3 # File has two sections, divided by a line of dashes '-'.
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
9 # First section is for regops, second section is for regmatch-states
11 # Note that the order in this file is important.
13 # Format for first section:
14 # NAME \s+ TYPE, arg-description [struct regnode suffix] [flags] [longjump] ; DESCRIPTION
15 # arg-description is currently unused
16 # suffix is appended to 'struct_regnode_' giving which one to use. If empty,
17 # it means plain 'struct regnode'. If the regnode is a string one, this
18 # should instead refer to the base regnode, without the char[1] element
20 # flag <S> means is REGNODE_SIMPLE; flag <V> means is REGNODE_VARIES; <.> is
22 # longjump is 1 if the (first) argument holds the next offset (instead of the
23 # usual 'next_offset' field
25 # run perl regen.pl after editing this file
27 # +- suffix of which struct regnode to use e.g.,
28 # | +- flags (S or V) struct regnode_1
29 # un- | | +- longjmp (0, blank, or 1) blank means 0
30 # Name Type used | | | ; comment
31 # --------------------------------------------------------------------------
32 # IFMATCH BRANCHJ, off 1 . 1 ; Succeeds if the following matches.
33 # UNLESSM BRANCHJ, off 1 . 1 ; Fails if the following matches.
34 # SUSPEND BRANCHJ, off 1 V 1 ; "Independent" sub-RE.
35 # IFTHEN BRANCHJ, off 1 V 1 ; Switch, should be preceded by switcher.
36 # GROUPP GROUPP, num 1 ; Whether the group matched.
38 # If we were to start running out of regnodes, many of the ones that are
39 # complements could be combined with their non-complement mates. For example,
40 # POSIXU could have the flags field have the bottom bit mean do we complement
41 # or not, and the type be shifted left 1 bit. Then all that would be needed to
42 # extract which to do is a mask for the complement bit, and a right shift for
43 # the other, an inconsequential increase in instructions. It might actually be
44 # clearer and slightly faster given the case statement and assignment are
45 # removed. Note that not everything could be collapsed: NPOSIXA, for example,
46 # would require special handling for performance.
51 END END, no ; End of program.
52 SUCCEED END, no ; Return from a subroutine, basically.
54 #* Line Start Anchors:
55 #Note flags field for SBOL indicates if it is a /^/ or a /\A/
56 SBOL BOL, no ; Match "" at beginning of line: /^/, /\A/
57 MBOL BOL, no ; Same, assuming multiline: /^/m
60 SEOL EOL, no ; Match "" at end of line: /$/
61 MEOL EOL, no ; Same, assuming multiline: /$/m
62 EOS EOL, no ; Match "" at end of string: /\z/
64 #* Match Start Anchors:
65 GPOS GPOS, no ; Matches where last m//g left off.
67 #* Word Boundary Opcodes:
68 # The regops that have varieties that vary depending on the character set regex
69 # modifiers have to ordered thusly: /d, /l, /u, /a, /aa. This is because code
70 # in regcomp.c uses the enum value of the modifier as an offset from the /d
71 # version. The complements must come after the non-complements.
72 # BOUND, POSIX and their complements are affected, as well as EXACTF.
73 BOUND BOUND, no ; Like BOUNDA for non-utf8, otherwise like BOUNDU
74 BOUNDL BOUND, no ; Like BOUND/BOUNDU, but \w and \W are defined by current locale
75 BOUNDU BOUND, no ; Match "" at any boundary of a given type using /u rules.
76 BOUNDA BOUND, no ; Match "" at any boundary between \w\W or \W\w, where \w is [_a-zA-Z0-9]
77 # All NBOUND nodes are required by code in regexec.c to be greater than all BOUND ones
78 NBOUND NBOUND, no ; Like NBOUNDA for non-utf8, otherwise like BOUNDU
79 NBOUNDL NBOUND, no ; Like NBOUND/NBOUNDU, but \w and \W are defined by current locale
80 NBOUNDU NBOUND, no ; Match "" at any non-boundary of a given type using using /u rules.
81 NBOUNDA NBOUND, no ; Match "" betweeen any \w\w or \W\W, where \w is [_a-zA-Z0-9]
83 #* [Special] alternatives:
84 REG_ANY REG_ANY, no 0 S ; Match any one character (except newline).
85 SANY REG_ANY, no 0 S ; Match any one character.
86 ANYOF ANYOF, sv charclass S ; Match character in (or not in) this class, single char match only
87 ANYOFD ANYOF, sv charclass S ; Like ANYOF, but /d is in effect
88 ANYOFL ANYOF, sv charclass S ; Like ANYOF, but /l is in effect
89 ANYOFPOSIXL ANYOF, sv charclass_posixl S ; Like ANYOFL, but matches [[:posix:]] classes
92 ANYOFH 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
93 ANYOFHb ANYOF, sv 1 S ; Like ANYOFH, but all matches share the same UTF-8 start byte, given in the flags field
94 ANYOFHr ANYOF, sv 1 S ; Like ANYOFH, but the flags field contains packed bounds for all matchable UTF-8 start bytes.
95 ANYOFHs ANYOF, sv 1 S ; Like ANYOFHb, but has a string field that gives the leading matchable UTF-8 bytes; flags field is len
96 ANYOFR ANYOFR, packed 1 S ; Matches any character in the range given by its packed args: upper 12 bits is the max delta from the base lower 20; the flags field contains the lowest matchable UTF-8 start byte
97 ANYOFRb ANYOFR, packed 1 S ; Like ANYOFR, but all matches share the same UTF-8 start byte, given in the flags field
98 # There is no ANYOFRr because khw doesn't think there are likely to be real-world cases where such a large range is used.
100 ANYOFM ANYOFM, byte 1 S ; Like ANYOF, but matches an invariant byte as determined by the mask and arg
101 NANYOFM ANYOFM, byte 1 S ; complement of ANYOFM
103 #* POSIX Character Classes:
104 # Order of the below is important. See ordering comment above.
105 POSIXD POSIXD, none 0 S ; Some [[:class:]] under /d; the FLAGS field gives which one
106 POSIXL POSIXD, none 0 S ; Some [[:class:]] under /l; the FLAGS field gives which one
107 POSIXU POSIXD, none 0 S ; Some [[:class:]] under /u; the FLAGS field gives which one
108 POSIXA POSIXD, none 0 S ; Some [[:class:]] under /a; the FLAGS field gives which one
109 NPOSIXD NPOSIXD, none 0 S ; complement of POSIXD, [[:^class:]]
110 NPOSIXL NPOSIXD, none 0 S ; complement of POSIXL, [[:^class:]]
111 NPOSIXU NPOSIXD, none 0 S ; complement of POSIXU, [[:^class:]]
112 NPOSIXA NPOSIXD, none 0 S ; complement of POSIXA, [[:^class:]]
113 # End of order is important
115 CLUMP CLUMP, no 0 V ; Match any extended grapheme cluster sequence
119 #* BRANCH The set of branches constituting a single choice are
120 #* hooked together with their "next" pointers, since
121 #* precedence prevents anything being concatenated to
122 #* any individual branch. The "next" pointer of the last
123 #* BRANCH in a choice points to the thing following the
124 #* whole choice. This is also where the final "next"
125 #* pointer of each individual branch points; each branch
126 #* starts with the operand node of a BRANCH node.
128 BRANCH BRANCH, node 0 V ; Match this alternative, or the next...
131 # NOTE: the relative ordering of these types is important do not change it
133 EXACT EXACT, str ; Match this string (flags field is the length).
135 #* In a long string node, the U32 argument is the length, and is
136 #* immediately followed by the string.
137 LEXACT EXACT, len:str 1; Match this long string (preceded by length; flags unused).
138 EXACTL EXACT, str ; Like EXACT, but /l is in effect (used so locale-related warnings can be checked for)
139 EXACTF EXACT, str ; Like EXACT, but match using /id rules; (string not UTF-8, ASCII folded; non-ASCII not)
140 EXACTFL EXACT, str ; Like EXACT, but match using /il rules; (string not likely to be folded)
141 EXACTFU EXACT, str ; Like EXACT, but match using /iu rules; (string folded)
143 # The reason MICRO and SHARP S aren't folded in non-UTF8 patterns is because
144 # they would fold to something that requires UTF-8. SHARP S would normally
145 # fold to 'ss', but because of /aa, it instead folds to a pair of LATIN SMALL
146 # LETTER LONG S characters (U+017F)
147 EXACTFAA EXACT, str ; Like EXACT, but match using /iaa rules; (string folded except in non-UTF8 patterns: MICRO, SHARP S; folded length <= unfolded)
149 # End of important relative ordering.
151 EXACTFUP EXACT, str ; Like EXACT, but match using /iu rules; (string not UTF-8, folded except MICRO, SHARP S: hence Problematic)
152 # In order for a non-UTF-8 EXACTFAA to think the pattern is pre-folded when
153 # matching a UTF-8 target string, there would have to be something like an
154 # EXACTFAA_MICRO which would not be considered pre-folded for UTF-8 targets,
155 # since the fold of the MICRO SIGN would not be done, and would be
156 # representable in the UTF-8 target string.
158 EXACTFLU8 EXACT, str ; Like EXACTFU, but use /il, UTF-8, (string is folded, and everything in it is above 255
159 EXACTFAA_NO_TRIE EXACT, str ; Like EXACT, but match using /iaa rules (string not UTF-8, not guaranteed to be folded, not currently trie-able)
162 EXACT_REQ8 EXACT, str ; Like EXACT, but only UTF-8 encoded targets can match
163 LEXACT_REQ8 EXACT, len:str 1 ; Like LEXACT, but only UTF-8 encoded targets can match
164 EXACTFU_REQ8 EXACT, str ; Like EXACTFU, but only UTF-8 encoded targets can match
165 # One could add EXACTFAA8 and something that has the same effect for /l,
166 # but these would be extremely uncommon
168 EXACTFU_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)
172 NOTHING NOTHING, no ; Match empty string.
173 #*A variant of above which delimits a group, thus stops optimizations
174 TAIL NOTHING, no ; Match empty string. Can jump here from outside.
178 #* STAR,PLUS '?', and complex '*' and '+', are implemented as
179 #* circular BRANCH structures. Simple cases
180 #* (one character per match) are implemented with STAR
181 #* and PLUS for speed and to minimize recursive plunges.
183 STAR STAR, node 0 V ; Match this (simple) thing 0 or more times.
184 PLUS PLUS, node 0 V ; Match this (simple) thing 1 or more times.
186 CURLY CURLY, sv 2 V ; Match this simple thing {n,m} times.
187 CURLYN CURLY, no 2 V ; Capture next-after-this simple thing
188 CURLYM CURLY, no 2 V ; Capture this medium-complex thing {n,m} times.
189 CURLYX CURLY, sv 2 V ; Match this complex thing {n,m} times.
191 #*This terminator creates a loop structure for CURLYX
192 WHILEM WHILEM, no 0 V ; Do curly processing and see if rest matches.
196 #*OPEN,CLOSE,GROUPP ...are numbered at compile time.
197 OPEN OPEN, num 1 ; Mark this point in input as start of #n.
198 CLOSE CLOSE, num 1 ; Close corresponding OPEN of #n.
199 SROPEN SROPEN, none ; Same as OPEN, but for script run
200 SRCLOSE SRCLOSE, none ; Close preceding SROPEN
202 REF REF, num 1 V ; Match some already matched string
203 REFF REF, num 1 V ; Match already matched string, using /di rules.
204 REFFL REF, num 1 V ; Match already matched string, using /li rules.
205 # N?REFF[AU] could have been implemented using the FLAGS field of the
206 # regnode, but by having a separate node type, we can use the existing switch
207 # statement to avoid some tests
208 REFFU REF, num 1 V ; Match already matched string, usng /ui.
209 REFFA REF, num 1 V ; Match already matched string, using /aai rules.
211 #*Named references. Code in regcomp.c assumes that these all are after
212 #*the numbered references
213 REFN REF, no-sv 1 V ; Match some already matched string
214 REFFN REF, no-sv 1 V ; Match already matched string, using /di rules.
215 REFFLN REF, no-sv 1 V ; Match already matched string, using /li rules.
216 REFFUN REF, num 1 V ; Match already matched string, using /ui rules.
217 REFFAN REF, num 1 V ; Match already matched string, using /aai rules.
219 #*Support for long RE
220 LONGJMP LONGJMP, off 1 . 1 ; Jump far away.
221 BRANCHJ BRANCHJ, off 1 V 1 ; BRANCH with long offset.
223 #*Special Case Regops
224 IFMATCH 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
225 UNLESSM 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
226 SUSPEND BRANCHJ, off 1 V 1 ; "Independent" sub-RE.
227 IFTHEN BRANCHJ, off 1 V 1 ; Switch, should be preceded by switcher.
228 GROUPP GROUPP, num 1 ; Whether the group matched.
232 EVAL EVAL, evl/flags 2L ; Execute some Perl code.
236 MINMOD MINMOD, no ; Next operator is not greedy.
237 LOGICAL LOGICAL, no ; Next opcode should set the flag only.
239 #*This is not used yet
240 RENUM BRANCHJ, off 1 . 1 ; Group with independently numbered parens.
244 #* Behave the same as A|LIST|OF|WORDS would. The '..C' variants
245 #* have inline charclass data (ascii only), the 'C' store it in the
247 # NOTE: the relative order of the TRIE-like regops is significant
249 TRIE TRIE, trie 1 ; Match many EXACT(F[ALU]?)? at once. flags==type
250 TRIEC TRIE,trie charclass ; Same as TRIE, but with embedded charclass data
252 # For start classes, contains an added fail table.
253 AHOCORASICK TRIE, trie 1 ; Aho Corasick stclass. flags==type
254 AHOCORASICKC TRIE,trie charclass ; Same as AHOCORASICK, but with embedded charclass data
257 GOSUB GOSUB, num/ofs 2L ; recurse to paren arg1 at (signed) ofs arg2
259 #*Special conditionals
260 GROUPPN GROUPPN, no-sv 1 ; Whether the group matched.
261 INSUBP INSUBP, num 1 ; Whether we are in a specific recurse.
262 DEFINEP DEFINEP, none 1 ; Never execute directly.
265 ENDLIKE ENDLIKE, none ; Used only for the type field of verbs
266 OPFAIL ENDLIKE, no-sv 1 ; Same as (?!), but with verb arg
267 ACCEPT ENDLIKE, no-sv/num 2L ; Accepts the current matched string, with verbar
269 #*Verbs With Arguments
270 VERB VERB, no-sv 1 ; Used only for the type field of verbs
271 PRUNE VERB, no-sv 1 ; Pattern fails at this startpoint if no-backtracking through this
272 MARKPOINT VERB, no-sv 1 ; Push the current location for rollback by cut.
273 SKIP VERB, no-sv 1 ; On failure skip forward (to the mark) before retrying
274 COMMIT VERB, no-sv 1 ; Pattern fails outright if backtracking through this
275 CUTGROUP VERB, no-sv 1 ; On failure go to the next alternation in the group
277 #*Control what to keep in $&.
278 KEEPS KEEPS, no ; $& begins here.
280 #*New charclass like patterns
281 LNBREAK LNBREAK, none ; generic newline pattern
283 # NEW STUFF SOMEWHERE ABOVE THIS LINE
285 ################################################################################
289 #* This is not really a node, but an optimized away piece of a "long"
290 #* node. To simplify debugging output, we mark it as if it were a node
291 OPTIMIZED NOTHING, off ; Placeholder for dump.
293 #* Special opcode with the property that no opcode in a compiled program
294 #* will ever be of this type. Thus it can be used as a flag value that
295 #* no other opcode has been seen. END is used similarly, in that an END
296 #* node cant be optimized. So END implies "unoptimizable" and PSEUDO
297 #* mean "not seen anything to optimize yet".
298 PSEUDO PSEUDO, off ; Pseudo opcode for internal use.
300 -------------------------------------------------------------------------------
301 # Format for second section:
302 # REGOP \t typelist [ \t typelist]
307 # Anything below is a state
311 EVAL B,postponed_AB:FAIL
313 WHILEM A_pre,A_min,A_max,B_min,B_max:FAIL
317 CURLY B_min,B_max:FAIL