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