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