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) (reginfo->is_utf8_target ? utf8_distance(a,b) : a - b)
115 #define HOPc(pos,off) \
116 (char *)(reginfo->is_utf8_target \
117 ? reghop3((U8*)pos, off, \
118 (U8*)(off >= 0 ? reginfo->strend : reginfo->strbeg)) \
120 #define HOPBACKc(pos, off) \
121 (char*)(reginfo->is_utf8_target \
122 ? reghopmaybe3((U8*)pos, -off, (U8*)(reginfo->strbeg)) \
123 : (pos - off >= reginfo->strbeg) \
127 #define HOP3(pos,off,lim) (reginfo->is_utf8_target ? reghop3((U8*)(pos), off, (U8*)(lim)) : (U8*)(pos + off))
128 #define HOP3c(pos,off,lim) ((char*)HOP3(pos,off,lim))
131 #define NEXTCHR_EOS -10 /* nextchr has fallen off the end */
132 #define NEXTCHR_IS_EOS (nextchr < 0)
134 #define SET_nextchr \
135 nextchr = ((locinput < reginfo->strend) ? UCHARAT(locinput) : NEXTCHR_EOS)
137 #define SET_locinput(p) \
142 #define LOAD_UTF8_CHARCLASS(swash_ptr, property_name) STMT_START { \
144 U8 flags = _CORE_SWASH_INIT_ACCEPT_INVLIST; \
145 swash_ptr = _core_swash_init("utf8", property_name, &PL_sv_undef, \
146 1, 0, NULL, &flags); \
151 /* If in debug mode, we test that a known character properly matches */
153 # define LOAD_UTF8_CHARCLASS_DEBUG_TEST(swash_ptr, \
155 utf8_char_in_property) \
156 LOAD_UTF8_CHARCLASS(swash_ptr, property_name); \
157 assert(swash_fetch(swash_ptr, (U8 *) utf8_char_in_property, TRUE));
159 # define LOAD_UTF8_CHARCLASS_DEBUG_TEST(swash_ptr, \
161 utf8_char_in_property) \
162 LOAD_UTF8_CHARCLASS(swash_ptr, property_name)
165 #define LOAD_UTF8_CHARCLASS_ALNUM() LOAD_UTF8_CHARCLASS_DEBUG_TEST( \
166 PL_utf8_swash_ptrs[_CC_WORDCHAR], \
167 swash_property_names[_CC_WORDCHAR], \
168 LATIN_CAPITAL_LETTER_SHARP_S_UTF8);
170 #define LOAD_UTF8_CHARCLASS_GCB() /* Grapheme cluster boundaries */ \
172 LOAD_UTF8_CHARCLASS_DEBUG_TEST(PL_utf8_X_regular_begin, \
173 "_X_regular_begin", \
174 LATIN_CAPITAL_LETTER_SHARP_S_UTF8); \
175 LOAD_UTF8_CHARCLASS_DEBUG_TEST(PL_utf8_X_extend, \
177 COMBINING_GRAVE_ACCENT_UTF8); \
180 #define PLACEHOLDER /* Something for the preprocessor to grab onto */
181 /* TODO: Combine JUMPABLE and HAS_TEXT to cache OP(rn) */
183 /* for use after a quantifier and before an EXACT-like node -- japhy */
184 /* it would be nice to rework regcomp.sym to generate this stuff. sigh
186 * NOTE that *nothing* that affects backtracking should be in here, specifically
187 * VERBS must NOT be included. JUMPABLE is used to determine if we can ignore a
188 * node that is in between two EXACT like nodes when ascertaining what the required
189 * "follow" character is. This should probably be moved to regex compile time
190 * although it may be done at run time beause of the REF possibility - more
191 * investigation required. -- demerphq
193 #define JUMPABLE(rn) ( \
195 (OP(rn) == CLOSE && (!cur_eval || cur_eval->u.eval.close_paren != ARG(rn))) || \
197 OP(rn) == SUSPEND || OP(rn) == IFMATCH || \
198 OP(rn) == PLUS || OP(rn) == MINMOD || \
200 (PL_regkind[OP(rn)] == CURLY && ARG1(rn) > 0) \
202 #define IS_EXACT(rn) (PL_regkind[OP(rn)] == EXACT)
204 #define HAS_TEXT(rn) ( IS_EXACT(rn) || PL_regkind[OP(rn)] == REF )
207 /* Currently these are only used when PL_regkind[OP(rn)] == EXACT so
208 we don't need this definition. */
209 #define IS_TEXT(rn) ( OP(rn)==EXACT || OP(rn)==REF || OP(rn)==NREF )
210 #define IS_TEXTF(rn) ( OP(rn)==EXACTFU || OP(rn)==EXACTFU_SS || OP(rn)==EXACTFA || OP(rn)==EXACTFA_NO_TRIE || OP(rn)==EXACTF || OP(rn)==REFF || OP(rn)==NREFF )
211 #define IS_TEXTFL(rn) ( OP(rn)==EXACTFL || OP(rn)==REFFL || OP(rn)==NREFFL )
214 /* ... so we use this as its faster. */
215 #define IS_TEXT(rn) ( OP(rn)==EXACT )
216 #define IS_TEXTFU(rn) ( OP(rn)==EXACTFU || OP(rn)==EXACTFU_SS || OP(rn) == EXACTFA || OP(rn) == EXACTFA_NO_TRIE)
217 #define IS_TEXTF(rn) ( OP(rn)==EXACTF )
218 #define IS_TEXTFL(rn) ( OP(rn)==EXACTFL )
223 Search for mandatory following text node; for lookahead, the text must
224 follow but for lookbehind (rn->flags != 0) we skip to the next step.
226 #define FIND_NEXT_IMPT(rn) STMT_START { \
227 while (JUMPABLE(rn)) { \
228 const OPCODE type = OP(rn); \
229 if (type == SUSPEND || PL_regkind[type] == CURLY) \
230 rn = NEXTOPER(NEXTOPER(rn)); \
231 else if (type == PLUS) \
233 else if (type == IFMATCH) \
234 rn = (rn->flags == 0) ? NEXTOPER(NEXTOPER(rn)) : rn + ARG(rn); \
235 else rn += NEXT_OFF(rn); \
239 /* These constants are for finding GCB=LV and GCB=LVT in the CLUMP regnode.
240 * These are for the pre-composed Hangul syllables, which are all in a
241 * contiguous block and arranged there in such a way so as to facilitate
242 * alorithmic determination of their characteristics. As such, they don't need
243 * a swash, but can be determined by simple arithmetic. Almost all are
244 * GCB=LVT, but every 28th one is a GCB=LV */
245 #define SBASE 0xAC00 /* Start of block */
246 #define SCount 11172 /* Length of block */
249 #define SLAB_FIRST(s) (&(s)->states[0])
250 #define SLAB_LAST(s) (&(s)->states[PERL_REGMATCH_SLAB_SLOTS-1])
252 static void S_setup_eval_state(pTHX_ regmatch_info *const reginfo);
253 static void S_cleanup_regmatch_info_aux(pTHX_ void *arg);
254 static regmatch_state * S_push_slab(pTHX);
256 #define REGCP_PAREN_ELEMS 3
257 #define REGCP_OTHER_ELEMS 3
258 #define REGCP_FRAME_ELEMS 1
259 /* REGCP_FRAME_ELEMS are not part of the REGCP_OTHER_ELEMS and
260 * are needed for the regexp context stack bookkeeping. */
263 S_regcppush(pTHX_ const regexp *rex, I32 parenfloor, U32 maxopenparen)
266 const int retval = PL_savestack_ix;
267 const int paren_elems_to_push =
268 (maxopenparen - parenfloor) * REGCP_PAREN_ELEMS;
269 const UV total_elems = paren_elems_to_push + REGCP_OTHER_ELEMS;
270 const UV elems_shifted = total_elems << SAVE_TIGHT_SHIFT;
272 GET_RE_DEBUG_FLAGS_DECL;
274 PERL_ARGS_ASSERT_REGCPPUSH;
276 if (paren_elems_to_push < 0)
277 Perl_croak(aTHX_ "panic: paren_elems_to_push, %i < 0",
278 paren_elems_to_push);
280 if ((elems_shifted >> SAVE_TIGHT_SHIFT) != total_elems)
281 Perl_croak(aTHX_ "panic: paren_elems_to_push offset %"UVuf
282 " out of range (%lu-%ld)",
284 (unsigned long)maxopenparen,
287 SSGROW(total_elems + REGCP_FRAME_ELEMS);
290 if ((int)maxopenparen > (int)parenfloor)
291 PerlIO_printf(Perl_debug_log,
292 "rex=0x%"UVxf" offs=0x%"UVxf": saving capture indices:\n",
297 for (p = parenfloor+1; p <= (I32)maxopenparen; p++) {
298 /* REGCP_PARENS_ELEMS are pushed per pairs of parentheses. */
299 SSPUSHIV(rex->offs[p].end);
300 SSPUSHIV(rex->offs[p].start);
301 SSPUSHINT(rex->offs[p].start_tmp);
302 DEBUG_BUFFERS_r(PerlIO_printf(Perl_debug_log,
303 " \\%"UVuf": %"IVdf"(%"IVdf")..%"IVdf"\n",
305 (IV)rex->offs[p].start,
306 (IV)rex->offs[p].start_tmp,
310 /* REGCP_OTHER_ELEMS are pushed in any case, parentheses or no. */
311 SSPUSHINT(maxopenparen);
312 SSPUSHINT(rex->lastparen);
313 SSPUSHINT(rex->lastcloseparen);
314 SSPUSHUV(SAVEt_REGCONTEXT | elems_shifted); /* Magic cookie. */
319 /* These are needed since we do not localize EVAL nodes: */
320 #define REGCP_SET(cp) \
322 PerlIO_printf(Perl_debug_log, \
323 " Setting an EVAL scope, savestack=%"IVdf"\n", \
324 (IV)PL_savestack_ix)); \
327 #define REGCP_UNWIND(cp) \
329 if (cp != PL_savestack_ix) \
330 PerlIO_printf(Perl_debug_log, \
331 " Clearing an EVAL scope, savestack=%"IVdf"..%"IVdf"\n", \
332 (IV)(cp), (IV)PL_savestack_ix)); \
335 #define UNWIND_PAREN(lp, lcp) \
336 for (n = rex->lastparen; n > lp; n--) \
337 rex->offs[n].end = -1; \
338 rex->lastparen = n; \
339 rex->lastcloseparen = lcp;
343 S_regcppop(pTHX_ regexp *rex, U32 *maxopenparen_p)
348 GET_RE_DEBUG_FLAGS_DECL;
350 PERL_ARGS_ASSERT_REGCPPOP;
352 /* Pop REGCP_OTHER_ELEMS before the parentheses loop starts. */
354 assert((i & SAVE_MASK) == SAVEt_REGCONTEXT); /* Check that the magic cookie is there. */
355 i >>= SAVE_TIGHT_SHIFT; /* Parentheses elements to pop. */
356 rex->lastcloseparen = SSPOPINT;
357 rex->lastparen = SSPOPINT;
358 *maxopenparen_p = SSPOPINT;
360 i -= REGCP_OTHER_ELEMS;
361 /* Now restore the parentheses context. */
363 if (i || rex->lastparen + 1 <= rex->nparens)
364 PerlIO_printf(Perl_debug_log,
365 "rex=0x%"UVxf" offs=0x%"UVxf": restoring capture indices to:\n",
370 paren = *maxopenparen_p;
371 for ( ; i > 0; i -= REGCP_PAREN_ELEMS) {
373 rex->offs[paren].start_tmp = SSPOPINT;
374 rex->offs[paren].start = SSPOPIV;
376 if (paren <= rex->lastparen)
377 rex->offs[paren].end = tmps;
378 DEBUG_BUFFERS_r( PerlIO_printf(Perl_debug_log,
379 " \\%"UVuf": %"IVdf"(%"IVdf")..%"IVdf"%s\n",
381 (IV)rex->offs[paren].start,
382 (IV)rex->offs[paren].start_tmp,
383 (IV)rex->offs[paren].end,
384 (paren > rex->lastparen ? "(skipped)" : ""));
389 /* It would seem that the similar code in regtry()
390 * already takes care of this, and in fact it is in
391 * a better location to since this code can #if 0-ed out
392 * but the code in regtry() is needed or otherwise tests
393 * requiring null fields (pat.t#187 and split.t#{13,14}
394 * (as of patchlevel 7877) will fail. Then again,
395 * this code seems to be necessary or otherwise
396 * this erroneously leaves $1 defined: "1" =~ /^(?:(\d)x)?\d$/
397 * --jhi updated by dapm */
398 for (i = rex->lastparen + 1; i <= rex->nparens; i++) {
399 if (i > *maxopenparen_p)
400 rex->offs[i].start = -1;
401 rex->offs[i].end = -1;
402 DEBUG_BUFFERS_r( PerlIO_printf(Perl_debug_log,
403 " \\%"UVuf": %s ..-1 undeffing\n",
405 (i > *maxopenparen_p) ? "-1" : " "
411 /* restore the parens and associated vars at savestack position ix,
412 * but without popping the stack */
415 S_regcp_restore(pTHX_ regexp *rex, I32 ix, U32 *maxopenparen_p)
417 I32 tmpix = PL_savestack_ix;
418 PL_savestack_ix = ix;
419 regcppop(rex, maxopenparen_p);
420 PL_savestack_ix = tmpix;
423 #define regcpblow(cp) LEAVE_SCOPE(cp) /* Ignores regcppush()ed data. */
426 S_isFOO_lc(pTHX_ const U8 classnum, const U8 character)
428 /* Returns a boolean as to whether or not 'character' is a member of the
429 * Posix character class given by 'classnum' that should be equivalent to a
430 * value in the typedef '_char_class_number'.
432 * Ideally this could be replaced by a just an array of function pointers
433 * to the C library functions that implement the macros this calls.
434 * However, to compile, the precise function signatures are required, and
435 * these may vary from platform to to platform. To avoid having to figure
436 * out what those all are on each platform, I (khw) am using this method,
437 * which adds an extra layer of function call overhead (unless the C
438 * optimizer strips it away). But we don't particularly care about
439 * performance with locales anyway. */
441 switch ((_char_class_number) classnum) {
442 case _CC_ENUM_ALPHANUMERIC: return isALPHANUMERIC_LC(character);
443 case _CC_ENUM_ALPHA: return isALPHA_LC(character);
444 case _CC_ENUM_ASCII: return isASCII_LC(character);
445 case _CC_ENUM_BLANK: return isBLANK_LC(character);
446 case _CC_ENUM_CASED: return isLOWER_LC(character)
447 || isUPPER_LC(character);
448 case _CC_ENUM_CNTRL: return isCNTRL_LC(character);
449 case _CC_ENUM_DIGIT: return isDIGIT_LC(character);
450 case _CC_ENUM_GRAPH: return isGRAPH_LC(character);
451 case _CC_ENUM_LOWER: return isLOWER_LC(character);
452 case _CC_ENUM_PRINT: return isPRINT_LC(character);
453 case _CC_ENUM_PSXSPC: return isPSXSPC_LC(character);
454 case _CC_ENUM_PUNCT: return isPUNCT_LC(character);
455 case _CC_ENUM_SPACE: return isSPACE_LC(character);
456 case _CC_ENUM_UPPER: return isUPPER_LC(character);
457 case _CC_ENUM_WORDCHAR: return isWORDCHAR_LC(character);
458 case _CC_ENUM_XDIGIT: return isXDIGIT_LC(character);
459 default: /* VERTSPACE should never occur in locales */
460 Perl_croak(aTHX_ "panic: isFOO_lc() has an unexpected character class '%d'", classnum);
463 assert(0); /* NOTREACHED */
468 S_isFOO_utf8_lc(pTHX_ const U8 classnum, const U8* character)
470 /* Returns a boolean as to whether or not the (well-formed) UTF-8-encoded
471 * 'character' is a member of the Posix character class given by 'classnum'
472 * that should be equivalent to a value in the typedef
473 * '_char_class_number'.
475 * This just calls isFOO_lc on the code point for the character if it is in
476 * the range 0-255. Outside that range, all characters avoid Unicode
477 * rules, ignoring any locale. So use the Unicode function if this class
478 * requires a swash, and use the Unicode macro otherwise. */
480 PERL_ARGS_ASSERT_ISFOO_UTF8_LC;
482 if (UTF8_IS_INVARIANT(*character)) {
483 return isFOO_lc(classnum, *character);
485 else if (UTF8_IS_DOWNGRADEABLE_START(*character)) {
486 return isFOO_lc(classnum,
487 TWO_BYTE_UTF8_TO_NATIVE(*character, *(character + 1)));
490 if (classnum < _FIRST_NON_SWASH_CC) {
492 /* Initialize the swash unless done already */
493 if (! PL_utf8_swash_ptrs[classnum]) {
494 U8 flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;
495 PL_utf8_swash_ptrs[classnum] = _core_swash_init("utf8",
496 swash_property_names[classnum], &PL_sv_undef, 1, 0, NULL, &flags);
499 return cBOOL(swash_fetch(PL_utf8_swash_ptrs[classnum], (U8 *)
501 TRUE /* is UTF */ ));
504 switch ((_char_class_number) classnum) {
506 case _CC_ENUM_PSXSPC: return is_XPERLSPACE_high(character);
508 case _CC_ENUM_BLANK: return is_HORIZWS_high(character);
509 case _CC_ENUM_XDIGIT: return is_XDIGIT_high(character);
510 case _CC_ENUM_VERTSPACE: return is_VERTWS_high(character);
511 default: return 0; /* Things like CNTRL are always
515 assert(0); /* NOTREACHED */
520 * pregexec and friends
523 #ifndef PERL_IN_XSUB_RE
525 - pregexec - match a regexp against a string
528 Perl_pregexec(pTHX_ REGEXP * const prog, char* stringarg, char *strend,
529 char *strbeg, SSize_t minend, SV *screamer, U32 nosave)
530 /* stringarg: the point in the string at which to begin matching */
531 /* strend: pointer to null at end of string */
532 /* strbeg: real beginning of string */
533 /* minend: end of match must be >= minend bytes after stringarg. */
534 /* screamer: SV being matched: only used for utf8 flag, pos() etc; string
535 * itself is accessed via the pointers above */
536 /* nosave: For optimizations. */
538 PERL_ARGS_ASSERT_PREGEXEC;
541 regexec_flags(prog, stringarg, strend, strbeg, minend, screamer, NULL,
542 nosave ? 0 : REXEC_COPY_STR);
547 * Need to implement the following flags for reg_anch:
549 * USE_INTUIT_NOML - Useful to call re_intuit_start() first
551 * INTUIT_AUTORITATIVE_NOML - Can trust a positive answer
552 * INTUIT_AUTORITATIVE_ML
553 * INTUIT_ONCE_NOML - Intuit can match in one location only.
556 * Another flag for this function: SECOND_TIME (so that float substrs
557 * with giant delta may be not rechecked).
560 /* If SCREAM, then SvPVX_const(sv) should be compatible with strpos and strend.
561 Otherwise, only SvCUR(sv) is used to get strbeg. */
563 /* XXXX Some places assume that there is a fixed substring.
564 An update may be needed if optimizer marks as "INTUITable"
565 RExen without fixed substrings. Similarly, it is assumed that
566 lengths of all the strings are no more than minlen, thus they
567 cannot come from lookahead.
568 (Or minlen should take into account lookahead.)
569 NOTE: Some of this comment is not correct. minlen does now take account
570 of lookahead/behind. Further research is required. -- demerphq
574 /* A failure to find a constant substring means that there is no need to make
575 an expensive call to REx engine, thus we celebrate a failure. Similarly,
576 finding a substring too deep into the string means that fewer calls to
577 regtry() should be needed.
579 REx compiler's optimizer found 4 possible hints:
580 a) Anchored substring;
582 c) Whether we are anchored (beginning-of-line or \G);
583 d) First node (of those at offset 0) which may distinguish positions;
584 We use a)b)d) and multiline-part of c), and try to find a position in the
585 string which does not contradict any of them.
588 /* Most of decisions we do here should have been done at compile time.
589 The nodes of the REx which we used for the search should have been
590 deleted from the finite automaton. */
593 * rx: the regex to match against
594 * sv: the SV being matched: only used for utf8 flag; the string
595 * itself is accessed via the pointers below. Note that on
596 * something like an overloaded SV, SvPOK(sv) may be false
597 * and the string pointers may point to something unrelated to
599 * strbeg: real beginning of string
600 * strpos: the point in the string at which to begin matching
601 * strend: pointer to the byte following the last char of the string
602 * flags currently unused; set to 0
603 * data: currently unused; set to NULL
607 Perl_re_intuit_start(pTHX_
610 const char * const strbeg,
614 re_scream_pos_data *data)
617 struct regexp *const prog = ReANY(rx);
618 SSize_t start_shift = 0;
619 /* Should be nonnegative! */
620 SSize_t end_shift = 0;
624 const bool utf8_target = (sv && SvUTF8(sv)) ? 1 : 0; /* if no sv we have to assume bytes */
626 char *other_last = NULL; /* other substr checked before this */
627 char *check_at = NULL; /* check substr found at this pos */
628 char *checked_upto = NULL; /* how far into the string we have already checked using find_byclass*/
629 const I32 multiline = prog->extflags & RXf_PMf_MULTILINE;
630 RXi_GET_DECL(prog,progi);
631 regmatch_info reginfo_buf; /* create some info to pass to find_byclass */
632 regmatch_info *const reginfo = ®info_buf;
634 const char * const i_strpos = strpos;
636 GET_RE_DEBUG_FLAGS_DECL;
638 PERL_ARGS_ASSERT_RE_INTUIT_START;
639 PERL_UNUSED_ARG(flags);
640 PERL_UNUSED_ARG(data);
642 /* CHR_DIST() would be more correct here but it makes things slow. */
643 if (prog->minlen > strend - strpos) {
644 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
645 "String too short... [re_intuit_start]\n"));
649 reginfo->is_utf8_target = cBOOL(utf8_target);
650 reginfo->info_aux = NULL;
651 reginfo->strbeg = strbeg;
652 reginfo->strend = strend;
653 reginfo->is_utf8_pat = cBOOL(RX_UTF8(rx));
655 /* not actually used within intuit, but zero for safety anyway */
656 reginfo->poscache_maxiter = 0;
659 if (!prog->check_utf8 && prog->check_substr)
660 to_utf8_substr(prog);
661 check = prog->check_utf8;
663 if (!prog->check_substr && prog->check_utf8) {
664 if (! to_byte_substr(prog)) {
665 NON_UTF8_TARGET_BUT_UTF8_REQUIRED(fail);
668 check = prog->check_substr;
670 if ((prog->extflags & RXf_ANCH) /* Match at beg-of-str or after \n */
671 && !(prog->extflags & RXf_ANCH_GPOS)) /* \G isn't a BOS or \n */
673 ml_anch = !( (prog->extflags & RXf_ANCH_SINGLE)
674 || ( (prog->extflags & RXf_ANCH_BOL)
675 && !multiline ) ); /* Check after \n? */
678 if ( !(prog->intflags & PREGf_IMPLICIT) /* not a real BOL */
679 && (strpos != strbeg)) {
680 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Not at start...\n"));
683 if (prog->check_offset_min == prog->check_offset_max
684 && !(prog->extflags & RXf_CANY_SEEN)
685 && ! multiline) /* /m can cause \n's to match that aren't
686 accounted for in the string max length.
687 See [perl #115242] */
689 /* Substring at constant offset from beg-of-str... */
692 s = HOP3c(strpos, prog->check_offset_min, strend);
695 slen = SvCUR(check); /* >= 1 */
697 if ( strend - s > slen || strend - s < slen - 1
698 || (strend - s == slen && strend[-1] != '\n')) {
699 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "String too long...\n"));
702 /* Now should match s[0..slen-2] */
704 if (slen && (*SvPVX_const(check) != *s
706 && memNE(SvPVX_const(check), s, slen)))) {
708 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "String not equal...\n"));
712 else if (*SvPVX_const(check) != *s
713 || ((slen = SvCUR(check)) > 1
714 && memNE(SvPVX_const(check), s, slen)))
717 goto success_at_start;
720 /* Match is anchored, but substr is not anchored wrt beg-of-str. */
722 start_shift = prog->check_offset_min; /* okay to underestimate on CC */
723 end_shift = prog->check_end_shift;
726 const SSize_t end = prog->check_offset_max + CHR_SVLEN(check)
727 - (SvTAIL(check) != 0);
728 const SSize_t eshift = CHR_DIST((U8*)strend, (U8*)s) - end;
730 if (end_shift < eshift)
734 else { /* Can match at random position */
737 start_shift = prog->check_offset_min; /* okay to underestimate on CC */
738 end_shift = prog->check_end_shift;
740 /* end shift should be non negative here */
743 #ifdef QDEBUGGING /* 7/99: reports of failure (with the older version) */
745 Perl_croak(aTHX_ "panic: end_shift: %"IVdf" pattern:\n%s\n ",
746 (IV)end_shift, RX_PRECOMP(prog));
750 /* Find a possible match in the region s..strend by looking for
751 the "check" substring in the region corrected by start/end_shift. */
754 SSize_t srch_start_shift = start_shift;
755 SSize_t srch_end_shift = end_shift;
758 if (srch_start_shift < 0 && strbeg - s > srch_start_shift) {
759 srch_end_shift -= ((strbeg - s) - srch_start_shift);
760 srch_start_shift = strbeg - s;
762 DEBUG_OPTIMISE_MORE_r({
763 PerlIO_printf(Perl_debug_log, "Check offset min: %"IVdf" Start shift: %"IVdf" End shift %"IVdf" Real End Shift: %"IVdf"\n",
764 (IV)prog->check_offset_min,
765 (IV)srch_start_shift,
767 (IV)prog->check_end_shift);
770 if (prog->extflags & RXf_CANY_SEEN) {
771 start_point= (U8*)(s + srch_start_shift);
772 end_point= (U8*)(strend - srch_end_shift);
774 start_point= HOP3(s, srch_start_shift, srch_start_shift < 0 ? strbeg : strend);
775 end_point= HOP3(strend, -srch_end_shift, strbeg);
777 DEBUG_OPTIMISE_MORE_r({
778 PerlIO_printf(Perl_debug_log, "fbm_instr len=%d str=<%.*s>\n",
779 (int)(end_point - start_point),
780 (int)(end_point - start_point) > 20 ? 20 : (int)(end_point - start_point),
784 s = fbm_instr( start_point, end_point,
785 check, multiline ? FBMrf_MULTILINE : 0);
787 /* Update the count-of-usability, remove useless subpatterns,
791 RE_PV_QUOTED_DECL(quoted, utf8_target, PERL_DEBUG_PAD_ZERO(0),
792 SvPVX_const(check), RE_SV_DUMPLEN(check), 30);
793 PerlIO_printf(Perl_debug_log, "%s %s substr %s%s%s",
794 (s ? "Found" : "Did not find"),
795 (check == (utf8_target ? prog->anchored_utf8 : prog->anchored_substr)
796 ? "anchored" : "floating"),
799 (s ? " at offset " : "...\n") );
804 /* Finish the diagnostic message */
805 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "%ld...\n", (long)(s - i_strpos)) );
807 /* XXX dmq: first branch is for positive lookbehind...
808 Our check string is offset from the beginning of the pattern.
809 So we need to do any stclass tests offset forward from that
818 /* Got a candidate. Check MBOL anchoring, and the *other* substr.
819 Start with the other substr.
820 XXXX no SCREAM optimization yet - and a very coarse implementation
821 XXXX /ttx+/ results in anchored="ttx", floating="x". floating will
822 *always* match. Probably should be marked during compile...
823 Probably it is right to do no SCREAM here...
826 if (utf8_target ? (prog->float_utf8 && prog->anchored_utf8)
827 : (prog->float_substr && prog->anchored_substr))
829 /* Take into account the "other" substring. */
830 /* XXXX May be hopelessly wrong for UTF... */
833 if (check == (utf8_target ? prog->float_utf8 : prog->float_substr)) {
836 char * const last = HOP3c(s, -start_shift, strbeg);
838 char * const saved_s = s;
841 t = s - prog->check_offset_max;
842 if (s - strpos > prog->check_offset_max /* signed-corrected t > strpos */
844 || ((t = (char*)reghopmaybe3((U8*)s, -(prog->check_offset_max), (U8*)strpos))
849 t = HOP3c(t, prog->anchored_offset, strend);
850 if (t < other_last) /* These positions already checked */
852 last2 = last1 = HOP3c(strend, -prog->minlen, strbeg);
855 /* XXXX It is not documented what units *_offsets are in.
856 We assume bytes, but this is clearly wrong.
857 Meaning this code needs to be carefully reviewed for errors.
861 /* On end-of-str: see comment below. */
862 must = utf8_target ? prog->anchored_utf8 : prog->anchored_substr;
863 if (must == &PL_sv_undef) {
865 DEBUG_r(must = prog->anchored_utf8); /* for debug */
870 HOP3(HOP3(last1, prog->anchored_offset, strend)
871 + SvCUR(must), -(SvTAIL(must)!=0), strbeg),
873 multiline ? FBMrf_MULTILINE : 0
876 RE_PV_QUOTED_DECL(quoted, utf8_target, PERL_DEBUG_PAD_ZERO(0),
877 SvPVX_const(must), RE_SV_DUMPLEN(must), 30);
878 PerlIO_printf(Perl_debug_log, "%s anchored substr %s%s",
879 (s ? "Found" : "Contradicts"),
880 quoted, RE_SV_TAIL(must));
885 if (last1 >= last2) {
886 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
887 ", giving up...\n"));
890 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
891 ", trying floating at offset %ld...\n",
892 (long)(HOP3c(saved_s, 1, strend) - i_strpos)));
893 other_last = HOP3c(last1, prog->anchored_offset+1, strend);
894 s = HOP3c(last, 1, strend);
898 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, " at offset %ld...\n",
899 (long)(s - i_strpos)));
900 t = HOP3c(s, -prog->anchored_offset, strbeg);
901 other_last = HOP3c(s, 1, strend);
909 else { /* Take into account the floating substring. */
911 char * const saved_s = s;
914 t = HOP3c(s, -start_shift, strbeg);
916 HOP3c(strend, -prog->minlen + prog->float_min_offset, strbeg);
917 if (CHR_DIST((U8*)last, (U8*)t) > prog->float_max_offset)
918 last = HOP3c(t, prog->float_max_offset, strend);
919 s = HOP3c(t, prog->float_min_offset, strend);
922 /* XXXX It is not documented what units *_offsets are in. Assume bytes. */
923 must = utf8_target ? prog->float_utf8 : prog->float_substr;
924 /* fbm_instr() takes into account exact value of end-of-str
925 if the check is SvTAIL(ed). Since false positives are OK,
926 and end-of-str is not later than strend we are OK. */
927 if (must == &PL_sv_undef) {
929 DEBUG_r(must = prog->float_utf8); /* for debug message */
932 s = fbm_instr((unsigned char*)s,
933 (unsigned char*)last + SvCUR(must)
935 must, multiline ? FBMrf_MULTILINE : 0);
937 RE_PV_QUOTED_DECL(quoted, utf8_target, PERL_DEBUG_PAD_ZERO(0),
938 SvPVX_const(must), RE_SV_DUMPLEN(must), 30);
939 PerlIO_printf(Perl_debug_log, "%s floating substr %s%s",
940 (s ? "Found" : "Contradicts"),
941 quoted, RE_SV_TAIL(must));
945 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
946 ", giving up...\n"));
949 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
950 ", trying anchored starting at offset %ld...\n",
951 (long)(saved_s + 1 - i_strpos)));
953 s = HOP3c(t, 1, strend);
957 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, " at offset %ld...\n",
958 (long)(s - i_strpos)));
959 other_last = s; /* Fix this later. --Hugo */
969 t= (char*)HOP3( s, -prog->check_offset_max, (prog->check_offset_max<0) ? strend : strpos);
971 DEBUG_OPTIMISE_MORE_r(
972 PerlIO_printf(Perl_debug_log,
973 "Check offset min:%"IVdf" max:%"IVdf" S:%"IVdf" t:%"IVdf" D:%"IVdf" end:%"IVdf"\n",
974 (IV)prog->check_offset_min,
975 (IV)prog->check_offset_max,
983 if (s - strpos > prog->check_offset_max /* signed-corrected t > strpos */
985 || ((t = (char*)reghopmaybe3((U8*)s, -prog->check_offset_max, (U8*) ((prog->check_offset_max<0) ? strend : strpos)))
988 /* Fixed substring is found far enough so that the match
989 cannot start at strpos. */
991 if (ml_anch && t[-1] != '\n') {
992 /* Eventually fbm_*() should handle this, but often
993 anchored_offset is not 0, so this check will not be wasted. */
994 /* XXXX In the code below we prefer to look for "^" even in
995 presence of anchored substrings. And we search even
996 beyond the found float position. These pessimizations
997 are historical artefacts only. */
999 while (t < strend - prog->minlen) {
1001 if (t < check_at - prog->check_offset_min) {
1002 if (utf8_target ? prog->anchored_utf8 : prog->anchored_substr) {
1003 /* Since we moved from the found position,
1004 we definitely contradict the found anchored
1005 substr. Due to the above check we do not
1006 contradict "check" substr.
1007 Thus we can arrive here only if check substr
1008 is float. Redo checking for "other"=="fixed".
1011 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Found /%s^%s/m at offset %ld, rescanning for anchored from offset %ld...\n",
1012 PL_colors[0], PL_colors[1], (long)(strpos - i_strpos), (long)(strpos - i_strpos + prog->anchored_offset)));
1013 goto do_other_anchored;
1015 /* We don't contradict the found floating substring. */
1016 /* XXXX Why not check for STCLASS? */
1018 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Found /%s^%s/m at offset %ld...\n",
1019 PL_colors[0], PL_colors[1], (long)(s - i_strpos)));
1022 /* Position contradicts check-string */
1023 /* XXXX probably better to look for check-string
1024 than for "\n", so one should lower the limit for t? */
1025 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Found /%s^%s/m, restarting lookup for check-string at offset %ld...\n",
1026 PL_colors[0], PL_colors[1], (long)(t + 1 - i_strpos)));
1027 other_last = strpos = s = t + 1;
1032 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Did not find /%s^%s/m...\n",
1033 PL_colors[0], PL_colors[1]));
1037 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Starting position does not contradict /%s^%s/m...\n",
1038 PL_colors[0], PL_colors[1]));
1042 ++BmUSEFUL(utf8_target ? prog->check_utf8 : prog->check_substr); /* hooray/5 */
1045 /* The found string does not prohibit matching at strpos,
1046 - no optimization of calling REx engine can be performed,
1047 unless it was an MBOL and we are not after MBOL,
1048 or a future STCLASS check will fail this. */
1050 /* Even in this situation we may use MBOL flag if strpos is offset
1051 wrt the start of the string. */
1052 if (ml_anch && (strpos != strbeg) && strpos[-1] != '\n'
1053 /* May be due to an implicit anchor of m{.*foo} */
1054 && !(prog->intflags & PREGf_IMPLICIT))
1059 DEBUG_EXECUTE_r( if (ml_anch)
1060 PerlIO_printf(Perl_debug_log, "Position at offset %ld does not contradict /%s^%s/m...\n",
1061 (long)(strpos - i_strpos), PL_colors[0], PL_colors[1]);
1064 if (!(prog->intflags & PREGf_NAUGHTY) /* XXXX If strpos moved? */
1066 prog->check_utf8 /* Could be deleted already */
1067 && --BmUSEFUL(prog->check_utf8) < 0
1068 && (prog->check_utf8 == prog->float_utf8)
1070 prog->check_substr /* Could be deleted already */
1071 && --BmUSEFUL(prog->check_substr) < 0
1072 && (prog->check_substr == prog->float_substr)
1075 /* If flags & SOMETHING - do not do it many times on the same match */
1076 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "... Disabling check substring...\n"));
1077 /* XXX Does the destruction order has to change with utf8_target? */
1078 SvREFCNT_dec(utf8_target ? prog->check_utf8 : prog->check_substr);
1079 SvREFCNT_dec(utf8_target ? prog->check_substr : prog->check_utf8);
1080 prog->check_substr = prog->check_utf8 = NULL; /* disable */
1081 prog->float_substr = prog->float_utf8 = NULL; /* clear */
1082 check = NULL; /* abort */
1084 /* XXXX If the check string was an implicit check MBOL, then we need to unset the relevant flag
1085 see http://bugs.activestate.com/show_bug.cgi?id=87173 */
1086 if (prog->intflags & PREGf_IMPLICIT)
1087 prog->extflags &= ~RXf_ANCH_MBOL;
1088 /* XXXX This is a remnant of the old implementation. It
1089 looks wasteful, since now INTUIT can use many
1090 other heuristics. */
1091 prog->extflags &= ~RXf_USE_INTUIT;
1092 /* XXXX What other flags might need to be cleared in this branch? */
1098 /* Last resort... */
1099 /* XXXX BmUSEFUL already changed, maybe multiple change is meaningful... */
1100 /* trie stclasses are too expensive to use here, we are better off to
1101 leave it to regmatch itself */
1102 if (progi->regstclass && PL_regkind[OP(progi->regstclass)]!=TRIE) {
1103 /* minlen == 0 is possible if regstclass is \b or \B,
1104 and the fixed substr is ''$.
1105 Since minlen is already taken into account, s+1 is before strend;
1106 accidentally, minlen >= 1 guaranties no false positives at s + 1
1107 even for \b or \B. But (minlen? 1 : 0) below assumes that
1108 regstclass does not come from lookahead... */
1109 /* If regstclass takes bytelength more than 1: If charlength==1, OK.
1110 This leaves EXACTF-ish only, which are dealt with in find_byclass(). */
1111 const U8* const str = (U8*)STRING(progi->regstclass);
1112 /* XXX this value could be pre-computed */
1113 const int cl_l = (PL_regkind[OP(progi->regstclass)] == EXACT
1114 ? (reginfo->is_utf8_pat
1115 ? utf8_distance(str + STR_LEN(progi->regstclass), str)
1116 : STR_LEN(progi->regstclass))
1119 if (prog->anchored_substr || prog->anchored_utf8 || ml_anch)
1120 endpos= HOP3c(s, (prog->minlen ? cl_l : 0), strend);
1121 else if (prog->float_substr || prog->float_utf8)
1122 endpos= HOP3c(HOP3c(check_at, -start_shift, strbeg), cl_l, strend);
1126 if (checked_upto < s)
1128 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "start_shift: %"IVdf" check_at: %"IVdf" s: %"IVdf" endpos: %"IVdf" checked_upto: %"IVdf"\n",
1129 (IV)start_shift, (IV)(check_at - strbeg), (IV)(s - strbeg), (IV)(endpos - strbeg), (IV)(checked_upto- strbeg)));
1132 s = find_byclass(prog, progi->regstclass, checked_upto, endpos,
1138 const char *what = NULL;
1140 if (endpos == strend) {
1141 DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
1142 "Could not match STCLASS...\n") );
1145 DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
1146 "This position contradicts STCLASS...\n") );
1147 if ((prog->extflags & RXf_ANCH) && !ml_anch)
1149 checked_upto = HOPBACKc(endpos, start_shift);
1150 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "start_shift: %"IVdf" check_at: %"IVdf" endpos: %"IVdf" checked_upto: %"IVdf"\n",
1151 (IV)start_shift, (IV)(check_at - strbeg), (IV)(endpos - strbeg), (IV)(checked_upto- strbeg)));
1152 /* Contradict one of substrings */
1153 if (prog->anchored_substr || prog->anchored_utf8) {
1154 if ((utf8_target ? prog->anchored_utf8 : prog->anchored_substr) == check) {
1155 DEBUG_EXECUTE_r( what = "anchored" );
1157 s = HOP3c(t, 1, strend);
1158 if (s + start_shift + end_shift > strend) {
1159 /* XXXX Should be taken into account earlier? */
1160 DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
1161 "Could not match STCLASS...\n") );
1166 DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
1167 "Looking for %s substr starting at offset %ld...\n",
1168 what, (long)(s + start_shift - i_strpos)) );
1171 /* Have both, check_string is floating */
1172 if (t + start_shift >= check_at) /* Contradicts floating=check */
1173 goto retry_floating_check;
1174 /* Recheck anchored substring, but not floating... */
1178 DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
1179 "Looking for anchored substr starting at offset %ld...\n",
1180 (long)(other_last - i_strpos)) );
1181 goto do_other_anchored;
1183 /* Another way we could have checked stclass at the
1184 current position only: */
1189 DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
1190 "Looking for /%s^%s/m starting at offset %ld...\n",
1191 PL_colors[0], PL_colors[1], (long)(t - i_strpos)) );
1194 if (!(utf8_target ? prog->float_utf8 : prog->float_substr)) /* Could have been deleted */
1196 /* Check is floating substring. */
1197 retry_floating_check:
1198 t = check_at - start_shift;
1199 DEBUG_EXECUTE_r( what = "floating" );
1200 goto hop_and_restart;
1203 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
1204 "By STCLASS: moving %ld --> %ld\n",
1205 (long)(t - i_strpos), (long)(s - i_strpos))
1209 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
1210 "Does not contradict STCLASS...\n");
1215 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "%s%s:%s match at offset %ld\n",
1216 PL_colors[4], (check ? "Guessed" : "Giving up"),
1217 PL_colors[5], (long)(s - i_strpos)) );
1220 fail_finish: /* Substring not found */
1221 if (prog->check_substr || prog->check_utf8) /* could be removed already */
1222 BmUSEFUL(utf8_target ? prog->check_utf8 : prog->check_substr) += 5; /* hooray */
1224 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "%sMatch rejected by optimizer%s\n",
1225 PL_colors[4], PL_colors[5]));
1229 #define DECL_TRIE_TYPE(scan) \
1230 const enum { trie_plain, trie_utf8, trie_utf8_fold, trie_latin_utf8_fold, \
1231 trie_utf8_exactfa_fold, trie_latin_utf8_exactfa_fold } \
1232 trie_type = ((scan->flags == EXACT) \
1233 ? (utf8_target ? trie_utf8 : trie_plain) \
1234 : (scan->flags == EXACTFA) \
1235 ? (utf8_target ? trie_utf8_exactfa_fold : trie_latin_utf8_exactfa_fold) \
1236 : (utf8_target ? trie_utf8_fold : trie_latin_utf8_fold))
1238 #define REXEC_TRIE_READ_CHAR(trie_type, trie, widecharmap, uc, uscan, len, uvc, charid, foldlen, foldbuf, uniflags) \
1241 U8 flags = FOLD_FLAGS_FULL; \
1242 switch (trie_type) { \
1243 case trie_utf8_exactfa_fold: \
1244 flags |= FOLD_FLAGS_NOMIX_ASCII; \
1245 /* FALL THROUGH */ \
1246 case trie_utf8_fold: \
1247 if ( foldlen>0 ) { \
1248 uvc = utf8n_to_uvchr( (const U8*) uscan, UTF8_MAXLEN, &len, uniflags ); \
1253 uvc = _to_utf8_fold_flags( (const U8*) uc, foldbuf, &foldlen, flags, NULL); \
1254 len = UTF8SKIP(uc); \
1255 skiplen = UNISKIP( uvc ); \
1256 foldlen -= skiplen; \
1257 uscan = foldbuf + skiplen; \
1260 case trie_latin_utf8_exactfa_fold: \
1261 flags |= FOLD_FLAGS_NOMIX_ASCII; \
1262 /* FALL THROUGH */ \
1263 case trie_latin_utf8_fold: \
1264 if ( foldlen>0 ) { \
1265 uvc = utf8n_to_uvchr( (const U8*) uscan, UTF8_MAXLEN, &len, uniflags ); \
1271 uvc = _to_fold_latin1( (U8) *uc, foldbuf, &foldlen, flags); \
1272 skiplen = UNISKIP( uvc ); \
1273 foldlen -= skiplen; \
1274 uscan = foldbuf + skiplen; \
1278 uvc = utf8n_to_uvchr( (const U8*) uc, UTF8_MAXLEN, &len, uniflags ); \
1285 charid = trie->charmap[ uvc ]; \
1289 if (widecharmap) { \
1290 SV** const svpp = hv_fetch(widecharmap, \
1291 (char*)&uvc, sizeof(UV), 0); \
1293 charid = (U16)SvIV(*svpp); \
1298 #define REXEC_FBC_EXACTISH_SCAN(CoNd) \
1302 && (ln == 1 || folder(s, pat_string, ln)) \
1303 && (reginfo->intuit || regtry(reginfo, &s)) )\
1309 #define REXEC_FBC_UTF8_SCAN(CoDe) \
1311 while (s < strend) { \
1317 #define REXEC_FBC_SCAN(CoDe) \
1319 while (s < strend) { \
1325 #define REXEC_FBC_UTF8_CLASS_SCAN(CoNd) \
1326 REXEC_FBC_UTF8_SCAN( \
1328 if (tmp && (reginfo->intuit || regtry(reginfo, &s))) \
1337 #define REXEC_FBC_CLASS_SCAN(CoNd) \
1340 if (tmp && (reginfo->intuit || regtry(reginfo, &s))) \
1349 #define REXEC_FBC_TRYIT \
1350 if ((reginfo->intuit || regtry(reginfo, &s))) \
1353 #define REXEC_FBC_CSCAN(CoNdUtF8,CoNd) \
1354 if (utf8_target) { \
1355 REXEC_FBC_UTF8_CLASS_SCAN(CoNdUtF8); \
1358 REXEC_FBC_CLASS_SCAN(CoNd); \
1361 #define DUMP_EXEC_POS(li,s,doutf8) \
1362 dump_exec_pos(li,s,(reginfo->strend),(reginfo->strbeg), \
1366 #define UTF8_NOLOAD(TEST_NON_UTF8, IF_SUCCESS, IF_FAIL) \
1367 tmp = (s != reginfo->strbeg) ? UCHARAT(s - 1) : '\n'; \
1368 tmp = TEST_NON_UTF8(tmp); \
1369 REXEC_FBC_UTF8_SCAN( \
1370 if (tmp == ! TEST_NON_UTF8((U8) *s)) { \
1379 #define UTF8_LOAD(TeSt1_UtF8, TeSt2_UtF8, IF_SUCCESS, IF_FAIL) \
1380 if (s == reginfo->strbeg) { \
1384 U8 * const r = reghop3((U8*)s, -1, (U8*)reginfo->strbeg); \
1385 tmp = utf8n_to_uvchr(r, UTF8SKIP(r), 0, UTF8_ALLOW_DEFAULT); \
1388 LOAD_UTF8_CHARCLASS_ALNUM(); \
1389 REXEC_FBC_UTF8_SCAN( \
1390 if (tmp == ! (TeSt2_UtF8)) { \
1399 /* The only difference between the BOUND and NBOUND cases is that
1400 * REXEC_FBC_TRYIT is called when matched in BOUND, and when non-matched in
1401 * NBOUND. This is accomplished by passing it in either the if or else clause,
1402 * with the other one being empty */
1403 #define FBC_BOUND(TEST_NON_UTF8, TEST1_UTF8, TEST2_UTF8) \
1404 FBC_BOUND_COMMON(UTF8_LOAD(TEST1_UTF8, TEST2_UTF8, REXEC_FBC_TRYIT, PLACEHOLDER), TEST_NON_UTF8, REXEC_FBC_TRYIT, PLACEHOLDER)
1406 #define FBC_BOUND_NOLOAD(TEST_NON_UTF8, TEST1_UTF8, TEST2_UTF8) \
1407 FBC_BOUND_COMMON(UTF8_NOLOAD(TEST_NON_UTF8, REXEC_FBC_TRYIT, PLACEHOLDER), TEST_NON_UTF8, REXEC_FBC_TRYIT, PLACEHOLDER)
1409 #define FBC_NBOUND(TEST_NON_UTF8, TEST1_UTF8, TEST2_UTF8) \
1410 FBC_BOUND_COMMON(UTF8_LOAD(TEST1_UTF8, TEST2_UTF8, PLACEHOLDER, REXEC_FBC_TRYIT), TEST_NON_UTF8, PLACEHOLDER, REXEC_FBC_TRYIT)
1412 #define FBC_NBOUND_NOLOAD(TEST_NON_UTF8, TEST1_UTF8, TEST2_UTF8) \
1413 FBC_BOUND_COMMON(UTF8_NOLOAD(TEST_NON_UTF8, PLACEHOLDER, REXEC_FBC_TRYIT), TEST_NON_UTF8, PLACEHOLDER, REXEC_FBC_TRYIT)
1416 /* Common to the BOUND and NBOUND cases. Unfortunately the UTF8 tests need to
1417 * be passed in completely with the variable name being tested, which isn't
1418 * such a clean interface, but this is easier to read than it was before. We
1419 * are looking for the boundary (or non-boundary between a word and non-word
1420 * character. The utf8 and non-utf8 cases have the same logic, but the details
1421 * must be different. Find the "wordness" of the character just prior to this
1422 * one, and compare it with the wordness of this one. If they differ, we have
1423 * a boundary. At the beginning of the string, pretend that the previous
1424 * character was a new-line */
1425 #define FBC_BOUND_COMMON(UTF8_CODE, TEST_NON_UTF8, IF_SUCCESS, IF_FAIL) \
1426 if (utf8_target) { \
1429 else { /* Not utf8 */ \
1430 tmp = (s != reginfo->strbeg) ? UCHARAT(s - 1) : '\n'; \
1431 tmp = TEST_NON_UTF8(tmp); \
1433 if (tmp == ! TEST_NON_UTF8((U8) *s)) { \
1442 if ((!prog->minlen && tmp) && (reginfo->intuit || regtry(reginfo, &s))) \
1445 /* We know what class REx starts with. Try to find this position... */
1446 /* if reginfo->intuit, its a dryrun */
1447 /* annoyingly all the vars in this routine have different names from their counterparts
1448 in regmatch. /grrr */
1451 S_find_byclass(pTHX_ regexp * prog, const regnode *c, char *s,
1452 const char *strend, regmatch_info *reginfo)
1455 const I32 doevery = (prog->intflags & PREGf_SKIP) == 0;
1456 char *pat_string; /* The pattern's exactish string */
1457 char *pat_end; /* ptr to end char of pat_string */
1458 re_fold_t folder; /* Function for computing non-utf8 folds */
1459 const U8 *fold_array; /* array for folding ords < 256 */
1465 I32 tmp = 1; /* Scratch variable? */
1466 const bool utf8_target = reginfo->is_utf8_target;
1467 UV utf8_fold_flags = 0;
1468 const bool is_utf8_pat = reginfo->is_utf8_pat;
1469 bool to_complement = FALSE; /* Invert the result? Taking the xor of this
1470 with a result inverts that result, as 0^1 =
1472 _char_class_number classnum;
1474 RXi_GET_DECL(prog,progi);
1476 PERL_ARGS_ASSERT_FIND_BYCLASS;
1478 /* We know what class it must start with. */
1481 case ANYOF_SYNTHETIC:
1482 case ANYOF_WARN_SUPER:
1484 REXEC_FBC_UTF8_CLASS_SCAN(
1485 reginclass(prog, c, (U8*)s, utf8_target));
1488 REXEC_FBC_CLASS_SCAN(REGINCLASS(prog, c, (U8*)s));
1493 if (tmp && (reginfo->intuit || regtry(reginfo, &s)))
1500 case EXACTFA_NO_TRIE: /* This node only generated for non-utf8 patterns */
1501 assert(! is_utf8_pat);
1504 if (is_utf8_pat || utf8_target) {
1505 utf8_fold_flags = FOLDEQ_UTF8_NOMIX_ASCII;
1506 goto do_exactf_utf8;
1508 fold_array = PL_fold_latin1; /* Latin1 folds are not affected by */
1509 folder = foldEQ_latin1; /* /a, except the sharp s one which */
1510 goto do_exactf_non_utf8; /* isn't dealt with by these */
1512 case EXACTF: /* This node only generated for non-utf8 patterns */
1513 assert(! is_utf8_pat);
1515 utf8_fold_flags = 0;
1516 goto do_exactf_utf8;
1518 fold_array = PL_fold;
1520 goto do_exactf_non_utf8;
1523 if (is_utf8_pat || utf8_target) {
1524 utf8_fold_flags = FOLDEQ_UTF8_LOCALE;
1525 goto do_exactf_utf8;
1527 fold_array = PL_fold_locale;
1528 folder = foldEQ_locale;
1529 goto do_exactf_non_utf8;
1533 utf8_fold_flags = FOLDEQ_S2_ALREADY_FOLDED;
1535 goto do_exactf_utf8;
1538 if (is_utf8_pat || utf8_target) {
1539 utf8_fold_flags = is_utf8_pat ? FOLDEQ_S2_ALREADY_FOLDED : 0;
1540 goto do_exactf_utf8;
1543 /* Any 'ss' in the pattern should have been replaced by regcomp,
1544 * so we don't have to worry here about this single special case
1545 * in the Latin1 range */
1546 fold_array = PL_fold_latin1;
1547 folder = foldEQ_latin1;
1551 do_exactf_non_utf8: /* Neither pattern nor string are UTF8, and there
1552 are no glitches with fold-length differences
1553 between the target string and pattern */
1555 /* The idea in the non-utf8 EXACTF* cases is to first find the
1556 * first character of the EXACTF* node and then, if necessary,
1557 * case-insensitively compare the full text of the node. c1 is the
1558 * first character. c2 is its fold. This logic will not work for
1559 * Unicode semantics and the german sharp ss, which hence should
1560 * not be compiled into a node that gets here. */
1561 pat_string = STRING(c);
1562 ln = STR_LEN(c); /* length to match in octets/bytes */
1564 /* We know that we have to match at least 'ln' bytes (which is the
1565 * same as characters, since not utf8). If we have to match 3
1566 * characters, and there are only 2 availabe, we know without
1567 * trying that it will fail; so don't start a match past the
1568 * required minimum number from the far end */
1569 e = HOP3c(strend, -((SSize_t)ln), s);
1571 if (reginfo->intuit && e < s) {
1572 e = s; /* Due to minlen logic of intuit() */
1576 c2 = fold_array[c1];
1577 if (c1 == c2) { /* If char and fold are the same */
1578 REXEC_FBC_EXACTISH_SCAN(*(U8*)s == c1);
1581 REXEC_FBC_EXACTISH_SCAN(*(U8*)s == c1 || *(U8*)s == c2);
1589 /* If one of the operands is in utf8, we can't use the simpler folding
1590 * above, due to the fact that many different characters can have the
1591 * same fold, or portion of a fold, or different- length fold */
1592 pat_string = STRING(c);
1593 ln = STR_LEN(c); /* length to match in octets/bytes */
1594 pat_end = pat_string + ln;
1595 lnc = is_utf8_pat /* length to match in characters */
1596 ? utf8_length((U8 *) pat_string, (U8 *) pat_end)
1599 /* We have 'lnc' characters to match in the pattern, but because of
1600 * multi-character folding, each character in the target can match
1601 * up to 3 characters (Unicode guarantees it will never exceed
1602 * this) if it is utf8-encoded; and up to 2 if not (based on the
1603 * fact that the Latin 1 folds are already determined, and the
1604 * only multi-char fold in that range is the sharp-s folding to
1605 * 'ss'. Thus, a pattern character can match as little as 1/3 of a
1606 * string character. Adjust lnc accordingly, rounding up, so that
1607 * if we need to match at least 4+1/3 chars, that really is 5. */
1608 expansion = (utf8_target) ? UTF8_MAX_FOLD_CHAR_EXPAND : 2;
1609 lnc = (lnc + expansion - 1) / expansion;
1611 /* As in the non-UTF8 case, if we have to match 3 characters, and
1612 * only 2 are left, it's guaranteed to fail, so don't start a
1613 * match that would require us to go beyond the end of the string
1615 e = HOP3c(strend, -((SSize_t)lnc), s);
1617 if (reginfo->intuit && e < s) {
1618 e = s; /* Due to minlen logic of intuit() */
1621 /* XXX Note that we could recalculate e to stop the loop earlier,
1622 * as the worst case expansion above will rarely be met, and as we
1623 * go along we would usually find that e moves further to the left.
1624 * This would happen only after we reached the point in the loop
1625 * where if there were no expansion we should fail. Unclear if
1626 * worth the expense */
1629 char *my_strend= (char *)strend;
1630 if (foldEQ_utf8_flags(s, &my_strend, 0, utf8_target,
1631 pat_string, NULL, ln, is_utf8_pat, utf8_fold_flags)
1632 && (reginfo->intuit || regtry(reginfo, &s)) )
1636 s += (utf8_target) ? UTF8SKIP(s) : 1;
1641 RXp_MATCH_TAINTED_on(prog);
1642 FBC_BOUND(isWORDCHAR_LC,
1643 isWORDCHAR_LC_uvchr(tmp),
1644 isWORDCHAR_LC_utf8((U8*)s));
1647 RXp_MATCH_TAINTED_on(prog);
1648 FBC_NBOUND(isWORDCHAR_LC,
1649 isWORDCHAR_LC_uvchr(tmp),
1650 isWORDCHAR_LC_utf8((U8*)s));
1653 FBC_BOUND(isWORDCHAR,
1654 isWORDCHAR_uni(tmp),
1655 cBOOL(swash_fetch(PL_utf8_swash_ptrs[_CC_WORDCHAR], (U8*)s, utf8_target)));
1658 FBC_BOUND_NOLOAD(isWORDCHAR_A,
1660 isWORDCHAR_A((U8*)s));
1663 FBC_NBOUND(isWORDCHAR,
1664 isWORDCHAR_uni(tmp),
1665 cBOOL(swash_fetch(PL_utf8_swash_ptrs[_CC_WORDCHAR], (U8*)s, utf8_target)));
1668 FBC_NBOUND_NOLOAD(isWORDCHAR_A,
1670 isWORDCHAR_A((U8*)s));
1673 FBC_BOUND(isWORDCHAR_L1,
1674 isWORDCHAR_uni(tmp),
1675 cBOOL(swash_fetch(PL_utf8_swash_ptrs[_CC_WORDCHAR], (U8*)s, utf8_target)));
1678 FBC_NBOUND(isWORDCHAR_L1,
1679 isWORDCHAR_uni(tmp),
1680 cBOOL(swash_fetch(PL_utf8_swash_ptrs[_CC_WORDCHAR], (U8*)s, utf8_target)));
1683 REXEC_FBC_CSCAN(is_LNBREAK_utf8_safe(s, strend),
1684 is_LNBREAK_latin1_safe(s, strend)
1688 /* The argument to all the POSIX node types is the class number to pass to
1689 * _generic_isCC() to build a mask for searching in PL_charclass[] */
1696 RXp_MATCH_TAINTED_on(prog);
1697 REXEC_FBC_CSCAN(to_complement ^ cBOOL(isFOO_utf8_lc(FLAGS(c), (U8 *) s)),
1698 to_complement ^ cBOOL(isFOO_lc(FLAGS(c), *s)));
1713 /* The complement of something that matches only ASCII matches all
1714 * UTF-8 variant code points, plus everything in ASCII that isn't
1716 REXEC_FBC_UTF8_CLASS_SCAN(! UTF8_IS_INVARIANT(*s)
1717 || ! _generic_isCC_A(*s, FLAGS(c)));
1726 /* Don't need to worry about utf8, as it can match only a single
1727 * byte invariant character. */
1728 REXEC_FBC_CLASS_SCAN(
1729 to_complement ^ cBOOL(_generic_isCC_A(*s, FLAGS(c))));
1737 if (! utf8_target) {
1738 REXEC_FBC_CLASS_SCAN(to_complement ^ cBOOL(_generic_isCC(*s,
1744 classnum = (_char_class_number) FLAGS(c);
1745 if (classnum < _FIRST_NON_SWASH_CC) {
1746 while (s < strend) {
1748 /* We avoid loading in the swash as long as possible, but
1749 * should we have to, we jump to a separate loop. This
1750 * extra 'if' statement is what keeps this code from being
1751 * just a call to REXEC_FBC_UTF8_CLASS_SCAN() */
1752 if (UTF8_IS_ABOVE_LATIN1(*s)) {
1753 goto found_above_latin1;
1755 if ((UTF8_IS_INVARIANT(*s)
1756 && to_complement ^ cBOOL(_generic_isCC((U8) *s,
1758 || (UTF8_IS_DOWNGRADEABLE_START(*s)
1759 && to_complement ^ cBOOL(
1760 _generic_isCC(TWO_BYTE_UTF8_TO_NATIVE(*s,
1764 if (tmp && (reginfo->intuit || regtry(reginfo, &s)))
1776 else switch (classnum) { /* These classes are implemented as
1778 case _CC_ENUM_SPACE: /* XXX would require separate code if we
1779 revert the change of \v matching this */
1782 case _CC_ENUM_PSXSPC:
1783 REXEC_FBC_UTF8_CLASS_SCAN(
1784 to_complement ^ cBOOL(isSPACE_utf8(s)));
1787 case _CC_ENUM_BLANK:
1788 REXEC_FBC_UTF8_CLASS_SCAN(
1789 to_complement ^ cBOOL(isBLANK_utf8(s)));
1792 case _CC_ENUM_XDIGIT:
1793 REXEC_FBC_UTF8_CLASS_SCAN(
1794 to_complement ^ cBOOL(isXDIGIT_utf8(s)));
1797 case _CC_ENUM_VERTSPACE:
1798 REXEC_FBC_UTF8_CLASS_SCAN(
1799 to_complement ^ cBOOL(isVERTWS_utf8(s)));
1802 case _CC_ENUM_CNTRL:
1803 REXEC_FBC_UTF8_CLASS_SCAN(
1804 to_complement ^ cBOOL(isCNTRL_utf8(s)));
1808 Perl_croak(aTHX_ "panic: find_byclass() node %d='%s' has an unexpected character class '%d'", OP(c), PL_reg_name[OP(c)], classnum);
1809 assert(0); /* NOTREACHED */
1814 found_above_latin1: /* Here we have to load a swash to get the result
1815 for the current code point */
1816 if (! PL_utf8_swash_ptrs[classnum]) {
1817 U8 flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;
1818 PL_utf8_swash_ptrs[classnum] =
1819 _core_swash_init("utf8", swash_property_names[classnum],
1820 &PL_sv_undef, 1, 0, NULL, &flags);
1823 /* This is a copy of the loop above for swash classes, though using the
1824 * FBC macro instead of being expanded out. Since we've loaded the
1825 * swash, we don't have to check for that each time through the loop */
1826 REXEC_FBC_UTF8_CLASS_SCAN(
1827 to_complement ^ cBOOL(_generic_utf8(
1830 swash_fetch(PL_utf8_swash_ptrs[classnum],
1838 /* what trie are we using right now */
1839 reg_ac_data *aho = (reg_ac_data*)progi->data->data[ ARG( c ) ];
1840 reg_trie_data *trie = (reg_trie_data*)progi->data->data[ aho->trie ];
1841 HV *widecharmap = MUTABLE_HV(progi->data->data[ aho->trie + 1 ]);
1843 const char *last_start = strend - trie->minlen;
1845 const char *real_start = s;
1847 STRLEN maxlen = trie->maxlen;
1849 U8 **points; /* map of where we were in the input string
1850 when reading a given char. For ASCII this
1851 is unnecessary overhead as the relationship
1852 is always 1:1, but for Unicode, especially
1853 case folded Unicode this is not true. */
1854 U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
1858 GET_RE_DEBUG_FLAGS_DECL;
1860 /* We can't just allocate points here. We need to wrap it in
1861 * an SV so it gets freed properly if there is a croak while
1862 * running the match */
1865 sv_points=newSV(maxlen * sizeof(U8 *));
1866 SvCUR_set(sv_points,
1867 maxlen * sizeof(U8 *));
1868 SvPOK_on(sv_points);
1869 sv_2mortal(sv_points);
1870 points=(U8**)SvPV_nolen(sv_points );
1871 if ( trie_type != trie_utf8_fold
1872 && (trie->bitmap || OP(c)==AHOCORASICKC) )
1875 bitmap=(U8*)trie->bitmap;
1877 bitmap=(U8*)ANYOF_BITMAP(c);
1879 /* this is the Aho-Corasick algorithm modified a touch
1880 to include special handling for long "unknown char" sequences.
1881 The basic idea being that we use AC as long as we are dealing
1882 with a possible matching char, when we encounter an unknown char
1883 (and we have not encountered an accepting state) we scan forward
1884 until we find a legal starting char.
1885 AC matching is basically that of trie matching, except that when
1886 we encounter a failing transition, we fall back to the current
1887 states "fail state", and try the current char again, a process
1888 we repeat until we reach the root state, state 1, or a legal
1889 transition. If we fail on the root state then we can either
1890 terminate if we have reached an accepting state previously, or
1891 restart the entire process from the beginning if we have not.
1894 while (s <= last_start) {
1895 const U32 uniflags = UTF8_ALLOW_DEFAULT;
1903 U8 *uscan = (U8*)NULL;
1904 U8 *leftmost = NULL;
1906 U32 accepted_word= 0;
1910 while ( state && uc <= (U8*)strend ) {
1912 U32 word = aho->states[ state ].wordnum;
1916 DEBUG_TRIE_EXECUTE_r(
1917 if ( uc <= (U8*)last_start && !BITMAP_TEST(bitmap,*uc) ) {
1918 dump_exec_pos( (char *)uc, c, strend, real_start,
1919 (char *)uc, utf8_target );
1920 PerlIO_printf( Perl_debug_log,
1921 " Scanning for legal start char...\n");
1925 while ( uc <= (U8*)last_start && !BITMAP_TEST(bitmap,*uc) ) {
1929 while ( uc <= (U8*)last_start && !BITMAP_TEST(bitmap,*uc) ) {
1935 if (uc >(U8*)last_start) break;
1939 U8 *lpos= points[ (pointpos - trie->wordinfo[word].len) % maxlen ];
1940 if (!leftmost || lpos < leftmost) {
1941 DEBUG_r(accepted_word=word);
1947 points[pointpos++ % maxlen]= uc;
1948 if (foldlen || uc < (U8*)strend) {
1949 REXEC_TRIE_READ_CHAR(trie_type, trie,
1951 uscan, len, uvc, charid, foldlen,
1953 DEBUG_TRIE_EXECUTE_r({
1954 dump_exec_pos( (char *)uc, c, strend,
1955 real_start, s, utf8_target);
1956 PerlIO_printf(Perl_debug_log,
1957 " Charid:%3u CP:%4"UVxf" ",
1969 word = aho->states[ state ].wordnum;
1971 base = aho->states[ state ].trans.base;
1973 DEBUG_TRIE_EXECUTE_r({
1975 dump_exec_pos( (char *)uc, c, strend, real_start,
1977 PerlIO_printf( Perl_debug_log,
1978 "%sState: %4"UVxf", word=%"UVxf,
1979 failed ? " Fail transition to " : "",
1980 (UV)state, (UV)word);
1986 ( ((offset = base + charid
1987 - 1 - trie->uniquecharcount)) >= 0)
1988 && ((U32)offset < trie->lasttrans)
1989 && trie->trans[offset].check == state
1990 && (tmp=trie->trans[offset].next))
1992 DEBUG_TRIE_EXECUTE_r(
1993 PerlIO_printf( Perl_debug_log," - legal\n"));
1998 DEBUG_TRIE_EXECUTE_r(
1999 PerlIO_printf( Perl_debug_log," - fail\n"));
2001 state = aho->fail[state];
2005 /* we must be accepting here */
2006 DEBUG_TRIE_EXECUTE_r(
2007 PerlIO_printf( Perl_debug_log," - accepting\n"));
2016 if (!state) state = 1;
2019 if ( aho->states[ state ].wordnum ) {
2020 U8 *lpos = points[ (pointpos - trie->wordinfo[aho->states[ state ].wordnum].len) % maxlen ];
2021 if (!leftmost || lpos < leftmost) {
2022 DEBUG_r(accepted_word=aho->states[ state ].wordnum);
2027 s = (char*)leftmost;
2028 DEBUG_TRIE_EXECUTE_r({
2030 Perl_debug_log,"Matches word #%"UVxf" at position %"IVdf". Trying full pattern...\n",
2031 (UV)accepted_word, (IV)(s - real_start)
2034 if (reginfo->intuit || regtry(reginfo, &s)) {
2040 DEBUG_TRIE_EXECUTE_r({
2041 PerlIO_printf( Perl_debug_log,"Pattern failed. Looking for new start point...\n");
2044 DEBUG_TRIE_EXECUTE_r(
2045 PerlIO_printf( Perl_debug_log,"No match.\n"));
2054 Perl_croak(aTHX_ "panic: unknown regstclass %d", (int)OP(c));
2062 /* set RX_SAVED_COPY, RX_SUBBEG etc.
2063 * flags have same meanings as with regexec_flags() */
2066 S_reg_set_capture_string(pTHX_ REGEXP * const rx,
2073 struct regexp *const prog = ReANY(rx);
2075 if (flags & REXEC_COPY_STR) {
2079 PerlIO_printf(Perl_debug_log,
2080 "Copy on write: regexp capture, type %d\n",
2083 /* Create a new COW SV to share the match string and store
2084 * in saved_copy, unless the current COW SV in saved_copy
2085 * is valid and suitable for our purpose */
2086 if (( prog->saved_copy
2087 && SvIsCOW(prog->saved_copy)
2088 && SvPOKp(prog->saved_copy)
2091 && SvPVX(sv) == SvPVX(prog->saved_copy)))
2093 /* just reuse saved_copy SV */
2094 if (RXp_MATCH_COPIED(prog)) {
2095 Safefree(prog->subbeg);
2096 RXp_MATCH_COPIED_off(prog);
2100 /* create new COW SV to share string */
2101 RX_MATCH_COPY_FREE(rx);
2102 prog->saved_copy = sv_setsv_cow(prog->saved_copy, sv);
2104 prog->subbeg = (char *)SvPVX_const(prog->saved_copy);
2105 assert (SvPOKp(prog->saved_copy));
2106 prog->sublen = strend - strbeg;
2107 prog->suboffset = 0;
2108 prog->subcoffset = 0;
2113 SSize_t max = strend - strbeg;
2116 if ( (flags & REXEC_COPY_SKIP_POST)
2117 && !(prog->extflags & RXf_PMf_KEEPCOPY) /* //p */
2118 && !(PL_sawampersand & SAWAMPERSAND_RIGHT)
2119 ) { /* don't copy $' part of string */
2122 /* calculate the right-most part of the string covered
2123 * by a capture. Due to look-ahead, this may be to
2124 * the right of $&, so we have to scan all captures */
2125 while (n <= prog->lastparen) {
2126 if (prog->offs[n].end > max)
2127 max = prog->offs[n].end;
2131 max = (PL_sawampersand & SAWAMPERSAND_LEFT)
2132 ? prog->offs[0].start
2134 assert(max >= 0 && max <= strend - strbeg);
2137 if ( (flags & REXEC_COPY_SKIP_PRE)
2138 && !(prog->extflags & RXf_PMf_KEEPCOPY) /* //p */
2139 && !(PL_sawampersand & SAWAMPERSAND_LEFT)
2140 ) { /* don't copy $` part of string */
2143 /* calculate the left-most part of the string covered
2144 * by a capture. Due to look-behind, this may be to
2145 * the left of $&, so we have to scan all captures */
2146 while (min && n <= prog->lastparen) {
2147 if ( prog->offs[n].start != -1
2148 && prog->offs[n].start < min)
2150 min = prog->offs[n].start;
2154 if ((PL_sawampersand & SAWAMPERSAND_RIGHT)
2155 && min > prog->offs[0].end
2157 min = prog->offs[0].end;
2161 assert(min >= 0 && min <= max && min <= strend - strbeg);
2164 if (RX_MATCH_COPIED(rx)) {
2165 if (sublen > prog->sublen)
2167 (char*)saferealloc(prog->subbeg, sublen+1);
2170 prog->subbeg = (char*)safemalloc(sublen+1);
2171 Copy(strbeg + min, prog->subbeg, sublen, char);
2172 prog->subbeg[sublen] = '\0';
2173 prog->suboffset = min;
2174 prog->sublen = sublen;
2175 RX_MATCH_COPIED_on(rx);
2177 prog->subcoffset = prog->suboffset;
2178 if (prog->suboffset && utf8_target) {
2179 /* Convert byte offset to chars.
2180 * XXX ideally should only compute this if @-/@+
2181 * has been seen, a la PL_sawampersand ??? */
2183 /* If there's a direct correspondence between the
2184 * string which we're matching and the original SV,
2185 * then we can use the utf8 len cache associated with
2186 * the SV. In particular, it means that under //g,
2187 * sv_pos_b2u() will use the previously cached
2188 * position to speed up working out the new length of
2189 * subcoffset, rather than counting from the start of
2190 * the string each time. This stops
2191 * $x = "\x{100}" x 1E6; 1 while $x =~ /(.)/g;
2192 * from going quadratic */
2193 if (SvPOKp(sv) && SvPVX(sv) == strbeg)
2194 prog->subcoffset = sv_pos_b2u_flags(sv, prog->subcoffset,
2195 SV_GMAGIC|SV_CONST_RETURN);
2197 prog->subcoffset = utf8_length((U8*)strbeg,
2198 (U8*)(strbeg+prog->suboffset));
2202 RX_MATCH_COPY_FREE(rx);
2203 prog->subbeg = strbeg;
2204 prog->suboffset = 0;
2205 prog->subcoffset = 0;
2206 prog->sublen = strend - strbeg;
2214 - regexec_flags - match a regexp against a string
2217 Perl_regexec_flags(pTHX_ REGEXP * const rx, char *stringarg, char *strend,
2218 char *strbeg, SSize_t minend, SV *sv, void *data, U32 flags)
2219 /* stringarg: the point in the string at which to begin matching */
2220 /* strend: pointer to null at end of string */
2221 /* strbeg: real beginning of string */
2222 /* minend: end of match must be >= minend bytes after stringarg. */
2223 /* sv: SV being matched: only used for utf8 flag, pos() etc; string
2224 * itself is accessed via the pointers above */
2225 /* data: May be used for some additional optimizations.
2226 Currently unused. */
2227 /* flags: For optimizations. See REXEC_* in regexp.h */
2231 struct regexp *const prog = ReANY(rx);
2235 SSize_t minlen; /* must match at least this many chars */
2236 SSize_t dontbother = 0; /* how many characters not to try at end */
2237 const bool utf8_target = cBOOL(DO_UTF8(sv));
2239 RXi_GET_DECL(prog,progi);
2240 regmatch_info reginfo_buf; /* create some info to pass to regtry etc */
2241 regmatch_info *const reginfo = ®info_buf;
2242 regexp_paren_pair *swap = NULL;
2244 GET_RE_DEBUG_FLAGS_DECL;
2246 PERL_ARGS_ASSERT_REGEXEC_FLAGS;
2247 PERL_UNUSED_ARG(data);
2249 /* Be paranoid... */
2250 if (prog == NULL || stringarg == NULL) {
2251 Perl_croak(aTHX_ "NULL regexp parameter");
2256 debug_start_match(rx, utf8_target, stringarg, strend,
2260 startpos = stringarg;
2262 if (prog->extflags & RXf_GPOS_SEEN) {
2265 /* set reginfo->ganch, the position where \G can match */
2268 (flags & REXEC_IGNOREPOS)
2269 ? stringarg /* use start pos rather than pos() */
2270 : (sv && (mg = mg_find_mglob(sv)) && mg->mg_len >= 0)
2271 /* Defined pos(): */
2272 ? strbeg + MgBYTEPOS(mg, sv, strbeg, strend-strbeg)
2273 : strbeg; /* pos() not defined; use start of string */
2275 DEBUG_GPOS_r(PerlIO_printf(Perl_debug_log,
2276 "GPOS ganch set to strbeg[%"IVdf"]\n", reginfo->ganch - strbeg));
2278 /* in the presence of \G, we may need to start looking earlier in
2279 * the string than the suggested start point of stringarg:
2280 * if gofs->prog is set, then that's a known, fixed minimum
2283 * /ab|c\G/: gofs = 1
2284 * or if the minimum offset isn't known, then we have to go back
2285 * to the start of the string, e.g. /w+\G/
2288 if (prog->extflags & RXf_ANCH_GPOS) {
2289 startpos = reginfo->ganch - prog->gofs;
2291 ((flags & REXEC_FAIL_ON_UNDERFLOW) ? stringarg : strbeg))
2293 DEBUG_r(PerlIO_printf(Perl_debug_log,
2294 "fail: ganch-gofs before earliest possible start\n"));
2298 else if (prog->gofs) {
2299 if (startpos - prog->gofs < strbeg)
2302 startpos -= prog->gofs;
2304 else if (prog->extflags & RXf_GPOS_FLOAT)
2308 minlen = prog->minlen;
2309 if ((startpos + minlen) > strend || startpos < strbeg) {
2310 DEBUG_r(PerlIO_printf(Perl_debug_log,
2311 "Regex match can't succeed, so not even tried\n"));
2315 /* at the end of this function, we'll do a LEAVE_SCOPE(oldsave),
2316 * which will call destuctors to reset PL_regmatch_state, free higher
2317 * PL_regmatch_slabs, and clean up regmatch_info_aux and
2318 * regmatch_info_aux_eval */
2320 oldsave = PL_savestack_ix;
2324 if ((prog->extflags & RXf_USE_INTUIT)
2325 && !(flags & REXEC_CHECKED))
2327 s = re_intuit_start(rx, sv, strbeg, startpos, strend,
2332 if (prog->extflags & RXf_CHECK_ALL) {
2333 /* we can match based purely on the result of INTUIT.
2334 * Set up captures etc just for $& and $-[0]
2335 * (an intuit-only match wont have $1,$2,..) */
2336 assert(!prog->nparens);
2338 /* s/// doesn't like it if $& is earlier than where we asked it to
2339 * start searching (which can happen on something like /.\G/) */
2340 if ( (flags & REXEC_FAIL_ON_UNDERFLOW)
2343 /* this should only be possible under \G */
2344 assert(prog->extflags & RXf_GPOS_SEEN);
2345 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
2346 "matched, but failing for REXEC_FAIL_ON_UNDERFLOW\n"));
2350 /* match via INTUIT shouldn't have any captures.
2351 * Let @-, @+, $^N know */
2352 prog->lastparen = prog->lastcloseparen = 0;
2353 RX_MATCH_UTF8_set(rx, utf8_target);
2354 prog->offs[0].start = s - strbeg;
2355 prog->offs[0].end = utf8_target
2356 ? (char*)utf8_hop((U8*)s, prog->minlenret) - strbeg
2357 : s - strbeg + prog->minlenret;
2358 if ( !(flags & REXEC_NOT_FIRST) )
2359 S_reg_set_capture_string(aTHX_ rx,
2361 sv, flags, utf8_target);
2367 multiline = prog->extflags & RXf_PMf_MULTILINE;
2369 if (strend - s < (minlen+(prog->check_offset_min<0?prog->check_offset_min:0))) {
2370 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
2371 "String too short [regexec_flags]...\n"));
2375 /* Check validity of program. */
2376 if (UCHARAT(progi->program) != REG_MAGIC) {
2377 Perl_croak(aTHX_ "corrupted regexp program");
2380 RX_MATCH_TAINTED_off(rx);
2382 reginfo->prog = rx; /* Yes, sorry that this is confusing. */
2383 reginfo->intuit = 0;
2384 reginfo->is_utf8_target = cBOOL(utf8_target);
2385 reginfo->is_utf8_pat = cBOOL(RX_UTF8(rx));
2386 reginfo->warned = FALSE;
2387 reginfo->strbeg = strbeg;
2389 reginfo->poscache_maxiter = 0; /* not yet started a countdown */
2390 reginfo->strend = strend;
2391 /* see how far we have to get to not match where we matched before */
2392 reginfo->till = stringarg + minend;
2394 if (prog->extflags & RXf_EVAL_SEEN && SvPADTMP(sv) && !IS_PADGV(sv)) {
2395 /* SAVEFREESV, not sv_mortalcopy, as this SV must last until after
2396 S_cleanup_regmatch_info_aux has executed (registered by
2397 SAVEDESTRUCTOR_X below). S_cleanup_regmatch_info_aux modifies
2398 magic belonging to this SV.
2399 Not newSVsv, either, as it does not COW.
2401 reginfo->sv = newSV(0);
2402 sv_setsv(reginfo->sv, sv);
2403 SAVEFREESV(reginfo->sv);
2406 /* reserve next 2 or 3 slots in PL_regmatch_state:
2407 * slot N+0: may currently be in use: skip it
2408 * slot N+1: use for regmatch_info_aux struct
2409 * slot N+2: use for regmatch_info_aux_eval struct if we have (?{})'s
2410 * slot N+3: ready for use by regmatch()
2414 regmatch_state *old_regmatch_state;
2415 regmatch_slab *old_regmatch_slab;
2416 int i, max = (prog->extflags & RXf_EVAL_SEEN) ? 2 : 1;
2418 /* on first ever match, allocate first slab */
2419 if (!PL_regmatch_slab) {
2420 Newx(PL_regmatch_slab, 1, regmatch_slab);
2421 PL_regmatch_slab->prev = NULL;
2422 PL_regmatch_slab->next = NULL;
2423 PL_regmatch_state = SLAB_FIRST(PL_regmatch_slab);
2426 old_regmatch_state = PL_regmatch_state;
2427 old_regmatch_slab = PL_regmatch_slab;
2429 for (i=0; i <= max; i++) {
2431 reginfo->info_aux = &(PL_regmatch_state->u.info_aux);
2433 reginfo->info_aux_eval =
2434 reginfo->info_aux->info_aux_eval =
2435 &(PL_regmatch_state->u.info_aux_eval);
2437 if (++PL_regmatch_state > SLAB_LAST(PL_regmatch_slab))
2438 PL_regmatch_state = S_push_slab(aTHX);
2441 /* note initial PL_regmatch_state position; at end of match we'll
2442 * pop back to there and free any higher slabs */
2444 reginfo->info_aux->old_regmatch_state = old_regmatch_state;
2445 reginfo->info_aux->old_regmatch_slab = old_regmatch_slab;
2446 reginfo->info_aux->poscache = NULL;
2448 SAVEDESTRUCTOR_X(S_cleanup_regmatch_info_aux, reginfo->info_aux);
2450 if ((prog->extflags & RXf_EVAL_SEEN))
2451 S_setup_eval_state(aTHX_ reginfo);
2453 reginfo->info_aux_eval = reginfo->info_aux->info_aux_eval = NULL;
2456 /* If there is a "must appear" string, look for it. */
2458 if (PL_curpm && (PM_GETRE(PL_curpm) == rx)) {
2459 /* We have to be careful. If the previous successful match
2460 was from this regex we don't want a subsequent partially
2461 successful match to clobber the old results.
2462 So when we detect this possibility we add a swap buffer
2463 to the re, and switch the buffer each match. If we fail,
2464 we switch it back; otherwise we leave it swapped.
2467 /* do we need a save destructor here for eval dies? */
2468 Newxz(prog->offs, (prog->nparens + 1), regexp_paren_pair);
2469 DEBUG_BUFFERS_r(PerlIO_printf(Perl_debug_log,
2470 "rex=0x%"UVxf" saving offs: orig=0x%"UVxf" new=0x%"UVxf"\n",
2477 /* Simplest case: anchored match need be tried only once. */
2478 /* [unless only anchor is BOL and multiline is set] */
2479 if (prog->extflags & (RXf_ANCH & ~RXf_ANCH_GPOS)) {
2480 if (s == startpos && regtry(reginfo, &s))
2482 else if (multiline || (prog->intflags & PREGf_IMPLICIT)
2483 || (prog->extflags & RXf_ANCH_MBOL)) /* XXXX SBOL? */
2488 dontbother = minlen - 1;
2489 end = HOP3c(strend, -dontbother, strbeg) - 1;
2490 /* for multiline we only have to try after newlines */
2491 if (prog->check_substr || prog->check_utf8) {
2492 /* because of the goto we can not easily reuse the macros for bifurcating the
2493 unicode/non-unicode match modes here like we do elsewhere - demerphq */
2496 goto after_try_utf8;
2498 if (regtry(reginfo, &s)) {
2505 if (prog->extflags & RXf_USE_INTUIT) {
2506 s = re_intuit_start(rx, sv, strbeg,
2507 s + UTF8SKIP(s), strend, flags, NULL);
2516 } /* end search for check string in unicode */
2518 if (s == startpos) {
2519 goto after_try_latin;
2522 if (regtry(reginfo, &s)) {
2529 if (prog->extflags & RXf_USE_INTUIT) {
2530 s = re_intuit_start(rx, sv, strbeg,
2531 s + 1, strend, flags, NULL);
2540 } /* end search for check string in latin*/
2541 } /* end search for check string */
2542 else { /* search for newline */
2544 /*XXX: The s-- is almost definitely wrong here under unicode - demeprhq*/
2547 /* We can use a more efficient search as newlines are the same in unicode as they are in latin */
2548 while (s <= end) { /* note it could be possible to match at the end of the string */
2549 if (*s++ == '\n') { /* don't need PL_utf8skip here */
2550 if (regtry(reginfo, &s))
2554 } /* end search for newline */
2555 } /* end anchored/multiline check string search */
2557 } else if (RXf_GPOS_CHECK == (prog->extflags & RXf_GPOS_CHECK))
2559 /* For anchored \G, the only position it can match from is
2560 * (ganch-gofs); we already set startpos to this above; if intuit
2561 * moved us on from there, we can't possibly succeed */
2562 assert(startpos == reginfo->ganch - prog->gofs);
2563 if (s == startpos && regtry(reginfo, &s))
2568 /* Messy cases: unanchored match. */
2569 if ((prog->anchored_substr || prog->anchored_utf8) && prog->intflags & PREGf_SKIP) {
2570 /* we have /x+whatever/ */
2571 /* it must be a one character string (XXXX Except is_utf8_pat?) */
2577 if (! prog->anchored_utf8) {
2578 to_utf8_substr(prog);
2580 ch = SvPVX_const(prog->anchored_utf8)[0];
2583 DEBUG_EXECUTE_r( did_match = 1 );
2584 if (regtry(reginfo, &s)) goto got_it;
2586 while (s < strend && *s == ch)
2593 if (! prog->anchored_substr) {
2594 if (! to_byte_substr(prog)) {
2595 NON_UTF8_TARGET_BUT_UTF8_REQUIRED(phooey);
2598 ch = SvPVX_const(prog->anchored_substr)[0];
2601 DEBUG_EXECUTE_r( did_match = 1 );
2602 if (regtry(reginfo, &s)) goto got_it;
2604 while (s < strend && *s == ch)
2609 DEBUG_EXECUTE_r(if (!did_match)
2610 PerlIO_printf(Perl_debug_log,
2611 "Did not find anchored character...\n")
2614 else if (prog->anchored_substr != NULL
2615 || prog->anchored_utf8 != NULL
2616 || ((prog->float_substr != NULL || prog->float_utf8 != NULL)
2617 && prog->float_max_offset < strend - s)) {
2622 char *last1; /* Last position checked before */
2626 if (prog->anchored_substr || prog->anchored_utf8) {
2628 if (! prog->anchored_utf8) {
2629 to_utf8_substr(prog);
2631 must = prog->anchored_utf8;
2634 if (! prog->anchored_substr) {
2635 if (! to_byte_substr(prog)) {
2636 NON_UTF8_TARGET_BUT_UTF8_REQUIRED(phooey);
2639 must = prog->anchored_substr;
2641 back_max = back_min = prog->anchored_offset;
2644 if (! prog->float_utf8) {
2645 to_utf8_substr(prog);
2647 must = prog->float_utf8;
2650 if (! prog->float_substr) {
2651 if (! to_byte_substr(prog)) {
2652 NON_UTF8_TARGET_BUT_UTF8_REQUIRED(phooey);
2655 must = prog->float_substr;
2657 back_max = prog->float_max_offset;
2658 back_min = prog->float_min_offset;
2664 last = HOP3c(strend, /* Cannot start after this */
2665 -(SSize_t)(CHR_SVLEN(must)
2666 - (SvTAIL(must) != 0) + back_min), strbeg);
2668 if (s > reginfo->strbeg)
2669 last1 = HOPc(s, -1);
2671 last1 = s - 1; /* bogus */
2673 /* XXXX check_substr already used to find "s", can optimize if
2674 check_substr==must. */
2676 strend = HOPc(strend, -dontbother);
2677 while ( (s <= last) &&
2678 (s = fbm_instr((unsigned char*)HOP3(s, back_min, (back_min<0 ? strbeg : strend)),
2679 (unsigned char*)strend, must,
2680 multiline ? FBMrf_MULTILINE : 0)) ) {
2681 DEBUG_EXECUTE_r( did_match = 1 );
2682 if (HOPc(s, -back_max) > last1) {
2683 last1 = HOPc(s, -back_min);
2684 s = HOPc(s, -back_max);
2687 char * const t = (last1 >= reginfo->strbeg)
2688 ? HOPc(last1, 1) : last1 + 1;
2690 last1 = HOPc(s, -back_min);
2694 while (s <= last1) {
2695 if (regtry(reginfo, &s))
2698 s++; /* to break out of outer loop */
2705 while (s <= last1) {
2706 if (regtry(reginfo, &s))
2712 DEBUG_EXECUTE_r(if (!did_match) {
2713 RE_PV_QUOTED_DECL(quoted, utf8_target, PERL_DEBUG_PAD_ZERO(0),
2714 SvPVX_const(must), RE_SV_DUMPLEN(must), 30);
2715 PerlIO_printf(Perl_debug_log, "Did not find %s substr %s%s...\n",
2716 ((must == prog->anchored_substr || must == prog->anchored_utf8)
2717 ? "anchored" : "floating"),
2718 quoted, RE_SV_TAIL(must));
2722 else if ( (c = progi->regstclass) ) {
2724 const OPCODE op = OP(progi->regstclass);
2725 /* don't bother with what can't match */
2726 if (PL_regkind[op] != EXACT && op != CANY && PL_regkind[op] != TRIE)
2727 strend = HOPc(strend, -(minlen - 1));
2730 SV * const prop = sv_newmortal();
2731 regprop(prog, prop, c);
2733 RE_PV_QUOTED_DECL(quoted,utf8_target,PERL_DEBUG_PAD_ZERO(1),
2735 PerlIO_printf(Perl_debug_log,
2736 "Matching stclass %.*s against %s (%d bytes)\n",
2737 (int)SvCUR(prop), SvPVX_const(prop),
2738 quoted, (int)(strend - s));
2741 if (find_byclass(prog, c, s, strend, reginfo))
2743 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Contradicts stclass... [regexec_flags]\n"));
2747 if (prog->float_substr != NULL || prog->float_utf8 != NULL) {
2755 if (! prog->float_utf8) {
2756 to_utf8_substr(prog);
2758 float_real = prog->float_utf8;
2761 if (! prog->float_substr) {
2762 if (! to_byte_substr(prog)) {
2763 NON_UTF8_TARGET_BUT_UTF8_REQUIRED(phooey);
2766 float_real = prog->float_substr;
2769 little = SvPV_const(float_real, len);
2770 if (SvTAIL(float_real)) {
2771 /* This means that float_real contains an artificial \n on
2772 * the end due to the presence of something like this:
2773 * /foo$/ where we can match both "foo" and "foo\n" at the
2774 * end of the string. So we have to compare the end of the
2775 * string first against the float_real without the \n and
2776 * then against the full float_real with the string. We
2777 * have to watch out for cases where the string might be
2778 * smaller than the float_real or the float_real without
2780 char *checkpos= strend - len;
2782 PerlIO_printf(Perl_debug_log,
2783 "%sChecking for float_real.%s\n",
2784 PL_colors[4], PL_colors[5]));
2785 if (checkpos + 1 < strbeg) {
2786 /* can't match, even if we remove the trailing \n
2787 * string is too short to match */
2789 PerlIO_printf(Perl_debug_log,
2790 "%sString shorter than required trailing substring, cannot match.%s\n",
2791 PL_colors[4], PL_colors[5]));
2793 } else if (memEQ(checkpos + 1, little, len - 1)) {
2794 /* can match, the end of the string matches without the
2796 last = checkpos + 1;
2797 } else if (checkpos < strbeg) {
2798 /* cant match, string is too short when the "\n" is
2801 PerlIO_printf(Perl_debug_log,
2802 "%sString does not contain required trailing substring, cannot match.%s\n",
2803 PL_colors[4], PL_colors[5]));
2805 } else if (!multiline) {
2806 /* non multiline match, so compare with the "\n" at the
2807 * end of the string */
2808 if (memEQ(checkpos, little, len)) {
2812 PerlIO_printf(Perl_debug_log,
2813 "%sString does not contain required trailing substring, cannot match.%s\n",
2814 PL_colors[4], PL_colors[5]));
2818 /* multiline match, so we have to search for a place
2819 * where the full string is located */
2825 last = rninstr(s, strend, little, little + len);
2827 last = strend; /* matching "$" */
2830 /* at one point this block contained a comment which was
2831 * probably incorrect, which said that this was a "should not
2832 * happen" case. Even if it was true when it was written I am
2833 * pretty sure it is not anymore, so I have removed the comment
2834 * and replaced it with this one. Yves */
2836 PerlIO_printf(Perl_debug_log,
2837 "String does not contain required substring, cannot match.\n"
2841 dontbother = strend - last + prog->float_min_offset;
2843 if (minlen && (dontbother < minlen))
2844 dontbother = minlen - 1;
2845 strend -= dontbother; /* this one's always in bytes! */
2846 /* We don't know much -- general case. */
2849 if (regtry(reginfo, &s))
2858 if (regtry(reginfo, &s))
2860 } while (s++ < strend);
2868 /* s/// doesn't like it if $& is earlier than where we asked it to
2869 * start searching (which can happen on something like /.\G/) */
2870 if ( (flags & REXEC_FAIL_ON_UNDERFLOW)
2871 && (prog->offs[0].start < stringarg - strbeg))
2873 /* this should only be possible under \G */
2874 assert(prog->extflags & RXf_GPOS_SEEN);
2875 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
2876 "matched, but failing for REXEC_FAIL_ON_UNDERFLOW\n"));
2882 PerlIO_printf(Perl_debug_log,
2883 "rex=0x%"UVxf" freeing offs: 0x%"UVxf"\n",
2890 /* clean up; this will trigger destructors that will free all slabs
2891 * above the current one, and cleanup the regmatch_info_aux
2892 * and regmatch_info_aux_eval sructs */
2894 LEAVE_SCOPE(oldsave);
2896 if (RXp_PAREN_NAMES(prog))
2897 (void)hv_iterinit(RXp_PAREN_NAMES(prog));
2899 RX_MATCH_UTF8_set(rx, utf8_target);
2901 /* make sure $`, $&, $', and $digit will work later */
2902 if ( !(flags & REXEC_NOT_FIRST) )
2903 S_reg_set_capture_string(aTHX_ rx,
2904 strbeg, reginfo->strend,
2905 sv, flags, utf8_target);
2910 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "%sMatch failed%s\n",
2911 PL_colors[4], PL_colors[5]));
2913 /* clean up; this will trigger destructors that will free all slabs
2914 * above the current one, and cleanup the regmatch_info_aux
2915 * and regmatch_info_aux_eval sructs */
2917 LEAVE_SCOPE(oldsave);
2920 /* we failed :-( roll it back */
2921 DEBUG_BUFFERS_r(PerlIO_printf(Perl_debug_log,
2922 "rex=0x%"UVxf" rolling back offs: freeing=0x%"UVxf" restoring=0x%"UVxf"\n",
2927 Safefree(prog->offs);
2934 /* Set which rex is pointed to by PL_reg_curpm, handling ref counting.
2935 * Do inc before dec, in case old and new rex are the same */
2936 #define SET_reg_curpm(Re2) \
2937 if (reginfo->info_aux_eval) { \
2938 (void)ReREFCNT_inc(Re2); \
2939 ReREFCNT_dec(PM_GETRE(PL_reg_curpm)); \
2940 PM_SETRE((PL_reg_curpm), (Re2)); \
2945 - regtry - try match at specific point
2947 STATIC I32 /* 0 failure, 1 success */
2948 S_regtry(pTHX_ regmatch_info *reginfo, char **startposp)
2952 REGEXP *const rx = reginfo->prog;
2953 regexp *const prog = ReANY(rx);
2955 RXi_GET_DECL(prog,progi);
2956 GET_RE_DEBUG_FLAGS_DECL;
2958 PERL_ARGS_ASSERT_REGTRY;
2960 reginfo->cutpoint=NULL;
2962 prog->offs[0].start = *startposp - reginfo->strbeg;
2963 prog->lastparen = 0;
2964 prog->lastcloseparen = 0;
2966 /* XXXX What this code is doing here?!!! There should be no need
2967 to do this again and again, prog->lastparen should take care of
2970 /* Tests pat.t#187 and split.t#{13,14} seem to depend on this code.
2971 * Actually, the code in regcppop() (which Ilya may be meaning by
2972 * prog->lastparen), is not needed at all by the test suite
2973 * (op/regexp, op/pat, op/split), but that code is needed otherwise
2974 * this erroneously leaves $1 defined: "1" =~ /^(?:(\d)x)?\d$/
2975 * Meanwhile, this code *is* needed for the
2976 * above-mentioned test suite tests to succeed. The common theme
2977 * on those tests seems to be returning null fields from matches.
2978 * --jhi updated by dapm */
2980 if (prog->nparens) {
2981 regexp_paren_pair *pp = prog->offs;
2983 for (i = prog->nparens; i > (I32)prog->lastparen; i--) {
2991 result = regmatch(reginfo, *startposp, progi->program + 1);
2993 prog->offs[0].end = result;
2996 if (reginfo->cutpoint)
2997 *startposp= reginfo->cutpoint;
2998 REGCP_UNWIND(lastcp);
3003 #define sayYES goto yes
3004 #define sayNO goto no
3005 #define sayNO_SILENT goto no_silent
3007 /* we dont use STMT_START/END here because it leads to
3008 "unreachable code" warnings, which are bogus, but distracting. */
3009 #define CACHEsayNO \
3010 if (ST.cache_mask) \
3011 reginfo->info_aux->poscache[ST.cache_offset] |= ST.cache_mask; \
3014 /* this is used to determine how far from the left messages like
3015 'failed...' are printed. It should be set such that messages
3016 are inline with the regop output that created them.
3018 #define REPORT_CODE_OFF 32
3021 #define CHRTEST_UNINIT -1001 /* c1/c2 haven't been calculated yet */
3022 #define CHRTEST_VOID -1000 /* the c1/c2 "next char" test should be skipped */
3023 #define CHRTEST_NOT_A_CP_1 -999
3024 #define CHRTEST_NOT_A_CP_2 -998
3026 /* grab a new slab and return the first slot in it */
3028 STATIC regmatch_state *
3031 #if PERL_VERSION < 9 && !defined(PERL_CORE)
3034 regmatch_slab *s = PL_regmatch_slab->next;
3036 Newx(s, 1, regmatch_slab);
3037 s->prev = PL_regmatch_slab;
3039 PL_regmatch_slab->next = s;
3041 PL_regmatch_slab = s;
3042 return SLAB_FIRST(s);
3046 /* push a new state then goto it */
3048 #define PUSH_STATE_GOTO(state, node, input) \
3049 pushinput = input; \
3051 st->resume_state = state; \
3054 /* push a new state with success backtracking, then goto it */
3056 #define PUSH_YES_STATE_GOTO(state, node, input) \
3057 pushinput = input; \
3059 st->resume_state = state; \
3060 goto push_yes_state;
3067 regmatch() - main matching routine
3069 This is basically one big switch statement in a loop. We execute an op,
3070 set 'next' to point the next op, and continue. If we come to a point which
3071 we may need to backtrack to on failure such as (A|B|C), we push a
3072 backtrack state onto the backtrack stack. On failure, we pop the top
3073 state, and re-enter the loop at the state indicated. If there are no more
3074 states to pop, we return failure.
3076 Sometimes we also need to backtrack on success; for example /A+/, where
3077 after successfully matching one A, we need to go back and try to
3078 match another one; similarly for lookahead assertions: if the assertion
3079 completes successfully, we backtrack to the state just before the assertion
3080 and then carry on. In these cases, the pushed state is marked as
3081 'backtrack on success too'. This marking is in fact done by a chain of
3082 pointers, each pointing to the previous 'yes' state. On success, we pop to
3083 the nearest yes state, discarding any intermediate failure-only states.
3084 Sometimes a yes state is pushed just to force some cleanup code to be
3085 called at the end of a successful match or submatch; e.g. (??{$re}) uses
3086 it to free the inner regex.
3088 Note that failure backtracking rewinds the cursor position, while
3089 success backtracking leaves it alone.
3091 A pattern is complete when the END op is executed, while a subpattern
3092 such as (?=foo) is complete when the SUCCESS op is executed. Both of these
3093 ops trigger the "pop to last yes state if any, otherwise return true"
3096 A common convention in this function is to use A and B to refer to the two
3097 subpatterns (or to the first nodes thereof) in patterns like /A*B/: so A is
3098 the subpattern to be matched possibly multiple times, while B is the entire
3099 rest of the pattern. Variable and state names reflect this convention.
3101 The states in the main switch are the union of ops and failure/success of
3102 substates associated with with that op. For example, IFMATCH is the op
3103 that does lookahead assertions /(?=A)B/ and so the IFMATCH state means
3104 'execute IFMATCH'; while IFMATCH_A is a state saying that we have just
3105 successfully matched A and IFMATCH_A_fail is a state saying that we have
3106 just failed to match A. Resume states always come in pairs. The backtrack
3107 state we push is marked as 'IFMATCH_A', but when that is popped, we resume
3108 at IFMATCH_A or IFMATCH_A_fail, depending on whether we are backtracking
3109 on success or failure.
3111 The struct that holds a backtracking state is actually a big union, with
3112 one variant for each major type of op. The variable st points to the
3113 top-most backtrack struct. To make the code clearer, within each
3114 block of code we #define ST to alias the relevant union.
3116 Here's a concrete example of a (vastly oversimplified) IFMATCH
3122 #define ST st->u.ifmatch
3124 case IFMATCH: // we are executing the IFMATCH op, (?=A)B
3125 ST.foo = ...; // some state we wish to save
3127 // push a yes backtrack state with a resume value of
3128 // IFMATCH_A/IFMATCH_A_fail, then continue execution at the
3130 PUSH_YES_STATE_GOTO(IFMATCH_A, A, newinput);
3133 case IFMATCH_A: // we have successfully executed A; now continue with B
3135 bar = ST.foo; // do something with the preserved value
3138 case IFMATCH_A_fail: // A failed, so the assertion failed
3139 ...; // do some housekeeping, then ...
3140 sayNO; // propagate the failure
3147 For any old-timers reading this who are familiar with the old recursive
3148 approach, the code above is equivalent to:
3150 case IFMATCH: // we are executing the IFMATCH op, (?=A)B
3159 ...; // do some housekeeping, then ...
3160 sayNO; // propagate the failure
3163 The topmost backtrack state, pointed to by st, is usually free. If you
3164 want to claim it, populate any ST.foo fields in it with values you wish to
3165 save, then do one of
3167 PUSH_STATE_GOTO(resume_state, node, newinput);
3168 PUSH_YES_STATE_GOTO(resume_state, node, newinput);
3170 which sets that backtrack state's resume value to 'resume_state', pushes a
3171 new free entry to the top of the backtrack stack, then goes to 'node'.
3172 On backtracking, the free slot is popped, and the saved state becomes the
3173 new free state. An ST.foo field in this new top state can be temporarily
3174 accessed to retrieve values, but once the main loop is re-entered, it
3175 becomes available for reuse.
3177 Note that the depth of the backtrack stack constantly increases during the
3178 left-to-right execution of the pattern, rather than going up and down with
3179 the pattern nesting. For example the stack is at its maximum at Z at the
3180 end of the pattern, rather than at X in the following:
3182 /(((X)+)+)+....(Y)+....Z/
3184 The only exceptions to this are lookahead/behind assertions and the cut,
3185 (?>A), which pop all the backtrack states associated with A before
3188 Backtrack state structs are allocated in slabs of about 4K in size.
3189 PL_regmatch_state and st always point to the currently active state,
3190 and PL_regmatch_slab points to the slab currently containing
3191 PL_regmatch_state. The first time regmatch() is called, the first slab is
3192 allocated, and is never freed until interpreter destruction. When the slab
3193 is full, a new one is allocated and chained to the end. At exit from
3194 regmatch(), slabs allocated since entry are freed.
3199 #define DEBUG_STATE_pp(pp) \
3201 DUMP_EXEC_POS(locinput, scan, utf8_target); \
3202 PerlIO_printf(Perl_debug_log, \
3203 " %*s"pp" %s%s%s%s%s\n", \
3205 PL_reg_name[st->resume_state], \
3206 ((st==yes_state||st==mark_state) ? "[" : ""), \
3207 ((st==yes_state) ? "Y" : ""), \
3208 ((st==mark_state) ? "M" : ""), \
3209 ((st==yes_state||st==mark_state) ? "]" : "") \
3214 #define REG_NODE_NUM(x) ((x) ? (int)((x)-prog) : -1)
3219 S_debug_start_match(pTHX_ const REGEXP *prog, const bool utf8_target,
3220 const char *start, const char *end, const char *blurb)
3222 const bool utf8_pat = RX_UTF8(prog) ? 1 : 0;
3224 PERL_ARGS_ASSERT_DEBUG_START_MATCH;
3229 RE_PV_QUOTED_DECL(s0, utf8_pat, PERL_DEBUG_PAD_ZERO(0),
3230 RX_PRECOMP_const(prog), RX_PRELEN(prog), 60);
3232 RE_PV_QUOTED_DECL(s1, utf8_target, PERL_DEBUG_PAD_ZERO(1),
3233 start, end - start, 60);
3235 PerlIO_printf(Perl_debug_log,
3236 "%s%s REx%s %s against %s\n",
3237 PL_colors[4], blurb, PL_colors[5], s0, s1);
3239 if (utf8_target||utf8_pat)
3240 PerlIO_printf(Perl_debug_log, "UTF-8 %s%s%s...\n",
3241 utf8_pat ? "pattern" : "",
3242 utf8_pat && utf8_target ? " and " : "",
3243 utf8_target ? "string" : ""
3249 S_dump_exec_pos(pTHX_ const char *locinput,
3250 const regnode *scan,
3251 const char *loc_regeol,
3252 const char *loc_bostr,
3253 const char *loc_reg_starttry,
3254 const bool utf8_target)
3256 const int docolor = *PL_colors[0] || *PL_colors[2] || *PL_colors[4];
3257 const int taill = (docolor ? 10 : 7); /* 3 chars for "> <" */
3258 int l = (loc_regeol - locinput) > taill ? taill : (loc_regeol - locinput);
3259 /* The part of the string before starttry has one color
3260 (pref0_len chars), between starttry and current
3261 position another one (pref_len - pref0_len chars),
3262 after the current position the third one.
3263 We assume that pref0_len <= pref_len, otherwise we
3264 decrease pref0_len. */
3265 int pref_len = (locinput - loc_bostr) > (5 + taill) - l
3266 ? (5 + taill) - l : locinput - loc_bostr;
3269 PERL_ARGS_ASSERT_DUMP_EXEC_POS;
3271 while (utf8_target && UTF8_IS_CONTINUATION(*(U8*)(locinput - pref_len)))
3273 pref0_len = pref_len - (locinput - loc_reg_starttry);
3274 if (l + pref_len < (5 + taill) && l < loc_regeol - locinput)
3275 l = ( loc_regeol - locinput > (5 + taill) - pref_len
3276 ? (5 + taill) - pref_len : loc_regeol - locinput);
3277 while (utf8_target && UTF8_IS_CONTINUATION(*(U8*)(locinput + l)))
3281 if (pref0_len > pref_len)
3282 pref0_len = pref_len;
3284 const int is_uni = (utf8_target && OP(scan) != CANY) ? 1 : 0;
3286 RE_PV_COLOR_DECL(s0,len0,is_uni,PERL_DEBUG_PAD(0),
3287 (locinput - pref_len),pref0_len, 60, 4, 5);
3289 RE_PV_COLOR_DECL(s1,len1,is_uni,PERL_DEBUG_PAD(1),
3290 (locinput - pref_len + pref0_len),
3291 pref_len - pref0_len, 60, 2, 3);
3293 RE_PV_COLOR_DECL(s2,len2,is_uni,PERL_DEBUG_PAD(2),
3294 locinput, loc_regeol - locinput, 10, 0, 1);
3296 const STRLEN tlen=len0+len1+len2;
3297 PerlIO_printf(Perl_debug_log,
3298 "%4"IVdf" <%.*s%.*s%s%.*s>%*s|",
3299 (IV)(locinput - loc_bostr),
3302 (docolor ? "" : "> <"),
3304 (int)(tlen > 19 ? 0 : 19 - tlen),
3311 /* reg_check_named_buff_matched()
3312 * Checks to see if a named buffer has matched. The data array of
3313 * buffer numbers corresponding to the buffer is expected to reside
3314 * in the regexp->data->data array in the slot stored in the ARG() of
3315 * node involved. Note that this routine doesn't actually care about the
3316 * name, that information is not preserved from compilation to execution.
3317 * Returns the index of the leftmost defined buffer with the given name
3318 * or 0 if non of the buffers matched.
3321 S_reg_check_named_buff_matched(pTHX_ const regexp *rex, const regnode *scan)
3324 RXi_GET_DECL(rex,rexi);
3325 SV *sv_dat= MUTABLE_SV(rexi->data->data[ ARG( scan ) ]);
3326 I32 *nums=(I32*)SvPVX(sv_dat);
3328 PERL_ARGS_ASSERT_REG_CHECK_NAMED_BUFF_MATCHED;
3330 for ( n=0; n<SvIVX(sv_dat); n++ ) {
3331 if ((I32)rex->lastparen >= nums[n] &&
3332 rex->offs[nums[n]].end != -1)
3342 S_setup_EXACTISH_ST_c1_c2(pTHX_ const regnode * const text_node, int *c1p,
3343 U8* c1_utf8, int *c2p, U8* c2_utf8, regmatch_info *reginfo)
3345 /* This function determines if there are one or two characters that match
3346 * the first character of the passed-in EXACTish node <text_node>, and if
3347 * so, returns them in the passed-in pointers.
3349 * If it determines that no possible character in the target string can
3350 * match, it returns FALSE; otherwise TRUE. (The FALSE situation occurs if
3351 * the first character in <text_node> requires UTF-8 to represent, and the
3352 * target string isn't in UTF-8.)
3354 * If there are more than two characters that could match the beginning of
3355 * <text_node>, or if more context is required to determine a match or not,
3356 * it sets both *<c1p> and *<c2p> to CHRTEST_VOID.
3358 * The motiviation behind this function is to allow the caller to set up
3359 * tight loops for matching. If <text_node> is of type EXACT, there is
3360 * only one possible character that can match its first character, and so
3361 * the situation is quite simple. But things get much more complicated if
3362 * folding is involved. It may be that the first character of an EXACTFish
3363 * node doesn't participate in any possible fold, e.g., punctuation, so it
3364 * can be matched only by itself. The vast majority of characters that are
3365 * in folds match just two things, their lower and upper-case equivalents.
3366 * But not all are like that; some have multiple possible matches, or match
3367 * sequences of more than one character. This function sorts all that out.
3369 * Consider the patterns A*B or A*?B where A and B are arbitrary. In a
3370 * loop of trying to match A*, we know we can't exit where the thing
3371 * following it isn't a B. And something can't be a B unless it is the
3372 * beginning of B. By putting a quick test for that beginning in a tight
3373 * loop, we can rule out things that can't possibly be B without having to
3374 * break out of the loop, thus avoiding work. Similarly, if A is a single
3375 * character, we can make a tight loop matching A*, using the outputs of
3378 * If the target string to match isn't in UTF-8, and there aren't
3379 * complications which require CHRTEST_VOID, *<c1p> and *<c2p> are set to
3380 * the one or two possible octets (which are characters in this situation)
3381 * that can match. In all cases, if there is only one character that can
3382 * match, *<c1p> and *<c2p> will be identical.
3384 * If the target string is in UTF-8, the buffers pointed to by <c1_utf8>
3385 * and <c2_utf8> will contain the one or two UTF-8 sequences of bytes that
3386 * can match the beginning of <text_node>. They should be declared with at
3387 * least length UTF8_MAXBYTES+1. (If the target string isn't in UTF-8, it is
3388 * undefined what these contain.) If one or both of the buffers are
3389 * invariant under UTF-8, *<c1p>, and *<c2p> will also be set to the
3390 * corresponding invariant. If variant, the corresponding *<c1p> and/or
3391 * *<c2p> will be set to a negative number(s) that shouldn't match any code
3392 * point (unless inappropriately coerced to unsigned). *<c1p> will equal
3393 * *<c2p> if and only if <c1_utf8> and <c2_utf8> are the same. */
3395 const bool utf8_target = reginfo->is_utf8_target;
3397 UV c1 = CHRTEST_NOT_A_CP_1;
3398 UV c2 = CHRTEST_NOT_A_CP_2;
3399 bool use_chrtest_void = FALSE;
3400 const bool is_utf8_pat = reginfo->is_utf8_pat;
3402 /* Used when we have both utf8 input and utf8 output, to avoid converting
3403 * to/from code points */
3404 bool utf8_has_been_setup = FALSE;
3408 U8 *pat = (U8*)STRING(text_node);
3410 if (OP(text_node) == EXACT) {
3412 /* In an exact node, only one thing can be matched, that first
3413 * character. If both the pat and the target are UTF-8, we can just
3414 * copy the input to the output, avoiding finding the code point of
3419 else if (utf8_target) {
3420 Copy(pat, c1_utf8, UTF8SKIP(pat), U8);
3421 Copy(pat, c2_utf8, UTF8SKIP(pat), U8);
3422 utf8_has_been_setup = TRUE;
3425 c2 = c1 = valid_utf8_to_uvchr(pat, NULL);
3428 else /* an EXACTFish node */
3430 && is_MULTI_CHAR_FOLD_utf8_safe(pat,
3431 pat + STR_LEN(text_node)))
3433 && is_MULTI_CHAR_FOLD_latin1_safe(pat,
3434 pat + STR_LEN(text_node))))
3436 /* Multi-character folds require more context to sort out. Also
3437 * PL_utf8_foldclosures used below doesn't handle them, so have to be
3438 * handled outside this routine */
3439 use_chrtest_void = TRUE;
3441 else { /* an EXACTFish node which doesn't begin with a multi-char fold */
3442 c1 = is_utf8_pat ? valid_utf8_to_uvchr(pat, NULL) : *pat;
3444 /* Load the folds hash, if not already done */
3446 if (! PL_utf8_foldclosures) {
3447 if (! PL_utf8_tofold) {
3448 U8 dummy[UTF8_MAXBYTES_CASE+1];
3450 /* Force loading this by folding an above-Latin1 char */
3451 to_utf8_fold((U8*) HYPHEN_UTF8, dummy, NULL);
3452 assert(PL_utf8_tofold); /* Verify that worked */
3454 PL_utf8_foldclosures = _swash_inversion_hash(PL_utf8_tofold);
3457 /* The fold closures data structure is a hash with the keys being
3458 * the UTF-8 of every character that is folded to, like 'k', and
3459 * the values each an array of all code points that fold to its
3460 * key. e.g. [ 'k', 'K', KELVIN_SIGN ]. Multi-character folds are
3462 if ((! (listp = hv_fetch(PL_utf8_foldclosures,
3467 /* Not found in the hash, therefore there are no folds
3468 * containing it, so there is only a single character that
3472 else { /* Does participate in folds */
3473 AV* list = (AV*) *listp;
3474 if (av_len(list) != 1) {
3476 /* If there aren't exactly two folds to this, it is outside
3477 * the scope of this function */
3478 use_chrtest_void = TRUE;
3480 else { /* There are two. Get them */
3481 SV** c_p = av_fetch(list, 0, FALSE);
3483 Perl_croak(aTHX_ "panic: invalid PL_utf8_foldclosures structure");
3487 c_p = av_fetch(list, 1, FALSE);
3489 Perl_croak(aTHX_ "panic: invalid PL_utf8_foldclosures structure");
3493 /* Folds that cross the 255/256 boundary are forbidden if
3494 * EXACTFL, or EXACTFA and one is ASCIII. Since the
3495 * pattern character is above 256, and its only other match
3496 * is below 256, the only legal match will be to itself.
3497 * We have thrown away the original, so have to compute
3498 * which is the one above 255 */
3499 if ((c1 < 256) != (c2 < 256)) {
3500 if (OP(text_node) == EXACTFL
3501 || ((OP(text_node) == EXACTFA
3502 || OP(text_node) == EXACTFA_NO_TRIE)
3503 && (isASCII(c1) || isASCII(c2))))
3516 else /* Here, c1 is < 255 */
3518 && HAS_NONLATIN1_FOLD_CLOSURE(c1)
3519 && OP(text_node) != EXACTFL
3520 && ((OP(text_node) != EXACTFA
3521 && OP(text_node) != EXACTFA_NO_TRIE)
3524 /* Here, there could be something above Latin1 in the target which
3525 * folds to this character in the pattern. All such cases except
3526 * LATIN SMALL LETTER Y WITH DIAERESIS have more than two characters
3527 * involved in their folds, so are outside the scope of this
3529 if (UNLIKELY(c1 == LATIN_SMALL_LETTER_Y_WITH_DIAERESIS)) {
3530 c2 = LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS;
3533 use_chrtest_void = TRUE;
3536 else { /* Here nothing above Latin1 can fold to the pattern character */
3537 switch (OP(text_node)) {
3539 case EXACTFL: /* /l rules */
3540 c2 = PL_fold_locale[c1];
3543 case EXACTF: /* This node only generated for non-utf8
3545 assert(! is_utf8_pat);
3546 if (! utf8_target) { /* /d rules */
3551 /* /u rules for all these. This happens to work for
3552 * EXACTFA as nothing in Latin1 folds to ASCII */
3553 case EXACTFA_NO_TRIE: /* This node only generated for
3554 non-utf8 patterns */
3555 assert(! is_utf8_pat);
3560 c2 = PL_fold_latin1[c1];
3564 Perl_croak(aTHX_ "panic: Unexpected op %u", OP(text_node));
3565 assert(0); /* NOTREACHED */
3570 /* Here have figured things out. Set up the returns */
3571 if (use_chrtest_void) {
3572 *c2p = *c1p = CHRTEST_VOID;
3574 else if (utf8_target) {
3575 if (! utf8_has_been_setup) { /* Don't have the utf8; must get it */
3576 uvchr_to_utf8(c1_utf8, c1);
3577 uvchr_to_utf8(c2_utf8, c2);
3580 /* Invariants are stored in both the utf8 and byte outputs; Use
3581 * negative numbers otherwise for the byte ones. Make sure that the
3582 * byte ones are the same iff the utf8 ones are the same */
3583 *c1p = (UTF8_IS_INVARIANT(*c1_utf8)) ? *c1_utf8 : CHRTEST_NOT_A_CP_1;
3584 *c2p = (UTF8_IS_INVARIANT(*c2_utf8))
3587 ? CHRTEST_NOT_A_CP_1
3588 : CHRTEST_NOT_A_CP_2;
3590 else if (c1 > 255) {
3591 if (c2 > 255) { /* both possibilities are above what a non-utf8 string
3596 *c1p = *c2p = c2; /* c2 is the only representable value */
3598 else { /* c1 is representable; see about c2 */
3600 *c2p = (c2 < 256) ? c2 : c1;
3606 /* returns -1 on failure, $+[0] on success */
3608 S_regmatch(pTHX_ regmatch_info *reginfo, char *startpos, regnode *prog)
3610 #if PERL_VERSION < 9 && !defined(PERL_CORE)
3614 const bool utf8_target = reginfo->is_utf8_target;
3615 const U32 uniflags = UTF8_ALLOW_DEFAULT;
3616 REGEXP *rex_sv = reginfo->prog;
3617 regexp *rex = ReANY(rex_sv);
3618 RXi_GET_DECL(rex,rexi);
3619 /* the current state. This is a cached copy of PL_regmatch_state */
3621 /* cache heavy used fields of st in registers */
3624 U32 n = 0; /* general value; init to avoid compiler warning */
3625 SSize_t ln = 0; /* len or last; init to avoid compiler warning */
3626 char *locinput = startpos;
3627 char *pushinput; /* where to continue after a PUSH */
3628 I32 nextchr; /* is always set to UCHARAT(locinput) */
3630 bool result = 0; /* return value of S_regmatch */
3631 int depth = 0; /* depth of backtrack stack */
3632 U32 nochange_depth = 0; /* depth of GOSUB recursion with nochange */
3633 const U32 max_nochange_depth =
3634 (3 * rex->nparens > MAX_RECURSE_EVAL_NOCHANGE_DEPTH) ?
3635 3 * rex->nparens : MAX_RECURSE_EVAL_NOCHANGE_DEPTH;
3636 regmatch_state *yes_state = NULL; /* state to pop to on success of
3638 /* mark_state piggy backs on the yes_state logic so that when we unwind
3639 the stack on success we can update the mark_state as we go */
3640 regmatch_state *mark_state = NULL; /* last mark state we have seen */
3641 regmatch_state *cur_eval = NULL; /* most recent EVAL_AB state */
3642 struct regmatch_state *cur_curlyx = NULL; /* most recent curlyx */
3644 bool no_final = 0; /* prevent failure from backtracking? */
3645 bool do_cutgroup = 0; /* no_final only until next branch/trie entry */
3646 char *startpoint = locinput;
3647 SV *popmark = NULL; /* are we looking for a mark? */
3648 SV *sv_commit = NULL; /* last mark name seen in failure */
3649 SV *sv_yes_mark = NULL; /* last mark name we have seen
3650 during a successful match */
3651 U32 lastopen = 0; /* last open we saw */
3652 bool has_cutgroup = RX_HAS_CUTGROUP(rex) ? 1 : 0;
3653 SV* const oreplsv = GvSV(PL_replgv);
3654 /* these three flags are set by various ops to signal information to
3655 * the very next op. They have a useful lifetime of exactly one loop
3656 * iteration, and are not preserved or restored by state pushes/pops
3658 bool sw = 0; /* the condition value in (?(cond)a|b) */
3659 bool minmod = 0; /* the next "{n,m}" is a "{n,m}?" */
3660 int logical = 0; /* the following EVAL is:
3664 or the following IFMATCH/UNLESSM is:
3665 false: plain (?=foo)
3666 true: used as a condition: (?(?=foo))
3668 PAD* last_pad = NULL;
3670 I32 gimme = G_SCALAR;
3671 CV *caller_cv = NULL; /* who called us */
3672 CV *last_pushed_cv = NULL; /* most recently called (?{}) CV */
3673 CHECKPOINT runops_cp; /* savestack position before executing EVAL */
3674 U32 maxopenparen = 0; /* max '(' index seen so far */
3675 int to_complement; /* Invert the result? */
3676 _char_class_number classnum;
3677 bool is_utf8_pat = reginfo->is_utf8_pat;
3680 GET_RE_DEBUG_FLAGS_DECL;
3683 /* shut up 'may be used uninitialized' compiler warnings for dMULTICALL */
3684 multicall_oldcatch = 0;
3685 multicall_cv = NULL;
3687 PERL_UNUSED_VAR(multicall_cop);
3688 PERL_UNUSED_VAR(newsp);
3691 PERL_ARGS_ASSERT_REGMATCH;
3693 DEBUG_OPTIMISE_r( DEBUG_EXECUTE_r({
3694 PerlIO_printf(Perl_debug_log,"regmatch start\n");
3697 st = PL_regmatch_state;
3699 /* Note that nextchr is a byte even in UTF */
3702 while (scan != NULL) {
3705 SV * const prop = sv_newmortal();
3706 regnode *rnext=regnext(scan);
3707 DUMP_EXEC_POS( locinput, scan, utf8_target );
3708 regprop(rex, prop, scan);
3710 PerlIO_printf(Perl_debug_log,
3711 "%3"IVdf":%*s%s(%"IVdf")\n",
3712 (IV)(scan - rexi->program), depth*2, "",
3714 (PL_regkind[OP(scan)] == END || !rnext) ?
3715 0 : (IV)(rnext - rexi->program));
3718 next = scan + NEXT_OFF(scan);
3721 state_num = OP(scan);
3727 assert(nextchr < 256 && (nextchr >= 0 || nextchr == NEXTCHR_EOS));
3729 switch (state_num) {
3730 case BOL: /* /^../ */
3731 if (locinput == reginfo->strbeg)
3735 case MBOL: /* /^../m */
3736 if (locinput == reginfo->strbeg ||
3737 (!NEXTCHR_IS_EOS && locinput[-1] == '\n'))
3743 case SBOL: /* /^../s */
3744 if (locinput == reginfo->strbeg)
3749 if (locinput == reginfo->ganch)
3753 case KEEPS: /* \K */
3754 /* update the startpoint */
3755 st->u.keeper.val = rex->offs[0].start;
3756 rex->offs[0].start = locinput - reginfo->strbeg;
3757 PUSH_STATE_GOTO(KEEPS_next, next, locinput);
3758 assert(0); /*NOTREACHED*/
3759 case KEEPS_next_fail:
3760 /* rollback the start point change */
3761 rex->offs[0].start = st->u.keeper.val;
3763 assert(0); /*NOTREACHED*/
3765 case EOL: /* /..$/ */
3768 case MEOL: /* /..$/m */
3769 if (!NEXTCHR_IS_EOS && nextchr != '\n')
3773 case SEOL: /* /..$/s */
3775 if (!NEXTCHR_IS_EOS && nextchr != '\n')
3777 if (reginfo->strend - locinput > 1)
3782 if (!NEXTCHR_IS_EOS)
3786 case SANY: /* /./s */
3789 goto increment_locinput;
3797 case REG_ANY: /* /./ */
3798 if ((NEXTCHR_IS_EOS) || nextchr == '\n')
3800 goto increment_locinput;
3804 #define ST st->u.trie
3805 case TRIEC: /* (ab|cd) with known charclass */
3806 /* In this case the charclass data is available inline so
3807 we can fail fast without a lot of extra overhead.
3809 if(!NEXTCHR_IS_EOS && !ANYOF_BITMAP_TEST(scan, nextchr)) {
3811 PerlIO_printf(Perl_debug_log,
3812 "%*s %sfailed to match trie start class...%s\n",
3813 REPORT_CODE_OFF+depth*2, "", PL_colors[4], PL_colors[5])
3816 assert(0); /* NOTREACHED */
3819 case TRIE: /* (ab|cd) */
3820 /* the basic plan of execution of the trie is:
3821 * At the beginning, run though all the states, and
3822 * find the longest-matching word. Also remember the position
3823 * of the shortest matching word. For example, this pattern:
3826 * when matched against the string "abcde", will generate
3827 * accept states for all words except 3, with the longest
3828 * matching word being 4, and the shortest being 2 (with
3829 * the position being after char 1 of the string).
3831 * Then for each matching word, in word order (i.e. 1,2,4,5),
3832 * we run the remainder of the pattern; on each try setting
3833 * the current position to the character following the word,
3834 * returning to try the next word on failure.
3836 * We avoid having to build a list of words at runtime by
3837 * using a compile-time structure, wordinfo[].prev, which
3838 * gives, for each word, the previous accepting word (if any).
3839 * In the case above it would contain the mappings 1->2, 2->0,
3840 * 3->0, 4->5, 5->1. We can use this table to generate, from
3841 * the longest word (4 above), a list of all words, by
3842 * following the list of prev pointers; this gives us the
3843 * unordered list 4,5,1,2. Then given the current word we have
3844 * just tried, we can go through the list and find the
3845 * next-biggest word to try (so if we just failed on word 2,
3846 * the next in the list is 4).
3848 * Since at runtime we don't record the matching position in
3849 * the string for each word, we have to work that out for
3850 * each word we're about to process. The wordinfo table holds
3851 * the character length of each word; given that we recorded
3852 * at the start: the position of the shortest word and its
3853 * length in chars, we just need to move the pointer the
3854 * difference between the two char lengths. Depending on
3855 * Unicode status and folding, that's cheap or expensive.
3857 * This algorithm is optimised for the case where are only a
3858 * small number of accept states, i.e. 0,1, or maybe 2.
3859 * With lots of accepts states, and having to try all of them,
3860 * it becomes quadratic on number of accept states to find all
3865 /* what type of TRIE am I? (utf8 makes this contextual) */
3866 DECL_TRIE_TYPE(scan);
3868 /* what trie are we using right now */
3869 reg_trie_data * const trie
3870 = (reg_trie_data*)rexi->data->data[ ARG( scan ) ];
3871 HV * widecharmap = MUTABLE_HV(rexi->data->data[ ARG( scan ) + 1 ]);
3872 U32 state = trie->startstate;
3875 && (NEXTCHR_IS_EOS || !TRIE_BITMAP_TEST(trie, nextchr)))
3877 if (trie->states[ state ].wordnum) {
3879 PerlIO_printf(Perl_debug_log,
3880 "%*s %smatched empty string...%s\n",
3881 REPORT_CODE_OFF+depth*2, "", PL_colors[4], PL_colors[5])
3887 PerlIO_printf(Perl_debug_log,
3888 "%*s %sfailed to match trie start class...%s\n",
3889 REPORT_CODE_OFF+depth*2, "", PL_colors[4], PL_colors[5])
3896 U8 *uc = ( U8* )locinput;
3900 U8 *uscan = (U8*)NULL;
3901 U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
3902 U32 charcount = 0; /* how many input chars we have matched */
3903 U32 accepted = 0; /* have we seen any accepting states? */
3905 ST.jump = trie->jump;
3908 ST.longfold = FALSE; /* char longer if folded => it's harder */
3911 /* fully traverse the TRIE; note the position of the
3912 shortest accept state and the wordnum of the longest
3915 while ( state && uc <= (U8*)(reginfo->strend) ) {
3916 U32 base = trie->states[ state ].trans.base;
3920 wordnum = trie->states[ state ].wordnum;
3922 if (wordnum) { /* it's an accept state */
3925 /* record first match position */
3927 ST.firstpos = (U8*)locinput;
3932 ST.firstchars = charcount;
3935 if (!ST.nextword || wordnum < ST.nextword)
3936 ST.nextword = wordnum;
3937 ST.topword = wordnum;
3940 DEBUG_TRIE_EXECUTE_r({
3941 DUMP_EXEC_POS( (char *)uc, scan, utf8_target );
3942 PerlIO_printf( Perl_debug_log,
3943 "%*s %sState: %4"UVxf" Accepted: %c ",