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