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