regcomp.h

   1 /* $RCSfile: regcomp.h,v $$Revision: 4.1 $$Date: 92/08/07 18:26:31 $
   2  *
   3  * $Log:        regcomp.h,v $
   4  * Revision 4.1  92/08/07  18:26:31  lwall
   5  *
   6  * Revision 4.0.1.1  91/06/07  11:49:40  lwall
   7  * patch4: no change
   8  *
   9  * Revision 4.0  91/03/20  01:39:09  lwall
  10  * 4.0 baseline.
  11  *
  12  */
  13
  14 /*
  15  * The "internal use only" fields in regexp.h are present to pass info from
  16  * compile to execute that permits the execute phase to run lots faster on
  17  * simple cases.  They are:
  18  *
  19  * regstart     sv that must begin a match; Nullch if none obvious
  20  * reganch      is the match anchored (at beginning-of-line only)?
  21  * regmust      string (pointer into program) that match must include, or NULL
  22  *  [regmust changed to SV* for bminstr()--law]
  23  * regmlen      length of regmust string
  24  *  [regmlen not used currently]
  25  *
  26  * Regstart and reganch permit very fast decisions on suitable starting points
  27  * for a match, cutting down the work a lot.  Regmust permits fast rejection
  28  * of lines that cannot possibly match.  The regmust tests are costly enough
  29  * that regcomp() supplies a regmust only if the r.e. contains something
  30  * potentially expensive (at present, the only such thing detected is * or +
  31  * at the start of the r.e., which can involve a lot of backup).  Regmlen is
  32  * supplied because the test in regexec() needs it and regcomp() is computing
  33  * it anyway.
  34  * [regmust is now supplied always.  The tests that use regmust have a
  35  * heuristic that disables the test if it usually matches.]
  36  *
  37  * [In fact, we now use regmust in many cases to locate where the search
  38  * starts in the string, so if regback is >= 0, the regmust search is never
  39  * wasted effort.  The regback variable says how many characters back from
  40  * where regmust matched is the earliest possible start of the match.
  41  * For instance, /[a-z].foo/ has a regmust of 'foo' and a regback of 2.]
  42  */
  43
  44 /*
  45  * Structure for regexp "program".  This is essentially a linear encoding
  46  * of a nondeterministic finite-state machine (aka syntax charts or
  47  * "railroad normal form" in parsing technology).  Each node is an opcode
  48  * plus a "next" pointer, possibly plus an operand.  "Next" pointers of
  49  * all nodes except BRANCH implement concatenation; a "next" pointer with
  50  * a BRANCH on both ends of it is connecting two alternatives.  (Here we
  51  * have one of the subtle syntax dependencies:  an individual BRANCH (as
  52  * opposed to a collection of them) is never concatenated with anything
  53  * because of operator precedence.)  The operand of some types of node is
  54  * a literal string; for others, it is a node leading into a sub-FSM.  In
  55  * particular, the operand of a BRANCH node is the first node of the branch.
  56  * (NB this is *not* a tree structure:  the tail of the branch connects
  57  * to the thing following the set of BRANCHes.)  The opcodes are:
  58  */
  59
  60 /* definition   number  opnd?   meaning */
  61 #define END     0       /* no   End of program. */
  62 #define BOL     1       /* no   Match "" at beginning of line. */
  63 #define EOL     2       /* no   Match "" at end of line. */
  64 #define ANY     3       /* no   Match any one character. */
  65 #define ANYOF   4       /* sv   Match character in (or not in) this class. */
  66 #define CURLY   5       /* sv   Match this simple thing {n,m} times. */
  67 #define BRANCH  6       /* node Match this alternative, or the next... */
  68 #define BACK    7       /* no   Match "", "next" ptr points backward. */
  69 #define EXACTLY 8       /* sv   Match this string (preceded by length). */
  70 #define NOTHING 9       /* no   Match empty string. */
  71 #define STAR    10      /* node Match this (simple) thing 0 or more times. */
  72 #define PLUS    11      /* node Match this (simple) thing 1 or more times. */
  73 #define ALNUM   12      /* no   Match any alphanumeric character */
  74 #define NALNUM  13      /* no   Match any non-alphanumeric character */
  75 #define BOUND   14      /* no   Match "" at any word boundary */
  76 #define NBOUND  15      /* no   Match "" at any word non-boundary */
  77 #define SPACE   16      /* no   Match any whitespace character */
  78 #define NSPACE  17      /* no   Match any non-whitespace character */
  79 #define DIGIT   18      /* no   Match any numeric character */
  80 #define NDIGIT  19      /* no   Match any non-numeric character */
  81 #define REF     20      /* num  Match some already matched string */
  82 #define OPEN    21      /* num  Mark this point in input as start of #n. */
  83 #define CLOSE   22      /* num  Analogous to OPEN. */
  84
  85 /*
  86  * Opcode notes:
  87  *
  88  * BRANCH       The set of branches constituting a single choice are hooked
  89  *              together with their "next" pointers, since precedence prevents
  90  *              anything being concatenated to any individual branch.  The
  91  *              "next" pointer of the last BRANCH in a choice points to the
  92  *              thing following the whole choice.  This is also where the
  93  *              final "next" pointer of each individual branch points; each
  94  *              branch starts with the operand node of a BRANCH node.
  95  *
  96  * BACK         Normal "next" pointers all implicitly point forward; BACK
  97  *              exists to make loop structures possible.
  98  *
  99  * STAR,PLUS    '?', and complex '*' and '+', are implemented as circular
 100  *              BRANCH structures using BACK.  Simple cases (one character
 101  *              per match) are implemented with STAR and PLUS for speed
 102  *              and to minimize recursive plunges.
 103  *
 104  * OPEN,CLOSE   ...are numbered at compile time.
 105  */
 106
 107 #ifndef DOINIT
 108 extern char regarglen[];
 109 #else
 110 char regarglen[] = {0,0,0,0,0,4,0,0,0,0,0,0,0,0,0,0,0,0,0,0,2,2,2};
 111 #endif
 112
 113 /* The following have no fixed length. */
 114 #ifndef DOINIT
 115 extern char varies[];
 116 #else
 117 char varies[] = {BRANCH,BACK,STAR,PLUS,CURLY,REF,0};
 118 #endif
 119
 120 /* The following always have a length of 1. */
 121 #ifndef DOINIT
 122 extern char simple[];
 123 #else
 124 char simple[] = {ANY,ANYOF,ALNUM,NALNUM,SPACE,NSPACE,DIGIT,NDIGIT,0};
 125 #endif
 126
 127 EXT char regdummy;
 128
 129 /*
 130  * A node is one char of opcode followed by two chars of "next" pointer.
 131  * "Next" pointers are stored as two 8-bit pieces, high order first.  The
 132  * value is a positive offset from the opcode of the node containing it.
 133  * An operand, if any, simply follows the node.  (Note that much of the
 134  * code generation knows about this implicit relationship.)
 135  *
 136  * Using two bytes for the "next" pointer is vast overkill for most things,
 137  * but allows patterns to get big without disasters.
 138  *
 139  * [If REGALIGN is defined, the "next" pointer is always aligned on an even
 140  * boundary, and reads the offset directly as a short.  Also, there is no
 141  * special test to reverse the sign of BACK pointers since the offset is
 142  * stored negative.]
 143  */
 144
 145 #ifndef gould
 146 #ifndef cray
 147 #ifndef eta10
 148 #define REGALIGN
 149 #endif
 150 #endif
 151 #endif
 152
 153 #define OP(p)   (*(p))
 154
 155 #ifndef lint
 156 #ifdef REGALIGN
 157 #define NEXT(p) (*(short*)(p+1))
 158 #define ARG1(p) (*(unsigned short*)(p+3))
 159 #define ARG2(p) (*(unsigned short*)(p+5))
 160 #else
 161 #define NEXT(p) (((*((p)+1)&0377)<<8) + (*((p)+2)&0377))
 162 #define ARG1(p) (((*((p)+3)&0377)<<8) + (*((p)+4)&0377))
 163 #define ARG2(p) (((*((p)+5)&0377)<<8) + (*((p)+6)&0377))
 164 #endif
 165 #else /* lint */
 166 #define NEXT(p) 0
 167 #endif /* lint */
 168
 169 #define OPERAND(p)      ((p) + 3)
 170
 171 #ifdef REGALIGN
 172 #define NEXTOPER(p)     ((p) + 4)
 173 #else
 174 #define NEXTOPER(p)     ((p) + 3)
 175 #endif
 176
 177 #define MAGIC 0234
 178
 179 /*
 180  * Utility definitions.
 181  */
 182 #ifndef lint
 183 #ifndef CHARMASK
 184 #define UCHARAT(p)      ((int)*(unsigned char *)(p))
 185 #else
 186 #define UCHARAT(p)      ((int)*(p)&CHARMASK)
 187 #endif
 188 #else /* lint */
 189 #define UCHARAT(p)      regdummy
 190 #endif /* lint */
 191
 192 #define FAIL(m) croak("/%s/: %s",regprecomp,m)