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