Move Compress::Raw::Zlib from ext/ to cpan/
[perl.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 # run perl regen.pl after editing this file
16
17
18
19 #* Exit points (0,1)
20
21 END             END,    no      End of program.
22 SUCCEED         END,    no      Return from a subroutine, basically.
23
24 #* Anchors: (2..13)
25
26 BOL             BOL,    no      Match "" at beginning of line.
27 MBOL            BOL,    no      Same, assuming multiline.
28 SBOL            BOL,    no      Same, assuming singleline.
29 EOS             EOL,    no      Match "" at end of string.
30 EOL             EOL,    no      Match "" at end of line.
31 MEOL            EOL,    no      Same, assuming multiline.
32 SEOL            EOL,    no      Same, assuming singleline.
33 BOUND           BOUND,  no      Match "" at any word boundary
34 BOUNDL          BOUND,  no      Match "" at any word boundary
35 NBOUND          NBOUND, no      Match "" at any word non-boundary
36 NBOUNDL         NBOUND, no      Match "" at any word non-boundary
37 GPOS            GPOS,   no      Matches where last m//g left off.
38
39 #* [Special] alternatives: (14..30)
40
41 REG_ANY         REG_ANY,    no  Match any one character (except newline).
42 SANY            REG_ANY,    no  Match any one character.
43 CANY            REG_ANY,    no  Match any one byte.
44 ANYOF           ANYOF,  sv      Match character in (or not in) this class.
45 ALNUM           ALNUM,  no      Match any alphanumeric character
46 ALNUML          ALNUM,  no      Match any alphanumeric char in locale
47 NALNUM          NALNUM, no      Match any non-alphanumeric character
48 NALNUML         NALNUM, no      Match any non-alphanumeric char in locale
49 SPACE           SPACE,  no      Match any whitespace character
50 SPACEL          SPACE,  no      Match any whitespace char in locale
51 NSPACE          NSPACE, no      Match any non-whitespace character
52 NSPACEL         NSPACE, no      Match any non-whitespace char in locale
53 DIGIT           DIGIT,  no      Match any numeric character
54 DIGITL          DIGIT,  no      Match any numeric character in locale
55 NDIGIT          NDIGIT, no      Match any non-numeric character
56 NDIGITL         NDIGIT, no      Match any non-numeric character in locale
57 CLUMP           CLUMP,  no      Match any combining character sequence
58
59 #* Alternation (31)
60
61 # BRANCH        The set of branches constituting a single choice are hooked
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 #
69 BRANCH          BRANCH, node    Match this alternative, or the next...
70
71 #*Back pointer (32)
72
73 # BACK          Normal "next" pointers all implicitly point forward; BACK
74 #               exists to make loop structures possible.
75 # not used
76 BACK            BACK,   no      Match "", "next" ptr points backward.
77
78 #*Literals (33..35)
79
80 EXACT           EXACT,  str     Match this string (preceded by length).
81 EXACTF          EXACT,  str     Match this string, folded (prec. by length).
82 EXACTFL         EXACT,  str     Match this string, folded in locale (w/len).
83
84 #*Do nothing types (36..37)
85
86 NOTHING         NOTHING,no      Match empty string.
87 # A variant of above which delimits a group, thus stops optimizations
88 TAIL            NOTHING,no      Match empty string. Can jump here from outside.
89
90 #*Loops (38..44)
91
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 #
97 STAR            STAR,   node    Match this (simple) thing 0 or more times.
98 PLUS            PLUS,   node    Match this (simple) thing 1 or more times.
99
100 CURLY           CURLY,  sv 2    Match this simple thing {n,m} times.
101 CURLYN          CURLY,  no 2    Capture next-after-this simple thing 
102 CURLYM          CURLY,  no 2    Capture 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 #*Regex Subroutines (65..66) 
157 GOSUB           GOSUB,     num/ofs 2L   recurse to paren arg1 at (signed) ofs arg2
158 GOSTART         GOSTART,   no           recurse to start of pattern
159
160 #*Named references (67..69)
161 NREF            REF,       no-sv 1      Match some already matched string
162 NREFF           REF,       no-sv 1      Match already matched string, folded
163 NREFFL          REF,       no-sv 1      Match already matched string, folded in loc.
164
165
166 #*Special conditionals  (70..72)
167 NGROUPP         NGROUPP,   no-sv 1      Whether the group matched.            
168 INSUBP          INSUBP,    num 1        Whether we are in a specific recurse.  
169 DEFINEP         DEFINEP,   none 1       Never execute directly.               
170
171 #*Bactracking Verbs
172 ENDLIKE         ENDLIKE,   none         Used only for the type field of verbs
173 OPFAIL          ENDLIKE,   none         Same as (?!)
174 ACCEPT          ENDLIKE,   parno 1      Accepts the current matched string.
175
176
177 #*Verbs With Arguments
178 VERB            VERB,      no-sv 1      Used only for the type field of verbs
179 PRUNE           VERB,      no-sv 1      Pattern fails at this startpoint if no-backtracking through this 
180 MARKPOINT       VERB,      no-sv 1      Push the current location for rollback by cut.
181 SKIP            VERB,      no-sv 1      On failure skip forward (to the mark) before retrying
182 COMMIT          VERB,      no-sv 1      Pattern fails outright if backtracking through this
183 CUTGROUP        VERB,      no-sv 1      On failure go to the next alternation in the group
184
185 #*Control what to keep in $&.
186 KEEPS           KEEPS,  no      $& begins here.
187
188 #*New charclass like patterns
189 LNBREAK         LNBREAK,   none         generic newline pattern
190 VERTWS          VERTWS,    none         vertical whitespace         (Perl 6)
191 NVERTWS         NVERTWS,   none         not vertical whitespace     (Perl 6)
192 HORIZWS         HORIZWS,   none         horizontal whitespace       (Perl 6)
193 NHORIZWS        NHORIZWS,  none         not horizontal whitespace   (Perl 6)
194
195 FOLDCHAR        FOLDCHAR,  codepoint 1  codepoint with tricky case folding properties.
196
197 # NEW STUFF ABOVE THIS LINE  
198
199 ################################################################################
200
201 #*SPECIAL  REGOPS
202
203 # This is not really a node, but an optimized away piece of a "long" node.
204 # To simplify debugging output, we mark it as if it were a node
205 OPTIMIZED       NOTHING,off     Placeholder for dump.
206
207 # Special opcode with the property that no opcode in a compiled program
208 # will ever be of this type. Thus it can be used as a flag value that
209 # no other opcode has been seen. END is used similarly, in that an END
210 # node cant be optimized. So END implies "unoptimizable" and PSEUDO mean
211 # "not seen anything to optimize yet".
212 PSEUDO          PSEUDO,off      Pseudo opcode for internal use.
213
214 -------------------------------------------------------------------------------
215 # Format for second section:
216 # REGOP \t typelist [ \t typelist] [# Comment]
217 # typelist= namelist
218 #         = namelist:FAIL
219 #         = name:count
220
221 # Anything below is a state
222 #
223 #
224 TRIE            next:FAIL       
225 EVAL            AB:FAIL 
226 CURLYX          end:FAIL        
227 WHILEM          A_pre,A_min,A_max,B_min,B_max:FAIL
228 BRANCH          next:FAIL       
229 CURLYM          A,B:FAIL        
230 IFMATCH         A:FAIL  
231 CURLY           B_min_known,B_min,B_max:FAIL    
232 COMMIT          next:FAIL
233 MARKPOINT       next:FAIL
234 SKIP            next:FAIL
235 CUTGROUP        next:FAIL
236 KEEPS           next:FAIL