This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
regexec.c: Clean up macro/code interface slightly
[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(TEST_UV, 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 = TEST_UV(tmp);                                                    \
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, TEST_UV, TEST2_UTF8) \
1612     FBC_BOUND_COMMON(FBC_UTF8(TEST_UV, TEST2_UTF8, REXEC_FBC_TRYIT, PLACEHOLDER), TEST_NON_UTF8, REXEC_FBC_TRYIT, PLACEHOLDER)
1613
1614 #define FBC_BOUND_A(TEST_NON_UTF8, TEST_UV, 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, TEST_UV, TEST2_UTF8) \
1618     FBC_BOUND_COMMON(FBC_UTF8(TEST_UV, TEST2_UTF8, PLACEHOLDER, REXEC_FBC_TRYIT), TEST_NON_UTF8, PLACEHOLDER, REXEC_FBC_TRYIT)
1619
1620 #define FBC_NBOUND_A(TEST_NON_UTF8, TEST_UV, 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 /* Common to the BOUND and NBOUND cases.  Unfortunately the UTF8 tests need to
1624  * be passed in completely with the variable name being tested, which isn't
1625  * such a clean interface, but this is easier to read than it was before.  We
1626  * are looking for the boundary (or non-boundary between a word and non-word
1627  * character.  The utf8 and non-utf8 cases have the same logic, but the details
1628  * must be different.  Find the "wordness" of the character just prior to this
1629  * one, and compare it with the wordness of this one.  If they differ, we have
1630  * a boundary.  At the beginning of the string, pretend that the previous
1631  * character was a new-line */
1632 #define FBC_BOUND_COMMON(UTF8_CODE, TEST_NON_UTF8, IF_SUCCESS, IF_FAIL)        \
1633     if (utf8_target) {                                                         \
1634                 UTF8_CODE                                                      \
1635     }                                                                          \
1636     else {  /* Not utf8 */                                                     \
1637         tmp = (s != reginfo->strbeg) ? UCHARAT(s - 1) : '\n';                  \
1638         tmp = TEST_NON_UTF8(tmp);                                              \
1639         REXEC_FBC_SCAN(                                                        \
1640             if (tmp == ! TEST_NON_UTF8((U8) *s)) {                             \
1641                 tmp = !tmp;                                                    \
1642                 IF_SUCCESS;                                                    \
1643             }                                                                  \
1644             else {                                                             \
1645                 IF_FAIL;                                                       \
1646             }                                                                  \
1647         );                                                                     \
1648     }                                                                          \
1649     if ((!prog->minlen && tmp) && (reginfo->intuit || regtry(reginfo, &s)))    \
1650         goto got_it;
1651
1652 /* We know what class REx starts with.  Try to find this position... */
1653 /* if reginfo->intuit, its a dryrun */
1654 /* annoyingly all the vars in this routine have different names from their counterparts
1655    in regmatch. /grrr */
1656
1657 STATIC char *
1658 S_find_byclass(pTHX_ regexp * prog, const regnode *c, char *s, 
1659     const char *strend, regmatch_info *reginfo)
1660 {
1661     dVAR;
1662     const I32 doevery = (prog->intflags & PREGf_SKIP) == 0;
1663     char *pat_string;   /* The pattern's exactish string */
1664     char *pat_end;          /* ptr to end char of pat_string */
1665     re_fold_t folder;   /* Function for computing non-utf8 folds */
1666     const U8 *fold_array;   /* array for folding ords < 256 */
1667     STRLEN ln;
1668     STRLEN lnc;
1669     U8 c1;
1670     U8 c2;
1671     char *e;
1672     I32 tmp = 1;        /* Scratch variable? */
1673     const bool utf8_target = reginfo->is_utf8_target;
1674     UV utf8_fold_flags = 0;
1675     const bool is_utf8_pat = reginfo->is_utf8_pat;
1676     bool to_complement = FALSE; /* Invert the result?  Taking the xor of this
1677                                    with a result inverts that result, as 0^1 =
1678                                    1 and 1^1 = 0 */
1679     _char_class_number classnum;
1680
1681     RXi_GET_DECL(prog,progi);
1682
1683     PERL_ARGS_ASSERT_FIND_BYCLASS;
1684
1685     /* We know what class it must start with. */
1686     switch (OP(c)) {
1687     case ANYOF:
1688         if (utf8_target) {
1689             REXEC_FBC_UTF8_CLASS_SCAN(
1690                       reginclass(prog, c, (U8*)s, (U8*) strend, utf8_target));
1691         }
1692         else {
1693             REXEC_FBC_CLASS_SCAN(REGINCLASS(prog, c, (U8*)s));
1694         }
1695         break;
1696     case CANY:
1697         REXEC_FBC_SCAN(
1698             if (tmp && (reginfo->intuit || regtry(reginfo, &s)))
1699                 goto got_it;
1700             else
1701                 tmp = doevery;
1702         );
1703         break;
1704
1705     case EXACTFA_NO_TRIE:   /* This node only generated for non-utf8 patterns */
1706         assert(! is_utf8_pat);
1707         /* FALLTHROUGH */
1708     case EXACTFA:
1709         if (is_utf8_pat || utf8_target) {
1710             utf8_fold_flags = FOLDEQ_UTF8_NOMIX_ASCII;
1711             goto do_exactf_utf8;
1712         }
1713         fold_array = PL_fold_latin1;    /* Latin1 folds are not affected by */
1714         folder = foldEQ_latin1;         /* /a, except the sharp s one which */
1715         goto do_exactf_non_utf8;        /* isn't dealt with by these */
1716
1717     case EXACTF:   /* This node only generated for non-utf8 patterns */
1718         assert(! is_utf8_pat);
1719         if (utf8_target) {
1720             utf8_fold_flags = 0;
1721             goto do_exactf_utf8;
1722         }
1723         fold_array = PL_fold;
1724         folder = foldEQ;
1725         goto do_exactf_non_utf8;
1726
1727     case EXACTFL:
1728         if (is_utf8_pat || utf8_target || IN_UTF8_CTYPE_LOCALE) {
1729             utf8_fold_flags = FOLDEQ_LOCALE;
1730             goto do_exactf_utf8;
1731         }
1732         fold_array = PL_fold_locale;
1733         folder = foldEQ_locale;
1734         goto do_exactf_non_utf8;
1735
1736     case EXACTFU_SS:
1737         if (is_utf8_pat) {
1738             utf8_fold_flags = FOLDEQ_S2_ALREADY_FOLDED;
1739         }
1740         goto do_exactf_utf8;
1741
1742     case EXACTFU:
1743         if (is_utf8_pat || utf8_target) {
1744             utf8_fold_flags = is_utf8_pat ? FOLDEQ_S2_ALREADY_FOLDED : 0;
1745             goto do_exactf_utf8;
1746         }
1747
1748         /* Any 'ss' in the pattern should have been replaced by regcomp,
1749          * so we don't have to worry here about this single special case
1750          * in the Latin1 range */
1751         fold_array = PL_fold_latin1;
1752         folder = foldEQ_latin1;
1753
1754         /* FALLTHROUGH */
1755
1756     do_exactf_non_utf8: /* Neither pattern nor string are UTF8, and there
1757                            are no glitches with fold-length differences
1758                            between the target string and pattern */
1759
1760         /* The idea in the non-utf8 EXACTF* cases is to first find the
1761          * first character of the EXACTF* node and then, if necessary,
1762          * case-insensitively compare the full text of the node.  c1 is the
1763          * first character.  c2 is its fold.  This logic will not work for
1764          * Unicode semantics and the german sharp ss, which hence should
1765          * not be compiled into a node that gets here. */
1766         pat_string = STRING(c);
1767         ln  = STR_LEN(c);       /* length to match in octets/bytes */
1768
1769         /* We know that we have to match at least 'ln' bytes (which is the
1770          * same as characters, since not utf8).  If we have to match 3
1771          * characters, and there are only 2 availabe, we know without
1772          * trying that it will fail; so don't start a match past the
1773          * required minimum number from the far end */
1774         e = HOP3c(strend, -((SSize_t)ln), s);
1775
1776         if (reginfo->intuit && e < s) {
1777             e = s;                      /* Due to minlen logic of intuit() */
1778         }
1779
1780         c1 = *pat_string;
1781         c2 = fold_array[c1];
1782         if (c1 == c2) { /* If char and fold are the same */
1783             REXEC_FBC_EXACTISH_SCAN(*(U8*)s == c1);
1784         }
1785         else {
1786             REXEC_FBC_EXACTISH_SCAN(*(U8*)s == c1 || *(U8*)s == c2);
1787         }
1788         break;
1789
1790     do_exactf_utf8:
1791     {
1792         unsigned expansion;
1793
1794         /* If one of the operands is in utf8, we can't use the simpler folding
1795          * above, due to the fact that many different characters can have the
1796          * same fold, or portion of a fold, or different- length fold */
1797         pat_string = STRING(c);
1798         ln  = STR_LEN(c);       /* length to match in octets/bytes */
1799         pat_end = pat_string + ln;
1800         lnc = is_utf8_pat       /* length to match in characters */
1801                 ? utf8_length((U8 *) pat_string, (U8 *) pat_end)
1802                 : ln;
1803
1804         /* We have 'lnc' characters to match in the pattern, but because of
1805          * multi-character folding, each character in the target can match
1806          * up to 3 characters (Unicode guarantees it will never exceed
1807          * this) if it is utf8-encoded; and up to 2 if not (based on the
1808          * fact that the Latin 1 folds are already determined, and the
1809          * only multi-char fold in that range is the sharp-s folding to
1810          * 'ss'.  Thus, a pattern character can match as little as 1/3 of a
1811          * string character.  Adjust lnc accordingly, rounding up, so that
1812          * if we need to match at least 4+1/3 chars, that really is 5. */
1813         expansion = (utf8_target) ? UTF8_MAX_FOLD_CHAR_EXPAND : 2;
1814         lnc = (lnc + expansion - 1) / expansion;
1815
1816         /* As in the non-UTF8 case, if we have to match 3 characters, and
1817          * only 2 are left, it's guaranteed to fail, so don't start a
1818          * match that would require us to go beyond the end of the string
1819          */
1820         e = HOP3c(strend, -((SSize_t)lnc), s);
1821
1822         if (reginfo->intuit && e < s) {
1823             e = s;                      /* Due to minlen logic of intuit() */
1824         }
1825
1826         /* XXX Note that we could recalculate e to stop the loop earlier,
1827          * as the worst case expansion above will rarely be met, and as we
1828          * go along we would usually find that e moves further to the left.
1829          * This would happen only after we reached the point in the loop
1830          * where if there were no expansion we should fail.  Unclear if
1831          * worth the expense */
1832
1833         while (s <= e) {
1834             char *my_strend= (char *)strend;
1835             if (foldEQ_utf8_flags(s, &my_strend, 0,  utf8_target,
1836                   pat_string, NULL, ln, is_utf8_pat, utf8_fold_flags)
1837                 && (reginfo->intuit || regtry(reginfo, &s)) )
1838             {
1839                 goto got_it;
1840             }
1841             s += (utf8_target) ? UTF8SKIP(s) : 1;
1842         }
1843         break;
1844     }
1845     case BOUNDL:
1846         FBC_BOUND(isWORDCHAR_LC,
1847                   isWORDCHAR_LC_uvchr,
1848                   isWORDCHAR_LC_utf8((U8*)s));
1849         break;
1850     case NBOUNDL:
1851         FBC_NBOUND(isWORDCHAR_LC,
1852                    isWORDCHAR_LC_uvchr,
1853                    isWORDCHAR_LC_utf8((U8*)s));
1854         break;
1855     case BOUND:
1856         FBC_BOUND(isWORDCHAR,
1857                   isWORDCHAR_uni,
1858                   cBOOL(swash_fetch(PL_utf8_swash_ptrs[_CC_WORDCHAR], (U8*)s, utf8_target)));
1859         break;
1860     case BOUNDA:
1861         FBC_BOUND_A(isWORDCHAR_A,
1862                     isWORDCHAR_A,
1863                     isWORDCHAR_A((U8*)s));
1864         break;
1865     case NBOUND:
1866         FBC_NBOUND(isWORDCHAR,
1867                    isWORDCHAR_uni,
1868                    cBOOL(swash_fetch(PL_utf8_swash_ptrs[_CC_WORDCHAR], (U8*)s, utf8_target)));
1869         break;
1870     case NBOUNDA:
1871         FBC_NBOUND_A(isWORDCHAR_A,
1872                      isWORDCHAR_A,
1873                      isWORDCHAR_A((U8*)s));
1874         break;
1875     case BOUNDU:
1876         FBC_BOUND(isWORDCHAR_L1,
1877                   isWORDCHAR_uni,
1878                   cBOOL(swash_fetch(PL_utf8_swash_ptrs[_CC_WORDCHAR], (U8*)s, utf8_target)));
1879         break;
1880     case NBOUNDU:
1881         FBC_NBOUND(isWORDCHAR_L1,
1882                    isWORDCHAR_uni,
1883                    cBOOL(swash_fetch(PL_utf8_swash_ptrs[_CC_WORDCHAR], (U8*)s, utf8_target)));
1884         break;
1885     case LNBREAK:
1886         REXEC_FBC_CSCAN(is_LNBREAK_utf8_safe(s, strend),
1887                         is_LNBREAK_latin1_safe(s, strend)
1888         );
1889         break;
1890
1891     /* The argument to all the POSIX node types is the class number to pass to
1892      * _generic_isCC() to build a mask for searching in PL_charclass[] */
1893
1894     case NPOSIXL:
1895         to_complement = 1;
1896         /* FALLTHROUGH */
1897
1898     case POSIXL:
1899         REXEC_FBC_CSCAN(to_complement ^ cBOOL(isFOO_utf8_lc(FLAGS(c), (U8 *) s)),
1900                         to_complement ^ cBOOL(isFOO_lc(FLAGS(c), *s)));
1901         break;
1902
1903     case NPOSIXD:
1904         to_complement = 1;
1905         /* FALLTHROUGH */
1906
1907     case POSIXD:
1908         if (utf8_target) {
1909             goto posix_utf8;
1910         }
1911         goto posixa;
1912
1913     case NPOSIXA:
1914         if (utf8_target) {
1915             /* The complement of something that matches only ASCII matches all
1916              * non-ASCII, plus everything in ASCII that isn't in the class. */
1917             REXEC_FBC_UTF8_CLASS_SCAN(! isASCII_utf8(s)
1918                                       || ! _generic_isCC_A(*s, FLAGS(c)));
1919             break;
1920         }
1921
1922         to_complement = 1;
1923         /* FALLTHROUGH */
1924
1925     case POSIXA:
1926       posixa:
1927         /* Don't need to worry about utf8, as it can match only a single
1928          * byte invariant character. */
1929         REXEC_FBC_CLASS_SCAN(
1930                         to_complement ^ cBOOL(_generic_isCC_A(*s, FLAGS(c))));
1931         break;
1932
1933     case NPOSIXU:
1934         to_complement = 1;
1935         /* FALLTHROUGH */
1936
1937     case POSIXU:
1938         if (! utf8_target) {
1939             REXEC_FBC_CLASS_SCAN(to_complement ^ cBOOL(_generic_isCC(*s,
1940                                                                     FLAGS(c))));
1941         }
1942         else {
1943
1944       posix_utf8:
1945             classnum = (_char_class_number) FLAGS(c);
1946             if (classnum < _FIRST_NON_SWASH_CC) {
1947                 while (s < strend) {
1948
1949                     /* We avoid loading in the swash as long as possible, but
1950                      * should we have to, we jump to a separate loop.  This
1951                      * extra 'if' statement is what keeps this code from being
1952                      * just a call to REXEC_FBC_UTF8_CLASS_SCAN() */
1953                     if (UTF8_IS_ABOVE_LATIN1(*s)) {
1954                         goto found_above_latin1;
1955                     }
1956                     if ((UTF8_IS_INVARIANT(*s)
1957                          && to_complement ^ cBOOL(_generic_isCC((U8) *s,
1958                                                                 classnum)))
1959                         || (UTF8_IS_DOWNGRADEABLE_START(*s)
1960                             && to_complement ^ cBOOL(
1961                                 _generic_isCC(TWO_BYTE_UTF8_TO_NATIVE(*s,
1962                                                                       *(s + 1)),
1963                                               classnum))))
1964                     {
1965                         if (tmp && (reginfo->intuit || regtry(reginfo, &s)))
1966                             goto got_it;
1967                         else {
1968                             tmp = doevery;
1969                         }
1970                     }
1971                     else {
1972                         tmp = 1;
1973                     }
1974                     s += UTF8SKIP(s);
1975                 }
1976             }
1977             else switch (classnum) {    /* These classes are implemented as
1978                                            macros */
1979                 case _CC_ENUM_SPACE: /* XXX would require separate code if we
1980                                         revert the change of \v matching this */
1981                     /* FALLTHROUGH */
1982
1983                 case _CC_ENUM_PSXSPC:
1984                     REXEC_FBC_UTF8_CLASS_SCAN(
1985                                         to_complement ^ cBOOL(isSPACE_utf8(s)));
1986                     break;
1987
1988                 case _CC_ENUM_BLANK:
1989                     REXEC_FBC_UTF8_CLASS_SCAN(
1990                                         to_complement ^ cBOOL(isBLANK_utf8(s)));
1991                     break;
1992
1993                 case _CC_ENUM_XDIGIT:
1994                     REXEC_FBC_UTF8_CLASS_SCAN(
1995                                        to_complement ^ cBOOL(isXDIGIT_utf8(s)));
1996                     break;
1997
1998                 case _CC_ENUM_VERTSPACE:
1999                     REXEC_FBC_UTF8_CLASS_SCAN(
2000                                        to_complement ^ cBOOL(isVERTWS_utf8(s)));
2001                     break;
2002
2003                 case _CC_ENUM_CNTRL:
2004                     REXEC_FBC_UTF8_CLASS_SCAN(
2005                                         to_complement ^ cBOOL(isCNTRL_utf8(s)));
2006                     break;
2007
2008                 default:
2009                     Perl_croak(aTHX_ "panic: find_byclass() node %d='%s' has an unexpected character class '%d'", OP(c), PL_reg_name[OP(c)], classnum);
2010                     assert(0); /* NOTREACHED */
2011             }
2012         }
2013         break;
2014
2015       found_above_latin1:   /* Here we have to load a swash to get the result
2016                                for the current code point */
2017         if (! PL_utf8_swash_ptrs[classnum]) {
2018             U8 flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;
2019             PL_utf8_swash_ptrs[classnum] =
2020                     _core_swash_init("utf8",
2021                                      "",
2022                                      &PL_sv_undef, 1, 0,
2023                                      PL_XPosix_ptrs[classnum], &flags);
2024         }
2025
2026         /* This is a copy of the loop above for swash classes, though using the
2027          * FBC macro instead of being expanded out.  Since we've loaded the
2028          * swash, we don't have to check for that each time through the loop */
2029         REXEC_FBC_UTF8_CLASS_SCAN(
2030                 to_complement ^ cBOOL(_generic_utf8(
2031                                       classnum,
2032                                       s,
2033                                       swash_fetch(PL_utf8_swash_ptrs[classnum],
2034                                                   (U8 *) s, TRUE))));
2035         break;
2036
2037     case AHOCORASICKC:
2038     case AHOCORASICK:
2039         {
2040             DECL_TRIE_TYPE(c);
2041             /* what trie are we using right now */
2042             reg_ac_data *aho = (reg_ac_data*)progi->data->data[ ARG( c ) ];
2043             reg_trie_data *trie = (reg_trie_data*)progi->data->data[ aho->trie ];
2044             HV *widecharmap = MUTABLE_HV(progi->data->data[ aho->trie + 1 ]);
2045
2046             const char *last_start = strend - trie->minlen;
2047 #ifdef DEBUGGING
2048             const char *real_start = s;
2049 #endif
2050             STRLEN maxlen = trie->maxlen;
2051             SV *sv_points;
2052             U8 **points; /* map of where we were in the input string
2053                             when reading a given char. For ASCII this
2054                             is unnecessary overhead as the relationship
2055                             is always 1:1, but for Unicode, especially
2056                             case folded Unicode this is not true. */
2057             U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
2058             U8 *bitmap=NULL;
2059
2060
2061             GET_RE_DEBUG_FLAGS_DECL;
2062
2063             /* We can't just allocate points here. We need to wrap it in
2064              * an SV so it gets freed properly if there is a croak while
2065              * running the match */
2066             ENTER;
2067             SAVETMPS;
2068             sv_points=newSV(maxlen * sizeof(U8 *));
2069             SvCUR_set(sv_points,
2070                 maxlen * sizeof(U8 *));
2071             SvPOK_on(sv_points);
2072             sv_2mortal(sv_points);
2073             points=(U8**)SvPV_nolen(sv_points );
2074             if ( trie_type != trie_utf8_fold
2075                  && (trie->bitmap || OP(c)==AHOCORASICKC) )
2076             {
2077                 if (trie->bitmap)
2078                     bitmap=(U8*)trie->bitmap;
2079                 else
2080                     bitmap=(U8*)ANYOF_BITMAP(c);
2081             }
2082             /* this is the Aho-Corasick algorithm modified a touch
2083                to include special handling for long "unknown char" sequences.
2084                The basic idea being that we use AC as long as we are dealing
2085                with a possible matching char, when we encounter an unknown char
2086                (and we have not encountered an accepting state) we scan forward
2087                until we find a legal starting char.
2088                AC matching is basically that of trie matching, except that when
2089                we encounter a failing transition, we fall back to the current
2090                states "fail state", and try the current char again, a process
2091                we repeat until we reach the root state, state 1, or a legal
2092                transition. If we fail on the root state then we can either
2093                terminate if we have reached an accepting state previously, or
2094                restart the entire process from the beginning if we have not.
2095
2096              */
2097             while (s <= last_start) {
2098                 const U32 uniflags = UTF8_ALLOW_DEFAULT;
2099                 U8 *uc = (U8*)s;
2100                 U16 charid = 0;
2101                 U32 base = 1;
2102                 U32 state = 1;
2103                 UV uvc = 0;
2104                 STRLEN len = 0;
2105                 STRLEN foldlen = 0;
2106                 U8 *uscan = (U8*)NULL;
2107                 U8 *leftmost = NULL;
2108 #ifdef DEBUGGING
2109                 U32 accepted_word= 0;
2110 #endif
2111                 U32 pointpos = 0;
2112
2113                 while ( state && uc <= (U8*)strend ) {
2114                     int failed=0;
2115                     U32 word = aho->states[ state ].wordnum;
2116
2117                     if( state==1 ) {
2118                         if ( bitmap ) {
2119                             DEBUG_TRIE_EXECUTE_r(
2120                                 if ( uc <= (U8*)last_start && !BITMAP_TEST(bitmap,*uc) ) {
2121                                     dump_exec_pos( (char *)uc, c, strend, real_start,
2122                                         (char *)uc, utf8_target );
2123                                     PerlIO_printf( Perl_debug_log,
2124                                         " Scanning for legal start char...\n");
2125                                 }
2126                             );
2127                             if (utf8_target) {
2128                                 while ( uc <= (U8*)last_start && !BITMAP_TEST(bitmap,*uc) ) {
2129                                     uc += UTF8SKIP(uc);
2130                                 }
2131                             } else {
2132                                 while ( uc <= (U8*)last_start  && !BITMAP_TEST(bitmap,*uc) ) {
2133                                     uc++;
2134                                 }
2135                             }
2136                             s= (char *)uc;
2137                         }
2138                         if (uc >(U8*)last_start) break;
2139                     }
2140
2141                     if ( word ) {
2142                         U8 *lpos= points[ (pointpos - trie->wordinfo[word].len) % maxlen ];
2143                         if (!leftmost || lpos < leftmost) {
2144                             DEBUG_r(accepted_word=word);
2145                             leftmost= lpos;
2146                         }
2147                         if (base==0) break;
2148
2149                     }
2150                     points[pointpos++ % maxlen]= uc;
2151                     if (foldlen || uc < (U8*)strend) {
2152                         REXEC_TRIE_READ_CHAR(trie_type, trie,
2153                                          widecharmap, uc,
2154                                          uscan, len, uvc, charid, foldlen,
2155                                          foldbuf, uniflags);
2156                         DEBUG_TRIE_EXECUTE_r({
2157                             dump_exec_pos( (char *)uc, c, strend,
2158                                         real_start, s, utf8_target);
2159                             PerlIO_printf(Perl_debug_log,
2160                                 " Charid:%3u CP:%4"UVxf" ",
2161                                  charid, uvc);
2162                         });
2163                     }
2164                     else {
2165                         len = 0;
2166                         charid = 0;
2167                     }
2168
2169
2170                     do {
2171 #ifdef DEBUGGING
2172                         word = aho->states[ state ].wordnum;
2173 #endif
2174                         base = aho->states[ state ].trans.base;
2175
2176                         DEBUG_TRIE_EXECUTE_r({
2177                             if (failed)
2178                                 dump_exec_pos( (char *)uc, c, strend, real_start,
2179                                     s,   utf8_target );
2180                             PerlIO_printf( Perl_debug_log,
2181                                 "%sState: %4"UVxf", word=%"UVxf,
2182                                 failed ? " Fail transition to " : "",
2183                                 (UV)state, (UV)word);
2184                         });
2185                         if ( base ) {
2186                             U32 tmp;
2187                             I32 offset;
2188                             if (charid &&
2189                                  ( ((offset = base + charid
2190                                     - 1 - trie->uniquecharcount)) >= 0)
2191                                  && ((U32)offset < trie->lasttrans)
2192                                  && trie->trans[offset].check == state
2193                                  && (tmp=trie->trans[offset].next))
2194                             {
2195                                 DEBUG_TRIE_EXECUTE_r(
2196                                     PerlIO_printf( Perl_debug_log," - legal\n"));
2197                                 state = tmp;
2198                                 break;
2199                             }
2200                             else {
2201                                 DEBUG_TRIE_EXECUTE_r(
2202                                     PerlIO_printf( Perl_debug_log," - fail\n"));
2203                                 failed = 1;
2204                                 state = aho->fail[state];
2205                             }
2206                         }
2207                         else {
2208                             /* we must be accepting here */
2209                             DEBUG_TRIE_EXECUTE_r(
2210                                     PerlIO_printf( Perl_debug_log," - accepting\n"));
2211                             failed = 1;
2212                             break;
2213                         }
2214                     } while(state);
2215                     uc += len;
2216                     if (failed) {
2217                         if (leftmost)
2218                             break;
2219                         if (!state) state = 1;
2220                     }
2221                 }
2222                 if ( aho->states[ state ].wordnum ) {
2223                     U8 *lpos = points[ (pointpos - trie->wordinfo[aho->states[ state ].wordnum].len) % maxlen ];
2224                     if (!leftmost || lpos < leftmost) {
2225                         DEBUG_r(accepted_word=aho->states[ state ].wordnum);
2226                         leftmost = lpos;
2227                     }
2228                 }
2229                 if (leftmost) {
2230                     s = (char*)leftmost;
2231                     DEBUG_TRIE_EXECUTE_r({
2232                         PerlIO_printf(
2233                             Perl_debug_log,"Matches word #%"UVxf" at position %"IVdf". Trying full pattern...\n",
2234                             (UV)accepted_word, (IV)(s - real_start)
2235                         );
2236                     });
2237                     if (reginfo->intuit || regtry(reginfo, &s)) {
2238                         FREETMPS;
2239                         LEAVE;
2240                         goto got_it;
2241                     }
2242                     s = HOPc(s,1);
2243                     DEBUG_TRIE_EXECUTE_r({
2244                         PerlIO_printf( Perl_debug_log,"Pattern failed. Looking for new start point...\n");
2245                     });
2246                 } else {
2247                     DEBUG_TRIE_EXECUTE_r(
2248                         PerlIO_printf( Perl_debug_log,"No match.\n"));
2249                     break;
2250                 }
2251             }
2252             FREETMPS;
2253             LEAVE;
2254         }
2255         break;
2256     default:
2257         Perl_croak(aTHX_ "panic: unknown regstclass %d", (int)OP(c));
2258     }
2259     return 0;
2260   got_it:
2261     return s;
2262 }
2263
2264 /* set RX_SAVED_COPY, RX_SUBBEG etc.
2265  * flags have same meanings as with regexec_flags() */
2266
2267 static void
2268 S_reg_set_capture_string(pTHX_ REGEXP * const rx,
2269                             char *strbeg,
2270                             char *strend,
2271                             SV *sv,
2272                             U32 flags,
2273                             bool utf8_target)
2274 {
2275     struct regexp *const prog = ReANY(rx);
2276
2277     if (flags & REXEC_COPY_STR) {
2278 #ifdef PERL_ANY_COW
2279         if (SvCANCOW(sv)) {
2280             if (DEBUG_C_TEST) {
2281                 PerlIO_printf(Perl_debug_log,
2282                               "Copy on write: regexp capture, type %d\n",
2283                               (int) SvTYPE(sv));
2284             }
2285             /* Create a new COW SV to share the match string and store
2286              * in saved_copy, unless the current COW SV in saved_copy
2287              * is valid and suitable for our purpose */
2288             if ((   prog->saved_copy
2289                  && SvIsCOW(prog->saved_copy)
2290                  && SvPOKp(prog->saved_copy)
2291                  && SvIsCOW(sv)
2292                  && SvPOKp(sv)
2293                  && SvPVX(sv) == SvPVX(prog->saved_copy)))
2294             {
2295                 /* just reuse saved_copy SV */
2296                 if (RXp_MATCH_COPIED(prog)) {
2297                     Safefree(prog->subbeg);
2298                     RXp_MATCH_COPIED_off(prog);
2299                 }
2300             }
2301             else {
2302                 /* create new COW SV to share string */
2303                 RX_MATCH_COPY_FREE(rx);
2304                 prog->saved_copy = sv_setsv_cow(prog->saved_copy, sv);
2305             }
2306             prog->subbeg = (char *)SvPVX_const(prog->saved_copy);
2307             assert (SvPOKp(prog->saved_copy));
2308             prog->sublen  = strend - strbeg;
2309             prog->suboffset = 0;
2310             prog->subcoffset = 0;
2311         } else
2312 #endif
2313         {
2314             SSize_t min = 0;
2315             SSize_t max = strend - strbeg;
2316             SSize_t sublen;
2317
2318             if (    (flags & REXEC_COPY_SKIP_POST)
2319                 && !(prog->extflags & RXf_PMf_KEEPCOPY) /* //p */
2320                 && !(PL_sawampersand & SAWAMPERSAND_RIGHT)
2321             ) { /* don't copy $' part of string */
2322                 U32 n = 0;
2323                 max = -1;
2324                 /* calculate the right-most part of the string covered
2325                  * by a capture. Due to look-ahead, this may be to
2326                  * the right of $&, so we have to scan all captures */
2327                 while (n <= prog->lastparen) {
2328                     if (prog->offs[n].end > max)
2329                         max = prog->offs[n].end;
2330                     n++;
2331                 }
2332                 if (max == -1)
2333                     max = (PL_sawampersand & SAWAMPERSAND_LEFT)
2334                             ? prog->offs[0].start
2335                             : 0;
2336                 assert(max >= 0 && max <= strend - strbeg);
2337             }
2338
2339             if (    (flags & REXEC_COPY_SKIP_PRE)
2340                 && !(prog->extflags & RXf_PMf_KEEPCOPY) /* //p */
2341                 && !(PL_sawampersand & SAWAMPERSAND_LEFT)
2342             ) { /* don't copy $` part of string */
2343                 U32 n = 0;
2344                 min = max;
2345                 /* calculate the left-most part of the string covered
2346                  * by a capture. Due to look-behind, this may be to
2347                  * the left of $&, so we have to scan all captures */
2348                 while (min && n <= prog->lastparen) {
2349                     if (   prog->offs[n].start != -1
2350                         && prog->offs[n].start < min)
2351                     {
2352                         min = prog->offs[n].start;
2353                     }
2354                     n++;
2355                 }
2356                 if ((PL_sawampersand & SAWAMPERSAND_RIGHT)
2357                     && min >  prog->offs[0].end
2358                 )
2359                     min = prog->offs[0].end;
2360
2361             }
2362
2363             assert(min >= 0 && min <= max && min <= strend - strbeg);
2364             sublen = max - min;
2365
2366             if (RX_MATCH_COPIED(rx)) {
2367                 if (sublen > prog->sublen)
2368                     prog->subbeg =
2369                             (char*)saferealloc(prog->subbeg, sublen+1);
2370             }
2371             else
2372                 prog->subbeg = (char*)safemalloc(sublen+1);
2373             Copy(strbeg + min, prog->subbeg, sublen, char);
2374             prog->subbeg[sublen] = '\0';
2375             prog->suboffset = min;
2376             prog->sublen = sublen;
2377             RX_MATCH_COPIED_on(rx);
2378         }
2379         prog->subcoffset = prog->suboffset;
2380         if (prog->suboffset && utf8_target) {
2381             /* Convert byte offset to chars.
2382              * XXX ideally should only compute this if @-/@+
2383              * has been seen, a la PL_sawampersand ??? */
2384
2385             /* If there's a direct correspondence between the
2386              * string which we're matching and the original SV,
2387              * then we can use the utf8 len cache associated with
2388              * the SV. In particular, it means that under //g,
2389              * sv_pos_b2u() will use the previously cached
2390              * position to speed up working out the new length of
2391              * subcoffset, rather than counting from the start of
2392              * the string each time. This stops
2393              *   $x = "\x{100}" x 1E6; 1 while $x =~ /(.)/g;
2394              * from going quadratic */
2395             if (SvPOKp(sv) && SvPVX(sv) == strbeg)
2396                 prog->subcoffset = sv_pos_b2u_flags(sv, prog->subcoffset,
2397                                                 SV_GMAGIC|SV_CONST_RETURN);
2398             else
2399                 prog->subcoffset = utf8_length((U8*)strbeg,
2400                                     (U8*)(strbeg+prog->suboffset));
2401         }
2402     }
2403     else {
2404         RX_MATCH_COPY_FREE(rx);
2405         prog->subbeg = strbeg;
2406         prog->suboffset = 0;
2407         prog->subcoffset = 0;
2408         prog->sublen = strend - strbeg;
2409     }
2410 }
2411
2412
2413
2414
2415 /*
2416  - regexec_flags - match a regexp against a string
2417  */
2418 I32
2419 Perl_regexec_flags(pTHX_ REGEXP * const rx, char *stringarg, char *strend,
2420               char *strbeg, SSize_t minend, SV *sv, void *data, U32 flags)
2421 /* stringarg: the point in the string at which to begin matching */
2422 /* strend:    pointer to null at end of string */
2423 /* strbeg:    real beginning of string */
2424 /* minend:    end of match must be >= minend bytes after stringarg. */
2425 /* sv:        SV being matched: only used for utf8 flag, pos() etc; string
2426  *            itself is accessed via the pointers above */
2427 /* data:      May be used for some additional optimizations.
2428               Currently unused. */
2429 /* flags:     For optimizations. See REXEC_* in regexp.h */
2430
2431 {
2432     struct regexp *const prog = ReANY(rx);
2433     char *s;
2434     regnode *c;
2435     char *startpos;
2436     SSize_t minlen;             /* must match at least this many chars */
2437     SSize_t dontbother = 0;     /* how many characters not to try at end */
2438     const bool utf8_target = cBOOL(DO_UTF8(sv));
2439     I32 multiline;
2440     RXi_GET_DECL(prog,progi);
2441     regmatch_info reginfo_buf;  /* create some info to pass to regtry etc */
2442     regmatch_info *const reginfo = &reginfo_buf;
2443     regexp_paren_pair *swap = NULL;
2444     I32 oldsave;
2445     GET_RE_DEBUG_FLAGS_DECL;
2446
2447     PERL_ARGS_ASSERT_REGEXEC_FLAGS;
2448     PERL_UNUSED_ARG(data);
2449
2450     /* Be paranoid... */
2451     if (prog == NULL || stringarg == NULL) {
2452         Perl_croak(aTHX_ "NULL regexp parameter");
2453     }
2454
2455     DEBUG_EXECUTE_r(
2456         debug_start_match(rx, utf8_target, stringarg, strend,
2457         "Matching");
2458     );
2459
2460     startpos = stringarg;
2461
2462     if (prog->intflags & PREGf_GPOS_SEEN) {
2463         MAGIC *mg;
2464
2465         /* set reginfo->ganch, the position where \G can match */
2466
2467         reginfo->ganch =
2468             (flags & REXEC_IGNOREPOS)
2469             ? stringarg /* use start pos rather than pos() */
2470             : (sv && (mg = mg_find_mglob(sv)) && mg->mg_len >= 0)
2471               /* Defined pos(): */
2472             ? strbeg + MgBYTEPOS(mg, sv, strbeg, strend-strbeg)
2473             : strbeg; /* pos() not defined; use start of string */
2474
2475         DEBUG_GPOS_r(PerlIO_printf(Perl_debug_log,
2476             "GPOS ganch set to strbeg[%"IVdf"]\n", (IV)(reginfo->ganch - strbeg)));
2477
2478         /* in the presence of \G, we may need to start looking earlier in
2479          * the string than the suggested start point of stringarg:
2480          * if prog->gofs is set, then that's a known, fixed minimum
2481          * offset, such as
2482          * /..\G/:   gofs = 2
2483          * /ab|c\G/: gofs = 1
2484          * or if the minimum offset isn't known, then we have to go back
2485          * to the start of the string, e.g. /w+\G/
2486          */
2487
2488         if (prog->intflags & PREGf_ANCH_GPOS) {
2489             startpos  = reginfo->ganch - prog->gofs;
2490             if (startpos <
2491                 ((flags & REXEC_FAIL_ON_UNDERFLOW) ? stringarg : strbeg))
2492             {
2493                 DEBUG_r(PerlIO_printf(Perl_debug_log,
2494                         "fail: ganch-gofs before earliest possible start\n"));
2495                 return 0;
2496             }
2497         }
2498         else if (prog->gofs) {
2499             if (startpos - prog->gofs < strbeg)
2500                 startpos = strbeg;
2501             else
2502                 startpos -= prog->gofs;
2503         }
2504         else if (prog->intflags & PREGf_GPOS_FLOAT)
2505             startpos = strbeg;
2506     }
2507
2508     minlen = prog->minlen;
2509     if ((startpos + minlen) > strend || startpos < strbeg) {
2510         DEBUG_r(PerlIO_printf(Perl_debug_log,
2511                     "Regex match can't succeed, so not even tried\n"));
2512         return 0;
2513     }
2514
2515     /* at the end of this function, we'll do a LEAVE_SCOPE(oldsave),
2516      * which will call destuctors to reset PL_regmatch_state, free higher
2517      * PL_regmatch_slabs, and clean up regmatch_info_aux and
2518      * regmatch_info_aux_eval */
2519
2520     oldsave = PL_savestack_ix;
2521
2522     s = startpos;
2523
2524     if ((prog->extflags & RXf_USE_INTUIT)
2525         && !(flags & REXEC_CHECKED))
2526     {
2527         s = re_intuit_start(rx, sv, strbeg, startpos, strend,
2528                                     flags, NULL);
2529         if (!s)
2530             return 0;
2531
2532         if (prog->extflags & RXf_CHECK_ALL) {
2533             /* we can match based purely on the result of INTUIT.
2534              * Set up captures etc just for $& and $-[0]
2535              * (an intuit-only match wont have $1,$2,..) */
2536             assert(!prog->nparens);
2537
2538             /* s/// doesn't like it if $& is earlier than where we asked it to
2539              * start searching (which can happen on something like /.\G/) */
2540             if (       (flags & REXEC_FAIL_ON_UNDERFLOW)
2541                     && (s < stringarg))
2542             {
2543                 /* this should only be possible under \G */
2544                 assert(prog->intflags & PREGf_GPOS_SEEN);
2545                 DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
2546                     "matched, but failing for REXEC_FAIL_ON_UNDERFLOW\n"));
2547                 goto phooey;
2548             }
2549
2550             /* match via INTUIT shouldn't have any captures.
2551              * Let @-, @+, $^N know */
2552             prog->lastparen = prog->lastcloseparen = 0;
2553             RX_MATCH_UTF8_set(rx, utf8_target);
2554             prog->offs[0].start = s - strbeg;
2555             prog->offs[0].end = utf8_target
2556                 ? (char*)utf8_hop((U8*)s, prog->minlenret) - strbeg
2557                 : s - strbeg + prog->minlenret;
2558             if ( !(flags & REXEC_NOT_FIRST) )
2559                 S_reg_set_capture_string(aTHX_ rx,
2560                                         strbeg, strend,
2561                                         sv, flags, utf8_target);
2562
2563             return 1;
2564         }
2565     }
2566
2567     multiline = prog->extflags & RXf_PMf_MULTILINE;
2568     
2569     if (strend - s < (minlen+(prog->check_offset_min<0?prog->check_offset_min:0))) {
2570         DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
2571                               "String too short [regexec_flags]...\n"));
2572         goto phooey;
2573     }
2574     
2575     /* Check validity of program. */
2576     if (UCHARAT(progi->program) != REG_MAGIC) {
2577         Perl_croak(aTHX_ "corrupted regexp program");
2578     }
2579
2580     RX_MATCH_TAINTED_off(rx);
2581
2582     reginfo->prog = rx;  /* Yes, sorry that this is confusing.  */
2583     reginfo->intuit = 0;
2584     reginfo->is_utf8_target = cBOOL(utf8_target);
2585     reginfo->is_utf8_pat = cBOOL(RX_UTF8(rx));
2586     reginfo->warned = FALSE;
2587     reginfo->strbeg  = strbeg;
2588     reginfo->sv = sv;
2589     reginfo->poscache_maxiter = 0; /* not yet started a countdown */
2590     reginfo->strend = strend;
2591     /* see how far we have to get to not match where we matched before */
2592     reginfo->till = stringarg + minend;
2593
2594     if (prog->extflags & RXf_EVAL_SEEN && SvPADTMP(sv)) {
2595         /* SAVEFREESV, not sv_mortalcopy, as this SV must last until after
2596            S_cleanup_regmatch_info_aux has executed (registered by
2597            SAVEDESTRUCTOR_X below).  S_cleanup_regmatch_info_aux modifies
2598            magic belonging to this SV.
2599            Not newSVsv, either, as it does not COW.
2600         */
2601         assert(!IS_PADGV(sv));
2602         reginfo->sv = newSV(0);
2603         SvSetSV_nosteal(reginfo->sv, sv);
2604         SAVEFREESV(reginfo->sv);
2605     }
2606
2607     /* reserve next 2 or 3 slots in PL_regmatch_state:
2608      * slot N+0: may currently be in use: skip it
2609      * slot N+1: use for regmatch_info_aux struct
2610      * slot N+2: use for regmatch_info_aux_eval struct if we have (?{})'s
2611      * slot N+3: ready for use by regmatch()
2612      */
2613
2614     {
2615         regmatch_state *old_regmatch_state;
2616         regmatch_slab  *old_regmatch_slab;
2617         int i, max = (prog->extflags & RXf_EVAL_SEEN) ? 2 : 1;
2618
2619         /* on first ever match, allocate first slab */
2620         if (!PL_regmatch_slab) {
2621             Newx(PL_regmatch_slab, 1, regmatch_slab);
2622             PL_regmatch_slab->prev = NULL;
2623             PL_regmatch_slab->next = NULL;
2624             PL_regmatch_state = SLAB_FIRST(PL_regmatch_slab);
2625         }
2626
2627         old_regmatch_state = PL_regmatch_state;
2628         old_regmatch_slab  = PL_regmatch_slab;
2629
2630         for (i=0; i <= max; i++) {
2631             if (i == 1)
2632                 reginfo->info_aux = &(PL_regmatch_state->u.info_aux);
2633             else if (i ==2)
2634                 reginfo->info_aux_eval =
2635                 reginfo->info_aux->info_aux_eval =
2636                             &(PL_regmatch_state->u.info_aux_eval);
2637
2638             if (++PL_regmatch_state >  SLAB_LAST(PL_regmatch_slab))
2639                 PL_regmatch_state = S_push_slab(aTHX);
2640         }
2641
2642         /* note initial PL_regmatch_state position; at end of match we'll
2643          * pop back to there and free any higher slabs */
2644
2645         reginfo->info_aux->old_regmatch_state = old_regmatch_state;
2646         reginfo->info_aux->old_regmatch_slab  = old_regmatch_slab;
2647         reginfo->info_aux->poscache = NULL;
2648
2649         SAVEDESTRUCTOR_X(S_cleanup_regmatch_info_aux, reginfo->info_aux);
2650
2651         if ((prog->extflags & RXf_EVAL_SEEN))
2652             S_setup_eval_state(aTHX_ reginfo);
2653         else
2654             reginfo->info_aux_eval = reginfo->info_aux->info_aux_eval = NULL;
2655     }
2656
2657     /* If there is a "must appear" string, look for it. */
2658
2659     if (PL_curpm && (PM_GETRE(PL_curpm) == rx)) {
2660         /* We have to be careful. If the previous successful match
2661            was from this regex we don't want a subsequent partially
2662            successful match to clobber the old results.
2663            So when we detect this possibility we add a swap buffer
2664            to the re, and switch the buffer each match. If we fail,
2665            we switch it back; otherwise we leave it swapped.
2666         */
2667         swap = prog->offs;
2668         /* do we need a save destructor here for eval dies? */
2669         Newxz(prog->offs, (prog->nparens + 1), regexp_paren_pair);
2670         DEBUG_BUFFERS_r(PerlIO_printf(Perl_debug_log,
2671             "rex=0x%"UVxf" saving  offs: orig=0x%"UVxf" new=0x%"UVxf"\n",
2672             PTR2UV(prog),
2673             PTR2UV(swap),
2674             PTR2UV(prog->offs)
2675         ));
2676     }
2677
2678     /* Simplest case:  anchored match need be tried only once. */
2679     /*  [unless only anchor is BOL and multiline is set] */
2680     if (prog->intflags & (PREGf_ANCH & ~PREGf_ANCH_GPOS)) {
2681         if (s == startpos && regtry(reginfo, &s))
2682             goto got_it;
2683         else if (multiline || (prog->intflags & (PREGf_IMPLICIT | PREGf_ANCH_MBOL))) /* XXXX SBOL? */
2684         {
2685             char *end;
2686
2687             if (minlen)
2688                 dontbother = minlen - 1;
2689             end = HOP3c(strend, -dontbother, strbeg) - 1;
2690             /* for multiline we only have to try after newlines */
2691             if (prog->check_substr || prog->check_utf8) {
2692                 /* because of the goto we can not easily reuse the macros for bifurcating the
2693                    unicode/non-unicode match modes here like we do elsewhere - demerphq */
2694                 if (utf8_target) {
2695                     if (s == startpos)
2696                         goto after_try_utf8;
2697                     while (1) {
2698                         if (regtry(reginfo, &s)) {
2699                             goto got_it;
2700                         }
2701                       after_try_utf8:
2702                         if (s > end) {
2703                             goto phooey;
2704                         }
2705                         if (prog->extflags & RXf_USE_INTUIT) {
2706                             s = re_intuit_start(rx, sv, strbeg,
2707                                     s + UTF8SKIP(s), strend, flags, NULL);
2708                             if (!s) {
2709                                 goto phooey;
2710                             }
2711                         }
2712                         else {
2713                             s += UTF8SKIP(s);
2714                         }
2715                     }
2716                 } /* end search for check string in unicode */
2717                 else {
2718                     if (s == startpos) {
2719                         goto after_try_latin;
2720                     }
2721                     while (1) {
2722                         if (regtry(reginfo, &s)) {
2723                             goto got_it;
2724                         }
2725                       after_try_latin:
2726                         if (s > end) {
2727                             goto phooey;
2728                         }
2729                         if (prog->extflags & RXf_USE_INTUIT) {
2730                             s = re_intuit_start(rx, sv, strbeg,
2731                                         s + 1, strend, flags, NULL);
2732                             if (!s) {
2733                                 goto phooey;
2734                             }
2735                         }
2736                         else {
2737                             s++;
2738                         }
2739                     }
2740                 } /* end search for check string in latin*/
2741             } /* end search for check string */
2742             else { /* search for newline */
2743                 if (s > startpos) {
2744                     /*XXX: The s-- is almost definitely wrong here under unicode - demeprhq*/
2745                     s--;
2746                 }
2747                 /* We can use a more efficient search as newlines are the same in unicode as they are in latin */
2748                 while (s <= end) { /* note it could be possible to match at the end of the string */
2749                     if (*s++ == '\n') { /* don't need PL_utf8skip here */
2750                         if (regtry(reginfo, &s))
2751                             goto got_it;
2752                     }
2753                 }
2754             } /* end search for newline */
2755         } /* end anchored/multiline check string search */
2756         goto phooey;
2757     } else if (prog->intflags & PREGf_ANCH_GPOS)
2758     {
2759         /* PREGf_ANCH_GPOS should never be true if PREGf_GPOS_SEEN is not true */
2760         assert(prog->intflags & PREGf_GPOS_SEEN);
2761         /* For anchored \G, the only position it can match from is
2762          * (ganch-gofs); we already set startpos to this above; if intuit
2763          * moved us on from there, we can't possibly succeed */
2764         assert(startpos == reginfo->ganch - prog->gofs);
2765         if (s == startpos && regtry(reginfo, &s))
2766             goto got_it;
2767         goto phooey;
2768     }
2769
2770     /* Messy cases:  unanchored match. */
2771     if ((prog->anchored_substr || prog->anchored_utf8) && prog->intflags & PREGf_SKIP) {
2772         /* we have /x+whatever/ */
2773         /* it must be a one character string (XXXX Except is_utf8_pat?) */
2774         char ch;
2775 #ifdef DEBUGGING
2776         int did_match = 0;
2777 #endif
2778         if (utf8_target) {
2779             if (! prog->anchored_utf8) {
2780                 to_utf8_substr(prog);
2781             }
2782             ch = SvPVX_const(prog->anchored_utf8)[0];
2783             REXEC_FBC_SCAN(
2784                 if (*s == ch) {
2785                     DEBUG_EXECUTE_r( did_match = 1 );
2786                     if (regtry(reginfo, &s)) goto got_it;
2787                     s += UTF8SKIP(s);
2788                     while (s < strend && *s == ch)
2789                         s += UTF8SKIP(s);
2790                 }
2791             );
2792
2793         }
2794         else {
2795             if (! prog->anchored_substr) {
2796                 if (! to_byte_substr(prog)) {
2797                     NON_UTF8_TARGET_BUT_UTF8_REQUIRED(phooey);
2798                 }
2799             }
2800             ch = SvPVX_const(prog->anchored_substr)[0];
2801             REXEC_FBC_SCAN(
2802                 if (*s == ch) {
2803                     DEBUG_EXECUTE_r( did_match = 1 );
2804                     if (regtry(reginfo, &s)) goto got_it;
2805                     s++;
2806                     while (s < strend && *s == ch)
2807                         s++;
2808                 }
2809             );
2810         }
2811         DEBUG_EXECUTE_r(if (!did_match)
2812                 PerlIO_printf(Perl_debug_log,
2813                                   "Did not find anchored character...\n")
2814                );
2815     }
2816     else if (prog->anchored_substr != NULL
2817               || prog->anchored_utf8 != NULL
2818               || ((prog->float_substr != NULL || prog->float_utf8 != NULL)
2819                   && prog->float_max_offset < strend - s)) {
2820         SV *must;
2821         SSize_t back_max;
2822         SSize_t back_min;
2823         char *last;
2824         char *last1;            /* Last position checked before */
2825 #ifdef DEBUGGING
2826         int did_match = 0;
2827 #endif
2828         if (prog->anchored_substr || prog->anchored_utf8) {
2829             if (utf8_target) {
2830                 if (! prog->anchored_utf8) {
2831                     to_utf8_substr(prog);
2832                 }
2833                 must = prog->anchored_utf8;
2834             }
2835             else {
2836                 if (! prog->anchored_substr) {
2837                     if (! to_byte_substr(prog)) {
2838                         NON_UTF8_TARGET_BUT_UTF8_REQUIRED(phooey);
2839                     }
2840                 }
2841                 must = prog->anchored_substr;
2842             }
2843             back_max = back_min = prog->anchored_offset;
2844         } else {
2845             if (utf8_target) {
2846                 if (! prog->float_utf8) {
2847                     to_utf8_substr(prog);
2848                 }
2849                 must = prog->float_utf8;
2850             }
2851             else {
2852                 if (! prog->float_substr) {
2853                     if (! to_byte_substr(prog)) {
2854                         NON_UTF8_TARGET_BUT_UTF8_REQUIRED(phooey);
2855                     }
2856                 }
2857                 must = prog->float_substr;
2858             }
2859             back_max = prog->float_max_offset;
2860             back_min = prog->float_min_offset;
2861         }
2862             
2863         if (back_min<0) {
2864             last = strend;
2865         } else {
2866             last = HOP3c(strend,        /* Cannot start after this */
2867                   -(SSize_t)(CHR_SVLEN(must)
2868                          - (SvTAIL(must) != 0) + back_min), strbeg);
2869         }
2870         if (s > reginfo->strbeg)
2871             last1 = HOPc(s, -1);
2872         else
2873             last1 = s - 1;      /* bogus */
2874
2875         /* XXXX check_substr already used to find "s", can optimize if
2876            check_substr==must. */
2877         dontbother = 0;
2878         strend = HOPc(strend, -dontbother);
2879         while ( (s <= last) &&
2880                 (s = fbm_instr((unsigned char*)HOP4c(s, back_min, strbeg,  strend),
2881                                   (unsigned char*)strend, must,
2882                                   multiline ? FBMrf_MULTILINE : 0)) ) {
2883             DEBUG_EXECUTE_r( did_match = 1 );
2884             if (HOPc(s, -back_max) > last1) {
2885                 last1 = HOPc(s, -back_min);
2886                 s = HOPc(s, -back_max);
2887             }
2888             else {
2889                 char * const t = (last1 >= reginfo->strbeg)
2890                                     ? HOPc(last1, 1) : last1 + 1;
2891
2892                 last1 = HOPc(s, -back_min);
2893                 s = t;
2894             }
2895             if (utf8_target) {
2896                 while (s <= last1) {
2897                     if (regtry(reginfo, &s))
2898                         goto got_it;
2899                     if (s >= last1) {
2900                         s++; /* to break out of outer loop */
2901                         break;
2902                     }
2903                     s += UTF8SKIP(s);
2904                 }
2905             }
2906             else {
2907                 while (s <= last1) {
2908                     if (regtry(reginfo, &s))
2909                         goto got_it;
2910                     s++;
2911                 }
2912             }
2913         }
2914         DEBUG_EXECUTE_r(if (!did_match) {
2915             RE_PV_QUOTED_DECL(quoted, utf8_target, PERL_DEBUG_PAD_ZERO(0),
2916                 SvPVX_const(must), RE_SV_DUMPLEN(must), 30);
2917             PerlIO_printf(Perl_debug_log, "Did not find %s substr %s%s...\n",
2918                               ((must == prog->anchored_substr || must == prog->anchored_utf8)
2919                                ? "anchored" : "floating"),
2920                 quoted, RE_SV_TAIL(must));
2921         });                 
2922         goto phooey;
2923     }
2924     else if ( (c = progi->regstclass) ) {
2925         if (minlen) {
2926             const OPCODE op = OP(progi->regstclass);
2927             /* don't bother with what can't match */
2928             if (PL_regkind[op] != EXACT && op != CANY && PL_regkind[op] != TRIE)
2929                 strend = HOPc(strend, -(minlen - 1));
2930         }
2931         DEBUG_EXECUTE_r({
2932             SV * const prop = sv_newmortal();
2933             regprop(prog, prop, c, reginfo);
2934             {
2935                 RE_PV_QUOTED_DECL(quoted,utf8_target,PERL_DEBUG_PAD_ZERO(1),
2936                     s,strend-s,60);
2937                 PerlIO_printf(Perl_debug_log,
2938                     "Matching stclass %.*s against %s (%d bytes)\n",
2939                     (int)SvCUR(prop), SvPVX_const(prop),
2940                      quoted, (int)(strend - s));
2941             }
2942         });
2943         if (find_byclass(prog, c, s, strend, reginfo))
2944             goto got_it;
2945         DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "Contradicts stclass... [regexec_flags]\n"));
2946     }
2947     else {
2948         dontbother = 0;
2949         if (prog->float_substr != NULL || prog->float_utf8 != NULL) {
2950             /* Trim the end. */
2951             char *last= NULL;
2952             SV* float_real;
2953             STRLEN len;
2954             const char *little;
2955
2956             if (utf8_target) {
2957                 if (! prog->float_utf8) {
2958                     to_utf8_substr(prog);
2959                 }
2960                 float_real = prog->float_utf8;
2961             }
2962             else {
2963                 if (! prog->float_substr) {
2964                     if (! to_byte_substr(prog)) {
2965                         NON_UTF8_TARGET_BUT_UTF8_REQUIRED(phooey);
2966                     }
2967                 }
2968                 float_real = prog->float_substr;
2969             }
2970
2971             little = SvPV_const(float_real, len);
2972             if (SvTAIL(float_real)) {
2973                     /* This means that float_real contains an artificial \n on
2974                      * the end due to the presence of something like this:
2975                      * /foo$/ where we can match both "foo" and "foo\n" at the
2976                      * end of the string.  So we have to compare the end of the
2977                      * string first against the float_real without the \n and
2978                      * then against the full float_real with the string.  We
2979                      * have to watch out for cases where the string might be
2980                      * smaller than the float_real or the float_real without
2981                      * the \n. */
2982                     char *checkpos= strend - len;
2983                     DEBUG_OPTIMISE_r(
2984                         PerlIO_printf(Perl_debug_log,
2985                             "%sChecking for float_real.%s\n",
2986                             PL_colors[4], PL_colors[5]));
2987                     if (checkpos + 1 < strbeg) {
2988                         /* can't match, even if we remove the trailing \n
2989                          * string is too short to match */
2990                         DEBUG_EXECUTE_r(
2991                             PerlIO_printf(Perl_debug_log,
2992                                 "%sString shorter than required trailing substring, cannot match.%s\n",
2993                                 PL_colors[4], PL_colors[5]));
2994                         goto phooey;
2995                     } else if (memEQ(checkpos + 1, little, len - 1)) {
2996                         /* can match, the end of the string matches without the
2997                          * "\n" */
2998                         last = checkpos + 1;
2999                     } else if (checkpos < strbeg) {
3000                         /* cant match, string is too short when the "\n" is
3001                          * included */
3002                         DEBUG_EXECUTE_r(
3003                             PerlIO_printf(Perl_debug_log,
3004                                 "%sString does not contain required trailing substring, cannot match.%s\n",
3005                                 PL_colors[4], PL_colors[5]));
3006                         goto phooey;
3007                     } else if (!multiline) {
3008                         /* non multiline match, so compare with the "\n" at the
3009                          * end of the string */
3010                         if (memEQ(checkpos, little, len)) {
3011                             last= checkpos;
3012                         } else {
3013                             DEBUG_EXECUTE_r(
3014                                 PerlIO_printf(Perl_debug_log,
3015                                     "%sString does not contain required trailing substring, cannot match.%s\n",
3016                                     PL_colors[4], PL_colors[5]));
3017                             goto phooey;
3018                         }
3019                     } else {
3020                         /* multiline match, so we have to search for a place
3021                          * where the full string is located */
3022                         goto find_last;
3023                     }
3024             } else {
3025                   find_last:
3026                     if (len)
3027                         last = rninstr(s, strend, little, little + len);
3028                     else
3029                         last = strend;  /* matching "$" */
3030             }
3031             if (!last) {
3032                 /* at one point this block contained a comment which was
3033                  * probably incorrect, which said that this was a "should not
3034                  * happen" case.  Even if it was true when it was written I am
3035                  * pretty sure it is not anymore, so I have removed the comment
3036                  * and replaced it with this one. Yves */
3037                 DEBUG_EXECUTE_r(
3038                     PerlIO_printf(Perl_debug_log,
3039                         "String does not contain required substring, cannot match.\n"
3040                     ));
3041                 goto phooey;
3042             }
3043             dontbother = strend - last + prog->float_min_offset;
3044         }
3045         if (minlen && (dontbother < minlen))
3046             dontbother = minlen - 1;
3047         strend -= dontbother;              /* this one's always in bytes! */
3048         /* We don't know much -- general case. */
3049         if (utf8_target) {
3050             for (;;) {
3051                 if (regtry(reginfo, &s))
3052                     goto got_it;
3053                 if (s >= strend)
3054                     break;
3055                 s += UTF8SKIP(s);
3056             };
3057         }
3058         else {
3059             do {
3060                 if (regtry(reginfo, &s))
3061                     goto got_it;
3062             } while (s++ < strend);
3063         }
3064     }
3065
3066     /* Failure. */
3067     goto phooey;
3068
3069 got_it:
3070     /* s/// doesn't like it if $& is earlier than where we asked it to
3071      * start searching (which can happen on something like /.\G/) */
3072     if (       (flags & REXEC_FAIL_ON_UNDERFLOW)
3073             && (prog->offs[0].start < stringarg - strbeg))
3074     {
3075         /* this should only be possible under \G */
3076         assert(prog->intflags & PREGf_GPOS_SEEN);
3077         DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log,
3078             "matched, but failing for REXEC_FAIL_ON_UNDERFLOW\n"));
3079         goto phooey;
3080     }
3081
3082     DEBUG_BUFFERS_r(
3083         if (swap)
3084             PerlIO_printf(Perl_debug_log,
3085                 "rex=0x%"UVxf" freeing offs: 0x%"UVxf"\n",
3086                 PTR2UV(prog),
3087                 PTR2UV(swap)
3088             );
3089     );
3090     Safefree(swap);
3091
3092     /* clean up; this will trigger destructors that will free all slabs
3093      * above the current one, and cleanup the regmatch_info_aux
3094      * and regmatch_info_aux_eval sructs */
3095
3096     LEAVE_SCOPE(oldsave);
3097
3098     if (RXp_PAREN_NAMES(prog)) 
3099         (void)hv_iterinit(RXp_PAREN_NAMES(prog));
3100
3101     RX_MATCH_UTF8_set(rx, utf8_target);
3102
3103     /* make sure $`, $&, $', and $digit will work later */
3104     if ( !(flags & REXEC_NOT_FIRST) )
3105         S_reg_set_capture_string(aTHX_ rx,
3106                                     strbeg, reginfo->strend,
3107                                     sv, flags, utf8_target);
3108
3109     return 1;
3110
3111 phooey:
3112     DEBUG_EXECUTE_r(PerlIO_printf(Perl_debug_log, "%sMatch failed%s\n",
3113                           PL_colors[4], PL_colors[5]));
3114
3115     /* clean up; this will trigger destructors that will free all slabs
3116      * above the current one, and cleanup the regmatch_info_aux
3117      * and regmatch_info_aux_eval sructs */
3118
3119     LEAVE_SCOPE(oldsave);
3120
3121     if (swap) {
3122         /* we failed :-( roll it back */
3123         DEBUG_BUFFERS_r(PerlIO_printf(Perl_debug_log,
3124             "rex=0x%"UVxf" rolling back offs: freeing=0x%"UVxf" restoring=0x%"UVxf"\n",
3125             PTR2UV(prog),
3126             PTR2UV(prog->offs),
3127             PTR2UV(swap)
3128         ));
3129         Safefree(prog->offs);
3130         prog->offs = swap;
3131     }
3132     return 0;
3133 }
3134
3135
3136 /* Set which rex is pointed to by PL_reg_curpm, handling ref counting.
3137  * Do inc before dec, in case old and new rex are the same */
3138 #define SET_reg_curpm(Re2)                          \
3139     if (reginfo->info_aux_eval) {                   \
3140         (void)ReREFCNT_inc(Re2);                    \
3141         ReREFCNT_dec(PM_GETRE(PL_reg_curpm));       \
3142         PM_SETRE((PL_reg_curpm), (Re2));            \
3143     }
3144
3145
3146 /*
3147  - regtry - try match at specific point
3148  */
3149 STATIC I32                      /* 0 failure, 1 success */
3150 S_regtry(pTHX_ regmatch_info *reginfo, char **startposp)
3151 {
3152     CHECKPOINT lastcp;
3153     REGEXP *const rx = reginfo->prog;
3154     regexp *const prog = ReANY(rx);
3155     SSize_t result;
3156     RXi_GET_DECL(prog,progi);
3157     GET_RE_DEBUG_FLAGS_DECL;
3158
3159     PERL_ARGS_ASSERT_REGTRY;
3160
3161     reginfo->cutpoint=NULL;
3162
3163     prog->offs[0].start = *startposp - reginfo->strbeg;
3164     prog->lastparen = 0;
3165     prog->lastcloseparen = 0;
3166
3167     /* XXXX What this code is doing here?!!!  There should be no need
3168        to do this again and again, prog->lastparen should take care of
3169        this!  --ilya*/
3170
3171     /* Tests pat.t#187 and split.t#{13,14} seem to depend on this code.
3172      * Actually, the code in regcppop() (which Ilya may be meaning by
3173      * prog->lastparen), is not needed at all by the test suite
3174      * (op/regexp, op/pat, op/split), but that code is needed otherwise
3175      * this erroneously leaves $1 defined: "1" =~ /^(?:(\d)x)?\d$/
3176      * Meanwhile, this code *is* needed for the
3177      * above-mentioned test suite tests to succeed.  The common theme
3178      * on those tests seems to be returning null fields from matches.
3179      * --jhi updated by dapm */
3180 #if 1
3181     if (prog->nparens) {
3182         regexp_paren_pair *pp = prog->offs;
3183         I32 i;
3184         for (i = prog->nparens; i > (I32)prog->lastparen; i--) {
3185             ++pp;
3186             pp->start = -1;
3187             pp->end = -1;
3188         }
3189     }
3190 #endif
3191     REGCP_SET(lastcp);
3192     result = regmatch(reginfo, *startposp, progi->program + 1);
3193     if (result != -1) {
3194         prog->offs[0].end = result;
3195         return 1;
3196     }
3197     if (reginfo->cutpoint)
3198         *startposp= reginfo->cutpoint;
3199     REGCP_UNWIND(lastcp);
3200     return 0;
3201 }
3202
3203
3204 #define sayYES goto yes
3205 #define sayNO goto no
3206 #define sayNO_SILENT goto no_silent
3207
3208 /* we dont use STMT_START/END here because it leads to 
3209    "unreachable code" warnings, which are bogus, but distracting. */
3210 #define CACHEsayNO \
3211     if (ST.cache_mask) \
3212        reginfo->info_aux->poscache[ST.cache_offset] |= ST.cache_mask; \
3213     sayNO
3214
3215 /* this is used to determine how far from the left messages like
3216    'failed...' are printed. It should be set such that messages 
3217    are inline with the regop output that created them.
3218 */
3219 #define REPORT_CODE_OFF 32
3220
3221
3222 #define CHRTEST_UNINIT -1001 /* c1/c2 haven't been calculated yet */
3223 #define CHRTEST_VOID   -1000 /* the c1/c2 "next char" test should be skipped */
3224 #define CHRTEST_NOT_A_CP_1 -999
3225 #define CHRTEST_NOT_A_CP_2 -998
3226
3227 /* grab a new slab and return the first slot in it */
3228
3229 STATIC regmatch_state *
3230 S_push_slab(pTHX)
3231 {
3232 #if PERL_VERSION < 9 && !defined(PERL_CORE)
3233     dMY_CXT;
3234 #endif
3235     regmatch_slab *s = PL_regmatch_slab->next;
3236     if (!s) {
3237         Newx(s, 1, regmatch_slab);
3238         s->prev = PL_regmatch_slab;
3239         s->next = NULL;
3240         PL_regmatch_slab->next = s;
3241     }
3242     PL_regmatch_slab = s;
3243     return SLAB_FIRST(s);
3244 }
3245
3246
3247 /* push a new state then goto it */
3248
3249 #define PUSH_STATE_GOTO(state, node, input) \
3250     pushinput = input; \
3251     scan = node; \
3252     st->resume_state = state; \
3253     goto push_state;
3254
3255 /* push a new state with success backtracking, then goto it */
3256
3257 #define PUSH_YES_STATE_GOTO(state, node, input) \
3258     pushinput = input; \
3259     scan = node; \
3260     st->resume_state = state; \
3261     goto push_yes_state;
3262
3263
3264
3265
3266 /*
3267
3268 regmatch() - main matching routine
3269
3270 This is basically one big switch statement in a loop. We execute an op,
3271 set 'next' to point the next op, and continue. If we come to a point which
3272 we may need to backtrack to on failure such as (A|B|C), we push a
3273 backtrack state onto the backtrack stack. On failure, we pop the top
3274 state, and re-enter the loop at the state indicated. If there are no more
3275 states to pop, we return failure.
3276
3277 Sometimes we also need to backtrack on success; for example /A+/, where
3278 after successfully matching one A, we need to go back and try to
3279 match another one; similarly for lookahead assertions: if the assertion
3280 completes successfully, we backtrack to the state just before the assertion
3281 and then carry on.  In these cases, the pushed state is marked as
3282 'backtrack on success too'. This marking is in fact done by a chain of
3283 pointers, each pointing to the previous 'yes' state. On success, we pop to
3284 the nearest yes state, discarding any intermediate failure-only states.
3285 Sometimes a yes state is pushed just to force some cleanup code to be
3286 called at the end of a successful match or submatch; e.g. (??{$re}) uses
3287 it to free the inner regex.
3288
3289 Note that failure backtracking rewinds the cursor position, while
3290 success backtracking leaves it alone.
3291
3292 A pattern is complete when the END op is executed, while a subpattern
3293 such as (?=foo) is complete when the SUCCESS op is executed. Both of these
3294 ops trigger the "pop to last yes state if any, otherwise return true"
3295 behaviour.
3296
3297 A common convention in this function is to use A and B to refer to the two
3298 subpatterns (or to the first nodes thereof) in patterns like /A*B/: so A is
3299 the subpattern to be matched possibly multiple times, while B is the entire
3300 rest of the pattern. Variable and state names reflect this convention.
3301
3302 The states in the main switch are the union of ops and failure/success of
3303 substates associated with with that op.  For example, IFMATCH is the op
3304 that does lookahead assertions /(?=A)B/ and so the IFMATCH state means
3305 'execute IFMATCH'; while IFMATCH_A is a state saying that we have just
3306 successfully matched A and IFMATCH_A_fail is a state saying that we have
3307 just failed to match A. Resume states always come in pairs. The backtrack
3308 state we push is marked as 'IFMATCH_A', but when that is popped, we resume
3309 at IFMATCH_A or IFMATCH_A_fail, depending on whether we are backtracking
3310 on success or failure.
3311
3312 The struct that holds a backtracking state is actually a big union, with
3313 one variant for each major type of op. The variable st points to the
3314 top-most backtrack struct. To make the code clearer, within each
3315 block of code we #define ST to alias the relevant union.
3316
3317 Here's a concrete example of a (vastly oversimplified) IFMATCH
3318 implementation:
3319
3320     switch (state) {
3321     ....
3322
3323 #define ST st->u.ifmatch
3324
3325     case IFMATCH: // we are executing the IFMATCH op, (?=A)B
3326         ST.foo = ...; // some state we wish to save
3327         ...
3328         // push a yes backtrack state with a resume value of
3329         // IFMATCH_A/IFMATCH_A_fail, then continue execution at the
3330         // first node of A:
3331         PUSH_YES_STATE_GOTO(IFMATCH_A, A, newinput);
3332         // NOTREACHED
3333
3334     case IFMATCH_A: // we have successfully executed A; now continue with B
3335         next = B;
3336         bar = ST.foo; // do something with the preserved value
3337         break;
3338
3339     case IFMATCH_A_fail: // A failed, so the assertion failed
3340         ...;   // do some housekeeping, then ...
3341         sayNO; // propagate the failure
3342
3343 #undef ST
3344
3345     ...
3346     }
3347
3348 For any old-timers reading this who are familiar with the old recursive
3349 approach, the code above is equivalent to:
3350
3351     case IFMATCH: // we are executing the IFMATCH op, (?=A)B
3352     {
3353         int foo = ...
3354         ...
3355         if (regmatch(A)) {
3356             next = B;
3357             bar = foo;
3358             break;
3359         }
3360         ...;   // do some housekeeping, then ...
3361         sayNO; // propagate the failure
3362     }
3363
3364 The topmost backtrack state, pointed to by st, is usually free. If you
3365 want to claim it, populate any ST.foo fields in it with values you wish to
3366 save, then do one of
3367
3368         PUSH_STATE_GOTO(resume_state, node, newinput);
3369         PUSH_YES_STATE_GOTO(resume_state, node, newinput);
3370
3371 which sets that backtrack state's resume value to 'resume_state', pushes a
3372 new free entry to the top of the backtrack stack, then goes to 'node'.
3373 On backtracking, the free slot is popped, and the saved state becomes the
3374 new free state. An ST.foo field in this new top state can be temporarily
3375 accessed to retrieve values, but once the main loop is re-entered, it
3376 becomes available for reuse.
3377
3378 Note that the depth of the backtrack stack constantly increases during the
3379 left-to-right execution of the pattern, rather than going up and down with
3380 the pattern nesting. For example the stack is at its maximum at Z at the
3381 end of the pattern, rather than at X in the following:
3382
3383     /(((X)+)+)+....(Y)+....Z/
3384
3385 The only exceptions to this are lookahead/behind assertions and the cut,
3386 (?>A), which pop all the backtrack states associated with A before
3387 continuing.
3388  
3389 Backtrack state structs are allocated in slabs of about 4K in size.
3390 PL_regmatch_state and st always point to the currently active state,
3391 and PL_regmatch_slab points to the slab currently containing
3392 PL_regmatch_state.  The first time regmatch() is called, the first slab is
3393 allocated, and is never freed until interpreter destruction. When the slab
3394 is full, a new one is allocated and chained to the end. At exit from
3395 regmatch(), slabs allocated since entry are freed.
3396
3397 */
3398  
3399
3400 #define DEBUG_STATE_pp(pp)                                  \
3401     DEBUG_STATE_r({                                         \
3402         DUMP_EXEC_POS(locinput, scan, utf8_target);         \
3403         PerlIO_printf(Perl_debug_log,                       \
3404             "    %*s"pp" %s%s%s%s%s\n",                     \
3405             depth*2, "",                                    \
3406             PL_reg_name[st->resume_state],                  \
3407             ((st==yes_state||st==mark_state) ? "[" : ""),   \
3408             ((st==yes_state) ? "Y" : ""),                   \
3409             ((st==mark_state) ? "M" : ""),                  \
3410             ((st==yes_state||st==mark_state) ? "]" : "")    \
3411         );                                                  \
3412     });
3413
3414
3415 #define REG_NODE_NUM(x) ((x) ? (int)((x)-prog) : -1)
3416
3417 #ifdef DEBUGGING
3418
3419 STATIC void
3420 S_debug_start_match(pTHX_ const REGEXP *prog, const bool utf8_target,
3421     const char *start, const char *end, const char *blurb)
3422 {
3423     const bool utf8_pat = RX_UTF8(prog) ? 1 : 0;
3424
3425     PERL_ARGS_ASSERT_DEBUG_START_MATCH;
3426
3427     if (!PL_colorset)   
3428             reginitcolors();    
3429     {
3430         RE_PV_QUOTED_DECL(s0, utf8_pat, PERL_DEBUG_PAD_ZERO(0), 
3431             RX_PRECOMP_const(prog), RX_PRELEN(prog), 60);   
3432         
3433         RE_PV_QUOTED_DECL(s1, utf8_target, PERL_DEBUG_PAD_ZERO(1),
3434             start, end - start, 60); 
3435         
3436         PerlIO_printf(Perl_debug_log, 
3437             "%s%s REx%s %s against %s\n", 
3438                        PL_colors[4], blurb, PL_colors[5], s0, s1); 
3439         
3440         if (utf8_target||utf8_pat)
3441             PerlIO_printf(Perl_debug_log, "UTF-8 %s%s%s...\n",
3442                 utf8_pat ? "pattern" : "",
3443                 utf8_pat && utf8_target ? " and " : "",
3444                 utf8_target ? "string" : ""
3445             ); 
3446     }
3447 }
3448
3449 STATIC void
3450 S_dump_exec_pos(pTHX_ const char *locinput, 
3451                       const regnode *scan, 
3452                       const char *loc_regeol, 
3453                       const char *loc_bostr, 
3454                       const char *loc_reg_starttry,
3455                       const bool utf8_target)
3456 {
3457     const int docolor = *PL_colors[0] || *PL_colors[2] || *PL_colors[4];
3458     const int taill = (docolor ? 10 : 7); /* 3 chars for "> <" */
3459     int l = (loc_regeol - locinput) > taill ? taill : (loc_regeol - locinput);
3460     /* The part of the string before starttry has one color
3461        (pref0_len chars), between starttry and current
3462        position another one (pref_len - pref0_len chars),
3463        after the current position the third one.
3464        We assume that pref0_len <= pref_len, otherwise we
3465        decrease pref0_len.  */
3466     int pref_len = (locinput - loc_bostr) > (5 + taill) - l
3467         ? (5 + taill) - l : locinput - loc_bostr;
3468     int pref0_len;
3469
3470     PERL_ARGS_ASSERT_DUMP_EXEC_POS;
3471
3472     while (utf8_target && UTF8_IS_CONTINUATION(*(U8*)(locinput - pref_len)))
3473         pref_len++;
3474     pref0_len = pref_len  - (locinput - loc_reg_starttry);
3475     if (l + pref_len < (5 + taill) && l < loc_regeol - locinput)
3476         l = ( loc_regeol - locinput > (5 + taill) - pref_len
3477               ? (5 + taill) - pref_len : loc_regeol - locinput);
3478     while (utf8_target && UTF8_IS_CONTINUATION(*(U8*)(locinput + l)))
3479         l--;
3480     if (pref0_len < 0)
3481         pref0_len = 0;
3482     if (pref0_len > pref_len)
3483         pref0_len = pref_len;
3484     {
3485         const int is_uni = (utf8_target && OP(scan) != CANY) ? 1 : 0;
3486
3487         RE_PV_COLOR_DECL(s0,len0,is_uni,PERL_DEBUG_PAD(0),
3488             (locinput - pref_len),pref0_len, 60, 4, 5);
3489         
3490         RE_PV_COLOR_DECL(s1,len1,is_uni,PERL_DEBUG_PAD(1),
3491                     (locinput - pref_len + pref0_len),
3492                     pref_len - pref0_len, 60, 2, 3);
3493         
3494         RE_PV_COLOR_DECL(s2,len2,is_uni,PERL_DEBUG_PAD(2),
3495                     locinput, loc_regeol - locinput, 10, 0, 1);
3496
3497         const STRLEN tlen=len0+len1+len2;
3498         PerlIO_printf(Perl_debug_log,
3499                     "%4"IVdf" <%.*s%.*s%s%.*s>%*s|",
3500                     (IV)(locinput - loc_bostr),
3501                     len0, s0,
3502                     len1, s1,
3503                     (docolor ? "" : "> <"),
3504                     len2, s2,
3505                     (int)(tlen > 19 ? 0 :  19 - tlen),
3506                     "");
3507     }
3508 }
3509
3510 #endif
3511
3512 /* reg_check_named_buff_matched()
3513  * Checks to see if a named buffer has matched. The data array of 
3514  * buffer numbers corresponding to the buffer is expected to reside
3515  * in the regexp->data->data array in the slot stored in the ARG() of
3516  * node involved. Note that this routine doesn't actually care about the
3517  * name, that information is not preserved from compilation to execution.
3518  * Returns the index of the leftmost defined buffer with the given name
3519  * or 0 if non of the buffers matched.
3520  */
3521 STATIC I32
3522 S_reg_check_named_buff_matched(const regexp *rex, const regnode *scan)
3523 {
3524     I32 n;
3525     RXi_GET_DECL(rex,rexi);
3526     SV *sv_dat= MUTABLE_SV(rexi->data->data[ ARG( scan ) ]);
3527     I32 *nums=(I32*)SvPVX(sv_dat);
3528
3529     PERL_ARGS_ASSERT_REG_CHECK_NAMED_BUFF_MATCHED;
3530
3531     for ( n=0; n<SvIVX(sv_dat); n++ ) {
3532         if ((I32)rex->lastparen >= nums[n] &&
3533             rex->offs[nums[n]].end != -1)
3534         {
3535             return nums[n];
3536         }
3537     }
3538     return 0;
3539 }
3540
3541
3542 static bool
3543 S_setup_EXACTISH_ST_c1_c2(pTHX_ const regnode * const text_node, int *c1p,
3544         U8* c1_utf8, int *c2p, U8* c2_utf8, regmatch_info *reginfo)
3545 {
3546     /* This function determines if there are one or two characters that match
3547      * the first character of the passed-in EXACTish node <text_node>, and if
3548      * so, returns them in the passed-in pointers.
3549      *
3550      * If it determines that no possible character in the target string can
3551      * match, it returns FALSE; otherwise TRUE.  (The FALSE situation occurs if
3552      * the first character in <text_node> requires UTF-8 to represent, and the
3553      * target string isn't in UTF-8.)
3554      *
3555      * If there are more than two characters that could match the beginning of
3556      * <text_node>, or if more context is required to determine a match or not,
3557      * it sets both *<c1p> and *<c2p> to CHRTEST_VOID.
3558      *
3559      * The motiviation behind this function is to allow the caller to set up
3560      * tight loops for matching.  If <text_node> is of type EXACT, there is
3561      * only one possible character that can match its first character, and so
3562      * the situation is quite simple.  But things get much more complicated if
3563      * folding is involved.  It may be that the first character of an EXACTFish
3564      * node doesn't participate in any possible fold, e.g., punctuation, so it
3565      * can be matched only by itself.  The vast majority of characters that are
3566      * in folds match just two things, their lower and upper-case equivalents.
3567      * But not all are like that; some have multiple possible matches, or match
3568      * sequences of more than one character.  This function sorts all that out.
3569      *
3570      * Consider the patterns A*B or A*?B where A and B are arbitrary.  In a
3571      * loop of trying to match A*, we know we can't exit where the thing
3572      * following it isn't a B.  And something can't be a B unless it is the
3573      * beginning of B.  By putting a quick test for that beginning in a tight
3574      * loop, we can rule out things that can't possibly be B without having to
3575      * break out of the loop, thus avoiding work.  Similarly, if A is a single
3576      * character, we can make a tight loop matching A*, using the outputs of
3577      * this function.
3578      *
3579      * If the target string to match isn't in UTF-8, and there aren't
3580      * complications which require CHRTEST_VOID, *<c1p> and *<c2p> are set to
3581      * the one or two possible octets (which are characters in this situation)
3582      * that can match.  In all cases, if there is only one character that can
3583      * match, *<c1p> and *<c2p> will be identical.
3584      *
3585      * If the target string is in UTF-8, the buffers pointed to by <c1_utf8>
3586      * and <c2_utf8> will contain the one or two UTF-8 sequences of bytes that
3587      * can match the beginning of <text_node>.  They should be declared with at
3588      * least length UTF8_MAXBYTES+1.  (If the target string isn't in UTF-8, it is
3589      * undefined what these contain.)  If one or both of the buffers are
3590      * invariant under UTF-8, *<c1p>, and *<c2p> will also be set to the
3591      * corresponding invariant.  If variant, the corresponding *<c1p> and/or
3592      * *<c2p> will be set to a negative number(s) that shouldn't match any code
3593      * point (unless inappropriately coerced to unsigned).   *<c1p> will equal
3594      * *<c2p> if and only if <c1_utf8> and <c2_utf8> are the same. */
3595
3596     const bool utf8_target = reginfo->is_utf8_target;
3597
3598     UV c1 = CHRTEST_NOT_A_CP_1;
3599     UV c2 = CHRTEST_NOT_A_CP_2;
3600     bool use_chrtest_void = FALSE;
3601     const bool is_utf8_pat = reginfo->is_utf8_pat;
3602
3603     /* Used when we have both utf8 input and utf8 output, to avoid converting
3604      * to/from code points */
3605     bool utf8_has_been_setup = FALSE;
3606
3607     dVAR;
3608
3609     U8 *pat = (U8*)STRING(text_node);
3610     U8 folded[UTF8_MAX_FOLD_CHAR_EXPAND * UTF8_MAXBYTES_CASE + 1] = { '\0' };
3611
3612     if (OP(text_node) == EXACT) {
3613
3614         /* In an exact node, only one thing can be matched, that first
3615          * character.  If both the pat and the target are UTF-8, we can just
3616          * copy the input to the output, avoiding finding the code point of
3617          * that character */
3618         if (!is_utf8_pat) {
3619             c2 = c1 = *pat;
3620         }
3621         else if (utf8_target) {
3622             Copy(pat, c1_utf8, UTF8SKIP(pat), U8);
3623             Copy(pat, c2_utf8, UTF8SKIP(pat), U8);
3624             utf8_has_been_setup = TRUE;
3625         }
3626         else {
3627             c2 = c1 = valid_utf8_to_uvchr(pat, NULL);
3628         }
3629     }
3630     else { /* an EXACTFish node */
3631         U8 *pat_end = pat + STR_LEN(text_node);
3632
3633         /* An EXACTFL node has at least some characters unfolded, because what
3634          * they match is not known until now.  So, now is the time to fold
3635          * the first few of them, as many as are needed to determine 'c1' and
3636          * 'c2' later in the routine.  If the pattern isn't UTF-8, we only need
3637          * to fold if in a UTF-8 locale, and then only the Sharp S; everything
3638          * else is 1-1 and isn't assumed to be folded.  In a UTF-8 pattern, we
3639          * need to fold as many characters as a single character can fold to,
3640          * so that later we can check if the first ones are such a multi-char
3641          * fold.  But, in such a pattern only locale-problematic characters
3642          * aren't folded, so we can skip this completely if the first character
3643          * in the node isn't one of the tricky ones */
3644         if (OP(text_node) == EXACTFL) {
3645
3646             if (! is_utf8_pat) {
3647                 if (IN_UTF8_CTYPE_LOCALE && *pat == LATIN_SMALL_LETTER_SHARP_S)
3648                 {
3649                     folded[0] = folded[1] = 's';
3650                     pat = folded;
3651                     pat_end = folded + 2;
3652                 }
3653             }
3654             else if (is_PROBLEMATIC_LOCALE_FOLDEDS_START_utf8(pat)) {
3655                 U8 *s = pat;
3656                 U8 *d = folded;
3657                 int i;
3658
3659                 for (i = 0; i < UTF8_MAX_FOLD_CHAR_EXPAND && s < pat_end; i++) {
3660                     if (isASCII(*s)) {
3661                         *(d++) = (U8) toFOLD_LC(*s);
3662                         s++;
3663                     }
3664                     else {
3665                         STRLEN len;
3666                         _to_utf8_fold_flags(s,
3667                                             d,
3668                                             &len,
3669                                             FOLD_FLAGS_FULL | FOLD_FLAGS_LOCALE);
3670                         d += len;
3671                         s += UTF8SKIP(s);
3672                     }
3673                 }
3674
3675                 pat = folded;
3676                 pat_end = d;
3677             }
3678         }
3679
3680         if ((is_utf8_pat && is_MULTI_CHAR_FOLD_utf8_safe(pat, pat_end))
3681              || (!is_utf8_pat && is_MULTI_CHAR_FOLD_latin1_safe(pat, pat_end)))
3682         {
3683             /* Multi-character folds require more context to sort out.  Also
3684              * PL_utf8_foldclosures used below doesn't handle them, so have to
3685              * be handled outside this routine */
3686             use_chrtest_void = TRUE;
3687         }
3688         else { /* an EXACTFish node which doesn't begin with a multi-char fold */
3689             c1 = is_utf8_pat ? valid_utf8_to_uvchr(pat, NULL) : *pat;
3690             if (c1 > 255) {
3691                 /* Load the folds hash, if not already done */
3692                 SV** listp;
3693                 if (! PL_utf8_foldclosures) {
3694                     _load_PL_utf8_foldclosures();
3695                 }
3696
3697                 /* The fold closures data structure is a hash with the keys
3698                  * being the UTF-8 of every character that is folded to, like
3699                  * 'k', and the values each an array of all code points that
3700                  * fold to its key.  e.g. [ 'k', 'K', KELVIN_SIGN ].
3701                  * Multi-character folds are not included */
3702                 if ((! (listp = hv_fetch(PL_utf8_foldclosures,
3703                                         (char *) pat,
3704                                         UTF8SKIP(pat),
3705                                         FALSE))))
3706                 {
3707                     /* Not found in the hash, therefore there are no folds
3708                     * containing it, so there is only a single character that
3709                     * could match */
3710                     c2 = c1;
3711                 }
3712                 else {  /* Does participate in folds */
3713                     AV* list = (AV*) *listp;
3714                     if (av_tindex(list) != 1) {
3715
3716                         /* If there aren't exactly two folds to this, it is
3717                          * outside the scope of this function */
3718                         use_chrtest_void = TRUE;
3719                     }
3720                     else {  /* There are two.  Get them */
3721                         SV** c_p = av_fetch(list, 0, FALSE);
3722                         if (c_p == NULL) {
3723                             Perl_croak(aTHX_ "panic: invalid PL_utf8_foldclosures structure");
3724                         }
3725                         c1 = SvUV(*c_p);
3726
3727                         c_p = av_fetch(list, 1, FALSE);
3728                         if (c_p == NULL) {
3729                             Perl_croak(aTHX_ "panic: invalid PL_utf8_foldclosures structure");
3730                         }
3731                         c2 = SvUV(*c_p);
3732
3733                         /* Folds that cross the 255/256 boundary are forbidden
3734                          * if EXACTFL (and isnt a UTF8 locale), or EXACTFA and
3735                          * one is ASCIII.  Since the pattern character is above
3736                          * 255, and its only other match is below 256, the only
3737                          * legal match will be to itself.  We have thrown away
3738                          * the original, so have to compute which is the one
3739                          * above 255. */
3740                         if ((c1 < 256) != (c2 < 256)) {
3741                             if ((OP(text_node) == EXACTFL
3742                                  && ! IN_UTF8_CTYPE_LOCALE)
3743                                 || ((OP(text_node) == EXACTFA
3744                                     || OP(text_node) == EXACTFA_NO_TRIE)
3745                                     && (isASCII(c1) || isASCII(c2))))
3746                             {
3747                                 if (c1 < 256) {
3748                                     c1 = c2;
3749                                 }
3750                                 else {
3751                                     c2 = c1;
3752                                 }
3753                             }
3754                         }
3755                     }
3756                 }
3757             }
3758             else /* Here, c1 is <= 255 */
3759                 if (utf8_target
3760                     && HAS_NONLATIN1_FOLD_CLOSURE(c1)
3761                     && ( ! (OP(text_node) == EXACTFL && ! IN_UTF8_CTYPE_LOCALE))
3762                     && ((OP(text_node) != EXACTFA
3763                         && OP(text_node) != EXACTFA_NO_TRIE)
3764                         || ! isASCII(c1)))
3765             {
3766                 /* Here, there could be something above Latin1 in the target
3767                  * which folds to this character in the pattern.  All such
3768                  * cases except LATIN SMALL LETTER Y WITH DIAERESIS have more
3769                  * than two characters involved in their folds, so are outside
3770                  * the scope of this function */
3771                 if (UNLIKELY(c1 == LATIN_SMALL_LETTER_Y_WITH_DIAERESIS)) {
3772                     c2 = LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS;
3773                 }
3774                 else {
3775                     use_chrtest_void = TRUE;
3776                 }
3777             }
3778             else { /* Here nothing above Latin1 can fold to the pattern
3779                       character */
3780                 switch (OP(text_node)) {
3781
3782                     case EXACTFL:   /* /l rules */
3783                         c2 = PL_fold_locale[c1];
3784                         break;
3785
3786                     case EXACTF:   /* This node only generated for non-utf8
3787                                     patterns */
3788                         assert(! is_utf8_pat);
3789                         if (! utf8_target) {    /* /d rules */
3790                             c2 = PL_fold[c1];
3791                             break;
3792                         }
3793                         /* FALLTHROUGH */
3794                         /* /u rules for all these.  This happens to work for
3795                         * EXACTFA as nothing in Latin1 folds to ASCII */
3796                     case EXACTFA_NO_TRIE:   /* This node only generated for
3797                                             non-utf8 patterns */
3798                         assert(! is_utf8_pat);
3799                         /* FALLTHROUGH */
3800                     case EXACTFA:
3801                     case EXACTFU_SS:
3802                     case EXACTFU:
3803                         c2 = PL_fold_latin1[c1];
3804                         break;
3805
3806                     default:
3807                         Perl_croak(aTHX_ "panic: Unexpected op %u", OP(text_node));
3808                         assert(0); /* NOTREACHED */
3809                 }
3810             }
3811         }
3812     }
3813
3814     /* Here have figured things out.  Set up the returns */
3815     if (use_chrtest_void) {
3816         *c2p = *c1p = CHRTEST_VOID;
3817     }
3818     else if (utf8_target) {
3819         if (! utf8_has_been_setup) {    /* Don't have the utf8; must get it */
3820             uvchr_to_utf8(c1_utf8, c1);
3821             uvchr_to_utf8(c2_utf8, c2);
3822         }
3823
3824         /* Invariants are stored in both the utf8 and byte outputs; Use
3825          * negative numbers otherwise for the byte ones.  Make sure that the
3826          * byte ones are the same iff the utf8 ones are the same */
3827         *c1p = (UTF8_IS_INVARIANT(*c1_utf8)) ? *c1_utf8 : CHRTEST_NOT_A_CP_1;
3828         *c2p = (UTF8_IS_INVARIANT(*c2_utf8))
3829                 ? *c2_utf8
3830                 : (c1 == c2)
3831                   ? CHRTEST_NOT_A_CP_1
3832                   : CHRTEST_NOT_A_CP_2;
3833     }
3834     else if (c1 > 255) {
3835        if (c2 > 255) {  /* both possibilities are above what a non-utf8 string
3836                            can represent */
3837            return FALSE;
3838        }
3839
3840        *c1p = *c2p = c2;    /* c2 is the only representable value */
3841     }
3842     else {  /* c1 is representable; see about c2 */
3843        *c1p = c1;
3844        *c2p = (c2 < 256) ? c2 : c1;
3845     }
3846
3847     return TRUE;
3848 }
3849
3850 /* returns -1 on failure, $+[0] on success */
3851 STATIC SSize_t
3852 S_regmatch(pTHX_ regmatch_info *reginfo, char *startpos, regnode *prog)
3853 {
3854 #if PERL_VERSION < 9 && !defined(PERL_CORE)
3855     dMY_CXT;
3856 #endif
3857     dVAR;
3858     const bool utf8_target = reginfo->is_utf8_target;
3859     const U32 uniflags = UTF8_ALLOW_DEFAULT;
3860     REGEXP *rex_sv = reginfo->prog;
3861     regexp *rex = ReANY(rex_sv);
3862     RXi_GET_DECL(rex,rexi);
3863     /* the current state. This is a cached copy of PL_regmatch_state */
3864     regmatch_state *st;
3865     /* cache heavy used fields of st in registers */
3866     regnode *scan;
3867     regnode *next;
3868     U32 n = 0;  /* general value; init to avoid compiler warning */
3869     SSize_t ln = 0; /* len or last;  init to avoid compiler warning */
3870     char *locinput = startpos;
3871     char *pushinput; /* where to continue after a PUSH */
3872     I32 nextchr;   /* is always set to UCHARAT(locinput) */
3873
3874     bool result = 0;        /* return value of S_regmatch */
3875     int depth = 0;          /* depth of backtrack stack */
3876     U32 nochange_depth = 0; /* depth of GOSUB recursion with nochange */
3877     const U32 max_nochange_depth =
3878         (3 * rex->nparens > MAX_RECURSE_EVAL_NOCHANGE_DEPTH) ?
3879         3 * rex->nparens : MAX_RECURSE_EVAL_NOCHANGE_DEPTH;
3880     regmatch_state *yes_state = NULL; /* state to pop to on success of
3881                                                             subpattern */
3882     /* mark_state piggy backs on the yes_state logic so that when we unwind 
3883        the stack on success we can update the mark_state as we go */
3884     regmatch_state *mark_state = NULL; /* last mark state we have seen */
3885     regmatch_state *cur_eval = NULL; /* most recent EVAL_AB state */
3886     struct regmatch_state  *cur_curlyx = NULL; /* most recent curlyx */
3887     U32 state_num;
3888     bool no_final = 0;      /* prevent failure from backtracking? */
3889     bool do_cutgroup = 0;   /* no_final only until next branch/trie entry */
3890     char *startpoint = locinput;
3891     SV *popmark = NULL;     /* are we looking for a mark? */
3892     SV *sv_commit = NULL;   /* last mark name seen in failure */
3893     SV *sv_yes_mark = NULL; /* last mark name we have seen 
3894                                during a successful match */
3895     U32 lastopen = 0;       /* last open we saw */
3896     bool has_cutgroup = RX_HAS_CUTGROUP(rex) ? 1 : 0;   
3897     SV* const oreplsv = GvSVn(PL_replgv);
3898     /* these three flags are set by various ops to signal information to
3899      * the very next op. They have a useful lifetime of exactly one loop
3900      * iteration, and are not preserved or restored by state pushes/pops
3901      */
3902     bool sw = 0;            /* the condition value in (?(cond)a|b) */
3903     bool minmod = 0;        /* the next "{n,m}" is a "{n,m}?" */
3904     int logical = 0;        /* the following EVAL is:
3905                                 0: (?{...})
3906                                 1: (?(?{...})X|Y)
3907                                 2: (??{...})
3908                                or the following IFMATCH/UNLESSM is:
3909                                 false: plain (?=foo)
3910                                 true:  used as a condition: (?(?=foo))
3911                             */
3912     PAD* last_pad = NULL;
3913     dMULTICALL;
3914     I32 gimme = G_SCALAR;
3915     CV *caller_cv = NULL;       /* who called us */
3916     CV *last_pushed_cv = NULL;  /* most recently called (?{}) CV */
3917     CHECKPOINT runops_cp;       /* savestack position before executing EVAL */
3918     U32 maxopenparen = 0;       /* max '(' index seen so far */
3919     int to_complement;  /* Invert the result? */
3920     _char_class_number classnum;
3921     bool is_utf8_pat = reginfo->is_utf8_pat;
3922
3923 #ifdef DEBUGGING
3924     GET_RE_DEBUG_FLAGS_DECL;
3925 #endif
3926
3927     /* protect against undef(*^R) */
3928     SAVEFREESV(SvREFCNT_inc_simple_NN(oreplsv));
3929
3930     /* shut up 'may be used uninitialized' compiler warnings for dMULTICALL */
3931     multicall_oldcatch = 0;
3932     multicall_cv = NULL;