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