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