This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
An optimisation to the MRO code, by Brandon Black,
[perl5.git] / regcomp.sym
CommitLineData
03363afd
YO
1# regcomp.sym
2#
3# File has two sections, divided by a line of dashes '-'.
4#
5# Empty rows after #-comment are removed from input are ignored
6#
7# First section is for regops, second sectionis for regmatch-states
8#
3dab1dad
YO
9# Note that the order in this file is important.
10#
03363afd
YO
11# Format for first section:
12# NAME \t TYPE, arg-description [num-args] [longjump-len] \t DESCRIPTION
13#
3dab1dad 14#
c476f425 15# run perl regen.pl after editing this file
3dab1dad 16
03363afd
YO
17
18
1de06328
YO
19#* Exit points (0,1)
20
d09b2d29
IZ
21END END, no End of program.
22SUCCEED END, no Return from a subroutine, basically.
23
1de06328
YO
24#* Anchors: (2..13)
25
d09b2d29
IZ
26BOL BOL, no Match "" at beginning of line.
27MBOL BOL, no Same, assuming multiline.
28SBOL BOL, no Same, assuming singleline.
b85d18e9 29EOS EOL, no Match "" at end of string.
d09b2d29
IZ
30EOL EOL, no Match "" at end of line.
31MEOL EOL, no Same, assuming multiline.
32SEOL EOL, no Same, assuming singleline.
33BOUND BOUND, no Match "" at any word boundary
34BOUNDL BOUND, no Match "" at any word boundary
35NBOUND NBOUND, no Match "" at any word non-boundary
36NBOUNDL NBOUND, no Match "" at any word non-boundary
37GPOS GPOS, no Matches where last m//g left off.
38
1de06328
YO
39#* [Special] alternatives: (14..30)
40
22c35a8c 41REG_ANY REG_ANY, no Match any one character (except newline).
22c35a8c 42SANY REG_ANY, no Match any one character.
f33976b4 43CANY REG_ANY, no Match any one byte.
d09b2d29
IZ
44ANYOF ANYOF, sv Match character in (or not in) this class.
45ALNUM ALNUM, no Match any alphanumeric character
46ALNUML ALNUM, no Match any alphanumeric char in locale
47NALNUM NALNUM, no Match any non-alphanumeric character
48NALNUML NALNUM, no Match any non-alphanumeric char in locale
49SPACE SPACE, no Match any whitespace character
50SPACEL SPACE, no Match any whitespace char in locale
51NSPACE NSPACE, no Match any non-whitespace character
52NSPACEL NSPACE, no Match any non-whitespace char in locale
53DIGIT DIGIT, no Match any numeric character
b8c5462f 54DIGITL DIGIT, no Match any numeric character in locale
d09b2d29 55NDIGIT NDIGIT, no Match any non-numeric character
b8c5462f 56NDIGITL NDIGIT, no Match any non-numeric character in locale
a0ed51b3 57CLUMP CLUMP, no Match any combining character sequence
d09b2d29 58
1de06328
YO
59#* Alternation (31)
60
61# BRANCH The set of branches constituting a single choice are hooked
d09b2d29
IZ
62# together with their "next" pointers, since precedence prevents
63# anything being concatenated to any individual branch. The
64# "next" pointer of the last BRANCH in a choice points to the
65# thing following the whole choice. This is also where the
66# final "next" pointer of each individual branch points; each
67# branch starts with the operand node of a BRANCH node.
68#
69BRANCH BRANCH, node Match this alternative, or the next...
70
1de06328
YO
71#*Back pointer (32)
72
d09b2d29
IZ
73# BACK Normal "next" pointers all implicitly point forward; BACK
74# exists to make loop structures possible.
75# not used
76BACK BACK, no Match "", "next" ptr points backward.
77
1de06328
YO
78#*Literals (33..35)
79
81714fb9
YO
80EXACT EXACT, str Match this string (preceded by length).
81EXACTF EXACT, str Match this string, folded (prec. by length).
82EXACTFL EXACT, str Match this string, folded in locale (w/len).
d09b2d29 83
1de06328
YO
84#*Do nothing types (36..37)
85
d09b2d29
IZ
86NOTHING NOTHING,no Match empty string.
87# A variant of above which delimits a group, thus stops optimizations
88TAIL NOTHING,no Match empty string. Can jump here from outside.
89
1de06328
YO
90#*Loops (38..44)
91
d09b2d29
IZ
92# STAR,PLUS '?', and complex '*' and '+', are implemented as circular
93# BRANCH structures using BACK. Simple cases (one character
94# per match) are implemented with STAR and PLUS for speed
95# and to minimize recursive plunges.
96#
97STAR STAR, node Match this (simple) thing 0 or more times.
98PLUS PLUS, node Match this (simple) thing 1 or more times.
99
100CURLY CURLY, sv 2 Match this simple thing {n,m} times.
40d049e4
YO
101CURLYN CURLY, no 2 Capture next-after-this simple thing
102CURLYM CURLY, no 2 Capture this medium-complex thing {n,m} times.
d09b2d29
IZ
103CURLYX CURLY, sv 2 Match this complex thing {n,m} times.
104
105# This terminator creates a loop structure for CURLYX
106WHILEM WHILEM, no Do curly processing and see if rest matches.
107
1de06328
YO
108#*Buffer related (45..49)
109
d09b2d29
IZ
110# OPEN,CLOSE,GROUPP ...are numbered at compile time.
111OPEN OPEN, num 1 Mark this point in input as start of #n.
112CLOSE CLOSE, num 1 Analogous to OPEN.
113
114REF REF, num 1 Match some already matched string
115REFF REF, num 1 Match already matched string, folded
116REFFL REF, num 1 Match already matched string, folded in loc.
117
1de06328
YO
118#*Grouping assertions (50..54)
119
d09b2d29
IZ
120IFMATCH BRANCHJ,off 1 2 Succeeds if the following matches.
121UNLESSM BRANCHJ,off 1 2 Fails if the following matches.
122SUSPEND BRANCHJ,off 1 1 "Independent" sub-RE.
123IFTHEN BRANCHJ,off 1 1 Switch, should be preceeded by switcher .
124GROUPP GROUPP, num 1 Whether the group matched.
125
1de06328
YO
126#*Support for long RE (55..56)
127
d09b2d29
IZ
128LONGJMP LONGJMP,off 1 1 Jump far away.
129BRANCHJ BRANCHJ,off 1 1 BRANCH with long offset.
130
1de06328
YO
131#*The heavy worker (57..58)
132
d09b2d29
IZ
133EVAL EVAL, evl 1 Execute some Perl code.
134
1de06328
YO
135#*Modifiers (59..60)
136
d09b2d29
IZ
137MINMOD MINMOD, no Next operator is not greedy.
138LOGICAL LOGICAL,no Next opcode should set the flag only.
139
1de06328 140# This is not used yet (61)
d09b2d29
IZ
141RENUM BRANCHJ,off 1 1 Group with independently numbered parens.
142
1de06328
YO
143#*Trie Related (62..64)
144
145# Behave the same as A|LIST|OF|WORDS would. The '..C' variants have
146# inline charclass data (ascii only), the 'C' store it in the structure.
147# NOTE: the relative order of the TRIE-like regops is signifigant
ce5e9471 148
5d458dd8
YO
149TRIE TRIE, trie 1 Match many EXACT(FL?)? at once. flags==type
150TRIEC TRIE,trie charclass Same as TRIE, but with embedded charclass data
3dab1dad 151
1de06328 152# For start classes, contains an added fail table.
5d458dd8
YO
153AHOCORASICK TRIE, trie 1 Aho Corasick stclass. flags==type
154AHOCORASICKC TRIE,trie charclass Same as AHOCORASICK, but with embedded charclass data
1de06328 155
1a147d38 156#*Regex Subroutines (65..66)
5d458dd8 157GOSUB GOSUB, num/ofs 2L recurse to paren arg1 at (signed) ofs arg2
1a147d38 158GOSTART GOSTART, no recurse to start of pattern
03363afd 159
81714fb9 160#*Named references (67..69)
ee9b8eae
YO
161NREF REF, no-sv 1 Match some already matched string
162NREFF REF, no-sv 1 Match already matched string, folded
163NREFFL REF, no-sv 1 Match already matched string, folded in loc.
81714fb9
YO
164
165
7f69552c 166#*Special conditionals (70..72)
0a4db386 167NGROUPP NGROUPP, no-sv 1 Whether the group matched.
1a147d38 168INSUBP INSUBP, num 1 Whether we are in a specific recurse.
0a4db386
YO
169DEFINEP DEFINEP, none 1 Never execute directly.
170
5d458dd8 171#*Bactracking Verbs
e2e6a0f1
YO
172ENDLIKE ENDLIKE, none Used only for the type field of verbs
173OPFAIL ENDLIKE, none Same as (?!)
174ACCEPT ENDLIKE, parno 1 Accepts the current matched string.
5d458dd8
YO
175
176
177#*Verbs With Arguments
e2e6a0f1 178VERB VERB, no-sv 1 Used only for the type field of verbs
5d458dd8 179PRUNE VERB, no-sv 1 Pattern fails at this startpoint if no-backtracking through this
e2e6a0f1 180MARKPOINT VERB, no-sv 1 Push the current location for rollback by cut.
5d458dd8 181SKIP VERB, no-sv 1 On failure skip forward (to the mark) before retrying
e2e6a0f1 182COMMIT VERB, no-sv 1 Pattern fails outright if backtracking through this
5d458dd8 183CUTGROUP VERB, no-sv 1 On failure go to the next alternation in the group
e2e6a0f1 184
ee9b8eae
YO
185#*Control what to keep in $&.
186KEEPS KEEPS, no $& begins here.
187
1de06328
YO
188# NEW STUFF ABOVE THIS LINE -- Please update counts below.
189
03363afd
YO
190################################################################################
191
7f69552c 192#*SPECIAL REGOPS
1de06328
YO
193
194# This is not really a node, but an optimized away piece of a "long" node.
195# To simplify debugging output, we mark it as if it were a node
196OPTIMIZED NOTHING,off Placeholder for dump.
197
3dab1dad
YO
198# Special opcode with the property that no opcode in a compiled program
199# will ever be of this type. Thus it can be used as a flag value that
200# no other opcode has been seen. END is used similarly, in that an END
201# node cant be optimized. So END implies "unoptimizable" and PSEUDO mean
202# "not seen anything to optimize yet".
203PSEUDO PSEUDO,off Pseudo opcode for internal use.
1de06328 204
03363afd
YO
205-------------------------------------------------------------------------------
206# Format for second section:
207# REGOP \t typelist [ \t typelist] [# Comment]
208# typelist= namelist
209# = namelist:FAIL
210# = name:count
211
212# Anything below is a state
213#
214#
215TRIE next:FAIL
216EVAL AB:FAIL
c476f425
DM
217CURLYX end:FAIL
218WHILEM A_pre,A_min,A_max,B_min,B_max:FAIL
03363afd
YO
219BRANCH next:FAIL
220CURLYM A,B:FAIL
221IFMATCH A:FAIL
222CURLY B_min_known,B_min,B_max:FAIL
24b23f37 223COMMIT next:FAIL
e2e6a0f1 224MARKPOINT next:FAIL
5d458dd8
YO
225SKIP next:FAIL
226CUTGROUP next:FAIL
ee9b8eae 227KEEPS next:FAIL