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