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