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 * Structure for regexp "program". This is essentially a linear encoding
35 * of a nondeterministic finite-state machine (aka syntax charts or
36 * "railroad normal form" in parsing technology). Each node is an opcode
37 * plus a "next" pointer, possibly plus an operand. "Next" pointers of
38 * all nodes except BRANCH implement concatenation; a "next" pointer with
39 * a BRANCH on both ends of it is connecting two alternatives. (Here we
40 * have one of the subtle syntax dependencies: an individual BRANCH (as
41 * opposed to a collection of them) is never concatenated with anything
42 * because of operator precedence.) The operand of some types of node is
43 * a literal string; for others, it is a node leading into a sub-FSM. In
44 * particular, the operand of a BRANCH node is the first node of the branch.
45 * (NB this is *not* a tree structure: the tail of the branch connects
46 * to the thing following the set of BRANCHes.) The opcodes are defined
47 * in regnodes.h which is generated from regcomp.sym by regcomp.pl.
51 * A node is one char of opcode followed by two chars of "next" pointer.
52 * "Next" pointers are stored as two 8-bit pieces, high order first. The
53 * value is a positive offset from the opcode of the node containing it.
54 * An operand, if any, simply follows the node. (Note that much of the
55 * code generation knows about this implicit relationship.)
57 * Using two bytes for the "next" pointer is vast overkill for most things,
58 * but allows patterns to get big without disasters.
60 * [The "next" pointer is always aligned on an even
61 * boundary, and reads the offset directly as a short.]
64 /* This is the stuff that used to live in regexp.h that was truly
65 private to the engine itself. It now lives here. */
67 typedef struct regexp_internal {
69 U32 *offsets; /* offset annotations 20001228 MJD
70 data about mapping the program to the
72 offsets[0] is proglen when this is used
77 regnode *regstclass; /* Optional startclass as identified or constructed
79 struct reg_data *data; /* Additional miscellaneous data used by the program.
80 Used to make it easier to clone and free arbitrary
81 data that the regops need. Often the ARG field of
82 a regop is an index into this structure */
83 struct reg_code_blocks *code_blocks;/* positions of literal (?{}) */
84 int name_list_idx; /* Optional data index of an array of paren names */
85 regnode program[1]; /* Unwarranted chumminess with compiler. */
88 #define RXi_SET(x,y) (x)->pprivate = (void*)(y)
89 #define RXi_GET(x) ((regexp_internal *)((x)->pprivate))
90 #define RXi_GET_DECL(r,ri) regexp_internal *ri = RXi_GET(r)
92 * Flags stored in regexp->intflags
93 * These are used only internally to the regexp engine
95 * See regexp.h for flags used externally to the regexp engine
97 #define RXp_INTFLAGS(rx) ((rx)->intflags)
98 #define RX_INTFLAGS(prog) RXp_INTFLAGS(ReANY(prog))
100 #define PREGf_SKIP 0x00000001
101 #define PREGf_IMPLICIT 0x00000002 /* Converted .* to ^.* */
102 #define PREGf_NAUGHTY 0x00000004 /* how exponential is this pattern? */
103 #define PREGf_VERBARG_SEEN 0x00000008
104 #define PREGf_CUTGROUP_SEEN 0x00000010
105 #define PREGf_USE_RE_EVAL 0x00000020 /* compiled with "use re 'eval'" */
106 /* these used to be extflags, but are now intflags */
107 #define PREGf_NOSCAN 0x00000040
109 #define PREGf_GPOS_SEEN 0x00000100
110 #define PREGf_GPOS_FLOAT 0x00000200
112 #define PREGf_ANCH_MBOL 0x00000400
113 #define PREGf_ANCH_SBOL 0x00000800
114 #define PREGf_ANCH_GPOS 0x00001000
115 #define PREGf_RECURSE_SEEN 0x00002000
118 ( PREGf_ANCH_SBOL | PREGf_ANCH_GPOS | PREGf_ANCH_MBOL )
120 /* this is where the old regcomp.h started */
122 struct regnode_string {
129 struct regnode_lstring { /* Constructed this way to keep the string aligned. */
133 U32 str_len; /* Only 18 bits allowed before would overflow 'next_off' */
137 struct regnode_anyofhs { /* Constructed this way to keep the string aligned. */
141 U32 arg1; /* set by set_ANYOF_arg() */
145 /* Argument bearing node - workhorse,
146 arg1 is often for the data field */
154 /* Node whose argument is 'SV *'. This needs to be used very carefully in
155 * situations where pointers won't become invalid because of, say re-mallocs */
163 /* Similar to a regnode_1 but with an extra signed argument */
172 /* 'Two field' -- Two 16 bit unsigned args */
181 #define ANYOF_BITMAP_SIZE (NUM_ANYOF_CODE_POINTS / 8) /* 8 bits/Byte */
183 /* Note that these form structs which are supersets of the next smaller one, by
184 * appending fields. Alignment problems can occur if one of those optional
185 * fields requires stricter alignment than the base struct. And formal
186 * parameters that can really be two or more of the structs should be
187 * declared as the smallest one it could be. See commit message for
188 * 7dcac5f6a5195002b55c935ee1d67f67e1df280b. Regnode allocation is done
189 * without regard to alignment, and changing it to would also require changing
190 * the code that inserts and deletes regnodes. The basic single-argument
191 * regnode has a U32, which is what reganode() allocates as a unit. Therefore
192 * no field can require stricter alignment than U32. */
194 /* also used by trie */
195 struct regnode_charclass {
199 U32 arg1; /* set by set_ANYOF_arg() */
200 char bitmap[ANYOF_BITMAP_SIZE]; /* only compile-time */
203 /* has runtime (locale) \d, \w, ..., [:posix:] classes */
204 struct regnode_charclass_posixl {
205 U8 flags; /* ANYOF_MATCHES_POSIXL bit must go here */
209 char bitmap[ANYOF_BITMAP_SIZE]; /* both compile-time ... */
210 U32 classflags; /* and run-time */
213 /* A synthetic start class (SSC); is a regnode_charclass_posixl_fold, plus an
214 * extra SV*, used only during its construction and which is not used by
215 * regexec.c. Note that the 'next_off' field is unused, as the SSC stands
216 * alone, so there is never a next node. Also, there is no alignment issue,
217 * because these are declared or allocated as a complete unit so the compiler
218 * takes care of alignment. This is unlike the other regnodes which are
219 * allocated in terms of multiples of a single-argument regnode. SSC nodes can
220 * have a pointer field because there is no alignment issue, and because it is
221 * set to NULL after construction, before any cloning of the pattern */
223 U8 flags; /* ANYOF_MATCHES_POSIXL bit must go here */
227 char bitmap[ANYOF_BITMAP_SIZE]; /* both compile-time ... */
228 U32 classflags; /* ... and run-time */
230 /* Auxiliary, only used during construction; NULL afterwards: list of code
235 /* We take advantage of 'next_off' not otherwise being used in the SSC by
236 * actually using it: by setting it to 1. This allows us to test and
237 * distinguish between an SSC and other ANYOF node types, as 'next_off' cannot
238 * otherwise be 1, because it is the offset to the next regnode expressed in
239 * units of regnodes. Since an ANYOF node contains extra fields, it adds up
240 * to 12 regnode units on 32-bit systems, (hence the minimum this can be (if
241 * not 0) is 11 there. Even if things get tightly packed on a 64-bit system,
242 * it still would be more than 1. */
243 #define set_ANYOF_SYNTHETIC(n) STMT_START{ OP(n) = ANYOF; \
246 #define is_ANYOF_SYNTHETIC(n) (PL_regkind[OP(n)] == ANYOF && NEXT_OFF(n) == 1)
248 /* XXX fix this description.
249 Impose a limit of REG_INFTY on various pattern matching operations
250 to limit stack growth and to avoid "infinite" recursions.
252 /* The default size for REG_INFTY is U16_MAX, which is the same as
253 USHORT_MAX (see perl.h). Unfortunately U16 isn't necessarily 16 bits
254 (see handy.h). On the Cray C90, sizeof(short)==4 and hence U16_MAX is
255 ((1<<32)-1), while on the Cray T90, sizeof(short)==8 and U16_MAX is
256 ((1<<64)-1). To limit stack growth to reasonable sizes, supply a
258 --Andy Dougherty 11 June 1998
262 # define REG_INFTY nBIT_UMAX(16)
267 # define REG_INFTY U16_MAX
270 #define ARG_VALUE(arg) (arg)
271 #define ARG__SET(arg,val) ((arg) = (val))
277 #define ARG(p) ARG_VALUE(ARG_LOC(p))
278 #define ARGp(p) ARG_VALUE(ARGp_LOC(p))
279 #define ARG1(p) ARG_VALUE(ARG1_LOC(p))
280 #define ARG2(p) ARG_VALUE(ARG2_LOC(p))
281 #define ARG2L(p) ARG_VALUE(ARG2L_LOC(p))
283 #define ARG_SET(p, val) ARG__SET(ARG_LOC(p), (val))
284 #define ARGp_SET(p, val) ARG__SET(ARGp_LOC(p), (val))
285 #define ARG1_SET(p, val) ARG__SET(ARG1_LOC(p), (val))
286 #define ARG2_SET(p, val) ARG__SET(ARG2_LOC(p), (val))
287 #define ARG2L_SET(p, val) ARG__SET(ARG2L_LOC(p), (val))
292 #define NEXT_OFF(p) ((p)->next_off)
293 #define NODE_ALIGN(node)
294 /* the following define was set to 0xde in 075abff3
295 * as part of some linting logic. I have set it to 0
296 * as otherwise in every place where we /might/ set flags
297 * we have to set it 0 explicitly, which duplicates
298 * assignments and IMO adds an unacceptable level of
299 * surprise to working in the regex engine. If this
300 * is changed from 0 then at the very least make sure
301 * that SBOL for /^/ sets the flags to 0 explicitly.
303 #define NODE_ALIGN_FILL(node) ((node)->flags = 0)
305 #define SIZE_ALIGN NODE_ALIGN
311 #define OP(p) ((p)->type)
312 #define FLAGS(p) ((p)->flags) /* Caution: Doesn't apply to all \
313 regnode types. For some, it's the \
314 character set of the regnode */
315 #define STR_LENs(p) (__ASSERT_(OP(p) != LEXACT && OP(p) != LEXACT_REQ8) \
316 ((struct regnode_string *)p)->str_len)
317 #define STRINGs(p) (__ASSERT_(OP(p) != LEXACT && OP(p) != LEXACT_REQ8) \
318 ((struct regnode_string *)p)->string)
319 #define OPERANDs(p) STRINGs(p)
321 /* Long strings. Currently limited to length 18 bits, which handles a 262000
322 * byte string. The limiting factor is the 16 bit 'next_off' field, which
323 * points to the next regnode, so the furthest away it can be is 2**16. On
324 * most architectures, regnodes are 2**2 bytes long, so that yields 2**18
325 * bytes. Should a longer string be desired, we could increase it to 26 bits
326 * fairly easily, by changing this node to have longj type which causes the ARG
327 * field to be used for the link to the next regnode (although code would have
328 * to be changed to account for this), and then use a combination of the flags
329 * and next_off fields for the length. To get 34 bit length, also change the
330 * node to be an ARG2L, using the second 32 bit field for the length, and not
331 * using the flags nor next_off fields at all. One could have an llstring node
332 * and even an lllstring type. */
333 #define STR_LENl(p) (__ASSERT_(OP(p) == LEXACT || OP(p) == LEXACT_REQ8) \
334 (((struct regnode_lstring *)p)->str_len))
335 #define STRINGl(p) (__ASSERT_(OP(p) == LEXACT || OP(p) == LEXACT_REQ8) \
336 (((struct regnode_lstring *)p)->string))
337 #define OPERANDl(p) STRINGl(p)
339 #define STR_LEN(p) ((OP(p) == LEXACT || OP(p) == LEXACT_REQ8) \
340 ? STR_LENl(p) : STR_LENs(p))
341 #define STRING(p) ((OP(p) == LEXACT || OP(p) == LEXACT_REQ8) \
342 ? STRINGl(p) : STRINGs(p))
343 #define OPERAND(p) STRING(p)
345 /* The number of (smallest) regnode equivalents that a string of length l bytes
347 #define STR_SZ(l) (((l) + sizeof(regnode) - 1) / sizeof(regnode))
349 /* The number of (smallest) regnode equivalents that the EXACTISH node 'p'
351 #define NODE_SZ_STR(p) (STR_SZ(STR_LEN(p)) + 1 + regarglen[(p)->type])
353 #define setSTR_LEN(p,v) \
355 if (OP(p) == LEXACT || OP(p) == LEXACT_REQ8) \
356 ((struct regnode_lstring *)(p))->str_len = (v); \
358 ((struct regnode_string *)(p))->str_len = (v); \
361 #define ANYOFR_BASE_BITS 20
362 #define ANYOFRbase(p) (ARG(p) & nBIT_MASK(ANYOFR_BASE_BITS))
363 #define ANYOFRdelta(p) (ARG(p) >> ANYOFR_BASE_BITS)
370 #define NODE_ALIGN(node)
371 #define ARG_LOC(p) (((struct regnode_1 *)p)->arg1)
372 #define ARGp_LOC(p) (((struct regnode_p *)p)->arg1)
373 #define ARG1_LOC(p) (((struct regnode_2 *)p)->arg1)
374 #define ARG2_LOC(p) (((struct regnode_2 *)p)->arg2)
375 #define ARG2L_LOC(p) (((struct regnode_2L *)p)->arg2)
377 #define NODE_STEP_REGNODE 1 /* sizeof(regnode)/sizeof(regnode) */
378 #define EXTRA_STEP_2ARGS EXTRA_SIZE(struct regnode_2)
380 #define NEXTOPER(p) ((p) + NODE_STEP_REGNODE)
381 #define PREVOPER(p) ((p) - NODE_STEP_REGNODE)
383 #define FILL_NODE(offset, op) \
385 OP(REGNODE_p(offset)) = op; \
386 NEXT_OFF(REGNODE_p(offset)) = 0; \
388 #define FILL_ADVANCE_NODE(offset, op) \
390 FILL_NODE(offset, op); \
393 #define FILL_ADVANCE_NODE_ARG(offset, op, arg) \
395 ARG_SET(REGNODE_p(offset), arg); \
396 FILL_ADVANCE_NODE(offset, op); \
397 /* This is used generically for other operations \
398 * that have a longer argument */ \
399 (offset) += regarglen[op]; \
401 #define FILL_ADVANCE_NODE_ARGp(offset, op, arg) \
403 ARGp_SET(REGNODE_p(offset), arg); \
404 FILL_ADVANCE_NODE(offset, op); \
405 (offset) += regarglen[op]; \
407 #define FILL_ADVANCE_NODE_2L_ARG(offset, op, arg1, arg2) \
409 ARG_SET(REGNODE_p(offset), arg1); \
410 ARG2L_SET(REGNODE_p(offset), arg2); \
411 FILL_ADVANCE_NODE(offset, op); \
415 #define REG_MAGIC 0234
417 /* An ANYOF node is basically a bitmap with the index being a code point. If
418 * the bit for that code point is 1, the code point matches; if 0, it doesn't
419 * match (complemented if inverted). There is an additional mechanism to deal
420 * with cases where the bitmap is insufficient in and of itself. This #define
421 * indicates if the bitmap does fully represent what this ANYOF node can match.
422 * The ARG is set to this special value (since 0, 1, ... are legal, but will
423 * never reach this high). */
424 #define ANYOF_ONLY_HAS_BITMAP ((U32) -1)
426 /* When the bitmap isn't completely sufficient for handling the ANYOF node,
427 * flags (in node->flags of the ANYOF node) get set to indicate this. These
428 * are perennially in short supply. Beyond several cases where warnings need
429 * to be raised under certain circumstances, currently, there are six cases
430 * where the bitmap alone isn't sufficient. We could use six flags to
431 * represent the 6 cases, but to save flags bits, we play some games. The
434 * 1) The bitmap has a compiled-in very finite size. So something else needs
435 * to be used to specify if a code point that is too large for the bitmap
436 * actually matches. The mechanism currently is an inversion
437 * list. ANYOF_ONLY_HAS_BITMAP, described above, being TRUE indicates
438 * there are no matches of too-large code points. But if it is FALSE,
439 * then almost certainly there are matches too large for the bitmap. (The
440 * other cases, described below, either imply this one or are extremely
441 * rare in practice.) So we can just assume that a too-large code point
442 * will need something beyond the bitmap if ANYOF_ONLY_HAS_BITMAP is
443 * FALSE, instead of having a separate flag for this.
444 * 2) A subset of item 1) is if all possible code points outside the bitmap
445 * match. This is a common occurrence when the class is complemented,
446 * like /[^ij]/. Therefore a bit is reserved to indicate this,
447 * rather than having an inversion list created,
448 * ANYOF_MATCHES_ALL_ABOVE_BITMAP.
449 * 3) Under /d rules, it can happen that code points that are in the upper
450 * latin1 range (\x80-\xFF or their equivalents on EBCDIC platforms) match
451 * only if the runtime target string being matched against is UTF-8. For
452 * example /[\w[:punct:]]/d. This happens only for posix classes (with a
453 * couple of exceptions, like \d where it doesn't happen), and all such
454 * ones also have above-bitmap matches. Thus, 3) implies 1) as well.
455 * Note that /d rules are no longer encouraged; 'use 5.14' or higher
456 * deselects them. But a flag is required so that they can be properly
457 * handled. But it can be a shared flag: see 5) below.
458 * 4) Also under /d rules, something like /[\Wfoo]/ will match everything in
459 * the \x80-\xFF range, unless the string being matched against is UTF-8.
460 * An inversion list could be created for this case, but this is
461 * relatively common, and it turns out that it's all or nothing: if any
462 * one of these code points matches, they all do. Hence a single bit
463 * suffices. We use a shared flag that doesn't take up space by itself:
464 * ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER. This
465 * also implies 1), with one exception: [:^cntrl:].
466 * 5) A user-defined \p{} property may not have been defined by the time the
467 * regex is compiled. In this case, we don't know until runtime what it
468 * will match, so we have to assume it could match anything, including
469 * code points that ordinarily would be in the bitmap. A flag bit is
470 * necessary to indicate this , though it can be shared with the item 3)
471 * flag, as that only occurs under /d, and this only occurs under non-d.
472 * This case is quite uncommon in the field, and the /(?[ ...])/ construct
473 * is a better way to accomplish what this feature does. This case also
475 * ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP
476 * is the shared flag.
477 * 6) /[foo]/il may have folds that are only valid if the runtime locale is a
478 * UTF-8 one. These are quite rare, so it would be good to avoid the
479 * expense of looking for them. But /l matching is slow anyway, and we've
480 * traditionally not worried too much about its performance. And this
481 * condition requires the ANYOFL_FOLD flag to be set, so testing for
482 * that flag would be sufficient to rule out most cases of this. So it is
483 * unclear if this should have a flag or not. But, this flag can be
484 * shared with another, so it doesn't occupy extra space.
486 * At the moment, there is one spare bit, but this could be increased by
489 * If just one more bit is needed, as of this writing it seems to khw that the
490 * best choice would be to make ANYOF_MATCHES_ALL_ABOVE_BITMAP not a flag, but
493 * #define ANYOF_MATCHES_ALL_ABOVE_BITMAP ((U32) -2)
495 * and access it through the ARG like ANYOF_ONLY_HAS_BITMAP is. This flag is
496 * used by all ANYOF node types, and it could be used to avoid calling the
497 * handler function, as the macro REGINCLASS in regexec.c does now for other
500 * Another possibility is based on the fact that ANYOF_MATCHES_POSIXL is
501 * redundant with the node type ANYOFPOSIXL. That flag could be removed, but
502 * at the expense of extra code in regexec.c. The flag has been retained
503 * because it allows us to see if we need to call reginsert, or just use the
504 * bitmap in one test.
506 * If this is done, an extension would be to make all ANYOFL nodes contain the
507 * extra 32 bits that ANYOFPOSIXL ones do. The posix flags only occupy 30
508 * bits, so the ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD flags
509 * and ANYOFL_FOLD could be moved to that extra space, but it would mean extra
510 * instructions, as there are currently places in the code that assume those
513 * All told, 5 bits could be available for other uses if all of the above were
516 * Some flags are not used in synthetic start class (SSC) nodes, so could be
517 * shared should new flags be needed for SSCs, like SSC_MATCHES_EMPTY_STRING
520 /* If this is set, the result of the match should be complemented. regexec.c
521 * is expecting this to be in the low bit. Never in an SSC */
522 #define ANYOF_INVERT 0x01
524 /* For the SSC node only, which cannot be inverted, so is shared with that bit.
525 * This is used only during regex compilation. */
526 #define SSC_MATCHES_EMPTY_STRING ANYOF_INVERT
528 /* Set if this is a regnode_charclass_posixl vs a regnode_charclass. This
529 * is used for runtime \d, \w, [:posix:], ..., which are used only in locale
530 * and the optimizer's synthetic start class. Non-locale \d, etc are resolved
531 * at compile-time. Only set under /l; can be in SSC */
532 #define ANYOF_MATCHES_POSIXL 0x02
534 /* The fold is calculated and stored in the bitmap where possible at compile
535 * time. However under locale, the actual folding varies depending on
536 * what the locale is at the time of execution, so it has to be deferred until
537 * then. Only set under /l; never in an SSC */
538 #define ANYOFL_FOLD 0x04
540 /* Shared bit set only with ANYOFL and SSC nodes:
541 * If ANYOFL_FOLD is set, this flag indicates there are potential matches
542 * valid only if the locale is a UTF-8 one.
543 * If ANYOFL_FOLD is NOT set, this flag means to warn if the runtime locale
544 * isn't a UTF-8 one (and the generated node assumes a UTF-8 locale).
545 * None of INVERT, POSIXL,
546 * ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP
548 #define ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD 0x08
550 /* Convenience macros for teasing apart the meanings when reading the above bit
552 #define ANYOFL_SOME_FOLDS_ONLY_IN_UTF8_LOCALE(flags) \
553 ((flags & ( ANYOFL_FOLD /* Both bits are set */ \
554 |ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD)) \
556 |ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD))
558 #define ANYOFL_UTF8_LOCALE_REQD(flags) \
559 ((flags & ( ANYOFL_FOLD /* Only REQD bit is set */ \
560 |ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD)) \
561 == ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD)
563 /* Spare: Be sure to change ANYOF_FLAGS_ALL if this gets used 0x10 */
565 /* If set, the node matches every code point NUM_ANYOF_CODE_POINTS and above.
566 * Can be in an SSC */
567 #define ANYOF_MATCHES_ALL_ABOVE_BITMAP 0x20
570 * Under /d it means the ANYOFD node matches more things if the target
571 * string is encoded in UTF-8; any such things will be non-ASCII,
572 * characters that are < 256, and can be accessed via the inversion
574 * When not under /d, it means the ANYOF node contains a user-defined
575 * property that wasn't yet defined at the time the regex was compiled,
576 * and so must be looked up at runtime, by creating an inversion list.
577 * (These uses are mutually exclusive because a user-defined property is
578 * specified by \p{}, and \p{} implies /u which deselects /d). The long macro
579 * name is to make sure that you are cautioned about its shared nature. Only
580 * the non-/d meaning can be in an SSC */
581 #define ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP 0x40
584 * Under /d it means the ANYOFD node matches all non-ASCII Latin1
585 * characters when the target string is not in utf8.
586 * When not under /d, it means the ANYOF node should raise a warning if
587 * matching against an above-Unicode code point.
588 * (These uses are mutually exclusive because the warning requires a \p{}, and
589 * \p{} implies /u which deselects /d). An SSC node only has this bit set if
590 * what is meant is the warning. The long macro name is to make sure that you
591 * are cautioned about its shared nature */
592 #define ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER 0x80
594 #define ANYOF_FLAGS_ALL (0xff & ~0x10)
596 #define ANYOF_LOCALE_FLAGS (ANYOFL_FOLD | ANYOF_MATCHES_POSIXL)
598 /* These are the flags that apply to both regular ANYOF nodes and synthetic
599 * start class nodes during construction of the SSC. During finalization of
600 * the SSC, other of the flags may get added to it */
601 #define ANYOF_COMMON_FLAGS 0
603 /* Character classes for node->classflags of ANYOF */
604 /* Should be synchronized with a table in regprop() */
605 /* 2n should be the normal one, paired with its complement at 2n+1 */
607 #define ANYOF_ALPHA ((_CC_ALPHA) * 2)
608 #define ANYOF_NALPHA ((ANYOF_ALPHA) + 1)
609 #define ANYOF_ALPHANUMERIC ((_CC_ALPHANUMERIC) * 2) /* [[:alnum:]] isalnum(3), utf8::IsAlnum */
610 #define ANYOF_NALPHANUMERIC ((ANYOF_ALPHANUMERIC) + 1)
611 #define ANYOF_ASCII ((_CC_ASCII) * 2)
612 #define ANYOF_NASCII ((ANYOF_ASCII) + 1)
613 #define ANYOF_BLANK ((_CC_BLANK) * 2) /* GNU extension: space and tab: non-vertical space */
614 #define ANYOF_NBLANK ((ANYOF_BLANK) + 1)
615 #define ANYOF_CASED ((_CC_CASED) * 2) /* Pseudo class for [:lower:] or
616 [:upper:] under /i */
617 #define ANYOF_NCASED ((ANYOF_CASED) + 1)
618 #define ANYOF_CNTRL ((_CC_CNTRL) * 2)
619 #define ANYOF_NCNTRL ((ANYOF_CNTRL) + 1)
620 #define ANYOF_DIGIT ((_CC_DIGIT) * 2) /* \d */
621 #define ANYOF_NDIGIT ((ANYOF_DIGIT) + 1)
622 #define ANYOF_GRAPH ((_CC_GRAPH) * 2)
623 #define ANYOF_NGRAPH ((ANYOF_GRAPH) + 1)
624 #define ANYOF_LOWER ((_CC_LOWER) * 2)
625 #define ANYOF_NLOWER ((ANYOF_LOWER) + 1)
626 #define ANYOF_PRINT ((_CC_PRINT) * 2)
627 #define ANYOF_NPRINT ((ANYOF_PRINT) + 1)
628 #define ANYOF_PUNCT ((_CC_PUNCT) * 2)
629 #define ANYOF_NPUNCT ((ANYOF_PUNCT) + 1)
630 #define ANYOF_SPACE ((_CC_SPACE) * 2) /* \s */
631 #define ANYOF_NSPACE ((ANYOF_SPACE) + 1)
632 #define ANYOF_UPPER ((_CC_UPPER) * 2)
633 #define ANYOF_NUPPER ((ANYOF_UPPER) + 1)
634 #define ANYOF_WORDCHAR ((_CC_WORDCHAR) * 2) /* \w, PL_utf8_alnum, utf8::IsWord, ALNUM */
635 #define ANYOF_NWORDCHAR ((ANYOF_WORDCHAR) + 1)
636 #define ANYOF_XDIGIT ((_CC_XDIGIT) * 2)
637 #define ANYOF_NXDIGIT ((ANYOF_XDIGIT) + 1)
639 /* pseudo classes below this, not stored in the class bitmap, but used as flags
640 during compilation of char classes */
642 #define ANYOF_VERTWS ((_CC_VERTSPACE) * 2)
643 #define ANYOF_NVERTWS ((ANYOF_VERTWS)+1)
645 /* It is best if this is the last one, as all above it are stored as bits in a
646 * bitmap, and it isn't part of that bitmap */
647 #if _CC_VERTSPACE != _HIGHEST_REGCOMP_DOT_H_SYNC
648 # error Problem with handy.h _HIGHEST_REGCOMP_DOT_H_SYNC #define
651 #define ANYOF_POSIXL_MAX (ANYOF_VERTWS) /* So upper loop limit is written:
653 * Hence doesn't include VERTWS, as that
654 * is a pseudo class */
655 #define ANYOF_MAX ANYOF_POSIXL_MAX
657 #if (ANYOF_POSIXL_MAX > 32) /* Must fit in 32-bit word */
658 # error Problem with handy.h _CC_foo #defines
661 #define ANYOF_HORIZWS ((ANYOF_POSIXL_MAX)+2) /* = (ANYOF_NVERTWS + 1) */
662 #define ANYOF_NHORIZWS ((ANYOF_POSIXL_MAX)+3)
664 #define ANYOF_UNIPROP ((ANYOF_POSIXL_MAX)+4) /* Used to indicate a Unicode
665 property: \p{} or \P{} */
667 /* Backward source code compatibility. */
669 #define ANYOF_ALNUML ANYOF_ALNUM
670 #define ANYOF_NALNUML ANYOF_NALNUM
671 #define ANYOF_SPACEL ANYOF_SPACE
672 #define ANYOF_NSPACEL ANYOF_NSPACE
673 #define ANYOF_ALNUM ANYOF_WORDCHAR
674 #define ANYOF_NALNUM ANYOF_NWORDCHAR
676 /* Utility macros for the bitmap and classes of ANYOF */
678 #define ANYOF_FLAGS(p) ((p)->flags)
680 #define ANYOF_BIT(c) (1U << ((c) & 7))
682 #define POSIXL_SET(field, c) ((field) |= (1U << (c)))
683 #define ANYOF_POSIXL_SET(p, c) POSIXL_SET(((regnode_charclass_posixl*) (p))->classflags, (c))
685 #define POSIXL_CLEAR(field, c) ((field) &= ~ (1U <<(c)))
686 #define ANYOF_POSIXL_CLEAR(p, c) POSIXL_CLEAR(((regnode_charclass_posixl*) (p))->classflags, (c))
688 #define POSIXL_TEST(field, c) ((field) & (1U << (c)))
689 #define ANYOF_POSIXL_TEST(p, c) POSIXL_TEST(((regnode_charclass_posixl*) (p))->classflags, (c))
691 #define POSIXL_ZERO(field) STMT_START { (field) = 0; } STMT_END
692 #define ANYOF_POSIXL_ZERO(ret) POSIXL_ZERO(((regnode_charclass_posixl*) (ret))->classflags)
694 #define ANYOF_POSIXL_SET_TO_BITMAP(p, bits) \
696 ((regnode_charclass_posixl*) (p))->classflags = (bits); \
699 /* Shifts a bit to get, eg. 0x4000_0000, then subtracts 1 to get 0x3FFF_FFFF */
700 #define ANYOF_POSIXL_SETALL(ret) STMT_START { ((regnode_charclass_posixl*) (ret))->classflags = nBIT_MASK(ANYOF_POSIXL_MAX); } STMT_END
701 #define ANYOF_CLASS_SETALL(ret) ANYOF_POSIXL_SETALL(ret)
703 #define ANYOF_POSIXL_TEST_ANY_SET(p) \
704 ((ANYOF_FLAGS(p) & ANYOF_MATCHES_POSIXL) \
705 && (((regnode_charclass_posixl*)(p))->classflags))
706 #define ANYOF_CLASS_TEST_ANY_SET(p) ANYOF_POSIXL_TEST_ANY_SET(p)
708 /* Since an SSC always has this field, we don't have to test for that; nor do
709 * we want to because the bit isn't set for SSC during its construction */
710 #define ANYOF_POSIXL_SSC_TEST_ANY_SET(p) \
711 cBOOL(((regnode_ssc*)(p))->classflags)
712 #define ANYOF_POSIXL_SSC_TEST_ALL_SET(p) /* Are all bits set? */ \
713 (((regnode_ssc*) (p))->classflags \
714 == nBIT_MASK(ANYOF_POSIXL_MAX))
716 #define ANYOF_POSIXL_TEST_ALL_SET(p) \
717 ((ANYOF_FLAGS(p) & ANYOF_MATCHES_POSIXL) \
718 && ((regnode_charclass_posixl*) (p))->classflags \
719 == nBIT_MASK(ANYOF_POSIXL_MAX))
721 #define ANYOF_POSIXL_OR(source, dest) STMT_START { (dest)->classflags |= (source)->classflags ; } STMT_END
722 #define ANYOF_CLASS_OR(source, dest) ANYOF_POSIXL_OR((source), (dest))
724 #define ANYOF_POSIXL_AND(source, dest) STMT_START { (dest)->classflags &= (source)->classflags ; } STMT_END
726 #define ANYOF_BITMAP_ZERO(ret) Zero(((regnode_charclass*)(ret))->bitmap, ANYOF_BITMAP_SIZE, char)
727 #define ANYOF_BITMAP(p) ((regnode_charclass*)(p))->bitmap
728 #define ANYOF_BITMAP_BYTE(p, c) BITMAP_BYTE(ANYOF_BITMAP(p), c)
729 #define ANYOF_BITMAP_SET(p, c) (ANYOF_BITMAP_BYTE(p, c) |= ANYOF_BIT(c))
730 #define ANYOF_BITMAP_CLEAR(p,c) (ANYOF_BITMAP_BYTE(p, c) &= ~ANYOF_BIT(c))
731 #define ANYOF_BITMAP_TEST(p, c) cBOOL(ANYOF_BITMAP_BYTE(p, c) & ANYOF_BIT(c))
733 #define ANYOF_BITMAP_SETALL(p) \
734 memset (ANYOF_BITMAP(p), 255, ANYOF_BITMAP_SIZE)
735 #define ANYOF_BITMAP_CLEARALL(p) \
736 Zero (ANYOF_BITMAP(p), ANYOF_BITMAP_SIZE)
739 * Utility definitions.
742 # define UCHARAT(p) ((int)*(const U8*)(p))
744 # define UCHARAT(p) ((int)*(p)&CHARMASK)
747 /* Number of regnode equivalents that 'guy' occupies beyond the size of the
748 * smallest regnode. */
749 #define EXTRA_SIZE(guy) ((sizeof(guy)-1)/sizeof(struct regnode))
751 #define REG_ZERO_LEN_SEEN 0x00000001
752 #define REG_LOOKBEHIND_SEEN 0x00000002
753 #define REG_GPOS_SEEN 0x00000004
755 #define REG_RECURSE_SEEN 0x00000020
756 #define REG_TOP_LEVEL_BRANCHES_SEEN 0x00000040
757 #define REG_VERBARG_SEEN 0x00000080
758 #define REG_CUTGROUP_SEEN 0x00000100
759 #define REG_RUN_ON_COMMENT_SEEN 0x00000200
760 #define REG_UNFOLDED_MULTI_SEEN 0x00000400
762 #define REG_UNBOUNDED_QUANTIFIER_SEEN 0x00001000
767 #ifdef PLUGGABLE_RE_EXTENSION
768 #include "re_nodes.h"
770 #include "regnodes.h"
773 #ifndef PLUGGABLE_RE_EXTENSION
775 EXTCONST regexp_engine PL_core_reg_engine;
777 EXTCONST regexp_engine PL_core_reg_engine = {
780 Perl_re_intuit_start,
781 Perl_re_intuit_string,
782 Perl_regfree_internal,
783 Perl_reg_numbered_buff_fetch,
784 Perl_reg_numbered_buff_store,
785 Perl_reg_numbered_buff_length,
787 Perl_reg_named_buff_iter,
789 #if defined(USE_ITHREADS)
790 Perl_regdupe_internal,
795 #endif /* PLUGGABLE_RE_EXTENSION */
801 /* .what is a character array with one character for each member of .data
802 * The character describes the function of the corresponding .data item:
803 * a - AV for paren_name_list under DEBUGGING
804 * f - start-class data for regstclass optimization
805 * l - start op for literal (?{EVAL}) item
806 * L - start op for literal (?{EVAL}) item, with separate CV (qr//)
807 * r - pointer to an embedded code-containing qr, e.g. /ab$qr/
808 * s - inversion list for Unicode-style character class, and the
809 * multicharacter strings resulting from casefolding the single-character
810 * entries in the character class
812 * u - trie struct's widecharmap (a HV, so can't share, must dup)
813 * also used for revcharmap and words under DEBUGGING
814 * T - aho-trie struct
815 * S - sv for named capture lookup
816 * 20010712 mjd@plover.com
817 * (Remember to update re_dup() and pregfree() if you add any items.)
825 /* Code in S_to_utf8_substr() and S_to_byte_substr() in regexec.c accesses
826 anchored* and float* via array indexes 0 and 1. */
827 #define anchored_substr substrs->data[0].substr
828 #define anchored_utf8 substrs->data[0].utf8_substr
829 #define anchored_offset substrs->data[0].min_offset
830 #define anchored_end_shift substrs->data[0].end_shift
832 #define float_substr substrs->data[1].substr
833 #define float_utf8 substrs->data[1].utf8_substr
834 #define float_min_offset substrs->data[1].min_offset
835 #define float_max_offset substrs->data[1].max_offset
836 #define float_end_shift substrs->data[1].end_shift
838 #define check_substr substrs->data[2].substr
839 #define check_utf8 substrs->data[2].utf8_substr
840 #define check_offset_min substrs->data[2].min_offset
841 #define check_offset_max substrs->data[2].max_offset
842 #define check_end_shift substrs->data[2].end_shift
844 #define RX_ANCHORED_SUBSTR(rx) (ReANY(rx)->anchored_substr)
845 #define RX_ANCHORED_UTF8(rx) (ReANY(rx)->anchored_utf8)
846 #define RX_FLOAT_SUBSTR(rx) (ReANY(rx)->float_substr)
847 #define RX_FLOAT_UTF8(rx) (ReANY(rx)->float_utf8)
849 /* trie related stuff */
851 /* a transition record for the state machine. the
852 check field determines which state "owns" the
853 transition. the char the transition is for is
854 determined by offset from the owning states base
855 field. the next field determines which state
856 is to be transitioned to if any.
858 struct _reg_trie_trans {
863 /* a transition list element for the list based representation */
864 struct _reg_trie_trans_list_elem {
868 typedef struct _reg_trie_trans_list_elem reg_trie_trans_le;
870 /* a state for compressed nodes. base is an offset
871 into an array of reg_trie_trans array. If wordnum is
872 nonzero the state is accepting. if base is zero then
873 the state has no children (and will be accepting)
875 struct _reg_trie_state {
879 reg_trie_trans_le* list;
883 /* info per word; indexed by wordnum */
885 U16 prev; /* previous word in acceptance chain; eg in
886 * zzz|abc|ab/ after matching the chars abc, the
887 * accepted word is #2, and the previous accepted
889 U32 len; /* how many chars long is this word? */
890 U32 accept; /* accept state for this word */
894 typedef struct _reg_trie_state reg_trie_state;
895 typedef struct _reg_trie_trans reg_trie_trans;
898 /* anything in here that needs to be freed later
899 should be dealt with in pregfree.
900 refcount is first in both this and _reg_ac_data to allow a space
901 optimisation in Perl_regdupe. */
902 struct _reg_trie_data {
903 U32 refcount; /* number of times this trie is referenced */
904 U32 lasttrans; /* last valid transition element */
905 U16 *charmap; /* byte to charid lookup array */
906 reg_trie_state *states; /* state data */
907 reg_trie_trans *trans; /* array of transition elements */
908 char *bitmap; /* stclass bitmap */
909 U16 *jump; /* optional 1 indexed array of offsets before tail
910 for the node following a given word. */
911 reg_trie_wordinfo *wordinfo; /* array of info per word */
912 U16 uniquecharcount; /* unique chars in trie (width of trans table) */
913 U32 startstate; /* initial state - used for common prefix optimisation */
914 STRLEN minlen; /* minimum length of words in trie - build/opt only? */
915 STRLEN maxlen; /* maximum length of words in trie - build/opt only? */
916 U32 prefixlen; /* #chars in common prefix */
917 U32 statecount; /* Build only - number of states in the states array
918 (including the unused zero state) */
919 U32 wordcount; /* Build only */
921 STRLEN charcount; /* Build only */
924 /* There is one (3 under DEBUGGING) pointers that logically belong in this
925 structure, but are held outside as they need duplication on thread cloning,
926 whereas the rest of the structure can be read only:
927 HV *widecharmap; code points > 255 to charid
929 AV *words; Array of words contained in trie, for dumping
930 AV *revcharmap; Map of each charid back to its character representation
934 #define TRIE_WORDS_OFFSET 2
936 typedef struct _reg_trie_data reg_trie_data;
938 /* refcount is first in both this and _reg_trie_data to allow a space
939 optimisation in Perl_regdupe. */
940 struct _reg_ac_data {
944 reg_trie_state *states;
946 typedef struct _reg_ac_data reg_ac_data;
948 /* ANY_BIT doesn't use the structure, so we can borrow it here.
949 This is simpler than refactoring all of it as wed end up with
950 three different sets... */
952 #define TRIE_BITMAP(p) (((reg_trie_data *)(p))->bitmap)
953 #define TRIE_BITMAP_BYTE(p, c) BITMAP_BYTE(TRIE_BITMAP(p), c)
954 #define TRIE_BITMAP_SET(p, c) (TRIE_BITMAP_BYTE(p, c) |= ANYOF_BIT((U8)c))
955 #define TRIE_BITMAP_CLEAR(p,c) (TRIE_BITMAP_BYTE(p, c) &= ~ANYOF_BIT((U8)c))
956 #define TRIE_BITMAP_TEST(p, c) (TRIE_BITMAP_BYTE(p, c) & ANYOF_BIT((U8)c))
958 #define IS_ANYOF_TRIE(op) ((op)==TRIEC || (op)==AHOCORASICKC)
959 #define IS_TRIE_AC(op) ((op)>=AHOCORASICK)
962 #define BITMAP_BYTE(p, c) (( (U8*) p) [ ( ( (UV) (c)) >> 3) ] )
963 #define BITMAP_TEST(p, c) (BITMAP_BYTE(p, c) & ANYOF_BIT((U8)c))
965 /* these defines assume uniquecharcount is the correct variable, and state may be evaluated twice */
966 #define TRIE_NODENUM(state) (((state)-1)/(trie->uniquecharcount)+1)
967 #define SAFE_TRIE_NODENUM(state) ((state) ? (((state)-1)/(trie->uniquecharcount)+1) : (state))
968 #define TRIE_NODEIDX(state) ((state) ? (((state)-1)*(trie->uniquecharcount)+1) : (state))
971 #define TRIE_CHARCOUNT(trie) ((trie)->charcount)
973 #define TRIE_CHARCOUNT(trie) (trie_charcount)
976 #define RE_TRIE_MAXBUF_INIT 65536
977 #define RE_TRIE_MAXBUF_NAME "\022E_TRIE_MAXBUF"
978 #define RE_DEBUG_FLAGS "\022E_DEBUG_FLAGS"
980 #define RE_COMPILE_RECURSION_INIT 1000
981 #define RE_COMPILE_RECURSION_LIMIT "\022E_COMPILE_RECURSION_LIMIT"
985 RE_DEBUG_FLAGS is used to control what debug output is emitted
986 its divided into three groups of options, some of which interact.
987 The three groups are: Compile, Execute, Extra. There is room for a
988 further group, as currently only the low three bytes are used.
1009 If you modify any of these make sure you make corresponding changes to
1010 re.pm, especially to the documentation.
1016 #define RE_DEBUG_COMPILE_MASK 0x0000FF
1017 #define RE_DEBUG_COMPILE_PARSE 0x000001
1018 #define RE_DEBUG_COMPILE_OPTIMISE 0x000002
1019 #define RE_DEBUG_COMPILE_TRIE 0x000004
1020 #define RE_DEBUG_COMPILE_DUMP 0x000008
1021 #define RE_DEBUG_COMPILE_FLAGS 0x000010
1022 #define RE_DEBUG_COMPILE_TEST 0x000020
1025 #define RE_DEBUG_EXECUTE_MASK 0x00FF00
1026 #define RE_DEBUG_EXECUTE_INTUIT 0x000100
1027 #define RE_DEBUG_EXECUTE_MATCH 0x000200
1028 #define RE_DEBUG_EXECUTE_TRIE 0x000400
1031 #define RE_DEBUG_EXTRA_MASK 0x3FF0000
1032 #define RE_DEBUG_EXTRA_TRIE 0x0010000
1033 #define RE_DEBUG_EXTRA_OFFSETS 0x0020000
1034 #define RE_DEBUG_EXTRA_OFFDEBUG 0x0040000
1035 #define RE_DEBUG_EXTRA_STATE 0x0080000
1036 #define RE_DEBUG_EXTRA_OPTIMISE 0x0100000
1037 #define RE_DEBUG_EXTRA_BUFFERS 0x0400000
1038 #define RE_DEBUG_EXTRA_GPOS 0x0800000
1039 #define RE_DEBUG_EXTRA_DUMP_PRE_OPTIMIZE 0x1000000
1040 #define RE_DEBUG_EXTRA_WILDCARD 0x2000000
1042 #define RE_DEBUG_EXTRA_STACK 0x0280000
1044 #define RE_DEBUG_FLAG(x) (re_debug_flags & (x))
1046 #define DEBUG_COMPILE_r(x) DEBUG_r( \
1047 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_COMPILE_MASK)) x )
1048 #define DEBUG_PARSE_r(x) DEBUG_r( \
1049 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_COMPILE_PARSE)) x )
1050 #define DEBUG_OPTIMISE_r(x) DEBUG_r( \
1051 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_COMPILE_OPTIMISE)) x )
1052 #define DEBUG_DUMP_r(x) DEBUG_r( \
1053 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_COMPILE_DUMP)) x )
1054 #define DEBUG_TRIE_COMPILE_r(x) DEBUG_r( \
1055 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_COMPILE_TRIE)) x )
1056 #define DEBUG_FLAGS_r(x) DEBUG_r( \
1057 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_COMPILE_FLAGS)) x )
1058 #define DEBUG_TEST_r(x) DEBUG_r( \
1059 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_COMPILE_TEST)) x )
1061 #define DEBUG_EXECUTE_r(x) DEBUG_r( \
1062 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_EXECUTE_MASK)) x )
1063 #define DEBUG_INTUIT_r(x) DEBUG_r( \
1064 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_EXECUTE_INTUIT)) x )
1065 #define DEBUG_MATCH_r(x) DEBUG_r( \
1066 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_EXECUTE_MATCH)) x )
1067 #define DEBUG_TRIE_EXECUTE_r(x) DEBUG_r( \
1068 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_EXECUTE_TRIE)) x )
1071 #define DEBUG_EXTRA_r(x) DEBUG_r( \
1072 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_EXTRA_MASK)) x )
1073 #define DEBUG_OFFSETS_r(x) DEBUG_r( \
1074 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_EXTRA_OFFSETS)) x )
1075 #define DEBUG_STATE_r(x) DEBUG_r( \
1076 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_EXTRA_STATE)) x )
1077 #define DEBUG_STACK_r(x) DEBUG_r( \
1078 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_EXTRA_STACK)) x )
1079 #define DEBUG_BUFFERS_r(x) DEBUG_r( \
1080 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_EXTRA_BUFFERS)) x )
1082 #define DEBUG_OPTIMISE_MORE_r(x) DEBUG_r( \
1083 if (DEBUG_v_TEST || ((RE_DEBUG_EXTRA_OPTIMISE|RE_DEBUG_COMPILE_OPTIMISE) == \
1084 RE_DEBUG_FLAG(RE_DEBUG_EXTRA_OPTIMISE|RE_DEBUG_COMPILE_OPTIMISE))) x )
1085 #define MJD_OFFSET_DEBUG(x) DEBUG_r( \
1086 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_EXTRA_OFFDEBUG)) \
1087 Perl_warn_nocontext x )
1088 #define DEBUG_TRIE_COMPILE_MORE_r(x) DEBUG_TRIE_COMPILE_r( \
1089 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_EXTRA_TRIE)) x )
1090 #define DEBUG_TRIE_EXECUTE_MORE_r(x) DEBUG_TRIE_EXECUTE_r( \
1091 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_EXTRA_TRIE)) x )
1093 #define DEBUG_TRIE_r(x) DEBUG_r( \
1094 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_COMPILE_TRIE \
1095 | RE_DEBUG_EXECUTE_TRIE )) x )
1096 #define DEBUG_GPOS_r(x) DEBUG_r( \
1097 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_EXTRA_GPOS)) x )
1099 #define DEBUG_DUMP_PRE_OPTIMIZE_r(x) DEBUG_r( \
1100 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_EXTRA_DUMP_PRE_OPTIMIZE)) x )
1102 /* initialization */
1103 /* Get the debug flags for code not in regcomp.c nor regexec.c. This doesn't
1104 * initialize the variable if it isn't already there, instead it just assumes
1105 * the flags are 0 */
1106 #define DECLARE_AND_GET_RE_DEBUG_FLAGS_NON_REGEX \
1107 volatile IV re_debug_flags = 0; PERL_UNUSED_VAR(re_debug_flags); \
1109 SV * re_debug_flags_sv = NULL; \
1110 /* get_sv() can return NULL during global destruction. */ \
1111 re_debug_flags_sv = PL_curcop ? get_sv(RE_DEBUG_FLAGS, GV_ADD) : NULL; \
1112 if (re_debug_flags_sv && SvIOK(re_debug_flags_sv)) \
1113 re_debug_flags=SvIV(re_debug_flags_sv); \
1119 /* For use in regcomp.c and regexec.c, Get the debug flags, and initialize to
1120 * the defaults if not done already */
1121 #define DECLARE_AND_GET_RE_DEBUG_FLAGS \
1122 volatile IV re_debug_flags = 0; PERL_UNUSED_VAR(re_debug_flags); \
1124 SV * re_debug_flags_sv = NULL; \
1125 /* get_sv() can return NULL during global destruction. */ \
1126 re_debug_flags_sv = PL_curcop ? get_sv(RE_DEBUG_FLAGS, GV_ADD) : NULL; \
1127 if (re_debug_flags_sv) { \
1128 if (!SvIOK(re_debug_flags_sv)) /* If doesnt exist set to default */\
1129 sv_setuv(re_debug_flags_sv, \
1130 /* These defaults should be kept in sync with re.pm */ \
1131 RE_DEBUG_COMPILE_DUMP | RE_DEBUG_EXECUTE_MASK ); \
1132 re_debug_flags=SvIV(re_debug_flags_sv); \
1136 #define isDEBUG_WILDCARD (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_EXTRA_WILDCARD))
1138 #define RE_PV_COLOR_DECL(rpv,rlen,isuni,dsv,pv,l,m,c1,c2) \
1139 const char * const rpv = \
1140 pv_pretty((dsv), (pv), (l), (m), \
1141 PL_colors[(c1)],PL_colors[(c2)], \
1142 PERL_PV_ESCAPE_RE|PERL_PV_ESCAPE_NONASCII |((isuni) ? PERL_PV_ESCAPE_UNI : 0) ); \
1143 const int rlen = SvCUR(dsv)
1145 /* This is currently unsed in the core */
1146 #define RE_SV_ESCAPE(rpv,isuni,dsv,sv,m) \
1147 const char * const rpv = \
1148 pv_pretty((dsv), (SvPV_nolen_const(sv)), (SvCUR(sv)), (m), \
1149 PL_colors[(c1)],PL_colors[(c2)], \
1150 PERL_PV_ESCAPE_RE|PERL_PV_ESCAPE_NONASCII |((isuni) ? PERL_PV_ESCAPE_UNI : 0) )
1152 #define RE_PV_QUOTED_DECL(rpv,isuni,dsv,pv,l,m) \
1153 const char * const rpv = \
1154 pv_pretty((dsv), (pv), (l), (m), \
1155 PL_colors[0], PL_colors[1], \
1156 ( PERL_PV_PRETTY_QUOTE | PERL_PV_ESCAPE_RE | PERL_PV_ESCAPE_NONASCII | PERL_PV_PRETTY_ELLIPSES | \
1157 ((isuni) ? PERL_PV_ESCAPE_UNI : 0)) \
1160 #define RE_SV_DUMPLEN(ItEm) (SvCUR(ItEm) - (SvTAIL(ItEm)!=0))
1161 #define RE_SV_TAIL(ItEm) (SvTAIL(ItEm) ? "$" : "")
1163 #else /* if not DEBUGGING */
1165 #define DECLARE_AND_GET_RE_DEBUG_FLAGS dNOOP
1166 #define RE_PV_COLOR_DECL(rpv,rlen,isuni,dsv,pv,l,m,c1,c2) dNOOP
1167 #define RE_SV_ESCAPE(rpv,isuni,dsv,sv,m)
1168 #define RE_PV_QUOTED_DECL(rpv,isuni,dsv,pv,l,m) dNOOP
1169 #define RE_SV_DUMPLEN(ItEm)
1170 #define RE_SV_TAIL(ItEm)
1171 #define isDEBUG_WILDCARD 0
1173 #endif /* DEBUG RELATED DEFINES */
1175 #define FIRST_NON_ASCII_DECIMAL_DIGIT 0x660 /* ARABIC_INDIC_DIGIT_ZERO */
1178 TRADITIONAL_BOUND = _CC_WORDCHAR,
1185 /* This unpacks the FLAGS field of ANYOF[HR]x nodes. The value it contains
1186 * gives the strict lower bound for the UTF-8 start byte of any code point
1187 * matchable by the node, and a loose upper bound as well.
1189 * The low bound is stored in the upper 6 bits, plus 0xC0.
1190 * The loose upper bound is determined from the lowest 2 bits and the low bound
1191 * (called x) as follows:
1193 * 11 The upper limit of the range can be as much as (EF - x) / 8
1194 * 10 The upper limit of the range can be as much as (EF - x) / 4
1195 * 01 The upper limit of the range can be as much as (EF - x) / 2
1196 * 00 The upper limit of the range can be as much as EF
1198 * For motivation of this design, see commit message in
1199 * 3146c00a633e9cbed741e10146662fbcedfdb8d3 */
1201 # define MAX_ANYOF_HRx_BYTE 0xF4
1203 # define MAX_ANYOF_HRx_BYTE 0xEF
1205 #define LOWEST_ANYOF_HRx_BYTE(b) (((b) >> 2) + 0xC0)
1206 #define HIGHEST_ANYOF_HRx_BYTE(b) \
1207 (LOWEST_ANYOF_HRx_BYTE(b) \
1208 + ((MAX_ANYOF_HRx_BYTE - LOWEST_ANYOF_HRx_BYTE(b)) >> ((b) & 3)))
1210 #endif /* PERL_REGCOMP_H_ */
1213 * ex: set ts=8 sts=4 sw=4 et: