The space computation for hexfp was overovershooting.
[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 RXp_INTFLAGS(rx)        ((rx)->intflags)
129 #define RX_INTFLAGS(prog)        RXp_INTFLAGS(ReANY(prog))
130
131 #define PREGf_SKIP              0x00000001
132 #define PREGf_IMPLICIT          0x00000002 /* Converted .* to ^.* */
133 #define PREGf_NAUGHTY           0x00000004 /* how exponential is this pattern? */
134 #define PREGf_VERBARG_SEEN      0x00000008
135 #define PREGf_CUTGROUP_SEEN     0x00000010
136 #define PREGf_USE_RE_EVAL       0x00000020 /* compiled with "use re 'eval'" */
137 /* these used to be extflags, but are now intflags */
138 #define PREGf_NOSCAN            0x00000040
139 #define PREGf_CANY_SEEN         0x00000080
140 #define PREGf_GPOS_SEEN         0x00000100
141 #define PREGf_GPOS_FLOAT        0x00000200
142
143 #define PREGf_ANCH_BOL          0x00000400
144 #define PREGf_ANCH_MBOL         0x00000800
145 #define PREGf_ANCH_SBOL         0x00001000
146 #define PREGf_ANCH_GPOS         0x00002000
147
148 #define PREGf_ANCH              (PREGf_ANCH_SBOL | PREGf_ANCH_GPOS | \
149                                  PREGf_ANCH_MBOL | PREGf_ANCH_BOL )
150
151 /* this is where the old regcomp.h started */
152
153 struct regnode_string {
154     U8  str_len;
155     U8  type;
156     U16 next_off;
157     char string[1];
158 };
159
160 /* Argument bearing node - workhorse, 
161    arg1 is often for the data field */
162 struct regnode_1 {
163     U8  flags;
164     U8  type;
165     U16 next_off;
166     U32 arg1;
167 };
168
169 /* Similar to a regnode_1 but with an extra signed argument */
170 struct regnode_2L {
171     U8  flags;
172     U8  type;
173     U16 next_off;
174     U32 arg1;
175     I32 arg2;
176 };
177
178 /* 'Two field' -- Two 16 bit unsigned args */
179 struct regnode_2 {
180     U8  flags;
181     U8  type;
182     U16 next_off;
183     U16 arg1;
184     U16 arg2;
185 };
186
187 /* This give the number of code points that can be in the bitmap of an ANYOF
188  * node.  The shift number must currently be one of: 8..12.  It can't be less
189  * than 8 (256) because some code relies on it being at least that.  Above 12
190  * (4096), and you start running into warnings that some data structure widths
191  * have been exceeded, though the test suite as of this writing still passes
192  * for up through 16, which is as high as anyone would ever want to go,
193  * encompassing all of the Unicode BMP, and thus including all the economically
194  * important world scripts.  At 12 most of them are: including Arabic,
195  * Cyrillic, Greek, Hebrew, Indian subcontinent, Latin, and Thai; but not Han,
196  * Japanese, nor Korean.  (The regarglen structure in regnodes.h is a U8, and
197  * the trie types TRIEC and AHOCORASICKC are larger than U8 for shift values
198  * below above 12.)  Be sure to benchmark before changing, as larger sizes do
199  * significantly slow down the test suite */
200 #define NUM_ANYOF_CODE_POINTS   (1 << 8)
201
202 #define ANYOF_BITMAP_SIZE       (NUM_ANYOF_CODE_POINTS / 8)   /* 8 bits/Byte */
203
204 /* Note that these form structs which are supersets of the next smaller one, by
205  * appending fields.  Alignment problems can occur if one of those optional
206  * fields requires stricter alignment than the base struct.  And formal
207  * parameters that can really be two or more of the structs should be
208  * declared as the smallest one it could be.  See commit message for
209  * 7dcac5f6a5195002b55c935ee1d67f67e1df280b.  Regnode allocation is done
210  * without regard to alignment, and changing it to would also require changing
211  * the code that inserts and deletes regnodes.  The basic single-argument
212  * regnode has a U32, which is what reganode() allocates as a unit.  Therefore
213  * no field can require stricter alignment than U32. */
214
215 /* also used by trie */
216 struct regnode_charclass {
217     U8  flags;
218     U8  type;
219     U16 next_off;
220     U32 arg1;
221     char bitmap[ANYOF_BITMAP_SIZE];     /* only compile-time */
222 };
223
224 /* has runtime (locale) \d, \w, ..., [:posix:] classes */
225 struct regnode_charclass_class {
226     U8  flags;                      /* ANYOF_MATCHES_POSIXL bit must go here */
227     U8  type;
228     U16 next_off;
229     U32 arg1;
230     char bitmap[ANYOF_BITMAP_SIZE];             /* both compile-time ... */
231     U32 classflags;                             /* and run-time */
232 };
233
234 /* A synthetic start class (SSC); is a regnode_charclass_posixl_fold, plus an
235  * extra SV*, used only during its construction and which is not used by
236  * regexec.c.  Note that the 'next_off' field is unused, as the SSC stands
237  * alone, so there is never a next node.  Also, there is no alignment issue,
238  * becase these are declared or allocated as a complete unit so the compiler
239  * takes care of alignment.  This is unlike the other regnodes which are
240  * allocated in terms of multiples of a single-argument regnode.  SSC nodes can
241  * have a pointer field because there is no alignment issue, and because it is
242  * set to NULL after construction, before any cloning of the pattern */
243 struct regnode_ssc {
244     U8  flags;                      /* ANYOF_MATCHES_POSIXL bit must go here */
245     U8  type;
246     U16 next_off;
247     U32 arg1;
248     char bitmap[ANYOF_BITMAP_SIZE];     /* both compile-time ... */
249     U32 classflags;                     /* and run-time */
250
251     /* Auxiliary, only used during construction; NULL afterwards: list of code
252      * points matched */
253     SV* invlist;
254 };
255
256 /*  We take advantage of 'next_off' not otherwise being used in the SSC by
257  *  actually using it: by setting it to 1.  This allows us to test and
258  *  distinguish between an SSC and other ANYOF node types, as 'next_off' cannot
259  *  otherwise be 1, because it is the offset to the next regnode expressed in
260  *  units of regnodes.  Since an ANYOF node contains extra fields, it adds up
261  *  to 12 regnode units on 32-bit systems, (hence the minimum this can be (if
262  *  not 0) is 11 there.  Even if things get tightly packed on a 64-bit system,
263  *  it still would be more than 1. */
264 #define set_ANYOF_SYNTHETIC(n) STMT_START{ OP(n) = ANYOF;              \
265                                            NEXT_OFF(n) = 1;            \
266                                } STMT_END
267 #define is_ANYOF_SYNTHETIC(n) (OP(n) == ANYOF && NEXT_OFF(n) == 1)
268
269 /* XXX fix this description.
270    Impose a limit of REG_INFTY on various pattern matching operations
271    to limit stack growth and to avoid "infinite" recursions.
272 */
273 /* The default size for REG_INFTY is I16_MAX, which is the same as
274    SHORT_MAX (see perl.h).  Unfortunately I16 isn't necessarily 16 bits
275    (see handy.h).  On the Cray C90, sizeof(short)==4 and hence I16_MAX is
276    ((1<<31)-1), while on the Cray T90, sizeof(short)==8 and I16_MAX is
277    ((1<<63)-1).  To limit stack growth to reasonable sizes, supply a
278    smaller default.
279         --Andy Dougherty  11 June 1998
280 */
281 #if SHORTSIZE > 2
282 #  ifndef REG_INFTY
283 #    define REG_INFTY ((1<<15)-1)
284 #  endif
285 #endif
286
287 #ifndef REG_INFTY
288 #  define REG_INFTY I16_MAX
289 #endif
290
291 #define ARG_VALUE(arg) (arg)
292 #define ARG__SET(arg,val) ((arg) = (val))
293
294 #undef ARG
295 #undef ARG1
296 #undef ARG2
297
298 #define ARG(p) ARG_VALUE(ARG_LOC(p))
299 #define ARG1(p) ARG_VALUE(ARG1_LOC(p))
300 #define ARG2(p) ARG_VALUE(ARG2_LOC(p))
301 #define ARG2L(p) ARG_VALUE(ARG2L_LOC(p))
302
303 #define ARG_SET(p, val) ARG__SET(ARG_LOC(p), (val))
304 #define ARG1_SET(p, val) ARG__SET(ARG1_LOC(p), (val))
305 #define ARG2_SET(p, val) ARG__SET(ARG2_LOC(p), (val))
306 #define ARG2L_SET(p, val) ARG__SET(ARG2L_LOC(p), (val))
307
308 #undef NEXT_OFF
309 #undef NODE_ALIGN
310
311 #define NEXT_OFF(p) ((p)->next_off)
312 #define NODE_ALIGN(node)
313 #define NODE_ALIGN_FILL(node) ((node)->flags = 0xde) /* deadbeef */
314
315 #define SIZE_ALIGN NODE_ALIGN
316
317 #undef OP
318 #undef OPERAND
319 #undef MASK
320 #undef STRING
321
322 #define OP(p)           ((p)->type)
323 #define FLAGS(p)        ((p)->flags)    /* Caution: Doesn't apply to all      \
324                                            regnode types.  For some, it's the \
325                                            character set of the regnode */
326 #define OPERAND(p)      (((struct regnode_string *)p)->string)
327 #define MASK(p)         ((char*)OPERAND(p))
328 #define STR_LEN(p)      (((struct regnode_string *)p)->str_len)
329 #define STRING(p)       (((struct regnode_string *)p)->string)
330 #define STR_SZ(l)       ((l + sizeof(regnode) - 1) / sizeof(regnode))
331 #define NODE_SZ_STR(p)  (STR_SZ(STR_LEN(p))+1)
332
333 #undef NODE_ALIGN
334 #undef ARG_LOC
335 #undef NEXTOPER
336 #undef PREVOPER
337
338 #define NODE_ALIGN(node)
339 #define ARG_LOC(p)      (((struct regnode_1 *)p)->arg1)
340 #define ARG1_LOC(p)     (((struct regnode_2 *)p)->arg1)
341 #define ARG2_LOC(p)     (((struct regnode_2 *)p)->arg2)
342 #define ARG2L_LOC(p)    (((struct regnode_2L *)p)->arg2)
343
344 #define NODE_STEP_REGNODE       1       /* sizeof(regnode)/sizeof(regnode) */
345 #define EXTRA_STEP_2ARGS        EXTRA_SIZE(struct regnode_2)
346
347 #define NODE_STEP_B     4
348
349 #define NEXTOPER(p)     ((p) + NODE_STEP_REGNODE)
350 #define PREVOPER(p)     ((p) - NODE_STEP_REGNODE)
351
352 #define FILL_ADVANCE_NODE(ptr, op) STMT_START { \
353     (ptr)->type = op;    (ptr)->next_off = 0;   (ptr)++; } STMT_END
354 #define FILL_ADVANCE_NODE_ARG(ptr, op, arg) STMT_START { \
355     ARG_SET(ptr, arg);  FILL_ADVANCE_NODE(ptr, op); (ptr) += 1; } STMT_END
356
357 #define REG_MAGIC 0234
358
359 #define SIZE_ONLY (RExC_emit == (regnode *) & RExC_emit_dummy)
360 #define PASS1 SIZE_ONLY
361 #define PASS2 (! SIZE_ONLY)
362
363 /* If the bitmap fully represents what this ANYOF node can match, the
364  * ARG is set to this special value (since 0, 1, ... are legal, but will never
365  * reach this high). */
366 #define ANYOF_ONLY_HAS_BITMAP   ((U32) -1)
367
368 /* Flags for node->flags of ANYOF.  These are in short supply, with none
369  * currently available.  The ABOVE_BITMAP_ALL bit could be freed up
370  * by resorting to creating a swash containing everything above 255.  This
371  * introduces a performance penalty.  An option that wouldn't slow things down
372  * would be to split one of the two LOC flags out into a separate
373  * node, like what was done with ANYOF_NON_UTF8_NON_ASCII_ALL in commit
374  * 34fdef848b1687b91892ba55e9e0c3430e0770f6 (but which was reverted because it
375  * wasn't the best option available at the time), and using a LOC flag is
376  * probably better than that commit anyway.  But it could be reinstated if we
377  * need a bit.  The LOC flags are only for /l nodes; the reverted commit was
378  * only for /d, so there are no combinatorial issues.  The LOC flag to use is
379  * probably the POSIXL one.
380  * Several flags are not used in synthetic start class (SSC) nodes, so could be
381  * shared should new flags be needed for SSCs, like SSC_MATCHES_EMPTY_STRING
382  * now. */
383
384 /* regexec.c is expecting this to be in the low bit */
385 #define ANYOF_INVERT                            0x01
386
387 /* For the SSC node only, which cannot be inverted, so is shared with that bit.
388  * This is used only during regex compilation. */
389 #define SSC_MATCHES_EMPTY_STRING                ANYOF_INVERT
390
391 /* Are there things outside the bitmap that will match only if the target
392  * string is encoded in UTF-8?  (This is not set if ANYOF_ABOVE_BITMAP_ALL is
393  * set) */
394 #define ANYOF_HAS_UTF8_NONBITMAP_MATCHES        0x02
395
396 /* The fold is calculated and stored in the bitmap where possible at compile
397  * time.  However under locale, the actual folding varies depending on
398  * what the locale is at the time of execution, so it has to be deferred until
399  * then */
400 #define ANYOF_LOC_FOLD                          0x04
401
402 /* Set if this is a regnode_charclass_posixl vs a regnode_charclass.  This
403  * is used for runtime \d, \w, [:posix:], ..., which are used only in locale
404  * and the optimizer's synthetic start class.  Non-locale \d, etc are resolved
405  * at compile-time */
406 #define ANYOF_MATCHES_POSIXL                    0x08
407
408 /* Should we raise a warning if matching against an above-Unicode code point?
409  * */
410 #define ANYOF_WARN_SUPER                        0x10
411
412 /* Can match something outside the bitmap that isn't in utf8 */
413 #define ANYOF_HAS_NONBITMAP_NON_UTF8_MATCHES    0x20
414
415 /* Matches every code point NUM_ANYOF_CODE_POINTS and above*/
416 #define ANYOF_MATCHES_ALL_ABOVE_BITMAP          0x40
417
418 /* Match all Latin1 characters that aren't ASCII when the target string is not
419  * in utf8. */
420 #define ANYOF_MATCHES_ALL_NON_UTF8_NON_ASCII    0x80
421
422 #define ANYOF_FLAGS_ALL         (0xff)
423
424 #define ANYOF_LOCALE_FLAGS (ANYOF_LOC_FOLD | ANYOF_MATCHES_POSIXL)
425
426 /* These are the flags that apply to both regular ANYOF nodes and synthetic
427  * start class nodes during construction of the SSC.  During finalization of
428  * the SSC, other of the flags could be added to it */
429 #define ANYOF_COMMON_FLAGS    (ANYOF_WARN_SUPER|ANYOF_HAS_UTF8_NONBITMAP_MATCHES)
430
431 /* Character classes for node->classflags of ANYOF */
432 /* Should be synchronized with a table in regprop() */
433 /* 2n should be the normal one, paired with its complement at 2n+1 */
434
435 #define ANYOF_ALPHA    ((_CC_ALPHA) * 2)
436 #define ANYOF_NALPHA   ((ANYOF_ALPHA) + 1)
437 #define ANYOF_ALPHANUMERIC   ((_CC_ALPHANUMERIC) * 2)    /* [[:alnum:]] isalnum(3), utf8::IsAlnum */
438 #define ANYOF_NALPHANUMERIC  ((ANYOF_ALPHANUMERIC) + 1)
439 #define ANYOF_ASCII    ((_CC_ASCII) * 2)
440 #define ANYOF_NASCII   ((ANYOF_ASCII) + 1)
441 #define ANYOF_BLANK    ((_CC_BLANK) * 2)     /* GNU extension: space and tab: non-vertical space */
442 #define ANYOF_NBLANK   ((ANYOF_BLANK) + 1)
443 #define ANYOF_CASED    ((_CC_CASED) * 2)    /* Pseudo class for [:lower:] or
444                                                [:upper:] under /i */
445 #define ANYOF_NCASED   ((ANYOF_CASED) + 1)
446 #define ANYOF_CNTRL    ((_CC_CNTRL) * 2)
447 #define ANYOF_NCNTRL   ((ANYOF_CNTRL) + 1)
448 #define ANYOF_DIGIT    ((_CC_DIGIT) * 2)     /* \d */
449 #define ANYOF_NDIGIT   ((ANYOF_DIGIT) + 1)
450 #define ANYOF_GRAPH    ((_CC_GRAPH) * 2)
451 #define ANYOF_NGRAPH   ((ANYOF_GRAPH) + 1)
452 #define ANYOF_LOWER    ((_CC_LOWER) * 2)
453 #define ANYOF_NLOWER   ((ANYOF_LOWER) + 1)
454 #define ANYOF_PRINT    ((_CC_PRINT) * 2)
455 #define ANYOF_NPRINT   ((ANYOF_PRINT) + 1)
456 #define ANYOF_PSXSPC   ((_CC_PSXSPC) * 2)    /* POSIX space: \s plus the vertical tab */
457 #define ANYOF_NPSXSPC  ((ANYOF_PSXSPC) + 1)
458 #define ANYOF_PUNCT    ((_CC_PUNCT) * 2)
459 #define ANYOF_NPUNCT   ((ANYOF_PUNCT) + 1)
460 #define ANYOF_SPACE    ((_CC_SPACE) * 2)     /* \s */
461 #define ANYOF_NSPACE   ((ANYOF_SPACE) + 1)
462 #define ANYOF_UPPER    ((_CC_UPPER) * 2)
463 #define ANYOF_NUPPER   ((ANYOF_UPPER) + 1)
464 #define ANYOF_WORDCHAR ((_CC_WORDCHAR) * 2)  /* \w, PL_utf8_alnum, utf8::IsWord, ALNUM */
465 #define ANYOF_NWORDCHAR   ((ANYOF_WORDCHAR) + 1)
466 #define ANYOF_XDIGIT   ((_CC_XDIGIT) * 2)
467 #define ANYOF_NXDIGIT  ((ANYOF_XDIGIT) + 1)
468
469 /* pseudo classes below this, not stored in the class bitmap, but used as flags
470    during compilation of char classes */
471
472 #define ANYOF_VERTWS    ((_CC_VERTSPACE) * 2)
473 #define ANYOF_NVERTWS   ((ANYOF_VERTWS)+1)
474
475 /* It is best if this is the last one, as all above it are stored as bits in a
476  * bitmap, and it isn't part of that bitmap */
477 #if _CC_VERTSPACE != _HIGHEST_REGCOMP_DOT_H_SYNC
478 #   error Problem with handy.h _HIGHEST_REGCOMP_DOT_H_SYNC #define
479 #endif
480
481 #define ANYOF_POSIXL_MAX (ANYOF_VERTWS) /* So upper loop limit is written:
482                                          *       '< ANYOF_MAX'
483                                          * Hence doesn't include VERTWS, as that
484                                          * is a pseudo class */
485 #define ANYOF_MAX      ANYOF_POSIXL_MAX
486
487 #if (ANYOF_POSIXL_MAX > 32)   /* Must fit in 32-bit word */
488 #   error Problem with handy.h _CC_foo #defines
489 #endif
490
491 #define ANYOF_HORIZWS   ((ANYOF_POSIXL_MAX)+2) /* = (ANYOF_NVERTWS + 1) */
492 #define ANYOF_NHORIZWS  ((ANYOF_POSIXL_MAX)+3)
493
494 #define ANYOF_UNIPROP   ((ANYOF_POSIXL_MAX)+4)  /* Used to indicate a Unicode
495                                                    property: \p{} or \P{} */
496
497 /* Backward source code compatibility. */
498
499 #define ANYOF_ALNUML     ANYOF_ALNUM
500 #define ANYOF_NALNUML    ANYOF_NALNUM
501 #define ANYOF_SPACEL     ANYOF_SPACE
502 #define ANYOF_NSPACEL    ANYOF_NSPACE
503 #define ANYOF_ALNUM ANYOF_WORDCHAR
504 #define ANYOF_NALNUM ANYOF_NWORDCHAR
505
506 /* Utility macros for the bitmap and classes of ANYOF */
507
508 #define ANYOF_SIZE              (sizeof(struct regnode_charclass))
509 #define ANYOF_POSIXL_SIZE       (sizeof(regnode_charclass_posixl))
510 #define ANYOF_CLASS_SIZE        ANYOF_POSIXL_SIZE
511
512 #define ANYOF_FLAGS(p)          ((p)->flags)
513
514 #define ANYOF_BIT(c)            (1U << ((c) & 7))
515
516 #define ANYOF_POSIXL_SET(p, c)  (((regnode_charclass_posixl*) (p))->classflags |= (1U << (c)))
517 #define ANYOF_CLASS_SET(p, c)   ANYOF_POSIXL_SET((p), (c))
518
519 #define ANYOF_POSIXL_CLEAR(p, c) (((regnode_charclass_posixl*) (p))->classflags &= ~ (1U <<(c)))
520 #define ANYOF_CLASS_CLEAR(p, c) ANYOF_POSIXL_CLEAR((p), (c))
521
522 #define ANYOF_POSIXL_TEST(p, c) (((regnode_charclass_posixl*) (p))->classflags & (1U << (c)))
523 #define ANYOF_CLASS_TEST(p, c)  ANYOF_POSIXL_TEST((p), (c))
524
525 #define ANYOF_POSIXL_ZERO(ret)  STMT_START { ((regnode_charclass_posixl*) (ret))->classflags = 0; } STMT_END
526 #define ANYOF_CLASS_ZERO(ret)   ANYOF_POSIXL_ZERO(ret)
527
528 /* Shifts a bit to get, eg. 0x4000_0000, then subtracts 1 to get 0x3FFF_FFFF */
529 #define ANYOF_POSIXL_SETALL(ret) STMT_START { ((regnode_charclass_posixl*) (ret))->classflags = ((1U << ((ANYOF_POSIXL_MAX) - 1))) - 1; } STMT_END
530 #define ANYOF_CLASS_SETALL(ret) ANYOF_POSIXL_SETALL(ret)
531
532 #define ANYOF_POSIXL_TEST_ANY_SET(p)                               \
533         ((ANYOF_FLAGS(p) & ANYOF_MATCHES_POSIXL)                           \
534          && (((regnode_charclass_posixl*)(p))->classflags))
535 #define ANYOF_CLASS_TEST_ANY_SET(p) ANYOF_POSIXL_TEST_ANY_SET(p)
536
537 /* Since an SSC always has this field, we don't have to test for that; nor do
538  * we want to because the bit isn't set for SSC during its construction */
539 #define ANYOF_POSIXL_SSC_TEST_ANY_SET(p)                               \
540                             cBOOL(((regnode_ssc*)(p))->classflags)
541 #define ANYOF_POSIXL_SSC_TEST_ALL_SET(p) /* Are all bits set? */       \
542         (((regnode_ssc*) (p))->classflags                              \
543                         == ((1U << ((ANYOF_POSIXL_MAX) - 1))) - 1)
544
545 #define ANYOF_POSIXL_TEST_ALL_SET(p)                                   \
546         ((ANYOF_FLAGS(p) & ANYOF_MATCHES_POSIXL)                               \
547          && ((regnode_charclass_posixl*) (p))->classflags              \
548                         == ((1U << ((ANYOF_POSIXL_MAX) - 1))) - 1)
549
550 #define ANYOF_POSIXL_OR(source, dest) STMT_START { (dest)->classflags |= (source)->classflags ; } STMT_END
551 #define ANYOF_CLASS_OR(source, dest) ANYOF_POSIXL_OR((source), (dest))
552
553 #define ANYOF_POSIXL_AND(source, dest) STMT_START { (dest)->classflags &= (source)->classflags ; } STMT_END
554
555 #define ANYOF_BITMAP_ZERO(ret)  Zero(((struct regnode_charclass*)(ret))->bitmap, ANYOF_BITMAP_SIZE, char)
556 #define ANYOF_BITMAP(p)         (((struct regnode_charclass*)(p))->bitmap)
557 #define ANYOF_BITMAP_BYTE(p, c) (ANYOF_BITMAP(p)[(((U8)(c)) >> 3) & 31])
558 #define ANYOF_BITMAP_SET(p, c)  (ANYOF_BITMAP_BYTE(p, c) |=  ANYOF_BIT(c))
559 #define ANYOF_BITMAP_CLEAR(p,c) (ANYOF_BITMAP_BYTE(p, c) &= ~ANYOF_BIT(c))
560 #define ANYOF_BITMAP_TEST(p, c) cBOOL(ANYOF_BITMAP_BYTE(p, c) &   ANYOF_BIT(c))
561
562 #define ANYOF_BITMAP_SETALL(p)          \
563         memset (ANYOF_BITMAP(p), 255, ANYOF_BITMAP_SIZE)
564 #define ANYOF_BITMAP_CLEARALL(p)        \
565         Zero (ANYOF_BITMAP(p), ANYOF_BITMAP_SIZE)
566
567 #define ANYOF_SKIP              ((ANYOF_SIZE - 1)/sizeof(regnode))
568 #define ANYOF_POSIXL_SKIP       ((ANYOF_POSIXL_SIZE - 1)/sizeof(regnode))
569 #define ANYOF_CLASS_SKIP        ANYOF_POSIXL_SKIP
570
571 /*
572  * Utility definitions.
573  */
574 #ifndef CHARMASK
575 #  define UCHARAT(p)    ((int)*(const U8*)(p))
576 #else
577 #  define UCHARAT(p)    ((int)*(p)&CHARMASK)
578 #endif
579
580 #define EXTRA_SIZE(guy) ((sizeof(guy)-1)/sizeof(struct regnode))
581
582 #define REG_ZERO_LEN_SEEN                   0x00000001
583 #define REG_LOOKBEHIND_SEEN                 0x00000002
584 #define REG_GPOS_SEEN                       0x00000004
585 /* spare */
586 #define REG_CANY_SEEN                       0x00000010
587 #define REG_RECURSE_SEEN                    0x00000020
588 #define REG_TOP_LEVEL_BRANCHES_SEEN         0x00000040
589 #define REG_VERBARG_SEEN                    0x00000080
590 #define REG_CUTGROUP_SEEN                   0x00000100
591 #define REG_RUN_ON_COMMENT_SEEN             0x00000200
592 #define REG_UNFOLDED_MULTI_SEEN             0x00000400
593 #define REG_GOSTART_SEEN                    0x00000800
594 #define REG_UNBOUNDED_QUANTIFIER_SEEN       0x00001000
595
596
597 START_EXTERN_C
598
599 #ifdef PLUGGABLE_RE_EXTENSION
600 #include "re_nodes.h"
601 #else
602 #include "regnodes.h"
603 #endif
604
605 #ifndef PLUGGABLE_RE_EXTENSION
606 #ifndef DOINIT
607 EXTCONST regexp_engine PL_core_reg_engine;
608 #else /* DOINIT */
609 EXTCONST regexp_engine PL_core_reg_engine = { 
610         Perl_re_compile,
611         Perl_regexec_flags,
612         Perl_re_intuit_start,
613         Perl_re_intuit_string, 
614         Perl_regfree_internal,
615         Perl_reg_numbered_buff_fetch,
616         Perl_reg_numbered_buff_store,
617         Perl_reg_numbered_buff_length,
618         Perl_reg_named_buff,
619         Perl_reg_named_buff_iter,
620         Perl_reg_qr_package,
621 #if defined(USE_ITHREADS)        
622         Perl_regdupe_internal,
623 #endif        
624         Perl_re_op_compile
625 };
626 #endif /* DOINIT */
627 #endif /* PLUGGABLE_RE_EXTENSION */
628
629
630 END_EXTERN_C
631
632
633 /* .what is a character array with one character for each member of .data
634  * The character describes the function of the corresponding .data item:
635  *   a - AV for paren_name_list under DEBUGGING
636  *   f - start-class data for regstclass optimization
637  *   l - start op for literal (?{EVAL}) item
638  *   L - start op for literal (?{EVAL}) item, with separate CV (qr//)
639  *   r - pointer to an embedded code-containing qr, e.g. /ab$qr/
640  *   s - swash for Unicode-style character class, and the multicharacter
641  *       strings resulting from casefolding the single-character entries
642  *       in the character class
643  *   t - trie struct
644  *   u - trie struct's widecharmap (a HV, so can't share, must dup)
645  *       also used for revcharmap and words under DEBUGGING
646  *   T - aho-trie struct
647  *   S - sv for named capture lookup
648  * 20010712 mjd@plover.com
649  * (Remember to update re_dup() and pregfree() if you add any items.)
650  */
651 struct reg_data {
652     U32 count;
653     U8 *what;
654     void* data[1];
655 };
656
657 /* Code in S_to_utf8_substr() and S_to_byte_substr() in regexec.c accesses
658    anchored* and float* via array indexes 0 and 1.  */
659 #define anchored_substr substrs->data[0].substr
660 #define anchored_utf8 substrs->data[0].utf8_substr
661 #define anchored_offset substrs->data[0].min_offset
662 #define anchored_end_shift substrs->data[0].end_shift
663
664 #define float_substr substrs->data[1].substr
665 #define float_utf8 substrs->data[1].utf8_substr
666 #define float_min_offset substrs->data[1].min_offset
667 #define float_max_offset substrs->data[1].max_offset
668 #define float_end_shift substrs->data[1].end_shift
669
670 #define check_substr substrs->data[2].substr
671 #define check_utf8 substrs->data[2].utf8_substr
672 #define check_offset_min substrs->data[2].min_offset
673 #define check_offset_max substrs->data[2].max_offset
674 #define check_end_shift substrs->data[2].end_shift
675
676 #define RX_ANCHORED_SUBSTR(rx)  (ReANY(rx)->anchored_substr)
677 #define RX_ANCHORED_UTF8(rx)    (ReANY(rx)->anchored_utf8)
678 #define RX_FLOAT_SUBSTR(rx)     (ReANY(rx)->float_substr)
679 #define RX_FLOAT_UTF8(rx)       (ReANY(rx)->float_utf8)
680
681 /* trie related stuff */
682
683 /* a transition record for the state machine. the
684    check field determines which state "owns" the
685    transition. the char the transition is for is
686    determined by offset from the owning states base
687    field.  the next field determines which state
688    is to be transitioned to if any.
689 */
690 struct _reg_trie_trans {
691   U32 next;
692   U32 check;
693 };
694
695 /* a transition list element for the list based representation */
696 struct _reg_trie_trans_list_elem {
697     U16 forid;
698     U32 newstate;
699 };
700 typedef struct _reg_trie_trans_list_elem reg_trie_trans_le;
701
702 /* a state for compressed nodes. base is an offset
703   into an array of reg_trie_trans array. If wordnum is
704   nonzero the state is accepting. if base is zero then
705   the state has no children (and will be accepting)
706 */
707 struct _reg_trie_state {
708   U16 wordnum;
709   union {
710     U32                base;
711     reg_trie_trans_le* list;
712   } trans;
713 };
714
715 /* info per word; indexed by wordnum */
716 typedef struct {
717     U16  prev;  /* previous word in acceptance chain; eg in
718                  * zzz|abc|ab/ after matching the chars abc, the
719                  * accepted word is #2, and the previous accepted
720                  * word is #3 */
721     U32 len;    /* how many chars long is this word? */
722     U32 accept; /* accept state for this word */
723 } reg_trie_wordinfo;
724
725
726 typedef struct _reg_trie_state    reg_trie_state;
727 typedef struct _reg_trie_trans    reg_trie_trans;
728
729
730 /* anything in here that needs to be freed later
731    should be dealt with in pregfree.
732    refcount is first in both this and _reg_ac_data to allow a space
733    optimisation in Perl_regdupe.  */
734 struct _reg_trie_data {
735     U32             refcount;        /* number of times this trie is referenced */
736     U32             lasttrans;       /* last valid transition element */
737     U16             *charmap;        /* byte to charid lookup array */
738     reg_trie_state  *states;         /* state data */
739     reg_trie_trans  *trans;          /* array of transition elements */
740     char            *bitmap;         /* stclass bitmap */
741     U16             *jump;           /* optional 1 indexed array of offsets before tail 
742                                         for the node following a given word. */
743     reg_trie_wordinfo *wordinfo;     /* array of info per word */
744     U16             uniquecharcount; /* unique chars in trie (width of trans table) */
745     U32             startstate;      /* initial state - used for common prefix optimisation */
746     STRLEN          minlen;          /* minimum length of words in trie - build/opt only? */
747     STRLEN          maxlen;          /* maximum length of words in trie - build/opt only? */
748     U32             prefixlen;       /* #chars in common prefix */
749     U32             statecount;      /* Build only - number of states in the states array 
750                                         (including the unused zero state) */
751     U32             wordcount;       /* Build only */
752 #ifdef DEBUGGING
753     STRLEN          charcount;       /* Build only */
754 #endif
755 };
756 /* There is one (3 under DEBUGGING) pointers that logically belong in this
757    structure, but are held outside as they need duplication on thread cloning,
758    whereas the rest of the structure can be read only:
759     HV              *widecharmap;    code points > 255 to charid
760 #ifdef DEBUGGING
761     AV              *words;          Array of words contained in trie, for dumping
762     AV              *revcharmap;     Map of each charid back to its character representation
763 #endif
764 */
765
766 #define TRIE_WORDS_OFFSET 2
767
768 typedef struct _reg_trie_data reg_trie_data;
769
770 /* refcount is first in both this and _reg_trie_data to allow a space
771    optimisation in Perl_regdupe.  */
772 struct _reg_ac_data {
773     U32              refcount;
774     U32              trie;
775     U32              *fail;
776     reg_trie_state   *states;
777 };
778 typedef struct _reg_ac_data reg_ac_data;
779
780 /* ANY_BIT doesn't use the structure, so we can borrow it here.
781    This is simpler than refactoring all of it as wed end up with
782    three different sets... */
783
784 #define TRIE_BITMAP(p)          (((reg_trie_data *)(p))->bitmap)
785 #define TRIE_BITMAP_BYTE(p, c)  (TRIE_BITMAP(p)[(((U8)(c)) >> 3) & 31])
786 #define TRIE_BITMAP_SET(p, c)   (TRIE_BITMAP_BYTE(p, c) |=  ANYOF_BIT((U8)c))
787 #define TRIE_BITMAP_CLEAR(p,c)  (TRIE_BITMAP_BYTE(p, c) &= ~ANYOF_BIT((U8)c))
788 #define TRIE_BITMAP_TEST(p, c)  (TRIE_BITMAP_BYTE(p, c) &   ANYOF_BIT((U8)c))
789
790 #define IS_ANYOF_TRIE(op) ((op)==TRIEC || (op)==AHOCORASICKC)
791 #define IS_TRIE_AC(op) ((op)>=AHOCORASICK)
792
793
794 #define BITMAP_BYTE(p, c)       (((U8*)p)[(((U8)(c)) >> 3) & 31])
795 #define BITMAP_TEST(p, c)       (BITMAP_BYTE(p, c) &   ANYOF_BIT((U8)c))
796
797 /* these defines assume uniquecharcount is the correct variable, and state may be evaluated twice */
798 #define TRIE_NODENUM(state) (((state)-1)/(trie->uniquecharcount)+1)
799 #define SAFE_TRIE_NODENUM(state) ((state) ? (((state)-1)/(trie->uniquecharcount)+1) : (state))
800 #define TRIE_NODEIDX(state) ((state) ? (((state)-1)*(trie->uniquecharcount)+1) : (state))
801
802 #ifdef DEBUGGING
803 #define TRIE_CHARCOUNT(trie) ((trie)->charcount)
804 #else
805 #define TRIE_CHARCOUNT(trie) (trie_charcount)
806 #endif
807
808 #define RE_TRIE_MAXBUF_INIT 65536
809 #define RE_TRIE_MAXBUF_NAME "\022E_TRIE_MAXBUF"
810 #define RE_DEBUG_FLAGS "\022E_DEBUG_FLAGS"
811
812 /*
813
814 RE_DEBUG_FLAGS is used to control what debug output is emitted
815 its divided into three groups of options, some of which interact.
816 The three groups are: Compile, Execute, Extra. There is room for a
817 further group, as currently only the low three bytes are used.
818
819     Compile Options:
820     
821     PARSE
822     PEEP
823     TRIE
824     PROGRAM
825     OFFSETS
826
827     Execute Options:
828
829     INTUIT
830     MATCH
831     TRIE
832
833     Extra Options
834
835     TRIE
836     OFFSETS
837
838 If you modify any of these make sure you make corresponding changes to
839 re.pm, especially to the documentation.
840
841 */
842
843
844 /* Compile */
845 #define RE_DEBUG_COMPILE_MASK      0x0000FF
846 #define RE_DEBUG_COMPILE_PARSE     0x000001
847 #define RE_DEBUG_COMPILE_OPTIMISE  0x000002
848 #define RE_DEBUG_COMPILE_TRIE      0x000004
849 #define RE_DEBUG_COMPILE_DUMP      0x000008
850 #define RE_DEBUG_COMPILE_FLAGS     0x000010
851
852 /* Execute */
853 #define RE_DEBUG_EXECUTE_MASK      0x00FF00
854 #define RE_DEBUG_EXECUTE_INTUIT    0x000100
855 #define RE_DEBUG_EXECUTE_MATCH     0x000200
856 #define RE_DEBUG_EXECUTE_TRIE      0x000400
857
858 /* Extra */
859 #define RE_DEBUG_EXTRA_MASK        0xFF0000
860 #define RE_DEBUG_EXTRA_TRIE        0x010000
861 #define RE_DEBUG_EXTRA_OFFSETS     0x020000
862 #define RE_DEBUG_EXTRA_OFFDEBUG    0x040000
863 #define RE_DEBUG_EXTRA_STATE       0x080000
864 #define RE_DEBUG_EXTRA_OPTIMISE    0x100000
865 #define RE_DEBUG_EXTRA_BUFFERS     0x400000
866 #define RE_DEBUG_EXTRA_GPOS        0x800000
867 /* combined */
868 #define RE_DEBUG_EXTRA_STACK       0x280000
869
870 #define RE_DEBUG_FLAG(x) (re_debug_flags & x)
871 /* Compile */
872 #define DEBUG_COMPILE_r(x) DEBUG_r( \
873     if (re_debug_flags & RE_DEBUG_COMPILE_MASK) x  )
874 #define DEBUG_PARSE_r(x) DEBUG_r( \
875     if (re_debug_flags & RE_DEBUG_COMPILE_PARSE) x  )
876 #define DEBUG_OPTIMISE_r(x) DEBUG_r( \
877     if (re_debug_flags & RE_DEBUG_COMPILE_OPTIMISE) x  )
878 #define DEBUG_PARSE_r(x) DEBUG_r( \
879     if (re_debug_flags & RE_DEBUG_COMPILE_PARSE) x  )
880 #define DEBUG_DUMP_r(x) DEBUG_r( \
881     if (re_debug_flags & RE_DEBUG_COMPILE_DUMP) x  )
882 #define DEBUG_TRIE_COMPILE_r(x) DEBUG_r( \
883     if (re_debug_flags & RE_DEBUG_COMPILE_TRIE) x )
884 #define DEBUG_FLAGS_r(x) DEBUG_r( \
885     if (re_debug_flags & RE_DEBUG_COMPILE_FLAGS) x )
886 /* Execute */
887 #define DEBUG_EXECUTE_r(x) DEBUG_r( \
888     if (re_debug_flags & RE_DEBUG_EXECUTE_MASK) x  )
889 #define DEBUG_INTUIT_r(x) DEBUG_r( \
890     if (re_debug_flags & RE_DEBUG_EXECUTE_INTUIT) x  )
891 #define DEBUG_MATCH_r(x) DEBUG_r( \
892     if (re_debug_flags & RE_DEBUG_EXECUTE_MATCH) x  )
893 #define DEBUG_TRIE_EXECUTE_r(x) DEBUG_r( \
894     if (re_debug_flags & RE_DEBUG_EXECUTE_TRIE) x )
895
896 /* Extra */
897 #define DEBUG_EXTRA_r(x) DEBUG_r( \
898     if (re_debug_flags & RE_DEBUG_EXTRA_MASK) x  )
899 #define DEBUG_OFFSETS_r(x) DEBUG_r( \
900     if (re_debug_flags & RE_DEBUG_EXTRA_OFFSETS) x  )
901 #define DEBUG_STATE_r(x) DEBUG_r( \
902     if (re_debug_flags & RE_DEBUG_EXTRA_STATE) x )
903 #define DEBUG_STACK_r(x) DEBUG_r( \
904     if (re_debug_flags & RE_DEBUG_EXTRA_STACK) x )
905 #define DEBUG_BUFFERS_r(x) DEBUG_r( \
906     if (re_debug_flags & RE_DEBUG_EXTRA_BUFFERS) x )
907
908 #define DEBUG_OPTIMISE_MORE_r(x) DEBUG_r( \
909     if ((RE_DEBUG_EXTRA_OPTIMISE|RE_DEBUG_COMPILE_OPTIMISE) == \
910          (re_debug_flags & (RE_DEBUG_EXTRA_OPTIMISE|RE_DEBUG_COMPILE_OPTIMISE)) ) x )
911 #define MJD_OFFSET_DEBUG(x) DEBUG_r( \
912     if (re_debug_flags & RE_DEBUG_EXTRA_OFFDEBUG) \
913         Perl_warn_nocontext x )
914 #define DEBUG_TRIE_COMPILE_MORE_r(x) DEBUG_TRIE_COMPILE_r( \
915     if (re_debug_flags & RE_DEBUG_EXTRA_TRIE) x )
916 #define DEBUG_TRIE_EXECUTE_MORE_r(x) DEBUG_TRIE_EXECUTE_r( \
917     if (re_debug_flags & RE_DEBUG_EXTRA_TRIE) x )
918
919 #define DEBUG_TRIE_r(x) DEBUG_r( \
920     if (re_debug_flags & (RE_DEBUG_COMPILE_TRIE \
921         | RE_DEBUG_EXECUTE_TRIE )) x )
922 #define DEBUG_GPOS_r(x) DEBUG_r( \
923     if (re_debug_flags & RE_DEBUG_EXTRA_GPOS) x )
924
925 /* initialization */
926 /* get_sv() can return NULL during global destruction. */
927 #define GET_RE_DEBUG_FLAGS DEBUG_r({ \
928         SV * re_debug_flags_sv = NULL; \
929         re_debug_flags_sv = get_sv(RE_DEBUG_FLAGS, 1); \
930         if (re_debug_flags_sv) { \
931             if (!SvIOK(re_debug_flags_sv)) \
932                 sv_setuv(re_debug_flags_sv, RE_DEBUG_COMPILE_DUMP | RE_DEBUG_EXECUTE_MASK ); \
933             re_debug_flags=SvIV(re_debug_flags_sv); \
934         }\
935 })
936
937 #ifdef DEBUGGING
938
939 #define GET_RE_DEBUG_FLAGS_DECL VOL IV re_debug_flags  = 0; \
940         PERL_UNUSED_VAR(re_debug_flags); GET_RE_DEBUG_FLAGS;
941
942 #define RE_PV_COLOR_DECL(rpv,rlen,isuni,dsv,pv,l,m,c1,c2) \
943     const char * const rpv =                          \
944         pv_pretty((dsv), (pv), (l), (m), \
945             PL_colors[(c1)],PL_colors[(c2)], \
946             PERL_PV_ESCAPE_RE|PERL_PV_ESCAPE_NONASCII |((isuni) ? PERL_PV_ESCAPE_UNI : 0) );         \
947     const int rlen = SvCUR(dsv)
948
949 #define RE_SV_ESCAPE(rpv,isuni,dsv,sv,m) \
950     const char * const rpv =                          \
951         pv_pretty((dsv), (SvPV_nolen_const(sv)), (SvCUR(sv)), (m), \
952             PL_colors[(c1)],PL_colors[(c2)], \
953             PERL_PV_ESCAPE_RE|PERL_PV_ESCAPE_NONASCII |((isuni) ? PERL_PV_ESCAPE_UNI : 0) )
954
955 #define RE_PV_QUOTED_DECL(rpv,isuni,dsv,pv,l,m)                    \
956     const char * const rpv =                                       \
957         pv_pretty((dsv), (pv), (l), (m), \
958             PL_colors[0], PL_colors[1], \
959             ( PERL_PV_PRETTY_QUOTE | PERL_PV_ESCAPE_RE | PERL_PV_ESCAPE_NONASCII | PERL_PV_PRETTY_ELLIPSES | \
960               ((isuni) ? PERL_PV_ESCAPE_UNI : 0))                  \
961         )
962
963 #define RE_SV_DUMPLEN(ItEm) (SvCUR(ItEm) - (SvTAIL(ItEm)!=0))
964 #define RE_SV_TAIL(ItEm) (SvTAIL(ItEm) ? "$" : "")
965     
966 #else /* if not DEBUGGING */
967
968 #define GET_RE_DEBUG_FLAGS_DECL
969 #define RE_PV_COLOR_DECL(rpv,rlen,isuni,dsv,pv,l,m,c1,c2)
970 #define RE_SV_ESCAPE(rpv,isuni,dsv,sv,m)
971 #define RE_PV_QUOTED_DECL(rpv,isuni,dsv,pv,l,m)
972 #define RE_SV_DUMPLEN(ItEm)
973 #define RE_SV_TAIL(ItEm)
974
975 #endif /* DEBUG RELATED DEFINES */
976
977 /*
978  * Local variables:
979  * c-indentation-style: bsd
980  * c-basic-offset: 4
981  * indent-tabs-mode: nil
982  * End:
983  *
984  * ex: set ts=8 sts=4 sw=4 et:
985  */