This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
regex: Add lower bound to ANYOFH nodes UTF-8 byte
[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
912b808c 50BOUNDU BOUND, no ; Match "" at any boundary of a given type using /u 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
912b808c 55NBOUNDU NBOUND, no ; Match "" at any non-boundary of a given type using using /u rules.
c440a570 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
f6eaa562
KW
65
66# Must be sequential
29a889ef 67ANYOFH 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 68ANYOFHb ANYOF, sv 1 S ; Like ANYOFH, but all matches share the same UTF-8 start byte, given in the flags field
f6eaa562 69
67a1b5f9 70ANYOFM ANYOFM byte 1 S ; Like ANYOF, but matches an invariant byte as determined by the mask and arg
3db0bccc 71NANYOFM ANYOFM byte 1 S ; complement of ANYOFM
693fefec 72
d3d47aac 73#* POSIX Character Classes:
3018b823
KW
74# Order of the below is important. See ordering comment above.
75POSIXD POSIXD, none 0 S ; Some [[:class:]] under /d; the FLAGS field gives which one
76POSIXL POSIXD, none 0 S ; Some [[:class:]] under /l; the FLAGS field gives which one
77POSIXU POSIXD, none 0 S ; Some [[:class:]] under /u; the FLAGS field gives which one
3615ea58 78POSIXA POSIXD, none 0 S ; Some [[:class:]] under /a; the FLAGS field gives which one
3018b823
KW
79NPOSIXD NPOSIXD, none 0 S ; complement of POSIXD, [[:^class:]]
80NPOSIXL NPOSIXD, none 0 S ; complement of POSIXL, [[:^class:]]
81NPOSIXU NPOSIXD, none 0 S ; complement of POSIXU, [[:^class:]]
9e84774b 82NPOSIXA NPOSIXD, none 0 S ; complement of POSIXA, [[:^class:]]
3018b823 83# End of order is important
693fefec 84
2448cf39 85CLUMP CLUMP, no 0 V ; Match any extended grapheme cluster sequence
d09b2d29 86
381b57db 87#* Alternation
1de06328 88
65aa4ca7
FC
89#* BRANCH The set of branches constituting a single choice are
90#* hooked together with their "next" pointers, since
91#* precedence prevents anything being concatenated to
92#* any individual branch. The "next" pointer of the last
93#* BRANCH in a choice points to the thing following the
94#* whole choice. This is also where the final "next"
95#* pointer of each individual branch points; each branch
96#* starts with the operand node of a BRANCH node.
97#*
f9ef50a7 98BRANCH BRANCH, node 0 V ; Match this alternative, or the next...
d09b2d29 99
65aa4ca7
FC
100#*Literals
101# NOTE: the relative ordering of these types is important do not change it
1de06328 102
f8abb37e 103EXACT EXACT, str ; Match this string (preceded by length).
b24abbc8 104EXACTL EXACT, str ; Like EXACT, but /l is in effect (used so locale-related warnings can be checked for).
4f4c2c24
KW
105EXACTF EXACT, str ; Match this string using /id rules (w/len); (string not UTF-8, not guaranteed to be folded).
106EXACTFL EXACT, str ; Match this string using /il rules (w/len); (string not guaranteed to be folded).
107EXACTFU EXACT, str ; Match this string using /iu rules (w/len); (string folded iff in UTF-8; non-UTF8 folded length <= unfolded).
108EXACTFAA EXACT, str ; Match this string using /iaa rules (w/len) (string folded iff in UTF-8; non-UTF8 folded length <= unfolded).
2f306ab9
KW
109
110# End of important relative ordering.
111
627a7895 112EXACTFUP EXACT, str ; Match this string using /iu rules (w/len); (string not UTF-8, not guaranteed to be folded; and its Problematic).
aa419ff3
KW
113# In order for a non-UTF-8 EXACTFAA to think the pattern is pre-folded when
114# matching a UTF-8 target string, there would have to be something like an
115# EXACTFAA_MICRO which would not be considered pre-folded for UTF-8 targets,
116# since the fold of the MICRO SIGN would not be done, and would be
117# representable in the UTF-8 target string.
118
4f4c2c24
KW
119EXACTFLU8 EXACT, str ; Like EXACTFU, but use /il, UTF-8, folded, and everything in it is above 255.
120EXACTFAA_NO_TRIE EXACT, str ; Match this string using /iaa rules (w/len) (string not UTF-8, not guaranteed to be folded, not currently trie-able).
d09b2d29 121
4f4c2c24
KW
122
123EXACT_ONLY8 EXACT, str ; Like EXACT, but only UTF-8 encoded targets can match
124EXACTFU_ONLY8 EXACT, str ; Like EXACTFU, but only UTF-8 encoded targets can match
efec1f81 125# One could add EXACTFAA8 and something that has the same effect for /l,
a9f8c7ac 126# but these would be extremely uncommon
f6b4b99d 127
95fb0a6e 128EXACTFU_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 129
381b57db 130#*Do nothing types
1de06328 131
f8abb37e 132NOTHING NOTHING, no ; Match empty string.
65aa4ca7 133#*A variant of above which delimits a group, thus stops optimizations
f8abb37e 134TAIL NOTHING, no ; Match empty string. Can jump here from outside.
d09b2d29 135
381b57db 136#*Loops
1de06328 137
65aa4ca7 138#* STAR,PLUS '?', and complex '*' and '+', are implemented as
62e6ef33 139#* circular BRANCH structures. Simple cases
65aa4ca7
FC
140#* (one character per match) are implemented with STAR
141#* and PLUS for speed and to minimize recursive plunges.
142#*
f9ef50a7
NC
143STAR STAR, node 0 V ; Match this (simple) thing 0 or more times.
144PLUS PLUS, node 0 V ; Match this (simple) thing 1 or more times.
d09b2d29 145
f9ef50a7
NC
146CURLY CURLY, sv 2 V ; Match this simple thing {n,m} times.
147CURLYN CURLY, no 2 V ; Capture next-after-this simple thing
148CURLYM CURLY, no 2 V ; Capture this medium-complex thing {n,m} times.
149CURLYX CURLY, sv 2 V ; Match this complex thing {n,m} times.
d09b2d29 150
65aa4ca7 151#*This terminator creates a loop structure for CURLYX
f9ef50a7 152WHILEM WHILEM, no 0 V ; Do curly processing and see if rest matches.
d09b2d29 153
381b57db 154#*Buffer related
1de06328 155
65aa4ca7 156#*OPEN,CLOSE,GROUPP ...are numbered at compile time.
f8abb37e 157OPEN OPEN, num 1 ; Mark this point in input as start of #n.
48e88d42 158CLOSE CLOSE, num 1 ; Close corresponding OPEN of #n.
07093db4
KW
159SROPEN SROPEN, none ; Same as OPEN, but for script run
160SRCLOSE SRCLOSE, none ; Close preceding SROPEN
d09b2d29 161
f9ef50a7 162REF REF, num 1 V ; Match some already matched string
912b808c
KW
163REFF REF, num 1 V ; Match already matched string, using /di rules.
164REFFL REF, num 1 V ; Match already matched string, using /li rules.
781aab5c 165# N?REFF[AU] could have been implemented using the FLAGS field of the
01f98ec2
KW
166# regnode, but by having a separate node type, we can use the existing switch
167# statement to avoid some tests
912b808c
KW
168REFFU REF, num 1 V ; Match already matched string, usng /ui.
169REFFA REF, num 1 V ; Match already matched string, using /aai rules.
d09b2d29 170
65aa4ca7
FC
171#*Named references. Code in regcomp.c assumes that these all are after
172#*the numbered references
016b7209
KW
173REFN REF, no-sv 1 V ; Match some already matched string
174REFFN REF, no-sv 1 V ; Match already matched string, using /di rules.
175REFFLN REF, no-sv 1 V ; Match already matched string, using /li rules.
176REFFUN REF, num 1 V ; Match already matched string, using /ui rules.
177REFFAN REF, num 1 V ; Match already matched string, using /aai rules.
1de06328 178
d3d47aac
YO
179#*Support for long RE
180LONGJMP LONGJMP, off 1 . 1 ; Jump far away.
181BRANCHJ BRANCHJ, off 1 V 1 ; BRANCH with long offset.
182
183#*Special Case Regops
2abbd513
KW
184IFMATCH 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
185UNLESSM 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 186SUSPEND BRANCHJ, off 1 V 1 ; "Independent" sub-RE.
65aa4ca7 187IFTHEN BRANCHJ, off 1 V 1 ; Switch, should be preceded by switcher.
f8abb37e 188GROUPP GROUPP, num 1 ; Whether the group matched.
d09b2d29 189
d09b2d29 190
381b57db 191#*The heavy worker
1de06328 192
13f27704 193EVAL EVAL, evl/flags 2L ; Execute some Perl code.
d09b2d29 194
381b57db 195#*Modifiers
1de06328 196
f8abb37e
NC
197MINMOD MINMOD, no ; Next operator is not greedy.
198LOGICAL LOGICAL, no ; Next opcode should set the flag only.
d09b2d29 199
65aa4ca7 200#*This is not used yet
f9ef50a7 201RENUM BRANCHJ, off 1 . 1 ; Group with independently numbered parens.
d09b2d29 202
381b57db 203#*Trie Related
1de06328 204
65aa4ca7
FC
205#* Behave the same as A|LIST|OF|WORDS would. The '..C' variants
206#* have inline charclass data (ascii only), the 'C' store it in the
207#* structure.
486ec47a 208# NOTE: the relative order of the TRIE-like regops is significant
ce5e9471 209
7986cb47 210TRIE TRIE, trie 1 ; Match many EXACT(F[ALU]?)? at once. flags==type
f8abb37e 211TRIEC TRIE,trie charclass ; Same as TRIE, but with embedded charclass data
3dab1dad 212
1de06328 213# For start classes, contains an added fail table.
f8abb37e
NC
214AHOCORASICK TRIE, trie 1 ; Aho Corasick stclass. flags==type
215AHOCORASICKC TRIE,trie charclass ; Same as AHOCORASICK, but with embedded charclass data
1de06328 216
381b57db 217#*Regex Subroutines
f8abb37e 218GOSUB GOSUB, num/ofs 2L ; recurse to paren arg1 at (signed) ofs arg2
03363afd 219
381b57db 220#*Special conditionals
016b7209 221GROUPPN GROUPPN, no-sv 1 ; Whether the group matched.
f8abb37e
NC
222INSUBP INSUBP, num 1 ; Whether we are in a specific recurse.
223DEFINEP DEFINEP, none 1 ; Never execute directly.
0a4db386 224
486ec47a 225#*Backtracking Verbs
f8abb37e 226ENDLIKE ENDLIKE, none ; Used only for the type field of verbs
fee50582
YO
227OPFAIL ENDLIKE, no-sv 1 ; Same as (?!), but with verb arg
228ACCEPT ENDLIKE, no-sv/num 2L ; Accepts the current matched string, with verbar
5d458dd8
YO
229
230#*Verbs With Arguments
f8abb37e
NC
231VERB VERB, no-sv 1 ; Used only for the type field of verbs
232PRUNE VERB, no-sv 1 ; Pattern fails at this startpoint if no-backtracking through this
233MARKPOINT VERB, no-sv 1 ; Push the current location for rollback by cut.
234SKIP VERB, no-sv 1 ; On failure skip forward (to the mark) before retrying
235COMMIT VERB, no-sv 1 ; Pattern fails outright if backtracking through this
236CUTGROUP VERB, no-sv 1 ; On failure go to the next alternation in the group
e2e6a0f1 237
ee9b8eae 238#*Control what to keep in $&.
f8abb37e 239KEEPS KEEPS, no ; $& begins here.
ee9b8eae 240
e1d1eefb 241#*New charclass like patterns
f8abb37e 242LNBREAK LNBREAK, none ; generic newline pattern
3172e3fd 243
381b57db 244# NEW STUFF SOMEWHERE ABOVE THIS LINE
1de06328 245
03363afd
YO
246################################################################################
247
7f69552c 248#*SPECIAL REGOPS
1de06328 249
65aa4ca7
FC
250#* This is not really a node, but an optimized away piece of a "long"
251#* node. To simplify debugging output, we mark it as if it were a node
f8abb37e 252OPTIMIZED NOTHING, off ; Placeholder for dump.
1de06328 253
65aa4ca7
FC
254#* Special opcode with the property that no opcode in a compiled program
255#* will ever be of this type. Thus it can be used as a flag value that
256#* no other opcode has been seen. END is used similarly, in that an END
257#* node cant be optimized. So END implies "unoptimizable" and PSEUDO
258#* mean "not seen anything to optimize yet".
f8abb37e 259PSEUDO PSEUDO, off ; Pseudo opcode for internal use.
1de06328 260
03363afd
YO
261-------------------------------------------------------------------------------
262# Format for second section:
65aa4ca7 263# REGOP \t typelist [ \t typelist]
03363afd
YO
264# typelist= namelist
265# = namelist:FAIL
266# = name:count
267
268# Anything below is a state
269#
270#
f8abb37e 271TRIE next:FAIL
4ee16520 272EVAL B,postponed_AB:FAIL
f8abb37e
NC
273CURLYX end:FAIL
274WHILEM A_pre,A_min,A_max,B_min,B_max:FAIL
275BRANCH next:FAIL
276CURLYM A,B:FAIL
277IFMATCH A:FAIL
21cbe009 278CURLY B_min,B_max:FAIL
f8abb37e
NC
279COMMIT next:FAIL
280MARKPOINT next:FAIL
281SKIP next:FAIL
282CUTGROUP next:FAIL
283KEEPS next:FAIL