Rename regex flag bit for clarity
[perl.git] / regcomp.h
1 /*    regcomp.h
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
4  *    2000, 2001, 2002, 2003, 2005, 2006, 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* */
195 struct regnode_ssc {
196     U8  flags;                          /* ANYOF_POSIXL bit must go here */
197     U8  type;
198     U16 next_off;
199     U32 arg1;                           /* used as ptr in S_regclass */
200     char bitmap[ANYOF_BITMAP_SIZE];     /* both compile-time */
201     U32 classflags;                     /* and run-time */
202     SV* invlist;                        /* list of code points matched */
203 };
204
205 /* XXX fix this description.
206    Impose a limit of REG_INFTY on various pattern matching operations
207    to limit stack growth and to avoid "infinite" recursions.
208 */
209 /* The default size for REG_INFTY is I16_MAX, which is the same as
210    SHORT_MAX (see perl.h).  Unfortunately I16 isn't necessarily 16 bits
211    (see handy.h).  On the Cray C90, sizeof(short)==4 and hence I16_MAX is
212    ((1<<31)-1), while on the Cray T90, sizeof(short)==8 and I16_MAX is
213    ((1<<63)-1).  To limit stack growth to reasonable sizes, supply a
214    smaller default.
215         --Andy Dougherty  11 June 1998
216 */
217 #if SHORTSIZE > 2
218 #  ifndef REG_INFTY
219 #    define REG_INFTY ((1<<15)-1)
220 #  endif
221 #endif
222
223 #ifndef REG_INFTY
224 #  define REG_INFTY I16_MAX
225 #endif
226
227 #define ARG_VALUE(arg) (arg)
228 #define ARG__SET(arg,val) ((arg) = (val))
229
230 #undef ARG
231 #undef ARG1
232 #undef ARG2
233
234 #define ARG(p) ARG_VALUE(ARG_LOC(p))
235 #define ARG1(p) ARG_VALUE(ARG1_LOC(p))
236 #define ARG2(p) ARG_VALUE(ARG2_LOC(p))
237 #define ARG2L(p) ARG_VALUE(ARG2L_LOC(p))
238
239 #define ARG_SET(p, val) ARG__SET(ARG_LOC(p), (val))
240 #define ARG1_SET(p, val) ARG__SET(ARG1_LOC(p), (val))
241 #define ARG2_SET(p, val) ARG__SET(ARG2_LOC(p), (val))
242 #define ARG2L_SET(p, val) ARG__SET(ARG2L_LOC(p), (val))
243
244 #undef NEXT_OFF
245 #undef NODE_ALIGN
246
247 #define NEXT_OFF(p) ((p)->next_off)
248 #define NODE_ALIGN(node)
249 #define NODE_ALIGN_FILL(node) ((node)->flags = 0xde) /* deadbeef */
250
251 #define SIZE_ALIGN NODE_ALIGN
252
253 #undef OP
254 #undef OPERAND
255 #undef MASK
256 #undef STRING
257
258 #define OP(p)           ((p)->type)
259 #define FLAGS(p)        ((p)->flags)    /* Caution: Doesn't apply to all      \
260                                            regnode types.  For some, it's the \
261                                            character set of the regnode */
262 #define OPERAND(p)      (((struct regnode_string *)p)->string)
263 #define MASK(p)         ((char*)OPERAND(p))
264 #define STR_LEN(p)      (((struct regnode_string *)p)->str_len)
265 #define STRING(p)       (((struct regnode_string *)p)->string)
266 #define STR_SZ(l)       ((l + sizeof(regnode) - 1) / sizeof(regnode))
267 #define NODE_SZ_STR(p)  (STR_SZ(STR_LEN(p))+1)
268
269 #undef NODE_ALIGN
270 #undef ARG_LOC
271 #undef NEXTOPER
272 #undef PREVOPER
273
274 #define NODE_ALIGN(node)
275 #define ARG_LOC(p)      (((struct regnode_1 *)p)->arg1)
276 #define ARG1_LOC(p)     (((struct regnode_2 *)p)->arg1)
277 #define ARG2_LOC(p)     (((struct regnode_2 *)p)->arg2)
278 #define ARG2L_LOC(p)    (((struct regnode_2L *)p)->arg2)
279
280 #define NODE_STEP_REGNODE       1       /* sizeof(regnode)/sizeof(regnode) */
281 #define EXTRA_STEP_2ARGS        EXTRA_SIZE(struct regnode_2)
282
283 #define NODE_STEP_B     4
284
285 #define NEXTOPER(p)     ((p) + NODE_STEP_REGNODE)
286 #define PREVOPER(p)     ((p) - NODE_STEP_REGNODE)
287
288 #define FILL_ADVANCE_NODE(ptr, op) STMT_START { \
289     (ptr)->type = op;    (ptr)->next_off = 0;   (ptr)++; } STMT_END
290 #define FILL_ADVANCE_NODE_ARG(ptr, op, arg) STMT_START { \
291     ARG_SET(ptr, arg);  FILL_ADVANCE_NODE(ptr, op); (ptr) += 1; } STMT_END
292
293 #define REG_MAGIC 0234
294
295 #define SIZE_ONLY (RExC_emit == &RExC_emit_dummy)
296 #define PASS1 SIZE_ONLY
297 #define PASS2 (! SIZE_ONLY)
298
299 /* If the bitmap doesn't fully represent what this ANYOF node can match, the
300  * ARG is set to this special value (since 0, 1, ... are legal, but will never
301  * reach this high). */
302 #define ANYOF_NONBITMAP_EMPTY   ((U32) -1)
303
304 /* The information used to be stored as as combination of the ANYOF_UTF8 and
305  * ANYOF_NONBITMAP_NON_UTF8 bits in the flags field, but was moved out of there
306  * to free up a bit for other uses.  This tries to hide the change from
307  * existing code as much as possible.  Now, the data structure that goes in ARG
308  * is not allocated unless it is needed, and that is what is used to determine
309  * if there is something outside the bitmap.  The code now assumes that if
310  * that structure exists, that any UTF-8 encoded string should be tried against
311  * it, but a non-UTF8-encoded string will be tried only if the
312  * ANYOF_NONBITMAP_NON_UTF8 bit is also set. */
313 #define ANYOF_NONBITMAP(node)   (ARG(node) != ANYOF_NONBITMAP_EMPTY)
314
315 /* Flags for node->flags of ANYOF.  These are in short supply, but there is one
316  * currently available.  If more than this are needed, the ANYOF_LOCALE and
317  * ANYOF_POSIXL bits could be shared, making a space penalty for all locale nodes.
318  * Also, the ABOVE_LATIN1_ALL bit could be freed up by resorting to creating a
319  * swash containing everything above 255.  This introduces a performance
320  * penalty.  Better would be to split it off into a separate node, which
321  * actually would improve performance a bit by allowing regexec.c to test for a
322  * UTF-8 character being above 255 without having to call a function nor
323  * calculate its code point value.  However, this solution might need to have a
324  * second node type, ANYOF_SYNTHETIC_ABOVE_LATIN1_ALL */
325
326 #define ANYOF_LOCALE             0x01       /* /l modifier */
327
328 /* The fold is calculated and stored in the bitmap where possible at compile
329  * time.  However under locale, the actual folding varies depending on
330  * what the locale is at the time of execution, so it has to be deferred until
331  * then */
332 #define ANYOF_LOC_FOLD           0x02
333
334 #define ANYOF_INVERT             0x04
335
336 /* Set if this is a regnode_charclass_posixl vs a regnode_charclass.  This
337  * is used for runtime \d, \w, [:posix:], ..., which are used only in locale
338  * and the optimizer's synthetic start class.  Non-locale \d, etc are resolved
339  * at compile-time.  Could be shared with ANYOF_LOCALE, forcing all locale
340  * nodes to be large */
341 #define ANYOF_POSIXL             0x08
342 #define ANYOF_CLASS              ANYOF_POSIXL
343 #define ANYOF_LARGE              ANYOF_POSIXL
344
345 /* Unused: 0x10.  When using, be sure to change ANYOF_FLAGS_ALL below */
346
347 /* Can match something outside the bitmap that isn't in utf8 */
348 #define ANYOF_NONBITMAP_NON_UTF8 0x20
349
350 /* Matches every code point 0x100 and above*/
351 #define ANYOF_ABOVE_LATIN1_ALL   0x40
352 #define ANYOF_UNICODE_ALL        ANYOF_ABOVE_LATIN1_ALL
353
354 /* Match all Latin1 characters that aren't ASCII when the target string is not
355  * in utf8. */
356 #define ANYOF_NON_UTF8_LATIN1_ALL 0x80
357
358 #define ANYOF_FLAGS_ALL         (0xff & ~0x10)
359
360 /* These are the flags that ANYOF_INVERT being set or not doesn't affect
361  * whether they are operative or not.  e.g., the node still has LOCALE
362  * regardless of being inverted; whereas ANYOF_ABOVE_LATIN1_ALL means something
363  * different if inverted */
364 #define INVERSION_UNAFFECTED_FLAGS (ANYOF_LOCALE                        \
365                                    |ANYOF_LOC_FOLD                      \
366                                    |ANYOF_POSIXL                         \
367                                    |ANYOF_NONBITMAP_NON_UTF8)
368
369 /* Character classes for node->classflags of ANYOF */
370 /* Should be synchronized with a table in regprop() */
371 /* 2n should be the normal one, paired with its complement at 2n+1 */
372
373 #define ANYOF_ALPHA    ((_CC_ALPHA) * 2)
374 #define ANYOF_NALPHA   ((ANYOF_ALPHA) + 1)
375 #define ANYOF_ALPHANUMERIC   ((_CC_ALPHANUMERIC) * 2)    /* [[:alnum:]] isalnum(3), utf8::IsAlnum */
376 #define ANYOF_NALPHANUMERIC  ((ANYOF_ALPHANUMERIC) + 1)
377 #define ANYOF_ASCII    ((_CC_ASCII) * 2)
378 #define ANYOF_NASCII   ((ANYOF_ASCII) + 1)
379 #define ANYOF_BLANK    ((_CC_BLANK) * 2)     /* GNU extension: space and tab: non-vertical space */
380 #define ANYOF_NBLANK   ((ANYOF_BLANK) + 1)
381 #define ANYOF_CASED    ((_CC_CASED) * 2)    /* Pseudo class for [:lower:] or
382                                                [:upper:] under /i */
383 #define ANYOF_NCASED   ((ANYOF_CASED) + 1)
384 #define ANYOF_CNTRL    ((_CC_CNTRL) * 2)
385 #define ANYOF_NCNTRL   ((ANYOF_CNTRL) + 1)
386 #define ANYOF_DIGIT    ((_CC_DIGIT) * 2)     /* \d */
387 #define ANYOF_NDIGIT   ((ANYOF_DIGIT) + 1)
388 #define ANYOF_GRAPH    ((_CC_GRAPH) * 2)
389 #define ANYOF_NGRAPH   ((ANYOF_GRAPH) + 1)
390 #define ANYOF_LOWER    ((_CC_LOWER) * 2)
391 #define ANYOF_NLOWER   ((ANYOF_LOWER) + 1)
392 #define ANYOF_PRINT    ((_CC_PRINT) * 2)
393 #define ANYOF_NPRINT   ((ANYOF_PRINT) + 1)
394 #define ANYOF_PSXSPC   ((_CC_PSXSPC) * 2)    /* POSIX space: \s plus the vertical tab */
395 #define ANYOF_NPSXSPC  ((ANYOF_PSXSPC) + 1)
396 #define ANYOF_PUNCT    ((_CC_PUNCT) * 2)
397 #define ANYOF_NPUNCT   ((ANYOF_PUNCT) + 1)
398 #define ANYOF_SPACE    ((_CC_SPACE) * 2)     /* \s */
399 #define ANYOF_NSPACE   ((ANYOF_SPACE) + 1)
400 #define ANYOF_UPPER    ((_CC_UPPER) * 2)
401 #define ANYOF_NUPPER   ((ANYOF_UPPER) + 1)
402 #define ANYOF_WORDCHAR ((_CC_WORDCHAR) * 2)  /* \w, PL_utf8_alnum, utf8::IsWord, ALNUM */
403 #define ANYOF_NWORDCHAR   ((ANYOF_WORDCHAR) + 1)
404 #define ANYOF_XDIGIT   ((_CC_XDIGIT) * 2)
405 #define ANYOF_NXDIGIT  ((ANYOF_XDIGIT) + 1)
406
407 /* pseudo classes below this, not stored in the class bitmap, but used as flags
408    during compilation of char classes */
409
410 #define ANYOF_VERTWS    ((_CC_VERTSPACE) * 2)
411 #define ANYOF_NVERTWS   ((ANYOF_VERTWS)+1)
412
413 /* It is best if this is the last one, as all above it are stored as bits in a
414  * bitmap, and it isn't part of that bitmap */
415 #if _CC_VERTSPACE != _HIGHEST_REGCOMP_DOT_H_SYNC
416 #   error Problem with handy.h _HIGHEST_REGCOMP_DOT_H_SYNC #define
417 #endif
418
419 #define ANYOF_POSIXL_MAX (ANYOF_VERTWS) /* So upper loop limit is written:
420                                          *       '< ANYOF_MAX'
421                                          * Hence doesn't include VERTWS, as that
422                                          * is a pseudo class */
423 #define ANYOF_MAX      ANYOF_POSIXL_MAX
424
425 #if (ANYOF_POSIXL_MAX > 32)   /* Must fit in 32-bit word */
426 #   error Problem with handy.h _CC_foo #defines
427 #endif
428
429 #define ANYOF_HORIZWS   ((ANYOF_POSIXL_MAX)+2) /* = (ANYOF_NVERTWS + 1) */
430 #define ANYOF_NHORIZWS  ((ANYOF_POSIXL_MAX)+3)
431
432 #define ANYOF_UNIPROP   ((ANYOF_POSIXL_MAX)+4)  /* Used to indicate a Unicode
433                                                    property: \p{} or \P{} */
434
435 /* Backward source code compatibility. */
436
437 #define ANYOF_ALNUML     ANYOF_ALNUM
438 #define ANYOF_NALNUML    ANYOF_NALNUM
439 #define ANYOF_SPACEL     ANYOF_SPACE
440 #define ANYOF_NSPACEL    ANYOF_NSPACE
441 #define ANYOF_ALNUM ANYOF_WORDCHAR
442 #define ANYOF_NALNUM ANYOF_NWORDCHAR
443
444 /* Utility macros for the bitmap and classes of ANYOF */
445
446 #define ANYOF_SIZE              (sizeof(struct regnode_charclass))
447 #define ANYOF_POSIXL_SIZE       (sizeof(regnode_charclass_posixl))
448 #define ANYOF_CLASS_SIZE        ANYOF_POSIXL_SIZE
449
450 #define ANYOF_FLAGS(p)          ((p)->flags)
451
452 #define ANYOF_BIT(c)            (1 << ((c) & 7))
453
454 #define ANYOF_POSIXL_SET(p, c)  (((regnode_charclass_posixl*) (p))->classflags |= (1U << (c)))
455 #define ANYOF_CLASS_SET(p, c)   ANYOF_POSIXL_SET((p), (c))
456
457 #define ANYOF_POSIXL_CLEAR(p, c) (((regnode_charclass_posixl*) (p))->classflags &= ~ (1U <<(c)))
458 #define ANYOF_CLASS_CLEAR(p, c) ANYOF_POSIXL_CLEAR((p), (c))
459
460 #define ANYOF_POSIXL_TEST(p, c) (((regnode_charclass_posixl*) (p))->classflags & (1U << (c)))
461 #define ANYOF_CLASS_TEST(p, c)  ANYOF_POSIXL_TEST((p), (c))
462
463 #define ANYOF_POSIXL_ZERO(ret)  STMT_START { ((regnode_charclass_posixl*) (ret))->classflags = 0; } STMT_END
464 #define ANYOF_CLASS_ZERO(ret)   ANYOF_POSIXL_ZERO(ret)
465
466 /* Shifts a bit to get, eg. 0x4000_0000, then subtracts 1 to get 0x3FFF_FFFF */
467 #define ANYOF_POSIXL_SETALL(ret) STMT_START { ((regnode_charclass_posixl*) (ret))->classflags = ((1U << ((ANYOF_POSIXL_MAX) - 1))) - 1; } STMT_END
468 #define ANYOF_CLASS_SETALL(ret) ANYOF_POSIXL_SETALL(ret)
469
470 #define ANYOF_POSIXL_TEST_ANY_SET(p)                               \
471         ((ANYOF_FLAGS(p) & ANYOF_POSIXL)                           \
472          && (((regnode_charclass_posixl*)(p))->classflags))
473 #define ANYOF_CLASS_TEST_ANY_SET(p) ANYOF_POSIXL_TEST_ANY_SET(p)
474
475 #define ANYOF_POSIXL_OR(source, dest) STMT_START { (dest)->classflags |= (source)->classflags ; } STMT_END
476 #define ANYOF_CLASS_OR(source, dest) ANYOF_POSIXL_OR((source), (dest))
477
478 #define ANYOF_BITMAP_ZERO(ret)  Zero(((struct regnode_charclass*)(ret))->bitmap, ANYOF_BITMAP_SIZE, char)
479 #define ANYOF_BITMAP(p)         (((struct regnode_charclass*)(p))->bitmap)
480 #define ANYOF_BITMAP_BYTE(p, c) (ANYOF_BITMAP(p)[(((U8)(c)) >> 3) & 31])
481 #define ANYOF_BITMAP_SET(p, c)  (ANYOF_BITMAP_BYTE(p, c) |=  ANYOF_BIT(c))
482 #define ANYOF_BITMAP_CLEAR(p,c) (ANYOF_BITMAP_BYTE(p, c) &= ~ANYOF_BIT(c))
483 #define ANYOF_BITMAP_TEST(p, c) (ANYOF_BITMAP_BYTE(p, c) &   ANYOF_BIT(c))
484
485 #define ANYOF_BITMAP_SETALL(p)          \
486         memset (ANYOF_BITMAP(p), 255, ANYOF_BITMAP_SIZE)
487 #define ANYOF_BITMAP_CLEARALL(p)        \
488         Zero (ANYOF_BITMAP(p), ANYOF_BITMAP_SIZE)
489 /* Check that all 256 bits are all set.  Used in S_cl_is_anything()  */
490 #define ANYOF_BITMAP_TESTALLSET(p)      /* Assumes sizeof(p) == 32 */     \
491         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)
492
493 #define ANYOF_SKIP              ((ANYOF_SIZE - 1)/sizeof(regnode))
494 #define ANYOF_POSIXL_SKIP       ((ANYOF_POSIXL_SIZE - 1)/sizeof(regnode))
495 #define ANYOF_CLASS_SKIP        ANYOF_POSIXL_SKIP
496
497 /*
498  * Utility definitions.
499  */
500 #ifndef CHARMASK
501 #  define UCHARAT(p)    ((int)*(const U8*)(p))
502 #else
503 #  define UCHARAT(p)    ((int)*(p)&CHARMASK)
504 #endif
505
506 #define EXTRA_SIZE(guy) ((sizeof(guy)-1)/sizeof(struct regnode))
507
508 #define REG_SEEN_ZERO_LEN       0x00000001
509 #define REG_SEEN_LOOKBEHIND     0x00000002
510 #define REG_SEEN_GPOS           0x00000004
511 /* spare */
512 #define REG_SEEN_CANY           0x00000010
513 #define REG_SEEN_SANY           REG_SEEN_CANY /* src bckwrd cmpt */
514 #define REG_SEEN_RECURSE        0x00000020
515 #define REG_TOP_LEVEL_BRANCHES  0x00000040
516 #define REG_SEEN_VERBARG        0x00000080
517 #define REG_SEEN_CUTGROUP       0x00000100
518 #define REG_SEEN_RUN_ON_COMMENT 0x00000200
519 #define REG_SEEN_EXACTF_SHARP_S 0x00000400
520
521 START_EXTERN_C
522
523 #ifdef PLUGGABLE_RE_EXTENSION
524 #include "re_nodes.h"
525 #else
526 #include "regnodes.h"
527 #endif
528
529 #ifndef PLUGGABLE_RE_EXTENSION
530 #ifndef DOINIT
531 EXTCONST regexp_engine PL_core_reg_engine;
532 #else /* DOINIT */
533 EXTCONST regexp_engine PL_core_reg_engine = { 
534         Perl_re_compile,
535         Perl_regexec_flags,
536         Perl_re_intuit_start,
537         Perl_re_intuit_string, 
538         Perl_regfree_internal,
539         Perl_reg_numbered_buff_fetch,
540         Perl_reg_numbered_buff_store,
541         Perl_reg_numbered_buff_length,
542         Perl_reg_named_buff,
543         Perl_reg_named_buff_iter,
544         Perl_reg_qr_package,
545 #if defined(USE_ITHREADS)        
546         Perl_regdupe_internal,
547 #endif        
548         Perl_re_op_compile
549 };
550 #endif /* DOINIT */
551 #endif /* PLUGGABLE_RE_EXTENSION */
552
553
554 END_EXTERN_C
555
556
557 /* .what is a character array with one character for each member of .data
558  * The character describes the function of the corresponding .data item:
559  *   a - AV for paren_name_list under DEBUGGING
560  *   f - start-class data for regstclass optimization
561  *   l - start op for literal (?{EVAL}) item
562  *   L - start op for literal (?{EVAL}) item, with separate CV (qr//)
563  *   r - pointer to an embedded code-containing qr, e.g. /ab$qr/
564  *   s - swash for Unicode-style character class, and the multicharacter
565  *       strings resulting from casefolding the single-character entries
566  *       in the character class
567  *   t - trie struct
568  *   u - trie struct's widecharmap (a HV, so can't share, must dup)
569  *       also used for revcharmap and words under DEBUGGING
570  *   T - aho-trie struct
571  *   S - sv for named capture lookup
572  * 20010712 mjd@plover.com
573  * (Remember to update re_dup() and pregfree() if you add any items.)
574  */
575 struct reg_data {
576     U32 count;
577     U8 *what;
578     void* data[1];
579 };
580
581 /* Code in S_to_utf8_substr() and S_to_byte_substr() in regexec.c accesses
582    anchored* and float* via array indexes 0 and 1.  */
583 #define anchored_substr substrs->data[0].substr
584 #define anchored_utf8 substrs->data[0].utf8_substr
585 #define anchored_offset substrs->data[0].min_offset
586 #define anchored_end_shift substrs->data[0].end_shift
587
588 #define float_substr substrs->data[1].substr
589 #define float_utf8 substrs->data[1].utf8_substr
590 #define float_min_offset substrs->data[1].min_offset
591 #define float_max_offset substrs->data[1].max_offset
592 #define float_end_shift substrs->data[1].end_shift
593
594 #define check_substr substrs->data[2].substr
595 #define check_utf8 substrs->data[2].utf8_substr
596 #define check_offset_min substrs->data[2].min_offset
597 #define check_offset_max substrs->data[2].max_offset
598 #define check_end_shift substrs->data[2].end_shift
599
600 #define RX_ANCHORED_SUBSTR(rx)  (ReANY(rx)->anchored_substr)
601 #define RX_ANCHORED_UTF8(rx)    (ReANY(rx)->anchored_utf8)
602 #define RX_FLOAT_SUBSTR(rx)     (ReANY(rx)->float_substr)
603 #define RX_FLOAT_UTF8(rx)       (ReANY(rx)->float_utf8)
604
605 /* trie related stuff */
606
607 /* a transition record for the state machine. the
608    check field determines which state "owns" the
609    transition. the char the transition is for is
610    determined by offset from the owning states base
611    field.  the next field determines which state
612    is to be transitioned to if any.
613 */
614 struct _reg_trie_trans {
615   U32 next;
616   U32 check;
617 };
618
619 /* a transition list element for the list based representation */
620 struct _reg_trie_trans_list_elem {
621     U16 forid;
622     U32 newstate;
623 };
624 typedef struct _reg_trie_trans_list_elem reg_trie_trans_le;
625
626 /* a state for compressed nodes. base is an offset
627   into an array of reg_trie_trans array. If wordnum is
628   nonzero the state is accepting. if base is zero then
629   the state has no children (and will be accepting)
630 */
631 struct _reg_trie_state {
632   U16 wordnum;
633   union {
634     U32                base;
635     reg_trie_trans_le* list;
636   } trans;
637 };
638
639 /* info per word; indexed by wordnum */
640 typedef struct {
641     U16  prev;  /* previous word in acceptance chain; eg in
642                  * zzz|abc|ab/ after matching the chars abc, the
643                  * accepted word is #2, and the previous accepted
644                  * word is #3 */
645     U32 len;    /* how many chars long is this word? */
646     U32 accept; /* accept state for this word */
647 } reg_trie_wordinfo;
648
649
650 typedef struct _reg_trie_state    reg_trie_state;
651 typedef struct _reg_trie_trans    reg_trie_trans;
652
653
654 /* anything in here that needs to be freed later
655    should be dealt with in pregfree.
656    refcount is first in both this and _reg_ac_data to allow a space
657    optimisation in Perl_regdupe.  */
658 struct _reg_trie_data {
659     U32             refcount;        /* number of times this trie is referenced */
660     U32             lasttrans;       /* last valid transition element */
661     U16             *charmap;        /* byte to charid lookup array */
662     reg_trie_state  *states;         /* state data */
663     reg_trie_trans  *trans;          /* array of transition elements */
664     char            *bitmap;         /* stclass bitmap */
665     U16             *jump;           /* optional 1 indexed array of offsets before tail 
666                                         for the node following a given word. */
667     reg_trie_wordinfo *wordinfo;     /* array of info per word */
668     U16             uniquecharcount; /* unique chars in trie (width of trans table) */
669     U32             startstate;      /* initial state - used for common prefix optimisation */
670     STRLEN          minlen;          /* minimum length of words in trie - build/opt only? */
671     STRLEN          maxlen;          /* maximum length of words in trie - build/opt only? */
672     U32             prefixlen;       /* #chars in common prefix */
673     U32             statecount;      /* Build only - number of states in the states array 
674                                         (including the unused zero state) */
675     U32             wordcount;       /* Build only */
676 #ifdef DEBUGGING
677     STRLEN          charcount;       /* Build only */
678 #endif
679 };
680 /* There is one (3 under DEBUGGING) pointers that logically belong in this
681    structure, but are held outside as they need duplication on thread cloning,
682    whereas the rest of the structure can be read only:
683     HV              *widecharmap;    code points > 255 to charid
684 #ifdef DEBUGGING
685     AV              *words;          Array of words contained in trie, for dumping
686     AV              *revcharmap;     Map of each charid back to its character representation
687 #endif
688 */
689
690 #define TRIE_WORDS_OFFSET 2
691
692 typedef struct _reg_trie_data reg_trie_data;
693
694 /* refcount is first in both this and _reg_trie_data to allow a space
695    optimisation in Perl_regdupe.  */
696 struct _reg_ac_data {
697     U32              refcount;
698     U32              trie;
699     U32              *fail;
700     reg_trie_state   *states;
701 };
702 typedef struct _reg_ac_data reg_ac_data;
703
704 /* ANY_BIT doesn't use the structure, so we can borrow it here.
705    This is simpler than refactoring all of it as wed end up with
706    three different sets... */
707
708 #define TRIE_BITMAP(p)          (((reg_trie_data *)(p))->bitmap)
709 #define TRIE_BITMAP_BYTE(p, c)  (TRIE_BITMAP(p)[(((U8)(c)) >> 3) & 31])
710 #define TRIE_BITMAP_SET(p, c)   (TRIE_BITMAP_BYTE(p, c) |=  ANYOF_BIT((U8)c))
711 #define TRIE_BITMAP_CLEAR(p,c)  (TRIE_BITMAP_BYTE(p, c) &= ~ANYOF_BIT((U8)c))
712 #define TRIE_BITMAP_TEST(p, c)  (TRIE_BITMAP_BYTE(p, c) &   ANYOF_BIT((U8)c))
713
714 #define IS_ANYOF_TRIE(op) ((op)==TRIEC || (op)==AHOCORASICKC)
715 #define IS_TRIE_AC(op) ((op)>=AHOCORASICK)
716
717
718 #define BITMAP_BYTE(p, c)       (((U8*)p)[(((U8)(c)) >> 3) & 31])
719 #define BITMAP_TEST(p, c)       (BITMAP_BYTE(p, c) &   ANYOF_BIT((U8)c))
720
721 /* these defines assume uniquecharcount is the correct variable, and state may be evaluated twice */
722 #define TRIE_NODENUM(state) (((state)-1)/(trie->uniquecharcount)+1)
723 #define SAFE_TRIE_NODENUM(state) ((state) ? (((state)-1)/(trie->uniquecharcount)+1) : (state))
724 #define TRIE_NODEIDX(state) ((state) ? (((state)-1)*(trie->uniquecharcount)+1) : (state))
725
726 #ifdef DEBUGGING
727 #define TRIE_CHARCOUNT(trie) ((trie)->charcount)
728 #else
729 #define TRIE_CHARCOUNT(trie) (trie_charcount)
730 #endif
731
732 #define RE_TRIE_MAXBUF_INIT 65536
733 #define RE_TRIE_MAXBUF_NAME "\022E_TRIE_MAXBUF"
734 #define RE_DEBUG_FLAGS "\022E_DEBUG_FLAGS"
735
736 /*
737
738 RE_DEBUG_FLAGS is used to control what debug output is emitted
739 its divided into three groups of options, some of which interact.
740 The three groups are: Compile, Execute, Extra. There is room for a
741 further group, as currently only the low three bytes are used.
742
743     Compile Options:
744     
745     PARSE
746     PEEP
747     TRIE
748     PROGRAM
749     OFFSETS
750
751     Execute Options:
752
753     INTUIT
754     MATCH
755     TRIE
756
757     Extra Options
758
759     TRIE
760     OFFSETS
761
762 If you modify any of these make sure you make corresponding changes to
763 re.pm, especially to the documentation.
764
765 */
766
767
768 /* Compile */
769 #define RE_DEBUG_COMPILE_MASK      0x0000FF
770 #define RE_DEBUG_COMPILE_PARSE     0x000001
771 #define RE_DEBUG_COMPILE_OPTIMISE  0x000002
772 #define RE_DEBUG_COMPILE_TRIE      0x000004
773 #define RE_DEBUG_COMPILE_DUMP      0x000008
774 #define RE_DEBUG_COMPILE_FLAGS     0x000010
775
776 /* Execute */
777 #define RE_DEBUG_EXECUTE_MASK      0x00FF00
778 #define RE_DEBUG_EXECUTE_INTUIT    0x000100
779 #define RE_DEBUG_EXECUTE_MATCH     0x000200
780 #define RE_DEBUG_EXECUTE_TRIE      0x000400
781
782 /* Extra */
783 #define RE_DEBUG_EXTRA_MASK        0xFF0000
784 #define RE_DEBUG_EXTRA_TRIE        0x010000
785 #define RE_DEBUG_EXTRA_OFFSETS     0x020000
786 #define RE_DEBUG_EXTRA_OFFDEBUG    0x040000
787 #define RE_DEBUG_EXTRA_STATE       0x080000
788 #define RE_DEBUG_EXTRA_OPTIMISE    0x100000
789 #define RE_DEBUG_EXTRA_BUFFERS     0x400000
790 #define RE_DEBUG_EXTRA_GPOS        0x800000
791 /* combined */
792 #define RE_DEBUG_EXTRA_STACK       0x280000
793
794 #define RE_DEBUG_FLAG(x) (re_debug_flags & x)
795 /* Compile */
796 #define DEBUG_COMPILE_r(x) DEBUG_r( \
797     if (re_debug_flags & RE_DEBUG_COMPILE_MASK) x  )
798 #define DEBUG_PARSE_r(x) DEBUG_r( \
799     if (re_debug_flags & RE_DEBUG_COMPILE_PARSE) x  )
800 #define DEBUG_OPTIMISE_r(x) DEBUG_r( \
801     if (re_debug_flags & RE_DEBUG_COMPILE_OPTIMISE) x  )
802 #define DEBUG_PARSE_r(x) DEBUG_r( \
803     if (re_debug_flags & RE_DEBUG_COMPILE_PARSE) x  )
804 #define DEBUG_DUMP_r(x) DEBUG_r( \
805     if (re_debug_flags & RE_DEBUG_COMPILE_DUMP) x  )
806 #define DEBUG_TRIE_COMPILE_r(x) DEBUG_r( \
807     if (re_debug_flags & RE_DEBUG_COMPILE_TRIE) x )
808 #define DEBUG_FLAGS_r(x) DEBUG_r( \
809     if (re_debug_flags & RE_DEBUG_COMPILE_FLAGS) x )
810 /* Execute */
811 #define DEBUG_EXECUTE_r(x) DEBUG_r( \
812     if (re_debug_flags & RE_DEBUG_EXECUTE_MASK) x  )
813 #define DEBUG_INTUIT_r(x) DEBUG_r( \
814     if (re_debug_flags & RE_DEBUG_EXECUTE_INTUIT) x  )
815 #define DEBUG_MATCH_r(x) DEBUG_r( \
816     if (re_debug_flags & RE_DEBUG_EXECUTE_MATCH) x  )
817 #define DEBUG_TRIE_EXECUTE_r(x) DEBUG_r( \
818     if (re_debug_flags & RE_DEBUG_EXECUTE_TRIE) x )
819
820 /* Extra */
821 #define DEBUG_EXTRA_r(x) DEBUG_r( \
822     if (re_debug_flags & RE_DEBUG_EXTRA_MASK) x  )
823 #define DEBUG_OFFSETS_r(x) DEBUG_r( \
824     if (re_debug_flags & RE_DEBUG_EXTRA_OFFSETS) x  )
825 #define DEBUG_STATE_r(x) DEBUG_r( \
826     if (re_debug_flags & RE_DEBUG_EXTRA_STATE) x )
827 #define DEBUG_STACK_r(x) DEBUG_r( \
828     if (re_debug_flags & RE_DEBUG_EXTRA_STACK) x )
829 #define DEBUG_BUFFERS_r(x) DEBUG_r( \
830     if (re_debug_flags & RE_DEBUG_EXTRA_BUFFERS) x )
831
832 #define DEBUG_OPTIMISE_MORE_r(x) DEBUG_r( \
833     if ((RE_DEBUG_EXTRA_OPTIMISE|RE_DEBUG_COMPILE_OPTIMISE) == \
834          (re_debug_flags & (RE_DEBUG_EXTRA_OPTIMISE|RE_DEBUG_COMPILE_OPTIMISE)) ) x )
835 #define MJD_OFFSET_DEBUG(x) DEBUG_r( \
836     if (re_debug_flags & RE_DEBUG_EXTRA_OFFDEBUG) \
837         Perl_warn_nocontext x )
838 #define DEBUG_TRIE_COMPILE_MORE_r(x) DEBUG_TRIE_COMPILE_r( \
839     if (re_debug_flags & RE_DEBUG_EXTRA_TRIE) x )
840 #define DEBUG_TRIE_EXECUTE_MORE_r(x) DEBUG_TRIE_EXECUTE_r( \
841     if (re_debug_flags & RE_DEBUG_EXTRA_TRIE) x )
842
843 #define DEBUG_TRIE_r(x) DEBUG_r( \
844     if (re_debug_flags & (RE_DEBUG_COMPILE_TRIE \
845         | RE_DEBUG_EXECUTE_TRIE )) x )
846 #define DEBUG_GPOS_r(x) DEBUG_r( \
847     if (re_debug_flags & RE_DEBUG_EXTRA_GPOS) x )
848
849 /* initialization */
850 /* get_sv() can return NULL during global destruction. */
851 #define GET_RE_DEBUG_FLAGS DEBUG_r({ \
852         SV * re_debug_flags_sv = NULL; \
853         re_debug_flags_sv = get_sv(RE_DEBUG_FLAGS, 1); \
854         if (re_debug_flags_sv) { \
855             if (!SvIOK(re_debug_flags_sv)) \
856                 sv_setuv(re_debug_flags_sv, RE_DEBUG_COMPILE_DUMP | RE_DEBUG_EXECUTE_MASK ); \
857             re_debug_flags=SvIV(re_debug_flags_sv); \
858         }\
859 })
860
861 #ifdef DEBUGGING
862
863 #define GET_RE_DEBUG_FLAGS_DECL VOL IV re_debug_flags  = 0; \
864         PERL_UNUSED_VAR(re_debug_flags); GET_RE_DEBUG_FLAGS;
865
866 #define RE_PV_COLOR_DECL(rpv,rlen,isuni,dsv,pv,l,m,c1,c2) \
867     const char * const rpv =                          \
868         pv_pretty((dsv), (pv), (l), (m), \
869             PL_colors[(c1)],PL_colors[(c2)], \
870             PERL_PV_ESCAPE_RE|PERL_PV_ESCAPE_NONASCII |((isuni) ? PERL_PV_ESCAPE_UNI : 0) );         \
871     const int rlen = SvCUR(dsv)
872
873 #define RE_SV_ESCAPE(rpv,isuni,dsv,sv,m) \
874     const char * const rpv =                          \
875         pv_pretty((dsv), (SvPV_nolen_const(sv)), (SvCUR(sv)), (m), \
876             PL_colors[(c1)],PL_colors[(c2)], \
877             PERL_PV_ESCAPE_RE|PERL_PV_ESCAPE_NONASCII |((isuni) ? PERL_PV_ESCAPE_UNI : 0) )
878
879 #define RE_PV_QUOTED_DECL(rpv,isuni,dsv,pv,l,m)                    \
880     const char * const rpv =                                       \
881         pv_pretty((dsv), (pv), (l), (m), \
882             PL_colors[0], PL_colors[1], \
883             ( PERL_PV_PRETTY_QUOTE | PERL_PV_ESCAPE_RE | PERL_PV_ESCAPE_NONASCII | PERL_PV_PRETTY_ELLIPSES | \
884               ((isuni) ? PERL_PV_ESCAPE_UNI : 0))                  \
885         )
886
887 #define RE_SV_DUMPLEN(ItEm) (SvCUR(ItEm) - (SvTAIL(ItEm)!=0))
888 #define RE_SV_TAIL(ItEm) (SvTAIL(ItEm) ? "$" : "")
889     
890 #else /* if not DEBUGGING */
891
892 #define GET_RE_DEBUG_FLAGS_DECL
893 #define RE_PV_COLOR_DECL(rpv,rlen,isuni,dsv,pv,l,m,c1,c2)
894 #define RE_SV_ESCAPE(rpv,isuni,dsv,sv,m)
895 #define RE_PV_QUOTED_DECL(rpv,isuni,dsv,pv,l,m)
896 #define RE_SV_DUMPLEN(ItEm)
897 #define RE_SV_TAIL(ItEm)
898
899 #endif /* DEBUG RELATED DEFINES */
900
901 /*
902  * Local variables:
903  * c-indentation-style: bsd
904  * c-basic-offset: 4
905  * indent-tabs-mode: nil
906  * End:
907  *
908  * ex: set ts=8 sts=4 sw=4 et:
909  */