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