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