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 GREEK_SMALL_LETTER_IOTA_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 GREEK_SMALL_LETTER_IOTA_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)==EXACTFU_TRICKYFOLD || OP(rn)==EXACTFA || 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)==EXACTFU_TRICKYFOLD || OP(rn) == EXACTFA)
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 SSPUSHINT(rex->offs[p].end);
300 SSPUSHINT(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 = SSPOPINT;
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_UNI(*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, I32 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);
619 /* Should be nonnegative! */
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 I32 end = prog->check_offset_max + CHR_SVLEN(check)
727 - (SvTAIL(check) != 0);
728 const I32 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 I32 srch_start_shift = start_shift;
755 I32 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_type = ((scan->flags == EXACT) \
1232 ? (utf8_target ? trie_utf8 : trie_plain) \
1233 : (utf8_target ? trie_utf8_fold : trie_latin_utf8_fold))
1235 #define REXEC_TRIE_READ_CHAR(trie_type, trie, widecharmap, uc, uscan, len, uvc, charid, foldlen, foldbuf, uniflags) \
1238 switch (trie_type) { \
1239 case trie_utf8_fold: \
1240 if ( foldlen>0 ) { \
1241 uvc = utf8n_to_uvuni( (const U8*) uscan, UTF8_MAXLEN, &len, uniflags ); \
1246 uvc = to_utf8_fold( (const U8*) uc, foldbuf, &foldlen ); \
1247 len = UTF8SKIP(uc); \
1248 skiplen = UNISKIP( uvc ); \
1249 foldlen -= skiplen; \
1250 uscan = foldbuf + skiplen; \
1253 case trie_latin_utf8_fold: \
1254 if ( foldlen>0 ) { \
1255 uvc = utf8n_to_uvuni( (const U8*) uscan, UTF8_MAXLEN, &len, uniflags ); \
1261 uvc = _to_fold_latin1( (U8) *uc, foldbuf, &foldlen, FOLD_FLAGS_FULL); \
1262 skiplen = UNISKIP( uvc ); \
1263 foldlen -= skiplen; \
1264 uscan = foldbuf + skiplen; \
1268 uvc = utf8n_to_uvuni( (const U8*) uc, UTF8_MAXLEN, &len, uniflags ); \
1275 charid = trie->charmap[ uvc ]; \
1279 if (widecharmap) { \
1280 SV** const svpp = hv_fetch(widecharmap, \
1281 (char*)&uvc, sizeof(UV), 0); \
1283 charid = (U16)SvIV(*svpp); \
1288 #define REXEC_FBC_EXACTISH_SCAN(CoNd) \
1292 && (ln == 1 || folder(s, pat_string, ln)) \
1293 && (reginfo->intuit || regtry(reginfo, &s)) )\
1299 #define REXEC_FBC_UTF8_SCAN(CoDe) \
1301 while (s < strend) { \
1307 #define REXEC_FBC_SCAN(CoDe) \
1309 while (s < strend) { \
1315 #define REXEC_FBC_UTF8_CLASS_SCAN(CoNd) \
1316 REXEC_FBC_UTF8_SCAN( \
1318 if (tmp && (reginfo->intuit || regtry(reginfo, &s))) \
1327 #define REXEC_FBC_CLASS_SCAN(CoNd) \
1330 if (tmp && (reginfo->intuit || regtry(reginfo, &s))) \
1339 #define REXEC_FBC_TRYIT \
1340 if ((reginfo->intuit || regtry(reginfo, &s))) \
1343 #define REXEC_FBC_CSCAN(CoNdUtF8,CoNd) \
1344 if (utf8_target) { \
1345 REXEC_FBC_UTF8_CLASS_SCAN(CoNdUtF8); \
1348 REXEC_FBC_CLASS_SCAN(CoNd); \
1351 #define DUMP_EXEC_POS(li,s,doutf8) \
1352 dump_exec_pos(li,s,(reginfo->strend),(reginfo->strbeg), \
1356 #define UTF8_NOLOAD(TEST_NON_UTF8, IF_SUCCESS, IF_FAIL) \
1357 tmp = (s != reginfo->strbeg) ? UCHARAT(s - 1) : '\n'; \
1358 tmp = TEST_NON_UTF8(tmp); \
1359 REXEC_FBC_UTF8_SCAN( \
1360 if (tmp == ! TEST_NON_UTF8((U8) *s)) { \
1369 #define UTF8_LOAD(TeSt1_UtF8, TeSt2_UtF8, IF_SUCCESS, IF_FAIL) \
1370 if (s == reginfo->strbeg) { \
1374 U8 * const r = reghop3((U8*)s, -1, (U8*)reginfo->strbeg); \
1375 tmp = utf8n_to_uvchr(r, UTF8SKIP(r), 0, UTF8_ALLOW_DEFAULT); \
1378 LOAD_UTF8_CHARCLASS_ALNUM(); \
1379 REXEC_FBC_UTF8_SCAN( \
1380 if (tmp == ! (TeSt2_UtF8)) { \
1389 /* The only difference between the BOUND and NBOUND cases is that
1390 * REXEC_FBC_TRYIT is called when matched in BOUND, and when non-matched in
1391 * NBOUND. This is accomplished by passing it in either the if or else clause,
1392 * with the other one being empty */
1393 #define FBC_BOUND(TEST_NON_UTF8, TEST1_UTF8, TEST2_UTF8) \
1394 FBC_BOUND_COMMON(UTF8_LOAD(TEST1_UTF8, TEST2_UTF8, REXEC_FBC_TRYIT, PLACEHOLDER), TEST_NON_UTF8, REXEC_FBC_TRYIT, PLACEHOLDER)
1396 #define FBC_BOUND_NOLOAD(TEST_NON_UTF8, TEST1_UTF8, TEST2_UTF8) \
1397 FBC_BOUND_COMMON(UTF8_NOLOAD(TEST_NON_UTF8, REXEC_FBC_TRYIT, PLACEHOLDER), TEST_NON_UTF8, REXEC_FBC_TRYIT, PLACEHOLDER)
1399 #define FBC_NBOUND(TEST_NON_UTF8, TEST1_UTF8, TEST2_UTF8) \
1400 FBC_BOUND_COMMON(UTF8_LOAD(TEST1_UTF8, TEST2_UTF8, PLACEHOLDER, REXEC_FBC_TRYIT), TEST_NON_UTF8, PLACEHOLDER, REXEC_FBC_TRYIT)
1402 #define FBC_NBOUND_NOLOAD(TEST_NON_UTF8, TEST1_UTF8, TEST2_UTF8) \
1403 FBC_BOUND_COMMON(UTF8_NOLOAD(TEST_NON_UTF8, PLACEHOLDER, REXEC_FBC_TRYIT), TEST_NON_UTF8, PLACEHOLDER, REXEC_FBC_TRYIT)
1406 /* Common to the BOUND and NBOUND cases. Unfortunately the UTF8 tests need to
1407 * be passed in completely with the variable name being tested, which isn't
1408 * such a clean interface, but this is easier to read than it was before. We
1409 * are looking for the boundary (or non-boundary between a word and non-word
1410 * character. The utf8 and non-utf8 cases have the same logic, but the details
1411 * must be different. Find the "wordness" of the character just prior to this
1412 * one, and compare it with the wordness of this one. If they differ, we have
1413 * a boundary. At the beginning of the string, pretend that the previous
1414 * character was a new-line */
1415 #define FBC_BOUND_COMMON(UTF8_CODE, TEST_NON_UTF8, IF_SUCCESS, IF_FAIL) \
1416 if (utf8_target) { \
1419 else { /* Not utf8 */ \
1420 tmp = (s != reginfo->strbeg) ? UCHARAT(s - 1) : '\n'; \
1421 tmp = TEST_NON_UTF8(tmp); \
1423 if (tmp == ! TEST_NON_UTF8((U8) *s)) { \
1432 if ((!prog->minlen && tmp) && (reginfo->intuit || regtry(reginfo, &s))) \
1435 /* We know what class REx starts with. Try to find this position... */
1436 /* if reginfo->intuit, its a dryrun */
1437 /* annoyingly all the vars in this routine have different names from their counterparts
1438 in regmatch. /grrr */
1441 S_find_byclass(pTHX_ regexp * prog, const regnode *c, char *s,
1442 const char *strend, regmatch_info *reginfo)
1445 const I32 doevery = (prog->intflags & PREGf_SKIP) == 0;
1446 char *pat_string; /* The pattern's exactish string */
1447 char *pat_end; /* ptr to end char of pat_string */
1448 re_fold_t folder; /* Function for computing non-utf8 folds */
1449 const U8 *fold_array; /* array for folding ords < 256 */
1455 I32 tmp = 1; /* Scratch variable? */
1456 const bool utf8_target = reginfo->is_utf8_target;
1457 UV utf8_fold_flags = 0;
1458 const bool is_utf8_pat = reginfo->is_utf8_pat;
1459 bool to_complement = FALSE; /* Invert the result? Taking the xor of this
1460 with a result inverts that result, as 0^1 =
1462 _char_class_number classnum;
1464 RXi_GET_DECL(prog,progi);
1466 PERL_ARGS_ASSERT_FIND_BYCLASS;
1468 /* We know what class it must start with. */
1471 case ANYOF_SYNTHETIC:
1472 case ANYOF_WARN_SUPER:
1474 REXEC_FBC_UTF8_CLASS_SCAN(
1475 reginclass(prog, c, (U8*)s, utf8_target));
1478 REXEC_FBC_CLASS_SCAN(REGINCLASS(prog, c, (U8*)s));
1483 if (tmp && (reginfo->intuit || regtry(reginfo, &s)))
1491 if (is_utf8_pat || utf8_target) {
1492 utf8_fold_flags = FOLDEQ_UTF8_NOMIX_ASCII;
1493 goto do_exactf_utf8;
1495 fold_array = PL_fold_latin1; /* Latin1 folds are not affected by */
1496 folder = foldEQ_latin1; /* /a, except the sharp s one which */
1497 goto do_exactf_non_utf8; /* isn't dealt with by these */
1502 /* regcomp.c already folded this if pattern is in UTF-8 */
1503 utf8_fold_flags = 0;
1504 goto do_exactf_utf8;
1506 fold_array = PL_fold;
1508 goto do_exactf_non_utf8;
1511 if (is_utf8_pat || utf8_target) {
1512 utf8_fold_flags = FOLDEQ_UTF8_LOCALE;
1513 goto do_exactf_utf8;
1515 fold_array = PL_fold_locale;
1516 folder = foldEQ_locale;
1517 goto do_exactf_non_utf8;
1521 utf8_fold_flags = FOLDEQ_S2_ALREADY_FOLDED;
1523 goto do_exactf_utf8;
1525 case EXACTFU_TRICKYFOLD:
1527 if (is_utf8_pat || utf8_target) {
1528 utf8_fold_flags = is_utf8_pat ? FOLDEQ_S2_ALREADY_FOLDED : 0;
1529 goto do_exactf_utf8;
1532 /* Any 'ss' in the pattern should have been replaced by regcomp,
1533 * so we don't have to worry here about this single special case
1534 * in the Latin1 range */
1535 fold_array = PL_fold_latin1;
1536 folder = foldEQ_latin1;
1540 do_exactf_non_utf8: /* Neither pattern nor string are UTF8, and there
1541 are no glitches with fold-length differences
1542 between the target string and pattern */
1544 /* The idea in the non-utf8 EXACTF* cases is to first find the
1545 * first character of the EXACTF* node and then, if necessary,
1546 * case-insensitively compare the full text of the node. c1 is the
1547 * first character. c2 is its fold. This logic will not work for
1548 * Unicode semantics and the german sharp ss, which hence should
1549 * not be compiled into a node that gets here. */
1550 pat_string = STRING(c);
1551 ln = STR_LEN(c); /* length to match in octets/bytes */
1553 /* We know that we have to match at least 'ln' bytes (which is the
1554 * same as characters, since not utf8). If we have to match 3
1555 * characters, and there are only 2 availabe, we know without
1556 * trying that it will fail; so don't start a match past the
1557 * required minimum number from the far end */
1558 e = HOP3c(strend, -((I32)ln), s);
1560 if (reginfo->intuit && e < s) {
1561 e = s; /* Due to minlen logic of intuit() */
1565 c2 = fold_array[c1];
1566 if (c1 == c2) { /* If char and fold are the same */
1567 REXEC_FBC_EXACTISH_SCAN(*(U8*)s == c1);
1570 REXEC_FBC_EXACTISH_SCAN(*(U8*)s == c1 || *(U8*)s == c2);
1578 /* If one of the operands is in utf8, we can't use the simpler folding
1579 * above, due to the fact that many different characters can have the
1580 * same fold, or portion of a fold, or different- length fold */
1581 pat_string = STRING(c);
1582 ln = STR_LEN(c); /* length to match in octets/bytes */
1583 pat_end = pat_string + ln;
1584 lnc = is_utf8_pat /* length to match in characters */
1585 ? utf8_length((U8 *) pat_string, (U8 *) pat_end)
1588 /* We have 'lnc' characters to match in the pattern, but because of
1589 * multi-character folding, each character in the target can match
1590 * up to 3 characters (Unicode guarantees it will never exceed
1591 * this) if it is utf8-encoded; and up to 2 if not (based on the
1592 * fact that the Latin 1 folds are already determined, and the
1593 * only multi-char fold in that range is the sharp-s folding to
1594 * 'ss'. Thus, a pattern character can match as little as 1/3 of a
1595 * string character. Adjust lnc accordingly, rounding up, so that
1596 * if we need to match at least 4+1/3 chars, that really is 5. */
1597 expansion = (utf8_target) ? UTF8_MAX_FOLD_CHAR_EXPAND : 2;
1598 lnc = (lnc + expansion - 1) / expansion;
1600 /* As in the non-UTF8 case, if we have to match 3 characters, and
1601 * only 2 are left, it's guaranteed to fail, so don't start a
1602 * match that would require us to go beyond the end of the string
1604 e = HOP3c(strend, -((I32)lnc), s);
1606 if (reginfo->intuit && e < s) {
1607 e = s; /* Due to minlen logic of intuit() */
1610 /* XXX Note that we could recalculate e to stop the loop earlier,
1611 * as the worst case expansion above will rarely be met, and as we
1612 * go along we would usually find that e moves further to the left.
1613 * This would happen only after we reached the point in the loop
1614 * where if there were no expansion we should fail. Unclear if
1615 * worth the expense */
1618 char *my_strend= (char *)strend;
1619 if (foldEQ_utf8_flags(s, &my_strend, 0, utf8_target,
1620 pat_string, NULL, ln, is_utf8_pat, utf8_fold_flags)
1621 && (reginfo->intuit || regtry(reginfo, &s)) )
1625 s += (utf8_target) ? UTF8SKIP(s) : 1;
1630 RXp_MATCH_TAINTED_on(prog);
1631 FBC_BOUND(isWORDCHAR_LC,
1632 isWORDCHAR_LC_uvchr(UNI_TO_NATIVE(tmp)),
1633 isWORDCHAR_LC_utf8((U8*)s));
1636 RXp_MATCH_TAINTED_on(prog);
1637 FBC_NBOUND(isWORDCHAR_LC,
1638 isWORDCHAR_LC_uvchr(UNI_TO_NATIVE(tmp)),
1639 isWORDCHAR_LC_utf8((U8*)s));
1642 FBC_BOUND(isWORDCHAR,
1643 isWORDCHAR_uni(tmp),
1644 cBOOL(swash_fetch(PL_utf8_swash_ptrs[_CC_WORDCHAR], (U8*)s, utf8_target)));
1647 FBC_BOUND_NOLOAD(isWORDCHAR_A,
1649 isWORDCHAR_A((U8*)s));
1652 FBC_NBOUND(isWORDCHAR,
1653 isWORDCHAR_uni(tmp),
1654 cBOOL(swash_fetch(PL_utf8_swash_ptrs[_CC_WORDCHAR], (U8*)s, utf8_target)));
1657 FBC_NBOUND_NOLOAD(isWORDCHAR_A,
1659 isWORDCHAR_A((U8*)s));
1662 FBC_BOUND(isWORDCHAR_L1,
1663 isWORDCHAR_uni(tmp),
1664 cBOOL(swash_fetch(PL_utf8_swash_ptrs[_CC_WORDCHAR], (U8*)s, utf8_target)));
1667 FBC_NBOUND(isWORDCHAR_L1,
1668 isWORDCHAR_uni(tmp),
1669 cBOOL(swash_fetch(PL_utf8_swash_ptrs[_CC_WORDCHAR], (U8*)s, utf8_target)));
1672 REXEC_FBC_CSCAN(is_LNBREAK_utf8_safe(s, strend),
1673 is_LNBREAK_latin1_safe(s, strend)
1677 /* The argument to all the POSIX node types is the class number to pass to
1678 * _generic_isCC() to build a mask for searching in PL_charclass[] */
1685 RXp_MATCH_TAINTED_on(prog);
1686 REXEC_FBC_CSCAN(to_complement ^ cBOOL(isFOO_utf8_lc(FLAGS(c), (U8 *) s)),
1687 to_complement ^ cBOOL(isFOO_lc(FLAGS(c), *s)));
1702 /* The complement of something that matches only ASCII matches all
1703 * UTF-8 variant code points, plus everything in ASCII that isn't
1705 REXEC_FBC_UTF8_CLASS_SCAN(! UTF8_IS_INVARIANT(*s)
1706 || ! _generic_isCC_A(*s, FLAGS(c)));
1715 /* Don't need to worry about utf8, as it can match only a single
1716 * byte invariant character. */
1717 REXEC_FBC_CLASS_SCAN(
1718 to_complement ^ cBOOL(_generic_isCC_A(*s, FLAGS(c))));
1726 if (! utf8_target) {
1727 REXEC_FBC_CLASS_SCAN(to_complement ^ cBOOL(_generic_isCC(*s,
1733 classnum = (_char_class_number) FLAGS(c);
1734 if (classnum < _FIRST_NON_SWASH_CC) {
1735 while (s < strend) {
1737 /* We avoid loading in the swash as long as possible, but
1738 * should we have to, we jump to a separate loop. This
1739 * extra 'if' statement is what keeps this code from being
1740 * just a call to REXEC_FBC_UTF8_CLASS_SCAN() */
1741 if (UTF8_IS_ABOVE_LATIN1(*s)) {
1742 goto found_above_latin1;
1744 if ((UTF8_IS_INVARIANT(*s)
1745 && to_complement ^ cBOOL(_generic_isCC((U8) *s,
1747 || (UTF8_IS_DOWNGRADEABLE_START(*s)
1748 && to_complement ^ cBOOL(
1749 _generic_isCC(TWO_BYTE_UTF8_TO_UNI(*s, *(s + 1)),
1752 if (tmp && (reginfo->intuit || regtry(reginfo, &s)))
1764 else switch (classnum) { /* These classes are implemented as
1766 case _CC_ENUM_SPACE: /* XXX would require separate code if we
1767 revert the change of \v matching this */
1770 case _CC_ENUM_PSXSPC:
1771 REXEC_FBC_UTF8_CLASS_SCAN(
1772 to_complement ^ cBOOL(isSPACE_utf8(s)));
1775 case _CC_ENUM_BLANK:
1776 REXEC_FBC_UTF8_CLASS_SCAN(
1777 to_complement ^ cBOOL(isBLANK_utf8(s)));
1780 case _CC_ENUM_XDIGIT:
1781 REXEC_FBC_UTF8_CLASS_SCAN(
1782 to_complement ^ cBOOL(isXDIGIT_utf8(s)));
1785 case _CC_ENUM_VERTSPACE:
1786 REXEC_FBC_UTF8_CLASS_SCAN(
1787 to_complement ^ cBOOL(isVERTWS_utf8(s)));
1790 case _CC_ENUM_CNTRL:
1791 REXEC_FBC_UTF8_CLASS_SCAN(
1792 to_complement ^ cBOOL(isCNTRL_utf8(s)));
1796 Perl_croak(aTHX_ "panic: find_byclass() node %d='%s' has an unexpected character class '%d'", OP(c), PL_reg_name[OP(c)], classnum);
1797 assert(0); /* NOTREACHED */
1802 found_above_latin1: /* Here we have to load a swash to get the result
1803 for the current code point */
1804 if (! PL_utf8_swash_ptrs[classnum]) {
1805 U8 flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;
1806 PL_utf8_swash_ptrs[classnum] =
1807 _core_swash_init("utf8", swash_property_names[classnum],
1808 &PL_sv_undef, 1, 0, NULL, &flags);
1811 /* This is a copy of the loop above for swash classes, though using the
1812 * FBC macro instead of being expanded out. Since we've loaded the
1813 * swash, we don't have to check for that each time through the loop */
1814 REXEC_FBC_UTF8_CLASS_SCAN(
1815 to_complement ^ cBOOL(_generic_utf8(
1818 swash_fetch(PL_utf8_swash_ptrs[classnum],
1826 /* what trie are we using right now */
1827 reg_ac_data *aho = (reg_ac_data*)progi->data->data[ ARG( c ) ];
1828 reg_trie_data *trie = (reg_trie_data*)progi->data->data[ aho->trie ];
1829 HV *widecharmap = MUTABLE_HV(progi->data->data[ aho->trie + 1 ]);
1831 const char *last_start = strend - trie->minlen;
1833 const char *real_start = s;
1835 STRLEN maxlen = trie->maxlen;
1837 U8 **points; /* map of where we were in the input string
1838 when reading a given char. For ASCII this
1839 is unnecessary overhead as the relationship
1840 is always 1:1, but for Unicode, especially
1841 case folded Unicode this is not true. */
1842 U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
1846 GET_RE_DEBUG_FLAGS_DECL;
1848 /* We can't just allocate points here. We need to wrap it in
1849 * an SV so it gets freed properly if there is a croak while
1850 * running the match */
1853 sv_points=newSV(maxlen * sizeof(U8 *));
1854 SvCUR_set(sv_points,
1855 maxlen * sizeof(U8 *));
1856 SvPOK_on(sv_points);
1857 sv_2mortal(sv_points);
1858 points=(U8**)SvPV_nolen(sv_points );
1859 if ( trie_type != trie_utf8_fold
1860 && (trie->bitmap || OP(c)==AHOCORASICKC) )
1863 bitmap=(U8*)trie->bitmap;
1865 bitmap=(U8*)ANYOF_BITMAP(c);
1867 /* this is the Aho-Corasick algorithm modified a touch
1868 to include special handling for long "unknown char" sequences.
1869 The basic idea being that we use AC as long as we are dealing
1870 with a possible matching char, when we encounter an unknown char
1871 (and we have not encountered an accepting state) we scan forward
1872 until we find a legal starting char.
1873 AC matching is basically that of trie matching, except that when
1874 we encounter a failing transition, we fall back to the current
1875 states "fail state", and try the current char again, a process
1876 we repeat until we reach the root state, state 1, or a legal
1877 transition. If we fail on the root state then we can either
1878 terminate if we have reached an accepting state previously, or
1879 restart the entire process from the beginning if we have not.
1882 while (s <= last_start) {
1883 const U32 uniflags = UTF8_ALLOW_DEFAULT;
1891 U8 *uscan = (U8*)NULL;
1892 U8 *leftmost = NULL;
1894 U32 accepted_word= 0;
1898 while ( state && uc <= (U8*)strend ) {
1900 U32 word = aho->states[ state ].wordnum;
1904 DEBUG_TRIE_EXECUTE_r(
1905 if ( uc <= (U8*)last_start && !BITMAP_TEST(bitmap,*uc) ) {
1906 dump_exec_pos( (char *)uc, c, strend, real_start,
1907 (char *)uc, utf8_target );
1908 PerlIO_printf( Perl_debug_log,
1909 " Scanning for legal start char...\n");
1913 while ( uc <= (U8*)last_start && !BITMAP_TEST(bitmap,*uc) ) {
1917 while ( uc <= (U8*)last_start && !BITMAP_TEST(bitmap,*uc) ) {
1923 if (uc >(U8*)last_start) break;
1927 U8 *lpos= points[ (pointpos - trie->wordinfo[word].len) % maxlen ];
1928 if (!leftmost || lpos < leftmost) {
1929 DEBUG_r(accepted_word=word);
1935 points[pointpos++ % maxlen]= uc;
1936 if (foldlen || uc < (U8*)strend) {
1937 REXEC_TRIE_READ_CHAR(trie_type, trie,
1939 uscan, len, uvc, charid, foldlen,
1941 DEBUG_TRIE_EXECUTE_r({
1942 dump_exec_pos( (char *)uc, c, strend,
1943 real_start, s, utf8_target);
1944 PerlIO_printf(Perl_debug_log,
1945 " Charid:%3u CP:%4"UVxf" ",
1957 word = aho->states[ state ].wordnum;
1959 base = aho->states[ state ].trans.base;
1961 DEBUG_TRIE_EXECUTE_r({
1963 dump_exec_pos( (char *)uc, c, strend, real_start,
1965 PerlIO_printf( Perl_debug_log,
1966 "%sState: %4"UVxf", word=%"UVxf,
1967 failed ? " Fail transition to " : "",
1968 (UV)state, (UV)word);
1974 ( ((offset = base + charid
1975 - 1 - trie->uniquecharcount)) >= 0)
1976 && ((U32)offset < trie->lasttrans)
1977 && trie->trans[offset].check == state
1978 && (tmp=trie->trans[offset].next))
1980 DEBUG_TRIE_EXECUTE_r(
1981 PerlIO_printf( Perl_debug_log," - legal\n"));
1986 DEBUG_TRIE_EXECUTE_r(
1987 PerlIO_printf( Perl_debug_log," - fail\n"));
1989 state = aho->fail[state];
1993 /* we must be accepting here */
1994 DEBUG_TRIE_EXECUTE_r(
1995 PerlIO_printf( Perl_debug_log," - accepting\n"));
2004 if (!state) state = 1;
2007 if ( aho->states[ state ].wordnum ) {
2008 U8 *lpos = points[ (pointpos - trie->wordinfo[aho->states[ state ].wordnum].len) % maxlen ];
2009 if (!leftmost || lpos < leftmost) {
2010 DEBUG_r(accepted_word=aho->states[ state ].wordnum);
2015 s = (char*)leftmost;
2016 DEBUG_TRIE_EXECUTE_r({
2018 Perl_debug_log,"Matches word #%"UVxf" at position %"IVdf". Trying full pattern...\n",
2019 (UV)accepted_word, (IV)(s - real_start)
2022 if (reginfo->intuit || regtry(reginfo, &s)) {
2028 DEBUG_TRIE_EXECUTE_r({
2029 PerlIO_printf( Perl_debug_log,"Pattern failed. Looking for new start point...\n");
2032 DEBUG_TRIE_EXECUTE_r(
2033 PerlIO_printf( Perl_debug_log,"No match.\n"));
2042 Perl_croak(aTHX_ "panic: unknown regstclass %d", (int)OP(c));
2050 /* set RX_SAVED_COPY, RX_SUBBEG etc.
2051 * flags have same meanings as with regexec_flags() */
2054 S_reg_set_capture_string(pTHX_ REGEXP * const rx,
2061 struct regexp *const prog = ReANY(rx);
2063 if (flags & REXEC_COPY_STR) {
2067 PerlIO_printf(Perl_debug_log,
2068 "Copy on write: regexp capture, type %d\n",
2071 /* skip creating new COW SV if a valid one already exists */
2072 if (! ( prog->saved_copy
2075 && SvIsCOW(prog->saved_copy)
2076 && SvPOKp(prog->saved_copy)
2077 && SvPVX(sv) == SvPVX(prog->saved_copy)))
2079 RX_MATCH_COPY_FREE(rx);
2080 prog->saved_copy = sv_setsv_cow(prog->saved_copy, sv);
2081 prog->subbeg = (char *)SvPVX_const(prog->saved_copy);
2082 assert (SvPOKp(prog->saved_copy));
2084 prog->sublen = strend - strbeg;
2085 prog->suboffset = 0;
2086 prog->subcoffset = 0;
2091 I32 max = strend - strbeg;
2094 if ( (flags & REXEC_COPY_SKIP_POST)
2095 && !(RX_EXTFLAGS(rx) & RXf_PMf_KEEPCOPY) /* //p */
2096 && !(PL_sawampersand & SAWAMPERSAND_RIGHT)
2097 ) { /* don't copy $' part of string */
2100 /* calculate the right-most part of the string covered
2101 * by a capture. Due to look-ahead, this may be to
2102 * the right of $&, so we have to scan all captures */
2103 while (n <= prog->lastparen) {
2104 if (prog->offs[n].end > max)
2105 max = prog->offs[n].end;
2109 max = (PL_sawampersand & SAWAMPERSAND_LEFT)
2110 ? prog->offs[0].start
2112 assert(max >= 0 && max <= strend - strbeg);
2115 if ( (flags & REXEC_COPY_SKIP_PRE)
2116 && !(RX_EXTFLAGS(rx) & RXf_PMf_KEEPCOPY) /* //p */
2117 && !(PL_sawampersand & SAWAMPERSAND_LEFT)
2118 ) { /* don't copy $` part of string */
2121 /* calculate the left-most part of the string covered
2122 * by a capture. Due to look-behind, this may be to
2123 * the left of $&, so we have to scan all captures */
2124 while (min && n <= prog->lastparen) {
2125 if ( prog->offs[n].start != -1
2126 && prog->offs[n].start < min)
2128 min = prog->offs[n].start;
2132 if ((PL_sawampersand & SAWAMPERSAND_RIGHT)
2133 && min > prog->offs[0].end
2135 min = prog->offs[0].end;
2139 assert(min >= 0 && min <= max && min <= strend - strbeg);
2142 if (RX_MATCH_COPIED(rx)) {
2143 if (sublen > prog->sublen)
2145 (char*)saferealloc(prog->subbeg, sublen+1);
2148 prog->subbeg = (char*)safemalloc(sublen+1);
2149 Copy(strbeg + min, prog->subbeg, sublen, char);
2150 prog->subbeg[sublen] = '\0';
2151 prog->suboffset = min;
2152 prog->sublen = sublen;
2153 RX_MATCH_COPIED_on(rx);
2155 prog->subcoffset = prog->suboffset;
2156 if (prog->suboffset && utf8_target) {
2157 /* Convert byte offset to chars.
2158 * XXX ideally should only compute this if @-/@+
2159 * has been seen, a la PL_sawampersand ??? */
2161 /* If there's a direct correspondence between the
2162 * string which we're matching and the original SV,
2163 * then we can use the utf8 len cache associated with
2164 * the SV. In particular, it means that under //g,
2165 * sv_pos_b2u() will use the previously cached
2166 * position to speed up working out the new length of
2167 * subcoffset, rather than counting from the start of
2168 * the string each time. This stops
2169 * $x = "\x{100}" x 1E6; 1 while $x =~ /(.)/g;
2170 * from going quadratic */
2171 if (SvPOKp(sv) && SvPVX(sv) == strbeg)
2172 sv_pos_b2u(sv, &(prog->subcoffset));
2174 prog->subcoffset = utf8_length((U8*)strbeg,
2175 (U8*)(strbeg+prog->suboffset));
2179 RX_MATCH_COPY_FREE(rx);
2180 prog->subbeg = strbeg;
2181 prog->suboffset = 0;
2182 prog->subcoffset = 0;
2183 prog->sublen = strend - strbeg;
2191 - regexec_flags - match a regexp against a string
2194 Perl_regexec_flags(pTHX_ REGEXP * const rx, char *stringarg, char *strend,
2195 char *strbeg, I32 minend, SV *sv, void *data, U32 flags)
2196 /* stringarg: the point in the string at which to begin matching */
2197 /* strend: pointer to null at end of string */
2198 /* strbeg: real beginning of string */
2199 /* minend: end of match must be >= minend bytes after stringarg. */
2200 /* sv: SV being matched: only used for utf8 flag, pos() etc; string
2201 * itself is accessed via the pointers above */
2202 /* data: May be used for some additional optimizations.
2203 Currently unused. */
2204 /* nosave: For optimizations. */
2208 struct regexp *const prog = ReANY(rx);
2212 I32 minlen; /* must match at least this many chars */
2213 I32 dontbother = 0; /* how many characters not to try at end */
2214 I32 end_shift = 0; /* Same for the end. */ /* CC */
2215 const bool utf8_target = cBOOL(DO_UTF8(sv));
2217 RXi_GET_DECL(prog,progi);
2218 regmatch_info reginfo_buf; /* create some info to pass to regtry etc */
2219 regmatch_info *const reginfo = ®info_buf;
2220 regexp_paren_pair *swap = NULL;
2222 GET_RE_DEBUG_FLAGS_DECL;
2224 PERL_ARGS_ASSERT_REGEXEC_FLAGS;
2225 PERL_UNUSED_ARG(data);
2227 /* Be paranoid... */
2228 if (prog == NULL || stringarg == NULL) {
2229 Perl_croak(aTHX_ "NULL regexp parameter");
2234 debug_start_match(rx, utf8_target, stringarg, strend,
2238 startpos = stringarg;
2240 if (prog->extflags & RXf_GPOS_SEEN) {
2243 /* in the presence of \G, we may need to start looking earlier in
2244 * the string than the suggested start point of stringarg:
2245 * if gofs->prog is set, then that's a known, fixed minimum
2248 * /ab|c\G/: gofs = 1
2249 * or if the minimum offset isn't known, then we have to go back
2250 * to the start of the string, e.g. /w+\G/
2253 if (startpos - prog->gofs < strbeg)
2256 startpos -= prog->gofs;
2258 else if (prog->extflags & RXf_GPOS_FLOAT)
2261 /* set reginfo->ganch, the position where \G can match */
2264 (flags & REXEC_IGNOREPOS)
2265 ? stringarg /* use start pos rather than pos() */
2266 : (sv && (mg = mg_find_mglob(sv)) && mg->mg_len >= 0)
2267 ? strbeg + mg->mg_len /* Defined pos() */
2268 : strbeg; /* pos() not defined; use start of string */
2270 DEBUG_GPOS_r(PerlIO_printf(Perl_debug_log,
2271 "GPOS ganch set to strbeg[%"IVdf"]\n", reginfo->ganch - strbeg));
2274 minlen = prog->minlen;
2275 if ((startpos + minlen) > strend || startpos < strbeg) {
2276 DEBUG_r(PerlIO_printf(Perl_debug_log,
2277 "Regex match can't succeed, so not even tried\n"));
2283 if ((RX_EXTFLAGS(rx) & RXf_USE_INTUIT)
2284 && !(flags & REXEC_CHECKED))
2286 s = re_intuit_start(rx, sv, strbeg, startpos, strend,
2291 if (RX_EXTFLAGS(rx) & RXf_CHECK_ALL) {
2292 /* we can match based purely on the result of INTUIT.
2293 * Set up captures etc just for $& and $-[0]
2294 * (an intuit-only match wont have $1,$2,..) */
2295 assert(!prog->nparens);
2297 /* s/// doesn't like it if $& is earlier than where we asked it to
2298 * start searching (which can happen on something like /.\G/) */
2299 if ( (flags & REXEC_FAIL_ON_UNDERFLOW)
2302 /* this should only be possible under \G */
2303 assert(prog->extflags & RXf_GPOS_SEEN);
2304 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
2305 "matched, but failing for REXEC_FAIL_ON_UNDERFLOW\n"));
2309 /* match via INTUIT shouldn't have any captures.
2310 * Let @-, @+, $^N know */
2311 prog->lastparen = prog->lastcloseparen = 0;
2312 RX_MATCH_UTF8_set(rx, utf8_target);
2313 if ( !(flags & REXEC_NOT_FIRST) )
2314 S_reg_set_capture_string(aTHX_ rx,
2316 sv, flags, utf8_target);
2318 prog->offs[0].start = s - strbeg;
2319 prog->offs[0].end = utf8_target
2320 ? (char*)utf8_hop((U8*)s, prog->minlenret) - strbeg
2321 : s - strbeg + prog->minlenret;
2327 /* at the end of this function, we'll do a LEAVE_SCOPE(oldsave),
2328 * which will call destuctors to reset PL_regmatch_state, free higher
2329 * PL_regmatch_slabs, and clean up regmatch_info_aux and
2330 * regmatch_info_aux_eval */
2332 oldsave = PL_savestack_ix;
2334 multiline = prog->extflags & RXf_PMf_MULTILINE;
2336 if (strend - s < (minlen+(prog->check_offset_min<0?prog->check_offset_min:0))) {
2337 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
2338 "String too short [regexec_flags]...\n"));
2342 /* Check validity of program. */
2343 if (UCHARAT(progi->program) != REG_MAGIC) {
2344 Perl_croak(aTHX_ "corrupted regexp program");
2347 RX_MATCH_TAINTED_off(rx);
2349 reginfo->prog = rx; /* Yes, sorry that this is confusing. */
2350 reginfo->intuit = 0;
2351 reginfo->is_utf8_target = cBOOL(utf8_target);
2352 reginfo->is_utf8_pat = cBOOL(RX_UTF8(rx));
2353 reginfo->warned = FALSE;
2354 reginfo->strbeg = strbeg;
2356 reginfo->poscache_maxiter = 0; /* not yet started a countdown */
2357 reginfo->strend = strend;
2358 /* see how far we have to get to not match where we matched before */
2359 reginfo->till = stringarg + minend;
2361 if (prog->extflags & RXf_EVAL_SEEN && SvPADTMP(sv) && !IS_PADGV(sv)) {
2362 /* SAVEFREESV, not sv_mortalcopy, as this SV must last until after
2363 S_cleanup_regmatch_info_aux has executed (registered by
2364 SAVEDESTRUCTOR_X below). S_cleanup_regmatch_info_aux modifies
2365 magic belonging to this SV.
2366 Not newSVsv, either, as it does not COW.
2368 reginfo->sv = newSV(0);
2369 sv_setsv(reginfo->sv, sv);
2370 SAVEFREESV(reginfo->sv);
2373 /* reserve next 2 or 3 slots in PL_regmatch_state:
2374 * slot N+0: may currently be in use: skip it
2375 * slot N+1: use for regmatch_info_aux struct
2376 * slot N+2: use for regmatch_info_aux_eval struct if we have (?{})'s
2377 * slot N+3: ready for use by regmatch()
2381 regmatch_state *old_regmatch_state;
2382 regmatch_slab *old_regmatch_slab;
2383 int i, max = (prog->extflags & RXf_EVAL_SEEN) ? 2 : 1;
2385 /* on first ever match, allocate first slab */
2386 if (!PL_regmatch_slab) {
2387 Newx(PL_regmatch_slab, 1, regmatch_slab);
2388 PL_regmatch_slab->prev = NULL;
2389 PL_regmatch_slab->next = NULL;
2390 PL_regmatch_state = SLAB_FIRST(PL_regmatch_slab);
2393 old_regmatch_state = PL_regmatch_state;
2394 old_regmatch_slab = PL_regmatch_slab;
2396 for (i=0; i <= max; i++) {
2398 reginfo->info_aux = &(PL_regmatch_state->u.info_aux);
2400 reginfo->info_aux_eval =
2401 reginfo->info_aux->info_aux_eval =
2402 &(PL_regmatch_state->u.info_aux_eval);
2404 if (++PL_regmatch_state > SLAB_LAST(PL_regmatch_slab))
2405 PL_regmatch_state = S_push_slab(aTHX);
2408 /* note initial PL_regmatch_state position; at end of match we'll
2409 * pop back to there and free any higher slabs */
2411 reginfo->info_aux->old_regmatch_state = old_regmatch_state;
2412 reginfo->info_aux->old_regmatch_slab = old_regmatch_slab;
2413 reginfo->info_aux->poscache = NULL;
2415 SAVEDESTRUCTOR_X(S_cleanup_regmatch_info_aux, reginfo->info_aux);
2417 if ((prog->extflags & RXf_EVAL_SEEN))
2418 S_setup_eval_state(aTHX_ reginfo);
2420 reginfo->info_aux_eval = reginfo->info_aux->info_aux_eval = NULL;
2423 /* If there is a "must appear" string, look for it. */
2425 if (PL_curpm && (PM_GETRE(PL_curpm) == rx)) {
2426 /* We have to be careful. If the previous successful match
2427 was from this regex we don't want a subsequent partially
2428 successful match to clobber the old results.
2429 So when we detect this possibility we add a swap buffer
2430 to the re, and switch the buffer each match. If we fail,
2431 we switch it back; otherwise we leave it swapped.
2434 /* do we need a save destructor here for eval dies? */
2435 Newxz(prog->offs, (prog->nparens + 1), regexp_paren_pair);
2436 DEBUG_BUFFERS_r(PerlIO_printf(Perl_debug_log,
2437 "rex=0x%"UVxf" saving offs: orig=0x%"UVxf" new=0x%"UVxf"\n",
2444 /* Simplest case: anchored match need be tried only once. */
2445 /* [unless only anchor is BOL and multiline is set] */
2446 if (prog->extflags & (RXf_ANCH & ~RXf_ANCH_GPOS)) {
2447 if (s == startpos && regtry(reginfo, &s))
2449 else if (multiline || (prog->intflags & PREGf_IMPLICIT)
2450 || (prog->extflags & RXf_ANCH_MBOL)) /* XXXX SBOL? */
2455 dontbother = minlen - 1;
2456 end = HOP3c(strend, -dontbother, strbeg) - 1;
2457 /* for multiline we only have to try after newlines */
2458 if (prog->check_substr || prog->check_utf8) {
2459 /* because of the goto we can not easily reuse the macros for bifurcating the
2460 unicode/non-unicode match modes here like we do elsewhere - demerphq */
2463 goto after_try_utf8;
2465 if (regtry(reginfo, &s)) {
2472 if (prog->extflags & RXf_USE_INTUIT) {
2473 s = re_intuit_start(rx, sv, strbeg,
2474 s + UTF8SKIP(s), strend, flags, NULL);
2483 } /* end search for check string in unicode */
2485 if (s == startpos) {
2486 goto after_try_latin;
2489 if (regtry(reginfo, &s)) {
2496 if (prog->extflags & RXf_USE_INTUIT) {
2497 s = re_intuit_start(rx, sv, strbeg,
2498 s + 1, strend, flags, NULL);
2507 } /* end search for check string in latin*/
2508 } /* end search for check string */
2509 else { /* search for newline */
2511 /*XXX: The s-- is almost definitely wrong here under unicode - demeprhq*/
2514 /* We can use a more efficient search as newlines are the same in unicode as they are in latin */
2515 while (s <= end) { /* note it could be possible to match at the end of the string */
2516 if (*s++ == '\n') { /* don't need PL_utf8skip here */
2517 if (regtry(reginfo, &s))
2521 } /* end search for newline */
2522 } /* end anchored/multiline check string search */
2524 } else if (RXf_GPOS_CHECK == (prog->extflags & RXf_GPOS_CHECK))
2526 /* the warning about reginfo->ganch being used without initialization
2527 is bogus -- we set it above, when prog->extflags & RXf_GPOS_SEEN
2528 and we only enter this block when the same bit is set. */
2529 char *tmp_s = reginfo->ganch - prog->gofs;
2531 if (s <= tmp_s && regtry(reginfo, &tmp_s))
2536 /* Messy cases: unanchored match. */
2537 if ((prog->anchored_substr || prog->anchored_utf8) && prog->intflags & PREGf_SKIP) {
2538 /* we have /x+whatever/ */
2539 /* it must be a one character string (XXXX Except is_utf8_pat?) */
2545 if (! prog->anchored_utf8) {
2546 to_utf8_substr(prog);
2548 ch = SvPVX_const(prog->anchored_utf8)[0];
2551 DEBUG_EXECUTE_r( did_match = 1 );
2552 if (regtry(reginfo, &s)) goto got_it;
2554 while (s < strend && *s == ch)
2561 if (! prog->anchored_substr) {
2562 if (! to_byte_substr(prog)) {
2563 NON_UTF8_TARGET_BUT_UTF8_REQUIRED(phooey);
2566 ch = SvPVX_const(prog->anchored_substr)[0];
2569 DEBUG_EXECUTE_r( did_match = 1 );
2570 if (regtry(reginfo, &s)) goto got_it;
2572 while (s < strend && *s == ch)
2577 DEBUG_EXECUTE_r(if (!did_match)
2578 PerlIO_printf(Perl_debug_log,
2579 "Did not find anchored character...\n")
2582 else if (prog->anchored_substr != NULL
2583 || prog->anchored_utf8 != NULL
2584 || ((prog->float_substr != NULL || prog->float_utf8 != NULL)
2585 && prog->float_max_offset < strend - s)) {
2590 char *last1; /* Last position checked before */
2594 if (prog->anchored_substr || prog->anchored_utf8) {
2596 if (! prog->anchored_utf8) {
2597 to_utf8_substr(prog);
2599 must = prog->anchored_utf8;
2602 if (! prog->anchored_substr) {
2603 if (! to_byte_substr(prog)) {
2604 NON_UTF8_TARGET_BUT_UTF8_REQUIRED(phooey);
2607 must = prog->anchored_substr;
2609 back_max = back_min = prog->anchored_offset;
2612 if (! prog->float_utf8) {
2613 to_utf8_substr(prog);
2615 must = prog->float_utf8;
2618 if (! prog->float_substr) {
2619 if (! to_byte_substr(prog)) {
2620 NON_UTF8_TARGET_BUT_UTF8_REQUIRED(phooey);
2623 must = prog->float_substr;
2625 back_max = prog->float_max_offset;
2626 back_min = prog->float_min_offset;
2632 last = HOP3c(strend, /* Cannot start after this */
2633 -(I32)(CHR_SVLEN(must)
2634 - (SvTAIL(must) != 0) + back_min), strbeg);
2636 if (s > reginfo->strbeg)
2637 last1 = HOPc(s, -1);
2639 last1 = s - 1; /* bogus */
2641 /* XXXX check_substr already used to find "s", can optimize if
2642 check_substr==must. */
2643 dontbother = end_shift;
2644 strend = HOPc(strend, -dontbother);
2645 while ( (s <= last) &&
2646 (s = fbm_instr((unsigned char*)HOP3(s, back_min, (back_min<0 ? strbeg : strend)),
2647 (unsigned char*)strend, must,
2648 multiline ? FBMrf_MULTILINE : 0)) ) {
2649 DEBUG_EXECUTE_r( did_match = 1 );
2650 if (HOPc(s, -back_max) > last1) {
2651 last1 = HOPc(s, -back_min);
2652 s = HOPc(s, -back_max);
2655 char * const t = (last1 >= reginfo->strbeg)
2656 ? HOPc(last1, 1) : last1 + 1;
2658 last1 = HOPc(s, -back_min);
2662 while (s <= last1) {
2663 if (regtry(reginfo, &s))
2666 s++; /* to break out of outer loop */
2673 while (s <= last1) {
2674 if (regtry(reginfo, &s))
2680 DEBUG_EXECUTE_r(if (!did_match) {
2681 RE_PV_QUOTED_DECL(quoted, utf8_target, PERL_DEBUG_PAD_ZERO(0),
2682 SvPVX_const(must), RE_SV_DUMPLEN(must), 30);
2683 PerlIO_printf(Perl_debug_log, "Did not find %s substr %s%s...\n",
2684 ((must == prog->anchored_substr || must == prog->anchored_utf8)
2685 ? "anchored" : "floating"),
2686 quoted, RE_SV_TAIL(must));
2690 else if ( (c = progi->regstclass) ) {
2692 const OPCODE op = OP(progi->regstclass);
2693 /* don't bother with what can't match */
2694 if (PL_regkind[op] != EXACT && op != CANY && PL_regkind[op] != TRIE)
2695 strend = HOPc(strend, -(minlen - 1));
2698 SV * const prop = sv_newmortal();
2699 regprop(prog, prop, c);
2701 RE_PV_QUOTED_DECL(quoted,utf8_target,PERL_DEBUG_PAD_ZERO(1),
2703 PerlIO_printf(Perl_debug_log,
2704 "Matching stclass %.*s against %s (%d bytes)\n",
2705 (int)SvCUR(prop), SvPVX_const(prop),
2706 quoted, (int)(strend - s));
2709 if (find_byclass(prog, c, s, strend, reginfo))
2711 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Contradicts stclass... [regexec_flags]\n"));
2715 if (prog->float_substr != NULL || prog->float_utf8 != NULL) {
2723 if (! prog->float_utf8) {
2724 to_utf8_substr(prog);
2726 float_real = prog->float_utf8;
2729 if (! prog->float_substr) {
2730 if (! to_byte_substr(prog)) {
2731 NON_UTF8_TARGET_BUT_UTF8_REQUIRED(phooey);
2734 float_real = prog->float_substr;
2737 little = SvPV_const(float_real, len);
2738 if (SvTAIL(float_real)) {
2739 /* This means that float_real contains an artificial \n on
2740 * the end due to the presence of something like this:
2741 * /foo$/ where we can match both "foo" and "foo\n" at the
2742 * end of the string. So we have to compare the end of the
2743 * string first against the float_real without the \n and
2744 * then against the full float_real with the string. We
2745 * have to watch out for cases where the string might be
2746 * smaller than the float_real or the float_real without
2748 char *checkpos= strend - len;
2750 PerlIO_printf(Perl_debug_log,
2751 "%sChecking for float_real.%s\n",
2752 PL_colors[4], PL_colors[5]));
2753 if (checkpos + 1 < strbeg) {
2754 /* can't match, even if we remove the trailing \n
2755 * string is too short to match */
2757 PerlIO_printf(Perl_debug_log,
2758 "%sString shorter than required trailing substring, cannot match.%s\n",
2759 PL_colors[4], PL_colors[5]));
2761 } else if (memEQ(checkpos + 1, little, len - 1)) {
2762 /* can match, the end of the string matches without the
2764 last = checkpos + 1;
2765 } else if (checkpos < strbeg) {
2766 /* cant match, string is too short when the "\n" is
2769 PerlIO_printf(Perl_debug_log,
2770 "%sString does not contain required trailing substring, cannot match.%s\n",
2771 PL_colors[4], PL_colors[5]));
2773 } else if (!multiline) {
2774 /* non multiline match, so compare with the "\n" at the
2775 * end of the string */
2776 if (memEQ(checkpos, little, len)) {
2780 PerlIO_printf(Perl_debug_log,
2781 "%sString does not contain required trailing substring, cannot match.%s\n",
2782 PL_colors[4], PL_colors[5]));
2786 /* multiline match, so we have to search for a place
2787 * where the full string is located */
2793 last = rninstr(s, strend, little, little + len);
2795 last = strend; /* matching "$" */
2798 /* at one point this block contained a comment which was
2799 * probably incorrect, which said that this was a "should not
2800 * happen" case. Even if it was true when it was written I am
2801 * pretty sure it is not anymore, so I have removed the comment
2802 * and replaced it with this one. Yves */
2804 PerlIO_printf(Perl_debug_log,
2805 "String does not contain required substring, cannot match.\n"
2809 dontbother = strend - last + prog->float_min_offset;
2811 if (minlen && (dontbother < minlen))
2812 dontbother = minlen - 1;
2813 strend -= dontbother; /* this one's always in bytes! */
2814 /* We don't know much -- general case. */
2817 if (regtry(reginfo, &s))
2826 if (regtry(reginfo, &s))
2828 } while (s++ < strend);
2836 /* s/// doesn't like it if $& is earlier than where we asked it to
2837 * start searching (which can happen on something like /.\G/) */
2838 if ( (flags & REXEC_FAIL_ON_UNDERFLOW)
2839 && (prog->offs[0].start < stringarg - strbeg))
2841 /* this should only be possible under \G */
2842 assert(prog->extflags & RXf_GPOS_SEEN);
2843 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
2844 "matched, but failing for REXEC_FAIL_ON_UNDERFLOW\n"));
2850 PerlIO_printf(Perl_debug_log,
2851 "rex=0x%"UVxf" freeing offs: 0x%"UVxf"\n",
2858 /* clean up; this will trigger destructors that will free all slabs
2859 * above the current one, and cleanup the regmatch_info_aux
2860 * and regmatch_info_aux_eval sructs */
2862 LEAVE_SCOPE(oldsave);
2864 if (RXp_PAREN_NAMES(prog))
2865 (void)hv_iterinit(RXp_PAREN_NAMES(prog));
2867 RX_MATCH_UTF8_set(rx, utf8_target);
2869 /* make sure $`, $&, $', and $digit will work later */
2870 if ( !(flags & REXEC_NOT_FIRST) )
2871 S_reg_set_capture_string(aTHX_ rx,
2872 strbeg, reginfo->strend,
2873 sv, flags, utf8_target);
2878 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "%sMatch failed%s\n",
2879 PL_colors[4], PL_colors[5]));
2881 /* clean up; this will trigger destructors that will free all slabs
2882 * above the current one, and cleanup the regmatch_info_aux
2883 * and regmatch_info_aux_eval sructs */
2885 LEAVE_SCOPE(oldsave);
2888 /* we failed :-( roll it back */
2889 DEBUG_BUFFERS_r(PerlIO_printf(Perl_debug_log,
2890 "rex=0x%"UVxf" rolling back offs: freeing=0x%"UVxf" restoring=0x%"UVxf"\n",
2895 Safefree(prog->offs);
2902 /* Set which rex is pointed to by PL_reg_curpm, handling ref counting.
2903 * Do inc before dec, in case old and new rex are the same */
2904 #define SET_reg_curpm(Re2) \
2905 if (reginfo->info_aux_eval) { \
2906 (void)ReREFCNT_inc(Re2); \
2907 ReREFCNT_dec(PM_GETRE(PL_reg_curpm)); \
2908 PM_SETRE((PL_reg_curpm), (Re2)); \
2913 - regtry - try match at specific point
2915 STATIC I32 /* 0 failure, 1 success */
2916 S_regtry(pTHX_ regmatch_info *reginfo, char **startposp)
2920 REGEXP *const rx = reginfo->prog;
2921 regexp *const prog = ReANY(rx);
2923 RXi_GET_DECL(prog,progi);
2924 GET_RE_DEBUG_FLAGS_DECL;
2926 PERL_ARGS_ASSERT_REGTRY;
2928 reginfo->cutpoint=NULL;
2930 prog->offs[0].start = *startposp - reginfo->strbeg;
2931 prog->lastparen = 0;
2932 prog->lastcloseparen = 0;
2934 /* XXXX What this code is doing here?!!! There should be no need
2935 to do this again and again, prog->lastparen should take care of
2938 /* Tests pat.t#187 and split.t#{13,14} seem to depend on this code.
2939 * Actually, the code in regcppop() (which Ilya may be meaning by
2940 * prog->lastparen), is not needed at all by the test suite
2941 * (op/regexp, op/pat, op/split), but that code is needed otherwise
2942 * this erroneously leaves $1 defined: "1" =~ /^(?:(\d)x)?\d$/
2943 * Meanwhile, this code *is* needed for the
2944 * above-mentioned test suite tests to succeed. The common theme
2945 * on those tests seems to be returning null fields from matches.
2946 * --jhi updated by dapm */
2948 if (prog->nparens) {
2949 regexp_paren_pair *pp = prog->offs;
2951 for (i = prog->nparens; i > (I32)prog->lastparen; i--) {
2959 result = regmatch(reginfo, *startposp, progi->program + 1);
2961 prog->offs[0].end = result;
2964 if (reginfo->cutpoint)
2965 *startposp= reginfo->cutpoint;
2966 REGCP_UNWIND(lastcp);
2971 #define sayYES goto yes
2972 #define sayNO goto no
2973 #define sayNO_SILENT goto no_silent
2975 /* we dont use STMT_START/END here because it leads to
2976 "unreachable code" warnings, which are bogus, but distracting. */
2977 #define CACHEsayNO \
2978 if (ST.cache_mask) \
2979 reginfo->info_aux->poscache[ST.cache_offset] |= ST.cache_mask; \
2982 /* this is used to determine how far from the left messages like
2983 'failed...' are printed. It should be set such that messages
2984 are inline with the regop output that created them.
2986 #define REPORT_CODE_OFF 32
2989 #define CHRTEST_UNINIT -1001 /* c1/c2 haven't been calculated yet */
2990 #define CHRTEST_VOID -1000 /* the c1/c2 "next char" test should be skipped */
2991 #define CHRTEST_NOT_A_CP_1 -999
2992 #define CHRTEST_NOT_A_CP_2 -998
2994 /* grab a new slab and return the first slot in it */
2996 STATIC regmatch_state *
2999 #if PERL_VERSION < 9 && !defined(PERL_CORE)
3002 regmatch_slab *s = PL_regmatch_slab->next;
3004 Newx(s, 1, regmatch_slab);
3005 s->prev = PL_regmatch_slab;
3007 PL_regmatch_slab->next = s;
3009 PL_regmatch_slab = s;
3010 return SLAB_FIRST(s);
3014 /* push a new state then goto it */
3016 #define PUSH_STATE_GOTO(state, node, input) \
3017 pushinput = input; \
3019 st->resume_state = state; \
3022 /* push a new state with success backtracking, then goto it */
3024 #define PUSH_YES_STATE_GOTO(state, node, input) \
3025 pushinput = input; \
3027 st->resume_state = state; \
3028 goto push_yes_state;
3035 regmatch() - main matching routine
3037 This is basically one big switch statement in a loop. We execute an op,
3038 set 'next' to point the next op, and continue. If we come to a point which
3039 we may need to backtrack to on failure such as (A|B|C), we push a
3040 backtrack state onto the backtrack stack. On failure, we pop the top
3041 state, and re-enter the loop at the state indicated. If there are no more
3042 states to pop, we return failure.
3044 Sometimes we also need to backtrack on success; for example /A+/, where
3045 after successfully matching one A, we need to go back and try to
3046 match another one; similarly for lookahead assertions: if the assertion
3047 completes successfully, we backtrack to the state just before the assertion
3048 and then carry on. In these cases, the pushed state is marked as
3049 'backtrack on success too'. This marking is in fact done by a chain of
3050 pointers, each pointing to the previous 'yes' state. On success, we pop to
3051 the nearest yes state, discarding any intermediate failure-only states.
3052 Sometimes a yes state is pushed just to force some cleanup code to be
3053 called at the end of a successful match or submatch; e.g. (??{$re}) uses
3054 it to free the inner regex.
3056 Note that failure backtracking rewinds the cursor position, while
3057 success backtracking leaves it alone.
3059 A pattern is complete when the END op is executed, while a subpattern
3060 such as (?=foo) is complete when the SUCCESS op is executed. Both of these
3061 ops trigger the "pop to last yes state if any, otherwise return true"
3064 A common convention in this function is to use A and B to refer to the two
3065 subpatterns (or to the first nodes thereof) in patterns like /A*B/: so A is
3066 the subpattern to be matched possibly multiple times, while B is the entire
3067 rest of the pattern. Variable and state names reflect this convention.
3069 The states in the main switch are the union of ops and failure/success of
3070 substates associated with with that op. For example, IFMATCH is the op
3071 that does lookahead assertions /(?=A)B/ and so the IFMATCH state means
3072 'execute IFMATCH'; while IFMATCH_A is a state saying that we have just
3073 successfully matched A and IFMATCH_A_fail is a state saying that we have
3074 just failed to match A. Resume states always come in pairs. The backtrack
3075 state we push is marked as 'IFMATCH_A', but when that is popped, we resume
3076 at IFMATCH_A or IFMATCH_A_fail, depending on whether we are backtracking
3077 on success or failure.
3079 The struct that holds a backtracking state is actually a big union, with
3080 one variant for each major type of op. The variable st points to the
3081 top-most backtrack struct. To make the code clearer, within each
3082 block of code we #define ST to alias the relevant union.
3084 Here's a concrete example of a (vastly oversimplified) IFMATCH
3090 #define ST st->u.ifmatch
3092 case IFMATCH: // we are executing the IFMATCH op, (?=A)B
3093 ST.foo = ...; // some state we wish to save
3095 // push a yes backtrack state with a resume value of
3096 // IFMATCH_A/IFMATCH_A_fail, then continue execution at the
3098 PUSH_YES_STATE_GOTO(IFMATCH_A, A, newinput);
3101 case IFMATCH_A: // we have successfully executed A; now continue with B
3103 bar = ST.foo; // do something with the preserved value
3106 case IFMATCH_A_fail: // A failed, so the assertion failed
3107 ...; // do some housekeeping, then ...
3108 sayNO; // propagate the failure
3115 For any old-timers reading this who are familiar with the old recursive
3116 approach, the code above is equivalent to:
3118 case IFMATCH: // we are executing the IFMATCH op, (?=A)B
3127 ...; // do some housekeeping, then ...
3128 sayNO; // propagate the failure
3131 The topmost backtrack state, pointed to by st, is usually free. If you
3132 want to claim it, populate any ST.foo fields in it with values you wish to
3133 save, then do one of
3135 PUSH_STATE_GOTO(resume_state, node, newinput);
3136 PUSH_YES_STATE_GOTO(resume_state, node, newinput);
3138 which sets that backtrack state's resume value to 'resume_state', pushes a
3139 new free entry to the top of the backtrack stack, then goes to 'node'.
3140 On backtracking, the free slot is popped, and the saved state becomes the
3141 new free state. An ST.foo field in this new top state can be temporarily
3142 accessed to retrieve values, but once the main loop is re-entered, it
3143 becomes available for reuse.
3145 Note that the depth of the backtrack stack constantly increases during the
3146 left-to-right execution of the pattern, rather than going up and down with
3147 the pattern nesting. For example the stack is at its maximum at Z at the
3148 end of the pattern, rather than at X in the following:
3150 /(((X)+)+)+....(Y)+....Z/
3152 The only exceptions to this are lookahead/behind assertions and the cut,
3153 (?>A), which pop all the backtrack states associated with A before
3156 Backtrack state structs are allocated in slabs of about 4K in size.
3157 PL_regmatch_state and st always point to the currently active state,
3158 and PL_regmatch_slab points to the slab currently containing
3159 PL_regmatch_state. The first time regmatch() is called, the first slab is
3160 allocated, and is never freed until interpreter destruction. When the slab
3161 is full, a new one is allocated and chained to the end. At exit from
3162 regmatch(), slabs allocated since entry are freed.
3167 #define DEBUG_STATE_pp(pp) \
3169 DUMP_EXEC_POS(locinput, scan, utf8_target); \
3170 PerlIO_printf(Perl_debug_log, \
3171 " %*s"pp" %s%s%s%s%s\n", \
3173 PL_reg_name[st->resume_state], \
3174 ((st==yes_state||st==mark_state) ? "[" : ""), \
3175 ((st==yes_state) ? "Y" : ""), \
3176 ((st==mark_state) ? "M" : ""), \
3177 ((st==yes_state||st==mark_state) ? "]" : "") \
3182 #define REG_NODE_NUM(x) ((x) ? (int)((x)-prog) : -1)
3187 S_debug_start_match(pTHX_ const REGEXP *prog, const bool utf8_target,
3188 const char *start, const char *end, const char *blurb)
3190 const bool utf8_pat = RX_UTF8(prog) ? 1 : 0;
3192 PERL_ARGS_ASSERT_DEBUG_START_MATCH;
3197 RE_PV_QUOTED_DECL(s0, utf8_pat, PERL_DEBUG_PAD_ZERO(0),
3198 RX_PRECOMP_const(prog), RX_PRELEN(prog), 60);
3200 RE_PV_QUOTED_DECL(s1, utf8_target, PERL_DEBUG_PAD_ZERO(1),
3201 start, end - start, 60);
3203 PerlIO_printf(Perl_debug_log,
3204 "%s%s REx%s %s against %s\n",
3205 PL_colors[4], blurb, PL_colors[5], s0, s1);
3207 if (utf8_target||utf8_pat)
3208 PerlIO_printf(Perl_debug_log, "UTF-8 %s%s%s...\n",
3209 utf8_pat ? "pattern" : "",
3210 utf8_pat && utf8_target ? " and " : "",
3211 utf8_target ? "string" : ""
3217 S_dump_exec_pos(pTHX_ const char *locinput,
3218 const regnode *scan,
3219 const char *loc_regeol,
3220 const char *loc_bostr,
3221 const char *loc_reg_starttry,
3222 const bool utf8_target)
3224 const int docolor = *PL_colors[0] || *PL_colors[2] || *PL_colors[4];
3225 const int taill = (docolor ? 10 : 7); /* 3 chars for "> <" */
3226 int l = (loc_regeol - locinput) > taill ? taill : (loc_regeol - locinput);
3227 /* The part of the string before starttry has one color
3228 (pref0_len chars), between starttry and current
3229 position another one (pref_len - pref0_len chars),
3230 after the current position the third one.
3231 We assume that pref0_len <= pref_len, otherwise we
3232 decrease pref0_len. */
3233 int pref_len = (locinput - loc_bostr) > (5 + taill) - l
3234 ? (5 + taill) - l : locinput - loc_bostr;
3237 PERL_ARGS_ASSERT_DUMP_EXEC_POS;
3239 while (utf8_target && UTF8_IS_CONTINUATION(*(U8*)(locinput - pref_len)))
3241 pref0_len = pref_len - (locinput - loc_reg_starttry);
3242 if (l + pref_len < (5 + taill) && l < loc_regeol - locinput)
3243 l = ( loc_regeol - locinput > (5 + taill) - pref_len
3244 ? (5 + taill) - pref_len : loc_regeol - locinput);
3245 while (utf8_target && UTF8_IS_CONTINUATION(*(U8*)(locinput + l)))
3249 if (pref0_len > pref_len)
3250 pref0_len = pref_len;
3252 const int is_uni = (utf8_target && OP(scan) != CANY) ? 1 : 0;
3254 RE_PV_COLOR_DECL(s0,len0,is_uni,PERL_DEBUG_PAD(0),
3255 (locinput - pref_len),pref0_len, 60, 4, 5);
3257 RE_PV_COLOR_DECL(s1,len1,is_uni,PERL_DEBUG_PAD(1),
3258 (locinput - pref_len + pref0_len),
3259 pref_len - pref0_len, 60, 2, 3);
3261 RE_PV_COLOR_DECL(s2,len2,is_uni,PERL_DEBUG_PAD(2),
3262 locinput, loc_regeol - locinput, 10, 0, 1);
3264 const STRLEN tlen=len0+len1+len2;
3265 PerlIO_printf(Perl_debug_log,
3266 "%4"IVdf" <%.*s%.*s%s%.*s>%*s|",
3267 (IV)(locinput - loc_bostr),
3270 (docolor ? "" : "> <"),
3272 (int)(tlen > 19 ? 0 : 19 - tlen),
3279 /* reg_check_named_buff_matched()
3280 * Checks to see if a named buffer has matched. The data array of
3281 * buffer numbers corresponding to the buffer is expected to reside
3282 * in the regexp->data->data array in the slot stored in the ARG() of
3283 * node involved. Note that this routine doesn't actually care about the
3284 * name, that information is not preserved from compilation to execution.
3285 * Returns the index of the leftmost defined buffer with the given name
3286 * or 0 if non of the buffers matched.
3289 S_reg_check_named_buff_matched(pTHX_ const regexp *rex, const regnode *scan)
3292 RXi_GET_DECL(rex,rexi);
3293 SV *sv_dat= MUTABLE_SV(rexi->data->data[ ARG( scan ) ]);
3294 I32 *nums=(I32*)SvPVX(sv_dat);
3296 PERL_ARGS_ASSERT_REG_CHECK_NAMED_BUFF_MATCHED;
3298 for ( n=0; n<SvIVX(sv_dat); n++ ) {
3299 if ((I32)rex->lastparen >= nums[n] &&
3300 rex->offs[nums[n]].end != -1)
3310 S_setup_EXACTISH_ST_c1_c2(pTHX_ const regnode * const text_node, int *c1p,
3311 U8* c1_utf8, int *c2p, U8* c2_utf8, regmatch_info *reginfo)
3313 /* This function determines if there are one or two characters that match
3314 * the first character of the passed-in EXACTish node <text_node>, and if
3315 * so, returns them in the passed-in pointers.
3317 * If it determines that no possible character in the target string can
3318 * match, it returns FALSE; otherwise TRUE. (The FALSE situation occurs if
3319 * the first character in <text_node> requires UTF-8 to represent, and the
3320 * target string isn't in UTF-8.)
3322 * If there are more than two characters that could match the beginning of
3323 * <text_node>, or if more context is required to determine a match or not,
3324 * it sets both *<c1p> and *<c2p> to CHRTEST_VOID.
3326 * The motiviation behind this function is to allow the caller to set up
3327 * tight loops for matching. If <text_node> is of type EXACT, there is
3328 * only one possible character that can match its first character, and so
3329 * the situation is quite simple. But things get much more complicated if
3330 * folding is involved. It may be that the first character of an EXACTFish
3331 * node doesn't participate in any possible fold, e.g., punctuation, so it
3332 * can be matched only by itself. The vast majority of characters that are
3333 * in folds match just two things, their lower and upper-case equivalents.
3334 * But not all are like that; some have multiple possible matches, or match
3335 * sequences of more than one character. This function sorts all that out.
3337 * Consider the patterns A*B or A*?B where A and B are arbitrary. In a
3338 * loop of trying to match A*, we know we can't exit where the thing
3339 * following it isn't a B. And something can't be a B unless it is the
3340 * beginning of B. By putting a quick test for that beginning in a tight
3341 * loop, we can rule out things that can't possibly be B without having to
3342 * break out of the loop, thus avoiding work. Similarly, if A is a single
3343 * character, we can make a tight loop matching A*, using the outputs of
3346 * If the target string to match isn't in UTF-8, and there aren't
3347 * complications which require CHRTEST_VOID, *<c1p> and *<c2p> are set to
3348 * the one or two possible octets (which are characters in this situation)
3349 * that can match. In all cases, if there is only one character that can
3350 * match, *<c1p> and *<c2p> will be identical.
3352 * If the target string is in UTF-8, the buffers pointed to by <c1_utf8>
3353 * and <c2_utf8> will contain the one or two UTF-8 sequences of bytes that
3354 * can match the beginning of <text_node>. They should be declared with at
3355 * least length UTF8_MAXBYTES+1. (If the target string isn't in UTF-8, it is
3356 * undefined what these contain.) If one or both of the buffers are
3357 * invariant under UTF-8, *<c1p>, and *<c2p> will also be set to the
3358 * corresponding invariant. If variant, the corresponding *<c1p> and/or
3359 * *<c2p> will be set to a negative number(s) that shouldn't match any code
3360 * point (unless inappropriately coerced to unsigned). *<c1p> will equal
3361 * *<c2p> if and only if <c1_utf8> and <c2_utf8> are the same. */
3363 const bool utf8_target = reginfo->is_utf8_target;
3365 UV c1 = CHRTEST_NOT_A_CP_1;
3366 UV c2 = CHRTEST_NOT_A_CP_2;
3367 bool use_chrtest_void = FALSE;
3368 const bool is_utf8_pat = reginfo->is_utf8_pat;
3370 /* Used when we have both utf8 input and utf8 output, to avoid converting
3371 * to/from code points */
3372 bool utf8_has_been_setup = FALSE;
3376 U8 *pat = (U8*)STRING(text_node);
3378 if (OP(text_node) == EXACT) {
3380 /* In an exact node, only one thing can be matched, that first
3381 * character. If both the pat and the target are UTF-8, we can just
3382 * copy the input to the output, avoiding finding the code point of
3387 else if (utf8_target) {
3388 Copy(pat, c1_utf8, UTF8SKIP(pat), U8);
3389 Copy(pat, c2_utf8, UTF8SKIP(pat), U8);
3390 utf8_has_been_setup = TRUE;
3393 c2 = c1 = valid_utf8_to_uvchr(pat, NULL);
3396 else /* an EXACTFish node */
3398 && is_MULTI_CHAR_FOLD_utf8_safe(pat,
3399 pat + STR_LEN(text_node)))
3401 && is_MULTI_CHAR_FOLD_latin1_safe(pat,
3402 pat + STR_LEN(text_node))))
3404 /* Multi-character folds require more context to sort out. Also
3405 * PL_utf8_foldclosures used below doesn't handle them, so have to be
3406 * handled outside this routine */
3407 use_chrtest_void = TRUE;
3409 else { /* an EXACTFish node which doesn't begin with a multi-char fold */
3410 c1 = is_utf8_pat ? valid_utf8_to_uvchr(pat, NULL) : *pat;
3412 /* Load the folds hash, if not already done */
3414 if (! PL_utf8_foldclosures) {
3415 if (! PL_utf8_tofold) {
3416 U8 dummy[UTF8_MAXBYTES+1];
3418 /* Force loading this by folding an above-Latin1 char */
3419 to_utf8_fold((U8*) HYPHEN_UTF8, dummy, NULL);
3420 assert(PL_utf8_tofold); /* Verify that worked */
3422 PL_utf8_foldclosures = _swash_inversion_hash(PL_utf8_tofold);
3425 /* The fold closures data structure is a hash with the keys being
3426 * the UTF-8 of every character that is folded to, like 'k', and
3427 * the values each an array of all code points that fold to its
3428 * key. e.g. [ 'k', 'K', KELVIN_SIGN ]. Multi-character folds are
3430 if ((! (listp = hv_fetch(PL_utf8_foldclosures,
3435 /* Not found in the hash, therefore there are no folds
3436 * containing it, so there is only a single character that
3440 else { /* Does participate in folds */
3441 AV* list = (AV*) *listp;
3442 if (av_len(list) != 1) {
3444 /* If there aren't exactly two folds to this, it is outside
3445 * the scope of this function */
3446 use_chrtest_void = TRUE;
3448 else { /* There are two. Get them */
3449 SV** c_p = av_fetch(list, 0, FALSE);
3451 Perl_croak(aTHX_ "panic: invalid PL_utf8_foldclosures structure");
3455 c_p = av_fetch(list, 1, FALSE);
3457 Perl_croak(aTHX_ "panic: invalid PL_utf8_foldclosures structure");
3461 /* Folds that cross the 255/256 boundary are forbidden if
3462 * EXACTFL, or EXACTFA and one is ASCIII. Since the
3463 * pattern character is above 256, and its only other match
3464 * is below 256, the only legal match will be to itself.
3465 * We have thrown away the original, so have to compute
3466 * which is the one above 255 */
3467 if ((c1 < 256) != (c2 < 256)) {
3468 if (OP(text_node) == EXACTFL
3469 || (OP(text_node) == EXACTFA
3470 && (isASCII(c1) || isASCII(c2))))
3483 else /* Here, c1 is < 255 */
3485 && HAS_NONLATIN1_FOLD_CLOSURE(c1)
3486 && OP(text_node) != EXACTFL
3487 && (OP(text_node) != EXACTFA || ! isASCII(c1)))
3489 /* Here, there could be something above Latin1 in the target which
3490 * folds to this character in the pattern. All such cases except
3491 * LATIN SMALL LETTER Y WITH DIAERESIS have more than two characters
3492 * involved in their folds, so are outside the scope of this
3494 if (UNLIKELY(c1 == LATIN_SMALL_LETTER_Y_WITH_DIAERESIS)) {
3495 c2 = LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS;
3498 use_chrtest_void = TRUE;
3501 else { /* Here nothing above Latin1 can fold to the pattern character */
3502 switch (OP(text_node)) {
3504 case EXACTFL: /* /l rules */
3505 c2 = PL_fold_locale[c1];
3509 if (! utf8_target) { /* /d rules */
3514 /* /u rules for all these. This happens to work for
3515 * EXACTFA as nothing in Latin1 folds to ASCII */
3517 case EXACTFU_TRICKYFOLD:
3520 c2 = PL_fold_latin1[c1];
3524 Perl_croak(aTHX_ "panic: Unexpected op %u", OP(text_node));
3525 assert(0); /* NOTREACHED */
3530 /* Here have figured things out. Set up the returns */
3531 if (use_chrtest_void) {
3532 *c2p = *c1p = CHRTEST_VOID;
3534 else if (utf8_target) {
3535 if (! utf8_has_been_setup) { /* Don't have the utf8; must get it */
3536 uvchr_to_utf8(c1_utf8, c1);
3537 uvchr_to_utf8(c2_utf8, c2);
3540 /* Invariants are stored in both the utf8 and byte outputs; Use
3541 * negative numbers otherwise for the byte ones. Make sure that the
3542 * byte ones are the same iff the utf8 ones are the same */
3543 *c1p = (UTF8_IS_INVARIANT(*c1_utf8)) ? *c1_utf8 : CHRTEST_NOT_A_CP_1;
3544 *c2p = (UTF8_IS_INVARIANT(*c2_utf8))
3547 ? CHRTEST_NOT_A_CP_1
3548 : CHRTEST_NOT_A_CP_2;
3550 else if (c1 > 255) {
3551 if (c2 > 255) { /* both possibilities are above what a non-utf8 string
3556 *c1p = *c2p = c2; /* c2 is the only representable value */
3558 else { /* c1 is representable; see about c2 */
3560 *c2p = (c2 < 256) ? c2 : c1;
3566 /* returns -1 on failure, $+[0] on success */
3568 S_regmatch(pTHX_ regmatch_info *reginfo, char *startpos, regnode *prog)
3570 #if PERL_VERSION < 9 && !defined(PERL_CORE)
3574 const bool utf8_target = reginfo->is_utf8_target;
3575 const U32 uniflags = UTF8_ALLOW_DEFAULT;
3576 REGEXP *rex_sv = reginfo->prog;
3577 regexp *rex = ReANY(rex_sv);
3578 RXi_GET_DECL(rex,rexi);
3579 /* the current state. This is a cached copy of PL_regmatch_state */
3581 /* cache heavy used fields of st in registers */
3584 U32 n = 0; /* general value; init to avoid compiler warning */
3585 I32 ln = 0; /* len or last; init to avoid compiler warning */
3586 char *locinput = startpos;
3587 char *pushinput; /* where to continue after a PUSH */
3588 I32 nextchr; /* is always set to UCHARAT(locinput) */
3590 bool result = 0; /* return value of S_regmatch */
3591 int depth = 0; /* depth of backtrack stack */
3592 U32 nochange_depth = 0; /* depth of GOSUB recursion with nochange */
3593 const U32 max_nochange_depth =
3594 (3 * rex->nparens > MAX_RECURSE_EVAL_NOCHANGE_DEPTH) ?
3595 3 * rex->nparens : MAX_RECURSE_EVAL_NOCHANGE_DEPTH;
3596 regmatch_state *yes_state = NULL; /* state to pop to on success of
3598 /* mark_state piggy backs on the yes_state logic so that when we unwind
3599 the stack on success we can update the mark_state as we go */
3600 regmatch_state *mark_state = NULL; /* last mark state we have seen */
3601 regmatch_state *cur_eval = NULL; /* most recent EVAL_AB state */
3602 struct regmatch_state *cur_curlyx = NULL; /* most recent curlyx */
3604 bool no_final = 0; /* prevent failure from backtracking? */
3605 bool do_cutgroup = 0; /* no_final only until next branch/trie entry */
3606 char *startpoint = locinput;
3607 SV *popmark = NULL; /* are we looking for a mark? */
3608 SV *sv_commit = NULL; /* last mark name seen in failure */
3609 SV *sv_yes_mark = NULL; /* last mark name we have seen
3610 during a successful match */
3611 U32 lastopen = 0; /* last open we saw */
3612 bool has_cutgroup = RX_HAS_CUTGROUP(rex) ? 1 : 0;
3613 SV* const oreplsv = GvSV(PL_replgv);
3614 /* these three flags are set by various ops to signal information to
3615 * the very next op. They have a useful lifetime of exactly one loop
3616 * iteration, and are not preserved or restored by state pushes/pops
3618 bool sw = 0; /* the condition value in (?(cond)a|b) */
3619 bool minmod = 0; /* the next "{n,m}" is a "{n,m}?" */
3620 int logical = 0; /* the following EVAL is:
3624 or the following IFMATCH/UNLESSM is:
3625 false: plain (?=foo)
3626 true: used as a condition: (?(?=foo))
3628 PAD* last_pad = NULL;
3630 I32 gimme = G_SCALAR;
3631 CV *caller_cv = NULL; /* who called us */
3632 CV *last_pushed_cv = NULL; /* most recently called (?{}) CV */
3633 CHECKPOINT runops_cp; /* savestack position before executing EVAL */
3634 U32 maxopenparen = 0; /* max '(' index seen so far */
3635 int to_complement; /* Invert the result? */
3636 _char_class_number classnum;
3637 bool is_utf8_pat = reginfo->is_utf8_pat;
3640 GET_RE_DEBUG_FLAGS_DECL;
3643 /* shut up 'may be used uninitialized' compiler warnings for dMULTICALL */
3644 multicall_oldcatch = 0;
3645 multicall_cv = NULL;
3647 PERL_UNUSED_VAR(multicall_cop);
3648 PERL_UNUSED_VAR(newsp);
3651 PERL_ARGS_ASSERT_REGMATCH;
3653 DEBUG_OPTIMISE_r( DEBUG_EXECUTE_r({
3654 PerlIO_printf(Perl_debug_log,"regmatch start\n");
3657 st = PL_regmatch_state;
3659 /* Note that nextchr is a byte even in UTF */
3662 while (scan != NULL) {
3665 SV * const prop = sv_newmortal();
3666 regnode *rnext=regnext(scan);
3667 DUMP_EXEC_POS( locinput, scan, utf8_target );
3668 regprop(rex, prop, scan);
3670 PerlIO_printf(Perl_debug_log,
3671 "%3"IVdf":%*s%s(%"IVdf")\n",
3672 (IV)(scan - rexi->program), depth*2, "",
3674 (PL_regkind[OP(scan)] == END || !rnext) ?
3675 0 : (IV)(rnext - rexi->program));
3678 next = scan + NEXT_OFF(scan);
3681 state_num = OP(scan);
3687 assert(nextchr < 256 && (nextchr >= 0 || nextchr == NEXTCHR_EOS));
3689 switch (state_num) {
3690 case BOL: /* /^../ */
3691 if (locinput == reginfo->strbeg)
3695 case MBOL: /* /^../m */
3696 if (locinput == reginfo->strbeg ||
3697 (!NEXTCHR_IS_EOS && locinput[-1] == '\n'))
3703 case SBOL: /* /^../s */
3704 if (locinput == reginfo->strbeg)
3709 if (locinput == reginfo->ganch)
3713 case KEEPS: /* \K */
3714 /* update the startpoint */
3715 st->u.keeper.val = rex->offs[0].start;
3716 rex->offs[0].start = locinput - reginfo->strbeg;
3717 PUSH_STATE_GOTO(KEEPS_next, next, locinput);
3718 assert(0); /*NOTREACHED*/
3719 case KEEPS_next_fail:
3720 /* rollback the start point change */
3721 rex->offs[0].start = st->u.keeper.val;
3723 assert(0); /*NOTREACHED*/
3725 case EOL: /* /..$/ */
3728 case MEOL: /* /..$/m */
3729 if (!NEXTCHR_IS_EOS && nextchr != '\n')
3733 case SEOL: /* /..$/s */
3735 if (!NEXTCHR_IS_EOS && nextchr != '\n')
3737 if (reginfo->strend - locinput > 1)
3742 if (!NEXTCHR_IS_EOS)
3746 case SANY: /* /./s */
3749 goto increment_locinput;
3757 case REG_ANY: /* /./ */
3758 if ((NEXTCHR_IS_EOS) || nextchr == '\n')
3760 goto increment_locinput;
3764 #define ST st->u.trie
3765 case TRIEC: /* (ab|cd) with known charclass */
3766 /* In this case the charclass data is available inline so
3767 we can fail fast without a lot of extra overhead.
3769 if(!NEXTCHR_IS_EOS && !ANYOF_BITMAP_TEST(scan, nextchr)) {
3771 PerlIO_printf(Perl_debug_log,
3772 "%*s %sfailed to match trie start class...%s\n",
3773 REPORT_CODE_OFF+depth*2, "", PL_colors[4], PL_colors[5])
3776 assert(0); /* NOTREACHED */
3779 case TRIE: /* (ab|cd) */
3780 /* the basic plan of execution of the trie is:
3781 * At the beginning, run though all the states, and
3782 * find the longest-matching word. Also remember the position
3783 * of the shortest matching word. For example, this pattern:
3786 * when matched against the string "abcde", will generate
3787 * accept states for all words except 3, with the longest
3788 * matching word being 4, and the shortest being 2 (with
3789 * the position being after char 1 of the string).
3791 * Then for each matching word, in word order (i.e. 1,2,4,5),
3792 * we run the remainder of the pattern; on each try setting
3793 * the current position to the character following the word,
3794 * returning to try the next word on failure.
3796 * We avoid having to build a list of words at runtime by
3797 * using a compile-time structure, wordinfo[].prev, which
3798 * gives, for each word, the previous accepting word (if any).
3799 * In the case above it would contain the mappings 1->2, 2->0,
3800 * 3->0, 4->5, 5->1. We can use this table to generate, from
3801 * the longest word (4 above), a list of all words, by
3802 * following the list of prev pointers; this gives us the
3803 * unordered list 4,5,1,2. Then given the current word we have
3804 * just tried, we can go through the list and find the
3805 * next-biggest word to try (so if we just failed on word 2,
3806 * the next in the list is 4).
3808 * Since at runtime we don't record the matching position in
3809 * the string for each word, we have to work that out for
3810 * each word we're about to process. The wordinfo table holds
3811 * the character length of each word; given that we recorded
3812 * at the start: the position of the shortest word and its
3813 * length in chars, we just need to move the pointer the
3814 * difference between the two char lengths. Depending on
3815 * Unicode status and folding, that's cheap or expensive.
3817 * This algorithm is optimised for the case where are only a
3818 * small number of accept states, i.e. 0,1, or maybe 2.
3819 * With lots of accepts states, and having to try all of them,
3820 * it becomes quadratic on number of accept states to find all
3825 /* what type of TRIE am I? (utf8 makes this contextual) */
3826 DECL_TRIE_TYPE(scan);
3828 /* what trie are we using right now */
3829 reg_trie_data * const trie
3830 = (reg_trie_data*)rexi->data->data[ ARG( scan ) ];
3831 HV * widecharmap = MUTABLE_HV(rexi->data->data[ ARG( scan ) + 1 ]);
3832 U32 state = trie->startstate;
3835 && (NEXTCHR_IS_EOS || !TRIE_BITMAP_TEST(trie, nextchr)))
3837 if (trie->states[ state ].wordnum) {
3839 PerlIO_printf(Perl_debug_log,
3840 "%*s %smatched empty string...%s\n",
3841 REPORT_CODE_OFF+depth*2, "", PL_colors[4], PL_colors[5])
3847 PerlIO_printf(Perl_debug_log,
3848 "%*s %sfailed to match trie start class...%s\n",
3849 REPORT_CODE_OFF+depth*2, "", PL_colors[4], PL_colors[5])
3856 U8 *uc = ( U8* )locinput;
3860 U8 *uscan = (U8*)NULL;
3861 U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
3862 U32 charcount = 0; /* how many input chars we have matched */
3863 U32 accepted = 0; /* have we seen any accepting states? */
3865 ST.jump = trie->jump;
3868 ST.longfold = FALSE; /* char longer if folded => it's harder */
3871 /* fully traverse the TRIE; note the position of the
3872 shortest accept state and the wordnum of the longest
3875 while ( state && uc <= (U8*)(reginfo->strend) ) {
3876 U32 base = trie->states[ state ].trans.base;
3880 wordnum = trie->states[ state ].wordnum;
3882 if (wordnum) { /* it's an accept state */
3885 /* record first match position */
3887 ST.firstpos = (U8*)locinput;
3892 ST.firstchars = charcount;
3895 if (!ST.nextword || wordnum < ST.nextword)
3896 ST.nextword = wordnum;
3897 ST.topword = wordnum;
3900 DEBUG_TRIE_EXECUTE_r({
3901 DUMP_EXEC_POS( (char *)uc, scan, utf8_target );
3902 PerlIO_printf( Perl_debug_log,
3903 "%*s %sState: %4"UVxf" Accepted: %c ",
3904 2+depth * 2, "", PL_colors[4],
3905 (UV)state, (accepted ? 'Y' : 'N'));
3908 /* read a char and goto next state */
3909 if ( base && (foldlen || uc < (U8*)(reginfo->strend))) {
3911 REXEC_TRIE_READ_CHAR(trie_type, trie, widecharmap, uc,
3912 uscan, len, uvc, charid, foldlen,
3919 base + charid - 1 - trie->uniquecharcount)) >= 0)
3921 && ((U32)offset < trie->lasttrans)
3922 && trie->trans[offset].check == state)
3924 state = trie->trans[offset].next;
3935 DEBUG_TRIE_EXECUTE_r(
3936 PerlIO_printf( Perl_debug_log,
3937 "Charid:%3x CP:%4"UVxf" After State: %4"UVxf"%s\n",
3938 charid, uvc, (UV)state, PL_colors[5] );