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