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