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