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