This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
regcomp.sym: Update \b descriptions
[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:
519ebf3d
KW
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
03363afd 16#
3dab1dad 17#
c476f425 18# run perl regen.pl after editing this file
3dab1dad 19
03363afd
YO
20
21
381b57db 22#* Exit points
1de06328 23
f8abb37e
NC
24END END, no ; End of program.
25SUCCEED END, no ; Return from a subroutine, basically.
d09b2d29 26
d3d47aac 27#* Line Start Anchors:
1645b83c 28#Note flags field for SBOL indicates if it is a /^/ or a /\A/
d3d47aac
YO
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:
693fefec
KW
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.
3018b823 45# BOUND, POSIX and their complements are affected, as well as EXACTF.
c440a570
KW
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
64935bc6 48BOUNDU BOUND, no ; Match "" at any boundary of a given type using Unicode rules
c440a570 49BOUNDA BOUND, no ; Match "" at any boundary between \w\W or \W\w, where \w is [_a-zA-Z0-9]
693fefec 50# All NBOUND nodes are required by code in regexec.c to be greater than all BOUND ones
c440a570
KW
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]
d09b2d29 55
381b57db 56#* [Special] alternatives:
f9ef50a7
NC
57REG_ANY REG_ANY, no 0 S ; Match any one character (except newline).
58SANY REG_ANY, no 0 S ; Match any one character.
59CANY REG_ANY, no 0 S ; Match any one byte.
975a06f7 60ANYOF ANYOF, sv 1 S ; Match character in (or not in) this class, single char match only
a4525e78 61ANYOFL ANYOF, sv 1 S ; Like ANYOF, but /l is in effect
693fefec 62
d3d47aac 63#* POSIX Character Classes:
3018b823
KW
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
3615ea58 68POSIXA POSIXD, none 0 S ; Some [[:class:]] under /a; the FLAGS field gives which one
3018b823
KW
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:]]
9e84774b 72NPOSIXA NPOSIXD, none 0 S ; complement of POSIXA, [[:^class:]]
3018b823 73# End of order is important
693fefec 74
2448cf39 75CLUMP CLUMP, no 0 V ; Match any extended grapheme cluster sequence
d09b2d29 76
381b57db 77#* Alternation
1de06328 78
65aa4ca7
FC
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#*
f9ef50a7 88BRANCH BRANCH, node 0 V ; Match this alternative, or the next...
d09b2d29 89
65aa4ca7
FC
90#*Literals
91# NOTE: the relative ordering of these types is important do not change it
1de06328 92
f8abb37e 93EXACT EXACT, str ; Match this string (preceded by length).
a4525e78 94EXACTL EXACT, str ; Like EXACT, but /l is in effect.
a36afff1
KW
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).
3c760661 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).
8c1182fd 98EXACTFA EXACT, str ; Match this string (not guaranteed to be folded) using /iaa rules (w/len).
2f306ab9
KW
99
100# End of important relative ordering.
101
3c760661 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).
a4525e78 103EXACTFLU8 EXACT, str ; Rare cirucmstances: like EXACTFU, but is under /l, UTF-8, folded, and everything in it is above 255.
098b07d5 104EXACTFA_NO_TRIE EXACT, str ; Match this string (which is not trie-able; not guaranteed to be folded) using /iaa rules (w/len).
d09b2d29 105
381b57db 106#*Do nothing types
1de06328 107
f8abb37e 108NOTHING NOTHING, no ; Match empty string.
65aa4ca7 109#*A variant of above which delimits a group, thus stops optimizations
f8abb37e 110TAIL NOTHING, no ; Match empty string. Can jump here from outside.
d09b2d29 111
381b57db 112#*Loops
1de06328 113
65aa4ca7 114#* STAR,PLUS '?', and complex '*' and '+', are implemented as
62e6ef33 115#* circular BRANCH structures. Simple cases
65aa4ca7
FC
116#* (one character per match) are implemented with STAR
117#* and PLUS for speed and to minimize recursive plunges.
118#*
f9ef50a7
NC
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.
d09b2d29 121
f9ef50a7
NC
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.
d09b2d29 126
65aa4ca7 127#*This terminator creates a loop structure for CURLYX
f9ef50a7 128WHILEM WHILEM, no 0 V ; Do curly processing and see if rest matches.
d09b2d29 129
381b57db 130#*Buffer related
1de06328 131
65aa4ca7 132#*OPEN,CLOSE,GROUPP ...are numbered at compile time.
f8abb37e
NC
133OPEN OPEN, num 1 ; Mark this point in input as start of #n.
134CLOSE CLOSE, num 1 ; Analogous to OPEN.
d09b2d29 135
f9ef50a7 136REF REF, num 1 V ; Match some already matched string
850b7ec9 137REFF REF, num 1 V ; Match already matched string, folded using native charset rules for non-utf8
f9ef50a7 138REFFL REF, num 1 V ; Match already matched string, folded in loc.
781aab5c 139# N?REFF[AU] could have been implemented using the FLAGS field of the
01f98ec2
KW
140# regnode, but by having a separate node type, we can use the existing switch
141# statement to avoid some tests
850b7ec9
KW
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
d09b2d29 144
65aa4ca7
FC
145#*Named references. Code in regcomp.c assumes that these all are after
146#*the numbered references
01f98ec2 147NREF REF, no-sv 1 V ; Match some already matched string
850b7ec9 148NREFF REF, no-sv 1 V ; Match already matched string, folded using native charset rules for non-utf8
01f98ec2 149NREFFL REF, no-sv 1 V ; Match already matched string, folded in loc.
850b7ec9
KW
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
1de06328 152
d3d47aac
YO
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
f9ef50a7
NC
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.
65aa4ca7 161IFTHEN BRANCHJ, off 1 V 1 ; Switch, should be preceded by switcher.
f8abb37e 162GROUPP GROUPP, num 1 ; Whether the group matched.
d09b2d29 163
d09b2d29 164
381b57db 165#*The heavy worker
1de06328 166
13f27704 167EVAL EVAL, evl/flags 2L ; Execute some Perl code.
d09b2d29 168
381b57db 169#*Modifiers
1de06328 170
f8abb37e
NC
171MINMOD MINMOD, no ; Next operator is not greedy.
172LOGICAL LOGICAL, no ; Next opcode should set the flag only.
d09b2d29 173
65aa4ca7 174#*This is not used yet
f9ef50a7 175RENUM BRANCHJ, off 1 . 1 ; Group with independently numbered parens.
d09b2d29 176
381b57db 177#*Trie Related
1de06328 178
65aa4ca7
FC
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.
486ec47a 182# NOTE: the relative order of the TRIE-like regops is significant
ce5e9471 183
7986cb47 184TRIE TRIE, trie 1 ; Match many EXACT(F[ALU]?)? at once. flags==type
f8abb37e 185TRIEC TRIE,trie charclass ; Same as TRIE, but with embedded charclass data
3dab1dad 186
1de06328 187# For start classes, contains an added fail table.
f8abb37e
NC
188AHOCORASICK TRIE, trie 1 ; Aho Corasick stclass. flags==type
189AHOCORASICKC TRIE,trie charclass ; Same as AHOCORASICK, but with embedded charclass data
1de06328 190
381b57db 191#*Regex Subroutines
f8abb37e
NC
192GOSUB GOSUB, num/ofs 2L ; recurse to paren arg1 at (signed) ofs arg2
193GOSTART GOSTART, no ; recurse to start of pattern
03363afd 194
381b57db 195#*Special conditionals
f8abb37e
NC
196NGROUPP NGROUPP, no-sv 1 ; Whether the group matched.
197INSUBP INSUBP, num 1 ; Whether we are in a specific recurse.
198DEFINEP DEFINEP, none 1 ; Never execute directly.
0a4db386 199
486ec47a 200#*Backtracking Verbs
f8abb37e
NC
201ENDLIKE ENDLIKE, none ; Used only for the type field of verbs
202OPFAIL ENDLIKE, none ; Same as (?!)
203ACCEPT ENDLIKE, parno 1 ; Accepts the current matched string.
5d458dd8
YO
204
205
206#*Verbs With Arguments
f8abb37e
NC
207VERB VERB, no-sv 1 ; Used only for the type field of verbs
208PRUNE VERB, no-sv 1 ; Pattern fails at this startpoint if no-backtracking through this
209MARKPOINT VERB, no-sv 1 ; Push the current location for rollback by cut.
210SKIP VERB, no-sv 1 ; On failure skip forward (to the mark) before retrying
211COMMIT VERB, no-sv 1 ; Pattern fails outright if backtracking through this
212CUTGROUP VERB, no-sv 1 ; On failure go to the next alternation in the group
e2e6a0f1 213
ee9b8eae 214#*Control what to keep in $&.
f8abb37e 215KEEPS KEEPS, no ; $& begins here.
ee9b8eae 216
e1d1eefb 217#*New charclass like patterns
f8abb37e 218LNBREAK LNBREAK, none ; generic newline pattern
3172e3fd 219
381b57db 220# NEW STUFF SOMEWHERE ABOVE THIS LINE
1de06328 221
03363afd
YO
222################################################################################
223
7f69552c 224#*SPECIAL REGOPS
1de06328 225
65aa4ca7
FC
226#* This is not really a node, but an optimized away piece of a "long"
227#* node. To simplify debugging output, we mark it as if it were a node
f8abb37e 228OPTIMIZED NOTHING, off ; Placeholder for dump.
1de06328 229
65aa4ca7
FC
230#* Special opcode with the property that no opcode in a compiled program
231#* will ever be of this type. Thus it can be used as a flag value that
232#* no other opcode has been seen. END is used similarly, in that an END
233#* node cant be optimized. So END implies "unoptimizable" and PSEUDO
234#* mean "not seen anything to optimize yet".
f8abb37e 235PSEUDO PSEUDO, off ; Pseudo opcode for internal use.
1de06328 236
03363afd
YO
237-------------------------------------------------------------------------------
238# Format for second section:
65aa4ca7 239# REGOP \t typelist [ \t typelist]
03363afd
YO
240# typelist= namelist
241# = namelist:FAIL
242# = name:count
243
244# Anything below is a state
245#
246#
f8abb37e
NC
247TRIE next:FAIL
248EVAL AB:FAIL
249CURLYX end:FAIL
250WHILEM A_pre,A_min,A_max,B_min,B_max:FAIL
251BRANCH next:FAIL
252CURLYM A,B:FAIL
253IFMATCH A:FAIL
254CURLY B_min_known,B_min,B_max:FAIL
255COMMIT next:FAIL
256MARKPOINT next:FAIL
257SKIP next:FAIL
258CUTGROUP next:FAIL
259KEEPS next:FAIL