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