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