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