This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Add ANYOFR regnode
[perl5.git] / regcomp.sym
CommitLineData
03363afd
YO
1# regcomp.sym
2#
3# File has two sections, divided by a line of dashes '-'.
4#
65aa4ca7
FC
5# Lines beginning with # are ignored, except for those that start with #*
6# which are included in pod/perldebguts.pod. # within a line may be part
7# of a description.
03363afd 8#
486ec47a 9# First section is for regops, second section is for regmatch-states
03363afd 10#
3dab1dad
YO
11# Note that the order in this file is important.
12#
03363afd 13# Format for first section:
e21ef692
KW
14# NAME \s+ TYPE, arg-description [struct regnode suffix] [flags] [longjump] ; DESCRIPTION
15# arg-description is currently unused
16# suffix is appended to 'struct_regnode_' giving which one to use. If empty,
17# it means plain 'struct regnode'. If the regnode is a string one, this
18# should instead refer to the base regnode, without the char[1] element
19# of the structure
46167d76 20# flag <S> means is REGNODE_SIMPLE; flag <V> means is REGNODE_VARIES; <.> is
e21ef692
KW
21# a placeholder
22# longjump is 1 if the (first) argument holds the next offset (instead of the
23# usual 'next_offset' field
3dab1dad 24#
c476f425 25# run perl regen.pl after editing this file
3dab1dad 26
e21ef692
KW
27# +- suffix of which struct regnode to use e.g.,
28# | +- flags (S or V) struct regnode_1
29# un- | | +- longjmp (0, blank, or 1) blank means 0
30# Name Type used | | | ; comment
31# --------------------------------------------------------------------------
32# IFMATCH BRANCHJ, off 1 . 1 ; Succeeds if the following matches.
33# UNLESSM BRANCHJ, off 1 . 1 ; Fails if the following matches.
34# SUSPEND BRANCHJ, off 1 V 1 ; "Independent" sub-RE.
35# IFTHEN BRANCHJ, off 1 V 1 ; Switch, should be preceded by switcher.
36# GROUPP GROUPP, num 1 ; Whether the group matched.
03363afd
YO
37
38
381b57db 39#* Exit points
1de06328 40
f8abb37e
NC
41END END, no ; End of program.
42SUCCEED END, no ; Return from a subroutine, basically.
d09b2d29 43
d3d47aac 44#* Line Start Anchors:
1645b83c 45#Note flags field for SBOL indicates if it is a /^/ or a /\A/
d3d47aac
YO
46SBOL BOL, no ; Match "" at beginning of line: /^/, /\A/
47MBOL BOL, no ; Same, assuming multiline: /^/m
48
49#* Line End Anchors:
50SEOL EOL, no ; Match "" at end of line: /$/
51MEOL EOL, no ; Same, assuming multiline: /$/m
52EOS EOL, no ; Match "" at end of string: /\z/
53
54#* Match Start Anchors:
55GPOS GPOS, no ; Matches where last m//g left off.
56
57#* Word Boundary Opcodes:
693fefec
KW
58# The regops that have varieties that vary depending on the character set regex
59# modifiers have to ordered thusly: /d, /l, /u, /a, /aa. This is because code
60# in regcomp.c uses the enum value of the modifier as an offset from the /d
61# version. The complements must come after the non-complements.
3018b823 62# BOUND, POSIX and their complements are affected, as well as EXACTF.
c440a570
KW
63BOUND BOUND, no ; Like BOUNDA for non-utf8, otherwise match "" between any Unicode \w\W or \W\w
64BOUNDL BOUND, no ; Like BOUND/BOUNDU, but \w and \W are defined by current locale
912b808c 65BOUNDU BOUND, no ; Match "" at any boundary of a given type using /u rules.
c440a570 66BOUNDA BOUND, no ; Match "" at any boundary between \w\W or \W\w, where \w is [_a-zA-Z0-9]
693fefec 67# All NBOUND nodes are required by code in regexec.c to be greater than all BOUND ones
c440a570
KW
68NBOUND NBOUND, no ; Like NBOUNDA for non-utf8, otherwise match "" between any Unicode \w\w or \W\W
69NBOUNDL NBOUND, no ; Like NBOUND/NBOUNDU, but \w and \W are defined by current locale
912b808c 70NBOUNDU NBOUND, no ; Match "" at any non-boundary of a given type using using /u rules.
c440a570 71NBOUNDA NBOUND, no ; Match "" betweeen any \w\w or \W\W, where \w is [_a-zA-Z0-9]
d09b2d29 72
381b57db 73#* [Special] alternatives:
f9ef50a7
NC
74REG_ANY REG_ANY, no 0 S ; Match any one character (except newline).
75SANY REG_ANY, no 0 S ; Match any one character.
46fc0c43
KW
76ANYOF ANYOF, sv charclass S ; Match character in (or not in) this class, single char match only
77ANYOFD ANYOF, sv charclass S ; Like ANYOF, but /d is in effect
78ANYOFL ANYOF, sv charclass S ; Like ANYOF, but /l is in effect
79ANYOFPOSIXL ANYOF, sv charclass_posixl S ; Like ANYOFL, but matches [[:posix:]] classes
f6eaa562
KW
80
81# Must be sequential
29a889ef 82ANYOFH ANYOF, sv 1 S ; Like ANYOF, but only has "High" matches, none in the bitmap; the flags field contains the lowest matchable UTF-8 start byte
a5bc0742 83ANYOFHb ANYOF, sv 1 S ; Like ANYOFH, but all matches share the same UTF-8 start byte, given in the flags field
3146c00a 84ANYOFHr ANYOF, sv 1 S ; Like ANYOFH, but the flags field contains packed bounds for all matchable UTF-8 start bytes.
13fcf652 85ANYOFR ANYOFR, packed 1 S ; Matches any character in the range given by its packed args: upper 12 bits is the max delta from the base lower 20; the flags field contains the lowest matchable UTF-8 start byte
f6eaa562 86
67a1b5f9 87ANYOFM ANYOFM byte 1 S ; Like ANYOF, but matches an invariant byte as determined by the mask and arg
3db0bccc 88NANYOFM ANYOFM byte 1 S ; complement of ANYOFM
693fefec 89
d3d47aac 90#* POSIX Character Classes:
3018b823
KW
91# Order of the below is important. See ordering comment above.
92POSIXD POSIXD, none 0 S ; Some [[:class:]] under /d; the FLAGS field gives which one
93POSIXL POSIXD, none 0 S ; Some [[:class:]] under /l; the FLAGS field gives which one
94POSIXU POSIXD, none 0 S ; Some [[:class:]] under /u; the FLAGS field gives which one
3615ea58 95POSIXA POSIXD, none 0 S ; Some [[:class:]] under /a; the FLAGS field gives which one
3018b823
KW
96NPOSIXD NPOSIXD, none 0 S ; complement of POSIXD, [[:^class:]]
97NPOSIXL NPOSIXD, none 0 S ; complement of POSIXL, [[:^class:]]
98NPOSIXU NPOSIXD, none 0 S ; complement of POSIXU, [[:^class:]]
9e84774b 99NPOSIXA NPOSIXD, none 0 S ; complement of POSIXA, [[:^class:]]
3018b823 100# End of order is important
693fefec 101
2448cf39 102CLUMP CLUMP, no 0 V ; Match any extended grapheme cluster sequence
d09b2d29 103
381b57db 104#* Alternation
1de06328 105
65aa4ca7
FC
106#* BRANCH The set of branches constituting a single choice are
107#* hooked together with their "next" pointers, since
108#* precedence prevents anything being concatenated to
109#* any individual branch. The "next" pointer of the last
110#* BRANCH in a choice points to the thing following the
111#* whole choice. This is also where the final "next"
112#* pointer of each individual branch points; each branch
113#* starts with the operand node of a BRANCH node.
114#*
f9ef50a7 115BRANCH BRANCH, node 0 V ; Match this alternative, or the next...
d09b2d29 116
65aa4ca7
FC
117#*Literals
118# NOTE: the relative ordering of these types is important do not change it
1de06328 119
3ace85ea 120EXACT EXACT, str ; Match this string (flags field is the length).
ae06e581
KW
121
122#* In a long string node, the U32 argument is the length, and is
123#* immediately followed by the string.
124LEXACT EXACT, len:str 1; Match this long string (preceded by length; flags unused).
58ea1df2
KW
125EXACTL EXACT, str ; Like EXACT, but /l is in effect (used so locale-related warnings can be checked for)
126EXACTF EXACT, str ; Like EXACT, but match using /id rules; (string not UTF-8, ASCII folded; non-ASCII not)
127EXACTFL EXACT, str ; Like EXACT, but match using /il rules; (string not likely to be folded)
128EXACTFU EXACT, str ; Like EXACT, but match using /iu rules; (string folded)
129
130# The reason MICRO and SHARP S aren't folded in non-UTF8 patterns is because
131# they would fold to something that requires UTF-8. SHARP S would normally
132# fold to 'ss', but because of /aa, it instead folds to a pair of LATIN SMALL
133# LETTER LONG S characters (U+017F)
134EXACTFAA EXACT, str ; Like EXACT, but match using /iaa rules; (string folded except in non-UTF8 patterns: MICRO, SHARP S; folded length <= unfolded)
2f306ab9
KW
135
136# End of important relative ordering.
137
58ea1df2 138EXACTFUP EXACT, str ; Like EXACT, but match using /iu rules; (string not UTF-8, folded except MICRO, SHARP S: hence Problematic)
aa419ff3
KW
139# In order for a non-UTF-8 EXACTFAA to think the pattern is pre-folded when
140# matching a UTF-8 target string, there would have to be something like an
141# EXACTFAA_MICRO which would not be considered pre-folded for UTF-8 targets,
142# since the fold of the MICRO SIGN would not be done, and would be
143# representable in the UTF-8 target string.
144
58ea1df2
KW
145EXACTFLU8 EXACT, str ; Like EXACTFU, but use /il, UTF-8, (string is folded, and everything in it is above 255
146EXACTFAA_NO_TRIE EXACT, str ; Like EXACT, but match using /iaa rules (string not UTF-8, not guaranteed to be folded, not currently trie-able)
d09b2d29 147
4f4c2c24 148
3f2416ae
KW
149EXACT_REQ8 EXACT, str ; Like EXACT, but only UTF-8 encoded targets can match
150LEXACT_REQ8 EXACT, len:str 1 ; Like LEXACT, but only UTF-8 encoded targets can match
151EXACTFU_REQ8 EXACT, str ; Like EXACTFU, but only UTF-8 encoded targets can match
efec1f81 152# One could add EXACTFAA8 and something that has the same effect for /l,
a9f8c7ac 153# but these would be extremely uncommon
f6b4b99d 154
58ea1df2 155EXACTFU_S_EDGE EXACT, str ; /di rules, but nothing in it precludes /ui, except begins and/or ends with [Ss]; (string not UTF-8; compile-time only)
8a100c91 156
381b57db 157#*Do nothing types
1de06328 158
f8abb37e 159NOTHING NOTHING, no ; Match empty string.
65aa4ca7 160#*A variant of above which delimits a group, thus stops optimizations
f8abb37e 161TAIL NOTHING, no ; Match empty string. Can jump here from outside.
d09b2d29 162
381b57db 163#*Loops
1de06328 164
65aa4ca7 165#* STAR,PLUS '?', and complex '*' and '+', are implemented as
62e6ef33 166#* circular BRANCH structures. Simple cases
65aa4ca7
FC
167#* (one character per match) are implemented with STAR
168#* and PLUS for speed and to minimize recursive plunges.
169#*
f9ef50a7
NC
170STAR STAR, node 0 V ; Match this (simple) thing 0 or more times.
171PLUS PLUS, node 0 V ; Match this (simple) thing 1 or more times.
d09b2d29 172
f9ef50a7
NC
173CURLY CURLY, sv 2 V ; Match this simple thing {n,m} times.
174CURLYN CURLY, no 2 V ; Capture next-after-this simple thing
175CURLYM CURLY, no 2 V ; Capture this medium-complex thing {n,m} times.
176CURLYX CURLY, sv 2 V ; Match this complex thing {n,m} times.
d09b2d29 177
65aa4ca7 178#*This terminator creates a loop structure for CURLYX
f9ef50a7 179WHILEM WHILEM, no 0 V ; Do curly processing and see if rest matches.
d09b2d29 180
381b57db 181#*Buffer related
1de06328 182
65aa4ca7 183#*OPEN,CLOSE,GROUPP ...are numbered at compile time.
f8abb37e 184OPEN OPEN, num 1 ; Mark this point in input as start of #n.
48e88d42 185CLOSE CLOSE, num 1 ; Close corresponding OPEN of #n.
07093db4
KW
186SROPEN SROPEN, none ; Same as OPEN, but for script run
187SRCLOSE SRCLOSE, none ; Close preceding SROPEN
d09b2d29 188
f9ef50a7 189REF REF, num 1 V ; Match some already matched string
912b808c
KW
190REFF REF, num 1 V ; Match already matched string, using /di rules.
191REFFL REF, num 1 V ; Match already matched string, using /li rules.
781aab5c 192# N?REFF[AU] could have been implemented using the FLAGS field of the
01f98ec2
KW
193# regnode, but by having a separate node type, we can use the existing switch
194# statement to avoid some tests
912b808c
KW
195REFFU REF, num 1 V ; Match already matched string, usng /ui.
196REFFA REF, num 1 V ; Match already matched string, using /aai rules.
d09b2d29 197
65aa4ca7
FC
198#*Named references. Code in regcomp.c assumes that these all are after
199#*the numbered references
016b7209
KW
200REFN REF, no-sv 1 V ; Match some already matched string
201REFFN REF, no-sv 1 V ; Match already matched string, using /di rules.
202REFFLN REF, no-sv 1 V ; Match already matched string, using /li rules.
203REFFUN REF, num 1 V ; Match already matched string, using /ui rules.
204REFFAN REF, num 1 V ; Match already matched string, using /aai rules.
1de06328 205
d3d47aac
YO
206#*Support for long RE
207LONGJMP LONGJMP, off 1 . 1 ; Jump far away.
208BRANCHJ BRANCHJ, off 1 V 1 ; BRANCH with long offset.
209
210#*Special Case Regops
2abbd513
KW
211IFMATCH BRANCHJ, off 1 . 1 ; Succeeds if the following matches; non-zero flags "f", next_off "o" means lookbehind assertion starting "f..(f-o)" characters before current
212UNLESSM BRANCHJ, off 1 . 1 ; Fails if the following matches; non-zero flags "f", next_off "o" means lookbehind assertion starting "f..(f-o)" characters before current
f9ef50a7 213SUSPEND BRANCHJ, off 1 V 1 ; "Independent" sub-RE.
65aa4ca7 214IFTHEN BRANCHJ, off 1 V 1 ; Switch, should be preceded by switcher.
f8abb37e 215GROUPP GROUPP, num 1 ; Whether the group matched.
d09b2d29 216
381b57db 217#*The heavy worker
1de06328 218
13f27704 219EVAL EVAL, evl/flags 2L ; Execute some Perl code.
d09b2d29 220
381b57db 221#*Modifiers
1de06328 222
f8abb37e
NC
223MINMOD MINMOD, no ; Next operator is not greedy.
224LOGICAL LOGICAL, no ; Next opcode should set the flag only.
d09b2d29 225
65aa4ca7 226#*This is not used yet
f9ef50a7 227RENUM BRANCHJ, off 1 . 1 ; Group with independently numbered parens.
d09b2d29 228
381b57db 229#*Trie Related
1de06328 230
65aa4ca7
FC
231#* Behave the same as A|LIST|OF|WORDS would. The '..C' variants
232#* have inline charclass data (ascii only), the 'C' store it in the
233#* structure.
486ec47a 234# NOTE: the relative order of the TRIE-like regops is significant
ce5e9471 235
7986cb47 236TRIE TRIE, trie 1 ; Match many EXACT(F[ALU]?)? at once. flags==type
f8abb37e 237TRIEC TRIE,trie charclass ; Same as TRIE, but with embedded charclass data
3dab1dad 238
1de06328 239# For start classes, contains an added fail table.
f8abb37e
NC
240AHOCORASICK TRIE, trie 1 ; Aho Corasick stclass. flags==type
241AHOCORASICKC TRIE,trie charclass ; Same as AHOCORASICK, but with embedded charclass data
1de06328 242
381b57db 243#*Regex Subroutines
f8abb37e 244GOSUB GOSUB, num/ofs 2L ; recurse to paren arg1 at (signed) ofs arg2
03363afd 245
381b57db 246#*Special conditionals
016b7209 247GROUPPN GROUPPN, no-sv 1 ; Whether the group matched.
f8abb37e
NC
248INSUBP INSUBP, num 1 ; Whether we are in a specific recurse.
249DEFINEP DEFINEP, none 1 ; Never execute directly.
0a4db386 250
486ec47a 251#*Backtracking Verbs
f8abb37e 252ENDLIKE ENDLIKE, none ; Used only for the type field of verbs
fee50582
YO
253OPFAIL ENDLIKE, no-sv 1 ; Same as (?!), but with verb arg
254ACCEPT ENDLIKE, no-sv/num 2L ; Accepts the current matched string, with verbar
5d458dd8
YO
255
256#*Verbs With Arguments
f8abb37e
NC
257VERB VERB, no-sv 1 ; Used only for the type field of verbs
258PRUNE VERB, no-sv 1 ; Pattern fails at this startpoint if no-backtracking through this
259MARKPOINT VERB, no-sv 1 ; Push the current location for rollback by cut.
260SKIP VERB, no-sv 1 ; On failure skip forward (to the mark) before retrying
261COMMIT VERB, no-sv 1 ; Pattern fails outright if backtracking through this
262CUTGROUP VERB, no-sv 1 ; On failure go to the next alternation in the group
e2e6a0f1 263
ee9b8eae 264#*Control what to keep in $&.
f8abb37e 265KEEPS KEEPS, no ; $& begins here.
ee9b8eae 266
e1d1eefb 267#*New charclass like patterns
f8abb37e 268LNBREAK LNBREAK, none ; generic newline pattern
3172e3fd 269
381b57db 270# NEW STUFF SOMEWHERE ABOVE THIS LINE
1de06328 271
03363afd
YO
272################################################################################
273
7f69552c 274#*SPECIAL REGOPS
1de06328 275
65aa4ca7
FC
276#* This is not really a node, but an optimized away piece of a "long"
277#* node. To simplify debugging output, we mark it as if it were a node
f8abb37e 278OPTIMIZED NOTHING, off ; Placeholder for dump.
1de06328 279
65aa4ca7
FC
280#* Special opcode with the property that no opcode in a compiled program
281#* will ever be of this type. Thus it can be used as a flag value that
282#* no other opcode has been seen. END is used similarly, in that an END
283#* node cant be optimized. So END implies "unoptimizable" and PSEUDO
284#* mean "not seen anything to optimize yet".
f8abb37e 285PSEUDO PSEUDO, off ; Pseudo opcode for internal use.
1de06328 286
03363afd
YO
287-------------------------------------------------------------------------------
288# Format for second section:
65aa4ca7 289# REGOP \t typelist [ \t typelist]
03363afd
YO
290# typelist= namelist
291# = namelist:FAIL
292# = name:count
293
294# Anything below is a state
295#
296#
f8abb37e 297TRIE next:FAIL
4ee16520 298EVAL B,postponed_AB:FAIL
f8abb37e
NC
299CURLYX end:FAIL
300WHILEM A_pre,A_min,A_max,B_min,B_max:FAIL
301BRANCH next:FAIL
302CURLYM A,B:FAIL
303IFMATCH A:FAIL
21cbe009 304CURLY B_min,B_max:FAIL
f8abb37e
NC
305COMMIT next:FAIL
306MARKPOINT next:FAIL
307SKIP next:FAIL
308CUTGROUP next:FAIL
309KEEPS next:FAIL