5 * 'A fair jaw-cracker dwarf-language must be.' --Samwise Gamgee
7 * [p.285 of _The Lord of the Rings_, II/iii: "The Ring Goes South"]
10 /* This file contains functions for compiling a regular expression. See
11 * also regexec.c which funnily enough, contains functions for executing
12 * a regular expression.
14 * This file is also copied at build time to ext/re/re_comp.c, where
15 * it's built with -DPERL_EXT_RE_BUILD -DPERL_EXT_RE_DEBUG -DPERL_EXT.
16 * This causes the main functions to be compiled under new names and with
17 * debugging support added, which makes "use re 'debug'" work.
20 /* NOTE: this is derived from Henry Spencer's regexp code, and should not
21 * confused with the original package (see point 3 below). Thanks, Henry!
24 /* Additional note: this code is very heavily munged from Henry's version
25 * in places. In some spots I've traded clarity for efficiency, so don't
26 * blame Henry for some of the lack of readability.
29 /* The names of the functions have been changed from regcomp and
30 * regexec to pregcomp and pregexec in order to avoid conflicts
31 * with the POSIX routines of the same names.
34 #ifdef PERL_EXT_RE_BUILD
39 * pregcomp and pregexec -- regsub and regerror are not used in perl
41 * Copyright (c) 1986 by University of Toronto.
42 * Written by Henry Spencer. Not derived from licensed software.
44 * Permission is granted to anyone to use this software for any
45 * purpose on any computer system, and to redistribute it freely,
46 * subject to the following restrictions:
48 * 1. The author is not responsible for the consequences of use of
49 * this software, no matter how awful, even if they arise
52 * 2. The origin of this software must not be misrepresented, either
53 * by explicit claim or by omission.
55 * 3. Altered versions must be plainly marked as such, and must not
56 * be misrepresented as being the original software.
59 **** Alterations to Henry's code are...
61 **** Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
62 **** 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
63 **** by Larry Wall and others
65 **** You may distribute under the terms of either the GNU General Public
66 **** License or the Artistic License, as specified in the README file.
69 * Beware that some of this code is subtly aware of the way operator
70 * precedence is structured in regular expressions. Serious changes in
71 * regular-expression syntax might require a total rethink.
74 #define PERL_IN_REGCOMP_C
77 #ifndef PERL_IN_XSUB_RE
82 #ifdef PERL_IN_XSUB_RE
84 extern const struct regexp_engine my_reg_engine;
89 #include "dquote_static.c"
90 #include "charclass_invlists.h"
91 #include "inline_invlist.c"
92 #include "unicode_constants.h"
94 #define HAS_NONLATIN1_FOLD_CLOSURE(i) _HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(i)
95 #define IS_NON_FINAL_FOLD(c) _IS_NON_FINAL_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c)
96 #define IS_IN_SOME_FOLD_L1(c) _IS_IN_SOME_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c)
103 # if defined(BUGGY_MSC6)
104 /* MSC 6.00A breaks on op/regexp.t test 85 unless we turn this off */
105 # pragma optimize("a",off)
106 /* But MSC 6.00A is happy with 'w', for aliases only across function calls*/
107 # pragma optimize("w",on )
108 # endif /* BUGGY_MSC6 */
112 #define STATIC static
116 typedef struct RExC_state_t {
117 U32 flags; /* RXf_* are we folding, multilining? */
118 U32 pm_flags; /* PMf_* stuff from the calling PMOP */
119 char *precomp; /* uncompiled string. */
120 REGEXP *rx_sv; /* The SV that is the regexp. */
121 regexp *rx; /* perl core regexp structure */
122 regexp_internal *rxi; /* internal data for regexp object pprivate field */
123 char *start; /* Start of input for compile */
124 char *end; /* End of input for compile */
125 char *parse; /* Input-scan pointer. */
126 I32 whilem_seen; /* number of WHILEM in this expr */
127 regnode *emit_start; /* Start of emitted-code area */
128 regnode *emit_bound; /* First regnode outside of the allocated space */
129 regnode *emit; /* Code-emit pointer; if = &emit_dummy,
130 implies compiling, so don't emit */
131 regnode emit_dummy; /* placeholder for emit to point to */
132 I32 naughty; /* How bad is this pattern? */
133 I32 sawback; /* Did we see \1, ...? */
135 I32 size; /* Code size. */
136 I32 npar; /* Capture buffer count, (OPEN). */
137 I32 cpar; /* Capture buffer count, (CLOSE). */
138 I32 nestroot; /* root parens we are in - used by accept */
141 regnode **open_parens; /* pointers to open parens */
142 regnode **close_parens; /* pointers to close parens */
143 regnode *opend; /* END node in program */
144 I32 utf8; /* whether the pattern is utf8 or not */
145 I32 orig_utf8; /* whether the pattern was originally in utf8 */
146 /* XXX use this for future optimisation of case
147 * where pattern must be upgraded to utf8. */
148 I32 uni_semantics; /* If a d charset modifier should use unicode
149 rules, even if the pattern is not in
151 HV *paren_names; /* Paren names */
153 regnode **recurse; /* Recurse regops */
154 I32 recurse_count; /* Number of recurse regops */
157 I32 override_recoding;
158 I32 in_multi_char_class;
159 struct reg_code_block *code_blocks; /* positions of literal (?{})
161 int num_code_blocks; /* size of code_blocks[] */
162 int code_index; /* next code_blocks[] slot */
164 char *starttry; /* -Dr: where regtry was called. */
165 #define RExC_starttry (pRExC_state->starttry)
167 SV *runtime_code_qr; /* qr with the runtime code blocks */
169 const char *lastparse;
171 AV *paren_name_list; /* idx -> name */
172 #define RExC_lastparse (pRExC_state->lastparse)
173 #define RExC_lastnum (pRExC_state->lastnum)
174 #define RExC_paren_name_list (pRExC_state->paren_name_list)
178 #define RExC_flags (pRExC_state->flags)
179 #define RExC_pm_flags (pRExC_state->pm_flags)
180 #define RExC_precomp (pRExC_state->precomp)
181 #define RExC_rx_sv (pRExC_state->rx_sv)
182 #define RExC_rx (pRExC_state->rx)
183 #define RExC_rxi (pRExC_state->rxi)
184 #define RExC_start (pRExC_state->start)
185 #define RExC_end (pRExC_state->end)
186 #define RExC_parse (pRExC_state->parse)
187 #define RExC_whilem_seen (pRExC_state->whilem_seen)
188 #ifdef RE_TRACK_PATTERN_OFFSETS
189 #define RExC_offsets (pRExC_state->rxi->u.offsets) /* I am not like the others */
191 #define RExC_emit (pRExC_state->emit)
192 #define RExC_emit_dummy (pRExC_state->emit_dummy)
193 #define RExC_emit_start (pRExC_state->emit_start)
194 #define RExC_emit_bound (pRExC_state->emit_bound)
195 #define RExC_naughty (pRExC_state->naughty)
196 #define RExC_sawback (pRExC_state->sawback)
197 #define RExC_seen (pRExC_state->seen)
198 #define RExC_size (pRExC_state->size)
199 #define RExC_npar (pRExC_state->npar)
200 #define RExC_nestroot (pRExC_state->nestroot)
201 #define RExC_extralen (pRExC_state->extralen)
202 #define RExC_seen_zerolen (pRExC_state->seen_zerolen)
203 #define RExC_utf8 (pRExC_state->utf8)
204 #define RExC_uni_semantics (pRExC_state->uni_semantics)
205 #define RExC_orig_utf8 (pRExC_state->orig_utf8)
206 #define RExC_open_parens (pRExC_state->open_parens)
207 #define RExC_close_parens (pRExC_state->close_parens)
208 #define RExC_opend (pRExC_state->opend)
209 #define RExC_paren_names (pRExC_state->paren_names)
210 #define RExC_recurse (pRExC_state->recurse)
211 #define RExC_recurse_count (pRExC_state->recurse_count)
212 #define RExC_in_lookbehind (pRExC_state->in_lookbehind)
213 #define RExC_contains_locale (pRExC_state->contains_locale)
214 #define RExC_override_recoding (pRExC_state->override_recoding)
215 #define RExC_in_multi_char_class (pRExC_state->in_multi_char_class)
218 #define ISMULT1(c) ((c) == '*' || (c) == '+' || (c) == '?')
219 #define ISMULT2(s) ((*s) == '*' || (*s) == '+' || (*s) == '?' || \
220 ((*s) == '{' && regcurly(s, FALSE)))
223 #undef SPSTART /* dratted cpp namespace... */
226 * Flags to be passed up and down.
228 #define WORST 0 /* Worst case. */
229 #define HASWIDTH 0x01 /* Known to match non-null strings. */
231 /* Simple enough to be STAR/PLUS operand; in an EXACTish node must be a single
232 * character. (There needs to be a case: in the switch statement in regexec.c
233 * for any node marked SIMPLE.) Note that this is not the same thing as
236 #define SPSTART 0x04 /* Starts with * or + */
237 #define POSTPONED 0x08 /* (?1),(?&name), (??{...}) or similar */
238 #define TRYAGAIN 0x10 /* Weeded out a declaration. */
239 #define RESTART_UTF8 0x20 /* Restart, need to calcuate sizes as UTF-8 */
241 #define REG_NODE_NUM(x) ((x) ? (int)((x)-RExC_emit_start) : -1)
243 /* whether trie related optimizations are enabled */
244 #if PERL_ENABLE_EXTENDED_TRIE_OPTIMISATION
245 #define TRIE_STUDY_OPT
246 #define FULL_TRIE_STUDY
252 #define PBYTE(u8str,paren) ((U8*)(u8str))[(paren) >> 3]
253 #define PBITVAL(paren) (1 << ((paren) & 7))
254 #define PAREN_TEST(u8str,paren) ( PBYTE(u8str,paren) & PBITVAL(paren))
255 #define PAREN_SET(u8str,paren) PBYTE(u8str,paren) |= PBITVAL(paren)
256 #define PAREN_UNSET(u8str,paren) PBYTE(u8str,paren) &= (~PBITVAL(paren))
258 #define REQUIRE_UTF8 STMT_START { \
260 *flagp = RESTART_UTF8; \
265 /* This converts the named class defined in regcomp.h to its equivalent class
266 * number defined in handy.h. */
267 #define namedclass_to_classnum(class) ((int) ((class) / 2))
268 #define classnum_to_namedclass(classnum) ((classnum) * 2)
270 /* About scan_data_t.
272 During optimisation we recurse through the regexp program performing
273 various inplace (keyhole style) optimisations. In addition study_chunk
274 and scan_commit populate this data structure with information about
275 what strings MUST appear in the pattern. We look for the longest
276 string that must appear at a fixed location, and we look for the
277 longest string that may appear at a floating location. So for instance
282 Both 'FOO' and 'A' are fixed strings. Both 'B' and 'BAR' are floating
283 strings (because they follow a .* construct). study_chunk will identify
284 both FOO and BAR as being the longest fixed and floating strings respectively.
286 The strings can be composites, for instance
290 will result in a composite fixed substring 'foo'.
292 For each string some basic information is maintained:
294 - offset or min_offset
295 This is the position the string must appear at, or not before.
296 It also implicitly (when combined with minlenp) tells us how many
297 characters must match before the string we are searching for.
298 Likewise when combined with minlenp and the length of the string it
299 tells us how many characters must appear after the string we have
303 Only used for floating strings. This is the rightmost point that
304 the string can appear at. If set to I32 max it indicates that the
305 string can occur infinitely far to the right.
308 A pointer to the minimum number of characters of the pattern that the
309 string was found inside. This is important as in the case of positive
310 lookahead or positive lookbehind we can have multiple patterns
315 The minimum length of the pattern overall is 3, the minimum length
316 of the lookahead part is 3, but the minimum length of the part that
317 will actually match is 1. So 'FOO's minimum length is 3, but the
318 minimum length for the F is 1. This is important as the minimum length
319 is used to determine offsets in front of and behind the string being
320 looked for. Since strings can be composites this is the length of the
321 pattern at the time it was committed with a scan_commit. Note that
322 the length is calculated by study_chunk, so that the minimum lengths
323 are not known until the full pattern has been compiled, thus the
324 pointer to the value.
328 In the case of lookbehind the string being searched for can be
329 offset past the start point of the final matching string.
330 If this value was just blithely removed from the min_offset it would
331 invalidate some of the calculations for how many chars must match
332 before or after (as they are derived from min_offset and minlen and
333 the length of the string being searched for).
334 When the final pattern is compiled and the data is moved from the
335 scan_data_t structure into the regexp structure the information
336 about lookbehind is factored in, with the information that would
337 have been lost precalculated in the end_shift field for the
340 The fields pos_min and pos_delta are used to store the minimum offset
341 and the delta to the maximum offset at the current point in the pattern.
345 typedef struct scan_data_t {
346 /*I32 len_min; unused */
347 /*I32 len_delta; unused */
351 I32 last_end; /* min value, <0 unless valid. */
354 SV **longest; /* Either &l_fixed, or &l_float. */
355 SV *longest_fixed; /* longest fixed string found in pattern */
356 I32 offset_fixed; /* offset where it starts */
357 I32 *minlen_fixed; /* pointer to the minlen relevant to the string */
358 I32 lookbehind_fixed; /* is the position of the string modfied by LB */
359 SV *longest_float; /* longest floating string found in pattern */
360 I32 offset_float_min; /* earliest point in string it can appear */
361 I32 offset_float_max; /* latest point in string it can appear */
362 I32 *minlen_float; /* pointer to the minlen relevant to the string */
363 I32 lookbehind_float; /* is the position of the string modified by LB */
367 struct regnode_charclass_class *start_class;
371 * Forward declarations for pregcomp()'s friends.
374 static const scan_data_t zero_scan_data =
375 { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ,0};
377 #define SF_BEFORE_EOL (SF_BEFORE_SEOL|SF_BEFORE_MEOL)
378 #define SF_BEFORE_SEOL 0x0001
379 #define SF_BEFORE_MEOL 0x0002
380 #define SF_FIX_BEFORE_EOL (SF_FIX_BEFORE_SEOL|SF_FIX_BEFORE_MEOL)
381 #define SF_FL_BEFORE_EOL (SF_FL_BEFORE_SEOL|SF_FL_BEFORE_MEOL)
384 # define SF_FIX_SHIFT_EOL (0+2)
385 # define SF_FL_SHIFT_EOL (0+4)
387 # define SF_FIX_SHIFT_EOL (+2)
388 # define SF_FL_SHIFT_EOL (+4)
391 #define SF_FIX_BEFORE_SEOL (SF_BEFORE_SEOL << SF_FIX_SHIFT_EOL)
392 #define SF_FIX_BEFORE_MEOL (SF_BEFORE_MEOL << SF_FIX_SHIFT_EOL)
394 #define SF_FL_BEFORE_SEOL (SF_BEFORE_SEOL << SF_FL_SHIFT_EOL)
395 #define SF_FL_BEFORE_MEOL (SF_BEFORE_MEOL << SF_FL_SHIFT_EOL) /* 0x20 */
396 #define SF_IS_INF 0x0040
397 #define SF_HAS_PAR 0x0080
398 #define SF_IN_PAR 0x0100
399 #define SF_HAS_EVAL 0x0200
400 #define SCF_DO_SUBSTR 0x0400
401 #define SCF_DO_STCLASS_AND 0x0800
402 #define SCF_DO_STCLASS_OR 0x1000
403 #define SCF_DO_STCLASS (SCF_DO_STCLASS_AND|SCF_DO_STCLASS_OR)
404 #define SCF_WHILEM_VISITED_POS 0x2000
406 #define SCF_TRIE_RESTUDY 0x4000 /* Do restudy? */
407 #define SCF_SEEN_ACCEPT 0x8000
408 #define SCF_TRIE_DOING_RESTUDY 0x10000
410 #define UTF cBOOL(RExC_utf8)
412 /* The enums for all these are ordered so things work out correctly */
413 #define LOC (get_regex_charset(RExC_flags) == REGEX_LOCALE_CHARSET)
414 #define DEPENDS_SEMANTICS (get_regex_charset(RExC_flags) == REGEX_DEPENDS_CHARSET)
415 #define UNI_SEMANTICS (get_regex_charset(RExC_flags) == REGEX_UNICODE_CHARSET)
416 #define AT_LEAST_UNI_SEMANTICS (get_regex_charset(RExC_flags) >= REGEX_UNICODE_CHARSET)
417 #define ASCII_RESTRICTED (get_regex_charset(RExC_flags) == REGEX_ASCII_RESTRICTED_CHARSET)
418 #define AT_LEAST_ASCII_RESTRICTED (get_regex_charset(RExC_flags) >= REGEX_ASCII_RESTRICTED_CHARSET)
419 #define ASCII_FOLD_RESTRICTED (get_regex_charset(RExC_flags) == REGEX_ASCII_MORE_RESTRICTED_CHARSET)
421 #define FOLD cBOOL(RExC_flags & RXf_PMf_FOLD)
423 #define OOB_NAMEDCLASS -1
425 /* There is no code point that is out-of-bounds, so this is problematic. But
426 * its only current use is to initialize a variable that is always set before
428 #define OOB_UNICODE 0xDEADBEEF
430 #define CHR_SVLEN(sv) (UTF ? sv_len_utf8(sv) : SvCUR(sv))
431 #define CHR_DIST(a,b) (UTF ? utf8_distance(a,b) : a - b)
434 /* length of regex to show in messages that don't mark a position within */
435 #define RegexLengthToShowInErrorMessages 127
438 * If MARKER[12] are adjusted, be sure to adjust the constants at the top
439 * of t/op/regmesg.t, the tests in t/op/re_tests, and those in
440 * op/pragma/warn/regcomp.
442 #define MARKER1 "<-- HERE" /* marker as it appears in the description */
443 #define MARKER2 " <-- HERE " /* marker as it appears within the regex */
445 #define REPORT_LOCATION " in regex; marked by " MARKER1 " in m/%.*s" MARKER2 "%s/"
448 * Calls SAVEDESTRUCTOR_X if needed, then calls Perl_croak with the given
449 * arg. Show regex, up to a maximum length. If it's too long, chop and add
452 #define _FAIL(code) STMT_START { \
453 const char *ellipses = ""; \
454 IV len = RExC_end - RExC_precomp; \
457 SAVEFREESV(RExC_rx_sv); \
458 if (len > RegexLengthToShowInErrorMessages) { \
459 /* chop 10 shorter than the max, to ensure meaning of "..." */ \
460 len = RegexLengthToShowInErrorMessages - 10; \
466 #define FAIL(msg) _FAIL( \
467 Perl_croak(aTHX_ "%s in regex m/%.*s%s/", \
468 msg, (int)len, RExC_precomp, ellipses))
470 #define FAIL2(msg,arg) _FAIL( \
471 Perl_croak(aTHX_ msg " in regex m/%.*s%s/", \
472 arg, (int)len, RExC_precomp, ellipses))
475 * Simple_vFAIL -- like FAIL, but marks the current location in the scan
477 #define Simple_vFAIL(m) STMT_START { \
478 const IV offset = RExC_parse - RExC_precomp; \
479 Perl_croak(aTHX_ "%s" REPORT_LOCATION, \
480 m, (int)offset, RExC_precomp, RExC_precomp + offset); \
484 * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL()
486 #define vFAIL(m) STMT_START { \
488 SAVEFREESV(RExC_rx_sv); \
493 * Like Simple_vFAIL(), but accepts two arguments.
495 #define Simple_vFAIL2(m,a1) STMT_START { \
496 const IV offset = RExC_parse - RExC_precomp; \
497 S_re_croak2(aTHX_ m, REPORT_LOCATION, a1, \
498 (int)offset, RExC_precomp, RExC_precomp + offset); \
502 * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL2().
504 #define vFAIL2(m,a1) STMT_START { \
506 SAVEFREESV(RExC_rx_sv); \
507 Simple_vFAIL2(m, a1); \
512 * Like Simple_vFAIL(), but accepts three arguments.
514 #define Simple_vFAIL3(m, a1, a2) STMT_START { \
515 const IV offset = RExC_parse - RExC_precomp; \
516 S_re_croak2(aTHX_ m, REPORT_LOCATION, a1, a2, \
517 (int)offset, RExC_precomp, RExC_precomp + offset); \
521 * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL3().
523 #define vFAIL3(m,a1,a2) STMT_START { \
525 SAVEFREESV(RExC_rx_sv); \
526 Simple_vFAIL3(m, a1, a2); \
530 * Like Simple_vFAIL(), but accepts four arguments.
532 #define Simple_vFAIL4(m, a1, a2, a3) STMT_START { \
533 const IV offset = RExC_parse - RExC_precomp; \
534 S_re_croak2(aTHX_ m, REPORT_LOCATION, a1, a2, a3, \
535 (int)offset, RExC_precomp, RExC_precomp + offset); \
538 #define vFAIL4(m,a1,a2,a3) STMT_START { \
540 SAVEFREESV(RExC_rx_sv); \
541 Simple_vFAIL4(m, a1, a2, a3); \
544 /* m is not necessarily a "literal string", in this macro */
545 #define reg_warn_non_literal_string(loc, m) STMT_START { \
546 const IV offset = loc - RExC_precomp; \
547 Perl_warner(aTHX_ packWARN(WARN_REGEXP), "%s" REPORT_LOCATION, \
548 m, (int)offset, RExC_precomp, RExC_precomp + offset); \
551 #define ckWARNreg(loc,m) STMT_START { \
552 const IV offset = loc - RExC_precomp; \
553 Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION, \
554 (int)offset, RExC_precomp, RExC_precomp + offset); \
557 #define vWARN_dep(loc, m) STMT_START { \
558 const IV offset = loc - RExC_precomp; \
559 Perl_warner(aTHX_ packWARN(WARN_DEPRECATED), m REPORT_LOCATION, \
560 (int)offset, RExC_precomp, RExC_precomp + offset); \
563 #define ckWARNdep(loc,m) STMT_START { \
564 const IV offset = loc - RExC_precomp; \
565 Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED), \
567 (int)offset, RExC_precomp, RExC_precomp + offset); \
570 #define ckWARNregdep(loc,m) STMT_START { \
571 const IV offset = loc - RExC_precomp; \
572 Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_REGEXP), \
574 (int)offset, RExC_precomp, RExC_precomp + offset); \
577 #define ckWARN2reg_d(loc,m, a1) STMT_START { \
578 const IV offset = loc - RExC_precomp; \
579 Perl_ck_warner_d(aTHX_ packWARN(WARN_REGEXP), \
581 a1, (int)offset, RExC_precomp, RExC_precomp + offset); \
584 #define ckWARN2reg(loc, m, a1) STMT_START { \
585 const IV offset = loc - RExC_precomp; \
586 Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION, \
587 a1, (int)offset, RExC_precomp, RExC_precomp + offset); \
590 #define vWARN3(loc, m, a1, a2) STMT_START { \
591 const IV offset = loc - RExC_precomp; \
592 Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION, \
593 a1, a2, (int)offset, RExC_precomp, RExC_precomp + offset); \
596 #define ckWARN3reg(loc, m, a1, a2) STMT_START { \
597 const IV offset = loc - RExC_precomp; \
598 Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION, \
599 a1, a2, (int)offset, RExC_precomp, RExC_precomp + offset); \
602 #define vWARN4(loc, m, a1, a2, a3) STMT_START { \
603 const IV offset = loc - RExC_precomp; \
604 Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION, \
605 a1, a2, a3, (int)offset, RExC_precomp, RExC_precomp + offset); \
608 #define ckWARN4reg(loc, m, a1, a2, a3) STMT_START { \
609 const IV offset = loc - RExC_precomp; \
610 Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION, \
611 a1, a2, a3, (int)offset, RExC_precomp, RExC_precomp + offset); \
614 #define vWARN5(loc, m, a1, a2, a3, a4) STMT_START { \
615 const IV offset = loc - RExC_precomp; \
616 Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION, \
617 a1, a2, a3, a4, (int)offset, RExC_precomp, RExC_precomp + offset); \
621 /* Allow for side effects in s */
622 #define REGC(c,s) STMT_START { \
623 if (!SIZE_ONLY) *(s) = (c); else (void)(s); \
626 /* Macros for recording node offsets. 20001227 mjd@plover.com
627 * Nodes are numbered 1, 2, 3, 4. Node #n's position is recorded in
628 * element 2*n-1 of the array. Element #2n holds the byte length node #n.
629 * Element 0 holds the number n.
630 * Position is 1 indexed.
632 #ifndef RE_TRACK_PATTERN_OFFSETS
633 #define Set_Node_Offset_To_R(node,byte)
634 #define Set_Node_Offset(node,byte)
635 #define Set_Cur_Node_Offset
636 #define Set_Node_Length_To_R(node,len)
637 #define Set_Node_Length(node,len)
638 #define Set_Node_Cur_Length(node,start)
639 #define Node_Offset(n)
640 #define Node_Length(n)
641 #define Set_Node_Offset_Length(node,offset,len)
642 #define ProgLen(ri) ri->u.proglen
643 #define SetProgLen(ri,x) ri->u.proglen = x
645 #define ProgLen(ri) ri->u.offsets[0]
646 #define SetProgLen(ri,x) ri->u.offsets[0] = x
647 #define Set_Node_Offset_To_R(node,byte) STMT_START { \
649 MJD_OFFSET_DEBUG(("** (%d) offset of node %d is %d.\n", \
650 __LINE__, (int)(node), (int)(byte))); \
652 Perl_croak(aTHX_ "value of node is %d in Offset macro", (int)(node)); \
654 RExC_offsets[2*(node)-1] = (byte); \
659 #define Set_Node_Offset(node,byte) \
660 Set_Node_Offset_To_R((node)-RExC_emit_start, (byte)-RExC_start)
661 #define Set_Cur_Node_Offset Set_Node_Offset(RExC_emit, RExC_parse)
663 #define Set_Node_Length_To_R(node,len) STMT_START { \
665 MJD_OFFSET_DEBUG(("** (%d) size of node %d is %d.\n", \
666 __LINE__, (int)(node), (int)(len))); \
668 Perl_croak(aTHX_ "value of node is %d in Length macro", (int)(node)); \
670 RExC_offsets[2*(node)] = (len); \
675 #define Set_Node_Length(node,len) \
676 Set_Node_Length_To_R((node)-RExC_emit_start, len)
677 #define Set_Node_Cur_Length(node, start) \
678 Set_Node_Length(node, RExC_parse - start)
680 /* Get offsets and lengths */
681 #define Node_Offset(n) (RExC_offsets[2*((n)-RExC_emit_start)-1])
682 #define Node_Length(n) (RExC_offsets[2*((n)-RExC_emit_start)])
684 #define Set_Node_Offset_Length(node,offset,len) STMT_START { \
685 Set_Node_Offset_To_R((node)-RExC_emit_start, (offset)); \
686 Set_Node_Length_To_R((node)-RExC_emit_start, (len)); \
690 #if PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS
691 #define EXPERIMENTAL_INPLACESCAN
692 #endif /*PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS*/
694 #define DEBUG_STUDYDATA(str,data,depth) \
695 DEBUG_OPTIMISE_MORE_r(if(data){ \
696 PerlIO_printf(Perl_debug_log, \
697 "%*s" str "Pos:%"IVdf"/%"IVdf \
698 " Flags: 0x%"UVXf" Whilem_c: %"IVdf" Lcp: %"IVdf" %s", \
699 (int)(depth)*2, "", \
700 (IV)((data)->pos_min), \
701 (IV)((data)->pos_delta), \
702 (UV)((data)->flags), \
703 (IV)((data)->whilem_c), \
704 (IV)((data)->last_closep ? *((data)->last_closep) : -1), \
705 is_inf ? "INF " : "" \
707 if ((data)->last_found) \
708 PerlIO_printf(Perl_debug_log, \
709 "Last:'%s' %"IVdf":%"IVdf"/%"IVdf" %sFixed:'%s' @ %"IVdf \
710 " %sFloat: '%s' @ %"IVdf"/%"IVdf"", \
711 SvPVX_const((data)->last_found), \
712 (IV)((data)->last_end), \
713 (IV)((data)->last_start_min), \
714 (IV)((data)->last_start_max), \
715 ((data)->longest && \
716 (data)->longest==&((data)->longest_fixed)) ? "*" : "", \
717 SvPVX_const((data)->longest_fixed), \
718 (IV)((data)->offset_fixed), \
719 ((data)->longest && \
720 (data)->longest==&((data)->longest_float)) ? "*" : "", \
721 SvPVX_const((data)->longest_float), \
722 (IV)((data)->offset_float_min), \
723 (IV)((data)->offset_float_max) \
725 PerlIO_printf(Perl_debug_log,"\n"); \
728 /* Mark that we cannot extend a found fixed substring at this point.
729 Update the longest found anchored substring and the longest found
730 floating substrings if needed. */
733 S_scan_commit(pTHX_ const RExC_state_t *pRExC_state, scan_data_t *data, I32 *minlenp, int is_inf)
735 const STRLEN l = CHR_SVLEN(data->last_found);
736 const STRLEN old_l = CHR_SVLEN(*data->longest);
737 GET_RE_DEBUG_FLAGS_DECL;
739 PERL_ARGS_ASSERT_SCAN_COMMIT;
741 if ((l >= old_l) && ((l > old_l) || (data->flags & SF_BEFORE_EOL))) {
742 SvSetMagicSV(*data->longest, data->last_found);
743 if (*data->longest == data->longest_fixed) {
744 data->offset_fixed = l ? data->last_start_min : data->pos_min;
745 if (data->flags & SF_BEFORE_EOL)
747 |= ((data->flags & SF_BEFORE_EOL) << SF_FIX_SHIFT_EOL);
749 data->flags &= ~SF_FIX_BEFORE_EOL;
750 data->minlen_fixed=minlenp;
751 data->lookbehind_fixed=0;
753 else { /* *data->longest == data->longest_float */
754 data->offset_float_min = l ? data->last_start_min : data->pos_min;
755 data->offset_float_max = (l
756 ? data->last_start_max
757 : (data->pos_delta == I32_MAX ? I32_MAX : data->pos_min + data->pos_delta));
758 if (is_inf || (U32)data->offset_float_max > (U32)I32_MAX)
759 data->offset_float_max = I32_MAX;
760 if (data->flags & SF_BEFORE_EOL)
762 |= ((data->flags & SF_BEFORE_EOL) << SF_FL_SHIFT_EOL);
764 data->flags &= ~SF_FL_BEFORE_EOL;
765 data->minlen_float=minlenp;
766 data->lookbehind_float=0;
769 SvCUR_set(data->last_found, 0);
771 SV * const sv = data->last_found;
772 if (SvUTF8(sv) && SvMAGICAL(sv)) {
773 MAGIC * const mg = mg_find(sv, PERL_MAGIC_utf8);
779 data->flags &= ~SF_BEFORE_EOL;
780 DEBUG_STUDYDATA("commit: ",data,0);
783 /* These macros set, clear and test whether the synthetic start class ('ssc',
784 * given by the parameter) matches an empty string (EOS). This uses the
785 * 'next_off' field in the node, to save a bit in the flags field. The ssc
786 * stands alone, so there is never a next_off, so this field is otherwise
787 * unused. The EOS information is used only for compilation, but theoretically
788 * it could be passed on to the execution code. This could be used to store
789 * more than one bit of information, but only this one is currently used. */
790 #define SET_SSC_EOS(node) STMT_START { (node)->next_off = TRUE; } STMT_END
791 #define CLEAR_SSC_EOS(node) STMT_START { (node)->next_off = FALSE; } STMT_END
792 #define TEST_SSC_EOS(node) cBOOL((node)->next_off)
794 /* Can match anything (initialization) */
796 S_cl_anything(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl)
798 PERL_ARGS_ASSERT_CL_ANYTHING;
800 ANYOF_BITMAP_SETALL(cl);
801 cl->flags = ANYOF_UNICODE_ALL;
804 /* If any portion of the regex is to operate under locale rules,
805 * initialization includes it. The reason this isn't done for all regexes
806 * is that the optimizer was written under the assumption that locale was
807 * all-or-nothing. Given the complexity and lack of documentation in the
808 * optimizer, and that there are inadequate test cases for locale, so many
809 * parts of it may not work properly, it is safest to avoid locale unless
811 if (RExC_contains_locale) {
812 ANYOF_CLASS_SETALL(cl); /* /l uses class */
813 cl->flags |= ANYOF_LOCALE|ANYOF_CLASS|ANYOF_LOC_FOLD;
816 ANYOF_CLASS_ZERO(cl); /* Only /l uses class now */
820 /* Can match anything (initialization) */
822 S_cl_is_anything(const struct regnode_charclass_class *cl)
826 PERL_ARGS_ASSERT_CL_IS_ANYTHING;
828 for (value = 0; value < ANYOF_MAX; value += 2)
829 if (ANYOF_CLASS_TEST(cl, value) && ANYOF_CLASS_TEST(cl, value + 1))
831 if (!(cl->flags & ANYOF_UNICODE_ALL))
833 if (!ANYOF_BITMAP_TESTALLSET((const void*)cl))
838 /* Can match anything (initialization) */
840 S_cl_init(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl)
842 PERL_ARGS_ASSERT_CL_INIT;
844 Zero(cl, 1, struct regnode_charclass_class);
846 cl_anything(pRExC_state, cl);
847 ARG_SET(cl, ANYOF_NONBITMAP_EMPTY);
850 /* These two functions currently do the exact same thing */
851 #define cl_init_zero cl_init
853 /* 'AND' a given class with another one. Can create false positives. 'cl'
854 * should not be inverted. 'and_with->flags & ANYOF_CLASS' should be 0 if
855 * 'and_with' is a regnode_charclass instead of a regnode_charclass_class. */
857 S_cl_and(struct regnode_charclass_class *cl,
858 const struct regnode_charclass_class *and_with)
860 PERL_ARGS_ASSERT_CL_AND;
862 assert(PL_regkind[and_with->type] == ANYOF);
864 /* I (khw) am not sure all these restrictions are necessary XXX */
865 if (!(ANYOF_CLASS_TEST_ANY_SET(and_with))
866 && !(ANYOF_CLASS_TEST_ANY_SET(cl))
867 && (and_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
868 && !(and_with->flags & ANYOF_LOC_FOLD)
869 && !(cl->flags & ANYOF_LOC_FOLD)) {
872 if (and_with->flags & ANYOF_INVERT)
873 for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
874 cl->bitmap[i] &= ~and_with->bitmap[i];
876 for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
877 cl->bitmap[i] &= and_with->bitmap[i];
878 } /* XXXX: logic is complicated otherwise, leave it along for a moment. */
880 if (and_with->flags & ANYOF_INVERT) {
882 /* Here, the and'ed node is inverted. Get the AND of the flags that
883 * aren't affected by the inversion. Those that are affected are
884 * handled individually below */
885 U8 affected_flags = cl->flags & ~INVERSION_UNAFFECTED_FLAGS;
886 cl->flags &= (and_with->flags & INVERSION_UNAFFECTED_FLAGS);
887 cl->flags |= affected_flags;
889 /* We currently don't know how to deal with things that aren't in the
890 * bitmap, but we know that the intersection is no greater than what
891 * is already in cl, so let there be false positives that get sorted
892 * out after the synthetic start class succeeds, and the node is
893 * matched for real. */
895 /* The inversion of these two flags indicate that the resulting
896 * intersection doesn't have them */
897 if (and_with->flags & ANYOF_UNICODE_ALL) {
898 cl->flags &= ~ANYOF_UNICODE_ALL;
900 if (and_with->flags & ANYOF_NON_UTF8_LATIN1_ALL) {
901 cl->flags &= ~ANYOF_NON_UTF8_LATIN1_ALL;
904 else { /* and'd node is not inverted */
905 U8 outside_bitmap_but_not_utf8; /* Temp variable */
907 if (! ANYOF_NONBITMAP(and_with)) {
909 /* Here 'and_with' doesn't match anything outside the bitmap
910 * (except possibly ANYOF_UNICODE_ALL), which means the
911 * intersection can't either, except for ANYOF_UNICODE_ALL, in
912 * which case we don't know what the intersection is, but it's no
913 * greater than what cl already has, so can just leave it alone,
914 * with possible false positives */
915 if (! (and_with->flags & ANYOF_UNICODE_ALL)) {
916 ARG_SET(cl, ANYOF_NONBITMAP_EMPTY);
917 cl->flags &= ~ANYOF_NONBITMAP_NON_UTF8;
920 else if (! ANYOF_NONBITMAP(cl)) {
922 /* Here, 'and_with' does match something outside the bitmap, and cl
923 * doesn't have a list of things to match outside the bitmap. If
924 * cl can match all code points above 255, the intersection will
925 * be those above-255 code points that 'and_with' matches. If cl
926 * can't match all Unicode code points, it means that it can't
927 * match anything outside the bitmap (since the 'if' that got us
928 * into this block tested for that), so we leave the bitmap empty.
930 if (cl->flags & ANYOF_UNICODE_ALL) {
931 ARG_SET(cl, ARG(and_with));
933 /* and_with's ARG may match things that don't require UTF8.
934 * And now cl's will too, in spite of this being an 'and'. See
935 * the comments below about the kludge */
936 cl->flags |= and_with->flags & ANYOF_NONBITMAP_NON_UTF8;
940 /* Here, both 'and_with' and cl match something outside the
941 * bitmap. Currently we do not do the intersection, so just match
942 * whatever cl had at the beginning. */
946 /* Take the intersection of the two sets of flags. However, the
947 * ANYOF_NONBITMAP_NON_UTF8 flag is treated as an 'or'. This is a
948 * kludge around the fact that this flag is not treated like the others
949 * which are initialized in cl_anything(). The way the optimizer works
950 * is that the synthetic start class (SSC) is initialized to match
951 * anything, and then the first time a real node is encountered, its
952 * values are AND'd with the SSC's with the result being the values of
953 * the real node. However, there are paths through the optimizer where
954 * the AND never gets called, so those initialized bits are set
955 * inappropriately, which is not usually a big deal, as they just cause
956 * false positives in the SSC, which will just mean a probably
957 * imperceptible slow down in execution. However this bit has a
958 * higher false positive consequence in that it can cause utf8.pm,
959 * utf8_heavy.pl ... to be loaded when not necessary, which is a much
960 * bigger slowdown and also causes significant extra memory to be used.
961 * In order to prevent this, the code now takes a different tack. The
962 * bit isn't set unless some part of the regular expression needs it,
963 * but once set it won't get cleared. This means that these extra
964 * modules won't get loaded unless there was some path through the
965 * pattern that would have required them anyway, and so any false
966 * positives that occur by not ANDing them out when they could be
967 * aren't as severe as they would be if we treated this bit like all
969 outside_bitmap_but_not_utf8 = (cl->flags | and_with->flags)
970 & ANYOF_NONBITMAP_NON_UTF8;
971 cl->flags &= and_with->flags;
972 cl->flags |= outside_bitmap_but_not_utf8;
976 /* 'OR' a given class with another one. Can create false positives. 'cl'
977 * should not be inverted. 'or_with->flags & ANYOF_CLASS' should be 0 if
978 * 'or_with' is a regnode_charclass instead of a regnode_charclass_class. */
980 S_cl_or(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl, const struct regnode_charclass_class *or_with)
982 PERL_ARGS_ASSERT_CL_OR;
984 if (or_with->flags & ANYOF_INVERT) {
986 /* Here, the or'd node is to be inverted. This means we take the
987 * complement of everything not in the bitmap, but currently we don't
988 * know what that is, so give up and match anything */
989 if (ANYOF_NONBITMAP(or_with)) {
990 cl_anything(pRExC_state, cl);
993 * (B1 | CL1) | (!B2 & !CL2) = (B1 | !B2 & !CL2) | (CL1 | (!B2 & !CL2))
994 * <= (B1 | !B2) | (CL1 | !CL2)
995 * which is wasteful if CL2 is small, but we ignore CL2:
996 * (B1 | CL1) | (!B2 & !CL2) <= (B1 | CL1) | !B2 = (B1 | !B2) | CL1
997 * XXXX Can we handle case-fold? Unclear:
998 * (OK1(i) | OK1(i')) | !(OK1(i) | OK1(i')) =
999 * (OK1(i) | OK1(i')) | (!OK1(i) & !OK1(i'))
1001 else if ( (or_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
1002 && !(or_with->flags & ANYOF_LOC_FOLD)
1003 && !(cl->flags & ANYOF_LOC_FOLD) ) {
1006 for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
1007 cl->bitmap[i] |= ~or_with->bitmap[i];
1008 } /* XXXX: logic is complicated otherwise */
1010 cl_anything(pRExC_state, cl);
1013 /* And, we can just take the union of the flags that aren't affected
1014 * by the inversion */
1015 cl->flags |= or_with->flags & INVERSION_UNAFFECTED_FLAGS;
1017 /* For the remaining flags:
1018 ANYOF_UNICODE_ALL and inverted means to not match anything above
1019 255, which means that the union with cl should just be
1020 what cl has in it, so can ignore this flag
1021 ANYOF_NON_UTF8_LATIN1_ALL and inverted means if not utf8 and ord
1022 is 127-255 to match them, but then invert that, so the
1023 union with cl should just be what cl has in it, so can
1026 } else { /* 'or_with' is not inverted */
1027 /* (B1 | CL1) | (B2 | CL2) = (B1 | B2) | (CL1 | CL2)) */
1028 if ( (or_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
1029 && (!(or_with->flags & ANYOF_LOC_FOLD)
1030 || (cl->flags & ANYOF_LOC_FOLD)) ) {
1033 /* OR char bitmap and class bitmap separately */
1034 for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
1035 cl->bitmap[i] |= or_with->bitmap[i];
1036 if (or_with->flags & ANYOF_CLASS) {
1037 ANYOF_CLASS_OR(or_with, cl);
1040 else { /* XXXX: logic is complicated, leave it along for a moment. */
1041 cl_anything(pRExC_state, cl);
1044 if (ANYOF_NONBITMAP(or_with)) {
1046 /* Use the added node's outside-the-bit-map match if there isn't a
1047 * conflict. If there is a conflict (both nodes match something
1048 * outside the bitmap, but what they match outside is not the same
1049 * pointer, and hence not easily compared until XXX we extend
1050 * inversion lists this far), give up and allow the start class to
1051 * match everything outside the bitmap. If that stuff is all above
1052 * 255, can just set UNICODE_ALL, otherwise caould be anything. */
1053 if (! ANYOF_NONBITMAP(cl)) {
1054 ARG_SET(cl, ARG(or_with));
1056 else if (ARG(cl) != ARG(or_with)) {
1058 if ((or_with->flags & ANYOF_NONBITMAP_NON_UTF8)) {
1059 cl_anything(pRExC_state, cl);
1062 cl->flags |= ANYOF_UNICODE_ALL;
1067 /* Take the union */
1068 cl->flags |= or_with->flags;
1072 #define TRIE_LIST_ITEM(state,idx) (trie->states[state].trans.list)[ idx ]
1073 #define TRIE_LIST_CUR(state) ( TRIE_LIST_ITEM( state, 0 ).forid )
1074 #define TRIE_LIST_LEN(state) ( TRIE_LIST_ITEM( state, 0 ).newstate )
1075 #define TRIE_LIST_USED(idx) ( trie->states[state].trans.list ? (TRIE_LIST_CUR( idx ) - 1) : 0 )
1080 dump_trie(trie,widecharmap,revcharmap)
1081 dump_trie_interim_list(trie,widecharmap,revcharmap,next_alloc)
1082 dump_trie_interim_table(trie,widecharmap,revcharmap,next_alloc)
1084 These routines dump out a trie in a somewhat readable format.
1085 The _interim_ variants are used for debugging the interim
1086 tables that are used to generate the final compressed
1087 representation which is what dump_trie expects.
1089 Part of the reason for their existence is to provide a form
1090 of documentation as to how the different representations function.
1095 Dumps the final compressed table form of the trie to Perl_debug_log.
1096 Used for debugging make_trie().
1100 S_dump_trie(pTHX_ const struct _reg_trie_data *trie, HV *widecharmap,
1101 AV *revcharmap, U32 depth)
1104 SV *sv=sv_newmortal();
1105 int colwidth= widecharmap ? 6 : 4;
1107 GET_RE_DEBUG_FLAGS_DECL;
1109 PERL_ARGS_ASSERT_DUMP_TRIE;
1111 PerlIO_printf( Perl_debug_log, "%*sChar : %-6s%-6s%-4s ",
1112 (int)depth * 2 + 2,"",
1113 "Match","Base","Ofs" );
1115 for( state = 0 ; state < trie->uniquecharcount ; state++ ) {
1116 SV ** const tmp = av_fetch( revcharmap, state, 0);
1118 PerlIO_printf( Perl_debug_log, "%*s",
1120 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth,
1121 PL_colors[0], PL_colors[1],
1122 (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1123 PERL_PV_ESCAPE_FIRSTCHAR
1128 PerlIO_printf( Perl_debug_log, "\n%*sState|-----------------------",
1129 (int)depth * 2 + 2,"");
1131 for( state = 0 ; state < trie->uniquecharcount ; state++ )
1132 PerlIO_printf( Perl_debug_log, "%.*s", colwidth, "--------");
1133 PerlIO_printf( Perl_debug_log, "\n");
1135 for( state = 1 ; state < trie->statecount ; state++ ) {
1136 const U32 base = trie->states[ state ].trans.base;
1138 PerlIO_printf( Perl_debug_log, "%*s#%4"UVXf"|", (int)depth * 2 + 2,"", (UV)state);
1140 if ( trie->states[ state ].wordnum ) {
1141 PerlIO_printf( Perl_debug_log, " W%4X", trie->states[ state ].wordnum );
1143 PerlIO_printf( Perl_debug_log, "%6s", "" );
1146 PerlIO_printf( Perl_debug_log, " @%4"UVXf" ", (UV)base );
1151 while( ( base + ofs < trie->uniquecharcount ) ||
1152 ( base + ofs - trie->uniquecharcount < trie->lasttrans
1153 && trie->trans[ base + ofs - trie->uniquecharcount ].check != state))
1156 PerlIO_printf( Perl_debug_log, "+%2"UVXf"[ ", (UV)ofs);
1158 for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
1159 if ( ( base + ofs >= trie->uniquecharcount ) &&
1160 ( base + ofs - trie->uniquecharcount < trie->lasttrans ) &&
1161 trie->trans[ base + ofs - trie->uniquecharcount ].check == state )
1163 PerlIO_printf( Perl_debug_log, "%*"UVXf,
1165 (UV)trie->trans[ base + ofs - trie->uniquecharcount ].next );
1167 PerlIO_printf( Perl_debug_log, "%*s",colwidth," ." );
1171 PerlIO_printf( Perl_debug_log, "]");
1174 PerlIO_printf( Perl_debug_log, "\n" );
1176 PerlIO_printf(Perl_debug_log, "%*sword_info N:(prev,len)=", (int)depth*2, "");
1177 for (word=1; word <= trie->wordcount; word++) {
1178 PerlIO_printf(Perl_debug_log, " %d:(%d,%d)",
1179 (int)word, (int)(trie->wordinfo[word].prev),
1180 (int)(trie->wordinfo[word].len));
1182 PerlIO_printf(Perl_debug_log, "\n" );
1185 Dumps a fully constructed but uncompressed trie in list form.
1186 List tries normally only are used for construction when the number of
1187 possible chars (trie->uniquecharcount) is very high.
1188 Used for debugging make_trie().
1191 S_dump_trie_interim_list(pTHX_ const struct _reg_trie_data *trie,
1192 HV *widecharmap, AV *revcharmap, U32 next_alloc,
1196 SV *sv=sv_newmortal();
1197 int colwidth= widecharmap ? 6 : 4;
1198 GET_RE_DEBUG_FLAGS_DECL;
1200 PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_LIST;
1202 /* print out the table precompression. */
1203 PerlIO_printf( Perl_debug_log, "%*sState :Word | Transition Data\n%*s%s",
1204 (int)depth * 2 + 2,"", (int)depth * 2 + 2,"",
1205 "------:-----+-----------------\n" );
1207 for( state=1 ; state < next_alloc ; state ++ ) {
1210 PerlIO_printf( Perl_debug_log, "%*s %4"UVXf" :",
1211 (int)depth * 2 + 2,"", (UV)state );
1212 if ( ! trie->states[ state ].wordnum ) {
1213 PerlIO_printf( Perl_debug_log, "%5s| ","");
1215 PerlIO_printf( Perl_debug_log, "W%4x| ",
1216 trie->states[ state ].wordnum
1219 for( charid = 1 ; charid <= TRIE_LIST_USED( state ) ; charid++ ) {
1220 SV ** const tmp = av_fetch( revcharmap, TRIE_LIST_ITEM(state,charid).forid, 0);
1222 PerlIO_printf( Perl_debug_log, "%*s:%3X=%4"UVXf" | ",
1224 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth,
1225 PL_colors[0], PL_colors[1],
1226 (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1227 PERL_PV_ESCAPE_FIRSTCHAR
1229 TRIE_LIST_ITEM(state,charid).forid,
1230 (UV)TRIE_LIST_ITEM(state,charid).newstate
1233 PerlIO_printf(Perl_debug_log, "\n%*s| ",
1234 (int)((depth * 2) + 14), "");
1237 PerlIO_printf( Perl_debug_log, "\n");
1242 Dumps a fully constructed but uncompressed trie in table form.
1243 This is the normal DFA style state transition table, with a few
1244 twists to facilitate compression later.
1245 Used for debugging make_trie().
1248 S_dump_trie_interim_table(pTHX_ const struct _reg_trie_data *trie,
1249 HV *widecharmap, AV *revcharmap, U32 next_alloc,
1254 SV *sv=sv_newmortal();
1255 int colwidth= widecharmap ? 6 : 4;
1256 GET_RE_DEBUG_FLAGS_DECL;
1258 PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_TABLE;
1261 print out the table precompression so that we can do a visual check
1262 that they are identical.
1265 PerlIO_printf( Perl_debug_log, "%*sChar : ",(int)depth * 2 + 2,"" );
1267 for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
1268 SV ** const tmp = av_fetch( revcharmap, charid, 0);
1270 PerlIO_printf( Perl_debug_log, "%*s",
1272 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth,
1273 PL_colors[0], PL_colors[1],
1274 (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1275 PERL_PV_ESCAPE_FIRSTCHAR
1281 PerlIO_printf( Perl_debug_log, "\n%*sState+-",(int)depth * 2 + 2,"" );
1283 for( charid=0 ; charid < trie->uniquecharcount ; charid++ ) {
1284 PerlIO_printf( Perl_debug_log, "%.*s", colwidth,"--------");
1287 PerlIO_printf( Perl_debug_log, "\n" );
1289 for( state=1 ; state < next_alloc ; state += trie->uniquecharcount ) {
1291 PerlIO_printf( Perl_debug_log, "%*s%4"UVXf" : ",
1292 (int)depth * 2 + 2,"",
1293 (UV)TRIE_NODENUM( state ) );
1295 for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
1296 UV v=(UV)SAFE_TRIE_NODENUM( trie->trans[ state + charid ].next );
1298 PerlIO_printf( Perl_debug_log, "%*"UVXf, colwidth, v );
1300 PerlIO_printf( Perl_debug_log, "%*s", colwidth, "." );
1302 if ( ! trie->states[ TRIE_NODENUM( state ) ].wordnum ) {
1303 PerlIO_printf( Perl_debug_log, " (%4"UVXf")\n", (UV)trie->trans[ state ].check );
1305 PerlIO_printf( Perl_debug_log, " (%4"UVXf") W%4X\n", (UV)trie->trans[ state ].check,
1306 trie->states[ TRIE_NODENUM( state ) ].wordnum );
1314 /* make_trie(startbranch,first,last,tail,word_count,flags,depth)
1315 startbranch: the first branch in the whole branch sequence
1316 first : start branch of sequence of branch-exact nodes.
1317 May be the same as startbranch
1318 last : Thing following the last branch.
1319 May be the same as tail.
1320 tail : item following the branch sequence
1321 count : words in the sequence
1322 flags : currently the OP() type we will be building one of /EXACT(|F|Fl)/
1323 depth : indent depth
1325 Inplace optimizes a sequence of 2 or more Branch-Exact nodes into a TRIE node.
1327 A trie is an N'ary tree where the branches are determined by digital
1328 decomposition of the key. IE, at the root node you look up the 1st character and
1329 follow that branch repeat until you find the end of the branches. Nodes can be
1330 marked as "accepting" meaning they represent a complete word. Eg:
1334 would convert into the following structure. Numbers represent states, letters
1335 following numbers represent valid transitions on the letter from that state, if
1336 the number is in square brackets it represents an accepting state, otherwise it
1337 will be in parenthesis.
1339 +-h->+-e->[3]-+-r->(8)-+-s->[9]
1343 (1) +-i->(6)-+-s->[7]
1345 +-s->(3)-+-h->(4)-+-e->[5]
1347 Accept Word Mapping: 3=>1 (he),5=>2 (she), 7=>3 (his), 9=>4 (hers)
1349 This shows that when matching against the string 'hers' we will begin at state 1
1350 read 'h' and move to state 2, read 'e' and move to state 3 which is accepting,
1351 then read 'r' and go to state 8 followed by 's' which takes us to state 9 which
1352 is also accepting. Thus we know that we can match both 'he' and 'hers' with a
1353 single traverse. We store a mapping from accepting to state to which word was
1354 matched, and then when we have multiple possibilities we try to complete the
1355 rest of the regex in the order in which they occured in the alternation.
1357 The only prior NFA like behaviour that would be changed by the TRIE support is
1358 the silent ignoring of duplicate alternations which are of the form:
1360 / (DUPE|DUPE) X? (?{ ... }) Y /x
1362 Thus EVAL blocks following a trie may be called a different number of times with
1363 and without the optimisation. With the optimisations dupes will be silently
1364 ignored. This inconsistent behaviour of EVAL type nodes is well established as
1365 the following demonstrates:
1367 'words'=~/(word|word|word)(?{ print $1 })[xyz]/
1369 which prints out 'word' three times, but
1371 'words'=~/(word|word|word)(?{ print $1 })S/
1373 which doesnt print it out at all. This is due to other optimisations kicking in.
1375 Example of what happens on a structural level:
1377 The regexp /(ac|ad|ab)+/ will produce the following debug output:
1379 1: CURLYM[1] {1,32767}(18)
1390 This would be optimizable with startbranch=5, first=5, last=16, tail=16
1391 and should turn into:
1393 1: CURLYM[1] {1,32767}(18)
1395 [Words:3 Chars Stored:6 Unique Chars:4 States:5 NCP:1]
1403 Cases where tail != last would be like /(?foo|bar)baz/:
1413 which would be optimizable with startbranch=1, first=1, last=7, tail=8
1414 and would end up looking like:
1417 [Words:2 Chars Stored:6 Unique Chars:5 States:7 NCP:1]
1424 d = uvuni_to_utf8_flags(d, uv, 0);
1426 is the recommended Unicode-aware way of saying
1431 #define TRIE_STORE_REVCHAR(val) \
1434 SV *zlopp = newSV(7); /* XXX: optimize me */ \
1435 unsigned char *flrbbbbb = (unsigned char *) SvPVX(zlopp); \
1436 unsigned const char *const kapow = uvuni_to_utf8(flrbbbbb, val); \
1437 SvCUR_set(zlopp, kapow - flrbbbbb); \
1440 av_push(revcharmap, zlopp); \
1442 char ooooff = (char)val; \
1443 av_push(revcharmap, newSVpvn(&ooooff, 1)); \
1447 #define TRIE_READ_CHAR STMT_START { \
1450 /* if it is UTF then it is either already folded, or does not need folding */ \
1451 uvc = utf8n_to_uvuni( (const U8*) uc, UTF8_MAXLEN, &len, uniflags); \
1453 else if (folder == PL_fold_latin1) { \
1454 /* if we use this folder we have to obey unicode rules on latin-1 data */ \
1455 if ( foldlen > 0 ) { \
1456 uvc = utf8n_to_uvuni( (const U8*) scan, UTF8_MAXLEN, &len, uniflags ); \
1462 uvc = _to_fold_latin1( (U8) *uc, foldbuf, &foldlen, FOLD_FLAGS_FULL); \
1463 skiplen = UNISKIP(uvc); \
1464 foldlen -= skiplen; \
1465 scan = foldbuf + skiplen; \
1468 /* raw data, will be folded later if needed */ \
1476 #define TRIE_LIST_PUSH(state,fid,ns) STMT_START { \
1477 if ( TRIE_LIST_CUR( state ) >=TRIE_LIST_LEN( state ) ) { \
1478 U32 ging = TRIE_LIST_LEN( state ) *= 2; \
1479 Renew( trie->states[ state ].trans.list, ging, reg_trie_trans_le ); \
1481 TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).forid = fid; \
1482 TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).newstate = ns; \
1483 TRIE_LIST_CUR( state )++; \
1486 #define TRIE_LIST_NEW(state) STMT_START { \
1487 Newxz( trie->states[ state ].trans.list, \
1488 4, reg_trie_trans_le ); \
1489 TRIE_LIST_CUR( state ) = 1; \
1490 TRIE_LIST_LEN( state ) = 4; \
1493 #define TRIE_HANDLE_WORD(state) STMT_START { \
1494 U16 dupe= trie->states[ state ].wordnum; \
1495 regnode * const noper_next = regnext( noper ); \
1498 /* store the word for dumping */ \
1500 if (OP(noper) != NOTHING) \
1501 tmp = newSVpvn_utf8(STRING(noper), STR_LEN(noper), UTF); \
1503 tmp = newSVpvn_utf8( "", 0, UTF ); \
1504 av_push( trie_words, tmp ); \
1508 trie->wordinfo[curword].prev = 0; \
1509 trie->wordinfo[curword].len = wordlen; \
1510 trie->wordinfo[curword].accept = state; \
1512 if ( noper_next < tail ) { \
1514 trie->jump = (U16 *) PerlMemShared_calloc( word_count + 1, sizeof(U16) ); \
1515 trie->jump[curword] = (U16)(noper_next - convert); \
1517 jumper = noper_next; \
1519 nextbranch= regnext(cur); \
1523 /* It's a dupe. Pre-insert into the wordinfo[].prev */\
1524 /* chain, so that when the bits of chain are later */\
1525 /* linked together, the dups appear in the chain */\
1526 trie->wordinfo[curword].prev = trie->wordinfo[dupe].prev; \
1527 trie->wordinfo[dupe].prev = curword; \
1529 /* we haven't inserted this word yet. */ \
1530 trie->states[ state ].wordnum = curword; \
1535 #define TRIE_TRANS_STATE(state,base,ucharcount,charid,special) \
1536 ( ( base + charid >= ucharcount \
1537 && base + charid < ubound \
1538 && state == trie->trans[ base - ucharcount + charid ].check \
1539 && trie->trans[ base - ucharcount + charid ].next ) \
1540 ? trie->trans[ base - ucharcount + charid ].next \
1541 : ( state==1 ? special : 0 ) \
1545 #define MADE_JUMP_TRIE 2
1546 #define MADE_EXACT_TRIE 4
1549 S_make_trie(pTHX_ RExC_state_t *pRExC_state, regnode *startbranch, regnode *first, regnode *last, regnode *tail, U32 word_count, U32 flags, U32 depth)
1552 /* first pass, loop through and scan words */
1553 reg_trie_data *trie;
1554 HV *widecharmap = NULL;
1555 AV *revcharmap = newAV();
1557 const U32 uniflags = UTF8_ALLOW_DEFAULT;
1562 regnode *jumper = NULL;
1563 regnode *nextbranch = NULL;
1564 regnode *convert = NULL;
1565 U32 *prev_states; /* temp array mapping each state to previous one */
1566 /* we just use folder as a flag in utf8 */
1567 const U8 * folder = NULL;
1570 const U32 data_slot = add_data( pRExC_state, 4, "tuuu" );
1571 AV *trie_words = NULL;
1572 /* along with revcharmap, this only used during construction but both are
1573 * useful during debugging so we store them in the struct when debugging.
1576 const U32 data_slot = add_data( pRExC_state, 2, "tu" );
1577 STRLEN trie_charcount=0;
1579 SV *re_trie_maxbuff;
1580 GET_RE_DEBUG_FLAGS_DECL;
1582 PERL_ARGS_ASSERT_MAKE_TRIE;
1584 PERL_UNUSED_ARG(depth);
1591 case EXACTFU_TRICKYFOLD:
1592 case EXACTFU: folder = PL_fold_latin1; break;
1593 case EXACTF: folder = PL_fold; break;
1594 case EXACTFL: folder = PL_fold_locale; break;
1595 default: Perl_croak( aTHX_ "panic! In trie construction, unknown node type %u %s", (unsigned) flags, PL_reg_name[flags] );
1598 trie = (reg_trie_data *) PerlMemShared_calloc( 1, sizeof(reg_trie_data) );
1600 trie->startstate = 1;
1601 trie->wordcount = word_count;
1602 RExC_rxi->data->data[ data_slot ] = (void*)trie;
1603 trie->charmap = (U16 *) PerlMemShared_calloc( 256, sizeof(U16) );
1605 trie->bitmap = (char *) PerlMemShared_calloc( ANYOF_BITMAP_SIZE, 1 );
1606 trie->wordinfo = (reg_trie_wordinfo *) PerlMemShared_calloc(
1607 trie->wordcount+1, sizeof(reg_trie_wordinfo));
1610 trie_words = newAV();
1613 re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
1614 if (!SvIOK(re_trie_maxbuff)) {
1615 sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
1617 DEBUG_TRIE_COMPILE_r({
1618 PerlIO_printf( Perl_debug_log,
1619 "%*smake_trie start==%d, first==%d, last==%d, tail==%d depth=%d\n",
1620 (int)depth * 2 + 2, "",
1621 REG_NODE_NUM(startbranch),REG_NODE_NUM(first),
1622 REG_NODE_NUM(last), REG_NODE_NUM(tail),
1626 /* Find the node we are going to overwrite */
1627 if ( first == startbranch && OP( last ) != BRANCH ) {
1628 /* whole branch chain */
1631 /* branch sub-chain */
1632 convert = NEXTOPER( first );
1635 /* -- First loop and Setup --
1637 We first traverse the branches and scan each word to determine if it
1638 contains widechars, and how many unique chars there are, this is
1639 important as we have to build a table with at least as many columns as we
1642 We use an array of integers to represent the character codes 0..255
1643 (trie->charmap) and we use a an HV* to store Unicode characters. We use the
1644 native representation of the character value as the key and IV's for the
1647 *TODO* If we keep track of how many times each character is used we can
1648 remap the columns so that the table compression later on is more
1649 efficient in terms of memory by ensuring the most common value is in the
1650 middle and the least common are on the outside. IMO this would be better
1651 than a most to least common mapping as theres a decent chance the most
1652 common letter will share a node with the least common, meaning the node
1653 will not be compressible. With a middle is most common approach the worst
1654 case is when we have the least common nodes twice.
1658 for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
1659 regnode *noper = NEXTOPER( cur );
1660 const U8 *uc = (U8*)STRING( noper );
1661 const U8 *e = uc + STR_LEN( noper );
1663 U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
1665 const U8 *scan = (U8*)NULL;
1666 U32 wordlen = 0; /* required init */
1668 bool set_bit = trie->bitmap ? 1 : 0; /*store the first char in the bitmap?*/
1670 if (OP(noper) == NOTHING) {
1671 regnode *noper_next= regnext(noper);
1672 if (noper_next != tail && OP(noper_next) == flags) {
1674 uc= (U8*)STRING(noper);
1675 e= uc + STR_LEN(noper);
1676 trie->minlen= STR_LEN(noper);
1683 if ( set_bit ) { /* bitmap only alloced when !(UTF&&Folding) */
1684 TRIE_BITMAP_SET(trie,*uc); /* store the raw first byte
1685 regardless of encoding */
1686 if (OP( noper ) == EXACTFU_SS) {
1687 /* false positives are ok, so just set this */
1688 TRIE_BITMAP_SET(trie,0xDF);
1691 for ( ; uc < e ; uc += len ) {
1692 TRIE_CHARCOUNT(trie)++;
1697 U8 folded= folder[ (U8) uvc ];
1698 if ( !trie->charmap[ folded ] ) {
1699 trie->charmap[ folded ]=( ++trie->uniquecharcount );
1700 TRIE_STORE_REVCHAR( folded );
1703 if ( !trie->charmap[ uvc ] ) {
1704 trie->charmap[ uvc ]=( ++trie->uniquecharcount );
1705 TRIE_STORE_REVCHAR( uvc );
1708 /* store the codepoint in the bitmap, and its folded
1710 TRIE_BITMAP_SET(trie, uvc);
1712 /* store the folded codepoint */
1713 if ( folder ) TRIE_BITMAP_SET(trie, folder[(U8) uvc ]);
1716 /* store first byte of utf8 representation of
1717 variant codepoints */
1718 if (! UNI_IS_INVARIANT(uvc)) {
1719 TRIE_BITMAP_SET(trie, UTF8_TWO_BYTE_HI(uvc));
1722 set_bit = 0; /* We've done our bit :-) */
1727 widecharmap = newHV();
1729 svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 1 );
1732 Perl_croak( aTHX_ "error creating/fetching widecharmap entry for 0x%"UVXf, uvc );
1734 if ( !SvTRUE( *svpp ) ) {
1735 sv_setiv( *svpp, ++trie->uniquecharcount );
1736 TRIE_STORE_REVCHAR(uvc);
1740 if( cur == first ) {
1741 trie->minlen = chars;
1742 trie->maxlen = chars;
1743 } else if (chars < trie->minlen) {
1744 trie->minlen = chars;
1745 } else if (chars > trie->maxlen) {
1746 trie->maxlen = chars;
1748 if (OP( noper ) == EXACTFU_SS) {
1749 /* XXX: workaround - 'ss' could match "\x{DF}" so minlen could be 1 and not 2*/
1750 if (trie->minlen > 1)
1753 if (OP( noper ) == EXACTFU_TRICKYFOLD) {
1754 /* XXX: workround - things like "\x{1FBE}\x{0308}\x{0301}" can match "\x{0390}"
1755 * - We assume that any such sequence might match a 2 byte string */
1756 if (trie->minlen > 2 )
1760 } /* end first pass */
1761 DEBUG_TRIE_COMPILE_r(
1762 PerlIO_printf( Perl_debug_log, "%*sTRIE(%s): W:%d C:%d Uq:%d Min:%d Max:%d\n",
1763 (int)depth * 2 + 2,"",
1764 ( widecharmap ? "UTF8" : "NATIVE" ), (int)word_count,
1765 (int)TRIE_CHARCOUNT(trie), trie->uniquecharcount,
1766 (int)trie->minlen, (int)trie->maxlen )
1770 We now know what we are dealing with in terms of unique chars and
1771 string sizes so we can calculate how much memory a naive
1772 representation using a flat table will take. If it's over a reasonable
1773 limit (as specified by ${^RE_TRIE_MAXBUF}) we use a more memory
1774 conservative but potentially much slower representation using an array
1777 At the end we convert both representations into the same compressed
1778 form that will be used in regexec.c for matching with. The latter
1779 is a form that cannot be used to construct with but has memory
1780 properties similar to the list form and access properties similar
1781 to the table form making it both suitable for fast searches and
1782 small enough that its feasable to store for the duration of a program.
1784 See the comment in the code where the compressed table is produced
1785 inplace from the flat tabe representation for an explanation of how
1786 the compression works.
1791 Newx(prev_states, TRIE_CHARCOUNT(trie) + 2, U32);
1794 if ( (IV)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1) > SvIV(re_trie_maxbuff) ) {
1796 Second Pass -- Array Of Lists Representation
1798 Each state will be represented by a list of charid:state records
1799 (reg_trie_trans_le) the first such element holds the CUR and LEN
1800 points of the allocated array. (See defines above).
1802 We build the initial structure using the lists, and then convert
1803 it into the compressed table form which allows faster lookups
1804 (but cant be modified once converted).
1807 STRLEN transcount = 1;
1809 DEBUG_TRIE_COMPILE_MORE_r( PerlIO_printf( Perl_debug_log,
1810 "%*sCompiling trie using list compiler\n",
1811 (int)depth * 2 + 2, ""));
1813 trie->states = (reg_trie_state *)
1814 PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
1815 sizeof(reg_trie_state) );
1819 for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
1821 regnode *noper = NEXTOPER( cur );
1822 U8 *uc = (U8*)STRING( noper );
1823 const U8 *e = uc + STR_LEN( noper );
1824 U32 state = 1; /* required init */
1825 U16 charid = 0; /* sanity init */
1826 U8 *scan = (U8*)NULL; /* sanity init */
1827 STRLEN foldlen = 0; /* required init */
1828 U32 wordlen = 0; /* required init */
1829 U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
1832 if (OP(noper) == NOTHING) {
1833 regnode *noper_next= regnext(noper);
1834 if (noper_next != tail && OP(noper_next) == flags) {
1836 uc= (U8*)STRING(noper);
1837 e= uc + STR_LEN(noper);
1841 if (OP(noper) != NOTHING) {
1842 for ( ; uc < e ; uc += len ) {
1847 charid = trie->charmap[ uvc ];
1849 SV** const svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 0);
1853 charid=(U16)SvIV( *svpp );
1856 /* charid is now 0 if we dont know the char read, or nonzero if we do */
1863 if ( !trie->states[ state ].trans.list ) {
1864 TRIE_LIST_NEW( state );
1866 for ( check = 1; check <= TRIE_LIST_USED( state ); check++ ) {
1867 if ( TRIE_LIST_ITEM( state, check ).forid == charid ) {
1868 newstate = TRIE_LIST_ITEM( state, check ).newstate;
1873 newstate = next_alloc++;
1874 prev_states[newstate] = state;
1875 TRIE_LIST_PUSH( state, charid, newstate );
1880 Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %"IVdf, uvc );
1884 TRIE_HANDLE_WORD(state);
1886 } /* end second pass */
1888 /* next alloc is the NEXT state to be allocated */
1889 trie->statecount = next_alloc;
1890 trie->states = (reg_trie_state *)
1891 PerlMemShared_realloc( trie->states,
1893 * sizeof(reg_trie_state) );
1895 /* and now dump it out before we compress it */
1896 DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_list(trie, widecharmap,
1897 revcharmap, next_alloc,
1901 trie->trans = (reg_trie_trans *)
1902 PerlMemShared_calloc( transcount, sizeof(reg_trie_trans) );
1909 for( state=1 ; state < next_alloc ; state ++ ) {
1913 DEBUG_TRIE_COMPILE_MORE_r(
1914 PerlIO_printf( Perl_debug_log, "tp: %d zp: %d ",tp,zp)
1918 if (trie->states[state].trans.list) {
1919 U16 minid=TRIE_LIST_ITEM( state, 1).forid;
1923 for( idx = 2 ; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
1924 const U16 forid = TRIE_LIST_ITEM( state, idx).forid;
1925 if ( forid < minid ) {
1927 } else if ( forid > maxid ) {
1931 if ( transcount < tp + maxid - minid + 1) {
1933 trie->trans = (reg_trie_trans *)
1934 PerlMemShared_realloc( trie->trans,
1936 * sizeof(reg_trie_trans) );
1937 Zero( trie->trans + (transcount / 2), transcount / 2 , reg_trie_trans );
1939 base = trie->uniquecharcount + tp - minid;
1940 if ( maxid == minid ) {
1942 for ( ; zp < tp ; zp++ ) {
1943 if ( ! trie->trans[ zp ].next ) {
1944 base = trie->uniquecharcount + zp - minid;
1945 trie->trans[ zp ].next = TRIE_LIST_ITEM( state, 1).newstate;
1946 trie->trans[ zp ].check = state;
1952 trie->trans[ tp ].next = TRIE_LIST_ITEM( state, 1).newstate;
1953 trie->trans[ tp ].check = state;
1958 for ( idx=1; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
1959 const U32 tid = base - trie->uniquecharcount + TRIE_LIST_ITEM( state, idx ).forid;
1960 trie->trans[ tid ].next = TRIE_LIST_ITEM( state, idx ).newstate;
1961 trie->trans[ tid ].check = state;
1963 tp += ( maxid - minid + 1 );
1965 Safefree(trie->states[ state ].trans.list);
1968 DEBUG_TRIE_COMPILE_MORE_r(
1969 PerlIO_printf( Perl_debug_log, " base: %d\n",base);
1972 trie->states[ state ].trans.base=base;
1974 trie->lasttrans = tp + 1;
1978 Second Pass -- Flat Table Representation.
1980 we dont use the 0 slot of either trans[] or states[] so we add 1 to each.
1981 We know that we will need Charcount+1 trans at most to store the data
1982 (one row per char at worst case) So we preallocate both structures
1983 assuming worst case.
1985 We then construct the trie using only the .next slots of the entry
1988 We use the .check field of the first entry of the node temporarily to
1989 make compression both faster and easier by keeping track of how many non
1990 zero fields are in the node.
1992 Since trans are numbered from 1 any 0 pointer in the table is a FAIL
1995 There are two terms at use here: state as a TRIE_NODEIDX() which is a
1996 number representing the first entry of the node, and state as a
1997 TRIE_NODENUM() which is the trans number. state 1 is TRIE_NODEIDX(1) and
1998 TRIE_NODENUM(1), state 2 is TRIE_NODEIDX(2) and TRIE_NODENUM(3) if there
1999 are 2 entrys per node. eg:
2007 The table is internally in the right hand, idx form. However as we also
2008 have to deal with the states array which is indexed by nodenum we have to
2009 use TRIE_NODENUM() to convert.
2012 DEBUG_TRIE_COMPILE_MORE_r( PerlIO_printf( Perl_debug_log,
2013 "%*sCompiling trie using table compiler\n",
2014 (int)depth * 2 + 2, ""));
2016 trie->trans = (reg_trie_trans *)
2017 PerlMemShared_calloc( ( TRIE_CHARCOUNT(trie) + 1 )
2018 * trie->uniquecharcount + 1,
2019 sizeof(reg_trie_trans) );
2020 trie->states = (reg_trie_state *)
2021 PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
2022 sizeof(reg_trie_state) );
2023 next_alloc = trie->uniquecharcount + 1;
2026 for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
2028 regnode *noper = NEXTOPER( cur );
2029 const U8 *uc = (U8*)STRING( noper );
2030 const U8 *e = uc + STR_LEN( noper );
2032 U32 state = 1; /* required init */
2034 U16 charid = 0; /* sanity init */
2035 U32 accept_state = 0; /* sanity init */
2036 U8 *scan = (U8*)NULL; /* sanity init */
2038 STRLEN foldlen = 0; /* required init */
2039 U32 wordlen = 0; /* required init */
2041 U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
2043 if (OP(noper) == NOTHING) {
2044 regnode *noper_next= regnext(noper);
2045 if (noper_next != tail && OP(noper_next) == flags) {
2047 uc= (U8*)STRING(noper);
2048 e= uc + STR_LEN(noper);
2052 if ( OP(noper) != NOTHING ) {
2053 for ( ; uc < e ; uc += len ) {
2058 charid = trie->charmap[ uvc ];
2060 SV* const * const svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 0);
2061 charid = svpp ? (U16)SvIV(*svpp) : 0;
2065 if ( !trie->trans[ state + charid ].next ) {
2066 trie->trans[ state + charid ].next = next_alloc;
2067 trie->trans[ state ].check++;
2068 prev_states[TRIE_NODENUM(next_alloc)]
2069 = TRIE_NODENUM(state);
2070 next_alloc += trie->uniquecharcount;
2072 state = trie->trans[ state + charid ].next;
2074 Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %"IVdf, uvc );
2076 /* charid is now 0 if we dont know the char read, or nonzero if we do */
2079 accept_state = TRIE_NODENUM( state );
2080 TRIE_HANDLE_WORD(accept_state);
2082 } /* end second pass */
2084 /* and now dump it out before we compress it */
2085 DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_table(trie, widecharmap,
2087 next_alloc, depth+1));
2091 * Inplace compress the table.*
2093 For sparse data sets the table constructed by the trie algorithm will
2094 be mostly 0/FAIL transitions or to put it another way mostly empty.
2095 (Note that leaf nodes will not contain any transitions.)
2097 This algorithm compresses the tables by eliminating most such
2098 transitions, at the cost of a modest bit of extra work during lookup:
2100 - Each states[] entry contains a .base field which indicates the
2101 index in the state[] array wheres its transition data is stored.
2103 - If .base is 0 there are no valid transitions from that node.
2105 - If .base is nonzero then charid is added to it to find an entry in
2108 -If trans[states[state].base+charid].check!=state then the
2109 transition is taken to be a 0/Fail transition. Thus if there are fail
2110 transitions at the front of the node then the .base offset will point
2111 somewhere inside the previous nodes data (or maybe even into a node
2112 even earlier), but the .check field determines if the transition is
2116 The following process inplace converts the table to the compressed
2117 table: We first do not compress the root node 1,and mark all its
2118 .check pointers as 1 and set its .base pointer as 1 as well. This
2119 allows us to do a DFA construction from the compressed table later,
2120 and ensures that any .base pointers we calculate later are greater
2123 - We set 'pos' to indicate the first entry of the second node.
2125 - We then iterate over the columns of the node, finding the first and
2126 last used entry at l and m. We then copy l..m into pos..(pos+m-l),
2127 and set the .check pointers accordingly, and advance pos
2128 appropriately and repreat for the next node. Note that when we copy
2129 the next pointers we have to convert them from the original
2130 NODEIDX form to NODENUM form as the former is not valid post
2133 - If a node has no transitions used we mark its base as 0 and do not
2134 advance the pos pointer.
2136 - If a node only has one transition we use a second pointer into the
2137 structure to fill in allocated fail transitions from other states.
2138 This pointer is independent of the main pointer and scans forward
2139 looking for null transitions that are allocated to a state. When it
2140 finds one it writes the single transition into the "hole". If the
2141 pointer doesnt find one the single transition is appended as normal.
2143 - Once compressed we can Renew/realloc the structures to release the
2146 See "Table-Compression Methods" in sec 3.9 of the Red Dragon,
2147 specifically Fig 3.47 and the associated pseudocode.
2151 const U32 laststate = TRIE_NODENUM( next_alloc );
2154 trie->statecount = laststate;
2156 for ( state = 1 ; state < laststate ; state++ ) {
2158 const U32 stateidx = TRIE_NODEIDX( state );
2159 const U32 o_used = trie->trans[ stateidx ].check;
2160 U32 used = trie->trans[ stateidx ].check;
2161 trie->trans[ stateidx ].check = 0;
2163 for ( charid = 0 ; used && charid < trie->uniquecharcount ; charid++ ) {
2164 if ( flag || trie->trans[ stateidx + charid ].next ) {
2165 if ( trie->trans[ stateidx + charid ].next ) {
2167 for ( ; zp < pos ; zp++ ) {
2168 if ( ! trie->trans[ zp ].next ) {
2172 trie->states[ state ].trans.base = zp + trie->uniquecharcount - charid ;
2173 trie->trans[ zp ].next = SAFE_TRIE_NODENUM( trie->trans[ stateidx + charid ].next );
2174 trie->trans[ zp ].check = state;
2175 if ( ++zp > pos ) pos = zp;
2182 trie->states[ state ].trans.base = pos + trie->uniquecharcount - charid ;
2184 trie->trans[ pos ].next = SAFE_TRIE_NODENUM( trie->trans[ stateidx + charid ].next );
2185 trie->trans[ pos ].check = state;
2190 trie->lasttrans = pos + 1;
2191 trie->states = (reg_trie_state *)
2192 PerlMemShared_realloc( trie->states, laststate
2193 * sizeof(reg_trie_state) );
2194 DEBUG_TRIE_COMPILE_MORE_r(
2195 PerlIO_printf( Perl_debug_log,
2196 "%*sAlloc: %d Orig: %"IVdf" elements, Final:%"IVdf". Savings of %%%5.2f\n",
2197 (int)depth * 2 + 2,"",
2198 (int)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1 ),
2201 ( ( next_alloc - pos ) * 100 ) / (double)next_alloc );
2204 } /* end table compress */
2206 DEBUG_TRIE_COMPILE_MORE_r(
2207 PerlIO_printf(Perl_debug_log, "%*sStatecount:%"UVxf" Lasttrans:%"UVxf"\n",
2208 (int)depth * 2 + 2, "",
2209 (UV)trie->statecount,
2210 (UV)trie->lasttrans)
2212 /* resize the trans array to remove unused space */
2213 trie->trans = (reg_trie_trans *)
2214 PerlMemShared_realloc( trie->trans, trie->lasttrans
2215 * sizeof(reg_trie_trans) );
2217 { /* Modify the program and insert the new TRIE node */
2218 U8 nodetype =(U8)(flags & 0xFF);
2222 regnode *optimize = NULL;
2223 #ifdef RE_TRACK_PATTERN_OFFSETS
2226 U32 mjd_nodelen = 0;
2227 #endif /* RE_TRACK_PATTERN_OFFSETS */
2228 #endif /* DEBUGGING */
2230 This means we convert either the first branch or the first Exact,
2231 depending on whether the thing following (in 'last') is a branch
2232 or not and whther first is the startbranch (ie is it a sub part of
2233 the alternation or is it the whole thing.)
2234 Assuming its a sub part we convert the EXACT otherwise we convert
2235 the whole branch sequence, including the first.
2237 /* Find the node we are going to overwrite */
2238 if ( first != startbranch || OP( last ) == BRANCH ) {
2239 /* branch sub-chain */
2240 NEXT_OFF( first ) = (U16)(last - first);
2241 #ifdef RE_TRACK_PATTERN_OFFSETS
2243 mjd_offset= Node_Offset((convert));
2244 mjd_nodelen= Node_Length((convert));
2247 /* whole branch chain */
2249 #ifdef RE_TRACK_PATTERN_OFFSETS
2252 const regnode *nop = NEXTOPER( convert );
2253 mjd_offset= Node_Offset((nop));
2254 mjd_nodelen= Node_Length((nop));
2258 PerlIO_printf(Perl_debug_log, "%*sMJD offset:%"UVuf" MJD length:%"UVuf"\n",
2259 (int)depth * 2 + 2, "",
2260 (UV)mjd_offset, (UV)mjd_nodelen)
2263 /* But first we check to see if there is a common prefix we can
2264 split out as an EXACT and put in front of the TRIE node. */
2265 trie->startstate= 1;
2266 if ( trie->bitmap && !widecharmap && !trie->jump ) {
2268 for ( state = 1 ; state < trie->statecount-1 ; state++ ) {
2272 const U32 base = trie->states[ state ].trans.base;
2274 if ( trie->states[state].wordnum )
2277 for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
2278 if ( ( base + ofs >= trie->uniquecharcount ) &&
2279 ( base + ofs - trie->uniquecharcount < trie->lasttrans ) &&
2280 trie->trans[ base + ofs - trie->uniquecharcount ].check == state )
2282 if ( ++count > 1 ) {
2283 SV **tmp = av_fetch( revcharmap, ofs, 0);
2284 const U8 *ch = (U8*)SvPV_nolen_const( *tmp );
2285 if ( state == 1 ) break;
2287 Zero(trie->bitmap, ANYOF_BITMAP_SIZE, char);
2289 PerlIO_printf(Perl_debug_log,
2290 "%*sNew Start State=%"UVuf" Class: [",
2291 (int)depth * 2 + 2, "",
2294 SV ** const tmp = av_fetch( revcharmap, idx, 0);
2295 const U8 * const ch = (U8*)SvPV_nolen_const( *tmp );
2297 TRIE_BITMAP_SET(trie,*ch);
2299 TRIE_BITMAP_SET(trie, folder[ *ch ]);
2301 PerlIO_printf(Perl_debug_log, "%s", (char*)ch)
2305 TRIE_BITMAP_SET(trie,*ch);
2307 TRIE_BITMAP_SET(trie,folder[ *ch ]);
2308 DEBUG_OPTIMISE_r(PerlIO_printf( Perl_debug_log,"%s", ch));
2314 SV **tmp = av_fetch( revcharmap, idx, 0);
2316 char *ch = SvPV( *tmp, len );
2318 SV *sv=sv_newmortal();
2319 PerlIO_printf( Perl_debug_log,
2320 "%*sPrefix State: %"UVuf" Idx:%"UVuf" Char='%s'\n",
2321 (int)depth * 2 + 2, "",
2323 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), 6,
2324 PL_colors[0], PL_colors[1],
2325 (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
2326 PERL_PV_ESCAPE_FIRSTCHAR
2331 OP( convert ) = nodetype;
2332 str=STRING(convert);
2335 STR_LEN(convert) += len;
2341 DEBUG_OPTIMISE_r(PerlIO_printf( Perl_debug_log,"]\n"));
2346 trie->prefixlen = (state-1);
2348 regnode *n = convert+NODE_SZ_STR(convert);
2349 NEXT_OFF(convert) = NODE_SZ_STR(convert);
2350 trie->startstate = state;
2351 trie->minlen -= (state - 1);
2352 trie->maxlen -= (state - 1);
2354 /* At least the UNICOS C compiler choked on this
2355 * being argument to DEBUG_r(), so let's just have
2358 #ifdef PERL_EXT_RE_BUILD
2364 regnode *fix = convert;
2365 U32 word = trie->wordcount;
2367 Set_Node_Offset_Length(convert, mjd_offset, state - 1);
2368 while( ++fix < n ) {
2369 Set_Node_Offset_Length(fix, 0, 0);
2372 SV ** const tmp = av_fetch( trie_words, word, 0 );
2374 if ( STR_LEN(convert) <= SvCUR(*tmp) )
2375 sv_chop(*tmp, SvPV_nolen(*tmp) + STR_LEN(convert));
2377 sv_chop(*tmp, SvPV_nolen(*tmp) + SvCUR(*tmp));
2385 NEXT_OFF(convert) = (U16)(tail - convert);
2386 DEBUG_r(optimize= n);
2392 if ( trie->maxlen ) {
2393 NEXT_OFF( convert ) = (U16)(tail - convert);
2394 ARG_SET( convert, data_slot );
2395 /* Store the offset to the first unabsorbed branch in
2396 jump[0], which is otherwise unused by the jump logic.
2397 We use this when dumping a trie and during optimisation. */
2399 trie->jump[0] = (U16)(nextbranch - convert);
2401 /* If the start state is not accepting (meaning there is no empty string/NOTHING)
2402 * and there is a bitmap
2403 * and the first "jump target" node we found leaves enough room
2404 * then convert the TRIE node into a TRIEC node, with the bitmap
2405 * embedded inline in the opcode - this is hypothetically faster.
2407 if ( !trie->states[trie->startstate].wordnum
2409 && ( (char *)jumper - (char *)convert) >= (int)sizeof(struct regnode_charclass) )
2411 OP( convert ) = TRIEC;
2412 Copy(trie->bitmap, ((struct regnode_charclass *)convert)->bitmap, ANYOF_BITMAP_SIZE, char);
2413 PerlMemShared_free(trie->bitmap);
2416 OP( convert ) = TRIE;
2418 /* store the type in the flags */
2419 convert->flags = nodetype;
2423 + regarglen[ OP( convert ) ];
2425 /* XXX We really should free up the resource in trie now,
2426 as we won't use them - (which resources?) dmq */
2428 /* needed for dumping*/
2429 DEBUG_r(if (optimize) {
2430 regnode *opt = convert;
2432 while ( ++opt < optimize) {
2433 Set_Node_Offset_Length(opt,0,0);
2436 Try to clean up some of the debris left after the
2439 while( optimize < jumper ) {
2440 mjd_nodelen += Node_Length((optimize));
2441 OP( optimize ) = OPTIMIZED;
2442 Set_Node_Offset_Length(optimize,0,0);
2445 Set_Node_Offset_Length(convert,mjd_offset,mjd_nodelen);
2447 } /* end node insert */
2449 /* Finish populating the prev field of the wordinfo array. Walk back
2450 * from each accept state until we find another accept state, and if
2451 * so, point the first word's .prev field at the second word. If the
2452 * second already has a .prev field set, stop now. This will be the
2453 * case either if we've already processed that word's accept state,
2454 * or that state had multiple words, and the overspill words were
2455 * already linked up earlier.
2462 for (word=1; word <= trie->wordcount; word++) {
2464 if (trie->wordinfo[word].prev)
2466 state = trie->wordinfo[word].accept;
2468 state = prev_states[state];
2471 prev = trie->states[state].wordnum;
2475 trie->wordinfo[word].prev = prev;
2477 Safefree(prev_states);
2481 /* and now dump out the compressed format */
2482 DEBUG_TRIE_COMPILE_r(dump_trie(trie, widecharmap, revcharmap, depth+1));
2484 RExC_rxi->data->data[ data_slot + 1 ] = (void*)widecharmap;
2486 RExC_rxi->data->data[ data_slot + TRIE_WORDS_OFFSET ] = (void*)trie_words;
2487 RExC_rxi->data->data[ data_slot + 3 ] = (void*)revcharmap;
2489 SvREFCNT_dec_NN(revcharmap);
2493 : trie->startstate>1
2499 S_make_trie_failtable(pTHX_ RExC_state_t *pRExC_state, regnode *source, regnode *stclass, U32 depth)
2501 /* The Trie is constructed and compressed now so we can build a fail array if it's needed
2503 This is basically the Aho-Corasick algorithm. Its from exercise 3.31 and 3.32 in the
2504 "Red Dragon" -- Compilers, principles, techniques, and tools. Aho, Sethi, Ullman 1985/88
2507 We find the fail state for each state in the trie, this state is the longest proper
2508 suffix of the current state's 'word' that is also a proper prefix of another word in our
2509 trie. State 1 represents the word '' and is thus the default fail state. This allows
2510 the DFA not to have to restart after its tried and failed a word at a given point, it
2511 simply continues as though it had been matching the other word in the first place.
2513 'abcdgu'=~/abcdefg|cdgu/
2514 When we get to 'd' we are still matching the first word, we would encounter 'g' which would
2515 fail, which would bring us to the state representing 'd' in the second word where we would
2516 try 'g' and succeed, proceeding to match 'cdgu'.
2518 /* add a fail transition */
2519 const U32 trie_offset = ARG(source);
2520 reg_trie_data *trie=(reg_trie_data *)RExC_rxi->data->data[trie_offset];
2522 const U32 ucharcount = trie->uniquecharcount;
2523 const U32 numstates = trie->statecount;
2524 const U32 ubound = trie->lasttrans + ucharcount;
2528 U32 base = trie->states[ 1 ].trans.base;
2531 const U32 data_slot = add_data( pRExC_state, 1, "T" );
2532 GET_RE_DEBUG_FLAGS_DECL;
2534 PERL_ARGS_ASSERT_MAKE_TRIE_FAILTABLE;
2536 PERL_UNUSED_ARG(depth);
2540 ARG_SET( stclass, data_slot );
2541 aho = (reg_ac_data *) PerlMemShared_calloc( 1, sizeof(reg_ac_data) );
2542 RExC_rxi->data->data[ data_slot ] = (void*)aho;
2543 aho->trie=trie_offset;
2544 aho->states=(reg_trie_state *)PerlMemShared_malloc( numstates * sizeof(reg_trie_state) );
2545 Copy( trie->states, aho->states, numstates, reg_trie_state );
2546 Newxz( q, numstates, U32);
2547 aho->fail = (U32 *) PerlMemShared_calloc( numstates, sizeof(U32) );
2550 /* initialize fail[0..1] to be 1 so that we always have
2551 a valid final fail state */
2552 fail[ 0 ] = fail[ 1 ] = 1;
2554 for ( charid = 0; charid < ucharcount ; charid++ ) {
2555 const U32 newstate = TRIE_TRANS_STATE( 1, base, ucharcount, charid, 0 );
2557 q[ q_write ] = newstate;
2558 /* set to point at the root */
2559 fail[ q[ q_write++ ] ]=1;
2562 while ( q_read < q_write) {
2563 const U32 cur = q[ q_read++ % numstates ];
2564 base = trie->states[ cur ].trans.base;
2566 for ( charid = 0 ; charid < ucharcount ; charid++ ) {
2567 const U32 ch_state = TRIE_TRANS_STATE( cur, base, ucharcount, charid, 1 );
2569 U32 fail_state = cur;
2572 fail_state = fail[ fail_state ];
2573 fail_base = aho->states[ fail_state ].trans.base;
2574 } while ( !TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 ) );
2576 fail_state = TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 );
2577 fail[ ch_state ] = fail_state;
2578 if ( !aho->states[ ch_state ].wordnum && aho->states[ fail_state ].wordnum )
2580 aho->states[ ch_state ].wordnum = aho->states[ fail_state ].wordnum;
2582 q[ q_write++ % numstates] = ch_state;
2586 /* restore fail[0..1] to 0 so that we "fall out" of the AC loop
2587 when we fail in state 1, this allows us to use the
2588 charclass scan to find a valid start char. This is based on the principle
2589 that theres a good chance the string being searched contains lots of stuff
2590 that cant be a start char.
2592 fail[ 0 ] = fail[ 1 ] = 0;
2593 DEBUG_TRIE_COMPILE_r({
2594 PerlIO_printf(Perl_debug_log,
2595 "%*sStclass Failtable (%"UVuf" states): 0",
2596 (int)(depth * 2), "", (UV)numstates
2598 for( q_read=1; q_read<numstates; q_read++ ) {
2599 PerlIO_printf(Perl_debug_log, ", %"UVuf, (UV)fail[q_read]);
2601 PerlIO_printf(Perl_debug_log, "\n");
2604 /*RExC_seen |= REG_SEEN_TRIEDFA;*/
2609 * There are strange code-generation bugs caused on sparc64 by gcc-2.95.2.
2610 * These need to be revisited when a newer toolchain becomes available.
2612 #if defined(__sparc64__) && defined(__GNUC__)
2613 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 96)
2614 # undef SPARC64_GCC_WORKAROUND
2615 # define SPARC64_GCC_WORKAROUND 1
2619 #define DEBUG_PEEP(str,scan,depth) \
2620 DEBUG_OPTIMISE_r({if (scan){ \
2621 SV * const mysv=sv_newmortal(); \
2622 regnode *Next = regnext(scan); \
2623 regprop(RExC_rx, mysv, scan); \
2624 PerlIO_printf(Perl_debug_log, "%*s" str ">%3d: %s (%d)\n", \
2625 (int)depth*2, "", REG_NODE_NUM(scan), SvPV_nolen_const(mysv),\
2626 Next ? (REG_NODE_NUM(Next)) : 0 ); \
2630 /* The below joins as many adjacent EXACTish nodes as possible into a single
2631 * one. The regop may be changed if the node(s) contain certain sequences that
2632 * require special handling. The joining is only done if:
2633 * 1) there is room in the current conglomerated node to entirely contain the
2635 * 2) they are the exact same node type
2637 * The adjacent nodes actually may be separated by NOTHING-kind nodes, and
2638 * these get optimized out
2640 * If a node is to match under /i (folded), the number of characters it matches
2641 * can be different than its character length if it contains a multi-character
2642 * fold. *min_subtract is set to the total delta of the input nodes.
2644 * And *has_exactf_sharp_s is set to indicate whether or not the node is EXACTF
2645 * and contains LATIN SMALL LETTER SHARP S
2647 * This is as good a place as any to discuss the design of handling these
2648 * multi-character fold sequences. It's been wrong in Perl for a very long
2649 * time. There are three code points in Unicode whose multi-character folds
2650 * were long ago discovered to mess things up. The previous designs for
2651 * dealing with these involved assigning a special node for them. This
2652 * approach doesn't work, as evidenced by this example:
2653 * "\xDFs" =~ /s\xDF/ui # Used to fail before these patches
2654 * Both these fold to "sss", but if the pattern is parsed to create a node that
2655 * would match just the \xDF, it won't be able to handle the case where a
2656 * successful match would have to cross the node's boundary. The new approach
2657 * that hopefully generally solves the problem generates an EXACTFU_SS node
2660 * It turns out that there are problems with all multi-character folds, and not
2661 * just these three. Now the code is general, for all such cases, but the
2662 * three still have some special handling. The approach taken is:
2663 * 1) This routine examines each EXACTFish node that could contain multi-
2664 * character fold sequences. It returns in *min_subtract how much to
2665 * subtract from the the actual length of the string to get a real minimum
2666 * match length; it is 0 if there are no multi-char folds. This delta is
2667 * used by the caller to adjust the min length of the match, and the delta
2668 * between min and max, so that the optimizer doesn't reject these
2669 * possibilities based on size constraints.
2670 * 2) Certain of these sequences require special handling by the trie code,
2671 * so, if found, this code changes the joined node type to special ops:
2672 * EXACTFU_TRICKYFOLD and EXACTFU_SS.
2673 * 3) For the sequence involving the Sharp s (\xDF), the node type EXACTFU_SS
2674 * is used for an EXACTFU node that contains at least one "ss" sequence in
2675 * it. For non-UTF-8 patterns and strings, this is the only case where
2676 * there is a possible fold length change. That means that a regular
2677 * EXACTFU node without UTF-8 involvement doesn't have to concern itself
2678 * with length changes, and so can be processed faster. regexec.c takes
2679 * advantage of this. Generally, an EXACTFish node that is in UTF-8 is
2680 * pre-folded by regcomp.c. This saves effort in regex matching.
2681 * However, the pre-folding isn't done for non-UTF8 patterns because the
2682 * fold of the MICRO SIGN requires UTF-8, and we don't want to slow things
2683 * down by forcing the pattern into UTF8 unless necessary. Also what
2684 * EXACTF and EXACTFL nodes fold to isn't known until runtime. The fold
2685 * possibilities for the non-UTF8 patterns are quite simple, except for
2686 * the sharp s. All the ones that don't involve a UTF-8 target string are
2687 * members of a fold-pair, and arrays are set up for all of them so that
2688 * the other member of the pair can be found quickly. Code elsewhere in
2689 * this file makes sure that in EXACTFU nodes, the sharp s gets folded to
2690 * 'ss', even if the pattern isn't UTF-8. This avoids the issues
2691 * described in the next item.
2692 * 4) A problem remains for the sharp s in EXACTF and EXACTFA nodes when the
2693 * pattern isn't in UTF-8. (BTW, there cannot be an EXACTF node with a
2694 * UTF-8 pattern.) An assumption that the optimizer part of regexec.c
2695 * (probably unwittingly, in Perl_regexec_flags()) makes is that a
2696 * character in the pattern corresponds to at most a single character in
2697 * the target string. (And I do mean character, and not byte here, unlike
2698 * other parts of the documentation that have never been updated to
2699 * account for multibyte Unicode.) sharp s in EXACTF nodes can match the
2700 * two character string 'ss'; in EXACTFA nodes it can match
2701 * "\x{17F}\x{17F}". These violate the assumption, and they are the only
2702 * instances where it is violated. I'm reluctant to try to change the
2703 * assumption, as the code involved is impenetrable to me (khw), so
2704 * instead the code here punts. This routine examines (when the pattern
2705 * isn't UTF-8) EXACTF and EXACTFA nodes for the sharp s, and returns a
2706 * boolean indicating whether or not the node contains a sharp s. When it
2707 * is true, the caller sets a flag that later causes the optimizer in this
2708 * file to not set values for the floating and fixed string lengths, and
2709 * thus avoids the optimizer code in regexec.c that makes the invalid
2710 * assumption. Thus, there is no optimization based on string lengths for
2711 * non-UTF8-pattern EXACTF and EXACTFA nodes that contain the sharp s.
2712 * (The reason the assumption is wrong only in these two cases is that all
2713 * other non-UTF-8 folds are 1-1; and, for UTF-8 patterns, we pre-fold all
2714 * other folds to their expanded versions. We can't prefold sharp s to
2715 * 'ss' in EXACTF nodes because we don't know at compile time if it
2716 * actually matches 'ss' or not. It will match iff the target string is
2717 * in UTF-8, unlike the EXACTFU nodes, where it always matches; and
2718 * EXACTFA and EXACTFL where it never does. In an EXACTFA node in a UTF-8
2719 * pattern, sharp s is folded to "\x{17F}\x{17F}, avoiding the problem;
2720 * but in a non-UTF8 pattern, folding it to that above-Latin1 string would
2721 * require the pattern to be forced into UTF-8, the overhead of which we
2725 #define JOIN_EXACT(scan,min_subtract,has_exactf_sharp_s, flags) \
2726 if (PL_regkind[OP(scan)] == EXACT) \
2727 join_exact(pRExC_state,(scan),(min_subtract),has_exactf_sharp_s, (flags),NULL,depth+1)
2730 S_join_exact(pTHX_ RExC_state_t *pRExC_state, regnode *scan, UV *min_subtract, bool *has_exactf_sharp_s, U32 flags,regnode *val, U32 depth) {
2731 /* Merge several consecutive EXACTish nodes into one. */
2732 regnode *n = regnext(scan);
2734 regnode *next = scan + NODE_SZ_STR(scan);
2738 regnode *stop = scan;
2739 GET_RE_DEBUG_FLAGS_DECL;
2741 PERL_UNUSED_ARG(depth);
2744 PERL_ARGS_ASSERT_JOIN_EXACT;
2745 #ifndef EXPERIMENTAL_INPLACESCAN
2746 PERL_UNUSED_ARG(flags);
2747 PERL_UNUSED_ARG(val);
2749 DEBUG_PEEP("join",scan,depth);
2751 /* Look through the subsequent nodes in the chain. Skip NOTHING, merge
2752 * EXACT ones that are mergeable to the current one. */
2754 && (PL_regkind[OP(n)] == NOTHING
2755 || (stringok && OP(n) == OP(scan)))
2757 && NEXT_OFF(scan) + NEXT_OFF(n) < I16_MAX)
2760 if (OP(n) == TAIL || n > next)
2762 if (PL_regkind[OP(n)] == NOTHING) {
2763 DEBUG_PEEP("skip:",n,depth);
2764 NEXT_OFF(scan) += NEXT_OFF(n);
2765 next = n + NODE_STEP_REGNODE;
2772 else if (stringok) {
2773 const unsigned int oldl = STR_LEN(scan);
2774 regnode * const nnext = regnext(n);
2776 /* XXX I (khw) kind of doubt that this works on platforms where
2777 * U8_MAX is above 255 because of lots of other assumptions */
2778 /* Don't join if the sum can't fit into a single node */
2779 if (oldl + STR_LEN(n) > U8_MAX)
2782 DEBUG_PEEP("merg",n,depth);
2785 NEXT_OFF(scan) += NEXT_OFF(n);
2786 STR_LEN(scan) += STR_LEN(n);
2787 next = n + NODE_SZ_STR(n);
2788 /* Now we can overwrite *n : */
2789 Move(STRING(n), STRING(scan) + oldl, STR_LEN(n), char);
2797 #ifdef EXPERIMENTAL_INPLACESCAN
2798 if (flags && !NEXT_OFF(n)) {
2799 DEBUG_PEEP("atch", val, depth);
2800 if (reg_off_by_arg[OP(n)]) {
2801 ARG_SET(n, val - n);
2804 NEXT_OFF(n) = val - n;
2812 *has_exactf_sharp_s = FALSE;
2814 /* Here, all the adjacent mergeable EXACTish nodes have been merged. We
2815 * can now analyze for sequences of problematic code points. (Prior to
2816 * this final joining, sequences could have been split over boundaries, and
2817 * hence missed). The sequences only happen in folding, hence for any
2818 * non-EXACT EXACTish node */
2819 if (OP(scan) != EXACT) {
2820 const U8 * const s0 = (U8*) STRING(scan);
2822 const U8 * const s_end = s0 + STR_LEN(scan);
2824 /* One pass is made over the node's string looking for all the
2825 * possibilities. to avoid some tests in the loop, there are two main
2826 * cases, for UTF-8 patterns (which can't have EXACTF nodes) and
2830 /* Examine the string for a multi-character fold sequence. UTF-8
2831 * patterns have all characters pre-folded by the time this code is
2833 while (s < s_end - 1) /* Can stop 1 before the end, as minimum
2834 length sequence we are looking for is 2 */
2837 int len = is_MULTI_CHAR_FOLD_utf8_safe(s, s_end);
2838 if (! len) { /* Not a multi-char fold: get next char */
2843 /* Nodes with 'ss' require special handling, except for EXACTFL
2844 * and EXACTFA for which there is no multi-char fold to this */
2845 if (len == 2 && *s == 's' && *(s+1) == 's'
2846 && OP(scan) != EXACTFL && OP(scan) != EXACTFA)
2849 OP(scan) = EXACTFU_SS;
2852 else if (len == 6 /* len is the same in both ASCII and EBCDIC
2854 && (memEQ(s, GREEK_SMALL_LETTER_IOTA_UTF8
2855 COMBINING_DIAERESIS_UTF8
2856 COMBINING_ACUTE_ACCENT_UTF8,
2858 || memEQ(s, GREEK_SMALL_LETTER_UPSILON_UTF8
2859 COMBINING_DIAERESIS_UTF8
2860 COMBINING_ACUTE_ACCENT_UTF8,
2865 /* These two folds require special handling by trie's, so
2866 * change the node type to indicate this. If EXACTFA and
2867 * EXACTFL were ever to be handled by trie's, this would
2868 * have to be changed. If this node has already been
2869 * changed to EXACTFU_SS in this loop, leave it as is. (I
2870 * (khw) think it doesn't matter in regexec.c for UTF
2871 * patterns, but no need to change it */
2872 if (OP(scan) == EXACTFU) {
2873 OP(scan) = EXACTFU_TRICKYFOLD;
2877 else { /* Here is a generic multi-char fold. */
2878 const U8* multi_end = s + len;
2880 /* Count how many characters in it. In the case of /l and
2881 * /aa, no folds which contain ASCII code points are
2882 * allowed, so check for those, and skip if found. (In
2883 * EXACTFL, no folds are allowed to any Latin1 code point,
2884 * not just ASCII. But there aren't any of these
2885 * currently, nor ever likely, so don't take the time to
2886 * test for them. The code that generates the
2887 * is_MULTI_foo() macros croaks should one actually get put
2888 * into Unicode .) */
2889 if (OP(scan) != EXACTFL && OP(scan) != EXACTFA) {
2890 count = utf8_length(s, multi_end);
2894 while (s < multi_end) {
2897 goto next_iteration;
2907 /* The delta is how long the sequence is minus 1 (1 is how long
2908 * the character that folds to the sequence is) */
2909 *min_subtract += count - 1;
2913 else if (OP(scan) == EXACTFA) {
2915 /* Non-UTF-8 pattern, EXACTFA node. There can't be a multi-char
2916 * fold to the ASCII range (and there are no existing ones in the
2917 * upper latin1 range). But, as outlined in the comments preceding
2918 * this function, we need to flag any occurrences of the sharp s */
2920 if (*s == LATIN_SMALL_LETTER_SHARP_S) {
2921 *has_exactf_sharp_s = TRUE;
2928 else if (OP(scan) != EXACTFL) {
2930 /* Non-UTF-8 pattern, not EXACTFA nor EXACTFL node. Look for the
2931 * multi-char folds that are all Latin1. (This code knows that
2932 * there are no current multi-char folds possible with EXACTFL,
2933 * relying on fold_grind.t to catch any errors if the very unlikely
2934 * event happens that some get added in future Unicode versions.)
2935 * As explained in the comments preceding this function, we look
2936 * also for the sharp s in EXACTF nodes; it can be in the final
2937 * position. Otherwise we can stop looking 1 byte earlier because
2938 * have to find at least two characters for a multi-fold */
2939 const U8* upper = (OP(scan) == EXACTF) ? s_end : s_end -1;
2941 /* The below is perhaps overboard, but this allows us to save a
2942 * test each time through the loop at the expense of a mask. This
2943 * is because on both EBCDIC and ASCII machines, 'S' and 's' differ
2944 * by a single bit. On ASCII they are 32 apart; on EBCDIC, they
2945 * are 64. This uses an exclusive 'or' to find that bit and then
2946 * inverts it to form a mask, with just a single 0, in the bit
2947 * position where 'S' and 's' differ. */
2948 const U8 S_or_s_mask = (U8) ~ ('S' ^ 's');
2949 const U8 s_masked = 's' & S_or_s_mask;
2952 int len = is_MULTI_CHAR_FOLD_latin1_safe(s, s_end);
2953 if (! len) { /* Not a multi-char fold. */
2954 if (*s == LATIN_SMALL_LETTER_SHARP_S && OP(scan) == EXACTF)
2956 *has_exactf_sharp_s = TRUE;
2963 && ((*s & S_or_s_mask) == s_masked)
2964 && ((*(s+1) & S_or_s_mask) == s_masked))
2967 /* EXACTF nodes need to know that the minimum length
2968 * changed so that a sharp s in the string can match this
2969 * ss in the pattern, but they remain EXACTF nodes, as they
2970 * won't match this unless the target string is is UTF-8,
2971 * which we don't know until runtime */
2972 if (OP(scan) != EXACTF) {
2973 OP(scan) = EXACTFU_SS;
2977 *min_subtract += len - 1;
2984 /* Allow dumping but overwriting the collection of skipped
2985 * ops and/or strings with fake optimized ops */
2986 n = scan + NODE_SZ_STR(scan);
2994 DEBUG_OPTIMISE_r(if (merged){DEBUG_PEEP("finl",scan,depth)});
2998 /* REx optimizer. Converts nodes into quicker variants "in place".
2999 Finds fixed substrings. */
3001 /* Stops at toplevel WHILEM as well as at "last". At end *scanp is set
3002 to the position after last scanned or to NULL. */
3004 #define INIT_AND_WITHP \
3005 assert(!and_withp); \
3006 Newx(and_withp,1,struct regnode_charclass_class); \
3007 SAVEFREEPV(and_withp)
3009 /* this is a chain of data about sub patterns we are processing that
3010 need to be handled separately/specially in study_chunk. Its so
3011 we can simulate recursion without losing state. */
3013 typedef struct scan_frame {
3014 regnode *last; /* last node to process in this frame */
3015 regnode *next; /* next node to process when last is reached */
3016 struct scan_frame *prev; /*previous frame*/
3017 I32 stop; /* what stopparen do we use */
3021 #define SCAN_COMMIT(s, data, m) scan_commit(s, data, m, is_inf)
3024 S_study_chunk(pTHX_ RExC_state_t *pRExC_state, regnode **scanp,
3025 I32 *minlenp, I32 *deltap,
3030 struct regnode_charclass_class *and_withp,
3031 U32 flags, U32 depth)
3032 /* scanp: Start here (read-write). */
3033 /* deltap: Write maxlen-minlen here. */
3034 /* last: Stop before this one. */
3035 /* data: string data about the pattern */
3036 /* stopparen: treat close N as END */
3037 /* recursed: which subroutines have we recursed into */
3038 /* and_withp: Valid if flags & SCF_DO_STCLASS_OR */
3041 I32 min = 0; /* There must be at least this number of characters to match */
3043 regnode *scan = *scanp, *next;
3045 int is_inf = (flags & SCF_DO_SUBSTR) && (data->flags & SF_IS_INF);
3046 int is_inf_internal = 0; /* The studied chunk is infinite */
3047 I32 is_par = OP(scan) == OPEN ? ARG(scan) : 0;
3048 scan_data_t data_fake;
3049 SV *re_trie_maxbuff = NULL;
3050 regnode *first_non_open = scan;
3051 I32 stopmin = I32_MAX;
3052 scan_frame *frame = NULL;
3053 GET_RE_DEBUG_FLAGS_DECL;
3055 PERL_ARGS_ASSERT_STUDY_CHUNK;
3058 StructCopy(&zero_scan_data, &data_fake, scan_data_t);
3062 while (first_non_open && OP(first_non_open) == OPEN)
3063 first_non_open=regnext(first_non_open);
3068 while ( scan && OP(scan) != END && scan < last ){
3069 UV min_subtract = 0; /* How mmany chars to subtract from the minimum
3070 node length to get a real minimum (because
3071 the folded version may be shorter) */
3072 bool has_exactf_sharp_s = FALSE;
3073 /* Peephole optimizer: */
3074 DEBUG_STUDYDATA("Peep:", data,depth);
3075 DEBUG_PEEP("Peep",scan,depth);
3077 /* Its not clear to khw or hv why this is done here, and not in the
3078 * clauses that deal with EXACT nodes. khw's guess is that it's
3079 * because of a previous design */
3080 JOIN_EXACT(scan,&min_subtract, &has_exactf_sharp_s, 0);
3082 /* Follow the next-chain of the current node and optimize
3083 away all the NOTHINGs from it. */
3084 if (OP(scan) != CURLYX) {
3085 const int max = (reg_off_by_arg[OP(scan)]
3087 /* I32 may be smaller than U16 on CRAYs! */
3088 : (I32_MAX < U16_MAX ? I32_MAX : U16_MAX));
3089 int off = (reg_off_by_arg[OP(scan)] ? ARG(scan) : NEXT_OFF(scan));
3093 /* Skip NOTHING and LONGJMP. */
3094 while ((n = regnext(n))
3095 && ((PL_regkind[OP(n)] == NOTHING && (noff = NEXT_OFF(n)))
3096 || ((OP(n) == LONGJMP) && (noff = ARG(n))))
3097 && off + noff < max)
3099 if (reg_off_by_arg[OP(scan)])
3102 NEXT_OFF(scan) = off;
3107 /* The principal pseudo-switch. Cannot be a switch, since we
3108 look into several different things. */
3109 if (OP(scan) == BRANCH || OP(scan) == BRANCHJ
3110 || OP(scan) == IFTHEN) {
3111 next = regnext(scan);
3113 /* demq: the op(next)==code check is to see if we have "branch-branch" AFAICT */
3115 if (OP(next) == code || code == IFTHEN) {
3116 /* NOTE - There is similar code to this block below for handling
3117 TRIE nodes on a re-study. If you change stuff here check there
3119 I32 max1 = 0, min1 = I32_MAX, num = 0;
3120 struct regnode_charclass_class accum;
3121 regnode * const startbranch=scan;
3123 if (flags & SCF_DO_SUBSTR)
3124 SCAN_COMMIT(pRExC_state, data, minlenp); /* Cannot merge strings after this. */
3125 if (flags & SCF_DO_STCLASS)
3126 cl_init_zero(pRExC_state, &accum);
3128 while (OP(scan) == code) {
3129 I32 deltanext, minnext, f = 0, fake;
3130 struct regnode_charclass_class this_class;
3133 data_fake.flags = 0;
3135 data_fake.whilem_c = data->whilem_c;
3136 data_fake.last_closep = data->last_closep;
3139 data_fake.last_closep = &fake;
3141 data_fake.pos_delta = delta;
3142 next = regnext(scan);
3143 scan = NEXTOPER(scan);
3145 scan = NEXTOPER(scan);
3146 if (flags & SCF_DO_STCLASS) {
3147 cl_init(pRExC_state, &this_class);
3148 data_fake.start_class = &this_class;
3149 f = SCF_DO_STCLASS_AND;
3151 if (flags & SCF_WHILEM_VISITED_POS)
3152 f |= SCF_WHILEM_VISITED_POS;
3154 /* we suppose the run is continuous, last=next...*/
3155 minnext = study_chunk(pRExC_state, &scan, minlenp, &deltanext,
3157 stopparen, recursed, NULL, f,depth+1);
3160 if (deltanext == I32_MAX) {
3161 is_inf = is_inf_internal = 1;
3163 } else if (max1 < minnext + deltanext)
3164 max1 = minnext + deltanext;
3166 if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
3168 if (data_fake.flags & SCF_SEEN_ACCEPT) {
3169 if ( stopmin > minnext)
3170 stopmin = min + min1;
3171 flags &= ~SCF_DO_SUBSTR;
3173 data->flags |= SCF_SEEN_ACCEPT;
3176 if (data_fake.flags & SF_HAS_EVAL)
3177 data->flags |= SF_HAS_EVAL;
3178 data->whilem_c = data_fake.whilem_c;
3180 if (flags & SCF_DO_STCLASS)
3181 cl_or(pRExC_state, &accum, &this_class);
3183 if (code == IFTHEN && num < 2) /* Empty ELSE branch */
3185 if (flags & SCF_DO_SUBSTR) {
3186 data->pos_min += min1;
3187 if (data->pos_delta >= I32_MAX - (max1 - min1))
3188 data->pos_delta = I32_MAX;
3190 data->pos_delta += max1 - min1;
3191 if (max1 != min1 || is_inf)
3192 data->longest = &(data->longest_float);
3195 if (delta == I32_MAX || I32_MAX - delta - (max1 - min1) < 0)
3198 delta += max1 - min1;
3199 if (flags & SCF_DO_STCLASS_OR) {
3200 cl_or(pRExC_state, data->start_class, &accum);
3202 cl_and(data->start_class, and_withp);
3203 flags &= ~SCF_DO_STCLASS;
3206 else if (flags & SCF_DO_STCLASS_AND) {
3208 cl_and(data->start_class, &accum);
3209 flags &= ~SCF_DO_STCLASS;
3212 /* Switch to OR mode: cache the old value of
3213 * data->start_class */
3215 StructCopy(data->start_class, and_withp,
3216 struct regnode_charclass_class);
3217 flags &= ~SCF_DO_STCLASS_AND;
3218 StructCopy(&accum, data->start_class,
3219 struct regnode_charclass_class);
3220 flags |= SCF_DO_STCLASS_OR;
3221 SET_SSC_EOS(data->start_class);
3225 if (PERL_ENABLE_TRIE_OPTIMISATION && OP( startbranch ) == BRANCH ) {
3228 Assuming this was/is a branch we are dealing with: 'scan' now
3229 points at the item that follows the branch sequence, whatever
3230 it is. We now start at the beginning of the sequence and look
3237 which would be constructed from a pattern like /A|LIST|OF|WORDS/
3239 If we can find such a subsequence we need to turn the first
3240 element into a trie and then add the subsequent branch exact
3241 strings to the trie.
3245 1. patterns where the whole set of branches can be converted.
3247 2. patterns where only a subset can be converted.
3249 In case 1 we can replace the whole set with a single regop
3250 for the trie. In case 2 we need to keep the start and end
3253 'BRANCH EXACT; BRANCH EXACT; BRANCH X'
3254 becomes BRANCH TRIE; BRANCH X;
3256 There is an additional case, that being where there is a
3257 common prefix, which gets split out into an EXACT like node
3258 preceding the TRIE node.
3260 If x(1..n)==tail then we can do a simple trie, if not we make
3261 a "jump" trie, such that when we match the appropriate word
3262 we "jump" to the appropriate tail node. Essentially we turn
3263 a nested if into a case structure of sorts.
3268 if (!re_trie_maxbuff) {
3269 re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
3270 if (!SvIOK(re_trie_maxbuff))
3271 sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
3273 if ( SvIV(re_trie_maxbuff)>=0 ) {
3275 regnode *first = (regnode *)NULL;
3276 regnode *last = (regnode *)NULL;
3277 regnode *tail = scan;
3282 SV * const mysv = sv_newmortal(); /* for dumping */
3284 /* var tail is used because there may be a TAIL
3285 regop in the way. Ie, the exacts will point to the
3286 thing following the TAIL, but the last branch will
3287 point at the TAIL. So we advance tail. If we
3288 have nested (?:) we may have to move through several
3292 while ( OP( tail ) == TAIL ) {
3293 /* this is the TAIL generated by (?:) */
3294 tail = regnext( tail );
3298 DEBUG_TRIE_COMPILE_r({
3299 regprop(RExC_rx, mysv, tail );
3300 PerlIO_printf( Perl_debug_log, "%*s%s%s\n",
3301 (int)depth * 2 + 2, "",
3302 "Looking for TRIE'able sequences. Tail node is: ",
3303 SvPV_nolen_const( mysv )
3309 Step through the branches
3310 cur represents each branch,
3311 noper is the first thing to be matched as part of that branch
3312 noper_next is the regnext() of that node.
3314 We normally handle a case like this /FOO[xyz]|BAR[pqr]/
3315 via a "jump trie" but we also support building with NOJUMPTRIE,
3316 which restricts the trie logic to structures like /FOO|BAR/.
3318 If noper is a trieable nodetype then the branch is a possible optimization
3319 target. If we are building under NOJUMPTRIE then we require that noper_next
3320 is the same as scan (our current position in the regex program).
3322 Once we have two or more consecutive such branches we can create a
3323 trie of the EXACT's contents and stitch it in place into the program.
3325 If the sequence represents all of the branches in the alternation we
3326 replace the entire thing with a single TRIE node.
3328 Otherwise when it is a subsequence we need to stitch it in place and
3329 replace only the relevant branches. This means the first branch has
3330 to remain as it is used by the alternation logic, and its next pointer,
3331 and needs to be repointed at the item on the branch chain following
3332 the last branch we have optimized away.
3334 This could be either a BRANCH, in which case the subsequence is internal,
3335 or it could be the item following the branch sequence in which case the
3336 subsequence is at the end (which does not necessarily mean the first node
3337 is the start of the alternation).
3339 TRIE_TYPE(X) is a define which maps the optype to a trietype.
3342 ----------------+-----------
3346 EXACTFU_SS | EXACTFU
3347 EXACTFU_TRICKYFOLD | EXACTFU
3352 #define TRIE_TYPE(X) ( ( NOTHING == (X) ) ? NOTHING : \
3353 ( EXACT == (X) ) ? EXACT : \
3354 ( EXACTFU == (X) || EXACTFU_SS == (X) || EXACTFU_TRICKYFOLD == (X) ) ? EXACTFU : \
3357 /* dont use tail as the end marker for this traverse */
3358 for ( cur = startbranch ; cur != scan ; cur = regnext( cur ) ) {
3359 regnode * const noper = NEXTOPER( cur );
3360 U8 noper_type = OP( noper );
3361 U8 noper_trietype = TRIE_TYPE( noper_type );
3362 #if defined(DEBUGGING) || defined(NOJUMPTRIE)
3363 regnode * const noper_next = regnext( noper );
3364 U8 noper_next_type = (noper_next && noper_next != tail) ? OP(noper_next) : 0;
3365 U8 noper_next_trietype = (noper_next && noper_next != tail) ? TRIE_TYPE( noper_next_type ) :0;
3368 DEBUG_TRIE_COMPILE_r({
3369 regprop(RExC_rx, mysv, cur);
3370 PerlIO_printf( Perl_debug_log, "%*s- %s (%d)",
3371 (int)depth * 2 + 2,"", SvPV_nolen_const( mysv ), REG_NODE_NUM(cur) );
3373 regprop(RExC_rx, mysv, noper);
3374 PerlIO_printf( Perl_debug_log, " -> %s",
3375 SvPV_nolen_const(mysv));
3378 regprop(RExC_rx, mysv, noper_next );
3379 PerlIO_printf( Perl_debug_log,"\t=> %s\t",
3380 SvPV_nolen_const(mysv));
3382 PerlIO_printf( Perl_debug_log, "(First==%d,Last==%d,Cur==%d,tt==%s,nt==%s,nnt==%s)\n",
3383 REG_NODE_NUM(first), REG_NODE_NUM(last), REG_NODE_NUM(cur),
3384 PL_reg_name[trietype], PL_reg_name[noper_trietype], PL_reg_name[noper_next_trietype]
3388 /* Is noper a trieable nodetype that can be merged with the
3389 * current trie (if there is one)? */
3393 ( noper_trietype == NOTHING)
3394 || ( trietype == NOTHING )
3395 || ( trietype == noper_trietype )
3398 && noper_next == tail
3402 /* Handle mergable triable node
3403 * Either we are the first node in a new trieable sequence,
3404 * in which case we do some bookkeeping, otherwise we update
3405 * the end pointer. */
3408 if ( noper_trietype == NOTHING ) {
3409 #if !defined(DEBUGGING) && !defined(NOJUMPTRIE)
3410 regnode * const noper_next = regnext( noper );
3411 U8 noper_next_type = (noper_next && noper_next!=tail) ? OP(noper_next) : 0;
3412 U8 noper_next_trietype = noper_next_type ? TRIE_TYPE( noper_next_type ) :0;
3415 if ( noper_next_trietype ) {
3416 trietype = noper_next_trietype;
3417 } else if (noper_next_type) {
3418 /* a NOTHING regop is 1 regop wide. We need at least two
3419 * for a trie so we can't merge this in */
3423 trietype = noper_trietype;
3426 if ( trietype == NOTHING )
3427 trietype = noper_trietype;
3432 } /* end handle mergable triable node */
3434 /* handle unmergable node -
3435 * noper may either be a triable node which can not be tried
3436 * together with the current trie, or a non triable node */
3438 /* If last is set and trietype is not NOTHING then we have found
3439 * at least two triable branch sequences in a row of a similar
3440 * trietype so we can turn them into a trie. If/when we
3441 * allow NOTHING to start a trie sequence this condition will be
3442 * required, and it isn't expensive so we leave it in for now. */
3443 if ( trietype && trietype != NOTHING )
3444 make_trie( pRExC_state,
3445 startbranch, first, cur, tail, count,
3446 trietype, depth+1 );
3447 last = NULL; /* note: we clear/update first, trietype etc below, so we dont do it here */
3451 && noper_next == tail
3454 /* noper is triable, so we can start a new trie sequence */
3457 trietype = noper_trietype;
3459 /* if we already saw a first but the current node is not triable then we have
3460 * to reset the first information. */
3465 } /* end handle unmergable node */
3466 } /* loop over branches */
3467 DEBUG_TRIE_COMPILE_r({
3468 regprop(RExC_rx, mysv, cur);
3469 PerlIO_printf( Perl_debug_log,
3470 "%*s- %s (%d) <SCAN FINISHED>\n", (int)depth * 2 + 2,
3471 "", SvPV_nolen_const( mysv ),REG_NODE_NUM(cur));
3474 if ( last && trietype ) {
3475 if ( trietype != NOTHING ) {
3476 /* the last branch of the sequence was part of a trie,
3477 * so we have to construct it here outside of the loop
3479 made= make_trie( pRExC_state, startbranch, first, scan, tail, count, trietype, depth+1 );
3480 #ifdef TRIE_STUDY_OPT
3481 if ( ((made == MADE_EXACT_TRIE &&
3482 startbranch == first)
3483 || ( first_non_open == first )) &&
3485 flags |= SCF_TRIE_RESTUDY;
3486 if ( startbranch == first
3489 RExC_seen &=~REG_TOP_LEVEL_BRANCHES;
3494 /* at this point we know whatever we have is a NOTHING sequence/branch
3495 * AND if 'startbranch' is 'first' then we can turn the whole thing into a NOTHING
3497 if ( startbranch == first ) {
3499 /* the entire thing is a NOTHING sequence, something like this:
3500 * (?:|) So we can turn it into a plain NOTHING op. */
3501 DEBUG_TRIE_COMPILE_r({
3502 regprop(RExC_rx, mysv, cur);
3503 PerlIO_printf( Perl_debug_log,
3504 "%*s- %s (%d) <NOTHING BRANCH SEQUENCE>\n", (int)depth * 2 + 2,
3505 "", SvPV_nolen_const( mysv ),REG_NODE_NUM(cur));
3508 OP(startbranch)= NOTHING;
3509 NEXT_OFF(startbranch)= tail - startbranch;
3510 for ( opt= startbranch + 1; opt < tail ; opt++ )
3514 } /* end if ( last) */
3515 } /* TRIE_MAXBUF is non zero */
3520 else if ( code == BRANCHJ ) { /* single branch is optimized. */
3521 scan = NEXTOPER(NEXTOPER(scan));
3522 } else /* single branch is optimized. */
3523 scan = NEXTOPER(scan);
3525 } else if (OP(scan) == SUSPEND || OP(scan) == GOSUB || OP(scan) == GOSTART) {
3526 scan_frame *newframe = NULL;
3531 if (OP(scan) != SUSPEND) {
3532 /* set the pointer */
3533 if (OP(scan) == GOSUB) {
3535 RExC_recurse[ARG2L(scan)] = scan;
3536 start = RExC_open_parens[paren-1];
3537 end = RExC_close_parens[paren-1];
3540 start = RExC_rxi->program + 1;
3544 Newxz(recursed, (((RExC_npar)>>3) +1), U8);
3545 SAVEFREEPV(recursed);
3547 if (!PAREN_TEST(recursed,paren+1)) {
3548 PAREN_SET(recursed,paren+1);
3549 Newx(newframe,1,scan_frame);
3551 if (flags & SCF_DO_SUBSTR) {
3552 SCAN_COMMIT(pRExC_state,data,minlenp);
3553 data->longest = &(data->longest_float);
3555 is_inf = is_inf_internal = 1;
3556 if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
3557 cl_anything(pRExC_state, data->start_class);
3558 flags &= ~SCF_DO_STCLASS;
3561 Newx(newframe,1,scan_frame);
3564 end = regnext(scan);
3569 SAVEFREEPV(newframe);
3570 newframe->next = regnext(scan);
3571 newframe->last = last;
3572 newframe->stop = stopparen;
3573 newframe->prev = frame;
3583 else if (OP(scan) == EXACT) {
3584 I32 l = STR_LEN(scan);
3587 const U8 * const s = (U8*)STRING(scan);
3588 uc = utf8_to_uvchr_buf(s, s + l, NULL);
3589 l = utf8_length(s, s + l);
3591 uc = *((U8*)STRING(scan));
3594 if (flags & SCF_DO_SUBSTR) { /* Update longest substr. */
3595 /* The code below prefers earlier match for fixed
3596 offset, later match for variable offset. */
3597 if (data->last_end == -1) { /* Update the start info. */
3598 data->last_start_min = data->pos_min;
3599 data->last_start_max = is_inf
3600 ? I32_MAX : data->pos_min + data->pos_delta;
3602 sv_catpvn(data->last_found, STRING(scan), STR_LEN(scan));
3604 SvUTF8_on(data->last_found);
3606 SV * const sv = data->last_found;
3607 MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
3608 mg_find(sv, PERL_MAGIC_utf8) : NULL;
3609 if (mg && mg->mg_len >= 0)
3610 mg->mg_len += utf8_length((U8*)STRING(scan),
3611 (U8*)STRING(scan)+STR_LEN(scan));
3613 data->last_end = data->pos_min + l;
3614 data->pos_min += l; /* As in the first entry. */
3615 data->flags &= ~SF_BEFORE_EOL;
3617 if (flags & SCF_DO_STCLASS_AND) {
3618 /* Check whether it is compatible with what we know already! */
3622 /* If compatible, we or it in below. It is compatible if is
3623 * in the bitmp and either 1) its bit or its fold is set, or 2)
3624 * it's for a locale. Even if there isn't unicode semantics
3625 * here, at runtime there may be because of matching against a
3626 * utf8 string, so accept a possible false positive for
3627 * latin1-range folds */
3629 (!(data->start_class->flags & ANYOF_LOCALE)
3630 && !ANYOF_BITMAP_TEST(data->start_class, uc)
3631 && (!(data->start_class->flags & ANYOF_LOC_FOLD)
3632 || !ANYOF_BITMAP_TEST(data->start_class, PL_fold_latin1[uc])))
3637 ANYOF_CLASS_ZERO(data->start_class);
3638 ANYOF_BITMAP_ZERO(data->start_class);
3640 ANYOF_BITMAP_SET(data->start_class, uc);
3641 else if (uc >= 0x100) {
3644 /* Some Unicode code points fold to the Latin1 range; as
3645 * XXX temporary code, instead of figuring out if this is
3646 * one, just assume it is and set all the start class bits
3647 * that could be some such above 255 code point's fold
3648 * which will generate fals positives. As the code
3649 * elsewhere that does compute the fold settles down, it
3650 * can be extracted out and re-used here */
3651 for (i = 0; i < 256; i++){
3652 if (HAS_NONLATIN1_FOLD_CLOSURE(i)) {
3653 ANYOF_BITMAP_SET(data->start_class, i);
3657 CLEAR_SSC_EOS(data->start_class);
3659 data->start_class->flags &= ~ANYOF_UNICODE_ALL;
3661 else if (flags & SCF_DO_STCLASS_OR) {
3662 /* false positive possible if the class is case-folded */
3664 ANYOF_BITMAP_SET(data->start_class, uc);
3666 data->start_class->flags |= ANYOF_UNICODE_ALL;
3667 CLEAR_SSC_EOS(data->start_class);
3668 cl_and(data->start_class, and_withp);
3670 flags &= ~SCF_DO_STCLASS;
3672 else if (PL_regkind[OP(scan)] == EXACT) { /* But OP != EXACT! */
3673 I32 l = STR_LEN(scan);
3674 UV uc = *((U8*)STRING(scan));
3676 /* Search for fixed substrings supports EXACT only. */
3677 if (flags & SCF_DO_SUBSTR) {
3679 SCAN_COMMIT(pRExC_state, data, minlenp);
3682 const U8 * const s = (U8 *)STRING(scan);
3683 uc = utf8_to_uvchr_buf(s, s + l, NULL);
3684 l = utf8_length(s, s + l);
3686 if (has_exactf_sharp_s) {
3687 RExC_seen |= REG_SEEN_EXACTF_SHARP_S;
3689 min += l - min_subtract;
3691 delta += min_subtract;
3692 if (flags & SCF_DO_SUBSTR) {
3693 data->pos_min += l - min_subtract;
3694 if (data->pos_min < 0) {
3697 data->pos_delta += min_subtract;
3699 data->longest = &(data->longest_float);
3702 if (flags & SCF_DO_STCLASS_AND) {
3703 /* Check whether it is compatible with what we know already! */
3706 (!(data->start_class->flags & ANYOF_LOCALE)
3707 && !ANYOF_BITMAP_TEST(data->start_class, uc)
3708 && !ANYOF_BITMAP_TEST(data->start_class, PL_fold_latin1[uc])))
3712 ANYOF_CLASS_ZERO(data->start_class);
3713 ANYOF_BITMAP_ZERO(data->start_class);
3715 ANYOF_BITMAP_SET(data->start_class, uc);
3716 CLEAR_SSC_EOS(data->start_class);
3717 if (OP(scan) == EXACTFL) {
3718 /* XXX This set is probably no longer necessary, and
3719 * probably wrong as LOCALE now is on in the initial
3721 data->start_class->flags |= ANYOF_LOCALE|ANYOF_LOC_FOLD;
3725 /* Also set the other member of the fold pair. In case
3726 * that unicode semantics is called for at runtime, use
3727 * the full latin1 fold. (Can't do this for locale,
3728 * because not known until runtime) */
3729 ANYOF_BITMAP_SET(data->start_class, PL_fold_latin1[uc]);
3731 /* All other (EXACTFL handled above) folds except under
3732 * /iaa that include s, S, and sharp_s also may include
3734 if (OP(scan) != EXACTFA) {
3735 if (uc == 's' || uc == 'S') {
3736 ANYOF_BITMAP_SET(data->start_class,
3737 LATIN_SMALL_LETTER_SHARP_S);
3739 else if (uc == LATIN_SMALL_LETTER_SHARP_S) {
3740 ANYOF_BITMAP_SET(data->start_class, 's');
3741 ANYOF_BITMAP_SET(data->start_class, 'S');
3746 else if (uc >= 0x100) {
3748 for (i = 0; i < 256; i++){
3749 if (_HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(i)) {
3750 ANYOF_BITMAP_SET(data->start_class, i);
3755 else if (flags & SCF_DO_STCLASS_OR) {
3756 if (data->start_class->flags & ANYOF_LOC_FOLD) {
3757 /* false positive possible if the class is case-folded.
3758 Assume that the locale settings are the same... */
3760 ANYOF_BITMAP_SET(data->start_class, uc);
3761 if (OP(scan) != EXACTFL) {
3763 /* And set the other member of the fold pair, but
3764 * can't do that in locale because not known until
3766 ANYOF_BITMAP_SET(data->start_class,
3767 PL_fold_latin1[uc]);
3769 /* All folds except under /iaa that include s, S,
3770 * and sharp_s also may include the others */
3771 if (OP(scan) != EXACTFA) {
3772 if (uc == 's' || uc == 'S') {
3773 ANYOF_BITMAP_SET(data->start_class,
3774 LATIN_SMALL_LETTER_SHARP_S);
3776 else if (uc == LATIN_SMALL_LETTER_SHARP_S) {
3777 ANYOF_BITMAP_SET(data->start_class, 's');
3778 ANYOF_BITMAP_SET(data->start_class, 'S');
3783 CLEAR_SSC_EOS(data->start_class);
3785 cl_and(data->start_class, and_withp);
3787 flags &= ~SCF_DO_STCLASS;
3789 else if (REGNODE_VARIES(OP(scan))) {
3790 I32 mincount, maxcount, minnext, deltanext, fl = 0;
3791 I32 f = flags, pos_before = 0;
3792 regnode * const oscan = scan;
3793 struct regnode_charclass_class this_class;
3794 struct regnode_charclass_class *oclass = NULL;
3795 I32 next_is_eval = 0;
3797 switch (PL_regkind[OP(scan)]) {
3798 case WHILEM: /* End of (?:...)* . */
3799 scan = NEXTOPER(scan);
3802 if (flags & (SCF_DO_SUBSTR | SCF_DO_STCLASS)) {
3803 next = NEXTOPER(scan);
3804 if (OP(next) == EXACT || (flags & SCF_DO_STCLASS)) {
3806 maxcount = REG_INFTY;
3807 next = regnext(scan);
3808 scan = NEXTOPER(scan);
3812 if (flags & SCF_DO_SUBSTR)
3817 if (flags & SCF_DO_STCLASS) {
3819 maxcount = REG_INFTY;
3820 next = regnext(scan);
3821 scan = NEXTOPER(scan);
3824 is_inf = is_inf_internal = 1;
3825 scan = regnext(scan);
3826 if (flags & SCF_DO_SUBSTR) {
3827 SCAN_COMMIT(pRExC_state, data, minlenp); /* Cannot extend fixed substrings */
3828 data->longest = &(data->longest_float);
3830 goto optimize_curly_tail;
3832 if (stopparen>0 && (OP(scan)==CURLYN || OP(scan)==CURLYM)
3833 && (scan->flags == stopparen))
3838 mincount = ARG1(scan);
3839 maxcount = ARG2(scan);
3841 next = regnext(scan);
3842 if (OP(scan) == CURLYX) {
3843 I32 lp = (data ? *(data->last_closep) : 0);
3844 scan->flags = ((lp <= (I32)U8_MAX) ? (U8)lp : U8_MAX);
3846 scan = NEXTOPER(scan) + EXTRA_STEP_2ARGS;
3847 next_is_eval = (OP(scan) == EVAL);
3849 if (flags & SCF_DO_SUBSTR) {
3850 if (mincount == 0) SCAN_COMMIT(pRExC_state,data,minlenp); /* Cannot extend fixed substrings */
3851 pos_before = data->pos_min;
3855 data->flags &= ~(SF_HAS_PAR|SF_IN_PAR|SF_HAS_EVAL);
3857 data->flags |= SF_IS_INF;
3859 if (flags & SCF_DO_STCLASS) {
3860 cl_init(pRExC_state, &this_class);
3861 oclass = data->start_class;
3862 data->start_class = &this_class;
3863 f |= SCF_DO_STCLASS_AND;
3864 f &= ~SCF_DO_STCLASS_OR;
3866 /* Exclude from super-linear cache processing any {n,m}
3867 regops for which the combination of input pos and regex
3868 pos is not enough information to determine if a match
3871 For example, in the regex /foo(bar\s*){4,8}baz/ with the
3872 regex pos at the \s*, the prospects for a match depend not
3873 only on the input position but also on how many (bar\s*)
3874 repeats into the {4,8} we are. */
3875 if ((mincount > 1) || (maxcount > 1 && maxcount != REG_INFTY))
3876 f &= ~SCF_WHILEM_VISITED_POS;
3878 /* This will finish on WHILEM, setting scan, or on NULL: */
3879 minnext = study_chunk(pRExC_state, &scan, minlenp, &deltanext,
3880 last, data, stopparen, recursed, NULL,
3882 ? (f & ~SCF_DO_SUBSTR) : f),depth+1);
3884 if (flags & SCF_DO_STCLASS)
3885 data->start_class = oclass;
3886 if (mincount == 0 || minnext == 0) {
3887 if (flags & SCF_DO_STCLASS_OR) {
3888 cl_or(pRExC_state, data->start_class, &this_class);
3890 else if (flags & SCF_DO_STCLASS_AND) {
3891 /* Switch to OR mode: cache the old value of
3892 * data->start_class */
3894 StructCopy(data->start_class, and_withp,
3895 struct regnode_charclass_class);
3896 flags &= ~SCF_DO_STCLASS_AND;
3897 StructCopy(&this_class, data->start_class,
3898 struct regnode_charclass_class);
3899 flags |= SCF_DO_STCLASS_OR;
3900 SET_SSC_EOS(data->start_class);
3902 } else { /* Non-zero len */
3903 if (flags & SCF_DO_STCLASS_OR) {
3904 cl_or(pRExC_state, data->start_class, &this_class);
3905 cl_and(data->start_class, and_withp);
3907 else if (flags & SCF_DO_STCLASS_AND)
3908 cl_and(data->start_class, &this_class);
3909 flags &= ~SCF_DO_STCLASS;
3911 if (!scan) /* It was not CURLYX, but CURLY. */
3913 if (!(flags & SCF_TRIE_DOING_RESTUDY)
3914 /* ? quantifier ok, except for (?{ ... }) */
3915 && (next_is_eval || !(mincount == 0 && maxcount == 1))
3916 && (minnext == 0) && (deltanext == 0)
3917 && data && !(data->flags & (SF_HAS_PAR|SF_IN_PAR))
3918 && maxcount <= REG_INFTY/3) /* Complement check for big count */
3920 /* Fatal warnings may leak the regexp without this: */
3921 SAVEFREESV(RExC_rx_sv);
3922 ckWARNreg(RExC_parse,
3923 "Quantifier unexpected on zero-length expression");
3924 (void)ReREFCNT_inc(RExC_rx_sv);
3927 min += minnext * mincount;
3928 is_inf_internal |= deltanext == I32_MAX
3929 || (maxcount == REG_INFTY && minnext + deltanext > 0);
3930 is_inf |= is_inf_internal;
3934 delta += (minnext + deltanext) * maxcount - minnext * mincount;
3936 /* Try powerful optimization CURLYX => CURLYN. */
3937 if ( OP(oscan) == CURLYX && data
3938 && data->flags & SF_IN_PAR
3939 && !(data->flags & SF_HAS_EVAL)
3940 && !deltanext && minnext == 1 ) {
3941 /* Try to optimize to CURLYN. */
3942 regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS;
3943 regnode * const nxt1 = nxt;
3950 if (!REGNODE_SIMPLE(OP(nxt))
3951 && !(PL_regkind[OP(nxt)] == EXACT
3952 && STR_LEN(nxt) == 1))
3958 if (OP(nxt) != CLOSE)
3960 if (RExC_open_parens) {
3961 RExC_open_parens[ARG(nxt1)-1]=oscan; /*open->CURLYM*/
3962 RExC_close_parens[ARG(nxt1)-1]=nxt+2; /*close->while*/
3964 /* Now we know that nxt2 is the only contents: */
3965 oscan->flags = (U8)ARG(nxt);
3967 OP(nxt1) = NOTHING; /* was OPEN. */
3970 OP(nxt1 + 1) = OPTIMIZED; /* was count. */
3971 NEXT_OFF(nxt1+ 1) = 0; /* just for consistency. */
3972 NEXT_OFF(nxt2) = 0; /* just for consistency with CURLY. */
3973 OP(nxt) = OPTIMIZED; /* was CLOSE. */
3974 OP(nxt + 1) = OPTIMIZED; /* was count. */
3975 NEXT_OFF(nxt+ 1) = 0; /* just for consistency. */
3980 /* Try optimization CURLYX => CURLYM. */
3981 if ( OP(oscan) == CURLYX && data
3982 && !(data->flags & SF_HAS_PAR)
3983 && !(data->flags & SF_HAS_EVAL)
3984 && !deltanext /* atom is fixed width */
3985 && minnext != 0 /* CURLYM can't handle zero width */
3986 && ! (RExC_seen & REG_SEEN_EXACTF_SHARP_S) /* Nor \xDF */
3988 /* XXXX How to optimize if data == 0? */
3989 /* Optimize to a simpler form. */
3990 regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN */
3994 while ( (nxt2 = regnext(nxt)) /* skip over embedded stuff*/
3995 && (OP(nxt2) != WHILEM))
3997 OP(nxt2) = SUCCEED; /* Whas WHILEM */
3998 /* Need to optimize away parenths. */
3999 if ((data->flags & SF_IN_PAR) && OP(nxt) == CLOSE) {
4000 /* Set the parenth number. */
4001 regnode *nxt1 = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN*/
4003 oscan->flags = (U8)ARG(nxt);
4004 if (RExC_open_parens) {
4005 RExC_open_parens[ARG(nxt1)-1]=oscan; /*open->CURLYM*/
4006 RExC_close_parens[ARG(nxt1)-1]=nxt2+1; /*close->NOTHING*/
4008 OP(nxt1) = OPTIMIZED; /* was OPEN. */
4009 OP(nxt) = OPTIMIZED; /* was CLOSE. */
4012 OP(nxt1 + 1) = OPTIMIZED; /* was count. */
4013 OP(nxt + 1) = OPTIMIZED; /* was count. */
4014 NEXT_OFF(nxt1 + 1) = 0; /* just for consistency. */
4015 NEXT_OFF(nxt + 1) = 0; /* just for consistency. */
4018 while ( nxt1 && (OP(nxt1) != WHILEM)) {
4019 regnode *nnxt = regnext(nxt1);
4021 if (reg_off_by_arg[OP(nxt1)])
4022 ARG_SET(nxt1, nxt2 - nxt1);
4023 else if (nxt2 - nxt1 < U16_MAX)
4024 NEXT_OFF(nxt1) = nxt2 - nxt1;
4026 OP(nxt) = NOTHING; /* Cannot beautify */
4031 /* Optimize again: */
4032 study_chunk(pRExC_state, &nxt1, minlenp, &deltanext, nxt,
4033 NULL, stopparen, recursed, NULL, 0,depth+1);
4038 else if ((OP(oscan) == CURLYX)
4039 && (flags & SCF_WHILEM_VISITED_POS)
4040 /* See the comment on a similar expression above.
4041 However, this time it's not a subexpression
4042 we care about, but the expression itself. */
4043 && (maxcount == REG_INFTY)
4044 && data && ++data->whilem_c < 16) {
4045 /* This stays as CURLYX, we can put the count/of pair. */
4046 /* Find WHILEM (as in regexec.c) */
4047 regnode *nxt = oscan + NEXT_OFF(oscan);
4049 if (OP(PREVOPER(nxt)) == NOTHING) /* LONGJMP */
4051 PREVOPER(nxt)->flags = (U8)(data->whilem_c
4052 | (RExC_whilem_seen << 4)); /* On WHILEM */
4054 if (data && fl & (SF_HAS_PAR|SF_IN_PAR))
4056 if (flags & SCF_DO_SUBSTR) {
4057 SV *last_str = NULL;
4058 int counted = mincount != 0;
4060 if (data->last_end > 0 && mincount != 0) { /* Ends with a string. */
4061 #if defined(SPARC64_GCC_WORKAROUND)
4064 const char *s = NULL;
4067 if (pos_before >= data->last_start_min)
4070 b = data->last_start_min;
4073 s = SvPV_const(data->last_found, l);
4074 old = b - data->last_start_min;
4077 I32 b = pos_before >= data->last_start_min
4078 ? pos_before : data->last_start_min;
4080 const char * const s = SvPV_const(data->last_found, l);
4081 I32 old = b - data->last_start_min;
4085 old = utf8_hop((U8*)s, old) - (U8*)s;
4087 /* Get the added string: */
4088 last_str = newSVpvn_utf8(s + old, l, UTF);
4089 if (deltanext == 0 && pos_before == b) {
4090 /* What was added is a constant string */
4092 SvGROW(last_str, (mincount * l) + 1);
4093 repeatcpy(SvPVX(last_str) + l,
4094 SvPVX_const(last_str), l, mincount - 1);
4095 SvCUR_set(last_str, SvCUR(last_str) * mincount);
4096 /* Add additional parts. */
4097 SvCUR_set(data->last_found,
4098 SvCUR(data->last_found) - l);
4099 sv_catsv(data->last_found, last_str);
4101 SV * sv = data->last_found;
4103 SvUTF8(sv) && SvMAGICAL(sv) ?
4104 mg_find(sv, PERL_MAGIC_utf8) : NULL;
4105 if (mg && mg->mg_len >= 0)
4106 mg->mg_len += CHR_SVLEN(last_str) - l;
4108 data->last_end += l * (mincount - 1);
4111 /* start offset must point into the last copy */
4112 data->last_start_min += minnext * (mincount - 1);
4113 data->last_start_max += is_inf ? I32_MAX
4114 : (maxcount - 1) * (minnext + data->pos_delta);
4117 /* It is counted once already... */
4118 data->pos_min += minnext * (mincount - counted);
4120 PerlIO_printf(Perl_debug_log, "counted=%d deltanext=%d I32_MAX=%d minnext=%d maxcount=%d mincount=%d\n",
4121 counted, deltanext, I32_MAX, minnext, maxcount, mincount);
4122 if (deltanext != I32_MAX)
4123 PerlIO_printf(Perl_debug_log, "LHS=%d RHS=%d\n", -counted * deltanext + (minnext + deltanext) * maxcount - minnext * mincount, I32_MAX - data->pos_delta);
4125 if (deltanext == I32_MAX || -counted * deltanext + (minnext + deltanext) * maxcount - minnext * mincount >= I32_MAX - data->pos_delta)
4126 data->pos_delta = I32_MAX;
4128 data->pos_delta += - counted * deltanext +
4129 (minnext + deltanext) * maxcount - minnext * mincount;
4130 if (mincount != maxcount) {
4131 /* Cannot extend fixed substrings found inside
4133 SCAN_COMMIT(pRExC_state,data,minlenp);
4134 if (mincount && last_str) {
4135 SV * const sv = data->last_found;
4136 MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
4137 mg_find(sv, PERL_MAGIC_utf8) : NULL;
4141 sv_setsv(sv, last_str);
4142 data->last_end = data->pos_min;
4143 data->last_start_min =
4144 data->pos_min - CHR_SVLEN(last_str);
4145 data->last_start_max = is_inf
4147 : data->pos_min + data->pos_delta
4148 - CHR_SVLEN(last_str);
4150 data->longest = &(data->longest_float);
4152 SvREFCNT_dec(last_str);
4154 if (data && (fl & SF_HAS_EVAL))
4155 data->flags |= SF_HAS_EVAL;
4156 optimize_curly_tail:
4157 if (OP(oscan) != CURLYX) {
4158 while (PL_regkind[OP(next = regnext(oscan))] == NOTHING
4160 NEXT_OFF(oscan) += NEXT_OFF(next);
4163 default: /* REF, and CLUMP only? */
4164 if (flags & SCF_DO_SUBSTR) {
4165 SCAN_COMMIT(pRExC_state,data,minlenp); /* Cannot expect anything... */
4166 data->longest = &(data->longest_float);
4168 is_inf = is_inf_internal = 1;
4169 if (flags & SCF_DO_STCLASS_OR)
4170 cl_anything(pRExC_state, data->start_class);
4171 flags &= ~SCF_DO_STCLASS;
4175 else if (OP(scan) == LNBREAK) {
4176 if (flags & SCF_DO_STCLASS) {
4178 CLEAR_SSC_EOS(data->start_class); /* No match on empty */
4179 if (flags & SCF_DO_STCLASS_AND) {
4180 for (value = 0; value < 256; value++)
4181 if (!is_VERTWS_cp(value))
4182 ANYOF_BITMAP_CLEAR(data->start_class, value);
4185 for (value = 0; value < 256; value++)
4186 if (is_VERTWS_cp(value))
4187 ANYOF_BITMAP_SET(data->start_class, value);
4189 if (flags & SCF_DO_STCLASS_OR)
4190 cl_and(data->start_class, and_withp);
4191 flags &= ~SCF_DO_STCLASS;
4194 delta++; /* Because of the 2 char string cr-lf */
4195 if (flags & SCF_DO_SUBSTR) {
4196 SCAN_COMMIT(pRExC_state,data,minlenp); /* Cannot expect anything... */
4198 data->pos_delta += 1;
4199 data->longest = &(data->longest_float);
4202 else if (REGNODE_SIMPLE(OP(scan))) {
4205 if (flags & SCF_DO_SUBSTR) {
4206 SCAN_COMMIT(pRExC_state,data,minlenp);
4210 if (flags & SCF_DO_STCLASS) {
4212 CLEAR_SSC_EOS(data->start_class); /* No match on empty */
4214 /* Some of the logic below assumes that switching
4215 locale on will only add false positives. */
4216 switch (PL_regkind[OP(scan)]) {
4222 Perl_croak(aTHX_ "panic: unexpected simple REx opcode %d", OP(scan));
4225 if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
4226 cl_anything(pRExC_state, data->start_class);
4229 if (OP(scan) == SANY)
4231 if (flags & SCF_DO_STCLASS_OR) { /* Everything but \n */
4232 value = (ANYOF_BITMAP_TEST(data->start_class,'\n')
4233 || ANYOF_CLASS_TEST_ANY_SET(data->start_class));
4234 cl_anything(pRExC_state, data->start_class);
4236 if (flags & SCF_DO_STCLASS_AND || !value)
4237 ANYOF_BITMAP_CLEAR(data->start_class,'\n');
4240 if (flags & SCF_DO_STCLASS_AND)
4241 cl_and(data->start_class,
4242 (struct regnode_charclass_class*)scan);
4244 cl_or(pRExC_state, data->start_class,
4245 (struct regnode_charclass_class*)scan);
4253 classnum = FLAGS(scan);
4254 if (flags & SCF_DO_STCLASS_AND) {
4255 if (!(data->start_class->flags & ANYOF_LOCALE)) {
4256 ANYOF_CLASS_CLEAR(data->start_class, classnum_to_namedclass(classnum) + 1);
4257 for (value = 0; value < loop_max; value++) {
4258 if (! _generic_isCC(UNI_TO_NATIVE(value), classnum)) {
4259 ANYOF_BITMAP_CLEAR(data->start_class, UNI_TO_NATIVE(value));
4265 if (data->start_class->flags & ANYOF_LOCALE) {
4266 ANYOF_CLASS_SET(data->start_class, classnum_to_namedclass(classnum));
4270 /* Even if under locale, set the bits for non-locale
4271 * in case it isn't a true locale-node. This will
4272 * create false positives if it truly is locale */
4273 for (value = 0; value < loop_max; value++) {
4274 if (_generic_isCC(UNI_TO_NATIVE(value), classnum)) {
4275 ANYOF_BITMAP_SET(data->start_class, UNI_TO_NATIVE(value));
4287 classnum = FLAGS(scan);
4288 if (flags & SCF_DO_STCLASS_AND) {
4289 if (!(data->start_class->flags & ANYOF_LOCALE)) {
4290 ANYOF_CLASS_CLEAR(data->start_class, classnum_to_namedclass(classnum));
4291 for (value = 0; value < loop_max; value++) {
4292 if (_generic_isCC(UNI_TO_NATIVE(value), classnum)) {
4293 ANYOF_BITMAP_CLEAR(data->start_class, UNI_TO_NATIVE(value));
4299 if (data->start_class->flags & ANYOF_LOCALE) {
4300 ANYOF_CLASS_SET(data->start_class, classnum_to_namedclass(classnum) + 1);
4304 /* Even if under locale, set the bits for non-locale in
4305 * case it isn't a true locale-node. This will create
4306 * false positives if it truly is locale */
4307 for (value = 0; value < loop_max; value++) {
4308 if (! _generic_isCC(UNI_TO_NATIVE(value), classnum)) {
4309 ANYOF_BITMAP_SET(data->start_class, UNI_TO_NATIVE(value));
4312 if (PL_regkind[OP(scan)] == NPOSIXD) {
4313 data->start_class->flags |= ANYOF_NON_UTF8_LATIN1_ALL;
4319 if (flags & SCF_DO_STCLASS_OR)
4320 cl_and(data->start_class, and_withp);
4321 flags &= ~SCF_DO_STCLASS;
4324 else if (PL_regkind[OP(scan)] == EOL && flags & SCF_DO_SUBSTR) {
4325 data->flags |= (OP(scan) == MEOL
4328 SCAN_COMMIT(pRExC_state, data, minlenp);
4331 else if ( PL_regkind[OP(scan)] == BRANCHJ
4332 /* Lookbehind, or need to calculate parens/evals/stclass: */
4333 && (scan->flags || data || (flags & SCF_DO_STCLASS))
4334 && (OP(scan) == IFMATCH || OP(scan) == UNLESSM)) {
4335 if ( OP(scan) == UNLESSM &&
4337 OP(NEXTOPER(NEXTOPER(scan))) == NOTHING &&
4338 OP(regnext(NEXTOPER(NEXTOPER(scan)))) == SUCCEED
4341 regnode *upto= regnext(scan);
4343 SV * const mysv_val=sv_newmortal();
4344 DEBUG_STUDYDATA("OPFAIL",data,depth);
4346 /*DEBUG_PARSE_MSG("opfail");*/
4347 regprop(RExC_rx, mysv_val, upto);
4348 PerlIO_printf(Perl_debug_log, "~ replace with OPFAIL pointed at %s (%"IVdf") offset %"IVdf"\n",
4349 SvPV_nolen_const(mysv_val),
4350 (IV)REG_NODE_NUM(upto),
4355 NEXT_OFF(scan) = upto - scan;
4356 for (opt= scan + 1; opt < upto ; opt++)
4357 OP(opt) = OPTIMIZED;
4361 if ( !PERL_ENABLE_POSITIVE_ASSERTION_STUDY
4362 || OP(scan) == UNLESSM )
4364 /* Negative Lookahead/lookbehind
4365 In this case we can't do fixed string optimisation.
4368 I32 deltanext, minnext, fake = 0;
4370 struct regnode_charclass_class intrnl;
4373 data_fake.flags = 0;
4375 data_fake.whilem_c = data->whilem_c;
4376 data_fake.last_closep = data->last_closep;
4379 data_fake.last_closep = &fake;
4380 data_fake.pos_delta = delta;
4381 if ( flags & SCF_DO_STCLASS && !scan->flags
4382 && OP(scan) == IFMATCH ) { /* Lookahead */
4383 cl_init(pRExC_state, &intrnl);
4384 data_fake.start_class = &intrnl;
4385 f |= SCF_DO_STCLASS_AND;
4387 if (flags & SCF_WHILEM_VISITED_POS)
4388 f |= SCF_WHILEM_VISITED_POS;
4389 next = regnext(scan);
4390 nscan = NEXTOPER(NEXTOPER(scan));
4391 minnext = study_chunk(pRExC_state, &nscan, minlenp, &deltanext,
4392 last, &data_fake, stopparen, recursed, NULL, f, depth+1);
4395 FAIL("Variable length lookbehind not implemented");
4397 else if (minnext > (I32)U8_MAX) {
4398 FAIL2("Lookbehind longer than %"UVuf" not implemented", (UV)U8_MAX);
4400 scan->flags = (U8)minnext;
4403 if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4405 if (data_fake.flags & SF_HAS_EVAL)
4406 data->flags |= SF_HAS_EVAL;
4407 data->whilem_c = data_fake.whilem_c;
4409 if (f & SCF_DO_STCLASS_AND) {
4410 if (flags & SCF_DO_STCLASS_OR) {
4411 /* OR before, AND after: ideally we would recurse with
4412 * data_fake to get the AND applied by study of the
4413 * remainder of the pattern, and then derecurse;
4414 * *** HACK *** for now just treat as "no information".
4415 * See [perl #56690].
4417 cl_init(pRExC_state, data->start_class);
4419 /* AND before and after: combine and continue */
4420 const int was = TEST_SSC_EOS(data->start_class);
4422 cl_and(data->start_class, &intrnl);
4424 SET_SSC_EOS(data->start_class);
4428 #if PERL_ENABLE_POSITIVE_ASSERTION_STUDY
4430 /* Positive Lookahead/lookbehind
4431 In this case we can do fixed string optimisation,
4432 but we must be careful about it. Note in the case of
4433 lookbehind the positions will be offset by the minimum
4434 length of the pattern, something we won't know about
4435 until after the recurse.
4437 I32 deltanext, fake = 0;
4439 struct regnode_charclass_class intrnl;
4441 /* We use SAVEFREEPV so that when the full compile
4442 is finished perl will clean up the allocated
4443 minlens when it's all done. This way we don't
4444 have to worry about freeing them when we know
4445 they wont be used, which would be a pain.
4448 Newx( minnextp, 1, I32 );
4449 SAVEFREEPV(minnextp);
4452 StructCopy(data, &data_fake, scan_data_t);
4453 if ((flags & SCF_DO_SUBSTR) && data->last_found) {
4456 SCAN_COMMIT(pRExC_state, &data_fake,minlenp);
4457 data_fake.last_found=newSVsv(data->last_found);
4461 data_fake.last_closep = &fake;
4462 data_fake.flags = 0;
4463 data_fake.pos_delta = delta;
4465 data_fake.flags |= SF_IS_INF;
4466 if ( flags & SCF_DO_STCLASS && !scan->flags
4467 && OP(scan) == IFMATCH ) { /* Lookahead */
4468 cl_init(pRExC_state, &intrnl);
4469 data_fake.start_class = &intrnl;
4470 f |= SCF_DO_STCLASS_AND;
4472 if (flags & SCF_WHILEM_VISITED_POS)
4473 f |= SCF_WHILEM_VISITED_POS;
4474 next = regnext(scan);
4475 nscan = NEXTOPER(NEXTOPER(scan));
4477 *minnextp = study_chunk(pRExC_state, &nscan, minnextp, &deltanext,
4478 last, &data_fake, stopparen, recursed, NULL, f,depth+1);
4481 FAIL("Variable length lookbehind not implemented");
4483 else if (*minnextp > (I32)U8_MAX) {
4484 FAIL2("Lookbehind longer than %"UVuf" not implemented", (UV)U8_MAX);
4486 scan->flags = (U8)*minnextp;
4491 if (f & SCF_DO_STCLASS_AND) {
4492 const int was = TEST_SSC_EOS(data.start_class);
4494 cl_and(data->start_class, &intrnl);
4496 SET_SSC_EOS(data->start_class);
4499 if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4501 if (data_fake.flags & SF_HAS_EVAL)
4502 data->flags |= SF_HAS_EVAL;
4503 data->whilem_c = data_fake.whilem_c;
4504 if ((flags & SCF_DO_SUBSTR) && data_fake.last_found) {
4505 if (RExC_rx->minlen<*minnextp)
4506 RExC_rx->minlen=*minnextp;
4507 SCAN_COMMIT(pRExC_state, &data_fake, minnextp);
4508 SvREFCNT_dec_NN(data_fake.last_found);
4510 if ( data_fake.minlen_fixed != minlenp )
4512 data->offset_fixed= data_fake.offset_fixed;
4513 data->minlen_fixed= data_fake.minlen_fixed;
4514 data->lookbehind_fixed+= scan->flags;
4516 if ( data_fake.minlen_float != minlenp )
4518 data->minlen_float= data_fake.minlen_float;
4519 data->offset_float_min=data_fake.offset_float_min;
4520 data->offset_float_max=data_fake.offset_float_max;
4521 data->lookbehind_float+= scan->flags;
4528 else if (OP(scan) == OPEN) {
4529 if (stopparen != (I32)ARG(scan))
4532 else if (OP(scan) == CLOSE) {
4533 if (stopparen == (I32)ARG(scan)) {
4536 if ((I32)ARG(scan) == is_par) {
4537 next = regnext(scan);
4539 if ( next && (OP(next) != WHILEM) && next < last)
4540 is_par = 0; /* Disable optimization */
4543 *(data->last_closep) = ARG(scan);
4545 else if (OP(scan) == EVAL) {
4547 data->flags |= SF_HAS_EVAL;
4549 else if ( PL_regkind[OP(scan)] == ENDLIKE ) {
4550 if (flags & SCF_DO_SUBSTR) {
4551 SCAN_COMMIT(pRExC_state,data,minlenp);
4552 flags &= ~SCF_DO_SUBSTR;
4554 if (data && OP(scan)==ACCEPT) {
4555 data->flags |= SCF_SEEN_ACCEPT;
4560 else if (OP(scan) == LOGICAL && scan->flags == 2) /* Embedded follows */
4562 if (flags & SCF_DO_SUBSTR) {
4563 SCAN_COMMIT(pRExC_state,data,minlenp);
4564 data->longest = &(data->longest_float);
4566 is_inf = is_inf_internal = 1;
4567 if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
4568 cl_anything(pRExC_state, data->start_class);
4569 flags &= ~SCF_DO_STCLASS;
4571 else if (OP(scan) == GPOS) {
4572 if (!(RExC_rx->extflags & RXf_GPOS_FLOAT) &&
4573 !(delta || is_inf || (data && data->pos_delta)))
4575 if (!(RExC_rx->extflags & RXf_ANCH) && (flags & SCF_DO_SUBSTR))
4576 RExC_rx->extflags |= RXf_ANCH_GPOS;
4577 if (RExC_rx->gofs < (U32)min)
4578 RExC_rx->gofs = min;
4580 RExC_rx->extflags |= RXf_GPOS_FLOAT;
4584 #ifdef TRIE_STUDY_OPT
4585 #ifdef FULL_TRIE_STUDY
4586 else if (PL_regkind[OP(scan)] == TRIE) {
4587 /* NOTE - There is similar code to this block above for handling
4588 BRANCH nodes on the initial study. If you change stuff here
4590 regnode *trie_node= scan;
4591 regnode *tail= regnext(scan);
4592 reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
4593 I32 max1 = 0, min1 = I32_MAX;
4594 struct regnode_charclass_class accum;
4596 if (flags & SCF_DO_SUBSTR) /* XXXX Add !SUSPEND? */
4597 SCAN_COMMIT(pRExC_state, data,minlenp); /* Cannot merge strings after this. */
4598 if (flags & SCF_DO_STCLASS)
4599 cl_init_zero(pRExC_state, &accum);
4605 const regnode *nextbranch= NULL;
4608 for ( word=1 ; word <= trie->wordcount ; word++)
4610 I32 deltanext=0, minnext=0, f = 0, fake;
4611 struct regnode_charclass_class this_class;
4613 data_fake.flags = 0;
4615 data_fake.whilem_c = data->whilem_c;
4616 data_fake.last_closep = data->last_closep;
4619 data_fake.last_closep = &fake;
4620 data_fake.pos_delta = delta;
4621 if (flags & SCF_DO_STCLASS) {
4622 cl_init(pRExC_state, &this_class);
4623 data_fake.start_class = &this_class;
4624 f = SCF_DO_STCLASS_AND;
4626 if (flags & SCF_WHILEM_VISITED_POS)
4627 f |= SCF_WHILEM_VISITED_POS;
4629 if (trie->jump[word]) {
4631 nextbranch = trie_node + trie->jump[0];
4632 scan= trie_node + trie->jump[word];
4633 /* We go from the jump point to the branch that follows
4634 it. Note this means we need the vestigal unused branches
4635 even though they arent otherwise used.
4637 minnext = study_chunk(pRExC_state, &scan, minlenp,
4638 &deltanext, (regnode *)nextbranch, &data_fake,
4639 stopparen, recursed, NULL, f,depth+1);
4641 if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
4642 nextbranch= regnext((regnode*)nextbranch);
4644 if (min1 > (I32)(minnext + trie->minlen))
4645 min1 = minnext + trie->minlen;
4646 if (deltanext == I32_MAX) {
4647 is_inf = is_inf_internal = 1;
4649 } else if (max1 < (I32)(minnext + deltanext + trie->maxlen))
4650 max1 = minnext + deltanext + trie->maxlen;
4652 if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4654 if (data_fake.flags & SCF_SEEN_ACCEPT) {
4655 if ( stopmin > min + min1)
4656 stopmin = min + min1;
4657 flags &= ~SCF_DO_SUBSTR;
4659 data->flags |= SCF_SEEN_ACCEPT;
4662 if (data_fake.flags & SF_HAS_EVAL)
4663 data->flags |= SF_HAS_EVAL;
4664 data->whilem_c = data_fake.whilem_c;
4666 if (flags & SCF_DO_STCLASS)
4667 cl_or(pRExC_state, &accum, &this_class);
4670 if (flags & SCF_DO_SUBSTR) {
4671 data->pos_min += min1;
4672 data->pos_delta += max1 - min1;
4673 if (max1 != min1 || is_inf)
4674 data->longest = &(data->longest_float);
4677 delta += max1 - min1;
4678 if (flags & SCF_DO_STCLASS_OR) {
4679 cl_or(pRExC_state, data->start_class, &accum);
4681 cl_and(data->start_class, and_withp);
4682 flags &= ~SCF_DO_STCLASS;
4685 else if (flags & SCF_DO_STCLASS_AND) {
4687 cl_and(data->start_class, &accum);
4688 flags &= ~SCF_DO_STCLASS;
4691 /* Switch to OR mode: cache the old value of
4692 * data->start_class */
4694 StructCopy(data->start_class, and_withp,
4695 struct regnode_charclass_class);
4696 flags &= ~SCF_DO_STCLASS_AND;
4697 StructCopy(&accum, data->start_class,
4698 struct regnode_charclass_class);
4699 flags |= SCF_DO_STCLASS_OR;
4700 SET_SSC_EOS(data->start_class);
4707 else if (PL_regkind[OP(scan)] == TRIE) {
4708 reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
4711 min += trie->minlen;
4712 delta += (trie->maxlen - trie->minlen);
4713 flags &= ~SCF_DO_STCLASS; /* xxx */
4714 if (flags & SCF_DO_SUBSTR) {
4715 SCAN_COMMIT(pRExC_state,data,minlenp); /* Cannot expect anything... */
4716 data->pos_min += trie->minlen;
4717 data->pos_delta += (trie->maxlen - trie->minlen);
4718 if (trie->maxlen != trie->minlen)
4719 data->longest = &(data->longest_float);
4721 if (trie->jump) /* no more substrings -- for now /grr*/
4722 flags &= ~SCF_DO_SUBSTR;
4724 #endif /* old or new */
4725 #endif /* TRIE_STUDY_OPT */
4727 /* Else: zero-length, ignore. */
4728 scan = regnext(scan);
4733 stopparen = frame->stop;
4734 frame = frame->prev;
4735 goto fake_study_recurse;
4740 DEBUG_STUDYDATA("pre-fin:",data,depth);
4743 *deltap = is_inf_internal ? I32_MAX : delta;
4744 if (flags & SCF_DO_SUBSTR && is_inf)
4745 data->pos_delta = I32_MAX - data->pos_min;
4746 if (is_par > (I32)U8_MAX)
4748 if (is_par && pars==1 && data) {
4749 data->flags |= SF_IN_PAR;
4750 data->flags &= ~SF_HAS_PAR;
4752 else if (pars && data) {
4753 data->flags |= SF_HAS_PAR;
4754 data->flags &= ~SF_IN_PAR;
4756 if (flags & SCF_DO_STCLASS_OR)
4757 cl_and(data->start_class, and_withp);
4758 if (flags & SCF_TRIE_RESTUDY)
4759 data->flags |= SCF_TRIE_RESTUDY;
4761 DEBUG_STUDYDATA("post-fin:",data,depth);
4763 return min < stopmin ? min : stopmin;
4767 S_add_data(RExC_state_t *pRExC_state, U32 n, const char *s)
4769 U32 count = RExC_rxi->data ? RExC_rxi->data->count : 0;
4771 PERL_ARGS_ASSERT_ADD_DATA;
4773 Renewc(RExC_rxi->data,
4774 sizeof(*RExC_rxi->data) + sizeof(void*) * (count + n - 1),
4775 char, struct reg_data);
4777 Renew(RExC_rxi->data->what, count + n, U8);
4779 Newx(RExC_rxi->data->what, n, U8);
4780 RExC_rxi->data->count = count + n;
4781 Copy(s, RExC_rxi->data->what + count, n, U8);
4785 /*XXX: todo make this not included in a non debugging perl */
4786 #ifndef PERL_IN_XSUB_RE
4788 Perl_reginitcolors(pTHX)
4791 const char * const s = PerlEnv_getenv("PERL_RE_COLORS");
4793 char *t = savepv(s);
4797 t = strchr(t, '\t');
4803 PL_colors[i] = t = (char *)"";
4808 PL_colors[i++] = (char *)"";
4815 #ifdef TRIE_STUDY_OPT
4816 #define CHECK_RESTUDY_GOTO_butfirst(dOsomething) \
4819 (data.flags & SCF_TRIE_RESTUDY) \
4827 #define CHECK_RESTUDY_GOTO_butfirst
4831 * pregcomp - compile a regular expression into internal code
4833 * Decides which engine's compiler to call based on the hint currently in
4837 #ifndef PERL_IN_XSUB_RE
4839 /* return the currently in-scope regex engine (or the default if none) */
4841 regexp_engine const *
4842 Perl_current_re_engine(pTHX)
4846 if (IN_PERL_COMPILETIME) {
4847 HV * const table = GvHV(PL_hintgv);
4851 return &PL_core_reg_engine;
4852 ptr = hv_fetchs(table, "regcomp", FALSE);
4853 if ( !(ptr && SvIOK(*ptr) && SvIV(*ptr)))
4854 return &PL_core_reg_engine;
4855 return INT2PTR(regexp_engine*,SvIV(*ptr));
4859 if (!PL_curcop->cop_hints_hash)
4860 return &PL_core_reg_engine;
4861 ptr = cop_hints_fetch_pvs(PL_curcop, "regcomp", 0);
4862 if ( !(ptr && SvIOK(ptr) && SvIV(ptr)))
4863 return &PL_core_reg_engine;
4864 return INT2PTR(regexp_engine*,SvIV(ptr));
4870 Perl_pregcomp(pTHX_ SV * const pattern, const U32 flags)
4873 regexp_engine const *eng = current_re_engine();
4874 GET_RE_DEBUG_FLAGS_DECL;
4876 PERL_ARGS_ASSERT_PREGCOMP;
4878 /* Dispatch a request to compile a regexp to correct regexp engine. */
4880 PerlIO_printf(Perl_debug_log, "Using engine %"UVxf"\n",
4883 return CALLREGCOMP_ENG(eng, pattern, flags);
4887 /* public(ish) entry point for the perl core's own regex compiling code.
4888 * It's actually a wrapper for Perl_re_op_compile that only takes an SV
4889 * pattern rather than a list of OPs, and uses the internal engine rather
4890 * than the current one */
4893 Perl_re_compile(pTHX_ SV * const pattern, U32 rx_flags)
4895 SV *pat = pattern; /* defeat constness! */
4896 PERL_ARGS_ASSERT_RE_COMPILE;
4897 return Perl_re_op_compile(aTHX_ &pat, 1, NULL,
4898 #ifdef PERL_IN_XSUB_RE
4901 &PL_core_reg_engine,
4903 NULL, NULL, rx_flags, 0);
4907 /* upgrade pattern pat_p of length plen_p to UTF8, and if there are code
4908 * blocks, recalculate the indices. Update pat_p and plen_p in-place to
4909 * point to the realloced string and length.
4911 * This is essentially a copy of Perl_bytes_to_utf8() with the code index
4915 S_pat_upgrade_to_utf8(pTHX_ RExC_state_t * const pRExC_state,
4916 char **pat_p, STRLEN *plen_p, int num_code_blocks)
4918 U8 *const src = (U8*)*pat_p;
4921 STRLEN s = 0, d = 0;
4923 GET_RE_DEBUG_FLAGS_DECL;
4925 DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log,
4926 "UTF8 mismatch! Converting to utf8 for resizing and compile\n"));
4928 Newx(dst, *plen_p * 2 + 1, U8);
4930 while (s < *plen_p) {
4931 const UV uv = NATIVE_TO_ASCII(src[s]);
4932 if (UNI_IS_INVARIANT(uv))
4933 dst[d] = (U8)UTF_TO_NATIVE(uv);
4935 dst[d++] = (U8)UTF8_EIGHT_BIT_HI(uv);
4936 dst[d] = (U8)UTF8_EIGHT_BIT_LO(uv);
4938 if (n < num_code_blocks) {
4939 if (!do_end && pRExC_state->code_blocks[n].start == s) {
4940 pRExC_state->code_blocks[n].start = d;
4941 assert(dst[d] == '(');
4944 else if (do_end && pRExC_state->code_blocks[n].end == s) {
4945 pRExC_state->code_blocks[n].end = d;
4946 assert(dst[d] == ')');
4956 *pat_p = (char*) dst;
4958 RExC_orig_utf8 = RExC_utf8 = 1;
4963 /* S_concat_pat(): concatenate a list of args to the pattern string pat,
4964 * while recording any code block indices, and handling overloading,
4965 * nested qr// objects etc. If pat is null, it will allocate a new
4966 * string, or just return the first arg, if there's only one.
4968 * Returns the malloced/updated pat.
4969 * patternp and pat_count is the array of SVs to be concatted;
4970 * oplist is the optional list of ops that generated the SVs;
4971 * recompile_p is a pointer to a boolean that will be set if
4972 * the regex will need to be recompiled.
4973 * delim, if non-null is an SV that will be inserted between each element
4977 S_concat_pat(pTHX_ RExC_state_t * const pRExC_state,
4978 SV *pat, SV ** const patternp, int pat_count,
4979 OP *oplist, bool *recompile_p, SV *delim)
4983 bool use_delim = FALSE;
4984 bool alloced = FALSE;
4986 /* if we know we have at least two args, create an empty string,
4987 * then concatenate args to that. For no args, return an empty string */
4988 if (!pat && pat_count != 1) {
4989 pat = newSVpvn("", 0);
4994 for (svp = patternp; svp < patternp + pat_count; svp++) {
4997 STRLEN orig_patlen = 0;
4999 SV *msv = use_delim ? delim : *svp;
5001 /* if we've got a delimiter, we go round the loop twice for each
5002 * svp slot (except the last), using the delimiter the second
5011 if (SvTYPE(msv) == SVt_PVAV) {
5012 /* we've encountered an interpolated array within
5013 * the pattern, e.g. /...@a..../. Expand the list of elements,
5014 * then recursively append elements.
5015 * The code in this block is based on S_pushav() */
5017 AV *const av = (AV*)msv;
5018 const I32 maxarg = AvFILL(av) + 1;
5022 assert(oplist->op_type == OP_PADAV
5023 || oplist->op_type == OP_RV2AV);
5024 oplist = oplist->op_sibling;;
5027 if (SvRMAGICAL(av)) {
5030 Newx(array, maxarg, SV*);
5032 for (i=0; i < (U32)maxarg; i++) {
5033 SV ** const svp = av_fetch(av, i, FALSE);
5034 array[i] = svp ? *svp : &PL_sv_undef;
5038 array = AvARRAY(av);
5040 pat = S_concat_pat(aTHX_ pRExC_state, pat,
5041 array, maxarg, NULL, recompile_p,
5043 GvSV((gv_fetchpvs("\"", GV_ADDMULTI, SVt_PV))));
5049 /* we make the assumption here that each op in the list of
5050 * op_siblings maps to one SV pushed onto the stack,
5051 * except for code blocks, with have both an OP_NULL and
5053 * This allows us to match up the list of SVs against the
5054 * list of OPs to find the next code block.
5056 * Note that PUSHMARK PADSV PADSV ..
5058 * PADRANGE PADSV PADSV ..
5059 * so the alignment still works. */
5062 if (oplist->op_type == OP_NULL
5063 && (oplist->op_flags & OPf_SPECIAL))
5065 assert(n < pRExC_state->num_code_blocks);
5066 pRExC_state->code_blocks[n].start = pat ? SvCUR(pat) : 0;
5067 pRExC_state->code_blocks[n].block = oplist;
5068 pRExC_state->code_blocks[n].src_regex = NULL;
5071 oplist = oplist->op_sibling; /* skip CONST */
5074 oplist = oplist->op_sibling;;
5077 /* apply magic and QR overloading to arg */
5080 if (SvROK(msv) && SvAMAGIC(msv)) {
5081 SV *sv = AMG_CALLunary(msv, regexp_amg);
5085 if (SvTYPE(sv) != SVt_REGEXP)
5086 Perl_croak(aTHX_ "Overloaded qr did not return a REGEXP");
5091 /* try concatenation overload ... */
5092 if (pat && (SvAMAGIC(pat) || SvAMAGIC(msv)) &&
5093 (sv = amagic_call(pat, msv, concat_amg, AMGf_assign)))
5096 /* overloading involved: all bets are off over literal
5097 * code. Pretend we haven't seen it */
5098 pRExC_state->num_code_blocks -= n;
5102 /* ... or failing that, try "" overload */
5103 while (SvAMAGIC(msv)
5104 && (sv = AMG_CALLunary(msv, string_amg))
5108 && SvRV(msv) == SvRV(sv))
5113 if (SvROK(msv) && SvTYPE(SvRV(msv)) == SVt_REGEXP)
5117 /* this is a partially unrolled
5118 * sv_catsv_nomg(pat, msv);
5119 * that allows us to adjust code block indices if
5122 char *dst = SvPV_force_nomg(pat, dlen);
5124 if (SvUTF8(msv) && !SvUTF8(pat)) {
5125 S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &dst, &dlen, n);
5126 sv_setpvn(pat, dst, dlen);
5129 sv_catsv_nomg(pat, msv);
5136 pRExC_state->code_blocks[n-1].end = SvCUR(pat)-1;
5139 /* extract any code blocks within any embedded qr//'s */
5140 if (rx && SvTYPE(rx) == SVt_REGEXP
5141 && RX_ENGINE((REGEXP*)rx)->op_comp)
5144 RXi_GET_DECL(ReANY((REGEXP *)rx), ri);
5145 if (ri->num_code_blocks) {
5147 /* the presence of an embedded qr// with code means
5148 * we should always recompile: the text of the
5149 * qr// may not have changed, but it may be a
5150 * different closure than last time */
5152 Renew(pRExC_state->code_blocks,
5153 pRExC_state->num_code_blocks + ri->num_code_blocks,
5154 struct reg_code_block);
5155 pRExC_state->num_code_blocks += ri->num_code_blocks;
5157 for (i=0; i < ri->num_code_blocks; i++) {
5158 struct reg_code_block *src, *dst;
5159 STRLEN offset = orig_patlen
5160 + ReANY((REGEXP *)rx)->pre_prefix;
5161 assert(n < pRExC_state->num_code_blocks);
5162 src = &ri->code_blocks[i];
5163 dst = &pRExC_state->code_blocks[n];
5164 dst->start = src->start + offset;
5165 dst->end = src->end + offset;
5166 dst->block = src->block;
5167 dst->src_regex = (REGEXP*) SvREFCNT_inc( (SV*)
5176 /* avoid calling magic multiple times on a single element e.g. =~ $qr */
5185 /* see if there are any run-time code blocks in the pattern.
5186 * False positives are allowed */
5189 S_has_runtime_code(pTHX_ RExC_state_t * const pRExC_state,
5190 char *pat, STRLEN plen)
5195 for (s = 0; s < plen; s++) {
5196 if (n < pRExC_state->num_code_blocks
5197 && s == pRExC_state->code_blocks[n].start)
5199 s = pRExC_state->code_blocks[n].end;
5203 /* TODO ideally should handle [..], (#..), /#.../x to reduce false
5205 if (pat[s] == '(' && s+2 <= plen && pat[s+1] == '?' &&
5207 || (s + 2 <= plen && pat[s+2] == '?' && pat[s+3] == '{'))
5214 /* Handle run-time code blocks. We will already have compiled any direct
5215 * or indirect literal code blocks. Now, take the pattern 'pat' and make a
5216 * copy of it, but with any literal code blocks blanked out and
5217 * appropriate chars escaped; then feed it into
5219 * eval "qr'modified_pattern'"
5223 * a\bc(?{"this was literal"})def'ghi\\jkl(?{"this is runtime"})mno
5227 * qr'a\\bc_______________________def\'ghi\\\\jkl(?{"this is runtime"})mno'
5229 * After eval_sv()-ing that, grab any new code blocks from the returned qr
5230 * and merge them with any code blocks of the original regexp.
5232 * If the pat is non-UTF8, while the evalled qr is UTF8, don't merge;
5233 * instead, just save the qr and return FALSE; this tells our caller that
5234 * the original pattern needs upgrading to utf8.
5238 S_compile_runtime_code(pTHX_ RExC_state_t * const pRExC_state,
5239 char *pat, STRLEN plen)
5243 GET_RE_DEBUG_FLAGS_DECL;
5245 if (pRExC_state->runtime_code_qr) {
5246 /* this is the second time we've been called; this should
5247 * only happen if the main pattern got upgraded to utf8
5248 * during compilation; re-use the qr we compiled first time
5249 * round (which should be utf8 too)
5251 qr = pRExC_state->runtime_code_qr;
5252 pRExC_state->runtime_code_qr = NULL;
5253 assert(RExC_utf8 && SvUTF8(qr));
5259 int newlen = plen + 6; /* allow for "qr''x\0" extra chars */
5263 /* determine how many extra chars we need for ' and \ escaping */
5264 for (s = 0; s < plen; s++) {
5265 if (pat[s] == '\'' || pat[s] == '\\')
5269 Newx(newpat, newlen, char);
5271 *p++ = 'q'; *p++ = 'r'; *p++ = '\'';
5273 for (s = 0; s < plen; s++) {
5274 if (n < pRExC_state->num_code_blocks
5275 && s == pRExC_state->code_blocks[n].start)
5277 /* blank out literal code block */
5278 assert(pat[s] == '(');
5279 while (s <= pRExC_state->code_blocks[n].end) {
5287 if (pat[s] == '\'' || pat[s] == '\\')
5292 if (pRExC_state->pm_flags & RXf_PMf_EXTENDED)
5296 PerlIO_printf(Perl_debug_log,
5297 "%sre-parsing pattern for runtime code:%s %s\n",
5298 PL_colors[4],PL_colors[5],newpat);
5301 sv = newSVpvn_flags(newpat, p-newpat-1, RExC_utf8 ? SVf_UTF8 : 0);
5307 PUSHSTACKi(PERLSI_REQUIRE);
5308 /* G_RE_REPARSING causes the toker to collapse \\ into \ when
5309 * parsing qr''; normally only q'' does this. It also alters
5311 eval_sv(sv, G_SCALAR|G_RE_REPARSING);
5312 SvREFCNT_dec_NN(sv);
5317 SV * const errsv = ERRSV;
5318 if (SvTRUE_NN(errsv))
5320 Safefree(pRExC_state->code_blocks);
5321 /* use croak_sv ? */
5322 Perl_croak_nocontext("%s", SvPV_nolen_const(errsv));
5325 assert(SvROK(qr_ref));
5327 assert(SvTYPE(qr) == SVt_REGEXP && RX_ENGINE((REGEXP*)qr)->op_comp);
5328 /* the leaving below frees the tmp qr_ref.
5329 * Give qr a life of its own */
5337 if (!RExC_utf8 && SvUTF8(qr)) {
5338 /* first time through; the pattern got upgraded; save the
5339 * qr for the next time through */
5340 assert(!pRExC_state->runtime_code_qr);
5341 pRExC_state->runtime_code_qr = qr;
5346 /* extract any code blocks within the returned qr// */
5349 /* merge the main (r1) and run-time (r2) code blocks into one */
5351 RXi_GET_DECL(ReANY((REGEXP *)qr), r2);
5352 struct reg_code_block *new_block, *dst;
5353 RExC_state_t * const r1 = pRExC_state; /* convenient alias */
5356 if (!r2->num_code_blocks) /* we guessed wrong */
5358 SvREFCNT_dec_NN(qr);
5363 r1->num_code_blocks + r2->num_code_blocks,
5364 struct reg_code_block);
5367 while ( i1 < r1->num_code_blocks
5368 || i2 < r2->num_code_blocks)
5370 struct reg_code_block *src;
5373 if (i1 == r1->num_code_blocks) {
5374 src = &r2->code_blocks[i2++];
5377 else if (i2 == r2->num_code_blocks)
5378 src = &r1->code_blocks[i1++];
5379 else if ( r1->code_blocks[i1].start
5380 < r2->code_blocks[i2].start)
5382 src = &r1->code_blocks[i1++];
5383 assert(src->end < r2->code_blocks[i2].start);
5386 assert( r1->code_blocks[i1].start
5387 > r2->code_blocks[i2].start);
5388 src = &r2->code_blocks[i2++];
5390 assert(src->end < r1->code_blocks[i1].start);
5393 assert(pat[src->start] == '(');
5394 assert(pat[src->end] == ')');
5395 dst->start = src->start;
5396 dst->end = src->end;
5397 dst->block = src->block;
5398 dst->src_regex = is_qr ? (REGEXP*) SvREFCNT_inc( (SV*) qr)
5402 r1->num_code_blocks += r2->num_code_blocks;
5403 Safefree(r1->code_blocks);
5404 r1->code_blocks = new_block;
5407 SvREFCNT_dec_NN(qr);
5413 S_setup_longest(pTHX_ RExC_state_t *pRExC_state, SV* sv_longest, SV** rx_utf8, SV** rx_substr, I32* rx_end_shift, I32 lookbehind, I32 offset, I32 *minlen, STRLEN longest_length, bool eol, bool meol)
5415 /* This is the common code for setting up the floating and fixed length
5416 * string data extracted from Perl_re_op_compile() below. Returns a boolean
5417 * as to whether succeeded or not */
5421 if (! (longest_length
5422 || (eol /* Can't have SEOL and MULTI */
5423 && (! meol || (RExC_flags & RXf_PMf_MULTILINE)))
5425 /* See comments for join_exact for why REG_SEEN_EXACTF_SHARP_S */
5426 || (RExC_seen & REG_SEEN_EXACTF_SHARP_S))
5431 /* copy the information about the longest from the reg_scan_data
5432 over to the program. */
5433 if (SvUTF8(sv_longest)) {
5434 *rx_utf8 = sv_longest;
5437 *rx_substr = sv_longest;
5440 /* end_shift is how many chars that must be matched that
5441 follow this item. We calculate it ahead of time as once the
5442 lookbehind offset is added in we lose the ability to correctly
5444 ml = minlen ? *(minlen) : (I32)longest_length;
5445 *rx_end_shift = ml - offset
5446 - longest_length + (SvTAIL(sv_longest) != 0)
5449 t = (eol/* Can't have SEOL and MULTI */
5450 && (! meol || (RExC_flags & RXf_PMf_MULTILINE)));
5451 fbm_compile(sv_longest, t ? FBMcf_TAIL : 0);
5457 * Perl_re_op_compile - the perl internal RE engine's function to compile a
5458 * regular expression into internal code.
5459 * The pattern may be passed either as:
5460 * a list of SVs (patternp plus pat_count)
5461 * a list of OPs (expr)
5462 * If both are passed, the SV list is used, but the OP list indicates
5463 * which SVs are actually pre-compiled code blocks
5465 * The SVs in the list have magic and qr overloading applied to them (and
5466 * the list may be modified in-place with replacement SVs in the latter
5469 * If the pattern hasn't changed from old_re, then old_re will be
5472 * eng is the current engine. If that engine has an op_comp method, then
5473 * handle directly (i.e. we assume that op_comp was us); otherwise, just
5474 * do the initial concatenation of arguments and pass on to the external
5477 * If is_bare_re is not null, set it to a boolean indicating whether the
5478 * arg list reduced (after overloading) to a single bare regex which has
5479 * been returned (i.e. /$qr/).
5481 * orig_rx_flags contains RXf_* flags. See perlreapi.pod for more details.
5483 * pm_flags contains the PMf_* flags, typically based on those from the
5484 * pm_flags field of the related PMOP. Currently we're only interested in
5485 * PMf_HAS_CV, PMf_IS_QR, PMf_USE_RE_EVAL.
5487 * We can't allocate space until we know how big the compiled form will be,
5488 * but we can't compile it (and thus know how big it is) until we've got a
5489 * place to put the code. So we cheat: we compile it twice, once with code
5490 * generation turned off and size counting turned on, and once "for real".
5491 * This also means that we don't allocate space until we are sure that the
5492 * thing really will compile successfully, and we never have to move the
5493 * code and thus invalidate pointers into it. (Note that it has to be in
5494 * one piece because free() must be able to free it all.) [NB: not true in perl]
5496 * Beware that the optimization-preparation code in here knows about some
5497 * of the structure of the compiled regexp. [I'll say.]
5501 Perl_re_op_compile(pTHX_ SV ** const patternp, int pat_count,
5502 OP *expr, const regexp_engine* eng, REGEXP *old_re,
5503 bool *is_bare_re, U32 orig_rx_flags, U32 pm_flags)
5508 regexp_internal *ri;
5516 SV *code_blocksv = NULL;
5517 SV** new_patternp = patternp;
5519 /* these are all flags - maybe they should be turned
5520 * into a single int with different bit masks */
5521 I32 sawlookahead = 0;
5526 regex_charset initial_charset = get_regex_charset(orig_rx_flags);
5528 bool runtime_code = 0;
5530 RExC_state_t RExC_state;
5531 RExC_state_t * const pRExC_state = &RExC_state;
5532 #ifdef TRIE_STUDY_OPT
5534 RExC_state_t copyRExC_state;
5536 GET_RE_DEBUG_FLAGS_DECL;
5538 PERL_ARGS_ASSERT_RE_OP_COMPILE;
5540 DEBUG_r(if (!PL_colorset) reginitcolors());
5542 #ifndef PERL_IN_XSUB_RE
5543 /* Initialize these here instead of as-needed, as is quick and avoids
5544 * having to test them each time otherwise */
5545 if (! PL_AboveLatin1) {
5546 PL_AboveLatin1 = _new_invlist_C_array(AboveLatin1_invlist);
5547 PL_ASCII = _new_invlist_C_array(ASCII_invlist);
5548 PL_Latin1 = _new_invlist_C_array(Latin1_invlist);
5550 PL_L1Posix_ptrs[_CC_ALPHANUMERIC]
5551 = _new_invlist_C_array(L1PosixAlnum_invlist);
5552 PL_Posix_ptrs[_CC_ALPHANUMERIC]
5553 = _new_invlist_C_array(PosixAlnum_invlist);
5555 PL_L1Posix_ptrs[_CC_ALPHA]
5556 = _new_invlist_C_array(L1PosixAlpha_invlist);
5557 PL_Posix_ptrs[_CC_ALPHA] = _new_invlist_C_array(PosixAlpha_invlist);
5559 PL_Posix_ptrs[_CC_BLANK] = _new_invlist_C_array(PosixBlank_invlist);
5560 PL_XPosix_ptrs[_CC_BLANK] = _new_invlist_C_array(XPosixBlank_invlist);
5562 /* Cased is the same as Alpha in the ASCII range */
5563 PL_L1Posix_ptrs[_CC_CASED] = _new_invlist_C_array(L1Cased_invlist);
5564 PL_Posix_ptrs[_CC_CASED] = _new_invlist_C_array(PosixAlpha_invlist);
5566 PL_Posix_ptrs[_CC_CNTRL] = _new_invlist_C_array(PosixCntrl_invlist);
5567 PL_XPosix_ptrs[_CC_CNTRL] = _new_invlist_C_array(XPosixCntrl_invlist);
5569 PL_Posix_ptrs[_CC_DIGIT] = _new_invlist_C_array(PosixDigit_invlist);
5570 PL_L1Posix_ptrs[_CC_DIGIT] = _new_invlist_C_array(PosixDigit_invlist);
5572 PL_L1Posix_ptrs[_CC_GRAPH] = _new_invlist_C_array(L1PosixGraph_invlist);
5573 PL_Posix_ptrs[_CC_GRAPH] = _new_invlist_C_array(PosixGraph_invlist);
5575 PL_L1Posix_ptrs[_CC_LOWER] = _new_invlist_C_array(L1PosixLower_invlist);
5576 PL_Posix_ptrs[_CC_LOWER] = _new_invlist_C_array(PosixLower_invlist);
5578 PL_L1Posix_ptrs[_CC_PRINT] = _new_invlist_C_array(L1PosixPrint_invlist);
5579 PL_Posix_ptrs[_CC_PRINT] = _new_invlist_C_array(PosixPrint_invlist);
5581 PL_L1Posix_ptrs[_CC_PUNCT] = _new_invlist_C_array(L1PosixPunct_invlist);
5582 PL_Posix_ptrs[_CC_PUNCT] = _new_invlist_C_array(PosixPunct_invlist);
5584 PL_Posix_ptrs[_CC_SPACE] = _new_invlist_C_array(PerlSpace_invlist);
5585 PL_XPosix_ptrs[_CC_SPACE] = _new_invlist_C_array(XPerlSpace_invlist);
5586 PL_Posix_ptrs[_CC_PSXSPC] = _new_invlist_C_array(PosixSpace_invlist);
5587 PL_XPosix_ptrs[_CC_PSXSPC] = _new_invlist_C_array(XPosixSpace_invlist);
5589 PL_L1Posix_ptrs[_CC_UPPER] = _new_invlist_C_array(L1PosixUpper_invlist);
5590 PL_Posix_ptrs[_CC_UPPER] = _new_invlist_C_array(PosixUpper_invlist);
5592 PL_XPosix_ptrs[_CC_VERTSPACE] = _new_invlist_C_array(VertSpace_invlist);
5594 PL_Posix_ptrs[_CC_WORDCHAR] = _new_invlist_C_array(PosixWord_invlist);
5595 PL_L1Posix_ptrs[_CC_WORDCHAR]
5596 = _new_invlist_C_array(L1PosixWord_invlist);
5598 PL_Posix_ptrs[_CC_XDIGIT] = _new_invlist_C_array(PosixXDigit_invlist);
5599 PL_XPosix_ptrs[_CC_XDIGIT] = _new_invlist_C_array(XPosixXDigit_invlist);
5601 PL_HasMultiCharFold = _new_invlist_C_array(_Perl_Multi_Char_Folds_invlist);
5605 pRExC_state->code_blocks = NULL;
5606 pRExC_state->num_code_blocks = 0;
5609 *is_bare_re = FALSE;
5611 if (expr && (expr->op_type == OP_LIST ||
5612 (expr->op_type == OP_NULL && expr->op_targ == OP_LIST))) {
5613 /* allocate code_blocks if needed */
5617 for (o = cLISTOPx(expr)->op_first; o; o = o->op_sibling)
5618 if (o->op_type == OP_NULL && (o->op_flags & OPf_SPECIAL))
5619 ncode++; /* count of DO blocks */
5621 pRExC_state->num_code_blocks = ncode;
5622 Newx(pRExC_state->code_blocks, ncode, struct reg_code_block);
5627 /* compile-time pattern with just OP_CONSTs and DO blocks */
5632 /* find how many CONSTs there are */
5635 if (expr->op_type == OP_CONST)
5638 for (o = cLISTOPx(expr)->op_first; o; o = o->op_sibling) {
5639 if (o->op_type == OP_CONST)
5643 /* fake up an SV array */
5645 assert(!new_patternp);
5646 Newx(new_patternp, n, SV*);
5647 SAVEFREEPV(new_patternp);
5651 if (expr->op_type == OP_CONST)
5652 new_patternp[n] = cSVOPx_sv(expr);
5654 for (o = cLISTOPx(expr)->op_first; o; o = o->op_sibling) {
5655 if (o->op_type == OP_CONST)
5656 new_patternp[n++] = cSVOPo_sv;
5661 DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log,
5662 "Assembling pattern from %d elements%s\n", pat_count,
5663 orig_rx_flags & RXf_SPLIT ? " for split" : ""));
5665 /* set expr to the first arg op */
5667 if (pRExC_state->num_code_blocks
5668 && expr->op_type != OP_CONST)
5670 expr = cLISTOPx(expr)->op_first;
5671 assert( expr->op_type == OP_PUSHMARK
5672 || (expr->op_type == OP_NULL && expr->op_targ == OP_PUSHMARK)
5673 || expr->op_type == OP_PADRANGE);
5674 expr = expr->op_sibling;
5677 pat = S_concat_pat(aTHX_ pRExC_state, NULL, new_patternp, pat_count,
5678 expr, &recompile, NULL);
5680 /* handle bare (possibly after overloading) regex: foo =~ $re */
5685 if (SvTYPE(re) == SVt_REGEXP) {
5689 Safefree(pRExC_state->code_blocks);
5690 DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log,
5691 "Precompiled pattern%s\n",
5692 orig_rx_flags & RXf_SPLIT ? " for split" : ""));
5698 exp = SvPV_nomg(pat, plen);
5700 if (!eng->op_comp) {
5701 if ((SvUTF8(pat) && IN_BYTES)
5702 || SvGMAGICAL(pat) || SvAMAGIC(pat))
5704 /* make a temporary copy; either to convert to bytes,
5705 * or to avoid repeating get-magic / overloaded stringify */
5706 pat = newSVpvn_flags(exp, plen, SVs_TEMP |
5707 (IN_BYTES ? 0 : SvUTF8(pat)));
5709 Safefree(pRExC_state->code_blocks);
5710 return CALLREGCOMP_ENG(eng, pat, orig_rx_flags);
5713 /* ignore the utf8ness if the pattern is 0 length */
5714 RExC_utf8 = RExC_orig_utf8 = (plen == 0 || IN_BYTES) ? 0 : SvUTF8(pat);
5715 RExC_uni_semantics = 0;
5716 RExC_contains_locale = 0;
5717 pRExC_state->runtime_code_qr = NULL;
5720 SV *dsv= sv_newmortal();
5721 RE_PV_QUOTED_DECL(s, RExC_utf8, dsv, exp, plen, 60);
5722 PerlIO_printf(Perl_debug_log, "%sCompiling REx%s %s\n",
5723 PL_colors[4],PL_colors[5],s);
5727 /* we jump here if we upgrade the pattern to utf8 and have to
5730 if ((pm_flags & PMf_USE_RE_EVAL)
5731 /* this second condition covers the non-regex literal case,
5732 * i.e. $foo =~ '(?{})'. */
5733 || (IN_PERL_COMPILETIME && (PL_hints & HINT_RE_EVAL))
5735 runtime_code = S_has_runtime_code(aTHX_ pRExC_state, exp, plen);
5737 /* return old regex if pattern hasn't changed */
5738 /* XXX: note in the below we have to check the flags as well as the pattern.
5740 * Things get a touch tricky as we have to compare the utf8 flag independently
5741 * from the compile flags.
5746 && !!RX_UTF8(old_re) == !!RExC_utf8
5747 && ( RX_COMPFLAGS(old_re) == ( orig_rx_flags & RXf_PMf_FLAGCOPYMASK ) )
5748 && RX_PRECOMP(old_re)
5749 && RX_PRELEN(old_re) == plen
5750 && memEQ(RX_PRECOMP(old_re), exp, plen)
5751 && !runtime_code /* with runtime code, always recompile */ )
5753 Safefree(pRExC_state->code_blocks);
5757 rx_flags = orig_rx_flags;
5759 if (initial_charset == REGEX_LOCALE_CHARSET) {
5760 RExC_contains_locale = 1;
5762 else if (RExC_utf8 && initial_charset == REGEX_DEPENDS_CHARSET) {
5764 /* Set to use unicode semantics if the pattern is in utf8 and has the
5765 * 'depends' charset specified, as it means unicode when utf8 */
5766 set_regex_charset(&rx_flags, REGEX_UNICODE_CHARSET);
5770 RExC_flags = rx_flags;
5771 RExC_pm_flags = pm_flags;
5774 if (TAINTING_get && TAINT_get)
5775 Perl_croak(aTHX_ "Eval-group in insecure regular expression");
5777 if (!S_compile_runtime_code(aTHX_ pRExC_state, exp, plen)) {
5778 /* whoops, we have a non-utf8 pattern, whilst run-time code
5779 * got compiled as utf8. Try again with a utf8 pattern */
5780 S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &exp, &plen,
5781 pRExC_state->num_code_blocks);
5782 goto redo_first_pass;
5785 assert(!pRExC_state->runtime_code_qr);
5790 RExC_in_lookbehind = 0;
5791 RExC_seen_zerolen = *exp == '^' ? -1 : 0;
5793 RExC_override_recoding = 0;
5794 RExC_in_multi_char_class = 0;
5796 /* First pass: determine size, legality. */
5799 RExC_end = exp + plen;
5804 RExC_emit = &RExC_emit_dummy;
5805 RExC_whilem_seen = 0;
5806 RExC_open_parens = NULL;
5807 RExC_close_parens = NULL;
5809 RExC_paren_names = NULL;
5811 RExC_paren_name_list = NULL;
5813 RExC_recurse = NULL;
5814 RExC_recurse_count = 0;
5815 pRExC_state->code_index = 0;
5817 #if 0 /* REGC() is (currently) a NOP at the first pass.
5818 * Clever compilers notice this and complain. --jhi */
5819 REGC((U8)REG_MAGIC, (char*)RExC_emit);
5822 PerlIO_printf(Perl_debug_log, "Starting first pass (sizing)\n");
5824 RExC_lastparse=NULL;
5826 /* reg may croak on us, not giving us a chance to free
5827 pRExC_state->code_blocks. We cannot SAVEFREEPV it now, as we may
5828 need it to survive as long as the regexp (qr/(?{})/).
5829 We must check that code_blocksv is not already set, because we may
5830 have jumped back to restart the sizing pass. */
5831 if (pRExC_state->code_blocks && !code_blocksv) {
5832 code_blocksv = newSV_type(SVt_PV);
5833 SAVEFREESV(code_blocksv);
5834 SvPV_set(code_blocksv, (char *)pRExC_state->code_blocks);
5835 SvLEN_set(code_blocksv, 1); /*sufficient to make sv_clear free it*/
5837 if (reg(pRExC_state, 0, &flags,1) == NULL) {
5838 /* It's possible to write a regexp in ascii that represents Unicode
5839 codepoints outside of the byte range, such as via \x{100}. If we
5840 detect such a sequence we have to convert the entire pattern to utf8
5841 and then recompile, as our sizing calculation will have been based
5842 on 1 byte == 1 character, but we will need to use utf8 to encode
5843 at least some part of the pattern, and therefore must convert the whole
5846 if (flags & RESTART_UTF8) {
5847 S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &exp, &plen,
5848 pRExC_state->num_code_blocks);
5849 goto redo_first_pass;
5851 Perl_croak(aTHX_ "panic: reg returned NULL to re_op_compile for sizing pass, flags=%#"UVxf"", (UV) flags);
5854 SvLEN_set(code_blocksv,0); /* no you can't have it, sv_clear */
5857 PerlIO_printf(Perl_debug_log,
5858 "Required size %"IVdf" nodes\n"
5859 "Starting second pass (creation)\n",
5862 RExC_lastparse=NULL;
5865 /* The first pass could have found things that force Unicode semantics */
5866 if ((RExC_utf8 || RExC_uni_semantics)
5867 && get_regex_charset(rx_flags) == REGEX_DEPENDS_CHARSET)
5869 set_regex_charset(&rx_flags, REGEX_UNICODE_CHARSET);
5872 /* Small enough for pointer-storage convention?
5873 If extralen==0, this means that we will not need long jumps. */
5874 if (RExC_size >= 0x10000L && RExC_extralen)
5875 RExC_size += RExC_extralen;
5878 if (RExC_whilem_seen > 15)
5879 RExC_whilem_seen = 15;
5881 /* Allocate space and zero-initialize. Note, the two step process
5882 of zeroing when in debug mode, thus anything assigned has to
5883 happen after that */
5884 rx = (REGEXP*) newSV_type(SVt_REGEXP);
5886 Newxc(ri, sizeof(regexp_internal) + (unsigned)RExC_size * sizeof(regnode),
5887 char, regexp_internal);
5888 if ( r == NULL || ri == NULL )
5889 FAIL("Regexp out of space");
5891 /* avoid reading uninitialized memory in DEBUGGING code in study_chunk() */
5892 Zero(ri, sizeof(regexp_internal) + (unsigned)RExC_size * sizeof(regnode), char);
5894 /* bulk initialize base fields with 0. */
5895 Zero(ri, sizeof(regexp_internal), char);
5898 /* non-zero initialization begins here */
5901 r->extflags = rx_flags;
5902 RXp_COMPFLAGS(r) = orig_rx_flags & RXf_PMf_FLAGCOPYMASK;
5904 if (pm_flags & PMf_IS_QR) {
5905 ri->code_blocks = pRExC_state->code_blocks;
5906 ri->num_code_blocks = pRExC_state->num_code_blocks;
5911 for (n = 0; n < pRExC_state->num_code_blocks; n++)
5912 if (pRExC_state->code_blocks[n].src_regex)
5913 SAVEFREESV(pRExC_state->code_blocks[n].src_regex);
5914 SAVEFREEPV(pRExC_state->code_blocks);
5918 bool has_p = ((r->extflags & RXf_PMf_KEEPCOPY) == RXf_PMf_KEEPCOPY);
5919 bool has_charset = (get_regex_charset(r->extflags) != REGEX_DEPENDS_CHARSET);
5921 /* The caret is output if there are any defaults: if not all the STD
5922 * flags are set, or if no character set specifier is needed */
5924 (((r->extflags & RXf_PMf_STD_PMMOD) != RXf_PMf_STD_PMMOD)
5926 bool has_runon = ((RExC_seen & REG_SEEN_RUN_ON_COMMENT)==REG_SEEN_RUN_ON_COMMENT);
5927 U16 reganch = (U16)((r->extflags & RXf_PMf_STD_PMMOD)
5928 >> RXf_PMf_STD_PMMOD_SHIFT);
5929 const char *fptr = STD_PAT_MODS; /*"msix"*/
5931 /* Allocate for the worst case, which is all the std flags are turned
5932 * on. If more precision is desired, we could do a population count of
5933 * the flags set. This could be done with a small lookup table, or by
5934 * shifting, masking and adding, or even, when available, assembly
5935 * language for a machine-language population count.
5936 * We never output a minus, as all those are defaults, so are
5937 * covered by the caret */
5938 const STRLEN wraplen = plen + has_p + has_runon
5939 + has_default /* If needs a caret */
5941 /* If needs a character set specifier */
5942 + ((has_charset) ? MAX_CHARSET_NAME_LENGTH : 0)
5943 + (sizeof(STD_PAT_MODS) - 1)
5944 + (sizeof("(?:)") - 1);
5946 Newx(p, wraplen + 1, char); /* +1 for the ending NUL */
5947 r->xpv_len_u.xpvlenu_pv = p;
5949 SvFLAGS(rx) |= SVf_UTF8;
5952 /* If a default, cover it using the caret */
5954 *p++= DEFAULT_PAT_MOD;
5958 const char* const name = get_regex_charset_name(r->extflags, &len);
5959 Copy(name, p, len, char);
5963 *p++ = KEEPCOPY_PAT_MOD; /*'p'*/
5966 while((ch = *fptr++)) {
5974 Copy(RExC_precomp, p, plen, char);
5975 assert ((RX_WRAPPED(rx) - p) < 16);
5976 r->pre_prefix = p - RX_WRAPPED(rx);
5982 SvCUR_set(rx, p - RX_WRAPPED(rx));
5986 r->nparens = RExC_npar - 1; /* set early to validate backrefs */
5988 if (RExC_seen & REG_SEEN_RECURSE) {
5989 Newxz(RExC_open_parens, RExC_npar,regnode *);
5990 SAVEFREEPV(RExC_open_parens);
5991 Newxz(RExC_close_parens,RExC_npar,regnode *);
5992 SAVEFREEPV(RExC_close_parens);
5995 /* Useful during FAIL. */
5996 #ifdef RE_TRACK_PATTERN_OFFSETS
5997 Newxz(ri->u.offsets, 2*RExC_size+1, U32); /* MJD 20001228 */
5998 DEBUG_OFFSETS_r(PerlIO_printf(Perl_debug_log,
5999 "%s %"UVuf" bytes for offset annotations.\n",
6000 ri->u.offsets ? "Got" : "Couldn't get",
6001 (UV)((2*RExC_size+1) * sizeof(U32))));
6003 SetProgLen(ri,RExC_size);
6008 /* Second pass: emit code. */
6009 RExC_flags = rx_flags; /* don't let top level (?i) bleed */
6010 RExC_pm_flags = pm_flags;
6012 RExC_end = exp + plen;
6015 RExC_emit_start = ri->program;
6016 RExC_emit = ri->program;
6017 RExC_emit_bound = ri->program + RExC_size + 1;
6018 pRExC_state->code_index = 0;
6020 REGC((U8)REG_MAGIC, (char*) RExC_emit++);
6021 if (reg(pRExC_state, 0, &flags,1) == NULL) {
6023 Perl_croak(aTHX_ "panic: reg returned NULL to re_op_compile for generation pass, flags=%#"UVxf"", (UV) flags);
6025 /* XXXX To minimize changes to RE engine we always allocate
6026 3-units-long substrs field. */
6027 Newx(r->substrs, 1, struct reg_substr_data);
6028 if (RExC_recurse_count) {
6029 Newxz(RExC_recurse,RExC_recurse_count,regnode *);
6030 SAVEFREEPV(RExC_recurse);
6034 r->minlen = minlen = sawlookahead = sawplus = sawopen = sawminmod = 0;
6035 Zero(r->substrs, 1, struct reg_substr_data);
6037 #ifdef TRIE_STUDY_OPT
6039 StructCopy(&zero_scan_data, &data, scan_data_t);
6040 copyRExC_state = RExC_state;
6043 DEBUG_OPTIMISE_r(PerlIO_printf(Perl_debug_log,"Restudying\n"));
6045 RExC_state = copyRExC_state;
6046 if (seen & REG_TOP_LEVEL_BRANCHES)
6047 RExC_seen |= REG_TOP_LEVEL_BRANCHES;
6049 RExC_seen &= ~REG_TOP_LEVEL_BRANCHES;
6050 StructCopy(&zero_scan_data, &data, scan_data_t);
6053 StructCopy(&zero_scan_data, &data, scan_data_t);
6056 /* Dig out information for optimizations. */
6057 r->extflags = RExC_flags; /* was pm_op */
6058 /*dmq: removed as part of de-PMOP: pm->op_pmflags = RExC_flags; */
6061 SvUTF8_on(rx); /* Unicode in it? */
6062 ri->regstclass = NULL;
6063 if (RExC_naughty >= 10) /* Probably an expensive pattern. */
6064 r->intflags |= PREGf_NAUGHTY;
6065 scan = ri->program + 1; /* First BRANCH. */
6067 /* testing for BRANCH here tells us whether there is "must appear"
6068 data in the pattern. If there is then we can use it for optimisations */
6069 if (!(RExC_seen & REG_TOP_LEVEL_BRANCHES)) { /* Only one top-level choice. */
6071 STRLEN longest_float_length, longest_fixed_length;
6072 struct regnode_charclass_class ch_class; /* pointed to by data */
6074 I32 last_close = 0; /* pointed to by data */
6075 regnode *first= scan;
6076 regnode *first_next= regnext(first);
6078 * Skip introductions and multiplicators >= 1
6079 * so that we can extract the 'meat' of the pattern that must
6080 * match in the large if() sequence following.
6081 * NOTE that EXACT is NOT covered here, as it is normally
6082 * picked up by the optimiser separately.
6084 * This is unfortunate as the optimiser isnt handling lookahead
6085 * properly currently.
6088 while ((OP(first) == OPEN && (sawopen = 1)) ||
6089 /* An OR of *one* alternative - should not happen now. */
6090 (OP(first) == BRANCH && OP(first_next) != BRANCH) ||
6091 /* for now we can't handle lookbehind IFMATCH*/
6092 (OP(first) == IFMATCH && !first->flags && (sawlookahead = 1)) ||
6093 (OP(first) == PLUS) ||
6094 (OP(first) == MINMOD) ||
6095 /* An {n,m} with n>0 */
6096 (PL_regkind[OP(first)] == CURLY && ARG1(first) > 0) ||
6097 (OP(first) == NOTHING && PL_regkind[OP(first_next)] != END ))
6100 * the only op that could be a regnode is PLUS, all the rest
6101 * will be regnode_1 or regnode_2.
6103 * (yves doesn't think this is true)
6105 if (OP(first) == PLUS)
6108 if (OP(first) == MINMOD)
6110 first += regarglen[OP(first)];
6112 first = NEXTOPER(first);
6113 first_next= regnext(first);
6116 /* Starting-point info. */
6118 DEBUG_PEEP("first:",first,0);
6119 /* Ignore EXACT as we deal with it later. */
6120 if (PL_regkind[OP(first)] == EXACT) {
6121 if (OP(first) == EXACT)
6122 NOOP; /* Empty, get anchored substr later. */
6124 ri->regstclass = first;
6127 else if (PL_regkind[OP(first)] == TRIE &&
6128 ((reg_trie_data *)ri->data->data[ ARG(first) ])->minlen>0)
6131 /* this can happen only on restudy */
6132 if ( OP(first) == TRIE ) {
6133 struct regnode_1 *trieop = (struct regnode_1 *)
6134 PerlMemShared_calloc(1, sizeof(struct regnode_1));
6135 StructCopy(first,trieop,struct regnode_1);
6136 trie_op=(regnode *)trieop;
6138 struct regnode_charclass *trieop = (struct regnode_charclass *)
6139 PerlMemShared_calloc(1, sizeof(struct regnode_charclass));
6140 StructCopy(first,trieop,struct regnode_charclass);
6141 trie_op=(regnode *)trieop;
6144 make_trie_failtable(pRExC_state, (regnode *)first, trie_op, 0);
6145 ri->regstclass = trie_op;
6148 else if (REGNODE_SIMPLE(OP(first)))
6149 ri->regstclass = first;
6150 else if (PL_regkind[OP(first)] == BOUND ||
6151 PL_regkind[OP(first)] == NBOUND)
6152 ri->regstclass = first;
6153 else if (PL_regkind[OP(first)] == BOL) {
6154 r->extflags |= (OP(first) == MBOL
6156 : (OP(first) == SBOL
6159 first = NEXTOPER(first);
6162 else if (OP(first) == GPOS) {
6163 r->extflags |= RXf_ANCH_GPOS;
6164 first = NEXTOPER(first);
6167 else if ((!sawopen || !RExC_sawback) &&
6168 (OP(first) == STAR &&
6169 PL_regkind[OP(NEXTOPER(first))] == REG_ANY) &&
6170 !(r->extflags & RXf_ANCH) && !pRExC_state->num_code_blocks)
6172 /* turn .* into ^.* with an implied $*=1 */
6174 (OP(NEXTOPER(first)) == REG_ANY)
6177 r->extflags |= type;
6178 r->intflags |= PREGf_IMPLICIT;
6179 first = NEXTOPER(first);
6182 if (sawplus && !sawminmod && !sawlookahead && (!sawopen || !RExC_sawback)
6183 && !pRExC_state->num_code_blocks) /* May examine pos and $& */
6184 /* x+ must match at the 1st pos of run of x's */
6185 r->intflags |= PREGf_SKIP;
6187 /* Scan is after the zeroth branch, first is atomic matcher. */
6188 #ifdef TRIE_STUDY_OPT
6191 PerlIO_printf(Perl_debug_log, "first at %"IVdf"\n",
6192 (IV)(first - scan + 1))
6196 PerlIO_printf(Perl_debug_log, "first at %"IVdf"\n",
6197 (IV)(first - scan + 1))
6203 * If there's something expensive in the r.e., find the
6204 * longest literal string that must appear and make it the
6205 * regmust. Resolve ties in favor of later strings, since
6206 * the regstart check works with the beginning of the r.e.
6207 * and avoiding duplication strengthens checking. Not a
6208 * strong reason, but sufficient in the absence of others.
6209 * [Now we resolve ties in favor of the earlier string if
6210 * it happens that c_offset_min has been invalidated, since the
6211 * earlier string may buy us something the later one won't.]
6214 data.longest_fixed = newSVpvs("");
6215 data.longest_float = newSVpvs("");
6216 data.last_found = newSVpvs("");
6217 data.longest = &(data.longest_fixed);
6218 ENTER_with_name("study_chunk");
6219 SAVEFREESV(data.longest_fixed);
6220 SAVEFREESV(data.longest_float);
6221 SAVEFREESV(data.last_found);
6223 if (!ri->regstclass) {
6224 cl_init(pRExC_state, &ch_class);
6225 data.start_class = &ch_class;
6226 stclass_flag = SCF_DO_STCLASS_AND;
6227 } else /* XXXX Check for BOUND? */
6229 data.last_closep = &last_close;
6231 minlen = study_chunk(pRExC_state, &first, &minlen, &fake, scan + RExC_size, /* Up to end */
6232 &data, -1, NULL, NULL,
6233 SCF_DO_SUBSTR | SCF_WHILEM_VISITED_POS | stclass_flag
6234 | (restudied ? SCF_TRIE_DOING_RESTUDY : 0),
6238 CHECK_RESTUDY_GOTO_butfirst(LEAVE_with_name("study_chunk"));
6241 if ( RExC_npar == 1 && data.longest == &(data.longest_fixed)
6242 && data.last_start_min == 0 && data.last_end > 0
6243 && !RExC_seen_zerolen
6244 && !(RExC_seen & REG_SEEN_VERBARG)
6245 && (!(RExC_seen & REG_SEEN_GPOS) || (r->extflags & RXf_ANCH_GPOS)))
6246 r->extflags |= RXf_CHECK_ALL;
6247 scan_commit(pRExC_state, &data,&minlen,0);
6249 longest_float_length = CHR_SVLEN(data.longest_float);
6251 if (! ((SvCUR(data.longest_fixed) /* ok to leave SvCUR */
6252 && data.offset_fixed == data.offset_float_min
6253 && SvCUR(data.longest_fixed) == SvCUR(data.longest_float)))
6254 && S_setup_longest (aTHX_ pRExC_state,
6258 &(r->float_end_shift),
6259 data.lookbehind_float,
6260 data.offset_float_min,
6262 longest_float_length,
6263 cBOOL(data.flags & SF_FL_BEFORE_EOL),
6264 cBOOL(data.flags & SF_FL_BEFORE_MEOL)))
6266 r->float_min_offset = data.offset_float_min - data.lookbehind_float;
6267 r->float_max_offset = data.offset_float_max;
6268 if (data.offset_float_max < I32_MAX) /* Don't offset infinity */
6269 r->float_max_offset -= data.lookbehind_float;
6270 SvREFCNT_inc_simple_void_NN(data.longest_float);
6273 r->float_substr = r->float_utf8 = NULL;
6274 longest_float_length = 0;
6277 longest_fixed_length = CHR_SVLEN(data.longest_fixed);
6279 if (S_setup_longest (aTHX_ pRExC_state,
6281 &(r->anchored_utf8),
6282 &(r->anchored_substr),
6283 &(r->anchored_end_shift),
6284 data.lookbehind_fixed,
6287 longest_fixed_length,
6288 cBOOL(data.flags & SF_FIX_BEFORE_EOL),
6289 cBOOL(data.flags & SF_FIX_BEFORE_MEOL)))
6291 r->anchored_offset = data.offset_fixed - data.lookbehind_fixed;
6292 SvREFCNT_inc_simple_void_NN(data.longest_fixed);
6295 r->anchored_substr = r->anchored_utf8 = NULL;
6296 longest_fixed_length = 0;
6298 LEAVE_with_name("study_chunk");
6301 && (OP(ri->regstclass) == REG_ANY || OP(ri->regstclass) == SANY))
6302 ri->regstclass = NULL;
6304 if ((!(r->anchored_substr || r->anchored_utf8) || r->anchored_offset)
6306 && ! TEST_SSC_EOS(data.start_class)
6307 && !cl_is_anything(data.start_class))
6309 const U32 n = add_data(pRExC_state, 1, "f");
6310 OP(data.start_class) = ANYOF_SYNTHETIC;
6312 Newx(RExC_rxi->data->data[n], 1,
6313 struct regnode_charclass_class);
6314 StructCopy(data.start_class,
6315 (struct regnode_charclass_class*)RExC_rxi->data->data[n],
6316 struct regnode_charclass_class);
6317 ri->regstclass = (regnode*)RExC_rxi->data->data[n];
6318 r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
6319 DEBUG_COMPILE_r({ SV *sv = sv_newmortal();
6320 regprop(r, sv, (regnode*)data.start_class);
6321 PerlIO_printf(Perl_debug_log,
6322 "synthetic stclass \"%s\".\n",
6323 SvPVX_const(sv));});
6326 /* A temporary algorithm prefers floated substr to fixed one to dig more info. */
6327 if (longest_fixed_length > longest_float_length) {
6328 r->check_end_shift = r->anchored_end_shift;
6329 r->check_substr = r->anchored_substr;
6330 r->check_utf8 = r->anchored_utf8;
6331 r->check_offset_min = r->check_offset_max = r->anchored_offset;
6332 if (r->extflags & RXf_ANCH_SINGLE)
6333 r->extflags |= RXf_NOSCAN;
6336 r->check_end_shift = r->float_end_shift;
6337 r->check_substr = r->float_substr;
6338 r->check_utf8 = r->float_utf8;
6339 r->check_offset_min = r->float_min_offset;
6340 r->check_offset_max = r->float_max_offset;
6342 /* XXXX Currently intuiting is not compatible with ANCH_GPOS.
6343 This should be changed ASAP! */
6344 if ((r->check_substr || r->check_utf8) && !(r->extflags & RXf_ANCH_GPOS)) {
6345 r->extflags |= RXf_USE_INTUIT;
6346 if (SvTAIL(r->check_substr ? r->check_substr : r->check_utf8))
6347 r->extflags |= RXf_INTUIT_TAIL;
6349 /* XXX Unneeded? dmq (shouldn't as this is handled elsewhere)
6350 if ( (STRLEN)minlen < longest_float_length )
6351 minlen= longest_float_length;
6352 if ( (STRLEN)minlen < longest_fixed_length )
6353 minlen= longest_fixed_length;
6357 /* Several toplevels. Best we can is to set minlen. */
6359 struct regnode_charclass_class ch_class;
6362 DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log, "\nMulti Top Level\n"));
6364 scan = ri->program + 1;
6365 cl_init(pRExC_state, &ch_class);
6366 data.start_class = &ch_class;
6367 data.last_closep = &last_close;
6370 minlen = study_chunk(pRExC_state, &scan, &minlen, &fake, scan + RExC_size,
6371 &data, -1, NULL, NULL,
6372 SCF_DO_STCLASS_AND|SCF_WHILEM_VISITED_POS
6373 |(restudied ? SCF_TRIE_DOING_RESTUDY : 0),
6376 CHECK_RESTUDY_GOTO_butfirst(NOOP);
6378 r->check_substr = r->check_utf8 = r->anchored_substr = r->anchored_utf8
6379 = r->float_substr = r->float_utf8 = NULL;
6381 if (! TEST_SSC_EOS(data.start_class)
6382 && !cl_is_anything(data.start_class))
6384 const U32 n = add_data(pRExC_state, 1, "f");
6385 OP(data.start_class) = ANYOF_SYNTHETIC;
6387 Newx(RExC_rxi->data->data[n], 1,
6388 struct regnode_charclass_class);
6389 StructCopy(data.start_class,
6390 (struct regnode_charclass_class*)RExC_rxi->data->data[n],
6391 struct regnode_charclass_class);
6392 ri->regstclass = (regnode*)RExC_rxi->data->data[n];
6393 r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
6394 DEBUG_COMPILE_r({ SV* sv = sv_newmortal();
6395 regprop(r, sv, (regnode*)data.start_class);
6396 PerlIO_printf(Perl_debug_log,
6397 "synthetic stclass \"%s\".\n",
6398 SvPVX_const(sv));});
6402 /* Guard against an embedded (?=) or (?<=) with a longer minlen than
6403 the "real" pattern. */
6405 PerlIO_printf(Perl_debug_log,"minlen: %"IVdf" r->minlen:%"IVdf"\n",
6406 (IV)minlen, (IV)r->minlen);
6408 r->minlenret = minlen;
6409 if (r->minlen < minlen)
6412 if (RExC_seen & REG_SEEN_GPOS)
6413 r->extflags |= RXf_GPOS_SEEN;
6414 if (RExC_seen & REG_SEEN_LOOKBEHIND)
6415 r->extflags |= RXf_NO_INPLACE_SUBST; /* inplace might break the lookbehind */
6416 if (pRExC_state->num_code_blocks)
6417 r->extflags |= RXf_EVAL_SEEN;
6418 if (RExC_seen & REG_SEEN_CANY)
6419 r->extflags |= RXf_CANY_SEEN;
6420 if (RExC_seen & REG_SEEN_VERBARG)
6422 r->intflags |= PREGf_VERBARG_SEEN;
6423 r->extflags |= RXf_NO_INPLACE_SUBST; /* don't understand this! Yves */
6425 if (RExC_seen & REG_SEEN_CUTGROUP)
6426 r->intflags |= PREGf_CUTGROUP_SEEN;
6427 if (pm_flags & PMf_USE_RE_EVAL)
6428 r->intflags |= PREGf_USE_RE_EVAL;
6429 if (RExC_paren_names)
6430 RXp_PAREN_NAMES(r) = MUTABLE_HV(SvREFCNT_inc(RExC_paren_names));
6432 RXp_PAREN_NAMES(r) = NULL;
6435 regnode *first = ri->program + 1;
6437 regnode *next = NEXTOPER(first);
6440 if (PL_regkind[fop] == NOTHING && nop == END)
6441 r->extflags |= RXf_NULL;
6442 else if (PL_regkind[fop] == BOL && nop == END)
6443 r->extflags |= RXf_START_ONLY;
6444 else if (fop == PLUS && PL_regkind[nop] == POSIXD && FLAGS(next) == _CC_SPACE && OP(regnext(first)) == END)
6445 r->extflags |= RXf_WHITE;
6446 else if ( r->extflags & RXf_SPLIT && fop == EXACT && STR_LEN(first) == 1 && *(STRING(first)) == ' ' && OP(regnext(first)) == END )
6447 r->extflags |= (RXf_SKIPWHITE|RXf_WHITE);
6451 if (RExC_paren_names) {
6452 ri->name_list_idx = add_data( pRExC_state, 1, "a" );
6453 ri->data->data[ri->name_list_idx] = (void*)SvREFCNT_inc(RExC_paren_name_list);
6456 ri->name_list_idx = 0;
6458 if (RExC_recurse_count) {
6459 for ( ; RExC_recurse_count ; RExC_recurse_count-- ) {
6460 const regnode *scan = RExC_recurse[RExC_recurse_count-1];
6461 ARG2L_SET( scan, RExC_open_parens[ARG(scan)-1] - scan );
6464 Newxz(r->offs, RExC_npar, regexp_paren_pair);
6465 /* assume we don't need to swap parens around before we match */
6468 PerlIO_printf(Perl_debug_log,"Final program:\n");
6471 #ifdef RE_TRACK_PATTERN_OFFSETS
6472 DEBUG_OFFSETS_r(if (ri->u.offsets) {
6473 const U32 len = ri->u.offsets[0];
6475 GET_RE_DEBUG_FLAGS_DECL;
6476 PerlIO_printf(Perl_debug_log, "Offsets: [%"UVuf"]\n\t", (UV)ri->u.offsets[0]);
6477 for (i = 1; i <= len; i++) {
6478 if (ri->u.offsets[i*2-1] || ri->u.offsets[i*2])
6479 PerlIO_printf(Perl_debug_log, "%"UVuf":%"UVuf"[%"UVuf"] ",
6480 (UV)i, (UV)ri->u.offsets[i*2-1], (UV)ri->u.offsets[i*2]);
6482 PerlIO_printf(Perl_debug_log, "\n");
6487 /* under ithreads the ?pat? PMf_USED flag on the pmop is simulated
6488 * by setting the regexp SV to readonly-only instead. If the
6489 * pattern's been recompiled, the USEDness should remain. */
6490 if (old_re && SvREADONLY(old_re))
6498 Perl_reg_named_buff(pTHX_ REGEXP * const rx, SV * const key, SV * const value,
6501 PERL_ARGS_ASSERT_REG_NAMED_BUFF;
6503 PERL_UNUSED_ARG(value);
6505 if (flags & RXapif_FETCH) {
6506 return reg_named_buff_fetch(rx, key, flags);
6507 } else if (flags & (RXapif_STORE | RXapif_DELETE | RXapif_CLEAR)) {
6508 Perl_croak_no_modify();
6510 } else if (flags & RXapif_EXISTS) {
6511 return reg_named_buff_exists(rx, key, flags)
6514 } else if (flags & RXapif_REGNAMES) {
6515 return reg_named_buff_all(rx, flags);
6516 } else if (flags & (RXapif_SCALAR | RXapif_REGNAMES_COUNT)) {
6517 return reg_named_buff_scalar(rx, flags);
6519 Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff", (int)flags);
6525 Perl_reg_named_buff_iter(pTHX_ REGEXP * const rx, const SV * const lastkey,
6528 PERL_ARGS_ASSERT_REG_NAMED_BUFF_ITER;
6529 PERL_UNUSED_ARG(lastkey);
6531 if (flags & RXapif_FIRSTKEY)
6532 return reg_named_buff_firstkey(rx, flags);
6533 else if (flags & RXapif_NEXTKEY)
6534 return reg_named_buff_nextkey(rx, flags);
6536 Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_iter", (int)flags);
6542 Perl_reg_named_buff_fetch(pTHX_ REGEXP * const r, SV * const namesv,
6545 AV *retarray = NULL;
6547 struct regexp *const rx = ReANY(r);
6549 PERL_ARGS_ASSERT_REG_NAMED_BUFF_FETCH;
6551 if (flags & RXapif_ALL)
6554 if (rx && RXp_PAREN_NAMES(rx)) {
6555 HE *he_str = hv_fetch_ent( RXp_PAREN_NAMES(rx), namesv, 0, 0 );
6558 SV* sv_dat=HeVAL(he_str);
6559 I32 *nums=(I32*)SvPVX(sv_dat);
6560 for ( i=0; i<SvIVX(sv_dat); i++ ) {
6561 if ((I32)(rx->nparens) >= nums[i]
6562 && rx->offs[nums[i]].start != -1
6563 && rx->offs[nums[i]].end != -1)
6566 CALLREG_NUMBUF_FETCH(r,nums[i],ret);
6571 ret = newSVsv(&PL_sv_undef);
6574 av_push(retarray, ret);
6577 return newRV_noinc(MUTABLE_SV(retarray));
6584 Perl_reg_named_buff_exists(pTHX_ REGEXP * const r, SV * const key,
6587 struct regexp *const rx = ReANY(r);
6589 PERL_ARGS_ASSERT_REG_NAMED_BUFF_EXISTS;
6591 if (rx && RXp_PAREN_NAMES(rx)) {
6592 if (flags & RXapif_ALL) {
6593 return hv_exists_ent(RXp_PAREN_NAMES(rx), key, 0);
6595 SV *sv = CALLREG_NAMED_BUFF_FETCH(r, key, flags);
6597 SvREFCNT_dec_NN(sv);
6609 Perl_reg_named_buff_firstkey(pTHX_ REGEXP * const r, const U32 flags)
6611 struct regexp *const rx = ReANY(r);
6613 PERL_ARGS_ASSERT_REG_NAMED_BUFF_FIRSTKEY;
6615 if ( rx && RXp_PAREN_NAMES(rx) ) {
6616 (void)hv_iterinit(RXp_PAREN_NAMES(rx));
6618 return CALLREG_NAMED_BUFF_NEXTKEY(r, NULL, flags & ~RXapif_FIRSTKEY);
6625 Perl_reg_named_buff_nextkey(pTHX_ REGEXP * const r, const U32 flags)
6627 struct regexp *const rx = ReANY(r);
6628 GET_RE_DEBUG_FLAGS_DECL;
6630 PERL_ARGS_ASSERT_REG_NAMED_BUFF_NEXTKEY;
6632 if (rx && RXp_PAREN_NAMES(rx)) {
6633 HV *hv = RXp_PAREN_NAMES(rx);
6635 while ( (temphe = hv_iternext_flags(hv,0)) ) {
6638 SV* sv_dat = HeVAL(temphe);
6639 I32 *nums = (I32*)SvPVX(sv_dat);
6640 for ( i = 0; i < SvIVX(sv_dat); i++ ) {
6641 if ((I32)(rx->lastparen) >= nums[i] &&
6642 rx->offs[nums[i]].start != -1 &&
6643 rx->offs[nums[i]].end != -1)
6649 if (parno || flags & RXapif_ALL) {
6650 return newSVhek(HeKEY_hek(temphe));
6658 Perl_reg_named_buff_scalar(pTHX_ REGEXP * const r, const U32 flags)
6663 struct regexp *const rx = ReANY(r);
6665 PERL_ARGS_ASSERT_REG_NAMED_BUFF_SCALAR;
6667 if (rx && RXp_PAREN_NAMES(rx)) {
6668 if (flags & (RXapif_ALL | RXapif_REGNAMES_COUNT)) {
6669 return newSViv(HvTOTALKEYS(RXp_PAREN_NAMES(rx)));
6670 } else if (flags & RXapif_ONE) {
6671 ret = CALLREG_NAMED_BUFF_ALL(r, (flags | RXapif_REGNAMES));
6672 av = MUTABLE_AV(SvRV(ret));
6673 length = av_len(av);
6674 SvREFCNT_dec_NN(ret);
6675 return newSViv(length + 1);
6677 Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_scalar", (int)flags);
6681 return &PL_sv_undef;
6685 Perl_reg_named_buff_all(pTHX_ REGEXP * const r, const U32 flags)
6687 struct regexp *const rx = ReANY(r);
6690 PERL_ARGS_ASSERT_REG_NAMED_BUFF_ALL;
6692 if (rx && RXp_PAREN_NAMES(rx)) {
6693 HV *hv= RXp_PAREN_NAMES(rx);
6695 (void)hv_iterinit(hv);
6696 while ( (temphe = hv_iternext_flags(hv,0)) ) {
6699 SV* sv_dat = HeVAL(temphe);
6700 I32 *nums = (I32*)SvPVX(sv_dat);
6701 for ( i = 0; i < SvIVX(sv_dat); i++ ) {
6702 if ((I32)(rx->lastparen) >= nums[i] &&
6703 rx->offs[nums[i]].start != -1 &&
6704 rx->offs[nums[i]].end != -1)
6710 if (parno || flags & RXapif_ALL) {
6711 av_push(av, newSVhek(HeKEY_hek(temphe)));
6716 return newRV_noinc(MUTABLE_SV(av));
6720 Perl_reg_numbered_buff_fetch(pTHX_ REGEXP * const r, const I32 paren,
6723 struct regexp *const rx = ReANY(r);
6729 PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_FETCH;
6731 if ( ( n == RX_BUFF_IDX_CARET_PREMATCH
6732 || n == RX_BUFF_IDX_CARET_FULLMATCH
6733 || n == RX_BUFF_IDX_CARET_POSTMATCH
6735 && !(rx->extflags & RXf_PMf_KEEPCOPY)
6742 if (n == RX_BUFF_IDX_CARET_FULLMATCH)
6743 /* no need to distinguish between them any more */
6744 n = RX_BUFF_IDX_FULLMATCH;
6746 if ((n == RX_BUFF_IDX_PREMATCH || n == RX_BUFF_IDX_CARET_PREMATCH)
6747 && rx->offs[0].start != -1)
6749 /* $`, ${^PREMATCH} */
6750 i = rx->offs[0].start;
6754 if ((n == RX_BUFF_IDX_POSTMATCH || n == RX_BUFF_IDX_CARET_POSTMATCH)
6755 && rx->offs[0].end != -1)
6757 /* $', ${^POSTMATCH} */
6758 s = rx->subbeg - rx->suboffset + rx->offs[0].end;
6759 i = rx->sublen + rx->suboffset - rx->offs[0].end;
6762 if ( 0 <= n && n <= (I32)rx->nparens &&
6763 (s1 = rx->offs[n].start) != -1 &&
6764 (t1 = rx->offs[n].end) != -1)
6766 /* $&, ${^MATCH}, $1 ... */
6768 s = rx->subbeg + s1 - rx->suboffset;
6773 assert(s >= rx->subbeg);
6774 assert(rx->sublen >= (s - rx->subbeg) + i );
6776 #if NO_TAINT_SUPPORT
6777 sv_setpvn(sv, s, i);
6779 const int oldtainted = TAINT_get;
6781 sv_setpvn(sv, s, i);
6782 TAINT_set(oldtainted);
6784 if ( (rx->extflags & RXf_CANY_SEEN)
6785 ? (RXp_MATCH_UTF8(rx)
6786 && (!i || is_utf8_string((U8*)s, i)))
6787 : (RXp_MATCH_UTF8(rx)) )
6794 if (RXp_MATCH_TAINTED(rx)) {
6795 if (SvTYPE(sv) >= SVt_PVMG) {
6796 MAGIC* const mg = SvMAGIC(sv);
6799 SvMAGIC_set(sv, mg->mg_moremagic);
6801 if ((mgt = SvMAGIC(sv))) {
6802 mg->mg_moremagic = mgt;
6803 SvMAGIC_set(sv, mg);
6814 sv_setsv(sv,&PL_sv_undef);
6820 Perl_reg_numbered_buff_store(pTHX_ REGEXP * const rx, const I32 paren,
6821 SV const * const value)
6823 PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_STORE;
6825 PERL_UNUSED_ARG(rx);
6826 PERL_UNUSED_ARG(paren);
6827 PERL_UNUSED_ARG(value);
6830 Perl_croak_no_modify();
6834 Perl_reg_numbered_buff_length(pTHX_ REGEXP * const r, const SV * const sv,
6837 struct regexp *const rx = ReANY(r);
6841 PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_LENGTH;
6843 /* Some of this code was originally in C<Perl_magic_len> in F<mg.c> */
6845 case RX_BUFF_IDX_CARET_PREMATCH: /* ${^PREMATCH} */
6846 if (!(rx->extflags & RXf_PMf_KEEPCOPY))
6850 case RX_BUFF_IDX_PREMATCH: /* $` */
6851 if (rx->offs[0].start != -1) {
6852 i = rx->offs[0].start;
6861 case RX_BUFF_IDX_CARET_POSTMATCH: /* ${^POSTMATCH} */
6862 if (!(rx->extflags & RXf_PMf_KEEPCOPY))
6864 case RX_BUFF_IDX_POSTMATCH: /* $' */
6865 if (rx->offs[0].end != -1) {
6866 i = rx->sublen - rx->offs[0].end;
6868 s1 = rx->offs[0].end;
6875 case RX_BUFF_IDX_CARET_FULLMATCH: /* ${^MATCH} */
6876 if (!(rx->extflags & RXf_PMf_KEEPCOPY))
6880 /* $& / ${^MATCH}, $1, $2, ... */
6882 if (paren <= (I32)rx->nparens &&
6883 (s1 = rx->offs[paren].start) != -1 &&
6884 (t1 = rx->offs[paren].end) != -1)
6890 if (ckWARN(WARN_UNINITIALIZED))
6891 report_uninit((const SV *)sv);
6896 if (i > 0 && RXp_MATCH_UTF8(rx)) {
6897 const char * const s = rx->subbeg - rx->suboffset + s1;
6902 if (is_utf8_string_loclen((U8*)s, i, &ep, &el))
6909 Perl_reg_qr_package(pTHX_ REGEXP * const rx)
6911 PERL_ARGS_ASSERT_REG_QR_PACKAGE;
6912 PERL_UNUSED_ARG(rx);
6916 return newSVpvs("Regexp");
6919 /* Scans the name of a named buffer from the pattern.
6920 * If flags is REG_RSN_RETURN_NULL returns null.
6921 * If flags is REG_RSN_RETURN_NAME returns an SV* containing the name
6922 * If flags is REG_RSN_RETURN_DATA returns the data SV* corresponding
6923 * to the parsed name as looked up in the RExC_paren_names hash.
6924 * If there is an error throws a vFAIL().. type exception.
6927 #define REG_RSN_RETURN_NULL 0
6928 #define REG_RSN_RETURN_NAME 1
6929 #define REG_RSN_RETURN_DATA 2
6932 S_reg_scan_name(pTHX_ RExC_state_t *pRExC_state, U32 flags)
6934 char *name_start = RExC_parse;
6936 PERL_ARGS_ASSERT_REG_SCAN_NAME;
6938 if (isIDFIRST_lazy_if(RExC_parse, UTF)) {
6939 /* skip IDFIRST by using do...while */
6942 RExC_parse += UTF8SKIP(RExC_parse);
6943 } while (isWORDCHAR_utf8((U8*)RExC_parse));
6947 } while (isWORDCHAR(*RExC_parse));
6949 RExC_parse++; /* so the <- from the vFAIL is after the offending character */
6950 vFAIL("Group name must start with a non-digit word character");
6954 = newSVpvn_flags(name_start, (int)(RExC_parse - name_start),
6955 SVs_TEMP | (UTF ? SVf_UTF8 : 0));
6956 if ( flags == REG_RSN_RETURN_NAME)
6958 else if (flags==REG_RSN_RETURN_DATA) {
6961 if ( ! sv_name ) /* should not happen*/
6962 Perl_croak(aTHX_ "panic: no svname in reg_scan_name");
6963 if (RExC_paren_names)
6964 he_str = hv_fetch_ent( RExC_paren_names, sv_name, 0, 0 );
6966 sv_dat = HeVAL(he_str);
6968 vFAIL("Reference to nonexistent named group");
6972 Perl_croak(aTHX_ "panic: bad flag %lx in reg_scan_name",
6973 (unsigned long) flags);
6975 assert(0); /* NOT REACHED */
6980 #define DEBUG_PARSE_MSG(funcname) DEBUG_PARSE_r({ \
6981 int rem=(int)(RExC_end - RExC_parse); \
6990 if (RExC_lastparse!=RExC_parse) \
6991 PerlIO_printf(Perl_debug_log," >%.*s%-*s", \
6994 iscut ? "..." : "<" \
6997 PerlIO_printf(Perl_debug_log,"%16s",""); \
7000 num = RExC_size + 1; \
7002 num=REG_NODE_NUM(RExC_emit); \
7003 if (RExC_lastnum!=num) \
7004 PerlIO_printf(Perl_debug_log,"|%4d",num); \
7006 PerlIO_printf(Perl_debug_log,"|%4s",""); \
7007 PerlIO_printf(Perl_debug_log,"|%*s%-4s", \
7008 (int)((depth*2)), "", \
7012 RExC_lastparse=RExC_parse; \
7017 #define DEBUG_PARSE(funcname) DEBUG_PARSE_r({ \
7018 DEBUG_PARSE_MSG((funcname)); \
7019 PerlIO_printf(Perl_debug_log,"%4s","\n"); \
7021 #define DEBUG_PARSE_FMT(funcname,fmt,args) DEBUG_PARSE_r({ \
7022 DEBUG_PARSE_MSG((funcname)); \
7023 PerlIO_printf(Perl_debug_log,fmt "\n",args); \
7026 /* This section of code defines the inversion list object and its methods. The
7027 * interfaces are highly subject to change, so as much as possible is static to
7028 * this file. An inversion list is here implemented as a malloc'd C UV array
7029 * as an SVt_INVLIST scalar.
7031 * An inversion list for Unicode is an array of code points, sorted by ordinal
7032 * number. The zeroth element is the first code point in the list. The 1th
7033 * element is the first element beyond that not in the list. In other words,
7034 * the first range is
7035 * invlist[0]..(invlist[1]-1)
7036 * The other ranges follow. Thus every element whose index is divisible by two
7037 * marks the beginning of a range that is in the list, and every element not
7038 * divisible by two marks the beginning of a range not in the list. A single
7039 * element inversion list that contains the single code point N generally
7040 * consists of two elements
7043 * (The exception is when N is the highest representable value on the
7044 * machine, in which case the list containing just it would be a single
7045 * element, itself. By extension, if the last range in the list extends to
7046 * infinity, then the first element of that range will be in the inversion list
7047 * at a position that is divisible by two, and is the final element in the
7049 * Taking the complement (inverting) an inversion list is quite simple, if the
7050 * first element is 0, remove it; otherwise add a 0 element at the beginning.
7051 * This implementation reserves an element at the beginning of each inversion
7052 * list to always contain 0; there is an additional flag in the header which
7053 * indicates if the list begins at the 0, or is offset to begin at the next
7056 * More about inversion lists can be found in "Unicode Demystified"
7057 * Chapter 13 by Richard Gillam, published by Addison-Wesley.
7058 * More will be coming when functionality is added later.
7060 * The inversion list data structure is currently implemented as an SV pointing
7061 * to an array of UVs that the SV thinks are bytes. This allows us to have an
7062 * array of UV whose memory management is automatically handled by the existing
7063 * facilities for SV's.
7065 * Some of the methods should always be private to the implementation, and some
7066 * should eventually be made public */
7068 /* The header definitions are in F<inline_invlist.c> */
7070 PERL_STATIC_INLINE UV*
7071 S__invlist_array_init(pTHX_ SV* const invlist, const bool will_have_0)
7073 /* Returns a pointer to the first element in the inversion list's array.
7074 * This is called upon initialization of an inversion list. Where the
7075 * array begins depends on whether the list has the code point U+0000 in it
7076 * or not. The other parameter tells it whether the code that follows this
7077 * call is about to put a 0 in the inversion list or not. The first
7078 * element is either the element reserved for 0, if TRUE, or the element
7079 * after it, if FALSE */
7081 bool* offset = get_invlist_offset_addr(invlist);
7082 UV* zero_addr = (UV *) SvPVX(invlist);
7084 PERL_ARGS_ASSERT__INVLIST_ARRAY_INIT;
7087 assert(! _invlist_len(invlist));
7091 /* 1^1 = 0; 1^0 = 1 */
7092 *offset = 1 ^ will_have_0;
7093 return zero_addr + *offset;
7096 PERL_STATIC_INLINE UV*
7097 S_invlist_array(pTHX_ SV* const invlist)
7099 /* Returns the pointer to the inversion list's array. Every time the
7100 * length changes, this needs to be called in case malloc or realloc moved
7103 PERL_ARGS_ASSERT_INVLIST_ARRAY;
7105 /* Must not be empty. If these fail, you probably didn't check for <len>
7106 * being non-zero before trying to get the array */
7107 assert(_invlist_len(invlist));
7109 /* The very first element always contains zero, The array begins either
7110 * there, or if the inversion list is offset, at the element after it.
7111 * The offset header field determines which; it contains 0 or 1 to indicate
7112 * how much additionally to add */
7113 assert(0 == *(SvPVX(invlist)));
7114 return ((UV *) SvPVX(invlist) + *get_invlist_offset_addr(invlist));
7117 PERL_STATIC_INLINE void
7118 S_invlist_set_len(pTHX_ SV* const invlist, const UV len, const bool offset)
7120 /* Sets the current number of elements stored in the inversion list.
7121 * Updates SvCUR correspondingly */
7123 PERL_ARGS_ASSERT_INVLIST_SET_LEN;
7125 assert(SvTYPE(invlist) == SVt_INVLIST);
7130 : TO_INTERNAL_SIZE(len + offset));
7131 assert(SvLEN(invlist) == 0 || SvCUR(invlist) <= SvLEN(invlist));
7134 PERL_STATIC_INLINE IV*
7135 S_get_invlist_previous_index_addr(pTHX_ SV* invlist)
7137 /* Return the address of the IV that is reserved to hold the cached index
7140 PERL_ARGS_ASSERT_GET_INVLIST_PREVIOUS_INDEX_ADDR;
7142 assert(SvTYPE(invlist) == SVt_INVLIST);
7144 return &(((XINVLIST*) SvANY(invlist))->prev_index);
7147 PERL_STATIC_INLINE IV
7148 S_invlist_previous_index(pTHX_ SV* const invlist)
7150 /* Returns cached index of previous search */
7152 PERL_ARGS_ASSERT_INVLIST_PREVIOUS_INDEX;
7154 return *get_invlist_previous_index_addr(invlist);
7157 PERL_STATIC_INLINE void
7158 S_invlist_set_previous_index(pTHX_ SV* const invlist, const IV index)
7160 /* Caches <index> for later retrieval */
7162 PERL_ARGS_ASSERT_INVLIST_SET_PREVIOUS_INDEX;
7164 assert(index == 0 || index < (int) _invlist_len(invlist));
7166 *get_invlist_previous_index_addr(invlist) = index;
7169 PERL_STATIC_INLINE UV
7170 S_invlist_max(pTHX_ SV* const invlist)
7172 /* Returns the maximum number of elements storable in the inversion list's
7173 * array, without having to realloc() */
7175 PERL_ARGS_ASSERT_INVLIST_MAX;
7177 assert(SvTYPE(invlist) == SVt_INVLIST);
7179 /* Assumes worst case, in which the 0 element is not counted in the
7180 * inversion list, so subtracts 1 for that */
7181 return SvLEN(invlist) == 0 /* This happens under _new_invlist_C_array */
7182 ? FROM_INTERNAL_SIZE(SvCUR(invlist)) - 1
7183 : FROM_INTERNAL_SIZE(SvLEN(invlist)) - 1;
7186 #ifndef PERL_IN_XSUB_RE
7188 Perl__new_invlist(pTHX_ IV initial_size)
7191 /* Return a pointer to a newly constructed inversion list, with enough
7192 * space to store 'initial_size' elements. If that number is negative, a
7193 * system default is used instead */
7197 if (initial_size < 0) {
7201 /* Allocate the initial space */
7202 new_list = newSV_type(SVt_INVLIST);
7204 /* First 1 is in case the zero element isn't in the list; second 1 is for
7206 SvGROW(new_list, TO_INTERNAL_SIZE(initial_size + 1) + 1);
7207 invlist_set_len(new_list, 0, 0);
7209 /* Force iterinit() to be used to get iteration to work */
7210 *get_invlist_iter_addr(new_list) = (STRLEN) UV_MAX;
7212 *get_invlist_previous_index_addr(new_list) = 0;
7219 S__new_invlist_C_array(pTHX_ const UV* const list)
7221 /* Return a pointer to a newly constructed inversion list, initialized to
7222 * point to <list>, which has to be in the exact correct inversion list
7223 * form, including internal fields. Thus this is a dangerous routine that
7224 * should not be used in the wrong hands. The passed in 'list' contains
7225 * several header fields at the beginning that are not part of the
7226 * inversion list body proper */
7228 const STRLEN length = (STRLEN) list[0];
7229 const UV version_id = list[1];
7230 const bool offset = cBOOL(list[2]);
7231 #define HEADER_LENGTH 3
7232 /* If any of the above changes in any way, you must change HEADER_LENGTH
7233 * (if appropriate) and regenerate INVLIST_VERSION_ID by running
7234 * perl -E 'say int(rand 2**31-1)'
7236 #define INVLIST_VERSION_ID 148565664 /* This is a combination of a version and
7237 data structure type, so that one being
7238 passed in can be validated to be an
7239 inversion list of the correct vintage.
7242 SV* invlist = newSV_type(SVt_INVLIST);
7244 PERL_ARGS_ASSERT__NEW_INVLIST_C_ARRAY;
7246 if (version_id != INVLIST_VERSION_ID) {
7247 Perl_croak(aTHX_ "panic: Incorrect version for previously generated inversion list");
7250 /* The generated array passed in includes header elements that aren't part
7251 * of the list proper, so start it just after them */
7252 SvPV_set(invlist, (char *) (list + HEADER_LENGTH));
7254 SvLEN_set(invlist, 0); /* Means we own the contents, and the system
7255 shouldn't touch it */
7257 *(get_invlist_offset_addr(invlist)) = offset;
7259 /* The 'length' passed to us is the physical number of elements in the
7260 * inversion list. But if there is an offset the logical number is one
7262 invlist_set_len(invlist, length - offset, offset);
7264 invlist_set_previous_index(invlist, 0);
7266 /* Initialize the iteration pointer. */
7267 invlist_iterfinish(invlist);
7273 S_invlist_extend(pTHX_ SV* const invlist, const UV new_max)
7275 /* Grow the maximum size of an inversion list */
7277 PERL_ARGS_ASSERT_INVLIST_EXTEND;
7279 assert(SvTYPE(invlist) == SVt_INVLIST);
7281 /* Add one to account for the zero element at the beginning which may not
7282 * be counted by the calling parameters */
7283 SvGROW((SV *)invlist, TO_INTERNAL_SIZE(new_max + 1));
7286 PERL_STATIC_INLINE void
7287 S_invlist_trim(pTHX_ SV* const invlist)
7289 PERL_ARGS_ASSERT_INVLIST_TRIM;
7291 assert(SvTYPE(invlist) == SVt_INVLIST);
7293 /* Change the length of the inversion list to how many entries it currently
7295 SvPV_shrink_to_cur((SV *) invlist);
7298 #define _invlist_union_complement_2nd(a, b, output) _invlist_union_maybe_complement_2nd(a, b, TRUE, output)
7301 S__append_range_to_invlist(pTHX_ SV* const invlist, const UV start, const UV end)
7303 /* Subject to change or removal. Append the range from 'start' to 'end' at
7304 * the end of the inversion list. The range must be above any existing
7308 UV max = invlist_max(invlist);
7309 UV len = _invlist_len(invlist);
7312 PERL_ARGS_ASSERT__APPEND_RANGE_TO_INVLIST;
7314 if (len == 0) { /* Empty lists must be initialized */
7315 offset = start != 0;
7316 array = _invlist_array_init(invlist, ! offset);
7319 /* Here, the existing list is non-empty. The current max entry in the
7320 * list is generally the first value not in the set, except when the
7321 * set extends to the end of permissible values, in which case it is
7322 * the first entry in that final set, and so this call is an attempt to
7323 * append out-of-order */
7325 UV final_element = len - 1;
7326 array = invlist_array(invlist);
7327 if (array[final_element] > start
7328 || ELEMENT_RANGE_MATCHES_INVLIST(final_element))
7330 Perl_croak(aTHX_ "panic: attempting to append to an inversion list, but wasn't at the end of the list, final=%"UVuf", start=%"UVuf", match=%c",
7331 array[final_element], start,
7332 ELEMENT_RANGE_MATCHES_INVLIST(final_element) ? 't' : 'f');
7335 /* Here, it is a legal append. If the new range begins with the first
7336 * value not in the set, it is extending the set, so the new first
7337 * value not in the set is one greater than the newly extended range.
7339 offset = *get_invlist_offset_addr(invlist);
7340 if (array[final_element] == start) {
7341 if (end != UV_MAX) {
7342 array[final_element] = end + 1;
7345 /* But if the end is the maximum representable on the machine,
7346 * just let the range that this would extend to have no end */
7347 invlist_set_len(invlist, len - 1, offset);
7353 /* Here the new range doesn't extend any existing set. Add it */
7355 len += 2; /* Includes an element each for the start and end of range */
7357 /* If wll overflow the existing space, extend, which may cause the array to
7360 invlist_extend(invlist, len);
7362 /* Have to set len here to avoid assert failure in invlist_array() */
7363 invlist_set_len(invlist, len, offset);
7365 array = invlist_array(invlist);
7368 invlist_set_len(invlist, len, offset);
7371 /* The next item on the list starts the range, the one after that is
7372 * one past the new range. */
7373 array[len - 2] = start;
7374 if (end != UV_MAX) {
7375 array[len - 1] = end + 1;
7378 /* But if the end is the maximum representable on the machine, just let
7379 * the range have no end */
7380 invlist_set_len(invlist, len - 1, offset);
7384 #ifndef PERL_IN_XSUB_RE
7387 Perl__invlist_search(pTHX_ SV* const invlist, const UV cp)
7389 /* Searches the inversion list for the entry that contains the input code
7390 * point <cp>. If <cp> is not in the list, -1 is returned. Otherwise, the
7391 * return value is the index into the list's array of the range that
7396 IV high = _invlist_len(invlist);
7397 const IV highest_element = high - 1;
7400 PERL_ARGS_ASSERT__INVLIST_SEARCH;
7402 /* If list is empty, return failure. */
7407 /* (We can't get the array unless we know the list is non-empty) */
7408 array = invlist_array(invlist);
7410 mid = invlist_previous_index(invlist);
7411 assert(mid >=0 && mid <= highest_element);
7413 /* <mid> contains the cache of the result of the previous call to this
7414 * function (0 the first time). See if this call is for the same result,
7415 * or if it is for mid-1. This is under the theory that calls to this
7416 * function will often be for related code points that are near each other.
7417 * And benchmarks show that caching gives better results. We also test
7418 * here if the code point is within the bounds of the list. These tests
7419 * replace others that would have had to be made anyway to make sure that
7420 * the array bounds were not exceeded, and these give us extra information
7421 * at the same time */
7422 if (cp >= array[mid]) {
7423 if (cp >= array[highest_element]) {
7424 return highest_element;
7427 /* Here, array[mid] <= cp < array[highest_element]. This means that
7428 * the final element is not the answer, so can exclude it; it also
7429 * means that <mid> is not the final element, so can refer to 'mid + 1'
7431 if (cp < array[mid + 1]) {
7437 else { /* cp < aray[mid] */
7438 if (cp < array[0]) { /* Fail if outside the array */
7442 if (cp >= array[mid - 1]) {
7447 /* Binary search. What we are looking for is <i> such that
7448 * array[i] <= cp < array[i+1]
7449 * The loop below converges on the i+1. Note that there may not be an
7450 * (i+1)th element in the array, and things work nonetheless */
7451 while (low < high) {
7452 mid = (low + high) / 2;
7453 assert(mid <= highest_element);
7454 if (array[mid] <= cp) { /* cp >= array[mid] */
7457 /* We could do this extra test to exit the loop early.
7458 if (cp < array[low]) {
7463 else { /* cp < array[mid] */
7470 invlist_set_previous_index(invlist, high);
7475 Perl__invlist_populate_swatch(pTHX_ SV* const invlist, const UV start, const UV end, U8* swatch)
7477 /* populates a swatch of a swash the same way swatch_get() does in utf8.c,
7478 * but is used when the swash has an inversion list. This makes this much
7479 * faster, as it uses a binary search instead of a linear one. This is
7480 * intimately tied to that function, and perhaps should be in utf8.c,
7481 * except it is intimately tied to inversion lists as well. It assumes
7482 * that <swatch> is all 0's on input */
7485 const IV len = _invlist_len(invlist);
7489 PERL_ARGS_ASSERT__INVLIST_POPULATE_SWATCH;
7491 if (len == 0) { /* Empty inversion list */
7495 array = invlist_array(invlist);
7497 /* Find which element it is */
7498 i = _invlist_search(invlist, start);
7500 /* We populate from <start> to <end> */
7501 while (current < end) {
7504 /* The inversion list gives the results for every possible code point
7505 * after the first one in the list. Only those ranges whose index is
7506 * even are ones that the inversion list matches. For the odd ones,
7507 * and if the initial code point is not in the list, we have to skip
7508 * forward to the next element */
7509 if (i == -1 || ! ELEMENT_RANGE_MATCHES_INVLIST(i)) {
7511 if (i >= len) { /* Finished if beyond the end of the array */
7515 if (current >= end) { /* Finished if beyond the end of what we
7517 if (LIKELY(end < UV_MAX)) {
7521 /* We get here when the upper bound is the maximum
7522 * representable on the machine, and we are looking for just
7523 * that code point. Have to special case it */
7525 goto join_end_of_list;
7528 assert(current >= start);
7530 /* The current range ends one below the next one, except don't go past
7533 upper = (i < len && array[i] < end) ? array[i] : end;
7535 /* Here we are in a range that matches. Populate a bit in the 3-bit U8
7536 * for each code point in it */
7537 for (; current < upper; current++) {
7538 const STRLEN offset = (STRLEN)(current - start);
7539 swatch[offset >> 3] |= 1 << (offset & 7);
7544 /* Quit if at the end of the list */
7547 /* But first, have to deal with the highest possible code point on
7548 * the platform. The previous code assumes that <end> is one
7549 * beyond where we want to populate, but that is impossible at the
7550 * platform's infinity, so have to handle it specially */
7551 if (UNLIKELY(end == UV_MAX && ELEMENT_RANGE_MATCHES_INVLIST(len-1)))
7553 const STRLEN offset = (STRLEN)(end - start);
7554 swatch[offset >> 3] |= 1 << (offset & 7);
7559 /* Advance to the next range, which will be for code points not in the
7568 Perl__invlist_union_maybe_complement_2nd(pTHX_ SV* const a, SV* const b, const bool complement_b, SV** output)
7570 /* Take the union of two inversion lists and point <output> to it. *output
7571 * SHOULD BE DEFINED upon input, and if it points to one of the two lists,
7572 * the reference count to that list will be decremented. The first list,
7573 * <a>, may be NULL, in which case a copy of the second list is returned.
7574 * If <complement_b> is TRUE, the union is taken of the complement
7575 * (inversion) of <b> instead of b itself.
7577 * The basis for this comes from "Unicode Demystified" Chapter 13 by
7578 * Richard Gillam, published by Addison-Wesley, and explained at some
7579 * length there. The preface says to incorporate its examples into your
7580 * code at your own risk.
7582 * The algorithm is like a merge sort.
7584 * XXX A potential performance improvement is to keep track as we go along
7585 * if only one of the inputs contributes to the result, meaning the other
7586 * is a subset of that one. In that case, we can skip the final copy and
7587 * return the larger of the input lists, but then outside code might need
7588 * to keep track of whether to free the input list or not */
7590 const UV* array_a; /* a's array */
7592 UV len_a; /* length of a's array */
7595 SV* u; /* the resulting union */
7599 UV i_a = 0; /* current index into a's array */
7603 /* running count, as explained in the algorithm source book; items are
7604 * stopped accumulating and are output when the count changes to/from 0.
7605 * The count is incremented when we start a range that's in the set, and
7606 * decremented when we start a range that's not in the set. So its range
7607 * is 0 to 2. Only when the count is zero is something not in the set.
7611 PERL_ARGS_ASSERT__INVLIST_UNION_MAYBE_COMPLEMENT_2ND;
7614 /* If either one is empty, the union is the other one */
7615 if (a == NULL || ((len_a = _invlist_len(a)) == 0)) {
7622 *output = invlist_clone(b);
7624 _invlist_invert(*output);
7626 } /* else *output already = b; */
7629 else if ((len_b = _invlist_len(b)) == 0) {
7634 /* The complement of an empty list is a list that has everything in it,
7635 * so the union with <a> includes everything too */
7640 *output = _new_invlist(1);
7641 _append_range_to_invlist(*output, 0, UV_MAX);
7643 else if (*output != a) {
7644 *output = invlist_clone(a);
7646 /* else *output already = a; */
7650 /* Here both lists exist and are non-empty */
7651 array_a = invlist_array(a);
7652 array_b = invlist_array(b);
7654 /* If are to take the union of 'a' with the complement of b, set it
7655 * up so are looking at b's complement. */
7658 /* To complement, we invert: if the first element is 0, remove it. To
7659 * do this, we just pretend the array starts one later */
7660 if (array_b[0] == 0) {
7666 /* But if the first element is not zero, we pretend the list starts
7667 * at the 0 that is always stored immediately before the array. */
7673 /* Size the union for the worst case: that the sets are completely
7675 u = _new_invlist(len_a + len_b);
7677 /* Will contain U+0000 if either component does */
7678 array_u = _invlist_array_init(u, (len_a > 0 && array_a[0] == 0)
7679 || (len_b > 0 && array_b[0] == 0));
7681 /* Go through each list item by item, stopping when exhausted one of
7683 while (i_a < len_a && i_b < len_b) {
7684 UV cp; /* The element to potentially add to the union's array */
7685 bool cp_in_set; /* is it in the the input list's set or not */
7687 /* We need to take one or the other of the two inputs for the union.
7688 * Since we are merging two sorted lists, we take the smaller of the
7689 * next items. In case of a tie, we take the one that is in its set
7690 * first. If we took one not in the set first, it would decrement the
7691 * count, possibly to 0 which would cause it to be output as ending the
7692 * range, and the next time through we would take the same number, and
7693 * output it again as beginning the next range. By doing it the
7694 * opposite way, there is no possibility that the count will be
7695 * momentarily decremented to 0, and thus the two adjoining ranges will
7696 * be seamlessly merged. (In a tie and both are in the set or both not
7697 * in the set, it doesn't matter which we take first.) */
7698 if (array_a[i_a] < array_b[i_b]
7699 || (array_a[i_a] == array_b[i_b]
7700 && ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
7702 cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
7706 cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
7707 cp = array_b[i_b++];
7710 /* Here, have chosen which of the two inputs to look at. Only output
7711 * if the running count changes to/from 0, which marks the
7712 * beginning/end of a range in that's in the set */
7715 array_u[i_u++] = cp;
7722 array_u[i_u++] = cp;
7727 /* Here, we are finished going through at least one of the lists, which
7728 * means there is something remaining in at most one. We check if the list
7729 * that hasn't been exhausted is positioned such that we are in the middle
7730 * of a range in its set or not. (i_a and i_b point to the element beyond
7731 * the one we care about.) If in the set, we decrement 'count'; if 0, there
7732 * is potentially more to output.
7733 * There are four cases:
7734 * 1) Both weren't in their sets, count is 0, and remains 0. What's left
7735 * in the union is entirely from the non-exhausted set.
7736 * 2) Both were in their sets, count is 2. Nothing further should
7737 * be output, as everything that remains will be in the exhausted
7738 * list's set, hence in the union; decrementing to 1 but not 0 insures
7740 * 3) the exhausted was in its set, non-exhausted isn't, count is 1.
7741 * Nothing further should be output because the union includes
7742 * everything from the exhausted set. Not decrementing ensures that.
7743 * 4) the exhausted wasn't in its set, non-exhausted is, count is 1;
7744 * decrementing to 0 insures that we look at the remainder of the
7745 * non-exhausted set */
7746 if ((i_a != len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
7747 || (i_b != len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
7752 /* The final length is what we've output so far, plus what else is about to
7753 * be output. (If 'count' is non-zero, then the input list we exhausted
7754 * has everything remaining up to the machine's limit in its set, and hence
7755 * in the union, so there will be no further output. */
7758 /* At most one of the subexpressions will be non-zero */
7759 len_u += (len_a - i_a) + (len_b - i_b);
7762 /* Set result to final length, which can change the pointer to array_u, so
7764 if (len_u != _invlist_len(u)) {
7765 invlist_set_len(u, len_u, *get_invlist_offset_addr(u));
7767 array_u = invlist_array(u);
7770 /* When 'count' is 0, the list that was exhausted (if one was shorter than
7771 * the other) ended with everything above it not in its set. That means
7772 * that the remaining part of the union is precisely the same as the
7773 * non-exhausted list, so can just copy it unchanged. (If both list were
7774 * exhausted at the same time, then the operations below will be both 0.)
7777 IV copy_count; /* At most one will have a non-zero copy count */
7778 if ((copy_count = len_a - i_a) > 0) {
7779 Copy(array_a + i_a, array_u + i_u, copy_count, UV);
7781 else if ((copy_count = len_b - i_b) > 0) {
7782 Copy(array_b + i_b, array_u + i_u, copy_count, UV);
7786 /* We may be removing a reference to one of the inputs */
7787 if (a == *output || b == *output) {
7788 assert(! invlist_is_iterating(*output));
7789 SvREFCNT_dec_NN(*output);
7797 Perl__invlist_intersection_maybe_complement_2nd(pTHX_ SV* const a, SV* const b, const bool complement_b, SV** i)
7799 /* Take the intersection of two inversion lists and point <i> to it. *i
7800 * SHOULD BE DEFINED upon input, and if it points to one of the two lists,
7801 * the reference count to that list will be decremented.
7802 * If <complement_b> is TRUE, the result will be the intersection of <a>
7803 * and the complement (or inversion) of <b> instead of <b> directly.
7805 * The basis for this comes from "Unicode Demystified" Chapter 13 by
7806 * Richard Gillam, published by Addison-Wesley, and explained at some
7807 * length there. The preface says to incorporate its examples into your
7808 * code at your own risk. In fact, it had bugs
7810 * The algorithm is like a merge sort, and is essentially the same as the
7814 const UV* array_a; /* a's array */
7816 UV len_a; /* length of a's array */
7819 SV* r; /* the resulting intersection */
7823 UV i_a = 0; /* current index into a's array */
7827 /* running count, as explained in the algorithm source book; items are
7828 * stopped accumulating and are output when the count changes to/from 2.
7829 * The count is incremented when we start a range that's in the set, and
7830 * decremented when we start a range that's not in the set. So its range
7831 * is 0 to 2. Only when the count is 2 is something in the intersection.
7835 PERL_ARGS_ASSERT__INVLIST_INTERSECTION_MAYBE_COMPLEMENT_2ND;
7838 /* Special case if either one is empty */
7839 len_a = (a == NULL) ? 0 : _invlist_len(a);
7840 if ((len_a == 0) || ((len_b = _invlist_len(b)) == 0)) {
7842 if (len_a != 0 && complement_b) {
7844 /* Here, 'a' is not empty, therefore from the above 'if', 'b' must
7845 * be empty. Here, also we are using 'b's complement, which hence
7846 * must be every possible code point. Thus the intersection is
7849 *i = invlist_clone(a);
7855 /* else *i is already 'a' */
7859 /* Here, 'a' or 'b' is empty and not using the complement of 'b'. The
7860 * intersection must be empty */
7867 *i = _new_invlist(0);
7871 /* Here both lists exist and are non-empty */
7872 array_a = invlist_array(a);
7873 array_b = invlist_array(b);
7875 /* If are to take the intersection of 'a' with the complement of b, set it
7876 * up so are looking at b's complement. */
7879 /* To complement, we invert: if the first element is 0, remove it. To
7880 * do this, we just pretend the array starts one later */
7881 if (array_b[0] == 0) {
7887 /* But if the first element is not zero, we pretend the list starts
7888 * at the 0 that is always stored immediately before the array. */
7894 /* Size the intersection for the worst case: that the intersection ends up
7895 * fragmenting everything to be completely disjoint */
7896 r= _new_invlist(len_a + len_b);
7898 /* Will contain U+0000 iff both components do */
7899 array_r = _invlist_array_init(r, len_a > 0 && array_a[0] == 0
7900 && len_b > 0 && array_b[0] == 0);
7902 /* Go through each list item by item, stopping when exhausted one of
7904 while (i_a < len_a && i_b < len_b) {
7905 UV cp; /* The element to potentially add to the intersection's
7907 bool cp_in_set; /* Is it in the input list's set or not */
7909 /* We need to take one or the other of the two inputs for the
7910 * intersection. Since we are merging two sorted lists, we take the
7911 * smaller of the next items. In case of a tie, we take the one that
7912 * is not in its set first (a difference from the union algorithm). If
7913 * we took one in the set first, it would increment the count, possibly
7914 * to 2 which would cause it to be output as starting a range in the
7915 * intersection, and the next time through we would take that same
7916 * number, and output it again as ending the set. By doing it the
7917 * opposite of this, there is no possibility that the count will be
7918 * momentarily incremented to 2. (In a tie and both are in the set or
7919 * both not in the set, it doesn't matter which we take first.) */
7920 if (array_a[i_a] < array_b[i_b]
7921 || (array_a[i_a] == array_b[i_b]
7922 && ! ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
7924 cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
7928 cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
7932 /* Here, have chosen which of the two inputs to look at. Only output
7933 * if the running count changes to/from 2, which marks the
7934 * beginning/end of a range that's in the intersection */
7938 array_r[i_r++] = cp;
7943 array_r[i_r++] = cp;
7949 /* Here, we are finished going through at least one of the lists, which
7950 * means there is something remaining in at most one. We check if the list
7951 * that has been exhausted is positioned such that we are in the middle
7952 * of a range in its set or not. (i_a and i_b point to elements 1 beyond
7953 * the ones we care about.) There are four cases:
7954 * 1) Both weren't in their sets, count is 0, and remains 0. There's
7955 * nothing left in the intersection.
7956 * 2) Both were in their sets, count is 2 and perhaps is incremented to
7957 * above 2. What should be output is exactly that which is in the
7958 * non-exhausted set, as everything it has is also in the intersection
7959 * set, and everything it doesn't have can't be in the intersection
7960 * 3) The exhausted was in its set, non-exhausted isn't, count is 1, and
7961 * gets incremented to 2. Like the previous case, the intersection is
7962 * everything that remains in the non-exhausted set.
7963 * 4) the exhausted wasn't in its set, non-exhausted is, count is 1, and
7964 * remains 1. And the intersection has nothing more. */
7965 if ((i_a == len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
7966 || (i_b == len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
7971 /* The final length is what we've output so far plus what else is in the
7972 * intersection. At most one of the subexpressions below will be non-zero */
7975 len_r += (len_a - i_a) + (len_b - i_b);
7978 /* Set result to final length, which can change the pointer to array_r, so
7980 if (len_r != _invlist_len(r)) {
7981 invlist_set_len(r, len_r, *get_invlist_offset_addr(r));
7983 array_r = invlist_array(r);
7986 /* Finish outputting any remaining */
7987 if (count >= 2) { /* At most one will have a non-zero copy count */
7989 if ((copy_count = len_a - i_a) > 0) {
7990 Copy(array_a + i_a, array_r + i_r, copy_count, UV);
7992 else if ((copy_count = len_b - i_b) > 0) {
7993 Copy(array_b + i_b, array_r + i_r, copy_count, UV);
7997 /* We may be removing a reference to one of the inputs */
7998 if (a == *i || b == *i) {
7999 assert(! invlist_is_iterating(*i));
8000 SvREFCNT_dec_NN(*i);
8008 Perl__add_range_to_invlist(pTHX_ SV* invlist, const UV start, const UV end)
8010 /* Add the range from 'start' to 'end' inclusive to the inversion list's
8011 * set. A pointer to the inversion list is returned. This may actually be
8012 * a new list, in which case the passed in one has been destroyed. The
8013 * passed in inversion list can be NULL, in which case a new one is created
8014 * with just the one range in it */
8019 if (invlist == NULL) {
8020 invlist = _new_invlist(2);
8024 len = _invlist_len(invlist);
8027 /* If comes after the final entry actually in the list, can just append it
8030 || (! ELEMENT_RANGE_MATCHES_INVLIST(len - 1)
8031 && start >= invlist_array(invlist)[len - 1]))
8033 _append_range_to_invlist(invlist, start, end);
8037 /* Here, can't just append things, create and return a new inversion list
8038 * which is the union of this range and the existing inversion list */
8039 range_invlist = _new_invlist(2);
8040 _append_range_to_invlist(range_invlist, start, end);
8042 _invlist_union(invlist, range_invlist, &invlist);
8044 /* The temporary can be freed */
8045 SvREFCNT_dec_NN(range_invlist);
8052 PERL_STATIC_INLINE SV*
8053 S_add_cp_to_invlist(pTHX_ SV* invlist, const UV cp) {
8054 return _add_range_to_invlist(invlist, cp, cp);
8057 #ifndef PERL_IN_XSUB_RE
8059 Perl__invlist_invert(pTHX_ SV* const invlist)
8061 /* Complement the input inversion list. This adds a 0 if the list didn't
8062 * have a zero; removes it otherwise. As described above, the data
8063 * structure is set up so that this is very efficient */
8065 PERL_ARGS_ASSERT__INVLIST_INVERT;
8067 assert(! invlist_is_iterating(invlist));
8069 /* The inverse of matching nothing is matching everything */
8070 if (_invlist_len(invlist) == 0) {
8071 _append_range_to_invlist(invlist, 0, UV_MAX);
8075 *get_invlist_offset_addr(invlist) = ! *get_invlist_offset_addr(invlist);
8079 Perl__invlist_invert_prop(pTHX_ SV* const invlist)
8081 /* Complement the input inversion list (which must be a Unicode property,
8082 * all of which don't match above the Unicode maximum code point.) And
8083 * Perl has chosen to not have the inversion match above that either. This
8084 * adds a 0x110000 if the list didn't end with it, and removes it if it did
8090 PERL_ARGS_ASSERT__INVLIST_INVERT_PROP;
8092 _invlist_invert(invlist);
8094 len = _invlist_len(invlist);
8096 if (len != 0) { /* If empty do nothing */
8097 array = invlist_array(invlist);
8098 if (array[len - 1] != PERL_UNICODE_MAX + 1) {
8099 /* Add 0x110000. First, grow if necessary */
8101 if (invlist_max(invlist) < len) {
8102 invlist_extend(invlist, len);
8103 array = invlist_array(invlist);
8105 invlist_set_len(invlist, len, *get_invlist_offset_addr(invlist));
8106 array[len - 1] = PERL_UNICODE_MAX + 1;
8108 else { /* Remove the 0x110000 */
8109 invlist_set_len(invlist, len - 1, *get_invlist_offset_addr(invlist));
8117 PERL_STATIC_INLINE SV*
8118 S_invlist_clone(pTHX_ SV* const invlist)
8121 /* Return a new inversion list that is a copy of the input one, which is
8124 /* Need to allocate extra space to accommodate Perl's addition of a
8125 * trailing NUL to SvPV's, since it thinks they are always strings */
8126 SV* new_invlist = _new_invlist(_invlist_len(invlist) + 1);
8127 STRLEN physical_length = SvCUR(invlist);
8128 bool offset = *(get_invlist_offset_addr(invlist));
8130 PERL_ARGS_ASSERT_INVLIST_CLONE;
8132 *(get_invlist_offset_addr(new_invlist)) = offset;
8133 invlist_set_len(new_invlist, _invlist_len(invlist), offset);
8134 Copy(SvPVX(invlist), SvPVX(new_invlist), physical_length, char);
8139 PERL_STATIC_INLINE STRLEN*
8140 S_get_invlist_iter_addr(pTHX_ SV* invlist)
8142 /* Return the address of the UV that contains the current iteration
8145 PERL_ARGS_ASSERT_GET_INVLIST_ITER_ADDR;
8147 assert(SvTYPE(invlist) == SVt_INVLIST);
8149 return &(((XINVLIST*) SvANY(invlist))->iterator);
8152 PERL_STATIC_INLINE void
8153 S_invlist_iterinit(pTHX_ SV* invlist) /* Initialize iterator for invlist */
8155 PERL_ARGS_ASSERT_INVLIST_ITERINIT;
8157 *get_invlist_iter_addr(invlist) = 0;
8160 PERL_STATIC_INLINE void
8161 S_invlist_iterfinish(pTHX_ SV* invlist)
8163 /* Terminate iterator for invlist. This is to catch development errors.
8164 * Any iteration that is interrupted before completed should call this
8165 * function. Functions that add code points anywhere else but to the end
8166 * of an inversion list assert that they are not in the middle of an
8167 * iteration. If they were, the addition would make the iteration
8168 * problematical: if the iteration hadn't reached the place where things
8169 * were being added, it would be ok */
8171 PERL_ARGS_ASSERT_INVLIST_ITERFINISH;
8173 *get_invlist_iter_addr(invlist) = (STRLEN) UV_MAX;
8177 S_invlist_iternext(pTHX_ SV* invlist, UV* start, UV* end)
8179 /* An C<invlist_iterinit> call on <invlist> must be used to set this up.
8180 * This call sets in <*start> and <*end>, the next range in <invlist>.
8181 * Returns <TRUE> if successful and the next call will return the next
8182 * range; <FALSE> if was already at the end of the list. If the latter,
8183 * <*start> and <*end> are unchanged, and the next call to this function
8184 * will start over at the beginning of the list */
8186 STRLEN* pos = get_invlist_iter_addr(invlist);
8187 UV len = _invlist_len(invlist);
8190 PERL_ARGS_ASSERT_INVLIST_ITERNEXT;
8193 *pos = (STRLEN) UV_MAX; /* Force iterinit() to be required next time */
8197 array = invlist_array(invlist);
8199 *start = array[(*pos)++];
8205 *end = array[(*pos)++] - 1;
8211 PERL_STATIC_INLINE bool
8212 S_invlist_is_iterating(pTHX_ SV* const invlist)
8214 PERL_ARGS_ASSERT_INVLIST_IS_ITERATING;
8216 return *(get_invlist_iter_addr(invlist)) < (STRLEN) UV_MAX;
8219 PERL_STATIC_INLINE UV
8220 S_invlist_highest(pTHX_ SV* const invlist)
8222 /* Returns the highest code point that matches an inversion list. This API
8223 * has an ambiguity, as it returns 0 under either the highest is actually
8224 * 0, or if the list is empty. If this distinction matters to you, check
8225 * for emptiness before calling this function */
8227 UV len = _invlist_len(invlist);
8230 PERL_ARGS_ASSERT_INVLIST_HIGHEST;
8236 array = invlist_array(invlist);
8238 /* The last element in the array in the inversion list always starts a
8239 * range that goes to infinity. That range may be for code points that are
8240 * matched in the inversion list, or it may be for ones that aren't
8241 * matched. In the latter case, the highest code point in the set is one
8242 * less than the beginning of this range; otherwise it is the final element
8243 * of this range: infinity */
8244 return (ELEMENT_RANGE_MATCHES_INVLIST(len - 1))
8246 : array[len - 1] - 1;
8249 #ifndef PERL_IN_XSUB_RE
8251 Perl__invlist_contents(pTHX_ SV* const invlist)
8253 /* Get the contents of an inversion list into a string SV so that they can
8254 * be printed out. It uses the format traditionally done for debug tracing
8258 SV* output = newSVpvs("\n");
8260 PERL_ARGS_ASSERT__INVLIST_CONTENTS;
8262 assert(! invlist_is_iterating(invlist));
8264 invlist_iterinit(invlist);
8265 while (invlist_iternext(invlist, &start, &end)) {
8266 if (end == UV_MAX) {
8267 Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\tINFINITY\n", start);
8269 else if (end != start) {
8270 Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\t%04"UVXf"\n",
8274 Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\n", start);
8282 #ifdef PERL_ARGS_ASSERT__INVLIST_DUMP
8284 Perl__invlist_dump(pTHX_ SV* const invlist, const char * const header)
8286 /* Dumps out the ranges in an inversion list. The string 'header'
8287 * if present is output on a line before the first range */
8291 PERL_ARGS_ASSERT__INVLIST_DUMP;
8293 if (header && strlen(header)) {
8294 PerlIO_printf(Perl_debug_log, "%s\n", header);
8296 if (invlist_is_iterating(invlist)) {
8297 PerlIO_printf(Perl_debug_log, "Can't dump because is in middle of iterating\n");
8301 invlist_iterinit(invlist);
8302 while (invlist_iternext(invlist, &start, &end)) {
8303 if (end == UV_MAX) {
8304 PerlIO_printf(Perl_debug_log, "0x%04"UVXf" .. INFINITY\n", start);
8306 else if (end != start) {
8307 PerlIO_printf(Perl_debug_log, "0x%04"UVXf" .. 0x%04"UVXf"\n",
8311 PerlIO_printf(Perl_debug_log, "0x%04"UVXf"\n", start);
8319 S__invlistEQ(pTHX_ SV* const a, SV* const b, const bool complement_b)
8321 /* Return a boolean as to if the two passed in inversion lists are
8322 * identical. The final argument, if TRUE, says to take the complement of
8323 * the second inversion list before doing the comparison */
8325 const UV* array_a = invlist_array(a);
8326 const UV* array_b = invlist_array(b);
8327 UV len_a = _invlist_len(a);
8328 UV len_b = _invlist_len(b);
8330 UV i = 0; /* current index into the arrays */
8331 bool retval = TRUE; /* Assume are identical until proven otherwise */
8333 PERL_ARGS_ASSERT__INVLISTEQ;
8335 /* If are to compare 'a' with the complement of b, set it
8336 * up so are looking at b's complement. */
8339 /* The complement of nothing is everything, so <a> would have to have
8340 * just one element, starting at zero (ending at infinity) */
8342 return (len_a == 1 && array_a[0] == 0);
8344 else if (array_b[0] == 0) {
8346 /* Otherwise, to complement, we invert. Here, the first element is
8347 * 0, just remove it. To do this, we just pretend the array starts
8355 /* But if the first element is not zero, we pretend the list starts
8356 * at the 0 that is always stored immediately before the array. */
8362 /* Make sure that the lengths are the same, as well as the final element
8363 * before looping through the remainder. (Thus we test the length, final,
8364 * and first elements right off the bat) */
8365 if (len_a != len_b || array_a[len_a-1] != array_b[len_a-1]) {
8368 else for (i = 0; i < len_a - 1; i++) {
8369 if (array_a[i] != array_b[i]) {
8379 #undef HEADER_LENGTH
8380 #undef TO_INTERNAL_SIZE
8381 #undef FROM_INTERNAL_SIZE
8382 #undef INVLIST_VERSION_ID
8384 /* End of inversion list object */
8387 S_parse_lparen_question_flags(pTHX_ struct RExC_state_t *pRExC_state)
8389 /* This parses the flags that are in either the '(?foo)' or '(?foo:bar)'
8390 * constructs, and updates RExC_flags with them. On input, RExC_parse
8391 * should point to the first flag; it is updated on output to point to the
8392 * final ')' or ':'. There needs to be at least one flag, or this will
8395 /* for (?g), (?gc), and (?o) warnings; warning
8396 about (?c) will warn about (?g) -- japhy */
8398 #define WASTED_O 0x01
8399 #define WASTED_G 0x02
8400 #define WASTED_C 0x04
8401 #define WASTED_GC (WASTED_G|WASTED_C)
8402 I32 wastedflags = 0x00;
8403 U32 posflags = 0, negflags = 0;
8404 U32 *flagsp = &posflags;
8405 char has_charset_modifier = '\0';
8407 bool has_use_defaults = FALSE;
8408 const char* const seqstart = RExC_parse - 1; /* Point to the '?' */
8410 PERL_ARGS_ASSERT_PARSE_LPAREN_QUESTION_FLAGS;
8412 /* '^' as an initial flag sets certain defaults */
8413 if (UCHARAT(RExC_parse) == '^') {
8415 has_use_defaults = TRUE;
8416 STD_PMMOD_FLAGS_CLEAR(&RExC_flags);
8417 set_regex_charset(&RExC_flags, (RExC_utf8 || RExC_uni_semantics)
8418 ? REGEX_UNICODE_CHARSET
8419 : REGEX_DEPENDS_CHARSET);
8422 cs = get_regex_charset(RExC_flags);
8423 if (cs == REGEX_DEPENDS_CHARSET
8424 && (RExC_utf8 || RExC_uni_semantics))
8426 cs = REGEX_UNICODE_CHARSET;
8429 while (*RExC_parse) {
8430 /* && strchr("iogcmsx", *RExC_parse) */
8431 /* (?g), (?gc) and (?o) are useless here
8432 and must be globally applied -- japhy */
8433 switch (*RExC_parse) {
8435 /* Code for the imsx flags */
8436 CASE_STD_PMMOD_FLAGS_PARSE_SET(flagsp);
8438 case LOCALE_PAT_MOD:
8439 if (has_charset_modifier) {
8440 goto excess_modifier;
8442 else if (flagsp == &negflags) {
8445 cs = REGEX_LOCALE_CHARSET;
8446 has_charset_modifier = LOCALE_PAT_MOD;
8447 RExC_contains_locale = 1;
8449 case UNICODE_PAT_MOD:
8450 if (has_charset_modifier) {
8451 goto excess_modifier;
8453 else if (flagsp == &negflags) {
8456 cs = REGEX_UNICODE_CHARSET;
8457 has_charset_modifier = UNICODE_PAT_MOD;
8459 case ASCII_RESTRICT_PAT_MOD:
8460 if (flagsp == &negflags) {
8463 if (has_charset_modifier) {
8464 if (cs != REGEX_ASCII_RESTRICTED_CHARSET) {
8465 goto excess_modifier;
8467 /* Doubled modifier implies more restricted */
8468 cs = REGEX_ASCII_MORE_RESTRICTED_CHARSET;
8471 cs = REGEX_ASCII_RESTRICTED_CHARSET;
8473 has_charset_modifier = ASCII_RESTRICT_PAT_MOD;
8475 case DEPENDS_PAT_MOD:
8476 if (has_use_defaults) {
8477 goto fail_modifiers;
8479 else if (flagsp == &negflags) {
8482 else if (has_charset_modifier) {
8483 goto excess_modifier;
8486 /* The dual charset means unicode semantics if the
8487 * pattern (or target, not known until runtime) are
8488 * utf8, or something in the pattern indicates unicode
8490 cs = (RExC_utf8 || RExC_uni_semantics)
8491 ? REGEX_UNICODE_CHARSET
8492 : REGEX_DEPENDS_CHARSET;
8493 has_charset_modifier = DEPENDS_PAT_MOD;
8497 if (has_charset_modifier == ASCII_RESTRICT_PAT_MOD) {
8498 vFAIL2("Regexp modifier \"%c\" may appear a maximum of twice", ASCII_RESTRICT_PAT_MOD);
8500 else if (has_charset_modifier == *(RExC_parse - 1)) {
8501 vFAIL2("Regexp modifier \"%c\" may not appear twice", *(RExC_parse - 1));
8504 vFAIL3("Regexp modifiers \"%c\" and \"%c\" are mutually exclusive", has_charset_modifier, *(RExC_parse - 1));
8509 vFAIL2("Regexp modifier \"%c\" may not appear after the \"-\"", *(RExC_parse - 1));
8511 case ONCE_PAT_MOD: /* 'o' */
8512 case GLOBAL_PAT_MOD: /* 'g' */
8513 if (SIZE_ONLY && ckWARN(WARN_REGEXP)) {
8514 const I32 wflagbit = *RExC_parse == 'o' ? WASTED_O : WASTED_G;
8515 if (! (wastedflags & wflagbit) ) {
8516 wastedflags |= wflagbit;
8517 /* diag_listed_as: Useless (?-%s) - don't use /%s modifier in regex; marked by <-- HERE in m/%s/ */
8520 "Useless (%s%c) - %suse /%c modifier",
8521 flagsp == &negflags ? "?-" : "?",
8523 flagsp == &negflags ? "don't " : "",
8530 case CONTINUE_PAT_MOD: /* 'c' */
8531 if (SIZE_ONLY && ckWARN(WARN_REGEXP)) {
8532 if (! (wastedflags & WASTED_C) ) {
8533 wastedflags |= WASTED_GC;
8534 /* diag_listed_as: Useless (?-%s) - don't use /%s modifier in regex; marked by <-- HERE in m/%s/ */
8537 "Useless (%sc) - %suse /gc modifier",
8538 flagsp == &negflags ? "?-" : "?",
8539 flagsp == &negflags ? "don't " : ""
8544 case KEEPCOPY_PAT_MOD: /* 'p' */
8545 if (flagsp == &negflags) {
8547 ckWARNreg(RExC_parse + 1,"Useless use of (?-p)");
8549 *flagsp |= RXf_PMf_KEEPCOPY;
8553 /* A flag is a default iff it is following a minus, so
8554 * if there is a minus, it means will be trying to
8555 * re-specify a default which is an error */
8556 if (has_use_defaults || flagsp == &negflags) {
8557 goto fail_modifiers;
8560 wastedflags = 0; /* reset so (?g-c) warns twice */
8564 RExC_flags |= posflags;
8565 RExC_flags &= ~negflags;
8566 set_regex_charset(&RExC_flags, cs);
8572 vFAIL3("Sequence (%.*s...) not recognized",
8573 RExC_parse-seqstart, seqstart);
8582 - reg - regular expression, i.e. main body or parenthesized thing
8584 * Caller must absorb opening parenthesis.
8586 * Combining parenthesis handling with the base level of regular expression
8587 * is a trifle forced, but the need to tie the tails of the branches to what
8588 * follows makes it hard to avoid.
8590 #define REGTAIL(x,y,z) regtail((x),(y),(z),depth+1)
8592 #define REGTAIL_STUDY(x,y,z) regtail_study((x),(y),(z),depth+1)
8594 #define REGTAIL_STUDY(x,y,z) regtail((x),(y),(z),depth+1)
8597 /* Returns NULL, setting *flagp to TRYAGAIN at the end of (?) that only sets
8598 flags. Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan
8599 needs to be restarted.
8600 Otherwise would only return NULL if regbranch() returns NULL, which
8603 S_reg(pTHX_ RExC_state_t *pRExC_state, I32 paren, I32 *flagp,U32 depth)
8604 /* paren: Parenthesized? 0=top; 1,2=inside '(': changed to letter.
8605 * 2 is like 1, but indicates that nextchar() has been called to advance
8606 * RExC_parse beyond the '('. Things like '(?' are indivisible tokens, and
8607 * this flag alerts us to the need to check for that */
8610 regnode *ret; /* Will be the head of the group. */
8613 regnode *ender = NULL;
8616 U32 oregflags = RExC_flags;
8617 bool have_branch = 0;
8619 I32 freeze_paren = 0;
8620 I32 after_freeze = 0;
8622 char * parse_start = RExC_parse; /* MJD */
8623 char * const oregcomp_parse = RExC_parse;
8625 GET_RE_DEBUG_FLAGS_DECL;
8627 PERL_ARGS_ASSERT_REG;
8628 DEBUG_PARSE("reg ");
8630 *flagp = 0; /* Tentatively. */
8633 /* Make an OPEN node, if parenthesized. */
8636 /* Under /x, space and comments can be gobbled up between the '(' and
8637 * here (if paren ==2). The forms '(*VERB' and '(?...' disallow such
8638 * intervening space, as the sequence is a token, and a token should be
8640 bool has_intervening_patws = paren == 2 && *(RExC_parse - 1) != '(';
8642 if ( *RExC_parse == '*') { /* (*VERB:ARG) */
8643 char *start_verb = RExC_parse;
8644 STRLEN verb_len = 0;
8645 char *start_arg = NULL;
8646 unsigned char op = 0;
8648 int internal_argval = 0; /* internal_argval is only useful if !argok */
8650 if (has_intervening_patws && SIZE_ONLY) {
8651 ckWARNregdep(RExC_parse + 1, "In '(*VERB...)', splitting the initial '(*' is deprecated");
8653 while ( *RExC_parse && *RExC_parse != ')' ) {
8654 if ( *RExC_parse == ':' ) {
8655 start_arg = RExC_parse + 1;
8661 verb_len = RExC_parse - start_verb;
8664 while ( *RExC_parse && *RExC_parse != ')' )
8666 if ( *RExC_parse != ')' )
8667 vFAIL("Unterminated verb pattern argument");
8668 if ( RExC_parse == start_arg )
8671 if ( *RExC_parse != ')' )
8672 vFAIL("Unterminated verb pattern");
8675 switch ( *start_verb ) {
8676 case 'A': /* (*ACCEPT) */
8677 if ( memEQs(start_verb,verb_len,"ACCEPT") ) {
8679 internal_argval = RExC_nestroot;
8682 case 'C': /* (*COMMIT) */
8683 if ( memEQs(start_verb,verb_len,"COMMIT") )
8686 case 'F': /* (*FAIL) */
8687 if ( verb_len==1 || memEQs(start_verb,verb_len,"FAIL") ) {
8692 case ':': /* (*:NAME) */
8693 case 'M': /* (*MARK:NAME) */
8694 if ( verb_len==0 || memEQs(start_verb,verb_len,"MARK") ) {
8699 case 'P': /* (*PRUNE) */
8700 if ( memEQs(start_verb,verb_len,"PRUNE") )
8703 case 'S': /* (*SKIP) */
8704 if ( memEQs(start_verb,verb_len,"SKIP") )
8707 case 'T': /* (*THEN) */
8708 /* [19:06] <TimToady> :: is then */
8709 if ( memEQs(start_verb,verb_len,"THEN") ) {
8711 RExC_seen |= REG_SEEN_CUTGROUP;
8717 vFAIL3("Unknown verb pattern '%.*s'",
8718 verb_len, start_verb);
8721 if ( start_arg && internal_argval ) {
8722 vFAIL3("Verb pattern '%.*s' may not have an argument",
8723 verb_len, start_verb);
8724 } else if ( argok < 0 && !start_arg ) {
8725 vFAIL3("Verb pattern '%.*s' has a mandatory argument",
8726 verb_len, start_verb);
8728 ret = reganode(pRExC_state, op, internal_argval);
8729 if ( ! internal_argval && ! SIZE_ONLY ) {
8731 SV *sv = newSVpvn( start_arg, RExC_parse - start_arg);
8732 ARG(ret) = add_data( pRExC_state, 1, "S" );
8733 RExC_rxi->data->data[ARG(ret)]=(void*)sv;
8740 if (!internal_argval)
8741 RExC_seen |= REG_SEEN_VERBARG;
8742 } else if ( start_arg ) {
8743 vFAIL3("Verb pattern '%.*s' may not have an argument",
8744 verb_len, start_verb);
8746 ret = reg_node(pRExC_state, op);
8748 nextchar(pRExC_state);
8751 else if (*RExC_parse == '?') { /* (?...) */
8752 bool is_logical = 0;
8753 const char * const seqstart = RExC_parse;
8754 if (has_intervening_patws && SIZE_ONLY) {
8755 ckWARNregdep(RExC_parse + 1, "In '(?...)', splitting the initial '(?' is deprecated");
8759 paren = *RExC_parse++;
8760 ret = NULL; /* For look-ahead/behind. */
8763 case 'P': /* (?P...) variants for those used to PCRE/Python */
8764 paren = *RExC_parse++;
8765 if ( paren == '<') /* (?P<...>) named capture */
8767 else if (paren == '>') { /* (?P>name) named recursion */
8768 goto named_recursion;
8770 else if (paren == '=') { /* (?P=...) named backref */
8771 /* this pretty much dupes the code for \k<NAME> in regatom(), if
8772 you change this make sure you change that */
8773 char* name_start = RExC_parse;
8775 SV *sv_dat = reg_scan_name(pRExC_state,
8776 SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
8777 if (RExC_parse == name_start || *RExC_parse != ')')
8778 vFAIL2("Sequence %.3s... not terminated",parse_start);
8781 num = add_data( pRExC_state, 1, "S" );
8782 RExC_rxi->data->data[num]=(void*)sv_dat;
8783 SvREFCNT_inc_simple_void(sv_dat);
8786 ret = reganode(pRExC_state,
8789 : (ASCII_FOLD_RESTRICTED)
8791 : (AT_LEAST_UNI_SEMANTICS)
8799 Set_Node_Offset(ret, parse_start+1);
8800 Set_Node_Cur_Length(ret, parse_start);
8802 nextchar(pRExC_state);
8806 vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
8808 case '<': /* (?<...) */
8809 if (*RExC_parse == '!')
8811 else if (*RExC_parse != '=')
8817 case '\'': /* (?'...') */
8818 name_start= RExC_parse;
8819 svname = reg_scan_name(pRExC_state,
8820 SIZE_ONLY ? /* reverse test from the others */
8821 REG_RSN_RETURN_NAME :
8822 REG_RSN_RETURN_NULL);
8823 if (RExC_parse == name_start) {
8825 vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
8828 if (*RExC_parse != paren)
8829 vFAIL2("Sequence (?%c... not terminated",
8830 paren=='>' ? '<' : paren);
8834 if (!svname) /* shouldn't happen */
8836 "panic: reg_scan_name returned NULL");
8837 if (!RExC_paren_names) {
8838 RExC_paren_names= newHV();
8839 sv_2mortal(MUTABLE_SV(RExC_paren_names));
8841 RExC_paren_name_list= newAV();
8842 sv_2mortal(MUTABLE_SV(RExC_paren_name_list));
8845 he_str = hv_fetch_ent( RExC_paren_names, svname, 1, 0 );
8847 sv_dat = HeVAL(he_str);
8849 /* croak baby croak */
8851 "panic: paren_name hash element allocation failed");
8852 } else if ( SvPOK(sv_dat) ) {
8853 /* (?|...) can mean we have dupes so scan to check
8854 its already been stored. Maybe a flag indicating
8855 we are inside such a construct would be useful,
8856 but the arrays are likely to be quite small, so
8857 for now we punt -- dmq */
8858 IV count = SvIV(sv_dat);
8859 I32 *pv = (I32*)SvPVX(sv_dat);
8861 for ( i = 0 ; i < count ; i++ ) {
8862 if ( pv[i] == RExC_npar ) {
8868 pv = (I32*)SvGROW(sv_dat, SvCUR(sv_dat) + sizeof(I32)+1);
8869 SvCUR_set(sv_dat, SvCUR(sv_dat) + sizeof(I32));
8870 pv[count] = RExC_npar;
8871 SvIV_set(sv_dat, SvIVX(sv_dat) + 1);
8874 (void)SvUPGRADE(sv_dat,SVt_PVNV);
8875 sv_setpvn(sv_dat, (char *)&(RExC_npar), sizeof(I32));
8877 SvIV_set(sv_dat, 1);
8880 /* Yes this does cause a memory leak in debugging Perls */
8881 if (!av_store(RExC_paren_name_list, RExC_npar, SvREFCNT_inc(svname)))
8882 SvREFCNT_dec_NN(svname);
8885 /*sv_dump(sv_dat);*/
8887 nextchar(pRExC_state);
8889 goto capturing_parens;
8891 RExC_seen |= REG_SEEN_LOOKBEHIND;
8892 RExC_in_lookbehind++;
8894 case '=': /* (?=...) */
8895 RExC_seen_zerolen++;
8897 case '!': /* (?!...) */
8898 RExC_seen_zerolen++;
8899 if (*RExC_parse == ')') {
8900 ret=reg_node(pRExC_state, OPFAIL);
8901 nextchar(pRExC_state);
8905 case '|': /* (?|...) */
8906 /* branch reset, behave like a (?:...) except that
8907 buffers in alternations share the same numbers */
8909 after_freeze = freeze_paren = RExC_npar;
8911 case ':': /* (?:...) */
8912 case '>': /* (?>...) */
8914 case '$': /* (?$...) */
8915 case '@': /* (?@...) */
8916 vFAIL2("Sequence (?%c...) not implemented", (int)paren);
8918 case '#': /* (?#...) */
8919 /* XXX As soon as we disallow separating the '?' and '*' (by
8920 * spaces or (?#...) comment), it is believed that this case
8921 * will be unreachable and can be removed. See
8923 while (*RExC_parse && *RExC_parse != ')')
8925 if (*RExC_parse != ')')
8926 FAIL("Sequence (?#... not terminated");
8927 nextchar(pRExC_state);
8930 case '0' : /* (?0) */
8931 case 'R' : /* (?R) */
8932 if (*RExC_parse != ')')
8933 FAIL("Sequence (?R) not terminated");
8934 ret = reg_node(pRExC_state, GOSTART);
8935 *flagp |= POSTPONED;
8936 nextchar(pRExC_state);
8939 { /* named and numeric backreferences */
8941 case '&': /* (?&NAME) */
8942 parse_start = RExC_parse - 1;
8945 SV *sv_dat = reg_scan_name(pRExC_state,
8946 SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
8947 num = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
8949 goto gen_recurse_regop;
8950 assert(0); /* NOT REACHED */
8952 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
8954 vFAIL("Illegal pattern");
8956 goto parse_recursion;
8958 case '-': /* (?-1) */
8959 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
8960 RExC_parse--; /* rewind to let it be handled later */
8964 case '1': case '2': case '3': case '4': /* (?1) */
8965 case '5': case '6': case '7': case '8': case '9':
8968 num = atoi(RExC_parse);
8969 parse_start = RExC_parse - 1; /* MJD */
8970 if (*RExC_parse == '-')
8972 while (isDIGIT(*RExC_parse))
8974 if (*RExC_parse!=')')
8975 vFAIL("Expecting close bracket");
8978 if ( paren == '-' ) {
8980 Diagram of capture buffer numbering.
8981 Top line is the normal capture buffer numbers
8982 Bottom line is the negative indexing as from
8986 /(a(x)y)(a(b(c(?-2)d)e)f)(g(h))/
8990 num = RExC_npar + num;
8993 vFAIL("Reference to nonexistent group");
8995 } else if ( paren == '+' ) {
8996 num = RExC_npar + num - 1;
8999 ret = reganode(pRExC_state, GOSUB, num);
9001 if (num > (I32)RExC_rx->nparens) {
9003 vFAIL("Reference to nonexistent group");
9005 ARG2L_SET( ret, RExC_recurse_count++);
9007 DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
9008 "Recurse #%"UVuf" to %"IVdf"\n", (UV)ARG(ret), (IV)ARG2L(ret)));
9012 RExC_seen |= REG_SEEN_RECURSE;
9013 Set_Node_Length(ret, 1 + regarglen[OP(ret)]); /* MJD */
9014 Set_Node_Offset(ret, parse_start); /* MJD */
9016 *flagp |= POSTPONED;
9017 nextchar(pRExC_state);
9019 } /* named and numeric backreferences */
9020 assert(0); /* NOT REACHED */
9022 case '?': /* (??...) */
9024 if (*RExC_parse != '{') {
9026 vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
9029 *flagp |= POSTPONED;
9030 paren = *RExC_parse++;
9032 case '{': /* (?{...}) */
9035 struct reg_code_block *cb;
9037 RExC_seen_zerolen++;
9039 if ( !pRExC_state->num_code_blocks
9040 || pRExC_state->code_index >= pRExC_state->num_code_blocks
9041 || pRExC_state->code_blocks[pRExC_state->code_index].start
9042 != (STRLEN)((RExC_parse -3 - (is_logical ? 1 : 0))
9045 if (RExC_pm_flags & PMf_USE_RE_EVAL)
9046 FAIL("panic: Sequence (?{...}): no code block found\n");
9047 FAIL("Eval-group not allowed at runtime, use re 'eval'");
9049 /* this is a pre-compiled code block (?{...}) */
9050 cb = &pRExC_state->code_blocks[pRExC_state->code_index];
9051 RExC_parse = RExC_start + cb->end;
9054 if (cb->src_regex) {
9055 n = add_data(pRExC_state, 2, "rl");
9056 RExC_rxi->data->data[n] =
9057 (void*)SvREFCNT_inc((SV*)cb->src_regex);
9058 RExC_rxi->data->data[n+1] = (void*)o;
9061 n = add_data(pRExC_state, 1,
9062 (RExC_pm_flags & PMf_HAS_CV) ? "L" : "l");
9063 RExC_rxi->data->data[n] = (void*)o;
9066 pRExC_state->code_index++;
9067 nextchar(pRExC_state);
9071 ret = reg_node(pRExC_state, LOGICAL);
9072 eval = reganode(pRExC_state, EVAL, n);
9075 /* for later propagation into (??{}) return value */
9076 eval->flags = (U8) (RExC_flags & RXf_PMf_COMPILETIME);
9078 REGTAIL(pRExC_state, ret, eval);
9079 /* deal with the length of this later - MJD */
9082 ret = reganode(pRExC_state, EVAL, n);
9083 Set_Node_Length(ret, RExC_parse - parse_start + 1);
9084 Set_Node_Offset(ret, parse_start);
9087 case '(': /* (?(?{...})...) and (?(?=...)...) */
9090 if (RExC_parse[0] == '?') { /* (?(?...)) */
9091 if (RExC_parse[1] == '=' || RExC_parse[1] == '!'
9092 || RExC_parse[1] == '<'
9093 || RExC_parse[1] == '{') { /* Lookahead or eval. */
9097 ret = reg_node(pRExC_state, LOGICAL);
9101 tail = reg(pRExC_state, 1, &flag, depth+1);
9102 if (flag & RESTART_UTF8) {
9103 *flagp = RESTART_UTF8;
9106 REGTAIL(pRExC_state, ret, tail);
9110 else if ( RExC_parse[0] == '<' /* (?(<NAME>)...) */
9111 || RExC_parse[0] == '\'' ) /* (?('NAME')...) */
9113 char ch = RExC_parse[0] == '<' ? '>' : '\'';
9114 char *name_start= RExC_parse++;
9116 SV *sv_dat=reg_scan_name(pRExC_state,
9117 SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
9118 if (RExC_parse == name_start || *RExC_parse != ch)
9119 vFAIL2("Sequence (?(%c... not terminated",
9120 (ch == '>' ? '<' : ch));
9123 num = add_data( pRExC_state, 1, "S" );
9124 RExC_rxi->data->data[num]=(void*)sv_dat;
9125 SvREFCNT_inc_simple_void(sv_dat);
9127 ret = reganode(pRExC_state,NGROUPP,num);
9128 goto insert_if_check_paren;
9130 else if (RExC_parse[0] == 'D' &&
9131 RExC_parse[1] == 'E' &&
9132 RExC_parse[2] == 'F' &&
9133 RExC_parse[3] == 'I' &&
9134 RExC_parse[4] == 'N' &&
9135 RExC_parse[5] == 'E')
9137 ret = reganode(pRExC_state,DEFINEP,0);
9140 goto insert_if_check_paren;
9142 else if (RExC_parse[0] == 'R') {
9145 if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
9146 parno = atoi(RExC_parse++);
9147 while (isDIGIT(*RExC_parse))
9149 } else if (RExC_parse[0] == '&') {
9152 sv_dat = reg_scan_name(pRExC_state,
9153 SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
9154 parno = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
9156 ret = reganode(pRExC_state,INSUBP,parno);
9157 goto insert_if_check_paren;
9159 else if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
9162 parno = atoi(RExC_parse++);
9164 while (isDIGIT(*RExC_parse))
9166 ret = reganode(pRExC_state, GROUPP, parno);
9168 insert_if_check_paren:
9169 if ((c = *nextchar(pRExC_state)) != ')')
9170 vFAIL("Switch condition not recognized");
9172 REGTAIL(pRExC_state, ret, reganode(pRExC_state, IFTHEN, 0));
9173 br = regbranch(pRExC_state, &flags, 1,depth+1);
9175 if (flags & RESTART_UTF8) {
9176 *flagp = RESTART_UTF8;
9179 FAIL2("panic: regbranch returned NULL, flags=%#"UVxf"",
9182 REGTAIL(pRExC_state, br, reganode(pRExC_state, LONGJMP, 0));
9183 c = *nextchar(pRExC_state);
9188 vFAIL("(?(DEFINE)....) does not allow branches");
9189 lastbr = reganode(pRExC_state, IFTHEN, 0); /* Fake one for optimizer. */
9190 if (!regbranch(pRExC_state, &flags, 1,depth+1)) {
9191 if (flags & RESTART_UTF8) {
9192 *flagp = RESTART_UTF8;
9195 FAIL2("panic: regbranch returned NULL, flags=%#"UVxf"",
9198 REGTAIL(pRExC_state, ret, lastbr);
9201 c = *nextchar(pRExC_state);
9206 vFAIL("Switch (?(condition)... contains too many branches");
9207 ender = reg_node(pRExC_state, TAIL);
9208 REGTAIL(pRExC_state, br, ender);
9210 REGTAIL(pRExC_state, lastbr, ender);
9211 REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender);
9214 REGTAIL(pRExC_state, ret, ender);
9215 RExC_size++; /* XXX WHY do we need this?!!
9216 For large programs it seems to be required
9217 but I can't figure out why. -- dmq*/
9221 vFAIL2("Unknown switch condition (?(%.2s", RExC_parse);
9224 case '[': /* (?[ ... ]) */
9225 return handle_regex_sets(pRExC_state, NULL, flagp, depth,
9228 RExC_parse--; /* for vFAIL to print correctly */
9229 vFAIL("Sequence (? incomplete");
9231 default: /* e.g., (?i) */
9234 parse_lparen_question_flags(pRExC_state);
9235 if (UCHARAT(RExC_parse) != ':') {
9236 nextchar(pRExC_state);
9241 nextchar(pRExC_state);
9251 ret = reganode(pRExC_state, OPEN, parno);
9254 RExC_nestroot = parno;
9255 if (RExC_seen & REG_SEEN_RECURSE
9256 && !RExC_open_parens[parno-1])
9258 DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
9259 "Setting open paren #%"IVdf" to %d\n",
9260 (IV)parno, REG_NODE_NUM(ret)));
9261 RExC_open_parens[parno-1]= ret;
9264 Set_Node_Length(ret, 1); /* MJD */
9265 Set_Node_Offset(ret, RExC_parse); /* MJD */
9273 /* Pick up the branches, linking them together. */
9274 parse_start = RExC_parse; /* MJD */
9275 br = regbranch(pRExC_state, &flags, 1,depth+1);
9277 /* branch_len = (paren != 0); */
9280 if (flags & RESTART_UTF8) {
9281 *flagp = RESTART_UTF8;
9284 FAIL2("panic: regbranch returned NULL, flags=%#"UVxf"", (UV) flags);
9286 if (*RExC_parse == '|') {
9287 if (!SIZE_ONLY && RExC_extralen) {
9288 reginsert(pRExC_state, BRANCHJ, br, depth+1);
9291 reginsert(pRExC_state, BRANCH, br, depth+1);
9292 Set_Node_Length(br, paren != 0);
9293 Set_Node_Offset_To_R(br-RExC_emit_start, parse_start-RExC_start);
9297 RExC_extralen += 1; /* For BRANCHJ-BRANCH. */
9299 else if (paren == ':') {
9300 *flagp |= flags&SIMPLE;
9302 if (is_open) { /* Starts with OPEN. */
9303 REGTAIL(pRExC_state, ret, br); /* OPEN -> first. */
9305 else if (paren != '?') /* Not Conditional */
9307 *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
9309 while (*RExC_parse == '|') {
9310 if (!SIZE_ONLY && RExC_extralen) {
9311 ender = reganode(pRExC_state, LONGJMP,0);
9312 REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender); /* Append to the previous. */
9315 RExC_extralen += 2; /* Account for LONGJMP. */
9316 nextchar(pRExC_state);
9318 if (RExC_npar > after_freeze)
9319 after_freeze = RExC_npar;
9320 RExC_npar = freeze_paren;
9322 br = regbranch(pRExC_state, &flags, 0, depth+1);
9325 if (flags & RESTART_UTF8) {
9326 *flagp = RESTART_UTF8;
9329 FAIL2("panic: regbranch returned NULL, flags=%#"UVxf"", (UV) flags);
9331 REGTAIL(pRExC_state, lastbr, br); /* BRANCH -> BRANCH. */
9333 *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
9336 if (have_branch || paren != ':') {
9337 /* Make a closing node, and hook it on the end. */
9340 ender = reg_node(pRExC_state, TAIL);
9343 ender = reganode(pRExC_state, CLOSE, parno);
9344 if (!SIZE_ONLY && RExC_seen & REG_SEEN_RECURSE) {
9345 DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
9346 "Setting close paren #%"IVdf" to %d\n",
9347 (IV)parno, REG_NODE_NUM(ender)));
9348 RExC_close_parens[parno-1]= ender;
9349 if (RExC_nestroot == parno)
9352 Set_Node_Offset(ender,RExC_parse+1); /* MJD */
9353 Set_Node_Length(ender,1); /* MJD */
9359 *flagp &= ~HASWIDTH;
9362 ender = reg_node(pRExC_state, SUCCEED);
9365 ender = reg_node(pRExC_state, END);
9367 assert(!RExC_opend); /* there can only be one! */
9372 DEBUG_PARSE_r(if (!SIZE_ONLY) {
9373 SV * const mysv_val1=sv_newmortal();
9374 SV * const mysv_val2=sv_newmortal();
9375 DEBUG_PARSE_MSG("lsbr");
9376 regprop(RExC_rx, mysv_val1, lastbr);
9377 regprop(RExC_rx, mysv_val2, ender);
9378 PerlIO_printf(Perl_debug_log, "~ tying lastbr %s (%"IVdf") to ender %s (%"IVdf") offset %"IVdf"\n",
9379 SvPV_nolen_const(mysv_val1),
9380 (IV)REG_NODE_NUM(lastbr),
9381 SvPV_nolen_const(mysv_val2),
9382 (IV)REG_NODE_NUM(ender),
9383 (IV)(ender - lastbr)
9386 REGTAIL(pRExC_state, lastbr, ender);
9388 if (have_branch && !SIZE_ONLY) {
9391 RExC_seen |= REG_TOP_LEVEL_BRANCHES;
9393 /* Hook the tails of the branches to the closing node. */
9394 for (br = ret; br; br = regnext(br)) {
9395 const U8 op = PL_regkind[OP(br)];
9397 REGTAIL_STUDY(pRExC_state, NEXTOPER(br), ender);
9398 if (OP(NEXTOPER(br)) != NOTHING || regnext(NEXTOPER(br)) != ender)
9401 else if (op == BRANCHJ) {
9402 REGTAIL_STUDY(pRExC_state, NEXTOPER(NEXTOPER(br)), ender);
9403 /* for now we always disable this optimisation * /
9404 if (OP(NEXTOPER(NEXTOPER(br))) != NOTHING || regnext(NEXTOPER(NEXTOPER(br))) != ender)
9410 br= PL_regkind[OP(ret)] != BRANCH ? regnext(ret) : ret;
9411 DEBUG_PARSE_r(if (!SIZE_ONLY) {
9412 SV * const mysv_val1=sv_newmortal();
9413 SV * const mysv_val2=sv_newmortal();
9414 DEBUG_PARSE_MSG("NADA");
9415 regprop(RExC_rx, mysv_val1, ret);
9416 regprop(RExC_rx, mysv_val2, ender);
9417 PerlIO_printf(Perl_debug_log, "~ converting ret %s (%"IVdf") to ender %s (%"IVdf") offset %"IVdf"\n",
9418 SvPV_nolen_const(mysv_val1),
9419 (IV)REG_NODE_NUM(ret),
9420 SvPV_nolen_const(mysv_val2),
9421 (IV)REG_NODE_NUM(ender),
9426 if (OP(ender) == TAIL) {
9431 for ( opt= br + 1; opt < ender ; opt++ )
9433 NEXT_OFF(br)= ender - br;
9441 static const char parens[] = "=!<,>";
9443 if (paren && (p = strchr(parens, paren))) {
9444 U8 node = ((p - parens) % 2) ? UNLESSM : IFMATCH;
9445 int flag = (p - parens) > 1;
9448 node = SUSPEND, flag = 0;
9449 reginsert(pRExC_state, node,ret, depth+1);
9450 Set_Node_Cur_Length(ret, parse_start);
9451 Set_Node_Offset(ret, parse_start + 1);
9453 REGTAIL_STUDY(pRExC_state, ret, reg_node(pRExC_state, TAIL));
9457 /* Check for proper termination. */
9459 /* restore original flags, but keep (?p) */
9460 RExC_flags = oregflags | (RExC_flags & RXf_PMf_KEEPCOPY);
9461 if (RExC_parse >= RExC_end || *nextchar(pRExC_state) != ')') {
9462 RExC_parse = oregcomp_parse;
9463 vFAIL("Unmatched (");
9466 else if (!paren && RExC_parse < RExC_end) {
9467 if (*RExC_parse == ')') {
9469 vFAIL("Unmatched )");
9472 FAIL("Junk on end of regexp"); /* "Can't happen". */
9473 assert(0); /* NOTREACHED */
9476 if (RExC_in_lookbehind) {
9477 RExC_in_lookbehind--;
9479 if (after_freeze > RExC_npar)
9480 RExC_npar = after_freeze;
9485 - regbranch - one alternative of an | operator
9487 * Implements the concatenation operator.
9489 * Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan needs to be
9493 S_regbranch(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, I32 first, U32 depth)
9497 regnode *chain = NULL;
9499 I32 flags = 0, c = 0;
9500 GET_RE_DEBUG_FLAGS_DECL;
9502 PERL_ARGS_ASSERT_REGBRANCH;
9504 DEBUG_PARSE("brnc");
9509 if (!SIZE_ONLY && RExC_extralen)
9510 ret = reganode(pRExC_state, BRANCHJ,0);
9512 ret = reg_node(pRExC_state, BRANCH);
9513 Set_Node_Length(ret, 1);
9517 if (!first && SIZE_ONLY)
9518 RExC_extralen += 1; /* BRANCHJ */
9520 *flagp = WORST; /* Tentatively. */
9523 nextchar(pRExC_state);
9524 while (RExC_parse < RExC_end && *RExC_parse != '|' && *RExC_parse != ')') {
9526 latest = regpiece(pRExC_state, &flags,depth+1);
9527 if (latest == NULL) {
9528 if (flags & TRYAGAIN)
9530 if (flags & RESTART_UTF8) {
9531 *flagp = RESTART_UTF8;
9534 FAIL2("panic: regpiece returned NULL, flags=%#"UVxf"", (UV) flags);
9536 else if (ret == NULL)
9538 *flagp |= flags&(HASWIDTH|POSTPONED);
9539 if (chain == NULL) /* First piece. */
9540 *flagp |= flags&SPSTART;
9543 REGTAIL(pRExC_state, chain, latest);
9548 if (chain == NULL) { /* Loop ran zero times. */
9549 chain = reg_node(pRExC_state, NOTHING);
9554 *flagp |= flags&SIMPLE;
9561 - regpiece - something followed by possible [*+?]
9563 * Note that the branching code sequences used for ? and the general cases
9564 * of * and + are somewhat optimized: they use the same NOTHING node as
9565 * both the endmarker for their branch list and the body of the last branch.
9566 * It might seem that this node could be dispensed with entirely, but the
9567 * endmarker role is not redundant.
9569 * Returns NULL, setting *flagp to TRYAGAIN if regatom() returns NULL with
9571 * Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan needs to be
9575 S_regpiece(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
9582 const char * const origparse = RExC_parse;
9584 I32 max = REG_INFTY;
9585 #ifdef RE_TRACK_PATTERN_OFFSETS
9588 const char *maxpos = NULL;
9590 /* Save the original in case we change the emitted regop to a FAIL. */
9591 regnode * const orig_emit = RExC_emit;
9593 GET_RE_DEBUG_FLAGS_DECL;
9595 PERL_ARGS_ASSERT_REGPIECE;
9597 DEBUG_PARSE("piec");
9599 ret = regatom(pRExC_state, &flags,depth+1);
9601 if (flags & (TRYAGAIN|RESTART_UTF8))
9602 *flagp |= flags & (TRYAGAIN|RESTART_UTF8);
9604 FAIL2("panic: regatom returned NULL, flags=%#"UVxf"", (UV) flags);
9610 if (op == '{' && regcurly(RExC_parse, FALSE)) {
9612 #ifdef RE_TRACK_PATTERN_OFFSETS
9613 parse_start = RExC_parse; /* MJD */
9615 next = RExC_parse + 1;
9616 while (isDIGIT(*next) || *next == ',') {
9625 if (*next == '}') { /* got one */
9629 min = atoi(RExC_parse);
9633 maxpos = RExC_parse;
9635 if (!max && *maxpos != '0')
9636 max = REG_INFTY; /* meaning "infinity" */
9637 else if (max >= REG_INFTY)
9638 vFAIL2("Quantifier in {,} bigger than %d", REG_INFTY - 1);
9640 nextchar(pRExC_state);
9641 if (max < min) { /* If can't match, warn and optimize to fail
9644 ckWARNreg(RExC_parse, "Quantifier {n,m} with n > m can't match");
9646 /* We can't back off the size because we have to reserve
9647 * enough space for all the things we are about to throw
9648 * away, but we can shrink it by the ammount we are about
9650 RExC_size = PREVOPER(RExC_size) - regarglen[(U8)OPFAIL];
9653 RExC_emit = orig_emit;
9655 ret = reg_node(pRExC_state, OPFAIL);
9660 if ((flags&SIMPLE)) {
9661 RExC_naughty += 2 + RExC_naughty / 2;
9662 reginsert(pRExC_state, CURLY, ret, depth+1);
9663 Set_Node_Offset(ret, parse_start+1); /* MJD */
9664 Set_Node_Cur_Length(ret, parse_start);
9667 regnode * const w = reg_node(pRExC_state, WHILEM);
9670 REGTAIL(pRExC_state, ret, w);
9671 if (!SIZE_ONLY && RExC_extralen) {
9672 reginsert(pRExC_state, LONGJMP,ret, depth+1);
9673 reginsert(pRExC_state, NOTHING,ret, depth+1);
9674 NEXT_OFF(ret) = 3; /* Go over LONGJMP. */
9676 reginsert(pRExC_state, CURLYX,ret, depth+1);
9678 Set_Node_Offset(ret, parse_start+1);
9679 Set_Node_Length(ret,
9680 op == '{' ? (RExC_parse - parse_start) : 1);
9682 if (!SIZE_ONLY && RExC_extralen)
9683 NEXT_OFF(ret) = 3; /* Go over NOTHING to LONGJMP. */
9684 REGTAIL(pRExC_state, ret, reg_node(pRExC_state, NOTHING));
9686 RExC_whilem_seen++, RExC_extralen += 3;
9687 RExC_naughty += 4 + RExC_naughty; /* compound interest */
9696 ARG1_SET(ret, (U16)min);
9697 ARG2_SET(ret, (U16)max);
9709 #if 0 /* Now runtime fix should be reliable. */
9711 /* if this is reinstated, don't forget to put this back into perldiag:
9713 =item Regexp *+ operand could be empty at {#} in regex m/%s/
9715 (F) The part of the regexp subject to either the * or + quantifier
9716 could match an empty string. The {#} shows in the regular
9717 expression about where the problem was discovered.
9721 if (!(flags&HASWIDTH) && op != '?')
9722 vFAIL("Regexp *+ operand could be empty");
9725 #ifdef RE_TRACK_PATTERN_OFFSETS
9726 parse_start = RExC_parse;
9728 nextchar(pRExC_state);
9730 *flagp = (op != '+') ? (WORST|SPSTART|HASWIDTH) : (WORST|HASWIDTH);
9732 if (op == '*' && (flags&SIMPLE)) {
9733 reginsert(pRExC_state, STAR, ret, depth+1);
9737 else if (op == '*') {
9741 else if (op == '+' && (flags&SIMPLE)) {
9742 reginsert(pRExC_state, PLUS, ret, depth+1);
9746 else if (op == '+') {
9750 else if (op == '?') {
9755 if (!SIZE_ONLY && !(flags&(HASWIDTH|POSTPONED)) && max > REG_INFTY/3) {
9756 SAVEFREESV(RExC_rx_sv); /* in case of fatal warnings */
9757 ckWARN3reg(RExC_parse,
9758 "%.*s matches null string many times",
9759 (int)(RExC_parse >= origparse ? RExC_parse - origparse : 0),
9761 (void)ReREFCNT_inc(RExC_rx_sv);
9764 if (RExC_parse < RExC_end && *RExC_parse == '?') {
9765 nextchar(pRExC_state);
9766 reginsert(pRExC_state, MINMOD, ret, depth+1);
9767 REGTAIL(pRExC_state, ret, ret + NODE_STEP_REGNODE);
9770 if (RExC_parse < RExC_end && *RExC_parse == '+') {
9772 nextchar(pRExC_state);
9773 ender = reg_node(pRExC_state, SUCCEED);
9774 REGTAIL(pRExC_state, ret, ender);
9775 reginsert(pRExC_state, SUSPEND, ret, depth+1);
9777 ender = reg_node(pRExC_state, TAIL);
9778 REGTAIL(pRExC_state, ret, ender);
9781 if (RExC_parse < RExC_end && ISMULT2(RExC_parse)) {
9783 vFAIL("Nested quantifiers");
9790 S_grok_bslash_N(pTHX_ RExC_state_t *pRExC_state, regnode** node_p, UV *valuep, I32 *flagp, U32 depth, bool in_char_class,
9791 const bool strict /* Apply stricter parsing rules? */
9795 /* This is expected to be called by a parser routine that has recognized '\N'
9796 and needs to handle the rest. RExC_parse is expected to point at the first
9797 char following the N at the time of the call. On successful return,
9798 RExC_parse has been updated to point to just after the sequence identified
9799 by this routine, and <*flagp> has been updated.
9801 The \N may be inside (indicated by the boolean <in_char_class>) or outside a
9804 \N may begin either a named sequence, or if outside a character class, mean
9805 to match a non-newline. For non single-quoted regexes, the tokenizer has
9806 attempted to decide which, and in the case of a named sequence, converted it
9807 into one of the forms: \N{} (if the sequence is null), or \N{U+c1.c2...},
9808 where c1... are the characters in the sequence. For single-quoted regexes,
9809 the tokenizer passes the \N sequence through unchanged; this code will not
9810 attempt to determine this nor expand those, instead raising a syntax error.
9811 The net effect is that if the beginning of the passed-in pattern isn't '{U+'
9812 or there is no '}', it signals that this \N occurrence means to match a
9815 Only the \N{U+...} form should occur in a character class, for the same
9816 reason that '.' inside a character class means to just match a period: it
9817 just doesn't make sense.
9819 The function raises an error (via vFAIL), and doesn't return for various
9820 syntax errors. Otherwise it returns TRUE and sets <node_p> or <valuep> on
9821 success; it returns FALSE otherwise. Returns FALSE, setting *flagp to
9822 RESTART_UTF8 if the sizing scan needs to be restarted. Such a restart is
9823 only possible if node_p is non-NULL.
9826 If <valuep> is non-null, it means the caller can accept an input sequence
9827 consisting of a just a single code point; <*valuep> is set to that value
9828 if the input is such.
9830 If <node_p> is non-null it signifies that the caller can accept any other
9831 legal sequence (i.e., one that isn't just a single code point). <*node_p>
9833 1) \N means not-a-NL: points to a newly created REG_ANY node;
9834 2) \N{}: points to a new NOTHING node;
9835 3) otherwise: points to a new EXACT node containing the resolved
9837 Note that FALSE is returned for single code point sequences if <valuep> is
9841 char * endbrace; /* '}' following the name */
9843 char *endchar; /* Points to '.' or '}' ending cur char in the input
9845 bool has_multiple_chars; /* true if the input stream contains a sequence of
9846 more than one character */
9848 GET_RE_DEBUG_FLAGS_DECL;
9850 PERL_ARGS_ASSERT_GROK_BSLASH_N;
9854 assert(cBOOL(node_p) ^ cBOOL(valuep)); /* Exactly one should be set */
9856 /* The [^\n] meaning of \N ignores spaces and comments under the /x
9857 * modifier. The other meaning does not */
9858 p = (RExC_flags & RXf_PMf_EXTENDED)
9859 ? regwhite( pRExC_state, RExC_parse )
9862 /* Disambiguate between \N meaning a named character versus \N meaning
9863 * [^\n]. The former is assumed when it can't be the latter. */
9864 if (*p != '{' || regcurly(p, FALSE)) {
9867 /* no bare \N in a charclass */
9868 if (in_char_class) {
9869 vFAIL("\\N in a character class must be a named character: \\N{...}");
9873 nextchar(pRExC_state);
9874 *node_p = reg_node(pRExC_state, REG_ANY);
9875 *flagp |= HASWIDTH|SIMPLE;
9878 Set_Node_Length(*node_p, 1); /* MJD */
9882 /* Here, we have decided it should be a named character or sequence */
9884 /* The test above made sure that the next real character is a '{', but
9885 * under the /x modifier, it could be separated by space (or a comment and
9886 * \n) and this is not allowed (for consistency with \x{...} and the
9887 * tokenizer handling of \N{NAME}). */
9888 if (*RExC_parse != '{') {
9889 vFAIL("Missing braces on \\N{}");
9892 RExC_parse++; /* Skip past the '{' */
9894 if (! (endbrace = strchr(RExC_parse, '}')) /* no trailing brace */
9895 || ! (endbrace == RExC_parse /* nothing between the {} */
9896 || (endbrace - RExC_parse >= 2 /* U+ (bad hex is checked below */
9897 && strnEQ(RExC_parse, "U+", 2)))) /* for a better error msg) */
9899 if (endbrace) RExC_parse = endbrace; /* position msg's '<--HERE' */
9900 vFAIL("\\N{NAME} must be resolved by the lexer");
9903 if (endbrace == RExC_parse) { /* empty: \N{} */
9906 *node_p = reg_node(pRExC_state,NOTHING);
9908 else if (in_char_class) {
9909 if (SIZE_ONLY && in_char_class) {
9911 RExC_parse++; /* Position after the "}" */
9912 vFAIL("Zero length \\N{}");
9915 ckWARNreg(RExC_parse,
9916 "Ignoring zero length \\N{} in character class");
9924 nextchar(pRExC_state);
9928 RExC_uni_semantics = 1; /* Unicode named chars imply Unicode semantics */
9929 RExC_parse += 2; /* Skip past the 'U+' */
9931 endchar = RExC_parse + strcspn(RExC_parse, ".}");
9933 /* Code points are separated by dots. If none, there is only one code
9934 * point, and is terminated by the brace */
9935 has_multiple_chars = (endchar < endbrace);
9937 if (valuep && (! has_multiple_chars || in_char_class)) {
9938 /* We only pay attention to the first char of
9939 multichar strings being returned in char classes. I kinda wonder
9940 if this makes sense as it does change the behaviour
9941 from earlier versions, OTOH that behaviour was broken
9942 as well. XXX Solution is to recharacterize as
9943 [rest-of-class]|multi1|multi2... */
9945 STRLEN length_of_hex = (STRLEN)(endchar - RExC_parse);
9946 I32 grok_hex_flags = PERL_SCAN_ALLOW_UNDERSCORES
9947 | PERL_SCAN_DISALLOW_PREFIX
9948 | (SIZE_ONLY ? PERL_SCAN_SILENT_ILLDIGIT : 0);
9950 *valuep = grok_hex(RExC_parse, &length_of_hex, &grok_hex_flags, NULL);
9952 /* The tokenizer should have guaranteed validity, but it's possible to
9953 * bypass it by using single quoting, so check */
9954 if (length_of_hex == 0
9955 || length_of_hex != (STRLEN)(endchar - RExC_parse) )
9957 RExC_parse += length_of_hex; /* Includes all the valid */
9958 RExC_parse += (RExC_orig_utf8) /* point to after 1st invalid */
9959 ? UTF8SKIP(RExC_parse)
9961 /* Guard against malformed utf8 */
9962 if (RExC_parse >= endchar) {
9963 RExC_parse = endchar;
9965 vFAIL("Invalid hexadecimal number in \\N{U+...}");
9968 if (in_char_class && has_multiple_chars) {
9970 RExC_parse = endbrace;
9971 vFAIL("\\N{} in character class restricted to one character");
9974 ckWARNreg(endchar, "Using just the first character returned by \\N{} in character class");
9978 RExC_parse = endbrace + 1;
9980 else if (! node_p || ! has_multiple_chars) {
9982 /* Here, the input is legal, but not according to the caller's
9983 * options. We fail without advancing the parse, so that the
9984 * caller can try again */
9990 /* What is done here is to convert this to a sub-pattern of the form
9991 * (?:\x{char1}\x{char2}...)
9992 * and then call reg recursively. That way, it retains its atomicness,
9993 * while not having to worry about special handling that some code
9994 * points may have. toke.c has converted the original Unicode values
9995 * to native, so that we can just pass on the hex values unchanged. We
9996 * do have to set a flag to keep recoding from happening in the
9999 SV * substitute_parse = newSVpvn_flags("?:", 2, SVf_UTF8|SVs_TEMP);
10001 char *orig_end = RExC_end;
10004 while (RExC_parse < endbrace) {
10006 /* Convert to notation the rest of the code understands */
10007 sv_catpv(substitute_parse, "\\x{");
10008 sv_catpvn(substitute_parse, RExC_parse, endchar - RExC_parse);
10009 sv_catpv(substitute_parse, "}");
10011 /* Point to the beginning of the next character in the sequence. */
10012 RExC_parse = endchar + 1;
10013 endchar = RExC_parse + strcspn(RExC_parse, ".}");
10015 sv_catpv(substitute_parse, ")");
10017 RExC_parse = SvPV(substitute_parse, len);
10019 /* Don't allow empty number */
10021 vFAIL("Invalid hexadecimal number in \\N{U+...}");
10023 RExC_end = RExC_parse + len;
10025 /* The values are Unicode, and therefore not subject to recoding */
10026 RExC_override_recoding = 1;
10028 if (!(*node_p = reg(pRExC_state, 1, &flags, depth+1))) {
10029 if (flags & RESTART_UTF8) {
10030 *flagp = RESTART_UTF8;
10033 FAIL2("panic: reg returned NULL to grok_bslash_N, flags=%#"UVxf"",
10036 *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
10038 RExC_parse = endbrace;
10039 RExC_end = orig_end;
10040 RExC_override_recoding = 0;
10042 nextchar(pRExC_state);
10052 * It returns the code point in utf8 for the value in *encp.
10053 * value: a code value in the source encoding
10054 * encp: a pointer to an Encode object
10056 * If the result from Encode is not a single character,
10057 * it returns U+FFFD (Replacement character) and sets *encp to NULL.
10060 S_reg_recode(pTHX_ const char value, SV **encp)
10063 SV * const sv = newSVpvn_flags(&value, numlen, SVs_TEMP);
10064 const char * const s = *encp ? sv_recode_to_utf8(sv, *encp) : SvPVX(sv);
10065 const STRLEN newlen = SvCUR(sv);
10066 UV uv = UNICODE_REPLACEMENT;
10068 PERL_ARGS_ASSERT_REG_RECODE;
10072 ? utf8n_to_uvchr((U8*)s, newlen, &numlen, UTF8_ALLOW_DEFAULT)
10075 if (!newlen || numlen != newlen) {
10076 uv = UNICODE_REPLACEMENT;
10082 PERL_STATIC_INLINE U8
10083 S_compute_EXACTish(pTHX_ RExC_state_t *pRExC_state)
10087 PERL_ARGS_ASSERT_COMPUTE_EXACTISH;
10093 op = get_regex_charset(RExC_flags);
10094 if (op >= REGEX_ASCII_RESTRICTED_CHARSET) {
10095 op--; /* /a is same as /u, and map /aa's offset to what /a's would have
10096 been, so there is no hole */
10099 return op + EXACTF;
10102 PERL_STATIC_INLINE void
10103 S_alloc_maybe_populate_EXACT(pTHX_ RExC_state_t *pRExC_state, regnode *node, I32* flagp, STRLEN len, UV code_point)
10105 /* This knows the details about sizing an EXACTish node, setting flags for
10106 * it (by setting <*flagp>, and potentially populating it with a single
10109 * If <len> (the length in bytes) is non-zero, this function assumes that
10110 * the node has already been populated, and just does the sizing. In this
10111 * case <code_point> should be the final code point that has already been
10112 * placed into the node. This value will be ignored except that under some
10113 * circumstances <*flagp> is set based on it.
10115 * If <len> is zero, the function assumes that the node is to contain only
10116 * the single character given by <code_point> and calculates what <len>
10117 * should be. In pass 1, it sizes the node appropriately. In pass 2, it
10118 * additionally will populate the node's STRING with <code_point>, if <len>
10119 * is 0. In both cases <*flagp> is appropriately set
10121 * It knows that under FOLD, the Latin Sharp S and UTF characters above
10122 * 255, must be folded (the former only when the rules indicate it can
10125 bool len_passed_in = cBOOL(len != 0);
10126 U8 character[UTF8_MAXBYTES_CASE+1];
10128 PERL_ARGS_ASSERT_ALLOC_MAYBE_POPULATE_EXACT;
10130 if (! len_passed_in) {
10132 if (FOLD && (! LOC || code_point > 255)) {
10133 _to_uni_fold_flags(NATIVE_TO_UNI(code_point),
10136 FOLD_FLAGS_FULL | ((LOC)
10137 ? FOLD_FLAGS_LOCALE
10138 : (ASCII_FOLD_RESTRICTED)
10139 ? FOLD_FLAGS_NOMIX_ASCII
10143 uvchr_to_utf8( character, code_point);
10144 len = UTF8SKIP(character);
10148 || code_point != LATIN_SMALL_LETTER_SHARP_S
10149 || ASCII_FOLD_RESTRICTED
10150 || ! AT_LEAST_UNI_SEMANTICS)
10152 *character = (U8) code_point;
10157 *(character + 1) = 's';
10163 RExC_size += STR_SZ(len);
10166 RExC_emit += STR_SZ(len);
10167 STR_LEN(node) = len;
10168 if (! len_passed_in) {
10169 Copy((char *) character, STRING(node), len, char);
10173 *flagp |= HASWIDTH;
10175 /* A single character node is SIMPLE, except for the special-cased SHARP S
10177 if ((len == 1 || (UTF && len == UNISKIP(code_point)))
10178 && (code_point != LATIN_SMALL_LETTER_SHARP_S
10179 || ! FOLD || ! DEPENDS_SEMANTICS))
10186 - regatom - the lowest level
10188 Try to identify anything special at the start of the pattern. If there
10189 is, then handle it as required. This may involve generating a single regop,
10190 such as for an assertion; or it may involve recursing, such as to
10191 handle a () structure.
10193 If the string doesn't start with something special then we gobble up
10194 as much literal text as we can.
10196 Once we have been able to handle whatever type of thing started the
10197 sequence, we return.
10199 Note: we have to be careful with escapes, as they can be both literal
10200 and special, and in the case of \10 and friends, context determines which.
10202 A summary of the code structure is:
10204 switch (first_byte) {
10205 cases for each special:
10206 handle this special;
10209 switch (2nd byte) {
10210 cases for each unambiguous special:
10211 handle this special;
10213 cases for each ambigous special/literal:
10215 if (special) handle here
10217 default: // unambiguously literal:
10220 default: // is a literal char
10223 create EXACTish node for literal;
10224 while (more input and node isn't full) {
10225 switch (input_byte) {
10226 cases for each special;
10227 make sure parse pointer is set so that the next call to
10228 regatom will see this special first
10229 goto loopdone; // EXACTish node terminated by prev. char
10231 append char to EXACTISH node;
10233 get next input byte;
10237 return the generated node;
10239 Specifically there are two separate switches for handling
10240 escape sequences, with the one for handling literal escapes requiring
10241 a dummy entry for all of the special escapes that are actually handled
10244 Returns NULL, setting *flagp to TRYAGAIN if reg() returns NULL with
10246 Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan needs to be
10248 Otherwise does not return NULL.
10252 S_regatom(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
10255 regnode *ret = NULL;
10257 char *parse_start = RExC_parse;
10261 GET_RE_DEBUG_FLAGS_DECL;
10263 *flagp = WORST; /* Tentatively. */
10265 DEBUG_PARSE("atom");
10267 PERL_ARGS_ASSERT_REGATOM;
10270 switch ((U8)*RExC_parse) {
10272 RExC_seen_zerolen++;
10273 nextchar(pRExC_state);
10274 if (RExC_flags & RXf_PMf_MULTILINE)
10275 ret = reg_node(pRExC_state, MBOL);
10276 else if (RExC_flags & RXf_PMf_SINGLELINE)
10277 ret = reg_node(pRExC_state, SBOL);
10279 ret = reg_node(pRExC_state, BOL);
10280 Set_Node_Length(ret, 1); /* MJD */
10283 nextchar(pRExC_state);
10285 RExC_seen_zerolen++;
10286 if (RExC_flags & RXf_PMf_MULTILINE)
10287 ret = reg_node(pRExC_state, MEOL);
10288 else if (RExC_flags & RXf_PMf_SINGLELINE)
10289 ret = reg_node(pRExC_state, SEOL);
10291 ret = reg_node(pRExC_state, EOL);
10292 Set_Node_Length(ret, 1); /* MJD */
10295 nextchar(pRExC_state);
10296 if (RExC_flags & RXf_PMf_SINGLELINE)
10297 ret = reg_node(pRExC_state, SANY);
10299 ret = reg_node(pRExC_state, REG_ANY);
10300 *flagp |= HASWIDTH|SIMPLE;
10302 Set_Node_Length(ret, 1); /* MJD */
10306 char * const oregcomp_parse = ++RExC_parse;
10307 ret = regclass(pRExC_state, flagp,depth+1,
10308 FALSE, /* means parse the whole char class */
10309 TRUE, /* allow multi-char folds */
10310 FALSE, /* don't silence non-portable warnings. */
10312 if (*RExC_parse != ']') {
10313 RExC_parse = oregcomp_parse;
10314 vFAIL("Unmatched [");
10317 if (*flagp & RESTART_UTF8)
10319 FAIL2("panic: regclass returned NULL to regatom, flags=%#"UVxf"",
10322 nextchar(pRExC_state);
10323 Set_Node_Length(ret, RExC_parse - oregcomp_parse + 1); /* MJD */
10327 nextchar(pRExC_state);
10328 ret = reg(pRExC_state, 2, &flags,depth+1);
10330 if (flags & TRYAGAIN) {
10331 if (RExC_parse == RExC_end) {
10332 /* Make parent create an empty node if needed. */
10333 *flagp |= TRYAGAIN;
10338 if (flags & RESTART_UTF8) {
10339 *flagp = RESTART_UTF8;
10342 FAIL2("panic: reg returned NULL to regatom, flags=%#"UVxf"", (UV) flags);
10344 *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
10348 if (flags & TRYAGAIN) {
10349 *flagp |= TRYAGAIN;
10352 vFAIL("Internal urp");
10353 /* Supposed to be caught earlier. */
10356 if (!regcurly(RExC_parse, FALSE)) {
10365 vFAIL("Quantifier follows nothing");
10370 This switch handles escape sequences that resolve to some kind
10371 of special regop and not to literal text. Escape sequnces that
10372 resolve to literal text are handled below in the switch marked
10375 Every entry in this switch *must* have a corresponding entry
10376 in the literal escape switch. However, the opposite is not
10377 required, as the default for this switch is to jump to the
10378 literal text handling code.
10380 switch ((U8)*++RExC_parse) {
10382 /* Special Escapes */
10384 RExC_seen_zerolen++;
10385 ret = reg_node(pRExC_state, SBOL);
10387 goto finish_meta_pat;
10389 ret = reg_node(pRExC_state, GPOS);
10390 RExC_seen |= REG_SEEN_GPOS;
10392 goto finish_meta_pat;
10394 RExC_seen_zerolen++;
10395 ret = reg_node(pRExC_state, KEEPS);
10397 /* XXX:dmq : disabling in-place substitution seems to
10398 * be necessary here to avoid cases of memory corruption, as
10399 * with: C<$_="x" x 80; s/x\K/y/> -- rgs
10401 RExC_seen |= REG_SEEN_LOOKBEHIND;
10402 goto finish_meta_pat;
10404 ret = reg_node(pRExC_state, SEOL);
10406 RExC_seen_zerolen++; /* Do not optimize RE away */
10407 goto finish_meta_pat;
10409 ret = reg_node(pRExC_state, EOS);
10411 RExC_seen_zerolen++; /* Do not optimize RE away */
10412 goto finish_meta_pat;
10414 ret = reg_node(pRExC_state, CANY);
10415 RExC_seen |= REG_SEEN_CANY;
10416 *flagp |= HASWIDTH|SIMPLE;
10417 goto finish_meta_pat;
10419 ret = reg_node(pRExC_state, CLUMP);
10420 *flagp |= HASWIDTH;
10421 goto finish_meta_pat;
10427 arg = ANYOF_WORDCHAR;
10431 RExC_seen_zerolen++;
10432 RExC_seen |= REG_SEEN_LOOKBEHIND;
10433 op = BOUND + get_regex_charset(RExC_flags);
10434 if (op > BOUNDA) { /* /aa is same as /a */
10437 ret = reg_node(pRExC_state, op);
10438 FLAGS(ret) = get_regex_charset(RExC_flags);
10440 if (! SIZE_ONLY && (U8) *(RExC_parse + 1) == '{') {
10441 ckWARNdep(RExC_parse, "\"\\b{\" is deprecated; use \"\\b\\{\" or \"\\b[{]\" instead");
10443 goto finish_meta_pat;
10445 RExC_seen_zerolen++;
10446 RExC_seen |= REG_SEEN_LOOKBEHIND;
10447 op = NBOUND + get_regex_charset(RExC_flags);
10448 if (op > NBOUNDA) { /* /aa is same as /a */
10451 ret = reg_node(pRExC_state, op);
10452 FLAGS(ret) = get_regex_charset(RExC_flags);
10454 if (! SIZE_ONLY && (U8) *(RExC_parse + 1) == '{') {
10455 ckWARNdep(RExC_parse, "\"\\B{\" is deprecated; use \"\\B\\{\" or \"\\B[{]\" instead");
10457 goto finish_meta_pat;
10467 ret = reg_node(pRExC_state, LNBREAK);
10468 *flagp |= HASWIDTH|SIMPLE;
10469 goto finish_meta_pat;
10477 goto join_posix_op_known;
10483 arg = ANYOF_VERTWS;
10485 goto join_posix_op_known;
10495 op = POSIXD + get_regex_charset(RExC_flags);
10496 if (op > POSIXA) { /* /aa is same as /a */
10500 join_posix_op_known:
10503 op += NPOSIXD - POSIXD;
10506 ret = reg_node(pRExC_state, op);
10508 FLAGS(ret) = namedclass_to_classnum(arg);
10511 *flagp |= HASWIDTH|SIMPLE;
10515 nextchar(pRExC_state);
10516 Set_Node_Length(ret, 2); /* MJD */
10522 char* parse_start = RExC_parse - 2;
10527 ret = regclass(pRExC_state, flagp,depth+1,
10528 TRUE, /* means just parse this element */
10529 FALSE, /* don't allow multi-char folds */
10530 FALSE, /* don't silence non-portable warnings.
10531 It would be a bug if these returned
10534 /* regclass() can only return RESTART_UTF8 if multi-char folds
10537 FAIL2("panic: regclass returned NULL to regatom, flags=%#"UVxf"",
10542 Set_Node_Offset(ret, parse_start + 2);
10543 Set_Node_Cur_Length(ret, parse_start);
10544 nextchar(pRExC_state);
10548 /* Handle \N and \N{NAME} with multiple code points here and not
10549 * below because it can be multicharacter. join_exact() will join
10550 * them up later on. Also this makes sure that things like
10551 * /\N{BLAH}+/ and \N{BLAH} being multi char Just Happen. dmq.
10552 * The options to the grok function call causes it to fail if the
10553 * sequence is just a single code point. We then go treat it as
10554 * just another character in the current EXACT node, and hence it
10555 * gets uniform treatment with all the other characters. The
10556 * special treatment for quantifiers is not needed for such single
10557 * character sequences */
10559 if (! grok_bslash_N(pRExC_state, &ret, NULL, flagp, depth, FALSE,
10560 FALSE /* not strict */ )) {
10561 if (*flagp & RESTART_UTF8)
10567 case 'k': /* Handle \k<NAME> and \k'NAME' */
10570 char ch= RExC_parse[1];
10571 if (ch != '<' && ch != '\'' && ch != '{') {
10573 vFAIL2("Sequence %.2s... not terminated",parse_start);
10575 /* this pretty much dupes the code for (?P=...) in reg(), if
10576 you change this make sure you change that */
10577 char* name_start = (RExC_parse += 2);
10579 SV *sv_dat = reg_scan_name(pRExC_state,
10580 SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
10581 ch= (ch == '<') ? '>' : (ch == '{') ? '}' : '\'';
10582 if (RExC_parse == name_start || *RExC_parse != ch)
10583 vFAIL2("Sequence %.3s... not terminated",parse_start);
10586 num = add_data( pRExC_state, 1, "S" );
10587 RExC_rxi->data->data[num]=(void*)sv_dat;
10588 SvREFCNT_inc_simple_void(sv_dat);
10592 ret = reganode(pRExC_state,
10595 : (ASCII_FOLD_RESTRICTED)
10597 : (AT_LEAST_UNI_SEMANTICS)
10603 *flagp |= HASWIDTH;
10605 /* override incorrect value set in reganode MJD */
10606 Set_Node_Offset(ret, parse_start+1);
10607 Set_Node_Cur_Length(ret, parse_start);
10608 nextchar(pRExC_state);
10614 case '1': case '2': case '3': case '4':
10615 case '5': case '6': case '7': case '8': case '9':
10618 bool isg = *RExC_parse == 'g';
10623 if (*RExC_parse == '{') {
10627 if (*RExC_parse == '-') {
10631 if (hasbrace && !isDIGIT(*RExC_parse)) {
10632 if (isrel) RExC_parse--;
10634 goto parse_named_seq;
10636 num = atoi(RExC_parse);
10637 if (isg && num == 0) {
10638 if (*RExC_parse == '0') {
10639 vFAIL("Reference to invalid group 0");
10642 vFAIL("Unterminated \\g... pattern");
10646 num = RExC_npar - num;
10648 vFAIL("Reference to nonexistent or unclosed group");
10650 if (!isg && num > 9 && num >= RExC_npar && *RExC_parse != '8' && *RExC_parse != '9')
10651 /* Probably a character specified in octal, e.g. \35 */
10654 #ifdef RE_TRACK_PATTERN_OFFSETS
10655 char * const parse_start = RExC_parse - 1; /* MJD */
10657 while (isDIGIT(*RExC_parse))
10660 if (*RExC_parse != '}')
10661 vFAIL("Unterminated \\g{...} pattern");
10665 if (num > (I32)RExC_rx->nparens)
10666 vFAIL("Reference to nonexistent group");
10669 ret = reganode(pRExC_state,
10672 : (ASCII_FOLD_RESTRICTED)
10674 : (AT_LEAST_UNI_SEMANTICS)
10680 *flagp |= HASWIDTH;
10682 /* override incorrect value set in reganode MJD */
10683 Set_Node_Offset(ret, parse_start+1);
10684 Set_Node_Cur_Length(ret, parse_start);
10686 nextchar(pRExC_state);
10691 if (RExC_parse >= RExC_end)
10692 FAIL("Trailing \\");
10695 /* Do not generate "unrecognized" warnings here, we fall
10696 back into the quick-grab loop below */
10703 if (RExC_flags & RXf_PMf_EXTENDED) {
10704 if ( reg_skipcomment( pRExC_state ) )
10711 parse_start = RExC_parse - 1;
10720 #define MAX_NODE_STRING_SIZE 127
10721 char foldbuf[MAX_NODE_STRING_SIZE+UTF8_MAXBYTES_CASE];
10723 U8 upper_parse = MAX_NODE_STRING_SIZE;
10726 bool next_is_quantifier;
10727 char * oldp = NULL;
10729 /* If a folding node contains only code points that don't
10730 * participate in folds, it can be changed into an EXACT node,
10731 * which allows the optimizer more things to look for */
10735 node_type = compute_EXACTish(pRExC_state);
10736 ret = reg_node(pRExC_state, node_type);
10738 /* In pass1, folded, we use a temporary buffer instead of the
10739 * actual node, as the node doesn't exist yet */
10740 s = (SIZE_ONLY && FOLD) ? foldbuf : STRING(ret);
10746 /* We do the EXACTFish to EXACT node only if folding, and not if in
10747 * locale, as whether a character folds or not isn't known until
10749 maybe_exact = FOLD && ! LOC;
10751 /* XXX The node can hold up to 255 bytes, yet this only goes to
10752 * 127. I (khw) do not know why. Keeping it somewhat less than
10753 * 255 allows us to not have to worry about overflow due to
10754 * converting to utf8 and fold expansion, but that value is
10755 * 255-UTF8_MAXBYTES_CASE. join_exact() may join adjacent nodes
10756 * split up by this limit into a single one using the real max of
10757 * 255. Even at 127, this breaks under rare circumstances. If
10758 * folding, we do not want to split a node at a character that is a
10759 * non-final in a multi-char fold, as an input string could just
10760 * happen to want to match across the node boundary. The join
10761 * would solve that problem if the join actually happens. But a
10762 * series of more than two nodes in a row each of 127 would cause
10763 * the first join to succeed to get to 254, but then there wouldn't
10764 * be room for the next one, which could at be one of those split
10765 * multi-char folds. I don't know of any fool-proof solution. One
10766 * could back off to end with only a code point that isn't such a
10767 * non-final, but it is possible for there not to be any in the
10769 for (p = RExC_parse - 1;
10770 len < upper_parse && p < RExC_end;
10775 if (RExC_flags & RXf_PMf_EXTENDED)
10776 p = regwhite( pRExC_state, p );
10787 /* Literal Escapes Switch
10789 This switch is meant to handle escape sequences that
10790 resolve to a literal character.
10792 Every escape sequence that represents something
10793 else, like an assertion or a char class, is handled
10794 in the switch marked 'Special Escapes' above in this
10795 routine, but also has an entry here as anything that
10796 isn't explicitly mentioned here will be treated as
10797 an unescaped equivalent literal.
10800 switch ((U8)*++p) {
10801 /* These are all the special escapes. */
10802 case 'A': /* Start assertion */
10803 case 'b': case 'B': /* Word-boundary assertion*/
10804 case 'C': /* Single char !DANGEROUS! */
10805 case 'd': case 'D': /* digit class */
10806 case 'g': case 'G': /* generic-backref, pos assertion */
10807 case 'h': case 'H': /* HORIZWS */
10808 case 'k': case 'K': /* named backref, keep marker */
10809 case 'p': case 'P': /* Unicode property */
10810 case 'R': /* LNBREAK */
10811 case 's': case 'S': /* space class */
10812 case 'v': case 'V': /* VERTWS */
10813 case 'w': case 'W': /* word class */
10814 case 'X': /* eXtended Unicode "combining character sequence" */
10815 case 'z': case 'Z': /* End of line/string assertion */
10819 /* Anything after here is an escape that resolves to a
10820 literal. (Except digits, which may or may not)
10826 case 'N': /* Handle a single-code point named character. */
10827 /* The options cause it to fail if a multiple code
10828 * point sequence. Handle those in the switch() above
10830 RExC_parse = p + 1;
10831 if (! grok_bslash_N(pRExC_state, NULL, &ender,
10832 flagp, depth, FALSE,
10833 FALSE /* not strict */ ))
10835 if (*flagp & RESTART_UTF8)
10836 FAIL("panic: grok_bslash_N set RESTART_UTF8");
10837 RExC_parse = p = oldp;
10841 if (ender > 0xff) {
10858 ender = ASCII_TO_NATIVE('\033');
10862 ender = ASCII_TO_NATIVE('\007');
10868 const char* error_msg;
10870 bool valid = grok_bslash_o(&p,
10873 TRUE, /* out warnings */
10874 FALSE, /* not strict */
10875 TRUE, /* Output warnings
10880 RExC_parse = p; /* going to die anyway; point
10881 to exact spot of failure */
10885 if (PL_encoding && ender < 0x100) {
10886 goto recode_encoding;
10888 if (ender > 0xff) {
10895 UV result = UV_MAX; /* initialize to erroneous
10897 const char* error_msg;
10899 bool valid = grok_bslash_x(&p,
10902 TRUE, /* out warnings */
10903 FALSE, /* not strict */
10904 TRUE, /* Output warnings
10909 RExC_parse = p; /* going to die anyway; point
10910 to exact spot of failure */
10915 if (PL_encoding && ender < 0x100) {
10916 goto recode_encoding;
10918 if (ender > 0xff) {
10925 ender = grok_bslash_c(*p++, UTF, SIZE_ONLY);
10927 case '8': case '9': /* must be a backreference */
10930 case '1': case '2': case '3':case '4':
10931 case '5': case '6': case '7':
10932 /* When we parse backslash escapes there is ambiguity between
10933 * backreferences and octal escapes. Any escape from \1 - \9 is
10934 * a backreference, any multi-digit escape which does not start with
10935 * 0 and which when evaluated as decimal could refer to an already
10936 * parsed capture buffer is a backslash. Anything else is octal.
10938 * Note this implies that \118 could be interpreted as 118 OR as
10939 * "\11" . "8" depending on whether there were 118 capture buffers
10940 * defined already in the pattern.
10942 if ( !isDIGIT(p[1]) || atoi(p) <= RExC_npar )
10943 { /* Not to be treated as an octal constant, go
10950 I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
10952 ender = grok_oct(p, &numlen, &flags, NULL);
10953 if (ender > 0xff) {
10957 if (SIZE_ONLY /* like \08, \178 */
10960 && isDIGIT(*p) && ckWARN(WARN_REGEXP))
10962 reg_warn_non_literal_string(
10964 form_short_octal_warning(p, numlen));
10967 if (PL_encoding && ender < 0x100)
10968 goto recode_encoding;
10971 if (! RExC_override_recoding) {
10972 SV* enc = PL_encoding;
10973 ender = reg_recode((const char)(U8)ender, &enc);
10974 if (!enc && SIZE_ONLY)
10975 ckWARNreg(p, "Invalid escape in the specified encoding");
10981 FAIL("Trailing \\");
10984 if (!SIZE_ONLY&& isALPHANUMERIC(*p)) {
10985 /* Include any { following the alpha to emphasize
10986 * that it could be part of an escape at some point
10988 int len = (isALPHA(*p) && *(p + 1) == '{') ? 2 : 1;
10989 ckWARN3reg(p + len, "Unrecognized escape \\%.*s passed through", len, p);
10991 goto normal_default;
10992 } /* End of switch on '\' */
10994 default: /* A literal character */
10997 && RExC_flags & RXf_PMf_EXTENDED
10998 && ckWARN_d(WARN_DEPRECATED)
10999 && is_PATWS_non_low(p, UTF))
11001 vWARN_dep(p + ((UTF) ? UTF8SKIP(p) : 1),
11002 "Escape literal pattern white space under /x");
11006 if (UTF8_IS_START(*p) && UTF) {
11008 ender = utf8n_to_uvchr((U8*)p, RExC_end - p,
11009 &numlen, UTF8_ALLOW_DEFAULT);
11015 } /* End of switch on the literal */
11017 /* Here, have looked at the literal character and <ender>
11018 * contains its ordinal, <p> points to the character after it
11021 if ( RExC_flags & RXf_PMf_EXTENDED)
11022 p = regwhite( pRExC_state, p );
11024 /* If the next thing is a quantifier, it applies to this
11025 * character only, which means that this character has to be in
11026 * its own node and can't just be appended to the string in an
11027 * existing node, so if there are already other characters in
11028 * the node, close the node with just them, and set up to do
11029 * this character again next time through, when it will be the
11030 * only thing in its new node */
11031 if ((next_is_quantifier = (p < RExC_end && ISMULT2(p))) && len)
11039 const STRLEN unilen = reguni(pRExC_state, ender, s);
11045 /* The loop increments <len> each time, as all but this
11046 * path (and one other) through it add a single byte to
11047 * the EXACTish node. But this one has changed len to
11048 * be the correct final value, so subtract one to
11049 * cancel out the increment that follows */
11053 REGC((char)ender, s++);
11058 /* See comments for join_exact() as to why we fold this
11059 * non-UTF at compile time */
11060 || (node_type == EXACTFU
11061 && ender == LATIN_SMALL_LETTER_SHARP_S)))
11063 *(s++) = (char) ender;
11064 maybe_exact &= ! IS_IN_SOME_FOLD_L1(ender);
11068 /* Prime the casefolded buffer. Locale rules, which apply
11069 * only to code points < 256, aren't known until execution,
11070 * so for them, just output the original character using
11071 * utf8. If we start to fold non-UTF patterns, be sure to
11072 * update join_exact() */
11073 if (LOC && ender < 256) {
11074 if (UNI_IS_INVARIANT(ender)) {
11078 *s = UTF8_TWO_BYTE_HI(ender);
11079 *(s + 1) = UTF8_TWO_BYTE_LO(ender);
11084 UV folded = _to_uni_fold_flags(
11089 | ((LOC) ? FOLD_FLAGS_LOCALE
11090 : (ASCII_FOLD_RESTRICTED)
11091 ? FOLD_FLAGS_NOMIX_ASCII
11095 /* If this node only contains non-folding code points
11096 * so far, see if this new one is also non-folding */
11098 if (folded != ender) {
11099 maybe_exact = FALSE;
11102 /* Here the fold is the original; we have
11103 * to check further to see if anything
11105 if (! PL_utf8_foldable) {
11106 SV* swash = swash_init("utf8",
11108 &PL_sv_undef, 1, 0);
11110 _get_swash_invlist(swash);
11111 SvREFCNT_dec_NN(swash);
11113 if (_invlist_contains_cp(PL_utf8_foldable,
11116 maybe_exact = FALSE;
11124 /* The loop increments <len> each time, as all but this
11125 * path (and one other) through it add a single byte to the
11126 * EXACTish node. But this one has changed len to be the
11127 * correct final value, so subtract one to cancel out the
11128 * increment that follows */
11129 len += foldlen - 1;
11132 if (next_is_quantifier) {
11134 /* Here, the next input is a quantifier, and to get here,
11135 * the current character is the only one in the node.
11136 * Also, here <len> doesn't include the final byte for this
11142 } /* End of loop through literal characters */
11144 /* Here we have either exhausted the input or ran out of room in
11145 * the node. (If we encountered a character that can't be in the
11146 * node, transfer is made directly to <loopdone>, and so we
11147 * wouldn't have fallen off the end of the loop.) In the latter
11148 * case, we artificially have to split the node into two, because
11149 * we just don't have enough space to hold everything. This
11150 * creates a problem if the final character participates in a
11151 * multi-character fold in the non-final position, as a match that
11152 * should have occurred won't, due to the way nodes are matched,
11153 * and our artificial boundary. So back off until we find a non-
11154 * problematic character -- one that isn't at the beginning or
11155 * middle of such a fold. (Either it doesn't participate in any
11156 * folds, or appears only in the final position of all the folds it
11157 * does participate in.) A better solution with far fewer false
11158 * positives, and that would fill the nodes more completely, would
11159 * be to actually have available all the multi-character folds to
11160 * test against, and to back-off only far enough to be sure that
11161 * this node isn't ending with a partial one. <upper_parse> is set
11162 * further below (if we need to reparse the node) to include just
11163 * up through that final non-problematic character that this code
11164 * identifies, so when it is set to less than the full node, we can
11165 * skip the rest of this */
11166 if (FOLD && p < RExC_end && upper_parse == MAX_NODE_STRING_SIZE) {
11168 const STRLEN full_len = len;
11170 assert(len >= MAX_NODE_STRING_SIZE);
11172 /* Here, <s> points to the final byte of the final character.
11173 * Look backwards through the string until find a non-
11174 * problematic character */
11178 /* These two have no multi-char folds to non-UTF characters
11180 if (ASCII_FOLD_RESTRICTED || LOC) {
11184 while (--s >= s0 && IS_NON_FINAL_FOLD(*s)) { }
11188 if (! PL_NonL1NonFinalFold) {
11189 PL_NonL1NonFinalFold = _new_invlist_C_array(
11190 NonL1_Perl_Non_Final_Folds_invlist);
11193 /* Point to the first byte of the final character */
11194 s = (char *) utf8_hop((U8 *) s, -1);
11196 while (s >= s0) { /* Search backwards until find
11197 non-problematic char */
11198 if (UTF8_IS_INVARIANT(*s)) {
11200 /* There are no ascii characters that participate
11201 * in multi-char folds under /aa. In EBCDIC, the
11202 * non-ascii invariants are all control characters,
11203 * so don't ever participate in any folds. */
11204 if (ASCII_FOLD_RESTRICTED
11205 || ! IS_NON_FINAL_FOLD(*s))
11210 else if (UTF8_IS_DOWNGRADEABLE_START(*s)) {
11212 /* No Latin1 characters participate in multi-char
11213 * folds under /l */
11215 || ! IS_NON_FINAL_FOLD(TWO_BYTE_UTF8_TO_UNI(
11221 else if (! _invlist_contains_cp(
11222 PL_NonL1NonFinalFold,
11223 valid_utf8_to_uvchr((U8 *) s, NULL)))
11228 /* Here, the current character is problematic in that
11229 * it does occur in the non-final position of some
11230 * fold, so try the character before it, but have to
11231 * special case the very first byte in the string, so
11232 * we don't read outside the string */
11233 s = (s == s0) ? s -1 : (char *) utf8_hop((U8 *) s, -1);
11234 } /* End of loop backwards through the string */
11236 /* If there were only problematic characters in the string,
11237 * <s> will point to before s0, in which case the length
11238 * should be 0, otherwise include the length of the
11239 * non-problematic character just found */
11240 len = (s < s0) ? 0 : s - s0 + UTF8SKIP(s);
11243 /* Here, have found the final character, if any, that is
11244 * non-problematic as far as ending the node without splitting
11245 * it across a potential multi-char fold. <len> contains the
11246 * number of bytes in the node up-to and including that
11247 * character, or is 0 if there is no such character, meaning
11248 * the whole node contains only problematic characters. In
11249 * this case, give up and just take the node as-is. We can't
11255 /* Here, the node does contain some characters that aren't
11256 * problematic. If one such is the final character in the
11257 * node, we are done */
11258 if (len == full_len) {
11261 else if (len + ((UTF) ? UTF8SKIP(s) : 1) == full_len) {
11263 /* If the final character is problematic, but the
11264 * penultimate is not, back-off that last character to
11265 * later start a new node with it */
11270 /* Here, the final non-problematic character is earlier
11271 * in the input than the penultimate character. What we do
11272 * is reparse from the beginning, going up only as far as
11273 * this final ok one, thus guaranteeing that the node ends
11274 * in an acceptable character. The reason we reparse is
11275 * that we know how far in the character is, but we don't
11276 * know how to correlate its position with the input parse.
11277 * An alternate implementation would be to build that
11278 * correlation as we go along during the original parse,
11279 * but that would entail extra work for every node, whereas
11280 * this code gets executed only when the string is too
11281 * large for the node, and the final two characters are
11282 * problematic, an infrequent occurrence. Yet another
11283 * possible strategy would be to save the tail of the
11284 * string, and the next time regatom is called, initialize
11285 * with that. The problem with this is that unless you
11286 * back off one more character, you won't be guaranteed
11287 * regatom will get called again, unless regbranch,
11288 * regpiece ... are also changed. If you do back off that
11289 * extra character, so that there is input guaranteed to
11290 * force calling regatom, you can't handle the case where
11291 * just the first character in the node is acceptable. I
11292 * (khw) decided to try this method which doesn't have that
11293 * pitfall; if performance issues are found, we can do a
11294 * combination of the current approach plus that one */
11300 } /* End of verifying node ends with an appropriate char */
11302 loopdone: /* Jumped to when encounters something that shouldn't be in
11305 /* I (khw) don't know if you can get here with zero length, but the
11306 * old code handled this situation by creating a zero-length EXACT
11307 * node. Might as well be NOTHING instead */
11313 /* If 'maybe_exact' is still set here, means there are no
11314 * code points in the node that participate in folds */
11315 if (FOLD && maybe_exact) {
11318 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, len, ender);
11321 RExC_parse = p - 1;
11322 Set_Node_Cur_Length(ret, parse_start);
11323 nextchar(pRExC_state);
11325 /* len is STRLEN which is unsigned, need to copy to signed */
11328 vFAIL("Internal disaster");
11331 } /* End of label 'defchar:' */
11333 } /* End of giant switch on input character */
11339 S_regwhite( RExC_state_t *pRExC_state, char *p )
11341 const char *e = RExC_end;
11343 PERL_ARGS_ASSERT_REGWHITE;
11348 else if (*p == '#') {
11351 if (*p++ == '\n') {
11357 RExC_seen |= REG_SEEN_RUN_ON_COMMENT;
11366 S_regpatws( RExC_state_t *pRExC_state, char *p , const bool recognize_comment )
11368 /* Returns the next non-pattern-white space, non-comment character (the
11369 * latter only if 'recognize_comment is true) in the string p, which is
11370 * ended by RExC_end. If there is no line break ending a comment,
11371 * RExC_seen has added the REG_SEEN_RUN_ON_COMMENT flag; */
11372 const char *e = RExC_end;
11374 PERL_ARGS_ASSERT_REGPATWS;
11378 if ((len = is_PATWS_safe(p, e, UTF))) {
11381 else if (recognize_comment && *p == '#') {
11385 if (is_LNBREAK_safe(p, e, UTF)) {
11391 RExC_seen |= REG_SEEN_RUN_ON_COMMENT;
11399 /* Parse POSIX character classes: [[:foo:]], [[=foo=]], [[.foo.]].
11400 Character classes ([:foo:]) can also be negated ([:^foo:]).
11401 Returns a named class id (ANYOF_XXX) if successful, -1 otherwise.
11402 Equivalence classes ([=foo=]) and composites ([.foo.]) are parsed,
11403 but trigger failures because they are currently unimplemented. */
11405 #define POSIXCC_DONE(c) ((c) == ':')
11406 #define POSIXCC_NOTYET(c) ((c) == '=' || (c) == '.')
11407 #define POSIXCC(c) (POSIXCC_DONE(c) || POSIXCC_NOTYET(c))
11409 PERL_STATIC_INLINE I32
11410 S_regpposixcc(pTHX_ RExC_state_t *pRExC_state, I32 value, const bool strict)
11413 I32 namedclass = OOB_NAMEDCLASS;
11415 PERL_ARGS_ASSERT_REGPPOSIXCC;
11417 if (value == '[' && RExC_parse + 1 < RExC_end &&
11418 /* I smell either [: or [= or [. -- POSIX has been here, right? */
11419 POSIXCC(UCHARAT(RExC_parse)))
11421 const char c = UCHARAT(RExC_parse);
11422 char* const s = RExC_parse++;
11424 while (RExC_parse < RExC_end && UCHARAT(RExC_parse) != c)
11426 if (RExC_parse == RExC_end) {
11429 /* Try to give a better location for the error (than the end of
11430 * the string) by looking for the matching ']' */
11432 while (RExC_parse < RExC_end && UCHARAT(RExC_parse) != ']') {
11435 vFAIL2("Unmatched '%c' in POSIX class", c);
11437 /* Grandfather lone [:, [=, [. */
11441 const char* const t = RExC_parse++; /* skip over the c */
11444 if (UCHARAT(RExC_parse) == ']') {
11445 const char *posixcc = s + 1;
11446 RExC_parse++; /* skip over the ending ] */
11449 const I32 complement = *posixcc == '^' ? *posixcc++ : 0;
11450 const I32 skip = t - posixcc;
11452 /* Initially switch on the length of the name. */
11455 if (memEQ(posixcc, "word", 4)) /* this is not POSIX,
11456 this is the Perl \w
11458 namedclass = ANYOF_WORDCHAR;
11461 /* Names all of length 5. */
11462 /* alnum alpha ascii blank cntrl digit graph lower
11463 print punct space upper */
11464 /* Offset 4 gives the best switch position. */
11465 switch (posixcc[4]) {
11467 if (memEQ(posixcc, "alph", 4)) /* alpha */
11468 namedclass = ANYOF_ALPHA;
11471 if (memEQ(posixcc, "spac", 4)) /* space */
11472 namedclass = ANYOF_PSXSPC;
11475 if (memEQ(posixcc, "grap", 4)) /* graph */
11476 namedclass = ANYOF_GRAPH;
11479 if (memEQ(posixcc, "asci", 4)) /* ascii */
11480 namedclass = ANYOF_ASCII;
11483 if (memEQ(posixcc, "blan", 4)) /* blank */
11484 namedclass = ANYOF_BLANK;
11487 if (memEQ(posixcc, "cntr", 4)) /* cntrl */
11488 namedclass = ANYOF_CNTRL;
11491 if (memEQ(posixcc, "alnu", 4)) /* alnum */
11492 namedclass = ANYOF_ALPHANUMERIC;
11495 if (memEQ(posixcc, "lowe", 4)) /* lower */
11496 namedclass = (FOLD) ? ANYOF_CASED : ANYOF_LOWER;
11497 else if (memEQ(posixcc, "uppe", 4)) /* upper */
11498 namedclass = (FOLD) ? ANYOF_CASED : ANYOF_UPPER;
11501 if (memEQ(posixcc, "digi", 4)) /* digit */
11502 namedclass = ANYOF_DIGIT;
11503 else if (memEQ(posixcc, "prin", 4)) /* print */
11504 namedclass = ANYOF_PRINT;
11505 else if (memEQ(posixcc, "punc", 4)) /* punct */
11506 namedclass = ANYOF_PUNCT;
11511 if (memEQ(posixcc, "xdigit", 6))
11512 namedclass = ANYOF_XDIGIT;
11516 if (namedclass == OOB_NAMEDCLASS)
11517 Simple_vFAIL3("POSIX class [:%.*s:] unknown",
11520 /* The #defines are structured so each complement is +1 to
11521 * the normal one */
11525 assert (posixcc[skip] == ':');
11526 assert (posixcc[skip+1] == ']');
11527 } else if (!SIZE_ONLY) {
11528 /* [[=foo=]] and [[.foo.]] are still future. */
11530 /* adjust RExC_parse so the warning shows after
11531 the class closes */
11532 while (UCHARAT(RExC_parse) && UCHARAT(RExC_parse) != ']')
11534 vFAIL3("POSIX syntax [%c %c] is reserved for future extensions", c, c);
11537 /* Maternal grandfather:
11538 * "[:" ending in ":" but not in ":]" */
11540 vFAIL("Unmatched '[' in POSIX class");
11543 /* Grandfather lone [:, [=, [. */
11553 S_could_it_be_a_POSIX_class(pTHX_ RExC_state_t *pRExC_state)
11555 /* This applies some heuristics at the current parse position (which should
11556 * be at a '[') to see if what follows might be intended to be a [:posix:]
11557 * class. It returns true if it really is a posix class, of course, but it
11558 * also can return true if it thinks that what was intended was a posix
11559 * class that didn't quite make it.
11561 * It will return true for
11563 * [:alphanumerics] (as long as the ] isn't followed immediately by a
11564 * ')' indicating the end of the (?[
11565 * [:any garbage including %^&$ punctuation:]
11567 * This is designed to be called only from S_handle_regex_sets; it could be
11568 * easily adapted to be called from the spot at the beginning of regclass()
11569 * that checks to see in a normal bracketed class if the surrounding []
11570 * have been omitted ([:word:] instead of [[:word:]]). But doing so would
11571 * change long-standing behavior, so I (khw) didn't do that */
11572 char* p = RExC_parse + 1;
11573 char first_char = *p;
11575 PERL_ARGS_ASSERT_COULD_IT_BE_A_POSIX_CLASS;
11577 assert(*(p - 1) == '[');
11579 if (! POSIXCC(first_char)) {
11584 while (p < RExC_end && isWORDCHAR(*p)) p++;
11586 if (p >= RExC_end) {
11590 if (p - RExC_parse > 2 /* Got at least 1 word character */
11591 && (*p == first_char
11592 || (*p == ']' && p + 1 < RExC_end && *(p + 1) != ')')))
11597 p = (char *) memchr(RExC_parse, ']', RExC_end - RExC_parse);
11600 && p - RExC_parse > 2 /* [:] evaluates to colon;
11601 [::] is a bad posix class. */
11602 && first_char == *(p - 1));
11606 S_handle_regex_sets(pTHX_ RExC_state_t *pRExC_state, SV** return_invlist, I32 *flagp, U32 depth,
11607 char * const oregcomp_parse)
11609 /* Handle the (?[...]) construct to do set operations */
11612 UV start, end; /* End points of code point ranges */
11614 char *save_end, *save_parse;
11619 const bool save_fold = FOLD;
11621 GET_RE_DEBUG_FLAGS_DECL;
11623 PERL_ARGS_ASSERT_HANDLE_REGEX_SETS;
11626 vFAIL("(?[...]) not valid in locale");
11628 RExC_uni_semantics = 1;
11630 /* This will return only an ANYOF regnode, or (unlikely) something smaller
11631 * (such as EXACT). Thus we can skip most everything if just sizing. We
11632 * call regclass to handle '[]' so as to not have to reinvent its parsing
11633 * rules here (throwing away the size it computes each time). And, we exit
11634 * upon an unescaped ']' that isn't one ending a regclass. To do both
11635 * these things, we need to realize that something preceded by a backslash
11636 * is escaped, so we have to keep track of backslashes */
11638 UV depth = 0; /* how many nested (?[...]) constructs */
11640 Perl_ck_warner_d(aTHX_
11641 packWARN(WARN_EXPERIMENTAL__REGEX_SETS),
11642 "The regex_sets feature is experimental" REPORT_LOCATION,
11643 (int) (RExC_parse - RExC_precomp) , RExC_precomp, RExC_parse);
11645 while (RExC_parse < RExC_end) {
11646 SV* current = NULL;
11647 RExC_parse = regpatws(pRExC_state, RExC_parse,
11648 TRUE); /* means recognize comments */
11649 switch (*RExC_parse) {
11651 if (RExC_parse[1] == '[') depth++, RExC_parse++;
11656 /* Skip the next byte (which could cause us to end up in
11657 * the middle of a UTF-8 character, but since none of those
11658 * are confusable with anything we currently handle in this
11659 * switch (invariants all), it's safe. We'll just hit the
11660 * default: case next time and keep on incrementing until
11661 * we find one of the invariants we do handle. */
11666 /* If this looks like it is a [:posix:] class, leave the
11667 * parse pointer at the '[' to fool regclass() into
11668 * thinking it is part of a '[[:posix:]]'. That function
11669 * will use strict checking to force a syntax error if it
11670 * doesn't work out to a legitimate class */
11671 bool is_posix_class
11672 = could_it_be_a_POSIX_class(pRExC_state);
11673 if (! is_posix_class) {
11677 /* regclass() can only return RESTART_UTF8 if multi-char
11678 folds are allowed. */
11679 if (!regclass(pRExC_state, flagp,depth+1,
11680 is_posix_class, /* parse the whole char
11681 class only if not a
11683 FALSE, /* don't allow multi-char folds */
11684 TRUE, /* silence non-portable warnings. */
11686 FAIL2("panic: regclass returned NULL to handle_sets, flags=%#"UVxf"",
11689 /* function call leaves parse pointing to the ']', except
11690 * if we faked it */
11691 if (is_posix_class) {
11695 SvREFCNT_dec(current); /* In case it returned something */
11700 if (depth--) break;
11702 if (RExC_parse < RExC_end
11703 && *RExC_parse == ')')
11705 node = reganode(pRExC_state, ANYOF, 0);
11706 RExC_size += ANYOF_SKIP;
11707 nextchar(pRExC_state);
11708 Set_Node_Length(node,
11709 RExC_parse - oregcomp_parse + 1); /* MJD */
11718 FAIL("Syntax error in (?[...])");
11721 /* Pass 2 only after this. Everything in this construct is a
11722 * metacharacter. Operands begin with either a '\' (for an escape
11723 * sequence), or a '[' for a bracketed character class. Any other
11724 * character should be an operator, or parenthesis for grouping. Both
11725 * types of operands are handled by calling regclass() to parse them. It
11726 * is called with a parameter to indicate to return the computed inversion
11727 * list. The parsing here is implemented via a stack. Each entry on the
11728 * stack is a single character representing one of the operators, or the
11729 * '('; or else a pointer to an operand inversion list. */
11731 #define IS_OPERAND(a) (! SvIOK(a))
11733 /* The stack starts empty. It is a syntax error if the first thing parsed
11734 * is a binary operator; everything else is pushed on the stack. When an
11735 * operand is parsed, the top of the stack is examined. If it is a binary
11736 * operator, the item before it should be an operand, and both are replaced
11737 * by the result of doing that operation on the new operand and the one on
11738 * the stack. Thus a sequence of binary operands is reduced to a single
11739 * one before the next one is parsed.
11741 * A unary operator may immediately follow a binary in the input, for
11744 * When an operand is parsed and the top of the stack is a unary operator,
11745 * the operation is performed, and then the stack is rechecked to see if
11746 * this new operand is part of a binary operation; if so, it is handled as
11749 * A '(' is simply pushed on the stack; it is valid only if the stack is
11750 * empty, or the top element of the stack is an operator or another '('
11751 * (for which the parenthesized expression will become an operand). By the
11752 * time the corresponding ')' is parsed everything in between should have
11753 * been parsed and evaluated to a single operand (or else is a syntax
11754 * error), and is handled as a regular operand */
11756 sv_2mortal((SV *)(stack = newAV()));
11758 while (RExC_parse < RExC_end) {
11759 I32 top_index = av_tindex(stack);
11761 SV* current = NULL;
11763 /* Skip white space */
11764 RExC_parse = regpatws(pRExC_state, RExC_parse,
11765 TRUE); /* means recognize comments */
11766 if (RExC_parse >= RExC_end) {
11767 Perl_croak(aTHX_ "panic: Read past end of '(?[ ])'");
11769 if ((curchar = UCHARAT(RExC_parse)) == ']') {
11776 if (av_tindex(stack) >= 0 /* This makes sure that we can
11777 safely subtract 1 from
11778 RExC_parse in the next clause.
11779 If we have something on the
11780 stack, we have parsed something
11782 && UCHARAT(RExC_parse - 1) == '('
11783 && RExC_parse < RExC_end)
11785 /* If is a '(?', could be an embedded '(?flags:(?[...])'.
11786 * This happens when we have some thing like
11788 * my $thai_or_lao = qr/(?[ \p{Thai} + \p{Lao} ])/;
11790 * qr/(?[ \p{Digit} & $thai_or_lao ])/;
11792 * Here we would be handling the interpolated
11793 * '$thai_or_lao'. We handle this by a recursive call to
11794 * ourselves which returns the inversion list the
11795 * interpolated expression evaluates to. We use the flags
11796 * from the interpolated pattern. */
11797 U32 save_flags = RExC_flags;
11798 const char * const save_parse = ++RExC_parse;
11800 parse_lparen_question_flags(pRExC_state);
11802 if (RExC_parse == save_parse /* Makes sure there was at
11803 least one flag (or this
11804 embedding wasn't compiled)
11806 || RExC_parse >= RExC_end - 4
11807 || UCHARAT(RExC_parse) != ':'
11808 || UCHARAT(++RExC_parse) != '('
11809 || UCHARAT(++RExC_parse) != '?'
11810 || UCHARAT(++RExC_parse) != '[')
11813 /* In combination with the above, this moves the
11814 * pointer to the point just after the first erroneous
11815 * character (or if there are no flags, to where they
11816 * should have been) */
11817 if (RExC_parse >= RExC_end - 4) {
11818 RExC_parse = RExC_end;
11820 else if (RExC_parse != save_parse) {
11821 RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
11823 vFAIL("Expecting '(?flags:(?[...'");
11826 (void) handle_regex_sets(pRExC_state, ¤t, flagp,
11827 depth+1, oregcomp_parse);
11829 /* Here, 'current' contains the embedded expression's
11830 * inversion list, and RExC_parse points to the trailing
11831 * ']'; the next character should be the ')' which will be
11832 * paired with the '(' that has been put on the stack, so
11833 * the whole embedded expression reduces to '(operand)' */
11836 RExC_flags = save_flags;
11837 goto handle_operand;
11842 RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
11843 vFAIL("Unexpected character");
11846 /* regclass() can only return RESTART_UTF8 if multi-char
11847 folds are allowed. */
11848 if (!regclass(pRExC_state, flagp,depth+1,
11849 TRUE, /* means parse just the next thing */
11850 FALSE, /* don't allow multi-char folds */
11851 FALSE, /* don't silence non-portable warnings. */
11853 FAIL2("panic: regclass returned NULL to handle_sets, flags=%#"UVxf"",
11855 /* regclass() will return with parsing just the \ sequence,
11856 * leaving the parse pointer at the next thing to parse */
11858 goto handle_operand;
11860 case '[': /* Is a bracketed character class */
11862 bool is_posix_class = could_it_be_a_POSIX_class(pRExC_state);
11864 if (! is_posix_class) {
11868 /* regclass() can only return RESTART_UTF8 if multi-char
11869 folds are allowed. */
11870 if(!regclass(pRExC_state, flagp,depth+1,
11871 is_posix_class, /* parse the whole char class
11872 only if not a posix class */
11873 FALSE, /* don't allow multi-char folds */
11874 FALSE, /* don't silence non-portable warnings. */
11876 FAIL2("panic: regclass returned NULL to handle_sets, flags=%#"UVxf"",
11878 /* function call leaves parse pointing to the ']', except if we
11880 if (is_posix_class) {
11884 goto handle_operand;
11893 || ( ! (top_ptr = av_fetch(stack, top_index, FALSE)))
11894 || ! IS_OPERAND(*top_ptr))
11897 vFAIL2("Unexpected binary operator '%c' with no preceding operand", curchar);
11899 av_push(stack, newSVuv(curchar));
11903 av_push(stack, newSVuv(curchar));
11907 if (top_index >= 0) {
11908 top_ptr = av_fetch(stack, top_index, FALSE);
11910 if (IS_OPERAND(*top_ptr)) {
11912 vFAIL("Unexpected '(' with no preceding operator");
11915 av_push(stack, newSVuv(curchar));
11922 || ! (current = av_pop(stack))
11923 || ! IS_OPERAND(current)
11924 || ! (lparen = av_pop(stack))
11925 || IS_OPERAND(lparen)
11926 || SvUV(lparen) != '(')
11928 SvREFCNT_dec(current);
11930 vFAIL("Unexpected ')'");
11933 SvREFCNT_dec_NN(lparen);
11940 /* Here, we have an operand to process, in 'current' */
11942 if (top_index < 0) { /* Just push if stack is empty */
11943 av_push(stack, current);
11946 SV* top = av_pop(stack);
11948 char current_operator;
11950 if (IS_OPERAND(top)) {
11951 SvREFCNT_dec_NN(top);
11952 SvREFCNT_dec_NN(current);
11953 vFAIL("Operand with no preceding operator");
11955 current_operator = (char) SvUV(top);
11956 switch (current_operator) {
11957 case '(': /* Push the '(' back on followed by the new
11959 av_push(stack, top);
11960 av_push(stack, current);
11961 SvREFCNT_inc(top); /* Counters the '_dec' done
11962 just after the 'break', so
11963 it doesn't get wrongly freed
11968 _invlist_invert(current);
11970 /* Unlike binary operators, the top of the stack,
11971 * now that this unary one has been popped off, may
11972 * legally be an operator, and we now have operand
11975 SvREFCNT_dec_NN(top);
11976 goto handle_operand;
11979 prev = av_pop(stack);
11980 _invlist_intersection(prev,
11983 av_push(stack, current);
11988 prev = av_pop(stack);
11989 _invlist_union(prev, current, ¤t);
11990 av_push(stack, current);
11994 prev = av_pop(stack);;
11995 _invlist_subtract(prev, current, ¤t);
11996 av_push(stack, current);
11999 case '^': /* The union minus the intersection */
12005 prev = av_pop(stack);
12006 _invlist_union(prev, current, &u);
12007 _invlist_intersection(prev, current, &i);
12008 /* _invlist_subtract will overwrite current
12009 without freeing what it already contains */
12011 _invlist_subtract(u, i, ¤t);
12012 av_push(stack, current);
12013 SvREFCNT_dec_NN(i);
12014 SvREFCNT_dec_NN(u);
12015 SvREFCNT_dec_NN(element);
12020 Perl_croak(aTHX_ "panic: Unexpected item on '(?[ ])' stack");
12022 SvREFCNT_dec_NN(top);
12023 SvREFCNT_dec(prev);
12027 RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
12030 if (av_tindex(stack) < 0 /* Was empty */
12031 || ((final = av_pop(stack)) == NULL)
12032 || ! IS_OPERAND(final)
12033 || av_tindex(stack) >= 0) /* More left on stack */
12035 vFAIL("Incomplete expression within '(?[ ])'");
12038 /* Here, 'final' is the resultant inversion list from evaluating the
12039 * expression. Return it if so requested */
12040 if (return_invlist) {
12041 *return_invlist = final;
12045 /* Otherwise generate a resultant node, based on 'final'. regclass() is
12046 * expecting a string of ranges and individual code points */
12047 invlist_iterinit(final);
12048 result_string = newSVpvs("");
12049 while (invlist_iternext(final, &start, &end)) {
12050 if (start == end) {
12051 Perl_sv_catpvf(aTHX_ result_string, "\\x{%"UVXf"}", start);
12054 Perl_sv_catpvf(aTHX_ result_string, "\\x{%"UVXf"}-\\x{%"UVXf"}",
12059 save_parse = RExC_parse;
12060 RExC_parse = SvPV(result_string, len);
12061 save_end = RExC_end;
12062 RExC_end = RExC_parse + len;
12064 /* We turn off folding around the call, as the class we have constructed
12065 * already has all folding taken into consideration, and we don't want
12066 * regclass() to add to that */
12067 RExC_flags &= ~RXf_PMf_FOLD;
12068 /* regclass() can only return RESTART_UTF8 if multi-char folds are allowed.
12070 node = regclass(pRExC_state, flagp,depth+1,
12071 FALSE, /* means parse the whole char class */
12072 FALSE, /* don't allow multi-char folds */
12073 TRUE, /* silence non-portable warnings. The above may very
12074 well have generated non-portable code points, but
12075 they're valid on this machine */
12078 FAIL2("panic: regclass returned NULL to handle_sets, flags=%#"UVxf,
12081 RExC_flags |= RXf_PMf_FOLD;
12083 RExC_parse = save_parse + 1;
12084 RExC_end = save_end;
12085 SvREFCNT_dec_NN(final);
12086 SvREFCNT_dec_NN(result_string);
12088 nextchar(pRExC_state);
12089 Set_Node_Length(node, RExC_parse - oregcomp_parse + 1); /* MJD */
12094 /* The names of properties whose definitions are not known at compile time are
12095 * stored in this SV, after a constant heading. So if the length has been
12096 * changed since initialization, then there is a run-time definition. */
12097 #define HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION (SvCUR(listsv) != initial_listsv_len)
12100 S_regclass(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth,
12101 const bool stop_at_1, /* Just parse the next thing, don't
12102 look for a full character class */
12103 bool allow_multi_folds,
12104 const bool silence_non_portable, /* Don't output warnings
12107 SV** ret_invlist) /* Return an inversion list, not a node */
12109 /* parse a bracketed class specification. Most of these will produce an
12110 * ANYOF node; but something like [a] will produce an EXACT node; [aA], an
12111 * EXACTFish node; [[:ascii:]], a POSIXA node; etc. It is more complex
12112 * under /i with multi-character folds: it will be rewritten following the
12113 * paradigm of this example, where the <multi-fold>s are characters which
12114 * fold to multiple character sequences:
12115 * /[abc\x{multi-fold1}def\x{multi-fold2}ghi]/i
12116 * gets effectively rewritten as:
12117 * /(?:\x{multi-fold1}|\x{multi-fold2}|[abcdefghi]/i
12118 * reg() gets called (recursively) on the rewritten version, and this
12119 * function will return what it constructs. (Actually the <multi-fold>s
12120 * aren't physically removed from the [abcdefghi], it's just that they are
12121 * ignored in the recursion by means of a flag:
12122 * <RExC_in_multi_char_class>.)
12124 * ANYOF nodes contain a bit map for the first 256 characters, with the
12125 * corresponding bit set if that character is in the list. For characters
12126 * above 255, a range list or swash is used. There are extra bits for \w,
12127 * etc. in locale ANYOFs, as what these match is not determinable at
12130 * Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan needs
12131 * to be restarted. This can only happen if ret_invlist is non-NULL.
12135 UV prevvalue = OOB_UNICODE, save_prevvalue = OOB_UNICODE;
12137 UV value = OOB_UNICODE, save_value = OOB_UNICODE;
12140 IV namedclass = OOB_NAMEDCLASS;
12141 char *rangebegin = NULL;
12142 bool need_class = 0;
12144 STRLEN initial_listsv_len = 0; /* Kind of a kludge to see if it is more
12145 than just initialized. */
12146 SV* properties = NULL; /* Code points that match \p{} \P{} */
12147 SV* posixes = NULL; /* Code points that match classes like, [:word:],
12148 extended beyond the Latin1 range */
12149 UV element_count = 0; /* Number of distinct elements in the class.
12150 Optimizations may be possible if this is tiny */
12151 AV * multi_char_matches = NULL; /* Code points that fold to more than one
12152 character; used under /i */
12154 char * stop_ptr = RExC_end; /* where to stop parsing */
12155 const bool skip_white = cBOOL(ret_invlist); /* ignore unescaped white
12157 const bool strict = cBOOL(ret_invlist); /* Apply strict parsing rules? */
12159 /* Unicode properties are stored in a swash; this holds the current one
12160 * being parsed. If this swash is the only above-latin1 component of the
12161 * character class, an optimization is to pass it directly on to the
12162 * execution engine. Otherwise, it is set to NULL to indicate that there
12163 * are other things in the class that have to be dealt with at execution
12165 SV* swash = NULL; /* Code points that match \p{} \P{} */
12167 /* Set if a component of this character class is user-defined; just passed
12168 * on to the engine */
12169 bool has_user_defined_property = FALSE;
12171 /* inversion list of code points this node matches only when the target
12172 * string is in UTF-8. (Because is under /d) */
12173 SV* depends_list = NULL;
12175 /* inversion list of code points this node matches. For much of the
12176 * function, it includes only those that match regardless of the utf8ness
12177 * of the target string */
12178 SV* cp_list = NULL;
12181 /* In a range, counts how many 0-2 of the ends of it came from literals,
12182 * not escapes. Thus we can tell if 'A' was input vs \x{C1} */
12183 UV literal_endpoint = 0;
12185 bool invert = FALSE; /* Is this class to be complemented */
12187 /* Is there any thing like \W or [:^digit:] that matches above the legal
12188 * Unicode range? */
12189 bool runtime_posix_matches_above_Unicode = FALSE;
12191 regnode * const orig_emit = RExC_emit; /* Save the original RExC_emit in
12192 case we need to change the emitted regop to an EXACT. */
12193 const char * orig_parse = RExC_parse;
12194 const I32 orig_size = RExC_size;
12195 GET_RE_DEBUG_FLAGS_DECL;
12197 PERL_ARGS_ASSERT_REGCLASS;
12199 PERL_UNUSED_ARG(depth);
12202 DEBUG_PARSE("clas");
12204 /* Assume we are going to generate an ANYOF node. */
12205 ret = reganode(pRExC_state, ANYOF, 0);
12208 RExC_size += ANYOF_SKIP;
12209 listsv = &PL_sv_undef; /* For code scanners: listsv always non-NULL. */
12212 ANYOF_FLAGS(ret) = 0;
12214 RExC_emit += ANYOF_SKIP;
12216 ANYOF_FLAGS(ret) |= ANYOF_LOCALE;
12218 listsv = newSVpvs_flags("# comment\n", SVs_TEMP);
12219 initial_listsv_len = SvCUR(listsv);
12220 SvTEMP_off(listsv); /* Grr, TEMPs and mortals are conflated. */
12224 RExC_parse = regpatws(pRExC_state, RExC_parse,
12225 FALSE /* means don't recognize comments */);
12228 if (UCHARAT(RExC_parse) == '^') { /* Complement of range. */
12231 allow_multi_folds = FALSE;
12234 RExC_parse = regpatws(pRExC_state, RExC_parse,
12235 FALSE /* means don't recognize comments */);
12239 /* Check that they didn't say [:posix:] instead of [[:posix:]] */
12240 if (!SIZE_ONLY && RExC_parse < RExC_end && POSIXCC(UCHARAT(RExC_parse))) {
12241 const char *s = RExC_parse;
12242 const char c = *s++;
12244 while (isWORDCHAR(*s))
12246 if (*s && c == *s && s[1] == ']') {
12247 SAVEFREESV(RExC_rx_sv);
12249 "POSIX syntax [%c %c] belongs inside character classes",
12251 (void)ReREFCNT_inc(RExC_rx_sv);
12255 /* If the caller wants us to just parse a single element, accomplish this
12256 * by faking the loop ending condition */
12257 if (stop_at_1 && RExC_end > RExC_parse) {
12258 stop_ptr = RExC_parse + 1;
12261 /* allow 1st char to be ']' (allowing it to be '-' is dealt with later) */
12262 if (UCHARAT(RExC_parse) == ']')
12263 goto charclassloop;
12267 if (RExC_parse >= stop_ptr) {
12272 RExC_parse = regpatws(pRExC_state, RExC_parse,
12273 FALSE /* means don't recognize comments */);
12276 if (UCHARAT(RExC_parse) == ']') {
12282 namedclass = OOB_NAMEDCLASS; /* initialize as illegal */
12283 save_value = value;
12284 save_prevvalue = prevvalue;
12287 rangebegin = RExC_parse;
12291 value = utf8n_to_uvchr((U8*)RExC_parse,
12292 RExC_end - RExC_parse,
12293 &numlen, UTF8_ALLOW_DEFAULT);
12294 RExC_parse += numlen;
12297 value = UCHARAT(RExC_parse++);
12300 && RExC_parse < RExC_end
12301 && POSIXCC(UCHARAT(RExC_parse)))
12303 namedclass = regpposixcc(pRExC_state, value, strict);
12305 else if (value == '\\') {
12307 value = utf8n_to_uvchr((U8*)RExC_parse,
12308 RExC_end - RExC_parse,
12309 &numlen, UTF8_ALLOW_DEFAULT);
12310 RExC_parse += numlen;
12313 value = UCHARAT(RExC_parse++);
12315 /* Some compilers cannot handle switching on 64-bit integer
12316 * values, therefore value cannot be an UV. Yes, this will
12317 * be a problem later if we want switch on Unicode.
12318 * A similar issue a little bit later when switching on
12319 * namedclass. --jhi */
12321 /* If the \ is escaping white space when white space is being
12322 * skipped, it means that that white space is wanted literally, and
12323 * is already in 'value'. Otherwise, need to translate the escape
12324 * into what it signifies. */
12325 if (! skip_white || ! is_PATWS_cp(value)) switch ((I32)value) {
12327 case 'w': namedclass = ANYOF_WORDCHAR; break;
12328 case 'W': namedclass = ANYOF_NWORDCHAR; break;
12329 case 's': namedclass = ANYOF_SPACE; break;
12330 case 'S': namedclass = ANYOF_NSPACE; break;
12331 case 'd': namedclass = ANYOF_DIGIT; break;
12332 case 'D': namedclass = ANYOF_NDIGIT; break;
12333 case 'v': namedclass = ANYOF_VERTWS; break;
12334 case 'V': namedclass = ANYOF_NVERTWS; break;
12335 case 'h': namedclass = ANYOF_HORIZWS; break;
12336 case 'H': namedclass = ANYOF_NHORIZWS; break;
12337 case 'N': /* Handle \N{NAME} in class */
12339 /* We only pay attention to the first char of
12340 multichar strings being returned. I kinda wonder
12341 if this makes sense as it does change the behaviour
12342 from earlier versions, OTOH that behaviour was broken
12344 if (! grok_bslash_N(pRExC_state, NULL, &value, flagp, depth,
12345 TRUE, /* => charclass */
12348 if (*flagp & RESTART_UTF8)
12349 FAIL("panic: grok_bslash_N set RESTART_UTF8");
12359 /* We will handle any undefined properties ourselves */
12360 U8 swash_init_flags = _CORE_SWASH_INIT_RETURN_IF_UNDEF;
12362 if (RExC_parse >= RExC_end)
12363 vFAIL2("Empty \\%c{}", (U8)value);
12364 if (*RExC_parse == '{') {
12365 const U8 c = (U8)value;
12366 e = strchr(RExC_parse++, '}');
12368 vFAIL2("Missing right brace on \\%c{}", c);
12369 while (isSPACE(UCHARAT(RExC_parse)))
12371 if (e == RExC_parse)
12372 vFAIL2("Empty \\%c{}", c);
12373 n = e - RExC_parse;
12374 while (isSPACE(UCHARAT(RExC_parse + n - 1)))
12385 if (UCHARAT(RExC_parse) == '^') {
12388 /* toggle. (The rhs xor gets the single bit that
12389 * differs between P and p; the other xor inverts just
12391 value ^= 'P' ^ 'p';
12393 while (isSPACE(UCHARAT(RExC_parse))) {
12398 /* Try to get the definition of the property into
12399 * <invlist>. If /i is in effect, the effective property
12400 * will have its name be <__NAME_i>. The design is
12401 * discussed in commit
12402 * 2f833f5208e26b208886e51e09e2c072b5eabb46 */
12403 Newx(name, n + sizeof("_i__\n"), char);
12405 sprintf(name, "%s%.*s%s\n",
12406 (FOLD) ? "__" : "",
12412 /* Look up the property name, and get its swash and
12413 * inversion list, if the property is found */
12415 SvREFCNT_dec_NN(swash);
12417 swash = _core_swash_init("utf8", name, &PL_sv_undef,
12420 NULL, /* No inversion list */
12423 if (! swash || ! (invlist = _get_swash_invlist(swash))) {
12425 SvREFCNT_dec_NN(swash);
12429 /* Here didn't find it. It could be a user-defined
12430 * property that will be available at run-time. If we
12431 * accept only compile-time properties, is an error;
12432 * otherwise add it to the list for run-time look up */
12434 RExC_parse = e + 1;
12435 vFAIL3("Property '%.*s' is unknown", (int) n, name);
12437 Perl_sv_catpvf(aTHX_ listsv, "%cutf8::%s\n",
12438 (value == 'p' ? '+' : '!'),
12440 has_user_defined_property = TRUE;
12442 /* We don't know yet, so have to assume that the
12443 * property could match something in the Latin1 range,
12444 * hence something that isn't utf8. Note that this
12445 * would cause things in <depends_list> to match
12446 * inappropriately, except that any \p{}, including
12447 * this one forces Unicode semantics, which means there
12448 * is <no depends_list> */
12449 ANYOF_FLAGS(ret) |= ANYOF_NONBITMAP_NON_UTF8;
12453 /* Here, did get the swash and its inversion list. If
12454 * the swash is from a user-defined property, then this
12455 * whole character class should be regarded as such */
12456 has_user_defined_property =
12458 & _CORE_SWASH_INIT_USER_DEFINED_PROPERTY);
12460 /* Invert if asking for the complement */
12461 if (value == 'P') {
12462 _invlist_union_complement_2nd(properties,
12466 /* The swash can't be used as-is, because we've
12467 * inverted things; delay removing it to here after
12468 * have copied its invlist above */
12469 SvREFCNT_dec_NN(swash);
12473 _invlist_union(properties, invlist, &properties);
12478 RExC_parse = e + 1;
12479 namedclass = ANYOF_UNIPROP; /* no official name, but it's
12482 /* \p means they want Unicode semantics */
12483 RExC_uni_semantics = 1;
12486 case 'n': value = '\n'; break;
12487 case 'r': value = '\r'; break;
12488 case 't': value = '\t'; break;
12489 case 'f': value = '\f'; break;
12490 case 'b': value = '\b'; break;
12491 case 'e': value = ASCII_TO_NATIVE('\033');break;
12492 case 'a': value = ASCII_TO_NATIVE('\007');break;
12494 RExC_parse--; /* function expects to be pointed at the 'o' */
12496 const char* error_msg;
12497 bool valid = grok_bslash_o(&RExC_parse,
12500 SIZE_ONLY, /* warnings in pass
12503 silence_non_portable,
12509 if (PL_encoding && value < 0x100) {
12510 goto recode_encoding;
12514 RExC_parse--; /* function expects to be pointed at the 'x' */
12516 const char* error_msg;
12517 bool valid = grok_bslash_x(&RExC_parse,
12520 TRUE, /* Output warnings */
12522 silence_non_portable,
12528 if (PL_encoding && value < 0x100)
12529 goto recode_encoding;
12532 value = grok_bslash_c(*RExC_parse++, UTF, SIZE_ONLY);
12534 case '0': case '1': case '2': case '3': case '4':
12535 case '5': case '6': case '7':
12537 /* Take 1-3 octal digits */
12538 I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
12539 numlen = (strict) ? 4 : 3;
12540 value = grok_oct(--RExC_parse, &numlen, &flags, NULL);
12541 RExC_parse += numlen;
12544 RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
12545 vFAIL("Need exactly 3 octal digits");
12547 else if (! SIZE_ONLY /* like \08, \178 */
12549 && RExC_parse < RExC_end
12550 && isDIGIT(*RExC_parse)
12551 && ckWARN(WARN_REGEXP))
12553 SAVEFREESV(RExC_rx_sv);
12554 reg_warn_non_literal_string(
12556 form_short_octal_warning(RExC_parse, numlen));
12557 (void)ReREFCNT_inc(RExC_rx_sv);
12560 if (PL_encoding && value < 0x100)
12561 goto recode_encoding;
12565 if (! RExC_override_recoding) {
12566 SV* enc = PL_encoding;
12567 value = reg_recode((const char)(U8)value, &enc);
12570 vFAIL("Invalid escape in the specified encoding");
12572 else if (SIZE_ONLY) {
12573 ckWARNreg(RExC_parse,
12574 "Invalid escape in the specified encoding");
12580 /* Allow \_ to not give an error */
12581 if (!SIZE_ONLY && isWORDCHAR(value) && value != '_') {
12583 vFAIL2("Unrecognized escape \\%c in character class",
12587 SAVEFREESV(RExC_rx_sv);
12588 ckWARN2reg(RExC_parse,
12589 "Unrecognized escape \\%c in character class passed through",
12591 (void)ReREFCNT_inc(RExC_rx_sv);
12595 } /* End of switch on char following backslash */
12596 } /* end of handling backslash escape sequences */
12599 literal_endpoint++;
12602 /* Here, we have the current token in 'value' */
12604 /* What matches in a locale is not known until runtime. This includes
12605 * what the Posix classes (like \w, [:space:]) match. Room must be
12606 * reserved (one time per class) to store such classes, either if Perl
12607 * is compiled so that locale nodes always should have this space, or
12608 * if there is such class info to be stored. The space will contain a
12609 * bit for each named class that is to be matched against. This isn't
12610 * needed for \p{} and pseudo-classes, as they are not affected by
12611 * locale, and hence are dealt with separately */
12614 && (ANYOF_LOCALE == ANYOF_CLASS
12615 || (namedclass > OOB_NAMEDCLASS && namedclass < ANYOF_MAX)))
12619 RExC_size += ANYOF_CLASS_SKIP - ANYOF_SKIP;
12622 RExC_emit += ANYOF_CLASS_SKIP - ANYOF_SKIP;
12623 ANYOF_CLASS_ZERO(ret);
12625 ANYOF_FLAGS(ret) |= ANYOF_CLASS;
12628 if (namedclass > OOB_NAMEDCLASS) { /* this is a named class \blah */
12630 /* a bad range like a-\d, a-[:digit:]. The '-' is taken as a
12631 * literal, as is the character that began the false range, i.e.
12632 * the 'a' in the examples */
12635 const int w = (RExC_parse >= rangebegin)
12636 ? RExC_parse - rangebegin
12639 vFAIL4("False [] range \"%*.*s\"", w, w, rangebegin);
12642 SAVEFREESV(RExC_rx_sv); /* in case of fatal warnings */
12643 ckWARN4reg(RExC_parse,
12644 "False [] range \"%*.*s\"",
12646 (void)ReREFCNT_inc(RExC_rx_sv);
12647 cp_list = add_cp_to_invlist(cp_list, '-');
12648 cp_list = add_cp_to_invlist(cp_list, prevvalue);
12652 range = 0; /* this was not a true range */
12653 element_count += 2; /* So counts for three values */
12657 U8 classnum = namedclass_to_classnum(namedclass);
12658 if (namedclass >= ANYOF_MAX) { /* If a special class */
12659 if (namedclass != ANYOF_UNIPROP) { /* UNIPROP = \p and \P */
12661 /* Here, should be \h, \H, \v, or \V. Neither /d nor
12662 * /l make a difference in what these match. There
12663 * would be problems if these characters had folds
12664 * other than themselves, as cp_list is subject to
12666 if (classnum != _CC_VERTSPACE) {
12667 assert( namedclass == ANYOF_HORIZWS
12668 || namedclass == ANYOF_NHORIZWS);
12670 /* It turns out that \h is just a synonym for
12672 classnum = _CC_BLANK;
12675 _invlist_union_maybe_complement_2nd(
12677 PL_XPosix_ptrs[classnum],
12678 cBOOL(namedclass % 2), /* Complement if odd
12679 (NHORIZWS, NVERTWS)
12684 else if (classnum == _CC_ASCII) {
12687 ANYOF_CLASS_SET(ret, namedclass);
12690 #endif /* Not isascii(); just use the hard-coded definition for it */
12691 _invlist_union_maybe_complement_2nd(
12694 cBOOL(namedclass % 2), /* Complement if odd
12698 else { /* Garden variety class */
12700 /* The ascii range inversion list */
12701 SV* ascii_source = PL_Posix_ptrs[classnum];
12703 /* The full Latin1 range inversion list */
12704 SV* l1_source = PL_L1Posix_ptrs[classnum];
12706 /* This code is structured into two major clauses. The
12707 * first is for classes whose complete definitions may not
12708 * already be known. It not, the Latin1 definition
12709 * (guaranteed to already known) is used plus code is
12710 * generated to load the rest at run-time (only if needed).
12711 * If the complete definition is known, it drops down to
12712 * the second clause, where the complete definition is
12715 if (classnum < _FIRST_NON_SWASH_CC) {
12717 /* Here, the class has a swash, which may or not
12718 * already be loaded */
12720 /* The name of the property to use to match the full
12721 * eXtended Unicode range swash for this character
12723 const char *Xname = swash_property_names[classnum];
12725 /* If returning the inversion list, we can't defer
12726 * getting this until runtime */
12727 if (ret_invlist && ! PL_utf8_swash_ptrs[classnum]) {
12728 PL_utf8_swash_ptrs[classnum] =
12729 _core_swash_init("utf8", Xname, &PL_sv_undef,
12732 NULL, /* No inversion list */
12733 NULL /* No flags */
12735 assert(PL_utf8_swash_ptrs[classnum]);
12737 if ( ! PL_utf8_swash_ptrs[classnum]) {
12738 if (namedclass % 2 == 0) { /* A non-complemented
12740 /* If not /a matching, there are code points we
12741 * don't know at compile time. Arrange for the
12742 * unknown matches to be loaded at run-time, if
12744 if (! AT_LEAST_ASCII_RESTRICTED) {
12745 Perl_sv_catpvf(aTHX_ listsv, "+utf8::%s\n",
12748 if (LOC) { /* Under locale, set run-time
12750 ANYOF_CLASS_SET(ret, namedclass);
12753 /* Add the current class's code points to
12754 * the running total */
12755 _invlist_union(posixes,
12756 (AT_LEAST_ASCII_RESTRICTED)
12762 else { /* A complemented class */
12763 if (AT_LEAST_ASCII_RESTRICTED) {
12764 /* Under /a should match everything above
12765 * ASCII, plus the complement of the set's
12767 _invlist_union_complement_2nd(posixes,
12772 /* Arrange for the unknown matches to be
12773 * loaded at run-time, if needed */
12774 Perl_sv_catpvf(aTHX_ listsv, "!utf8::%s\n",
12776 runtime_posix_matches_above_Unicode = TRUE;
12778 ANYOF_CLASS_SET(ret, namedclass);
12782 /* We want to match everything in
12783 * Latin1, except those things that
12784 * l1_source matches */
12785 SV* scratch_list = NULL;
12786 _invlist_subtract(PL_Latin1, l1_source,
12789 /* Add the list from this class to the
12792 posixes = scratch_list;
12795 _invlist_union(posixes,
12798 SvREFCNT_dec_NN(scratch_list);
12800 if (DEPENDS_SEMANTICS) {
12802 |= ANYOF_NON_UTF8_LATIN1_ALL;
12807 goto namedclass_done;
12810 /* Here, there is a swash loaded for the class. If no
12811 * inversion list for it yet, get it */
12812 if (! PL_XPosix_ptrs[classnum]) {
12813 PL_XPosix_ptrs[classnum]
12814 = _swash_to_invlist(PL_utf8_swash_ptrs[classnum]);
12818 /* Here there is an inversion list already loaded for the
12821 if (namedclass % 2 == 0) { /* A non-complemented class,
12822 like ANYOF_PUNCT */
12824 /* For non-locale, just add it to any existing list
12826 _invlist_union(posixes,
12827 (AT_LEAST_ASCII_RESTRICTED)
12829 : PL_XPosix_ptrs[classnum],
12832 else { /* Locale */
12833 SV* scratch_list = NULL;
12835 /* For above Latin1 code points, we use the full
12837 _invlist_intersection(PL_AboveLatin1,
12838 PL_XPosix_ptrs[classnum],
12840 /* And set the output to it, adding instead if
12841 * there already is an output. Checking if
12842 * 'posixes' is NULL first saves an extra clone.
12843 * Its reference count will be decremented at the
12844 * next union, etc, or if this is the only
12845 * instance, at the end of the routine */
12847 posixes = scratch_list;
12850 _invlist_union(posixes, scratch_list, &posixes);
12851 SvREFCNT_dec_NN(scratch_list);
12854 #ifndef HAS_ISBLANK
12855 if (namedclass != ANYOF_BLANK) {
12857 /* Set this class in the node for runtime
12859 ANYOF_CLASS_SET(ret, namedclass);
12860 #ifndef HAS_ISBLANK
12863 /* No isblank(), use the hard-coded ASCII-range
12864 * blanks, adding them to the running total. */
12866 _invlist_union(posixes, ascii_source, &posixes);
12871 else { /* A complemented class, like ANYOF_NPUNCT */
12873 _invlist_union_complement_2nd(
12875 (AT_LEAST_ASCII_RESTRICTED)
12877 : PL_XPosix_ptrs[classnum],
12879 /* Under /d, everything in the upper half of the
12880 * Latin1 range matches this complement */
12881 if (DEPENDS_SEMANTICS) {
12882 ANYOF_FLAGS(ret) |= ANYOF_NON_UTF8_LATIN1_ALL;
12885 else { /* Locale */
12886 SV* scratch_list = NULL;
12887 _invlist_subtract(PL_AboveLatin1,
12888 PL_XPosix_ptrs[classnum],
12891 posixes = scratch_list;
12894 _invlist_union(posixes, scratch_list, &posixes);
12895 SvREFCNT_dec_NN(scratch_list);
12897 #ifndef HAS_ISBLANK
12898 if (namedclass != ANYOF_NBLANK) {
12900 ANYOF_CLASS_SET(ret, namedclass);
12901 #ifndef HAS_ISBLANK
12904 /* Get the list of all code points in Latin1
12905 * that are not ASCII blanks, and add them to
12906 * the running total */
12907 _invlist_subtract(PL_Latin1, ascii_source,
12909 _invlist_union(posixes, scratch_list, &posixes);
12910 SvREFCNT_dec_NN(scratch_list);
12917 continue; /* Go get next character */
12919 } /* end of namedclass \blah */
12921 /* Here, we have a single value. If 'range' is set, it is the ending
12922 * of a range--check its validity. Later, we will handle each
12923 * individual code point in the range. If 'range' isn't set, this
12924 * could be the beginning of a range, so check for that by looking
12925 * ahead to see if the next real character to be processed is the range
12926 * indicator--the minus sign */
12929 RExC_parse = regpatws(pRExC_state, RExC_parse,
12930 FALSE /* means don't recognize comments */);
12934 if (prevvalue > value) /* b-a */ {
12935 const int w = RExC_parse - rangebegin;
12936 Simple_vFAIL4("Invalid [] range \"%*.*s\"", w, w, rangebegin);
12937 range = 0; /* not a valid range */
12941 prevvalue = value; /* save the beginning of the potential range */
12942 if (! stop_at_1 /* Can't be a range if parsing just one thing */
12943 && *RExC_parse == '-')
12945 char* next_char_ptr = RExC_parse + 1;
12946 if (skip_white) { /* Get the next real char after the '-' */
12947 next_char_ptr = regpatws(pRExC_state,
12949 FALSE); /* means don't recognize
12953 /* If the '-' is at the end of the class (just before the ']',
12954 * it is a literal minus; otherwise it is a range */
12955 if (next_char_ptr < RExC_end && *next_char_ptr != ']') {
12956 RExC_parse = next_char_ptr;
12958 /* a bad range like \w-, [:word:]- ? */
12959 if (namedclass > OOB_NAMEDCLASS) {
12960 if (strict || ckWARN(WARN_REGEXP)) {
12962 RExC_parse >= rangebegin ?
12963 RExC_parse - rangebegin : 0;
12965 vFAIL4("False [] range \"%*.*s\"",
12970 "False [] range \"%*.*s\"",
12975 cp_list = add_cp_to_invlist(cp_list, '-');
12979 range = 1; /* yeah, it's a range! */
12980 continue; /* but do it the next time */
12985 /* Here, <prevvalue> is the beginning of the range, if any; or <value>
12988 /* non-Latin1 code point implies unicode semantics. Must be set in
12989 * pass1 so is there for the whole of pass 2 */
12991 RExC_uni_semantics = 1;
12994 /* Ready to process either the single value, or the completed range.
12995 * For single-valued non-inverted ranges, we consider the possibility
12996 * of multi-char folds. (We made a conscious decision to not do this
12997 * for the other cases because it can often lead to non-intuitive
12998 * results. For example, you have the peculiar case that:
12999 * "s s" =~ /^[^\xDF]+$/i => Y
13000 * "ss" =~ /^[^\xDF]+$/i => N
13002 * See [perl #89750] */
13003 if (FOLD && allow_multi_folds && value == prevvalue) {
13004 if (value == LATIN_SMALL_LETTER_SHARP_S
13005 || (value > 255 && _invlist_contains_cp(PL_HasMultiCharFold,
13008 /* Here <value> is indeed a multi-char fold. Get what it is */
13010 U8 foldbuf[UTF8_MAXBYTES_CASE];
13013 UV folded = _to_uni_fold_flags(
13018 | ((LOC) ? FOLD_FLAGS_LOCALE
13019 : (ASCII_FOLD_RESTRICTED)
13020 ? FOLD_FLAGS_NOMIX_ASCII
13024 /* Here, <folded> should be the first character of the
13025 * multi-char fold of <value>, with <foldbuf> containing the
13026 * whole thing. But, if this fold is not allowed (because of
13027 * the flags), <fold> will be the same as <value>, and should
13028 * be processed like any other character, so skip the special
13030 if (folded != value) {
13032 /* Skip if we are recursed, currently parsing the class
13033 * again. Otherwise add this character to the list of
13034 * multi-char folds. */
13035 if (! RExC_in_multi_char_class) {
13036 AV** this_array_ptr;
13038 STRLEN cp_count = utf8_length(foldbuf,
13039 foldbuf + foldlen);
13040 SV* multi_fold = sv_2mortal(newSVpvn("", 0));
13042 Perl_sv_catpvf(aTHX_ multi_fold, "\\x{%"UVXf"}", value);
13045 if (! multi_char_matches) {
13046 multi_char_matches = newAV();
13049 /* <multi_char_matches> is actually an array of arrays.
13050 * There will be one or two top-level elements: [2],
13051 * and/or [3]. The [2] element is an array, each
13052 * element thereof is a character which folds to TWO
13053 * characters; [3] is for folds to THREE characters.
13054 * (Unicode guarantees a maximum of 3 characters in any
13055 * fold.) When we rewrite the character class below,
13056 * we will do so such that the longest folds are
13057 * written first, so that it prefers the longest
13058 * matching strings first. This is done even if it
13059 * turns out that any quantifier is non-greedy, out of
13060 * programmer laziness. Tom Christiansen has agreed
13061 * that this is ok. This makes the test for the
13062 * ligature 'ffi' come before the test for 'ff' */
13063 if (av_exists(multi_char_matches, cp_count)) {
13064 this_array_ptr = (AV**) av_fetch(multi_char_matches,
13066 this_array = *this_array_ptr;
13069 this_array = newAV();
13070 av_store(multi_char_matches, cp_count,
13073 av_push(this_array, multi_fold);
13076 /* This element should not be processed further in this
13079 value = save_value;
13080 prevvalue = save_prevvalue;
13086 /* Deal with this element of the class */
13089 cp_list = _add_range_to_invlist(cp_list, prevvalue, value);
13091 SV* this_range = _new_invlist(1);
13092 _append_range_to_invlist(this_range, prevvalue, value);
13094 /* In EBCDIC, the ranges 'A-Z' and 'a-z' are each not contiguous.
13095 * If this range was specified using something like 'i-j', we want
13096 * to include only the 'i' and the 'j', and not anything in
13097 * between, so exclude non-ASCII, non-alphabetics from it.
13098 * However, if the range was specified with something like
13099 * [\x89-\x91] or [\x89-j], all code points within it should be
13100 * included. literal_endpoint==2 means both ends of the range used
13101 * a literal character, not \x{foo} */
13102 if (literal_endpoint == 2
13103 && (prevvalue >= 'a' && value <= 'z')
13104 || (prevvalue >= 'A' && value <= 'Z'))
13106 _invlist_intersection(this_range, PL_Posix_ptrs[_CC_ALPHA],
13109 _invlist_union(cp_list, this_range, &cp_list);
13110 literal_endpoint = 0;
13114 range = 0; /* this range (if it was one) is done now */
13115 } /* End of loop through all the text within the brackets */
13117 /* If anything in the class expands to more than one character, we have to
13118 * deal with them by building up a substitute parse string, and recursively
13119 * calling reg() on it, instead of proceeding */
13120 if (multi_char_matches) {
13121 SV * substitute_parse = newSVpvn_flags("?:", 2, SVs_TEMP);
13124 char *save_end = RExC_end;
13125 char *save_parse = RExC_parse;
13126 bool first_time = TRUE; /* First multi-char occurrence doesn't get
13131 #if 0 /* Have decided not to deal with multi-char folds in inverted classes,
13132 because too confusing */
13134 sv_catpv(substitute_parse, "(?:");
13138 /* Look at the longest folds first */
13139 for (cp_count = av_len(multi_char_matches); cp_count > 0; cp_count--) {
13141 if (av_exists(multi_char_matches, cp_count)) {
13142 AV** this_array_ptr;
13145 this_array_ptr = (AV**) av_fetch(multi_char_matches,
13147 while ((this_sequence = av_pop(*this_array_ptr)) !=
13150 if (! first_time) {
13151 sv_catpv(substitute_parse, "|");
13153 first_time = FALSE;
13155 sv_catpv(substitute_parse, SvPVX(this_sequence));
13160 /* If the character class contains anything else besides these
13161 * multi-character folds, have to include it in recursive parsing */
13162 if (element_count) {
13163 sv_catpv(substitute_parse, "|[");
13164 sv_catpvn(substitute_parse, orig_parse, RExC_parse - orig_parse);
13165 sv_catpv(substitute_parse, "]");
13168 sv_catpv(substitute_parse, ")");
13171 /* This is a way to get the parse to skip forward a whole named
13172 * sequence instead of matching the 2nd character when it fails the
13174 sv_catpv(substitute_parse, "(*THEN)(*SKIP)(*FAIL)|.)");
13178 RExC_parse = SvPV(substitute_parse, len);
13179 RExC_end = RExC_parse + len;
13180 RExC_in_multi_char_class = 1;
13181 RExC_emit = (regnode *)orig_emit;
13183 ret = reg(pRExC_state, 1, ®_flags, depth+1);
13185 *flagp |= reg_flags&(HASWIDTH|SIMPLE|SPSTART|POSTPONED|RESTART_UTF8);
13187 RExC_parse = save_parse;
13188 RExC_end = save_end;
13189 RExC_in_multi_char_class = 0;
13190 SvREFCNT_dec_NN(multi_char_matches);
13194 /* If the character class contains only a single element, it may be
13195 * optimizable into another node type which is smaller and runs faster.
13196 * Check if this is the case for this class */
13197 if (element_count == 1 && ! ret_invlist) {
13201 if (namedclass > OOB_NAMEDCLASS) { /* this is a named class, like \w or
13202 [:digit:] or \p{foo} */
13204 /* All named classes are mapped into POSIXish nodes, with its FLAG
13205 * argument giving which class it is */
13206 switch ((I32)namedclass) {
13207 case ANYOF_UNIPROP:
13210 /* These don't depend on the charset modifiers. They always
13211 * match under /u rules */
13212 case ANYOF_NHORIZWS:
13213 case ANYOF_HORIZWS:
13214 namedclass = ANYOF_BLANK + namedclass - ANYOF_HORIZWS;
13217 case ANYOF_NVERTWS:
13222 /* The actual POSIXish node for all the rest depends on the
13223 * charset modifier. The ones in the first set depend only on
13224 * ASCII or, if available on this platform, locale */
13228 op = (LOC) ? POSIXL : POSIXA;
13239 /* under /a could be alpha */
13241 if (ASCII_RESTRICTED) {
13242 namedclass = ANYOF_ALPHA + (namedclass % 2);
13250 /* The rest have more possibilities depending on the charset.
13251 * We take advantage of the enum ordering of the charset
13252 * modifiers to get the exact node type, */
13254 op = POSIXD + get_regex_charset(RExC_flags);
13255 if (op > POSIXA) { /* /aa is same as /a */
13258 #ifndef HAS_ISBLANK
13260 && (namedclass == ANYOF_BLANK
13261 || namedclass == ANYOF_NBLANK))
13268 /* The odd numbered ones are the complements of the
13269 * next-lower even number one */
13270 if (namedclass % 2 == 1) {
13274 arg = namedclass_to_classnum(namedclass);
13278 else if (value == prevvalue) {
13280 /* Here, the class consists of just a single code point */
13283 if (! LOC && value == '\n') {
13284 op = REG_ANY; /* Optimize [^\n] */
13285 *flagp |= HASWIDTH|SIMPLE;
13289 else if (value < 256 || UTF) {
13291 /* Optimize a single value into an EXACTish node, but not if it
13292 * would require converting the pattern to UTF-8. */
13293 op = compute_EXACTish(pRExC_state);
13295 } /* Otherwise is a range */
13296 else if (! LOC) { /* locale could vary these */
13297 if (prevvalue == '0') {
13298 if (value == '9') {
13305 /* Here, we have changed <op> away from its initial value iff we found
13306 * an optimization */
13309 /* Throw away this ANYOF regnode, and emit the calculated one,
13310 * which should correspond to the beginning, not current, state of
13312 const char * cur_parse = RExC_parse;
13313 RExC_parse = (char *)orig_parse;
13317 /* To get locale nodes to not use the full ANYOF size would
13318 * require moving the code above that writes the portions
13319 * of it that aren't in other nodes to after this point.
13320 * e.g. ANYOF_CLASS_SET */
13321 RExC_size = orig_size;
13325 RExC_emit = (regnode *)orig_emit;
13326 if (PL_regkind[op] == POSIXD) {
13328 op += NPOSIXD - POSIXD;
13333 ret = reg_node(pRExC_state, op);
13335 if (PL_regkind[op] == POSIXD || PL_regkind[op] == NPOSIXD) {
13339 *flagp |= HASWIDTH|SIMPLE;
13341 else if (PL_regkind[op] == EXACT) {
13342 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, 0, value);
13345 RExC_parse = (char *) cur_parse;
13347 SvREFCNT_dec(posixes);
13348 SvREFCNT_dec(cp_list);
13355 /****** !SIZE_ONLY (Pass 2) AFTER HERE *********/
13357 /* If folding, we calculate all characters that could fold to or from the
13358 * ones already on the list */
13359 if (FOLD && cp_list) {
13360 UV start, end; /* End points of code point ranges */
13362 SV* fold_intersection = NULL;
13364 /* If the highest code point is within Latin1, we can use the
13365 * compiled-in Alphas list, and not have to go out to disk. This
13366 * yields two false positives, the masculine and feminine ordinal
13367 * indicators, which are weeded out below using the
13368 * IS_IN_SOME_FOLD_L1() macro */
13369 if (invlist_highest(cp_list) < 256) {
13370 _invlist_intersection(PL_L1Posix_ptrs[_CC_ALPHA], cp_list,
13371 &fold_intersection);
13375 /* Here, there are non-Latin1 code points, so we will have to go
13376 * fetch the list of all the characters that participate in folds
13378 if (! PL_utf8_foldable) {
13379 SV* swash = swash_init("utf8", "_Perl_Any_Folds",
13380 &PL_sv_undef, 1, 0);
13381 PL_utf8_foldable = _get_swash_invlist(swash);
13382 SvREFCNT_dec_NN(swash);
13385 /* This is a hash that for a particular fold gives all characters
13386 * that are involved in it */
13387 if (! PL_utf8_foldclosures) {
13389 /* If we were unable to find any folds, then we likely won't be
13390 * able to find the closures. So just create an empty list.
13391 * Folding will effectively be restricted to the non-Unicode
13392 * rules hard-coded into Perl. (This case happens legitimately
13393 * during compilation of Perl itself before the Unicode tables
13394 * are generated) */
13395 if (_invlist_len(PL_utf8_foldable) == 0) {
13396 PL_utf8_foldclosures = newHV();
13399 /* If the folds haven't been read in, call a fold function
13401 if (! PL_utf8_tofold) {
13402 U8 dummy[UTF8_MAXBYTES+1];
13404 /* This string is just a short named one above \xff */
13405 to_utf8_fold((U8*) HYPHEN_UTF8, dummy, NULL);
13406 assert(PL_utf8_tofold); /* Verify that worked */
13408 PL_utf8_foldclosures =
13409 _swash_inversion_hash(PL_utf8_tofold);
13413 /* Only the characters in this class that participate in folds need
13414 * be checked. Get the intersection of this class and all the
13415 * possible characters that are foldable. This can quickly narrow
13416 * down a large class */
13417 _invlist_intersection(PL_utf8_foldable, cp_list,
13418 &fold_intersection);
13421 /* Now look at the foldable characters in this class individually */
13422 invlist_iterinit(fold_intersection);
13423 while (invlist_iternext(fold_intersection, &start, &end)) {
13426 /* Locale folding for Latin1 characters is deferred until runtime */
13427 if (LOC && start < 256) {
13431 /* Look at every character in the range */
13432 for (j = start; j <= end; j++) {
13434 U8 foldbuf[UTF8_MAXBYTES_CASE+1];
13440 /* We have the latin1 folding rules hard-coded here so that
13441 * an innocent-looking character class, like /[ks]/i won't
13442 * have to go out to disk to find the possible matches.
13443 * XXX It would be better to generate these via regen, in
13444 * case a new version of the Unicode standard adds new
13445 * mappings, though that is not really likely, and may be
13446 * caught by the default: case of the switch below. */
13448 if (IS_IN_SOME_FOLD_L1(j)) {
13450 /* ASCII is always matched; non-ASCII is matched only
13451 * under Unicode rules */
13452 if (isASCII(j) || AT_LEAST_UNI_SEMANTICS) {
13454 add_cp_to_invlist(cp_list, PL_fold_latin1[j]);
13458 add_cp_to_invlist(depends_list, PL_fold_latin1[j]);
13462 if (HAS_NONLATIN1_FOLD_CLOSURE(j)
13463 && (! isASCII(j) || ! ASCII_FOLD_RESTRICTED))
13465 /* Certain Latin1 characters have matches outside
13466 * Latin1. To get here, <j> is one of those
13467 * characters. None of these matches is valid for
13468 * ASCII characters under /aa, which is why the 'if'
13469 * just above excludes those. These matches only
13470 * happen when the target string is utf8. The code
13471 * below adds the single fold closures for <j> to the
13472 * inversion list. */
13477 add_cp_to_invlist(cp_list, KELVIN_SIGN);
13481 cp_list = add_cp_to_invlist(cp_list,
13482 LATIN_SMALL_LETTER_LONG_S);
13485 cp_list = add_cp_to_invlist(cp_list,
13486 GREEK_CAPITAL_LETTER_MU);
13487 cp_list = add_cp_to_invlist(cp_list,
13488 GREEK_SMALL_LETTER_MU);
13490 case LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE:
13491 case LATIN_SMALL_LETTER_A_WITH_RING_ABOVE:
13493 add_cp_to_invlist(cp_list, ANGSTROM_SIGN);
13495 case LATIN_SMALL_LETTER_Y_WITH_DIAERESIS:
13496 cp_list = add_cp_to_invlist(cp_list,
13497 LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS);
13499 case LATIN_SMALL_LETTER_SHARP_S:
13500 cp_list = add_cp_to_invlist(cp_list,
13501 LATIN_CAPITAL_LETTER_SHARP_S);
13503 case 'F': case 'f':
13504 case 'I': case 'i':
13505 case 'L': case 'l':
13506 case 'T': case 't':
13507 case 'A': case 'a':
13508 case 'H': case 'h':
13509 case 'J': case 'j':
13510 case 'N': case 'n':
13511 case 'W': case 'w':
13512 case 'Y': case 'y':
13513 /* These all are targets of multi-character
13514 * folds from code points that require UTF8 to
13515 * express, so they can't match unless the
13516 * target string is in UTF-8, so no action here
13517 * is necessary, as regexec.c properly handles
13518 * the general case for UTF-8 matching and
13519 * multi-char folds */
13522 /* Use deprecated warning to increase the
13523 * chances of this being output */
13524 ckWARN2reg_d(RExC_parse, "Perl folding rules are not up-to-date for 0x%"UVXf"; please use the perlbug utility to report;", j);
13531 /* Here is an above Latin1 character. We don't have the rules
13532 * hard-coded for it. First, get its fold. This is the simple
13533 * fold, as the multi-character folds have been handled earlier
13534 * and separated out */
13535 _to_uni_fold_flags(j, foldbuf, &foldlen,
13537 ? FOLD_FLAGS_LOCALE
13538 : (ASCII_FOLD_RESTRICTED)
13539 ? FOLD_FLAGS_NOMIX_ASCII
13542 /* Single character fold of above Latin1. Add everything in
13543 * its fold closure to the list that this node should match.
13544 * The fold closures data structure is a hash with the keys
13545 * being the UTF-8 of every character that is folded to, like
13546 * 'k', and the values each an array of all code points that
13547 * fold to its key. e.g. [ 'k', 'K', KELVIN_SIGN ].
13548 * Multi-character folds are not included */
13549 if ((listp = hv_fetch(PL_utf8_foldclosures,
13550 (char *) foldbuf, foldlen, FALSE)))
13552 AV* list = (AV*) *listp;
13554 for (k = 0; k <= av_len(list); k++) {
13555 SV** c_p = av_fetch(list, k, FALSE);
13558 Perl_croak(aTHX_ "panic: invalid PL_utf8_foldclosures structure");
13562 /* /aa doesn't allow folds between ASCII and non-; /l
13563 * doesn't allow them between above and below 256 */
13564 if ((ASCII_FOLD_RESTRICTED
13565 && (isASCII(c) != isASCII(j)))
13566 || (LOC && c < 256)) {
13570 /* Folds involving non-ascii Latin1 characters
13571 * under /d are added to a separate list */
13572 if (isASCII(c) || c > 255 || AT_LEAST_UNI_SEMANTICS)
13574 cp_list = add_cp_to_invlist(cp_list, c);
13577 depends_list = add_cp_to_invlist(depends_list, c);
13583 SvREFCNT_dec_NN(fold_intersection);
13586 /* And combine the result (if any) with any inversion list from posix
13587 * classes. The lists are kept separate up to now because we don't want to
13588 * fold the classes (folding of those is automatically handled by the swash
13589 * fetching code) */
13591 if (! DEPENDS_SEMANTICS) {
13593 _invlist_union(cp_list, posixes, &cp_list);
13594 SvREFCNT_dec_NN(posixes);
13601 /* Under /d, we put into a separate list the Latin1 things that
13602 * match only when the target string is utf8 */
13603 SV* nonascii_but_latin1_properties = NULL;
13604 _invlist_intersection(posixes, PL_Latin1,
13605 &nonascii_but_latin1_properties);
13606 _invlist_subtract(nonascii_but_latin1_properties, PL_ASCII,
13607 &nonascii_but_latin1_properties);
13608 _invlist_subtract(posixes, nonascii_but_latin1_properties,
13611 _invlist_union(cp_list, posixes, &cp_list);
13612 SvREFCNT_dec_NN(posixes);
13618 if (depends_list) {
13619 _invlist_union(depends_list, nonascii_but_latin1_properties,
13621 SvREFCNT_dec_NN(nonascii_but_latin1_properties);
13624 depends_list = nonascii_but_latin1_properties;
13629 /* And combine the result (if any) with any inversion list from properties.
13630 * The lists are kept separate up to now so that we can distinguish the two
13631 * in regards to matching above-Unicode. A run-time warning is generated
13632 * if a Unicode property is matched against a non-Unicode code point. But,
13633 * we allow user-defined properties to match anything, without any warning,
13634 * and we also suppress the warning if there is a portion of the character
13635 * class that isn't a Unicode property, and which matches above Unicode, \W
13636 * or [\x{110000}] for example.
13637 * (Note that in this case, unlike the Posix one above, there is no
13638 * <depends_list>, because having a Unicode property forces Unicode
13641 bool warn_super = ! has_user_defined_property;
13644 /* If it matters to the final outcome, see if a non-property
13645 * component of the class matches above Unicode. If so, the
13646 * warning gets suppressed. This is true even if just a single
13647 * such code point is specified, as though not strictly correct if
13648 * another such code point is matched against, the fact that they
13649 * are using above-Unicode code points indicates they should know
13650 * the issues involved */
13652 bool non_prop_matches_above_Unicode =
13653 runtime_posix_matches_above_Unicode
13654 | (invlist_highest(cp_list) > PERL_UNICODE_MAX);
13656 non_prop_matches_above_Unicode =
13657 ! non_prop_matches_above_Unicode;
13659 warn_super = ! non_prop_matches_above_Unicode;
13662 _invlist_union(properties, cp_list, &cp_list);
13663 SvREFCNT_dec_NN(properties);
13666 cp_list = properties;
13670 OP(ret) = ANYOF_WARN_SUPER;
13674 /* Here, we have calculated what code points should be in the character
13677 * Now we can see about various optimizations. Fold calculation (which we
13678 * did above) needs to take place before inversion. Otherwise /[^k]/i
13679 * would invert to include K, which under /i would match k, which it
13680 * shouldn't. Therefore we can't invert folded locale now, as it won't be
13681 * folded until runtime */
13683 /* Optimize inverted simple patterns (e.g. [^a-z]) when everything is known
13684 * at compile time. Besides not inverting folded locale now, we can't
13685 * invert if there are things such as \w, which aren't known until runtime
13688 && ! (LOC && (FOLD || (ANYOF_FLAGS(ret) & ANYOF_CLASS)))
13690 && ! HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
13692 _invlist_invert(cp_list);
13694 /* Any swash can't be used as-is, because we've inverted things */
13696 SvREFCNT_dec_NN(swash);
13700 /* Clear the invert flag since have just done it here */
13705 *ret_invlist = cp_list;
13706 SvREFCNT_dec(swash);
13708 /* Discard the generated node */
13710 RExC_size = orig_size;
13713 RExC_emit = orig_emit;
13718 /* If we didn't do folding, it's because some information isn't available
13719 * until runtime; set the run-time fold flag for these. (We don't have to
13720 * worry about properties folding, as that is taken care of by the swash
13724 ANYOF_FLAGS(ret) |= ANYOF_LOC_FOLD;
13727 /* Some character classes are equivalent to other nodes. Such nodes take
13728 * up less room and generally fewer operations to execute than ANYOF nodes.
13729 * Above, we checked for and optimized into some such equivalents for
13730 * certain common classes that are easy to test. Getting to this point in
13731 * the code means that the class didn't get optimized there. Since this
13732 * code is only executed in Pass 2, it is too late to save space--it has
13733 * been allocated in Pass 1, and currently isn't given back. But turning
13734 * things into an EXACTish node can allow the optimizer to join it to any
13735 * adjacent such nodes. And if the class is equivalent to things like /./,
13736 * expensive run-time swashes can be avoided. Now that we have more
13737 * complete information, we can find things necessarily missed by the
13738 * earlier code. I (khw) am not sure how much to look for here. It would
13739 * be easy, but perhaps too slow, to check any candidates against all the
13740 * node types they could possibly match using _invlistEQ(). */
13745 && ! (ANYOF_FLAGS(ret) & ANYOF_CLASS)
13746 && ! HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
13749 U8 op = END; /* The optimzation node-type */
13750 const char * cur_parse= RExC_parse;
13752 invlist_iterinit(cp_list);
13753 if (! invlist_iternext(cp_list, &start, &end)) {
13755 /* Here, the list is empty. This happens, for example, when a
13756 * Unicode property is the only thing in the character class, and
13757 * it doesn't match anything. (perluniprops.pod notes such
13760 *flagp |= HASWIDTH|SIMPLE;
13762 else if (start == end) { /* The range is a single code point */
13763 if (! invlist_iternext(cp_list, &start, &end)
13765 /* Don't do this optimization if it would require changing
13766 * the pattern to UTF-8 */
13767 && (start < 256 || UTF))
13769 /* Here, the list contains a single code point. Can optimize
13770 * into an EXACT node */
13779 /* A locale node under folding with one code point can be
13780 * an EXACTFL, as its fold won't be calculated until
13786 /* Here, we are generally folding, but there is only one
13787 * code point to match. If we have to, we use an EXACT
13788 * node, but it would be better for joining with adjacent
13789 * nodes in the optimization pass if we used the same
13790 * EXACTFish node that any such are likely to be. We can
13791 * do this iff the code point doesn't participate in any
13792 * folds. For example, an EXACTF of a colon is the same as
13793 * an EXACT one, since nothing folds to or from a colon. */
13795 if (IS_IN_SOME_FOLD_L1(value)) {
13800 if (! PL_utf8_foldable) {
13801 SV* swash = swash_init("utf8", "_Perl_Any_Folds",
13802 &PL_sv_undef, 1, 0);
13803 PL_utf8_foldable = _get_swash_invlist(swash);
13804 SvREFCNT_dec_NN(swash);
13806 if (_invlist_contains_cp(PL_utf8_foldable, value)) {
13811 /* If we haven't found the node type, above, it means we
13812 * can use the prevailing one */
13814 op = compute_EXACTish(pRExC_state);
13819 else if (start == 0) {
13820 if (end == UV_MAX) {
13822 *flagp |= HASWIDTH|SIMPLE;
13825 else if (end == '\n' - 1
13826 && invlist_iternext(cp_list, &start, &end)
13827 && start == '\n' + 1 && end == UV_MAX)
13830 *flagp |= HASWIDTH|SIMPLE;
13834 invlist_iterfinish(cp_list);
13837 RExC_parse = (char *)orig_parse;
13838 RExC_emit = (regnode *)orig_emit;
13840 ret = reg_node(pRExC_state, op);
13842 RExC_parse = (char *)cur_parse;
13844 if (PL_regkind[op] == EXACT) {
13845 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, 0, value);
13848 SvREFCNT_dec_NN(cp_list);
13853 /* Here, <cp_list> contains all the code points we can determine at
13854 * compile time that match under all conditions. Go through it, and
13855 * for things that belong in the bitmap, put them there, and delete from
13856 * <cp_list>. While we are at it, see if everything above 255 is in the
13857 * list, and if so, set a flag to speed up execution */
13858 ANYOF_BITMAP_ZERO(ret);
13861 /* This gets set if we actually need to modify things */
13862 bool change_invlist = FALSE;
13866 /* Start looking through <cp_list> */
13867 invlist_iterinit(cp_list);
13868 while (invlist_iternext(cp_list, &start, &end)) {
13872 if (end == UV_MAX && start <= 256) {
13873 ANYOF_FLAGS(ret) |= ANYOF_UNICODE_ALL;
13876 /* Quit if are above what we should change */
13881 change_invlist = TRUE;
13883 /* Set all the bits in the range, up to the max that we are doing */
13884 high = (end < 255) ? end : 255;
13885 for (i = start; i <= (int) high; i++) {
13886 if (! ANYOF_BITMAP_TEST(ret, i)) {
13887 ANYOF_BITMAP_SET(ret, i);
13891 invlist_iterfinish(cp_list);
13893 /* Done with loop; remove any code points that are in the bitmap from
13895 if (change_invlist) {
13896 _invlist_subtract(cp_list, PL_Latin1, &cp_list);
13899 /* If have completely emptied it, remove it completely */
13900 if (_invlist_len(cp_list) == 0) {
13901 SvREFCNT_dec_NN(cp_list);
13907 ANYOF_FLAGS(ret) |= ANYOF_INVERT;
13910 /* Here, the bitmap has been populated with all the Latin1 code points that
13911 * always match. Can now add to the overall list those that match only
13912 * when the target string is UTF-8 (<depends_list>). */
13913 if (depends_list) {
13915 _invlist_union(cp_list, depends_list, &cp_list);
13916 SvREFCNT_dec_NN(depends_list);
13919 cp_list = depends_list;
13923 /* If there is a swash and more than one element, we can't use the swash in
13924 * the optimization below. */
13925 if (swash && element_count > 1) {
13926 SvREFCNT_dec_NN(swash);
13931 && ! HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
13933 ARG_SET(ret, ANYOF_NONBITMAP_EMPTY);
13936 /* av[0] stores the character class description in its textual form:
13937 * used later (regexec.c:Perl_regclass_swash()) to initialize the
13938 * appropriate swash, and is also useful for dumping the regnode.
13939 * av[1] if NULL, is a placeholder to later contain the swash computed
13940 * from av[0]. But if no further computation need be done, the
13941 * swash is stored there now.
13942 * av[2] stores the cp_list inversion list for use in addition or
13943 * instead of av[0]; used only if av[1] is NULL
13944 * av[3] is set if any component of the class is from a user-defined
13945 * property; used only if av[1] is NULL */
13946 AV * const av = newAV();
13949 av_store(av, 0, (HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
13950 ? SvREFCNT_inc(listsv) : &PL_sv_undef);
13952 av_store(av, 1, swash);
13953 SvREFCNT_dec_NN(cp_list);
13956 av_store(av, 1, NULL);
13958 av_store(av, 2, cp_list);
13959 av_store(av, 3, newSVuv(has_user_defined_property));
13963 rv = newRV_noinc(MUTABLE_SV(av));
13964 n = add_data(pRExC_state, 1, "s");
13965 RExC_rxi->data->data[n] = (void*)rv;
13969 *flagp |= HASWIDTH|SIMPLE;
13972 #undef HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION
13975 /* reg_skipcomment()
13977 Absorbs an /x style # comments from the input stream.
13978 Returns true if there is more text remaining in the stream.
13979 Will set the REG_SEEN_RUN_ON_COMMENT flag if the comment
13980 terminates the pattern without including a newline.
13982 Note its the callers responsibility to ensure that we are
13983 actually in /x mode
13988 S_reg_skipcomment(pTHX_ RExC_state_t *pRExC_state)
13992 PERL_ARGS_ASSERT_REG_SKIPCOMMENT;
13994 while (RExC_parse < RExC_end)
13995 if (*RExC_parse++ == '\n') {
14000 /* we ran off the end of the pattern without ending
14001 the comment, so we have to add an \n when wrapping */
14002 RExC_seen |= REG_SEEN_RUN_ON_COMMENT;
14010 Advances the parse position, and optionally absorbs
14011 "whitespace" from the inputstream.
14013 Without /x "whitespace" means (?#...) style comments only,
14014 with /x this means (?#...) and # comments and whitespace proper.
14016 Returns the RExC_parse point from BEFORE the scan occurs.
14018 This is the /x friendly way of saying RExC_parse++.
14022 S_nextchar(pTHX_ RExC_state_t *pRExC_state)
14024 char* const retval = RExC_parse++;
14026 PERL_ARGS_ASSERT_NEXTCHAR;
14029 if (RExC_end - RExC_parse >= 3
14030 && *RExC_parse == '('
14031 && RExC_parse[1] == '?'
14032 && RExC_parse[2] == '#')
14034 while (*RExC_parse != ')') {
14035 if (RExC_parse == RExC_end)
14036 FAIL("Sequence (?#... not terminated");
14042 if (RExC_flags & RXf_PMf_EXTENDED) {
14043 if (isSPACE(*RExC_parse)) {
14047 else if (*RExC_parse == '#') {
14048 if ( reg_skipcomment( pRExC_state ) )
14057 - reg_node - emit a node
14059 STATIC regnode * /* Location. */
14060 S_reg_node(pTHX_ RExC_state_t *pRExC_state, U8 op)
14064 regnode * const ret = RExC_emit;
14065 GET_RE_DEBUG_FLAGS_DECL;
14067 PERL_ARGS_ASSERT_REG_NODE;
14070 SIZE_ALIGN(RExC_size);
14074 if (RExC_emit >= RExC_emit_bound)
14075 Perl_croak(aTHX_ "panic: reg_node overrun trying to emit %d, %p>=%p",
14076 op, RExC_emit, RExC_emit_bound);
14078 NODE_ALIGN_FILL(ret);
14080 FILL_ADVANCE_NODE(ptr, op);
14081 #ifdef RE_TRACK_PATTERN_OFFSETS
14082 if (RExC_offsets) { /* MJD */
14083 MJD_OFFSET_DEBUG(("%s:%d: (op %s) %s %"UVuf" (len %"UVuf") (max %"UVuf").\n",
14084 "reg_node", __LINE__,
14086 (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0]
14087 ? "Overwriting end of array!\n" : "OK",
14088 (UV)(RExC_emit - RExC_emit_start),
14089 (UV)(RExC_parse - RExC_start),
14090 (UV)RExC_offsets[0]));
14091 Set_Node_Offset(RExC_emit, RExC_parse + (op == END));
14099 - reganode - emit a node with an argument
14101 STATIC regnode * /* Location. */
14102 S_reganode(pTHX_ RExC_state_t *pRExC_state, U8 op, U32 arg)
14106 regnode * const ret = RExC_emit;
14107 GET_RE_DEBUG_FLAGS_DECL;
14109 PERL_ARGS_ASSERT_REGANODE;
14112 SIZE_ALIGN(RExC_size);
14117 assert(2==regarglen[op]+1);
14119 Anything larger than this has to allocate the extra amount.
14120 If we changed this to be:
14122 RExC_size += (1 + regarglen[op]);
14124 then it wouldn't matter. Its not clear what side effect
14125 might come from that so its not done so far.
14130 if (RExC_emit >= RExC_emit_bound)
14131 Perl_croak(aTHX_ "panic: reg_node overrun trying to emit %d, %p>=%p",
14132 op, RExC_emit, RExC_emit_bound);
14134 NODE_ALIGN_FILL(ret);
14136 FILL_ADVANCE_NODE_ARG(ptr, op, arg);
14137 #ifdef RE_TRACK_PATTERN_OFFSETS
14138 if (RExC_offsets) { /* MJD */
14139 MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s %"UVuf" <- %"UVuf" (max %"UVuf").\n",
14143 (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0] ?
14144 "Overwriting end of array!\n" : "OK",
14145 (UV)(RExC_emit - RExC_emit_start),
14146 (UV)(RExC_parse - RExC_start),
14147 (UV)RExC_offsets[0]));
14148 Set_Cur_Node_Offset;
14156 - reguni - emit (if appropriate) a Unicode character
14159 S_reguni(pTHX_ const RExC_state_t *pRExC_state, UV uv, char* s)
14163 PERL_ARGS_ASSERT_REGUNI;
14165 return SIZE_ONLY ? UNISKIP(uv) : (uvchr_to_utf8((U8*)s, uv) - (U8*)s);
14169 - reginsert - insert an operator in front of already-emitted operand
14171 * Means relocating the operand.
14174 S_reginsert(pTHX_ RExC_state_t *pRExC_state, U8 op, regnode *opnd, U32 depth)
14180 const int offset = regarglen[(U8)op];
14181 const int size = NODE_STEP_REGNODE + offset;
14182 GET_RE_DEBUG_FLAGS_DECL;
14184 PERL_ARGS_ASSERT_REGINSERT;
14185 PERL_UNUSED_ARG(depth);
14186 /* (PL_regkind[(U8)op] == CURLY ? EXTRA_STEP_2ARGS : 0); */
14187 DEBUG_PARSE_FMT("inst"," - %s",PL_reg_name[op]);
14196 if (RExC_open_parens) {
14198 /*DEBUG_PARSE_FMT("inst"," - %"IVdf, (IV)RExC_npar);*/
14199 for ( paren=0 ; paren < RExC_npar ; paren++ ) {
14200 if ( RExC_open_parens[paren] >= opnd ) {
14201 /*DEBUG_PARSE_FMT("open"," - %d",size);*/
14202 RExC_open_parens[paren] += size;
14204 /*DEBUG_PARSE_FMT("open"," - %s","ok");*/
14206 if ( RExC_close_parens[paren] >= opnd ) {
14207 /*DEBUG_PARSE_FMT("close"," - %d",size);*/
14208 RExC_close_parens[paren] += size;
14210 /*DEBUG_PARSE_FMT("close"," - %s","ok");*/
14215 while (src > opnd) {
14216 StructCopy(--src, --dst, regnode);
14217 #ifdef RE_TRACK_PATTERN_OFFSETS
14218 if (RExC_offsets) { /* MJD 20010112 */
14219 MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s copy %"UVuf" -> %"UVuf" (max %"UVuf").\n",
14223 (UV)(dst - RExC_emit_start) > RExC_offsets[0]
14224 ? "Overwriting end of array!\n" : "OK",
14225 (UV)(src - RExC_emit_start),
14226 (UV)(dst - RExC_emit_start),
14227 (UV)RExC_offsets[0]));
14228 Set_Node_Offset_To_R(dst-RExC_emit_start, Node_Offset(src));
14229 Set_Node_Length_To_R(dst-RExC_emit_start, Node_Length(src));
14235 place = opnd; /* Op node, where operand used to be. */
14236 #ifdef RE_TRACK_PATTERN_OFFSETS
14237 if (RExC_offsets) { /* MJD */
14238 MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s %"UVuf" <- %"UVuf" (max %"UVuf").\n",
14242 (UV)(place - RExC_emit_start) > RExC_offsets[0]
14243 ? "Overwriting end of array!\n" : "OK",
14244 (UV)(place - RExC_emit_start),
14245 (UV)(RExC_parse - RExC_start),
14246 (UV)RExC_offsets[0]));
14247 Set_Node_Offset(place, RExC_parse);
14248 Set_Node_Length(place, 1);
14251 src = NEXTOPER(place);
14252 FILL_ADVANCE_NODE(place, op);
14253 Zero(src, offset, regnode);
14257 - regtail - set the next-pointer at the end of a node chain of p to val.
14258 - SEE ALSO: regtail_study
14260 /* TODO: All three parms should be const */
14262 S_regtail(pTHX_ RExC_state_t *pRExC_state, regnode *p, const regnode *val,U32 depth)
14266 GET_RE_DEBUG_FLAGS_DECL;
14268 PERL_ARGS_ASSERT_REGTAIL;
14270 PERL_UNUSED_ARG(depth);
14276 /* Find last node. */
14279 regnode * const temp = regnext(scan);
14281 SV * const mysv=sv_newmortal();
14282 DEBUG_PARSE_MSG((scan==p ? "tail" : ""));
14283 regprop(RExC_rx, mysv, scan);
14284 PerlIO_printf(Perl_debug_log, "~ %s (%d) %s %s\n",
14285 SvPV_nolen_const(mysv), REG_NODE_NUM(scan),
14286 (temp == NULL ? "->" : ""),
14287 (temp == NULL ? PL_reg_name[OP(val)] : "")
14295 if (reg_off_by_arg[OP(scan)]) {
14296 ARG_SET(scan, val - scan);
14299 NEXT_OFF(scan) = val - scan;
14305 - regtail_study - set the next-pointer at the end of a node chain of p to val.
14306 - Look for optimizable sequences at the same time.
14307 - currently only looks for EXACT chains.
14309 This is experimental code. The idea is to use this routine to perform
14310 in place optimizations on branches and groups as they are constructed,
14311 with the long term intention of removing optimization from study_chunk so
14312 that it is purely analytical.
14314 Currently only used when in DEBUG mode. The macro REGTAIL_STUDY() is used
14315 to control which is which.
14318 /* TODO: All four parms should be const */
14321 S_regtail_study(pTHX_ RExC_state_t *pRExC_state, regnode *p, const regnode *val,U32 depth)
14326 #ifdef EXPERIMENTAL_INPLACESCAN
14329 GET_RE_DEBUG_FLAGS_DECL;
14331 PERL_ARGS_ASSERT_REGTAIL_STUDY;
14337 /* Find last node. */
14341 regnode * const temp = regnext(scan);
14342 #ifdef EXPERIMENTAL_INPLACESCAN
14343 if (PL_regkind[OP(scan)] == EXACT) {
14344 bool has_exactf_sharp_s; /* Unexamined in this routine */
14345 if (join_exact(pRExC_state,scan,&min, &has_exactf_sharp_s, 1,val,depth+1))
14350 switch (OP(scan)) {
14356 case EXACTFU_TRICKYFOLD:
14358 if( exact == PSEUDO )
14360 else if ( exact != OP(scan) )
14369 SV * const mysv=sv_newmortal();
14370 DEBUG_PARSE_MSG((scan==p ? "tsdy" : ""));
14371 regprop(RExC_rx, mysv, scan);
14372 PerlIO_printf(Perl_debug_log, "~ %s (%d) -> %s\n",
14373 SvPV_nolen_const(mysv),
14374 REG_NODE_NUM(scan),
14375 PL_reg_name[exact]);
14382 SV * const mysv_val=sv_newmortal();
14383 DEBUG_PARSE_MSG("");
14384 regprop(RExC_rx, mysv_val, val);
14385 PerlIO_printf(Perl_debug_log, "~ attach to %s (%"IVdf") offset to %"IVdf"\n",
14386 SvPV_nolen_const(mysv_val),
14387 (IV)REG_NODE_NUM(val),
14391 if (reg_off_by_arg[OP(scan)]) {
14392 ARG_SET(scan, val - scan);
14395 NEXT_OFF(scan) = val - scan;
14403 - regdump - dump a regexp onto Perl_debug_log in vaguely comprehensible form
14408 S_regdump_intflags(pTHX_ const char *lead, const U32 flags)
14413 for (bit=0; bit<32; bit++) {
14414 if (flags & (1<<bit)) {
14415 if (!set++ && lead)
14416 PerlIO_printf(Perl_debug_log, "%s",lead);
14417 PerlIO_printf(Perl_debug_log, "%s ",PL_reg_intflags_name[bit]);
14422 PerlIO_printf(Perl_debug_log, "\n");
14424 PerlIO_printf(Perl_debug_log, "%s[none-set]\n",lead);
14429 S_regdump_extflags(pTHX_ const char *lead, const U32 flags)
14435 for (bit=0; bit<32; bit++) {
14436 if (flags & (1<<bit)) {
14437 if ((1<<bit) & RXf_PMf_CHARSET) { /* Output separately, below */
14440 if (!set++ && lead)
14441 PerlIO_printf(Perl_debug_log, "%s",lead);
14442 PerlIO_printf(Perl_debug_log, "%s ",PL_reg_extflags_name[bit]);
14445 if ((cs = get_regex_charset(flags)) != REGEX_DEPENDS_CHARSET) {
14446 if (!set++ && lead) {
14447 PerlIO_printf(Perl_debug_log, "%s",lead);
14450 case REGEX_UNICODE_CHARSET:
14451 PerlIO_printf(Perl_debug_log, "UNICODE");
14453 case REGEX_LOCALE_CHARSET:
14454 PerlIO_printf(Perl_debug_log, "LOCALE");
14456 case REGEX_ASCII_RESTRICTED_CHARSET:
14457 PerlIO_printf(Perl_debug_log, "ASCII-RESTRICTED");
14459 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
14460 PerlIO_printf(Perl_debug_log, "ASCII-MORE_RESTRICTED");
14463 PerlIO_printf(Perl_debug_log, "UNKNOWN CHARACTER SET");
14469 PerlIO_printf(Perl_debug_log, "\n");
14471 PerlIO_printf(Perl_debug_log, "%s[none-set]\n",lead);
14477 Perl_regdump(pTHX_ const regexp *r)
14481 SV * const sv = sv_newmortal();
14482 SV *dsv= sv_newmortal();
14483 RXi_GET_DECL(r,ri);
14484 GET_RE_DEBUG_FLAGS_DECL;
14486 PERL_ARGS_ASSERT_REGDUMP;
14488 (void)dumpuntil(r, ri->program, ri->program + 1, NULL, NULL, sv, 0, 0);
14490 /* Header fields of interest. */
14491 if (r->anchored_substr) {
14492 RE_PV_QUOTED_DECL(s, 0, dsv, SvPVX_const(r->anchored_substr),
14493 RE_SV_DUMPLEN(r->anchored_substr), 30);
14494 PerlIO_printf(Perl_debug_log,
14495 "anchored %s%s at %"IVdf" ",
14496 s, RE_SV_TAIL(r->anchored_substr),
14497 (IV)r->anchored_offset);
14498 } else if (r->anchored_utf8) {
14499 RE_PV_QUOTED_DECL(s, 1, dsv, SvPVX_const(r->anchored_utf8),
14500 RE_SV_DUMPLEN(r->anchored_utf8), 30);
14501 PerlIO_printf(Perl_debug_log,
14502 "anchored utf8 %s%s at %"IVdf" ",
14503 s, RE_SV_TAIL(r->anchored_utf8),
14504 (IV)r->anchored_offset);
14506 if (r->float_substr) {
14507 RE_PV_QUOTED_DECL(s, 0, dsv, SvPVX_const(r->float_substr),
14508 RE_SV_DUMPLEN(r->float_substr), 30);
14509 PerlIO_printf(Perl_debug_log,
14510 "floating %s%s at %"IVdf"..%"UVuf" ",
14511 s, RE_SV_TAIL(r->float_substr),
14512 (IV)r->float_min_offset, (UV)r->float_max_offset);
14513 } else if (r->float_utf8) {
14514 RE_PV_QUOTED_DECL(s, 1, dsv, SvPVX_const(r->float_utf8),
14515 RE_SV_DUMPLEN(r->float_utf8), 30);
14516 PerlIO_printf(Perl_debug_log,
14517 "floating utf8 %s%s at %"IVdf"..%"UVuf" ",
14518 s, RE_SV_TAIL(r->float_utf8),
14519 (IV)r->float_min_offset, (UV)r->float_max_offset);
14521 if (r->check_substr || r->check_utf8)
14522 PerlIO_printf(Perl_debug_log,
14524 (r->check_substr == r->float_substr
14525 && r->check_utf8 == r->float_utf8
14526 ? "(checking floating" : "(checking anchored"));
14527 if (r->extflags & RXf_NOSCAN)
14528 PerlIO_printf(Perl_debug_log, " noscan");
14529 if (r->extflags & RXf_CHECK_ALL)
14530 PerlIO_printf(Perl_debug_log, " isall");
14531 if (r->check_substr || r->check_utf8)
14532 PerlIO_printf(Perl_debug_log, ") ");
14534 if (ri->regstclass) {
14535 regprop(r, sv, ri->regstclass);
14536 PerlIO_printf(Perl_debug_log, "stclass %s ", SvPVX_const(sv));
14538 if (r->extflags & RXf_ANCH) {
14539 PerlIO_printf(Perl_debug_log, "anchored");
14540 if (r->extflags & RXf_ANCH_BOL)
14541 PerlIO_printf(Perl_debug_log, "(BOL)");
14542 if (r->extflags & RXf_ANCH_MBOL)
14543 PerlIO_printf(Perl_debug_log, "(MBOL)");
14544 if (r->extflags & RXf_ANCH_SBOL)
14545 PerlIO_printf(Perl_debug_log, "(SBOL)");
14546 if (r->extflags & RXf_ANCH_GPOS)
14547 PerlIO_printf(Perl_debug_log, "(GPOS)");
14548 PerlIO_putc(Perl_debug_log, ' ');
14550 if (r->extflags & RXf_GPOS_SEEN)
14551 PerlIO_printf(Perl_debug_log, "GPOS:%"UVuf" ", (UV)r->gofs);
14552 if (r->intflags & PREGf_SKIP)
14553 PerlIO_printf(Perl_debug_log, "plus ");
14554 if (r->intflags & PREGf_IMPLICIT)
14555 PerlIO_printf(Perl_debug_log, "implicit ");
14556 PerlIO_printf(Perl_debug_log, "minlen %"IVdf" ", (IV)r->minlen);
14557 if (r->extflags & RXf_EVAL_SEEN)
14558 PerlIO_printf(Perl_debug_log, "with eval ");
14559 PerlIO_printf(Perl_debug_log, "\n");
14561 regdump_extflags("r->extflags: ",r->extflags);
14562 regdump_intflags("r->intflags: ",r->intflags);
14565 PERL_ARGS_ASSERT_REGDUMP;
14566 PERL_UNUSED_CONTEXT;
14567 PERL_UNUSED_ARG(r);
14568 #endif /* DEBUGGING */
14572 - regprop - printable representation of opcode
14574 #define EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags) \
14577 Perl_sv_catpvf(aTHX_ sv,"%s][%s",PL_colors[1],PL_colors[0]); \
14578 if (flags & ANYOF_INVERT) \
14579 /*make sure the invert info is in each */ \
14580 sv_catpvs(sv, "^"); \
14586 Perl_regprop(pTHX_ const regexp *prog, SV *sv, const regnode *o)
14592 /* Should be synchronized with * ANYOF_ #xdefines in regcomp.h */
14593 static const char * const anyofs[] = {
14594 #if _CC_WORDCHAR != 0 || _CC_DIGIT != 1 || _CC_ALPHA != 2 || _CC_LOWER != 3 \
14595 || _CC_UPPER != 4 || _CC_PUNCT != 5 || _CC_PRINT != 6 \
14596 || _CC_ALPHANUMERIC != 7 || _CC_GRAPH != 8 || _CC_CASED != 9 \
14597 || _CC_SPACE != 10 || _CC_BLANK != 11 || _CC_XDIGIT != 12 \
14598 || _CC_PSXSPC != 13 || _CC_CNTRL != 14 || _CC_ASCII != 15 \
14599 || _CC_VERTSPACE != 16
14600 #error Need to adjust order of anyofs[]
14637 RXi_GET_DECL(prog,progi);
14638 GET_RE_DEBUG_FLAGS_DECL;
14640 PERL_ARGS_ASSERT_REGPROP;
14644 if (OP(o) > REGNODE_MAX) /* regnode.type is unsigned */
14645 /* It would be nice to FAIL() here, but this may be called from
14646 regexec.c, and it would be hard to supply pRExC_state. */
14647 Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d", (int)OP(o), (int)REGNODE_MAX);
14648 sv_catpv(sv, PL_reg_name[OP(o)]); /* Take off const! */
14650 k = PL_regkind[OP(o)];
14653 sv_catpvs(sv, " ");
14654 /* Using is_utf8_string() (via PERL_PV_UNI_DETECT)
14655 * is a crude hack but it may be the best for now since
14656 * we have no flag "this EXACTish node was UTF-8"
14658 pv_pretty(sv, STRING(o), STR_LEN(o), 60, PL_colors[0], PL_colors[1],
14659 PERL_PV_ESCAPE_UNI_DETECT |
14660 PERL_PV_ESCAPE_NONASCII |
14661 PERL_PV_PRETTY_ELLIPSES |
14662 PERL_PV_PRETTY_LTGT |
14663 PERL_PV_PRETTY_NOCLEAR
14665 } else if (k == TRIE) {
14666 /* print the details of the trie in dumpuntil instead, as
14667 * progi->data isn't available here */
14668 const char op = OP(o);
14669 const U32 n = ARG(o);
14670 const reg_ac_data * const ac = IS_TRIE_AC(op) ?
14671 (reg_ac_data *)progi->data->data[n] :
14673 const reg_trie_data * const trie
14674 = (reg_trie_data*)progi->data->data[!IS_TRIE_AC(op) ? n : ac->trie];
14676 Perl_sv_catpvf(aTHX_ sv, "-%s",PL_reg_name[o->flags]);
14677 DEBUG_TRIE_COMPILE_r(
14678 Perl_sv_catpvf(aTHX_ sv,
14679 "<S:%"UVuf"/%"IVdf" W:%"UVuf" L:%"UVuf"/%"UVuf" C:%"UVuf"/%"UVuf">",
14680 (UV)trie->startstate,
14681 (IV)trie->statecount-1, /* -1 because of the unused 0 element */
14682 (UV)trie->wordcount,
14685 (UV)TRIE_CHARCOUNT(trie),
14686 (UV)trie->uniquecharcount
14689 if ( IS_ANYOF_TRIE(op) || trie->bitmap ) {
14691 int rangestart = -1;
14692 U8* bitmap = IS_ANYOF_TRIE(op) ? (U8*)ANYOF_BITMAP(o) : (U8*)TRIE_BITMAP(trie);
14693 sv_catpvs(sv, "[");
14694 for (i = 0; i <= 256; i++) {
14695 if (i < 256 && BITMAP_TEST(bitmap,i)) {
14696 if (rangestart == -1)
14698 } else if (rangestart != -1) {
14699 if (i <= rangestart + 3)
14700 for (; rangestart < i; rangestart++)
14701 put_byte(sv, rangestart);
14703 put_byte(sv, rangestart);
14704 sv_catpvs(sv, "-");
14705 put_byte(sv, i - 1);
14710 sv_catpvs(sv, "]");
14713 } else if (k == CURLY) {
14714 if (OP(o) == CURLYM || OP(o) == CURLYN || OP(o) == CURLYX)
14715 Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags); /* Parenth number */
14716 Perl_sv_catpvf(aTHX_ sv, " {%d,%d}", ARG1(o), ARG2(o));
14718 else if (k == WHILEM && o->flags) /* Ordinal/of */
14719 Perl_sv_catpvf(aTHX_ sv, "[%d/%d]", o->flags & 0xf, o->flags>>4);
14720 else if (k == REF || k == OPEN || k == CLOSE || k == GROUPP || OP(o)==ACCEPT) {
14721 Perl_sv_catpvf(aTHX_ sv, "%d", (int)ARG(o)); /* Parenth number */
14722 if ( RXp_PAREN_NAMES(prog) ) {
14723 if ( k != REF || (OP(o) < NREF)) {
14724 AV *list= MUTABLE_AV(progi->data->data[progi->name_list_idx]);
14725 SV **name= av_fetch(list, ARG(o), 0 );
14727 Perl_sv_catpvf(aTHX_ sv, " '%"SVf"'", SVfARG(*name));
14730 AV *list= MUTABLE_AV(progi->data->data[ progi->name_list_idx ]);
14731 SV *sv_dat= MUTABLE_SV(progi->data->data[ ARG( o ) ]);
14732 I32 *nums=(I32*)SvPVX(sv_dat);
14733 SV **name= av_fetch(list, nums[0], 0 );
14736 for ( n=0; n<SvIVX(sv_dat); n++ ) {
14737 Perl_sv_catpvf(aTHX_ sv, "%s%"IVdf,
14738 (n ? "," : ""), (IV)nums[n]);
14740 Perl_sv_catpvf(aTHX_ sv, " '%"SVf"'", SVfARG(*name));
14744 } else if (k == GOSUB)
14745 Perl_sv_catpvf(aTHX_ sv, "%d[%+d]", (int)ARG(o),(int)ARG2L(o)); /* Paren and offset */
14746 else if (k == VERB) {
14748 Perl_sv_catpvf(aTHX_ sv, ":%"SVf,
14749 SVfARG((MUTABLE_SV(progi->data->data[ ARG( o ) ]))));
14750 } else if (k == LOGICAL)
14751 Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags); /* 2: embedded, otherwise 1 */
14752 else if (k == ANYOF) {
14753 int i, rangestart = -1;
14754 const U8 flags = ANYOF_FLAGS(o);
14758 if (flags & ANYOF_LOCALE)
14759 sv_catpvs(sv, "{loc}");
14760 if (flags & ANYOF_LOC_FOLD)
14761 sv_catpvs(sv, "{i}");
14762 Perl_sv_catpvf(aTHX_ sv, "[%s", PL_colors[0]);
14763 if (flags & ANYOF_INVERT)
14764 sv_catpvs(sv, "^");
14766 /* output what the standard cp 0-255 bitmap matches */
14767 for (i = 0; i <= 256; i++) {
14768 if (i < 256 && ANYOF_BITMAP_TEST(o,i)) {
14769 if (rangestart == -1)
14771 } else if (rangestart != -1) {
14772 if (i <= rangestart + 3)
14773 for (; rangestart < i; rangestart++)
14774 put_byte(sv, rangestart);
14776 put_byte(sv, rangestart);
14777 sv_catpvs(sv, "-");
14778 put_byte(sv, i - 1);
14785 EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags);
14786 /* output any special charclass tests (used entirely under use locale) */
14787 if (ANYOF_CLASS_TEST_ANY_SET(o))
14788 for (i = 0; i < (int)(sizeof(anyofs)/sizeof(char*)); i++)
14789 if (ANYOF_CLASS_TEST(o,i)) {
14790 sv_catpv(sv, anyofs[i]);
14794 EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags);
14796 if (flags & ANYOF_NON_UTF8_LATIN1_ALL) {
14797 sv_catpvs(sv, "{non-utf8-latin1-all}");
14800 /* output information about the unicode matching */
14801 if (flags & ANYOF_UNICODE_ALL)
14802 sv_catpvs(sv, "{unicode_all}");
14803 else if (ANYOF_NONBITMAP(o))
14804 sv_catpvs(sv, "{unicode}");
14805 if (flags & ANYOF_NONBITMAP_NON_UTF8)
14806 sv_catpvs(sv, "{outside bitmap}");
14808 if (ANYOF_NONBITMAP(o)) {
14809 SV *lv; /* Set if there is something outside the bit map */
14810 SV * const sw = regclass_swash(prog, o, FALSE, &lv, NULL);
14811 bool byte_output = FALSE; /* If something in the bitmap has been
14814 if (lv && lv != &PL_sv_undef) {
14816 U8 s[UTF8_MAXBYTES_CASE+1];
14818 for (i = 0; i <= 256; i++) { /* Look at chars in bitmap */
14819 uvchr_to_utf8(s, i);
14822 && ! ANYOF_BITMAP_TEST(o, i) /* Don't duplicate
14826 && swash_fetch(sw, s, TRUE))
14828 if (rangestart == -1)
14830 } else if (rangestart != -1) {
14831 byte_output = TRUE;
14832 if (i <= rangestart + 3)
14833 for (; rangestart < i; rangestart++) {
14834 put_byte(sv, rangestart);
14837 put_byte(sv, rangestart);
14838 sv_catpvs(sv, "-");
14847 char *s = savesvpv(lv);
14848 char * const origs = s;
14850 while (*s && *s != '\n')
14854 const char * const t = ++s;
14857 sv_catpvs(sv, " ");
14863 /* Truncate very long output */
14864 if (s - origs > 256) {
14865 Perl_sv_catpvf(aTHX_ sv,
14867 (int) (s - origs - 1),
14873 else if (*s == '\t') {
14888 SvREFCNT_dec_NN(lv);
14892 Perl_sv_catpvf(aTHX_ sv, "%s]", PL_colors[1]);
14894 else if (k == POSIXD || k == NPOSIXD) {
14895 U8 index = FLAGS(o) * 2;
14896 if (index > (sizeof(anyofs) / sizeof(anyofs[0]))) {
14897 Perl_sv_catpvf(aTHX_ sv, "[illegal type=%d])", index);
14900 sv_catpv(sv, anyofs[index]);
14903 else if (k == BRANCHJ && (OP(o) == UNLESSM || OP(o) == IFMATCH))
14904 Perl_sv_catpvf(aTHX_ sv, "[%d]", -(o->flags));
14906 PERL_UNUSED_CONTEXT;
14907 PERL_UNUSED_ARG(sv);
14908 PERL_UNUSED_ARG(o);
14909 PERL_UNUSED_ARG(prog);
14910 #endif /* DEBUGGING */
14914 Perl_re_intuit_string(pTHX_ REGEXP * const r)
14915 { /* Assume that RE_INTUIT is set */
14917 struct regexp *const prog = ReANY(r);
14918 GET_RE_DEBUG_FLAGS_DECL;
14920 PERL_ARGS_ASSERT_RE_INTUIT_STRING;
14921 PERL_UNUSED_CONTEXT;
14925 const char * const s = SvPV_nolen_const(prog->check_substr
14926 ? prog->check_substr : prog->check_utf8);
14928 if (!PL_colorset) reginitcolors();
14929 PerlIO_printf(Perl_debug_log,
14930 "%sUsing REx %ssubstr:%s \"%s%.60s%s%s\"\n",
14932 prog->check_substr ? "" : "utf8 ",
14933 PL_colors[5],PL_colors[0],
14936 (strlen(s) > 60 ? "..." : ""));
14939 return prog->check_substr ? prog->check_substr : prog->check_utf8;
14945 handles refcounting and freeing the perl core regexp structure. When
14946 it is necessary to actually free the structure the first thing it
14947 does is call the 'free' method of the regexp_engine associated to
14948 the regexp, allowing the handling of the void *pprivate; member
14949 first. (This routine is not overridable by extensions, which is why
14950 the extensions free is called first.)
14952 See regdupe and regdupe_internal if you change anything here.
14954 #ifndef PERL_IN_XSUB_RE
14956 Perl_pregfree(pTHX_ REGEXP *r)
14962 Perl_pregfree2(pTHX_ REGEXP *rx)
14965 struct regexp *const r = ReANY(rx);
14966 GET_RE_DEBUG_FLAGS_DECL;
14968 PERL_ARGS_ASSERT_PREGFREE2;
14970 if (r->mother_re) {
14971 ReREFCNT_dec(r->mother_re);
14973 CALLREGFREE_PVT(rx); /* free the private data */
14974 SvREFCNT_dec(RXp_PAREN_NAMES(r));
14975 Safefree(r->xpv_len_u.xpvlenu_pv);
14978 SvREFCNT_dec(r->anchored_substr);
14979 SvREFCNT_dec(r->anchored_utf8);
14980 SvREFCNT_dec(r->float_substr);
14981 SvREFCNT_dec(r->float_utf8);
14982 Safefree(r->substrs);
14984 RX_MATCH_COPY_FREE(rx);
14985 #ifdef PERL_ANY_COW
14986 SvREFCNT_dec(r->saved_copy);
14989 SvREFCNT_dec(r->qr_anoncv);
14990 rx->sv_u.svu_rx = 0;
14995 This is a hacky workaround to the structural issue of match results
14996 being stored in the regexp structure which is in turn stored in
14997 PL_curpm/PL_reg_curpm. The problem is that due to qr// the pattern
14998 could be PL_curpm in multiple contexts, and could require multiple
14999 result sets being associated with the pattern simultaneously, such
15000 as when doing a recursive match with (??{$qr})
15002 The solution is to make a lightweight copy of the regexp structure
15003 when a qr// is returned from the code executed by (??{$qr}) this
15004 lightweight copy doesn't actually own any of its data except for
15005 the starp/end and the actual regexp structure itself.
15011 Perl_reg_temp_copy (pTHX_ REGEXP *ret_x, REGEXP *rx)
15013 struct regexp *ret;
15014 struct regexp *const r = ReANY(rx);
15015 const bool islv = ret_x && SvTYPE(ret_x) == SVt_PVLV;
15017 PERL_ARGS_ASSERT_REG_TEMP_COPY;
15020 ret_x = (REGEXP*) newSV_type(SVt_REGEXP);
15022 SvOK_off((SV *)ret_x);
15024 /* For PVLVs, SvANY points to the xpvlv body while sv_u points
15025 to the regexp. (For SVt_REGEXPs, sv_upgrade has already
15026 made both spots point to the same regexp body.) */
15027 REGEXP *temp = (REGEXP *)newSV_type(SVt_REGEXP);
15028 assert(!SvPVX(ret_x));
15029 ret_x->sv_u.svu_rx = temp->sv_any;
15030 temp->sv_any = NULL;
15031 SvFLAGS(temp) = (SvFLAGS(temp) & ~SVTYPEMASK) | SVt_NULL;
15032 SvREFCNT_dec_NN(temp);
15033 /* SvCUR still resides in the xpvlv struct, so the regexp copy-
15034 ing below will not set it. */
15035 SvCUR_set(ret_x, SvCUR(rx));
15038 /* This ensures that SvTHINKFIRST(sv) is true, and hence that
15039 sv_force_normal(sv) is called. */
15041 ret = ReANY(ret_x);
15043 SvFLAGS(ret_x) |= SvUTF8(rx);
15044 /* We share the same string buffer as the original regexp, on which we
15045 hold a reference count, incremented when mother_re is set below.
15046 The string pointer is copied here, being part of the regexp struct.
15048 memcpy(&(ret->xpv_cur), &(r->xpv_cur),
15049 sizeof(regexp) - STRUCT_OFFSET(regexp, xpv_cur));
15051 const I32 npar = r->nparens+1;
15052 Newx(ret->offs, npar, regexp_paren_pair);
15053 Copy(r->offs, ret->offs, npar, regexp_paren_pair);
15056 Newx(ret->substrs, 1, struct reg_substr_data);
15057 StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
15059 SvREFCNT_inc_void(ret->anchored_substr);
15060 SvREFCNT_inc_void(ret->anchored_utf8);
15061 SvREFCNT_inc_void(ret->float_substr);
15062 SvREFCNT_inc_void(ret->float_utf8);
15064 /* check_substr and check_utf8, if non-NULL, point to either their
15065 anchored or float namesakes, and don't hold a second reference. */
15067 RX_MATCH_COPIED_off(ret_x);
15068 #ifdef PERL_ANY_COW
15069 ret->saved_copy = NULL;
15071 ret->mother_re = ReREFCNT_inc(r->mother_re ? r->mother_re : rx);
15072 SvREFCNT_inc_void(ret->qr_anoncv);
15078 /* regfree_internal()
15080 Free the private data in a regexp. This is overloadable by
15081 extensions. Perl takes care of the regexp structure in pregfree(),
15082 this covers the *pprivate pointer which technically perl doesn't
15083 know about, however of course we have to handle the
15084 regexp_internal structure when no extension is in use.
15086 Note this is called before freeing anything in the regexp
15091 Perl_regfree_internal(pTHX_ REGEXP * const rx)
15094 struct regexp *const r = ReANY(rx);
15095 RXi_GET_DECL(r,ri);
15096 GET_RE_DEBUG_FLAGS_DECL;
15098 PERL_ARGS_ASSERT_REGFREE_INTERNAL;
15104 SV *dsv= sv_newmortal();
15105 RE_PV_QUOTED_DECL(s, RX_UTF8(rx),
15106 dsv, RX_PRECOMP(rx), RX_PRELEN(rx), 60);
15107 PerlIO_printf(Perl_debug_log,"%sFreeing REx:%s %s\n",
15108 PL_colors[4],PL_colors[5],s);
15111 #ifdef RE_TRACK_PATTERN_OFFSETS
15113 Safefree(ri->u.offsets); /* 20010421 MJD */
15115 if (ri->code_blocks) {
15117 for (n = 0; n < ri->num_code_blocks; n++)
15118 SvREFCNT_dec(ri->code_blocks[n].src_regex);
15119 Safefree(ri->code_blocks);
15123 int n = ri->data->count;
15126 /* If you add a ->what type here, update the comment in regcomp.h */
15127 switch (ri->data->what[n]) {
15133 SvREFCNT_dec(MUTABLE_SV(ri->data->data[n]));
15136 Safefree(ri->data->data[n]);
15142 { /* Aho Corasick add-on structure for a trie node.
15143 Used in stclass optimization only */
15145 reg_ac_data *aho=(reg_ac_data*)ri->data->data[n];
15147 refcount = --aho->refcount;
15150 PerlMemShared_free(aho->states);
15151 PerlMemShared_free(aho->fail);
15152 /* do this last!!!! */
15153 PerlMemShared_free(ri->data->data[n]);
15154 PerlMemShared_free(ri->regstclass);
15160 /* trie structure. */
15162 reg_trie_data *trie=(reg_trie_data*)ri->data->data[n];
15164 refcount = --trie->refcount;
15167 PerlMemShared_free(trie->charmap);
15168 PerlMemShared_free(trie->states);
15169 PerlMemShared_free(trie->trans);
15171 PerlMemShared_free(trie->bitmap);
15173 PerlMemShared_free(trie->jump);
15174 PerlMemShared_free(trie->wordinfo);
15175 /* do this last!!!! */
15176 PerlMemShared_free(ri->data->data[n]);
15181 Perl_croak(aTHX_ "panic: regfree data code '%c'", ri->data->what[n]);
15184 Safefree(ri->data->what);
15185 Safefree(ri->data);
15191 #define av_dup_inc(s,t) MUTABLE_AV(sv_dup_inc((const SV *)s,t))
15192 #define hv_dup_inc(s,t) MUTABLE_HV(sv_dup_inc((const SV *)s,t))
15193 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
15196 re_dup - duplicate a regexp.
15198 This routine is expected to clone a given regexp structure. It is only
15199 compiled under USE_ITHREADS.
15201 After all of the core data stored in struct regexp is duplicated
15202 the regexp_engine.dupe method is used to copy any private data
15203 stored in the *pprivate pointer. This allows extensions to handle
15204 any duplication it needs to do.
15206 See pregfree() and regfree_internal() if you change anything here.
15208 #if defined(USE_ITHREADS)
15209 #ifndef PERL_IN_XSUB_RE
15211 Perl_re_dup_guts(pTHX_ const REGEXP *sstr, REGEXP *dstr, CLONE_PARAMS *param)
15215 const struct regexp *r = ReANY(sstr);
15216 struct regexp *ret = ReANY(dstr);
15218 PERL_ARGS_ASSERT_RE_DUP_GUTS;
15220 npar = r->nparens+1;
15221 Newx(ret->offs, npar, regexp_paren_pair);
15222 Copy(r->offs, ret->offs, npar, regexp_paren_pair);
15224 if (ret->substrs) {
15225 /* Do it this way to avoid reading from *r after the StructCopy().
15226 That way, if any of the sv_dup_inc()s dislodge *r from the L1
15227 cache, it doesn't matter. */
15228 const bool anchored = r->check_substr
15229 ? r->check_substr == r->anchored_substr
15230 : r->check_utf8 == r->anchored_utf8;
15231 Newx(ret->substrs, 1, struct reg_substr_data);
15232 StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
15234 ret->anchored_substr = sv_dup_inc(ret->anchored_substr, param);
15235 ret->anchored_utf8 = sv_dup_inc(ret->anchored_utf8, param);
15236 ret->float_substr = sv_dup_inc(ret->float_substr, param);
15237 ret->float_utf8 = sv_dup_inc(ret->float_utf8, param);
15239 /* check_substr and check_utf8, if non-NULL, point to either their
15240 anchored or float namesakes, and don't hold a second reference. */
15242 if (ret->check_substr) {
15244 assert(r->check_utf8 == r->anchored_utf8);
15245 ret->check_substr = ret->anchored_substr;
15246 ret->check_utf8 = ret->anchored_utf8;
15248 assert(r->check_substr == r->float_substr);
15249 assert(r->check_utf8 == r->float_utf8);
15250 ret->check_substr = ret->float_substr;
15251 ret->check_utf8 = ret->float_utf8;
15253 } else if (ret->check_utf8) {
15255 ret->check_utf8 = ret->anchored_utf8;
15257 ret->check_utf8 = ret->float_utf8;
15262 RXp_PAREN_NAMES(ret) = hv_dup_inc(RXp_PAREN_NAMES(ret), param);
15263 ret->qr_anoncv = MUTABLE_CV(sv_dup_inc((const SV *)ret->qr_anoncv, param));
15266 RXi_SET(ret,CALLREGDUPE_PVT(dstr,param));
15268 if (RX_MATCH_COPIED(dstr))
15269 ret->subbeg = SAVEPVN(ret->subbeg, ret->sublen);
15271 ret->subbeg = NULL;
15272 #ifdef PERL_ANY_COW
15273 ret->saved_copy = NULL;
15276 /* Whether mother_re be set or no, we need to copy the string. We
15277 cannot refrain from copying it when the storage points directly to
15278 our mother regexp, because that's
15279 1: a buffer in a different thread
15280 2: something we no longer hold a reference on
15281 so we need to copy it locally. */
15282 RX_WRAPPED(dstr) = SAVEPVN(RX_WRAPPED(sstr), SvCUR(sstr)+1);
15283 ret->mother_re = NULL;
15286 #endif /* PERL_IN_XSUB_RE */
15291 This is the internal complement to regdupe() which is used to copy
15292 the structure pointed to by the *pprivate pointer in the regexp.
15293 This is the core version of the extension overridable cloning hook.
15294 The regexp structure being duplicated will be copied by perl prior
15295 to this and will be provided as the regexp *r argument, however
15296 with the /old/ structures pprivate pointer value. Thus this routine
15297 may override any copying normally done by perl.
15299 It returns a pointer to the new regexp_internal structure.
15303 Perl_regdupe_internal(pTHX_ REGEXP * const rx, CLONE_PARAMS *param)
15306 struct regexp *const r = ReANY(rx);
15307 regexp_internal *reti;
15309 RXi_GET_DECL(r,ri);
15311 PERL_ARGS_ASSERT_REGDUPE_INTERNAL;
15315 Newxc(reti, sizeof(regexp_internal) + len*sizeof(regnode), char, regexp_internal);
15316 Copy(ri->program, reti->program, len+1, regnode);
15318 reti->num_code_blocks = ri->num_code_blocks;
15319 if (ri->code_blocks) {
15321 Newxc(reti->code_blocks, ri->num_code_blocks, struct reg_code_block,
15322 struct reg_code_block);
15323 Copy(ri->code_blocks, reti->code_blocks, ri->num_code_blocks,
15324 struct reg_code_block);
15325 for (n = 0; n < ri->num_code_blocks; n++)
15326 reti->code_blocks[n].src_regex = (REGEXP*)
15327 sv_dup_inc((SV*)(ri->code_blocks[n].src_regex), param);
15330 reti->code_blocks = NULL;
15332 reti->regstclass = NULL;
15335 struct reg_data *d;
15336 const int count = ri->data->count;
15339 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
15340 char, struct reg_data);
15341 Newx(d->what, count, U8);
15344 for (i = 0; i < count; i++) {
15345 d->what[i] = ri->data->what[i];
15346 switch (d->what[i]) {
15347 /* see also regcomp.h and regfree_internal() */
15348 case 'a': /* actually an AV, but the dup function is identical. */
15352 case 'u': /* actually an HV, but the dup function is identical. */
15353 d->data[i] = sv_dup_inc((const SV *)ri->data->data[i], param);
15356 /* This is cheating. */
15357 Newx(d->data[i], 1, struct regnode_charclass_class);
15358 StructCopy(ri->data->data[i], d->data[i],
15359 struct regnode_charclass_class);
15360 reti->regstclass = (regnode*)d->data[i];
15363 /* Trie stclasses are readonly and can thus be shared
15364 * without duplication. We free the stclass in pregfree
15365 * when the corresponding reg_ac_data struct is freed.
15367 reti->regstclass= ri->regstclass;
15371 ((reg_trie_data*)ri->data->data[i])->refcount++;
15376 d->data[i] = ri->data->data[i];
15379 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", ri->data->what[i]);
15388 reti->name_list_idx = ri->name_list_idx;
15390 #ifdef RE_TRACK_PATTERN_OFFSETS
15391 if (ri->u.offsets) {
15392 Newx(reti->u.offsets, 2*len+1, U32);
15393 Copy(ri->u.offsets, reti->u.offsets, 2*len+1, U32);
15396 SetProgLen(reti,len);
15399 return (void*)reti;
15402 #endif /* USE_ITHREADS */
15404 #ifndef PERL_IN_XSUB_RE
15407 - regnext - dig the "next" pointer out of a node
15410 Perl_regnext(pTHX_ regnode *p)
15418 if (OP(p) > REGNODE_MAX) { /* regnode.type is unsigned */
15419 Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d", (int)OP(p), (int)REGNODE_MAX);
15422 offset = (reg_off_by_arg[OP(p)] ? ARG(p) : NEXT_OFF(p));
15431 S_re_croak2(pTHX_ const char* pat1,const char* pat2,...)
15434 STRLEN l1 = strlen(pat1);
15435 STRLEN l2 = strlen(pat2);
15438 const char *message;
15440 PERL_ARGS_ASSERT_RE_CROAK2;
15446 Copy(pat1, buf, l1 , char);
15447 Copy(pat2, buf + l1, l2 , char);
15448 buf[l1 + l2] = '\n';
15449 buf[l1 + l2 + 1] = '\0';
15451 /* ANSI variant takes additional second argument */
15452 va_start(args, pat2);
15456 msv = vmess(buf, &args);
15458 message = SvPV_const(msv,l1);
15461 Copy(message, buf, l1 , char);
15462 buf[l1-1] = '\0'; /* Overwrite \n */
15463 Perl_croak(aTHX_ "%s", buf);
15466 /* XXX Here's a total kludge. But we need to re-enter for swash routines. */
15468 #ifndef PERL_IN_XSUB_RE
15470 Perl_save_re_context(pTHX)
15474 /* Save $1..$n (#18107: UTF-8 s/(\w+)/uc($1)/e); AMS 20021106. */
15476 const REGEXP * const rx = PM_GETRE(PL_curpm);
15479 for (i = 1; i <= RX_NPARENS(rx); i++) {
15480 char digits[TYPE_CHARS(long)];
15481 const STRLEN len = my_snprintf(digits, sizeof(digits), "%lu", (long)i);
15482 GV *const *const gvp
15483 = (GV**)hv_fetch(PL_defstash, digits, len, 0);
15486 GV * const gv = *gvp;
15487 if (SvTYPE(gv) == SVt_PVGV && GvSV(gv))
15499 S_put_byte(pTHX_ SV *sv, int c)
15501 PERL_ARGS_ASSERT_PUT_BYTE;
15503 /* Our definition of isPRINT() ignores locales, so only bytes that are
15504 not part of UTF-8 are considered printable. I assume that the same
15505 holds for UTF-EBCDIC.
15506 Also, code point 255 is not printable in either (it's E0 in EBCDIC,
15507 which Wikipedia says:
15509 EO, or Eight Ones, is an 8-bit EBCDIC character code represented as all
15510 ones (binary 1111 1111, hexadecimal FF). It is similar, but not
15511 identical, to the ASCII delete (DEL) or rubout control character. ...
15512 it is typically mapped to hexadecimal code 9F, in order to provide a
15513 unique character mapping in both directions)
15515 So the old condition can be simplified to !isPRINT(c) */
15518 Perl_sv_catpvf(aTHX_ sv, "\\x%02x", c);
15521 Perl_sv_catpvf(aTHX_ sv, "\\x{%x}", c);
15525 const char string = c;
15526 if (c == '-' || c == ']' || c == '\\' || c == '^')
15527 sv_catpvs(sv, "\\");
15528 sv_catpvn(sv, &string, 1);
15533 #define CLEAR_OPTSTART \
15534 if (optstart) STMT_START { \
15535 DEBUG_OPTIMISE_r(PerlIO_printf(Perl_debug_log, " (%"IVdf" nodes)\n", (IV)(node - optstart))); \
15539 #define DUMPUNTIL(b,e) CLEAR_OPTSTART; node=dumpuntil(r,start,(b),(e),last,sv,indent+1,depth+1);
15541 STATIC const regnode *
15542 S_dumpuntil(pTHX_ const regexp *r, const regnode *start, const regnode *node,
15543 const regnode *last, const regnode *plast,
15544 SV* sv, I32 indent, U32 depth)
15547 U8 op = PSEUDO; /* Arbitrary non-END op. */
15548 const regnode *next;
15549 const regnode *optstart= NULL;
15551 RXi_GET_DECL(r,ri);
15552 GET_RE_DEBUG_FLAGS_DECL;
15554 PERL_ARGS_ASSERT_DUMPUNTIL;
15556 #ifdef DEBUG_DUMPUNTIL
15557 PerlIO_printf(Perl_debug_log, "--- %d : %d - %d - %d\n",indent,node-start,
15558 last ? last-start : 0,plast ? plast-start : 0);
15561 if (plast && plast < last)
15564 while (PL_regkind[op] != END && (!last || node < last)) {
15565 /* While that wasn't END last time... */
15568 if (op == CLOSE || op == WHILEM)
15570 next = regnext((regnode *)node);
15573 if (OP(node) == OPTIMIZED) {
15574 if (!optstart && RE_DEBUG_FLAG(RE_DEBUG_COMPILE_OPTIMISE))
15581 regprop(r, sv, node);
15582 PerlIO_printf(Perl_debug_log, "%4"IVdf":%*s%s", (IV)(node - start),
15583 (int)(2*indent + 1), "", SvPVX_const(sv));
15585 if (OP(node) != OPTIMIZED) {
15586 if (next == NULL) /* Next ptr. */
15587 PerlIO_printf(Perl_debug_log, " (0)");
15588 else if (PL_regkind[(U8)op] == BRANCH && PL_regkind[OP(next)] != BRANCH )
15589 PerlIO_printf(Perl_debug_log, " (FAIL)");
15591 PerlIO_printf(Perl_debug_log, " (%"IVdf")", (IV)(next - start));
15592 (void)PerlIO_putc(Perl_debug_log, '\n');
15596 if (PL_regkind[(U8)op] == BRANCHJ) {
15599 const regnode *nnode = (OP(next) == LONGJMP
15600 ? regnext((regnode *)next)
15602 if (last && nnode > last)
15604 DUMPUNTIL(NEXTOPER(NEXTOPER(node)), nnode);
15607 else if (PL_regkind[(U8)op] == BRANCH) {
15609 DUMPUNTIL(NEXTOPER(node), next);
15611 else if ( PL_regkind[(U8)op] == TRIE ) {
15612 const regnode *this_trie = node;
15613 const char op = OP(node);
15614 const U32 n = ARG(node);
15615 const reg_ac_data * const ac = op>=AHOCORASICK ?
15616 (reg_ac_data *)ri->data->data[n] :
15618 const reg_trie_data * const trie =
15619 (reg_trie_data*)ri->data->data[op<AHOCORASICK ? n : ac->trie];
15621 AV *const trie_words = MUTABLE_AV(ri->data->data[n + TRIE_WORDS_OFFSET]);
15623 const regnode *nextbranch= NULL;
15626 for (word_idx= 0; word_idx < (I32)trie->wordcount; word_idx++) {
15627 SV ** const elem_ptr = av_fetch(trie_words,word_idx,0);
15629 PerlIO_printf(Perl_debug_log, "%*s%s ",
15630 (int)(2*(indent+3)), "",
15631 elem_ptr ? pv_pretty(sv, SvPV_nolen_const(*elem_ptr), SvCUR(*elem_ptr), 60,
15632 PL_colors[0], PL_colors[1],
15633 (SvUTF8(*elem_ptr) ? PERL_PV_ESCAPE_UNI : 0) |
15634 PERL_PV_PRETTY_ELLIPSES |
15635 PERL_PV_PRETTY_LTGT
15640 U16 dist= trie->jump[word_idx+1];
15641 PerlIO_printf(Perl_debug_log, "(%"UVuf")\n",
15642 (UV)((dist ? this_trie + dist : next) - start));
15645 nextbranch= this_trie + trie->jump[0];
15646 DUMPUNTIL(this_trie + dist, nextbranch);
15648 if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
15649 nextbranch= regnext((regnode *)nextbranch);
15651 PerlIO_printf(Perl_debug_log, "\n");
15654 if (last && next > last)
15659 else if ( op == CURLY ) { /* "next" might be very big: optimizer */
15660 DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS,
15661 NEXTOPER(node) + EXTRA_STEP_2ARGS + 1);
15663 else if (PL_regkind[(U8)op] == CURLY && op != CURLYX) {
15665 DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS, next);
15667 else if ( op == PLUS || op == STAR) {
15668 DUMPUNTIL(NEXTOPER(node), NEXTOPER(node) + 1);
15670 else if (PL_regkind[(U8)op] == ANYOF) {
15671 /* arglen 1 + class block */
15672 node += 1 + ((ANYOF_FLAGS(node) & ANYOF_CLASS)
15673 ? ANYOF_CLASS_SKIP : ANYOF_SKIP);
15674 node = NEXTOPER(node);
15676 else if (PL_regkind[(U8)op] == EXACT) {
15677 /* Literal string, where present. */
15678 node += NODE_SZ_STR(node) - 1;
15679 node = NEXTOPER(node);
15682 node = NEXTOPER(node);
15683 node += regarglen[(U8)op];
15685 if (op == CURLYX || op == OPEN)
15689 #ifdef DEBUG_DUMPUNTIL
15690 PerlIO_printf(Perl_debug_log, "--- %d\n", (int)indent);
15695 #endif /* DEBUGGING */
15699 * c-indentation-style: bsd
15700 * c-basic-offset: 4
15701 * indent-tabs-mode: nil
15704 * ex: set ts=8 sts=4 sw=4 et: