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