5 * One Ring to rule them all, One Ring to find them
7 * [p.v of _The Lord of the Rings_, opening poem]
8 * [p.50 of _The Lord of the Rings_, I/iii: "The Shadow of the Past"]
9 * [p.254 of _The Lord of the Rings_, II/ii: "The Council of Elrond"]
12 /* This file contains functions for executing a regular expression. See
13 * also regcomp.c which funnily enough, contains functions for compiling
14 * a regular expression.
16 * This file is also copied at build time to ext/re/re_exec.c, where
17 * it's built with -DPERL_EXT_RE_BUILD -DPERL_EXT_RE_DEBUG -DPERL_EXT.
18 * This causes the main functions to be compiled under new names and with
19 * debugging support added, which makes "use re 'debug'" work.
22 /* NOTE: this is derived from Henry Spencer's regexp code, and should not
23 * confused with the original package (see point 3 below). Thanks, Henry!
26 /* Additional note: this code is very heavily munged from Henry's version
27 * in places. In some spots I've traded clarity for efficiency, so don't
28 * blame Henry for some of the lack of readability.
31 /* The names of the functions have been changed from regcomp and
32 * regexec to pregcomp and pregexec in order to avoid conflicts
33 * with the POSIX routines of the same names.
36 #ifdef PERL_EXT_RE_BUILD
40 /* At least one required character in the target string is expressible only in
42 static const char* const non_utf8_target_but_utf8_required
43 = "Can't match, because target string needs to be in UTF-8\n";
45 #define NON_UTF8_TARGET_BUT_UTF8_REQUIRED(target) STMT_START { \
46 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "%s", non_utf8_target_but_utf8_required));\
51 * pregcomp and pregexec -- regsub and regerror are not used in perl
53 * Copyright (c) 1986 by University of Toronto.
54 * Written by Henry Spencer. Not derived from licensed software.
56 * Permission is granted to anyone to use this software for any
57 * purpose on any computer system, and to redistribute it freely,
58 * subject to the following restrictions:
60 * 1. The author is not responsible for the consequences of use of
61 * this software, no matter how awful, even if they arise
64 * 2. The origin of this software must not be misrepresented, either
65 * by explicit claim or by omission.
67 * 3. Altered versions must be plainly marked as such, and must not
68 * be misrepresented as being the original software.
70 **** Alterations to Henry's code are...
72 **** Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
73 **** 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
74 **** by Larry Wall and others
76 **** You may distribute under the terms of either the GNU General Public
77 **** License or the Artistic License, as specified in the README file.
79 * Beware that some of this code is subtly aware of the way operator
80 * precedence is structured in regular expressions. Serious changes in
81 * regular-expression syntax might require a total rethink.
84 #define PERL_IN_REGEXEC_C
87 #ifdef PERL_IN_XSUB_RE
93 #include "inline_invlist.c"
94 #include "unicode_constants.h"
96 #define HAS_NONLATIN1_FOLD_CLOSURE(i) _HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(i)
102 /* Valid for non-utf8 strings: avoids the reginclass
103 * call if there are no complications: i.e., if everything matchable is
104 * straight forward in the bitmap */
105 #define REGINCLASS(prog,p,c) (ANYOF_FLAGS(p) ? reginclass(prog,p,c,0) \
106 : ANYOF_BITMAP_TEST(p,*(c)))
112 #define CHR_SVLEN(sv) (utf8_target ? sv_len_utf8(sv) : SvCUR(sv))
113 #define CHR_DIST(a,b) (PL_reg_match_utf8 ? utf8_distance(a,b) : a - b)
115 #define HOPc(pos,off) \
116 (char *)(PL_reg_match_utf8 \
117 ? reghop3((U8*)pos, off, (U8*)(off >= 0 ? PL_regeol : PL_bostr)) \
119 #define HOPBACKc(pos, off) \
120 (char*)(PL_reg_match_utf8\
121 ? reghopmaybe3((U8*)pos, -off, (U8*)PL_bostr) \
122 : (pos - off >= PL_bostr) \
126 #define HOP3(pos,off,lim) (PL_reg_match_utf8 ? reghop3((U8*)(pos), off, (U8*)(lim)) : (U8*)(pos + off))
127 #define HOP3c(pos,off,lim) ((char*)HOP3(pos,off,lim))
130 #define NEXTCHR_EOS -10 /* nextchr has fallen off the end */
131 #define NEXTCHR_IS_EOS (nextchr < 0)
133 #define SET_nextchr \
134 nextchr = ((locinput < PL_regeol) ? UCHARAT(locinput) : NEXTCHR_EOS)
136 #define SET_locinput(p) \
141 #define LOAD_UTF8_CHARCLASS(swash_ptr, property_name) STMT_START { \
143 U8 flags = _CORE_SWASH_INIT_ACCEPT_INVLIST; \
144 swash_ptr = _core_swash_init("utf8", property_name, &PL_sv_undef, \
145 1, 0, NULL, &flags); \
150 /* If in debug mode, we test that a known character properly matches */
152 # define LOAD_UTF8_CHARCLASS_DEBUG_TEST(swash_ptr, \
154 utf8_char_in_property) \
155 LOAD_UTF8_CHARCLASS(swash_ptr, property_name); \
156 assert(swash_fetch(swash_ptr, (U8 *) utf8_char_in_property, TRUE));
158 # define LOAD_UTF8_CHARCLASS_DEBUG_TEST(swash_ptr, \
160 utf8_char_in_property) \
161 LOAD_UTF8_CHARCLASS(swash_ptr, property_name)
164 #define LOAD_UTF8_CHARCLASS_ALNUM() LOAD_UTF8_CHARCLASS_DEBUG_TEST( \
165 PL_utf8_swash_ptrs[_CC_WORDCHAR], \
166 swash_property_names[_CC_WORDCHAR], \
167 GREEK_SMALL_LETTER_IOTA_UTF8)
169 #define LOAD_UTF8_CHARCLASS_GCB() /* Grapheme cluster boundaries */ \
171 LOAD_UTF8_CHARCLASS_DEBUG_TEST(PL_utf8_X_regular_begin, \
172 "_X_regular_begin", \
173 GREEK_SMALL_LETTER_IOTA_UTF8); \
174 LOAD_UTF8_CHARCLASS_DEBUG_TEST(PL_utf8_X_extend, \
176 COMBINING_GRAVE_ACCENT_UTF8); \
179 #define PLACEHOLDER /* Something for the preprocessor to grab onto */
180 /* TODO: Combine JUMPABLE and HAS_TEXT to cache OP(rn) */
182 /* for use after a quantifier and before an EXACT-like node -- japhy */
183 /* it would be nice to rework regcomp.sym to generate this stuff. sigh
185 * NOTE that *nothing* that affects backtracking should be in here, specifically
186 * VERBS must NOT be included. JUMPABLE is used to determine if we can ignore a
187 * node that is in between two EXACT like nodes when ascertaining what the required
188 * "follow" character is. This should probably be moved to regex compile time
189 * although it may be done at run time beause of the REF possibility - more
190 * investigation required. -- demerphq
192 #define JUMPABLE(rn) ( \
194 (OP(rn) == CLOSE && (!cur_eval || cur_eval->u.eval.close_paren != ARG(rn))) || \
196 OP(rn) == SUSPEND || OP(rn) == IFMATCH || \
197 OP(rn) == PLUS || OP(rn) == MINMOD || \
199 (PL_regkind[OP(rn)] == CURLY && ARG1(rn) > 0) \
201 #define IS_EXACT(rn) (PL_regkind[OP(rn)] == EXACT)
203 #define HAS_TEXT(rn) ( IS_EXACT(rn) || PL_regkind[OP(rn)] == REF )
206 /* Currently these are only used when PL_regkind[OP(rn)] == EXACT so
207 we don't need this definition. */
208 #define IS_TEXT(rn) ( OP(rn)==EXACT || OP(rn)==REF || OP(rn)==NREF )
209 #define IS_TEXTF(rn) ( OP(rn)==EXACTFU || OP(rn)==EXACTFU_SS || OP(rn)==EXACTFU_TRICKYFOLD || OP(rn)==EXACTFA || OP(rn)==EXACTF || OP(rn)==REFF || OP(rn)==NREFF )
210 #define IS_TEXTFL(rn) ( OP(rn)==EXACTFL || OP(rn)==REFFL || OP(rn)==NREFFL )
213 /* ... so we use this as its faster. */
214 #define IS_TEXT(rn) ( OP(rn)==EXACT )
215 #define IS_TEXTFU(rn) ( OP(rn)==EXACTFU || OP(rn)==EXACTFU_SS || OP(rn)==EXACTFU_TRICKYFOLD || OP(rn) == EXACTFA)
216 #define IS_TEXTF(rn) ( OP(rn)==EXACTF )
217 #define IS_TEXTFL(rn) ( OP(rn)==EXACTFL )
222 Search for mandatory following text node; for lookahead, the text must
223 follow but for lookbehind (rn->flags != 0) we skip to the next step.
225 #define FIND_NEXT_IMPT(rn) STMT_START { \
226 while (JUMPABLE(rn)) { \
227 const OPCODE type = OP(rn); \
228 if (type == SUSPEND || PL_regkind[type] == CURLY) \
229 rn = NEXTOPER(NEXTOPER(rn)); \
230 else if (type == PLUS) \
232 else if (type == IFMATCH) \
233 rn = (rn->flags == 0) ? NEXTOPER(NEXTOPER(rn)) : rn + ARG(rn); \
234 else rn += NEXT_OFF(rn); \
238 /* These constants are for finding GCB=LV and GCB=LVT in the CLUMP regnode.
239 * These are for the pre-composed Hangul syllables, which are all in a
240 * contiguous block and arranged there in such a way so as to facilitate
241 * alorithmic determination of their characteristics. As such, they don't need
242 * a swash, but can be determined by simple arithmetic. Almost all are
243 * GCB=LVT, but every 28th one is a GCB=LV */
244 #define SBASE 0xAC00 /* Start of block */
245 #define SCount 11172 /* Length of block */
248 static void restore_pos(pTHX_ void *arg);
250 #define REGCP_PAREN_ELEMS 3
251 #define REGCP_OTHER_ELEMS 3
252 #define REGCP_FRAME_ELEMS 1
253 /* REGCP_FRAME_ELEMS are not part of the REGCP_OTHER_ELEMS and
254 * are needed for the regexp context stack bookkeeping. */
257 S_regcppush(pTHX_ const regexp *rex, I32 parenfloor, U32 maxopenparen)
260 const int retval = PL_savestack_ix;
261 const int paren_elems_to_push =
262 (maxopenparen - parenfloor) * REGCP_PAREN_ELEMS;
263 const UV total_elems = paren_elems_to_push + REGCP_OTHER_ELEMS;
264 const UV elems_shifted = total_elems << SAVE_TIGHT_SHIFT;
266 GET_RE_DEBUG_FLAGS_DECL;
268 PERL_ARGS_ASSERT_REGCPPUSH;
270 if (paren_elems_to_push < 0)
271 Perl_croak(aTHX_ "panic: paren_elems_to_push, %i < 0",
272 paren_elems_to_push);
274 if ((elems_shifted >> SAVE_TIGHT_SHIFT) != total_elems)
275 Perl_croak(aTHX_ "panic: paren_elems_to_push offset %"UVuf
276 " out of range (%lu-%ld)",
278 (unsigned long)maxopenparen,
281 SSGROW(total_elems + REGCP_FRAME_ELEMS);
284 if ((int)maxopenparen > (int)parenfloor)
285 PerlIO_printf(Perl_debug_log,
286 "rex=0x%"UVxf" offs=0x%"UVxf": saving capture indices:\n",
291 for (p = parenfloor+1; p <= (I32)maxopenparen; p++) {
292 /* REGCP_PARENS_ELEMS are pushed per pairs of parentheses. */
293 SSPUSHINT(rex->offs[p].end);
294 SSPUSHINT(rex->offs[p].start);
295 SSPUSHINT(rex->offs[p].start_tmp);
296 DEBUG_BUFFERS_r(PerlIO_printf(Perl_debug_log,
297 " \\%"UVuf": %"IVdf"(%"IVdf")..%"IVdf"\n",
299 (IV)rex->offs[p].start,
300 (IV)rex->offs[p].start_tmp,
304 /* REGCP_OTHER_ELEMS are pushed in any case, parentheses or no. */
305 SSPUSHINT(maxopenparen);
306 SSPUSHINT(rex->lastparen);
307 SSPUSHINT(rex->lastcloseparen);
308 SSPUSHUV(SAVEt_REGCONTEXT | elems_shifted); /* Magic cookie. */
313 /* These are needed since we do not localize EVAL nodes: */
314 #define REGCP_SET(cp) \
316 PerlIO_printf(Perl_debug_log, \
317 " Setting an EVAL scope, savestack=%"IVdf"\n", \
318 (IV)PL_savestack_ix)); \
321 #define REGCP_UNWIND(cp) \
323 if (cp != PL_savestack_ix) \
324 PerlIO_printf(Perl_debug_log, \
325 " Clearing an EVAL scope, savestack=%"IVdf"..%"IVdf"\n", \
326 (IV)(cp), (IV)PL_savestack_ix)); \
329 #define UNWIND_PAREN(lp, lcp) \
330 for (n = rex->lastparen; n > lp; n--) \
331 rex->offs[n].end = -1; \
332 rex->lastparen = n; \
333 rex->lastcloseparen = lcp;
337 S_regcppop(pTHX_ regexp *rex, U32 *maxopenparen_p)
342 GET_RE_DEBUG_FLAGS_DECL;
344 PERL_ARGS_ASSERT_REGCPPOP;
346 /* Pop REGCP_OTHER_ELEMS before the parentheses loop starts. */
348 assert((i & SAVE_MASK) == SAVEt_REGCONTEXT); /* Check that the magic cookie is there. */
349 i >>= SAVE_TIGHT_SHIFT; /* Parentheses elements to pop. */
350 rex->lastcloseparen = SSPOPINT;
351 rex->lastparen = SSPOPINT;
352 *maxopenparen_p = SSPOPINT;
354 i -= REGCP_OTHER_ELEMS;
355 /* Now restore the parentheses context. */
357 if (i || rex->lastparen + 1 <= rex->nparens)
358 PerlIO_printf(Perl_debug_log,
359 "rex=0x%"UVxf" offs=0x%"UVxf": restoring capture indices to:\n",
364 paren = *maxopenparen_p;
365 for ( ; i > 0; i -= REGCP_PAREN_ELEMS) {
367 rex->offs[paren].start_tmp = SSPOPINT;
368 rex->offs[paren].start = SSPOPINT;
370 if (paren <= rex->lastparen)
371 rex->offs[paren].end = tmps;
372 DEBUG_BUFFERS_r( PerlIO_printf(Perl_debug_log,
373 " \\%"UVuf": %"IVdf"(%"IVdf")..%"IVdf"%s\n",
375 (IV)rex->offs[paren].start,
376 (IV)rex->offs[paren].start_tmp,
377 (IV)rex->offs[paren].end,
378 (paren > rex->lastparen ? "(skipped)" : ""));
383 /* It would seem that the similar code in regtry()
384 * already takes care of this, and in fact it is in
385 * a better location to since this code can #if 0-ed out
386 * but the code in regtry() is needed or otherwise tests
387 * requiring null fields (pat.t#187 and split.t#{13,14}
388 * (as of patchlevel 7877) will fail. Then again,
389 * this code seems to be necessary or otherwise
390 * this erroneously leaves $1 defined: "1" =~ /^(?:(\d)x)?\d$/
391 * --jhi updated by dapm */
392 for (i = rex->lastparen + 1; i <= rex->nparens; i++) {
393 if (i > *maxopenparen_p)
394 rex->offs[i].start = -1;
395 rex->offs[i].end = -1;
396 DEBUG_BUFFERS_r( PerlIO_printf(Perl_debug_log,
397 " \\%"UVuf": %s ..-1 undeffing\n",
399 (i > *maxopenparen_p) ? "-1" : " "
405 /* restore the parens and associated vars at savestack position ix,
406 * but without popping the stack */
409 S_regcp_restore(pTHX_ regexp *rex, I32 ix, U32 *maxopenparen_p)
411 I32 tmpix = PL_savestack_ix;
412 PL_savestack_ix = ix;
413 regcppop(rex, maxopenparen_p);
414 PL_savestack_ix = tmpix;
417 #define regcpblow(cp) LEAVE_SCOPE(cp) /* Ignores regcppush()ed data. */
420 S_isFOO_lc(pTHX_ const U8 classnum, const U8 character)
422 /* Returns a boolean as to whether or not 'character' is a member of the
423 * Posix character class given by 'classnum' that should be equivalent to a
424 * value in the typedef '_char_class_number'.
426 * Ideally this could be replaced by a just an array of function pointers
427 * to the C library functions that implement the macros this calls.
428 * However, to compile, the precise function signatures are required, and
429 * these may vary from platform to to platform. To avoid having to figure
430 * out what those all are on each platform, I (khw) am using this method,
431 * which adds an extra layer of function call overhead (unless the C
432 * optimizer strips it away). But we don't particularly care about
433 * performance with locales anyway. */
435 switch ((_char_class_number) classnum) {
436 case _CC_ENUM_ALPHANUMERIC: return isALPHANUMERIC_LC(character);
437 case _CC_ENUM_ALPHA: return isALPHA_LC(character);
438 case _CC_ENUM_ASCII: return isASCII_LC(character);
439 case _CC_ENUM_BLANK: return isBLANK_LC(character);
440 case _CC_ENUM_CASED: return isLOWER_LC(character)
441 || isUPPER_LC(character);
442 case _CC_ENUM_CNTRL: return isCNTRL_LC(character);
443 case _CC_ENUM_DIGIT: return isDIGIT_LC(character);
444 case _CC_ENUM_GRAPH: return isGRAPH_LC(character);
445 case _CC_ENUM_LOWER: return isLOWER_LC(character);
446 case _CC_ENUM_PRINT: return isPRINT_LC(character);
447 case _CC_ENUM_PSXSPC: return isPSXSPC_LC(character);
448 case _CC_ENUM_PUNCT: return isPUNCT_LC(character);
449 case _CC_ENUM_SPACE: return isSPACE_LC(character);
450 case _CC_ENUM_UPPER: return isUPPER_LC(character);
451 case _CC_ENUM_WORDCHAR: return isWORDCHAR_LC(character);
452 case _CC_ENUM_XDIGIT: return isXDIGIT_LC(character);
453 default: /* VERTSPACE should never occur in locales */
454 Perl_croak(aTHX_ "panic: isFOO_lc() has an unexpected character class '%d'", classnum);
457 assert(0); /* NOTREACHED */
462 S_isFOO_utf8_lc(pTHX_ const U8 classnum, const U8* character)
464 /* Returns a boolean as to whether or not the (well-formed) UTF-8-encoded
465 * 'character' is a member of the Posix character class given by 'classnum'
466 * that should be equivalent to a value in the typedef
467 * '_char_class_number'.
469 * This just calls isFOO_lc on the code point for the character if it is in
470 * the range 0-255. Outside that range, all characters avoid Unicode
471 * rules, ignoring any locale. So use the Unicode function if this class
472 * requires a swash, and use the Unicode macro otherwise. */
474 PERL_ARGS_ASSERT_ISFOO_UTF8_LC;
476 if (UTF8_IS_INVARIANT(*character)) {
477 return isFOO_lc(classnum, *character);
479 else if (UTF8_IS_DOWNGRADEABLE_START(*character)) {
480 return isFOO_lc(classnum,
481 TWO_BYTE_UTF8_TO_UNI(*character, *(character + 1)));
484 if (classnum < _FIRST_NON_SWASH_CC) {
486 /* Initialize the swash unless done already */
487 if (! PL_utf8_swash_ptrs[classnum]) {
488 U8 flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;
489 PL_utf8_swash_ptrs[classnum] = _core_swash_init("utf8",
490 swash_property_names[classnum], &PL_sv_undef, 1, 0, NULL, &flags);
493 return cBOOL(swash_fetch(PL_utf8_swash_ptrs[classnum], (U8 *)
495 TRUE /* is UTF */ ));
498 switch ((_char_class_number) classnum) {
500 case _CC_ENUM_PSXSPC: return is_XPERLSPACE_high(character);
502 case _CC_ENUM_BLANK: return is_HORIZWS_high(character);
503 case _CC_ENUM_XDIGIT: return is_XDIGIT_high(character);
504 case _CC_ENUM_VERTSPACE: return is_VERTWS_high(character);
505 default: return 0; /* Things like CNTRL are always
509 assert(0); /* NOTREACHED */
514 * pregexec and friends
517 #ifndef PERL_IN_XSUB_RE
519 - pregexec - match a regexp against a string
522 Perl_pregexec(pTHX_ REGEXP * const prog, char* stringarg, char *strend,
523 char *strbeg, I32 minend, SV *screamer, U32 nosave)
524 /* stringarg: the point in the string at which to begin matching */
525 /* strend: pointer to null at end of string */
526 /* strbeg: real beginning of string */
527 /* minend: end of match must be >= minend bytes after stringarg. */
528 /* screamer: SV being matched: only used for utf8 flag, pos() etc; string
529 * itself is accessed via the pointers above */
530 /* nosave: For optimizations. */
532 PERL_ARGS_ASSERT_PREGEXEC;
535 regexec_flags(prog, stringarg, strend, strbeg, minend, screamer, NULL,
536 nosave ? 0 : REXEC_COPY_STR);
541 * Need to implement the following flags for reg_anch:
543 * USE_INTUIT_NOML - Useful to call re_intuit_start() first
545 * INTUIT_AUTORITATIVE_NOML - Can trust a positive answer
546 * INTUIT_AUTORITATIVE_ML
547 * INTUIT_ONCE_NOML - Intuit can match in one location only.
550 * Another flag for this function: SECOND_TIME (so that float substrs
551 * with giant delta may be not rechecked).
554 /* Assumptions: if ANCH_GPOS, then strpos is anchored. XXXX Check GPOS logic */
556 /* If SCREAM, then SvPVX_const(sv) should be compatible with strpos and strend.
557 Otherwise, only SvCUR(sv) is used to get strbeg. */
559 /* XXXX We assume that strpos is strbeg unless sv. */
561 /* XXXX Some places assume that there is a fixed substring.
562 An update may be needed if optimizer marks as "INTUITable"
563 RExen without fixed substrings. Similarly, it is assumed that
564 lengths of all the strings are no more than minlen, thus they
565 cannot come from lookahead.
566 (Or minlen should take into account lookahead.)
567 NOTE: Some of this comment is not correct. minlen does now take account
568 of lookahead/behind. Further research is required. -- demerphq
572 /* A failure to find a constant substring means that there is no need to make
573 an expensive call to REx engine, thus we celebrate a failure. Similarly,
574 finding a substring too deep into the string means that fewer calls to
575 regtry() should be needed.
577 REx compiler's optimizer found 4 possible hints:
578 a) Anchored substring;
580 c) Whether we are anchored (beginning-of-line or \G);
581 d) First node (of those at offset 0) which may distinguish positions;
582 We use a)b)d) and multiline-part of c), and try to find a position in the
583 string which does not contradict any of them.
586 /* Most of decisions we do here should have been done at compile time.
587 The nodes of the REx which we used for the search should have been
588 deleted from the finite automaton. */
591 Perl_re_intuit_start(pTHX_ REGEXP * const rx, SV *sv, char *strpos,
592 char *strend, const U32 flags, re_scream_pos_data *data)
595 struct regexp *const prog = ReANY(rx);
597 /* Should be nonnegative! */
603 const bool utf8_target = (sv && SvUTF8(sv)) ? 1 : 0; /* if no sv we have to assume bytes */
605 char *other_last = NULL; /* other substr checked before this */
606 char *check_at = NULL; /* check substr found at this pos */
607 char *checked_upto = NULL; /* how far into the string we have already checked using find_byclass*/
608 const I32 multiline = prog->extflags & RXf_PMf_MULTILINE;
609 RXi_GET_DECL(prog,progi);
612 const char * const i_strpos = strpos;
614 GET_RE_DEBUG_FLAGS_DECL;
616 PERL_ARGS_ASSERT_RE_INTUIT_START;
617 PERL_UNUSED_ARG(flags);
618 PERL_UNUSED_ARG(data);
620 RX_MATCH_UTF8_set(rx,utf8_target);
622 is_utf8_pat = cBOOL(RX_UTF8(rx));
625 debug_start_match(rx, utf8_target, strpos, strend,
626 sv ? "Guessing start of match in sv for"
627 : "Guessing start of match in string for");
630 /* CHR_DIST() would be more correct here but it makes things slow. */
631 if (prog->minlen > strend - strpos) {
632 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
633 "String too short... [re_intuit_start]\n"));
637 /* XXX we need to pass strbeg as a separate arg: the following is
638 * guesswork and can be wrong... */
639 if (sv && SvPOK(sv)) {
640 char * p = SvPVX(sv);
641 STRLEN cur = SvCUR(sv);
642 if (p <= strpos && strpos < p + cur) {
644 assert(p <= strend && strend <= p + cur);
647 strbeg = strend - cur;
654 if (!prog->check_utf8 && prog->check_substr)
655 to_utf8_substr(prog);
656 check = prog->check_utf8;
658 if (!prog->check_substr && prog->check_utf8) {
659 if (! to_byte_substr(prog)) {
660 NON_UTF8_TARGET_BUT_UTF8_REQUIRED(fail);
663 check = prog->check_substr;
665 if (prog->extflags & RXf_ANCH) { /* Match at beg-of-str or after \n */
666 ml_anch = !( (prog->extflags & RXf_ANCH_SINGLE)
667 || ( (prog->extflags & RXf_ANCH_BOL)
668 && !multiline ) ); /* Check after \n? */
671 if ( !(prog->extflags & RXf_ANCH_GPOS) /* Checked by the caller */
672 && !(prog->intflags & PREGf_IMPLICIT) /* not a real BOL */
673 /* SvCUR is not set on references: SvRV and SvPVX_const overlap */
675 && (strpos != strbeg)) {
676 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Not at start...\n"));
679 if (prog->check_offset_min == prog->check_offset_max
680 && !(prog->extflags & RXf_CANY_SEEN)
681 && ! multiline) /* /m can cause \n's to match that aren't
682 accounted for in the string max length.
683 See [perl #115242] */
685 /* Substring at constant offset from beg-of-str... */
688 s = HOP3c(strpos, prog->check_offset_min, strend);
691 slen = SvCUR(check); /* >= 1 */
693 if ( strend - s > slen || strend - s < slen - 1
694 || (strend - s == slen && strend[-1] != '\n')) {
695 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "String too long...\n"));
698 /* Now should match s[0..slen-2] */
700 if (slen && (*SvPVX_const(check) != *s
702 && memNE(SvPVX_const(check), s, slen)))) {
704 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "String not equal...\n"));
708 else if (*SvPVX_const(check) != *s
709 || ((slen = SvCUR(check)) > 1
710 && memNE(SvPVX_const(check), s, slen)))
713 goto success_at_start;
716 /* Match is anchored, but substr is not anchored wrt beg-of-str. */
718 start_shift = prog->check_offset_min; /* okay to underestimate on CC */
719 end_shift = prog->check_end_shift;
722 const I32 end = prog->check_offset_max + CHR_SVLEN(check)
723 - (SvTAIL(check) != 0);
724 const I32 eshift = CHR_DIST((U8*)strend, (U8*)s) - end;
726 if (end_shift < eshift)
730 else { /* Can match at random position */
733 start_shift = prog->check_offset_min; /* okay to underestimate on CC */
734 end_shift = prog->check_end_shift;
736 /* end shift should be non negative here */
739 #ifdef QDEBUGGING /* 7/99: reports of failure (with the older version) */
741 Perl_croak(aTHX_ "panic: end_shift: %"IVdf" pattern:\n%s\n ",
742 (IV)end_shift, RX_PRECOMP(prog));
746 /* Find a possible match in the region s..strend by looking for
747 the "check" substring in the region corrected by start/end_shift. */
750 I32 srch_start_shift = start_shift;
751 I32 srch_end_shift = end_shift;
754 if (srch_start_shift < 0 && strbeg - s > srch_start_shift) {
755 srch_end_shift -= ((strbeg - s) - srch_start_shift);
756 srch_start_shift = strbeg - s;
758 DEBUG_OPTIMISE_MORE_r({
759 PerlIO_printf(Perl_debug_log, "Check offset min: %"IVdf" Start shift: %"IVdf" End shift %"IVdf" Real End Shift: %"IVdf"\n",
760 (IV)prog->check_offset_min,
761 (IV)srch_start_shift,
763 (IV)prog->check_end_shift);
766 if (prog->extflags & RXf_CANY_SEEN) {
767 start_point= (U8*)(s + srch_start_shift);
768 end_point= (U8*)(strend - srch_end_shift);
770 start_point= HOP3(s, srch_start_shift, srch_start_shift < 0 ? strbeg : strend);
771 end_point= HOP3(strend, -srch_end_shift, strbeg);
773 DEBUG_OPTIMISE_MORE_r({
774 PerlIO_printf(Perl_debug_log, "fbm_instr len=%d str=<%.*s>\n",
775 (int)(end_point - start_point),
776 (int)(end_point - start_point) > 20 ? 20 : (int)(end_point - start_point),
780 s = fbm_instr( start_point, end_point,
781 check, multiline ? FBMrf_MULTILINE : 0);
783 /* Update the count-of-usability, remove useless subpatterns,
787 RE_PV_QUOTED_DECL(quoted, utf8_target, PERL_DEBUG_PAD_ZERO(0),
788 SvPVX_const(check), RE_SV_DUMPLEN(check), 30);
789 PerlIO_printf(Perl_debug_log, "%s %s substr %s%s%s",
790 (s ? "Found" : "Did not find"),
791 (check == (utf8_target ? prog->anchored_utf8 : prog->anchored_substr)
792 ? "anchored" : "floating"),
795 (s ? " at offset " : "...\n") );
800 /* Finish the diagnostic message */
801 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "%ld...\n", (long)(s - i_strpos)) );
803 /* XXX dmq: first branch is for positive lookbehind...
804 Our check string is offset from the beginning of the pattern.
805 So we need to do any stclass tests offset forward from that
814 /* Got a candidate. Check MBOL anchoring, and the *other* substr.
815 Start with the other substr.
816 XXXX no SCREAM optimization yet - and a very coarse implementation
817 XXXX /ttx+/ results in anchored="ttx", floating="x". floating will
818 *always* match. Probably should be marked during compile...
819 Probably it is right to do no SCREAM here...
822 if (utf8_target ? (prog->float_utf8 && prog->anchored_utf8)
823 : (prog->float_substr && prog->anchored_substr))
825 /* Take into account the "other" substring. */
826 /* XXXX May be hopelessly wrong for UTF... */
829 if (check == (utf8_target ? prog->float_utf8 : prog->float_substr)) {
832 char * const last = HOP3c(s, -start_shift, strbeg);
834 char * const saved_s = s;
837 t = s - prog->check_offset_max;
838 if (s - strpos > prog->check_offset_max /* signed-corrected t > strpos */
840 || ((t = (char*)reghopmaybe3((U8*)s, -(prog->check_offset_max), (U8*)strpos))
845 t = HOP3c(t, prog->anchored_offset, strend);
846 if (t < other_last) /* These positions already checked */
848 last2 = last1 = HOP3c(strend, -prog->minlen, strbeg);
851 /* XXXX It is not documented what units *_offsets are in.
852 We assume bytes, but this is clearly wrong.
853 Meaning this code needs to be carefully reviewed for errors.
857 /* On end-of-str: see comment below. */
858 must = utf8_target ? prog->anchored_utf8 : prog->anchored_substr;
859 if (must == &PL_sv_undef) {
861 DEBUG_r(must = prog->anchored_utf8); /* for debug */
866 HOP3(HOP3(last1, prog->anchored_offset, strend)
867 + SvCUR(must), -(SvTAIL(must)!=0), strbeg),
869 multiline ? FBMrf_MULTILINE : 0
872 RE_PV_QUOTED_DECL(quoted, utf8_target, PERL_DEBUG_PAD_ZERO(0),
873 SvPVX_const(must), RE_SV_DUMPLEN(must), 30);
874 PerlIO_printf(Perl_debug_log, "%s anchored substr %s%s",
875 (s ? "Found" : "Contradicts"),
876 quoted, RE_SV_TAIL(must));
881 if (last1 >= last2) {
882 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
883 ", giving up...\n"));
886 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
887 ", trying floating at offset %ld...\n",
888 (long)(HOP3c(saved_s, 1, strend) - i_strpos)));
889 other_last = HOP3c(last1, prog->anchored_offset+1, strend);
890 s = HOP3c(last, 1, strend);
894 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, " at offset %ld...\n",
895 (long)(s - i_strpos)));
896 t = HOP3c(s, -prog->anchored_offset, strbeg);
897 other_last = HOP3c(s, 1, strend);
905 else { /* Take into account the floating substring. */
907 char * const saved_s = s;
910 t = HOP3c(s, -start_shift, strbeg);
912 HOP3c(strend, -prog->minlen + prog->float_min_offset, strbeg);
913 if (CHR_DIST((U8*)last, (U8*)t) > prog->float_max_offset)
914 last = HOP3c(t, prog->float_max_offset, strend);
915 s = HOP3c(t, prog->float_min_offset, strend);
918 /* XXXX It is not documented what units *_offsets are in. Assume bytes. */
919 must = utf8_target ? prog->float_utf8 : prog->float_substr;
920 /* fbm_instr() takes into account exact value of end-of-str
921 if the check is SvTAIL(ed). Since false positives are OK,
922 and end-of-str is not later than strend we are OK. */
923 if (must == &PL_sv_undef) {
925 DEBUG_r(must = prog->float_utf8); /* for debug message */
928 s = fbm_instr((unsigned char*)s,
929 (unsigned char*)last + SvCUR(must)
931 must, multiline ? FBMrf_MULTILINE : 0);
933 RE_PV_QUOTED_DECL(quoted, utf8_target, PERL_DEBUG_PAD_ZERO(0),
934 SvPVX_const(must), RE_SV_DUMPLEN(must), 30);
935 PerlIO_printf(Perl_debug_log, "%s floating substr %s%s",
936 (s ? "Found" : "Contradicts"),
937 quoted, RE_SV_TAIL(must));
941 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
942 ", giving up...\n"));
945 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
946 ", trying anchored starting at offset %ld...\n",
947 (long)(saved_s + 1 - i_strpos)));
949 s = HOP3c(t, 1, strend);
953 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, " at offset %ld...\n",
954 (long)(s - i_strpos)));
955 other_last = s; /* Fix this later. --Hugo */
965 t= (char*)HOP3( s, -prog->check_offset_max, (prog->check_offset_max<0) ? strend : strpos);
967 DEBUG_OPTIMISE_MORE_r(
968 PerlIO_printf(Perl_debug_log,
969 "Check offset min:%"IVdf" max:%"IVdf" S:%"IVdf" t:%"IVdf" D:%"IVdf" end:%"IVdf"\n",
970 (IV)prog->check_offset_min,
971 (IV)prog->check_offset_max,
979 if (s - strpos > prog->check_offset_max /* signed-corrected t > strpos */
981 || ((t = (char*)reghopmaybe3((U8*)s, -prog->check_offset_max, (U8*) ((prog->check_offset_max<0) ? strend : strpos)))
984 /* Fixed substring is found far enough so that the match
985 cannot start at strpos. */
987 if (ml_anch && t[-1] != '\n') {
988 /* Eventually fbm_*() should handle this, but often
989 anchored_offset is not 0, so this check will not be wasted. */
990 /* XXXX In the code below we prefer to look for "^" even in
991 presence of anchored substrings. And we search even
992 beyond the found float position. These pessimizations
993 are historical artefacts only. */
995 while (t < strend - prog->minlen) {
997 if (t < check_at - prog->check_offset_min) {
998 if (utf8_target ? prog->anchored_utf8 : prog->anchored_substr) {
999 /* Since we moved from the found position,
1000 we definitely contradict the found anchored
1001 substr. Due to the above check we do not
1002 contradict "check" substr.
1003 Thus we can arrive here only if check substr
1004 is float. Redo checking for "other"=="fixed".
1007 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Found /%s^%s/m at offset %ld, rescanning for anchored from offset %ld...\n",
1008 PL_colors[0], PL_colors[1], (long)(strpos - i_strpos), (long)(strpos - i_strpos + prog->anchored_offset)));
1009 goto do_other_anchored;
1011 /* We don't contradict the found floating substring. */
1012 /* XXXX Why not check for STCLASS? */
1014 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Found /%s^%s/m at offset %ld...\n",
1015 PL_colors[0], PL_colors[1], (long)(s - i_strpos)));
1018 /* Position contradicts check-string */
1019 /* XXXX probably better to look for check-string
1020 than for "\n", so one should lower the limit for t? */
1021 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Found /%s^%s/m, restarting lookup for check-string at offset %ld...\n",
1022 PL_colors[0], PL_colors[1], (long)(t + 1 - i_strpos)));
1023 other_last = strpos = s = t + 1;
1028 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Did not find /%s^%s/m...\n",
1029 PL_colors[0], PL_colors[1]));
1033 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Starting position does not contradict /%s^%s/m...\n",
1034 PL_colors[0], PL_colors[1]));
1038 ++BmUSEFUL(utf8_target ? prog->check_utf8 : prog->check_substr); /* hooray/5 */
1041 /* The found string does not prohibit matching at strpos,
1042 - no optimization of calling REx engine can be performed,
1043 unless it was an MBOL and we are not after MBOL,
1044 or a future STCLASS check will fail this. */
1046 /* Even in this situation we may use MBOL flag if strpos is offset
1047 wrt the start of the string. */
1048 if (ml_anch && sv && !SvROK(sv) /* See prev comment on SvROK */
1049 && (strpos != strbeg) && strpos[-1] != '\n'
1050 /* May be due to an implicit anchor of m{.*foo} */
1051 && !(prog->intflags & PREGf_IMPLICIT))
1056 DEBUG_EXECUTE_r( if (ml_anch)
1057 PerlIO_printf(Perl_debug_log, "Position at offset %ld does not contradict /%s^%s/m...\n",
1058 (long)(strpos - i_strpos), PL_colors[0], PL_colors[1]);
1061 if (!(prog->intflags & PREGf_NAUGHTY) /* XXXX If strpos moved? */
1063 prog->check_utf8 /* Could be deleted already */
1064 && --BmUSEFUL(prog->check_utf8) < 0
1065 && (prog->check_utf8 == prog->float_utf8)
1067 prog->check_substr /* Could be deleted already */
1068 && --BmUSEFUL(prog->check_substr) < 0
1069 && (prog->check_substr == prog->float_substr)
1072 /* If flags & SOMETHING - do not do it many times on the same match */
1073 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "... Disabling check substring...\n"));
1074 /* XXX Does the destruction order has to change with utf8_target? */
1075 SvREFCNT_dec(utf8_target ? prog->check_utf8 : prog->check_substr);
1076 SvREFCNT_dec(utf8_target ? prog->check_substr : prog->check_utf8);
1077 prog->check_substr = prog->check_utf8 = NULL; /* disable */
1078 prog->float_substr = prog->float_utf8 = NULL; /* clear */
1079 check = NULL; /* abort */
1081 /* XXXX If the check string was an implicit check MBOL, then we need to unset the relevant flag
1082 see http://bugs.activestate.com/show_bug.cgi?id=87173 */
1083 if (prog->intflags & PREGf_IMPLICIT)
1084 prog->extflags &= ~RXf_ANCH_MBOL;
1085 /* XXXX This is a remnant of the old implementation. It
1086 looks wasteful, since now INTUIT can use many
1087 other heuristics. */
1088 prog->extflags &= ~RXf_USE_INTUIT;
1089 /* XXXX What other flags might need to be cleared in this branch? */
1095 /* Last resort... */
1096 /* XXXX BmUSEFUL already changed, maybe multiple change is meaningful... */
1097 /* trie stclasses are too expensive to use here, we are better off to
1098 leave it to regmatch itself */
1099 if (progi->regstclass && PL_regkind[OP(progi->regstclass)]!=TRIE) {
1100 /* minlen == 0 is possible if regstclass is \b or \B,
1101 and the fixed substr is ''$.
1102 Since minlen is already taken into account, s+1 is before strend;
1103 accidentally, minlen >= 1 guaranties no false positives at s + 1
1104 even for \b or \B. But (minlen? 1 : 0) below assumes that
1105 regstclass does not come from lookahead... */
1106 /* If regstclass takes bytelength more than 1: If charlength==1, OK.
1107 This leaves EXACTF-ish only, which are dealt with in find_byclass(). */
1108 const U8* const str = (U8*)STRING(progi->regstclass);
1109 const int cl_l = (PL_regkind[OP(progi->regstclass)] == EXACT
1110 ? CHR_DIST(str+STR_LEN(progi->regstclass), str)
1113 if (prog->anchored_substr || prog->anchored_utf8 || ml_anch)
1114 endpos= HOP3c(s, (prog->minlen ? cl_l : 0), strend);
1115 else if (prog->float_substr || prog->float_utf8)
1116 endpos= HOP3c(HOP3c(check_at, -start_shift, strbeg), cl_l, strend);
1120 if (checked_upto < s)
1122 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "start_shift: %"IVdf" check_at: %"IVdf" s: %"IVdf" endpos: %"IVdf" checked_upto: %"IVdf"\n",
1123 (IV)start_shift, (IV)(check_at - strbeg), (IV)(s - strbeg), (IV)(endpos - strbeg), (IV)(checked_upto- strbeg)));
1126 s = find_byclass(prog, progi->regstclass, checked_upto, endpos,
1132 const char *what = NULL;
1134 if (endpos == strend) {
1135 DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
1136 "Could not match STCLASS...\n") );
1139 DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
1140 "This position contradicts STCLASS...\n") );
1141 if ((prog->extflags & RXf_ANCH) && !ml_anch)
1143 checked_upto = HOPBACKc(endpos, start_shift);
1144 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "start_shift: %"IVdf" check_at: %"IVdf" endpos: %"IVdf" checked_upto: %"IVdf"\n",
1145 (IV)start_shift, (IV)(check_at - strbeg), (IV)(endpos - strbeg), (IV)(checked_upto- strbeg)));
1146 /* Contradict one of substrings */
1147 if (prog->anchored_substr || prog->anchored_utf8) {
1148 if ((utf8_target ? prog->anchored_utf8 : prog->anchored_substr) == check) {
1149 DEBUG_EXECUTE_r( what = "anchored" );
1151 s = HOP3c(t, 1, strend);
1152 if (s + start_shift + end_shift > strend) {
1153 /* XXXX Should be taken into account earlier? */
1154 DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
1155 "Could not match STCLASS...\n") );
1160 DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
1161 "Looking for %s substr starting at offset %ld...\n",
1162 what, (long)(s + start_shift - i_strpos)) );
1165 /* Have both, check_string is floating */
1166 if (t + start_shift >= check_at) /* Contradicts floating=check */
1167 goto retry_floating_check;
1168 /* Recheck anchored substring, but not floating... */
1172 DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
1173 "Looking for anchored substr starting at offset %ld...\n",
1174 (long)(other_last - i_strpos)) );
1175 goto do_other_anchored;
1177 /* Another way we could have checked stclass at the
1178 current position only: */
1183 DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
1184 "Looking for /%s^%s/m starting at offset %ld...\n",
1185 PL_colors[0], PL_colors[1], (long)(t - i_strpos)) );
1188 if (!(utf8_target ? prog->float_utf8 : prog->float_substr)) /* Could have been deleted */
1190 /* Check is floating substring. */
1191 retry_floating_check:
1192 t = check_at - start_shift;
1193 DEBUG_EXECUTE_r( what = "floating" );
1194 goto hop_and_restart;
1197 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
1198 "By STCLASS: moving %ld --> %ld\n",
1199 (long)(t - i_strpos), (long)(s - i_strpos))
1203 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
1204 "Does not contradict STCLASS...\n");
1209 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "%s%s:%s match at offset %ld\n",
1210 PL_colors[4], (check ? "Guessed" : "Giving up"),
1211 PL_colors[5], (long)(s - i_strpos)) );
1214 fail_finish: /* Substring not found */
1215 if (prog->check_substr || prog->check_utf8) /* could be removed already */
1216 BmUSEFUL(utf8_target ? prog->check_utf8 : prog->check_substr) += 5; /* hooray */
1218 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "%sMatch rejected by optimizer%s\n",
1219 PL_colors[4], PL_colors[5]));
1223 #define DECL_TRIE_TYPE(scan) \
1224 const enum { trie_plain, trie_utf8, trie_utf8_fold, trie_latin_utf8_fold } \
1225 trie_type = ((scan->flags == EXACT) \
1226 ? (utf8_target ? trie_utf8 : trie_plain) \
1227 : (utf8_target ? trie_utf8_fold : trie_latin_utf8_fold))
1229 #define REXEC_TRIE_READ_CHAR(trie_type, trie, widecharmap, uc, uscan, len, uvc, charid, foldlen, foldbuf, uniflags) \
1232 switch (trie_type) { \
1233 case trie_utf8_fold: \
1234 if ( foldlen>0 ) { \
1235 uvc = utf8n_to_uvuni( (const U8*) uscan, UTF8_MAXLEN, &len, uniflags ); \
1240 uvc = to_utf8_fold( (const U8*) uc, foldbuf, &foldlen ); \
1241 len = UTF8SKIP(uc); \
1242 skiplen = UNISKIP( uvc ); \
1243 foldlen -= skiplen; \
1244 uscan = foldbuf + skiplen; \
1247 case trie_latin_utf8_fold: \
1248 if ( foldlen>0 ) { \
1249 uvc = utf8n_to_uvuni( (const U8*) uscan, UTF8_MAXLEN, &len, uniflags ); \
1255 uvc = _to_fold_latin1( (U8) *uc, foldbuf, &foldlen, 1); \
1256 skiplen = UNISKIP( uvc ); \
1257 foldlen -= skiplen; \
1258 uscan = foldbuf + skiplen; \
1262 uvc = utf8n_to_uvuni( (const U8*) uc, UTF8_MAXLEN, &len, uniflags ); \
1269 charid = trie->charmap[ uvc ]; \
1273 if (widecharmap) { \
1274 SV** const svpp = hv_fetch(widecharmap, \
1275 (char*)&uvc, sizeof(UV), 0); \
1277 charid = (U16)SvIV(*svpp); \
1282 #define REXEC_FBC_EXACTISH_SCAN(CoNd) \
1286 && (ln == 1 || folder(s, pat_string, ln)) \
1287 && (!reginfo || regtry(reginfo, &s)) ) \
1293 #define REXEC_FBC_UTF8_SCAN(CoDe) \
1295 while (s < strend) { \
1301 #define REXEC_FBC_SCAN(CoDe) \
1303 while (s < strend) { \
1309 #define REXEC_FBC_UTF8_CLASS_SCAN(CoNd) \
1310 REXEC_FBC_UTF8_SCAN( \
1312 if (tmp && (!reginfo || regtry(reginfo, &s))) \
1321 #define REXEC_FBC_CLASS_SCAN(CoNd) \
1324 if (tmp && (!reginfo || regtry(reginfo, &s))) \
1333 #define REXEC_FBC_TRYIT \
1334 if ((!reginfo || regtry(reginfo, &s))) \
1337 #define REXEC_FBC_CSCAN(CoNdUtF8,CoNd) \
1338 if (utf8_target) { \
1339 REXEC_FBC_UTF8_CLASS_SCAN(CoNdUtF8); \
1342 REXEC_FBC_CLASS_SCAN(CoNd); \
1345 #define DUMP_EXEC_POS(li,s,doutf8) \
1346 dump_exec_pos(li,s,(PL_regeol),(PL_bostr),(PL_reg_starttry),doutf8)
1349 #define UTF8_NOLOAD(TEST_NON_UTF8, IF_SUCCESS, IF_FAIL) \
1350 tmp = (s != PL_bostr) ? UCHARAT(s - 1) : '\n'; \
1351 tmp = TEST_NON_UTF8(tmp); \
1352 REXEC_FBC_UTF8_SCAN( \
1353 if (tmp == ! TEST_NON_UTF8((U8) *s)) { \
1362 #define UTF8_LOAD(TeSt1_UtF8, TeSt2_UtF8, IF_SUCCESS, IF_FAIL) \
1363 if (s == PL_bostr) { \
1367 U8 * const r = reghop3((U8*)s, -1, (U8*)PL_bostr); \
1368 tmp = utf8n_to_uvchr(r, UTF8SKIP(r), 0, UTF8_ALLOW_DEFAULT); \
1371 LOAD_UTF8_CHARCLASS_ALNUM(); \
1372 REXEC_FBC_UTF8_SCAN( \
1373 if (tmp == ! (TeSt2_UtF8)) { \
1382 /* The only difference between the BOUND and NBOUND cases is that
1383 * REXEC_FBC_TRYIT is called when matched in BOUND, and when non-matched in
1384 * NBOUND. This is accomplished by passing it in either the if or else clause,
1385 * with the other one being empty */
1386 #define FBC_BOUND(TEST_NON_UTF8, TEST1_UTF8, TEST2_UTF8) \
1387 FBC_BOUND_COMMON(UTF8_LOAD(TEST1_UTF8, TEST2_UTF8, REXEC_FBC_TRYIT, PLACEHOLDER), TEST_NON_UTF8, REXEC_FBC_TRYIT, PLACEHOLDER)
1389 #define FBC_BOUND_NOLOAD(TEST_NON_UTF8, TEST1_UTF8, TEST2_UTF8) \
1390 FBC_BOUND_COMMON(UTF8_NOLOAD(TEST_NON_UTF8, REXEC_FBC_TRYIT, PLACEHOLDER), TEST_NON_UTF8, REXEC_FBC_TRYIT, PLACEHOLDER)
1392 #define FBC_NBOUND(TEST_NON_UTF8, TEST1_UTF8, TEST2_UTF8) \
1393 FBC_BOUND_COMMON(UTF8_LOAD(TEST1_UTF8, TEST2_UTF8, PLACEHOLDER, REXEC_FBC_TRYIT), TEST_NON_UTF8, PLACEHOLDER, REXEC_FBC_TRYIT)
1395 #define FBC_NBOUND_NOLOAD(TEST_NON_UTF8, TEST1_UTF8, TEST2_UTF8) \
1396 FBC_BOUND_COMMON(UTF8_NOLOAD(TEST_NON_UTF8, PLACEHOLDER, REXEC_FBC_TRYIT), TEST_NON_UTF8, PLACEHOLDER, REXEC_FBC_TRYIT)
1399 /* Common to the BOUND and NBOUND cases. Unfortunately the UTF8 tests need to
1400 * be passed in completely with the variable name being tested, which isn't
1401 * such a clean interface, but this is easier to read than it was before. We
1402 * are looking for the boundary (or non-boundary between a word and non-word
1403 * character. The utf8 and non-utf8 cases have the same logic, but the details
1404 * must be different. Find the "wordness" of the character just prior to this
1405 * one, and compare it with the wordness of this one. If they differ, we have
1406 * a boundary. At the beginning of the string, pretend that the previous
1407 * character was a new-line */
1408 #define FBC_BOUND_COMMON(UTF8_CODE, TEST_NON_UTF8, IF_SUCCESS, IF_FAIL) \
1409 if (utf8_target) { \
1412 else { /* Not utf8 */ \
1413 tmp = (s != PL_bostr) ? UCHARAT(s - 1) : '\n'; \
1414 tmp = TEST_NON_UTF8(tmp); \
1416 if (tmp == ! TEST_NON_UTF8((U8) *s)) { \
1425 if ((!prog->minlen && tmp) && (!reginfo || regtry(reginfo, &s))) \
1428 /* We know what class REx starts with. Try to find this position... */
1429 /* if reginfo is NULL, its a dryrun */
1430 /* annoyingly all the vars in this routine have different names from their counterparts
1431 in regmatch. /grrr */
1434 S_find_byclass(pTHX_ regexp * prog, const regnode *c, char *s,
1435 const char *strend, regmatch_info *reginfo, bool is_utf8_pat)
1438 const I32 doevery = (prog->intflags & PREGf_SKIP) == 0;
1439 char *pat_string; /* The pattern's exactish string */
1440 char *pat_end; /* ptr to end char of pat_string */
1441 re_fold_t folder; /* Function for computing non-utf8 folds */
1442 const U8 *fold_array; /* array for folding ords < 256 */
1448 I32 tmp = 1; /* Scratch variable? */
1449 const bool utf8_target = PL_reg_match_utf8;
1450 UV utf8_fold_flags = 0;
1451 bool to_complement = FALSE; /* Invert the result? Taking the xor of this
1452 with a result inverts that result, as 0^1 =
1454 _char_class_number classnum;
1456 RXi_GET_DECL(prog,progi);
1458 PERL_ARGS_ASSERT_FIND_BYCLASS;
1460 /* We know what class it must start with. */
1463 case ANYOF_SYNTHETIC:
1464 case ANYOF_WARN_SUPER:
1466 REXEC_FBC_UTF8_CLASS_SCAN(
1467 reginclass(prog, c, (U8*)s, utf8_target));
1470 REXEC_FBC_CLASS_SCAN(REGINCLASS(prog, c, (U8*)s));
1475 if (tmp && (!reginfo || regtry(reginfo, &s)))
1483 if (is_utf8_pat || utf8_target) {
1484 utf8_fold_flags = FOLDEQ_UTF8_NOMIX_ASCII;
1485 goto do_exactf_utf8;
1487 fold_array = PL_fold_latin1; /* Latin1 folds are not affected by */
1488 folder = foldEQ_latin1; /* /a, except the sharp s one which */
1489 goto do_exactf_non_utf8; /* isn't dealt with by these */
1494 /* regcomp.c already folded this if pattern is in UTF-8 */
1495 utf8_fold_flags = 0;
1496 goto do_exactf_utf8;
1498 fold_array = PL_fold;
1500 goto do_exactf_non_utf8;
1503 if (is_utf8_pat || utf8_target) {
1504 utf8_fold_flags = FOLDEQ_UTF8_LOCALE;
1505 goto do_exactf_utf8;
1507 fold_array = PL_fold_locale;
1508 folder = foldEQ_locale;
1509 goto do_exactf_non_utf8;
1513 utf8_fold_flags = FOLDEQ_S2_ALREADY_FOLDED;
1515 goto do_exactf_utf8;
1517 case EXACTFU_TRICKYFOLD:
1519 if (is_utf8_pat || utf8_target) {
1520 utf8_fold_flags = is_utf8_pat ? FOLDEQ_S2_ALREADY_FOLDED : 0;
1521 goto do_exactf_utf8;
1524 /* Any 'ss' in the pattern should have been replaced by regcomp,
1525 * so we don't have to worry here about this single special case
1526 * in the Latin1 range */
1527 fold_array = PL_fold_latin1;
1528 folder = foldEQ_latin1;
1532 do_exactf_non_utf8: /* Neither pattern nor string are UTF8, and there
1533 are no glitches with fold-length differences
1534 between the target string and pattern */
1536 /* The idea in the non-utf8 EXACTF* cases is to first find the
1537 * first character of the EXACTF* node and then, if necessary,
1538 * case-insensitively compare the full text of the node. c1 is the
1539 * first character. c2 is its fold. This logic will not work for
1540 * Unicode semantics and the german sharp ss, which hence should
1541 * not be compiled into a node that gets here. */
1542 pat_string = STRING(c);
1543 ln = STR_LEN(c); /* length to match in octets/bytes */
1545 /* We know that we have to match at least 'ln' bytes (which is the
1546 * same as characters, since not utf8). If we have to match 3
1547 * characters, and there are only 2 availabe, we know without
1548 * trying that it will fail; so don't start a match past the
1549 * required minimum number from the far end */
1550 e = HOP3c(strend, -((I32)ln), s);
1552 if (!reginfo && e < s) {
1553 e = s; /* Due to minlen logic of intuit() */
1557 c2 = fold_array[c1];
1558 if (c1 == c2) { /* If char and fold are the same */
1559 REXEC_FBC_EXACTISH_SCAN(*(U8*)s == c1);
1562 REXEC_FBC_EXACTISH_SCAN(*(U8*)s == c1 || *(U8*)s == c2);
1570 /* If one of the operands is in utf8, we can't use the simpler folding
1571 * above, due to the fact that many different characters can have the
1572 * same fold, or portion of a fold, or different- length fold */
1573 pat_string = STRING(c);
1574 ln = STR_LEN(c); /* length to match in octets/bytes */
1575 pat_end = pat_string + ln;
1576 lnc = is_utf8_pat /* length to match in characters */
1577 ? utf8_length((U8 *) pat_string, (U8 *) pat_end)
1580 /* We have 'lnc' characters to match in the pattern, but because of
1581 * multi-character folding, each character in the target can match
1582 * up to 3 characters (Unicode guarantees it will never exceed
1583 * this) if it is utf8-encoded; and up to 2 if not (based on the
1584 * fact that the Latin 1 folds are already determined, and the
1585 * only multi-char fold in that range is the sharp-s folding to
1586 * 'ss'. Thus, a pattern character can match as little as 1/3 of a
1587 * string character. Adjust lnc accordingly, rounding up, so that
1588 * if we need to match at least 4+1/3 chars, that really is 5. */
1589 expansion = (utf8_target) ? UTF8_MAX_FOLD_CHAR_EXPAND : 2;
1590 lnc = (lnc + expansion - 1) / expansion;
1592 /* As in the non-UTF8 case, if we have to match 3 characters, and
1593 * only 2 are left, it's guaranteed to fail, so don't start a
1594 * match that would require us to go beyond the end of the string
1596 e = HOP3c(strend, -((I32)lnc), s);
1598 if (!reginfo && e < s) {
1599 e = s; /* Due to minlen logic of intuit() */
1602 /* XXX Note that we could recalculate e to stop the loop earlier,
1603 * as the worst case expansion above will rarely be met, and as we
1604 * go along we would usually find that e moves further to the left.
1605 * This would happen only after we reached the point in the loop
1606 * where if there were no expansion we should fail. Unclear if
1607 * worth the expense */
1610 char *my_strend= (char *)strend;
1611 if (foldEQ_utf8_flags(s, &my_strend, 0, utf8_target,
1612 pat_string, NULL, ln, is_utf8_pat, utf8_fold_flags)
1613 && (!reginfo || regtry(reginfo, &s)) )
1617 s += (utf8_target) ? UTF8SKIP(s) : 1;
1622 RXp_MATCH_TAINTED_on(prog);
1623 FBC_BOUND(isWORDCHAR_LC,
1624 isWORDCHAR_LC_uvchr(UNI_TO_NATIVE(tmp)),
1625 isWORDCHAR_LC_utf8((U8*)s));
1628 RXp_MATCH_TAINTED_on(prog);
1629 FBC_NBOUND(isWORDCHAR_LC,
1630 isWORDCHAR_LC_uvchr(UNI_TO_NATIVE(tmp)),
1631 isWORDCHAR_LC_utf8((U8*)s));
1634 FBC_BOUND(isWORDCHAR,
1635 isWORDCHAR_uni(tmp),
1636 cBOOL(swash_fetch(PL_utf8_swash_ptrs[_CC_WORDCHAR], (U8*)s, utf8_target)));
1639 FBC_BOUND_NOLOAD(isWORDCHAR_A,
1641 isWORDCHAR_A((U8*)s));
1644 FBC_NBOUND(isWORDCHAR,
1645 isWORDCHAR_uni(tmp),
1646 cBOOL(swash_fetch(PL_utf8_swash_ptrs[_CC_WORDCHAR], (U8*)s, utf8_target)));
1649 FBC_NBOUND_NOLOAD(isWORDCHAR_A,
1651 isWORDCHAR_A((U8*)s));
1654 FBC_BOUND(isWORDCHAR_L1,
1655 isWORDCHAR_uni(tmp),
1656 cBOOL(swash_fetch(PL_utf8_swash_ptrs[_CC_WORDCHAR], (U8*)s, utf8_target)));
1659 FBC_NBOUND(isWORDCHAR_L1,
1660 isWORDCHAR_uni(tmp),
1661 cBOOL(swash_fetch(PL_utf8_swash_ptrs[_CC_WORDCHAR], (U8*)s, utf8_target)));
1664 REXEC_FBC_CSCAN(is_LNBREAK_utf8_safe(s, strend),
1665 is_LNBREAK_latin1_safe(s, strend)
1669 /* The argument to all the POSIX node types is the class number to pass to
1670 * _generic_isCC() to build a mask for searching in PL_charclass[] */
1677 RXp_MATCH_TAINTED_on(prog);
1678 REXEC_FBC_CSCAN(to_complement ^ cBOOL(isFOO_utf8_lc(FLAGS(c), (U8 *) s)),
1679 to_complement ^ cBOOL(isFOO_lc(FLAGS(c), *s)));
1694 /* The complement of something that matches only ASCII matches all
1695 * UTF-8 variant code points, plus everything in ASCII that isn't
1697 REXEC_FBC_UTF8_CLASS_SCAN(! UTF8_IS_INVARIANT(*s)
1698 || ! _generic_isCC_A(*s, FLAGS(c)));
1707 /* Don't need to worry about utf8, as it can match only a single
1708 * byte invariant character. */
1709 REXEC_FBC_CLASS_SCAN(
1710 to_complement ^ cBOOL(_generic_isCC_A(*s, FLAGS(c))));
1718 if (! utf8_target) {
1719 REXEC_FBC_CLASS_SCAN(to_complement ^ cBOOL(_generic_isCC(*s,
1725 classnum = (_char_class_number) FLAGS(c);
1726 if (classnum < _FIRST_NON_SWASH_CC) {
1727 while (s < strend) {
1729 /* We avoid loading in the swash as long as possible, but
1730 * should we have to, we jump to a separate loop. This
1731 * extra 'if' statement is what keeps this code from being
1732 * just a call to REXEC_FBC_UTF8_CLASS_SCAN() */
1733 if (UTF8_IS_ABOVE_LATIN1(*s)) {
1734 goto found_above_latin1;
1736 if ((UTF8_IS_INVARIANT(*s)
1737 && to_complement ^ cBOOL(_generic_isCC((U8) *s,
1739 || (UTF8_IS_DOWNGRADEABLE_START(*s)
1740 && to_complement ^ cBOOL(
1741 _generic_isCC(TWO_BYTE_UTF8_TO_UNI(*s, *(s + 1)),
1744 if (tmp && (!reginfo || regtry(reginfo, &s)))
1756 else switch (classnum) { /* These classes are implemented as
1758 case _CC_ENUM_SPACE: /* XXX would require separate code if we
1759 revert the change of \v matching this */
1762 case _CC_ENUM_PSXSPC:
1763 REXEC_FBC_UTF8_CLASS_SCAN(
1764 to_complement ^ cBOOL(isSPACE_utf8(s)));
1767 case _CC_ENUM_BLANK:
1768 REXEC_FBC_UTF8_CLASS_SCAN(
1769 to_complement ^ cBOOL(isBLANK_utf8(s)));
1772 case _CC_ENUM_XDIGIT:
1773 REXEC_FBC_UTF8_CLASS_SCAN(
1774 to_complement ^ cBOOL(isXDIGIT_utf8(s)));
1777 case _CC_ENUM_VERTSPACE:
1778 REXEC_FBC_UTF8_CLASS_SCAN(
1779 to_complement ^ cBOOL(isVERTWS_utf8(s)));
1782 case _CC_ENUM_CNTRL:
1783 REXEC_FBC_UTF8_CLASS_SCAN(
1784 to_complement ^ cBOOL(isCNTRL_utf8(s)));
1788 Perl_croak(aTHX_ "panic: find_byclass() node %d='%s' has an unexpected character class '%d'", OP(c), PL_reg_name[OP(c)], classnum);
1789 assert(0); /* NOTREACHED */
1794 found_above_latin1: /* Here we have to load a swash to get the result
1795 for the current code point */
1796 if (! PL_utf8_swash_ptrs[classnum]) {
1797 U8 flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;
1798 PL_utf8_swash_ptrs[classnum] =
1799 _core_swash_init("utf8", swash_property_names[classnum],
1800 &PL_sv_undef, 1, 0, NULL, &flags);
1803 /* This is a copy of the loop above for swash classes, though using the
1804 * FBC macro instead of being expanded out. Since we've loaded the
1805 * swash, we don't have to check for that each time through the loop */
1806 REXEC_FBC_UTF8_CLASS_SCAN(
1807 to_complement ^ cBOOL(_generic_utf8(
1810 swash_fetch(PL_utf8_swash_ptrs[classnum],
1818 /* what trie are we using right now */
1819 reg_ac_data *aho = (reg_ac_data*)progi->data->data[ ARG( c ) ];
1820 reg_trie_data *trie = (reg_trie_data*)progi->data->data[ aho->trie ];
1821 HV *widecharmap = MUTABLE_HV(progi->data->data[ aho->trie + 1 ]);
1823 const char *last_start = strend - trie->minlen;
1825 const char *real_start = s;
1827 STRLEN maxlen = trie->maxlen;
1829 U8 **points; /* map of where we were in the input string
1830 when reading a given char. For ASCII this
1831 is unnecessary overhead as the relationship
1832 is always 1:1, but for Unicode, especially
1833 case folded Unicode this is not true. */
1834 U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
1838 GET_RE_DEBUG_FLAGS_DECL;
1840 /* We can't just allocate points here. We need to wrap it in
1841 * an SV so it gets freed properly if there is a croak while
1842 * running the match */
1845 sv_points=newSV(maxlen * sizeof(U8 *));
1846 SvCUR_set(sv_points,
1847 maxlen * sizeof(U8 *));
1848 SvPOK_on(sv_points);
1849 sv_2mortal(sv_points);
1850 points=(U8**)SvPV_nolen(sv_points );
1851 if ( trie_type != trie_utf8_fold
1852 && (trie->bitmap || OP(c)==AHOCORASICKC) )
1855 bitmap=(U8*)trie->bitmap;
1857 bitmap=(U8*)ANYOF_BITMAP(c);
1859 /* this is the Aho-Corasick algorithm modified a touch
1860 to include special handling for long "unknown char" sequences.
1861 The basic idea being that we use AC as long as we are dealing
1862 with a possible matching char, when we encounter an unknown char
1863 (and we have not encountered an accepting state) we scan forward
1864 until we find a legal starting char.
1865 AC matching is basically that of trie matching, except that when
1866 we encounter a failing transition, we fall back to the current
1867 states "fail state", and try the current char again, a process
1868 we repeat until we reach the root state, state 1, or a legal
1869 transition. If we fail on the root state then we can either
1870 terminate if we have reached an accepting state previously, or
1871 restart the entire process from the beginning if we have not.
1874 while (s <= last_start) {
1875 const U32 uniflags = UTF8_ALLOW_DEFAULT;
1883 U8 *uscan = (U8*)NULL;
1884 U8 *leftmost = NULL;
1886 U32 accepted_word= 0;
1890 while ( state && uc <= (U8*)strend ) {
1892 U32 word = aho->states[ state ].wordnum;
1896 DEBUG_TRIE_EXECUTE_r(
1897 if ( uc <= (U8*)last_start && !BITMAP_TEST(bitmap,*uc) ) {
1898 dump_exec_pos( (char *)uc, c, strend, real_start,
1899 (char *)uc, utf8_target );
1900 PerlIO_printf( Perl_debug_log,
1901 " Scanning for legal start char...\n");
1905 while ( uc <= (U8*)last_start && !BITMAP_TEST(bitmap,*uc) ) {
1909 while ( uc <= (U8*)last_start && !BITMAP_TEST(bitmap,*uc) ) {
1915 if (uc >(U8*)last_start) break;
1919 U8 *lpos= points[ (pointpos - trie->wordinfo[word].len) % maxlen ];
1920 if (!leftmost || lpos < leftmost) {
1921 DEBUG_r(accepted_word=word);
1927 points[pointpos++ % maxlen]= uc;
1928 if (foldlen || uc < (U8*)strend) {
1929 REXEC_TRIE_READ_CHAR(trie_type, trie,
1931 uscan, len, uvc, charid, foldlen,
1933 DEBUG_TRIE_EXECUTE_r({
1934 dump_exec_pos( (char *)uc, c, strend,
1935 real_start, s, utf8_target);
1936 PerlIO_printf(Perl_debug_log,
1937 " Charid:%3u CP:%4"UVxf" ",
1949 word = aho->states[ state ].wordnum;
1951 base = aho->states[ state ].trans.base;
1953 DEBUG_TRIE_EXECUTE_r({
1955 dump_exec_pos( (char *)uc, c, strend, real_start,
1957 PerlIO_printf( Perl_debug_log,
1958 "%sState: %4"UVxf", word=%"UVxf,
1959 failed ? " Fail transition to " : "",
1960 (UV)state, (UV)word);
1966 ( ((offset = base + charid
1967 - 1 - trie->uniquecharcount)) >= 0)
1968 && ((U32)offset < trie->lasttrans)
1969 && trie->trans[offset].check == state
1970 && (tmp=trie->trans[offset].next))
1972 DEBUG_TRIE_EXECUTE_r(
1973 PerlIO_printf( Perl_debug_log," - legal\n"));
1978 DEBUG_TRIE_EXECUTE_r(
1979 PerlIO_printf( Perl_debug_log," - fail\n"));
1981 state = aho->fail[state];
1985 /* we must be accepting here */
1986 DEBUG_TRIE_EXECUTE_r(
1987 PerlIO_printf( Perl_debug_log," - accepting\n"));
1996 if (!state) state = 1;
1999 if ( aho->states[ state ].wordnum ) {
2000 U8 *lpos = points[ (pointpos - trie->wordinfo[aho->states[ state ].wordnum].len) % maxlen ];
2001 if (!leftmost || lpos < leftmost) {
2002 DEBUG_r(accepted_word=aho->states[ state ].wordnum);
2007 s = (char*)leftmost;
2008 DEBUG_TRIE_EXECUTE_r({
2010 Perl_debug_log,"Matches word #%"UVxf" at position %"IVdf". Trying full pattern...\n",
2011 (UV)accepted_word, (IV)(s - real_start)
2014 if (!reginfo || regtry(reginfo, &s)) {
2020 DEBUG_TRIE_EXECUTE_r({
2021 PerlIO_printf( Perl_debug_log,"Pattern failed. Looking for new start point...\n");
2024 DEBUG_TRIE_EXECUTE_r(
2025 PerlIO_printf( Perl_debug_log,"No match.\n"));
2034 Perl_croak(aTHX_ "panic: unknown regstclass %d", (int)OP(c));
2044 - regexec_flags - match a regexp against a string
2047 Perl_regexec_flags(pTHX_ REGEXP * const rx, char *stringarg, char *strend,
2048 char *strbeg, I32 minend, SV *sv, void *data, U32 flags)
2049 /* stringarg: the point in the string at which to begin matching */
2050 /* strend: pointer to null at end of string */
2051 /* strbeg: real beginning of string */
2052 /* minend: end of match must be >= minend bytes after stringarg. */
2053 /* sv: SV being matched: only used for utf8 flag, pos() etc; string
2054 * itself is accessed via the pointers above */
2055 /* data: May be used for some additional optimizations.
2056 Currently its only used, with a U32 cast, for transmitting
2057 the ganch offset when doing a /g match. This will change */
2058 /* nosave: For optimizations. */
2062 struct regexp *const prog = ReANY(rx);
2065 char *startpos = stringarg;
2066 I32 minlen; /* must match at least this many chars */
2067 I32 dontbother = 0; /* how many characters not to try at end */
2068 I32 end_shift = 0; /* Same for the end. */ /* CC */
2069 I32 scream_pos = -1; /* Internal iterator of scream. */
2070 char *scream_olds = NULL;
2071 const bool utf8_target = cBOOL(DO_UTF8(sv));
2073 RXi_GET_DECL(prog,progi);
2074 regmatch_info reginfo; /* create some info to pass to regtry etc */
2075 regexp_paren_pair *swap = NULL;
2076 GET_RE_DEBUG_FLAGS_DECL;
2078 PERL_ARGS_ASSERT_REGEXEC_FLAGS;
2079 PERL_UNUSED_ARG(data);
2081 /* Be paranoid... */
2082 if (prog == NULL || startpos == NULL) {
2083 Perl_croak(aTHX_ "NULL regexp parameter");
2087 multiline = prog->extflags & RXf_PMf_MULTILINE;
2088 reginfo.prog = rx; /* Yes, sorry that this is confusing. */
2090 RX_MATCH_UTF8_set(rx, utf8_target);
2092 debug_start_match(rx, utf8_target, startpos, strend,
2096 minlen = prog->minlen;
2098 if (strend - startpos < (minlen+(prog->check_offset_min<0?prog->check_offset_min:0))) {
2099 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
2100 "String too short [regexec_flags]...\n"));
2105 /* Check validity of program. */
2106 if (UCHARAT(progi->program) != REG_MAGIC) {
2107 Perl_croak(aTHX_ "corrupted regexp program");
2110 RX_MATCH_TAINTED_off(rx);
2111 PL_reg_state.re_state_eval_setup_done = FALSE;
2114 reginfo.is_utf8_pat = cBOOL(RX_UTF8(rx));
2115 reginfo.warned = FALSE;
2116 /* Mark beginning of line for ^ and lookbehind. */
2117 reginfo.bol = startpos; /* XXX not used ??? */
2121 /* Mark end of line for $ (and such) */
2124 /* see how far we have to get to not match where we matched before */
2125 reginfo.till = startpos+minend;
2127 /* If there is a "must appear" string, look for it. */
2130 if (prog->extflags & RXf_GPOS_SEEN) { /* Need to set reginfo->ganch */
2132 if (flags & REXEC_IGNOREPOS){ /* Means: check only at start */
2133 reginfo.ganch = startpos + prog->gofs;
2134 DEBUG_GPOS_r(PerlIO_printf(Perl_debug_log,
2135 "GPOS IGNOREPOS: reginfo.ganch = startpos + %"UVxf"\n",(UV)prog->gofs));
2136 } else if (sv && SvTYPE(sv) >= SVt_PVMG
2138 && (mg = mg_find(sv, PERL_MAGIC_regex_global))
2139 && mg->mg_len >= 0) {
2140 reginfo.ganch = strbeg + mg->mg_len; /* Defined pos() */
2141 DEBUG_GPOS_r(PerlIO_printf(Perl_debug_log,
2142 "GPOS MAGIC: reginfo.ganch = strbeg + %"IVdf"\n",(IV)mg->mg_len));
2144 if (prog->extflags & RXf_ANCH_GPOS) {
2145 if (s > reginfo.ganch)
2147 s = reginfo.ganch - prog->gofs;
2148 DEBUG_GPOS_r(PerlIO_printf(Perl_debug_log,
2149 "GPOS ANCH_GPOS: s = ganch - %"UVxf"\n",(UV)prog->gofs));
2155 reginfo.ganch = strbeg + PTR2UV(data);
2156 DEBUG_GPOS_r(PerlIO_printf(Perl_debug_log,
2157 "GPOS DATA: reginfo.ganch= strbeg + %"UVxf"\n",PTR2UV(data)));
2159 } else { /* pos() not defined */
2160 reginfo.ganch = strbeg;
2161 DEBUG_GPOS_r(PerlIO_printf(Perl_debug_log,
2162 "GPOS: reginfo.ganch = strbeg\n"));
2165 if (PL_curpm && (PM_GETRE(PL_curpm) == rx)) {
2166 /* We have to be careful. If the previous successful match
2167 was from this regex we don't want a subsequent partially
2168 successful match to clobber the old results.
2169 So when we detect this possibility we add a swap buffer
2170 to the re, and switch the buffer each match. If we fail,
2171 we switch it back; otherwise we leave it swapped.
2174 /* do we need a save destructor here for eval dies? */
2175 Newxz(prog->offs, (prog->nparens + 1), regexp_paren_pair);
2176 DEBUG_BUFFERS_r(PerlIO_printf(Perl_debug_log,
2177 "rex=0x%"UVxf" saving offs: orig=0x%"UVxf" new=0x%"UVxf"\n",
2183 if (!(flags & REXEC_CHECKED) && (prog->check_substr != NULL || prog->check_utf8 != NULL)) {
2184 re_scream_pos_data d;
2186 d.scream_olds = &scream_olds;
2187 d.scream_pos = &scream_pos;
2188 s = re_intuit_start(rx, sv, s, strend, flags, &d);
2190 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Not present...\n"));
2191 goto phooey; /* not present */
2197 /* Simplest case: anchored match need be tried only once. */
2198 /* [unless only anchor is BOL and multiline is set] */
2199 if (prog->extflags & (RXf_ANCH & ~RXf_ANCH_GPOS)) {
2200 if (s == startpos && regtry(®info, &startpos))
2202 else if (multiline || (prog->intflags & PREGf_IMPLICIT)
2203 || (prog->extflags & RXf_ANCH_MBOL)) /* XXXX SBOL? */
2208 dontbother = minlen - 1;
2209 end = HOP3c(strend, -dontbother, strbeg) - 1;
2210 /* for multiline we only have to try after newlines */
2211 if (prog->check_substr || prog->check_utf8) {
2212 /* because of the goto we can not easily reuse the macros for bifurcating the
2213 unicode/non-unicode match modes here like we do elsewhere - demerphq */
2216 goto after_try_utf8;
2218 if (regtry(®info, &s)) {
2225 if (prog->extflags & RXf_USE_INTUIT) {
2226 s = re_intuit_start(rx, sv, s + UTF8SKIP(s), strend, flags, NULL);
2235 } /* end search for check string in unicode */
2237 if (s == startpos) {
2238 goto after_try_latin;
2241 if (regtry(®info, &s)) {
2248 if (prog->extflags & RXf_USE_INTUIT) {
2249 s = re_intuit_start(rx, sv, s + 1, strend, flags, NULL);
2258 } /* end search for check string in latin*/
2259 } /* end search for check string */
2260 else { /* search for newline */
2262 /*XXX: The s-- is almost definitely wrong here under unicode - demeprhq*/
2265 /* We can use a more efficient search as newlines are the same in unicode as they are in latin */
2266 while (s <= end) { /* note it could be possible to match at the end of the string */
2267 if (*s++ == '\n') { /* don't need PL_utf8skip here */
2268 if (regtry(®info, &s))
2272 } /* end search for newline */
2273 } /* end anchored/multiline check string search */
2275 } else if (RXf_GPOS_CHECK == (prog->extflags & RXf_GPOS_CHECK))
2277 /* the warning about reginfo.ganch being used without initialization
2278 is bogus -- we set it above, when prog->extflags & RXf_GPOS_SEEN
2279 and we only enter this block when the same bit is set. */
2280 char *tmp_s = reginfo.ganch - prog->gofs;
2282 if (tmp_s >= strbeg && regtry(®info, &tmp_s))
2287 /* Messy cases: unanchored match. */
2288 if ((prog->anchored_substr || prog->anchored_utf8) && prog->intflags & PREGf_SKIP) {
2289 /* we have /x+whatever/ */
2290 /* it must be a one character string (XXXX Except is_utf8_pat?) */
2296 if (! prog->anchored_utf8) {
2297 to_utf8_substr(prog);
2299 ch = SvPVX_const(prog->anchored_utf8)[0];
2302 DEBUG_EXECUTE_r( did_match = 1 );
2303 if (regtry(®info, &s)) goto got_it;
2305 while (s < strend && *s == ch)
2312 if (! prog->anchored_substr) {
2313 if (! to_byte_substr(prog)) {
2314 NON_UTF8_TARGET_BUT_UTF8_REQUIRED(phooey);
2317 ch = SvPVX_const(prog->anchored_substr)[0];
2320 DEBUG_EXECUTE_r( did_match = 1 );
2321 if (regtry(®info, &s)) goto got_it;
2323 while (s < strend && *s == ch)
2328 DEBUG_EXECUTE_r(if (!did_match)
2329 PerlIO_printf(Perl_debug_log,
2330 "Did not find anchored character...\n")
2333 else if (prog->anchored_substr != NULL
2334 || prog->anchored_utf8 != NULL
2335 || ((prog->float_substr != NULL || prog->float_utf8 != NULL)
2336 && prog->float_max_offset < strend - s)) {
2341 char *last1; /* Last position checked before */
2345 if (prog->anchored_substr || prog->anchored_utf8) {
2347 if (! prog->anchored_utf8) {
2348 to_utf8_substr(prog);
2350 must = prog->anchored_utf8;
2353 if (! prog->anchored_substr) {
2354 if (! to_byte_substr(prog)) {
2355 NON_UTF8_TARGET_BUT_UTF8_REQUIRED(phooey);
2358 must = prog->anchored_substr;
2360 back_max = back_min = prog->anchored_offset;
2363 if (! prog->float_utf8) {
2364 to_utf8_substr(prog);
2366 must = prog->float_utf8;
2369 if (! prog->float_substr) {
2370 if (! to_byte_substr(prog)) {
2371 NON_UTF8_TARGET_BUT_UTF8_REQUIRED(phooey);
2374 must = prog->float_substr;
2376 back_max = prog->float_max_offset;
2377 back_min = prog->float_min_offset;
2383 last = HOP3c(strend, /* Cannot start after this */
2384 -(I32)(CHR_SVLEN(must)
2385 - (SvTAIL(must) != 0) + back_min), strbeg);
2388 last1 = HOPc(s, -1);
2390 last1 = s - 1; /* bogus */
2392 /* XXXX check_substr already used to find "s", can optimize if
2393 check_substr==must. */
2395 dontbother = end_shift;
2396 strend = HOPc(strend, -dontbother);
2397 while ( (s <= last) &&
2398 (s = fbm_instr((unsigned char*)HOP3(s, back_min, (back_min<0 ? strbeg : strend)),
2399 (unsigned char*)strend, must,
2400 multiline ? FBMrf_MULTILINE : 0)) ) {
2401 DEBUG_EXECUTE_r( did_match = 1 );
2402 if (HOPc(s, -back_max) > last1) {
2403 last1 = HOPc(s, -back_min);
2404 s = HOPc(s, -back_max);
2407 char * const t = (last1 >= PL_bostr) ? HOPc(last1, 1) : last1 + 1;
2409 last1 = HOPc(s, -back_min);
2413 while (s <= last1) {
2414 if (regtry(®info, &s))
2417 s++; /* to break out of outer loop */
2424 while (s <= last1) {
2425 if (regtry(®info, &s))
2431 DEBUG_EXECUTE_r(if (!did_match) {
2432 RE_PV_QUOTED_DECL(quoted, utf8_target, PERL_DEBUG_PAD_ZERO(0),
2433 SvPVX_const(must), RE_SV_DUMPLEN(must), 30);
2434 PerlIO_printf(Perl_debug_log, "Did not find %s substr %s%s...\n",
2435 ((must == prog->anchored_substr || must == prog->anchored_utf8)
2436 ? "anchored" : "floating"),
2437 quoted, RE_SV_TAIL(must));
2441 else if ( (c = progi->regstclass) ) {
2443 const OPCODE op = OP(progi->regstclass);
2444 /* don't bother with what can't match */
2445 if (PL_regkind[op] != EXACT && op != CANY && PL_regkind[op] != TRIE)
2446 strend = HOPc(strend, -(minlen - 1));
2449 SV * const prop = sv_newmortal();
2450 regprop(prog, prop, c);
2452 RE_PV_QUOTED_DECL(quoted,utf8_target,PERL_DEBUG_PAD_ZERO(1),
2454 PerlIO_printf(Perl_debug_log,
2455 "Matching stclass %.*s against %s (%d bytes)\n",
2456 (int)SvCUR(prop), SvPVX_const(prop),
2457 quoted, (int)(strend - s));
2460 if (find_byclass(prog, c, s, strend, ®info, reginfo.is_utf8_pat))
2462 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Contradicts stclass... [regexec_flags]\n"));
2466 if (prog->float_substr != NULL || prog->float_utf8 != NULL) {
2474 if (! prog->float_utf8) {
2475 to_utf8_substr(prog);
2477 float_real = prog->float_utf8;
2480 if (! prog->float_substr) {
2481 if (! to_byte_substr(prog)) {
2482 NON_UTF8_TARGET_BUT_UTF8_REQUIRED(phooey);
2485 float_real = prog->float_substr;
2488 little = SvPV_const(float_real, len);
2489 if (SvTAIL(float_real)) {
2490 /* This means that float_real contains an artificial \n on
2491 * the end due to the presence of something like this:
2492 * /foo$/ where we can match both "foo" and "foo\n" at the
2493 * end of the string. So we have to compare the end of the
2494 * string first against the float_real without the \n and
2495 * then against the full float_real with the string. We
2496 * have to watch out for cases where the string might be
2497 * smaller than the float_real or the float_real without
2499 char *checkpos= strend - len;
2501 PerlIO_printf(Perl_debug_log,
2502 "%sChecking for float_real.%s\n",
2503 PL_colors[4], PL_colors[5]));
2504 if (checkpos + 1 < strbeg) {
2505 /* can't match, even if we remove the trailing \n
2506 * string is too short to match */
2508 PerlIO_printf(Perl_debug_log,
2509 "%sString shorter than required trailing substring, cannot match.%s\n",
2510 PL_colors[4], PL_colors[5]));
2512 } else if (memEQ(checkpos + 1, little, len - 1)) {
2513 /* can match, the end of the string matches without the
2515 last = checkpos + 1;
2516 } else if (checkpos < strbeg) {
2517 /* cant match, string is too short when the "\n" is
2520 PerlIO_printf(Perl_debug_log,
2521 "%sString does not contain required trailing substring, cannot match.%s\n",
2522 PL_colors[4], PL_colors[5]));
2524 } else if (!multiline) {
2525 /* non multiline match, so compare with the "\n" at the
2526 * end of the string */
2527 if (memEQ(checkpos, little, len)) {
2531 PerlIO_printf(Perl_debug_log,
2532 "%sString does not contain required trailing substring, cannot match.%s\n",
2533 PL_colors[4], PL_colors[5]));
2537 /* multiline match, so we have to search for a place
2538 * where the full string is located */
2544 last = rninstr(s, strend, little, little + len);
2546 last = strend; /* matching "$" */
2549 /* at one point this block contained a comment which was
2550 * probably incorrect, which said that this was a "should not
2551 * happen" case. Even if it was true when it was written I am
2552 * pretty sure it is not anymore, so I have removed the comment
2553 * and replaced it with this one. Yves */
2555 PerlIO_printf(Perl_debug_log,
2556 "String does not contain required substring, cannot match.\n"
2560 dontbother = strend - last + prog->float_min_offset;
2562 if (minlen && (dontbother < minlen))
2563 dontbother = minlen - 1;
2564 strend -= dontbother; /* this one's always in bytes! */
2565 /* We don't know much -- general case. */
2568 if (regtry(®info, &s))
2577 if (regtry(®info, &s))
2579 } while (s++ < strend);
2589 PerlIO_printf(Perl_debug_log,
2590 "rex=0x%"UVxf" freeing offs: 0x%"UVxf"\n",
2597 if (PL_reg_state.re_state_eval_setup_done)
2598 restore_pos(aTHX_ prog);
2599 if (RXp_PAREN_NAMES(prog))
2600 (void)hv_iterinit(RXp_PAREN_NAMES(prog));
2602 /* make sure $`, $&, $', and $digit will work later */
2603 if ( !(flags & REXEC_NOT_FIRST) ) {
2604 if (flags & REXEC_COPY_STR) {
2608 PerlIO_printf(Perl_debug_log,
2609 "Copy on write: regexp capture, type %d\n",
2612 RX_MATCH_COPY_FREE(rx);
2613 prog->saved_copy = sv_setsv_cow(prog->saved_copy, sv);
2614 prog->subbeg = (char *)SvPVX_const(prog->saved_copy);
2615 assert (SvPOKp(prog->saved_copy));
2616 prog->sublen = PL_regeol - strbeg;
2617 prog->suboffset = 0;
2618 prog->subcoffset = 0;
2623 I32 max = PL_regeol - strbeg;
2626 if ( (flags & REXEC_COPY_SKIP_POST)
2627 && !(RX_EXTFLAGS(rx) & RXf_PMf_KEEPCOPY) /* //p */
2628 && !(PL_sawampersand & SAWAMPERSAND_RIGHT)
2629 ) { /* don't copy $' part of string */
2632 /* calculate the right-most part of the string covered
2633 * by a capture. Due to look-ahead, this may be to
2634 * the right of $&, so we have to scan all captures */
2635 while (n <= prog->lastparen) {
2636 if (prog->offs[n].end > max)
2637 max = prog->offs[n].end;
2641 max = (PL_sawampersand & SAWAMPERSAND_LEFT)
2642 ? prog->offs[0].start
2644 assert(max >= 0 && max <= PL_regeol - strbeg);
2647 if ( (flags & REXEC_COPY_SKIP_PRE)
2648 && !(RX_EXTFLAGS(rx) & RXf_PMf_KEEPCOPY) /* //p */
2649 && !(PL_sawampersand & SAWAMPERSAND_LEFT)
2650 ) { /* don't copy $` part of string */
2653 /* calculate the left-most part of the string covered
2654 * by a capture. Due to look-behind, this may be to
2655 * the left of $&, so we have to scan all captures */
2656 while (min && n <= prog->lastparen) {
2657 if ( prog->offs[n].start != -1
2658 && prog->offs[n].start < min)
2660 min = prog->offs[n].start;
2664 if ((PL_sawampersand & SAWAMPERSAND_RIGHT)
2665 && min > prog->offs[0].end
2667 min = prog->offs[0].end;
2671 assert(min >= 0 && min <= max && min <= PL_regeol - strbeg);
2674 if (RX_MATCH_COPIED(rx)) {
2675 if (sublen > prog->sublen)
2677 (char*)saferealloc(prog->subbeg, sublen+1);
2680 prog->subbeg = (char*)safemalloc(sublen+1);
2681 Copy(strbeg + min, prog->subbeg, sublen, char);
2682 prog->subbeg[sublen] = '\0';
2683 prog->suboffset = min;
2684 prog->sublen = sublen;
2685 RX_MATCH_COPIED_on(rx);
2687 prog->subcoffset = prog->suboffset;
2688 if (prog->suboffset && utf8_target) {
2689 /* Convert byte offset to chars.
2690 * XXX ideally should only compute this if @-/@+
2691 * has been seen, a la PL_sawampersand ??? */
2693 /* If there's a direct correspondence between the
2694 * string which we're matching and the original SV,
2695 * then we can use the utf8 len cache associated with
2696 * the SV. In particular, it means that under //g,
2697 * sv_pos_b2u() will use the previously cached
2698 * position to speed up working out the new length of
2699 * subcoffset, rather than counting from the start of
2700 * the string each time. This stops
2701 * $x = "\x{100}" x 1E6; 1 while $x =~ /(.)/g;
2702 * from going quadratic */
2703 if (SvPOKp(sv) && SvPVX(sv) == strbeg)
2704 sv_pos_b2u(sv, &(prog->subcoffset));
2706 prog->subcoffset = utf8_length((U8*)strbeg,
2707 (U8*)(strbeg+prog->suboffset));
2711 RX_MATCH_COPY_FREE(rx);
2712 prog->subbeg = strbeg;
2713 prog->suboffset = 0;
2714 prog->subcoffset = 0;
2715 prog->sublen = PL_regeol - strbeg; /* strend may have been modified */
2722 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "%sMatch failed%s\n",
2723 PL_colors[4], PL_colors[5]));
2724 if (PL_reg_state.re_state_eval_setup_done)
2725 restore_pos(aTHX_ prog);
2727 /* we failed :-( roll it back */
2728 DEBUG_BUFFERS_r(PerlIO_printf(Perl_debug_log,
2729 "rex=0x%"UVxf" rolling back offs: freeing=0x%"UVxf" restoring=0x%"UVxf"\n",
2734 Safefree(prog->offs);
2741 /* Set which rex is pointed to by PL_reg_state, handling ref counting.
2742 * Do inc before dec, in case old and new rex are the same */
2743 #define SET_reg_curpm(Re2) \
2744 if (PL_reg_state.re_state_eval_setup_done) { \
2745 (void)ReREFCNT_inc(Re2); \
2746 ReREFCNT_dec(PM_GETRE(PL_reg_curpm)); \
2747 PM_SETRE((PL_reg_curpm), (Re2)); \
2752 - regtry - try match at specific point
2754 STATIC I32 /* 0 failure, 1 success */
2755 S_regtry(pTHX_ regmatch_info *reginfo, char **startposp)
2759 REGEXP *const rx = reginfo->prog;
2760 regexp *const prog = ReANY(rx);
2762 RXi_GET_DECL(prog,progi);
2763 GET_RE_DEBUG_FLAGS_DECL;
2765 PERL_ARGS_ASSERT_REGTRY;
2767 reginfo->cutpoint=NULL;
2769 if ((prog->extflags & RXf_EVAL_SEEN)
2770 && !PL_reg_state.re_state_eval_setup_done)
2774 PL_reg_state.re_state_eval_setup_done = TRUE;
2776 /* Make $_ available to executed code. */
2777 if (reginfo->sv != DEFSV) {
2779 DEFSV_set(reginfo->sv);
2782 if (!(SvTYPE(reginfo->sv) >= SVt_PVMG && SvMAGIC(reginfo->sv)
2783 && (mg = mg_find(reginfo->sv, PERL_MAGIC_regex_global)))) {
2784 /* prepare for quick setting of pos */
2785 #ifdef PERL_OLD_COPY_ON_WRITE
2786 if (SvIsCOW(reginfo->sv))
2787 sv_force_normal_flags(reginfo->sv, 0);
2789 mg = sv_magicext(reginfo->sv, NULL, PERL_MAGIC_regex_global,
2790 &PL_vtbl_mglob, NULL, 0);
2794 PL_reg_oldpos = mg->mg_len;
2795 SAVEDESTRUCTOR_X(restore_pos, prog);
2797 if (!PL_reg_curpm) {
2798 Newxz(PL_reg_curpm, 1, PMOP);
2801 SV* const repointer = &PL_sv_undef;
2802 /* this regexp is also owned by the new PL_reg_curpm, which
2803 will try to free it. */
2804 av_push(PL_regex_padav, repointer);
2805 PL_reg_curpm->op_pmoffset = av_len(PL_regex_padav);
2806 PL_regex_pad = AvARRAY(PL_regex_padav);
2811 PL_reg_oldcurpm = PL_curpm;
2812 PL_curpm = PL_reg_curpm;
2813 if (RXp_MATCH_COPIED(prog)) {
2814 /* Here is a serious problem: we cannot rewrite subbeg,
2815 since it may be needed if this match fails. Thus
2816 $` inside (?{}) could fail... */
2817 PL_reg_oldsaved = prog->subbeg;
2818 PL_reg_oldsavedlen = prog->sublen;
2819 PL_reg_oldsavedoffset = prog->suboffset;
2820 PL_reg_oldsavedcoffset = prog->suboffset;
2822 PL_nrs = prog->saved_copy;
2824 RXp_MATCH_COPIED_off(prog);
2827 PL_reg_oldsaved = NULL;
2828 prog->subbeg = PL_bostr;
2829 prog->suboffset = 0;
2830 prog->subcoffset = 0;
2831 prog->sublen = PL_regeol - PL_bostr; /* strend may have been modified */
2834 PL_reg_starttry = *startposp;
2836 prog->offs[0].start = *startposp - PL_bostr;
2837 prog->lastparen = 0;
2838 prog->lastcloseparen = 0;
2840 /* XXXX What this code is doing here?!!! There should be no need
2841 to do this again and again, prog->lastparen should take care of
2844 /* Tests pat.t#187 and split.t#{13,14} seem to depend on this code.
2845 * Actually, the code in regcppop() (which Ilya may be meaning by
2846 * prog->lastparen), is not needed at all by the test suite
2847 * (op/regexp, op/pat, op/split), but that code is needed otherwise
2848 * this erroneously leaves $1 defined: "1" =~ /^(?:(\d)x)?\d$/
2849 * Meanwhile, this code *is* needed for the
2850 * above-mentioned test suite tests to succeed. The common theme
2851 * on those tests seems to be returning null fields from matches.
2852 * --jhi updated by dapm */
2854 if (prog->nparens) {
2855 regexp_paren_pair *pp = prog->offs;
2857 for (i = prog->nparens; i > (I32)prog->lastparen; i--) {
2865 result = regmatch(reginfo, *startposp, progi->program + 1);
2867 prog->offs[0].end = result;
2870 if (reginfo->cutpoint)
2871 *startposp= reginfo->cutpoint;
2872 REGCP_UNWIND(lastcp);
2877 #define sayYES goto yes
2878 #define sayNO goto no
2879 #define sayNO_SILENT goto no_silent
2881 /* we dont use STMT_START/END here because it leads to
2882 "unreachable code" warnings, which are bogus, but distracting. */
2883 #define CACHEsayNO \
2884 if (ST.cache_mask) \
2885 PL_reg_poscache[ST.cache_offset] |= ST.cache_mask; \
2888 /* this is used to determine how far from the left messages like
2889 'failed...' are printed. It should be set such that messages
2890 are inline with the regop output that created them.
2892 #define REPORT_CODE_OFF 32
2895 #define CHRTEST_UNINIT -1001 /* c1/c2 haven't been calculated yet */
2896 #define CHRTEST_VOID -1000 /* the c1/c2 "next char" test should be skipped */
2897 #define CHRTEST_NOT_A_CP_1 -999
2898 #define CHRTEST_NOT_A_CP_2 -998
2900 #define SLAB_FIRST(s) (&(s)->states[0])
2901 #define SLAB_LAST(s) (&(s)->states[PERL_REGMATCH_SLAB_SLOTS-1])
2903 /* grab a new slab and return the first slot in it */
2905 STATIC regmatch_state *
2908 #if PERL_VERSION < 9 && !defined(PERL_CORE)
2911 regmatch_slab *s = PL_regmatch_slab->next;
2913 Newx(s, 1, regmatch_slab);
2914 s->prev = PL_regmatch_slab;
2916 PL_regmatch_slab->next = s;
2918 PL_regmatch_slab = s;
2919 return SLAB_FIRST(s);
2923 /* push a new state then goto it */
2925 #define PUSH_STATE_GOTO(state, node, input) \
2926 pushinput = input; \
2928 st->resume_state = state; \
2931 /* push a new state with success backtracking, then goto it */
2933 #define PUSH_YES_STATE_GOTO(state, node, input) \
2934 pushinput = input; \
2936 st->resume_state = state; \
2937 goto push_yes_state;
2944 regmatch() - main matching routine
2946 This is basically one big switch statement in a loop. We execute an op,
2947 set 'next' to point the next op, and continue. If we come to a point which
2948 we may need to backtrack to on failure such as (A|B|C), we push a
2949 backtrack state onto the backtrack stack. On failure, we pop the top
2950 state, and re-enter the loop at the state indicated. If there are no more
2951 states to pop, we return failure.
2953 Sometimes we also need to backtrack on success; for example /A+/, where
2954 after successfully matching one A, we need to go back and try to
2955 match another one; similarly for lookahead assertions: if the assertion
2956 completes successfully, we backtrack to the state just before the assertion
2957 and then carry on. In these cases, the pushed state is marked as
2958 'backtrack on success too'. This marking is in fact done by a chain of
2959 pointers, each pointing to the previous 'yes' state. On success, we pop to
2960 the nearest yes state, discarding any intermediate failure-only states.
2961 Sometimes a yes state is pushed just to force some cleanup code to be
2962 called at the end of a successful match or submatch; e.g. (??{$re}) uses
2963 it to free the inner regex.
2965 Note that failure backtracking rewinds the cursor position, while
2966 success backtracking leaves it alone.
2968 A pattern is complete when the END op is executed, while a subpattern
2969 such as (?=foo) is complete when the SUCCESS op is executed. Both of these
2970 ops trigger the "pop to last yes state if any, otherwise return true"
2973 A common convention in this function is to use A and B to refer to the two
2974 subpatterns (or to the first nodes thereof) in patterns like /A*B/: so A is
2975 the subpattern to be matched possibly multiple times, while B is the entire
2976 rest of the pattern. Variable and state names reflect this convention.
2978 The states in the main switch are the union of ops and failure/success of
2979 substates associated with with that op. For example, IFMATCH is the op
2980 that does lookahead assertions /(?=A)B/ and so the IFMATCH state means
2981 'execute IFMATCH'; while IFMATCH_A is a state saying that we have just
2982 successfully matched A and IFMATCH_A_fail is a state saying that we have
2983 just failed to match A. Resume states always come in pairs. The backtrack
2984 state we push is marked as 'IFMATCH_A', but when that is popped, we resume
2985 at IFMATCH_A or IFMATCH_A_fail, depending on whether we are backtracking
2986 on success or failure.
2988 The struct that holds a backtracking state is actually a big union, with
2989 one variant for each major type of op. The variable st points to the
2990 top-most backtrack struct. To make the code clearer, within each
2991 block of code we #define ST to alias the relevant union.
2993 Here's a concrete example of a (vastly oversimplified) IFMATCH
2999 #define ST st->u.ifmatch
3001 case IFMATCH: // we are executing the IFMATCH op, (?=A)B
3002 ST.foo = ...; // some state we wish to save
3004 // push a yes backtrack state with a resume value of
3005 // IFMATCH_A/IFMATCH_A_fail, then continue execution at the
3007 PUSH_YES_STATE_GOTO(IFMATCH_A, A, newinput);
3010 case IFMATCH_A: // we have successfully executed A; now continue with B
3012 bar = ST.foo; // do something with the preserved value
3015 case IFMATCH_A_fail: // A failed, so the assertion failed
3016 ...; // do some housekeeping, then ...
3017 sayNO; // propagate the failure
3024 For any old-timers reading this who are familiar with the old recursive
3025 approach, the code above is equivalent to:
3027 case IFMATCH: // we are executing the IFMATCH op, (?=A)B
3036 ...; // do some housekeeping, then ...
3037 sayNO; // propagate the failure
3040 The topmost backtrack state, pointed to by st, is usually free. If you
3041 want to claim it, populate any ST.foo fields in it with values you wish to
3042 save, then do one of
3044 PUSH_STATE_GOTO(resume_state, node, newinput);
3045 PUSH_YES_STATE_GOTO(resume_state, node, newinput);
3047 which sets that backtrack state's resume value to 'resume_state', pushes a
3048 new free entry to the top of the backtrack stack, then goes to 'node'.
3049 On backtracking, the free slot is popped, and the saved state becomes the
3050 new free state. An ST.foo field in this new top state can be temporarily
3051 accessed to retrieve values, but once the main loop is re-entered, it
3052 becomes available for reuse.
3054 Note that the depth of the backtrack stack constantly increases during the
3055 left-to-right execution of the pattern, rather than going up and down with
3056 the pattern nesting. For example the stack is at its maximum at Z at the
3057 end of the pattern, rather than at X in the following:
3059 /(((X)+)+)+....(Y)+....Z/
3061 The only exceptions to this are lookahead/behind assertions and the cut,
3062 (?>A), which pop all the backtrack states associated with A before
3065 Backtrack state structs are allocated in slabs of about 4K in size.
3066 PL_regmatch_state and st always point to the currently active state,
3067 and PL_regmatch_slab points to the slab currently containing
3068 PL_regmatch_state. The first time regmatch() is called, the first slab is
3069 allocated, and is never freed until interpreter destruction. When the slab
3070 is full, a new one is allocated and chained to the end. At exit from
3071 regmatch(), slabs allocated since entry are freed.
3076 #define DEBUG_STATE_pp(pp) \
3078 DUMP_EXEC_POS(locinput, scan, utf8_target); \
3079 PerlIO_printf(Perl_debug_log, \
3080 " %*s"pp" %s%s%s%s%s\n", \
3082 PL_reg_name[st->resume_state], \
3083 ((st==yes_state||st==mark_state) ? "[" : ""), \
3084 ((st==yes_state) ? "Y" : ""), \
3085 ((st==mark_state) ? "M" : ""), \
3086 ((st==yes_state||st==mark_state) ? "]" : "") \
3091 #define REG_NODE_NUM(x) ((x) ? (int)((x)-prog) : -1)
3096 S_debug_start_match(pTHX_ const REGEXP *prog, const bool utf8_target,
3097 const char *start, const char *end, const char *blurb)
3099 const bool utf8_pat = RX_UTF8(prog) ? 1 : 0;
3101 PERL_ARGS_ASSERT_DEBUG_START_MATCH;
3106 RE_PV_QUOTED_DECL(s0, utf8_pat, PERL_DEBUG_PAD_ZERO(0),
3107 RX_PRECOMP_const(prog), RX_PRELEN(prog), 60);
3109 RE_PV_QUOTED_DECL(s1, utf8_target, PERL_DEBUG_PAD_ZERO(1),
3110 start, end - start, 60);
3112 PerlIO_printf(Perl_debug_log,
3113 "%s%s REx%s %s against %s\n",
3114 PL_colors[4], blurb, PL_colors[5], s0, s1);
3116 if (utf8_target||utf8_pat)
3117 PerlIO_printf(Perl_debug_log, "UTF-8 %s%s%s...\n",
3118 utf8_pat ? "pattern" : "",
3119 utf8_pat && utf8_target ? " and " : "",
3120 utf8_target ? "string" : ""
3126 S_dump_exec_pos(pTHX_ const char *locinput,
3127 const regnode *scan,
3128 const char *loc_regeol,
3129 const char *loc_bostr,
3130 const char *loc_reg_starttry,
3131 const bool utf8_target)
3133 const int docolor = *PL_colors[0] || *PL_colors[2] || *PL_colors[4];
3134 const int taill = (docolor ? 10 : 7); /* 3 chars for "> <" */
3135 int l = (loc_regeol - locinput) > taill ? taill : (loc_regeol - locinput);
3136 /* The part of the string before starttry has one color
3137 (pref0_len chars), between starttry and current
3138 position another one (pref_len - pref0_len chars),
3139 after the current position the third one.
3140 We assume that pref0_len <= pref_len, otherwise we
3141 decrease pref0_len. */
3142 int pref_len = (locinput - loc_bostr) > (5 + taill) - l
3143 ? (5 + taill) - l : locinput - loc_bostr;
3146 PERL_ARGS_ASSERT_DUMP_EXEC_POS;
3148 while (utf8_target && UTF8_IS_CONTINUATION(*(U8*)(locinput - pref_len)))
3150 pref0_len = pref_len - (locinput - loc_reg_starttry);
3151 if (l + pref_len < (5 + taill) && l < loc_regeol - locinput)
3152 l = ( loc_regeol - locinput > (5 + taill) - pref_len
3153 ? (5 + taill) - pref_len : loc_regeol - locinput);
3154 while (utf8_target && UTF8_IS_CONTINUATION(*(U8*)(locinput + l)))
3158 if (pref0_len > pref_len)
3159 pref0_len = pref_len;
3161 const int is_uni = (utf8_target && OP(scan) != CANY) ? 1 : 0;
3163 RE_PV_COLOR_DECL(s0,len0,is_uni,PERL_DEBUG_PAD(0),
3164 (locinput - pref_len),pref0_len, 60, 4, 5);
3166 RE_PV_COLOR_DECL(s1,len1,is_uni,PERL_DEBUG_PAD(1),
3167 (locinput - pref_len + pref0_len),
3168 pref_len - pref0_len, 60, 2, 3);
3170 RE_PV_COLOR_DECL(s2,len2,is_uni,PERL_DEBUG_PAD(2),
3171 locinput, loc_regeol - locinput, 10, 0, 1);
3173 const STRLEN tlen=len0+len1+len2;
3174 PerlIO_printf(Perl_debug_log,
3175 "%4"IVdf" <%.*s%.*s%s%.*s>%*s|",
3176 (IV)(locinput - loc_bostr),
3179 (docolor ? "" : "> <"),
3181 (int)(tlen > 19 ? 0 : 19 - tlen),
3188 /* reg_check_named_buff_matched()
3189 * Checks to see if a named buffer has matched. The data array of
3190 * buffer numbers corresponding to the buffer is expected to reside
3191 * in the regexp->data->data array in the slot stored in the ARG() of
3192 * node involved. Note that this routine doesn't actually care about the
3193 * name, that information is not preserved from compilation to execution.
3194 * Returns the index of the leftmost defined buffer with the given name
3195 * or 0 if non of the buffers matched.
3198 S_reg_check_named_buff_matched(pTHX_ const regexp *rex, const regnode *scan)
3201 RXi_GET_DECL(rex,rexi);
3202 SV *sv_dat= MUTABLE_SV(rexi->data->data[ ARG( scan ) ]);
3203 I32 *nums=(I32*)SvPVX(sv_dat);
3205 PERL_ARGS_ASSERT_REG_CHECK_NAMED_BUFF_MATCHED;
3207 for ( n=0; n<SvIVX(sv_dat); n++ ) {
3208 if ((I32)rex->lastparen >= nums[n] &&
3209 rex->offs[nums[n]].end != -1)
3218 /* free all slabs above current one - called during LEAVE_SCOPE */
3221 S_clear_backtrack_stack(pTHX_ void *p)
3223 regmatch_slab *s = PL_regmatch_slab->next;
3228 PL_regmatch_slab->next = NULL;
3230 regmatch_slab * const osl = s;
3236 S_setup_EXACTISH_ST_c1_c2(pTHX_ const regnode * const text_node, int *c1p,
3237 U8* c1_utf8, int *c2p, U8* c2_utf8, bool is_utf8_pat)
3239 /* This function determines if there are one or two characters that match
3240 * the first character of the passed-in EXACTish node <text_node>, and if
3241 * so, returns them in the passed-in pointers.
3243 * If it determines that no possible character in the target string can
3244 * match, it returns FALSE; otherwise TRUE. (The FALSE situation occurs if
3245 * the first character in <text_node> requires UTF-8 to represent, and the
3246 * target string isn't in UTF-8.)
3248 * If there are more than two characters that could match the beginning of
3249 * <text_node>, or if more context is required to determine a match or not,
3250 * it sets both *<c1p> and *<c2p> to CHRTEST_VOID.
3252 * The motiviation behind this function is to allow the caller to set up
3253 * tight loops for matching. If <text_node> is of type EXACT, there is
3254 * only one possible character that can match its first character, and so
3255 * the situation is quite simple. But things get much more complicated if
3256 * folding is involved. It may be that the first character of an EXACTFish
3257 * node doesn't participate in any possible fold, e.g., punctuation, so it
3258 * can be matched only by itself. The vast majority of characters that are
3259 * in folds match just two things, their lower and upper-case equivalents.
3260 * But not all are like that; some have multiple possible matches, or match
3261 * sequences of more than one character. This function sorts all that out.
3263 * Consider the patterns A*B or A*?B where A and B are arbitrary. In a
3264 * loop of trying to match A*, we know we can't exit where the thing
3265 * following it isn't a B. And something can't be a B unless it is the
3266 * beginning of B. By putting a quick test for that beginning in a tight
3267 * loop, we can rule out things that can't possibly be B without having to
3268 * break out of the loop, thus avoiding work. Similarly, if A is a single
3269 * character, we can make a tight loop matching A*, using the outputs of
3272 * If the target string to match isn't in UTF-8, and there aren't
3273 * complications which require CHRTEST_VOID, *<c1p> and *<c2p> are set to
3274 * the one or two possible octets (which are characters in this situation)
3275 * that can match. In all cases, if there is only one character that can
3276 * match, *<c1p> and *<c2p> will be identical.
3278 * If the target string is in UTF-8, the buffers pointed to by <c1_utf8>
3279 * and <c2_utf8> will contain the one or two UTF-8 sequences of bytes that
3280 * can match the beginning of <text_node>. They should be declared with at
3281 * least length UTF8_MAXBYTES+1. (If the target string isn't in UTF-8, it is
3282 * undefined what these contain.) If one or both of the buffers are
3283 * invariant under UTF-8, *<c1p>, and *<c2p> will also be set to the
3284 * corresponding invariant. If variant, the corresponding *<c1p> and/or
3285 * *<c2p> will be set to a negative number(s) that shouldn't match any code
3286 * point (unless inappropriately coerced to unsigned). *<c1p> will equal
3287 * *<c2p> if and only if <c1_utf8> and <c2_utf8> are the same. */
3289 const bool utf8_target = PL_reg_match_utf8;
3291 UV c1 = CHRTEST_NOT_A_CP_1;
3292 UV c2 = CHRTEST_NOT_A_CP_2;
3293 bool use_chrtest_void = FALSE;
3295 /* Used when we have both utf8 input and utf8 output, to avoid converting
3296 * to/from code points */
3297 bool utf8_has_been_setup = FALSE;
3301 U8 *pat = (U8*)STRING(text_node);
3303 if (OP(text_node) == EXACT) {
3305 /* In an exact node, only one thing can be matched, that first
3306 * character. If both the pat and the target are UTF-8, we can just
3307 * copy the input to the output, avoiding finding the code point of
3312 else if (utf8_target) {
3313 Copy(pat, c1_utf8, UTF8SKIP(pat), U8);
3314 Copy(pat, c2_utf8, UTF8SKIP(pat), U8);
3315 utf8_has_been_setup = TRUE;
3318 c2 = c1 = valid_utf8_to_uvchr(pat, NULL);
3321 else /* an EXACTFish node */
3323 && is_MULTI_CHAR_FOLD_utf8_safe(pat,
3324 pat + STR_LEN(text_node)))
3326 && is_MULTI_CHAR_FOLD_latin1_safe(pat,
3327 pat + STR_LEN(text_node))))
3329 /* Multi-character folds require more context to sort out. Also
3330 * PL_utf8_foldclosures used below doesn't handle them, so have to be
3331 * handled outside this routine */
3332 use_chrtest_void = TRUE;
3334 else { /* an EXACTFish node which doesn't begin with a multi-char fold */
3335 c1 = is_utf8_pat ? valid_utf8_to_uvchr(pat, NULL) : *pat;
3337 /* Load the folds hash, if not already done */
3339 if (! PL_utf8_foldclosures) {
3340 if (! PL_utf8_tofold) {
3341 U8 dummy[UTF8_MAXBYTES+1];
3343 /* Force loading this by folding an above-Latin1 char */
3344 to_utf8_fold((U8*) HYPHEN_UTF8, dummy, NULL);
3345 assert(PL_utf8_tofold); /* Verify that worked */
3347 PL_utf8_foldclosures = _swash_inversion_hash(PL_utf8_tofold);
3350 /* The fold closures data structure is a hash with the keys being
3351 * the UTF-8 of every character that is folded to, like 'k', and
3352 * the values each an array of all code points that fold to its
3353 * key. e.g. [ 'k', 'K', KELVIN_SIGN ]. Multi-character folds are
3355 if ((! (listp = hv_fetch(PL_utf8_foldclosures,
3360 /* Not found in the hash, therefore there are no folds
3361 * containing it, so there is only a single character that
3365 else { /* Does participate in folds */
3366 AV* list = (AV*) *listp;
3367 if (av_len(list) != 1) {
3369 /* If there aren't exactly two folds to this, it is outside
3370 * the scope of this function */
3371 use_chrtest_void = TRUE;
3373 else { /* There are two. Get them */
3374 SV** c_p = av_fetch(list, 0, FALSE);
3376 Perl_croak(aTHX_ "panic: invalid PL_utf8_foldclosures structure");
3380 c_p = av_fetch(list, 1, FALSE);
3382 Perl_croak(aTHX_ "panic: invalid PL_utf8_foldclosures structure");
3386 /* Folds that cross the 255/256 boundary are forbidden if
3387 * EXACTFL, or EXACTFA and one is ASCIII. Since the
3388 * pattern character is above 256, and its only other match
3389 * is below 256, the only legal match will be to itself.
3390 * We have thrown away the original, so have to compute
3391 * which is the one above 255 */
3392 if ((c1 < 256) != (c2 < 256)) {
3393 if (OP(text_node) == EXACTFL
3394 || (OP(text_node) == EXACTFA
3395 && (isASCII(c1) || isASCII(c2))))
3408 else /* Here, c1 is < 255 */
3410 && HAS_NONLATIN1_FOLD_CLOSURE(c1)
3411 && OP(text_node) != EXACTFL
3412 && (OP(text_node) != EXACTFA || ! isASCII(c1)))
3414 /* Here, there could be something above Latin1 in the target which
3415 * folds to this character in the pattern. All such cases except
3416 * LATIN SMALL LETTER Y WITH DIAERESIS have more than two characters
3417 * involved in their folds, so are outside the scope of this
3419 if (UNLIKELY(c1 == LATIN_SMALL_LETTER_Y_WITH_DIAERESIS)) {
3420 c2 = LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS;
3423 use_chrtest_void = TRUE;
3426 else { /* Here nothing above Latin1 can fold to the pattern character */
3427 switch (OP(text_node)) {
3429 case EXACTFL: /* /l rules */
3430 c2 = PL_fold_locale[c1];
3434 if (! utf8_target) { /* /d rules */
3439 /* /u rules for all these. This happens to work for
3440 * EXACTFA as nothing in Latin1 folds to ASCII */
3442 case EXACTFU_TRICKYFOLD:
3445 c2 = PL_fold_latin1[c1];
3449 Perl_croak(aTHX_ "panic: Unexpected op %u", OP(text_node));
3450 assert(0); /* NOTREACHED */
3455 /* Here have figured things out. Set up the returns */
3456 if (use_chrtest_void) {
3457 *c2p = *c1p = CHRTEST_VOID;
3459 else if (utf8_target) {
3460 if (! utf8_has_been_setup) { /* Don't have the utf8; must get it */
3461 uvchr_to_utf8(c1_utf8, c1);
3462 uvchr_to_utf8(c2_utf8, c2);
3465 /* Invariants are stored in both the utf8 and byte outputs; Use
3466 * negative numbers otherwise for the byte ones. Make sure that the
3467 * byte ones are the same iff the utf8 ones are the same */
3468 *c1p = (UTF8_IS_INVARIANT(*c1_utf8)) ? *c1_utf8 : CHRTEST_NOT_A_CP_1;
3469 *c2p = (UTF8_IS_INVARIANT(*c2_utf8))
3472 ? CHRTEST_NOT_A_CP_1
3473 : CHRTEST_NOT_A_CP_2;
3475 else if (c1 > 255) {
3476 if (c2 > 255) { /* both possibilities are above what a non-utf8 string
3481 *c1p = *c2p = c2; /* c2 is the only representable value */
3483 else { /* c1 is representable; see about c2 */
3485 *c2p = (c2 < 256) ? c2 : c1;
3491 /* returns -1 on failure, $+[0] on success */
3493 S_regmatch(pTHX_ regmatch_info *reginfo, char *startpos, regnode *prog)
3495 #if PERL_VERSION < 9 && !defined(PERL_CORE)
3499 const bool utf8_target = PL_reg_match_utf8;
3500 const U32 uniflags = UTF8_ALLOW_DEFAULT;
3501 REGEXP *rex_sv = reginfo->prog;
3502 regexp *rex = ReANY(rex_sv);
3503 RXi_GET_DECL(rex,rexi);
3505 /* the current state. This is a cached copy of PL_regmatch_state */
3507 /* cache heavy used fields of st in registers */
3510 U32 n = 0; /* general value; init to avoid compiler warning */
3511 I32 ln = 0; /* len or last; init to avoid compiler warning */
3512 char *locinput = startpos;
3513 char *pushinput; /* where to continue after a PUSH */
3514 I32 nextchr; /* is always set to UCHARAT(locinput) */
3516 bool result = 0; /* return value of S_regmatch */
3517 int depth = 0; /* depth of backtrack stack */
3518 U32 nochange_depth = 0; /* depth of GOSUB recursion with nochange */
3519 const U32 max_nochange_depth =
3520 (3 * rex->nparens > MAX_RECURSE_EVAL_NOCHANGE_DEPTH) ?
3521 3 * rex->nparens : MAX_RECURSE_EVAL_NOCHANGE_DEPTH;
3522 regmatch_state *yes_state = NULL; /* state to pop to on success of
3524 /* mark_state piggy backs on the yes_state logic so that when we unwind
3525 the stack on success we can update the mark_state as we go */
3526 regmatch_state *mark_state = NULL; /* last mark state we have seen */
3527 regmatch_state *cur_eval = NULL; /* most recent EVAL_AB state */
3528 struct regmatch_state *cur_curlyx = NULL; /* most recent curlyx */
3530 bool no_final = 0; /* prevent failure from backtracking? */
3531 bool do_cutgroup = 0; /* no_final only until next branch/trie entry */
3532 char *startpoint = locinput;
3533 SV *popmark = NULL; /* are we looking for a mark? */
3534 SV *sv_commit = NULL; /* last mark name seen in failure */
3535 SV *sv_yes_mark = NULL; /* last mark name we have seen
3536 during a successful match */
3537 U32 lastopen = 0; /* last open we saw */
3538 bool has_cutgroup = RX_HAS_CUTGROUP(rex) ? 1 : 0;
3539 SV* const oreplsv = GvSV(PL_replgv);
3540 /* these three flags are set by various ops to signal information to
3541 * the very next op. They have a useful lifetime of exactly one loop
3542 * iteration, and are not preserved or restored by state pushes/pops
3544 bool sw = 0; /* the condition value in (?(cond)a|b) */
3545 bool minmod = 0; /* the next "{n,m}" is a "{n,m}?" */
3546 int logical = 0; /* the following EVAL is:
3550 or the following IFMATCH/UNLESSM is:
3551 false: plain (?=foo)
3552 true: used as a condition: (?(?=foo))
3554 PAD* last_pad = NULL;
3556 I32 gimme = G_SCALAR;
3557 CV *caller_cv = NULL; /* who called us */
3558 CV *last_pushed_cv = NULL; /* most recently called (?{}) CV */
3559 CHECKPOINT runops_cp; /* savestack position before executing EVAL */
3560 U32 maxopenparen = 0; /* max '(' index seen so far */
3561 int to_complement; /* Invert the result? */
3562 _char_class_number classnum;
3563 bool is_utf8_pat = reginfo->is_utf8_pat;
3566 GET_RE_DEBUG_FLAGS_DECL;
3569 /* shut up 'may be used uninitialized' compiler warnings for dMULTICALL */
3570 multicall_oldcatch = 0;
3571 multicall_cv = NULL;
3573 PERL_UNUSED_VAR(multicall_cop);
3574 PERL_UNUSED_VAR(newsp);
3577 PERL_ARGS_ASSERT_REGMATCH;
3579 DEBUG_OPTIMISE_r( DEBUG_EXECUTE_r({
3580 PerlIO_printf(Perl_debug_log,"regmatch start\n");
3582 /* on first ever call to regmatch, allocate first slab */
3583 if (!PL_regmatch_slab) {
3584 Newx(PL_regmatch_slab, 1, regmatch_slab);
3585 PL_regmatch_slab->prev = NULL;
3586 PL_regmatch_slab->next = NULL;
3587 PL_regmatch_state = SLAB_FIRST(PL_regmatch_slab);
3590 oldsave = PL_savestack_ix;
3591 SAVEDESTRUCTOR_X(S_clear_backtrack_stack, NULL);
3592 SAVEVPTR(PL_regmatch_slab);
3593 SAVEVPTR(PL_regmatch_state);
3595 /* grab next free state slot */
3596 st = ++PL_regmatch_state;
3597 if (st > SLAB_LAST(PL_regmatch_slab))
3598 st = PL_regmatch_state = S_push_slab(aTHX);
3600 /* Note that nextchr is a byte even in UTF */
3603 while (scan != NULL) {
3606 SV * const prop = sv_newmortal();
3607 regnode *rnext=regnext(scan);
3608 DUMP_EXEC_POS( locinput, scan, utf8_target );
3609 regprop(rex, prop, scan);
3611 PerlIO_printf(Perl_debug_log,
3612 "%3"IVdf":%*s%s(%"IVdf")\n",
3613 (IV)(scan - rexi->program), depth*2, "",
3615 (PL_regkind[OP(scan)] == END || !rnext) ?
3616 0 : (IV)(rnext - rexi->program));
3619 next = scan + NEXT_OFF(scan);
3622 state_num = OP(scan);
3628 assert(nextchr < 256 && (nextchr >= 0 || nextchr == NEXTCHR_EOS));
3630 switch (state_num) {
3631 case BOL: /* /^../ */
3632 if (locinput == PL_bostr)
3634 /* reginfo->till = reginfo->bol; */
3639 case MBOL: /* /^../m */
3640 if (locinput == PL_bostr ||
3641 (!NEXTCHR_IS_EOS && locinput[-1] == '\n'))
3647 case SBOL: /* /^../s */
3648 if (locinput == PL_bostr)
3653 if (locinput == reginfo->ganch)
3657 case KEEPS: /* \K */
3658 /* update the startpoint */
3659 st->u.keeper.val = rex->offs[0].start;
3660 rex->offs[0].start = locinput - PL_bostr;
3661 PUSH_STATE_GOTO(KEEPS_next, next, locinput);
3662 assert(0); /*NOTREACHED*/
3663 case KEEPS_next_fail:
3664 /* rollback the start point change */
3665 rex->offs[0].start = st->u.keeper.val;
3667 assert(0); /*NOTREACHED*/
3669 case EOL: /* /..$/ */
3672 case MEOL: /* /..$/m */
3673 if (!NEXTCHR_IS_EOS && nextchr != '\n')
3677 case SEOL: /* /..$/s */
3679 if (!NEXTCHR_IS_EOS && nextchr != '\n')
3681 if (PL_regeol - locinput > 1)
3686 if (!NEXTCHR_IS_EOS)
3690 case SANY: /* /./s */
3693 goto increment_locinput;
3701 case REG_ANY: /* /./ */
3702 if ((NEXTCHR_IS_EOS) || nextchr == '\n')
3704 goto increment_locinput;
3708 #define ST st->u.trie
3709 case TRIEC: /* (ab|cd) with known charclass */
3710 /* In this case the charclass data is available inline so
3711 we can fail fast without a lot of extra overhead.
3713 if(!NEXTCHR_IS_EOS && !ANYOF_BITMAP_TEST(scan, nextchr)) {
3715 PerlIO_printf(Perl_debug_log,
3716 "%*s %sfailed to match trie start class...%s\n",
3717 REPORT_CODE_OFF+depth*2, "", PL_colors[4], PL_colors[5])
3720 assert(0); /* NOTREACHED */
3723 case TRIE: /* (ab|cd) */
3724 /* the basic plan of execution of the trie is:
3725 * At the beginning, run though all the states, and
3726 * find the longest-matching word. Also remember the position
3727 * of the shortest matching word. For example, this pattern:
3730 * when matched against the string "abcde", will generate
3731 * accept states for all words except 3, with the longest
3732 * matching word being 4, and the shortest being 2 (with
3733 * the position being after char 1 of the string).
3735 * Then for each matching word, in word order (i.e. 1,2,4,5),
3736 * we run the remainder of the pattern; on each try setting
3737 * the current position to the character following the word,
3738 * returning to try the next word on failure.
3740 * We avoid having to build a list of words at runtime by
3741 * using a compile-time structure, wordinfo[].prev, which
3742 * gives, for each word, the previous accepting word (if any).
3743 * In the case above it would contain the mappings 1->2, 2->0,
3744 * 3->0, 4->5, 5->1. We can use this table to generate, from
3745 * the longest word (4 above), a list of all words, by
3746 * following the list of prev pointers; this gives us the
3747 * unordered list 4,5,1,2. Then given the current word we have
3748 * just tried, we can go through the list and find the
3749 * next-biggest word to try (so if we just failed on word 2,
3750 * the next in the list is 4).
3752 * Since at runtime we don't record the matching position in
3753 * the string for each word, we have to work that out for
3754 * each word we're about to process. The wordinfo table holds
3755 * the character length of each word; given that we recorded
3756 * at the start: the position of the shortest word and its
3757 * length in chars, we just need to move the pointer the
3758 * difference between the two char lengths. Depending on
3759 * Unicode status and folding, that's cheap or expensive.
3761 * This algorithm is optimised for the case where are only a
3762 * small number of accept states, i.e. 0,1, or maybe 2.
3763 * With lots of accepts states, and having to try all of them,
3764 * it becomes quadratic on number of accept states to find all
3769 /* what type of TRIE am I? (utf8 makes this contextual) */
3770 DECL_TRIE_TYPE(scan);
3772 /* what trie are we using right now */
3773 reg_trie_data * const trie
3774 = (reg_trie_data*)rexi->data->data[ ARG( scan ) ];
3775 HV * widecharmap = MUTABLE_HV(rexi->data->data[ ARG( scan ) + 1 ]);
3776 U32 state = trie->startstate;
3779 && (NEXTCHR_IS_EOS || !TRIE_BITMAP_TEST(trie, nextchr)))
3781 if (trie->states[ state ].wordnum) {
3783 PerlIO_printf(Perl_debug_log,
3784 "%*s %smatched empty string...%s\n",
3785 REPORT_CODE_OFF+depth*2, "", PL_colors[4], PL_colors[5])
3791 PerlIO_printf(Perl_debug_log,
3792 "%*s %sfailed to match trie start class...%s\n",
3793 REPORT_CODE_OFF+depth*2, "", PL_colors[4], PL_colors[5])
3800 U8 *uc = ( U8* )locinput;
3804 U8 *uscan = (U8*)NULL;
3805 U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
3806 U32 charcount = 0; /* how many input chars we have matched */
3807 U32 accepted = 0; /* have we seen any accepting states? */
3809 ST.jump = trie->jump;
3812 ST.longfold = FALSE; /* char longer if folded => it's harder */
3815 /* fully traverse the TRIE; note the position of the
3816 shortest accept state and the wordnum of the longest
3819 while ( state && uc <= (U8*)PL_regeol ) {
3820 U32 base = trie->states[ state ].trans.base;
3824 wordnum = trie->states[ state ].wordnum;
3826 if (wordnum) { /* it's an accept state */
3829 /* record first match position */
3831 ST.firstpos = (U8*)locinput;
3836 ST.firstchars = charcount;
3839 if (!ST.nextword || wordnum < ST.nextword)
3840 ST.nextword = wordnum;
3841 ST.topword = wordnum;
3844 DEBUG_TRIE_EXECUTE_r({
3845 DUMP_EXEC_POS( (char *)uc, scan, utf8_target );
3846 PerlIO_printf( Perl_debug_log,
3847 "%*s %sState: %4"UVxf" Accepted: %c ",
3848 2+depth * 2, "", PL_colors[4],
3849 (UV)state, (accepted ? 'Y' : 'N'));
3852 /* read a char and goto next state */
3853 if ( base && (foldlen || uc < (U8*)PL_regeol)) {
3855 REXEC_TRIE_READ_CHAR(trie_type, trie, widecharmap, uc,
3856 uscan, len, uvc, charid, foldlen,
3863 base + charid - 1 - trie->uniquecharcount)) >= 0)
3865 && ((U32)offset < trie->lasttrans)
3866 && trie->trans[offset].check == state)
3868 state = trie->trans[offset].next;
3879 DEBUG_TRIE_EXECUTE_r(
3880 PerlIO_printf( Perl_debug_log,
3881 "Charid:%3x CP:%4"UVxf" After State: %4"UVxf"%s\n",
3882 charid, uvc, (UV)state, PL_colors[5] );
3888 /* calculate total number of accept states */
3893 w = trie->wordinfo[w].prev;
3896 ST.accepted = accepted;
3900 PerlIO_printf( Perl_debug_log,
3901 "%*s %sgot %"IVdf" possible matches%s\n",
3902 REPORT_CODE_OFF + depth * 2, "",
3903 PL_colors[4], (IV)ST.accepted, PL_colors[5] );
3905 goto trie_first_try; /* jump into the fail handler */
3907 assert(0); /* NOTREACHED */
3909 case TRIE_next_fail: /* we failed - try next alternative */
3913 REGCP_UNWIND(ST.cp);
3914 UNWIND_PAREN(ST.lastparen, ST.lastcloseparen);
3916 if (!--ST.accepted) {
3918 PerlIO_printf( Perl_debug_log,
3919 "%*s %sTRIE failed...%s\n",
3920 REPORT_CODE_OFF+depth*2, "",
3927 /* Find next-highest word to process. Note that this code
3928 * is O(N^2) per trie run (O(N) per branch), so keep tight */
3931 U16 const nextword = ST.nextword;
3932 reg_trie_wordinfo * const wordinfo
3933 = ((reg_trie_data*)rexi->data->data[ARG(ST.me)])->wordinfo;
3934 for (word=ST.topword; word; word=wordinfo[word].prev) {
3935 if (word > nextword && (!min || word < min))
3948 ST.lastparen = rex->lastparen;
3949 ST.lastcloseparen = rex->lastcloseparen;
3953 /* find start char of end of current word */
3955 U32 chars; /* how many chars to skip */
3956 reg_trie_data * const trie
3957 = (reg_trie_data*)rexi->data->data[ARG(ST.me)];
3959 assert((trie->wordinfo[ST.nextword].len - trie->prefixlen)
3961 chars = (trie->wordinfo[ST.nextword].len - trie->prefixlen)
3966 /* the hard option - fold each char in turn and find
3967 * its folded length (which may be different */
3968 U8 foldbuf[UTF8_MAXBYTES_CASE + 1];
3976 uvc = utf8n_to_uvuni((U8*)uc, UTF8_MAXLEN, &len,
3984 uvc = to_uni_fold(uvc, foldbuf, &foldlen);
3989 uvc = utf8n_to_uvuni(uscan, UTF8_MAXLEN, &len,
4005 scan = ST.me + ((ST.jump && ST.jump[ST.nextword])
4006 ? ST.jump[ST.nextword]
4010 PerlIO_printf( Perl_debug_log,
4011 "%*s %sTRIE matched word #%d, continuing%s\n",
4012 REPORT_CODE_OFF+depth*2, "",
4019 if (ST.accepted > 1 || has_cutgroup) {
4020 PUSH_STATE_GOTO(TRIE_next, scan, (char*)uc);
4021 assert(0); /* NOTREACHED */
4023 /* only one choice left - just continue */
4025 AV *const trie_words
4026 = MUTABLE_AV(rexi->data->data[ARG(ST.me)+TRIE_WORDS_OFFSET]);
4027 SV ** const tmp = av_fetch( trie_words,
4029 SV *sv= tmp ? sv_newmortal() : NULL;
4031 PerlIO_printf( Perl_debug_log,
4032 "%*s %sonly one match left, short-circuiting: #%d <%s>%s\n",
4033 REPORT_CODE_OFF+depth*2, "", PL_colors[4],
4035 tmp ? pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), 0,
4036 PL_colors[0], PL_colors[1],
4037 (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0)|PERL_PV_ESCAPE_NONASCII
4039 : "not compiled under -Dr",
4043 locinput = (char*)uc;
4044 continue; /* execute rest of RE */
4045 assert(0); /* NOTREACHED */
4049 case EXACT: { /* /abc/ */
4050 char *s = STRING(scan);
4052 if (utf8_target != is_utf8_pat) {
4053 /* The target and the pattern have differing utf8ness. */
4055 const char * const e = s + ln;
4058 /* The target is utf8, the pattern is not utf8.
4059 * Above-Latin1 code points can't match the pattern;
4060 * invariants match exactly, and the other Latin1 ones need
4061 * to be downgraded to a single byte in order to do the
4062 * comparison. (If we could be confident that the target
4063 * is not malformed, this could be refactored to have fewer
4064 * tests by just assuming that if the first bytes match, it
4065 * is an invariant, but there are tests in the test suite
4066 * dealing with (??{...}) which violate this) */
4068 if (l >= PL_regeol || UTF8_IS_ABOVE_LATIN1(* (U8*) l)) {
4071 if (UTF8_IS_INVARIANT(*(U8*)l)) {
4078 if (TWO_BYTE_UTF8_TO_UNI(*l, *(l+1)) != * (U8*) s) {
4087 /* The target is not utf8, the pattern is utf8. */
4089 if (l >= PL_regeol || UTF8_IS_ABOVE_LATIN1(* (U8*) s))
4093 if (UTF8_IS_INVARIANT(*(U8*)s)) {
4100 if (TWO_BYTE_UTF8_TO_UNI(*s, *(s+1)) != * (U8*) l) {
4111 /* The target and the pattern have the same utf8ness. */
4112 /* Inline the first character, for speed. */
4113 if (PL_regeol - locinput < ln
4114 || UCHARAT(s) != nextchr
4115 || (ln > 1 && memNE(s, locinput, ln)))
4124 case EXACTFL: { /* /abc/il */
4126 const U8 * fold_array;
4128 U32 fold_utf8_flags;
4130 RX_MATCH_TAINTED_on(reginfo->prog);
4131 folder = foldEQ_locale;
4132 fold_array = PL_fold_locale;
4133 fold_utf8_flags = FOLDEQ_UTF8_LOCALE;
4136 case EXACTFU_SS: /* /\x{df}/iu */
4137 case EXACTFU_TRICKYFOLD: /* /\x{390}/iu */
4138 case EXACTFU: /* /abc/iu */
4139 folder = foldEQ_latin1;
4140 fold_array = PL_fold_latin1;
4141 fold_utf8_flags = is_utf8_pat ? FOLDEQ_S1_ALREADY_FOLDED : 0;
4144 case EXACTFA: /* /abc/iaa */
4145 folder = foldEQ_latin1;
4146 fold_array = PL_fold_latin1;
4147 fold_utf8_flags = FOLDEQ_UTF8_NOMIX_ASCII;
4150 case EXACTF: /* /abc/i */
4152 fold_array = PL_fold;
4153 fold_utf8_flags = 0;
4159 if (utf8_target || is_utf8_pat || state_num == EXACTFU_SS) {
4160 /* Either target or the pattern are utf8, or has the issue where
4161 * the fold lengths may differ. */
4162 const char * const l = locinput;
4163 char *e = PL_regeol;
4165 if (! foldEQ_utf8_flags(s, 0, ln, is_utf8_pat,
4166 l, &e, 0, utf8_target, fold_utf8_flags))
4174 /* Neither the target nor the pattern are utf8 */
4175 if (UCHARAT(s) != nextchr
4177 && UCHARAT(s) != fold_array[nextchr])
4181 if (PL_regeol - locinput < ln)
4183 if (ln > 1 && ! folder(s, locinput, ln))
4189 /* XXX Could improve efficiency by separating these all out using a
4190 * macro or in-line function. At that point regcomp.c would no longer
4191 * have to set the FLAGS fields of these */
4192 case BOUNDL: /* /\b/l */
4193 case NBOUNDL: /* /\B/l */
4194 RX_MATCH_TAINTED_on(reginfo->prog);
4196 case BOUND: /* /\b/ */
4197 case BOUNDU: /* /\b/u */
4198 case BOUNDA: /* /\b/a */
4199 case NBOUND: /* /\B/ */
4200 case NBOUNDU: /* /\B/u */
4201 case NBOUNDA: /* /\B/a */
4202 /* was last char in word? */
4204 && FLAGS(scan) != REGEX_ASCII_RESTRICTED_CHARSET
4205 && FLAGS(scan) != REGEX_ASCII_MORE_RESTRICTED_CHARSET)
4207 if (locinput == PL_bostr)
4210 const U8 * const r = reghop3((U8*)locinput, -1, (U8*)PL_bostr);
4212 ln = utf8n_to_uvchr(r, UTF8SKIP(r), 0, uniflags);
4214 if (FLAGS(scan) != REGEX_LOCALE_CHARSET) {
4215 ln = isWORDCHAR_uni(ln);
4219 LOAD_UTF8_CHARCLASS_ALNUM();
4220 n = swash_fetch(PL_utf8_swash_ptrs[_CC_WORDCHAR], (U8*)locinput,
4225 ln = isWORDCHAR_LC_uvchr(UNI_TO_NATIVE(ln));
4226 n = NEXTCHR_IS_EOS ? 0 : isWORDCHAR_LC_utf8((U8*)locinput);
4231 /* Here the string isn't utf8, or is utf8 and only ascii
4232 * characters are to match \w. In the latter case looking at
4233 * the byte just prior to the current one may be just the final
4234 * byte of a multi-byte character. This is ok. There are two
4236 * 1) it is a single byte character, and then the test is doing
4237 * just what it's supposed to.
4238 * 2) it is a multi-byte character, in which case the final
4239 * byte is never mistakable for ASCII, and so the test
4240 * will say it is not a word character, which is the
4241 * correct answer. */
4242 ln = (locinput != PL_bostr) ?
4243 UCHARAT(locinput - 1) : '\n';
4244 switch (FLAGS(scan)) {
4245 case REGEX_UNICODE_CHARSET:
4246 ln = isWORDCHAR_L1(ln);
4247 n = NEXTCHR_IS_EOS ? 0 : isWORDCHAR_L1(nextchr);
4249 case REGEX_LOCALE_CHARSET:
4250 ln = isWORDCHAR_LC(ln);
4251 n = NEXTCHR_IS_EOS ? 0 : isWORDCHAR_LC(nextchr);
4253 case REGEX_DEPENDS_CHARSET:
4254 ln = isWORDCHAR(ln);
4255 n = NEXTCHR_IS_EOS ? 0 : isWORDCHAR(nextchr);
4257 case REGEX_ASCII_RESTRICTED_CHARSET:
4258 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
4259 ln = isWORDCHAR_A(ln);
4260 n = NEXTCHR_IS_EOS ? 0 : isWORDCHAR_A(nextchr);
4263 Perl_croak(aTHX_ "panic: Unexpected FLAGS %u in op %u", FLAGS(scan), OP(scan));
4267 /* Note requires that all BOUNDs be lower than all NBOUNDs in
4269 if (((!ln) == (!n)) == (OP(scan) < NBOUND))
4273 case ANYOF: /* /[abc]/ */
4274 case ANYOF_WARN_SUPER:
4278 if (!reginclass(rex, scan, (U8*)locinput, utf8_target))
4280 locinput += UTF8SKIP(locinput);
4283 if (!REGINCLASS(rex, scan, (U8*)locinput))
4289 /* The argument (FLAGS) to all the POSIX node types is the class number
4292 case NPOSIXL: /* \W or [:^punct:] etc. under /l */
4296 case POSIXL: /* \w or [:punct:] etc. under /l */
4300 /* The locale hasn't influenced the outcome before this, so defer
4301 * tainting until now */
4302 RX_MATCH_TAINTED_on(reginfo->prog);
4304 /* Use isFOO_lc() for characters within Latin1. (Note that
4305 * UTF8_IS_INVARIANT works even on non-UTF-8 strings, or else
4306 * wouldn't be invariant) */
4307 if (UTF8_IS_INVARIANT(nextchr) || ! utf8_target) {
4308 if (! (to_complement ^ cBOOL(isFOO_lc(FLAGS(scan), (U8) nextchr)))) {
4312 else if (UTF8_IS_DOWNGRADEABLE_START(nextchr)) {
4313 if (! (to_complement ^ cBOOL(isFOO_lc(FLAGS(scan),
4314 (U8) TWO_BYTE_UTF8_TO_UNI(nextchr,
4315 *(locinput + 1))))))
4320 else { /* Here, must be an above Latin-1 code point */
4321 goto utf8_posix_not_eos;
4324 /* Here, must be utf8 */
4325 locinput += UTF8SKIP(locinput);
4328 case NPOSIXD: /* \W or [:^punct:] etc. under /d */
4332 case POSIXD: /* \w or [:punct:] etc. under /d */
4338 case NPOSIXA: /* \W or [:^punct:] etc. under /a */
4340 if (NEXTCHR_IS_EOS) {
4344 /* All UTF-8 variants match */
4345 if (! UTF8_IS_INVARIANT(nextchr)) {
4346 goto increment_locinput;
4352 case POSIXA: /* \w or [:punct:] etc. under /a */
4355 /* We get here through POSIXD, NPOSIXD, and NPOSIXA when not in
4356 * UTF-8, and also from NPOSIXA even in UTF-8 when the current
4357 * character is a single byte */
4360 || ! (to_complement ^ cBOOL(_generic_isCC_A(nextchr,
4366 /* Here we are either not in utf8, or we matched a utf8-invariant,
4367 * so the next char is the next byte */
4371 case NPOSIXU: /* \W or [:^punct:] etc. under /u */
4375 case POSIXU: /* \w or [:punct:] etc. under /u */
4377 if (NEXTCHR_IS_EOS) {
4382 /* Use _generic_isCC() for characters within Latin1. (Note that
4383 * UTF8_IS_INVARIANT works even on non-UTF-8 strings, or else
4384 * wouldn't be invariant) */
4385 if (UTF8_IS_INVARIANT(nextchr) || ! utf8_target) {
4386 if (! (to_complement ^ cBOOL(_generic_isCC(nextchr,
4393 else if (UTF8_IS_DOWNGRADEABLE_START(nextchr)) {
4394 if (! (to_complement
4395 ^ cBOOL(_generic_isCC(TWO_BYTE_UTF8_TO_UNI(nextchr,
4403 else { /* Handle above Latin-1 code points */
4404 classnum = (_char_class_number) FLAGS(scan);
4405 if (classnum < _FIRST_NON_SWASH_CC) {
4407 /* Here, uses a swash to find such code points. Load if if
4408 * not done already */
4409 if (! PL_utf8_swash_ptrs[classnum]) {
4410 U8 flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;
4411 PL_utf8_swash_ptrs[classnum]
4412 = _core_swash_init("utf8",
4413 swash_property_names[classnum],
4414 &PL_sv_undef, 1, 0, NULL, &flags);
4416 if (! (to_complement
4417 ^ cBOOL(swash_fetch(PL_utf8_swash_ptrs[classnum],
4418 (U8 *) locinput, TRUE))))
4423 else { /* Here, uses macros to find above Latin-1 code points */
4425 case _CC_ENUM_SPACE: /* XXX would require separate
4426 code if we revert the change
4427 of \v matching this */
4428 case _CC_ENUM_PSXSPC:
4429 if (! (to_complement
4430 ^ cBOOL(is_XPERLSPACE_high(locinput))))
4435 case _CC_ENUM_BLANK:
4436 if (! (to_complement
4437 ^ cBOOL(is_HORIZWS_high(locinput))))
4442 case _CC_ENUM_XDIGIT:
4443 if (! (to_complement
4444 ^ cBOOL(is_XDIGIT_high(locinput))))
4449 case _CC_ENUM_VERTSPACE:
4450 if (! (to_complement
4451 ^ cBOOL(is_VERTWS_high(locinput))))
4456 default: /* The rest, e.g. [:cntrl:], can't match
4458 if (! to_complement) {
4464 locinput += UTF8SKIP(locinput);
4468 case CLUMP: /* Match \X: logical Unicode character. This is defined as
4469 a Unicode extended Grapheme Cluster */
4470 /* From http://www.unicode.org/reports/tr29 (5.2 version). An
4471 extended Grapheme Cluster is:
4474 | Prepend* Begin Extend*
4477 Begin is: ( Special_Begin | ! Control )
4478 Special_Begin is: ( Regional-Indicator+ | Hangul-syllable )
4479 Extend is: ( Grapheme_Extend | Spacing_Mark )
4480 Control is: [ GCB_Control | CR | LF ]
4481 Hangul-syllable is: ( T+ | ( L* ( L | ( LVT | ( V | LV ) V* ) T* ) ))
4483 If we create a 'Regular_Begin' = Begin - Special_Begin, then
4486 Begin is ( Regular_Begin + Special Begin )
4488 It turns out that 98.4% of all Unicode code points match
4489 Regular_Begin. Doing it this way eliminates a table match in
4490 the previous implementation for almost all Unicode code points.
4492 There is a subtlety with Prepend* which showed up in testing.
4493 Note that the Begin, and only the Begin is required in:
4494 | Prepend* Begin Extend*
4495 Also, Begin contains '! Control'. A Prepend must be a
4496 '! Control', which means it must also be a Begin. What it
4497 comes down to is that if we match Prepend* and then find no
4498 suitable Begin afterwards, that if we backtrack the last
4499 Prepend, that one will be a suitable Begin.
4504 if (! utf8_target) {
4506 /* Match either CR LF or '.', as all the other possibilities
4508 locinput++; /* Match the . or CR */
4509 if (nextchr == '\r' /* And if it was CR, and the next is LF,
4511 && locinput < PL_regeol
4512 && UCHARAT(locinput) == '\n')
4519 /* Utf8: See if is ( CR LF ); already know that locinput <
4520 * PL_regeol, so locinput+1 is in bounds */
4521 if ( nextchr == '\r' && locinput+1 < PL_regeol
4522 && UCHARAT(locinput + 1) == '\n')
4529 /* In case have to backtrack to beginning, then match '.' */
4530 char *starting = locinput;
4532 /* In case have to backtrack the last prepend */
4533 char *previous_prepend = NULL;
4535 LOAD_UTF8_CHARCLASS_GCB();
4537 /* Match (prepend)* */
4538 while (locinput < PL_regeol
4539 && (len = is_GCB_Prepend_utf8(locinput)))
4541 previous_prepend = locinput;
4545 /* As noted above, if we matched a prepend character, but
4546 * the next thing won't match, back off the last prepend we
4547 * matched, as it is guaranteed to match the begin */
4548 if (previous_prepend
4549 && (locinput >= PL_regeol
4550 || (! swash_fetch(PL_utf8_X_regular_begin,
4551 (U8*)locinput, utf8_target)
4552 && ! is_GCB_SPECIAL_BEGIN_START_utf8(locinput)))
4555 locinput = previous_prepend;
4558 /* Note that here we know PL_regeol > locinput, as we
4559 * tested that upon input to this switch case, and if we
4560 * moved locinput forward, we tested the result just above
4561 * and it either passed, or we backed off so that it will
4563 if (swash_fetch(PL_utf8_X_regular_begin,
4564 (U8*)locinput, utf8_target)) {
4565 locinput += UTF8SKIP(locinput);
4567 else if (! is_GCB_SPECIAL_BEGIN_START_utf8(locinput)) {
4569 /* Here did not match the required 'Begin' in the
4570 * second term. So just match the very first
4571 * character, the '.' of the final term of the regex */
4572 locinput = starting + UTF8SKIP(starting);
4576 /* Here is a special begin. It can be composed of
4577 * several individual characters. One possibility is
4579 if ((len = is_GCB_RI_utf8(locinput))) {
4581 while (locinput < PL_regeol
4582 && (len = is_GCB_RI_utf8(locinput)))
4586 } else if ((len = is_GCB_T_utf8(locinput))) {
4587 /* Another possibility is T+ */
4589 while (locinput < PL_regeol
4590 && (len = is_GCB_T_utf8(locinput)))
4596 /* Here, neither RI+ nor T+; must be some other
4597 * Hangul. That means it is one of the others: L,
4598 * LV, LVT or V, and matches:
4599 * L* (L | LVT T* | V * V* T* | LV V* T*) */
4602 while (locinput < PL_regeol
4603 && (len = is_GCB_L_utf8(locinput)))
4608 /* Here, have exhausted L*. If the next character
4609 * is not an LV, LVT nor V, it means we had to have
4610 * at least one L, so matches L+ in the original
4611 * equation, we have a complete hangul syllable.
4614 if (locinput < PL_regeol
4615 && is_GCB_LV_LVT_V_utf8(locinput))
4617 /* Otherwise keep going. Must be LV, LVT or V.
4618 * See if LVT, by first ruling out V, then LV */
4619 if (! is_GCB_V_utf8(locinput)
4620 /* All but every TCount one is LV */
4621 && (valid_utf8_to_uvchr((U8 *) locinput,
4626 locinput += UTF8SKIP(locinput);
4629 /* Must be V or LV. Take it, then match
4631 locinput += UTF8SKIP(locinput);
4632 while (locinput < PL_regeol
4633 && (len = is_GCB_V_utf8(locinput)))
4639 /* And any of LV, LVT, or V can be followed
4641 while (locinput < PL_regeol
4642 && (len = is_GCB_T_utf8(locinput)))
4650 /* Match any extender */
4651 while (locinput < PL_regeol
4652 && swash_fetch(PL_utf8_X_extend,
4653 (U8*)locinput, utf8_target))
4655 locinput += UTF8SKIP(locinput);
4659 if (locinput > PL_regeol) sayNO;
4663 case NREFFL: /* /\g{name}/il */
4664 { /* The capture buffer cases. The ones beginning with N for the
4665 named buffers just convert to the equivalent numbered and
4666 pretend they were called as the corresponding numbered buffer
4668 /* don't initialize these in the declaration, it makes C++
4673 const U8 *fold_array;
4676 RX_MATCH_TAINTED_on(reginfo->prog);
4677 folder = foldEQ_locale;
4678 fold_array = PL_fold_locale;
4680 utf8_fold_flags = FOLDEQ_UTF8_LOCALE;
4683 case NREFFA: /* /\g{name}/iaa */
4684 folder = foldEQ_latin1;
4685 fold_array = PL_fold_latin1;
4687 utf8_fold_flags = FOLDEQ_UTF8_NOMIX_ASCII;
4690 case NREFFU: /* /\g{name}/iu */
4691 folder = foldEQ_latin1;
4692 fold_array = PL_fold_latin1;
4694 utf8_fold_flags = 0;
4697 case NREFF: /* /\g{name}/i */
4699 fold_array = PL_fold;
4701 utf8_fold_flags = 0;
4704 case NREF: /* /\g{name}/ */
4708 utf8_fold_flags = 0;
4711 /* For the named back references, find the corresponding buffer
4713 n = reg_check_named_buff_matched(rex,scan);
4718 goto do_nref_ref_common;
4720 case REFFL: /* /\1/il */
4721 RX_MATCH_TAINTED_on(reginfo->prog);
4722 folder = foldEQ_locale;
4723 fold_array = PL_fold_locale;
4724 utf8_fold_flags = FOLDEQ_UTF8_LOCALE;
4727 case REFFA: /* /\1/iaa */
4728 folder = foldEQ_latin1;
4729 fold_array = PL_fold_latin1;
4730 utf8_fold_flags = FOLDEQ_UTF8_NOMIX_ASCII;
4733 case REFFU: /* /\1/iu */
4734 folder = foldEQ_latin1;
4735 fold_array = PL_fold_latin1;
4736 utf8_fold_flags = 0;
4739 case REFF: /* /\1/i */
4741 fold_array = PL_fold;
4742 utf8_fold_flags = 0;
4745 case REF: /* /\1/ */
4748 utf8_fold_flags = 0;
4752 n = ARG(scan); /* which paren pair */
4755 ln = rex->offs[n].start;
4756 PL_reg_leftiter = PL_reg_maxiter; /* Void cache */
4757 if (rex->lastparen < n || ln == -1)
4758 sayNO; /* Do not match unless seen CLOSEn. */
4759 if (ln == rex->offs[n].end)
4763 if (type != REF /* REF can do byte comparison */
4764 && (utf8_target || type == REFFU))
4765 { /* XXX handle REFFL better */
4766 char * limit = PL_regeol;
4768 /* This call case insensitively compares the entire buffer
4769 * at s, with the current input starting at locinput, but
4770 * not going off the end given by PL_regeol, and returns in
4771 * <limit> upon success, how much of the current input was
4773 if (! foldEQ_utf8_flags(s, NULL, rex->offs[n].end - ln, utf8_target,
4774 locinput, &limit, 0, utf8_target, utf8_fold_flags))
4782 /* Not utf8: Inline the first character, for speed. */
4783 if (!NEXTCHR_IS_EOS &&
4784 UCHARAT(s) != nextchr &&
4786 UCHARAT(s) != fold_array[nextchr]))
4788 ln = rex->offs[n].end - ln;
4789 if (locinput + ln > PL_regeol)
4791 if (ln > 1 && (type == REF
4792 ? memNE(s, locinput, ln)
4793 : ! folder(s, locinput, ln)))
4799 case NOTHING: /* null op; e.g. the 'nothing' following
4800 * the '*' in m{(a+|b)*}' */
4802 case TAIL: /* placeholder while compiling (A|B|C) */
4805 case BACK: /* ??? doesn't appear to be used ??? */
4809 #define ST st->u.eval
4814 regexp_internal *rei;
4815 regnode *startpoint;
4817 case GOSTART: /* (?R) */
4818 case GOSUB: /* /(...(?1))/ /(...(?&foo))/ */
4819 if (cur_eval && cur_eval->locinput==locinput) {
4820 if (cur_eval->u.eval.close_paren == (U32)ARG(scan))
4821 Perl_croak(aTHX_ "Infinite recursion in regex");
4822 if ( ++nochange_depth > max_nochange_depth )
4824 "Pattern subroutine nesting without pos change"
4825 " exceeded limit in regex");
4832 if (OP(scan)==GOSUB) {
4833 startpoint = scan + ARG2L(scan);
4834 ST.close_paren = ARG(scan);
4836 startpoint = rei->program+1;
4839 goto eval_recurse_doit;
4840 assert(0); /* NOTREACHED */
4842 case EVAL: /* /(?{A})B/ /(??{A})B/ and /(?(?{A})X|Y)B/ */
4843 if (cur_eval && cur_eval->locinput==locinput) {
4844 if ( ++nochange_depth > max_nochange_depth )
4845 Perl_croak(aTHX_ "EVAL without pos change exceeded limit in regex");
4850 /* execute the code in the {...} */
4854 OP * const oop = PL_op;
4855 COP * const ocurcop = PL_curcop;
4857 char *saved_regeol = PL_regeol;
4858 struct re_save_state saved_state;
4861 /* save *all* paren positions */
4862 regcppush(rex, 0, maxopenparen);
4863 REGCP_SET(runops_cp);
4865 /* To not corrupt the existing regex state while executing the
4866 * eval we would normally put it on the save stack, like with
4867 * save_re_context. However, re-evals have a weird scoping so we
4868 * can't just add ENTER/LEAVE here. With that, things like
4870 * (?{$a=2})(a(?{local$a=$a+1}))*aak*c(?{$b=$a})
4872 * would break, as they expect the localisation to be unwound
4873 * only when the re-engine backtracks through the bit that
4876 * What we do instead is just saving the state in a local c
4879 Copy(&PL_reg_state, &saved_state, 1, struct re_save_state);
4882 caller_cv = find_runcv(NULL);
4886 if (rexi->data->what[n] == 'r') { /* code from an external qr */
4888 (REGEXP*)(rexi->data->data[n])
4891 nop = (OP*)rexi->data->data[n+1];
4893 else if (rexi->data->what[n] == 'l') { /* literal code */
4895 nop = (OP*)rexi->data->data[n];
4896 assert(CvDEPTH(newcv));
4899 /* literal with own CV */
4900 assert(rexi->data->what[n] == 'L');
4901 newcv = rex->qr_anoncv;
4902 nop = (OP*)rexi->data->data[n];
4905 /* normally if we're about to execute code from the same
4906 * CV that we used previously, we just use the existing
4907 * CX stack entry. However, its possible that in the
4908 * meantime we may have backtracked, popped from the save
4909 * stack, and undone the SAVECOMPPAD(s) associated with
4910 * PUSH_MULTICALL; in which case PL_comppad no longer
4911 * points to newcv's pad. */
4912 if (newcv != last_pushed_cv || PL_comppad != last_pad)
4914 U8 flags = (CXp_SUB_RE |
4915 ((newcv == caller_cv) ? CXp_SUB_RE_FAKE : 0));
4916 if (last_pushed_cv) {
4917 CHANGE_MULTICALL_FLAGS(newcv, flags);
4920 PUSH_MULTICALL_FLAGS(newcv, flags);
4922 last_pushed_cv = newcv;
4925 /* these assignments are just to silence compiler
4927 multicall_cop = NULL;
4930 last_pad = PL_comppad;
4932 /* the initial nextstate you would normally execute
4933 * at the start of an eval (which would cause error
4934 * messages to come from the eval), may be optimised
4935 * away from the execution path in the regex code blocks;
4936 * so manually set PL_curcop to it initially */
4938 OP *o = cUNOPx(nop)->op_first;
4939 assert(o->op_type == OP_NULL);
4940 if (o->op_targ == OP_SCOPE) {
4941 o = cUNOPo->op_first;
4944 assert(o->op_targ == OP_LEAVE);
4945 o = cUNOPo->op_first;
4946 assert(o->op_type == OP_ENTER);
4950 if (o->op_type != OP_STUB) {
4951 assert( o->op_type == OP_NEXTSTATE
4952 || o->op_type == OP_DBSTATE
4953 || (o->op_type == OP_NULL
4954 && ( o->op_targ == OP_NEXTSTATE
4955 || o->op_targ == OP_DBSTATE
4959 PL_curcop = (COP*)o;
4964 DEBUG_STATE_r( PerlIO_printf(Perl_debug_log,
4965 " re EVAL PL_op=0x%"UVxf"\n", PTR2UV(nop)) );
4967 rex->offs[0].end = PL_reg_magic->mg_len = locinput - PL_bostr;
4970 SV *sv_mrk = get_sv("REGMARK", 1);
4971 sv_setsv(sv_mrk, sv_yes_mark);
4974 /* we don't use MULTICALL here as we want to call the
4975 * first op of the block of interest, rather than the
4976 * first op of the sub */
4977 before = (IV)(SP-PL_stack_base);
4979 CALLRUNOPS(aTHX); /* Scalar context. */
4981 if ((IV)(SP-PL_stack_base) == before)
4982 ret = &PL_sv_undef; /* protect against empty (?{}) blocks. */
4988 /* before restoring everything, evaluate the returned
4989 * value, so that 'uninit' warnings don't use the wrong
4990 * PL_op or pad. Also need to process any magic vars
4991 * (e.g. $1) *before* parentheses are restored */
4996 if (logical == 0) /* (?{})/ */
4997 sv_setsv(save_scalar(PL_replgv), ret); /* $^R */
4998 else if (logical == 1) { /* /(?(?{...})X|Y)/ */
4999 sw = cBOOL(SvTRUE(ret));
5002 else { /* /(??{}) */
5003 /* if its overloaded, let the regex compiler handle
5004 * it; otherwise extract regex, or stringify */
5005 if (!SvAMAGIC(ret)) {
5009 if (SvTYPE(sv) == SVt_REGEXP)
5010 re_sv = (REGEXP*) sv;
5011 else if (SvSMAGICAL(sv)) {
5012 MAGIC *mg = mg_find(sv, PERL_MAGIC_qr);
5014 re_sv = (REGEXP *) mg->mg_obj;
5017 /* force any magic, undef warnings here */
5019 ret = sv_mortalcopy(ret);
5020 (void) SvPV_force_nolen(ret);
5026 Copy(&saved_state, &PL_reg_state, 1, struct re_save_state);
5028 /* *** Note that at this point we don't restore
5029 * PL_comppad, (or pop the CxSUB) on the assumption it may
5030 * be used again soon. This is safe as long as nothing
5031 * in the regexp code uses the pad ! */
5033 PL_curcop = ocurcop;
5034 PL_regeol = saved_regeol;
5035 S_regcp_restore(aTHX_ rex, runops_cp, &maxopenparen);
5041 /* only /(??{})/ from now on */
5044 /* extract RE object from returned value; compiling if
5048 re_sv = reg_temp_copy(NULL, re_sv);
5053 if (SvUTF8(ret) && IN_BYTES) {
5054 /* In use 'bytes': make a copy of the octet
5055 * sequence, but without the flag on */
5057 const char *const p = SvPV(ret, len);
5058 ret = newSVpvn_flags(p, len, SVs_TEMP);
5060 if (rex->intflags & PREGf_USE_RE_EVAL)
5061 pm_flags |= PMf_USE_RE_EVAL;
5063 /* if we got here, it should be an engine which
5064 * supports compiling code blocks and stuff */
5065 assert(rex->engine && rex->engine->op_comp);
5066 assert(!(scan->flags & ~RXf_PMf_COMPILETIME));
5067 re_sv = rex->engine->op_comp(aTHX_ &ret, 1, NULL,
5068 rex->engine, NULL, NULL,
5069 /* copy /msix etc to inner pattern */
5074 & (SVs_TEMP | SVs_PADTMP | SVf_READONLY
5076 /* This isn't a first class regexp. Instead, it's
5077 caching a regexp onto an existing, Perl visible
5079 sv_magic(ret, MUTABLE_SV(re_sv), PERL_MAGIC_qr, 0, 0);
5081 /* safe to do now that any $1 etc has been
5082 * interpolated into the new pattern string and
5084 S_regcp_restore(aTHX_ rex, runops_cp, &maxopenparen);
5089 RXp_MATCH_COPIED_off(re);
5090 re->subbeg = rex->subbeg;
5091 re->sublen = rex->sublen;
5092 re->suboffset = rex->suboffset;
5093 re->subcoffset = rex->subcoffset;
5096 debug_start_match(re_sv, utf8_target, locinput, PL_regeol,
5097 "Matching embedded");
5099 startpoint = rei->program + 1;
5100 ST.close_paren = 0; /* only used for GOSUB */
5102 eval_recurse_doit: /* Share code with GOSUB below this line */
5103 /* run the pattern returned from (??{...}) */
5105 /* Save *all* the positions. */
5106 ST.cp = regcppush(rex, 0, maxopenparen);
5107 REGCP_SET(ST.lastcp);
5110 re->lastcloseparen = 0;
5114 /* XXXX This is too dramatic a measure... */
5117 ST.saved_utf8_pat = is_utf8_pat;
5118 is_utf8_pat = cBOOL(RX_UTF8(re_sv));
5120 ST.prev_rex = rex_sv;
5121 ST.prev_curlyx = cur_curlyx;
5123 SET_reg_curpm(rex_sv);
5128 ST.prev_eval = cur_eval;
5130 /* now continue from first node in postoned RE */
5131 PUSH_YES_STATE_GOTO(EVAL_AB, startpoint, locinput);
5132 assert(0); /* NOTREACHED */
5135 case EVAL_AB: /* cleanup after a successful (??{A})B */
5136 /* note: this is called twice; first after popping B, then A */
5137 is_utf8_pat = ST.saved_utf8_pat;
5138 rex_sv = ST.prev_rex;
5139 SET_reg_curpm(rex_sv);
5140 rex = ReANY(rex_sv);
5141 rexi = RXi_GET(rex);
5143 cur_eval = ST.prev_eval;
5144 cur_curlyx = ST.prev_curlyx;
5146 /* XXXX This is too dramatic a measure... */
5148 if ( nochange_depth )
5153 case EVAL_AB_fail: /* unsuccessfully ran A or B in (??{A})B */
5154 /* note: this is called twice; first after popping B, then A */
5155 is_utf8_pat = ST.saved_utf8_pat;
5156 rex_sv = ST.prev_rex;
5157 SET_reg_curpm(rex_sv);
5158 rex = ReANY(rex_sv);
5159 rexi = RXi_GET(rex);
5161 REGCP_UNWIND(ST.lastcp);
5162 regcppop(rex, &maxopenparen);
5163 cur_eval = ST.prev_eval;
5164 cur_curlyx = ST.prev_curlyx;
5165 /* XXXX This is too dramatic a measure... */
5167 if ( nochange_depth )
5173 n = ARG(scan); /* which paren pair */
5174 rex->offs[n].start_tmp = locinput - PL_bostr;
5175 if (n > maxopenparen)
5177 DEBUG_BUFFERS_r(PerlIO_printf(Perl_debug_log,
5178 "rex=0x%"UVxf" offs=0x%"UVxf": \\%"UVuf": set %"IVdf" tmp; maxopenparen=%"UVuf"\n",
5182 (IV)rex->offs[n].start_tmp,
5188 /* XXX really need to log other places start/end are set too */
5189 #define CLOSE_CAPTURE \
5190 rex->offs[n].start = rex->offs[n].start_tmp; \
5191 rex->offs[n].end = locinput - PL_bostr; \
5192 DEBUG_BUFFERS_r(PerlIO_printf(Perl_debug_log, \
5193 "rex=0x%"UVxf" offs=0x%"UVxf": \\%"UVuf": set %"IVdf"..%"IVdf"\n", \
5195 PTR2UV(rex->offs), \
5197 (IV)rex->offs[n].start, \
5198 (IV)rex->offs[n].end \
5202 n = ARG(scan); /* which paren pair */
5204 if (n > rex->lastparen)
5206 rex->lastcloseparen = n;
5207 if (cur_eval && cur_eval->u.eval.close_paren == n) {
5212 case ACCEPT: /* (*ACCEPT) */
5216 cursor && OP(cursor)!=END;
5217 cursor=regnext(cursor))
5219 if ( OP(cursor)==CLOSE ){
5221 if ( n <= lastopen ) {
5223 if (n > rex->lastparen)
5225 rex->lastcloseparen = n;
5226 if ( n == ARG(scan) || (cur_eval &&
5227 cur_eval->u.eval.close_paren == n))
5236 case GROUPP: /* (?(1)) */
5237 n = ARG(scan); /* which paren pair */
5238 sw = cBOOL(rex->lastparen >= n && rex->offs[n].end != -1);
5241 case NGROUPP: /* (?(<name>)) */
5242 /* reg_check_named_buff_matched returns 0 for no match */
5243 sw = cBOOL(0 < reg_check_named_buff_matched(rex,scan));
5246 case INSUBP: /* (?(R)) */
5248 sw = (cur_eval && (!n || cur_eval->u.eval.close_paren == n));
5251 case DEFINEP: /* (?(DEFINE)) */
5255 case IFTHEN: /* (?(cond)A|B) */
5256 PL_reg_leftiter = PL_reg_maxiter; /* Void cache */
5258 next = NEXTOPER(NEXTOPER(scan));
5260 next = scan + ARG(scan);
5261 if (OP(next) == IFTHEN) /* Fake one. */
5262 next = NEXTOPER(NEXTOPER(next));
5266 case LOGICAL: /* modifier for EVAL and IFMATCH */
5267 logical = scan->flags;
5270 /*******************************************************************
5272 The CURLYX/WHILEM pair of ops handle the most generic case of the /A*B/
5273 pattern, where A and B are subpatterns. (For simple A, CURLYM or
5274 STAR/PLUS/CURLY/CURLYN are used instead.)
5276 A*B is compiled as <CURLYX><A><WHILEM><B>
5278 On entry to the subpattern, CURLYX is called. This pushes a CURLYX
5279 state, which contains the current count, initialised to -1. It also sets
5280 cur_curlyx to point to this state, with any previous value saved in the
5283 CURLYX then jumps straight to the WHILEM op, rather than executing A,
5284 since the pattern may possibly match zero times (i.e. it's a while {} loop
5285 rather than a do {} while loop).
5287 Each entry to WHILEM represents a successful match of A. The count in the
5288 CURLYX block is incremented, another WHILEM state is pushed, and execution
5289 passes to A or B depending on greediness and the current count.
5291 For example, if matching against the string a1a2a3b (where the aN are
5292 substrings that match /A/), then the match progresses as follows: (the
5293 pushed states are interspersed with the bits of strings matched so far):
5296 <CURLYX cnt=0><WHILEM>
5297 <CURLYX cnt=1><WHILEM> a1 <WHILEM>
5298 <CURLYX cnt=2><WHILEM> a1 <WHILEM> a2 <WHILEM>
5299 <CURLYX cnt=3><WHILEM> a1 <WHILEM> a2 <WHILEM> a3 <WHILEM>
5300 <CURLYX cnt=3><WHILEM> a1 <WHILEM> a2 <WHILEM> a3 <WHILEM> b
5302 (Contrast this with something like CURLYM, which maintains only a single
5306 a1 <CURLYM cnt=1> a2
5307 a1 a2 <CURLYM cnt=2> a3
5308 a1 a2 a3 <CURLYM cnt=3> b
5311 Each WHILEM state block marks a point to backtrack to upon partial failure
5312 of A or B, and also contains some minor state data related to that
5313 iteration. The CURLYX block, pointed to by cur_curlyx, contains the
5314 overall state, such as the count, and pointers to the A and B ops.
5316 This is complicated slightly by nested CURLYX/WHILEM's. Since cur_curlyx
5317 must always point to the *current* CURLYX block, the rules are:
5319 When executing CURLYX, save the old cur_curlyx in the CURLYX state block,
5320 and set cur_curlyx to point the new block.
5322 When popping the CURLYX block after a successful or unsuccessful match,
5323 restore the previous cur_curlyx.
5325 When WHILEM is about to execute B, save the current cur_curlyx, and set it
5326 to the outer one saved in the CURLYX block.
5328 When popping the WHILEM block after a successful or unsuccessful B match,
5329 restore the previous cur_curlyx.
5331 Here's an example for the pattern (AI* BI)*BO
5332 I and O refer to inner and outer, C and W refer to CURLYX and WHILEM:
5335 curlyx backtrack stack
5336 ------ ---------------
5338 CO <CO prev=NULL> <WO>
5339 CI <CO prev=NULL> <WO> <CI prev=CO> <WI> ai
5340 CO <CO prev=NULL> <WO> <CI prev=CO> <WI> ai <WI prev=CI> bi
5341 NULL <CO prev=NULL> <WO> <CI prev=CO> <WI> ai <WI prev=CI> bi <WO prev=CO> bo
5343 At this point the pattern succeeds, and we work back down the stack to
5344 clean up, restoring as we go:
5346 CO <CO prev=NULL> <WO> <CI prev=CO> <WI> ai <WI prev=CI> bi
5347 CI <CO prev=NULL> <WO> <CI prev=CO> <WI> ai
5348 CO <CO prev=NULL> <WO>
5351 *******************************************************************/
5353 #define ST st->u.curlyx
5355 case CURLYX: /* start of /A*B/ (for complex A) */
5357 /* No need to save/restore up to this paren */
5358 I32 parenfloor = scan->flags;
5360 assert(next); /* keep Coverity happy */
5361 if (OP(PREVOPER(next)) == NOTHING) /* LONGJMP */
5364 /* XXXX Probably it is better to teach regpush to support
5365 parenfloor > maxopenparen ... */
5366 if (parenfloor > (I32)rex->lastparen)
5367 parenfloor = rex->lastparen; /* Pessimization... */
5369 ST.prev_curlyx= cur_curlyx;
5371 ST.cp = PL_savestack_ix;
5373 /* these fields contain the state of the current curly.
5374 * they are accessed by subsequent WHILEMs */
5375 ST.parenfloor = parenfloor;
5380 ST.count = -1; /* this will be updated by WHILEM */
5381 ST.lastloc = NULL; /* this will be updated by WHILEM */
5383 PUSH_YES_STATE_GOTO(CURLYX_end, PREVOPER(next), locinput);
5384 assert(0); /* NOTREACHED */
5387 case CURLYX_end: /* just finished matching all of A*B */
5388 cur_curlyx = ST.prev_curlyx;
5390 assert(0); /* NOTREACHED */
5392 case CURLYX_end_fail: /* just failed to match all of A*B */
5394 cur_curlyx = ST.prev_curlyx;
5396 assert(0); /* NOTREACHED */
5400 #define ST st->u.whilem
5402 case WHILEM: /* just matched an A in /A*B/ (for complex A) */
5404 /* see the discussion above about CURLYX/WHILEM */
5406 int min = ARG1(cur_curlyx->u.curlyx.me);
5407 int max = ARG2(cur_curlyx->u.curlyx.me);
5408 regnode *A = NEXTOPER(cur_curlyx->u.curlyx.me) + EXTRA_STEP_2ARGS;
5410 assert(cur_curlyx); /* keep Coverity happy */
5411 n = ++cur_curlyx->u.curlyx.count; /* how many A's matched */
5412 ST.save_lastloc = cur_curlyx->u.curlyx.lastloc;
5413 ST.cache_offset = 0;
5417 DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
5418 "%*s whilem: matched %ld out of %d..%d\n",
5419 REPORT_CODE_OFF+depth*2, "", (long)n, min, max)
5422 /* First just match a string of min A's. */
5425 ST.cp = regcppush(rex, cur_curlyx->u.curlyx.parenfloor,
5427 cur_curlyx->u.curlyx.lastloc = locinput;
5428 REGCP_SET(ST.lastcp);
5430 PUSH_STATE_GOTO(WHILEM_A_pre, A, locinput);
5431 assert(0); /* NOTREACHED */
5434 /* If degenerate A matches "", assume A done. */
5436 if (locinput == cur_curlyx->u.curlyx.lastloc) {
5437 DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
5438 "%*s whilem: empty match detected, trying continuation...\n",
5439 REPORT_CODE_OFF+depth*2, "")
5441 goto do_whilem_B_max;
5444 /* super-linear cache processing */
5448 if (!PL_reg_maxiter) {
5449 /* start the countdown: Postpone detection until we
5450 * know the match is not *that* much linear. */
5451 PL_reg_maxiter = (PL_regeol - PL_bostr + 1) * (scan->flags>>4);
5452 /* possible overflow for long strings and many CURLYX's */
5453 if (PL_reg_maxiter < 0)
5454 PL_reg_maxiter = I32_MAX;
5455 PL_reg_leftiter = PL_reg_maxiter;
5458 if (PL_reg_leftiter-- == 0) {
5459 /* initialise cache */
5460 const I32 size = (PL_reg_maxiter + 7)/8;
5461 if (PL_reg_poscache) {
5462 if ((I32)PL_reg_poscache_size < size) {
5463 Renew(PL_reg_poscache, size, char);
5464 PL_reg_poscache_size = size;
5466 Zero(PL_reg_poscache, size, char);
5469 PL_reg_poscache_size = size;
5470 Newxz(PL_reg_poscache, size, char);
5472 DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
5473 "%swhilem: Detected a super-linear match, switching on caching%s...\n",
5474 PL_colors[4], PL_colors[5])
5478 if (PL_reg_leftiter < 0) {
5479 /* have we already failed at this position? */
5481 offset = (scan->flags & 0xf) - 1
5482 + (locinput - PL_bostr) * (scan->flags>>4);
5483 mask = 1 << (offset % 8);
5485 if (PL_reg_poscache[offset] & mask) {
5486 DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
5487 "%*s whilem: (cache) already tried at this position...\n",
5488 REPORT_CODE_OFF+depth*2, "")
5490 sayNO; /* cache records failure */
5492 ST.cache_offset = offset;
5493 ST.cache_mask = mask;
5497 /* Prefer B over A for minimal matching. */
5499 if (cur_curlyx->u.curlyx.minmod) {
5500 ST.save_curlyx = cur_curlyx;
5501 cur_curlyx = cur_curlyx->u.curlyx.prev_curlyx;
5502 ST.cp = regcppush(rex, ST.save_curlyx->u.curlyx.parenfloor,
5504 REGCP_SET(ST.lastcp);
5505 PUSH_YES_STATE_GOTO(WHILEM_B_min, ST.save_curlyx->u.curlyx.B,
5507 assert(0); /* NOTREACHED */
5510 /* Prefer A over B for maximal matching. */
5512 if (n < max) { /* More greed allowed? */
5513 ST.cp = regcppush(rex, cur_curlyx->u.curlyx.parenfloor,
5515 cur_curlyx->u.curlyx.lastloc = locinput;
5516 REGCP_SET(ST.lastcp);
5517 PUSH_STATE_GOTO(WHILEM_A_max, A, locinput);
5518 assert(0); /* NOTREACHED */
5520 goto do_whilem_B_max;
5522 assert(0); /* NOTREACHED */
5524 case WHILEM_B_min: /* just matched B in a minimal match */
5525 case WHILEM_B_max: /* just matched B in a maximal match */
5526 cur_curlyx = ST.save_curlyx;
5528 assert(0); /* NOTREACHED */
5530 case WHILEM_B_max_fail: /* just failed to match B in a maximal match */
5531 cur_curlyx = ST.save_curlyx;
5532 cur_curlyx->u.curlyx.lastloc = ST.save_lastloc;
5533 cur_curlyx->u.curlyx.count--;
5535 assert(0); /* NOTREACHED */
5537 case WHILEM_A_min_fail: /* just failed to match A in a minimal match */
5539 case WHILEM_A_pre_fail: /* just failed to match even minimal A */
5540 REGCP_UNWIND(ST.lastcp);
5541 regcppop(rex, &maxopenparen);
5542 cur_curlyx->u.curlyx.lastloc = ST.save_lastloc;
5543 cur_curlyx->u.curlyx.count--;
5545 assert(0); /* NOTREACHED */
5547 case WHILEM_A_max_fail: /* just failed to match A in a maximal match */
5548 REGCP_UNWIND(ST.lastcp);
5549 regcppop(rex, &maxopenparen); /* Restore some previous $<digit>s? */
5550 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
5551 "%*s whilem: failed, trying continuation...\n",
5552 REPORT_CODE_OFF+depth*2, "")
5555 if (cur_curlyx->u.curlyx.count >= REG_INFTY
5556 && ckWARN(WARN_REGEXP)
5557 && !reginfo->warned)
5559 reginfo->warned = TRUE;
5560 Perl_warner(aTHX_ packWARN(WARN_REGEXP),
5561 "Complex regular subexpression recursion limit (%d) "
5567 ST.save_curlyx = cur_curlyx;
5568 cur_curlyx = cur_curlyx->u.curlyx.prev_curlyx;
5569 PUSH_YES_STATE_GOTO(WHILEM_B_max, ST.save_curlyx->u.curlyx.B,
5571 assert(0); /* NOTREACHED */
5573 case WHILEM_B_min_fail: /* just failed to match B in a minimal match */
5574 cur_curlyx = ST.save_curlyx;
5575 REGCP_UNWIND(ST.lastcp);
5576 regcppop(rex, &maxopenparen);
5578 if (cur_curlyx->u.curlyx.count >= /*max*/ARG2(cur_curlyx->u.curlyx.me)) {
5579 /* Maximum greed exceeded */
5580 if (cur_curlyx->u.curlyx.count >= REG_INFTY
5581 && ckWARN(WARN_REGEXP)
5582 && !reginfo->warned)
5584 reginfo->warned = TRUE;
5585 Perl_warner(aTHX_ packWARN(WARN_REGEXP),
5586 "Complex regular subexpression recursion "
5587 "limit (%d) exceeded",
5590 cur_curlyx->u.curlyx.count--;
5594 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
5595 "%*s trying longer...\n", REPORT_CODE_OFF+depth*2, "")
5597 /* Try grabbing another A and see if it helps. */
5598 cur_curlyx->u.curlyx.lastloc = locinput;
5599 ST.cp = regcppush(rex, cur_curlyx->u.curlyx.parenfloor,
5601 REGCP_SET(ST.lastcp);
5602 PUSH_STATE_GOTO(WHILEM_A_min,
5603 /*A*/ NEXTOPER(ST.save_curlyx->u.curlyx.me) + EXTRA_STEP_2ARGS,
5605 assert(0); /* NOTREACHED */
5608 #define ST st->u.branch
5610 case BRANCHJ: /* /(...|A|...)/ with long next pointer */
5611 next = scan + ARG(scan);
5614 scan = NEXTOPER(scan);
5617 case BRANCH: /* /(...|A|...)/ */
5618 scan = NEXTOPER(scan); /* scan now points to inner node */
5619 ST.lastparen = rex->lastparen;
5620 ST.lastcloseparen = rex->lastcloseparen;
5621 ST.next_branch = next;
5624 /* Now go into the branch */
5626 PUSH_YES_STATE_GOTO(BRANCH_next, scan, locinput);
5628 PUSH_STATE_GOTO(BRANCH_next, scan, locinput);
5630 assert(0); /* NOTREACHED */
5632 case CUTGROUP: /* /(*THEN)/ */
5633 sv_yes_mark = st->u.mark.mark_name = scan->flags ? NULL :
5634 MUTABLE_SV(rexi->data->data[ ARG( scan ) ]);
5635 PUSH_STATE_GOTO(CUTGROUP_next, next, locinput);
5636 assert(0); /* NOTREACHED */
5638 case CUTGROUP_next_fail:
5641 if (st->u.mark.mark_name)
5642 sv_commit = st->u.mark.mark_name;
5644 assert(0); /* NOTREACHED */
5648 assert(0); /* NOTREACHED */
5650 case BRANCH_next_fail: /* that branch failed; try the next, if any */
5655 REGCP_UNWIND(ST.cp);
5656 UNWIND_PAREN(ST.lastparen, ST.lastcloseparen);
5657 scan = ST.next_branch;
5658 /* no more branches? */
5659 if (!scan || (OP(scan) != BRANCH && OP(scan) != BRANCHJ)) {
5661 PerlIO_printf( Perl_debug_log,
5662 "%*s %sBRANCH failed...%s\n",
5663 REPORT_CODE_OFF+depth*2, "",
5669 continue; /* execute next BRANCH[J] op */
5670 assert(0); /* NOTREACHED */
5672 case MINMOD: /* next op will be non-greedy, e.g. A*? */
5677 #define ST st->u.curlym
5679 case CURLYM: /* /A{m,n}B/ where A is fixed-length */
5681 /* This is an optimisation of CURLYX that enables us to push
5682 * only a single backtracking state, no matter how many matches
5683 * there are in {m,n}. It relies on the pattern being constant
5684 * length, with no parens to influence future backrefs
5688 scan = NEXTOPER(scan) + NODE_STEP_REGNODE;
5690 ST.lastparen = rex->lastparen;
5691 ST.lastcloseparen = rex->lastcloseparen;
5693 /* if paren positive, emulate an OPEN/CLOSE around A */
5695 U32 paren = ST.me->flags;
5696 if (paren > maxopenparen)
5697 maxopenparen = paren;
5698 scan += NEXT_OFF(scan); /* Skip former OPEN. */
5706 ST.c1 = CHRTEST_UNINIT;
5709 if (!(ST.minmod ? ARG1(ST.me) : ARG2(ST.me))) /* min/max */
5712 curlym_do_A: /* execute the A in /A{m,n}B/ */
5713 PUSH_YES_STATE_GOTO(CURLYM_A, ST.A, locinput); /* match A */
5714 assert(0); /* NOTREACHED */
5716 case CURLYM_A: /* we've just matched an A */
5718 /* after first match, determine A's length: u.curlym.alen */
5719 if (ST.count == 1) {
5720 if (PL_reg_match_utf8) {
5721 char *s = st->locinput;
5722 while (s < locinput) {
5728 ST.alen = locinput - st->locinput;
5731 ST.count = ST.minmod ? ARG1(ST.me) : ARG2(ST.me);
5734 PerlIO_printf(Perl_debug_log,
5735 "%*s CURLYM now matched %"IVdf" times, len=%"IVdf"...\n",
5736 (int)(REPORT_CODE_OFF+(depth*2)), "",
5737 (IV) ST.count, (IV)ST.alen)
5740 if (cur_eval && cur_eval->u.eval.close_paren &&
5741 cur_eval->u.eval.close_paren == (U32)ST.me->flags)
5745 I32 max = (ST.minmod ? ARG1(ST.me) : ARG2(ST.me));
5746 if ( max == REG_INFTY || ST.count < max )
5747 goto curlym_do_A; /* try to match another A */
5749 goto curlym_do_B; /* try to match B */
5751 case CURLYM_A_fail: /* just failed to match an A */
5752 REGCP_UNWIND(ST.cp);
5754 if (ST.minmod || ST.count < ARG1(ST.me) /* min*/
5755 || (cur_eval && cur_eval->u.eval.close_paren &&
5756 cur_eval->u.eval.close_paren == (U32)ST.me->flags))
5759 curlym_do_B: /* execute the B in /A{m,n}B/ */
5760 if (ST.c1 == CHRTEST_UNINIT) {
5761 /* calculate c1 and c2 for possible match of 1st char
5762 * following curly */
5763 ST.c1 = ST.c2 = CHRTEST_VOID;
5764 if (HAS_TEXT(ST.B) || JUMPABLE(ST.B)) {
5765 regnode *text_node = ST.B;
5766 if (! HAS_TEXT(text_node))
5767 FIND_NEXT_IMPT(text_node);
5770 (HAS_TEXT(text_node) && PL_regkind[OP(text_node)] == EXACT)
5772 But the former is redundant in light of the latter.
5774 if this changes back then the macro for
5775 IS_TEXT and friends need to change.
5777 if (PL_regkind[OP(text_node)] == EXACT) {
5778 if (! S_setup_EXACTISH_ST_c1_c2(aTHX_
5779 text_node, &ST.c1, ST.c1_utf8, &ST.c2, ST.c2_utf8,
5789 PerlIO_printf(Perl_debug_log,
5790 "%*s CURLYM trying tail with matches=%"IVdf"...\n",
5791 (int)(REPORT_CODE_OFF+(depth*2)),
5794 if (! NEXTCHR_IS_EOS && ST.c1 != CHRTEST_VOID) {
5795 if (! UTF8_IS_INVARIANT(nextchr) && utf8_target) {
5796 if (memNE(locinput, ST.c1_utf8, UTF8SKIP(locinput))
5797 && memNE(locinput, ST.c2_utf8, UTF8SKIP(locinput)))
5799 /* simulate B failing */
5801 PerlIO_printf(Perl_debug_log,
5802 "%*s CURLYM Fast bail next target=U+%"UVXf" c1=U+%"UVXf" c2=U+%"UVXf"\n",
5803 (int)(REPORT_CODE_OFF+(depth*2)),"",
5804 valid_utf8_to_uvchr((U8 *) locinput, NULL),
5805 valid_utf8_to_uvchr(ST.c1_utf8, NULL),
5806 valid_utf8_to_uvchr(ST.c2_utf8, NULL))
5808 state_num = CURLYM_B_fail;
5809 goto reenter_switch;
5812 else if (nextchr != ST.c1 && nextchr != ST.c2) {
5813 /* simulate B failing */
5815 PerlIO_printf(Perl_debug_log,
5816 "%*s CURLYM Fast bail next target=U+%X c1=U+%X c2=U+%X\n",
5817 (int)(REPORT_CODE_OFF+(depth*2)),"",
5818 (int) nextchr, ST.c1, ST.c2)
5820 state_num = CURLYM_B_fail;
5821 goto reenter_switch;
5826 /* emulate CLOSE: mark current A as captured */
5827 I32 paren = ST.me->flags;
5829 rex->offs[paren].start
5830 = HOPc(locinput, -ST.alen) - PL_bostr;
5831 rex->offs[paren].end = locinput - PL_bostr;
5832 if ((U32)paren > rex->lastparen)
5833 rex->lastparen = paren;
5834 rex->lastcloseparen = paren;
5837 rex->offs[paren].end = -1;
5838 if (cur_eval && cur_eval->u.eval.close_paren &&
5839 cur_eval->u.eval.close_paren == (U32)ST.me->flags)
5848 PUSH_STATE_GOTO(CURLYM_B, ST.B, locinput); /* match B */
5849 assert(0); /* NOTREACHED */
5851 case CURLYM_B_fail: /* just failed to match a B */
5852 REGCP_UNWIND(ST.cp);
5853 UNWIND_PAREN(ST.lastparen, ST.lastcloseparen);
5855 I32 max = ARG2(ST.me);
5856 if (max != REG_INFTY && ST.count == max)
5858 goto curlym_do_A; /* try to match a further A */
5860 /* backtrack one A */
5861 if (ST.count == ARG1(ST.me) /* min */)
5864 SET_locinput(HOPc(locinput, -ST.alen));
5865 goto curlym_do_B; /* try to match B */
5868 #define ST st->u.curly
5870 #define CURLY_SETPAREN(paren, success) \
5873 rex->offs[paren].start = HOPc(locinput, -1) - PL_bostr; \
5874 rex->offs[paren].end = locinput - PL_bostr; \
5875 if (paren > rex->lastparen) \
5876 rex->lastparen = paren; \
5877 rex->lastcloseparen = paren; \
5880 rex->offs[paren].end = -1; \
5881 rex->lastparen = ST.lastparen; \
5882 rex->lastcloseparen = ST.lastcloseparen; \
5886 case STAR: /* /A*B/ where A is width 1 char */
5890 scan = NEXTOPER(scan);
5893 case PLUS: /* /A+B/ where A is width 1 char */
5897 scan = NEXTOPER(scan);
5900 case CURLYN: /* /(A){m,n}B/ where A is width 1 char */
5901 ST.paren = scan->flags; /* Which paren to set */
5902 ST.lastparen = rex->lastparen;
5903 ST.lastcloseparen = rex->lastcloseparen;
5904 if (ST.paren > maxopenparen)
5905 maxopenparen = ST.paren;
5906 ST.min = ARG1(scan); /* min to match */
5907 ST.max = ARG2(scan); /* max to match */
5908 if (cur_eval && cur_eval->u.eval.close_paren &&
5909 cur_eval->u.eval.close_paren == (U32)ST.paren) {
5913 scan = regnext(NEXTOPER(scan) + NODE_STEP_REGNODE);
5916 case CURLY: /* /A{m,n}B/ where A is width 1 char */
5918 ST.min = ARG1(scan); /* min to match */
5919 ST.max = ARG2(scan); /* max to match */
5920 scan = NEXTOPER(scan) + NODE_STEP_REGNODE;
5923 * Lookahead to avoid useless match attempts
5924 * when we know what character comes next.
5926 * Used to only do .*x and .*?x, but now it allows
5927 * for )'s, ('s and (?{ ... })'s to be in the way
5928 * of the quantifier and the EXACT-like node. -- japhy
5931 assert(ST.min <= ST.max);
5932 if (! HAS_TEXT(next) && ! JUMPABLE(next)) {
5933 ST.c1 = ST.c2 = CHRTEST_VOID;
5936 regnode *text_node = next;
5938 if (! HAS_TEXT(text_node))
5939 FIND_NEXT_IMPT(text_node);
5941 if (! HAS_TEXT(text_node))
5942 ST.c1 = ST.c2 = CHRTEST_VOID;
5944 if ( PL_regkind[OP(text_node)] != EXACT ) {
5945 ST.c1 = ST.c2 = CHRTEST_VOID;
5949 /* Currently we only get here when
5951 PL_rekind[OP(text_node)] == EXACT
5953 if this changes back then the macro for IS_TEXT and
5954 friends need to change. */
5955 if (! S_setup_EXACTISH_ST_c1_c2(aTHX_
5956 text_node, &ST.c1, ST.c1_utf8, &ST.c2, ST.c2_utf8,
5968 char *li = locinput;
5971 regrepeat(rex, &li, ST.A, ST.min, depth, is_utf8_pat)
5977 if (ST.c1 == CHRTEST_VOID)
5978 goto curly_try_B_min;
5980 ST.oldloc = locinput;
5982 /* set ST.maxpos to the furthest point along the
5983 * string that could possibly match */
5984 if (ST.max == REG_INFTY) {
5985 ST.maxpos = PL_regeol - 1;
5987 while (UTF8_IS_CONTINUATION(*(U8*)ST.maxpos))
5990 else if (utf8_target) {
5991 int m = ST.max - ST.min;
5992 for (ST.maxpos = locinput;
5993 m >0 && ST.maxpos < PL_regeol; m--)
5994 ST.maxpos += UTF8SKIP(ST.maxpos);
5997 ST.maxpos = locinput + ST.max - ST.min;
5998 if (ST.maxpos >= PL_regeol)
5999 ST.maxpos = PL_regeol - 1;
6001 goto curly_try_B_min_known;
6005 /* avoid taking address of locinput, so it can remain
6007 char *li = locinput;
6008 ST.count = regrepeat(rex, &li, ST.A, ST.max, depth,
6010 if (ST.count < ST.min)
6013 if ((ST.count > ST.min)
6014 && (PL_regkind[OP(ST.B)] == EOL) && (OP(ST.B) != MEOL))
6016 /* A{m,n} must come at the end of the string, there's
6017 * no point in backing off ... */
6019 /* ...except that $ and \Z can match before *and* after
6020 newline at the end. Consider "\n\n" =~ /\n+\Z\n/.
6021 We may back off by one in this case. */
6022 if (UCHARAT(locinput - 1) == '\n' && OP(ST.B) != EOS)
6026 goto curly_try_B_max;
6028 assert(0); /* NOTREACHED */
6031 case CURLY_B_min_known_fail:
6032 /* failed to find B in a non-greedy match where c1,c2 valid */
6034 REGCP_UNWIND(ST.cp);
6036 UNWIND_PAREN(ST.lastparen, ST.lastcloseparen);
6038 /* Couldn't or didn't -- move forward. */
6039 ST.oldloc = locinput;
6041 locinput += UTF8SKIP(locinput);
6045 curly_try_B_min_known:
6046 /* find the next place where 'B' could work, then call B */
6050 n = (ST.oldloc == locinput) ? 0 : 1;
6051 if (ST.c1 == ST.c2) {
6052 /* set n to utf8_distance(oldloc, locinput) */
6053 while (locinput <= ST.maxpos
6054 && memNE(locinput, ST.c1_utf8, UTF8SKIP(locinput)))
6056 locinput += UTF8SKIP(locinput);
6061 /* set n to utf8_distance(oldloc, locinput) */
6062 while (locinput <= ST.maxpos
6063 && memNE(locinput, ST.c1_utf8, UTF8SKIP(locinput))
6064 && memNE(locinput, ST.c2_utf8, UTF8SKIP(locinput)))
6066 locinput += UTF8SKIP(locinput);
6071 else { /* Not utf8_target */
6072 if (ST.c1 == ST.c2) {
6073 while (locinput <= ST.maxpos &&
6074 UCHARAT(locinput) != ST.c1)
6078 while (locinput <= ST.maxpos
6079 && UCHARAT(locinput) != ST.c1
6080 && UCHARAT(locinput) != ST.c2)
6083 n = locinput - ST.oldloc;
6085 if (locinput > ST.maxpos)
6088 /* In /a{m,n}b/, ST.oldloc is at "a" x m, locinput is
6089 * at b; check that everything between oldloc and
6090 * locinput matches */
6091 char *li = ST.oldloc;
6093 if (regrepeat(rex, &li, ST.A, n, depth, is_utf8_pat) < n)
6095 assert(n == REG_INFTY || locinput == li);
6097 CURLY_SETPAREN(ST.paren, ST.count);
6098 if (cur_eval && cur_eval->u.eval.close_paren &&
6099 cur_eval->u.eval.close_paren == (U32)ST.paren) {
6102 PUSH_STATE_GOTO(CURLY_B_min_known, ST.B, locinput);
6104 assert(0); /* NOTREACHED */
6107 case CURLY_B_min_fail:
6108 /* failed to find B in a non-greedy match where c1,c2 invalid */
6110 REGCP_UNWIND(ST.cp);
6112 UNWIND_PAREN(ST.lastparen, ST.lastcloseparen);
6114 /* failed -- move forward one */
6116 char *li = locinput;
6117 if (!regrepeat(rex, &li, ST.A, 1, depth, is_utf8_pat)) {
6124 if (ST.count <= ST.max || (ST.max == REG_INFTY &&
6125 ST.count > 0)) /* count overflow ? */
6128 CURLY_SETPAREN(ST.paren, ST.count);
6129 if (cur_eval && cur_eval->u.eval.close_paren &&
6130 cur_eval->u.eval.close_paren == (U32)ST.paren) {
6133 PUSH_STATE_GOTO(CURLY_B_min, ST.B, locinput);
6137 assert(0); /* NOTREACHED */
6141 /* a successful greedy match: now try to match B */
6142 if (cur_eval && cur_eval->u.eval.close_paren &&
6143 cur_eval->u.eval.close_paren == (U32)ST.paren) {
6147 bool could_match = locinput < PL_regeol;
6149 /* If it could work, try it. */
6150 if (ST.c1 != CHRTEST_VOID && could_match) {
6151 if (! UTF8_IS_INVARIANT(UCHARAT(locinput)) && utf8_target)
6153 could_match = memEQ(locinput,
6158 UTF8SKIP(locinput));
6161 could_match = UCHARAT(locinput) == ST.c1
6162 || UCHARAT(locinput) == ST.c2;
6165 if (ST.c1 == CHRTEST_VOID || could_match) {
6166 CURLY_SETPAREN(ST.paren, ST.count);
6167 PUSH_STATE_GOTO(CURLY_B_max, ST.B, locinput);
6168 assert(0); /* NOTREACHED */
6173 case CURLY_B_max_fail:
6174 /* failed to find B in a greedy match */
6176 REGCP_UNWIND(ST.cp);
6178 UNWIND_PAREN(ST.lastparen, ST.lastcloseparen);
6181 if (--ST.count < ST.min)
6183 locinput = HOPc(locinput, -1);
6184 goto curly_try_B_max;
6188 case END: /* last op of main pattern */
6191 /* we've just finished A in /(??{A})B/; now continue with B */
6192 st->u.eval.saved_utf8_pat = is_utf8_pat;
6193 is_utf8_pat = cur_eval->u.eval.saved_utf8_pat;
6195 st->u.eval.prev_rex = rex_sv; /* inner */
6197 /* Save *all* the positions. */
6198 st->u.eval.cp = regcppush(rex, 0, maxopenparen);
6199 rex_sv = cur_eval->u.eval.prev_rex;
6200 SET_reg_curpm(rex_sv);
6201 rex = ReANY(rex_sv);
6202 rexi = RXi_GET(rex);
6203 cur_curlyx = cur_eval->u.eval.prev_curlyx;
6205 REGCP_SET(st->u.eval.lastcp);
6207 /* Restore parens of the outer rex without popping the
6209 S_regcp_restore(aTHX_ rex, cur_eval->u.eval.lastcp,
6212 st->u.eval.prev_eval = cur_eval;
6213 cur_eval = cur_eval->u.eval.prev_eval;
6215 PerlIO_printf(Perl_debug_log, "%*s EVAL trying tail ... %"UVxf"\n",
6216 REPORT_CODE_OFF+depth*2, "",PTR2UV(cur_eval)););
6217 if ( nochange_depth )
6220 PUSH_YES_STATE_GOTO(EVAL_AB, st->u.eval.prev_eval->u.eval.B,
6221 locinput); /* match B */
6224 if (locinput < reginfo->till) {
6225 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
6226 "%sMatch possible, but length=%ld is smaller than requested=%ld, failing!%s\n",
6228 (long)(locinput - PL_reg_starttry),
6229 (long)(reginfo->till - PL_reg_starttry),
6232 sayNO_SILENT; /* Cannot match: too short. */
6234 sayYES; /* Success! */
6236 case SUCCEED: /* successful SUSPEND/UNLESSM/IFMATCH/CURLYM */
6238 PerlIO_printf(Perl_debug_log,
6239 "%*s %ssubpattern success...%s\n",
6240 REPORT_CODE_OFF+depth*2, "", PL_colors[4], PL_colors[5]));
6241 sayYES; /* Success! */
6244 #define ST st->u.ifmatch
6249 case SUSPEND: /* (?>A) */
6251 newstart = locinput;
6254 case UNLESSM: /* -ve lookaround: (?!A), or with flags, (?<!A) */
6256 goto ifmatch_trivial_fail_test;
6258 case IFMATCH: /* +ve lookaround: (?=A), or with flags, (?<=A) */
6260 ifmatch_trivial_fail_test:
6262 char * const s = HOPBACKc(locinput, scan->flags);
6267 sw = 1 - cBOOL(ST.wanted);
6271 next = scan + ARG(scan);
6279 newstart = locinput;
6283 ST.logical = logical;
6284 logical = 0; /* XXX: reset state of logical once it has been saved into ST */
6286 /* execute body of (?...A) */
6287 PUSH_YES_STATE_GOTO(IFMATCH_A, NEXTOPER(NEXTOPER(scan)), newstart);
6288 assert(0); /* NOTREACHED */
6291 case IFMATCH_A_fail: /* body of (?...A) failed */
6292 ST.wanted = !ST.wanted;
6295 case IFMATCH_A: /* body of (?...A) succeeded */
6297 sw = cBOOL(ST.wanted);
6299 else if (!ST.wanted)
6302 if (OP(ST.me) != SUSPEND) {
6303 /* restore old position except for (?>...) */
6304 locinput = st->locinput;
6306 scan = ST.me + ARG(ST.me);
6309 continue; /* execute B */
6313 case LONGJMP: /* alternative with many branches compiles to
6314 * (BRANCHJ; EXACT ...; LONGJMP ) x N */
6315 next = scan + ARG(scan);
6320 case COMMIT: /* (*COMMIT) */
6321 reginfo->cutpoint = PL_regeol;
6324 case PRUNE: /* (*PRUNE) */
6326 sv_yes_mark = sv_commit = MUTABLE_SV(rexi->data->data[ ARG( scan ) ]);
6327 PUSH_STATE_GOTO(COMMIT_next, next, locinput);
6328 assert(0); /* NOTREACHED */
6330 case COMMIT_next_fail:
6334 case OPFAIL: /* (*FAIL) */
6336 assert(0); /* NOTREACHED */
6338 #define ST st->u.mark
6339 case MARKPOINT: /* (*MARK:foo) */
6340 ST.prev_mark = mark_state;
6341 ST.mark_name = sv_commit = sv_yes_mark
6342 = MUTABLE_SV(rexi->data->data[ ARG( scan ) ]);
6344 ST.mark_loc = locinput;
6345 PUSH_YES_STATE_GOTO(MARKPOINT_next, next, locinput);
6346 assert(0); /* NOTREACHED */
6348 case MARKPOINT_next:
6349 mark_state = ST.prev_mark;
6351 assert(0); /* NOTREACHED */
6353 case MARKPOINT_next_fail:
6354 if (popmark && sv_eq(ST.mark_name,popmark))
6356 if (ST.mark_loc > startpoint)
6357 reginfo->cutpoint = HOPBACKc(ST.mark_loc, 1);
6358 popmark = NULL; /* we found our mark */
6359 sv_commit = ST.mark_name;
6362 PerlIO_printf(Perl_debug_log,
6363 "%*s %ssetting cutpoint to mark:%"SVf"...%s\n",
6364 REPORT_CODE_OFF+depth*2, "",
6365 PL_colors[4], SVfARG(sv_commit), PL_colors[5]);
6368 mark_state = ST.prev_mark;
6369 sv_yes_mark = mark_state ?
6370 mark_state->u.mark.mark_name : NULL;
6372 assert(0); /* NOTREACHED */
6374 case SKIP: /* (*SKIP) */
6376 /* (*SKIP) : if we fail we cut here*/
6377 ST.mark_name = NULL;
6378 ST.mark_loc = locinput;
6379 PUSH_STATE_GOTO(SKIP_next,next, locinput);
6381 /* (*SKIP:NAME) : if there is a (*MARK:NAME) fail where it was,
6382 otherwise do nothing. Meaning we need to scan
6384 regmatch_state *cur = mark_state;
6385 SV *find = MUTABLE_SV(rexi->data->data[ ARG( scan ) ]);
6388 if ( sv_eq( cur->u.mark.mark_name,
6391 ST.mark_name = find;
6392 PUSH_STATE_GOTO( SKIP_next, next, locinput);
6394 cur = cur->u.mark.prev_mark;
6397 /* Didn't find our (*MARK:NAME) so ignore this (*SKIP:NAME) */
6400 case SKIP_next_fail:
6402 /* (*CUT:NAME) - Set up to search for the name as we
6403 collapse the stack*/
6404 popmark = ST.mark_name;
6406 /* (*CUT) - No name, we cut here.*/
6407 if (ST.mark_loc > startpoint)
6408 reginfo->cutpoint = HOPBACKc(ST.mark_loc, 1);
6409 /* but we set sv_commit to latest mark_name if there
6410 is one so they can test to see how things lead to this
6413 sv_commit=mark_state->u.mark.mark_name;
6417 assert(0); /* NOTREACHED */
6420 case LNBREAK: /* \R */
6421 if ((n=is_LNBREAK_safe(locinput, PL_regeol, utf8_target))) {
6428 PerlIO_printf(Perl_error_log, "%"UVxf" %d\n",
6429 PTR2UV(scan), OP(scan));
6430 Perl_croak(aTHX_ "regexp memory corruption");
6432 /* this is a point to jump to in order to increment
6433 * locinput by one character */
6435 assert(!NEXTCHR_IS_EOS);
6437 locinput += PL_utf8skip[nextchr];
6438 /* locinput is allowed to go 1 char off the end, but not 2+ */
6439 if (locinput > PL_regeol)
6448 /* switch break jumps here */
6449 scan = next; /* prepare to execute the next op and ... */
6450 continue; /* ... jump back to the top, reusing st */
6451 assert(0); /* NOTREACHED */
6454 /* push a state that backtracks on success */
6455 st->u.yes.prev_yes_state = yes_state;
6459 /* push a new regex state, then continue at scan */
6461 regmatch_state *newst;
6464 regmatch_state *cur = st;
6465 regmatch_state *curyes = yes_state;
6467 regmatch_slab *slab = PL_regmatch_slab;
6468 for (;curd > -1;cur--,curd--) {
6469 if (cur < SLAB_FIRST(slab)) {
6471 cur = SLAB_LAST(slab);
6473 PerlIO_printf(Perl_error_log, "%*s#%-3d %-10s %s\n",
6474 REPORT_CODE_OFF + 2 + depth * 2,"",
6475 curd, PL_reg_name[cur->resume_state],
6476 (curyes == cur) ? "yes" : ""
6479 curyes = cur->u.yes.prev_yes_state;
6482 DEBUG_STATE_pp("push")
6485 st->locinput = locinput;
6487 if (newst > SLAB_LAST(PL_regmatch_slab))
6488 newst = S_push_slab(aTHX);
6489 PL_regmatch_state = newst;
6491 locinput = pushinput;
6494 assert(0); /* NOTREACHED */
6499 * We get here only if there's trouble -- normally "case END" is
6500 * the terminating point.
6502 Perl_croak(aTHX_ "corrupted regexp pointers");
6508 /* we have successfully completed a subexpression, but we must now
6509 * pop to the state marked by yes_state and continue from there */
6510 assert(st != yes_state);
6512 while (st != yes_state) {
6514 if (st < SLAB_FIRST(PL_regmatch_slab)) {
6515 PL_regmatch_slab = PL_regmatch_slab->prev;
6516 st = SLAB_LAST(PL_regmatch_slab);
6520 DEBUG_STATE_pp("pop (no final)");
6522 DEBUG_STATE_pp("pop (yes)");
6528 while (yes_state < SLAB_FIRST(PL_regmatch_slab)
6529 || yes_state > SLAB_LAST(PL_regmatch_slab))
6531 /* not in this slab, pop slab */
6532 depth -= (st - SLAB_FIRST(PL_regmatch_slab) + 1);
6533 PL_regmatch_slab = PL_regmatch_slab->prev;
6534 st = SLAB_LAST(PL_regmatch_slab);
6536 depth -= (st - yes_state);
6539 yes_state = st->u.yes.prev_yes_state;
6540 PL_regmatch_state = st;
6543 locinput= st->locinput;
6544 state_num = st->resume_state + no_final;
6545 goto reenter_switch;
6548 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "%sMatch successful!%s\n",
6549 PL_colors[4], PL_colors[5]));
6551 if (PL_reg_state.re_state_eval_setup_done) {
6552 /* each successfully executed (?{...}) block does the equivalent of
6553 * local $^R = do {...}
6554 * When popping the save stack, all these locals would be undone;
6555 * bypass this by setting the outermost saved $^R to the latest
6557 if (oreplsv != GvSV(PL_replgv))
6558 sv_setsv(oreplsv, GvSV(PL_replgv));
6565 PerlIO_printf(Perl_debug_log,
6566 "%*s %sfailed...%s\n",
6567 REPORT_CODE_OFF+depth*2, "",
6568 PL_colors[4], PL_colors[5])
6580 /* there's a previous state to backtrack to */
6582 if (st < SLAB_FIRST(PL_regmatch_slab)) {
6583 PL_regmatch_slab = PL_regmatch_slab->prev;
6584 st = SLAB_LAST(PL_regmatch_slab);
6586 PL_regmatch_state = st;
6587 locinput= st->locinput;
6589 DEBUG_STATE_pp("pop");
6591 if (yes_state == st)
6592 yes_state = st->u.yes.prev_yes_state;
6594 state_num = st->resume_state + 1; /* failure = success + 1 */
6595 goto reenter_switch;
6600 if (rex->intflags & PREGf_VERBARG_SEEN) {
6601 SV *sv_err = get_sv("REGERROR", 1);
6602 SV *sv_mrk = get_sv("REGMARK", 1);
6604 sv_commit = &PL_sv_no;
6606 sv_yes_mark = &PL_sv_yes;
6609 sv_commit = &PL_sv_yes;
6610 sv_yes_mark = &PL_sv_no;
6612 sv_setsv(sv_err, sv_commit);
6613 sv_setsv(sv_mrk, sv_yes_mark);
6617 if (last_pushed_cv) {
6620 PERL_UNUSED_VAR(SP);
6623 /* clean up; in particular, free all slabs above current one */
6624 LEAVE_SCOPE(oldsave);
6626 assert(!result || locinput - PL_bostr >= 0);
6627 return result ? locinput - PL_bostr : -1;
6631 - regrepeat - repeatedly match something simple, report how many
6633 * What 'simple' means is a node which can be the operand of a quantifier like
6636 * startposp - pointer a pointer to the start position. This is updated
6637 * to point to the byte following the highest successful
6639 * p - the regnode to be repeatedly matched against.
6640 * max - maximum number of things to match.
6641 * depth - (for debugging) backtracking depth.
6644 S_regrepeat(pTHX_ regexp *prog, char **startposp, const regnode *p,
6645 I32 max, int depth, bool is_utf8_pat)
6648 char *scan; /* Pointer to current position in target string */
6650 char *loceol = PL_regeol; /* local version */
6651 I32 hardcount = 0; /* How many matches so far */
6652 bool utf8_target = PL_reg_match_utf8;
6653 int to_complement = 0; /* Invert the result? */
6655 _char_class_number classnum;
6657 PERL_UNUSED_ARG(depth);
6660 PERL_ARGS_ASSERT_REGREPEAT;
6663 if (max == REG_INFTY)
6665 else if (! utf8_target && loceol - scan > max)
6666 loceol = scan + max;
6668 /* Here, for the case of a non-UTF-8 target we have adjusted <loceol> down
6669 * to the maximum of how far we should go in it (leaving it set to the real
6670 * end, if the maximum permissible would take us beyond that). This allows
6671 * us to make the loop exit condition that we haven't gone past <loceol> to
6672 * also mean that we haven't exceeded the max permissible count, saving a
6673 * test each time through the loop. But it assumes that the OP matches a
6674 * single byte, which is true for most of the OPs below when applied to a
6675 * non-UTF-8 target. Those relatively few OPs that don't have this
6676 * characteristic will have to compensate.
6678 * There is no adjustment for UTF-8 targets, as the number of bytes per
6679 * character varies. OPs will have to test both that the count is less
6680 * than the max permissible (using <hardcount> to keep track), and that we
6681 * are still within the bounds of the string (using <loceol>. A few OPs
6682 * match a single byte no matter what the encoding. They can omit the max
6683 * test if, for the UTF-8 case, they do the adjustment that was skipped
6686 * Thus, the code above sets things up for the common case; and exceptional
6687 * cases need extra work; the common case is to make sure <scan> doesn't
6688 * go past <loceol>, and for UTF-8 to also use <hardcount> to make sure the
6689 * count doesn't exceed the maximum permissible */
6694 while (scan < loceol && hardcount < max && *scan != '\n') {
6695 scan += UTF8SKIP(scan);
6699 while (scan < loceol && *scan != '\n')
6705 while (scan < loceol && hardcount < max) {
6706 scan += UTF8SKIP(scan);
6713 case CANY: /* Move <scan> forward <max> bytes, unless goes off end */
6714 if (utf8_target && loceol - scan > max) {
6716 /* <loceol> hadn't been adjusted in the UTF-8 case */
6724 assert(STR_LEN(p) == is_utf8_pat ? UTF8SKIP(STRING(p)) : 1);
6728 /* Can use a simple loop if the pattern char to match on is invariant
6729 * under UTF-8, or both target and pattern aren't UTF-8. Note that we
6730 * can use UTF8_IS_INVARIANT() even if the pattern isn't UTF-8, as it's
6731 * true iff it doesn't matter if the argument is in UTF-8 or not */
6732 if (UTF8_IS_INVARIANT(c) || (! utf8_target && ! is_utf8_pat)) {
6733 if (utf8_target && loceol - scan > max) {
6734 /* We didn't adjust <loceol> because is UTF-8, but ok to do so,
6735 * since here, to match at all, 1 char == 1 byte */
6736 loceol = scan + max;
6738 while (scan < loceol && UCHARAT(scan) == c) {
6742 else if (is_utf8_pat) {
6744 STRLEN scan_char_len;
6746 /* When both target and pattern are UTF-8, we have to do
6748 while (hardcount < max
6750 && (scan_char_len = UTF8SKIP(scan)) <= STR_LEN(p)
6751 && memEQ(scan, STRING(p), scan_char_len))
6753 scan += scan_char_len;
6757 else if (! UTF8_IS_ABOVE_LATIN1(c)) {
6759 /* Target isn't utf8; convert the character in the UTF-8
6760 * pattern to non-UTF8, and do a simple loop */
6761 c = TWO_BYTE_UTF8_TO_UNI(c, *(STRING(p) + 1));
6762 while (scan < loceol && UCHARAT(scan) == c) {
6765 } /* else pattern char is above Latin1, can't possibly match the
6770 /* Here, the string must be utf8; pattern isn't, and <c> is
6771 * different in utf8 than not, so can't compare them directly.
6772 * Outside the loop, find the two utf8 bytes that represent c, and
6773 * then look for those in sequence in the utf8 string */
6774 U8 high = UTF8_TWO_BYTE_HI(c);
6775 U8 low = UTF8_TWO_BYTE_LO(c);
6777 while (hardcount < max
6778 && scan + 1 < loceol
6779 && UCHARAT(scan) == high
6780 && UCHARAT(scan + 1) == low)
6789 utf8_flags = FOLDEQ_UTF8_NOMIX_ASCII;
6793 RXp_MATCH_TAINTED_on(prog);
6794 utf8_flags = FOLDEQ_UTF8_LOCALE;
6802 case EXACTFU_TRICKYFOLD:
6804 utf8_flags = is_utf8_pat ? FOLDEQ_S2_ALREADY_FOLDED : 0;
6808 U8 c1_utf8[UTF8_MAXBYTES+1], c2_utf8[UTF8_MAXBYTES+1];
6810 assert(STR_LEN(p) == is_utf8_pat ? UTF8SKIP(STRING(p)) : 1);
6812 if (S_setup_EXACTISH_ST_c1_c2(aTHX_ p, &c1, c1_utf8, &c2, c2_utf8,
6815 if (c1 == CHRTEST_VOID) {
6816 /* Use full Unicode fold matching */
6817 char *tmpeol = PL_regeol;
6818 STRLEN pat_len = is_utf8_pat ? UTF8SKIP(STRING(p)) : 1;
6819 while (hardcount < max
6820 && foldEQ_utf8_flags(scan, &tmpeol, 0, utf8_target,
6821 STRING(p), NULL, pat_len,
6822 is_utf8_pat, utf8_flags))
6829 else if (utf8_target) {
6831 while (scan < loceol
6833 && memEQ(scan, c1_utf8, UTF8SKIP(scan)))
6835 scan += UTF8SKIP(scan);
6840 while (scan < loceol
6842 && (memEQ(scan, c1_utf8, UTF8SKIP(scan))
6843 || memEQ(scan, c2_utf8, UTF8SKIP(scan))))
6845 scan += UTF8SKIP(scan);
6850 else if (c1 == c2) {
6851 while (scan < loceol && UCHARAT(scan) == c1) {
6856 while (scan < loceol &&
6857 (UCHARAT(scan) == c1 || UCHARAT(scan) == c2))
6866 case ANYOF_WARN_SUPER:
6868 while (hardcount < max
6870 && reginclass(prog, p, (U8*)scan, utf8_target))
6872 scan += UTF8SKIP(scan);
6876 while (scan < loceol && REGINCLASS(prog, p, (U8*)scan))
6881 /* The argument (FLAGS) to all the POSIX node types is the class number */
6888 RXp_MATCH_TAINTED_on(prog);
6889 if (! utf8_target) {
6890 while (scan < loceol && to_complement ^ cBOOL(isFOO_lc(FLAGS(p),
6896 while (hardcount < max && scan < loceol
6897 && to_complement ^ cBOOL(isFOO_utf8_lc(FLAGS(p),
6900 scan += UTF8SKIP(scan);
6913 if (utf8_target && loceol - scan > max) {
6915 /* We didn't adjust <loceol> at the beginning of this routine
6916 * because is UTF-8, but it is actually ok to do so, since here, to
6917 * match, 1 char == 1 byte. */
6918 loceol = scan + max;
6920 while (scan < loceol && _generic_isCC_A((U8) *scan, FLAGS(p))) {
6933 if (! utf8_target) {
6934 while (scan < loceol && ! _generic_isCC_A((U8) *scan, FLAGS(p))) {
6940 /* The complement of something that matches only ASCII matches all
6941 * UTF-8 variant code points, plus everything in ASCII that isn't
6943 while (hardcount < max && scan < loceol
6944 && (! UTF8_IS_INVARIANT(*scan)
6945 || ! _generic_isCC_A((U8) *scan, FLAGS(p))))
6947 scan += UTF8SKIP(scan);
6958 if (! utf8_target) {
6959 while (scan < loceol && to_complement
6960 ^ cBOOL(_generic_isCC((U8) *scan, FLAGS(p))))
6967 classnum = (_char_class_number) FLAGS(p);
6968 if (classnum < _FIRST_NON_SWASH_CC) {
6970 /* Here, a swash is needed for above-Latin1 code points.
6971 * Process as many Latin1 code points using the built-in rules.
6972 * Go to another loop to finish processing upon encountering
6973 * the first Latin1 code point. We could do that in this loop
6974 * as well, but the other way saves having to test if the swash
6975 * has been loaded every time through the loop: extra space to
6977 while (hardcount < max && scan < loceol) {
6978 if (UTF8_IS_INVARIANT(*scan)) {
6979 if (! (to_complement ^ cBOOL(_generic_isCC((U8) *scan,
6986 else if (UTF8_IS_DOWNGRADEABLE_START(*scan)) {
6987 if (! (to_complement
6988 ^ cBOOL(_generic_isCC(TWO_BYTE_UTF8_TO_UNI(*scan,
6997 goto found_above_latin1;
7004 /* For these character classes, the knowledge of how to handle
7005 * every code point is compiled in to Perl via a macro. This
7006 * code is written for making the loops as tight as possible.
7007 * It could be refactored to save space instead */
7009 case _CC_ENUM_SPACE: /* XXX would require separate code
7010 if we revert the change of \v
7013 case _CC_ENUM_PSXSPC:
7014 while (hardcount < max
7016 && (to_complement ^ cBOOL(isSPACE_utf8(scan))))
7018 scan += UTF8SKIP(scan);
7022 case _CC_ENUM_BLANK:
7023 while (hardcount < max
7025 && (to_complement ^ cBOOL(isBLANK_utf8(scan))))
7027 scan += UTF8SKIP(scan);
7031 case _CC_ENUM_XDIGIT:
7032 while (hardcount < max
7034 && (to_complement ^ cBOOL(isXDIGIT_utf8(scan))))
7036 scan += UTF8SKIP(scan);
7040 case _CC_ENUM_VERTSPACE:
7041 while (hardcount < max
7043 && (to_complement ^ cBOOL(isVERTWS_utf8(scan))))
7045 scan += UTF8SKIP(scan);
7049 case _CC_ENUM_CNTRL:
7050 while (hardcount < max
7052 && (to_complement ^ cBOOL(isCNTRL_utf8(scan))))
7054 scan += UTF8SKIP(scan);
7059 Perl_croak(aTHX_ "panic: regrepeat() node %d='%s' has an unexpected character class '%d'", OP(p), PL_reg_name[OP(p)], classnum);
7065 found_above_latin1: /* Continuation of POSIXU and NPOSIXU */
7067 /* Load the swash if not already present */
7068 if (! PL_utf8_swash_ptrs[classnum]) {
7069 U8 flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;
7070 PL_utf8_swash_ptrs[classnum] = _core_swash_init(
7071 "utf8", swash_property_names[classnum],
7072 &PL_sv_undef, 1, 0, NULL, &flags);
7075 while (hardcount < max && scan < loceol
7076 && to_complement ^ cBOOL(_generic_utf8(
7079 swash_fetch(PL_utf8_swash_ptrs[classnum],
7083 scan += UTF8SKIP(scan);
7090 while (hardcount < max && scan < loceol &&
7091 (c=is_LNBREAK_utf8_safe(scan, loceol))) {
7096 /* LNBREAK can match one or two latin chars, which is ok, but we
7097 * have to use hardcount in this situation, and throw away the
7098 * adjustment to <loceol> done before the switch statement */
7100 while (scan < loceol && (c=is_LNBREAK_latin1_safe(scan, loceol))) {
7121 /* These are all 0 width, so match right here or not at all. */
7125 Perl_croak(aTHX_ "panic: regrepeat() called with unrecognized node type %d='%s'", OP(p), PL_reg_name[OP(p)]);
7126 assert(0); /* NOTREACHED */
7133 c = scan - *startposp;
7137 GET_RE_DEBUG_FLAGS_DECL;
7139 SV * const prop = sv_newmortal();
7140 regprop(prog, prop, p);
7141 PerlIO_printf(Perl_debug_log,
7142 "%*s %s can match %"IVdf" times out of %"IVdf"...\n",
7143 REPORT_CODE_OFF + depth*2, "", SvPVX_const(prop),(IV)c,(IV)max);
7151 #if !defined(PERL_IN_XSUB_RE) || defined(PLUGGABLE_RE_EXTENSION)
7153 - regclass_swash - prepare the utf8 swash. Wraps the shared core version to
7154 create a copy so that changes the caller makes won't change the shared one.
7155 If <altsvp> is non-null, will return NULL in it, for back-compat.
7158 Perl_regclass_swash(pTHX_ const regexp *prog, const regnode* node, bool doinit, SV** listsvp, SV **altsvp)
7160 PERL_ARGS_ASSERT_REGCLASS_SWASH;
7166 return newSVsv(core_regclass_swash(prog, node, doinit, listsvp));
7171 S_core_regclass_swash(pTHX_ const regexp *prog, const regnode* node, bool doinit, SV** listsvp)
7173 /* Returns the swash for the input 'node' in the regex 'prog'.
7174 * If <doinit> is true, will attempt to create the swash if not already
7176 * If <listsvp> is non-null, will return the swash initialization string in
7178 * Tied intimately to how regcomp.c sets up the data structure */
7185 RXi_GET_DECL(prog,progi);
7186 const struct reg_data * const data = prog ? progi->data : NULL;
7188 PERL_ARGS_ASSERT_CORE_REGCLASS_SWASH;
7190 assert(ANYOF_NONBITMAP(node));
7192 if (data && data->count) {
7193 const U32 n = ARG(node);
7195 if (data->what[n] == 's') {
7196 SV * const rv = MUTABLE_SV(data->data[n]);
7197 AV * const av = MUTABLE_AV(SvRV(rv));
7198 SV **const ary = AvARRAY(av);
7199 U8 swash_init_flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;
7201 si = *ary; /* ary[0] = the string to initialize the swash with */
7203 /* Elements 2 and 3 are either both present or both absent. [2] is
7204 * any inversion list generated at compile time; [3] indicates if
7205 * that inversion list has any user-defined properties in it. */
7206 if (av_len(av) >= 2) {
7209 swash_init_flags |= _CORE_SWASH_INIT_USER_DEFINED_PROPERTY;
7216 /* Element [1] is reserved for the set-up swash. If already there,
7217 * return it; if not, create it and store it there */
7218 if (SvROK(ary[1])) {
7221 else if (si && doinit) {
7223 sw = _core_swash_init("utf8", /* the utf8 package */
7227 0, /* not from tr/// */
7230 (void)av_store(av, 1, sw);
7236 SV* matches_string = newSVpvn("", 0);
7238 /* Use the swash, if any, which has to have incorporated into it all
7240 if ((! sw || (invlist = _get_swash_invlist(sw)) == NULL)
7241 && (si && si != &PL_sv_undef))
7244 /* If no swash, use the input initialization string, if available */
7245 sv_catsv(matches_string, si);
7248 /* Add the inversion list to whatever we have. This may have come from
7249 * the swash, or from an input parameter */
7251 sv_catsv(matches_string, _invlist_contents(invlist));
7253 *listsvp = matches_string;
7260 - reginclass - determine if a character falls into a character class
7262 n is the ANYOF regnode
7263 p is the target string
7264 utf8_target tells whether p is in UTF-8.
7266 Returns true if matched; false otherwise.
7268 Note that this can be a synthetic start class, a combination of various
7269 nodes, so things you think might be mutually exclusive, such as locale,
7270 aren't. It can match both locale and non-locale
7275 S_reginclass(pTHX_ regexp * const prog, const regnode * const n, const U8* const p, const bool utf8_target)
7278 const char flags = ANYOF_FLAGS(n);
7282 PERL_ARGS_ASSERT_REGINCLASS;
7284 /* If c is not already the code point, get it. Note that
7285 * UTF8_IS_INVARIANT() works even if not in UTF-8 */
7286 if (! UTF8_IS_INVARIANT(c) && utf8_target) {
7288 c = utf8n_to_uvchr(p, UTF8_MAXBYTES, &c_len,
7289 (UTF8_ALLOW_DEFAULT & UTF8_ALLOW_ANYUV)
7290 | UTF8_ALLOW_FFFF | UTF8_CHECK_ONLY);
7291 /* see [perl #37836] for UTF8_ALLOW_ANYUV; [perl #38293] for
7292 * UTF8_ALLOW_FFFF */
7293 if (c_len == (STRLEN)-1)
7294 Perl_croak(aTHX_ "Malformed UTF-8 character (fatal)");
7297 /* If this character is potentially in the bitmap, check it */
7299 if (ANYOF_BITMAP_TEST(n, c))
7301 else if (flags & ANYOF_NON_UTF8_LATIN1_ALL
7307 else if (flags & ANYOF_LOCALE) {
7308 RXp_MATCH_TAINTED_on(prog);
7310 if ((flags & ANYOF_LOC_FOLD)
7311 && ANYOF_BITMAP_TEST(n, PL_fold_locale[c]))
7315 else if (ANYOF_CLASS_TEST_ANY_SET(n)) {
7317 /* The data structure is arranged so bits 0, 2, 4, ... are set
7318 * if the class includes the Posix character class given by
7319 * bit/2; and 1, 3, 5, ... are set if the class includes the
7320 * complemented Posix class given by int(bit/2). So we loop
7321 * through the bits, each time changing whether we complement
7322 * the result or not. Suppose for the sake of illustration
7323 * that bits 0-3 mean respectively, \w, \W, \s, \S. If bit 0
7324 * is set, it means there is a match for this ANYOF node if the
7325 * character is in the class given by the expression (0 / 2 = 0
7326 * = \w). If it is in that class, isFOO_lc() will return 1,
7327 * and since 'to_complement' is 0, the result will stay TRUE,
7328 * and we exit the loop. Suppose instead that bit 0 is 0, but
7329 * bit 1 is 1. That means there is a match if the character
7330 * matches \W. We won't bother to call isFOO_lc() on bit 0,
7331 * but will on bit 1. On the second iteration 'to_complement'
7332 * will be 1, so the exclusive or will reverse things, so we
7333 * are testing for \W. On the third iteration, 'to_complement'
7334 * will be 0, and we would be testing for \s; the fourth
7335 * iteration would test for \S, etc.
7337 * Note that this code assumes that all the classes are closed
7338 * under folding. For example, if a character matches \w, then
7339 * its fold does too; and vice versa. This should be true for
7340 * any well-behaved locale for all the currently defined Posix
7341 * classes, except for :lower: and :upper:, which are handled
7342 * by the pseudo-class :cased: which matches if either of the
7343 * other two does. To get rid of this assumption, an outer
7344 * loop could be used below to iterate over both the source
7345 * character, and its fold (if different) */
7348 int to_complement = 0;
7349 while (count < ANYOF_MAX) {
7350 if (ANYOF_CLASS_TEST(n, count)
7351 && to_complement ^ cBOOL(isFOO_lc(count/2, (U8) c)))
7363 /* If the bitmap didn't (or couldn't) match, and something outside the
7364 * bitmap could match, try that. Locale nodes specify completely the
7365 * behavior of code points in the bit map (otherwise, a utf8 target would
7366 * cause them to be treated as Unicode and not locale), except in
7367 * the very unlikely event when this node is a synthetic start class, which
7368 * could be a combination of locale and non-locale nodes. So allow locale
7369 * to match for the synthetic start class, which will give a false
7370 * positive that will be resolved when the match is done again as not part
7371 * of the synthetic start class */
7373 if (utf8_target && (flags & ANYOF_UNICODE_ALL) && c >= 256) {
7374 match = TRUE; /* Everything above 255 matches */
7376 else if (ANYOF_NONBITMAP(n)
7377 && ((flags & ANYOF_NONBITMAP_NON_UTF8)
7380 || (! (flags & ANYOF_LOCALE))
7381 || OP(n) == ANYOF_SYNTHETIC))))
7383 SV * const sw = core_regclass_swash(prog, n, TRUE, 0);
7388 } else { /* Convert to utf8 */
7390 utf8_p = bytes_to_utf8(p, &len);
7393 if (swash_fetch(sw, utf8_p, TRUE)) {
7397 /* If we allocated a string above, free it */
7398 if (! utf8_target) Safefree(utf8_p);
7402 if (UNICODE_IS_SUPER(c)
7403 && OP(n) == ANYOF_WARN_SUPER
7404 && ckWARN_d(WARN_NON_UNICODE))
7406 Perl_warner(aTHX_ packWARN(WARN_NON_UNICODE),
7407 "Code point 0x%04"UVXf" is not Unicode, all \\p{} matches fail; all \\P{} matches succeed", c);
7411 /* The xor complements the return if to invert: 1^1 = 0, 1^0 = 1 */
7412 return cBOOL(flags & ANYOF_INVERT) ^ match;
7416 S_reghop3(U8 *s, I32 off, const U8* lim)
7418 /* return the position 'off' UTF-8 characters away from 's', forward if
7419 * 'off' >= 0, backwards if negative. But don't go outside of position
7420 * 'lim', which better be < s if off < 0 */
7424 PERL_ARGS_ASSERT_REGHOP3;
7427 while (off-- && s < lim) {
7428 /* XXX could check well-formedness here */
7433 while (off++ && s > lim) {
7435 if (UTF8_IS_CONTINUED(*s)) {
7436 while (s > lim && UTF8_IS_CONTINUATION(*s))
7439 /* XXX could check well-formedness here */
7446 /* there are a bunch of places where we use two reghop3's that should
7447 be replaced with this routine. but since thats not done yet
7448 we ifdef it out - dmq
7451 S_reghop4(U8 *s, I32 off, const U8* llim, const U8* rlim)
7455 PERL_ARGS_ASSERT_REGHOP4;
7458 while (off-- && s < rlim) {
7459 /* XXX could check well-formedness here */
7464 while (off++ && s > llim) {
7466 if (UTF8_IS_CONTINUED(*s)) {
7467 while (s > llim && UTF8_IS_CONTINUATION(*s))
7470 /* XXX could check well-formedness here */
7478 S_reghopmaybe3(U8* s, I32 off, const U8* lim)
7482 PERL_ARGS_ASSERT_REGHOPMAYBE3;
7485 while (off-- && s < lim) {
7486 /* XXX could check well-formedness here */
7493 while (off++ && s > lim) {
7495 if (UTF8_IS_CONTINUED(*s)) {
7496 while (s > lim && UTF8_IS_CONTINUATION(*s))
7499 /* XXX could check well-formedness here */
7508 restore_pos(pTHX_ void *arg)
7511 regexp * const rex = (regexp *)arg;
7512 if (PL_reg_state.re_state_eval_setup_done) {
7513 if (PL_reg_oldsaved) {
7514 rex->subbeg = PL_reg_oldsaved;
7515 rex->sublen = PL_reg_oldsavedlen;
7516 rex->suboffset = PL_reg_oldsavedoffset;
7517 rex->subcoffset = PL_reg_oldsavedcoffset;
7519 rex->saved_copy = PL_nrs;
7521 RXp_MATCH_COPIED_on(rex);
7523 PL_reg_magic->mg_len = PL_reg_oldpos;
7524 PL_reg_state.re_state_eval_setup_done = FALSE;
7525 PL_curpm = PL_reg_oldcurpm;
7530 S_to_utf8_substr(pTHX_ regexp *prog)
7532 /* Converts substr fields in prog from bytes to UTF-8, calling fbm_compile
7533 * on the converted value */
7537 PERL_ARGS_ASSERT_TO_UTF8_SUBSTR;
7540 if (prog->substrs->data[i].substr
7541 && !prog->substrs->data[i].utf8_substr) {
7542 SV* const sv = newSVsv(prog->substrs->data[i].substr);
7543 prog->substrs->data[i].utf8_substr = sv;
7544 sv_utf8_upgrade(sv);
7545 if (SvVALID(prog->substrs->data[i].substr)) {
7546 if (SvTAIL(prog->substrs->data[i].substr)) {
7547 /* Trim the trailing \n that fbm_compile added last
7549 SvCUR_set(sv, SvCUR(sv) - 1);
7550 /* Whilst this makes the SV technically "invalid" (as its
7551 buffer is no longer followed by "\0") when fbm_compile()
7552 adds the "\n" back, a "\0" is restored. */
7553 fbm_compile(sv, FBMcf_TAIL);
7557 if (prog->substrs->data[i].substr == prog->check_substr)
7558 prog->check_utf8 = sv;
7564 S_to_byte_substr(pTHX_ regexp *prog)
7566 /* Converts substr fields in prog from UTF-8 to bytes, calling fbm_compile
7567 * on the converted value; returns FALSE if can't be converted. */
7572 PERL_ARGS_ASSERT_TO_BYTE_SUBSTR;
7575 if (prog->substrs->data[i].utf8_substr
7576 && !prog->substrs->data[i].substr) {
7577 SV* sv = newSVsv(prog->substrs->data[i].utf8_substr);
7578 if (! sv_utf8_downgrade(sv, TRUE)) {
7581 if (SvVALID(prog->substrs->data[i].utf8_substr)) {
7582 if (SvTAIL(prog->substrs->data[i].utf8_substr)) {
7583 /* Trim the trailing \n that fbm_compile added last
7585 SvCUR_set(sv, SvCUR(sv) - 1);
7586 fbm_compile(sv, FBMcf_TAIL);
7590 prog->substrs->data[i].substr = sv;
7591 if (prog->substrs->data[i].utf8_substr == prog->check_utf8)
7592 prog->check_substr = sv;
7601 * c-indentation-style: bsd
7603 * indent-tabs-mode: nil
7606 * ex: set ts=8 sts=4 sw=4 et: