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