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