avoid " in Carp.t test programs, due to Win32 shell issues
[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 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         regnode program[1];     /* Unwarranted chumminess with compiler. */
125 } regexp_internal;
126
127 #define RXi_SET(x,y) (x)->pprivate = (void*)(y)   
128 #define RXi_GET(x)   ((regexp_internal *)((x)->pprivate))
129 #define RXi_GET_DECL(r,ri) regexp_internal *ri = RXi_GET(r)
130 /*
131  * Flags stored in regexp->intflags
132  * These are used only internally to the regexp engine
133  *
134  * See regexp.h for flags used externally to the regexp engine
135  */
136 #define PREGf_SKIP              0x00000001
137 #define PREGf_IMPLICIT          0x00000002 /* Converted .* to ^.* */
138 #define PREGf_NAUGHTY           0x00000004 /* how exponential is this pattern? */
139 #define PREGf_VERBARG_SEEN      0x00000008
140 #define PREGf_CUTGROUP_SEEN     0x00000010
141
142
143 /* this is where the old regcomp.h started */
144
145 struct regnode_string {
146     U8  str_len;
147     U8  type;
148     U16 next_off;
149     char string[1];
150 };
151
152 /* Argument bearing node - workhorse, 
153    arg1 is often for the data field */
154 struct regnode_1 {
155     U8  flags;
156     U8  type;
157     U16 next_off;
158     U32 arg1;
159 };
160
161 /* Similar to a regnode_1 but with an extra signed argument */
162 struct regnode_2L {
163     U8  flags;
164     U8  type;
165     U16 next_off;
166     U32 arg1;
167     I32 arg2;
168 };
169
170 /* 'Two field' -- Two 16 bit unsigned args */
171 struct regnode_2 {
172     U8  flags;
173     U8  type;
174     U16 next_off;
175     U16 arg1;
176     U16 arg2;
177 };
178
179
180 #define ANYOF_BITMAP_SIZE       32      /* 256 b/(8 b/B) */
181 #define ANYOF_CLASSBITMAP_SIZE   4      /* up to 32 (8*4) named classes */
182
183 /* also used by trie */
184 struct regnode_charclass {
185     U8  flags;
186     U8  type;
187     U16 next_off;
188     U32 arg1;                           /* used as ptr in S_regclass */
189     char bitmap[ANYOF_BITMAP_SIZE];     /* only compile-time */
190 };
191
192 /* has runtime (locale) \d, \w, ..., [:posix:] classes */
193 struct regnode_charclass_class {
194     U8  flags;                          /* ANYOF_CLASS bit must go here */
195     U8  type;
196     U16 next_off;
197     U32 arg1;                                   /* used as ptr in S_regclass */
198     char bitmap[ANYOF_BITMAP_SIZE];             /* both compile-time */
199     char classflags[ANYOF_CLASSBITMAP_SIZE];    /* and run-time */
200 };
201
202 /* XXX fix this description.
203    Impose a limit of REG_INFTY on various pattern matching operations
204    to limit stack growth and to avoid "infinite" recursions.
205 */
206 /* The default size for REG_INFTY is I16_MAX, which is the same as
207    SHORT_MAX (see perl.h).  Unfortunately I16 isn't necessarily 16 bits
208    (see handy.h).  On the Cray C90, sizeof(short)==4 and hence I16_MAX is
209    ((1<<31)-1), while on the Cray T90, sizeof(short)==8 and I16_MAX is
210    ((1<<63)-1).  To limit stack growth to reasonable sizes, supply a
211    smaller default.
212         --Andy Dougherty  11 June 1998
213 */
214 #if SHORTSIZE > 2
215 #  ifndef REG_INFTY
216 #    define REG_INFTY ((1<<15)-1)
217 #  endif
218 #endif
219
220 #ifndef REG_INFTY
221 #  define REG_INFTY I16_MAX
222 #endif
223
224 #define ARG_VALUE(arg) (arg)
225 #define ARG__SET(arg,val) ((arg) = (val))
226
227 #undef ARG
228 #undef ARG1
229 #undef ARG2
230
231 #define ARG(p) ARG_VALUE(ARG_LOC(p))
232 #define ARG1(p) ARG_VALUE(ARG1_LOC(p))
233 #define ARG2(p) ARG_VALUE(ARG2_LOC(p))
234 #define ARG2L(p) ARG_VALUE(ARG2L_LOC(p))
235
236 #define ARG_SET(p, val) ARG__SET(ARG_LOC(p), (val))
237 #define ARG1_SET(p, val) ARG__SET(ARG1_LOC(p), (val))
238 #define ARG2_SET(p, val) ARG__SET(ARG2_LOC(p), (val))
239 #define ARG2L_SET(p, val) ARG__SET(ARG2L_LOC(p), (val))
240
241 #undef NEXT_OFF
242 #undef NODE_ALIGN
243
244 #define NEXT_OFF(p) ((p)->next_off)
245 #define NODE_ALIGN(node)
246 #define NODE_ALIGN_FILL(node) ((node)->flags = 0xde) /* deadbeef */
247
248 #define SIZE_ALIGN NODE_ALIGN
249
250 #undef OP
251 #undef OPERAND
252 #undef MASK
253 #undef STRING
254
255 #define OP(p)           ((p)->type)
256 #define FLAGS(p)        ((p)->flags)    /* Caution: Doesn't apply to all      \
257                                            regnode types.  For some, it's the \
258                                            character set of the regnode */
259 #define OPERAND(p)      (((struct regnode_string *)p)->string)
260 #define MASK(p)         ((char*)OPERAND(p))
261 #define STR_LEN(p)      (((struct regnode_string *)p)->str_len)
262 #define STRING(p)       (((struct regnode_string *)p)->string)
263 #define STR_SZ(l)       ((l + sizeof(regnode) - 1) / sizeof(regnode))
264 #define NODE_SZ_STR(p)  (STR_SZ(STR_LEN(p))+1)
265
266 #undef NODE_ALIGN
267 #undef ARG_LOC
268 #undef NEXTOPER
269 #undef PREVOPER
270
271 #define NODE_ALIGN(node)
272 #define ARG_LOC(p)      (((struct regnode_1 *)p)->arg1)
273 #define ARG1_LOC(p)     (((struct regnode_2 *)p)->arg1)
274 #define ARG2_LOC(p)     (((struct regnode_2 *)p)->arg2)
275 #define ARG2L_LOC(p)    (((struct regnode_2L *)p)->arg2)
276
277 #define NODE_STEP_REGNODE       1       /* sizeof(regnode)/sizeof(regnode) */
278 #define EXTRA_STEP_2ARGS        EXTRA_SIZE(struct regnode_2)
279
280 #define NODE_STEP_B     4
281
282 #define NEXTOPER(p)     ((p) + NODE_STEP_REGNODE)
283 #define PREVOPER(p)     ((p) - NODE_STEP_REGNODE)
284
285 #define FILL_ADVANCE_NODE(ptr, op) STMT_START { \
286     (ptr)->type = op;    (ptr)->next_off = 0;   (ptr)++; } STMT_END
287 #define FILL_ADVANCE_NODE_ARG(ptr, op, arg) STMT_START { \
288     ARG_SET(ptr, arg);  FILL_ADVANCE_NODE(ptr, op); (ptr) += 1; } STMT_END
289
290 #define REG_MAGIC 0234
291
292 #define SIZE_ONLY (RExC_emit == &PL_regdummy)
293
294 /* If the bitmap doesn't fully represent what this ANYOF node can match, the
295  * ARG is set to this special value (since 0, 1, ... are legal, but will never
296  * reach this high). */
297 #define ANYOF_NONBITMAP_EMPTY   ((U32) -1)
298
299 /* The information used to be stored as as combination of the ANYOF_UTF8 and
300  * ANYOF_NONBITMAP_NON_UTF8 bits in the flags field, but was moved out of there
301  * to free up a bit for other uses.  This tries to hide the change from
302  * existing code as much as possible.  Now, the data structure that goes in ARG
303  * is not allocated unless it is needed, and that is what is used to determine
304  * if there is something outside the bitmap.  The code now assumes that if
305  * that structure exists, that any UTF-8 encoded string should be tried against
306  * it, but a non-UTF8-encoded string will be tried only if the
307  * ANYOF_NONBITMAP_NON_UTF8 bit is also set. */
308 #define ANYOF_NONBITMAP(node)   (ARG(node) != ANYOF_NONBITMAP_EMPTY)
309
310 /* Flags for node->flags of ANYOF.  These are in short supply, so some games
311  * are done to share them, as described below.  If necessary, the ANYOF_LOCALE
312  * and ANYOF_CLASS bits could be shared with a space penalty for locale nodes,
313  * but this isn't quite so easy, as the optimizer also uses ANYOF_CLASS.
314  * Once the planned change to compile all the above-latin1 code points is done,
315  * then the UNICODE_ALL bit can be freed up, with a small performance penalty.
316  * If flags need to be added that are applicable to the synthetic start class
317  * only, with some work, they could be put in the next-node field, or in an
318  * unused bit of the classflags field. */
319
320 #define ANYOF_LOCALE             0x01       /* /l modifier */
321
322 /* The fold is calculated and stored in the bitmap where possible at compile
323  * time.  However there are two cases where it isn't possible.  These share
324  * this bit:  1) under locale, where the actual folding varies depending on
325  * what the locale is at the time of execution; and 2) where the folding is
326  * specified in a swash, not the bitmap, such as characters which aren't
327  * specified in the bitmap, or properties that aren't looked at at compile time
328  */
329 #define ANYOF_LOC_NONBITMAP_FOLD 0x02
330
331 #define ANYOF_INVERT             0x04
332
333 /* Set if this is a struct regnode_charclass_class vs a regnode_charclass.  This
334  * is used for runtime \d, \w, [:posix:], ..., which are used only in locale
335  * and the optimizer's synthetic start class.  Non-locale \d, etc are resolved
336  * at compile-time */
337 #define ANYOF_CLASS      0x08
338 #define ANYOF_LARGE      ANYOF_CLASS    /* Same; name retained for back compat */
339
340 /* EOS, meaning that it can match an empty string too, is used for the
341  * synthetic start class only. */
342 #define ANYOF_EOS               0x10
343
344 /* ? Is this node the synthetic start class (ssc).  This bit is shared with
345  * ANYOF_EOS, as the latter is used only for the ssc, and then not used by
346  * regexec.c.  And, the code is structured so that if it is set, the ssc is
347  * not used, so it is guaranteed to be 0 for the ssc by the time regexec.c
348  * gets executed, and 0 for a non-ssc ANYOF node, as it only ever gets set for
349  * a potential ssc candidate.  Thus setting it to 1 after it has been
350  * determined that the ssc will be used is not ambiguous */
351 #define ANYOF_IS_SYNTHETIC      ANYOF_EOS
352
353 /* Can match something outside the bitmap that isn't in utf8 */
354 #define ANYOF_NONBITMAP_NON_UTF8 0x20
355
356 /* Matches every code point 0x100 and above*/
357 #define ANYOF_UNICODE_ALL       0x40
358
359 /* Match all Latin1 characters that aren't ASCII when the target string is not
360  * in utf8. */
361 #define ANYOF_NON_UTF8_LATIN1_ALL 0x80
362
363 #define ANYOF_FLAGS_ALL         0xff
364
365 /* These are the flags that ANYOF_INVERT being set or not doesn't affect
366  * whether they are operative or not.  e.g., the node still has LOCALE
367  * regardless of being inverted; whereas ANYOF_UNICODE_ALL means something
368  * different if inverted */
369 #define INVERSION_UNAFFECTED_FLAGS (ANYOF_LOCALE                        \
370                                    |ANYOF_LOC_NONBITMAP_FOLD            \
371                                    |ANYOF_CLASS                         \
372                                    |ANYOF_EOS                           \
373                                    |ANYOF_NONBITMAP_NON_UTF8)
374
375 /* Character classes for node->classflags of ANYOF */
376 /* Should be synchronized with a table in regprop() */
377 /* 2n should pair with 2n+1 */
378
379 #define ANYOF_ALNUM      0      /* \w, PL_utf8_alnum, utf8::IsWord, ALNUM */
380 #define ANYOF_NALNUM     1
381 #define ANYOF_SPACE      2      /* \s */
382 #define ANYOF_NSPACE     3
383 #define ANYOF_DIGIT      4      /* \d */
384 #define ANYOF_NDIGIT     5
385 #define ANYOF_ALNUMC     6      /* [[:alnum:]] isalnum(3), utf8::IsAlnum, ALNUMC */
386 #define ANYOF_NALNUMC    7
387 #define ANYOF_ALPHA      8
388 #define ANYOF_NALPHA     9
389 #define ANYOF_ASCII     10
390 #define ANYOF_NASCII    11
391 #define ANYOF_CNTRL     12
392 #define ANYOF_NCNTRL    13
393 #define ANYOF_GRAPH     14
394 #define ANYOF_NGRAPH    15
395 #define ANYOF_LOWER     16
396 #define ANYOF_NLOWER    17
397 #define ANYOF_PRINT     18
398 #define ANYOF_NPRINT    19
399 #define ANYOF_PUNCT     20
400 #define ANYOF_NPUNCT    21
401 #define ANYOF_UPPER     22
402 #define ANYOF_NUPPER    23
403 #define ANYOF_XDIGIT    24
404 #define ANYOF_NXDIGIT   25
405 #define ANYOF_PSXSPC    26      /* POSIX space: \s plus the vertical tab */
406 #define ANYOF_NPSXSPC   27
407 #define ANYOF_BLANK     28      /* GNU extension: space and tab: non-vertical space */
408 #define ANYOF_NBLANK    29
409
410 #define ANYOF_MAX       32
411
412 /* pseudo classes, not stored in the class bitmap, but used as flags
413    during compilation of char classes */
414
415 #define ANYOF_VERTWS    (ANYOF_MAX+1)
416 #define ANYOF_NVERTWS   (ANYOF_MAX+2)
417 #define ANYOF_HORIZWS   (ANYOF_MAX+3)
418 #define ANYOF_NHORIZWS  (ANYOF_MAX+4)
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
427 /* Utility macros for the bitmap and classes of ANYOF */
428
429 #define ANYOF_SIZE              (sizeof(struct regnode_charclass))
430 #define ANYOF_CLASS_SIZE        (sizeof(struct regnode_charclass_class))
431
432 #define ANYOF_FLAGS(p)          ((p)->flags)
433
434 #define ANYOF_BIT(c)            (1 << ((c) & 7))
435
436 #define ANYOF_CLASS_BYTE(p, c)  (((struct regnode_charclass_class*)(p))->classflags[((c) >> 3) & 3])
437 #define ANYOF_CLASS_SET(p, c)   (ANYOF_CLASS_BYTE(p, c) |=  ANYOF_BIT(c))
438 #define ANYOF_CLASS_CLEAR(p, c) (ANYOF_CLASS_BYTE(p, c) &= ~ANYOF_BIT(c))
439 #define ANYOF_CLASS_TEST(p, c)  (ANYOF_CLASS_BYTE(p, c) &   ANYOF_BIT(c))
440
441 #define ANYOF_CLASS_ZERO(ret)   Zero(((struct regnode_charclass_class*)(ret))->classflags, ANYOF_CLASSBITMAP_SIZE, char)
442 #define ANYOF_CLASS_SETALL(ret)         \
443         memset (((struct regnode_charclass_class*)(ret))->classflags, 255, ANYOF_CLASSBITMAP_SIZE)
444 #define ANYOF_BITMAP_ZERO(ret)  Zero(((struct regnode_charclass*)(ret))->bitmap, ANYOF_BITMAP_SIZE, char)
445
446 #define ANYOF_BITMAP(p)         (((struct regnode_charclass*)(p))->bitmap)
447 #define ANYOF_BITMAP_BYTE(p, c) (ANYOF_BITMAP(p)[(((U8)(c)) >> 3) & 31])
448 #define ANYOF_BITMAP_SET(p, c)  (ANYOF_BITMAP_BYTE(p, c) |=  ANYOF_BIT(c))
449 #define ANYOF_BITMAP_CLEAR(p,c) (ANYOF_BITMAP_BYTE(p, c) &= ~ANYOF_BIT(c))
450 #define ANYOF_BITMAP_TEST(p, c) (ANYOF_BITMAP_BYTE(p, c) &   ANYOF_BIT(c))
451
452 #define ANYOF_BITMAP_SETALL(p)          \
453         memset (ANYOF_BITMAP(p), 255, ANYOF_BITMAP_SIZE)
454 #define ANYOF_BITMAP_CLEARALL(p)        \
455         Zero (ANYOF_BITMAP(p), ANYOF_BITMAP_SIZE)
456 /* Check that all 256 bits are all set.  Used in S_cl_is_anything()  */
457 #define ANYOF_BITMAP_TESTALLSET(p)      /* Assumes sizeof(p) == 32 */     \
458         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)
459
460 #define ANYOF_SKIP              ((ANYOF_SIZE - 1)/sizeof(regnode))
461 #define ANYOF_CLASS_SKIP        ((ANYOF_CLASS_SIZE - 1)/sizeof(regnode))
462
463 #if ANYOF_CLASSBITMAP_SIZE != 4
464 #   error ANYOF_CLASSBITMAP_SIZE is expected to be 4
465 #endif
466 #define ANYOF_CLASS_TEST_ANY_SET(p) ((ANYOF_FLAGS(p) & ANYOF_CLASS)         \
467         && memNE (((struct regnode_charclass_class*)(p))->classflags,       \
468                     "\0\0\0\0", ANYOF_CLASSBITMAP_SIZE))
469 /*#define ANYOF_CLASS_ADD_SKIP  (ANYOF_CLASS_SKIP - ANYOF_SKIP)
470  * */
471
472
473 /*
474  * Utility definitions.
475  */
476 #ifndef CHARMASK
477 #  define UCHARAT(p)    ((int)*(const U8*)(p))
478 #else
479 #  define UCHARAT(p)    ((int)*(p)&CHARMASK)
480 #endif
481
482 #define EXTRA_SIZE(guy) ((sizeof(guy)-1)/sizeof(struct regnode))
483
484 #define REG_SEEN_ZERO_LEN       0x00000001
485 #define REG_SEEN_LOOKBEHIND     0x00000002
486 #define REG_SEEN_GPOS           0x00000004
487 #define REG_SEEN_EVAL           0x00000008
488 #define REG_SEEN_CANY           0x00000010
489 #define REG_SEEN_SANY           REG_SEEN_CANY /* src bckwrd cmpt */
490 #define REG_SEEN_RECURSE        0x00000020
491 #define REG_TOP_LEVEL_BRANCHES  0x00000040
492 #define REG_SEEN_VERBARG        0x00000080
493 #define REG_SEEN_CUTGROUP       0x00000100
494 #define REG_SEEN_RUN_ON_COMMENT 0x00000200
495
496 START_EXTERN_C
497
498 #ifdef PLUGGABLE_RE_EXTENSION
499 #include "re_nodes.h"
500 #else
501 #include "regnodes.h"
502 #endif
503
504 #ifndef PLUGGABLE_RE_EXTENSION
505 #ifndef DOINIT
506 EXTCONST regexp_engine PL_core_reg_engine;
507 #else /* DOINIT */
508 EXTCONST regexp_engine PL_core_reg_engine = { 
509         Perl_re_compile,
510         Perl_regexec_flags,
511         Perl_re_intuit_start,
512         Perl_re_intuit_string, 
513         Perl_regfree_internal,
514         Perl_reg_numbered_buff_fetch,
515         Perl_reg_numbered_buff_store,
516         Perl_reg_numbered_buff_length,
517         Perl_reg_named_buff,
518         Perl_reg_named_buff_iter,
519         Perl_reg_qr_package,
520 #if defined(USE_ITHREADS)        
521         Perl_regdupe_internal
522 #endif        
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  *   n - Root of op tree for (?{EVAL}) item
536  *   o - Start op for (?{EVAL}) item
537  *   p - Pad for (?{EVAL}) item
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)  (((struct regexp *)SvANY(rx))->anchored_substr)
575 #define RX_ANCHORED_UTF8(rx)    (((struct regexp *)SvANY(rx))->anchored_utf8)
576 #define RX_FLOAT_SUBSTR(rx)     (((struct regexp *)SvANY(rx))->float_substr)
577 #define RX_FLOAT_UTF8(rx)       (((struct regexp *)SvANY(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.  re_debug_flags can get
825  * clobbered by a longjmp, so must be initialized */
826 #define GET_RE_DEBUG_FLAGS DEBUG_r({ \
827         SV * re_debug_flags_sv = NULL; \
828         re_debug_flags = 0;            \
829         re_debug_flags_sv = get_sv(RE_DEBUG_FLAGS, 1); \
830         if (re_debug_flags_sv) { \
831             if (!SvIOK(re_debug_flags_sv)) \
832                 sv_setuv(re_debug_flags_sv, RE_DEBUG_COMPILE_DUMP | RE_DEBUG_EXECUTE_MASK ); \
833             re_debug_flags=SvIV(re_debug_flags_sv); \
834         }\
835 })
836
837 #ifdef DEBUGGING
838
839 #define GET_RE_DEBUG_FLAGS_DECL VOL IV re_debug_flags \
840         __attribute__unused__ = 0; GET_RE_DEBUG_FLAGS;
841
842 #define RE_PV_COLOR_DECL(rpv,rlen,isuni,dsv,pv,l,m,c1,c2) \
843     const char * const rpv =                          \
844         pv_pretty((dsv), (pv), (l), (m), \
845             PL_colors[(c1)],PL_colors[(c2)], \
846             PERL_PV_ESCAPE_RE|PERL_PV_ESCAPE_NONASCII |((isuni) ? PERL_PV_ESCAPE_UNI : 0) );         \
847     const int rlen = SvCUR(dsv)
848
849 #define RE_SV_ESCAPE(rpv,isuni,dsv,sv,m) \
850     const char * const rpv =                          \
851         pv_pretty((dsv), (SvPV_nolen_const(sv)), (SvCUR(sv)), (m), \
852             PL_colors[(c1)],PL_colors[(c2)], \
853             PERL_PV_ESCAPE_RE|PERL_PV_ESCAPE_NONASCII |((isuni) ? PERL_PV_ESCAPE_UNI : 0) )
854
855 #define RE_PV_QUOTED_DECL(rpv,isuni,dsv,pv,l,m)                    \
856     const char * const rpv =                                       \
857         pv_pretty((dsv), (pv), (l), (m), \
858             PL_colors[0], PL_colors[1], \
859             ( PERL_PV_PRETTY_QUOTE | PERL_PV_ESCAPE_RE | PERL_PV_ESCAPE_NONASCII | PERL_PV_PRETTY_ELLIPSES | \
860               ((isuni) ? PERL_PV_ESCAPE_UNI : 0))                  \
861         )
862
863 #define RE_SV_DUMPLEN(ItEm) (SvCUR(ItEm) - (SvTAIL(ItEm)!=0))
864 #define RE_SV_TAIL(ItEm) (SvTAIL(ItEm) ? "$" : "")
865     
866 #else /* if not DEBUGGING */
867
868 #define GET_RE_DEBUG_FLAGS_DECL
869 #define RE_PV_COLOR_DECL(rpv,rlen,isuni,dsv,pv,l,m,c1,c2)
870 #define RE_SV_ESCAPE(rpv,isuni,dsv,sv,m)
871 #define RE_PV_QUOTED_DECL(rpv,isuni,dsv,pv,l,m)
872 #define RE_SV_DUMPLEN(ItEm)
873 #define RE_SV_TAIL(ItEm)
874
875 #endif /* DEBUG RELATED DEFINES */
876
877 /*
878  * Local variables:
879  * c-indentation-style: bsd
880  * c-basic-offset: 4
881  * indent-tabs-mode: t
882  * End:
883  *
884  * ex: set ts=8 sts=4 sw=4 noet:
885  */