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