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