regcomp.h

   1 /*    regcomp.h
   2  *
   3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
   4  *    2000, 2001, 2002, 2003, 2005 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
  11 typedef OP OP_4tree;                    /* Will be redefined later. */
  12
  13
  14 /* Convert branch sequences to more efficient trie ops? */
  15 #define PERL_ENABLE_TRIE_OPTIMISATION 1
  16
  17 /* Be really agressive about optimising patterns with trie sequences? */
  18 #define PERL_ENABLE_EXTENDED_TRIE_OPTIMISATION 1
  19
  20 /* Should the optimiser take positive assertions into account? */
  21 #define PERL_ENABLE_POSITIVE_ASSERTION_STUDY 1
  22
  23 /* Not for production use: */
  24 #define PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS 0
  25
  26 /* Unless the next line is uncommented it is illegal to combine lazy
  27    matching with possessive matching. Frankly it doesn't make much sense
  28    to allow it as X*?+ matches nothing, X+?+ matches a single char only,
  29    and X{min,max}?+ matches min times only.
  30  */
  31 /* #define REG_ALLOW_MINMOD_SUSPEND */
  32
  33 /*
  34  * The "internal use only" fields in regexp.h are present to pass info from
  35  * compile to execute that permits the execute phase to run lots faster on
  36  * simple cases.  They are:
  37  *
  38  * regstart     sv that must begin a match; NULL if none obvious
  39  * reganch      is the match anchored (at beginning-of-line only)?
  40  * regmust      string (pointer into program) that match must include, or NULL
  41  *  [regmust changed to SV* for bminstr()--law]
  42  * regmlen      length of regmust string
  43  *  [regmlen not used currently]
  44  *
  45  * Regstart and reganch permit very fast decisions on suitable starting points
  46  * for a match, cutting down the work a lot.  Regmust permits fast rejection
  47  * of lines that cannot possibly match.  The regmust tests are costly enough
  48  * that pregcomp() supplies a regmust only if the r.e. contains something
  49  * potentially expensive (at present, the only such thing detected is * or +
  50  * at the start of the r.e., which can involve a lot of backup).  Regmlen is
  51  * supplied because the test in pregexec() needs it and pregcomp() is computing
  52  * it anyway.
  53  * [regmust is now supplied always.  The tests that use regmust have a
  54  * heuristic that disables the test if it usually matches.]
  55  *
  56  * [In fact, we now use regmust in many cases to locate where the search
  57  * starts in the string, so if regback is >= 0, the regmust search is never
  58  * wasted effort.  The regback variable says how many characters back from
  59  * where regmust matched is the earliest possible start of the match.
  60  * For instance, /[a-z].foo/ has a regmust of 'foo' and a regback of 2.]
  61  */
  62
  63 /*
  64  * Structure for regexp "program".  This is essentially a linear encoding
  65  * of a nondeterministic finite-state machine (aka syntax charts or
  66  * "railroad normal form" in parsing technology).  Each node is an opcode
  67  * plus a "next" pointer, possibly plus an operand.  "Next" pointers of
  68  * all nodes except BRANCH implement concatenation; a "next" pointer with
  69  * a BRANCH on both ends of it is connecting two alternatives.  (Here we
  70  * have one of the subtle syntax dependencies:  an individual BRANCH (as
  71  * opposed to a collection of them) is never concatenated with anything
  72  * because of operator precedence.)  The operand of some types of node is
  73  * a literal string; for others, it is a node leading into a sub-FSM.  In
  74  * particular, the operand of a BRANCH node is the first node of the branch.
  75  * (NB this is *not* a tree structure:  the tail of the branch connects
  76  * to the thing following the set of BRANCHes.)  The opcodes are defined
  77  * in regnodes.h which is generated from regcomp.sym by regcomp.pl.
  78  */
  79
  80 /*
  81  * A node is one char of opcode followed by two chars of "next" pointer.
  82  * "Next" pointers are stored as two 8-bit pieces, high order first.  The
  83  * value is a positive offset from the opcode of the node containing it.
  84  * An operand, if any, simply follows the node.  (Note that much of the
  85  * code generation knows about this implicit relationship.)
  86  *
  87  * Using two bytes for the "next" pointer is vast overkill for most things,
  88  * but allows patterns to get big without disasters.
  89  *
  90  * [The "next" pointer is always aligned on an even
  91  * boundary, and reads the offset directly as a short.  Also, there is no
  92  * special test to reverse the sign of BACK pointers since the offset is
  93  * stored negative.]
  94  */
  95 typedef struct regexp_internal {
  96         regexp_paren_ofs *swap; /* Swap copy of *startp / *endp */
  97         U32 *offsets;           /* offset annotations 20001228 MJD
  98                                    data about mapping the program to the
  99                                    string*/
 100         regnode *regstclass;    /* Optional startclass as identified or constructed
 101                                    by the optimiser */
 102         struct reg_data *data;  /* Additional miscellaneous data used by the program.
 103                                    Used to make it easier to clone and free arbitrary
 104                                    data that the regops need. Often the ARG field of
 105                                    a regop is an index into this structure */
 106         regnode program[1];     /* Unwarranted chumminess with compiler. */
 107 } regexp_internal;
 108
 109 #define RXi_SET(x,y) (x)->pprivate = (void*)(y)
 110 #define RXi_GET(x)   ((regexp_internal *)((x)->pprivate))
 111 #define RXi_GET_DECL(r,ri) regexp_internal *ri = RXi_GET(r)
 112
 113 struct regnode_string {
 114     U8  str_len;
 115     U8  type;
 116     U16 next_off;
 117     char string[1];
 118 };
 119
 120 /* Argument bearing node - workhorse,
 121    arg1 is often for the data field */
 122 struct regnode_1 {
 123     U8  flags;
 124     U8  type;
 125     U16 next_off;
 126     U32 arg1;
 127 };
 128
 129 /* Similar to a regnode_1 but with an extra signed argument */
 130 struct regnode_2L {
 131     U8  flags;
 132     U8  type;
 133     U16 next_off;
 134     U32 arg1;
 135     I32 arg2;
 136 };
 137
 138 /* 'Two field' -- Two 16 bit unsigned args */
 139 struct regnode_2 {
 140     U8  flags;
 141     U8  type;
 142     U16 next_off;
 143     U16 arg1;
 144     U16 arg2;
 145 };
 146
 147
 148 #define ANYOF_BITMAP_SIZE       32      /* 256 b/(8 b/B) */
 149 #define ANYOF_CLASSBITMAP_SIZE   4      /* up to 32 (8*4) named classes */
 150
 151 /* also used by trie */
 152 struct regnode_charclass {
 153     U8  flags;
 154     U8  type;
 155     U16 next_off;
 156     U32 arg1;
 157     char bitmap[ANYOF_BITMAP_SIZE];     /* only compile-time */
 158 };
 159
 160 struct regnode_charclass_class {        /* has [[:blah:]] classes */
 161     U8  flags;                          /* should have ANYOF_CLASS here */
 162     U8  type;
 163     U16 next_off;
 164     U32 arg1;
 165     char bitmap[ANYOF_BITMAP_SIZE];             /* both compile-time */
 166     char classflags[ANYOF_CLASSBITMAP_SIZE];    /* and run-time */
 167 };
 168
 169 /* XXX fix this description.
 170    Impose a limit of REG_INFTY on various pattern matching operations
 171    to limit stack growth and to avoid "infinite" recursions.
 172 */
 173 /* The default size for REG_INFTY is I16_MAX, which is the same as
 174    SHORT_MAX (see perl.h).  Unfortunately I16 isn't necessarily 16 bits
 175    (see handy.h).  On the Cray C90, sizeof(short)==4 and hence I16_MAX is
 176    ((1<<31)-1), while on the Cray T90, sizeof(short)==8 and I16_MAX is
 177    ((1<<63)-1).  To limit stack growth to reasonable sizes, supply a
 178    smaller default.
 179         --Andy Dougherty  11 June 1998
 180 */
 181 #if SHORTSIZE > 2
 182 #  ifndef REG_INFTY
 183 #    define REG_INFTY ((1<<15)-1)
 184 #  endif
 185 #endif
 186
 187 #ifndef REG_INFTY
 188 #  define REG_INFTY I16_MAX
 189 #endif
 190
 191 #define ARG_VALUE(arg) (arg)
 192 #define ARG__SET(arg,val) ((arg) = (val))
 193
 194 #undef ARG
 195 #undef ARG1
 196 #undef ARG2
 197
 198 #define ARG(p) ARG_VALUE(ARG_LOC(p))
 199 #define ARG1(p) ARG_VALUE(ARG1_LOC(p))
 200 #define ARG2(p) ARG_VALUE(ARG2_LOC(p))
 201 #define ARG2L(p) ARG_VALUE(ARG2L_LOC(p))
 202
 203 #define ARG_SET(p, val) ARG__SET(ARG_LOC(p), (val))
 204 #define ARG1_SET(p, val) ARG__SET(ARG1_LOC(p), (val))
 205 #define ARG2_SET(p, val) ARG__SET(ARG2_LOC(p), (val))
 206 #define ARG2L_SET(p, val) ARG__SET(ARG2L_LOC(p), (val))
 207
 208 #undef NEXT_OFF
 209 #undef NODE_ALIGN
 210
 211 #define NEXT_OFF(p) ((p)->next_off)
 212 #define NODE_ALIGN(node)
 213 #define NODE_ALIGN_FILL(node) ((node)->flags = 0xde) /* deadbeef */
 214
 215 #define SIZE_ALIGN NODE_ALIGN
 216
 217 #undef OP
 218 #undef OPERAND
 219 #undef MASK
 220 #undef STRING
 221
 222 #define OP(p)           ((p)->type)
 223 #define OPERAND(p)      (((struct regnode_string *)p)->string)
 224 #define MASK(p)         ((char*)OPERAND(p))
 225 #define STR_LEN(p)      (((struct regnode_string *)p)->str_len)
 226 #define STRING(p)       (((struct regnode_string *)p)->string)
 227 #define STR_SZ(l)       ((l + sizeof(regnode) - 1) / sizeof(regnode))
 228 #define NODE_SZ_STR(p)  (STR_SZ(STR_LEN(p))+1)
 229
 230 #undef NODE_ALIGN
 231 #undef ARG_LOC
 232 #undef NEXTOPER
 233 #undef PREVOPER
 234
 235 #define NODE_ALIGN(node)
 236 #define ARG_LOC(p)      (((struct regnode_1 *)p)->arg1)
 237 #define ARG1_LOC(p)     (((struct regnode_2 *)p)->arg1)
 238 #define ARG2_LOC(p)     (((struct regnode_2 *)p)->arg2)
 239 #define ARG2L_LOC(p)    (((struct regnode_2L *)p)->arg2)
 240
 241 #define NODE_STEP_REGNODE       1       /* sizeof(regnode)/sizeof(regnode) */
 242 #define EXTRA_STEP_2ARGS        EXTRA_SIZE(struct regnode_2)
 243
 244 #define NODE_STEP_B     4
 245
 246 #define NEXTOPER(p)     ((p) + NODE_STEP_REGNODE)
 247 #define PREVOPER(p)     ((p) - NODE_STEP_REGNODE)
 248
 249 #define FILL_ADVANCE_NODE(ptr, op) STMT_START { \
 250     (ptr)->type = op;    (ptr)->next_off = 0;   (ptr)++; } STMT_END
 251 #define FILL_ADVANCE_NODE_ARG(ptr, op, arg) STMT_START { \
 252     ARG_SET(ptr, arg);  FILL_ADVANCE_NODE(ptr, op); (ptr) += 1; } STMT_END
 253
 254 #define REG_MAGIC 0234
 255
 256 #define SIZE_ONLY (RExC_emit == &PL_regdummy)
 257
 258 /* Flags for node->flags of ANYOF */
 259
 260 #define ANYOF_CLASS             0x08    /* has [[:blah:]] classes */
 261 #define ANYOF_INVERT            0x04
 262 #define ANYOF_FOLD              0x02
 263 #define ANYOF_LOCALE            0x01
 264
 265 /* Used for regstclass only */
 266 #define ANYOF_EOS               0x10            /* Can match an empty string too */
 267
 268 /* There is a character or a range past 0xff */
 269 #define ANYOF_UNICODE           0x20
 270 #define ANYOF_UNICODE_ALL       0x40    /* Can match any char past 0xff */
 271
 272 /* size of node is large (includes class pointer) */
 273 #define ANYOF_LARGE             0x80
 274
 275 /* Are there any runtime flags on in this node? */
 276 #define ANYOF_RUNTIME(s)        (ANYOF_FLAGS(s) & 0x0f)
 277
 278 #define ANYOF_FLAGS_ALL         0xff
 279
 280 /* Character classes for node->classflags of ANYOF */
 281 /* Should be synchronized with a table in regprop() */
 282 /* 2n should pair with 2n+1 */
 283
 284 #define ANYOF_ALNUM      0      /* \w, PL_utf8_alnum, utf8::IsWord, ALNUM */
 285 #define ANYOF_NALNUM     1
 286 #define ANYOF_SPACE      2      /* \s */
 287 #define ANYOF_NSPACE     3
 288 #define ANYOF_DIGIT      4
 289 #define ANYOF_NDIGIT     5
 290 #define ANYOF_ALNUMC     6      /* isalnum(3), utf8::IsAlnum, ALNUMC */
 291 #define ANYOF_NALNUMC    7
 292 #define ANYOF_ALPHA      8
 293 #define ANYOF_NALPHA     9
 294 #define ANYOF_ASCII     10
 295 #define ANYOF_NASCII    11
 296 #define ANYOF_CNTRL     12
 297 #define ANYOF_NCNTRL    13
 298 #define ANYOF_GRAPH     14
 299 #define ANYOF_NGRAPH    15
 300 #define ANYOF_LOWER     16
 301 #define ANYOF_NLOWER    17
 302 #define ANYOF_PRINT     18
 303 #define ANYOF_NPRINT    19
 304 #define ANYOF_PUNCT     20
 305 #define ANYOF_NPUNCT    21
 306 #define ANYOF_UPPER     22
 307 #define ANYOF_NUPPER    23
 308 #define ANYOF_XDIGIT    24
 309 #define ANYOF_NXDIGIT   25
 310 #define ANYOF_PSXSPC    26      /* POSIX space: \s plus the vertical tab */
 311 #define ANYOF_NPSXSPC   27
 312 #define ANYOF_BLANK     28      /* GNU extension: space and tab: non-vertical space */
 313 #define ANYOF_NBLANK    29
 314
 315 #define ANYOF_MAX       32
 316
 317 /* Backward source code compatibility. */
 318
 319 #define ANYOF_ALNUML     ANYOF_ALNUM
 320 #define ANYOF_NALNUML    ANYOF_NALNUM
 321 #define ANYOF_SPACEL     ANYOF_SPACE
 322 #define ANYOF_NSPACEL    ANYOF_NSPACE
 323
 324 /* Utility macros for the bitmap and classes of ANYOF */
 325
 326 #define ANYOF_SIZE              (sizeof(struct regnode_charclass))
 327 #define ANYOF_CLASS_SIZE        (sizeof(struct regnode_charclass_class))
 328
 329 #define ANYOF_FLAGS(p)          ((p)->flags)
 330
 331 #define ANYOF_BIT(c)            (1 << ((c) & 7))
 332
 333 #define ANYOF_CLASS_BYTE(p, c)  (((struct regnode_charclass_class*)(p))->classflags[((c) >> 3) & 3])
 334 #define ANYOF_CLASS_SET(p, c)   (ANYOF_CLASS_BYTE(p, c) |=  ANYOF_BIT(c))
 335 #define ANYOF_CLASS_CLEAR(p, c) (ANYOF_CLASS_BYTE(p, c) &= ~ANYOF_BIT(c))
 336 #define ANYOF_CLASS_TEST(p, c)  (ANYOF_CLASS_BYTE(p, c) &   ANYOF_BIT(c))
 337
 338 #define ANYOF_CLASS_ZERO(ret)   Zero(((struct regnode_charclass_class*)(ret))->classflags, ANYOF_CLASSBITMAP_SIZE, char)
 339 #define ANYOF_BITMAP_ZERO(ret)  Zero(((struct regnode_charclass*)(ret))->bitmap, ANYOF_BITMAP_SIZE, char)
 340
 341 #define ANYOF_BITMAP(p)         (((struct regnode_charclass*)(p))->bitmap)
 342 #define ANYOF_BITMAP_BYTE(p, c) (ANYOF_BITMAP(p)[(((U8)(c)) >> 3) & 31])
 343 #define ANYOF_BITMAP_SET(p, c)  (ANYOF_BITMAP_BYTE(p, c) |=  ANYOF_BIT(c))
 344 #define ANYOF_BITMAP_CLEAR(p,c) (ANYOF_BITMAP_BYTE(p, c) &= ~ANYOF_BIT(c))
 345 #define ANYOF_BITMAP_TEST(p, c) (ANYOF_BITMAP_BYTE(p, c) &   ANYOF_BIT(c))
 346
 347 #define ANYOF_BITMAP_SETALL(p)          \
 348         memset (ANYOF_BITMAP(p), 255, ANYOF_BITMAP_SIZE)
 349 #define ANYOF_BITMAP_CLEARALL(p)        \
 350         Zero (ANYOF_BITMAP(p), ANYOF_BITMAP_SIZE)
 351 /* Check that all 256 bits are all set.  Used in S_cl_is_anything()  */
 352 #define ANYOF_BITMAP_TESTALLSET(p)      \
 353         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)
 354
 355 #define ANYOF_SKIP              ((ANYOF_SIZE - 1)/sizeof(regnode))
 356 #define ANYOF_CLASS_SKIP        ((ANYOF_CLASS_SIZE - 1)/sizeof(regnode))
 357 #define ANYOF_CLASS_ADD_SKIP    (ANYOF_CLASS_SKIP - ANYOF_SKIP)
 358
 359
 360 /*
 361  * Utility definitions.
 362  */
 363 #ifndef CHARMASK
 364 #  define UCHARAT(p)    ((int)*(const U8*)(p))
 365 #else
 366 #  define UCHARAT(p)    ((int)*(p)&CHARMASK)
 367 #endif
 368
 369 #define EXTRA_SIZE(guy) ((sizeof(guy)-1)/sizeof(struct regnode))
 370
 371 #define REG_SEEN_ZERO_LEN       0x00000001
 372 #define REG_SEEN_LOOKBEHIND     0x00000002
 373 #define REG_SEEN_GPOS           0x00000004
 374 #define REG_SEEN_EVAL           0x00000008
 375 #define REG_SEEN_CANY           0x00000010
 376 #define REG_SEEN_SANY           REG_SEEN_CANY /* src bckwrd cmpt */
 377 #define REG_SEEN_RECURSE        0x00000020
 378 #define REG_TOP_LEVEL_BRANCHES  0x00000040
 379 #define REG_SEEN_VERBARG        0x00000080
 380 #define REG_SEEN_CUTGROUP       0x00000100
 381
 382 START_EXTERN_C
 383
 384 #ifdef PLUGGABLE_RE_EXTENSION
 385 #include "re_nodes.h"
 386 #else
 387 #include "regnodes.h"
 388 #endif
 389
 390 /* The following have no fixed length. U8 so we can do strchr() on it. */
 391 #ifndef DOINIT
 392 EXTCONST U8 PL_varies[];
 393 #else
 394 EXTCONST U8 PL_varies[] = {
 395     BRANCH, BACK, STAR, PLUS, CURLY, CURLYX, REF, REFF, REFFL,
 396     WHILEM, CURLYM, CURLYN, BRANCHJ, IFTHEN, SUSPEND, CLUMP,
 397     NREF, NREFF, NREFFL,
 398     0
 399 };
 400 #endif
 401
 402 /* The following always have a length of 1. U8 we can do strchr() on it. */
 403 /* (Note that length 1 means "one character" under UTF8, not "one octet".) */
 404 #ifndef DOINIT
 405 EXTCONST U8 PL_simple[];
 406 #else
 407 EXTCONST U8 PL_simple[] = {
 408     REG_ANY,    SANY,   CANY,
 409     ANYOF,
 410     ALNUM,      ALNUML,
 411     NALNUM,     NALNUML,
 412     SPACE,      SPACEL,
 413     NSPACE,     NSPACEL,
 414     DIGIT,      NDIGIT,
 415     0
 416 };
 417 #endif
 418
 419 #ifndef PLUGGABLE_RE_EXTENSION
 420 #ifndef DOINIT
 421 EXTCONST regexp_engine PL_core_reg_engine;
 422 #else /* DOINIT */
 423 EXTCONST regexp_engine PL_core_reg_engine = {
 424         Perl_re_compile,
 425         Perl_regexec_flags,
 426         Perl_re_intuit_start,
 427         Perl_re_intuit_string,
 428         Perl_regfree_internal,
 429 #if defined(USE_ITHREADS)
 430         Perl_regdupe_internal
 431 #endif
 432 };
 433 #endif /* DOINIT */
 434 #endif /* PLUGGABLE_RE_EXTENSION */
 435
 436
 437 END_EXTERN_C
 438
 439
 440 /* .what is a character array with one character for each member of .data
 441  * The character describes the function of the corresponding .data item:
 442  *   f - start-class data for regstclass optimization
 443  *   n - Root of op tree for (?{EVAL}) item
 444  *   o - Start op for (?{EVAL}) item
 445  *   p - Pad for (?{EVAL}) item
 446  *   s - swash for unicode-style character class, and the multicharacter
 447  *       strings resulting from casefolding the single-character entries
 448  *       in the character class
 449  *   t - trie struct
 450  *   u - trie struct's widecharmap (a HV, so can't share, must dup)
 451  *       also used for revcharmap and words under DEBUGGING
 452  *   T - aho-trie struct
 453  *   S - sv for named capture lookup
 454  * 20010712 mjd@plover.com
 455  * (Remember to update re_dup() and pregfree() if you add any items.)
 456  */
 457 struct reg_data {
 458     U32 count;
 459     U8 *what;
 460     void* data[1];
 461 };
 462
 463 struct reg_substr_datum {
 464     I32 min_offset;
 465     I32 max_offset;
 466     SV *substr;         /* non-utf8 variant */
 467     SV *utf8_substr;    /* utf8 variant */
 468     I32 end_shift;
 469 };
 470
 471 struct reg_substr_data {
 472     struct reg_substr_datum data[3];    /* Actual array */
 473 };
 474
 475 #define anchored_substr substrs->data[0].substr
 476 #define anchored_utf8 substrs->data[0].utf8_substr
 477 #define anchored_offset substrs->data[0].min_offset
 478 #define anchored_end_shift substrs->data[0].end_shift
 479
 480 #define float_substr substrs->data[1].substr
 481 #define float_utf8 substrs->data[1].utf8_substr
 482 #define float_min_offset substrs->data[1].min_offset
 483 #define float_max_offset substrs->data[1].max_offset
 484 #define float_end_shift substrs->data[1].end_shift
 485
 486 #define check_substr substrs->data[2].substr
 487 #define check_utf8 substrs->data[2].utf8_substr
 488 #define check_offset_min substrs->data[2].min_offset
 489 #define check_offset_max substrs->data[2].max_offset
 490 #define check_end_shift substrs->data[2].end_shift
 491
 492
 493
 494 /* trie related stuff */
 495
 496 /* a transition record for the state machine. the
 497    check field determines which state "owns" the
 498    transition. the char the transition is for is
 499    determined by offset from the owning states base
 500    field.  the next field determines which state
 501    is to be transitioned to if any.
 502 */
 503 struct _reg_trie_trans {
 504   U32 next;
 505   U32 check;
 506 };
 507
 508 /* a transition list element for the list based representation */
 509 struct _reg_trie_trans_list_elem {
 510     U16 forid;
 511     U32 newstate;
 512 };
 513 typedef struct _reg_trie_trans_list_elem reg_trie_trans_le;
 514
 515 /* a state for compressed nodes. base is an offset
 516   into an array of reg_trie_trans array. If wordnum is
 517   nonzero the state is accepting. if base is zero then
 518   the state has no children (and will be accepting)
 519 */
 520 struct _reg_trie_state {
 521   U16 wordnum;
 522   union {
 523     U32                base;
 524     reg_trie_trans_le* list;
 525   } trans;
 526 };
 527
 528
 529
 530 typedef struct _reg_trie_state    reg_trie_state;
 531 typedef struct _reg_trie_trans    reg_trie_trans;
 532
 533
 534 /* anything in here that needs to be freed later
 535    should be dealt with in pregfree.
 536    refcount is first in both this and _reg_ac_data to allow a space
 537    optimisation in Perl_regdupe.  */
 538 struct _reg_trie_data {
 539     U32             refcount;        /* number of times this trie is referenced */
 540     U16             uniquecharcount; /* unique chars in trie (width of trans table) */
 541     U32             lasttrans;       /* last valid transition element */
 542     U16             *charmap;        /* byte to charid lookup array */
 543     reg_trie_state  *states;         /* state data */
 544     reg_trie_trans  *trans;          /* array of transition elements */
 545     char            *bitmap;         /* stclass bitmap */
 546     U32             startstate;      /* initial state - used for common prefix optimisation */
 547     STRLEN          minlen;          /* minimum length of words in trie - build/opt only? */
 548     STRLEN          maxlen;          /* maximum length of words in trie - build/opt only? */
 549     U32             *wordlen;        /* array of lengths of words */
 550     U16             *jump;           /* optional 1 indexed array of offsets before tail
 551                                         for the node following a given word. */
 552     U16             *nextword;       /* optional 1 indexed array to support linked list
 553                                         of duplicate wordnums */
 554     U32             statecount;      /* Build only - number of states in the states array
 555                                         (including the unused zero state) */
 556     U32             wordcount;       /* Build only */
 557 #ifdef DEBUGGING
 558     STRLEN          charcount;       /* Build only */
 559 #endif
 560 };
 561 /* There is one (3 under DEBUGGING) pointers that logically belong in this
 562    structure, but are held outside as they need duplication on thread cloning,
 563    whereas the rest of the structure can be read only:
 564     HV              *widecharmap;    code points > 255 to charid
 565 #ifdef DEBUGGING
 566     AV              *words;          Array of words contained in trie, for dumping
 567     AV              *revcharmap;     Map of each charid back to its character representation
 568 #endif
 569 */
 570
 571 #define TRIE_WORDS_OFFSET 2
 572
 573 typedef struct _reg_trie_data reg_trie_data;
 574
 575 /* refcount is first in both this and _reg_trie_data to allow a space
 576    optimisation in Perl_regdupe.  */
 577 struct _reg_ac_data {
 578     U32              refcount;
 579     U32              *fail;
 580     reg_trie_state   *states;
 581     U32              trie;
 582 };
 583 typedef struct _reg_ac_data reg_ac_data;
 584
 585 /* ANY_BIT doesnt use the structure, so we can borrow it here.
 586    This is simpler than refactoring all of it as wed end up with
 587    three different sets... */
 588
 589 #define TRIE_BITMAP(p)          (((reg_trie_data *)(p))->bitmap)
 590 #define TRIE_BITMAP_BYTE(p, c)  (TRIE_BITMAP(p)[(((U8)(c)) >> 3) & 31])
 591 #define TRIE_BITMAP_SET(p, c)   (TRIE_BITMAP_BYTE(p, c) |=  ANYOF_BIT((U8)c))
 592 #define TRIE_BITMAP_CLEAR(p,c)  (TRIE_BITMAP_BYTE(p, c) &= ~ANYOF_BIT((U8)c))
 593 #define TRIE_BITMAP_TEST(p, c)  (TRIE_BITMAP_BYTE(p, c) &   ANYOF_BIT((U8)c))
 594
 595 #define IS_ANYOF_TRIE(op) ((op)==TRIEC || (op)==AHOCORASICKC)
 596 #define IS_TRIE_AC(op) ((op)>=AHOCORASICK)
 597
 598
 599 #define BITMAP_BYTE(p, c)       (((U8*)p)[(((U8)(c)) >> 3) & 31])
 600 #define BITMAP_TEST(p, c)       (BITMAP_BYTE(p, c) &   ANYOF_BIT((U8)c))
 601
 602 /* these defines assume uniquecharcount is the correct variable, and state may be evaluated twice */
 603 #define TRIE_NODENUM(state) (((state)-1)/(trie->uniquecharcount)+1)
 604 #define SAFE_TRIE_NODENUM(state) ((state) ? (((state)-1)/(trie->uniquecharcount)+1) : (state))
 605 #define TRIE_NODEIDX(state) ((state) ? (((state)-1)*(trie->uniquecharcount)+1) : (state))
 606
 607 #ifdef DEBUGGING
 608 #define TRIE_CHARCOUNT(trie) ((trie)->charcount)
 609 #else
 610 #define TRIE_CHARCOUNT(trie) (trie_charcount)
 611 #endif
 612
 613 #define RE_TRIE_MAXBUF_INIT 65536
 614 #define RE_TRIE_MAXBUF_NAME "\022E_TRIE_MAXBUF"
 615 #define RE_DEBUG_FLAGS "\022E_DEBUG_FLAGS"
 616
 617 /*
 618
 619 RE_DEBUG_FLAGS is used to control what debug output is emitted
 620 its divided into three groups of options, some of which interact.
 621 The three groups are: Compile, Execute, Extra. There is room for a
 622 further group, as currently only the low three bytes are used.
 623
 624     Compile Options:
 625
 626     PARSE
 627     PEEP
 628     TRIE
 629     PROGRAM
 630     OFFSETS
 631
 632     Execute Options:
 633
 634     INTUIT
 635     MATCH
 636     TRIE
 637
 638     Extra Options
 639
 640     TRIE
 641     OFFSETS
 642
 643 If you modify any of these make sure you make corresponding changes to
 644 re.pm, especially to the documentation.
 645
 646 */
 647
 648
 649 /* Compile */
 650 #define RE_DEBUG_COMPILE_MASK      0x0000FF
 651 #define RE_DEBUG_COMPILE_PARSE     0x000001
 652 #define RE_DEBUG_COMPILE_OPTIMISE  0x000002
 653 #define RE_DEBUG_COMPILE_TRIE      0x000004
 654 #define RE_DEBUG_COMPILE_DUMP      0x000008
 655
 656 /* Execute */
 657 #define RE_DEBUG_EXECUTE_MASK      0x00FF00
 658 #define RE_DEBUG_EXECUTE_INTUIT    0x000100
 659 #define RE_DEBUG_EXECUTE_MATCH     0x000200
 660 #define RE_DEBUG_EXECUTE_TRIE      0x000400
 661
 662 /* Extra */
 663 #define RE_DEBUG_EXTRA_MASK        0xFF0000
 664 #define RE_DEBUG_EXTRA_TRIE        0x010000
 665 #define RE_DEBUG_EXTRA_OFFSETS     0x020000
 666 #define RE_DEBUG_EXTRA_OFFDEBUG    0x040000
 667 #define RE_DEBUG_EXTRA_STATE       0x080000
 668 #define RE_DEBUG_EXTRA_OPTIMISE    0x100000
 669 /* combined */
 670 #define RE_DEBUG_EXTRA_STACK       0x280000
 671
 672 #define RE_DEBUG_FLAG(x) (re_debug_flags & x)
 673 /* Compile */
 674 #define DEBUG_COMPILE_r(x) DEBUG_r( \
 675     if (re_debug_flags & RE_DEBUG_COMPILE_MASK) x  )
 676 #define DEBUG_PARSE_r(x) DEBUG_r( \
 677     if (re_debug_flags & RE_DEBUG_COMPILE_PARSE) x  )
 678 #define DEBUG_OPTIMISE_r(x) DEBUG_r( \
 679     if (re_debug_flags & RE_DEBUG_COMPILE_OPTIMISE) x  )
 680 #define DEBUG_PARSE_r(x) DEBUG_r( \
 681     if (re_debug_flags & RE_DEBUG_COMPILE_PARSE) x  )
 682 #define DEBUG_DUMP_r(x) DEBUG_r( \
 683     if (re_debug_flags & RE_DEBUG_COMPILE_DUMP) x  )
 684 #define DEBUG_TRIE_COMPILE_r(x) DEBUG_r( \
 685     if (re_debug_flags & RE_DEBUG_COMPILE_TRIE) x )
 686
 687 /* Execute */
 688 #define DEBUG_EXECUTE_r(x) DEBUG_r( \
 689     if (re_debug_flags & RE_DEBUG_EXECUTE_MASK) x  )
 690 #define DEBUG_INTUIT_r(x) DEBUG_r( \
 691     if (re_debug_flags & RE_DEBUG_EXECUTE_INTUIT) x  )
 692 #define DEBUG_MATCH_r(x) DEBUG_r( \
 693     if (re_debug_flags & RE_DEBUG_EXECUTE_MATCH) x  )
 694 #define DEBUG_TRIE_EXECUTE_r(x) DEBUG_r( \
 695     if (re_debug_flags & RE_DEBUG_EXECUTE_TRIE) x )
 696
 697 /* Extra */
 698 #define DEBUG_EXTRA_r(x) DEBUG_r( \
 699     if (re_debug_flags & RE_DEBUG_EXTRA_MASK) x  )
 700 #define DEBUG_OFFSETS_r(x) DEBUG_r( \
 701     if (re_debug_flags & RE_DEBUG_EXTRA_OFFSETS) x  )
 702 #define DEBUG_STATE_r(x) DEBUG_r( \
 703     if (re_debug_flags & RE_DEBUG_EXTRA_STATE) x )
 704 #define DEBUG_STACK_r(x) DEBUG_r( \
 705     if (re_debug_flags & RE_DEBUG_EXTRA_STACK) x )
 706 #define DEBUG_OPTIMISE_MORE_r(x) DEBUG_r( \
 707     if ((RE_DEBUG_EXTRA_OPTIMISE|RE_DEBUG_COMPILE_OPTIMISE) == \
 708          (re_debug_flags & (RE_DEBUG_EXTRA_OPTIMISE|RE_DEBUG_COMPILE_OPTIMISE)) ) x )
 709 #define MJD_OFFSET_DEBUG(x) DEBUG_r( \
 710     if (re_debug_flags & RE_DEBUG_EXTRA_OFFDEBUG) \
 711         Perl_warn_nocontext x )
 712 #define DEBUG_TRIE_COMPILE_MORE_r(x) DEBUG_TRIE_COMPILE_r( \
 713     if (re_debug_flags & RE_DEBUG_EXTRA_TRIE) x )
 714 #define DEBUG_TRIE_EXECUTE_MORE_r(x) DEBUG_TRIE_EXECUTE_r( \
 715     if (re_debug_flags & RE_DEBUG_EXTRA_TRIE) x )
 716
 717 #define DEBUG_TRIE_r(x) DEBUG_r( \
 718     if (re_debug_flags & (RE_DEBUG_COMPILE_TRIE \
 719         | RE_DEBUG_EXECUTE_TRIE )) x )
 720
 721 /* initialization */
 722 /* get_sv() can return NULL during global destruction. */
 723 #define GET_RE_DEBUG_FLAGS DEBUG_r({ \
 724         SV * re_debug_flags_sv = NULL; \
 725         re_debug_flags_sv = get_sv(RE_DEBUG_FLAGS, 1); \
 726         if (re_debug_flags_sv) { \
 727             if (!SvIOK(re_debug_flags_sv)) \
 728                 sv_setuv(re_debug_flags_sv, RE_DEBUG_COMPILE_DUMP | RE_DEBUG_EXECUTE_MASK ); \
 729             re_debug_flags=SvIV(re_debug_flags_sv); \
 730         }\
 731 })
 732
 733 #ifdef DEBUGGING
 734
 735 #define GET_RE_DEBUG_FLAGS_DECL IV re_debug_flags = 0; GET_RE_DEBUG_FLAGS;
 736
 737 #define RE_PV_COLOR_DECL(rpv,rlen,isuni,dsv,pv,l,m,c1,c2) \
 738     const char * const rpv =                          \
 739         pv_pretty((dsv), (pv), (l), (m), \
 740             PL_colors[(c1)],PL_colors[(c2)], \
 741             ((isuni) ? PERL_PV_ESCAPE_UNI : 0) );         \
 742     const int rlen = SvCUR(dsv)
 743
 744 #define RE_SV_ESCAPE(rpv,isuni,dsv,sv,m) \
 745     const char * const rpv =                          \
 746         pv_pretty((dsv), (SvPV_nolen_const(sv)), (SvCUR(sv)), (m), \
 747             PL_colors[(c1)],PL_colors[(c2)], \
 748             ((isuni) ? PERL_PV_ESCAPE_UNI : 0) )
 749
 750 #define RE_PV_QUOTED_DECL(rpv,isuni,dsv,pv,l,m)                    \
 751     const char * const rpv =                                       \
 752         pv_pretty((dsv), (pv), (l), (m), \
 753             PL_colors[0], PL_colors[1], \
 754             ( PERL_PV_PRETTY_QUOTE | PERL_PV_PRETTY_ELIPSES |      \
 755               ((isuni) ? PERL_PV_ESCAPE_UNI : 0))                  \
 756         )
 757
 758 #define RE_SV_DUMPLEN(ItEm) (SvCUR(ItEm) - (SvTAIL(ItEm)!=0))
 759 #define RE_SV_TAIL(ItEm) (SvTAIL(ItEm) ? "$" : "")
 760
 761 #else /* if not DEBUGGING */
 762
 763 #define GET_RE_DEBUG_FLAGS_DECL
 764 #define RE_PV_COLOR_DECL(rpv,rlen,isuni,dsv,pv,l,m,c1,c2)
 765 #define RE_SV_ESCAPE(rpv,isuni,dsv,sv,m)
 766 #define RE_PV_QUOTED_DECL(rpv,isuni,dsv,pv,l,m)
 767 #define RE_SV_DUMPLEN(ItEm)
 768 #define RE_SV_TAIL(ItEm)
 769
 770 #endif /* DEBUG RELATED DEFINES */
 771
 772