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