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