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