This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
skip t/op/incfilter.t for "make clean;make miniperl;make minitest"
[perl5.git] / regcomp.sym
CommitLineData
d09b2d29
IZ
1# Format:
2# NAME \t TYPE, arg-description [num-args] [longjump-len] \t DESCRIPTION
3
4# Empty rows and #-comment rows are ignored.
5
6# Exit points
7END END, no End of program.
8SUCCEED END, no Return from a subroutine, basically.
9
10# Anchors:
11BOL BOL, no Match "" at beginning of line.
12MBOL BOL, no Same, assuming multiline.
13SBOL BOL, no Same, assuming singleline.
b85d18e9 14EOS EOL, no Match "" at end of string.
d09b2d29
IZ
15EOL EOL, no Match "" at end of line.
16MEOL EOL, no Same, assuming multiline.
17SEOL EOL, no Same, assuming singleline.
18BOUND BOUND, no Match "" at any word boundary
19BOUNDL BOUND, no Match "" at any word boundary
20NBOUND NBOUND, no Match "" at any word non-boundary
21NBOUNDL NBOUND, no Match "" at any word non-boundary
22GPOS GPOS, no Matches where last m//g left off.
23
24# [Special] alternatives
22c35a8c 25REG_ANY REG_ANY, no Match any one character (except newline).
22c35a8c 26SANY REG_ANY, no Match any one character.
f33976b4 27CANY REG_ANY, no Match any one byte.
d09b2d29
IZ
28ANYOF ANYOF, sv Match character in (or not in) this class.
29ALNUM ALNUM, no Match any alphanumeric character
30ALNUML ALNUM, no Match any alphanumeric char in locale
31NALNUM NALNUM, no Match any non-alphanumeric character
32NALNUML NALNUM, no Match any non-alphanumeric char in locale
33SPACE SPACE, no Match any whitespace character
34SPACEL SPACE, no Match any whitespace char in locale
35NSPACE NSPACE, no Match any non-whitespace character
36NSPACEL NSPACE, no Match any non-whitespace char in locale
37DIGIT DIGIT, no Match any numeric character
b8c5462f 38DIGITL DIGIT, no Match any numeric character in locale
d09b2d29 39NDIGIT NDIGIT, no Match any non-numeric character
b8c5462f 40NDIGITL NDIGIT, no Match any non-numeric character in locale
a0ed51b3 41CLUMP CLUMP, no Match any combining character sequence
d09b2d29
IZ
42
43# BRANCH The set of branches constituting a single choice are hooked
44# together with their "next" pointers, since precedence prevents
45# anything being concatenated to any individual branch. The
46# "next" pointer of the last BRANCH in a choice points to the
47# thing following the whole choice. This is also where the
48# final "next" pointer of each individual branch points; each
49# branch starts with the operand node of a BRANCH node.
50#
51BRANCH BRANCH, node Match this alternative, or the next...
52
53# BACK Normal "next" pointers all implicitly point forward; BACK
54# exists to make loop structures possible.
55# not used
56BACK BACK, no Match "", "next" ptr points backward.
57
58# Literals
59EXACT EXACT, sv Match this string (preceded by length).
60EXACTF EXACT, sv Match this string, folded (prec. by length).
61EXACTFL EXACT, sv Match this string, folded in locale (w/len).
62
63# Do nothing
64NOTHING NOTHING,no Match empty string.
65# A variant of above which delimits a group, thus stops optimizations
66TAIL NOTHING,no Match empty string. Can jump here from outside.
67
68# STAR,PLUS '?', and complex '*' and '+', are implemented as circular
69# BRANCH structures using BACK. Simple cases (one character
70# per match) are implemented with STAR and PLUS for speed
71# and to minimize recursive plunges.
72#
73STAR STAR, node Match this (simple) thing 0 or more times.
74PLUS PLUS, node Match this (simple) thing 1 or more times.
75
76CURLY CURLY, sv 2 Match this simple thing {n,m} times.
77CURLYN CURLY, no 2 Match next-after-this simple thing
78# {n,m} times, set parenths.
79CURLYM CURLY, no 2 Match this medium-complex thing {n,m} times.
80CURLYX CURLY, sv 2 Match this complex thing {n,m} times.
81
82# This terminator creates a loop structure for CURLYX
83WHILEM WHILEM, no Do curly processing and see if rest matches.
84
85# OPEN,CLOSE,GROUPP ...are numbered at compile time.
86OPEN OPEN, num 1 Mark this point in input as start of #n.
87CLOSE CLOSE, num 1 Analogous to OPEN.
88
89REF REF, num 1 Match some already matched string
90REFF REF, num 1 Match already matched string, folded
91REFFL REF, num 1 Match already matched string, folded in loc.
92
93# grouping assertions
94IFMATCH BRANCHJ,off 1 2 Succeeds if the following matches.
95UNLESSM BRANCHJ,off 1 2 Fails if the following matches.
96SUSPEND BRANCHJ,off 1 1 "Independent" sub-RE.
97IFTHEN BRANCHJ,off 1 1 Switch, should be preceeded by switcher .
98GROUPP GROUPP, num 1 Whether the group matched.
99
100# Support for long RE
101LONGJMP LONGJMP,off 1 1 Jump far away.
102BRANCHJ BRANCHJ,off 1 1 BRANCH with long offset.
103
104# The heavy worker
105EVAL EVAL, evl 1 Execute some Perl code.
106
107# Modifiers
108MINMOD MINMOD, no Next operator is not greedy.
109LOGICAL LOGICAL,no Next opcode should set the flag only.
110
111# This is not used yet
112RENUM BRANCHJ,off 1 1 Group with independently numbered parens.
113
114# This is not really a node, but an optimized away piece of a "long" node.
115# To simplify debugging output, we mark it as if it were a node
116OPTIMIZED NOTHING,off Placeholder for dump.
ce5e9471
YO
117
118# Trie Related (behave the same as A|LIST|OF|WORDS would)
119TRIE TRIE, trie 1 Match one or more of many EXACT strings
120TRIEF TRIE, trie 1 Match one or more of many EXACTF strings
121TRIEFL TRIE, trie 1 Match one or more of many EXACTFL strings
122