POSIX math: Match FE_ and FLT_ROUNDS with the GNU defaults.
[perl.git] / regcomp.sym
1 # regcomp.sym
2 #
3 # File has two sections, divided by a line of dashes '-'. 
4 #
5 # Lines beginning with # are ignored, except for those that start with #*
6 # which are included in pod/perldebguts.pod.  # within a line may be part
7 # of a description.
8 #
9 # First section is for regops, second section is for regmatch-states
10 #
11 # Note that the order in this file is important.
12 #
13 # Format for first section: 
14 # NAME \s+ TYPE, arg-description [num-args] [flags] [longjump-len] ; DESCRIPTION
15 #   flag <S> means is REGNODE_SIMPLE; flag <V> means is REGNODE_VARIES
16 #
17 #
18 # run perl regen.pl after editing this file
19
20
21
22 #* Exit points
23
24 END         END,        no        ; End of program.
25 SUCCEED     END,        no        ; Return from a subroutine, basically.
26
27 #* Line Start Anchors:
28 #Note flags field for SBOL indicates if it is a /^/ or a /\A/
29 SBOL        BOL,        no        ; Match "" at beginning of line: /^/, /\A/
30 MBOL        BOL,        no        ; Same, assuming multiline: /^/m
31
32 #* Line End Anchors:
33 SEOL        EOL,        no        ; Match "" at end of line: /$/
34 MEOL        EOL,        no        ; Same, assuming multiline: /$/m
35 EOS         EOL,        no        ; Match "" at end of string: /\z/
36
37 #* Match Start Anchors:
38 GPOS        GPOS,       no        ; Matches where last m//g left off.
39
40 #* Word Boundary Opcodes:
41 # The regops that have varieties that vary depending on the character set regex
42 # modifiers have to ordered thusly: /d, /l, /u, /a, /aa.  This is because code
43 # in regcomp.c uses the enum value of the modifier as an offset from the /d
44 # version.  The complements must come after the non-complements.
45 # BOUND, POSIX and their complements are affected, as well as EXACTF.
46 BOUND       BOUND,      no        ; Match "" at any word boundary using native charset rules for non-utf8
47 BOUNDL      BOUND,      no        ; Match "" at any locale word boundary
48 BOUNDU      BOUND,      no        ; Match "" at any word boundary using Unicode rules
49 BOUNDA      BOUND,      no         ; Match "" at any word boundary using ASCII rules
50 # All NBOUND nodes are required by code in regexec.c to be greater than all BOUND ones
51 NBOUND      NBOUND,     no        ; Match "" at any word non-boundary using native charset rules for non-utf8
52 NBOUNDL     NBOUND,     no        ; Match "" at any locale word non-boundary
53 NBOUNDU     NBOUND,     no        ; Match "" at any word non-boundary using Unicode rules
54 NBOUNDA     NBOUND,     no        ; Match "" at any word non-boundary using ASCII rules
55
56 #* [Special] alternatives:
57 REG_ANY     REG_ANY,    no 0 S    ; Match any one character (except newline).
58 SANY        REG_ANY,    no 0 S    ; Match any one character.
59 CANY        REG_ANY,    no 0 S    ; Match any one byte.
60 ANYOF       ANYOF,      sv 0 S    ; Match character in (or not in) this class, single char match only
61
62 #* POSIX Character Classes:
63 # Order of the below is important.  See ordering comment above.
64 POSIXD      POSIXD,     none 0 S   ; Some [[:class:]] under /d; the FLAGS field gives which one
65 POSIXL      POSIXD,     none 0 S   ; Some [[:class:]] under /l; the FLAGS field gives which one
66 POSIXU      POSIXD,     none 0 S   ; Some [[:class:]] under /u; the FLAGS field gives which one
67 POSIXA      POSIXD,     none 0 S   ; Some [[:class:]] under /a; the FLAGS field gives which one
68 NPOSIXD     NPOSIXD,    none 0 S   ; complement of POSIXD, [[:^class:]]
69 NPOSIXL     NPOSIXD,    none 0 S   ; complement of POSIXL, [[:^class:]]
70 NPOSIXU     NPOSIXD,    none 0 S   ; complement of POSIXU, [[:^class:]]
71 NPOSIXA     NPOSIXD,    none 0 S   ; complement of POSIXA, [[:^class:]]
72 # End of order is important
73
74 CLUMP       CLUMP,      no 0 V    ; Match any extended grapheme cluster sequence
75
76 #* Alternation
77
78 #* BRANCH        The set of branches constituting a single choice are
79 #*               hooked together with their "next" pointers, since
80 #*               precedence prevents anything being concatenated to
81 #*               any individual branch.  The "next" pointer of the last
82 #*               BRANCH in a choice points to the thing following the
83 #*               whole choice.  This is also where the final "next"
84 #*               pointer of each individual branch points; each branch
85 #*               starts with the operand node of a BRANCH node.
86 #*
87 BRANCH      BRANCH,     node 0 V  ; Match this alternative, or the next...
88
89 #*Back pointer
90
91 #* BACK          Normal "next" pointers all implicitly point forward;
92 #*               BACK exists to make loop structures possible.
93 #* not used
94 BACK        BACK,       no 0 V    ; Match "", "next" ptr points backward.
95
96 #*Literals
97 # NOTE: the relative ordering of these types is important do not change it
98
99 EXACT       EXACT,      str       ; Match this string (preceded by length).
100 EXACTF      EXACT,      str       ; Match this non-UTF-8 string (not guaranteed to be folded) using /id rules (w/len).
101 EXACTFL     EXACT,      str       ; Match this string (not guaranteed to be folded) using /il rules (w/len).
102 EXACTFU     EXACT,      str       ; Match this string (folded iff in UTF-8, length in folding doesn't change if not in UTF-8) using /iu rules (w/len).
103 EXACTFA     EXACT,      str       ; Match this string (not guaranteed to be folded) using /iaa rules (w/len).
104 EXACTFU_SS  EXACT,      str       ; Match this string (folded iff in UTF-8, length in folding may change even if not in UTF-8) using /iu rules (w/len).
105 EXACTFA_NO_TRIE  EXACT, str       ; Match this string (which is not trie-able; not guaranteed to be folded) using /iaa rules (w/len).
106
107 #*Do nothing types
108
109 NOTHING     NOTHING,    no        ; Match empty string.
110 #*A variant of above which delimits a group, thus stops optimizations
111 TAIL        NOTHING,    no        ; Match empty string. Can jump here from outside.
112
113 #*Loops
114
115 #* STAR,PLUS    '?', and complex '*' and '+', are implemented as
116 #*               circular BRANCH structures using BACK.  Simple cases
117 #*               (one character per match) are implemented with STAR
118 #*               and PLUS for speed and to minimize recursive plunges.
119 #*
120 STAR        STAR,       node 0 V  ; Match this (simple) thing 0 or more times.
121 PLUS        PLUS,       node 0 V  ; Match this (simple) thing 1 or more times.
122
123 CURLY       CURLY,      sv 2 V    ; Match this simple thing {n,m} times.
124 CURLYN      CURLY,      no 2 V    ; Capture next-after-this simple thing 
125 CURLYM      CURLY,      no 2 V    ; Capture this medium-complex thing {n,m} times. 
126 CURLYX      CURLY,      sv 2 V    ; Match this complex thing {n,m} times.
127
128 #*This terminator creates a loop structure for CURLYX
129 WHILEM      WHILEM,     no 0 V    ; Do curly processing and see if rest matches.
130
131 #*Buffer related
132
133 #*OPEN,CLOSE,GROUPP     ...are numbered at compile time.
134 OPEN        OPEN,       num 1     ; Mark this point in input as start of #n.
135 CLOSE       CLOSE,      num 1     ; Analogous to OPEN.
136
137 REF         REF,        num 1 V   ; Match some already matched string
138 REFF        REF,        num 1 V   ; Match already matched string, folded using native charset rules for non-utf8
139 REFFL       REF,        num 1 V   ; Match already matched string, folded in loc.
140 # N?REFF[AU] could have been implemented using the FLAGS field of the
141 # regnode, but by having a separate node type, we can use the existing switch
142 # statement to avoid some tests
143 REFFU       REF,        num 1 V   ; Match already matched string, folded using unicode rules for non-utf8
144 REFFA       REF,        num 1 V   ; Match already matched string, folded using unicode rules for non-utf8, no mixing ASCII, non-ASCII
145
146 #*Named references.  Code in regcomp.c assumes that these all are after
147 #*the numbered references
148 NREF        REF,        no-sv 1 V ; Match some already matched string
149 NREFF       REF,        no-sv 1 V ; Match already matched string, folded using native charset rules for non-utf8
150 NREFFL      REF,        no-sv 1 V ; Match already matched string, folded in loc.
151 NREFFU      REF,        num   1 V ; Match already matched string, folded using unicode rules for non-utf8
152 NREFFA      REF,        num   1 V ; Match already matched string, folded using unicode rules for non-utf8, no mixing ASCII, non-ASCII
153
154 #*Support for long RE
155 LONGJMP     LONGJMP,    off 1 . 1 ; Jump far away.
156 BRANCHJ     BRANCHJ,    off 1 V 1 ; BRANCH with long offset.
157
158 #*Special Case Regops
159 IFMATCH     BRANCHJ,    off 1 . 2 ; Succeeds if the following matches.
160 UNLESSM     BRANCHJ,    off 1 . 2 ; Fails if the following matches.
161 SUSPEND     BRANCHJ,    off 1 V 1 ; "Independent" sub-RE.
162 IFTHEN      BRANCHJ,    off 1 V 1 ; Switch, should be preceded by switcher.
163 GROUPP      GROUPP,     num 1     ; Whether the group matched.
164
165
166 #*The heavy worker
167
168 EVAL        EVAL,       evl 1     ; Execute some Perl code.
169
170 #*Modifiers
171
172 MINMOD      MINMOD,     no        ; Next operator is not greedy.
173 LOGICAL     LOGICAL,    no        ; Next opcode should set the flag only.
174
175 #*This is not used yet
176 RENUM       BRANCHJ,    off 1 . 1 ; Group with independently numbered parens.
177
178 #*Trie Related
179
180 #* Behave the same as A|LIST|OF|WORDS would. The '..C' variants
181 #* have inline charclass data (ascii only), the 'C' store it in the
182 #* structure.
183 # NOTE: the relative order of the TRIE-like regops  is significant
184
185 TRIE        TRIE,       trie 1    ; Match many EXACT(F[ALU]?)? at once. flags==type
186 TRIEC       TRIE,trie charclass   ; Same as TRIE, but with embedded charclass data
187
188 # For start classes, contains an added fail table.
189 AHOCORASICK     TRIE,   trie 1    ; Aho Corasick stclass. flags==type
190 AHOCORASICKC    TRIE,trie charclass   ; Same as AHOCORASICK, but with embedded charclass data
191
192 #*Regex Subroutines
193 GOSUB       GOSUB,      num/ofs 2L    ; recurse to paren arg1 at (signed) ofs arg2
194 GOSTART     GOSTART,    no        ; recurse to start of pattern
195
196 #*Special conditionals
197 NGROUPP     NGROUPP,    no-sv 1   ; Whether the group matched.            
198 INSUBP      INSUBP,     num 1     ; Whether we are in a specific recurse.  
199 DEFINEP     DEFINEP,    none 1    ; Never execute directly.               
200
201 #*Backtracking Verbs
202 ENDLIKE     ENDLIKE,    none      ; Used only for the type field of verbs
203 OPFAIL      ENDLIKE,    none      ; Same as (?!)
204 ACCEPT      ENDLIKE,    parno 1   ; Accepts the current matched string.
205
206
207 #*Verbs With Arguments
208 VERB        VERB,       no-sv 1   ; Used only for the type field of verbs
209 PRUNE       VERB,       no-sv 1   ; Pattern fails at this startpoint if no-backtracking through this 
210 MARKPOINT   VERB,       no-sv 1   ; Push the current location for rollback by cut.
211 SKIP        VERB,       no-sv 1   ; On failure skip forward (to the mark) before retrying
212 COMMIT      VERB,       no-sv 1   ; Pattern fails outright if backtracking through this
213 CUTGROUP    VERB,       no-sv 1   ; On failure go to the next alternation in the group
214
215 #*Control what to keep in $&.
216 KEEPS       KEEPS,      no        ; $& begins here.
217
218 #*New charclass like patterns
219 LNBREAK     LNBREAK,    none      ; generic newline pattern
220
221 # NEW STUFF SOMEWHERE ABOVE THIS LINE
222
223 ################################################################################
224
225 #*SPECIAL  REGOPS
226
227 #* This is not really a node, but an optimized away piece of a "long"
228 #* node.  To simplify debugging output, we mark it as if it were a node
229 OPTIMIZED   NOTHING,    off       ; Placeholder for dump.
230
231 #* Special opcode with the property that no opcode in a compiled program
232 #* will ever be of this type. Thus it can be used as a flag value that
233 #* no other opcode has been seen. END is used similarly, in that an END
234 #* node cant be optimized. So END implies "unoptimizable" and PSEUDO
235 #* mean "not seen anything to optimize yet".
236 PSEUDO      PSEUDO,     off       ; Pseudo opcode for internal use.
237
238 -------------------------------------------------------------------------------
239 # Format for second section:
240 # REGOP \t typelist [ \t typelist]
241 # typelist= namelist
242 #         = namelist:FAIL
243 #         = name:count
244
245 # Anything below is a state
246 #
247 #
248 TRIE            next:FAIL
249 EVAL            AB:FAIL
250 CURLYX          end:FAIL
251 WHILEM          A_pre,A_min,A_max,B_min,B_max:FAIL
252 BRANCH          next:FAIL
253 CURLYM          A,B:FAIL
254 IFMATCH         A:FAIL
255 CURLY           B_min_known,B_min,B_max:FAIL
256 COMMIT          next:FAIL
257 MARKPOINT       next:FAIL
258 SKIP            next:FAIL
259 CUTGROUP        next:FAIL
260 KEEPS           next:FAIL