This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
regcomp.h: Reorder statements for clarity
[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_LOCALE            0x01
318 #define ANYOF_FOLD              0x02
319 #define ANYOF_INVERT            0x04
320
321 /* CLASS is never set unless LOCALE is too: has runtime \d, \w, [:posix:], ... */
322 #define ANYOF_CLASS             0x08
323 #define ANYOF_LARGE      ANYOF_CLASS    /* Same; name retained for back compat */
324
325 /* EOS used for regstclass only */
326 #define ANYOF_EOS               0x10    /* Can match an empty string too */
327
328 #define ANYOF_UNICODE           0x20    /* Matches >= one thing past 0xff */
329 #define ANYOF_UNICODE_ALL       0x40    /* Matches 0x100 - infinity */
330
331 #define ANYOF_FLAGS_ALL         0xff
332
333 /* Character classes for node->classflags of ANYOF */
334 /* Should be synchronized with a table in regprop() */
335 /* 2n should pair with 2n+1 */
336
337 #define ANYOF_ALNUM      0      /* \w, PL_utf8_alnum, utf8::IsWord, ALNUM */
338 #define ANYOF_NALNUM     1
339 #define ANYOF_SPACE      2      /* \s */
340 #define ANYOF_NSPACE     3
341 #define ANYOF_DIGIT      4      /* \d */
342 #define ANYOF_NDIGIT     5
343 #define ANYOF_ALNUMC     6      /* [[:alnum:]] isalnum(3), utf8::IsAlnum, ALNUMC */
344 #define ANYOF_NALNUMC    7
345 #define ANYOF_ALPHA      8
346 #define ANYOF_NALPHA     9
347 #define ANYOF_ASCII     10
348 #define ANYOF_NASCII    11
349 #define ANYOF_CNTRL     12
350 #define ANYOF_NCNTRL    13
351 #define ANYOF_GRAPH     14
352 #define ANYOF_NGRAPH    15
353 #define ANYOF_LOWER     16
354 #define ANYOF_NLOWER    17
355 #define ANYOF_PRINT     18
356 #define ANYOF_NPRINT    19
357 #define ANYOF_PUNCT     20
358 #define ANYOF_NPUNCT    21
359 #define ANYOF_UPPER     22
360 #define ANYOF_NUPPER    23
361 #define ANYOF_XDIGIT    24
362 #define ANYOF_NXDIGIT   25
363 #define ANYOF_PSXSPC    26      /* POSIX space: \s plus the vertical tab */
364 #define ANYOF_NPSXSPC   27
365 #define ANYOF_BLANK     28      /* GNU extension: space and tab: non-vertical space */
366 #define ANYOF_NBLANK    29
367
368 #define ANYOF_MAX       32
369
370 /* pseudo classes, not stored in the class bitmap, but used as flags
371    during compilation of char classes */
372
373 #define ANYOF_VERTWS    (ANYOF_MAX+1)
374 #define ANYOF_NVERTWS   (ANYOF_MAX+2)
375 #define ANYOF_HORIZWS   (ANYOF_MAX+3)
376 #define ANYOF_NHORIZWS  (ANYOF_MAX+4)
377
378 /* Backward source code compatibility. */
379
380 #define ANYOF_ALNUML     ANYOF_ALNUM
381 #define ANYOF_NALNUML    ANYOF_NALNUM
382 #define ANYOF_SPACEL     ANYOF_SPACE
383 #define ANYOF_NSPACEL    ANYOF_NSPACE
384
385 /* Utility macros for the bitmap and classes of ANYOF */
386
387 #define ANYOF_SIZE              (sizeof(struct regnode_charclass))
388 #define ANYOF_CLASS_SIZE        (sizeof(struct regnode_charclass_class))
389
390 #define ANYOF_FLAGS(p)          ((p)->flags)
391
392 #define ANYOF_BIT(c)            (1 << ((c) & 7))
393
394 #define ANYOF_CLASS_BYTE(p, c)  (((struct regnode_charclass_class*)(p))->classflags[((c) >> 3) & 3])
395 #define ANYOF_CLASS_SET(p, c)   (ANYOF_CLASS_BYTE(p, c) |=  ANYOF_BIT(c))
396 #define ANYOF_CLASS_CLEAR(p, c) (ANYOF_CLASS_BYTE(p, c) &= ~ANYOF_BIT(c))
397 #define ANYOF_CLASS_TEST(p, c)  (ANYOF_CLASS_BYTE(p, c) &   ANYOF_BIT(c))
398
399 #define ANYOF_CLASS_ZERO(ret)   Zero(((struct regnode_charclass_class*)(ret))->classflags, ANYOF_CLASSBITMAP_SIZE, char)
400 #define ANYOF_BITMAP_ZERO(ret)  Zero(((struct regnode_charclass*)(ret))->bitmap, ANYOF_BITMAP_SIZE, char)
401
402 #define ANYOF_BITMAP(p)         (((struct regnode_charclass*)(p))->bitmap)
403 #define ANYOF_BITMAP_BYTE(p, c) (ANYOF_BITMAP(p)[(((U8)(c)) >> 3) & 31])
404 #define ANYOF_BITMAP_SET(p, c)  (ANYOF_BITMAP_BYTE(p, c) |=  ANYOF_BIT(c))
405 #define ANYOF_BITMAP_CLEAR(p,c) (ANYOF_BITMAP_BYTE(p, c) &= ~ANYOF_BIT(c))
406 #define ANYOF_BITMAP_TEST(p, c) (ANYOF_BITMAP_BYTE(p, c) &   ANYOF_BIT(c))
407
408 #define ANYOF_BITMAP_SETALL(p)          \
409         memset (ANYOF_BITMAP(p), 255, ANYOF_BITMAP_SIZE)
410 #define ANYOF_BITMAP_CLEARALL(p)        \
411         Zero (ANYOF_BITMAP(p), ANYOF_BITMAP_SIZE)
412 /* Check that all 256 bits are all set.  Used in S_cl_is_anything()  */
413 #define ANYOF_BITMAP_TESTALLSET(p)      \
414         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)
415
416 #define ANYOF_SKIP              ((ANYOF_SIZE - 1)/sizeof(regnode))
417 #define ANYOF_CLASS_SKIP        ((ANYOF_CLASS_SIZE - 1)/sizeof(regnode))
418 #define ANYOF_CLASS_ADD_SKIP    (ANYOF_CLASS_SKIP - ANYOF_SKIP)
419
420
421 /*
422  * Utility definitions.
423  */
424 #ifndef CHARMASK
425 #  define UCHARAT(p)    ((int)*(const U8*)(p))
426 #else
427 #  define UCHARAT(p)    ((int)*(p)&CHARMASK)
428 #endif
429
430 #define EXTRA_SIZE(guy) ((sizeof(guy)-1)/sizeof(struct regnode))
431
432 #define REG_SEEN_ZERO_LEN       0x00000001
433 #define REG_SEEN_LOOKBEHIND     0x00000002
434 #define REG_SEEN_GPOS           0x00000004
435 #define REG_SEEN_EVAL           0x00000008
436 #define REG_SEEN_CANY           0x00000010
437 #define REG_SEEN_SANY           REG_SEEN_CANY /* src bckwrd cmpt */
438 #define REG_SEEN_RECURSE        0x00000020
439 #define REG_TOP_LEVEL_BRANCHES  0x00000040
440 #define REG_SEEN_VERBARG        0x00000080
441 #define REG_SEEN_CUTGROUP       0x00000100
442 #define REG_SEEN_RUN_ON_COMMENT 0x00000200
443
444 START_EXTERN_C
445
446 #ifdef PLUGGABLE_RE_EXTENSION
447 #include "re_nodes.h"
448 #else
449 #include "regnodes.h"
450 #endif
451
452 #ifndef PLUGGABLE_RE_EXTENSION
453 #ifndef DOINIT
454 EXTCONST regexp_engine PL_core_reg_engine;
455 #else /* DOINIT */
456 EXTCONST regexp_engine PL_core_reg_engine = { 
457         Perl_re_compile,
458         Perl_regexec_flags,
459         Perl_re_intuit_start,
460         Perl_re_intuit_string, 
461         Perl_regfree_internal,
462         Perl_reg_numbered_buff_fetch,
463         Perl_reg_numbered_buff_store,
464         Perl_reg_numbered_buff_length,
465         Perl_reg_named_buff,
466         Perl_reg_named_buff_iter,
467         Perl_reg_qr_package,
468 #if defined(USE_ITHREADS)        
469         Perl_regdupe_internal
470 #endif        
471 };
472 #endif /* DOINIT */
473 #endif /* PLUGGABLE_RE_EXTENSION */
474
475
476 END_EXTERN_C
477
478
479 /* .what is a character array with one character for each member of .data
480  * The character describes the function of the corresponding .data item:
481  *   a - AV for paren_name_list under DEBUGGING
482  *   f - start-class data for regstclass optimization
483  *   n - Root of op tree for (?{EVAL}) item
484  *   o - Start op for (?{EVAL}) item
485  *   p - Pad for (?{EVAL}) item
486  *   s - swash for Unicode-style character class, and the multicharacter
487  *       strings resulting from casefolding the single-character entries
488  *       in the character class
489  *   t - trie struct
490  *   u - trie struct's widecharmap (a HV, so can't share, must dup)
491  *       also used for revcharmap and words under DEBUGGING
492  *   T - aho-trie struct
493  *   S - sv for named capture lookup
494  * 20010712 mjd@plover.com
495  * (Remember to update re_dup() and pregfree() if you add any items.)
496  */
497 struct reg_data {
498     U32 count;
499     U8 *what;
500     void* data[1];
501 };
502
503 /* Code in S_to_utf8_substr() and S_to_byte_substr() in regexec.c accesses
504    anchored* and float* via array indexes 0 and 1.  */
505 #define anchored_substr substrs->data[0].substr
506 #define anchored_utf8 substrs->data[0].utf8_substr
507 #define anchored_offset substrs->data[0].min_offset
508 #define anchored_end_shift substrs->data[0].end_shift
509
510 #define float_substr substrs->data[1].substr
511 #define float_utf8 substrs->data[1].utf8_substr
512 #define float_min_offset substrs->data[1].min_offset
513 #define float_max_offset substrs->data[1].max_offset
514 #define float_end_shift substrs->data[1].end_shift
515
516 #define check_substr substrs->data[2].substr
517 #define check_utf8 substrs->data[2].utf8_substr
518 #define check_offset_min substrs->data[2].min_offset
519 #define check_offset_max substrs->data[2].max_offset
520 #define check_end_shift substrs->data[2].end_shift
521
522 #define RX_ANCHORED_SUBSTR(rx)  (((struct regexp *)SvANY(rx))->anchored_substr)
523 #define RX_ANCHORED_UTF8(rx)    (((struct regexp *)SvANY(rx))->anchored_utf8)
524 #define RX_FLOAT_SUBSTR(rx)     (((struct regexp *)SvANY(rx))->float_substr)
525 #define RX_FLOAT_UTF8(rx)       (((struct regexp *)SvANY(rx))->float_utf8)
526
527 /* trie related stuff */
528
529 /* a transition record for the state machine. the
530    check field determines which state "owns" the
531    transition. the char the transition is for is
532    determined by offset from the owning states base
533    field.  the next field determines which state
534    is to be transitioned to if any.
535 */
536 struct _reg_trie_trans {
537   U32 next;
538   U32 check;
539 };
540
541 /* a transition list element for the list based representation */
542 struct _reg_trie_trans_list_elem {
543     U16 forid;
544     U32 newstate;
545 };
546 typedef struct _reg_trie_trans_list_elem reg_trie_trans_le;
547
548 /* a state for compressed nodes. base is an offset
549   into an array of reg_trie_trans array. If wordnum is
550   nonzero the state is accepting. if base is zero then
551   the state has no children (and will be accepting)
552 */
553 struct _reg_trie_state {
554   U16 wordnum;
555   union {
556     U32                base;
557     reg_trie_trans_le* list;
558   } trans;
559 };
560
561 /* info per word; indexed by wordnum */
562 typedef struct {
563     U16  prev;  /* previous word in acceptance chain; eg in
564                  * zzz|abc|ab/ after matching the chars abc, the
565                  * accepted word is #2, and the previous accepted
566                  * word is #3 */
567     U32 len;    /* how many chars long is this word? */
568     U32 accept; /* accept state for this word */
569 } reg_trie_wordinfo;
570
571
572 typedef struct _reg_trie_state    reg_trie_state;
573 typedef struct _reg_trie_trans    reg_trie_trans;
574
575
576 /* anything in here that needs to be freed later
577    should be dealt with in pregfree.
578    refcount is first in both this and _reg_ac_data to allow a space
579    optimisation in Perl_regdupe.  */
580 struct _reg_trie_data {
581     U32             refcount;        /* number of times this trie is referenced */
582     U32             lasttrans;       /* last valid transition element */
583     U16             *charmap;        /* byte to charid lookup array */
584     reg_trie_state  *states;         /* state data */
585     reg_trie_trans  *trans;          /* array of transition elements */
586     char            *bitmap;         /* stclass bitmap */
587     U16             *jump;           /* optional 1 indexed array of offsets before tail 
588                                         for the node following a given word. */
589     reg_trie_wordinfo *wordinfo;     /* array of info per word */
590     U16             uniquecharcount; /* unique chars in trie (width of trans table) */
591     U32             startstate;      /* initial state - used for common prefix optimisation */
592     STRLEN          minlen;          /* minimum length of words in trie - build/opt only? */
593     STRLEN          maxlen;          /* maximum length of words in trie - build/opt only? */
594     U32             prefixlen;       /* #chars in common prefix */
595     U32             statecount;      /* Build only - number of states in the states array 
596                                         (including the unused zero state) */
597     U32             wordcount;       /* Build only */
598 #ifdef DEBUGGING
599     STRLEN          charcount;       /* Build only */
600 #endif
601 };
602 /* There is one (3 under DEBUGGING) pointers that logically belong in this
603    structure, but are held outside as they need duplication on thread cloning,
604    whereas the rest of the structure can be read only:
605     HV              *widecharmap;    code points > 255 to charid
606 #ifdef DEBUGGING
607     AV              *words;          Array of words contained in trie, for dumping
608     AV              *revcharmap;     Map of each charid back to its character representation
609 #endif
610 */
611
612 #define TRIE_WORDS_OFFSET 2
613
614 typedef struct _reg_trie_data reg_trie_data;
615
616 /* refcount is first in both this and _reg_trie_data to allow a space
617    optimisation in Perl_regdupe.  */
618 struct _reg_ac_data {
619     U32              refcount;
620     U32              trie;
621     U32              *fail;
622     reg_trie_state   *states;
623 };
624 typedef struct _reg_ac_data reg_ac_data;
625
626 /* ANY_BIT doesnt use the structure, so we can borrow it here.
627    This is simpler than refactoring all of it as wed end up with
628    three different sets... */
629
630 #define TRIE_BITMAP(p)          (((reg_trie_data *)(p))->bitmap)
631 #define TRIE_BITMAP_BYTE(p, c)  (TRIE_BITMAP(p)[(((U8)(c)) >> 3) & 31])
632 #define TRIE_BITMAP_SET(p, c)   (TRIE_BITMAP_BYTE(p, c) |=  ANYOF_BIT((U8)c))
633 #define TRIE_BITMAP_CLEAR(p,c)  (TRIE_BITMAP_BYTE(p, c) &= ~ANYOF_BIT((U8)c))
634 #define TRIE_BITMAP_TEST(p, c)  (TRIE_BITMAP_BYTE(p, c) &   ANYOF_BIT((U8)c))
635
636 #define IS_ANYOF_TRIE(op) ((op)==TRIEC || (op)==AHOCORASICKC)
637 #define IS_TRIE_AC(op) ((op)>=AHOCORASICK)
638
639
640 #define BITMAP_BYTE(p, c)       (((U8*)p)[(((U8)(c)) >> 3) & 31])
641 #define BITMAP_TEST(p, c)       (BITMAP_BYTE(p, c) &   ANYOF_BIT((U8)c))
642
643 /* these defines assume uniquecharcount is the correct variable, and state may be evaluated twice */
644 #define TRIE_NODENUM(state) (((state)-1)/(trie->uniquecharcount)+1)
645 #define SAFE_TRIE_NODENUM(state) ((state) ? (((state)-1)/(trie->uniquecharcount)+1) : (state))
646 #define TRIE_NODEIDX(state) ((state) ? (((state)-1)*(trie->uniquecharcount)+1) : (state))
647
648 #ifdef DEBUGGING
649 #define TRIE_CHARCOUNT(trie) ((trie)->charcount)
650 #else
651 #define TRIE_CHARCOUNT(trie) (trie_charcount)
652 #endif
653
654 #define RE_TRIE_MAXBUF_INIT 65536
655 #define RE_TRIE_MAXBUF_NAME "\022E_TRIE_MAXBUF"
656 #define RE_DEBUG_FLAGS "\022E_DEBUG_FLAGS"
657
658 /*
659
660 RE_DEBUG_FLAGS is used to control what debug output is emitted
661 its divided into three groups of options, some of which interact.
662 The three groups are: Compile, Execute, Extra. There is room for a
663 further group, as currently only the low three bytes are used.
664
665     Compile Options:
666     
667     PARSE
668     PEEP
669     TRIE
670     PROGRAM
671     OFFSETS
672
673     Execute Options:
674
675     INTUIT
676     MATCH
677     TRIE
678
679     Extra Options
680
681     TRIE
682     OFFSETS
683
684 If you modify any of these make sure you make corresponding changes to
685 re.pm, especially to the documentation.
686
687 */
688
689
690 /* Compile */
691 #define RE_DEBUG_COMPILE_MASK      0x0000FF
692 #define RE_DEBUG_COMPILE_PARSE     0x000001
693 #define RE_DEBUG_COMPILE_OPTIMISE  0x000002
694 #define RE_DEBUG_COMPILE_TRIE      0x000004
695 #define RE_DEBUG_COMPILE_DUMP      0x000008
696 #define RE_DEBUG_COMPILE_FLAGS     0x000010
697
698 /* Execute */
699 #define RE_DEBUG_EXECUTE_MASK      0x00FF00
700 #define RE_DEBUG_EXECUTE_INTUIT    0x000100
701 #define RE_DEBUG_EXECUTE_MATCH     0x000200
702 #define RE_DEBUG_EXECUTE_TRIE      0x000400
703
704 /* Extra */
705 #define RE_DEBUG_EXTRA_MASK        0xFF0000
706 #define RE_DEBUG_EXTRA_TRIE        0x010000
707 #define RE_DEBUG_EXTRA_OFFSETS     0x020000
708 #define RE_DEBUG_EXTRA_OFFDEBUG    0x040000
709 #define RE_DEBUG_EXTRA_STATE       0x080000
710 #define RE_DEBUG_EXTRA_OPTIMISE    0x100000
711 #define RE_DEBUG_EXTRA_BUFFERS     0x400000
712 #define RE_DEBUG_EXTRA_GPOS        0x800000
713 /* combined */
714 #define RE_DEBUG_EXTRA_STACK       0x280000
715
716 #define RE_DEBUG_FLAG(x) (re_debug_flags & x)
717 /* Compile */
718 #define DEBUG_COMPILE_r(x) DEBUG_r( \
719     if (re_debug_flags & RE_DEBUG_COMPILE_MASK) x  )
720 #define DEBUG_PARSE_r(x) DEBUG_r( \
721     if (re_debug_flags & RE_DEBUG_COMPILE_PARSE) x  )
722 #define DEBUG_OPTIMISE_r(x) DEBUG_r( \
723     if (re_debug_flags & RE_DEBUG_COMPILE_OPTIMISE) x  )
724 #define DEBUG_PARSE_r(x) DEBUG_r( \
725     if (re_debug_flags & RE_DEBUG_COMPILE_PARSE) x  )
726 #define DEBUG_DUMP_r(x) DEBUG_r( \
727     if (re_debug_flags & RE_DEBUG_COMPILE_DUMP) x  )
728 #define DEBUG_TRIE_COMPILE_r(x) DEBUG_r( \
729     if (re_debug_flags & RE_DEBUG_COMPILE_TRIE) x )
730 #define DEBUG_FLAGS_r(x) DEBUG_r( \
731     if (re_debug_flags & RE_DEBUG_COMPILE_FLAGS) x )
732 /* Execute */
733 #define DEBUG_EXECUTE_r(x) DEBUG_r( \
734     if (re_debug_flags & RE_DEBUG_EXECUTE_MASK) x  )
735 #define DEBUG_INTUIT_r(x) DEBUG_r( \
736     if (re_debug_flags & RE_DEBUG_EXECUTE_INTUIT) x  )
737 #define DEBUG_MATCH_r(x) DEBUG_r( \
738     if (re_debug_flags & RE_DEBUG_EXECUTE_MATCH) x  )
739 #define DEBUG_TRIE_EXECUTE_r(x) DEBUG_r( \
740     if (re_debug_flags & RE_DEBUG_EXECUTE_TRIE) x )
741
742 /* Extra */
743 #define DEBUG_EXTRA_r(x) DEBUG_r( \
744     if (re_debug_flags & RE_DEBUG_EXTRA_MASK) x  )
745 #define DEBUG_OFFSETS_r(x) DEBUG_r( \
746     if (re_debug_flags & RE_DEBUG_EXTRA_OFFSETS) x  )
747 #define DEBUG_STATE_r(x) DEBUG_r( \
748     if (re_debug_flags & RE_DEBUG_EXTRA_STATE) x )
749 #define DEBUG_STACK_r(x) DEBUG_r( \
750     if (re_debug_flags & RE_DEBUG_EXTRA_STACK) x )
751 #define DEBUG_BUFFERS_r(x) DEBUG_r( \
752     if (re_debug_flags & RE_DEBUG_EXTRA_BUFFERS) x )
753
754 #define DEBUG_OPTIMISE_MORE_r(x) DEBUG_r( \
755     if ((RE_DEBUG_EXTRA_OPTIMISE|RE_DEBUG_COMPILE_OPTIMISE) == \
756          (re_debug_flags & (RE_DEBUG_EXTRA_OPTIMISE|RE_DEBUG_COMPILE_OPTIMISE)) ) x )
757 #define MJD_OFFSET_DEBUG(x) DEBUG_r( \
758     if (re_debug_flags & RE_DEBUG_EXTRA_OFFDEBUG) \
759         Perl_warn_nocontext x )
760 #define DEBUG_TRIE_COMPILE_MORE_r(x) DEBUG_TRIE_COMPILE_r( \
761     if (re_debug_flags & RE_DEBUG_EXTRA_TRIE) x )
762 #define DEBUG_TRIE_EXECUTE_MORE_r(x) DEBUG_TRIE_EXECUTE_r( \
763     if (re_debug_flags & RE_DEBUG_EXTRA_TRIE) x )
764
765 #define DEBUG_TRIE_r(x) DEBUG_r( \
766     if (re_debug_flags & (RE_DEBUG_COMPILE_TRIE \
767         | RE_DEBUG_EXECUTE_TRIE )) x )
768 #define DEBUG_GPOS_r(x) DEBUG_r( \
769     if (re_debug_flags & RE_DEBUG_EXTRA_GPOS) x )
770
771 /* initialization */
772 /* get_sv() can return NULL during global destruction.  re_debug_flags can get
773  * clobbered by a longjmp, so must be initialized */
774 #define GET_RE_DEBUG_FLAGS DEBUG_r({ \
775         SV * re_debug_flags_sv = NULL; \
776         re_debug_flags = 0;            \
777         re_debug_flags_sv = get_sv(RE_DEBUG_FLAGS, 1); \
778         if (re_debug_flags_sv) { \
779             if (!SvIOK(re_debug_flags_sv)) \
780                 sv_setuv(re_debug_flags_sv, RE_DEBUG_COMPILE_DUMP | RE_DEBUG_EXECUTE_MASK ); \
781             re_debug_flags=SvIV(re_debug_flags_sv); \
782         }\
783 })
784
785 #ifdef DEBUGGING
786
787 #define GET_RE_DEBUG_FLAGS_DECL VOL IV re_debug_flags = 0; GET_RE_DEBUG_FLAGS;
788
789 #define RE_PV_COLOR_DECL(rpv,rlen,isuni,dsv,pv,l,m,c1,c2) \
790     const char * const rpv =                          \
791         pv_pretty((dsv), (pv), (l), (m), \
792             PL_colors[(c1)],PL_colors[(c2)], \
793             PERL_PV_ESCAPE_RE |((isuni) ? PERL_PV_ESCAPE_UNI : 0) );         \
794     const int rlen = SvCUR(dsv)
795
796 #define RE_SV_ESCAPE(rpv,isuni,dsv,sv,m) \
797     const char * const rpv =                          \
798         pv_pretty((dsv), (SvPV_nolen_const(sv)), (SvCUR(sv)), (m), \
799             PL_colors[(c1)],PL_colors[(c2)], \
800             PERL_PV_ESCAPE_RE |((isuni) ? PERL_PV_ESCAPE_UNI : 0) )
801
802 #define RE_PV_QUOTED_DECL(rpv,isuni,dsv,pv,l,m)                    \
803     const char * const rpv =                                       \
804         pv_pretty((dsv), (pv), (l), (m), \
805             PL_colors[0], PL_colors[1], \
806             ( PERL_PV_PRETTY_QUOTE | PERL_PV_ESCAPE_RE | PERL_PV_PRETTY_ELLIPSES | \
807               ((isuni) ? PERL_PV_ESCAPE_UNI : 0))                  \
808         )
809
810 #define RE_SV_DUMPLEN(ItEm) (SvCUR(ItEm) - (SvTAIL(ItEm)!=0))
811 #define RE_SV_TAIL(ItEm) (SvTAIL(ItEm) ? "$" : "")
812     
813 #else /* if not DEBUGGING */
814
815 #define GET_RE_DEBUG_FLAGS_DECL
816 #define RE_PV_COLOR_DECL(rpv,rlen,isuni,dsv,pv,l,m,c1,c2)
817 #define RE_SV_ESCAPE(rpv,isuni,dsv,sv,m)
818 #define RE_PV_QUOTED_DECL(rpv,isuni,dsv,pv,l,m)
819 #define RE_SV_DUMPLEN(ItEm)
820 #define RE_SV_TAIL(ItEm)
821
822 #endif /* DEBUG RELATED DEFINES */
823
824 /*
825  * Local variables:
826  * c-indentation-style: bsd
827  * c-basic-offset: 4
828  * indent-tabs-mode: t
829  * End:
830  *
831  * ex: set ts=8 sts=4 sw=4 noet:
832  */