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