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