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