This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
regcomp.sym: Change regnode description
[perl5.git] / regcomp.sym
1 # regcomp.sym
2 #
3 # File has two sections, divided by a line of dashes '-'. 
4 #
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.
8 #
9 # First section is for regops, second section is for regmatch-states
10 #
11 # Note that the order in this file is important.
12 #
13 # Format for first section: 
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.
18 #
19 #
20 # run perl regen.pl after editing this file
21
22
23
24 #* Exit points
25
26 END         END,        no        ; End of program.
27 SUCCEED     END,        no        ; Return from a subroutine, basically.
28
29 #* Line Start Anchors:
30 #Note flags field for SBOL indicates if it is a /^/ or a /\A/
31 SBOL        BOL,        no        ; Match "" at beginning of line: /^/, /\A/
32 MBOL        BOL,        no        ; Same, assuming multiline: /^/m
33
34 #* Line End Anchors:
35 SEOL        EOL,        no        ; Match "" at end of line: /$/
36 MEOL        EOL,        no        ; Same, assuming multiline: /$/m
37 EOS         EOL,        no        ; Match "" at end of string: /\z/
38
39 #* Match Start Anchors:
40 GPOS        GPOS,       no        ; Matches where last m//g left off.
41
42 #* Word Boundary Opcodes:
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.
47 # BOUND, POSIX and their complements are affected, as well as EXACTF.
48 BOUND       BOUND,      no        ; Like BOUNDA for non-utf8, otherwise match "" between any Unicode \w\W or \W\w
49 BOUNDL      BOUND,      no        ; Like BOUND/BOUNDU, but \w and \W are defined by current locale
50 BOUNDU      BOUND,      no        ; Match "" at any boundary of a given type using /u rules.
51 BOUNDA      BOUND,      no        ; Match "" at any boundary between \w\W or \W\w, where \w is [_a-zA-Z0-9]
52 # All NBOUND nodes are required by code in regexec.c to be greater than all BOUND ones
53 NBOUND      NBOUND,     no        ; Like NBOUNDA for non-utf8, otherwise match "" between any Unicode \w\w or \W\W
54 NBOUNDL     NBOUND,     no        ; Like NBOUND/NBOUNDU, but \w and \W are defined by current locale
55 NBOUNDU     NBOUND,     no        ; Match "" at any non-boundary of a given type using using /u rules.
56 NBOUNDA     NBOUND,     no        ; Match "" betweeen any \w\w or \W\W, where \w is [_a-zA-Z0-9]
57
58 #* [Special] alternatives:
59 REG_ANY     REG_ANY,    no 0 S    ; Match any one character (except newline).
60 SANY        REG_ANY,    no 0 S    ; Match any one character.
61 ANYOF       ANYOF,      sv charclass S    ; Match character in (or not in) this class, single char match only
62 ANYOFD      ANYOF,      sv charclass S    ; Like ANYOF, but /d is in effect
63 ANYOFL      ANYOF,      sv charclass S    ; Like ANYOF, but /l is in effect
64 ANYOFPOSIXL ANYOF,      sv charclass_posixl S    ; Like ANYOFL, but matches [[:posix:]] classes
65 ANYOFH      ANYOF,      sv 1 S    ; Like ANYOF, but only has "High" matches, none in the bitmap;
66 ANYOFHb     ANYOF,      sv 1 S    ; Like ANYOFH, but all matches share the same UTF-8 start byte, given in the flags field
67 ANYOFM      ANYOFM      byte 1 S  ; Like ANYOF, but matches an invariant byte as determined by the mask and arg
68 NANYOFM     ANYOFM      byte 1 S  ; complement of ANYOFM
69
70 #* POSIX Character Classes:
71 # Order of the below is important.  See ordering comment above.
72 POSIXD      POSIXD,     none 0 S   ; Some [[:class:]] under /d; the FLAGS field gives which one
73 POSIXL      POSIXD,     none 0 S   ; Some [[:class:]] under /l; the FLAGS field gives which one
74 POSIXU      POSIXD,     none 0 S   ; Some [[:class:]] under /u; the FLAGS field gives which one
75 POSIXA      POSIXD,     none 0 S   ; Some [[:class:]] under /a; the FLAGS field gives which one
76 NPOSIXD     NPOSIXD,    none 0 S   ; complement of POSIXD, [[:^class:]]
77 NPOSIXL     NPOSIXD,    none 0 S   ; complement of POSIXL, [[:^class:]]
78 NPOSIXU     NPOSIXD,    none 0 S   ; complement of POSIXU, [[:^class:]]
79 NPOSIXA     NPOSIXD,    none 0 S   ; complement of POSIXA, [[:^class:]]
80 # End of order is important
81
82 CLUMP       CLUMP,      no 0 V    ; Match any extended grapheme cluster sequence
83
84 #* Alternation
85
86 #* BRANCH        The set of branches constituting a single choice are
87 #*               hooked together with their "next" pointers, since
88 #*               precedence prevents anything being concatenated to
89 #*               any individual branch.  The "next" pointer of the last
90 #*               BRANCH in a choice points to the thing following the
91 #*               whole choice.  This is also where the final "next"
92 #*               pointer of each individual branch points; each branch
93 #*               starts with the operand node of a BRANCH node.
94 #*
95 BRANCH      BRANCH,     node 0 V  ; Match this alternative, or the next...
96
97 #*Literals
98 # NOTE: the relative ordering of these types is important do not change it
99
100 EXACT       EXACT,      str       ; Match this string (preceded by length).
101 EXACTL      EXACT,      str       ; Like EXACT, but /l is in effect (used so locale-related warnings can be checked for).
102 EXACTF      EXACT,      str       ; Match this string using /id rules (w/len); (string not UTF-8, not guaranteed to be folded).
103 EXACTFL     EXACT,      str       ; Match this string using /il rules (w/len); (string not guaranteed to be folded).
104 EXACTFU     EXACT,      str       ; Match this string using /iu rules (w/len); (string folded iff in UTF-8; non-UTF8 folded length <= unfolded).
105 EXACTFAA    EXACT,      str       ; Match this string using /iaa rules (w/len) (string folded iff in UTF-8; non-UTF8 folded length <= unfolded).
106
107 # End of important relative ordering.
108
109 EXACTFUP    EXACT,      str       ; Match this string using /iu rules (w/len); (string not UTF-8, not guaranteed to be folded; and its Problematic).
110 # In order for a non-UTF-8 EXACTFAA to think the pattern is pre-folded when
111 # matching a UTF-8 target string, there would have to be something like an
112 # EXACTFAA_MICRO which would not be considered pre-folded for UTF-8 targets,
113 # since the fold of the MICRO SIGN would not be done, and would be
114 # representable in the UTF-8 target string.
115
116 EXACTFLU8   EXACT,      str       ; Like EXACTFU, but use /il, UTF-8, folded, and everything in it is above 255.
117 EXACTFAA_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).
118
119
120 EXACT_ONLY8 EXACT,      str       ; Like EXACT, but only UTF-8 encoded targets can match
121 EXACTFU_ONLY8 EXACT,    str       ; Like EXACTFU, but only UTF-8 encoded targets can match
122 # One could add EXACTFAA8 and something that has the same effect for /l,
123 # but these would be extremely uncommon
124
125 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).
126
127 #*Do nothing types
128
129 NOTHING     NOTHING,    no        ; Match empty string.
130 #*A variant of above which delimits a group, thus stops optimizations
131 TAIL        NOTHING,    no        ; Match empty string. Can jump here from outside.
132
133 #*Loops
134
135 #* STAR,PLUS    '?', and complex '*' and '+', are implemented as
136 #*               circular BRANCH structures.  Simple cases
137 #*               (one character per match) are implemented with STAR
138 #*               and PLUS for speed and to minimize recursive plunges.
139 #*
140 STAR        STAR,       node 0 V  ; Match this (simple) thing 0 or more times.
141 PLUS        PLUS,       node 0 V  ; Match this (simple) thing 1 or more times.
142
143 CURLY       CURLY,      sv 2 V    ; Match this simple thing {n,m} times.
144 CURLYN      CURLY,      no 2 V    ; Capture next-after-this simple thing 
145 CURLYM      CURLY,      no 2 V    ; Capture this medium-complex thing {n,m} times. 
146 CURLYX      CURLY,      sv 2 V    ; Match this complex thing {n,m} times.
147
148 #*This terminator creates a loop structure for CURLYX
149 WHILEM      WHILEM,     no 0 V    ; Do curly processing and see if rest matches.
150
151 #*Buffer related
152
153 #*OPEN,CLOSE,GROUPP     ...are numbered at compile time.
154 OPEN        OPEN,       num 1     ; Mark this point in input as start of #n.
155 CLOSE       CLOSE,      num 1     ; Close corresponding OPEN of #n.
156 SROPEN      SROPEN,     none      ; Same as OPEN, but for script run
157 SRCLOSE     SRCLOSE,    none      ; Close preceding SROPEN
158
159 REF         REF,        num 1 V   ; Match some already matched string
160 REFF        REF,        num 1 V   ; Match already matched string, using /di rules.
161 REFFL       REF,        num 1 V   ; Match already matched string, using /li rules.
162 # N?REFF[AU] could have been implemented using the FLAGS field of the
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, usng /ui.
166 REFFA       REF,        num 1 V   ; Match already matched string, using /aai rules.
167
168 #*Named references.  Code in regcomp.c assumes that these all are after
169 #*the numbered references
170 REFN        REF,        no-sv 1 V ; Match some already matched string
171 REFFN       REF,        no-sv 1 V ; Match already matched string, using /di rules.
172 REFFLN      REF,        no-sv 1 V ; Match already matched string, using /li rules.
173 REFFUN      REF,        num   1 V ; Match already matched string, using /ui rules.
174 REFFAN      REF,        num   1 V ; Match already matched string, using /aai rules.
175
176 #*Support for long RE
177 LONGJMP     LONGJMP,    off 1 . 1 ; Jump far away.
178 BRANCHJ     BRANCHJ,    off 1 V 1 ; BRANCH with long offset.
179
180 #*Special Case Regops
181 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
182 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
183 SUSPEND     BRANCHJ,    off 1 V 1 ; "Independent" sub-RE.
184 IFTHEN      BRANCHJ,    off 1 V 1 ; Switch, should be preceded by switcher.
185 GROUPP      GROUPP,     num 1     ; Whether the group matched.
186
187
188 #*The heavy worker
189
190 EVAL        EVAL,       evl/flags 2L ; Execute some Perl code.
191
192 #*Modifiers
193
194 MINMOD      MINMOD,     no        ; Next operator is not greedy.
195 LOGICAL     LOGICAL,    no        ; Next opcode should set the flag only.
196
197 #*This is not used yet
198 RENUM       BRANCHJ,    off 1 . 1 ; Group with independently numbered parens.
199
200 #*Trie Related
201
202 #* Behave the same as A|LIST|OF|WORDS would. The '..C' variants
203 #* have inline charclass data (ascii only), the 'C' store it in the
204 #* structure.
205 # NOTE: the relative order of the TRIE-like regops  is significant
206
207 TRIE        TRIE,       trie 1    ; Match many EXACT(F[ALU]?)? at once. flags==type
208 TRIEC       TRIE,trie charclass   ; Same as TRIE, but with embedded charclass data
209
210 # For start classes, contains an added fail table.
211 AHOCORASICK     TRIE,   trie 1    ; Aho Corasick stclass. flags==type
212 AHOCORASICKC    TRIE,trie charclass   ; Same as AHOCORASICK, but with embedded charclass data
213
214 #*Regex Subroutines
215 GOSUB       GOSUB,      num/ofs 2L    ; recurse to paren arg1 at (signed) ofs arg2
216
217 #*Special conditionals
218 GROUPPN     GROUPPN,    no-sv 1   ; Whether the group matched.
219 INSUBP      INSUBP,     num 1     ; Whether we are in a specific recurse.  
220 DEFINEP     DEFINEP,    none 1    ; Never execute directly.               
221
222 #*Backtracking Verbs
223 ENDLIKE     ENDLIKE,    none      ; Used only for the type field of verbs
224 OPFAIL      ENDLIKE,    no-sv 1   ; Same as (?!), but with verb arg
225 ACCEPT      ENDLIKE,    no-sv/num 2L   ; Accepts the current matched string, with verbar
226
227 #*Verbs With Arguments
228 VERB        VERB,       no-sv 1   ; Used only for the type field of verbs
229 PRUNE       VERB,       no-sv 1   ; Pattern fails at this startpoint if no-backtracking through this 
230 MARKPOINT   VERB,       no-sv 1   ; Push the current location for rollback by cut.
231 SKIP        VERB,       no-sv 1   ; On failure skip forward (to the mark) before retrying
232 COMMIT      VERB,       no-sv 1   ; Pattern fails outright if backtracking through this
233 CUTGROUP    VERB,       no-sv 1   ; On failure go to the next alternation in the group
234
235 #*Control what to keep in $&.
236 KEEPS       KEEPS,      no        ; $& begins here.
237
238 #*New charclass like patterns
239 LNBREAK     LNBREAK,    none      ; generic newline pattern
240
241 # NEW STUFF SOMEWHERE ABOVE THIS LINE
242
243 ################################################################################
244
245 #*SPECIAL  REGOPS
246
247 #* This is not really a node, but an optimized away piece of a "long"
248 #* node.  To simplify debugging output, we mark it as if it were a node
249 OPTIMIZED   NOTHING,    off       ; Placeholder for dump.
250
251 #* Special opcode with the property that no opcode in a compiled program
252 #* will ever be of this type. Thus it can be used as a flag value that
253 #* no other opcode has been seen. END is used similarly, in that an END
254 #* node cant be optimized. So END implies "unoptimizable" and PSEUDO
255 #* mean "not seen anything to optimize yet".
256 PSEUDO      PSEUDO,     off       ; Pseudo opcode for internal use.
257
258 -------------------------------------------------------------------------------
259 # Format for second section:
260 # REGOP \t typelist [ \t typelist]
261 # typelist= namelist
262 #         = namelist:FAIL
263 #         = name:count
264
265 # Anything below is a state
266 #
267 #
268 TRIE            next:FAIL
269 EVAL            B,postponed_AB:FAIL
270 CURLYX          end:FAIL
271 WHILEM          A_pre,A_min,A_max,B_min,B_max:FAIL
272 BRANCH          next:FAIL
273 CURLYM          A,B:FAIL
274 IFMATCH         A:FAIL
275 CURLY           B_min,B_max:FAIL
276 COMMIT          next:FAIL
277 MARKPOINT       next:FAIL
278 SKIP            next:FAIL
279 CUTGROUP        next:FAIL
280 KEEPS           next:FAIL