This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Free up bit for regex ANYOF nodes
[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:
519ebf3d
KW
14# NAME \s+ TYPE, arg-description [num-args] [flags] [longjump-len] ; DESCRIPTION
15# flag <S> means is REGNODE_SIMPLE; flag <V> means is REGNODE_VARIES
03363afd 16#
3dab1dad 17#
c476f425 18# run perl regen.pl after editing this file
3dab1dad 19
03363afd
YO
20
21
381b57db 22#* Exit points
1de06328 23
f8abb37e
NC
24END END, no ; End of program.
25SUCCEED END, no ; Return from a subroutine, basically.
d09b2d29 26
381b57db 27#* Anchors:
1de06328 28
f8abb37e
NC
29BOL BOL, no ; Match "" at beginning of line.
30MBOL BOL, no ; Same, assuming multiline.
31SBOL BOL, no ; Same, assuming singleline.
32EOS EOL, no ; Match "" at end of string.
33EOL EOL, no ; Match "" at end of line.
34MEOL EOL, no ; Same, assuming multiline.
35SEOL EOL, no ; Same, assuming singleline.
693fefec
KW
36# The regops that have varieties that vary depending on the character set regex
37# modifiers have to ordered thusly: /d, /l, /u, /a, /aa. This is because code
38# in regcomp.c uses the enum value of the modifier as an offset from the /d
39# version. The complements must come after the non-complements.
3018b823 40# BOUND, POSIX and their complements are affected, as well as EXACTF.
1e355c70 41BOUND BOUND, no ; Match "" at any word boundary using native charset semantics for non-utf8
f2284805 42BOUNDL BOUND, no ; Match "" at any locale word boundary
1e355c70 43BOUNDU BOUND, no ; Match "" at any word boundary using Unicode semantics
0c6e81eb 44BOUNDA BOUND, no ; Match "" at any word boundary using ASCII semantics
693fefec 45# All NBOUND nodes are required by code in regexec.c to be greater than all BOUND ones
1e355c70 46NBOUND NBOUND, no ; Match "" at any word non-boundary using native charset semantics for non-utf8
f2284805 47NBOUNDL NBOUND, no ; Match "" at any locale word non-boundary
1e355c70 48NBOUNDU NBOUND, no ; Match "" at any word non-boundary using Unicode semantics
0c6e81eb 49NBOUNDA NBOUND, no ; Match "" at any word non-boundary using ASCII semantics
f8abb37e 50GPOS GPOS, no ; Matches where last m//g left off.
d09b2d29 51
381b57db 52#* [Special] alternatives:
1de06328 53
f9ef50a7
NC
54REG_ANY REG_ANY, no 0 S ; Match any one character (except newline).
55SANY REG_ANY, no 0 S ; Match any one character.
56CANY REG_ANY, no 0 S ; Match any one byte.
0e019ad6 57ANYOF ANYOF, sv 0 S ; Match character in (or not in) this class, single char match only
34fdef84 58ANYOF_NON_UTF8_NON_ASCII_ALL ANYOF, sv 0 S ; like ANYOF, also matches any U+80 - U+FF when not in UTF-8
693fefec 59
3018b823
KW
60# Order of the below is important. See ordering comment above.
61POSIXD POSIXD, none 0 S ; Some [[:class:]] under /d; the FLAGS field gives which one
62POSIXL POSIXD, none 0 S ; Some [[:class:]] under /l; the FLAGS field gives which one
63POSIXU POSIXD, none 0 S ; Some [[:class:]] under /u; the FLAGS field gives which one
3615ea58 64POSIXA POSIXD, none 0 S ; Some [[:class:]] under /a; the FLAGS field gives which one
3018b823
KW
65NPOSIXD NPOSIXD, none 0 S ; complement of POSIXD, [[:^class:]]
66NPOSIXL NPOSIXD, none 0 S ; complement of POSIXL, [[:^class:]]
67NPOSIXU NPOSIXD, none 0 S ; complement of POSIXU, [[:^class:]]
9e84774b 68NPOSIXA NPOSIXD, none 0 S ; complement of POSIXA, [[:^class:]]
3018b823 69# End of order is important
693fefec 70
2448cf39 71CLUMP CLUMP, no 0 V ; Match any extended grapheme cluster sequence
d09b2d29 72
381b57db 73#* Alternation
1de06328 74
65aa4ca7
FC
75#* BRANCH The set of branches constituting a single choice are
76#* hooked together with their "next" pointers, since
77#* precedence prevents anything being concatenated to
78#* any individual branch. The "next" pointer of the last
79#* BRANCH in a choice points to the thing following the
80#* whole choice. This is also where the final "next"
81#* pointer of each individual branch points; each branch
82#* starts with the operand node of a BRANCH node.
83#*
f9ef50a7 84BRANCH BRANCH, node 0 V ; Match this alternative, or the next...
d09b2d29 85
381b57db 86#*Back pointer
1de06328 87
65aa4ca7
FC
88#* BACK Normal "next" pointers all implicitly point forward;
89#* BACK exists to make loop structures possible.
90#* not used
f9ef50a7 91BACK BACK, no 0 V ; Match "", "next" ptr points backward.
d09b2d29 92
65aa4ca7
FC
93#*Literals
94# NOTE: the relative ordering of these types is important do not change it
1de06328 95
f8abb37e 96EXACT EXACT, str ; Match this string (preceded by length).
a36afff1
KW
97EXACTF EXACT, str ; Match this non-UTF-8 string (not guaranteed to be folded) using /id rules (w/len).
98EXACTFL EXACT, str ; Match this string (not guaranteed to be folded) using /il rules (w/len).
3c760661 99EXACTFU EXACT, str ; Match this string (folded iff in UTF-8, length in folding doesn't change if not in UTF-8) using /iu rules (w/len).
8c1182fd 100EXACTFA EXACT, str ; Match this string (not guaranteed to be folded) using /iaa rules (w/len).
3c760661 101EXACTFU_SS EXACT, str ; Match this string (folded iff in UTF-8, length in folding may change even if not in UTF-8) using /iu rules (w/len).
098b07d5 102EXACTFA_NO_TRIE EXACT, str ; Match this string (which is not trie-able; not guaranteed to be folded) using /iaa rules (w/len).
d09b2d29 103
381b57db 104#*Do nothing types
1de06328 105
f8abb37e 106NOTHING NOTHING, no ; Match empty string.
65aa4ca7 107#*A variant of above which delimits a group, thus stops optimizations
f8abb37e 108TAIL NOTHING, no ; Match empty string. Can jump here from outside.
d09b2d29 109
381b57db 110#*Loops
1de06328 111
65aa4ca7
FC
112#* STAR,PLUS '?', and complex '*' and '+', are implemented as
113#* circular BRANCH structures using BACK. Simple cases
114#* (one character per match) are implemented with STAR
115#* and PLUS for speed and to minimize recursive plunges.
116#*
f9ef50a7
NC
117STAR STAR, node 0 V ; Match this (simple) thing 0 or more times.
118PLUS PLUS, node 0 V ; Match this (simple) thing 1 or more times.
d09b2d29 119
f9ef50a7
NC
120CURLY CURLY, sv 2 V ; Match this simple thing {n,m} times.
121CURLYN CURLY, no 2 V ; Capture next-after-this simple thing
122CURLYM CURLY, no 2 V ; Capture this medium-complex thing {n,m} times.
123CURLYX CURLY, sv 2 V ; Match this complex thing {n,m} times.
d09b2d29 124
65aa4ca7 125#*This terminator creates a loop structure for CURLYX
f9ef50a7 126WHILEM WHILEM, no 0 V ; Do curly processing and see if rest matches.
d09b2d29 127
381b57db 128#*Buffer related
1de06328 129
65aa4ca7 130#*OPEN,CLOSE,GROUPP ...are numbered at compile time.
f8abb37e
NC
131OPEN OPEN, num 1 ; Mark this point in input as start of #n.
132CLOSE CLOSE, num 1 ; Analogous to OPEN.
d09b2d29 133
f9ef50a7 134REF REF, num 1 V ; Match some already matched string
2448cf39 135REFF REF, num 1 V ; Match already matched string, folded using native charset semantics for non-utf8
f9ef50a7 136REFFL REF, num 1 V ; Match already matched string, folded in loc.
781aab5c 137# N?REFF[AU] could have been implemented using the FLAGS field of the
01f98ec2
KW
138# regnode, but by having a separate node type, we can use the existing switch
139# statement to avoid some tests
140REFFU REF, num 1 V ; Match already matched string, folded using unicode semantics for non-utf8
781aab5c 141REFFA REF, num 1 V ; Match already matched string, folded using unicode semantics for non-utf8, no mixing ASCII, non-ASCII
d09b2d29 142
65aa4ca7
FC
143#*Named references. Code in regcomp.c assumes that these all are after
144#*the numbered references
01f98ec2
KW
145NREF REF, no-sv 1 V ; Match some already matched string
146NREFF REF, no-sv 1 V ; Match already matched string, folded using native charset semantics for non-utf8
147NREFFL REF, no-sv 1 V ; Match already matched string, folded in loc.
148NREFFU REF, num 1 V ; Match already matched string, folded using unicode semantics for non-utf8
781aab5c 149NREFFA REF, num 1 V ; Match already matched string, folded using unicode semantics for non-utf8, no mixing ASCII, non-ASCII
1de06328 150
f9ef50a7
NC
151IFMATCH BRANCHJ, off 1 . 2 ; Succeeds if the following matches.
152UNLESSM BRANCHJ, off 1 . 2 ; Fails if the following matches.
153SUSPEND BRANCHJ, off 1 V 1 ; "Independent" sub-RE.
65aa4ca7 154IFTHEN BRANCHJ, off 1 V 1 ; Switch, should be preceded by switcher.
f8abb37e 155GROUPP GROUPP, num 1 ; Whether the group matched.
d09b2d29 156
381b57db 157#*Support for long RE
1de06328 158
f9ef50a7
NC
159LONGJMP LONGJMP, off 1 . 1 ; Jump far away.
160BRANCHJ BRANCHJ, off 1 V 1 ; BRANCH with long offset.
d09b2d29 161
381b57db 162#*The heavy worker
1de06328 163
f8abb37e 164EVAL EVAL, evl 1 ; Execute some Perl code.
d09b2d29 165
381b57db 166#*Modifiers
1de06328 167
f8abb37e
NC
168MINMOD MINMOD, no ; Next operator is not greedy.
169LOGICAL LOGICAL, no ; Next opcode should set the flag only.
d09b2d29 170
65aa4ca7 171#*This is not used yet
f9ef50a7 172RENUM BRANCHJ, off 1 . 1 ; Group with independently numbered parens.
d09b2d29 173
381b57db 174#*Trie Related
1de06328 175
65aa4ca7
FC
176#* Behave the same as A|LIST|OF|WORDS would. The '..C' variants
177#* have inline charclass data (ascii only), the 'C' store it in the
178#* structure.
486ec47a 179# NOTE: the relative order of the TRIE-like regops is significant
ce5e9471 180
7986cb47 181TRIE TRIE, trie 1 ; Match many EXACT(F[ALU]?)? at once. flags==type
f8abb37e 182TRIEC TRIE,trie charclass ; Same as TRIE, but with embedded charclass data
3dab1dad 183
1de06328 184# For start classes, contains an added fail table.
f8abb37e
NC
185AHOCORASICK TRIE, trie 1 ; Aho Corasick stclass. flags==type
186AHOCORASICKC TRIE,trie charclass ; Same as AHOCORASICK, but with embedded charclass data
1de06328 187
381b57db 188#*Regex Subroutines
f8abb37e
NC
189GOSUB GOSUB, num/ofs 2L ; recurse to paren arg1 at (signed) ofs arg2
190GOSTART GOSTART, no ; recurse to start of pattern
03363afd 191
381b57db 192#*Special conditionals
f8abb37e
NC
193NGROUPP NGROUPP, no-sv 1 ; Whether the group matched.
194INSUBP INSUBP, num 1 ; Whether we are in a specific recurse.
195DEFINEP DEFINEP, none 1 ; Never execute directly.
0a4db386 196
486ec47a 197#*Backtracking Verbs
f8abb37e
NC
198ENDLIKE ENDLIKE, none ; Used only for the type field of verbs
199OPFAIL ENDLIKE, none ; Same as (?!)
200ACCEPT ENDLIKE, parno 1 ; Accepts the current matched string.
5d458dd8
YO
201
202
203#*Verbs With Arguments
f8abb37e
NC
204VERB VERB, no-sv 1 ; Used only for the type field of verbs
205PRUNE VERB, no-sv 1 ; Pattern fails at this startpoint if no-backtracking through this
206MARKPOINT VERB, no-sv 1 ; Push the current location for rollback by cut.
207SKIP VERB, no-sv 1 ; On failure skip forward (to the mark) before retrying
208COMMIT VERB, no-sv 1 ; Pattern fails outright if backtracking through this
209CUTGROUP VERB, no-sv 1 ; On failure go to the next alternation in the group
e2e6a0f1 210
ee9b8eae 211#*Control what to keep in $&.
f8abb37e 212KEEPS KEEPS, no ; $& begins here.
ee9b8eae 213
e1d1eefb 214#*New charclass like patterns
f8abb37e 215LNBREAK LNBREAK, none ; generic newline pattern
3172e3fd 216
381b57db 217# NEW STUFF SOMEWHERE ABOVE THIS LINE
1de06328 218
03363afd
YO
219################################################################################
220
7f69552c 221#*SPECIAL REGOPS
1de06328 222
65aa4ca7
FC
223#* This is not really a node, but an optimized away piece of a "long"
224#* node. To simplify debugging output, we mark it as if it were a node
f8abb37e 225OPTIMIZED NOTHING, off ; Placeholder for dump.
1de06328 226
65aa4ca7
FC
227#* Special opcode with the property that no opcode in a compiled program
228#* will ever be of this type. Thus it can be used as a flag value that
229#* no other opcode has been seen. END is used similarly, in that an END
230#* node cant be optimized. So END implies "unoptimizable" and PSEUDO
231#* mean "not seen anything to optimize yet".
f8abb37e 232PSEUDO PSEUDO, off ; Pseudo opcode for internal use.
1de06328 233
03363afd
YO
234-------------------------------------------------------------------------------
235# Format for second section:
65aa4ca7 236# REGOP \t typelist [ \t typelist]
03363afd
YO
237# typelist= namelist
238# = namelist:FAIL
239# = name:count
240
241# Anything below is a state
242#
243#
f8abb37e
NC
244TRIE next:FAIL
245EVAL AB:FAIL
246CURLYX end:FAIL
247WHILEM A_pre,A_min,A_max,B_min,B_max:FAIL
248BRANCH next:FAIL
249CURLYM A,B:FAIL
250IFMATCH A:FAIL
251CURLY B_min_known,B_min,B_max:FAIL
252COMMIT next:FAIL
253MARKPOINT next:FAIL
254SKIP next:FAIL
255CUTGROUP next:FAIL
256KEEPS next:FAIL