Fix POSIX::mblen mbstate_t initialization on threaded perls with glibc
[perl.git] / regexec.c
1 /*    regexec.c
2  */
3
4 /*
5  *      One Ring to rule them all, One Ring to find them
6  *
7  *     [p.v of _The Lord of the Rings_, opening poem]
8  *     [p.50 of _The Lord of the Rings_, I/iii: "The Shadow of the Past"]
9  *     [p.254 of _The Lord of the Rings_, II/ii: "The Council of Elrond"]
10  */
11
12 /* This file contains functions for executing a regular expression.  See
13  * also regcomp.c which funnily enough, contains functions for compiling
14  * a regular expression.
15  *
16  * This file is also copied at build time to ext/re/re_exec.c, where
17  * it's built with -DPERL_EXT_RE_BUILD -DPERL_EXT_RE_DEBUG -DPERL_EXT.
18  * This causes the main functions to be compiled under new names and with
19  * debugging support added, which makes "use re 'debug'" work.
20  */
21
22 /* NOTE: this is derived from Henry Spencer's regexp code, and should not
23  * confused with the original package (see point 3 below).  Thanks, Henry!
24  */
25
26 /* Additional note: this code is very heavily munged from Henry's version
27  * in places.  In some spots I've traded clarity for efficiency, so don't
28  * blame Henry for some of the lack of readability.
29  */
30
31 /* The names of the functions have been changed from regcomp and
32  * regexec to  pregcomp and pregexec in order to avoid conflicts
33  * with the POSIX routines of the same names.
34 */
35
36 #ifdef PERL_EXT_RE_BUILD
37 #include "re_top.h"
38 #endif
39
40 /*
41  * pregcomp and pregexec -- regsub and regerror are not used in perl
42  *
43  *      Copyright (c) 1986 by University of Toronto.
44  *      Written by Henry Spencer.  Not derived from licensed software.
45  *
46  *      Permission is granted to anyone to use this software for any
47  *      purpose on any computer system, and to redistribute it freely,
48  *      subject to the following restrictions:
49  *
50  *      1. The author is not responsible for the consequences of use of
51  *              this software, no matter how awful, even if they arise
52  *              from defects in it.
53  *
54  *      2. The origin of this software must not be misrepresented, either
55  *              by explicit claim or by omission.
56  *
57  *      3. Altered versions must be plainly marked as such, and must not
58  *              be misrepresented as being the original software.
59  *
60  ****    Alterations to Henry's code are...
61  ****
62  ****    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
63  ****    2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
64  ****    by Larry Wall and others
65  ****
66  ****    You may distribute under the terms of either the GNU General Public
67  ****    License or the Artistic License, as specified in the README file.
68  *
69  * Beware that some of this code is subtly aware of the way operator
70  * precedence is structured in regular expressions.  Serious changes in
71  * regular-expression syntax might require a total rethink.
72  */
73 #include "EXTERN.h"
74 #define PERL_IN_REGEXEC_C
75 #include "perl.h"
76
77 #ifdef PERL_IN_XSUB_RE
78 #  include "re_comp.h"
79 #else
80 #  include "regcomp.h"
81 #endif
82
83 #include "invlist_inline.h"
84 #include "unicode_constants.h"
85
86 #define B_ON_NON_UTF8_LOCALE_IS_WRONG            \
87  "Use of \\b{} or \\B{} for non-UTF-8 locale is wrong.  Assuming a UTF-8 locale"
88
89 static const char utf8_locale_required[] =
90       "Use of (?[ ]) for non-UTF-8 locale is wrong.  Assuming a UTF-8 locale";
91
92 #ifdef DEBUGGING
93 /* At least one required character in the target string is expressible only in
94  * UTF-8. */
95 static const char 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 (utf8_target ? 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
1188         /* if "other" is anchored:
1189          * we've previously found a floating substr starting at check_at.
1190          * This means that the regex origin must lie somewhere
1191          * between min (rx_origin): HOP3(check_at, -check_offset_max)
1192          * and max:                 HOP3(check_at, -check_offset_min)
1193          * (except that min will be >= strpos)
1194          * So the fixed  substr must lie somewhere between
1195          *  HOP3(min, anchored_offset)
1196          *  HOP3(max, anchored_offset) + SvCUR(substr)
1197          */
1198
1199         /* if "other" is floating
1200          * Calculate last1, the absolute latest point where the
1201          * floating substr could start in the string, ignoring any
1202          * constraints from the earlier fixed match. It is calculated
1203          * as follows:
1204          *
1205          * strend - prog->minlen (in chars) is the absolute latest
1206          * position within the string where the origin of the regex
1207          * could appear. The latest start point for the floating
1208          * substr is float_min_offset(*) on from the start of the
1209          * regex.  last1 simply combines thee two offsets.
1210          *
1211          * (*) You might think the latest start point should be
1212          * float_max_offset from the regex origin, and technically
1213          * you'd be correct. However, consider
1214          *    /a\d{2,4}bcd\w/
1215          * Here, float min, max are 3,5 and minlen is 7.
1216          * This can match either
1217          *    /a\d\dbcd\w/
1218          *    /a\d\d\dbcd\w/
1219          *    /a\d\d\d\dbcd\w/
1220          * In the first case, the regex matches minlen chars; in the
1221          * second, minlen+1, in the third, minlen+2.
1222          * In the first case, the floating offset is 3 (which equals
1223          * float_min), in the second, 4, and in the third, 5 (which
1224          * equals float_max). In all cases, the floating string bcd
1225          * can never start more than 4 chars from the end of the
1226          * string, which equals minlen - float_min. As the substring
1227          * starts to match more than float_min from the start of the
1228          * regex, it makes the regex match more than minlen chars,
1229          * and the two cancel each other out. So we can always use
1230          * float_min - minlen, rather than float_max - minlen for the
1231          * latest position in the string.
1232          *
1233          * Note that -minlen + float_min_offset is equivalent (AFAIKT)
1234          * to CHR_SVLEN(must) - !!SvTAIL(must) + prog->float_end_shift
1235          */
1236
1237         assert(prog->minlen >= other->min_offset);
1238         last1 = HOP3c(strend,
1239                         other->min_offset - prog->minlen, strbeg);
1240
1241         if (other_ix) {/* i.e. if (other-is-float) */
1242             /* last is the latest point where the floating substr could
1243              * start, *given* any constraints from the earlier fixed
1244              * match. This constraint is that the floating string starts
1245              * <= float_max_offset chars from the regex origin (rx_origin).
1246              * If this value is less than last1, use it instead.
1247              */
1248             assert(rx_origin <= last1);
1249             last =
1250                 /* this condition handles the offset==infinity case, and
1251                  * is a short-cut otherwise. Although it's comparing a
1252                  * byte offset to a char length, it does so in a safe way,
1253                  * since 1 char always occupies 1 or more bytes,
1254                  * so if a string range is  (last1 - rx_origin) bytes,
1255                  * it will be less than or equal to  (last1 - rx_origin)
1256                  * chars; meaning it errs towards doing the accurate HOP3
1257                  * rather than just using last1 as a short-cut */
1258                 (last1 - rx_origin) < other->max_offset
1259                     ? last1
1260                     : (char*)HOP3lim(rx_origin, other->max_offset, last1);
1261         }
1262         else {
1263             assert(strpos + start_shift <= check_at);
1264             last = HOP4c(check_at, other->min_offset - start_shift,
1265                         strbeg, strend);
1266         }
1267
1268         s = HOP3c(rx_origin, other->min_offset, strend);
1269         if (s < other_last)     /* These positions already checked */
1270             s = other_last;
1271
1272         must = utf8_target ? other->utf8_substr : other->substr;
1273         assert(SvPOK(must));
1274         {
1275             char *from = s;
1276             char *to   = last + SvCUR(must) - (SvTAIL(must)!=0);
1277
1278             if (to > strend)
1279                 to = strend;
1280             if (from > to) {
1281                 s = NULL;
1282                 DEBUG_EXECUTE_r(Perl_re_printf( aTHX_
1283                     "  skipping 'other' fbm scan: %" IVdf " > %" IVdf "\n",
1284                     (IV)(from - strbeg),
1285                     (IV)(to   - strbeg)
1286                 ));
1287             }
1288             else {
1289                 s = fbm_instr(
1290                     (unsigned char*)from,
1291                     (unsigned char*)to,
1292                     must,
1293                     multiline ? FBMrf_MULTILINE : 0
1294                 );
1295                 DEBUG_EXECUTE_r(Perl_re_printf( aTHX_
1296                     "  doing 'other' fbm scan, [%" IVdf "..%" IVdf "] gave %" IVdf "\n",
1297                     (IV)(from - strbeg),
1298                     (IV)(to   - strbeg),
1299                     (IV)(s ? s - strbeg : -1)
1300                 ));
1301             }
1302         }
1303
1304         DEBUG_EXECUTE_r({
1305             RE_PV_QUOTED_DECL(quoted, utf8_target, PERL_DEBUG_PAD_ZERO(0),
1306                 SvPVX_const(must), RE_SV_DUMPLEN(must), 30);
1307             Perl_re_printf( aTHX_  "  %s %s substr %s%s",
1308                 s ? "Found" : "Contradicts",
1309                 other_ix ? "floating" : "anchored",
1310                 quoted, RE_SV_TAIL(must));
1311         });
1312
1313
1314         if (!s) {
1315             /* last1 is latest possible substr location. If we didn't
1316              * find it before there, we never will */
1317             if (last >= last1) {
1318                 DEBUG_EXECUTE_r(Perl_re_printf( aTHX_
1319                                         "; giving up...\n"));
1320                 goto fail_finish;
1321             }
1322
1323             /* try to find the check substr again at a later
1324              * position. Maybe next time we'll find the "other" substr
1325              * in range too */
1326             other_last = HOP3c(last, 1, strend) /* highest failure */;
1327             rx_origin =
1328                 other_ix /* i.e. if other-is-float */
1329                     ? HOP3c(rx_origin, 1, strend)
1330                     : HOP4c(last, 1 - other->min_offset, strbeg, strend);
1331             DEBUG_EXECUTE_r(Perl_re_printf( aTHX_
1332                 "; about to retry %s at offset %ld (rx_origin now %" IVdf ")...\n",
1333                 (other_ix ? "floating" : "anchored"),
1334                 (long)(HOP3c(check_at, 1, strend) - strbeg),
1335                 (IV)(rx_origin - strbeg)
1336             ));
1337             goto restart;
1338         }
1339         else {
1340             if (other_ix) { /* if (other-is-float) */
1341                 /* other_last is set to s, not s+1, since its possible for
1342                  * a floating substr to fail first time, then succeed
1343                  * second time at the same floating position; e.g.:
1344                  *     "-AB--AABZ" =~ /\wAB\d*Z/
1345                  * The first time round, anchored and float match at
1346                  * "-(AB)--AAB(Z)" then fail on the initial \w character
1347                  * class. Second time round, they match at "-AB--A(AB)(Z)".
1348                  */
1349                 other_last = s;
1350             }
1351             else {
1352                 rx_origin = HOP3c(s, -other->min_offset, strbeg);
1353                 other_last = HOP3c(s, 1, strend);
1354             }
1355             DEBUG_EXECUTE_r(Perl_re_printf( aTHX_
1356                 " at offset %ld (rx_origin now %" IVdf ")...\n",
1357                   (long)(s - strbeg),
1358                 (IV)(rx_origin - strbeg)
1359               ));
1360
1361         }
1362     }
1363     else {
1364         DEBUG_OPTIMISE_MORE_r(
1365             Perl_re_printf( aTHX_
1366                 "  Check-only match: offset min:%" IVdf " max:%" IVdf
1367                 " check_at:%" IVdf " rx_origin:%" IVdf " rx_origin-check_at:%" IVdf
1368                 " strend:%" IVdf "\n",
1369                 (IV)prog->check_offset_min,
1370                 (IV)prog->check_offset_max,
1371                 (IV)(check_at-strbeg),
1372                 (IV)(rx_origin-strbeg),
1373                 (IV)(rx_origin-check_at),
1374                 (IV)(strend-strbeg)
1375             )
1376         );
1377     }
1378
1379   postprocess_substr_matches:
1380
1381     /* handle the extra constraint of /^.../m if present */
1382
1383     if (ml_anch && rx_origin != strbeg && rx_origin[-1] != '\n') {
1384         char *s;
1385
1386         DEBUG_EXECUTE_r(Perl_re_printf( aTHX_
1387                         "  looking for /^/m anchor"));
1388
1389         /* we have failed the constraint of a \n before rx_origin.
1390          * Find the next \n, if any, even if it's beyond the current
1391          * anchored and/or floating substrings. Whether we should be
1392          * scanning ahead for the next \n or the next substr is debatable.
1393          * On the one hand you'd expect rare substrings to appear less
1394          * often than \n's. On the other hand, searching for \n means
1395          * we're effectively flipping between check_substr and "\n" on each
1396          * iteration as the current "rarest" string candidate, which
1397          * means for example that we'll quickly reject the whole string if
1398          * hasn't got a \n, rather than trying every substr position
1399          * first
1400          */
1401
1402         s = HOP3c(strend, - prog->minlen, strpos);
1403         if (s <= rx_origin ||
1404             ! ( rx_origin = (char *)memchr(rx_origin, '\n', s - rx_origin)))
1405         {
1406             DEBUG_EXECUTE_r(Perl_re_printf( aTHX_
1407                             "  Did not find /%s^%s/m...\n",
1408                             PL_colors[0], PL_colors[1]));
1409             goto fail_finish;
1410         }
1411
1412         /* earliest possible origin is 1 char after the \n.
1413          * (since *rx_origin == '\n', it's safe to ++ here rather than
1414          * HOP(rx_origin, 1)) */
1415         rx_origin++;
1416
1417         if (prog->substrs->check_ix == 0  /* check is anchored */
1418             || rx_origin >= HOP3c(check_at,  - prog->check_offset_min, strpos))
1419         {
1420             /* Position contradicts check-string; either because
1421              * check was anchored (and thus has no wiggle room),
1422              * or check was float and rx_origin is above the float range */
1423             DEBUG_EXECUTE_r(Perl_re_printf( aTHX_
1424                 "  Found /%s^%s/m, about to restart lookup for check-string with rx_origin %ld...\n",
1425                 PL_colors[0], PL_colors[1], (long)(rx_origin - strbeg)));
1426             goto restart;
1427         }
1428
1429         /* if we get here, the check substr must have been float,
1430          * is in range, and we may or may not have had an anchored
1431          * "other" substr which still contradicts */
1432         assert(prog->substrs->check_ix); /* check is float */
1433
1434         if (utf8_target ? prog->anchored_utf8 : prog->anchored_substr) {
1435             /* whoops, the anchored "other" substr exists, so we still
1436              * contradict. On the other hand, the float "check" substr
1437              * didn't contradict, so just retry the anchored "other"
1438              * substr */
1439             DEBUG_EXECUTE_r(Perl_re_printf( aTHX_
1440                 "  Found /%s^%s/m, rescanning for anchored from offset %" IVdf " (rx_origin now %" IVdf ")...\n",
1441                 PL_colors[0], PL_colors[1],
1442                 (IV)(rx_origin - strbeg + prog->anchored_offset),
1443                 (IV)(rx_origin - strbeg)
1444             ));
1445             goto do_other_substr;
1446         }
1447
1448         /* success: we don't contradict the found floating substring
1449          * (and there's no anchored substr). */
1450         DEBUG_EXECUTE_r(Perl_re_printf( aTHX_
1451             "  Found /%s^%s/m with rx_origin %ld...\n",
1452             PL_colors[0], PL_colors[1], (long)(rx_origin - strbeg)));
1453     }
1454     else {
1455         DEBUG_EXECUTE_r(Perl_re_printf( aTHX_
1456             "  (multiline anchor test skipped)\n"));
1457     }
1458
1459   success_at_start:
1460
1461
1462     /* if we have a starting character class, then test that extra constraint.
1463      * (trie stclasses are too expensive to use here, we are better off to
1464      * leave it to regmatch itself) */
1465
1466     if (progi->regstclass && PL_regkind[OP(progi->regstclass)]!=TRIE) {
1467         const U8* const str = (U8*)STRING(progi->regstclass);
1468
1469         /* XXX this value could be pre-computed */
1470         const int cl_l = (PL_regkind[OP(progi->regstclass)] == EXACT
1471                     ?  (reginfo->is_utf8_pat
1472                         ? utf8_distance(str + STR_LEN(progi->regstclass), str)
1473                         : STR_LEN(progi->regstclass))
1474                     : 1);
1475         char * endpos;
1476         char *s;
1477         /* latest pos that a matching float substr constrains rx start to */
1478         char *rx_max_float = NULL;
1479
1480         /* if the current rx_origin is anchored, either by satisfying an
1481          * anchored substring constraint, or a /^.../m constraint, then we
1482          * can reject the current origin if the start class isn't found
1483          * at the current position. If we have a float-only match, then
1484          * rx_origin is constrained to a range; so look for the start class
1485          * in that range. if neither, then look for the start class in the
1486          * whole rest of the string */
1487
1488         /* XXX DAPM it's not clear what the minlen test is for, and why
1489          * it's not used in the floating case. Nothing in the test suite
1490          * causes minlen == 0 here. See <20140313134639.GS12844@iabyn.com>.
1491          * Here are some old comments, which may or may not be correct:
1492          *
1493          *   minlen == 0 is possible if regstclass is \b or \B,
1494          *   and the fixed substr is ''$.
1495          *   Since minlen is already taken into account, rx_origin+1 is
1496          *   before strend; accidentally, minlen >= 1 guaranties no false
1497          *   positives at rx_origin + 1 even for \b or \B.  But (minlen? 1 :
1498          *   0) below assumes that regstclass does not come from lookahead...
1499          *   If regstclass takes bytelength more than 1: If charlength==1, OK.
1500          *   This leaves EXACTF-ish only, which are dealt with in
1501          *   find_byclass().
1502          */
1503
1504         if (prog->anchored_substr || prog->anchored_utf8 || ml_anch)
1505             endpos = HOP3clim(rx_origin, (prog->minlen ? cl_l : 0), strend);
1506         else if (prog->float_substr || prog->float_utf8) {
1507             rx_max_float = HOP3c(check_at, -start_shift, strbeg);
1508             endpos = HOP3clim(rx_max_float, cl_l, strend);
1509         }
1510         else 
1511             endpos= strend;
1512                     
1513         DEBUG_EXECUTE_r(Perl_re_printf( aTHX_
1514             "  looking for class: start_shift: %" IVdf " check_at: %" IVdf
1515             " rx_origin: %" IVdf " endpos: %" IVdf "\n",
1516               (IV)start_shift, (IV)(check_at - strbeg),
1517               (IV)(rx_origin - strbeg), (IV)(endpos - strbeg)));
1518
1519         s = find_byclass(prog, progi->regstclass, rx_origin, endpos,
1520                             reginfo);
1521         if (!s) {
1522             if (endpos == strend) {
1523                 DEBUG_EXECUTE_r( Perl_re_printf( aTHX_
1524                                 "  Could not match STCLASS...\n") );
1525                 goto fail;
1526             }
1527             DEBUG_EXECUTE_r( Perl_re_printf( aTHX_
1528                                "  This position contradicts STCLASS...\n") );
1529             if ((prog->intflags & PREGf_ANCH) && !ml_anch
1530                         && !(prog->intflags & PREGf_IMPLICIT))
1531                 goto fail;
1532
1533             /* Contradict one of substrings */
1534             if (prog->anchored_substr || prog->anchored_utf8) {
1535                 if (prog->substrs->check_ix == 1) { /* check is float */
1536                     /* Have both, check_string is floating */
1537                     assert(rx_origin + start_shift <= check_at);
1538                     if (rx_origin + start_shift != check_at) {
1539                         /* not at latest position float substr could match:
1540                          * Recheck anchored substring, but not floating.
1541                          * The condition above is in bytes rather than
1542                          * chars for efficiency. It's conservative, in
1543                          * that it errs on the side of doing 'goto
1544                          * do_other_substr'. In this case, at worst,
1545                          * an extra anchored search may get done, but in
1546                          * practice the extra fbm_instr() is likely to
1547                          * get skipped anyway. */
1548                         DEBUG_EXECUTE_r( Perl_re_printf( aTHX_
1549                             "  about to retry anchored at offset %ld (rx_origin now %" IVdf ")...\n",
1550                             (long)(other_last - strbeg),
1551                             (IV)(rx_origin - strbeg)
1552                         ));
1553                         goto do_other_substr;
1554                     }
1555                 }
1556             }
1557             else {
1558                 /* float-only */
1559
1560                 if (ml_anch) {
1561                     /* In the presence of ml_anch, we might be able to
1562                      * find another \n without breaking the current float
1563                      * constraint. */
1564
1565                     /* strictly speaking this should be HOP3c(..., 1, ...),
1566                      * but since we goto a block of code that's going to
1567                      * search for the next \n if any, its safe here */
1568                     rx_origin++;
1569                     DEBUG_EXECUTE_r( Perl_re_printf( aTHX_
1570                               "  about to look for /%s^%s/m starting at rx_origin %ld...\n",
1571                               PL_colors[0], PL_colors[1],
1572                               (long)(rx_origin - strbeg)) );
1573                     goto postprocess_substr_matches;
1574                 }
1575
1576                 /* strictly speaking this can never be true; but might
1577                  * be if we ever allow intuit without substrings */
1578                 if (!(utf8_target ? prog->float_utf8 : prog->float_substr))
1579                     goto fail;
1580
1581                 rx_origin = rx_max_float;
1582             }
1583
1584             /* at this point, any matching substrings have been
1585              * contradicted. Start again... */
1586
1587             rx_origin = HOP3c(rx_origin, 1, strend);
1588
1589             /* uses bytes rather than char calculations for efficiency.
1590              * It's conservative: it errs on the side of doing 'goto restart',
1591              * where there is code that does a proper char-based test */
1592             if (rx_origin + start_shift + end_shift > strend) {
1593                 DEBUG_EXECUTE_r( Perl_re_printf( aTHX_
1594                                        "  Could not match STCLASS...\n") );
1595                 goto fail;
1596             }
1597             DEBUG_EXECUTE_r( Perl_re_printf( aTHX_
1598                 "  about to look for %s substr starting at offset %ld (rx_origin now %" IVdf ")...\n",
1599                 (prog->substrs->check_ix ? "floating" : "anchored"),
1600                 (long)(rx_origin + start_shift - strbeg),
1601                 (IV)(rx_origin - strbeg)
1602             ));
1603             goto restart;
1604         }
1605
1606         /* Success !!! */
1607
1608         if (rx_origin != s) {
1609             DEBUG_EXECUTE_r(Perl_re_printf( aTHX_
1610                         "  By STCLASS: moving %ld --> %ld\n",
1611                                   (long)(rx_origin - strbeg), (long)(s - strbeg))
1612                    );
1613         }
1614         else {
1615             DEBUG_EXECUTE_r(Perl_re_printf( aTHX_
1616                                   "  Does not contradict STCLASS...\n");
1617                    );
1618         }
1619     }
1620
1621     /* Decide whether using the substrings helped */
1622
1623     if (rx_origin != strpos) {
1624         /* Fixed substring is found far enough so that the match
1625            cannot start at strpos. */
1626
1627         DEBUG_EXECUTE_r(Perl_re_printf( aTHX_  "  try at offset...\n"));
1628         ++BmUSEFUL(utf8_target ? prog->check_utf8 : prog->check_substr);        /* hooray/5 */
1629     }
1630     else {
1631         /* The found rx_origin position does not prohibit matching at
1632          * strpos, so calling intuit didn't gain us anything. Decrement
1633          * the BmUSEFUL() count on the check substring, and if we reach
1634          * zero, free it.  */
1635         if (!(prog->intflags & PREGf_NAUGHTY)
1636             && (utf8_target ? (
1637                 prog->check_utf8                /* Could be deleted already */
1638                 && --BmUSEFUL(prog->check_utf8) < 0
1639                 && (prog->check_utf8 == prog->float_utf8)
1640             ) : (
1641                 prog->check_substr              /* Could be deleted already */
1642                 && --BmUSEFUL(prog->check_substr) < 0
1643                 && (prog->check_substr == prog->float_substr)
1644             )))
1645         {
1646             /* If flags & SOMETHING - do not do it many times on the same match */
1647             DEBUG_EXECUTE_r(Perl_re_printf( aTHX_  "  ... Disabling check substring...\n"));
1648             /* XXX Does the destruction order has to change with utf8_target? */
1649             SvREFCNT_dec(utf8_target ? prog->check_utf8 : prog->check_substr);
1650             SvREFCNT_dec(utf8_target ? prog->check_substr : prog->check_utf8);
1651             prog->check_substr = prog->check_utf8 = NULL;       /* disable */
1652             prog->float_substr = prog->float_utf8 = NULL;       /* clear */
1653             check = NULL;                       /* abort */
1654             /* XXXX This is a remnant of the old implementation.  It
1655                     looks wasteful, since now INTUIT can use many
1656                     other heuristics. */
1657             prog->extflags &= ~RXf_USE_INTUIT;
1658         }
1659     }
1660
1661     DEBUG_EXECUTE_r(Perl_re_printf( aTHX_
1662             "Intuit: %sSuccessfully guessed:%s match at offset %ld\n",
1663              PL_colors[4], PL_colors[5], (long)(rx_origin - strbeg)) );
1664
1665     return rx_origin;
1666
1667   fail_finish:                          /* Substring not found */
1668     if (prog->check_substr || prog->check_utf8)         /* could be removed already */
1669         BmUSEFUL(utf8_target ? prog->check_utf8 : prog->check_substr) += 5; /* hooray */
1670   fail:
1671     DEBUG_EXECUTE_r(Perl_re_printf( aTHX_  "%sMatch rejected by optimizer%s\n",
1672                           PL_colors[4], PL_colors[5]));
1673     return NULL;
1674 }
1675
1676
1677 #define DECL_TRIE_TYPE(scan) \
1678     const enum { trie_plain, trie_utf8, trie_utf8_fold, trie_latin_utf8_fold,       \
1679                  trie_utf8_exactfa_fold, trie_latin_utf8_exactfa_fold,              \
1680                  trie_utf8l, trie_flu8, trie_flu8_latin }                           \
1681                     trie_type = ((scan->flags == EXACT)                             \
1682                                  ? (utf8_target ? trie_utf8 : trie_plain)           \
1683                                  : (scan->flags == EXACTL)                          \
1684                                     ? (utf8_target ? trie_utf8l : trie_plain)       \
1685                                     : (scan->flags == EXACTFAA)                     \
1686                                       ? (utf8_target                                \
1687                                          ? trie_utf8_exactfa_fold                   \
1688                                          : trie_latin_utf8_exactfa_fold)            \
1689                                       : (scan->flags == EXACTFLU8                   \
1690                                          ? (utf8_target                             \
1691                                            ? trie_flu8                              \
1692                                            : trie_flu8_latin)                       \
1693                                          : (utf8_target                             \
1694                                            ? trie_utf8_fold                         \
1695                                            : trie_latin_utf8_fold)))
1696
1697 /* 'uscan' is set to foldbuf, and incremented, so below the end of uscan is
1698  * 'foldbuf+sizeof(foldbuf)' */
1699 #define REXEC_TRIE_READ_CHAR(trie_type, trie, widecharmap, uc, uc_end, uscan, len, uvc, charid, foldlen, foldbuf, uniflags) \
1700 STMT_START {                                                                        \
1701     STRLEN skiplen;                                                                 \
1702     U8 flags = FOLD_FLAGS_FULL;                                                     \
1703     switch (trie_type) {                                                            \
1704     case trie_flu8:                                                                 \
1705         _CHECK_AND_WARN_PROBLEMATIC_LOCALE;                                         \
1706         if (UTF8_IS_ABOVE_LATIN1(*uc)) {                                            \
1707             _CHECK_AND_OUTPUT_WIDE_LOCALE_UTF8_MSG(uc, uc_end);                     \
1708         }                                                                           \
1709         goto do_trie_utf8_fold;                                                     \
1710     case trie_utf8_exactfa_fold:                                                    \
1711         flags |= FOLD_FLAGS_NOMIX_ASCII;                                            \
1712         /* FALLTHROUGH */                                                           \
1713     case trie_utf8_fold:                                                            \
1714       do_trie_utf8_fold:                                                            \
1715         if ( foldlen>0 ) {                                                          \
1716             uvc = utf8n_to_uvchr( (const U8*) uscan, foldlen, &len, uniflags );     \
1717             foldlen -= len;                                                         \
1718             uscan += len;                                                           \
1719             len=0;                                                                  \
1720         } else {                                                                    \
1721             uvc = _toFOLD_utf8_flags( (const U8*) uc, uc_end, foldbuf, &foldlen,    \
1722                                                                             flags); \
1723             len = UTF8_SAFE_SKIP(uc, uc_end);                                       \
1724             skiplen = UVCHR_SKIP( uvc );                                            \
1725             foldlen -= skiplen;                                                     \
1726             uscan = foldbuf + skiplen;                                              \
1727         }                                                                           \
1728         break;                                                                      \
1729     case trie_flu8_latin:                                                           \
1730         _CHECK_AND_WARN_PROBLEMATIC_LOCALE;                                         \
1731         goto do_trie_latin_utf8_fold;                                               \
1732     case trie_latin_utf8_exactfa_fold:                                              \
1733         flags |= FOLD_FLAGS_NOMIX_ASCII;                                            \
1734         /* FALLTHROUGH */                                                           \
1735     case trie_latin_utf8_fold:                                                      \
1736       do_trie_latin_utf8_fold:                                                      \
1737         if ( foldlen>0 ) {                                                          \
1738             uvc = utf8n_to_uvchr( (const U8*) uscan, foldlen, &len, uniflags );     \
1739             foldlen -= len;                                                         \
1740             uscan += len;                                                           \
1741             len=0;                                                                  \
1742         } else {                                                                    \
1743             len = 1;                                                                \
1744             uvc = _to_fold_latin1( (U8) *uc, foldbuf, &foldlen, flags);             \
1745             skiplen = UVCHR_SKIP( uvc );                                            \
1746             foldlen -= skiplen;                                                     \
1747             uscan = foldbuf + skiplen;                                              \
1748         }                                                                           \
1749         break;                                                                      \
1750     case trie_utf8l:                                                                \
1751         _CHECK_AND_WARN_PROBLEMATIC_LOCALE;                                         \
1752         if (utf8_target && UTF8_IS_ABOVE_LATIN1(*uc)) {                             \
1753             _CHECK_AND_OUTPUT_WIDE_LOCALE_UTF8_MSG(uc, uc_end);                     \
1754         }                                                                           \
1755         /* FALLTHROUGH */                                                           \
1756     case trie_utf8:                                                                 \
1757         uvc = utf8n_to_uvchr( (const U8*) uc, uc_end - uc, &len, uniflags );        \
1758         break;                                                                      \
1759     case trie_plain:                                                                \
1760         uvc = (UV)*uc;                                                              \
1761         len = 1;                                                                    \
1762     }                                                                               \
1763     if (uvc < 256) {                                                                \
1764         charid = trie->charmap[ uvc ];                                              \
1765     }                                                                               \
1766     else {                                                                          \
1767         charid = 0;                                                                 \
1768         if (widecharmap) {                                                          \
1769             SV** const svpp = hv_fetch(widecharmap,                                 \
1770                         (char*)&uvc, sizeof(UV), 0);                                \
1771             if (svpp)                                                               \
1772                 charid = (U16)SvIV(*svpp);                                          \
1773         }                                                                           \
1774     }                                                                               \
1775 } STMT_END
1776
1777 #define DUMP_EXEC_POS(li,s,doutf8,depth)                    \
1778     dump_exec_pos(li,s,(reginfo->strend),(reginfo->strbeg), \
1779                 startpos, doutf8, depth)
1780
1781 #define REXEC_FBC_SCAN(UTF8, CODE)                          \
1782     STMT_START {                                            \
1783         while (s < strend) {                                \
1784             CODE                                            \
1785             s += ((UTF8) ? UTF8SKIP(s) : 1);                \
1786         }                                                   \
1787     } STMT_END
1788
1789 #define REXEC_FBC_CLASS_SCAN(UTF8, COND)                    \
1790     STMT_START {                                            \
1791         while (s < strend) {                                \
1792             REXEC_FBC_CLASS_SCAN_GUTS(UTF8, COND)           \
1793         }                                                   \
1794     } STMT_END
1795
1796 #define REXEC_FBC_CLASS_SCAN_GUTS(UTF8, COND)                  \
1797     if (COND) {                                                \
1798         FBC_CHECK_AND_TRY                                      \
1799         s += ((UTF8) ? UTF8SKIP(s) : 1);                       \
1800         previous_occurrence_end = s;                           \
1801     }                                                          \
1802     else {                                                     \
1803         s += ((UTF8) ? UTF8SKIP(s) : 1);                       \
1804     }
1805
1806 #define REXEC_FBC_CSCAN(CONDUTF8,COND)                         \
1807     if (utf8_target) {                                         \
1808         REXEC_FBC_CLASS_SCAN(1, CONDUTF8);                     \
1809     }                                                          \
1810     else {                                                     \
1811         REXEC_FBC_CLASS_SCAN(0, COND);                         \
1812     }
1813
1814 /* We keep track of where the next character should start after an occurrence
1815  * of the one we're looking for.  Knowing that, we can see right away if the
1816  * next occurrence is adjacent to the previous.  When 'doevery' is FALSE, we
1817  * don't accept the 2nd and succeeding adjacent occurrences */
1818 #define FBC_CHECK_AND_TRY                                      \
1819         if (   (   doevery                                     \
1820                 || s != previous_occurrence_end)               \
1821             && (reginfo->intuit || regtry(reginfo, &s)))       \
1822         {                                                      \
1823             goto got_it;                                       \
1824         }
1825
1826
1827 /* This differs from the above macros in that it calls a function which returns
1828  * the next occurrence of the thing being looked for in 's'; and 'strend' if
1829  * there is no such occurrence. */
1830 #define REXEC_FBC_FIND_NEXT_SCAN(UTF8, f)                   \
1831     while (s < strend) {                                    \
1832         s = (f);                                            \
1833         if (s >= strend) {                                  \
1834             break;                                          \
1835         }                                                   \
1836                                                             \
1837         FBC_CHECK_AND_TRY                                   \
1838         s += (UTF8) ? UTF8SKIP(s) : 1;                      \
1839         previous_occurrence_end = s;                        \
1840     }
1841
1842 /* The three macros below are slightly different versions of the same logic.
1843  *
1844  * The first is for /a and /aa when the target string is UTF-8.  This can only
1845  * match ascii, but it must advance based on UTF-8.   The other two handle the
1846  * non-UTF-8 and the more generic UTF-8 cases.   In all three, we are looking
1847  * for the boundary (or non-boundary) between a word and non-word character.
1848  * The utf8 and non-utf8 cases have the same logic, but the details must be
1849  * different.  Find the "wordness" of the character just prior to this one, and
1850  * compare it with the wordness of this one.  If they differ, we have a
1851  * boundary.  At the beginning of the string, pretend that the previous
1852  * character was a new-line.
1853  *
1854  * All these macros uncleanly have side-effects with each other and outside
1855  * variables.  So far it's been too much trouble to clean-up
1856  *
1857  * TEST_NON_UTF8 is the macro or function to call to test if its byte input is
1858  *               a word character or not.
1859  * IF_SUCCESS    is code to do if it finds that we are at a boundary between
1860  *               word/non-word
1861  * IF_FAIL       is code to do if we aren't at a boundary between word/non-word
1862  *
1863  * Exactly one of the two IF_FOO parameters is a no-op, depending on whether we
1864  * are looking for a boundary or for a non-boundary.  If we are looking for a
1865  * boundary, we want IF_FAIL to be the no-op, and for IF_SUCCESS to go out and
1866  * see if this tentative match actually works, and if so, to quit the loop
1867  * here.  And vice-versa if we are looking for a non-boundary.
1868  *
1869  * 'tmp' below in the next three macros in the REXEC_FBC_SCAN and
1870  * REXEC_FBC_SCAN loops is a loop invariant, a bool giving the return of
1871  * TEST_NON_UTF8(s-1).  To see this, note that that's what it is defined to be
1872  * at entry to the loop, and to get to the IF_FAIL branch, tmp must equal
1873  * TEST_NON_UTF8(s), and in the opposite branch, IF_SUCCESS, tmp is that
1874  * complement.  But in that branch we complement tmp, meaning that at the
1875  * bottom of the loop tmp is always going to be equal to TEST_NON_UTF8(s),
1876  * which means at the top of the loop in the next iteration, it is
1877  * TEST_NON_UTF8(s-1) */
1878 #define FBC_UTF8_A(TEST_NON_UTF8, IF_SUCCESS, IF_FAIL)                         \
1879     tmp = (s != reginfo->strbeg) ? UCHARAT(s - 1) : '\n';                      \
1880     tmp = TEST_NON_UTF8(tmp);                                                  \
1881     REXEC_FBC_SCAN(1,  /* 1=>is-utf8; advances s while s < strend */           \
1882         if (tmp == ! TEST_NON_UTF8((U8) *s)) {                                 \
1883             tmp = !tmp;                                                        \
1884             IF_SUCCESS; /* Is a boundary if values for s-1 and s differ */     \
1885         }                                                                      \
1886         else {                                                                 \
1887             IF_FAIL;                                                           \
1888         }                                                                      \
1889     );                                                                         \
1890
1891 /* Like FBC_UTF8_A, but TEST_UV is a macro which takes a UV as its input, and
1892  * TEST_UTF8 is a macro that for the same input code points returns identically
1893  * to TEST_UV, but takes a pointer to a UTF-8 encoded string instead */
1894 #define FBC_UTF8(TEST_UV, TEST_UTF8, IF_SUCCESS, IF_FAIL)                      \
1895     if (s == reginfo->strbeg) {                                                \
1896         tmp = '\n';                                                            \
1897     }                                                                          \
1898     else { /* Back-up to the start of the previous character */                \
1899         U8 * const r = reghop3((U8*)s, -1, (U8*)reginfo->strbeg);              \
1900         tmp = utf8n_to_uvchr(r, (U8*) reginfo->strend - r,                     \
1901                                                        0, UTF8_ALLOW_DEFAULT); \
1902     }                                                                          \
1903     tmp = TEST_UV(tmp);                                                        \
1904     REXEC_FBC_SCAN(1,  /* 1=>is-utf8; advances s while s < strend */           \
1905         if (tmp == ! (TEST_UTF8((U8 *) s, (U8 *) reginfo->strend))) {          \
1906             tmp = !tmp;                                                        \
1907             IF_SUCCESS;                                                        \
1908         }                                                                      \
1909         else {                                                                 \
1910             IF_FAIL;                                                           \
1911         }                                                                      \
1912     );
1913
1914 /* Like the above two macros.  UTF8_CODE is the complete code for handling
1915  * UTF-8.  Common to the BOUND and NBOUND cases, set-up by the FBC_BOUND, etc
1916  * macros below */
1917 #define FBC_BOUND_COMMON(UTF8_CODE, TEST_NON_UTF8, IF_SUCCESS, IF_FAIL)        \
1918     if (utf8_target) {                                                         \
1919         UTF8_CODE                                                              \
1920     }                                                                          \
1921     else {  /* Not utf8 */                                                     \
1922         tmp = (s != reginfo->strbeg) ? UCHARAT(s - 1) : '\n';                  \
1923         tmp = TEST_NON_UTF8(tmp);                                              \
1924         REXEC_FBC_SCAN(0, /* 0=>not-utf8; advances s while s < strend */       \
1925             if (tmp == ! TEST_NON_UTF8((U8) *s)) {                             \
1926                 IF_SUCCESS;                                                    \
1927                 tmp = !tmp;                                                    \
1928             }                                                                  \
1929             else {                                                             \
1930                 IF_FAIL;                                                       \
1931             }                                                                  \
1932         );                                                                     \
1933     }                                                                          \
1934     /* Here, things have been set up by the previous code so that tmp is the   \
1935      * return of TEST_NON_UTF(s-1) or TEST_UTF8(s-1) (depending on the         \
1936      * utf8ness of the target).  We also have to check if this matches against \
1937      * the EOS, which we treat as a \n (which is the same value in both UTF-8  \
1938      * or non-UTF8, so can use the non-utf8 test condition even for a UTF-8    \
1939      * string */                                                               \
1940     if (tmp == ! TEST_NON_UTF8('\n')) {                                        \
1941         IF_SUCCESS;                                                            \
1942     }                                                                          \
1943     else {                                                                     \
1944         IF_FAIL;                                                               \
1945     }
1946
1947 /* This is the macro to use when we want to see if something that looks like it
1948  * could match, actually does, and if so exits the loop */
1949 #define REXEC_FBC_TRYIT                            \
1950     if ((reginfo->intuit || regtry(reginfo, &s)))  \
1951         goto got_it
1952
1953 /* The only difference between the BOUND and NBOUND cases is that
1954  * REXEC_FBC_TRYIT is called when matched in BOUND, and when non-matched in
1955  * NBOUND.  This is accomplished by passing it as either the if or else clause,
1956  * with the other one being empty (PLACEHOLDER is defined as empty).
1957  *
1958  * The TEST_FOO parameters are for operating on different forms of input, but
1959  * all should be ones that return identically for the same underlying code
1960  * points */
1961 #define FBC_BOUND(TEST_NON_UTF8, TEST_UV, TEST_UTF8)                           \
1962     FBC_BOUND_COMMON(                                                          \
1963           FBC_UTF8(TEST_UV, TEST_UTF8, REXEC_FBC_TRYIT, PLACEHOLDER),          \
1964           TEST_NON_UTF8, REXEC_FBC_TRYIT, PLACEHOLDER)
1965
1966 #define FBC_BOUND_A(TEST_NON_UTF8)                                             \
1967     FBC_BOUND_COMMON(                                                          \
1968             FBC_UTF8_A(TEST_NON_UTF8, REXEC_FBC_TRYIT, PLACEHOLDER),           \
1969             TEST_NON_UTF8, REXEC_FBC_TRYIT, PLACEHOLDER)
1970
1971 #define FBC_NBOUND(TEST_NON_UTF8, TEST_UV, TEST_UTF8)                          \
1972     FBC_BOUND_COMMON(                                                          \
1973           FBC_UTF8(TEST_UV, TEST_UTF8, PLACEHOLDER, REXEC_FBC_TRYIT),          \
1974           TEST_NON_UTF8, PLACEHOLDER, REXEC_FBC_TRYIT)
1975
1976 #define FBC_NBOUND_A(TEST_NON_UTF8)                                            \
1977     FBC_BOUND_COMMON(                                                          \
1978             FBC_UTF8_A(TEST_NON_UTF8, PLACEHOLDER, REXEC_FBC_TRYIT),           \
1979             TEST_NON_UTF8, PLACEHOLDER, REXEC_FBC_TRYIT)
1980
1981 #ifdef DEBUGGING
1982 static IV
1983 S_get_break_val_cp_checked(SV* const invlist, const UV cp_in) {
1984   IV cp_out = _invlist_search(invlist, cp_in);
1985   assert(cp_out >= 0);
1986   return cp_out;
1987 }
1988 #  define _generic_GET_BREAK_VAL_CP_CHECKED(invlist, invmap, cp) \
1989         invmap[S_get_break_val_cp_checked(invlist, cp)]
1990 #else
1991 #  define _generic_GET_BREAK_VAL_CP_CHECKED(invlist, invmap, cp) \
1992         invmap[_invlist_search(invlist, cp)]
1993 #endif
1994
1995 /* Takes a pointer to an inversion list, a pointer to its corresponding
1996  * inversion map, and a code point, and returns the code point's value
1997  * according to the two arrays.  It assumes that all code points have a value.
1998  * This is used as the base macro for macros for particular properties */
1999 #define _generic_GET_BREAK_VAL_CP(invlist, invmap, cp)              \
2000         _generic_GET_BREAK_VAL_CP_CHECKED(invlist, invmap, cp)
2001
2002 /* Same as above, but takes begin, end ptrs to a UTF-8 encoded string instead
2003  * of a code point, returning the value for the first code point in the string.
2004  * And it takes the particular macro name that finds the desired value given a
2005  * code point.  Merely convert the UTF-8 to code point and call the cp macro */
2006 #define _generic_GET_BREAK_VAL_UTF8(cp_macro, pos, strend)                     \
2007              (__ASSERT_(pos < strend)                                          \
2008                  /* Note assumes is valid UTF-8 */                             \
2009              (cp_macro(utf8_to_uvchr_buf((pos), (strend), NULL))))
2010
2011 /* Returns the GCB value for the input code point */
2012 #define getGCB_VAL_CP(cp)                                                      \
2013           _generic_GET_BREAK_VAL_CP(                                           \
2014                                     PL_GCB_invlist,                            \
2015                                     _Perl_GCB_invmap,                          \
2016                                     (cp))
2017
2018 /* Returns the GCB value for the first code point in the UTF-8 encoded string
2019  * bounded by pos and strend */
2020 #define getGCB_VAL_UTF8(pos, strend)                                           \
2021     _generic_GET_BREAK_VAL_UTF8(getGCB_VAL_CP, pos, strend)
2022
2023 /* Returns the LB value for the input code point */
2024 #define getLB_VAL_CP(cp)                                                       \
2025           _generic_GET_BREAK_VAL_CP(                                           \
2026                                     PL_LB_invlist,                             \
2027                                     _Perl_LB_invmap,                           \
2028                                     (cp))
2029
2030 /* Returns the LB value for the first code point in the UTF-8 encoded string
2031  * bounded by pos and strend */
2032 #define getLB_VAL_UTF8(pos, strend)                                            \
2033     _generic_GET_BREAK_VAL_UTF8(getLB_VAL_CP, pos, strend)
2034
2035
2036 /* Returns the SB value for the input code point */
2037 #define getSB_VAL_CP(cp)                                                       \
2038           _generic_GET_BREAK_VAL_CP(                                           \
2039                                     PL_SB_invlist,                             \
2040                                     _Perl_SB_invmap,                     \
2041                                     (cp))
2042
2043 /* Returns the SB value for the first code point in the UTF-8 encoded string
2044  * bounded by pos and strend */
2045 #define getSB_VAL_UTF8(pos, strend)                                            \
2046     _generic_GET_BREAK_VAL_UTF8(getSB_VAL_CP, pos, strend)
2047
2048 /* Returns the WB value for the input code point */
2049 #define getWB_VAL_CP(cp)                                                       \
2050           _generic_GET_BREAK_VAL_CP(                                           \
2051                                     PL_WB_invlist,                             \
2052                                     _Perl_WB_invmap,                         \
2053                                     (cp))
2054
2055 /* Returns the WB value for the first code point in the UTF-8 encoded string
2056  * bounded by pos and strend */
2057 #define getWB_VAL_UTF8(pos, strend)                                            \
2058     _generic_GET_BREAK_VAL_UTF8(getWB_VAL_CP, pos, strend)
2059
2060 /* We know what class REx starts with.  Try to find this position... */
2061 /* if reginfo->intuit, its a dryrun */
2062 /* annoyingly all the vars in this routine have different names from their counterparts
2063    in regmatch. /grrr */
2064 STATIC char *
2065 S_find_byclass(pTHX_ regexp * prog, const regnode *c, char *s, 
2066     const char *strend, regmatch_info *reginfo)
2067 {
2068     dVAR;
2069
2070     /* TRUE if x+ need not match at just the 1st pos of run of x's */
2071     const I32 doevery = (prog->intflags & PREGf_SKIP) == 0;
2072
2073     char *pat_string;   /* The pattern's exactish string */
2074     char *pat_end;          /* ptr to end char of pat_string */
2075     re_fold_t folder;   /* Function for computing non-utf8 folds */
2076     const U8 *fold_array;   /* array for folding ords < 256 */
2077     STRLEN ln;
2078     STRLEN lnc;
2079     U8 c1;
2080     U8 c2;
2081     char *e = NULL;
2082
2083     /* In some cases we accept only the first occurence of 'x' in a sequence of
2084      * them.  This variable points to just beyond the end of the previous
2085      * occurrence of 'x', hence we can tell if we are in a sequence.  (Having
2086      * it point to beyond the 'x' allows us to work for UTF-8 without having to
2087      * hop back.) */
2088     char * previous_occurrence_end = 0;
2089
2090     I32 tmp;            /* Scratch variable */
2091     const bool utf8_target = reginfo->is_utf8_target;
2092     UV utf8_fold_flags = 0;
2093     const bool is_utf8_pat = reginfo->is_utf8_pat;
2094     bool to_complement = FALSE; /* Invert the result?  Taking the xor of this
2095                                    with a result inverts that result, as 0^1 =
2096                                    1 and 1^1 = 0 */
2097     _char_class_number classnum;
2098
2099     RXi_GET_DECL(prog,progi);
2100
2101     PERL_ARGS_ASSERT_FIND_BYCLASS;
2102
2103     /* We know what class it must start with. */
2104     switch (OP(c)) {
2105     case ANYOFPOSIXL:
2106     case ANYOFL:
2107         _CHECK_AND_WARN_PROBLEMATIC_LOCALE;
2108
2109         if (ANYOFL_UTF8_LOCALE_REQD(FLAGS(c)) && ! IN_UTF8_CTYPE_LOCALE) {
2110             Perl_ck_warner(aTHX_ packWARN(WARN_LOCALE), utf8_locale_required);
2111         }
2112
2113         /* FALLTHROUGH */
2114     case ANYOFD:
2115     case ANYOF:
2116         if (utf8_target) {
2117             REXEC_FBC_CLASS_SCAN(1, /* 1=>is-utf8 */
2118                       reginclass(prog, c, (U8*)s, (U8*) strend, utf8_target));
2119         }
2120         else if (ANYOF_FLAGS(c) & ~ ANYOF_MATCHES_ALL_ABOVE_BITMAP) {
2121             /* We know that s is in the bitmap range since the target isn't
2122              * UTF-8, so what happens for out-of-range values is not relevant,
2123              * so exclude that from the flags */
2124             REXEC_FBC_CLASS_SCAN(0, reginclass(prog,c, (U8*)s, (U8*)s+1, 0));
2125         }
2126         else {
2127             REXEC_FBC_CLASS_SCAN(0, ANYOF_BITMAP_TEST(c, *((U8*)s)));
2128         }
2129         break;
2130
2131     case ANYOFM:    /* ARG() is the base byte; FLAGS() the mask byte */
2132         /* UTF-8ness doesn't matter, so use 0 */
2133         REXEC_FBC_FIND_NEXT_SCAN(0,
2134          (char *) find_next_masked((U8 *) s, (U8 *) strend,
2135                                    (U8) ARG(c), FLAGS(c)));
2136         break;
2137
2138     case NANYOFM:
2139         REXEC_FBC_FIND_NEXT_SCAN(0,
2140          (char *) find_span_end_mask((U8 *) s, (U8 *) strend,
2141                                    (U8) ARG(c), FLAGS(c)));
2142         break;
2143
2144     case ANYOFH:
2145         if (utf8_target) REXEC_FBC_CLASS_SCAN(TRUE,
2146                       reginclass(prog, c, (U8*)s, (U8*) strend, utf8_target));
2147         break;
2148
2149     case EXACTFAA_NO_TRIE: /* This node only generated for non-utf8 patterns */
2150         assert(! is_utf8_pat);
2151         /* FALLTHROUGH */
2152     case EXACTFAA:
2153         if (is_utf8_pat) {
2154             utf8_fold_flags = FOLDEQ_UTF8_NOMIX_ASCII
2155                              |FOLDEQ_S2_ALREADY_FOLDED|FOLDEQ_S2_FOLDS_SANE;
2156             goto do_exactf_utf8;
2157         }
2158         else if (utf8_target) {
2159
2160             /* Here, and elsewhere in this file, the reason we can't consider a
2161              * non-UTF-8 pattern already folded in the presence of a UTF-8
2162              * target is because any MICRO SIGN in the pattern won't be folded.
2163              * Since the fold of the MICRO SIGN requires UTF-8 to represent, we
2164              * can consider a non-UTF-8 pattern folded when matching a
2165              * non-UTF-8 target */
2166             utf8_fold_flags = FOLDEQ_UTF8_NOMIX_ASCII;
2167             goto do_exactf_utf8;
2168         }
2169
2170         /* Latin1 folds are not affected by /a, except it excludes the sharp s,
2171          * which these functions don't handle anyway */
2172         fold_array = PL_fold_latin1;
2173         folder = foldEQ_latin1_s2_folded;
2174         goto do_exactf_non_utf8;
2175
2176     case EXACTF:   /* This node only generated for non-utf8 patterns */
2177         assert(! is_utf8_pat);
2178         if (utf8_target) {
2179             goto do_exactf_utf8;
2180         }
2181         fold_array = PL_fold;
2182         folder = foldEQ;
2183         goto do_exactf_non_utf8;
2184
2185     case EXACTFL:
2186         _CHECK_AND_WARN_PROBLEMATIC_LOCALE;
2187         if (is_utf8_pat || utf8_target || IN_UTF8_CTYPE_LOCALE) {
2188             utf8_fold_flags = FOLDEQ_LOCALE;
2189             goto do_exactf_utf8;
2190         }
2191         fold_array = PL_fold_locale;
2192         folder = foldEQ_locale;
2193         goto do_exactf_non_utf8;
2194
2195     case EXACTFUP:      /* Problematic even though pattern isn't UTF-8.  Use
2196                            full functionality normally not done except for
2197                            UTF-8 */
2198         assert(! is_utf8_pat);
2199         goto do_exactf_utf8;
2200
2201     case EXACTFLU8:
2202             if (! utf8_target) {    /* All code points in this node require
2203                                        UTF-8 to express.  */
2204                 break;
2205             }
2206             utf8_fold_flags =  FOLDEQ_LOCALE | FOLDEQ_S2_ALREADY_FOLDED
2207                                              | FOLDEQ_S2_FOLDS_SANE;
2208             goto do_exactf_utf8;
2209
2210     case EXACTFU_ONLY8:
2211         if (! utf8_target) {
2212             break;
2213         }
2214         assert(is_utf8_pat);
2215         utf8_fold_flags = FOLDEQ_S2_ALREADY_FOLDED;
2216         goto do_exactf_utf8;
2217
2218     case EXACTFU:
2219         if (is_utf8_pat || utf8_target) {
2220             utf8_fold_flags = FOLDEQ_S2_ALREADY_FOLDED;
2221             goto do_exactf_utf8;
2222         }
2223
2224         /* Any 'ss' in the pattern should have been replaced by regcomp,
2225          * so we don't have to worry here about this single special case
2226          * in the Latin1 range */
2227         fold_array = PL_fold_latin1;
2228         folder = foldEQ_latin1_s2_folded;
2229
2230         /* FALLTHROUGH */
2231
2232       do_exactf_non_utf8: /* Neither pattern nor string are UTF8, and there
2233                            are no glitches with fold-length differences
2234                            between the target string and pattern */
2235
2236         /* The idea in the non-utf8 EXACTF* cases is to first find the
2237          * first character of the EXACTF* node and then, if necessary,
2238          * case-insensitively compare the full text of the node.  c1 is the
2239          * first character.  c2 is its fold.  This logic will not work for
2240          * Unicode semantics and the german sharp ss, which hence should
2241          * not be compiled into a node that gets here. */
2242         pat_string = STRING(c);
2243         ln  = STR_LEN(c);       /* length to match in octets/bytes */
2244
2245         /* We know that we have to match at least 'ln' bytes (which is the
2246          * same as characters, since not utf8).  If we have to match 3
2247          * characters, and there are only 2 availabe, we know without
2248          * trying that it will fail; so don't start a match past the
2249          * required minimum number from the far end */
2250         e = HOP3c(strend, -((SSize_t)ln), s);
2251         if (e < s)
2252             break;
2253
2254         c1 = *pat_string;
2255         c2 = fold_array[c1];
2256         if (c1 == c2) { /* If char and fold are the same */
2257             while (s <= e) {
2258                 s = (char *) memchr(s, c1, e + 1 - s);
2259                 if (s == NULL) {
2260                     break;
2261                 }
2262
2263                 /* Check that the rest of the node matches */
2264                 if (   (ln == 1 || folder(s + 1, pat_string + 1, ln - 1))
2265                     && (reginfo->intuit || regtry(reginfo, &s)) )
2266                 {
2267                     goto got_it;
2268                 }
2269                 s++;
2270             }
2271         }
2272         else {
2273             U8 bits_differing = c1 ^ c2;
2274
2275             /* If the folds differ in one bit position only, we can mask to
2276              * match either of them, and can use this faster find method.  Both
2277              * ASCII and EBCDIC tend to have their case folds differ in only
2278              * one position, so this is very likely */
2279             if (LIKELY(PL_bitcount[bits_differing] == 1)) {
2280                 bits_differing = ~ bits_differing;
2281                 while (s <= e) {
2282                     s = (char *) find_next_masked((U8 *) s, (U8 *) e + 1,
2283                                         (c1 & bits_differing), bits_differing);
2284                     if (s > e) {
2285                         break;
2286                     }
2287
2288                     if (   (ln == 1 || folder(s + 1, pat_string + 1, ln - 1))
2289                         && (reginfo->intuit || regtry(reginfo, &s)) )
2290                     {
2291                         goto got_it;
2292                     }
2293                     s++;
2294                 }
2295             }
2296             else {  /* Otherwise, stuck with looking byte-at-a-time.  This
2297                        should actually happen only in EXACTFL nodes */
2298                 while (s <= e) {
2299                     if (    (*(U8*)s == c1 || *(U8*)s == c2)
2300                         && (ln == 1 || folder(s + 1, pat_string + 1, ln - 1))
2301                         && (reginfo->intuit || regtry(reginfo, &s)) )
2302                     {
2303                         goto got_it;
2304                     }
2305                     s++;
2306                 }
2307             }
2308         }
2309         break;
2310
2311       do_exactf_utf8:
2312       {
2313         unsigned expansion;
2314
2315         /* If one of the operands is in utf8, we can't use the simpler folding
2316          * above, due to the fact that many different characters can have the
2317          * same fold, or portion of a fold, or different- length fold */
2318         pat_string = STRING(c);
2319         ln  = STR_LEN(c);       /* length to match in octets/bytes */
2320         pat_end = pat_string + ln;
2321         lnc = is_utf8_pat       /* length to match in characters */
2322                 ? utf8_length((U8 *) pat_string, (U8 *) pat_end)
2323                 : ln;
2324
2325         /* We have 'lnc' characters to match in the pattern, but because of
2326          * multi-character folding, each character in the target can match
2327          * up to 3 characters (Unicode guarantees it will never exceed
2328          * this) if it is utf8-encoded; and up to 2 if not (based on the
2329          * fact that the Latin 1 folds are already determined, and the
2330          * only multi-char fold in that range is the sharp-s folding to
2331          * 'ss'.  Thus, a pattern character can match as little as 1/3 of a
2332          * string character.  Adjust lnc accordingly, rounding up, so that
2333          * if we need to match at least 4+1/3 chars, that really is 5. */
2334         expansion = (utf8_target) ? UTF8_MAX_FOLD_CHAR_EXPAND : 2;
2335         lnc = (lnc + expansion - 1) / expansion;
2336
2337         /* As in the non-UTF8 case, if we have to match 3 characters, and
2338          * only 2 are left, it's guaranteed to fail, so don't start a
2339          * match that would require us to go beyond the end of the string
2340          */
2341         e = HOP3c(strend, -((SSize_t)lnc), s);
2342
2343         /* XXX Note that we could recalculate e to stop the loop earlier,
2344          * as the worst case expansion above will rarely be met, and as we
2345          * go along we would usually find that e moves further to the left.
2346          * This would happen only after we reached the point in the loop
2347          * where if there were no expansion we should fail.  Unclear if
2348          * worth the expense */
2349
2350         while (s <= e) {
2351             char *my_strend= (char *)strend;
2352             if (foldEQ_utf8_flags(s, &my_strend, 0,  utf8_target,
2353                   pat_string, NULL, ln, is_utf8_pat, utf8_fold_flags)
2354                 && (reginfo->intuit || regtry(reginfo, &s)) )
2355             {
2356                 goto got_it;
2357             }
2358             s += (utf8_target) ? UTF8SKIP(s) : 1;
2359         }
2360         break;
2361     }
2362
2363     case BOUNDL:
2364         _CHECK_AND_WARN_PROBLEMATIC_LOCALE;
2365         if (FLAGS(c) != TRADITIONAL_BOUND) {
2366             if (! IN_UTF8_CTYPE_LOCALE) {
2367                 Perl_ck_warner(aTHX_ packWARN(WARN_LOCALE),
2368                                                 B_ON_NON_UTF8_LOCALE_IS_WRONG);
2369             }
2370             goto do_boundu;
2371         }
2372
2373         FBC_BOUND(isWORDCHAR_LC, isWORDCHAR_LC_uvchr, isWORDCHAR_LC_utf8_safe);
2374         break;
2375
2376     case NBOUNDL:
2377         _CHECK_AND_WARN_PROBLEMATIC_LOCALE;
2378         if (FLAGS(c) != TRADITIONAL_BOUND) {
2379             if (! IN_UTF8_CTYPE_LOCALE) {
2380                 Perl_ck_warner(aTHX_ packWARN(WARN_LOCALE),
2381                                                 B_ON_NON_UTF8_LOCALE_IS_WRONG);
2382             }
2383             goto do_nboundu;
2384         }
2385
2386         FBC_NBOUND(isWORDCHAR_LC, isWORDCHAR_LC_uvchr, isWORDCHAR_LC_utf8_safe);
2387         break;
2388
2389     case BOUND: /* regcomp.c makes sure that this only has the traditional \b
2390                    meaning */
2391         assert(FLAGS(c) == TRADITIONAL_BOUND);
2392
2393         FBC_BOUND(isWORDCHAR, isWORDCHAR_uni, isWORDCHAR_utf8_safe);
2394         break;
2395
2396     case BOUNDA: /* regcomp.c makes sure that this only has the traditional \b
2397                    meaning */
2398         assert(FLAGS(c) == TRADITIONAL_BOUND);
2399
2400         FBC_BOUND_A(isWORDCHAR_A);
2401         break;
2402
2403     case NBOUND: /* regcomp.c makes sure that this only has the traditional \b
2404                    meaning */
2405         assert(FLAGS(c) == TRADITIONAL_BOUND);
2406
2407         FBC_NBOUND(isWORDCHAR, isWORDCHAR_uni, isWORDCHAR_utf8_safe);
2408         break;
2409
2410     case NBOUNDA: /* regcomp.c makes sure that this only has the traditional \b
2411                    meaning */
2412         assert(FLAGS(c) == TRADITIONAL_BOUND);
2413
2414         FBC_NBOUND_A(isWORDCHAR_A);
2415         break;
2416
2417     case NBOUNDU:
2418         if ((bound_type) FLAGS(c) == TRADITIONAL_BOUND) {
2419             FBC_NBOUND(isWORDCHAR_L1, isWORDCHAR_uni, isWORDCHAR_utf8_safe);
2420             break;
2421         }
2422
2423       do_nboundu:
2424
2425         to_complement = 1;
2426         /* FALLTHROUGH */
2427
2428     case BOUNDU:
2429       do_boundu:
2430         switch((bound_type) FLAGS(c)) {
2431             case TRADITIONAL_BOUND:
2432                 FBC_BOUND(isWORDCHAR_L1, isWORDCHAR_uni, isWORDCHAR_utf8_safe);
2433                 break;
2434             case GCB_BOUND:
2435                 if (s == reginfo->strbeg) {
2436                     if (reginfo->intuit || regtry(reginfo, &s))
2437                     {
2438                         goto got_it;
2439                     }
2440
2441                     /* Didn't match.  Try at the next position (if there is one) */
2442                     s += (utf8_target) ? UTF8SKIP(s) : 1;
2443                     if (UNLIKELY(s >= reginfo->strend)) {
2444                         break;
2445                     }
2446                 }
2447
2448                 if (utf8_target) {
2449                     GCB_enum before = getGCB_VAL_UTF8(
2450                                                reghop3((U8*)s, -1,
2451                                                        (U8*)(reginfo->strbeg)),
2452                                                (U8*) reginfo->strend);
2453                     while (s < strend) {
2454                         GCB_enum after = getGCB_VAL_UTF8((U8*) s,
2455                                                         (U8*) reginfo->strend);
2456                         if (   (to_complement ^ isGCB(before,
2457                                                       after,
2458                                                       (U8*) reginfo->strbeg,
2459                                                       (U8*) s,
2460                                                       utf8_target))
2461                             && (reginfo->intuit || regtry(reginfo, &s)))
2462                         {
2463                             goto got_it;
2464                         }
2465                         before = after;
2466                         s += UTF8SKIP(s);
2467                     }
2468                 }
2469                 else {  /* Not utf8.  Everything is a GCB except between CR and
2470                            LF */
2471                     while (s < strend) {
2472                         if ((to_complement ^ (   UCHARAT(s - 1) != '\r'
2473                                               || UCHARAT(s) != '\n'))
2474                             && (reginfo->intuit || regtry(reginfo, &s)))
2475                         {
2476                             goto got_it;
2477                         }
2478                         s++;
2479                     }
2480                 }
2481
2482                 /* And, since this is a bound, it can match after the final
2483                  * character in the string */
2484                 if ((reginfo->intuit || regtry(reginfo, &s))) {
2485                     goto got_it;
2486                 }
2487                 break;
2488
2489             case LB_BOUND:
2490                 if (s == reginfo->strbeg) {
2491                     if (reginfo->intuit || regtry(reginfo, &s)) {
2492                         goto got_it;
2493                     }
2494                     s += (utf8_target) ? UTF8SKIP(s) : 1;
2495                     if (UNLIKELY(s >= reginfo->strend)) {
2496                         break;
2497                     }
2498                 }
2499
2500                 if (utf8_target) {
2501                     LB_enum before = getLB_VAL_UTF8(reghop3((U8*)s,
2502                                                                -1,
2503                                                                (U8*)(reginfo->strbeg)),
2504                                                        (U8*) reginfo->strend);
2505                     while (s < strend) {
2506                         LB_enum after = getLB_VAL_UTF8((U8*) s, (U8*) reginfo->strend);
2507                         if (to_complement ^ isLB(before,
2508                                                  after,
2509                                                  (U8*) reginfo->strbeg,
2510                                                  (U8*) s,
2511                                                  (U8*) reginfo->strend,
2512                                                  utf8_target)
2513                             && (reginfo->intuit || regtry(reginfo, &s)))
2514                         {
2515                             goto got_it;
2516                         }
2517                         before = after;
2518                         s += UTF8SKIP(s);
2519                     }
2520                 }
2521                 else {  /* Not utf8. */
2522                     LB_enum before = getLB_VAL_CP((U8) *(s -1));
2523                     while (s < strend) {
2524                         LB_enum after = getLB_VAL_CP((U8) *s);
2525                         if (to_complement ^ isLB(before,
2526                                                  after,
2527                                                  (U8*) reginfo->strbeg,
2528                                                  (U8*) s,
2529                                                  (U8*) reginfo->strend,
2530                                                  utf8_target)
2531                             && (reginfo->intuit || regtry(reginfo, &s)))
2532                         {
2533                             goto got_it;
2534                         }
2535                         before = after;
2536                         s++;
2537                     }
2538                 }
2539
2540                 if (reginfo->intuit || regtry(reginfo, &s)) {
2541                     goto got_it;
2542                 }
2543
2544                 break;
2545
2546             case SB_BOUND:
2547                 if (s == reginfo->strbeg) {
2548                     if (reginfo->intuit || regtry(reginfo, &s)) {
2549                         goto got_it;
2550                     }
2551                     s += (utf8_target) ? UTF8SKIP(s) : 1;
2552                     if (UNLIKELY(s >= reginfo->strend)) {
2553                         break;
2554                     }
2555                 }
2556
2557                 if (utf8_target) {
2558                     SB_enum before = getSB_VAL_UTF8(reghop3((U8*)s,
2559                                                         -1,
2560                                                         (U8*)(reginfo->strbeg)),
2561                                                       (U8*) reginfo->strend);
2562                     while (s < strend) {
2563                         SB_enum after = getSB_VAL_UTF8((U8*) s,
2564                                                          (U8*) reginfo->strend);
2565                         if ((to_complement ^ isSB(before,
2566                                                   after,
2567                                                   (U8*) reginfo->strbeg,
2568                                                   (U8*) s,
2569                                                   (U8*) reginfo->strend,
2570                                                   utf8_target))
2571                             && (reginfo->intuit || regtry(reginfo, &s)))
2572                         {
2573                             goto got_it;
2574                         }
2575                         before = after;
2576                         s += UTF8SKIP(s);
2577                     }
2578                 }
2579                 else {  /* Not utf8. */
2580                     SB_enum before = getSB_VAL_CP((U8) *(s -1));
2581                     while (s < strend) {
2582                         SB_enum after = getSB_VAL_CP((U8) *s);
2583                         if ((to_complement ^ isSB(before,
2584                                                   after,
2585                                                   (U8*) reginfo->strbeg,
2586                                                   (U8*) s,
2587                                                   (U8*) reginfo->strend,
2588                                                   utf8_target))
2589                             && (reginfo->intuit || regtry(reginfo, &s)))
2590                         {
2591                             goto got_it;
2592                         }
2593                         before = after;
2594                         s++;
2595                     }
2596                 }
2597
2598                 /* Here are at the final position in the target string.  The SB
2599                  * value is always true here, so matches, depending on other
2600                  * constraints */
2601                 if (reginfo->intuit || regtry(reginfo, &s)) {
2602                     goto got_it;
2603                 }
2604
2605                 break;
2606
2607             case WB_BOUND:
2608                 if (s == reginfo->strbeg) {
2609                     if (reginfo->intuit || regtry(reginfo, &s)) {
2610                         goto got_it;
2611                     }
2612                     s += (utf8_target) ? UTF8SKIP(s) : 1;
2613                     if (UNLIKELY(s >= reginfo->strend)) {
2614                         break;
2615                     }
2616                 }
2617
2618                 if (utf8_target) {
2619                     /* We are at a boundary between char_sub_0 and char_sub_1.
2620                      * We also keep track of the value for char_sub_-1 as we
2621                      * loop through the line.   Context may be needed to make a
2622                      * determination, and if so, this can save having to
2623                      * recalculate it */
2624                     WB_enum previous = WB_UNKNOWN;
2625                     WB_enum before = getWB_VAL_UTF8(
2626                                               reghop3((U8*)s,
2627                                                       -1,
2628                                                       (U8*)(reginfo->strbeg)),
2629                                               (U8*) reginfo->strend);
2630                     while (s < strend) {
2631                         WB_enum after = getWB_VAL_UTF8((U8*) s,
2632                                                         (U8*) reginfo->strend);
2633                         if ((to_complement ^ isWB(previous,
2634                                                   before,
2635                                                   after,
2636                                                   (U8*) reginfo->strbeg,
2637                                                   (U8*) s,
2638                                                   (U8*) reginfo->strend,
2639                                                   utf8_target))
2640                             && (reginfo->intuit || regtry(reginfo, &s)))
2641                         {
2642                             goto got_it;
2643                         }
2644                         previous = before;
2645                         before = after;
2646                         s += UTF8SKIP(s);
2647                     }
2648                 }
2649                 else {  /* Not utf8. */
2650                     WB_enum previous = WB_UNKNOWN;
2651                     WB_enum before = getWB_VAL_CP((U8) *(s -1));
2652                     while (s < strend) {
2653                         WB_enum after = getWB_VAL_CP((U8) *s);
2654                         if ((to_complement ^ isWB(previous,
2655                                                   before,
2656                                                   after,
2657                                                   (U8*) reginfo->strbeg,
2658                                                   (U8*) s,
2659                                                   (U8*) reginfo->strend,
2660                                                   utf8_target))
2661                             && (reginfo->intuit || regtry(reginfo, &s)))
2662                         {
2663                             goto got_it;
2664                         }
2665                         previous = before;
2666                         before = after;
2667                         s++;
2668                     }
2669                 }
2670
2671                 if (reginfo->intuit || regtry(reginfo, &s)) {
2672                     goto got_it;
2673                 }
2674         }
2675         break;
2676
2677     case LNBREAK:
2678         REXEC_FBC_CSCAN(is_LNBREAK_utf8_safe(s, strend),
2679                         is_LNBREAK_latin1_safe(s, strend)
2680         );
2681         break;
2682
2683     /* The argument to all the POSIX node types is the class number to pass to
2684      * _generic_isCC() to build a mask for searching in PL_charclass[] */
2685
2686     case NPOSIXL:
2687         to_complement = 1;
2688         /* FALLTHROUGH */
2689
2690     case POSIXL:
2691         _CHECK_AND_WARN_PROBLEMATIC_LOCALE;
2692         REXEC_FBC_CSCAN(to_complement ^ cBOOL(isFOO_utf8_lc(FLAGS(c), (U8 *) s, (U8 *) strend)),
2693                         to_complement ^ cBOOL(isFOO_lc(FLAGS(c), *s)));
2694         break;
2695
2696     case NPOSIXD:
2697         to_complement = 1;
2698         /* FALLTHROUGH */
2699
2700     case POSIXD:
2701         if (utf8_target) {
2702             goto posix_utf8;
2703         }
2704         goto posixa;
2705
2706     case NPOSIXA:
2707         if (utf8_target) {
2708             /* The complement of something that matches only ASCII matches all
2709              * non-ASCII, plus everything in ASCII that isn't in the class. */
2710             REXEC_FBC_CLASS_SCAN(1,   ! isASCII_utf8_safe(s, strend)
2711                                    || ! _generic_isCC_A(*s, FLAGS(c)));
2712             break;
2713         }
2714
2715         to_complement = 1;
2716         goto posixa;
2717
2718     case POSIXA:
2719         /* Don't need to worry about utf8, as it can match only a single
2720          * byte invariant character.  But we do anyway for performance reasons,
2721          * as otherwise we would have to examine all the continuation
2722          * characters */
2723         if (utf8_target) {
2724             REXEC_FBC_CLASS_SCAN(1, _generic_isCC_A(*s, FLAGS(c)));
2725             break;
2726         }
2727
2728       posixa:
2729         REXEC_FBC_CLASS_SCAN(0, /* 0=>not-utf8 */
2730                         to_complement ^ cBOOL(_generic_isCC_A(*s, FLAGS(c))));
2731         break;
2732
2733     case NPOSIXU:
2734         to_complement = 1;
2735         /* FALLTHROUGH */
2736
2737     case POSIXU:
2738         if (! utf8_target) {
2739             REXEC_FBC_CLASS_SCAN(0, /* 0=>not-utf8 */
2740                                  to_complement ^ cBOOL(_generic_isCC(*s,
2741                                                                     FLAGS(c))));
2742         }
2743         else {
2744
2745           posix_utf8:
2746             classnum = (_char_class_number) FLAGS(c);
2747             switch (classnum) {
2748                 default:
2749                     REXEC_FBC_CLASS_SCAN(1, /* 1=>is-utf8 */
2750                         to_complement ^ cBOOL(_invlist_contains_cp(
2751                                               PL_XPosix_ptrs[classnum],
2752                                               utf8_to_uvchr_buf((U8 *) s,
2753                                                                 (U8 *) strend,
2754                                                                 NULL))));
2755                     break;
2756                 case _CC_ENUM_SPACE:
2757                     REXEC_FBC_CLASS_SCAN(1, /* 1=>is-utf8 */
2758                         to_complement ^ cBOOL(isSPACE_utf8_safe(s, strend)));
2759                     break;
2760
2761                 case _CC_ENUM_BLANK:
2762                     REXEC_FBC_CLASS_SCAN(1,
2763                         to_complement ^ cBOOL(isBLANK_utf8_safe(s, strend)));
2764                     break;
2765
2766                 case _CC_ENUM_XDIGIT:
2767                     REXEC_FBC_CLASS_SCAN(1,
2768                        to_complement ^ cBOOL(isXDIGIT_utf8_safe(s, strend)));
2769                     break;
2770
2771                 case _CC_ENUM_VERTSPACE:
2772                     REXEC_FBC_CLASS_SCAN(1,
2773                        to_complement ^ cBOOL(isVERTWS_utf8_safe(s, strend)));
2774                     break;
2775
2776                 case _CC_ENUM_CNTRL:
2777                     REXEC_FBC_CLASS_SCAN(1,
2778                         to_complement ^ cBOOL(isCNTRL_utf8_safe(s, strend)));
2779                     break;
2780             }
2781         }
2782         break;
2783
2784     case AHOCORASICKC:
2785     case AHOCORASICK:
2786         {
2787             DECL_TRIE_TYPE(c);
2788             /* what trie are we using right now */
2789             reg_ac_data *aho = (reg_ac_data*)progi->data->data[ ARG( c ) ];
2790             reg_trie_data *trie = (reg_trie_data*)progi->data->data[ aho->trie ];
2791             HV *widecharmap = MUTABLE_HV(progi->data->data[ aho->trie + 1 ]);
2792
2793             const char *last_start = strend - trie->minlen;
2794 #ifdef DEBUGGING
2795             const char *real_start = s;
2796 #endif
2797             STRLEN maxlen = trie->maxlen;
2798             SV *sv_points;
2799             U8 **points; /* map of where we were in the input string
2800                             when reading a given char. For ASCII this
2801                             is unnecessary overhead as the relationship
2802                             is always 1:1, but for Unicode, especially
2803                             case folded Unicode this is not true. */
2804             U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
2805             U8 *bitmap=NULL;
2806
2807
2808             GET_RE_DEBUG_FLAGS_DECL;
2809
2810             /* We can't just allocate points here. We need to wrap it in
2811              * an SV so it gets freed properly if there is a croak while
2812              * running the match */
2813             ENTER;
2814             SAVETMPS;
2815             sv_points=newSV(maxlen * sizeof(U8 *));
2816             SvCUR_set(sv_points,
2817                 maxlen * sizeof(U8 *));
2818             SvPOK_on(sv_points);
2819             sv_2mortal(sv_points);
2820             points=(U8**)SvPV_nolen(sv_points );
2821             if ( trie_type != trie_utf8_fold
2822                  && (trie->bitmap || OP(c)==AHOCORASICKC) )
2823             {
2824                 if (trie->bitmap)
2825                     bitmap=(U8*)trie->bitmap;
2826                 else
2827                     bitmap=(U8*)ANYOF_BITMAP(c);
2828             }
2829             /* this is the Aho-Corasick algorithm modified a touch
2830                to include special handling for long "unknown char" sequences.
2831                The basic idea being that we use AC as long as we are dealing
2832                with a possible matching char, when we encounter an unknown char
2833                (and we have not encountered an accepting state) we scan forward
2834                until we find a legal starting char.
2835                AC matching is basically that of trie matching, except that when
2836                we encounter a failing transition, we fall back to the current
2837                states "fail state", and try the current char again, a process
2838                we repeat until we reach the root state, state 1, or a legal
2839                transition. If we fail on the root state then we can either
2840                terminate if we have reached an accepting state previously, or
2841                restart the entire process from the beginning if we have not.
2842
2843              */
2844             while (s <= last_start) {
2845                 const U32 uniflags = UTF8_ALLOW_DEFAULT;
2846                 U8 *uc = (U8*)s;
2847                 U16 charid = 0;
2848                 U32 base = 1;
2849                 U32 state = 1;
2850                 UV uvc = 0;
2851                 STRLEN len = 0;
2852                 STRLEN foldlen = 0;
2853                 U8 *uscan = (U8*)NULL;
2854                 U8 *leftmost = NULL;
2855 #ifdef DEBUGGING
2856                 U32 accepted_word= 0;
2857 #endif
2858                 U32 pointpos = 0;
2859
2860                 while ( state && uc <= (U8*)strend ) {
2861                     int failed=0;
2862                     U32 word = aho->states[ state ].wordnum;
2863
2864                     if( state==1 ) {
2865                         if ( bitmap ) {
2866                             DEBUG_TRIE_EXECUTE_r(
2867                                 if ( uc <= (U8*)last_start && !BITMAP_TEST(bitmap,*uc) ) {
2868                                     dump_exec_pos( (char *)uc, c, strend, real_start,
2869                                         (char *)uc, utf8_target, 0 );
2870                                     Perl_re_printf( aTHX_
2871                                         " Scanning for legal start char...\n");
2872                                 }
2873                             );
2874                             if (utf8_target) {
2875                                 while ( uc <= (U8*)last_start && !BITMAP_TEST(bitmap,*uc) ) {
2876                                     uc += UTF8SKIP(uc);
2877                                 }
2878                             } else {
2879                                 while ( uc <= (U8*)last_start  && !BITMAP_TEST(bitmap,*uc) ) {
2880                                     uc++;
2881                                 }
2882                             }
2883                             s= (char *)uc;
2884                         }
2885                         if (uc >(U8*)last_start) break;
2886                     }
2887
2888                     if ( word ) {
2889                         U8 *lpos= points[ (pointpos - trie->wordinfo[word].len) % maxlen ];
2890                         if (!leftmost || lpos < leftmost) {
2891                             DEBUG_r(accepted_word=word);
2892                             leftmost= lpos;
2893                         }
2894                         if (base==0) break;
2895
2896                     }
2897                     points[pointpos++ % maxlen]= uc;
2898                     if (foldlen || uc < (U8*)strend) {
2899                         REXEC_TRIE_READ_CHAR(trie_type, trie, widecharmap, uc,
2900                                              (U8 *) strend, uscan, len, uvc,
2901                                              charid, foldlen, foldbuf,
2902                                              uniflags);
2903                         DEBUG_TRIE_EXECUTE_r({
2904                             dump_exec_pos( (char *)uc, c, strend,
2905                                         real_start, s, utf8_target, 0);
2906                             Perl_re_printf( aTHX_
2907                                 " Charid:%3u CP:%4" UVxf " ",
2908                                  charid, uvc);
2909                         });
2910                     }
2911                     else {
2912                         len = 0;
2913                         charid = 0;
2914                     }
2915
2916
2917                     do {
2918 #ifdef DEBUGGING
2919                         word = aho->states[ state ].wordnum;
2920 #endif
2921                         base = aho->states[ state ].trans.base;
2922
2923                         DEBUG_TRIE_EXECUTE_r({
2924                             if (failed)
2925                                 dump_exec_pos( (char *)uc, c, strend, real_start,
2926                                     s,   utf8_target, 0 );
2927                             Perl_re_printf( aTHX_
2928                                 "%sState: %4" UVxf ", word=%" UVxf,
2929                                 failed ? " Fail transition to " : "",
2930                                 (UV)state, (UV)word);
2931                         });
2932                         if ( base ) {
2933                             U32 tmp;
2934                             I32 offset;
2935                             if (charid &&
2936                                  ( ((offset = base + charid
2937                                     - 1 - trie->uniquecharcount)) >= 0)
2938                                  && ((U32)offset < trie->lasttrans)
2939                                  && trie->trans[offset].check == state
2940                                  && (tmp=trie->trans[offset].next))
2941                             {
2942                                 DEBUG_TRIE_EXECUTE_r(
2943                                     Perl_re_printf( aTHX_ " - legal\n"));
2944                                 state = tmp;
2945                                 break;
2946                             }
2947                             else {
2948                                 DEBUG_TRIE_EXECUTE_r(
2949                                     Perl_re_printf( aTHX_ " - fail\n"));
2950                                 failed = 1;
2951                                 state = aho->fail[state];
2952                             }
2953                         }
2954                         else {
2955                             /* we must be accepting here */
2956                             DEBUG_TRIE_EXECUTE_r(
2957                                     Perl_re_printf( aTHX_ " - accepting\n"));
2958                             failed = 1;
2959                             break;
2960                         }
2961                     } while(state);
2962                     uc += len;
2963                     if (failed) {
2964                         if (leftmost)
2965                             break;
2966                         if (!state) state = 1;
2967                     }
2968                 }
2969                 if ( aho->states[ state ].wordnum ) {
2970                     U8 *lpos = points[ (pointpos - trie->wordinfo[aho->states[ state ].wordnum].len) % maxlen ];
2971                     if (!leftmost || lpos < leftmost) {
2972                         DEBUG_r(accepted_word=aho->states[ state ].wordnum);
2973                         leftmost = lpos;
2974                     }
2975                 }
2976                 if (leftmost) {
2977                     s = (char*)leftmost;
2978                     DEBUG_TRIE_EXECUTE_r({
2979                         Perl_re_printf( aTHX_  "Matches word #%" UVxf " at position %" IVdf ". Trying full pattern...\n",
2980                             (UV)accepted_word, (IV)(s - real_start)
2981                         );
2982                     });
2983                     if (reginfo->intuit || regtry(reginfo, &s)) {
2984                         FREETMPS;
2985                         LEAVE;
2986                         goto got_it;
2987                     }
2988                     s = HOPc(s,1);
2989                     DEBUG_TRIE_EXECUTE_r({
2990                         Perl_re_printf( aTHX_ "Pattern failed. Looking for new start point...\n");
2991                     });
2992                 } else {
2993                     DEBUG_TRIE_EXECUTE_r(
2994                         Perl_re_printf( aTHX_ "No match.\n"));
2995                     break;
2996                 }
2997             }
2998             FREETMPS;
2999             LEAVE;
3000         }
3001         break;
3002     default:
3003         Perl_croak(aTHX_ "panic: unknown regstclass %d", (int)OP(c));
3004     }
3005     return 0;
3006   got_it:
3007     return s;
3008 }
3009
3010 /* set RX_SAVED_COPY, RX_SUBBEG etc.
3011  * flags have same meanings as with regexec_flags() */
3012
3013 static void
3014 S_reg_set_capture_string(pTHX_ REGEXP * const rx,
3015                             char *strbeg,
3016                             char *strend,
3017                             SV *sv,
3018                             U32 flags,
3019                             bool utf8_target)
3020 {
3021     struct regexp *const prog = ReANY(rx);
3022
3023     if (flags & REXEC_COPY_STR) {
3024 #ifdef PERL_ANY_COW
3025         if (SvCANCOW(sv)) {
3026             DEBUG_C(Perl_re_printf( aTHX_
3027                               "Copy on write: regexp capture, type %d\n",
3028                                     (int) SvTYPE(sv)));
3029             /* Create a new COW SV to share the match string and store
3030              * in saved_copy, unless the current COW SV in saved_copy
3031              * is valid and suitable for our purpose */
3032             if ((   prog->saved_copy
3033                  && SvIsCOW(prog->saved_copy)
3034                  && SvPOKp(prog->saved_copy)
3035                  && SvIsCOW(sv)
3036                  && SvPOKp(sv)
3037                  && SvPVX(sv) == SvPVX(prog->saved_copy)))
3038             {
3039                 /* just reuse saved_copy SV */
3040                 if (RXp_MATCH_COPIED(prog)) {
3041                     Safefree(prog->subbeg);
3042                     RXp_MATCH_COPIED_off(prog);
3043                 }
3044             }
3045             else {
3046                 /* create new COW SV to share string */
3047                 RXp_MATCH_COPY_FREE(prog);
3048                 prog->saved_copy = sv_setsv_cow(prog->saved_copy, sv);
3049             }
3050             prog->subbeg = (char *)SvPVX_const(prog->saved_copy);
3051             assert (SvPOKp(prog->saved_copy));
3052             prog->sublen  = strend - strbeg;
3053             prog->suboffset = 0;
3054             prog->subcoffset = 0;
3055         } else
3056 #endif
3057         {
3058             SSize_t min = 0;
3059             SSize_t max = strend - strbeg;
3060             SSize_t sublen;
3061
3062             if (    (flags & REXEC_COPY_SKIP_POST)
3063                 && !(prog->extflags & RXf_PMf_KEEPCOPY) /* //p */
3064                 && !(PL_sawampersand & SAWAMPERSAND_RIGHT)
3065             ) { /* don't copy $' part of string */
3066                 U32 n = 0;
3067                 max = -1;
3068                 /* calculate the right-most part of the string covered
3069                  * by a capture. Due to lookahead, this may be to
3070                  * the right of $&, so we have to scan all captures */
3071                 while (n <= prog->lastparen) {
3072                     if (prog->offs[n].end > max)
3073                         max = prog->offs[n].end;
3074                     n++;
3075                 }
3076                 if (max == -1)
3077                     max = (PL_sawampersand & SAWAMPERSAND_LEFT)
3078                             ? prog->offs[0].start
3079                             : 0;
3080                 assert(max >= 0 && max <= strend - strbeg);
3081             }
3082
3083             if (    (flags & REXEC_COPY_SKIP_PRE)
3084                 && !(prog->extflags & RXf_PMf_KEEPCOPY) /* //p */
3085                 && !(PL_sawampersand & SAWAMPERSAND_LEFT)
3086             ) { /* don't copy $` part of string */
3087                 U32 n = 0;
3088                 min = max;
3089                 /* calculate the left-most part of the string covered
3090                  * by a capture. Due to lookbehind, this may be to
3091                  * the left of $&, so we have to scan all captures */
3092                 while (min && n <= prog->lastparen) {
3093                     if (   prog->offs[n].start != -1
3094                         && prog->offs[n].start < min)
3095                     {
3096                         min = prog->offs[n].start;
3097                     }
3098                     n++;
3099                 }
3100                 if ((PL_sawampersand & SAWAMPERSAND_RIGHT)
3101                     && min >  prog->offs[0].end
3102                 )
3103                     min = prog->offs[0].end;
3104
3105             }
3106
3107             assert(min >= 0 && min <= max && min <= strend - strbeg);
3108             sublen = max - min;
3109
3110             if (RXp_MATCH_COPIED(prog)) {
3111                 if (sublen > prog->sublen)
3112                     prog->subbeg =
3113                             (char*)saferealloc(prog->subbeg, sublen+1);
3114             }
3115             else
3116                 prog->subbeg = (char*)safemalloc(sublen+1);
3117             Copy(strbeg + min, prog->subbeg, sublen, char);
3118             prog->subbeg[sublen] = '\0';
3119             prog->suboffset = min;
3120             prog->sublen = sublen;
3121             RXp_MATCH_COPIED_on(prog);
3122         }
3123         prog->subcoffset = prog->suboffset;
3124         if (prog->suboffset && utf8_target) {
3125             /* Convert byte offset to chars.
3126              * XXX ideally should only compute this if @-/@+
3127              * has been seen, a la PL_sawampersand ??? */
3128
3129             /* If there's a direct correspondence between the
3130              * string which we're matching and the original SV,
3131              * then we can use the utf8 len cache associated with
3132              * the SV. In particular, it means that under //g,
3133              * sv_pos_b2u() will use the previously cached
3134              * position to speed up working out the new length of
3135              * subcoffset, rather than counting from the start of
3136              * the string each time. This stops
3137              *   $x = "\x{100}" x 1E6; 1 while $x =~ /(.)/g;
3138              * from going quadratic */
3139             if (SvPOKp(sv) && SvPVX(sv) == strbeg)
3140                 prog->subcoffset = sv_pos_b2u_flags(sv, prog->subcoffset,
3141                                                 SV_GMAGIC|SV_CONST_RETURN);
3142             else
3143                 prog->subcoffset = utf8_length((U8*)strbeg,
3144                                     (U8*)(strbeg+prog->suboffset));
3145         }
3146     }
3147     else {
3148         RXp_MATCH_COPY_FREE(prog);
3149         prog->subbeg = strbeg;
3150         prog->suboffset = 0;
3151         prog->subcoffset = 0;
3152         prog->sublen = strend - strbeg;
3153     }
3154 }
3155
3156
3157
3158
3159 /*
3160  - regexec_flags - match a regexp against a string
3161  */
3162 I32
3163 Perl_regexec_flags(pTHX_ REGEXP * const rx, char *stringarg, char *strend,
3164               char *strbeg, SSize_t minend, SV *sv, void *data, U32 flags)
3165 /* stringarg: the point in the string at which to begin matching */
3166 /* strend:    pointer to null at end of string */
3167 /* strbeg:    real beginning of string */
3168 /* minend:    end of match must be >= minend bytes after stringarg. */
3169 /* sv:        SV being matched: only used for utf8 flag, pos() etc; string
3170  *            itself is accessed via the pointers above */
3171 /* data:      May be used for some additional optimizations.
3172               Currently unused. */
3173 /* flags:     For optimizations. See REXEC_* in regexp.h */
3174
3175 {
3176     struct regexp *const prog = ReANY(rx);
3177     char *s;
3178     regnode *c;
3179     char *startpos;
3180     SSize_t minlen;             /* must match at least this many chars */
3181     SSize_t dontbother = 0;     /* how many characters not to try at end */
3182     const bool utf8_target = cBOOL(DO_UTF8(sv));
3183     I32 multiline;
3184     RXi_GET_DECL(prog,progi);
3185     regmatch_info reginfo_buf;  /* create some info to pass to regtry etc */
3186     regmatch_info *const reginfo = &reginfo_buf;
3187     regexp_paren_pair *swap = NULL;
3188     I32 oldsave;
3189     GET_RE_DEBUG_FLAGS_DECL;
3190
3191     PERL_ARGS_ASSERT_REGEXEC_FLAGS;
3192     PERL_UNUSED_ARG(data);
3193
3194     /* Be paranoid... */
3195     if (prog == NULL) {
3196         Perl_croak(aTHX_ "NULL regexp parameter");
3197     }
3198
3199     DEBUG_EXECUTE_r(
3200         debug_start_match(rx, utf8_target, stringarg, strend,
3201         "Matching");
3202     );
3203
3204     startpos = stringarg;
3205
3206     /* set these early as they may be used by the HOP macros below */
3207     reginfo->strbeg = strbeg;
3208     reginfo->strend = strend;
3209     reginfo->is_utf8_target = cBOOL(utf8_target);
3210
3211     if (prog->intflags & PREGf_GPOS_SEEN) {
3212         MAGIC *mg;
3213
3214         /* set reginfo->ganch, the position where \G can match */
3215
3216         reginfo->ganch =
3217             (flags & REXEC_IGNOREPOS)
3218             ? stringarg /* use start pos rather than pos() */
3219             : ((mg = mg_find_mglob(sv)) && mg->mg_len >= 0)
3220               /* Defined pos(): */
3221             ? strbeg + MgBYTEPOS(mg, sv, strbeg, strend-strbeg)
3222             : strbeg; /* pos() not defined; use start of string */
3223
3224         DEBUG_GPOS_r(Perl_re_printf( aTHX_
3225             "GPOS ganch set to strbeg[%" IVdf "]\n", (IV)(reginfo->ganch - strbeg)));
3226
3227         /* in the presence of \G, we may need to start looking earlier in
3228          * the string than the suggested start point of stringarg:
3229          * if prog->gofs is set, then that's a known, fixed minimum
3230          * offset, such as
3231          * /..\G/:   gofs = 2
3232          * /ab|c\G/: gofs = 1
3233          * or if the minimum offset isn't known, then we have to go back
3234          * to the start of the string, e.g. /w+\G/
3235          */
3236
3237         if (prog->intflags & PREGf_ANCH_GPOS) {
3238             if (prog->gofs) {
3239                 startpos = HOPBACKc(reginfo->ganch, prog->gofs);
3240                 if (!startpos ||
3241                     ((flags & REXEC_FAIL_ON_UNDERFLOW) && startpos < stringarg))
3242                 {
3243                     DEBUG_r(Perl_re_printf( aTHX_
3244                             "fail: ganch-gofs before earliest possible start\n"));
3245                     return 0;
3246                 }
3247             }
3248             else
3249                 startpos = reginfo->ganch;
3250         }
3251         else if (prog->gofs) {
3252             startpos = HOPBACKc(startpos, prog->gofs);
3253             if (!startpos)
3254                 startpos = strbeg;
3255         }
3256         else if (prog->intflags & PREGf_GPOS_FLOAT)
3257             startpos = strbeg;
3258     }
3259
3260     minlen = prog->minlen;
3261     if ((startpos + minlen) > strend || startpos < strbeg) {
3262         DEBUG_r(Perl_re_printf( aTHX_
3263                     "Regex match can't succeed, so not even tried\n"));
3264         return 0;
3265     }
3266
3267     /* at the end of this function, we'll do a LEAVE_SCOPE(oldsave),
3268      * which will call destuctors to reset PL_regmatch_state, free higher
3269      * PL_regmatch_slabs, and clean up regmatch_info_aux and
3270      * regmatch_info_aux_eval */
3271
3272     oldsave = PL_savestack_ix;
3273
3274     s = startpos;
3275
3276     if ((prog->extflags & RXf_USE_INTUIT)
3277         && !(flags & REXEC_CHECKED))
3278     {
3279         s = re_intuit_start(rx, sv, strbeg, startpos, strend,
3280                                     flags, NULL);
3281         if (!s)
3282             return 0;
3283
3284         if (prog->extflags & RXf_CHECK_ALL) {
3285             /* we can match based purely on the result of INTUIT.
3286              * Set up captures etc just for $& and $-[0]
3287              * (an intuit-only match wont have $1,$2,..) */
3288             assert(!prog->nparens);
3289
3290             /* s/// doesn't like it if $& is earlier than where we asked it to
3291              * start searching (which can happen on something like /.\G/) */
3292             if (       (flags & REXEC_FAIL_ON_UNDERFLOW)
3293                     && (s < stringarg))
3294             {
3295                 /* this should only be possible under \G */
3296                 assert(prog->intflags & PREGf_GPOS_SEEN);
3297                 DEBUG_EXECUTE_r(Perl_re_printf( aTHX_
3298                     "matched, but failing for REXEC_FAIL_ON_UNDERFLOW\n"));
3299                 goto phooey;
3300             }
3301
3302             /* match via INTUIT shouldn't have any captures.
3303              * Let @-, @+, $^N know */
3304             prog->lastparen = prog->lastcloseparen = 0;
3305             RXp_MATCH_UTF8_set(prog, utf8_target);
3306             prog->offs[0].start = s - strbeg;
3307             prog->offs[0].end = utf8_target
3308                 ? (char*)utf8_hop_forward((U8*)s, prog->minlenret, (U8 *) strend) - strbeg
3309                 : s - strbeg + prog->minlenret;
3310             if ( !(flags & REXEC_NOT_FIRST) )
3311                 S_reg_set_capture_string(aTHX_ rx,
3312                                         strbeg, strend,
3313                                         sv, flags, utf8_target);
3314
3315             return 1;
3316         }
3317     }
3318
3319     multiline = prog->extflags & RXf_PMf_MULTILINE;
3320     
3321     if (strend - s < (minlen+(prog->check_offset_min<0?prog->check_offset_min:0))) {
3322         DEBUG_EXECUTE_r(Perl_re_printf( aTHX_
3323                               "String too short [regexec_flags]...\n"));
3324         goto phooey;
3325     }
3326     
3327     /* Check validity of program. */
3328     if (UCHARAT(progi->program) != REG_MAGIC) {
3329         Perl_croak(aTHX_ "corrupted regexp program");
3330     }
3331
3332     RXp_MATCH_TAINTED_off(prog);
3333     RXp_MATCH_UTF8_set(prog, utf8_target);
3334
3335     reginfo->prog = rx;  /* Yes, sorry that this is confusing.  */
3336     reginfo->intuit = 0;
3337     reginfo->is_utf8_pat = cBOOL(RX_UTF8(rx));
3338     reginfo->warned = FALSE;
3339     reginfo->sv = sv;
3340     reginfo->poscache_maxiter = 0; /* not yet started a countdown */
3341     /* see how far we have to get to not match where we matched before */
3342     reginfo->till = stringarg + minend;
3343
3344     if (prog->extflags & RXf_EVAL_SEEN && SvPADTMP(sv)) {
3345         /* SAVEFREESV, not sv_mortalcopy, as this SV must last until after
3346            S_cleanup_regmatch_info_aux has executed (registered by
3347            SAVEDESTRUCTOR_X below).  S_cleanup_regmatch_info_aux modifies
3348            magic belonging to this SV.
3349            Not newSVsv, either, as it does not COW.
3350         */
3351         reginfo->sv = newSV(0);
3352         SvSetSV_nosteal(reginfo->sv, sv);
3353         SAVEFREESV(reginfo->sv);
3354     }
3355
3356     /* reserve next 2 or 3 slots in PL_regmatch_state:
3357      * slot N+0: may currently be in use: skip it
3358      * slot N+1: use for regmatch_info_aux struct
3359      * slot N+2: use for regmatch_info_aux_eval struct if we have (?{})'s
3360      * slot N+3: ready for use by regmatch()
3361      */
3362
3363     {
3364         regmatch_state *old_regmatch_state;
3365         regmatch_slab  *old_regmatch_slab;
3366         int i, max = (prog->extflags & RXf_EVAL_SEEN) ? 2 : 1;
3367
3368         /* on first ever match, allocate first slab */
3369         if (!PL_regmatch_slab) {
3370             Newx(PL_regmatch_slab, 1, regmatch_slab);
3371             PL_regmatch_slab->prev = NULL;
3372             PL_regmatch_slab->next = NULL;
3373             PL_regmatch_state = SLAB_FIRST(PL_regmatch_slab);
3374         }
3375
3376         old_regmatch_state = PL_regmatch_state;
3377         old_regmatch_slab  = PL_regmatch_slab;
3378
3379         for (i=0; i <= max; i++) {
3380             if (i == 1)
3381                 reginfo->info_aux = &(PL_regmatch_state->u.info_aux);
3382             else if (i ==2)
3383                 reginfo->info_aux_eval =
3384                 reginfo->info_aux->info_aux_eval =
3385                             &(PL_regmatch_state->u.info_aux_eval);
3386
3387             if (++PL_regmatch_state >  SLAB_LAST(PL_regmatch_slab))
3388                 PL_regmatch_state = S_push_slab(aTHX);
3389         }
3390
3391         /* note initial PL_regmatch_state position; at end of match we'll
3392          * pop back to there and free any higher slabs */
3393
3394         reginfo->info_aux->old_regmatch_state = old_regmatch_state;
3395         reginfo->info_aux->old_regmatch_slab  = old_regmatch_slab;
3396         reginfo->info_aux->poscache = NULL;
3397
3398         SAVEDESTRUCTOR_X(S_cleanup_regmatch_info_aux, reginfo->info_aux);
3399
3400         if ((prog->extflags & RXf_EVAL_SEEN))
3401             S_setup_eval_state(aTHX_ reginfo);
3402         else
3403             reginfo->info_aux_eval = reginfo->info_aux->info_aux_eval = NULL;
3404     }
3405
3406     /* If there is a "must appear" string, look for it. */
3407
3408     if (PL_curpm && (PM_GETRE(PL_curpm) == rx)) {
3409         /* We have to be careful. If the previous successful match
3410            was from this regex we don't want a subsequent partially
3411            successful match to clobber the old results.
3412            So when we detect this possibility we add a swap buffer
3413            to the re, and switch the buffer each match. If we fail,
3414            we switch it back; otherwise we leave it swapped.
3415         */
3416         swap = prog->offs;
3417         /* avoid leak if we die, or clean up anyway if match completes */
3418         SAVEFREEPV(swap);
3419         Newxz(prog->offs, (prog->nparens + 1), regexp_paren_pair);
3420         DEBUG_BUFFERS_r(Perl_re_exec_indentf( aTHX_
3421             "rex=0x%" UVxf " saving  offs: orig=0x%" UVxf " new=0x%" UVxf "\n",
3422             0,
3423             PTR2UV(prog),
3424             PTR2UV(swap),
3425             PTR2UV(prog->offs)
3426         ));
3427     }
3428
3429     if (prog->recurse_locinput)
3430         Zero(prog->recurse_locinput,prog->nparens + 1, char *);
3431
3432     /* Simplest case: anchored match need be tried only once, or with
3433      * MBOL, only at the beginning of each line.
3434      *
3435      * Note that /.*.../ sets PREGf_IMPLICIT|MBOL, while /.*.../s sets
3436      * PREGf_IMPLICIT|SBOL. The idea is that with /.*.../s, if it doesn't
3437      * match at the start of the string then it won't match anywhere else
3438      * either; while with /.*.../, if it doesn't match at the beginning,
3439      * the earliest it could match is at the start of the next line */
3440
3441     if (prog->intflags & (PREGf_ANCH & ~PREGf_ANCH_GPOS)) {
3442         char *end;
3443
3444         if (regtry(reginfo, &s))
3445             goto got_it;
3446
3447         if (!(prog->intflags & PREGf_ANCH_MBOL))
3448             goto phooey;
3449
3450         /* didn't match at start, try at other newline positions */
3451
3452         if (minlen)
3453             dontbother = minlen - 1;
3454         end = HOP3c(strend, -dontbother, strbeg) - 1;
3455
3456         /* skip to next newline */
3457
3458         while (s <= end) { /* note it could be possible to match at the end of the string */
3459             /* NB: newlines are the same in unicode as they are in latin */
3460             if (*s++ != '\n')
3461                 continue;
3462             if (prog->check_substr || prog->check_utf8) {
3463             /* note that with PREGf_IMPLICIT, intuit can only fail
3464              * or return the start position, so it's of limited utility.
3465              * Nevertheless, I made the decision that the potential for
3466              * quick fail was still worth it - DAPM */
3467                 s = re_intuit_start(rx, sv, strbeg, s, strend, flags, NULL);
3468                 if (!s)
3469                     goto phooey;
3470             }
3471             if (regtry(reginfo, &s))
3472                 goto got_it;
3473         }
3474         goto phooey;
3475     } /* end anchored search */
3476
3477     if (prog->intflags & PREGf_ANCH_GPOS)
3478     {
3479         /* PREGf_ANCH_GPOS should never be true if PREGf_GPOS_SEEN is not true */
3480         assert(prog->intflags & PREGf_GPOS_SEEN);
3481         /* For anchored \G, the only position it can match from is
3482          * (ganch-gofs); we already set startpos to this above; if intuit
3483          * moved us on from there, we can't possibly succeed */
3484         assert(startpos == HOPBACKc(reginfo->ganch, prog->gofs));
3485         if (s == startpos && regtry(reginfo, &s))
3486             goto got_it;
3487         goto phooey;
3488     }
3489
3490     /* Messy cases:  unanchored match. */
3491     if ((prog->anchored_substr || prog->anchored_utf8) && prog->intflags & PREGf_SKIP) {
3492         /* we have /x+whatever/ */
3493         /* it must be a one character string (XXXX Except is_utf8_pat?) */
3494         char ch;
3495 #ifdef DEBUGGING
3496         int did_match = 0;
3497 #endif
3498         if (utf8_target) {
3499             if (! prog->anchored_utf8) {
3500                 to_utf8_substr(prog);
3501             }
3502             ch = SvPVX_const(prog->anchored_utf8)[0];
3503             REXEC_FBC_SCAN(0,   /* 0=>not-utf8 */
3504                 if (*s == ch) {
3505                     DEBUG_EXECUTE_r( did_match = 1 );
3506                     if (regtry(reginfo, &s)) goto got_it;
3507                     s += UTF8SKIP(s);
3508                     while (s < strend && *s == ch)
3509                         s += UTF8SKIP(s);
3510                 }
3511             );
3512
3513         }
3514         else {
3515             if (! prog->anchored_substr) {
3516                 if (! to_byte_substr(prog)) {
3517                     NON_UTF8_TARGET_BUT_UTF8_REQUIRED(phooey);
3518                 }
3519             }
3520             ch = SvPVX_const(prog->anchored_substr)[0];
3521             REXEC_FBC_SCAN(0,   /* 0=>not-utf8 */
3522                 if (*s == ch) {
3523                     DEBUG_EXECUTE_r( did_match = 1 );
3524                     if (regtry(reginfo, &s)) goto got_it;
3525                     s++;
3526                     while (s < strend && *s == ch)
3527                         s++;
3528                 }
3529             );
3530         }
3531         DEBUG_EXECUTE_r(if (!did_match)
3532                 Perl_re_printf( aTHX_
3533                                   "Did not find anchored character...\n")
3534                );
3535     }
3536     else if (prog->anchored_substr != NULL
3537               || prog->anchored_utf8 != NULL
3538               || ((prog->float_substr != NULL || prog->float_utf8 != NULL)
3539                   && prog->float_max_offset < strend - s)) {
3540         SV *must;
3541         SSize_t back_max;
3542         SSize_t back_min;
3543         char *last;
3544         char *last1;            /* Last position checked before */
3545 #ifdef DEBUGGING
3546         int did_match = 0;
3547 #endif
3548         if (prog->anchored_substr || prog->anchored_utf8) {
3549             if (utf8_target) {
3550                 if (! prog->anchored_utf8) {
3551                     to_utf8_substr(prog);
3552                 }
3553                 must = prog->anchored_utf8;
3554             }
3555             else {
3556                 if (! prog->anchored_substr) {
3557                     if (! to_byte_substr(prog)) {
3558                         NON_UTF8_TARGET_BUT_UTF8_REQUIRED(phooey);
3559                     }
3560                 }
3561                 must = prog->anchored_substr;
3562             }
3563             back_max = back_min = prog->anchored_offset;
3564         } else {
3565             if (utf8_target) {
3566                 if (! prog->float_utf8) {
3567                     to_utf8_substr(prog);
3568                 }
3569                 must = prog->float_utf8;
3570             }
3571             else {
3572                 if (! prog->float_substr) {
3573                     if (! to_byte_substr(prog)) {
3574                         NON_UTF8_TARGET_BUT_UTF8_REQUIRED(phooey);
3575                     }
3576                 }
3577                 must = prog->float_substr;
3578             }
3579             back_max = prog->float_max_offset;
3580             back_min = prog->float_min_offset;
3581         }
3582             
3583         if (back_min<0) {
3584             last = strend;
3585         } else {
3586             last = HOP3c(strend,        /* Cannot start after this */
3587                   -(SSize_t)(CHR_SVLEN(must)
3588                          - (SvTAIL(must) != 0) + back_min), strbeg);
3589         }
3590         if (s > reginfo->strbeg)
3591             last1 = HOPc(s, -1);
3592         else
3593             last1 = s - 1;      /* bogus */
3594
3595         /* XXXX check_substr already used to find "s", can optimize if
3596            check_substr==must. */
3597         dontbother = 0;
3598         strend = HOPc(strend, -dontbother);
3599         while ( (s <= last) &&
3600                 (s = fbm_instr((unsigned char*)HOP4c(s, back_min, strbeg,  strend),
3601                                   (unsigned char*)strend, must,
3602                                   multiline ? FBMrf_MULTILINE : 0)) ) {
3603             DEBUG_EXECUTE_r( did_match = 1 );
3604             if (HOPc(s, -back_max) > last1) {
3605                 last1 = HOPc(s, -back_min);
3606                 s = HOPc(s, -back_max);
3607             }
3608             else {
3609                 char * const t = (last1 >= reginfo->strbeg)
3610                                     ? HOPc(last1, 1) : last1 + 1;
3611
3612                 last1 = HOPc(s, -back_min);
3613                 s = t;
3614             }
3615             if (utf8_target) {
3616                 while (s <= last1) {
3617                     if (regtry(reginfo, &s))
3618                         goto got_it;
3619                     if (s >= last1) {
3620                         s++; /* to break out of outer loop */
3621                         break;
3622                     }
3623                     s += UTF8SKIP(s);
3624                 }
3625             }
3626             else {
3627                 while (s <= last1) {
3628                     if (regtry(reginfo, &s))
3629                         goto got_it;
3630                     s++;
3631                 }
3632             }
3633         }
3634         DEBUG_EXECUTE_r(if (!did_match) {
3635             RE_PV_QUOTED_DECL(quoted, utf8_target, PERL_DEBUG_PAD_ZERO(0),
3636                 SvPVX_const(must), RE_SV_DUMPLEN(must), 30);
3637             Perl_re_printf( aTHX_  "Did not find %s substr %s%s...\n",
3638                               ((must == prog->anchored_substr || must == prog->anchored_utf8)
3639                                ? "anchored" : "floating"),
3640                 quoted, RE_SV_TAIL(must));
3641         });                 
3642         goto phooey;
3643     }
3644     else if ( (c = progi->regstclass) ) {
3645         if (minlen) {
3646             const OPCODE op = OP(progi->regstclass);
3647             /* don't bother with what can't match */
3648             if (PL_regkind[op] != EXACT && PL_regkind[op] != TRIE)
3649                 strend = HOPc(strend, -(minlen - 1));
3650         }
3651         DEBUG_EXECUTE_r({
3652             SV * const prop = sv_newmortal();
3653             regprop(prog, prop, c, reginfo, NULL);
3654             {
3655                 RE_PV_QUOTED_DECL(quoted,utf8_target,PERL_DEBUG_PAD_ZERO(1),
3656                     s,strend-s,PL_dump_re_max_len);
3657                 Perl_re_printf( aTHX_
3658                     "Matching stclass %.*s against %s (%d bytes)\n",
3659                     (int)SvCUR(prop), SvPVX_const(prop),
3660                      quoted, (int)(strend - s));
3661             }
3662         });
3663         if (find_byclass(prog, c, s, strend, reginfo))
3664             goto got_it;
3665         DEBUG_EXECUTE_r(Perl_re_printf( aTHX_  "Contradicts stclass... [regexec_flags]\n"));
3666     }
3667     else {
3668         dontbother = 0;
3669         if (prog->float_substr != NULL || prog->float_utf8 != NULL) {
3670             /* Trim the end. */
3671             char *last= NULL;
3672             SV* float_real;
3673             STRLEN len;
3674             const char *little;
3675
3676             if (utf8_target) {
3677                 if (! prog->float_utf8) {
3678                     to_utf8_substr(prog);
3679                 }
3680                 float_real = prog->float_utf8;
3681             }
3682             else {
3683                 if (! prog->float_substr) {
3684                     if (! to_byte_substr(prog)) {
3685                         NON_UTF8_TARGET_BUT_UTF8_REQUIRED(phooey);
3686                     }
3687                 }
3688                 float_real = prog->float_substr;
3689             }
3690
3691             little = SvPV_const(float_real, len);
3692             if (SvTAIL(float_real)) {
3693                     /* This means that float_real contains an artificial \n on
3694                      * the end due to the presence of something like this:
3695                      * /foo$/ where we can match both "foo" and "foo\n" at the
3696                      * end of the string.  So we have to compare the end of the
3697                      * string first against the float_real without the \n and
3698                      * then against the full float_real with the string.  We
3699                      * have to watch out for cases where the string might be
3700                      * smaller than the float_real or the float_real without
3701                      * the \n. */
3702                     char *checkpos= strend - len;
3703                     DEBUG_OPTIMISE_r(
3704                         Perl_re_printf( aTHX_
3705                             "%sChecking for float_real.%s\n",
3706                             PL_colors[4], PL_colors[5]));
3707                     if (checkpos + 1 < strbeg) {
3708                         /* can't match, even if we remove the trailing \n
3709                          * string is too short to match */
3710                         DEBUG_EXECUTE_r(
3711                             Perl_re_printf( aTHX_
3712                                 "%sString shorter than required trailing substring, cannot match.%s\n",
3713                                 PL_colors[4], PL_colors[5]));
3714                         goto phooey;
3715                     } else if (memEQ(checkpos + 1, little, len - 1)) {
3716                         /* can match, the end of the string matches without the
3717                          * "\n" */
3718                         last = checkpos + 1;
3719                     } else if (checkpos < strbeg) {
3720                         /* cant match, string is too short when the "\n" is
3721                          * included */
3722                         DEBUG_EXECUTE_r(
3723                             Perl_re_printf( aTHX_
3724                                 "%sString does not contain required trailing substring, cannot match.%s\n",
3725                                 PL_colors[4], PL_colors[5]));
3726                         goto phooey;
3727                     } else if (!multiline) {
3728                         /* non multiline match, so compare with the "\n" at the
3729                          * end of the string */
3730                         if (memEQ(checkpos, little, len)) {
3731                             last= checkpos;
3732                         } else {
3733                             DEBUG_EXECUTE_r(
3734                                 Perl_re_printf( aTHX_
3735                                     "%sString does not contain required trailing substring, cannot match.%s\n",
3736                                     PL_colors[4], PL_colors[5]));
3737                             goto phooey;
3738                         }
3739                     } else {
3740                         /* multiline match, so we have to search for a place
3741                          * where the full string is located */
3742                         goto find_last;
3743                     }
3744             } else {
3745                   find_last:
3746                     if (len)
3747                         last = rninstr(s, strend, little, little + len);
3748                     else
3749                         last = strend;  /* matching "$" */
3750             }
3751             if (!last) {
3752                 /* at one point this block contained a comment which was
3753                  * probably incorrect, which said that this was a "should not
3754                  * happen" case.  Even if it was true when it was written I am
3755                  * pretty sure it is not anymore, so I have removed the comment
3756                  * and replaced it with this one. Yves */
3757                 DEBUG_EXECUTE_r(
3758                     Perl_re_printf( aTHX_
3759                         "%sString does not contain required substring, cannot match.%s\n",
3760                         PL_colors[4], PL_colors[5]
3761                     ));
3762                 goto phooey;
3763             }
3764             dontbother = strend - last + prog->float_min_offset;
3765         }
3766         if (minlen && (dontbother < minlen))
3767             dontbother = minlen - 1;
3768         strend -= dontbother;              /* this one's always in bytes! */
3769         /* We don't know much -- general case. */
3770         if (utf8_target) {
3771             for (;;) {
3772                 if (regtry(reginfo, &s))
3773                     goto got_it;
3774                 if (s >= strend)
3775                     break;
3776                 s += UTF8SKIP(s);
3777             };
3778         }
3779         else {
3780             do {
3781                 if (regtry(reginfo, &s))
3782                     goto got_it;
3783             } while (s++ < strend);
3784         }
3785     }
3786
3787     /* Failure. */
3788     goto phooey;
3789
3790   got_it:
3791     /* s/// doesn't like it if $& is earlier than where we asked it to
3792      * start searching (which can happen on something like /.\G/) */
3793     if (       (flags & REXEC_FAIL_ON_UNDERFLOW)
3794             && (prog->offs[0].start < stringarg - strbeg))
3795     {
3796         /* this should only be possible under \G */
3797         assert(prog->intflags & PREGf_GPOS_SEEN);
3798         DEBUG_EXECUTE_r(Perl_re_printf( aTHX_
3799             "matched, but failing for REXEC_FAIL_ON_UNDERFLOW\n"));
3800         goto phooey;
3801     }
3802
3803     /* clean up; this will trigger destructors that will free all slabs
3804      * above the current one, and cleanup the regmatch_info_aux
3805      * and regmatch_info_aux_eval sructs */
3806
3807     LEAVE_SCOPE(oldsave);
3808
3809     if (RXp_PAREN_NAMES(prog)) 
3810         (void)hv_iterinit(RXp_PAREN_NAMES(prog));
3811
3812     /* make sure $`, $&, $', and $digit will work later */
3813     if ( !(flags & REXEC_NOT_FIRST) )
3814         S_reg_set_capture_string(aTHX_ rx,
3815                                     strbeg, reginfo->strend,
3816                                     sv, flags, utf8_target);
3817
3818     return 1;
3819
3820   phooey:
3821     DEBUG_EXECUTE_r(Perl_re_printf( aTHX_  "%sMatch failed%s\n",
3822                           PL_colors[4], PL_colors[5]));
3823
3824     if (swap) {
3825         /* we failed :-( roll it back.
3826          * Since the swap buffer will be freed on scope exit which follows
3827          * shortly, restore the old captures by copying 'swap's original
3828          * data to the new offs buffer
3829          */
3830         DEBUG_BUFFERS_r(Perl_re_exec_indentf( aTHX_
3831             "rex=0x%" UVxf " rolling back offs: 0x%" UVxf " will be freed; restoring data to =0x%" UVxf "\n",
3832             0,
3833             PTR2UV(prog),
3834             PTR2UV(prog->offs),
3835             PTR2UV(swap)
3836         ));
3837
3838         Copy(swap, prog->offs, prog->nparens + 1, regexp_paren_pair);
3839     }
3840
3841     /* clean up; this will trigger destructors that will free all slabs
3842      * above the current one, and cleanup the regmatch_info_aux
3843      * and regmatch_info_aux_eval sructs */
3844
3845     LEAVE_SCOPE(oldsave);
3846
3847     return 0;
3848 }
3849
3850
3851 /* Set which rex is pointed to by PL_reg_curpm, handling ref counting.
3852  * Do inc before dec, in case old and new rex are the same */
3853 #define SET_reg_curpm(Re2)                          \
3854     if (reginfo->info_aux_eval) {                   \
3855         (void)ReREFCNT_inc(Re2);                    \
3856         ReREFCNT_dec(PM_GETRE(PL_reg_curpm));       \
3857         PM_SETRE((PL_reg_curpm), (Re2));            \
3858     }
3859
3860
3861 /*
3862  - regtry - try match at specific point
3863  */
3864 STATIC bool                     /* 0 failure, 1 success */
3865 S_regtry(pTHX_ regmatch_info *reginfo, char **startposp)
3866 {
3867     CHECKPOINT lastcp;
3868     REGEXP *const rx = reginfo->prog;
3869     regexp *const prog = ReANY(rx);
3870     SSize_t result;
3871 #ifdef DEBUGGING
3872     U32 depth = 0; /* used by REGCP_SET */
3873 #endif
3874     RXi_GET_DECL(prog,progi);
3875     GET_RE_DEBUG_FLAGS_DECL;
3876
3877     PERL_ARGS_ASSERT_REGTRY;
3878
3879     reginfo->cutpoint=NULL;
3880
3881     prog->offs[0].start = *startposp - reginfo->strbeg;
3882     prog->lastparen = 0;
3883     prog->lastcloseparen = 0;
3884
3885     /* XXXX What this code is doing here?!!!  There should be no need
3886        to do this again and again, prog->lastparen should take care of
3887        this!  --ilya*/
3888
3889     /* Tests pat.t#187 and split.t#{13,14} seem to depend on this code.
3890      * Actually, the code in regcppop() (which Ilya may be meaning by
3891      * prog->lastparen), is not needed at all by the test suite
3892      * (op/regexp, op/pat, op/split), but that code is needed otherwise
3893      * this erroneously leaves $1 defined: "1" =~ /^(?:(\d)x)?\d$/
3894      * Meanwhile, this code *is* needed for the
3895      * above-mentioned test suite tests to succeed.  The common theme
3896      * on those tests seems to be returning null fields from matches.
3897      * --jhi updated by dapm */
3898
3899     /* After encountering a variant of the issue mentioned above I think
3900      * the point Ilya was making is that if we properly unwind whenever
3901      * we set lastparen to a smaller value then we should not need to do
3902      * this every time, only when needed. So if we have tests that fail if
3903      * we remove this, then it suggests somewhere else we are improperly
3904      * unwinding the lastparen/paren buffers. See UNWIND_PARENS() and
3905      * places it is called, and related regcp() routines. - Yves */
3906 #if 1
3907     if (prog->nparens) {
3908         regexp_paren_pair *pp = prog->offs;
3909         I32 i;
3910         for (i = prog->nparens; i > (I32)prog->lastparen; i--) {
3911             ++pp;
3912             pp->start = -1;
3913             pp->end = -1;
3914         }
3915     }
3916 #endif
3917     REGCP_SET(lastcp);
3918     result = regmatch(reginfo, *startposp, progi->program + 1);
3919     if (result != -1) {
3920         prog->offs[0].end = result;
3921         return 1;
3922     }
3923     if (reginfo->cutpoint)
3924         *startposp= reginfo->cutpoint;
3925     REGCP_UNWIND(lastcp);
3926     return 0;
3927 }
3928
3929 /* this is used to determine how far from the left messages like
3930    'failed...' are printed in regexec.c. It should be set such that
3931    messages are inline with the regop output that created them.
3932 */
3933 #define REPORT_CODE_OFF 29
3934 #define INDENT_CHARS(depth) ((int)(depth) % 20)
3935 #ifdef DEBUGGING
3936 int
3937 Perl_re_exec_indentf(pTHX_ const char *fmt, U32 depth, ...)
3938 {
3939     va_list ap;
3940     int result;
3941     PerlIO *f= Perl_debug_log;
3942     PERL_ARGS_ASSERT_RE_EXEC_INDENTF;
3943     va_start(ap, depth);
3944     PerlIO_printf(f, "%*s|%4" UVuf "| %*s", REPORT_CODE_OFF, "", (UV)depth, INDENT_CHARS(depth), "" );
3945     result = PerlIO_vprintf(f, fmt, ap);
3946     va_end(ap);
3947     return result;
3948 }
3949 #endif /* DEBUGGING */
3950
3951 /* grab a new slab and return the first slot in it */
3952
3953 STATIC regmatch_state *
3954 S_push_slab(pTHX)
3955 {
3956     regmatch_slab *s = PL_regmatch_slab->next;
3957     if (!s) {
3958         Newx(s, 1, regmatch_slab);
3959         s->prev = PL_regmatch_slab;
3960         s->next = NULL;
3961         PL_regmatch_slab->next = s;
3962     }
3963     PL_regmatch_slab = s;
3964     return SLAB_FIRST(s);
3965 }
3966
3967 #ifdef DEBUGGING
3968
3969 STATIC void
3970 S_debug_start_match(pTHX_ const REGEXP *prog, const bool utf8_target,
3971     const char *start, const char *end, const char *blurb)
3972 {
3973     const bool utf8_pat = RX_UTF8(prog) ? 1 : 0;
3974
3975     PERL_ARGS_ASSERT_DEBUG_START_MATCH;
3976
3977     if (!PL_colorset)   
3978             reginitcolors();    
3979     {
3980         RE_PV_QUOTED_DECL(s0, utf8_pat, PERL_DEBUG_PAD_ZERO(0), 
3981             RX_PRECOMP_const(prog), RX_PRELEN(prog), PL_dump_re_max_len);
3982         
3983         RE_PV_QUOTED_DECL(s1, utf8_target, PERL_DEBUG_PAD_ZERO(1),
3984             start, end - start, PL_dump_re_max_len);
3985         
3986         Perl_re_printf( aTHX_
3987             "%s%s REx%s %s against %s\n", 
3988                        PL_colors[4], blurb, PL_colors[5], s0, s1); 
3989         
3990         if (utf8_target||utf8_pat)
3991             Perl_re_printf( aTHX_  "UTF-8 %s%s%s...\n",
3992                 utf8_pat ? "pattern" : "",
3993                 utf8_pat && utf8_target ? " and " : "",
3994                 utf8_target ? "string" : ""
3995             ); 
3996     }
3997 }
3998
3999 STATIC void
4000 S_dump_exec_pos(pTHX_ const char *locinput, 
4001                       const regnode *scan, 
4002                       const char *loc_regeol, 
4003                       const char *loc_bostr, 
4004                       const char *loc_reg_starttry,
4005                       const bool utf8_target,
4006                       const U32 depth
4007                 )
4008 {
4009     const int docolor = *PL_colors[0] || *PL_colors[2] || *PL_colors[4];
4010     const int taill = (docolor ? 10 : 7); /* 3 chars for "> <" */
4011     int l = (loc_regeol - locinput) > taill ? taill : (loc_regeol - locinput);
4012     /* The part of the string before starttry has one color
4013        (pref0_len chars), between starttry and current
4014        position another one (pref_len - pref0_len chars),
4015        after the current position the third one.
4016        We assume that pref0_len <= pref_len, otherwise we
4017        decrease pref0_len.  */
4018     int pref_len = (locinput - loc_bostr) > (5 + taill) - l
4019         ? (5 + taill) - l : locinput - loc_bostr;
4020     int pref0_len;
4021
4022     PERL_ARGS_ASSERT_DUMP_EXEC_POS;
4023
4024     while (utf8_target && UTF8_IS_CONTINUATION(*(U8*)(locinput - pref_len)))
4025         pref_len++;
4026     pref0_len = pref_len  - (locinput - loc_reg_starttry);
4027     if (l + pref_len < (5 + taill) && l < loc_regeol - locinput)
4028         l = ( loc_regeol - locinput > (5 + taill) - pref_len
4029               ? (5 + taill) - pref_len : loc_regeol - locinput);
4030     while (utf8_target && UTF8_IS_CONTINUATION(*(U8*)(locinput + l)))
4031         l--;
4032     if (pref0_len < 0)
4033         pref0_len = 0;
4034     if (pref0_len > pref_len)
4035         pref0_len = pref_len;
4036     {
4037         const int is_uni = utf8_target ? 1 : 0;
4038
4039         RE_PV_COLOR_DECL(s0,len0,is_uni,PERL_DEBUG_PAD(0),
4040             (locinput - pref_len),pref0_len, PL_dump_re_max_len, 4, 5);
4041         
4042         RE_PV_COLOR_DECL(s1,len1,is_uni,PERL_DEBUG_PAD(1),
4043                     (locinput - pref_len + pref0_len),
4044                     pref_len - pref0_len, PL_dump_re_max_len, 2, 3);
4045         
4046         RE_PV_COLOR_DECL(s2,len2,is_uni,PERL_DEBUG_PAD(2),
4047                     locinput, loc_regeol - locinput, 10, 0, 1);
4048
4049         const STRLEN tlen=len0+len1+len2;
4050         Perl_re_printf( aTHX_
4051                     "%4" IVdf " <%.*s%.*s%s%.*s>%*s|%4u| ",
4052                     (IV)(locinput - loc_bostr),
4053                     len0, s0,
4054                     len1, s1,
4055                     (docolor ? "" : "> <"),
4056                     len2, s2,
4057                     (int)(tlen > 19 ? 0 :  19 - tlen),
4058                     "",
4059                     depth);
4060     }
4061 }
4062
4063 #endif
4064
4065 /* reg_check_named_buff_matched()
4066  * Checks to see if a named buffer has matched. The data array of 
4067  * buffer numbers corresponding to the buffer is expected to reside
4068  * in the regexp->data->data array in the slot stored in the ARG() of
4069  * node involved. Note that this routine doesn't actually care about the
4070  * name, that information is not preserved from compilation to execution.
4071  * Returns the index of the leftmost defined buffer with the given name
4072  * or 0 if non of the buffers matched.
4073  */
4074 STATIC I32
4075 S_reg_check_named_buff_matched(const regexp *rex, const regnode *scan)
4076 {
4077     I32 n;
4078     RXi_GET_DECL(rex,rexi);
4079     SV *sv_dat= MUTABLE_SV(rexi->data->data[ ARG( scan ) ]);
4080     I32 *nums=(I32*)SvPVX(sv_dat);
4081
4082     PERL_ARGS_ASSERT_REG_CHECK_NAMED_BUFF_MATCHED;
4083
4084     for ( n=0; n<SvIVX(sv_dat); n++ ) {
4085         if ((I32)rex->lastparen >= nums[n] &&
4086             rex->offs[nums[n]].end != -1)
4087         {
4088             return nums[n];
4089         }
4090     }
4091     return 0;
4092 }
4093
4094 #define CHRTEST_UNINIT -1001 /* c1/c2 haven't been calculated yet */
4095 #define CHRTEST_VOID   -1000 /* the c1/c2 "next char" test should be skipped */
4096 #define CHRTEST_NOT_A_CP_1 -999
4097 #define CHRTEST_NOT_A_CP_2 -998
4098
4099 static bool
4100 S_setup_EXACTISH_ST_c1_c2(pTHX_ const regnode * const text_node, int *c1p,
4101         U8* c1_utf8, int *c2p, U8* c2_utf8, regmatch_info *reginfo)
4102 {
4103     /* This function determines if there are zero, one, two, or more characters
4104      * that match the first character of the passed-in EXACTish node
4105      * <text_node>, and if there are one or two, it returns them in the
4106      * passed-in pointers.
4107      *
4108      * If it determines that no possible character in the target string can
4109      * match, it returns FALSE; otherwise TRUE.  (The FALSE situation occurs if
4110      * the first character in <text_node> requires UTF-8 to represent, and the
4111      * target string isn't in UTF-8.)
4112      *
4113      * If there are more than two characters that could match the beginning of
4114      * <text_node>, or if more context is required to determine a match or not,
4115      * it sets both *<c1p> and *<c2p> to CHRTEST_VOID.
4116      *
4117      * The motiviation behind this function is to allow the caller to set up
4118      * tight loops for matching.  If <text_node> is of type EXACT, there is
4119      * only one possible character that can match its first character, and so
4120      * the situation is quite simple.  But things get much more complicated if
4121      * folding is involved.  It may be that the first character of an EXACTFish
4122      * node doesn't participate in any possible fold, e.g., punctuation, so it
4123      * can be matched only by itself.  The vast majority of characters that are
4124      * in folds match just two things, their lower and upper-case equivalents.
4125      * But not all are like that; some have multiple possible matches, or match
4126      * sequences of more than one character.  This function sorts all that out.
4127      *
4128      * Consider the patterns A*B or A*?B where A and B are arbitrary.  In a
4129      * loop of trying to match A*, we know we can't exit where the thing
4130      * following it isn't a B.  And something can't be a B unless it is the
4131      * beginning of B.  By putting a quick test for that beginning in a tight
4132      * loop, we can rule out things that can't possibly be B without having to
4133      * break out of the loop, thus avoiding work.  Similarly, if A is a single
4134      * character, we can make a tight loop matching A*, using the outputs of
4135      * this function.
4136      *
4137      * If the target string to match isn't in UTF-8, and there aren't
4138      * complications which require CHRTEST_VOID, *<c1p> and *<c2p> are set to
4139      * the one or two possible octets (which are characters in this situation)
4140      * that can match.  In all cases, if there is only one character that can
4141      * match, *<c1p> and *<c2p> will be identical.
4142      *
4143      * If the target string is in UTF-8, the buffers pointed to by <c1_utf8>
4144      * and <c2_utf8> will contain the one or two UTF-8 sequences of bytes that
4145      * can match the beginning of <text_node>.  They should be declared with at
4146      * least length UTF8_MAXBYTES+1.  (If the target string isn't in UTF-8, it is
4147      * undefined what these contain.)  If one or both of the buffers are
4148      * invariant under UTF-8, *<c1p>, and *<c2p> will also be set to the
4149      * corresponding invariant.  If variant, the corresponding *<c1p> and/or
4150      * *<c2p> will be set to a negative number(s) that shouldn't match any code
4151      * point (unless inappropriately coerced to unsigned).   *<c1p> will equal
4152      * *<c2p> if and only if <c1_utf8> and <c2_utf8> are the same. */
4153
4154     const bool utf8_target = reginfo->is_utf8_target;
4155
4156     UV c1 = (UV)CHRTEST_NOT_A_CP_1;
4157     UV c2 = (UV)CHRTEST_NOT_A_CP_2;
4158     bool use_chrtest_void = FALSE;
4159     const bool is_utf8_pat = reginfo->is_utf8_pat;
4160
4161     /* Used when we have both utf8 input and utf8 output, to avoid converting
4162      * to/from code points */
4163     bool utf8_has_been_setup = FALSE;
4164
4165     dVAR;
4166
4167     U8 *pat = (U8*)STRING(text_node);
4168     U8 folded[UTF8_MAX_FOLD_CHAR_EXPAND * UTF8_MAXBYTES_CASE + 1] = { '\0' };
4169
4170     if (   OP(text_node) == EXACT
4171         || OP(text_node) == EXACT_ONLY8
4172         || OP(text_node) == EXACTL)
4173     {
4174
4175         /* In an exact node, only one thing can be matched, that first
4176          * character.  If both the pat and the target are UTF-8, we can just
4177          * copy the input to the output, avoiding finding the code point of
4178          * that character */
4179         if (!is_utf8_pat) {
4180             assert(OP(text_node) != EXACT_ONLY8);
4181             c2 = c1 = *pat;
4182         }
4183         else if (utf8_target) {
4184             Copy(pat, c1_utf8, UTF8SKIP(pat), U8);
4185             Copy(pat, c2_utf8, UTF8SKIP(pat), U8);
4186             utf8_has_been_setup = TRUE;
4187         }
4188         else if (OP(text_node) == EXACT_ONLY8) {
4189             return FALSE;   /* Can only match UTF-8 target */
4190         }
4191         else {
4192             c2 = c1 = valid_utf8_to_uvchr(pat, NULL);
4193         }
4194     }
4195     else { /* an EXACTFish node */
4196         U8 *pat_end = pat + STR_LEN(text_node);
4197
4198         /* An EXACTFL node has at least some characters unfolded, because what
4199          * they match is not known until now.  So, now is the time to fold
4200          * the first few of them, as many as are needed to determine 'c1' and
4201          * 'c2' later in the routine.  If the pattern isn't UTF-8, we only need
4202          * to fold if in a UTF-8 locale, and then only the Sharp S; everything
4203          * else is 1-1 and isn't assumed to be folded.  In a UTF-8 pattern, we
4204          * need to fold as many characters as a single character can fold to,
4205          * so that later we can check if the first ones are such a multi-char
4206          * fold.  But, in such a pattern only locale-problematic characters
4207          * aren't folded, so we can skip this completely if the first character
4208          * in the node isn't one of the tricky ones */
4209         if (OP(text_node) == EXACTFL) {
4210
4211             if (! is_utf8_pat) {
4212                 if (IN_UTF8_CTYPE_LOCALE && *pat == LATIN_SMALL_LETTER_SHARP_S)
4213                 {
4214                     folded[0] = folded[1] = 's';
4215                     pat = folded;
4216                     pat_end = folded + 2;
4217                 }
4218             }
4219             else if (is_PROBLEMATIC_LOCALE_FOLDEDS_START_utf8(pat)) {
4220                 U8 *s = pat;
4221                 U8 *d = folded;
4222                 int i;
4223
4224                 for (i = 0; i < UTF8_MAX_FOLD_CHAR_EXPAND && s < pat_end; i++) {
4225                     if (isASCII(*s) && LIKELY(! PL_in_utf8_turkic_locale)) {
4226                         *(d++) = (U8) toFOLD_LC(*s);
4227                         s++;
4228                     }
4229                     else {
4230                         STRLEN len;
4231                         _toFOLD_utf8_flags(s,
4232                                            pat_end,
4233                                            d,
4234                                            &len,
4235                                            FOLD_FLAGS_FULL | FOLD_FLAGS_LOCALE);
4236                         d += len;
4237                         s += UTF8SKIP(s);
4238                     }
4239                 }
4240
4241                 pat = folded;
4242                 pat_end = d;
4243             }
4244         }
4245
4246         if (    ( is_utf8_pat && is_MULTI_CHAR_FOLD_utf8_safe(pat, pat_end))
4247              || (!is_utf8_pat && is_MULTI_CHAR_FOLD_latin1_safe(pat, pat_end)))
4248         {
4249             /* Multi-character folds require more context to sort out.  Also
4250              * PL_utf8_foldclosures used below doesn't handle them, so have to
4251              * be handled outside this routine */
4252             use_chrtest_void = TRUE;
4253         }
4254         else { /* an EXACTFish node which doesn't begin with a multi-char fold */
4255             c1 = is_utf8_pat ? valid_utf8_to_uvchr(pat, NULL) : *pat;
4256
4257             if (   UNLIKELY(PL_in_utf8_turkic_locale)
4258                 && OP(text_node) == EXACTFL
4259                 && UNLIKELY(   c1 == 'i' || c1 == 'I'
4260                             || c1 == LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE
4261                             || c1 == LATIN_SMALL_LETTER_DOTLESS_I))
4262             {   /* Hard-coded Turkish locale rules for these 4 characters
4263                    override normal rules */
4264                 if (c1 == 'i') {
4265                     c2 = LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE;
4266                 }
4267                 else if (c1 == 'I') {
4268                     c2 = LATIN_SMALL_LETTER_DOTLESS_I;
4269                 }
4270                 else if (c1 == LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE) {
4271                     c2 = 'i';
4272                 }
4273                 else if (c1 == LATIN_SMALL_LETTER_DOTLESS_I) {
4274                     c2 = 'I';
4275                 }
4276             }
4277             else if (c1 > 255) {
4278                 const unsigned int * remaining_folds;
4279                 unsigned int first_fold;
4280
4281                 /* Look up what code points (besides c1) fold to c1;  e.g.,
4282                  * [ 'K', KELVIN_SIGN ] both fold to 'k'. */
4283                 Size_t folds_count = _inverse_folds(c1, &first_fold,
4284                                                        &remaining_folds);
4285                 if (folds_count == 0) {
4286                     c2 = c1;    /* there is only a single character that could
4287                                    match */
4288                 }
4289                 else if (folds_count != 1) {
4290                     /* If there aren't exactly two folds to this (itself and
4291                      * another), it is outside the scope of this function */
4292                     use_chrtest_void = TRUE;
4293                 }
4294                 else {  /* There are two.  We already have one, get the other */
4295                     c2 = first_fold;
4296
4297                     /* Folds that cross the 255/256 boundary are forbidden if
4298                      * EXACTFL (and isnt a UTF8 locale), or EXACTFAA and one is
4299                      * ASCIII.  The only other match to c1 is c2, and since c1
4300                      * is above 255, c2 better be as well under these
4301                      * circumstances.  If it isn't, it means the only legal
4302                      * match of c1 is itself. */
4303                     if (    c2 < 256
4304                         && (   (   OP(text_node) == EXACTFL
4305                                 && ! IN_UTF8_CTYPE_LOCALE)
4306                             || ((     OP(text_node) == EXACTFAA
4307                                    || OP(text_node) == EXACTFAA_NO_TRIE)
4308                                 && (isASCII(c1) || isASCII(c2)))))
4309                     {
4310                         c2 = c1;
4311                     }
4312                 }
4313             }
4314             else /* Here, c1 is <= 255 */
4315                 if (   utf8_target
4316                     && HAS_NONLATIN1_FOLD_CLOSURE(c1)
4317                     && ( ! (OP(text_node) == EXACTFL && ! IN_UTF8_CTYPE_LOCALE))
4318                     && (   (   OP(text_node) != EXACTFAA
4319                             && OP(text_node) != EXACTFAA_NO_TRIE)
4320                         ||   ! isASCII(c1)))
4321             {
4322                 /* Here, there could be something above Latin1 in the target
4323                  * which folds to this character in the pattern.  All such
4324                  * cases except LATIN SMALL LETTER Y WITH DIAERESIS have more
4325                  * than two characters involved in their folds, so are outside
4326                  * the scope of this function */
4327                 if (UNLIKELY(c1 == LATIN_SMALL_LETTER_Y_WITH_DIAERESIS)) {
4328                     c2 = LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS;
4329                 }
4330                 else {
4331                     use_chrtest_void = TRUE;
4332                 }
4333             }
4334             else { /* Here nothing above Latin1 can fold to the pattern
4335                       character */
4336                 switch (OP(text_node)) {
4337
4338                     case EXACTFL:   /* /l rules */
4339                         c2 = PL_fold_locale[c1];
4340                         break;
4341
4342                     case EXACTF:   /* This node only generated for non-utf8
4343                                     patterns */
4344                         assert(! is_utf8_pat);
4345                         if (! utf8_target) {    /* /d rules */
4346                             c2 = PL_fold[c1];
4347                             break;
4348                         }
4349                         /* FALLTHROUGH */
4350                         /* /u rules for all these.  This happens to work for
4351                         * EXACTFAA as nothing in Latin1 folds to ASCII */
4352                     case EXACTFAA_NO_TRIE:   /* This node only generated for
4353                                                 non-utf8 patterns */
4354                         assert(! is_utf8_pat);
4355                         /* FALLTHROUGH */
4356                     case EXACTFAA:
4357                     case EXACTFUP:
4358                     case EXACTFU:
4359                         c2 = PL_fold_latin1[c1];
4360                         break;
4361                     case EXACTFU_ONLY8:
4362                         return FALSE;
4363                         NOT_REACHED; /* NOTREACHED */
4364
4365                     default:
4366                         Perl_croak(aTHX_ "panic: Unexpected op %u", OP(text_node));
4367                         NOT_REACHED; /* NOTREACHED */
4368                 }
4369             }
4370         }
4371     }
4372
4373     /* Here have figured things out.  Set up the returns */
4374     if (use_chrtest_void) {
4375         *c2p = *c1p = CHRTEST_VOID;
4376     }
4377     else if (utf8_target) {
4378         if (! utf8_has_been_setup) {    /* Don't have the utf8; must get it */
4379             uvchr_to_utf8(c1_utf8, c1);
4380             uvchr_to_utf8(c2_utf8, c2);
4381         }
4382
4383         /* Invariants are stored in both the utf8 and byte outputs; Use
4384          * negative numbers otherwise for the byte ones.  Make sure that the
4385          * byte ones are the same iff the utf8 ones are the same */
4386         *c1p = (UTF8_IS_INVARIANT(*c1_utf8)) ? *c1_utf8 : CHRTEST_NOT_A_CP_1;
4387         *c2p = (UTF8_IS_INVARIANT(*c2_utf8))
4388                 ? *c2_utf8
4389                 : (c1 == c2)
4390                   ? CHRTEST_NOT_A_CP_1
4391                   : CHRTEST_NOT_A_CP_2;
4392     }
4393     else if (c1 > 255) {
4394        if (c2 > 255) {  /* both possibilities are above what a non-utf8 string
4395                            can represent */
4396            return FALSE;
4397        }
4398
4399        *c1p = *c2p = c2;    /* c2 is the only representable value */
4400     }
4401     else {  /* c1 is representable; see about c2 */
4402        *c1p = c1;
4403        *c2p = (c2 < 256) ? c2 : c1;
4404     }
4405
4406     return TRUE;
4407 }
4408
4409 STATIC bool
4410 S_isGCB(pTHX_ const GCB_enum before, const GCB_enum after, const U8 * const strbeg, const U8 * const curpos, const bool utf8_target)
4411 {
4412     /* returns a boolean indicating if there is a Grapheme Cluster Boundary
4413      * between the inputs.  See http://www.unicode.org/reports/tr29/. */
4414
4415     PERL_ARGS_ASSERT_ISGCB;
4416
4417     switch (GCB_table[before][after]) {
4418         case GCB_BREAKABLE:
4419             return TRUE;
4420
4421         case GCB_NOBREAK:
4422             return FALSE;
4423
4424         case GCB_RI_then_RI:
4425             {
4426                 int RI_count = 1;
4427                 U8 * temp_pos = (U8 *) curpos;
4428
4429                 /* Do not break within emoji flag sequences. That is, do not
4430                  * break between regional indicator (RI) symbols if there is an
4431                  * odd number of RI characters before the break point.
4432                  *  GB12   sot (RI RI)* RI × RI
4433                  *  GB13 [^RI] (RI RI)* RI × RI */
4434
4435                 while (backup_one_GCB(strbeg,
4436                                     &temp_pos,
4437                                     utf8_target) == GCB_Regional_Indicator)
4438                 {
4439                     RI_count++;
4440                 }
4441
4442                 return RI_count % 2 != 1;
4443             }
4444
4445         case GCB_EX_then_EM:
4446
4447             /* GB10  ( E_Base | E_Base_GAZ ) Extend* ×  E_Modifier */
4448             {
4449                 U8 * temp_pos = (U8 *) curpos;
4450                 GCB_enum prev;
4451
4452                 do {
4453                     prev = backup_one_GCB(strbeg, &temp_pos, utf8_target);
4454                 }
4455                 while (prev == GCB_Extend);
4456
4457                 return prev != GCB_E_Base && prev != GCB_E_Base_GAZ;
4458             }
4459
4460         case GCB_Maybe_Emoji_NonBreak:
4461
4462             {
4463
4464             /* Do not break within emoji modifier sequences or emoji zwj sequences.
4465               GB11 \p{Extended_Pictographic} Extend* ZWJ × \p{Extended_Pictographic}
4466               */
4467                 U8 * temp_pos = (U8 *) curpos;
4468                 GCB_enum prev;
4469
4470                 do {
4471                     prev = backup_one_GCB(strbeg, &temp_pos, utf8_target);
4472                 }
4473                 while (prev == GCB_Extend);
4474
4475                 return prev != GCB_XPG_XX;
4476             }
4477
4478         default:
4479             break;
4480     }
4481
4482 #ifdef DEBUGGING
4483     Perl_re_printf( aTHX_  "Unhandled GCB pair: GCB_table[%d, %d] = %d\n",
4484                                   before, after, GCB_table[before][after]);
4485     assert(0);
4486 #endif
4487     return TRUE;
4488 }
4489
4490 STATIC GCB_enum
4491 S_backup_one_GCB(pTHX_ const U8 * const strbeg, U8 ** curpos, const bool utf8_target)
4492 {
4493     dVAR;
4494     GCB_enum gcb;
4495
4496     PERL_ARGS_ASSERT_BACKUP_ONE_GCB;
4497
4498     if (*curpos < strbeg) {
4499         return GCB_EDGE;
4500     }
4501
4502     if (utf8_target) {
4503         U8 * prev_char_pos = reghopmaybe3(*curpos, -1, strbeg);
4504         U8 * prev_prev_char_pos;
4505
4506         if (! prev_char_pos) {