Upgrade to Time-HiRes-1.91
[p5sagit/p5-mst-13.2.git] / regcomp.sym
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 #
9 # Note that the order in this file is important.
10 #
11 # Format for first section: 
12 # NAME \t TYPE, arg-description [num-args] [longjump-len] \t DESCRIPTION
13 #
14 #
15
16
17
18 #* Exit points (0,1)
19
20 END             END,    no      End of program.
21 SUCCEED         END,    no      Return from a subroutine, basically.
22
23 #* Anchors: (2..13)
24
25 BOL             BOL,    no      Match "" at beginning of line.
26 MBOL            BOL,    no      Same, assuming multiline.
27 SBOL            BOL,    no      Same, assuming singleline.
28 EOS             EOL,    no      Match "" at end of string.
29 EOL             EOL,    no      Match "" at end of line.
30 MEOL            EOL,    no      Same, assuming multiline.
31 SEOL            EOL,    no      Same, assuming singleline.
32 BOUND           BOUND,  no      Match "" at any word boundary
33 BOUNDL          BOUND,  no      Match "" at any word boundary
34 NBOUND          NBOUND, no      Match "" at any word non-boundary
35 NBOUNDL         NBOUND, no      Match "" at any word non-boundary
36 GPOS            GPOS,   no      Matches where last m//g left off.
37
38 #* [Special] alternatives: (14..30)
39
40 REG_ANY         REG_ANY,    no  Match any one character (except newline).
41 SANY            REG_ANY,    no  Match any one character.
42 CANY            REG_ANY,    no  Match any one byte.
43 ANYOF           ANYOF,  sv      Match character in (or not in) this class.
44 ALNUM           ALNUM,  no      Match any alphanumeric character
45 ALNUML          ALNUM,  no      Match any alphanumeric char in locale
46 NALNUM          NALNUM, no      Match any non-alphanumeric character
47 NALNUML         NALNUM, no      Match any non-alphanumeric char in locale
48 SPACE           SPACE,  no      Match any whitespace character
49 SPACEL          SPACE,  no      Match any whitespace char in locale
50 NSPACE          NSPACE, no      Match any non-whitespace character
51 NSPACEL         NSPACE, no      Match any non-whitespace char in locale
52 DIGIT           DIGIT,  no      Match any numeric character
53 DIGITL          DIGIT,  no      Match any numeric character in locale
54 NDIGIT          NDIGIT, no      Match any non-numeric character
55 NDIGITL         NDIGIT, no      Match any non-numeric character in locale
56 CLUMP           CLUMP,  no      Match any combining character sequence
57
58 #* Alternation (31)
59
60 # BRANCH        The set of branches constituting a single choice are hooked
61 #               together with their "next" pointers, since precedence prevents
62 #               anything being concatenated to any individual branch.  The
63 #               "next" pointer of the last BRANCH in a choice points to the
64 #               thing following the whole choice.  This is also where the
65 #               final "next" pointer of each individual branch points; each
66 #               branch starts with the operand node of a BRANCH node.
67 #
68 BRANCH          BRANCH, node    Match this alternative, or the next...
69
70 #*Back pointer (32)
71
72 # BACK          Normal "next" pointers all implicitly point forward; BACK
73 #               exists to make loop structures possible.
74 # not used
75 BACK            BACK,   no      Match "", "next" ptr points backward.
76
77 #*Literals (33..35)
78
79 EXACT           EXACT,  sv      Match this string (preceded by length).
80 EXACTF          EXACT,  sv      Match this string, folded (prec. by length).
81 EXACTFL         EXACT,  sv      Match this string, folded in locale (w/len).
82
83 #*Do nothing types (36..37)
84
85 NOTHING         NOTHING,no      Match empty string.
86 # A variant of above which delimits a group, thus stops optimizations
87 TAIL            NOTHING,no      Match empty string. Can jump here from outside.
88
89 #*Loops (38..44)
90
91 # STAR,PLUS     '?', and complex '*' and '+', are implemented as circular
92 #               BRANCH structures using BACK.  Simple cases (one character
93 #               per match) are implemented with STAR and PLUS for speed
94 #               and to minimize recursive plunges.
95 #
96 STAR            STAR,   node    Match this (simple) thing 0 or more times.
97 PLUS            PLUS,   node    Match this (simple) thing 1 or more times.
98
99 CURLY           CURLY,  sv 2    Match this simple thing {n,m} times.
100 CURLYN          CURLY,  no 2    Match next-after-this simple thing 
101 #                               {n,m} times, set parenths.
102 CURLYM          CURLY,  no 2    Match this medium-complex thing {n,m} times.
103 CURLYX          CURLY,  sv 2    Match this complex thing {n,m} times.
104
105 # This terminator creates a loop structure for CURLYX
106 WHILEM          WHILEM, no      Do curly processing and see if rest matches.
107
108 #*Buffer related (45..49)
109
110 # OPEN,CLOSE,GROUPP     ...are numbered at compile time.
111 OPEN            OPEN,   num 1   Mark this point in input as start of #n.
112 CLOSE           CLOSE,  num 1   Analogous to OPEN.
113
114 REF             REF,    num 1   Match some already matched string
115 REFF            REF,    num 1   Match already matched string, folded
116 REFFL           REF,    num 1   Match already matched string, folded in loc.
117
118 #*Grouping assertions (50..54)
119
120 IFMATCH         BRANCHJ,off 1 2 Succeeds if the following matches.
121 UNLESSM         BRANCHJ,off 1 2 Fails if the following matches.
122 SUSPEND         BRANCHJ,off 1 1 "Independent" sub-RE.
123 IFTHEN          BRANCHJ,off 1 1 Switch, should be preceeded by switcher .
124 GROUPP          GROUPP, num 1   Whether the group matched.
125
126 #*Support for long RE (55..56)
127
128 LONGJMP         LONGJMP,off 1 1 Jump far away.
129 BRANCHJ         BRANCHJ,off 1 1 BRANCH with long offset.
130
131 #*The heavy worker (57..58)
132
133 EVAL            EVAL,   evl 1   Execute some Perl code.
134
135 #*Modifiers (59..60)
136
137 MINMOD          MINMOD, no      Next operator is not greedy.
138 LOGICAL         LOGICAL,no      Next opcode should set the flag only.
139
140 # This is not used yet (61)
141 RENUM           BRANCHJ,off 1 1 Group with independently numbered parens.
142
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
148
149 TRIE            TRIE,   trie 1  Match many EXACT(FL?)? at once. flags==type
150 TRIEC           TRIE,   trie charclass  Same as TRIE, but with embedded charclass data
151
152 # For start classes, contains an added fail table.
153 AHOCORASICK     TRIE,   trie 1  Aho Corasick stclass. flags==type
154 AHOCORASICKC    TRIE,   trie charclass  Same as AHOCORASICK, but with embedded charclass data
155
156
157
158 # NEW STUFF ABOVE THIS LINE -- Please update counts below. 
159
160 ################################################################################
161
162 #*SPECIAL  REGOPS (65, 66)
163
164 # This is not really a node, but an optimized away piece of a "long" node.
165 # To simplify debugging output, we mark it as if it were a node
166 OPTIMIZED       NOTHING,off     Placeholder for dump.
167
168 # Special opcode with the property that no opcode in a compiled program
169 # will ever be of this type. Thus it can be used as a flag value that
170 # no other opcode has been seen. END is used similarly, in that an END
171 # node cant be optimized. So END implies "unoptimizable" and PSEUDO mean
172 # "not seen anything to optimize yet".
173 PSEUDO          PSEUDO,off      Pseudo opcode for internal use.
174
175 -------------------------------------------------------------------------------
176 # Format for second section:
177 # REGOP \t typelist [ \t typelist] [# Comment]
178 # typelist= namelist
179 #         = namelist:FAIL
180 #         = name:count
181
182 # Anything below is a state
183 #
184 #
185 TRIE            next:FAIL       
186 EVAL            AB:FAIL 
187 CURLYX          resume  
188 WHILEM          resume:6        
189 BRANCH          next:FAIL       
190 CURLYM          A,B:FAIL        
191 IFMATCH         A:FAIL  
192 CURLY           B_min_known,B_min,B_max:FAIL    
193