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