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