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