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