t/io/eintr.t: Make this pass on my ppc64 box
[perl.git] / 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 #include "unicode_constants.h"
85
86 #ifdef DEBUGGING
87 /* At least one required character in the target string is expressible only in
88  * UTF-8. */
89 static const char* const non_utf8_target_but_utf8_required
90                 = "Can't match, because target string needs to be in UTF-8\n";
91 #endif
92
93 #define NON_UTF8_TARGET_BUT_UTF8_REQUIRED(target) STMT_START { \
94     DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "%s", non_utf8_target_but_utf8_required));\
95     goto target; \
96 } STMT_END
97
98 #define HAS_NONLATIN1_FOLD_CLOSURE(i) _HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(i)
99
100 #ifndef STATIC
101 #define STATIC  static
102 #endif
103
104 /* Valid only for non-utf8 strings: avoids the reginclass
105  * call if there are no complications: i.e., if everything matchable is
106  * straight forward in the bitmap */
107 #define REGINCLASS(prog,p,c)  (ANYOF_FLAGS(p) ? reginclass(prog,p,c,c+1,0)   \
108                                               : ANYOF_BITMAP_TEST(p,*(c)))
109
110 /*
111  * Forwards.
112  */
113
114 #define CHR_SVLEN(sv) (utf8_target ? sv_len_utf8(sv) : SvCUR(sv))
115 #define CHR_DIST(a,b) (reginfo->is_utf8_target ? utf8_distance(a,b) : a - b)
116
117 #define HOPc(pos,off) \
118         (char *)(reginfo->is_utf8_target \
119             ? reghop3((U8*)pos, off, \
120                     (U8*)(off >= 0 ? reginfo->strend : reginfo->strbeg)) \
121             : (U8*)(pos + off))
122
123 #define HOPBACKc(pos, off) \
124         (char*)(reginfo->is_utf8_target \
125             ? reghopmaybe3((U8*)pos, -off, (U8*)(reginfo->strbeg)) \
126             : (pos - off >= reginfo->strbeg)    \
127                 ? (U8*)pos - off                \
128                 : NULL)
129
130 #define HOP3(pos,off,lim) (reginfo->is_utf8_target  ? reghop3((U8*)(pos), off, (U8*)(lim)) : (U8*)(pos + off))
131 #define HOP3c(pos,off,lim) ((char*)HOP3(pos,off,lim))
132
133 /* lim must be +ve. Returns NULL on overshoot */
134 #define HOPMAYBE3(pos,off,lim) \
135         (reginfo->is_utf8_target                        \
136             ? reghopmaybe3((U8*)pos, off, (U8*)(lim))   \
137             : ((U8*)pos + off <= lim)                   \
138                 ? (U8*)pos + off                        \
139                 : NULL)
140
141 /* like HOP3, but limits the result to <= lim even for the non-utf8 case.
142  * off must be >=0; args should be vars rather than expressions */
143 #define HOP3lim(pos,off,lim) (reginfo->is_utf8_target \
144     ? reghop3((U8*)(pos), off, (U8*)(lim)) \
145     : (U8*)((pos + off) > lim ? lim : (pos + off)))
146
147 #define HOP4(pos,off,llim, rlim) (reginfo->is_utf8_target \
148     ? reghop4((U8*)(pos), off, (U8*)(llim), (U8*)(rlim)) \
149     : (U8*)(pos + off))
150 #define HOP4c(pos,off,llim, rlim) ((char*)HOP4(pos,off,llim, rlim))
151
152 #define NEXTCHR_EOS -10 /* nextchr has fallen off the end */
153 #define NEXTCHR_IS_EOS (nextchr < 0)
154
155 #define SET_nextchr \
156     nextchr = ((locinput < reginfo->strend) ? UCHARAT(locinput) : NEXTCHR_EOS)
157
158 #define SET_locinput(p) \
159     locinput = (p);  \
160     SET_nextchr
161
162
163 #define LOAD_UTF8_CHARCLASS(swash_ptr, property_name, invlist) STMT_START {   \
164         if (!swash_ptr) {                                                     \
165             U8 flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;                       \
166             swash_ptr = _core_swash_init("utf8", property_name, &PL_sv_undef, \
167                                          1, 0, invlist, &flags);              \
168             assert(swash_ptr);                                                \
169         }                                                                     \
170     } STMT_END
171
172 /* If in debug mode, we test that a known character properly matches */
173 #ifdef DEBUGGING
174 #   define LOAD_UTF8_CHARCLASS_DEBUG_TEST(swash_ptr,                          \
175                                           property_name,                      \
176                                           invlist,                            \
177                                           utf8_char_in_property)              \
178         LOAD_UTF8_CHARCLASS(swash_ptr, property_name, invlist);               \
179         assert(swash_fetch(swash_ptr, (U8 *) utf8_char_in_property, TRUE));
180 #else
181 #   define LOAD_UTF8_CHARCLASS_DEBUG_TEST(swash_ptr,                          \
182                                           property_name,                      \
183                                           invlist,                            \
184                                           utf8_char_in_property)              \
185         LOAD_UTF8_CHARCLASS(swash_ptr, property_name, invlist)
186 #endif
187
188 #define LOAD_UTF8_CHARCLASS_ALNUM() LOAD_UTF8_CHARCLASS_DEBUG_TEST(           \
189                                         PL_utf8_swash_ptrs[_CC_WORDCHAR],     \
190                                         "",                                   \
191                                         PL_XPosix_ptrs[_CC_WORDCHAR],         \
192                                         LATIN_CAPITAL_LETTER_SHARP_S_UTF8);
193
194 #define LOAD_UTF8_CHARCLASS_GCB()  /* Grapheme cluster boundaries */          \
195     STMT_START {                                                              \
196         LOAD_UTF8_CHARCLASS_DEBUG_TEST(PL_utf8_X_regular_begin,               \
197                                        "_X_regular_begin",                    \
198                                        NULL,                                  \
199                                        LATIN_CAPITAL_LETTER_SHARP_S_UTF8);    \
200         LOAD_UTF8_CHARCLASS_DEBUG_TEST(PL_utf8_X_extend,                      \
201                                        "_X_extend",                           \
202                                        NULL,                                  \
203                                        COMBINING_GRAVE_ACCENT_UTF8);          \
204     } STMT_END
205
206 #define PLACEHOLDER     /* Something for the preprocessor to grab onto */
207 /* TODO: Combine JUMPABLE and HAS_TEXT to cache OP(rn) */
208
209 /* for use after a quantifier and before an EXACT-like node -- japhy */
210 /* it would be nice to rework regcomp.sym to generate this stuff. sigh
211  *
212  * NOTE that *nothing* that affects backtracking should be in here, specifically
213  * VERBS must NOT be included. JUMPABLE is used to determine  if we can ignore a
214  * node that is in between two EXACT like nodes when ascertaining what the required
215  * "follow" character is. This should probably be moved to regex compile time
216  * although it may be done at run time beause of the REF possibility - more
217  * investigation required. -- demerphq
218 */
219 #define JUMPABLE(rn) (                                                             \
220     OP(rn) == OPEN ||                                                              \
221     (OP(rn) == CLOSE && (!cur_eval || cur_eval->u.eval.close_paren != ARG(rn))) || \
222     OP(rn) == EVAL ||                                                              \
223     OP(rn) == SUSPEND || OP(rn) == IFMATCH ||                                      \
224     OP(rn) == PLUS || OP(rn) == MINMOD ||                                          \
225     OP(rn) == KEEPS ||                                                             \
226     (PL_regkind[OP(rn)] == CURLY && ARG1(rn) > 0)                                  \
227 )
228 #define IS_EXACT(rn) (PL_regkind[OP(rn)] == EXACT)
229
230 #define HAS_TEXT(rn) ( IS_EXACT(rn) || PL_regkind[OP(rn)] == REF )
231
232 #if 0 
233 /* Currently these are only used when PL_regkind[OP(rn)] == EXACT so
234    we don't need this definition. */
235 #define IS_TEXT(rn)   ( OP(rn)==EXACT   || OP(rn)==REF   || OP(rn)==NREF   )
236 #define IS_TEXTF(rn)  ( OP(rn)==EXACTFU || OP(rn)==EXACTFU_SS || OP(rn)==EXACTFA || OP(rn)==EXACTFA_NO_TRIE || OP(rn)==EXACTF || OP(rn)==REFF  || OP(rn)==NREFF )
237 #define IS_TEXTFL(rn) ( OP(rn)==EXACTFL || OP(rn)==REFFL || OP(rn)==NREFFL )
238
239 #else
240 /* ... so we use this as its faster. */
241 #define IS_TEXT(rn)   ( OP(rn)==EXACT   )
242 #define IS_TEXTFU(rn)  ( OP(rn)==EXACTFU || OP(rn)==EXACTFU_SS || OP(rn) == EXACTFA || OP(rn) == EXACTFA_NO_TRIE)
243 #define IS_TEXTF(rn)  ( OP(rn)==EXACTF  )
244 #define IS_TEXTFL(rn) ( OP(rn)==EXACTFL )
245
246 #endif
247
248 /*
249   Search for mandatory following text node; for lookahead, the text must
250   follow but for lookbehind (rn->flags != 0) we skip to the next step.
251 */
252 #define FIND_NEXT_IMPT(rn) STMT_START {                                   \
253     while (JUMPABLE(rn)) { \
254         const OPCODE type = OP(rn); \
255         if (type == SUSPEND || PL_regkind[type] == CURLY) \
256             rn = NEXTOPER(NEXTOPER(rn)); \
257         else if (type == PLUS) \
258             rn = NEXTOPER(rn); \
259         else if (type == IFMATCH) \
260             rn = (rn->flags == 0) ? NEXTOPER(NEXTOPER(rn)) : rn + ARG(rn); \
261         else rn += NEXT_OFF(rn); \
262     } \
263 } STMT_END 
264
265 /* These constants are for finding GCB=LV and GCB=LVT in the CLUMP regnode.
266  * These are for the pre-composed Hangul syllables, which are all in a
267  * contiguous block and arranged there in such a way so as to facilitate
268  * alorithmic determination of their characteristics.  As such, they don't need
269  * a swash, but can be determined by simple arithmetic.  Almost all are
270  * GCB=LVT, but every 28th one is a GCB=LV */
271 #define SBASE 0xAC00    /* Start of block */
272 #define SCount 11172    /* Length of block */
273 #define TCount 28
274
275 #define SLAB_FIRST(s) (&(s)->states[0])
276 #define SLAB_LAST(s)  (&(s)->states[PERL_REGMATCH_SLAB_SLOTS-1])
277
278 static void S_setup_eval_state(pTHX_ regmatch_info *const reginfo);
279 static void S_cleanup_regmatch_info_aux(pTHX_ void *arg);
280 static regmatch_state * S_push_slab(pTHX);
281
282 #define REGCP_PAREN_ELEMS 3
283 #define REGCP_OTHER_ELEMS 3
284 #define REGCP_FRAME_ELEMS 1
285 /* REGCP_FRAME_ELEMS are not part of the REGCP_OTHER_ELEMS and
286  * are needed for the regexp context stack bookkeeping. */
287
288 STATIC CHECKPOINT
289 S_regcppush(pTHX_ const regexp *rex, I32 parenfloor, U32 maxopenparen)
290 {
291     const int retval = PL_savestack_ix;
292     const int paren_elems_to_push =
293                 (maxopenparen - parenfloor) * REGCP_PAREN_ELEMS;
294     const UV total_elems = paren_elems_to_push + REGCP_OTHER_ELEMS;
295     const UV elems_shifted = total_elems << SAVE_TIGHT_SHIFT;
296     I32 p;
297     GET_RE_DEBUG_FLAGS_DECL;
298
299     PERL_ARGS_ASSERT_REGCPPUSH;
300
301     if (paren_elems_to_push < 0)
302         Perl_croak(aTHX_ "panic: paren_elems_to_push, %i < 0, maxopenparen: %i parenfloor: %i REGCP_PAREN_ELEMS: %u",
303                    (int)paren_elems_to_push, (int)maxopenparen,
304                    (int)parenfloor, (unsigned)REGCP_PAREN_ELEMS);
305
306     if ((elems_shifted >> SAVE_TIGHT_SHIFT) != total_elems)
307         Perl_croak(aTHX_ "panic: paren_elems_to_push offset %"UVuf
308                    " out of range (%lu-%ld)",
309                    total_elems,
310                    (unsigned long)maxopenparen,
311                    (long)parenfloor);
312
313     SSGROW(total_elems + REGCP_FRAME_ELEMS);
314     
315     DEBUG_BUFFERS_r(
316         if ((int)maxopenparen > (int)parenfloor)
317             PerlIO_printf(Perl_debug_log,
318                 "rex=0x%"UVxf" offs=0x%"UVxf": saving capture indices:\n",
319                 PTR2UV(rex),
320                 PTR2UV(rex->offs)
321             );
322     );
323     for (p = parenfloor+1; p <= (I32)maxopenparen;  p++) {
324 /* REGCP_PARENS_ELEMS are pushed per pairs of parentheses. */
325         SSPUSHIV(rex->offs[p].end);
326         SSPUSHIV(rex->offs[p].start);
327         SSPUSHINT(rex->offs[p].start_tmp);
328         DEBUG_BUFFERS_r(PerlIO_printf(Perl_debug_log,
329             "    \\%"UVuf": %"IVdf"(%"IVdf")..%"IVdf"\n",
330             (UV)p,
331             (IV)rex->offs[p].start,
332             (IV)rex->offs[p].start_tmp,
333             (IV)rex->offs[p].end
334         ));
335     }
336 /* REGCP_OTHER_ELEMS are pushed in any case, parentheses or no. */
337     SSPUSHINT(maxopenparen);
338     SSPUSHINT(rex->lastparen);
339     SSPUSHINT(rex->lastcloseparen);
340     SSPUSHUV(SAVEt_REGCONTEXT | elems_shifted); /* Magic cookie. */
341
342     return retval;
343 }
344
345 /* These are needed since we do not localize EVAL nodes: */
346 #define REGCP_SET(cp)                                           \
347     DEBUG_STATE_r(                                              \
348             PerlIO_printf(Perl_debug_log,                       \
349                 "  Setting an EVAL scope, savestack=%"IVdf"\n", \
350                 (IV)PL_savestack_ix));                          \
351     cp = PL_savestack_ix
352
353 #define REGCP_UNWIND(cp)                                        \
354     DEBUG_STATE_r(                                              \
355         if (cp != PL_savestack_ix)                              \
356             PerlIO_printf(Perl_debug_log,                       \
357                 "  Clearing an EVAL scope, savestack=%"IVdf"..%"IVdf"\n", \
358                 (IV)(cp), (IV)PL_savestack_ix));                \
359     regcpblow(cp)
360
361 #define UNWIND_PAREN(lp, lcp)               \
362     for (n = rex->lastparen; n > lp; n--)   \
363         rex->offs[n].end = -1;              \
364     rex->lastparen = n;                     \
365     rex->lastcloseparen = lcp;
366
367
368 STATIC void
369 S_regcppop(pTHX_ regexp *rex, U32 *maxopenparen_p)
370 {
371     UV i;
372     U32 paren;
373     GET_RE_DEBUG_FLAGS_DECL;
374
375     PERL_ARGS_ASSERT_REGCPPOP;
376
377     /* Pop REGCP_OTHER_ELEMS before the parentheses loop starts. */
378     i = SSPOPUV;
379     assert((i & SAVE_MASK) == SAVEt_REGCONTEXT); /* Check that the magic cookie is there. */
380     i >>= SAVE_TIGHT_SHIFT; /* Parentheses elements to pop. */
381     rex->lastcloseparen = SSPOPINT;
382     rex->lastparen = SSPOPINT;
383     *maxopenparen_p = SSPOPINT;
384
385     i -= REGCP_OTHER_ELEMS;
386     /* Now restore the parentheses context. */
387     DEBUG_BUFFERS_r(
388         if (i || rex->lastparen + 1 <= rex->nparens)
389             PerlIO_printf(Perl_debug_log,
390                 "rex=0x%"UVxf" offs=0x%"UVxf": restoring capture indices to:\n",
391                 PTR2UV(rex),
392                 PTR2UV(rex->offs)
393             );
394     );
395     paren = *maxopenparen_p;
396     for ( ; i > 0; i -= REGCP_PAREN_ELEMS) {
397         SSize_t tmps;
398         rex->offs[paren].start_tmp = SSPOPINT;
399         rex->offs[paren].start = SSPOPIV;
400         tmps = SSPOPIV;
401         if (paren <= rex->lastparen)
402             rex->offs[paren].end = tmps;
403         DEBUG_BUFFERS_r( PerlIO_printf(Perl_debug_log,
404             "    \\%"UVuf": %"IVdf"(%"IVdf")..%"IVdf"%s\n",
405             (UV)paren,
406             (IV)rex->offs[paren].start,
407             (IV)rex->offs[paren].start_tmp,
408             (IV)rex->offs[paren].end,
409             (paren > rex->lastparen ? "(skipped)" : ""));
410         );
411         paren--;
412     }
413 #if 1
414     /* It would seem that the similar code in regtry()
415      * already takes care of this, and in fact it is in
416      * a better location to since this code can #if 0-ed out
417      * but the code in regtry() is needed or otherwise tests
418      * requiring null fields (pat.t#187 and split.t#{13,14}
419      * (as of patchlevel 7877)  will fail.  Then again,
420      * this code seems to be necessary or otherwise
421      * this erroneously leaves $1 defined: "1" =~ /^(?:(\d)x)?\d$/
422      * --jhi updated by dapm */
423     for (i = rex->lastparen + 1; i <= rex->nparens; i++) {
424         if (i > *maxopenparen_p)
425             rex->offs[i].start = -1;
426         rex->offs[i].end = -1;
427         DEBUG_BUFFERS_r( PerlIO_printf(Perl_debug_log,
428             "    \\%"UVuf": %s   ..-1 undeffing\n",
429             (UV)i,
430             (i > *maxopenparen_p) ? "-1" : "  "
431         ));
432     }
433 #endif
434 }
435
436 /* restore the parens and associated vars at savestack position ix,
437  * but without popping the stack */
438
439 STATIC void
440 S_regcp_restore(pTHX_ regexp *rex, I32 ix, U32 *maxopenparen_p)
441 {
442     I32 tmpix = PL_savestack_ix;
443     PL_savestack_ix = ix;
444     regcppop(rex, maxopenparen_p);
445     PL_savestack_ix = tmpix;
446 }
447
448 #define regcpblow(cp) LEAVE_SCOPE(cp)   /* Ignores regcppush()ed data. */
449
450 STATIC bool
451 S_isFOO_lc(pTHX_ const U8 classnum, const U8 character)
452 {
453     /* Returns a boolean as to whether or not 'character' is a member of the
454      * Posix character class given by 'classnum' that should be equivalent to a
455      * value in the typedef '_char_class_number'.
456      *
457      * Ideally this could be replaced by a just an array of function pointers
458      * to the C library functions that implement the macros this calls.
459      * However, to compile, the precise function signatures are required, and
460      * these may vary from platform to to platform.  To avoid having to figure
461      * out what those all are on each platform, I (khw) am using this method,
462      * which adds an extra layer of function call overhead (unless the C
463      * optimizer strips it away).  But we don't particularly care about
464      * performance with locales anyway. */
465
466     switch ((_char_class_number) classnum) {
467         case _CC_ENUM_ALPHANUMERIC: return isALPHANUMERIC_LC(character);
468         case _CC_ENUM_ALPHA:     return isALPHA_LC(character);
469         case _CC_ENUM_ASCII:     return isASCII_LC(character);
470         case _CC_ENUM_BLANK:     return isBLANK_LC(character);
471         case _CC_ENUM_CASED:     return isLOWER_LC(character)
472                                         || isUPPER_LC(character);
473         case _CC_ENUM_CNTRL:     return isCNTRL_LC(character);
474         case _CC_ENUM_DIGIT:     return isDIGIT_LC(character);
475         case _CC_ENUM_GRAPH:     return isGRAPH_LC(character);
476         case _CC_ENUM_LOWER:     return isLOWER_LC(character);
477         case _CC_ENUM_PRINT:     return isPRINT_LC(character);
478         case _CC_ENUM_PSXSPC:    return isPSXSPC_LC(character);
479         case _CC_ENUM_PUNCT:     return isPUNCT_LC(character);
480         case _CC_ENUM_SPACE:     return isSPACE_LC(character);
481         case _CC_ENUM_UPPER:     return isUPPER_LC(character);
482         case _CC_ENUM_WORDCHAR:  return isWORDCHAR_LC(character);
483         case _CC_ENUM_XDIGIT:    return isXDIGIT_LC(character);
484         default:    /* VERTSPACE should never occur in locales */
485             Perl_croak(aTHX_ "panic: isFOO_lc() has an unexpected character class '%d'", classnum);
486     }
487
488     assert(0); /* NOTREACHED */
489     return FALSE;
490 }
491
492 STATIC bool
493 S_isFOO_utf8_lc(pTHX_ const U8 classnum, const U8* character)
494 {
495     /* Returns a boolean as to whether or not the (well-formed) UTF-8-encoded
496      * 'character' is a member of the Posix character class given by 'classnum'
497      * that should be equivalent to a value in the typedef
498      * '_char_class_number'.
499      *
500      * This just calls isFOO_lc on the code point for the character if it is in
501      * the range 0-255.  Outside that range, all characters avoid Unicode
502      * rules, ignoring any locale.  So use the Unicode function if this class
503      * requires a swash, and use the Unicode macro otherwise. */
504
505     PERL_ARGS_ASSERT_ISFOO_UTF8_LC;
506
507     if (UTF8_IS_INVARIANT(*character)) {
508         return isFOO_lc(classnum, *character);
509     }
510     else if (UTF8_IS_DOWNGRADEABLE_START(*character)) {
511         return isFOO_lc(classnum,
512                         TWO_BYTE_UTF8_TO_NATIVE(*character, *(character + 1)));
513     }
514
515     if (classnum < _FIRST_NON_SWASH_CC) {
516
517         /* Initialize the swash unless done already */
518         if (! PL_utf8_swash_ptrs[classnum]) {
519             U8 flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;
520             PL_utf8_swash_ptrs[classnum] =
521                     _core_swash_init("utf8",
522                                      "",
523                                      &PL_sv_undef, 1, 0,
524                                      PL_XPosix_ptrs[classnum], &flags);
525         }
526
527         return cBOOL(swash_fetch(PL_utf8_swash_ptrs[classnum], (U8 *)
528                                  character,
529                                  TRUE /* is UTF */ ));
530     }
531
532     switch ((_char_class_number) classnum) {
533         case _CC_ENUM_SPACE:
534         case _CC_ENUM_PSXSPC:    return is_XPERLSPACE_high(character);
535
536         case _CC_ENUM_BLANK:     return is_HORIZWS_high(character);
537         case _CC_ENUM_XDIGIT:    return is_XDIGIT_high(character);
538         case _CC_ENUM_VERTSPACE: return is_VERTWS_high(character);
539         default:                 break;
540     }
541
542     return FALSE; /* Things like CNTRL are always below 256 */
543 }
544
545 /*
546  * pregexec and friends
547  */
548
549 #ifndef PERL_IN_XSUB_RE
550 /*
551  - pregexec - match a regexp against a string
552  */
553 I32
554 Perl_pregexec(pTHX_ REGEXP * const prog, char* stringarg, char *strend,
555          char *strbeg, SSize_t minend, SV *screamer, U32 nosave)
556 /* stringarg: the point in the string at which to begin matching */
557 /* strend:    pointer to null at end of string */
558 /* strbeg:    real beginning of string */
559 /* minend:    end of match must be >= minend bytes after stringarg. */
560 /* screamer:  SV being matched: only used for utf8 flag, pos() etc; string
561  *            itself is accessed via the pointers above */
562 /* nosave:    For optimizations. */
563 {
564     PERL_ARGS_ASSERT_PREGEXEC;
565
566     return
567         regexec_flags(prog, stringarg, strend, strbeg, minend, screamer, NULL,
568                       nosave ? 0 : REXEC_COPY_STR);
569 }
570 #endif
571
572
573
574 /* re_intuit_start():
575  *
576  * Based on some optimiser hints, try to find the earliest position in the
577  * string where the regex could match.
578  *
579  *   rx:     the regex to match against
580  *   sv:     the SV being matched: only used for utf8 flag; the string
581  *           itself is accessed via the pointers below. Note that on
582  *           something like an overloaded SV, SvPOK(sv) may be false
583  *           and the string pointers may point to something unrelated to
584  *           the SV itself.
585  *   strbeg: real beginning of string
586  *   strpos: the point in the string at which to begin matching
587  *   strend: pointer to the byte following the last char of the string
588  *   flags   currently unused; set to 0
589  *   data:   currently unused; set to NULL
590  *
591  * The basic idea of re_intuit_start() is to use some known information
592  * about the pattern, namely:
593  *
594  *   a) the longest known anchored substring (i.e. one that's at a
595  *      constant offset from the beginning of the pattern; but not
596  *      necessarily at a fixed offset from the beginning of the
597  *      string);
598  *   b) the longest floating substring (i.e. one that's not at a constant
599  *      offset from the beginning of the pattern);
600  *   c) Whether the pattern is anchored to the string; either
601  *      an absolute anchor: /^../, or anchored to \n: /^.../m,
602  *      or anchored to pos(): /\G/;
603  *   d) A start class: a real or synthetic character class which
604  *      represents which characters are legal at the start of the pattern;
605  *
606  * to either quickly reject the match, or to find the earliest position
607  * within the string at which the pattern might match, thus avoiding
608  * running the full NFA engine at those earlier locations, only to
609  * eventually fail and retry further along.
610  *
611  * Returns NULL if the pattern can't match, or returns the address within
612  * the string which is the earliest place the match could occur.
613  *
614  * The longest of the anchored and floating substrings is called 'check'
615  * and is checked first. The other is called 'other' and is checked
616  * second. The 'other' substring may not be present.  For example,
617  *
618  *    /(abc|xyz)ABC\d{0,3}DEFG/
619  *
620  * will have
621  *
622  *   check substr (float)    = "DEFG", offset 6..9 chars
623  *   other substr (anchored) = "ABC",  offset 3..3 chars
624  *   stclass = [ax]
625  *
626  * Be aware that during the course of this function, sometimes 'anchored'
627  * refers to a substring being anchored relative to the start of the
628  * pattern, and sometimes to the pattern itself being anchored relative to
629  * the string. For example:
630  *
631  *   /\dabc/:   "abc" is anchored to the pattern;
632  *   /^\dabc/:  "abc" is anchored to the pattern and the string;
633  *   /\d+abc/:  "abc" is anchored to neither the pattern nor the string;
634  *   /^\d+abc/: "abc" is anchored to neither the pattern nor the string,
635  *                    but the pattern is anchored to the string.
636  */
637
638 char *
639 Perl_re_intuit_start(pTHX_
640                     REGEXP * const rx,
641                     SV *sv,
642                     const char * const strbeg,
643                     char *strpos,
644                     char *strend,
645                     const U32 flags,
646                     re_scream_pos_data *data)
647 {
648     struct regexp *const prog = ReANY(rx);
649     SSize_t start_shift = prog->check_offset_min;
650     /* Should be nonnegative! */
651     SSize_t end_shift   = 0;
652     /* current lowest pos in string where the regex can start matching */
653     char *rx_origin = strpos;
654     SV *check;
655     const bool utf8_target = (sv && SvUTF8(sv)) ? 1 : 0; /* if no sv we have to assume bytes */
656     U8   other_ix = 1 - prog->substrs->check_ix;
657     bool ml_anch = 0;
658     char *other_last = strpos;/* latest pos 'other' substr already checked to */
659     char *check_at = NULL;              /* check substr found at this pos */
660     const I32 multiline = prog->extflags & RXf_PMf_MULTILINE;
661     RXi_GET_DECL(prog,progi);
662     regmatch_info reginfo_buf;  /* create some info to pass to find_byclass */
663     regmatch_info *const reginfo = &reginfo_buf;
664     GET_RE_DEBUG_FLAGS_DECL;
665
666     PERL_ARGS_ASSERT_RE_INTUIT_START;
667     PERL_UNUSED_ARG(flags);
668     PERL_UNUSED_ARG(data);
669
670     DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
671                 "Intuit: trying to determine minimum start position...\n"));
672
673     /* for now, assume that all substr offsets are positive. If at some point
674      * in the future someone wants to do clever things with look-behind and
675      * -ve offsets, they'll need to fix up any code in this function
676      * which uses these offsets. See the thread beginning
677      * <20140113145929.GF27210@iabyn.com>
678      */
679     assert(prog->substrs->data[0].min_offset >= 0);
680     assert(prog->substrs->data[0].max_offset >= 0);
681     assert(prog->substrs->data[1].min_offset >= 0);
682     assert(prog->substrs->data[1].max_offset >= 0);
683     assert(prog->substrs->data[2].min_offset >= 0);
684     assert(prog->substrs->data[2].max_offset >= 0);
685
686     /* for now, assume that if both present, that the floating substring
687      * doesn't start before the anchored substring.
688      * If you break this assumption (e.g. doing better optimisations
689      * with lookahead/behind), then you'll need to audit the code in this
690      * function carefully first
691      */
692     assert(
693             ! (  (prog->anchored_utf8 || prog->anchored_substr)
694               && (prog->float_utf8    || prog->float_substr))
695            || (prog->float_min_offset >= prog->anchored_offset));
696
697     /* byte rather than char calculation for efficiency. It fails
698      * to quickly reject some cases that can't match, but will reject
699      * them later after doing full char arithmetic */
700     if (prog->minlen > strend - strpos) {
701         DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
702                               "  String too short...\n"));
703         goto fail;
704     }
705
706     reginfo->is_utf8_target = cBOOL(utf8_target);
707     reginfo->info_aux = NULL;
708     reginfo->strbeg = strbeg;
709     reginfo->strend = strend;
710     reginfo->is_utf8_pat = cBOOL(RX_UTF8(rx));
711     reginfo->intuit = 1;
712     /* not actually used within intuit, but zero for safety anyway */
713     reginfo->poscache_maxiter = 0;
714
715     if (utf8_target) {
716         if (!prog->check_utf8 && prog->check_substr)
717             to_utf8_substr(prog);
718         check = prog->check_utf8;
719     } else {
720         if (!prog->check_substr && prog->check_utf8) {
721             if (! to_byte_substr(prog)) {
722                 NON_UTF8_TARGET_BUT_UTF8_REQUIRED(fail);
723             }
724         }
725         check = prog->check_substr;
726     }
727
728     /* dump the various substring data */
729     DEBUG_OPTIMISE_MORE_r({
730         int i;
731         for (i=0; i<=2; i++) {
732             SV *sv = (utf8_target ? prog->substrs->data[i].utf8_substr
733                                   : prog->substrs->data[i].substr);
734             if (!sv)
735                 continue;
736
737             PerlIO_printf(Perl_debug_log,
738                 "  substrs[%d]: min=%"IVdf" max=%"IVdf" end shift=%"IVdf
739                 " useful=%"IVdf" utf8=%d [%s]\n",
740                 i,
741                 (IV)prog->substrs->data[i].min_offset,
742                 (IV)prog->substrs->data[i].max_offset,
743                 (IV)prog->substrs->data[i].end_shift,
744                 BmUSEFUL(sv),
745                 utf8_target ? 1 : 0,
746                 SvPEEK(sv));
747         }
748     });
749
750     if (prog->intflags & PREGf_ANCH) { /* Match at \G, beg-of-str or after \n */
751
752         /* ml_anch: check after \n?
753          *
754          * A note about IMPLICIT: on an un-anchored pattern beginning
755          * with /.*.../, these flags will have been added by the
756          * compiler:
757          *   /.*abc/, /.*abc/m:  PREGf_IMPLICIT | PREGf_ANCH_MBOL
758          *   /.*abc/s:           PREGf_IMPLICIT | PREGf_ANCH_SBOL
759          */
760         ml_anch =      (prog->intflags & PREGf_ANCH_MBOL)
761                    && !(prog->intflags & PREGf_IMPLICIT);
762
763         if (!ml_anch && !(prog->intflags & PREGf_IMPLICIT)) {
764             /* we are only allowed to match at BOS or \G */
765
766             /* trivially reject if there's a BOS anchor and we're not at BOS.
767              *
768              * Note that we don't try to do a similar quick reject for
769              * \G, since generally the caller will have calculated strpos
770              * based on pos() and gofs, so the string is already correctly
771              * anchored by definition; and handling the exceptions would
772              * be too fiddly (e.g. REXEC_IGNOREPOS).
773              */
774             if (   strpos != strbeg
775                 && (prog->intflags & PREGf_ANCH_SBOL))
776             {
777                 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
778                                 "  Not at start...\n"));
779                 goto fail;
780             }
781
782             /* in the presence of an anchor, the anchored (relative to the
783              * start of the regex) substr must also be anchored relative
784              * to strpos. So quickly reject if substr isn't found there.
785              * This works for \G too, because the caller will already have
786              * subtracted gofs from pos, and gofs is the offset from the
787              * \G to the start of the regex. For example, in /.abc\Gdef/,
788              * where substr="abcdef", pos()=3, gofs=4, offset_min=1:
789              * caller will have set strpos=pos()-4; we look for the substr
790              * at position pos()-4+1, which lines up with the "a" */
791
792             if (prog->check_offset_min == prog->check_offset_max
793                 && !(prog->intflags & PREGf_CANY_SEEN))
794             {
795                 /* Substring at constant offset from beg-of-str... */
796                 SSize_t slen = SvCUR(check);
797                 char *s = HOP3c(strpos, prog->check_offset_min, strend);
798             
799                 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
800                     "  Looking for check substr at fixed offset %"IVdf"...\n",
801                     (IV)prog->check_offset_min));
802
803                 if (SvTAIL(check)) {
804                     /* In this case, the regex is anchored at the end too.
805                      * Unless it's a multiline match, the lengths must match
806                      * exactly, give or take a \n.  NB: slen >= 1 since
807                      * the last char of check is \n */
808                     if (!multiline
809                         && (   strend - s > slen
810                             || strend - s < slen - 1
811                             || (strend - s == slen && strend[-1] != '\n')))
812                     {
813                         DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
814                                             "  String too long...\n"));
815                         goto fail_finish;
816                     }
817                     /* Now should match s[0..slen-2] */
818                     slen--;
819                 }
820                 if (slen && (*SvPVX_const(check) != *s
821                     || (slen > 1 && memNE(SvPVX_const(check), s, slen))))
822                 {
823                     DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
824                                     "  String not equal...\n"));
825                     goto fail_finish;
826                 }
827
828                 check_at = s;
829                 goto success_at_start;
830             }
831         }
832     }
833
834     end_shift = prog->check_end_shift;
835
836 #ifdef DEBUGGING        /* 7/99: reports of failure (with the older version) */
837     if (end_shift < 0)
838         Perl_croak(aTHX_ "panic: end_shift: %"IVdf" pattern:\n%s\n ",
839                    (IV)end_shift, RX_PRECOMP(prog));
840 #endif
841
842   restart:
843     
844     /* This is the (re)entry point of the main loop in this function.
845      * The goal of this loop is to:
846      * 1) find the "check" substring in the region rx_origin..strend
847      *    (adjusted by start_shift / end_shift). If not found, reject
848      *    immediately.
849      * 2) If it exists, look for the "other" substr too if defined; for
850      *    example, if the check substr maps to the anchored substr, then
851      *    check the floating substr, and vice-versa. If not found, go
852      *    back to (1) with rx_origin suitably incremented.
853      * 3) If we find an rx_origin position that doesn't contradict
854      *    either of the substrings, then check the possible additional
855      *    constraints on rx_origin of /^.../m or a known start class.
856      *    If these fail, then depending on which constraints fail, jump
857      *    back to here, or to various other re-entry points further along
858      *    that skip some of the first steps.
859      * 4) If we pass all those tests, update the BmUSEFUL() count on the
860      *    substring. If the start position was determined to be at the
861      *    beginning of the string  - so, not rejected, but not optimised,
862      *    since we have to run regmatch from position 0 - decrement the
863      *    BmUSEFUL() count. Otherwise increment it.
864      */
865
866
867     /* first, look for the 'check' substring */
868
869     {
870         U8* start_point;
871         U8* end_point;
872
873         DEBUG_OPTIMISE_MORE_r({
874             PerlIO_printf(Perl_debug_log,
875                 "  At restart: rx_origin=%"IVdf" Check offset min: %"IVdf
876                 " Start shift: %"IVdf" End shift %"IVdf
877                 " Real end Shift: %"IVdf"\n",
878                 (IV)(rx_origin - strpos),
879                 (IV)prog->check_offset_min,
880                 (IV)start_shift,
881                 (IV)end_shift,
882                 (IV)prog->check_end_shift);
883         });
884         
885         if (prog->intflags & PREGf_CANY_SEEN) {
886             start_point= (U8*)(rx_origin + start_shift);
887             end_point= (U8*)(strend - end_shift);
888             if (start_point > end_point)
889                 goto fail_finish;
890         } else {
891             end_point = HOP3(strend, -end_shift, strbeg);
892             start_point = HOPMAYBE3(rx_origin, start_shift, end_point);
893             if (!start_point)
894                 goto fail_finish;
895         }
896
897
898         /* If the regex is absolutely anchored to either the start of the
899          * string (SBOL) or to pos() (ANCH_GPOS), then
900          * check_offset_max represents an upper bound on the string where
901          * the substr could start. For the ANCH_GPOS case, we assume that
902          * the caller of intuit will have already set strpos to
903          * pos()-gofs, so in this case strpos + offset_max will still be
904          * an upper bound on the substr.
905          */
906         if (!ml_anch
907             && prog->intflags & PREGf_ANCH
908             && prog->check_offset_max != SSize_t_MAX)
909         {
910             SSize_t len = SvCUR(check) - !!SvTAIL(check);
911             const char * const anchor =
912                         (prog->intflags & PREGf_ANCH_GPOS ? strpos : strbeg);
913
914             /* do a bytes rather than chars comparison. It's conservative;
915              * so it skips doing the HOP if the result can't possibly end
916              * up earlier than the old value of end_point.
917              */
918             if ((char*)end_point - anchor > prog->check_offset_max) {
919                 end_point = HOP3lim((U8*)anchor,
920                                 prog->check_offset_max,
921                                 end_point -len)
922                             + len;
923             }
924         }
925
926         DEBUG_OPTIMISE_MORE_r({
927             PerlIO_printf(Perl_debug_log, "  fbm_instr len=%d str=<%.*s>\n",
928                 (int)(end_point - start_point),
929                 (int)(end_point - start_point) > 20 ? 20 : (int)(end_point - start_point), 
930                 start_point);
931         });
932
933         check_at = fbm_instr( start_point, end_point,
934                       check, multiline ? FBMrf_MULTILINE : 0);
935
936         /* Update the count-of-usability, remove useless subpatterns,
937             unshift s.  */
938
939         DEBUG_EXECUTE_r({
940             RE_PV_QUOTED_DECL(quoted, utf8_target, PERL_DEBUG_PAD_ZERO(0),
941                 SvPVX_const(check), RE_SV_DUMPLEN(check), 30);
942             PerlIO_printf(Perl_debug_log, "  %s %s substr %s%s%s",
943                               (check_at ? "Found" : "Did not find"),
944                 (check == (utf8_target ? prog->anchored_utf8 : prog->anchored_substr)
945                     ? "anchored" : "floating"),
946                 quoted,
947                 RE_SV_TAIL(check),
948                 (check_at ? " at offset " : "...\n") );
949         });
950
951         if (!check_at)
952             goto fail_finish;
953         /* Finish the diagnostic message */
954         DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "%ld...\n", (long)(check_at - strpos)) );
955
956         /* set rx_origin to the minimum position where the regex could start
957          * matching, given the constraint of the just-matched check substring.
958          * But don't set it lower than previously.
959          */
960
961         if (check_at - rx_origin > prog->check_offset_max)
962             rx_origin = HOP3c(check_at, -prog->check_offset_max, rx_origin);
963     }
964
965
966     /* now look for the 'other' substring if defined */
967
968     if (utf8_target ? prog->substrs->data[other_ix].utf8_substr
969                     : prog->substrs->data[other_ix].substr)
970     {
971         /* Take into account the "other" substring. */
972         char *last, *last1;
973         char *s;
974         SV* must;
975         struct reg_substr_datum *other;
976
977       do_other_substr:
978         other = &prog->substrs->data[other_ix];
979
980         /* if "other" is anchored:
981          * we've previously found a floating substr starting at check_at.
982          * This means that the regex origin must lie somewhere
983          * between min (rx_origin): HOP3(check_at, -check_offset_max)
984          * and max:                 HOP3(check_at, -check_offset_min)
985          * (except that min will be >= strpos)
986          * So the fixed  substr must lie somewhere between
987          *  HOP3(min, anchored_offset)
988          *  HOP3(max, anchored_offset) + SvCUR(substr)
989          */
990
991         /* if "other" is floating
992          * Calculate last1, the absolute latest point where the
993          * floating substr could start in the string, ignoring any
994          * constraints from the earlier fixed match. It is calculated
995          * as follows:
996          *
997          * strend - prog->minlen (in chars) is the absolute latest
998          * position within the string where the origin of the regex
999          * could appear. The latest start point for the floating
1000          * substr is float_min_offset(*) on from the start of the
1001          * regex.  last1 simply combines thee two offsets.
1002          *
1003          * (*) You might think the latest start point should be
1004          * float_max_offset from the regex origin, and technically
1005          * you'd be correct. However, consider
1006          *    /a\d{2,4}bcd\w/
1007          * Here, float min, max are 3,5 and minlen is 7.
1008          * This can match either
1009          *    /a\d\dbcd\w/
1010          *    /a\d\d\dbcd\w/
1011          *    /a\d\d\d\dbcd\w/
1012          * In the first case, the regex matches minlen chars; in the
1013          * second, minlen+1, in the third, minlen+2.
1014          * In the first case, the floating offset is 3 (which equals
1015          * float_min), in the second, 4, and in the third, 5 (which
1016          * equals float_max). In all cases, the floating string bcd
1017          * can never start more than 4 chars from the end of the
1018          * string, which equals minlen - float_min. As the substring
1019          * starts to match more than float_min from the start of the
1020          * regex, it makes the regex match more than minlen chars,
1021          * and the two cancel each other out. So we can always use
1022          * float_min - minlen, rather than float_max - minlen for the
1023          * latest position in the string.
1024          *
1025          * Note that -minlen + float_min_offset is equivalent (AFAIKT)
1026          * to CHR_SVLEN(must) - !!SvTAIL(must) + prog->float_end_shift
1027          */
1028
1029         assert(prog->minlen >= other->min_offset);
1030         last1 = HOP3c(strend,
1031                         other->min_offset - prog->minlen, strbeg);
1032
1033         if (other_ix) {/* i.e. if (other-is-float) */
1034             /* last is the latest point where the floating substr could
1035              * start, *given* any constraints from the earlier fixed
1036              * match. This constraint is that the floating string starts
1037              * <= float_max_offset chars from the regex origin (rx_origin).
1038              * If this value is less than last1, use it instead.
1039              */
1040             assert(rx_origin <= last1);
1041             last =
1042                 /* this condition handles the offset==infinity case, and
1043                  * is a short-cut otherwise. Although it's comparing a
1044                  * byte offset to a char length, it does so in a safe way,
1045                  * since 1 char always occupies 1 or more bytes,
1046                  * so if a string range is  (last1 - rx_origin) bytes,
1047                  * it will be less than or equal to  (last1 - rx_origin)
1048                  * chars; meaning it errs towards doing the accurate HOP3
1049                  * rather than just using last1 as a short-cut */
1050                 (last1 - rx_origin) < other->max_offset
1051                     ? last1
1052                     : (char*)HOP3lim(rx_origin, other->max_offset, last1);
1053         }
1054         else {
1055             assert(strpos + start_shift <= check_at);
1056             last = HOP4c(check_at, other->min_offset - start_shift,
1057                         strbeg, strend);
1058         }
1059
1060         s = HOP3c(rx_origin, other->min_offset, strend);
1061         if (s < other_last)     /* These positions already checked */
1062             s = other_last;
1063
1064         must = utf8_target ? other->utf8_substr : other->substr;
1065         assert(SvPOK(must));
1066         s = fbm_instr(
1067             (unsigned char*)s,
1068             (unsigned char*)last + SvCUR(must) - (SvTAIL(must)!=0),
1069             must,
1070             multiline ? FBMrf_MULTILINE : 0
1071         );
1072         DEBUG_EXECUTE_r({
1073             RE_PV_QUOTED_DECL(quoted, utf8_target, PERL_DEBUG_PAD_ZERO(0),
1074                 SvPVX_const(must), RE_SV_DUMPLEN(must), 30);
1075             PerlIO_printf(Perl_debug_log, "  %s %s substr %s%s",
1076                 s ? "Found" : "Contradicts",
1077                 other_ix ? "floating" : "anchored",
1078                 quoted, RE_SV_TAIL(must));
1079         });
1080
1081
1082         if (!s) {
1083             /* last1 is latest possible substr location. If we didn't
1084              * find it before there, we never will */
1085             if (last >= last1) {
1086                 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
1087                                         ", giving up...\n"));
1088                 goto fail_finish;
1089             }
1090
1091             /* try to find the check substr again at a later
1092              * position. Maybe next time we'll find the "other" substr
1093              * in range too */
1094             DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
1095                 ", trying %s at offset %ld...\n",
1096                 (other_ix ? "floating" : "anchored"),
1097                 (long)(HOP3c(check_at, 1, strend) - strpos)));
1098
1099             other_last = HOP3c(last, 1, strend) /* highest failure */;
1100             rx_origin =
1101                 other_ix /* i.e. if other-is-float */
1102                     ? HOP3c(rx_origin, 1, strend)
1103                     : HOP4c(last, 1 - other->min_offset, strbeg, strend);
1104             goto restart;
1105         }
1106         else {
1107             DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, " at offset %ld...\n",
1108                   (long)(s - strpos)));
1109
1110             if (other_ix) { /* if (other-is-float) */
1111                 /* other_last is set to s, not s+1, since its possible for
1112                  * a floating substr to fail first time, then succeed
1113                  * second time at the same floating position; e.g.:
1114                  *     "-AB--AABZ" =~ /\wAB\d*Z/
1115                  * The first time round, anchored and float match at
1116                  * "-(AB)--AAB(Z)" then fail on the initial \w character
1117                  * class. Second time round, they match at "-AB--A(AB)(Z)".
1118                  */
1119                 other_last = s;
1120             }
1121             else {
1122                 rx_origin = HOP3c(s, -other->min_offset, strbeg);
1123                 other_last = HOP3c(s, 1, strend);
1124             }
1125         }
1126     }
1127     else {
1128         DEBUG_OPTIMISE_MORE_r(
1129             PerlIO_printf(Perl_debug_log,
1130                 "  Check-only match: offset min:%"IVdf" max:%"IVdf
1131                 " check_at:%"IVdf" rx_origin:%"IVdf" rx_origin-check_at:%"IVdf
1132                 " strend-strpos:%"IVdf"\n",
1133                 (IV)prog->check_offset_min,
1134                 (IV)prog->check_offset_max,
1135                 (IV)(check_at-strpos),
1136                 (IV)(rx_origin-strpos),
1137                 (IV)(rx_origin-check_at),
1138                 (IV)(strend-strpos)
1139             )
1140         );
1141     }
1142
1143   postprocess_substr_matches:
1144
1145     /* handle the extra constraint of /^.../m if present */
1146
1147     if (ml_anch && rx_origin != strbeg && rx_origin[-1] != '\n') {
1148         char *s;
1149
1150         DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
1151                         "  looking for /^/m anchor"));
1152
1153         /* we have failed the constraint of a \n before rx_origin.
1154          * Find the next \n, if any, even if it's beyond the current
1155          * anchored and/or floating substrings. Whether we should be
1156          * scanning ahead for the next \n or the next substr is debatable.
1157          * On the one hand you'd expect rare substrings to appear less
1158          * often than \n's. On the other hand, searching for \n means
1159          * we're effectively flipping been check_substr and "\n" on each
1160          * iteration as the current "rarest" string candidate, which
1161          * means for example that we'll quickly reject the whole string if
1162          * hasn't got a \n, rather than trying every substr position
1163          * first
1164          */
1165
1166         s = HOP3c(strend, - prog->minlen, strpos);
1167         if (s <= rx_origin ||
1168             ! ( rx_origin = (char *)memchr(rx_origin, '\n', s - rx_origin)))
1169         {
1170             DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
1171                             "  Did not find /%s^%s/m...\n",
1172                             PL_colors[0], PL_colors[1]));
1173             goto fail_finish;
1174         }
1175
1176         /* earliest possible origin is 1 char after the \n.
1177          * (since *rx_origin == '\n', it's safe to ++ here rather than
1178          * HOP(rx_origin, 1)) */
1179         rx_origin++;
1180
1181         if (prog->substrs->check_ix == 0  /* check is anchored */
1182             || rx_origin >= HOP3c(check_at,  - prog->check_offset_min, strpos))
1183         {
1184             /* Position contradicts check-string; either because
1185              * check was anchored (and thus has no wiggle room),
1186              * or check was float and rx_origin is above the float range */
1187             DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
1188                 "  Found /%s^%s/m, restarting lookup for check-string at offset %ld...\n",
1189                 PL_colors[0], PL_colors[1], (long)(rx_origin - strpos)));
1190             goto restart;
1191         }
1192
1193         /* if we get here, the check substr must have been float,
1194          * is in range, and we may or may not have had an anchored
1195          * "other" substr which still contradicts */
1196         assert(prog->substrs->check_ix); /* check is float */
1197
1198         if (utf8_target ? prog->anchored_utf8 : prog->anchored_substr) {
1199             /* whoops, the anchored "other" substr exists, so we still
1200              * contradict. On the other hand, the float "check" substr
1201              * didn't contradict, so just retry the anchored "other"
1202              * substr */
1203             DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
1204                 "  Found /%s^%s/m at offset %ld, rescanning for anchored from offset %ld...\n",
1205                 PL_colors[0], PL_colors[1],
1206                 (long)(rx_origin - strpos),
1207                 (long)(rx_origin - strpos + prog->anchored_offset)));
1208             goto do_other_substr;
1209         }
1210
1211         /* success: we don't contradict the found floating substring
1212          * (and there's no anchored substr). */
1213         DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
1214             "  Found /%s^%s/m at offset %ld...\n",
1215             PL_colors[0], PL_colors[1], (long)(rx_origin - strpos)));
1216     }
1217     else {
1218         DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
1219             "  (multiline anchor test skipped)\n"));
1220     }
1221
1222   success_at_start:
1223
1224
1225     /* if we have a starting character class, then test that extra constraint.
1226      * (trie stclasses are too expensive to use here, we are better off to
1227      * leave it to regmatch itself) */
1228
1229     if (progi->regstclass && PL_regkind[OP(progi->regstclass)]!=TRIE) {
1230         const U8* const str = (U8*)STRING(progi->regstclass);
1231
1232         /* XXX this value could be pre-computed */
1233         const int cl_l = (PL_regkind[OP(progi->regstclass)] == EXACT
1234                     ?  (reginfo->is_utf8_pat
1235                         ? utf8_distance(str + STR_LEN(progi->regstclass), str)
1236                         : STR_LEN(progi->regstclass))
1237                     : 1);
1238         char * endpos;
1239         char *s;
1240         /* latest pos that a matching float substr constrains rx start to */
1241         char *rx_max_float = NULL;
1242
1243         /* if the current rx_origin is anchored, either by satisfying an
1244          * anchored substring constraint, or a /^.../m constraint, then we
1245          * can reject the current origin if the start class isn't found
1246          * at the current position. If we have a float-only match, then
1247          * rx_origin is constrained to a range; so look for the start class
1248          * in that range. if neither, then look for the start class in the
1249          * whole rest of the string */
1250
1251         /* XXX DAPM it's not clear what the minlen test is for, and why
1252          * it's not used in the floating case. Nothing in the test suite
1253          * causes minlen == 0 here. See <20140313134639.GS12844@iabyn.com>.
1254          * Here are some old comments, which may or may not be correct:
1255          *
1256          *   minlen == 0 is possible if regstclass is \b or \B,
1257          *   and the fixed substr is ''$.
1258          *   Since minlen is already taken into account, rx_origin+1 is
1259          *   before strend; accidentally, minlen >= 1 guaranties no false
1260          *   positives at rx_origin + 1 even for \b or \B.  But (minlen? 1 :
1261          *   0) below assumes that regstclass does not come from lookahead...
1262          *   If regstclass takes bytelength more than 1: If charlength==1, OK.
1263          *   This leaves EXACTF-ish only, which are dealt with in
1264          *   find_byclass().
1265          */
1266
1267         if (prog->anchored_substr || prog->anchored_utf8 || ml_anch)
1268             endpos= HOP3c(rx_origin, (prog->minlen ? cl_l : 0), strend);
1269         else if (prog->float_substr || prog->float_utf8) {
1270             rx_max_float = HOP3c(check_at, -start_shift, strbeg);
1271             endpos= HOP3c(rx_max_float, cl_l, strend);
1272         }
1273         else 
1274             endpos= strend;
1275                     
1276         DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
1277             "  looking for class: start_shift: %"IVdf" check_at: %"IVdf
1278             " rx_origin: %"IVdf" endpos: %"IVdf"\n",
1279               (IV)start_shift, (IV)(check_at - strbeg),
1280               (IV)(rx_origin - strbeg), (IV)(endpos - strbeg)));
1281
1282         s = find_byclass(prog, progi->regstclass, rx_origin, endpos,
1283                             reginfo);
1284         if (!s) {
1285             if (endpos == strend) {
1286                 DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
1287                                 "  Could not match STCLASS...\n") );
1288                 goto fail;
1289             }
1290             DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
1291                                "  This position contradicts STCLASS...\n") );
1292             if ((prog->intflags & PREGf_ANCH) && !ml_anch
1293                         && !(prog->intflags & PREGf_IMPLICIT))
1294                 goto fail;
1295
1296             /* Contradict one of substrings */
1297             if (prog->anchored_substr || prog->anchored_utf8) {
1298                 if (prog->substrs->check_ix == 1) { /* check is float */
1299                     /* Have both, check_string is floating */
1300                     assert(rx_origin + start_shift <= check_at);
1301                     if (rx_origin + start_shift != check_at) {
1302                         /* not at latest position float substr could match:
1303                          * Recheck anchored substring, but not floating.
1304                          * The condition above is in bytes rather than
1305                          * chars for efficiency. It's conservative, in
1306                          * that it errs on the side of doing 'goto
1307                          * do_other_substr', where a more accurate
1308                          * char-based calculation will be done */
1309                         DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
1310                                   "  Looking for anchored substr starting at offset %ld...\n",
1311                                   (long)(other_last - strpos)) );
1312                         goto do_other_substr;
1313                     }
1314                 }
1315             }
1316             else {
1317                 /* float-only */
1318
1319                 if (ml_anch) {
1320                     /* In the presence of ml_anch, we might be able to
1321                      * find another \n without breaking the current float
1322                      * constraint. */
1323
1324                     /* strictly speaking this should be HOP3c(..., 1, ...),
1325                      * but since we goto a block of code that's going to
1326                      * search for the next \n if any, its safe here */
1327                     rx_origin++;
1328                     DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
1329                               "  Looking for /%s^%s/m starting at offset %ld...\n",
1330                               PL_colors[0], PL_colors[1],
1331                               (long)(rx_origin - strpos)) );
1332                     goto postprocess_substr_matches;
1333                 }
1334
1335                 /* strictly speaking this can never be true; but might
1336                  * be if we ever allow intuit without substrings */
1337                 if (!(utf8_target ? prog->float_utf8 : prog->float_substr))
1338                     goto fail;
1339
1340                 rx_origin = rx_max_float;
1341             }
1342
1343             /* at this point, any matching substrings have been
1344              * contradicted. Start again... */
1345
1346             rx_origin = HOP3c(rx_origin, 1, strend);
1347
1348             /* uses bytes rather than char calculations for efficiency.
1349              * It's conservative: it errs on the side of doing 'goto restart',
1350              * where there is code that does a proper char-based test */
1351             if (rx_origin + start_shift + end_shift > strend) {
1352                 DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
1353                                        "  Could not match STCLASS...\n") );
1354                 goto fail;
1355             }
1356             DEBUG_EXECUTE_r( PerlIO_printf(Perl_debug_log,
1357                 "  Looking for %s substr starting at offset %ld...\n",
1358                 (prog->substrs->check_ix ? "floating" : "anchored"),
1359                 (long)(rx_origin + start_shift - strpos)) );
1360             goto restart;
1361         }
1362
1363         /* Success !!! */
1364
1365         if (rx_origin != s) {
1366             DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
1367                         "  By STCLASS: moving %ld --> %ld\n",
1368                                   (long)(rx_origin - strpos), (long)(s - strpos))
1369                    );
1370         }
1371         else {
1372             DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
1373                                   "  Does not contradict STCLASS...\n");
1374                    );
1375         }
1376     }
1377
1378     /* Decide whether using the substrings helped */
1379
1380     if (rx_origin != strpos) {
1381         /* Fixed substring is found far enough so that the match
1382            cannot start at strpos. */
1383
1384         DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "  try at offset...\n"));
1385         ++BmUSEFUL(utf8_target ? prog->check_utf8 : prog->check_substr);        /* hooray/5 */
1386     }
1387     else {
1388         /* The found rx_origin position does not prohibit matching at
1389          * strpos, so calling intuit didn't gain us anything. Decrement
1390          * the BmUSEFUL() count on the check substring, and if we reach
1391          * zero, free it.  */
1392         if (!(prog->intflags & PREGf_NAUGHTY)
1393             && (utf8_target ? (
1394                 prog->check_utf8                /* Could be deleted already */
1395                 && --BmUSEFUL(prog->check_utf8) < 0
1396                 && (prog->check_utf8 == prog->float_utf8)
1397             ) : (
1398                 prog->check_substr              /* Could be deleted already */
1399                 && --BmUSEFUL(prog->check_substr) < 0
1400                 && (prog->check_substr == prog->float_substr)
1401             )))
1402         {
1403             /* If flags & SOMETHING - do not do it many times on the same match */
1404             DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "  ... Disabling check substring...\n"));
1405             /* XXX Does the destruction order has to change with utf8_target? */
1406             SvREFCNT_dec(utf8_target ? prog->check_utf8 : prog->check_substr);
1407             SvREFCNT_dec(utf8_target ? prog->check_substr : prog->check_utf8);
1408             prog->check_substr = prog->check_utf8 = NULL;       /* disable */
1409             prog->float_substr = prog->float_utf8 = NULL;       /* clear */
1410             check = NULL;                       /* abort */
1411             /* XXXX This is a remnant of the old implementation.  It
1412                     looks wasteful, since now INTUIT can use many
1413                     other heuristics. */
1414             prog->extflags &= ~RXf_USE_INTUIT;
1415         }
1416     }
1417
1418     DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
1419             "Intuit: %sSuccessfully guessed:%s match at offset %ld\n",
1420              PL_colors[4], PL_colors[5], (long)(rx_origin - strpos)) );
1421
1422     return rx_origin;
1423
1424   fail_finish:                          /* Substring not found */
1425     if (prog->check_substr || prog->check_utf8)         /* could be removed already */
1426         BmUSEFUL(utf8_target ? prog->check_utf8 : prog->check_substr) += 5; /* hooray */
1427   fail:
1428     DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "%sMatch rejected by optimizer%s\n",
1429                           PL_colors[4], PL_colors[5]));
1430     return NULL;
1431 }
1432
1433
1434 #define DECL_TRIE_TYPE(scan) \
1435     const enum { trie_plain, trie_utf8, trie_utf8_fold, trie_latin_utf8_fold, \
1436                  trie_utf8_exactfa_fold, trie_latin_utf8_exactfa_fold } \
1437                     trie_type = ((scan->flags == EXACT) \
1438                               ? (utf8_target ? trie_utf8 : trie_plain) \
1439                               : (scan->flags == EXACTFA) \
1440                                 ? (utf8_target ? trie_utf8_exactfa_fold : trie_latin_utf8_exactfa_fold) \
1441                                 : (utf8_target ? trie_utf8_fold : trie_latin_utf8_fold))
1442
1443 #define REXEC_TRIE_READ_CHAR(trie_type, trie, widecharmap, uc, uscan, len, uvc, charid, foldlen, foldbuf, uniflags) \
1444 STMT_START {                                                                        \
1445     STRLEN skiplen;                                                                 \
1446     U8 flags = FOLD_FLAGS_FULL;                                                     \
1447     switch (trie_type) {                                                            \
1448     case trie_utf8_exactfa_fold:                                                    \
1449         flags |= FOLD_FLAGS_NOMIX_ASCII;                                            \
1450         /* FALLTHROUGH */                                                          \
1451     case trie_utf8_fold:                                                            \
1452         if ( foldlen>0 ) {                                                          \
1453             uvc = utf8n_to_uvchr( (const U8*) uscan, UTF8_MAXLEN, &len, uniflags ); \
1454             foldlen -= len;                                                         \
1455             uscan += len;                                                           \
1456             len=0;                                                                  \
1457         } else {                                                                    \
1458             uvc = _to_utf8_fold_flags( (const U8*) uc, foldbuf, &foldlen, flags);   \
1459             len = UTF8SKIP(uc);                                                     \
1460             skiplen = UNISKIP( uvc );                                               \
1461             foldlen -= skiplen;                                                     \
1462             uscan = foldbuf + skiplen;                                              \
1463         }                                                                           \
1464         break;                                                                      \
1465     case trie_latin_utf8_exactfa_fold:                                              \
1466         flags |= FOLD_FLAGS_NOMIX_ASCII;                                            \
1467         /* FALLTHROUGH */                                                          \
1468     case trie_latin_utf8_fold:                                                      \
1469         if ( foldlen>0 ) {                                                          \
1470             uvc = utf8n_to_uvchr( (const U8*) uscan, UTF8_MAXLEN, &len, uniflags ); \
1471             foldlen -= len;                                                         \
1472             uscan += len;                                                           \
1473             len=0;                                                                  \
1474         } else {                                                                    \
1475             len = 1;                                                                \
1476             uvc = _to_fold_latin1( (U8) *uc, foldbuf, &foldlen, flags);             \
1477             skiplen = UNISKIP( uvc );                                               \
1478             foldlen -= skiplen;                                                     \
1479             uscan = foldbuf + skiplen;                                              \
1480         }                                                                           \
1481         break;                                                                      \
1482     case trie_utf8:                                                                 \
1483         uvc = utf8n_to_uvchr( (const U8*) uc, UTF8_MAXLEN, &len, uniflags );        \
1484         break;                                                                      \
1485     case trie_plain:                                                                \
1486         uvc = (UV)*uc;                                                              \
1487         len = 1;                                                                    \
1488     }                                                                               \
1489     if (uvc < 256) {                                                                \
1490         charid = trie->charmap[ uvc ];                                              \
1491     }                                                                               \
1492     else {                                                                          \
1493         charid = 0;                                                                 \
1494         if (widecharmap) {                                                          \
1495             SV** const svpp = hv_fetch(widecharmap,                                 \
1496                         (char*)&uvc, sizeof(UV), 0);                                \
1497             if (svpp)                                                               \
1498                 charid = (U16)SvIV(*svpp);                                          \
1499         }                                                                           \
1500     }                                                                               \
1501 } STMT_END
1502
1503 #define DUMP_EXEC_POS(li,s,doutf8)                          \
1504     dump_exec_pos(li,s,(reginfo->strend),(reginfo->strbeg), \
1505                 startpos, doutf8)
1506
1507 #define REXEC_FBC_EXACTISH_SCAN(COND)                     \
1508 STMT_START {                                              \
1509     while (s <= e) {                                      \
1510         if ( (COND)                                       \
1511              && (ln == 1 || folder(s, pat_string, ln))    \
1512              && (reginfo->intuit || regtry(reginfo, &s)) )\
1513             goto got_it;                                  \
1514         s++;                                              \
1515     }                                                     \
1516 } STMT_END
1517
1518 #define REXEC_FBC_UTF8_SCAN(CODE)                     \
1519 STMT_START {                                          \
1520     while (s < strend) {                              \
1521         CODE                                          \
1522         s += UTF8SKIP(s);                             \
1523     }                                                 \
1524 } STMT_END
1525
1526 #define REXEC_FBC_SCAN(CODE)                          \
1527 STMT_START {                                          \
1528     while (s < strend) {                              \
1529         CODE                                          \
1530         s++;                                          \
1531     }                                                 \
1532 } STMT_END
1533
1534 #define REXEC_FBC_UTF8_CLASS_SCAN(COND)                        \
1535 REXEC_FBC_UTF8_SCAN( /* Loops while (s < strend) */            \
1536     if (COND) {                                                \
1537         if (tmp && (reginfo->intuit || regtry(reginfo, &s)))   \
1538             goto got_it;                                       \
1539         else                                                   \
1540             tmp = doevery;                                     \
1541     }                                                          \
1542     else                                                       \
1543         tmp = 1;                                               \
1544 )
1545
1546 #define REXEC_FBC_CLASS_SCAN(COND)                             \
1547 REXEC_FBC_SCAN( /* Loops while (s < strend) */                 \
1548     if (COND) {                                                \
1549         if (tmp && (reginfo->intuit || regtry(reginfo, &s)))   \
1550             goto got_it;                                       \
1551         else                                                   \
1552             tmp = doevery;                                     \
1553     }                                                          \
1554     else                                                       \
1555         tmp = 1;                                               \
1556 )
1557
1558 #define REXEC_FBC_CSCAN(CONDUTF8,COND)                         \
1559     if (utf8_target) {                                         \
1560         REXEC_FBC_UTF8_CLASS_SCAN(CONDUTF8);                   \
1561     }                                                          \
1562     else {                                                     \
1563         REXEC_FBC_CLASS_SCAN(COND);                            \
1564     }
1565
1566 /* The three macros below are slightly different versions of the same logic.
1567  *
1568  * The first is for /a and /aa when the target string is UTF-8.  This can only
1569  * match ascii, but it must advance based on UTF-8.   The other two handle the
1570  * non-UTF-8 and the more generic UTF-8 cases.   In all three, we are looking
1571  * for the boundary (or non-boundary) between a word and non-word character.
1572  * The utf8 and non-utf8 cases have the same logic, but the details must be
1573  * different.  Find the "wordness" of the character just prior to this one, and
1574  * compare it with the wordness of this one.  If they differ, we have a
1575  * boundary.  At the beginning of the string, pretend that the previous
1576  * character was a new-line.
1577  *
1578  * All these macros uncleanly have side-effects with each other and outside
1579  * variables.  So far it's been too much trouble to clean-up
1580  *
1581  * TEST_NON_UTF8 is the macro or function to call to test if its byte input is
1582  *               a word character or not.
1583  * IF_SUCCESS    is code to do if it finds that we are at a boundary between
1584  *               word/non-word
1585  * IF_FAIL       is code to do if we aren't at a boundary between word/non-word
1586  *
1587  * Exactly one of the two IF_FOO parameters is a no-op, depending on whether we
1588  * are looking for a boundary or for a non-boundary.  If we are looking for a
1589  * boundary, we want IF_FAIL to be the no-op, and for IF_SUCCESS to go out and
1590  * see if this tentative match actually works, and if so, to quit the loop
1591  * here.  And vice-versa if we are looking for a non-boundary.
1592  *
1593  * 'tmp' below in the next three macros in the REXEC_FBC_SCAN and
1594  * REXEC_FBC_UTF8_SCAN loops is a loop invariant, a bool giving the return of
1595  * TEST_NON_UTF8(s-1).  To see this, note that that's what it is defined to be
1596  * at entry to the loop, and to get to the IF_FAIL branch, tmp must equal
1597  * TEST_NON_UTF8(s), and in the opposite branch, IF_SUCCESS, tmp is that
1598  * complement.  But in that branch we complement tmp, meaning that at the
1599  * bottom of the loop tmp is always going to be equal to TEST_NON_UTF8(s),
1600  * which means at the top of the loop in the next iteration, it is
1601  * TEST_NON_UTF8(s-1) */
1602 #define FBC_UTF8_A(TEST_NON_UTF8, IF_SUCCESS, IF_FAIL)                         \
1603     tmp = (s != reginfo->strbeg) ? UCHARAT(s - 1) : '\n';                      \
1604     tmp = TEST_NON_UTF8(tmp);                                                  \
1605     REXEC_FBC_UTF8_SCAN( /* advances s while s < strend */                     \
1606         if (tmp == ! TEST_NON_UTF8((U8) *s)) {                                 \
1607             tmp = !tmp;                                                        \
1608             IF_SUCCESS; /* Is a boundary if values for s-1 and s differ */     \
1609         }                                                                      \
1610         else {                                                                 \
1611             IF_FAIL;                                                           \
1612         }                                                                      \
1613     );                                                                         \
1614
1615 /* Like FBC_UTF8_A, but TEST_UV is a macro which takes a UV as its input, and
1616  * TEST_UTF8 is a macro that for the same input code points returns identically
1617  * to TEST_UV, but takes a pointer to a UTF-8 encoded string instead */
1618 #define FBC_UTF8(TEST_UV, TEST_UTF8, IF_SUCCESS, IF_FAIL)                      \
1619     if (s == reginfo->strbeg) {                                                \
1620         tmp = '\n';                                                            \
1621     }                                                                          \
1622     else { /* Back-up to the start of the previous character */                \
1623         U8 * const r = reghop3((U8*)s, -1, (U8*)reginfo->strbeg);              \
1624         tmp = utf8n_to_uvchr(r, (U8*) reginfo->strend - r,                     \
1625                                                        0, UTF8_ALLOW_DEFAULT); \
1626     }                                                                          \
1627     tmp = TEST_UV(tmp);                                                        \
1628     LOAD_UTF8_CHARCLASS_ALNUM();                                               \
1629     REXEC_FBC_UTF8_SCAN( /* advances s while s < strend */                     \
1630         if (tmp == ! (TEST_UTF8((U8 *) s))) {                                  \
1631             tmp = !tmp;                                                        \
1632             IF_SUCCESS;                                                        \
1633         }                                                                      \
1634         else {                                                                 \
1635             IF_FAIL;                                                           \
1636         }                                                                      \
1637     );
1638
1639 /* Like the above two macros.  UTF8_CODE is the complete code for handling
1640  * UTF-8.  Common to the BOUND and NBOUND cases, set-up by the FBC_BOUND, etc
1641  * macros below */
1642 #define FBC_BOUND_COMMON(UTF8_CODE, TEST_NON_UTF8, IF_SUCCESS, IF_FAIL)        \
1643     if (utf8_target) {                                                         \
1644         UTF8_CODE                                                              \
1645     }                                                                          \
1646     else {  /* Not utf8 */                                                     \
1647         tmp = (s != reginfo->strbeg) ? UCHARAT(s - 1) : '\n';                  \
1648         tmp = TEST_NON_UTF8(tmp);                                              \
1649         REXEC_FBC_SCAN( /* advances s while s < strend */                      \
1650             if (tmp == ! TEST_NON_UTF8((U8) *s)) {                             \
1651                 IF_SUCCESS;                                                    \
1652                 tmp = !tmp;                                                    \
1653             }                                                                  \
1654             else {                                                             \
1655                 IF_FAIL;                                                       \
1656             }                                                                  \
1657         );                                                                     \
1658     }                                                                          \
1659     /* Here, things have been set up by the previous code so that tmp is the   \
1660      * return of TEST_NON_UTF(s-1) or TEST_UTF8(s-1) (depending on the         \
1661      * utf8ness of the target).  We also have to check if this matches against \
1662      * the EOS, which we treat as a \n (which is the same value in both UTF-8  \
1663      * or non-UTF8, so can use the non-utf8 test condition even for a UTF-8    \
1664      * string */                                                               \
1665     if (tmp == ! TEST_NON_UTF8('\n')) {                                        \
1666         IF_SUCCESS;                                                            \
1667     }                                                                          \
1668     else {                                                                     \
1669         IF_FAIL;                                                               \
1670     }
1671
1672 /* This is the macro to use when we want to see if something that looks like it
1673  * could match, actually does, and if so exits the loop */
1674 #define REXEC_FBC_TRYIT                            \
1675     if ((reginfo->intuit || regtry(reginfo, &s)))  \
1676         goto got_it
1677
1678 /* The only difference between the BOUND and NBOUND cases is that
1679  * REXEC_FBC_TRYIT is called when matched in BOUND, and when non-matched in
1680  * NBOUND.  This is accomplished by passing it as either the if or else clause,
1681  * with the other one being empty (PLACEHOLDER is defined as empty).
1682  *
1683  * The TEST_FOO parameters are for operating on different forms of input, but
1684  * all should be ones that return identically for the same underlying code
1685  * points */
1686 #define FBC_BOUND(TEST_NON_UTF8, TEST_UV, TEST_UTF8)                           \
1687     FBC_BOUND_COMMON(                                                          \
1688           FBC_UTF8(TEST_UV, TEST_UTF8, REXEC_FBC_TRYIT, PLACEHOLDER),          \
1689           TEST_NON_UTF8, REXEC_FBC_TRYIT, PLACEHOLDER)
1690
1691 #define FBC_BOUND_A(TEST_NON_UTF8, TEST_UV, TEST_UTF8)                         \
1692     FBC_BOUND_COMMON(                                                          \
1693             FBC_UTF8_A(TEST_NON_UTF8, REXEC_FBC_TRYIT, PLACEHOLDER),           \
1694             TEST_NON_UTF8, REXEC_FBC_TRYIT, PLACEHOLDER)
1695
1696 #define FBC_NBOUND(TEST_NON_UTF8, TEST_UV, TEST_UTF8)                          \
1697     FBC_BOUND_COMMON(                                                          \
1698           FBC_UTF8(TEST_UV, TEST_UTF8, PLACEHOLDER, REXEC_FBC_TRYIT),          \
1699           TEST_NON_UTF8, PLACEHOLDER, REXEC_FBC_TRYIT)
1700
1701 #define FBC_NBOUND_A(TEST_NON_UTF8, TEST_UV, TEST_UTF8)                        \
1702     FBC_BOUND_COMMON(                                                          \
1703             FBC_UTF8_A(TEST_NON_UTF8, PLACEHOLDER, REXEC_FBC_TRYIT),           \
1704             TEST_NON_UTF8, PLACEHOLDER, REXEC_FBC_TRYIT)
1705
1706
1707 /* We know what class REx starts with.  Try to find this position... */
1708 /* if reginfo->intuit, its a dryrun */
1709 /* annoyingly all the vars in this routine have different names from their counterparts
1710    in regmatch. /grrr */
1711 STATIC char *
1712 S_find_byclass(pTHX_ regexp * prog, const regnode *c, char *s, 
1713     const char *strend, regmatch_info *reginfo)
1714 {
1715     dVAR;
1716     const I32 doevery = (prog->intflags & PREGf_SKIP) == 0;
1717     char *pat_string;   /* The pattern's exactish string */
1718     char *pat_end;          /* ptr to end char of pat_string */
1719     re_fold_t folder;   /* Function for computing non-utf8 folds */
1720     const U8 *fold_array;   /* array for folding ords < 256 */
1721     STRLEN ln;
1722     STRLEN lnc;
1723     U8 c1;
1724     U8 c2;
1725     char *e;
1726     I32 tmp = 1;        /* Scratch variable? */
1727     const bool utf8_target = reginfo->is_utf8_target;
1728     UV utf8_fold_flags = 0;
1729     const bool is_utf8_pat = reginfo->is_utf8_pat;
1730     bool to_complement = FALSE; /* Invert the result?  Taking the xor of this
1731                                    with a result inverts that result, as 0^1 =
1732                                    1 and 1^1 = 0 */
1733     _char_class_number classnum;
1734
1735     RXi_GET_DECL(prog,progi);
1736
1737     PERL_ARGS_ASSERT_FIND_BYCLASS;
1738
1739     /* We know what class it must start with. */
1740     switch (OP(c)) {
1741     case ANYOF:
1742         if (utf8_target) {
1743             REXEC_FBC_UTF8_CLASS_SCAN(
1744                       reginclass(prog, c, (U8*)s, (U8*) strend, utf8_target));
1745         }
1746         else {
1747             REXEC_FBC_CLASS_SCAN(REGINCLASS(prog, c, (U8*)s));
1748         }
1749         break;
1750     case CANY:
1751         REXEC_FBC_SCAN(
1752             if (tmp && (reginfo->intuit || regtry(reginfo, &s)))
1753                 goto got_it;
1754             else
1755                 tmp = doevery;
1756         );
1757         break;
1758
1759     case EXACTFA_NO_TRIE:   /* This node only generated for non-utf8 patterns */
1760         assert(! is_utf8_pat);
1761         /* FALLTHROUGH */
1762     case EXACTFA:
1763         if (is_utf8_pat || utf8_target) {
1764             utf8_fold_flags = FOLDEQ_UTF8_NOMIX_ASCII;
1765             goto do_exactf_utf8;
1766         }
1767         fold_array = PL_fold_latin1;    /* Latin1 folds are not affected by */
1768         folder = foldEQ_latin1;         /* /a, except the sharp s one which */
1769         goto do_exactf_non_utf8;        /* isn't dealt with by these */
1770
1771     case EXACTF:   /* This node only generated for non-utf8 patterns */
1772         assert(! is_utf8_pat);
1773         if (utf8_target) {
1774             utf8_fold_flags = 0;
1775             goto do_exactf_utf8;
1776         }
1777         fold_array = PL_fold;
1778         folder = foldEQ;
1779         goto do_exactf_non_utf8;
1780
1781     case EXACTFL:
1782         if (is_utf8_pat || utf8_target || IN_UTF8_CTYPE_LOCALE) {
1783             utf8_fold_flags = FOLDEQ_LOCALE;
1784             goto do_exactf_utf8;
1785         }
1786         fold_array = PL_fold_locale;
1787         folder = foldEQ_locale;
1788         goto do_exactf_non_utf8;
1789
1790     case EXACTFU_SS:
1791         if (is_utf8_pat) {
1792             utf8_fold_flags = FOLDEQ_S2_ALREADY_FOLDED;
1793         }
1794         goto do_exactf_utf8;
1795
1796     case EXACTFU:
1797         if (is_utf8_pat || utf8_target) {
1798             utf8_fold_flags = is_utf8_pat ? FOLDEQ_S2_ALREADY_FOLDED : 0;
1799             goto do_exactf_utf8;
1800         }
1801
1802         /* Any 'ss' in the pattern should have been replaced by regcomp,
1803          * so we don't have to worry here about this single special case
1804          * in the Latin1 range */
1805         fold_array = PL_fold_latin1;
1806         folder = foldEQ_latin1;
1807
1808         /* FALLTHROUGH */
1809
1810     do_exactf_non_utf8: /* Neither pattern nor string are UTF8, and there
1811                            are no glitches with fold-length differences
1812                            between the target string and pattern */
1813
1814         /* The idea in the non-utf8 EXACTF* cases is to first find the
1815          * first character of the EXACTF* node and then, if necessary,
1816          * case-insensitively compare the full text of the node.  c1 is the
1817          * first character.  c2 is its fold.  This logic will not work for
1818          * Unicode semantics and the german sharp ss, which hence should
1819          * not be compiled into a node that gets here. */
1820         pat_string = STRING(c);
1821         ln  = STR_LEN(c);       /* length to match in octets/bytes */
1822
1823         /* We know that we have to match at least 'ln' bytes (which is the
1824          * same as characters, since not utf8).  If we have to match 3
1825          * characters, and there are only 2 availabe, we know without
1826          * trying that it will fail; so don't start a match past the
1827          * required minimum number from the far end */
1828         e = HOP3c(strend, -((SSize_t)ln), s);
1829
1830         if (reginfo->intuit && e < s) {
1831             e = s;                      /* Due to minlen logic of intuit() */
1832         }
1833
1834         c1 = *pat_string;
1835         c2 = fold_array[c1];
1836         if (c1 == c2) { /* If char and fold are the same */
1837             REXEC_FBC_EXACTISH_SCAN(*(U8*)s == c1);
1838         }
1839         else {
1840             REXEC_FBC_EXACTISH_SCAN(*(U8*)s == c1 || *(U8*)s == c2);
1841         }
1842         break;
1843
1844     do_exactf_utf8:
1845     {
1846         unsigned expansion;
1847
1848         /* If one of the operands is in utf8, we can't use the simpler folding
1849          * above, due to the fact that many different characters can have the
1850          * same fold, or portion of a fold, or different- length fold */
1851         pat_string = STRING(c);
1852         ln  = STR_LEN(c);       /* length to match in octets/bytes */
1853         pat_end = pat_string + ln;
1854         lnc = is_utf8_pat       /* length to match in characters */
1855                 ? utf8_length((U8 *) pat_string, (U8 *) pat_end)
1856                 : ln;
1857
1858         /* We have 'lnc' characters to match in the pattern, but because of
1859          * multi-character folding, each character in the target can match
1860          * up to 3 characters (Unicode guarantees it will never exceed
1861          * this) if it is utf8-encoded; and up to 2 if not (based on the
1862          * fact that the Latin 1 folds are already determined, and the
1863          * only multi-char fold in that range is the sharp-s folding to
1864          * 'ss'.  Thus, a pattern character can match as little as 1/3 of a
1865          * string character.  Adjust lnc accordingly, rounding up, so that
1866          * if we need to match at least 4+1/3 chars, that really is 5. */
1867         expansion = (utf8_target) ? UTF8_MAX_FOLD_CHAR_EXPAND : 2;
1868         lnc = (lnc + expansion - 1) / expansion;
1869
1870         /* As in the non-UTF8 case, if we have to match 3 characters, and
1871          * only 2 are left, it's guaranteed to fail, so don't start a
1872          * match that would require us to go beyond the end of the string
1873          */
1874         e = HOP3c(strend, -((SSize_t)lnc), s);
1875
1876         if (reginfo->intuit && e < s) {
1877             e = s;                      /* Due to minlen logic of intuit() */
1878         }
1879
1880         /* XXX Note that we could recalculate e to stop the loop earlier,
1881          * as the worst case expansion above will rarely be met, and as we
1882          * go along we would usually find that e moves further to the left.
1883          * This would happen only after we reached the point in the loop
1884          * where if there were no expansion we should fail.  Unclear if
1885          * worth the expense */
1886
1887         while (s <= e) {
1888             char *my_strend= (char *)strend;
1889             if (foldEQ_utf8_flags(s, &my_strend, 0,  utf8_target,
1890                   pat_string, NULL, ln, is_utf8_pat, utf8_fold_flags)
1891                 && (reginfo->intuit || regtry(reginfo, &s)) )
1892             {
1893                 goto got_it;
1894             }
1895             s += (utf8_target) ? UTF8SKIP(s) : 1;
1896         }
1897         break;
1898     }
1899
1900     case BOUNDL:
1901         FBC_BOUND(isWORDCHAR_LC, isWORDCHAR_LC_uvchr, isWORDCHAR_LC_utf8);
1902         break;
1903     case NBOUNDL:
1904         FBC_NBOUND(isWORDCHAR_LC, isWORDCHAR_LC_uvchr, isWORDCHAR_LC_utf8);
1905         break;
1906     case BOUND:
1907         FBC_BOUND(isWORDCHAR, isWORDCHAR_uni, isWORDCHAR_utf8);
1908         break;
1909     case BOUNDA:
1910         FBC_BOUND_A(isWORDCHAR_A, isWORDCHAR_A, isWORDCHAR_A);
1911         break;
1912     case NBOUND:
1913         FBC_NBOUND(isWORDCHAR, isWORDCHAR_uni, isWORDCHAR_utf8);
1914         break;
1915     case NBOUNDA:
1916         FBC_NBOUND_A(isWORDCHAR_A, isWORDCHAR_A, isWORDCHAR_A);
1917         break;
1918     case BOUNDU:
1919         FBC_BOUND(isWORDCHAR_L1, isWORDCHAR_uni, isWORDCHAR_utf8);
1920         break;
1921     case NBOUNDU:
1922         FBC_NBOUND(isWORDCHAR_L1, isWORDCHAR_uni, isWORDCHAR_utf8);
1923         break;
1924     case LNBREAK:
1925         REXEC_FBC_CSCAN(is_LNBREAK_utf8_safe(s, strend),
1926                         is_LNBREAK_latin1_safe(s, strend)
1927         );
1928         break;
1929
1930     /* The argument to all the POSIX node types is the class number to pass to
1931      * _generic_isCC() to build a mask for searching in PL_charclass[] */
1932
1933     case NPOSIXL:
1934         to_complement = 1;
1935         /* FALLTHROUGH */
1936
1937     case POSIXL:
1938         REXEC_FBC_CSCAN(to_complement ^ cBOOL(isFOO_utf8_lc(FLAGS(c), (U8 *) s)),
1939                         to_complement ^ cBOOL(isFOO_lc(FLAGS(c), *s)));
1940         break;
1941
1942     case NPOSIXD:
1943         to_complement = 1;
1944         /* FALLTHROUGH */
1945
1946     case POSIXD:
1947         if (utf8_target) {
1948             goto posix_utf8;
1949         }
1950         goto posixa;
1951
1952     case NPOSIXA:
1953         if (utf8_target) {
1954             /* The complement of something that matches only ASCII matches all
1955              * non-ASCII, plus everything in ASCII that isn't in the class. */
1956             REXEC_FBC_UTF8_CLASS_SCAN(! isASCII_utf8(s)
1957                                       || ! _generic_isCC_A(*s, FLAGS(c)));
1958             break;
1959         }
1960
1961         to_complement = 1;
1962         /* FALLTHROUGH */
1963
1964     case POSIXA:
1965       posixa:
1966         /* Don't need to worry about utf8, as it can match only a single
1967          * byte invariant character. */
1968         REXEC_FBC_CLASS_SCAN(
1969                         to_complement ^ cBOOL(_generic_isCC_A(*s, FLAGS(c))));
1970         break;
1971
1972     case NPOSIXU:
1973         to_complement = 1;
1974         /* FALLTHROUGH */
1975
1976     case POSIXU:
1977         if (! utf8_target) {
1978             REXEC_FBC_CLASS_SCAN(to_complement ^ cBOOL(_generic_isCC(*s,
1979                                                                     FLAGS(c))));
1980         }
1981         else {
1982
1983       posix_utf8:
1984             classnum = (_char_class_number) FLAGS(c);
1985             if (classnum < _FIRST_NON_SWASH_CC) {
1986                 while (s < strend) {
1987
1988                     /* We avoid loading in the swash as long as possible, but
1989                      * should we have to, we jump to a separate loop.  This
1990                      * extra 'if' statement is what keeps this code from being
1991                      * just a call to REXEC_FBC_UTF8_CLASS_SCAN() */
1992                     if (UTF8_IS_ABOVE_LATIN1(*s)) {
1993                         goto found_above_latin1;
1994                     }
1995                     if ((UTF8_IS_INVARIANT(*s)
1996                          && to_complement ^ cBOOL(_generic_isCC((U8) *s,
1997                                                                 classnum)))
1998                         || (UTF8_IS_DOWNGRADEABLE_START(*s)
1999                             && to_complement ^ cBOOL(
2000                                 _generic_isCC(TWO_BYTE_UTF8_TO_NATIVE(*s,
2001                                                                       *(s + 1)),
2002                                               classnum))))
2003                     {
2004                         if (tmp && (reginfo->intuit || regtry(reginfo, &s)))
2005                             goto got_it;
2006                         else {
2007                             tmp = doevery;
2008                         }
2009                     }
2010                     else {
2011                         tmp = 1;
2012                     }
2013                     s += UTF8SKIP(s);
2014                 }
2015             }
2016             else switch (classnum) {    /* These classes are implemented as
2017                                            macros */
2018                 case _CC_ENUM_SPACE: /* XXX would require separate code if we
2019                                         revert the change of \v matching this */
2020                     /* FALLTHROUGH */
2021
2022                 case _CC_ENUM_PSXSPC:
2023                     REXEC_FBC_UTF8_CLASS_SCAN(
2024                                         to_complement ^ cBOOL(isSPACE_utf8(s)));
2025                     break;
2026
2027                 case _CC_ENUM_BLANK:
2028                     REXEC_FBC_UTF8_CLASS_SCAN(
2029                                         to_complement ^ cBOOL(isBLANK_utf8(s)));
2030                     break;
2031
2032                 case _CC_ENUM_XDIGIT:
2033                     REXEC_FBC_UTF8_CLASS_SCAN(
2034                                        to_complement ^ cBOOL(isXDIGIT_utf8(s)));
2035                     break;
2036
2037                 case _CC_ENUM_VERTSPACE:
2038                     REXEC_FBC_UTF8_CLASS_SCAN(
2039                                        to_complement ^ cBOOL(isVERTWS_utf8(s)));
2040                     break;
2041
2042                 case _CC_ENUM_CNTRL:
2043                     REXEC_FBC_UTF8_CLASS_SCAN(
2044                                         to_complement ^ cBOOL(isCNTRL_utf8(s)));
2045                     break;
2046
2047                 default:
2048                     Perl_croak(aTHX_ "panic: find_byclass() node %d='%s' has an unexpected character class '%d'", OP(c), PL_reg_name[OP(c)], classnum);
2049                     assert(0); /* NOTREACHED */
2050             }
2051         }
2052         break;
2053
2054       found_above_latin1:   /* Here we have to load a swash to get the result
2055                                for the current code point */
2056         if (! PL_utf8_swash_ptrs[classnum]) {
2057             U8 flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;
2058             PL_utf8_swash_ptrs[classnum] =
2059                     _core_swash_init("utf8",
2060                                      "",
2061                                      &PL_sv_undef, 1, 0,
2062                                      PL_XPosix_ptrs[classnum], &flags);
2063         }
2064
2065         /* This is a copy of the loop above for swash classes, though using the
2066          * FBC macro instead of being expanded out.  Since we've loaded the
2067          * swash, we don't have to check for that each time through the loop */
2068         REXEC_FBC_UTF8_CLASS_SCAN(
2069                 to_complement ^ cBOOL(_generic_utf8(
2070                                       classnum,
2071                                       s,
2072                                       swash_fetch(PL_utf8_swash_ptrs[classnum],
2073                                                   (U8 *) s, TRUE))));
2074         break;
2075
2076     case AHOCORASICKC:
2077     case AHOCORASICK:
2078         {
2079             DECL_TRIE_TYPE(c);
2080             /* what trie are we using right now */
2081             reg_ac_data *aho = (reg_ac_data*)progi->data->data[ ARG( c ) ];
2082             reg_trie_data *trie = (reg_trie_data*)progi->data->data[ aho->trie ];
2083             HV *widecharmap = MUTABLE_HV(progi->data->data[ aho->trie + 1 ]);
2084
2085             const char *last_start = strend - trie->minlen;
2086 #ifdef DEBUGGING
2087             const char *real_start = s;
2088 #endif
2089             STRLEN maxlen = trie->maxlen;
2090             SV *sv_points;
2091             U8 **points; /* map of where we were in the input string
2092                             when reading a given char. For ASCII this
2093                             is unnecessary overhead as the relationship
2094                             is always 1:1, but for Unicode, especially
2095                             case folded Unicode this is not true. */
2096             U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
2097             U8 *bitmap=NULL;
2098
2099
2100             GET_RE_DEBUG_FLAGS_DECL;
2101
2102             /* We can't just allocate points here. We need to wrap it in
2103              * an SV so it gets freed properly if there is a croak while
2104              * running the match */
2105             ENTER;
2106             SAVETMPS;
2107             sv_points=newSV(maxlen * sizeof(U8 *));
2108             SvCUR_set(sv_points,
2109                 maxlen * sizeof(U8 *));
2110             SvPOK_on(sv_points);
2111             sv_2mortal(sv_points);
2112             points=(U8**)SvPV_nolen(sv_points );
2113             if ( trie_type != trie_utf8_fold
2114                  && (trie->bitmap || OP(c)==AHOCORASICKC) )
2115             {
2116                 if (trie->bitmap)
2117                     bitmap=(U8*)trie->bitmap;
2118                 else
2119                     bitmap=(U8*)ANYOF_BITMAP(c);
2120             }
2121             /* this is the Aho-Corasick algorithm modified a touch
2122                to include special handling for long "unknown char" sequences.
2123                The basic idea being that we use AC as long as we are dealing
2124                with a possible matching char, when we encounter an unknown char
2125                (and we have not encountered an accepting state) we scan forward
2126                until we find a legal starting char.
2127                AC matching is basically that of trie matching, except that when
2128                we encounter a failing transition, we fall back to the current
2129                states "fail state", and try the current char again, a process
2130                we repeat until we reach the root state, state 1, or a legal
2131                transition. If we fail on the root state then we can either
2132                terminate if we have reached an accepting state previously, or
2133                restart the entire process from the beginning if we have not.
2134
2135              */
2136             while (s <= last_start) {
2137                 const U32 uniflags = UTF8_ALLOW_DEFAULT;
2138                 U8 *uc = (U8*)s;
2139                 U16 charid = 0;
2140                 U32 base = 1;
2141                 U32 state = 1;
2142                 UV uvc = 0;
2143                 STRLEN len = 0;
2144                 STRLEN foldlen = 0;
2145                 U8 *uscan = (U8*)NULL;
2146                 U8 *leftmost = NULL;
2147 #ifdef DEBUGGING
2148                 U32 accepted_word= 0;
2149 #endif
2150                 U32 pointpos = 0;
2151
2152                 while ( state && uc <= (U8*)strend ) {
2153                     int failed=0;
2154                     U32 word = aho->states[ state ].wordnum;
2155
2156                     if( state==1 ) {
2157                         if ( bitmap ) {
2158                             DEBUG_TRIE_EXECUTE_r(
2159                                 if ( uc <= (U8*)last_start && !BITMAP_TEST(bitmap,*uc) ) {
2160                                     dump_exec_pos( (char *)uc, c, strend, real_start,
2161                                         (char *)uc, utf8_target );
2162                                     PerlIO_printf( Perl_debug_log,
2163                                         " Scanning for legal start char...\n");
2164                                 }
2165                             );
2166                             if (utf8_target) {
2167                                 while ( uc <= (U8*)last_start && !BITMAP_TEST(bitmap,*uc) ) {
2168                                     uc += UTF8SKIP(uc);
2169                                 }
2170                             } else {
2171                                 while ( uc <= (U8*)last_start  && !BITMAP_TEST(bitmap,*uc) ) {
2172                                     uc++;
2173                                 }
2174                             }
2175                             s= (char *)uc;
2176                         }
2177                         if (uc >(U8*)last_start) break;
2178                     }
2179
2180                     if ( word ) {
2181                         U8 *lpos= points[ (pointpos - trie->wordinfo[word].len) % maxlen ];
2182                         if (!leftmost || lpos < leftmost) {
2183                             DEBUG_r(accepted_word=word);
2184                             leftmost= lpos;
2185                         }
2186                         if (base==0) break;
2187
2188                     }
2189                     points[pointpos++ % maxlen]= uc;
2190                     if (foldlen || uc < (U8*)strend) {
2191                         REXEC_TRIE_READ_CHAR(trie_type, trie,
2192                                          widecharmap, uc,
2193                                          uscan, len, uvc, charid, foldlen,
2194                                          foldbuf, uniflags);
2195                         DEBUG_TRIE_EXECUTE_r({
2196                             dump_exec_pos( (char *)uc, c, strend,
2197                                         real_start, s, utf8_target);
2198                             PerlIO_printf(Perl_debug_log,
2199                                 " Charid:%3u CP:%4"UVxf" ",
2200                                  charid, uvc);
2201                         });
2202                     }
2203                     else {
2204                         len = 0;
2205                         charid = 0;
2206                     }
2207
2208
2209                     do {
2210 #ifdef DEBUGGING
2211                         word = aho->states[ state ].wordnum;
2212 #endif
2213                         base = aho->states[ state ].trans.base;
2214
2215                         DEBUG_TRIE_EXECUTE_r({
2216                             if (failed)
2217                                 dump_exec_pos( (char *)uc, c, strend, real_start,
2218                                     s,   utf8_target );
2219                             PerlIO_printf( Perl_debug_log,
2220                                 "%sState: %4"UVxf", word=%"UVxf,
2221                                 failed ? " Fail transition to " : "",
2222                                 (UV)state, (UV)word);
2223                         });
2224                         if ( base ) {
2225                             U32 tmp;
2226                             I32 offset;
2227                             if (charid &&
2228                                  ( ((offset = base + charid
2229                                     - 1 - trie->uniquecharcount)) >= 0)
2230                                  && ((U32)offset < trie->lasttrans)
2231                                  && trie->trans[offset].check == state
2232                                  && (tmp=trie->trans[offset].next))
2233                             {
2234                                 DEBUG_TRIE_EXECUTE_r(
2235                                     PerlIO_printf( Perl_debug_log," - legal\n"));
2236                                 state = tmp;
2237                                 break;
2238                             }
2239                             else {
2240                                 DEBUG_TRIE_EXECUTE_r(
2241                                     PerlIO_printf( Perl_debug_log," - fail\n"));
2242                                 failed = 1;
2243                                 state = aho->fail[state];
2244                             }
2245                         }
2246                         else {
2247                             /* we must be accepting here */
2248                             DEBUG_TRIE_EXECUTE_r(
2249                                     PerlIO_printf( Perl_debug_log," - accepting\n"));
2250                             failed = 1;
2251                             break;
2252                         }
2253                     } while(state);
2254                     uc += len;
2255                     if (failed) {
2256                         if (leftmost)
2257                             break;
2258                         if (!state) state = 1;
2259                     }
2260                 }
2261                 if ( aho->states[ state ].wordnum ) {
2262                     U8 *lpos = points[ (pointpos - trie->wordinfo[aho->states[ state ].wordnum].len) % maxlen ];
2263                     if (!leftmost || lpos < leftmost) {
2264                         DEBUG_r(accepted_word=aho->states[ state ].wordnum);
2265                         leftmost = lpos;
2266                     }
2267                 }
2268                 if (leftmost) {
2269                     s = (char*)leftmost;
2270                     DEBUG_TRIE_EXECUTE_r({
2271                         PerlIO_printf(
2272                             Perl_debug_log,"Matches word #%"UVxf" at position %"IVdf". Trying full pattern...\n",
2273                             (UV)accepted_word, (IV)(s - real_start)
2274                         );
2275                     });
2276                     if (reginfo->intuit || regtry(reginfo, &s)) {
2277                         FREETMPS;
2278                         LEAVE;
2279                         goto got_it;
2280                     }
2281                     s = HOPc(s,1);
2282                     DEBUG_TRIE_EXECUTE_r({
2283                         PerlIO_printf( Perl_debug_log,"Pattern failed. Looking for new start point...\n");
2284                     });
2285                 } else {
2286                     DEBUG_TRIE_EXECUTE_r(
2287                         PerlIO_printf( Perl_debug_log,"No match.\n"));
2288                     break;
2289                 }
2290             }
2291             FREETMPS;
2292             LEAVE;
2293         }
2294         break;
2295     default:
2296         Perl_croak(aTHX_ "panic: unknown regstclass %d", (int)OP(c));
2297     }
2298     return 0;
2299   got_it:
2300     return s;
2301 }
2302
2303 /* set RX_SAVED_COPY, RX_SUBBEG etc.
2304  * flags have same meanings as with regexec_flags() */
2305
2306 static void
2307 S_reg_set_capture_string(pTHX_ REGEXP * const rx,
2308                             char *strbeg,
2309                             char *strend,
2310                             SV *sv,
2311                             U32 flags,
2312                             bool utf8_target)
2313 {
2314     struct regexp *const prog = ReANY(rx);
2315
2316     if (flags & REXEC_COPY_STR) {
2317 #ifdef PERL_ANY_COW
2318         if (SvCANCOW(sv)) {
2319             if (DEBUG_C_TEST) {
2320                 PerlIO_printf(Perl_debug_log,
2321                               "Copy on write: regexp capture, type %d\n",
2322                               (int) SvTYPE(sv));
2323             }
2324             /* Create a new COW SV to share the match string and store
2325              * in saved_copy, unless the current COW SV in saved_copy
2326              * is valid and suitable for our purpose */
2327             if ((   prog->saved_copy
2328                  && SvIsCOW(prog->saved_copy)
2329                  && SvPOKp(prog->saved_copy)
2330                  && SvIsCOW(sv)
2331                  && SvPOKp(sv)
2332                  && SvPVX(sv) == SvPVX(prog->saved_copy)))
2333             {
2334                 /* just reuse saved_copy SV */
2335                 if (RXp_MATCH_COPIED(prog)) {
2336                     Safefree(prog->subbeg);
2337                     RXp_MATCH_COPIED_off(prog);
2338                 }
2339             }
2340             else {
2341                 /* create new COW SV to share string */
2342                 RX_MATCH_COPY_FREE(rx);
2343                 prog->saved_copy = sv_setsv_cow(prog->saved_copy, sv);
2344             }
2345             prog->subbeg = (char *)SvPVX_const(prog->saved_copy);
2346             assert (SvPOKp(prog->saved_copy));
2347             prog->sublen  = strend - strbeg;
2348             prog->suboffset = 0;
2349             prog->subcoffset = 0;
2350         } else
2351 #endif
2352         {
2353             SSize_t min = 0;
2354             SSize_t max = strend - strbeg;
2355             SSize_t sublen;
2356
2357             if (    (flags & REXEC_COPY_SKIP_POST)
2358                 && !(prog->extflags & RXf_PMf_KEEPCOPY) /* //p */
2359                 && !(PL_sawampersand & SAWAMPERSAND_RIGHT)
2360             ) { /* don't copy $' part of string */
2361                 U32 n = 0;
2362                 max = -1;
2363                 /* calculate the right-most part of the string covered
2364                  * by a capture. Due to look-ahead, this may be to
2365                  * the right of $&, so we have to scan all captures */
2366                 while (n <= prog->lastparen) {
2367                     if (prog->offs[n].end > max)
2368                         max = prog->offs[n].end;
2369                     n++;
2370                 }
2371                 if (max == -1)
2372                     max = (PL_sawampersand & SAWAMPERSAND_LEFT)
2373                             ? prog->offs[0].start
2374                             : 0;
2375                 assert(max >= 0 && max <= strend - strbeg);
2376             }
2377
2378             if (    (flags & REXEC_COPY_SKIP_PRE)
2379                 && !(prog->extflags & RXf_PMf_KEEPCOPY) /* //p */
2380                 && !(PL_sawampersand & SAWAMPERSAND_LEFT)
2381             ) { /* don't copy $` part of string */
2382                 U32 n = 0;
2383                 min = max;
2384                 /* calculate the left-most part of the string covered
2385                  * by a capture. Due to look-behind, this may be to
2386                  * the left of $&, so we have to scan all captures */
2387                 while (min && n <= prog->lastparen) {
2388                     if (   prog->offs[n].start != -1
2389                         && prog->offs[n].start < min)
2390                     {
2391                         min = prog->offs[n].start;
2392                     }
2393                     n++;
2394                 }
2395                 if ((PL_sawampersand & SAWAMPERSAND_RIGHT)
2396                     && min >  prog->offs[0].end
2397                 )
2398                     min = prog->offs[0].end;
2399
2400             }
2401
2402             assert(min >= 0 && min <= max && min <= strend - strbeg);
2403             sublen = max - min;
2404
2405             if (RX_MATCH_COPIED(rx)) {
2406                 if (sublen > prog->sublen)
2407                     prog->subbeg =
2408                             (char*)saferealloc(prog->subbeg, sublen+1);
2409             }
2410             else
2411                 prog->subbeg = (char*)safemalloc(sublen+1);
2412             Copy(strbeg + min, prog->subbeg, sublen, char);
2413             prog->subbeg[sublen] = '\0';
2414             prog->suboffset = min;
2415             prog->sublen = sublen;
2416             RX_MATCH_COPIED_on(rx);
2417         }
2418         prog->subcoffset = prog->suboffset;
2419         if (prog->suboffset && utf8_target) {
2420             /* Convert byte offset to chars.
2421              * XXX ideally should only compute this if @-/@+
2422              * has been seen, a la PL_sawampersand ??? */
2423
2424             /* If there's a direct correspondence between the
2425              * string which we're matching and the original SV,
2426              * then we can use the utf8 len cache associated with
2427              * the SV. In particular, it means that under //g,
2428              * sv_pos_b2u() will use the previously cached
2429              * position to speed up working out the new length of
2430              * subcoffset, rather than counting from the start of
2431              * the string each time. This stops
2432              *   $x = "\x{100}" x 1E6; 1 while $x =~ /(.)/g;
2433              * from going quadratic */
2434             if (SvPOKp(sv) && SvPVX(sv) == strbeg)
2435                 prog->subcoffset = sv_pos_b2u_flags(sv, prog->subcoffset,
2436                                                 SV_GMAGIC|SV_CONST_RETURN);
2437             else
2438                 prog->subcoffset = utf8_length((U8*)strbeg,
2439                                     (U8*)(strbeg+prog->suboffset));
2440         }
2441     }
2442     else {
2443         RX_MATCH_COPY_FREE(rx);
2444         prog->subbeg = strbeg;
2445         prog->suboffset = 0;
2446         prog->subcoffset = 0;
2447         prog->sublen = strend - strbeg;
2448     }
2449 }
2450
2451
2452
2453
2454 /*
2455  - regexec_flags - match a regexp against a string
2456  */
2457 I32
2458 Perl_regexec_flags(pTHX_ REGEXP * const rx, char *stringarg, char *strend,
2459               char *strbeg, SSize_t minend, SV *sv, void *data, U32 flags)
2460 /* stringarg: the point in the string at which to begin matching */
2461 /* strend:    pointer to null at end of string */
2462 /* strbeg:    real beginning of string */
2463 /* minend:    end of match must be >= minend bytes after stringarg. */
2464 /* sv:        SV being matched: only used for utf8 flag, pos() etc; string
2465  *            itself is accessed via the pointers above */
2466 /* data:      May be used for some additional optimizations.
2467               Currently unused. */
2468 /* flags:     For optimizations. See REXEC_* in regexp.h */
2469
2470 {
2471     struct regexp *const prog = ReANY(rx);
2472     char *s;
2473     regnode *c;
2474     char *startpos;
2475     SSize_t minlen;             /* must match at least this many chars */
2476     SSize_t dontbother = 0;     /* how many characters not to try at end */
2477     const bool utf8_target = cBOOL(DO_UTF8(sv));
2478     I32 multiline;
2479     RXi_GET_DECL(prog,progi);
2480     regmatch_info reginfo_buf;  /* create some info to pass to regtry etc */
2481     regmatch_info *const reginfo = &reginfo_buf;
2482     regexp_paren_pair *swap = NULL;
2483     I32 oldsave;
2484     GET_RE_DEBUG_FLAGS_DECL;
2485
2486     PERL_ARGS_ASSERT_REGEXEC_FLAGS;
2487     PERL_UNUSED_ARG(data);
2488
2489     /* Be paranoid... */
2490     if (prog == NULL || stringarg == NULL) {
2491         Perl_croak(aTHX_ "NULL regexp parameter");
2492     }
2493
2494     DEBUG_EXECUTE_r(
2495         debug_start_match(rx, utf8_target, stringarg, strend,
2496         "Matching");
2497     );
2498
2499     startpos = stringarg;
2500
2501     if (prog->intflags & PREGf_GPOS_SEEN) {
2502         MAGIC *mg;
2503
2504         /* set reginfo->ganch, the position where \G can match */
2505
2506         reginfo->ganch =
2507             (flags & REXEC_IGNOREPOS)
2508             ? stringarg /* use start pos rather than pos() */
2509             : (sv && (mg = mg_find_mglob(sv)) && mg->mg_len >= 0)
2510               /* Defined pos(): */
2511             ? strbeg + MgBYTEPOS(mg, sv, strbeg, strend-strbeg)
2512             : strbeg; /* pos() not defined; use start of string */
2513
2514         DEBUG_GPOS_r(PerlIO_printf(Perl_debug_log,
2515             "GPOS ganch set to strbeg[%"IVdf"]\n", (IV)(reginfo->ganch - strbeg)));
2516
2517         /* in the presence of \G, we may need to start looking earlier in
2518          * the string than the suggested start point of stringarg:
2519          * if prog->gofs is set, then that's a known, fixed minimum
2520          * offset, such as
2521          * /..\G/:   gofs = 2
2522          * /ab|c\G/: gofs = 1
2523          * or if the minimum offset isn't known, then we have to go back
2524          * to the start of the string, e.g. /w+\G/
2525          */
2526
2527         if (prog->intflags & PREGf_ANCH_GPOS) {
2528             startpos  = reginfo->ganch - prog->gofs;
2529             if (startpos <
2530                 ((flags & REXEC_FAIL_ON_UNDERFLOW) ? stringarg : strbeg))
2531             {
2532                 DEBUG_r(PerlIO_printf(Perl_debug_log,
2533                         "fail: ganch-gofs before earliest possible start\n"));
2534                 return 0;
2535             }
2536         }
2537         else if (prog->gofs) {
2538             if (startpos - prog->gofs < strbeg)
2539                 startpos = strbeg;
2540             else
2541                 startpos -= prog->gofs;
2542         }
2543         else if (prog->intflags & PREGf_GPOS_FLOAT)
2544             startpos = strbeg;
2545     }
2546
2547     minlen = prog->minlen;
2548     if ((startpos + minlen) > strend || startpos < strbeg) {
2549         DEBUG_r(PerlIO_printf(Perl_debug_log,
2550                     "Regex match can't succeed, so not even tried\n"));
2551         return 0;
2552     }
2553
2554     /* at the end of this function, we'll do a LEAVE_SCOPE(oldsave),
2555      * which will call destuctors to reset PL_regmatch_state, free higher
2556      * PL_regmatch_slabs, and clean up regmatch_info_aux and
2557      * regmatch_info_aux_eval */
2558
2559     oldsave = PL_savestack_ix;
2560
2561     s = startpos;
2562
2563     if ((prog->extflags & RXf_USE_INTUIT)
2564         && !(flags & REXEC_CHECKED))
2565     {
2566         s = re_intuit_start(rx, sv, strbeg, startpos, strend,
2567                                     flags, NULL);
2568         if (!s)
2569             return 0;
2570
2571         if (prog->extflags & RXf_CHECK_ALL) {
2572             /* we can match based purely on the result of INTUIT.
2573              * Set up captures etc just for $& and $-[0]
2574              * (an intuit-only match wont have $1,$2,..) */
2575             assert(!prog->nparens);
2576
2577             /* s/// doesn't like it if $& is earlier than where we asked it to
2578              * start searching (which can happen on something like /.\G/) */
2579             if (       (flags & REXEC_FAIL_ON_UNDERFLOW)
2580                     && (s < stringarg))
2581             {
2582                 /* this should only be possible under \G */
2583                 assert(prog->intflags & PREGf_GPOS_SEEN);
2584                 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
2585                     "matched, but failing for REXEC_FAIL_ON_UNDERFLOW\n"));
2586                 goto phooey;
2587             }
2588
2589             /* match via INTUIT shouldn't have any captures.
2590              * Let @-, @+, $^N know */
2591             prog->lastparen = prog->lastcloseparen = 0;
2592             RX_MATCH_UTF8_set(rx, utf8_target);
2593             prog->offs[0].start = s - strbeg;
2594             prog->offs[0].end = utf8_target
2595                 ? (char*)utf8_hop((U8*)s, prog->minlenret) - strbeg
2596                 : s - strbeg + prog->minlenret;
2597             if ( !(flags & REXEC_NOT_FIRST) )
2598                 S_reg_set_capture_string(aTHX_ rx,
2599                                         strbeg, strend,
2600                                         sv, flags, utf8_target);
2601
2602             return 1;
2603         }
2604     }
2605
2606     multiline = prog->extflags & RXf_PMf_MULTILINE;
2607     
2608     if (strend - s < (minlen+(prog->check_offset_min<0?prog->check_offset_min:0))) {
2609         DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
2610                               "String too short [regexec_flags]...\n"));
2611         goto phooey;
2612     }
2613     
2614     /* Check validity of program. */
2615     if (UCHARAT(progi->program) != REG_MAGIC) {
2616         Perl_croak(aTHX_ "corrupted regexp program");
2617     }
2618
2619     RX_MATCH_TAINTED_off(rx);
2620
2621     reginfo->prog = rx;  /* Yes, sorry that this is confusing.  */
2622     reginfo->intuit = 0;
2623     reginfo->is_utf8_target = cBOOL(utf8_target);
2624     reginfo->is_utf8_pat = cBOOL(RX_UTF8(rx));
2625     reginfo->warned = FALSE;
2626     reginfo->strbeg  = strbeg;
2627     reginfo->sv = sv;
2628     reginfo->poscache_maxiter = 0; /* not yet started a countdown */
2629     reginfo->strend = strend;
2630     /* see how far we have to get to not match where we matched before */
2631     reginfo->till = stringarg + minend;
2632
2633     if (prog->extflags & RXf_EVAL_SEEN && SvPADTMP(sv)) {
2634         /* SAVEFREESV, not sv_mortalcopy, as this SV must last until after
2635            S_cleanup_regmatch_info_aux has executed (registered by
2636            SAVEDESTRUCTOR_X below).  S_cleanup_regmatch_info_aux modifies
2637            magic belonging to this SV.
2638            Not newSVsv, either, as it does not COW.
2639         */
2640         reginfo->sv = newSV(0);
2641         SvSetSV_nosteal(reginfo->sv, sv);
2642         SAVEFREESV(reginfo->sv);
2643     }
2644
2645     /* reserve next 2 or 3 slots in PL_regmatch_state:
2646      * slot N+0: may currently be in use: skip it
2647      * slot N+1: use for regmatch_info_aux struct
2648      * slot N+2: use for regmatch_info_aux_eval struct if we have (?{})'s
2649      * slot N+3: ready for use by regmatch()
2650      */
2651
2652     {
2653         regmatch_state *old_regmatch_state;
2654         regmatch_slab  *old_regmatch_slab;
2655         int i, max = (prog->extflags & RXf_EVAL_SEEN) ? 2 : 1;
2656
2657         /* on first ever match, allocate first slab */
2658         if (!PL_regmatch_slab) {
2659             Newx(PL_regmatch_slab, 1, regmatch_slab);
2660             PL_regmatch_slab->prev = NULL;
2661             PL_regmatch_slab->next = NULL;
2662             PL_regmatch_state = SLAB_FIRST(PL_regmatch_slab);
2663         }
2664
2665         old_regmatch_state = PL_regmatch_state;
2666         old_regmatch_slab  = PL_regmatch_slab;
2667
2668         for (i=0; i <= max; i++) {
2669             if (i == 1)
2670                 reginfo->info_aux = &(PL_regmatch_state->u.info_aux);
2671             else if (i ==2)
2672                 reginfo->info_aux_eval =
2673                 reginfo->info_aux->info_aux_eval =
2674                             &(PL_regmatch_state->u.info_aux_eval);
2675
2676             if (++PL_regmatch_state >  SLAB_LAST(PL_regmatch_slab))
2677                 PL_regmatch_state = S_push_slab(aTHX);
2678         }
2679
2680         /* note initial PL_regmatch_state position; at end of match we'll
2681          * pop back to there and free any higher slabs */
2682
2683         reginfo->info_aux->old_regmatch_state = old_regmatch_state;
2684         reginfo->info_aux->old_regmatch_slab  = old_regmatch_slab;
2685         reginfo->info_aux->poscache = NULL;
2686
2687         SAVEDESTRUCTOR_X(S_cleanup_regmatch_info_aux, reginfo->info_aux);
2688
2689         if ((prog->extflags & RXf_EVAL_SEEN))
2690             S_setup_eval_state(aTHX_ reginfo);
2691         else
2692             reginfo->info_aux_eval = reginfo->info_aux->info_aux_eval = NULL;
2693     }
2694
2695     /* If there is a "must appear" string, look for it. */
2696
2697     if (PL_curpm && (PM_GETRE(PL_curpm) == rx)) {
2698         /* We have to be careful. If the previous successful match
2699            was from this regex we don't want a subsequent partially
2700            successful match to clobber the old results.
2701            So when we detect this possibility we add a swap buffer
2702            to the re, and switch the buffer each match. If we fail,
2703            we switch it back; otherwise we leave it swapped.
2704         */
2705         swap = prog->offs;
2706         /* do we need a save destructor here for eval dies? */
2707         Newxz(prog->offs, (prog->nparens + 1), regexp_paren_pair);
2708         DEBUG_BUFFERS_r(PerlIO_printf(Perl_debug_log,
2709             "rex=0x%"UVxf" saving  offs: orig=0x%"UVxf" new=0x%"UVxf"\n",
2710             PTR2UV(prog),
2711             PTR2UV(swap),
2712             PTR2UV(prog->offs)
2713         ));
2714     }
2715
2716     /* Simplest case:  anchored match need be tried only once. */
2717     /*  [unless only anchor is MBOL - implying multiline is set] */
2718     if (prog->intflags & (PREGf_ANCH & ~PREGf_ANCH_GPOS)) {
2719         if (s == startpos && regtry(reginfo, &s))
2720             goto got_it;
2721         else if (multiline || (prog->intflags & (PREGf_IMPLICIT | PREGf_ANCH_MBOL))) /* XXXX SBOL? */
2722         {
2723             char *end;
2724
2725             if (minlen)
2726                 dontbother = minlen - 1;
2727             end = HOP3c(strend, -dontbother, strbeg) - 1;
2728             /* for multiline we only have to try after newlines */
2729             if (prog->check_substr || prog->check_utf8) {
2730                 /* because of the goto we can not easily reuse the macros for bifurcating the
2731                    unicode/non-unicode match modes here like we do elsewhere - demerphq */
2732                 if (utf8_target) {
2733                     if (s == startpos)
2734                         goto after_try_utf8;
2735                     while (1) {
2736                         if (regtry(reginfo, &s)) {
2737                             goto got_it;
2738                         }
2739                       after_try_utf8:
2740                         if (s > end) {
2741                             goto phooey;
2742                         }
2743                         if (prog->extflags & RXf_USE_INTUIT) {
2744                             s = re_intuit_start(rx, sv, strbeg,
2745                                     s + UTF8SKIP(s), strend, flags, NULL);
2746                             if (!s) {
2747                                 goto phooey;
2748                             }
2749                         }
2750                         else {
2751                             s += UTF8SKIP(s);
2752                         }
2753                     }
2754                 } /* end search for check string in unicode */
2755                 else {
2756                     if (s == startpos) {
2757                         goto after_try_latin;
2758                     }
2759                     while (1) {
2760                         if (regtry(reginfo, &s)) {
2761                             goto got_it;
2762                         }
2763                       after_try_latin:
2764                         if (s > end) {
2765                             goto phooey;
2766                         }
2767                         if (prog->extflags & RXf_USE_INTUIT) {
2768                             s = re_intuit_start(rx, sv, strbeg,
2769                                         s + 1, strend, flags, NULL);
2770                             if (!s) {
2771                                 goto phooey;
2772                             }
2773                         }
2774                         else {
2775                             s++;
2776                         }
2777                     }
2778                 } /* end search for check string in latin*/
2779             } /* end search for check string */
2780             else { /* search for newline */
2781                 if (s > startpos) {
2782                     /*XXX: The s-- is almost definitely wrong here under unicode - demeprhq*/
2783                     s--;
2784                 }
2785                 /* We can use a more efficient search as newlines are the same in unicode as they are in latin */
2786                 while (s <= end) { /* note it could be possible to match at the end of the string */
2787                     if (*s++ == '\n') { /* don't need PL_utf8skip here */
2788                         if (regtry(reginfo, &s))
2789                             goto got_it;
2790                     }
2791                 }
2792             } /* end search for newline */
2793         } /* end anchored/multiline check string search */
2794         goto phooey;
2795     } else if (prog->intflags & PREGf_ANCH_GPOS)
2796     {
2797         /* PREGf_ANCH_GPOS should never be true if PREGf_GPOS_SEEN is not true */
2798         assert(prog->intflags & PREGf_GPOS_SEEN);
2799         /* For anchored \G, the only position it can match from is
2800          * (ganch-gofs); we already set startpos to this above; if intuit
2801          * moved us on from there, we can't possibly succeed */
2802         assert(startpos == reginfo->ganch - prog->gofs);
2803         if (s == startpos && regtry(reginfo, &s))
2804             goto got_it;
2805         goto phooey;
2806     }
2807
2808     /* Messy cases:  unanchored match. */
2809     if ((prog->anchored_substr || prog->anchored_utf8) && prog->intflags & PREGf_SKIP) {
2810         /* we have /x+whatever/ */
2811         /* it must be a one character string (XXXX Except is_utf8_pat?) */
2812         char ch;
2813 #ifdef DEBUGGING
2814         int did_match = 0;
2815 #endif
2816         if (utf8_target) {
2817             if (! prog->anchored_utf8) {
2818                 to_utf8_substr(prog);
2819             }
2820             ch = SvPVX_const(prog->anchored_utf8)[0];
2821             REXEC_FBC_SCAN(
2822                 if (*s == ch) {
2823                     DEBUG_EXECUTE_r( did_match = 1 );
2824                     if (regtry(reginfo, &s)) goto got_it;
2825                     s += UTF8SKIP(s);
2826                     while (s < strend && *s == ch)
2827                         s += UTF8SKIP(s);
2828                 }
2829             );
2830
2831         }
2832         else {
2833             if (! prog->anchored_substr) {
2834                 if (! to_byte_substr(prog)) {
2835                     NON_UTF8_TARGET_BUT_UTF8_REQUIRED(phooey);
2836                 }
2837             }
2838             ch = SvPVX_const(prog->anchored_substr)[0];
2839             REXEC_FBC_SCAN(
2840                 if (*s == ch) {
2841                     DEBUG_EXECUTE_r( did_match = 1 );
2842                     if (regtry(reginfo, &s)) goto got_it;
2843                     s++;
2844                     while (s < strend && *s == ch)
2845                         s++;
2846                 }
2847             );
2848         }
2849         DEBUG_EXECUTE_r(if (!did_match)
2850                 PerlIO_printf(Perl_debug_log,
2851                                   "Did not find anchored character...\n")
2852                );
2853     }
2854     else if (prog->anchored_substr != NULL
2855               || prog->anchored_utf8 != NULL
2856               || ((prog->float_substr != NULL || prog->float_utf8 != NULL)
2857                   && prog->float_max_offset < strend - s)) {
2858         SV *must;
2859         SSize_t back_max;
2860         SSize_t back_min;
2861         char *last;
2862         char *last1;            /* Last position checked before */
2863 #ifdef DEBUGGING
2864         int did_match = 0;
2865 #endif
2866         if (prog->anchored_substr || prog->anchored_utf8) {
2867             if (utf8_target) {
2868                 if (! prog->anchored_utf8) {
2869                     to_utf8_substr(prog);
2870                 }
2871                 must = prog->anchored_utf8;
2872             }
2873             else {
2874                 if (! prog->anchored_substr) {
2875                     if (! to_byte_substr(prog)) {
2876                         NON_UTF8_TARGET_BUT_UTF8_REQUIRED(phooey);
2877                     }
2878                 }
2879                 must = prog->anchored_substr;
2880             }
2881             back_max = back_min = prog->anchored_offset;
2882         } else {
2883             if (utf8_target) {
2884                 if (! prog->float_utf8) {
2885                     to_utf8_substr(prog);
2886                 }
2887                 must = prog->float_utf8;
2888             }
2889             else {
2890                 if (! prog->float_substr) {
2891                     if (! to_byte_substr(prog)) {
2892                         NON_UTF8_TARGET_BUT_UTF8_REQUIRED(phooey);
2893                     }
2894                 }
2895                 must = prog->float_substr;
2896             }
2897             back_max = prog->float_max_offset;
2898             back_min = prog->float_min_offset;
2899         }
2900             
2901         if (back_min<0) {
2902             last = strend;
2903         } else {
2904             last = HOP3c(strend,        /* Cannot start after this */
2905                   -(SSize_t)(CHR_SVLEN(must)
2906                          - (SvTAIL(must) != 0) + back_min), strbeg);
2907         }
2908         if (s > reginfo->strbeg)
2909             last1 = HOPc(s, -1);
2910         else
2911             last1 = s - 1;      /* bogus */
2912
2913         /* XXXX check_substr already used to find "s", can optimize if
2914            check_substr==must. */
2915         dontbother = 0;
2916         strend = HOPc(strend, -dontbother);
2917         while ( (s <= last) &&
2918                 (s = fbm_instr((unsigned char*)HOP4c(s, back_min, strbeg,  strend),
2919                                   (unsigned char*)strend, must,
2920                                   multiline ? FBMrf_MULTILINE : 0)) ) {
2921             DEBUG_EXECUTE_r( did_match = 1 );
2922             if (HOPc(s, -back_max) > last1) {
2923                 last1 = HOPc(s, -back_min);
2924                 s = HOPc(s, -back_max);
2925             }
2926             else {
2927                 char * const t = (last1 >= reginfo->strbeg)
2928                                     ? HOPc(last1, 1) : last1 + 1;
2929
2930                 last1 = HOPc(s, -back_min);
2931                 s = t;
2932             }
2933             if (utf8_target) {
2934                 while (s <= last1) {
2935                     if (regtry(reginfo, &s))
2936                         goto got_it;
2937                     if (s >= last1) {
2938                         s++; /* to break out of outer loop */
2939                         break;
2940                     }
2941                     s += UTF8SKIP(s);
2942                 }
2943             }
2944             else {
2945                 while (s <= last1) {
2946                     if (regtry(reginfo, &s))
2947                         goto got_it;
2948                     s++;
2949                 }
2950             }
2951         }
2952         DEBUG_EXECUTE_r(if (!did_match) {
2953             RE_PV_QUOTED_DECL(quoted, utf8_target, PERL_DEBUG_PAD_ZERO(0),
2954                 SvPVX_const(must), RE_SV_DUMPLEN(must), 30);
2955             PerlIO_printf(Perl_debug_log, "Did not find %s substr %s%s...\n",
2956                               ((must == prog->anchored_substr || must == prog->anchored_utf8)
2957                                ? "anchored" : "floating"),
2958                 quoted, RE_SV_TAIL(must));
2959         });                 
2960         goto phooey;
2961     }
2962     else if ( (c = progi->regstclass) ) {
2963         if (minlen) {
2964             const OPCODE op = OP(progi->regstclass);
2965             /* don't bother with what can't match */
2966             if (PL_regkind[op] != EXACT && op != CANY && PL_regkind[op] != TRIE)
2967                 strend = HOPc(strend, -(minlen - 1));
2968         }
2969         DEBUG_EXECUTE_r({
2970             SV * const prop = sv_newmortal();
2971             regprop(prog, prop, c, reginfo);
2972             {
2973                 RE_PV_QUOTED_DECL(quoted,utf8_target,PERL_DEBUG_PAD_ZERO(1),
2974                     s,strend-s,60);
2975                 PerlIO_printf(Perl_debug_log,
2976                     "Matching stclass %.*s against %s (%d bytes)\n",
2977                     (int)SvCUR(prop), SvPVX_const(prop),
2978                      quoted, (int)(strend - s));
2979             }
2980         });
2981         if (find_byclass(prog, c, s, strend, reginfo))
2982             goto got_it;
2983         DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Contradicts stclass... [regexec_flags]\n"));
2984     }
2985     else {
2986         dontbother = 0;
2987         if (prog->float_substr != NULL || prog->float_utf8 != NULL) {
2988             /* Trim the end. */
2989             char *last= NULL;
2990             SV* float_real;
2991             STRLEN len;
2992             const char *little;
2993
2994             if (utf8_target) {
2995                 if (! prog->float_utf8) {
2996                     to_utf8_substr(prog);
2997                 }
2998                 float_real = prog->float_utf8;
2999             }
3000             else {
3001                 if (! prog->float_substr) {
3002                     if (! to_byte_substr(prog)) {
3003                         NON_UTF8_TARGET_BUT_UTF8_REQUIRED(phooey);
3004                     }
3005                 }
3006                 float_real = prog->float_substr;
3007             }
3008
3009             little = SvPV_const(float_real, len);
3010             if (SvTAIL(float_real)) {
3011                     /* This means that float_real contains an artificial \n on
3012                      * the end due to the presence of something like this:
3013                      * /foo$/ where we can match both "foo" and "foo\n" at the
3014                      * end of the string.  So we have to compare the end of the
3015                      * string first against the float_real without the \n and
3016                      * then against the full float_real with the string.  We
3017                      * have to watch out for cases where the string might be
3018                      * smaller than the float_real or the float_real without
3019                      * the \n. */
3020                     char *checkpos= strend - len;
3021                     DEBUG_OPTIMISE_r(
3022                         PerlIO_printf(Perl_debug_log,
3023                             "%sChecking for float_real.%s\n",
3024                             PL_colors[4], PL_colors[5]));
3025                     if (checkpos + 1 < strbeg) {
3026                         /* can't match, even if we remove the trailing \n
3027                          * string is too short to match */
3028                         DEBUG_EXECUTE_r(
3029                             PerlIO_printf(Perl_debug_log,
3030                                 "%sString shorter than required trailing substring, cannot match.%s\n",
3031                                 PL_colors[4], PL_colors[5]));
3032                         goto phooey;
3033                     } else if (memEQ(checkpos + 1, little, len - 1)) {
3034                         /* can match, the end of the string matches without the
3035                          * "\n" */
3036                         last = checkpos + 1;
3037                     } else if (checkpos < strbeg) {
3038                         /* cant match, string is too short when the "\n" is
3039                          * included */
3040                         DEBUG_EXECUTE_r(
3041                             PerlIO_printf(Perl_debug_log,
3042                                 "%sString does not contain required trailing substring, cannot match.%s\n",
3043                                 PL_colors[4], PL_colors[5]));
3044                         goto phooey;
3045                     } else if (!multiline) {
3046                         /* non multiline match, so compare with the "\n" at the
3047                          * end of the string */
3048                         if (memEQ(checkpos, little, len)) {
3049                             last= checkpos;
3050                         } else {
3051                             DEBUG_EXECUTE_r(
3052                                 PerlIO_printf(Perl_debug_log,
3053                                     "%sString does not contain required trailing substring, cannot match.%s\n",
3054                                     PL_colors[4], PL_colors[5]));
3055                             goto phooey;
3056                         }
3057                     } else {
3058                         /* multiline match, so we have to search for a place
3059                          * where the full string is located */
3060                         goto find_last;
3061                     }
3062             } else {
3063                   find_last:
3064                     if (len)
3065                         last = rninstr(s, strend, little, little + len);
3066                     else
3067                         last = strend;  /* matching "$" */
3068             }
3069             if (!last) {
3070                 /* at one point this block contained a comment which was
3071                  * probably incorrect, which said that this was a "should not
3072                  * happen" case.  Even if it was true when it was written I am
3073                  * pretty sure it is not anymore, so I have removed the comment
3074                  * and replaced it with this one. Yves */
3075                 DEBUG_EXECUTE_r(
3076                     PerlIO_printf(Perl_debug_log,
3077                         "%sString does not contain required substring, cannot match.%s\n",
3078                         PL_colors[4], PL_colors[5]
3079                     ));
3080                 goto phooey;
3081             }
3082             dontbother = strend - last + prog->float_min_offset;
3083         }
3084         if (minlen && (dontbother < minlen))
3085             dontbother = minlen - 1;
3086         strend -= dontbother;              /* this one's always in bytes! */
3087         /* We don't know much -- general case. */
3088         if (utf8_target) {
3089             for (;;) {
3090                 if (regtry(reginfo, &s))
3091                     goto got_it;
3092                 if (s >= strend)
3093                     break;
3094                 s += UTF8SKIP(s);
3095             };
3096         }
3097         else {
3098             do {
3099                 if (regtry(reginfo, &s))
3100                     goto got_it;
3101             } while (s++ < strend);
3102         }
3103     }
3104
3105     /* Failure. */
3106     goto phooey;
3107
3108 got_it:
3109     /* s/// doesn't like it if $& is earlier than where we asked it to
3110      * start searching (which can happen on something like /.\G/) */
3111     if (       (flags & REXEC_FAIL_ON_UNDERFLOW)
3112             && (prog->offs[0].start < stringarg - strbeg))
3113     {
3114         /* this should only be possible under \G */
3115         assert(prog->intflags & PREGf_GPOS_SEEN);
3116         DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
3117             "matched, but failing for REXEC_FAIL_ON_UNDERFLOW\n"));
3118         goto phooey;
3119     }
3120
3121     DEBUG_BUFFERS_r(
3122         if (swap)
3123             PerlIO_printf(Perl_debug_log,
3124                 "rex=0x%"UVxf" freeing offs: 0x%"UVxf"\n",
3125                 PTR2UV(prog),
3126                 PTR2UV(swap)
3127             );
3128     );
3129     Safefree(swap);
3130
3131     /* clean up; this will trigger destructors that will free all slabs
3132      * above the current one, and cleanup the regmatch_info_aux
3133      * and regmatch_info_aux_eval sructs */
3134
3135     LEAVE_SCOPE(oldsave);
3136
3137     if (RXp_PAREN_NAMES(prog)) 
3138         (void)hv_iterinit(RXp_PAREN_NAMES(prog));
3139
3140     RX_MATCH_UTF8_set(rx, utf8_target);
3141
3142     /* make sure $`, $&, $', and $digit will work later */
3143     if ( !(flags & REXEC_NOT_FIRST) )
3144         S_reg_set_capture_string(aTHX_ rx,
3145                                     strbeg, reginfo->strend,
3146                                     sv, flags, utf8_target);
3147
3148     return 1;
3149
3150 phooey:
3151     DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "%sMatch failed%s\n",
3152                           PL_colors[4], PL_colors[5]));
3153
3154     /* clean up; this will trigger destructors that will free all slabs
3155      * above the current one, and cleanup the regmatch_info_aux
3156      * and regmatch_info_aux_eval sructs */
3157
3158     LEAVE_SCOPE(oldsave);
3159
3160     if (swap) {
3161         /* we failed :-( roll it back */
3162         DEBUG_BUFFERS_r(PerlIO_printf(Perl_debug_log,
3163             "rex=0x%"UVxf" rolling back offs: freeing=0x%"UVxf" restoring=0x%"UVxf"\n",
3164             PTR2UV(prog),
3165             PTR2UV(prog->offs),
3166             PTR2UV(swap)
3167         ));
3168         Safefree(prog->offs);
3169         prog->offs = swap;
3170     }
3171     return 0;
3172 }
3173
3174
3175 /* Set which rex is pointed to by PL_reg_curpm, handling ref counting.
3176  * Do inc before dec, in case old and new rex are the same */
3177 #define SET_reg_curpm(Re2)                          \
3178     if (reginfo->info_aux_eval) {                   \
3179         (void)ReREFCNT_inc(Re2);                    \
3180         ReREFCNT_dec(PM_GETRE(PL_reg_curpm));       \
3181         PM_SETRE((PL_reg_curpm), (Re2));            \
3182     }
3183
3184
3185 /*
3186  - regtry - try match at specific point
3187  */
3188 STATIC I32                      /* 0 failure, 1 success */
3189 S_regtry(pTHX_ regmatch_info *reginfo, char **startposp)
3190 {
3191     CHECKPOINT lastcp;
3192     REGEXP *const rx = reginfo->prog;
3193     regexp *const prog = ReANY(rx);
3194     SSize_t result;
3195     RXi_GET_DECL(prog,progi);
3196     GET_RE_DEBUG_FLAGS_DECL;
3197
3198     PERL_ARGS_ASSERT_REGTRY;
3199
3200     reginfo->cutpoint=NULL;
3201
3202     prog->offs[0].start = *startposp - reginfo->strbeg;
3203     prog->lastparen = 0;
3204     prog->lastcloseparen = 0;
3205
3206     /* XXXX What this code is doing here?!!!  There should be no need
3207        to do this again and again, prog->lastparen should take care of
3208        this!  --ilya*/
3209
3210     /* Tests pat.t#187 and split.t#{13,14} seem to depend on this code.
3211      * Actually, the code in regcppop() (which Ilya may be meaning by
3212      * prog->lastparen), is not needed at all by the test suite
3213      * (op/regexp, op/pat, op/split), but that code is needed otherwise
3214      * this erroneously leaves $1 defined: "1" =~ /^(?:(\d)x)?\d$/
3215      * Meanwhile, this code *is* needed for the
3216      * above-mentioned test suite tests to succeed.  The common theme
3217      * on those tests seems to be returning null fields from matches.
3218      * --jhi updated by dapm */
3219 #if 1
3220     if (prog->nparens) {
3221         regexp_paren_pair *pp = prog->offs;
3222         I32 i;
3223         for (i = prog->nparens; i > (I32)prog->lastparen; i--) {
3224             ++pp;
3225             pp->start = -1;
3226             pp->end = -1;
3227         }
3228     }
3229 #endif
3230     REGCP_SET(lastcp);
3231     result = regmatch(reginfo, *startposp, progi->program + 1);
3232     if (result != -1) {
3233         prog->offs[0].end = result;
3234         return 1;
3235     }
3236     if (reginfo->cutpoint)
3237         *startposp= reginfo->cutpoint;
3238     REGCP_UNWIND(lastcp);
3239     return 0;
3240 }
3241
3242
3243 #define sayYES goto yes
3244 #define sayNO goto no
3245 #define sayNO_SILENT goto no_silent
3246
3247 /* we dont use STMT_START/END here because it leads to 
3248    "unreachable code" warnings, which are bogus, but distracting. */
3249 #define CACHEsayNO \
3250     if (ST.cache_mask) \
3251        reginfo->info_aux->poscache[ST.cache_offset] |= ST.cache_mask; \
3252     sayNO
3253
3254 /* this is used to determine how far from the left messages like
3255    'failed...' are printed. It should be set such that messages 
3256    are inline with the regop output that created them.
3257 */
3258 #define REPORT_CODE_OFF 32
3259
3260
3261 #define CHRTEST_UNINIT -1001 /* c1/c2 haven't been calculated yet */
3262 #define CHRTEST_VOID   -1000 /* the c1/c2 "next char" test should be skipped */
3263 #define CHRTEST_NOT_A_CP_1 -999
3264 #define CHRTEST_NOT_A_CP_2 -998
3265
3266 /* grab a new slab and return the first slot in it */
3267
3268 STATIC regmatch_state *
3269 S_push_slab(pTHX)
3270 {
3271 #if PERL_VERSION < 9 && !defined(PERL_CORE)
3272     dMY_CXT;
3273 #endif
3274     regmatch_slab *s = PL_regmatch_slab->next;
3275     if (!s) {
3276         Newx(s, 1, regmatch_slab);
3277         s->prev = PL_regmatch_slab;
3278         s->next = NULL;
3279         PL_regmatch_slab->next = s;
3280     }
3281     PL_regmatch_slab = s;
3282     return SLAB_FIRST(s);
3283 }
3284
3285
3286 /* push a new state then goto it */
3287
3288 #define PUSH_STATE_GOTO(state, node, input) \
3289     pushinput = input; \
3290     scan = node; \
3291     st->resume_state = state; \
3292     goto push_state;
3293
3294 /* push a new state with success backtracking, then goto it */
3295
3296 #define PUSH_YES_STATE_GOTO(state, node, input) \
3297     pushinput = input; \
3298     scan = node; \
3299     st->resume_state = state; \
3300     goto push_yes_state;
3301
3302
3303
3304
3305 /*
3306
3307 regmatch() - main matching routine
3308
3309 This is basically one big switch statement in a loop. We execute an op,
3310 set 'next' to point the next op, and continue. If we come to a point which
3311 we may need to backtrack to on failure such as (A|B|C), we push a
3312 backtrack state onto the backtrack stack. On failure, we pop the top
3313 state, and re-enter the loop at the state indicated. If there are no more
3314 states to pop, we return failure.
3315
3316 Sometimes we also need to backtrack on success; for example /A+/, where
3317 after successfully matching one A, we need to go back and try to
3318 match another one; similarly for lookahead assertions: if the assertion
3319 completes successfully, we backtrack to the state just before the assertion
3320 and then carry on.  In these cases, the pushed state is marked as
3321 'backtrack on success too'. This marking is in fact done by a chain of
3322 pointers, each pointing to the previous 'yes' state. On success, we pop to
3323 the nearest yes state, discarding any intermediate failure-only states.
3324 Sometimes a yes state is pushed just to force some cleanup code to be
3325 called at the end of a successful match or submatch; e.g. (??{$re}) uses
3326 it to free the inner regex.
3327
3328 Note that failure backtracking rewinds the cursor position, while
3329 success backtracking leaves it alone.
3330
3331 A pattern is complete when the END op is executed, while a subpattern
3332 such as (?=foo) is complete when the SUCCESS op is executed. Both of these
3333 ops trigger the "pop to last yes state if any, otherwise return true"
3334 behaviour.
3335
3336 A common convention in this function is to use A and B to refer to the two
3337 subpatterns (or to the first nodes thereof) in patterns like /A*B/: so A is
3338 the subpattern to be matched possibly multiple times, while B is the entire
3339 rest of the pattern. Variable and state names reflect this convention.
3340
3341 The states in the main switch are the union of ops and failure/success of
3342 substates associated with with that op.  For example, IFMATCH is the op
3343 that does lookahead assertions /(?=A)B/ and so the IFMATCH state means
3344 'execute IFMATCH'; while IFMATCH_A is a state saying that we have just
3345 successfully matched A and IFMATCH_A_fail is a state saying that we have
3346 just failed to match A. Resume states always come in pairs. The backtrack
3347 state we push is marked as 'IFMATCH_A', but when that is popped, we resume
3348 at IFMATCH_A or IFMATCH_A_fail, depending on whether we are backtracking
3349 on success or failure.
3350
3351 The struct that holds a backtracking state is actually a big union, with
3352 one variant for each major type of op. The variable st points to the
3353 top-most backtrack struct. To make the code clearer, within each
3354 block of code we #define ST to alias the relevant union.
3355
3356 Here's a concrete example of a (vastly oversimplified) IFMATCH
3357 implementation:
3358
3359     switch (state) {
3360     ....
3361
3362 #define ST st->u.ifmatch
3363
3364     case IFMATCH: // we are executing the IFMATCH op, (?=A)B
3365         ST.foo = ...; // some state we wish to save
3366         ...
3367         // push a yes backtrack state with a resume value of
3368         // IFMATCH_A/IFMATCH_A_fail, then continue execution at the
3369         // first node of A:
3370         PUSH_YES_STATE_GOTO(IFMATCH_A, A, newinput);
3371         // NOTREACHED
3372
3373     case IFMATCH_A: // we have successfully executed A; now continue with B
3374         next = B;
3375         bar = ST.foo; // do something with the preserved value
3376         break;
3377
3378     case IFMATCH_A_fail: // A failed, so the assertion failed
3379         ...;   // do some housekeeping, then ...
3380         sayNO; // propagate the failure
3381
3382 #undef ST
3383
3384     ...
3385     }
3386
3387 For any old-timers reading this who are familiar with the old recursive
3388 approach, the code above is equivalent to:
3389
3390     case IFMATCH: // we are executing the IFMATCH op, (?=A)B
3391     {
3392         int foo = ...
3393         ...
3394         if (regmatch(A)) {
3395             next = B;
3396             bar = foo;
3397             break;
3398         }
3399         ...;   // do some housekeeping, then ...
3400         sayNO; // propagate the failure
3401     }
3402
3403 The topmost backtrack state, pointed to by st, is usually free. If you
3404 want to claim it, populate any ST.foo fields in it with values you wish to
3405 save, then do one of
3406
3407         PUSH_STATE_GOTO(resume_state, node, newinput);
3408         PUSH_YES_STATE_GOTO(resume_state, node, newinput);
3409
3410 which sets that backtrack state's resume value to 'resume_state', pushes a
3411 new free entry to the top of the backtrack stack, then goes to 'node'.
3412 On backtracking, the free slot is popped, and the saved state becomes the
3413 new free state. An ST.foo field in this new top state can be temporarily
3414 accessed to retrieve values, but once the main loop is re-entered, it
3415 becomes available for reuse.
3416
3417 Note that the depth of the backtrack stack constantly increases during the
3418 left-to-right execution of the pattern, rather than going up and down with
3419 the pattern nesting. For example the stack is at its maximum at Z at the
3420 end of the pattern, rather than at X in the following:
3421
3422     /(((X)+)+)+....(Y)+....Z/
3423
3424 The only exceptions to this are lookahead/behind assertions and the cut,
3425 (?>A), which pop all the backtrack states associated with A before
3426 continuing.
3427  
3428 Backtrack state structs are allocated in slabs of about 4K in size.
3429 PL_regmatch_state and st always point to the currently active state,
3430 and PL_regmatch_slab points to the slab currently containing
3431 PL_regmatch_state.  The first time regmatch() is called, the first slab is
3432 allocated, and is never freed until interpreter destruction. When the slab
3433 is full, a new one is allocated and chained to the end. At exit from
3434 regmatch(), slabs allocated since entry are freed.
3435
3436 */
3437  
3438
3439 #define DEBUG_STATE_pp(pp)                                  \
3440     DEBUG_STATE_r({                                         \
3441         DUMP_EXEC_POS(locinput, scan, utf8_target);         \
3442         PerlIO_printf(Perl_debug_log,                       \
3443             "    %*s"pp" %s%s%s%s%s\n",                     \
3444             depth*2, "",                                    \
3445             PL_reg_name[st->resume_state],                  \
3446             ((st==yes_state||st==mark_state) ? "[" : ""),   \
3447             ((st==yes_state) ? "Y" : ""),                   \
3448             ((st==mark_state) ? "M" : ""),                  \
3449             ((st==yes_state||st==mark_state) ? "]" : "")    \
3450         );                                                  \
3451     });
3452
3453
3454 #define REG_NODE_NUM(x) ((x) ? (int)((x)-prog) : -1)
3455
3456 #ifdef DEBUGGING
3457
3458 STATIC void
3459 S_debug_start_match(pTHX_ const REGEXP *prog, const bool utf8_target,
3460     const char *start, const char *end, const char *blurb)
3461 {
3462     const bool utf8_pat = RX_UTF8(prog) ? 1 : 0;
3463
3464     PERL_ARGS_ASSERT_DEBUG_START_MATCH;
3465
3466     if (!PL_colorset)   
3467             reginitcolors();    
3468     {
3469         RE_PV_QUOTED_DECL(s0, utf8_pat, PERL_DEBUG_PAD_ZERO(0), 
3470             RX_PRECOMP_const(prog), RX_PRELEN(prog), 60);   
3471         
3472         RE_PV_QUOTED_DECL(s1, utf8_target, PERL_DEBUG_PAD_ZERO(1),
3473             start, end - start, 60); 
3474         
3475         PerlIO_printf(Perl_debug_log, 
3476             "%s%s REx%s %s against %s\n", 
3477                        PL_colors[4], blurb, PL_colors[5], s0, s1); 
3478         
3479         if (utf8_target||utf8_pat)
3480             PerlIO_printf(Perl_debug_log, "UTF-8 %s%s%s...\n",
3481                 utf8_pat ? "pattern" : "",
3482                 utf8_pat && utf8_target ? " and " : "",
3483                 utf8_target ? "string" : ""
3484             ); 
3485     }
3486 }
3487
3488 STATIC void
3489 S_dump_exec_pos(pTHX_ const char *locinput, 
3490                       const regnode *scan, 
3491                       const char *loc_regeol, 
3492                       const char *loc_bostr, 
3493                       const char *loc_reg_starttry,
3494                       const bool utf8_target)
3495 {
3496     const int docolor = *PL_colors[0] || *PL_colors[2] || *PL_colors[4];
3497     const int taill = (docolor ? 10 : 7); /* 3 chars for "> <" */
3498     int l = (loc_regeol - locinput) > taill ? taill : (loc_regeol - locinput);
3499     /* The part of the string before starttry has one color
3500        (pref0_len chars), between starttry and current
3501        position another one (pref_len - pref0_len chars),
3502        after the current position the third one.
3503        We assume that pref0_len <= pref_len, otherwise we
3504        decrease pref0_len.  */
3505     int pref_len = (locinput - loc_bostr) > (5 + taill) - l
3506         ? (5 + taill) - l : locinput - loc_bostr;
3507     int pref0_len;
3508
3509     PERL_ARGS_ASSERT_DUMP_EXEC_POS;
3510
3511     while (utf8_target && UTF8_IS_CONTINUATION(*(U8*)(locinput - pref_len)))
3512         pref_len++;
3513     pref0_len = pref_len  - (locinput - loc_reg_starttry);
3514     if (l + pref_len < (5 + taill) && l < loc_regeol - locinput)
3515         l = ( loc_regeol - locinput > (5 + taill) - pref_len
3516               ? (5 + taill) - pref_len : loc_regeol - locinput);
3517     while (utf8_target && UTF8_IS_CONTINUATION(*(U8*)(locinput + l)))
3518         l--;
3519     if (pref0_len < 0)
3520         pref0_len = 0;
3521     if (pref0_len > pref_len)
3522         pref0_len = pref_len;
3523     {
3524         const int is_uni = (utf8_target && OP(scan) != CANY) ? 1 : 0;
3525
3526         RE_PV_COLOR_DECL(s0,len0,is_uni,PERL_DEBUG_PAD(0),
3527             (locinput - pref_len),pref0_len, 60, 4, 5);
3528         
3529         RE_PV_COLOR_DECL(s1,len1,is_uni,PERL_DEBUG_PAD(1),
3530                     (locinput - pref_len + pref0_len),
3531                     pref_len - pref0_len, 60, 2, 3);
3532         
3533         RE_PV_COLOR_DECL(s2,len2,is_uni,PERL_DEBUG_PAD(2),
3534                     locinput, loc_regeol - locinput, 10, 0, 1);
3535
3536         const STRLEN tlen=len0+len1+len2;
3537         PerlIO_printf(Perl_debug_log,
3538                     "%4"IVdf" <%.*s%.*s%s%.*s>%*s|",
3539                     (IV)(locinput - loc_bostr),
3540                     len0, s0,
3541                     len1, s1,
3542                     (docolor ? "" : "> <"),
3543                     len2, s2,
3544                     (int)(tlen > 19 ? 0 :  19 - tlen),
3545                     "");
3546     }
3547 }
3548
3549 #endif
3550
3551 /* reg_check_named_buff_matched()
3552  * Checks to see if a named buffer has matched. The data array of 
3553  * buffer numbers corresponding to the buffer is expected to reside
3554  * in the regexp->data->data array in the slot stored in the ARG() of
3555  * node involved. Note that this routine doesn't actually care about the
3556  * name, that information is not preserved from compilation to execution.
3557  * Returns the index of the leftmost defined buffer with the given name
3558  * or 0 if non of the buffers matched.
3559  */
3560 STATIC I32
3561 S_reg_check_named_buff_matched(const regexp *rex, const regnode *scan)
3562 {
3563     I32 n;
3564     RXi_GET_DECL(rex,rexi);
3565     SV *sv_dat= MUTABLE_SV(rexi->data->data[ ARG( scan ) ]);
3566     I32 *nums=(I32*)SvPVX(sv_dat);
3567
3568     PERL_ARGS_ASSERT_REG_CHECK_NAMED_BUFF_MATCHED;
3569
3570     for ( n=0; n<SvIVX(sv_dat); n++ ) {
3571         if ((I32)rex->lastparen >= nums[n] &&
3572             rex->offs[nums[n]].end != -1)
3573         {
3574             return nums[n];
3575         }
3576     }
3577     return 0;
3578 }
3579
3580
3581 static bool
3582 S_setup_EXACTISH_ST_c1_c2(pTHX_ const regnode * const text_node, int *c1p,
3583         U8* c1_utf8, int *c2p, U8* c2_utf8, regmatch_info *reginfo)
3584 {
3585     /* This function determines if there are one or two characters that match
3586      * the first character of the passed-in EXACTish node <text_node>, and if
3587      * so, returns them in the passed-in pointers.
3588      *
3589      * If it determines that no possible character in the target string can
3590      * match, it returns FALSE; otherwise TRUE.  (The FALSE situation occurs if
3591      * the first character in <text_node> requires UTF-8 to represent, and the
3592      * target string isn't in UTF-8.)
3593      *
3594      * If there are more than two characters that could match the beginning of
3595      * <text_node>, or if more context is required to determine a match or not,
3596      * it sets both *<c1p> and *<c2p> to CHRTEST_VOID.
3597      *
3598      * The motiviation behind this function is to allow the caller to set up
3599      * tight loops for matching.  If <text_node> is of type EXACT, there is
3600      * only one possible character that can match its first character, and so
3601      * the situation is quite simple.  But things get much more complicated if
3602      * folding is involved.  It may be that the first character of an EXACTFish
3603      * node doesn't participate in any possible fold, e.g., punctuation, so it
3604      * can be matched only by itself.  The vast majority of characters that are
3605      * in folds match just two things, their lower and upper-case equivalents.
3606      * But not all are like that; some have multiple possible matches, or match
3607      * sequences of more than one character.  This function sorts all that out.
3608      *
3609      * Consider the patterns A*B or A*?B where A and B are arbitrary.  In a
3610      * loop of trying to match A*, we know we can't exit where the thing
3611      * following it isn't a B.  And something can't be a B unless it is the
3612      * beginning of B.  By putting a quick test for that beginning in a tight
3613      * loop, we can rule out things that can't possibly be B without having to
3614      * break out of the loop, thus avoiding work.  Similarly, if A is a single
3615      * character, we can make a tight loop matching A*, using the outputs of
3616      * this function.
3617      *
3618      * If the target string to match isn't in UTF-8, and there aren't
3619      * complications which require CHRTEST_VOID, *<c1p> and *<c2p> are set to
3620      * the one or two possible octets (which are characters in this situation)
3621      * that can match.  In all cases, if there is only one character that can
3622      * match, *<c1p> and *<c2p> will be identical.
3623      *
3624      * If the target string is in UTF-8, the buffers pointed to by <c1_utf8>
3625      * and <c2_utf8> will contain the one or two UTF-8 sequences of bytes that
3626      * can match the beginning of <text_node>.  They should be declared with at
3627      * least length UTF8_MAXBYTES+1.  (If the target string isn't in UTF-8, it is
3628      * undefined what these contain.)  If one or both of the buffers are
3629      * invariant under UTF-8, *<c1p>, and *<c2p> will also be set to the
3630      * corresponding invariant.  If variant, the corresponding *<c1p> and/or
3631      * *<c2p> will be set to a negative number(s) that shouldn't match any code
3632      * point (unless inappropriately coerced to unsigned).   *<c1p> will equal
3633      * *<c2p> if and only if <c1_utf8> and <c2_utf8> are the same. */
3634
3635     const bool utf8_target = reginfo->is_utf8_target;
3636
3637     UV c1 = (UV)CHRTEST_NOT_A_CP_1;
3638     UV c2 = (UV)CHRTEST_NOT_A_CP_2;
3639     bool use_chrtest_void = FALSE;
3640     const bool is_utf8_pat = reginfo->is_utf8_pat;
3641
3642     /* Used when we have both utf8 input and utf8 output, to avoid converting
3643      * to/from code points */
3644     bool utf8_has_been_setup = FALSE;
3645
3646     dVAR;
3647
3648     U8 *pat = (U8*)STRING(text_node);
3649     U8 folded[UTF8_MAX_FOLD_CHAR_EXPAND * UTF8_MAXBYTES_CASE + 1] = { '\0' };
3650
3651     if (OP(text_node) == EXACT) {
3652
3653         /* In an exact node, only one thing can be matched, that first
3654          * character.  If both the pat and the target are UTF-8, we can just
3655          * copy the input to the output, avoiding finding the code point of
3656          * that character */
3657         if (!is_utf8_pat) {
3658             c2 = c1 = *pat;
3659         }
3660         else if (utf8_target) {
3661             Copy(pat, c1_utf8, UTF8SKIP(pat), U8);
3662             Copy(pat, c2_utf8, UTF8SKIP(pat), U8);
3663             utf8_has_been_setup = TRUE;
3664         }
3665         else {
3666             c2 = c1 = valid_utf8_to_uvchr(pat, NULL);
3667         }
3668     }
3669     else { /* an EXACTFish node */
3670         U8 *pat_end = pat + STR_LEN(text_node);
3671
3672         /* An EXACTFL node has at least some characters unfolded, because what
3673          * they match is not known until now.  So, now is the time to fold
3674          * the first few of them, as many as are needed to determine 'c1' and
3675          * 'c2' later in the routine.  If the pattern isn't UTF-8, we only need
3676          * to fold if in a UTF-8 locale, and then only the Sharp S; everything
3677          * else is 1-1 and isn't assumed to be folded.  In a UTF-8 pattern, we
3678          * need to fold as many characters as a single character can fold to,
3679          * so that later we can check if the first ones are such a multi-char
3680          * fold.  But, in such a pattern only locale-problematic characters
3681          * aren't folded, so we can skip this completely if the first character
3682          * in the node isn't one of the tricky ones */
3683         if (OP(text_node) == EXACTFL) {
3684
3685             if (! is_utf8_pat) {
3686                 if (IN_UTF8_CTYPE_LOCALE && *pat == LATIN_SMALL_LETTER_SHARP_S)
3687                 {
3688                     folded[0] = folded[1] = 's';
3689                     pat = folded;
3690                     pat_end = folded + 2;
3691                 }
3692             }
3693             else if (is_PROBLEMATIC_LOCALE_FOLDEDS_START_utf8(pat)) {
3694                 U8 *s = pat;
3695                 U8 *d = folded;
3696                 int i;
3697
3698                 for (i = 0; i < UTF8_MAX_FOLD_CHAR_EXPAND && s < pat_end; i++) {
3699                     if (isASCII(*s)) {
3700                         *(d++) = (U8) toFOLD_LC(*s);
3701                         s++;
3702                     }
3703                     else {
3704                         STRLEN len;
3705                         _to_utf8_fold_flags(s,
3706                                             d,
3707                                             &len,
3708                                             FOLD_FLAGS_FULL | FOLD_FLAGS_LOCALE);
3709                         d += len;
3710                         s += UTF8SKIP(s);
3711                     }
3712                 }
3713
3714                 pat = folded;
3715                 pat_end = d;
3716             }
3717         }
3718
3719         if ((is_utf8_pat && is_MULTI_CHAR_FOLD_utf8_safe(pat, pat_end))
3720              || (!is_utf8_pat && is_MULTI_CHAR_FOLD_latin1_safe(pat, pat_end)))
3721         {
3722             /* Multi-character folds require more context to sort out.  Also
3723              * PL_utf8_foldclosures used below doesn't handle them, so have to
3724              * be handled outside this routine */
3725             use_chrtest_void = TRUE;
3726         }
3727         else { /* an EXACTFish node which doesn't begin with a multi-char fold */
3728             c1 = is_utf8_pat ? valid_utf8_to_uvchr(pat, NULL) : *pat;
3729             if (c1 > 255) {
3730                 /* Load the folds hash, if not already done */
3731                 SV** listp;
3732                 if (! PL_utf8_foldclosures) {
3733                     _load_PL_utf8_foldclosures();
3734                 }
3735
3736                 /* The fold closures data structure is a hash with the keys
3737                  * being the UTF-8 of every character that is folded to, like
3738                  * 'k', and the values each an array of all code points that
3739                  * fold to its key.  e.g. [ 'k', 'K', KELVIN_SIGN ].
3740                  * Multi-character folds are not included */
3741                 if ((! (listp = hv_fetch(PL_utf8_foldclosures,
3742                                         (char *) pat,
3743                                         UTF8SKIP(pat),
3744                                         FALSE))))
3745                 {
3746                     /* Not found in the hash, therefore there are no folds
3747                     * containing it, so there is only a single character that
3748                     * could match */
3749                     c2 = c1;
3750                 }
3751                 else {  /* Does participate in folds */
3752                     AV* list = (AV*) *listp;
3753                     if (av_tindex(list) != 1) {
3754
3755                         /* If there aren't exactly two folds to this, it is
3756                          * outside the scope of this function */
3757                         use_chrtest_void = TRUE;
3758                     }
3759                     else {  /* There are two.  Get them */
3760                         SV** c_p = av_fetch(list, 0, FALSE);
3761                         if (c_p == NULL) {
3762                             Perl_croak(aTHX_ "panic: invalid PL_utf8_foldclosures structure");
3763                         }
3764                         c1 = SvUV(*c_p);
3765
3766                         c_p = av_fetch(list, 1, FALSE);
3767                         if (c_p == NULL) {
3768                             Perl_croak(aTHX_ "panic: invalid PL_utf8_foldclosures structure");
3769                         }
3770                         c2 = SvUV(*c_p);
3771
3772                         /* Folds that cross the 255/256 boundary are forbidden
3773                          * if EXACTFL (and isnt a UTF8 locale), or EXACTFA and
3774                          * one is ASCIII.  Since the pattern character is above
3775                          * 255, and its only other match is below 256, the only
3776                          * legal match will be to itself.  We have thrown away
3777                          * the original, so have to compute which is the one
3778                          * above 255. */
3779                         if ((c1 < 256) != (c2 < 256)) {
3780                             if ((OP(text_node) == EXACTFL
3781                                  && ! IN_UTF8_CTYPE_LOCALE)
3782                                 || ((OP(text_node) == EXACTFA
3783                                     || OP(text_node) == EXACTFA_NO_TRIE)
3784                                     && (isASCII(c1) || isASCII(c2))))
3785                             {
3786                                 if (c1 < 256) {
3787                                     c1 = c2;
3788                                 }
3789                                 else {
3790                                     c2 = c1;
3791                                 }
3792                             }
3793                         }
3794                     }
3795                 }
3796             }
3797             else /* Here, c1 is <= 255 */
3798                 if (utf8_target
3799                     && HAS_NONLATIN1_FOLD_CLOSURE(c1)
3800                     && ( ! (OP(text_node) == EXACTFL && ! IN_UTF8_CTYPE_LOCALE))
3801                     && ((OP(text_node) != EXACTFA
3802                         && OP(text_node) != EXACTFA_NO_TRIE)
3803                         || ! isASCII(c1)))
3804             {
3805                 /* Here, there could be something above Latin1 in the target
3806                  * which folds to this character in the pattern.  All such
3807                  * cases except LATIN SMALL LETTER Y WITH DIAERESIS have more
3808                  * than two characters involved in their folds, so are outside
3809                  * the scope of this function */
3810                 if (UNLIKELY(c1 == LATIN_SMALL_LETTER_Y_WITH_DIAERESIS)) {
3811                     c2 = LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS;
3812                 }
3813                 else {
3814                     use_chrtest_void = TRUE;
3815                 }
3816             }
3817             else { /* Here nothing above Latin1 can fold to the pattern
3818                       character */
3819                 switch (OP(text_node)) {
3820
3821                     case EXACTFL:   /* /l rules */
3822                         c2 = PL_fold_locale[c1];
3823                         break;
3824
3825                     case EXACTF:   /* This node only generated for non-utf8
3826                                     patterns */
3827                         assert(! is_utf8_pat);
3828                         if (! utf8_target) {    /* /d rules */
3829                             c2 = PL_fold[c1];
3830                             break;
3831                         }
3832                         /* FALLTHROUGH */
3833                         /* /u rules for all these.  This happens to work for
3834                         * EXACTFA as nothing in Latin1 folds to ASCII */
3835                     case EXACTFA_NO_TRIE:   /* This node only generated for
3836                                             non-utf8 patterns */
3837                         assert(! is_utf8_pat);
3838                         /* FALLTHROUGH */
3839                     case EXACTFA:
3840                     case EXACTFU_SS:
3841                     case EXACTFU:
3842                         c2 = PL_fold_latin1[c1];
3843                         break;
3844
3845                     default:
3846                         Perl_croak(aTHX_ "panic: Unexpected op %u", OP(text_node));
3847                         assert(0); /* NOTREACHED */
3848                 }
3849             }
3850         }
3851     }
3852
3853     /* Here have figured things out.  Set up the returns */
3854     if (use_chrtest_void) {
3855         *c2p = *c1p = CHRTEST_VOID;
3856     }
3857     else if (utf8_target) {
3858         if (! utf8_has_been_setup) {    /* Don't have the utf8; must get it */
3859             uvchr_to_utf8(c1_utf8, c1);
3860             uvchr_to_utf8(c2_utf8, c2);
3861         }
3862
3863         /* Invariants are stored in both the utf8 and byte outputs; Use
3864          * negative numbers otherwise for the byte ones.  Make sure that the
3865          * byte ones are the same iff the utf8 ones are the same */
3866         *c1p = (UTF8_IS_INVARIANT(*c1_utf8)) ? *c1_utf8 : CHRTEST_NOT_A_CP_1;
3867         *c2p = (UTF8_IS_INVARIANT(*c2_utf8))
3868                 ? *c2_utf8
3869                 : (c1 == c2)
3870                   ? CHRTEST_NOT_A_CP_1
3871                   : CHRTEST_NOT_A_CP_2;
3872     }
3873     else if (c1 > 255) {
3874        if (c2 > 255) {  /* both possibilities are above what a non-utf8 string
3875                            can represent */
3876            return FALSE;
3877        }
3878
3879        *c1p = *c2p = c2;    /* c2 is the only representable value */
3880     }
3881     else {  /* c1 is representable; see about c2 */
3882        *c1p = c1;
3883        *c2p = (c2 < 256) ? c2 : c1;
3884     }
3885
3886     return TRUE;
3887 }
3888
3889 /* returns -1 on failure, $+[0] on success */
3890 STATIC SSize_t
3891 S_regmatch(pTHX_ regmatch_info *reginfo, char *startpos, regnode *prog)
3892 {
3893 #if PERL_VERSION < 9 && !defined(PERL_CORE)
3894     dMY_CXT;
3895 #endif
3896     dVAR;
3897     const bool utf8_target = reginfo->is_utf8_target;
3898     const U32 uniflags = UTF8_ALLOW_DEFAULT;
3899     REGEXP *rex_sv = reginfo->prog;
3900     regexp *rex = ReANY(rex_sv);
3901     RXi_GET_DECL(rex,rexi);
3902     /* the current state. This is a cached copy of PL_regmatch_state */
3903     regmatch_state *st;
3904     /* cache heavy used fields of st in registers */
3905     regnode *scan;
3906     regnode *next;
3907     U32 n = 0;  /* general value; init to avoid compiler warning */
3908     SSize_t ln = 0; /* len or last;  init to avoid compiler warning */
3909     char *locinput = startpos;
3910     char *pushinput; /* where to continue after a PUSH */
3911     I32 nextchr;   /* is always set to UCHARAT(locinput) */
3912
3913     bool result = 0;        /* return value of S_regmatch */
3914     int depth = 0;          /* depth of backtrack stack */
3915     U32 nochange_depth = 0; /* depth of GOSUB recursion with nochange */
3916     const U32 max_nochange_depth =
3917         (3 * rex->nparens > MAX_RECURSE_EVAL_NOCHANGE_DEPTH) ?
3918         3 * rex->nparens : MAX_RECURSE_EVAL_NOCHANGE_DEPTH;
3919     regmatch_state *yes_state = NULL; /* state to pop to on success of
3920                                                             subpattern */
3921     /* mark_state piggy backs on the yes_state logic so that when we unwind 
3922        the stack on success we can update the mark_state as we go */
3923     regmatch_state *mark_state = NULL; /* last mark state we have seen */
3924     regmatch_state *cur_eval = NULL; /* most recent EVAL_AB state */
3925     struct regmatch_state  *cur_curlyx = NULL; /* most recent curlyx */
3926     U32 state_num;
3927     bool no_final = 0;      /* prevent failure from backtracking? */
3928     bool do_cutgroup = 0;   /* no_final only until next branch/trie entry */
3929     char *startpoint = locinput;
3930     SV *popmark = NULL;     /* are we looking for a mark? */
3931     SV *sv_commit = NULL;   /* last mark name seen in failure */
3932     SV *sv_yes_mark = NULL; /* last mark name we have seen 
3933                                during a successful match */
3934     U32 lastopen = 0;       /* last open we saw */
3935     bool has_cutgroup = RX_HAS_CUTGROUP(rex) ? 1 : 0;