regcomp.h

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