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