regcomp.sym

   1 # Format:
   2 # NAME \t TYPE, arg-description [num-args] [longjump-len] \t DESCRIPTION
   3
   4 # Empty rows and #-comment rows are ignored.
   5
   6 # Exit points
   7 END             END,    no      End of program.
   8 SUCCEED         END,    no      Return from a subroutine, basically.
   9
  10 # Anchors:
  11 BOL             BOL,    no      Match "" at beginning of line.
  12 MBOL            BOL,    no      Same, assuming multiline.
  13 SBOL            BOL,    no      Same, assuming singleline.
  14 EOS             EOL,    no      Match "" at end of string.
  15 EOL             EOL,    no      Match "" at end of line.
  16 MEOL            EOL,    no      Same, assuming multiline.
  17 SEOL            EOL,    no      Same, assuming singleline.
  18 BOUND           BOUND,  no      Match "" at any word boundary
  19 BOUNDL          BOUND,  no      Match "" at any word boundary
  20 NBOUND          NBOUND, no      Match "" at any word non-boundary
  21 NBOUNDL         NBOUND, no      Match "" at any word non-boundary
  22 GPOS            GPOS,   no      Matches where last m//g left off.
  23
  24 # [Special] alternatives
  25 REG_ANY         REG_ANY,    no  Match any one character (except newline).
  26 SANY            REG_ANY,    no  Match any one character.
  27 ANYOF           ANYOF,  sv      Match character in (or not in) this class.
  28 ALNUM           ALNUM,  no      Match any alphanumeric character
  29 ALNUML          ALNUM,  no      Match any alphanumeric char in locale
  30 NALNUM          NALNUM, no      Match any non-alphanumeric character
  31 NALNUML         NALNUM, no      Match any non-alphanumeric char in locale
  32 SPACE           SPACE,  no      Match any whitespace character
  33 SPACEL          SPACE,  no      Match any whitespace char in locale
  34 NSPACE          NSPACE, no      Match any non-whitespace character
  35 NSPACEL         NSPACE, no      Match any non-whitespace char in locale
  36 DIGIT           DIGIT,  no      Match any numeric character
  37 DIGITL          DIGIT,  no      Match any numeric character in locale
  38 NDIGIT          NDIGIT, no      Match any non-numeric character
  39 NDIGITL         NDIGIT, no      Match any non-numeric character in locale
  40 CLUMP           CLUMP,  no      Match any combining character sequence
  41
  42 # BRANCH        The set of branches constituting a single choice are hooked
  43 #               together with their "next" pointers, since precedence prevents
  44 #               anything being concatenated to any individual branch.  The
  45 #               "next" pointer of the last BRANCH in a choice points to the
  46 #               thing following the whole choice.  This is also where the
  47 #               final "next" pointer of each individual branch points; each
  48 #               branch starts with the operand node of a BRANCH node.
  49 #
  50 BRANCH          BRANCH, node    Match this alternative, or the next...
  51
  52 # BACK          Normal "next" pointers all implicitly point forward; BACK
  53 #               exists to make loop structures possible.
  54 # not used
  55 BACK            BACK,   no      Match "", "next" ptr points backward.
  56
  57 # Literals
  58 EXACT           EXACT,  sv      Match this string (preceded by length).
  59 EXACTF          EXACT,  sv      Match this string, folded (prec. by length).
  60 EXACTFL         EXACT,  sv      Match this string, folded in locale (w/len).
  61
  62 # Do nothing
  63 NOTHING         NOTHING,no      Match empty string.
  64 # A variant of above which delimits a group, thus stops optimizations
  65 TAIL            NOTHING,no      Match empty string. Can jump here from outside.
  66
  67 # STAR,PLUS     '?', and complex '*' and '+', are implemented as circular
  68 #               BRANCH structures using BACK.  Simple cases (one character
  69 #               per match) are implemented with STAR and PLUS for speed
  70 #               and to minimize recursive plunges.
  71 #
  72 STAR            STAR,   node    Match this (simple) thing 0 or more times.
  73 PLUS            PLUS,   node    Match this (simple) thing 1 or more times.
  74
  75 CURLY           CURLY,  sv 2    Match this simple thing {n,m} times.
  76 CURLYN          CURLY,  no 2    Match next-after-this simple thing
  77 #                               {n,m} times, set parenths.
  78 CURLYM          CURLY,  no 2    Match this medium-complex thing {n,m} times.
  79 CURLYX          CURLY,  sv 2    Match this complex thing {n,m} times.
  80
  81 # This terminator creates a loop structure for CURLYX
  82 WHILEM          WHILEM, no      Do curly processing and see if rest matches.
  83
  84 # OPEN,CLOSE,GROUPP     ...are numbered at compile time.
  85 OPEN            OPEN,   num 1   Mark this point in input as start of #n.
  86 CLOSE           CLOSE,  num 1   Analogous to OPEN.
  87
  88 REF             REF,    num 1   Match some already matched string
  89 REFF            REF,    num 1   Match already matched string, folded
  90 REFFL           REF,    num 1   Match already matched string, folded in loc.
  91
  92 # grouping assertions
  93 IFMATCH         BRANCHJ,off 1 2 Succeeds if the following matches.
  94 UNLESSM         BRANCHJ,off 1 2 Fails if the following matches.
  95 SUSPEND         BRANCHJ,off 1 1 "Independent" sub-RE.
  96 IFTHEN          BRANCHJ,off 1 1 Switch, should be preceeded by switcher .
  97 GROUPP          GROUPP, num 1   Whether the group matched.
  98
  99 # Support for long RE
 100 LONGJMP         LONGJMP,off 1 1 Jump far away.
 101 BRANCHJ         BRANCHJ,off 1 1 BRANCH with long offset.
 102
 103 # The heavy worker
 104 EVAL            EVAL,   evl 1   Execute some Perl code.
 105
 106 # Modifiers
 107 MINMOD          MINMOD, no      Next operator is not greedy.
 108 LOGICAL         LOGICAL,no      Next opcode should set the flag only.
 109
 110 # This is not used yet
 111 RENUM           BRANCHJ,off 1 1 Group with independently numbered parens.
 112
 113 # This is not really a node, but an optimized away piece of a "long" node.
 114 # To simplify debugging output, we mark it as if it were a node
 115 OPTIMIZED       NOTHING,off     Placeholder for dump.