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