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