regexec.c

   1 /*    regexec.c
   2  */
   3
   4 /*
   5  *      One Ring to rule them all, One Ring to find them
   6  &
   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"]
  10  */
  11
  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.
  15  *
  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.
  20  */
  21
  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!
  24  */
  25
  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.
  29  */
  30
  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.
  34 */
  35
  36 #ifdef PERL_EXT_RE_BUILD
  37 #include "re_top.h"
  38 #endif
  39
  40 /*
  41  * pregcomp and pregexec -- regsub and regerror are not used in perl
  42  *
  43  *      Copyright (c) 1986 by University of Toronto.
  44  *      Written by Henry Spencer.  Not derived from licensed software.
  45  *
  46  *      Permission is granted to anyone to use this software for any
  47  *      purpose on any computer system, and to redistribute it freely,
  48  *      subject to the following restrictions:
  49  *
  50  *      1. The author is not responsible for the consequences of use of
  51  *              this software, no matter how awful, even if they arise
  52  *              from defects in it.
  53  *
  54  *      2. The origin of this software must not be misrepresented, either
  55  *              by explicit claim or by omission.
  56  *
  57  *      3. Altered versions must be plainly marked as such, and must not
  58  *              be misrepresented as being the original software.
  59  *
  60  ****    Alterations to Henry's code are...
  61  ****
  62  ****    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
  63  ****    2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
  64  ****    by Larry Wall and others
  65  ****
  66  ****    You may distribute under the terms of either the GNU General Public
  67  ****    License or the Artistic License, as specified in the README file.
  68  *
  69  * Beware that some of this code is subtly aware of the way operator
  70  * precedence is structured in regular expressions.  Serious changes in
  71  * regular-expression syntax might require a total rethink.
  72  */
  73 #include "EXTERN.h"
  74 #define PERL_IN_REGEXEC_C
  75 #include "perl.h"
  76
  77 #ifdef PERL_IN_XSUB_RE
  78 #  include "re_comp.h"
  79 #else
  80 #  include "regcomp.h"
  81 #endif
  82
  83 #include "inline_invlist.c"
  84
  85 #define RF_tainted      1       /* tainted information used? e.g. locale */
  86 #define RF_warned       2               /* warned about big count? */
  87
  88 #define RF_utf8         8               /* Pattern contains multibyte chars? */
  89
  90 #define UTF_PATTERN ((PL_reg_flags & RF_utf8) != 0)
  91
  92 #ifndef STATIC
  93 #define STATIC  static
  94 #endif
  95
  96 /* Valid for non-utf8 strings, non-ANYOFV nodes only: avoids the reginclass
  97  * call if there are no complications: i.e., if everything matchable is
  98  * straight forward in the bitmap */
  99 #define REGINCLASS(prog,p,c)  (ANYOF_FLAGS(p) ? reginclass(prog,p,c,0,0)   \
 100                                               : ANYOF_BITMAP_TEST(p,*(c)))
 101
 102 /*
 103  * Forwards.
 104  */
 105
 106 #define CHR_SVLEN(sv) (utf8_target ? sv_len_utf8(sv) : SvCUR(sv))
 107 #define CHR_DIST(a,b) (PL_reg_match_utf8 ? utf8_distance(a,b) : a - b)
 108
 109 #define HOPc(pos,off) \
 110         (char *)(PL_reg_match_utf8 \
 111             ? reghop3((U8*)pos, off, (U8*)(off >= 0 ? PL_regeol : PL_bostr)) \
 112             : (U8*)(pos + off))
 113 #define HOPBACKc(pos, off) \
 114         (char*)(PL_reg_match_utf8\
 115             ? reghopmaybe3((U8*)pos, -off, (U8*)PL_bostr) \
 116             : (pos - off >= PL_bostr)           \
 117                 ? (U8*)pos - off                \
 118                 : NULL)
 119
 120 #define HOP3(pos,off,lim) (PL_reg_match_utf8 ? reghop3((U8*)(pos), off, (U8*)(lim)) : (U8*)(pos + off))
 121 #define HOP3c(pos,off,lim) ((char*)HOP3(pos,off,lim))
 122
 123 /* these are unrolled below in the CCC_TRY_XXX defined */
 124 #ifdef EBCDIC
 125     /* Often 'str' is a hard-coded utf8 string instead of utfebcdic. so just
 126      * skip the check on EBCDIC platforms */
 127 #   define LOAD_UTF8_CHARCLASS(class,str) LOAD_UTF8_CHARCLASS_NO_CHECK(class)
 128 #else
 129 #   define LOAD_UTF8_CHARCLASS(class,str) STMT_START { \
 130     if (!CAT2(PL_utf8_,class)) { \
 131         bool ok; \
 132         ENTER; save_re_context(); \
 133         ok=CAT2(is_utf8_,class)((const U8*)str); \
 134         PERL_UNUSED_VAR(ok); \
 135         assert(ok); assert(CAT2(PL_utf8_,class)); LEAVE; } } STMT_END
 136 #endif
 137
 138 /* Doesn't do an assert to verify that is correct */
 139 #define LOAD_UTF8_CHARCLASS_NO_CHECK(class) STMT_START { \
 140     if (!CAT2(PL_utf8_,class)) { \
 141         bool throw_away PERL_UNUSED_DECL; \
 142         ENTER; save_re_context(); \
 143         throw_away = CAT2(is_utf8_,class)((const U8*)" "); \
 144         LEAVE; } } STMT_END
 145
 146 #define LOAD_UTF8_CHARCLASS_ALNUM() LOAD_UTF8_CHARCLASS(alnum,"a")
 147 #define LOAD_UTF8_CHARCLASS_DIGIT() LOAD_UTF8_CHARCLASS(digit,"0")
 148 #define LOAD_UTF8_CHARCLASS_SPACE() LOAD_UTF8_CHARCLASS(space," ")
 149
 150 #define LOAD_UTF8_CHARCLASS_GCB()  /* Grapheme cluster boundaries */        \
 151         LOAD_UTF8_CHARCLASS(X_begin, " ");                                  \
 152         LOAD_UTF8_CHARCLASS(X_non_hangul, "A");                             \
 153         /* These are utf8 constants, and not utf-ebcdic constants, so the   \
 154             * assert should likely and hopefully fail on an EBCDIC machine */ \
 155         LOAD_UTF8_CHARCLASS(X_extend, "\xcc\x80"); /* U+0300 */             \
 156                                                                             \
 157         /* No asserts are done for these, in case called on an early        \
 158             * Unicode version in which they map to nothing */               \
 159         LOAD_UTF8_CHARCLASS_NO_CHECK(X_prepend);/* U+0E40 "\xe0\xb9\x80" */ \
 160         LOAD_UTF8_CHARCLASS_NO_CHECK(X_L);          /* U+1100 "\xe1\x84\x80" */ \
 161         LOAD_UTF8_CHARCLASS_NO_CHECK(X_LV_LVT_V);/* U+AC01 "\xea\xb0\x81" */\
 162         LOAD_UTF8_CHARCLASS_NO_CHECK(X_T);      /* U+11A8 "\xe1\x86\xa8" */ \
 163         LOAD_UTF8_CHARCLASS_NO_CHECK(X_V)       /* U+1160 "\xe1\x85\xa0" */
 164
 165 #define PLACEHOLDER     /* Something for the preprocessor to grab onto */
 166
 167 /* The actual code for CCC_TRY, which uses several variables from the routine
 168  * it's callable from.  It is designed to be the bulk of a case statement.
 169  * FUNC is the macro or function to call on non-utf8 targets that indicate if
 170  *      nextchr matches the class.
 171  * UTF8_TEST is the whole test string to use for utf8 targets
 172  * LOAD is what to use to test, and if not present to load in the swash for the
 173  *      class
 174  * POS_OR_NEG is either empty or ! to complement the results of FUNC or
 175  *      UTF8_TEST test.
 176  * The logic is: Fail if we're at the end-of-string; otherwise if the target is
 177  * utf8 and a variant, load the swash if necessary and test using the utf8
 178  * test.  Advance to the next character if test is ok, otherwise fail; If not
 179  * utf8 or an invariant under utf8, use the non-utf8 test, and fail if it
 180  * fails, or advance to the next character */
 181
 182 #define _CCC_TRY_CODE(POS_OR_NEG, FUNC, UTF8_TEST, CLASS, STR)                \
 183     if (locinput >= PL_regeol) {                                              \
 184         sayNO;                                                                \
 185     }                                                                         \
 186     if (utf8_target && UTF8_IS_CONTINUED(nextchr)) {                          \
 187         LOAD_UTF8_CHARCLASS(CLASS, STR);                                      \
 188         if (POS_OR_NEG (UTF8_TEST)) {                                         \
 189             sayNO;                                                            \
 190         }                                                                     \
 191         locinput += PL_utf8skip[nextchr];                                     \
 192         nextchr = UCHARAT(locinput);                                          \
 193         break;                                                                \
 194     }                                                                         \
 195     if (POS_OR_NEG (FUNC(nextchr))) {                                         \
 196         sayNO;                                                                \
 197     }                                                                         \
 198     nextchr = UCHARAT(++locinput);                                            \
 199     break;
 200
 201 /* Handle the non-locale cases for a character class and its complement.  It
 202  * calls _CCC_TRY_CODE with a ! to complement the test for the character class.
 203  * This is because that code fails when the test succeeds, so we want to have
 204  * the test fail so that the code succeeds.  The swash is stored in a
 205  * predictable PL_ place */
 206 #define _CCC_TRY_NONLOCALE(NAME,  NNAME,  FUNC,                               \
 207                            CLASS, STR)                                        \
 208     case NAME:                                                                \
 209         _CCC_TRY_CODE( !, FUNC,                                               \
 210                           cBOOL(swash_fetch(CAT2(PL_utf8_,CLASS),             \
 211                                             (U8*)locinput, TRUE)),            \
 212                           CLASS, STR)                                         \
 213     case NNAME:                                                               \
 214         _CCC_TRY_CODE(  PLACEHOLDER , FUNC,                                   \
 215                           cBOOL(swash_fetch(CAT2(PL_utf8_,CLASS),             \
 216                                             (U8*)locinput, TRUE)),            \
 217                           CLASS, STR)                                         \
 218
 219 /* Generate the case statements for both locale and non-locale character
 220  * classes in regmatch for classes that don't have special unicode semantics.
 221  * Locales don't use an immediate swash, but an intermediary special locale
 222  * function that is called on the pointer to the current place in the input
 223  * string.  That function will resolve to needing the same swash.  One might
 224  * think that because we don't know what the locale will match, we shouldn't
 225  * check with the swash loading function that it loaded properly; ie, that we
 226  * should use LOAD_UTF8_CHARCLASS_NO_CHECK for those, but what is passed to the
 227  * regular LOAD_UTF8_CHARCLASS is in non-locale terms, and so locale is
 228  * irrelevant here */
 229 #define CCC_TRY(NAME,  NNAME,  FUNC,                                          \
 230                 NAMEL, NNAMEL, LCFUNC, LCFUNC_utf8,                           \
 231                 NAMEA, NNAMEA, FUNCA,                                         \
 232                 CLASS, STR)                                                   \
 233     case NAMEL:                                                               \
 234         PL_reg_flags |= RF_tainted;                                           \
 235         _CCC_TRY_CODE( !, LCFUNC, LCFUNC_utf8((U8*)locinput), CLASS, STR)     \
 236     case NNAMEL:                                                              \
 237         PL_reg_flags |= RF_tainted;                                           \
 238         _CCC_TRY_CODE( PLACEHOLDER, LCFUNC, LCFUNC_utf8((U8*)locinput),       \
 239                        CLASS, STR)                                            \
 240     case NAMEA:                                                               \
 241         if (locinput >= PL_regeol || ! FUNCA(nextchr)) {                      \
 242             sayNO;                                                            \
 243         }                                                                     \
 244         /* Matched a utf8-invariant, so don't have to worry about utf8 */     \
 245         nextchr = UCHARAT(++locinput);                                        \
 246         break;                                                                \
 247     case NNAMEA:                                                              \
 248         if (locinput >= PL_regeol || FUNCA(nextchr)) {                        \
 249             sayNO;                                                            \
 250         }                                                                     \
 251         if (utf8_target) {                                                    \
 252             locinput += PL_utf8skip[nextchr];                                 \
 253             nextchr = UCHARAT(locinput);                                      \
 254         }                                                                     \
 255         else {                                                                \
 256             nextchr = UCHARAT(++locinput);                                    \
 257         }                                                                     \
 258         break;                                                                \
 259     /* Generate the non-locale cases */                                       \
 260     _CCC_TRY_NONLOCALE(NAME, NNAME, FUNC, CLASS, STR)
 261
 262 /* This is like CCC_TRY, but has an extra set of parameters for generating case
 263  * statements to handle separate Unicode semantics nodes */
 264 #define CCC_TRY_U(NAME,  NNAME,  FUNC,                                         \
 265                   NAMEL, NNAMEL, LCFUNC, LCFUNC_utf8,                          \
 266                   NAMEU, NNAMEU, FUNCU,                                        \
 267                   NAMEA, NNAMEA, FUNCA,                                        \
 268                   CLASS, STR)                                                  \
 269     CCC_TRY(NAME, NNAME, FUNC,                                                 \
 270             NAMEL, NNAMEL, LCFUNC, LCFUNC_utf8,                                \
 271             NAMEA, NNAMEA, FUNCA,                                              \
 272             CLASS, STR)                                                        \
 273     _CCC_TRY_NONLOCALE(NAMEU, NNAMEU, FUNCU, CLASS, STR)
 274
 275 /* TODO: Combine JUMPABLE and HAS_TEXT to cache OP(rn) */
 276
 277 /* for use after a quantifier and before an EXACT-like node -- japhy */
 278 /* it would be nice to rework regcomp.sym to generate this stuff. sigh
 279  *
 280  * NOTE that *nothing* that affects backtracking should be in here, specifically
 281  * VERBS must NOT be included. JUMPABLE is used to determine  if we can ignore a
 282  * node that is in between two EXACT like nodes when ascertaining what the required
 283  * "follow" character is. This should probably be moved to regex compile time
 284  * although it may be done at run time beause of the REF possibility - more
 285  * investigation required. -- demerphq
 286 */
 287 #define JUMPABLE(rn) (      \
 288     OP(rn) == OPEN ||       \
 289     (OP(rn) == CLOSE && (!cur_eval || cur_eval->u.eval.close_paren != ARG(rn))) || \
 290     OP(rn) == EVAL ||   \
 291     OP(rn) == SUSPEND || OP(rn) == IFMATCH || \
 292     OP(rn) == PLUS || OP(rn) == MINMOD || \
 293     OP(rn) == KEEPS || \
 294     (PL_regkind[OP(rn)] == CURLY && ARG1(rn) > 0) \
 295 )
 296 #define IS_EXACT(rn) (PL_regkind[OP(rn)] == EXACT)
 297
 298 #define HAS_TEXT(rn) ( IS_EXACT(rn) || PL_regkind[OP(rn)] == REF )
 299
 300 #if 0
 301 /* Currently these are only used when PL_regkind[OP(rn)] == EXACT so
 302    we don't need this definition. */
 303 #define IS_TEXT(rn)   ( OP(rn)==EXACT   || OP(rn)==REF   || OP(rn)==NREF   )
 304 #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 )
 305 #define IS_TEXTFL(rn) ( OP(rn)==EXACTFL || OP(rn)==REFFL || OP(rn)==NREFFL )
 306
 307 #else
 308 /* ... so we use this as its faster. */
 309 #define IS_TEXT(rn)   ( OP(rn)==EXACT   )
 310 #define IS_TEXTFU(rn)  ( OP(rn)==EXACTFU || OP(rn)==EXACTFU_SS || OP(rn)==EXACTFU_TRICKYFOLD || OP(rn) == EXACTFA)
 311 #define IS_TEXTF(rn)  ( OP(rn)==EXACTF  )
 312 #define IS_TEXTFL(rn) ( OP(rn)==EXACTFL )
 313
 314 #endif
 315
 316 /*
 317   Search for mandatory following text node; for lookahead, the text must
 318   follow but for lookbehind (rn->flags != 0) we skip to the next step.
 319 */
 320 #define FIND_NEXT_IMPT(rn) STMT_START { \
 321     while (JUMPABLE(rn)) { \
 322         const OPCODE type = OP(rn); \
 323         if (type == SUSPEND || PL_regkind[type] == CURLY) \
 324             rn = NEXTOPER(NEXTOPER(rn)); \
 325         else if (type == PLUS) \
 326             rn = NEXTOPER(rn); \
 327         else if (type == IFMATCH) \
 328             rn = (rn->flags == 0) ? NEXTOPER(NEXTOPER(rn)) : rn + ARG(rn); \
 329         else rn += NEXT_OFF(rn); \
 330     } \
 331 } STMT_END
 332
 333
 334 static void restore_pos(pTHX_ void *arg);
 335
 336 #define REGCP_PAREN_ELEMS 3
 337 #define REGCP_OTHER_ELEMS 3
 338 #define REGCP_FRAME_ELEMS 1
 339 /* REGCP_FRAME_ELEMS are not part of the REGCP_OTHER_ELEMS and
 340  * are needed for the regexp context stack bookkeeping. */
 341
 342 STATIC CHECKPOINT
 343 S_regcppush(pTHX_ const regexp *rex, I32 parenfloor)
 344 {
 345     dVAR;
 346     const int retval = PL_savestack_ix;
 347     const int paren_elems_to_push = (PL_regsize - parenfloor) * REGCP_PAREN_ELEMS;
 348     const UV total_elems = paren_elems_to_push + REGCP_OTHER_ELEMS;
 349     const UV elems_shifted = total_elems << SAVE_TIGHT_SHIFT;
 350     I32 p;
 351     GET_RE_DEBUG_FLAGS_DECL;
 352
 353     PERL_ARGS_ASSERT_REGCPPUSH;
 354
 355     if (paren_elems_to_push < 0)
 356         Perl_croak(aTHX_ "panic: paren_elems_to_push, %i < 0",
 357                    paren_elems_to_push);
 358
 359     if ((elems_shifted >> SAVE_TIGHT_SHIFT) != total_elems)
 360         Perl_croak(aTHX_ "panic: paren_elems_to_push offset %"UVuf
 361                    " out of range (%lu-%ld)",
 362                    total_elems, (unsigned long)PL_regsize, (long)parenfloor);
 363
 364     SSGROW(total_elems + REGCP_FRAME_ELEMS);
 365
 366     DEBUG_BUFFERS_r(
 367         if ((int)PL_regsize > (int)parenfloor)
 368             PerlIO_printf(Perl_debug_log,
 369                 "rex=0x%"UVxf" offs=0x%"UVxf": saving capture indices:\n",
 370                 PTR2UV(rex),
 371                 PTR2UV(rex->offs)
 372             );
 373     );
 374     for (p = parenfloor+1; p <= (I32)PL_regsize;  p++) {
 375 /* REGCP_PARENS_ELEMS are pushed per pairs of parentheses. */
 376         SSPUSHINT(rex->offs[p].end);
 377         SSPUSHINT(rex->offs[p].start);
 378         SSPUSHINT(rex->offs[p].start_tmp);
 379         DEBUG_BUFFERS_r(PerlIO_printf(Perl_debug_log,
 380             "    \\%"UVuf": %"IVdf"(%"IVdf")..%"IVdf"\n",
 381             (UV)p,
 382             (IV)rex->offs[p].start,
 383             (IV)rex->offs[p].start_tmp,
 384             (IV)rex->offs[p].end
 385         ));
 386     }
 387 /* REGCP_OTHER_ELEMS are pushed in any case, parentheses or no. */
 388     SSPUSHINT(PL_regsize);
 389     SSPUSHINT(rex->lastparen);
 390     SSPUSHINT(rex->lastcloseparen);
 391     SSPUSHUV(SAVEt_REGCONTEXT | elems_shifted); /* Magic cookie. */
 392
 393     return retval;
 394 }
 395
 396 /* These are needed since we do not localize EVAL nodes: */
 397 #define REGCP_SET(cp)                                           \
 398     DEBUG_STATE_r(                                              \
 399             PerlIO_printf(Perl_debug_log,                       \
 400                 "  Setting an EVAL scope, savestack=%"IVdf"\n", \
 401                 (IV)PL_savestack_ix));                          \
 402     cp = PL_savestack_ix
 403
 404 #define REGCP_UNWIND(cp)                                        \
 405     DEBUG_STATE_r(                                              \
 406         if (cp != PL_savestack_ix)                              \
 407             PerlIO_printf(Perl_debug_log,                       \
 408                 "  Clearing an EVAL scope, savestack=%"IVdf"..%"IVdf"\n", \
 409                 (IV)(cp), (IV)PL_savestack_ix));                \
 410     regcpblow(cp)
 411
 412 #define UNWIND_PAREN(lp, lcp)               \
 413     for (n = rex->lastparen; n > lp; n--)   \
 414         rex->offs[n].end = -1;              \
 415     rex->lastparen = n;                     \
 416     rex->lastcloseparen = lcp;
 417
 418
 419 STATIC void
 420 S_regcppop(pTHX_ regexp *rex)
 421 {
 422     dVAR;
 423     UV i;
 424     U32 paren;
 425     GET_RE_DEBUG_FLAGS_DECL;
 426
 427     PERL_ARGS_ASSERT_REGCPPOP;
 428
 429     /* Pop REGCP_OTHER_ELEMS before the parentheses loop starts. */
 430     i = SSPOPUV;
 431     assert((i & SAVE_MASK) == SAVEt_REGCONTEXT); /* Check that the magic cookie is there. */
 432     i >>= SAVE_TIGHT_SHIFT; /* Parentheses elements to pop. */
 433     rex->lastcloseparen = SSPOPINT;
 434     rex->lastparen = SSPOPINT;
 435     PL_regsize = SSPOPINT;
 436
 437     i -= REGCP_OTHER_ELEMS;
 438     /* Now restore the parentheses context. */
 439     DEBUG_BUFFERS_r(
 440         if (i || rex->lastparen + 1 <= rex->nparens)
 441             PerlIO_printf(Perl_debug_log,
 442                 "rex=0x%"UVxf" offs=0x%"UVxf": restoring capture indices to:\n",
 443                 PTR2UV(rex),
 444                 PTR2UV(rex->offs)
 445             );
 446     );
 447     paren = PL_regsize;
 448     for ( ; i > 0; i -= REGCP_PAREN_ELEMS) {
 449         I32 tmps;
 450         rex->offs[paren].start_tmp = SSPOPINT;
 451         rex->offs[paren].start = SSPOPINT;
 452         tmps = SSPOPINT;
 453         if (paren <= rex->lastparen)
 454             rex->offs[paren].end = tmps;
 455         DEBUG_BUFFERS_r( PerlIO_printf(Perl_debug_log,
 456             "    \\%"UVuf": %"IVdf"(%"IVdf")..%"IVdf"%s\n",
 457             (UV)paren,
 458             (IV)rex->offs[paren].start,
 459             (IV)rex->offs[paren].start_tmp,
 460             (IV)rex->offs[paren].end,
 461             (paren > rex->lastparen ? "(skipped)" : ""));
 462         );
 463         paren--;
 464     }
 465 #if 1
 466     /* It would seem that the similar code in regtry()
 467      * already takes care of this, and in fact it is in
 468      * a better location to since this code can #if 0-ed out
 469      * but the code in regtry() is needed or otherwise tests
 470      * requiring null fields (pat.t#187 and split.t#{13,14}
 471      * (as of patchlevel 7877)  will fail.  Then again,
 472      * this code seems to be necessary or otherwise
 473      * this erroneously leaves $1 defined: "1" =~ /^(?:(\d)x)?\d$/
 474      * --jhi updated by dapm */
 475     for (i = rex->lastparen + 1; i <= rex->nparens; i++) {
 476         if (i > PL_regsize)
 477             rex->offs[i].start = -1;
 478         rex->offs[i].end = -1;
 479         DEBUG_BUFFERS_r( PerlIO_printf(Perl_debug_log,
 480             "    \\%"UVuf": %s   ..-1 undeffing\n",
 481             (UV)i,
 482             (i > PL_regsize) ? "-1" : "  "
 483         ));
 484     }
 485 #endif
 486 }
 487
 488 /* restore the parens and associated vars at savestack position ix,
 489  * but without popping the stack */
 490
 491 STATIC void
 492 S_regcp_restore(pTHX_ regexp *rex, I32 ix)
 493 {
 494     I32 tmpix = PL_savestack_ix;
 495     PL_savestack_ix = ix;
 496     regcppop(rex);
 497     PL_savestack_ix = tmpix;
 498 }
 499
 500 #define regcpblow(cp) LEAVE_SCOPE(cp)   /* Ignores regcppush()ed data. */
 501
 502 /*
 503  * pregexec and friends
 504  */
 505
 506 #ifndef PERL_IN_XSUB_RE
 507 /*
 508  - pregexec - match a regexp against a string
 509  */
 510 I32
 511 Perl_pregexec(pTHX_ REGEXP * const prog, char* stringarg, register char *strend,
 512          char *strbeg, I32 minend, SV *screamer, U32 nosave)
 513 /* strend: pointer to null at end of string */
 514 /* strbeg: real beginning of string */
 515 /* minend: end of match must be >=minend after stringarg. */
 516 /* nosave: For optimizations. */
 517 {
 518     PERL_ARGS_ASSERT_PREGEXEC;
 519
 520     return
 521         regexec_flags(prog, stringarg, strend, strbeg, minend, screamer, NULL,
 522                       nosave ? 0 : REXEC_COPY_STR);
 523 }
 524 #endif
 525
 526 /*
 527  * Need to implement the following flags for reg_anch:
 528  *
 529  * USE_INTUIT_NOML              - Useful to call re_intuit_start() first
 530  * USE_INTUIT_ML
 531  * INTUIT_AUTORITATIVE_NOML     - Can trust a positive answer
 532  * INTUIT_AUTORITATIVE_ML
 533  * INTUIT_ONCE_NOML             - Intuit can match in one location only.
 534  * INTUIT_ONCE_ML
 535  *
 536  * Another flag for this function: SECOND_TIME (so that float substrs
 537  * with giant delta may be not rechecked).
 538  */
 539
 540 /* Assumptions: if ANCH_GPOS, then strpos is anchored. XXXX Check GPOS logic */
 541
 542 /* If SCREAM, then SvPVX_const(sv) should be compatible with strpos and strend.
 543    Otherwise, only SvCUR(sv) is used to get strbeg. */
 544
 545 /* XXXX We assume that strpos is strbeg unless sv. */
 546
 547 /* XXXX Some places assume that there is a fixed substring.
 548         An update may be needed if optimizer marks as "INTUITable"
 549         RExen without fixed substrings.  Similarly, it is assumed that
 550         lengths of all the strings are no more than minlen, thus they
 551         cannot come from lookahead.
 552         (Or minlen should take into account lookahead.)
 553   NOTE: Some of this comment is not correct. minlen does now take account
 554   of lookahead/behind. Further research is required. -- demerphq
 555
 556 */
 557
 558 /* A failure to find a constant substring means that there is no need to make
 559    an expensive call to REx engine, thus we celebrate a failure.  Similarly,
 560    finding a substring too deep into the string means that less calls to
 561    regtry() should be needed.
 562
 563    REx compiler's optimizer found 4 possible hints:
 564         a) Anchored substring;
 565         b) Fixed substring;
 566         c) Whether we are anchored (beginning-of-line or \G);
 567         d) First node (of those at offset 0) which may distinguish positions;
 568    We use a)b)d) and multiline-part of c), and try to find a position in the
 569    string which does not contradict any of them.
 570  */
 571
 572 /* Most of decisions we do here should have been done at compile time.
 573    The nodes of the REx which we used for the search should have been
 574    deleted from the finite automaton. */
 575
 576 char *
 577 Perl_re_intuit_start(pTHX_ REGEXP * const rx, SV *sv, char *strpos,
 578                      char *strend, const U32 flags, re_scream_pos_data *data)
 579 {
 580     dVAR;
 581     struct regexp *const prog = (struct regexp *)SvANY(rx);
 582     I32 start_shift = 0;
 583     /* Should be nonnegative! */
 584     I32 end_shift   = 0;
 585     char *s;
 586     SV *check;
 587     char *strbeg;
 588     char *t;
 589     const bool utf8_target = (sv && SvUTF8(sv)) ? 1 : 0; /* if no sv we have to assume bytes */
 590     I32 ml_anch;
 591     char *other_last = NULL;    /* other substr checked before this */
 592     char *check_at = NULL;              /* check substr found at this pos */
 593     char *checked_upto = NULL;          /* how far into the string we have already checked using find_byclass*/
 594     const I32 multiline = prog->extflags & RXf_PMf_MULTILINE;
 595     RXi_GET_DECL(prog,progi);
 596 #ifdef DEBUGGING
 597     const char * const i_strpos = strpos;
 598 #endif
 599     GET_RE_DEBUG_FLAGS_DECL;
 600
 601     PERL_ARGS_ASSERT_RE_INTUIT_START;
 602     PERL_UNUSED_ARG(flags);
 603     PERL_UNUSED_ARG(data);
 604
 605     RX_MATCH_UTF8_set(rx,utf8_target);
 606
 607     if (RX_UTF8(rx)) {
 608         PL_reg_flags |= RF_utf8;
 609     }
 610     DEBUG_EXECUTE_r(
 611         debug_start_match(rx, utf8_target, strpos, strend,
 612             sv ? "Guessing start of match in sv for"
 613                : "Guessing start of match in string for");
 614               );
 615
 616     /* CHR_DIST() would be more correct here but it makes things slow. */
 617     if (prog->minlen > strend - strpos) {
 618         DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
 619                               "String too short... [re_intuit_start]\n"));
 620         goto fail;
 621     }
 622
 623     strbeg = (sv && SvPOK(sv)) ? strend - SvCUR(sv) : strpos;
 624     PL_regeol = strend;
 625     if (utf8_target) {
 626         if (!prog->check_utf8 && prog->check_substr)
 627             to_utf8_substr(prog);
 628         check = prog->check_utf8;
 629     } else {
 630         if (!prog->check_substr && prog->check_utf8)
 631             to_byte_substr(prog);
 632         check = prog->check_substr;
 633     }
 634     if (check == &PL_sv_undef) {
 635         DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
 636                 "Non-utf8 string cannot match utf8 check string\n"));
 637         goto fail;
 638     }
 639     if (prog->extflags & RXf_ANCH) {    /* Match at beg-of-str or after \n */
 640         ml_anch = !( (prog->extflags & RXf_ANCH_SINGLE)
 641                      || ( (prog->extflags & RXf_ANCH_BOL)
 642                           && !multiline ) );    /* Check after \n? */
 643
 644         if (!ml_anch) {
 645           if ( !(prog->extflags & RXf_ANCH_GPOS) /* Checked by the caller */
 646                 && !(prog->intflags & PREGf_IMPLICIT) /* not a real BOL */
 647                /* SvCUR is not set on references: SvRV and SvPVX_const overlap */
 648                && sv && !SvROK(sv)
 649                && (strpos != strbeg)) {
 650               DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Not at start...\n"));
 651               goto fail;
 652           }
 653           if (prog->check_offset_min == prog->check_offset_max &&
 654               !(prog->extflags & RXf_CANY_SEEN)) {
 655             /* Substring at constant offset from beg-of-str... */
 656             I32 slen;
 657
 658             s = HOP3c(strpos, prog->check_offset_min, strend);
 659
 660             if (SvTAIL(check)) {
 661                 slen = SvCUR(check);    /* >= 1 */
 662
 663                 if ( strend - s > slen || strend - s < slen - 1
 664                      || (strend - s == slen && strend[-1] != '\n')) {
 665                     DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "String too long...\n"));
 666                     goto fail_finish;
 667                 }
 668                 /* Now should match s[0..slen-2] */
 669                 slen--;
 670                 if (slen && (*SvPVX_const(check) != *s
 671                              || (slen > 1
 672                                  && memNE(SvPVX_const(check), s, slen)))) {
 673                   report_neq:
 674                     DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "String not equal...\n"));
 675                     goto fail_finish;
 676                 }
 677             }
 678             else if (*SvPVX_const(check) != *s
 679                      || ((slen = SvCUR(check)) > 1
 680                          && memNE(SvPVX_const(check), s, slen)))
 681                 goto report_neq;
 682             check_at = s;
 683             goto success_at_start;
 684           }
 685         }
 686         /* Match is anchored, but substr is not anchored wrt beg-of-str. */
 687         s = strpos;
 688         start_shift = prog->check_offset_min; /* okay to underestimate on CC */
 689         end_shift = prog->check_end_shift;
 690
 691         if (!ml_anch) {
 692             const I32 end = prog->check_offset_max + CHR_SVLEN(check)
 693                                          - (SvTAIL(check) != 0);
 694             const I32 eshift = CHR_DIST((U8*)strend, (U8*)s) - end;
 695
 696             if (end_shift < eshift)
 697                 end_shift = eshift;
 698         }
 699     }
 700     else {                              /* Can match at random position */
 701         ml_anch = 0;
 702         s = strpos;
 703         start_shift = prog->check_offset_min;  /* okay to underestimate on CC */
 704         end_shift = prog->check_end_shift;
 705
 706         /* end shift should be non negative here */
 707     }
 708
 709 #ifdef QDEBUGGING       /* 7/99: reports of failure (with the older version) */
 710     if (end_shift < 0)
 711         Perl_croak(aTHX_ "panic: end_shift: %"IVdf" pattern:\n%s\n ",
 712                    (IV)end_shift, RX_PRECOMP(prog));
 713 #endif
 714
 715   restart:
 716     /* Find a possible match in the region s..strend by looking for
 717        the "check" substring in the region corrected by start/end_shift. */
 718
 719     {
 720         I32 srch_start_shift = start_shift;
 721         I32 srch_end_shift = end_shift;
 722         U8* start_point;
 723         U8* end_point;
 724         if (srch_start_shift < 0 && strbeg - s > srch_start_shift) {
 725             srch_end_shift -= ((strbeg - s) - srch_start_shift);
 726             srch_start_shift = strbeg - s;
 727         }
 728     DEBUG_OPTIMISE_MORE_r({
 729         PerlIO_printf(Perl_debug_log, "Check offset min: %"IVdf" Start shift: %"IVdf" End shift %"IVdf" Real End Shift: %"IVdf"\n",
 730             (IV)prog->check_offset_min,
 731             (IV)srch_start_shift,
 732             (IV)srch_end_shift,
 733             (IV)prog->check_end_shift);
 734     });
 735
 736         if (prog->extflags & RXf_CANY_SEEN) {
 737             start_point= (U8*)(s + srch_start_shift);
 738             end_point= (U8*)(strend - srch_end_shift);
 739         } else {
 740             start_point= HOP3(s, srch_start_shift, srch_start_shift < 0 ? strbeg : strend);
 741             end_point= HOP3(strend, -srch_end_shift, strbeg);
 742         }
 743         DEBUG_OPTIMISE_MORE_r({
 744             PerlIO_printf(Perl_debug_log, "fbm_instr len=%d str=<%.*s>\n",
 745                 (int)(end_point - start_point),
 746                 (int)(end_point - start_point) > 20 ? 20 : (int)(end_point - start_point),
 747                 start_point);
 748         });
 749
 750         s = fbm_instr( start_point, end_point,
 751                       check, multiline ? FBMrf_MULTILINE : 0);
 752     }
 753     /* Update the count-of-usability, remove useless subpatterns,
 754         unshift s.  */
 755
 756     DEBUG_EXECUTE_r({
 757         RE_PV_QUOTED_DECL(quoted, utf8_target, PERL_DEBUG_PAD_ZERO(0),
 758             SvPVX_const(check), RE_SV_DUMPLEN(check), 30);
 759         PerlIO_printf(Perl_debug_log, "%s %s substr %s%s%s",
 760                           (s ? "Found" : "Did not find"),
 761             (check == (utf8_target ? prog->anchored_utf8 : prog->anchored_substr)
 762                 ? "anchored" : "floating"),
 763             quoted,
 764             RE_SV_TAIL(check),
 765             (s ? " at offset " : "...\n") );
 766     });
 767
 768     if (!s)
 769         goto fail_finish;
 770     /* Finish the diagnostic message */
 771     DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "%ld...\n", (long)(s - i_strpos)) );
 772
 773     /* XXX dmq: first branch is for positive lookbehind...
 774        Our check string is offset from the beginning of the pattern.
 775        So we need to do any stclass tests offset forward from that
 776        point. I think. :-(
 777      */
 778
 779
 780
 781     check_at=s;
 782
 783
 784     /* Got a candidate.  Check MBOL anchoring, and the *other* substr.
 785        Start with the other substr.
 786        XXXX no SCREAM optimization yet - and a very coarse implementation
 787        XXXX /ttx+/ results in anchored="ttx", floating="x".  floating will
 788                 *always* match.  Probably should be marked during compile...
 789        Probably it is right to do no SCREAM here...
 790      */
 791
 792     if (utf8_target ? (prog->float_utf8 && prog->anchored_utf8)
 793                 : (prog->float_substr && prog->anchored_substr))
 794     {
 795         /* Take into account the "other" substring. */
 796         /* XXXX May be hopelessly wrong for UTF... */
 797         if (!other_last)
 798             other_last = strpos;
 799         if (check == (utf8_target ? prog->float_utf8 : prog->float_substr)) {
 800           do_other_anchored:
 801             {
 802                 char * const last = HOP3c(s, -start_shift, strbeg);
 803                 char *last1, *last2;
 804                 char * const saved_s = s;
 805                 SV* must;
 806
 807                 t = s - prog->check_offset_max;
 808                 if (s - strpos > prog->check_offset_max  /* signed-corrected t > strpos */
 809                     && (!utf8_target
 810                         || ((t = (char*)reghopmaybe3((U8*)s, -(prog->check_offset_max), (U8*)strpos))
 811                             && t > strpos)))
 812                     NOOP;
 813                 else
 814                     t = strpos;
 815                 t = HOP3c(t, prog->anchored_offset, strend);
 816                 if (t < other_last)     /* These positions already checked */
 817                     t = other_last;
 818                 last2 = last1 = HOP3c(strend, -prog->minlen, strbeg);
 819                 if (last < last1)
 820                     last1 = last;
 821                 /* XXXX It is not documented what units *_offsets are in.
 822                    We assume bytes, but this is clearly wrong.
 823                    Meaning this code needs to be carefully reviewed for errors.
 824                    dmq.
 825                   */
 826
 827                 /* On end-of-str: see comment below. */
 828                 must = utf8_target ? prog->anchored_utf8 : prog->anchored_substr;
 829                 if (must == &PL_sv_undef) {
 830                     s = (char*)NULL;
 831                     DEBUG_r(must = prog->anchored_utf8);        /* for debug */
 832                 }
 833                 else
 834                     s = fbm_instr(
 835                         (unsigned char*)t,
 836                         HOP3(HOP3(last1, prog->anchored_offset, strend)
 837                                 + SvCUR(must), -(SvTAIL(must)!=0), strbeg),
 838                         must,
 839                         multiline ? FBMrf_MULTILINE : 0
 840                     );
 841                 DEBUG_EXECUTE_r({
 842                     RE_PV_QUOTED_DECL(quoted, utf8_target, PERL_DEBUG_PAD_ZERO(0),
 843                         SvPVX_const(must), RE_SV_DUMPLEN(must), 30);
 844                     PerlIO_printf(Perl_debug_log, "%s anchored substr %s%s",
 845                         (s ? "Found" : "Contradicts"),
 846                         quoted, RE_SV_TAIL(must));
 847                 });
 848
 849
 850                 if (!s) {
 851                     if (last1 >= last2) {
 852                         DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
 853                                                 ", giving up...\n"));
 854                         goto fail_finish;
 855                     }
 856                     DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
 857                         ", trying floating at offset %ld...\n",
 858                         (long)(HOP3c(saved_s, 1, strend) - i_strpos)));
 859                     other_last = HOP3c(last1, prog->anchored_offset+1, strend);
 860                     s = HOP3c(last, 1, strend);
 861                     goto restart;
 862                 }
 863                 else {
 864                     DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, " at offset %ld...\n",
 865                           (long)(s - i_strpos)));
 866                     t = HOP3c(s, -prog->anchored_offset, strbeg);
 867                     other_last = HOP3c(s, 1, strend);
 868                     s = saved_s;
 869                     if (t == strpos)
 870                         goto try_at_start;
 871                     goto try_at_offset;
 872                 }
 873             }
 874         }
 875         else {          /* Take into account the floating substring. */
 876             char *last, *last1;
 877             char * const saved_s = s;
 878             SV* must;
 879
 880             t = HOP3c(s, -start_shift, strbeg);
 881             last1 = last =
 882                 HOP3c(strend, -prog->minlen + prog->float_min_offset, strbeg);
 883             if (CHR_DIST((U8*)last, (U8*)t) > prog->float_max_offset)
 884                 last = HOP3c(t, prog->float_max_offset, strend);
 885             s = HOP3c(t, prog->float_min_offset, strend);
 886             if (s < other_last)
 887                 s = other_last;
 888  /* XXXX It is not documented what units *_offsets are in.  Assume bytes.  */
 889             must = utf8_target ? prog->float_utf8 : prog->float_substr;
 890             /* fbm_instr() takes into account exact value of end-of-str
 891                if the check is SvTAIL(ed).  Since false positives are OK,
 892                and end-of-str is not later than strend we are OK. */
 893             if (must == &PL_sv_undef) {
 894                 s = (char*)NULL;
 895                 DEBUG_r(must = prog->float_utf8);       /* for debug message */
 896             }
 897             else
 898                 s = fbm_instr((unsigned char*)s,
 899                               (unsigned char*)last + SvCUR(must)
 900                                   - (SvTAIL(must)!=0),
 901                               must, multiline ? FBMrf_MULTILINE : 0);
 902             DEBUG_EXECUTE_r({
 903                 RE_PV_QUOTED_DECL(quoted, utf8_target, PERL_DEBUG_PAD_ZERO(0),
 904                     SvPVX_const(must), RE_SV_DUMPLEN(must), 30);
 905                 PerlIO_printf(Perl_debug_log, "%s floating substr %s%s",
 906                     (s ? "Found" : "Contradicts"),
 907                     quoted, RE_SV_TAIL(must));
 908             });
 909             if (!s) {
 910                 if (last1 == last) {
 911                     DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
 912                                             ", giving up...\n"));
 913                     goto fail_finish;
 914                 }
 915                 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
 916                     ", trying anchored starting at offset %ld...\n",
 917                     (long)(saved_s + 1 - i_strpos)));
 918                 other_last = last;
 919                 s = HOP3c(t, 1, strend);
 920                 goto restart;
 921             }
 922             else {
 923                 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, " at offset %ld...\n",
 924                       (long)(s - i_strpos)));
 925                 other_last = s; /* Fix this later. --Hugo */
 926                 s = saved_s;
 927                 if (t == strpos)
 928                     goto try_at_start;
 929                 goto try_at_offset;
 930             }
 931         }
 932     }
 933
 934
 935     t= (char*)HOP3( s, -prog->check_offset_max, (prog->check_offset_max<0) ? strend : strpos);
 936
 937     DEBUG_OPTIMISE_MORE_r(
 938         PerlIO_printf(Perl_debug_log,
 939             "Check offset min:%"IVdf" max:%"IVdf" S:%"IVdf" t:%"IVdf" D:%"IVdf" end:%"IVdf"\n",
 940             (IV)prog->check_offset_min,
 941             (IV)prog->check_offset_max,
 942             (IV)(s-strpos),
 943             (IV)(t-strpos),
 944             (IV)(t-s),
 945             (IV)(strend-strpos)
 946         )
 947     );
 948
 949     if (s - strpos > prog->check_offset_max  /* signed-corrected t > strpos */
 950         && (!utf8_target
 951             || ((t = (char*)reghopmaybe3((U8*)s, -prog->check_offset_max, (U8*) ((prog->check_offset_max<0) ? strend : strpos)))
 952                  && t > strpos)))
 953     {
 954         /* Fixed substring is found far enough so that the match
 955            cannot start at strpos. */
 956       try_at_offset:
 957         if (ml_anch && t[-1] != '\n') {
 958             /* Eventually fbm_*() should handle this, but often
 959                anchored_offset is not 0, so this check will not be wasted. */
 960             /* XXXX In the code below we prefer to look for "^" even in
 961                presence of anchored substrings.  And we search even
 962                beyond the found float position.  These pessimizations
 963                are historical artefacts only.  */
 964           find_anchor:
 965             while (t < strend - prog->minlen) {
 966                 if (*t == '\n') {
 967                     if (t < check_at - prog->check_offset_min) {
 968                         if (utf8_target ? prog->anchored_utf8 : prog->anchored_substr) {
 969                             /* Since we moved from the found position,
 970                                we definitely contradict the found anchored
 971                                substr.  Due to the above check we do not
 972                                contradict "check" substr.
 973                                Thus we can arrive here only if check substr
 974                                is float.  Redo checking for "other"=="fixed".
 975                              */
 976                             strpos = t + 1;
 977                             DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Found /%s^%s/m at offset %ld, rescanning for anchored from offset %ld...\n",
 978                                 PL_colors[0], PL_colors[1], (long)(strpos - i_strpos), (long)(strpos - i_strpos + prog->anchored_offset)));
 979                             goto do_other_anchored;
 980                         }
 981                         /* We don't contradict the found floating substring. */
 982                         /* XXXX Why not check for STCLASS? */
 983                         s = t + 1;
 984                         DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Found /%s^%s/m at offset %ld...\n",
 985                             PL_colors[0], PL_colors[1], (long)(s - i_strpos)));
 986                         goto set_useful;
 987                     }
 988                     /* Position contradicts check-string */
 989                     /* XXXX probably better to look for check-string
 990                        than for "\n", so one should lower the limit for t? */
 991                     DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Found /%s^%s/m, restarting lookup for check-string at offset %ld...\n",
 992                         PL_colors[0], PL_colors[1], (long)(t + 1 - i_strpos)));
 993                     other_last = strpos = s = t + 1;
 994                     goto restart;
 995                 }
 996                 t++;
 997             }
 998             DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Did not find /%s^%s/m...\n",
 999                         PL_colors[0], PL_colors[1]));
