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