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