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 #if ! defined(PERL_REGCOMP_H_) && ( defined(PERL_CORE) \
12 || defined(PERL_EXT_RE_BUILD))
13 #define PERL_REGCOMP_H_
15 #include "regcharclass.h"
17 /* Convert branch sequences to more efficient trie ops? */
18 #define PERL_ENABLE_TRIE_OPTIMISATION 1
20 /* Be really aggressive about optimising patterns with trie sequences? */
21 #define PERL_ENABLE_EXTENDED_TRIE_OPTIMISATION 1
23 /* Should the optimiser take positive assertions into account? */
24 #define PERL_ENABLE_POSITIVE_ASSERTION_STUDY 0
26 /* Not for production use: */
27 #define PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS 0
30 * Structure for regexp "program". This is essentially a linear encoding
31 * of a nondeterministic finite-state machine (aka syntax charts or
32 * "railroad normal form" in parsing technology). Each node is an opcode
33 * plus a "next" pointer, possibly plus an operand. "Next" pointers of
34 * all nodes except BRANCH implement concatenation; a "next" pointer with
35 * a BRANCH on both ends of it is connecting two alternatives. (Here we
36 * have one of the subtle syntax dependencies: an individual BRANCH (as
37 * opposed to a collection of them) is never concatenated with anything
38 * because of operator precedence.) The operand of some types of node is
39 * a literal string; for others, it is a node leading into a sub-FSM. In
40 * particular, the operand of a BRANCH node is the first node of the branch.
41 * (NB this is *not* a tree structure: the tail of the branch connects
42 * to the thing following the set of BRANCHes.) The opcodes are defined
43 * in regnodes.h which is generated from regcomp.sym by regcomp.pl.
47 * A node is one char of opcode followed by two chars of "next" pointer.
48 * "Next" pointers are stored as two 8-bit pieces, high order first. The
49 * value is a positive offset from the opcode of the node containing it.
50 * An operand, if any, simply follows the node. (Note that much of the
51 * code generation knows about this implicit relationship.)
53 * Using two bytes for the "next" pointer is vast overkill for most things,
54 * but allows patterns to get big without disasters.
56 * [The "next" pointer is always aligned on an even
57 * boundary, and reads the offset directly as a short.]
60 /* This is the stuff that used to live in regexp.h that was truly
61 private to the engine itself. It now lives here. */
63 typedef struct regexp_internal {
64 regnode *regstclass; /* Optional startclass as identified or constructed
66 struct reg_data *data; /* Additional miscellaneous data used by the program.
67 Used to make it easier to clone and free arbitrary
68 data that the regops need. Often the ARG field of
69 a regop is an index into this structure. NOTE the
70 0th element of this structure is NEVER used and is
71 strictly reserved for internal purposes. */
72 struct reg_code_blocks *code_blocks;/* positions of literal (?{}) */
73 U32 proglen; /* size of the compiled program in regnodes */
74 U32 name_list_idx; /* Optional data index of an array of paren names,
75 only valid when RXp_PAREN_NAMES(prog) is true,
76 0 means "no value" like any other index into the
78 regnode program[1]; /* Unwarranted chumminess with compiler. */
81 #define RXi_SET(x,y) (x)->pprivate = (void*)(y)
82 #define RXi_GET(x) ((regexp_internal *)((x)->pprivate))
83 #define RXi_GET_DECL(r,ri) regexp_internal *ri = RXi_GET(r)
85 * Flags stored in regexp->intflags
86 * These are used only internally to the regexp engine
88 * See regexp.h for flags used externally to the regexp engine
90 #define RXp_INTFLAGS(rx) ((rx)->intflags)
91 #define RX_INTFLAGS(prog) RXp_INTFLAGS(ReANY(prog))
93 #define PREGf_SKIP 0x00000001
94 #define PREGf_IMPLICIT 0x00000002 /* Converted .* to ^.* */
95 #define PREGf_NAUGHTY 0x00000004 /* how exponential is this pattern? */
96 #define PREGf_VERBARG_SEEN 0x00000008
97 #define PREGf_CUTGROUP_SEEN 0x00000010
98 #define PREGf_USE_RE_EVAL 0x00000020 /* compiled with "use re 'eval'" */
99 /* these used to be extflags, but are now intflags */
100 #define PREGf_NOSCAN 0x00000040
102 #define PREGf_GPOS_SEEN 0x00000100
103 #define PREGf_GPOS_FLOAT 0x00000200
105 #define PREGf_ANCH_MBOL 0x00000400
106 #define PREGf_ANCH_SBOL 0x00000800
107 #define PREGf_ANCH_GPOS 0x00001000
108 #define PREGf_RECURSE_SEEN 0x00002000
111 ( PREGf_ANCH_SBOL | PREGf_ANCH_GPOS | PREGf_ANCH_MBOL )
113 /* this is where the old regcomp.h started */
116 /* Define the various regnode structures. These all should be a multiple
117 * of 32 bits large, and they should by and large correspond with each other
118 * in terms of naming, etc. Things can and will break in subtle ways if you
119 * change things without care. If you look at regexp.h you will see it
128 * This structure is the base unit of elements in the regexp program. When
129 * we increment our way through the program we increment by the size of this
130 * structure, and in all cases where regnode sizing is considered it is in
131 * units of this structure.
133 * This implies that no regnode style structure should contain 64 bit
134 * aligned members. Since the base regnode is 32 bits any member might
135 * not be 64 bit aligned no matter how you might try to pad out the
136 * struct itself (the regnode_ssc is special in this regard as it is
137 * never used in a program directly). If you want to store 64 bit
138 * members you need to store them specially. The struct regnode_p and the
139 * ARGp() and ARGp_SET() macros and related inline functions provide an example
140 * solution. Note they deal with a slightly more complicated problem than simple
141 * alignment, as pointers may be 32 bits or 64 bits depending on platform,
142 * but they illustrate the pattern to follow if you want to put a 64 bit value
145 * NOTE: Ideally we do not put pointers into the regnodes in a program. Instead
146 * we put them in the "data" part of the regexp structure and store the index into
147 * the data in the pointers in the regnode. This allows the pointer to be handled
148 * properly during clone/free operations (eg refcount bookkeeping). See S_add_data(),
149 * Perl_regdupe_internal(), Perl_regfree_internal() in regcomp.c for how the data
150 * array can be used, the letters 'arsSu' all refer to different types of SV that
151 * we already have support for in the data array.
154 struct regnode_string {
161 struct regnode_lstring { /* Constructed this way to keep the string aligned. */
165 U32 str_len; /* Only 18 bits allowed before would overflow 'next_off' */
169 struct regnode_anyofhs { /* Constructed this way to keep the string aligned. */
173 U32 arg1; /* set by set_ANYOF_arg() */
177 /* Argument bearing node - workhorse,
178 arg1 is often for the data field */
186 /* Node whose argument is 'SV *'. This needs to be used very carefully in
187 * situations where pointers won't become invalid because of, say re-mallocs.
189 * Note that this regnode type is problematic and should not be used or copied
190 * and will be removed in the future. Pointers should be stored in the data[]
191 * array and an index into the data array stored in the regnode, which allows the
192 * pointers to be handled properly during clone/free operations on the regexp
193 * data structure. As a byproduct it also saves space, often we use a 16 bit
194 * member to store indexes into the data[] array.
196 * Also note that the weird storage here is because regnodes are 32 bit aligned,
197 * which means we cannot have a 64 bit aligned member. To make things more annoying
198 * the size of a pointer may vary by platform. Thus we use a character array, and
199 * then use inline functions to copy the data in or out.
205 char arg1_sv_ptr_bytes[sizeof(SV *)];
208 /* Similar to a regnode_1 but with an extra signed argument */
217 /* 'Two field' -- Two 16 bit unsigned args */
226 #define REGNODE_BBM_BITMAP_LEN \
227 /* 6 info bits requires 64 bits; 5 => 32 */ \
228 ((1 << (UTF_CONTINUATION_BYTE_INFO_BITS)) / CHARBITS)
230 /* Used for matching any two-byte UTF-8 character whose start byte is known.
231 * The array is a bitmap capable of representing any possible continuation
237 U8 bitmap[REGNODE_BBM_BITMAP_LEN];
240 #define ANYOF_BITMAP_SIZE (NUM_ANYOF_CODE_POINTS / CHARBITS)
242 /* Note that these form structs which are supersets of the next smaller one, by
243 * appending fields. Alignment problems can occur if one of those optional
244 * fields requires stricter alignment than the base struct. And formal
245 * parameters that can really be two or more of the structs should be
246 * declared as the smallest one it could be. See commit message for
247 * 7dcac5f6a5195002b55c935ee1d67f67e1df280b. Regnode allocation is done
248 * without regard to alignment, and changing it to would also require changing
249 * the code that inserts and deletes regnodes. The basic single-argument
250 * regnode has a U32, which is what reganode() allocates as a unit. Therefore
251 * no field can require stricter alignment than U32. */
253 /* also used by trie */
254 struct regnode_charclass {
258 U32 arg1; /* set by set_ANYOF_arg() */
259 char bitmap[ANYOF_BITMAP_SIZE]; /* only compile-time */
262 /* has runtime (locale) \d, \w, ..., [:posix:] classes */
263 struct regnode_charclass_posixl {
264 U8 flags; /* ANYOF_MATCHES_POSIXL bit must go here */
268 char bitmap[ANYOF_BITMAP_SIZE]; /* both compile-time ... */
269 U32 classflags; /* and run-time */
272 /* A synthetic start class (SSC); is a regnode_charclass_posixl_fold, plus an
273 * extra SV*, used only during regex construction and which is not used by the
274 * main machinery in regexec.c and which does not get embedded in the final compiled
277 * Because it does not get embedded it does not have to comply with the alignment
278 * and sizing constraints required for a normal regnode structure: it MAY contain
279 * pointers or members of whatever size needed and the compiler will do the right
280 * thing. (Every other regnode type is 32 bit aligned.)
282 * Note that the 'next_off' field is unused, as the SSC stands alone, so there is
286 U8 flags; /* ANYOF_MATCHES_POSIXL bit must go here */
290 char bitmap[ANYOF_BITMAP_SIZE]; /* both compile-time ... */
291 U32 classflags; /* ... and run-time */
293 /* Auxiliary, only used during construction; NULL afterwards: list of code
298 /* We take advantage of 'next_off' not otherwise being used in the SSC by
299 * actually using it: by setting it to 1. This allows us to test and
300 * distinguish between an SSC and other ANYOF node types, as 'next_off' cannot
301 * otherwise be 1, because it is the offset to the next regnode expressed in
302 * units of regnodes. Since an ANYOF node contains extra fields, it adds up
303 * to 12 regnode units on 32-bit systems, (hence the minimum this can be (if
304 * not 0) is 11 there. Even if things get tightly packed on a 64-bit system,
305 * it still would be more than 1. */
306 #define set_ANYOF_SYNTHETIC(n) STMT_START{ OP(n) = ANYOF; \
309 #define is_ANYOF_SYNTHETIC(n) (PL_regnode_kind[OP(n)] == ANYOF && NEXT_OFF(n) == 1)
311 /* XXX fix this description.
312 Impose a limit of REG_INFTY on various pattern matching operations
313 to limit stack growth and to avoid "infinite" recursions.
315 /* The default size for REG_INFTY is U16_MAX, which is the same as
316 USHORT_MAX (see perl.h). Unfortunately U16 isn't necessarily 16 bits
317 (see handy.h). On the Cray C90, sizeof(short)==4 and hence U16_MAX is
318 ((1<<32)-1), while on the Cray T90, sizeof(short)==8 and U16_MAX is
319 ((1<<64)-1). To limit stack growth to reasonable sizes, supply a
321 --Andy Dougherty 11 June 1998
325 # define REG_INFTY nBIT_UMAX(16)
330 # define REG_INFTY U16_MAX
333 #define ARG_VALUE(arg) (arg)
334 #define ARG__SET(arg,val) ((arg) = (val))
340 #define ARG(p) ARG_VALUE(ARG_LOC(p))
341 #define ARGp(p) ARGp_VALUE_inline(p)
342 #define ARG1(p) ARG_VALUE(ARG1_LOC(p))
343 #define ARG2(p) ARG_VALUE(ARG2_LOC(p))
344 #define ARG2L(p) ARG_VALUE(ARG2L_LOC(p))
346 #define ARG_SET(p, val) ARG__SET(ARG_LOC(p), (val))
347 #define ARG1_SET(p, val) ARG__SET(ARG1_LOC(p), (val))
348 #define ARG2_SET(p, val) ARG__SET(ARG2_LOC(p), (val))
349 #define ARG2L_SET(p, val) ARG__SET(ARG2L_LOC(p), (val))
350 #define ARGp_SET(p, val) ARGp_SET_inline((p),(val))
355 #define NEXT_OFF(p) ((p)->next_off)
356 #define NODE_ALIGN(node)
357 /* the following define was set to 0xde in 075abff3
358 * as part of some linting logic. I have set it to 0
359 * as otherwise in every place where we /might/ set flags
360 * we have to set it 0 explicitly, which duplicates
361 * assignments and IMO adds an unacceptable level of
362 * surprise to working in the regex engine. If this
363 * is changed from 0 then at the very least make sure
364 * that SBOL for /^/ sets the flags to 0 explicitly.
366 #define NODE_ALIGN_FILL(node) ((node)->flags = 0)
368 #define SIZE_ALIGN NODE_ALIGN
374 #define OP(p) ((p)->type)
375 #define FLAGS(p) ((p)->flags) /* Caution: Doesn't apply to all \
376 regnode types. For some, it's the \
377 character set of the regnode */
378 #define STR_LENs(p) (__ASSERT_(OP(p) != LEXACT && OP(p) != LEXACT_REQ8) \
379 ((struct regnode_string *)p)->str_len)
380 #define STRINGs(p) (__ASSERT_(OP(p) != LEXACT && OP(p) != LEXACT_REQ8) \
381 ((struct regnode_string *)p)->string)
382 #define OPERANDs(p) STRINGs(p)
384 /* Long strings. Currently limited to length 18 bits, which handles a 262000
385 * byte string. The limiting factor is the 16 bit 'next_off' field, which
386 * points to the next regnode, so the furthest away it can be is 2**16. On
387 * most architectures, regnodes are 2**2 bytes long, so that yields 2**18
388 * bytes. Should a longer string be desired, we could increase it to 26 bits
389 * fairly easily, by changing this node to have longj type which causes the ARG
390 * field to be used for the link to the next regnode (although code would have
391 * to be changed to account for this), and then use a combination of the flags
392 * and next_off fields for the length. To get 34 bit length, also change the
393 * node to be an ARG2L, using the second 32 bit field for the length, and not
394 * using the flags nor next_off fields at all. One could have an llstring node
395 * and even an lllstring type. */
396 #define STR_LENl(p) (__ASSERT_(OP(p) == LEXACT || OP(p) == LEXACT_REQ8) \
397 (((struct regnode_lstring *)p)->str_len))
398 #define STRINGl(p) (__ASSERT_(OP(p) == LEXACT || OP(p) == LEXACT_REQ8) \
399 (((struct regnode_lstring *)p)->string))
400 #define OPERANDl(p) STRINGl(p)
402 #define STR_LEN(p) ((OP(p) == LEXACT || OP(p) == LEXACT_REQ8) \
403 ? STR_LENl(p) : STR_LENs(p))
404 #define STRING(p) ((OP(p) == LEXACT || OP(p) == LEXACT_REQ8) \
405 ? STRINGl(p) : STRINGs(p))
406 #define OPERAND(p) STRING(p)
408 /* The number of (smallest) regnode equivalents that a string of length l bytes
410 #define STR_SZ(l) (((l) + sizeof(regnode) - 1) / sizeof(regnode))
412 /* The number of (smallest) regnode equivalents that the node 'p' which uses
413 * 'struct regnode_string' occupies. (These are EXACTish nodes and a few
415 #define NODE_SZ_STR(p) (STR_SZ(STR_LEN(p)) + 1 + PL_regnode_arg_len[(p)->type])
417 #define setSTR_LEN(p,v) \
419 if (OP(p) == LEXACT || OP(p) == LEXACT_REQ8) \
420 ((struct regnode_lstring *)(p))->str_len = (v); \
422 ((struct regnode_string *)(p))->str_len = (v); \
425 #define ANYOFR_BASE_BITS 20
426 #define ANYOFRbase(p) (ARG(p) & nBIT_MASK(ANYOFR_BASE_BITS))
427 #define ANYOFRdelta(p) (ARG(p) >> ANYOFR_BASE_BITS)
432 #undef REGNODE_BEFORE
434 #define NODE_ALIGN(node)
435 #define ARG_LOC(p) (((struct regnode_1 *)p)->arg1)
436 #define ARGp_BYTES_LOC(p) (((struct regnode_p *)p)->arg1_sv_ptr_bytes)
437 #define ARG1_LOC(p) (((struct regnode_2 *)p)->arg1)
438 #define ARG2_LOC(p) (((struct regnode_2 *)p)->arg2)
439 #define ARG2L_LOC(p) (((struct regnode_2L *)p)->arg2)
441 /* These should no longer be used directly in most cases. Please use
442 * the REGNODE_AFTER() macros instead. */
443 #define NODE_STEP_REGNODE 1 /* sizeof(regnode)/sizeof(regnode) */
444 #define EXTRA_STEP_2ARGS EXTRA_SIZE(struct regnode_2)
446 /* core macros for computing the regnode after this one, there is also
447 * a function which is more powerful called Perl_regnode_after(), see
450 * Note that regnodes can be thought of as nodes in binary tree like structure.
451 * The first "child" of a node is its immediate successor in the program, the
452 * second "child" of a node, if it has one, will be stored as an index in the
453 * regnode struct, usually in a field marked next_off (but sometimes somewhere
454 * else). To access the immediate successor of a regnode you should use one
455 * of the REGNODE_AFTER_xxx() macros which understand how long a given regnode is.
456 * To access the optional successor of a regnode you use the Perl_regnext()
457 * function in regcomp.c
459 * There are several variants of the REGNODE_AFTER_xxx() macros which are intended
460 * for use in different situations depending on how confident the code is about
461 * what node it is trying to find a successor for.
463 * So for instance if you know you are dealing with a known node type
464 * then you should use REGNODE_AFTER_type(NODE,TYPE).
466 * If you have a regnode pointer and nothing else use: REGNODE_AFTER_dynamic(NODE)
468 * If you have a regnode pointer and you have already extracted its opcode use:
469 * REGNODE_AFTER_opcode(NODE,OPCODE).
472 #define REGNODE_AFTER_PLUS(p,extra) ((p) + NODE_STEP_REGNODE + (extra))
473 /* under DEBUGGING we check that all REGNODE_AFTER style macro did the
474 * same thing that Perl_regnode_after() would have done. Note that when
475 * not compiled under DEBUGGING the assert_() macro is empty. Thus we
476 * don't have to implement different versions for DEBUGGING and not DEBUGGING,
477 * and explains why all the macros use REGNODE_AFTER_PLUS_DEBUG() under the
479 #define REGNODE_AFTER_PLUS_DEBUG(p,extra) \
480 (assert_(check_regnode_after(p,extra)) REGNODE_AFTER_PLUS((p),(extra)))
482 /* try to avoid using either of the following two directly. They exist for legacy
484 #define REGNODE_AFTER_plus(p,extra) REGNODE_AFTER_PLUS_DEBUG((p),(extra))
485 #define REGNODE_AFTER(p) REGNODE_AFTER_plus((p),0)
486 /* find the regnode after this p by using the opcode we previously extracted
488 #define REGNODE_AFTER_opcode(p,op) REGNODE_AFTER_plus((p),PL_regnode_arg_len[op])
489 /* find the regnode after this p by using OP(p) to find the regnode type of p */
490 #define REGNODE_AFTER_dynamic(p) REGNODE_AFTER_opcode((p),OP(p))
491 /* find the regnode after this p by using the size of the struct associated with
493 /* find the regnode after this p by using OP(p) to find the regnode type of p */
494 #define REGNODE_AFTER(p) regnode_after(p)
497 /* REGNODE_BEFORE() is trickier to deal with in terms of validation, execution.
498 * All the places that use it assume that p will be one struct regnode large.
499 * So to validate it we do the math to go backwards and then validate that the
500 * type of regnode we landed on is actually one regnode large. In theory if
501 * things go wrong the opcode should be illegal or say the item should be larger
502 * than it is, etc. */
503 #define REGNODE_BEFORE_BASE(p) ((p) - NODE_STEP_REGNODE)
504 #define REGNODE_BEFORE_BASE_DEBUG(p) \
505 (assert_(check_regnode_after(REGNODE_BEFORE_BASE(p),0)) REGNODE_BEFORE_BASE(p))
506 #define REGNODE_BEFORE(p) REGNODE_BEFORE_BASE_DEBUG(p)
508 #define FILL_NODE(offset, op) \
510 OP(REGNODE_p(offset)) = op; \
511 NEXT_OFF(REGNODE_p(offset)) = 0; \
513 #define FILL_ADVANCE_NODE(offset, op) \
515 FILL_NODE(offset, op); \
518 #define FILL_ADVANCE_NODE_ARG(offset, op, arg) \
520 ARG_SET(REGNODE_p(offset), arg); \
521 FILL_ADVANCE_NODE(offset, op); \
522 /* This is used generically for other operations \
523 * that have a longer argument */ \
524 (offset) += PL_regnode_arg_len[op]; \
526 #define FILL_ADVANCE_NODE_ARGp(offset, op, arg) \
528 ARGp_SET(REGNODE_p(offset), arg); \
529 FILL_ADVANCE_NODE(offset, op); \
530 (offset) += PL_regnode_arg_len[op]; \
532 #define FILL_ADVANCE_NODE_2L_ARG(offset, op, arg1, arg2) \
534 ARG_SET(REGNODE_p(offset), arg1); \
535 ARG2L_SET(REGNODE_p(offset), arg2); \
536 FILL_ADVANCE_NODE(offset, op); \
540 /* define these after we define the normal macros, so we can use
541 * ARGp_BYTES_LOC(n) */
544 ARGp_VALUE_inline(struct regnode *node) {
546 memcpy(&ptr, ARGp_BYTES_LOC(node), sizeof(ptr));
552 ARGp_SET_inline(struct regnode *node, SV *ptr) {
553 memcpy(ARGp_BYTES_LOC(node), &ptr, sizeof(ptr));
556 #define REG_MAGIC 0234
558 /* An ANYOF node matches a single code point based on specified criteria. It
559 * now comes in several styles, but originally it was just a 256 element
560 * bitmap, indexed by the code point (which was always just a byte). If the
561 * corresponding bit for a code point is 1, the code point matches; if 0, it
562 * doesn't match (complemented if inverted). This worked fine before Unicode
563 * existed, but making a bit map long enough to accommodate a bit for every
564 * possible Unicode code point is prohibitively large. Therefore it is made
565 * much much smaller, and an inversion list is created to handle code points
566 * not represented by the bitmap. (It is now possible to compile the bitmap to
567 * a larger size to avoid the slower inversion list lookup for however big the
568 * bitmap is set to, but this is rarely done). If the bitmap is sufficient to
569 * specify all possible matches (with nothing outside it matching), no
570 * inversion list is needed nor included, and the argument to the ANYOF node is
571 * set to the following: */
573 #define ANYOF_MATCHES_ALL_OUTSIDE_BITMAP_VALUE U32_MAX
574 #define ANYOF_MATCHES_ALL_OUTSIDE_BITMAP(node) \
575 (ARG(node) == ANYOF_MATCHES_ALL_OUTSIDE_BITMAP_VALUE)
577 #define ANYOF_MATCHES_NONE_OUTSIDE_BITMAP_VALUE \
578 /* Assumes ALL is odd */ (ANYOF_MATCHES_ALL_OUTSIDE_BITMAP_VALUE - 1)
579 #define ANYOF_MATCHES_NONE_OUTSIDE_BITMAP(node) \
580 (ARG(node) == ANYOF_MATCHES_NONE_OUTSIDE_BITMAP_VALUE)
582 #define ANYOF_ONLY_HAS_BITMAP_MASK ANYOF_MATCHES_NONE_OUTSIDE_BITMAP_VALUE
583 #define ANYOF_ONLY_HAS_BITMAP(node) \
584 ((ARG(node) & ANYOF_ONLY_HAS_BITMAP_MASK) == ANYOF_ONLY_HAS_BITMAP_MASK)
586 #define ANYOF_HAS_AUX(node) (! ANYOF_ONLY_HAS_BITMAP(node))
588 /* There are also ANYOFM nodes, used when the bit patterns representing the
589 * matched code points happen to be such that they can be checked by ANDing
590 * with a mask. The regex compiler looks for and silently optimizes to using
591 * this node type in the few cases where it works out. The eight octal digits
592 * form such a group. These nodes are simple and fast and no further
593 * discussion is needed here.
595 * And, there are ANYOFH-ish nodes which match only code points that aren't in
596 * the bitmap (the H stands for High). These are common for expressing
597 * Unicode properties concerning non-Latin scripts. They dispense with the
598 * bitmap altogether and don't need any of the flags discussed below.
600 * And, there are ANYOFR-ish nodes which match within a single range.
602 * When there is a need to specify what matches outside the bitmap, it is done
603 * by allocating an AV as part of the pattern's compiled form, and the argument
604 * to the node instead of being ANYOF_ONLY_HAS_BITMAP, points to that AV.
606 * (Actually, that is an oversimplification. The AV is placed into the
607 * pattern's struct reg_data, and what is stored in the node's argument field
608 * is its index into that struct. And the inversion list is just one element,
609 * the zeroth, of the AV.)
611 * There are certain situations where a single inversion list can't handle all
612 * the complexity. These are dealt with by having extra elements in the AV, by
613 * specifying flag bits in the ANYOF node, and/or special code. As an example,
614 * there are instances where what the ANYOF node matches is not completely
615 * known until runtime. In these cases, a flag is set, and the bitmap has a 1
616 * for the code points which are known at compile time to be 1, and a 0 for the
617 * ones that are known to be 0, or require runtime resolution. Some missing
618 * information can be found by merely seeing if the pattern is UTF-8 or not;
619 * other cases require looking at the extra elements in the AV.
621 * There are 5 cases where the bitmap is insufficient. These are specified by
622 * flags in the node's flags field. We could use five bits to represent the 5
623 * cases, but to save flags bits (which are perennially in short supply), we
624 * play some games. The cases are:
626 * 1) As already mentioned, if some code points outside the bitmap match, and
627 * some do not, an inversion list is specified to indicate which ones.
629 * 2) Under /d rules, it can happen that code points that are in the upper
630 * latin1 range (\x80-\xFF or their equivalents on EBCDIC platforms) match
631 * only if the runtime target string being matched against is UTF-8. For
632 * example /[\w[:punct:]]/d. This happens only for certain posix classes,
633 * and all such ones also have above-bitmap matches.
635 * Note that /d rules are no longer encouraged; 'use 5.14' or higher
636 * deselects them. But they are still supported, and a flag is required
637 * so that they can be properly handled. But it can be a shared flag: see
640 * 3) Also under /d rules, something like /[\Wfoo]/ will match everything in
641 * the \x80-\xFF range, unless the string being matched against is UTF-8.
642 * An inversion list could be created for this case, but this is
643 * relatively common, and it turns out that it's all or nothing: if any
644 * one of these code points matches, they all do. Hence a single bit
645 * suffices. We use a shared flag that doesn't take up space by itself:
646 * ANYOFD_NON_UTF8_MATCHES_ALL_NON_ASCII__shared. This also means there
647 * is an inversion list for the things that don't fit into the bitmap.
649 * 4) A user-defined \p{} property may not have been defined by the time the
650 * regex is compiled. In this case, we don't know until runtime what it
651 * will match, so we have to assume it could match anything, including
652 * code points that ordinarily would be in the bitmap. A flag bit is
653 * necessary to indicate this, though we can use the
654 * ANYOF_HAS_EXTRA_RUNTIME_MATCHES flag, along with the node not being
655 * ANYOFD. The information required to construct the property is stored
656 * in the AV pointed to by the node's argument. This case is quite
657 * uncommon in the field, and the /(?[...])/ construct is a better way to
658 * accomplish what this feature does.
660 * 5) /[foo]/il may have folds that are only valid if the runtime locale is a
661 * UTF-8 one. The ANYOF_HAS_EXTRA_RUNTIME_MATCHES flag can also be used
662 * for these. The list is stored in a different element of the AV, so its
663 * existence differentiates this case from that of 4), along with the node
664 * being ANYOFL, with the ANYOFL_FOLD flag being set. There are a few
665 * additional folds valid only if the UTF-8 locale is a Turkic one which
666 * is tested for explicitly.
668 * Note that the user-defined property flag and the /il flag can affect whether
669 * an ASCII character matches in the bitmap or not.
671 * And this still isn't the end of the story. In some cases, warnings are
672 * supposed to be raised when matching certain categories of code points in the
673 * target string. Flags are set to indicate this. This adds up to a bunch of
674 * flags required, and we only have 8 available. That is why we share some.
675 * At the moment, there are two spare flag bits, but this could be increased by
678 * ANYOF_MATCHES_POSIXL is redundant with the node type ANYOFPOSIXL. That flag
679 * could be removed, but at the expense of having to write extra code, which
680 * would take up space, and writing this turns out to be not hard, but not
683 * If this is done, an extension would be to make all ANYOFL nodes contain the
684 * extra 32 bits that ANYOFPOSIXL ones do, doubling each instance's size. The
685 * posix flags only occupy 30 bits, so the ANYOFL_FOLD and
686 * ANYOFL_UTF8_LOCALE_REQD bits could be moved to that extra space, but it
687 * would also mean extra instructions, as there are currently places in the
688 * code that assume those two bits are zero.
690 * Some flags are not used in synthetic start class (SSC) nodes, so could be
691 * shared should new flags be needed for SSCs, like SSC_MATCHES_EMPTY_STRING
694 /* If this is set, the result of the match should be complemented. regexec.c
695 * is expecting this to be in the low bit. Never in an SSC */
696 #define ANYOF_INVERT 0x01
698 /* For the SSC node only, which cannot be inverted, so is shared with that bit.
699 * This is used only during regex compilation. */
700 #define SSC_MATCHES_EMPTY_STRING ANYOF_INVERT
702 /* Set if this is a regnode_charclass_posixl vs a regnode_charclass. This
703 * is used for runtime \d, \w, [:posix:], ..., which are used only in locale
704 * and the optimizer's synthetic start class. Non-locale \d, etc are resolved
705 * at compile-time. Only set under /l; can be in SSC */
706 #define ANYOF_MATCHES_POSIXL 0x02
708 /* The fold is calculated and stored in the bitmap where possible at compile
709 * time. However under locale, the actual folding varies depending on
710 * what the locale is at the time of execution, so it has to be deferred until
711 * then. Only set under /l; never in an SSC */
712 #define ANYOFL_FOLD 0x04
714 /* Warn if the runtime locale isn't a UTF-8 one (and the generated node assumes
716 #define ANYOFL_UTF8_LOCALE_REQD 0x08
718 /* Spare: Be sure to change ANYOF_FLAGS_ALL if this gets used 0x10 */
720 /* Spare: Be sure to change ANYOF_FLAGS_ALL if this gets used 0x20 */
722 /* Shared bit that indicates that there are potential additional matches stored
723 * outside the bitmap, as pointed to by the AV given by the node's argument.
724 * The node type is used at runtime (in conjunction with this flag and other
725 * information available then) to decide if the flag should be acted upon.
726 * This extra information is needed because of at least one of the following
728 * Under /d and the matched string is in UTF-8, it means the ANYOFD node
729 * matches more things than in the bitmap. Those things will be any
730 * code point too high for the bitmap, but crucially, any non-ASCII
731 * characters that match iff when using Unicode rules. These all are
734 * Under /l and ANYOFL_FOLD is set, this flag may indicate there are
735 * potential matches valid only if the locale is a UTF-8 one. If so,
736 * a list of them is stored in the AV.
738 * For any non-ANYOFD node, there may be a user-defined property that
739 * wasn't yet defined at the time the regex was compiled, and so must
740 * be looked up at runtime, The information required to do so will
743 * Note that an ANYOFL node may contain both a user-defined property, and
744 * folds not always valid. The important thing is that there is an AV to
746 #define ANYOF_HAS_EXTRA_RUNTIME_MATCHES 0x40
749 * Under /d it means the ANYOFD node matches all non-ASCII Latin1
750 * characters when the target string is not in utf8.
751 * When not under /d, it means the ANYOF node should raise a warning if
752 * matching against an above-Unicode code point.
753 * (These uses are mutually exclusive because the warning requires a \p{}, and
754 * \p{} implies /u which deselects /d). An SSC node only has this bit set if
755 * what is meant is the warning. The names are to make sure that you are
756 * cautioned about its shared nature */
757 #define ANYOFD_NON_UTF8_MATCHES_ALL_NON_ASCII__shared 0x80
758 #define ANYOF_WARN_SUPER__shared 0x80
760 #define ANYOF_FLAGS_ALL ((U8) ~(0x10|0x20))
762 #define ANYOF_LOCALE_FLAGS ( ANYOFL_FOLD \
763 | ANYOF_MATCHES_POSIXL \
764 | ANYOFL_UTF8_LOCALE_REQD)
766 /* These are the flags that apply to both regular ANYOF nodes and synthetic
767 * start class nodes during construction of the SSC. During finalization of
768 * the SSC, other of the flags may get added to it */
769 #define ANYOF_COMMON_FLAGS 0
771 /* Character classes for node->classflags of ANYOF */
772 /* Should be synchronized with a table in regprop() */
773 /* 2n should be the normal one, paired with its complement at 2n+1 */
775 #define ANYOF_ALPHA ((CC_ALPHA_) * 2)
776 #define ANYOF_NALPHA ((ANYOF_ALPHA) + 1)
777 #define ANYOF_ALPHANUMERIC ((CC_ALPHANUMERIC_) * 2) /* [[:alnum:]] isalnum(3), utf8::IsAlnum */
778 #define ANYOF_NALPHANUMERIC ((ANYOF_ALPHANUMERIC) + 1)
779 #define ANYOF_ASCII ((CC_ASCII_) * 2)
780 #define ANYOF_NASCII ((ANYOF_ASCII) + 1)
781 #define ANYOF_BLANK ((CC_BLANK_) * 2) /* GNU extension: space and tab: non-vertical space */
782 #define ANYOF_NBLANK ((ANYOF_BLANK) + 1)
783 #define ANYOF_CASED ((CC_CASED_) * 2) /* Pseudo class for [:lower:] or
784 [:upper:] under /i */
785 #define ANYOF_NCASED ((ANYOF_CASED) + 1)
786 #define ANYOF_CNTRL ((CC_CNTRL_) * 2)
787 #define ANYOF_NCNTRL ((ANYOF_CNTRL) + 1)
788 #define ANYOF_DIGIT ((CC_DIGIT_) * 2) /* \d */
789 #define ANYOF_NDIGIT ((ANYOF_DIGIT) + 1)
790 #define ANYOF_GRAPH ((CC_GRAPH_) * 2)
791 #define ANYOF_NGRAPH ((ANYOF_GRAPH) + 1)
792 #define ANYOF_LOWER ((CC_LOWER_) * 2)
793 #define ANYOF_NLOWER ((ANYOF_LOWER) + 1)
794 #define ANYOF_PRINT ((CC_PRINT_) * 2)
795 #define ANYOF_NPRINT ((ANYOF_PRINT) + 1)
796 #define ANYOF_PUNCT ((CC_PUNCT_) * 2)
797 #define ANYOF_NPUNCT ((ANYOF_PUNCT) + 1)
798 #define ANYOF_SPACE ((CC_SPACE_) * 2) /* \s */
799 #define ANYOF_NSPACE ((ANYOF_SPACE) + 1)
800 #define ANYOF_UPPER ((CC_UPPER_) * 2)
801 #define ANYOF_NUPPER ((ANYOF_UPPER) + 1)
802 #define ANYOF_WORDCHAR ((CC_WORDCHAR_) * 2) /* \w, PL_utf8_alnum, utf8::IsWord, ALNUM */
803 #define ANYOF_NWORDCHAR ((ANYOF_WORDCHAR) + 1)
804 #define ANYOF_XDIGIT ((CC_XDIGIT_) * 2)
805 #define ANYOF_NXDIGIT ((ANYOF_XDIGIT) + 1)
807 /* pseudo classes below this, not stored in the class bitmap, but used as flags
808 during compilation of char classes */
810 #define ANYOF_VERTWS ((CC_VERTSPACE_) * 2)
811 #define ANYOF_NVERTWS ((ANYOF_VERTWS)+1)
813 /* It is best if this is the last one, as all above it are stored as bits in a
814 * bitmap, and it isn't part of that bitmap */
815 #if CC_VERTSPACE_ != HIGHEST_REGCOMP_DOT_H_SYNC_
816 # error Problem with handy.h HIGHEST_REGCOMP_DOT_H_SYNC_ #define
819 #define ANYOF_POSIXL_MAX (ANYOF_VERTWS) /* So upper loop limit is written:
821 * Hence doesn't include VERTWS, as that
822 * is a pseudo class */
823 #define ANYOF_MAX ANYOF_POSIXL_MAX
825 #if (ANYOF_POSIXL_MAX > 32) /* Must fit in 32-bit word */
826 # error Problem with handy.h CC_foo_ #defines
829 #define ANYOF_HORIZWS ((ANYOF_POSIXL_MAX)+2) /* = (ANYOF_NVERTWS + 1) */
830 #define ANYOF_NHORIZWS ((ANYOF_POSIXL_MAX)+3)
832 #define ANYOF_UNIPROP ((ANYOF_POSIXL_MAX)+4) /* Used to indicate a Unicode
833 property: \p{} or \P{} */
835 /* Backward source code compatibility. */
837 #define ANYOF_ALNUML ANYOF_ALNUM
838 #define ANYOF_NALNUML ANYOF_NALNUM
839 #define ANYOF_SPACEL ANYOF_SPACE
840 #define ANYOF_NSPACEL ANYOF_NSPACE
841 #define ANYOF_ALNUM ANYOF_WORDCHAR
842 #define ANYOF_NALNUM ANYOF_NWORDCHAR
844 /* Utility macros for the bitmap and classes of ANYOF */
846 #define BITMAP_BYTE(p, c) (( (U8*) (p)) [ ( ( (UV) (c)) >> 3) ] )
847 #define BITMAP_BIT(c) (1U << ((c) & 7))
848 #define BITMAP_TEST(p, c) (BITMAP_BYTE(p, c) & BITMAP_BIT((U8)(c)))
850 #define ANYOF_FLAGS(p) ((p)->flags)
852 #define ANYOF_BIT(c) BITMAP_BIT(c)
854 #define ANYOF_POSIXL_BITMAP(p) (((regnode_charclass_posixl*) (p))->classflags)
856 #define POSIXL_SET(field, c) ((field) |= (1U << (c)))
857 #define ANYOF_POSIXL_SET(p, c) POSIXL_SET(ANYOF_POSIXL_BITMAP(p), (c))
859 #define POSIXL_CLEAR(field, c) ((field) &= ~ (1U <<(c)))
860 #define ANYOF_POSIXL_CLEAR(p, c) POSIXL_CLEAR(ANYOF_POSIXL_BITMAP(p), (c))
862 #define POSIXL_TEST(field, c) ((field) & (1U << (c)))
863 #define ANYOF_POSIXL_TEST(p, c) POSIXL_TEST(ANYOF_POSIXL_BITMAP(p), (c))
865 #define POSIXL_ZERO(field) STMT_START { (field) = 0; } STMT_END
866 #define ANYOF_POSIXL_ZERO(ret) POSIXL_ZERO(ANYOF_POSIXL_BITMAP(ret))
868 #define ANYOF_POSIXL_SET_TO_BITMAP(p, bits) \
869 STMT_START { ANYOF_POSIXL_BITMAP(p) = (bits); } STMT_END
871 /* Shifts a bit to get, eg. 0x4000_0000, then subtracts 1 to get 0x3FFF_FFFF */
872 #define ANYOF_POSIXL_SETALL(ret) \
874 ANYOF_POSIXL_BITMAP(ret) = nBIT_MASK(ANYOF_POSIXL_MAX); \
876 #define ANYOF_CLASS_SETALL(ret) ANYOF_POSIXL_SETALL(ret)
878 #define ANYOF_POSIXL_TEST_ANY_SET(p) \
879 ((ANYOF_FLAGS(p) & ANYOF_MATCHES_POSIXL) && ANYOF_POSIXL_BITMAP(p))
880 #define ANYOF_CLASS_TEST_ANY_SET(p) ANYOF_POSIXL_TEST_ANY_SET(p)
882 /* Since an SSC always has this field, we don't have to test for that; nor do
883 * we want to because the bit isn't set for SSC during its construction */
884 #define ANYOF_POSIXL_SSC_TEST_ANY_SET(p) \
885 cBOOL(((regnode_ssc*)(p))->classflags)
886 #define ANYOF_POSIXL_SSC_TEST_ALL_SET(p) /* Are all bits set? */ \
887 (((regnode_ssc*) (p))->classflags \
888 == nBIT_MASK(ANYOF_POSIXL_MAX))
890 #define ANYOF_POSIXL_TEST_ALL_SET(p) \
891 ((ANYOF_FLAGS(p) & ANYOF_MATCHES_POSIXL) \
892 && ANYOF_POSIXL_BITMAP(p) == nBIT_MASK(ANYOF_POSIXL_MAX))
894 #define ANYOF_POSIXL_OR(source, dest) STMT_START { (dest)->classflags |= (source)->classflags ; } STMT_END
895 #define ANYOF_CLASS_OR(source, dest) ANYOF_POSIXL_OR((source), (dest))
897 #define ANYOF_POSIXL_AND(source, dest) STMT_START { (dest)->classflags &= (source)->classflags ; } STMT_END
899 #define ANYOF_BITMAP_ZERO(ret) Zero(((regnode_charclass*)(ret))->bitmap, ANYOF_BITMAP_SIZE, char)
900 #define ANYOF_BITMAP(p) ((regnode_charclass*)(p))->bitmap
901 #define ANYOF_BITMAP_BYTE(p, c) BITMAP_BYTE(ANYOF_BITMAP(p), c)
902 #define ANYOF_BITMAP_SET(p, c) (ANYOF_BITMAP_BYTE(p, c) |= ANYOF_BIT(c))
903 #define ANYOF_BITMAP_CLEAR(p,c) (ANYOF_BITMAP_BYTE(p, c) &= ~ANYOF_BIT(c))
904 #define ANYOF_BITMAP_TEST(p, c) cBOOL(ANYOF_BITMAP_BYTE(p, c) & ANYOF_BIT(c))
906 #define ANYOF_BITMAP_SETALL(p) \
907 memset (ANYOF_BITMAP(p), 255, ANYOF_BITMAP_SIZE)
908 #define ANYOF_BITMAP_CLEARALL(p) \
909 Zero (ANYOF_BITMAP(p), ANYOF_BITMAP_SIZE)
912 * Utility definitions.
915 # define UCHARAT(p) ((int)*(const U8*)(p))
917 # define UCHARAT(p) ((int)*(p)&CHARMASK)
920 /* Number of regnode equivalents that 'guy' occupies beyond the size of the
921 * smallest regnode. */
922 #define EXTRA_SIZE(guy) ((sizeof(guy)-1)/sizeof(struct regnode))
924 #define REG_ZERO_LEN_SEEN 0x00000001
925 #define REG_LOOKBEHIND_SEEN 0x00000002
926 /* add a short form alias to keep the line length police happy */
927 #define REG_LB_SEEN REG_LOOKBEHIND_SEEN
928 #define REG_GPOS_SEEN 0x00000004
930 #define REG_RECURSE_SEEN 0x00000020
931 #define REG_TOP_LEVEL_BRANCHES_SEEN 0x00000040
932 #define REG_VERBARG_SEEN 0x00000080
933 #define REG_CUTGROUP_SEEN 0x00000100
934 #define REG_RUN_ON_COMMENT_SEEN 0x00000200
935 #define REG_UNFOLDED_MULTI_SEEN 0x00000400
937 #define REG_UNBOUNDED_QUANTIFIER_SEEN 0x00001000
942 #ifdef PLUGGABLE_RE_EXTENSION
943 #include "re_nodes.h"
945 #include "regnodes.h"
948 #ifndef PLUGGABLE_RE_EXTENSION
950 EXTCONST regexp_engine PL_core_reg_engine;
952 EXTCONST regexp_engine PL_core_reg_engine = {
955 Perl_re_intuit_start,
956 Perl_re_intuit_string,
957 Perl_regfree_internal,
958 Perl_reg_numbered_buff_fetch,
959 Perl_reg_numbered_buff_store,
960 Perl_reg_numbered_buff_length,
962 Perl_reg_named_buff_iter,
964 #if defined(USE_ITHREADS)
965 Perl_regdupe_internal,
970 #endif /* PLUGGABLE_RE_EXTENSION */
976 /* .what is a character array with one character for each member of .data
977 * The character describes the function of the corresponding .data item:
978 * a - AV for paren_name_list under DEBUGGING
979 * f - start-class data for regstclass optimization
980 * l - start op for literal (?{EVAL}) item
981 * L - start op for literal (?{EVAL}) item, with separate CV (qr//)
982 * r - pointer to an embedded code-containing qr, e.g. /ab$qr/
983 * s - inversion list for Unicode-style character class, and the
984 * multicharacter strings resulting from casefolding the single-character
985 * entries in the character class
987 * u - trie struct's widecharmap (a HV, so can't share, must dup)
988 * also used for revcharmap and words under DEBUGGING
989 * T - aho-trie struct
990 * S - sv for named capture lookup
991 * 20010712 mjd@plover.com
992 * (Remember to update re_dup() and pregfree() if you add any items.)
1000 /* Code in S_to_utf8_substr() and S_to_byte_substr() in regexec.c accesses
1001 anchored* and float* via array indexes 0 and 1. */
1002 #define anchored_substr substrs->data[0].substr
1003 #define anchored_utf8 substrs->data[0].utf8_substr
1004 #define anchored_offset substrs->data[0].min_offset
1005 #define anchored_end_shift substrs->data[0].end_shift
1007 #define float_substr substrs->data[1].substr
1008 #define float_utf8 substrs->data[1].utf8_substr
1009 #define float_min_offset substrs->data[1].min_offset
1010 #define float_max_offset substrs->data[1].max_offset
1011 #define float_end_shift substrs->data[1].end_shift
1013 #define check_substr substrs->data[2].substr
1014 #define check_utf8 substrs->data[2].utf8_substr
1015 #define check_offset_min substrs->data[2].min_offset
1016 #define check_offset_max substrs->data[2].max_offset
1017 #define check_end_shift substrs->data[2].end_shift
1019 #define RX_ANCHORED_SUBSTR(rx) (ReANY(rx)->anchored_substr)
1020 #define RX_ANCHORED_UTF8(rx) (ReANY(rx)->anchored_utf8)
1021 #define RX_FLOAT_SUBSTR(rx) (ReANY(rx)->float_substr)
1022 #define RX_FLOAT_UTF8(rx) (ReANY(rx)->float_utf8)
1024 /* trie related stuff */
1026 /* a transition record for the state machine. the
1027 check field determines which state "owns" the
1028 transition. the char the transition is for is
1029 determined by offset from the owning states base
1030 field. the next field determines which state
1031 is to be transitioned to if any.
1033 struct _reg_trie_trans {
1038 /* a transition list element for the list based representation */
1039 struct _reg_trie_trans_list_elem {
1043 typedef struct _reg_trie_trans_list_elem reg_trie_trans_le;
1045 /* a state for compressed nodes. base is an offset
1046 into an array of reg_trie_trans array. If wordnum is
1047 nonzero the state is accepting. if base is zero then
1048 the state has no children (and will be accepting)
1050 struct _reg_trie_state {
1054 reg_trie_trans_le* list;
1058 /* info per word; indexed by wordnum */
1060 U16 prev; /* previous word in acceptance chain; eg in
1061 * zzz|abc|ab/ after matching the chars abc, the
1062 * accepted word is #2, and the previous accepted
1064 U32 len; /* how many chars long is this word? */
1065 U32 accept; /* accept state for this word */
1066 } reg_trie_wordinfo;
1069 typedef struct _reg_trie_state reg_trie_state;
1070 typedef struct _reg_trie_trans reg_trie_trans;
1073 /* anything in here that needs to be freed later
1074 should be dealt with in pregfree.
1075 refcount is first in both this and _reg_ac_data to allow a space
1076 optimisation in Perl_regdupe. */
1077 struct _reg_trie_data {
1078 U32 refcount; /* number of times this trie is referenced */
1079 U32 lasttrans; /* last valid transition element */
1080 U16 *charmap; /* byte to charid lookup array */
1081 reg_trie_state *states; /* state data */
1082 reg_trie_trans *trans; /* array of transition elements */
1083 char *bitmap; /* stclass bitmap */
1084 U16 *jump; /* optional 1 indexed array of offsets before tail
1085 for the node following a given word. */
1086 reg_trie_wordinfo *wordinfo; /* array of info per word */
1087 U16 uniquecharcount; /* unique chars in trie (width of trans table) */
1088 U32 startstate; /* initial state - used for common prefix optimisation */
1089 STRLEN minlen; /* minimum length of words in trie - build/opt only? */
1090 STRLEN maxlen; /* maximum length of words in trie - build/opt only? */
1091 U32 prefixlen; /* #chars in common prefix */
1092 U32 statecount; /* Build only - number of states in the states array
1093 (including the unused zero state) */
1094 U32 wordcount; /* Build only */
1096 STRLEN charcount; /* Build only */
1099 /* There is one (3 under DEBUGGING) pointers that logically belong in this
1100 structure, but are held outside as they need duplication on thread cloning,
1101 whereas the rest of the structure can be read only:
1102 HV *widecharmap; code points > 255 to charid
1104 AV *words; Array of words contained in trie, for dumping
1105 AV *revcharmap; Map of each charid back to its character representation
1109 #define TRIE_WORDS_OFFSET 2
1111 typedef struct _reg_trie_data reg_trie_data;
1113 /* refcount is first in both this and _reg_trie_data to allow a space
1114 optimisation in Perl_regdupe. */
1115 struct _reg_ac_data {
1119 reg_trie_state *states;
1121 typedef struct _reg_ac_data reg_ac_data;
1123 /* ANY_BIT doesn't use the structure, so we can borrow it here.
1124 This is simpler than refactoring all of it as wed end up with
1125 three different sets... */
1127 #define TRIE_BITMAP(p) (((reg_trie_data *)(p))->bitmap)
1128 #define TRIE_BITMAP_BYTE(p, c) BITMAP_BYTE(TRIE_BITMAP(p), c)
1129 #define TRIE_BITMAP_SET(p, c) (TRIE_BITMAP_BYTE(p, c) |= ANYOF_BIT((U8)c))
1130 #define TRIE_BITMAP_CLEAR(p,c) (TRIE_BITMAP_BYTE(p, c) &= ~ANYOF_BIT((U8)c))
1131 #define TRIE_BITMAP_TEST(p, c) (TRIE_BITMAP_BYTE(p, c) & ANYOF_BIT((U8)c))
1133 #define IS_ANYOF_TRIE(op) ((op)==TRIEC || (op)==AHOCORASICKC)
1134 #define IS_TRIE_AC(op) ((op)>=AHOCORASICK)
1136 /* these defines assume uniquecharcount is the correct variable, and state may be evaluated twice */
1137 #define TRIE_NODENUM(state) (((state)-1)/(trie->uniquecharcount)+1)
1138 #define SAFE_TRIE_NODENUM(state) ((state) ? (((state)-1)/(trie->uniquecharcount)+1) : (state))
1139 #define TRIE_NODEIDX(state) ((state) ? (((state)-1)*(trie->uniquecharcount)+1) : (state))
1142 #define TRIE_CHARCOUNT(trie) ((trie)->charcount)
1144 #define TRIE_CHARCOUNT(trie) (trie_charcount)
1147 #define RE_TRIE_MAXBUF_INIT 65536
1148 #define RE_TRIE_MAXBUF_NAME "\022E_TRIE_MAXBUF"
1149 #define RE_DEBUG_FLAGS "\022E_DEBUG_FLAGS"
1151 #define RE_COMPILE_RECURSION_INIT 1000
1152 #define RE_COMPILE_RECURSION_LIMIT "\022E_COMPILE_RECURSION_LIMIT"
1156 RE_DEBUG_FLAGS is used to control what debug output is emitted
1157 its divided into three groups of options, some of which interact.
1158 The three groups are: Compile, Execute, Extra. There is room for a
1159 further group, as currently only the low three bytes are used.
1178 If you modify any of these make sure you make corresponding changes to
1179 re.pm, especially to the documentation.
1185 #define RE_DEBUG_COMPILE_MASK 0x0000FF
1186 #define RE_DEBUG_COMPILE_PARSE 0x000001
1187 #define RE_DEBUG_COMPILE_OPTIMISE 0x000002
1188 #define RE_DEBUG_COMPILE_TRIE 0x000004
1189 #define RE_DEBUG_COMPILE_DUMP 0x000008
1190 #define RE_DEBUG_COMPILE_FLAGS 0x000010
1191 #define RE_DEBUG_COMPILE_TEST 0x000020
1194 #define RE_DEBUG_EXECUTE_MASK 0x00FF00
1195 #define RE_DEBUG_EXECUTE_INTUIT 0x000100
1196 #define RE_DEBUG_EXECUTE_MATCH 0x000200
1197 #define RE_DEBUG_EXECUTE_TRIE 0x000400
1200 #define RE_DEBUG_EXTRA_MASK 0x3FF0000
1201 #define RE_DEBUG_EXTRA_TRIE 0x0010000
1202 #define RE_DEBUG_EXTRA_STATE 0x0080000
1203 #define RE_DEBUG_EXTRA_OPTIMISE 0x0100000
1204 #define RE_DEBUG_EXTRA_BUFFERS 0x0400000
1205 #define RE_DEBUG_EXTRA_GPOS 0x0800000
1206 #define RE_DEBUG_EXTRA_DUMP_PRE_OPTIMIZE 0x1000000
1207 #define RE_DEBUG_EXTRA_WILDCARD 0x2000000
1209 #define RE_DEBUG_EXTRA_STACK 0x0280000
1211 #define RE_DEBUG_FLAG(x) (re_debug_flags & (x))
1213 #define DEBUG_COMPILE_r(x) DEBUG_r( \
1214 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_COMPILE_MASK)) x )
1215 #define DEBUG_PARSE_r(x) DEBUG_r( \
1216 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_COMPILE_PARSE)) x )
1217 #define DEBUG_OPTIMISE_r(x) DEBUG_r( \
1218 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_COMPILE_OPTIMISE)) x )
1219 #define DEBUG_DUMP_r(x) DEBUG_r( \
1220 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_COMPILE_DUMP)) x )
1221 #define DEBUG_TRIE_COMPILE_r(x) DEBUG_r( \
1222 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_COMPILE_TRIE)) x )
1223 #define DEBUG_FLAGS_r(x) DEBUG_r( \
1224 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_COMPILE_FLAGS)) x )
1225 #define DEBUG_TEST_r(x) DEBUG_r( \
1226 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_COMPILE_TEST)) x )
1228 #define DEBUG_EXECUTE_r(x) DEBUG_r( \
1229 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_EXECUTE_MASK)) x )
1230 #define DEBUG_INTUIT_r(x) DEBUG_r( \
1231 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_EXECUTE_INTUIT)) x )
1232 #define DEBUG_MATCH_r(x) DEBUG_r( \
1233 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_EXECUTE_MATCH)) x )
1234 #define DEBUG_TRIE_EXECUTE_r(x) DEBUG_r( \
1235 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_EXECUTE_TRIE)) x )
1238 #define DEBUG_EXTRA_r(x) DEBUG_r( \
1239 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_EXTRA_MASK)) x )
1240 #define DEBUG_STATE_r(x) DEBUG_r( \
1241 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_EXTRA_STATE)) x )
1242 #define DEBUG_STACK_r(x) DEBUG_r( \
1243 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_EXTRA_STACK)) x )
1244 #define DEBUG_BUFFERS_r(x) DEBUG_r( \
1245 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_EXTRA_BUFFERS)) x )
1247 #define DEBUG_OPTIMISE_MORE_r(x) DEBUG_r( \
1248 if (DEBUG_v_TEST || ((RE_DEBUG_EXTRA_OPTIMISE|RE_DEBUG_COMPILE_OPTIMISE) == \
1249 RE_DEBUG_FLAG(RE_DEBUG_EXTRA_OPTIMISE|RE_DEBUG_COMPILE_OPTIMISE))) x )
1250 #define DEBUG_TRIE_COMPILE_MORE_r(x) DEBUG_TRIE_COMPILE_r( \
1251 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_EXTRA_TRIE)) x )
1252 #define DEBUG_TRIE_EXECUTE_MORE_r(x) DEBUG_TRIE_EXECUTE_r( \
1253 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_EXTRA_TRIE)) x )
1255 #define DEBUG_TRIE_r(x) DEBUG_r( \
1256 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_COMPILE_TRIE \
1257 | RE_DEBUG_EXECUTE_TRIE )) x )
1258 #define DEBUG_GPOS_r(x) DEBUG_r( \
1259 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_EXTRA_GPOS)) x )
1261 #define DEBUG_DUMP_PRE_OPTIMIZE_r(x) DEBUG_r( \
1262 if (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_EXTRA_DUMP_PRE_OPTIMIZE)) x )
1264 /* initialization */
1265 /* Get the debug flags for code not in regcomp.c nor regexec.c. This doesn't
1266 * initialize the variable if it isn't already there, instead it just assumes
1267 * the flags are 0 */
1268 #define DECLARE_AND_GET_RE_DEBUG_FLAGS_NON_REGEX \
1269 volatile IV re_debug_flags = 0; PERL_UNUSED_VAR(re_debug_flags); \
1271 SV * re_debug_flags_sv = NULL; \
1272 /* get_sv() can return NULL during global destruction. */ \
1273 re_debug_flags_sv = PL_curcop ? get_sv(RE_DEBUG_FLAGS, GV_ADD) : NULL; \
1274 if (re_debug_flags_sv && SvIOK(re_debug_flags_sv)) \
1275 re_debug_flags=SvIV(re_debug_flags_sv); \
1281 /* For use in regcomp.c and regexec.c, Get the debug flags, and initialize to
1282 * the defaults if not done already */
1283 #define DECLARE_AND_GET_RE_DEBUG_FLAGS \
1284 volatile IV re_debug_flags = 0; PERL_UNUSED_VAR(re_debug_flags); \
1286 SV * re_debug_flags_sv = NULL; \
1287 /* get_sv() can return NULL during global destruction. */ \
1288 re_debug_flags_sv = PL_curcop ? get_sv(RE_DEBUG_FLAGS, GV_ADD) : NULL; \
1289 if (re_debug_flags_sv) { \
1290 if (!SvIOK(re_debug_flags_sv)) /* If doesnt exist set to default */\
1291 sv_setuv(re_debug_flags_sv, \
1292 /* These defaults should be kept in sync with re.pm */ \
1293 RE_DEBUG_COMPILE_DUMP | RE_DEBUG_EXECUTE_MASK ); \
1294 re_debug_flags=SvIV(re_debug_flags_sv); \
1298 #define isDEBUG_WILDCARD (DEBUG_v_TEST || RE_DEBUG_FLAG(RE_DEBUG_EXTRA_WILDCARD))
1300 #define RE_PV_COLOR_DECL(rpv,rlen,isuni,dsv,pv,l,m,c1,c2) \
1301 const char * const rpv = \
1302 pv_pretty((dsv), (pv), (l), (m), \
1303 PL_colors[(c1)],PL_colors[(c2)], \
1304 PERL_PV_ESCAPE_RE|PERL_PV_ESCAPE_NONASCII |((isuni) ? PERL_PV_ESCAPE_UNI : 0) ); \
1305 const int rlen = SvCUR(dsv)
1307 /* This is currently unsed in the core */
1308 #define RE_SV_ESCAPE(rpv,isuni,dsv,sv,m) \
1309 const char * const rpv = \
1310 pv_pretty((dsv), (SvPV_nolen_const(sv)), (SvCUR(sv)), (m), \
1311 PL_colors[(c1)],PL_colors[(c2)], \
1312 PERL_PV_ESCAPE_RE|PERL_PV_ESCAPE_NONASCII |((isuni) ? PERL_PV_ESCAPE_UNI : 0) )
1314 #define RE_PV_QUOTED_DECL(rpv,isuni,dsv,pv,l,m) \
1315 const char * const rpv = \
1316 pv_pretty((dsv), (pv), (l), (m), \
1317 PL_colors[0], PL_colors[1], \
1318 ( PERL_PV_PRETTY_QUOTE | PERL_PV_ESCAPE_RE | PERL_PV_ESCAPE_NONASCII | PERL_PV_PRETTY_ELLIPSES | \
1319 ((isuni) ? PERL_PV_ESCAPE_UNI : 0)) \
1322 #define RE_SV_DUMPLEN(ItEm) (SvCUR(ItEm) - (SvTAIL(ItEm)!=0))
1323 #define RE_SV_TAIL(ItEm) (SvTAIL(ItEm) ? "$" : "")
1325 #else /* if not DEBUGGING */
1327 #define DECLARE_AND_GET_RE_DEBUG_FLAGS dNOOP
1328 #define RE_PV_COLOR_DECL(rpv,rlen,isuni,dsv,pv,l,m,c1,c2) dNOOP
1329 #define RE_SV_ESCAPE(rpv,isuni,dsv,sv,m)
1330 #define RE_PV_QUOTED_DECL(rpv,isuni,dsv,pv,l,m) dNOOP
1331 #define RE_SV_DUMPLEN(ItEm)
1332 #define RE_SV_TAIL(ItEm)
1333 #define isDEBUG_WILDCARD 0
1335 #endif /* DEBUG RELATED DEFINES */
1337 #define FIRST_NON_ASCII_DECIMAL_DIGIT 0x660 /* ARABIC_INDIC_DIGIT_ZERO */
1340 TRADITIONAL_BOUND = CC_WORDCHAR_,
1347 /* This unpacks the FLAGS field of ANYOF[HR]x nodes. The value it contains
1348 * gives the strict lower bound for the UTF-8 start byte of any code point
1349 * matchable by the node, and a loose upper bound as well.
1351 * The low bound is stored as 0xC0 + ((the upper 6 bits) >> 2)
1352 * The loose upper bound is determined from the lowest 2 bits and the low bound
1353 * (called x) as follows:
1355 * 11 The upper limit of the range can be as much as (EF - x) / 8
1356 * 10 The upper limit of the range can be as much as (EF - x) / 4
1357 * 01 The upper limit of the range can be as much as (EF - x) / 2
1358 * 00 The upper limit of the range can be as much as EF
1360 * For motivation of this design, see commit message in
1361 * 3146c00a633e9cbed741e10146662fbcedfdb8d3 */
1363 # define MAX_ANYOF_HRx_BYTE 0xF4
1365 # define MAX_ANYOF_HRx_BYTE 0xEF
1367 #define LOWEST_ANYOF_HRx_BYTE(b) (((b) >> 2) + 0xC0)
1368 #define HIGHEST_ANYOF_HRx_BYTE(b) \
1369 (LOWEST_ANYOF_HRx_BYTE(b) \
1370 + ((MAX_ANYOF_HRx_BYTE - LOWEST_ANYOF_HRx_BYTE(b)) >> ((b) & 3)))
1372 #if !defined(PERL_IN_XSUB_RE) || defined(PLUGGABLE_RE_EXTENSION)
1373 # define GET_REGCLASS_AUX_DATA(a,b,c,d,e,f) get_regclass_aux_data(a,b,c,d,e,f)
1375 # define GET_REGCLASS_AUX_DATA(a,b,c,d,e,f) get_re_gclass_aux_data(a,b,c,d,e,f)
1378 #endif /* PERL_REGCOMP_H_ */
1381 * ex: set ts=8 sts=4 sw=4 et: