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