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