1000             goto fail_finish;
1001         }
1002         else {
1003             DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Starting position does not contradict /%s^%s/m...\n",
1004                         PL_colors[0], PL_colors[1]));
1005         }
1006         s = t;
1007       set_useful:
1008         ++BmUSEFUL(utf8_target ? prog->check_utf8 : prog->check_substr);        /* hooray/5 */
1009     }
1010     else {
1011         /* The found string does not prohibit matching at strpos,
1012            - no optimization of calling REx engine can be performed,
1013            unless it was an MBOL and we are not after MBOL,
1014            or a future STCLASS check will fail this. */
1015       try_at_start:
1016         /* Even in this situation we may use MBOL flag if strpos is offset
1017            wrt the start of the string. */
1018         if (ml_anch && sv && !SvROK(sv) /* See prev comment on SvROK */
1019             && (strpos != strbeg) && strpos[-1] != '\n'
1020             /* May be due to an implicit anchor of m{.*foo}  */
1021             && !(prog->intflags & PREGf_IMPLICIT))
1022         {
1023             t = strpos;
1024             goto find_anchor;
1025         }
1026         DEBUG_EXECUTE_r( if (ml_anch)
1027             PerlIO_printf(Perl_debug_log, "Position at offset %ld does not contradict /%s^%s/m...\n",
1028                           (long)(strpos - i_strpos), PL_colors[0], PL_colors[1]);
1029         );
1030       success_at_start:
1031         if (!(prog->intflags & PREGf_NAUGHTY)   /* XXXX If strpos moved? */
1032             && (utf8_target ? (
1033                 prog->check_utf8                /* Could be deleted already */
1034                 && --BmUSEFUL(prog->check_utf8) < 0
1035                 && (prog->check_utf8 == prog->float_utf8)
1036             ) : (
1037                 prog->check_substr              /* Could be deleted already */
1038                 && --BmUSEFUL(prog->check_substr) < 0
1039                 && (prog->check_substr == prog->float_substr)
1040             )))
1041         {
1042             /* If flags & SOMETHING - do not do it many times on the same match */
1043             DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "... Disabling check substring...\n"));
1044             /* XXX Does the destruction order has to change with utf8_target? */
1045             SvREFCNT_dec(utf8_target ? prog->check_utf8 : prog->check_substr);
1046             SvREFCNT_dec(utf8_target ? prog->check_substr : prog->check_utf8);
1047             prog->check_substr = prog->check_utf8 = NULL;       /* disable */
1048             prog->float_substr = prog->float_utf8 = NULL;       /* clear */
1049             check = NULL;                       /* abort */
1050             s = strpos;
1051             /* XXXX If the check string was an implicit check MBOL, then we need to unset the relevant flag
1052                     see http://bugs.activestate.com/show_bug.cgi?id=87173 */
1053             if (prog->intflags & PREGf_IMPLICIT)
1054                 prog->extflags &= ~RXf_ANCH_MBOL;
1055             /* XXXX This is a remnant of the old implementation.  It
1056                     looks wasteful, since now INTUIT can use many
1057                     other heuristics. */
1058             prog->extflags &= ~RXf_USE_INTUIT;
1059             /* XXXX What other flags might need to be cleared in this branch? */
1060         }
1061         else
1062             s = strpos;
1063     }
1064
1065     /* Last resort... */
1066     /* XXXX BmUSEFUL already changed, maybe multiple change is meaningful... */
1067     /* trie stclasses are too expensive to use here, we are better off to
1068        leave it to regmatch itself */
1069     if (progi->regstclass && PL_regkind[OP(progi->regstclass)]!=TRIE) {
1070         /* minlen == 0 is possible if regstclass is \b or \B,
1071            and the fixed substr is ''$.
1072            Since minlen is already taken into account, s+1 is before strend;
1073            accidentally, minlen >= 1 guaranties no false positives at s + 1
1074            even for \b or \B.  But (minlen? 1 : 0) below assumes that
1075            regstclass does not come from lookahead...  */
1076         /* If regstclass takes bytelength more than 1: If charlength==1, OK.
1077            This leaves EXACTF-ish only, which are dealt with in find_byclass().  */
1078         const U8* const str = (U8*)STRING(progi->regstclass);
1079         const int cl_l = (PL_regkind[OP(progi->regstclass)] == EXACT
1080                     ? CHR_DIST(str+STR_LEN(progi->regstclass), str)
1081                     : 1);
1082         char * endpos;
1083         if (prog->anchored_substr || prog->anchored_utf8 || ml_anch)
1084             endpos= HOP3c(s, (prog->minlen ? cl_l : 0), strend);
1085         else if (prog->float_substr || prog->float_utf8)
1086             endpos= HOP3c(HOP3c(check_at, -start_shift, strbeg), cl_l, strend);
1087         else
1088             endpos= strend;
1089
1090         if (checked_upto < s)
1091            checked_upto = s;
1092         DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "start_shift: %"IVdf" check_at: %"IVdf" s: %"IVdf" endpos: %"IVdf" checked_upto: %"IVdf"\n",
1093                                       (IV)start_shift, (IV)(check_at - strbeg), (IV)(s - strbeg), (IV)(endpos - strbeg), (IV)(checked_upto- strbeg)));
1094
1095         t = s;
1096         s = find_byclass(prog, progi->regstclass, checked_upto, endpos, NULL);
1097         if (s) {
1098             checked_upto = s;
1099         } else {
1100 #ifdef DEBUGGING
1101             const char *what = NULL;
1102 #endif
1103             if (endpos == strend) {
1104                 DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
1105                                 "Could not match STCLASS...\n") );
1106                 goto fail;
1107             }
1108             DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
1109                                    "This position contradicts STCLASS...\n") );
1110             if ((prog->extflags & RXf_ANCH) && !ml_anch)
1111                 goto fail;
1112             checked_upto = HOPBACKc(endpos, start_shift);
1113             DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "start_shift: %"IVdf" check_at: %"IVdf" endpos: %"IVdf" checked_upto: %"IVdf"\n",
1114                                       (IV)start_shift, (IV)(check_at - strbeg), (IV)(endpos - strbeg), (IV)(checked_upto- strbeg)));
1115             /* Contradict one of substrings */
1116             if (prog->anchored_substr || prog->anchored_utf8) {
1117                 if ((utf8_target ? prog->anchored_utf8 : prog->anchored_substr) == check) {
1118                     DEBUG_EXECUTE_r( what = "anchored" );
1119                   hop_and_restart:
1120                     s = HOP3c(t, 1, strend);
1121                     if (s + start_shift + end_shift > strend) {
1122                         /* XXXX Should be taken into account earlier? */
1123                         DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
1124                                                "Could not match STCLASS...\n") );
1125                         goto fail;
1126                     }
1127                     if (!check)
1128                         goto giveup;
1129                     DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
1130                                 "Looking for %s substr starting at offset %ld...\n",
1131                                  what, (long)(s + start_shift - i_strpos)) );
1132                     goto restart;
1133                 }
1134                 /* Have both, check_string is floating */
1135                 if (t + start_shift >= check_at) /* Contradicts floating=check */
1136                     goto retry_floating_check;
1137                 /* Recheck anchored substring, but not floating... */
1138                 s = check_at;
1139                 if (!check)
1140                     goto giveup;
1141                 DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
1142                           "Looking for anchored substr starting at offset %ld...\n",
1143                           (long)(other_last - i_strpos)) );
1144                 goto do_other_anchored;
1145             }
1146             /* Another way we could have checked stclass at the
1147                current position only: */
1148             if (ml_anch) {
1149                 s = t = t + 1;
1150                 if (!check)
1151                     goto giveup;
1152                 DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
1153                           "Looking for /%s^%s/m starting at offset %ld...\n",
1154                           PL_colors[0], PL_colors[1], (long)(t - i_strpos)) );
1155                 goto try_at_offset;
1156             }
1157             if (!(utf8_target ? prog->float_utf8 : prog->float_substr)) /* Could have been deleted */
1158                 goto fail;
1159             /* Check is floating substring. */
1160           retry_floating_check:
1161             t = check_at - start_shift;
1162             DEBUG_EXECUTE_r( what = "floating" );
1163             goto hop_and_restart;
1164         }
1165         if (t != s) {
1166             DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
1167                         "By STCLASS: moving %ld --> %ld\n",
1168                                   (long)(t - i_strpos), (long)(s - i_strpos))
1169                    );
1170         }
1171         else {
1172             DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
1173                                   "Does not contradict STCLASS...\n");
1174                    );
1175         }
1176     }
1177   giveup:
1178     DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "%s%s:%s match at offset %ld\n",
1179                           PL_colors[4], (check ? "Guessed" : "Giving up"),
1180                           PL_colors[5], (long)(s - i_strpos)) );
1181     return s;
1182
1183   fail_finish:                          /* Substring not found */
1184     if (prog->check_substr || prog->check_utf8)         /* could be removed already */
1185         BmUSEFUL(utf8_target ? prog->check_utf8 : prog->check_substr) += 5; /* hooray */
1186   fail:
1187     DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "%sMatch rejected by optimizer%s\n",
1188                           PL_colors[4], PL_colors[5]));
1189     return NULL;
1190 }
1191
1192 #define DECL_TRIE_TYPE(scan) \
1193     const enum { trie_plain, trie_utf8, trie_utf8_fold, trie_latin_utf8_fold } \
1194                     trie_type = ((scan->flags == EXACT) \
1195                               ? (utf8_target ? trie_utf8 : trie_plain) \
1196                               : (utf8_target ? trie_utf8_fold : trie_latin_utf8_fold))
1197
1198 #define REXEC_TRIE_READ_CHAR(trie_type, trie, widecharmap, uc, uscan, len,          \
1199 uvc, charid, foldlen, foldbuf, uniflags) STMT_START {                               \
1200     STRLEN skiplen;                                                                 \
1201     switch (trie_type) {                                                            \
1202     case trie_utf8_fold:                                                            \
1203         if ( foldlen>0 ) {                                                          \
1204             uvc = utf8n_to_uvuni( (const U8*) uscan, UTF8_MAXLEN, &len, uniflags ); \
1205             foldlen -= len;                                                         \
1206             uscan += len;                                                           \
1207             len=0;                                                                  \
1208         } else {                                                                    \
1209             uvc = to_utf8_fold( (const U8*) uc, foldbuf, &foldlen );                \
1210             len = UTF8SKIP(uc);                                                     \
1211             skiplen = UNISKIP( uvc );                                               \
1212             foldlen -= skiplen;                                                     \
1213             uscan = foldbuf + skiplen;                                              \
1214         }                                                                           \
1215         break;                                                                      \
1216     case trie_latin_utf8_fold:                                                      \
1217         if ( foldlen>0 ) {                                                          \
1218             uvc = utf8n_to_uvuni( (const U8*) uscan, UTF8_MAXLEN, &len, uniflags ); \
1219             foldlen -= len;                                                         \
1220             uscan += len;                                                           \
1221             len=0;                                                                  \
1222         } else {                                                                    \
1223             len = 1;                                                                \
1224             uvc = _to_fold_latin1( (U8) *uc, foldbuf, &foldlen, 1);                 \
1225             skiplen = UNISKIP( uvc );                                               \
1226             foldlen -= skiplen;                                                     \
1227             uscan = foldbuf + skiplen;                                              \
1228         }                                                                           \
1229         break;                                                                      \
1230     case trie_utf8:                                                                 \
1231         uvc = utf8n_to_uvuni( (const U8*) uc, UTF8_MAXLEN, &len, uniflags );        \
1232         break;                                                                      \
1233     case trie_plain:                                                                \
1234         uvc = (UV)*uc;                                                              \
1235         len = 1;                                                                    \
1236     }                                                                               \
1237     if (uvc < 256) {                                                                \
1238         charid = trie->charmap[ uvc ];                                              \
1239     }                                                                               \
1240     else {                                                                          \
1241         charid = 0;                                                                 \
1242         if (widecharmap) {                                                          \
1243             SV** const svpp = hv_fetch(widecharmap,                                 \
1244                         (char*)&uvc, sizeof(UV), 0);                                \
1245             if (svpp)                                                               \
1246                 charid = (U16)SvIV(*svpp);                                          \
1247         }                                                                           \
1248     }                                                                               \
1249 } STMT_END
1250
1251 #define REXEC_FBC_EXACTISH_SCAN(CoNd)                     \
1252 STMT_START {                                              \
1253     while (s <= e) {                                      \
1254         if ( (CoNd)                                       \
1255              && (ln == 1 || folder(s, pat_string, ln))    \
1256              && (!reginfo || regtry(reginfo, &s)) )       \
1257             goto got_it;                                  \
1258         s++;                                              \
1259     }                                                     \
1260 } STMT_END
1261
1262 #define REXEC_FBC_UTF8_SCAN(CoDe)                     \
1263 STMT_START {                                          \
1264     while (s + (uskip = UTF8SKIP(s)) <= strend) {     \
1265         CoDe                                          \
1266         s += uskip;                                   \
1267     }                                                 \
1268 } STMT_END
1269
1270 #define REXEC_FBC_SCAN(CoDe)                          \
1271 STMT_START {                                          \
1272     while (s < strend) {                              \
1273         CoDe                                          \
1274         s++;                                          \
1275     }                                                 \
1276 } STMT_END
1277
1278 #define REXEC_FBC_UTF8_CLASS_SCAN(CoNd)               \
1279 REXEC_FBC_UTF8_SCAN(                                  \
1280     if (CoNd) {                                       \
1281         if (tmp && (!reginfo || regtry(reginfo, &s)))  \
1282             goto got_it;                              \
1283         else                                          \
1284             tmp = doevery;                            \
1285     }                                                 \
1286     else                                              \
1287         tmp = 1;                                      \
1288 )
1289
1290 #define REXEC_FBC_CLASS_SCAN(CoNd)                    \
1291 REXEC_FBC_SCAN(                                       \
1292     if (CoNd) {                                       \
1293         if (tmp && (!reginfo || regtry(reginfo, &s)))  \
1294             goto got_it;                              \
1295         else                                          \
1296             tmp = doevery;                            \
1297     }                                                 \
1298     else                                              \
1299         tmp = 1;                                      \
1300 )
1301
1302 #define REXEC_FBC_TRYIT               \
1303 if ((!reginfo || regtry(reginfo, &s))) \
1304     goto got_it
1305
1306 #define REXEC_FBC_CSCAN(CoNdUtF8,CoNd)                         \
1307     if (utf8_target) {                                             \
1308         REXEC_FBC_UTF8_CLASS_SCAN(CoNdUtF8);                   \
1309     }                                                          \
1310     else {                                                     \
1311         REXEC_FBC_CLASS_SCAN(CoNd);                            \
1312     }
1313
1314 #define REXEC_FBC_CSCAN_PRELOAD(UtFpReLoAd,CoNdUtF8,CoNd)      \
1315     if (utf8_target) {                                             \
1316         UtFpReLoAd;                                            \
1317         REXEC_FBC_UTF8_CLASS_SCAN(CoNdUtF8);                   \
1318     }                                                          \
1319     else {                                                     \
1320         REXEC_FBC_CLASS_SCAN(CoNd);                            \
1321     }
1322
1323 #define REXEC_FBC_CSCAN_TAINT(CoNdUtF8,CoNd)                   \
1324     PL_reg_flags |= RF_tainted;                                \
1325     if (utf8_target) {                                             \
1326         REXEC_FBC_UTF8_CLASS_SCAN(CoNdUtF8);                   \
1327     }                                                          \
1328     else {                                                     \
1329         REXEC_FBC_CLASS_SCAN(CoNd);                            \
1330     }
1331
1332 #define DUMP_EXEC_POS(li,s,doutf8) \
1333     dump_exec_pos(li,s,(PL_regeol),(PL_bostr),(PL_reg_starttry),doutf8)
1334
1335
1336 #define UTF8_NOLOAD(TEST_NON_UTF8, IF_SUCCESS, IF_FAIL) \
1337         tmp = (s != PL_bostr) ? UCHARAT(s - 1) : '\n';                         \
1338         tmp = TEST_NON_UTF8(tmp);                                              \
1339         REXEC_FBC_UTF8_SCAN(                                                   \
1340             if (tmp == ! TEST_NON_UTF8((U8) *s)) { \
1341                 tmp = !tmp;                                                    \
1342                 IF_SUCCESS;                                                    \
1343             }                                                                  \
1344             else {                                                             \
1345                 IF_FAIL;                                                       \
1346             }                                                                  \
1347         );                                                                     \
1348
1349 #define UTF8_LOAD(TeSt1_UtF8, TeSt2_UtF8, IF_SUCCESS, IF_FAIL) \
1350         if (s == PL_bostr) {                                                   \
1351             tmp = '\n';                                                        \
1352         }                                                                      \
1353         else {                                                                 \
1354             U8 * const r = reghop3((U8*)s, -1, (U8*)PL_bostr);                 \
1355             tmp = utf8n_to_uvchr(r, UTF8SKIP(r), 0, UTF8_ALLOW_DEFAULT);       \
1356         }                                                                      \
1357         tmp = TeSt1_UtF8;                                                      \
1358         LOAD_UTF8_CHARCLASS_ALNUM();                                                                \
1359         REXEC_FBC_UTF8_SCAN(                                                   \
1360             if (tmp == ! (TeSt2_UtF8)) { \
1361                 tmp = !tmp;                                                    \
1362                 IF_SUCCESS;                                                    \
1363             }                                                                  \
1364             else {                                                             \
1365                 IF_FAIL;                                                       \
1366             }                                                                  \
1367         );                                                                     \
1368
1369 /* The only difference between the BOUND and NBOUND cases is that
1370  * REXEC_FBC_TRYIT is called when matched in BOUND, and when non-matched in
1371  * NBOUND.  This is accomplished by passing it in either the if or else clause,
1372  * with the other one being empty */
1373 #define FBC_BOUND(TEST_NON_UTF8, TEST1_UTF8, TEST2_UTF8) \
1374     FBC_BOUND_COMMON(UTF8_LOAD(TEST1_UTF8, TEST2_UTF8, REXEC_FBC_TRYIT, PLACEHOLDER), TEST_NON_UTF8, REXEC_FBC_TRYIT, PLACEHOLDER)
1375
1376 #define FBC_BOUND_NOLOAD(TEST_NON_UTF8, TEST1_UTF8, TEST2_UTF8) \
1377     FBC_BOUND_COMMON(UTF8_NOLOAD(TEST_NON_UTF8, REXEC_FBC_TRYIT, PLACEHOLDER), TEST_NON_UTF8, REXEC_FBC_TRYIT, PLACEHOLDER)
1378
1379 #define FBC_NBOUND(TEST_NON_UTF8, TEST1_UTF8, TEST2_UTF8) \
1380     FBC_BOUND_COMMON(UTF8_LOAD(TEST1_UTF8, TEST2_UTF8, PLACEHOLDER, REXEC_FBC_TRYIT), TEST_NON_UTF8, PLACEHOLDER, REXEC_FBC_TRYIT)
1381
1382 #define FBC_NBOUND_NOLOAD(TEST_NON_UTF8, TEST1_UTF8, TEST2_UTF8) \
1383     FBC_BOUND_COMMON(UTF8_NOLOAD(TEST_NON_UTF8, PLACEHOLDER, REXEC_FBC_TRYIT), TEST_NON_UTF8, PLACEHOLDER, REXEC_FBC_TRYIT)
1384
1385
1386 /* Common to the BOUND and NBOUND cases.  Unfortunately the UTF8 tests need to
1387  * be passed in completely with the variable name being tested, which isn't
1388  * such a clean interface, but this is easier to read than it was before.  We
1389  * are looking for the boundary (or non-boundary between a word and non-word
1390  * character.  The utf8 and non-utf8 cases have the same logic, but the details
1391  * must be different.  Find the "wordness" of the character just prior to this
1392  * one, and compare it with the wordness of this one.  If they differ, we have
1393  * a boundary.  At the beginning of the string, pretend that the previous
1394  * character was a new-line */
1395 #define FBC_BOUND_COMMON(UTF8_CODE, TEST_NON_UTF8, IF_SUCCESS, IF_FAIL) \
1396     if (utf8_target) {                                                         \
1397                 UTF8_CODE \
1398     }                                                                          \
1399     else {  /* Not utf8 */                                                     \
1400         tmp = (s != PL_bostr) ? UCHARAT(s - 1) : '\n';                         \
1401         tmp = TEST_NON_UTF8(tmp);                                              \
1402         REXEC_FBC_SCAN(                                                        \
1403             if (tmp == ! TEST_NON_UTF8((U8) *s)) {                             \
1404                 tmp = !tmp;                                                    \
1405                 IF_SUCCESS;                                                    \
1406             }                                                                  \
1407             else {                                                             \
1408                 IF_FAIL;                                                       \
1409             }                                                                  \
1410         );                                                                     \
1411     }                                                                          \
1412     if ((!prog->minlen && tmp) && (!reginfo || regtry(reginfo, &s)))           \
1413         goto got_it;
1414
1415 /* We know what class REx starts with.  Try to find this position... */
1416 /* if reginfo is NULL, its a dryrun */
1417 /* annoyingly all the vars in this routine have different names from their counterparts
1418    in regmatch. /grrr */
1419
1420 STATIC char *
1421 S_find_byclass(pTHX_ regexp * prog, const regnode *c, char *s,
1422     const char *strend, regmatch_info *reginfo)
1423 {
1424         dVAR;
1425         const I32 doevery = (prog->intflags & PREGf_SKIP) == 0;
1426         char *pat_string;   /* The pattern's exactish string */
1427         char *pat_end;      /* ptr to end char of pat_string */
1428         re_fold_t folder;       /* Function for computing non-utf8 folds */
1429         const U8 *fold_array;   /* array for folding ords < 256 */
1430         STRLEN ln;
1431         STRLEN lnc;
1432         STRLEN uskip;
1433         U8 c1;
1434         U8 c2;
1435         char *e;
1436         I32 tmp = 1;    /* Scratch variable? */
1437         const bool utf8_target = PL_reg_match_utf8;
1438         UV utf8_fold_flags = 0;
1439         RXi_GET_DECL(prog,progi);
1440
1441         PERL_ARGS_ASSERT_FIND_BYCLASS;
1442
1443         /* We know what class it must start with. */
1444         switch (OP(c)) {
1445         case ANYOFV:
1446         case ANYOF:
1447             if (utf8_target || OP(c) == ANYOFV) {
1448                 STRLEN inclasslen = strend - s;
1449                 REXEC_FBC_UTF8_CLASS_SCAN(
1450                           reginclass(prog, c, (U8*)s, &inclasslen, utf8_target));
1451             }
1452             else {
1453                 REXEC_FBC_CLASS_SCAN(REGINCLASS(prog, c, (U8*)s));
1454             }
1455             break;
1456         case CANY:
1457             REXEC_FBC_SCAN(
1458                 if (tmp && (!reginfo || regtry(reginfo, &s)))
1459                     goto got_it;
1460                 else
1461                     tmp = doevery;
1462             );
1463             break;
1464
1465         case EXACTFA:
1466             if (UTF_PATTERN || utf8_target) {
1467                 utf8_fold_flags = FOLDEQ_UTF8_NOMIX_ASCII;
1468                 goto do_exactf_utf8;
1469             }
1470             fold_array = PL_fold_latin1;    /* Latin1 folds are not affected by */
1471             folder = foldEQ_latin1;         /* /a, except the sharp s one which */
1472             goto do_exactf_non_utf8;        /* isn't dealt with by these */
1473
1474         case EXACTF:
1475             if (utf8_target) {
1476
1477                 /* regcomp.c already folded this if pattern is in UTF-8 */
1478                 utf8_fold_flags = 0;
1479                 goto do_exactf_utf8;
1480             }
1481             fold_array = PL_fold;
1482             folder = foldEQ;
1483             goto do_exactf_non_utf8;
1484
1485         case EXACTFL:
1486             if (UTF_PATTERN || utf8_target) {
1487                 utf8_fold_flags = FOLDEQ_UTF8_LOCALE;
1488                 goto do_exactf_utf8;
1489             }
1490             fold_array = PL_fold_locale;
1491             folder = foldEQ_locale;
1492             goto do_exactf_non_utf8;
1493
1494         case EXACTFU_SS:
1495             if (UTF_PATTERN) {
1496                 utf8_fold_flags = FOLDEQ_S2_ALREADY_FOLDED;
1497             }
1498             goto do_exactf_utf8;
1499
1500         case EXACTFU_TRICKYFOLD:
1501         case EXACTFU:
1502             if (UTF_PATTERN || utf8_target) {
1503                 utf8_fold_flags = (UTF_PATTERN) ? FOLDEQ_S2_ALREADY_FOLDED : 0;
1504                 goto do_exactf_utf8;
1505             }
1506
1507             /* Any 'ss' in the pattern should have been replaced by regcomp,
1508              * so we don't have to worry here about this single special case
1509              * in the Latin1 range */
1510             fold_array = PL_fold_latin1;
1511             folder = foldEQ_latin1;
1512
1513             /* FALL THROUGH */
1514
1515         do_exactf_non_utf8: /* Neither pattern nor string are UTF8, and there
1516                                are no glitches with fold-length differences
1517                                between the target string and pattern */
1518
1519             /* The idea in the non-utf8 EXACTF* cases is to first find the
1520              * first character of the EXACTF* node and then, if necessary,
1521              * case-insensitively compare the full text of the node.  c1 is the
1522              * first character.  c2 is its fold.  This logic will not work for
1523              * Unicode semantics and the german sharp ss, which hence should
1524              * not be compiled into a node that gets here. */
1525             pat_string = STRING(c);
1526             ln  = STR_LEN(c);   /* length to match in octets/bytes */
1527
1528             /* We know that we have to match at least 'ln' bytes (which is the
1529              * same as characters, since not utf8).  If we have to match 3
1530              * characters, and there are only 2 availabe, we know without
1531              * trying that it will fail; so don't start a match past the
1532              * required minimum number from the far end */
1533             e = HOP3c(strend, -((I32)ln), s);
1534
1535             if (!reginfo && e < s) {
1536                 e = s;                  /* Due to minlen logic of intuit() */
1537             }
1538
1539             c1 = *pat_string;
1540             c2 = fold_array[c1];
1541             if (c1 == c2) { /* If char and fold are the same */
1542                 REXEC_FBC_EXACTISH_SCAN(*(U8*)s == c1);
1543             }
1544             else {
1545                 REXEC_FBC_EXACTISH_SCAN(*(U8*)s == c1 || *(U8*)s == c2);
1546             }
1547             break;
1548
1549         do_exactf_utf8:
1550         {
1551             unsigned expansion;
1552
1553
1554             /* If one of the operands is in utf8, we can't use the simpler
1555              * folding above, due to the fact that many different characters
1556              * can have the same fold, or portion of a fold, or different-
1557              * length fold */
1558             pat_string = STRING(c);
1559             ln  = STR_LEN(c);   /* length to match in octets/bytes */
1560             pat_end = pat_string + ln;
1561             lnc = (UTF_PATTERN) /* length to match in characters */
1562                     ? utf8_length((U8 *) pat_string, (U8 *) pat_end)
1563                     : ln;
1564
1565             /* We have 'lnc' characters to match in the pattern, but because of
1566              * multi-character folding, each character in the target can match
1567              * up to 3 characters (Unicode guarantees it will never exceed
1568              * this) if it is utf8-encoded; and up to 2 if not (based on the
1569              * fact that the Latin 1 folds are already determined, and the
1570              * only multi-char fold in that range is the sharp-s folding to
1571              * 'ss'.  Thus, a pattern character can match as little as 1/3 of a
1572              * string character.  Adjust lnc accordingly, rounding up, so that
1573              * if we need to match at least 4+1/3 chars, that really is 5. */
1574             expansion = (utf8_target) ? UTF8_MAX_FOLD_CHAR_EXPAND : 2;
1575             lnc = (lnc + expansion - 1) / expansion;
1576
1577             /* As in the non-UTF8 case, if we have to match 3 characters, and
1578              * only 2 are left, it's guaranteed to fail, so don't start a
1579              * match that would require us to go beyond the end of the string
1580              */
1581             e = HOP3c(strend, -((I32)lnc), s);
1582
1583             if (!reginfo && e < s) {
1584                 e = s;                  /* Due to minlen logic of intuit() */
1585             }
1586
1587             /* XXX Note that we could recalculate e to stop the loop earlier,
1588              * as the worst case expansion above will rarely be met, and as we
1589              * go along we would usually find that e moves further to the left.
1590              * This would happen only after we reached the point in the loop
1591              * where if there were no expansion we should fail.  Unclear if
1592              * worth the expense */
1593
1594             while (s <= e) {
1595                 char *my_strend= (char *)strend;
1596                 if (foldEQ_utf8_flags(s, &my_strend, 0,  utf8_target,
1597                       pat_string, NULL, ln, cBOOL(UTF_PATTERN), utf8_fold_flags)
1598                     && (!reginfo || regtry(reginfo, &s)) )
1599                 {
1600                     goto got_it;
1601                 }
1602                 s += (utf8_target) ? UTF8SKIP(s) : 1;
1603             }
1604             break;
1605         }
1606         case BOUNDL:
1607             PL_reg_flags |= RF_tainted;
1608             FBC_BOUND(isALNUM_LC,
1609                       isALNUM_LC_uvchr(UNI_TO_NATIVE(tmp)),
1610                       isALNUM_LC_utf8((U8*)s));
1611             break;
1612         case NBOUNDL:
1613             PL_reg_flags |= RF_tainted;
1614             FBC_NBOUND(isALNUM_LC,
1615                        isALNUM_LC_uvchr(UNI_TO_NATIVE(tmp)),
1616                        isALNUM_LC_utf8((U8*)s));
1617             break;
1618         case BOUND:
1619             FBC_BOUND(isWORDCHAR,
1620                       isALNUM_uni(tmp),
1621                       cBOOL(swash_fetch(PL_utf8_alnum, (U8*)s, utf8_target)));
1622             break;
1623         case BOUNDA:
1624             FBC_BOUND_NOLOAD(isWORDCHAR_A,
1625                              isWORDCHAR_A(tmp),
1626                              isWORDCHAR_A((U8*)s));
1627             break;
1628         case NBOUND:
1629             FBC_NBOUND(isWORDCHAR,
1630                        isALNUM_uni(tmp),
1631                        cBOOL(swash_fetch(PL_utf8_alnum, (U8*)s, utf8_target)));
1632             break;
1633         case NBOUNDA:
1634             FBC_NBOUND_NOLOAD(isWORDCHAR_A,
1635                               isWORDCHAR_A(tmp),
1636                               isWORDCHAR_A((U8*)s));
1637             break;
1638         case BOUNDU:
1639             FBC_BOUND(isWORDCHAR_L1,
1640                       isALNUM_uni(tmp),
1641                       cBOOL(swash_fetch(PL_utf8_alnum, (U8*)s, utf8_target)));
1642             break;
1643         case NBOUNDU:
1644             FBC_NBOUND(isWORDCHAR_L1,
1645                        isALNUM_uni(tmp),
1646                        cBOOL(swash_fetch(PL_utf8_alnum, (U8*)s, utf8_target)));
1647             break;
1648         case ALNUML:
1649             REXEC_FBC_CSCAN_TAINT(
1650                 isALNUM_LC_utf8((U8*)s),
1651                 isALNUM_LC(*s)
1652             );
1653             break;
1654         case ALNUMU:
1655             REXEC_FBC_CSCAN_PRELOAD(
1656                 LOAD_UTF8_CHARCLASS_ALNUM(),
1657                 swash_fetch(PL_utf8_alnum,(U8*)s, utf8_target),
1658                 isWORDCHAR_L1((U8) *s)
1659             );
1660             break;
1661         case ALNUM:
1662             REXEC_FBC_CSCAN_PRELOAD(
1663                 LOAD_UTF8_CHARCLASS_ALNUM(),
1664                 swash_fetch(PL_utf8_alnum,(U8*)s, utf8_target),
1665                 isWORDCHAR((U8) *s)
1666             );
1667             break;
1668         case ALNUMA:
1669             /* Don't need to worry about utf8, as it can match only a single
1670              * byte invariant character */
1671             REXEC_FBC_CLASS_SCAN( isWORDCHAR_A(*s));
1672             break;
1673         case NALNUMU:
1674             REXEC_FBC_CSCAN_PRELOAD(
1675                 LOAD_UTF8_CHARCLASS_ALNUM(),
1676                 !swash_fetch(PL_utf8_alnum,(U8*)s, utf8_target),
1677                 ! isWORDCHAR_L1((U8) *s)
1678             );
1679             break;
1680         case NALNUM:
1681             REXEC_FBC_CSCAN_PRELOAD(
1682                 LOAD_UTF8_CHARCLASS_ALNUM(),
1683                 !swash_fetch(PL_utf8_alnum, (U8*)s, utf8_target),
1684                 ! isALNUM(*s)
1685             );
1686             break;
1687         case NALNUMA:
1688             REXEC_FBC_CSCAN(
1689                 !isWORDCHAR_A(*s),
1690                 !isWORDCHAR_A(*s)
1691             );
1692             break;
1693         case NALNUML:
1694             REXEC_FBC_CSCAN_TAINT(
1695                 !isALNUM_LC_utf8((U8*)s),
1696                 !isALNUM_LC(*s)
1697             );
1698             break;
1699         case SPACEU:
1700             REXEC_FBC_CSCAN_PRELOAD(
1701                 LOAD_UTF8_CHARCLASS_SPACE(),
1702                 *s == ' ' || swash_fetch(PL_utf8_space,(U8*)s, utf8_target),
1703                 isSPACE_L1((U8) *s)
1704             );
1705             break;
1706         case SPACE:
1707             REXEC_FBC_CSCAN_PRELOAD(
1708                 LOAD_UTF8_CHARCLASS_SPACE(),
1709                 *s == ' ' || swash_fetch(PL_utf8_space,(U8*)s, utf8_target),
1710                 isSPACE((U8) *s)
1711             );
1712             break;
1713         case SPACEA:
1714             /* Don't need to worry about utf8, as it can match only a single
1715              * byte invariant character */
1716             REXEC_FBC_CLASS_SCAN( isSPACE_A(*s));
1717             break;
1718         case SPACEL:
1719             REXEC_FBC_CSCAN_TAINT(
1720                 isSPACE_LC_utf8((U8*)s),
1721                 isSPACE_LC(*s)
1722             );
1723             break;
1724         case NSPACEU:
1725             REXEC_FBC_CSCAN_PRELOAD(
1726                 LOAD_UTF8_CHARCLASS_SPACE(),
1727                 !( *s == ' ' || swash_fetch(PL_utf8_space,(U8*)s, utf8_target)),
1728                 ! isSPACE_L1((U8) *s)
1729             );
1730             break;
1731         case NSPACE:
1732             REXEC_FBC_CSCAN_PRELOAD(
1733                 LOAD_UTF8_CHARCLASS_SPACE(),
1734                 !(*s == ' ' || swash_fetch(PL_utf8_space,(U8*)s, utf8_target)),
1735                 ! isSPACE((U8) *s)
1736             );
1737             break;
1738         case NSPACEA:
1739             REXEC_FBC_CSCAN(
1740                 !isSPACE_A(*s),
1741                 !isSPACE_A(*s)
1742             );
1743             break;
1744         case NSPACEL:
1745             REXEC_FBC_CSCAN_TAINT(
1746                 !isSPACE_LC_utf8((U8*)s),
1747                 !isSPACE_LC(*s)
1748             );
1749             break;
1750         case DIGIT:
1751             REXEC_FBC_CSCAN_PRELOAD(
1752                 LOAD_UTF8_CHARCLASS_DIGIT(),
1753                 swash_fetch(PL_utf8_digit,(U8*)s, utf8_target),
1754                 isDIGIT(*s)
1755             );
1756             break;
1757         case DIGITA:
1758             /* Don't need to worry about utf8, as it can match only a single
1759              * byte invariant character */
1760             REXEC_FBC_CLASS_SCAN( isDIGIT_A(*s));
1761             break;
1762         case DIGITL:
1763             REXEC_FBC_CSCAN_TAINT(
1764                 isDIGIT_LC_utf8((U8*)s),
1765                 isDIGIT_LC(*s)
1766             );
1767             break;
1768         case NDIGIT:
1769             REXEC_FBC_CSCAN_PRELOAD(
1770                 LOAD_UTF8_CHARCLASS_DIGIT(),
1771                 !swash_fetch(PL_utf8_digit,(U8*)s, utf8_target),
1772                 !isDIGIT(*s)
1773             );
1774             break;
1775         case NDIGITA:
1776             REXEC_FBC_CSCAN(
1777                 !isDIGIT_A(*s),
1778                 !isDIGIT_A(*s)
1779             );
1780             break;
1781         case NDIGITL:
1782             REXEC_FBC_CSCAN_TAINT(
1783                 !isDIGIT_LC_utf8((U8*)s),
1784                 !isDIGIT_LC(*s)
1785             );
1786             break;
1787         case LNBREAK:
1788             REXEC_FBC_CSCAN(
1789                 is_LNBREAK_utf8(s),
1790                 is_LNBREAK_latin1(s)
1791             );
1792             break;
1793         case VERTWS:
1794             REXEC_FBC_CSCAN(
1795                 is_VERTWS_utf8(s),
1796                 is_VERTWS_latin1(s)
1797             );
1798             break;
1799         case NVERTWS:
1800             REXEC_FBC_CSCAN(
1801                 !is_VERTWS_utf8(s),
1802                 !is_VERTWS_latin1(s)
1803             );
1804             break;
1805         case HORIZWS:
1806             REXEC_FBC_CSCAN(
1807                 is_HORIZWS_utf8(s),
1808                 is_HORIZWS_latin1(s)
1809             );
1810             break;
1811         case NHORIZWS:
1812             REXEC_FBC_CSCAN(
1813                 !is_HORIZWS_utf8(s),
1814                 !is_HORIZWS_latin1(s)
1815             );
1816             break;
1817         case POSIXA:
1818             /* Don't need to worry about utf8, as it can match only a single
1819             * byte invariant character.  The flag in this node type is the
1820             * class number to pass to _generic_isCC() to build a mask for
1821             * searching in PL_charclass[] */
1822             REXEC_FBC_CLASS_SCAN( _generic_isCC_A(*s, FLAGS(c)));
1823             break;
1824         case NPOSIXA:
1825             REXEC_FBC_CSCAN(
1826                 !_generic_isCC_A(*s, FLAGS(c)),
1827                 !_generic_isCC_A(*s, FLAGS(c))
1828             );
1829             break;
1830
1831         case AHOCORASICKC:
1832         case AHOCORASICK:
1833             {
1834                 DECL_TRIE_TYPE(c);
1835                 /* what trie are we using right now */
1836                 reg_ac_data *aho
1837                     = (reg_ac_data*)progi->data->data[ ARG( c ) ];
1838                 reg_trie_data *trie
1839                     = (reg_trie_data*)progi->data->data[ aho->trie ];
1840                 HV *widecharmap = MUTABLE_HV(progi->data->data[ aho->trie + 1 ]);
1841
1842                 const char *last_start = strend - trie->minlen;
1843 #ifdef DEBUGGING
1844                 const char *real_start = s;
1845 #endif
1846                 STRLEN maxlen = trie->maxlen;
1847                 SV *sv_points;
1848                 U8 **points; /* map of where we were in the input string
1849                                 when reading a given char. For ASCII this
1850                                 is unnecessary overhead as the relationship
1851                                 is always 1:1, but for Unicode, especially
1852                                 case folded Unicode this is not true. */
1853                 U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
1854                 U8 *bitmap=NULL;
1855
1856
1857                 GET_RE_DEBUG_FLAGS_DECL;
1858
1859                 /* We can't just allocate points here. We need to wrap it in
1860                  * an SV so it gets freed properly if there is a croak while
1861                  * running the match */
1862                 ENTER;
1863                 SAVETMPS;
1864                 sv_points=newSV(maxlen * sizeof(U8 *));
1865                 SvCUR_set(sv_points,
1866                     maxlen * sizeof(U8 *));
1867                 SvPOK_on(sv_points);
1868                 sv_2mortal(sv_points);
1869                 points=(U8**)SvPV_nolen(sv_points );
1870                 if ( trie_type != trie_utf8_fold
1871                      && (trie->bitmap || OP(c)==AHOCORASICKC) )
1872                 {
1873                     if (trie->bitmap)
1874                         bitmap=(U8*)trie->bitmap;
1875                     else
1876                         bitmap=(U8*)ANYOF_BITMAP(c);
1877                 }
1878                 /* this is the Aho-Corasick algorithm modified a touch
1879                    to include special handling for long "unknown char"
1880                    sequences. The basic idea being that we use AC as long
1881                    as we are dealing with a possible matching char, when
1882                    we encounter an unknown char (and we have not encountered
1883                    an accepting state) we scan forward until we find a legal
1884                    starting char.
1885                    AC matching is basically that of trie matching, except
1886                    that when we encounter a failing transition, we fall back
1887                    to the current states "fail state", and try the current char
1888                    again, a process we repeat until we reach the root state,
1889                    state 1, or a legal transition. If we fail on the root state
1890                    then we can either terminate if we have reached an accepting
1891                    state previously, or restart the entire process from the beginning
1892                    if we have not.
1893
1894                  */
1895                 while (s <= last_start) {
1896                     const U32 uniflags = UTF8_ALLOW_DEFAULT;
1897                     U8 *uc = (U8*)s;
1898                     U16 charid = 0;
1899                     U32 base = 1;
1900                     U32 state = 1;
1901                     UV uvc = 0;
1902                     STRLEN len = 0;
1903                     STRLEN foldlen = 0;
1904                     U8 *uscan = (U8*)NULL;
1905                     U8 *leftmost = NULL;
1906 #ifdef DEBUGGING
1907                     U32 accepted_word= 0;
1908 #endif
1909                     U32 pointpos = 0;
1910
1911                     while ( state && uc <= (U8*)strend ) {
1912                         int failed=0;
1913                         U32 word = aho->states[ state ].wordnum;
1914
1915                         if( state==1 ) {
1916                             if ( bitmap ) {
1917                                 DEBUG_TRIE_EXECUTE_r(
1918                                     if ( uc <= (U8*)last_start && !BITMAP_TEST(bitmap,*uc) ) {
1919                                         dump_exec_pos( (char *)uc, c, strend, real_start,
1920                                             (char *)uc, utf8_target );
1921                                         PerlIO_printf( Perl_debug_log,
1922                                             " Scanning for legal start char...\n");
1923                                     }
1924                                 );
1925                                 if (utf8_target) {
1926                                     while ( uc <= (U8*)last_start && !BITMAP_TEST(bitmap,*uc) ) {
1927                                         uc += UTF8SKIP(uc);
1928                                     }
1929                                 } else {
1930                                     while ( uc <= (U8*)last_start  && !BITMAP_TEST(bitmap,*uc) ) {
1931                                         uc++;
1932                                     }
1933                                 }
1934                                 s= (char *)uc;
1935                             }
1936                             if (uc >(U8*)last_start) break;
1937                         }
1938
1939                         if ( word ) {
1940                             U8 *lpos= points[ (pointpos - trie->wordinfo[word].len) % maxlen ];
1941                             if (!leftmost || lpos < leftmost) {
1942                                 DEBUG_r(accepted_word=word);
1943                                 leftmost= lpos;
1944                             }
1945                             if (base==0) break;
1946
1947                         }
1948                         points[pointpos++ % maxlen]= uc;
1949                         REXEC_TRIE_READ_CHAR(trie_type, trie, widecharmap, uc,
1950                                              uscan, len, uvc, charid, foldlen,
1951                                              foldbuf, uniflags);
1952                         DEBUG_TRIE_EXECUTE_r({
1953                             dump_exec_pos( (char *)uc, c, strend, real_start,
1954                                 s,   utf8_target );
1955                             PerlIO_printf(Perl_debug_log,
1956                                 " Charid:%3u CP:%4"UVxf" ",
1957                                  charid, uvc);
1958                         });
1959
1960                         do {
1961 #ifdef DEBUGGING
1962                             word = aho->states[ state ].wordnum;
1963 #endif
1964                             base = aho->states[ state ].trans.base;
1965
1966                             DEBUG_TRIE_EXECUTE_r({
1967                                 if (failed)
1968                                     dump_exec_pos( (char *)uc, c, strend, real_start,
1969                                         s,   utf8_target );
1970                                 PerlIO_printf( Perl_debug_log,
1971                                     "%sState: %4"UVxf", word=%"UVxf,
1972                                     failed ? " Fail transition to " : "",
1973                                     (UV)state, (UV)word);
1974                             });
1975                             if ( base ) {
1976                                 U32 tmp;
1977                                 I32 offset;
1978                                 if (charid &&
1979                                      ( ((offset = base + charid
1980                                         - 1 - trie->uniquecharcount)) >= 0)
1981                                      && ((U32)offset < trie->lasttrans)
1982                                      && trie->trans[offset].check == state
1983                                      && (tmp=trie->trans[offset].next))
1984                                 {
1985                                     DEBUG_TRIE_EXECUTE_r(
1986                                         PerlIO_printf( Perl_debug_log," - legal\n"));
1987                                     state = tmp;
1988                                     break;
1989                                 }
1990                                 else {
1991                                     DEBUG_TRIE_EXECUTE_r(
1992                                         PerlIO_printf( Perl_debug_log," - fail\n"));
1993                                     failed = 1;
1994                                     state = aho->fail[state];
1995                                 }
1996                             }
1997                             else {
1998                                 /* we must be accepting here */
1999                                 DEBUG_TRIE_EXECUTE_r(
2000                                         PerlIO_printf( Perl_debug_log," - accepting\n"));
2001                                 failed = 1;
2002                                 break;
2003                             }
2004                         } while(state);
2005                         uc += len;
2006                         if (failed) {
2007                             if (leftmost)
2008                                 break;
2009                             if (!state) state = 1;
2010                         }
2011                     }
2012                     if ( aho->states[ state ].wordnum ) {
2013                         U8 *lpos = points[ (pointpos - trie->wordinfo[aho->states[ state ].wordnum].len) % maxlen ];
2014                         if (!leftmost || lpos < leftmost) {
2015                             DEBUG_r(accepted_word=aho->states[ state ].wordnum);
2016                             leftmost = lpos;
2017                         }
2018                     }
2019                     if (leftmost) {
2020                         s = (char*)leftmost;
2021                         DEBUG_TRIE_EXECUTE_r({
2022                             PerlIO_printf(
2023                                 Perl_debug_log,"Matches word #%"UVxf" at position %"IVdf". Trying full pattern...\n",
2024                                 (UV)accepted_word, (IV)(s - real_start)
2025                             );
2026                         });
2027                         if (!reginfo || regtry(reginfo, &s)) {
2028                             FREETMPS;
2029                             LEAVE;
2030                             goto got_it;
2031                         }
2032                         s = HOPc(s,1);
2033                         DEBUG_TRIE_EXECUTE_r({
2034                             PerlIO_printf( Perl_debug_log,"Pattern failed. Looking for new start point...\n");
2035                         });
2036                     } else {
2037                         DEBUG_TRIE_EXECUTE_r(
2038                             PerlIO_printf( Perl_debug_log,"No match.\n"));
2039                         break;
2040                     }
2041                 }
2042                 FREETMPS;
2043                 LEAVE;
2044             }
2045             break;
2046         default:
2047             Perl_croak(aTHX_ "panic: unknown regstclass %d", (int)OP(c));
2048             break;
2049         }
2050         return 0;
2051       got_it:
2052         return s;
2053 }
2054
2055
2056 /*
2057  - regexec_flags - match a regexp against a string
2058  */
2059 I32
2060 Perl_regexec_flags(pTHX_ REGEXP * const rx, char *stringarg, register char *strend,
2061               char *strbeg, I32 minend, SV *sv, void *data, U32 flags)
2062 /* strend: pointer to null at end of string */
2063 /* strbeg: real beginning of string */
2064 /* minend: end of match must be >=minend after stringarg. */
2065 /* data: May be used for some additional optimizations.
2066          Currently its only used, with a U32 cast, for transmitting
2067          the ganch offset when doing a /g match. This will change */
2068 /* nosave: For optimizations. */
2069 {
2070     dVAR;
2071     struct regexp *const prog = (struct regexp *)SvANY(rx);
2072     /*register*/ char *s;
2073     regnode *c;
2074     /*register*/ char *startpos = stringarg;
2075     I32 minlen;         /* must match at least this many chars */
2076     I32 dontbother = 0; /* how many characters not to try at end */
2077     I32 end_shift = 0;                  /* Same for the end. */         /* CC */
2078     I32 scream_pos = -1;                /* Internal iterator of scream. */
2079     char *scream_olds = NULL;
2080     const bool utf8_target = cBOOL(DO_UTF8(sv));
2081     I32 multiline;
2082     RXi_GET_DECL(prog,progi);
2083     regmatch_info reginfo;  /* create some info to pass to regtry etc */
2084     regexp_paren_pair *swap = NULL;
2085     GET_RE_DEBUG_FLAGS_DECL;
2086
2087     PERL_ARGS_ASSERT_REGEXEC_FLAGS;
2088     PERL_UNUSED_ARG(data);
2089
2090     /* Be paranoid... */
2091     if (prog == NULL || startpos == NULL) {
2092         Perl_croak(aTHX_ "NULL regexp parameter");
2093         return 0;
2094     }
2095
2096     multiline = prog->extflags & RXf_PMf_MULTILINE;
2097     reginfo.prog = rx;   /* Yes, sorry that this is confusing.  */
2098
2099     RX_MATCH_UTF8_set(rx, utf8_target);
2100     DEBUG_EXECUTE_r(
2101         debug_start_match(rx, utf8_target, startpos, strend,
2102         "Matching");
2103     );
2104
2105     minlen = prog->minlen;
2106
2107     if (strend - startpos < (minlen+(prog->check_offset_min<0?prog->check_offset_min:0))) {
2108         DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
2109                               "String too short [regexec_flags]...\n"));
2110         goto phooey;
2111     }
2112
2113
2114     /* Check validity of program. */
2115     if (UCHARAT(progi->program) != REG_MAGIC) {
2116         Perl_croak(aTHX_ "corrupted regexp program");
2117     }
2118
2119     PL_reg_flags = 0;
2120     PL_reg_state.re_state_eval_setup_done = FALSE;
2121     PL_reg_maxiter = 0;
2122
2123     if (RX_UTF8(rx))
2124         PL_reg_flags |= RF_utf8;
2125
2126     /* Mark beginning of line for ^ and lookbehind. */
2127     reginfo.bol = startpos; /* XXX not used ??? */
2128     PL_bostr  = strbeg;
2129     reginfo.sv = sv;
2130
2131     /* Mark end of line for $ (and such) */
2132     PL_regeol = strend;
2133
2134     /* see how far we have to get to not match where we matched before */
2135     reginfo.till = startpos+minend;
2136
2137     /* If there is a "must appear" string, look for it. */
2138     s = startpos;
2139
2140     if (prog->extflags & RXf_GPOS_SEEN) { /* Need to set reginfo->ganch */
2141         MAGIC *mg;
2142         if (flags & REXEC_IGNOREPOS){   /* Means: check only at start */
2143             reginfo.ganch = startpos + prog->gofs;
2144             DEBUG_GPOS_r(PerlIO_printf(Perl_debug_log,
2145               "GPOS IGNOREPOS: reginfo.ganch = startpos + %"UVxf"\n",(UV)prog->gofs));
2146         } else if (sv && SvTYPE(sv) >= SVt_PVMG
2147                   && SvMAGIC(sv)
2148                   && (mg = mg_find(sv, PERL_MAGIC_regex_global))
2149                   && mg->mg_len >= 0) {
2150             reginfo.ganch = strbeg + mg->mg_len;        /* Defined pos() */
2151             DEBUG_GPOS_r(PerlIO_printf(Perl_debug_log,
2152                 "GPOS MAGIC: reginfo.ganch = strbeg + %"IVdf"\n",(IV)mg->mg_len));
2153
2154             if (prog->extflags & RXf_ANCH_GPOS) {
2155                 if (s > reginfo.ganch)
2156                     goto phooey;
2157                 s = reginfo.ganch - prog->gofs;
2158                 DEBUG_GPOS_r(PerlIO_printf(Perl_debug_log,
2159                      "GPOS ANCH_GPOS: s = ganch - %"UVxf"\n",(UV)prog->gofs));
2160                 if (s < strbeg)
2161                     goto phooey;
2162             }
2163         }
2164         else if (data) {
2165             reginfo.ganch = strbeg + PTR2UV(data);
2166             DEBUG_GPOS_r(PerlIO_printf(Perl_debug_log,
2167                  "GPOS DATA: reginfo.ganch= strbeg + %"UVxf"\n",PTR2UV(data)));
2168
2169         } else {                                /* pos() not defined */
2170             reginfo.ganch = strbeg;
2171             DEBUG_GPOS_r(PerlIO_printf(Perl_debug_log,
2172                  "GPOS: reginfo.ganch = strbeg\n"));
2173         }
2174     }
2175     if (PL_curpm && (PM_GETRE(PL_curpm) == rx)) {
2176         /* We have to be careful. If the previous successful match
2177            was from this regex we don't want a subsequent partially
2178            successful match to clobber the old results.
2179            So when we detect this possibility we add a swap buffer
2180            to the re, and switch the buffer each match. If we fail
2181            we switch it back, otherwise we leave it swapped.
2182         */
2183         swap = prog->offs;
2184         /* do we need a save destructor here for eval dies? */
2185         Newxz(prog->offs, (prog->nparens + 1), regexp_paren_pair);
2186         DEBUG_BUFFERS_r(PerlIO_printf(Perl_debug_log,
2187             "rex=0x%"UVxf" saving  offs: orig=0x%"UVxf" new=0x%"UVxf"\n",
2188             PTR2UV(prog),
2189             PTR2UV(swap),
2190             PTR2UV(prog->offs)
2191         ));
2192     }
2193     if (!(flags & REXEC_CHECKED) && (prog->check_substr != NULL || prog->check_utf8 != NULL)) {
2194         re_scream_pos_data d;
2195
2196         d.scream_olds = &scream_olds;
2197         d.scream_pos = &scream_pos;
2198         s = re_intuit_start(rx, sv, s, strend, flags, &d);
2199         if (!s) {
2200             DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Not present...\n"));
2201             goto phooey;        /* not present */
2202         }
2203     }
2204
2205
2206
2207     /* Simplest case:  anchored match need be tried only once. */
2208     /*  [unless only anchor is BOL and multiline is set] */
2209     if (prog->extflags & (RXf_ANCH & ~RXf_ANCH_GPOS)) {
2210         if (s == startpos && regtry(&reginfo, &startpos))
2211             goto got_it;
2212         else if (multiline || (prog->intflags & PREGf_IMPLICIT)
2213                  || (prog->extflags & RXf_ANCH_MBOL)) /* XXXX SBOL? */
2214         {
2215             char *end;
2216
2217             if (minlen)
2218                 dontbother = minlen - 1;
2219             end = HOP3c(strend, -dontbother, strbeg) - 1;
2220             /* for multiline we only have to try after newlines */
2221             if (prog->check_substr || prog->check_utf8) {
2222                 /* because of the goto we can not easily reuse the macros for bifurcating the
2223                    unicode/non-unicode match modes here like we do elsewhere - demerphq */
2224                 if (utf8_target) {
2225                     if (s == startpos)
2226                         goto after_try_utf8;
2227                     while (1) {
2228                         if (regtry(&reginfo, &s)) {
2229                             goto got_it;
2230                         }
2231                       after_try_utf8:
2232                         if (s > end) {
2233                             goto phooey;
2234                         }
2235                         if (prog->extflags & RXf_USE_INTUIT) {
2236                             s = re_intuit_start(rx, sv, s + UTF8SKIP(s), strend, flags, NULL);
2237                             if (!s) {
2238                                 goto phooey;
2239                             }
2240                         }
2241                         else {
2242                             s += UTF8SKIP(s);
2243                         }
2244                     }
2245                 } /* end search for check string in unicode */
2246                 else {
2247                     if (s == startpos) {
2248                         goto after_try_latin;
2249                     }
2250                     while (1) {
2251                         if (regtry(&reginfo, &s)) {
2252                             goto got_it;
2253                         }
2254                       after_try_latin:
2255                         if (s > end) {
2256                             goto phooey;
2257                         }
2258                         if (prog->extflags & RXf_USE_INTUIT) {
2259                             s = re_intuit_start(rx, sv, s + 1, strend, flags, NULL);
2260                             if (!s) {
2261                                 goto phooey;
2262                             }
2263                         }
2264                         else {
2265                             s++;
2266                         }
2267                     }
2268                 } /* end search for check string in latin*/
2269             } /* end search for check string */
2270             else { /* search for newline */
2271                 if (s > startpos) {
2272                     /*XXX: The s-- is almost definitely wrong here under unicode - demeprhq*/
2273                     s--;
2274                 }
2275                 /* We can use a more efficient search as newlines are the same in unicode as they are in latin */
2276                 while (s <= end) { /* note it could be possible to match at the end of the string */
2277                     if (*s++ == '\n') { /* don't need PL_utf8skip here */
2278                         if (regtry(&reginfo, &s))
2279                             goto got_it;
2280                     }
2281                 }
2282             } /* end search for newline */
2283         } /* end anchored/multiline check string search */
2284         goto phooey;
2285     } else if (RXf_GPOS_CHECK == (prog->extflags & RXf_GPOS_CHECK))
2286     {
2287         /* the warning about reginfo.ganch being used without initialization
2288            is bogus -- we set it above, when prog->extflags & RXf_GPOS_SEEN
2289            and we only enter this block when the same bit is set. */
2290         char *tmp_s = reginfo.ganch - prog->gofs;
2291
2292         if (tmp_s >= strbeg && regtry(&reginfo, &tmp_s))
2293             goto got_it;
2294         goto phooey;
2295     }
2296
2297     /* Messy cases:  unanchored match. */
2298     if ((prog->anchored_substr || prog->anchored_utf8) && prog->intflags & PREGf_SKIP) {
2299         /* we have /x+whatever/ */
2300         /* it must be a one character string (XXXX Except UTF_PATTERN?) */
2301         char ch;
2302 #ifdef DEBUGGING
2303         int did_match = 0;
2304 #endif
2305         if (!(utf8_target ? prog->anchored_utf8 : prog->anchored_substr))
2306             utf8_target ? to_utf8_substr(prog) : to_byte_substr(prog);
2307         ch = SvPVX_const(utf8_target ? prog->anchored_utf8 : prog->anchored_substr)[0];
2308
2309         if (utf8_target) {
2310             REXEC_FBC_SCAN(
2311                 if (*s == ch) {
2312                     DEBUG_EXECUTE_r( did_match = 1 );
2313                     if (regtry(&reginfo, &s)) goto got_it;
2314                     s += UTF8SKIP(s);
2315                     while (s < strend && *s == ch)
2316                         s += UTF8SKIP(s);
2317                 }
2318             );
2319         }
2320         else {
2321             REXEC_FBC_SCAN(
2322                 if (*s == ch) {
2323                     DEBUG_EXECUTE_r( did_match = 1 );
2324                     if (regtry(&reginfo, &s)) goto got_it;
2325                     s++;
2326                     while (s < strend && *s == ch)
2327                         s++;
2328                 }
2329             );
2330         }
2331         DEBUG_EXECUTE_r(if (!did_match)
2332                 PerlIO_printf(Perl_debug_log,
2333                                   "Did not find anchored character...\n")
2334                );
2335     }
2336     else if (prog->anchored_substr != NULL
2337               || prog->anchored_utf8 != NULL
2338               || ((prog->float_substr != NULL || prog->float_utf8 != NULL)
2339                   && prog->float_max_offset < strend - s)) {
2340         SV *must;
2341         I32 back_max;
2342         I32 back_min;
2343         char *last;
2344         char *last1;            /* Last position checked before */
2345 #ifdef DEBUGGING
2346         int did_match = 0;
2347 #endif
2348         if (prog->anchored_substr || prog->anchored_utf8) {
2349             if (!(utf8_target ? prog->anchored_utf8 : prog->anchored_substr))
2350                 utf8_target ? to_utf8_substr(prog) : to_byte_substr(prog);
2351             must = utf8_target ? prog->anchored_utf8 : prog->anchored_substr;
2352             back_max = back_min = prog->anchored_offset;
2353         } else {
2354             if (!(utf8_target ? prog->float_utf8 : prog->float_substr))
2355                 utf8_target ? to_utf8_substr(prog) : to_byte_substr(prog);
2356             must = utf8_target ? prog->float_utf8 : prog->float_substr;
2357             back_max = prog->float_max_offset;
2358             back_min = prog->float_min_offset;
2359         }
2360
2361
2362         if (must == &PL_sv_undef)
2363             /* could not downgrade utf8 check substring, so must fail */
2364             goto phooey;
2365
2366         if (back_min<0) {
2367             last = strend;
2368         } else {
2369             last = HOP3c(strend,        /* Cannot start after this */
2370                   -(I32)(CHR_SVLEN(must)
2371                          - (SvTAIL(must) != 0) + back_min), strbeg);
2372         }
2373         if (s > PL_bostr)
2374             last1 = HOPc(s, -1);
2375         else
2376             last1 = s - 1;      /* bogus */
2377
2378         /* XXXX check_substr already used to find "s", can optimize if
2379            check_substr==must. */
2380         scream_pos = -1;
2381         dontbother = end_shift;
2382         strend = HOPc(strend, -dontbother);
2383         while ( (s <= last) &&
2384                 (s = fbm_instr((unsigned char*)HOP3(s, back_min, (back_min<0 ? strbeg : strend)),
2385                                   (unsigned char*)strend, must,
2386                                   multiline ? FBMrf_MULTILINE : 0)) ) {
2387             DEBUG_EXECUTE_r( did_match = 1 );
2388             if (HOPc(s, -back_max) > last1) {
2389                 last1 = HOPc(s, -back_min);
2390                 s = HOPc(s, -back_max);
2391             }
2392             else {
2393                 char * const t = (last1 >= PL_bostr) ? HOPc(last1, 1) : last1 + 1;
2394
2395                 last1 = HOPc(s, -back_min);
2396                 s = t;
2397             }
2398             if (utf8_target) {
2399                 while (s <= last1) {
2400                     if (regtry(&reginfo, &s))
2401                         goto got_it;
2402                     s += UTF8SKIP(s);
2403                 }
2404             }
2405             else {
2406                 while (s <= last1) {
2407                     if (regtry(&reginfo, &s))
2408                         goto got_it;
2409                     s++;
2410                 }
2411             }
2412         }
2413         DEBUG_EXECUTE_r(if (!did_match) {
2414             RE_PV_QUOTED_DECL(quoted, utf8_target, PERL_DEBUG_PAD_ZERO(0),
2415                 SvPVX_const(must), RE_SV_DUMPLEN(must), 30);
2416             PerlIO_printf(Perl_debug_log, "Did not find %s substr %s%s...\n",
2417                               ((must == prog->anchored_substr || must == prog->anchored_utf8)
2418                                ? "anchored" : "floating"),
2419                 quoted, RE_SV_TAIL(must));
2420         });
2421         goto phooey;
2422     }
2423     else if ( (c = progi->regstclass) ) {
2424         if (minlen) {
2425             const OPCODE op = OP(progi->regstclass);
2426             /* don't bother with what can't match */
2427             if (PL_regkind[op] != EXACT && op != CANY && PL_regkind[op] != TRIE)
2428                 strend = HOPc(strend, -(minlen - 1));
2429         }
2430         DEBUG_EXECUTE_r({
2431             SV * const prop = sv_newmortal();
2432             regprop(prog, prop, c);
2433             {
2434                 RE_PV_QUOTED_DECL(quoted,utf8_target,PERL_DEBUG_PAD_ZERO(1),
2435                     s,strend-s,60);
2436                 PerlIO_printf(Perl_debug_log,
2437                     "Matching stclass %.*s against %s (%d bytes)\n",
2438                     (int)SvCUR(prop), SvPVX_const(prop),
2439                      quoted, (int)(strend - s));
2440             }
2441         });
2442         if (find_byclass(prog, c, s, strend, &reginfo))
2443             goto got_it;
2444         DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Contradicts stclass... [regexec_flags]\n"));
2445     }
2446     else {
2447         dontbother = 0;
2448         if (prog->float_substr != NULL || prog->float_utf8 != NULL) {
2449             /* Trim the end. */
2450             char *last= NULL;
2451             SV* float_real;
2452             STRLEN len;
2453             const char *little;
2454
2455             if (!(utf8_target ? prog->float_utf8 : prog->float_substr))
2456                 utf8_target ? to_utf8_substr(prog) : to_byte_substr(prog);
2457             float_real = utf8_target ? prog->float_utf8 : prog->float_substr;
2458
2459             little = SvPV_const(float_real, len);
2460             if (SvTAIL(float_real)) {
2461                     /* This means that float_real contains an artificial \n on the end
2462                      * due to the presence of something like this: /foo$/
2463                      * where we can match both "foo" and "foo\n" at the end of the string.
2464                      * So we have to compare the end of the string first against the float_real
2465                      * without the \n and then against the full float_real with the string.
2466                      * We have to watch out for cases where the string might be smaller
2467                      * than the float_real or the float_real without the \n.
2468                      */
2469                     char *checkpos= strend - len;
2470                     DEBUG_OPTIMISE_r(
2471                         PerlIO_printf(Perl_debug_log,
2472                             "%sChecking for float_real.%s\n",
2473                             PL_colors[4], PL_colors[5]));
2474                     if (checkpos + 1 < strbeg) {
2475                         /* can't match, even if we remove the trailing \n string is too short to match */
2476                         DEBUG_EXECUTE_r(
2477                             PerlIO_printf(Perl_debug_log,
2478                                 "%sString shorter than required trailing substring, cannot match.%s\n",
2479                                 PL_colors[4], PL_colors[5]));
2480                         goto phooey;
2481                     } else if (memEQ(checkpos + 1, little, len - 1)) {
2482                         /* can match, the end of the string matches without the "\n" */
2483                         last = checkpos + 1;
2484                     } else if (checkpos < strbeg) {
2485                         /* cant match, string is too short when the "\n" is included */
2486                         DEBUG_EXECUTE_r(
2487                             PerlIO_printf(Perl_debug_log,
2488                                 "%sString does not contain required trailing substring, cannot match.%s\n",
2489                                 PL_colors[4], PL_colors[5]));
2490                         goto phooey;
2491                     } else if (!multiline) {
2492                         /* non multiline match, so compare with the "\n" at the end of the string */
2493                         if (memEQ(checkpos, little, len)) {
2494                             last= checkpos;
2495                         } else {
2496                             DEBUG_EXECUTE_r(
2497                                 PerlIO_printf(Perl_debug_log,
2498                                     "%sString does not contain required trailing substring, cannot match.%s\n",
2499                                     PL_colors[4], PL_colors[5]));
2500                             goto phooey;
2501                         }
2502                     } else {
2503                         /* multiline match, so we have to search for a place where the full string is located */
2504                         goto find_last;
2505                     }
2506             } else {
2507                   find_last:
2508                     if (len)
2509                         last = rninstr(s, strend, little, little + len);
2510                     else
2511                         last = strend;  /* matching "$" */
2512             }
2513             if (!last) {
2514                 /* at one point this block contained a comment which was probably
2515                  * incorrect, which said that this was a "should not happen" case.
2516                  * Even if it was true when it was written I am pretty sure it is
2517                  * not anymore, so I have removed the comment and replaced it with
2518                  * this one. Yves */
2519                 DEBUG_EXECUTE_r(
2520                     PerlIO_printf(Perl_debug_log,
2521                         "String does not contain required substring, cannot match.\n"
2522                     ));
2523                 goto phooey;
2524             }
2525             dontbother = strend - last + prog->float_min_offset;
2526         }
2527         if (minlen && (dontbother < minlen))
2528             dontbother = minlen - 1;
2529         strend -= dontbother;              /* this one's always in bytes! */
2530         /* We don't know much -- general case. */
2531         if (utf8_target) {
2532             for (;;) {
2533                 if (regtry(&reginfo, &s))
2534                     goto got_it;
2535                 if (s >= strend)
2536                     break;
2537                 s += UTF8SKIP(s);
2538             };
2539         }
2540         else {
2541             do {
2542                 if (regtry(&reginfo, &s))
2543                     goto got_it;
2544             } while (s++ < strend);
2545         }
2546     }
2547
2548     /* Failure. */
2549     goto phooey;
2550
2551 got_it:
2552     DEBUG_BUFFERS_r(
2553         if (swap)
2554             PerlIO_printf(Perl_debug_log,
2555                 "rex=0x%"UVxf" freeing offs: 0x%"UVxf"\n",
2556                 PTR2UV(prog),
2557                 PTR2UV(swap)
2558             );
2559     );
2560     Safefree(swap);
2561     RX_MATCH_TAINTED_set(rx, PL_reg_flags & RF_tainted);
2562
2563     if (PL_reg_state.re_state_eval_setup_done)
2564         restore_pos(aTHX_ prog);
2565     if (RXp_PAREN_NAMES(prog))
2566         (void)hv_iterinit(RXp_PAREN_NAMES(prog));
2567
2568     /* make sure $`, $&, $', and $digit will work later */
2569     if ( !(flags & REXEC_NOT_FIRST) ) {
2570         RX_MATCH_COPY_FREE(rx);
2571         if (flags & REXEC_COPY_STR) {
2572             const I32 i = PL_regeol - startpos + (stringarg - strbeg);
2573 #ifdef PERL_OLD_COPY_ON_WRITE
2574             if ((SvIsCOW(sv)
2575                  || (SvFLAGS(sv) & CAN_COW_MASK) == CAN_COW_FLAGS)) {
2576                 if (DEBUG_C_TEST) {
2577                     PerlIO_printf(Perl_debug_log,
2578                                   "Copy on write: regexp capture, type %d\n",
2579                                   (int) SvTYPE(sv));
2580                 }
2581                 prog->saved_copy = sv_setsv_cow(prog->saved_copy, sv);
2582                 prog->subbeg = (char *)SvPVX_const(prog->saved_copy);
2583                 assert (SvPOKp(prog->saved_copy));
2584             } else
2585 #endif
2586             {
2587                 RX_MATCH_COPIED_on(rx);
2588                 s = savepvn(strbeg, i);
2589                 prog->subbeg = s;
2590             }
2591             prog->sublen = i;
2592         }
2593         else {
2594             prog->subbeg = strbeg;
2595             prog->sublen = PL_regeol - strbeg;  /* strend may have been modified */
2596         }
2597     }
2598
2599     return 1;
2600
2601 phooey:
2602     DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "%sMatch failed%s\n",
2603                           PL_colors[4], PL_colors[5]));
2604     if (PL_reg_state.re_state_eval_setup_done)
2605         restore_pos(aTHX_ prog);
2606     if (swap) {
2607         /* we failed :-( roll it back */
2608         DEBUG_BUFFERS_r(PerlIO_printf(Perl_debug_log,
2609             "rex=0x%"UVxf" rolling back offs: freeing=0x%"UVxf" restoring=0x%"UVxf"\n",
2610             PTR2UV(prog),
2611             PTR2UV(prog->offs),
2612             PTR2UV(swap)
2613         ));
2614         Safefree(prog->offs);
2615         prog->offs = swap;
2616     }
2617
2618     return 0;
2619 }
2620
2621
2622 /* Set which rex is pointed to by PL_reg_state, handling ref counting.
2623  * Do inc before dec, in case old and new rex are the same */
2624 #define SET_reg_curpm(Re2) \
2625     if (PL_reg_state.re_state_eval_setup_done) {    \
2626         (void)ReREFCNT_inc(Re2);                    \
2627         ReREFCNT_dec(PM_GETRE(PL_reg_curpm));       \
2628         PM_SETRE((PL_reg_curpm), (Re2));            \
2629     }
2630
2631
2632 /*
2633  - regtry - try match at specific point
2634  */
2635 STATIC I32                      /* 0 failure, 1 success */
2636 S_regtry(pTHX_ regmatch_info *reginfo, char **startpos)
2637 {
2638     dVAR;
2639     CHECKPOINT lastcp;
2640     REGEXP *const rx = reginfo->prog;
2641     regexp *const prog = (struct regexp *)SvANY(rx);
2642     RXi_GET_DECL(prog,progi);
2643     GET_RE_DEBUG_FLAGS_DECL;
2644
2645     PERL_ARGS_ASSERT_REGTRY;
2646
2647     reginfo->cutpoint=NULL;
2648
2649     if ((prog->extflags & RXf_EVAL_SEEN)
2650         && !PL_reg_state.re_state_eval_setup_done)
2651     {
2652         MAGIC *mg;
2653
2654         PL_reg_state.re_state_eval_setup_done = TRUE;
2655         if (reginfo->sv) {
2656             /* Make $_ available to executed code. */
2657             if (reginfo->sv != DEFSV) {
2658                 SAVE_DEFSV;
2659                 DEFSV_set(reginfo->sv);
2660             }
2661
2662             if (!(SvTYPE(reginfo->sv) >= SVt_PVMG && SvMAGIC(reginfo->sv)
2663                   && (mg = mg_find(reginfo->sv, PERL_MAGIC_regex_global)))) {
2664                 /* prepare for quick setting of pos */
2665 #ifdef PERL_OLD_COPY_ON_WRITE
2666                 if (SvIsCOW(reginfo->sv))
2667                     sv_force_normal_flags(reginfo->sv, 0);
2668 #endif
2669                 mg = sv_magicext(reginfo->sv, NULL, PERL_MAGIC_regex_global,
2670                                  &PL_vtbl_mglob, NULL, 0);
2671                 mg->mg_len = -1;
2672             }
2673             PL_reg_magic    = mg;
2674             PL_reg_oldpos   = mg->mg_len;
2675             SAVEDESTRUCTOR_X(restore_pos, prog);
2676         }
2677         if (!PL_reg_curpm) {
2678             Newxz(PL_reg_curpm, 1, PMOP);
2679 #ifdef USE_ITHREADS
2680             {
2681                 SV* const repointer = &PL_sv_undef;
2682                 /* this regexp is also owned by the new PL_reg_curpm, which
2683                    will try to free it.  */
2684                 av_push(PL_regex_padav, repointer);
2685                 PL_reg_curpm->op_pmoffset = av_len(PL_regex_padav);
2686                 PL_regex_pad = AvARRAY(PL_regex_padav);
2687             }
2688 #endif
2689         }
2690         SET_reg_curpm(rx);
2691         PL_reg_oldcurpm = PL_curpm;
2692         PL_curpm = PL_reg_curpm;
2693         if (RXp_MATCH_COPIED(prog)) {
2694             /*  Here is a serious problem: we cannot rewrite subbeg,
2695                 since it may be needed if this match fails.  Thus
2696                 $` inside (?{}) could fail... */
2697             PL_reg_oldsaved = prog->subbeg;
2698             PL_reg_oldsavedlen = prog->sublen;
2699 #ifdef PERL_OLD_COPY_ON_WRITE
2700             PL_nrs = prog->saved_copy;
2701 #endif
2702             RXp_MATCH_COPIED_off(prog);
2703         }
2704         else
2705             PL_reg_oldsaved = NULL;
2706         prog->subbeg = PL_bostr;
2707         prog->sublen = PL_regeol - PL_bostr; /* strend may have been modified */
2708     }
2709 #ifdef DEBUGGING
2710     PL_reg_starttry = *startpos;
2711 #endif
2712     prog->offs[0].start = *startpos - PL_bostr;
2713     PL_reginput = *startpos;
2714     prog->lastparen = 0;
2715     prog->lastcloseparen = 0;
2716     PL_regsize = 0;
2717
2718     /* XXXX What this code is doing here?!!!  There should be no need
2719        to do this again and again, prog->lastparen should take care of
2720        this!  --ilya*/
2721
2722     /* Tests pat.t#187 and split.t#{13,14} seem to depend on this code.
2723      * Actually, the code in regcppop() (which Ilya may be meaning by
2724      * prog->lastparen), is not needed at all by the test suite
2725      * (op/regexp, op/pat, op/split), but that code is needed otherwise
2726      * this erroneously leaves $1 defined: "1" =~ /^(?:(\d)x)?\d$/
2727      * Meanwhile, this code *is* needed for the
2728      * above-mentioned test suite tests to succeed.  The common theme
2729      * on those tests seems to be returning null fields from matches.
2730      * --jhi updated by dapm */
2731 #if 1
2732     if (prog->nparens) {
2733         regexp_paren_pair *pp = prog->offs;
2734         I32 i;
2735         for (i = prog->nparens; i > (I32)prog->lastparen; i--) {
2736             ++pp;
2737             pp->start = -1;
2738             pp->end = -1;
2739         }
2740     }
2741 #endif
2742     REGCP_SET(lastcp);
2743     if (regmatch(reginfo, progi->program + 1)) {
2744         prog->offs[0].end = PL_reginput - PL_bostr;
2745         return 1;
2746     }
2747     if (reginfo->cutpoint)
2748         *startpos= reginfo->cutpoint;
2749     REGCP_UNWIND(lastcp);
2750     return 0;
2751 }
2752
2753
2754 #define sayYES goto yes
2755 #define sayNO goto no
2756 #define sayNO_SILENT goto no_silent
2757
2758 /* we dont use STMT_START/END here because it leads to
2759    "unreachable code" warnings, which are bogus, but distracting. */
2760 #define CACHEsayNO \
2761     if (ST.cache_mask) \
2762        PL_reg_poscache[ST.cache_offset] |= ST.cache_mask; \
2763     sayNO
2764
2765 /* this is used to determine how far from the left messages like
2766    'failed...' are printed. It should be set such that messages
2767    are inline with the regop output that created them.
2768 */
2769 #define REPORT_CODE_OFF 32
2770
2771
2772 #define CHRTEST_UNINIT -1001 /* c1/c2 haven't been calculated yet */
2773 #define CHRTEST_VOID   -1000 /* the c1/c2 "next char" test should be skipped */
2774
2775 #define SLAB_FIRST(s) (&(s)->states[0])
2776 #define SLAB_LAST(s)  (&(s)->states[PERL_REGMATCH_SLAB_SLOTS-1])
2777
2778 /* grab a new slab and return the first slot in it */
2779
2780 STATIC regmatch_state *
2781 S_push_slab(pTHX)
2782 {
2783 #if PERL_VERSION < 9 && !defined(PERL_CORE)
2784     dMY_CXT;
2785 #endif
2786     regmatch_slab *s = PL_regmatch_slab->next;
2787     if (!s) {
2788         Newx(s, 1, regmatch_slab);
2789         s->prev = PL_regmatch_slab;
2790         s->next = NULL;
2791         PL_regmatch_slab->next = s;
2792     }
2793     PL_regmatch_slab = s;
2794     return SLAB_FIRST(s);
2795 }
2796
2797
2798 /* push a new state then goto it */
2799
2800 #define PUSH_STATE_GOTO(state, node) \
2801     scan = node; \
2802     st->resume_state = state; \
2803     goto push_state;
2804
2805 /* push a new state with success backtracking, then goto it */
2806
2807 #define PUSH_YES_STATE_GOTO(state, node) \
2808     scan = node; \
2809     st->resume_state = state; \
2810     goto push_yes_state;
2811
2812
2813
2814 /*
2815
2816 regmatch() - main matching routine
2817
2818 This is basically one big switch statement in a loop. We execute an op,
2819 set 'next' to point the next op, and continue. If we come to a point which
2820 we may need to backtrack to on failure such as (A|B|C), we push a
2821 backtrack state onto the backtrack stack. On failure, we pop the top
2822 state, and re-enter the loop at the state indicated. If there are no more
2823 states to pop, we return failure.
2824
2825 Sometimes we also need to backtrack on success; for example /A+/, where
2826 after successfully matching one A, we need to go back and try to
2827 match another one; similarly for lookahead assertions: if the assertion
2828 completes successfully, we backtrack to the state just before the assertion
2829 and then carry on.  In these cases, the pushed state is marked as
2830 'backtrack on success too'. This marking is in fact done by a chain of
2831 pointers, each pointing to the previous 'yes' state. On success, we pop to
2832 the nearest yes state, discarding any intermediate failure-only states.
2833 Sometimes a yes state is pushed just to force some cleanup code to be
2834 called at the end of a successful match or submatch; e.g. (??{$re}) uses
2835 it to free the inner regex.
2836
2837 Note that failure backtracking rewinds the cursor position, while
2838 success backtracking leaves it alone.
2839
2840 A pattern is complete when the END op is executed, while a subpattern
2841 such as (?=foo) is complete when the SUCCESS op is executed. Both of these
2842 ops trigger the "pop to last yes state if any, otherwise return true"
2843 behaviour.
2844
2845 A common convention in this function is to use A and B to refer to the two
2846 subpatterns (or to the first nodes thereof) in patterns like /A*B/: so A is
2847 the subpattern to be matched possibly multiple times, while B is the entire
2848 rest of the pattern. Variable and state names reflect this convention.
2849
2850 The states in the main switch are the union of ops and failure/success of
2851 substates associated with with that op.  For example, IFMATCH is the op
2852 that does lookahead assertions /(?=A)B/ and so the IFMATCH state means
2853 'execute IFMATCH'; while IFMATCH_A is a state saying that we have just
2854 successfully matched A and IFMATCH_A_fail is a state saying that we have
2855 just failed to match A. Resume states always come in pairs. The backtrack
2856 state we push is marked as 'IFMATCH_A', but when that is popped, we resume
2857 at IFMATCH_A or IFMATCH_A_fail, depending on whether we are backtracking
2858 on success or failure.
2859
2860 The struct that holds a backtracking state is actually a big union, with
2861 one variant for each major type of op. The variable st points to the
2862 top-most backtrack struct. To make the code clearer, within each
2863 block of code we #define ST to alias the relevant union.
2864
2865 Here's a concrete example of a (vastly oversimplified) IFMATCH
2866 implementation:
2867
2868     switch (state) {
2869     ....
2870
2871 #define ST st->u.ifmatch
2872
2873     case IFMATCH: // we are executing the IFMATCH op, (?=A)B
2874         ST.foo = ...; // some state we wish to save
2875         ...
2876         // push a yes backtrack state with a resume value of
2877         // IFMATCH_A/IFMATCH_A_fail, then continue execution at the
2878         // first node of A:
2879         PUSH_YES_STATE_GOTO(IFMATCH_A, A);
2880         // NOTREACHED
2881
2882     case IFMATCH_A: // we have successfully executed A; now continue with B
2883         next = B;
2884         bar = ST.foo; // do something with the preserved value
2885         break;
2886
2887     case IFMATCH_A_fail: // A failed, so the assertion failed
2888         ...;   // do some housekeeping, then ...
2889         sayNO; // propagate the failure
2890
2891 #undef ST
2892
2893     ...
2894     }
2895
2896 For any old-timers reading this who are familiar with the old recursive
2897 approach, the code above is equivalent to:
2898
2899     case IFMATCH: // we are executing the IFMATCH op, (?=A)B
2900     {
2901         int foo = ...
2902         ...
2903         if (regmatch(A)) {
2904             next = B;
2905             bar = foo;
2906             break;
2907         }
2908         ...;   // do some housekeeping, then ...
2909         sayNO; // propagate the failure
2910     }
2911
2912 The topmost backtrack state, pointed to by st, is usually free. If you
2913 want to claim it, populate any ST.foo fields in it with values you wish to
2914 save, then do one of
2915
2916         PUSH_STATE_GOTO(resume_state, node);
2917         PUSH_YES_STATE_GOTO(resume_state, node);
2918
2919 which sets that backtrack state's resume value to 'resume_state', pushes a
2920 new free entry to the top of the backtrack stack, then goes to 'node'.
2921 On backtracking, the free slot is popped, and the saved state becomes the
2922 new free state. An ST.foo field in this new top state can be temporarily
2923 accessed to retrieve values, but once the main loop is re-entered, it
2924 becomes available for reuse.
2925
2926 Note that the depth of the backtrack stack constantly increases during the
2927 left-to-right execution of the pattern, rather than going up and down with
2928 the pattern nesting. For example the stack is at its maximum at Z at the
2929 end of the pattern, rather than at X in the following:
2930
2931     /(((X)+)+)+....(Y)+....Z/
2932
2933 The only exceptions to this are lookahead/behind assertions and the cut,
2934 (?>A), which pop all the backtrack states associated with A before
2935 continuing.
2936
2937 Backtrack state structs are allocated in slabs of about 4K in size.
2938 PL_regmatch_state and st always point to the currently active state,
2939 and PL_regmatch_slab points to the slab currently containing
2940 PL_regmatch_state.  The first time regmatch() is called, the first slab is
2941 allocated, and is never freed until interpreter destruction. When the slab
2942 is full, a new one is allocated and chained to the end. At exit from
2943 regmatch(), slabs allocated since entry are freed.
2944
2945 */
2946
2947
2948 #define DEBUG_STATE_pp(pp)                                  \
2949     DEBUG_STATE_r({                                         \
2950         DUMP_EXEC_POS(locinput, scan, utf8_target);                 \
2951         PerlIO_printf(Perl_debug_log,                       \
2952             "    %*s"pp" %s%s%s%s%s\n",                     \
2953             depth*2, "",                                    \
2954             PL_reg_name[st->resume_state],                     \
2955             ((st==yes_state||st==mark_state) ? "[" : ""),   \
2956             ((st==yes_state) ? "Y" : ""),                   \
2957             ((st==mark_state) ? "M" : ""),                  \
2958             ((st==yes_state||st==mark_state) ? "]" : "")    \
2959         );                                                  \
2960     });
2961
2962
2963 #define REG_NODE_NUM(x) ((x) ? (int)((x)-prog) : -1)
2964
2965 #ifdef DEBUGGING
2966
2967 STATIC void
2968 S_debug_start_match(pTHX_ const REGEXP *prog, const bool utf8_target,
2969     const char *start, const char *end, const char *blurb)
2970 {
2971     const bool utf8_pat = RX_UTF8(prog) ? 1 : 0;
2972
2973     PERL_ARGS_ASSERT_DEBUG_START_MATCH;
2974
2975     if (!PL_colorset)
2976             reginitcolors();
2977     {
2978         RE_PV_QUOTED_DECL(s0, utf8_pat, PERL_DEBUG_PAD_ZERO(0),
2979             RX_PRECOMP_const(prog), RX_PRELEN(prog), 60);
2980
2981         RE_PV_QUOTED_DECL(s1, utf8_target, PERL_DEBUG_PAD_ZERO(1),
2982             start, end - start, 60);
2983
2984         PerlIO_printf(Perl_debug_log,
2985             "%s%s REx%s %s against %s\n",
2986                        PL_colors[4], blurb, PL_colors[5], s0, s1);
2987
2988         if (utf8_target||utf8_pat)
2989             PerlIO_printf(Perl_debug_log, "UTF-8 %s%s%s...\n",
2990                 utf8_pat ? "pattern" : "",
2991                 utf8_pat && utf8_target ? " and " : "",
2992                 utf8_target ? "string" : ""
2993             );
2994     }
2995 }
2996
2997 STATIC void
2998 S_dump_exec_pos(pTHX_ const char *locinput,
2999                       const regnode *scan,
3000                       const char *loc_regeol,
3001                       const char *loc_bostr,
3002                       const char *loc_reg_starttry,
3003                       const bool utf8_target)
3004 {
3005     const int docolor = *PL_colors[0] || *PL_colors[2] || *PL_colors[4];
3006     const int taill = (docolor ? 10 : 7); /* 3 chars for "> <" */
3007     int l = (loc_regeol - locinput) > taill ? taill : (loc_regeol - locinput);
3008     /* The part of the string before starttry has one color
3009        (pref0_len chars), between starttry and current
3010        position another one (pref_len - pref0_len chars),
3011        after the current position the third one.
3012        We assume that pref0_len <= pref_len, otherwise we
3013        decrease pref0_len.  */
3014     int pref_len = (locinput - loc_bostr) > (5 + taill) - l
3015         ? (5 + taill) - l : locinput - loc_bostr;
3016     int pref0_len;
3017
3018     PERL_ARGS_ASSERT_DUMP_EXEC_POS;
3019
3020     while (utf8_target && UTF8_IS_CONTINUATION(*(U8*)(locinput - pref_len)))
3021         pref_len++;
3022     pref0_len = pref_len  - (locinput - loc_reg_starttry);
3023     if (l + pref_len < (5 + taill) && l < loc_regeol - locinput)
3024         l = ( loc_regeol - locinput > (5 + taill) - pref_len
3025               ? (5 + taill) - pref_len : loc_regeol - locinput);
3026     while (utf8_target && UTF8_IS_CONTINUATION(*(U8*)(locinput + l)))
3027         l--;
3028     if (pref0_len < 0)
3029         pref0_len = 0;
3030     if (pref0_len > pref_len)
3031         pref0_len = pref_len;
3032     {
3033         const int is_uni = (utf8_target && OP(scan) != CANY) ? 1 : 0;
3034
3035         RE_PV_COLOR_DECL(s0,len0,is_uni,PERL_DEBUG_PAD(0),
3036             (locinput - pref_len),pref0_len, 60, 4, 5);
3037
3038         RE_PV_COLOR_DECL(s1,len1,is_uni,PERL_DEBUG_PAD(1),
3039                     (locinput - pref_len + pref0_len),
3040                     pref_len - pref0_len, 60, 2, 3);
3041
3042         RE_PV_COLOR_DECL(s2,len2,is_uni,PERL_DEBUG_PAD(2),
3043                     locinput, loc_regeol - locinput, 10, 0, 1);
3044
3045         const STRLEN tlen=len0+len1+len2;
3046         PerlIO_printf(Perl_debug_log,
3047                     "%4"IVdf" <%.*s%.*s%s%.*s>%*s|",
3048                     (IV)(locinput - loc_bostr),
3049                     len0, s0,
3050                     len1, s1,
3051                     (docolor ? "" : "> <"),
3052                     len2, s2,
3053                     (int)(tlen > 19 ? 0 :  19 - tlen),
3054                     "");
3055     }
3056 }
3057
3058 #endif
3059
3060 /* reg_check_named_buff_matched()
3061  * Checks to see if a named buffer has matched. The data array of
3062  * buffer numbers corresponding to the buffer is expected to reside
3063  * in the regexp->data->data array in the slot stored in the ARG() of
3064  * node involved. Note that this routine doesn't actually care about the
3065  * name, that information is not preserved from compilation to execution.
3066  * Returns the index of the leftmost defined buffer with the given name
3067  * or 0 if non of the buffers matched.
3068  */
3069 STATIC I32
3070 S_reg_check_named_buff_matched(pTHX_ const regexp *rex, const regnode *scan)
3071 {
3072     I32 n;
3073     RXi_GET_DECL(rex,rexi);
3074     SV *sv_dat= MUTABLE_SV(rexi->data->data[ ARG( scan ) ]);
3075     I32 *nums=(I32*)SvPVX(sv_dat);
3076
3077     PERL_ARGS_ASSERT_REG_CHECK_NAMED_BUFF_MATCHED;
3078
3079     for ( n=0; n<SvIVX(sv_dat); n++ ) {
3080         if ((I32)rex->lastparen >= nums[n] &&
3081             rex->offs[nums[n]].end != -1)
3082         {
3083             return nums[n];
3084         }
3085     }
3086     return 0;
3087 }
3088
3089
3090 /* free all slabs above current one  - called during LEAVE_SCOPE */
3091
3092 STATIC void
3093 S_clear_backtrack_stack(pTHX_ void *p)
3094 {
3095     regmatch_slab *s = PL_regmatch_slab->next;
3096     PERL_UNUSED_ARG(p);
3097
3098     if (!s)
3099         return;
3100     PL_regmatch_slab->next = NULL;
3101     while (s) {
3102         regmatch_slab * const osl = s;
3103         s = s->next;
3104         Safefree(osl);
3105     }
3106 }
3107
3108
3109 STATIC I32                      /* 0 failure, 1 success */
3110 S_regmatch(pTHX_ regmatch_info *reginfo, regnode *prog)
3111 {
3112 #if PERL_VERSION < 9 && !defined(PERL_CORE)
3113     dMY_CXT;
3114 #endif
3115     dVAR;
3116     const bool utf8_target = PL_reg_match_utf8;
3117     const U32 uniflags = UTF8_ALLOW_DEFAULT;
3118     REGEXP *rex_sv = reginfo->prog;
3119     regexp *rex = (struct regexp *)SvANY(rex_sv);
3120     RXi_GET_DECL(rex,rexi);
3121     I32 oldsave;
3122     /* the current state. This is a cached copy of PL_regmatch_state */
3123     regmatch_state *st;
3124     /* cache heavy used fields of st in registers */
3125     regnode *scan;
3126     regnode *next;
3127     U32 n = 0;  /* general value; init to avoid compiler warning */
3128     I32 ln = 0; /* len or last;  init to avoid compiler warning */
3129     char *locinput = PL_reginput;
3130     I32 nextchr;   /* is always set to UCHARAT(locinput) */
3131
3132     bool result = 0;        /* return value of S_regmatch */
3133     int depth = 0;          /* depth of backtrack stack */
3134     U32 nochange_depth = 0; /* depth of GOSUB recursion with nochange */
3135     const U32 max_nochange_depth =
3136         (3 * rex->nparens > MAX_RECURSE_EVAL_NOCHANGE_DEPTH) ?
3137         3 * rex->nparens : MAX_RECURSE_EVAL_NOCHANGE_DEPTH;
3138     regmatch_state *yes_state = NULL; /* state to pop to on success of
3139                                                             subpattern */
3140     /* mark_state piggy backs on the yes_state logic so that when we unwind
3141        the stack on success we can update the mark_state as we go */
3142     regmatch_state *mark_state = NULL; /* last mark state we have seen */
3143     regmatch_state *cur_eval = NULL; /* most recent EVAL_AB state */
3144     struct regmatch_state  *cur_curlyx = NULL; /* most recent curlyx */
3145     U32 state_num;
3146     bool no_final = 0;      /* prevent failure from backtracking? */
3147     bool do_cutgroup = 0;   /* no_final only until next branch/trie entry */
3148     char *startpoint = PL_reginput;
3149     SV *popmark = NULL;     /* are we looking for a mark? */
3150     SV *sv_commit = NULL;   /* last mark name seen in failure */
3151     SV *sv_yes_mark = NULL; /* last mark name we have seen
3152                                during a successful match */
3153     U32 lastopen = 0;       /* last open we saw */
3154     bool has_cutgroup = RX_HAS_CUTGROUP(rex) ? 1 : 0;
3155     SV* const oreplsv = GvSV(PL_replgv);
3156     /* these three flags are set by various ops to signal information to
3157      * the very next op. They have a useful lifetime of exactly one loop
3158      * iteration, and are not preserved or restored by state pushes/pops
3159      */
3160     bool sw = 0;            /* the condition value in (?(cond)a|b) */
3161     bool minmod = 0;        /* the next "{n,m}" is a "{n,m}?" */
3162     int logical = 0;        /* the following EVAL is:
3163                                 0: (?{...})
3164                                 1: (?(?{...})X|Y)
3165                                 2: (??{...})
3166                                or the following IFMATCH/UNLESSM is:
3167                                 false: plain (?=foo)
3168                                 true:  used as a condition: (?(?=foo))
3169                             */
3170     PAD* last_pad = NULL;
3171     dMULTICALL;
3172     I32 gimme = G_SCALAR;
3173     CV *caller_cv = NULL;       /* who called us */
3174     CV *last_pushed_cv = NULL;  /* most recently called (?{}) CV */
3175     CHECKPOINT runops_cp;       /* savestack position before executing EVAL */
3176
3177 #ifdef DEBUGGING
3178     GET_RE_DEBUG_FLAGS_DECL;
3179 #endif
3180
3181     /* shut up 'may be used uninitialized' compiler warnings for dMULTICALL */
3182     multicall_oldcatch = 0;
3183     multicall_cv = NULL;
3184     cx = NULL;
3185     PERL_UNUSED_VAR(multicall_cop);
3186     PERL_UNUSED_VAR(newsp);
3187
3188
3189     PERL_ARGS_ASSERT_REGMATCH;
3190
3191     DEBUG_OPTIMISE_r( DEBUG_EXECUTE_r({
3192             PerlIO_printf(Perl_debug_log,"regmatch start\n");
3193     }));
3194     /* on first ever call to regmatch, allocate first slab */
3195     if (!PL_regmatch_slab) {
3196         Newx(PL_regmatch_slab, 1, regmatch_slab);
3197         PL_regmatch_slab->prev = NULL;
3198         PL_regmatch_slab->next = NULL;
3199         PL_regmatch_state = SLAB_FIRST(PL_regmatch_slab);
3200     }
3201
3202     oldsave = PL_savestack_ix;
3203     SAVEDESTRUCTOR_X(S_clear_backtrack_stack, NULL);
3204     SAVEVPTR(PL_regmatch_slab);
3205     SAVEVPTR(PL_regmatch_state);
3206
3207     /* grab next free state slot */
3208     st = ++PL_regmatch_state;
3209     if (st >  SLAB_LAST(PL_regmatch_slab))
3210         st = PL_regmatch_state = S_push_slab(aTHX);
3211
3212     /* Note that nextchr is a byte even in UTF */
3213     nextchr = UCHARAT(locinput);
3214     scan = prog;
3215     while (scan != NULL) {
3216
3217         DEBUG_EXECUTE_r( {
3218             SV * const prop = sv_newmortal();
3219             regnode *rnext=regnext(scan);
3220             DUMP_EXEC_POS( locinput, scan, utf8_target );
3221             regprop(rex, prop, scan);
3222
3223             PerlIO_printf(Perl_debug_log,
3224                     "%3"IVdf":%*s%s(%"IVdf")\n",
3225                     (IV)(scan - rexi->program), depth*2, "",
3226                     SvPVX_const(prop),
3227                     (PL_regkind[OP(scan)] == END || !rnext) ?
3228                         0 : (IV)(rnext - rexi->program));
3229         });
3230
3231         next = scan + NEXT_OFF(scan);
3232         if (next == scan)
3233             next = NULL;
3234         state_num = OP(scan);
3235
3236       reenter_switch:
3237
3238         switch (state_num) {
3239         case BOL:
3240             if (locinput == PL_bostr)
3241             {
3242                 /* reginfo->till = reginfo->bol; */
3243                 break;
3244             }
3245             sayNO;
3246         case MBOL:
3247             if (locinput == PL_bostr ||
3248                 ((nextchr || locinput < PL_regeol) && locinput[-1] == '\n'))
3249             {
3250                 break;
3251             }
3252             sayNO;
3253         case SBOL:
3254             if (locinput == PL_bostr)
3255                 break;
3256             sayNO;
3257         case GPOS:
3258             if (locinput == reginfo->ganch)
3259                 break;
3260             sayNO;
3261
3262         case KEEPS:
3263             /* update the startpoint */
3264             st->u.keeper.val = rex->offs[0].start;
3265             PL_reginput = locinput;
3266             rex->offs[0].start = locinput - PL_bostr;
3267             PUSH_STATE_GOTO(KEEPS_next, next);
3268             /*NOT-REACHED*/
3269         case KEEPS_next_fail:
3270             /* rollback the start point change */
3271             rex->offs[0].start = st->u.keeper.val;
3272             sayNO_SILENT;
3273             /*NOT-REACHED*/
3274         case EOL:
3275                 goto seol;
3276         case MEOL:
3277             if ((nextchr || locinput < PL_regeol) && nextchr != '\n')
3278                 sayNO;
3279             break;
3280         case SEOL:
3281           seol:
3282             if ((nextchr || locinput < PL_regeol) && nextchr != '\n')
3283                 sayNO;
3284             if (PL_regeol - locinput > 1)
3285                 sayNO;
3286             break;
3287         case EOS:
3288             if (PL_regeol != locinput)
3289                 sayNO;
3290             break;
3291         case SANY:
3292             if (!nextchr && locinput >= PL_regeol)
3293                 sayNO;
3294             if (utf8_target) {
3295                 locinput += PL_utf8skip[nextchr];
3296                 if (locinput > PL_regeol)
3297                     sayNO;
3298                 nextchr = UCHARAT(locinput);
3299             }
3300             else
3301                 nextchr = UCHARAT(++locinput);
3302             break;
3303         case CANY:
3304             if (!nextchr && locinput >= PL_regeol)
3305                 sayNO;
3306             nextchr = UCHARAT(++locinput);
3307             break;
3308         case REG_ANY:
3309             if ((!nextchr && locinput >= PL_regeol) || nextchr == '\n')
3310                 sayNO;
3311             if (utf8_target) {
3312                 locinput += PL_utf8skip[nextchr];
3313                 if (locinput > PL_regeol)
3314                     sayNO;
3315                 nextchr = UCHARAT(locinput);
3316             }
3317             else
3318                 nextchr = UCHARAT(++locinput);
3319             break;
3320
3321 #undef  ST
3322 #define ST st->u.trie
3323         case TRIEC:
3324             /* In this case the charclass data is available inline so
3325                we can fail fast without a lot of extra overhead.
3326              */
3327             if(!ANYOF_BITMAP_TEST(scan, *locinput)) {
3328                 DEBUG_EXECUTE_r(
3329                     PerlIO_printf(Perl_debug_log,
3330                               "%*s  %sfailed to match trie start class...%s\n",
3331                               REPORT_CODE_OFF+depth*2, "", PL_colors[4], PL_colors[5])
3332                 );
3333                 sayNO_SILENT;
3334                 assert(0); /* NOTREACHED */
3335             }
3336             /* FALL THROUGH */
3337         case TRIE:
3338             /* the basic plan of execution of the trie is:
3339              * At the beginning, run though all the states, and
3340              * find the longest-matching word. Also remember the position
3341              * of the shortest matching word. For example, this pattern:
3342              *    1  2 3 4    5
3343              *    ab|a|x|abcd|abc
3344              * when matched against the string "abcde", will generate
3345              * accept states for all words except 3, with the longest
3346              * matching word being 4, and the shortest being 1 (with
3347              * the position being after char 1 of the string).
3348              *
3349              * Then for each matching word, in word order (i.e. 1,2,4,5),
3350              * we run the remainder of the pattern; on each try setting
3351              * the current position to the character following the word,
3352              * returning to try the next word on failure.
3353              *
3354              * We avoid having to build a list of words at runtime by
3355              * using a compile-time structure, wordinfo[].prev, which
3356              * gives, for each word, the previous accepting word (if any).
3357              * In the case above it would contain the mappings 1->2, 2->0,
3358              * 3->0, 4->5, 5->1.  We can use this table to generate, from
3359              * the longest word (4 above), a list of all words, by
3360              * following the list of prev pointers; this gives us the
3361              * unordered list 4,5,1,2. Then given the current word we have
3362              * just tried, we can go through the list and find the
3363              * next-biggest word to try (so if we just failed on word 2,
3364              * the next in the list is 4).
3365              *
3366              * Since at runtime we don't record the matching position in
3367              * the string for each word, we have to work that out for
3368              * each word we're about to process. The wordinfo table holds
3369              * the character length of each word; given that we recorded
3370              * at the start: the position of the shortest word and its
3371              * length in chars, we just need to move the pointer the
3372              * difference between the two char lengths. Depending on
3373              * Unicode status and folding, that's cheap or expensive.
3374              *
3375              * This algorithm is optimised for the case where are only a
3376              * small number of accept states, i.e. 0,1, or maybe 2.
3377              * With lots of accepts states, and having to try all of them,
3378              * it becomes quadratic on number of accept states to find all
3379              * the next words.
3380              */
3381
3382             {
3383                 /* what type of TRIE am I? (utf8 makes this contextual) */
3384                 DECL_TRIE_TYPE(scan);
3385
3386                 /* what trie are we using right now */
3387                 reg_trie_data * const trie
3388                     = (reg_trie_data*)rexi->data->data[ ARG( scan ) ];
3389                 HV * widecharmap = MUTABLE_HV(rexi->data->data[ ARG( scan ) + 1 ]);
3390                 U32 state = trie->startstate;
3391
3392                 if (trie->bitmap && !TRIE_BITMAP_TEST(trie,*locinput) ) {
3393                     if (trie->states[ state ].wordnum) {
3394                          DEBUG_EXECUTE_r(
3395                             PerlIO_printf(Perl_debug_log,
3396                                           "%*s  %smatched empty string...%s\n",
3397                                           REPORT_CODE_OFF+depth*2, "", PL_colors[4], PL_colors[5])
3398                         );
3399                         if (!trie->jump)
3400                             break;
3401                     } else {
3402                         DEBUG_EXECUTE_r(
3403                             PerlIO_printf(Perl_debug_log,
3404                                           "%*s  %sfailed to match trie start class...%s\n",
3405                                           REPORT_CODE_OFF+depth*2, "", PL_colors[4], PL_colors[5])
3406                         );
3407                         sayNO_SILENT;
3408                    }
3409                 }
3410
3411             {
3412                 U8 *uc = ( U8* )locinput;
3413
3414                 STRLEN len = 0;
3415                 STRLEN foldlen = 0;
3416                 U8 *uscan = (U8*)NULL;
3417                 U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
3418                 U32 charcount = 0; /* how many input chars we have matched */
3419                 U32 accepted = 0; /* have we seen any accepting states? */
3420
3421                 ST.jump = trie->jump;
3422                 ST.me = scan;
3423                 ST.firstpos = NULL;
3424                 ST.longfold = FALSE; /* char longer if folded => it's harder */
3425                 ST.nextword = 0;
3426
3427                 /* fully traverse the TRIE; note the position of the
3428                    shortest accept state and the wordnum of the longest
3429                    accept state */
3430
3431                 while ( state && uc <= (U8*)PL_regeol ) {
3432                     U32 base = trie->states[ state ].trans.base;
3433                     UV uvc = 0;
3434                     U16 charid = 0;
3435                     U16 wordnum;
3436                     wordnum = trie->states[ state ].wordnum;
3437
3438                     if (wordnum) { /* it's an accept state */
3439                         if (!accepted) {
3440                             accepted = 1;
3441                             /* record first match position */
3442                             if (ST.longfold) {
3443                                 ST.firstpos = (U8*)locinput;
3444                                 ST.firstchars = 0;
3445                             }
3446                             else {
3447                                 ST.firstpos = uc;
3448                                 ST.firstchars = charcount;
3449                             }
3450                         }
3451                         if (!ST.nextword || wordnum < ST.nextword)
3452                             ST.nextword = wordnum;
3453                         ST.topword = wordnum;
3454                     }
3455
3456                     DEBUG_TRIE_EXECUTE_r({
3457                                 DUMP_EXEC_POS( (char *)uc, scan, utf8_target );
3458                                 PerlIO_printf( Perl_debug_log,
3459                                     "%*s  %sState: %4"UVxf" Accepted: %c ",
3460                                     2+depth * 2, "", PL_colors[4],
3461                                     (UV)state, (accepted ? 'Y' : 'N'));
3462                     });
3463
3464                     /* read a char and goto next state */
3465                     if ( base ) {
3466                         I32 offset;
3467                         REXEC_TRIE_READ_CHAR(trie_type, trie, widecharmap, uc,
3468                                              uscan, len, uvc, charid, foldlen,
3469                                              foldbuf, uniflags);
3470                         charcount++;
3471                         if (foldlen>0)
3472                             ST.longfold = TRUE;
3473                         if (charid &&
3474                              ( ((offset =
3475                               base + charid - 1 - trie->uniquecharcount)) >= 0)
3476
3477                              && ((U32)offset < trie->lasttrans)
3478                              && trie->trans[offset].check == state)
3479                         {
3480                             state = trie->trans[offset].next;
3481                         }
3482                         else {
3483                             state = 0;
3484                         }
3485                         uc += len;
3486
3487                     }
3488                     else {
3489                         state = 0;
3490                     }
3491                     DEBUG_TRIE_EXECUTE_r(
3492                         PerlIO_printf( Perl_debug_log,
3493                             "Charid:%3x CP:%4"UVxf" After State: %4"UVxf"%s\n",
3494                             charid, uvc, (UV)state, PL_colors[5] );
3495                     );
3496                 }
3497                 if (!accepted)
3498                    sayNO;
3499
3500                 /* calculate total number of accept states */
3501                 {
3502                     U16 w = ST.topword;
3503                     accepted = 0;
3504                     while (w) {
3505                         w = trie->wordinfo[w].prev;
3506                         accepted++;
3507                     }
3508                     ST.accepted = accepted;
3509                 }
3510
3511                 DEBUG_EXECUTE_r(
3512                     PerlIO_printf( Perl_debug_log,
3513                         "%*s  %sgot %"IVdf" possible matches%s\n",
3514                         REPORT_CODE_OFF + depth * 2, "",
3515                         PL_colors[4], (IV)ST.accepted, PL_colors[5] );
3516                 );
3517                 goto trie_first_try; /* jump into the fail handler */
3518             }}
3519             assert(0); /* NOTREACHED */
3520
3521         case TRIE_next_fail: /* we failed - try next alternative */
3522             if ( ST.jump) {
3523                 REGCP_UNWIND(ST.cp);
3524                 UNWIND_PAREN(ST.lastparen, ST.lastcloseparen);
3525             }
3526             if (!--ST.accepted) {
3527                 DEBUG_EXECUTE_r({
3528                     PerlIO_printf( Perl_debug_log,
3529                         "%*s  %sTRIE failed...%s\n",
3530                         REPORT_CODE_OFF+depth*2, "",
3531                         PL_colors[4],
3532                         PL_colors[5] );
3533                 });
3534                 sayNO_SILENT;
3535             }
3536             {
3537                 /* Find next-highest word to process.  Note that this code
3538                  * is O(N^2) per trie run (O(N) per branch), so keep tight */
3539                 U16 min = 0;
3540                 U16 word;
3541                 U16 const nextword = ST.nextword;
3542                 reg_trie_wordinfo * const wordinfo
3543                     = ((reg_trie_data*)rexi->data->data[ARG(ST.me)])->wordinfo;
3544                 for (word=ST.topword; word; word=wordinfo[word].prev) {
3545                     if (word > nextword && (!min || word < min))
3546                         min = word;
3547                 }
3548                 ST.nextword = min;
3549             }
3550
3551           trie_first_try:
3552             if (do_cutgroup) {
3553                 do_cutgroup = 0;
3554                 no_final = 0;
3555             }
3556
3557             if ( ST.jump) {
3558                 ST.lastparen = rex->lastparen;
3559                 ST.lastcloseparen = rex->lastcloseparen;
3560                 REGCP_SET(ST.cp);
3561             }
3562
3563             /* find start char of end of current word */
3564             {
3565                 U32 chars; /* how many chars to skip */
3566                 U8 *uc = ST.firstpos;
3567                 reg_trie_data * const trie
3568                     = (reg_trie_data*)rexi->data->data[ARG(ST.me)];
3569
3570                 assert((trie->wordinfo[ST.nextword].len - trie->prefixlen)
3571                             >=  ST.firstchars);
3572                 chars = (trie->wordinfo[ST.nextword].len - trie->prefixlen)
3573                             - ST.firstchars;
3574
3575                 if (ST.longfold) {
3576                     /* the hard option - fold each char in turn and find
3577                      * its folded length (which may be different */
3578                     U8 foldbuf[UTF8_MAXBYTES_CASE + 1];
3579                     STRLEN foldlen;
3580                     STRLEN len;
3581                     UV uvc;
3582                     U8 *uscan;
3583
3584                     while (chars) {
3585                         if (utf8_target) {
3586                             uvc = utf8n_to_uvuni((U8*)uc, UTF8_MAXLEN, &len,
3587                                                     uniflags);
3588                             uc += len;
3589                         }
3590                         else {
3591                             uvc = *uc;
3592                             uc++;
3593                         }
3594                         uvc = to_uni_fold(uvc, foldbuf, &foldlen);
3595                         uscan = foldbuf;
3596                         while (foldlen) {
3597                             if (!--chars)
3598                                 break;
3599                             uvc = utf8n_to_uvuni(uscan, UTF8_MAXLEN, &len,
3600                                             uniflags);
3601                             uscan += len;
3602                             foldlen -= len;
3603                         }
3604                     }
3605                 }
3606                 else {
3607                     if (utf8_target)
3608                         while (chars--)
3609                             uc += UTF8SKIP(uc);
3610                     else
3611                         uc += chars;
3612                 }
3613                 PL_reginput = (char *)uc;
3614             }
3615
3616             scan = ST.me + ((ST.jump && ST.jump[ST.nextword])
3617                             ? ST.jump[ST.nextword]
3618                             : NEXT_OFF(ST.me));
3619
3620             DEBUG_EXECUTE_r({
3621                 PerlIO_printf( Perl_debug_log,
3622                     "%*s  %sTRIE matched word #%d, continuing%s\n",
3623                     REPORT_CODE_OFF+depth*2, "",
3624                     PL_colors[4],
3625                     ST.nextword,
3626                     PL_colors[5]
3627                     );
3628             });
3629
3630             if (ST.accepted > 1 || has_cutgroup) {
3631                 PUSH_STATE_GOTO(TRIE_next, scan);
3632                 assert(0); /* NOTREACHED */
3633             }
3634             /* only one choice left - just continue */
3635             DEBUG_EXECUTE_r({
3636                 AV *const trie_words
3637                     = MUTABLE_AV(rexi->data->data[ARG(ST.me)+TRIE_WORDS_OFFSET]);
3638                 SV ** const tmp = av_fetch( trie_words,
3639                     ST.nextword-1, 0 );
3640                 SV *sv= tmp ? sv_newmortal() : NULL;
3641
3642                 PerlIO_printf( Perl_debug_log,
3643                     "%*s  %sonly one match left, short-circuiting: #%d <%s>%s\n",
3644                     REPORT_CODE_OFF+depth*2, "", PL_colors[4],
3645                     ST.nextword,
3646                     tmp ? pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), 0,
3647                             PL_colors[0], PL_colors[1],
3648                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0)|PERL_PV_ESCAPE_NONASCII
3649                         )
3650                     : "not compiled under -Dr",
3651                     PL_colors[5] );
3652             });
3653
3654             locinput = PL_reginput;
3655             nextchr = UCHARAT(locinput);
3656             continue; /* execute rest of RE */
3657             assert(0); /* NOTREACHED */
3658 #undef  ST
3659
3660         case EXACT: {
3661             char *s = STRING(scan);
3662             ln = STR_LEN(scan);
3663             if (utf8_target != UTF_PATTERN) {
3664                 /* The target and the pattern have differing utf8ness. */
3665                 char *l = locinput;
3666                 const char * const e = s + ln;
3667
3668                 if (utf8_target) {
3669                     /* The target is utf8, the pattern is not utf8. */
3670                     while (s < e) {
3671                         STRLEN ulen;
3672                         if (l >= PL_regeol)
3673                              sayNO;
3674                         if (NATIVE_TO_UNI(*(U8*)s) !=
3675                             utf8n_to_uvuni((U8*)l, UTF8_MAXBYTES, &ulen,
3676                                             uniflags))
3677                              sayNO;
3678                         l += ulen;
3679                         s ++;
3680                     }
3681                 }
3682                 else {
3683                     /* The target is not utf8, the pattern is utf8. */
3684                     while (s < e) {
3685                         STRLEN ulen;
3686                         if (l >= PL_regeol)
3687                             sayNO;
3688                         if (NATIVE_TO_UNI(*((U8*)l)) !=
3689                             utf8n_to_uvuni((U8*)s, UTF8_MAXBYTES, &ulen,
3690                                            uniflags))
3691                             sayNO;
3692                         s += ulen;
3693                         l ++;
3694                     }
3695                 }
3696                 locinput = l;
3697                 nextchr = UCHARAT(locinput);
3698                 break;
3699             }
3700             /* The target and the pattern have the same utf8ness. */
3701             /* Inline the first character, for speed. */
3702             if (UCHARAT(s) != nextchr)
3703                 sayNO;
3704             if (PL_regeol - locinput < ln)
3705                 sayNO;
3706             if (ln > 1 && memNE(s, locinput, ln))
3707                 sayNO;
3708             locinput += ln;
3709             nextchr = UCHARAT(locinput);
3710             break;
3711             }
3712         case EXACTFL: {
3713             re_fold_t folder;
3714             const U8 * fold_array;
3715             const char * s;
3716             U32 fold_utf8_flags;
3717
3718             PL_reg_flags |= RF_tainted;
3719             folder = foldEQ_locale;
3720             fold_array = PL_fold_locale;
3721             fold_utf8_flags = FOLDEQ_UTF8_LOCALE;
3722             goto do_exactf;
3723
3724         case EXACTFU_SS:
3725         case EXACTFU_TRICKYFOLD:
3726         case EXACTFU:
3727             folder = foldEQ_latin1;
3728             fold_array = PL_fold_latin1;
3729             fold_utf8_flags = (UTF_PATTERN) ? FOLDEQ_S1_ALREADY_FOLDED : 0;
3730             goto do_exactf;
3731
3732         case EXACTFA:
3733             folder = foldEQ_latin1;
3734             fold_array = PL_fold_latin1;
3735             fold_utf8_flags = FOLDEQ_UTF8_NOMIX_ASCII;
3736             goto do_exactf;
3737
3738         case EXACTF:
3739             folder = foldEQ;
3740             fold_array = PL_fold;
3741             fold_utf8_flags = 0;
3742
3743           do_exactf:
3744             s = STRING(scan);
3745             ln = STR_LEN(scan);
3746
3747             if (utf8_target || UTF_PATTERN || state_num == EXACTFU_SS) {
3748               /* Either target or the pattern are utf8, or has the issue where
3749                * the fold lengths may differ. */
3750                 const char * const l = locinput;
3751                 char *e = PL_regeol;
3752
3753                 if (! foldEQ_utf8_flags(s, 0,  ln, cBOOL(UTF_PATTERN),
3754                                         l, &e, 0,  utf8_target, fold_utf8_flags))
3755                 {
3756                     sayNO;
3757                 }
3758                 locinput = e;
3759                 nextchr = UCHARAT(locinput);
3760                 break;
3761             }
3762
3763             /* Neither the target nor the pattern are utf8 */
3764             if (UCHARAT(s) != nextchr &&
3765                 UCHARAT(s) != fold_array[nextchr])
3766             {
3767                 sayNO;
3768             }
3769             if (PL_regeol - locinput < ln)
3770                 sayNO;
3771             if (ln > 1 && ! folder(s, locinput, ln))
3772                 sayNO;
3773             locinput += ln;
3774             nextchr = UCHARAT(locinput);
3775             break;
3776         }
3777
3778         /* XXX Could improve efficiency by separating these all out using a
3779          * macro or in-line function.  At that point regcomp.c would no longer
3780          * have to set the FLAGS fields of these */
3781         case BOUNDL:
3782         case NBOUNDL:
3783             PL_reg_flags |= RF_tainted;
3784             /* FALL THROUGH */
3785         case BOUND:
3786         case BOUNDU:
3787         case BOUNDA:
3788         case NBOUND:
3789         case NBOUNDU:
3790         case NBOUNDA:
3791             /* was last char in word? */
3792             if (utf8_target
3793                 && FLAGS(scan) != REGEX_ASCII_RESTRICTED_CHARSET
3794                 && FLAGS(scan) != REGEX_ASCII_MORE_RESTRICTED_CHARSET)
3795             {
3796                 if (locinput == PL_bostr)
3797                     ln = '\n';
3798                 else {
3799                     const U8 * const r = reghop3((U8*)locinput, -1, (U8*)PL_bostr);
3800
3801                     ln = utf8n_to_uvchr(r, UTF8SKIP(r), 0, uniflags);
3802                 }
3803                 if (FLAGS(scan) != REGEX_LOCALE_CHARSET) {
3804                     ln = isALNUM_uni(ln);
3805                     LOAD_UTF8_CHARCLASS_ALNUM();
3806                     n = swash_fetch(PL_utf8_alnum, (U8*)locinput, utf8_target);
3807                 }
3808                 else {
3809                     ln = isALNUM_LC_uvchr(UNI_TO_NATIVE(ln));
3810                     n = isALNUM_LC_utf8((U8*)locinput);
3811                 }
3812             }
3813             else {
3814
3815                 /* Here the string isn't utf8, or is utf8 and only ascii
3816                  * characters are to match \w.  In the latter case looking at
3817                  * the byte just prior to the current one may be just the final
3818                  * byte of a multi-byte character.  This is ok.  There are two
3819                  * cases:
3820                  * 1) it is a single byte character, and then the test is doing
3821                  *      just what it's supposed to.
3822                  * 2) it is a multi-byte character, in which case the final
3823                  *      byte is never mistakable for ASCII, and so the test
3824                  *      will say it is not a word character, which is the
3825                  *      correct answer. */
3826                 ln = (locinput != PL_bostr) ?
3827                     UCHARAT(locinput - 1) : '\n';
3828                 switch (FLAGS(scan)) {
3829                     case REGEX_UNICODE_CHARSET:
3830                         ln = isWORDCHAR_L1(ln);
3831                         n = isWORDCHAR_L1(nextchr);
3832                         break;
3833                     case REGEX_LOCALE_CHARSET:
3834                         ln = isALNUM_LC(ln);
3835                         n = isALNUM_LC(nextchr);
3836                         break;
3837                     case REGEX_DEPENDS_CHARSET:
3838                         ln = isALNUM(ln);
3839                         n = isALNUM(nextchr);
3840                         break;
3841                     case REGEX_ASCII_RESTRICTED_CHARSET:
3842                     case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
3843                         ln = isWORDCHAR_A(ln);
3844                         n = isWORDCHAR_A(nextchr);
3845                         break;
3846                     default:
3847                         Perl_croak(aTHX_ "panic: Unexpected FLAGS %u in op %u", FLAGS(scan), OP(scan));
3848                         break;
3849                 }
3850             }
3851             /* Note requires that all BOUNDs be lower than all NBOUNDs in
3852              * regcomp.sym */
3853             if (((!ln) == (!n)) == (OP(scan) < NBOUND))
3854                     sayNO;
3855             break;
3856         case ANYOFV:
3857         case ANYOF:
3858             if (utf8_target || state_num == ANYOFV) {
3859                 STRLEN inclasslen = PL_regeol - locinput;
3860                 if (locinput >= PL_regeol)
3861                     sayNO;
3862
3863                 if (!reginclass(rex, scan, (U8*)locinput, &inclasslen, utf8_target))
3864                     sayNO;
3865                 locinput += inclasslen;
3866                 nextchr = UCHARAT(locinput);
3867                 break;
3868             }
3869             else {
3870                 if (nextchr < 0)
3871                     nextchr = UCHARAT(locinput);
3872                 if (!nextchr && locinput >= PL_regeol)
3873                     sayNO;
3874                 if (!REGINCLASS(rex, scan, (U8*)locinput))
3875                     sayNO;
3876                 nextchr = UCHARAT(++locinput);
3877                 break;
3878             }
3879             break;
3880         /* Special char classes - The defines start on line 129 or so */
3881         CCC_TRY_U(ALNUM,  NALNUM,  isWORDCHAR,
3882                   ALNUML, NALNUML, isALNUM_LC, isALNUM_LC_utf8,
3883                   ALNUMU, NALNUMU, isWORDCHAR_L1,
3884                   ALNUMA, NALNUMA, isWORDCHAR_A,
3885                   alnum, "a");
3886
3887         CCC_TRY_U(SPACE,  NSPACE,  isSPACE,
3888                   SPACEL, NSPACEL, isSPACE_LC, isSPACE_LC_utf8,
3889                   SPACEU, NSPACEU, isSPACE_L1,
3890                   SPACEA, NSPACEA, isSPACE_A,
3891                   space, " ");
3892
3893         CCC_TRY(DIGIT,  NDIGIT,  isDIGIT,
3894                 DIGITL, NDIGITL, isDIGIT_LC, isDIGIT_LC_utf8,
3895                 DIGITA, NDIGITA, isDIGIT_A,
3896                 digit, "0");
3897
3898         case POSIXA:
3899             if (locinput >= PL_regeol || ! _generic_isCC_A(nextchr, FLAGS(scan))) {
3900                 sayNO;
3901             }
3902             /* Matched a utf8-invariant, so don't have to worry about utf8 */
3903             nextchr = UCHARAT(++locinput);
3904             break;
3905         case NPOSIXA:
3906             if (locinput >= PL_regeol || _generic_isCC_A(nextchr, FLAGS(scan))) {
3907                 sayNO;
3908             }
3909             if (utf8_target) {
3910                 locinput += PL_utf8skip[nextchr];
3911                 nextchr = UCHARAT(locinput);
3912             }
3913             else {
3914                 nextchr = UCHARAT(++locinput);
3915             }
3916             break;
3917
3918         case CLUMP: /* Match \X: logical Unicode character.  This is defined as
3919                        a Unicode extended Grapheme Cluster */
3920             /* From http://www.unicode.org/reports/tr29 (5.2 version).  An
3921               extended Grapheme Cluster is:
3922
3923                CR LF
3924                | Prepend* Begin Extend*
3925                | .
3926
3927                Begin is (Hangul-syllable | ! Control)
3928                Extend is (Grapheme_Extend | Spacing_Mark)
3929                Control is [ GCB_Control CR LF ]
3930
3931                The discussion below shows how the code for CLUMP is derived
3932                from this regex.  Note that most of these concepts are from
3933                property values of the Grapheme Cluster Boundary (GCB) property.
3934                No code point can have multiple property values for a given
3935                property.  Thus a code point in Prepend can't be in Control, but
3936                it must be in !Control.  This is why Control above includes
3937                GCB_Control plus CR plus LF.  The latter two are used in the GCB
3938                property separately, and so can't be in GCB_Control, even though
3939                they logically are controls.  Control is not the same as gc=cc,
3940                but includes format and other characters as well.
3941
3942                The Unicode definition of Hangul-syllable is:
3943                    L+
3944                    | (L* ( ( V | LV ) V* | LVT ) T*)
3945                    | T+
3946                   )
3947                Each of these is a value for the GCB property, and hence must be
3948                disjoint, so the order they are tested is immaterial, so the
3949                above can safely be changed to
3950                    T+
3951                    | L+
3952                    | (L* ( LVT | ( V | LV ) V*) T*)
3953
3954                The last two terms can be combined like this:
3955                    L* ( L | (( LVT | ( V | LV ) V*) T*))
3956
3957                That means that if we have seen any L's at all we can quit
3958                there, but if the next character is an LVT, a V, or an LV we
3959                should keep going.
3960
3961                There is a subtlety with Prepend* which showed up in testing.
3962                Note that the Begin, and only the Begin is required in:
3963                 | Prepend* Begin Extend*
3964                Also, Begin contains '! Control'.  A Prepend must be a
3965                '!  Control', which means it must also be a Begin.  What it
3966                comes down to is that if we match Prepend* and then find no
3967                suitable Begin afterwards, that if we backtrack the last
3968                Prepend, that one will be a suitable Begin.
3969             */
3970
3971             if (locinput >= PL_regeol)
3972                 sayNO;
3973             if  (! utf8_target) {
3974
3975                 /* Match either CR LF  or '.', as all the other possibilities
3976                  * require utf8 */
3977                 locinput++;         /* Match the . or CR */
3978                 if (nextchr == '\r' /* And if it was CR, and the next is LF,
3979                                        match the LF */
3980                     && locinput < PL_regeol
3981                     && UCHARAT(locinput) == '\n') locinput++;
3982             }
3983             else {
3984
3985                 /* Utf8: See if is ( CR LF ); already know that locinput <
3986                  * PL_regeol, so locinput+1 is in bounds */
3987                 if (nextchr == '\r' && UCHARAT(locinput + 1) == '\n') {
3988                     locinput += 2;
3989                 }
3990                 else {
3991                     /* In case have to backtrack to beginning, then match '.' */
3992                     char *starting = locinput;
3993
3994                     /* In case have to backtrack the last prepend */
3995                     char *previous_prepend = 0;
3996
3997                     LOAD_UTF8_CHARCLASS_GCB();
3998
3999                     /* Match (prepend)* */
4000                     while (locinput < PL_regeol
4001                            && swash_fetch(PL_utf8_X_prepend,
4002                                           (U8*)locinput, utf8_target))
4003                     {
4004                         previous_prepend = locinput;
4005                         locinput += UTF8SKIP(locinput);
4006                     }
4007
4008                     /* As noted above, if we matched a prepend character, but
4009                      * the next thing won't match, back off the last prepend we
4010                      * matched, as it is guaranteed to match the begin */
4011                     if (previous_prepend
4012                         && (locinput >=  PL_regeol
4013                             || ! swash_fetch(PL_utf8_X_begin,
4014                                              (U8*)locinput, utf8_target)))
4015                     {
4016                         locinput = previous_prepend;
4017                     }
4018
4019                     /* Note that here we know PL_regeol > locinput, as we
4020                      * tested that upon input to this switch case, and if we
4021                      * moved locinput forward, we tested the result just above
4022                      * and it either passed, or we backed off so that it will
4023                      * now pass */
4024                     if (! swash_fetch(PL_utf8_X_begin, (U8*)locinput, utf8_target)) {
4025
4026                         /* Here did not match the required 'Begin' in the
4027                          * second term.  So just match the very first
4028                          * character, the '.' of the final term of the regex */
4029                         locinput = starting + UTF8SKIP(starting);
4030                     } else {
4031
4032                         /* Here is the beginning of a character that can have
4033                          * an extender.  It is either a hangul syllable, or a
4034                          * non-control */
4035                         if (swash_fetch(PL_utf8_X_non_hangul,
4036                                         (U8*)locinput, utf8_target))
4037                         {
4038
4039                             /* Here not a Hangul syllable, must be a
4040                              * ('!  * Control') */
4041                             locinput += UTF8SKIP(locinput);
4042                         } else {
4043
4044                             /* Here is a Hangul syllable.  It can be composed
4045                              * of several individual characters.  One
4046                              * possibility is T+ */
4047                             if (swash_fetch(PL_utf8_X_T,
4048                                             (U8*)locinput, utf8_target))
4049                             {
4050                                 while (locinput < PL_regeol
4051                                         && swash_fetch(PL_utf8_X_T,
4052                                                         (U8*)locinput, utf8_target))
4053                                 {
4054                                     locinput += UTF8SKIP(locinput);
4055                                 }
4056                             } else {
4057
4058                                 /* Here, not T+, but is a Hangul.  That means
4059                                  * it is one of the others: L, LV, LVT or V,
4060                                  * and matches:
4061                                  * L* (L | LVT T* | V  V* T* | LV  V* T*) */
4062
4063                                 /* Match L*           */
4064                                 while (locinput < PL_regeol
4065                                         && swash_fetch(PL_utf8_X_L,
4066                                                         (U8*)locinput, utf8_target))
4067                                 {
4068                                     locinput += UTF8SKIP(locinput);
4069                                 }
4070
4071                                 /* Here, have exhausted L*.  If the next
4072                                  * character is not an LV, LVT nor V, it means
4073                                  * we had to have at least one L, so matches L+
4074                                  * in the original equation, we have a complete
4075                                  * hangul syllable.  Are done. */
4076
4077                                 if (locinput < PL_regeol
4078                                     && swash_fetch(PL_utf8_X_LV_LVT_V,
4079                                                     (U8*)locinput, utf8_target))
4080                                 {
4081
4082                                     /* Otherwise keep going.  Must be LV, LVT
4083                                      * or V.  See if LVT */
4084                                     if (is_utf8_X_LVT((U8*)locinput)) {
4085                                         locinput += UTF8SKIP(locinput);
4086                                     } else {
4087
4088                                         /* Must be  V or LV.  Take it, then
4089                                          * match V*     */
4090                                         locinput += UTF8SKIP(locinput);
4091                                         while (locinput < PL_regeol
4092                                                 && swash_fetch(PL_utf8_X_V,
4093                                                          (U8*)locinput, utf8_target))
4094                                         {
4095                                             locinput += UTF8SKIP(locinput);
4096                                         }
4097                                     }
4098
4099                                     /* And any of LV, LVT, or V can be followed
4100                                      * by T*            */
4101                                     while (locinput < PL_regeol
4102                                            && swash_fetch(PL_utf8_X_T,
4103                                                            (U8*)locinput,
4104                                                            utf8_target))
4105                                     {
4106                                         locinput += UTF8SKIP(locinput);
4107                                     }
4108                                 }
4109                             }
4110                         }
4111
4112                         /* Match any extender */
4113                         while (locinput < PL_regeol
4114                                 && swash_fetch(PL_utf8_X_extend,
4115                                                 (U8*)locinput, utf8_target))
4116                         {
4117                             locinput += UTF8SKIP(locinput);
4118                         }
4119                     }
4120                 }
4121                 if (locinput > PL_regeol) sayNO;
4122             }
4123             nextchr = UCHARAT(locinput);
4124             break;
4125
4126         case NREFFL:
4127         {   /* The capture buffer cases.  The ones beginning with N for the
4128                named buffers just convert to the equivalent numbered and
4129                pretend they were called as the corresponding numbered buffer
4130                op.  */
4131             /* don't initialize these in the declaration, it makes C++
4132                unhappy */
4133             char *s;
4134             char type;
4135             re_fold_t folder;
4136             const U8 *fold_array;
4137             UV utf8_fold_flags;
4138
4139             PL_reg_flags |= RF_tainted;
4140             folder = foldEQ_locale;
4141             fold_array = PL_fold_locale;
4142             type = REFFL;
4143             utf8_fold_flags = FOLDEQ_UTF8_LOCALE;
4144             goto do_nref;
4145
4146         case NREFFA:
4147             folder = foldEQ_latin1;
4148             fold_array = PL_fold_latin1;
4149             type = REFFA;
4150             utf8_fold_flags = FOLDEQ_UTF8_NOMIX_ASCII;
4151             goto do_nref;
4152
4153         case NREFFU:
4154             folder = foldEQ_latin1;
4155             fold_array = PL_fold_latin1;
4156             type = REFFU;
4157             utf8_fold_flags = 0;
4158             goto do_nref;
4159
4160         case NREFF:
4161             folder = foldEQ;
4162             fold_array = PL_fold;
4163             type = REFF;
4164             utf8_fold_flags = 0;
4165             goto do_nref;
4166
4167         case NREF:
4168             type = REF;
4169             folder = NULL;
4170             fold_array = NULL;
4171             utf8_fold_flags = 0;
4172           do_nref:
4173
4174             /* For the named back references, find the corresponding buffer
4175              * number */
4176             n = reg_check_named_buff_matched(rex,scan);
4177
4178             if ( ! n ) {
4179                 sayNO;
4180             }
4181             goto do_nref_ref_common;
4182
4183         case REFFL:
4184             PL_reg_flags |= RF_tainted;
4185             folder = foldEQ_locale;
4186             fold_array = PL_fold_locale;
4187             utf8_fold_flags = FOLDEQ_UTF8_LOCALE;
4188             goto do_ref;
4189
4190         case REFFA:
4191             folder = foldEQ_latin1;
4192             fold_array = PL_fold_latin1;
4193             utf8_fold_flags = FOLDEQ_UTF8_NOMIX_ASCII;
4194             goto do_ref;
4195
4196         case REFFU:
4197             folder = foldEQ_latin1;
4198             fold_array = PL_fold_latin1;
4199             utf8_fold_flags = 0;
4200             goto do_ref;
4201
4202         case REFF:
4203             folder = foldEQ;
4204             fold_array = PL_fold;
4205             utf8_fold_flags = 0;
4206             goto do_ref;
4207
4208         case REF:
4209             folder = NULL;
4210             fold_array = NULL;
4211             utf8_fold_flags = 0;
4212
4213           do_ref:
4214             type = OP(scan);
4215             n = ARG(scan);  /* which paren pair */
4216
4217           do_nref_ref_common:
4218             ln = rex->offs[n].start;
4219             PL_reg_leftiter = PL_reg_maxiter;           /* Void cache */
4220             if (rex->lastparen < n || ln == -1)
4221                 sayNO;                  /* Do not match unless seen CLOSEn. */
4222             if (ln == rex->offs[n].end)
4223                 break;
4224
4225             s = PL_bostr + ln;
4226             if (type != REF     /* REF can do byte comparison */
4227                 && (utf8_target || type == REFFU))
4228             { /* XXX handle REFFL better */
4229                 char * limit = PL_regeol;
4230
4231                 /* This call case insensitively compares the entire buffer
4232                     * at s, with the current input starting at locinput, but
4233                     * not going off the end given by PL_regeol, and returns in
4234                     * limit upon success, how much of the current input was
4235                     * matched */
4236                 if (! foldEQ_utf8_flags(s, NULL, rex->offs[n].end - ln, utf8_target,
4237                                     locinput, &limit, 0, utf8_target, utf8_fold_flags))
4238                 {
4239                     sayNO;
4240                 }
4241                 locinput = limit;
4242                 nextchr = UCHARAT(locinput);
4243                 break;
4244             }
4245
4246             /* Not utf8:  Inline the first character, for speed. */
4247             if (UCHARAT(s) != nextchr &&
4248                 (type == REF ||
4249                  UCHARAT(s) != fold_array[nextchr]))
4250                 sayNO;
4251             ln = rex->offs[n].end - ln;
4252             if (locinput + ln > PL_regeol)
4253                 sayNO;
4254             if (ln > 1 && (type == REF
4255                            ? memNE(s, locinput, ln)
4256                            : ! folder(s, locinput, ln)))
4257                 sayNO;
4258             locinput += ln;
4259             nextchr = UCHARAT(locinput);
4260             break;
4261         }
4262         case NOTHING:
4263         case TAIL:
4264             break;
4265         case BACK:
4266             break;
4267
4268 #undef  ST
4269 #define ST st->u.eval
4270         {
4271             SV *ret;
4272             REGEXP *re_sv;
4273             regexp *re;
4274             regexp_internal *rei;
4275             regnode *startpoint;
4276
4277         case GOSTART:
4278         case GOSUB: /*    /(...(?1))/   /(...(?&foo))/   */
4279             if (cur_eval && cur_eval->locinput==locinput) {
4280                 if (cur_eval->u.eval.close_paren == (U32)ARG(scan))
4281                     Perl_croak(aTHX_ "Infinite recursion in regex");
4282                 if ( ++nochange_depth > max_nochange_depth )
4283                     Perl_croak(aTHX_
4284                         "Pattern subroutine nesting without pos change"
4285                         " exceeded limit in regex");
4286             } else {
4287                 nochange_depth = 0;
4288             }
4289             re_sv = rex_sv;
4290             re = rex;
4291             rei = rexi;
4292             if (OP(scan)==GOSUB) {
4293                 startpoint = scan + ARG2L(scan);
4294                 ST.close_paren = ARG(scan);
4295             } else {
4296                 startpoint = rei->program+1;
4297                 ST.close_paren = 0;
4298             }
4299             goto eval_recurse_doit;
4300             assert(0); /* NOTREACHED */
4301         case EVAL:  /*   /(?{A})B/   /(??{A})B/  and /(?(?{A})X|Y)B/   */
4302             if (cur_eval && cur_eval->locinput==locinput) {
4303                 if ( ++nochange_depth > max_nochange_depth )
4304                     Perl_croak(aTHX_ "EVAL without pos change exceeded limit in regex");
4305             } else {
4306                 nochange_depth = 0;
4307             }
4308             {
4309                 /* execute the code in the {...} */
4310
4311                 dSP;
4312                 SV ** before;
4313                 OP * const oop = PL_op;
4314                 COP * const ocurcop = PL_curcop;
4315                 OP *nop;
4316                 char *saved_regeol = PL_regeol;
4317                 struct re_save_state saved_state;
4318                 CV *newcv;
4319
4320                 /* save *all* paren positions */
4321                 regcppush(rex, 0);
4322                 REGCP_SET(runops_cp);
4323
4324                 /* To not corrupt the existing regex state while executing the
4325                  * eval we would normally put it on the save stack, like with
4326                  * save_re_context. However, re-evals have a weird scoping so we
4327                  * can't just add ENTER/LEAVE here. With that, things like
4328                  *
4329                  *    (?{$a=2})(a(?{local$a=$a+1}))*aak*c(?{$b=$a})
4330                  *
4331                  * would break, as they expect the localisation to be unwound
4332                  * only when the re-engine backtracks through the bit that
4333                  * localised it.
4334                  *
4335                  * What we do instead is just saving the state in a local c
4336                  * variable.
4337                  */
4338                 Copy(&PL_reg_state, &saved_state, 1, struct re_save_state);
4339
4340                 PL_reg_state.re_reparsing = FALSE;
4341
4342                 if (!caller_cv)
4343                     caller_cv = find_runcv(NULL);
4344
4345                 n = ARG(scan);
4346
4347                 if (rexi->data->what[n] == 'r') { /* code from an external qr */
4348                     newcv = ((struct regexp *)SvANY(
4349                                                 (REGEXP*)(rexi->data->data[n])
4350                                             ))->qr_anoncv
4351                                         ;
4352                     nop = (OP*)rexi->data->data[n+1];
4353                 }
4354                 else if (rexi->data->what[n] == 'l') { /* literal code */
4355                     newcv = caller_cv;
4356                     nop = (OP*)rexi->data->data[n];
4357                     assert(CvDEPTH(newcv));
4358                 }
4359                 else {
4360                     /* literal with own CV */
4361                     assert(rexi->data->what[n] == 'L');
4362                     newcv = rex->qr_anoncv;
4363                     nop = (OP*)rexi->data->data[n];
4364                 }
4365
4366                 /* normally if we're about to execute code from the same
4367                  * CV that we used previously, we just use the existing
4368                  * CX stack entry. However, its possible that in the
4369                  * meantime we may have backtracked, popped from the save
4370                  * stack, and undone the SAVECOMPPAD(s) associated with
4371                  * PUSH_MULTICALL; in which case PL_comppad no longer
4372                  * points to newcv's pad. */
4373                 if (newcv != last_pushed_cv || PL_comppad != last_pad)
4374                 {
4375                     I32 depth = (newcv == caller_cv) ? 0 : 1;
4376                     if (last_pushed_cv) {
4377                         CHANGE_MULTICALL_WITHDEPTH(newcv, depth);
4378                     }
4379                     else {
4380                         PUSH_MULTICALL_WITHDEPTH(newcv, depth);
4381                     }
4382                     last_pushed_cv = newcv;
4383                 }
4384                 last_pad = PL_comppad;
4385
4386                 /* the initial nextstate you would normally execute
4387                  * at the start of an eval (which would cause error
4388                  * messages to come from the eval), may be optimised
4389                  * away from the execution path in the regex code blocks;
4390                  * so manually set PL_curcop to it initially */
4391                 {
4392                     OP *o = cUNOPx(nop)->op_first;
4393                     assert(o->op_type == OP_NULL);
4394                     if (o->op_targ == OP_SCOPE) {
4395                         o = cUNOPo->op_first;
4396                     }
4397                     else {
4398                         assert(o->op_targ == OP_LEAVE);
4399                         o = cUNOPo->op_first;
4400                         assert(o->op_type == OP_ENTER);
4401                         o = o->op_sibling;
4402                     }
4403
4404                     if (o->op_type != OP_STUB) {
4405                         assert(    o->op_type == OP_NEXTSTATE
4406                                 || o->op_type == OP_DBSTATE
4407                                 || (o->op_type == OP_NULL
4408                                     &&  (  o->op_targ == OP_NEXTSTATE
4409                                         || o->op_targ == OP_DBSTATE
4410                                         )
4411                                     )
4412                         );
4413                         PL_curcop = (COP*)o;
4414                     }
4415                 }
4416                 nop = nop->op_next;
4417
4418                 DEBUG_STATE_r( PerlIO_printf(Perl_debug_log,
4419                     "  re EVAL PL_op=0x%"UVxf"\n", PTR2UV(nop)) );
4420
4421                 rex->offs[0].end = PL_reg_magic->mg_len = locinput - PL_bostr;
4422
4423                 if (sv_yes_mark) {
4424                     SV *sv_mrk = get_sv("REGMARK", 1);
4425                     sv_setsv(sv_mrk, sv_yes_mark);
4426                 }
4427
4428                 /* we don't use MULTICALL here as we want to call the
4429                  * first op of the block of interest, rather than the
4430                  * first op of the sub */
4431                 before = SP;
4432                 PL_op = nop;
4433                 CALLRUNOPS(aTHX);                       /* Scalar context. */
4434                 SPAGAIN;
4435                 if (SP == before)
4436                     ret = &PL_sv_undef;   /* protect against empty (?{}) blocks. */
4437                 else {
4438                     ret = POPs;
4439                     PUTBACK;
4440                 }
4441
4442                 /* before restoring everything, evaluate the returned
4443                  * value, so that 'uninit' warnings don't use the wrong
4444                  * PL_op or pad. Also need to process any magic vars
4445                  * (e.g. $1) *before* parentheses are restored */
4446
4447                 PL_op = NULL;
4448
4449                 re_sv = NULL;
4450                 if (logical == 0)        /*   (?{})/   */
4451                     sv_setsv(save_scalar(PL_replgv), ret); /* $^R */
4452                 else if (logical == 1) { /*   /(?(?{...})X|Y)/    */
4453                     sw = cBOOL(SvTRUE(ret));
4454                     logical = 0;
4455                 }
4456                 else {                   /*  /(??{})  */
4457                     /*  if its overloaded, let the regex compiler handle
4458                      *  it; otherwise extract regex, or stringify  */
4459                     if (!SvAMAGIC(ret)) {
4460                         SV *sv = ret;
4461                         if (SvROK(sv))
4462                             sv = SvRV(sv);
4463                         if (SvTYPE(sv) == SVt_REGEXP)
4464                             re_sv = (REGEXP*) sv;
4465                         else if (SvSMAGICAL(sv)) {
4466                             MAGIC *mg = mg_find(sv, PERL_MAGIC_qr);
4467                             if (mg)
4468                                 re_sv = (REGEXP *) mg->mg_obj;
4469                         }
4470
4471                         /* force any magic, undef warnings here */
4472                         if (!re_sv) {
4473                             ret = sv_mortalcopy(ret);
4474                             (void) SvPV_force_nolen(ret);
4475                         }
4476                     }
4477
4478                 }
4479
4480                 Copy(&saved_state, &PL_reg_state, 1, struct re_save_state);
4481
4482                 /* *** Note that at this point we don't restore
4483                  * PL_comppad, (or pop the CxSUB) on the assumption it may
4484                  * be used again soon. This is safe as long as nothing
4485                  * in the regexp code uses the pad ! */
4486                 PL_op = oop;
4487                 PL_curcop = ocurcop;
4488                 PL_regeol = saved_regeol;
4489                 S_regcp_restore(aTHX_ rex, runops_cp);
4490
4491                 if (logical != 2)
4492                     break;
4493             }
4494
4495                 /* only /(??{})/  from now on */
4496                 logical = 0;
4497                 {
4498                     /* extract RE object from returned value; compiling if
4499                      * necessary */
4500
4501                     if (re_sv) {
4502                         re_sv = reg_temp_copy(NULL, re_sv);
4503                     }
4504                     else {
4505                         U32 pm_flags = 0;
4506                         const I32 osize = PL_regsize;
4507
4508                         if (SvUTF8(ret) && IN_BYTES) {
4509                             /* In use 'bytes': make a copy of the octet
4510                              * sequence, but without the flag on */
4511                             STRLEN len;
4512                             const char *const p = SvPV(ret, len);
4513                             ret = newSVpvn_flags(p, len, SVs_TEMP);
4514                         }
4515                         if (rex->intflags & PREGf_USE_RE_EVAL)
4516                             pm_flags |= PMf_USE_RE_EVAL;
4517
4518                         /* if we got here, it should be an engine which
4519                          * supports compiling code blocks and stuff */
4520                         assert(rex->engine && rex->engine->op_comp);
4521                         assert(!(scan->flags & ~RXf_PMf_COMPILETIME));
4522                         re_sv = rex->engine->op_comp(aTHX_ &ret, 1, NULL,
4523                                     rex->engine, NULL, NULL,
4524                                     /* copy /msix etc to inner pattern */
4525                                     scan->flags,
4526                                     pm_flags);
4527
4528                         if (!(SvFLAGS(ret)
4529                               & (SVs_TEMP | SVs_PADTMP | SVf_READONLY
4530                                  | SVs_GMG))) {
4531                             /* This isn't a first class regexp. Instead, it's
4532                                caching a regexp onto an existing, Perl visible
4533                                scalar.  */
4534                             sv_magic(ret, MUTABLE_SV(re_sv), PERL_MAGIC_qr, 0, 0);
4535                         }
4536                         PL_regsize = osize;
4537                         /* safe to do now that any $1 etc has been
4538                          * interpolated into the new pattern string and
4539                          * compiled */
4540                         S_regcp_restore(aTHX_ rex, runops_cp);
4541                     }
4542                     re = (struct regexp *)SvANY(re_sv);
4543                 }
4544                 RXp_MATCH_COPIED_off(re);
4545                 re->subbeg = rex->subbeg;
4546                 re->sublen = rex->sublen;
4547                 rei = RXi_GET(re);
4548                 DEBUG_EXECUTE_r(
4549                     debug_start_match(re_sv, utf8_target, locinput, PL_regeol,
4550                         "Matching embedded");
4551                 );
4552                 startpoint = rei->program + 1;
4553                 ST.close_paren = 0; /* only used for GOSUB */
4554
4555         eval_recurse_doit: /* Share code with GOSUB below this line */
4556                 /* run the pattern returned from (??{...}) */
4557                 ST.cp = regcppush(rex, 0);      /* Save *all* the positions. */
4558                 REGCP_SET(ST.lastcp);
4559
4560                 re->lastparen = 0;
4561                 re->lastcloseparen = 0;
4562
4563                 PL_reginput = locinput;
4564                 PL_regsize = 0;
4565
4566                 /* XXXX This is too dramatic a measure... */
4567                 PL_reg_maxiter = 0;
4568
4569                 ST.toggle_reg_flags = PL_reg_flags;
4570                 if (RX_UTF8(re_sv))
4571                     PL_reg_flags |= RF_utf8;
4572                 else
4573                     PL_reg_flags &= ~RF_utf8;
4574                 ST.toggle_reg_flags ^= PL_reg_flags; /* diff of old and new */
4575
4576                 ST.prev_rex = rex_sv;
4577                 ST.prev_curlyx = cur_curlyx;
4578                 rex_sv = re_sv;
4579                 SET_reg_curpm(rex_sv);
4580                 rex = re;
4581                 rexi = rei;
4582                 cur_curlyx = NULL;
4583                 ST.B = next;
4584                 ST.prev_eval = cur_eval;
4585                 cur_eval = st;
4586                 /* now continue from first node in postoned RE */
4587                 PUSH_YES_STATE_GOTO(EVAL_AB, startpoint);
4588                 assert(0); /* NOTREACHED */
4589         }
4590
4591         case EVAL_AB: /* cleanup after a successful (??{A})B */
4592             /* note: this is called twice; first after popping B, then A */
4593             PL_reg_flags ^= ST.toggle_reg_flags;
4594             rex_sv = ST.prev_rex;
4595             SET_reg_curpm(rex_sv);
4596             rex = (struct regexp *)SvANY(rex_sv);
4597             rexi = RXi_GET(rex);
4598             regcpblow(ST.cp);
4599             cur_eval = ST.prev_eval;
4600             cur_curlyx = ST.prev_curlyx;
4601
4602             /* XXXX This is too dramatic a measure... */
4603             PL_reg_maxiter = 0;
4604             if ( nochange_depth )
4605                 nochange_depth--;
4606             sayYES;
4607
4608
4609         case EVAL_AB_fail: /* unsuccessfully ran A or B in (??{A})B */
4610             /* note: this is called twice; first after popping B, then A */
4611             PL_reg_flags ^= ST.toggle_reg_flags;
4612             rex_sv = ST.prev_rex;
4613             SET_reg_curpm(rex_sv);
4614             rex = (struct regexp *)SvANY(rex_sv);
4615             rexi = RXi_GET(rex);
4616
4617             PL_reginput = locinput;
4618             REGCP_UNWIND(ST.lastcp);
4619             regcppop(rex);
4620             cur_eval = ST.prev_eval;
4621             cur_curlyx = ST.prev_curlyx;
4622             /* XXXX This is too dramatic a measure... */
4623             PL_reg_maxiter = 0;
4624             if ( nochange_depth )
4625                 nochange_depth--;
4626             sayNO_SILENT;
4627 #undef ST
4628
4629         case OPEN:
4630             n = ARG(scan);  /* which paren pair */
4631             rex->offs[n].start_tmp = locinput - PL_bostr;
4632             if (n > PL_regsize)
4633                 PL_regsize = n;
4634             DEBUG_BUFFERS_r(PerlIO_printf(Perl_debug_log,
4635                 "rex=0x%"UVxf" offs=0x%"UVxf": \\%"UVuf": set %"IVdf" tmp; regsize=%"UVuf"\n",
4636                 PTR2UV(rex),
4637                 PTR2UV(rex->offs),
4638                 (UV)n,
4639                 (IV)rex->offs[n].start_tmp,
4640                 (UV)PL_regsize
4641             ));
4642             lastopen = n;
4643             break;
4644
4645 /* XXX really need to log other places start/end are set too */
4646 #define CLOSE_CAPTURE \
4647     rex->offs[n].start = rex->offs[n].start_tmp; \
4648     rex->offs[n].end = locinput - PL_bostr; \
4649     DEBUG_BUFFERS_r(PerlIO_printf(Perl_debug_log, \
4650         "rex=0x%"UVxf" offs=0x%"UVxf": \\%"UVuf": set %"IVdf"..%"IVdf"\n", \
4651         PTR2UV(rex), \
4652         PTR2UV(rex->offs), \
4653         (UV)n, \
4654         (IV)rex->offs[n].start, \
4655         (IV)rex->offs[n].end \
4656     ))
4657
4658         case CLOSE:
4659             n = ARG(scan);  /* which paren pair */
4660             CLOSE_CAPTURE;
4661             /*if (n > PL_regsize)
4662                 PL_regsize = n;*/
4663             if (n > rex->lastparen)
4664                 rex->lastparen = n;
4665             rex->lastcloseparen = n;
4666             if (cur_eval && cur_eval->u.eval.close_paren == n) {
4667                 goto fake_end;
4668             }
4669             break;
4670         case ACCEPT:
4671             if (ARG(scan)){
4672                 regnode *cursor;
4673                 for (cursor=scan;
4674                      cursor && OP(cursor)!=END;
4675                      cursor=regnext(cursor))
4676                 {
4677                     if ( OP(cursor)==CLOSE ){
4678                         n = ARG(cursor);
4679                         if ( n <= lastopen ) {
4680                             CLOSE_CAPTURE;
4681                             /*if (n > PL_regsize)
4682                             PL_regsize = n;*/
4683                             if (n > rex->lastparen)
4684                                 rex->lastparen = n;
4685                             rex->lastcloseparen = n;
4686                             if ( n == ARG(scan) || (cur_eval &&
4687                                 cur_eval->u.eval.close_paren == n))
4688                                 break;
4689                         }
4690                     }
4691                 }
4692             }
4693             goto fake_end;
4694             /*NOTREACHED*/
4695         case GROUPP:
4696             n = ARG(scan);  /* which paren pair */
4697             sw = cBOOL(rex->lastparen >= n && rex->offs[n].end != -1);
4698             break;
4699         case NGROUPP:
4700             /* reg_check_named_buff_matched returns 0 for no match */
4701             sw = cBOOL(0 < reg_check_named_buff_matched(rex,scan));
4702             break;
4703         case INSUBP:
4704             n = ARG(scan);
4705             sw = (cur_eval && (!n || cur_eval->u.eval.close_paren == n));
4706             break;
4707         case DEFINEP:
4708             sw = 0;
4709             break;
4710         case IFTHEN:
4711             PL_reg_leftiter = PL_reg_maxiter;           /* Void cache */
4712             if (sw)
4713                 next = NEXTOPER(NEXTOPER(scan));
4714             else {
4715                 next = scan + ARG(scan);
4716                 if (OP(next) == IFTHEN) /* Fake one. */
4717                     next = NEXTOPER(NEXTOPER(next));
4718             }
4719             break;
4720         case LOGICAL:
4721             logical = scan->flags;
4722             break;
4723
4724 /*******************************************************************
4725
4726 The CURLYX/WHILEM pair of ops handle the most generic case of the /A*B/
4727 pattern, where A and B are subpatterns. (For simple A, CURLYM or
4728 STAR/PLUS/CURLY/CURLYN are used instead.)
4729
4730 A*B is compiled as <CURLYX><A><WHILEM><B>
4731
4732 On entry to the subpattern, CURLYX is called. This pushes a CURLYX
4733 state, which contains the current count, initialised to -1. It also sets
4734 cur_curlyx to point to this state, with any previous value saved in the
4735 state block.
4736
4737 CURLYX then jumps straight to the WHILEM op, rather than executing A,
4738 since the pattern may possibly match zero times (i.e. it's a while {} loop
4739 rather than a do {} while loop).
4740
4741 Each entry to WHILEM represents a successful match of A. The count in the
4742 CURLYX block is incremented, another WHILEM state is pushed, and execution
4743 passes to A or B depending on greediness and the current count.
4744
4745 For example, if matching against the string a1a2a3b (where the aN are
4746 substrings that match /A/), then the match progresses as follows: (the
4747 pushed states are interspersed with the bits of strings matched so far):
4748
4749     <CURLYX cnt=-1>
4750     <CURLYX cnt=0><WHILEM>
4751     <CURLYX cnt=1><WHILEM> a1 <WHILEM>
4752     <CURLYX cnt=2><WHILEM> a1 <WHILEM> a2 <WHILEM>
4753     <CURLYX cnt=3><WHILEM> a1 <WHILEM> a2 <WHILEM> a3 <WHILEM>
4754     <CURLYX cnt=3><WHILEM> a1 <WHILEM> a2 <WHILEM> a3 <WHILEM> b
4755
4756 (Contrast this with something like CURLYM, which maintains only a single
4757 backtrack state:
4758
4759     <CURLYM cnt=0> a1
4760     a1 <CURLYM cnt=1> a2
4761     a1 a2 <CURLYM cnt=2> a3
4762     a1 a2 a3 <CURLYM cnt=3> b
4763 )
4764
4765 Each WHILEM state block marks a point to backtrack to upon partial failure
4766 of A or B, and also contains some minor state data related to that
4767 iteration.  The CURLYX block, pointed to by cur_curlyx, contains the
4768 overall state, such as the count, and pointers to the A and B ops.
4769
4770 This is complicated slightly by nested CURLYX/WHILEM's. Since cur_curlyx
4771 must always point to the *current* CURLYX block, the rules are:
4772
4773 When executing CURLYX, save the old cur_curlyx in the CURLYX state block,
4774 and set cur_curlyx to point the new block.
4775
4776 When popping the CURLYX block after a successful or unsuccessful match,
4777 restore the previous cur_curlyx.
4778
4779 When WHILEM is about to execute B, save the current cur_curlyx, and set it
4780 to the outer one saved in the CURLYX block.
4781
4782 When popping the WHILEM block after a successful or unsuccessful B match,
4783 restore the previous cur_curlyx.
4784
4785 Here's an example for the pattern (AI* BI)*BO
4786 I and O refer to inner and outer, C and W refer to CURLYX and WHILEM:
4787
4788 cur_
4789 curlyx backtrack stack
4790 ------ ---------------
4791 NULL
4792 CO     <CO prev=NULL> <WO>
4793 CI     <CO prev=NULL> <WO> <CI prev=CO> <WI> ai
4794 CO     <CO prev=NULL> <WO> <CI prev=CO> <WI> ai <WI prev=CI> bi
4795 NULL   <CO prev=NULL> <WO> <CI prev=CO> <WI> ai <WI prev=CI> bi <WO prev=CO> bo
4796
4797 At this point the pattern succeeds, and we work back down the stack to
4798 clean up, restoring as we go:
4799
4800 CO     <CO prev=NULL> <WO> <CI prev=CO> <WI> ai <WI prev=CI> bi
4801 CI     <CO prev=NULL> <WO> <CI prev=CO> <WI> ai
4802 CO     <CO prev=NULL> <WO>
4803 NULL
4804
4805 *******************************************************************/
4806
4807 #define ST st->u.curlyx
4808
4809         case CURLYX:    /* start of /A*B/  (for complex A) */
4810         {
4811             /* No need to save/restore up to this paren */
4812             I32 parenfloor = scan->flags;
4813
4814             assert(next); /* keep Coverity happy */
4815             if (OP(PREVOPER(next)) == NOTHING) /* LONGJMP */
4816                 next += ARG(next);
4817
4818             /* XXXX Probably it is better to teach regpush to support
4819                parenfloor > PL_regsize... */
4820             if (parenfloor > (I32)rex->lastparen)
4821                 parenfloor = rex->lastparen; /* Pessimization... */
4822
4823             ST.prev_curlyx= cur_curlyx;
4824             cur_curlyx = st;
4825             ST.cp = PL_savestack_ix;
4826
4827             /* these fields contain the state of the current curly.
4828              * they are accessed by subsequent WHILEMs */
4829             ST.parenfloor = parenfloor;
4830             ST.me = scan;
4831             ST.B = next;
4832             ST.minmod = minmod;
4833             minmod = 0;
4834             ST.count = -1;      /* this will be updated by WHILEM */
4835             ST.lastloc = NULL;  /* this will be updated by WHILEM */
4836
4837             PL_reginput = locinput;
4838             PUSH_YES_STATE_GOTO(CURLYX_end, PREVOPER(next));
4839             assert(0); /* NOTREACHED */
4840         }
4841
4842         case CURLYX_end: /* just finished matching all of A*B */
4843             cur_curlyx = ST.prev_curlyx;
4844             sayYES;
4845             assert(0); /* NOTREACHED */
4846
4847         case CURLYX_end_fail: /* just failed to match all of A*B */
4848             regcpblow(ST.cp);
4849             cur_curlyx = ST.prev_curlyx;
4850             sayNO;
4851             assert(0); /* NOTREACHED */
4852
4853
4854 #undef ST
4855 #define ST st->u.whilem
4856
4857         case WHILEM:     /* just matched an A in /A*B/  (for complex A) */
4858         {
4859             /* see the discussion above about CURLYX/WHILEM */
4860             I32 n;
4861             int min = ARG1(cur_curlyx->u.curlyx.me);
4862             int max = ARG2(cur_curlyx->u.curlyx.me);
4863             regnode *A = NEXTOPER(cur_curlyx->u.curlyx.me) + EXTRA_STEP_2ARGS;
4864
4865             assert(cur_curlyx); /* keep Coverity happy */
4866             n = ++cur_curlyx->u.curlyx.count; /* how many A's matched */
4867             ST.save_lastloc = cur_curlyx->u.curlyx.lastloc;
4868             ST.cache_offset = 0;
4869             ST.cache_mask = 0;
4870
4871             PL_reginput = locinput;
4872
4873             DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
4874                   "%*s  whilem: matched %ld out of %d..%d\n",
4875                   REPORT_CODE_OFF+depth*2, "", (long)n, min, max)
4876             );
4877
4878             /* First just match a string of min A's. */
4879
4880             if (n < min) {
4881                 ST.cp = regcppush(rex, cur_curlyx->u.curlyx.parenfloor);
4882                 cur_curlyx->u.curlyx.lastloc = locinput;
4883                 REGCP_SET(ST.lastcp);
4884
4885                 PUSH_STATE_GOTO(WHILEM_A_pre, A);
4886                 assert(0); /* NOTREACHED */
4887             }
4888
4889             /* If degenerate A matches "", assume A done. */
4890
4891             if (locinput == cur_curlyx->u.curlyx.lastloc) {
4892                 DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
4893                    "%*s  whilem: empty match detected, trying continuation...\n",
4894                    REPORT_CODE_OFF+depth*2, "")
4895                 );
4896                 goto do_whilem_B_max;
4897             }
4898
4899             /* super-linear cache processing */
4900
4901             if (scan->flags) {
4902
4903                 if (!PL_reg_maxiter) {
4904                     /* start the countdown: Postpone detection until we
4905                      * know the match is not *that* much linear. */
4906                     PL_reg_maxiter = (PL_regeol - PL_bostr + 1) * (scan->flags>>4);
4907                     /* possible overflow for long strings and many CURLYX's */
4908                     if (PL_reg_maxiter < 0)
4909                         PL_reg_maxiter = I32_MAX;
4910                     PL_reg_leftiter = PL_reg_maxiter;
4911                 }
4912
4913                 if (PL_reg_leftiter-- == 0) {
4914                     /* initialise cache */
4915                     const I32 size = (PL_reg_maxiter + 7)/8;
4916                     if (PL_reg_poscache) {
4917                         if ((I32)PL_reg_poscache_size < size) {
4918                             Renew(PL_reg_poscache, size, char);
4919                             PL_reg_poscache_size = size;
4920                         }
4921                         Zero(PL_reg_poscache, size, char);
4922                     }
4923                     else {
4924                         PL_reg_poscache_size = size;
4925                         Newxz(PL_reg_poscache, size, char);
4926                     }
4927                     DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
4928       "%swhilem: Detected a super-linear match, switching on caching%s...\n",
4929                               PL_colors[4], PL_colors[5])
4930                     );
4931                 }
4932
4933                 if (PL_reg_leftiter < 0) {
4934                     /* have we already failed at this position? */
4935                     I32 offset, mask;
4936                     offset  = (scan->flags & 0xf) - 1
4937                                 + (locinput - PL_bostr)  * (scan->flags>>4);
4938                     mask    = 1 << (offset % 8);
4939                     offset /= 8;
4940                     if (PL_reg_poscache[offset] & mask) {
4941                         DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
4942                             "%*s  whilem: (cache) already tried at this position...\n",
4943                             REPORT_CODE_OFF+depth*2, "")
4944                         );
4945                         sayNO; /* cache records failure */
4946                     }
4947                     ST.cache_offset = offset;
4948                     ST.cache_mask   = mask;
4949                 }
4950             }
4951
4952             /* Prefer B over A for minimal matching. */
4953
4954             if (cur_curlyx->u.curlyx.minmod) {
4955                 ST.save_curlyx = cur_curlyx;
4956                 cur_curlyx = cur_curlyx->u.curlyx.prev_curlyx;
4957                 ST.cp = regcppush(rex, ST.save_curlyx->u.curlyx.parenfloor);
4958                 REGCP_SET(ST.lastcp);
4959                 PUSH_YES_STATE_GOTO(WHILEM_B_min, ST.save_curlyx->u.curlyx.B);
4960                 assert(0); /* NOTREACHED */
4961             }
4962
4963             /* Prefer A over B for maximal matching. */
4964
4965             if (n < max) { /* More greed allowed? */
4966                 ST.cp = regcppush(rex, cur_curlyx->u.curlyx.parenfloor);
4967                 cur_curlyx->u.curlyx.lastloc = locinput;
4968                 REGCP_SET(ST.lastcp);
4969                 PUSH_STATE_GOTO(WHILEM_A_max, A);
4970                 assert(0); /* NOTREACHED */
4971             }
4972             goto do_whilem_B_max;
4973         }
4974         assert(0); /* NOTREACHED */
4975
4976         case WHILEM_B_min: /* just matched B in a minimal match */
4977         case WHILEM_B_max: /* just matched B in a maximal match */
4978             cur_curlyx = ST.save_curlyx;
4979             sayYES;
4980             assert(0); /* NOTREACHED */
4981
4982         case WHILEM_B_max_fail: /* just failed to match B in a maximal match */
4983             cur_curlyx = ST.save_curlyx;
4984             cur_curlyx->u.curlyx.lastloc = ST.save_lastloc;
4985             cur_curlyx->u.curlyx.count--;
4986             CACHEsayNO;
4987             assert(0); /* NOTREACHED */
4988
4989         case WHILEM_A_min_fail: /* just failed to match A in a minimal match */
4990             /* FALL THROUGH */
4991         case WHILEM_A_pre_fail: /* just failed to match even minimal A */
4992             REGCP_UNWIND(ST.lastcp);
4993             regcppop(rex);
4994             cur_curlyx->u.curlyx.lastloc = ST.save_lastloc;
4995             cur_curlyx->u.curlyx.count--;
4996             CACHEsayNO;
4997             assert(0); /* NOTREACHED */
4998
4999         case WHILEM_A_max_fail: /* just failed to match A in a maximal match */
5000             REGCP_UNWIND(ST.lastcp);
5001             regcppop(rex);      /* Restore some previous $<digit>s? */
5002             PL_reginput = locinput;
5003             DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
5004                 "%*s  whilem: failed, trying continuation...\n",
5005                 REPORT_CODE_OFF+depth*2, "")
5006             );
5007           do_whilem_B_max:
5008             if (cur_curlyx->u.curlyx.count >= REG_INFTY
5009                 && ckWARN(WARN_REGEXP)
5010                 && !(PL_reg_flags & RF_warned))
5011             {
5012                 PL_reg_flags |= RF_warned;
5013                 Perl_warner(aTHX_ packWARN(WARN_REGEXP),
5014                      "Complex regular subexpression recursion limit (%d) "
5015                      "exceeded",
5016                      REG_INFTY - 1);
5017             }
5018
5019             /* now try B */
5020             ST.save_curlyx = cur_curlyx;
5021             cur_curlyx = cur_curlyx->u.curlyx.prev_curlyx;
5022             PUSH_YES_STATE_GOTO(WHILEM_B_max, ST.save_curlyx->u.curlyx.B);
5023             assert(0); /* NOTREACHED */
5024
5025         case WHILEM_B_min_fail: /* just failed to match B in a minimal match */
5026             cur_curlyx = ST.save_curlyx;
5027             REGCP_UNWIND(ST.lastcp);
5028             regcppop(rex);
5029
5030             if (cur_curlyx->u.curlyx.count >= /*max*/ARG2(cur_curlyx->u.curlyx.me)) {
5031                 /* Maximum greed exceeded */
5032                 if (cur_curlyx->u.curlyx.count >= REG_INFTY
5033                     && ckWARN(WARN_REGEXP)
5034                     && !(PL_reg_flags & RF_warned))
5035                 {
5036                     PL_reg_flags |= RF_warned;
5037                     Perl_warner(aTHX_ packWARN(WARN_REGEXP),
5038                         "Complex regular subexpression recursion "
5039                         "limit (%d) exceeded",
5040                         REG_INFTY - 1);
5041                 }
5042                 cur_curlyx->u.curlyx.count--;
5043                 CACHEsayNO;
5044             }
5045
5046             DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
5047                 "%*s  trying longer...\n", REPORT_CODE_OFF+depth*2, "")
5048             );
5049             /* Try grabbing another A and see if it helps. */
5050             PL_reginput = locinput;
5051             cur_curlyx->u.curlyx.lastloc = locinput;
5052             ST.cp = regcppush(rex, cur_curlyx->u.curlyx.parenfloor);
5053             REGCP_SET(ST.lastcp);
5054             PUSH_STATE_GOTO(WHILEM_A_min,
5055                 /*A*/ NEXTOPER(ST.save_curlyx->u.curlyx.me) + EXTRA_STEP_2ARGS);
5056             assert(0); /* NOTREACHED */
5057
5058 #undef  ST
5059 #define ST st->u.branch
5060
5061         case BRANCHJ:       /*  /(...|A|...)/ with long next pointer */
5062             next = scan + ARG(scan);
5063             if (next == scan)
5064                 next = NULL;
5065             scan = NEXTOPER(scan);
5066             /* FALL THROUGH */
5067
5068         case BRANCH:        /*  /(...|A|...)/ */
5069             scan = NEXTOPER(scan); /* scan now points to inner node */
5070             ST.lastparen = rex->lastparen;
5071             ST.lastcloseparen = rex->lastcloseparen;
5072             ST.next_branch = next;
5073             REGCP_SET(ST.cp);
5074             PL_reginput = locinput;
5075
5076             /* Now go into the branch */
5077             if (has_cutgroup) {
5078                 PUSH_YES_STATE_GOTO(BRANCH_next, scan);
5079             } else {
5080                 PUSH_STATE_GOTO(BRANCH_next, scan);
5081             }
5082             assert(0); /* NOTREACHED */
5083         case CUTGROUP:
5084             PL_reginput = locinput;
5085             sv_yes_mark = st->u.mark.mark_name = scan->flags ? NULL :
5086                 MUTABLE_SV(rexi->data->data[ ARG( scan ) ]);
5087             PUSH_STATE_GOTO(CUTGROUP_next,next);
5088             assert(0); /* NOTREACHED */
5089         case CUTGROUP_next_fail:
5090             do_cutgroup = 1;
5091             no_final = 1;
5092             if (st->u.mark.mark_name)
5093                 sv_commit = st->u.mark.mark_name;
5094             sayNO;
5095             assert(0); /* NOTREACHED */
5096         case BRANCH_next:
5097             sayYES;
5098             assert(0); /* NOTREACHED */
5099         case BRANCH_next_fail: /* that branch failed; try the next, if any */
5100             if (do_cutgroup) {
5101                 do_cutgroup = 0;
5102                 no_final = 0;
5103             }
5104             REGCP_UNWIND(ST.cp);
5105             UNWIND_PAREN(ST.lastparen, ST.lastcloseparen);
5106             scan = ST.next_branch;
5107             /* no more branches? */
5108             if (!scan || (OP(scan) != BRANCH && OP(scan) != BRANCHJ)) {
5109                 DEBUG_EXECUTE_r({
5110                     PerlIO_printf( Perl_debug_log,
5111                         "%*s  %sBRANCH failed...%s\n",
5112                         REPORT_CODE_OFF+depth*2, "",
5113                         PL_colors[4],
5114                         PL_colors[5] );
5115                 });
5116                 sayNO_SILENT;
5117             }
5118             continue; /* execute next BRANCH[J] op */
5119             assert(0); /* NOTREACHED */
5120
5121         case MINMOD:
5122             minmod = 1;
5123             break;
5124
5125 #undef  ST
5126 #define ST st->u.curlym
5127
5128         case CURLYM:    /* /A{m,n}B/ where A is fixed-length */
5129
5130             /* This is an optimisation of CURLYX that enables us to push
5131              * only a single backtracking state, no matter how many matches
5132              * there are in {m,n}. It relies on the pattern being constant
5133              * length, with no parens to influence future backrefs
5134              */
5135
5136             ST.me = scan;
5137             scan = NEXTOPER(scan) + NODE_STEP_REGNODE;
5138
5139             ST.lastparen      = rex->lastparen;
5140             ST.lastcloseparen = rex->lastcloseparen;
5141
5142             /* if paren positive, emulate an OPEN/CLOSE around A */
5143             if (ST.me->flags) {
5144                 U32 paren = ST.me->flags;
5145                 if (paren > PL_regsize)
5146                     PL_regsize = paren;
5147                 scan += NEXT_OFF(scan); /* Skip former OPEN. */
5148             }
5149             ST.A = scan;
5150             ST.B = next;
5151             ST.alen = 0;
5152             ST.count = 0;
5153             ST.minmod = minmod;
5154             minmod = 0;
5155             ST.c1 = CHRTEST_UNINIT;
5156             REGCP_SET(ST.cp);
5157
5158             if (!(ST.minmod ? ARG1(ST.me) : ARG2(ST.me))) /* min/max */
5159                 goto curlym_do_B;
5160
5161           curlym_do_A: /* execute the A in /A{m,n}B/  */
5162             PL_reginput = locinput;
5163             PUSH_YES_STATE_GOTO(CURLYM_A, ST.A); /* match A */
5164             assert(0); /* NOTREACHED */
5165
5166         case CURLYM_A: /* we've just matched an A */
5167             locinput = st->locinput;
5168             nextchr = UCHARAT(locinput);
5169
5170             ST.count++;
5171             /* after first match, determine A's length: u.curlym.alen */
5172             if (ST.count == 1) {
5173                 if (PL_reg_match_utf8) {
5174                     char *s = locinput;
5175                     while (s < PL_reginput) {
5176                         ST.alen++;
5177                         s += UTF8SKIP(s);
5178                     }
5179                 }
5180                 else {
5181                     ST.alen = PL_reginput - locinput;
5182                 }
5183                 if (ST.alen == 0)
5184                     ST.count = ST.minmod ? ARG1(ST.me) : ARG2(ST.me);
5185             }
5186             DEBUG_EXECUTE_r(
5187                 PerlIO_printf(Perl_debug_log,
5188                           "%*s  CURLYM now matched %"IVdf" times, len=%"IVdf"...\n",
5189                           (int)(REPORT_CODE_OFF+(depth*2)), "",
5190                           (IV) ST.count, (IV)ST.alen)
5191             );
5192
5193             locinput = PL_reginput;
5194
5195             if (cur_eval && cur_eval->u.eval.close_paren &&
5196                 cur_eval->u.eval.close_paren == (U32)ST.me->flags)
5197                 goto fake_end;
5198
5199             {
5200                 I32 max = (ST.minmod ? ARG1(ST.me) : ARG2(ST.me));
5201                 if ( max == REG_INFTY || ST.count < max )
5202                     goto curlym_do_A; /* try to match another A */
5203             }
5204             goto curlym_do_B; /* try to match B */
5205
5206         case CURLYM_A_fail: /* just failed to match an A */
5207             REGCP_UNWIND(ST.cp);
5208
5209             if (ST.minmod || ST.count < ARG1(ST.me) /* min*/
5210                 || (cur_eval && cur_eval->u.eval.close_paren &&
5211                     cur_eval->u.eval.close_paren == (U32)ST.me->flags))
5212                 sayNO;
5213
5214           curlym_do_B: /* execute the B in /A{m,n}B/  */
5215             PL_reginput = locinput;
5216             if (ST.c1 == CHRTEST_UNINIT) {
5217                 /* calculate c1 and c2 for possible match of 1st char
5218                  * following curly */
5219                 ST.c1 = ST.c2 = CHRTEST_VOID;
5220                 if (HAS_TEXT(ST.B) || JUMPABLE(ST.B)) {
5221                     regnode *text_node = ST.B;
5222                     if (! HAS_TEXT(text_node))
5223                         FIND_NEXT_IMPT(text_node);
5224                     /* this used to be
5225
5226                         (HAS_TEXT(text_node) && PL_regkind[OP(text_node)] == EXACT)
5227
5228                         But the former is redundant in light of the latter.
5229
5230                         if this changes back then the macro for
5231                         IS_TEXT and friends need to change.
5232                      */
5233                     if (PL_regkind[OP(text_node)] == EXACT)
5234                     {
5235
5236                         ST.c1 = (U8)*STRING(text_node);
5237                         switch (OP(text_node)) {
5238                             case EXACTF: ST.c2 = PL_fold[ST.c1]; break;
5239                             case EXACTFA:
5240                             case EXACTFU_SS:
5241                             case EXACTFU_TRICKYFOLD:
5242                             case EXACTFU: ST.c2 = PL_fold_latin1[ST.c1]; break;
5243                             case EXACTFL: ST.c2 = PL_fold_locale[ST.c1]; break;
5244                             default: ST.c2 = ST.c1;
5245                         }
5246                     }
5247                 }
5248             }
5249
5250             DEBUG_EXECUTE_r(
5251                 PerlIO_printf(Perl_debug_log,
5252                     "%*s  CURLYM trying tail with matches=%"IVdf"...\n",
5253                     (int)(REPORT_CODE_OFF+(depth*2)),
5254                     "", (IV)ST.count)
5255                 );
5256             if (ST.c1 != CHRTEST_VOID
5257                     && UCHARAT(PL_reginput) != ST.c1
5258                     && UCHARAT(PL_reginput) != ST.c2)
5259             {
5260                 /* simulate B failing */
5261                 DEBUG_OPTIMISE_r(
5262                     PerlIO_printf(Perl_debug_log,
5263                         "%*s  CURLYM Fast bail c1=%"IVdf" c2=%"IVdf"\n",
5264                         (int)(REPORT_CODE_OFF+(depth*2)),"",
5265                         (IV)ST.c1,(IV)ST.c2
5266                 ));
5267                 state_num = CURLYM_B_fail;
5268                 goto reenter_switch;
5269             }
5270
5271             if (ST.me->flags) {
5272                 /* emulate CLOSE: mark current A as captured */
5273                 I32 paren = ST.me->flags;
5274                 if (ST.count) {
5275                     rex->offs[paren].start
5276                         = HOPc(PL_reginput, -ST.alen) - PL_bostr;
5277                     rex->offs[paren].end = PL_reginput - PL_bostr;
5278                     if ((U32)paren > rex->lastparen)
5279                         rex->lastparen = paren;
5280                     rex->lastcloseparen = paren;
5281                 }
5282                 else
5283                     rex->offs[paren].end = -1;
5284                 if (cur_eval && cur_eval->u.eval.close_paren &&
5285                     cur_eval->u.eval.close_paren == (U32)ST.me->flags)
5286                 {
5287                     if (ST.count)
5288                         goto fake_end;
5289                     else
5290                         sayNO;
5291                 }
5292             }
5293
5294             PUSH_STATE_GOTO(CURLYM_B, ST.B); /* match B */
5295             assert(0); /* NOTREACHED */
5296
5297         case CURLYM_B_fail: /* just failed to match a B */
5298             REGCP_UNWIND(ST.cp);
5299             UNWIND_PAREN(ST.lastparen, ST.lastcloseparen);
5300             if (ST.minmod) {
5301                 I32 max = ARG2(ST.me);
5302                 if (max != REG_INFTY && ST.count == max)
5303                     sayNO;
5304                 goto curlym_do_A; /* try to match a further A */
5305             }
5306             /* backtrack one A */
5307             if (ST.count == ARG1(ST.me) /* min */)
5308                 sayNO;
5309             ST.count--;
5310             locinput = HOPc(locinput, -ST.alen);
5311             goto curlym_do_B; /* try to match B */
5312
5313 #undef ST
5314 #define ST st->u.curly
5315
5316 #define CURLY_SETPAREN(paren, success) \
5317     if (paren) { \
5318         if (success) { \
5319             rex->offs[paren].start = HOPc(locinput, -1) - PL_bostr; \
5320             rex->offs[paren].end = locinput - PL_bostr; \
5321             if (paren > rex->lastparen) \
5322                 rex->lastparen = paren; \
5323             rex->lastcloseparen = paren; \
5324         } \
5325         else { \
5326             rex->offs[paren].end = -1; \
5327             rex->lastparen      = ST.lastparen; \
5328             rex->lastcloseparen = ST.lastcloseparen; \
5329         } \
5330     }
5331
5332         case STAR:              /*  /A*B/ where A is width 1 */
5333             ST.paren = 0;
5334             ST.min = 0;
5335             ST.max = REG_INFTY;
5336             scan = NEXTOPER(scan);
5337             goto repeat;
5338         case PLUS:              /*  /A+B/ where A is width 1 */
5339             ST.paren = 0;
5340             ST.min = 1;
5341             ST.max = REG_INFTY;
5342             scan = NEXTOPER(scan);
5343             goto repeat;
5344         case CURLYN:            /*  /(A){m,n}B/ where A is width 1 */
5345             ST.paren = scan->flags;     /* Which paren to set */
5346             ST.lastparen      = rex->lastparen;
5347             ST.lastcloseparen = rex->lastcloseparen;
5348             if (ST.paren > PL_regsize)
5349                 PL_regsize = ST.paren;
5350             ST.min = ARG1(scan);  /* min to match */
5351             ST.max = ARG2(scan);  /* max to match */
5352             if (cur_eval && cur_eval->u.eval.close_paren &&
5353                 cur_eval->u.eval.close_paren == (U32)ST.paren) {
5354                 ST.min=1;
5355                 ST.max=1;
5356             }
5357             scan = regnext(NEXTOPER(scan) + NODE_STEP_REGNODE);
5358             goto repeat;
5359         case CURLY:             /*  /A{m,n}B/ where A is width 1 */
5360             ST.paren = 0;
5361             ST.min = ARG1(scan);  /* min to match */
5362             ST.max = ARG2(scan);  /* max to match */
5363             scan = NEXTOPER(scan) + NODE_STEP_REGNODE;
5364           repeat:
5365             /*
5366             * Lookahead to avoid useless match attempts
5367             * when we know what character comes next.
5368             *
5369             * Used to only do .*x and .*?x, but now it allows
5370             * for )'s, ('s and (?{ ... })'s to be in the way
5371             * of the quantifier and the EXACT-like node.  -- japhy
5372             */
5373
5374             if (ST.min > ST.max) /* XXX make this a compile-time check? */
5375                 sayNO;
5376             if (HAS_TEXT(next) || JUMPABLE(next)) {
5377                 U8 *s;
5378                 regnode *text_node = next;
5379
5380                 if (! HAS_TEXT(text_node))
5381                     FIND_NEXT_IMPT(text_node);
5382
5383                 if (! HAS_TEXT(text_node))
5384                     ST.c1 = ST.c2 = CHRTEST_VOID;
5385                 else {
5386                     if ( PL_regkind[OP(text_node)] != EXACT ) {
5387                         ST.c1 = ST.c2 = CHRTEST_VOID;
5388                         goto assume_ok_easy;
5389                     }
5390                     else
5391                         s = (U8*)STRING(text_node);
5392
5393                     /*  Currently we only get here when
5394
5395                         PL_rekind[OP(text_node)] == EXACT
5396
5397                         if this changes back then the macro for IS_TEXT and
5398                         friends need to change. */
5399                     if (!UTF_PATTERN) {
5400                         ST.c1 = *s;
5401                         switch (OP(text_node)) {
5402                             case EXACTF: ST.c2 = PL_fold[ST.c1]; break;
5403                             case EXACTFA:
5404                             case EXACTFU_SS:
5405                             case EXACTFU_TRICKYFOLD:
5406                             case EXACTFU: ST.c2 = PL_fold_latin1[ST.c1]; break;
5407                             case EXACTFL: ST.c2 = PL_fold_locale[ST.c1]; break;
5408                             default: ST.c2 = ST.c1; break;
5409                         }
5410                     }
5411                     else { /* UTF_PATTERN */
5412                         if (IS_TEXTFU(text_node) || IS_TEXTF(text_node)) {
5413                              STRLEN ulen;
5414                              U8 tmpbuf[UTF8_MAXBYTES_CASE+1];
5415
5416                              to_utf8_fold((U8*)s, tmpbuf, &ulen);
5417                              ST.c1 = ST.c2 = utf8n_to_uvchr(tmpbuf, UTF8_MAXLEN, 0,
5418                                                     uniflags);
5419                         }
5420                         else {
5421                             ST.c2 = ST.c1 = utf8n_to_uvchr(s, UTF8_MAXBYTES, 0,
5422                                                      uniflags);
5423                         }
5424                     }
5425                 }
5426             }
5427             else
5428                 ST.c1 = ST.c2 = CHRTEST_VOID;
5429         assume_ok_easy:
5430
5431             ST.A = scan;
5432             ST.B = next;
5433             PL_reginput = locinput;
5434             if (minmod) {
5435                 minmod = 0;
5436                 if (ST.min && regrepeat(rex, ST.A, ST.min, depth) < ST.min)
5437                     sayNO;
5438                 ST.count = ST.min;
5439                 locinput = PL_reginput;
5440                 REGCP_SET(ST.cp);
5441                 if (ST.c1 == CHRTEST_VOID)
5442                     goto curly_try_B_min;
5443
5444                 ST.oldloc = locinput;
5445
5446                 /* set ST.maxpos to the furthest point along the
5447                  * string that could possibly match */
5448                 if  (ST.max == REG_INFTY) {
5449                     ST.maxpos = PL_regeol - 1;
5450                     if (utf8_target)
5451                         while (UTF8_IS_CONTINUATION(*(U8*)ST.maxpos))
5452                             ST.maxpos--;
5453                 }
5454                 else if (utf8_target) {
5455                     int m = ST.max - ST.min;
5456                     for (ST.maxpos = locinput;
5457                          m >0 && ST.maxpos + UTF8SKIP(ST.maxpos) <= PL_regeol; m--)
5458                         ST.maxpos += UTF8SKIP(ST.maxpos);
5459                 }
5460                 else {
5461                     ST.maxpos = locinput + ST.max - ST.min;
5462                     if (ST.maxpos >= PL_regeol)
5463                         ST.maxpos = PL_regeol - 1;
5464                 }
5465                 goto curly_try_B_min_known;
5466
5467             }
5468             else {
5469                 ST.count = regrepeat(rex, ST.A, ST.max, depth);
5470                 locinput = PL_reginput;
5471                 if (ST.count < ST.min)
5472                     sayNO;
5473                 if ((ST.count > ST.min)
5474                     && (PL_regkind[OP(ST.B)] == EOL) && (OP(ST.B) != MEOL))
5475                 {
5476                     /* A{m,n} must come at the end of the string, there's
5477                      * no point in backing off ... */
5478                     ST.min = ST.count;
5479                     /* ...except that $ and \Z can match before *and* after
5480                        newline at the end.  Consider "\n\n" =~ /\n+\Z\n/.
5481                        We may back off by one in this case. */
5482                     if (UCHARAT(PL_reginput - 1) == '\n' && OP(ST.B) != EOS)
5483                         ST.min--;
5484                 }
5485                 REGCP_SET(ST.cp);
5486                 goto curly_try_B_max;
5487             }
5488             assert(0); /* NOTREACHED */
5489
5490
5491         case CURLY_B_min_known_fail:
5492             /* failed to find B in a non-greedy match where c1,c2 valid */
5493
5494             PL_reginput = locinput;     /* Could be reset... */
5495             REGCP_UNWIND(ST.cp);
5496             if (ST.paren) {
5497                 UNWIND_PAREN(ST.lastparen, ST.lastcloseparen);
5498             }
5499             /* Couldn't or didn't -- move forward. */
5500             ST.oldloc = locinput;
5501             if (utf8_target)
5502                 locinput += UTF8SKIP(locinput);
5503             else
5504                 locinput++;
5505             ST.count++;
5506           curly_try_B_min_known:
5507              /* find the next place where 'B' could work, then call B */
5508             {
5509                 int n;
5510                 if (utf8_target) {
5511                     n = (ST.oldloc == locinput) ? 0 : 1;
5512                     if (ST.c1 == ST.c2) {
5513                         STRLEN len;
5514                         /* set n to utf8_distance(oldloc, locinput) */
5515                         while (locinput <= ST.maxpos &&
5516                                utf8n_to_uvchr((U8*)locinput,
5517                                               UTF8_MAXBYTES, &len,
5518                                               uniflags) != (UV)ST.c1) {
5519                             locinput += len;
5520                             n++;
5521                         }
5522                     }
5523                     else {
5524                         /* set n to utf8_distance(oldloc, locinput) */
5525                         while (locinput <= ST.maxpos) {
5526                             STRLEN len;
5527                             const UV c = utf8n_to_uvchr((U8*)locinput,
5528                                                   UTF8_MAXBYTES, &len,
5529                                                   uniflags);
5530                             if (c == (UV)ST.c1 || c == (UV)ST.c2)
5531                                 break;
5532                             locinput += len;
5533                             n++;
5534                         }
5535                     }
5536                 }
5537                 else {
5538                     if (ST.c1 == ST.c2) {
5539                         while (locinput <= ST.maxpos &&
5540                                UCHARAT(locinput) != ST.c1)
5541                             locinput++;
5542                     }
5543                     else {
5544                         while (locinput <= ST.maxpos
5545                                && UCHARAT(locinput) != ST.c1
5546                                && UCHARAT(locinput) != ST.c2)
5547                             locinput++;
5548                     }
5549                     n = locinput - ST.oldloc;
5550                 }
5551                 if (locinput > ST.maxpos)
5552                     sayNO;
5553                 /* PL_reginput == oldloc now */
5554                 if (n) {
5555                     ST.count += n;
5556                     if (regrepeat(rex, ST.A, n, depth) < n)
5557                         sayNO;
5558                 }
5559                 PL_reginput = locinput;
5560                 CURLY_SETPAREN(ST.paren, ST.count);
5561                 if (cur_eval && cur_eval->u.eval.close_paren &&
5562                     cur_eval->u.eval.close_paren == (U32)ST.paren) {
5563                     goto fake_end;
5564                 }
5565                 PUSH_STATE_GOTO(CURLY_B_min_known, ST.B);
5566             }
5567             assert(0); /* NOTREACHED */
5568
5569
5570         case CURLY_B_min_fail:
5571             /* failed to find B in a non-greedy match where c1,c2 invalid */
5572
5573             REGCP_UNWIND(ST.cp);
5574             if (ST.paren) {
5575                 UNWIND_PAREN(ST.lastparen, ST.lastcloseparen);
5576             }
5577             /* failed -- move forward one */
5578             PL_reginput = locinput;
5579             if (regrepeat(rex, ST.A, 1, depth)) {
5580                 ST.count++;
5581                 locinput = PL_reginput;
5582                 if (ST.count <= ST.max || (ST.max == REG_INFTY &&
5583                         ST.count > 0)) /* count overflow ? */
5584                 {
5585                   curly_try_B_min:
5586                     CURLY_SETPAREN(ST.paren, ST.count);
5587                     if (cur_eval && cur_eval->u.eval.close_paren &&
5588                         cur_eval->u.eval.close_paren == (U32)ST.paren) {
5589                         goto fake_end;
5590                     }
5591                     PUSH_STATE_GOTO(CURLY_B_min, ST.B);
5592                 }
5593             }
5594             sayNO;
5595             assert(0); /* NOTREACHED */
5596
5597
5598         curly_try_B_max:
5599             /* a successful greedy match: now try to match B */
5600             if (cur_eval && cur_eval->u.eval.close_paren &&
5601                 cur_eval->u.eval.close_paren == (U32)ST.paren) {
5602                 goto fake_end;
5603             }
5604             {
5605                 UV c = 0;
5606                 if (ST.c1 != CHRTEST_VOID)
5607                     c = utf8_target ? utf8n_to_uvchr((U8*)PL_reginput,
5608                                            UTF8_MAXBYTES, 0, uniflags)
5609                                 : (UV) UCHARAT(PL_reginput);
5610                 /* If it could work, try it. */
5611                 if (ST.c1 == CHRTEST_VOID || c == (UV)ST.c1 || c == (UV)ST.c2) {
5612                     CURLY_SETPAREN(ST.paren, ST.count);
5613                     PUSH_STATE_GOTO(CURLY_B_max, ST.B);
5614                     assert(0); /* NOTREACHED */
5615                 }
5616             }
5617             /* FALL THROUGH */
5618         case CURLY_B_max_fail:
5619             /* failed to find B in a greedy match */
5620
5621             REGCP_UNWIND(ST.cp);
5622             if (ST.paren) {
5623                 UNWIND_PAREN(ST.lastparen, ST.lastcloseparen);
5624             }
5625             /*  back up. */
5626             if (--ST.count < ST.min)
5627                 sayNO;
5628             PL_reginput = locinput = HOPc(locinput, -1);
5629             goto curly_try_B_max;
5630
5631 #undef ST
5632
5633         case END:
5634             fake_end:
5635             if (cur_eval) {
5636                 /* we've just finished A in /(??{A})B/; now continue with B */
5637                 st->u.eval.toggle_reg_flags
5638                             = cur_eval->u.eval.toggle_reg_flags;
5639                 PL_reg_flags ^= st->u.eval.toggle_reg_flags;
5640
5641                 st->u.eval.prev_rex = rex_sv;           /* inner */
5642                 st->u.eval.cp = regcppush(rex, 0); /* Save *all* the positions. */
5643                 rex_sv = cur_eval->u.eval.prev_rex;
5644                 SET_reg_curpm(rex_sv);
5645                 rex = (struct regexp *)SvANY(rex_sv);
5646                 rexi = RXi_GET(rex);
5647                 cur_curlyx = cur_eval->u.eval.prev_curlyx;
5648
5649                 REGCP_SET(st->u.eval.lastcp);
5650                 PL_reginput = locinput;
5651
5652                 /* Restore parens of the outer rex without popping the
5653                  * savestack */
5654                 S_regcp_restore(aTHX_ rex, cur_eval->u.eval.lastcp);
5655
5656                 st->u.eval.prev_eval = cur_eval;
5657                 cur_eval = cur_eval->u.eval.prev_eval;
5658                 DEBUG_EXECUTE_r(
5659                     PerlIO_printf(Perl_debug_log, "%*s  EVAL trying tail ... %"UVxf"\n",
5660                                       REPORT_CODE_OFF+depth*2, "",PTR2UV(cur_eval)););
5661                 if ( nochange_depth )
5662                     nochange_depth--;
5663
5664                 PUSH_YES_STATE_GOTO(EVAL_AB,
5665                         st->u.eval.prev_eval->u.eval.B); /* match B */
5666             }
5667
5668             if (locinput < reginfo->till) {
5669                 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
5670                                       "%sMatch possible, but length=%ld is smaller than requested=%ld, failing!%s\n",
5671                                       PL_colors[4],
5672                                       (long)(locinput - PL_reg_starttry),
5673                                       (long)(reginfo->till - PL_reg_starttry),
5674                                       PL_colors[5]));
5675
5676                 sayNO_SILENT;           /* Cannot match: too short. */
5677             }
5678             PL_reginput = locinput;     /* put where regtry can find it */
5679             sayYES;                     /* Success! */
5680
5681         case SUCCEED: /* successful SUSPEND/UNLESSM/IFMATCH/CURLYM */
5682             DEBUG_EXECUTE_r(
5683             PerlIO_printf(Perl_debug_log,
5684                 "%*s  %ssubpattern success...%s\n",
5685                 REPORT_CODE_OFF+depth*2, "", PL_colors[4], PL_colors[5]));
5686             PL_reginput = locinput;     /* put where regtry can find it */
5687             sayYES;                     /* Success! */
5688
5689 #undef  ST
5690 #define ST st->u.ifmatch
5691
5692         case SUSPEND:   /* (?>A) */
5693             ST.wanted = 1;
5694             PL_reginput = locinput;
5695             goto do_ifmatch;
5696
5697         case UNLESSM:   /* -ve lookaround: (?!A), or with flags, (?<!A) */
5698             ST.wanted = 0;
5699             goto ifmatch_trivial_fail_test;
5700
5701         case IFMATCH:   /* +ve lookaround: (?=A), or with flags, (?<=A) */
5702             ST.wanted = 1;
5703           ifmatch_trivial_fail_test:
5704             if (scan->flags) {
5705                 char * const s = HOPBACKc(locinput, scan->flags);
5706                 if (!s) {
5707                     /* trivial fail */
5708                     if (logical) {
5709                         logical = 0;
5710                         sw = 1 - cBOOL(ST.wanted);
5711                     }
5712                     else if (ST.wanted)
5713                         sayNO;
5714                     next = scan + ARG(scan);
5715                     if (next == scan)
5716                         next = NULL;
5717                     break;
5718                 }
5719                 PL_reginput = s;
5720             }
5721             else
5722                 PL_reginput = locinput;
5723
5724           do_ifmatch:
5725             ST.me = scan;
5726             ST.logical = logical;
5727             logical = 0; /* XXX: reset state of logical once it has been saved into ST */
5728
5729             /* execute body of (?...A) */
5730             PUSH_YES_STATE_GOTO(IFMATCH_A, NEXTOPER(NEXTOPER(scan)));
5731             assert(0); /* NOTREACHED */
5732
5733         case IFMATCH_A_fail: /* body of (?...A) failed */
5734             ST.wanted = !ST.wanted;
5735             /* FALL THROUGH */
5736
5737         case IFMATCH_A: /* body of (?...A) succeeded */
5738             if (ST.logical) {
5739                 sw = cBOOL(ST.wanted);
5740             }
5741             else if (!ST.wanted)
5742                 sayNO;
5743
5744             if (OP(ST.me) == SUSPEND)
5745                 locinput = PL_reginput;
5746             else {
5747                 locinput = PL_reginput = st->locinput;
5748                 nextchr = UCHARAT(locinput);
5749             }
5750             scan = ST.me + ARG(ST.me);
5751             if (scan == ST.me)
5752                 scan = NULL;
5753             continue; /* execute B */
5754
5755 #undef ST
5756
5757         case LONGJMP:
5758             next = scan + ARG(scan);
5759             if (next == scan)
5760                 next = NULL;
5761             break;
5762         case COMMIT:
5763             reginfo->cutpoint = PL_regeol;
5764             /* FALLTHROUGH */
5765         case PRUNE:
5766             PL_reginput = locinput;
5767             if (!scan->flags)
5768                 sv_yes_mark = sv_commit = MUTABLE_SV(rexi->data->data[ ARG( scan ) ]);
5769             PUSH_STATE_GOTO(COMMIT_next,next);
5770             assert(0); /* NOTREACHED */
5771         case COMMIT_next_fail:
5772             no_final = 1;
5773             /* FALLTHROUGH */
5774         case OPFAIL:
5775             sayNO;
5776             assert(0); /* NOTREACHED */
5777
5778 #define ST st->u.mark
5779         case MARKPOINT:
5780             ST.prev_mark = mark_state;
5781             ST.mark_name = sv_commit = sv_yes_mark
5782                 = MUTABLE_SV(rexi->data->data[ ARG( scan ) ]);
5783             mark_state = st;
5784             ST.mark_loc = PL_reginput = locinput;
5785             PUSH_YES_STATE_GOTO(MARKPOINT_next,next);
5786             assert(0); /* NOTREACHED */
5787         case MARKPOINT_next:
5788             mark_state = ST.prev_mark;
5789             sayYES;
5790             assert(0); /* NOTREACHED */
5791         case MARKPOINT_next_fail:
5792             if (popmark && sv_eq(ST.mark_name,popmark))
5793             {
5794                 if (ST.mark_loc > startpoint)
5795                     reginfo->cutpoint = HOPBACKc(ST.mark_loc, 1);
5796                 popmark = NULL; /* we found our mark */
5797                 sv_commit = ST.mark_name;
5798
5799                 DEBUG_EXECUTE_r({
5800                         PerlIO_printf(Perl_debug_log,
5801                             "%*s  %ssetting cutpoint to mark:%"SVf"...%s\n",
5802                             REPORT_CODE_OFF+depth*2, "",
5803                             PL_colors[4], SVfARG(sv_commit), PL_colors[5]);
5804                 });
5805             }
5806             mark_state = ST.prev_mark;
5807             sv_yes_mark = mark_state ?
5808                 mark_state->u.mark.mark_name : NULL;
5809             sayNO;
5810             assert(0); /* NOTREACHED */
5811         case SKIP:
5812             PL_reginput = locinput;
5813             if (scan->flags) {
5814                 /* (*SKIP) : if we fail we cut here*/
5815                 ST.mark_name = NULL;
5816                 ST.mark_loc = locinput;
5817                 PUSH_STATE_GOTO(SKIP_next,next);
5818             } else {
5819                 /* (*SKIP:NAME) : if there is a (*MARK:NAME) fail where it was,
5820                    otherwise do nothing.  Meaning we need to scan
5821                  */
5822                 regmatch_state *cur = mark_state;
5823                 SV *find = MUTABLE_SV(rexi->data->data[ ARG( scan ) ]);
5824
5825                 while (cur) {
5826                     if ( sv_eq( cur->u.mark.mark_name,
5827                                 find ) )
5828                     {
5829                         ST.mark_name = find;
5830                         PUSH_STATE_GOTO( SKIP_next, next );
5831                     }
5832                     cur = cur->u.mark.prev_mark;
5833                 }
5834             }
5835             /* Didn't find our (*MARK:NAME) so ignore this (*SKIP:NAME) */
5836             break;
5837         case SKIP_next_fail:
5838             if (ST.mark_name) {
5839                 /* (*CUT:NAME) - Set up to search for the name as we
5840                    collapse the stack*/
5841                 popmark = ST.mark_name;
5842             } else {
5843                 /* (*CUT) - No name, we cut here.*/
5844                 if (ST.mark_loc > startpoint)
5845                     reginfo->cutpoint = HOPBACKc(ST.mark_loc, 1);
5846                 /* but we set sv_commit to latest mark_name if there
5847                    is one so they can test to see how things lead to this
5848                    cut */
5849                 if (mark_state)
5850                     sv_commit=mark_state->u.mark.mark_name;
5851             }
5852             no_final = 1;
5853             sayNO;
5854             assert(0); /* NOTREACHED */
5855 #undef ST
5856         case LNBREAK:
5857             if ((n=is_LNBREAK(locinput,utf8_target))) {
5858                 locinput += n;
5859                 nextchr = UCHARAT(locinput);
5860             } else
5861                 sayNO;
5862             break;
5863
5864 #define CASE_CLASS(nAmE)                              \
5865         case nAmE:                                    \
5866             if (locinput >= PL_regeol)                \
5867                 sayNO;                                \
5868             if ((n=is_##nAmE(locinput,utf8_target))) {    \
5869                 locinput += n;                        \
5870                 nextchr = UCHARAT(locinput);          \
5871             } else                                    \
5872                 sayNO;                                \
5873             break;                                    \
5874         case N##nAmE:                                 \
5875             if (locinput >= PL_regeol)                \
5876                 sayNO;                                \
5877             if ((n=is_##nAmE(locinput,utf8_target))) {    \
5878                 sayNO;                                \
5879             } else {                                  \
5880                 locinput += UTF8SKIP(locinput);       \
5881                 nextchr = UCHARAT(locinput);          \
5882             }                                         \
5883             break
5884
5885         CASE_CLASS(VERTWS);
5886         CASE_CLASS(HORIZWS);
5887 #undef CASE_CLASS
5888
5889         default:
5890             PerlIO_printf(Perl_error_log, "%"UVxf" %d\n",
5891                           PTR2UV(scan), OP(scan));
5892             Perl_croak(aTHX_ "regexp memory corruption");
5893
5894         } /* end switch */
5895
5896         /* switch break jumps here */
5897         scan = next; /* prepare to execute the next op and ... */
5898         continue;    /* ... jump back to the top, reusing st */
5899         assert(0); /* NOTREACHED */
5900
5901       push_yes_state:
5902         /* push a state that backtracks on success */
5903         st->u.yes.prev_yes_state = yes_state;
5904         yes_state = st;
5905         /* FALL THROUGH */
5906       push_state:
5907         /* push a new regex state, then continue at scan  */
5908         {
5909             regmatch_state *newst;
5910
5911             DEBUG_STACK_r({
5912                 regmatch_state *cur = st;
5913                 regmatch_state *curyes = yes_state;
5914                 int curd = depth;
5915                 regmatch_slab *slab = PL_regmatch_slab;
5916                 for (;curd > -1;cur--,curd--) {
5917                     if (cur < SLAB_FIRST(slab)) {
5918                         slab = slab->prev;
5919                         cur = SLAB_LAST(slab);
5920                     }
5921                     PerlIO_printf(Perl_error_log, "%*s#%-3d %-10s %s\n",
5922                         REPORT_CODE_OFF + 2 + depth * 2,"",
5923                         curd, PL_reg_name[cur->resume_state],
5924                         (curyes == cur) ? "yes" : ""
5925                     );
5926                     if (curyes == cur)
5927                         curyes = cur->u.yes.prev_yes_state;
5928                 }
5929             } else
5930                 DEBUG_STATE_pp("push")
5931             );
5932             depth++;
5933             st->locinput = locinput;
5934             newst = st+1;
5935             if (newst >  SLAB_LAST(PL_regmatch_slab))
5936                 newst = S_push_slab(aTHX);
5937             PL_regmatch_state = newst;
5938
5939             locinput = PL_reginput;
5940             nextchr = UCHARAT(locinput);
5941             st = newst;
5942             continue;
5943             assert(0); /* NOTREACHED */
5944         }
5945     }
5946
5947     /*
5948     * We get here only if there's trouble -- normally "case END" is
5949     * the terminating point.
5950     */
5951     Perl_croak(aTHX_ "corrupted regexp pointers");
5952     /*NOTREACHED*/
5953     sayNO;
5954
5955 yes:
5956     if (yes_state) {
5957         /* we have successfully completed a subexpression, but we must now
5958          * pop to the state marked by yes_state and continue from there */
5959         assert(st != yes_state);
5960 #ifdef DEBUGGING
5961         while (st != yes_state) {
5962             st--;
5963             if (st < SLAB_FIRST(PL_regmatch_slab)) {
5964                 PL_regmatch_slab = PL_regmatch_slab->prev;
5965                 st = SLAB_LAST(PL_regmatch_slab);
5966             }
5967             DEBUG_STATE_r({
5968                 if (no_final) {
5969                     DEBUG_STATE_pp("pop (no final)");
5970                 } else {
5971                     DEBUG_STATE_pp("pop (yes)");
5972                 }
5973             });
5974             depth--;
5975         }
5976 #else
5977         while (yes_state < SLAB_FIRST(PL_regmatch_slab)
5978             || yes_state > SLAB_LAST(PL_regmatch_slab))
5979         {
5980             /* not in this slab, pop slab */
5981             depth -= (st - SLAB_FIRST(PL_regmatch_slab) + 1);
5982             PL_regmatch_slab = PL_regmatch_slab->prev;
5983             st = SLAB_LAST(PL_regmatch_slab);
5984         }
5985         depth -= (st - yes_state);
5986 #endif
5987         st = yes_state;
5988         yes_state = st->u.yes.prev_yes_state;
5989         PL_regmatch_state = st;
5990
5991         if (no_final) {
5992             locinput= st->locinput;
5993             nextchr = UCHARAT(locinput);
5994         }
5995         state_num = st->resume_state + no_final;
5996         goto reenter_switch;
5997     }
5998
5999     DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "%sMatch successful!%s\n",
6000                           PL_colors[4], PL_colors[5]));
6001
6002     if (PL_reg_state.re_state_eval_setup_done) {
6003         /* each successfully executed (?{...}) block does the equivalent of
6004          *   local $^R = do {...}
6005          * When popping the save stack, all these locals would be undone;
6006          * bypass this by setting the outermost saved $^R to the latest
6007          * value */
6008         if (oreplsv != GvSV(PL_replgv))
6009             sv_setsv(oreplsv, GvSV(PL_replgv));
6010     }
6011     result = 1;
6012     goto final_exit;
6013
6014 no:
6015     DEBUG_EXECUTE_r(
6016         PerlIO_printf(Perl_debug_log,
6017             "%*s  %sfailed...%s\n",
6018             REPORT_CODE_OFF+depth*2, "",
6019             PL_colors[4], PL_colors[5])
6020         );
6021
6022 no_silent:
6023     if (no_final) {
6024         if (yes_state) {
6025             goto yes;
6026         } else {
6027             goto final_exit;
6028         }
6029     }
6030     if (depth) {
6031         /* there's a previous state to backtrack to */
6032         st--;
6033         if (st < SLAB_FIRST(PL_regmatch_slab)) {
6034             PL_regmatch_slab = PL_regmatch_slab->prev;
6035             st = SLAB_LAST(PL_regmatch_slab);
6036         }
6037         PL_regmatch_state = st;
6038         locinput= st->locinput;
6039         nextchr = UCHARAT(locinput);
6040
6041         DEBUG_STATE_pp("pop");
6042         depth--;
6043         if (yes_state == st)
6044             yes_state = st->u.yes.prev_yes_state;
6045
6046         state_num = st->resume_state + 1; /* failure = success + 1 */
6047         goto reenter_switch;
6048     }
6049     result = 0;
6050
6051   final_exit:
6052     if (rex->intflags & PREGf_VERBARG_SEEN) {
6053         SV *sv_err = get_sv("REGERROR", 1);
6054         SV *sv_mrk = get_sv("REGMARK", 1);
6055         if (result) {
6056             sv_commit = &PL_sv_no;
6057             if (!sv_yes_mark)
6058                 sv_yes_mark = &PL_sv_yes;
6059         } else {
6060             if (!sv_commit)
6061                 sv_commit = &PL_sv_yes;
6062             sv_yes_mark = &PL_sv_no;
6063         }
6064         sv_setsv(sv_err, sv_commit);
6065         sv_setsv(sv_mrk, sv_yes_mark);
6066     }
6067
6068
6069     if (last_pushed_cv) {
6070         dSP;
6071         POP_MULTICALL;
6072         PERL_UNUSED_VAR(SP);
6073     }
6074
6075     /* clean up; in particular, free all slabs above current one */
6076     LEAVE_SCOPE(oldsave);
6077
6078     return result;
6079 }
6080
6081 /*
6082  - regrepeat - repeatedly match something simple, report how many
6083  */
6084 /*
6085  * [This routine now assumes that it will only match on things of length 1.
6086  * That was true before, but now we assume scan - reginput is the count,
6087  * rather than incrementing count on every character.  [Er, except utf8.]]
6088  */
6089 STATIC I32
6090 S_regrepeat(pTHX_ const regexp *prog, const regnode *p, I32 max, int depth)
6091 {
6092     dVAR;
6093     char *scan;
6094     I32 c;
6095     char *loceol = PL_regeol;
6096     I32 hardcount = 0;
6097     bool utf8_target = PL_reg_match_utf8;
6098     UV utf8_flags;
6099 #ifndef DEBUGGING
6100     PERL_UNUSED_ARG(depth);
6101 #endif
6102
6103     PERL_ARGS_ASSERT_REGREPEAT;
6104
6105     scan = PL_reginput;
6106     if (max == REG_INFTY)
6107         max = I32_MAX;
6108     else if (max < loceol - scan)
6109         loceol = scan + max;
6110     switch (OP(p)) {
6111     case REG_ANY:
6112         if (utf8_target) {
6113             loceol = PL_regeol;
6114             while (scan < loceol && hardcount < max && *scan != '\n') {
6115                 scan += UTF8SKIP(scan);
6116                 hardcount++;
6117             }
6118         } else {
6119             while (scan < loceol && *scan != '\n')
6120                 scan++;
6121         }
6122         break;
6123     case SANY:
6124         if (utf8_target) {
6125             loceol = PL_regeol;
6126             while (scan < loceol && hardcount < max) {
6127                 scan += UTF8SKIP(scan);
6128                 hardcount++;
6129             }
6130         }
6131         else
6132             scan = loceol;
6133         break;
6134     case CANY:
6135         scan = loceol;
6136         break;
6137     case EXACT:
6138         /* To get here, EXACTish nodes must have *byte* length == 1.  That
6139          * means they match only characters in the string that can be expressed
6140          * as a single byte.  For non-utf8 strings, that means a simple match.
6141          * For utf8 strings, the character matched must be an invariant, or
6142          * downgradable to a single byte.  The pattern's utf8ness is
6143          * irrelevant, as since it's a single byte, it either isn't utf8, or if
6144          * it is, it's an invariant */
6145
6146         c = (U8)*STRING(p);
6147         assert(! UTF_PATTERN || UNI_IS_INVARIANT(c));
6148
6149         if (! utf8_target || UNI_IS_INVARIANT(c)) {
6150             while (scan < loceol && UCHARAT(scan) == c) {
6151                 scan++;
6152             }
6153         }
6154         else {
6155
6156             /* Here, the string is utf8, and the pattern char is different
6157              * in utf8 than not, so can't compare them directly.  Outside the
6158              * loop, find the two utf8 bytes that represent c, and then
6159              * look for those in sequence in the utf8 string */
6160             U8 high = UTF8_TWO_BYTE_HI(c);
6161             U8 low = UTF8_TWO_BYTE_LO(c);
6162             loceol = PL_regeol;
6163
6164             while (hardcount < max
6165                     && scan + 1 < loceol
6166                     && UCHARAT(scan) == high
6167                     && UCHARAT(scan + 1) == low)
6168             {
6169                 scan += 2;
6170                 hardcount++;
6171             }
6172         }
6173         break;
6174     case EXACTFA:
6175         utf8_flags = FOLDEQ_UTF8_NOMIX_ASCII;
6176         goto do_exactf;
6177
6178     case EXACTFL:
6179         PL_reg_flags |= RF_tainted;
6180         utf8_flags = FOLDEQ_UTF8_LOCALE;
6181         goto do_exactf;
6182
6183     case EXACTF:
6184             utf8_flags = 0;
6185             goto do_exactf;
6186
6187     case EXACTFU_SS:
6188     case EXACTFU_TRICKYFOLD:
6189     case EXACTFU:
6190         utf8_flags = (UTF_PATTERN) ? FOLDEQ_S2_ALREADY_FOLDED : 0;
6191
6192         /* The comments for the EXACT case above apply as well to these fold
6193          * ones */
6194
6195     do_exactf:
6196         c = (U8)*STRING(p);
6197         assert(! UTF_PATTERN || UNI_IS_INVARIANT(c));
6198
6199         if (utf8_target || OP(p) == EXACTFU_SS) { /* Use full Unicode fold matching */
6200             char *tmpeol = loceol;
6201             while (hardcount < max
6202                     && foldEQ_utf8_flags(scan, &tmpeol, 0, utf8_target,
6203                                    STRING(p), NULL, 1, cBOOL(UTF_PATTERN), utf8_flags))
6204             {
6205                 scan = tmpeol;
6206                 tmpeol = loceol;
6207                 hardcount++;
6208             }
6209
6210             /* XXX Note that the above handles properly the German sharp s in
6211              * the pattern matching ss in the string.  But it doesn't handle
6212              * properly cases where the string contains say 'LIGATURE ff' and
6213              * the pattern is 'f+'.  This would require, say, a new function or
6214              * revised interface to foldEQ_utf8(), in which the maximum number
6215              * of characters to match could be passed and it would return how
6216              * many actually did.  This is just one of many cases where
6217              * multi-char folds don't work properly, and so the fix is being
6218              * deferred */
6219         }
6220         else {
6221             U8 folded;
6222
6223             /* Here, the string isn't utf8 and c is a single byte; and either
6224              * the pattern isn't utf8 or c is an invariant, so its utf8ness
6225              * doesn't affect c.  Can just do simple comparisons for exact or
6226              * fold matching. */
6227             switch (OP(p)) {
6228                 case EXACTF: folded = PL_fold[c]; break;
6229                 case EXACTFA:
6230                 case EXACTFU_TRICKYFOLD:
6231                 case EXACTFU: folded = PL_fold_latin1[c]; break;
6232                 case EXACTFL: folded = PL_fold_locale[c]; break;
6233                 default: Perl_croak(aTHX_ "panic: Unexpected op %u", OP(p));
6234             }
6235             while (scan < loceol &&
6236                    (UCHARAT(scan) == c || UCHARAT(scan) == folded))
6237             {
6238                 scan++;
6239             }
6240         }
6241         break;
6242     case ANYOFV:
6243     case ANYOF:
6244         if (utf8_target || OP(p) == ANYOFV) {
6245             STRLEN inclasslen;
6246             loceol = PL_regeol;
6247             inclasslen = loceol - scan;
6248             while (hardcount < max
6249                    && ((inclasslen = loceol - scan) > 0)
6250                    && reginclass(prog, p, (U8*)scan, &inclasslen, utf8_target))
6251             {
6252                 scan += inclasslen;
6253                 hardcount++;
6254             }
6255         } else {
6256             while (scan < loceol && REGINCLASS(prog, p, (U8*)scan))
6257                 scan++;
6258         }
6259         break;
6260     case ALNUMU:
6261         if (utf8_target) {
6262     utf8_wordchar:
6263             loceol = PL_regeol;
6264             LOAD_UTF8_CHARCLASS_ALNUM();
6265             while (hardcount < max && scan < loceol &&
6266                    swash_fetch(PL_utf8_alnum, (U8*)scan, utf8_target))
6267             {
6268                 scan += UTF8SKIP(scan);
6269                 hardcount++;
6270             }
6271         } else {
6272             while (scan < loceol && isWORDCHAR_L1((U8) *scan)) {
6273                 scan++;
6274             }
6275         }
6276         break;
6277     case ALNUM:
6278         if (utf8_target)
6279             goto utf8_wordchar;
6280         while (scan < loceol && isALNUM((U8) *scan)) {
6281             scan++;
6282         }
6283         break;
6284     case ALNUMA:
6285         while (scan < loceol && isWORDCHAR_A((U8) *scan)) {
6286             scan++;
6287         }
6288         break;
6289     case ALNUML:
6290         PL_reg_flags |= RF_tainted;
6291         if (utf8_target) {
6292             loceol = PL_regeol;
6293             while (hardcount < max && scan < loceol &&
6294                    isALNUM_LC_utf8((U8*)scan)) {
6295                 scan += UTF8SKIP(scan);
6296                 hardcount++;
6297             }
6298         } else {
6299             while (scan < loceol && isALNUM_LC(*scan))
6300                 scan++;
6301         }
6302         break;
6303     case NALNUMU:
6304         if (utf8_target) {
6305
6306     utf8_Nwordchar:
6307
6308             loceol = PL_regeol;
6309             LOAD_UTF8_CHARCLASS_ALNUM();
6310             while (hardcount < max && scan < loceol &&
6311                    ! swash_fetch(PL_utf8_alnum, (U8*)scan, utf8_target))
6312             {
6313                 scan += UTF8SKIP(scan);
6314                 hardcount++;
6315             }
6316         } else {
6317             while (scan < loceol && ! isWORDCHAR_L1((U8) *scan)) {
6318                 scan++;
6319             }
6320         }
6321         break;
6322     case NALNUM:
6323         if (utf8_target)
6324             goto utf8_Nwordchar;
6325         while (scan < loceol && ! isALNUM((U8) *scan)) {
6326             scan++;
6327         }
6328         break;
6329
6330     case POSIXA:
6331        while (scan < loceol && _generic_isCC_A((U8) *scan, FLAGS(p))) {
6332             scan++;
6333         }
6334         break;
6335     case NPOSIXA:
6336         if (utf8_target) {
6337             while (scan < loceol && ! _generic_isCC_A((U8) *scan, FLAGS(p))) {
6338                 scan += UTF8SKIP(scan);
6339             }
6340         }
6341         else {
6342             while (scan < loceol && ! _generic_isCC_A((U8) *scan, FLAGS(p))) {
6343                 scan++;
6344             }
6345         }
6346         break;
6347     case NALNUMA:
6348         if (utf8_target) {
6349             while (scan < loceol && ! isWORDCHAR_A((U8) *scan)) {
6350                 scan += UTF8SKIP(scan);
6351             }
6352         }
6353         else {
6354             while (scan < loceol && ! isWORDCHAR_A((U8) *scan)) {
6355                 scan++;
6356             }
6357         }
6358         break;
6359     case NALNUML:
6360         PL_reg_flags |= RF_tainted;
6361         if (utf8_target) {
6362             loceol = PL_regeol;
6363             while (hardcount < max && scan < loceol &&
6364                    !isALNUM_LC_utf8((U8*)scan)) {
6365                 scan += UTF8SKIP(scan);
6366                 hardcount++;
6367             }
6368         } else {
6369             while (scan < loceol && !isALNUM_LC(*scan))
6370                 scan++;
6371         }
6372         break;
6373     case SPACEU:
6374         if (utf8_target) {
6375
6376     utf8_space:
6377
6378             loceol = PL_regeol;
6379             LOAD_UTF8_CHARCLASS_SPACE();
6380             while (hardcount < max && scan < loceol &&
6381                    (*scan == ' ' ||
6382                     swash_fetch(PL_utf8_space,(U8*)scan, utf8_target)))
6383             {
6384                 scan += UTF8SKIP(scan);
6385                 hardcount++;
6386             }
6387             break;
6388         }
6389         else {
6390             while (scan < loceol && isSPACE_L1((U8) *scan)) {
6391                 scan++;
6392             }
6393             break;
6394         }
6395     case SPACE:
6396         if (utf8_target)
6397             goto utf8_space;
6398
6399         while (scan < loceol && isSPACE((U8) *scan)) {
6400             scan++;
6401         }
6402         break;
6403     case SPACEA:
6404         while (scan < loceol && isSPACE_A((U8) *scan)) {
6405             scan++;
6406         }
6407         break;
6408     case SPACEL:
6409         PL_reg_flags |= RF_tainted;
6410         if (utf8_target) {
6411             loceol = PL_regeol;
6412             while (hardcount < max && scan < loceol &&
6413                    isSPACE_LC_utf8((U8*)scan)) {
6414                 scan += UTF8SKIP(scan);
6415                 hardcount++;
6416             }
6417         } else {
6418             while (scan < loceol && isSPACE_LC(*scan))
6419                 scan++;
6420         }
6421         break;
6422     case NSPACEU:
6423         if (utf8_target) {
6424
6425     utf8_Nspace:
6426
6427             loceol = PL_regeol;
6428             LOAD_UTF8_CHARCLASS_SPACE();
6429             while (hardcount < max && scan < loceol &&
6430                    ! (*scan == ' ' ||
6431                       swash_fetch(PL_utf8_space,(U8*)scan, utf8_target)))
6432             {
6433                 scan += UTF8SKIP(scan);
6434                 hardcount++;
6435             }
6436             break;
6437         }
6438         else {
6439             while (scan < loceol && ! isSPACE_L1((U8) *scan)) {
6440                 scan++;
6441             }
6442         }
6443         break;
6444     case NSPACE:
6445         if (utf8_target)
6446             goto utf8_Nspace;
6447
6448         while (scan < loceol && ! isSPACE((U8) *scan)) {
6449             scan++;
6450         }
6451         break;
6452     case NSPACEA:
6453         if (utf8_target) {
6454             while (scan < loceol && ! isSPACE_A((U8) *scan)) {
6455                 scan += UTF8SKIP(scan);
6456             }
6457         }
6458         else {
6459             while (scan < loceol && ! isSPACE_A((U8) *scan)) {
6460                 scan++;
6461             }
6462         }
6463         break;
6464     case NSPACEL:
6465         PL_reg_flags |= RF_tainted;
6466         if (utf8_target) {
6467             loceol = PL_regeol;
6468             while (hardcount < max && scan < loceol &&
6469                    !isSPACE_LC_utf8((U8*)scan)) {
6470                 scan += UTF8SKIP(scan);
6471                 hardcount++;
6472             }
6473         } else {
6474             while (scan < loceol && !isSPACE_LC(*scan))
6475                 scan++;
6476         }
6477         break;
6478     case DIGIT:
6479         if (utf8_target) {
6480             loceol = PL_regeol;
6481             LOAD_UTF8_CHARCLASS_DIGIT();
6482             while (hardcount < max && scan < loceol &&
6483                    swash_fetch(PL_utf8_digit, (U8*)scan, utf8_target)) {
6484                 scan += UTF8SKIP(scan);
6485                 hardcount++;
6486             }
6487         } else {
6488             while (scan < loceol && isDIGIT(*scan))
6489                 scan++;
6490         }
6491         break;
6492     case DIGITA:
6493         while (scan < loceol && isDIGIT_A((U8) *scan)) {
6494             scan++;
6495         }
6496         break;
6497     case DIGITL:
6498         PL_reg_flags |= RF_tainted;
6499         if (utf8_target) {
6500             loceol = PL_regeol;
6501             while (hardcount < max && scan < loceol &&
6502                    isDIGIT_LC_utf8((U8*)scan)) {
6503                 scan += UTF8SKIP(scan);
6504                 hardcount++;
6505             }
6506         } else {
6507             while (scan < loceol && isDIGIT_LC(*scan))
6508                 scan++;
6509         }
6510         break;
6511     case NDIGIT:
6512         if (utf8_target) {
6513             loceol = PL_regeol;
6514             LOAD_UTF8_CHARCLASS_DIGIT();
6515             while (hardcount < max && scan < loceol &&
6516                    !swash_fetch(PL_utf8_digit, (U8*)scan, utf8_target)) {
6517                 scan += UTF8SKIP(scan);
6518                 hardcount++;
6519             }
6520         } else {
6521             while (scan < loceol && !isDIGIT(*scan))
6522                 scan++;
6523         }
6524         break;
6525     case NDIGITA:
6526         if (utf8_target) {
6527             while (scan < loceol && ! isDIGIT_A((U8) *scan)) {
6528                 scan += UTF8SKIP(scan);
6529             }
6530         }
6531         else {
6532             while (scan < loceol && ! isDIGIT_A((U8) *scan)) {
6533                 scan++;
6534             }
6535         }
6536         break;
6537     case NDIGITL:
6538         PL_reg_flags |= RF_tainted;
6539         if (utf8_target) {
6540             loceol = PL_regeol;
6541             while (hardcount < max && scan < loceol &&
6542                    !isDIGIT_LC_utf8((U8*)scan)) {
6543                 scan += UTF8SKIP(scan);
6544                 hardcount++;
6545             }
6546         } else {
6547             while (scan < loceol && !isDIGIT_LC(*scan))
6548                 scan++;
6549         }
6550         break;
6551     case LNBREAK:
6552         if (utf8_target) {
6553             loceol = PL_regeol;
6554             while (hardcount < max && scan < loceol && (c=is_LNBREAK_utf8(scan))) {
6555                 scan += c;
6556                 hardcount++;
6557             }
6558         } else {
6559             /*
6560               LNBREAK can match two latin chars, which is ok,
6561               because we have a null terminated string, but we
6562               have to use hardcount in this situation
6563             */
6564             while (scan < loceol && (c=is_LNBREAK_latin1(scan)))  {
6565                 scan+=c;
6566                 hardcount++;
6567             }
6568         }
6569         break;
6570     case HORIZWS:
6571         if (utf8_target) {
6572             loceol = PL_regeol;
6573             while (hardcount < max && scan < loceol && (c=is_HORIZWS_utf8(scan))) {
6574                 scan += c;
6575                 hardcount++;
6576             }
6577         } else {
6578             while (scan < loceol && is_HORIZWS_latin1(scan))
6579                 scan++;
6580         }
6581         break;
6582     case NHORIZWS:
6583         if (utf8_target) {
6584             loceol = PL_regeol;
6585             while (hardcount < max && scan < loceol && !is_HORIZWS_utf8(scan)) {
6586                 scan += UTF8SKIP(scan);
6587                 hardcount++;
6588             }
6589         } else {
6590             while (scan < loceol && !is_HORIZWS_latin1(scan))
6591                 scan++;
6592
6593         }
6594         break;
6595     case VERTWS:
6596         if (utf8_target) {
6597             loceol = PL_regeol;
6598             while (hardcount < max && scan < loceol && (c=is_VERTWS_utf8(scan))) {
6599                 scan += c;
6600                 hardcount++;
6601             }
6602         } else {
6603             while (scan < loceol && is_VERTWS_latin1(scan))
6604                 scan++;
6605
6606         }
6607         break;
6608     case NVERTWS:
6609         if (utf8_target) {
6610             loceol = PL_regeol;
6611             while (hardcount < max && scan < loceol && !is_VERTWS_utf8(scan)) {
6612                 scan += UTF8SKIP(scan);
6613                 hardcount++;
6614             }
6615         } else {
6616             while (scan < loceol && !is_VERTWS_latin1(scan))
6617                 scan++;
6618
6619         }
6620         break;
6621
6622     default:            /* Called on something of 0 width. */
6623         break;          /* So match right here or not at all. */
6624     }
6625
6626     if (hardcount)
6627         c = hardcount;
6628     else
6629         c = scan - PL_reginput;
6630     PL_reginput = scan;
6631
6632     DEBUG_r({
6633         GET_RE_DEBUG_FLAGS_DECL;
6634         DEBUG_EXECUTE_r({
6635             SV * const prop = sv_newmortal();
6636             regprop(prog, prop, p);
6637             PerlIO_printf(Perl_debug_log,
6638                         "%*s  %s can match %"IVdf" times out of %"IVdf"...\n",
6639                         REPORT_CODE_OFF + depth*2, "", SvPVX_const(prop),(IV)c,(IV)max);
6640         });
6641     });
6642
6643     return(c);
6644 }
6645
6646
6647 #if !defined(PERL_IN_XSUB_RE) || defined(PLUGGABLE_RE_EXTENSION)
6648 /*
6649 - regclass_swash - prepare the utf8 swash.  Wraps the shared core version to
6650 create a copy so that changes the caller makes won't change the shared one
6651  */
6652 SV *
6653 Perl_regclass_swash(pTHX_ const regexp *prog, register const regnode* node, bool doinit, SV** listsvp, SV **altsvp)
6654 {
6655     PERL_ARGS_ASSERT_REGCLASS_SWASH;
6656     return newSVsv(core_regclass_swash(prog, node, doinit, listsvp, altsvp));
6657 }
6658 #endif
6659
6660 STATIC SV *
6661 S_core_regclass_swash(pTHX_ const regexp *prog, register const regnode* node, bool doinit, SV** listsvp, SV **altsvp)
6662 {
6663     /* Returns the swash for the input 'node' in the regex 'prog'.
6664      * If <doinit> is true, will attempt to create the swash if not already
6665      *    done.
6666      * If <listsvp> is non-null, will return the swash initialization string in
6667      *    it.
6668      * If <altsvp> is non-null, will return the alternates to the regular swash
6669      *    in it
6670      * Tied intimately to how regcomp.c sets up the data structure */
6671
6672     dVAR;
6673     SV *sw  = NULL;
6674     SV *si  = NULL;
6675     SV *alt = NULL;
6676     SV*  invlist = NULL;
6677
6678     RXi_GET_DECL(prog,progi);
6679     const struct reg_data * const data = prog ? progi->data : NULL;
6680
6681     PERL_ARGS_ASSERT_CORE_REGCLASS_SWASH;
6682
6683     assert(ANYOF_NONBITMAP(node));
6684
6685     if (data && data->count) {
6686         const U32 n = ARG(node);
6687
6688         if (data->what[n] == 's') {
6689             SV * const rv = MUTABLE_SV(data->data[n]);
6690             AV * const av = MUTABLE_AV(SvRV(rv));
6691             SV **const ary = AvARRAY(av);
6692             U8 swash_init_flags = 0;
6693
6694             si = *ary;  /* ary[0] = the string to initialize the swash with */
6695
6696             /* Elements 3 and 4 are either both present or both absent. [3] is
6697              * any inversion list generated at compile time; [4] indicates if
6698              * that inversion list has any user-defined properties in it. */
6699             if (av_len(av) >= 3) {
6700                 invlist = ary[3];
6701                 if (SvUV(ary[4])) {
6702                     swash_init_flags |= _CORE_SWASH_INIT_USER_DEFINED_PROPERTY;
6703                 }
6704             }
6705             else {
6706                 invlist = NULL;
6707             }
6708
6709             /* Element [1] is reserved for the set-up swash.  If already there,
6710              * return it; if not, create it and store it there */
6711             if (SvROK(ary[1])) {
6712                 sw = ary[1];
6713             }
6714             else if (si && doinit) {
6715
6716                 sw = _core_swash_init("utf8", /* the utf8 package */
6717                                       "", /* nameless */
6718                                       si,
6719                                       1, /* binary */
6720                                       0, /* not from tr/// */
6721                                       invlist,
6722                                       &swash_init_flags);
6723                 (void)av_store(av, 1, sw);
6724             }
6725
6726             /* Element [2] is for any multi-char folds.  Note that is a
6727              * fundamentally flawed design, because can't backtrack and try
6728              * again.  See [perl #89774] */
6729             if (SvTYPE(ary[2]) == SVt_PVAV) {
6730                 alt = ary[2];
6731             }
6732         }
6733     }
6734
6735     if (listsvp) {
6736         SV* matches_string = newSVpvn("", 0);
6737
6738         /* Use the swash, if any, which has to have incorporated into it all
6739          * possibilities */
6740         if ((! sw || (invlist = _get_swash_invlist(sw)) == NULL)
6741             && (si && si != &PL_sv_undef))
6742         {
6743
6744             /* If no swash, use the input initialization string, if available */
6745             sv_catsv(matches_string, si);
6746         }
6747
6748         /* Add the inversion list to whatever we have.  This may have come from
6749          * the swash, or from an input parameter */
6750         if (invlist) {
6751             sv_catsv(matches_string, _invlist_contents(invlist));
6752         }
6753         *listsvp = matches_string;
6754     }
6755
6756     if (altsvp)
6757         *altsvp  = alt;
6758
6759     return sw;
6760 }
6761
6762 /*
6763  - reginclass - determine if a character falls into a character class
6764
6765   n is the ANYOF regnode
6766   p is the target string
6767   lenp is pointer to the maximum number of bytes of how far to go in p
6768     (This is assumed wthout checking to always be at least the current
6769     character's size)
6770   utf8_target tells whether p is in UTF-8.
6771
6772   Returns true if matched; false otherwise.  If lenp is not NULL, on return
6773   from a successful match, the value it points to will be updated to how many
6774   bytes in p were matched.  If there was no match, the value is undefined,
6775   possibly changed from the input.
6776
6777   Note that this can be a synthetic start class, a combination of various
6778   nodes, so things you think might be mutually exclusive, such as locale,
6779   aren't.  It can match both locale and non-locale
6780
6781  */
6782
6783 STATIC bool
6784 S_reginclass(pTHX_ const regexp * const prog, register const regnode * const n, register const U8* const p, STRLEN* lenp, register const bool utf8_target)
6785 {
6786     dVAR;
6787     const char flags = ANYOF_FLAGS(n);
6788     bool match = FALSE;
6789     UV c = *p;
6790     STRLEN c_len = 0;
6791     STRLEN maxlen;
6792
6793     PERL_ARGS_ASSERT_REGINCLASS;
6794
6795     /* If c is not already the code point, get it */
6796     if (utf8_target && !UTF8_IS_INVARIANT(c)) {
6797         c = utf8n_to_uvchr(p, UTF8_MAXBYTES, &c_len,
6798                 (UTF8_ALLOW_DEFAULT & UTF8_ALLOW_ANYUV)
6799                 | UTF8_ALLOW_FFFF | UTF8_CHECK_ONLY);
6800                 /* see [perl #37836] for UTF8_ALLOW_ANYUV; [perl #38293] for
6801                  * UTF8_ALLOW_FFFF */
6802         if (c_len == (STRLEN)-1)
6803             Perl_croak(aTHX_ "Malformed UTF-8 character (fatal)");
6804     }
6805     else {
6806         c_len = 1;
6807     }
6808
6809     /* Use passed in max length, or one character if none passed in or less
6810      * than one character.  And assume will match just one character.  This is
6811      * overwritten later if matched more. */
6812     if (lenp) {
6813         maxlen = (*lenp > c_len) ? *lenp : c_len;
6814         *lenp = c_len;
6815
6816     }
6817     else {
6818         maxlen = c_len;
6819     }
6820
6821     /* If this character is potentially in the bitmap, check it */
6822     if (c < 256) {
6823         if (ANYOF_BITMAP_TEST(n, c))
6824             match = TRUE;
6825         else if (flags & ANYOF_NON_UTF8_LATIN1_ALL
6826                 && ! utf8_target
6827                 && ! isASCII(c))
6828         {
6829             match = TRUE;
6830         }
6831
6832         else if (flags & ANYOF_LOCALE) {
6833             PL_reg_flags |= RF_tainted;
6834
6835             if ((flags & ANYOF_LOC_NONBITMAP_FOLD)
6836                  && ANYOF_BITMAP_TEST(n, PL_fold_locale[c]))
6837             {
6838                 match = TRUE;
6839             }
6840             else if (ANYOF_CLASS_TEST_ANY_SET(n) &&
6841                      ((ANYOF_CLASS_TEST(n, ANYOF_ALNUM)   &&  isALNUM_LC(c))  ||
6842                       (ANYOF_CLASS_TEST(n, ANYOF_NALNUM)  && !isALNUM_LC(c))  ||
6843                       (ANYOF_CLASS_TEST(n, ANYOF_SPACE)   &&  isSPACE_LC(c))  ||
6844                       (ANYOF_CLASS_TEST(n, ANYOF_NSPACE)  && !isSPACE_LC(c))  ||
6845                       (ANYOF_CLASS_TEST(n, ANYOF_DIGIT)   &&  isDIGIT_LC(c))  ||
6846                       (ANYOF_CLASS_TEST(n, ANYOF_NDIGIT)  && !isDIGIT_LC(c))  ||
6847                       (ANYOF_CLASS_TEST(n, ANYOF_ALNUMC)  &&  isALNUMC_LC(c)) ||
6848                       (ANYOF_CLASS_TEST(n, ANYOF_NALNUMC) && !isALNUMC_LC(c)) ||
6849                       (ANYOF_CLASS_TEST(n, ANYOF_ALPHA)   &&  isALPHA_LC(c))  ||
6850                       (ANYOF_CLASS_TEST(n, ANYOF_NALPHA)  && !isALPHA_LC(c))  ||
6851                       (ANYOF_CLASS_TEST(n, ANYOF_ASCII)   &&  isASCII_LC(c))  ||
6852                       (ANYOF_CLASS_TEST(n, ANYOF_NASCII)  && !isASCII_LC(c))  ||
6853                       (ANYOF_CLASS_TEST(n, ANYOF_CNTRL)   &&  isCNTRL_LC(c))  ||
6854                       (ANYOF_CLASS_TEST(n, ANYOF_NCNTRL)  && !isCNTRL_LC(c))  ||
6855                       (ANYOF_CLASS_TEST(n, ANYOF_GRAPH)   &&  isGRAPH_LC(c))  ||
6856                       (ANYOF_CLASS_TEST(n, ANYOF_NGRAPH)  && !isGRAPH_LC(c))  ||
6857                       (ANYOF_CLASS_TEST(n, ANYOF_LOWER)   &&  isLOWER_LC(c))  ||
6858                       (ANYOF_CLASS_TEST(n, ANYOF_NLOWER)  && !isLOWER_LC(c))  ||
6859                       (ANYOF_CLASS_TEST(n, ANYOF_PRINT)   &&  isPRINT_LC(c))  ||
6860                       (ANYOF_CLASS_TEST(n, ANYOF_NPRINT)  && !isPRINT_LC(c))  ||
6861                       (ANYOF_CLASS_TEST(n, ANYOF_PUNCT)   &&  isPUNCT_LC(c))  ||
6862                       (ANYOF_CLASS_TEST(n, ANYOF_NPUNCT)  && !isPUNCT_LC(c))  ||
6863                       (ANYOF_CLASS_TEST(n, ANYOF_UPPER)   &&  isUPPER_LC(c))  ||
6864                       (ANYOF_CLASS_TEST(n, ANYOF_NUPPER)  && !isUPPER_LC(c))  ||
6865                       (ANYOF_CLASS_TEST(n, ANYOF_XDIGIT)  &&  isXDIGIT(c))    ||
6866                       (ANYOF_CLASS_TEST(n, ANYOF_NXDIGIT) && !isXDIGIT(c))    ||
6867                       (ANYOF_CLASS_TEST(n, ANYOF_PSXSPC)  &&  isPSXSPC(c))    ||
6868                       (ANYOF_CLASS_TEST(n, ANYOF_NPSXSPC) && !isPSXSPC(c))    ||
6869                       (ANYOF_CLASS_TEST(n, ANYOF_BLANK)   &&  isBLANK_LC(c))  ||
6870                       (ANYOF_CLASS_TEST(n, ANYOF_NBLANK)  && !isBLANK_LC(c))
6871                      ) /* How's that for a conditional? */
6872             ) {
6873                 match = TRUE;
6874             }
6875         }
6876     }
6877
6878     /* If the bitmap didn't (or couldn't) match, and something outside the
6879      * bitmap could match, try that.  Locale nodes specifiy completely the
6880      * behavior of code points in the bit map (otherwise, a utf8 target would
6881      * cause them to be treated as Unicode and not locale), except in
6882      * the very unlikely event when this node is a synthetic start class, which
6883      * could be a combination of locale and non-locale nodes.  So allow locale
6884      * to match for the synthetic start class, which will give a false
6885      * positive that will be resolved when the match is done again as not part
6886      * of the synthetic start class */
6887     if (!match) {
6888         if (utf8_target && (flags & ANYOF_UNICODE_ALL) && c >= 256) {
6889             match = TRUE;       /* Everything above 255 matches */
6890         }
6891         else if (ANYOF_NONBITMAP(n)
6892                  && ((flags & ANYOF_NONBITMAP_NON_UTF8)
6893                      || (utf8_target
6894                          && (c >=256
6895                              || (! (flags & ANYOF_LOCALE))
6896                              || (flags & ANYOF_IS_SYNTHETIC)))))
6897         {
6898             AV *av;
6899             SV * const sw = core_regclass_swash(prog, n, TRUE, 0, (SV**)&av);
6900
6901             if (sw) {
6902                 U8 * utf8_p;
6903                 if (utf8_target) {
6904                     utf8_p = (U8 *) p;
6905                 } else {
6906
6907                     /* Not utf8.  Convert as much of the string as available up
6908                      * to the limit of how far the (single) character in the
6909                      * pattern can possibly match (no need to go further).  If
6910                      * the node is a straight ANYOF or not folding, it can't
6911                      * match more than one.  Otherwise, It can match up to how
6912                      * far a single char can fold to.  Since not utf8, each
6913                      * character is a single byte, so the max it can be in
6914                      * bytes is the same as the max it can be in characters */
6915                     STRLEN len = (OP(n) == ANYOF
6916                                   || ! (flags & ANYOF_LOC_NONBITMAP_FOLD))
6917                                   ? 1
6918                                   : (maxlen < UTF8_MAX_FOLD_CHAR_EXPAND)
6919                                     ? maxlen
6920                                     : UTF8_MAX_FOLD_CHAR_EXPAND;
6921                     utf8_p = bytes_to_utf8(p, &len);
6922                 }
6923
6924                 if (swash_fetch(sw, utf8_p, TRUE))
6925                     match = TRUE;
6926                 else if (flags & ANYOF_LOC_NONBITMAP_FOLD) {
6927
6928                     /* Here, we need to test if the fold of the target string
6929                      * matches.  The non-multi char folds have all been moved to
6930                      * the compilation phase, and the multi-char folds have
6931                      * been stored by regcomp into 'av'; we linearly check to
6932                      * see if any match the target string (folded).   We know
6933                      * that the originals were each one character, but we don't
6934                      * currently know how many characters/bytes each folded to,
6935                      * except we do know that there are small limits imposed by
6936                      * Unicode.  XXX A performance enhancement would be to have
6937                      * regcomp.c store the max number of chars/bytes that are
6938                      * in an av entry, as, say the 0th element.  Even better
6939                      * would be to have a hash of the few characters that can
6940                      * start a multi-char fold to the max number of chars of
6941                      * those folds.
6942                      *
6943                      * If there is a match, we will need to advance (if lenp is
6944                      * specified) the match pointer in the target string.  But
6945                      * what we are comparing here isn't that string directly,
6946                      * but its fold, whose length may differ from the original.
6947                      * As we go along in constructing the fold, therefore, we
6948                      * create a map so that we know how many bytes in the
6949                      * source to advance given that we have matched a certain
6950                      * number of bytes in the fold.  This map is stored in
6951                      * 'map_fold_len_back'.  Let n mean the number of bytes in
6952                      * the fold of the first character that we are folding.
6953                      * Then map_fold_len_back[n] is set to the number of bytes
6954                      * in that first character.  Similarly let m be the
6955                      * corresponding number for the second character to be
6956                      * folded.  Then map_fold_len_back[n+m] is set to the
6957                      * number of bytes occupied by the first two source
6958                      * characters. ... */
6959                     U8 map_fold_len_back[UTF8_MAXBYTES_CASE+1] = { 0 };
6960                     U8 folded[UTF8_MAXBYTES_CASE+1];
6961                     STRLEN foldlen = 0; /* num bytes in fold of 1st char */
6962                     STRLEN total_foldlen = 0; /* num bytes in fold of all
6963                                                   chars */
6964
6965                     if (OP(n) == ANYOF || maxlen == 1 || ! lenp || ! av) {
6966
6967                         /* Here, only need to fold the first char of the target
6968                          * string.  It the source wasn't utf8, is 1 byte long */
6969                         to_utf8_fold(utf8_p, folded, &foldlen);
6970                         total_foldlen = foldlen;
6971                         map_fold_len_back[foldlen] = (utf8_target)
6972                                                      ? UTF8SKIP(utf8_p)
6973                                                      : 1;
6974                     }
6975                     else {
6976
6977                         /* Here, need to fold more than the first char.  Do so
6978                          * up to the limits */
6979                         U8* source_ptr = utf8_p;    /* The source for the fold
6980                                                        is the regex target
6981                                                        string */
6982                         U8* folded_ptr = folded;
6983                         U8* e = utf8_p + maxlen;    /* Can't go beyond last
6984                                                        available byte in the
6985                                                        target string */
6986                         U8 i;
6987                         for (i = 0;
6988                              i < UTF8_MAX_FOLD_CHAR_EXPAND && source_ptr < e;
6989                              i++)
6990                         {
6991
6992                             /* Fold the next character */
6993                             U8 this_char_folded[UTF8_MAXBYTES_CASE+1];
6994                             STRLEN this_char_foldlen;
6995                             to_utf8_fold(source_ptr,
6996                                          this_char_folded,
6997                                          &this_char_foldlen);
6998
6999                             /* Bail if it would exceed the byte limit for
7000                              * folding a single char. */
7001                             if (this_char_foldlen + folded_ptr - folded >
7002                                                             UTF8_MAXBYTES_CASE)
7003                             {
7004                                 break;
7005                             }
7006
7007                             /* Add the fold of this character */
7008                             Copy(this_char_folded,
7009                                  folded_ptr,
7010                                  this_char_foldlen,
7011                                  U8);
7012                             source_ptr += UTF8SKIP(source_ptr);
7013                             folded_ptr += this_char_foldlen;
7014                             total_foldlen = folded_ptr - folded;
7015
7016                             /* Create map from the number of bytes in the fold
7017                              * back to the number of bytes in the source.  If
7018                              * the source isn't utf8, the byte count is just
7019                              * the number of characters so far */
7020                             map_fold_len_back[total_foldlen]
7021                                                       = (utf8_target)
7022                                                         ? source_ptr - utf8_p
7023                                                         : i + 1;
7024                         }
7025                         *folded_ptr = '\0';
7026                     }
7027
7028
7029                     /* Do the linear search to see if the fold is in the list
7030                      * of multi-char folds. */
7031                     if (av) {
7032                         I32 i;
7033                         for (i = 0; i <= av_len(av); i++) {
7034                             SV* const sv = *av_fetch(av, i, FALSE);
7035                             STRLEN len;
7036                             const char * const s = SvPV_const(sv, len);
7037
7038                             if (len <= total_foldlen
7039                                 && memEQ(s, (char*)folded, len)
7040
7041                                    /* If 0, means matched a partial char. See
7042                                     * [perl #90536] */
7043                                 && map_fold_len_back[len])
7044                             {
7045
7046                                 /* Advance the target string ptr to account for
7047                                  * this fold, but have to translate from the
7048                                  * folded length to the corresponding source
7049                                  * length. */
7050                                 if (lenp) {
7051                                     *lenp = map_fold_len_back[len];
7052                                 }
7053                                 match = TRUE;
7054                                 break;
7055                             }
7056                         }
7057                     }
7058                 }
7059
7060                 /* If we allocated a string above, free it */
7061                 if (! utf8_target) Safefree(utf8_p);
7062             }
7063         }
7064
7065         if (UNICODE_IS_SUPER(c)
7066             && (flags & ANYOF_WARN_SUPER)
7067             && ckWARN_d(WARN_NON_UNICODE))
7068         {
7069             Perl_warner(aTHX_ packWARN(WARN_NON_UNICODE),
7070                 "Code point 0x%04"UVXf" is not Unicode, all \\p{} matches fail; all \\P{} matches succeed", c);
7071         }
7072     }
7073
7074     /* The xor complements the return if to invert: 1^1 = 0, 1^0 = 1 */
7075     return cBOOL(flags & ANYOF_INVERT) ^ match;
7076 }
7077
7078 STATIC U8 *
7079 S_reghop3(U8 *s, I32 off, const U8* lim)
7080 {
7081     /* return the position 'off' UTF-8 characters away from 's', forward if
7082      * 'off' >= 0, backwards if negative.  But don't go outside of position
7083      * 'lim', which better be < s  if off < 0 */
7084
7085     dVAR;
7086
7087     PERL_ARGS_ASSERT_REGHOP3;
7088
7089     if (off >= 0) {
7090         while (off-- && s < lim) {
7091             /* XXX could check well-formedness here */
7092             s += UTF8SKIP(s);
7093         }
7094     }
7095     else {
7096         while (off++ && s > lim) {
7097             s--;
7098             if (UTF8_IS_CONTINUED(*s)) {
7099                 while (s > lim && UTF8_IS_CONTINUATION(*s))
7100                     s--;
7101             }
7102             /* XXX could check well-formedness here */
7103         }
7104     }
7105     return s;
7106 }
7107
7108 #ifdef XXX_dmq
7109 /* there are a bunch of places where we use two reghop3's that should
7110    be replaced with this routine. but since thats not done yet
7111    we ifdef it out - dmq
7112 */
7113 STATIC U8 *
7114 S_reghop4(U8 *s, I32 off, const U8* llim, const U8* rlim)
7115 {
7116     dVAR;
7117
7118     PERL_ARGS_ASSERT_REGHOP4;
7119
7120     if (off >= 0) {
7121         while (off-- && s < rlim) {
7122             /* XXX could check well-formedness here */
7123             s += UTF8SKIP(s);
7124         }
7125     }
7126     else {
7127         while (off++ && s > llim) {
7128             s--;
7129             if (UTF8_IS_CONTINUED(*s)) {
7130                 while (s > llim && UTF8_IS_CONTINUATION(*s))
7131                     s--;
7132             }
7133             /* XXX could check well-formedness here */
7134         }
7135     }
7136     return s;
7137 }
7138 #endif
7139
7140 STATIC U8 *
7141 S_reghopmaybe3(U8* s, I32 off, const U8* lim)
7142 {
7143     dVAR;
7144
7145     PERL_ARGS_ASSERT_REGHOPMAYBE3;
7146
7147     if (off >= 0) {
7148         while (off-- && s < lim) {
7149             /* XXX could check well-formedness here */
7150             s += UTF8SKIP(s);
7151         }
7152         if (off >= 0)
7153             return NULL;
7154     }
7155     else {
7156         while (off++ && s > lim) {
7157             s--;
7158             if (UTF8_IS_CONTINUED(*s)) {
7159                 while (s > lim && UTF8_IS_CONTINUATION(*s))
7160                     s--;
7161             }
7162             /* XXX could check well-formedness here */
7163         }
7164         if (off <= 0)
7165             return NULL;
7166     }
7167     return s;
7168 }
7169
7170 static void
7171 restore_pos(pTHX_ void *arg)
7172 {
7173     dVAR;
7174     regexp * const rex = (regexp *)arg;
7175     if (PL_reg_state.re_state_eval_setup_done) {
7176         if (PL_reg_oldsaved) {
7177             rex->subbeg = PL_reg_oldsaved;
7178             rex->sublen = PL_reg_oldsavedlen;
7179 #ifdef PERL_OLD_COPY_ON_WRITE
7180             rex->saved_copy = PL_nrs;
7181 #endif
7182             RXp_MATCH_COPIED_on(rex);
7183         }
7184         PL_reg_magic->mg_len = PL_reg_oldpos;
7185         PL_reg_state.re_state_eval_setup_done = FALSE;
7186         PL_curpm = PL_reg_oldcurpm;
7187     }
7188 }
7189
7190 STATIC void
7191 S_to_utf8_substr(pTHX_ register regexp *prog)
7192 {
7193     int i = 1;
7194
7195     PERL_ARGS_ASSERT_TO_UTF8_SUBSTR;
7196
7197     do {
7198         if (prog->substrs->data[i].substr
7199             && !prog->substrs->data[i].utf8_substr) {
7200             SV* const sv = newSVsv(prog->substrs->data[i].substr);
7201             prog->substrs->data[i].utf8_substr = sv;
7202             sv_utf8_upgrade(sv);
7203             if (SvVALID(prog->substrs->data[i].substr)) {
7204                 if (SvTAIL(prog->substrs->data[i].substr)) {
7205                     /* Trim the trailing \n that fbm_compile added last
7206                        time.  */
7207                     SvCUR_set(sv, SvCUR(sv) - 1);
7208                     /* Whilst this makes the SV technically "invalid" (as its
7209                        buffer is no longer followed by "\0") when fbm_compile()
7210                        adds the "\n" back, a "\0" is restored.  */
7211                     fbm_compile(sv, FBMcf_TAIL);
7212                 } else
7213                     fbm_compile(sv, 0);
7214             }
7215             if (prog->substrs->data[i].substr == prog->check_substr)
7216                 prog->check_utf8 = sv;
7217         }
7218     } while (i--);
7219 }
7220
7221 STATIC void
7222 S_to_byte_substr(pTHX_ register regexp *prog)
7223 {
7224     dVAR;
7225     int i = 1;
7226
7227     PERL_ARGS_ASSERT_TO_BYTE_SUBSTR;
7228
7229     do {
7230         if (prog->substrs->data[i].utf8_substr
7231             && !prog->substrs->data[i].substr) {
7232             SV* sv = newSVsv(prog->substrs->data[i].utf8_substr);
7233             if (sv_utf8_downgrade(sv, TRUE)) {
7234                 if (SvVALID(prog->substrs->data[i].utf8_substr)) {
7235                     if (SvTAIL(prog->substrs->data[i].utf8_substr)) {
7236                         /* Trim the trailing \n that fbm_compile added last
7237                            time.  */
7238                         SvCUR_set(sv, SvCUR(sv) - 1);
7239                         fbm_compile(sv, FBMcf_TAIL);
7240                     } else
7241                         fbm_compile(sv, 0);
7242                 }
7243             } else {
7244                 SvREFCNT_dec(sv);
7245                 sv = &PL_sv_undef;
7246             }
7247             prog->substrs->data[i].substr = sv;
7248             if (prog->substrs->data[i].utf8_substr == prog->check_utf8)
7249                 prog->check_substr = sv;
7250         }
7251     } while (i--);
7252 }
7253
7254 /*
7255  * Local variables:
7256  * c-indentation-style: bsd
7257  * c-basic-offset: 4
7258  * indent-tabs-mode: nil
7259  * End:
7260  *
7261  * ex: set ts=8 sts=4 sw=4 et:
7262  */