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
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.
11 #ifndef PERL_REGCOMP_H_
12 #define PERL_REGCOMP_H_
14 #include "regcharclass.h"
16 /* Convert branch sequences to more efficient trie ops? */
17 #define PERL_ENABLE_TRIE_OPTIMISATION 1
19 /* Be really aggressive about optimising patterns with trie sequences? */
20 #define PERL_ENABLE_EXTENDED_TRIE_OPTIMISATION 1
22 /* Should the optimiser take positive assertions into account? */
23 #define PERL_ENABLE_POSITIVE_ASSERTION_STUDY 0
25 /* Not for production use: */
26 #define PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS 0
28 /* Activate offsets code - set to if 1 to enable */
30 #define RE_TRACK_PATTERN_OFFSETS
34 * The "internal use only" fields in regexp.h are present to pass info from
35 * compile to execute that permits the execute phase to run lots faster on
36 * simple cases. They are:
38 * regstart sv that must begin a match; NULL if none obvious
39 * reganch is the match anchored (at beginning-of-line only)?
40 * regmust string (pointer into program) that match must include, or NULL
41 * [regmust changed to SV* for bminstr()--law]
42 * regmlen length of regmust string
43 * [regmlen not used currently]
45 * Regstart and reganch permit very fast decisions on suitable starting points
46 * for a match, cutting down the work a lot. Regmust permits fast rejection
47 * of lines that cannot possibly match. The regmust tests are costly enough
48 * that pregcomp() supplies a regmust only if the r.e. contains something
49 * potentially expensive (at present, the only such thing detected is * or +
50 * at the start of the r.e., which can involve a lot of backup). Regmlen is
51 * supplied because the test in pregexec() needs it and pregcomp() is computing
53 * [regmust is now supplied always. The tests that use regmust have a
54 * heuristic that disables the test if it usually matches.]
56 * [In fact, we now use regmust in many cases to locate where the search
57 * starts in the string, so if regback is >= 0, the regmust search is never
58 * wasted effort. The regback variable says how many characters back from
59 * where regmust matched is the earliest possible start of the match.
60 * For instance, /[a-z].foo/ has a regmust of 'foo' and a regback of 2.]
64 * Structure for regexp "program". This is essentially a linear encoding
65 * of a nondeterministic finite-state machine (aka syntax charts or
66 * "railroad normal form" in parsing technology). Each node is an opcode
67 * plus a "next" pointer, possibly plus an operand. "Next" pointers of
68 * all nodes except BRANCH implement concatenation; a "next" pointer with
69 * a BRANCH on both ends of it is connecting two alternatives. (Here we
70 * have one of the subtle syntax dependencies: an individual BRANCH (as
71 * opposed to a collection of them) is never concatenated with anything
72 * because of operator precedence.) The operand of some types of node is
73 * a literal string; for others, it is a node leading into a sub-FSM. In
74 * particular, the operand of a BRANCH node is the first node of the branch.
75 * (NB this is *not* a tree structure: the tail of the branch connects
76 * to the thing following the set of BRANCHes.) The opcodes are defined
77 * in regnodes.h which is generated from regcomp.sym by regcomp.pl.
81 * A node is one char of opcode followed by two chars of "next" pointer.
82 * "Next" pointers are stored as two 8-bit pieces, high order first. The
83 * value is a positive offset from the opcode of the node containing it.
84 * An operand, if any, simply follows the node. (Note that much of the
85 * code generation knows about this implicit relationship.)
87 * Using two bytes for the "next" pointer is vast overkill for most things,
88 * but allows patterns to get big without disasters.
90 * [The "next" pointer is always aligned on an even
91 * boundary, and reads the offset directly as a short.]
94 /* This is the stuff that used to live in regexp.h that was truly
95 private to the engine itself. It now lives here. */
97 typedef struct regexp_internal {
98 int name_list_idx; /* Optional data index of an array of paren names */
100 U32 *offsets; /* offset annotations 20001228 MJD
101 data about mapping the program to the
103 offsets[0] is proglen when this is used
108 regnode *regstclass; /* Optional startclass as identified or constructed
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_blocks *code_blocks;/* positions of literal (?{}) */
115 regnode program[1]; /* Unwarranted chumminess with compiler. */
118 #define RXi_SET(x,y) (x)->pprivate = (void*)(y)
119 #define RXi_GET(x) ((regexp_internal *)((x)->pprivate))
120 #define RXi_GET_DECL(r,ri) regexp_internal *ri = RXi_GET(r)
122 * Flags stored in regexp->intflags
123 * These are used only internally to the regexp engine
125 * See regexp.h for flags used externally to the regexp engine
127 #define RXp_INTFLAGS(rx) ((rx)->intflags)
128 #define RX_INTFLAGS(prog) RXp_INTFLAGS(ReANY(prog))
130 #define PREGf_SKIP 0x00000001
131 #define PREGf_IMPLICIT 0x00000002 /* Converted .* to ^.* */
132 #define PREGf_NAUGHTY 0x00000004 /* how exponential is this pattern? */
133 #define PREGf_VERBARG_SEEN 0x00000008
134 #define PREGf_CUTGROUP_SEEN 0x00000010
135 #define PREGf_USE_RE_EVAL 0x00000020 /* compiled with "use re 'eval'" */
136 /* these used to be extflags, but are now intflags */
137 #define PREGf_NOSCAN 0x00000040
139 #define PREGf_GPOS_SEEN 0x00000100
140 #define PREGf_GPOS_FLOAT 0x00000200
142 #define PREGf_ANCH_MBOL 0x00000400
143 #define PREGf_ANCH_SBOL 0x00000800
144 #define PREGf_ANCH_GPOS 0x00001000
145 #define PREGf_RECURSE_SEEN 0x00002000
148 ( PREGf_ANCH_SBOL | PREGf_ANCH_GPOS | PREGf_ANCH_MBOL )
150 /* this is where the old regcomp.h started */
152 struct regnode_string {
159 /* Argument bearing node - workhorse,
160 arg1 is often for the data field */
168 /* Similar to a regnode_1 but with an extra signed argument */
177 /* 'Two field' -- Two 16 bit unsigned args */
186 /* This give the number of code points that can be in the bitmap of an ANYOF
187 * node. The shift number must currently be one of: 8..12. It can't be less
188 * than 8 (256) because some code relies on it being at least that. Above 12
189 * (4096), and you start running into warnings that some data structure widths
190 * have been exceeded, though the test suite as of this writing still passes
191 * for up through 16, which is as high as anyone would ever want to go,
192 * encompassing all of the Unicode BMP, and thus including all the economically
193 * important world scripts. At 12 most of them are: including Arabic,
194 * Cyrillic, Greek, Hebrew, Indian subcontinent, Latin, and Thai; but not Han,
195 * Japanese, nor Korean. (The regarglen structure in regnodes.h is a U8, and
196 * the trie types TRIEC and AHOCORASICKC are larger than U8 for shift values
197 * above 12.) Be sure to benchmark before changing, as larger sizes do
198 * significantly slow down the test suite */
199 #define NUM_ANYOF_CODE_POINTS (1 << 8)
201 #define ANYOF_BITMAP_SIZE (NUM_ANYOF_CODE_POINTS / 8) /* 8 bits/Byte */
203 /* Note that these form structs which are supersets of the next smaller one, by
204 * appending fields. Alignment problems can occur if one of those optional
205 * fields requires stricter alignment than the base struct. And formal
206 * parameters that can really be two or more of the structs should be
207 * declared as the smallest one it could be. See commit message for
208 * 7dcac5f6a5195002b55c935ee1d67f67e1df280b. Regnode allocation is done
209 * without regard to alignment, and changing it to would also require changing
210 * the code that inserts and deletes regnodes. The basic single-argument
211 * regnode has a U32, which is what reganode() allocates as a unit. Therefore
212 * no field can require stricter alignment than U32. */
214 /* also used by trie */
215 struct regnode_charclass {
219 U32 arg1; /* set by set_ANYOF_arg() */
220 char bitmap[ANYOF_BITMAP_SIZE]; /* only compile-time */
223 /* has runtime (locale) \d, \w, ..., [:posix:] classes */
224 struct regnode_charclass_posixl {
225 U8 flags; /* ANYOF_MATCHES_POSIXL bit must go here */
229 char bitmap[ANYOF_BITMAP_SIZE]; /* both compile-time ... */
230 U32 classflags; /* and run-time */
233 /* A synthetic start class (SSC); is a regnode_charclass_posixl_fold, plus an
234 * extra SV*, used only during its construction and which is not used by
235 * regexec.c. Note that the 'next_off' field is unused, as the SSC stands
236 * alone, so there is never a next node. Also, there is no alignment issue,
237 * because these are declared or allocated as a complete unit so the compiler
238 * takes care of alignment. This is unlike the other regnodes which are
239 * allocated in terms of multiples of a single-argument regnode. SSC nodes can
240 * have a pointer field because there is no alignment issue, and because it is
241 * set to NULL after construction, before any cloning of the pattern */
243 U8 flags; /* ANYOF_MATCHES_POSIXL bit must go here */
247 char bitmap[ANYOF_BITMAP_SIZE]; /* both compile-time ... */
248 U32 classflags; /* ... and run-time */
250 /* Auxiliary, only used during construction; NULL afterwards: list of code
255 /* We take advantage of 'next_off' not otherwise being used in the SSC by
256 * actually using it: by setting it to 1. This allows us to test and
257 * distinguish between an SSC and other ANYOF node types, as 'next_off' cannot
258 * otherwise be 1, because it is the offset to the next regnode expressed in
259 * units of regnodes. Since an ANYOF node contains extra fields, it adds up
260 * to 12 regnode units on 32-bit systems, (hence the minimum this can be (if
261 * not 0) is 11 there. Even if things get tightly packed on a 64-bit system,
262 * it still would be more than 1. */
263 #define set_ANYOF_SYNTHETIC(n) STMT_START{ OP(n) = ANYOF; \
266 #define is_ANYOF_SYNTHETIC(n) (PL_regkind[OP(n)] == ANYOF && NEXT_OFF(n) == 1)
268 /* XXX fix this description.
269 Impose a limit of REG_INFTY on various pattern matching operations
270 to limit stack growth and to avoid "infinite" recursions.
272 /* The default size for REG_INFTY is U16_MAX, which is the same as
273 USHORT_MAX (see perl.h). Unfortunately U16 isn't necessarily 16 bits
274 (see handy.h). On the Cray C90, sizeof(short)==4 and hence U16_MAX is
275 ((1<<32)-1), while on the Cray T90, sizeof(short)==8 and U16_MAX is
276 ((1<<64)-1). To limit stack growth to reasonable sizes, supply a
278 --Andy Dougherty 11 June 1998
282 # define REG_INFTY ((1<<16)-1)
287 # define REG_INFTY U16_MAX
290 #define ARG_VALUE(arg) (arg)
291 #define ARG__SET(arg,val) ((arg) = (val))
297 #define ARG(p) ARG_VALUE(ARG_LOC(p))
298 #define ARG1(p) ARG_VALUE(ARG1_LOC(p))
299 #define ARG2(p) ARG_VALUE(ARG2_LOC(p))
300 #define ARG2L(p) ARG_VALUE(ARG2L_LOC(p))
302 #define ARG_SET(p, val) ARG__SET(ARG_LOC(p), (val))
303 #define ARG1_SET(p, val) ARG__SET(ARG1_LOC(p), (val))
304 #define ARG2_SET(p, val) ARG__SET(ARG2_LOC(p), (val))
305 #define ARG2L_SET(p, val) ARG__SET(ARG2L_LOC(p), (val))
310 #define NEXT_OFF(p) ((p)->next_off)
311 #define NODE_ALIGN(node)
312 /* the following define was set to 0xde in 075abff3
313 * as part of some linting logic. I have set it to 0
314 * as otherwise in every place where we /might/ set flags
315 * we have to set it 0 explicitly, which duplicates
316 * assignments and IMO adds an unacceptable level of
317 * surprise to working in the regex engine. If this
318 * is changed from 0 then at the very least make sure
319 * that SBOL for /^/ sets the flags to 0 explicitly.
321 #define NODE_ALIGN_FILL(node) ((node)->flags = 0)
323 #define SIZE_ALIGN NODE_ALIGN
330 #define OP(p) ((p)->type)
331 #define FLAGS(p) ((p)->flags) /* Caution: Doesn't apply to all \
332 regnode types. For some, it's the \
333 character set of the regnode */
334 #define OPERAND(p) STRING(p)
336 #define MASK(p) ((char*)OPERAND(p))
337 #define STR_LEN(p) (((struct regnode_string *)p)->str_len)
338 #define STRING(p) (((struct regnode_string *)p)->string)
339 #define STR_SZ(l) (((l) + sizeof(regnode) - 1) / sizeof(regnode))
340 #define NODE_SZ_STR(p) (STR_SZ(STR_LEN(p))+1)
347 #define NODE_ALIGN(node)
348 #define ARG_LOC(p) (((struct regnode_1 *)p)->arg1)
349 #define ARG1_LOC(p) (((struct regnode_2 *)p)->arg1)
350 #define ARG2_LOC(p) (((struct regnode_2 *)p)->arg2)
351 #define ARG2L_LOC(p) (((struct regnode_2L *)p)->arg2)
353 #define NODE_STEP_REGNODE 1 /* sizeof(regnode)/sizeof(regnode) */
354 #define EXTRA_STEP_2ARGS EXTRA_SIZE(struct regnode_2)
356 #define NODE_STEP_B 4
358 #define NEXTOPER(p) ((p) + NODE_STEP_REGNODE)
359 #define PREVOPER(p) ((p) - NODE_STEP_REGNODE)
361 #define FILL_NODE(offset, op) \
363 OP(REGNODE_p(offset)) = op; \
364 NEXT_OFF(REGNODE_p(offset)) = 0; \
366 #define FILL_ADVANCE_NODE(offset, op) \
368 FILL_NODE(offset, op); \
371 #define FILL_ADVANCE_NODE_ARG(offset, op, arg) \
373 ARG_SET(REGNODE_p(offset), arg); \
374 FILL_ADVANCE_NODE(offset, op); \
375 /* This is used generically for other operations \
376 * that have a longer argument */ \
377 (offset) += regarglen[op]; \
379 #define FILL_ADVANCE_NODE_2L_ARG(offset, op, arg1, arg2) \
381 ARG_SET(REGNODE_p(offset), arg1); \
382 ARG2L_SET(REGNODE_p(offset), arg2); \
383 FILL_ADVANCE_NODE(offset, op); \
387 #define REG_MAGIC 0234
389 /* An ANYOF node is basically a bitmap with the index being a code point. If
390 * the bit for that code point is 1, the code point matches; if 0, it doesn't
391 * match (complemented if inverted). There is an additional mechanism to deal
392 * with cases where the bitmap is insufficient in and of itself. This #define
393 * indicates if the bitmap does fully represent what this ANYOF node can match.
394 * The ARG is set to this special value (since 0, 1, ... are legal, but will
395 * never reach this high). */
396 #define ANYOF_ONLY_HAS_BITMAP ((U32) -1)
398 /* When the bitmap isn't completely sufficient for handling the ANYOF node,
399 * flags (in node->flags of the ANYOF node) get set to indicate this. These
400 * are perennially in short supply. Beyond several cases where warnings need
401 * to be raised under certain circumstances, currently, there are six cases
402 * where the bitmap alone isn't sufficient. We could use six flags to
403 * represent the 6 cases, but to save flags bits, we play some games. The
406 * 1) The bitmap has a compiled-in very finite size. So something else needs
407 * to be used to specify if a code point that is too large for the bitmap
408 * actually matches. The mechanism currently is an inversion
409 * list. ANYOF_ONLY_HAS_BITMAP, described above, being TRUE indicates
410 * there are no matches of too-large code points. But if it is FALSE,
411 * then almost certainly there are matches too large for the bitmap. (The
412 * other cases, described below, either imply this one or are extremely
413 * rare in practice.) So we can just assume that a too-large code point
414 * will need something beyond the bitmap if ANYOF_ONLY_HAS_BITMAP is
415 * FALSE, instead of having a separate flag for this.
416 * 2) A subset of item 1) is if all possible code points outside the bitmap
417 * match. This is a common occurrence when the class is complemented,
418 * like /[^ij]/. Therefore a bit is reserved to indicate this,
419 * rather than having a more expensive inversion list created,
420 * ANYOF_MATCHES_ALL_ABOVE_BITMAP.
421 * 3) Under /d rules, it can happen that code points that are in the upper
422 * latin1 range (\x80-\xFF or their equivalents on EBCDIC platforms) match
423 * only if the runtime target string being matched against is UTF-8. For
424 * example /[\w[:punct:]]/d. This happens only for posix classes (with a
425 * couple of exceptions, like \d where it doesn't happen), and all such
426 * ones also have above-bitmap matches. Thus, 3) implies 1) as well.
427 * Note that /d rules are no longer encouraged; 'use 5.14' or higher
428 * deselects them. But a flag is required so that they can be properly
429 * handled. But it can be a shared flag: see 5) below.
430 * 4) Also under /d rules, something like /[\Wfoo]/ will match everything in
431 * the \x80-\xFF range, unless the string being matched against is UTF-8.
432 * An inversion list could be created for this case, but this is
433 * relatively common, and it turns out that it's all or nothing: if any
434 * one of these code points matches, they all do. Hence a single bit
435 * suffices. We use a shared flag that doesn't take up space by itself:
436 * ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER. This
437 * also implies 1), with one exception: [:^cntrl:].
438 * 5) A user-defined \p{} property may not have been defined by the time the
439 * regex is compiled. In this case, we don't know until runtime what it
440 * will match, so we have to assume it could match anything, including
441 * code points that ordinarily would be in the bitmap. A flag bit is
442 * necessary to indicate this , though it can be shared with the item 3)
443 * flag, as that only occurs under /d, and this only occurs under non-d.
444 * This case is quite uncommon in the field, and the /(?[ ...])/ construct
445 * is a better way to accomplish what this feature does. This case also
447 * ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP
448 * is the shared flag.
449 * 6) /[foo]/il may have folds that are only valid if the runtime locale is a
450 * UTF-8 one. These are quite rare, so it would be good to avoid the
451 * expense of looking for them. But /l matching is slow anyway, and we've
452 * traditionally not worried too much about its performance. And this
453 * condition requires the ANYOFL_FOLD flag to be set, so testing for
454 * that flag would be sufficient to rule out most cases of this. So it is
455 * unclear if this should have a flag or not. But, this flag can be
456 * shared with another, so it doesn't occupy extra space.
458 * At the moment, there is one spare bit, but this could be increased by
461 * If just one more bit is needed, as of this writing it seems to khw that the
462 * best choice would be to make ANYOF_MATCHES_ALL_ABOVE_BITMAP not a flag, but
465 * #define ANYOF_MATCHES_ALL_ABOVE_BITMAP ((U32) -2)
467 * and access it through the ARG like ANYOF_ONLY_HAS_BITMAP is. This flag is
468 * used by all ANYOF node types, and it could be used to avoid calling the
469 * handler function, as the macro REGINCLASS in regexec.c does now for other
472 * Another possibility is based on the fact that ANYOF_MATCHES_POSIXL is
473 * redundant with the node type ANYOFPOSIXL. That flag could be removed, but
474 * at the expense of extra code in regexec.c. The flag has been retained
475 * because it allows us to see if we need to call reginsert, or just use the
476 * bitmap in one test.
478 * If this is done, an extension would be to make all ANYOFL nodes contain the
479 * extra 32 bits that ANYOFPOSIXL ones do. The posix flags only occupy 30
480 * bits, so the ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD flags
481 * and ANYOFL_FOLD could be moved to that extra space, but it would mean extra
482 * instructions, as there are currently places in the code that assume those
485 * All told, 5 bits could be available for other uses if all of the above were
488 * Some flags are not used in synthetic start class (SSC) nodes, so could be
489 * shared should new flags be needed for SSCs, like SSC_MATCHES_EMPTY_STRING
492 /* If this is set, the result of the match should be complemented. regexec.c
493 * is expecting this to be in the low bit. Never in an SSC */
494 #define ANYOF_INVERT 0x01
496 /* For the SSC node only, which cannot be inverted, so is shared with that bit.
497 * This is used only during regex compilation. */
498 #define SSC_MATCHES_EMPTY_STRING ANYOF_INVERT
500 /* Set if this is a regnode_charclass_posixl vs a regnode_charclass. This
501 * is used for runtime \d, \w, [:posix:], ..., which are used only in locale
502 * and the optimizer's synthetic start class. Non-locale \d, etc are resolved
503 * at compile-time. Only set under /l; can be in SSC */
504 #define ANYOF_MATCHES_POSIXL 0x02
506 /* The fold is calculated and stored in the bitmap where possible at compile
507 * time. However under locale, the actual folding varies depending on
508 * what the locale is at the time of execution, so it has to be deferred until
509 * then. Only set under /l; never in an SSC */
510 #define ANYOFL_FOLD 0x04
512 /* Shared bit set only with ANYOFL and SSC nodes:
513 * If ANYOFL_FOLD is set, this flag indicates there are potential matches
514 * valid only if the locale is a UTF-8 one.
515 * If ANYOFL_FOLD is NOT set, this flag means to warn if the runtime locale
516 * isn't a UTF-8 one (and the generated node assumes a UTF-8 locale).
517 * None of INVERT, POSIXL,
518 * ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP
520 #define ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD 0x08
522 /* Convenience macros for teasing apart the meanings when reading the above bit
524 #define ANYOFL_SOME_FOLDS_ONLY_IN_UTF8_LOCALE(flags) \
525 ((flags & ( ANYOFL_FOLD /* Both bits are set */ \
526 |ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD)) \
528 |ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD))
530 #define ANYOFL_UTF8_LOCALE_REQD(flags) \
531 ((flags & ( ANYOFL_FOLD /* Only REQD bit is set */ \
532 |ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD)) \
533 == ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD)
535 /* Spare: Be sure to change ANYOF_FLAGS_ALL if this gets used 0x10 */
537 /* If set, the node matches every code point NUM_ANYOF_CODE_POINTS and above.
538 * Can be in an SSC */
539 #define ANYOF_MATCHES_ALL_ABOVE_BITMAP 0x20
542 * Under /d it means the ANYOFD node matches more things if the target
543 * string is encoded in UTF-8; any such things will be non-ASCII,
544 * characters that are < 256, and can be accessed via the inversion
546 * When not under /d, it means the ANYOF node contains a user-defined
547 * property that wasn't yet defined at the time the regex was compiled,
548 * and so must be looked up at runtime, by creating an inversion list.
549 * (These uses are mutually exclusive because a user-defined property is
550 * specified by \p{}, and \p{} implies /u which deselects /d). The long macro
551 * name is to make sure that you are cautioned about its shared nature. Only
552 * the non-/d meaning can be in an SSC */
553 #define ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP 0x40
556 * Under /d it means the ANYOFD node matches all non-ASCII Latin1
557 * characters when the target string is not in utf8.
558 * When not under /d, it means the ANYOF node should raise a warning if
559 * matching against an above-Unicode code point.
560 * (These uses are mutually exclusive because the warning requires a \p{}, and
561 * \p{} implies /u which deselects /d). An SSC node only has this bit set if
562 * what is meant is the warning. The long macro name is to make sure that you
563 * are cautioned about its shared nature */
564 #define ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER 0x80
566 #define ANYOF_FLAGS_ALL (0xff & ~0x10)
568 #define ANYOF_LOCALE_FLAGS (ANYOFL_FOLD | ANYOF_MATCHES_POSIXL)
570 /* These are the flags that apply to both regular ANYOF nodes and synthetic
571 * start class nodes during construction of the SSC. During finalization of
572 * the SSC, other of the flags may get added to it */
573 #define ANYOF_COMMON_FLAGS 0
575 /* Character classes for node->classflags of ANYOF */
576 /* Should be synchronized with a table in regprop() */
577 /* 2n should be the normal one, paired with its complement at 2n+1 */
579 #define ANYOF_ALPHA ((_CC_ALPHA) * 2)
580 #define ANYOF_NALPHA ((ANYOF_ALPHA) + 1)
581 #define ANYOF_ALPHANUMERIC ((_CC_ALPHANUMERIC) * 2) /* [[:alnum:]] isalnum(3), utf8::IsAlnum */
582 #define ANYOF_NALPHANUMERIC ((ANYOF_ALPHANUMERIC) + 1)
583 #define ANYOF_ASCII ((_CC_ASCII) * 2)
584 #define ANYOF_NASCII ((ANYOF_ASCII) + 1)
585 #define ANYOF_BLANK ((_CC_BLANK) * 2) /* GNU extension: space and tab: non-vertical space */
586 #define ANYOF_NBLANK ((ANYOF_BLANK) + 1)
587 #define ANYOF_CASED ((_CC_CASED) * 2) /* Pseudo class for [:lower:] or
588 [:upper:] under /i */
589 #define ANYOF_NCASED ((ANYOF_CASED) + 1)
590 #define ANYOF_CNTRL ((_CC_CNTRL) * 2)
591 #define ANYOF_NCNTRL ((ANYOF_CNTRL) + 1)
592 #define ANYOF_DIGIT ((_CC_DIGIT) * 2) /* \d */
593 #define ANYOF_NDIGIT ((ANYOF_DIGIT) + 1)
594 #define ANYOF_GRAPH ((_CC_GRAPH) * 2)
595 #define ANYOF_NGRAPH ((ANYOF_GRAPH) + 1)
596 #define ANYOF_LOWER ((_CC_LOWER) * 2)
597 #define ANYOF_NLOWER ((ANYOF_LOWER) + 1)
598 #define ANYOF_PRINT ((_CC_PRINT) * 2)
599 #define ANYOF_NPRINT ((ANYOF_PRINT) + 1)
600 #define ANYOF_PUNCT ((_CC_PUNCT) * 2)
601 #define ANYOF_NPUNCT ((ANYOF_PUNCT) + 1)
602 #define ANYOF_SPACE ((_CC_SPACE) * 2) /* \s */
603 #define ANYOF_NSPACE ((ANYOF_SPACE) + 1)
604 #define ANYOF_UPPER ((_CC_UPPER) * 2)
605 #define ANYOF_NUPPER ((ANYOF_UPPER) + 1)
606 #define ANYOF_WORDCHAR ((_CC_WORDCHAR) * 2) /* \w, PL_utf8_alnum, utf8::IsWord, ALNUM */
607 #define ANYOF_NWORDCHAR ((ANYOF_WORDCHAR) + 1)
608 #define ANYOF_XDIGIT ((_CC_XDIGIT) * 2)
609 #define ANYOF_NXDIGIT ((ANYOF_XDIGIT) + 1)
611 /* pseudo classes below this, not stored in the class bitmap, but used as flags
612 during compilation of char classes */
614 #define ANYOF_VERTWS ((_CC_VERTSPACE) * 2)
615 #define ANYOF_NVERTWS ((ANYOF_VERTWS)+1)
617 /* It is best if this is the last one, as all above it are stored as bits in a
618 * bitmap, and it isn't part of that bitmap */
619 #if _CC_VERTSPACE != _HIGHEST_REGCOMP_DOT_H_SYNC
620 # error Problem with handy.h _HIGHEST_REGCOMP_DOT_H_SYNC #define
623 #define ANYOF_POSIXL_MAX (ANYOF_VERTWS) /* So upper loop limit is written:
625 * Hence doesn't include VERTWS, as that
626 * is a pseudo class */
627 #define ANYOF_MAX ANYOF_POSIXL_MAX
629 #if (ANYOF_POSIXL_MAX > 32) /* Must fit in 32-bit word */
630 # error Problem with handy.h _CC_foo #defines
633 #define ANYOF_HORIZWS ((ANYOF_POSIXL_MAX)+2) /* = (ANYOF_NVERTWS + 1) */
634 #define ANYOF_NHORIZWS ((ANYOF_POSIXL_MAX)+3)
636 #define ANYOF_UNIPROP ((ANYOF_POSIXL_MAX)+4) /* Used to indicate a Unicode
637 property: \p{} or \P{} */
639 /* Backward source code compatibility. */
641 #define ANYOF_ALNUML ANYOF_ALNUM
642 #define ANYOF_NALNUML ANYOF_NALNUM
643 #define ANYOF_SPACEL ANYOF_SPACE
644 #define ANYOF_NSPACEL ANYOF_NSPACE
645 #define ANYOF_ALNUM ANYOF_WORDCHAR
646 #define ANYOF_NALNUM ANYOF_NWORDCHAR
648 /* Utility macros for the bitmap and classes of ANYOF */
650 #define ANYOF_FLAGS(p) ((p)->flags)
652 #define ANYOF_BIT(c) (1U << ((c) & 7))
654 #define POSIXL_SET(field, c) ((field) |= (1U << (c)))
655 #define ANYOF_POSIXL_SET(p, c) POSIXL_SET(((regnode_charclass_posixl*) (p))->classflags, (c))
657 #define POSIXL_CLEAR(field, c) ((field) &= ~ (1U <<(c)))
658 #define ANYOF_POSIXL_CLEAR(p, c) POSIXL_CLEAR(((regnode_charclass_posixl*) (p))->classflags, (c))
660 #define POSIXL_TEST(field, c) ((field) & (1U << (c)))
661 #define ANYOF_POSIXL_TEST(p, c) POSIXL_TEST(((regnode_charclass_posixl*) (p))->classflags, (c))
663 #define POSIXL_ZERO(field) STMT_START { (field) = 0; } STMT_END
664 #define ANYOF_POSIXL_ZERO(ret) POSIXL_ZERO(((regnode_charclass_posixl*) (ret))->classflags)
666 #define ANYOF_POSIXL_SET_TO_BITMAP(p, bits) \
668 ((regnode_charclass_posixl*) (p))->classflags = (bits); \
671 /* Shifts a bit to get, eg. 0x4000_0000, then subtracts 1 to get 0x3FFF_FFFF */
672 #define ANYOF_POSIXL_SETALL(ret) STMT_START { ((regnode_charclass_posixl*) (ret))->classflags = ((1U << ((ANYOF_POSIXL_MAX) - 1))) - 1; } STMT_END
673 #define ANYOF_CLASS_SETALL(ret) ANYOF_POSIXL_SETALL(ret)
675 #define ANYOF_POSIXL_TEST_ANY_SET(p) \
676 ((ANYOF_FLAGS(p) & ANYOF_MATCHES_POSIXL) \
677 && (((regnode_charclass_posixl*)(p))->classflags))
678 #define ANYOF_CLASS_TEST_ANY_SET(p) ANYOF_POSIXL_TEST_ANY_SET(p)
680 /* Since an SSC always has this field, we don't have to test for that; nor do
681 * we want to because the bit isn't set for SSC during its construction */
682 #define ANYOF_POSIXL_SSC_TEST_ANY_SET(p) \
683 cBOOL(((regnode_ssc*)(p))->classflags)
684 #define ANYOF_POSIXL_SSC_TEST_ALL_SET(p) /* Are all bits set? */ \
685 (((regnode_ssc*) (p))->classflags \
686 == ((1U << ((ANYOF_POSIXL_MAX) - 1))) - 1)
688 #define ANYOF_POSIXL_TEST_ALL_SET(p) \
689 ((ANYOF_FLAGS(p) & ANYOF_MATCHES_POSIXL) \
690 && ((regnode_charclass_posixl*) (p))->classflags \
691 == ((1U << ((ANYOF_POSIXL_MAX) - 1))) - 1)
693 #define ANYOF_POSIXL_OR(source, dest) STMT_START { (dest)->classflags |= (source)->classflags ; } STMT_END
694 #define ANYOF_CLASS_OR(source, dest) ANYOF_POSIXL_OR((source), (dest))
696 #define ANYOF_POSIXL_AND(source, dest) STMT_START { (dest)->classflags &= (source)->classflags ; } STMT_END
698 #define ANYOF_BITMAP_ZERO(ret) Zero(((regnode_charclass*)(ret))->bitmap, ANYOF_BITMAP_SIZE, char)
699 #define ANYOF_BITMAP(p) ((regnode_charclass*)(p))->bitmap
700 #define ANYOF_BITMAP_BYTE(p, c) BITMAP_BYTE(ANYOF_BITMAP(p), c)
701 #define ANYOF_BITMAP_SET(p, c) (ANYOF_BITMAP_BYTE(p, c) |= ANYOF_BIT(c))
702 #define ANYOF_BITMAP_CLEAR(p,c) (ANYOF_BITMAP_BYTE(p, c) &= ~ANYOF_BIT(c))
703 #define ANYOF_BITMAP_TEST(p, c) cBOOL(ANYOF_BITMAP_BYTE(p, c) & ANYOF_BIT(c))
705 #define ANYOF_BITMAP_SETALL(p) \
706 memset (ANYOF_BITMAP(p), 255, ANYOF_BITMAP_SIZE)
707 #define ANYOF_BITMAP_CLEARALL(p) \
708 Zero (ANYOF_BITMAP(p), ANYOF_BITMAP_SIZE)
711 * Utility definitions.
714 # define UCHARAT(p) ((int)*(const U8*)(p))
716 # define UCHARAT(p) ((int)*(p)&CHARMASK)
719 #define EXTRA_SIZE(guy) ((sizeof(guy)-1)/sizeof(struct regnode))
721 #define REG_ZERO_LEN_SEEN 0x00000001
722 #define REG_LOOKBEHIND_SEEN 0x00000002
723 #define REG_GPOS_SEEN 0x00000004
725 #define REG_RECURSE_SEEN 0x00000020
726 #define REG_TOP_LEVEL_BRANCHES_SEEN 0x00000040
727 #define REG_VERBARG_SEEN 0x00000080
728 #define REG_CUTGROUP_SEEN 0x00000100
729 #define REG_RUN_ON_COMMENT_SEEN 0x00000200
730 #define REG_UNFOLDED_MULTI_SEEN 0x00000400
732 #define REG_UNBOUNDED_QUANTIFIER_SEEN 0x00001000
737 #ifdef PLUGGABLE_RE_EXTENSION
738 #include "re_nodes.h"
740 #include "regnodes.h"
743 #ifndef PLUGGABLE_RE_EXTENSION
745 EXTCONST regexp_engine PL_core_reg_engine;
747 EXTCONST regexp_engine PL_core_reg_engine = {
750 Perl_re_intuit_start,
751 Perl_re_intuit_string,
752 Perl_regfree_internal,
753 Perl_reg_numbered_buff_fetch,
754 Perl_reg_numbered_buff_store,
755 Perl_reg_numbered_buff_length,
757 Perl_reg_named_buff_iter,
759 #if defined(USE_ITHREADS)
760 Perl_regdupe_internal,
765 #endif /* PLUGGABLE_RE_EXTENSION */
771 /* .what is a character array with one character for each member of .data
772 * The character describes the function of the corresponding .data item:
773 * a - AV for paren_name_list under DEBUGGING
774 * f - start-class data for regstclass optimization
775 * l - start op for literal (?{EVAL}) item
776 * L - start op for literal (?{EVAL}) item, with separate CV (qr//)
777 * r - pointer to an embedded code-containing qr, e.g. /ab$qr/
778 * s - inversion list for Unicode-style character class, and the
779 * multicharacter strings resulting from casefolding the single-character
780 * entries in the character class
782 * u - trie struct's widecharmap (a HV, so can't share, must dup)
783 * also used for revcharmap and words under DEBUGGING
784 * T - aho-trie struct
785 * S - sv for named capture lookup
786 * 20010712 mjd@plover.com
787 * (Remember to update re_dup() and pregfree() if you add any items.)
795 /* Code in S_to_utf8_substr() and S_to_byte_substr() in regexec.c accesses
796 anchored* and float* via array indexes 0 and 1. */
797 #define anchored_substr substrs->data[0].substr
798 #define anchored_utf8 substrs->data[0].utf8_substr
799 #define anchored_offset substrs->data[0].min_offset
800 #define anchored_end_shift substrs->data[0].end_shift
802 #define float_substr substrs->data[1].substr
803 #define float_utf8 substrs->data[1].utf8_substr
804 #define float_min_offset substrs->data[1].min_offset
805 #define float_max_offset substrs->data[1].max_offset
806 #define float_end_shift substrs->data[1].end_shift
808 #define check_substr substrs->data[2].substr
809 #define check_utf8 substrs->data[2].utf8_substr
810 #define check_offset_min substrs->data[2].min_offset
811 #define check_offset_max substrs->data[2].max_offset
812 #define check_end_shift substrs->data[2].end_shift
814 #define RX_ANCHORED_SUBSTR(rx) (ReANY(rx)->anchored_substr)
815 #define RX_ANCHORED_UTF8(rx) (ReANY(rx)->anchored_utf8)
816 #define RX_FLOAT_SUBSTR(rx) (ReANY(rx)->float_substr)
817 #define RX_FLOAT_UTF8(rx) (ReANY(rx)->float_utf8)
819 /* trie related stuff */
821 /* a transition record for the state machine. the
822 check field determines which state "owns" the
823 transition. the char the transition is for is
824 determined by offset from the owning states base
825 field. the next field determines which state
826 is to be transitioned to if any.
828 struct _reg_trie_trans {
833 /* a transition list element for the list based representation */
834 struct _reg_trie_trans_list_elem {
838 typedef struct _reg_trie_trans_list_elem reg_trie_trans_le;
840 /* a state for compressed nodes. base is an offset
841 into an array of reg_trie_trans array. If wordnum is
842 nonzero the state is accepting. if base is zero then
843 the state has no children (and will be accepting)
845 struct _reg_trie_state {
849 reg_trie_trans_le* list;
853 /* info per word; indexed by wordnum */
855 U16 prev; /* previous word in acceptance chain; eg in
856 * zzz|abc|ab/ after matching the chars abc, the
857 * accepted word is #2, and the previous accepted
859 U32 len; /* how many chars long is this word? */
860 U32 accept; /* accept state for this word */
864 typedef struct _reg_trie_state reg_trie_state;
865 typedef struct _reg_trie_trans reg_trie_trans;
868 /* anything in here that needs to be freed later
869 should be dealt with in pregfree.
870 refcount is first in both this and _reg_ac_data to allow a space
871 optimisation in Perl_regdupe. */
872 struct _reg_trie_data {
873 U32 refcount; /* number of times this trie is referenced */
874 U32 lasttrans; /* last valid transition element */
875 U16 *charmap; /* byte to charid lookup array */
876 reg_trie_state *states; /* state data */
877 reg_trie_trans *trans; /* array of transition elements */
878 char *bitmap; /* stclass bitmap */
879 U16 *jump; /* optional 1 indexed array of offsets before tail
880 for the node following a given word. */
881 reg_trie_wordinfo *wordinfo; /* array of info per word */
882 U16 uniquecharcount; /* unique chars in trie (width of trans table) */
883 U32 startstate; /* initial state - used for common prefix optimisation */
884 STRLEN minlen; /* minimum length of words in trie - build/opt only? */
885 STRLEN maxlen; /* maximum length of words in trie - build/opt only? */
886 U32 prefixlen; /* #chars in common prefix */
887 U32 statecount; /* Build only - number of states in the states array
888 (including the unused zero state) */
889 U32 wordcount; /* Build only */
891 STRLEN charcount; /* Build only */
894 /* There is one (3 under DEBUGGING) pointers that logically belong in this
895 structure, but are held outside as they need duplication on thread cloning,
896 whereas the rest of the structure can be read only:
897 HV *widecharmap; code points > 255 to charid
899 AV *words; Array of words contained in trie, for dumping
900 AV *revcharmap; Map of each charid back to its character representation
904 #define TRIE_WORDS_OFFSET 2
906 typedef struct _reg_trie_data reg_trie_data;
908 /* refcount is first in both this and _reg_trie_data to allow a space
909 optimisation in Perl_regdupe. */
910 struct _reg_ac_data {
914 reg_trie_state *states;
916 typedef struct _reg_ac_data reg_ac_data;
918 /* ANY_BIT doesn't use the structure, so we can borrow it here.
919 This is simpler than refactoring all of it as wed end up with
920 three different sets... */
922 #define TRIE_BITMAP(p) (((reg_trie_data *)(p))->bitmap)
923 #define TRIE_BITMAP_BYTE(p, c) BITMAP_BYTE(TRIE_BITMAP(p), c)
924 #define TRIE_BITMAP_SET(p, c) (TRIE_BITMAP_BYTE(p, c) |= ANYOF_BIT((U8)c))
925 #define TRIE_BITMAP_CLEAR(p,c) (TRIE_BITMAP_BYTE(p, c) &= ~ANYOF_BIT((U8)c))
926 #define TRIE_BITMAP_TEST(p, c) (TRIE_BITMAP_BYTE(p, c) & ANYOF_BIT((U8)c))
928 #define IS_ANYOF_TRIE(op) ((op)==TRIEC || (op)==AHOCORASICKC)
929 #define IS_TRIE_AC(op) ((op)>=AHOCORASICK)
932 #define BITMAP_BYTE(p, c) (( (U8*) p) [ ( ( (UV) (c)) >> 3) ] )
933 #define BITMAP_TEST(p, c) (BITMAP_BYTE(p, c) & ANYOF_BIT((U8)c))
935 /* these defines assume uniquecharcount is the correct variable, and state may be evaluated twice */
936 #define TRIE_NODENUM(state) (((state)-1)/(trie->uniquecharcount)+1)
937 #define SAFE_TRIE_NODENUM(state) ((state) ? (((state)-1)/(trie->uniquecharcount)+1) : (state))
938 #define TRIE_NODEIDX(state) ((state) ? (((state)-1)*(trie->uniquecharcount)+1) : (state))
941 #define TRIE_CHARCOUNT(trie) ((trie)->charcount)
943 #define TRIE_CHARCOUNT(trie) (trie_charcount)
946 #define RE_TRIE_MAXBUF_INIT 65536
947 #define RE_TRIE_MAXBUF_NAME "\022E_TRIE_MAXBUF"
948 #define RE_DEBUG_FLAGS "\022E_DEBUG_FLAGS"
950 #define RE_COMPILE_RECURSION_INIT 1000
951 #define RE_COMPILE_RECURSION_LIMIT "\022E_COMPILE_RECURSION_LIMIT"
955 RE_DEBUG_FLAGS is used to control what debug output is emitted
956 its divided into three groups of options, some of which interact.
957 The three groups are: Compile, Execute, Extra. There is room for a
958 further group, as currently only the low three bytes are used.
979 If you modify any of these make sure you make corresponding changes to
980 re.pm, especially to the documentation.
986 #define RE_DEBUG_COMPILE_MASK 0x0000FF
987 #define RE_DEBUG_COMPILE_PARSE 0x000001
988 #define RE_DEBUG_COMPILE_OPTIMISE 0x000002
989 #define RE_DEBUG_COMPILE_TRIE 0x000004
990 #define RE_DEBUG_COMPILE_DUMP 0x000008
991 #define RE_DEBUG_COMPILE_FLAGS 0x000010
992 #define RE_DEBUG_COMPILE_TEST 0x000020
995 #define RE_DEBUG_EXECUTE_MASK 0x00FF00
996 #define RE_DEBUG_EXECUTE_INTUIT 0x000100
997 #define RE_DEBUG_EXECUTE_MATCH 0x000200
998 #define RE_DEBUG_EXECUTE_TRIE 0x000400
1001 #define RE_DEBUG_EXTRA_MASK 0x1FF0000
1002 #define RE_DEBUG_EXTRA_TRIE 0x0010000
1003 #define RE_DEBUG_EXTRA_OFFSETS 0x0020000
1004 #define RE_DEBUG_EXTRA_OFFDEBUG 0x0040000
1005 #define RE_DEBUG_EXTRA_STATE 0x0080000
1006 #define RE_DEBUG_EXTRA_OPTIMISE 0x0100000
1007 #define RE_DEBUG_EXTRA_BUFFERS 0x0400000
1008 #define RE_DEBUG_EXTRA_GPOS 0x0800000
1009 #define RE_DEBUG_EXTRA_DUMP_PRE_OPTIMIZE 0x1000000
1011 #define RE_DEBUG_EXTRA_STACK 0x0280000
1013 #define RE_DEBUG_FLAG(x) (re_debug_flags & x)
1015 #define DEBUG_COMPILE_r(x) DEBUG_r( \
1016 if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_COMPILE_MASK)) x )
1017 #define DEBUG_PARSE_r(x) DEBUG_r( \
1018 if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_COMPILE_PARSE)) x )
1019 #define DEBUG_OPTIMISE_r(x) DEBUG_r( \
1020 if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_COMPILE_OPTIMISE)) x )
1021 #define DEBUG_DUMP_r(x) DEBUG_r( \
1022 if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_COMPILE_DUMP)) x )
1023 #define DEBUG_TRIE_COMPILE_r(x) DEBUG_r( \
1024 if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_COMPILE_TRIE)) x )
1025 #define DEBUG_FLAGS_r(x) DEBUG_r( \
1026 if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_COMPILE_FLAGS)) x )
1027 #define DEBUG_TEST_r(x) DEBUG_r( \
1028 if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_COMPILE_TEST)) x )
1030 #define DEBUG_EXECUTE_r(x) DEBUG_r( \
1031 if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_EXECUTE_MASK)) x )
1032 #define DEBUG_INTUIT_r(x) DEBUG_r( \
1033 if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_EXECUTE_INTUIT)) x )
1034 #define DEBUG_MATCH_r(x) DEBUG_r( \
1035 if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_EXECUTE_MATCH)) x )
1036 #define DEBUG_TRIE_EXECUTE_r(x) DEBUG_r( \
1037 if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_EXECUTE_TRIE)) x )
1040 #define DEBUG_EXTRA_r(x) DEBUG_r( \
1041 if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_EXTRA_MASK)) x )
1042 #define DEBUG_OFFSETS_r(x) DEBUG_r( \
1043 if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_EXTRA_OFFSETS)) x )
1044 #define DEBUG_STATE_r(x) DEBUG_r( \
1045 if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_EXTRA_STATE)) x )
1046 #define DEBUG_STACK_r(x) DEBUG_r( \
1047 if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_EXTRA_STACK)) x )
1048 #define DEBUG_BUFFERS_r(x) DEBUG_r( \
1049 if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_EXTRA_BUFFERS)) x )
1051 #define DEBUG_OPTIMISE_MORE_r(x) DEBUG_r( \
1052 if (DEBUG_v_TEST || ((RE_DEBUG_EXTRA_OPTIMISE|RE_DEBUG_COMPILE_OPTIMISE) == \
1053 (re_debug_flags & (RE_DEBUG_EXTRA_OPTIMISE|RE_DEBUG_COMPILE_OPTIMISE)))) x )
1054 #define MJD_OFFSET_DEBUG(x) DEBUG_r( \
1055 if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_EXTRA_OFFDEBUG)) \
1056 Perl_warn_nocontext x )
1057 #define DEBUG_TRIE_COMPILE_MORE_r(x) DEBUG_TRIE_COMPILE_r( \
1058 if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_EXTRA_TRIE)) x )
1059 #define DEBUG_TRIE_EXECUTE_MORE_r(x) DEBUG_TRIE_EXECUTE_r( \
1060 if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_EXTRA_TRIE)) x )
1062 #define DEBUG_TRIE_r(x) DEBUG_r( \
1063 if (DEBUG_v_TEST || (re_debug_flags & (RE_DEBUG_COMPILE_TRIE \
1064 | RE_DEBUG_EXECUTE_TRIE ))) x )
1065 #define DEBUG_GPOS_r(x) DEBUG_r( \
1066 if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_EXTRA_GPOS)) x )
1068 #define DEBUG_DUMP_PRE_OPTIMIZE_r(x) DEBUG_r( \
1069 if (DEBUG_v_TEST || (re_debug_flags & RE_DEBUG_EXTRA_DUMP_PRE_OPTIMIZE)) x )
1071 /* initialization */
1072 /* get_sv() can return NULL during global destruction. */
1073 #define GET_RE_DEBUG_FLAGS DEBUG_r({ \
1074 SV * re_debug_flags_sv = NULL; \
1075 re_debug_flags_sv = PL_curcop ? get_sv(RE_DEBUG_FLAGS, GV_ADD) : NULL; \
1076 if (re_debug_flags_sv) { \
1077 if (!SvIOK(re_debug_flags_sv)) \
1078 sv_setuv(re_debug_flags_sv, RE_DEBUG_COMPILE_DUMP | RE_DEBUG_EXECUTE_MASK ); \
1079 re_debug_flags=SvIV(re_debug_flags_sv); \
1085 #define GET_RE_DEBUG_FLAGS_DECL volatile IV re_debug_flags = 0; \
1086 PERL_UNUSED_VAR(re_debug_flags); GET_RE_DEBUG_FLAGS;
1088 #define RE_PV_COLOR_DECL(rpv,rlen,isuni,dsv,pv,l,m,c1,c2) \
1089 const char * const rpv = \
1090 pv_pretty((dsv), (pv), (l), (m), \
1091 PL_colors[(c1)],PL_colors[(c2)], \
1092 PERL_PV_ESCAPE_RE|PERL_PV_ESCAPE_NONASCII |((isuni) ? PERL_PV_ESCAPE_UNI : 0) ); \
1093 const int rlen = SvCUR(dsv)
1095 /* This is currently unsed in the core */
1096 #define RE_SV_ESCAPE(rpv,isuni,dsv,sv,m) \
1097 const char * const rpv = \
1098 pv_pretty((dsv), (SvPV_nolen_const(sv)), (SvCUR(sv)), (m), \
1099 PL_colors[(c1)],PL_colors[(c2)], \
1100 PERL_PV_ESCAPE_RE|PERL_PV_ESCAPE_NONASCII |((isuni) ? PERL_PV_ESCAPE_UNI : 0) )
1102 #define RE_PV_QUOTED_DECL(rpv,isuni,dsv,pv,l,m) \
1103 const char * const rpv = \
1104 pv_pretty((dsv), (pv), (l), (m), \
1105 PL_colors[0], PL_colors[1], \
1106 ( PERL_PV_PRETTY_QUOTE | PERL_PV_ESCAPE_RE | PERL_PV_ESCAPE_NONASCII | PERL_PV_PRETTY_ELLIPSES | \
1107 ((isuni) ? PERL_PV_ESCAPE_UNI : 0)) \
1110 #define RE_SV_DUMPLEN(ItEm) (SvCUR(ItEm) - (SvTAIL(ItEm)!=0))
1111 #define RE_SV_TAIL(ItEm) (SvTAIL(ItEm) ? "$" : "")
1113 #else /* if not DEBUGGING */
1115 #define GET_RE_DEBUG_FLAGS_DECL
1116 #define RE_PV_COLOR_DECL(rpv,rlen,isuni,dsv,pv,l,m,c1,c2)
1117 #define RE_SV_ESCAPE(rpv,isuni,dsv,sv,m)
1118 #define RE_PV_QUOTED_DECL(rpv,isuni,dsv,pv,l,m)
1119 #define RE_SV_DUMPLEN(ItEm)
1120 #define RE_SV_TAIL(ItEm)
1122 #endif /* DEBUG RELATED DEFINES */
1124 #define FIRST_NON_ASCII_DECIMAL_DIGIT 0x660 /* ARABIC_INDIC_DIGIT_ZERO */
1127 TRADITIONAL_BOUND = _CC_WORDCHAR,
1134 /* This unpacks the FLAGS field of ANYOFHx nodes. The value it contains
1135 * gives the strict lower bound for the UTF-8 start byte of any code point
1136 * matchable by the node, and a loose upper bound as well.
1138 * The low bound is stored in the upper 6 bits, plus 0xC0.
1139 * The loose upper bound is determined from the lowest 2 bits and the low bound
1140 * (called x) as follows:
1142 * 11 The upper limit of the range can be as much as (EF - x) / 8
1143 * 10 The upper limit of the range can be as much as (EF - x) / 4
1144 * 01 The upper limit of the range can be as much as (EF - x) / 2
1145 * 00 The upper limit of the range can be as much as EF
1147 * For motivation of this design, see commit message in
1148 * 3146c00a633e9cbed741e10146662fbcedfdb8d3 */
1150 # define MAX_ANYOF_HRx_BYTE 0xF4
1152 # define MAX_ANYOF_HRx_BYTE 0xEF
1154 #define LOWEST_ANYOF_HRx_BYTE(b) (((b) >> 2) + 0xC0)
1155 #define HIGHEST_ANYOF_HRx_BYTE(b) \
1156 (LOWEST_ANYOF_HRx_BYTE(b) \
1157 + ((MAX_ANYOF_HRx_BYTE - LOWEST_ANYOF_HRx_BYTE(b)) >> ((b) & 3)))
1159 #endif /* PERL_REGCOMP_H_ */
1162 * ex: set ts=8 sts=4 sw=4 et: