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