regcomp.h

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