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