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"
100 #define HAS_NONLATIN1_FOLD_CLOSURE(i) _HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(i)
101 #define IS_NON_FINAL_FOLD(c) _IS_NON_FINAL_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c)
102 #define IS_IN_SOME_FOLD_L1(c) _IS_IN_SOME_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c)
109 # if defined(BUGGY_MSC6)
110 /* MSC 6.00A breaks on op/regexp.t test 85 unless we turn this off */
111 # pragma optimize("a",off)
112 /* But MSC 6.00A is happy with 'w', for aliases only across function calls*/
113 # pragma optimize("w",on )
114 # endif /* BUGGY_MSC6 */
118 #define STATIC static
122 typedef struct RExC_state_t {
123 U32 flags; /* RXf_* are we folding, multilining? */
124 U32 pm_flags; /* PMf_* stuff from the calling PMOP */
125 char *precomp; /* uncompiled string. */
126 REGEXP *rx_sv; /* The SV that is the regexp. */
127 regexp *rx; /* perl core regexp structure */
128 regexp_internal *rxi; /* internal data for regexp object pprivate field */
129 char *start; /* Start of input for compile */
130 char *end; /* End of input for compile */
131 char *parse; /* Input-scan pointer. */
132 I32 whilem_seen; /* number of WHILEM in this expr */
133 regnode *emit_start; /* Start of emitted-code area */
134 regnode *emit_bound; /* First regnode outside of the allocated space */
135 regnode *emit; /* Code-emit pointer; ®dummy = don't = compiling */
136 I32 naughty; /* How bad is this pattern? */
137 I32 sawback; /* Did we see \1, ...? */
139 I32 size; /* Code size. */
140 I32 npar; /* Capture buffer count, (OPEN). */
141 I32 cpar; /* Capture buffer count, (CLOSE). */
142 I32 nestroot; /* root parens we are in - used by accept */
145 regnode **open_parens; /* pointers to open parens */
146 regnode **close_parens; /* pointers to close parens */
147 regnode *opend; /* END node in program */
148 I32 utf8; /* whether the pattern is utf8 or not */
149 I32 orig_utf8; /* whether the pattern was originally in utf8 */
150 /* XXX use this for future optimisation of case
151 * where pattern must be upgraded to utf8. */
152 I32 uni_semantics; /* If a d charset modifier should use unicode
153 rules, even if the pattern is not in
155 HV *paren_names; /* Paren names */
157 regnode **recurse; /* Recurse regops */
158 I32 recurse_count; /* Number of recurse regops */
161 I32 override_recoding;
162 I32 in_multi_char_class;
163 struct reg_code_block *code_blocks; /* positions of literal (?{})
165 int num_code_blocks; /* size of code_blocks[] */
166 int code_index; /* next code_blocks[] slot */
168 char *starttry; /* -Dr: where regtry was called. */
169 #define RExC_starttry (pRExC_state->starttry)
171 SV *runtime_code_qr; /* qr with the runtime code blocks */
173 const char *lastparse;
175 AV *paren_name_list; /* idx -> name */
176 #define RExC_lastparse (pRExC_state->lastparse)
177 #define RExC_lastnum (pRExC_state->lastnum)
178 #define RExC_paren_name_list (pRExC_state->paren_name_list)
182 #define RExC_flags (pRExC_state->flags)
183 #define RExC_pm_flags (pRExC_state->pm_flags)
184 #define RExC_precomp (pRExC_state->precomp)
185 #define RExC_rx_sv (pRExC_state->rx_sv)
186 #define RExC_rx (pRExC_state->rx)
187 #define RExC_rxi (pRExC_state->rxi)
188 #define RExC_start (pRExC_state->start)
189 #define RExC_end (pRExC_state->end)
190 #define RExC_parse (pRExC_state->parse)
191 #define RExC_whilem_seen (pRExC_state->whilem_seen)
192 #ifdef RE_TRACK_PATTERN_OFFSETS
193 #define RExC_offsets (pRExC_state->rxi->u.offsets) /* I am not like the others */
195 #define RExC_emit (pRExC_state->emit)
196 #define RExC_emit_start (pRExC_state->emit_start)
197 #define RExC_emit_bound (pRExC_state->emit_bound)
198 #define RExC_naughty (pRExC_state->naughty)
199 #define RExC_sawback (pRExC_state->sawback)
200 #define RExC_seen (pRExC_state->seen)
201 #define RExC_size (pRExC_state->size)
202 #define RExC_npar (pRExC_state->npar)
203 #define RExC_nestroot (pRExC_state->nestroot)
204 #define RExC_extralen (pRExC_state->extralen)
205 #define RExC_seen_zerolen (pRExC_state->seen_zerolen)
206 #define RExC_utf8 (pRExC_state->utf8)
207 #define RExC_uni_semantics (pRExC_state->uni_semantics)
208 #define RExC_orig_utf8 (pRExC_state->orig_utf8)
209 #define RExC_open_parens (pRExC_state->open_parens)
210 #define RExC_close_parens (pRExC_state->close_parens)
211 #define RExC_opend (pRExC_state->opend)
212 #define RExC_paren_names (pRExC_state->paren_names)
213 #define RExC_recurse (pRExC_state->recurse)
214 #define RExC_recurse_count (pRExC_state->recurse_count)
215 #define RExC_in_lookbehind (pRExC_state->in_lookbehind)
216 #define RExC_contains_locale (pRExC_state->contains_locale)
217 #define RExC_override_recoding (pRExC_state->override_recoding)
218 #define RExC_in_multi_char_class (pRExC_state->in_multi_char_class)
221 #define ISMULT1(c) ((c) == '*' || (c) == '+' || (c) == '?')
222 #define ISMULT2(s) ((*s) == '*' || (*s) == '+' || (*s) == '?' || \
223 ((*s) == '{' && regcurly(s)))
226 #undef SPSTART /* dratted cpp namespace... */
229 * Flags to be passed up and down.
231 #define WORST 0 /* Worst case. */
232 #define HASWIDTH 0x01 /* Known to match non-null strings. */
234 /* Simple enough to be STAR/PLUS operand; in an EXACTish node must be a single
235 * character. (There needs to be a case: in the switch statement in regexec.c
236 * for any node marked SIMPLE.) Note that this is not the same thing as
239 #define SPSTART 0x04 /* Starts with * or + */
240 #define TRYAGAIN 0x08 /* Weeded out a declaration. */
241 #define POSTPONED 0x10 /* (?1),(?&name), (??{...}) or similar */
243 #define REG_NODE_NUM(x) ((x) ? (int)((x)-RExC_emit_start) : -1)
245 /* whether trie related optimizations are enabled */
246 #if PERL_ENABLE_EXTENDED_TRIE_OPTIMISATION
247 #define TRIE_STUDY_OPT
248 #define FULL_TRIE_STUDY
254 #define PBYTE(u8str,paren) ((U8*)(u8str))[(paren) >> 3]
255 #define PBITVAL(paren) (1 << ((paren) & 7))
256 #define PAREN_TEST(u8str,paren) ( PBYTE(u8str,paren) & PBITVAL(paren))
257 #define PAREN_SET(u8str,paren) PBYTE(u8str,paren) |= PBITVAL(paren)
258 #define PAREN_UNSET(u8str,paren) PBYTE(u8str,paren) &= (~PBITVAL(paren))
260 /* If not already in utf8, do a longjmp back to the beginning */
261 #define UTF8_LONGJMP 42 /* Choose a value not likely to ever conflict */
262 #define REQUIRE_UTF8 STMT_START { \
263 if (! UTF) JMPENV_JUMP(UTF8_LONGJMP); \
266 /* About scan_data_t.
268 During optimisation we recurse through the regexp program performing
269 various inplace (keyhole style) optimisations. In addition study_chunk
270 and scan_commit populate this data structure with information about
271 what strings MUST appear in the pattern. We look for the longest
272 string that must appear at a fixed location, and we look for the
273 longest string that may appear at a floating location. So for instance
278 Both 'FOO' and 'A' are fixed strings. Both 'B' and 'BAR' are floating
279 strings (because they follow a .* construct). study_chunk will identify
280 both FOO and BAR as being the longest fixed and floating strings respectively.
282 The strings can be composites, for instance
286 will result in a composite fixed substring 'foo'.
288 For each string some basic information is maintained:
290 - offset or min_offset
291 This is the position the string must appear at, or not before.
292 It also implicitly (when combined with minlenp) tells us how many
293 characters must match before the string we are searching for.
294 Likewise when combined with minlenp and the length of the string it
295 tells us how many characters must appear after the string we have
299 Only used for floating strings. This is the rightmost point that
300 the string can appear at. If set to I32 max it indicates that the
301 string can occur infinitely far to the right.
304 A pointer to the minimum number of characters of the pattern that the
305 string was found inside. This is important as in the case of positive
306 lookahead or positive lookbehind we can have multiple patterns
311 The minimum length of the pattern overall is 3, the minimum length
312 of the lookahead part is 3, but the minimum length of the part that
313 will actually match is 1. So 'FOO's minimum length is 3, but the
314 minimum length for the F is 1. This is important as the minimum length
315 is used to determine offsets in front of and behind the string being
316 looked for. Since strings can be composites this is the length of the
317 pattern at the time it was committed with a scan_commit. Note that
318 the length is calculated by study_chunk, so that the minimum lengths
319 are not known until the full pattern has been compiled, thus the
320 pointer to the value.
324 In the case of lookbehind the string being searched for can be
325 offset past the start point of the final matching string.
326 If this value was just blithely removed from the min_offset it would
327 invalidate some of the calculations for how many chars must match
328 before or after (as they are derived from min_offset and minlen and
329 the length of the string being searched for).
330 When the final pattern is compiled and the data is moved from the
331 scan_data_t structure into the regexp structure the information
332 about lookbehind is factored in, with the information that would
333 have been lost precalculated in the end_shift field for the
336 The fields pos_min and pos_delta are used to store the minimum offset
337 and the delta to the maximum offset at the current point in the pattern.
341 typedef struct scan_data_t {
342 /*I32 len_min; unused */
343 /*I32 len_delta; unused */
347 I32 last_end; /* min value, <0 unless valid. */
350 SV **longest; /* Either &l_fixed, or &l_float. */
351 SV *longest_fixed; /* longest fixed string found in pattern */
352 I32 offset_fixed; /* offset where it starts */
353 I32 *minlen_fixed; /* pointer to the minlen relevant to the string */
354 I32 lookbehind_fixed; /* is the position of the string modfied by LB */
355 SV *longest_float; /* longest floating string found in pattern */
356 I32 offset_float_min; /* earliest point in string it can appear */
357 I32 offset_float_max; /* latest point in string it can appear */
358 I32 *minlen_float; /* pointer to the minlen relevant to the string */
359 I32 lookbehind_float; /* is the position of the string modified by LB */
363 struct regnode_charclass_class *start_class;
367 * Forward declarations for pregcomp()'s friends.
370 static const scan_data_t zero_scan_data =
371 { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ,0};
373 #define SF_BEFORE_EOL (SF_BEFORE_SEOL|SF_BEFORE_MEOL)
374 #define SF_BEFORE_SEOL 0x0001
375 #define SF_BEFORE_MEOL 0x0002
376 #define SF_FIX_BEFORE_EOL (SF_FIX_BEFORE_SEOL|SF_FIX_BEFORE_MEOL)
377 #define SF_FL_BEFORE_EOL (SF_FL_BEFORE_SEOL|SF_FL_BEFORE_MEOL)
380 # define SF_FIX_SHIFT_EOL (0+2)
381 # define SF_FL_SHIFT_EOL (0+4)
383 # define SF_FIX_SHIFT_EOL (+2)
384 # define SF_FL_SHIFT_EOL (+4)
387 #define SF_FIX_BEFORE_SEOL (SF_BEFORE_SEOL << SF_FIX_SHIFT_EOL)
388 #define SF_FIX_BEFORE_MEOL (SF_BEFORE_MEOL << SF_FIX_SHIFT_EOL)
390 #define SF_FL_BEFORE_SEOL (SF_BEFORE_SEOL << SF_FL_SHIFT_EOL)
391 #define SF_FL_BEFORE_MEOL (SF_BEFORE_MEOL << SF_FL_SHIFT_EOL) /* 0x20 */
392 #define SF_IS_INF 0x0040
393 #define SF_HAS_PAR 0x0080
394 #define SF_IN_PAR 0x0100
395 #define SF_HAS_EVAL 0x0200
396 #define SCF_DO_SUBSTR 0x0400
397 #define SCF_DO_STCLASS_AND 0x0800
398 #define SCF_DO_STCLASS_OR 0x1000
399 #define SCF_DO_STCLASS (SCF_DO_STCLASS_AND|SCF_DO_STCLASS_OR)
400 #define SCF_WHILEM_VISITED_POS 0x2000
402 #define SCF_TRIE_RESTUDY 0x4000 /* Do restudy? */
403 #define SCF_SEEN_ACCEPT 0x8000
405 #define UTF cBOOL(RExC_utf8)
407 /* The enums for all these are ordered so things work out correctly */
408 #define LOC (get_regex_charset(RExC_flags) == REGEX_LOCALE_CHARSET)
409 #define DEPENDS_SEMANTICS (get_regex_charset(RExC_flags) == REGEX_DEPENDS_CHARSET)
410 #define UNI_SEMANTICS (get_regex_charset(RExC_flags) == REGEX_UNICODE_CHARSET)
411 #define AT_LEAST_UNI_SEMANTICS (get_regex_charset(RExC_flags) >= REGEX_UNICODE_CHARSET)
412 #define ASCII_RESTRICTED (get_regex_charset(RExC_flags) == REGEX_ASCII_RESTRICTED_CHARSET)
413 #define AT_LEAST_ASCII_RESTRICTED (get_regex_charset(RExC_flags) >= REGEX_ASCII_RESTRICTED_CHARSET)
414 #define ASCII_FOLD_RESTRICTED (get_regex_charset(RExC_flags) == REGEX_ASCII_MORE_RESTRICTED_CHARSET)
416 #define FOLD cBOOL(RExC_flags & RXf_PMf_FOLD)
418 #define OOB_NAMEDCLASS -1
420 /* There is no code point that is out-of-bounds, so this is problematic. But
421 * its only current use is to initialize a variable that is always set before
423 #define OOB_UNICODE 0xDEADBEEF
425 #define CHR_SVLEN(sv) (UTF ? sv_len_utf8(sv) : SvCUR(sv))
426 #define CHR_DIST(a,b) (UTF ? utf8_distance(a,b) : a - b)
429 /* length of regex to show in messages that don't mark a position within */
430 #define RegexLengthToShowInErrorMessages 127
433 * If MARKER[12] are adjusted, be sure to adjust the constants at the top
434 * of t/op/regmesg.t, the tests in t/op/re_tests, and those in
435 * op/pragma/warn/regcomp.
437 #define MARKER1 "<-- HERE" /* marker as it appears in the description */
438 #define MARKER2 " <-- HERE " /* marker as it appears within the regex */
440 #define REPORT_LOCATION " in regex; marked by " MARKER1 " in m/%.*s" MARKER2 "%s/"
443 * Calls SAVEDESTRUCTOR_X if needed, then calls Perl_croak with the given
444 * arg. Show regex, up to a maximum length. If it's too long, chop and add
447 #define _FAIL(code) STMT_START { \
448 const char *ellipses = ""; \
449 IV len = RExC_end - RExC_precomp; \
452 SAVEDESTRUCTOR_X(clear_re,(void*)RExC_rx_sv); \
453 if (len > RegexLengthToShowInErrorMessages) { \
454 /* chop 10 shorter than the max, to ensure meaning of "..." */ \
455 len = RegexLengthToShowInErrorMessages - 10; \
461 #define FAIL(msg) _FAIL( \
462 Perl_croak(aTHX_ "%s in regex m/%.*s%s/", \
463 msg, (int)len, RExC_precomp, ellipses))
465 #define FAIL2(msg,arg) _FAIL( \
466 Perl_croak(aTHX_ msg " in regex m/%.*s%s/", \
467 arg, (int)len, RExC_precomp, ellipses))
470 * Simple_vFAIL -- like FAIL, but marks the current location in the scan
472 #define Simple_vFAIL(m) STMT_START { \
473 const IV offset = RExC_parse - RExC_precomp; \
474 Perl_croak(aTHX_ "%s" REPORT_LOCATION, \
475 m, (int)offset, RExC_precomp, RExC_precomp + offset); \
479 * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL()
481 #define vFAIL(m) STMT_START { \
483 SAVEDESTRUCTOR_X(clear_re,(void*)RExC_rx_sv); \
488 * Like Simple_vFAIL(), but accepts two arguments.
490 #define Simple_vFAIL2(m,a1) STMT_START { \
491 const IV offset = RExC_parse - RExC_precomp; \
492 S_re_croak2(aTHX_ m, REPORT_LOCATION, a1, \
493 (int)offset, RExC_precomp, RExC_precomp + offset); \
497 * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL2().
499 #define vFAIL2(m,a1) STMT_START { \
501 SAVEDESTRUCTOR_X(clear_re,(void*)RExC_rx_sv); \
502 Simple_vFAIL2(m, a1); \
507 * Like Simple_vFAIL(), but accepts three arguments.
509 #define Simple_vFAIL3(m, a1, a2) STMT_START { \
510 const IV offset = RExC_parse - RExC_precomp; \
511 S_re_croak2(aTHX_ m, REPORT_LOCATION, a1, a2, \
512 (int)offset, RExC_precomp, RExC_precomp + offset); \
516 * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL3().
518 #define vFAIL3(m,a1,a2) STMT_START { \
520 SAVEDESTRUCTOR_X(clear_re,(void*)RExC_rx_sv); \
521 Simple_vFAIL3(m, a1, a2); \
525 * Like Simple_vFAIL(), but accepts four arguments.
527 #define Simple_vFAIL4(m, a1, a2, a3) STMT_START { \
528 const IV offset = RExC_parse - RExC_precomp; \
529 S_re_croak2(aTHX_ m, REPORT_LOCATION, a1, a2, a3, \
530 (int)offset, RExC_precomp, RExC_precomp + offset); \
533 #define ckWARNreg(loc,m) STMT_START { \
534 const IV offset = loc - RExC_precomp; \
535 Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION, \
536 (int)offset, RExC_precomp, RExC_precomp + offset); \
539 #define ckWARNregdep(loc,m) STMT_START { \
540 const IV offset = loc - RExC_precomp; \
541 Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_REGEXP), \
543 (int)offset, RExC_precomp, RExC_precomp + offset); \
546 #define ckWARN2regdep(loc,m, a1) STMT_START { \
547 const IV offset = loc - RExC_precomp; \
548 Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_REGEXP), \
550 a1, (int)offset, RExC_precomp, RExC_precomp + offset); \
553 #define ckWARN2reg(loc, m, a1) STMT_START { \
554 const IV offset = loc - RExC_precomp; \
555 Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION, \
556 a1, (int)offset, RExC_precomp, RExC_precomp + offset); \
559 #define vWARN3(loc, m, a1, a2) STMT_START { \
560 const IV offset = loc - RExC_precomp; \
561 Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION, \
562 a1, a2, (int)offset, RExC_precomp, RExC_precomp + offset); \
565 #define ckWARN3reg(loc, m, a1, a2) STMT_START { \
566 const IV offset = loc - RExC_precomp; \
567 Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION, \
568 a1, a2, (int)offset, RExC_precomp, RExC_precomp + offset); \
571 #define vWARN4(loc, m, a1, a2, a3) STMT_START { \
572 const IV offset = loc - RExC_precomp; \
573 Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION, \
574 a1, a2, a3, (int)offset, RExC_precomp, RExC_precomp + offset); \
577 #define ckWARN4reg(loc, m, a1, a2, a3) STMT_START { \
578 const IV offset = loc - RExC_precomp; \
579 Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION, \
580 a1, a2, a3, (int)offset, RExC_precomp, RExC_precomp + offset); \
583 #define vWARN5(loc, m, a1, a2, a3, a4) STMT_START { \
584 const IV offset = loc - RExC_precomp; \
585 Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION, \
586 a1, a2, a3, a4, (int)offset, RExC_precomp, RExC_precomp + offset); \
590 /* Allow for side effects in s */
591 #define REGC(c,s) STMT_START { \
592 if (!SIZE_ONLY) *(s) = (c); else (void)(s); \
595 /* Macros for recording node offsets. 20001227 mjd@plover.com
596 * Nodes are numbered 1, 2, 3, 4. Node #n's position is recorded in
597 * element 2*n-1 of the array. Element #2n holds the byte length node #n.
598 * Element 0 holds the number n.
599 * Position is 1 indexed.
601 #ifndef RE_TRACK_PATTERN_OFFSETS
602 #define Set_Node_Offset_To_R(node,byte)
603 #define Set_Node_Offset(node,byte)
604 #define Set_Cur_Node_Offset
605 #define Set_Node_Length_To_R(node,len)
606 #define Set_Node_Length(node,len)
607 #define Set_Node_Cur_Length(node)
608 #define Node_Offset(n)
609 #define Node_Length(n)
610 #define Set_Node_Offset_Length(node,offset,len)
611 #define ProgLen(ri) ri->u.proglen
612 #define SetProgLen(ri,x) ri->u.proglen = x
614 #define ProgLen(ri) ri->u.offsets[0]
615 #define SetProgLen(ri,x) ri->u.offsets[0] = x
616 #define Set_Node_Offset_To_R(node,byte) STMT_START { \
618 MJD_OFFSET_DEBUG(("** (%d) offset of node %d is %d.\n", \
619 __LINE__, (int)(node), (int)(byte))); \
621 Perl_croak(aTHX_ "value of node is %d in Offset macro", (int)(node)); \
623 RExC_offsets[2*(node)-1] = (byte); \
628 #define Set_Node_Offset(node,byte) \
629 Set_Node_Offset_To_R((node)-RExC_emit_start, (byte)-RExC_start)
630 #define Set_Cur_Node_Offset Set_Node_Offset(RExC_emit, RExC_parse)
632 #define Set_Node_Length_To_R(node,len) STMT_START { \
634 MJD_OFFSET_DEBUG(("** (%d) size of node %d is %d.\n", \
635 __LINE__, (int)(node), (int)(len))); \
637 Perl_croak(aTHX_ "value of node is %d in Length macro", (int)(node)); \
639 RExC_offsets[2*(node)] = (len); \
644 #define Set_Node_Length(node,len) \
645 Set_Node_Length_To_R((node)-RExC_emit_start, len)
646 #define Set_Cur_Node_Length(len) Set_Node_Length(RExC_emit, len)
647 #define Set_Node_Cur_Length(node) \
648 Set_Node_Length(node, RExC_parse - parse_start)
650 /* Get offsets and lengths */
651 #define Node_Offset(n) (RExC_offsets[2*((n)-RExC_emit_start)-1])
652 #define Node_Length(n) (RExC_offsets[2*((n)-RExC_emit_start)])
654 #define Set_Node_Offset_Length(node,offset,len) STMT_START { \
655 Set_Node_Offset_To_R((node)-RExC_emit_start, (offset)); \
656 Set_Node_Length_To_R((node)-RExC_emit_start, (len)); \
660 #if PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS
661 #define EXPERIMENTAL_INPLACESCAN
662 #endif /*PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS*/
664 #define DEBUG_STUDYDATA(str,data,depth) \
665 DEBUG_OPTIMISE_MORE_r(if(data){ \
666 PerlIO_printf(Perl_debug_log, \
667 "%*s" str "Pos:%"IVdf"/%"IVdf \
668 " Flags: 0x%"UVXf" Whilem_c: %"IVdf" Lcp: %"IVdf" %s", \
669 (int)(depth)*2, "", \
670 (IV)((data)->pos_min), \
671 (IV)((data)->pos_delta), \
672 (UV)((data)->flags), \
673 (IV)((data)->whilem_c), \
674 (IV)((data)->last_closep ? *((data)->last_closep) : -1), \
675 is_inf ? "INF " : "" \
677 if ((data)->last_found) \
678 PerlIO_printf(Perl_debug_log, \
679 "Last:'%s' %"IVdf":%"IVdf"/%"IVdf" %sFixed:'%s' @ %"IVdf \
680 " %sFloat: '%s' @ %"IVdf"/%"IVdf"", \
681 SvPVX_const((data)->last_found), \
682 (IV)((data)->last_end), \
683 (IV)((data)->last_start_min), \
684 (IV)((data)->last_start_max), \
685 ((data)->longest && \
686 (data)->longest==&((data)->longest_fixed)) ? "*" : "", \
687 SvPVX_const((data)->longest_fixed), \
688 (IV)((data)->offset_fixed), \
689 ((data)->longest && \
690 (data)->longest==&((data)->longest_float)) ? "*" : "", \
691 SvPVX_const((data)->longest_float), \
692 (IV)((data)->offset_float_min), \
693 (IV)((data)->offset_float_max) \
695 PerlIO_printf(Perl_debug_log,"\n"); \
698 static void clear_re(pTHX_ void *r);
700 /* Mark that we cannot extend a found fixed substring at this point.
701 Update the longest found anchored substring and the longest found
702 floating substrings if needed. */
705 S_scan_commit(pTHX_ const RExC_state_t *pRExC_state, scan_data_t *data, I32 *minlenp, int is_inf)
707 const STRLEN l = CHR_SVLEN(data->last_found);
708 const STRLEN old_l = CHR_SVLEN(*data->longest);
709 GET_RE_DEBUG_FLAGS_DECL;
711 PERL_ARGS_ASSERT_SCAN_COMMIT;
713 if ((l >= old_l) && ((l > old_l) || (data->flags & SF_BEFORE_EOL))) {
714 SvSetMagicSV(*data->longest, data->last_found);
715 if (*data->longest == data->longest_fixed) {
716 data->offset_fixed = l ? data->last_start_min : data->pos_min;
717 if (data->flags & SF_BEFORE_EOL)
719 |= ((data->flags & SF_BEFORE_EOL) << SF_FIX_SHIFT_EOL);
721 data->flags &= ~SF_FIX_BEFORE_EOL;
722 data->minlen_fixed=minlenp;
723 data->lookbehind_fixed=0;
725 else { /* *data->longest == data->longest_float */
726 data->offset_float_min = l ? data->last_start_min : data->pos_min;
727 data->offset_float_max = (l
728 ? data->last_start_max
729 : data->pos_min + data->pos_delta);
730 if (is_inf || (U32)data->offset_float_max > (U32)I32_MAX)
731 data->offset_float_max = I32_MAX;
732 if (data->flags & SF_BEFORE_EOL)
734 |= ((data->flags & SF_BEFORE_EOL) << SF_FL_SHIFT_EOL);
736 data->flags &= ~SF_FL_BEFORE_EOL;
737 data->minlen_float=minlenp;
738 data->lookbehind_float=0;
741 SvCUR_set(data->last_found, 0);
743 SV * const sv = data->last_found;
744 if (SvUTF8(sv) && SvMAGICAL(sv)) {
745 MAGIC * const mg = mg_find(sv, PERL_MAGIC_utf8);
751 data->flags &= ~SF_BEFORE_EOL;
752 DEBUG_STUDYDATA("commit: ",data,0);
755 /* Can match anything (initialization) */
757 S_cl_anything(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl)
759 PERL_ARGS_ASSERT_CL_ANYTHING;
761 ANYOF_BITMAP_SETALL(cl);
762 cl->flags = ANYOF_CLASS|ANYOF_EOS|ANYOF_UNICODE_ALL
763 |ANYOF_NON_UTF8_LATIN1_ALL;
765 /* If any portion of the regex is to operate under locale rules,
766 * initialization includes it. The reason this isn't done for all regexes
767 * is that the optimizer was written under the assumption that locale was
768 * all-or-nothing. Given the complexity and lack of documentation in the
769 * optimizer, and that there are inadequate test cases for locale, so many
770 * parts of it may not work properly, it is safest to avoid locale unless
772 if (RExC_contains_locale) {
773 ANYOF_CLASS_SETALL(cl); /* /l uses class */
774 cl->flags |= ANYOF_LOCALE|ANYOF_LOC_FOLD;
777 ANYOF_CLASS_ZERO(cl); /* Only /l uses class now */
781 /* Can match anything (initialization) */
783 S_cl_is_anything(const struct regnode_charclass_class *cl)
787 PERL_ARGS_ASSERT_CL_IS_ANYTHING;
789 for (value = 0; value <= ANYOF_MAX; value += 2)
790 if (ANYOF_CLASS_TEST(cl, value) && ANYOF_CLASS_TEST(cl, value + 1))
792 if (!(cl->flags & ANYOF_UNICODE_ALL))
794 if (!ANYOF_BITMAP_TESTALLSET((const void*)cl))
799 /* Can match anything (initialization) */
801 S_cl_init(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl)
803 PERL_ARGS_ASSERT_CL_INIT;
805 Zero(cl, 1, struct regnode_charclass_class);
807 cl_anything(pRExC_state, cl);
808 ARG_SET(cl, ANYOF_NONBITMAP_EMPTY);
811 /* These two functions currently do the exact same thing */
812 #define cl_init_zero S_cl_init
814 /* 'AND' a given class with another one. Can create false positives. 'cl'
815 * should not be inverted. 'and_with->flags & ANYOF_CLASS' should be 0 if
816 * 'and_with' is a regnode_charclass instead of a regnode_charclass_class. */
818 S_cl_and(struct regnode_charclass_class *cl,
819 const struct regnode_charclass_class *and_with)
821 PERL_ARGS_ASSERT_CL_AND;
823 assert(and_with->type == ANYOF);
825 /* I (khw) am not sure all these restrictions are necessary XXX */
826 if (!(ANYOF_CLASS_TEST_ANY_SET(and_with))
827 && !(ANYOF_CLASS_TEST_ANY_SET(cl))
828 && (and_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
829 && !(and_with->flags & ANYOF_LOC_FOLD)
830 && !(cl->flags & ANYOF_LOC_FOLD)) {
833 if (and_with->flags & ANYOF_INVERT)
834 for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
835 cl->bitmap[i] &= ~and_with->bitmap[i];
837 for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
838 cl->bitmap[i] &= and_with->bitmap[i];
839 } /* XXXX: logic is complicated otherwise, leave it along for a moment. */
841 if (and_with->flags & ANYOF_INVERT) {
843 /* Here, the and'ed node is inverted. Get the AND of the flags that
844 * aren't affected by the inversion. Those that are affected are
845 * handled individually below */
846 U8 affected_flags = cl->flags & ~INVERSION_UNAFFECTED_FLAGS;
847 cl->flags &= (and_with->flags & INVERSION_UNAFFECTED_FLAGS);
848 cl->flags |= affected_flags;
850 /* We currently don't know how to deal with things that aren't in the
851 * bitmap, but we know that the intersection is no greater than what
852 * is already in cl, so let there be false positives that get sorted
853 * out after the synthetic start class succeeds, and the node is
854 * matched for real. */
856 /* The inversion of these two flags indicate that the resulting
857 * intersection doesn't have them */
858 if (and_with->flags & ANYOF_UNICODE_ALL) {
859 cl->flags &= ~ANYOF_UNICODE_ALL;
861 if (and_with->flags & ANYOF_NON_UTF8_LATIN1_ALL) {
862 cl->flags &= ~ANYOF_NON_UTF8_LATIN1_ALL;
865 else { /* and'd node is not inverted */
866 U8 outside_bitmap_but_not_utf8; /* Temp variable */
868 if (! ANYOF_NONBITMAP(and_with)) {
870 /* Here 'and_with' doesn't match anything outside the bitmap
871 * (except possibly ANYOF_UNICODE_ALL), which means the
872 * intersection can't either, except for ANYOF_UNICODE_ALL, in
873 * which case we don't know what the intersection is, but it's no
874 * greater than what cl already has, so can just leave it alone,
875 * with possible false positives */
876 if (! (and_with->flags & ANYOF_UNICODE_ALL)) {
877 ARG_SET(cl, ANYOF_NONBITMAP_EMPTY);
878 cl->flags &= ~ANYOF_NONBITMAP_NON_UTF8;
881 else if (! ANYOF_NONBITMAP(cl)) {
883 /* Here, 'and_with' does match something outside the bitmap, and cl
884 * doesn't have a list of things to match outside the bitmap. If
885 * cl can match all code points above 255, the intersection will
886 * be those above-255 code points that 'and_with' matches. If cl
887 * can't match all Unicode code points, it means that it can't
888 * match anything outside the bitmap (since the 'if' that got us
889 * into this block tested for that), so we leave the bitmap empty.
891 if (cl->flags & ANYOF_UNICODE_ALL) {
892 ARG_SET(cl, ARG(and_with));
894 /* and_with's ARG may match things that don't require UTF8.
895 * And now cl's will too, in spite of this being an 'and'. See
896 * the comments below about the kludge */
897 cl->flags |= and_with->flags & ANYOF_NONBITMAP_NON_UTF8;
901 /* Here, both 'and_with' and cl match something outside the
902 * bitmap. Currently we do not do the intersection, so just match
903 * whatever cl had at the beginning. */
907 /* Take the intersection of the two sets of flags. However, the
908 * ANYOF_NONBITMAP_NON_UTF8 flag is treated as an 'or'. This is a
909 * kludge around the fact that this flag is not treated like the others
910 * which are initialized in cl_anything(). The way the optimizer works
911 * is that the synthetic start class (SSC) is initialized to match
912 * anything, and then the first time a real node is encountered, its
913 * values are AND'd with the SSC's with the result being the values of
914 * the real node. However, there are paths through the optimizer where
915 * the AND never gets called, so those initialized bits are set
916 * inappropriately, which is not usually a big deal, as they just cause
917 * false positives in the SSC, which will just mean a probably
918 * imperceptible slow down in execution. However this bit has a
919 * higher false positive consequence in that it can cause utf8.pm,
920 * utf8_heavy.pl ... to be loaded when not necessary, which is a much
921 * bigger slowdown and also causes significant extra memory to be used.
922 * In order to prevent this, the code now takes a different tack. The
923 * bit isn't set unless some part of the regular expression needs it,
924 * but once set it won't get cleared. This means that these extra
925 * modules won't get loaded unless there was some path through the
926 * pattern that would have required them anyway, and so any false
927 * positives that occur by not ANDing them out when they could be
928 * aren't as severe as they would be if we treated this bit like all
930 outside_bitmap_but_not_utf8 = (cl->flags | and_with->flags)
931 & ANYOF_NONBITMAP_NON_UTF8;
932 cl->flags &= and_with->flags;
933 cl->flags |= outside_bitmap_but_not_utf8;
937 /* 'OR' a given class with another one. Can create false positives. 'cl'
938 * should not be inverted. 'or_with->flags & ANYOF_CLASS' should be 0 if
939 * 'or_with' is a regnode_charclass instead of a regnode_charclass_class. */
941 S_cl_or(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl, const struct regnode_charclass_class *or_with)
943 PERL_ARGS_ASSERT_CL_OR;
945 if (or_with->flags & ANYOF_INVERT) {
947 /* Here, the or'd node is to be inverted. This means we take the
948 * complement of everything not in the bitmap, but currently we don't
949 * know what that is, so give up and match anything */
950 if (ANYOF_NONBITMAP(or_with)) {
951 cl_anything(pRExC_state, cl);
954 * (B1 | CL1) | (!B2 & !CL2) = (B1 | !B2 & !CL2) | (CL1 | (!B2 & !CL2))
955 * <= (B1 | !B2) | (CL1 | !CL2)
956 * which is wasteful if CL2 is small, but we ignore CL2:
957 * (B1 | CL1) | (!B2 & !CL2) <= (B1 | CL1) | !B2 = (B1 | !B2) | CL1
958 * XXXX Can we handle case-fold? Unclear:
959 * (OK1(i) | OK1(i')) | !(OK1(i) | OK1(i')) =
960 * (OK1(i) | OK1(i')) | (!OK1(i) & !OK1(i'))
962 else if ( (or_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
963 && !(or_with->flags & ANYOF_LOC_FOLD)
964 && !(cl->flags & ANYOF_LOC_FOLD) ) {
967 for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
968 cl->bitmap[i] |= ~or_with->bitmap[i];
969 } /* XXXX: logic is complicated otherwise */
971 cl_anything(pRExC_state, cl);
974 /* And, we can just take the union of the flags that aren't affected
975 * by the inversion */
976 cl->flags |= or_with->flags & INVERSION_UNAFFECTED_FLAGS;
978 /* For the remaining flags:
979 ANYOF_UNICODE_ALL and inverted means to not match anything above
980 255, which means that the union with cl should just be
981 what cl has in it, so can ignore this flag
982 ANYOF_NON_UTF8_LATIN1_ALL and inverted means if not utf8 and ord
983 is 127-255 to match them, but then invert that, so the
984 union with cl should just be what cl has in it, so can
987 } else { /* 'or_with' is not inverted */
988 /* (B1 | CL1) | (B2 | CL2) = (B1 | B2) | (CL1 | CL2)) */
989 if ( (or_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
990 && (!(or_with->flags & ANYOF_LOC_FOLD)
991 || (cl->flags & ANYOF_LOC_FOLD)) ) {
994 /* OR char bitmap and class bitmap separately */
995 for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
996 cl->bitmap[i] |= or_with->bitmap[i];
997 if (ANYOF_CLASS_TEST_ANY_SET(or_with)) {
998 for (i = 0; i < ANYOF_CLASSBITMAP_SIZE; i++)
999 cl->classflags[i] |= or_with->classflags[i];
1000 cl->flags |= ANYOF_CLASS;
1003 else { /* XXXX: logic is complicated, leave it along for a moment. */
1004 cl_anything(pRExC_state, cl);
1007 if (ANYOF_NONBITMAP(or_with)) {
1009 /* Use the added node's outside-the-bit-map match if there isn't a
1010 * conflict. If there is a conflict (both nodes match something
1011 * outside the bitmap, but what they match outside is not the same
1012 * pointer, and hence not easily compared until XXX we extend
1013 * inversion lists this far), give up and allow the start class to
1014 * match everything outside the bitmap. If that stuff is all above
1015 * 255, can just set UNICODE_ALL, otherwise caould be anything. */
1016 if (! ANYOF_NONBITMAP(cl)) {
1017 ARG_SET(cl, ARG(or_with));
1019 else if (ARG(cl) != ARG(or_with)) {
1021 if ((or_with->flags & ANYOF_NONBITMAP_NON_UTF8)) {
1022 cl_anything(pRExC_state, cl);
1025 cl->flags |= ANYOF_UNICODE_ALL;
1030 /* Take the union */
1031 cl->flags |= or_with->flags;
1035 #define TRIE_LIST_ITEM(state,idx) (trie->states[state].trans.list)[ idx ]
1036 #define TRIE_LIST_CUR(state) ( TRIE_LIST_ITEM( state, 0 ).forid )
1037 #define TRIE_LIST_LEN(state) ( TRIE_LIST_ITEM( state, 0 ).newstate )
1038 #define TRIE_LIST_USED(idx) ( trie->states[state].trans.list ? (TRIE_LIST_CUR( idx ) - 1) : 0 )
1043 dump_trie(trie,widecharmap,revcharmap)
1044 dump_trie_interim_list(trie,widecharmap,revcharmap,next_alloc)
1045 dump_trie_interim_table(trie,widecharmap,revcharmap,next_alloc)
1047 These routines dump out a trie in a somewhat readable format.
1048 The _interim_ variants are used for debugging the interim
1049 tables that are used to generate the final compressed
1050 representation which is what dump_trie expects.
1052 Part of the reason for their existence is to provide a form
1053 of documentation as to how the different representations function.
1058 Dumps the final compressed table form of the trie to Perl_debug_log.
1059 Used for debugging make_trie().
1063 S_dump_trie(pTHX_ const struct _reg_trie_data *trie, HV *widecharmap,
1064 AV *revcharmap, U32 depth)
1067 SV *sv=sv_newmortal();
1068 int colwidth= widecharmap ? 6 : 4;
1070 GET_RE_DEBUG_FLAGS_DECL;
1072 PERL_ARGS_ASSERT_DUMP_TRIE;
1074 PerlIO_printf( Perl_debug_log, "%*sChar : %-6s%-6s%-4s ",
1075 (int)depth * 2 + 2,"",
1076 "Match","Base","Ofs" );
1078 for( state = 0 ; state < trie->uniquecharcount ; state++ ) {
1079 SV ** const tmp = av_fetch( revcharmap, state, 0);
1081 PerlIO_printf( Perl_debug_log, "%*s",
1083 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth,
1084 PL_colors[0], PL_colors[1],
1085 (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1086 PERL_PV_ESCAPE_FIRSTCHAR
1091 PerlIO_printf( Perl_debug_log, "\n%*sState|-----------------------",
1092 (int)depth * 2 + 2,"");
1094 for( state = 0 ; state < trie->uniquecharcount ; state++ )
1095 PerlIO_printf( Perl_debug_log, "%.*s", colwidth, "--------");
1096 PerlIO_printf( Perl_debug_log, "\n");
1098 for( state = 1 ; state < trie->statecount ; state++ ) {
1099 const U32 base = trie->states[ state ].trans.base;
1101 PerlIO_printf( Perl_debug_log, "%*s#%4"UVXf"|", (int)depth * 2 + 2,"", (UV)state);
1103 if ( trie->states[ state ].wordnum ) {
1104 PerlIO_printf( Perl_debug_log, " W%4X", trie->states[ state ].wordnum );
1106 PerlIO_printf( Perl_debug_log, "%6s", "" );
1109 PerlIO_printf( Perl_debug_log, " @%4"UVXf" ", (UV)base );
1114 while( ( base + ofs < trie->uniquecharcount ) ||
1115 ( base + ofs - trie->uniquecharcount < trie->lasttrans
1116 && trie->trans[ base + ofs - trie->uniquecharcount ].check != state))
1119 PerlIO_printf( Perl_debug_log, "+%2"UVXf"[ ", (UV)ofs);
1121 for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
1122 if ( ( base + ofs >= trie->uniquecharcount ) &&
1123 ( base + ofs - trie->uniquecharcount < trie->lasttrans ) &&
1124 trie->trans[ base + ofs - trie->uniquecharcount ].check == state )
1126 PerlIO_printf( Perl_debug_log, "%*"UVXf,
1128 (UV)trie->trans[ base + ofs - trie->uniquecharcount ].next );
1130 PerlIO_printf( Perl_debug_log, "%*s",colwidth," ." );
1134 PerlIO_printf( Perl_debug_log, "]");
1137 PerlIO_printf( Perl_debug_log, "\n" );
1139 PerlIO_printf(Perl_debug_log, "%*sword_info N:(prev,len)=", (int)depth*2, "");
1140 for (word=1; word <= trie->wordcount; word++) {
1141 PerlIO_printf(Perl_debug_log, " %d:(%d,%d)",
1142 (int)word, (int)(trie->wordinfo[word].prev),
1143 (int)(trie->wordinfo[word].len));
1145 PerlIO_printf(Perl_debug_log, "\n" );
1148 Dumps a fully constructed but uncompressed trie in list form.
1149 List tries normally only are used for construction when the number of
1150 possible chars (trie->uniquecharcount) is very high.
1151 Used for debugging make_trie().
1154 S_dump_trie_interim_list(pTHX_ const struct _reg_trie_data *trie,
1155 HV *widecharmap, AV *revcharmap, U32 next_alloc,
1159 SV *sv=sv_newmortal();
1160 int colwidth= widecharmap ? 6 : 4;
1161 GET_RE_DEBUG_FLAGS_DECL;
1163 PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_LIST;
1165 /* print out the table precompression. */
1166 PerlIO_printf( Perl_debug_log, "%*sState :Word | Transition Data\n%*s%s",
1167 (int)depth * 2 + 2,"", (int)depth * 2 + 2,"",
1168 "------:-----+-----------------\n" );
1170 for( state=1 ; state < next_alloc ; state ++ ) {
1173 PerlIO_printf( Perl_debug_log, "%*s %4"UVXf" :",
1174 (int)depth * 2 + 2,"", (UV)state );
1175 if ( ! trie->states[ state ].wordnum ) {
1176 PerlIO_printf( Perl_debug_log, "%5s| ","");
1178 PerlIO_printf( Perl_debug_log, "W%4x| ",
1179 trie->states[ state ].wordnum
1182 for( charid = 1 ; charid <= TRIE_LIST_USED( state ) ; charid++ ) {
1183 SV ** const tmp = av_fetch( revcharmap, TRIE_LIST_ITEM(state,charid).forid, 0);
1185 PerlIO_printf( Perl_debug_log, "%*s:%3X=%4"UVXf" | ",
1187 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth,
1188 PL_colors[0], PL_colors[1],
1189 (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1190 PERL_PV_ESCAPE_FIRSTCHAR
1192 TRIE_LIST_ITEM(state,charid).forid,
1193 (UV)TRIE_LIST_ITEM(state,charid).newstate
1196 PerlIO_printf(Perl_debug_log, "\n%*s| ",
1197 (int)((depth * 2) + 14), "");
1200 PerlIO_printf( Perl_debug_log, "\n");
1205 Dumps a fully constructed but uncompressed trie in table form.
1206 This is the normal DFA style state transition table, with a few
1207 twists to facilitate compression later.
1208 Used for debugging make_trie().
1211 S_dump_trie_interim_table(pTHX_ const struct _reg_trie_data *trie,
1212 HV *widecharmap, AV *revcharmap, U32 next_alloc,
1217 SV *sv=sv_newmortal();
1218 int colwidth= widecharmap ? 6 : 4;
1219 GET_RE_DEBUG_FLAGS_DECL;
1221 PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_TABLE;
1224 print out the table precompression so that we can do a visual check
1225 that they are identical.
1228 PerlIO_printf( Perl_debug_log, "%*sChar : ",(int)depth * 2 + 2,"" );
1230 for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
1231 SV ** const tmp = av_fetch( revcharmap, charid, 0);
1233 PerlIO_printf( Perl_debug_log, "%*s",
1235 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth,
1236 PL_colors[0], PL_colors[1],
1237 (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1238 PERL_PV_ESCAPE_FIRSTCHAR
1244 PerlIO_printf( Perl_debug_log, "\n%*sState+-",(int)depth * 2 + 2,"" );
1246 for( charid=0 ; charid < trie->uniquecharcount ; charid++ ) {
1247 PerlIO_printf( Perl_debug_log, "%.*s", colwidth,"--------");
1250 PerlIO_printf( Perl_debug_log, "\n" );
1252 for( state=1 ; state < next_alloc ; state += trie->uniquecharcount ) {
1254 PerlIO_printf( Perl_debug_log, "%*s%4"UVXf" : ",
1255 (int)depth * 2 + 2,"",
1256 (UV)TRIE_NODENUM( state ) );
1258 for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
1259 UV v=(UV)SAFE_TRIE_NODENUM( trie->trans[ state + charid ].next );
1261 PerlIO_printf( Perl_debug_log, "%*"UVXf, colwidth, v );
1263 PerlIO_printf( Perl_debug_log, "%*s", colwidth, "." );
1265 if ( ! trie->states[ TRIE_NODENUM( state ) ].wordnum ) {
1266 PerlIO_printf( Perl_debug_log, " (%4"UVXf")\n", (UV)trie->trans[ state ].check );
1268 PerlIO_printf( Perl_debug_log, " (%4"UVXf") W%4X\n", (UV)trie->trans[ state ].check,
1269 trie->states[ TRIE_NODENUM( state ) ].wordnum );
1277 /* make_trie(startbranch,first,last,tail,word_count,flags,depth)
1278 startbranch: the first branch in the whole branch sequence
1279 first : start branch of sequence of branch-exact nodes.
1280 May be the same as startbranch
1281 last : Thing following the last branch.
1282 May be the same as tail.
1283 tail : item following the branch sequence
1284 count : words in the sequence
1285 flags : currently the OP() type we will be building one of /EXACT(|F|Fl)/
1286 depth : indent depth
1288 Inplace optimizes a sequence of 2 or more Branch-Exact nodes into a TRIE node.
1290 A trie is an N'ary tree where the branches are determined by digital
1291 decomposition of the key. IE, at the root node you look up the 1st character and
1292 follow that branch repeat until you find the end of the branches. Nodes can be
1293 marked as "accepting" meaning they represent a complete word. Eg:
1297 would convert into the following structure. Numbers represent states, letters
1298 following numbers represent valid transitions on the letter from that state, if
1299 the number is in square brackets it represents an accepting state, otherwise it
1300 will be in parenthesis.
1302 +-h->+-e->[3]-+-r->(8)-+-s->[9]
1306 (1) +-i->(6)-+-s->[7]
1308 +-s->(3)-+-h->(4)-+-e->[5]
1310 Accept Word Mapping: 3=>1 (he),5=>2 (she), 7=>3 (his), 9=>4 (hers)
1312 This shows that when matching against the string 'hers' we will begin at state 1
1313 read 'h' and move to state 2, read 'e' and move to state 3 which is accepting,
1314 then read 'r' and go to state 8 followed by 's' which takes us to state 9 which
1315 is also accepting. Thus we know that we can match both 'he' and 'hers' with a
1316 single traverse. We store a mapping from accepting to state to which word was
1317 matched, and then when we have multiple possibilities we try to complete the
1318 rest of the regex in the order in which they occured in the alternation.
1320 The only prior NFA like behaviour that would be changed by the TRIE support is
1321 the silent ignoring of duplicate alternations which are of the form:
1323 / (DUPE|DUPE) X? (?{ ... }) Y /x
1325 Thus EVAL blocks following a trie may be called a different number of times with
1326 and without the optimisation. With the optimisations dupes will be silently
1327 ignored. This inconsistent behaviour of EVAL type nodes is well established as
1328 the following demonstrates:
1330 'words'=~/(word|word|word)(?{ print $1 })[xyz]/
1332 which prints out 'word' three times, but
1334 'words'=~/(word|word|word)(?{ print $1 })S/
1336 which doesnt print it out at all. This is due to other optimisations kicking in.
1338 Example of what happens on a structural level:
1340 The regexp /(ac|ad|ab)+/ will produce the following debug output:
1342 1: CURLYM[1] {1,32767}(18)
1353 This would be optimizable with startbranch=5, first=5, last=16, tail=16
1354 and should turn into:
1356 1: CURLYM[1] {1,32767}(18)
1358 [Words:3 Chars Stored:6 Unique Chars:4 States:5 NCP:1]
1366 Cases where tail != last would be like /(?foo|bar)baz/:
1376 which would be optimizable with startbranch=1, first=1, last=7, tail=8
1377 and would end up looking like:
1380 [Words:2 Chars Stored:6 Unique Chars:5 States:7 NCP:1]
1387 d = uvuni_to_utf8_flags(d, uv, 0);
1389 is the recommended Unicode-aware way of saying
1394 #define TRIE_STORE_REVCHAR(val) \
1397 SV *zlopp = newSV(7); /* XXX: optimize me */ \
1398 unsigned char *flrbbbbb = (unsigned char *) SvPVX(zlopp); \
1399 unsigned const char *const kapow = uvuni_to_utf8(flrbbbbb, val); \
1400 SvCUR_set(zlopp, kapow - flrbbbbb); \
1403 av_push(revcharmap, zlopp); \
1405 char ooooff = (char)val; \
1406 av_push(revcharmap, newSVpvn(&ooooff, 1)); \
1410 #define TRIE_READ_CHAR STMT_START { \
1413 /* if it is UTF then it is either already folded, or does not need folding */ \
1414 uvc = utf8n_to_uvuni( (const U8*) uc, UTF8_MAXLEN, &len, uniflags); \
1416 else if (folder == PL_fold_latin1) { \
1417 /* if we use this folder we have to obey unicode rules on latin-1 data */ \
1418 if ( foldlen > 0 ) { \
1419 uvc = utf8n_to_uvuni( (const U8*) scan, UTF8_MAXLEN, &len, uniflags ); \
1425 uvc = _to_fold_latin1( (U8) *uc, foldbuf, &foldlen, 1); \
1426 skiplen = UNISKIP(uvc); \
1427 foldlen -= skiplen; \
1428 scan = foldbuf + skiplen; \
1431 /* raw data, will be folded later if needed */ \
1439 #define TRIE_LIST_PUSH(state,fid,ns) STMT_START { \
1440 if ( TRIE_LIST_CUR( state ) >=TRIE_LIST_LEN( state ) ) { \
1441 U32 ging = TRIE_LIST_LEN( state ) *= 2; \
1442 Renew( trie->states[ state ].trans.list, ging, reg_trie_trans_le ); \
1444 TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).forid = fid; \
1445 TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).newstate = ns; \
1446 TRIE_LIST_CUR( state )++; \
1449 #define TRIE_LIST_NEW(state) STMT_START { \
1450 Newxz( trie->states[ state ].trans.list, \
1451 4, reg_trie_trans_le ); \
1452 TRIE_LIST_CUR( state ) = 1; \
1453 TRIE_LIST_LEN( state ) = 4; \
1456 #define TRIE_HANDLE_WORD(state) STMT_START { \
1457 U16 dupe= trie->states[ state ].wordnum; \
1458 regnode * const noper_next = regnext( noper ); \
1461 /* store the word for dumping */ \
1463 if (OP(noper) != NOTHING) \
1464 tmp = newSVpvn_utf8(STRING(noper), STR_LEN(noper), UTF); \
1466 tmp = newSVpvn_utf8( "", 0, UTF ); \
1467 av_push( trie_words, tmp ); \
1471 trie->wordinfo[curword].prev = 0; \
1472 trie->wordinfo[curword].len = wordlen; \
1473 trie->wordinfo[curword].accept = state; \
1475 if ( noper_next < tail ) { \
1477 trie->jump = (U16 *) PerlMemShared_calloc( word_count + 1, sizeof(U16) ); \
1478 trie->jump[curword] = (U16)(noper_next - convert); \
1480 jumper = noper_next; \
1482 nextbranch= regnext(cur); \
1486 /* It's a dupe. Pre-insert into the wordinfo[].prev */\
1487 /* chain, so that when the bits of chain are later */\
1488 /* linked together, the dups appear in the chain */\
1489 trie->wordinfo[curword].prev = trie->wordinfo[dupe].prev; \
1490 trie->wordinfo[dupe].prev = curword; \
1492 /* we haven't inserted this word yet. */ \
1493 trie->states[ state ].wordnum = curword; \
1498 #define TRIE_TRANS_STATE(state,base,ucharcount,charid,special) \
1499 ( ( base + charid >= ucharcount \
1500 && base + charid < ubound \
1501 && state == trie->trans[ base - ucharcount + charid ].check \
1502 && trie->trans[ base - ucharcount + charid ].next ) \
1503 ? trie->trans[ base - ucharcount + charid ].next \
1504 : ( state==1 ? special : 0 ) \
1508 #define MADE_JUMP_TRIE 2
1509 #define MADE_EXACT_TRIE 4
1512 S_make_trie(pTHX_ RExC_state_t *pRExC_state, regnode *startbranch, regnode *first, regnode *last, regnode *tail, U32 word_count, U32 flags, U32 depth)
1515 /* first pass, loop through and scan words */
1516 reg_trie_data *trie;
1517 HV *widecharmap = NULL;
1518 AV *revcharmap = newAV();
1520 const U32 uniflags = UTF8_ALLOW_DEFAULT;
1525 regnode *jumper = NULL;
1526 regnode *nextbranch = NULL;
1527 regnode *convert = NULL;
1528 U32 *prev_states; /* temp array mapping each state to previous one */
1529 /* we just use folder as a flag in utf8 */
1530 const U8 * folder = NULL;
1533 const U32 data_slot = add_data( pRExC_state, 4, "tuuu" );
1534 AV *trie_words = NULL;
1535 /* along with revcharmap, this only used during construction but both are
1536 * useful during debugging so we store them in the struct when debugging.
1539 const U32 data_slot = add_data( pRExC_state, 2, "tu" );
1540 STRLEN trie_charcount=0;
1542 SV *re_trie_maxbuff;
1543 GET_RE_DEBUG_FLAGS_DECL;
1545 PERL_ARGS_ASSERT_MAKE_TRIE;
1547 PERL_UNUSED_ARG(depth);
1554 case EXACTFU_TRICKYFOLD:
1555 case EXACTFU: folder = PL_fold_latin1; break;
1556 case EXACTF: folder = PL_fold; break;
1557 case EXACTFL: folder = PL_fold_locale; break;
1558 default: Perl_croak( aTHX_ "panic! In trie construction, unknown node type %u %s", (unsigned) flags, PL_reg_name[flags] );
1561 trie = (reg_trie_data *) PerlMemShared_calloc( 1, sizeof(reg_trie_data) );
1563 trie->startstate = 1;
1564 trie->wordcount = word_count;
1565 RExC_rxi->data->data[ data_slot ] = (void*)trie;
1566 trie->charmap = (U16 *) PerlMemShared_calloc( 256, sizeof(U16) );
1568 trie->bitmap = (char *) PerlMemShared_calloc( ANYOF_BITMAP_SIZE, 1 );
1569 trie->wordinfo = (reg_trie_wordinfo *) PerlMemShared_calloc(
1570 trie->wordcount+1, sizeof(reg_trie_wordinfo));
1573 trie_words = newAV();
1576 re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
1577 if (!SvIOK(re_trie_maxbuff)) {
1578 sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
1580 DEBUG_TRIE_COMPILE_r({
1581 PerlIO_printf( Perl_debug_log,
1582 "%*smake_trie start==%d, first==%d, last==%d, tail==%d depth=%d\n",
1583 (int)depth * 2 + 2, "",
1584 REG_NODE_NUM(startbranch),REG_NODE_NUM(first),
1585 REG_NODE_NUM(last), REG_NODE_NUM(tail),
1589 /* Find the node we are going to overwrite */
1590 if ( first == startbranch && OP( last ) != BRANCH ) {
1591 /* whole branch chain */
1594 /* branch sub-chain */
1595 convert = NEXTOPER( first );
1598 /* -- First loop and Setup --
1600 We first traverse the branches and scan each word to determine if it
1601 contains widechars, and how many unique chars there are, this is
1602 important as we have to build a table with at least as many columns as we
1605 We use an array of integers to represent the character codes 0..255
1606 (trie->charmap) and we use a an HV* to store Unicode characters. We use the
1607 native representation of the character value as the key and IV's for the
1610 *TODO* If we keep track of how many times each character is used we can
1611 remap the columns so that the table compression later on is more
1612 efficient in terms of memory by ensuring the most common value is in the
1613 middle and the least common are on the outside. IMO this would be better
1614 than a most to least common mapping as theres a decent chance the most
1615 common letter will share a node with the least common, meaning the node
1616 will not be compressible. With a middle is most common approach the worst
1617 case is when we have the least common nodes twice.
1621 for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
1622 regnode *noper = NEXTOPER( cur );
1623 const U8 *uc = (U8*)STRING( noper );
1624 const U8 *e = uc + STR_LEN( noper );
1626 U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
1628 const U8 *scan = (U8*)NULL;
1629 U32 wordlen = 0; /* required init */
1631 bool set_bit = trie->bitmap ? 1 : 0; /*store the first char in the bitmap?*/
1633 if (OP(noper) == NOTHING) {
1634 regnode *noper_next= regnext(noper);
1635 if (noper_next != tail && OP(noper_next) == flags) {
1637 uc= (U8*)STRING(noper);
1638 e= uc + STR_LEN(noper);
1639 trie->minlen= STR_LEN(noper);
1646 if ( set_bit ) { /* bitmap only alloced when !(UTF&&Folding) */
1647 TRIE_BITMAP_SET(trie,*uc); /* store the raw first byte
1648 regardless of encoding */
1649 if (OP( noper ) == EXACTFU_SS) {
1650 /* false positives are ok, so just set this */
1651 TRIE_BITMAP_SET(trie,0xDF);
1654 for ( ; uc < e ; uc += len ) {
1655 TRIE_CHARCOUNT(trie)++;
1660 U8 folded= folder[ (U8) uvc ];
1661 if ( !trie->charmap[ folded ] ) {
1662 trie->charmap[ folded ]=( ++trie->uniquecharcount );
1663 TRIE_STORE_REVCHAR( folded );
1666 if ( !trie->charmap[ uvc ] ) {
1667 trie->charmap[ uvc ]=( ++trie->uniquecharcount );
1668 TRIE_STORE_REVCHAR( uvc );
1671 /* store the codepoint in the bitmap, and its folded
1673 TRIE_BITMAP_SET(trie, uvc);
1675 /* store the folded codepoint */
1676 if ( folder ) TRIE_BITMAP_SET(trie, folder[(U8) uvc ]);
1679 /* store first byte of utf8 representation of
1680 variant codepoints */
1681 if (! UNI_IS_INVARIANT(uvc)) {
1682 TRIE_BITMAP_SET(trie, UTF8_TWO_BYTE_HI(uvc));
1685 set_bit = 0; /* We've done our bit :-) */
1690 widecharmap = newHV();
1692 svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 1 );
1695 Perl_croak( aTHX_ "error creating/fetching widecharmap entry for 0x%"UVXf, uvc );
1697 if ( !SvTRUE( *svpp ) ) {
1698 sv_setiv( *svpp, ++trie->uniquecharcount );
1699 TRIE_STORE_REVCHAR(uvc);
1703 if( cur == first ) {
1704 trie->minlen = chars;
1705 trie->maxlen = chars;
1706 } else if (chars < trie->minlen) {
1707 trie->minlen = chars;
1708 } else if (chars > trie->maxlen) {
1709 trie->maxlen = chars;
1711 if (OP( noper ) == EXACTFU_SS) {
1712 /* XXX: workaround - 'ss' could match "\x{DF}" so minlen could be 1 and not 2*/
1713 if (trie->minlen > 1)
1716 if (OP( noper ) == EXACTFU_TRICKYFOLD) {
1717 /* XXX: workround - things like "\x{1FBE}\x{0308}\x{0301}" can match "\x{0390}"
1718 * - We assume that any such sequence might match a 2 byte string */
1719 if (trie->minlen > 2 )
1723 } /* end first pass */
1724 DEBUG_TRIE_COMPILE_r(
1725 PerlIO_printf( Perl_debug_log, "%*sTRIE(%s): W:%d C:%d Uq:%d Min:%d Max:%d\n",
1726 (int)depth * 2 + 2,"",
1727 ( widecharmap ? "UTF8" : "NATIVE" ), (int)word_count,
1728 (int)TRIE_CHARCOUNT(trie), trie->uniquecharcount,
1729 (int)trie->minlen, (int)trie->maxlen )
1733 We now know what we are dealing with in terms of unique chars and
1734 string sizes so we can calculate how much memory a naive
1735 representation using a flat table will take. If it's over a reasonable
1736 limit (as specified by ${^RE_TRIE_MAXBUF}) we use a more memory
1737 conservative but potentially much slower representation using an array
1740 At the end we convert both representations into the same compressed
1741 form that will be used in regexec.c for matching with. The latter
1742 is a form that cannot be used to construct with but has memory
1743 properties similar to the list form and access properties similar
1744 to the table form making it both suitable for fast searches and
1745 small enough that its feasable to store for the duration of a program.
1747 See the comment in the code where the compressed table is produced
1748 inplace from the flat tabe representation for an explanation of how
1749 the compression works.
1754 Newx(prev_states, TRIE_CHARCOUNT(trie) + 2, U32);
1757 if ( (IV)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1) > SvIV(re_trie_maxbuff) ) {
1759 Second Pass -- Array Of Lists Representation
1761 Each state will be represented by a list of charid:state records
1762 (reg_trie_trans_le) the first such element holds the CUR and LEN
1763 points of the allocated array. (See defines above).
1765 We build the initial structure using the lists, and then convert
1766 it into the compressed table form which allows faster lookups
1767 (but cant be modified once converted).
1770 STRLEN transcount = 1;
1772 DEBUG_TRIE_COMPILE_MORE_r( PerlIO_printf( Perl_debug_log,
1773 "%*sCompiling trie using list compiler\n",
1774 (int)depth * 2 + 2, ""));
1776 trie->states = (reg_trie_state *)
1777 PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
1778 sizeof(reg_trie_state) );
1782 for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
1784 regnode *noper = NEXTOPER( cur );
1785 U8 *uc = (U8*)STRING( noper );
1786 const U8 *e = uc + STR_LEN( noper );
1787 U32 state = 1; /* required init */
1788 U16 charid = 0; /* sanity init */
1789 U8 *scan = (U8*)NULL; /* sanity init */
1790 STRLEN foldlen = 0; /* required init */
1791 U32 wordlen = 0; /* required init */
1792 U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
1795 if (OP(noper) == NOTHING) {
1796 regnode *noper_next= regnext(noper);
1797 if (noper_next != tail && OP(noper_next) == flags) {
1799 uc= (U8*)STRING(noper);
1800 e= uc + STR_LEN(noper);
1804 if (OP(noper) != NOTHING) {
1805 for ( ; uc < e ; uc += len ) {
1810 charid = trie->charmap[ uvc ];
1812 SV** const svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 0);
1816 charid=(U16)SvIV( *svpp );
1819 /* charid is now 0 if we dont know the char read, or nonzero if we do */
1826 if ( !trie->states[ state ].trans.list ) {
1827 TRIE_LIST_NEW( state );
1829 for ( check = 1; check <= TRIE_LIST_USED( state ); check++ ) {
1830 if ( TRIE_LIST_ITEM( state, check ).forid == charid ) {
1831 newstate = TRIE_LIST_ITEM( state, check ).newstate;
1836 newstate = next_alloc++;
1837 prev_states[newstate] = state;
1838 TRIE_LIST_PUSH( state, charid, newstate );
1843 Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %"IVdf, uvc );
1847 TRIE_HANDLE_WORD(state);
1849 } /* end second pass */
1851 /* next alloc is the NEXT state to be allocated */
1852 trie->statecount = next_alloc;
1853 trie->states = (reg_trie_state *)
1854 PerlMemShared_realloc( trie->states,
1856 * sizeof(reg_trie_state) );
1858 /* and now dump it out before we compress it */
1859 DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_list(trie, widecharmap,
1860 revcharmap, next_alloc,
1864 trie->trans = (reg_trie_trans *)
1865 PerlMemShared_calloc( transcount, sizeof(reg_trie_trans) );
1872 for( state=1 ; state < next_alloc ; state ++ ) {
1876 DEBUG_TRIE_COMPILE_MORE_r(
1877 PerlIO_printf( Perl_debug_log, "tp: %d zp: %d ",tp,zp)
1881 if (trie->states[state].trans.list) {
1882 U16 minid=TRIE_LIST_ITEM( state, 1).forid;
1886 for( idx = 2 ; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
1887 const U16 forid = TRIE_LIST_ITEM( state, idx).forid;
1888 if ( forid < minid ) {
1890 } else if ( forid > maxid ) {
1894 if ( transcount < tp + maxid - minid + 1) {
1896 trie->trans = (reg_trie_trans *)
1897 PerlMemShared_realloc( trie->trans,
1899 * sizeof(reg_trie_trans) );
1900 Zero( trie->trans + (transcount / 2), transcount / 2 , reg_trie_trans );
1902 base = trie->uniquecharcount + tp - minid;
1903 if ( maxid == minid ) {
1905 for ( ; zp < tp ; zp++ ) {
1906 if ( ! trie->trans[ zp ].next ) {
1907 base = trie->uniquecharcount + zp - minid;
1908 trie->trans[ zp ].next = TRIE_LIST_ITEM( state, 1).newstate;
1909 trie->trans[ zp ].check = state;
1915 trie->trans[ tp ].next = TRIE_LIST_ITEM( state, 1).newstate;
1916 trie->trans[ tp ].check = state;
1921 for ( idx=1; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
1922 const U32 tid = base - trie->uniquecharcount + TRIE_LIST_ITEM( state, idx ).forid;
1923 trie->trans[ tid ].next = TRIE_LIST_ITEM( state, idx ).newstate;
1924 trie->trans[ tid ].check = state;
1926 tp += ( maxid - minid + 1 );
1928 Safefree(trie->states[ state ].trans.list);
1931 DEBUG_TRIE_COMPILE_MORE_r(
1932 PerlIO_printf( Perl_debug_log, " base: %d\n",base);
1935 trie->states[ state ].trans.base=base;
1937 trie->lasttrans = tp + 1;
1941 Second Pass -- Flat Table Representation.
1943 we dont use the 0 slot of either trans[] or states[] so we add 1 to each.
1944 We know that we will need Charcount+1 trans at most to store the data
1945 (one row per char at worst case) So we preallocate both structures
1946 assuming worst case.
1948 We then construct the trie using only the .next slots of the entry
1951 We use the .check field of the first entry of the node temporarily to
1952 make compression both faster and easier by keeping track of how many non
1953 zero fields are in the node.
1955 Since trans are numbered from 1 any 0 pointer in the table is a FAIL
1958 There are two terms at use here: state as a TRIE_NODEIDX() which is a
1959 number representing the first entry of the node, and state as a
1960 TRIE_NODENUM() which is the trans number. state 1 is TRIE_NODEIDX(1) and
1961 TRIE_NODENUM(1), state 2 is TRIE_NODEIDX(2) and TRIE_NODENUM(3) if there
1962 are 2 entrys per node. eg:
1970 The table is internally in the right hand, idx form. However as we also
1971 have to deal with the states array which is indexed by nodenum we have to
1972 use TRIE_NODENUM() to convert.
1975 DEBUG_TRIE_COMPILE_MORE_r( PerlIO_printf( Perl_debug_log,
1976 "%*sCompiling trie using table compiler\n",
1977 (int)depth * 2 + 2, ""));
1979 trie->trans = (reg_trie_trans *)
1980 PerlMemShared_calloc( ( TRIE_CHARCOUNT(trie) + 1 )
1981 * trie->uniquecharcount + 1,
1982 sizeof(reg_trie_trans) );
1983 trie->states = (reg_trie_state *)
1984 PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
1985 sizeof(reg_trie_state) );
1986 next_alloc = trie->uniquecharcount + 1;
1989 for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
1991 regnode *noper = NEXTOPER( cur );
1992 const U8 *uc = (U8*)STRING( noper );
1993 const U8 *e = uc + STR_LEN( noper );
1995 U32 state = 1; /* required init */
1997 U16 charid = 0; /* sanity init */
1998 U32 accept_state = 0; /* sanity init */
1999 U8 *scan = (U8*)NULL; /* sanity init */
2001 STRLEN foldlen = 0; /* required init */
2002 U32 wordlen = 0; /* required init */
2004 U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
2006 if (OP(noper) == NOTHING) {
2007 regnode *noper_next= regnext(noper);
2008 if (noper_next != tail && OP(noper_next) == flags) {
2010 uc= (U8*)STRING(noper);
2011 e= uc + STR_LEN(noper);
2015 if ( OP(noper) != NOTHING ) {
2016 for ( ; uc < e ; uc += len ) {
2021 charid = trie->charmap[ uvc ];
2023 SV* const * const svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 0);
2024 charid = svpp ? (U16)SvIV(*svpp) : 0;
2028 if ( !trie->trans[ state + charid ].next ) {
2029 trie->trans[ state + charid ].next = next_alloc;
2030 trie->trans[ state ].check++;
2031 prev_states[TRIE_NODENUM(next_alloc)]
2032 = TRIE_NODENUM(state);
2033 next_alloc += trie->uniquecharcount;
2035 state = trie->trans[ state + charid ].next;
2037 Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %"IVdf, uvc );
2039 /* charid is now 0 if we dont know the char read, or nonzero if we do */
2042 accept_state = TRIE_NODENUM( state );
2043 TRIE_HANDLE_WORD(accept_state);
2045 } /* end second pass */
2047 /* and now dump it out before we compress it */
2048 DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_table(trie, widecharmap,
2050 next_alloc, depth+1));
2054 * Inplace compress the table.*
2056 For sparse data sets the table constructed by the trie algorithm will
2057 be mostly 0/FAIL transitions or to put it another way mostly empty.
2058 (Note that leaf nodes will not contain any transitions.)
2060 This algorithm compresses the tables by eliminating most such
2061 transitions, at the cost of a modest bit of extra work during lookup:
2063 - Each states[] entry contains a .base field which indicates the
2064 index in the state[] array wheres its transition data is stored.
2066 - If .base is 0 there are no valid transitions from that node.
2068 - If .base is nonzero then charid is added to it to find an entry in
2071 -If trans[states[state].base+charid].check!=state then the
2072 transition is taken to be a 0/Fail transition. Thus if there are fail
2073 transitions at the front of the node then the .base offset will point
2074 somewhere inside the previous nodes data (or maybe even into a node
2075 even earlier), but the .check field determines if the transition is
2079 The following process inplace converts the table to the compressed
2080 table: We first do not compress the root node 1,and mark all its
2081 .check pointers as 1 and set its .base pointer as 1 as well. This
2082 allows us to do a DFA construction from the compressed table later,
2083 and ensures that any .base pointers we calculate later are greater
2086 - We set 'pos' to indicate the first entry of the second node.
2088 - We then iterate over the columns of the node, finding the first and
2089 last used entry at l and m. We then copy l..m into pos..(pos+m-l),
2090 and set the .check pointers accordingly, and advance pos
2091 appropriately and repreat for the next node. Note that when we copy
2092 the next pointers we have to convert them from the original
2093 NODEIDX form to NODENUM form as the former is not valid post
2096 - If a node has no transitions used we mark its base as 0 and do not
2097 advance the pos pointer.
2099 - If a node only has one transition we use a second pointer into the
2100 structure to fill in allocated fail transitions from other states.
2101 This pointer is independent of the main pointer and scans forward
2102 looking for null transitions that are allocated to a state. When it
2103 finds one it writes the single transition into the "hole". If the
2104 pointer doesnt find one the single transition is appended as normal.
2106 - Once compressed we can Renew/realloc the structures to release the
2109 See "Table-Compression Methods" in sec 3.9 of the Red Dragon,
2110 specifically Fig 3.47 and the associated pseudocode.
2114 const U32 laststate = TRIE_NODENUM( next_alloc );
2117 trie->statecount = laststate;
2119 for ( state = 1 ; state < laststate ; state++ ) {
2121 const U32 stateidx = TRIE_NODEIDX( state );
2122 const U32 o_used = trie->trans[ stateidx ].check;
2123 U32 used = trie->trans[ stateidx ].check;
2124 trie->trans[ stateidx ].check = 0;
2126 for ( charid = 0 ; used && charid < trie->uniquecharcount ; charid++ ) {
2127 if ( flag || trie->trans[ stateidx + charid ].next ) {
2128 if ( trie->trans[ stateidx + charid ].next ) {
2130 for ( ; zp < pos ; zp++ ) {
2131 if ( ! trie->trans[ zp ].next ) {
2135 trie->states[ state ].trans.base = zp + trie->uniquecharcount - charid ;
2136 trie->trans[ zp ].next = SAFE_TRIE_NODENUM( trie->trans[ stateidx + charid ].next );
2137 trie->trans[ zp ].check = state;
2138 if ( ++zp > pos ) pos = zp;
2145 trie->states[ state ].trans.base = pos + trie->uniquecharcount - charid ;
2147 trie->trans[ pos ].next = SAFE_TRIE_NODENUM( trie->trans[ stateidx + charid ].next );
2148 trie->trans[ pos ].check = state;
2153 trie->lasttrans = pos + 1;
2154 trie->states = (reg_trie_state *)
2155 PerlMemShared_realloc( trie->states, laststate
2156 * sizeof(reg_trie_state) );
2157 DEBUG_TRIE_COMPILE_MORE_r(
2158 PerlIO_printf( Perl_debug_log,
2159 "%*sAlloc: %d Orig: %"IVdf" elements, Final:%"IVdf". Savings of %%%5.2f\n",
2160 (int)depth * 2 + 2,"",
2161 (int)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1 ),
2164 ( ( next_alloc - pos ) * 100 ) / (double)next_alloc );
2167 } /* end table compress */
2169 DEBUG_TRIE_COMPILE_MORE_r(
2170 PerlIO_printf(Perl_debug_log, "%*sStatecount:%"UVxf" Lasttrans:%"UVxf"\n",
2171 (int)depth * 2 + 2, "",
2172 (UV)trie->statecount,
2173 (UV)trie->lasttrans)
2175 /* resize the trans array to remove unused space */
2176 trie->trans = (reg_trie_trans *)
2177 PerlMemShared_realloc( trie->trans, trie->lasttrans
2178 * sizeof(reg_trie_trans) );
2180 { /* Modify the program and insert the new TRIE node */
2181 U8 nodetype =(U8)(flags & 0xFF);
2185 regnode *optimize = NULL;
2186 #ifdef RE_TRACK_PATTERN_OFFSETS
2189 U32 mjd_nodelen = 0;
2190 #endif /* RE_TRACK_PATTERN_OFFSETS */
2191 #endif /* DEBUGGING */
2193 This means we convert either the first branch or the first Exact,
2194 depending on whether the thing following (in 'last') is a branch
2195 or not and whther first is the startbranch (ie is it a sub part of
2196 the alternation or is it the whole thing.)
2197 Assuming its a sub part we convert the EXACT otherwise we convert
2198 the whole branch sequence, including the first.
2200 /* Find the node we are going to overwrite */
2201 if ( first != startbranch || OP( last ) == BRANCH ) {
2202 /* branch sub-chain */
2203 NEXT_OFF( first ) = (U16)(last - first);
2204 #ifdef RE_TRACK_PATTERN_OFFSETS
2206 mjd_offset= Node_Offset((convert));
2207 mjd_nodelen= Node_Length((convert));
2210 /* whole branch chain */
2212 #ifdef RE_TRACK_PATTERN_OFFSETS
2215 const regnode *nop = NEXTOPER( convert );
2216 mjd_offset= Node_Offset((nop));
2217 mjd_nodelen= Node_Length((nop));
2221 PerlIO_printf(Perl_debug_log, "%*sMJD offset:%"UVuf" MJD length:%"UVuf"\n",
2222 (int)depth * 2 + 2, "",
2223 (UV)mjd_offset, (UV)mjd_nodelen)
2226 /* But first we check to see if there is a common prefix we can
2227 split out as an EXACT and put in front of the TRIE node. */
2228 trie->startstate= 1;
2229 if ( trie->bitmap && !widecharmap && !trie->jump ) {
2231 for ( state = 1 ; state < trie->statecount-1 ; state++ ) {
2235 const U32 base = trie->states[ state ].trans.base;
2237 if ( trie->states[state].wordnum )
2240 for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
2241 if ( ( base + ofs >= trie->uniquecharcount ) &&
2242 ( base + ofs - trie->uniquecharcount < trie->lasttrans ) &&
2243 trie->trans[ base + ofs - trie->uniquecharcount ].check == state )
2245 if ( ++count > 1 ) {
2246 SV **tmp = av_fetch( revcharmap, ofs, 0);
2247 const U8 *ch = (U8*)SvPV_nolen_const( *tmp );
2248 if ( state == 1 ) break;
2250 Zero(trie->bitmap, ANYOF_BITMAP_SIZE, char);
2252 PerlIO_printf(Perl_debug_log,
2253 "%*sNew Start State=%"UVuf" Class: [",
2254 (int)depth * 2 + 2, "",
2257 SV ** const tmp = av_fetch( revcharmap, idx, 0);
2258 const U8 * const ch = (U8*)SvPV_nolen_const( *tmp );
2260 TRIE_BITMAP_SET(trie,*ch);
2262 TRIE_BITMAP_SET(trie, folder[ *ch ]);
2264 PerlIO_printf(Perl_debug_log, "%s", (char*)ch)
2268 TRIE_BITMAP_SET(trie,*ch);
2270 TRIE_BITMAP_SET(trie,folder[ *ch ]);
2271 DEBUG_OPTIMISE_r(PerlIO_printf( Perl_debug_log,"%s", ch));
2277 SV **tmp = av_fetch( revcharmap, idx, 0);
2279 char *ch = SvPV( *tmp, len );
2281 SV *sv=sv_newmortal();
2282 PerlIO_printf( Perl_debug_log,
2283 "%*sPrefix State: %"UVuf" Idx:%"UVuf" Char='%s'\n",
2284 (int)depth * 2 + 2, "",
2286 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), 6,
2287 PL_colors[0], PL_colors[1],
2288 (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
2289 PERL_PV_ESCAPE_FIRSTCHAR
2294 OP( convert ) = nodetype;
2295 str=STRING(convert);
2298 STR_LEN(convert) += len;
2304 DEBUG_OPTIMISE_r(PerlIO_printf( Perl_debug_log,"]\n"));
2309 trie->prefixlen = (state-1);
2311 regnode *n = convert+NODE_SZ_STR(convert);
2312 NEXT_OFF(convert) = NODE_SZ_STR(convert);
2313 trie->startstate = state;
2314 trie->minlen -= (state - 1);
2315 trie->maxlen -= (state - 1);
2317 /* At least the UNICOS C compiler choked on this
2318 * being argument to DEBUG_r(), so let's just have
2321 #ifdef PERL_EXT_RE_BUILD
2327 regnode *fix = convert;
2328 U32 word = trie->wordcount;
2330 Set_Node_Offset_Length(convert, mjd_offset, state - 1);
2331 while( ++fix < n ) {
2332 Set_Node_Offset_Length(fix, 0, 0);
2335 SV ** const tmp = av_fetch( trie_words, word, 0 );
2337 if ( STR_LEN(convert) <= SvCUR(*tmp) )
2338 sv_chop(*tmp, SvPV_nolen(*tmp) + STR_LEN(convert));
2340 sv_chop(*tmp, SvPV_nolen(*tmp) + SvCUR(*tmp));
2348 NEXT_OFF(convert) = (U16)(tail - convert);
2349 DEBUG_r(optimize= n);
2355 if ( trie->maxlen ) {
2356 NEXT_OFF( convert ) = (U16)(tail - convert);
2357 ARG_SET( convert, data_slot );
2358 /* Store the offset to the first unabsorbed branch in
2359 jump[0], which is otherwise unused by the jump logic.
2360 We use this when dumping a trie and during optimisation. */
2362 trie->jump[0] = (U16)(nextbranch - convert);
2364 /* If the start state is not accepting (meaning there is no empty string/NOTHING)
2365 * and there is a bitmap
2366 * and the first "jump target" node we found leaves enough room
2367 * then convert the TRIE node into a TRIEC node, with the bitmap
2368 * embedded inline in the opcode - this is hypothetically faster.
2370 if ( !trie->states[trie->startstate].wordnum
2372 && ( (char *)jumper - (char *)convert) >= (int)sizeof(struct regnode_charclass) )
2374 OP( convert ) = TRIEC;
2375 Copy(trie->bitmap, ((struct regnode_charclass *)convert)->bitmap, ANYOF_BITMAP_SIZE, char);
2376 PerlMemShared_free(trie->bitmap);
2379 OP( convert ) = TRIE;
2381 /* store the type in the flags */
2382 convert->flags = nodetype;
2386 + regarglen[ OP( convert ) ];
2388 /* XXX We really should free up the resource in trie now,
2389 as we won't use them - (which resources?) dmq */
2391 /* needed for dumping*/
2392 DEBUG_r(if (optimize) {
2393 regnode *opt = convert;
2395 while ( ++opt < optimize) {
2396 Set_Node_Offset_Length(opt,0,0);
2399 Try to clean up some of the debris left after the
2402 while( optimize < jumper ) {
2403 mjd_nodelen += Node_Length((optimize));
2404 OP( optimize ) = OPTIMIZED;
2405 Set_Node_Offset_Length(optimize,0,0);
2408 Set_Node_Offset_Length(convert,mjd_offset,mjd_nodelen);
2410 } /* end node insert */
2412 /* Finish populating the prev field of the wordinfo array. Walk back
2413 * from each accept state until we find another accept state, and if
2414 * so, point the first word's .prev field at the second word. If the
2415 * second already has a .prev field set, stop now. This will be the
2416 * case either if we've already processed that word's accept state,
2417 * or that state had multiple words, and the overspill words were
2418 * already linked up earlier.
2425 for (word=1; word <= trie->wordcount; word++) {
2427 if (trie->wordinfo[word].prev)
2429 state = trie->wordinfo[word].accept;
2431 state = prev_states[state];
2434 prev = trie->states[state].wordnum;
2438 trie->wordinfo[word].prev = prev;
2440 Safefree(prev_states);
2444 /* and now dump out the compressed format */
2445 DEBUG_TRIE_COMPILE_r(dump_trie(trie, widecharmap, revcharmap, depth+1));
2447 RExC_rxi->data->data[ data_slot + 1 ] = (void*)widecharmap;
2449 RExC_rxi->data->data[ data_slot + TRIE_WORDS_OFFSET ] = (void*)trie_words;
2450 RExC_rxi->data->data[ data_slot + 3 ] = (void*)revcharmap;
2452 SvREFCNT_dec(revcharmap);
2456 : trie->startstate>1
2462 S_make_trie_failtable(pTHX_ RExC_state_t *pRExC_state, regnode *source, regnode *stclass, U32 depth)
2464 /* The Trie is constructed and compressed now so we can build a fail array if it's needed
2466 This is basically the Aho-Corasick algorithm. Its from exercise 3.31 and 3.32 in the
2467 "Red Dragon" -- Compilers, principles, techniques, and tools. Aho, Sethi, Ullman 1985/88
2470 We find the fail state for each state in the trie, this state is the longest proper
2471 suffix of the current state's 'word' that is also a proper prefix of another word in our
2472 trie. State 1 represents the word '' and is thus the default fail state. This allows
2473 the DFA not to have to restart after its tried and failed a word at a given point, it
2474 simply continues as though it had been matching the other word in the first place.
2476 'abcdgu'=~/abcdefg|cdgu/
2477 When we get to 'd' we are still matching the first word, we would encounter 'g' which would
2478 fail, which would bring us to the state representing 'd' in the second word where we would
2479 try 'g' and succeed, proceeding to match 'cdgu'.
2481 /* add a fail transition */
2482 const U32 trie_offset = ARG(source);
2483 reg_trie_data *trie=(reg_trie_data *)RExC_rxi->data->data[trie_offset];
2485 const U32 ucharcount = trie->uniquecharcount;
2486 const U32 numstates = trie->statecount;
2487 const U32 ubound = trie->lasttrans + ucharcount;
2491 U32 base = trie->states[ 1 ].trans.base;
2494 const U32 data_slot = add_data( pRExC_state, 1, "T" );
2495 GET_RE_DEBUG_FLAGS_DECL;
2497 PERL_ARGS_ASSERT_MAKE_TRIE_FAILTABLE;
2499 PERL_UNUSED_ARG(depth);
2503 ARG_SET( stclass, data_slot );
2504 aho = (reg_ac_data *) PerlMemShared_calloc( 1, sizeof(reg_ac_data) );
2505 RExC_rxi->data->data[ data_slot ] = (void*)aho;
2506 aho->trie=trie_offset;
2507 aho->states=(reg_trie_state *)PerlMemShared_malloc( numstates * sizeof(reg_trie_state) );
2508 Copy( trie->states, aho->states, numstates, reg_trie_state );
2509 Newxz( q, numstates, U32);
2510 aho->fail = (U32 *) PerlMemShared_calloc( numstates, sizeof(U32) );
2513 /* initialize fail[0..1] to be 1 so that we always have
2514 a valid final fail state */
2515 fail[ 0 ] = fail[ 1 ] = 1;
2517 for ( charid = 0; charid < ucharcount ; charid++ ) {
2518 const U32 newstate = TRIE_TRANS_STATE( 1, base, ucharcount, charid, 0 );
2520 q[ q_write ] = newstate;
2521 /* set to point at the root */
2522 fail[ q[ q_write++ ] ]=1;
2525 while ( q_read < q_write) {
2526 const U32 cur = q[ q_read++ % numstates ];
2527 base = trie->states[ cur ].trans.base;
2529 for ( charid = 0 ; charid < ucharcount ; charid++ ) {
2530 const U32 ch_state = TRIE_TRANS_STATE( cur, base, ucharcount, charid, 1 );
2532 U32 fail_state = cur;
2535 fail_state = fail[ fail_state ];
2536 fail_base = aho->states[ fail_state ].trans.base;
2537 } while ( !TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 ) );
2539 fail_state = TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 );
2540 fail[ ch_state ] = fail_state;
2541 if ( !aho->states[ ch_state ].wordnum && aho->states[ fail_state ].wordnum )
2543 aho->states[ ch_state ].wordnum = aho->states[ fail_state ].wordnum;
2545 q[ q_write++ % numstates] = ch_state;
2549 /* restore fail[0..1] to 0 so that we "fall out" of the AC loop
2550 when we fail in state 1, this allows us to use the
2551 charclass scan to find a valid start char. This is based on the principle
2552 that theres a good chance the string being searched contains lots of stuff
2553 that cant be a start char.
2555 fail[ 0 ] = fail[ 1 ] = 0;
2556 DEBUG_TRIE_COMPILE_r({
2557 PerlIO_printf(Perl_debug_log,
2558 "%*sStclass Failtable (%"UVuf" states): 0",
2559 (int)(depth * 2), "", (UV)numstates
2561 for( q_read=1; q_read<numstates; q_read++ ) {
2562 PerlIO_printf(Perl_debug_log, ", %"UVuf, (UV)fail[q_read]);
2564 PerlIO_printf(Perl_debug_log, "\n");
2567 /*RExC_seen |= REG_SEEN_TRIEDFA;*/
2572 * There are strange code-generation bugs caused on sparc64 by gcc-2.95.2.
2573 * These need to be revisited when a newer toolchain becomes available.
2575 #if defined(__sparc64__) && defined(__GNUC__)
2576 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 96)
2577 # undef SPARC64_GCC_WORKAROUND
2578 # define SPARC64_GCC_WORKAROUND 1
2582 #define DEBUG_PEEP(str,scan,depth) \
2583 DEBUG_OPTIMISE_r({if (scan){ \
2584 SV * const mysv=sv_newmortal(); \
2585 regnode *Next = regnext(scan); \
2586 regprop(RExC_rx, mysv, scan); \
2587 PerlIO_printf(Perl_debug_log, "%*s" str ">%3d: %s (%d)\n", \
2588 (int)depth*2, "", REG_NODE_NUM(scan), SvPV_nolen_const(mysv),\
2589 Next ? (REG_NODE_NUM(Next)) : 0 ); \
2593 /* The below joins as many adjacent EXACTish nodes as possible into a single
2594 * one. The regop may be changed if the node(s) contain certain sequences that
2595 * require special handling. The joining is only done if:
2596 * 1) there is room in the current conglomerated node to entirely contain the
2598 * 2) they are the exact same node type
2600 * The adjacent nodes actually may be separated by NOTHING-kind nodes, and
2601 * these get optimized out
2603 * If a node is to match under /i (folded), the number of characters it matches
2604 * can be different than its character length if it contains a multi-character
2605 * fold. *min_subtract is set to the total delta of the input nodes.
2607 * And *has_exactf_sharp_s is set to indicate whether or not the node is EXACTF
2608 * and contains LATIN SMALL LETTER SHARP S
2610 * This is as good a place as any to discuss the design of handling these
2611 * multi-character fold sequences. It's been wrong in Perl for a very long
2612 * time. There are three code points in Unicode whose multi-character folds
2613 * were long ago discovered to mess things up. The previous designs for
2614 * dealing with these involved assigning a special node for them. This
2615 * approach doesn't work, as evidenced by this example:
2616 * "\xDFs" =~ /s\xDF/ui # Used to fail before these patches
2617 * Both these fold to "sss", but if the pattern is parsed to create a node that
2618 * would match just the \xDF, it won't be able to handle the case where a
2619 * successful match would have to cross the node's boundary. The new approach
2620 * that hopefully generally solves the problem generates an EXACTFU_SS node
2623 * It turns out that there are problems with all multi-character folds, and not
2624 * just these three. Now the code is general, for all such cases, but the
2625 * three still have some special handling. The approach taken is:
2626 * 1) This routine examines each EXACTFish node that could contain multi-
2627 * character fold sequences. It returns in *min_subtract how much to
2628 * subtract from the the actual length of the string to get a real minimum
2629 * match length; it is 0 if there are no multi-char folds. This delta is
2630 * used by the caller to adjust the min length of the match, and the delta
2631 * between min and max, so that the optimizer doesn't reject these
2632 * possibilities based on size constraints.
2633 * 2) Certain of these sequences require special handling by the trie code,
2634 * so, if found, this code changes the joined node type to special ops:
2635 * EXACTFU_TRICKYFOLD and EXACTFU_SS.
2636 * 3) For the sequence involving the Sharp s (\xDF), the node type EXACTFU_SS
2637 * is used for an EXACTFU node that contains at least one "ss" sequence in
2638 * it. For non-UTF-8 patterns and strings, this is the only case where
2639 * there is a possible fold length change. That means that a regular
2640 * EXACTFU node without UTF-8 involvement doesn't have to concern itself
2641 * with length changes, and so can be processed faster. regexec.c takes
2642 * advantage of this. Generally, an EXACTFish node that is in UTF-8 is
2643 * pre-folded by regcomp.c. This saves effort in regex matching.
2644 * However, the pre-folding isn't done for non-UTF8 patterns because the
2645 * fold of the MICRO SIGN requires UTF-8, and we don't want to slow things
2646 * down by forcing the pattern into UTF8 unless necessary. Also what
2647 * EXACTF and EXACTFL nodes fold to isn't known until runtime. The fold
2648 * possibilities for the non-UTF8 patterns are quite simple, except for
2649 * the sharp s. All the ones that don't involve a UTF-8 target string are
2650 * members of a fold-pair, and arrays are set up for all of them so that
2651 * the other member of the pair can be found quickly. Code elsewhere in
2652 * this file makes sure that in EXACTFU nodes, the sharp s gets folded to
2653 * 'ss', even if the pattern isn't UTF-8. This avoids the issues
2654 * described in the next item.
2655 * 4) A problem remains for the sharp s in EXACTF nodes. Whether it matches
2656 * 'ss' or not is not knowable at compile time. It will match iff the
2657 * target string is in UTF-8, unlike the EXACTFU nodes, where it always
2658 * matches; and the EXACTFL and EXACTFA nodes where it never does. Thus
2659 * it can't be folded to "ss" at compile time, unlike EXACTFU does (as
2660 * described in item 3). An assumption that the optimizer part of
2661 * regexec.c (probably unwittingly) makes is that a character in the
2662 * pattern corresponds to at most a single character in the target string.
2663 * (And I do mean character, and not byte here, unlike other parts of the
2664 * documentation that have never been updated to account for multibyte
2665 * Unicode.) This assumption is wrong only in this case, as all other
2666 * cases are either 1-1 folds when no UTF-8 is involved; or is true by
2667 * virtue of having this file pre-fold UTF-8 patterns. I'm
2668 * reluctant to try to change this assumption, so instead the code punts.
2669 * This routine examines EXACTF nodes for the sharp s, and returns a
2670 * boolean indicating whether or not the node is an EXACTF node that
2671 * contains a sharp s. When it is true, the caller sets a flag that later
2672 * causes the optimizer in this file to not set values for the floating
2673 * and fixed string lengths, and thus avoids the optimizer code in
2674 * regexec.c that makes the invalid assumption. Thus, there is no
2675 * optimization based on string lengths for EXACTF nodes that contain the
2676 * sharp s. This only happens for /id rules (which means the pattern
2680 #define JOIN_EXACT(scan,min_subtract,has_exactf_sharp_s, flags) \
2681 if (PL_regkind[OP(scan)] == EXACT) \
2682 join_exact(pRExC_state,(scan),(min_subtract),has_exactf_sharp_s, (flags),NULL,depth+1)
2685 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) {
2686 /* Merge several consecutive EXACTish nodes into one. */
2687 regnode *n = regnext(scan);
2689 regnode *next = scan + NODE_SZ_STR(scan);
2693 regnode *stop = scan;
2694 GET_RE_DEBUG_FLAGS_DECL;
2696 PERL_UNUSED_ARG(depth);
2699 PERL_ARGS_ASSERT_JOIN_EXACT;
2700 #ifndef EXPERIMENTAL_INPLACESCAN
2701 PERL_UNUSED_ARG(flags);
2702 PERL_UNUSED_ARG(val);
2704 DEBUG_PEEP("join",scan,depth);
2706 /* Look through the subsequent nodes in the chain. Skip NOTHING, merge
2707 * EXACT ones that are mergeable to the current one. */
2709 && (PL_regkind[OP(n)] == NOTHING
2710 || (stringok && OP(n) == OP(scan)))
2712 && NEXT_OFF(scan) + NEXT_OFF(n) < I16_MAX)
2715 if (OP(n) == TAIL || n > next)
2717 if (PL_regkind[OP(n)] == NOTHING) {
2718 DEBUG_PEEP("skip:",n,depth);
2719 NEXT_OFF(scan) += NEXT_OFF(n);
2720 next = n + NODE_STEP_REGNODE;
2727 else if (stringok) {
2728 const unsigned int oldl = STR_LEN(scan);
2729 regnode * const nnext = regnext(n);
2731 /* XXX I (khw) kind of doubt that this works on platforms where
2732 * U8_MAX is above 255 because of lots of other assumptions */
2733 if (oldl + STR_LEN(n) > U8_MAX)
2736 DEBUG_PEEP("merg",n,depth);
2739 NEXT_OFF(scan) += NEXT_OFF(n);
2740 STR_LEN(scan) += STR_LEN(n);
2741 next = n + NODE_SZ_STR(n);
2742 /* Now we can overwrite *n : */
2743 Move(STRING(n), STRING(scan) + oldl, STR_LEN(n), char);
2751 #ifdef EXPERIMENTAL_INPLACESCAN
2752 if (flags && !NEXT_OFF(n)) {
2753 DEBUG_PEEP("atch", val, depth);
2754 if (reg_off_by_arg[OP(n)]) {
2755 ARG_SET(n, val - n);
2758 NEXT_OFF(n) = val - n;
2766 *has_exactf_sharp_s = FALSE;
2768 /* Here, all the adjacent mergeable EXACTish nodes have been merged. We
2769 * can now analyze for sequences of problematic code points. (Prior to
2770 * this final joining, sequences could have been split over boundaries, and
2771 * hence missed). The sequences only happen in folding, hence for any
2772 * non-EXACT EXACTish node */
2773 if (OP(scan) != EXACT) {
2774 const U8 * const s0 = (U8*) STRING(scan);
2776 const U8 * const s_end = s0 + STR_LEN(scan);
2778 /* One pass is made over the node's string looking for all the
2779 * possibilities. to avoid some tests in the loop, there are two main
2780 * cases, for UTF-8 patterns (which can't have EXACTF nodes) and
2784 /* Examine the string for a multi-character fold sequence. UTF-8
2785 * patterns have all characters pre-folded by the time this code is
2787 while (s < s_end - 1) /* Can stop 1 before the end, as minimum
2788 length sequence we are looking for is 2 */
2791 int len = is_MULTI_CHAR_FOLD_utf8_safe(s, s_end);
2792 if (! len) { /* Not a multi-char fold: get next char */
2797 /* Nodes with 'ss' require special handling, except for EXACTFL
2798 * and EXACTFA for which there is no multi-char fold to this */
2799 if (len == 2 && *s == 's' && *(s+1) == 's'
2800 && OP(scan) != EXACTFL && OP(scan) != EXACTFA)
2803 OP(scan) = EXACTFU_SS;
2806 else if (len == 6 /* len is the same in both ASCII and EBCDIC for these */
2807 && (memEQ(s, GREEK_SMALL_LETTER_IOTA_UTF8
2808 COMBINING_DIAERESIS_UTF8
2809 COMBINING_ACUTE_ACCENT_UTF8,
2811 || memEQ(s, GREEK_SMALL_LETTER_UPSILON_UTF8
2812 COMBINING_DIAERESIS_UTF8
2813 COMBINING_ACUTE_ACCENT_UTF8,
2818 /* These two folds require special handling by trie's, so
2819 * change the node type to indicate this. If EXACTFA and
2820 * EXACTFL were ever to be handled by trie's, this would
2821 * have to be changed. If this node has already been
2822 * changed to EXACTFU_SS in this loop, leave it as is. (I
2823 * (khw) think it doesn't matter in regexec.c for UTF
2824 * patterns, but no need to change it */
2825 if (OP(scan) == EXACTFU) {
2826 OP(scan) = EXACTFU_TRICKYFOLD;
2830 else { /* Here is a generic multi-char fold. */
2831 const U8* multi_end = s + len;
2833 /* Count how many characters in it. In the case of /l and
2834 * /aa, no folds which contain ASCII code points are
2835 * allowed, so check for those, and skip if found. (In
2836 * EXACTFL, no folds are allowed to any Latin1 code point,
2837 * not just ASCII. But there aren't any of these
2838 * currently, nor ever likely, so don't take the time to
2839 * test for them. The code that generates the
2840 * is_MULTI_foo() macros croaks should one actually get put
2841 * into Unicode .) */
2842 if (OP(scan) != EXACTFL && OP(scan) != EXACTFA) {
2843 count = utf8_length(s, multi_end);
2847 while (s < multi_end) {
2850 goto next_iteration;
2860 /* The delta is how long the sequence is minus 1 (1 is how long
2861 * the character that folds to the sequence is) */
2862 *min_subtract += count - 1;
2866 else if (OP(scan) != EXACTFL && OP(scan) != EXACTFA) {
2868 /* Here, the pattern is not UTF-8. Look for the multi-char folds
2869 * that are all ASCII. As in the above case, EXACTFL and EXACTFA
2870 * nodes can't have multi-char folds to this range (and there are
2871 * no existing ones in the upper latin1 range). In the EXACTF
2872 * case we look also for the sharp s, which can be in the final
2873 * position. Otherwise we can stop looking 1 byte earlier because
2874 * have to find at least two characters for a multi-fold */
2875 const U8* upper = (OP(scan) == EXACTF) ? s_end : s_end -1;
2877 /* The below is perhaps overboard, but this allows us to save a
2878 * test each time through the loop at the expense of a mask. This
2879 * is because on both EBCDIC and ASCII machines, 'S' and 's' differ
2880 * by a single bit. On ASCII they are 32 apart; on EBCDIC, they
2881 * are 64. This uses an exclusive 'or' to find that bit and then
2882 * inverts it to form a mask, with just a single 0, in the bit
2883 * position where 'S' and 's' differ. */
2884 const U8 S_or_s_mask = (U8) ~ ('S' ^ 's');
2885 const U8 s_masked = 's' & S_or_s_mask;
2888 int len = is_MULTI_CHAR_FOLD_latin1_safe(s, s_end);
2889 if (! len) { /* Not a multi-char fold. */
2890 if (*s == LATIN_SMALL_LETTER_SHARP_S && OP(scan) == EXACTF)
2892 *has_exactf_sharp_s = TRUE;
2899 && ((*s & S_or_s_mask) == s_masked)
2900 && ((*(s+1) & S_or_s_mask) == s_masked))
2903 /* EXACTF nodes need to know that the minimum length
2904 * changed so that a sharp s in the string can match this
2905 * ss in the pattern, but they remain EXACTF nodes, as they
2906 * won't match this unless the target string is is UTF-8,
2907 * which we don't know until runtime */
2908 if (OP(scan) != EXACTF) {
2909 OP(scan) = EXACTFU_SS;
2913 *min_subtract += len - 1;
2920 /* Allow dumping but overwriting the collection of skipped
2921 * ops and/or strings with fake optimized ops */
2922 n = scan + NODE_SZ_STR(scan);
2930 DEBUG_OPTIMISE_r(if (merged){DEBUG_PEEP("finl",scan,depth)});
2934 /* REx optimizer. Converts nodes into quicker variants "in place".
2935 Finds fixed substrings. */
2937 /* Stops at toplevel WHILEM as well as at "last". At end *scanp is set
2938 to the position after last scanned or to NULL. */
2940 #define INIT_AND_WITHP \
2941 assert(!and_withp); \
2942 Newx(and_withp,1,struct regnode_charclass_class); \
2943 SAVEFREEPV(and_withp)
2945 /* this is a chain of data about sub patterns we are processing that
2946 need to be handled separately/specially in study_chunk. Its so
2947 we can simulate recursion without losing state. */
2949 typedef struct scan_frame {
2950 regnode *last; /* last node to process in this frame */
2951 regnode *next; /* next node to process when last is reached */
2952 struct scan_frame *prev; /*previous frame*/
2953 I32 stop; /* what stopparen do we use */
2957 #define SCAN_COMMIT(s, data, m) scan_commit(s, data, m, is_inf)
2959 #define CASE_SYNST_FNC(nAmE) \
2961 if (flags & SCF_DO_STCLASS_AND) { \
2962 for (value = 0; value < 256; value++) \
2963 if (!is_ ## nAmE ## _cp(value)) \
2964 ANYOF_BITMAP_CLEAR(data->start_class, value); \
2967 for (value = 0; value < 256; value++) \
2968 if (is_ ## nAmE ## _cp(value)) \
2969 ANYOF_BITMAP_SET(data->start_class, value); \
2973 if (flags & SCF_DO_STCLASS_AND) { \
2974 for (value = 0; value < 256; value++) \
2975 if (is_ ## nAmE ## _cp(value)) \
2976 ANYOF_BITMAP_CLEAR(data->start_class, value); \
2979 for (value = 0; value < 256; value++) \
2980 if (!is_ ## nAmE ## _cp(value)) \
2981 ANYOF_BITMAP_SET(data->start_class, value); \
2988 S_study_chunk(pTHX_ RExC_state_t *pRExC_state, regnode **scanp,
2989 I32 *minlenp, I32 *deltap,
2994 struct regnode_charclass_class *and_withp,
2995 U32 flags, U32 depth)
2996 /* scanp: Start here (read-write). */
2997 /* deltap: Write maxlen-minlen here. */
2998 /* last: Stop before this one. */
2999 /* data: string data about the pattern */
3000 /* stopparen: treat close N as END */
3001 /* recursed: which subroutines have we recursed into */
3002 /* and_withp: Valid if flags & SCF_DO_STCLASS_OR */
3005 I32 min = 0; /* There must be at least this number of characters to match */
3007 regnode *scan = *scanp, *next;
3009 int is_inf = (flags & SCF_DO_SUBSTR) && (data->flags & SF_IS_INF);
3010 int is_inf_internal = 0; /* The studied chunk is infinite */
3011 I32 is_par = OP(scan) == OPEN ? ARG(scan) : 0;
3012 scan_data_t data_fake;
3013 SV *re_trie_maxbuff = NULL;
3014 regnode *first_non_open = scan;
3015 I32 stopmin = I32_MAX;
3016 scan_frame *frame = NULL;
3017 GET_RE_DEBUG_FLAGS_DECL;
3019 PERL_ARGS_ASSERT_STUDY_CHUNK;
3022 StructCopy(&zero_scan_data, &data_fake, scan_data_t);
3026 while (first_non_open && OP(first_non_open) == OPEN)
3027 first_non_open=regnext(first_non_open);
3032 while ( scan && OP(scan) != END && scan < last ){
3033 UV min_subtract = 0; /* How mmany chars to subtract from the minimum
3034 node length to get a real minimum (because
3035 the folded version may be shorter) */
3036 bool has_exactf_sharp_s = FALSE;
3037 /* Peephole optimizer: */
3038 DEBUG_STUDYDATA("Peep:", data,depth);
3039 DEBUG_PEEP("Peep",scan,depth);
3041 /* Its not clear to khw or hv why this is done here, and not in the
3042 * clauses that deal with EXACT nodes. khw's guess is that it's
3043 * because of a previous design */
3044 JOIN_EXACT(scan,&min_subtract, &has_exactf_sharp_s, 0);
3046 /* Follow the next-chain of the current node and optimize
3047 away all the NOTHINGs from it. */
3048 if (OP(scan) != CURLYX) {
3049 const int max = (reg_off_by_arg[OP(scan)]
3051 /* I32 may be smaller than U16 on CRAYs! */
3052 : (I32_MAX < U16_MAX ? I32_MAX : U16_MAX));
3053 int off = (reg_off_by_arg[OP(scan)] ? ARG(scan) : NEXT_OFF(scan));
3057 /* Skip NOTHING and LONGJMP. */
3058 while ((n = regnext(n))
3059 && ((PL_regkind[OP(n)] == NOTHING && (noff = NEXT_OFF(n)))
3060 || ((OP(n) == LONGJMP) && (noff = ARG(n))))
3061 && off + noff < max)
3063 if (reg_off_by_arg[OP(scan)])
3066 NEXT_OFF(scan) = off;
3071 /* The principal pseudo-switch. Cannot be a switch, since we
3072 look into several different things. */
3073 if (OP(scan) == BRANCH || OP(scan) == BRANCHJ
3074 || OP(scan) == IFTHEN) {
3075 next = regnext(scan);
3077 /* demq: the op(next)==code check is to see if we have "branch-branch" AFAICT */
3079 if (OP(next) == code || code == IFTHEN) {
3080 /* NOTE - There is similar code to this block below for handling
3081 TRIE nodes on a re-study. If you change stuff here check there
3083 I32 max1 = 0, min1 = I32_MAX, num = 0;
3084 struct regnode_charclass_class accum;
3085 regnode * const startbranch=scan;
3087 if (flags & SCF_DO_SUBSTR)
3088 SCAN_COMMIT(pRExC_state, data, minlenp); /* Cannot merge strings after this. */
3089 if (flags & SCF_DO_STCLASS)
3090 cl_init_zero(pRExC_state, &accum);
3092 while (OP(scan) == code) {
3093 I32 deltanext, minnext, f = 0, fake;
3094 struct regnode_charclass_class this_class;
3097 data_fake.flags = 0;
3099 data_fake.whilem_c = data->whilem_c;
3100 data_fake.last_closep = data->last_closep;
3103 data_fake.last_closep = &fake;
3105 data_fake.pos_delta = delta;
3106 next = regnext(scan);
3107 scan = NEXTOPER(scan);
3109 scan = NEXTOPER(scan);
3110 if (flags & SCF_DO_STCLASS) {
3111 cl_init(pRExC_state, &this_class);
3112 data_fake.start_class = &this_class;
3113 f = SCF_DO_STCLASS_AND;
3115 if (flags & SCF_WHILEM_VISITED_POS)
3116 f |= SCF_WHILEM_VISITED_POS;
3118 /* we suppose the run is continuous, last=next...*/
3119 minnext = study_chunk(pRExC_state, &scan, minlenp, &deltanext,
3121 stopparen, recursed, NULL, f,depth+1);
3124 if (max1 < minnext + deltanext)
3125 max1 = minnext + deltanext;
3126 if (deltanext == I32_MAX)
3127 is_inf = is_inf_internal = 1;
3129 if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
3131 if (data_fake.flags & SCF_SEEN_ACCEPT) {
3132 if ( stopmin > minnext)
3133 stopmin = min + min1;
3134 flags &= ~SCF_DO_SUBSTR;
3136 data->flags |= SCF_SEEN_ACCEPT;
3139 if (data_fake.flags & SF_HAS_EVAL)
3140 data->flags |= SF_HAS_EVAL;
3141 data->whilem_c = data_fake.whilem_c;
3143 if (flags & SCF_DO_STCLASS)
3144 cl_or(pRExC_state, &accum, &this_class);
3146 if (code == IFTHEN && num < 2) /* Empty ELSE branch */
3148 if (flags & SCF_DO_SUBSTR) {
3149 data->pos_min += min1;
3150 data->pos_delta += max1 - min1;
3151 if (max1 != min1 || is_inf)
3152 data->longest = &(data->longest_float);
3155 delta += max1 - min1;
3156 if (flags & SCF_DO_STCLASS_OR) {
3157 cl_or(pRExC_state, data->start_class, &accum);
3159 cl_and(data->start_class, and_withp);
3160 flags &= ~SCF_DO_STCLASS;
3163 else if (flags & SCF_DO_STCLASS_AND) {
3165 cl_and(data->start_class, &accum);
3166 flags &= ~SCF_DO_STCLASS;
3169 /* Switch to OR mode: cache the old value of
3170 * data->start_class */
3172 StructCopy(data->start_class, and_withp,
3173 struct regnode_charclass_class);
3174 flags &= ~SCF_DO_STCLASS_AND;
3175 StructCopy(&accum, data->start_class,
3176 struct regnode_charclass_class);
3177 flags |= SCF_DO_STCLASS_OR;
3178 data->start_class->flags |= ANYOF_EOS;
3182 if (PERL_ENABLE_TRIE_OPTIMISATION && OP( startbranch ) == BRANCH ) {
3185 Assuming this was/is a branch we are dealing with: 'scan' now
3186 points at the item that follows the branch sequence, whatever
3187 it is. We now start at the beginning of the sequence and look
3194 which would be constructed from a pattern like /A|LIST|OF|WORDS/
3196 If we can find such a subsequence we need to turn the first
3197 element into a trie and then add the subsequent branch exact
3198 strings to the trie.
3202 1. patterns where the whole set of branches can be converted.
3204 2. patterns where only a subset can be converted.
3206 In case 1 we can replace the whole set with a single regop
3207 for the trie. In case 2 we need to keep the start and end
3210 'BRANCH EXACT; BRANCH EXACT; BRANCH X'
3211 becomes BRANCH TRIE; BRANCH X;
3213 There is an additional case, that being where there is a
3214 common prefix, which gets split out into an EXACT like node
3215 preceding the TRIE node.
3217 If x(1..n)==tail then we can do a simple trie, if not we make
3218 a "jump" trie, such that when we match the appropriate word
3219 we "jump" to the appropriate tail node. Essentially we turn
3220 a nested if into a case structure of sorts.
3225 if (!re_trie_maxbuff) {
3226 re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
3227 if (!SvIOK(re_trie_maxbuff))
3228 sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
3230 if ( SvIV(re_trie_maxbuff)>=0 ) {
3232 regnode *first = (regnode *)NULL;
3233 regnode *last = (regnode *)NULL;
3234 regnode *tail = scan;
3239 SV * const mysv = sv_newmortal(); /* for dumping */
3241 /* var tail is used because there may be a TAIL
3242 regop in the way. Ie, the exacts will point to the
3243 thing following the TAIL, but the last branch will
3244 point at the TAIL. So we advance tail. If we
3245 have nested (?:) we may have to move through several
3249 while ( OP( tail ) == TAIL ) {
3250 /* this is the TAIL generated by (?:) */
3251 tail = regnext( tail );
3255 DEBUG_TRIE_COMPILE_r({
3256 regprop(RExC_rx, mysv, tail );
3257 PerlIO_printf( Perl_debug_log, "%*s%s%s\n",
3258 (int)depth * 2 + 2, "",
3259 "Looking for TRIE'able sequences. Tail node is: ",
3260 SvPV_nolen_const( mysv )
3266 Step through the branches
3267 cur represents each branch,
3268 noper is the first thing to be matched as part of that branch
3269 noper_next is the regnext() of that node.
3271 We normally handle a case like this /FOO[xyz]|BAR[pqr]/
3272 via a "jump trie" but we also support building with NOJUMPTRIE,
3273 which restricts the trie logic to structures like /FOO|BAR/.
3275 If noper is a trieable nodetype then the branch is a possible optimization
3276 target. If we are building under NOJUMPTRIE then we require that noper_next
3277 is the same as scan (our current position in the regex program).
3279 Once we have two or more consecutive such branches we can create a
3280 trie of the EXACT's contents and stitch it in place into the program.
3282 If the sequence represents all of the branches in the alternation we
3283 replace the entire thing with a single TRIE node.
3285 Otherwise when it is a subsequence we need to stitch it in place and
3286 replace only the relevant branches. This means the first branch has
3287 to remain as it is used by the alternation logic, and its next pointer,
3288 and needs to be repointed at the item on the branch chain following
3289 the last branch we have optimized away.
3291 This could be either a BRANCH, in which case the subsequence is internal,
3292 or it could be the item following the branch sequence in which case the
3293 subsequence is at the end (which does not necessarily mean the first node
3294 is the start of the alternation).
3296 TRIE_TYPE(X) is a define which maps the optype to a trietype.
3299 ----------------+-----------
3303 EXACTFU_SS | EXACTFU
3304 EXACTFU_TRICKYFOLD | EXACTFU
3309 #define TRIE_TYPE(X) ( ( NOTHING == (X) ) ? NOTHING : \
3310 ( EXACT == (X) ) ? EXACT : \
3311 ( EXACTFU == (X) || EXACTFU_SS == (X) || EXACTFU_TRICKYFOLD == (X) ) ? EXACTFU : \
3314 /* dont use tail as the end marker for this traverse */
3315 for ( cur = startbranch ; cur != scan ; cur = regnext( cur ) ) {
3316 regnode * const noper = NEXTOPER( cur );
3317 U8 noper_type = OP( noper );
3318 U8 noper_trietype = TRIE_TYPE( noper_type );
3319 #if defined(DEBUGGING) || defined(NOJUMPTRIE)
3320 regnode * const noper_next = regnext( noper );
3321 U8 noper_next_type = (noper_next && noper_next != tail) ? OP(noper_next) : 0;
3322 U8 noper_next_trietype = (noper_next && noper_next != tail) ? TRIE_TYPE( noper_next_type ) :0;
3325 DEBUG_TRIE_COMPILE_r({
3326 regprop(RExC_rx, mysv, cur);
3327 PerlIO_printf( Perl_debug_log, "%*s- %s (%d)",
3328 (int)depth * 2 + 2,"", SvPV_nolen_const( mysv ), REG_NODE_NUM(cur) );
3330 regprop(RExC_rx, mysv, noper);
3331 PerlIO_printf( Perl_debug_log, " -> %s",
3332 SvPV_nolen_const(mysv));
3335 regprop(RExC_rx, mysv, noper_next );
3336 PerlIO_printf( Perl_debug_log,"\t=> %s\t",
3337 SvPV_nolen_const(mysv));
3339 PerlIO_printf( Perl_debug_log, "(First==%d,Last==%d,Cur==%d,tt==%s,nt==%s,nnt==%s)\n",
3340 REG_NODE_NUM(first), REG_NODE_NUM(last), REG_NODE_NUM(cur),
3341 PL_reg_name[trietype], PL_reg_name[noper_trietype], PL_reg_name[noper_next_trietype]
3345 /* Is noper a trieable nodetype that can be merged with the
3346 * current trie (if there is one)? */
3350 ( noper_trietype == NOTHING)
3351 || ( trietype == NOTHING )
3352 || ( trietype == noper_trietype )
3355 && noper_next == tail
3359 /* Handle mergable triable node
3360 * Either we are the first node in a new trieable sequence,
3361 * in which case we do some bookkeeping, otherwise we update
3362 * the end pointer. */
3365 if ( noper_trietype == NOTHING ) {
3366 #if !defined(DEBUGGING) && !defined(NOJUMPTRIE)
3367 regnode * const noper_next = regnext( noper );
3368 U8 noper_next_type = (noper_next && noper_next!=tail) ? OP(noper_next) : 0;
3369 U8 noper_next_trietype = noper_next_type ? TRIE_TYPE( noper_next_type ) :0;
3372 if ( noper_next_trietype ) {
3373 trietype = noper_next_trietype;
3374 } else if (noper_next_type) {
3375 /* a NOTHING regop is 1 regop wide. We need at least two
3376 * for a trie so we can't merge this in */
3380 trietype = noper_trietype;
3383 if ( trietype == NOTHING )
3384 trietype = noper_trietype;
3389 } /* end handle mergable triable node */
3391 /* handle unmergable node -
3392 * noper may either be a triable node which can not be tried
3393 * together with the current trie, or a non triable node */
3395 /* If last is set and trietype is not NOTHING then we have found
3396 * at least two triable branch sequences in a row of a similar
3397 * trietype so we can turn them into a trie. If/when we
3398 * allow NOTHING to start a trie sequence this condition will be
3399 * required, and it isn't expensive so we leave it in for now. */
3400 if ( trietype && trietype != NOTHING )
3401 make_trie( pRExC_state,
3402 startbranch, first, cur, tail, count,
3403 trietype, depth+1 );
3404 last = NULL; /* note: we clear/update first, trietype etc below, so we dont do it here */
3408 && noper_next == tail
3411 /* noper is triable, so we can start a new trie sequence */
3414 trietype = noper_trietype;
3416 /* if we already saw a first but the current node is not triable then we have
3417 * to reset the first information. */
3422 } /* end handle unmergable node */
3423 } /* loop over branches */
3424 DEBUG_TRIE_COMPILE_r({
3425 regprop(RExC_rx, mysv, cur);
3426 PerlIO_printf( Perl_debug_log,
3427 "%*s- %s (%d) <SCAN FINISHED>\n", (int)depth * 2 + 2,
3428 "", SvPV_nolen_const( mysv ),REG_NODE_NUM(cur));
3431 if ( last && trietype ) {
3432 if ( trietype != NOTHING ) {
3433 /* the last branch of the sequence was part of a trie,
3434 * so we have to construct it here outside of the loop
3436 made= make_trie( pRExC_state, startbranch, first, scan, tail, count, trietype, depth+1 );
3437 #ifdef TRIE_STUDY_OPT
3438 if ( ((made == MADE_EXACT_TRIE &&
3439 startbranch == first)
3440 || ( first_non_open == first )) &&
3442 flags |= SCF_TRIE_RESTUDY;
3443 if ( startbranch == first
3446 RExC_seen &=~REG_TOP_LEVEL_BRANCHES;
3451 /* at this point we know whatever we have is a NOTHING sequence/branch
3452 * AND if 'startbranch' is 'first' then we can turn the whole thing into a NOTHING
3454 if ( startbranch == first ) {
3456 /* the entire thing is a NOTHING sequence, something like this:
3457 * (?:|) So we can turn it into a plain NOTHING op. */
3458 DEBUG_TRIE_COMPILE_r({
3459 regprop(RExC_rx, mysv, cur);
3460 PerlIO_printf( Perl_debug_log,
3461 "%*s- %s (%d) <NOTHING BRANCH SEQUENCE>\n", (int)depth * 2 + 2,
3462 "", SvPV_nolen_const( mysv ),REG_NODE_NUM(cur));
3465 OP(startbranch)= NOTHING;
3466 NEXT_OFF(startbranch)= tail - startbranch;
3467 for ( opt= startbranch + 1; opt < tail ; opt++ )
3471 } /* end if ( last) */
3472 } /* TRIE_MAXBUF is non zero */
3477 else if ( code == BRANCHJ ) { /* single branch is optimized. */
3478 scan = NEXTOPER(NEXTOPER(scan));
3479 } else /* single branch is optimized. */
3480 scan = NEXTOPER(scan);
3482 } else if (OP(scan) == SUSPEND || OP(scan) == GOSUB || OP(scan) == GOSTART) {
3483 scan_frame *newframe = NULL;
3488 if (OP(scan) != SUSPEND) {
3489 /* set the pointer */
3490 if (OP(scan) == GOSUB) {
3492 RExC_recurse[ARG2L(scan)] = scan;
3493 start = RExC_open_parens[paren-1];
3494 end = RExC_close_parens[paren-1];
3497 start = RExC_rxi->program + 1;
3501 Newxz(recursed, (((RExC_npar)>>3) +1), U8);
3502 SAVEFREEPV(recursed);
3504 if (!PAREN_TEST(recursed,paren+1)) {
3505 PAREN_SET(recursed,paren+1);
3506 Newx(newframe,1,scan_frame);
3508 if (flags & SCF_DO_SUBSTR) {
3509 SCAN_COMMIT(pRExC_state,data,minlenp);
3510 data->longest = &(data->longest_float);
3512 is_inf = is_inf_internal = 1;
3513 if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
3514 cl_anything(pRExC_state, data->start_class);
3515 flags &= ~SCF_DO_STCLASS;
3518 Newx(newframe,1,scan_frame);
3521 end = regnext(scan);
3526 SAVEFREEPV(newframe);
3527 newframe->next = regnext(scan);
3528 newframe->last = last;
3529 newframe->stop = stopparen;
3530 newframe->prev = frame;
3540 else if (OP(scan) == EXACT) {
3541 I32 l = STR_LEN(scan);
3544 const U8 * const s = (U8*)STRING(scan);
3545 uc = utf8_to_uvchr_buf(s, s + l, NULL);
3546 l = utf8_length(s, s + l);
3548 uc = *((U8*)STRING(scan));
3551 if (flags & SCF_DO_SUBSTR) { /* Update longest substr. */
3552 /* The code below prefers earlier match for fixed
3553 offset, later match for variable offset. */
3554 if (data->last_end == -1) { /* Update the start info. */
3555 data->last_start_min = data->pos_min;
3556 data->last_start_max = is_inf
3557 ? I32_MAX : data->pos_min + data->pos_delta;
3559 sv_catpvn(data->last_found, STRING(scan), STR_LEN(scan));
3561 SvUTF8_on(data->last_found);
3563 SV * const sv = data->last_found;
3564 MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
3565 mg_find(sv, PERL_MAGIC_utf8) : NULL;
3566 if (mg && mg->mg_len >= 0)
3567 mg->mg_len += utf8_length((U8*)STRING(scan),
3568 (U8*)STRING(scan)+STR_LEN(scan));
3570 data->last_end = data->pos_min + l;
3571 data->pos_min += l; /* As in the first entry. */
3572 data->flags &= ~SF_BEFORE_EOL;
3574 if (flags & SCF_DO_STCLASS_AND) {
3575 /* Check whether it is compatible with what we know already! */
3579 /* If compatible, we or it in below. It is compatible if is
3580 * in the bitmp and either 1) its bit or its fold is set, or 2)
3581 * it's for a locale. Even if there isn't unicode semantics
3582 * here, at runtime there may be because of matching against a
3583 * utf8 string, so accept a possible false positive for
3584 * latin1-range folds */
3586 (!(data->start_class->flags & (ANYOF_CLASS | ANYOF_LOCALE))
3587 && !ANYOF_BITMAP_TEST(data->start_class, uc)
3588 && (!(data->start_class->flags & ANYOF_LOC_FOLD)
3589 || !ANYOF_BITMAP_TEST(data->start_class, PL_fold_latin1[uc])))
3594 ANYOF_CLASS_ZERO(data->start_class);
3595 ANYOF_BITMAP_ZERO(data->start_class);
3597 ANYOF_BITMAP_SET(data->start_class, uc);
3598 else if (uc >= 0x100) {
3601 /* Some Unicode code points fold to the Latin1 range; as
3602 * XXX temporary code, instead of figuring out if this is
3603 * one, just assume it is and set all the start class bits
3604 * that could be some such above 255 code point's fold
3605 * which will generate fals positives. As the code
3606 * elsewhere that does compute the fold settles down, it
3607 * can be extracted out and re-used here */
3608 for (i = 0; i < 256; i++){
3609 if (HAS_NONLATIN1_FOLD_CLOSURE(i)) {
3610 ANYOF_BITMAP_SET(data->start_class, i);
3614 data->start_class->flags &= ~ANYOF_EOS;
3616 data->start_class->flags &= ~ANYOF_UNICODE_ALL;
3618 else if (flags & SCF_DO_STCLASS_OR) {
3619 /* false positive possible if the class is case-folded */
3621 ANYOF_BITMAP_SET(data->start_class, uc);
3623 data->start_class->flags |= ANYOF_UNICODE_ALL;
3624 data->start_class->flags &= ~ANYOF_EOS;
3625 cl_and(data->start_class, and_withp);
3627 flags &= ~SCF_DO_STCLASS;
3629 else if (PL_regkind[OP(scan)] == EXACT) { /* But OP != EXACT! */
3630 I32 l = STR_LEN(scan);
3631 UV uc = *((U8*)STRING(scan));
3633 /* Search for fixed substrings supports EXACT only. */
3634 if (flags & SCF_DO_SUBSTR) {
3636 SCAN_COMMIT(pRExC_state, data, minlenp);
3639 const U8 * const s = (U8 *)STRING(scan);
3640 uc = utf8_to_uvchr_buf(s, s + l, NULL);
3641 l = utf8_length(s, s + l);
3643 if (has_exactf_sharp_s) {
3644 RExC_seen |= REG_SEEN_EXACTF_SHARP_S;
3646 min += l - min_subtract;
3648 delta += min_subtract;
3649 if (flags & SCF_DO_SUBSTR) {
3650 data->pos_min += l - min_subtract;
3651 if (data->pos_min < 0) {
3654 data->pos_delta += min_subtract;
3656 data->longest = &(data->longest_float);
3659 if (flags & SCF_DO_STCLASS_AND) {
3660 /* Check whether it is compatible with what we know already! */
3663 (!(data->start_class->flags & (ANYOF_CLASS | ANYOF_LOCALE))
3664 && !ANYOF_BITMAP_TEST(data->start_class, uc)
3665 && !ANYOF_BITMAP_TEST(data->start_class, PL_fold_latin1[uc])))
3669 ANYOF_CLASS_ZERO(data->start_class);
3670 ANYOF_BITMAP_ZERO(data->start_class);
3672 ANYOF_BITMAP_SET(data->start_class, uc);
3673 data->start_class->flags &= ~ANYOF_EOS;
3674 if (OP(scan) == EXACTFL) {
3675 /* XXX This set is probably no longer necessary, and
3676 * probably wrong as LOCALE now is on in the initial
3678 data->start_class->flags |= ANYOF_LOCALE|ANYOF_LOC_FOLD;
3682 /* Also set the other member of the fold pair. In case
3683 * that unicode semantics is called for at runtime, use
3684 * the full latin1 fold. (Can't do this for locale,
3685 * because not known until runtime) */
3686 ANYOF_BITMAP_SET(data->start_class, PL_fold_latin1[uc]);
3688 /* All other (EXACTFL handled above) folds except under
3689 * /iaa that include s, S, and sharp_s also may include
3691 if (OP(scan) != EXACTFA) {
3692 if (uc == 's' || uc == 'S') {
3693 ANYOF_BITMAP_SET(data->start_class,
3694 LATIN_SMALL_LETTER_SHARP_S);
3696 else if (uc == LATIN_SMALL_LETTER_SHARP_S) {
3697 ANYOF_BITMAP_SET(data->start_class, 's');
3698 ANYOF_BITMAP_SET(data->start_class, 'S');
3703 else if (uc >= 0x100) {
3705 for (i = 0; i < 256; i++){
3706 if (_HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(i)) {
3707 ANYOF_BITMAP_SET(data->start_class, i);
3712 else if (flags & SCF_DO_STCLASS_OR) {
3713 if (data->start_class->flags & ANYOF_LOC_FOLD) {
3714 /* false positive possible if the class is case-folded.
3715 Assume that the locale settings are the same... */
3717 ANYOF_BITMAP_SET(data->start_class, uc);
3718 if (OP(scan) != EXACTFL) {
3720 /* And set the other member of the fold pair, but
3721 * can't do that in locale because not known until
3723 ANYOF_BITMAP_SET(data->start_class,
3724 PL_fold_latin1[uc]);
3726 /* All folds except under /iaa that include s, S,
3727 * and sharp_s also may include the others */
3728 if (OP(scan) != EXACTFA) {
3729 if (uc == 's' || uc == 'S') {
3730 ANYOF_BITMAP_SET(data->start_class,
3731 LATIN_SMALL_LETTER_SHARP_S);
3733 else if (uc == LATIN_SMALL_LETTER_SHARP_S) {
3734 ANYOF_BITMAP_SET(data->start_class, 's');
3735 ANYOF_BITMAP_SET(data->start_class, 'S');
3740 data->start_class->flags &= ~ANYOF_EOS;
3742 cl_and(data->start_class, and_withp);
3744 flags &= ~SCF_DO_STCLASS;
3746 else if (REGNODE_VARIES(OP(scan))) {
3747 I32 mincount, maxcount, minnext, deltanext, fl = 0;
3748 I32 f = flags, pos_before = 0;
3749 regnode * const oscan = scan;
3750 struct regnode_charclass_class this_class;
3751 struct regnode_charclass_class *oclass = NULL;
3752 I32 next_is_eval = 0;
3754 switch (PL_regkind[OP(scan)]) {
3755 case WHILEM: /* End of (?:...)* . */
3756 scan = NEXTOPER(scan);
3759 if (flags & (SCF_DO_SUBSTR | SCF_DO_STCLASS)) {
3760 next = NEXTOPER(scan);
3761 if (OP(next) == EXACT || (flags & SCF_DO_STCLASS)) {
3763 maxcount = REG_INFTY;
3764 next = regnext(scan);
3765 scan = NEXTOPER(scan);
3769 if (flags & SCF_DO_SUBSTR)
3774 if (flags & SCF_DO_STCLASS) {
3776 maxcount = REG_INFTY;
3777 next = regnext(scan);
3778 scan = NEXTOPER(scan);
3781 is_inf = is_inf_internal = 1;
3782 scan = regnext(scan);
3783 if (flags & SCF_DO_SUBSTR) {
3784 SCAN_COMMIT(pRExC_state, data, minlenp); /* Cannot extend fixed substrings */
3785 data->longest = &(data->longest_float);
3787 goto optimize_curly_tail;
3789 if (stopparen>0 && (OP(scan)==CURLYN || OP(scan)==CURLYM)
3790 && (scan->flags == stopparen))
3795 mincount = ARG1(scan);
3796 maxcount = ARG2(scan);
3798 next = regnext(scan);
3799 if (OP(scan) == CURLYX) {
3800 I32 lp = (data ? *(data->last_closep) : 0);
3801 scan->flags = ((lp <= (I32)U8_MAX) ? (U8)lp : U8_MAX);
3803 scan = NEXTOPER(scan) + EXTRA_STEP_2ARGS;
3804 next_is_eval = (OP(scan) == EVAL);
3806 if (flags & SCF_DO_SUBSTR) {
3807 if (mincount == 0) SCAN_COMMIT(pRExC_state,data,minlenp); /* Cannot extend fixed substrings */
3808 pos_before = data->pos_min;
3812 data->flags &= ~(SF_HAS_PAR|SF_IN_PAR|SF_HAS_EVAL);
3814 data->flags |= SF_IS_INF;
3816 if (flags & SCF_DO_STCLASS) {
3817 cl_init(pRExC_state, &this_class);
3818 oclass = data->start_class;
3819 data->start_class = &this_class;
3820 f |= SCF_DO_STCLASS_AND;
3821 f &= ~SCF_DO_STCLASS_OR;
3823 /* Exclude from super-linear cache processing any {n,m}
3824 regops for which the combination of input pos and regex
3825 pos is not enough information to determine if a match
3828 For example, in the regex /foo(bar\s*){4,8}baz/ with the
3829 regex pos at the \s*, the prospects for a match depend not
3830 only on the input position but also on how many (bar\s*)
3831 repeats into the {4,8} we are. */
3832 if ((mincount > 1) || (maxcount > 1 && maxcount != REG_INFTY))
3833 f &= ~SCF_WHILEM_VISITED_POS;
3835 /* This will finish on WHILEM, setting scan, or on NULL: */
3836 minnext = study_chunk(pRExC_state, &scan, minlenp, &deltanext,
3837 last, data, stopparen, recursed, NULL,
3839 ? (f & ~SCF_DO_SUBSTR) : f),depth+1);
3841 if (flags & SCF_DO_STCLASS)
3842 data->start_class = oclass;
3843 if (mincount == 0 || minnext == 0) {
3844 if (flags & SCF_DO_STCLASS_OR) {
3845 cl_or(pRExC_state, data->start_class, &this_class);
3847 else if (flags & SCF_DO_STCLASS_AND) {
3848 /* Switch to OR mode: cache the old value of
3849 * data->start_class */
3851 StructCopy(data->start_class, and_withp,
3852 struct regnode_charclass_class);
3853 flags &= ~SCF_DO_STCLASS_AND;
3854 StructCopy(&this_class, data->start_class,
3855 struct regnode_charclass_class);
3856 flags |= SCF_DO_STCLASS_OR;
3857 data->start_class->flags |= ANYOF_EOS;
3859 } else { /* Non-zero len */
3860 if (flags & SCF_DO_STCLASS_OR) {
3861 cl_or(pRExC_state, data->start_class, &this_class);
3862 cl_and(data->start_class, and_withp);
3864 else if (flags & SCF_DO_STCLASS_AND)
3865 cl_and(data->start_class, &this_class);
3866 flags &= ~SCF_DO_STCLASS;
3868 if (!scan) /* It was not CURLYX, but CURLY. */
3870 if ( /* ? quantifier ok, except for (?{ ... }) */
3871 (next_is_eval || !(mincount == 0 && maxcount == 1))
3872 && (minnext == 0) && (deltanext == 0)
3873 && data && !(data->flags & (SF_HAS_PAR|SF_IN_PAR))
3874 && maxcount <= REG_INFTY/3) /* Complement check for big count */
3876 ckWARNreg(RExC_parse,
3877 "Quantifier unexpected on zero-length expression");
3880 min += minnext * mincount;
3881 is_inf_internal |= ((maxcount == REG_INFTY
3882 && (minnext + deltanext) > 0)
3883 || deltanext == I32_MAX);
3884 is_inf |= is_inf_internal;
3885 delta += (minnext + deltanext) * maxcount - minnext * mincount;
3887 /* Try powerful optimization CURLYX => CURLYN. */
3888 if ( OP(oscan) == CURLYX && data
3889 && data->flags & SF_IN_PAR
3890 && !(data->flags & SF_HAS_EVAL)
3891 && !deltanext && minnext == 1 ) {
3892 /* Try to optimize to CURLYN. */
3893 regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS;
3894 regnode * const nxt1 = nxt;
3901 if (!REGNODE_SIMPLE(OP(nxt))
3902 && !(PL_regkind[OP(nxt)] == EXACT
3903 && STR_LEN(nxt) == 1))
3909 if (OP(nxt) != CLOSE)
3911 if (RExC_open_parens) {
3912 RExC_open_parens[ARG(nxt1)-1]=oscan; /*open->CURLYM*/
3913 RExC_close_parens[ARG(nxt1)-1]=nxt+2; /*close->while*/
3915 /* Now we know that nxt2 is the only contents: */
3916 oscan->flags = (U8)ARG(nxt);
3918 OP(nxt1) = NOTHING; /* was OPEN. */
3921 OP(nxt1 + 1) = OPTIMIZED; /* was count. */
3922 NEXT_OFF(nxt1+ 1) = 0; /* just for consistency. */
3923 NEXT_OFF(nxt2) = 0; /* just for consistency with CURLY. */
3924 OP(nxt) = OPTIMIZED; /* was CLOSE. */
3925 OP(nxt + 1) = OPTIMIZED; /* was count. */
3926 NEXT_OFF(nxt+ 1) = 0; /* just for consistency. */
3931 /* Try optimization CURLYX => CURLYM. */
3932 if ( OP(oscan) == CURLYX && data
3933 && !(data->flags & SF_HAS_PAR)
3934 && !(data->flags & SF_HAS_EVAL)
3935 && !deltanext /* atom is fixed width */
3936 && minnext != 0 /* CURLYM can't handle zero width */
3937 && ! (RExC_seen & REG_SEEN_EXACTF_SHARP_S) /* Nor \xDF */
3939 /* XXXX How to optimize if data == 0? */
3940 /* Optimize to a simpler form. */
3941 regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN */
3945 while ( (nxt2 = regnext(nxt)) /* skip over embedded stuff*/
3946 && (OP(nxt2) != WHILEM))
3948 OP(nxt2) = SUCCEED; /* Whas WHILEM */
3949 /* Need to optimize away parenths. */
3950 if ((data->flags & SF_IN_PAR) && OP(nxt) == CLOSE) {
3951 /* Set the parenth number. */
3952 regnode *nxt1 = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN*/
3954 oscan->flags = (U8)ARG(nxt);
3955 if (RExC_open_parens) {
3956 RExC_open_parens[ARG(nxt1)-1]=oscan; /*open->CURLYM*/
3957 RExC_close_parens[ARG(nxt1)-1]=nxt2+1; /*close->NOTHING*/
3959 OP(nxt1) = OPTIMIZED; /* was OPEN. */
3960 OP(nxt) = OPTIMIZED; /* was CLOSE. */
3963 OP(nxt1 + 1) = OPTIMIZED; /* was count. */
3964 OP(nxt + 1) = OPTIMIZED; /* was count. */
3965 NEXT_OFF(nxt1 + 1) = 0; /* just for consistency. */
3966 NEXT_OFF(nxt + 1) = 0; /* just for consistency. */
3969 while ( nxt1 && (OP(nxt1) != WHILEM)) {
3970 regnode *nnxt = regnext(nxt1);
3972 if (reg_off_by_arg[OP(nxt1)])
3973 ARG_SET(nxt1, nxt2 - nxt1);
3974 else if (nxt2 - nxt1 < U16_MAX)
3975 NEXT_OFF(nxt1) = nxt2 - nxt1;
3977 OP(nxt) = NOTHING; /* Cannot beautify */
3982 /* Optimize again: */
3983 study_chunk(pRExC_state, &nxt1, minlenp, &deltanext, nxt,
3984 NULL, stopparen, recursed, NULL, 0,depth+1);
3989 else if ((OP(oscan) == CURLYX)
3990 && (flags & SCF_WHILEM_VISITED_POS)
3991 /* See the comment on a similar expression above.
3992 However, this time it's not a subexpression
3993 we care about, but the expression itself. */
3994 && (maxcount == REG_INFTY)
3995 && data && ++data->whilem_c < 16) {
3996 /* This stays as CURLYX, we can put the count/of pair. */
3997 /* Find WHILEM (as in regexec.c) */
3998 regnode *nxt = oscan + NEXT_OFF(oscan);
4000 if (OP(PREVOPER(nxt)) == NOTHING) /* LONGJMP */
4002 PREVOPER(nxt)->flags = (U8)(data->whilem_c
4003 | (RExC_whilem_seen << 4)); /* On WHILEM */
4005 if (data && fl & (SF_HAS_PAR|SF_IN_PAR))
4007 if (flags & SCF_DO_SUBSTR) {
4008 SV *last_str = NULL;
4009 int counted = mincount != 0;
4011 if (data->last_end > 0 && mincount != 0) { /* Ends with a string. */
4012 #if defined(SPARC64_GCC_WORKAROUND)
4015 const char *s = NULL;
4018 if (pos_before >= data->last_start_min)
4021 b = data->last_start_min;
4024 s = SvPV_const(data->last_found, l);
4025 old = b - data->last_start_min;
4028 I32 b = pos_before >= data->last_start_min
4029 ? pos_before : data->last_start_min;
4031 const char * const s = SvPV_const(data->last_found, l);
4032 I32 old = b - data->last_start_min;
4036 old = utf8_hop((U8*)s, old) - (U8*)s;
4038 /* Get the added string: */
4039 last_str = newSVpvn_utf8(s + old, l, UTF);
4040 if (deltanext == 0 && pos_before == b) {
4041 /* What was added is a constant string */
4043 SvGROW(last_str, (mincount * l) + 1);
4044 repeatcpy(SvPVX(last_str) + l,
4045 SvPVX_const(last_str), l, mincount - 1);
4046 SvCUR_set(last_str, SvCUR(last_str) * mincount);
4047 /* Add additional parts. */
4048 SvCUR_set(data->last_found,
4049 SvCUR(data->last_found) - l);
4050 sv_catsv(data->last_found, last_str);
4052 SV * sv = data->last_found;
4054 SvUTF8(sv) && SvMAGICAL(sv) ?
4055 mg_find(sv, PERL_MAGIC_utf8) : NULL;
4056 if (mg && mg->mg_len >= 0)
4057 mg->mg_len += CHR_SVLEN(last_str) - l;
4059 data->last_end += l * (mincount - 1);
4062 /* start offset must point into the last copy */
4063 data->last_start_min += minnext * (mincount - 1);
4064 data->last_start_max += is_inf ? I32_MAX
4065 : (maxcount - 1) * (minnext + data->pos_delta);
4068 /* It is counted once already... */
4069 data->pos_min += minnext * (mincount - counted);
4070 data->pos_delta += - counted * deltanext +
4071 (minnext + deltanext) * maxcount - minnext * mincount;
4072 if (mincount != maxcount) {
4073 /* Cannot extend fixed substrings found inside
4075 SCAN_COMMIT(pRExC_state,data,minlenp);
4076 if (mincount && last_str) {
4077 SV * const sv = data->last_found;
4078 MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
4079 mg_find(sv, PERL_MAGIC_utf8) : NULL;
4083 sv_setsv(sv, last_str);
4084 data->last_end = data->pos_min;
4085 data->last_start_min =
4086 data->pos_min - CHR_SVLEN(last_str);
4087 data->last_start_max = is_inf
4089 : data->pos_min + data->pos_delta
4090 - CHR_SVLEN(last_str);
4092 data->longest = &(data->longest_float);
4094 SvREFCNT_dec(last_str);
4096 if (data && (fl & SF_HAS_EVAL))
4097 data->flags |= SF_HAS_EVAL;
4098 optimize_curly_tail:
4099 if (OP(oscan) != CURLYX) {
4100 while (PL_regkind[OP(next = regnext(oscan))] == NOTHING
4102 NEXT_OFF(oscan) += NEXT_OFF(next);
4105 default: /* REF, ANYOFV, and CLUMP only? */
4106 if (flags & SCF_DO_SUBSTR) {
4107 SCAN_COMMIT(pRExC_state,data,minlenp); /* Cannot expect anything... */
4108 data->longest = &(data->longest_float);
4110 is_inf = is_inf_internal = 1;
4111 if (flags & SCF_DO_STCLASS_OR)
4112 cl_anything(pRExC_state, data->start_class);
4113 flags &= ~SCF_DO_STCLASS;
4117 else if (OP(scan) == LNBREAK) {
4118 if (flags & SCF_DO_STCLASS) {
4120 data->start_class->flags &= ~ANYOF_EOS; /* No match on empty */
4121 if (flags & SCF_DO_STCLASS_AND) {
4122 for (value = 0; value < 256; value++)
4123 if (!is_VERTWS_cp(value))
4124 ANYOF_BITMAP_CLEAR(data->start_class, value);
4127 for (value = 0; value < 256; value++)
4128 if (is_VERTWS_cp(value))
4129 ANYOF_BITMAP_SET(data->start_class, value);
4131 if (flags & SCF_DO_STCLASS_OR)
4132 cl_and(data->start_class, and_withp);
4133 flags &= ~SCF_DO_STCLASS;
4136 delta++; /* Because of the 2 char string cr-lf */
4137 if (flags & SCF_DO_SUBSTR) {
4138 SCAN_COMMIT(pRExC_state,data,minlenp); /* Cannot expect anything... */
4140 data->pos_delta += 1;
4141 data->longest = &(data->longest_float);
4144 else if (REGNODE_SIMPLE(OP(scan))) {
4147 if (flags & SCF_DO_SUBSTR) {
4148 SCAN_COMMIT(pRExC_state,data,minlenp);
4152 if (flags & SCF_DO_STCLASS) {
4153 data->start_class->flags &= ~ANYOF_EOS; /* No match on empty */
4155 /* Some of the logic below assumes that switching
4156 locale on will only add false positives. */
4157 switch (PL_regkind[OP(scan)]) {
4161 /* Perl_croak(aTHX_ "panic: unexpected simple REx opcode %d", OP(scan)); */
4162 if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
4163 cl_anything(pRExC_state, data->start_class);
4166 if (OP(scan) == SANY)
4168 if (flags & SCF_DO_STCLASS_OR) { /* Everything but \n */
4169 value = (ANYOF_BITMAP_TEST(data->start_class,'\n')
4170 || ANYOF_CLASS_TEST_ANY_SET(data->start_class));
4171 cl_anything(pRExC_state, data->start_class);
4173 if (flags & SCF_DO_STCLASS_AND || !value)
4174 ANYOF_BITMAP_CLEAR(data->start_class,'\n');
4177 if (flags & SCF_DO_STCLASS_AND)
4178 cl_and(data->start_class,
4179 (struct regnode_charclass_class*)scan);
4181 cl_or(pRExC_state, data->start_class,
4182 (struct regnode_charclass_class*)scan);
4185 if (flags & SCF_DO_STCLASS_AND) {
4186 if (!(data->start_class->flags & ANYOF_LOCALE)) {
4187 ANYOF_CLASS_CLEAR(data->start_class,ANYOF_NWORDCHAR);
4188 if (OP(scan) == ALNUMU) {
4189 for (value = 0; value < 256; value++) {
4190 if (!isWORDCHAR_L1(value)) {
4191 ANYOF_BITMAP_CLEAR(data->start_class, value);
4195 for (value = 0; value < 256; value++) {
4196 if (!isALNUM(value)) {
4197 ANYOF_BITMAP_CLEAR(data->start_class, value);
4204 if (data->start_class->flags & ANYOF_LOCALE)
4205 ANYOF_CLASS_SET(data->start_class,ANYOF_WORDCHAR);
4207 /* Even if under locale, set the bits for non-locale
4208 * in case it isn't a true locale-node. This will
4209 * create false positives if it truly is locale */
4210 if (OP(scan) == ALNUMU) {
4211 for (value = 0; value < 256; value++) {
4212 if (isWORDCHAR_L1(value)) {
4213 ANYOF_BITMAP_SET(data->start_class, value);
4217 for (value = 0; value < 256; value++) {
4218 if (isALNUM(value)) {
4219 ANYOF_BITMAP_SET(data->start_class, value);
4226 if (flags & SCF_DO_STCLASS_AND) {
4227 if (!(data->start_class->flags & ANYOF_LOCALE)) {
4228 ANYOF_CLASS_CLEAR(data->start_class,ANYOF_WORDCHAR);
4229 if (OP(scan) == NALNUMU) {
4230 for (value = 0; value < 256; value++) {
4231 if (isWORDCHAR_L1(value)) {
4232 ANYOF_BITMAP_CLEAR(data->start_class, value);
4236 for (value = 0; value < 256; value++) {
4237 if (isALNUM(value)) {
4238 ANYOF_BITMAP_CLEAR(data->start_class, value);
4245 if (data->start_class->flags & ANYOF_LOCALE)
4246 ANYOF_CLASS_SET(data->start_class,ANYOF_NWORDCHAR);
4248 /* Even if under locale, set the bits for non-locale in
4249 * case it isn't a true locale-node. This will create
4250 * false positives if it truly is locale */
4251 if (OP(scan) == NALNUMU) {
4252 for (value = 0; value < 256; value++) {
4253 if (! isWORDCHAR_L1(value)) {
4254 ANYOF_BITMAP_SET(data->start_class, value);
4258 for (value = 0; value < 256; value++) {
4259 if (! isALNUM(value)) {
4260 ANYOF_BITMAP_SET(data->start_class, value);
4267 if (flags & SCF_DO_STCLASS_AND) {
4268 if (!(data->start_class->flags & ANYOF_LOCALE)) {
4269 ANYOF_CLASS_CLEAR(data->start_class,ANYOF_NSPACE);
4270 if (OP(scan) == SPACEU) {
4271 for (value = 0; value < 256; value++) {
4272 if (!isSPACE_L1(value)) {
4273 ANYOF_BITMAP_CLEAR(data->start_class, value);
4277 for (value = 0; value < 256; value++) {
4278 if (!isSPACE(value)) {
4279 ANYOF_BITMAP_CLEAR(data->start_class, value);
4286 if (data->start_class->flags & ANYOF_LOCALE) {
4287 ANYOF_CLASS_SET(data->start_class,ANYOF_SPACE);
4289 if (OP(scan) == SPACEU) {
4290 for (value = 0; value < 256; value++) {
4291 if (isSPACE_L1(value)) {
4292 ANYOF_BITMAP_SET(data->start_class, value);
4296 for (value = 0; value < 256; value++) {
4297 if (isSPACE(value)) {
4298 ANYOF_BITMAP_SET(data->start_class, value);
4305 if (flags & SCF_DO_STCLASS_AND) {
4306 if (!(data->start_class->flags & ANYOF_LOCALE)) {
4307 ANYOF_CLASS_CLEAR(data->start_class,ANYOF_SPACE);
4308 if (OP(scan) == NSPACEU) {
4309 for (value = 0; value < 256; value++) {
4310 if (isSPACE_L1(value)) {
4311 ANYOF_BITMAP_CLEAR(data->start_class, value);
4315 for (value = 0; value < 256; value++) {
4316 if (isSPACE(value)) {
4317 ANYOF_BITMAP_CLEAR(data->start_class, value);
4324 if (data->start_class->flags & ANYOF_LOCALE)
4325 ANYOF_CLASS_SET(data->start_class,ANYOF_NSPACE);
4326 if (OP(scan) == NSPACEU) {
4327 for (value = 0; value < 256; value++) {
4328 if (!isSPACE_L1(value)) {
4329 ANYOF_BITMAP_SET(data->start_class, value);
4334 for (value = 0; value < 256; value++) {
4335 if (!isSPACE(value)) {
4336 ANYOF_BITMAP_SET(data->start_class, value);
4343 if (flags & SCF_DO_STCLASS_AND) {
4344 if (!(data->start_class->flags & ANYOF_LOCALE)) {
4345 ANYOF_CLASS_CLEAR(data->start_class,ANYOF_NDIGIT);
4346 for (value = 0; value < 256; value++)
4347 if (!isDIGIT(value))
4348 ANYOF_BITMAP_CLEAR(data->start_class, value);
4352 if (data->start_class->flags & ANYOF_LOCALE)
4353 ANYOF_CLASS_SET(data->start_class,ANYOF_DIGIT);
4354 for (value = 0; value < 256; value++)
4356 ANYOF_BITMAP_SET(data->start_class, value);
4360 if (flags & SCF_DO_STCLASS_AND) {
4361 if (!(data->start_class->flags & ANYOF_LOCALE))
4362 ANYOF_CLASS_CLEAR(data->start_class,ANYOF_DIGIT);
4363 for (value = 0; value < 256; value++)
4365 ANYOF_BITMAP_CLEAR(data->start_class, value);
4368 if (data->start_class->flags & ANYOF_LOCALE)
4369 ANYOF_CLASS_SET(data->start_class,ANYOF_NDIGIT);
4370 for (value = 0; value < 256; value++)
4371 if (!isDIGIT(value))
4372 ANYOF_BITMAP_SET(data->start_class, value);
4375 CASE_SYNST_FNC(VERTWS);
4376 CASE_SYNST_FNC(HORIZWS);
4379 if (flags & SCF_DO_STCLASS_OR)
4380 cl_and(data->start_class, and_withp);
4381 flags &= ~SCF_DO_STCLASS;
4384 else if (PL_regkind[OP(scan)] == EOL && flags & SCF_DO_SUBSTR) {
4385 data->flags |= (OP(scan) == MEOL
4388 SCAN_COMMIT(pRExC_state, data, minlenp);
4391 else if ( PL_regkind[OP(scan)] == BRANCHJ
4392 /* Lookbehind, or need to calculate parens/evals/stclass: */
4393 && (scan->flags || data || (flags & SCF_DO_STCLASS))
4394 && (OP(scan) == IFMATCH || OP(scan) == UNLESSM)) {
4395 if ( OP(scan) == UNLESSM &&
4397 OP(NEXTOPER(NEXTOPER(scan))) == NOTHING &&
4398 OP(regnext(NEXTOPER(NEXTOPER(scan)))) == SUCCEED
4401 regnode *upto= regnext(scan);
4403 SV * const mysv_val=sv_newmortal();
4404 DEBUG_STUDYDATA("OPFAIL",data,depth);
4406 /*DEBUG_PARSE_MSG("opfail");*/
4407 regprop(RExC_rx, mysv_val, upto);
4408 PerlIO_printf(Perl_debug_log, "~ replace with OPFAIL pointed at %s (%"IVdf") offset %"IVdf"\n",
4409 SvPV_nolen_const(mysv_val),
4410 (IV)REG_NODE_NUM(upto),
4415 NEXT_OFF(scan) = upto - scan;
4416 for (opt= scan + 1; opt < upto ; opt++)
4417 OP(opt) = OPTIMIZED;
4421 if ( !PERL_ENABLE_POSITIVE_ASSERTION_STUDY
4422 || OP(scan) == UNLESSM )
4424 /* Negative Lookahead/lookbehind
4425 In this case we can't do fixed string optimisation.
4428 I32 deltanext, minnext, fake = 0;
4430 struct regnode_charclass_class intrnl;
4433 data_fake.flags = 0;
4435 data_fake.whilem_c = data->whilem_c;
4436 data_fake.last_closep = data->last_closep;
4439 data_fake.last_closep = &fake;
4440 data_fake.pos_delta = delta;
4441 if ( flags & SCF_DO_STCLASS && !scan->flags
4442 && OP(scan) == IFMATCH ) { /* Lookahead */
4443 cl_init(pRExC_state, &intrnl);
4444 data_fake.start_class = &intrnl;
4445 f |= SCF_DO_STCLASS_AND;
4447 if (flags & SCF_WHILEM_VISITED_POS)
4448 f |= SCF_WHILEM_VISITED_POS;
4449 next = regnext(scan);
4450 nscan = NEXTOPER(NEXTOPER(scan));
4451 minnext = study_chunk(pRExC_state, &nscan, minlenp, &deltanext,
4452 last, &data_fake, stopparen, recursed, NULL, f, depth+1);
4455 FAIL("Variable length lookbehind not implemented");
4457 else if (minnext > (I32)U8_MAX) {
4458 FAIL2("Lookbehind longer than %"UVuf" not implemented", (UV)U8_MAX);
4460 scan->flags = (U8)minnext;
4463 if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4465 if (data_fake.flags & SF_HAS_EVAL)
4466 data->flags |= SF_HAS_EVAL;
4467 data->whilem_c = data_fake.whilem_c;
4469 if (f & SCF_DO_STCLASS_AND) {
4470 if (flags & SCF_DO_STCLASS_OR) {
4471 /* OR before, AND after: ideally we would recurse with
4472 * data_fake to get the AND applied by study of the
4473 * remainder of the pattern, and then derecurse;
4474 * *** HACK *** for now just treat as "no information".
4475 * See [perl #56690].
4477 cl_init(pRExC_state, data->start_class);
4479 /* AND before and after: combine and continue */
4480 const int was = (data->start_class->flags & ANYOF_EOS);
4482 cl_and(data->start_class, &intrnl);
4484 data->start_class->flags |= ANYOF_EOS;
4488 #if PERL_ENABLE_POSITIVE_ASSERTION_STUDY
4490 /* Positive Lookahead/lookbehind
4491 In this case we can do fixed string optimisation,
4492 but we must be careful about it. Note in the case of
4493 lookbehind the positions will be offset by the minimum
4494 length of the pattern, something we won't know about
4495 until after the recurse.
4497 I32 deltanext, fake = 0;
4499 struct regnode_charclass_class intrnl;
4501 /* We use SAVEFREEPV so that when the full compile
4502 is finished perl will clean up the allocated
4503 minlens when it's all done. This way we don't
4504 have to worry about freeing them when we know
4505 they wont be used, which would be a pain.
4508 Newx( minnextp, 1, I32 );
4509 SAVEFREEPV(minnextp);
4512 StructCopy(data, &data_fake, scan_data_t);
4513 if ((flags & SCF_DO_SUBSTR) && data->last_found) {
4516 SCAN_COMMIT(pRExC_state, &data_fake,minlenp);
4517 data_fake.last_found=newSVsv(data->last_found);
4521 data_fake.last_closep = &fake;
4522 data_fake.flags = 0;
4523 data_fake.pos_delta = delta;
4525 data_fake.flags |= SF_IS_INF;
4526 if ( flags & SCF_DO_STCLASS && !scan->flags
4527 && OP(scan) == IFMATCH ) { /* Lookahead */
4528 cl_init(pRExC_state, &intrnl);
4529 data_fake.start_class = &intrnl;
4530 f |= SCF_DO_STCLASS_AND;
4532 if (flags & SCF_WHILEM_VISITED_POS)
4533 f |= SCF_WHILEM_VISITED_POS;
4534 next = regnext(scan);
4535 nscan = NEXTOPER(NEXTOPER(scan));
4537 *minnextp = study_chunk(pRExC_state, &nscan, minnextp, &deltanext,
4538 last, &data_fake, stopparen, recursed, NULL, f,depth+1);
4541 FAIL("Variable length lookbehind not implemented");
4543 else if (*minnextp > (I32)U8_MAX) {
4544 FAIL2("Lookbehind longer than %"UVuf" not implemented", (UV)U8_MAX);
4546 scan->flags = (U8)*minnextp;
4551 if (f & SCF_DO_STCLASS_AND) {
4552 const int was = (data->start_class->flags & ANYOF_EOS);
4554 cl_and(data->start_class, &intrnl);
4556 data->start_class->flags |= ANYOF_EOS;
4559 if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4561 if (data_fake.flags & SF_HAS_EVAL)
4562 data->flags |= SF_HAS_EVAL;
4563 data->whilem_c = data_fake.whilem_c;
4564 if ((flags & SCF_DO_SUBSTR) && data_fake.last_found) {
4565 if (RExC_rx->minlen<*minnextp)
4566 RExC_rx->minlen=*minnextp;
4567 SCAN_COMMIT(pRExC_state, &data_fake, minnextp);
4568 SvREFCNT_dec(data_fake.last_found);
4570 if ( data_fake.minlen_fixed != minlenp )
4572 data->offset_fixed= data_fake.offset_fixed;
4573 data->minlen_fixed= data_fake.minlen_fixed;
4574 data->lookbehind_fixed+= scan->flags;
4576 if ( data_fake.minlen_float != minlenp )
4578 data->minlen_float= data_fake.minlen_float;
4579 data->offset_float_min=data_fake.offset_float_min;
4580 data->offset_float_max=data_fake.offset_float_max;
4581 data->lookbehind_float+= scan->flags;
4588 else if (OP(scan) == OPEN) {
4589 if (stopparen != (I32)ARG(scan))
4592 else if (OP(scan) == CLOSE) {
4593 if (stopparen == (I32)ARG(scan)) {
4596 if ((I32)ARG(scan) == is_par) {
4597 next = regnext(scan);
4599 if ( next && (OP(next) != WHILEM) && next < last)
4600 is_par = 0; /* Disable optimization */
4603 *(data->last_closep) = ARG(scan);
4605 else if (OP(scan) == EVAL) {
4607 data->flags |= SF_HAS_EVAL;
4609 else if ( PL_regkind[OP(scan)] == ENDLIKE ) {
4610 if (flags & SCF_DO_SUBSTR) {
4611 SCAN_COMMIT(pRExC_state,data,minlenp);
4612 flags &= ~SCF_DO_SUBSTR;
4614 if (data && OP(scan)==ACCEPT) {
4615 data->flags |= SCF_SEEN_ACCEPT;
4620 else if (OP(scan) == LOGICAL && scan->flags == 2) /* Embedded follows */
4622 if (flags & SCF_DO_SUBSTR) {
4623 SCAN_COMMIT(pRExC_state,data,minlenp);
4624 data->longest = &(data->longest_float);
4626 is_inf = is_inf_internal = 1;
4627 if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
4628 cl_anything(pRExC_state, data->start_class);
4629 flags &= ~SCF_DO_STCLASS;
4631 else if (OP(scan) == GPOS) {
4632 if (!(RExC_rx->extflags & RXf_GPOS_FLOAT) &&
4633 !(delta || is_inf || (data && data->pos_delta)))
4635 if (!(RExC_rx->extflags & RXf_ANCH) && (flags & SCF_DO_SUBSTR))
4636 RExC_rx->extflags |= RXf_ANCH_GPOS;
4637 if (RExC_rx->gofs < (U32)min)
4638 RExC_rx->gofs = min;
4640 RExC_rx->extflags |= RXf_GPOS_FLOAT;
4644 #ifdef TRIE_STUDY_OPT
4645 #ifdef FULL_TRIE_STUDY
4646 else if (PL_regkind[OP(scan)] == TRIE) {
4647 /* NOTE - There is similar code to this block above for handling
4648 BRANCH nodes on the initial study. If you change stuff here
4650 regnode *trie_node= scan;
4651 regnode *tail= regnext(scan);
4652 reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
4653 I32 max1 = 0, min1 = I32_MAX;
4654 struct regnode_charclass_class accum;
4656 if (flags & SCF_DO_SUBSTR) /* XXXX Add !SUSPEND? */
4657 SCAN_COMMIT(pRExC_state, data,minlenp); /* Cannot merge strings after this. */
4658 if (flags & SCF_DO_STCLASS)
4659 cl_init_zero(pRExC_state, &accum);
4665 const regnode *nextbranch= NULL;
4668 for ( word=1 ; word <= trie->wordcount ; word++)
4670 I32 deltanext=0, minnext=0, f = 0, fake;
4671 struct regnode_charclass_class this_class;
4673 data_fake.flags = 0;
4675 data_fake.whilem_c = data->whilem_c;
4676 data_fake.last_closep = data->last_closep;
4679 data_fake.last_closep = &fake;
4680 data_fake.pos_delta = delta;
4681 if (flags & SCF_DO_STCLASS) {
4682 cl_init(pRExC_state, &this_class);
4683 data_fake.start_class = &this_class;
4684 f = SCF_DO_STCLASS_AND;
4686 if (flags & SCF_WHILEM_VISITED_POS)
4687 f |= SCF_WHILEM_VISITED_POS;
4689 if (trie->jump[word]) {
4691 nextbranch = trie_node + trie->jump[0];
4692 scan= trie_node + trie->jump[word];
4693 /* We go from the jump point to the branch that follows
4694 it. Note this means we need the vestigal unused branches
4695 even though they arent otherwise used.
4697 minnext = study_chunk(pRExC_state, &scan, minlenp,
4698 &deltanext, (regnode *)nextbranch, &data_fake,
4699 stopparen, recursed, NULL, f,depth+1);
4701 if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
4702 nextbranch= regnext((regnode*)nextbranch);
4704 if (min1 > (I32)(minnext + trie->minlen))
4705 min1 = minnext + trie->minlen;
4706 if (max1 < (I32)(minnext + deltanext + trie->maxlen))
4707 max1 = minnext + deltanext + trie->maxlen;
4708 if (deltanext == I32_MAX)
4709 is_inf = is_inf_internal = 1;
4711 if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4713 if (data_fake.flags & SCF_SEEN_ACCEPT) {
4714 if ( stopmin > min + min1)
4715 stopmin = min + min1;
4716 flags &= ~SCF_DO_SUBSTR;
4718 data->flags |= SCF_SEEN_ACCEPT;
4721 if (data_fake.flags & SF_HAS_EVAL)
4722 data->flags |= SF_HAS_EVAL;
4723 data->whilem_c = data_fake.whilem_c;
4725 if (flags & SCF_DO_STCLASS)
4726 cl_or(pRExC_state, &accum, &this_class);
4729 if (flags & SCF_DO_SUBSTR) {
4730 data->pos_min += min1;
4731 data->pos_delta += max1 - min1;
4732 if (max1 != min1 || is_inf)
4733 data->longest = &(data->longest_float);
4736 delta += max1 - min1;
4737 if (flags & SCF_DO_STCLASS_OR) {
4738 cl_or(pRExC_state, data->start_class, &accum);
4740 cl_and(data->start_class, and_withp);
4741 flags &= ~SCF_DO_STCLASS;
4744 else if (flags & SCF_DO_STCLASS_AND) {
4746 cl_and(data->start_class, &accum);
4747 flags &= ~SCF_DO_STCLASS;
4750 /* Switch to OR mode: cache the old value of
4751 * data->start_class */
4753 StructCopy(data->start_class, and_withp,
4754 struct regnode_charclass_class);
4755 flags &= ~SCF_DO_STCLASS_AND;
4756 StructCopy(&accum, data->start_class,
4757 struct regnode_charclass_class);
4758 flags |= SCF_DO_STCLASS_OR;
4759 data->start_class->flags |= ANYOF_EOS;
4766 else if (PL_regkind[OP(scan)] == TRIE) {
4767 reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
4770 min += trie->minlen;
4771 delta += (trie->maxlen - trie->minlen);
4772 flags &= ~SCF_DO_STCLASS; /* xxx */
4773 if (flags & SCF_DO_SUBSTR) {
4774 SCAN_COMMIT(pRExC_state,data,minlenp); /* Cannot expect anything... */
4775 data->pos_min += trie->minlen;
4776 data->pos_delta += (trie->maxlen - trie->minlen);
4777 if (trie->maxlen != trie->minlen)
4778 data->longest = &(data->longest_float);
4780 if (trie->jump) /* no more substrings -- for now /grr*/
4781 flags &= ~SCF_DO_SUBSTR;
4783 #endif /* old or new */
4784 #endif /* TRIE_STUDY_OPT */
4786 /* Else: zero-length, ignore. */
4787 scan = regnext(scan);
4792 stopparen = frame->stop;
4793 frame = frame->prev;
4794 goto fake_study_recurse;
4799 DEBUG_STUDYDATA("pre-fin:",data,depth);
4802 *deltap = is_inf_internal ? I32_MAX : delta;
4803 if (flags & SCF_DO_SUBSTR && is_inf)
4804 data->pos_delta = I32_MAX - data->pos_min;
4805 if (is_par > (I32)U8_MAX)
4807 if (is_par && pars==1 && data) {
4808 data->flags |= SF_IN_PAR;
4809 data->flags &= ~SF_HAS_PAR;
4811 else if (pars && data) {
4812 data->flags |= SF_HAS_PAR;
4813 data->flags &= ~SF_IN_PAR;
4815 if (flags & SCF_DO_STCLASS_OR)
4816 cl_and(data->start_class, and_withp);
4817 if (flags & SCF_TRIE_RESTUDY)
4818 data->flags |= SCF_TRIE_RESTUDY;
4820 DEBUG_STUDYDATA("post-fin:",data,depth);
4822 return min < stopmin ? min : stopmin;
4826 S_add_data(RExC_state_t *pRExC_state, U32 n, const char *s)
4828 U32 count = RExC_rxi->data ? RExC_rxi->data->count : 0;
4830 PERL_ARGS_ASSERT_ADD_DATA;
4832 Renewc(RExC_rxi->data,
4833 sizeof(*RExC_rxi->data) + sizeof(void*) * (count + n - 1),
4834 char, struct reg_data);
4836 Renew(RExC_rxi->data->what, count + n, U8);
4838 Newx(RExC_rxi->data->what, n, U8);
4839 RExC_rxi->data->count = count + n;
4840 Copy(s, RExC_rxi->data->what + count, n, U8);
4844 /*XXX: todo make this not included in a non debugging perl */
4845 #ifndef PERL_IN_XSUB_RE
4847 Perl_reginitcolors(pTHX)
4850 const char * const s = PerlEnv_getenv("PERL_RE_COLORS");
4852 char *t = savepv(s);
4856 t = strchr(t, '\t');
4862 PL_colors[i] = t = (char *)"";
4867 PL_colors[i++] = (char *)"";
4874 #ifdef TRIE_STUDY_OPT
4875 #define CHECK_RESTUDY_GOTO \
4877 (data.flags & SCF_TRIE_RESTUDY) \
4881 #define CHECK_RESTUDY_GOTO
4885 * pregcomp - compile a regular expression into internal code
4887 * Decides which engine's compiler to call based on the hint currently in
4891 #ifndef PERL_IN_XSUB_RE
4893 /* return the currently in-scope regex engine (or the default if none) */
4895 regexp_engine const *
4896 Perl_current_re_engine(pTHX)
4900 if (IN_PERL_COMPILETIME) {
4901 HV * const table = GvHV(PL_hintgv);
4905 return &PL_core_reg_engine;
4906 ptr = hv_fetchs(table, "regcomp", FALSE);
4907 if ( !(ptr && SvIOK(*ptr) && SvIV(*ptr)))
4908 return &PL_core_reg_engine;
4909 return INT2PTR(regexp_engine*,SvIV(*ptr));
4913 if (!PL_curcop->cop_hints_hash)
4914 return &PL_core_reg_engine;
4915 ptr = cop_hints_fetch_pvs(PL_curcop, "regcomp", 0);
4916 if ( !(ptr && SvIOK(ptr) && SvIV(ptr)))
4917 return &PL_core_reg_engine;
4918 return INT2PTR(regexp_engine*,SvIV(ptr));
4924 Perl_pregcomp(pTHX_ SV * const pattern, const U32 flags)
4927 regexp_engine const *eng = current_re_engine();
4928 GET_RE_DEBUG_FLAGS_DECL;
4930 PERL_ARGS_ASSERT_PREGCOMP;
4932 /* Dispatch a request to compile a regexp to correct regexp engine. */
4934 PerlIO_printf(Perl_debug_log, "Using engine %"UVxf"\n",
4937 return CALLREGCOMP_ENG(eng, pattern, flags);
4941 /* public(ish) entry point for the perl core's own regex compiling code.
4942 * It's actually a wrapper for Perl_re_op_compile that only takes an SV
4943 * pattern rather than a list of OPs, and uses the internal engine rather
4944 * than the current one */
4947 Perl_re_compile(pTHX_ SV * const pattern, U32 rx_flags)
4949 SV *pat = pattern; /* defeat constness! */
4950 PERL_ARGS_ASSERT_RE_COMPILE;
4951 return Perl_re_op_compile(aTHX_ &pat, 1, NULL,
4952 #ifdef PERL_IN_XSUB_RE
4955 &PL_core_reg_engine,
4957 NULL, NULL, rx_flags, 0);
4960 /* see if there are any run-time code blocks in the pattern.
4961 * False positives are allowed */
4964 S_has_runtime_code(pTHX_ RExC_state_t * const pRExC_state, OP *expr,
4965 U32 pm_flags, char *pat, STRLEN plen)
4970 /* avoid infinitely recursing when we recompile the pattern parcelled up
4971 * as qr'...'. A single constant qr// string can't have have any
4972 * run-time component in it, and thus, no runtime code. (A non-qr
4973 * string, however, can, e.g. $x =~ '(?{})') */
4974 if ((pm_flags & PMf_IS_QR) && expr && expr->op_type == OP_CONST)
4977 for (s = 0; s < plen; s++) {
4978 if (n < pRExC_state->num_code_blocks
4979 && s == pRExC_state->code_blocks[n].start)
4981 s = pRExC_state->code_blocks[n].end;
4985 /* TODO ideally should handle [..], (#..), /#.../x to reduce false
4987 if (pat[s] == '(' && pat[s+1] == '?' &&
4988 (pat[s+2] == '{' || (pat[s+2] == '?' && pat[s+3] == '{'))
4995 /* Handle run-time code blocks. We will already have compiled any direct
4996 * or indirect literal code blocks. Now, take the pattern 'pat' and make a
4997 * copy of it, but with any literal code blocks blanked out and
4998 * appropriate chars escaped; then feed it into
5000 * eval "qr'modified_pattern'"
5004 * a\bc(?{"this was literal"})def'ghi\\jkl(?{"this is runtime"})mno
5008 * qr'a\\bc_______________________def\'ghi\\\\jkl(?{"this is runtime"})mno'
5010 * After eval_sv()-ing that, grab any new code blocks from the returned qr
5011 * and merge them with any code blocks of the original regexp.
5013 * If the pat is non-UTF8, while the evalled qr is UTF8, don't merge;
5014 * instead, just save the qr and return FALSE; this tells our caller that
5015 * the original pattern needs upgrading to utf8.
5019 S_compile_runtime_code(pTHX_ RExC_state_t * const pRExC_state,
5020 char *pat, STRLEN plen)
5024 GET_RE_DEBUG_FLAGS_DECL;
5026 if (pRExC_state->runtime_code_qr) {
5027 /* this is the second time we've been called; this should
5028 * only happen if the main pattern got upgraded to utf8
5029 * during compilation; re-use the qr we compiled first time
5030 * round (which should be utf8 too)
5032 qr = pRExC_state->runtime_code_qr;
5033 pRExC_state->runtime_code_qr = NULL;
5034 assert(RExC_utf8 && SvUTF8(qr));
5040 int newlen = plen + 6; /* allow for "qr''x\0" extra chars */
5044 /* determine how many extra chars we need for ' and \ escaping */
5045 for (s = 0; s < plen; s++) {
5046 if (pat[s] == '\'' || pat[s] == '\\')
5050 Newx(newpat, newlen, char);
5052 *p++ = 'q'; *p++ = 'r'; *p++ = '\'';
5054 for (s = 0; s < plen; s++) {
5055 if (n < pRExC_state->num_code_blocks
5056 && s == pRExC_state->code_blocks[n].start)
5058 /* blank out literal code block */
5059 assert(pat[s] == '(');
5060 while (s <= pRExC_state->code_blocks[n].end) {
5068 if (pat[s] == '\'' || pat[s] == '\\')
5073 if (pRExC_state->pm_flags & RXf_PMf_EXTENDED)
5077 PerlIO_printf(Perl_debug_log,
5078 "%sre-parsing pattern for runtime code:%s %s\n",
5079 PL_colors[4],PL_colors[5],newpat);
5082 sv = newSVpvn_flags(newpat, p-newpat-1, RExC_utf8 ? SVf_UTF8 : 0);
5088 PUSHSTACKi(PERLSI_REQUIRE);
5089 /* this causes the toker to collapse \\ into \ when parsing
5090 * qr''; normally only q'' does this. It also alters hints
5092 PL_reg_state.re_reparsing = TRUE;
5093 eval_sv(sv, G_SCALAR);
5100 Safefree(pRExC_state->code_blocks);
5101 Perl_croak(aTHX_ "%s", SvPVx_nolen_const(ERRSV));
5103 assert(SvROK(qr_ref));
5105 assert(SvTYPE(qr) == SVt_REGEXP && RX_ENGINE((REGEXP*)qr)->op_comp);
5106 /* the leaving below frees the tmp qr_ref.
5107 * Give qr a life of its own */
5115 if (!RExC_utf8 && SvUTF8(qr)) {
5116 /* first time through; the pattern got upgraded; save the
5117 * qr for the next time through */
5118 assert(!pRExC_state->runtime_code_qr);
5119 pRExC_state->runtime_code_qr = qr;
5124 /* extract any code blocks within the returned qr// */
5127 /* merge the main (r1) and run-time (r2) code blocks into one */
5129 RXi_GET_DECL(ReANY((REGEXP *)qr), r2);
5130 struct reg_code_block *new_block, *dst;
5131 RExC_state_t * const r1 = pRExC_state; /* convenient alias */
5134 if (!r2->num_code_blocks) /* we guessed wrong */
5141 r1->num_code_blocks + r2->num_code_blocks,
5142 struct reg_code_block);
5145 while ( i1 < r1->num_code_blocks
5146 || i2 < r2->num_code_blocks)
5148 struct reg_code_block *src;
5151 if (i1 == r1->num_code_blocks) {
5152 src = &r2->code_blocks[i2++];
5155 else if (i2 == r2->num_code_blocks)
5156 src = &r1->code_blocks[i1++];
5157 else if ( r1->code_blocks[i1].start
5158 < r2->code_blocks[i2].start)
5160 src = &r1->code_blocks[i1++];
5161 assert(src->end < r2->code_blocks[i2].start);
5164 assert( r1->code_blocks[i1].start
5165 > r2->code_blocks[i2].start);
5166 src = &r2->code_blocks[i2++];
5168 assert(src->end < r1->code_blocks[i1].start);
5171 assert(pat[src->start] == '(');
5172 assert(pat[src->end] == ')');
5173 dst->start = src->start;
5174 dst->end = src->end;
5175 dst->block = src->block;
5176 dst->src_regex = is_qr ? (REGEXP*) SvREFCNT_inc( (SV*) qr)
5180 r1->num_code_blocks += r2->num_code_blocks;
5181 Safefree(r1->code_blocks);
5182 r1->code_blocks = new_block;
5191 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)
5193 /* This is the common code for setting up the floating and fixed length
5194 * string data extracted from Perlre_op_compile() below. Returns a boolean
5195 * as to whether succeeded or not */
5199 if (! (longest_length
5200 || (eol /* Can't have SEOL and MULTI */
5201 && (! meol || (RExC_flags & RXf_PMf_MULTILINE)))
5203 /* See comments for join_exact for why REG_SEEN_EXACTF_SHARP_S */
5204 || (RExC_seen & REG_SEEN_EXACTF_SHARP_S))
5209 /* copy the information about the longest from the reg_scan_data
5210 over to the program. */
5211 if (SvUTF8(sv_longest)) {
5212 *rx_utf8 = sv_longest;
5215 *rx_substr = sv_longest;
5218 /* end_shift is how many chars that must be matched that
5219 follow this item. We calculate it ahead of time as once the
5220 lookbehind offset is added in we lose the ability to correctly
5222 ml = minlen ? *(minlen) : (I32)longest_length;
5223 *rx_end_shift = ml - offset
5224 - longest_length + (SvTAIL(sv_longest) != 0)
5227 t = (eol/* Can't have SEOL and MULTI */
5228 && (! meol || (RExC_flags & RXf_PMf_MULTILINE)));
5229 fbm_compile(sv_longest, t ? FBMcf_TAIL : 0);
5235 * Perl_re_op_compile - the perl internal RE engine's function to compile a
5236 * regular expression into internal code.
5237 * The pattern may be passed either as:
5238 * a list of SVs (patternp plus pat_count)
5239 * a list of OPs (expr)
5240 * If both are passed, the SV list is used, but the OP list indicates
5241 * which SVs are actually pre-compiled code blocks
5243 * The SVs in the list have magic and qr overloading applied to them (and
5244 * the list may be modified in-place with replacement SVs in the latter
5247 * If the pattern hasn't changed from old_re, then old_re will be
5250 * eng is the current engine. If that engine has an op_comp method, then
5251 * handle directly (i.e. we assume that op_comp was us); otherwise, just
5252 * do the initial concatenation of arguments and pass on to the external
5255 * If is_bare_re is not null, set it to a boolean indicating whether the
5256 * arg list reduced (after overloading) to a single bare regex which has
5257 * been returned (i.e. /$qr/).
5259 * orig_rx_flags contains RXf_* flags. See perlreapi.pod for more details.
5261 * pm_flags contains the PMf_* flags, typically based on those from the
5262 * pm_flags field of the related PMOP. Currently we're only interested in
5263 * PMf_HAS_CV, PMf_IS_QR, PMf_USE_RE_EVAL.
5265 * We can't allocate space until we know how big the compiled form will be,
5266 * but we can't compile it (and thus know how big it is) until we've got a
5267 * place to put the code. So we cheat: we compile it twice, once with code
5268 * generation turned off and size counting turned on, and once "for real".
5269 * This also means that we don't allocate space until we are sure that the
5270 * thing really will compile successfully, and we never have to move the
5271 * code and thus invalidate pointers into it. (Note that it has to be in
5272 * one piece because free() must be able to free it all.) [NB: not true in perl]
5274 * Beware that the optimization-preparation code in here knows about some
5275 * of the structure of the compiled regexp. [I'll say.]
5279 Perl_re_op_compile(pTHX_ SV ** const patternp, int pat_count,
5280 OP *expr, const regexp_engine* eng, REGEXP *VOL old_re,
5281 bool *is_bare_re, U32 orig_rx_flags, U32 pm_flags)
5286 regexp_internal *ri;
5295 SV * VOL code_blocksv = NULL;
5297 /* these are all flags - maybe they should be turned
5298 * into a single int with different bit masks */
5299 I32 sawlookahead = 0;
5302 bool used_setjump = FALSE;
5303 regex_charset initial_charset = get_regex_charset(orig_rx_flags);
5304 bool code_is_utf8 = 0;
5305 bool VOL recompile = 0;
5306 bool runtime_code = 0;
5310 RExC_state_t RExC_state;
5311 RExC_state_t * const pRExC_state = &RExC_state;
5312 #ifdef TRIE_STUDY_OPT
5314 RExC_state_t copyRExC_state;
5316 GET_RE_DEBUG_FLAGS_DECL;
5318 PERL_ARGS_ASSERT_RE_OP_COMPILE;
5320 DEBUG_r(if (!PL_colorset) reginitcolors());
5322 #ifndef PERL_IN_XSUB_RE
5323 /* Initialize these here instead of as-needed, as is quick and avoids
5324 * having to test them each time otherwise */
5325 if (! PL_AboveLatin1) {
5326 PL_AboveLatin1 = _new_invlist_C_array(AboveLatin1_invlist);
5327 PL_ASCII = _new_invlist_C_array(ASCII_invlist);
5328 PL_Latin1 = _new_invlist_C_array(Latin1_invlist);
5330 PL_L1PosixAlnum = _new_invlist_C_array(L1PosixAlnum_invlist);
5331 PL_PosixAlnum = _new_invlist_C_array(PosixAlnum_invlist);
5333 PL_L1PosixAlpha = _new_invlist_C_array(L1PosixAlpha_invlist);
5334 PL_PosixAlpha = _new_invlist_C_array(PosixAlpha_invlist);
5336 PL_PosixBlank = _new_invlist_C_array(PosixBlank_invlist);
5337 PL_XPosixBlank = _new_invlist_C_array(XPosixBlank_invlist);
5339 PL_L1Cased = _new_invlist_C_array(L1Cased_invlist);
5341 PL_PosixCntrl = _new_invlist_C_array(PosixCntrl_invlist);
5342 PL_XPosixCntrl = _new_invlist_C_array(XPosixCntrl_invlist);
5344 PL_PosixDigit = _new_invlist_C_array(PosixDigit_invlist);
5346 PL_L1PosixGraph = _new_invlist_C_array(L1PosixGraph_invlist);
5347 PL_PosixGraph = _new_invlist_C_array(PosixGraph_invlist);
5349 PL_L1PosixLower = _new_invlist_C_array(L1PosixLower_invlist);
5350 PL_PosixLower = _new_invlist_C_array(PosixLower_invlist);
5352 PL_L1PosixPrint = _new_invlist_C_array(L1PosixPrint_invlist);
5353 PL_PosixPrint = _new_invlist_C_array(PosixPrint_invlist);
5355 PL_L1PosixPunct = _new_invlist_C_array(L1PosixPunct_invlist);
5356 PL_PosixPunct = _new_invlist_C_array(PosixPunct_invlist);
5358 PL_PerlSpace = _new_invlist_C_array(PerlSpace_invlist);
5359 PL_XPerlSpace = _new_invlist_C_array(XPerlSpace_invlist);
5361 PL_PosixSpace = _new_invlist_C_array(PosixSpace_invlist);
5362 PL_XPosixSpace = _new_invlist_C_array(XPosixSpace_invlist);
5364 PL_L1PosixUpper = _new_invlist_C_array(L1PosixUpper_invlist);
5365 PL_PosixUpper = _new_invlist_C_array(PosixUpper_invlist);
5367 PL_VertSpace = _new_invlist_C_array(VertSpace_invlist);
5369 PL_PosixWord = _new_invlist_C_array(PosixWord_invlist);
5370 PL_L1PosixWord = _new_invlist_C_array(L1PosixWord_invlist);
5372 PL_PosixXDigit = _new_invlist_C_array(PosixXDigit_invlist);
5373 PL_XPosixXDigit = _new_invlist_C_array(XPosixXDigit_invlist);
5375 PL_HasMultiCharFold = _new_invlist_C_array(_Perl_Multi_Char_Folds_invlist);
5379 pRExC_state->code_blocks = NULL;
5380 pRExC_state->num_code_blocks = 0;
5383 *is_bare_re = FALSE;
5385 if (expr && (expr->op_type == OP_LIST ||
5386 (expr->op_type == OP_NULL && expr->op_targ == OP_LIST))) {
5388 /* is the source UTF8, and how many code blocks are there? */
5392 for (o = cLISTOPx(expr)->op_first; o; o = o->op_sibling) {
5393 if (o->op_type == OP_CONST && SvUTF8(cSVOPo_sv))
5395 else if (o->op_type == OP_NULL && (o->op_flags & OPf_SPECIAL))
5396 /* count of DO blocks */
5400 pRExC_state->num_code_blocks = ncode;
5401 Newx(pRExC_state->code_blocks, ncode, struct reg_code_block);
5406 /* handle a list of SVs */
5410 /* apply magic and RE overloading to each arg */
5411 for (svp = patternp; svp < patternp + pat_count; svp++) {
5414 if (SvROK(rx) && SvAMAGIC(rx)) {
5415 SV *sv = AMG_CALLunary(rx, regexp_amg);
5419 if (SvTYPE(sv) != SVt_REGEXP)
5420 Perl_croak(aTHX_ "Overloaded qr did not return a REGEXP");
5426 if (pat_count > 1) {
5427 /* concat multiple args and find any code block indexes */
5432 STRLEN orig_patlen = 0;
5434 if (pRExC_state->num_code_blocks) {
5435 o = cLISTOPx(expr)->op_first;
5436 assert( o->op_type == OP_PUSHMARK
5437 || (o->op_type == OP_NULL && o->op_targ == OP_PUSHMARK)
5438 || o->op_type == OP_PADRANGE);
5442 pat = newSVpvn("", 0);
5445 /* determine if the pattern is going to be utf8 (needed
5446 * in advance to align code block indices correctly).
5447 * XXX This could fail to be detected for an arg with
5448 * overloading but not concat overloading; but the main effect
5449 * in this obscure case is to need a 'use re eval' for a
5450 * literal code block */
5451 for (svp = patternp; svp < patternp + pat_count; svp++) {
5458 for (svp = patternp; svp < patternp + pat_count; svp++) {
5459 SV *sv, *msv = *svp;
5462 /* we make the assumption here that each op in the list of
5463 * op_siblings maps to one SV pushed onto the stack,
5464 * except for code blocks, with have both an OP_NULL and
5466 * This allows us to match up the list of SVs against the
5467 * list of OPs to find the next code block.
5469 * Note that PUSHMARK PADSV PADSV ..
5471 * PADRANGE NULL NULL ..
5472 * so the alignment still works. */
5474 if (o->op_type == OP_NULL && (o->op_flags & OPf_SPECIAL)) {
5475 assert(n < pRExC_state->num_code_blocks);
5476 pRExC_state->code_blocks[n].start = SvCUR(pat);
5477 pRExC_state->code_blocks[n].block = o;
5478 pRExC_state->code_blocks[n].src_regex = NULL;
5481 o = o->op_sibling; /* skip CONST */
5487 if ((SvAMAGIC(pat) || SvAMAGIC(msv)) &&
5488 (sv = amagic_call(pat, msv, concat_amg, AMGf_assign)))
5491 /* overloading involved: all bets are off over literal
5492 * code. Pretend we haven't seen it */
5493 pRExC_state->num_code_blocks -= n;
5499 while (SvAMAGIC(msv)
5500 && (sv = AMG_CALLunary(msv, string_amg))
5504 && SvRV(msv) == SvRV(sv))
5509 if (SvROK(msv) && SvTYPE(SvRV(msv)) == SVt_REGEXP)
5511 orig_patlen = SvCUR(pat);
5512 sv_catsv_nomg(pat, msv);
5515 pRExC_state->code_blocks[n-1].end = SvCUR(pat)-1;
5518 /* extract any code blocks within any embedded qr//'s */
5519 if (rx && SvTYPE(rx) == SVt_REGEXP
5520 && RX_ENGINE((REGEXP*)rx)->op_comp)
5523 RXi_GET_DECL(ReANY((REGEXP *)rx), ri);
5524 if (ri->num_code_blocks) {
5526 /* the presence of an embedded qr// with code means
5527 * we should always recompile: the text of the
5528 * qr// may not have changed, but it may be a
5529 * different closure than last time */
5531 Renew(pRExC_state->code_blocks,
5532 pRExC_state->num_code_blocks + ri->num_code_blocks,
5533 struct reg_code_block);
5534 pRExC_state->num_code_blocks += ri->num_code_blocks;
5535 for (i=0; i < ri->num_code_blocks; i++) {
5536 struct reg_code_block *src, *dst;
5537 STRLEN offset = orig_patlen
5538 + ReANY((REGEXP *)rx)->pre_prefix;
5539 assert(n < pRExC_state->num_code_blocks);
5540 src = &ri->code_blocks[i];
5541 dst = &pRExC_state->code_blocks[n];
5542 dst->start = src->start + offset;
5543 dst->end = src->end + offset;
5544 dst->block = src->block;
5545 dst->src_regex = (REGEXP*) SvREFCNT_inc( (SV*)
5559 while (SvAMAGIC(pat)
5560 && (sv = AMG_CALLunary(pat, string_amg))
5568 /* handle bare regex: foo =~ $re */
5573 if (SvTYPE(re) == SVt_REGEXP) {
5577 Safefree(pRExC_state->code_blocks);
5583 /* not a list of SVs, so must be a list of OPs */
5585 if (expr->op_type == OP_LIST) {
5590 pat = newSVpvn("", 0);
5595 /* given a list of CONSTs and DO blocks in expr, append all
5596 * the CONSTs to pat, and record the start and end of each
5597 * code block in code_blocks[] (each DO{} op is followed by an
5598 * OP_CONST containing the corresponding literal '(?{...})
5601 for (o = cLISTOPx(expr)->op_first; o; o = o->op_sibling) {
5602 if (o->op_type == OP_CONST) {
5603 sv_catsv(pat, cSVOPo_sv);
5605 pRExC_state->code_blocks[i].end = SvCUR(pat)-1;
5609 else if (o->op_type == OP_NULL && (o->op_flags & OPf_SPECIAL)) {
5610 assert(i+1 < pRExC_state->num_code_blocks);
5611 pRExC_state->code_blocks[++i].start = SvCUR(pat);
5612 pRExC_state->code_blocks[i].block = o;
5613 pRExC_state->code_blocks[i].src_regex = NULL;
5619 assert(expr->op_type == OP_CONST);
5620 pat = cSVOPx_sv(expr);
5624 exp = SvPV_nomg(pat, plen);
5626 if (!eng->op_comp) {
5627 if ((SvUTF8(pat) && IN_BYTES)
5628 || SvGMAGICAL(pat) || SvAMAGIC(pat))
5630 /* make a temporary copy; either to convert to bytes,
5631 * or to avoid repeating get-magic / overloaded stringify */
5632 pat = newSVpvn_flags(exp, plen, SVs_TEMP |
5633 (IN_BYTES ? 0 : SvUTF8(pat)));
5635 Safefree(pRExC_state->code_blocks);
5636 return CALLREGCOMP_ENG(eng, pat, orig_rx_flags);
5639 /* ignore the utf8ness if the pattern is 0 length */
5640 RExC_utf8 = RExC_orig_utf8 = (plen == 0 || IN_BYTES) ? 0 : SvUTF8(pat);
5641 RExC_uni_semantics = 0;
5642 RExC_contains_locale = 0;
5643 pRExC_state->runtime_code_qr = NULL;
5645 /****************** LONG JUMP TARGET HERE***********************/
5646 /* Longjmp back to here if have to switch in midstream to utf8 */
5647 if (! RExC_orig_utf8) {
5648 JMPENV_PUSH(jump_ret);
5649 used_setjump = TRUE;
5652 if (jump_ret == 0) { /* First time through */
5656 SV *dsv= sv_newmortal();
5657 RE_PV_QUOTED_DECL(s, RExC_utf8,
5658 dsv, exp, plen, 60);
5659 PerlIO_printf(Perl_debug_log, "%sCompiling REx%s %s\n",
5660 PL_colors[4],PL_colors[5],s);
5663 else { /* longjumped back */
5666 STRLEN s = 0, d = 0;
5669 /* If the cause for the longjmp was other than changing to utf8, pop
5670 * our own setjmp, and longjmp to the correct handler */
5671 if (jump_ret != UTF8_LONGJMP) {
5673 JMPENV_JUMP(jump_ret);
5678 /* It's possible to write a regexp in ascii that represents Unicode
5679 codepoints outside of the byte range, such as via \x{100}. If we
5680 detect such a sequence we have to convert the entire pattern to utf8
5681 and then recompile, as our sizing calculation will have been based
5682 on 1 byte == 1 character, but we will need to use utf8 to encode
5683 at least some part of the pattern, and therefore must convert the whole
5686 DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log,
5687 "UTF8 mismatch! Converting to utf8 for resizing and compile\n"));
5689 /* upgrade pattern to UTF8, and if there are code blocks,
5690 * recalculate the indices.
5691 * This is essentially an unrolled Perl_bytes_to_utf8() */
5693 src = (U8*)SvPV_nomg(pat, plen);
5694 Newx(dst, plen * 2 + 1, U8);
5697 const UV uv = NATIVE_TO_ASCII(src[s]);
5698 if (UNI_IS_INVARIANT(uv))
5699 dst[d] = (U8)UTF_TO_NATIVE(uv);
5701 dst[d++] = (U8)UTF8_EIGHT_BIT_HI(uv);
5702 dst[d] = (U8)UTF8_EIGHT_BIT_LO(uv);
5704 if (n < pRExC_state->num_code_blocks) {
5705 if (!do_end && pRExC_state->code_blocks[n].start == s) {
5706 pRExC_state->code_blocks[n].start = d;
5707 assert(dst[d] == '(');
5710 else if (do_end && pRExC_state->code_blocks[n].end == s) {
5711 pRExC_state->code_blocks[n].end = d;
5712 assert(dst[d] == ')');
5725 RExC_orig_utf8 = RExC_utf8 = 1;
5728 /* return old regex if pattern hasn't changed */
5732 && !!RX_UTF8(old_re) == !!RExC_utf8
5733 && RX_PRECOMP(old_re)
5734 && RX_PRELEN(old_re) == plen
5735 && memEQ(RX_PRECOMP(old_re), exp, plen))
5737 /* with runtime code, always recompile */
5738 runtime_code = S_has_runtime_code(aTHX_ pRExC_state, expr, pm_flags,
5740 if (!runtime_code) {
5744 Safefree(pRExC_state->code_blocks);
5748 else if ((pm_flags & PMf_USE_RE_EVAL)
5749 /* this second condition covers the non-regex literal case,
5750 * i.e. $foo =~ '(?{})'. */
5751 || ( !PL_reg_state.re_reparsing && IN_PERL_COMPILETIME
5752 && (PL_hints & HINT_RE_EVAL))
5754 runtime_code = S_has_runtime_code(aTHX_ pRExC_state, expr, pm_flags,
5757 #ifdef TRIE_STUDY_OPT
5761 rx_flags = orig_rx_flags;
5763 if (initial_charset == REGEX_LOCALE_CHARSET) {
5764 RExC_contains_locale = 1;
5766 else if (RExC_utf8 && initial_charset == REGEX_DEPENDS_CHARSET) {
5768 /* Set to use unicode semantics if the pattern is in utf8 and has the
5769 * 'depends' charset specified, as it means unicode when utf8 */
5770 set_regex_charset(&rx_flags, REGEX_UNICODE_CHARSET);
5774 RExC_flags = rx_flags;
5775 RExC_pm_flags = pm_flags;
5778 if (TAINTING_get && TAINT_get)
5779 Perl_croak(aTHX_ "Eval-group in insecure regular expression");
5781 if (!S_compile_runtime_code(aTHX_ pRExC_state, exp, plen)) {
5782 /* whoops, we have a non-utf8 pattern, whilst run-time code
5783 * got compiled as utf8. Try again with a utf8 pattern */
5784 JMPENV_JUMP(UTF8_LONGJMP);
5787 assert(!pRExC_state->runtime_code_qr);
5792 RExC_in_lookbehind = 0;
5793 RExC_seen_zerolen = *exp == '^' ? -1 : 0;
5795 RExC_override_recoding = 0;
5796 RExC_in_multi_char_class = 0;
5798 /* First pass: determine size, legality. */
5806 RExC_emit = &PL_regdummy;
5807 RExC_whilem_seen = 0;
5808 RExC_open_parens = NULL;
5809 RExC_close_parens = NULL;
5811 RExC_paren_names = NULL;
5813 RExC_paren_name_list = NULL;
5815 RExC_recurse = NULL;
5816 RExC_recurse_count = 0;
5817 pRExC_state->code_index = 0;
5819 #if 0 /* REGC() is (currently) a NOP at the first pass.
5820 * Clever compilers notice this and complain. --jhi */
5821 REGC((U8)REG_MAGIC, (char*)RExC_emit);
5824 PerlIO_printf(Perl_debug_log, "Starting first pass (sizing)\n");
5826 RExC_lastparse=NULL;
5828 /* reg may croak on us, not giving us a chance to free
5829 pRExC_state->code_blocks. We cannot SAVEFREEPV it now, as we may
5830 need it to survive as long as the regexp (qr/(?{})/).
5831 We must check that code_blocksv is not already set, because we may
5832 have longjmped back. */
5833 if (pRExC_state->code_blocks && !code_blocksv) {
5834 code_blocksv = newSV_type(SVt_PV);
5835 SAVEFREESV(code_blocksv);
5836 SvPV_set(code_blocksv, (char *)pRExC_state->code_blocks);
5837 SvLEN_set(code_blocksv, 1); /*sufficient to make sv_clear free it*/
5839 if (reg(pRExC_state, 0, &flags,1) == NULL) {
5840 RExC_precomp = NULL;
5844 SvLEN_set(code_blocksv,0); /* no you can't have it, sv_clear */
5846 /* Here, finished first pass. Get rid of any added setjmp */
5852 PerlIO_printf(Perl_debug_log,
5853 "Required size %"IVdf" nodes\n"
5854 "Starting second pass (creation)\n",
5857 RExC_lastparse=NULL;
5860 /* The first pass could have found things that force Unicode semantics */
5861 if ((RExC_utf8 || RExC_uni_semantics)
5862 && get_regex_charset(rx_flags) == REGEX_DEPENDS_CHARSET)
5864 set_regex_charset(&rx_flags, REGEX_UNICODE_CHARSET);
5867 /* Small enough for pointer-storage convention?
5868 If extralen==0, this means that we will not need long jumps. */
5869 if (RExC_size >= 0x10000L && RExC_extralen)
5870 RExC_size += RExC_extralen;
5873 if (RExC_whilem_seen > 15)
5874 RExC_whilem_seen = 15;
5876 /* Allocate space and zero-initialize. Note, the two step process
5877 of zeroing when in debug mode, thus anything assigned has to
5878 happen after that */
5879 rx = (REGEXP*) newSV_type(SVt_REGEXP);
5881 Newxc(ri, sizeof(regexp_internal) + (unsigned)RExC_size * sizeof(regnode),
5882 char, regexp_internal);
5883 if ( r == NULL || ri == NULL )
5884 FAIL("Regexp out of space");
5886 /* avoid reading uninitialized memory in DEBUGGING code in study_chunk() */
5887 Zero(ri, sizeof(regexp_internal) + (unsigned)RExC_size * sizeof(regnode), char);
5889 /* bulk initialize base fields with 0. */
5890 Zero(ri, sizeof(regexp_internal), char);
5893 /* non-zero initialization begins here */
5896 r->extflags = rx_flags;
5897 if (pm_flags & PMf_IS_QR) {
5898 ri->code_blocks = pRExC_state->code_blocks;
5899 ri->num_code_blocks = pRExC_state->num_code_blocks;
5904 for (n = 0; n < pRExC_state->num_code_blocks; n++)
5905 if (pRExC_state->code_blocks[n].src_regex)
5906 SAVEFREESV(pRExC_state->code_blocks[n].src_regex);
5907 SAVEFREEPV(pRExC_state->code_blocks);
5911 bool has_p = ((r->extflags & RXf_PMf_KEEPCOPY) == RXf_PMf_KEEPCOPY);
5912 bool has_charset = (get_regex_charset(r->extflags) != REGEX_DEPENDS_CHARSET);
5914 /* The caret is output if there are any defaults: if not all the STD
5915 * flags are set, or if no character set specifier is needed */
5917 (((r->extflags & RXf_PMf_STD_PMMOD) != RXf_PMf_STD_PMMOD)
5919 bool has_runon = ((RExC_seen & REG_SEEN_RUN_ON_COMMENT)==REG_SEEN_RUN_ON_COMMENT);
5920 U16 reganch = (U16)((r->extflags & RXf_PMf_STD_PMMOD)
5921 >> RXf_PMf_STD_PMMOD_SHIFT);
5922 const char *fptr = STD_PAT_MODS; /*"msix"*/
5924 /* Allocate for the worst case, which is all the std flags are turned
5925 * on. If more precision is desired, we could do a population count of
5926 * the flags set. This could be done with a small lookup table, or by
5927 * shifting, masking and adding, or even, when available, assembly
5928 * language for a machine-language population count.
5929 * We never output a minus, as all those are defaults, so are
5930 * covered by the caret */
5931 const STRLEN wraplen = plen + has_p + has_runon
5932 + has_default /* If needs a caret */
5934 /* If needs a character set specifier */
5935 + ((has_charset) ? MAX_CHARSET_NAME_LENGTH : 0)
5936 + (sizeof(STD_PAT_MODS) - 1)
5937 + (sizeof("(?:)") - 1);
5939 Newx(p, wraplen + 1, char); /* +1 for the ending NUL */
5940 r->xpv_len_u.xpvlenu_pv = p;
5942 SvFLAGS(rx) |= SVf_UTF8;
5945 /* If a default, cover it using the caret */
5947 *p++= DEFAULT_PAT_MOD;
5951 const char* const name = get_regex_charset_name(r->extflags, &len);
5952 Copy(name, p, len, char);
5956 *p++ = KEEPCOPY_PAT_MOD; /*'p'*/
5959 while((ch = *fptr++)) {
5967 Copy(RExC_precomp, p, plen, char);
5968 assert ((RX_WRAPPED(rx) - p) < 16);
5969 r->pre_prefix = p - RX_WRAPPED(rx);
5975 SvCUR_set(rx, p - RX_WRAPPED(rx));
5979 r->nparens = RExC_npar - 1; /* set early to validate backrefs */
5981 if (RExC_seen & REG_SEEN_RECURSE) {
5982 Newxz(RExC_open_parens, RExC_npar,regnode *);
5983 SAVEFREEPV(RExC_open_parens);
5984 Newxz(RExC_close_parens,RExC_npar,regnode *);
5985 SAVEFREEPV(RExC_close_parens);
5988 /* Useful during FAIL. */
5989 #ifdef RE_TRACK_PATTERN_OFFSETS
5990 Newxz(ri->u.offsets, 2*RExC_size+1, U32); /* MJD 20001228 */
5991 DEBUG_OFFSETS_r(PerlIO_printf(Perl_debug_log,
5992 "%s %"UVuf" bytes for offset annotations.\n",
5993 ri->u.offsets ? "Got" : "Couldn't get",
5994 (UV)((2*RExC_size+1) * sizeof(U32))));
5996 SetProgLen(ri,RExC_size);
6001 /* Second pass: emit code. */
6002 RExC_flags = rx_flags; /* don't let top level (?i) bleed */
6003 RExC_pm_flags = pm_flags;
6008 RExC_emit_start = ri->program;
6009 RExC_emit = ri->program;
6010 RExC_emit_bound = ri->program + RExC_size + 1;
6011 pRExC_state->code_index = 0;
6013 REGC((U8)REG_MAGIC, (char*) RExC_emit++);
6014 if (reg(pRExC_state, 0, &flags,1) == NULL) {
6018 /* XXXX To minimize changes to RE engine we always allocate
6019 3-units-long substrs field. */
6020 Newx(r->substrs, 1, struct reg_substr_data);
6021 if (RExC_recurse_count) {
6022 Newxz(RExC_recurse,RExC_recurse_count,regnode *);
6023 SAVEFREEPV(RExC_recurse);
6027 r->minlen = minlen = sawlookahead = sawplus = sawopen = 0;
6028 Zero(r->substrs, 1, struct reg_substr_data);
6030 #ifdef TRIE_STUDY_OPT
6032 StructCopy(&zero_scan_data, &data, scan_data_t);
6033 copyRExC_state = RExC_state;
6036 DEBUG_OPTIMISE_r(PerlIO_printf(Perl_debug_log,"Restudying\n"));
6038 RExC_state = copyRExC_state;
6039 if (seen & REG_TOP_LEVEL_BRANCHES)
6040 RExC_seen |= REG_TOP_LEVEL_BRANCHES;
6042 RExC_seen &= ~REG_TOP_LEVEL_BRANCHES;
6043 if (data.last_found) {
6044 SvREFCNT_dec(data.longest_fixed);
6045 SvREFCNT_dec(data.longest_float);
6046 SvREFCNT_dec(data.last_found);
6048 StructCopy(&zero_scan_data, &data, scan_data_t);
6051 StructCopy(&zero_scan_data, &data, scan_data_t);
6054 /* Dig out information for optimizations. */
6055 r->extflags = RExC_flags; /* was pm_op */
6056 /*dmq: removed as part of de-PMOP: pm->op_pmflags = RExC_flags; */
6059 SvUTF8_on(rx); /* Unicode in it? */
6060 ri->regstclass = NULL;
6061 if (RExC_naughty >= 10) /* Probably an expensive pattern. */
6062 r->intflags |= PREGf_NAUGHTY;
6063 scan = ri->program + 1; /* First BRANCH. */
6065 /* testing for BRANCH here tells us whether there is "must appear"
6066 data in the pattern. If there is then we can use it for optimisations */
6067 if (!(RExC_seen & REG_TOP_LEVEL_BRANCHES)) { /* Only one top-level choice. */
6069 STRLEN longest_float_length, longest_fixed_length;
6070 struct regnode_charclass_class ch_class; /* pointed to by data */
6072 I32 last_close = 0; /* pointed to by data */
6073 regnode *first= scan;
6074 regnode *first_next= regnext(first);
6076 * Skip introductions and multiplicators >= 1
6077 * so that we can extract the 'meat' of the pattern that must
6078 * match in the large if() sequence following.
6079 * NOTE that EXACT is NOT covered here, as it is normally
6080 * picked up by the optimiser separately.
6082 * This is unfortunate as the optimiser isnt handling lookahead
6083 * properly currently.
6086 while ((OP(first) == OPEN && (sawopen = 1)) ||
6087 /* An OR of *one* alternative - should not happen now. */
6088 (OP(first) == BRANCH && OP(first_next) != BRANCH) ||
6089 /* for now we can't handle lookbehind IFMATCH*/
6090 (OP(first) == IFMATCH && !first->flags && (sawlookahead = 1)) ||
6091 (OP(first) == PLUS) ||
6092 (OP(first) == MINMOD) ||
6093 /* An {n,m} with n>0 */
6094 (PL_regkind[OP(first)] == CURLY && ARG1(first) > 0) ||
6095 (OP(first) == NOTHING && PL_regkind[OP(first_next)] != END ))
6098 * the only op that could be a regnode is PLUS, all the rest
6099 * will be regnode_1 or regnode_2.
6102 if (OP(first) == PLUS)
6105 first += regarglen[OP(first)];
6107 first = NEXTOPER(first);
6108 first_next= regnext(first);
6111 /* Starting-point info. */
6113 DEBUG_PEEP("first:",first,0);
6114 /* Ignore EXACT as we deal with it later. */
6115 if (PL_regkind[OP(first)] == EXACT) {
6116 if (OP(first) == EXACT)
6117 NOOP; /* Empty, get anchored substr later. */
6119 ri->regstclass = first;
6122 else if (PL_regkind[OP(first)] == TRIE &&
6123 ((reg_trie_data *)ri->data->data[ ARG(first) ])->minlen>0)
6126 /* this can happen only on restudy */
6127 if ( OP(first) == TRIE ) {
6128 struct regnode_1 *trieop = (struct regnode_1 *)
6129 PerlMemShared_calloc(1, sizeof(struct regnode_1));
6130 StructCopy(first,trieop,struct regnode_1);
6131 trie_op=(regnode *)trieop;
6133 struct regnode_charclass *trieop = (struct regnode_charclass *)
6134 PerlMemShared_calloc(1, sizeof(struct regnode_charclass));
6135 StructCopy(first,trieop,struct regnode_charclass);
6136 trie_op=(regnode *)trieop;
6139 make_trie_failtable(pRExC_state, (regnode *)first, trie_op, 0);
6140 ri->regstclass = trie_op;
6143 else if (REGNODE_SIMPLE(OP(first)))
6144 ri->regstclass = first;
6145 else if (PL_regkind[OP(first)] == BOUND ||
6146 PL_regkind[OP(first)] == NBOUND)
6147 ri->regstclass = first;
6148 else if (PL_regkind[OP(first)] == BOL) {
6149 r->extflags |= (OP(first) == MBOL
6151 : (OP(first) == SBOL
6154 first = NEXTOPER(first);
6157 else if (OP(first) == GPOS) {
6158 r->extflags |= RXf_ANCH_GPOS;
6159 first = NEXTOPER(first);
6162 else if ((!sawopen || !RExC_sawback) &&
6163 (OP(first) == STAR &&
6164 PL_regkind[OP(NEXTOPER(first))] == REG_ANY) &&
6165 !(r->extflags & RXf_ANCH) && !pRExC_state->num_code_blocks)
6167 /* turn .* into ^.* with an implied $*=1 */
6169 (OP(NEXTOPER(first)) == REG_ANY)
6172 r->extflags |= type;
6173 r->intflags |= PREGf_IMPLICIT;
6174 first = NEXTOPER(first);
6177 if (sawplus && !sawlookahead && (!sawopen || !RExC_sawback)
6178 && !pRExC_state->num_code_blocks) /* May examine pos and $& */
6179 /* x+ must match at the 1st pos of run of x's */
6180 r->intflags |= PREGf_SKIP;
6182 /* Scan is after the zeroth branch, first is atomic matcher. */
6183 #ifdef TRIE_STUDY_OPT
6186 PerlIO_printf(Perl_debug_log, "first at %"IVdf"\n",
6187 (IV)(first - scan + 1))
6191 PerlIO_printf(Perl_debug_log, "first at %"IVdf"\n",
6192 (IV)(first - scan + 1))
6198 * If there's something expensive in the r.e., find the
6199 * longest literal string that must appear and make it the
6200 * regmust. Resolve ties in favor of later strings, since
6201 * the regstart check works with the beginning of the r.e.
6202 * and avoiding duplication strengthens checking. Not a
6203 * strong reason, but sufficient in the absence of others.
6204 * [Now we resolve ties in favor of the earlier string if
6205 * it happens that c_offset_min has been invalidated, since the
6206 * earlier string may buy us something the later one won't.]
6209 data.longest_fixed = newSVpvs("");
6210 data.longest_float = newSVpvs("");
6211 data.last_found = newSVpvs("");
6212 data.longest = &(data.longest_fixed);
6214 if (!ri->regstclass) {
6215 cl_init(pRExC_state, &ch_class);
6216 data.start_class = &ch_class;
6217 stclass_flag = SCF_DO_STCLASS_AND;
6218 } else /* XXXX Check for BOUND? */
6220 data.last_closep = &last_close;
6222 minlen = study_chunk(pRExC_state, &first, &minlen, &fake, scan + RExC_size, /* Up to end */
6223 &data, -1, NULL, NULL,
6224 SCF_DO_SUBSTR | SCF_WHILEM_VISITED_POS | stclass_flag,0);
6230 if ( RExC_npar == 1 && data.longest == &(data.longest_fixed)
6231 && data.last_start_min == 0 && data.last_end > 0
6232 && !RExC_seen_zerolen
6233 && !(RExC_seen & REG_SEEN_VERBARG)
6234 && (!(RExC_seen & REG_SEEN_GPOS) || (r->extflags & RXf_ANCH_GPOS)))
6235 r->extflags |= RXf_CHECK_ALL;
6236 scan_commit(pRExC_state, &data,&minlen,0);
6237 SvREFCNT_dec(data.last_found);
6239 longest_float_length = CHR_SVLEN(data.longest_float);
6241 if (! ((SvCUR(data.longest_fixed) /* ok to leave SvCUR */
6242 && data.offset_fixed == data.offset_float_min
6243 && SvCUR(data.longest_fixed) == SvCUR(data.longest_float)))
6244 && S_setup_longest (aTHX_ pRExC_state,
6248 &(r->float_end_shift),
6249 data.lookbehind_float,
6250 data.offset_float_min,
6252 longest_float_length,
6253 data.flags & SF_FL_BEFORE_EOL,
6254 data.flags & SF_FL_BEFORE_MEOL))
6256 r->float_min_offset = data.offset_float_min - data.lookbehind_float;
6257 r->float_max_offset = data.offset_float_max;
6258 if (data.offset_float_max < I32_MAX) /* Don't offset infinity */
6259 r->float_max_offset -= data.lookbehind_float;
6262 r->float_substr = r->float_utf8 = NULL;
6263 SvREFCNT_dec(data.longest_float);
6264 longest_float_length = 0;
6267 longest_fixed_length = CHR_SVLEN(data.longest_fixed);
6269 if (S_setup_longest (aTHX_ pRExC_state,
6271 &(r->anchored_utf8),
6272 &(r->anchored_substr),
6273 &(r->anchored_end_shift),
6274 data.lookbehind_fixed,
6277 longest_fixed_length,
6278 data.flags & SF_FIX_BEFORE_EOL,
6279 data.flags & SF_FIX_BEFORE_MEOL))
6281 r->anchored_offset = data.offset_fixed - data.lookbehind_fixed;
6284 r->anchored_substr = r->anchored_utf8 = NULL;
6285 SvREFCNT_dec(data.longest_fixed);
6286 longest_fixed_length = 0;
6290 && (OP(ri->regstclass) == REG_ANY || OP(ri->regstclass) == SANY))
6291 ri->regstclass = NULL;
6293 if ((!(r->anchored_substr || r->anchored_utf8) || r->anchored_offset)
6295 && !(data.start_class->flags & ANYOF_EOS)
6296 && !cl_is_anything(data.start_class))
6298 const U32 n = add_data(pRExC_state, 1, "f");
6299 data.start_class->flags |= ANYOF_IS_SYNTHETIC;
6301 Newx(RExC_rxi->data->data[n], 1,
6302 struct regnode_charclass_class);
6303 StructCopy(data.start_class,
6304 (struct regnode_charclass_class*)RExC_rxi->data->data[n],
6305 struct regnode_charclass_class);
6306 ri->regstclass = (regnode*)RExC_rxi->data->data[n];
6307 r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
6308 DEBUG_COMPILE_r({ SV *sv = sv_newmortal();
6309 regprop(r, sv, (regnode*)data.start_class);
6310 PerlIO_printf(Perl_debug_log,
6311 "synthetic stclass \"%s\".\n",
6312 SvPVX_const(sv));});
6315 /* A temporary algorithm prefers floated substr to fixed one to dig more info. */
6316 if (longest_fixed_length > longest_float_length) {
6317 r->check_end_shift = r->anchored_end_shift;
6318 r->check_substr = r->anchored_substr;
6319 r->check_utf8 = r->anchored_utf8;
6320 r->check_offset_min = r->check_offset_max = r->anchored_offset;
6321 if (r->extflags & RXf_ANCH_SINGLE)
6322 r->extflags |= RXf_NOSCAN;
6325 r->check_end_shift = r->float_end_shift;
6326 r->check_substr = r->float_substr;
6327 r->check_utf8 = r->float_utf8;
6328 r->check_offset_min = r->float_min_offset;
6329 r->check_offset_max = r->float_max_offset;
6331 /* XXXX Currently intuiting is not compatible with ANCH_GPOS.
6332 This should be changed ASAP! */
6333 if ((r->check_substr || r->check_utf8) && !(r->extflags & RXf_ANCH_GPOS)) {
6334 r->extflags |= RXf_USE_INTUIT;
6335 if (SvTAIL(r->check_substr ? r->check_substr : r->check_utf8))
6336 r->extflags |= RXf_INTUIT_TAIL;
6338 /* XXX Unneeded? dmq (shouldn't as this is handled elsewhere)
6339 if ( (STRLEN)minlen < longest_float_length )
6340 minlen= longest_float_length;
6341 if ( (STRLEN)minlen < longest_fixed_length )
6342 minlen= longest_fixed_length;
6346 /* Several toplevels. Best we can is to set minlen. */
6348 struct regnode_charclass_class ch_class;
6351 DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log, "\nMulti Top Level\n"));
6353 scan = ri->program + 1;
6354 cl_init(pRExC_state, &ch_class);
6355 data.start_class = &ch_class;
6356 data.last_closep = &last_close;
6359 minlen = study_chunk(pRExC_state, &scan, &minlen, &fake, scan + RExC_size,
6360 &data, -1, NULL, NULL, SCF_DO_STCLASS_AND|SCF_WHILEM_VISITED_POS,0);
6364 r->check_substr = r->check_utf8 = r->anchored_substr = r->anchored_utf8
6365 = r->float_substr = r->float_utf8 = NULL;
6367 if (!(data.start_class->flags & ANYOF_EOS)
6368 && !cl_is_anything(data.start_class))
6370 const U32 n = add_data(pRExC_state, 1, "f");
6371 data.start_class->flags |= ANYOF_IS_SYNTHETIC;
6373 Newx(RExC_rxi->data->data[n], 1,
6374 struct regnode_charclass_class);
6375 StructCopy(data.start_class,
6376 (struct regnode_charclass_class*)RExC_rxi->data->data[n],
6377 struct regnode_charclass_class);
6378 ri->regstclass = (regnode*)RExC_rxi->data->data[n];
6379 r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
6380 DEBUG_COMPILE_r({ SV* sv = sv_newmortal();
6381 regprop(r, sv, (regnode*)data.start_class);
6382 PerlIO_printf(Perl_debug_log,
6383 "synthetic stclass \"%s\".\n",
6384 SvPVX_const(sv));});
6388 /* Guard against an embedded (?=) or (?<=) with a longer minlen than
6389 the "real" pattern. */
6391 PerlIO_printf(Perl_debug_log,"minlen: %"IVdf" r->minlen:%"IVdf"\n",
6392 (IV)minlen, (IV)r->minlen);
6394 r->minlenret = minlen;
6395 if (r->minlen < minlen)
6398 if (RExC_seen & REG_SEEN_GPOS)
6399 r->extflags |= RXf_GPOS_SEEN;
6400 if (RExC_seen & REG_SEEN_LOOKBEHIND)
6401 r->extflags |= RXf_LOOKBEHIND_SEEN;
6402 if (pRExC_state->num_code_blocks)
6403 r->extflags |= RXf_EVAL_SEEN;
6404 if (RExC_seen & REG_SEEN_CANY)
6405 r->extflags |= RXf_CANY_SEEN;
6406 if (RExC_seen & REG_SEEN_VERBARG)
6408 r->intflags |= PREGf_VERBARG_SEEN;
6409 r->extflags |= RXf_MODIFIES_VARS;
6411 if (RExC_seen & REG_SEEN_CUTGROUP)
6412 r->intflags |= PREGf_CUTGROUP_SEEN;
6413 if (pm_flags & PMf_USE_RE_EVAL)
6414 r->intflags |= PREGf_USE_RE_EVAL;
6415 if (RExC_paren_names)
6416 RXp_PAREN_NAMES(r) = MUTABLE_HV(SvREFCNT_inc(RExC_paren_names));
6418 RXp_PAREN_NAMES(r) = NULL;
6420 #ifdef STUPID_PATTERN_CHECKS
6421 if (RX_PRELEN(rx) == 0)
6422 r->extflags |= RXf_NULL;
6423 if (RX_PRELEN(rx) == 3 && memEQ("\\s+", RX_PRECOMP(rx), 3))
6424 r->extflags |= RXf_WHITE;
6425 else if (RX_PRELEN(rx) == 1 && RXp_PRECOMP(rx)[0] == '^')
6426 r->extflags |= RXf_START_ONLY;
6429 regnode *first = ri->program + 1;
6432 if (PL_regkind[fop] == NOTHING && OP(NEXTOPER(first)) == END)
6433 r->extflags |= RXf_NULL;
6434 else if (PL_regkind[fop] == BOL && OP(NEXTOPER(first)) == END)
6435 r->extflags |= RXf_START_ONLY;
6436 else if (fop == PLUS && OP(NEXTOPER(first)) == SPACE
6437 && OP(regnext(first)) == END)
6438 r->extflags |= RXf_WHITE;
6442 if (RExC_paren_names) {
6443 ri->name_list_idx = add_data( pRExC_state, 1, "a" );
6444 ri->data->data[ri->name_list_idx] = (void*)SvREFCNT_inc(RExC_paren_name_list);
6447 ri->name_list_idx = 0;
6449 if (RExC_recurse_count) {
6450 for ( ; RExC_recurse_count ; RExC_recurse_count-- ) {
6451 const regnode *scan = RExC_recurse[RExC_recurse_count-1];
6452 ARG2L_SET( scan, RExC_open_parens[ARG(scan)-1] - scan );
6455 Newxz(r->offs, RExC_npar, regexp_paren_pair);
6456 /* assume we don't need to swap parens around before we match */
6459 PerlIO_printf(Perl_debug_log,"Final program:\n");
6462 #ifdef RE_TRACK_PATTERN_OFFSETS
6463 DEBUG_OFFSETS_r(if (ri->u.offsets) {
6464 const U32 len = ri->u.offsets[0];
6466 GET_RE_DEBUG_FLAGS_DECL;
6467 PerlIO_printf(Perl_debug_log, "Offsets: [%"UVuf"]\n\t", (UV)ri->u.offsets[0]);
6468 for (i = 1; i <= len; i++) {
6469 if (ri->u.offsets[i*2-1] || ri->u.offsets[i*2])
6470 PerlIO_printf(Perl_debug_log, "%"UVuf":%"UVuf"[%"UVuf"] ",
6471 (UV)i, (UV)ri->u.offsets[i*2-1], (UV)ri->u.offsets[i*2]);
6473 PerlIO_printf(Perl_debug_log, "\n");
6481 Perl_reg_named_buff(pTHX_ REGEXP * const rx, SV * const key, SV * const value,
6484 PERL_ARGS_ASSERT_REG_NAMED_BUFF;
6486 PERL_UNUSED_ARG(value);
6488 if (flags & RXapif_FETCH) {
6489 return reg_named_buff_fetch(rx, key, flags);
6490 } else if (flags & (RXapif_STORE | RXapif_DELETE | RXapif_CLEAR)) {
6491 Perl_croak_no_modify();
6493 } else if (flags & RXapif_EXISTS) {
6494 return reg_named_buff_exists(rx, key, flags)
6497 } else if (flags & RXapif_REGNAMES) {
6498 return reg_named_buff_all(rx, flags);
6499 } else if (flags & (RXapif_SCALAR | RXapif_REGNAMES_COUNT)) {
6500 return reg_named_buff_scalar(rx, flags);
6502 Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff", (int)flags);
6508 Perl_reg_named_buff_iter(pTHX_ REGEXP * const rx, const SV * const lastkey,
6511 PERL_ARGS_ASSERT_REG_NAMED_BUFF_ITER;
6512 PERL_UNUSED_ARG(lastkey);
6514 if (flags & RXapif_FIRSTKEY)
6515 return reg_named_buff_firstkey(rx, flags);
6516 else if (flags & RXapif_NEXTKEY)
6517 return reg_named_buff_nextkey(rx, flags);
6519 Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_iter", (int)flags);
6525 Perl_reg_named_buff_fetch(pTHX_ REGEXP * const r, SV * const namesv,
6528 AV *retarray = NULL;
6530 struct regexp *const rx = ReANY(r);
6532 PERL_ARGS_ASSERT_REG_NAMED_BUFF_FETCH;
6534 if (flags & RXapif_ALL)
6537 if (rx && RXp_PAREN_NAMES(rx)) {
6538 HE *he_str = hv_fetch_ent( RXp_PAREN_NAMES(rx), namesv, 0, 0 );
6541 SV* sv_dat=HeVAL(he_str);
6542 I32 *nums=(I32*)SvPVX(sv_dat);
6543 for ( i=0; i<SvIVX(sv_dat); i++ ) {
6544 if ((I32)(rx->nparens) >= nums[i]
6545 && rx->offs[nums[i]].start != -1
6546 && rx->offs[nums[i]].end != -1)
6549 CALLREG_NUMBUF_FETCH(r,nums[i],ret);
6554 ret = newSVsv(&PL_sv_undef);
6557 av_push(retarray, ret);
6560 return newRV_noinc(MUTABLE_SV(retarray));
6567 Perl_reg_named_buff_exists(pTHX_ REGEXP * const r, SV * const key,
6570 struct regexp *const rx = ReANY(r);
6572 PERL_ARGS_ASSERT_REG_NAMED_BUFF_EXISTS;
6574 if (rx && RXp_PAREN_NAMES(rx)) {
6575 if (flags & RXapif_ALL) {
6576 return hv_exists_ent(RXp_PAREN_NAMES(rx), key, 0);
6578 SV *sv = CALLREG_NAMED_BUFF_FETCH(r, key, flags);
6592 Perl_reg_named_buff_firstkey(pTHX_ REGEXP * const r, const U32 flags)
6594 struct regexp *const rx = ReANY(r);
6596 PERL_ARGS_ASSERT_REG_NAMED_BUFF_FIRSTKEY;
6598 if ( rx && RXp_PAREN_NAMES(rx) ) {
6599 (void)hv_iterinit(RXp_PAREN_NAMES(rx));
6601 return CALLREG_NAMED_BUFF_NEXTKEY(r, NULL, flags & ~RXapif_FIRSTKEY);
6608 Perl_reg_named_buff_nextkey(pTHX_ REGEXP * const r, const U32 flags)
6610 struct regexp *const rx = ReANY(r);
6611 GET_RE_DEBUG_FLAGS_DECL;
6613 PERL_ARGS_ASSERT_REG_NAMED_BUFF_NEXTKEY;
6615 if (rx && RXp_PAREN_NAMES(rx)) {
6616 HV *hv = RXp_PAREN_NAMES(rx);
6618 while ( (temphe = hv_iternext_flags(hv,0)) ) {
6621 SV* sv_dat = HeVAL(temphe);
6622 I32 *nums = (I32*)SvPVX(sv_dat);
6623 for ( i = 0; i < SvIVX(sv_dat); i++ ) {
6624 if ((I32)(rx->lastparen) >= nums[i] &&
6625 rx->offs[nums[i]].start != -1 &&
6626 rx->offs[nums[i]].end != -1)
6632 if (parno || flags & RXapif_ALL) {
6633 return newSVhek(HeKEY_hek(temphe));
6641 Perl_reg_named_buff_scalar(pTHX_ REGEXP * const r, const U32 flags)
6646 struct regexp *const rx = ReANY(r);
6648 PERL_ARGS_ASSERT_REG_NAMED_BUFF_SCALAR;
6650 if (rx && RXp_PAREN_NAMES(rx)) {
6651 if (flags & (RXapif_ALL | RXapif_REGNAMES_COUNT)) {
6652 return newSViv(HvTOTALKEYS(RXp_PAREN_NAMES(rx)));
6653 } else if (flags & RXapif_ONE) {
6654 ret = CALLREG_NAMED_BUFF_ALL(r, (flags | RXapif_REGNAMES));
6655 av = MUTABLE_AV(SvRV(ret));
6656 length = av_len(av);
6658 return newSViv(length + 1);
6660 Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_scalar", (int)flags);
6664 return &PL_sv_undef;
6668 Perl_reg_named_buff_all(pTHX_ REGEXP * const r, const U32 flags)
6670 struct regexp *const rx = ReANY(r);
6673 PERL_ARGS_ASSERT_REG_NAMED_BUFF_ALL;
6675 if (rx && RXp_PAREN_NAMES(rx)) {
6676 HV *hv= RXp_PAREN_NAMES(rx);
6678 (void)hv_iterinit(hv);
6679 while ( (temphe = hv_iternext_flags(hv,0)) ) {
6682 SV* sv_dat = HeVAL(temphe);
6683 I32 *nums = (I32*)SvPVX(sv_dat);
6684 for ( i = 0; i < SvIVX(sv_dat); i++ ) {
6685 if ((I32)(rx->lastparen) >= nums[i] &&
6686 rx->offs[nums[i]].start != -1 &&
6687 rx->offs[nums[i]].end != -1)
6693 if (parno || flags & RXapif_ALL) {
6694 av_push(av, newSVhek(HeKEY_hek(temphe)));
6699 return newRV_noinc(MUTABLE_SV(av));
6703 Perl_reg_numbered_buff_fetch(pTHX_ REGEXP * const r, const I32 paren,
6706 struct regexp *const rx = ReANY(r);
6712 PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_FETCH;
6714 if ( ( n == RX_BUFF_IDX_CARET_PREMATCH
6715 || n == RX_BUFF_IDX_CARET_FULLMATCH
6716 || n == RX_BUFF_IDX_CARET_POSTMATCH
6718 && !(rx->extflags & RXf_PMf_KEEPCOPY)
6725 if (n == RX_BUFF_IDX_CARET_FULLMATCH)
6726 /* no need to distinguish between them any more */
6727 n = RX_BUFF_IDX_FULLMATCH;
6729 if ((n == RX_BUFF_IDX_PREMATCH || n == RX_BUFF_IDX_CARET_PREMATCH)
6730 && rx->offs[0].start != -1)
6732 /* $`, ${^PREMATCH} */
6733 i = rx->offs[0].start;
6737 if ((n == RX_BUFF_IDX_POSTMATCH || n == RX_BUFF_IDX_CARET_POSTMATCH)
6738 && rx->offs[0].end != -1)
6740 /* $', ${^POSTMATCH} */
6741 s = rx->subbeg - rx->suboffset + rx->offs[0].end;
6742 i = rx->sublen + rx->suboffset - rx->offs[0].end;
6745 if ( 0 <= n && n <= (I32)rx->nparens &&
6746 (s1 = rx->offs[n].start) != -1 &&
6747 (t1 = rx->offs[n].end) != -1)
6749 /* $&, ${^MATCH}, $1 ... */
6751 s = rx->subbeg + s1 - rx->suboffset;
6756 assert(s >= rx->subbeg);
6757 assert(rx->sublen >= (s - rx->subbeg) + i );
6759 #if NO_TAINT_SUPPORT
6760 sv_setpvn(sv, s, i);
6762 const int oldtainted = TAINT_get;
6764 sv_setpvn(sv, s, i);
6765 TAINT_set(oldtainted);
6767 if ( (rx->extflags & RXf_CANY_SEEN)
6768 ? (RXp_MATCH_UTF8(rx)
6769 && (!i || is_utf8_string((U8*)s, i)))
6770 : (RXp_MATCH_UTF8(rx)) )
6777 if (RXp_MATCH_TAINTED(rx)) {
6778 if (SvTYPE(sv) >= SVt_PVMG) {
6779 MAGIC* const mg = SvMAGIC(sv);
6782 SvMAGIC_set(sv, mg->mg_moremagic);
6784 if ((mgt = SvMAGIC(sv))) {
6785 mg->mg_moremagic = mgt;
6786 SvMAGIC_set(sv, mg);
6797 sv_setsv(sv,&PL_sv_undef);
6803 Perl_reg_numbered_buff_store(pTHX_ REGEXP * const rx, const I32 paren,
6804 SV const * const value)
6806 PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_STORE;
6808 PERL_UNUSED_ARG(rx);
6809 PERL_UNUSED_ARG(paren);
6810 PERL_UNUSED_ARG(value);
6813 Perl_croak_no_modify();
6817 Perl_reg_numbered_buff_length(pTHX_ REGEXP * const r, const SV * const sv,
6820 struct regexp *const rx = ReANY(r);
6824 PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_LENGTH;
6826 /* Some of this code was originally in C<Perl_magic_len> in F<mg.c> */
6828 case RX_BUFF_IDX_CARET_PREMATCH: /* ${^PREMATCH} */
6829 if (!(rx->extflags & RXf_PMf_KEEPCOPY))
6833 case RX_BUFF_IDX_PREMATCH: /* $` */
6834 if (rx->offs[0].start != -1) {
6835 i = rx->offs[0].start;
6844 case RX_BUFF_IDX_CARET_POSTMATCH: /* ${^POSTMATCH} */
6845 if (!(rx->extflags & RXf_PMf_KEEPCOPY))
6847 case RX_BUFF_IDX_POSTMATCH: /* $' */
6848 if (rx->offs[0].end != -1) {
6849 i = rx->sublen - rx->offs[0].end;
6851 s1 = rx->offs[0].end;
6858 case RX_BUFF_IDX_CARET_FULLMATCH: /* ${^MATCH} */
6859 if (!(rx->extflags & RXf_PMf_KEEPCOPY))
6863 /* $& / ${^MATCH}, $1, $2, ... */
6865 if (paren <= (I32)rx->nparens &&
6866 (s1 = rx->offs[paren].start) != -1 &&
6867 (t1 = rx->offs[paren].end) != -1)
6873 if (ckWARN(WARN_UNINITIALIZED))
6874 report_uninit((const SV *)sv);
6879 if (i > 0 && RXp_MATCH_UTF8(rx)) {
6880 const char * const s = rx->subbeg - rx->suboffset + s1;
6885 if (is_utf8_string_loclen((U8*)s, i, &ep, &el))
6892 Perl_reg_qr_package(pTHX_ REGEXP * const rx)
6894 PERL_ARGS_ASSERT_REG_QR_PACKAGE;
6895 PERL_UNUSED_ARG(rx);
6899 return newSVpvs("Regexp");
6902 /* Scans the name of a named buffer from the pattern.
6903 * If flags is REG_RSN_RETURN_NULL returns null.
6904 * If flags is REG_RSN_RETURN_NAME returns an SV* containing the name
6905 * If flags is REG_RSN_RETURN_DATA returns the data SV* corresponding
6906 * to the parsed name as looked up in the RExC_paren_names hash.
6907 * If there is an error throws a vFAIL().. type exception.
6910 #define REG_RSN_RETURN_NULL 0
6911 #define REG_RSN_RETURN_NAME 1
6912 #define REG_RSN_RETURN_DATA 2
6915 S_reg_scan_name(pTHX_ RExC_state_t *pRExC_state, U32 flags)
6917 char *name_start = RExC_parse;
6919 PERL_ARGS_ASSERT_REG_SCAN_NAME;
6921 if (isIDFIRST_lazy_if(RExC_parse, UTF)) {
6922 /* skip IDFIRST by using do...while */
6925 RExC_parse += UTF8SKIP(RExC_parse);
6926 } while (isALNUM_utf8((U8*)RExC_parse));
6930 } while (isALNUM(*RExC_parse));
6932 RExC_parse++; /* so the <- from the vFAIL is after the offending character */
6933 vFAIL("Group name must start with a non-digit word character");
6937 = newSVpvn_flags(name_start, (int)(RExC_parse - name_start),
6938 SVs_TEMP | (UTF ? SVf_UTF8 : 0));
6939 if ( flags == REG_RSN_RETURN_NAME)
6941 else if (flags==REG_RSN_RETURN_DATA) {
6944 if ( ! sv_name ) /* should not happen*/
6945 Perl_croak(aTHX_ "panic: no svname in reg_scan_name");
6946 if (RExC_paren_names)
6947 he_str = hv_fetch_ent( RExC_paren_names, sv_name, 0, 0 );
6949 sv_dat = HeVAL(he_str);
6951 vFAIL("Reference to nonexistent named group");
6955 Perl_croak(aTHX_ "panic: bad flag %lx in reg_scan_name",
6956 (unsigned long) flags);
6958 assert(0); /* NOT REACHED */
6963 #define DEBUG_PARSE_MSG(funcname) DEBUG_PARSE_r({ \
6964 int rem=(int)(RExC_end - RExC_parse); \
6973 if (RExC_lastparse!=RExC_parse) \
6974 PerlIO_printf(Perl_debug_log," >%.*s%-*s", \
6977 iscut ? "..." : "<" \
6980 PerlIO_printf(Perl_debug_log,"%16s",""); \
6983 num = RExC_size + 1; \
6985 num=REG_NODE_NUM(RExC_emit); \
6986 if (RExC_lastnum!=num) \
6987 PerlIO_printf(Perl_debug_log,"|%4d",num); \
6989 PerlIO_printf(Perl_debug_log,"|%4s",""); \
6990 PerlIO_printf(Perl_debug_log,"|%*s%-4s", \
6991 (int)((depth*2)), "", \
6995 RExC_lastparse=RExC_parse; \
7000 #define DEBUG_PARSE(funcname) DEBUG_PARSE_r({ \
7001 DEBUG_PARSE_MSG((funcname)); \
7002 PerlIO_printf(Perl_debug_log,"%4s","\n"); \
7004 #define DEBUG_PARSE_FMT(funcname,fmt,args) DEBUG_PARSE_r({ \
7005 DEBUG_PARSE_MSG((funcname)); \
7006 PerlIO_printf(Perl_debug_log,fmt "\n",args); \
7009 /* This section of code defines the inversion list object and its methods. The
7010 * interfaces are highly subject to change, so as much as possible is static to
7011 * this file. An inversion list is here implemented as a malloc'd C UV array
7012 * with some added info that is placed as UVs at the beginning in a header
7013 * portion. An inversion list for Unicode is an array of code points, sorted
7014 * by ordinal number. The zeroth element is the first code point in the list.
7015 * The 1th element is the first element beyond that not in the list. In other
7016 * words, the first range is
7017 * invlist[0]..(invlist[1]-1)
7018 * The other ranges follow. Thus every element whose index is divisible by two
7019 * marks the beginning of a range that is in the list, and every element not
7020 * divisible by two marks the beginning of a range not in the list. A single
7021 * element inversion list that contains the single code point N generally
7022 * consists of two elements
7025 * (The exception is when N is the highest representable value on the
7026 * machine, in which case the list containing just it would be a single
7027 * element, itself. By extension, if the last range in the list extends to
7028 * infinity, then the first element of that range will be in the inversion list
7029 * at a position that is divisible by two, and is the final element in the
7031 * Taking the complement (inverting) an inversion list is quite simple, if the
7032 * first element is 0, remove it; otherwise add a 0 element at the beginning.
7033 * This implementation reserves an element at the beginning of each inversion
7034 * list to contain 0 when the list contains 0, and contains 1 otherwise. The
7035 * actual beginning of the list is either that element if 0, or the next one if
7038 * More about inversion lists can be found in "Unicode Demystified"
7039 * Chapter 13 by Richard Gillam, published by Addison-Wesley.
7040 * More will be coming when functionality is added later.
7042 * The inversion list data structure is currently implemented as an SV pointing
7043 * to an array of UVs that the SV thinks are bytes. This allows us to have an
7044 * array of UV whose memory management is automatically handled by the existing
7045 * facilities for SV's.
7047 * Some of the methods should always be private to the implementation, and some
7048 * should eventually be made public */
7050 /* The header definitions are in F<inline_invlist.c> */
7052 #define TO_INTERNAL_SIZE(x) ((x + HEADER_LENGTH) * sizeof(UV))
7053 #define FROM_INTERNAL_SIZE(x) ((x / sizeof(UV)) - HEADER_LENGTH)
7055 #define INVLIST_INITIAL_LEN 10
7057 PERL_STATIC_INLINE UV*
7058 S__invlist_array_init(pTHX_ SV* const invlist, const bool will_have_0)
7060 /* Returns a pointer to the first element in the inversion list's array.
7061 * This is called upon initialization of an inversion list. Where the
7062 * array begins depends on whether the list has the code point U+0000
7063 * in it or not. The other parameter tells it whether the code that
7064 * follows this call is about to put a 0 in the inversion list or not.
7065 * The first element is either the element with 0, if 0, or the next one,
7068 UV* zero = get_invlist_zero_addr(invlist);
7070 PERL_ARGS_ASSERT__INVLIST_ARRAY_INIT;
7073 assert(! *_get_invlist_len_addr(invlist));
7075 /* 1^1 = 0; 1^0 = 1 */
7076 *zero = 1 ^ will_have_0;
7077 return zero + *zero;
7080 PERL_STATIC_INLINE UV*
7081 S_invlist_array(pTHX_ SV* const invlist)
7083 /* Returns the pointer to the inversion list's array. Every time the
7084 * length changes, this needs to be called in case malloc or realloc moved
7087 PERL_ARGS_ASSERT_INVLIST_ARRAY;
7089 /* Must not be empty. If these fail, you probably didn't check for <len>
7090 * being non-zero before trying to get the array */
7091 assert(*_get_invlist_len_addr(invlist));
7092 assert(*get_invlist_zero_addr(invlist) == 0
7093 || *get_invlist_zero_addr(invlist) == 1);
7095 /* The array begins either at the element reserved for zero if the
7096 * list contains 0 (that element will be set to 0), or otherwise the next
7097 * element (in which case the reserved element will be set to 1). */
7098 return (UV *) (get_invlist_zero_addr(invlist)
7099 + *get_invlist_zero_addr(invlist));
7102 PERL_STATIC_INLINE void
7103 S_invlist_set_len(pTHX_ SV* const invlist, const UV len)
7105 /* Sets the current number of elements stored in the inversion list */
7107 PERL_ARGS_ASSERT_INVLIST_SET_LEN;
7109 *_get_invlist_len_addr(invlist) = len;
7111 assert(len <= SvLEN(invlist));
7113 SvCUR_set(invlist, TO_INTERNAL_SIZE(len));
7114 /* If the list contains U+0000, that element is part of the header,
7115 * and should not be counted as part of the array. It will contain
7116 * 0 in that case, and 1 otherwise. So we could flop 0=>1, 1=>0 and
7118 * SvCUR_set(invlist,
7119 * TO_INTERNAL_SIZE(len
7120 * - (*get_invlist_zero_addr(inv_list) ^ 1)));
7121 * But, this is only valid if len is not 0. The consequences of not doing
7122 * this is that the memory allocation code may think that 1 more UV is
7123 * being used than actually is, and so might do an unnecessary grow. That
7124 * seems worth not bothering to make this the precise amount.
7126 * Note that when inverting, SvCUR shouldn't change */
7129 PERL_STATIC_INLINE IV*
7130 S_get_invlist_previous_index_addr(pTHX_ SV* invlist)
7132 /* Return the address of the UV that is reserved to hold the cached index
7135 PERL_ARGS_ASSERT_GET_INVLIST_PREVIOUS_INDEX_ADDR;
7137 return (IV *) (SvPVX(invlist) + (INVLIST_PREVIOUS_INDEX_OFFSET * sizeof (UV)));
7140 PERL_STATIC_INLINE IV
7141 S_invlist_previous_index(pTHX_ SV* const invlist)
7143 /* Returns cached index of previous search */
7145 PERL_ARGS_ASSERT_INVLIST_PREVIOUS_INDEX;
7147 return *get_invlist_previous_index_addr(invlist);
7150 PERL_STATIC_INLINE void
7151 S_invlist_set_previous_index(pTHX_ SV* const invlist, const IV index)
7153 /* Caches <index> for later retrieval */
7155 PERL_ARGS_ASSERT_INVLIST_SET_PREVIOUS_INDEX;
7157 assert(index == 0 || index < (int) _invlist_len(invlist));
7159 *get_invlist_previous_index_addr(invlist) = index;
7162 PERL_STATIC_INLINE UV
7163 S_invlist_max(pTHX_ SV* const invlist)
7165 /* Returns the maximum number of elements storable in the inversion list's
7166 * array, without having to realloc() */
7168 PERL_ARGS_ASSERT_INVLIST_MAX;
7170 return FROM_INTERNAL_SIZE(SvLEN(invlist));
7173 PERL_STATIC_INLINE UV*
7174 S_get_invlist_zero_addr(pTHX_ SV* invlist)
7176 /* Return the address of the UV that is reserved to hold 0 if the inversion
7177 * list contains 0. This has to be the last element of the heading, as the
7178 * list proper starts with either it if 0, or the next element if not.
7179 * (But we force it to contain either 0 or 1) */
7181 PERL_ARGS_ASSERT_GET_INVLIST_ZERO_ADDR;
7183 return (UV *) (SvPVX(invlist) + (INVLIST_ZERO_OFFSET * sizeof (UV)));
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) {
7198 initial_size = INVLIST_INITIAL_LEN;
7201 /* Allocate the initial space */
7202 new_list = newSV(TO_INTERNAL_SIZE(initial_size));
7203 invlist_set_len(new_list, 0);
7205 /* Force iterinit() to be used to get iteration to work */
7206 *get_invlist_iter_addr(new_list) = UV_MAX;
7208 /* This should force a segfault if a method doesn't initialize this
7210 *get_invlist_zero_addr(new_list) = UV_MAX;
7212 *get_invlist_previous_index_addr(new_list) = 0;
7213 *get_invlist_version_id_addr(new_list) = INVLIST_VERSION_ID;
7214 #if HEADER_LENGTH != 5
7215 # error Need to regenerate VERSION_ID by running perl -E 'say int(rand 2**31-1)', and then changing the #if to the new length
7223 S__new_invlist_C_array(pTHX_ UV* list)
7225 /* Return a pointer to a newly constructed inversion list, initialized to
7226 * point to <list>, which has to be in the exact correct inversion list
7227 * form, including internal fields. Thus this is a dangerous routine that
7228 * should not be used in the wrong hands */
7230 SV* invlist = newSV_type(SVt_PV);
7232 PERL_ARGS_ASSERT__NEW_INVLIST_C_ARRAY;
7234 SvPV_set(invlist, (char *) list);
7235 SvLEN_set(invlist, 0); /* Means we own the contents, and the system
7236 shouldn't touch it */
7237 SvCUR_set(invlist, TO_INTERNAL_SIZE(_invlist_len(invlist)));
7239 if (*get_invlist_version_id_addr(invlist) != INVLIST_VERSION_ID) {
7240 Perl_croak(aTHX_ "panic: Incorrect version for previously generated inversion list");
7247 S_invlist_extend(pTHX_ SV* const invlist, const UV new_max)
7249 /* Grow the maximum size of an inversion list */
7251 PERL_ARGS_ASSERT_INVLIST_EXTEND;
7253 SvGROW((SV *)invlist, TO_INTERNAL_SIZE(new_max));
7256 PERL_STATIC_INLINE void
7257 S_invlist_trim(pTHX_ SV* const invlist)
7259 PERL_ARGS_ASSERT_INVLIST_TRIM;
7261 /* Change the length of the inversion list to how many entries it currently
7264 SvPV_shrink_to_cur((SV *) invlist);
7267 #define _invlist_union_complement_2nd(a, b, output) _invlist_union_maybe_complement_2nd(a, b, TRUE, output)
7270 S__append_range_to_invlist(pTHX_ SV* const invlist, const UV start, const UV end)
7272 /* Subject to change or removal. Append the range from 'start' to 'end' at
7273 * the end of the inversion list. The range must be above any existing
7277 UV max = invlist_max(invlist);
7278 UV len = _invlist_len(invlist);
7280 PERL_ARGS_ASSERT__APPEND_RANGE_TO_INVLIST;
7282 if (len == 0) { /* Empty lists must be initialized */
7283 array = _invlist_array_init(invlist, start == 0);
7286 /* Here, the existing list is non-empty. The current max entry in the
7287 * list is generally the first value not in the set, except when the
7288 * set extends to the end of permissible values, in which case it is
7289 * the first entry in that final set, and so this call is an attempt to
7290 * append out-of-order */
7292 UV final_element = len - 1;
7293 array = invlist_array(invlist);
7294 if (array[final_element] > start
7295 || ELEMENT_RANGE_MATCHES_INVLIST(final_element))
7297 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",
7298 array[final_element], start,
7299 ELEMENT_RANGE_MATCHES_INVLIST(final_element) ? 't' : 'f');
7302 /* Here, it is a legal append. If the new range begins with the first
7303 * value not in the set, it is extending the set, so the new first
7304 * value not in the set is one greater than the newly extended range.
7306 if (array[final_element] == start) {
7307 if (end != UV_MAX) {
7308 array[final_element] = end + 1;
7311 /* But if the end is the maximum representable on the machine,
7312 * just let the range that this would extend to have no end */
7313 invlist_set_len(invlist, len - 1);
7319 /* Here the new range doesn't extend any existing set. Add it */
7321 len += 2; /* Includes an element each for the start and end of range */
7323 /* If overflows the existing space, extend, which may cause the array to be
7326 invlist_extend(invlist, len);
7327 invlist_set_len(invlist, len); /* Have to set len here to avoid assert
7328 failure in invlist_array() */
7329 array = invlist_array(invlist);
7332 invlist_set_len(invlist, len);
7335 /* The next item on the list starts the range, the one after that is
7336 * one past the new range. */
7337 array[len - 2] = start;
7338 if (end != UV_MAX) {
7339 array[len - 1] = end + 1;
7342 /* But if the end is the maximum representable on the machine, just let
7343 * the range have no end */
7344 invlist_set_len(invlist, len - 1);
7348 #ifndef PERL_IN_XSUB_RE
7351 Perl__invlist_search(pTHX_ SV* const invlist, const UV cp)
7353 /* Searches the inversion list for the entry that contains the input code
7354 * point <cp>. If <cp> is not in the list, -1 is returned. Otherwise, the
7355 * return value is the index into the list's array of the range that
7360 IV high = _invlist_len(invlist);
7361 const IV highest_element = high - 1;
7364 PERL_ARGS_ASSERT__INVLIST_SEARCH;
7366 /* If list is empty, return failure. */
7371 /* If the code point is before the first element, return failure. (We
7372 * can't combine this with the test above, because we can't get the array
7373 * unless we know the list is non-empty) */
7374 array = invlist_array(invlist);
7376 mid = invlist_previous_index(invlist);
7377 assert(mid >=0 && mid <= highest_element);
7379 /* <mid> contains the cache of the result of the previous call to this
7380 * function (0 the first time). See if this call is for the same result,
7381 * or if it is for mid-1. This is under the theory that calls to this
7382 * function will often be for related code points that are near each other.
7383 * And benchmarks show that caching gives better results. We also test
7384 * here if the code point is within the bounds of the list. These tests
7385 * replace others that would have had to be made anyway to make sure that
7386 * the array bounds were not exceeded, and give us extra information at the
7388 if (cp >= array[mid]) {
7389 if (cp >= array[highest_element]) {
7390 return highest_element;
7393 /* Here, array[mid] <= cp < array[highest_element]. This means that
7394 * the final element is not the answer, so can exclude it; it also
7395 * means that <mid> is not the final element, so can refer to 'mid + 1'
7397 if (cp < array[mid + 1]) {
7403 else { /* cp < aray[mid] */
7404 if (cp < array[0]) { /* Fail if outside the array */
7408 if (cp >= array[mid - 1]) {
7413 /* Binary search. What we are looking for is <i> such that
7414 * array[i] <= cp < array[i+1]
7415 * The loop below converges on the i+1. Note that there may not be an
7416 * (i+1)th element in the array, and things work nonetheless */
7417 while (low < high) {
7418 mid = (low + high) / 2;
7419 assert(mid <= highest_element);
7420 if (array[mid] <= cp) { /* cp >= array[mid] */
7423 /* We could do this extra test to exit the loop early.
7424 if (cp < array[low]) {
7429 else { /* cp < array[mid] */
7436 invlist_set_previous_index(invlist, high);
7441 Perl__invlist_populate_swatch(pTHX_ SV* const invlist, const UV start, const UV end, U8* swatch)
7443 /* populates a swatch of a swash the same way swatch_get() does in utf8.c,
7444 * but is used when the swash has an inversion list. This makes this much
7445 * faster, as it uses a binary search instead of a linear one. This is
7446 * intimately tied to that function, and perhaps should be in utf8.c,
7447 * except it is intimately tied to inversion lists as well. It assumes
7448 * that <swatch> is all 0's on input */
7451 const IV len = _invlist_len(invlist);
7455 PERL_ARGS_ASSERT__INVLIST_POPULATE_SWATCH;
7457 if (len == 0) { /* Empty inversion list */
7461 array = invlist_array(invlist);
7463 /* Find which element it is */
7464 i = _invlist_search(invlist, start);
7466 /* We populate from <start> to <end> */
7467 while (current < end) {
7470 /* The inversion list gives the results for every possible code point
7471 * after the first one in the list. Only those ranges whose index is
7472 * even are ones that the inversion list matches. For the odd ones,
7473 * and if the initial code point is not in the list, we have to skip
7474 * forward to the next element */
7475 if (i == -1 || ! ELEMENT_RANGE_MATCHES_INVLIST(i)) {
7477 if (i >= len) { /* Finished if beyond the end of the array */
7481 if (current >= end) { /* Finished if beyond the end of what we
7483 if (LIKELY(end < UV_MAX)) {
7487 /* We get here when the upper bound is the maximum
7488 * representable on the machine, and we are looking for just
7489 * that code point. Have to special case it */
7491 goto join_end_of_list;
7494 assert(current >= start);
7496 /* The current range ends one below the next one, except don't go past
7499 upper = (i < len && array[i] < end) ? array[i] : end;
7501 /* Here we are in a range that matches. Populate a bit in the 3-bit U8
7502 * for each code point in it */
7503 for (; current < upper; current++) {
7504 const STRLEN offset = (STRLEN)(current - start);
7505 swatch[offset >> 3] |= 1 << (offset & 7);
7510 /* Quit if at the end of the list */
7513 /* But first, have to deal with the highest possible code point on
7514 * the platform. The previous code assumes that <end> is one
7515 * beyond where we want to populate, but that is impossible at the
7516 * platform's infinity, so have to handle it specially */
7517 if (UNLIKELY(end == UV_MAX && ELEMENT_RANGE_MATCHES_INVLIST(len-1)))
7519 const STRLEN offset = (STRLEN)(end - start);
7520 swatch[offset >> 3] |= 1 << (offset & 7);
7525 /* Advance to the next range, which will be for code points not in the
7534 Perl__invlist_union_maybe_complement_2nd(pTHX_ SV* const a, SV* const b, bool complement_b, SV** output)
7536 /* Take the union of two inversion lists and point <output> to it. *output
7537 * should be defined upon input, and if it points to one of the two lists,
7538 * the reference count to that list will be decremented. The first list,
7539 * <a>, may be NULL, in which case a copy of the second list is returned.
7540 * If <complement_b> is TRUE, the union is taken of the complement
7541 * (inversion) of <b> instead of b itself.
7543 * The basis for this comes from "Unicode Demystified" Chapter 13 by
7544 * Richard Gillam, published by Addison-Wesley, and explained at some
7545 * length there. The preface says to incorporate its examples into your
7546 * code at your own risk.
7548 * The algorithm is like a merge sort.
7550 * XXX A potential performance improvement is to keep track as we go along
7551 * if only one of the inputs contributes to the result, meaning the other
7552 * is a subset of that one. In that case, we can skip the final copy and
7553 * return the larger of the input lists, but then outside code might need
7554 * to keep track of whether to free the input list or not */
7556 UV* array_a; /* a's array */
7558 UV len_a; /* length of a's array */
7561 SV* u; /* the resulting union */
7565 UV i_a = 0; /* current index into a's array */
7569 /* running count, as explained in the algorithm source book; items are
7570 * stopped accumulating and are output when the count changes to/from 0.
7571 * The count is incremented when we start a range that's in the set, and
7572 * decremented when we start a range that's not in the set. So its range
7573 * is 0 to 2. Only when the count is zero is something not in the set.
7577 PERL_ARGS_ASSERT__INVLIST_UNION_MAYBE_COMPLEMENT_2ND;
7580 /* If either one is empty, the union is the other one */
7581 if (a == NULL || ((len_a = _invlist_len(a)) == 0)) {
7588 *output = invlist_clone(b);
7590 _invlist_invert(*output);
7592 } /* else *output already = b; */
7595 else if ((len_b = _invlist_len(b)) == 0) {
7600 /* The complement of an empty list is a list that has everything in it,
7601 * so the union with <a> includes everything too */
7606 *output = _new_invlist(1);
7607 _append_range_to_invlist(*output, 0, UV_MAX);
7609 else if (*output != a) {
7610 *output = invlist_clone(a);
7612 /* else *output already = a; */
7616 /* Here both lists exist and are non-empty */
7617 array_a = invlist_array(a);
7618 array_b = invlist_array(b);
7620 /* If are to take the union of 'a' with the complement of b, set it
7621 * up so are looking at b's complement. */
7624 /* To complement, we invert: if the first element is 0, remove it. To
7625 * do this, we just pretend the array starts one later, and clear the
7626 * flag as we don't have to do anything else later */
7627 if (array_b[0] == 0) {
7630 complement_b = FALSE;
7634 /* But if the first element is not zero, we unshift a 0 before the
7635 * array. The data structure reserves a space for that 0 (which
7636 * should be a '1' right now), so physical shifting is unneeded,
7637 * but temporarily change that element to 0. Before exiting the
7638 * routine, we must restore the element to '1' */
7645 /* Size the union for the worst case: that the sets are completely
7647 u = _new_invlist(len_a + len_b);
7649 /* Will contain U+0000 if either component does */
7650 array_u = _invlist_array_init(u, (len_a > 0 && array_a[0] == 0)
7651 || (len_b > 0 && array_b[0] == 0));
7653 /* Go through each list item by item, stopping when exhausted one of
7655 while (i_a < len_a && i_b < len_b) {
7656 UV cp; /* The element to potentially add to the union's array */
7657 bool cp_in_set; /* is it in the the input list's set or not */
7659 /* We need to take one or the other of the two inputs for the union.
7660 * Since we are merging two sorted lists, we take the smaller of the
7661 * next items. In case of a tie, we take the one that is in its set
7662 * first. If we took one not in the set first, it would decrement the
7663 * count, possibly to 0 which would cause it to be output as ending the
7664 * range, and the next time through we would take the same number, and
7665 * output it again as beginning the next range. By doing it the
7666 * opposite way, there is no possibility that the count will be
7667 * momentarily decremented to 0, and thus the two adjoining ranges will
7668 * be seamlessly merged. (In a tie and both are in the set or both not
7669 * in the set, it doesn't matter which we take first.) */
7670 if (array_a[i_a] < array_b[i_b]
7671 || (array_a[i_a] == array_b[i_b]
7672 && ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
7674 cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
7678 cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
7682 /* Here, have chosen which of the two inputs to look at. Only output
7683 * if the running count changes to/from 0, which marks the
7684 * beginning/end of a range in that's in the set */
7687 array_u[i_u++] = cp;
7694 array_u[i_u++] = cp;
7699 /* Here, we are finished going through at least one of the lists, which
7700 * means there is something remaining in at most one. We check if the list
7701 * that hasn't been exhausted is positioned such that we are in the middle
7702 * of a range in its set or not. (i_a and i_b point to the element beyond
7703 * the one we care about.) If in the set, we decrement 'count'; if 0, there
7704 * is potentially more to output.
7705 * There are four cases:
7706 * 1) Both weren't in their sets, count is 0, and remains 0. What's left
7707 * in the union is entirely from the non-exhausted set.
7708 * 2) Both were in their sets, count is 2. Nothing further should
7709 * be output, as everything that remains will be in the exhausted
7710 * list's set, hence in the union; decrementing to 1 but not 0 insures
7712 * 3) the exhausted was in its set, non-exhausted isn't, count is 1.
7713 * Nothing further should be output because the union includes
7714 * everything from the exhausted set. Not decrementing ensures that.
7715 * 4) the exhausted wasn't in its set, non-exhausted is, count is 1;
7716 * decrementing to 0 insures that we look at the remainder of the
7717 * non-exhausted set */
7718 if ((i_a != len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
7719 || (i_b != len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
7724 /* The final length is what we've output so far, plus what else is about to
7725 * be output. (If 'count' is non-zero, then the input list we exhausted
7726 * has everything remaining up to the machine's limit in its set, and hence
7727 * in the union, so there will be no further output. */
7730 /* At most one of the subexpressions will be non-zero */
7731 len_u += (len_a - i_a) + (len_b - i_b);
7734 /* Set result to final length, which can change the pointer to array_u, so
7736 if (len_u != _invlist_len(u)) {
7737 invlist_set_len(u, len_u);
7739 array_u = invlist_array(u);
7742 /* When 'count' is 0, the list that was exhausted (if one was shorter than
7743 * the other) ended with everything above it not in its set. That means
7744 * that the remaining part of the union is precisely the same as the
7745 * non-exhausted list, so can just copy it unchanged. (If both list were
7746 * exhausted at the same time, then the operations below will be both 0.)
7749 IV copy_count; /* At most one will have a non-zero copy count */
7750 if ((copy_count = len_a - i_a) > 0) {
7751 Copy(array_a + i_a, array_u + i_u, copy_count, UV);
7753 else if ((copy_count = len_b - i_b) > 0) {
7754 Copy(array_b + i_b, array_u + i_u, copy_count, UV);
7758 /* We may be removing a reference to one of the inputs */
7759 if (a == *output || b == *output) {
7760 SvREFCNT_dec(*output);
7763 /* If we've changed b, restore it */
7773 Perl__invlist_intersection_maybe_complement_2nd(pTHX_ SV* const a, SV* const b, bool complement_b, SV** i)
7775 /* Take the intersection of two inversion lists and point <i> to it. *i
7776 * should be defined upon input, and if it points to one of the two lists,
7777 * the reference count to that list will be decremented.
7778 * If <complement_b> is TRUE, the result will be the intersection of <a>
7779 * and the complement (or inversion) of <b> instead of <b> directly.
7781 * The basis for this comes from "Unicode Demystified" Chapter 13 by
7782 * Richard Gillam, published by Addison-Wesley, and explained at some
7783 * length there. The preface says to incorporate its examples into your
7784 * code at your own risk. In fact, it had bugs
7786 * The algorithm is like a merge sort, and is essentially the same as the
7790 UV* array_a; /* a's array */
7792 UV len_a; /* length of a's array */
7795 SV* r; /* the resulting intersection */
7799 UV i_a = 0; /* current index into a's array */
7803 /* running count, as explained in the algorithm source book; items are
7804 * stopped accumulating and are output when the count changes to/from 2.
7805 * The count is incremented when we start a range that's in the set, and
7806 * decremented when we start a range that's not in the set. So its range
7807 * is 0 to 2. Only when the count is 2 is something in the intersection.
7811 PERL_ARGS_ASSERT__INVLIST_INTERSECTION_MAYBE_COMPLEMENT_2ND;
7814 /* Special case if either one is empty */
7815 len_a = _invlist_len(a);
7816 if ((len_a == 0) || ((len_b = _invlist_len(b)) == 0)) {
7818 if (len_a != 0 && complement_b) {
7820 /* Here, 'a' is not empty, therefore from the above 'if', 'b' must
7821 * be empty. Here, also we are using 'b's complement, which hence
7822 * must be every possible code point. Thus the intersection is
7825 *i = invlist_clone(a);
7831 /* else *i is already 'a' */
7835 /* Here, 'a' or 'b' is empty and not using the complement of 'b'. The
7836 * intersection must be empty */
7843 *i = _new_invlist(0);
7847 /* Here both lists exist and are non-empty */
7848 array_a = invlist_array(a);
7849 array_b = invlist_array(b);
7851 /* If are to take the intersection of 'a' with the complement of b, set it
7852 * up so are looking at b's complement. */
7855 /* To complement, we invert: if the first element is 0, remove it. To
7856 * do this, we just pretend the array starts one later, and clear the
7857 * flag as we don't have to do anything else later */
7858 if (array_b[0] == 0) {
7861 complement_b = FALSE;
7865 /* But if the first element is not zero, we unshift a 0 before the
7866 * array. The data structure reserves a space for that 0 (which
7867 * should be a '1' right now), so physical shifting is unneeded,
7868 * but temporarily change that element to 0. Before exiting the
7869 * routine, we must restore the element to '1' */
7876 /* Size the intersection for the worst case: that the intersection ends up
7877 * fragmenting everything to be completely disjoint */
7878 r= _new_invlist(len_a + len_b);
7880 /* Will contain U+0000 iff both components do */
7881 array_r = _invlist_array_init(r, len_a > 0 && array_a[0] == 0
7882 && len_b > 0 && array_b[0] == 0);
7884 /* Go through each list item by item, stopping when exhausted one of
7886 while (i_a < len_a && i_b < len_b) {
7887 UV cp; /* The element to potentially add to the intersection's
7889 bool cp_in_set; /* Is it in the input list's set or not */
7891 /* We need to take one or the other of the two inputs for the
7892 * intersection. Since we are merging two sorted lists, we take the
7893 * smaller of the next items. In case of a tie, we take the one that
7894 * is not in its set first (a difference from the union algorithm). If
7895 * we took one in the set first, it would increment the count, possibly
7896 * to 2 which would cause it to be output as starting a range in the
7897 * intersection, and the next time through we would take that same
7898 * number, and output it again as ending the set. By doing it the
7899 * opposite of this, there is no possibility that the count will be
7900 * momentarily incremented to 2. (In a tie and both are in the set or
7901 * both not in the set, it doesn't matter which we take first.) */
7902 if (array_a[i_a] < array_b[i_b]
7903 || (array_a[i_a] == array_b[i_b]
7904 && ! ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
7906 cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
7910 cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
7914 /* Here, have chosen which of the two inputs to look at. Only output
7915 * if the running count changes to/from 2, which marks the
7916 * beginning/end of a range that's in the intersection */
7920 array_r[i_r++] = cp;
7925 array_r[i_r++] = cp;
7931 /* Here, we are finished going through at least one of the lists, which
7932 * means there is something remaining in at most one. We check if the list
7933 * that has been exhausted is positioned such that we are in the middle
7934 * of a range in its set or not. (i_a and i_b point to elements 1 beyond
7935 * the ones we care about.) There are four cases:
7936 * 1) Both weren't in their sets, count is 0, and remains 0. There's
7937 * nothing left in the intersection.
7938 * 2) Both were in their sets, count is 2 and perhaps is incremented to
7939 * above 2. What should be output is exactly that which is in the
7940 * non-exhausted set, as everything it has is also in the intersection
7941 * set, and everything it doesn't have can't be in the intersection
7942 * 3) The exhausted was in its set, non-exhausted isn't, count is 1, and
7943 * gets incremented to 2. Like the previous case, the intersection is
7944 * everything that remains in the non-exhausted set.
7945 * 4) the exhausted wasn't in its set, non-exhausted is, count is 1, and
7946 * remains 1. And the intersection has nothing more. */
7947 if ((i_a == len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
7948 || (i_b == len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
7953 /* The final length is what we've output so far plus what else is in the
7954 * intersection. At most one of the subexpressions below will be non-zero */
7957 len_r += (len_a - i_a) + (len_b - i_b);
7960 /* Set result to final length, which can change the pointer to array_r, so
7962 if (len_r != _invlist_len(r)) {
7963 invlist_set_len(r, len_r);
7965 array_r = invlist_array(r);
7968 /* Finish outputting any remaining */
7969 if (count >= 2) { /* At most one will have a non-zero copy count */
7971 if ((copy_count = len_a - i_a) > 0) {
7972 Copy(array_a + i_a, array_r + i_r, copy_count, UV);
7974 else if ((copy_count = len_b - i_b) > 0) {
7975 Copy(array_b + i_b, array_r + i_r, copy_count, UV);
7979 /* We may be removing a reference to one of the inputs */
7980 if (a == *i || b == *i) {
7984 /* If we've changed b, restore it */
7994 Perl__add_range_to_invlist(pTHX_ SV* invlist, const UV start, const UV end)
7996 /* Add the range from 'start' to 'end' inclusive to the inversion list's
7997 * set. A pointer to the inversion list is returned. This may actually be
7998 * a new list, in which case the passed in one has been destroyed. The
7999 * passed in inversion list can be NULL, in which case a new one is created
8000 * with just the one range in it */
8005 if (invlist == NULL) {
8006 invlist = _new_invlist(2);
8010 len = _invlist_len(invlist);
8013 /* If comes after the final entry, can just append it to the end */
8015 || start >= invlist_array(invlist)
8016 [_invlist_len(invlist) - 1])
8018 _append_range_to_invlist(invlist, start, end);
8022 /* Here, can't just append things, create and return a new inversion list
8023 * which is the union of this range and the existing inversion list */
8024 range_invlist = _new_invlist(2);
8025 _append_range_to_invlist(range_invlist, start, end);
8027 _invlist_union(invlist, range_invlist, &invlist);
8029 /* The temporary can be freed */
8030 SvREFCNT_dec(range_invlist);
8037 PERL_STATIC_INLINE SV*
8038 S_add_cp_to_invlist(pTHX_ SV* invlist, const UV cp) {
8039 return _add_range_to_invlist(invlist, cp, cp);
8042 #ifndef PERL_IN_XSUB_RE
8044 Perl__invlist_invert(pTHX_ SV* const invlist)
8046 /* Complement the input inversion list. This adds a 0 if the list didn't
8047 * have a zero; removes it otherwise. As described above, the data
8048 * structure is set up so that this is very efficient */
8050 UV* len_pos = _get_invlist_len_addr(invlist);
8052 PERL_ARGS_ASSERT__INVLIST_INVERT;
8054 /* The inverse of matching nothing is matching everything */
8055 if (*len_pos == 0) {
8056 _append_range_to_invlist(invlist, 0, UV_MAX);
8060 /* The exclusive or complents 0 to 1; and 1 to 0. If the result is 1, the
8061 * zero element was a 0, so it is being removed, so the length decrements
8062 * by 1; and vice-versa. SvCUR is unaffected */
8063 if (*get_invlist_zero_addr(invlist) ^= 1) {
8072 Perl__invlist_invert_prop(pTHX_ SV* const invlist)
8074 /* Complement the input inversion list (which must be a Unicode property,
8075 * all of which don't match above the Unicode maximum code point.) And
8076 * Perl has chosen to not have the inversion match above that either. This
8077 * adds a 0x110000 if the list didn't end with it, and removes it if it did
8083 PERL_ARGS_ASSERT__INVLIST_INVERT_PROP;
8085 _invlist_invert(invlist);
8087 len = _invlist_len(invlist);
8089 if (len != 0) { /* If empty do nothing */
8090 array = invlist_array(invlist);
8091 if (array[len - 1] != PERL_UNICODE_MAX + 1) {
8092 /* Add 0x110000. First, grow if necessary */
8094 if (invlist_max(invlist) < len) {
8095 invlist_extend(invlist, len);
8096 array = invlist_array(invlist);
8098 invlist_set_len(invlist, len);
8099 array[len - 1] = PERL_UNICODE_MAX + 1;
8101 else { /* Remove the 0x110000 */
8102 invlist_set_len(invlist, len - 1);
8110 PERL_STATIC_INLINE SV*
8111 S_invlist_clone(pTHX_ SV* const invlist)
8114 /* Return a new inversion list that is a copy of the input one, which is
8117 /* Need to allocate extra space to accommodate Perl's addition of a
8118 * trailing NUL to SvPV's, since it thinks they are always strings */
8119 SV* new_invlist = _new_invlist(_invlist_len(invlist) + 1);
8120 STRLEN length = SvCUR(invlist);
8122 PERL_ARGS_ASSERT_INVLIST_CLONE;
8124 SvCUR_set(new_invlist, length); /* This isn't done automatically */
8125 Copy(SvPVX(invlist), SvPVX(new_invlist), length, char);
8130 PERL_STATIC_INLINE UV*
8131 S_get_invlist_iter_addr(pTHX_ SV* invlist)
8133 /* Return the address of the UV that contains the current iteration
8136 PERL_ARGS_ASSERT_GET_INVLIST_ITER_ADDR;
8138 return (UV *) (SvPVX(invlist) + (INVLIST_ITER_OFFSET * sizeof (UV)));
8141 PERL_STATIC_INLINE UV*
8142 S_get_invlist_version_id_addr(pTHX_ SV* invlist)
8144 /* Return the address of the UV that contains the version id. */
8146 PERL_ARGS_ASSERT_GET_INVLIST_VERSION_ID_ADDR;
8148 return (UV *) (SvPVX(invlist) + (INVLIST_VERSION_ID_OFFSET * sizeof (UV)));
8151 PERL_STATIC_INLINE void
8152 S_invlist_iterinit(pTHX_ SV* invlist) /* Initialize iterator for invlist */
8154 PERL_ARGS_ASSERT_INVLIST_ITERINIT;
8156 *get_invlist_iter_addr(invlist) = 0;
8160 S_invlist_iternext(pTHX_ SV* invlist, UV* start, UV* end)
8162 /* An C<invlist_iterinit> call on <invlist> must be used to set this up.
8163 * This call sets in <*start> and <*end>, the next range in <invlist>.
8164 * Returns <TRUE> if successful and the next call will return the next
8165 * range; <FALSE> if was already at the end of the list. If the latter,
8166 * <*start> and <*end> are unchanged, and the next call to this function
8167 * will start over at the beginning of the list */
8169 UV* pos = get_invlist_iter_addr(invlist);
8170 UV len = _invlist_len(invlist);
8173 PERL_ARGS_ASSERT_INVLIST_ITERNEXT;
8176 *pos = UV_MAX; /* Force iternit() to be required next time */
8180 array = invlist_array(invlist);
8182 *start = array[(*pos)++];
8188 *end = array[(*pos)++] - 1;
8194 PERL_STATIC_INLINE UV
8195 S_invlist_highest(pTHX_ SV* const invlist)
8197 /* Returns the highest code point that matches an inversion list. This API
8198 * has an ambiguity, as it returns 0 under either the highest is actually
8199 * 0, or if the list is empty. If this distinction matters to you, check
8200 * for emptiness before calling this function */
8202 UV len = _invlist_len(invlist);
8205 PERL_ARGS_ASSERT_INVLIST_HIGHEST;
8211 array = invlist_array(invlist);
8213 /* The last element in the array in the inversion list always starts a
8214 * range that goes to infinity. That range may be for code points that are
8215 * matched in the inversion list, or it may be for ones that aren't
8216 * matched. In the latter case, the highest code point in the set is one
8217 * less than the beginning of this range; otherwise it is the final element
8218 * of this range: infinity */
8219 return (ELEMENT_RANGE_MATCHES_INVLIST(len - 1))
8221 : array[len - 1] - 1;
8224 #ifndef PERL_IN_XSUB_RE
8226 Perl__invlist_contents(pTHX_ SV* const invlist)
8228 /* Get the contents of an inversion list into a string SV so that they can
8229 * be printed out. It uses the format traditionally done for debug tracing
8233 SV* output = newSVpvs("\n");
8235 PERL_ARGS_ASSERT__INVLIST_CONTENTS;
8237 invlist_iterinit(invlist);
8238 while (invlist_iternext(invlist, &start, &end)) {
8239 if (end == UV_MAX) {
8240 Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\tINFINITY\n", start);
8242 else if (end != start) {
8243 Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\t%04"UVXf"\n",
8247 Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\n", start);
8257 S_invlist_dump(pTHX_ SV* const invlist, const char * const header)
8259 /* Dumps out the ranges in an inversion list. The string 'header'
8260 * if present is output on a line before the first range */
8264 if (header && strlen(header)) {
8265 PerlIO_printf(Perl_debug_log, "%s\n", header);
8267 invlist_iterinit(invlist);
8268 while (invlist_iternext(invlist, &start, &end)) {
8269 if (end == UV_MAX) {
8270 PerlIO_printf(Perl_debug_log, "0x%04"UVXf" .. INFINITY\n", start);
8273 PerlIO_printf(Perl_debug_log, "0x%04"UVXf" .. 0x%04"UVXf"\n", start, end);
8281 S__invlistEQ(pTHX_ SV* const a, SV* const b, bool complement_b)
8283 /* Return a boolean as to if the two passed in inversion lists are
8284 * identical. The final argument, if TRUE, says to take the complement of
8285 * the second inversion list before doing the comparison */
8287 UV* array_a = invlist_array(a);
8288 UV* array_b = invlist_array(b);
8289 UV len_a = _invlist_len(a);
8290 UV len_b = _invlist_len(b);
8292 UV i = 0; /* current index into the arrays */
8293 bool retval = TRUE; /* Assume are identical until proven otherwise */
8295 PERL_ARGS_ASSERT__INVLISTEQ;
8297 /* If are to compare 'a' with the complement of b, set it
8298 * up so are looking at b's complement. */
8301 /* The complement of nothing is everything, so <a> would have to have
8302 * just one element, starting at zero (ending at infinity) */
8304 return (len_a == 1 && array_a[0] == 0);
8306 else if (array_b[0] == 0) {
8308 /* Otherwise, to complement, we invert. Here, the first element is
8309 * 0, just remove it. To do this, we just pretend the array starts
8310 * one later, and clear the flag as we don't have to do anything
8315 complement_b = FALSE;
8319 /* But if the first element is not zero, we unshift a 0 before the
8320 * array. The data structure reserves a space for that 0 (which
8321 * should be a '1' right now), so physical shifting is unneeded,
8322 * but temporarily change that element to 0. Before exiting the
8323 * routine, we must restore the element to '1' */
8330 /* Make sure that the lengths are the same, as well as the final element
8331 * before looping through the remainder. (Thus we test the length, final,
8332 * and first elements right off the bat) */
8333 if (len_a != len_b || array_a[len_a-1] != array_b[len_a-1]) {
8336 else for (i = 0; i < len_a - 1; i++) {
8337 if (array_a[i] != array_b[i]) {
8350 #undef HEADER_LENGTH
8351 #undef INVLIST_INITIAL_LENGTH
8352 #undef TO_INTERNAL_SIZE
8353 #undef FROM_INTERNAL_SIZE
8354 #undef INVLIST_LEN_OFFSET
8355 #undef INVLIST_ZERO_OFFSET
8356 #undef INVLIST_ITER_OFFSET
8357 #undef INVLIST_VERSION_ID
8359 /* End of inversion list object */
8362 - reg - regular expression, i.e. main body or parenthesized thing
8364 * Caller must absorb opening parenthesis.
8366 * Combining parenthesis handling with the base level of regular expression
8367 * is a trifle forced, but the need to tie the tails of the branches to what
8368 * follows makes it hard to avoid.
8370 #define REGTAIL(x,y,z) regtail((x),(y),(z),depth+1)
8372 #define REGTAIL_STUDY(x,y,z) regtail_study((x),(y),(z),depth+1)
8374 #define REGTAIL_STUDY(x,y,z) regtail((x),(y),(z),depth+1)
8378 S_reg(pTHX_ RExC_state_t *pRExC_state, I32 paren, I32 *flagp,U32 depth)
8379 /* paren: Parenthesized? 0=top, 1=(, inside: changed to letter. */
8382 regnode *ret; /* Will be the head of the group. */
8385 regnode *ender = NULL;
8388 U32 oregflags = RExC_flags;
8389 bool have_branch = 0;
8391 I32 freeze_paren = 0;
8392 I32 after_freeze = 0;
8394 /* for (?g), (?gc), and (?o) warnings; warning
8395 about (?c) will warn about (?g) -- japhy */
8397 #define WASTED_O 0x01
8398 #define WASTED_G 0x02
8399 #define WASTED_C 0x04
8400 #define WASTED_GC (0x02|0x04)
8401 I32 wastedflags = 0x00;
8403 char * parse_start = RExC_parse; /* MJD */
8404 char * const oregcomp_parse = RExC_parse;
8406 GET_RE_DEBUG_FLAGS_DECL;
8408 PERL_ARGS_ASSERT_REG;
8409 DEBUG_PARSE("reg ");
8411 *flagp = 0; /* Tentatively. */
8414 /* Make an OPEN node, if parenthesized. */
8416 if ( *RExC_parse == '*') { /* (*VERB:ARG) */
8417 char *start_verb = RExC_parse;
8418 STRLEN verb_len = 0;
8419 char *start_arg = NULL;
8420 unsigned char op = 0;
8422 int internal_argval = 0; /* internal_argval is only useful if !argok */
8423 while ( *RExC_parse && *RExC_parse != ')' ) {
8424 if ( *RExC_parse == ':' ) {
8425 start_arg = RExC_parse + 1;
8431 verb_len = RExC_parse - start_verb;
8434 while ( *RExC_parse && *RExC_parse != ')' )
8436 if ( *RExC_parse != ')' )
8437 vFAIL("Unterminated verb pattern argument");
8438 if ( RExC_parse == start_arg )
8441 if ( *RExC_parse != ')' )
8442 vFAIL("Unterminated verb pattern");
8445 switch ( *start_verb ) {
8446 case 'A': /* (*ACCEPT) */
8447 if ( memEQs(start_verb,verb_len,"ACCEPT") ) {
8449 internal_argval = RExC_nestroot;
8452 case 'C': /* (*COMMIT) */
8453 if ( memEQs(start_verb,verb_len,"COMMIT") )
8456 case 'F': /* (*FAIL) */
8457 if ( verb_len==1 || memEQs(start_verb,verb_len,"FAIL") ) {
8462 case ':': /* (*:NAME) */
8463 case 'M': /* (*MARK:NAME) */
8464 if ( verb_len==0 || memEQs(start_verb,verb_len,"MARK") ) {
8469 case 'P': /* (*PRUNE) */
8470 if ( memEQs(start_verb,verb_len,"PRUNE") )
8473 case 'S': /* (*SKIP) */
8474 if ( memEQs(start_verb,verb_len,"SKIP") )
8477 case 'T': /* (*THEN) */
8478 /* [19:06] <TimToady> :: is then */
8479 if ( memEQs(start_verb,verb_len,"THEN") ) {
8481 RExC_seen |= REG_SEEN_CUTGROUP;
8487 vFAIL3("Unknown verb pattern '%.*s'",
8488 verb_len, start_verb);
8491 if ( start_arg && internal_argval ) {
8492 vFAIL3("Verb pattern '%.*s' may not have an argument",
8493 verb_len, start_verb);
8494 } else if ( argok < 0 && !start_arg ) {
8495 vFAIL3("Verb pattern '%.*s' has a mandatory argument",
8496 verb_len, start_verb);
8498 ret = reganode(pRExC_state, op, internal_argval);
8499 if ( ! internal_argval && ! SIZE_ONLY ) {
8501 SV *sv = newSVpvn( start_arg, RExC_parse - start_arg);
8502 ARG(ret) = add_data( pRExC_state, 1, "S" );
8503 RExC_rxi->data->data[ARG(ret)]=(void*)sv;
8510 if (!internal_argval)
8511 RExC_seen |= REG_SEEN_VERBARG;
8512 } else if ( start_arg ) {
8513 vFAIL3("Verb pattern '%.*s' may not have an argument",
8514 verb_len, start_verb);
8516 ret = reg_node(pRExC_state, op);
8518 nextchar(pRExC_state);
8521 if (*RExC_parse == '?') { /* (?...) */
8522 bool is_logical = 0;
8523 const char * const seqstart = RExC_parse;
8524 bool has_use_defaults = FALSE;
8527 paren = *RExC_parse++;
8528 ret = NULL; /* For look-ahead/behind. */
8531 case 'P': /* (?P...) variants for those used to PCRE/Python */
8532 paren = *RExC_parse++;
8533 if ( paren == '<') /* (?P<...>) named capture */
8535 else if (paren == '>') { /* (?P>name) named recursion */
8536 goto named_recursion;
8538 else if (paren == '=') { /* (?P=...) named backref */
8539 /* this pretty much dupes the code for \k<NAME> in regatom(), if
8540 you change this make sure you change that */
8541 char* name_start = RExC_parse;
8543 SV *sv_dat = reg_scan_name(pRExC_state,
8544 SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
8545 if (RExC_parse == name_start || *RExC_parse != ')')
8546 vFAIL2("Sequence %.3s... not terminated",parse_start);
8549 num = add_data( pRExC_state, 1, "S" );
8550 RExC_rxi->data->data[num]=(void*)sv_dat;
8551 SvREFCNT_inc_simple_void(sv_dat);
8554 ret = reganode(pRExC_state,
8557 : (ASCII_FOLD_RESTRICTED)
8559 : (AT_LEAST_UNI_SEMANTICS)
8567 Set_Node_Offset(ret, parse_start+1);
8568 Set_Node_Cur_Length(ret); /* MJD */
8570 nextchar(pRExC_state);
8574 vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
8576 case '<': /* (?<...) */
8577 if (*RExC_parse == '!')
8579 else if (*RExC_parse != '=')
8585 case '\'': /* (?'...') */
8586 name_start= RExC_parse;
8587 svname = reg_scan_name(pRExC_state,
8588 SIZE_ONLY ? /* reverse test from the others */
8589 REG_RSN_RETURN_NAME :
8590 REG_RSN_RETURN_NULL);
8591 if (RExC_parse == name_start) {
8593 vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
8596 if (*RExC_parse != paren)
8597 vFAIL2("Sequence (?%c... not terminated",
8598 paren=='>' ? '<' : paren);
8602 if (!svname) /* shouldn't happen */
8604 "panic: reg_scan_name returned NULL");
8605 if (!RExC_paren_names) {
8606 RExC_paren_names= newHV();
8607 sv_2mortal(MUTABLE_SV(RExC_paren_names));
8609 RExC_paren_name_list= newAV();
8610 sv_2mortal(MUTABLE_SV(RExC_paren_name_list));
8613 he_str = hv_fetch_ent( RExC_paren_names, svname, 1, 0 );
8615 sv_dat = HeVAL(he_str);
8617 /* croak baby croak */
8619 "panic: paren_name hash element allocation failed");
8620 } else if ( SvPOK(sv_dat) ) {
8621 /* (?|...) can mean we have dupes so scan to check
8622 its already been stored. Maybe a flag indicating
8623 we are inside such a construct would be useful,
8624 but the arrays are likely to be quite small, so
8625 for now we punt -- dmq */
8626 IV count = SvIV(sv_dat);
8627 I32 *pv = (I32*)SvPVX(sv_dat);
8629 for ( i = 0 ; i < count ; i++ ) {
8630 if ( pv[i] == RExC_npar ) {
8636 pv = (I32*)SvGROW(sv_dat, SvCUR(sv_dat) + sizeof(I32)+1);
8637 SvCUR_set(sv_dat, SvCUR(sv_dat) + sizeof(I32));
8638 pv[count] = RExC_npar;
8639 SvIV_set(sv_dat, SvIVX(sv_dat) + 1);
8642 (void)SvUPGRADE(sv_dat,SVt_PVNV);
8643 sv_setpvn(sv_dat, (char *)&(RExC_npar), sizeof(I32));
8645 SvIV_set(sv_dat, 1);
8648 /* Yes this does cause a memory leak in debugging Perls */
8649 if (!av_store(RExC_paren_name_list, RExC_npar, SvREFCNT_inc(svname)))
8650 SvREFCNT_dec(svname);
8653 /*sv_dump(sv_dat);*/
8655 nextchar(pRExC_state);
8657 goto capturing_parens;
8659 RExC_seen |= REG_SEEN_LOOKBEHIND;
8660 RExC_in_lookbehind++;
8662 case '=': /* (?=...) */
8663 RExC_seen_zerolen++;
8665 case '!': /* (?!...) */
8666 RExC_seen_zerolen++;
8667 if (*RExC_parse == ')') {
8668 ret=reg_node(pRExC_state, OPFAIL);
8669 nextchar(pRExC_state);
8673 case '|': /* (?|...) */
8674 /* branch reset, behave like a (?:...) except that
8675 buffers in alternations share the same numbers */
8677 after_freeze = freeze_paren = RExC_npar;
8679 case ':': /* (?:...) */
8680 case '>': /* (?>...) */
8682 case '$': /* (?$...) */
8683 case '@': /* (?@...) */
8684 vFAIL2("Sequence (?%c...) not implemented", (int)paren);
8686 case '#': /* (?#...) */
8687 while (*RExC_parse && *RExC_parse != ')')
8689 if (*RExC_parse != ')')
8690 FAIL("Sequence (?#... not terminated");
8691 nextchar(pRExC_state);
8694 case '0' : /* (?0) */
8695 case 'R' : /* (?R) */
8696 if (*RExC_parse != ')')
8697 FAIL("Sequence (?R) not terminated");
8698 ret = reg_node(pRExC_state, GOSTART);
8699 *flagp |= POSTPONED;
8700 nextchar(pRExC_state);
8703 { /* named and numeric backreferences */
8705 case '&': /* (?&NAME) */
8706 parse_start = RExC_parse - 1;
8709 SV *sv_dat = reg_scan_name(pRExC_state,
8710 SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
8711 num = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
8713 goto gen_recurse_regop;
8714 assert(0); /* NOT REACHED */
8716 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
8718 vFAIL("Illegal pattern");
8720 goto parse_recursion;
8722 case '-': /* (?-1) */
8723 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
8724 RExC_parse--; /* rewind to let it be handled later */
8728 case '1': case '2': case '3': case '4': /* (?1) */
8729 case '5': case '6': case '7': case '8': case '9':
8732 num = atoi(RExC_parse);
8733 parse_start = RExC_parse - 1; /* MJD */
8734 if (*RExC_parse == '-')
8736 while (isDIGIT(*RExC_parse))
8738 if (*RExC_parse!=')')
8739 vFAIL("Expecting close bracket");
8742 if ( paren == '-' ) {
8744 Diagram of capture buffer numbering.
8745 Top line is the normal capture buffer numbers
8746 Bottom line is the negative indexing as from
8750 /(a(x)y)(a(b(c(?-2)d)e)f)(g(h))/
8754 num = RExC_npar + num;
8757 vFAIL("Reference to nonexistent group");
8759 } else if ( paren == '+' ) {
8760 num = RExC_npar + num - 1;
8763 ret = reganode(pRExC_state, GOSUB, num);
8765 if (num > (I32)RExC_rx->nparens) {
8767 vFAIL("Reference to nonexistent group");
8769 ARG2L_SET( ret, RExC_recurse_count++);
8771 DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
8772 "Recurse #%"UVuf" to %"IVdf"\n", (UV)ARG(ret), (IV)ARG2L(ret)));
8776 RExC_seen |= REG_SEEN_RECURSE;
8777 Set_Node_Length(ret, 1 + regarglen[OP(ret)]); /* MJD */
8778 Set_Node_Offset(ret, parse_start); /* MJD */
8780 *flagp |= POSTPONED;
8781 nextchar(pRExC_state);
8783 } /* named and numeric backreferences */
8784 assert(0); /* NOT REACHED */
8786 case '?': /* (??...) */
8788 if (*RExC_parse != '{') {
8790 vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
8793 *flagp |= POSTPONED;
8794 paren = *RExC_parse++;
8796 case '{': /* (?{...}) */
8799 struct reg_code_block *cb;
8801 RExC_seen_zerolen++;
8803 if ( !pRExC_state->num_code_blocks
8804 || pRExC_state->code_index >= pRExC_state->num_code_blocks
8805 || pRExC_state->code_blocks[pRExC_state->code_index].start
8806 != (STRLEN)((RExC_parse -3 - (is_logical ? 1 : 0))
8809 if (RExC_pm_flags & PMf_USE_RE_EVAL)
8810 FAIL("panic: Sequence (?{...}): no code block found\n");
8811 FAIL("Eval-group not allowed at runtime, use re 'eval'");
8813 /* this is a pre-compiled code block (?{...}) */
8814 cb = &pRExC_state->code_blocks[pRExC_state->code_index];
8815 RExC_parse = RExC_start + cb->end;
8818 if (cb->src_regex) {
8819 n = add_data(pRExC_state, 2, "rl");
8820 RExC_rxi->data->data[n] =
8821 (void*)SvREFCNT_inc((SV*)cb->src_regex);
8822 RExC_rxi->data->data[n+1] = (void*)o;
8825 n = add_data(pRExC_state, 1,
8826 (RExC_pm_flags & PMf_HAS_CV) ? "L" : "l");
8827 RExC_rxi->data->data[n] = (void*)o;
8830 pRExC_state->code_index++;
8831 nextchar(pRExC_state);
8835 ret = reg_node(pRExC_state, LOGICAL);
8836 eval = reganode(pRExC_state, EVAL, n);
8839 /* for later propagation into (??{}) return value */
8840 eval->flags = (U8) (RExC_flags & RXf_PMf_COMPILETIME);
8842 REGTAIL(pRExC_state, ret, eval);
8843 /* deal with the length of this later - MJD */
8846 ret = reganode(pRExC_state, EVAL, n);
8847 Set_Node_Length(ret, RExC_parse - parse_start + 1);
8848 Set_Node_Offset(ret, parse_start);
8851 case '(': /* (?(?{...})...) and (?(?=...)...) */
8854 if (RExC_parse[0] == '?') { /* (?(?...)) */
8855 if (RExC_parse[1] == '=' || RExC_parse[1] == '!'
8856 || RExC_parse[1] == '<'
8857 || RExC_parse[1] == '{') { /* Lookahead or eval. */
8860 ret = reg_node(pRExC_state, LOGICAL);
8863 REGTAIL(pRExC_state, ret, reg(pRExC_state, 1, &flag,depth+1));
8867 else if ( RExC_parse[0] == '<' /* (?(<NAME>)...) */
8868 || RExC_parse[0] == '\'' ) /* (?('NAME')...) */
8870 char ch = RExC_parse[0] == '<' ? '>' : '\'';
8871 char *name_start= RExC_parse++;
8873 SV *sv_dat=reg_scan_name(pRExC_state,
8874 SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
8875 if (RExC_parse == name_start || *RExC_parse != ch)
8876 vFAIL2("Sequence (?(%c... not terminated",
8877 (ch == '>' ? '<' : ch));
8880 num = add_data( pRExC_state, 1, "S" );
8881 RExC_rxi->data->data[num]=(void*)sv_dat;
8882 SvREFCNT_inc_simple_void(sv_dat);
8884 ret = reganode(pRExC_state,NGROUPP,num);
8885 goto insert_if_check_paren;
8887 else if (RExC_parse[0] == 'D' &&
8888 RExC_parse[1] == 'E' &&
8889 RExC_parse[2] == 'F' &&
8890 RExC_parse[3] == 'I' &&
8891 RExC_parse[4] == 'N' &&
8892 RExC_parse[5] == 'E')
8894 ret = reganode(pRExC_state,DEFINEP,0);
8897 goto insert_if_check_paren;
8899 else if (RExC_parse[0] == 'R') {
8902 if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
8903 parno = atoi(RExC_parse++);
8904 while (isDIGIT(*RExC_parse))
8906 } else if (RExC_parse[0] == '&') {
8909 sv_dat = reg_scan_name(pRExC_state,
8910 SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
8911 parno = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
8913 ret = reganode(pRExC_state,INSUBP,parno);
8914 goto insert_if_check_paren;
8916 else if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
8919 parno = atoi(RExC_parse++);
8921 while (isDIGIT(*RExC_parse))
8923 ret = reganode(pRExC_state, GROUPP, parno);
8925 insert_if_check_paren:
8926 if ((c = *nextchar(pRExC_state)) != ')')
8927 vFAIL("Switch condition not recognized");
8929 REGTAIL(pRExC_state, ret, reganode(pRExC_state, IFTHEN, 0));
8930 br = regbranch(pRExC_state, &flags, 1,depth+1);
8932 br = reganode(pRExC_state, LONGJMP, 0);
8934 REGTAIL(pRExC_state, br, reganode(pRExC_state, LONGJMP, 0));
8935 c = *nextchar(pRExC_state);
8940 vFAIL("(?(DEFINE)....) does not allow branches");
8941 lastbr = reganode(pRExC_state, IFTHEN, 0); /* Fake one for optimizer. */
8942 regbranch(pRExC_state, &flags, 1,depth+1);
8943 REGTAIL(pRExC_state, ret, lastbr);
8946 c = *nextchar(pRExC_state);
8951 vFAIL("Switch (?(condition)... contains too many branches");
8952 ender = reg_node(pRExC_state, TAIL);
8953 REGTAIL(pRExC_state, br, ender);
8955 REGTAIL(pRExC_state, lastbr, ender);
8956 REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender);
8959 REGTAIL(pRExC_state, ret, ender);
8960 RExC_size++; /* XXX WHY do we need this?!!
8961 For large programs it seems to be required
8962 but I can't figure out why. -- dmq*/
8966 vFAIL2("Unknown switch condition (?(%.2s", RExC_parse);
8970 RExC_parse--; /* for vFAIL to print correctly */
8971 vFAIL("Sequence (? incomplete");
8973 case DEFAULT_PAT_MOD: /* Use default flags with the exceptions
8975 has_use_defaults = TRUE;
8976 STD_PMMOD_FLAGS_CLEAR(&RExC_flags);
8977 set_regex_charset(&RExC_flags, (RExC_utf8 || RExC_uni_semantics)
8978 ? REGEX_UNICODE_CHARSET
8979 : REGEX_DEPENDS_CHARSET);
8983 parse_flags: /* (?i) */
8985 U32 posflags = 0, negflags = 0;
8986 U32 *flagsp = &posflags;
8987 char has_charset_modifier = '\0';
8988 regex_charset cs = get_regex_charset(RExC_flags);
8989 if (cs == REGEX_DEPENDS_CHARSET
8990 && (RExC_utf8 || RExC_uni_semantics))
8992 cs = REGEX_UNICODE_CHARSET;
8995 while (*RExC_parse) {
8996 /* && strchr("iogcmsx", *RExC_parse) */
8997 /* (?g), (?gc) and (?o) are useless here
8998 and must be globally applied -- japhy */
8999 switch (*RExC_parse) {
9000 CASE_STD_PMMOD_FLAGS_PARSE_SET(flagsp);
9001 case LOCALE_PAT_MOD:
9002 if (has_charset_modifier) {
9003 goto excess_modifier;
9005 else if (flagsp == &negflags) {
9008 cs = REGEX_LOCALE_CHARSET;
9009 has_charset_modifier = LOCALE_PAT_MOD;
9010 RExC_contains_locale = 1;
9012 case UNICODE_PAT_MOD:
9013 if (has_charset_modifier) {
9014 goto excess_modifier;
9016 else if (flagsp == &negflags) {
9019 cs = REGEX_UNICODE_CHARSET;
9020 has_charset_modifier = UNICODE_PAT_MOD;
9022 case ASCII_RESTRICT_PAT_MOD:
9023 if (flagsp == &negflags) {
9026 if (has_charset_modifier) {
9027 if (cs != REGEX_ASCII_RESTRICTED_CHARSET) {
9028 goto excess_modifier;
9030 /* Doubled modifier implies more restricted */
9031 cs = REGEX_ASCII_MORE_RESTRICTED_CHARSET;
9034 cs = REGEX_ASCII_RESTRICTED_CHARSET;
9036 has_charset_modifier = ASCII_RESTRICT_PAT_MOD;
9038 case DEPENDS_PAT_MOD:
9039 if (has_use_defaults) {
9040 goto fail_modifiers;
9042 else if (flagsp == &negflags) {
9045 else if (has_charset_modifier) {
9046 goto excess_modifier;
9049 /* The dual charset means unicode semantics if the
9050 * pattern (or target, not known until runtime) are
9051 * utf8, or something in the pattern indicates unicode
9053 cs = (RExC_utf8 || RExC_uni_semantics)
9054 ? REGEX_UNICODE_CHARSET
9055 : REGEX_DEPENDS_CHARSET;
9056 has_charset_modifier = DEPENDS_PAT_MOD;
9060 if (has_charset_modifier == ASCII_RESTRICT_PAT_MOD) {
9061 vFAIL2("Regexp modifier \"%c\" may appear a maximum of twice", ASCII_RESTRICT_PAT_MOD);
9063 else if (has_charset_modifier == *(RExC_parse - 1)) {
9064 vFAIL2("Regexp modifier \"%c\" may not appear twice", *(RExC_parse - 1));
9067 vFAIL3("Regexp modifiers \"%c\" and \"%c\" are mutually exclusive", has_charset_modifier, *(RExC_parse - 1));
9072 vFAIL2("Regexp modifier \"%c\" may not appear after the \"-\"", *(RExC_parse - 1));
9074 case ONCE_PAT_MOD: /* 'o' */
9075 case GLOBAL_PAT_MOD: /* 'g' */
9076 if (SIZE_ONLY && ckWARN(WARN_REGEXP)) {
9077 const I32 wflagbit = *RExC_parse == 'o' ? WASTED_O : WASTED_G;
9078 if (! (wastedflags & wflagbit) ) {
9079 wastedflags |= wflagbit;
9082 "Useless (%s%c) - %suse /%c modifier",
9083 flagsp == &negflags ? "?-" : "?",
9085 flagsp == &negflags ? "don't " : "",
9092 case CONTINUE_PAT_MOD: /* 'c' */
9093 if (SIZE_ONLY && ckWARN(WARN_REGEXP)) {
9094 if (! (wastedflags & WASTED_C) ) {
9095 wastedflags |= WASTED_GC;
9098 "Useless (%sc) - %suse /gc modifier",
9099 flagsp == &negflags ? "?-" : "?",
9100 flagsp == &negflags ? "don't " : ""
9105 case KEEPCOPY_PAT_MOD: /* 'p' */
9106 if (flagsp == &negflags) {
9108 ckWARNreg(RExC_parse + 1,"Useless use of (?-p)");
9110 *flagsp |= RXf_PMf_KEEPCOPY;
9114 /* A flag is a default iff it is following a minus, so
9115 * if there is a minus, it means will be trying to
9116 * re-specify a default which is an error */
9117 if (has_use_defaults || flagsp == &negflags) {
9120 vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
9124 wastedflags = 0; /* reset so (?g-c) warns twice */
9130 RExC_flags |= posflags;
9131 RExC_flags &= ~negflags;
9132 set_regex_charset(&RExC_flags, cs);
9134 oregflags |= posflags;
9135 oregflags &= ~negflags;
9136 set_regex_charset(&oregflags, cs);
9138 nextchar(pRExC_state);
9149 vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
9154 }} /* one for the default block, one for the switch */
9161 ret = reganode(pRExC_state, OPEN, parno);
9164 RExC_nestroot = parno;
9165 if (RExC_seen & REG_SEEN_RECURSE
9166 && !RExC_open_parens[parno-1])
9168 DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
9169 "Setting open paren #%"IVdf" to %d\n",
9170 (IV)parno, REG_NODE_NUM(ret)));
9171 RExC_open_parens[parno-1]= ret;
9174 Set_Node_Length(ret, 1); /* MJD */
9175 Set_Node_Offset(ret, RExC_parse); /* MJD */
9183 /* Pick up the branches, linking them together. */
9184 parse_start = RExC_parse; /* MJD */
9185 br = regbranch(pRExC_state, &flags, 1,depth+1);
9187 /* branch_len = (paren != 0); */
9191 if (*RExC_parse == '|') {
9192 if (!SIZE_ONLY && RExC_extralen) {
9193 reginsert(pRExC_state, BRANCHJ, br, depth+1);
9196 reginsert(pRExC_state, BRANCH, br, depth+1);
9197 Set_Node_Length(br, paren != 0);
9198 Set_Node_Offset_To_R(br-RExC_emit_start, parse_start-RExC_start);
9202 RExC_extralen += 1; /* For BRANCHJ-BRANCH. */
9204 else if (paren == ':') {
9205 *flagp |= flags&SIMPLE;
9207 if (is_open) { /* Starts with OPEN. */
9208 REGTAIL(pRExC_state, ret, br); /* OPEN -> first. */
9210 else if (paren != '?') /* Not Conditional */
9212 *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
9214 while (*RExC_parse == '|') {
9215 if (!SIZE_ONLY && RExC_extralen) {
9216 ender = reganode(pRExC_state, LONGJMP,0);
9217 REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender); /* Append to the previous. */
9220 RExC_extralen += 2; /* Account for LONGJMP. */
9221 nextchar(pRExC_state);
9223 if (RExC_npar > after_freeze)
9224 after_freeze = RExC_npar;
9225 RExC_npar = freeze_paren;
9227 br = regbranch(pRExC_state, &flags, 0, depth+1);
9231 REGTAIL(pRExC_state, lastbr, br); /* BRANCH -> BRANCH. */
9233 *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
9236 if (have_branch || paren != ':') {
9237 /* Make a closing node, and hook it on the end. */
9240 ender = reg_node(pRExC_state, TAIL);
9243 ender = reganode(pRExC_state, CLOSE, parno);
9244 if (!SIZE_ONLY && RExC_seen & REG_SEEN_RECURSE) {
9245 DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
9246 "Setting close paren #%"IVdf" to %d\n",
9247 (IV)parno, REG_NODE_NUM(ender)));
9248 RExC_close_parens[parno-1]= ender;
9249 if (RExC_nestroot == parno)
9252 Set_Node_Offset(ender,RExC_parse+1); /* MJD */
9253 Set_Node_Length(ender,1); /* MJD */
9259 *flagp &= ~HASWIDTH;
9262 ender = reg_node(pRExC_state, SUCCEED);
9265 ender = reg_node(pRExC_state, END);
9267 assert(!RExC_opend); /* there can only be one! */
9272 DEBUG_PARSE_r(if (!SIZE_ONLY) {
9273 SV * const mysv_val1=sv_newmortal();
9274 SV * const mysv_val2=sv_newmortal();
9275 DEBUG_PARSE_MSG("lsbr");
9276 regprop(RExC_rx, mysv_val1, lastbr);
9277 regprop(RExC_rx, mysv_val2, ender);
9278 PerlIO_printf(Perl_debug_log, "~ tying lastbr %s (%"IVdf") to ender %s (%"IVdf") offset %"IVdf"\n",
9279 SvPV_nolen_const(mysv_val1),
9280 (IV)REG_NODE_NUM(lastbr),
9281 SvPV_nolen_const(mysv_val2),
9282 (IV)REG_NODE_NUM(ender),
9283 (IV)(ender - lastbr)
9286 REGTAIL(pRExC_state, lastbr, ender);
9288 if (have_branch && !SIZE_ONLY) {
9291 RExC_seen |= REG_TOP_LEVEL_BRANCHES;
9293 /* Hook the tails of the branches to the closing node. */
9294 for (br = ret; br; br = regnext(br)) {
9295 const U8 op = PL_regkind[OP(br)];
9297 REGTAIL_STUDY(pRExC_state, NEXTOPER(br), ender);
9298 if (OP(NEXTOPER(br)) != NOTHING || regnext(NEXTOPER(br)) != ender)
9301 else if (op == BRANCHJ) {
9302 REGTAIL_STUDY(pRExC_state, NEXTOPER(NEXTOPER(br)), ender);
9303 /* for now we always disable this optimisation * /
9304 if (OP(NEXTOPER(NEXTOPER(br))) != NOTHING || regnext(NEXTOPER(NEXTOPER(br))) != ender)
9310 br= PL_regkind[OP(ret)] != BRANCH ? regnext(ret) : ret;
9311 DEBUG_PARSE_r(if (!SIZE_ONLY) {
9312 SV * const mysv_val1=sv_newmortal();
9313 SV * const mysv_val2=sv_newmortal();
9314 DEBUG_PARSE_MSG("NADA");
9315 regprop(RExC_rx, mysv_val1, ret);
9316 regprop(RExC_rx, mysv_val2, ender);
9317 PerlIO_printf(Perl_debug_log, "~ converting ret %s (%"IVdf") to ender %s (%"IVdf") offset %"IVdf"\n",
9318 SvPV_nolen_const(mysv_val1),
9319 (IV)REG_NODE_NUM(ret),
9320 SvPV_nolen_const(mysv_val2),
9321 (IV)REG_NODE_NUM(ender),
9326 if (OP(ender) == TAIL) {
9331 for ( opt= br + 1; opt < ender ; opt++ )
9333 NEXT_OFF(br)= ender - br;
9341 static const char parens[] = "=!<,>";
9343 if (paren && (p = strchr(parens, paren))) {
9344 U8 node = ((p - parens) % 2) ? UNLESSM : IFMATCH;
9345 int flag = (p - parens) > 1;
9348 node = SUSPEND, flag = 0;
9349 reginsert(pRExC_state, node,ret, depth+1);
9350 Set_Node_Cur_Length(ret);
9351 Set_Node_Offset(ret, parse_start + 1);
9353 REGTAIL_STUDY(pRExC_state, ret, reg_node(pRExC_state, TAIL));
9357 /* Check for proper termination. */
9359 RExC_flags = oregflags;
9360 if (RExC_parse >= RExC_end || *nextchar(pRExC_state) != ')') {
9361 RExC_parse = oregcomp_parse;
9362 vFAIL("Unmatched (");
9365 else if (!paren && RExC_parse < RExC_end) {
9366 if (*RExC_parse == ')') {
9368 vFAIL("Unmatched )");
9371 FAIL("Junk on end of regexp"); /* "Can't happen". */
9372 assert(0); /* NOTREACHED */
9375 if (RExC_in_lookbehind) {
9376 RExC_in_lookbehind--;
9378 if (after_freeze > RExC_npar)
9379 RExC_npar = after_freeze;
9384 - regbranch - one alternative of an | operator
9386 * Implements the concatenation operator.
9389 S_regbranch(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, I32 first, U32 depth)
9393 regnode *chain = NULL;
9395 I32 flags = 0, c = 0;
9396 GET_RE_DEBUG_FLAGS_DECL;
9398 PERL_ARGS_ASSERT_REGBRANCH;
9400 DEBUG_PARSE("brnc");
9405 if (!SIZE_ONLY && RExC_extralen)
9406 ret = reganode(pRExC_state, BRANCHJ,0);
9408 ret = reg_node(pRExC_state, BRANCH);
9409 Set_Node_Length(ret, 1);
9413 if (!first && SIZE_ONLY)
9414 RExC_extralen += 1; /* BRANCHJ */
9416 *flagp = WORST; /* Tentatively. */
9419 nextchar(pRExC_state);
9420 while (RExC_parse < RExC_end && *RExC_parse != '|' && *RExC_parse != ')') {
9422 latest = regpiece(pRExC_state, &flags,depth+1);
9423 if (latest == NULL) {
9424 if (flags & TRYAGAIN)
9428 else if (ret == NULL)
9430 *flagp |= flags&(HASWIDTH|POSTPONED);
9431 if (chain == NULL) /* First piece. */
9432 *flagp |= flags&SPSTART;
9435 REGTAIL(pRExC_state, chain, latest);
9440 if (chain == NULL) { /* Loop ran zero times. */
9441 chain = reg_node(pRExC_state, NOTHING);
9446 *flagp |= flags&SIMPLE;
9453 - regpiece - something followed by possible [*+?]
9455 * Note that the branching code sequences used for ? and the general cases
9456 * of * and + are somewhat optimized: they use the same NOTHING node as
9457 * both the endmarker for their branch list and the body of the last branch.
9458 * It might seem that this node could be dispensed with entirely, but the
9459 * endmarker role is not redundant.
9462 S_regpiece(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
9469 const char * const origparse = RExC_parse;
9471 I32 max = REG_INFTY;
9472 #ifdef RE_TRACK_PATTERN_OFFSETS
9475 const char *maxpos = NULL;
9477 /* Save the original in case we change the emitted regop to a FAIL. */
9478 regnode * const orig_emit = RExC_emit;
9480 GET_RE_DEBUG_FLAGS_DECL;
9482 PERL_ARGS_ASSERT_REGPIECE;
9484 DEBUG_PARSE("piec");
9486 ret = regatom(pRExC_state, &flags,depth+1);
9488 if (flags & TRYAGAIN)
9495 if (op == '{' && regcurly(RExC_parse)) {
9497 #ifdef RE_TRACK_PATTERN_OFFSETS
9498 parse_start = RExC_parse; /* MJD */
9500 next = RExC_parse + 1;
9501 while (isDIGIT(*next) || *next == ',') {
9510 if (*next == '}') { /* got one */
9514 min = atoi(RExC_parse);
9518 maxpos = RExC_parse;
9520 if (!max && *maxpos != '0')
9521 max = REG_INFTY; /* meaning "infinity" */
9522 else if (max >= REG_INFTY)
9523 vFAIL2("Quantifier in {,} bigger than %d", REG_INFTY - 1);
9525 nextchar(pRExC_state);
9526 if (max < min) { /* If can't match, warn and optimize to fail
9529 ckWARNreg(RExC_parse, "Quantifier {n,m} with n > m can't match");
9531 /* We can't back off the size because we have to reserve
9532 * enough space for all the things we are about to throw
9533 * away, but we can shrink it by the ammount we are about
9535 RExC_size = PREVOPER(RExC_size) - regarglen[(U8)OPFAIL];
9538 RExC_emit = orig_emit;
9540 ret = reg_node(pRExC_state, OPFAIL);
9545 if ((flags&SIMPLE)) {
9546 RExC_naughty += 2 + RExC_naughty / 2;
9547 reginsert(pRExC_state, CURLY, ret, depth+1);
9548 Set_Node_Offset(ret, parse_start+1); /* MJD */
9549 Set_Node_Cur_Length(ret);
9552 regnode * const w = reg_node(pRExC_state, WHILEM);
9555 REGTAIL(pRExC_state, ret, w);
9556 if (!SIZE_ONLY && RExC_extralen) {
9557 reginsert(pRExC_state, LONGJMP,ret, depth+1);
9558 reginsert(pRExC_state, NOTHING,ret, depth+1);
9559 NEXT_OFF(ret) = 3; /* Go over LONGJMP. */
9561 reginsert(pRExC_state, CURLYX,ret, depth+1);
9563 Set_Node_Offset(ret, parse_start+1);
9564 Set_Node_Length(ret,
9565 op == '{' ? (RExC_parse - parse_start) : 1);
9567 if (!SIZE_ONLY && RExC_extralen)
9568 NEXT_OFF(ret) = 3; /* Go over NOTHING to LONGJMP. */
9569 REGTAIL(pRExC_state, ret, reg_node(pRExC_state, NOTHING));
9571 RExC_whilem_seen++, RExC_extralen += 3;
9572 RExC_naughty += 4 + RExC_naughty; /* compound interest */
9581 ARG1_SET(ret, (U16)min);
9582 ARG2_SET(ret, (U16)max);
9594 #if 0 /* Now runtime fix should be reliable. */
9596 /* if this is reinstated, don't forget to put this back into perldiag:
9598 =item Regexp *+ operand could be empty at {#} in regex m/%s/
9600 (F) The part of the regexp subject to either the * or + quantifier
9601 could match an empty string. The {#} shows in the regular
9602 expression about where the problem was discovered.
9606 if (!(flags&HASWIDTH) && op != '?')
9607 vFAIL("Regexp *+ operand could be empty");
9610 #ifdef RE_TRACK_PATTERN_OFFSETS
9611 parse_start = RExC_parse;
9613 nextchar(pRExC_state);
9615 *flagp = (op != '+') ? (WORST|SPSTART|HASWIDTH) : (WORST|HASWIDTH);
9617 if (op == '*' && (flags&SIMPLE)) {
9618 reginsert(pRExC_state, STAR, ret, depth+1);
9622 else if (op == '*') {
9626 else if (op == '+' && (flags&SIMPLE)) {
9627 reginsert(pRExC_state, PLUS, ret, depth+1);
9631 else if (op == '+') {
9635 else if (op == '?') {
9640 if (!SIZE_ONLY && !(flags&(HASWIDTH|POSTPONED)) && max > REG_INFTY/3) {
9641 ckWARN3reg(RExC_parse,
9642 "%.*s matches null string many times",
9643 (int)(RExC_parse >= origparse ? RExC_parse - origparse : 0),
9647 if (RExC_parse < RExC_end && *RExC_parse == '?') {
9648 nextchar(pRExC_state);
9649 reginsert(pRExC_state, MINMOD, ret, depth+1);
9650 REGTAIL(pRExC_state, ret, ret + NODE_STEP_REGNODE);
9652 #ifndef REG_ALLOW_MINMOD_SUSPEND
9655 if (RExC_parse < RExC_end && *RExC_parse == '+') {
9657 nextchar(pRExC_state);
9658 ender = reg_node(pRExC_state, SUCCEED);
9659 REGTAIL(pRExC_state, ret, ender);
9660 reginsert(pRExC_state, SUSPEND, ret, depth+1);
9662 ender = reg_node(pRExC_state, TAIL);
9663 REGTAIL(pRExC_state, ret, ender);
9667 if (RExC_parse < RExC_end && ISMULT2(RExC_parse)) {
9669 vFAIL("Nested quantifiers");
9676 S_grok_bslash_N(pTHX_ RExC_state_t *pRExC_state, regnode** node_p, UV *valuep, I32 *flagp, U32 depth, bool in_char_class)
9679 /* This is expected to be called by a parser routine that has recognized '\N'
9680 and needs to handle the rest. RExC_parse is expected to point at the first
9681 char following the N at the time of the call. On successful return,
9682 RExC_parse has been updated to point to just after the sequence identified
9683 by this routine, and <*flagp> has been updated.
9685 The \N may be inside (indicated by the boolean <in_char_class>) or outside a
9688 \N may begin either a named sequence, or if outside a character class, mean
9689 to match a non-newline. For non single-quoted regexes, the tokenizer has
9690 attempted to decide which, and in the case of a named sequence, converted it
9691 into one of the forms: \N{} (if the sequence is null), or \N{U+c1.c2...},
9692 where c1... are the characters in the sequence. For single-quoted regexes,
9693 the tokenizer passes the \N sequence through unchanged; this code will not
9694 attempt to determine this nor expand those, instead raising a syntax error.
9695 The net effect is that if the beginning of the passed-in pattern isn't '{U+'
9696 or there is no '}', it signals that this \N occurrence means to match a
9699 Only the \N{U+...} form should occur in a character class, for the same
9700 reason that '.' inside a character class means to just match a period: it
9701 just doesn't make sense.
9703 The function raises an error (via vFAIL), and doesn't return for various
9704 syntax errors. Otherwise it returns TRUE and sets <node_p> or <valuep> on
9705 success; it returns FALSE otherwise.
9707 If <valuep> is non-null, it means the caller can accept an input sequence
9708 consisting of a just a single code point; <*valuep> is set to that value
9709 if the input is such.
9711 If <node_p> is non-null it signifies that the caller can accept any other
9712 legal sequence (i.e., one that isn't just a single code point). <*node_p>
9714 1) \N means not-a-NL: points to a newly created REG_ANY node;
9715 2) \N{}: points to a new NOTHING node;
9716 3) otherwise: points to a new EXACT node containing the resolved
9718 Note that FALSE is returned for single code point sequences if <valuep> is
9722 char * endbrace; /* '}' following the name */
9724 char *endchar; /* Points to '.' or '}' ending cur char in the input
9726 bool has_multiple_chars; /* true if the input stream contains a sequence of
9727 more than one character */
9729 GET_RE_DEBUG_FLAGS_DECL;
9731 PERL_ARGS_ASSERT_GROK_BSLASH_N;
9735 assert(cBOOL(node_p) ^ cBOOL(valuep)); /* Exactly one should be set */
9737 /* The [^\n] meaning of \N ignores spaces and comments under the /x
9738 * modifier. The other meaning does not */
9739 p = (RExC_flags & RXf_PMf_EXTENDED)
9740 ? regwhite( pRExC_state, RExC_parse )
9743 /* Disambiguate between \N meaning a named character versus \N meaning
9744 * [^\n]. The former is assumed when it can't be the latter. */
9745 if (*p != '{' || regcurly(p)) {
9748 /* no bare \N in a charclass */
9749 if (in_char_class) {
9750 vFAIL("\\N in a character class must be a named character: \\N{...}");
9754 nextchar(pRExC_state);
9755 *node_p = reg_node(pRExC_state, REG_ANY);
9756 *flagp |= HASWIDTH|SIMPLE;
9759 Set_Node_Length(*node_p, 1); /* MJD */
9763 /* Here, we have decided it should be a named character or sequence */
9765 /* The test above made sure that the next real character is a '{', but
9766 * under the /x modifier, it could be separated by space (or a comment and
9767 * \n) and this is not allowed (for consistency with \x{...} and the
9768 * tokenizer handling of \N{NAME}). */
9769 if (*RExC_parse != '{') {
9770 vFAIL("Missing braces on \\N{}");
9773 RExC_parse++; /* Skip past the '{' */
9775 if (! (endbrace = strchr(RExC_parse, '}')) /* no trailing brace */
9776 || ! (endbrace == RExC_parse /* nothing between the {} */
9777 || (endbrace - RExC_parse >= 2 /* U+ (bad hex is checked below */
9778 && strnEQ(RExC_parse, "U+", 2)))) /* for a better error msg) */
9780 if (endbrace) RExC_parse = endbrace; /* position msg's '<--HERE' */
9781 vFAIL("\\N{NAME} must be resolved by the lexer");
9784 if (endbrace == RExC_parse) { /* empty: \N{} */
9787 *node_p = reg_node(pRExC_state,NOTHING);
9789 else if (in_char_class) {
9790 if (SIZE_ONLY && in_char_class) {
9791 ckWARNreg(RExC_parse,
9792 "Ignoring zero length \\N{} in character class"
9800 nextchar(pRExC_state);
9804 RExC_uni_semantics = 1; /* Unicode named chars imply Unicode semantics */
9805 RExC_parse += 2; /* Skip past the 'U+' */
9807 endchar = RExC_parse + strcspn(RExC_parse, ".}");
9809 /* Code points are separated by dots. If none, there is only one code
9810 * point, and is terminated by the brace */
9811 has_multiple_chars = (endchar < endbrace);
9813 if (valuep && (! has_multiple_chars || in_char_class)) {
9814 /* We only pay attention to the first char of
9815 multichar strings being returned in char classes. I kinda wonder
9816 if this makes sense as it does change the behaviour
9817 from earlier versions, OTOH that behaviour was broken
9818 as well. XXX Solution is to recharacterize as
9819 [rest-of-class]|multi1|multi2... */
9821 STRLEN length_of_hex = (STRLEN)(endchar - RExC_parse);
9822 I32 grok_hex_flags = PERL_SCAN_ALLOW_UNDERSCORES
9823 | PERL_SCAN_DISALLOW_PREFIX
9824 | (SIZE_ONLY ? PERL_SCAN_SILENT_ILLDIGIT : 0);
9826 *valuep = grok_hex(RExC_parse, &length_of_hex, &grok_hex_flags, NULL);
9828 /* The tokenizer should have guaranteed validity, but it's possible to
9829 * bypass it by using single quoting, so check */
9830 if (length_of_hex == 0
9831 || length_of_hex != (STRLEN)(endchar - RExC_parse) )
9833 RExC_parse += length_of_hex; /* Includes all the valid */
9834 RExC_parse += (RExC_orig_utf8) /* point to after 1st invalid */
9835 ? UTF8SKIP(RExC_parse)
9837 /* Guard against malformed utf8 */
9838 if (RExC_parse >= endchar) {
9839 RExC_parse = endchar;
9841 vFAIL("Invalid hexadecimal number in \\N{U+...}");
9844 if (in_char_class && has_multiple_chars) {
9845 ckWARNreg(endchar, "Using just the first character returned by \\N{} in character class");
9848 RExC_parse = endbrace + 1;
9850 else if (! node_p || ! has_multiple_chars) {
9852 /* Here, the input is legal, but not according to the caller's
9853 * options. We fail without advancing the parse, so that the
9854 * caller can try again */
9860 /* What is done here is to convert this to a sub-pattern of the form
9861 * (?:\x{char1}\x{char2}...)
9862 * and then call reg recursively. That way, it retains its atomicness,
9863 * while not having to worry about special handling that some code
9864 * points may have. toke.c has converted the original Unicode values
9865 * to native, so that we can just pass on the hex values unchanged. We
9866 * do have to set a flag to keep recoding from happening in the
9869 SV * substitute_parse = newSVpvn_flags("?:", 2, SVf_UTF8|SVs_TEMP);
9871 char *orig_end = RExC_end;
9874 while (RExC_parse < endbrace) {
9876 /* Convert to notation the rest of the code understands */
9877 sv_catpv(substitute_parse, "\\x{");
9878 sv_catpvn(substitute_parse, RExC_parse, endchar - RExC_parse);
9879 sv_catpv(substitute_parse, "}");
9881 /* Point to the beginning of the next character in the sequence. */
9882 RExC_parse = endchar + 1;
9883 endchar = RExC_parse + strcspn(RExC_parse, ".}");
9885 sv_catpv(substitute_parse, ")");
9887 RExC_parse = SvPV(substitute_parse, len);
9889 /* Don't allow empty number */
9891 vFAIL("Invalid hexadecimal number in \\N{U+...}");
9893 RExC_end = RExC_parse + len;
9895 /* The values are Unicode, and therefore not subject to recoding */
9896 RExC_override_recoding = 1;
9898 *node_p = reg(pRExC_state, 1, &flags, depth+1);
9899 *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
9901 RExC_parse = endbrace;
9902 RExC_end = orig_end;
9903 RExC_override_recoding = 0;
9905 nextchar(pRExC_state);
9915 * It returns the code point in utf8 for the value in *encp.
9916 * value: a code value in the source encoding
9917 * encp: a pointer to an Encode object
9919 * If the result from Encode is not a single character,
9920 * it returns U+FFFD (Replacement character) and sets *encp to NULL.
9923 S_reg_recode(pTHX_ const char value, SV **encp)
9926 SV * const sv = newSVpvn_flags(&value, numlen, SVs_TEMP);
9927 const char * const s = *encp ? sv_recode_to_utf8(sv, *encp) : SvPVX(sv);
9928 const STRLEN newlen = SvCUR(sv);
9929 UV uv = UNICODE_REPLACEMENT;
9931 PERL_ARGS_ASSERT_REG_RECODE;
9935 ? utf8n_to_uvchr((U8*)s, newlen, &numlen, UTF8_ALLOW_DEFAULT)
9938 if (!newlen || numlen != newlen) {
9939 uv = UNICODE_REPLACEMENT;
9945 PERL_STATIC_INLINE U8
9946 S_compute_EXACTish(pTHX_ RExC_state_t *pRExC_state)
9950 PERL_ARGS_ASSERT_COMPUTE_EXACTISH;
9956 op = get_regex_charset(RExC_flags);
9957 if (op >= REGEX_ASCII_RESTRICTED_CHARSET) {
9958 op--; /* /a is same as /u, and map /aa's offset to what /a's would have
9959 been, so there is no hole */
9965 PERL_STATIC_INLINE void
9966 S_alloc_maybe_populate_EXACT(pTHX_ RExC_state_t *pRExC_state, regnode *node, I32* flagp, STRLEN len, UV code_point)
9968 /* This knows the details about sizing an EXACTish node, setting flags for
9969 * it (by setting <*flagp>, and potentially populating it with a single
9972 * If <len> (the length in bytes) is non-zero, this function assumes that
9973 * the node has already been populated, and just does the sizing. In this
9974 * case <code_point> should be the final code point that has already been
9975 * placed into the node. This value will be ignored except that under some
9976 * circumstances <*flagp> is set based on it.
9978 * If <len> is zero, the function assumes that the node is to contain only
9979 * the single character given by <code_point> and calculates what <len>
9980 * should be. In pass 1, it sizes the node appropriately. In pass 2, it
9981 * additionally will populate the node's STRING with <code_point>, if <len>
9982 * is 0. In both cases <*flagp> is appropriately set
9984 * It knows that under FOLD, UTF characters and the Latin Sharp S must be
9985 * folded (the latter only when the rules indicate it can match 'ss') */
9987 bool len_passed_in = cBOOL(len != 0);
9988 U8 character[UTF8_MAXBYTES_CASE+1];
9990 PERL_ARGS_ASSERT_ALLOC_MAYBE_POPULATE_EXACT;
9992 if (! len_passed_in) {
9995 to_uni_fold(NATIVE_TO_UNI(code_point), character, &len);
9998 uvchr_to_utf8( character, code_point);
9999 len = UTF8SKIP(character);
10003 || code_point != LATIN_SMALL_LETTER_SHARP_S
10004 || ASCII_FOLD_RESTRICTED
10005 || ! AT_LEAST_UNI_SEMANTICS)
10007 *character = (U8) code_point;
10012 *(character + 1) = 's';
10018 RExC_size += STR_SZ(len);
10021 RExC_emit += STR_SZ(len);
10022 STR_LEN(node) = len;
10023 if (! len_passed_in) {
10024 Copy((char *) character, STRING(node), len, char);
10028 *flagp |= HASWIDTH;
10030 /* A single character node is SIMPLE, except for the special-cased SHARP S
10032 if ((len == 1 || (UTF && len == UNISKIP(code_point)))
10033 && (code_point != LATIN_SMALL_LETTER_SHARP_S
10034 || ! FOLD || ! DEPENDS_SEMANTICS))
10041 - regatom - the lowest level
10043 Try to identify anything special at the start of the pattern. If there
10044 is, then handle it as required. This may involve generating a single regop,
10045 such as for an assertion; or it may involve recursing, such as to
10046 handle a () structure.
10048 If the string doesn't start with something special then we gobble up
10049 as much literal text as we can.
10051 Once we have been able to handle whatever type of thing started the
10052 sequence, we return.
10054 Note: we have to be careful with escapes, as they can be both literal
10055 and special, and in the case of \10 and friends, context determines which.
10057 A summary of the code structure is:
10059 switch (first_byte) {
10060 cases for each special:
10061 handle this special;
10064 switch (2nd byte) {
10065 cases for each unambiguous special:
10066 handle this special;
10068 cases for each ambigous special/literal:
10070 if (special) handle here
10072 default: // unambiguously literal:
10075 default: // is a literal char
10078 create EXACTish node for literal;
10079 while (more input and node isn't full) {
10080 switch (input_byte) {
10081 cases for each special;
10082 make sure parse pointer is set so that the next call to
10083 regatom will see this special first
10084 goto loopdone; // EXACTish node terminated by prev. char
10086 append char to EXACTISH node;
10088 get next input byte;
10092 return the generated node;
10094 Specifically there are two separate switches for handling
10095 escape sequences, with the one for handling literal escapes requiring
10096 a dummy entry for all of the special escapes that are actually handled
10101 S_regatom(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
10104 regnode *ret = NULL;
10106 char *parse_start = RExC_parse;
10108 GET_RE_DEBUG_FLAGS_DECL;
10109 DEBUG_PARSE("atom");
10110 *flagp = WORST; /* Tentatively. */
10112 PERL_ARGS_ASSERT_REGATOM;
10115 switch ((U8)*RExC_parse) {
10117 RExC_seen_zerolen++;
10118 nextchar(pRExC_state);
10119 if (RExC_flags & RXf_PMf_MULTILINE)
10120 ret = reg_node(pRExC_state, MBOL);
10121 else if (RExC_flags & RXf_PMf_SINGLELINE)
10122 ret = reg_node(pRExC_state, SBOL);
10124 ret = reg_node(pRExC_state, BOL);
10125 Set_Node_Length(ret, 1); /* MJD */
10128 nextchar(pRExC_state);
10130 RExC_seen_zerolen++;
10131 if (RExC_flags & RXf_PMf_MULTILINE)
10132 ret = reg_node(pRExC_state, MEOL);
10133 else if (RExC_flags & RXf_PMf_SINGLELINE)
10134 ret = reg_node(pRExC_state, SEOL);
10136 ret = reg_node(pRExC_state, EOL);
10137 Set_Node_Length(ret, 1); /* MJD */
10140 nextchar(pRExC_state);
10141 if (RExC_flags & RXf_PMf_SINGLELINE)
10142 ret = reg_node(pRExC_state, SANY);
10144 ret = reg_node(pRExC_state, REG_ANY);
10145 *flagp |= HASWIDTH|SIMPLE;
10147 Set_Node_Length(ret, 1); /* MJD */
10151 char * const oregcomp_parse = ++RExC_parse;
10152 ret = regclass(pRExC_state, flagp,depth+1);
10153 if (*RExC_parse != ']') {
10154 RExC_parse = oregcomp_parse;
10155 vFAIL("Unmatched [");
10157 nextchar(pRExC_state);
10158 Set_Node_Length(ret, RExC_parse - oregcomp_parse + 1); /* MJD */
10162 nextchar(pRExC_state);
10163 ret = reg(pRExC_state, 1, &flags,depth+1);
10165 if (flags & TRYAGAIN) {
10166 if (RExC_parse == RExC_end) {
10167 /* Make parent create an empty node if needed. */
10168 *flagp |= TRYAGAIN;
10175 *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
10179 if (flags & TRYAGAIN) {
10180 *flagp |= TRYAGAIN;
10183 vFAIL("Internal urp");
10184 /* Supposed to be caught earlier. */
10190 vFAIL("Quantifier follows nothing");
10195 This switch handles escape sequences that resolve to some kind
10196 of special regop and not to literal text. Escape sequnces that
10197 resolve to literal text are handled below in the switch marked
10200 Every entry in this switch *must* have a corresponding entry
10201 in the literal escape switch. However, the opposite is not
10202 required, as the default for this switch is to jump to the
10203 literal text handling code.
10205 switch ((U8)*++RExC_parse) {
10206 /* Special Escapes */
10208 RExC_seen_zerolen++;
10209 ret = reg_node(pRExC_state, SBOL);
10211 goto finish_meta_pat;
10213 ret = reg_node(pRExC_state, GPOS);
10214 RExC_seen |= REG_SEEN_GPOS;
10216 goto finish_meta_pat;
10218 RExC_seen_zerolen++;
10219 ret = reg_node(pRExC_state, KEEPS);
10221 /* XXX:dmq : disabling in-place substitution seems to
10222 * be necessary here to avoid cases of memory corruption, as
10223 * with: C<$_="x" x 80; s/x\K/y/> -- rgs
10225 RExC_seen |= REG_SEEN_LOOKBEHIND;
10226 goto finish_meta_pat;
10228 ret = reg_node(pRExC_state, SEOL);
10230 RExC_seen_zerolen++; /* Do not optimize RE away */
10231 goto finish_meta_pat;
10233 ret = reg_node(pRExC_state, EOS);
10235 RExC_seen_zerolen++; /* Do not optimize RE away */
10236 goto finish_meta_pat;
10238 ret = reg_node(pRExC_state, CANY);
10239 RExC_seen |= REG_SEEN_CANY;
10240 *flagp |= HASWIDTH|SIMPLE;
10241 goto finish_meta_pat;
10243 ret = reg_node(pRExC_state, CLUMP);
10244 *flagp |= HASWIDTH;
10245 goto finish_meta_pat;
10247 op = ALNUM + get_regex_charset(RExC_flags);
10248 if (op > ALNUMA) { /* /aa is same as /a */
10251 ret = reg_node(pRExC_state, op);
10252 *flagp |= HASWIDTH|SIMPLE;
10253 goto finish_meta_pat;
10255 op = NALNUM + get_regex_charset(RExC_flags);
10256 if (op > NALNUMA) { /* /aa is same as /a */
10259 ret = reg_node(pRExC_state, op);
10260 *flagp |= HASWIDTH|SIMPLE;
10261 goto finish_meta_pat;
10263 RExC_seen_zerolen++;
10264 RExC_seen |= REG_SEEN_LOOKBEHIND;
10265 op = BOUND + get_regex_charset(RExC_flags);
10266 if (op > BOUNDA) { /* /aa is same as /a */
10269 ret = reg_node(pRExC_state, op);
10270 FLAGS(ret) = get_regex_charset(RExC_flags);
10272 goto finish_meta_pat;
10274 RExC_seen_zerolen++;
10275 RExC_seen |= REG_SEEN_LOOKBEHIND;
10276 op = NBOUND + get_regex_charset(RExC_flags);
10277 if (op > NBOUNDA) { /* /aa is same as /a */
10280 ret = reg_node(pRExC_state, op);
10281 FLAGS(ret) = get_regex_charset(RExC_flags);
10283 goto finish_meta_pat;
10285 op = SPACE + get_regex_charset(RExC_flags);
10286 if (op > SPACEA) { /* /aa is same as /a */
10289 ret = reg_node(pRExC_state, op);
10290 *flagp |= HASWIDTH|SIMPLE;
10291 goto finish_meta_pat;
10293 op = NSPACE + get_regex_charset(RExC_flags);
10294 if (op > NSPACEA) { /* /aa is same as /a */
10297 ret = reg_node(pRExC_state, op);
10298 *flagp |= HASWIDTH|SIMPLE;
10299 goto finish_meta_pat;
10307 U8 offset = get_regex_charset(RExC_flags);
10308 if (offset == REGEX_UNICODE_CHARSET) {
10309 offset = REGEX_DEPENDS_CHARSET;
10311 else if (offset == REGEX_ASCII_MORE_RESTRICTED_CHARSET) {
10312 offset = REGEX_ASCII_RESTRICTED_CHARSET;
10316 ret = reg_node(pRExC_state, op);
10317 *flagp |= HASWIDTH|SIMPLE;
10318 goto finish_meta_pat;
10320 ret = reg_node(pRExC_state, LNBREAK);
10321 *flagp |= HASWIDTH|SIMPLE;
10322 goto finish_meta_pat;
10324 ret = reg_node(pRExC_state, HORIZWS);
10325 *flagp |= HASWIDTH|SIMPLE;
10326 goto finish_meta_pat;
10328 ret = reg_node(pRExC_state, NHORIZWS);
10329 *flagp |= HASWIDTH|SIMPLE;
10330 goto finish_meta_pat;
10332 ret = reg_node(pRExC_state, VERTWS);
10333 *flagp |= HASWIDTH|SIMPLE;
10334 goto finish_meta_pat;
10336 ret = reg_node(pRExC_state, NVERTWS);
10337 *flagp |= HASWIDTH|SIMPLE;
10339 nextchar(pRExC_state);
10340 Set_Node_Length(ret, 2); /* MJD */
10345 char* const oldregxend = RExC_end;
10347 char* parse_start = RExC_parse - 2;
10350 if (RExC_parse[1] == '{') {
10351 /* a lovely hack--pretend we saw [\pX] instead */
10352 RExC_end = strchr(RExC_parse, '}');
10354 const U8 c = (U8)*RExC_parse;
10356 RExC_end = oldregxend;
10357 vFAIL2("Missing right brace on \\%c{}", c);
10362 RExC_end = RExC_parse + 2;
10363 if (RExC_end > oldregxend)
10364 RExC_end = oldregxend;
10368 ret = regclass(pRExC_state, flagp,depth+1);
10370 RExC_end = oldregxend;
10373 Set_Node_Offset(ret, parse_start + 2);
10374 Set_Node_Cur_Length(ret);
10375 nextchar(pRExC_state);
10379 /* Handle \N and \N{NAME} with multiple code points here and not
10380 * below because it can be multicharacter. join_exact() will join
10381 * them up later on. Also this makes sure that things like
10382 * /\N{BLAH}+/ and \N{BLAH} being multi char Just Happen. dmq.
10383 * The options to the grok function call causes it to fail if the
10384 * sequence is just a single code point. We then go treat it as
10385 * just another character in the current EXACT node, and hence it
10386 * gets uniform treatment with all the other characters. The
10387 * special treatment for quantifiers is not needed for such single
10388 * character sequences */
10390 if (! grok_bslash_N(pRExC_state, &ret, NULL, flagp, depth, FALSE)) {
10395 case 'k': /* Handle \k<NAME> and \k'NAME' */
10398 char ch= RExC_parse[1];
10399 if (ch != '<' && ch != '\'' && ch != '{') {
10401 vFAIL2("Sequence %.2s... not terminated",parse_start);
10403 /* this pretty much dupes the code for (?P=...) in reg(), if
10404 you change this make sure you change that */
10405 char* name_start = (RExC_parse += 2);
10407 SV *sv_dat = reg_scan_name(pRExC_state,
10408 SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
10409 ch= (ch == '<') ? '>' : (ch == '{') ? '}' : '\'';
10410 if (RExC_parse == name_start || *RExC_parse != ch)
10411 vFAIL2("Sequence %.3s... not terminated",parse_start);
10414 num = add_data( pRExC_state, 1, "S" );
10415 RExC_rxi->data->data[num]=(void*)sv_dat;
10416 SvREFCNT_inc_simple_void(sv_dat);
10420 ret = reganode(pRExC_state,
10423 : (ASCII_FOLD_RESTRICTED)
10425 : (AT_LEAST_UNI_SEMANTICS)
10431 *flagp |= HASWIDTH;
10433 /* override incorrect value set in reganode MJD */
10434 Set_Node_Offset(ret, parse_start+1);
10435 Set_Node_Cur_Length(ret); /* MJD */
10436 nextchar(pRExC_state);
10442 case '1': case '2': case '3': case '4':
10443 case '5': case '6': case '7': case '8': case '9':
10446 bool isg = *RExC_parse == 'g';
10451 if (*RExC_parse == '{') {
10455 if (*RExC_parse == '-') {
10459 if (hasbrace && !isDIGIT(*RExC_parse)) {
10460 if (isrel) RExC_parse--;
10462 goto parse_named_seq;
10464 num = atoi(RExC_parse);
10465 if (isg && num == 0)
10466 vFAIL("Reference to invalid group 0");
10468 num = RExC_npar - num;
10470 vFAIL("Reference to nonexistent or unclosed group");
10472 if (!isg && num > 9 && num >= RExC_npar)
10473 /* Probably a character specified in octal, e.g. \35 */
10476 char * const parse_start = RExC_parse - 1; /* MJD */
10477 while (isDIGIT(*RExC_parse))
10479 if (parse_start == RExC_parse - 1)
10480 vFAIL("Unterminated \\g... pattern");
10482 if (*RExC_parse != '}')
10483 vFAIL("Unterminated \\g{...} pattern");
10487 if (num > (I32)RExC_rx->nparens)
10488 vFAIL("Reference to nonexistent group");
10491 ret = reganode(pRExC_state,
10494 : (ASCII_FOLD_RESTRICTED)
10496 : (AT_LEAST_UNI_SEMANTICS)
10502 *flagp |= HASWIDTH;
10504 /* override incorrect value set in reganode MJD */
10505 Set_Node_Offset(ret, parse_start+1);
10506 Set_Node_Cur_Length(ret); /* MJD */
10508 nextchar(pRExC_state);
10513 if (RExC_parse >= RExC_end)
10514 FAIL("Trailing \\");
10517 /* Do not generate "unrecognized" warnings here, we fall
10518 back into the quick-grab loop below */
10525 if (RExC_flags & RXf_PMf_EXTENDED) {
10526 if ( reg_skipcomment( pRExC_state ) )
10533 parse_start = RExC_parse - 1;
10542 #define MAX_NODE_STRING_SIZE 127
10543 char foldbuf[MAX_NODE_STRING_SIZE+UTF8_MAXBYTES_CASE];
10545 U8 upper_parse = MAX_NODE_STRING_SIZE;
10548 bool next_is_quantifier;
10549 char * oldp = NULL;
10551 /* If a folding node contains only code points that don't
10552 * participate in folds, it can be changed into an EXACT node,
10553 * which allows the optimizer more things to look for */
10557 node_type = compute_EXACTish(pRExC_state);
10558 ret = reg_node(pRExC_state, node_type);
10560 /* In pass1, folded, we use a temporary buffer instead of the
10561 * actual node, as the node doesn't exist yet */
10562 s = (SIZE_ONLY && FOLD) ? foldbuf : STRING(ret);
10568 /* We do the EXACTFish to EXACT node only if folding, and not if in
10569 * locale, as whether a character folds or not isn't known until
10571 maybe_exact = FOLD && ! LOC;
10573 /* XXX The node can hold up to 255 bytes, yet this only goes to
10574 * 127. I (khw) do not know why. Keeping it somewhat less than
10575 * 255 allows us to not have to worry about overflow due to
10576 * converting to utf8 and fold expansion, but that value is
10577 * 255-UTF8_MAXBYTES_CASE. join_exact() may join adjacent nodes
10578 * split up by this limit into a single one using the real max of
10579 * 255. Even at 127, this breaks under rare circumstances. If
10580 * folding, we do not want to split a node at a character that is a
10581 * non-final in a multi-char fold, as an input string could just
10582 * happen to want to match across the node boundary. The join
10583 * would solve that problem if the join actually happens. But a
10584 * series of more than two nodes in a row each of 127 would cause
10585 * the first join to succeed to get to 254, but then there wouldn't
10586 * be room for the next one, which could at be one of those split
10587 * multi-char folds. I don't know of any fool-proof solution. One
10588 * could back off to end with only a code point that isn't such a
10589 * non-final, but it is possible for there not to be any in the
10591 for (p = RExC_parse - 1;
10592 len < upper_parse && p < RExC_end;
10597 if (RExC_flags & RXf_PMf_EXTENDED)
10598 p = regwhite( pRExC_state, p );
10609 /* Literal Escapes Switch
10611 This switch is meant to handle escape sequences that
10612 resolve to a literal character.
10614 Every escape sequence that represents something
10615 else, like an assertion or a char class, is handled
10616 in the switch marked 'Special Escapes' above in this
10617 routine, but also has an entry here as anything that
10618 isn't explicitly mentioned here will be treated as
10619 an unescaped equivalent literal.
10622 switch ((U8)*++p) {
10623 /* These are all the special escapes. */
10624 case 'A': /* Start assertion */
10625 case 'b': case 'B': /* Word-boundary assertion*/
10626 case 'C': /* Single char !DANGEROUS! */
10627 case 'd': case 'D': /* digit class */
10628 case 'g': case 'G': /* generic-backref, pos assertion */
10629 case 'h': case 'H': /* HORIZWS */
10630 case 'k': case 'K': /* named backref, keep marker */
10631 case 'p': case 'P': /* Unicode property */
10632 case 'R': /* LNBREAK */
10633 case 's': case 'S': /* space class */
10634 case 'v': case 'V': /* VERTWS */
10635 case 'w': case 'W': /* word class */
10636 case 'X': /* eXtended Unicode "combining character sequence" */
10637 case 'z': case 'Z': /* End of line/string assertion */
10641 /* Anything after here is an escape that resolves to a
10642 literal. (Except digits, which may or may not)
10648 case 'N': /* Handle a single-code point named character. */
10649 /* The options cause it to fail if a multiple code
10650 * point sequence. Handle those in the switch() above
10652 RExC_parse = p + 1;
10653 if (! grok_bslash_N(pRExC_state, NULL, &ender,
10654 flagp, depth, FALSE))
10656 RExC_parse = p = oldp;
10660 if (ender > 0xff) {
10677 ender = ASCII_TO_NATIVE('\033');
10681 ender = ASCII_TO_NATIVE('\007');
10686 STRLEN brace_len = len;
10688 const char* error_msg;
10690 bool valid = grok_bslash_o(p,
10697 RExC_parse = p; /* going to die anyway; point
10698 to exact spot of failure */
10705 if (PL_encoding && ender < 0x100) {
10706 goto recode_encoding;
10708 if (ender > 0xff) {
10715 STRLEN brace_len = len;
10717 const char* error_msg;
10719 bool valid = grok_bslash_x(p,
10726 RExC_parse = p; /* going to die anyway; point
10727 to exact spot of failure */
10733 if (PL_encoding && ender < 0x100) {
10734 goto recode_encoding;
10736 if (ender > 0xff) {
10743 ender = grok_bslash_c(*p++, UTF, SIZE_ONLY);
10745 case '0': case '1': case '2': case '3':case '4':
10746 case '5': case '6': case '7':
10748 (isDIGIT(p[1]) && atoi(p) >= RExC_npar))
10750 I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
10752 ender = grok_oct(p, &numlen, &flags, NULL);
10753 if (ender > 0xff) {
10762 if (PL_encoding && ender < 0x100)
10763 goto recode_encoding;
10766 if (! RExC_override_recoding) {
10767 SV* enc = PL_encoding;
10768 ender = reg_recode((const char)(U8)ender, &enc);
10769 if (!enc && SIZE_ONLY)
10770 ckWARNreg(p, "Invalid escape in the specified encoding");
10776 FAIL("Trailing \\");
10779 if (!SIZE_ONLY&& isALNUMC(*p)) {
10780 ckWARN2reg(p + 1, "Unrecognized escape \\%.1s passed through", p);
10782 goto normal_default;
10786 /* Currently we don't warn when the lbrace is at the start
10787 * of a construct. This catches it in the middle of a
10788 * literal string, or when its the first thing after
10789 * something like "\b" */
10791 && (len || (p > RExC_start && isALPHA_A(*(p -1)))))
10793 ckWARNregdep(p + 1, "Unescaped left brace in regex is deprecated, passed through");
10798 if (UTF8_IS_START(*p) && UTF) {
10800 ender = utf8n_to_uvchr((U8*)p, RExC_end - p,
10801 &numlen, UTF8_ALLOW_DEFAULT);
10807 } /* End of switch on the literal */
10809 /* Here, have looked at the literal character and <ender>
10810 * contains its ordinal, <p> points to the character after it
10813 if ( RExC_flags & RXf_PMf_EXTENDED)
10814 p = regwhite( pRExC_state, p );
10816 /* If the next thing is a quantifier, it applies to this
10817 * character only, which means that this character has to be in
10818 * its own node and can't just be appended to the string in an
10819 * existing node, so if there are already other characters in
10820 * the node, close the node with just them, and set up to do
10821 * this character again next time through, when it will be the
10822 * only thing in its new node */
10823 if ((next_is_quantifier = (p < RExC_end && ISMULT2(p))) && len)
10831 /* See comments for join_exact() as to why we fold
10832 * this non-UTF at compile time */
10833 || (node_type == EXACTFU
10834 && ender == LATIN_SMALL_LETTER_SHARP_S))
10838 /* Prime the casefolded buffer. Locale rules, which
10839 * apply only to code points < 256, aren't known until
10840 * execution, so for them, just output the original
10841 * character using utf8. If we start to fold non-UTF
10842 * patterns, be sure to update join_exact() */
10843 if (LOC && ender < 256) {
10844 if (UNI_IS_INVARIANT(ender)) {
10848 *s = UTF8_TWO_BYTE_HI(ender);
10849 *(s + 1) = UTF8_TWO_BYTE_LO(ender);
10854 UV folded = _to_uni_fold_flags(
10859 | ((LOC) ? FOLD_FLAGS_LOCALE
10860 : (ASCII_FOLD_RESTRICTED)
10861 ? FOLD_FLAGS_NOMIX_ASCII
10865 /* If this node only contains non-folding code
10866 * points so far, see if this new one is also
10869 if (folded != ender) {
10870 maybe_exact = FALSE;
10873 /* Here the fold is the original; we have
10874 * to check further to see if anything
10876 if (! PL_utf8_foldable) {
10877 SV* swash = swash_init("utf8",
10879 &PL_sv_undef, 1, 0);
10881 _get_swash_invlist(swash);
10882 SvREFCNT_dec(swash);
10884 if (_invlist_contains_cp(PL_utf8_foldable,
10887 maybe_exact = FALSE;
10895 /* The loop increments <len> each time, as all but this
10896 * path (and the one just below for UTF) through it add
10897 * a single byte to the EXACTish node. But this one
10898 * has changed len to be the correct final value, so
10899 * subtract one to cancel out the increment that
10901 len += foldlen - 1;
10905 maybe_exact &= ! IS_IN_SOME_FOLD_L1(ender);
10909 const STRLEN unilen = reguni(pRExC_state, ender, s);
10915 /* See comment just above for - 1 */
10919 REGC((char)ender, s++);
10922 if (next_is_quantifier) {
10924 /* Here, the next input is a quantifier, and to get here,
10925 * the current character is the only one in the node.
10926 * Also, here <len> doesn't include the final byte for this
10932 } /* End of loop through literal characters */
10934 /* Here we have either exhausted the input or ran out of room in
10935 * the node. (If we encountered a character that can't be in the
10936 * node, transfer is made directly to <loopdone>, and so we
10937 * wouldn't have fallen off the end of the loop.) In the latter
10938 * case, we artificially have to split the node into two, because
10939 * we just don't have enough space to hold everything. This
10940 * creates a problem if the final character participates in a
10941 * multi-character fold in the non-final position, as a match that
10942 * should have occurred won't, due to the way nodes are matched,
10943 * and our artificial boundary. So back off until we find a non-
10944 * problematic character -- one that isn't at the beginning or
10945 * middle of such a fold. (Either it doesn't participate in any
10946 * folds, or appears only in the final position of all the folds it
10947 * does participate in.) A better solution with far fewer false
10948 * positives, and that would fill the nodes more completely, would
10949 * be to actually have available all the multi-character folds to
10950 * test against, and to back-off only far enough to be sure that
10951 * this node isn't ending with a partial one. <upper_parse> is set
10952 * further below (if we need to reparse the node) to include just
10953 * up through that final non-problematic character that this code
10954 * identifies, so when it is set to less than the full node, we can
10955 * skip the rest of this */
10956 if (FOLD && p < RExC_end && upper_parse == MAX_NODE_STRING_SIZE) {
10958 const STRLEN full_len = len;
10960 assert(len >= MAX_NODE_STRING_SIZE);
10962 /* Here, <s> points to the final byte of the final character.
10963 * Look backwards through the string until find a non-
10964 * problematic character */
10968 /* These two have no multi-char folds to non-UTF characters
10970 if (ASCII_FOLD_RESTRICTED || LOC) {
10974 while (--s >= s0 && IS_NON_FINAL_FOLD(*s)) { }
10978 if (! PL_NonL1NonFinalFold) {
10979 PL_NonL1NonFinalFold = _new_invlist_C_array(
10980 NonL1_Perl_Non_Final_Folds_invlist);
10983 /* Point to the first byte of the final character */
10984 s = (char *) utf8_hop((U8 *) s, -1);
10986 while (s >= s0) { /* Search backwards until find
10987 non-problematic char */
10988 if (UTF8_IS_INVARIANT(*s)) {
10990 /* There are no ascii characters that participate
10991 * in multi-char folds under /aa. In EBCDIC, the
10992 * non-ascii invariants are all control characters,
10993 * so don't ever participate in any folds. */
10994 if (ASCII_FOLD_RESTRICTED
10995 || ! IS_NON_FINAL_FOLD(*s))
11000 else if (UTF8_IS_DOWNGRADEABLE_START(*s)) {
11002 /* No Latin1 characters participate in multi-char
11003 * folds under /l */
11005 || ! IS_NON_FINAL_FOLD(TWO_BYTE_UTF8_TO_UNI(
11011 else if (! _invlist_contains_cp(
11012 PL_NonL1NonFinalFold,
11013 valid_utf8_to_uvchr((U8 *) s, NULL)))
11018 /* Here, the current character is problematic in that
11019 * it does occur in the non-final position of some
11020 * fold, so try the character before it, but have to
11021 * special case the very first byte in the string, so
11022 * we don't read outside the string */
11023 s = (s == s0) ? s -1 : (char *) utf8_hop((U8 *) s, -1);
11024 } /* End of loop backwards through the string */
11026 /* If there were only problematic characters in the string,
11027 * <s> will point to before s0, in which case the length
11028 * should be 0, otherwise include the length of the
11029 * non-problematic character just found */
11030 len = (s < s0) ? 0 : s - s0 + UTF8SKIP(s);
11033 /* Here, have found the final character, if any, that is
11034 * non-problematic as far as ending the node without splitting
11035 * it across a potential multi-char fold. <len> contains the
11036 * number of bytes in the node up-to and including that
11037 * character, or is 0 if there is no such character, meaning
11038 * the whole node contains only problematic characters. In
11039 * this case, give up and just take the node as-is. We can't
11045 /* Here, the node does contain some characters that aren't
11046 * problematic. If one such is the final character in the
11047 * node, we are done */
11048 if (len == full_len) {
11051 else if (len + ((UTF) ? UTF8SKIP(s) : 1) == full_len) {
11053 /* If the final character is problematic, but the
11054 * penultimate is not, back-off that last character to
11055 * later start a new node with it */
11060 /* Here, the final non-problematic character is earlier
11061 * in the input than the penultimate character. What we do
11062 * is reparse from the beginning, going up only as far as
11063 * this final ok one, thus guaranteeing that the node ends
11064 * in an acceptable character. The reason we reparse is
11065 * that we know how far in the character is, but we don't
11066 * know how to correlate its position with the input parse.
11067 * An alternate implementation would be to build that
11068 * correlation as we go along during the original parse,
11069 * but that would entail extra work for every node, whereas
11070 * this code gets executed only when the string is too
11071 * large for the node, and the final two characters are
11072 * problematic, an infrequent occurrence. Yet another
11073 * possible strategy would be to save the tail of the
11074 * string, and the next time regatom is called, initialize
11075 * with that. The problem with this is that unless you
11076 * back off one more character, you won't be guaranteed
11077 * regatom will get called again, unless regbranch,
11078 * regpiece ... are also changed. If you do back off that
11079 * extra character, so that there is input guaranteed to
11080 * force calling regatom, you can't handle the case where
11081 * just the first character in the node is acceptable. I
11082 * (khw) decided to try this method which doesn't have that
11083 * pitfall; if performance issues are found, we can do a
11084 * combination of the current approach plus that one */
11090 } /* End of verifying node ends with an appropriate char */
11092 loopdone: /* Jumped to when encounters something that shouldn't be in
11095 /* If 'maybe_exact' is still set here, means there are no
11096 * code points in the node that participate in folds */
11097 if (FOLD && maybe_exact) {
11101 /* I (khw) don't know if you can get here with zero length, but the
11102 * old code handled this situation by creating a zero-length EXACT
11103 * node. Might as well be NOTHING instead */
11108 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, len, ender);
11111 RExC_parse = p - 1;
11112 Set_Node_Cur_Length(ret); /* MJD */
11113 nextchar(pRExC_state);
11115 /* len is STRLEN which is unsigned, need to copy to signed */
11118 vFAIL("Internal disaster");
11121 } /* End of label 'defchar:' */
11123 } /* End of giant switch on input character */
11129 S_regwhite( RExC_state_t *pRExC_state, char *p )
11131 const char *e = RExC_end;
11133 PERL_ARGS_ASSERT_REGWHITE;
11138 else if (*p == '#') {
11141 if (*p++ == '\n') {
11147 RExC_seen |= REG_SEEN_RUN_ON_COMMENT;
11155 /* Parse POSIX character classes: [[:foo:]], [[=foo=]], [[.foo.]].
11156 Character classes ([:foo:]) can also be negated ([:^foo:]).
11157 Returns a named class id (ANYOF_XXX) if successful, -1 otherwise.
11158 Equivalence classes ([=foo=]) and composites ([.foo.]) are parsed,
11159 but trigger failures because they are currently unimplemented. */
11161 #define POSIXCC_DONE(c) ((c) == ':')
11162 #define POSIXCC_NOTYET(c) ((c) == '=' || (c) == '.')
11163 #define POSIXCC(c) (POSIXCC_DONE(c) || POSIXCC_NOTYET(c))
11166 S_regpposixcc(pTHX_ RExC_state_t *pRExC_state, I32 value)
11169 I32 namedclass = OOB_NAMEDCLASS;
11171 PERL_ARGS_ASSERT_REGPPOSIXCC;
11173 if (value == '[' && RExC_parse + 1 < RExC_end &&
11174 /* I smell either [: or [= or [. -- POSIX has been here, right? */
11175 POSIXCC(UCHARAT(RExC_parse))) {
11176 const char c = UCHARAT(RExC_parse);
11177 char* const s = RExC_parse++;
11179 while (RExC_parse < RExC_end && UCHARAT(RExC_parse) != c)
11181 if (RExC_parse == RExC_end)
11182 /* Grandfather lone [:, [=, [. */
11185 const char* const t = RExC_parse++; /* skip over the c */
11188 if (UCHARAT(RExC_parse) == ']') {
11189 const char *posixcc = s + 1;
11190 RExC_parse++; /* skip over the ending ] */
11193 const I32 complement = *posixcc == '^' ? *posixcc++ : 0;
11194 const I32 skip = t - posixcc;
11196 /* Initially switch on the length of the name. */
11199 if (memEQ(posixcc, "word", 4)) /* this is not POSIX, this is the Perl \w */
11200 namedclass = ANYOF_WORDCHAR;
11203 /* Names all of length 5. */
11204 /* alnum alpha ascii blank cntrl digit graph lower
11205 print punct space upper */
11206 /* Offset 4 gives the best switch position. */
11207 switch (posixcc[4]) {
11209 if (memEQ(posixcc, "alph", 4)) /* alpha */
11210 namedclass = ANYOF_ALPHA;
11213 if (memEQ(posixcc, "spac", 4)) /* space */
11214 namedclass = ANYOF_PSXSPC;
11217 if (memEQ(posixcc, "grap", 4)) /* graph */
11218 namedclass = ANYOF_GRAPH;
11221 if (memEQ(posixcc, "asci", 4)) /* ascii */
11222 namedclass = ANYOF_ASCII;
11225 if (memEQ(posixcc, "blan", 4)) /* blank */
11226 namedclass = ANYOF_BLANK;
11229 if (memEQ(posixcc, "cntr", 4)) /* cntrl */
11230 namedclass = ANYOF_CNTRL;
11233 if (memEQ(posixcc, "alnu", 4)) /* alnum */
11234 namedclass = ANYOF_ALNUMC;
11237 if (memEQ(posixcc, "lowe", 4)) /* lower */
11238 namedclass = ANYOF_LOWER;
11239 else if (memEQ(posixcc, "uppe", 4)) /* upper */
11240 namedclass = ANYOF_UPPER;
11243 if (memEQ(posixcc, "digi", 4)) /* digit */
11244 namedclass = ANYOF_DIGIT;
11245 else if (memEQ(posixcc, "prin", 4)) /* print */
11246 namedclass = ANYOF_PRINT;
11247 else if (memEQ(posixcc, "punc", 4)) /* punct */
11248 namedclass = ANYOF_PUNCT;
11253 if (memEQ(posixcc, "xdigit", 6))
11254 namedclass = ANYOF_XDIGIT;
11258 if (namedclass == OOB_NAMEDCLASS)
11259 Simple_vFAIL3("POSIX class [:%.*s:] unknown",
11262 /* The #defines are structured so each complement is +1 to
11263 * the normal one */
11267 assert (posixcc[skip] == ':');
11268 assert (posixcc[skip+1] == ']');
11269 } else if (!SIZE_ONLY) {
11270 /* [[=foo=]] and [[.foo.]] are still future. */
11272 /* adjust RExC_parse so the warning shows after
11273 the class closes */
11274 while (UCHARAT(RExC_parse) && UCHARAT(RExC_parse) != ']')
11276 Simple_vFAIL3("POSIX syntax [%c %c] is reserved for future extensions", c, c);
11279 /* Maternal grandfather:
11280 * "[:" ending in ":" but not in ":]" */
11290 S_checkposixcc(pTHX_ RExC_state_t *pRExC_state)
11294 PERL_ARGS_ASSERT_CHECKPOSIXCC;
11296 if (POSIXCC(UCHARAT(RExC_parse))) {
11297 const char *s = RExC_parse;
11298 const char c = *s++;
11300 while (isALNUM(*s))
11302 if (*s && c == *s && s[1] == ']') {
11304 "POSIX syntax [%c %c] belongs inside character classes",
11307 /* [[=foo=]] and [[.foo.]] are still future. */
11308 if (POSIXCC_NOTYET(c)) {
11309 /* adjust RExC_parse so the error shows after
11310 the class closes */
11311 while (UCHARAT(RExC_parse) && UCHARAT(RExC_parse++) != ']')
11313 Simple_vFAIL3("POSIX syntax [%c %c] is reserved for future extensions", c, c);
11319 /* Generate the code to add a full posix character <class> to the bracketed
11320 * character class given by <node>. (<node> is needed only under locale rules)
11321 * destlist is the inversion list for non-locale rules that this class is
11323 * sourcelist is the ASCII-range inversion list to add under /a rules
11324 * Xsourcelist is the full Unicode range list to use otherwise. */
11325 #define DO_POSIX(node, class, destlist, sourcelist, Xsourcelist) \
11327 SV* scratch_list = NULL; \
11329 /* Set this class in the node for runtime matching */ \
11330 ANYOF_CLASS_SET(node, class); \
11332 /* For above Latin1 code points, we use the full Unicode range */ \
11333 _invlist_intersection(PL_AboveLatin1, \
11336 /* And set the output to it, adding instead if there already is an \
11337 * output. Checking if <destlist> is NULL first saves an extra \
11338 * clone. Its reference count will be decremented at the next \
11339 * union, etc, or if this is the only instance, at the end of the \
11341 if (! destlist) { \
11342 destlist = scratch_list; \
11345 _invlist_union(destlist, scratch_list, &destlist); \
11346 SvREFCNT_dec(scratch_list); \
11350 /* For non-locale, just add it to any existing list */ \
11351 _invlist_union(destlist, \
11352 (AT_LEAST_ASCII_RESTRICTED) \
11358 /* Like DO_POSIX, but matches the complement of <sourcelist> and <Xsourcelist>.
11360 #define DO_N_POSIX(node, class, destlist, sourcelist, Xsourcelist) \
11362 SV* scratch_list = NULL; \
11363 ANYOF_CLASS_SET(node, class); \
11364 _invlist_subtract(PL_AboveLatin1, Xsourcelist, &scratch_list); \
11365 if (! destlist) { \
11366 destlist = scratch_list; \
11369 _invlist_union(destlist, scratch_list, &destlist); \
11370 SvREFCNT_dec(scratch_list); \
11374 _invlist_union_complement_2nd(destlist, \
11375 (AT_LEAST_ASCII_RESTRICTED) \
11379 /* Under /d, everything in the upper half of the Latin1 range \
11380 * matches this complement */ \
11381 if (DEPENDS_SEMANTICS) { \
11382 ANYOF_FLAGS(node) |= ANYOF_NON_UTF8_LATIN1_ALL; \
11386 /* Generate the code to add a posix character <class> to the bracketed
11387 * character class given by <node>. (<node> is needed only under locale rules)
11388 * destlist is the inversion list for non-locale rules that this class is
11390 * sourcelist is the ASCII-range inversion list to add under /a rules
11391 * l1_sourcelist is the Latin1 range list to use otherwise.
11392 * Xpropertyname is the name to add to <run_time_list> of the property to
11393 * specify the code points above Latin1 that will have to be
11394 * determined at run-time
11395 * run_time_list is a SV* that contains text names of properties that are to
11396 * be computed at run time. This concatenates <Xpropertyname>
11397 * to it, appropriately
11398 * This is essentially DO_POSIX, but we know only the Latin1 values at compile
11400 #define DO_POSIX_LATIN1_ONLY_KNOWN(node, class, destlist, sourcelist, \
11401 l1_sourcelist, Xpropertyname, run_time_list) \
11402 /* First, resolve whether to use the ASCII-only list or the L1 \
11404 DO_POSIX_LATIN1_ONLY_KNOWN_L1_RESOLVED(node, class, destlist, \
11405 ((AT_LEAST_ASCII_RESTRICTED) ? sourcelist : l1_sourcelist),\
11406 Xpropertyname, run_time_list)
11408 #define DO_POSIX_LATIN1_ONLY_KNOWN_L1_RESOLVED(node, class, destlist, sourcelist, \
11409 Xpropertyname, run_time_list) \
11410 /* If not /a matching, there are going to be code points we will have \
11411 * to defer to runtime to look-up */ \
11412 if (! AT_LEAST_ASCII_RESTRICTED) { \
11413 Perl_sv_catpvf(aTHX_ run_time_list, "+utf8::%s\n", Xpropertyname); \
11416 ANYOF_CLASS_SET(node, class); \
11419 _invlist_union(destlist, sourcelist, &destlist); \
11422 /* Like DO_POSIX_LATIN1_ONLY_KNOWN, but for the complement. A combination of
11423 * this and DO_N_POSIX. Sets <matches_above_unicode> only if it can; unchanged
11425 #define DO_N_POSIX_LATIN1_ONLY_KNOWN(node, class, destlist, sourcelist, \
11426 l1_sourcelist, Xpropertyname, run_time_list, matches_above_unicode) \
11427 if (AT_LEAST_ASCII_RESTRICTED) { \
11428 _invlist_union_complement_2nd(destlist, sourcelist, &destlist); \
11431 Perl_sv_catpvf(aTHX_ run_time_list, "!utf8::%s\n", Xpropertyname); \
11432 matches_above_unicode = TRUE; \
11434 ANYOF_CLASS_SET(node, namedclass); \
11437 SV* scratch_list = NULL; \
11438 _invlist_subtract(PL_Latin1, l1_sourcelist, &scratch_list); \
11439 if (! destlist) { \
11440 destlist = scratch_list; \
11443 _invlist_union(destlist, scratch_list, &destlist); \
11444 SvREFCNT_dec(scratch_list); \
11446 if (DEPENDS_SEMANTICS) { \
11447 ANYOF_FLAGS(node) |= ANYOF_NON_UTF8_LATIN1_ALL; \
11452 /* The names of properties whose definitions are not known at compile time are
11453 * stored in this SV, after a constant heading. So if the length has been
11454 * changed since initialization, then there is a run-time definition. */
11455 #define HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION (SvCUR(listsv) != initial_listsv_len)
11457 /* This converts the named class defined in regcomp.h to its equivalent class
11458 * number defined in handy.h. */
11459 #define namedclass_to_classnum(class) ((class) / 2)
11462 S_regclass(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
11464 /* parse a bracketed class specification. Most of these will produce an ANYOF node;
11465 * but something like [a] will produce an EXACT node; [aA], an EXACTFish
11466 * node; [[:ascii:]], a POSIXA node; etc. It is more complex under /i with
11467 * multi-character folds: it will be rewritten following the paradigm of
11468 * this example, where the <multi-fold>s are characters which fold to
11469 * multiple character sequences:
11470 * /[abc\x{multi-fold1}def\x{multi-fold2}ghi]/i
11471 * gets effectively rewritten as:
11472 * /(?:\x{multi-fold1}|\x{multi-fold2}|[abcdefghi]/i
11473 * reg() gets called (recursively) on the rewritten version, and this
11474 * function will return what it constructs. (Actually the <multi-fold>s
11475 * aren't physically removed from the [abcdefghi], it's just that they are
11476 * ignored in the recursion by means of a flag:
11477 * <RExC_in_multi_char_class>.)
11479 * ANYOF nodes contain a bit map for the first 256 characters, with the
11480 * corresponding bit set if that character is in the list. For characters
11481 * above 255, a range list or swash is used. There are extra bits for \w,
11482 * etc. in locale ANYOFs, as what these match is not determinable at
11487 UV prevvalue = OOB_UNICODE, save_prevvalue = OOB_UNICODE;
11489 UV value = OOB_UNICODE, save_value = OOB_UNICODE;
11492 IV namedclass = OOB_NAMEDCLASS;
11493 char *rangebegin = NULL;
11494 bool need_class = 0;
11496 STRLEN initial_listsv_len = 0; /* Kind of a kludge to see if it is more
11497 than just initialized. */
11498 SV* properties = NULL; /* Code points that match \p{} \P{} */
11499 SV* posixes = NULL; /* Code points that match classes like, [:word:],
11500 extended beyond the Latin1 range */
11501 UV element_count = 0; /* Number of distinct elements in the class.
11502 Optimizations may be possible if this is tiny */
11503 AV * multi_char_matches = NULL; /* Code points that fold to more than one
11504 character; used under /i */
11507 /* Unicode properties are stored in a swash; this holds the current one
11508 * being parsed. If this swash is the only above-latin1 component of the
11509 * character class, an optimization is to pass it directly on to the
11510 * execution engine. Otherwise, it is set to NULL to indicate that there
11511 * are other things in the class that have to be dealt with at execution
11513 SV* swash = NULL; /* Code points that match \p{} \P{} */
11515 /* Set if a component of this character class is user-defined; just passed
11516 * on to the engine */
11517 bool has_user_defined_property = FALSE;
11519 /* inversion list of code points this node matches only when the target
11520 * string is in UTF-8. (Because is under /d) */
11521 SV* depends_list = NULL;
11523 /* inversion list of code points this node matches. For much of the
11524 * function, it includes only those that match regardless of the utf8ness
11525 * of the target string */
11526 SV* cp_list = NULL;
11529 /* In a range, counts how many 0-2 of the ends of it came from literals,
11530 * not escapes. Thus we can tell if 'A' was input vs \x{C1} */
11531 UV literal_endpoint = 0;
11533 bool invert = FALSE; /* Is this class to be complemented */
11535 /* Is there any thing like \W or [:^digit:] that matches above the legal
11536 * Unicode range? */
11537 bool runtime_posix_matches_above_Unicode = FALSE;
11539 regnode * const orig_emit = RExC_emit; /* Save the original RExC_emit in
11540 case we need to change the emitted regop to an EXACT. */
11541 const char * orig_parse = RExC_parse;
11542 const I32 orig_size = RExC_size;
11543 GET_RE_DEBUG_FLAGS_DECL;
11545 PERL_ARGS_ASSERT_REGCLASS;
11547 PERL_UNUSED_ARG(depth);
11550 DEBUG_PARSE("clas");
11552 /* Assume we are going to generate an ANYOF node. */
11553 ret = reganode(pRExC_state, ANYOF, 0);
11556 ANYOF_FLAGS(ret) = 0;
11559 if (UCHARAT(RExC_parse) == '^') { /* Complement of range. */
11566 RExC_size += ANYOF_SKIP;
11567 listsv = &PL_sv_undef; /* For code scanners: listsv always non-NULL. */
11570 RExC_emit += ANYOF_SKIP;
11572 ANYOF_FLAGS(ret) |= ANYOF_LOCALE;
11574 listsv = newSVpvs("# comment\n");
11575 initial_listsv_len = SvCUR(listsv);
11578 nextvalue = RExC_parse < RExC_end ? UCHARAT(RExC_parse) : 0;
11580 if (!SIZE_ONLY && POSIXCC(nextvalue))
11581 checkposixcc(pRExC_state);
11583 /* allow 1st char to be ] (allowing it to be - is dealt with later) */
11584 if (UCHARAT(RExC_parse) == ']')
11585 goto charclassloop;
11588 while (RExC_parse < RExC_end && UCHARAT(RExC_parse) != ']') {
11592 namedclass = OOB_NAMEDCLASS; /* initialize as illegal */
11593 save_value = value;
11594 save_prevvalue = prevvalue;
11597 rangebegin = RExC_parse;
11601 value = utf8n_to_uvchr((U8*)RExC_parse,
11602 RExC_end - RExC_parse,
11603 &numlen, UTF8_ALLOW_DEFAULT);
11604 RExC_parse += numlen;
11607 value = UCHARAT(RExC_parse++);
11609 nextvalue = RExC_parse < RExC_end ? UCHARAT(RExC_parse) : 0;
11610 if (value == '[' && POSIXCC(nextvalue))
11611 namedclass = regpposixcc(pRExC_state, value);
11612 else if (value == '\\') {
11614 value = utf8n_to_uvchr((U8*)RExC_parse,
11615 RExC_end - RExC_parse,
11616 &numlen, UTF8_ALLOW_DEFAULT);
11617 RExC_parse += numlen;
11620 value = UCHARAT(RExC_parse++);
11621 /* Some compilers cannot handle switching on 64-bit integer
11622 * values, therefore value cannot be an UV. Yes, this will
11623 * be a problem later if we want switch on Unicode.
11624 * A similar issue a little bit later when switching on
11625 * namedclass. --jhi */
11626 switch ((I32)value) {
11627 case 'w': namedclass = ANYOF_WORDCHAR; break;
11628 case 'W': namedclass = ANYOF_NWORDCHAR; break;
11629 case 's': namedclass = ANYOF_SPACE; break;
11630 case 'S': namedclass = ANYOF_NSPACE; break;
11631 case 'd': namedclass = ANYOF_DIGIT; break;
11632 case 'D': namedclass = ANYOF_NDIGIT; break;
11633 case 'v': namedclass = ANYOF_VERTWS; break;
11634 case 'V': namedclass = ANYOF_NVERTWS; break;
11635 case 'h': namedclass = ANYOF_HORIZWS; break;
11636 case 'H': namedclass = ANYOF_NHORIZWS; break;
11637 case 'N': /* Handle \N{NAME} in class */
11639 /* We only pay attention to the first char of
11640 multichar strings being returned. I kinda wonder
11641 if this makes sense as it does change the behaviour
11642 from earlier versions, OTOH that behaviour was broken
11644 if (! grok_bslash_N(pRExC_state, NULL, &value, flagp, depth,
11645 TRUE /* => charclass */))
11656 /* This routine will handle any undefined properties */
11657 U8 swash_init_flags = _CORE_SWASH_INIT_RETURN_IF_UNDEF;
11659 if (RExC_parse >= RExC_end)
11660 vFAIL2("Empty \\%c{}", (U8)value);
11661 if (*RExC_parse == '{') {
11662 const U8 c = (U8)value;
11663 e = strchr(RExC_parse++, '}');
11665 vFAIL2("Missing right brace on \\%c{}", c);
11666 while (isSPACE(UCHARAT(RExC_parse)))
11668 if (e == RExC_parse)
11669 vFAIL2("Empty \\%c{}", c);
11670 n = e - RExC_parse;
11671 while (isSPACE(UCHARAT(RExC_parse + n - 1)))
11682 if (UCHARAT(RExC_parse) == '^') {
11685 value = value == 'p' ? 'P' : 'p'; /* toggle */
11686 while (isSPACE(UCHARAT(RExC_parse))) {
11691 /* Try to get the definition of the property into
11692 * <invlist>. If /i is in effect, the effective property
11693 * will have its name be <__NAME_i>. The design is
11694 * discussed in commit
11695 * 2f833f5208e26b208886e51e09e2c072b5eabb46 */
11696 Newx(name, n + sizeof("_i__\n"), char);
11698 sprintf(name, "%s%.*s%s\n",
11699 (FOLD) ? "__" : "",
11705 /* Look up the property name, and get its swash and
11706 * inversion list, if the property is found */
11708 SvREFCNT_dec(swash);
11710 swash = _core_swash_init("utf8", name, &PL_sv_undef,
11713 NULL, /* No inversion list */
11716 if (! swash || ! (invlist = _get_swash_invlist(swash))) {
11718 SvREFCNT_dec(swash);
11722 /* Here didn't find it. It could be a user-defined
11723 * property that will be available at run-time. Add it
11724 * to the list to look up then */
11725 Perl_sv_catpvf(aTHX_ listsv, "%cutf8::%s\n",
11726 (value == 'p' ? '+' : '!'),
11728 has_user_defined_property = TRUE;
11730 /* We don't know yet, so have to assume that the
11731 * property could match something in the Latin1 range,
11732 * hence something that isn't utf8. Note that this
11733 * would cause things in <depends_list> to match
11734 * inappropriately, except that any \p{}, including
11735 * this one forces Unicode semantics, which means there
11736 * is <no depends_list> */
11737 ANYOF_FLAGS(ret) |= ANYOF_NONBITMAP_NON_UTF8;
11741 /* Here, did get the swash and its inversion list. If
11742 * the swash is from a user-defined property, then this
11743 * whole character class should be regarded as such */
11744 has_user_defined_property =
11746 & _CORE_SWASH_INIT_USER_DEFINED_PROPERTY);
11748 /* Invert if asking for the complement */
11749 if (value == 'P') {
11750 _invlist_union_complement_2nd(properties,
11754 /* The swash can't be used as-is, because we've
11755 * inverted things; delay removing it to here after
11756 * have copied its invlist above */
11757 SvREFCNT_dec(swash);
11761 _invlist_union(properties, invlist, &properties);
11766 RExC_parse = e + 1;
11767 namedclass = ANYOF_MAX; /* no official name, but it's named */
11769 /* \p means they want Unicode semantics */
11770 RExC_uni_semantics = 1;
11773 case 'n': value = '\n'; break;
11774 case 'r': value = '\r'; break;
11775 case 't': value = '\t'; break;
11776 case 'f': value = '\f'; break;
11777 case 'b': value = '\b'; break;
11778 case 'e': value = ASCII_TO_NATIVE('\033');break;
11779 case 'a': value = ASCII_TO_NATIVE('\007');break;
11781 RExC_parse--; /* function expects to be pointed at the 'o' */
11783 const char* error_msg;
11784 bool valid = grok_bslash_o(RExC_parse,
11789 RExC_parse += numlen;
11794 if (PL_encoding && value < 0x100) {
11795 goto recode_encoding;
11799 RExC_parse--; /* function expects to be pointed at the 'x' */
11801 const char* error_msg;
11802 bool valid = grok_bslash_x(RExC_parse,
11807 RExC_parse += numlen;
11812 if (PL_encoding && value < 0x100)
11813 goto recode_encoding;
11816 value = grok_bslash_c(*RExC_parse++, UTF, SIZE_ONLY);
11818 case '0': case '1': case '2': case '3': case '4':
11819 case '5': case '6': case '7':
11821 /* Take 1-3 octal digits */
11822 I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
11824 value = grok_oct(--RExC_parse, &numlen, &flags, NULL);
11825 RExC_parse += numlen;
11826 if (PL_encoding && value < 0x100)
11827 goto recode_encoding;
11831 if (! RExC_override_recoding) {
11832 SV* enc = PL_encoding;
11833 value = reg_recode((const char)(U8)value, &enc);
11834 if (!enc && SIZE_ONLY)
11835 ckWARNreg(RExC_parse,
11836 "Invalid escape in the specified encoding");
11840 /* Allow \_ to not give an error */
11841 if (!SIZE_ONLY && isALNUM(value) && value != '_') {
11842 ckWARN2reg(RExC_parse,
11843 "Unrecognized escape \\%c in character class passed through",
11848 } /* end of \blah */
11851 literal_endpoint++;
11854 /* What matches in a locale is not known until runtime. This
11855 * includes what the Posix classes (like \w, [:space:]) match.
11856 * Room must be reserved (one time per class) to store such
11857 * classes, either if Perl is compiled so that locale nodes always
11858 * should have this space, or if there is such class info to be
11859 * stored. The space will contain a bit for each named class that
11860 * is to be matched against. This isn't needed for \p{} and
11861 * pseudo-classes, as they are not affected by locale, and hence
11862 * are dealt with separately */
11865 && (ANYOF_LOCALE == ANYOF_CLASS
11866 || (namedclass > OOB_NAMEDCLASS && namedclass < ANYOF_MAX)))
11870 RExC_size += ANYOF_CLASS_SKIP - ANYOF_SKIP;
11873 RExC_emit += ANYOF_CLASS_SKIP - ANYOF_SKIP;
11874 ANYOF_CLASS_ZERO(ret);
11876 ANYOF_FLAGS(ret) |= ANYOF_CLASS;
11879 if (namedclass > OOB_NAMEDCLASS) { /* this is a named class \blah */
11881 /* a bad range like a-\d, a-[:digit:]. The '-' is taken as a
11882 * literal, as is the character that began the false range, i.e.
11883 * the 'a' in the examples */
11887 RExC_parse >= rangebegin ?
11888 RExC_parse - rangebegin : 0;
11889 ckWARN4reg(RExC_parse,
11890 "False [] range \"%*.*s\"",
11892 cp_list = add_cp_to_invlist(cp_list, '-');
11893 cp_list = add_cp_to_invlist(cp_list, prevvalue);
11896 range = 0; /* this was not a true range */
11897 element_count += 2; /* So counts for three values */
11901 switch ((I32)namedclass) {
11903 case ANYOF_ALNUMC: /* C's alnum, in contrast to \w */
11904 DO_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, posixes,
11905 PL_PosixAlnum, PL_L1PosixAlnum, "XPosixAlnum", listsv);
11907 case ANYOF_NALNUMC:
11908 DO_N_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, posixes,
11909 PL_PosixAlnum, PL_L1PosixAlnum, "XPosixAlnum", listsv,
11910 runtime_posix_matches_above_Unicode);
11913 DO_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, posixes,
11914 PL_PosixAlpha, PL_L1PosixAlpha, "XPosixAlpha", listsv);
11917 DO_N_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, posixes,
11918 PL_PosixAlpha, PL_L1PosixAlpha, "XPosixAlpha", listsv,
11919 runtime_posix_matches_above_Unicode);
11924 ANYOF_CLASS_SET(ret, namedclass);
11927 #endif /* Not isascii(); just use the hard-coded definition for it */
11928 _invlist_union(posixes, PL_ASCII, &posixes);
11933 ANYOF_CLASS_SET(ret, namedclass);
11937 _invlist_union_complement_2nd(posixes,
11938 PL_ASCII, &posixes);
11939 if (DEPENDS_SEMANTICS) {
11940 ANYOF_FLAGS(ret) |= ANYOF_NON_UTF8_LATIN1_ALL;
11947 if (hasISBLANK || ! LOC) {
11948 DO_POSIX(ret, namedclass, posixes,
11949 PL_PosixBlank, PL_XPosixBlank);
11951 else { /* There is no isblank() and we are in locale: We
11952 use the ASCII range and the above-Latin1 range
11954 SV* scratch_list = NULL;
11956 /* Include all above-Latin1 blanks */
11957 _invlist_intersection(PL_AboveLatin1,
11960 /* Add it to the running total of posix classes */
11962 posixes = scratch_list;
11965 _invlist_union(posixes, scratch_list, &posixes);
11966 SvREFCNT_dec(scratch_list);
11968 /* Add the ASCII-range blanks to the running total. */
11969 _invlist_union(posixes, PL_PosixBlank, &posixes);
11973 if (hasISBLANK || ! LOC) {
11974 DO_N_POSIX(ret, namedclass, posixes,
11975 PL_PosixBlank, PL_XPosixBlank);
11977 else { /* There is no isblank() and we are in locale */
11978 SV* scratch_list = NULL;
11980 /* Include all above-Latin1 non-blanks */
11981 _invlist_subtract(PL_AboveLatin1, PL_XPosixBlank,
11984 /* Add them to the running total of posix classes */
11985 _invlist_subtract(PL_AboveLatin1, PL_XPosixBlank,
11988 posixes = scratch_list;
11991 _invlist_union(posixes, scratch_list, &posixes);
11992 SvREFCNT_dec(scratch_list);
11995 /* Get the list of all non-ASCII-blanks in Latin 1, and
11996 * add them to the running total */
11997 _invlist_subtract(PL_Latin1, PL_PosixBlank,
11999 _invlist_union(posixes, scratch_list, &posixes);
12000 SvREFCNT_dec(scratch_list);
12004 DO_POSIX(ret, namedclass, posixes,
12005 PL_PosixCntrl, PL_XPosixCntrl);
12008 DO_N_POSIX(ret, namedclass, posixes,
12009 PL_PosixCntrl, PL_XPosixCntrl);
12012 /* There are no digits in the Latin1 range outside of
12013 * ASCII, so call the macro that doesn't have to resolve
12015 DO_POSIX_LATIN1_ONLY_KNOWN_L1_RESOLVED(ret, namedclass, posixes,
12016 PL_PosixDigit, "XPosixDigit", listsv);
12019 DO_N_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, posixes,
12020 PL_PosixDigit, PL_PosixDigit, "XPosixDigit", listsv,
12021 runtime_posix_matches_above_Unicode);
12024 DO_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, posixes,
12025 PL_PosixGraph, PL_L1PosixGraph, "XPosixGraph", listsv);
12028 DO_N_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, posixes,
12029 PL_PosixGraph, PL_L1PosixGraph, "XPosixGraph", listsv,
12030 runtime_posix_matches_above_Unicode);
12032 case ANYOF_HORIZWS:
12033 /* For these, we use the cp_list, as /d doesn't make a
12034 * difference in what these match. There would be problems
12035 * if these characters had folds other than themselves, as
12036 * cp_list is subject to folding. It turns out that \h
12037 * is just a synonym for XPosixBlank */
12038 _invlist_union(cp_list, PL_XPosixBlank, &cp_list);
12040 case ANYOF_NHORIZWS:
12041 _invlist_union_complement_2nd(cp_list,
12042 PL_XPosixBlank, &cp_list);
12046 { /* These require special handling, as they differ under
12047 folding, matching Cased there (which in the ASCII range
12048 is the same as Alpha */
12054 if (FOLD && ! LOC) {
12055 ascii_source = PL_PosixAlpha;
12056 l1_source = PL_L1Cased;
12060 ascii_source = PL_PosixLower;
12061 l1_source = PL_L1PosixLower;
12062 Xname = "XPosixLower";
12064 if (namedclass == ANYOF_LOWER) {
12065 DO_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, posixes,
12066 ascii_source, l1_source, Xname, listsv);
12069 DO_N_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass,
12070 posixes, ascii_source, l1_source, Xname, listsv,
12071 runtime_posix_matches_above_Unicode);
12076 DO_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, posixes,
12077 PL_PosixPrint, PL_L1PosixPrint, "XPosixPrint", listsv);
12080 DO_N_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, posixes,
12081 PL_PosixPrint, PL_L1PosixPrint, "XPosixPrint", listsv,
12082 runtime_posix_matches_above_Unicode);
12085 DO_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, posixes,
12086 PL_PosixPunct, PL_L1PosixPunct, "XPosixPunct", listsv);
12089 DO_N_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, posixes,
12090 PL_PosixPunct, PL_L1PosixPunct, "XPosixPunct", listsv,
12091 runtime_posix_matches_above_Unicode);
12094 DO_POSIX(ret, namedclass, posixes,
12095 PL_PosixSpace, PL_XPosixSpace);
12097 case ANYOF_NPSXSPC:
12098 DO_N_POSIX(ret, namedclass, posixes,
12099 PL_PosixSpace, PL_XPosixSpace);
12102 DO_POSIX(ret, namedclass, posixes,
12103 PL_PerlSpace, PL_XPerlSpace);
12106 DO_N_POSIX(ret, namedclass, posixes,
12107 PL_PerlSpace, PL_XPerlSpace);
12109 case ANYOF_UPPER: /* Same as LOWER, above */
12116 if (FOLD && ! LOC) {
12117 ascii_source = PL_PosixAlpha;
12118 l1_source = PL_L1Cased;
12122 ascii_source = PL_PosixUpper;
12123 l1_source = PL_L1PosixUpper;
12124 Xname = "XPosixUpper";
12126 if (namedclass == ANYOF_UPPER) {
12127 DO_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, posixes,
12128 ascii_source, l1_source, Xname, listsv);
12131 DO_N_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass,
12132 posixes, ascii_source, l1_source, Xname, listsv,
12133 runtime_posix_matches_above_Unicode);
12137 case ANYOF_WORDCHAR:
12138 DO_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, posixes,
12139 PL_PosixWord, PL_L1PosixWord, "XPosixWord", listsv);
12141 case ANYOF_NWORDCHAR:
12142 DO_N_POSIX_LATIN1_ONLY_KNOWN(ret, namedclass, posixes,
12143 PL_PosixWord, PL_L1PosixWord, "XPosixWord", listsv,
12144 runtime_posix_matches_above_Unicode);
12147 /* For these, we use the cp_list, as /d doesn't make a
12148 * difference in what these match. There would be problems
12149 * if these characters had folds other than themselves, as
12150 * cp_list is subject to folding */
12151 _invlist_union(cp_list, PL_VertSpace, &cp_list);
12153 case ANYOF_NVERTWS:
12154 _invlist_union_complement_2nd(cp_list,
12155 PL_VertSpace, &cp_list);
12158 DO_POSIX(ret, namedclass, posixes,
12159 PL_PosixXDigit, PL_XPosixXDigit);
12161 case ANYOF_NXDIGIT:
12162 DO_N_POSIX(ret, namedclass, posixes,
12163 PL_PosixXDigit, PL_XPosixXDigit);
12166 /* this is to handle \p and \P */
12169 vFAIL("Invalid [::] class");
12173 continue; /* Go get next character */
12175 } /* end of namedclass \blah */
12178 if (prevvalue > value) /* b-a */ {
12179 const int w = RExC_parse - rangebegin;
12180 Simple_vFAIL4("Invalid [] range \"%*.*s\"", w, w, rangebegin);
12181 range = 0; /* not a valid range */
12185 prevvalue = value; /* save the beginning of the potential range */
12186 if (RExC_parse+1 < RExC_end
12187 && *RExC_parse == '-'
12188 && RExC_parse[1] != ']')
12192 /* a bad range like \w-, [:word:]- ? */
12193 if (namedclass > OOB_NAMEDCLASS) {
12194 if (ckWARN(WARN_REGEXP)) {
12196 RExC_parse >= rangebegin ?
12197 RExC_parse - rangebegin : 0;
12199 "False [] range \"%*.*s\"",
12203 cp_list = add_cp_to_invlist(cp_list, '-');
12207 range = 1; /* yeah, it's a range! */
12208 continue; /* but do it the next time */
12212 /* Here, <prevvalue> is the beginning of the range, if any; or <value>
12215 /* non-Latin1 code point implies unicode semantics. Must be set in
12216 * pass1 so is there for the whole of pass 2 */
12218 RExC_uni_semantics = 1;
12221 /* Ready to process either the single value, or the completed range.
12222 * For single-valued non-inverted ranges, we consider the possibility
12223 * of multi-char folds. (We made a conscious decision to not do this
12224 * for the other cases because it can often lead to non-intuitive
12225 * results. For example, you have the peculiar case that:
12226 * "s s" =~ /^[^\xDF]+$/i => Y
12227 * "ss" =~ /^[^\xDF]+$/i => N
12229 * See [perl #89750] */
12230 if (FOLD && ! invert && value == prevvalue) {
12231 if (value == LATIN_SMALL_LETTER_SHARP_S
12232 || (value > 255 && _invlist_contains_cp(PL_HasMultiCharFold,
12235 /* Here <value> is indeed a multi-char fold. Get what it is */
12237 U8 foldbuf[UTF8_MAXBYTES_CASE];
12240 UV folded = _to_uni_fold_flags(
12245 | ((LOC) ? FOLD_FLAGS_LOCALE
12246 : (ASCII_FOLD_RESTRICTED)
12247 ? FOLD_FLAGS_NOMIX_ASCII
12251 /* Here, <folded> should be the first character of the
12252 * multi-char fold of <value>, with <foldbuf> containing the
12253 * whole thing. But, if this fold is not allowed (because of
12254 * the flags), <fold> will be the same as <value>, and should
12255 * be processed like any other character, so skip the special
12257 if (folded != value) {
12259 /* Skip if we are recursed, currently parsing the class
12260 * again. Otherwise add this character to the list of
12261 * multi-char folds. */
12262 if (! RExC_in_multi_char_class) {
12263 AV** this_array_ptr;
12265 STRLEN cp_count = utf8_length(foldbuf,
12266 foldbuf + foldlen);
12267 SV* multi_fold = sv_2mortal(newSVpvn("", 0));
12269 Perl_sv_catpvf(aTHX_ multi_fold, "\\x{%"UVXf"}", value);
12272 if (! multi_char_matches) {
12273 multi_char_matches = newAV();
12276 /* <multi_char_matches> is actually an array of arrays.
12277 * There will be one or two top-level elements: [2],
12278 * and/or [3]. The [2] element is an array, each
12279 * element thereof is a character which folds to two
12280 * characters; likewise for [3]. (Unicode guarantees a
12281 * maximum of 3 characters in any fold.) When we
12282 * rewrite the character class below, we will do so
12283 * such that the longest folds are written first, so
12284 * that it prefers the longest matching strings first.
12285 * This is done even if it turns out that any
12286 * quantifier is non-greedy, out of programmer
12287 * laziness. Tom Christiansen has agreed that this is
12288 * ok. This makes the test for the ligature 'ffi' come
12289 * before the test for 'ff' */
12290 if (av_exists(multi_char_matches, cp_count)) {
12291 this_array_ptr = (AV**) av_fetch(multi_char_matches,
12293 this_array = *this_array_ptr;
12296 this_array = newAV();
12297 av_store(multi_char_matches, cp_count,
12300 av_push(this_array, multi_fold);
12303 /* This element should not be processed further in this
12306 value = save_value;
12307 prevvalue = save_prevvalue;
12313 /* Deal with this element of the class */
12316 cp_list = _add_range_to_invlist(cp_list, prevvalue, value);
12318 UV* this_range = _new_invlist(1);
12319 _append_range_to_invlist(this_range, prevvalue, value);
12321 /* In EBCDIC, the ranges 'A-Z' and 'a-z' are each not contiguous.
12322 * If this range was specified using something like 'i-j', we want
12323 * to include only the 'i' and the 'j', and not anything in
12324 * between, so exclude non-ASCII, non-alphabetics from it.
12325 * However, if the range was specified with something like
12326 * [\x89-\x91] or [\x89-j], all code points within it should be
12327 * included. literal_endpoint==2 means both ends of the range used
12328 * a literal character, not \x{foo} */
12329 if (literal_endpoint == 2
12330 && (prevvalue >= 'a' && value <= 'z')
12331 || (prevvalue >= 'A' && value <= 'Z'))
12333 _invlist_intersection(this_range, PL_ASCII, &this_range, );
12334 _invlist_intersection(this_range, PL_Alpha, &this_range, );
12336 _invlist_union(cp_list, this_range, &cp_list);
12337 literal_endpoint = 0;
12341 range = 0; /* this range (if it was one) is done now */
12342 } /* End of loop through all the text within the brackets */
12344 /* If anything in the class expands to more than one character, we have to
12345 * deal with them by building up a substitute parse string, and recursively
12346 * calling reg() on it, instead of proceeding */
12347 if (multi_char_matches) {
12348 SV * substitute_parse = newSVpvn_flags("?:", 2, SVs_TEMP);
12351 char *save_end = RExC_end;
12352 char *save_parse = RExC_parse;
12353 bool first_time = TRUE; /* First multi-char occurrence doesn't get
12358 #if 0 /* Have decided not to deal with multi-char folds in inverted classes,
12359 because too confusing */
12361 sv_catpv(substitute_parse, "(?:");
12365 /* Look at the longest folds first */
12366 for (cp_count = av_len(multi_char_matches); cp_count > 0; cp_count--) {
12368 if (av_exists(multi_char_matches, cp_count)) {
12369 AV** this_array_ptr;
12372 this_array_ptr = (AV**) av_fetch(multi_char_matches,
12374 while ((this_sequence = av_pop(*this_array_ptr)) !=
12377 if (! first_time) {
12378 sv_catpv(substitute_parse, "|");
12380 first_time = FALSE;
12382 sv_catpv(substitute_parse, SvPVX(this_sequence));
12387 /* If the character class contains anything else besides these
12388 * multi-character folds, have to include it in recursive parsing */
12389 if (element_count) {
12390 sv_catpv(substitute_parse, "|[");
12391 sv_catpvn(substitute_parse, orig_parse, RExC_parse - orig_parse);
12392 sv_catpv(substitute_parse, "]");
12395 sv_catpv(substitute_parse, ")");
12398 /* This is a way to get the parse to skip forward a whole named
12399 * sequence instead of matching the 2nd character when it fails the
12401 sv_catpv(substitute_parse, "(*THEN)(*SKIP)(*FAIL)|.)");
12405 RExC_parse = SvPV(substitute_parse, len);
12406 RExC_end = RExC_parse + len;
12407 RExC_in_multi_char_class = 1;
12408 RExC_emit = (regnode *)orig_emit;
12410 ret = reg(pRExC_state, 1, ®_flags, depth+1);
12412 *flagp |= reg_flags&(HASWIDTH|SIMPLE|SPSTART|POSTPONED);
12414 RExC_parse = save_parse;
12415 RExC_end = save_end;
12416 RExC_in_multi_char_class = 0;
12417 SvREFCNT_dec(multi_char_matches);
12418 SvREFCNT_dec(listsv);
12422 /* If the character class contains only a single element, it may be
12423 * optimizable into another node type which is smaller and runs faster.
12424 * Check if this is the case for this class */
12425 if (element_count == 1) {
12429 if (namedclass > OOB_NAMEDCLASS) { /* this is a named class, like \w or
12430 [:digit:] or \p{foo} */
12432 /* Certain named classes have equivalents that can appear outside a
12433 * character class, e.g. \w, \H. We use these instead of a
12434 * character class. */
12435 switch ((I32)namedclass) {
12438 /* The first group is for node types that depend on the charset
12439 * modifier to the regex. We first calculate the base node
12440 * type, and if it should be inverted */
12442 case ANYOF_NWORDCHAR:
12445 case ANYOF_WORDCHAR:
12447 goto join_charset_classes;
12454 goto join_charset_classes;
12462 join_charset_classes:
12464 /* Now that we have the base node type, we take advantage
12465 * of the enum ordering of the charset modifiers to get the
12466 * exact node type, For example the base SPACE also has
12467 * SPACEL, SPACEU, and SPACEA */
12469 offset = get_regex_charset(RExC_flags);
12471 /* /aa is the same as /a for these */
12472 if (offset == REGEX_ASCII_MORE_RESTRICTED_CHARSET) {
12473 offset = REGEX_ASCII_RESTRICTED_CHARSET;
12475 else if (op == DIGIT && offset == REGEX_UNICODE_CHARSET) {
12476 offset = REGEX_DEPENDS_CHARSET; /* There is no DIGITU */
12481 /* The number of varieties of each of these is the same,
12482 * hence, so is the delta between the normal and
12483 * complemented nodes */
12485 op += NALNUM - ALNUM;
12487 *flagp |= HASWIDTH|SIMPLE;
12490 /* The second group doesn't depend of the charset modifiers.
12491 * We just have normal and complemented */
12492 case ANYOF_NHORIZWS:
12495 case ANYOF_HORIZWS:
12497 op = (invert) ? NHORIZWS : HORIZWS;
12498 *flagp |= HASWIDTH|SIMPLE;
12501 case ANYOF_NVERTWS:
12505 op = (invert) ? NVERTWS : VERTWS;
12506 *flagp |= HASWIDTH|SIMPLE;
12516 if (AT_LEAST_UNI_SEMANTICS && ! AT_LEAST_ASCII_RESTRICTED) {
12521 /* A generic posix class. All the /a ones can be handled
12522 * by the POSIXA opcode. And all are closed under folding
12523 * in the ASCII range, so FOLD doesn't matter */
12524 if (AT_LEAST_ASCII_RESTRICTED
12525 || (! LOC && namedclass == ANYOF_ASCII))
12527 /* The odd numbered ones are the complements of the
12528 * next-lower even number one */
12529 if (namedclass % 2 == 1) {
12533 arg = namedclass_to_classnum(namedclass);
12534 op = (invert) ? NPOSIXA : POSIXA;
12539 else if (value == prevvalue) {
12541 /* Here, the class consists of just a single code point */
12544 if (! LOC && value == '\n') {
12545 op = REG_ANY; /* Optimize [^\n] */
12546 *flagp |= HASWIDTH|SIMPLE;
12550 else if (value < 256 || UTF) {
12552 /* Optimize a single value into an EXACTish node, but not if it
12553 * would require converting the pattern to UTF-8. */
12554 op = compute_EXACTish(pRExC_state);
12556 } /* Otherwise is a range */
12557 else if (! LOC) { /* locale could vary these */
12558 if (prevvalue == '0') {
12559 if (value == '9') {
12560 op = (invert) ? NDIGITA : DIGITA;
12561 *flagp |= HASWIDTH|SIMPLE;
12566 /* Here, we have changed <op> away from its initial value iff we found
12567 * an optimization */
12570 /* Throw away this ANYOF regnode, and emit the calculated one,
12571 * which should correspond to the beginning, not current, state of
12573 const char * cur_parse = RExC_parse;
12574 RExC_parse = (char *)orig_parse;
12578 /* To get locale nodes to not use the full ANYOF size would
12579 * require moving the code above that writes the portions
12580 * of it that aren't in other nodes to after this point.
12581 * e.g. ANYOF_CLASS_SET */
12582 RExC_size = orig_size;
12586 RExC_emit = (regnode *)orig_emit;
12589 ret = reg_node(pRExC_state, op);
12591 if (PL_regkind[op] == POSIXD) {
12595 *flagp |= HASWIDTH|SIMPLE;
12597 else if (PL_regkind[op] == EXACT) {
12598 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, 0, value);
12601 RExC_parse = (char *) cur_parse;
12603 SvREFCNT_dec(posixes);
12604 SvREFCNT_dec(listsv);
12605 SvREFCNT_dec(cp_list);
12612 /****** !SIZE_ONLY (Pass 2) AFTER HERE *********/
12614 /* If folding, we calculate all characters that could fold to or from the
12615 * ones already on the list */
12616 if (FOLD && cp_list) {
12617 UV start, end; /* End points of code point ranges */
12619 SV* fold_intersection = NULL;
12621 /* If the highest code point is within Latin1, we can use the
12622 * compiled-in Alphas list, and not have to go out to disk. This
12623 * yields two false positives, the masculine and feminine oridinal
12624 * indicators, which are weeded out below using the
12625 * IS_IN_SOME_FOLD_L1() macro */
12626 if (invlist_highest(cp_list) < 256) {
12627 _invlist_intersection(PL_L1PosixAlpha, cp_list, &fold_intersection);
12631 /* Here, there are non-Latin1 code points, so we will have to go
12632 * fetch the list of all the characters that participate in folds
12634 if (! PL_utf8_foldable) {
12635 SV* swash = swash_init("utf8", "_Perl_Any_Folds",
12636 &PL_sv_undef, 1, 0);
12637 PL_utf8_foldable = _get_swash_invlist(swash);
12638 SvREFCNT_dec(swash);
12641 /* This is a hash that for a particular fold gives all characters
12642 * that are involved in it */
12643 if (! PL_utf8_foldclosures) {
12645 /* If we were unable to find any folds, then we likely won't be
12646 * able to find the closures. So just create an empty list.
12647 * Folding will effectively be restricted to the non-Unicode
12648 * rules hard-coded into Perl. (This case happens legitimately
12649 * during compilation of Perl itself before the Unicode tables
12650 * are generated) */
12651 if (_invlist_len(PL_utf8_foldable) == 0) {
12652 PL_utf8_foldclosures = newHV();
12655 /* If the folds haven't been read in, call a fold function
12657 if (! PL_utf8_tofold) {
12658 U8 dummy[UTF8_MAXBYTES+1];
12660 /* This string is just a short named one above \xff */
12661 to_utf8_fold((U8*) HYPHEN_UTF8, dummy, NULL);
12662 assert(PL_utf8_tofold); /* Verify that worked */
12664 PL_utf8_foldclosures =
12665 _swash_inversion_hash(PL_utf8_tofold);
12669 /* Only the characters in this class that participate in folds need
12670 * be checked. Get the intersection of this class and all the
12671 * possible characters that are foldable. This can quickly narrow
12672 * down a large class */
12673 _invlist_intersection(PL_utf8_foldable, cp_list,
12674 &fold_intersection);
12677 /* Now look at the foldable characters in this class individually */
12678 invlist_iterinit(fold_intersection);
12679 while (invlist_iternext(fold_intersection, &start, &end)) {
12682 /* Locale folding for Latin1 characters is deferred until runtime */
12683 if (LOC && start < 256) {
12687 /* Look at every character in the range */
12688 for (j = start; j <= end; j++) {
12690 U8 foldbuf[UTF8_MAXBYTES_CASE+1];
12696 /* We have the latin1 folding rules hard-coded here so that
12697 * an innocent-looking character class, like /[ks]/i won't
12698 * have to go out to disk to find the possible matches.
12699 * XXX It would be better to generate these via regen, in
12700 * case a new version of the Unicode standard adds new
12701 * mappings, though that is not really likely, and may be
12702 * caught by the default: case of the switch below. */
12704 if (IS_IN_SOME_FOLD_L1(j)) {
12706 /* ASCII is always matched; non-ASCII is matched only
12707 * under Unicode rules */
12708 if (isASCII(j) || AT_LEAST_UNI_SEMANTICS) {
12710 add_cp_to_invlist(cp_list, PL_fold_latin1[j]);
12714 add_cp_to_invlist(depends_list, PL_fold_latin1[j]);
12718 if (HAS_NONLATIN1_FOLD_CLOSURE(j)
12719 && (! isASCII(j) || ! ASCII_FOLD_RESTRICTED))
12721 /* Certain Latin1 characters have matches outside
12722 * Latin1. To get here, <j> is one of those
12723 * characters. None of these matches is valid for
12724 * ASCII characters under /aa, which is why the 'if'
12725 * just above excludes those. These matches only
12726 * happen when the target string is utf8. The code
12727 * below adds the single fold closures for <j> to the
12728 * inversion list. */
12733 add_cp_to_invlist(cp_list, KELVIN_SIGN);
12737 cp_list = add_cp_to_invlist(cp_list,
12738 LATIN_SMALL_LETTER_LONG_S);
12741 cp_list = add_cp_to_invlist(cp_list,
12742 GREEK_CAPITAL_LETTER_MU);
12743 cp_list = add_cp_to_invlist(cp_list,
12744 GREEK_SMALL_LETTER_MU);
12746 case LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE:
12747 case LATIN_SMALL_LETTER_A_WITH_RING_ABOVE:
12749 add_cp_to_invlist(cp_list, ANGSTROM_SIGN);
12751 case LATIN_SMALL_LETTER_Y_WITH_DIAERESIS:
12752 cp_list = add_cp_to_invlist(cp_list,
12753 LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS);
12755 case LATIN_SMALL_LETTER_SHARP_S:
12756 cp_list = add_cp_to_invlist(cp_list,
12757 LATIN_CAPITAL_LETTER_SHARP_S);
12759 case 'F': case 'f':
12760 case 'I': case 'i':
12761 case 'L': case 'l':
12762 case 'T': case 't':
12763 case 'A': case 'a':
12764 case 'H': case 'h':
12765 case 'J': case 'j':
12766 case 'N': case 'n':
12767 case 'W': case 'w':
12768 case 'Y': case 'y':
12769 /* These all are targets of multi-character
12770 * folds from code points that require UTF8 to
12771 * express, so they can't match unless the
12772 * target string is in UTF-8, so no action here
12773 * is necessary, as regexec.c properly handles
12774 * the general case for UTF-8 matching and
12775 * multi-char folds */
12778 /* Use deprecated warning to increase the
12779 * chances of this being output */
12780 ckWARN2regdep(RExC_parse, "Perl folding rules are not up-to-date for 0x%"UVXf"; please use the perlbug utility to report;", j);
12787 /* Here is an above Latin1 character. We don't have the rules
12788 * hard-coded for it. First, get its fold. This is the simple
12789 * fold, as the multi-character folds have been handled earlier
12790 * and separated out */
12791 _to_uni_fold_flags(j, foldbuf, &foldlen,
12793 ? FOLD_FLAGS_LOCALE
12794 : (ASCII_FOLD_RESTRICTED)
12795 ? FOLD_FLAGS_NOMIX_ASCII
12798 /* Single character fold of above Latin1. Add everything in
12799 * its fold closure to the list that this node should match.
12800 * The fold closures data structure is a hash with the keys
12801 * being the UTF-8 of every character that is folded to, like
12802 * 'k', and the values each an array of all code points that
12803 * fold to its key. e.g. [ 'k', 'K', KELVIN_SIGN ].
12804 * Multi-character folds are not included */
12805 if ((listp = hv_fetch(PL_utf8_foldclosures,
12806 (char *) foldbuf, foldlen, FALSE)))
12808 AV* list = (AV*) *listp;
12810 for (k = 0; k <= av_len(list); k++) {
12811 SV** c_p = av_fetch(list, k, FALSE);
12814 Perl_croak(aTHX_ "panic: invalid PL_utf8_foldclosures structure");
12818 /* /aa doesn't allow folds between ASCII and non-; /l
12819 * doesn't allow them between above and below 256 */
12820 if ((ASCII_FOLD_RESTRICTED
12821 && (isASCII(c) != isASCII(j)))
12822 || (LOC && ((c < 256) != (j < 256))))
12827 /* Folds involving non-ascii Latin1 characters
12828 * under /d are added to a separate list */
12829 if (isASCII(c) || c > 255 || AT_LEAST_UNI_SEMANTICS)
12831 cp_list = add_cp_to_invlist(cp_list, c);
12834 depends_list = add_cp_to_invlist(depends_list, c);
12840 SvREFCNT_dec(fold_intersection);
12843 /* And combine the result (if any) with any inversion list from posix
12844 * classes. The lists are kept separate up to now because we don't want to
12845 * fold the classes (folding of those is automatically handled by the swash
12846 * fetching code) */
12848 if (! DEPENDS_SEMANTICS) {
12850 _invlist_union(cp_list, posixes, &cp_list);
12851 SvREFCNT_dec(posixes);
12858 /* Under /d, we put into a separate list the Latin1 things that
12859 * match only when the target string is utf8 */
12860 SV* nonascii_but_latin1_properties = NULL;
12861 _invlist_intersection(posixes, PL_Latin1,
12862 &nonascii_but_latin1_properties);
12863 _invlist_subtract(nonascii_but_latin1_properties, PL_ASCII,
12864 &nonascii_but_latin1_properties);
12865 _invlist_subtract(posixes, nonascii_but_latin1_properties,
12868 _invlist_union(cp_list, posixes, &cp_list);
12869 SvREFCNT_dec(posixes);
12875 if (depends_list) {
12876 _invlist_union(depends_list, nonascii_but_latin1_properties,
12878 SvREFCNT_dec(nonascii_but_latin1_properties);
12881 depends_list = nonascii_but_latin1_properties;
12886 /* And combine the result (if any) with any inversion list from properties.
12887 * The lists are kept separate up to now so that we can distinguish the two
12888 * in regards to matching above-Unicode. A run-time warning is generated
12889 * if a Unicode property is matched against a non-Unicode code point. But,
12890 * we allow user-defined properties to match anything, without any warning,
12891 * and we also suppress the warning if there is a portion of the character
12892 * class that isn't a Unicode property, and which matches above Unicode, \W
12893 * or [\x{110000}] for example.
12894 * (Note that in this case, unlike the Posix one above, there is no
12895 * <depends_list>, because having a Unicode property forces Unicode
12898 bool warn_super = ! has_user_defined_property;
12901 /* If it matters to the final outcome, see if a non-property
12902 * component of the class matches above Unicode. If so, the
12903 * warning gets suppressed. This is true even if just a single
12904 * such code point is specified, as though not strictly correct if
12905 * another such code point is matched against, the fact that they
12906 * are using above-Unicode code points indicates they should know
12907 * the issues involved */
12909 bool non_prop_matches_above_Unicode =
12910 runtime_posix_matches_above_Unicode
12911 | (invlist_highest(cp_list) > PERL_UNICODE_MAX);
12913 non_prop_matches_above_Unicode =
12914 ! non_prop_matches_above_Unicode;
12916 warn_super = ! non_prop_matches_above_Unicode;
12919 _invlist_union(properties, cp_list, &cp_list);
12920 SvREFCNT_dec(properties);
12923 cp_list = properties;
12927 ANYOF_FLAGS(ret) |= ANYOF_WARN_SUPER;
12931 /* Here, we have calculated what code points should be in the character
12934 * Now we can see about various optimizations. Fold calculation (which we
12935 * did above) needs to take place before inversion. Otherwise /[^k]/i
12936 * would invert to include K, which under /i would match k, which it
12937 * shouldn't. Therefore we can't invert folded locale now, as it won't be
12938 * folded until runtime */
12940 /* Optimize inverted simple patterns (e.g. [^a-z]) when everything is known
12941 * at compile time. Besides not inverting folded locale now, we can't
12942 * invert if there are things such as \w, which aren't known until runtime
12945 && ! (LOC && (FOLD || (ANYOF_FLAGS(ret) & ANYOF_CLASS)))
12947 && ! HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
12949 _invlist_invert(cp_list);
12951 /* Any swash can't be used as-is, because we've inverted things */
12953 SvREFCNT_dec(swash);
12957 /* Clear the invert flag since have just done it here */
12961 /* If we didn't do folding, it's because some information isn't available
12962 * until runtime; set the run-time fold flag for these. (We don't have to
12963 * worry about properties folding, as that is taken care of by the swash
12967 ANYOF_FLAGS(ret) |= ANYOF_LOC_FOLD;
12970 /* Some character classes are equivalent to other nodes. Such nodes take
12971 * up less room and generally fewer operations to execute than ANYOF nodes.
12972 * Above, we checked for and optimized into some such equivalents for
12973 * certain common classes that are easy to test. Getting to this point in
12974 * the code means that the class didn't get optimized there. Since this
12975 * code is only executed in Pass 2, it is too late to save space--it has
12976 * been allocated in Pass 1, and currently isn't given back. But turning
12977 * things into an EXACTish node can allow the optimizer to join it to any
12978 * adjacent such nodes. And if the class is equivalent to things like /./,
12979 * expensive run-time swashes can be avoided. Now that we have more
12980 * complete information, we can find things necessarily missed by the
12981 * earlier code. I (khw) am not sure how much to look for here. It would
12982 * be easy, but perhaps too slow, to check any candidates against all the
12983 * node types they could possibly match using _invlistEQ(). */
12988 && ! (ANYOF_FLAGS(ret) & ANYOF_CLASS)
12989 && ! HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
12992 U8 op = END; /* The optimzation node-type */
12993 const char * cur_parse= RExC_parse;
12995 invlist_iterinit(cp_list);
12996 if (! invlist_iternext(cp_list, &start, &end)) {
12998 /* Here, the list is empty. This happens, for example, when a
12999 * Unicode property is the only thing in the character class, and
13000 * it doesn't match anything. (perluniprops.pod notes such
13003 *flagp |= HASWIDTH|SIMPLE;
13005 else if (start == end) { /* The range is a single code point */
13006 if (! invlist_iternext(cp_list, &start, &end)
13008 /* Don't do this optimization if it would require changing
13009 * the pattern to UTF-8 */
13010 && (start < 256 || UTF))
13012 /* Here, the list contains a single code point. Can optimize
13013 * into an EXACT node */
13022 /* A locale node under folding with one code point can be
13023 * an EXACTFL, as its fold won't be calculated until
13029 /* Here, we are generally folding, but there is only one
13030 * code point to match. If we have to, we use an EXACT
13031 * node, but it would be better for joining with adjacent
13032 * nodes in the optimization pass if we used the same
13033 * EXACTFish node that any such are likely to be. We can
13034 * do this iff the code point doesn't participate in any
13035 * folds. For example, an EXACTF of a colon is the same as
13036 * an EXACT one, since nothing folds to or from a colon. */
13038 if (IS_IN_SOME_FOLD_L1(value)) {
13043 if (! PL_utf8_foldable) {
13044 SV* swash = swash_init("utf8", "_Perl_Any_Folds",
13045 &PL_sv_undef, 1, 0);
13046 PL_utf8_foldable = _get_swash_invlist(swash);
13047 SvREFCNT_dec(swash);
13049 if (_invlist_contains_cp(PL_utf8_foldable, value)) {
13054 /* If we haven't found the node type, above, it means we
13055 * can use the prevailing one */
13057 op = compute_EXACTish(pRExC_state);
13062 else if (start == 0) {
13063 if (end == UV_MAX) {
13065 *flagp |= HASWIDTH|SIMPLE;
13068 else if (end == '\n' - 1
13069 && invlist_iternext(cp_list, &start, &end)
13070 && start == '\n' + 1 && end == UV_MAX)
13073 *flagp |= HASWIDTH|SIMPLE;
13079 RExC_parse = (char *)orig_parse;
13080 RExC_emit = (regnode *)orig_emit;
13082 ret = reg_node(pRExC_state, op);
13084 RExC_parse = (char *)cur_parse;
13086 if (PL_regkind[op] == EXACT) {
13087 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, 0, value);
13090 SvREFCNT_dec(cp_list);
13091 SvREFCNT_dec(listsv);
13096 /* Here, <cp_list> contains all the code points we can determine at
13097 * compile time that match under all conditions. Go through it, and
13098 * for things that belong in the bitmap, put them there, and delete from
13099 * <cp_list>. While we are at it, see if everything above 255 is in the
13100 * list, and if so, set a flag to speed up execution */
13101 ANYOF_BITMAP_ZERO(ret);
13104 /* This gets set if we actually need to modify things */
13105 bool change_invlist = FALSE;
13109 /* Start looking through <cp_list> */
13110 invlist_iterinit(cp_list);
13111 while (invlist_iternext(cp_list, &start, &end)) {
13115 if (end == UV_MAX && start <= 256) {
13116 ANYOF_FLAGS(ret) |= ANYOF_UNICODE_ALL;
13119 /* Quit if are above what we should change */
13124 change_invlist = TRUE;
13126 /* Set all the bits in the range, up to the max that we are doing */
13127 high = (end < 255) ? end : 255;
13128 for (i = start; i <= (int) high; i++) {
13129 if (! ANYOF_BITMAP_TEST(ret, i)) {
13130 ANYOF_BITMAP_SET(ret, i);
13137 /* Done with loop; remove any code points that are in the bitmap from
13139 if (change_invlist) {
13140 _invlist_subtract(cp_list, PL_Latin1, &cp_list);
13143 /* If have completely emptied it, remove it completely */
13144 if (_invlist_len(cp_list) == 0) {
13145 SvREFCNT_dec(cp_list);
13151 ANYOF_FLAGS(ret) |= ANYOF_INVERT;
13154 /* Here, the bitmap has been populated with all the Latin1 code points that
13155 * always match. Can now add to the overall list those that match only
13156 * when the target string is UTF-8 (<depends_list>). */
13157 if (depends_list) {
13159 _invlist_union(cp_list, depends_list, &cp_list);
13160 SvREFCNT_dec(depends_list);
13163 cp_list = depends_list;
13167 /* If there is a swash and more than one element, we can't use the swash in
13168 * the optimization below. */
13169 if (swash && element_count > 1) {
13170 SvREFCNT_dec(swash);
13175 && ! HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
13177 ARG_SET(ret, ANYOF_NONBITMAP_EMPTY);
13178 SvREFCNT_dec(listsv);
13181 /* av[0] stores the character class description in its textual form:
13182 * used later (regexec.c:Perl_regclass_swash()) to initialize the
13183 * appropriate swash, and is also useful for dumping the regnode.
13184 * av[1] if NULL, is a placeholder to later contain the swash computed
13185 * from av[0]. But if no further computation need be done, the
13186 * swash is stored there now.
13187 * av[2] stores the cp_list inversion list for use in addition or
13188 * instead of av[0]; used only if av[1] is NULL
13189 * av[3] is set if any component of the class is from a user-defined
13190 * property; used only if av[1] is NULL */
13191 AV * const av = newAV();
13194 av_store(av, 0, (HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
13196 : (SvREFCNT_dec(listsv), &PL_sv_undef));
13198 av_store(av, 1, swash);
13199 SvREFCNT_dec(cp_list);
13202 av_store(av, 1, NULL);
13204 av_store(av, 2, cp_list);
13205 av_store(av, 3, newSVuv(has_user_defined_property));
13209 rv = newRV_noinc(MUTABLE_SV(av));
13210 n = add_data(pRExC_state, 1, "s");
13211 RExC_rxi->data->data[n] = (void*)rv;
13215 *flagp |= HASWIDTH|SIMPLE;
13218 #undef HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION
13221 /* reg_skipcomment()
13223 Absorbs an /x style # comments from the input stream.
13224 Returns true if there is more text remaining in the stream.
13225 Will set the REG_SEEN_RUN_ON_COMMENT flag if the comment
13226 terminates the pattern without including a newline.
13228 Note its the callers responsibility to ensure that we are
13229 actually in /x mode
13234 S_reg_skipcomment(pTHX_ RExC_state_t *pRExC_state)
13238 PERL_ARGS_ASSERT_REG_SKIPCOMMENT;
13240 while (RExC_parse < RExC_end)
13241 if (*RExC_parse++ == '\n') {
13246 /* we ran off the end of the pattern without ending
13247 the comment, so we have to add an \n when wrapping */
13248 RExC_seen |= REG_SEEN_RUN_ON_COMMENT;
13256 Advances the parse position, and optionally absorbs
13257 "whitespace" from the inputstream.
13259 Without /x "whitespace" means (?#...) style comments only,
13260 with /x this means (?#...) and # comments and whitespace proper.
13262 Returns the RExC_parse point from BEFORE the scan occurs.
13264 This is the /x friendly way of saying RExC_parse++.
13268 S_nextchar(pTHX_ RExC_state_t *pRExC_state)
13270 char* const retval = RExC_parse++;
13272 PERL_ARGS_ASSERT_NEXTCHAR;
13275 if (RExC_end - RExC_parse >= 3
13276 && *RExC_parse == '('
13277 && RExC_parse[1] == '?'
13278 && RExC_parse[2] == '#')
13280 while (*RExC_parse != ')') {
13281 if (RExC_parse == RExC_end)
13282 FAIL("Sequence (?#... not terminated");
13288 if (RExC_flags & RXf_PMf_EXTENDED) {
13289 if (isSPACE(*RExC_parse)) {
13293 else if (*RExC_parse == '#') {
13294 if ( reg_skipcomment( pRExC_state ) )
13303 - reg_node - emit a node
13305 STATIC regnode * /* Location. */
13306 S_reg_node(pTHX_ RExC_state_t *pRExC_state, U8 op)
13310 regnode * const ret = RExC_emit;
13311 GET_RE_DEBUG_FLAGS_DECL;
13313 PERL_ARGS_ASSERT_REG_NODE;
13316 SIZE_ALIGN(RExC_size);
13320 if (RExC_emit >= RExC_emit_bound)
13321 Perl_croak(aTHX_ "panic: reg_node overrun trying to emit %d, %p>=%p",
13322 op, RExC_emit, RExC_emit_bound);
13324 NODE_ALIGN_FILL(ret);
13326 FILL_ADVANCE_NODE(ptr, op);
13327 #ifdef RE_TRACK_PATTERN_OFFSETS
13328 if (RExC_offsets) { /* MJD */
13329 MJD_OFFSET_DEBUG(("%s:%d: (op %s) %s %"UVuf" (len %"UVuf") (max %"UVuf").\n",
13330 "reg_node", __LINE__,
13332 (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0]
13333 ? "Overwriting end of array!\n" : "OK",
13334 (UV)(RExC_emit - RExC_emit_start),
13335 (UV)(RExC_parse - RExC_start),
13336 (UV)RExC_offsets[0]));
13337 Set_Node_Offset(RExC_emit, RExC_parse + (op == END));
13345 - reganode - emit a node with an argument
13347 STATIC regnode * /* Location. */
13348 S_reganode(pTHX_ RExC_state_t *pRExC_state, U8 op, U32 arg)
13352 regnode * const ret = RExC_emit;
13353 GET_RE_DEBUG_FLAGS_DECL;
13355 PERL_ARGS_ASSERT_REGANODE;
13358 SIZE_ALIGN(RExC_size);
13363 assert(2==regarglen[op]+1);
13365 Anything larger than this has to allocate the extra amount.
13366 If we changed this to be:
13368 RExC_size += (1 + regarglen[op]);
13370 then it wouldn't matter. Its not clear what side effect
13371 might come from that so its not done so far.
13376 if (RExC_emit >= RExC_emit_bound)
13377 Perl_croak(aTHX_ "panic: reg_node overrun trying to emit %d, %p>=%p",
13378 op, RExC_emit, RExC_emit_bound);
13380 NODE_ALIGN_FILL(ret);
13382 FILL_ADVANCE_NODE_ARG(ptr, op, arg);
13383 #ifdef RE_TRACK_PATTERN_OFFSETS
13384 if (RExC_offsets) { /* MJD */
13385 MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s %"UVuf" <- %"UVuf" (max %"UVuf").\n",
13389 (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0] ?
13390 "Overwriting end of array!\n" : "OK",
13391 (UV)(RExC_emit - RExC_emit_start),
13392 (UV)(RExC_parse - RExC_start),
13393 (UV)RExC_offsets[0]));
13394 Set_Cur_Node_Offset;
13402 - reguni - emit (if appropriate) a Unicode character
13405 S_reguni(pTHX_ const RExC_state_t *pRExC_state, UV uv, char* s)
13409 PERL_ARGS_ASSERT_REGUNI;
13411 return SIZE_ONLY ? UNISKIP(uv) : (uvchr_to_utf8((U8*)s, uv) - (U8*)s);
13415 - reginsert - insert an operator in front of already-emitted operand
13417 * Means relocating the operand.
13420 S_reginsert(pTHX_ RExC_state_t *pRExC_state, U8 op, regnode *opnd, U32 depth)
13426 const int offset = regarglen[(U8)op];
13427 const int size = NODE_STEP_REGNODE + offset;
13428 GET_RE_DEBUG_FLAGS_DECL;
13430 PERL_ARGS_ASSERT_REGINSERT;
13431 PERL_UNUSED_ARG(depth);
13432 /* (PL_regkind[(U8)op] == CURLY ? EXTRA_STEP_2ARGS : 0); */
13433 DEBUG_PARSE_FMT("inst"," - %s",PL_reg_name[op]);
13442 if (RExC_open_parens) {
13444 /*DEBUG_PARSE_FMT("inst"," - %"IVdf, (IV)RExC_npar);*/
13445 for ( paren=0 ; paren < RExC_npar ; paren++ ) {
13446 if ( RExC_open_parens[paren] >= opnd ) {
13447 /*DEBUG_PARSE_FMT("open"," - %d",size);*/
13448 RExC_open_parens[paren] += size;
13450 /*DEBUG_PARSE_FMT("open"," - %s","ok");*/
13452 if ( RExC_close_parens[paren] >= opnd ) {
13453 /*DEBUG_PARSE_FMT("close"," - %d",size);*/
13454 RExC_close_parens[paren] += size;
13456 /*DEBUG_PARSE_FMT("close"," - %s","ok");*/
13461 while (src > opnd) {
13462 StructCopy(--src, --dst, regnode);
13463 #ifdef RE_TRACK_PATTERN_OFFSETS
13464 if (RExC_offsets) { /* MJD 20010112 */
13465 MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s copy %"UVuf" -> %"UVuf" (max %"UVuf").\n",
13469 (UV)(dst - RExC_emit_start) > RExC_offsets[0]
13470 ? "Overwriting end of array!\n" : "OK",
13471 (UV)(src - RExC_emit_start),
13472 (UV)(dst - RExC_emit_start),
13473 (UV)RExC_offsets[0]));
13474 Set_Node_Offset_To_R(dst-RExC_emit_start, Node_Offset(src));
13475 Set_Node_Length_To_R(dst-RExC_emit_start, Node_Length(src));
13481 place = opnd; /* Op node, where operand used to be. */
13482 #ifdef RE_TRACK_PATTERN_OFFSETS
13483 if (RExC_offsets) { /* MJD */
13484 MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s %"UVuf" <- %"UVuf" (max %"UVuf").\n",
13488 (UV)(place - RExC_emit_start) > RExC_offsets[0]
13489 ? "Overwriting end of array!\n" : "OK",
13490 (UV)(place - RExC_emit_start),
13491 (UV)(RExC_parse - RExC_start),
13492 (UV)RExC_offsets[0]));
13493 Set_Node_Offset(place, RExC_parse);
13494 Set_Node_Length(place, 1);
13497 src = NEXTOPER(place);
13498 FILL_ADVANCE_NODE(place, op);
13499 Zero(src, offset, regnode);
13503 - regtail - set the next-pointer at the end of a node chain of p to val.
13504 - SEE ALSO: regtail_study
13506 /* TODO: All three parms should be const */
13508 S_regtail(pTHX_ RExC_state_t *pRExC_state, regnode *p, const regnode *val,U32 depth)
13512 GET_RE_DEBUG_FLAGS_DECL;
13514 PERL_ARGS_ASSERT_REGTAIL;
13516 PERL_UNUSED_ARG(depth);
13522 /* Find last node. */
13525 regnode * const temp = regnext(scan);
13527 SV * const mysv=sv_newmortal();
13528 DEBUG_PARSE_MSG((scan==p ? "tail" : ""));
13529 regprop(RExC_rx, mysv, scan);
13530 PerlIO_printf(Perl_debug_log, "~ %s (%d) %s %s\n",
13531 SvPV_nolen_const(mysv), REG_NODE_NUM(scan),
13532 (temp == NULL ? "->" : ""),
13533 (temp == NULL ? PL_reg_name[OP(val)] : "")
13541 if (reg_off_by_arg[OP(scan)]) {
13542 ARG_SET(scan, val - scan);
13545 NEXT_OFF(scan) = val - scan;
13551 - regtail_study - set the next-pointer at the end of a node chain of p to val.
13552 - Look for optimizable sequences at the same time.
13553 - currently only looks for EXACT chains.
13555 This is experimental code. The idea is to use this routine to perform
13556 in place optimizations on branches and groups as they are constructed,
13557 with the long term intention of removing optimization from study_chunk so
13558 that it is purely analytical.
13560 Currently only used when in DEBUG mode. The macro REGTAIL_STUDY() is used
13561 to control which is which.
13564 /* TODO: All four parms should be const */
13567 S_regtail_study(pTHX_ RExC_state_t *pRExC_state, regnode *p, const regnode *val,U32 depth)
13572 #ifdef EXPERIMENTAL_INPLACESCAN
13575 GET_RE_DEBUG_FLAGS_DECL;
13577 PERL_ARGS_ASSERT_REGTAIL_STUDY;
13583 /* Find last node. */
13587 regnode * const temp = regnext(scan);
13588 #ifdef EXPERIMENTAL_INPLACESCAN
13589 if (PL_regkind[OP(scan)] == EXACT) {
13590 bool has_exactf_sharp_s; /* Unexamined in this routine */
13591 if (join_exact(pRExC_state,scan,&min, &has_exactf_sharp_s, 1,val,depth+1))
13596 switch (OP(scan)) {
13602 case EXACTFU_TRICKYFOLD:
13604 if( exact == PSEUDO )
13606 else if ( exact != OP(scan) )
13615 SV * const mysv=sv_newmortal();
13616 DEBUG_PARSE_MSG((scan==p ? "tsdy" : ""));
13617 regprop(RExC_rx, mysv, scan);
13618 PerlIO_printf(Perl_debug_log, "~ %s (%d) -> %s\n",
13619 SvPV_nolen_const(mysv),
13620 REG_NODE_NUM(scan),
13621 PL_reg_name[exact]);
13628 SV * const mysv_val=sv_newmortal();
13629 DEBUG_PARSE_MSG("");
13630 regprop(RExC_rx, mysv_val, val);
13631 PerlIO_printf(Perl_debug_log, "~ attach to %s (%"IVdf") offset to %"IVdf"\n",
13632 SvPV_nolen_const(mysv_val),
13633 (IV)REG_NODE_NUM(val),
13637 if (reg_off_by_arg[OP(scan)]) {
13638 ARG_SET(scan, val - scan);
13641 NEXT_OFF(scan) = val - scan;
13649 - regdump - dump a regexp onto Perl_debug_log in vaguely comprehensible form
13653 S_regdump_extflags(pTHX_ const char *lead, const U32 flags)
13659 for (bit=0; bit<32; bit++) {
13660 if (flags & (1<<bit)) {
13661 if ((1<<bit) & RXf_PMf_CHARSET) { /* Output separately, below */
13664 if (!set++ && lead)
13665 PerlIO_printf(Perl_debug_log, "%s",lead);
13666 PerlIO_printf(Perl_debug_log, "%s ",PL_reg_extflags_name[bit]);
13669 if ((cs = get_regex_charset(flags)) != REGEX_DEPENDS_CHARSET) {
13670 if (!set++ && lead) {
13671 PerlIO_printf(Perl_debug_log, "%s",lead);
13674 case REGEX_UNICODE_CHARSET:
13675 PerlIO_printf(Perl_debug_log, "UNICODE");
13677 case REGEX_LOCALE_CHARSET:
13678 PerlIO_printf(Perl_debug_log, "LOCALE");
13680 case REGEX_ASCII_RESTRICTED_CHARSET:
13681 PerlIO_printf(Perl_debug_log, "ASCII-RESTRICTED");
13683 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
13684 PerlIO_printf(Perl_debug_log, "ASCII-MORE_RESTRICTED");
13687 PerlIO_printf(Perl_debug_log, "UNKNOWN CHARACTER SET");
13693 PerlIO_printf(Perl_debug_log, "\n");
13695 PerlIO_printf(Perl_debug_log, "%s[none-set]\n",lead);
13701 Perl_regdump(pTHX_ const regexp *r)
13705 SV * const sv = sv_newmortal();
13706 SV *dsv= sv_newmortal();
13707 RXi_GET_DECL(r,ri);
13708 GET_RE_DEBUG_FLAGS_DECL;
13710 PERL_ARGS_ASSERT_REGDUMP;
13712 (void)dumpuntil(r, ri->program, ri->program + 1, NULL, NULL, sv, 0, 0);
13714 /* Header fields of interest. */
13715 if (r->anchored_substr) {
13716 RE_PV_QUOTED_DECL(s, 0, dsv, SvPVX_const(r->anchored_substr),
13717 RE_SV_DUMPLEN(r->anchored_substr), 30);
13718 PerlIO_printf(Perl_debug_log,
13719 "anchored %s%s at %"IVdf" ",
13720 s, RE_SV_TAIL(r->anchored_substr),
13721 (IV)r->anchored_offset);
13722 } else if (r->anchored_utf8) {
13723 RE_PV_QUOTED_DECL(s, 1, dsv, SvPVX_const(r->anchored_utf8),
13724 RE_SV_DUMPLEN(r->anchored_utf8), 30);
13725 PerlIO_printf(Perl_debug_log,
13726 "anchored utf8 %s%s at %"IVdf" ",
13727 s, RE_SV_TAIL(r->anchored_utf8),
13728 (IV)r->anchored_offset);
13730 if (r->float_substr) {
13731 RE_PV_QUOTED_DECL(s, 0, dsv, SvPVX_const(r->float_substr),
13732 RE_SV_DUMPLEN(r->float_substr), 30);
13733 PerlIO_printf(Perl_debug_log,
13734 "floating %s%s at %"IVdf"..%"UVuf" ",
13735 s, RE_SV_TAIL(r->float_substr),
13736 (IV)r->float_min_offset, (UV)r->float_max_offset);
13737 } else if (r->float_utf8) {
13738 RE_PV_QUOTED_DECL(s, 1, dsv, SvPVX_const(r->float_utf8),
13739 RE_SV_DUMPLEN(r->float_utf8), 30);
13740 PerlIO_printf(Perl_debug_log,
13741 "floating utf8 %s%s at %"IVdf"..%"UVuf" ",
13742 s, RE_SV_TAIL(r->float_utf8),
13743 (IV)r->float_min_offset, (UV)r->float_max_offset);
13745 if (r->check_substr || r->check_utf8)
13746 PerlIO_printf(Perl_debug_log,
13748 (r->check_substr == r->float_substr
13749 && r->check_utf8 == r->float_utf8
13750 ? "(checking floating" : "(checking anchored"));
13751 if (r->extflags & RXf_NOSCAN)
13752 PerlIO_printf(Perl_debug_log, " noscan");
13753 if (r->extflags & RXf_CHECK_ALL)
13754 PerlIO_printf(Perl_debug_log, " isall");
13755 if (r->check_substr || r->check_utf8)
13756 PerlIO_printf(Perl_debug_log, ") ");
13758 if (ri->regstclass) {
13759 regprop(r, sv, ri->regstclass);
13760 PerlIO_printf(Perl_debug_log, "stclass %s ", SvPVX_const(sv));
13762 if (r->extflags & RXf_ANCH) {
13763 PerlIO_printf(Perl_debug_log, "anchored");
13764 if (r->extflags & RXf_ANCH_BOL)
13765 PerlIO_printf(Perl_debug_log, "(BOL)");
13766 if (r->extflags & RXf_ANCH_MBOL)
13767 PerlIO_printf(Perl_debug_log, "(MBOL)");
13768 if (r->extflags & RXf_ANCH_SBOL)
13769 PerlIO_printf(Perl_debug_log, "(SBOL)");
13770 if (r->extflags & RXf_ANCH_GPOS)
13771 PerlIO_printf(Perl_debug_log, "(GPOS)");
13772 PerlIO_putc(Perl_debug_log, ' ');
13774 if (r->extflags & RXf_GPOS_SEEN)
13775 PerlIO_printf(Perl_debug_log, "GPOS:%"UVuf" ", (UV)r->gofs);
13776 if (r->intflags & PREGf_SKIP)
13777 PerlIO_printf(Perl_debug_log, "plus ");
13778 if (r->intflags & PREGf_IMPLICIT)
13779 PerlIO_printf(Perl_debug_log, "implicit ");
13780 PerlIO_printf(Perl_debug_log, "minlen %"IVdf" ", (IV)r->minlen);
13781 if (r->extflags & RXf_EVAL_SEEN)
13782 PerlIO_printf(Perl_debug_log, "with eval ");
13783 PerlIO_printf(Perl_debug_log, "\n");
13784 DEBUG_FLAGS_r(regdump_extflags("r->extflags: ",r->extflags));
13786 PERL_ARGS_ASSERT_REGDUMP;
13787 PERL_UNUSED_CONTEXT;
13788 PERL_UNUSED_ARG(r);
13789 #endif /* DEBUGGING */
13793 - regprop - printable representation of opcode
13795 #define EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags) \
13798 Perl_sv_catpvf(aTHX_ sv,"%s][%s",PL_colors[1],PL_colors[0]); \
13799 if (flags & ANYOF_INVERT) \
13800 /*make sure the invert info is in each */ \
13801 sv_catpvs(sv, "^"); \
13807 Perl_regprop(pTHX_ const regexp *prog, SV *sv, const regnode *o)
13813 /* Should be synchronized with * ANYOF_ #xdefines in regcomp.h */
13814 static const char * const anyofs[] = {
13846 RXi_GET_DECL(prog,progi);
13847 GET_RE_DEBUG_FLAGS_DECL;
13849 PERL_ARGS_ASSERT_REGPROP;
13853 if (OP(o) > REGNODE_MAX) /* regnode.type is unsigned */
13854 /* It would be nice to FAIL() here, but this may be called from
13855 regexec.c, and it would be hard to supply pRExC_state. */
13856 Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d", (int)OP(o), (int)REGNODE_MAX);
13857 sv_catpv(sv, PL_reg_name[OP(o)]); /* Take off const! */
13859 k = PL_regkind[OP(o)];
13862 sv_catpvs(sv, " ");
13863 /* Using is_utf8_string() (via PERL_PV_UNI_DETECT)
13864 * is a crude hack but it may be the best for now since
13865 * we have no flag "this EXACTish node was UTF-8"
13867 pv_pretty(sv, STRING(o), STR_LEN(o), 60, PL_colors[0], PL_colors[1],
13868 PERL_PV_ESCAPE_UNI_DETECT |
13869 PERL_PV_ESCAPE_NONASCII |
13870 PERL_PV_PRETTY_ELLIPSES |
13871 PERL_PV_PRETTY_LTGT |
13872 PERL_PV_PRETTY_NOCLEAR
13874 } else if (k == TRIE) {
13875 /* print the details of the trie in dumpuntil instead, as
13876 * progi->data isn't available here */
13877 const char op = OP(o);
13878 const U32 n = ARG(o);
13879 const reg_ac_data * const ac = IS_TRIE_AC(op) ?
13880 (reg_ac_data *)progi->data->data[n] :
13882 const reg_trie_data * const trie
13883 = (reg_trie_data*)progi->data->data[!IS_TRIE_AC(op) ? n : ac->trie];
13885 Perl_sv_catpvf(aTHX_ sv, "-%s",PL_reg_name[o->flags]);
13886 DEBUG_TRIE_COMPILE_r(
13887 Perl_sv_catpvf(aTHX_ sv,
13888 "<S:%"UVuf"/%"IVdf" W:%"UVuf" L:%"UVuf"/%"UVuf" C:%"UVuf"/%"UVuf">",
13889 (UV)trie->startstate,
13890 (IV)trie->statecount-1, /* -1 because of the unused 0 element */
13891 (UV)trie->wordcount,
13894 (UV)TRIE_CHARCOUNT(trie),
13895 (UV)trie->uniquecharcount
13898 if ( IS_ANYOF_TRIE(op) || trie->bitmap ) {
13900 int rangestart = -1;
13901 U8* bitmap = IS_ANYOF_TRIE(op) ? (U8*)ANYOF_BITMAP(o) : (U8*)TRIE_BITMAP(trie);
13902 sv_catpvs(sv, "[");
13903 for (i = 0; i <= 256; i++) {
13904 if (i < 256 && BITMAP_TEST(bitmap,i)) {
13905 if (rangestart == -1)
13907 } else if (rangestart != -1) {
13908 if (i <= rangestart + 3)
13909 for (; rangestart < i; rangestart++)
13910 put_byte(sv, rangestart);
13912 put_byte(sv, rangestart);
13913 sv_catpvs(sv, "-");
13914 put_byte(sv, i - 1);
13919 sv_catpvs(sv, "]");
13922 } else if (k == CURLY) {
13923 if (OP(o) == CURLYM || OP(o) == CURLYN || OP(o) == CURLYX)
13924 Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags); /* Parenth number */
13925 Perl_sv_catpvf(aTHX_ sv, " {%d,%d}", ARG1(o), ARG2(o));
13927 else if (k == WHILEM && o->flags) /* Ordinal/of */
13928 Perl_sv_catpvf(aTHX_ sv, "[%d/%d]", o->flags & 0xf, o->flags>>4);
13929 else if (k == REF || k == OPEN || k == CLOSE || k == GROUPP || OP(o)==ACCEPT) {
13930 Perl_sv_catpvf(aTHX_ sv, "%d", (int)ARG(o)); /* Parenth number */
13931 if ( RXp_PAREN_NAMES(prog) ) {
13932 if ( k != REF || (OP(o) < NREF)) {
13933 AV *list= MUTABLE_AV(progi->data->data[progi->name_list_idx]);
13934 SV **name= av_fetch(list, ARG(o), 0 );
13936 Perl_sv_catpvf(aTHX_ sv, " '%"SVf"'", SVfARG(*name));
13939 AV *list= MUTABLE_AV(progi->data->data[ progi->name_list_idx ]);
13940 SV *sv_dat= MUTABLE_SV(progi->data->data[ ARG( o ) ]);
13941 I32 *nums=(I32*)SvPVX(sv_dat);
13942 SV **name= av_fetch(list, nums[0], 0 );
13945 for ( n=0; n<SvIVX(sv_dat); n++ ) {
13946 Perl_sv_catpvf(aTHX_ sv, "%s%"IVdf,
13947 (n ? "," : ""), (IV)nums[n]);
13949 Perl_sv_catpvf(aTHX_ sv, " '%"SVf"'", SVfARG(*name));
13953 } else if (k == GOSUB)
13954 Perl_sv_catpvf(aTHX_ sv, "%d[%+d]", (int)ARG(o),(int)ARG2L(o)); /* Paren and offset */
13955 else if (k == VERB) {
13957 Perl_sv_catpvf(aTHX_ sv, ":%"SVf,
13958 SVfARG((MUTABLE_SV(progi->data->data[ ARG( o ) ]))));
13959 } else if (k == LOGICAL)
13960 Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags); /* 2: embedded, otherwise 1 */
13961 else if (k == ANYOF) {
13962 int i, rangestart = -1;
13963 const U8 flags = ANYOF_FLAGS(o);
13967 if (flags & ANYOF_LOCALE)
13968 sv_catpvs(sv, "{loc}");
13969 if (flags & ANYOF_LOC_FOLD)
13970 sv_catpvs(sv, "{i}");
13971 Perl_sv_catpvf(aTHX_ sv, "[%s", PL_colors[0]);
13972 if (flags & ANYOF_INVERT)
13973 sv_catpvs(sv, "^");
13975 /* output what the standard cp 0-255 bitmap matches */
13976 for (i = 0; i <= 256; i++) {
13977 if (i < 256 && ANYOF_BITMAP_TEST(o,i)) {
13978 if (rangestart == -1)
13980 } else if (rangestart != -1) {
13981 if (i <= rangestart + 3)
13982 for (; rangestart < i; rangestart++)
13983 put_byte(sv, rangestart);
13985 put_byte(sv, rangestart);
13986 sv_catpvs(sv, "-");
13987 put_byte(sv, i - 1);
13994 EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags);
13995 /* output any special charclass tests (used entirely under use locale) */
13996 if (ANYOF_CLASS_TEST_ANY_SET(o))
13997 for (i = 0; i < (int)(sizeof(anyofs)/sizeof(char*)); i++)
13998 if (ANYOF_CLASS_TEST(o,i)) {
13999 sv_catpv(sv, anyofs[i]);
14003 EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags);
14005 if (flags & ANYOF_NON_UTF8_LATIN1_ALL) {
14006 sv_catpvs(sv, "{non-utf8-latin1-all}");
14009 /* output information about the unicode matching */
14010 if (flags & ANYOF_UNICODE_ALL)
14011 sv_catpvs(sv, "{unicode_all}");
14012 else if (ANYOF_NONBITMAP(o))
14013 sv_catpvs(sv, "{unicode}");
14014 if (flags & ANYOF_NONBITMAP_NON_UTF8)
14015 sv_catpvs(sv, "{outside bitmap}");
14017 if (ANYOF_NONBITMAP(o)) {
14018 SV *lv; /* Set if there is something outside the bit map */
14019 SV * const sw = regclass_swash(prog, o, FALSE, &lv, NULL);
14020 bool byte_output = FALSE; /* If something in the bitmap has been
14023 if (lv && lv != &PL_sv_undef) {
14025 U8 s[UTF8_MAXBYTES_CASE+1];
14027 for (i = 0; i <= 256; i++) { /* Look at chars in bitmap */
14028 uvchr_to_utf8(s, i);
14031 && ! ANYOF_BITMAP_TEST(o, i) /* Don't duplicate
14035 && swash_fetch(sw, s, TRUE))
14037 if (rangestart == -1)
14039 } else if (rangestart != -1) {
14040 byte_output = TRUE;
14041 if (i <= rangestart + 3)
14042 for (; rangestart < i; rangestart++) {
14043 put_byte(sv, rangestart);
14046 put_byte(sv, rangestart);
14047 sv_catpvs(sv, "-");
14056 char *s = savesvpv(lv);
14057 char * const origs = s;
14059 while (*s && *s != '\n')
14063 const char * const t = ++s;
14066 sv_catpvs(sv, " ");
14072 /* Truncate very long output */
14073 if (s - origs > 256) {
14074 Perl_sv_catpvf(aTHX_ sv,
14076 (int) (s - origs - 1),
14082 else if (*s == '\t') {
14101 Perl_sv_catpvf(aTHX_ sv, "%s]", PL_colors[1]);
14103 else if (k == POSIXD) {
14104 U8 index = FLAGS(o) * 2;
14105 if (index > (sizeof(anyofs) / sizeof(anyofs[0]))) {
14106 Perl_sv_catpvf(aTHX_ sv, "[illegal type=%d])", index);
14109 sv_catpv(sv, anyofs[index]);
14112 else if (k == BRANCHJ && (OP(o) == UNLESSM || OP(o) == IFMATCH))
14113 Perl_sv_catpvf(aTHX_ sv, "[%d]", -(o->flags));
14115 PERL_UNUSED_CONTEXT;
14116 PERL_UNUSED_ARG(sv);
14117 PERL_UNUSED_ARG(o);
14118 PERL_UNUSED_ARG(prog);
14119 #endif /* DEBUGGING */
14123 Perl_re_intuit_string(pTHX_ REGEXP * const r)
14124 { /* Assume that RE_INTUIT is set */
14126 struct regexp *const prog = ReANY(r);
14127 GET_RE_DEBUG_FLAGS_DECL;
14129 PERL_ARGS_ASSERT_RE_INTUIT_STRING;
14130 PERL_UNUSED_CONTEXT;
14134 const char * const s = SvPV_nolen_const(prog->check_substr
14135 ? prog->check_substr : prog->check_utf8);
14137 if (!PL_colorset) reginitcolors();
14138 PerlIO_printf(Perl_debug_log,
14139 "%sUsing REx %ssubstr:%s \"%s%.60s%s%s\"\n",
14141 prog->check_substr ? "" : "utf8 ",
14142 PL_colors[5],PL_colors[0],
14145 (strlen(s) > 60 ? "..." : ""));
14148 return prog->check_substr ? prog->check_substr : prog->check_utf8;
14154 handles refcounting and freeing the perl core regexp structure. When
14155 it is necessary to actually free the structure the first thing it
14156 does is call the 'free' method of the regexp_engine associated to
14157 the regexp, allowing the handling of the void *pprivate; member
14158 first. (This routine is not overridable by extensions, which is why
14159 the extensions free is called first.)
14161 See regdupe and regdupe_internal if you change anything here.
14163 #ifndef PERL_IN_XSUB_RE
14165 Perl_pregfree(pTHX_ REGEXP *r)
14171 Perl_pregfree2(pTHX_ REGEXP *rx)
14174 struct regexp *const r = ReANY(rx);
14175 GET_RE_DEBUG_FLAGS_DECL;
14177 PERL_ARGS_ASSERT_PREGFREE2;
14179 if (r->mother_re) {
14180 ReREFCNT_dec(r->mother_re);
14182 CALLREGFREE_PVT(rx); /* free the private data */
14183 SvREFCNT_dec(RXp_PAREN_NAMES(r));
14184 Safefree(r->xpv_len_u.xpvlenu_pv);
14187 SvREFCNT_dec(r->anchored_substr);
14188 SvREFCNT_dec(r->anchored_utf8);
14189 SvREFCNT_dec(r->float_substr);
14190 SvREFCNT_dec(r->float_utf8);
14191 Safefree(r->substrs);
14193 RX_MATCH_COPY_FREE(rx);
14194 #ifdef PERL_OLD_COPY_ON_WRITE
14195 SvREFCNT_dec(r->saved_copy);
14198 SvREFCNT_dec(r->qr_anoncv);
14199 rx->sv_u.svu_rx = 0;
14204 This is a hacky workaround to the structural issue of match results
14205 being stored in the regexp structure which is in turn stored in
14206 PL_curpm/PL_reg_curpm. The problem is that due to qr// the pattern
14207 could be PL_curpm in multiple contexts, and could require multiple
14208 result sets being associated with the pattern simultaneously, such
14209 as when doing a recursive match with (??{$qr})
14211 The solution is to make a lightweight copy of the regexp structure
14212 when a qr// is returned from the code executed by (??{$qr}) this
14213 lightweight copy doesn't actually own any of its data except for
14214 the starp/end and the actual regexp structure itself.
14220 Perl_reg_temp_copy (pTHX_ REGEXP *ret_x, REGEXP *rx)
14222 struct regexp *ret;
14223 struct regexp *const r = ReANY(rx);
14224 const bool islv = ret_x && SvTYPE(ret_x) == SVt_PVLV;
14226 PERL_ARGS_ASSERT_REG_TEMP_COPY;
14229 ret_x = (REGEXP*) newSV_type(SVt_REGEXP);
14231 SvOK_off((SV *)ret_x);
14233 /* For PVLVs, SvANY points to the xpvlv body while sv_u points
14234 to the regexp. (For SVt_REGEXPs, sv_upgrade has already
14235 made both spots point to the same regexp body.) */
14236 REGEXP *temp = (REGEXP *)newSV_type(SVt_REGEXP);
14237 assert(!SvPVX(ret_x));
14238 ret_x->sv_u.svu_rx = temp->sv_any;
14239 temp->sv_any = NULL;
14240 SvFLAGS(temp) = (SvFLAGS(temp) & ~SVTYPEMASK) | SVt_NULL;
14241 SvREFCNT_dec(temp);
14242 /* SvCUR still resides in the xpvlv struct, so the regexp copy-
14243 ing below will not set it. */
14244 SvCUR_set(ret_x, SvCUR(rx));
14247 /* This ensures that SvTHINKFIRST(sv) is true, and hence that
14248 sv_force_normal(sv) is called. */
14250 ret = ReANY(ret_x);
14252 SvFLAGS(ret_x) |= SvUTF8(rx);
14253 /* We share the same string buffer as the original regexp, on which we
14254 hold a reference count, incremented when mother_re is set below.
14255 The string pointer is copied here, being part of the regexp struct.
14257 memcpy(&(ret->xpv_cur), &(r->xpv_cur),
14258 sizeof(regexp) - STRUCT_OFFSET(regexp, xpv_cur));
14260 const I32 npar = r->nparens+1;
14261 Newx(ret->offs, npar, regexp_paren_pair);
14262 Copy(r->offs, ret->offs, npar, regexp_paren_pair);
14265 Newx(ret->substrs, 1, struct reg_substr_data);
14266 StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
14268 SvREFCNT_inc_void(ret->anchored_substr);
14269 SvREFCNT_inc_void(ret->anchored_utf8);
14270 SvREFCNT_inc_void(ret->float_substr);
14271 SvREFCNT_inc_void(ret->float_utf8);
14273 /* check_substr and check_utf8, if non-NULL, point to either their
14274 anchored or float namesakes, and don't hold a second reference. */
14276 RX_MATCH_COPIED_off(ret_x);
14277 #ifdef PERL_OLD_COPY_ON_WRITE
14278 ret->saved_copy = NULL;
14280 ret->mother_re = ReREFCNT_inc(r->mother_re ? r->mother_re : rx);
14281 SvREFCNT_inc_void(ret->qr_anoncv);
14287 /* regfree_internal()
14289 Free the private data in a regexp. This is overloadable by
14290 extensions. Perl takes care of the regexp structure in pregfree(),
14291 this covers the *pprivate pointer which technically perl doesn't
14292 know about, however of course we have to handle the
14293 regexp_internal structure when no extension is in use.
14295 Note this is called before freeing anything in the regexp
14300 Perl_regfree_internal(pTHX_ REGEXP * const rx)
14303 struct regexp *const r = ReANY(rx);
14304 RXi_GET_DECL(r,ri);
14305 GET_RE_DEBUG_FLAGS_DECL;
14307 PERL_ARGS_ASSERT_REGFREE_INTERNAL;
14313 SV *dsv= sv_newmortal();
14314 RE_PV_QUOTED_DECL(s, RX_UTF8(rx),
14315 dsv, RX_PRECOMP(rx), RX_PRELEN(rx), 60);
14316 PerlIO_printf(Perl_debug_log,"%sFreeing REx:%s %s\n",
14317 PL_colors[4],PL_colors[5],s);
14320 #ifdef RE_TRACK_PATTERN_OFFSETS
14322 Safefree(ri->u.offsets); /* 20010421 MJD */
14324 if (ri->code_blocks) {
14326 for (n = 0; n < ri->num_code_blocks; n++)
14327 SvREFCNT_dec(ri->code_blocks[n].src_regex);
14328 Safefree(ri->code_blocks);
14332 int n = ri->data->count;
14335 /* If you add a ->what type here, update the comment in regcomp.h */
14336 switch (ri->data->what[n]) {
14342 SvREFCNT_dec(MUTABLE_SV(ri->data->data[n]));
14345 Safefree(ri->data->data[n]);
14351 { /* Aho Corasick add-on structure for a trie node.
14352 Used in stclass optimization only */
14354 reg_ac_data *aho=(reg_ac_data*)ri->data->data[n];
14356 refcount = --aho->refcount;
14359 PerlMemShared_free(aho->states);
14360 PerlMemShared_free(aho->fail);
14361 /* do this last!!!! */
14362 PerlMemShared_free(ri->data->data[n]);
14363 PerlMemShared_free(ri->regstclass);
14369 /* trie structure. */
14371 reg_trie_data *trie=(reg_trie_data*)ri->data->data[n];
14373 refcount = --trie->refcount;
14376 PerlMemShared_free(trie->charmap);
14377 PerlMemShared_free(trie->states);
14378 PerlMemShared_free(trie->trans);
14380 PerlMemShared_free(trie->bitmap);
14382 PerlMemShared_free(trie->jump);
14383 PerlMemShared_free(trie->wordinfo);
14384 /* do this last!!!! */
14385 PerlMemShared_free(ri->data->data[n]);
14390 Perl_croak(aTHX_ "panic: regfree data code '%c'", ri->data->what[n]);
14393 Safefree(ri->data->what);
14394 Safefree(ri->data);
14400 #define av_dup_inc(s,t) MUTABLE_AV(sv_dup_inc((const SV *)s,t))
14401 #define hv_dup_inc(s,t) MUTABLE_HV(sv_dup_inc((const SV *)s,t))
14402 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
14405 re_dup - duplicate a regexp.
14407 This routine is expected to clone a given regexp structure. It is only
14408 compiled under USE_ITHREADS.
14410 After all of the core data stored in struct regexp is duplicated
14411 the regexp_engine.dupe method is used to copy any private data
14412 stored in the *pprivate pointer. This allows extensions to handle
14413 any duplication it needs to do.
14415 See pregfree() and regfree_internal() if you change anything here.
14417 #if defined(USE_ITHREADS)
14418 #ifndef PERL_IN_XSUB_RE
14420 Perl_re_dup_guts(pTHX_ const REGEXP *sstr, REGEXP *dstr, CLONE_PARAMS *param)
14424 const struct regexp *r = ReANY(sstr);
14425 struct regexp *ret = ReANY(dstr);
14427 PERL_ARGS_ASSERT_RE_DUP_GUTS;
14429 npar = r->nparens+1;
14430 Newx(ret->offs, npar, regexp_paren_pair);
14431 Copy(r->offs, ret->offs, npar, regexp_paren_pair);
14433 /* no need to copy these */
14434 Newx(ret->swap, npar, regexp_paren_pair);
14437 if (ret->substrs) {
14438 /* Do it this way to avoid reading from *r after the StructCopy().
14439 That way, if any of the sv_dup_inc()s dislodge *r from the L1
14440 cache, it doesn't matter. */
14441 const bool anchored = r->check_substr
14442 ? r->check_substr == r->anchored_substr
14443 : r->check_utf8 == r->anchored_utf8;
14444 Newx(ret->substrs, 1, struct reg_substr_data);
14445 StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
14447 ret->anchored_substr = sv_dup_inc(ret->anchored_substr, param);
14448 ret->anchored_utf8 = sv_dup_inc(ret->anchored_utf8, param);
14449 ret->float_substr = sv_dup_inc(ret->float_substr, param);
14450 ret->float_utf8 = sv_dup_inc(ret->float_utf8, param);
14452 /* check_substr and check_utf8, if non-NULL, point to either their
14453 anchored or float namesakes, and don't hold a second reference. */
14455 if (ret->check_substr) {
14457 assert(r->check_utf8 == r->anchored_utf8);
14458 ret->check_substr = ret->anchored_substr;
14459 ret->check_utf8 = ret->anchored_utf8;
14461 assert(r->check_substr == r->float_substr);
14462 assert(r->check_utf8 == r->float_utf8);
14463 ret->check_substr = ret->float_substr;
14464 ret->check_utf8 = ret->float_utf8;
14466 } else if (ret->check_utf8) {
14468 ret->check_utf8 = ret->anchored_utf8;
14470 ret->check_utf8 = ret->float_utf8;
14475 RXp_PAREN_NAMES(ret) = hv_dup_inc(RXp_PAREN_NAMES(ret), param);
14476 ret->qr_anoncv = MUTABLE_CV(sv_dup_inc((const SV *)ret->qr_anoncv, param));
14479 RXi_SET(ret,CALLREGDUPE_PVT(dstr,param));
14481 if (RX_MATCH_COPIED(dstr))
14482 ret->subbeg = SAVEPVN(ret->subbeg, ret->sublen);
14484 ret->subbeg = NULL;
14485 #ifdef PERL_OLD_COPY_ON_WRITE
14486 ret->saved_copy = NULL;
14489 /* Whether mother_re be set or no, we need to copy the string. We
14490 cannot refrain from copying it when the storage points directly to
14491 our mother regexp, because that's
14492 1: a buffer in a different thread
14493 2: something we no longer hold a reference on
14494 so we need to copy it locally. */
14495 RX_WRAPPED(dstr) = SAVEPVN(RX_WRAPPED(sstr), SvCUR(sstr)+1);
14496 ret->mother_re = NULL;
14499 #endif /* PERL_IN_XSUB_RE */
14504 This is the internal complement to regdupe() which is used to copy
14505 the structure pointed to by the *pprivate pointer in the regexp.
14506 This is the core version of the extension overridable cloning hook.
14507 The regexp structure being duplicated will be copied by perl prior
14508 to this and will be provided as the regexp *r argument, however
14509 with the /old/ structures pprivate pointer value. Thus this routine
14510 may override any copying normally done by perl.
14512 It returns a pointer to the new regexp_internal structure.
14516 Perl_regdupe_internal(pTHX_ REGEXP * const rx, CLONE_PARAMS *param)
14519 struct regexp *const r = ReANY(rx);
14520 regexp_internal *reti;
14522 RXi_GET_DECL(r,ri);
14524 PERL_ARGS_ASSERT_REGDUPE_INTERNAL;
14528 Newxc(reti, sizeof(regexp_internal) + len*sizeof(regnode), char, regexp_internal);
14529 Copy(ri->program, reti->program, len+1, regnode);
14531 reti->num_code_blocks = ri->num_code_blocks;
14532 if (ri->code_blocks) {
14534 Newxc(reti->code_blocks, ri->num_code_blocks, struct reg_code_block,
14535 struct reg_code_block);
14536 Copy(ri->code_blocks, reti->code_blocks, ri->num_code_blocks,
14537 struct reg_code_block);
14538 for (n = 0; n < ri->num_code_blocks; n++)
14539 reti->code_blocks[n].src_regex = (REGEXP*)
14540 sv_dup_inc((SV*)(ri->code_blocks[n].src_regex), param);
14543 reti->code_blocks = NULL;
14545 reti->regstclass = NULL;
14548 struct reg_data *d;
14549 const int count = ri->data->count;
14552 Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
14553 char, struct reg_data);
14554 Newx(d->what, count, U8);
14557 for (i = 0; i < count; i++) {
14558 d->what[i] = ri->data->what[i];
14559 switch (d->what[i]) {
14560 /* see also regcomp.h and regfree_internal() */
14561 case 'a': /* actually an AV, but the dup function is identical. */
14565 case 'u': /* actually an HV, but the dup function is identical. */
14566 d->data[i] = sv_dup_inc((const SV *)ri->data->data[i], param);
14569 /* This is cheating. */
14570 Newx(d->data[i], 1, struct regnode_charclass_class);
14571 StructCopy(ri->data->data[i], d->data[i],
14572 struct regnode_charclass_class);
14573 reti->regstclass = (regnode*)d->data[i];
14576 /* Trie stclasses are readonly and can thus be shared
14577 * without duplication. We free the stclass in pregfree
14578 * when the corresponding reg_ac_data struct is freed.
14580 reti->regstclass= ri->regstclass;
14584 ((reg_trie_data*)ri->data->data[i])->refcount++;
14589 d->data[i] = ri->data->data[i];
14592 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", ri->data->what[i]);
14601 reti->name_list_idx = ri->name_list_idx;
14603 #ifdef RE_TRACK_PATTERN_OFFSETS
14604 if (ri->u.offsets) {
14605 Newx(reti->u.offsets, 2*len+1, U32);
14606 Copy(ri->u.offsets, reti->u.offsets, 2*len+1, U32);
14609 SetProgLen(reti,len);
14612 return (void*)reti;
14615 #endif /* USE_ITHREADS */
14617 #ifndef PERL_IN_XSUB_RE
14620 - regnext - dig the "next" pointer out of a node
14623 Perl_regnext(pTHX_ register regnode *p)
14631 if (OP(p) > REGNODE_MAX) { /* regnode.type is unsigned */
14632 Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d", (int)OP(p), (int)REGNODE_MAX);
14635 offset = (reg_off_by_arg[OP(p)] ? ARG(p) : NEXT_OFF(p));
14644 S_re_croak2(pTHX_ const char* pat1,const char* pat2,...)
14647 STRLEN l1 = strlen(pat1);
14648 STRLEN l2 = strlen(pat2);
14651 const char *message;
14653 PERL_ARGS_ASSERT_RE_CROAK2;
14659 Copy(pat1, buf, l1 , char);
14660 Copy(pat2, buf + l1, l2 , char);
14661 buf[l1 + l2] = '\n';
14662 buf[l1 + l2 + 1] = '\0';
14664 /* ANSI variant takes additional second argument */
14665 va_start(args, pat2);
14669 msv = vmess(buf, &args);
14671 message = SvPV_const(msv,l1);
14674 Copy(message, buf, l1 , char);
14675 buf[l1-1] = '\0'; /* Overwrite \n */
14676 Perl_croak(aTHX_ "%s", buf);
14679 /* XXX Here's a total kludge. But we need to re-enter for swash routines. */
14681 #ifndef PERL_IN_XSUB_RE
14683 Perl_save_re_context(pTHX)
14687 struct re_save_state *state;
14689 SAVEVPTR(PL_curcop);
14690 SSGROW(SAVESTACK_ALLOC_FOR_RE_SAVE_STATE + 1);
14692 state = (struct re_save_state *)(PL_savestack + PL_savestack_ix);
14693 PL_savestack_ix += SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
14694 SSPUSHUV(SAVEt_RE_STATE);
14696 Copy(&PL_reg_state, state, 1, struct re_save_state);
14698 PL_reg_oldsaved = NULL;
14699 PL_reg_oldsavedlen = 0;
14700 PL_reg_oldsavedoffset = 0;
14701 PL_reg_oldsavedcoffset = 0;
14702 PL_reg_maxiter = 0;
14703 PL_reg_leftiter = 0;
14704 PL_reg_poscache = NULL;
14705 PL_reg_poscache_size = 0;
14706 #ifdef PERL_OLD_COPY_ON_WRITE
14710 /* Save $1..$n (#18107: UTF-8 s/(\w+)/uc($1)/e); AMS 20021106. */
14712 const REGEXP * const rx = PM_GETRE(PL_curpm);
14715 for (i = 1; i <= RX_NPARENS(rx); i++) {
14716 char digits[TYPE_CHARS(long)];
14717 const STRLEN len = my_snprintf(digits, sizeof(digits), "%lu", (long)i);
14718 GV *const *const gvp
14719 = (GV**)hv_fetch(PL_defstash, digits, len, 0);
14722 GV * const gv = *gvp;
14723 if (SvTYPE(gv) == SVt_PVGV && GvSV(gv))
14733 clear_re(pTHX_ void *r)
14736 ReREFCNT_dec((REGEXP *)r);
14742 S_put_byte(pTHX_ SV *sv, int c)
14744 PERL_ARGS_ASSERT_PUT_BYTE;
14746 /* Our definition of isPRINT() ignores locales, so only bytes that are
14747 not part of UTF-8 are considered printable. I assume that the same
14748 holds for UTF-EBCDIC.
14749 Also, code point 255 is not printable in either (it's E0 in EBCDIC,
14750 which Wikipedia says:
14752 EO, or Eight Ones, is an 8-bit EBCDIC character code represented as all
14753 ones (binary 1111 1111, hexadecimal FF). It is similar, but not
14754 identical, to the ASCII delete (DEL) or rubout control character.
14755 ) So the old condition can be simplified to !isPRINT(c) */
14758 Perl_sv_catpvf(aTHX_ sv, "\\x%02x", c);
14761 Perl_sv_catpvf(aTHX_ sv, "\\x{%x}", c);
14765 const char string = c;
14766 if (c == '-' || c == ']' || c == '\\' || c == '^')
14767 sv_catpvs(sv, "\\");
14768 sv_catpvn(sv, &string, 1);
14773 #define CLEAR_OPTSTART \
14774 if (optstart) STMT_START { \
14775 DEBUG_OPTIMISE_r(PerlIO_printf(Perl_debug_log, " (%"IVdf" nodes)\n", (IV)(node - optstart))); \
14779 #define DUMPUNTIL(b,e) CLEAR_OPTSTART; node=dumpuntil(r,start,(b),(e),last,sv,indent+1,depth+1);
14781 STATIC const regnode *
14782 S_dumpuntil(pTHX_ const regexp *r, const regnode *start, const regnode *node,
14783 const regnode *last, const regnode *plast,
14784 SV* sv, I32 indent, U32 depth)
14787 U8 op = PSEUDO; /* Arbitrary non-END op. */
14788 const regnode *next;
14789 const regnode *optstart= NULL;
14791 RXi_GET_DECL(r,ri);
14792 GET_RE_DEBUG_FLAGS_DECL;
14794 PERL_ARGS_ASSERT_DUMPUNTIL;
14796 #ifdef DEBUG_DUMPUNTIL
14797 PerlIO_printf(Perl_debug_log, "--- %d : %d - %d - %d\n",indent,node-start,
14798 last ? last-start : 0,plast ? plast-start : 0);
14801 if (plast && plast < last)
14804 while (PL_regkind[op] != END && (!last || node < last)) {
14805 /* While that wasn't END last time... */
14808 if (op == CLOSE || op == WHILEM)
14810 next = regnext((regnode *)node);
14813 if (OP(node) == OPTIMIZED) {
14814 if (!optstart && RE_DEBUG_FLAG(RE_DEBUG_COMPILE_OPTIMISE))
14821 regprop(r, sv, node);
14822 PerlIO_printf(Perl_debug_log, "%4"IVdf":%*s%s", (IV)(node - start),
14823 (int)(2*indent + 1), "", SvPVX_const(sv));
14825 if (OP(node) != OPTIMIZED) {
14826 if (next == NULL) /* Next ptr. */
14827 PerlIO_printf(Perl_debug_log, " (0)");
14828 else if (PL_regkind[(U8)op] == BRANCH && PL_regkind[OP(next)] != BRANCH )
14829 PerlIO_printf(Perl_debug_log, " (FAIL)");
14831 PerlIO_printf(Perl_debug_log, " (%"IVdf")", (IV)(next - start));
14832 (void)PerlIO_putc(Perl_debug_log, '\n');
14836 if (PL_regkind[(U8)op] == BRANCHJ) {
14839 const regnode *nnode = (OP(next) == LONGJMP
14840 ? regnext((regnode *)next)
14842 if (last && nnode > last)
14844 DUMPUNTIL(NEXTOPER(NEXTOPER(node)), nnode);
14847 else if (PL_regkind[(U8)op] == BRANCH) {
14849 DUMPUNTIL(NEXTOPER(node), next);
14851 else if ( PL_regkind[(U8)op] == TRIE ) {
14852 const regnode *this_trie = node;
14853 const char op = OP(node);
14854 const U32 n = ARG(node);
14855 const reg_ac_data * const ac = op>=AHOCORASICK ?
14856 (reg_ac_data *)ri->data->data[n] :
14858 const reg_trie_data * const trie =
14859 (reg_trie_data*)ri->data->data[op<AHOCORASICK ? n : ac->trie];
14861 AV *const trie_words = MUTABLE_AV(ri->data->data[n + TRIE_WORDS_OFFSET]);
14863 const regnode *nextbranch= NULL;
14866 for (word_idx= 0; word_idx < (I32)trie->wordcount; word_idx++) {
14867 SV ** const elem_ptr = av_fetch(trie_words,word_idx,0);
14869 PerlIO_printf(Perl_debug_log, "%*s%s ",
14870 (int)(2*(indent+3)), "",
14871 elem_ptr ? pv_pretty(sv, SvPV_nolen_const(*elem_ptr), SvCUR(*elem_ptr), 60,
14872 PL_colors[0], PL_colors[1],
14873 (SvUTF8(*elem_ptr) ? PERL_PV_ESCAPE_UNI : 0) |
14874 PERL_PV_PRETTY_ELLIPSES |
14875 PERL_PV_PRETTY_LTGT
14880 U16 dist= trie->jump[word_idx+1];
14881 PerlIO_printf(Perl_debug_log, "(%"UVuf")\n",
14882 (UV)((dist ? this_trie + dist : next) - start));
14885 nextbranch= this_trie + trie->jump[0];
14886 DUMPUNTIL(this_trie + dist, nextbranch);
14888 if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
14889 nextbranch= regnext((regnode *)nextbranch);
14891 PerlIO_printf(Perl_debug_log, "\n");
14894 if (last && next > last)
14899 else if ( op == CURLY ) { /* "next" might be very big: optimizer */
14900 DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS,
14901 NEXTOPER(node) + EXTRA_STEP_2ARGS + 1);
14903 else if (PL_regkind[(U8)op] == CURLY && op != CURLYX) {
14905 DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS, next);
14907 else if ( op == PLUS || op == STAR) {
14908 DUMPUNTIL(NEXTOPER(node), NEXTOPER(node) + 1);
14910 else if (PL_regkind[(U8)op] == ANYOF) {
14911 /* arglen 1 + class block */
14912 node += 1 + ((ANYOF_FLAGS(node) & ANYOF_CLASS)
14913 ? ANYOF_CLASS_SKIP : ANYOF_SKIP);
14914 node = NEXTOPER(node);
14916 else if (PL_regkind[(U8)op] == EXACT) {
14917 /* Literal string, where present. */
14918 node += NODE_SZ_STR(node) - 1;
14919 node = NEXTOPER(node);
14922 node = NEXTOPER(node);
14923 node += regarglen[(U8)op];
14925 if (op == CURLYX || op == OPEN)
14929 #ifdef DEBUG_DUMPUNTIL
14930 PerlIO_printf(Perl_debug_log, "--- %d\n", (int)indent);
14935 #endif /* DEBUGGING */
14939 * c-indentation-style: bsd
14940 * c-basic-offset: 4
14941 * indent-tabs-mode: nil
14944 * ex: set ts=8 sts=4 sw=4 et:
https://perl5.git.perl.org / perl5.git / blob