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
  11 #ifndef PERL_REGCOMP_H_
  12 #define PERL_REGCOMP_H_
  13
  14 #include "regcharclass.h"
  15
  16 /* Convert branch sequences to more efficient trie ops? */
  17 #define PERL_ENABLE_TRIE_OPTIMISATION 1
  18
  19 /* Be really aggressive about optimising patterns with trie sequences? */
  20 #define PERL_ENABLE_EXTENDED_TRIE_OPTIMISATION 1
  21
  22 /* Should the optimiser take positive assertions into account? */
  23 #define PERL_ENABLE_POSITIVE_ASSERTION_STUDY 0
  24
  25 /* Not for production use: */
  26 #define PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS 0
  27
  28 /* Activate offsets code - set to if 1 to enable */
  29 #ifdef DEBUGGING
  30 #define RE_TRACK_PATTERN_OFFSETS
  31 #endif
  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.]
  92  */
  93
  94 /* This is the stuff that used to live in regexp.h that was truly
  95    private to the engine itself. It now lives here. */
  96
  97  typedef struct regexp_internal {
  98         int name_list_idx;      /* Optional data index of an array of paren names */
  99         union {
 100             U32 *offsets;           /* offset annotations 20001228 MJD
 101                                        data about mapping the program to the
 102                                        string -
 103                                        offsets[0] is proglen when this is used
 104                                        */
 105             U32 proglen;
 106         } u;
 107
 108         regnode *regstclass;    /* Optional startclass as identified or constructed
 109                                    by the optimiser */
 110         struct reg_data *data;  /* Additional miscellaneous data used by the program.
 111                                    Used to make it easier to clone and free arbitrary
 112                                    data that the regops need. Often the ARG field of
 113                                    a regop is an index into this structure */
 114         struct reg_code_blocks *code_blocks;/* positions of literal (?{}) */
 115         regnode program[1];     /* Unwarranted chumminess with compiler. */
 116 } regexp_internal;
 117
 118 #define RXi_SET(x,y) (x)->pprivate = (void*)(y)
 119 #define RXi_GET(x)   ((regexp_internal *)((x)->pprivate))
 120 #define RXi_GET_DECL(r,ri) regexp_internal *ri = RXi_GET(r)
 121 /*
 122  * Flags stored in regexp->intflags
 123  * These are used only internally to the regexp engine
 124  *
 125  * See regexp.h for flags used externally to the regexp engine
 126  */
 127 #define RXp_INTFLAGS(rx)        ((rx)->intflags)
 128 #define RX_INTFLAGS(prog)        RXp_INTFLAGS(ReANY(prog))
 129
 130 #define PREGf_SKIP              0x00000001
 131 #define PREGf_IMPLICIT          0x00000002 /* Converted .* to ^.* */
 132 #define PREGf_NAUGHTY           0x00000004 /* how exponential is this pattern? */
 133 #define PREGf_VERBARG_SEEN      0x00000008
 134 #define PREGf_CUTGROUP_SEEN     0x00000010
 135 #define PREGf_USE_RE_EVAL       0x00000020 /* compiled with "use re 'eval'" */
 136 /* these used to be extflags, but are now intflags */
 137 #define PREGf_NOSCAN            0x00000040
 138                                 /* spare */
 139 #define PREGf_GPOS_SEEN         0x00000100
 140 #define PREGf_GPOS_FLOAT        0x00000200
 141
 142 #define PREGf_ANCH_MBOL         0x00000400
 143 #define PREGf_ANCH_SBOL         0x00000800
 144 #define PREGf_ANCH_GPOS         0x00001000
 145 #define PREGf_RECURSE_SEEN      0x00002000
 146
 147 #define PREGf_ANCH              \
 148     ( PREGf_ANCH_SBOL | PREGf_ANCH_GPOS | PREGf_ANCH_MBOL )
 149
 150 /* this is where the old regcomp.h started */
 151
 152 struct regnode_string {
 153     U8  str_len;
 154     U8  type;
 155     U16 next_off;
 156     char string[1];
 157 };
 158
 159 struct regnode_lstring { /* Constructed this way to keep the string aligned. */
 160     U8  flags;
 161     U8  type;
 162     U16 next_off;
 163     U32 str_len;    /* Only 16 bits allowed before would overflow 'next_off' */
 164     char string[1];
 165 };
 166
 167 /* Argument bearing node - workhorse,
 168    arg1 is often for the data field */
 169 struct regnode_1 {
 170     U8  flags;
 171     U8  type;
 172     U16 next_off;
 173     U32 arg1;
 174 };
 175
 176 /* Similar to a regnode_1 but with an extra signed argument */
 177 struct regnode_2L {
 178     U8  flags;
 179     U8  type;
 180     U16 next_off;
 181     U32 arg1;
 182     I32 arg2;
 183 };
 184
 185 /* 'Two field' -- Two 16 bit unsigned args */
 186 struct regnode_2 {
 187     U8  flags;
 188     U8  type;
 189     U16 next_off;
 190     U16 arg1;
 191     U16 arg2;
 192 };
 193
 194 /* This give the number of code points that can be in the bitmap of an ANYOF
 195  * node.  The shift number must currently be one of: 8..12.  It can't be less
 196  * than 8 (256) because some code relies on it being at least that.  Above 12
 197  * (4096), and you start running into warnings that some data structure widths
 198  * have been exceeded, though the test suite as of this writing still passes
 199  * for up through 16, which is as high as anyone would ever want to go,
 200  * encompassing all of the Unicode BMP, and thus including all the economically
 201  * important world scripts.  At 12 most of them are: including Arabic,
 202  * Cyrillic, Greek, Hebrew, Indian subcontinent, Latin, and Thai; but not Han,
 203  * Japanese, nor Korean.  (The regarglen structure in regnodes.h is a U8, and
 204  * the trie types TRIEC and AHOCORASICKC are larger than U8 for shift values
 205  * above 12.)  Be sure to benchmark before changing, as larger sizes do
 206  * significantly slow down the test suite */
 207 #define NUM_ANYOF_CODE_POINTS   (1 << 8)
 208
 209 #define ANYOF_BITMAP_SIZE       (NUM_ANYOF_CODE_POINTS / 8)   /* 8 bits/Byte */
 210
 211 /* Note that these form structs which are supersets of the next smaller one, by
 212  * appending fields.  Alignment problems can occur if one of those optional
 213  * fields requires stricter alignment than the base struct.  And formal
 214  * parameters that can really be two or more of the structs should be
 215  * declared as the smallest one it could be.  See commit message for
 216  * 7dcac5f6a5195002b55c935ee1d67f67e1df280b.  Regnode allocation is done
 217  * without regard to alignment, and changing it to would also require changing
 218  * the code that inserts and deletes regnodes.  The basic single-argument
 219  * regnode has a U32, which is what reganode() allocates as a unit.  Therefore
 220  * no field can require stricter alignment than U32. */
 221
 222 /* also used by trie */
 223 struct regnode_charclass {
 224     U8  flags;
 225     U8  type;
 226     U16 next_off;
 227     U32 arg1;                           /* set by set_ANYOF_arg() */
 228     char bitmap[ANYOF_BITMAP_SIZE];     /* only compile-time */
 229 };
 230
 231 /* has runtime (locale) \d, \w, ..., [:posix:] classes */
 232 struct regnode_charclass_posixl {
 233     U8  flags;                      /* ANYOF_MATCHES_POSIXL bit must go here */
 234     U8  type;
 235     U16 next_off;
 236     U32 arg1;
 237     char bitmap[ANYOF_BITMAP_SIZE];             /* both compile-time ... */
 238     U32 classflags;                             /* and run-time */
 239 };
 240
 241 /* A synthetic start class (SSC); is a regnode_charclass_posixl_fold, plus an
 242  * extra SV*, used only during its construction and which is not used by
 243  * regexec.c.  Note that the 'next_off' field is unused, as the SSC stands
 244  * alone, so there is never a next node.  Also, there is no alignment issue,
 245  * because these are declared or allocated as a complete unit so the compiler
 246  * takes care of alignment.  This is unlike the other regnodes which are
 247  * allocated in terms of multiples of a single-argument regnode.  SSC nodes can
 248  * have a pointer field because there is no alignment issue, and because it is
 249  * set to NULL after construction, before any cloning of the pattern */
 250 struct regnode_ssc {
 251     U8  flags;                      /* ANYOF_MATCHES_POSIXL bit must go here */
 252     U8  type;
 253     U16 next_off;
 254     U32 arg1;
 255     char bitmap[ANYOF_BITMAP_SIZE];     /* both compile-time ... */
 256     U32 classflags;                     /* ... and run-time */
 257
 258     /* Auxiliary, only used during construction; NULL afterwards: list of code
 259      * points matched */
 260     SV* invlist;
 261 };
 262
 263 /*  We take advantage of 'next_off' not otherwise being used in the SSC by
 264  *  actually using it: by setting it to 1.  This allows us to test and
 265  *  distinguish between an SSC and other ANYOF node types, as 'next_off' cannot
 266  *  otherwise be 1, because it is the offset to the next regnode expressed in
 267  *  units of regnodes.  Since an ANYOF node contains extra fields, it adds up
 268  *  to 12 regnode units on 32-bit systems, (hence the minimum this can be (if
 269  *  not 0) is 11 there.  Even if things get tightly packed on a 64-bit system,
 270  *  it still would be more than 1. */
 271 #define set_ANYOF_SYNTHETIC(n) STMT_START{ OP(n) = ANYOF;              \
 272                                            NEXT_OFF(n) = 1;            \
 273                                } STMT_END
 274 #define is_ANYOF_SYNTHETIC(n) (PL_regkind[OP(n)] == ANYOF && NEXT_OFF(n) == 1)
 275
 276 /* XXX fix this description.
 277    Impose a limit of REG_INFTY on various pattern matching operations
 278    to limit stack growth and to avoid "infinite" recursions.
 279 */
 280 /* The default size for REG_INFTY is U16_MAX, which is the same as
 281    USHORT_MAX (see perl.h).  Unfortunately U16 isn't necessarily 16 bits
 282    (see handy.h).  On the Cray C90, sizeof(short)==4 and hence U16_MAX is
 283    ((1<<32)-1), while on the Cray T90, sizeof(short)==8 and U16_MAX is
 284    ((1<<64)-1).  To limit stack growth to reasonable sizes, supply a
 285    smaller default.
 286         --Andy Dougherty  11 June 1998
 287 */
 288 #if SHORTSIZE > 2
 289 #  ifndef REG_INFTY
 290 #    define REG_INFTY ((1<<16)-1)
 291 #  endif
 292 #endif
 293
 294 #ifndef REG_INFTY
 295 #  define REG_INFTY U16_MAX
 296 #endif
 297
 298 #define ARG_VALUE(arg) (arg)
 299 #define ARG__SET(arg,val) ((arg) = (val))
 300
 301 #undef ARG
 302 #undef ARG1
 303 #undef ARG2
 304
 305 #define ARG(p) ARG_VALUE(ARG_LOC(p))
 306 #define ARG1(p) ARG_VALUE(ARG1_LOC(p))
 307 #define ARG2(p) ARG_VALUE(ARG2_LOC(p))
 308 #define ARG2L(p) ARG_VALUE(ARG2L_LOC(p))
 309
 310 #define ARG_SET(p, val) ARG__SET(ARG_LOC(p), (val))
 311 #define ARG1_SET(p, val) ARG__SET(ARG1_LOC(p), (val))
 312 #define ARG2_SET(p, val) ARG__SET(ARG2_LOC(p), (val))
 313 #define ARG2L_SET(p, val) ARG__SET(ARG2L_LOC(p), (val))
 314
 315 #undef NEXT_OFF
 316 #undef NODE_ALIGN
 317
 318 #define NEXT_OFF(p) ((p)->next_off)
 319 #define NODE_ALIGN(node)
 320 /* the following define was set to 0xde in 075abff3
 321  * as part of some linting logic. I have set it to 0
 322  * as otherwise in every place where we /might/ set flags
 323  * we have to set it 0 explicitly, which duplicates
 324  * assignments and IMO adds an unacceptable level of
 325  * surprise to working in the regex engine. If this
 326  * is changed from 0 then at the very least make sure
 327  * that SBOL for /^/ sets the flags to 0 explicitly.
 328  * -- Yves */
 329 #define NODE_ALIGN_FILL(node) ((node)->flags = 0)
 330
 331 #define SIZE_ALIGN NODE_ALIGN
 332
 333 #undef OP
 334 #undef OPERAND
 335 #undef STRING
 336
 337 #define OP(p)           ((p)->type)
 338 #define FLAGS(p)        ((p)->flags)    /* Caution: Doesn't apply to all      \
 339                                            regnode types.  For some, it's the \
 340                                            character set of the regnode */
 341 #define STR_LENs(p)     (__ASSERT_(OP(p) != LEXACT && OP(p) != LEXACT_ONLY8)  \
 342                                     ((struct regnode_string *)p)->str_len)
 343 #define STRINGs(p)      (__ASSERT_(OP(p) != LEXACT && OP(p) != LEXACT_ONLY8)  \
 344                                     ((struct regnode_string *)p)->string)
 345 #define OPERANDs(p)     STRINGs(p)
 346
 347 /* Long strings.  Currently limited to length 18 bits, which handles a 262000
 348  * byte string.  The limiting factor is the 16 bit 'next_off' field, which
 349  * points to the next regnode, so the furthest away it can be is 2**16.  On
 350  * most architectures, regnodes are 2**2 bytes long, so that yields 2**18
 351  * bytes.  Should a longer string be desired, we could increase it to 26 bits
 352  * fairly easily, by changing this node to have longj type which causes the ARG
 353  * field to be used for the link to the next regnode (although code would have
 354  * to be changed to account for this), and then use a combination of the flags
 355  * and next_off fields for the length.  To get 34 bit length, also change the
 356  * node to be an ARG2L, using the second 32 bit field for the length, and not
 357  * using the flags nor next_off fields at all.  One could have an llstring node
 358  * and even an lllstring type. */
 359 #define STR_LENl(p)     (__ASSERT_(OP(p) == LEXACT || OP(p) == LEXACT_ONLY8)  \
 360                                     (((struct regnode_lstring *)p)->str_len))
 361 #define STRINGl(p)      (__ASSERT_(OP(p) == LEXACT || OP(p) == LEXACT_ONLY8)  \
 362                                     (((struct regnode_lstring *)p)->string))
 363 #define OPERANDl(p)     STRINGl(p)
 364
 365 #define STR_LEN(p)      ((OP(p) == LEXACT || OP(p) == LEXACT_ONLY8)           \
 366                                                ? STR_LENl(p) : STR_LENs(p))
 367 #define STRING(p)       ((OP(p) == LEXACT || OP(p) == LEXACT_ONLY8)           \
 368                                                ? STRINGl(p)  : STRINGs(p))
 369 #define OPERAND(p)      STRING(p)
 370
 371 /* The number of (smallest) regnode equivalents that a string of length l bytes
 372  * occupies */
 373 #define STR_SZ(l)       (((l) + sizeof(regnode) - 1) / sizeof(regnode))
 374
 375 /* The number of (smallest) regnode equivalents that the EXACTISH node 'p'
 376  * occupies */
 377 #define NODE_SZ_STR(p)  (STR_SZ(STR_LEN(p)) + 1 + regarglen[(p)->type])
 378
 379 #define setSTR_LEN(p,v)                                                     \
 380     STMT_START{                                                             \
 381         if (OP(p) == LEXACT || OP(p) == LEXACT_ONLY8)                       \
 382             ((struct regnode_lstring *)(p))->str_len = (v);                 \
 383         else                                                                \
 384             ((struct regnode_string *)(p))->str_len = (v);                  \
 385     } STMT_END
 386
 387 #undef NODE_ALIGN
 388 #undef ARG_LOC
 389 #undef NEXTOPER
 390 #undef PREVOPER
 391
 392 #define NODE_ALIGN(node)
 393 #define ARG_LOC(p)      (((struct regnode_1 *)p)->arg1)
 394 #define ARG1_LOC(p)     (((struct regnode_2 *)p)->arg1)
 395 #define ARG2_LOC(p)     (((struct regnode_2 *)p)->arg2)
 396 #define ARG2L_LOC(p)    (((struct regnode_2L *)p)->arg2)
 397
 398 #define NODE_STEP_REGNODE       1       /* sizeof(regnode)/sizeof(regnode) */
 399 #define EXTRA_STEP_2ARGS        EXTRA_SIZE(struct regnode_2)
 400
 401 #define NODE_STEP_B     4
 402
 403 #define NEXTOPER(p)     ((p) + NODE_STEP_REGNODE)
 404 #define PREVOPER(p)     ((p) - NODE_STEP_REGNODE)
 405
 406 #define FILL_NODE(offset, op)                                           \
 407     STMT_START {                                                        \
 408                     OP(REGNODE_p(offset)) = op;                         \
 409                     NEXT_OFF(REGNODE_p(offset)) = 0;                    \
 410     } STMT_END
 411 #define FILL_ADVANCE_NODE(offset, op)                                   \
 412     STMT_START {                                                        \
 413                     FILL_NODE(offset, op);                              \
 414                     (offset)++;                                         \
 415     } STMT_END
 416 #define FILL_ADVANCE_NODE_ARG(offset, op, arg)                          \
 417     STMT_START {                                                        \
 418                     ARG_SET(REGNODE_p(offset), arg);                    \
 419                     FILL_ADVANCE_NODE(offset, op);                      \
 420                     /* This is used generically for other operations    \
 421                      * that have a longer argument */                   \
 422                     (offset) += regarglen[op];                          \
 423     } STMT_END
 424 #define FILL_ADVANCE_NODE_2L_ARG(offset, op, arg1, arg2)                \
 425     STMT_START {                                                        \
 426                     ARG_SET(REGNODE_p(offset), arg1);                   \
 427                     ARG2L_SET(REGNODE_p(offset), arg2);                 \
 428                     FILL_ADVANCE_NODE(offset, op);                      \
 429                     (offset) += 2;                                      \
 430     } STMT_END
 431
 432 #define REG_MAGIC 0234
 433
 434 /* An ANYOF node is basically a bitmap with the index being a code point.  If
 435  * the bit for that code point is 1, the code point matches;  if 0, it doesn't
 436  * match (complemented if inverted).  There is an additional mechanism to deal
 437  * with cases where the bitmap is insufficient in and of itself.  This #define
 438  * indicates if the bitmap does fully represent what this ANYOF node can match.
 439  * The ARG is set to this special value (since 0, 1, ... are legal, but will
 440  * never reach this high). */
 441 #define ANYOF_ONLY_HAS_BITMAP   ((U32) -1)
 442
 443 /* When the bitmap isn't completely sufficient for handling the ANYOF node,
 444  * flags (in node->flags of the ANYOF node) get set to indicate this.  These
 445  * are perennially in short supply.  Beyond several cases where warnings need
 446  * to be raised under certain circumstances, currently, there are six cases
 447  * where the bitmap alone isn't sufficient.  We could use six flags to
 448  * represent the 6 cases, but to save flags bits, we play some games.  The
 449  * cases are:
 450  *
 451  *  1)  The bitmap has a compiled-in very finite size.  So something else needs
 452  *      to be used to specify if a code point that is too large for the bitmap
 453  *      actually matches.  The mechanism currently is an inversion
 454  *      list.  ANYOF_ONLY_HAS_BITMAP, described above, being TRUE indicates
 455  *      there are no matches of too-large code points.  But if it is FALSE,
 456  *      then almost certainly there are matches too large for the bitmap.  (The
 457  *      other cases, described below, either imply this one or are extremely
 458  *      rare in practice.)  So we can just assume that a too-large code point
 459  *      will need something beyond the bitmap if ANYOF_ONLY_HAS_BITMAP is
 460  *      FALSE, instead of having a separate flag for this.
 461  *  2)  A subset of item 1) is if all possible code points outside the bitmap
 462  *      match.  This is a common occurrence when the class is complemented,
 463  *      like /[^ij]/.  Therefore a bit is reserved to indicate this,
 464  *      rather than having a more expensive inversion list created,
 465  *      ANYOF_MATCHES_ALL_ABOVE_BITMAP.
 466  *  3)  Under /d rules, it can happen that code points that are in the upper
 467  *      latin1 range (\x80-\xFF or their equivalents on EBCDIC platforms) match
 468  *      only if the runtime target string being matched against is UTF-8.  For
 469  *      example /[\w[:punct:]]/d.  This happens only for posix classes (with a
 470  *      couple of exceptions, like \d where it doesn't happen), and all such
 471  *      ones also have above-bitmap matches.  Thus, 3) implies 1) as well.
 472  *      Note that /d rules are no longer encouraged; 'use 5.14' or higher
 473  *      deselects them.  But a flag is required so that they can be properly
 474  *      handled.  But it can be a shared flag: see 5) below.
 475  *  4)  Also under /d rules, something like /[\Wfoo]/ will match everything in
 476  *      the \x80-\xFF range, unless the string being matched against is UTF-8.
 477  *      An inversion list could be created for this case, but this is
 478  *      relatively common, and it turns out that it's all or nothing:  if any
 479  *      one of these code points matches, they all do.  Hence a single bit
 480  *      suffices.  We use a shared flag that doesn't take up space by itself:
 481  *      ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER.  This
 482  *      also implies 1), with one exception: [:^cntrl:].
 483  *  5)  A user-defined \p{} property may not have been defined by the time the
 484  *      regex is compiled.  In this case, we don't know until runtime what it
 485  *      will match, so we have to assume it could match anything, including
 486  *      code points that ordinarily would be in the bitmap.  A flag bit is
 487  *      necessary to indicate this , though it can be shared with the item 3)
 488  *      flag, as that only occurs under /d, and this only occurs under non-d.
 489  *      This case is quite uncommon in the field, and the /(?[ ...])/ construct
 490  *      is a better way to accomplish what this feature does.  This case also
 491  *      implies 1).
 492  *      ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP
 493  *      is the shared flag.
 494  *  6)  /[foo]/il may have folds that are only valid if the runtime locale is a
 495  *      UTF-8 one.  These are quite rare, so it would be good to avoid the
 496  *      expense of looking for them.  But /l matching is slow anyway, and we've
 497  *      traditionally not worried too much about its performance.  And this
 498  *      condition requires the ANYOFL_FOLD flag to be set, so testing for
 499  *      that flag would be sufficient to rule out most cases of this.  So it is
 500  *      unclear if this should have a flag or not.  But, this flag can be
 501  *      shared with another, so it doesn't occupy extra space.
 502  *
 503  * At the moment, there is one spare bit, but this could be increased by
 504  * various tricks:
 505  *
 506  * If just one more bit is needed, as of this writing it seems to khw that the
 507  * best choice would be to make ANYOF_MATCHES_ALL_ABOVE_BITMAP not a flag, but
 508  * something like
 509  *
 510  *      #define ANYOF_MATCHES_ALL_ABOVE_BITMAP      ((U32) -2)
 511  *
 512  * and access it through the ARG like ANYOF_ONLY_HAS_BITMAP is.  This flag is
 513  * used by all ANYOF node types, and it could be used to avoid calling the
 514  * handler function, as the macro REGINCLASS in regexec.c does now for other
 515  * cases.
 516  *
 517  * Another possibility is based on the fact that ANYOF_MATCHES_POSIXL is
 518  * redundant with the node type ANYOFPOSIXL.  That flag could be removed, but
 519  * at the expense of extra code in regexec.c.  The flag has been retained
 520  * because it allows us to see if we need to call reginsert, or just use the
 521  * bitmap in one test.
 522  *
 523  * If this is done, an extension would be to make all ANYOFL nodes contain the
 524  * extra 32 bits that ANYOFPOSIXL ones do.  The posix flags only occupy 30
 525  * bits, so the ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD flags
 526  * and ANYOFL_FOLD could be moved to that extra space, but it would mean extra
 527  * instructions, as there are currently places in the code that assume those
 528  * two bits are zero.
 529  *
 530  * All told, 5 bits could be available for other uses if all of the above were
 531  * done.
 532  *
 533  * Some flags are not used in synthetic start class (SSC) nodes, so could be
 534  * shared should new flags be needed for SSCs, like SSC_MATCHES_EMPTY_STRING
 535  * now. */
 536
 537 /* If this is set, the result of the match should be complemented.  regexec.c
 538  * is expecting this to be in the low bit.  Never in an SSC */
 539 #define ANYOF_INVERT                            0x01
 540
 541 /* For the SSC node only, which cannot be inverted, so is shared with that bit.
 542  * This is used only during regex compilation. */
 543 #define SSC_MATCHES_EMPTY_STRING                ANYOF_INVERT
 544
 545 /* Set if this is a regnode_charclass_posixl vs a regnode_charclass.  This
 546  * is used for runtime \d, \w, [:posix:], ..., which are used only in locale
 547  * and the optimizer's synthetic start class.  Non-locale \d, etc are resolved
 548  * at compile-time.  Only set under /l; can be in SSC */
 549 #define ANYOF_MATCHES_POSIXL                    0x02
 550
 551 /* The fold is calculated and stored in the bitmap where possible at compile
 552  * time.  However under locale, the actual folding varies depending on
 553  * what the locale is at the time of execution, so it has to be deferred until
 554  * then.  Only set under /l; never in an SSC  */
 555 #define ANYOFL_FOLD                             0x04
 556
 557 /* Shared bit set only with ANYOFL and SSC nodes:
 558  *    If ANYOFL_FOLD is set, this flag indicates there are potential matches
 559  *      valid only if the locale is a UTF-8 one.
 560  *    If ANYOFL_FOLD is NOT set, this flag means to warn if the runtime locale
 561  *       isn't a UTF-8 one (and the generated node assumes a UTF-8 locale).
 562  *       None of INVERT, POSIXL,
 563  *       ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP
 564  *       can be set.  */
 565 #define ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD        0x08
 566
 567 /* Convenience macros for teasing apart the meanings when reading the above bit
 568  * */
 569 #define ANYOFL_SOME_FOLDS_ONLY_IN_UTF8_LOCALE(flags)                        \
 570     ((flags & ( ANYOFL_FOLD /* Both bits are set */                         \
 571                |ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD))   \
 572              == ( ANYOFL_FOLD                                               \
 573                  |ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD))
 574
 575 #define  ANYOFL_UTF8_LOCALE_REQD(flags)                                     \
 576     ((flags & ( ANYOFL_FOLD /* Only REQD bit is set */                      \
 577                |ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD))   \
 578              == ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD)
 579
 580 /* Spare: Be sure to change ANYOF_FLAGS_ALL if this gets used  0x10 */
 581
 582 /* If set, the node matches every code point NUM_ANYOF_CODE_POINTS and above.
 583  * Can be in an SSC */
 584 #define ANYOF_MATCHES_ALL_ABOVE_BITMAP          0x20
 585
 586 /* Shared bit:
 587  *      Under /d it means the ANYOFD node matches more things if the target
 588  *          string is encoded in UTF-8; any such things will be non-ASCII,
 589  *          characters that are < 256, and can be accessed via the inversion
 590  *          list.
 591  *      When not under /d, it means the ANYOF node contains a user-defined
 592  *      property that wasn't yet defined at the time the regex was compiled,
 593  *      and so must be looked up at runtime, by creating an inversion list.
 594  * (These uses are mutually exclusive because a user-defined property is
 595  * specified by \p{}, and \p{} implies /u which deselects /d).  The long macro
 596  * name is to make sure that you are cautioned about its shared nature.  Only
 597  * the non-/d meaning can be in an SSC */
 598 #define ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP  0x40
 599
 600 /* Shared bit:
 601  *      Under /d it means the ANYOFD node matches all non-ASCII Latin1
 602  *          characters when the target string is not in utf8.
 603  *      When not under /d, it means the ANYOF node should raise a warning if
 604  *          matching against an above-Unicode code point.
 605  * (These uses are mutually exclusive because the warning requires a \p{}, and
 606  * \p{} implies /u which deselects /d).  An SSC node only has this bit set if
 607  * what is meant is the warning.  The long macro name is to make sure that you
 608  * are cautioned about its shared nature */
 609 #define ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER 0x80
 610
 611 #define ANYOF_FLAGS_ALL         (0xff & ~0x10)
 612
 613 #define ANYOF_LOCALE_FLAGS (ANYOFL_FOLD | ANYOF_MATCHES_POSIXL)
 614
 615 /* These are the flags that apply to both regular ANYOF nodes and synthetic
 616  * start class nodes during construction of the SSC.  During finalization of
 617  * the SSC, other of the flags may get added to it */
 618 #define ANYOF_COMMON_FLAGS      0
 619
 620 /* Character classes for node->classflags of ANYOF */
 621 /* Should be synchronized with a table in regprop() */
 622 /* 2n should be the normal one, paired with its complement at 2n+1 */
 623
 624 #define ANYOF_ALPHA    ((_CC_ALPHA) * 2)
 625 #define ANYOF_NALPHA   ((ANYOF_ALPHA) + 1)
 626 #define ANYOF_ALPHANUMERIC   ((_CC_ALPHANUMERIC) * 2)    /* [[:alnum:]] isalnum(3), utf8::IsAlnum */
 627 #define ANYOF_NALPHANUMERIC  ((ANYOF_ALPHANUMERIC) + 1)
 628 #define ANYOF_ASCII    ((_CC_ASCII) * 2)
 629 #define ANYOF_NASCII   ((ANYOF_ASCII) + 1)
 630 #define ANYOF_BLANK    ((_CC_BLANK) * 2)     /* GNU extension: space and tab: non-vertical space */
 631 #define ANYOF_NBLANK   ((ANYOF_BLANK) + 1)
 632 #define ANYOF_CASED    ((_CC_CASED) * 2)    /* Pseudo class for [:lower:] or
 633                                                [:upper:] under /i */
 634 #define ANYOF_NCASED   ((ANYOF_CASED) + 1)
 635 #define ANYOF_CNTRL    ((_CC_CNTRL) * 2)
 636 #define ANYOF_NCNTRL   ((ANYOF_CNTRL) + 1)
 637 #define ANYOF_DIGIT    ((_CC_DIGIT) * 2)     /* \d */
 638 #define ANYOF_NDIGIT   ((ANYOF_DIGIT) + 1)
 639 #define ANYOF_GRAPH    ((_CC_GRAPH) * 2)
 640 #define ANYOF_NGRAPH   ((ANYOF_GRAPH) + 1)
 641 #define ANYOF_LOWER    ((_CC_LOWER) * 2)
 642 #define ANYOF_NLOWER   ((ANYOF_LOWER) + 1)
 643 #define ANYOF_PRINT    ((_CC_PRINT) * 2)
 644 #define ANYOF_NPRINT   ((ANYOF_PRINT) + 1)
 645 #define ANYOF_PUNCT    ((_CC_PUNCT) * 2)
 646 #define ANYOF_NPUNCT   ((ANYOF_PUNCT) + 1)
 647 #define ANYOF_SPACE    ((_CC_SPACE) * 2)     /* \s */
 648 #define ANYOF_NSPACE   ((ANYOF_SPACE) + 1)
 649 #define ANYOF_UPPER    ((_CC_UPPER) * 2)
 650 #define ANYOF_NUPPER   ((ANYOF_UPPER) + 1)
 651 #define ANYOF_WORDCHAR ((_CC_WORDCHAR) * 2)  /* \w, PL_utf8_alnum, utf8::IsWord, ALNUM */
 652 #define ANYOF_NWORDCHAR   ((ANYOF_WORDCHAR) + 1)
 653 #define ANYOF_XDIGIT   ((_CC_XDIGIT) * 2)
 654 #define ANYOF_NXDIGIT  ((ANYOF_XDIGIT) + 1)
 655
 656 /* pseudo classes below this, not stored in the class bitmap, but used as flags
 657    during compilation of char classes */
 658
 659 #define ANYOF_VERTWS    ((_CC_VERTSPACE) * 2)
 660 #define ANYOF_NVERTWS   ((ANYOF_VERTWS)+1)
 661
 662 /* It is best if this is the last one, as all above it are stored as bits in a
 663  * bitmap, and it isn't part of that bitmap */
 664 #if _CC_VERTSPACE != _HIGHEST_REGCOMP_DOT_H_SYNC
 665 #   error Problem with handy.h _HIGHEST_REGCOMP_DOT_H_SYNC #define
 666 #endif
 667
 668 #define ANYOF_POSIXL_MAX (ANYOF_VERTWS) /* So upper loop limit is written:
 669                                          *       '< ANYOF_MAX'
 670                                          * Hence doesn't include VERTWS, as that
 671                                          * is a pseudo class */
 672 #define ANYOF_MAX      ANYOF_POSIXL_MAX
 673
 674 #if (ANYOF_POSIXL_MAX > 32)   /* Must fit in 32-bit word */
 675 #   error Problem with handy.h _CC_foo #defines
 676 #endif
 677
 678 #define ANYOF_HORIZWS   ((ANYOF_POSIXL_MAX)+2) /* = (ANYOF_NVERTWS + 1) */
 679 #define ANYOF_NHORIZWS  ((ANYOF_POSIXL_MAX)+3)
 680
 681 #define ANYOF_UNIPROP   ((ANYOF_POSIXL_MAX)+4)  /* Used to indicate a Unicode
 682                                                    property: \p{} or \P{} */
 683
 684 /* Backward source code compatibility. */
 685
 686 #define ANYOF_ALNUML     ANYOF_ALNUM
 687 #define ANYOF_NALNUML    ANYOF_NALNUM
 688 #define ANYOF_SPACEL     ANYOF_SPACE
 689 #define ANYOF_NSPACEL    ANYOF_NSPACE
 690 #define ANYOF_ALNUM ANYOF_WORDCHAR
 691 #define ANYOF_NALNUM ANYOF_NWORDCHAR
 692
 693 /* Utility macros for the bitmap and classes of ANYOF */
 694
 695 #define ANYOF_FLAGS(p)          ((p)->flags)
 696
 697 #define ANYOF_BIT(c)            (1U << ((c) & 7))
 698
 699 #define POSIXL_SET(field, c)    ((field) |= (1U << (c)))
 700 #define ANYOF_POSIXL_SET(p, c)  POSIXL_SET(((regnode_charclass_posixl*) (p))->classflags, (c))
 701
 702 #define POSIXL_CLEAR(field, c) ((field) &= ~ (1U <<(c)))
 703 #define ANYOF_POSIXL_CLEAR(p, c) POSIXL_CLEAR(((regnode_charclass_posixl*) (p))->classflags, (c))
 704
 705 #define POSIXL_TEST(field, c)   ((field) & (1U << (c)))
 706 #define ANYOF_POSIXL_TEST(p, c) POSIXL_TEST(((regnode_charclass_posixl*) (p))->classflags, (c))
 707
 708 #define POSIXL_ZERO(field)      STMT_START { (field) = 0; } STMT_END
 709 #define ANYOF_POSIXL_ZERO(ret)  POSIXL_ZERO(((regnode_charclass_posixl*) (ret))->classflags)
 710
 711 #define ANYOF_POSIXL_SET_TO_BITMAP(p, bits)                                 \
 712      STMT_START {                                                           \
 713                     ((regnode_charclass_posixl*) (p))->classflags = (bits); \
 714      } STMT_END
 715
 716 /* Shifts a bit to get, eg. 0x4000_0000, then subtracts 1 to get 0x3FFF_FFFF */
 717 #define ANYOF_POSIXL_SETALL(ret) STMT_START { ((regnode_charclass_posixl*) (ret))->classflags = ((1U << ((ANYOF_POSIXL_MAX) - 1))) - 1; } STMT_END
 718 #define ANYOF_CLASS_SETALL(ret) ANYOF_POSIXL_SETALL(ret)
 719
 720 #define ANYOF_POSIXL_TEST_ANY_SET(p)                               \
 721         ((ANYOF_FLAGS(p) & ANYOF_MATCHES_POSIXL)                           \
 722          && (((regnode_charclass_posixl*)(p))->classflags))
 723 #define ANYOF_CLASS_TEST_ANY_SET(p) ANYOF_POSIXL_TEST_ANY_SET(p)
 724
 725 /* Since an SSC always has this field, we don't have to test for that; nor do
 726  * we want to because the bit isn't set for SSC during its construction */
 727 #define ANYOF_POSIXL_SSC_TEST_ANY_SET(p)                               \
 728                             cBOOL(((regnode_ssc*)(p))->classflags)
 729 #define ANYOF_POSIXL_SSC_TEST_ALL_SET(p) /* Are all bits set? */       \
 730         (((regnode_ssc*) (p))->classflags                              \
 731                         == ((1U << ((ANYOF_POSIXL_MAX) - 1))) - 1)
 732
 733 #define ANYOF_POSIXL_TEST_ALL_SET(p)                                   \
 734         ((ANYOF_FLAGS(p) & ANYOF_MATCHES_POSIXL)                               \
 735          && ((regnode_charclass_posixl*) (p))->classflags              \
 736                         == ((1U << ((ANYOF_POSIXL_MAX) - 1))) - 1)
 737
 738 #define ANYOF_POSIXL_OR(source, dest) STMT_START { (dest)->classflags |= (source)->classflags ; } STMT_END
 739 #define ANYOF_CLASS_OR(source, dest) ANYOF_POSIXL_OR((source), (dest))
 740
 741 #define ANYOF_POSIXL_AND(source, dest) STMT_START { (dest)->classflags &= (source)->classflags ; } STMT_END
 742
 743 #define ANYOF_BITMAP_ZERO(ret)  Zero(((regnode_charclass*)(ret))->bitmap, ANYOF_BITMAP_SIZE, char)
 744 #define ANYOF_BITMAP(p)         ((regnode_charclass*)(p))->bitmap
 745 #define ANYOF_BITMAP_BYTE(p, c) BITMAP_BYTE(ANYOF_BITMAP(p), c)
 746 #define ANYOF_BITMAP_SET(p, c)  (ANYOF_BITMAP_BYTE(p, c) |=  ANYOF_BIT(c))
 747 #define ANYOF_BITMAP_CLEAR(p,c) (ANYOF_BITMAP_BYTE(p, c) &= ~ANYOF_BIT(c))
 748 #define ANYOF_BITMAP_TEST(p, c) cBOOL(ANYOF_BITMAP_BYTE(p, c) &   ANYOF_BIT(c))
 749
 750 #define ANYOF_BITMAP_SETALL(p)          \
 751         memset (ANYOF_BITMAP(p), 255, ANYOF_BITMAP_SIZE)
 752 #define ANYOF_BITMAP_CLEARALL(p)        \
 753         Zero (ANYOF_BITMAP(p), ANYOF_BITMAP_SIZE)
 754
 755 /*
 756  * Utility definitions.
 757  */
 758 #ifndef CHARMASK
 759 #  define UCHARAT(p)    ((int)*(const U8*)(p))
 760 #else
 761 #  define UCHARAT(p)    ((int)*(p)&CHARMASK)
 762 #endif
 763
 764 /* Number of regnode equivalents that 'guy' occupies beyond the size of the
 765  * smallest regnode. */
 766 #define EXTRA_SIZE(guy) ((sizeof(guy)-1)/sizeof(struct regnode))
 767
 768 #define REG_ZERO_LEN_SEEN                   0x00000001
 769 #define REG_LOOKBEHIND_SEEN                 0x00000002
 770 #define REG_GPOS_SEEN                       0x00000004
 771 /* spare */
 772 #define REG_RECURSE_SEEN                    0x00000020
 773 #define REG_TOP_LEVEL_BRANCHES_SEEN         0x00000040
 774 #define REG_VERBARG_SEEN                    0x00000080
 775 #define REG_CUTGROUP_SEEN                   0x00000100
 776 #define REG_RUN_ON_COMMENT_SEEN             0x00000200
 777 #define REG_UNFOLDED_MULTI_SEEN             0x00000400
 778 /* spare */
 779 #define REG_UNBOUNDED_QUANTIFIER_SEEN       0x00001000
 780
 781
 782 START_EXTERN_C
 783
 784 #ifdef PLUGGABLE_RE_EXTENSION
 785 #include "re_nodes.h"
 786 #else
 787 #include "regnodes.h"
 788 #endif
 789
 790 #ifndef PLUGGABLE_RE_EXTENSION
 791 #ifndef DOINIT
 792 EXTCONST regexp_engine PL_core_reg_engine;
 793 #else /* DOINIT */
 794 EXTCONST regexp_engine PL_core_reg_engine = {
 795         Perl_re_compile,
 796         Perl_regexec_flags,
 797         Perl_re_intuit_start,
 798         Perl_re_intuit_string,
 799         Perl_regfree_internal,
 800         Perl_reg_numbered_buff_fetch,
 801         Perl_reg_numbered_buff_store,
 802         Perl_reg_numbered_buff_length,
 803         Perl_reg_named_buff,
 804         Perl_reg_named_buff_iter,
 805         Perl_reg_qr_package,
 806 #if defined(USE_ITHREADS)
 807         Perl_regdupe_internal,
 808 #endif
 809         Perl_re_op_compile
 810 };
 811 #endif /* DOINIT */
 812 #endif /* PLUGGABLE_RE_EXTENSION */
 813
 814
 815 END_EXTERN_C
 816
 817
 818 /* .what is a character array with one character for each member of .data
 819  * The character describes the function of the corresponding .data item:
 820  *   a - AV for paren_name_list under DEBUGGING
 821  *   f - start-class data for regstclass optimization
 822  *   l - start op for literal (?{EVAL}) item
 823  *   L - start op for literal (?{EVAL}) item, with separate CV (qr//)
 824  *   r - pointer to an embedded code-containing qr, e.g. /ab$qr/
 825  *   s - inversion list for Unicode-style character class, and the
 826  *       multicharacter strings resulting from casefolding the single-character
 827  *       entries in the character class
 828  *   t - trie struct
 829  *   u - trie struct's widecharmap (a HV, so can't share, must dup)
 830  *       also used for revcharmap and words under DEBUGGING
 831  *   T - aho-trie struct
 832  *   S - sv for named capture lookup
 833  * 20010712 mjd@plover.com
 834  * (Remember to update re_dup() and pregfree() if you add any items.)
 835  */
 836 struct reg_data {
 837     U32 count;
 838     U8 *what;
 839     void* data[1];
 840 };
 841
 842 /* Code in S_to_utf8_substr() and S_to_byte_substr() in regexec.c accesses
 843    anchored* and float* via array indexes 0 and 1.  */
 844 #define anchored_substr substrs->data[0].substr
 845 #define anchored_utf8 substrs->data[0].utf8_substr
 846 #define anchored_offset substrs->data[0].min_offset
 847 #define anchored_end_shift substrs->data[0].end_shift
 848
 849 #define float_substr substrs->data[1].substr
 850 #define float_utf8 substrs->data[1].utf8_substr
 851 #define float_min_offset substrs->data[1].min_offset
 852 #define float_max_offset substrs->data[1].max_offset
 853 #define float_end_shift substrs->data[1].end_shift
 854
 855 #define check_substr substrs->data[2].substr
 856 #define check_utf8 substrs->data[2].utf8_substr
 857 #define check_offset_min substrs->data[2].min_offset
 858 #define check_offset_max substrs->data[2].max_offset
 859 #define check_end_shift substrs->data[2].end_shift
 860
 861 #define RX_ANCHORED_SUBSTR(rx)  (ReANY(rx)->anchored_substr)
 862 #define RX_ANCHORED_UTF8(rx)    (ReANY(rx)->anchored_utf8)
 863 #define RX_FLOAT_SUBSTR(rx)     (ReANY(rx)->float_substr)
 864 #define RX_FLOAT_UTF8(rx)       (ReANY(rx)->float_utf8)
 865
 866 /* trie related stuff */
 867
 868 /* a transition record for the state machine. the
 869    check field determines which state "owns" the
 870    transition. the char the transition is for is
 871    determined by offset from the owning states base
 872    field.  the next field determines which state
 873    is to be transitioned to if any.
 874 */
 875 struct _reg_trie_trans {
 876   U32 next;
 877   U32 check;
 878 };
 879
 880 /* a transition list element for the list based representation */
 881 struct _reg_trie_trans_list_elem {
 882     U16 forid;
 883     U32 newstate;
 884 };
 885 typedef struct _reg_trie_trans_list_elem reg_trie_trans_le;
 886
 887 /* a state for compressed nodes. base is an offset
 888   into an array of reg_trie_trans array. If wordnum is
 889   nonzero the state is accepting. if base is zero then
 890   the state has no children (and will be accepting)
 891 */
 892 struct _reg_trie_state {
 893   U16 wordnum;
 894   union {
 895     U32                base;
 896     reg_trie_trans_le* list;
 897   } trans;
 898 };
 899
 900 /* info per word; indexed by wordnum */
 901 typedef struct {
 902     U16  prev;  /* previous word in acceptance chain; eg in
 903                  * zzz|abc|ab/ after matching the chars abc, the
 904                  * accepted word is #2, and the previous accepted
 905                  * word is #3 */
 906     U32 len;    /* how many chars long is this word? */
 907     U32 accept; /* accept state for this word */
 908 } reg_trie_wordinfo;
 909
 910
 911 typedef struct _reg_trie_state    reg_trie_state;
 912 typedef struct _reg_trie_trans    reg_trie_trans;
 913
 914
 915 /* anything in here that needs to be freed later
 916    should be dealt with in pregfree.
 917    refcount is first in both this and _reg_ac_data to allow a space
 918    optimisation in Perl_regdupe.  */
 919 struct _reg_trie_data {
 920     U32             refcount;        /* number of times this trie is referenced */
 921     U32             lasttrans;       /* last valid transition element */
 922     U16             *charmap;        /* byte to charid lookup array */
 923     reg_trie_state  *states;         /* state data */
 924     reg_trie_trans  *trans;          /* array of transition elements */
 925     char            *bitmap;         /* stclass bitmap */
 926     U16             *jump;           /* optional 1 indexed array of offsets before tail
 927                                         for the node following a given word. */
 928     reg_trie_wordinfo *wordinfo;     /* array of info per word */
 929     U16             uniquecharcount; /* unique chars in trie (width of trans table) */
 930     U32             startstate;      /* initial state - used for common prefix optimisation */
 931     STRLEN          minlen;          /* minimum length of words in trie - build/opt only? */
 932     STRLEN          maxlen;          /* maximum length of words in trie - build/opt only? */
 933     U32             prefixlen;       /* #chars in common prefix */
 934     U32             statecount;      /* Build only - number of states in the states array
 935                                         (including the unused zero state) */
 936     U32             wordcount;       /* Build only */
 937 #ifdef DEBUGGING
 938     STRLEN          charcount;       /* Build only */
 939 #endif
 940 };
 941 /* There is one (3 under DEBUGGING) pointers that logically belong in this
 942    structure, but are held outside as they need duplication on thread cloning,
 943    whereas the rest of the structure can be read only:
 944     HV              *widecharmap;    code points > 255 to charid
 945 #ifdef DEBUGGING
 946     AV              *words;          Array of words contained in trie, for dumping
 947     AV              *revcharmap;     Map of each charid back to its character representation
 948 #endif
 949 */
 950
 951 #define TRIE_WORDS_OFFSET 2
 952
 953 typedef struct _reg_trie_data reg_trie_data;
 954
 955 /* refcount is first in both this and _reg_trie_data to allow a space
 956    optimisation in Perl_regdupe.  */
 957 struct _reg_ac_data {
 958     U32              refcount;
 959     U32              trie;
 960     U32              *fail;
 961     reg_trie_state   *states;
 962 };
 963 typedef struct _reg_ac_data reg_ac_data;
 964
 965 /* ANY_BIT doesn't use the structure, so we can borrow it here.
 966    This is simpler than refactoring all of it as wed end up with
 967    three different sets... */
 968
 969 #define TRIE_BITMAP(p)          (((reg_trie_data *)(p))->bitmap)
 970 #define TRIE_BITMAP_BYTE(p, c)  BITMAP_BYTE(TRIE_BITMAP(p), c)
 971 #define TRIE_BITMAP_SET(p, c)   (TRIE_BITMAP_BYTE(p, c) |=  ANYOF_BIT((U8)c))
 972 #define TRIE_BITMAP_CLEAR(p,c)  (TRIE_BITMAP_BYTE(p, c) &= ~ANYOF_BIT((U8)c))
 973 #define TRIE_BITMAP_TEST(p, c)  (TRIE_BITMAP_BYTE(p, c) &   ANYOF_BIT((U8)c))
 974
 975 #define IS_ANYOF_TRIE(op) ((op)==TRIEC || (op)==AHOCORASICKC)
 976 #define IS_TRIE_AC(op) ((op)>=AHOCORASICK)
 977
 978
 979 #define BITMAP_BYTE(p, c)       (( (U8*) p) [ ( ( (UV) (c)) >> 3) ] )
 980 #define BITMAP_TEST(p, c)       (BITMAP_BYTE(p, c) &   ANYOF_BIT((U8)c))
 981
 982 /* these defines assume uniquecharcount is the correct variable, and state may be evaluated twice */
 983 #define TRIE_NODENUM(state) (((state)-1)/(trie->uniquecharcount)+1)
 984 #define SAFE_TRIE_NODENUM(state) ((state) ? (((state)-1)/(trie->uniquecharcount)+1) : (state))
 985 #define TRIE_NODEIDX(state) ((state) ? (((state)-1)*(trie->uniquecharcount)+1) : (state))
 986
 987 #ifdef DEBUGGING
 988 #define TRIE_CHARCOUNT(trie) ((trie)->charcount)
 989 #else
 990 #define TRIE_CHARCOUNT(trie) (trie_charcount)
 991 #endif
 992
 993 #define RE_TRIE_MAXBUF_INIT 65536
 994 #define RE_TRIE_MAXBUF_NAME "\022E_TRIE_MAXBUF"
 995 #define RE_DEBUG_FLAGS "\022E_DEBUG_FLAGS"
 996
 997 #define RE_COMPILE_RECURSION_INIT 1000
 998 #define RE_COMPILE_RECURSION_LIMIT "\022E_COMPILE_RECURSION_LIMIT"
 999
1000 /*
1001
1002 RE_DEBUG_FLAGS is used to control what debug output is emitted
1003 its divided into three groups of options, some of which interact.
1004 The three groups are: Compile, Execute, Extra. There is room for a
1005 further group, as currently only the low three bytes are used.
1006
1007     Compile Options:
1008
1009     PARSE
1010     PEEP
1011     TRIE
1012     PROGRAM
1013     OFFSETS
1014
1015     Execute Options:
1016
1017     INTUIT
1018     MATCH
1019     TRIE
1020
1021     Extra Options
1022
1023     TRIE
1024     OFFSETS
1025
1026 If you modify any of these make sure you make corresponding changes to
1027 re.pm, especially to the documentation.
1028
1029 */
1030
1031
1032 /* Compile */
1033 #define RE_DEBUG_COMPILE_MASK      0x0000FF
1034 #define RE_DEBUG_COMPILE_PARSE     0x000001
1035 #define RE_DEBUG_COMPILE_OPTIMISE  0x000002
1036 #define RE_DEBUG_COMPILE_TRIE      0x000004
1037 #define RE_DEBUG_COMPILE_DUMP      0x000008
1038 #define RE_DEBUG_COMPILE_FLAGS     0x000010
1039 #define RE_DEBUG_COMPILE_TEST      0x000020
1040
1041 /* Execute */
1042 #define RE_DEBUG_EXECUTE_MASK      0x00FF00
1043 #define RE_DEBUG_EXECUTE_INTUIT    0x000100
1044 #define RE_DEBUG_EXECUTE_MATCH     0x000200
1045 #define RE_DEBUG_EXECUTE_TRIE      0x000400
1046
1047 /* Extra */
1048 #define RE_DEBUG_EXTRA_MASK              0x1FF0000
1049 #define RE_DEBUG_EXTRA_TRIE              0x0010000
1050 #define RE_DEBUG_EXTRA_OFFSETS           0x0020000
1051 #define RE_DEBUG_EXTRA_OFFDEBUG          0x0040000
1052 #define RE_DEBUG_EXTRA_STATE             0x0080000
1053 #define RE_DEBUG_EXTRA_OPTIMISE          0x0100000
1054 #define RE_DEBUG_EXTRA_BUFFERS           0x0400000
1055 #define RE_DEBUG_EXTRA_GPOS              0x0800000
1056 #define RE_DEBUG_EXTRA_DUMP_PRE_OPTIMIZE 0x1000000
1057 /* combined */
1058 #define RE_DEBUG_EXTRA_STACK             0x0280000
1059
1060 #define RE_DEBUG_FLAG(x) (re_debug_flags & x)
1061 /* Compile */
1062 #define DEBUG_COMPILE_r(x) DEBUG_r( \
1063     if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_COMPILE_MASK)) x  )
1064 #define DEBUG_PARSE_r(x) DEBUG_r( \
1065     if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_COMPILE_PARSE)) x  )
1066 #define DEBUG_OPTIMISE_r(x) DEBUG_r( \
1067     if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_COMPILE_OPTIMISE)) x  )
1068 #define DEBUG_DUMP_r(x) DEBUG_r( \
1069     if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_COMPILE_DUMP)) x  )
1070 #define DEBUG_TRIE_COMPILE_r(x) DEBUG_r( \
1071     if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_COMPILE_TRIE)) x )
1072 #define DEBUG_FLAGS_r(x) DEBUG_r( \
1073     if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_COMPILE_FLAGS)) x )
1074 #define DEBUG_TEST_r(x) DEBUG_r( \
1075     if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_COMPILE_TEST)) x )
1076 /* Execute */
1077 #define DEBUG_EXECUTE_r(x) DEBUG_r( \
1078     if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_EXECUTE_MASK)) x  )
1079 #define DEBUG_INTUIT_r(x) DEBUG_r( \
1080     if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_EXECUTE_INTUIT)) x  )
1081 #define DEBUG_MATCH_r(x) DEBUG_r( \
1082     if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_EXECUTE_MATCH)) x  )
1083 #define DEBUG_TRIE_EXECUTE_r(x) DEBUG_r( \
1084     if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_EXECUTE_TRIE)) x )
1085
1086 /* Extra */
1087 #define DEBUG_EXTRA_r(x) DEBUG_r( \
1088     if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_EXTRA_MASK)) x  )
1089 #define DEBUG_OFFSETS_r(x) DEBUG_r( \
1090     if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_EXTRA_OFFSETS)) x  )
1091 #define DEBUG_STATE_r(x) DEBUG_r( \
1092     if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_EXTRA_STATE)) x )
1093 #define DEBUG_STACK_r(x) DEBUG_r( \
1094     if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_EXTRA_STACK)) x )
1095 #define DEBUG_BUFFERS_r(x) DEBUG_r( \
1096     if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_EXTRA_BUFFERS)) x )
1097
1098 #define DEBUG_OPTIMISE_MORE_r(x) DEBUG_r( \
1099     if (DEBUG_v_TEST || ((RE_DEBUG_EXTRA_OPTIMISE|RE_DEBUG_COMPILE_OPTIMISE) == \
1100          (re_debug_flags & (RE_DEBUG_EXTRA_OPTIMISE|RE_DEBUG_COMPILE_OPTIMISE)))) x )
1101 #define MJD_OFFSET_DEBUG(x) DEBUG_r( \
1102     if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_EXTRA_OFFDEBUG)) \
1103         Perl_warn_nocontext x )
1104 #define DEBUG_TRIE_COMPILE_MORE_r(x) DEBUG_TRIE_COMPILE_r( \
1105     if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_EXTRA_TRIE)) x )
1106 #define DEBUG_TRIE_EXECUTE_MORE_r(x) DEBUG_TRIE_EXECUTE_r( \
1107     if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_EXTRA_TRIE)) x )
1108
1109 #define DEBUG_TRIE_r(x) DEBUG_r( \
1110     if (DEBUG_v_TEST || (re_debug_flags & (RE_DEBUG_COMPILE_TRIE \
1111         | RE_DEBUG_EXECUTE_TRIE ))) x )
1112 #define DEBUG_GPOS_r(x) DEBUG_r( \
1113     if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_EXTRA_GPOS)) x )
1114
1115 #define DEBUG_DUMP_PRE_OPTIMIZE_r(x) DEBUG_r( \
1116     if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_EXTRA_DUMP_PRE_OPTIMIZE)) x )
1117
1118 /* initialization */
1119 /* get_sv() can return NULL during global destruction. */
1120 #define GET_RE_DEBUG_FLAGS DEBUG_r({ \
1121         SV * re_debug_flags_sv = NULL; \
1122         re_debug_flags_sv = PL_curcop ? get_sv(RE_DEBUG_FLAGS, GV_ADD) : NULL; \
1123         if (re_debug_flags_sv) { \
1124             if (!SvIOK(re_debug_flags_sv)) \
1125                 sv_setuv(re_debug_flags_sv, RE_DEBUG_COMPILE_DUMP | RE_DEBUG_EXECUTE_MASK ); \
1126             re_debug_flags=SvIV(re_debug_flags_sv); \
1127         }\
1128 })
1129
1130 #ifdef DEBUGGING
1131
1132 #define GET_RE_DEBUG_FLAGS_DECL volatile IV re_debug_flags = 0; \
1133         PERL_UNUSED_VAR(re_debug_flags); GET_RE_DEBUG_FLAGS;
1134
1135 #define RE_PV_COLOR_DECL(rpv,rlen,isuni,dsv,pv,l,m,c1,c2)   \
1136     const char * const rpv =                                \
1137         pv_pretty((dsv), (pv), (l), (m),                    \
1138             PL_colors[(c1)],PL_colors[(c2)],                \
1139             PERL_PV_ESCAPE_RE|PERL_PV_ESCAPE_NONASCII |((isuni) ? PERL_PV_ESCAPE_UNI : 0) );         \
1140     const int rlen = SvCUR(dsv)
1141
1142 /* This is currently unsed in the core */
1143 #define RE_SV_ESCAPE(rpv,isuni,dsv,sv,m)                            \
1144     const char * const rpv =                                        \
1145         pv_pretty((dsv), (SvPV_nolen_const(sv)), (SvCUR(sv)), (m),  \
1146             PL_colors[(c1)],PL_colors[(c2)],                        \
1147             PERL_PV_ESCAPE_RE|PERL_PV_ESCAPE_NONASCII |((isuni) ? PERL_PV_ESCAPE_UNI : 0) )
1148
1149 #define RE_PV_QUOTED_DECL(rpv,isuni,dsv,pv,l,m)                     \
1150     const char * const rpv =                                        \
1151         pv_pretty((dsv), (pv), (l), (m),                            \
1152             PL_colors[0], PL_colors[1],                             \
1153             ( PERL_PV_PRETTY_QUOTE | PERL_PV_ESCAPE_RE | PERL_PV_ESCAPE_NONASCII | PERL_PV_PRETTY_ELLIPSES | \
1154               ((isuni) ? PERL_PV_ESCAPE_UNI : 0))                  \
1155         )
1156
1157 #define RE_SV_DUMPLEN(ItEm) (SvCUR(ItEm) - (SvTAIL(ItEm)!=0))
1158 #define RE_SV_TAIL(ItEm) (SvTAIL(ItEm) ? "$" : "")
1159
1160 #else /* if not DEBUGGING */
1161
1162 #define GET_RE_DEBUG_FLAGS_DECL
1163 #define RE_PV_COLOR_DECL(rpv,rlen,isuni,dsv,pv,l,m,c1,c2)
1164 #define RE_SV_ESCAPE(rpv,isuni,dsv,sv,m)
1165 #define RE_PV_QUOTED_DECL(rpv,isuni,dsv,pv,l,m)
1166 #define RE_SV_DUMPLEN(ItEm)
1167 #define RE_SV_TAIL(ItEm)
1168
1169 #endif /* DEBUG RELATED DEFINES */
1170
1171 #define FIRST_NON_ASCII_DECIMAL_DIGIT 0x660  /* ARABIC_INDIC_DIGIT_ZERO */
1172
1173 typedef enum {
1174         TRADITIONAL_BOUND = _CC_WORDCHAR,
1175         GCB_BOUND,
1176         LB_BOUND,
1177         SB_BOUND,
1178         WB_BOUND
1179 } bound_type;
1180
1181 /* This unpacks the FLAGS field of ANYOFHx nodes.  The value it contains
1182  * gives the strict lower bound for the UTF-8 start byte of any code point
1183  * matchable by the node, and a loose upper bound as well.
1184  *
1185  * The low bound is stored in the upper 6 bits, plus 0xC0.
1186  * The loose upper bound is determined from the lowest 2 bits and the low bound
1187  * (called x) as follows:
1188  *
1189  * 11  The upper limit of the range can be as much as (EF - x) / 8
1190  * 10  The upper limit of the range can be as much as (EF - x) / 4
1191  * 01  The upper limit of the range can be as much as (EF - x) / 2
1192  * 00  The upper limit of the range can be as much as  EF
1193  *
1194  * For motivation of this design, see commit message in
1195  * 3146c00a633e9cbed741e10146662fbcedfdb8d3 */
1196 #ifdef EBCDIC
1197 #  define MAX_ANYOF_HRx_BYTE  0xF4
1198 #else
1199 #  define MAX_ANYOF_HRx_BYTE  0xEF
1200 #endif
1201 #define LOWEST_ANYOF_HRx_BYTE(b) (((b) >> 2) + 0xC0)
1202 #define HIGHEST_ANYOF_HRx_BYTE(b)                                           \
1203                                   (LOWEST_ANYOF_HRx_BYTE(b)                 \
1204           + ((MAX_ANYOF_HRx_BYTE - LOWEST_ANYOF_HRx_BYTE(b)) >> ((b) & 3)))
1205
1206 #endif /* PERL_REGCOMP_H_ */
1207
1208 /*
1209  * ex: set ts=8 sts=4 sw=4 et:
1210  */