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