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