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