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