regcomp.h

   1 /*    regcomp.h
   2  *
   3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
   4  *    2000, 2001, 2002, 2003, 2005, 2006, 2007, by Larry Wall and others
   5  *
   6  *    You may distribute under the terms of either the GNU General Public
   7  *    License or the Artistic License, as specified in the README file.
   8  *
   9  */
  10 #include "regcharclass.h"
  11
  12 /* Convert branch sequences to more efficient trie ops? */
  13 #define PERL_ENABLE_TRIE_OPTIMISATION 1
  14
  15 /* Be really aggressive about optimising patterns with trie sequences? */
  16 #define PERL_ENABLE_EXTENDED_TRIE_OPTIMISATION 1
  17
  18 /* Should the optimiser take positive assertions into account? */
  19 #define PERL_ENABLE_POSITIVE_ASSERTION_STUDY 0
  20
  21 /* Not for production use: */
  22 #define PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS 0
  23
  24 /* Activate offsets code - set to if 1 to enable */
  25 #ifdef DEBUGGING
  26 #define RE_TRACK_PATTERN_OFFSETS
  27 #endif
  28
  29 /* Unless the next line is uncommented it is illegal to combine lazy
  30    matching with possessive matching. Frankly it doesn't make much sense
  31    to allow it as X*?+ matches nothing, X+?+ matches a single char only,
  32    and X{min,max}?+ matches min times only.
  33  */
  34 /* #define REG_ALLOW_MINMOD_SUSPEND */
  35
  36 /*
  37  * The "internal use only" fields in regexp.h are present to pass info from
  38  * compile to execute that permits the execute phase to run lots faster on
  39  * simple cases.  They are:
  40  *
  41  * regstart     sv that must begin a match; NULL if none obvious
  42  * reganch      is the match anchored (at beginning-of-line only)?
  43  * regmust      string (pointer into program) that match must include, or NULL
  44  *  [regmust changed to SV* for bminstr()--law]
  45  * regmlen      length of regmust string
  46  *  [regmlen not used currently]
  47  *
  48  * Regstart and reganch permit very fast decisions on suitable starting points
  49  * for a match, cutting down the work a lot.  Regmust permits fast rejection
  50  * of lines that cannot possibly match.  The regmust tests are costly enough
  51  * that pregcomp() supplies a regmust only if the r.e. contains something
  52  * potentially expensive (at present, the only such thing detected is * or +
  53  * at the start of the r.e., which can involve a lot of backup).  Regmlen is
  54  * supplied because the test in pregexec() needs it and pregcomp() is computing
  55  * it anyway.
  56  * [regmust is now supplied always.  The tests that use regmust have a
  57  * heuristic that disables the test if it usually matches.]
  58  *
  59  * [In fact, we now use regmust in many cases to locate where the search
  60  * starts in the string, so if regback is >= 0, the regmust search is never
  61  * wasted effort.  The regback variable says how many characters back from
  62  * where regmust matched is the earliest possible start of the match.
  63  * For instance, /[a-z].foo/ has a regmust of 'foo' and a regback of 2.]
  64  */
  65
  66 /*
  67  * Structure for regexp "program".  This is essentially a linear encoding
  68  * of a nondeterministic finite-state machine (aka syntax charts or
  69  * "railroad normal form" in parsing technology).  Each node is an opcode
  70  * plus a "next" pointer, possibly plus an operand.  "Next" pointers of
  71  * all nodes except BRANCH implement concatenation; a "next" pointer with
  72  * a BRANCH on both ends of it is connecting two alternatives.  (Here we
  73  * have one of the subtle syntax dependencies:  an individual BRANCH (as
  74  * opposed to a collection of them) is never concatenated with anything
  75  * because of operator precedence.)  The operand of some types of node is
  76  * a literal string; for others, it is a node leading into a sub-FSM.  In
  77  * particular, the operand of a BRANCH node is the first node of the branch.
  78  * (NB this is *not* a tree structure:  the tail of the branch connects
  79  * to the thing following the set of BRANCHes.)  The opcodes are defined
  80  * in regnodes.h which is generated from regcomp.sym by regcomp.pl.
  81  */
  82
  83 /*
  84  * A node is one char of opcode followed by two chars of "next" pointer.
  85  * "Next" pointers are stored as two 8-bit pieces, high order first.  The
  86  * value is a positive offset from the opcode of the node containing it.
  87  * An operand, if any, simply follows the node.  (Note that much of the
  88  * code generation knows about this implicit relationship.)
  89  *
  90  * Using two bytes for the "next" pointer is vast overkill for most things,
  91  * but allows patterns to get big without disasters.
  92  *
  93  * [The "next" pointer is always aligned on an even
  94  * boundary, and reads the offset directly as a short.  Also, there is no
  95  * special test to reverse the sign of BACK pointers since the offset is
  96  * stored negative.]
  97  */
  98
  99 /* This is the stuff that used to live in regexp.h that was truly
 100    private to the engine itself. It now lives here. */
 101
 102
 103
 104  typedef struct regexp_internal {
 105         int name_list_idx;      /* Optional data index of an array of paren names */
 106         union {
 107             U32 *offsets;           /* offset annotations 20001228 MJD
 108                                        data about mapping the program to the
 109                                        string -
 110                                        offsets[0] is proglen when this is used
 111                                        */
 112             U32 proglen;
 113         } u;
 114
 115         regnode *regstclass;    /* Optional startclass as identified or constructed
 116                                    by the optimiser */
 117         struct reg_data *data;  /* Additional miscellaneous data used by the program.
 118                                    Used to make it easier to clone and free arbitrary
 119                                    data that the regops need. Often the ARG field of
 120                                    a regop is an index into this structure */
 121         struct reg_code_block *code_blocks;/* positions of literal (?{}) */
 122         int num_code_blocks;    /* size of code_blocks[] */
 123         regnode program[1];     /* Unwarranted chumminess with compiler. */
 124 } regexp_internal;
 125
 126 #define RXi_SET(x,y) (x)->pprivate = (void*)(y)
 127 #define RXi_GET(x)   ((regexp_internal *)((x)->pprivate))
 128 #define RXi_GET_DECL(r,ri) regexp_internal *ri = RXi_GET(r)
 129 /*
 130  * Flags stored in regexp->intflags
 131  * These are used only internally to the regexp engine
 132  *
 133  * See regexp.h for flags used externally to the regexp engine
 134  */
 135 #define PREGf_SKIP              0x00000001
 136 #define PREGf_IMPLICIT          0x00000002 /* Converted .* to ^.* */
 137 #define PREGf_NAUGHTY           0x00000004 /* how exponential is this pattern? */
 138 #define PREGf_VERBARG_SEEN      0x00000008
 139 #define PREGf_CUTGROUP_SEEN     0x00000010
 140
 141
 142 /* this is where the old regcomp.h started */
 143
 144 struct regnode_string {
 145     U8  str_len;
 146     U8  type;
 147     U16 next_off;
 148     char string[1];
 149 };
 150
 151 /* Argument bearing node - workhorse,
 152    arg1 is often for the data field */
 153 struct regnode_1 {
 154     U8  flags;
 155     U8  type;
 156     U16 next_off;
 157     U32 arg1;
 158 };
 159
 160 /* Similar to a regnode_1 but with an extra signed argument */
 161 struct regnode_2L {
 162     U8  flags;
 163     U8  type;
 164     U16 next_off;
 165     U32 arg1;
 166     I32 arg2;
 167 };
 168
 169 /* 'Two field' -- Two 16 bit unsigned args */
 170 struct regnode_2 {
 171     U8  flags;
 172     U8  type;
 173     U16 next_off;
 174     U16 arg1;
 175     U16 arg2;
 176 };
 177
 178
 179 #define ANYOF_BITMAP_SIZE       32      /* 256 b/(8 b/B) */
 180 #define ANYOF_CLASSBITMAP_SIZE   4      /* up to 32 (8*4) named classes */
 181
 182 /* also used by trie */
 183 struct regnode_charclass {
 184     U8  flags;
 185     U8  type;
 186     U16 next_off;
 187     U32 arg1;                           /* used as ptr in S_regclass */
 188     char bitmap[ANYOF_BITMAP_SIZE];     /* only compile-time */
 189 };
 190
 191 /* has runtime (locale) \d, \w, ..., [:posix:] classes */
 192 struct regnode_charclass_class {
 193     U8  flags;                          /* ANYOF_CLASS bit must go here */
 194     U8  type;
 195     U16 next_off;
 196     U32 arg1;                                   /* used as ptr in S_regclass */
 197     char bitmap[ANYOF_BITMAP_SIZE];             /* both compile-time */
 198     char classflags[ANYOF_CLASSBITMAP_SIZE];    /* and run-time */
 199 };
 200
 201 /* XXX fix this description.
 202    Impose a limit of REG_INFTY on various pattern matching operations
 203    to limit stack growth and to avoid "infinite" recursions.
 204 */
 205 /* The default size for REG_INFTY is I16_MAX, which is the same as
 206    SHORT_MAX (see perl.h).  Unfortunately I16 isn't necessarily 16 bits
 207    (see handy.h).  On the Cray C90, sizeof(short)==4 and hence I16_MAX is
 208    ((1<<31)-1), while on the Cray T90, sizeof(short)==8 and I16_MAX is
 209    ((1<<63)-1).  To limit stack growth to reasonable sizes, supply a
 210    smaller default.
 211         --Andy Dougherty  11 June 1998
 212 */
 213 #if SHORTSIZE > 2
 214 #  ifndef REG_INFTY
 215 #    define REG_INFTY ((1<<15)-1)
 216 #  endif
 217 #endif
 218
 219 #ifndef REG_INFTY
 220 #  define REG_INFTY I16_MAX
 221 #endif
 222
 223 #define ARG_VALUE(arg) (arg)
 224 #define ARG__SET(arg,val) ((arg) = (val))
 225
 226 #undef ARG
 227 #undef ARG1
 228 #undef ARG2
 229
 230 #define ARG(p) ARG_VALUE(ARG_LOC(p))
 231 #define ARG1(p) ARG_VALUE(ARG1_LOC(p))
 232 #define ARG2(p) ARG_VALUE(ARG2_LOC(p))
 233 #define ARG2L(p) ARG_VALUE(ARG2L_LOC(p))
 234
 235 #define ARG_SET(p, val) ARG__SET(ARG_LOC(p), (val))
 236 #define ARG1_SET(p, val) ARG__SET(ARG1_LOC(p), (val))
 237 #define ARG2_SET(p, val) ARG__SET(ARG2_LOC(p), (val))
 238 #define ARG2L_SET(p, val) ARG__SET(ARG2L_LOC(p), (val))
 239
 240 #undef NEXT_OFF
 241 #undef NODE_ALIGN
 242
 243 #define NEXT_OFF(p) ((p)->next_off)
 244 #define NODE_ALIGN(node)
 245 #define NODE_ALIGN_FILL(node) ((node)->flags = 0xde) /* deadbeef */
 246
 247 #define SIZE_ALIGN NODE_ALIGN
 248
 249 #undef OP
 250 #undef OPERAND
 251 #undef MASK
 252 #undef STRING
 253
 254 #define OP(p)           ((p)->type)
 255 #define FLAGS(p)        ((p)->flags)    /* Caution: Doesn't apply to all      \
 256                                            regnode types.  For some, it's the \
 257                                            character set of the regnode */
 258 #define OPERAND(p)      (((struct regnode_string *)p)->string)
 259 #define MASK(p)         ((char*)OPERAND(p))
 260 #define STR_LEN(p)      (((struct regnode_string *)p)->str_len)
 261 #define STRING(p)       (((struct regnode_string *)p)->string)
 262 #define STR_SZ(l)       ((l + sizeof(regnode) - 1) / sizeof(regnode))
 263 #define NODE_SZ_STR(p)  (STR_SZ(STR_LEN(p))+1)
 264
 265 #undef NODE_ALIGN
 266 #undef ARG_LOC
 267 #undef NEXTOPER
 268 #undef PREVOPER
 269
 270 #define NODE_ALIGN(node)
 271 #define ARG_LOC(p)      (((struct regnode_1 *)p)->arg1)
 272 #define ARG1_LOC(p)     (((struct regnode_2 *)p)->arg1)
 273 #define ARG2_LOC(p)     (((struct regnode_2 *)p)->arg2)
 274 #define ARG2L_LOC(p)    (((struct regnode_2L *)p)->arg2)
 275
 276 #define NODE_STEP_REGNODE       1       /* sizeof(regnode)/sizeof(regnode) */
 277 #define EXTRA_STEP_2ARGS        EXTRA_SIZE(struct regnode_2)
 278
 279 #define NODE_STEP_B     4
 280
 281 #define NEXTOPER(p)     ((p) + NODE_STEP_REGNODE)
 282 #define PREVOPER(p)     ((p) - NODE_STEP_REGNODE)
 283
 284 #define FILL_ADVANCE_NODE(ptr, op) STMT_START { \
 285     (ptr)->type = op;    (ptr)->next_off = 0;   (ptr)++; } STMT_END
 286 #define FILL_ADVANCE_NODE_ARG(ptr, op, arg) STMT_START { \
 287     ARG_SET(ptr, arg);  FILL_ADVANCE_NODE(ptr, op); (ptr) += 1; } STMT_END
 288
 289 #define REG_MAGIC 0234
 290
 291 #define SIZE_ONLY (RExC_emit == &PL_regdummy)
 292
 293 /* If the bitmap doesn't fully represent what this ANYOF node can match, the
 294  * ARG is set to this special value (since 0, 1, ... are legal, but will never
 295  * reach this high). */
 296 #define ANYOF_NONBITMAP_EMPTY   ((U32) -1)
 297
 298 /* The information used to be stored as as combination of the ANYOF_UTF8 and
 299  * ANYOF_NONBITMAP_NON_UTF8 bits in the flags field, but was moved out of there
 300  * to free up a bit for other uses.  This tries to hide the change from
 301  * existing code as much as possible.  Now, the data structure that goes in ARG
 302  * is not allocated unless it is needed, and that is what is used to determine
 303  * if there is something outside the bitmap.  The code now assumes that if
 304  * that structure exists, that any UTF-8 encoded string should be tried against
 305  * it, but a non-UTF8-encoded string will be tried only if the
 306  * ANYOF_NONBITMAP_NON_UTF8 bit is also set. */
 307 #define ANYOF_NONBITMAP(node)   (ARG(node) != ANYOF_NONBITMAP_EMPTY)
 308
 309 /* Flags for node->flags of ANYOF.  These are in short supply, so some games
 310  * are done to share them, as described below.  If necessary, the ANYOF_LOCALE
 311  * and ANYOF_CLASS bits could be shared with a space penalty for locale nodes,
 312  * but this isn't quite so easy, as the optimizer also uses ANYOF_CLASS.
 313  * Another option would be to push them into new nodes.  E.g. there could be an
 314  * ANYOF_LOCALE node that would be in place of the flag of the same name.
 315  * Once the planned change to compile all the above-latin1 code points is done,
 316  * then the UNICODE_ALL bit can be freed up, with a small performance penalty.
 317  * If flags need to be added that are applicable to the synthetic start class
 318  * only, with some work, they could be put in the next-node field, or in an
 319  * unused bit of the classflags field. */
 320
 321 #define ANYOF_LOCALE             0x01       /* /l modifier */
 322
 323 /* The fold is calculated and stored in the bitmap where possible at compile
 324  * time.  However there are two cases where it isn't possible.  These share
 325  * this bit:  1) under locale, where the actual folding varies depending on
 326  * what the locale is at the time of execution; and 2) where the folding is
 327  * specified in a swash, not the bitmap, such as characters which aren't
 328  * specified in the bitmap, or properties that aren't looked at at compile time
 329  */
 330 #define ANYOF_LOC_NONBITMAP_FOLD 0x02
 331
 332 #define ANYOF_INVERT             0x04
 333
 334 /* Set if this is a struct regnode_charclass_class vs a regnode_charclass.  This
 335  * is used for runtime \d, \w, [:posix:], ..., which are used only in locale
 336  * and the optimizer's synthetic start class.  Non-locale \d, etc are resolved
 337  * at compile-time */
 338 #define ANYOF_CLASS      0x08
 339 #define ANYOF_LARGE      ANYOF_CLASS    /* Same; name retained for back compat */
 340
 341 /* EOS, meaning that it can match an empty string too, is used for the
 342  * synthetic start class only. */
 343 #define ANYOF_EOS               0x10
 344
 345 /* ? Is this node the synthetic start class (ssc).  This bit is shared with
 346  * ANYOF_EOS, as the latter is used only for the ssc, and then not used by
 347  * regexec.c.  And, the code is structured so that if it is set, the ssc is
 348  * not used, so it is guaranteed to be 0 for the ssc by the time regexec.c
 349  * gets executed, and 0 for a non-ssc ANYOF node, as it only ever gets set for
 350  * a potential ssc candidate.  Thus setting it to 1 after it has been
 351  * determined that the ssc will be used is not ambiguous */
 352 #define ANYOF_IS_SYNTHETIC      ANYOF_EOS
 353
 354 /* Can match something outside the bitmap that isn't in utf8 */
 355 #define ANYOF_NONBITMAP_NON_UTF8 0x20
 356
 357 /* Matches every code point 0x100 and above*/
 358 #define ANYOF_UNICODE_ALL       0x40
 359
 360 /* Match all Latin1 characters that aren't ASCII when the target string is not
 361  * in utf8. */
 362 #define ANYOF_NON_UTF8_LATIN1_ALL 0x80
 363
 364 #define ANYOF_FLAGS_ALL         0xff
 365
 366 /* These are the flags that ANYOF_INVERT being set or not doesn't affect
 367  * whether they are operative or not.  e.g., the node still has LOCALE
 368  * regardless of being inverted; whereas ANYOF_UNICODE_ALL means something
 369  * different if inverted */
 370 #define INVERSION_UNAFFECTED_FLAGS (ANYOF_LOCALE                        \
 371                                    |ANYOF_LOC_NONBITMAP_FOLD            \
 372                                    |ANYOF_CLASS                         \
 373                                    |ANYOF_EOS                           \
 374                                    |ANYOF_NONBITMAP_NON_UTF8)
 375
 376 /* Character classes for node->classflags of ANYOF */
 377 /* Should be synchronized with a table in regprop() */
 378 /* 2n should pair with 2n+1 */
 379
 380 #define ANYOF_ALNUM      0      /* \w, PL_utf8_alnum, utf8::IsWord, ALNUM */
 381 #define ANYOF_NALNUM     1
 382 #define ANYOF_SPACE      2      /* \s */
 383 #define ANYOF_NSPACE     3
 384 #define ANYOF_DIGIT      4      /* \d */
 385 #define ANYOF_NDIGIT     5
 386 #define ANYOF_ALNUMC     6      /* [[:alnum:]] isalnum(3), utf8::IsAlnum, ALNUMC */
 387 #define ANYOF_NALNUMC    7
 388 #define ANYOF_ALPHA      8
 389 #define ANYOF_NALPHA     9
 390 #define ANYOF_ASCII     10
 391 #define ANYOF_NASCII    11
 392 #define ANYOF_CNTRL     12
 393 #define ANYOF_NCNTRL    13
 394 #define ANYOF_GRAPH     14
 395 #define ANYOF_NGRAPH    15
 396 #define ANYOF_LOWER     16
 397 #define ANYOF_NLOWER    17
 398 #define ANYOF_PRINT     18
 399 #define ANYOF_NPRINT    19
 400 #define ANYOF_PUNCT     20
 401 #define ANYOF_NPUNCT    21
 402 #define ANYOF_UPPER     22
 403 #define ANYOF_NUPPER    23
 404 #define ANYOF_XDIGIT    24
 405 #define ANYOF_NXDIGIT   25
 406 #define ANYOF_PSXSPC    26      /* POSIX space: \s plus the vertical tab */
 407 #define ANYOF_NPSXSPC   27
 408 #define ANYOF_BLANK     28      /* GNU extension: space and tab: non-vertical space */
 409 #define ANYOF_NBLANK    29
 410
 411 #define ANYOF_MAX       32
 412
 413 /* pseudo classes, not stored in the class bitmap, but used as flags
 414    during compilation of char classes */
 415
 416 #define ANYOF_VERTWS    (ANYOF_MAX+1)
 417 #define ANYOF_NVERTWS   (ANYOF_MAX+2)
 418 #define ANYOF_HORIZWS   (ANYOF_MAX+3)
 419 #define ANYOF_NHORIZWS  (ANYOF_MAX+4)
 420
 421 /* Backward source code compatibility. */
 422
 423 #define ANYOF_ALNUML     ANYOF_ALNUM
 424 #define ANYOF_NALNUML    ANYOF_NALNUM
 425 #define ANYOF_SPACEL     ANYOF_SPACE
 426 #define ANYOF_NSPACEL    ANYOF_NSPACE
 427
 428 /* Utility macros for the bitmap and classes of ANYOF */
 429
 430 #define ANYOF_SIZE              (sizeof(struct regnode_charclass))
 431 #define ANYOF_CLASS_SIZE        (sizeof(struct regnode_charclass_class))
 432
 433 #define ANYOF_FLAGS(p)          ((p)->flags)
 434
 435 #define ANYOF_BIT(c)            (1 << ((c) & 7))
 436
 437 #define ANYOF_CLASS_BYTE(p, c)  (((struct regnode_charclass_class*)(p))->classflags[((c) >> 3) & 3])
 438 #define ANYOF_CLASS_SET(p, c)   (ANYOF_CLASS_BYTE(p, c) |=  ANYOF_BIT(c))
 439 #define ANYOF_CLASS_CLEAR(p, c) (ANYOF_CLASS_BYTE(p, c) &= ~ANYOF_BIT(c))
 440 #define ANYOF_CLASS_TEST(p, c)  (ANYOF_CLASS_BYTE(p, c) &   ANYOF_BIT(c))
 441
 442 #define ANYOF_CLASS_ZERO(ret)   Zero(((struct regnode_charclass_class*)(ret))->classflags, ANYOF_CLASSBITMAP_SIZE, char)
 443 #define ANYOF_CLASS_SETALL(ret)         \
 444         memset (((struct regnode_charclass_class*)(ret))->classflags, 255, ANYOF_CLASSBITMAP_SIZE)
 445 #define ANYOF_BITMAP_ZERO(ret)  Zero(((struct regnode_charclass*)(ret))->bitmap, ANYOF_BITMAP_SIZE, char)
 446
 447 #define ANYOF_BITMAP(p)         (((struct regnode_charclass*)(p))->bitmap)
 448 #define ANYOF_BITMAP_BYTE(p, c) (ANYOF_BITMAP(p)[(((U8)(c)) >> 3) & 31])
 449 #define ANYOF_BITMAP_SET(p, c)  (ANYOF_BITMAP_BYTE(p, c) |=  ANYOF_BIT(c))
 450 #define ANYOF_BITMAP_CLEAR(p,c) (ANYOF_BITMAP_BYTE(p, c) &= ~ANYOF_BIT(c))
 451 #define ANYOF_BITMAP_TEST(p, c) (ANYOF_BITMAP_BYTE(p, c) &   ANYOF_BIT(c))
 452
 453 #define ANYOF_BITMAP_SETALL(p)          \
 454         memset (ANYOF_BITMAP(p), 255, ANYOF_BITMAP_SIZE)
 455 #define ANYOF_BITMAP_CLEARALL(p)        \
 456         Zero (ANYOF_BITMAP(p), ANYOF_BITMAP_SIZE)
 457 /* Check that all 256 bits are all set.  Used in S_cl_is_anything()  */
 458 #define ANYOF_BITMAP_TESTALLSET(p)      /* Assumes sizeof(p) == 32 */     \
 459         memEQ (ANYOF_BITMAP(p), "\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377", ANYOF_BITMAP_SIZE)
 460
 461 #define ANYOF_SKIP              ((ANYOF_SIZE - 1)/sizeof(regnode))
 462 #define ANYOF_CLASS_SKIP        ((ANYOF_CLASS_SIZE - 1)/sizeof(regnode))
 463
 464 #if ANYOF_CLASSBITMAP_SIZE != 4
 465 #   error ANYOF_CLASSBITMAP_SIZE is expected to be 4
 466 #endif
 467 #define ANYOF_CLASS_TEST_ANY_SET(p) ((ANYOF_FLAGS(p) & ANYOF_CLASS)         \
 468         && memNE (((struct regnode_charclass_class*)(p))->classflags,       \
 469                     "\0\0\0\0", ANYOF_CLASSBITMAP_SIZE))
 470 /*#define ANYOF_CLASS_ADD_SKIP  (ANYOF_CLASS_SKIP - ANYOF_SKIP)
 471  * */
 472
 473
 474 /*
 475  * Utility definitions.
 476  */
 477 #ifndef CHARMASK
 478 #  define UCHARAT(p)    ((int)*(const U8*)(p))
 479 #else
 480 #  define UCHARAT(p)    ((int)*(p)&CHARMASK)
 481 #endif
 482
 483 #define EXTRA_SIZE(guy) ((sizeof(guy)-1)/sizeof(struct regnode))
 484
 485 #define REG_SEEN_ZERO_LEN       0x00000001
 486 #define REG_SEEN_LOOKBEHIND     0x00000002
 487 #define REG_SEEN_GPOS           0x00000004
 488 /* spare */
 489 #define REG_SEEN_CANY           0x00000010
 490 #define REG_SEEN_SANY           REG_SEEN_CANY /* src bckwrd cmpt */
 491 #define REG_SEEN_RECURSE        0x00000020
 492 #define REG_TOP_LEVEL_BRANCHES  0x00000040
 493 #define REG_SEEN_VERBARG        0x00000080
 494 #define REG_SEEN_CUTGROUP       0x00000100
 495 #define REG_SEEN_RUN_ON_COMMENT 0x00000200
 496 #define REG_SEEN_EXACTF_SHARP_S 0x00000400
 497
 498 START_EXTERN_C
 499
 500 #ifdef PLUGGABLE_RE_EXTENSION
 501 #include "re_nodes.h"
 502 #else
 503 #include "regnodes.h"
 504 #endif
 505
 506 #ifndef PLUGGABLE_RE_EXTENSION
 507 #ifndef DOINIT
 508 EXTCONST regexp_engine PL_core_reg_engine;
 509 #else /* DOINIT */
 510 EXTCONST regexp_engine PL_core_reg_engine = {
 511         Perl_re_compile,
 512         Perl_regexec_flags,
 513         Perl_re_intuit_start,
 514         Perl_re_intuit_string,
 515         Perl_regfree_internal,
 516         Perl_reg_numbered_buff_fetch,
 517         Perl_reg_numbered_buff_store,
 518         Perl_reg_numbered_buff_length,
 519         Perl_reg_named_buff,
 520         Perl_reg_named_buff_iter,
 521         Perl_reg_qr_package,
 522 #if defined(USE_ITHREADS)
 523         Perl_regdupe_internal,
 524 #endif
 525         Perl_re_op_compile
 526 };
 527 #endif /* DOINIT */
 528 #endif /* PLUGGABLE_RE_EXTENSION */
 529
 530
 531 END_EXTERN_C
 532
 533
 534 /* .what is a character array with one character for each member of .data
 535  * The character describes the function of the corresponding .data item:
 536  *   a - AV for paren_name_list under DEBUGGING
 537  *   f - start-class data for regstclass optimization
 538  *   l - start op for literal (?{EVAL}) item
 539  *   L - start op for literal (?{EVAL}) item, with separate CV (qr//)
 540  *   r - pointer to an embedded code-containing qr, e.g. /ab$qr/
 541  *   s - swash for Unicode-style character class, and the multicharacter
 542  *       strings resulting from casefolding the single-character entries
 543  *       in the character class
 544  *   t - trie struct
 545  *   u - trie struct's widecharmap (a HV, so can't share, must dup)
 546  *       also used for revcharmap and words under DEBUGGING
 547  *   T - aho-trie struct
 548  *   S - sv for named capture lookup
 549  * 20010712 mjd@plover.com
 550  * (Remember to update re_dup() and pregfree() if you add any items.)
 551  */
 552 struct reg_data {
 553     U32 count;
 554     U8 *what;
 555     void* data[1];
 556 };
 557
 558 /* Code in S_to_utf8_substr() and S_to_byte_substr() in regexec.c accesses
 559    anchored* and float* via array indexes 0 and 1.  */
 560 #define anchored_substr substrs->data[0].substr
 561 #define anchored_utf8 substrs->data[0].utf8_substr
 562 #define anchored_offset substrs->data[0].min_offset
 563 #define anchored_end_shift substrs->data[0].end_shift
 564
 565 #define float_substr substrs->data[1].substr
 566 #define float_utf8 substrs->data[1].utf8_substr
 567 #define float_min_offset substrs->data[1].min_offset
 568 #define float_max_offset substrs->data[1].max_offset
 569 #define float_end_shift substrs->data[1].end_shift
 570
 571 #define check_substr substrs->data[2].substr
 572 #define check_utf8 substrs->data[2].utf8_substr
 573 #define check_offset_min substrs->data[2].min_offset
 574 #define check_offset_max substrs->data[2].max_offset
 575 #define check_end_shift substrs->data[2].end_shift
 576
 577 #define RX_ANCHORED_SUBSTR(rx)  (((struct regexp *)SvANY(rx))->anchored_substr)
 578 #define RX_ANCHORED_UTF8(rx)    (((struct regexp *)SvANY(rx))->anchored_utf8)
 579 #define RX_FLOAT_SUBSTR(rx)     (((struct regexp *)SvANY(rx))->float_substr)
 580 #define RX_FLOAT_UTF8(rx)       (((struct regexp *)SvANY(rx))->float_utf8)
 581
 582 /* trie related stuff */
 583
 584 /* a transition record for the state machine. the
 585    check field determines which state "owns" the
 586    transition. the char the transition is for is
 587    determined by offset from the owning states base
 588    field.  the next field determines which state
 589    is to be transitioned to if any.
 590 */
 591 struct _reg_trie_trans {
 592   U32 next;
 593   U32 check;
 594 };
 595
 596 /* a transition list element for the list based representation */
 597 struct _reg_trie_trans_list_elem {
 598     U16 forid;
 599     U32 newstate;
 600 };
 601 typedef struct _reg_trie_trans_list_elem reg_trie_trans_le;
 602
 603 /* a state for compressed nodes. base is an offset
 604   into an array of reg_trie_trans array. If wordnum is
 605   nonzero the state is accepting. if base is zero then
 606   the state has no children (and will be accepting)
 607 */
 608 struct _reg_trie_state {
 609   U16 wordnum;
 610   union {
 611     U32                base;
 612     reg_trie_trans_le* list;
 613   } trans;
 614 };
 615
 616 /* info per word; indexed by wordnum */
 617 typedef struct {
 618     U16  prev;  /* previous word in acceptance chain; eg in
 619                  * zzz|abc|ab/ after matching the chars abc, the
 620                  * accepted word is #2, and the previous accepted
 621                  * word is #3 */
 622     U32 len;    /* how many chars long is this word? */
 623     U32 accept; /* accept state for this word */
 624 } reg_trie_wordinfo;
 625
 626
 627 typedef struct _reg_trie_state    reg_trie_state;
 628 typedef struct _reg_trie_trans    reg_trie_trans;
 629
 630
 631 /* anything in here that needs to be freed later
 632    should be dealt with in pregfree.
 633    refcount is first in both this and _reg_ac_data to allow a space
 634    optimisation in Perl_regdupe.  */
 635 struct _reg_trie_data {
 636     U32             refcount;        /* number of times this trie is referenced */
 637     U32             lasttrans;       /* last valid transition element */
 638     U16             *charmap;        /* byte to charid lookup array */
 639     reg_trie_state  *states;         /* state data */
 640     reg_trie_trans  *trans;          /* array of transition elements */
 641     char            *bitmap;         /* stclass bitmap */
 642     U16             *jump;           /* optional 1 indexed array of offsets before tail
 643                                         for the node following a given word. */
 644     reg_trie_wordinfo *wordinfo;     /* array of info per word */
 645     U16             uniquecharcount; /* unique chars in trie (width of trans table) */
 646     U32             startstate;      /* initial state - used for common prefix optimisation */
 647     STRLEN          minlen;          /* minimum length of words in trie - build/opt only? */
 648     STRLEN          maxlen;          /* maximum length of words in trie - build/opt only? */
 649     U32             prefixlen;       /* #chars in common prefix */
 650     U32             statecount;      /* Build only - number of states in the states array
 651                                         (including the unused zero state) */
 652     U32             wordcount;       /* Build only */
 653 #ifdef DEBUGGING
 654     STRLEN          charcount;       /* Build only */
 655 #endif
 656 };
 657 /* There is one (3 under DEBUGGING) pointers that logically belong in this
 658    structure, but are held outside as they need duplication on thread cloning,
 659    whereas the rest of the structure can be read only:
 660     HV              *widecharmap;    code points > 255 to charid
 661 #ifdef DEBUGGING
 662     AV              *words;          Array of words contained in trie, for dumping
 663     AV              *revcharmap;     Map of each charid back to its character representation
 664 #endif
 665 */
 666
 667 #define TRIE_WORDS_OFFSET 2
 668
 669 typedef struct _reg_trie_data reg_trie_data;
 670
 671 /* refcount is first in both this and _reg_trie_data to allow a space
 672    optimisation in Perl_regdupe.  */
 673 struct _reg_ac_data {
 674     U32              refcount;
 675     U32              trie;
 676     U32              *fail;
 677     reg_trie_state   *states;
 678 };
 679 typedef struct _reg_ac_data reg_ac_data;
 680
 681 /* ANY_BIT doesn't use the structure, so we can borrow it here.
 682    This is simpler than refactoring all of it as wed end up with
 683    three different sets... */
 684
 685 #define TRIE_BITMAP(p)          (((reg_trie_data *)(p))->bitmap)
 686 #define TRIE_BITMAP_BYTE(p, c)  (TRIE_BITMAP(p)[(((U8)(c)) >> 3) & 31])
 687 #define TRIE_BITMAP_SET(p, c)   (TRIE_BITMAP_BYTE(p, c) |=  ANYOF_BIT((U8)c))
 688 #define TRIE_BITMAP_CLEAR(p,c)  (TRIE_BITMAP_BYTE(p, c) &= ~ANYOF_BIT((U8)c))
 689 #define TRIE_BITMAP_TEST(p, c)  (TRIE_BITMAP_BYTE(p, c) &   ANYOF_BIT((U8)c))
 690
 691 #define IS_ANYOF_TRIE(op) ((op)==TRIEC || (op)==AHOCORASICKC)
 692 #define IS_TRIE_AC(op) ((op)>=AHOCORASICK)
 693
 694
 695 #define BITMAP_BYTE(p, c)       (((U8*)p)[(((U8)(c)) >> 3) & 31])
 696 #define BITMAP_TEST(p, c)       (BITMAP_BYTE(p, c) &   ANYOF_BIT((U8)c))
 697
 698 /* these defines assume uniquecharcount is the correct variable, and state may be evaluated twice */
 699 #define TRIE_NODENUM(state) (((state)-1)/(trie->uniquecharcount)+1)
 700 #define SAFE_TRIE_NODENUM(state) ((state) ? (((state)-1)/(trie->uniquecharcount)+1) : (state))
 701 #define TRIE_NODEIDX(state) ((state) ? (((state)-1)*(trie->uniquecharcount)+1) : (state))
 702
 703 #ifdef DEBUGGING
 704 #define TRIE_CHARCOUNT(trie) ((trie)->charcount)
 705 #else
 706 #define TRIE_CHARCOUNT(trie) (trie_charcount)
 707 #endif
 708
 709 #define RE_TRIE_MAXBUF_INIT 65536
 710 #define RE_TRIE_MAXBUF_NAME "\022E_TRIE_MAXBUF"
 711 #define RE_DEBUG_FLAGS "\022E_DEBUG_FLAGS"
 712
 713 /*
 714
 715 RE_DEBUG_FLAGS is used to control what debug output is emitted
 716 its divided into three groups of options, some of which interact.
 717 The three groups are: Compile, Execute, Extra. There is room for a
 718 further group, as currently only the low three bytes are used.
 719
 720     Compile Options:
 721
 722     PARSE
 723     PEEP
 724     TRIE
 725     PROGRAM
 726     OFFSETS
 727
 728     Execute Options:
 729
 730     INTUIT
 731     MATCH
 732     TRIE
 733
 734     Extra Options
 735
 736     TRIE
 737     OFFSETS
 738
 739 If you modify any of these make sure you make corresponding changes to
 740 re.pm, especially to the documentation.
 741
 742 */
 743
 744
 745 /* Compile */
 746 #define RE_DEBUG_COMPILE_MASK      0x0000FF
 747 #define RE_DEBUG_COMPILE_PARSE     0x000001
 748 #define RE_DEBUG_COMPILE_OPTIMISE  0x000002
 749 #define RE_DEBUG_COMPILE_TRIE      0x000004
 750 #define RE_DEBUG_COMPILE_DUMP      0x000008
 751 #define RE_DEBUG_COMPILE_FLAGS     0x000010
 752
 753 /* Execute */
 754 #define RE_DEBUG_EXECUTE_MASK      0x00FF00
 755 #define RE_DEBUG_EXECUTE_INTUIT    0x000100
 756 #define RE_DEBUG_EXECUTE_MATCH     0x000200
 757 #define RE_DEBUG_EXECUTE_TRIE      0x000400
 758
 759 /* Extra */
 760 #define RE_DEBUG_EXTRA_MASK        0xFF0000
 761 #define RE_DEBUG_EXTRA_TRIE        0x010000
 762 #define RE_DEBUG_EXTRA_OFFSETS     0x020000
 763 #define RE_DEBUG_EXTRA_OFFDEBUG    0x040000
 764 #define RE_DEBUG_EXTRA_STATE       0x080000
 765 #define RE_DEBUG_EXTRA_OPTIMISE    0x100000
 766 #define RE_DEBUG_EXTRA_BUFFERS     0x400000
 767 #define RE_DEBUG_EXTRA_GPOS        0x800000
 768 /* combined */
 769 #define RE_DEBUG_EXTRA_STACK       0x280000
 770
 771 #define RE_DEBUG_FLAG(x) (re_debug_flags & x)
 772 /* Compile */
 773 #define DEBUG_COMPILE_r(x) DEBUG_r( \
 774     if (re_debug_flags & RE_DEBUG_COMPILE_MASK) x  )
 775 #define DEBUG_PARSE_r(x) DEBUG_r( \
 776     if (re_debug_flags & RE_DEBUG_COMPILE_PARSE) x  )
 777 #define DEBUG_OPTIMISE_r(x) DEBUG_r( \
 778     if (re_debug_flags & RE_DEBUG_COMPILE_OPTIMISE) x  )
 779 #define DEBUG_PARSE_r(x) DEBUG_r( \
 780     if (re_debug_flags & RE_DEBUG_COMPILE_PARSE) x  )
 781 #define DEBUG_DUMP_r(x) DEBUG_r( \
 782     if (re_debug_flags & RE_DEBUG_COMPILE_DUMP) x  )
 783 #define DEBUG_TRIE_COMPILE_r(x) DEBUG_r( \
 784     if (re_debug_flags & RE_DEBUG_COMPILE_TRIE) x )
 785 #define DEBUG_FLAGS_r(x) DEBUG_r( \
 786     if (re_debug_flags & RE_DEBUG_COMPILE_FLAGS) x )
 787 /* Execute */
 788 #define DEBUG_EXECUTE_r(x) DEBUG_r( \
 789     if (re_debug_flags & RE_DEBUG_EXECUTE_MASK) x  )
 790 #define DEBUG_INTUIT_r(x) DEBUG_r( \
 791     if (re_debug_flags & RE_DEBUG_EXECUTE_INTUIT) x  )
 792 #define DEBUG_MATCH_r(x) DEBUG_r( \
 793     if (re_debug_flags & RE_DEBUG_EXECUTE_MATCH) x  )
 794 #define DEBUG_TRIE_EXECUTE_r(x) DEBUG_r( \
 795     if (re_debug_flags & RE_DEBUG_EXECUTE_TRIE) x )
 796
 797 /* Extra */
 798 #define DEBUG_EXTRA_r(x) DEBUG_r( \
 799     if (re_debug_flags & RE_DEBUG_EXTRA_MASK) x  )
 800 #define DEBUG_OFFSETS_r(x) DEBUG_r( \
 801     if (re_debug_flags & RE_DEBUG_EXTRA_OFFSETS) x  )
 802 #define DEBUG_STATE_r(x) DEBUG_r( \
 803     if (re_debug_flags & RE_DEBUG_EXTRA_STATE) x )
 804 #define DEBUG_STACK_r(x) DEBUG_r( \
 805     if (re_debug_flags & RE_DEBUG_EXTRA_STACK) x )
 806 #define DEBUG_BUFFERS_r(x) DEBUG_r( \
 807     if (re_debug_flags & RE_DEBUG_EXTRA_BUFFERS) x )
 808
 809 #define DEBUG_OPTIMISE_MORE_r(x) DEBUG_r( \
 810     if ((RE_DEBUG_EXTRA_OPTIMISE|RE_DEBUG_COMPILE_OPTIMISE) == \
 811          (re_debug_flags & (RE_DEBUG_EXTRA_OPTIMISE|RE_DEBUG_COMPILE_OPTIMISE)) ) x )
 812 #define MJD_OFFSET_DEBUG(x) DEBUG_r( \
 813     if (re_debug_flags & RE_DEBUG_EXTRA_OFFDEBUG) \
 814         Perl_warn_nocontext x )
 815 #define DEBUG_TRIE_COMPILE_MORE_r(x) DEBUG_TRIE_COMPILE_r( \
 816     if (re_debug_flags & RE_DEBUG_EXTRA_TRIE) x )
 817 #define DEBUG_TRIE_EXECUTE_MORE_r(x) DEBUG_TRIE_EXECUTE_r( \
 818     if (re_debug_flags & RE_DEBUG_EXTRA_TRIE) x )
 819
 820 #define DEBUG_TRIE_r(x) DEBUG_r( \
 821     if (re_debug_flags & (RE_DEBUG_COMPILE_TRIE \
 822         | RE_DEBUG_EXECUTE_TRIE )) x )
 823 #define DEBUG_GPOS_r(x) DEBUG_r( \
 824     if (re_debug_flags & RE_DEBUG_EXTRA_GPOS) x )
 825
 826 /* initialization */
 827 /* get_sv() can return NULL during global destruction.  re_debug_flags can get
 828  * clobbered by a longjmp, so must be initialized */
 829 #define GET_RE_DEBUG_FLAGS DEBUG_r({ \
 830         SV * re_debug_flags_sv = NULL; \
 831         re_debug_flags = 0;            \
 832         re_debug_flags_sv = get_sv(RE_DEBUG_FLAGS, 1); \
 833         if (re_debug_flags_sv) { \
 834             if (!SvIOK(re_debug_flags_sv)) \
 835                 sv_setuv(re_debug_flags_sv, RE_DEBUG_COMPILE_DUMP | RE_DEBUG_EXECUTE_MASK ); \
 836             re_debug_flags=SvIV(re_debug_flags_sv); \
 837         }\
 838 })
 839
 840 #ifdef DEBUGGING
 841
 842 #define GET_RE_DEBUG_FLAGS_DECL VOL IV re_debug_flags \
 843         PERL_UNUSED_DECL = 0; GET_RE_DEBUG_FLAGS;
 844
 845 #define RE_PV_COLOR_DECL(rpv,rlen,isuni,dsv,pv,l,m,c1,c2) \
 846     const char * const rpv =                          \
 847         pv_pretty((dsv), (pv), (l), (m), \
 848             PL_colors[(c1)],PL_colors[(c2)], \
 849             PERL_PV_ESCAPE_RE|PERL_PV_ESCAPE_NONASCII |((isuni) ? PERL_PV_ESCAPE_UNI : 0) );         \
 850     const int rlen = SvCUR(dsv)
 851
 852 #define RE_SV_ESCAPE(rpv,isuni,dsv,sv,m) \
 853     const char * const rpv =                          \
 854         pv_pretty((dsv), (SvPV_nolen_const(sv)), (SvCUR(sv)), (m), \
 855             PL_colors[(c1)],PL_colors[(c2)], \
 856             PERL_PV_ESCAPE_RE|PERL_PV_ESCAPE_NONASCII |((isuni) ? PERL_PV_ESCAPE_UNI : 0) )
 857
 858 #define RE_PV_QUOTED_DECL(rpv,isuni,dsv,pv,l,m)                    \
 859     const char * const rpv =                                       \
 860         pv_pretty((dsv), (pv), (l), (m), \
 861             PL_colors[0], PL_colors[1], \
 862             ( PERL_PV_PRETTY_QUOTE | PERL_PV_ESCAPE_RE | PERL_PV_ESCAPE_NONASCII | PERL_PV_PRETTY_ELLIPSES | \
 863               ((isuni) ? PERL_PV_ESCAPE_UNI : 0))                  \
 864         )
 865
 866 #define RE_SV_DUMPLEN(ItEm) (SvCUR(ItEm) - (SvTAIL(ItEm)!=0))
 867 #define RE_SV_TAIL(ItEm) (SvTAIL(ItEm) ? "$" : "")
 868
 869 #else /* if not DEBUGGING */
 870
 871 #define GET_RE_DEBUG_FLAGS_DECL
 872 #define RE_PV_COLOR_DECL(rpv,rlen,isuni,dsv,pv,l,m,c1,c2)
 873 #define RE_SV_ESCAPE(rpv,isuni,dsv,sv,m)
 874 #define RE_PV_QUOTED_DECL(rpv,isuni,dsv,pv,l,m)
 875 #define RE_SV_DUMPLEN(ItEm)
 876 #define RE_SV_TAIL(ItEm)
 877
 878 #endif /* DEBUG RELATED DEFINES */
 879
 880 /*
 881  * Local variables:
 882  * c-indentation-style: bsd
 883  * c-basic-offset: 4
 884  * indent-tabs-mode: nil
 885  * End:
 886  *
 887  * ex: set ts=8 sts=4 sw=4 et:
 888  */