This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Silence verbatim line pod warning in perldebguts
[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
f6eaa562
KW
65
66# Must be sequential
29a889ef 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
a5bc0742 68ANYOFHb ANYOF, sv 1 S ; Like ANYOFH, but all matches share the same UTF-8 start byte, given in the flags field
3146c00a 69ANYOFHr ANYOF, sv 1 S ; Like ANYOFH, but the flags field contains packed bounds for all matchable UTF-8 start bytes.
f6eaa562 70
67a1b5f9 71ANYOFM ANYOFM byte 1 S ; Like ANYOF, but matches an invariant byte as determined by the mask and arg
3db0bccc 72NANYOFM ANYOFM byte 1 S ; complement of ANYOFM
693fefec 73
d3d47aac 74#* POSIX Character Classes:
3018b823
KW
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
3615ea58 79POSIXA POSIXD, none 0 S ; Some [[:class:]] under /a; the FLAGS field gives which one
3018b823
KW
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:]]
9e84774b 83NPOSIXA NPOSIXD, none 0 S ; complement of POSIXA, [[:^class:]]
3018b823 84# End of order is important
693fefec 85
2448cf39 86CLUMP CLUMP, no 0 V ; Match any extended grapheme cluster sequence
d09b2d29 87
381b57db 88#* Alternation
1de06328 89
65aa4ca7
FC
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#*
f9ef50a7 99BRANCH BRANCH, node 0 V ; Match this alternative, or the next...
d09b2d29 100
65aa4ca7
FC
101#*Literals
102# NOTE: the relative ordering of these types is important do not change it
1de06328 103
3ace85ea 104EXACT EXACT, str ; Match this string (flags field is the length).
b24abbc8 105EXACTL EXACT, str ; Like EXACT, but /l is in effect (used so locale-related warnings can be checked for).
4f4c2c24
KW
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).
2f306ab9
KW
110
111# End of important relative ordering.
112
627a7895 113EXACTFUP EXACT, str ; Match this string using /iu rules (w/len); (string not UTF-8, not guaranteed to be folded; and its Problematic).
aa419ff3
KW
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
4f4c2c24
KW
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).
d09b2d29 122
4f4c2c24
KW
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
efec1f81 126# One could add EXACTFAA8 and something that has the same effect for /l,
a9f8c7ac 127# but these would be extremely uncommon
f6b4b99d 128
95fb0a6e 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).
8a100c91 130
381b57db 131#*Do nothing types
1de06328 132
f8abb37e 133NOTHING NOTHING, no ; Match empty string.
65aa4ca7 134#*A variant of above which delimits a group, thus stops optimizations
f8abb37e 135TAIL NOTHING, no ; Match empty string. Can jump here from outside.
d09b2d29 136
381b57db 137#*Loops
1de06328 138
65aa4ca7 139#* STAR,PLUS '?', and complex '*' and '+', are implemented as
62e6ef33 140#* circular BRANCH structures. Simple cases
65aa4ca7
FC
141#* (one character per match) are implemented with STAR
142#* and PLUS for speed and to minimize recursive plunges.
143#*
f9ef50a7
NC
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.
d09b2d29 146
f9ef50a7
NC
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.
d09b2d29 151
65aa4ca7 152#*This terminator creates a loop structure for CURLYX
f9ef50a7 153WHILEM WHILEM, no 0 V ; Do curly processing and see if rest matches.
d09b2d29 154
381b57db 155#*Buffer related
1de06328 156
65aa4ca7 157#*OPEN,CLOSE,GROUPP ...are numbered at compile time.
f8abb37e 158OPEN OPEN, num 1 ; Mark this point in input as start of #n.
48e88d42 159CLOSE CLOSE, num 1 ; Close corresponding OPEN of #n.
07093db4
KW
160SROPEN SROPEN, none ; Same as OPEN, but for script run
161SRCLOSE SRCLOSE, none ; Close preceding SROPEN
d09b2d29 162
f9ef50a7 163REF REF, num 1 V ; Match some already matched string
912b808c
KW
164REFF REF, num 1 V ; Match already matched string, using /di rules.
165REFFL REF, num 1 V ; Match already matched string, using /li rules.
781aab5c 166# N?REFF[AU] could have been implemented using the FLAGS field of the
01f98ec2
KW
167# regnode, but by having a separate node type, we can use the existing switch
168# statement to avoid some tests
912b808c
KW
169REFFU REF, num 1 V ; Match already matched string, usng /ui.
170REFFA REF, num 1 V ; Match already matched string, using /aai rules.
d09b2d29 171
65aa4ca7
FC
172#*Named references. Code in regcomp.c assumes that these all are after
173#*the numbered references
016b7209
KW
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.
1de06328 179
d3d47aac
YO
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
2abbd513
KW
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
f9ef50a7 187SUSPEND BRANCHJ, off 1 V 1 ; "Independent" sub-RE.
65aa4ca7 188IFTHEN BRANCHJ, off 1 V 1 ; Switch, should be preceded by switcher.
f8abb37e 189GROUPP GROUPP, num 1 ; Whether the group matched.
d09b2d29 190
d09b2d29 191
381b57db 192#*The heavy worker
1de06328 193
13f27704 194EVAL EVAL, evl/flags 2L ; Execute some Perl code.
d09b2d29 195
381b57db 196#*Modifiers
1de06328 197
f8abb37e
NC
198MINMOD MINMOD, no ; Next operator is not greedy.
199LOGICAL LOGICAL, no ; Next opcode should set the flag only.
d09b2d29 200
65aa4ca7 201#*This is not used yet
f9ef50a7 202RENUM BRANCHJ, off 1 . 1 ; Group with independently numbered parens.
d09b2d29 203
381b57db 204#*Trie Related
1de06328 205
65aa4ca7
FC
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.
486ec47a 209# NOTE: the relative order of the TRIE-like regops is significant
ce5e9471 210
7986cb47 211TRIE TRIE, trie 1 ; Match many EXACT(F[ALU]?)? at once. flags==type
f8abb37e 212TRIEC TRIE,trie charclass ; Same as TRIE, but with embedded charclass data
3dab1dad 213
1de06328 214# For start classes, contains an added fail table.
f8abb37e
NC
215AHOCORASICK TRIE, trie 1 ; Aho Corasick stclass. flags==type
216AHOCORASICKC TRIE,trie charclass ; Same as AHOCORASICK, but with embedded charclass data
1de06328 217
381b57db 218#*Regex Subroutines
f8abb37e 219GOSUB GOSUB, num/ofs 2L ; recurse to paren arg1 at (signed) ofs arg2
03363afd 220
381b57db 221#*Special conditionals
016b7209 222GROUPPN GROUPPN, no-sv 1 ; Whether the group matched.
f8abb37e
NC
223INSUBP INSUBP, num 1 ; Whether we are in a specific recurse.
224DEFINEP DEFINEP, none 1 ; Never execute directly.
0a4db386 225
486ec47a 226#*Backtracking Verbs
f8abb37e 227ENDLIKE ENDLIKE, none ; Used only for the type field of verbs
fee50582
YO
228OPFAIL ENDLIKE, no-sv 1 ; Same as (?!), but with verb arg
229ACCEPT ENDLIKE, no-sv/num 2L ; Accepts the current matched string, with verbar
5d458dd8
YO
230
231#*Verbs With Arguments
f8abb37e
NC
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
e2e6a0f1 238
ee9b8eae 239#*Control what to keep in $&.
f8abb37e 240KEEPS KEEPS, no ; $& begins here.
ee9b8eae 241
e1d1eefb 242#*New charclass like patterns
f8abb37e 243LNBREAK LNBREAK, none ; generic newline pattern
3172e3fd 244
381b57db 245# NEW STUFF SOMEWHERE ABOVE THIS LINE
1de06328 246
03363afd
YO
247################################################################################
248
7f69552c 249#*SPECIAL REGOPS
1de06328 250
65aa4ca7
FC
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
f8abb37e 253OPTIMIZED NOTHING, off ; Placeholder for dump.
1de06328 254
65aa4ca7
FC
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".
f8abb37e 260PSEUDO PSEUDO, off ; Pseudo opcode for internal use.
1de06328 261
03363afd
YO
262-------------------------------------------------------------------------------
263# Format for second section:
65aa4ca7 264# REGOP \t typelist [ \t typelist]
03363afd
YO
265# typelist= namelist
266# = namelist:FAIL
267# = name:count
268
269# Anything below is a state
270#
271#
f8abb37e 272TRIE next:FAIL
4ee16520 273EVAL B,postponed_AB:FAIL
f8abb37e
NC
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
21cbe009 279CURLY B_min,B_max:FAIL
f8abb37e
NC
280COMMIT next:FAIL
281MARKPOINT next:FAIL
282SKIP next:FAIL
283CUTGROUP next:FAIL
284KEEPS next:FAIL