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