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