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.
10 #include "regcharclass.h"
12 /* Convert branch sequences to more efficient trie ops? */
13 #define PERL_ENABLE_TRIE_OPTIMISATION 1
15 /* Be really aggressive about optimising patterns with trie sequences? */
16 #define PERL_ENABLE_EXTENDED_TRIE_OPTIMISATION 1
18 /* Should the optimiser take positive assertions into account? */
19 #define PERL_ENABLE_POSITIVE_ASSERTION_STUDY 0
21 /* Not for production use: */
22 #define PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS 0
24 /* Activate offsets code - set to if 1 to enable */
26 #define RE_TRACK_PATTERN_OFFSETS
29 /* Unless the next line is uncommented it is illegal to combine lazy
30 matching with possessive matching. Frankly it doesn't make much sense
31 to allow it as X*?+ matches nothing, X+?+ matches a single char only,
32 and X{min,max}?+ matches min times only.
34 /* #define REG_ALLOW_MINMOD_SUSPEND */
37 * The "internal use only" fields in regexp.h are present to pass info from
38 * compile to execute that permits the execute phase to run lots faster on
39 * simple cases. They are:
41 * regstart sv that must begin a match; NULL if none obvious
42 * reganch is the match anchored (at beginning-of-line only)?
43 * regmust string (pointer into program) that match must include, or NULL
44 * [regmust changed to SV* for bminstr()--law]
45 * regmlen length of regmust string
46 * [regmlen not used currently]
48 * Regstart and reganch permit very fast decisions on suitable starting points
49 * for a match, cutting down the work a lot. Regmust permits fast rejection
50 * of lines that cannot possibly match. The regmust tests are costly enough
51 * that pregcomp() supplies a regmust only if the r.e. contains something
52 * potentially expensive (at present, the only such thing detected is * or +
53 * at the start of the r.e., which can involve a lot of backup). Regmlen is
54 * supplied because the test in pregexec() needs it and pregcomp() is computing
56 * [regmust is now supplied always. The tests that use regmust have a
57 * heuristic that disables the test if it usually matches.]
59 * [In fact, we now use regmust in many cases to locate where the search
60 * starts in the string, so if regback is >= 0, the regmust search is never
61 * wasted effort. The regback variable says how many characters back from
62 * where regmust matched is the earliest possible start of the match.
63 * For instance, /[a-z].foo/ has a regmust of 'foo' and a regback of 2.]
67 * Structure for regexp "program". This is essentially a linear encoding
68 * of a nondeterministic finite-state machine (aka syntax charts or
69 * "railroad normal form" in parsing technology). Each node is an opcode
70 * plus a "next" pointer, possibly plus an operand. "Next" pointers of
71 * all nodes except BRANCH implement concatenation; a "next" pointer with
72 * a BRANCH on both ends of it is connecting two alternatives. (Here we
73 * have one of the subtle syntax dependencies: an individual BRANCH (as
74 * opposed to a collection of them) is never concatenated with anything
75 * because of operator precedence.) The operand of some types of node is
76 * a literal string; for others, it is a node leading into a sub-FSM. In
77 * particular, the operand of a BRANCH node is the first node of the branch.
78 * (NB this is *not* a tree structure: the tail of the branch connects
79 * to the thing following the set of BRANCHes.) The opcodes are defined
80 * in regnodes.h which is generated from regcomp.sym by regcomp.pl.
84 * A node is one char of opcode followed by two chars of "next" pointer.
85 * "Next" pointers are stored as two 8-bit pieces, high order first. The
86 * value is a positive offset from the opcode of the node containing it.
87 * An operand, if any, simply follows the node. (Note that much of the
88 * code generation knows about this implicit relationship.)
90 * Using two bytes for the "next" pointer is vast overkill for most things,
91 * but allows patterns to get big without disasters.
93 * [The "next" pointer is always aligned on an even
94 * boundary, and reads the offset directly as a short. Also, there is no
95 * special test to reverse the sign of BACK pointers since the offset is
99 /* This is the stuff that used to live in regexp.h that was truly
100 private to the engine itself. It now lives here. */
104 typedef struct regexp_internal {
105 int name_list_idx; /* Optional data index of an array of paren names */
107 U32 *offsets; /* offset annotations 20001228 MJD
108 data about mapping the program to the
110 offsets[0] is proglen when this is used
115 regnode *regstclass; /* Optional startclass as identified or constructed
117 struct reg_data *data; /* Additional miscellaneous data used by the program.
118 Used to make it easier to clone and free arbitrary
119 data that the regops need. Often the ARG field of
120 a regop is an index into this structure */
121 struct reg_code_block *code_blocks;/* positions of literal (?{}) */
122 int num_code_blocks; /* size of code_blocks[] */
123 regnode program[1]; /* Unwarranted chumminess with compiler. */
126 #define RXi_SET(x,y) (x)->pprivate = (void*)(y)
127 #define RXi_GET(x) ((regexp_internal *)((x)->pprivate))
128 #define RXi_GET_DECL(r,ri) regexp_internal *ri = RXi_GET(r)
130 * Flags stored in regexp->intflags
131 * These are used only internally to the regexp engine
133 * See regexp.h for flags used externally to the regexp engine
135 #define PREGf_SKIP 0x00000001
136 #define PREGf_IMPLICIT 0x00000002 /* Converted .* to ^.* */
137 #define PREGf_NAUGHTY 0x00000004 /* how exponential is this pattern? */
138 #define PREGf_VERBARG_SEEN 0x00000008
139 #define PREGf_CUTGROUP_SEEN 0x00000010
140 #define PREGf_USE_RE_EVAL 0x00000020 /* compiled with "use re 'eval'" */
143 /* this is where the old regcomp.h started */
145 struct regnode_string {
152 /* Argument bearing node - workhorse,
153 arg1 is often for the data field */
161 /* Similar to a regnode_1 but with an extra signed argument */
170 /* 'Two field' -- Two 16 bit unsigned args */
180 #define ANYOF_BITMAP_SIZE 32 /* 256 b/(8 b/B) */
181 #define ANYOF_CLASSBITMAP_SIZE 4 /* up to 32 (8*4) named classes */
183 /* also used by trie */
184 struct regnode_charclass {
188 U32 arg1; /* used as ptr in S_regclass */
189 char bitmap[ANYOF_BITMAP_SIZE]; /* only compile-time */
192 /* has runtime (locale) \d, \w, ..., [:posix:] classes */
193 struct regnode_charclass_class {
194 U8 flags; /* ANYOF_CLASS bit must go here */
197 U32 arg1; /* used as ptr in S_regclass */
198 char bitmap[ANYOF_BITMAP_SIZE]; /* both compile-time */
199 char classflags[ANYOF_CLASSBITMAP_SIZE]; /* and run-time */
202 /* XXX fix this description.
203 Impose a limit of REG_INFTY on various pattern matching operations
204 to limit stack growth and to avoid "infinite" recursions.
206 /* The default size for REG_INFTY is I16_MAX, which is the same as
207 SHORT_MAX (see perl.h). Unfortunately I16 isn't necessarily 16 bits
208 (see handy.h). On the Cray C90, sizeof(short)==4 and hence I16_MAX is
209 ((1<<31)-1), while on the Cray T90, sizeof(short)==8 and I16_MAX is
210 ((1<<63)-1). To limit stack growth to reasonable sizes, supply a
212 --Andy Dougherty 11 June 1998
216 # define REG_INFTY ((1<<15)-1)
221 # define REG_INFTY I16_MAX
224 #define ARG_VALUE(arg) (arg)
225 #define ARG__SET(arg,val) ((arg) = (val))
231 #define ARG(p) ARG_VALUE(ARG_LOC(p))
232 #define ARG1(p) ARG_VALUE(ARG1_LOC(p))
233 #define ARG2(p) ARG_VALUE(ARG2_LOC(p))
234 #define ARG2L(p) ARG_VALUE(ARG2L_LOC(p))
236 #define ARG_SET(p, val) ARG__SET(ARG_LOC(p), (val))
237 #define ARG1_SET(p, val) ARG__SET(ARG1_LOC(p), (val))
238 #define ARG2_SET(p, val) ARG__SET(ARG2_LOC(p), (val))
239 #define ARG2L_SET(p, val) ARG__SET(ARG2L_LOC(p), (val))
244 #define NEXT_OFF(p) ((p)->next_off)
245 #define NODE_ALIGN(node)
246 #define NODE_ALIGN_FILL(node) ((node)->flags = 0xde) /* deadbeef */
248 #define SIZE_ALIGN NODE_ALIGN
255 #define OP(p) ((p)->type)
256 #define FLAGS(p) ((p)->flags) /* Caution: Doesn't apply to all \
257 regnode types. For some, it's the \
258 character set of the regnode */
259 #define OPERAND(p) (((struct regnode_string *)p)->string)
260 #define MASK(p) ((char*)OPERAND(p))
261 #define STR_LEN(p) (((struct regnode_string *)p)->str_len)
262 #define STRING(p) (((struct regnode_string *)p)->string)
263 #define STR_SZ(l) ((l + sizeof(regnode) - 1) / sizeof(regnode))
264 #define NODE_SZ_STR(p) (STR_SZ(STR_LEN(p))+1)
271 #define NODE_ALIGN(node)
272 #define ARG_LOC(p) (((struct regnode_1 *)p)->arg1)
273 #define ARG1_LOC(p) (((struct regnode_2 *)p)->arg1)
274 #define ARG2_LOC(p) (((struct regnode_2 *)p)->arg2)
275 #define ARG2L_LOC(p) (((struct regnode_2L *)p)->arg2)
277 #define NODE_STEP_REGNODE 1 /* sizeof(regnode)/sizeof(regnode) */
278 #define EXTRA_STEP_2ARGS EXTRA_SIZE(struct regnode_2)
280 #define NODE_STEP_B 4
282 #define NEXTOPER(p) ((p) + NODE_STEP_REGNODE)
283 #define PREVOPER(p) ((p) - NODE_STEP_REGNODE)
285 #define FILL_ADVANCE_NODE(ptr, op) STMT_START { \
286 (ptr)->type = op; (ptr)->next_off = 0; (ptr)++; } STMT_END
287 #define FILL_ADVANCE_NODE_ARG(ptr, op, arg) STMT_START { \
288 ARG_SET(ptr, arg); FILL_ADVANCE_NODE(ptr, op); (ptr) += 1; } STMT_END
290 #define REG_MAGIC 0234
292 #define SIZE_ONLY (RExC_emit == &PL_regdummy)
294 /* If the bitmap doesn't fully represent what this ANYOF node can match, the
295 * ARG is set to this special value (since 0, 1, ... are legal, but will never
296 * reach this high). */
297 #define ANYOF_NONBITMAP_EMPTY ((U32) -1)
299 /* The information used to be stored as as combination of the ANYOF_UTF8 and
300 * ANYOF_NONBITMAP_NON_UTF8 bits in the flags field, but was moved out of there
301 * to free up a bit for other uses. This tries to hide the change from
302 * existing code as much as possible. Now, the data structure that goes in ARG
303 * is not allocated unless it is needed, and that is what is used to determine
304 * if there is something outside the bitmap. The code now assumes that if
305 * that structure exists, that any UTF-8 encoded string should be tried against
306 * it, but a non-UTF8-encoded string will be tried only if the
307 * ANYOF_NONBITMAP_NON_UTF8 bit is also set. */
308 #define ANYOF_NONBITMAP(node) (ARG(node) != ANYOF_NONBITMAP_EMPTY)
310 /* Flags for node->flags of ANYOF. These are in short supply, so some games
311 * are done to share them, as described below. Already, the ANYOF_LOCALE and
312 * ANYOF_CLASS bits are shared, making a space penalty for all locale nodes.
313 * An option would be to push them into new nodes. E.g. there could be an
314 * ANYOF_LOCALE node that would be in place of the flag of the same name. But
315 * there are better options. The UNICODE_ALL bit could be freed up by
316 * resorting to creating a swash containing everything above 255. This
317 * introduces a performance penalty. Better would be to split it off into a
318 * separate node, which actually would improve performance by allowing adding a
319 * case statement to regexec.c use the bit map for code points under 256, and
320 * to match everything above. If flags need to be added that are applicable to
321 * the synthetic start class only, with some work, they could be put in the
322 * next-node field, or in an unused bit of the classflags field. This could be
323 * done with the current EOS flag, and a new node type created that is just for
324 * the scc, freeing up that bit */
326 #define ANYOF_LOCALE 0x01 /* /l modifier */
328 /* The fold is calculated and stored in the bitmap where possible at compile
329 * time. However there are two cases where it isn't possible. These share
330 * this bit: 1) under locale, where the actual folding varies depending on
331 * what the locale is at the time of execution; and 2) where the folding is
332 * specified in a swash, not the bitmap, such as characters which aren't
333 * specified in the bitmap, or properties that aren't looked at at compile time
335 #define ANYOF_LOC_NONBITMAP_FOLD 0x02
337 #define ANYOF_INVERT 0x04
339 /* Set if this is a struct regnode_charclass_class vs a regnode_charclass. This
340 * is used for runtime \d, \w, [:posix:], ..., which are used only in locale
341 * and the optimizer's synthetic start class. Non-locale \d, etc are resolved
342 * at compile-time. Now shared with ANYOF_LOCALE, forcing all locale nodes to
344 #define ANYOF_CLASS ANYOF_LOCALE
345 #define ANYOF_LARGE ANYOF_CLASS /* Same; name retained for back compat */
347 /* Should this character class warn if matched against a character above
349 #define ANYOF_WARN_SUPER 0x08
351 /* EOS, meaning that it can match an empty string too, is used for the
352 * synthetic start class only. */
353 #define ANYOF_EOS 0x10
355 /* ? Is this node the synthetic start class (ssc). This bit is shared with
356 * ANYOF_EOS, as the latter is used only for the ssc, and then not used by
357 * regexec.c. And, the code is structured so that if it is set, the ssc is
358 * not used, so it is guaranteed to be 0 for the ssc by the time regexec.c
359 * gets executed, and 0 for a non-ssc ANYOF node, as it only ever gets set for
360 * a potential ssc candidate. Thus setting it to 1 after it has been
361 * determined that the ssc will be used is not ambiguous */
362 #define ANYOF_IS_SYNTHETIC ANYOF_EOS
364 /* Can match something outside the bitmap that isn't in utf8 */
365 #define ANYOF_NONBITMAP_NON_UTF8 0x20
367 /* Matches every code point 0x100 and above*/
368 #define ANYOF_UNICODE_ALL 0x40
370 /* Match all Latin1 characters that aren't ASCII when the target string is not
372 #define ANYOF_NON_UTF8_LATIN1_ALL 0x80
374 #define ANYOF_FLAGS_ALL 0xff
376 /* These are the flags that ANYOF_INVERT being set or not doesn't affect
377 * whether they are operative or not. e.g., the node still has LOCALE
378 * regardless of being inverted; whereas ANYOF_UNICODE_ALL means something
379 * different if inverted */
380 #define INVERSION_UNAFFECTED_FLAGS (ANYOF_LOCALE \
381 |ANYOF_LOC_NONBITMAP_FOLD \
384 |ANYOF_NONBITMAP_NON_UTF8)
386 /* Character classes for node->classflags of ANYOF */
387 /* Should be synchronized with a table in regprop() */
388 /* 2n should be the normal one, paired with its complement at 2n+1 */
390 #define ANYOF_WORDCHAR ((_CC_WORDCHAR) * 2) /* \w, PL_utf8_alnum, utf8::IsWord, ALNUM */
391 #define ANYOF_NWORDCHAR ((ANYOF_WORDCHAR) + 1)
392 #define ANYOF_SPACE ((_CC_SPACE) * 2) /* \s */
393 #define ANYOF_NSPACE ((ANYOF_SPACE) + 1)
394 #define ANYOF_DIGIT ((_CC_DIGIT) * 2) /* \d */
395 #define ANYOF_NDIGIT ((ANYOF_DIGIT) + 1)
396 #define ANYOF_ALNUMC ((_CC_ALNUMC) * 2) /* [[:alnum:]] isalnum(3), utf8::IsAlnum, ALNUMC */
397 #define ANYOF_NALNUMC ((ANYOF_ALNUMC) + 1)
398 #define ANYOF_ALPHA ((_CC_ALPHA) * 2)
399 #define ANYOF_NALPHA ((ANYOF_ALPHA) + 1)
400 #define ANYOF_ASCII ((_CC_ASCII) * 2)
401 #define ANYOF_NASCII ((ANYOF_ASCII) + 1)
402 #define ANYOF_CNTRL ((_CC_CNTRL) * 2)
403 #define ANYOF_NCNTRL ((ANYOF_CNTRL) + 1)
404 #define ANYOF_GRAPH ((_CC_GRAPH) * 2)
405 #define ANYOF_NGRAPH ((ANYOF_GRAPH) + 1)
406 #define ANYOF_LOWER ((_CC_LOWER) * 2)
407 #define ANYOF_NLOWER ((ANYOF_LOWER) + 1)
408 #define ANYOF_PRINT ((_CC_PRINT) * 2)
409 #define ANYOF_NPRINT ((ANYOF_PRINT) + 1)
410 #define ANYOF_PUNCT ((_CC_PUNCT) * 2)
411 #define ANYOF_NPUNCT ((ANYOF_PUNCT) + 1)
412 #define ANYOF_UPPER ((_CC_UPPER) * 2)
413 #define ANYOF_NUPPER ((ANYOF_UPPER) + 1)
414 #define ANYOF_XDIGIT ((_CC_XDIGIT) * 2)
415 #define ANYOF_NXDIGIT ((ANYOF_XDIGIT) + 1)
416 #define ANYOF_PSXSPC ((_CC_PSXSPC) * 2) /* POSIX space: \s plus the vertical tab */
417 #define ANYOF_NPSXSPC ((ANYOF_PSXSPC) + 1)
418 #define ANYOF_BLANK ((_CC_BLANK) * 2) /* GNU extension: space and tab: non-vertical space */
419 #define ANYOF_NBLANK ((ANYOF_BLANK) + 1)
422 #if (ANYOF_MAX <= _HIGHEST_REGCOMP_DOT_H_SYNC * 2 + 1)
423 # error Problem with handy.h _CC_foo #defines
426 /* pseudo classes, not stored in the class bitmap, but used as flags
427 during compilation of char classes */
429 #define ANYOF_VERTWS (ANYOF_MAX+1)
430 #define ANYOF_NVERTWS (ANYOF_MAX+2)
431 #define ANYOF_HORIZWS (ANYOF_MAX+3)
432 #define ANYOF_NHORIZWS (ANYOF_MAX+4)
434 /* Backward source code compatibility. */
436 #define ANYOF_ALNUML ANYOF_ALNUM
437 #define ANYOF_NALNUML ANYOF_NALNUM
438 #define ANYOF_SPACEL ANYOF_SPACE
439 #define ANYOF_NSPACEL ANYOF_NSPACE
440 #define ANYOF_ALNUM ANYOF_WORDCHAR
441 #define ANYOF_NALNUM ANYOF_NWORDCHAR
443 /* Utility macros for the bitmap and classes of ANYOF */
445 #define ANYOF_SIZE (sizeof(struct regnode_charclass))
446 #define ANYOF_CLASS_SIZE (sizeof(struct regnode_charclass_class))
448 #define ANYOF_FLAGS(p) ((p)->flags)
450 #define ANYOF_BIT(c) (1 << ((c) & 7))
452 #define ANYOF_CLASS_BYTE(p, c) (((struct regnode_charclass_class*)(p))->classflags[((c) >> 3) & 3])
453 #define ANYOF_CLASS_SET(p, c) (ANYOF_CLASS_BYTE(p, c) |= ANYOF_BIT(c))
454 #define ANYOF_CLASS_CLEAR(p, c) (ANYOF_CLASS_BYTE(p, c) &= ~ANYOF_BIT(c))
455 #define ANYOF_CLASS_TEST(p, c) (ANYOF_CLASS_BYTE(p, c) & ANYOF_BIT(c))
457 #define ANYOF_CLASS_ZERO(ret) Zero(((struct regnode_charclass_class*)(ret))->classflags, ANYOF_CLASSBITMAP_SIZE, char)
458 #define ANYOF_CLASS_SETALL(ret) \
459 memset (((struct regnode_charclass_class*)(ret))->classflags, 255, ANYOF_CLASSBITMAP_SIZE)
460 #define ANYOF_BITMAP_ZERO(ret) Zero(((struct regnode_charclass*)(ret))->bitmap, ANYOF_BITMAP_SIZE, char)
462 #define ANYOF_BITMAP(p) (((struct regnode_charclass*)(p))->bitmap)
463 #define ANYOF_BITMAP_BYTE(p, c) (ANYOF_BITMAP(p)[(((U8)(c)) >> 3) & 31])
464 #define ANYOF_BITMAP_SET(p, c) (ANYOF_BITMAP_BYTE(p, c) |= ANYOF_BIT(c))
465 #define ANYOF_BITMAP_CLEAR(p,c) (ANYOF_BITMAP_BYTE(p, c) &= ~ANYOF_BIT(c))
466 #define ANYOF_BITMAP_TEST(p, c) (ANYOF_BITMAP_BYTE(p, c) & ANYOF_BIT(c))
468 #define ANYOF_BITMAP_SETALL(p) \
469 memset (ANYOF_BITMAP(p), 255, ANYOF_BITMAP_SIZE)
470 #define ANYOF_BITMAP_CLEARALL(p) \
471 Zero (ANYOF_BITMAP(p), ANYOF_BITMAP_SIZE)
472 /* Check that all 256 bits are all set. Used in S_cl_is_anything() */
473 #define ANYOF_BITMAP_TESTALLSET(p) /* Assumes sizeof(p) == 32 */ \
474 memEQ (ANYOF_BITMAP(p), "\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377\377", ANYOF_BITMAP_SIZE)
476 #define ANYOF_SKIP ((ANYOF_SIZE - 1)/sizeof(regnode))
477 #define ANYOF_CLASS_SKIP ((ANYOF_CLASS_SIZE - 1)/sizeof(regnode))
479 #if ANYOF_CLASSBITMAP_SIZE != 4
480 # error ANYOF_CLASSBITMAP_SIZE is expected to be 4
482 #define ANYOF_CLASS_TEST_ANY_SET(p) ((ANYOF_FLAGS(p) & ANYOF_CLASS) \
483 && memNE (((struct regnode_charclass_class*)(p))->classflags, \
484 "\0\0\0\0", ANYOF_CLASSBITMAP_SIZE))
485 /*#define ANYOF_CLASS_ADD_SKIP (ANYOF_CLASS_SKIP - ANYOF_SKIP)
490 * Utility definitions.
493 # define UCHARAT(p) ((int)*(const U8*)(p))
495 # define UCHARAT(p) ((int)*(p)&CHARMASK)
498 #define EXTRA_SIZE(guy) ((sizeof(guy)-1)/sizeof(struct regnode))
500 #define REG_SEEN_ZERO_LEN 0x00000001
501 #define REG_SEEN_LOOKBEHIND 0x00000002
502 #define REG_SEEN_GPOS 0x00000004
504 #define REG_SEEN_CANY 0x00000010
505 #define REG_SEEN_SANY REG_SEEN_CANY /* src bckwrd cmpt */
506 #define REG_SEEN_RECURSE 0x00000020
507 #define REG_TOP_LEVEL_BRANCHES 0x00000040
508 #define REG_SEEN_VERBARG 0x00000080
509 #define REG_SEEN_CUTGROUP 0x00000100
510 #define REG_SEEN_RUN_ON_COMMENT 0x00000200
511 #define REG_SEEN_EXACTF_SHARP_S 0x00000400
515 #ifdef PLUGGABLE_RE_EXTENSION
516 #include "re_nodes.h"
518 #include "regnodes.h"
521 #ifndef PLUGGABLE_RE_EXTENSION
523 EXTCONST regexp_engine PL_core_reg_engine;
525 EXTCONST regexp_engine PL_core_reg_engine = {
528 Perl_re_intuit_start,
529 Perl_re_intuit_string,
530 Perl_regfree_internal,
531 Perl_reg_numbered_buff_fetch,
532 Perl_reg_numbered_buff_store,
533 Perl_reg_numbered_buff_length,
535 Perl_reg_named_buff_iter,
537 #if defined(USE_ITHREADS)
538 Perl_regdupe_internal,
543 #endif /* PLUGGABLE_RE_EXTENSION */
549 /* .what is a character array with one character for each member of .data
550 * The character describes the function of the corresponding .data item:
551 * a - AV for paren_name_list under DEBUGGING
552 * f - start-class data for regstclass optimization
553 * l - start op for literal (?{EVAL}) item
554 * L - start op for literal (?{EVAL}) item, with separate CV (qr//)
555 * r - pointer to an embedded code-containing qr, e.g. /ab$qr/
556 * s - swash for Unicode-style character class, and the multicharacter
557 * strings resulting from casefolding the single-character entries
558 * in the character class
560 * u - trie struct's widecharmap (a HV, so can't share, must dup)
561 * also used for revcharmap and words under DEBUGGING
562 * T - aho-trie struct
563 * S - sv for named capture lookup
564 * 20010712 mjd@plover.com
565 * (Remember to update re_dup() and pregfree() if you add any items.)
573 /* Code in S_to_utf8_substr() and S_to_byte_substr() in regexec.c accesses
574 anchored* and float* via array indexes 0 and 1. */
575 #define anchored_substr substrs->data[0].substr
576 #define anchored_utf8 substrs->data[0].utf8_substr
577 #define anchored_offset substrs->data[0].min_offset
578 #define anchored_end_shift substrs->data[0].end_shift
580 #define float_substr substrs->data[1].substr
581 #define float_utf8 substrs->data[1].utf8_substr
582 #define float_min_offset substrs->data[1].min_offset
583 #define float_max_offset substrs->data[1].max_offset
584 #define float_end_shift substrs->data[1].end_shift
586 #define check_substr substrs->data[2].substr
587 #define check_utf8 substrs->data[2].utf8_substr
588 #define check_offset_min substrs->data[2].min_offset
589 #define check_offset_max substrs->data[2].max_offset
590 #define check_end_shift substrs->data[2].end_shift
592 #define RX_ANCHORED_SUBSTR(rx) (((struct regexp *)SvANY(rx))->anchored_substr)
593 #define RX_ANCHORED_UTF8(rx) (((struct regexp *)SvANY(rx))->anchored_utf8)
594 #define RX_FLOAT_SUBSTR(rx) (((struct regexp *)SvANY(rx))->float_substr)
595 #define RX_FLOAT_UTF8(rx) (((struct regexp *)SvANY(rx))->float_utf8)
597 /* trie related stuff */
599 /* a transition record for the state machine. the
600 check field determines which state "owns" the
601 transition. the char the transition is for is
602 determined by offset from the owning states base
603 field. the next field determines which state
604 is to be transitioned to if any.
606 struct _reg_trie_trans {
611 /* a transition list element for the list based representation */
612 struct _reg_trie_trans_list_elem {
616 typedef struct _reg_trie_trans_list_elem reg_trie_trans_le;
618 /* a state for compressed nodes. base is an offset
619 into an array of reg_trie_trans array. If wordnum is
620 nonzero the state is accepting. if base is zero then
621 the state has no children (and will be accepting)
623 struct _reg_trie_state {
627 reg_trie_trans_le* list;
631 /* info per word; indexed by wordnum */
633 U16 prev; /* previous word in acceptance chain; eg in
634 * zzz|abc|ab/ after matching the chars abc, the
635 * accepted word is #2, and the previous accepted
637 U32 len; /* how many chars long is this word? */
638 U32 accept; /* accept state for this word */
642 typedef struct _reg_trie_state reg_trie_state;
643 typedef struct _reg_trie_trans reg_trie_trans;
646 /* anything in here that needs to be freed later
647 should be dealt with in pregfree.
648 refcount is first in both this and _reg_ac_data to allow a space
649 optimisation in Perl_regdupe. */
650 struct _reg_trie_data {
651 U32 refcount; /* number of times this trie is referenced */
652 U32 lasttrans; /* last valid transition element */
653 U16 *charmap; /* byte to charid lookup array */
654 reg_trie_state *states; /* state data */
655 reg_trie_trans *trans; /* array of transition elements */
656 char *bitmap; /* stclass bitmap */
657 U16 *jump; /* optional 1 indexed array of offsets before tail
658 for the node following a given word. */
659 reg_trie_wordinfo *wordinfo; /* array of info per word */
660 U16 uniquecharcount; /* unique chars in trie (width of trans table) */
661 U32 startstate; /* initial state - used for common prefix optimisation */
662 STRLEN minlen; /* minimum length of words in trie - build/opt only? */
663 STRLEN maxlen; /* maximum length of words in trie - build/opt only? */
664 U32 prefixlen; /* #chars in common prefix */
665 U32 statecount; /* Build only - number of states in the states array
666 (including the unused zero state) */
667 U32 wordcount; /* Build only */
669 STRLEN charcount; /* Build only */
672 /* There is one (3 under DEBUGGING) pointers that logically belong in this
673 structure, but are held outside as they need duplication on thread cloning,
674 whereas the rest of the structure can be read only:
675 HV *widecharmap; code points > 255 to charid
677 AV *words; Array of words contained in trie, for dumping
678 AV *revcharmap; Map of each charid back to its character representation
682 #define TRIE_WORDS_OFFSET 2
684 typedef struct _reg_trie_data reg_trie_data;
686 /* refcount is first in both this and _reg_trie_data to allow a space
687 optimisation in Perl_regdupe. */
688 struct _reg_ac_data {
692 reg_trie_state *states;
694 typedef struct _reg_ac_data reg_ac_data;
696 /* ANY_BIT doesn't use the structure, so we can borrow it here.
697 This is simpler than refactoring all of it as wed end up with
698 three different sets... */
700 #define TRIE_BITMAP(p) (((reg_trie_data *)(p))->bitmap)
701 #define TRIE_BITMAP_BYTE(p, c) (TRIE_BITMAP(p)[(((U8)(c)) >> 3) & 31])
702 #define TRIE_BITMAP_SET(p, c) (TRIE_BITMAP_BYTE(p, c) |= ANYOF_BIT((U8)c))
703 #define TRIE_BITMAP_CLEAR(p,c) (TRIE_BITMAP_BYTE(p, c) &= ~ANYOF_BIT((U8)c))
704 #define TRIE_BITMAP_TEST(p, c) (TRIE_BITMAP_BYTE(p, c) & ANYOF_BIT((U8)c))
706 #define IS_ANYOF_TRIE(op) ((op)==TRIEC || (op)==AHOCORASICKC)
707 #define IS_TRIE_AC(op) ((op)>=AHOCORASICK)
710 #define BITMAP_BYTE(p, c) (((U8*)p)[(((U8)(c)) >> 3) & 31])
711 #define BITMAP_TEST(p, c) (BITMAP_BYTE(p, c) & ANYOF_BIT((U8)c))
713 /* these defines assume uniquecharcount is the correct variable, and state may be evaluated twice */
714 #define TRIE_NODENUM(state) (((state)-1)/(trie->uniquecharcount)+1)
715 #define SAFE_TRIE_NODENUM(state) ((state) ? (((state)-1)/(trie->uniquecharcount)+1) : (state))
716 #define TRIE_NODEIDX(state) ((state) ? (((state)-1)*(trie->uniquecharcount)+1) : (state))
719 #define TRIE_CHARCOUNT(trie) ((trie)->charcount)
721 #define TRIE_CHARCOUNT(trie) (trie_charcount)
724 #define RE_TRIE_MAXBUF_INIT 65536
725 #define RE_TRIE_MAXBUF_NAME "\022E_TRIE_MAXBUF"
726 #define RE_DEBUG_FLAGS "\022E_DEBUG_FLAGS"
730 RE_DEBUG_FLAGS is used to control what debug output is emitted
731 its divided into three groups of options, some of which interact.
732 The three groups are: Compile, Execute, Extra. There is room for a
733 further group, as currently only the low three bytes are used.
754 If you modify any of these make sure you make corresponding changes to
755 re.pm, especially to the documentation.
761 #define RE_DEBUG_COMPILE_MASK 0x0000FF
762 #define RE_DEBUG_COMPILE_PARSE 0x000001
763 #define RE_DEBUG_COMPILE_OPTIMISE 0x000002
764 #define RE_DEBUG_COMPILE_TRIE 0x000004
765 #define RE_DEBUG_COMPILE_DUMP 0x000008
766 #define RE_DEBUG_COMPILE_FLAGS 0x000010
769 #define RE_DEBUG_EXECUTE_MASK 0x00FF00
770 #define RE_DEBUG_EXECUTE_INTUIT 0x000100
771 #define RE_DEBUG_EXECUTE_MATCH 0x000200
772 #define RE_DEBUG_EXECUTE_TRIE 0x000400
775 #define RE_DEBUG_EXTRA_MASK 0xFF0000
776 #define RE_DEBUG_EXTRA_TRIE 0x010000
777 #define RE_DEBUG_EXTRA_OFFSETS 0x020000
778 #define RE_DEBUG_EXTRA_OFFDEBUG 0x040000
779 #define RE_DEBUG_EXTRA_STATE 0x080000
780 #define RE_DEBUG_EXTRA_OPTIMISE 0x100000
781 #define RE_DEBUG_EXTRA_BUFFERS 0x400000
782 #define RE_DEBUG_EXTRA_GPOS 0x800000
784 #define RE_DEBUG_EXTRA_STACK 0x280000
786 #define RE_DEBUG_FLAG(x) (re_debug_flags & x)
788 #define DEBUG_COMPILE_r(x) DEBUG_r( \
789 if (re_debug_flags & RE_DEBUG_COMPILE_MASK) x )
790 #define DEBUG_PARSE_r(x) DEBUG_r( \
791 if (re_debug_flags & RE_DEBUG_COMPILE_PARSE) x )
792 #define DEBUG_OPTIMISE_r(x) DEBUG_r( \
793 if (re_debug_flags & RE_DEBUG_COMPILE_OPTIMISE) x )
794 #define DEBUG_PARSE_r(x) DEBUG_r( \
795 if (re_debug_flags & RE_DEBUG_COMPILE_PARSE) x )
796 #define DEBUG_DUMP_r(x) DEBUG_r( \
797 if (re_debug_flags & RE_DEBUG_COMPILE_DUMP) x )
798 #define DEBUG_TRIE_COMPILE_r(x) DEBUG_r( \
799 if (re_debug_flags & RE_DEBUG_COMPILE_TRIE) x )
800 #define DEBUG_FLAGS_r(x) DEBUG_r( \
801 if (re_debug_flags & RE_DEBUG_COMPILE_FLAGS) x )
803 #define DEBUG_EXECUTE_r(x) DEBUG_r( \
804 if (re_debug_flags & RE_DEBUG_EXECUTE_MASK) x )
805 #define DEBUG_INTUIT_r(x) DEBUG_r( \
806 if (re_debug_flags & RE_DEBUG_EXECUTE_INTUIT) x )
807 #define DEBUG_MATCH_r(x) DEBUG_r( \
808 if (re_debug_flags & RE_DEBUG_EXECUTE_MATCH) x )
809 #define DEBUG_TRIE_EXECUTE_r(x) DEBUG_r( \
810 if (re_debug_flags & RE_DEBUG_EXECUTE_TRIE) x )
813 #define DEBUG_EXTRA_r(x) DEBUG_r( \
814 if (re_debug_flags & RE_DEBUG_EXTRA_MASK) x )
815 #define DEBUG_OFFSETS_r(x) DEBUG_r( \
816 if (re_debug_flags & RE_DEBUG_EXTRA_OFFSETS) x )
817 #define DEBUG_STATE_r(x) DEBUG_r( \
818 if (re_debug_flags & RE_DEBUG_EXTRA_STATE) x )
819 #define DEBUG_STACK_r(x) DEBUG_r( \
820 if (re_debug_flags & RE_DEBUG_EXTRA_STACK) x )
821 #define DEBUG_BUFFERS_r(x) DEBUG_r( \
822 if (re_debug_flags & RE_DEBUG_EXTRA_BUFFERS) x )
824 #define DEBUG_OPTIMISE_MORE_r(x) DEBUG_r( \
825 if ((RE_DEBUG_EXTRA_OPTIMISE|RE_DEBUG_COMPILE_OPTIMISE) == \
826 (re_debug_flags & (RE_DEBUG_EXTRA_OPTIMISE|RE_DEBUG_COMPILE_OPTIMISE)) ) x )
827 #define MJD_OFFSET_DEBUG(x) DEBUG_r( \
828 if (re_debug_flags & RE_DEBUG_EXTRA_OFFDEBUG) \
829 Perl_warn_nocontext x )
830 #define DEBUG_TRIE_COMPILE_MORE_r(x) DEBUG_TRIE_COMPILE_r( \
831 if (re_debug_flags & RE_DEBUG_EXTRA_TRIE) x )
832 #define DEBUG_TRIE_EXECUTE_MORE_r(x) DEBUG_TRIE_EXECUTE_r( \
833 if (re_debug_flags & RE_DEBUG_EXTRA_TRIE) x )
835 #define DEBUG_TRIE_r(x) DEBUG_r( \
836 if (re_debug_flags & (RE_DEBUG_COMPILE_TRIE \
837 | RE_DEBUG_EXECUTE_TRIE )) x )
838 #define DEBUG_GPOS_r(x) DEBUG_r( \
839 if (re_debug_flags & RE_DEBUG_EXTRA_GPOS) x )
842 /* get_sv() can return NULL during global destruction. re_debug_flags can get
843 * clobbered by a longjmp, so must be initialized */
844 #define GET_RE_DEBUG_FLAGS DEBUG_r({ \
845 SV * re_debug_flags_sv = NULL; \
846 re_debug_flags = 0; \
847 re_debug_flags_sv = get_sv(RE_DEBUG_FLAGS, 1); \
848 if (re_debug_flags_sv) { \
849 if (!SvIOK(re_debug_flags_sv)) \
850 sv_setuv(re_debug_flags_sv, RE_DEBUG_COMPILE_DUMP | RE_DEBUG_EXECUTE_MASK ); \
851 re_debug_flags=SvIV(re_debug_flags_sv); \
857 #define GET_RE_DEBUG_FLAGS_DECL VOL IV re_debug_flags \
858 PERL_UNUSED_DECL = 0; GET_RE_DEBUG_FLAGS;
860 #define RE_PV_COLOR_DECL(rpv,rlen,isuni,dsv,pv,l,m,c1,c2) \
861 const char * const rpv = \
862 pv_pretty((dsv), (pv), (l), (m), \
863 PL_colors[(c1)],PL_colors[(c2)], \
864 PERL_PV_ESCAPE_RE|PERL_PV_ESCAPE_NONASCII |((isuni) ? PERL_PV_ESCAPE_UNI : 0) ); \
865 const int rlen = SvCUR(dsv)
867 #define RE_SV_ESCAPE(rpv,isuni,dsv,sv,m) \
868 const char * const rpv = \
869 pv_pretty((dsv), (SvPV_nolen_const(sv)), (SvCUR(sv)), (m), \
870 PL_colors[(c1)],PL_colors[(c2)], \
871 PERL_PV_ESCAPE_RE|PERL_PV_ESCAPE_NONASCII |((isuni) ? PERL_PV_ESCAPE_UNI : 0) )
873 #define RE_PV_QUOTED_DECL(rpv,isuni,dsv,pv,l,m) \
874 const char * const rpv = \
875 pv_pretty((dsv), (pv), (l), (m), \
876 PL_colors[0], PL_colors[1], \
877 ( PERL_PV_PRETTY_QUOTE | PERL_PV_ESCAPE_RE | PERL_PV_ESCAPE_NONASCII | PERL_PV_PRETTY_ELLIPSES | \
878 ((isuni) ? PERL_PV_ESCAPE_UNI : 0)) \
881 #define RE_SV_DUMPLEN(ItEm) (SvCUR(ItEm) - (SvTAIL(ItEm)!=0))
882 #define RE_SV_TAIL(ItEm) (SvTAIL(ItEm) ? "$" : "")
884 #else /* if not DEBUGGING */
886 #define GET_RE_DEBUG_FLAGS_DECL
887 #define RE_PV_COLOR_DECL(rpv,rlen,isuni,dsv,pv,l,m,c1,c2)
888 #define RE_SV_ESCAPE(rpv,isuni,dsv,sv,m)
889 #define RE_PV_QUOTED_DECL(rpv,isuni,dsv,pv,l,m)
890 #define RE_SV_DUMPLEN(ItEm)
891 #define RE_SV_TAIL(ItEm)
893 #endif /* DEBUG RELATED DEFINES */
897 * c-indentation-style: bsd
899 * indent-tabs-mode: nil
902 * ex: set ts=8 sts=4 sw=4 et: