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 [struct regnode suffix] [flags] [longjump] ; DESCRIPTION
  15 #   arg-description is currently unused
  16 #   suffix is appended to 'struct_regnode_' giving which one to use.  If empty,
  17 #       it means plain 'struct regnode'.  If the regnode is a string one, this
  18 #       should instead refer to the base regnode, without the char[1] element
  19 #       of the structure
  20 #   flag <S> means is REGNODE_SIMPLE; flag <V> means is REGNODE_VARIES; <.> is
  21 #       a placeholder
  22 #   longjump is 1 if the (first) argument holds the next offset (instead of the
  23 #       usual 'next_offset' field
  24 #
  25 # run perl regen.pl after editing this file
  26
  27 #                             +- suffix of which struct regnode to use e.g.,
  28 #                             | +- flags  (S or V)               struct regnode_1
  29 #                         un- | | +- longjmp (0, blank, or 1)  blank means 0
  30 # Name        Type       used | | | ; comment
  31 # --------------------------------------------------------------------------
  32 # IFMATCH     BRANCHJ,    off 1 . 1 ; Succeeds if the following matches.
  33 # UNLESSM     BRANCHJ,    off 1 . 1 ; Fails if the following matches.
  34 # SUSPEND     BRANCHJ,    off 1 V 1 ; "Independent" sub-RE.
  35 # IFTHEN      BRANCHJ,    off 1 V 1 ; Switch, should be preceded by switcher.
  36 # GROUPP      GROUPP,     num 1     ; Whether the group matched.
  37 #
  38 # If we were to start running out of regnodes, many of the ones that are
  39 # complements could be combined with their non-complement mates.  For example,
  40 # POSIXU could have the flags field have the bottom bit mean do we complement
  41 # or not, and the type be shifted left 1 bit.  Then all that would be needed to
  42 # extract which to do is a mask for the complement bit, and a right shift for
  43 # the other, an inconsequential increase in instructions.  It might actually be
  44 # clearer and slightly faster given the case statement and assignment are
  45 # removed.  Note that not everything could be collapsed: NPOSIXA, for example,
  46 # would require special handling for performance.
  47
  48
  49 #* Exit points
  50
  51 END         END,        no        ; End of program.
  52 SUCCEED     END,        no        ; Return from a subroutine, basically.
  53
  54 #* Line Start Anchors:
  55 #Note flags field for SBOL indicates if it is a /^/ or a /\A/
  56 SBOL        BOL,        no        ; Match "" at beginning of line: /^/, /\A/
  57 MBOL        BOL,        no        ; Same, assuming multiline: /^/m
  58
  59 #* Line End Anchors:
  60 SEOL        EOL,        no        ; Match "" at end of line: /$/
  61 MEOL        EOL,        no        ; Same, assuming multiline: /$/m
  62 EOS         EOL,        no        ; Match "" at end of string: /\z/
  63
  64 #* Match Start Anchors:
  65 GPOS        GPOS,       no        ; Matches where last m//g left off.
  66
  67 #* Word Boundary Opcodes:
  68 # The regops that have varieties that vary depending on the character set regex
  69 # modifiers have to ordered thusly: /d, /l, /u, /a, /aa.  This is because code
  70 # in regcomp.c uses the enum value of the modifier as an offset from the /d
  71 # version.  The complements must come after the non-complements.
  72 # BOUND, POSIX and their complements are affected, as well as EXACTF.
  73 BOUND       BOUND,      no        ; Like BOUNDA for non-utf8, otherwise like BOUNDU
  74 BOUNDL      BOUND,      no        ; Like BOUND/BOUNDU, but \w and \W are defined by current locale
  75 BOUNDU      BOUND,      no        ; Match "" at any boundary of a given type using /u rules.
  76 BOUNDA      BOUND,      no        ; Match "" at any boundary between \w\W or \W\w, where \w is [_a-zA-Z0-9]
  77 # All NBOUND nodes are required by code in regexec.c to be greater than all BOUND ones
  78 NBOUND      NBOUND,     no        ; Like NBOUNDA for non-utf8, otherwise like BOUNDU
  79 NBOUNDL     NBOUND,     no        ; Like NBOUND/NBOUNDU, but \w and \W are defined by current locale
  80 NBOUNDU     NBOUND,     no        ; Match "" at any non-boundary of a given type using using /u rules.
  81 NBOUNDA     NBOUND,     no        ; Match "" betweeen any \w\w or \W\W, where \w is [_a-zA-Z0-9]
  82
  83 #* [Special] alternatives:
  84 REG_ANY     REG_ANY,    no 0 S    ; Match any one character (except newline).
  85 SANY        REG_ANY,    no 0 S    ; Match any one character.
  86 ANYOF       ANYOF,      sv charclass S    ; Match character in (or not in) this class, single char match only
  87 ANYOFD      ANYOF,      sv charclass S    ; Like ANYOF, but /d is in effect
  88 ANYOFL      ANYOF,      sv charclass S    ; Like ANYOF, but /l is in effect
  89 ANYOFPOSIXL ANYOF,      sv charclass_posixl S    ; Like ANYOFL, but matches [[:posix:]] classes
  90
  91 # Must be sequential
  92 ANYOFH      ANYOF,      sv 1 S    ; Like ANYOF, but only has "High" matches, none in the bitmap; the flags field contains the lowest matchable UTF-8 start byte
  93 ANYOFHb     ANYOF,      sv 1 S    ; Like ANYOFH, but all matches share the same UTF-8 start byte, given in the flags field
  94 ANYOFHr     ANYOF,      sv 1 S    ; Like ANYOFH, but the flags field contains packed bounds for all matchable UTF-8 start bytes.
  95 ANYOFHs     ANYOF,      sv 1 S    ; Like ANYOFHb, but has a string field that gives the leading matchable UTF-8 bytes; flags field is len
  96 ANYOFR      ANYOFR,     packed 1  S  ; Matches any character in the range given by its packed args: upper 12 bits is the max delta from the base lower 20; the flags field contains the lowest matchable UTF-8 start byte
  97 ANYOFRb     ANYOFR,     packed 1  S ; Like ANYOFR, but all matches share the same UTF-8 start byte, given in the flags field
  98 # There is no ANYOFRr because khw doesn't think there are likely to be real-world cases where such a large range is used.
  99
 100 ANYOFM      ANYOFM,     byte 1 S  ; Like ANYOF, but matches an invariant byte as determined by the mask and arg
 101 NANYOFM     ANYOFM,     byte 1 S  ; complement of ANYOFM
 102
 103 #* POSIX Character Classes:
 104 # Order of the below is important.  See ordering comment above.
 105 POSIXD      POSIXD,     none 0 S   ; Some [[:class:]] under /d; the FLAGS field gives which one
 106 POSIXL      POSIXD,     none 0 S   ; Some [[:class:]] under /l; the FLAGS field gives which one
 107 POSIXU      POSIXD,     none 0 S   ; Some [[:class:]] under /u; the FLAGS field gives which one
 108 POSIXA      POSIXD,     none 0 S   ; Some [[:class:]] under /a; the FLAGS field gives which one
 109 NPOSIXD     NPOSIXD,    none 0 S   ; complement of POSIXD, [[:^class:]]
 110 NPOSIXL     NPOSIXD,    none 0 S   ; complement of POSIXL, [[:^class:]]
 111 NPOSIXU     NPOSIXD,    none 0 S   ; complement of POSIXU, [[:^class:]]
 112 NPOSIXA     NPOSIXD,    none 0 S   ; complement of POSIXA, [[:^class:]]
 113 # End of order is important
 114
 115 CLUMP       CLUMP,      no 0 V    ; Match any extended grapheme cluster sequence
 116
 117 #* Alternation
 118
 119 #* BRANCH        The set of branches constituting a single choice are
 120 #*               hooked together with their "next" pointers, since
 121 #*               precedence prevents anything being concatenated to
 122 #*               any individual branch.  The "next" pointer of the last
 123 #*               BRANCH in a choice points to the thing following the
 124 #*               whole choice.  This is also where the final "next"
 125 #*               pointer of each individual branch points; each branch
 126 #*               starts with the operand node of a BRANCH node.
 127 #*
 128 BRANCH      BRANCH,     node 0 V  ; Match this alternative, or the next...
 129
 130 #*Literals
 131 # NOTE: the relative ordering of these types is important do not change it
 132 # By convention, folding nodes begin with EXACTF; A digit 8 is in the name if
 133 # and only if it it requires a UTF-8 target string in order to successfully
 134 # match.
 135
 136 EXACT       EXACT,      str       ; Match this string (flags field is the length).
 137
 138 #* In a long string node, the U32 argument is the length, and is
 139 #* immediately followed by the string.
 140 LEXACT      EXACT,  len:str 1; Match this long string (preceded by length; flags unused).
 141 EXACTL      EXACT,      str       ; Like EXACT, but /l is in effect (used so locale-related warnings can be checked for)
 142 EXACTF      EXACT,      str       ; Like EXACT, but match using /id rules; (string not UTF-8, ASCII folded; non-ASCII not)
 143 EXACTFL     EXACT,      str       ; Like EXACT, but match using /il rules; (string not likely to be folded)
 144 EXACTFU     EXACT,      str       ; Like EXACT, but match using /iu rules; (string folded)
 145
 146 # The reason MICRO and SHARP S aren't folded in non-UTF8 patterns is because
 147 # they would fold to something that requires UTF-8.  SHARP S would normally
 148 # fold to 'ss', but because of /aa, it instead folds to a pair of LATIN SMALL
 149 # LETTER LONG S characters (U+017F)
 150 EXACTFAA    EXACT,      str       ; Like EXACT, but match using /iaa rules; (string folded except MICRO in non-UTF8 patterns; doesn't contain SHARP S unless UTF-8; folded length <= unfolded)
 151 # must immediately follow EXACTFAA
 152 EXACTFAA_NO_TRIE  EXACT, str      ; Like EXACTFAA, (string not UTF-8, folded except: MICRO, SHARP S; folded length <= unfolded, not currently trie-able)
 153
 154 # End of important relative ordering.
 155
 156 EXACTFUP    EXACT,      str       ; Like EXACT, but match using /iu rules; (string not UTF-8, folded except MICRO: hence Problematic)
 157 # In order for a non-UTF-8 EXACTFAA to think the pattern is pre-folded when
 158 # matching a UTF-8 target string, there would have to be something like an
 159 # EXACTFAA_MICRO which would not be considered pre-folded for UTF-8 targets,
 160 # since the fold of the MICRO SIGN would not be done, and would be
 161 # representable in the UTF-8 target string.
 162
 163 EXACTFLU8   EXACT,      str       ; Like EXACTFU, but use /il, UTF-8, (string is folded, and everything in it is above 255
 164 EXACT_REQ8   EXACT,      str      ; Like EXACT, but only UTF-8 encoded targets can match
 165 LEXACT_REQ8  EXACT,  len:str 1    ; Like LEXACT, but only UTF-8 encoded targets can match
 166 EXACTFU_REQ8 EXACT,    str        ; Like EXACTFU, but only UTF-8 encoded targets can match
 167 # One could add EXACTFAA8 and something that has the same effect for /l,
 168 # but these would be extremely uncommon
 169
 170 EXACTFU_S_EDGE EXACT,   str       ; /di rules, but nothing in it precludes /ui, except begins and/or ends with [Ss]; (string not UTF-8; compile-time only)
 171
 172 #*New charclass like patterns
 173 LNBREAK     LNBREAK,    none      ; generic newline pattern
 174
 175 #*Trie Related
 176
 177 #* Behave the same as A|LIST|OF|WORDS would. The '..C' variants
 178 #* have inline charclass data (ascii only), the 'C' store it in the
 179 #* structure.
 180 # NOTE: the relative order of the TRIE-like regops  is significant
 181
 182 TRIE        TRIE,       trie 1    ; Match many EXACT(F[ALU]?)? at once. flags==type
 183 TRIEC       TRIE,trie charclass   ; Same as TRIE, but with embedded charclass data
 184
 185 # For start classes, contains an added fail table.
 186 AHOCORASICK     TRIE,   trie 1    ; Aho Corasick stclass. flags==type
 187 AHOCORASICKC    TRIE,trie charclass   ; Same as AHOCORASICK, but with embedded charclass data
 188
 189 #*Do nothing types
 190
 191 NOTHING     NOTHING,    no        ; Match empty string.
 192 #*A variant of above which delimits a group, thus stops optimizations
 193 TAIL        NOTHING,    no        ; Match empty string. Can jump here from outside.
 194
 195 #*Loops
 196
 197 #* STAR,PLUS    '?', and complex '*' and '+', are implemented as
 198 #*               circular BRANCH structures.  Simple cases
 199 #*               (one character per match) are implemented with STAR
 200 #*               and PLUS for speed and to minimize recursive plunges.
 201 #*
 202 STAR        STAR,       node 0 V  ; Match this (simple) thing 0 or more times.
 203 PLUS        PLUS,       node 0 V  ; Match this (simple) thing 1 or more times.
 204
 205 CURLY       CURLY,      sv 2 V    ; Match this simple thing {n,m} times.
 206 CURLYN      CURLY,      no 2 V    ; Capture next-after-this simple thing
 207 CURLYM      CURLY,      no 2 V    ; Capture this medium-complex thing {n,m} times.
 208 CURLYX      CURLY,      sv 2 V    ; Match this complex thing {n,m} times.
 209
 210 #*This terminator creates a loop structure for CURLYX
 211 WHILEM      WHILEM,     no 0 V    ; Do curly processing and see if rest matches.
 212
 213 #*Buffer related
 214
 215 #*OPEN,CLOSE,GROUPP     ...are numbered at compile time.
 216 OPEN        OPEN,       num 1     ; Mark this point in input as start of #n.
 217 CLOSE       CLOSE,      num 1     ; Close corresponding OPEN of #n.
 218 SROPEN      SROPEN,     none      ; Same as OPEN, but for script run
 219 SRCLOSE     SRCLOSE,    none      ; Close preceding SROPEN
 220
 221 REF         REF,        num 1 V   ; Match some already matched string
 222 REFF        REF,        num 1 V   ; Match already matched string, using /di rules.
 223 REFFL       REF,        num 1 V   ; Match already matched string, using /li rules.
 224 # N?REFF[AU] could have been implemented using the FLAGS field of the
 225 # regnode, but by having a separate node type, we can use the existing switch
 226 # statement to avoid some tests
 227 REFFU       REF,        num 1 V   ; Match already matched string, usng /ui.
 228 REFFA       REF,        num 1 V   ; Match already matched string, using /aai rules.
 229
 230 #*Named references.  Code in regcomp.c assumes that these all are after
 231 #*the numbered references
 232 REFN        REF,        no-sv 1 V ; Match some already matched string
 233 REFFN       REF,        no-sv 1 V ; Match already matched string, using /di rules.
 234 REFFLN      REF,        no-sv 1 V ; Match already matched string, using /li rules.
 235 REFFUN      REF,        num   1 V ; Match already matched string, using /ui rules.
 236 REFFAN      REF,        num   1 V ; Match already matched string, using /aai rules.
 237
 238 #*Support for long RE
 239 LONGJMP     LONGJMP,    off 1 . 1 ; Jump far away.
 240 BRANCHJ     BRANCHJ,    off 1 V 1 ; BRANCH with long offset.
 241
 242 #*Special Case Regops
 243 IFMATCH     BRANCHJ,    off 1 . 1 ; Succeeds if the following matches; non-zero flags "f", next_off "o" means lookbehind assertion starting "f..(f-o)" characters before current
 244 UNLESSM     BRANCHJ,    off 1 . 1 ; Fails if the following matches; non-zero flags "f", next_off "o" means lookbehind assertion starting "f..(f-o)" characters before current
 245 SUSPEND     BRANCHJ,    off 1 V 1 ; "Independent" sub-RE.
 246 IFTHEN      BRANCHJ,    off 1 V 1 ; Switch, should be preceded by switcher.
 247 GROUPP      GROUPP,     num 1     ; Whether the group matched.
 248
 249 #*The heavy worker
 250
 251 EVAL        EVAL,       evl/flags 2L ; Execute some Perl code.
 252
 253 #*Modifiers
 254
 255 MINMOD      MINMOD,     no        ; Next operator is not greedy.
 256 LOGICAL     LOGICAL,    no        ; Next opcode should set the flag only.
 257
 258 #*This is not used yet
 259 RENUM       BRANCHJ,    off 1 . 1 ; Group with independently numbered parens.
 260
 261 #*Regex Subroutines
 262 GOSUB       GOSUB,      num/ofs 2L    ; recurse to paren arg1 at (signed) ofs arg2
 263
 264 #*Special conditionals
 265 GROUPPN     GROUPPN,    no-sv 1   ; Whether the group matched.
 266 INSUBP      INSUBP,     num 1     ; Whether we are in a specific recurse.
 267 DEFINEP     DEFINEP,    none 1    ; Never execute directly.
 268
 269 #*Backtracking Verbs
 270 ENDLIKE     ENDLIKE,    none      ; Used only for the type field of verbs
 271 OPFAIL      ENDLIKE,    no-sv 1   ; Same as (?!), but with verb arg
 272 ACCEPT      ENDLIKE,    no-sv/num 2L   ; Accepts the current matched string, with verbar
 273
 274 #*Verbs With Arguments
 275 VERB        VERB,       no-sv 1   ; Used only for the type field of verbs
 276 PRUNE       VERB,       no-sv 1   ; Pattern fails at this startpoint if no-backtracking through this
 277 MARKPOINT   VERB,       no-sv 1   ; Push the current location for rollback by cut.
 278 SKIP        VERB,       no-sv 1   ; On failure skip forward (to the mark) before retrying
 279 COMMIT      VERB,       no-sv 1   ; Pattern fails outright if backtracking through this
 280 CUTGROUP    VERB,       no-sv 1   ; On failure go to the next alternation in the group
 281
 282 #*Control what to keep in $&.
 283 KEEPS       KEEPS,      no        ; $& begins here.
 284
 285 # NEW STUFF SOMEWHERE ABOVE THIS LINE.  Stuff that regexec.c: find_byclass()
 286 # and regrepeat() use should go way above, near LNBREAK to allow a more compact
 287 # jump table to be generated for their switch() statements
 288
 289 ################################################################################
 290
 291 #*SPECIAL  REGOPS
 292
 293 #* This is not really a node, but an optimized away piece of a "long"
 294 #* node.  To simplify debugging output, we mark it as if it were a node
 295 OPTIMIZED   NOTHING,    off       ; Placeholder for dump.
 296
 297 #* Special opcode with the property that no opcode in a compiled program
 298 #* will ever be of this type. Thus it can be used as a flag value that
 299 #* no other opcode has been seen. END is used similarly, in that an END
 300 #* node cant be optimized. So END implies "unoptimizable" and PSEUDO
 301 #* mean "not seen anything to optimize yet".
 302 PSEUDO      PSEUDO,     off       ; Pseudo opcode for internal use.
 303
 304 REGEX_SET   REGEX_SET,  depth p S ; Regex set, temporary node used in pre-optimization compilation
 305
 306 -------------------------------------------------------------------------------
 307 # Format for second section:
 308 # REGOP \t typelist [ \t typelist]
 309 # typelist= namelist
 310 #         = namelist:FAIL
 311 #         = name:count
 312
 313 # Anything below is a state
 314 #
 315 #
 316 TRIE            next:FAIL
 317 EVAL            B,postponed_AB:FAIL
 318 CURLYX          end:FAIL
 319 WHILEM          A_pre,A_min,A_max,B_min,B_max:FAIL
 320 BRANCH          next:FAIL
 321 CURLYM          A,B:FAIL
 322 IFMATCH         A:FAIL
 323 CURLY           B_min,B_max:FAIL
 324 COMMIT          next:FAIL
 325 MARKPOINT       next:FAIL
 326 SKIP            next:FAIL
 327 CUTGROUP        next:FAIL
 328 KEEPS           next:FAIL