regcomp.c

   1 /*    regcomp.c
   2  */
   3
   4 /*
   5  * "A fair jaw-cracker dwarf-language must be."  --Samwise Gamgee
   6  */
   7
   8 /* This file contains functions for compiling a regular expression.  See
   9  * also regexec.c which funnily enough, contains functions for executing
  10  * a regular expression.
  11  *
  12  * This file is also copied at build time to ext/re/re_comp.c, where
  13  * it's built with -DPERL_EXT_RE_BUILD -DPERL_EXT_RE_DEBUG -DPERL_EXT.
  14  * This causes the main functions to be compiled under new names and with
  15  * debugging support added, which makes "use re 'debug'" work.
  16  */
  17
  18 /* NOTE: this is derived from Henry Spencer's regexp code, and should not
  19  * confused with the original package (see point 3 below).  Thanks, Henry!
  20  */
  21
  22 /* Additional note: this code is very heavily munged from Henry's version
  23  * in places.  In some spots I've traded clarity for efficiency, so don't
  24  * blame Henry for some of the lack of readability.
  25  */
  26
  27 /* The names of the functions have been changed from regcomp and
  28  * regexec to  pregcomp and pregexec in order to avoid conflicts
  29  * with the POSIX routines of the same names.
  30 */
  31
  32 #ifdef PERL_EXT_RE_BUILD
  33 #include "re_top.h"
  34 #endif
  35
  36 /*
  37  * pregcomp and pregexec -- regsub and regerror are not used in perl
  38  *
  39  *      Copyright (c) 1986 by University of Toronto.
  40  *      Written by Henry Spencer.  Not derived from licensed software.
  41  *
  42  *      Permission is granted to anyone to use this software for any
  43  *      purpose on any computer system, and to redistribute it freely,
  44  *      subject to the following restrictions:
  45  *
  46  *      1. The author is not responsible for the consequences of use of
  47  *              this software, no matter how awful, even if they arise
  48  *              from defects in it.
  49  *
  50  *      2. The origin of this software must not be misrepresented, either
  51  *              by explicit claim or by omission.
  52  *
  53  *      3. Altered versions must be plainly marked as such, and must not
  54  *              be misrepresented as being the original software.
  55  *
  56  *
  57  ****    Alterations to Henry's code are...
  58  ****
  59  ****    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
  60  ****    2000, 2001, 2002, 2003, 2004, 2005, 2006, by Larry Wall and others
  61  ****
  62  ****    You may distribute under the terms of either the GNU General Public
  63  ****    License or the Artistic License, as specified in the README file.
  64
  65  *
  66  * Beware that some of this code is subtly aware of the way operator
  67  * precedence is structured in regular expressions.  Serious changes in
  68  * regular-expression syntax might require a total rethink.
  69  */
  70 #include "EXTERN.h"
  71 #define PERL_IN_REGCOMP_C
  72 #include "perl.h"
  73
  74 #ifndef PERL_IN_XSUB_RE
  75 #  include "INTERN.h"
  76 #endif
  77
  78 #define REG_COMP_C
  79 #ifdef PERL_IN_XSUB_RE
  80 #  include "re_comp.h"
  81 #else
  82 #  include "regcomp.h"
  83 #endif
  84
  85 #ifdef op
  86 #undef op
  87 #endif /* op */
  88
  89 #ifdef MSDOS
  90 #  if defined(BUGGY_MSC6)
  91  /* MSC 6.00A breaks on op/regexp.t test 85 unless we turn this off */
  92 #    pragma optimize("a",off)
  93  /* But MSC 6.00A is happy with 'w', for aliases only across function calls*/
  94 #    pragma optimize("w",on )
  95 #  endif /* BUGGY_MSC6 */
  96 #endif /* MSDOS */
  97
  98 #ifndef STATIC
  99 #define STATIC  static
 100 #endif
 101
 102 typedef struct RExC_state_t {
 103     U32         flags;                  /* are we folding, multilining? */
 104     char        *precomp;               /* uncompiled string. */
 105     regexp      *rx;
 106     char        *start;                 /* Start of input for compile */
 107     char        *end;                   /* End of input for compile */
 108     char        *parse;                 /* Input-scan pointer. */
 109     I32         whilem_seen;            /* number of WHILEM in this expr */
 110     regnode     *emit_start;            /* Start of emitted-code area */
 111     regnode     *emit;                  /* Code-emit pointer; &regdummy = don't = compiling */
 112     I32         naughty;                /* How bad is this pattern? */
 113     I32         sawback;                /* Did we see \1, ...? */
 114     U32         seen;
 115     I32         size;                   /* Code size. */
 116     I32         npar;                   /* () count. */
 117     I32         extralen;
 118     I32         seen_zerolen;
 119     I32         seen_evals;
 120     regnode     **parens;               /* offsets of each paren */
 121     I32         utf8;
 122     HV          *charnames;             /* cache of named sequences */
 123     HV          *paren_names;           /* Paren names */
 124 #if ADD_TO_REGEXEC
 125     char        *starttry;              /* -Dr: where regtry was called. */
 126 #define RExC_starttry   (pRExC_state->starttry)
 127 #endif
 128 #ifdef DEBUGGING
 129     const char  *lastparse;
 130     I32         lastnum;
 131 #define RExC_lastparse  (pRExC_state->lastparse)
 132 #define RExC_lastnum    (pRExC_state->lastnum)
 133 #endif
 134 } RExC_state_t;
 135
 136 #define RExC_flags      (pRExC_state->flags)
 137 #define RExC_precomp    (pRExC_state->precomp)
 138 #define RExC_rx         (pRExC_state->rx)
 139 #define RExC_start      (pRExC_state->start)
 140 #define RExC_end        (pRExC_state->end)
 141 #define RExC_parse      (pRExC_state->parse)
 142 #define RExC_whilem_seen        (pRExC_state->whilem_seen)
 143 #define RExC_offsets    (pRExC_state->rx->offsets) /* I am not like the others */
 144 #define RExC_emit       (pRExC_state->emit)
 145 #define RExC_emit_start (pRExC_state->emit_start)
 146 #define RExC_naughty    (pRExC_state->naughty)
 147 #define RExC_sawback    (pRExC_state->sawback)
 148 #define RExC_seen       (pRExC_state->seen)
 149 #define RExC_size       (pRExC_state->size)
 150 #define RExC_npar       (pRExC_state->npar)
 151 #define RExC_extralen   (pRExC_state->extralen)
 152 #define RExC_seen_zerolen       (pRExC_state->seen_zerolen)
 153 #define RExC_seen_evals (pRExC_state->seen_evals)
 154 #define RExC_utf8       (pRExC_state->utf8)
 155 #define RExC_charnames  (pRExC_state->charnames)
 156 #define RExC_parens     (pRExC_state->parens)
 157 #define RExC_paren_names        (pRExC_state->paren_names)
 158
 159 #define ISMULT1(c)      ((c) == '*' || (c) == '+' || (c) == '?')
 160 #define ISMULT2(s)      ((*s) == '*' || (*s) == '+' || (*s) == '?' || \
 161         ((*s) == '{' && regcurly(s)))
 162
 163 #ifdef SPSTART
 164 #undef SPSTART          /* dratted cpp namespace... */
 165 #endif
 166 /*
 167  * Flags to be passed up and down.
 168  */
 169 #define WORST           0       /* Worst case. */
 170 #define HASWIDTH        0x1     /* Known to match non-null strings. */
 171 #define SIMPLE          0x2     /* Simple enough to be STAR/PLUS operand. */
 172 #define SPSTART         0x4     /* Starts with * or +. */
 173 #define TRYAGAIN        0x8     /* Weeded out a declaration. */
 174
 175 #define REG_NODE_NUM(x) ((x) ? (int)((x)-RExC_emit_start) : -1)
 176
 177 /* whether trie related optimizations are enabled */
 178 #if PERL_ENABLE_EXTENDED_TRIE_OPTIMISATION
 179 #define TRIE_STUDY_OPT
 180 #define FULL_TRIE_STUDY
 181 #define TRIE_STCLASS
 182 #endif
 183
 184
 185 /* About scan_data_t.
 186
 187   During optimisation we recurse through the regexp program performing
 188   various inplace (keyhole style) optimisations. In addition study_chunk
 189   and scan_commit populate this data structure with information about
 190   what strings MUST appear in the pattern. We look for the longest
 191   string that must appear for at a fixed location, and we look for the
 192   longest string that may appear at a floating location. So for instance
 193   in the pattern:
 194
 195     /FOO[xX]A.*B[xX]BAR/
 196
 197   Both 'FOO' and 'A' are fixed strings. Both 'B' and 'BAR' are floating
 198   strings (because they follow a .* construct). study_chunk will identify
 199   both FOO and BAR as being the longest fixed and floating strings respectively.
 200
 201   The strings can be composites, for instance
 202
 203      /(f)(o)(o)/
 204
 205   will result in a composite fixed substring 'foo'.
 206
 207   For each string some basic information is maintained:
 208
 209   - offset or min_offset
 210     This is the position the string must appear at, or not before.
 211     It also implicitly (when combined with minlenp) tells us how many
 212     character must match before the string we are searching.
 213     Likewise when combined with minlenp and the length of the string
 214     tells us how many characters must appear after the string we have
 215     found.
 216
 217   - max_offset
 218     Only used for floating strings. This is the rightmost point that
 219     the string can appear at. Ifset to I32 max it indicates that the
 220     string can occur infinitely far to the right.
 221
 222   - minlenp
 223     A pointer to the minimum length of the pattern that the string
 224     was found inside. This is important as in the case of positive
 225     lookahead or positive lookbehind we can have multiple patterns
 226     involved. Consider
 227
 228     /(?=FOO).*F/
 229
 230     The minimum length of the pattern overall is 3, the minimum length
 231     of the lookahead part is 3, but the minimum length of the part that
 232     will actually match is 1. So 'FOO's minimum length is 3, but the
 233     minimum length for the F is 1. This is important as the minimum length
 234     is used to determine offsets in front of and behind the string being
 235     looked for.  Since strings can be composites this is the length of the
 236     pattern at the time it was commited with a scan_commit. Note that
 237     the length is calculated by study_chunk, so that the minimum lengths
 238     are not known until the full pattern has been compiled, thus the
 239     pointer to the value.
 240
 241   - lookbehind
 242
 243     In the case of lookbehind the string being searched for can be
 244     offset past the start point of the final matching string.
 245     If this value was just blithely removed from the min_offset it would
 246     invalidate some of the calculations for how many chars must match
 247     before or after (as they are derived from min_offset and minlen and
 248     the length of the string being searched for).
 249     When the final pattern is compiled and the data is moved from the
 250     scan_data_t structure into the regexp structure the information
 251     about lookbehind is factored in, with the information that would
 252     have been lost precalculated in the end_shift field for the
 253     associated string.
 254
 255   The fields pos_min and pos_delta are used to store the minimum offset
 256   and the delta to the maximum offset at the current point in the pattern.
 257
 258 */
 259
 260 typedef struct scan_data_t {
 261     /*I32 len_min;      unused */
 262     /*I32 len_delta;    unused */
 263     I32 pos_min;
 264     I32 pos_delta;
 265     SV *last_found;
 266     I32 last_end;           /* min value, <0 unless valid. */
 267     I32 last_start_min;
 268     I32 last_start_max;
 269     SV **longest;           /* Either &l_fixed, or &l_float. */
 270     SV *longest_fixed;      /* longest fixed string found in pattern */
 271     I32 offset_fixed;       /* offset where it starts */
 272     I32 *minlen_fixed;      /* pointer to the minlen relevent to the string */
 273     I32 lookbehind_fixed;   /* is the position of the string modfied by LB */
 274     SV *longest_float;      /* longest floating string found in pattern */
 275     I32 offset_float_min;   /* earliest point in string it can appear */
 276     I32 offset_float_max;   /* latest point in string it can appear */
 277     I32 *minlen_float;      /* pointer to the minlen relevent to the string */
 278     I32 lookbehind_float;   /* is the position of the string modified by LB */
 279     I32 flags;
 280     I32 whilem_c;
 281     I32 *last_closep;
 282     struct regnode_charclass_class *start_class;
 283 } scan_data_t;
 284
 285 /*
 286  * Forward declarations for pregcomp()'s friends.
 287  */
 288
 289 static const scan_data_t zero_scan_data =
 290   { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ,0};
 291
 292 #define SF_BEFORE_EOL           (SF_BEFORE_SEOL|SF_BEFORE_MEOL)
 293 #define SF_BEFORE_SEOL          0x0001
 294 #define SF_BEFORE_MEOL          0x0002
 295 #define SF_FIX_BEFORE_EOL       (SF_FIX_BEFORE_SEOL|SF_FIX_BEFORE_MEOL)
 296 #define SF_FL_BEFORE_EOL        (SF_FL_BEFORE_SEOL|SF_FL_BEFORE_MEOL)
 297
 298 #ifdef NO_UNARY_PLUS
 299 #  define SF_FIX_SHIFT_EOL      (0+2)
 300 #  define SF_FL_SHIFT_EOL               (0+4)
 301 #else
 302 #  define SF_FIX_SHIFT_EOL      (+2)
 303 #  define SF_FL_SHIFT_EOL               (+4)
 304 #endif
 305
 306 #define SF_FIX_BEFORE_SEOL      (SF_BEFORE_SEOL << SF_FIX_SHIFT_EOL)
 307 #define SF_FIX_BEFORE_MEOL      (SF_BEFORE_MEOL << SF_FIX_SHIFT_EOL)
 308
 309 #define SF_FL_BEFORE_SEOL       (SF_BEFORE_SEOL << SF_FL_SHIFT_EOL)
 310 #define SF_FL_BEFORE_MEOL       (SF_BEFORE_MEOL << SF_FL_SHIFT_EOL) /* 0x20 */
 311 #define SF_IS_INF               0x0040
 312 #define SF_HAS_PAR              0x0080
 313 #define SF_IN_PAR               0x0100
 314 #define SF_HAS_EVAL             0x0200
 315 #define SCF_DO_SUBSTR           0x0400
 316 #define SCF_DO_STCLASS_AND      0x0800
 317 #define SCF_DO_STCLASS_OR       0x1000
 318 #define SCF_DO_STCLASS          (SCF_DO_STCLASS_AND|SCF_DO_STCLASS_OR)
 319 #define SCF_WHILEM_VISITED_POS  0x2000
 320
 321 #define SCF_TRIE_RESTUDY        0x4000 /* Do restudy? */
 322
 323
 324 #define UTF (RExC_utf8 != 0)
 325 #define LOC ((RExC_flags & PMf_LOCALE) != 0)
 326 #define FOLD ((RExC_flags & PMf_FOLD) != 0)
 327
 328 #define OOB_UNICODE             12345678
 329 #define OOB_NAMEDCLASS          -1
 330
 331 #define CHR_SVLEN(sv) (UTF ? sv_len_utf8(sv) : SvCUR(sv))
 332 #define CHR_DIST(a,b) (UTF ? utf8_distance(a,b) : a - b)
 333
 334
 335 /* length of regex to show in messages that don't mark a position within */
 336 #define RegexLengthToShowInErrorMessages 127
 337
 338 /*
 339  * If MARKER[12] are adjusted, be sure to adjust the constants at the top
 340  * of t/op/regmesg.t, the tests in t/op/re_tests, and those in
 341  * op/pragma/warn/regcomp.
 342  */
 343 #define MARKER1 "<-- HERE"    /* marker as it appears in the description */
 344 #define MARKER2 " <-- HERE "  /* marker as it appears within the regex */
 345
 346 #define REPORT_LOCATION " in regex; marked by " MARKER1 " in m/%.*s" MARKER2 "%s/"
 347
 348 /*
 349  * Calls SAVEDESTRUCTOR_X if needed, then calls Perl_croak with the given
 350  * arg. Show regex, up to a maximum length. If it's too long, chop and add
 351  * "...".
 352  */
 353 #define FAIL(msg) STMT_START {                                          \
 354     const char *ellipses = "";                                          \
 355     IV len = RExC_end - RExC_precomp;                                   \
 356                                                                         \
 357     if (!SIZE_ONLY)                                                     \
 358         SAVEDESTRUCTOR_X(clear_re,(void*)RExC_rx);                      \
 359     if (len > RegexLengthToShowInErrorMessages) {                       \
 360         /* chop 10 shorter than the max, to ensure meaning of "..." */  \
 361         len = RegexLengthToShowInErrorMessages - 10;                    \
 362         ellipses = "...";                                               \
 363     }                                                                   \
 364     Perl_croak(aTHX_ "%s in regex m/%.*s%s/",                           \
 365             msg, (int)len, RExC_precomp, ellipses);                     \
 366 } STMT_END
 367
 368 /*
 369  * Simple_vFAIL -- like FAIL, but marks the current location in the scan
 370  */
 371 #define Simple_vFAIL(m) STMT_START {                                    \
 372     const IV offset = RExC_parse - RExC_precomp;                        \
 373     Perl_croak(aTHX_ "%s" REPORT_LOCATION,                              \
 374             m, (int)offset, RExC_precomp, RExC_precomp + offset);       \
 375 } STMT_END
 376
 377 /*
 378  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL()
 379  */
 380 #define vFAIL(m) STMT_START {                           \
 381     if (!SIZE_ONLY)                                     \
 382         SAVEDESTRUCTOR_X(clear_re,(void*)RExC_rx);      \
 383     Simple_vFAIL(m);                                    \
 384 } STMT_END
 385
 386 /*
 387  * Like Simple_vFAIL(), but accepts two arguments.
 388  */
 389 #define Simple_vFAIL2(m,a1) STMT_START {                        \
 390     const IV offset = RExC_parse - RExC_precomp;                        \
 391     S_re_croak2(aTHX_ m, REPORT_LOCATION, a1,                   \
 392             (int)offset, RExC_precomp, RExC_precomp + offset);  \
 393 } STMT_END
 394
 395 /*
 396  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL2().
 397  */
 398 #define vFAIL2(m,a1) STMT_START {                       \
 399     if (!SIZE_ONLY)                                     \
 400         SAVEDESTRUCTOR_X(clear_re,(void*)RExC_rx);      \
 401     Simple_vFAIL2(m, a1);                               \
 402 } STMT_END
 403
 404
 405 /*
 406  * Like Simple_vFAIL(), but accepts three arguments.
 407  */
 408 #define Simple_vFAIL3(m, a1, a2) STMT_START {                   \
 409     const IV offset = RExC_parse - RExC_precomp;                \
 410     S_re_croak2(aTHX_ m, REPORT_LOCATION, a1, a2,               \
 411             (int)offset, RExC_precomp, RExC_precomp + offset);  \
 412 } STMT_END
 413
 414 /*
 415  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL3().
 416  */
 417 #define vFAIL3(m,a1,a2) STMT_START {                    \
 418     if (!SIZE_ONLY)                                     \
 419         SAVEDESTRUCTOR_X(clear_re,(void*)RExC_rx);      \
 420     Simple_vFAIL3(m, a1, a2);                           \
 421 } STMT_END
 422
 423 /*
 424  * Like Simple_vFAIL(), but accepts four arguments.
 425  */
 426 #define Simple_vFAIL4(m, a1, a2, a3) STMT_START {               \
 427     const IV offset = RExC_parse - RExC_precomp;                \
 428     S_re_croak2(aTHX_ m, REPORT_LOCATION, a1, a2, a3,           \
 429             (int)offset, RExC_precomp, RExC_precomp + offset);  \
 430 } STMT_END
 431
 432 #define vWARN(loc,m) STMT_START {                                       \
 433     const IV offset = loc - RExC_precomp;                               \
 434     Perl_warner(aTHX_ packWARN(WARN_REGEXP), "%s" REPORT_LOCATION,      \
 435             m, (int)offset, RExC_precomp, RExC_precomp + offset);       \
 436 } STMT_END
 437
 438 #define vWARNdep(loc,m) STMT_START {                                    \
 439     const IV offset = loc - RExC_precomp;                               \
 440     Perl_warner(aTHX_ packWARN2(WARN_DEPRECATED, WARN_REGEXP),          \
 441             "%s" REPORT_LOCATION,                                       \
 442             m, (int)offset, RExC_precomp, RExC_precomp + offset);       \
 443 } STMT_END
 444
 445
 446 #define vWARN2(loc, m, a1) STMT_START {                                 \
 447     const IV offset = loc - RExC_precomp;                               \
 448     Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,         \
 449             a1, (int)offset, RExC_precomp, RExC_precomp + offset);      \
 450 } STMT_END
 451
 452 #define vWARN3(loc, m, a1, a2) STMT_START {                             \
 453     const IV offset = loc - RExC_precomp;                               \
 454     Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,         \
 455             a1, a2, (int)offset, RExC_precomp, RExC_precomp + offset);  \
 456 } STMT_END
 457
 458 #define vWARN4(loc, m, a1, a2, a3) STMT_START {                         \
 459     const IV offset = loc - RExC_precomp;                               \
 460     Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,         \
 461             a1, a2, a3, (int)offset, RExC_precomp, RExC_precomp + offset); \
 462 } STMT_END
 463
 464 #define vWARN5(loc, m, a1, a2, a3, a4) STMT_START {                     \
 465     const IV offset = loc - RExC_precomp;                               \
 466     Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,         \
 467             a1, a2, a3, a4, (int)offset, RExC_precomp, RExC_precomp + offset); \
 468 } STMT_END
 469
 470
 471 /* Allow for side effects in s */
 472 #define REGC(c,s) STMT_START {                  \
 473     if (!SIZE_ONLY) *(s) = (c); else (void)(s); \
 474 } STMT_END
 475
 476 /* Macros for recording node offsets.   20001227 mjd@plover.com
 477  * Nodes are numbered 1, 2, 3, 4.  Node #n's position is recorded in
 478  * element 2*n-1 of the array.  Element #2n holds the byte length node #n.
 479  * Element 0 holds the number n.
 480  * Position is 1 indexed.
 481  */
 482
 483 #define Set_Node_Offset_To_R(node,byte) STMT_START {                    \
 484     if (! SIZE_ONLY) {                                                  \
 485         MJD_OFFSET_DEBUG(("** (%d) offset of node %d is %d.\n",         \
 486                     __LINE__, (node), (int)(byte)));                    \
 487         if((node) < 0) {                                                \
 488             Perl_croak(aTHX_ "value of node is %d in Offset macro", (int)(node)); \
 489         } else {                                                        \
 490             RExC_offsets[2*(node)-1] = (byte);                          \
 491         }                                                               \
 492     }                                                                   \
 493 } STMT_END
 494
 495 #define Set_Node_Offset(node,byte) \
 496     Set_Node_Offset_To_R((node)-RExC_emit_start, (byte)-RExC_start)
 497 #define Set_Cur_Node_Offset Set_Node_Offset(RExC_emit, RExC_parse)
 498
 499 #define Set_Node_Length_To_R(node,len) STMT_START {                     \
 500     if (! SIZE_ONLY) {                                                  \
 501         MJD_OFFSET_DEBUG(("** (%d) size of node %d is %d.\n",           \
 502                 __LINE__, (int)(node), (int)(len)));                    \
 503         if((node) < 0) {                                                \
 504             Perl_croak(aTHX_ "value of node is %d in Length macro", (int)(node)); \
 505         } else {                                                        \
 506             RExC_offsets[2*(node)] = (len);                             \
 507         }                                                               \
 508     }                                                                   \
 509 } STMT_END
 510
 511 #define Set_Node_Length(node,len) \
 512     Set_Node_Length_To_R((node)-RExC_emit_start, len)
 513 #define Set_Cur_Node_Length(len) Set_Node_Length(RExC_emit, len)
 514 #define Set_Node_Cur_Length(node) \
 515     Set_Node_Length(node, RExC_parse - parse_start)
 516
 517 /* Get offsets and lengths */
 518 #define Node_Offset(n) (RExC_offsets[2*((n)-RExC_emit_start)-1])
 519 #define Node_Length(n) (RExC_offsets[2*((n)-RExC_emit_start)])
 520
 521 #define Set_Node_Offset_Length(node,offset,len) STMT_START {    \
 522     Set_Node_Offset_To_R((node)-RExC_emit_start, (offset));     \
 523     Set_Node_Length_To_R((node)-RExC_emit_start, (len));        \
 524 } STMT_END
 525
 526
 527 #if PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS
 528 #define EXPERIMENTAL_INPLACESCAN
 529 #endif
 530
 531 #define DEBUG_STUDYDATA(data,depth)                                  \
 532 DEBUG_OPTIMISE_MORE_r(if(data){                                           \
 533     PerlIO_printf(Perl_debug_log,                                    \
 534         "%*s"/* Len:%"IVdf"/%"IVdf" */" Pos:%"IVdf"/%"IVdf           \
 535         " Flags: %"IVdf" Whilem_c: %"IVdf" Lcp: %"IVdf" ",           \
 536         (int)(depth)*2, "",                                          \
 537         (IV)((data)->pos_min),                                       \
 538         (IV)((data)->pos_delta),                                     \
 539         (IV)((data)->flags),                                         \
 540         (IV)((data)->whilem_c),                                      \
 541         (IV)((data)->last_closep ? *((data)->last_closep) : -1)      \
 542     );                                                               \
 543     if ((data)->last_found)                                          \
 544         PerlIO_printf(Perl_debug_log,                                \
 545             "Last:'%s' %"IVdf":%"IVdf"/%"IVdf" %sFixed:'%s' @ %"IVdf \
 546             " %sFloat: '%s' @ %"IVdf"/%"IVdf"",                      \
 547             SvPVX_const((data)->last_found),                         \
 548             (IV)((data)->last_end),                                  \
 549             (IV)((data)->last_start_min),                            \
 550             (IV)((data)->last_start_max),                            \
 551             ((data)->longest &&                                      \
 552              (data)->longest==&((data)->longest_fixed)) ? "*" : "",  \
 553             SvPVX_const((data)->longest_fixed),                      \
 554             (IV)((data)->offset_fixed),                              \
 555             ((data)->longest &&                                      \
 556              (data)->longest==&((data)->longest_float)) ? "*" : "",  \
 557             SvPVX_const((data)->longest_float),                      \
 558             (IV)((data)->offset_float_min),                          \
 559             (IV)((data)->offset_float_max)                           \
 560         );                                                           \
 561     PerlIO_printf(Perl_debug_log,"\n");                              \
 562 });
 563
 564 static void clear_re(pTHX_ void *r);
 565
 566 /* Mark that we cannot extend a found fixed substring at this point.
 567    Update the longest found anchored substring and the longest found
 568    floating substrings if needed. */
 569
 570 STATIC void
 571 S_scan_commit(pTHX_ const RExC_state_t *pRExC_state, scan_data_t *data, I32 *minlenp)
 572 {
 573     const STRLEN l = CHR_SVLEN(data->last_found);
 574     const STRLEN old_l = CHR_SVLEN(*data->longest);
 575     GET_RE_DEBUG_FLAGS_DECL;
 576
 577     if ((l >= old_l) && ((l > old_l) || (data->flags & SF_BEFORE_EOL))) {
 578         SvSetMagicSV(*data->longest, data->last_found);
 579         if (*data->longest == data->longest_fixed) {
 580             data->offset_fixed = l ? data->last_start_min : data->pos_min;
 581             if (data->flags & SF_BEFORE_EOL)
 582                 data->flags
 583                     |= ((data->flags & SF_BEFORE_EOL) << SF_FIX_SHIFT_EOL);
 584             else
 585                 data->flags &= ~SF_FIX_BEFORE_EOL;
 586             data->minlen_fixed=minlenp;
 587             data->lookbehind_fixed=0;
 588         }
 589         else {
 590             data->offset_float_min = l ? data->last_start_min : data->pos_min;
 591             data->offset_float_max = (l
 592                                       ? data->last_start_max
 593                                       : data->pos_min + data->pos_delta);
 594             if ((U32)data->offset_float_max > (U32)I32_MAX)
 595                 data->offset_float_max = I32_MAX;
 596             if (data->flags & SF_BEFORE_EOL)
 597                 data->flags
 598                     |= ((data->flags & SF_BEFORE_EOL) << SF_FL_SHIFT_EOL);
 599             else
 600                 data->flags &= ~SF_FL_BEFORE_EOL;
 601             data->minlen_float=minlenp;
 602             data->lookbehind_float=0;
 603         }
 604     }
 605     SvCUR_set(data->last_found, 0);
 606     {
 607         SV * const sv = data->last_found;
 608         if (SvUTF8(sv) && SvMAGICAL(sv)) {
 609             MAGIC * const mg = mg_find(sv, PERL_MAGIC_utf8);
 610             if (mg)
 611                 mg->mg_len = 0;
 612         }
 613     }
 614     data->last_end = -1;
 615     data->flags &= ~SF_BEFORE_EOL;
 616     DEBUG_STUDYDATA(data,0);
 617 }
 618
 619 /* Can match anything (initialization) */
 620 STATIC void
 621 S_cl_anything(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl)
 622 {
 623     ANYOF_CLASS_ZERO(cl);
 624     ANYOF_BITMAP_SETALL(cl);
 625     cl->flags = ANYOF_EOS|ANYOF_UNICODE_ALL;
 626     if (LOC)
 627         cl->flags |= ANYOF_LOCALE;
 628 }
 629
 630 /* Can match anything (initialization) */
 631 STATIC int
 632 S_cl_is_anything(const struct regnode_charclass_class *cl)
 633 {
 634     int value;
 635
 636     for (value = 0; value <= ANYOF_MAX; value += 2)
 637         if (ANYOF_CLASS_TEST(cl, value) && ANYOF_CLASS_TEST(cl, value + 1))
 638             return 1;
 639     if (!(cl->flags & ANYOF_UNICODE_ALL))
 640         return 0;
 641     if (!ANYOF_BITMAP_TESTALLSET((const void*)cl))
 642         return 0;
 643     return 1;
 644 }
 645
 646 /* Can match anything (initialization) */
 647 STATIC void
 648 S_cl_init(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl)
 649 {
 650     Zero(cl, 1, struct regnode_charclass_class);
 651     cl->type = ANYOF;
 652     cl_anything(pRExC_state, cl);
 653 }
 654
 655 STATIC void
 656 S_cl_init_zero(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl)
 657 {
 658     Zero(cl, 1, struct regnode_charclass_class);
 659     cl->type = ANYOF;
 660     cl_anything(pRExC_state, cl);
 661     if (LOC)
 662         cl->flags |= ANYOF_LOCALE;
 663 }
 664
 665 /* 'And' a given class with another one.  Can create false positives */
 666 /* We assume that cl is not inverted */
 667 STATIC void
 668 S_cl_and(struct regnode_charclass_class *cl,
 669         const struct regnode_charclass_class *and_with)
 670 {
 671     if (!(and_with->flags & ANYOF_CLASS)
 672         && !(cl->flags & ANYOF_CLASS)
 673         && (and_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
 674         && !(and_with->flags & ANYOF_FOLD)
 675         && !(cl->flags & ANYOF_FOLD)) {
 676         int i;
 677
 678         if (and_with->flags & ANYOF_INVERT)
 679             for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
 680                 cl->bitmap[i] &= ~and_with->bitmap[i];
 681         else
 682             for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
 683                 cl->bitmap[i] &= and_with->bitmap[i];
 684     } /* XXXX: logic is complicated otherwise, leave it along for a moment. */
 685     if (!(and_with->flags & ANYOF_EOS))
 686         cl->flags &= ~ANYOF_EOS;
 687
 688     if (cl->flags & ANYOF_UNICODE_ALL && and_with->flags & ANYOF_UNICODE &&
 689         !(and_with->flags & ANYOF_INVERT)) {
 690         cl->flags &= ~ANYOF_UNICODE_ALL;
 691         cl->flags |= ANYOF_UNICODE;
 692         ARG_SET(cl, ARG(and_with));
 693     }
 694     if (!(and_with->flags & ANYOF_UNICODE_ALL) &&
 695         !(and_with->flags & ANYOF_INVERT))
 696         cl->flags &= ~ANYOF_UNICODE_ALL;
 697     if (!(and_with->flags & (ANYOF_UNICODE|ANYOF_UNICODE_ALL)) &&
 698         !(and_with->flags & ANYOF_INVERT))
 699         cl->flags &= ~ANYOF_UNICODE;
 700 }
 701
 702 /* 'OR' a given class with another one.  Can create false positives */
 703 /* We assume that cl is not inverted */
 704 STATIC void
 705 S_cl_or(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl, const struct regnode_charclass_class *or_with)
 706 {
 707     if (or_with->flags & ANYOF_INVERT) {
 708         /* We do not use
 709          * (B1 | CL1) | (!B2 & !CL2) = (B1 | !B2 & !CL2) | (CL1 | (!B2 & !CL2))
 710          *   <= (B1 | !B2) | (CL1 | !CL2)
 711          * which is wasteful if CL2 is small, but we ignore CL2:
 712          *   (B1 | CL1) | (!B2 & !CL2) <= (B1 | CL1) | !B2 = (B1 | !B2) | CL1
 713          * XXXX Can we handle case-fold?  Unclear:
 714          *   (OK1(i) | OK1(i')) | !(OK1(i) | OK1(i')) =
 715          *   (OK1(i) | OK1(i')) | (!OK1(i) & !OK1(i'))
 716          */
 717         if ( (or_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
 718              && !(or_with->flags & ANYOF_FOLD)
 719              && !(cl->flags & ANYOF_FOLD) ) {
 720             int i;
 721
 722             for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
 723                 cl->bitmap[i] |= ~or_with->bitmap[i];
 724         } /* XXXX: logic is complicated otherwise */
 725         else {
 726             cl_anything(pRExC_state, cl);
 727         }
 728     } else {
 729         /* (B1 | CL1) | (B2 | CL2) = (B1 | B2) | (CL1 | CL2)) */
 730         if ( (or_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
 731              && (!(or_with->flags & ANYOF_FOLD)
 732                  || (cl->flags & ANYOF_FOLD)) ) {
 733             int i;
 734
 735             /* OR char bitmap and class bitmap separately */
 736             for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
 737                 cl->bitmap[i] |= or_with->bitmap[i];
 738             if (or_with->flags & ANYOF_CLASS) {
 739                 for (i = 0; i < ANYOF_CLASSBITMAP_SIZE; i++)
 740                     cl->classflags[i] |= or_with->classflags[i];
 741                 cl->flags |= ANYOF_CLASS;
 742             }
 743         }
 744         else { /* XXXX: logic is complicated, leave it along for a moment. */
 745             cl_anything(pRExC_state, cl);
 746         }
 747     }
 748     if (or_with->flags & ANYOF_EOS)
 749         cl->flags |= ANYOF_EOS;
 750
 751     if (cl->flags & ANYOF_UNICODE && or_with->flags & ANYOF_UNICODE &&
 752         ARG(cl) != ARG(or_with)) {
 753         cl->flags |= ANYOF_UNICODE_ALL;
 754         cl->flags &= ~ANYOF_UNICODE;
 755     }
 756     if (or_with->flags & ANYOF_UNICODE_ALL) {
 757         cl->flags |= ANYOF_UNICODE_ALL;
 758         cl->flags &= ~ANYOF_UNICODE;
 759     }
 760 }
 761
 762 #define TRIE_LIST_ITEM(state,idx) (trie->states[state].trans.list)[ idx ]
 763 #define TRIE_LIST_CUR(state)  ( TRIE_LIST_ITEM( state, 0 ).forid )
 764 #define TRIE_LIST_LEN(state) ( TRIE_LIST_ITEM( state, 0 ).newstate )
 765 #define TRIE_LIST_USED(idx)  ( trie->states[state].trans.list ? (TRIE_LIST_CUR( idx ) - 1) : 0 )
 766
 767
 768 #ifdef DEBUGGING
 769 /*
 770    dump_trie(trie)
 771    dump_trie_interim_list(trie,next_alloc)
 772    dump_trie_interim_table(trie,next_alloc)
 773
 774    These routines dump out a trie in a somewhat readable format.
 775    The _interim_ variants are used for debugging the interim
 776    tables that are used to generate the final compressed
 777    representation which is what dump_trie expects.
 778
 779    Part of the reason for their existance is to provide a form
 780    of documentation as to how the different representations function.
 781
 782 */
 783
 784 /*
 785   dump_trie(trie)
 786   Dumps the final compressed table form of the trie to Perl_debug_log.
 787   Used for debugging make_trie().
 788 */
 789
 790 STATIC void
 791 S_dump_trie(pTHX_ const struct _reg_trie_data *trie,U32 depth)
 792 {
 793     U32 state;
 794     SV *sv=sv_newmortal();
 795     int colwidth= trie->widecharmap ? 6 : 4;
 796     GET_RE_DEBUG_FLAGS_DECL;
 797
 798
 799     PerlIO_printf( Perl_debug_log, "%*sChar : %-6s%-6s%-4s ",
 800         (int)depth * 2 + 2,"",
 801         "Match","Base","Ofs" );
 802
 803     for( state = 0 ; state < trie->uniquecharcount ; state++ ) {
 804         SV ** const tmp = av_fetch( trie->revcharmap, state, 0);
 805         if ( tmp ) {
 806             PerlIO_printf( Perl_debug_log, "%*s",
 807                 colwidth,
 808                 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth,
 809                             PL_colors[0], PL_colors[1],
 810                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
 811                             PERL_PV_ESCAPE_FIRSTCHAR
 812                 )
 813             );
 814         }
 815     }
 816     PerlIO_printf( Perl_debug_log, "\n%*sState|-----------------------",
 817         (int)depth * 2 + 2,"");
 818
 819     for( state = 0 ; state < trie->uniquecharcount ; state++ )
 820         PerlIO_printf( Perl_debug_log, "%.*s", colwidth, "--------");
 821     PerlIO_printf( Perl_debug_log, "\n");
 822
 823     for( state = 1 ; state < trie->laststate ; state++ ) {
 824         const U32 base = trie->states[ state ].trans.base;
 825
 826         PerlIO_printf( Perl_debug_log, "%*s#%4"UVXf"|", (int)depth * 2 + 2,"", (UV)state);
 827
 828         if ( trie->states[ state ].wordnum ) {
 829             PerlIO_printf( Perl_debug_log, " W%4X", trie->states[ state ].wordnum );
 830         } else {
 831             PerlIO_printf( Perl_debug_log, "%6s", "" );
 832         }
 833
 834         PerlIO_printf( Perl_debug_log, " @%4"UVXf" ", (UV)base );
 835
 836         if ( base ) {
 837             U32 ofs = 0;
 838
 839             while( ( base + ofs  < trie->uniquecharcount ) ||
 840                    ( base + ofs - trie->uniquecharcount < trie->lasttrans
 841                      && trie->trans[ base + ofs - trie->uniquecharcount ].check != state))
 842                     ofs++;
 843
 844             PerlIO_printf( Perl_debug_log, "+%2"UVXf"[ ", (UV)ofs);
 845
 846             for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
 847                 if ( ( base + ofs >= trie->uniquecharcount ) &&
 848                      ( base + ofs - trie->uniquecharcount < trie->lasttrans ) &&
 849                      trie->trans[ base + ofs - trie->uniquecharcount ].check == state )
 850                 {
 851                    PerlIO_printf( Perl_debug_log, "%*"UVXf,
 852                     colwidth,
 853                     (UV)trie->trans[ base + ofs - trie->uniquecharcount ].next );
 854                 } else {
 855                     PerlIO_printf( Perl_debug_log, "%*s",colwidth,"   ." );
 856                 }
 857             }
 858
 859             PerlIO_printf( Perl_debug_log, "]");
 860
 861         }
 862         PerlIO_printf( Perl_debug_log, "\n" );
 863     }
 864 }
 865 /*
 866   dump_trie_interim_list(trie,next_alloc)
 867   Dumps a fully constructed but uncompressed trie in list form.
 868   List tries normally only are used for construction when the number of
 869   possible chars (trie->uniquecharcount) is very high.
 870   Used for debugging make_trie().
 871 */
 872 STATIC void
 873 S_dump_trie_interim_list(pTHX_ const struct _reg_trie_data *trie, U32 next_alloc,U32 depth)
 874 {
 875     U32 state;
 876     SV *sv=sv_newmortal();
 877     int colwidth= trie->widecharmap ? 6 : 4;
 878     GET_RE_DEBUG_FLAGS_DECL;
 879     /* print out the table precompression.  */
 880     PerlIO_printf( Perl_debug_log, "%*sState :Word | Transition Data\n%*s%s",
 881         (int)depth * 2 + 2,"", (int)depth * 2 + 2,"",
 882         "------:-----+-----------------\n" );
 883
 884     for( state=1 ; state < next_alloc ; state ++ ) {
 885         U16 charid;
 886
 887         PerlIO_printf( Perl_debug_log, "%*s %4"UVXf" :",
 888             (int)depth * 2 + 2,"", (UV)state  );
 889         if ( ! trie->states[ state ].wordnum ) {
 890             PerlIO_printf( Perl_debug_log, "%5s| ","");
 891         } else {
 892             PerlIO_printf( Perl_debug_log, "W%4x| ",
 893                 trie->states[ state ].wordnum
 894             );
 895         }
 896         for( charid = 1 ; charid <= TRIE_LIST_USED( state ) ; charid++ ) {
 897             SV ** const tmp = av_fetch( trie->revcharmap, TRIE_LIST_ITEM(state,charid).forid, 0);
 898             if ( tmp ) {
 899                 PerlIO_printf( Perl_debug_log, "%*s:%3X=%4"UVXf" | ",
 900                     colwidth,
 901                     pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth,
 902                             PL_colors[0], PL_colors[1],
 903                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
 904                             PERL_PV_ESCAPE_FIRSTCHAR
 905                     ) ,
 906                 TRIE_LIST_ITEM(state,charid).forid,
 907                 (UV)TRIE_LIST_ITEM(state,charid).newstate
 908             );
 909         }
 910         }
 911         PerlIO_printf( Perl_debug_log, "\n");
 912     }
 913 }
 914
 915 /*
 916   dump_trie_interim_table(trie,next_alloc)
 917   Dumps a fully constructed but uncompressed trie in table form.
 918   This is the normal DFA style state transition table, with a few
 919   twists to facilitate compression later.
 920   Used for debugging make_trie().
 921 */
 922 STATIC void
 923 S_dump_trie_interim_table(pTHX_ const struct _reg_trie_data *trie, U32 next_alloc, U32 depth)
 924 {
 925     U32 state;
 926     U16 charid;
 927     SV *sv=sv_newmortal();
 928     int colwidth= trie->widecharmap ? 6 : 4;
 929     GET_RE_DEBUG_FLAGS_DECL;
 930
 931     /*
 932        print out the table precompression so that we can do a visual check
 933        that they are identical.
 934      */
 935
 936     PerlIO_printf( Perl_debug_log, "%*sChar : ",(int)depth * 2 + 2,"" );
 937
 938     for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
 939         SV ** const tmp = av_fetch( trie->revcharmap, charid, 0);
 940         if ( tmp ) {
 941             PerlIO_printf( Perl_debug_log, "%*s",
 942                 colwidth,
 943                 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth,
 944                             PL_colors[0], PL_colors[1],
 945                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
 946                             PERL_PV_ESCAPE_FIRSTCHAR
 947                 )
 948             );
 949         }
 950     }
 951
 952     PerlIO_printf( Perl_debug_log, "\n%*sState+-",(int)depth * 2 + 2,"" );
 953
 954     for( charid=0 ; charid < trie->uniquecharcount ; charid++ ) {
 955         PerlIO_printf( Perl_debug_log, "%.*s", colwidth,"--------");
 956     }
 957
 958     PerlIO_printf( Perl_debug_log, "\n" );
 959
 960     for( state=1 ; state < next_alloc ; state += trie->uniquecharcount ) {
 961
 962         PerlIO_printf( Perl_debug_log, "%*s%4"UVXf" : ",
 963             (int)depth * 2 + 2,"",
 964             (UV)TRIE_NODENUM( state ) );
 965
 966         for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
 967             UV v=(UV)SAFE_TRIE_NODENUM( trie->trans[ state + charid ].next );
 968             if (v)
 969                 PerlIO_printf( Perl_debug_log, "%*"UVXf, colwidth, v );
 970             else
 971                 PerlIO_printf( Perl_debug_log, "%*s", colwidth, "." );
 972         }
 973         if ( ! trie->states[ TRIE_NODENUM( state ) ].wordnum ) {
 974             PerlIO_printf( Perl_debug_log, " (%4"UVXf")\n", (UV)trie->trans[ state ].check );
 975         } else {
 976             PerlIO_printf( Perl_debug_log, " (%4"UVXf") W%4X\n", (UV)trie->trans[ state ].check,
 977             trie->states[ TRIE_NODENUM( state ) ].wordnum );
 978         }
 979     }
 980 }
 981
 982 #endif
 983
 984 /* make_trie(startbranch,first,last,tail,word_count,flags,depth)
 985   startbranch: the first branch in the whole branch sequence
 986   first      : start branch of sequence of branch-exact nodes.
 987                May be the same as startbranch
 988   last       : Thing following the last branch.
 989                May be the same as tail.
 990   tail       : item following the branch sequence
 991   count      : words in the sequence
 992   flags      : currently the OP() type we will be building one of /EXACT(|F|Fl)/
 993   depth      : indent depth
 994
 995 Inplace optimizes a sequence of 2 or more Branch-Exact nodes into a TRIE node.
 996
 997 A trie is an N'ary tree where the branches are determined by digital
 998 decomposition of the key. IE, at the root node you look up the 1st character and
 999 follow that branch repeat until you find the end of the branches. Nodes can be
1000 marked as "accepting" meaning they represent a complete word. Eg:
1001
1002   /he|she|his|hers/
1003
1004 would convert into the following structure. Numbers represent states, letters
1005 following numbers represent valid transitions on the letter from that state, if
1006 the number is in square brackets it represents an accepting state, otherwise it
1007 will be in parenthesis.
1008
1009       +-h->+-e->[3]-+-r->(8)-+-s->[9]
1010       |    |
1011       |   (2)
1012       |    |
1013      (1)   +-i->(6)-+-s->[7]
1014       |
1015       +-s->(3)-+-h->(4)-+-e->[5]
1016
1017       Accept Word Mapping: 3=>1 (he),5=>2 (she), 7=>3 (his), 9=>4 (hers)
1018
1019 This shows that when matching against the string 'hers' we will begin at state 1
1020 read 'h' and move to state 2, read 'e' and move to state 3 which is accepting,
1021 then read 'r' and go to state 8 followed by 's' which takes us to state 9 which
1022 is also accepting. Thus we know that we can match both 'he' and 'hers' with a
1023 single traverse. We store a mapping from accepting to state to which word was
1024 matched, and then when we have multiple possibilities we try to complete the
1025 rest of the regex in the order in which they occured in the alternation.
1026
1027 The only prior NFA like behaviour that would be changed by the TRIE support is
1028 the silent ignoring of duplicate alternations which are of the form:
1029
1030  / (DUPE|DUPE) X? (?{ ... }) Y /x
1031
1032 Thus EVAL blocks follwing a trie may be called a different number of times with
1033 and without the optimisation. With the optimisations dupes will be silently
1034 ignored. This inconsistant behaviour of EVAL type nodes is well established as
1035 the following demonstrates:
1036
1037  'words'=~/(word|word|word)(?{ print $1 })[xyz]/
1038
1039 which prints out 'word' three times, but
1040
1041  'words'=~/(word|word|word)(?{ print $1 })S/
1042
1043 which doesnt print it out at all. This is due to other optimisations kicking in.
1044
1045 Example of what happens on a structural level:
1046
1047 The regexp /(ac|ad|ab)+/ will produce the folowing debug output:
1048
1049    1: CURLYM[1] {1,32767}(18)
1050    5:   BRANCH(8)
1051    6:     EXACT <ac>(16)
1052    8:   BRANCH(11)
1053    9:     EXACT <ad>(16)
1054   11:   BRANCH(14)
1055   12:     EXACT <ab>(16)
1056   16:   SUCCEED(0)
1057   17:   NOTHING(18)
1058   18: END(0)
1059
1060 This would be optimizable with startbranch=5, first=5, last=16, tail=16
1061 and should turn into:
1062
1063    1: CURLYM[1] {1,32767}(18)
1064    5:   TRIE(16)
1065         [Words:3 Chars Stored:6 Unique Chars:4 States:5 NCP:1]
1066           <ac>
1067           <ad>
1068           <ab>
1069   16:   SUCCEED(0)
1070   17:   NOTHING(18)
1071   18: END(0)
1072
1073 Cases where tail != last would be like /(?foo|bar)baz/:
1074
1075    1: BRANCH(4)
1076    2:   EXACT <foo>(8)
1077    4: BRANCH(7)
1078    5:   EXACT <bar>(8)
1079    7: TAIL(8)
1080    8: EXACT <baz>(10)
1081   10: END(0)
1082
1083 which would be optimizable with startbranch=1, first=1, last=7, tail=8
1084 and would end up looking like:
1085
1086     1: TRIE(8)
1087       [Words:2 Chars Stored:6 Unique Chars:5 States:7 NCP:1]
1088         <foo>
1089         <bar>
1090    7: TAIL(8)
1091    8: EXACT <baz>(10)
1092   10: END(0)
1093
1094     d = uvuni_to_utf8_flags(d, uv, 0);
1095
1096 is the recommended Unicode-aware way of saying
1097
1098     *(d++) = uv;
1099 */
1100
1101 #define TRIE_STORE_REVCHAR                                                    \
1102     STMT_START {                                                           \
1103         SV *tmp = Perl_newSVpvf_nocontext( "%c", (int)uvc );               \
1104         if (UTF) SvUTF8_on(tmp);                                           \
1105         av_push( TRIE_REVCHARMAP(trie), tmp );                             \
1106     } STMT_END
1107
1108 #define TRIE_READ_CHAR STMT_START {                                           \
1109     wordlen++;                                                                \
1110     if ( UTF ) {                                                              \
1111         if ( folder ) {                                                       \
1112             if ( foldlen > 0 ) {                                              \
1113                uvc = utf8n_to_uvuni( scan, UTF8_MAXLEN, &len, uniflags );     \
1114                foldlen -= len;                                                \
1115                scan += len;                                                   \
1116                len = 0;                                                       \
1117             } else {                                                          \
1118                 uvc = utf8n_to_uvuni( (const U8*)uc, UTF8_MAXLEN, &len, uniflags);\
1119                 uvc = to_uni_fold( uvc, foldbuf, &foldlen );                  \
1120                 foldlen -= UNISKIP( uvc );                                    \
1121                 scan = foldbuf + UNISKIP( uvc );                              \
1122             }                                                                 \
1123         } else {                                                              \
1124             uvc = utf8n_to_uvuni( (const U8*)uc, UTF8_MAXLEN, &len, uniflags);\
1125         }                                                                     \
1126     } else {                                                                  \
1127         uvc = (U32)*uc;                                                       \
1128         len = 1;                                                              \
1129     }                                                                         \
1130 } STMT_END
1131
1132
1133
1134 #define TRIE_LIST_PUSH(state,fid,ns) STMT_START {               \
1135     if ( TRIE_LIST_CUR( state ) >=TRIE_LIST_LEN( state ) ) {    \
1136         TRIE_LIST_LEN( state ) *= 2;                            \
1137         Renew( trie->states[ state ].trans.list,                \
1138                TRIE_LIST_LEN( state ), reg_trie_trans_le );     \
1139     }                                                           \
1140     TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).forid = fid;     \
1141     TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).newstate = ns;   \
1142     TRIE_LIST_CUR( state )++;                                   \
1143 } STMT_END
1144
1145 #define TRIE_LIST_NEW(state) STMT_START {                       \
1146     Newxz( trie->states[ state ].trans.list,               \
1147         4, reg_trie_trans_le );                                 \
1148      TRIE_LIST_CUR( state ) = 1;                                \
1149      TRIE_LIST_LEN( state ) = 4;                                \
1150 } STMT_END
1151
1152 #define TRIE_HANDLE_WORD(state) STMT_START {                    \
1153     U16 dupe= trie->states[ state ].wordnum;                    \
1154     regnode * const noper_next = regnext( noper );              \
1155                                                                 \
1156     if (trie->wordlen)                                          \
1157         trie->wordlen[ curword ] = wordlen;                     \
1158     DEBUG_r({                                                   \
1159         /* store the word for dumping */                        \
1160         SV* tmp;                                                \
1161         if (OP(noper) != NOTHING)                               \
1162             tmp = newSVpvn(STRING(noper), STR_LEN(noper));      \
1163         else                                                    \
1164             tmp = newSVpvn( "", 0 );                            \
1165         if ( UTF ) SvUTF8_on( tmp );                            \
1166         av_push( trie->words, tmp );                            \
1167     });                                                         \
1168                                                                 \
1169     curword++;                                                  \
1170                                                                 \
1171     if ( noper_next < tail ) {                                  \
1172         if (!trie->jump)                                        \
1173             Newxz( trie->jump, word_count + 1, U16);            \
1174         trie->jump[curword] = (U16)(tail - noper_next);         \
1175         if (!jumper)                                            \
1176             jumper = noper_next;                                \
1177         if (!nextbranch)                                        \
1178             nextbranch= regnext(cur);                           \
1179     }                                                           \
1180                                                                 \
1181     if ( dupe ) {                                               \
1182         /* So it's a dupe. This means we need to maintain a   */\
1183         /* linked-list from the first to the next.            */\
1184         /* we only allocate the nextword buffer when there    */\
1185         /* a dupe, so first time we have to do the allocation */\
1186         if (!trie->nextword)                                    \
1187             Newxz( trie->nextword, word_count + 1, U16);        \
1188         while ( trie->nextword[dupe] )                          \
1189             dupe= trie->nextword[dupe];                         \
1190         trie->nextword[dupe]= curword;                          \
1191     } else {                                                    \
1192         /* we haven't inserted this word yet.                */ \
1193         trie->states[ state ].wordnum = curword;                \
1194     }                                                           \
1195 } STMT_END
1196
1197
1198 #define TRIE_TRANS_STATE(state,base,ucharcount,charid,special)          \
1199      ( ( base + charid >=  ucharcount                                   \
1200          && base + charid < ubound                                      \
1201          && state == trie->trans[ base - ucharcount + charid ].check    \
1202          && trie->trans[ base - ucharcount + charid ].next )            \
1203            ? trie->trans[ base - ucharcount + charid ].next             \
1204            : ( state==1 ? special : 0 )                                 \
1205       )
1206
1207 #define MADE_TRIE       1
1208 #define MADE_JUMP_TRIE  2
1209 #define MADE_EXACT_TRIE 4
1210
1211 STATIC I32
1212 S_make_trie(pTHX_ RExC_state_t *pRExC_state, regnode *startbranch, regnode *first, regnode *last, regnode *tail, U32 word_count, U32 flags, U32 depth)
1213 {
1214     dVAR;
1215     /* first pass, loop through and scan words */
1216     reg_trie_data *trie;
1217     regnode *cur;
1218     const U32 uniflags = UTF8_ALLOW_DEFAULT;
1219     STRLEN len = 0;
1220     UV uvc = 0;
1221     U16 curword = 0;
1222     U32 next_alloc = 0;
1223     regnode *jumper = NULL;
1224     regnode *nextbranch = NULL;
1225     /* we just use folder as a flag in utf8 */
1226     const U8 * const folder = ( flags == EXACTF
1227                        ? PL_fold
1228                        : ( flags == EXACTFL
1229                            ? PL_fold_locale
1230                            : NULL
1231                          )
1232                      );
1233
1234     const U32 data_slot = add_data( pRExC_state, 1, "t" );
1235     SV *re_trie_maxbuff;
1236 #ifndef DEBUGGING
1237     /* these are only used during construction but are useful during
1238      * debugging so we store them in the struct when debugging.
1239      */
1240     STRLEN trie_charcount=0;
1241     AV *trie_revcharmap;
1242 #endif
1243     GET_RE_DEBUG_FLAGS_DECL;
1244 #ifndef DEBUGGING
1245     PERL_UNUSED_ARG(depth);
1246 #endif
1247
1248     Newxz( trie, 1, reg_trie_data );
1249     trie->refcount = 1;
1250     trie->startstate = 1;
1251     trie->wordcount = word_count;
1252     RExC_rx->data->data[ data_slot ] = (void*)trie;
1253     Newxz( trie->charmap, 256, U16 );
1254     if (!(UTF && folder))
1255         Newxz( trie->bitmap, ANYOF_BITMAP_SIZE, char );
1256     DEBUG_r({
1257         trie->words = newAV();
1258     });
1259     TRIE_REVCHARMAP(trie) = newAV();
1260
1261     re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
1262     if (!SvIOK(re_trie_maxbuff)) {
1263         sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
1264     }
1265     DEBUG_OPTIMISE_r({
1266                 PerlIO_printf( Perl_debug_log,
1267                   "%*smake_trie start==%d, first==%d, last==%d, tail==%d depth=%d\n",
1268                   (int)depth * 2 + 2, "",
1269                   REG_NODE_NUM(startbranch),REG_NODE_NUM(first),
1270                   REG_NODE_NUM(last), REG_NODE_NUM(tail),
1271                   (int)depth);
1272     });
1273     /*  -- First loop and Setup --
1274
1275        We first traverse the branches and scan each word to determine if it
1276        contains widechars, and how many unique chars there are, this is
1277        important as we have to build a table with at least as many columns as we
1278        have unique chars.
1279
1280        We use an array of integers to represent the character codes 0..255
1281        (trie->charmap) and we use a an HV* to store unicode characters. We use the
1282        native representation of the character value as the key and IV's for the
1283        coded index.
1284
1285        *TODO* If we keep track of how many times each character is used we can
1286        remap the columns so that the table compression later on is more
1287        efficient in terms of memory by ensuring most common value is in the
1288        middle and the least common are on the outside.  IMO this would be better
1289        than a most to least common mapping as theres a decent chance the most
1290        common letter will share a node with the least common, meaning the node
1291        will not be compressable. With a middle is most common approach the worst
1292        case is when we have the least common nodes twice.
1293
1294      */
1295
1296     for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
1297         regnode * const noper = NEXTOPER( cur );
1298         const U8 *uc = (U8*)STRING( noper );
1299         const U8 * const e  = uc + STR_LEN( noper );
1300         STRLEN foldlen = 0;
1301         U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
1302         const U8 *scan = (U8*)NULL;
1303         U32 wordlen      = 0;         /* required init */
1304         STRLEN chars=0;
1305
1306         if (OP(noper) == NOTHING) {
1307             trie->minlen= 0;
1308             continue;
1309         }
1310         if (trie->bitmap) {
1311             TRIE_BITMAP_SET(trie,*uc);
1312             if ( folder ) TRIE_BITMAP_SET(trie,folder[ *uc ]);
1313         }
1314         for ( ; uc < e ; uc += len ) {
1315             TRIE_CHARCOUNT(trie)++;
1316             TRIE_READ_CHAR;
1317             chars++;
1318             if ( uvc < 256 ) {
1319                 if ( !trie->charmap[ uvc ] ) {
1320                     trie->charmap[ uvc ]=( ++trie->uniquecharcount );
1321                     if ( folder )
1322                         trie->charmap[ folder[ uvc ] ] = trie->charmap[ uvc ];
1323                     TRIE_STORE_REVCHAR;
1324                 }
1325             } else {
1326                 SV** svpp;
1327                 if ( !trie->widecharmap )
1328                     trie->widecharmap = newHV();
1329
1330                 svpp = hv_fetch( trie->widecharmap, (char*)&uvc, sizeof( UV ), 1 );
1331
1332                 if ( !svpp )
1333                     Perl_croak( aTHX_ "error creating/fetching widecharmap entry for 0x%"UVXf, uvc );
1334
1335                 if ( !SvTRUE( *svpp ) ) {
1336                     sv_setiv( *svpp, ++trie->uniquecharcount );
1337                     TRIE_STORE_REVCHAR;
1338                 }
1339             }
1340         }
1341         if( cur == first ) {
1342             trie->minlen=chars;
1343             trie->maxlen=chars;
1344         } else if (chars < trie->minlen) {
1345             trie->minlen=chars;
1346         } else if (chars > trie->maxlen) {
1347             trie->maxlen=chars;
1348         }
1349
1350     } /* end first pass */
1351     DEBUG_TRIE_COMPILE_r(
1352         PerlIO_printf( Perl_debug_log, "%*sTRIE(%s): W:%d C:%d Uq:%d Min:%d Max:%d\n",
1353                 (int)depth * 2 + 2,"",
1354                 ( trie->widecharmap ? "UTF8" : "NATIVE" ), (int)word_count,
1355                 (int)TRIE_CHARCOUNT(trie), trie->uniquecharcount,
1356                 (int)trie->minlen, (int)trie->maxlen )
1357     );
1358     Newxz( trie->wordlen, word_count, U32 );
1359
1360     /*
1361         We now know what we are dealing with in terms of unique chars and
1362         string sizes so we can calculate how much memory a naive
1363         representation using a flat table  will take. If it's over a reasonable
1364         limit (as specified by ${^RE_TRIE_MAXBUF}) we use a more memory
1365         conservative but potentially much slower representation using an array
1366         of lists.
1367
1368         At the end we convert both representations into the same compressed
1369         form that will be used in regexec.c for matching with. The latter
1370         is a form that cannot be used to construct with but has memory
1371         properties similar to the list form and access properties similar
1372         to the table form making it both suitable for fast searches and
1373         small enough that its feasable to store for the duration of a program.
1374
1375         See the comment in the code where the compressed table is produced
1376         inplace from the flat tabe representation for an explanation of how
1377         the compression works.
1378
1379     */
1380
1381
1382     if ( (IV)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1) > SvIV(re_trie_maxbuff) ) {
1383         /*
1384             Second Pass -- Array Of Lists Representation
1385
1386             Each state will be represented by a list of charid:state records
1387             (reg_trie_trans_le) the first such element holds the CUR and LEN
1388             points of the allocated array. (See defines above).
1389
1390             We build the initial structure using the lists, and then convert
1391             it into the compressed table form which allows faster lookups
1392             (but cant be modified once converted).
1393         */
1394
1395         STRLEN transcount = 1;
1396
1397         Newxz( trie->states, TRIE_CHARCOUNT(trie) + 2, reg_trie_state );
1398         TRIE_LIST_NEW(1);
1399         next_alloc = 2;
1400
1401         for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
1402
1403             regnode * const noper = NEXTOPER( cur );
1404             U8 *uc           = (U8*)STRING( noper );
1405             const U8 * const e = uc + STR_LEN( noper );
1406             U32 state        = 1;         /* required init */
1407             U16 charid       = 0;         /* sanity init */
1408             U8 *scan         = (U8*)NULL; /* sanity init */
1409             STRLEN foldlen   = 0;         /* required init */
1410             U32 wordlen      = 0;         /* required init */
1411             U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
1412
1413             if (OP(noper) != NOTHING) {
1414                 for ( ; uc < e ; uc += len ) {
1415
1416                     TRIE_READ_CHAR;
1417
1418                     if ( uvc < 256 ) {
1419                         charid = trie->charmap[ uvc ];
1420                     } else {
1421                         SV** const svpp = hv_fetch( trie->widecharmap, (char*)&uvc, sizeof( UV ), 0);
1422                         if ( !svpp ) {
1423                             charid = 0;
1424                         } else {
1425                             charid=(U16)SvIV( *svpp );
1426                         }
1427                     }
1428                     /* charid is now 0 if we dont know the char read, or nonzero if we do */
1429                     if ( charid ) {
1430
1431                         U16 check;
1432                         U32 newstate = 0;
1433
1434                         charid--;
1435                         if ( !trie->states[ state ].trans.list ) {
1436                             TRIE_LIST_NEW( state );
1437                         }
1438                         for ( check = 1; check <= TRIE_LIST_USED( state ); check++ ) {
1439                             if ( TRIE_LIST_ITEM( state, check ).forid == charid ) {
1440                                 newstate = TRIE_LIST_ITEM( state, check ).newstate;
1441                                 break;
1442                             }
1443                         }
1444                         if ( ! newstate ) {
1445                             newstate = next_alloc++;
1446                             TRIE_LIST_PUSH( state, charid, newstate );
1447                             transcount++;
1448                         }
1449                         state = newstate;
1450                     } else {
1451                         Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %"IVdf, uvc );
1452                     }
1453                 }
1454             }
1455             TRIE_HANDLE_WORD(state);
1456
1457         } /* end second pass */
1458
1459         trie->laststate = next_alloc;
1460         Renew( trie->states, next_alloc, reg_trie_state );
1461
1462         /* and now dump it out before we compress it */
1463         DEBUG_TRIE_COMPILE_MORE_r(
1464             dump_trie_interim_list(trie,next_alloc,depth+1)
1465                     );
1466
1467         Newxz( trie->trans, transcount ,reg_trie_trans );
1468         {
1469             U32 state;
1470             U32 tp = 0;
1471             U32 zp = 0;
1472
1473
1474             for( state=1 ; state < next_alloc ; state ++ ) {
1475                 U32 base=0;
1476
1477                 /*
1478                 DEBUG_TRIE_COMPILE_MORE_r(
1479                     PerlIO_printf( Perl_debug_log, "tp: %d zp: %d ",tp,zp)
1480                 );
1481                 */
1482
1483                 if (trie->states[state].trans.list) {
1484                     U16 minid=TRIE_LIST_ITEM( state, 1).forid;
1485                     U16 maxid=minid;
1486                     U16 idx;
1487
1488                     for( idx = 2 ; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
1489                         const U16 forid = TRIE_LIST_ITEM( state, idx).forid;
1490                         if ( forid < minid ) {
1491                             minid=forid;
1492                         } else if ( forid > maxid ) {
1493                             maxid=forid;
1494                         }
1495                     }
1496                     if ( transcount < tp + maxid - minid + 1) {
1497                         transcount *= 2;
1498                         Renew( trie->trans, transcount, reg_trie_trans );
1499                         Zero( trie->trans + (transcount / 2), transcount / 2 , reg_trie_trans );
1500                     }
1501                     base = trie->uniquecharcount + tp - minid;
1502                     if ( maxid == minid ) {
1503                         U32 set = 0;
1504                         for ( ; zp < tp ; zp++ ) {
1505                             if ( ! trie->trans[ zp ].next ) {
1506                                 base = trie->uniquecharcount + zp - minid;
1507                                 trie->trans[ zp ].next = TRIE_LIST_ITEM( state, 1).newstate;
1508                                 trie->trans[ zp ].check = state;
1509                                 set = 1;
1510                                 break;
1511                             }
1512                         }
1513                         if ( !set ) {
1514                             trie->trans[ tp ].next = TRIE_LIST_ITEM( state, 1).newstate;
1515                             trie->trans[ tp ].check = state;
1516                             tp++;
1517                             zp = tp;
1518                         }
1519                     } else {
1520                         for ( idx=1; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
1521                             const U32 tid = base -  trie->uniquecharcount + TRIE_LIST_ITEM( state, idx ).forid;
1522                             trie->trans[ tid ].next = TRIE_LIST_ITEM( state, idx ).newstate;
1523                             trie->trans[ tid ].check = state;
1524                         }
1525                         tp += ( maxid - minid + 1 );
1526                     }
1527                     Safefree(trie->states[ state ].trans.list);
1528                 }
1529                 /*
1530                 DEBUG_TRIE_COMPILE_MORE_r(
1531                     PerlIO_printf( Perl_debug_log, " base: %d\n",base);
1532                 );
1533                 */
1534                 trie->states[ state ].trans.base=base;
1535             }
1536             trie->lasttrans = tp + 1;
1537         }
1538     } else {
1539         /*
1540            Second Pass -- Flat Table Representation.
1541
1542            we dont use the 0 slot of either trans[] or states[] so we add 1 to each.
1543            We know that we will need Charcount+1 trans at most to store the data
1544            (one row per char at worst case) So we preallocate both structures
1545            assuming worst case.
1546
1547            We then construct the trie using only the .next slots of the entry
1548            structs.
1549
1550            We use the .check field of the first entry of the node  temporarily to
1551            make compression both faster and easier by keeping track of how many non
1552            zero fields are in the node.
1553
1554            Since trans are numbered from 1 any 0 pointer in the table is a FAIL
1555            transition.
1556
1557            There are two terms at use here: state as a TRIE_NODEIDX() which is a
1558            number representing the first entry of the node, and state as a
1559            TRIE_NODENUM() which is the trans number. state 1 is TRIE_NODEIDX(1) and
1560            TRIE_NODENUM(1), state 2 is TRIE_NODEIDX(2) and TRIE_NODENUM(3) if there
1561            are 2 entrys per node. eg:
1562
1563              A B       A B
1564           1. 2 4    1. 3 7
1565           2. 0 3    3. 0 5
1566           3. 0 0    5. 0 0
1567           4. 0 0    7. 0 0
1568
1569            The table is internally in the right hand, idx form. However as we also
1570            have to deal with the states array which is indexed by nodenum we have to
1571            use TRIE_NODENUM() to convert.
1572
1573         */
1574
1575
1576         Newxz( trie->trans, ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1,
1577               reg_trie_trans );
1578         Newxz( trie->states, TRIE_CHARCOUNT(trie) + 2, reg_trie_state );
1579         next_alloc = trie->uniquecharcount + 1;
1580
1581
1582         for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
1583
1584             regnode * const noper   = NEXTOPER( cur );
1585             const U8 *uc     = (U8*)STRING( noper );
1586             const U8 * const e = uc + STR_LEN( noper );
1587
1588             U32 state        = 1;         /* required init */
1589
1590             U16 charid       = 0;         /* sanity init */
1591             U32 accept_state = 0;         /* sanity init */
1592             U8 *scan         = (U8*)NULL; /* sanity init */
1593
1594             STRLEN foldlen   = 0;         /* required init */
1595             U32 wordlen      = 0;         /* required init */
1596             U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
1597
1598             if ( OP(noper) != NOTHING ) {
1599                 for ( ; uc < e ; uc += len ) {
1600
1601                     TRIE_READ_CHAR;
1602
1603                     if ( uvc < 256 ) {
1604                         charid = trie->charmap[ uvc ];
1605                     } else {
1606                         SV* const * const svpp = hv_fetch( trie->widecharmap, (char*)&uvc, sizeof( UV ), 0);
1607                         charid = svpp ? (U16)SvIV(*svpp) : 0;
1608                     }
1609                     if ( charid ) {
1610                         charid--;
1611                         if ( !trie->trans[ state + charid ].next ) {
1612                             trie->trans[ state + charid ].next = next_alloc;
1613                             trie->trans[ state ].check++;
1614                             next_alloc += trie->uniquecharcount;
1615                         }
1616                         state = trie->trans[ state + charid ].next;
1617                     } else {
1618                         Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %"IVdf, uvc );
1619                     }
1620                     /* charid is now 0 if we dont know the char read, or nonzero if we do */
1621                 }
1622             }
1623             accept_state = TRIE_NODENUM( state );
1624             TRIE_HANDLE_WORD(accept_state);
1625
1626         } /* end second pass */
1627
1628         /* and now dump it out before we compress it */
1629         DEBUG_TRIE_COMPILE_MORE_r(
1630             dump_trie_interim_table(trie,next_alloc,depth+1)
1631         );
1632
1633         {
1634         /*
1635            * Inplace compress the table.*
1636
1637            For sparse data sets the table constructed by the trie algorithm will
1638            be mostly 0/FAIL transitions or to put it another way mostly empty.
1639            (Note that leaf nodes will not contain any transitions.)
1640
1641            This algorithm compresses the tables by eliminating most such
1642            transitions, at the cost of a modest bit of extra work during lookup:
1643
1644            - Each states[] entry contains a .base field which indicates the
1645            index in the state[] array wheres its transition data is stored.
1646
1647            - If .base is 0 there are no  valid transitions from that node.
1648
1649            - If .base is nonzero then charid is added to it to find an entry in
1650            the trans array.
1651
1652            -If trans[states[state].base+charid].check!=state then the
1653            transition is taken to be a 0/Fail transition. Thus if there are fail
1654            transitions at the front of the node then the .base offset will point
1655            somewhere inside the previous nodes data (or maybe even into a node
1656            even earlier), but the .check field determines if the transition is
1657            valid.
1658
1659            XXX - wrong maybe?
1660            The following process inplace converts the table to the compressed
1661            table: We first do not compress the root node 1,and mark its all its
1662            .check pointers as 1 and set its .base pointer as 1 as well. This
1663            allows to do a DFA construction from the compressed table later, and
1664            ensures that any .base pointers we calculate later are greater than
1665            0.
1666
1667            - We set 'pos' to indicate the first entry of the second node.
1668
1669            - We then iterate over the columns of the node, finding the first and
1670            last used entry at l and m. We then copy l..m into pos..(pos+m-l),
1671            and set the .check pointers accordingly, and advance pos
1672            appropriately and repreat for the next node. Note that when we copy
1673            the next pointers we have to convert them from the original
1674            NODEIDX form to NODENUM form as the former is not valid post
1675            compression.
1676
1677            - If a node has no transitions used we mark its base as 0 and do not
1678            advance the pos pointer.
1679
1680            - If a node only has one transition we use a second pointer into the
1681            structure to fill in allocated fail transitions from other states.
1682            This pointer is independent of the main pointer and scans forward
1683            looking for null transitions that are allocated to a state. When it
1684            finds one it writes the single transition into the "hole".  If the
1685            pointer doesnt find one the single transition is appended as normal.
1686
1687            - Once compressed we can Renew/realloc the structures to release the
1688            excess space.
1689
1690            See "Table-Compression Methods" in sec 3.9 of the Red Dragon,
1691            specifically Fig 3.47 and the associated pseudocode.
1692
1693            demq
1694         */
1695         const U32 laststate = TRIE_NODENUM( next_alloc );
1696         U32 state, charid;
1697         U32 pos = 0, zp=0;
1698         trie->laststate = laststate;
1699
1700         for ( state = 1 ; state < laststate ; state++ ) {
1701             U8 flag = 0;
1702             const U32 stateidx = TRIE_NODEIDX( state );
1703             const U32 o_used = trie->trans[ stateidx ].check;
1704             U32 used = trie->trans[ stateidx ].check;
1705             trie->trans[ stateidx ].check = 0;
1706
1707             for ( charid = 0 ; used && charid < trie->uniquecharcount ; charid++ ) {
1708                 if ( flag || trie->trans[ stateidx + charid ].next ) {
1709                     if ( trie->trans[ stateidx + charid ].next ) {
1710                         if (o_used == 1) {
1711                             for ( ; zp < pos ; zp++ ) {
1712                                 if ( ! trie->trans[ zp ].next ) {
1713                                     break;
1714                                 }
1715                             }
1716                             trie->states[ state ].trans.base = zp + trie->uniquecharcount - charid ;
1717                             trie->trans[ zp ].next = SAFE_TRIE_NODENUM( trie->trans[ stateidx + charid ].next );
1718                             trie->trans[ zp ].check = state;
1719                             if ( ++zp > pos ) pos = zp;
1720                             break;
1721                         }
1722                         used--;
1723                     }
1724                     if ( !flag ) {
1725                         flag = 1;
1726                         trie->states[ state ].trans.base = pos + trie->uniquecharcount - charid ;
1727                     }
1728                     trie->trans[ pos ].next = SAFE_TRIE_NODENUM( trie->trans[ stateidx + charid ].next );
1729                     trie->trans[ pos ].check = state;
1730                     pos++;
1731                 }
1732             }
1733         }
1734         trie->lasttrans = pos + 1;
1735         Renew( trie->states, laststate + 1, reg_trie_state);
1736         DEBUG_TRIE_COMPILE_MORE_r(
1737                 PerlIO_printf( Perl_debug_log,
1738                     "%*sAlloc: %d Orig: %"IVdf" elements, Final:%"IVdf". Savings of %%%5.2f\n",
1739                     (int)depth * 2 + 2,"",
1740                     (int)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1 ),
1741                     (IV)next_alloc,
1742                     (IV)pos,
1743                     ( ( next_alloc - pos ) * 100 ) / (double)next_alloc );
1744             );
1745
1746         } /* end table compress */
1747     }
1748     /* resize the trans array to remove unused space */
1749     Renew( trie->trans, trie->lasttrans, reg_trie_trans);
1750
1751     /* and now dump out the compressed format */
1752     DEBUG_TRIE_COMPILE_r(
1753         dump_trie(trie,depth+1)
1754     );
1755
1756     {   /* Modify the program and insert the new TRIE node*/
1757         regnode *convert;
1758         U8 nodetype =(U8)(flags & 0xFF);
1759         char *str=NULL;
1760
1761 #ifdef DEBUGGING
1762         regnode *optimize = NULL;
1763         U32 mjd_offset = 0;
1764         U32 mjd_nodelen = 0;
1765 #endif
1766         /*
1767            This means we convert either the first branch or the first Exact,
1768            depending on whether the thing following (in 'last') is a branch
1769            or not and whther first is the startbranch (ie is it a sub part of
1770            the alternation or is it the whole thing.)
1771            Assuming its a sub part we conver the EXACT otherwise we convert
1772            the whole branch sequence, including the first.
1773          */
1774         /* Find the node we are going to overwrite */
1775         if ( first == startbranch && OP( last ) != BRANCH ) {
1776             /* whole branch chain */
1777             convert = first;
1778             DEBUG_r({
1779                 const  regnode *nop = NEXTOPER( convert );
1780                 mjd_offset= Node_Offset((nop));
1781                 mjd_nodelen= Node_Length((nop));
1782             });
1783         } else {
1784             /* branch sub-chain */
1785             convert = NEXTOPER( first );
1786             NEXT_OFF( first ) = (U16)(last - first);
1787             DEBUG_r({
1788                 mjd_offset= Node_Offset((convert));
1789                 mjd_nodelen= Node_Length((convert));
1790             });
1791         }
1792         DEBUG_OPTIMISE_r(
1793             PerlIO_printf(Perl_debug_log, "%*sMJD offset:%"UVuf" MJD length:%"UVuf"\n",
1794                 (int)depth * 2 + 2, "",
1795                 (UV)mjd_offset, (UV)mjd_nodelen)
1796         );
1797
1798         /* But first we check to see if there is a common prefix we can
1799            split out as an EXACT and put in front of the TRIE node.  */
1800         trie->startstate= 1;
1801         if ( trie->bitmap && !trie->widecharmap && !trie->jump  ) {
1802             U32 state;
1803             DEBUG_OPTIMISE_r(
1804                 PerlIO_printf(Perl_debug_log, "%*sLaststate:%"UVuf"\n",
1805                     (int)depth * 2 + 2, "",
1806                     (UV)trie->laststate)
1807             );
1808             for ( state = 1 ; state < trie->laststate-1 ; state++ ) {
1809                 U32 ofs = 0;
1810                 I32 idx = -1;
1811                 U32 count = 0;
1812                 const U32 base = trie->states[ state ].trans.base;
1813
1814                 if ( trie->states[state].wordnum )
1815                         count = 1;
1816
1817                 for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
1818                     if ( ( base + ofs >= trie->uniquecharcount ) &&
1819                          ( base + ofs - trie->uniquecharcount < trie->lasttrans ) &&
1820                          trie->trans[ base + ofs - trie->uniquecharcount ].check == state )
1821                     {
1822                         if ( ++count > 1 ) {
1823                             SV **tmp = av_fetch( TRIE_REVCHARMAP(trie), ofs, 0);
1824                             const U8 *ch = (U8*)SvPV_nolen_const( *tmp );
1825                             if ( state == 1 ) break;
1826                             if ( count == 2 ) {
1827                                 Zero(trie->bitmap, ANYOF_BITMAP_SIZE, char);
1828                                 DEBUG_OPTIMISE_r(
1829                                     PerlIO_printf(Perl_debug_log,
1830                                         "%*sNew Start State=%"UVuf" Class: [",
1831                                         (int)depth * 2 + 2, "",
1832                                         (UV)state));
1833                                 if (idx >= 0) {
1834                                     SV ** const tmp = av_fetch( TRIE_REVCHARMAP(trie), idx, 0);
1835                                     const U8 * const ch = (U8*)SvPV_nolen_const( *tmp );
1836
1837                                     TRIE_BITMAP_SET(trie,*ch);
1838                                     if ( folder )
1839                                         TRIE_BITMAP_SET(trie, folder[ *ch ]);
1840                                     DEBUG_OPTIMISE_r(
1841                                         PerlIO_printf(Perl_debug_log, (char*)ch)
1842                                     );
1843                                 }
1844                             }
1845                             TRIE_BITMAP_SET(trie,*ch);
1846                             if ( folder )
1847                                 TRIE_BITMAP_SET(trie,folder[ *ch ]);
1848                             DEBUG_OPTIMISE_r(PerlIO_printf( Perl_debug_log,"%s", ch));
1849                         }
1850                         idx = ofs;
1851                     }
1852                 }
1853                 if ( count == 1 ) {
1854                     SV **tmp = av_fetch( TRIE_REVCHARMAP(trie), idx, 0);
1855                     const char *ch = SvPV_nolen_const( *tmp );
1856                     DEBUG_OPTIMISE_r(
1857                         PerlIO_printf( Perl_debug_log,
1858                             "%*sPrefix State: %"UVuf" Idx:%"UVuf" Char='%s'\n",
1859                             (int)depth * 2 + 2, "",
1860                             (UV)state, (UV)idx, ch)
1861                     );
1862                     if ( state==1 ) {
1863                         OP( convert ) = nodetype;
1864                         str=STRING(convert);
1865                         STR_LEN(convert)=0;
1866                     }
1867                     *str++=*ch;
1868                     STR_LEN(convert)++;
1869
1870                 } else {
1871 #ifdef DEBUGGING
1872                     if (state>1)
1873                         DEBUG_OPTIMISE_r(PerlIO_printf( Perl_debug_log,"]\n"));
1874 #endif
1875                     break;
1876                 }
1877             }
1878             if (str) {
1879                 regnode *n = convert+NODE_SZ_STR(convert);
1880                 NEXT_OFF(convert) = NODE_SZ_STR(convert);
1881                 trie->startstate = state;
1882                 trie->minlen -= (state - 1);
1883                 trie->maxlen -= (state - 1);
1884                 DEBUG_r({
1885                     regnode *fix = convert;
1886                     mjd_nodelen++;
1887                     Set_Node_Offset_Length(convert, mjd_offset, state - 1);
1888                     while( ++fix < n ) {
1889                         Set_Node_Offset_Length(fix, 0, 0);
1890                     }
1891                 });
1892                 if (trie->maxlen) {
1893                     convert = n;
1894                 } else {
1895                     NEXT_OFF(convert) = (U16)(tail - convert);
1896                     DEBUG_r(optimize= n);
1897                 }
1898             }
1899         }
1900         if (!jumper)
1901             jumper = last;
1902         if ( trie->maxlen ) {
1903             NEXT_OFF( convert ) = (U16)(tail - convert);
1904             ARG_SET( convert, data_slot );
1905             /* Store the offset to the first unabsorbed branch in
1906                jump[0], which is otherwise unused by the jump logic.
1907                We use this when dumping a trie and during optimisation. */
1908             if (trie->jump)
1909                 trie->jump[0] = (U16)(tail - nextbranch);
1910
1911             /* XXXX */
1912             if ( !trie->states[trie->startstate].wordnum && trie->bitmap &&
1913                  ( (char *)jumper - (char *)convert) >= (int)sizeof(struct regnode_charclass) )
1914             {
1915                 OP( convert ) = TRIEC;
1916                 Copy(trie->bitmap, ((struct regnode_charclass *)convert)->bitmap, ANYOF_BITMAP_SIZE, char);
1917                 Safefree(trie->bitmap);
1918                 trie->bitmap= NULL;
1919             } else
1920                 OP( convert ) = TRIE;
1921
1922             /* store the type in the flags */
1923             convert->flags = nodetype;
1924             DEBUG_r({
1925             optimize = convert
1926                       + NODE_STEP_REGNODE
1927                       + regarglen[ OP( convert ) ];
1928             });
1929             /* XXX We really should free up the resource in trie now,
1930                    as we won't use them - (which resources?) dmq */
1931         }
1932         /* needed for dumping*/
1933         DEBUG_r(if (optimize) {
1934             regnode *opt = convert;
1935             while ( ++opt < optimize) {
1936                 Set_Node_Offset_Length(opt,0,0);
1937             }
1938             /*
1939                 Try to clean up some of the debris left after the
1940                 optimisation.
1941              */
1942             while( optimize < jumper ) {
1943                 mjd_nodelen += Node_Length((optimize));
1944                 OP( optimize ) = OPTIMIZED;
1945                 Set_Node_Offset_Length(optimize,0,0);
1946                 optimize++;
1947             }
1948             Set_Node_Offset_Length(convert,mjd_offset,mjd_nodelen);
1949         });
1950     } /* end node insert */
1951 #ifndef DEBUGGING
1952     SvREFCNT_dec(TRIE_REVCHARMAP(trie));
1953 #endif
1954     return trie->jump
1955            ? MADE_JUMP_TRIE
1956            : trie->startstate>1
1957              ? MADE_EXACT_TRIE
1958              : MADE_TRIE;
1959 }
1960
1961 STATIC void
1962 S_make_trie_failtable(pTHX_ RExC_state_t *pRExC_state, regnode *source,  regnode *stclass, U32 depth)
1963 {
1964 /* The Trie is constructed and compressed now so we can build a fail array now if its needed
1965
1966    This is basically the Aho-Corasick algorithm. Its from exercise 3.31 and 3.32 in the
1967    "Red Dragon" -- Compilers, principles, techniques, and tools. Aho, Sethi, Ullman 1985/88
1968    ISBN 0-201-10088-6
1969
1970    We find the fail state for each state in the trie, this state is the longest proper
1971    suffix of the current states 'word' that is also a proper prefix of another word in our
1972    trie. State 1 represents the word '' and is the thus the default fail state. This allows
1973    the DFA not to have to restart after its tried and failed a word at a given point, it
1974    simply continues as though it had been matching the other word in the first place.
1975    Consider
1976       'abcdgu'=~/abcdefg|cdgu/
1977    When we get to 'd' we are still matching the first word, we would encounter 'g' which would
1978    fail, which would bring use to the state representing 'd' in the second word where we would
1979    try 'g' and succeed, prodceding to match 'cdgu'.
1980  */
1981  /* add a fail transition */
1982     reg_trie_data *trie=(reg_trie_data *)RExC_rx->data->data[ARG(source)];
1983     U32 *q;
1984     const U32 ucharcount = trie->uniquecharcount;
1985     const U32 numstates = trie->laststate;
1986     const U32 ubound = trie->lasttrans + ucharcount;
1987     U32 q_read = 0;
1988     U32 q_write = 0;
1989     U32 charid;
1990     U32 base = trie->states[ 1 ].trans.base;
1991     U32 *fail;
1992     reg_ac_data *aho;
1993     const U32 data_slot = add_data( pRExC_state, 1, "T" );
1994     GET_RE_DEBUG_FLAGS_DECL;
1995 #ifndef DEBUGGING
1996     PERL_UNUSED_ARG(depth);
1997 #endif
1998
1999
2000     ARG_SET( stclass, data_slot );
2001     Newxz( aho, 1, reg_ac_data );
2002     RExC_rx->data->data[ data_slot ] = (void*)aho;
2003     aho->trie=trie;
2004     aho->states=(reg_trie_state *)savepvn((const char*)trie->states,
2005         (trie->laststate+1)*sizeof(reg_trie_state));
2006     Newxz( q, numstates, U32);
2007     Newxz( aho->fail, numstates, U32 );
2008     aho->refcount = 1;
2009     fail = aho->fail;
2010     /* initialize fail[0..1] to be 1 so that we always have
2011        a valid final fail state */
2012     fail[ 0 ] = fail[ 1 ] = 1;
2013
2014     for ( charid = 0; charid < ucharcount ; charid++ ) {
2015         const U32 newstate = TRIE_TRANS_STATE( 1, base, ucharcount, charid, 0 );
2016         if ( newstate ) {
2017             q[ q_write ] = newstate;
2018             /* set to point at the root */
2019             fail[ q[ q_write++ ] ]=1;
2020         }
2021     }
2022     while ( q_read < q_write) {
2023         const U32 cur = q[ q_read++ % numstates ];
2024         base = trie->states[ cur ].trans.base;
2025
2026         for ( charid = 0 ; charid < ucharcount ; charid++ ) {
2027             const U32 ch_state = TRIE_TRANS_STATE( cur, base, ucharcount, charid, 1 );
2028             if (ch_state) {
2029                 U32 fail_state = cur;
2030                 U32 fail_base;
2031                 do {
2032                     fail_state = fail[ fail_state ];
2033                     fail_base = aho->states[ fail_state ].trans.base;
2034                 } while ( !TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 ) );
2035
2036                 fail_state = TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 );
2037                 fail[ ch_state ] = fail_state;
2038                 if ( !aho->states[ ch_state ].wordnum && aho->states[ fail_state ].wordnum )
2039                 {
2040                         aho->states[ ch_state ].wordnum =  aho->states[ fail_state ].wordnum;
2041                 }
2042                 q[ q_write++ % numstates] = ch_state;
2043             }
2044         }
2045     }
2046     /* restore fail[0..1] to 0 so that we "fall out" of the AC loop
2047        when we fail in state 1, this allows us to use the
2048        charclass scan to find a valid start char. This is based on the principle
2049        that theres a good chance the string being searched contains lots of stuff
2050        that cant be a start char.
2051      */
2052     fail[ 0 ] = fail[ 1 ] = 0;
2053     DEBUG_TRIE_COMPILE_r({
2054         PerlIO_printf(Perl_debug_log, "%*sStclass Failtable: 0", (int)(depth * 2), "");
2055         for( q_read=1; q_read<numstates; q_read++ ) {
2056             PerlIO_printf(Perl_debug_log, ", %"UVuf, (UV)fail[q_read]);
2057         }
2058         PerlIO_printf(Perl_debug_log, "\n");
2059     });
2060     Safefree(q);
2061     /*RExC_seen |= REG_SEEN_TRIEDFA;*/
2062 }
2063
2064
2065 /*
2066  * There are strange code-generation bugs caused on sparc64 by gcc-2.95.2.
2067  * These need to be revisited when a newer toolchain becomes available.
2068  */
2069 #if defined(__sparc64__) && defined(__GNUC__)
2070 #   if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 96)
2071 #       undef  SPARC64_GCC_WORKAROUND
2072 #       define SPARC64_GCC_WORKAROUND 1
2073 #   endif
2074 #endif
2075
2076 #define DEBUG_PEEP(str,scan,depth) \
2077     DEBUG_OPTIMISE_r({ \
2078        SV * const mysv=sv_newmortal(); \
2079        regnode *Next = regnext(scan); \
2080        regprop(RExC_rx, mysv, scan); \
2081        PerlIO_printf(Perl_debug_log, "%*s" str ">%3d: %s [%d]\n", \
2082        (int)depth*2, "", REG_NODE_NUM(scan), SvPV_nolen_const(mysv),\
2083        Next ? (REG_NODE_NUM(Next)) : 0 ); \
2084    });
2085
2086
2087
2088
2089
2090 #define JOIN_EXACT(scan,min,flags) \
2091     if (PL_regkind[OP(scan)] == EXACT) \
2092         join_exact(pRExC_state,(scan),(min),(flags),NULL,depth+1)
2093
2094 STATIC U32
2095 S_join_exact(pTHX_ RExC_state_t *pRExC_state, regnode *scan, I32 *min, U32 flags,regnode *val, U32 depth) {
2096     /* Merge several consecutive EXACTish nodes into one. */
2097     regnode *n = regnext(scan);
2098     U32 stringok = 1;
2099     regnode *next = scan + NODE_SZ_STR(scan);
2100     U32 merged = 0;
2101     U32 stopnow = 0;
2102 #ifdef DEBUGGING
2103     regnode *stop = scan;
2104     GET_RE_DEBUG_FLAGS_DECL;
2105 #else
2106     PERL_UNUSED_ARG(depth);
2107 #endif
2108 #ifndef EXPERIMENTAL_INPLACESCAN
2109     PERL_UNUSED_ARG(flags);
2110     PERL_UNUSED_ARG(val);
2111 #endif
2112     DEBUG_PEEP("join",scan,depth);
2113
2114     /* Skip NOTHING, merge EXACT*. */
2115     while (n &&
2116            ( PL_regkind[OP(n)] == NOTHING ||
2117              (stringok && (OP(n) == OP(scan))))
2118            && NEXT_OFF(n)
2119            && NEXT_OFF(scan) + NEXT_OFF(n) < I16_MAX) {
2120
2121         if (OP(n) == TAIL || n > next)
2122             stringok = 0;
2123         if (PL_regkind[OP(n)] == NOTHING) {
2124             DEBUG_PEEP("skip:",n,depth);
2125             NEXT_OFF(scan) += NEXT_OFF(n);
2126             next = n + NODE_STEP_REGNODE;
2127 #ifdef DEBUGGING
2128             if (stringok)
2129                 stop = n;
2130 #endif
2131             n = regnext(n);
2132         }
2133         else if (stringok) {
2134             const unsigned int oldl = STR_LEN(scan);
2135             regnode * const nnext = regnext(n);
2136
2137             DEBUG_PEEP("merg",n,depth);
2138
2139             merged++;
2140             if (oldl + STR_LEN(n) > U8_MAX)
2141                 break;
2142             NEXT_OFF(scan) += NEXT_OFF(n);
2143             STR_LEN(scan) += STR_LEN(n);
2144             next = n + NODE_SZ_STR(n);
2145             /* Now we can overwrite *n : */
2146             Move(STRING(n), STRING(scan) + oldl, STR_LEN(n), char);
2147 #ifdef DEBUGGING
2148             stop = next - 1;
2149 #endif
2150             n = nnext;
2151             if (stopnow) break;
2152         }
2153
2154 #ifdef EXPERIMENTAL_INPLACESCAN
2155         if (flags && !NEXT_OFF(n)) {
2156             DEBUG_PEEP("atch", val, depth);
2157             if (reg_off_by_arg[OP(n)]) {
2158                 ARG_SET(n, val - n);
2159             }
2160             else {
2161                 NEXT_OFF(n) = val - n;
2162             }
2163             stopnow = 1;
2164         }
2165 #endif
2166     }
2167
2168     if (UTF && ( OP(scan) == EXACTF ) && ( STR_LEN(scan) >= 6 ) ) {
2169     /*
2170     Two problematic code points in Unicode casefolding of EXACT nodes:
2171
2172     U+0390 - GREEK SMALL LETTER IOTA WITH DIALYTIKA AND TONOS
2173     U+03B0 - GREEK SMALL LETTER UPSILON WITH DIALYTIKA AND TONOS
2174
2175     which casefold to
2176
2177     Unicode                      UTF-8
2178
2179     U+03B9 U+0308 U+0301         0xCE 0xB9 0xCC 0x88 0xCC 0x81
2180     U+03C5 U+0308 U+0301         0xCF 0x85 0xCC 0x88 0xCC 0x81
2181
2182     This means that in case-insensitive matching (or "loose matching",
2183     as Unicode calls it), an EXACTF of length six (the UTF-8 encoded byte
2184     length of the above casefolded versions) can match a target string
2185     of length two (the byte length of UTF-8 encoded U+0390 or U+03B0).
2186     This would rather mess up the minimum length computation.
2187
2188     What we'll do is to look for the tail four bytes, and then peek
2189     at the preceding two bytes to see whether we need to decrease
2190     the minimum length by four (six minus two).
2191
2192     Thanks to the design of UTF-8, there cannot be false matches:
2193     A sequence of valid UTF-8 bytes cannot be a subsequence of
2194     another valid sequence of UTF-8 bytes.
2195
2196     */
2197          char * const s0 = STRING(scan), *s, *t;
2198          char * const s1 = s0 + STR_LEN(scan) - 1;
2199          char * const s2 = s1 - 4;
2200 #ifdef EBCDIC /* RD tunifold greek 0390 and 03B0 */
2201          const char t0[] = "\xaf\x49\xaf\x42";
2202 #else
2203          const char t0[] = "\xcc\x88\xcc\x81";
2204 #endif
2205          const char * const t1 = t0 + 3;
2206
2207          for (s = s0 + 2;
2208               s < s2 && (t = ninstr(s, s1, t0, t1));
2209               s = t + 4) {
2210 #ifdef EBCDIC
2211               if (((U8)t[-1] == 0x68 && (U8)t[-2] == 0xB4) ||
2212                   ((U8)t[-1] == 0x46 && (U8)t[-2] == 0xB5))
2213 #else
2214               if (((U8)t[-1] == 0xB9 && (U8)t[-2] == 0xCE) ||
2215                   ((U8)t[-1] == 0x85 && (U8)t[-2] == 0xCF))
2216 #endif
2217                    *min -= 4;
2218          }
2219     }
2220
2221 #ifdef DEBUGGING
2222     /* Allow dumping */
2223     n = scan + NODE_SZ_STR(scan);
2224     while (n <= stop) {
2225         if (PL_regkind[OP(n)] != NOTHING || OP(n) == NOTHING) {
2226             OP(n) = OPTIMIZED;
2227             NEXT_OFF(n) = 0;
2228         }
2229         n++;
2230     }
2231 #endif
2232     DEBUG_OPTIMISE_r(if (merged){DEBUG_PEEP("finl",scan,depth)});
2233     return stopnow;
2234 }
2235
2236 /* REx optimizer.  Converts nodes into quickier variants "in place".
2237    Finds fixed substrings.  */
2238
2239 /* Stops at toplevel WHILEM as well as at "last". At end *scanp is set
2240    to the position after last scanned or to NULL. */
2241
2242
2243
2244 STATIC I32
2245 S_study_chunk(pTHX_ RExC_state_t *pRExC_state, regnode **scanp,
2246                         I32 *minlenp, I32 *deltap,
2247                         regnode *last, scan_data_t *data, U32 flags, U32 depth)
2248                         /* scanp: Start here (read-write). */
2249                         /* deltap: Write maxlen-minlen here. */
2250                         /* last: Stop before this one. */
2251 {
2252     dVAR;
2253     I32 min = 0, pars = 0, code;
2254     regnode *scan = *scanp, *next;
2255     I32 delta = 0;
2256     int is_inf = (flags & SCF_DO_SUBSTR) && (data->flags & SF_IS_INF);
2257     int is_inf_internal = 0;            /* The studied chunk is infinite */
2258     I32 is_par = OP(scan) == OPEN ? ARG(scan) : 0;
2259     scan_data_t data_fake;
2260     struct regnode_charclass_class and_with; /* Valid if flags & SCF_DO_STCLASS_OR */
2261     SV *re_trie_maxbuff = NULL;
2262     regnode *first_non_open = scan;
2263
2264
2265     GET_RE_DEBUG_FLAGS_DECL;
2266 #ifdef DEBUGGING
2267     StructCopy(&zero_scan_data, &data_fake, scan_data_t);
2268 #endif
2269     if ( depth == 0 ) {
2270         while (first_non_open && OP(first_non_open) == OPEN)
2271             first_non_open=regnext(first_non_open);
2272     }
2273
2274
2275     while (scan && OP(scan) != END && scan < last) {
2276         /* Peephole optimizer: */
2277         DEBUG_STUDYDATA(data,depth);
2278         DEBUG_PEEP("Peep",scan,depth);
2279         JOIN_EXACT(scan,&min,0);
2280
2281         /* Follow the next-chain of the current node and optimize
2282            away all the NOTHINGs from it.  */
2283         if (OP(scan) != CURLYX) {
2284             const int max = (reg_off_by_arg[OP(scan)]
2285                        ? I32_MAX
2286                        /* I32 may be smaller than U16 on CRAYs! */
2287                        : (I32_MAX < U16_MAX ? I32_MAX : U16_MAX));
2288             int off = (reg_off_by_arg[OP(scan)] ? ARG(scan) : NEXT_OFF(scan));
2289             int noff;
2290             regnode *n = scan;
2291
2292             /* Skip NOTHING and LONGJMP. */
2293             while ((n = regnext(n))
2294                    && ((PL_regkind[OP(n)] == NOTHING && (noff = NEXT_OFF(n)))
2295                        || ((OP(n) == LONGJMP) && (noff = ARG(n))))
2296                    && off + noff < max)
2297                 off += noff;
2298             if (reg_off_by_arg[OP(scan)])
2299                 ARG(scan) = off;
2300             else
2301                 NEXT_OFF(scan) = off;
2302         }
2303
2304
2305
2306         /* The principal pseudo-switch.  Cannot be a switch, since we
2307            look into several different things.  */
2308         if (OP(scan) == BRANCH || OP(scan) == BRANCHJ
2309                    || OP(scan) == IFTHEN || OP(scan) == SUSPEND) {
2310             next = regnext(scan);
2311             code = OP(scan);
2312             /* demq: the op(next)==code check is to see if we have "branch-branch" AFAICT */
2313
2314             if (OP(next) == code || code == IFTHEN || code == SUSPEND) {
2315                 /* NOTE - There is similar code to this block below for handling
2316                    TRIE nodes on a re-study.  If you change stuff here check there
2317                    too. */
2318                 I32 max1 = 0, min1 = I32_MAX, num = 0;
2319                 struct regnode_charclass_class accum;
2320                 regnode * const startbranch=scan;
2321
2322                 if (flags & SCF_DO_SUBSTR) /* XXXX Add !SUSPEND? */
2323                     scan_commit(pRExC_state, data, minlenp); /* Cannot merge strings after this. */
2324                 if (flags & SCF_DO_STCLASS)
2325                     cl_init_zero(pRExC_state, &accum);
2326
2327                 while (OP(scan) == code) {
2328                     I32 deltanext, minnext, f = 0, fake;
2329                     struct regnode_charclass_class this_class;
2330
2331                     num++;
2332                     data_fake.flags = 0;
2333                     if (data) {
2334                         data_fake.whilem_c = data->whilem_c;
2335                         data_fake.last_closep = data->last_closep;
2336                     }
2337                     else
2338                         data_fake.last_closep = &fake;
2339                     next = regnext(scan);
2340                     scan = NEXTOPER(scan);
2341                     if (code != BRANCH)
2342                         scan = NEXTOPER(scan);
2343                     if (flags & SCF_DO_STCLASS) {
2344                         cl_init(pRExC_state, &this_class);
2345                         data_fake.start_class = &this_class;
2346                         f = SCF_DO_STCLASS_AND;
2347                     }
2348                     if (flags & SCF_WHILEM_VISITED_POS)
2349                         f |= SCF_WHILEM_VISITED_POS;
2350
2351                     /* we suppose the run is continuous, last=next...*/
2352                     minnext = study_chunk(pRExC_state, &scan, minlenp, &deltanext,
2353                                           next, &data_fake, f,depth+1);
2354                     if (min1 > minnext)
2355                         min1 = minnext;
2356                     if (max1 < minnext + deltanext)
2357                         max1 = minnext + deltanext;
2358                     if (deltanext == I32_MAX)
2359                         is_inf = is_inf_internal = 1;
2360                     scan = next;
2361                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
2362                         pars++;
2363                     if (data) {
2364                         if (data_fake.flags & SF_HAS_EVAL)
2365                             data->flags |= SF_HAS_EVAL;
2366                         data->whilem_c = data_fake.whilem_c;
2367                     }
2368                     if (flags & SCF_DO_STCLASS)
2369                         cl_or(pRExC_state, &accum, &this_class);
2370                     if (code == SUSPEND)
2371                         break;
2372                 }
2373                 if (code == IFTHEN && num < 2) /* Empty ELSE branch */
2374                     min1 = 0;
2375                 if (flags & SCF_DO_SUBSTR) {
2376                     data->pos_min += min1;
2377                     data->pos_delta += max1 - min1;
2378                     if (max1 != min1 || is_inf)
2379                         data->longest = &(data->longest_float);
2380                 }
2381                 min += min1;
2382                 delta += max1 - min1;
2383                 if (flags & SCF_DO_STCLASS_OR) {
2384                     cl_or(pRExC_state, data->start_class, &accum);
2385                     if (min1) {
2386                         cl_and(data->start_class, &and_with);
2387                         flags &= ~SCF_DO_STCLASS;
2388                     }
2389                 }
2390                 else if (flags & SCF_DO_STCLASS_AND) {
2391                     if (min1) {
2392                         cl_and(data->start_class, &accum);
2393                         flags &= ~SCF_DO_STCLASS;
2394                     }
2395                     else {
2396                         /* Switch to OR mode: cache the old value of
2397                          * data->start_class */
2398                         StructCopy(data->start_class, &and_with,
2399                                    struct regnode_charclass_class);
2400                         flags &= ~SCF_DO_STCLASS_AND;
2401                         StructCopy(&accum, data->start_class,
2402                                    struct regnode_charclass_class);
2403                         flags |= SCF_DO_STCLASS_OR;
2404                         data->start_class->flags |= ANYOF_EOS;
2405                     }
2406                 }
2407
2408                 if (PERL_ENABLE_TRIE_OPTIMISATION && OP( startbranch ) == BRANCH ) {
2409                 /* demq.
2410
2411                    Assuming this was/is a branch we are dealing with: 'scan' now
2412                    points at the item that follows the branch sequence, whatever
2413                    it is. We now start at the beginning of the sequence and look
2414                    for subsequences of
2415
2416                    BRANCH->EXACT=>x1
2417                    BRANCH->EXACT=>x2
2418                    tail
2419
2420                    which would be constructed from a pattern like /A|LIST|OF|WORDS/
2421
2422                    If we can find such a subseqence we need to turn the first
2423                    element into a trie and then add the subsequent branch exact
2424                    strings to the trie.
2425
2426                    We have two cases
2427
2428                      1. patterns where the whole set of branch can be converted.
2429
2430                      2. patterns where only a subset can be converted.
2431
2432                    In case 1 we can replace the whole set with a single regop
2433                    for the trie. In case 2 we need to keep the start and end
2434                    branchs so
2435
2436                      'BRANCH EXACT; BRANCH EXACT; BRANCH X'
2437                      becomes BRANCH TRIE; BRANCH X;
2438
2439                   There is an additional case, that being where there is a
2440                   common prefix, which gets split out into an EXACT like node
2441                   preceding the TRIE node.
2442
2443                   If x(1..n)==tail then we can do a simple trie, if not we make
2444                   a "jump" trie, such that when we match the appropriate word
2445                   we "jump" to the appopriate tail node. Essentailly we turn
2446                   a nested if into a case structure of sorts.
2447
2448                 */
2449
2450                     int made=0;
2451                     if (!re_trie_maxbuff) {
2452                         re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
2453                         if (!SvIOK(re_trie_maxbuff))
2454                             sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
2455                     }
2456                     if ( SvIV(re_trie_maxbuff)>=0  ) {
2457                         regnode *cur;
2458                         regnode *first = (regnode *)NULL;
2459                         regnode *last = (regnode *)NULL;
2460                         regnode *tail = scan;
2461                         U8 optype = 0;
2462                         U32 count=0;
2463
2464 #ifdef DEBUGGING
2465                         SV * const mysv = sv_newmortal();       /* for dumping */
2466 #endif
2467                         /* var tail is used because there may be a TAIL
2468                            regop in the way. Ie, the exacts will point to the
2469                            thing following the TAIL, but the last branch will
2470                            point at the TAIL. So we advance tail. If we
2471                            have nested (?:) we may have to move through several
2472                            tails.
2473                          */
2474
2475                         while ( OP( tail ) == TAIL ) {
2476                             /* this is the TAIL generated by (?:) */
2477                             tail = regnext( tail );
2478                         }
2479
2480
2481                         DEBUG_OPTIMISE_r({
2482                             regprop(RExC_rx, mysv, tail );
2483                             PerlIO_printf( Perl_debug_log, "%*s%s%s\n",
2484                                 (int)depth * 2 + 2, "",
2485                                 "Looking for TRIE'able sequences. Tail node is: ",
2486                                 SvPV_nolen_const( mysv )
2487                             );
2488                         });
2489
2490                         /*
2491
2492                            step through the branches, cur represents each
2493                            branch, noper is the first thing to be matched
2494                            as part of that branch and noper_next is the
2495                            regnext() of that node. if noper is an EXACT
2496                            and noper_next is the same as scan (our current
2497                            position in the regex) then the EXACT branch is
2498                            a possible optimization target. Once we have
2499                            two or more consequetive such branches we can
2500                            create a trie of the EXACT's contents and stich
2501                            it in place. If the sequence represents all of
2502                            the branches we eliminate the whole thing and
2503                            replace it with a single TRIE. If it is a
2504                            subsequence then we need to stitch it in. This
2505                            means the first branch has to remain, and needs
2506                            to be repointed at the item on the branch chain
2507                            following the last branch optimized. This could
2508                            be either a BRANCH, in which case the
2509                            subsequence is internal, or it could be the
2510                            item following the branch sequence in which
2511                            case the subsequence is at the end.
2512
2513                         */
2514
2515                         /* dont use tail as the end marker for this traverse */
2516                         for ( cur = startbranch ; cur != scan ; cur = regnext( cur ) ) {
2517                             regnode * const noper = NEXTOPER( cur );
2518 #if defined(DEBUGGING) || defined(NOJUMPTRIE)
2519                             regnode * const noper_next = regnext( noper );
2520 #endif
2521
2522                             DEBUG_OPTIMISE_r({
2523                                 regprop(RExC_rx, mysv, cur);
2524                                 PerlIO_printf( Perl_debug_log, "%*s- %s (%d)",
2525                                    (int)depth * 2 + 2,"", SvPV_nolen_const( mysv ), REG_NODE_NUM(cur) );
2526
2527                                 regprop(RExC_rx, mysv, noper);
2528                                 PerlIO_printf( Perl_debug_log, " -> %s",
2529                                     SvPV_nolen_const(mysv));
2530
2531                                 if ( noper_next ) {
2532                                   regprop(RExC_rx, mysv, noper_next );
2533                                   PerlIO_printf( Perl_debug_log,"\t=> %s\t",
2534                                     SvPV_nolen_const(mysv));
2535                                 }
2536                                 PerlIO_printf( Perl_debug_log, "(First==%d,Last==%d,Cur==%d)\n",
2537                                    REG_NODE_NUM(first), REG_NODE_NUM(last), REG_NODE_NUM(cur) );
2538                             });
2539                             if ( (((first && optype!=NOTHING) ? OP( noper ) == optype
2540                                          : PL_regkind[ OP( noper ) ] == EXACT )
2541                                   || OP(noper) == NOTHING )
2542 #ifdef NOJUMPTRIE
2543                                   && noper_next == tail
2544 #endif
2545                                   && count < U16_MAX)
2546                             {
2547                                 count++;
2548                                 if ( !first || optype == NOTHING ) {
2549                                     if (!first) first = cur;
2550                                     optype = OP( noper );
2551                                 } else {
2552                                     last = cur;
2553                                 }
2554                             } else {
2555                                 if ( last ) {
2556                                     make_trie( pRExC_state,
2557                                             startbranch, first, cur, tail, count,
2558                                             optype, depth+1 );
2559                                 }
2560                                 if ( PL_regkind[ OP( noper ) ] == EXACT
2561 #ifdef NOJUMPTRIE
2562                                      && noper_next == tail
2563 #endif
2564                                 ){
2565                                     count = 1;
2566                                     first = cur;
2567                                     optype = OP( noper );
2568                                 } else {
2569                                     count = 0;
2570                                     first = NULL;
2571                                     optype = 0;
2572                                 }
2573                                 last = NULL;
2574                             }
2575                         }
2576                         DEBUG_OPTIMISE_r({
2577                             regprop(RExC_rx, mysv, cur);
2578                             PerlIO_printf( Perl_debug_log,
2579                               "%*s- %s (%d) <SCAN FINISHED>\n", (int)depth * 2 + 2,
2580                               "", SvPV_nolen_const( mysv ),REG_NODE_NUM(cur));
2581
2582                         });
2583                         if ( last ) {
2584                             made= make_trie( pRExC_state, startbranch, first, scan, tail, count, optype, depth+1 );
2585 #ifdef TRIE_STUDY_OPT
2586                             if ( ((made == MADE_EXACT_TRIE &&
2587                                  startbranch == first)
2588                                  || ( first_non_open == first )) &&
2589                                  depth==0 )
2590                                 flags |= SCF_TRIE_RESTUDY;
2591 #endif
2592                         }
2593                     }
2594
2595                 } /* do trie */
2596
2597             }
2598             else if ( code == BRANCHJ ) {  /* single branch is optimized. */
2599                 scan = NEXTOPER(NEXTOPER(scan));
2600             } else                      /* single branch is optimized. */
2601                 scan = NEXTOPER(scan);
2602             continue;
2603         }
2604         else if (OP(scan) == EXACT) {
2605             I32 l = STR_LEN(scan);
2606             UV uc;
2607             if (UTF) {
2608                 const U8 * const s = (U8*)STRING(scan);
2609                 l = utf8_length(s, s + l);
2610                 uc = utf8_to_uvchr(s, NULL);
2611             } else {
2612                 uc = *((U8*)STRING(scan));
2613             }
2614             min += l;
2615             if (flags & SCF_DO_SUBSTR) { /* Update longest substr. */
2616                 /* The code below prefers earlier match for fixed
2617                    offset, later match for variable offset.  */
2618                 if (data->last_end == -1) { /* Update the start info. */
2619                     data->last_start_min = data->pos_min;
2620                     data->last_start_max = is_inf
2621                         ? I32_MAX : data->pos_min + data->pos_delta;
2622                 }
2623                 sv_catpvn(data->last_found, STRING(scan), STR_LEN(scan));
2624                 if (UTF)
2625                     SvUTF8_on(data->last_found);
2626                 {
2627                     SV * const sv = data->last_found;
2628                     MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
2629                         mg_find(sv, PERL_MAGIC_utf8) : NULL;
2630                     if (mg && mg->mg_len >= 0)
2631                         mg->mg_len += utf8_length((U8*)STRING(scan),
2632                                                   (U8*)STRING(scan)+STR_LEN(scan));
2633                 }
2634                 data->last_end = data->pos_min + l;
2635                 data->pos_min += l; /* As in the first entry. */
2636                 data->flags &= ~SF_BEFORE_EOL;
2637             }
2638             if (flags & SCF_DO_STCLASS_AND) {
2639                 /* Check whether it is compatible with what we know already! */
2640                 int compat = 1;
2641
2642                 if (uc >= 0x100 ||
2643                     (!(data->start_class->flags & (ANYOF_CLASS | ANYOF_LOCALE))
2644                     && !ANYOF_BITMAP_TEST(data->start_class, uc)
2645                     && (!(data->start_class->flags & ANYOF_FOLD)
2646                         || !ANYOF_BITMAP_TEST(data->start_class, PL_fold[uc])))
2647                     )
2648                     compat = 0;
2649                 ANYOF_CLASS_ZERO(data->start_class);
2650                 ANYOF_BITMAP_ZERO(data->start_class);
2651                 if (compat)
2652                     ANYOF_BITMAP_SET(data->start_class, uc);
2653                 data->start_class->flags &= ~ANYOF_EOS;
2654                 if (uc < 0x100)
2655                   data->start_class->flags &= ~ANYOF_UNICODE_ALL;
2656             }
2657             else if (flags & SCF_DO_STCLASS_OR) {
2658                 /* false positive possible if the class is case-folded */
2659                 if (uc < 0x100)
2660                     ANYOF_BITMAP_SET(data->start_class, uc);
2661                 else
2662                     data->start_class->flags |= ANYOF_UNICODE_ALL;
2663                 data->start_class->flags &= ~ANYOF_EOS;
2664                 cl_and(data->start_class, &and_with);
2665             }
2666             flags &= ~SCF_DO_STCLASS;
2667         }
2668         else if (PL_regkind[OP(scan)] == EXACT) { /* But OP != EXACT! */
2669             I32 l = STR_LEN(scan);
2670             UV uc = *((U8*)STRING(scan));
2671
2672             /* Search for fixed substrings supports EXACT only. */
2673             if (flags & SCF_DO_SUBSTR) {
2674                 assert(data);
2675                 scan_commit(pRExC_state, data, minlenp);
2676             }
2677             if (UTF) {
2678                 const U8 * const s = (U8 *)STRING(scan);
2679                 l = utf8_length(s, s + l);
2680                 uc = utf8_to_uvchr(s, NULL);
2681             }
2682             min += l;
2683             if (flags & SCF_DO_SUBSTR)
2684                 data->pos_min += l;
2685             if (flags & SCF_DO_STCLASS_AND) {
2686                 /* Check whether it is compatible with what we know already! */
2687                 int compat = 1;
2688
2689                 if (uc >= 0x100 ||
2690                     (!(data->start_class->flags & (ANYOF_CLASS | ANYOF_LOCALE))
2691                     && !ANYOF_BITMAP_TEST(data->start_class, uc)
2692                      && !ANYOF_BITMAP_TEST(data->start_class, PL_fold[uc])))
2693                     compat = 0;
2694                 ANYOF_CLASS_ZERO(data->start_class);
2695                 ANYOF_BITMAP_ZERO(data->start_class);
2696                 if (compat) {
2697                     ANYOF_BITMAP_SET(data->start_class, uc);
2698                     data->start_class->flags &= ~ANYOF_EOS;
2699                     data->start_class->flags |= ANYOF_FOLD;
2700                     if (OP(scan) == EXACTFL)
2701                         data->start_class->flags |= ANYOF_LOCALE;
2702                 }
2703             }
2704             else if (flags & SCF_DO_STCLASS_OR) {
2705                 if (data->start_class->flags & ANYOF_FOLD) {
2706                     /* false positive possible if the class is case-folded.
2707                        Assume that the locale settings are the same... */
2708                     if (uc < 0x100)
2709                         ANYOF_BITMAP_SET(data->start_class, uc);
2710                     data->start_class->flags &= ~ANYOF_EOS;
2711                 }
2712                 cl_and(data->start_class, &and_with);
2713             }
2714             flags &= ~SCF_DO_STCLASS;
2715         }
2716         else if (strchr((const char*)PL_varies,OP(scan))) {
2717             I32 mincount, maxcount, minnext, deltanext, fl = 0;
2718             I32 f = flags, pos_before = 0;
2719             regnode * const oscan = scan;
2720             struct regnode_charclass_class this_class;
2721             struct regnode_charclass_class *oclass = NULL;
2722             I32 next_is_eval = 0;
2723
2724             switch (PL_regkind[OP(scan)]) {
2725             case WHILEM:                /* End of (?:...)* . */
2726                 scan = NEXTOPER(scan);
2727                 goto finish;
2728             case PLUS:
2729                 if (flags & (SCF_DO_SUBSTR | SCF_DO_STCLASS)) {
2730                     next = NEXTOPER(scan);
2731                     if (OP(next) == EXACT || (flags & SCF_DO_STCLASS)) {
2732                         mincount = 1;
2733                         maxcount = REG_INFTY;
2734                         next = regnext(scan);
2735                         scan = NEXTOPER(scan);
2736                         goto do_curly;
2737                     }
2738                 }
2739                 if (flags & SCF_DO_SUBSTR)
2740                     data->pos_min++;
2741                 min++;
2742                 /* Fall through. */
2743             case STAR:
2744                 if (flags & SCF_DO_STCLASS) {
2745                     mincount = 0;
2746                     maxcount = REG_INFTY;
2747                     next = regnext(scan);
2748                     scan = NEXTOPER(scan);
2749                     goto do_curly;
2750                 }
2751                 is_inf = is_inf_internal = 1;
2752                 scan = regnext(scan);
2753                 if (flags & SCF_DO_SUBSTR) {
2754                     scan_commit(pRExC_state, data, minlenp); /* Cannot extend fixed substrings */
2755                     data->longest = &(data->longest_float);
2756                 }
2757                 goto optimize_curly_tail;
2758             case CURLY:
2759                 mincount = ARG1(scan);
2760                 maxcount = ARG2(scan);
2761                 next = regnext(scan);
2762                 if (OP(scan) == CURLYX) {
2763                     I32 lp = (data ? *(data->last_closep) : 0);
2764                     scan->flags = ((lp <= (I32)U8_MAX) ? (U8)lp : U8_MAX);
2765                 }
2766                 scan = NEXTOPER(scan) + EXTRA_STEP_2ARGS;
2767                 next_is_eval = (OP(scan) == EVAL);
2768               do_curly:
2769                 if (flags & SCF_DO_SUBSTR) {
2770                     if (mincount == 0) scan_commit(pRExC_state,data,minlenp); /* Cannot extend fixed substrings */
2771                     pos_before = data->pos_min;
2772                 }
2773                 if (data) {
2774                     fl = data->flags;
2775                     data->flags &= ~(SF_HAS_PAR|SF_IN_PAR|SF_HAS_EVAL);
2776                     if (is_inf)
2777                         data->flags |= SF_IS_INF;
2778                 }
2779                 if (flags & SCF_DO_STCLASS) {
2780                     cl_init(pRExC_state, &this_class);
2781                     oclass = data->start_class;
2782                     data->start_class = &this_class;
2783                     f |= SCF_DO_STCLASS_AND;
2784                     f &= ~SCF_DO_STCLASS_OR;
2785                 }
2786                 /* These are the cases when once a subexpression
2787                    fails at a particular position, it cannot succeed
2788                    even after backtracking at the enclosing scope.
2789
2790                    XXXX what if minimal match and we are at the
2791                         initial run of {n,m}? */
2792                 if ((mincount != maxcount - 1) && (maxcount != REG_INFTY))
2793                     f &= ~SCF_WHILEM_VISITED_POS;
2794
2795                 /* This will finish on WHILEM, setting scan, or on NULL: */
2796                 minnext = study_chunk(pRExC_state, &scan, minlenp, &deltanext, last, data,
2797                                       (mincount == 0
2798                                         ? (f & ~SCF_DO_SUBSTR) : f),depth+1);
2799
2800                 if (flags & SCF_DO_STCLASS)
2801                     data->start_class = oclass;
2802                 if (mincount == 0 || minnext == 0) {
2803                     if (flags & SCF_DO_STCLASS_OR) {
2804                         cl_or(pRExC_state, data->start_class, &this_class);
2805                     }
2806                     else if (flags & SCF_DO_STCLASS_AND) {
2807                         /* Switch to OR mode: cache the old value of
2808                          * data->start_class */
2809                         StructCopy(data->start_class, &and_with,
2810                                    struct regnode_charclass_class);
2811                         flags &= ~SCF_DO_STCLASS_AND;
2812                         StructCopy(&this_class, data->start_class,
2813                                    struct regnode_charclass_class);
2814                         flags |= SCF_DO_STCLASS_OR;
2815                         data->start_class->flags |= ANYOF_EOS;
2816                     }
2817                 } else {                /* Non-zero len */
2818                     if (flags & SCF_DO_STCLASS_OR) {
2819                         cl_or(pRExC_state, data->start_class, &this_class);
2820                         cl_and(data->start_class, &and_with);
2821                     }
2822                     else if (flags & SCF_DO_STCLASS_AND)
2823                         cl_and(data->start_class, &this_class);
2824                     flags &= ~SCF_DO_STCLASS;
2825                 }
2826                 if (!scan)              /* It was not CURLYX, but CURLY. */
2827                     scan = next;
2828                 if ( /* ? quantifier ok, except for (?{ ... }) */
2829                     (next_is_eval || !(mincount == 0 && maxcount == 1))
2830                     && (minnext == 0) && (deltanext == 0)
2831                     && data && !(data->flags & (SF_HAS_PAR|SF_IN_PAR))
2832                     && maxcount <= REG_INFTY/3 /* Complement check for big count */
2833                     && ckWARN(WARN_REGEXP))
2834                 {
2835                     vWARN(RExC_parse,
2836                           "Quantifier unexpected on zero-length expression");
2837                 }
2838
2839                 min += minnext * mincount;
2840                 is_inf_internal |= ((maxcount == REG_INFTY
2841                                      && (minnext + deltanext) > 0)
2842                                     || deltanext == I32_MAX);
2843                 is_inf |= is_inf_internal;
2844                 delta += (minnext + deltanext) * maxcount - minnext * mincount;
2845
2846                 /* Try powerful optimization CURLYX => CURLYN. */
2847                 if (  OP(oscan) == CURLYX && data
2848                       && data->flags & SF_IN_PAR
2849                       && !(data->flags & SF_HAS_EVAL)
2850                       && !deltanext && minnext == 1 ) {
2851                     /* Try to optimize to CURLYN.  */
2852                     regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS;
2853                     regnode * const nxt1 = nxt;
2854 #ifdef DEBUGGING
2855                     regnode *nxt2;
2856 #endif
2857
2858                     /* Skip open. */
2859                     nxt = regnext(nxt);
2860                     if (!strchr((const char*)PL_simple,OP(nxt))
2861                         && !(PL_regkind[OP(nxt)] == EXACT
2862                              && STR_LEN(nxt) == 1))
2863                         goto nogo;
2864 #ifdef DEBUGGING
2865                     nxt2 = nxt;
2866 #endif
2867                     nxt = regnext(nxt);
2868                     if (OP(nxt) != CLOSE)
2869                         goto nogo;
2870                     /* Now we know that nxt2 is the only contents: */
2871                     oscan->flags = (U8)ARG(nxt);
2872                     OP(oscan) = CURLYN;
2873                     OP(nxt1) = NOTHING; /* was OPEN. */
2874 #ifdef DEBUGGING
2875                     OP(nxt1 + 1) = OPTIMIZED; /* was count. */
2876                     NEXT_OFF(nxt1+ 1) = 0; /* just for consistancy. */
2877                     NEXT_OFF(nxt2) = 0; /* just for consistancy with CURLY. */
2878                     OP(nxt) = OPTIMIZED;        /* was CLOSE. */
2879                     OP(nxt + 1) = OPTIMIZED; /* was count. */
2880                     NEXT_OFF(nxt+ 1) = 0; /* just for consistancy. */
2881 #endif
2882                 }
2883               nogo:
2884
2885                 /* Try optimization CURLYX => CURLYM. */
2886                 if (  OP(oscan) == CURLYX && data
2887                       && !(data->flags & SF_HAS_PAR)
2888                       && !(data->flags & SF_HAS_EVAL)
2889                       && !deltanext     /* atom is fixed width */
2890                       && minnext != 0   /* CURLYM can't handle zero width */
2891                 ) {
2892                     /* XXXX How to optimize if data == 0? */
2893                     /* Optimize to a simpler form.  */
2894                     regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN */
2895                     regnode *nxt2;
2896
2897                     OP(oscan) = CURLYM;
2898                     while ( (nxt2 = regnext(nxt)) /* skip over embedded stuff*/
2899                             && (OP(nxt2) != WHILEM))
2900                         nxt = nxt2;
2901                     OP(nxt2)  = SUCCEED; /* Whas WHILEM */
2902                     /* Need to optimize away parenths. */
2903                     if (data->flags & SF_IN_PAR) {
2904                         /* Set the parenth number.  */
2905                         regnode *nxt1 = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN*/
2906
2907                         if (OP(nxt) != CLOSE)
2908                             FAIL("Panic opt close");
2909                         oscan->flags = (U8)ARG(nxt);
2910                         OP(nxt1) = OPTIMIZED;   /* was OPEN. */
2911                         OP(nxt) = OPTIMIZED;    /* was CLOSE. */
2912 #ifdef DEBUGGING
2913                         OP(nxt1 + 1) = OPTIMIZED; /* was count. */
2914                         OP(nxt + 1) = OPTIMIZED; /* was count. */
2915                         NEXT_OFF(nxt1 + 1) = 0; /* just for consistancy. */
2916                         NEXT_OFF(nxt + 1) = 0; /* just for consistancy. */
2917 #endif
2918 #if 0
2919                         while ( nxt1 && (OP(nxt1) != WHILEM)) {
2920                             regnode *nnxt = regnext(nxt1);
2921
2922                             if (nnxt == nxt) {
2923                                 if (reg_off_by_arg[OP(nxt1)])
2924                                     ARG_SET(nxt1, nxt2 - nxt1);
2925                                 else if (nxt2 - nxt1 < U16_MAX)
2926                                     NEXT_OFF(nxt1) = nxt2 - nxt1;
2927                                 else
2928                                     OP(nxt) = NOTHING;  /* Cannot beautify */
2929                             }
2930                             nxt1 = nnxt;
2931                         }
2932 #endif
2933                         /* Optimize again: */
2934                         study_chunk(pRExC_state, &nxt1, minlenp, &deltanext, nxt,
2935                                     NULL, 0,depth+1);
2936                     }
2937                     else
2938                         oscan->flags = 0;
2939                 }
2940                 else if ((OP(oscan) == CURLYX)
2941                          && (flags & SCF_WHILEM_VISITED_POS)
2942                          /* See the comment on a similar expression above.
2943                             However, this time it not a subexpression
2944                             we care about, but the expression itself. */
2945                          && (maxcount == REG_INFTY)
2946                          && data && ++data->whilem_c < 16) {
2947                     /* This stays as CURLYX, we can put the count/of pair. */
2948                     /* Find WHILEM (as in regexec.c) */
2949                     regnode *nxt = oscan + NEXT_OFF(oscan);
2950
2951                     if (OP(PREVOPER(nxt)) == NOTHING) /* LONGJMP */
2952                         nxt += ARG(nxt);
2953                     PREVOPER(nxt)->flags = (U8)(data->whilem_c
2954                         | (RExC_whilem_seen << 4)); /* On WHILEM */
2955                 }
2956                 if (data && fl & (SF_HAS_PAR|SF_IN_PAR))
2957                     pars++;
2958                 if (flags & SCF_DO_SUBSTR) {
2959                     SV *last_str = NULL;
2960                     int counted = mincount != 0;
2961
2962                     if (data->last_end > 0 && mincount != 0) { /* Ends with a string. */
2963 #if defined(SPARC64_GCC_WORKAROUND)
2964                         I32 b = 0;
2965                         STRLEN l = 0;
2966                         const char *s = NULL;
2967                         I32 old = 0;
2968
2969                         if (pos_before >= data->last_start_min)
2970                             b = pos_before;
2971                         else
2972                             b = data->last_start_min;
2973
2974                         l = 0;
2975                         s = SvPV_const(data->last_found, l);
2976                         old = b - data->last_start_min;
2977
2978 #else
2979                         I32 b = pos_before >= data->last_start_min
2980                             ? pos_before : data->last_start_min;
2981                         STRLEN l;
2982                         const char * const s = SvPV_const(data->last_found, l);
2983                         I32 old = b - data->last_start_min;
2984 #endif
2985
2986                         if (UTF)
2987                             old = utf8_hop((U8*)s, old) - (U8*)s;
2988
2989                         l -= old;
2990                         /* Get the added string: */
2991                         last_str = newSVpvn(s  + old, l);
2992                         if (UTF)
2993                             SvUTF8_on(last_str);
2994                         if (deltanext == 0 && pos_before == b) {
2995                             /* What was added is a constant string */
2996                             if (mincount > 1) {
2997                                 SvGROW(last_str, (mincount * l) + 1);
2998                                 repeatcpy(SvPVX(last_str) + l,
2999                                           SvPVX_const(last_str), l, mincount - 1);
3000                                 SvCUR_set(last_str, SvCUR(last_str) * mincount);
3001                                 /* Add additional parts. */
3002                                 SvCUR_set(data->last_found,
3003                                           SvCUR(data->last_found) - l);
3004                                 sv_catsv(data->last_found, last_str);
3005                                 {
3006                                     SV * sv = data->last_found;
3007                                     MAGIC *mg =
3008                                         SvUTF8(sv) && SvMAGICAL(sv) ?
3009                                         mg_find(sv, PERL_MAGIC_utf8) : NULL;
3010                                     if (mg && mg->mg_len >= 0)
3011                                         mg->mg_len += CHR_SVLEN(last_str);
3012                                 }
3013                                 data->last_end += l * (mincount - 1);
3014                             }
3015                         } else {
3016                             /* start offset must point into the last copy */
3017                             data->last_start_min += minnext * (mincount - 1);
3018                             data->last_start_max += is_inf ? I32_MAX
3019                                 : (maxcount - 1) * (minnext + data->pos_delta);
3020                         }
3021                     }
3022                     /* It is counted once already... */
3023                     data->pos_min += minnext * (mincount - counted);
3024                     data->pos_delta += - counted * deltanext +
3025                         (minnext + deltanext) * maxcount - minnext * mincount;
3026                     if (mincount != maxcount) {
3027                          /* Cannot extend fixed substrings found inside
3028                             the group.  */
3029                         scan_commit(pRExC_state,data,minlenp);
3030                         if (mincount && last_str) {
3031                             SV * const sv = data->last_found;
3032                             MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
3033                                 mg_find(sv, PERL_MAGIC_utf8) : NULL;
3034
3035                             if (mg)
3036                                 mg->mg_len = -1;
3037                             sv_setsv(sv, last_str);
3038                             data->last_end = data->pos_min;
3039                             data->last_start_min =
3040                                 data->pos_min - CHR_SVLEN(last_str);
3041                             data->last_start_max = is_inf
3042                                 ? I32_MAX
3043                                 : data->pos_min + data->pos_delta
3044                                 - CHR_SVLEN(last_str);
3045                         }
3046                         data->longest = &(data->longest_float);
3047                     }
3048                     SvREFCNT_dec(last_str);
3049                 }
3050                 if (data && (fl & SF_HAS_EVAL))
3051                     data->flags |= SF_HAS_EVAL;
3052               optimize_curly_tail:
3053                 if (OP(oscan) != CURLYX) {
3054                     while (PL_regkind[OP(next = regnext(oscan))] == NOTHING
3055                            && NEXT_OFF(next))
3056                         NEXT_OFF(oscan) += NEXT_OFF(next);
3057                 }
3058                 continue;
3059             default:                    /* REF and CLUMP only? */
3060                 if (flags & SCF_DO_SUBSTR) {
3061                     scan_commit(pRExC_state,data,minlenp);      /* Cannot expect anything... */
3062                     data->longest = &(data->longest_float);
3063                 }
3064                 is_inf = is_inf_internal = 1;
3065                 if (flags & SCF_DO_STCLASS_OR)
3066                     cl_anything(pRExC_state, data->start_class);
3067                 flags &= ~SCF_DO_STCLASS;
3068                 break;
3069             }
3070         }
3071         else if (strchr((const char*)PL_simple,OP(scan))) {
3072             int value = 0;
3073
3074             if (flags & SCF_DO_SUBSTR) {
3075                 scan_commit(pRExC_state,data,minlenp);
3076                 data->pos_min++;
3077             }
3078             min++;
3079             if (flags & SCF_DO_STCLASS) {
3080                 data->start_class->flags &= ~ANYOF_EOS; /* No match on empty */
3081
3082                 /* Some of the logic below assumes that switching
3083                    locale on will only add false positives. */
3084                 switch (PL_regkind[OP(scan)]) {
3085                 case SANY:
3086                 default:
3087                   do_default:
3088                     /* Perl_croak(aTHX_ "panic: unexpected simple REx opcode %d", OP(scan)); */
3089                     if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
3090                         cl_anything(pRExC_state, data->start_class);
3091                     break;
3092                 case REG_ANY:
3093                     if (OP(scan) == SANY)
3094                         goto do_default;
3095                     if (flags & SCF_DO_STCLASS_OR) { /* Everything but \n */
3096                         value = (ANYOF_BITMAP_TEST(data->start_class,'\n')
3097                                  || (data->start_class->flags & ANYOF_CLASS));
3098                         cl_anything(pRExC_state, data->start_class);
3099                     }
3100                     if (flags & SCF_DO_STCLASS_AND || !value)
3101                         ANYOF_BITMAP_CLEAR(data->start_class,'\n');
3102                     break;
3103                 case ANYOF:
3104                     if (flags & SCF_DO_STCLASS_AND)
3105                         cl_and(data->start_class,
3106                                (struct regnode_charclass_class*)scan);
3107                     else
3108                         cl_or(pRExC_state, data->start_class,
3109                               (struct regnode_charclass_class*)scan);
3110                     break;
3111                 case ALNUM:
3112                     if (flags & SCF_DO_STCLASS_AND) {
3113                         if (!(data->start_class->flags & ANYOF_LOCALE)) {
3114                             ANYOF_CLASS_CLEAR(data->start_class,ANYOF_NALNUM);
3115                             for (value = 0; value < 256; value++)
3116                                 if (!isALNUM(value))
3117                                     ANYOF_BITMAP_CLEAR(data->start_class, value);
3118                         }
3119                     }
3120                     else {
3121                         if (data->start_class->flags & ANYOF_LOCALE)
3122                             ANYOF_CLASS_SET(data->start_class,ANYOF_ALNUM);
3123                         else {
3124                             for (value = 0; value < 256; value++)
3125                                 if (isALNUM(value))
3126                                     ANYOF_BITMAP_SET(data->start_class, value);
3127                         }
3128                     }
3129                     break;
3130                 case ALNUML:
3131                     if (flags & SCF_DO_STCLASS_AND) {
3132                         if (data->start_class->flags & ANYOF_LOCALE)
3133                             ANYOF_CLASS_CLEAR(data->start_class,ANYOF_NALNUM);
3134                     }
3135                     else {
3136                         ANYOF_CLASS_SET(data->start_class,ANYOF_ALNUM);
3137                         data->start_class->flags |= ANYOF_LOCALE;
3138                     }
3139                     break;
3140                 case NALNUM:
3141                     if (flags & SCF_DO_STCLASS_AND) {
3142                         if (!(data->start_class->flags & ANYOF_LOCALE)) {
3143                             ANYOF_CLASS_CLEAR(data->start_class,ANYOF_ALNUM);
3144                             for (value = 0; value < 256; value++)
3145                                 if (isALNUM(value))
3146                                     ANYOF_BITMAP_CLEAR(data->start_class, value);
3147                         }
3148                     }
3149                     else {
3150                         if (data->start_class->flags & ANYOF_LOCALE)
3151                             ANYOF_CLASS_SET(data->start_class,ANYOF_NALNUM);
3152                         else {
3153                             for (value = 0; value < 256; value++)
3154                                 if (!isALNUM(value))
3155                                     ANYOF_BITMAP_SET(data->start_class, value);
3156                         }
3157                     }
3158                     break;
3159                 case NALNUML:
3160                     if (flags & SCF_DO_STCLASS_AND) {
3161                         if (data->start_class->flags & ANYOF_LOCALE)
3162                             ANYOF_CLASS_CLEAR(data->start_class,ANYOF_ALNUM);
3163                     }
3164                     else {
3165                         data->start_class->flags |= ANYOF_LOCALE;
3166                         ANYOF_CLASS_SET(data->start_class,ANYOF_NALNUM);
3167                     }
3168                     break;
3169                 case SPACE:
3170                     if (flags & SCF_DO_STCLASS_AND) {
3171                         if (!(data->start_class->flags & ANYOF_LOCALE)) {
3172                             ANYOF_CLASS_CLEAR(data->start_class,ANYOF_NSPACE);
3173                             for (value = 0; value < 256; value++)
3174                                 if (!isSPACE(value))
3175                                     ANYOF_BITMAP_CLEAR(data->start_class, value);
3176                         }
3177                     }
3178                     else {
3179                         if (data->start_class->flags & ANYOF_LOCALE)
3180                             ANYOF_CLASS_SET(data->start_class,ANYOF_SPACE);
3181                         else {
3182                             for (value = 0; value < 256; value++)
3183                                 if (isSPACE(value))
3184                                     ANYOF_BITMAP_SET(data->start_class, value);
3185                         }
3186                     }
3187                     break;
3188                 case SPACEL:
3189                     if (flags & SCF_DO_STCLASS_AND) {
3190                         if (data->start_class->flags & ANYOF_LOCALE)
3191                             ANYOF_CLASS_CLEAR(data->start_class,ANYOF_NSPACE);
3192                     }
3193                     else {
3194                         data->start_class->flags |= ANYOF_LOCALE;
3195                         ANYOF_CLASS_SET(data->start_class,ANYOF_SPACE);
3196                     }
3197                     break;
3198                 case NSPACE:
3199                     if (flags & SCF_DO_STCLASS_AND) {
3200                         if (!(data->start_class->flags & ANYOF_LOCALE)) {
3201                             ANYOF_CLASS_CLEAR(data->start_class,ANYOF_SPACE);
3202                             for (value = 0; value < 256; value++)
3203                                 if (isSPACE(value))
3204                                     ANYOF_BITMAP_CLEAR(data->start_class, value);
3205                         }
3206                     }
3207                     else {
3208                         if (data->start_class->flags & ANYOF_LOCALE)
3209                             ANYOF_CLASS_SET(data->start_class,ANYOF_NSPACE);
3210                         else {
3211                             for (value = 0; value < 256; value++)
3212                                 if (!isSPACE(value))
3213                                     ANYOF_BITMAP_SET(data->start_class, value);
3214                         }
3215                     }
3216                     break;
3217                 case NSPACEL:
3218                     if (flags & SCF_DO_STCLASS_AND) {
3219                         if (data->start_class->flags & ANYOF_LOCALE) {
3220                             ANYOF_CLASS_CLEAR(data->start_class,ANYOF_SPACE);
3221                             for (value = 0; value < 256; value++)
3222                                 if (!isSPACE(value))
3223                                     ANYOF_BITMAP_CLEAR(data->start_class, value);
3224                         }
3225                     }
3226                     else {
3227                         data->start_class->flags |= ANYOF_LOCALE;
3228                         ANYOF_CLASS_SET(data->start_class,ANYOF_NSPACE);
3229                     }
3230                     break;
3231                 case DIGIT:
3232                     if (flags & SCF_DO_STCLASS_AND) {
3233                         ANYOF_CLASS_CLEAR(data->start_class,ANYOF_NDIGIT);
3234                         for (value = 0; value < 256; value++)
3235                             if (!isDIGIT(value))
3236                                 ANYOF_BITMAP_CLEAR(data->start_class, value);
3237                     }
3238                     else {
3239                         if (data->start_class->flags & ANYOF_LOCALE)
3240                             ANYOF_CLASS_SET(data->start_class,ANYOF_DIGIT);
3241                         else {
3242                             for (value = 0; value < 256; value++)
3243                                 if (isDIGIT(value))
3244                                     ANYOF_BITMAP_SET(data->start_class, value);
3245                         }
3246                     }
3247                     break;
3248                 case NDIGIT:
3249                     if (flags & SCF_DO_STCLASS_AND) {
3250                         ANYOF_CLASS_CLEAR(data->start_class,ANYOF_DIGIT);
3251                         for (value = 0; value < 256; value++)
3252                             if (isDIGIT(value))
3253                                 ANYOF_BITMAP_CLEAR(data->start_class, value);
3254                     }
3255                     else {
3256                         if (data->start_class->flags & ANYOF_LOCALE)
3257                             ANYOF_CLASS_SET(data->start_class,ANYOF_NDIGIT);
3258                         else {
3259                             for (value = 0; value < 256; value++)
3260                                 if (!isDIGIT(value))
3261                                     ANYOF_BITMAP_SET(data->start_class, value);
3262                         }
3263                     }
3264                     break;
3265                 }
3266                 if (flags & SCF_DO_STCLASS_OR)
3267                     cl_and(data->start_class, &and_with);
3268                 flags &= ~SCF_DO_STCLASS;
3269             }
3270         }
3271         else if (PL_regkind[OP(scan)] == EOL && flags & SCF_DO_SUBSTR) {
3272             data->flags |= (OP(scan) == MEOL
3273                             ? SF_BEFORE_MEOL
3274                             : SF_BEFORE_SEOL);
3275         }
3276         else if (  PL_regkind[OP(scan)] == BRANCHJ
3277                  /* Lookbehind, or need to calculate parens/evals/stclass: */
3278                    && (scan->flags || data || (flags & SCF_DO_STCLASS))
3279                    && (OP(scan) == IFMATCH || OP(scan) == UNLESSM)) {
3280             if ( !PERL_ENABLE_POSITIVE_ASSERTION_STUDY
3281                 || OP(scan) == UNLESSM )
3282             {
3283                 /* Negative Lookahead/lookbehind
3284                    In this case we can't do fixed string optimisation.
3285                 */
3286
3287                 I32 deltanext, minnext, fake = 0;
3288                 regnode *nscan;
3289                 struct regnode_charclass_class intrnl;
3290                 int f = 0;
3291
3292                 data_fake.flags = 0;
3293                 if (data) {
3294                     data_fake.whilem_c = data->whilem_c;
3295                     data_fake.last_closep = data->last_closep;
3296                 }
3297                 else
3298                     data_fake.last_closep = &fake;
3299                 if ( flags & SCF_DO_STCLASS && !scan->flags
3300                      && OP(scan) == IFMATCH ) { /* Lookahead */
3301                     cl_init(pRExC_state, &intrnl);
3302                     data_fake.start_class = &intrnl;
3303                     f |= SCF_DO_STCLASS_AND;
3304                 }
3305                 if (flags & SCF_WHILEM_VISITED_POS)
3306                     f |= SCF_WHILEM_VISITED_POS;
3307                 next = regnext(scan);
3308                 nscan = NEXTOPER(NEXTOPER(scan));
3309                 minnext = study_chunk(pRExC_state, &nscan, minlenp, &deltanext, last, &data_fake, f,depth+1);
3310                 if (scan->flags) {
3311                     if (deltanext) {
3312                         vFAIL("Variable length lookbehind not implemented");
3313                     }
3314                     else if (minnext > (I32)U8_MAX) {
3315                         vFAIL2("Lookbehind longer than %"UVuf" not implemented", (UV)U8_MAX);
3316                     }
3317                     scan->flags = (U8)minnext;
3318                 }
3319                 if (data) {
3320                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
3321                         pars++;
3322                     if (data_fake.flags & SF_HAS_EVAL)
3323                         data->flags |= SF_HAS_EVAL;
3324                     data->whilem_c = data_fake.whilem_c;
3325                 }
3326                 if (f & SCF_DO_STCLASS_AND) {
3327                     const int was = (data->start_class->flags & ANYOF_EOS);
3328
3329                     cl_and(data->start_class, &intrnl);
3330                     if (was)
3331                         data->start_class->flags |= ANYOF_EOS;
3332                 }
3333             }
3334 #if PERL_ENABLE_POSITIVE_ASSERTION_STUDY
3335             else {
3336                 /* Positive Lookahead/lookbehind
3337                    In this case we can do fixed string optimisation,
3338                    but we must be careful about it. Note in the case of
3339                    lookbehind the positions will be offset by the minimum
3340                    length of the pattern, something we won't know about
3341                    until after the recurse.
3342                 */
3343                 I32 deltanext, fake = 0;
3344                 regnode *nscan;
3345                 struct regnode_charclass_class intrnl;
3346                 int f = 0;
3347                 /* We use SAVEFREEPV so that when the full compile
3348                     is finished perl will clean up the allocated
3349                     minlens when its all done. This was we don't
3350                     have to worry about freeing them when we know
3351                     they wont be used, which would be a pain.
3352                  */
3353                 I32 *minnextp;
3354                 Newx( minnextp, 1, I32 );
3355                 SAVEFREEPV(minnextp);
3356
3357                 if (data) {
3358                     StructCopy(data, &data_fake, scan_data_t);
3359                     if ((flags & SCF_DO_SUBSTR) && data->last_found) {
3360                         f |= SCF_DO_SUBSTR;
3361                         if (scan->flags)
3362                             scan_commit(pRExC_state, &data_fake,minlenp);
3363                         data_fake.last_found=newSVsv(data->last_found);
3364                     }
3365                 }
3366                 else
3367                     data_fake.last_closep = &fake;
3368                 data_fake.flags = 0;
3369                 if (is_inf)
3370                     data_fake.flags |= SF_IS_INF;
3371                 if ( flags & SCF_DO_STCLASS && !scan->flags
3372                      && OP(scan) == IFMATCH ) { /* Lookahead */
3373                     cl_init(pRExC_state, &intrnl);
3374                     data_fake.start_class = &intrnl;
3375                     f |= SCF_DO_STCLASS_AND;
3376                 }
3377                 if (flags & SCF_WHILEM_VISITED_POS)
3378                     f |= SCF_WHILEM_VISITED_POS;
3379                 next = regnext(scan);
3380                 nscan = NEXTOPER(NEXTOPER(scan));
3381
3382                 *minnextp = study_chunk(pRExC_state, &nscan, minnextp, &deltanext, last, &data_fake, f,depth+1);
3383                 if (scan->flags) {
3384                     if (deltanext) {
3385                         vFAIL("Variable length lookbehind not implemented");
3386                     }
3387                     else if (*minnextp > (I32)U8_MAX) {
3388                         vFAIL2("Lookbehind longer than %"UVuf" not implemented", (UV)U8_MAX);
3389                     }
3390                     scan->flags = (U8)*minnextp;
3391                 }
3392
3393                 *minnextp += min;
3394
3395
3396                 if (f & SCF_DO_STCLASS_AND) {
3397                     const int was = (data->start_class->flags & ANYOF_EOS);
3398
3399                     cl_and(data->start_class, &intrnl);
3400                     if (was)
3401                         data->start_class->flags |= ANYOF_EOS;
3402                 }
3403                 if (data) {
3404                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
3405                         pars++;
3406                     if (data_fake.flags & SF_HAS_EVAL)
3407                         data->flags |= SF_HAS_EVAL;
3408                     data->whilem_c = data_fake.whilem_c;
3409                     if ((flags & SCF_DO_SUBSTR) && data_fake.last_found) {
3410                         if (RExC_rx->minlen<*minnextp)
3411                             RExC_rx->minlen=*minnextp;
3412                         scan_commit(pRExC_state, &data_fake, minnextp);
3413                         SvREFCNT_dec(data_fake.last_found);
3414
3415                         if ( data_fake.minlen_fixed != minlenp )
3416                         {
3417                             data->offset_fixed= data_fake.offset_fixed;
3418                             data->minlen_fixed= data_fake.minlen_fixed;
3419                             data->lookbehind_fixed+= scan->flags;
3420                         }
3421                         if ( data_fake.minlen_float != minlenp )
3422                         {
3423                             data->minlen_float= data_fake.minlen_float;
3424                             data->offset_float_min=data_fake.offset_float_min;
3425                             data->offset_float_max=data_fake.offset_float_max;
3426                             data->lookbehind_float+= scan->flags;
3427                         }
3428                     }
3429                 }
3430
3431
3432             }
3433 #endif
3434         }
3435         else if (OP(scan) == OPEN) {
3436             pars++;
3437         }
3438         else if (OP(scan) == CLOSE) {
3439             if ((I32)ARG(scan) == is_par) {
3440                 next = regnext(scan);
3441
3442                 if ( next && (OP(next) != WHILEM) && next < last)
3443                     is_par = 0;         /* Disable optimization */
3444             }
3445             if (data)
3446                 *(data->last_closep) = ARG(scan);
3447         }
3448         else if (OP(scan) == EVAL) {
3449                 if (data)
3450                     data->flags |= SF_HAS_EVAL;
3451         }
3452         else if ( (OP(scan) == LOGICAL && scan->flags == 2) /* Embedded follows */
3453                   || OP(scan)==RECURSE)  /* recursion */
3454         {
3455                 if (OP(scan)==RECURSE) {
3456                     ARG2L_SET( scan, RExC_parens[ARG(scan)-1] - scan );
3457                 }
3458                 if (flags & SCF_DO_SUBSTR) {
3459                     scan_commit(pRExC_state,data,minlenp);
3460                     data->longest = &(data->longest_float);
3461                 }
3462                 is_inf = is_inf_internal = 1;
3463                 if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
3464                     cl_anything(pRExC_state, data->start_class);
3465                 flags &= ~SCF_DO_STCLASS;
3466         }
3467 #ifdef TRIE_STUDY_OPT
3468 #ifdef FULL_TRIE_STUDY
3469         else if (PL_regkind[OP(scan)] == TRIE) {
3470             /* NOTE - There is similar code to this block above for handling
3471                BRANCH nodes on the initial study.  If you change stuff here
3472                check there too. */
3473             regnode *tail= regnext(scan);
3474             reg_trie_data *trie = (reg_trie_data*)RExC_rx->data->data[ ARG(scan) ];
3475             I32 max1 = 0, min1 = I32_MAX;
3476             struct regnode_charclass_class accum;
3477
3478             if (flags & SCF_DO_SUBSTR) /* XXXX Add !SUSPEND? */
3479                 scan_commit(pRExC_state, data,minlenp); /* Cannot merge strings after this. */
3480             if (flags & SCF_DO_STCLASS)
3481                 cl_init_zero(pRExC_state, &accum);
3482
3483             if (!trie->jump) {
3484                 min1= trie->minlen;
3485                 max1= trie->maxlen;
3486             } else {
3487                 const regnode *nextbranch= NULL;
3488                 U32 word;
3489
3490                 for ( word=1 ; word <= trie->wordcount ; word++)
3491                 {
3492                     I32 deltanext=0, minnext=0, f = 0, fake;
3493                     struct regnode_charclass_class this_class;
3494
3495                     data_fake.flags = 0;
3496                     if (data) {
3497                         data_fake.whilem_c = data->whilem_c;
3498                         data_fake.last_closep = data->last_closep;
3499                     }
3500                     else
3501                         data_fake.last_closep = &fake;
3502
3503                     if (flags & SCF_DO_STCLASS) {
3504                         cl_init(pRExC_state, &this_class);
3505                         data_fake.start_class = &this_class;
3506                         f = SCF_DO_STCLASS_AND;
3507                     }
3508                     if (flags & SCF_WHILEM_VISITED_POS)
3509                         f |= SCF_WHILEM_VISITED_POS;
3510
3511                     if (trie->jump[word]) {
3512                         if (!nextbranch)
3513                             nextbranch = tail - trie->jump[0];
3514                         scan= tail - trie->jump[word];
3515                         /* We go from the jump point to the branch that follows
3516                            it. Note this means we need the vestigal unused branches
3517                            even though they arent otherwise used.
3518                          */
3519                         minnext = study_chunk(pRExC_state, &scan, minlenp, &deltanext,
3520                                               (regnode *)nextbranch, &data_fake, f,depth+1);
3521                     }
3522                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
3523                         nextbranch= regnext((regnode*)nextbranch);
3524
3525                     if (min1 > (I32)(minnext + trie->minlen))
3526                         min1 = minnext + trie->minlen;
3527                     if (max1 < (I32)(minnext + deltanext + trie->maxlen))
3528                         max1 = minnext + deltanext + trie->maxlen;
3529                     if (deltanext == I32_MAX)
3530                         is_inf = is_inf_internal = 1;
3531
3532                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
3533                         pars++;
3534
3535                     if (data) {
3536                         if (data_fake.flags & SF_HAS_EVAL)
3537                             data->flags |= SF_HAS_EVAL;
3538                         data->whilem_c = data_fake.whilem_c;
3539                     }
3540                     if (flags & SCF_DO_STCLASS)
3541                         cl_or(pRExC_state, &accum, &this_class);
3542                 }
3543             }
3544             if (flags & SCF_DO_SUBSTR) {
3545                 data->pos_min += min1;
3546                 data->pos_delta += max1 - min1;
3547                 if (max1 != min1 || is_inf)
3548                     data->longest = &(data->longest_float);
3549             }
3550             min += min1;
3551             delta += max1 - min1;
3552             if (flags & SCF_DO_STCLASS_OR) {
3553                 cl_or(pRExC_state, data->start_class, &accum);
3554                 if (min1) {
3555                     cl_and(data->start_class, &and_with);
3556                     flags &= ~SCF_DO_STCLASS;
3557                 }
3558             }
3559             else if (flags & SCF_DO_STCLASS_AND) {
3560                 if (min1) {
3561                     cl_and(data->start_class, &accum);
3562                     flags &= ~SCF_DO_STCLASS;
3563                 }
3564                 else {
3565                     /* Switch to OR mode: cache the old value of
3566                      * data->start_class */
3567                     StructCopy(data->start_class, &and_with,
3568                                struct regnode_charclass_class);
3569                     flags &= ~SCF_DO_STCLASS_AND;
3570                     StructCopy(&accum, data->start_class,
3571                                struct regnode_charclass_class);
3572                     flags |= SCF_DO_STCLASS_OR;
3573                     data->start_class->flags |= ANYOF_EOS;
3574                 }
3575             }
3576             scan= tail;
3577             continue;
3578         }
3579 #else
3580         else if (PL_regkind[OP(scan)] == TRIE) {
3581             reg_trie_data *trie = (reg_trie_data*)RExC_rx->data->data[ ARG(scan) ];
3582             U8*bang=NULL;
3583
3584             min += trie->minlen;
3585             delta += (trie->maxlen - trie->minlen);
3586             flags &= ~SCF_DO_STCLASS; /* xxx */
3587             if (flags & SCF_DO_SUBSTR) {
3588                 scan_commit(pRExC_state,data,minlenp);  /* Cannot expect anything... */
3589                 data->pos_min += trie->minlen;
3590                 data->pos_delta += (trie->maxlen - trie->minlen);
3591                 if (trie->maxlen != trie->minlen)
3592                     data->longest = &(data->longest_float);
3593             }
3594             if (trie->jump) /* no more substrings -- for now /grr*/
3595                 flags &= ~SCF_DO_SUBSTR;
3596         }
3597 #endif /* old or new */
3598 #endif /* TRIE_STUDY_OPT */
3599         /* Else: zero-length, ignore. */
3600         scan = regnext(scan);
3601     }
3602
3603   finish:
3604     *scanp = scan;
3605     *deltap = is_inf_internal ? I32_MAX : delta;
3606     if (flags & SCF_DO_SUBSTR && is_inf)
3607         data->pos_delta = I32_MAX - data->pos_min;
3608     if (is_par > (I32)U8_MAX)
3609         is_par = 0;
3610     if (is_par && pars==1 && data) {
3611         data->flags |= SF_IN_PAR;
3612         data->flags &= ~SF_HAS_PAR;
3613     }
3614     else if (pars && data) {
3615         data->flags |= SF_HAS_PAR;
3616         data->flags &= ~SF_IN_PAR;
3617     }
3618     if (flags & SCF_DO_STCLASS_OR)
3619         cl_and(data->start_class, &and_with);
3620     if (flags & SCF_TRIE_RESTUDY)
3621         data->flags |=  SCF_TRIE_RESTUDY;
3622
3623     DEBUG_STUDYDATA(data,depth);
3624
3625     return min;
3626 }
3627
3628 STATIC I32
3629 S_add_data(RExC_state_t *pRExC_state, I32 n, const char *s)
3630 {
3631     if (RExC_rx->data) {
3632         Renewc(RExC_rx->data,
3633                sizeof(*RExC_rx->data) + sizeof(void*) * (RExC_rx->data->count + n - 1),
3634                char, struct reg_data);
3635         Renew(RExC_rx->data->what, RExC_rx->data->count + n, U8);
3636         RExC_rx->data->count += n;
3637     }
3638     else {
3639         Newxc(RExC_rx->data, sizeof(*RExC_rx->data) + sizeof(void*) * (n - 1),
3640              char, struct reg_data);
3641         Newx(RExC_rx->data->what, n, U8);
3642         RExC_rx->data->count = n;
3643     }
3644     Copy(s, RExC_rx->data->what + RExC_rx->data->count - n, n, U8);
3645     return RExC_rx->data->count - n;
3646 }
3647
3648 #ifndef PERL_IN_XSUB_RE
3649 void
3650 Perl_reginitcolors(pTHX)
3651 {
3652     dVAR;
3653     const char * const s = PerlEnv_getenv("PERL_RE_COLORS");
3654     if (s) {
3655         char *t = savepv(s);
3656         int i = 0;
3657         PL_colors[0] = t;
3658         while (++i < 6) {
3659             t = strchr(t, '\t');
3660             if (t) {
3661                 *t = '\0';
3662                 PL_colors[i] = ++t;
3663             }
3664             else
3665                 PL_colors[i] = t = (char *)"";
3666         }
3667     } else {
3668         int i = 0;
3669         while (i < 6)
3670             PL_colors[i++] = (char *)"";
3671     }
3672     PL_colorset = 1;
3673 }
3674 #endif
3675
3676
3677 #ifdef TRIE_STUDY_OPT
3678 #define CHECK_RESTUDY_GOTO                                  \
3679         if (                                                \
3680               (data.flags & SCF_TRIE_RESTUDY)               \
3681               && ! restudied++                              \
3682         )     goto reStudy
3683 #else
3684 #define CHECK_RESTUDY_GOTO
3685 #endif
3686
3687 /*
3688  - pregcomp - compile a regular expression into internal code
3689  *
3690  * We can't allocate space until we know how big the compiled form will be,
3691  * but we can't compile it (and thus know how big it is) until we've got a
3692  * place to put the code.  So we cheat:  we compile it twice, once with code
3693  * generation turned off and size counting turned on, and once "for real".
3694  * This also means that we don't allocate space until we are sure that the
3695  * thing really will compile successfully, and we never have to move the
3696  * code and thus invalidate pointers into it.  (Note that it has to be in
3697  * one piece because free() must be able to free it all.) [NB: not true in perl]
3698  *
3699  * Beware that the optimization-preparation code in here knows about some
3700  * of the structure of the compiled regexp.  [I'll say.]
3701  */
3702
3703
3704
3705 #ifndef PERL_IN_XSUB_RE
3706 #define RE_ENGINE_PTR &PL_core_reg_engine
3707 #else
3708 extern const struct regexp_engine my_reg_engine;
3709 #define RE_ENGINE_PTR &my_reg_engine
3710 #endif
3711 /* these make a few things look better, to avoid indentation */
3712 #define BEGIN_BLOCK {
3713 #define END_BLOCK }
3714
3715 regexp *
3716 Perl_pregcomp(pTHX_ char *exp, char *xend, PMOP *pm)
3717 {
3718     dVAR;
3719     GET_RE_DEBUG_FLAGS_DECL;
3720     DEBUG_r(if (!PL_colorset) reginitcolors());
3721 #ifndef PERL_IN_XSUB_RE
3722     BEGIN_BLOCK
3723     /* Dispatch a request to compile a regexp to correct
3724        regexp engine. */
3725     HV * const table = GvHV(PL_hintgv);
3726     if (table) {
3727         SV **ptr= hv_fetchs(table, "regcomp", FALSE);
3728         if (ptr && SvIOK(*ptr)) {
3729             const regexp_engine *eng=INT2PTR(regexp_engine*,SvIV(*ptr));
3730             DEBUG_COMPILE_r({
3731                 PerlIO_printf(Perl_debug_log, "Using engine %"UVxf"\n",
3732                     SvIV(*ptr));
3733             });
3734             return CALLREGCOMP_ENG(eng, exp, xend, pm);
3735         }
3736     }
3737     END_BLOCK
3738 #endif
3739     BEGIN_BLOCK
3740     register regexp *r;
3741     regnode *scan;
3742     regnode *first;
3743     I32 flags;
3744     I32 minlen = 0;
3745     I32 sawplus = 0;
3746     I32 sawopen = 0;
3747     scan_data_t data;
3748     RExC_state_t RExC_state;
3749     RExC_state_t * const pRExC_state = &RExC_state;
3750 #ifdef TRIE_STUDY_OPT
3751     int restudied= 0;
3752     RExC_state_t copyRExC_state;
3753 #endif
3754     if (exp == NULL)
3755         FAIL("NULL regexp argument");
3756
3757     RExC_utf8 = pm->op_pmdynflags & PMdf_CMP_UTF8;
3758
3759     RExC_precomp = exp;
3760     DEBUG_COMPILE_r({
3761         SV *dsv= sv_newmortal();
3762         RE_PV_QUOTED_DECL(s, RExC_utf8,
3763             dsv, RExC_precomp, (xend - exp), 60);
3764         PerlIO_printf(Perl_debug_log, "%sCompiling REx%s %s\n",
3765                        PL_colors[4],PL_colors[5],s);
3766     });
3767     RExC_flags = pm->op_pmflags;
3768     RExC_sawback = 0;
3769
3770     RExC_seen = 0;
3771     RExC_seen_zerolen = *exp == '^' ? -1 : 0;
3772     RExC_seen_evals = 0;
3773     RExC_extralen = 0;
3774
3775     /* First pass: determine size, legality. */
3776     RExC_parse = exp;
3777     RExC_start = exp;
3778     RExC_end = xend;
3779     RExC_naughty = 0;
3780     RExC_npar = 1;
3781     RExC_size = 0L;
3782     RExC_emit = &PL_regdummy;
3783     RExC_whilem_seen = 0;
3784     RExC_charnames = NULL;
3785     RExC_parens = NULL;
3786     RExC_paren_names = NULL;
3787
3788 #if 0 /* REGC() is (currently) a NOP at the first pass.
3789        * Clever compilers notice this and complain. --jhi */
3790     REGC((U8)REG_MAGIC, (char*)RExC_emit);
3791 #endif
3792     DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log, "Starting first pass (sizing)\n"));
3793     if (reg(pRExC_state, 0, &flags,1) == NULL) {
3794         RExC_precomp = NULL;
3795         return(NULL);
3796     }
3797     DEBUG_PARSE_r({
3798         PerlIO_printf(Perl_debug_log,
3799             "Required size %"IVdf" nodes\n"
3800             "Starting second pass (creation)\n",
3801             (IV)RExC_size);
3802         RExC_lastnum=0;
3803         RExC_lastparse=NULL;
3804     });
3805     /* Small enough for pointer-storage convention?
3806        If extralen==0, this means that we will not need long jumps. */
3807     if (RExC_size >= 0x10000L && RExC_extralen)
3808         RExC_size += RExC_extralen;
3809     else
3810         RExC_extralen = 0;
3811     if (RExC_whilem_seen > 15)
3812         RExC_whilem_seen = 15;
3813
3814     /* Allocate space and zero-initialize. Note, the two step process
3815        of zeroing when in debug mode, thus anything assigned has to
3816        happen after that */
3817     Newxc(r, sizeof(regexp) + (unsigned)RExC_size * sizeof(regnode),
3818          char, regexp);
3819     if (r == NULL)
3820         FAIL("Regexp out of space");
3821 #ifdef DEBUGGING
3822     /* avoid reading uninitialized memory in DEBUGGING code in study_chunk() */
3823     Zero(r, sizeof(regexp) + (unsigned)RExC_size * sizeof(regnode), char);
3824 #endif
3825     /* initialization begins here */
3826     r->engine= RE_ENGINE_PTR;
3827     r->refcnt = 1;
3828     r->prelen = xend - exp;
3829     r->precomp = savepvn(RExC_precomp, r->prelen);
3830     r->subbeg = NULL;
3831 #ifdef PERL_OLD_COPY_ON_WRITE
3832     r->saved_copy = NULL;
3833 #endif
3834     r->reganch = pm->op_pmflags & PMf_COMPILETIME;
3835     r->nparens = RExC_npar - 1; /* set early to validate backrefs */
3836     r->lastparen = 0;                   /* mg.c reads this.  */
3837
3838     r->substrs = 0;                     /* Useful during FAIL. */
3839     r->startp = 0;                      /* Useful during FAIL. */
3840     r->endp = 0;
3841     r->paren_names = 0;
3842
3843     if (RExC_seen & REG_SEEN_RECURSE) {
3844         Newx(RExC_parens, RExC_npar,regnode *);
3845         SAVEFREEPV(RExC_parens);
3846     }
3847
3848     /* Useful during FAIL. */
3849     Newxz(r->offsets, 2*RExC_size+1, U32); /* MJD 20001228 */
3850     if (r->offsets) {
3851         r->offsets[0] = RExC_size;
3852     }
3853     DEBUG_OFFSETS_r(PerlIO_printf(Perl_debug_log,
3854                           "%s %"UVuf" bytes for offset annotations.\n",
3855                           r->offsets ? "Got" : "Couldn't get",
3856                           (UV)((2*RExC_size+1) * sizeof(U32))));
3857
3858     RExC_rx = r;
3859
3860     /* Second pass: emit code. */
3861     RExC_flags = pm->op_pmflags;        /* don't let top level (?i) bleed */
3862     RExC_parse = exp;
3863     RExC_end = xend;
3864     RExC_naughty = 0;
3865     RExC_npar = 1;
3866     RExC_emit_start = r->program;
3867     RExC_emit = r->program;
3868     /* Store the count of eval-groups for security checks: */
3869     RExC_emit->next_off = (RExC_seen_evals > (I32)U16_MAX) ? U16_MAX : (U16)RExC_seen_evals;
3870     REGC((U8)REG_MAGIC, (char*) RExC_emit++);
3871     r->data = 0;
3872     if (reg(pRExC_state, 0, &flags,1) == NULL)
3873         return(NULL);
3874
3875     /* XXXX To minimize changes to RE engine we always allocate
3876        3-units-long substrs field. */
3877     Newx(r->substrs, 1, struct reg_substr_data);
3878
3879 reStudy:
3880     r->minlen = minlen = sawplus = sawopen = 0;
3881     Zero(r->substrs, 1, struct reg_substr_data);
3882     StructCopy(&zero_scan_data, &data, scan_data_t);
3883
3884 #ifdef TRIE_STUDY_OPT
3885     if ( restudied ) {
3886         DEBUG_OPTIMISE_r(PerlIO_printf(Perl_debug_log,"Restudying\n"));
3887         RExC_state=copyRExC_state;
3888         if (data.last_found) {
3889             SvREFCNT_dec(data.longest_fixed);
3890             SvREFCNT_dec(data.longest_float);
3891             SvREFCNT_dec(data.last_found);
3892         }
3893     } else {
3894         copyRExC_state=RExC_state;
3895     }
3896 #endif
3897
3898     /* Dig out information for optimizations. */
3899     r->reganch = pm->op_pmflags & PMf_COMPILETIME; /* Again? */
3900     pm->op_pmflags = RExC_flags;
3901     if (UTF)
3902         r->reganch |= ROPT_UTF8;        /* Unicode in it? */
3903     r->regstclass = NULL;
3904     if (RExC_naughty >= 10)     /* Probably an expensive pattern. */
3905         r->reganch |= ROPT_NAUGHTY;
3906     scan = r->program + 1;              /* First BRANCH. */
3907
3908     /* testing for BRANCH here tells us whether there is "must appear"
3909        data in the pattern. If there is then we can use it for optimisations */
3910     if (!(RExC_seen & REG_TOP_LEVEL_BRANCHES)) { /*  Only one top-level choice. */
3911         I32 fake;
3912         STRLEN longest_float_length, longest_fixed_length;
3913         struct regnode_charclass_class ch_class; /* pointed to by data */
3914         int stclass_flag;
3915         I32 last_close = 0; /* pointed to by data */
3916
3917         first = scan;
3918         /* Skip introductions and multiplicators >= 1. */
3919         while ((OP(first) == OPEN && (sawopen = 1)) ||
3920                /* An OR of *one* alternative - should not happen now. */
3921             (OP(first) == BRANCH && OP(regnext(first)) != BRANCH) ||
3922             /* for now we can't handle lookbehind IFMATCH*/
3923             (OP(first) == IFMATCH && !first->flags) ||
3924             (OP(first) == PLUS) ||
3925             (OP(first) == MINMOD) ||
3926                /* An {n,m} with n>0 */
3927             (PL_regkind[OP(first)] == CURLY && ARG1(first) > 0) )
3928         {
3929
3930                 if (OP(first) == PLUS)
3931                     sawplus = 1;
3932                 else
3933                     first += regarglen[OP(first)];
3934                 if (OP(first) == IFMATCH) {
3935                     first = NEXTOPER(first);
3936                     first += EXTRA_STEP_2ARGS;
3937                 } else  /* XXX possible optimisation for /(?=)/  */
3938                     first = NEXTOPER(first);
3939         }
3940
3941         /* Starting-point info. */
3942       again:
3943         DEBUG_PEEP("first:",first,0);
3944         /* Ignore EXACT as we deal with it later. */
3945         if (PL_regkind[OP(first)] == EXACT) {
3946             if (OP(first) == EXACT)
3947                 NOOP;   /* Empty, get anchored substr later. */
3948             else if ((OP(first) == EXACTF || OP(first) == EXACTFL))
3949                 r->regstclass = first;
3950         }
3951 #ifdef TRIE_STCLASS
3952         else if (PL_regkind[OP(first)] == TRIE &&
3953                 ((reg_trie_data *)r->data->data[ ARG(first) ])->minlen>0)
3954         {
3955             regnode *trie_op;
3956             /* this can happen only on restudy */
3957             if ( OP(first) == TRIE ) {
3958                 struct regnode_1 *trieop;
3959                 Newxz(trieop,1,struct regnode_1);
3960                 StructCopy(first,trieop,struct regnode_1);
3961                 trie_op=(regnode *)trieop;
3962             } else {
3963                 struct regnode_charclass *trieop;
3964                 Newxz(trieop,1,struct regnode_charclass);
3965                 StructCopy(first,trieop,struct regnode_charclass);
3966                 trie_op=(regnode *)trieop;
3967             }
3968             OP(trie_op)+=2;
3969             make_trie_failtable(pRExC_state, (regnode *)first, trie_op, 0);
3970             r->regstclass = trie_op;
3971         }
3972 #endif
3973         else if (strchr((const char*)PL_simple,OP(first)))
3974             r->regstclass = first;
3975         else if (PL_regkind[OP(first)] == BOUND ||
3976                  PL_regkind[OP(first)] == NBOUND)
3977             r->regstclass = first;
3978         else if (PL_regkind[OP(first)] == BOL) {
3979             r->reganch |= (OP(first) == MBOL
3980                            ? ROPT_ANCH_MBOL
3981                            : (OP(first) == SBOL
3982                               ? ROPT_ANCH_SBOL
3983                               : ROPT_ANCH_BOL));
3984             first = NEXTOPER(first);
3985             goto again;
3986         }
3987         else if (OP(first) == GPOS) {
3988             r->reganch |= ROPT_ANCH_GPOS;
3989             first = NEXTOPER(first);
3990             goto again;
3991         }
3992         else if (!sawopen && (OP(first) == STAR &&
3993             PL_regkind[OP(NEXTOPER(first))] == REG_ANY) &&
3994             !(r->reganch & ROPT_ANCH) )
3995         {
3996             /* turn .* into ^.* with an implied $*=1 */
3997             const int type =
3998                 (OP(NEXTOPER(first)) == REG_ANY)
3999                     ? ROPT_ANCH_MBOL
4000                     : ROPT_ANCH_SBOL;
4001             r->reganch |= type | ROPT_IMPLICIT;
4002             first = NEXTOPER(first);
4003             goto again;
4004         }
4005         if (sawplus && (!sawopen || !RExC_sawback)
4006             && !(RExC_seen & REG_SEEN_EVAL)) /* May examine pos and $& */
4007             /* x+ must match at the 1st pos of run of x's */
4008             r->reganch |= ROPT_SKIP;
4009
4010         /* Scan is after the zeroth branch, first is atomic matcher. */
4011 #ifdef TRIE_STUDY_OPT
4012         DEBUG_PARSE_r(
4013             if (!restudied)
4014                 PerlIO_printf(Perl_debug_log, "first at %"IVdf"\n",
4015                               (IV)(first - scan + 1))
4016         );
4017 #else
4018         DEBUG_PARSE_r(
4019             PerlIO_printf(Perl_debug_log, "first at %"IVdf"\n",
4020                 (IV)(first - scan + 1))
4021         );
4022 #endif
4023
4024
4025         /*
4026         * If there's something expensive in the r.e., find the
4027         * longest literal string that must appear and make it the
4028         * regmust.  Resolve ties in favor of later strings, since
4029         * the regstart check works with the beginning of the r.e.
4030         * and avoiding duplication strengthens checking.  Not a
4031         * strong reason, but sufficient in the absence of others.
4032         * [Now we resolve ties in favor of the earlier string if
4033         * it happens that c_offset_min has been invalidated, since the
4034         * earlier string may buy us something the later one won't.]
4035         */
4036         minlen = 0;
4037
4038         data.longest_fixed = newSVpvs("");
4039         data.longest_float = newSVpvs("");
4040         data.last_found = newSVpvs("");
4041         data.longest = &(data.longest_fixed);
4042         first = scan;
4043         if (!r->regstclass) {
4044             cl_init(pRExC_state, &ch_class);
4045             data.start_class = &ch_class;
4046             stclass_flag = SCF_DO_STCLASS_AND;
4047         } else                          /* XXXX Check for BOUND? */
4048             stclass_flag = 0;
4049         data.last_closep = &last_close;
4050
4051         minlen = study_chunk(pRExC_state, &first, &minlen, &fake, scan + RExC_size, /* Up to end */
4052                              &data, SCF_DO_SUBSTR | SCF_WHILEM_VISITED_POS | stclass_flag,0);
4053
4054
4055         CHECK_RESTUDY_GOTO;
4056
4057
4058         if ( RExC_npar == 1 && data.longest == &(data.longest_fixed)
4059              && data.last_start_min == 0 && data.last_end > 0
4060              && !RExC_seen_zerolen
4061              && (!(RExC_seen & REG_SEEN_GPOS) || (r->reganch & ROPT_ANCH_GPOS)))
4062             r->reganch |= ROPT_CHECK_ALL;
4063         scan_commit(pRExC_state, &data,&minlen);
4064         SvREFCNT_dec(data.last_found);
4065
4066         /* Note that code very similar to this but for anchored string
4067            follows immediately below, changes may need to be made to both.
4068            Be careful.
4069          */
4070         longest_float_length = CHR_SVLEN(data.longest_float);
4071         if (longest_float_length
4072             || (data.flags & SF_FL_BEFORE_EOL
4073                 && (!(data.flags & SF_FL_BEFORE_MEOL)
4074                     || (RExC_flags & PMf_MULTILINE))))
4075         {
4076             I32 t,ml;
4077
4078             if (SvCUR(data.longest_fixed)  /* ok to leave SvCUR */
4079                 && data.offset_fixed == data.offset_float_min
4080                 && SvCUR(data.longest_fixed) == SvCUR(data.longest_float))
4081                     goto remove_float;          /* As in (a)+. */
4082
4083             /* copy the information about the longest float from the reg_scan_data
4084                over to the program. */
4085             if (SvUTF8(data.longest_float)) {
4086                 r->float_utf8 = data.longest_float;
4087                 r->float_substr = NULL;
4088             } else {
4089                 r->float_substr = data.longest_float;
4090                 r->float_utf8 = NULL;
4091             }
4092             /* float_end_shift is how many chars that must be matched that
4093                follow this item. We calculate it ahead of time as once the
4094                lookbehind offset is added in we lose the ability to correctly
4095                calculate it.*/
4096             ml = data.minlen_float ? *(data.minlen_float)
4097                                    : (I32)longest_float_length;
4098             r->float_end_shift = ml - data.offset_float_min
4099                 - longest_float_length + (SvTAIL(data.longest_float) != 0)
4100                 + data.lookbehind_float;
4101             r->float_min_offset = data.offset_float_min - data.lookbehind_float;
4102             r->float_max_offset = data.offset_float_max;
4103             if (data.offset_float_max < I32_MAX) /* Don't offset infinity */
4104                 r->float_max_offset -= data.lookbehind_float;
4105
4106             t = (data.flags & SF_FL_BEFORE_EOL /* Can't have SEOL and MULTI */
4107                        && (!(data.flags & SF_FL_BEFORE_MEOL)
4108                            || (RExC_flags & PMf_MULTILINE)));
4109             fbm_compile(data.longest_float, t ? FBMcf_TAIL : 0);
4110         }
4111         else {
4112           remove_float:
4113             r->float_substr = r->float_utf8 = NULL;
4114             SvREFCNT_dec(data.longest_float);
4115             longest_float_length = 0;
4116         }
4117
4118         /* Note that code very similar to this but for floating string
4119            is immediately above, changes may need to be made to both.
4120            Be careful.
4121          */
4122         longest_fixed_length = CHR_SVLEN(data.longest_fixed);
4123         if (longest_fixed_length
4124             || (data.flags & SF_FIX_BEFORE_EOL /* Cannot have SEOL and MULTI */
4125                 && (!(data.flags & SF_FIX_BEFORE_MEOL)
4126                     || (RExC_flags & PMf_MULTILINE))))
4127         {
4128             I32 t,ml;
4129
4130             /* copy the information about the longest fixed
4131                from the reg_scan_data over to the program. */
4132             if (SvUTF8(data.longest_fixed)) {
4133                 r->anchored_utf8 = data.longest_fixed;
4134                 r->anchored_substr = NULL;
4135             } else {
4136                 r->anchored_substr = data.longest_fixed;
4137                 r->anchored_utf8 = NULL;
4138             }
4139             /* fixed_end_shift is how many chars that must be matched that
4140                follow this item. We calculate it ahead of time as once the
4141                lookbehind offset is added in we lose the ability to correctly
4142                calculate it.*/
4143             ml = data.minlen_fixed ? *(data.minlen_fixed)
4144                                    : (I32)longest_fixed_length;
4145             r->anchored_end_shift = ml - data.offset_fixed
4146                 - longest_fixed_length + (SvTAIL(data.longest_fixed) != 0)
4147                 + data.lookbehind_fixed;
4148             r->anchored_offset = data.offset_fixed - data.lookbehind_fixed;
4149
4150             t = (data.flags & SF_FIX_BEFORE_EOL /* Can't have SEOL and MULTI */
4151                  && (!(data.flags & SF_FIX_BEFORE_MEOL)
4152                      || (RExC_flags & PMf_MULTILINE)));
4153             fbm_compile(data.longest_fixed, t ? FBMcf_TAIL : 0);
4154         }
4155         else {
4156             r->anchored_substr = r->anchored_utf8 = NULL;
4157             SvREFCNT_dec(data.longest_fixed);
4158             longest_fixed_length = 0;
4159         }
4160         if (r->regstclass
4161             && (OP(r->regstclass) == REG_ANY || OP(r->regstclass) == SANY))
4162             r->regstclass = NULL;
4163         if ((!(r->anchored_substr || r->anchored_utf8) || r->anchored_offset)
4164             && stclass_flag
4165             && !(data.start_class->flags & ANYOF_EOS)
4166             && !cl_is_anything(data.start_class))
4167         {
4168             const I32 n = add_data(pRExC_state, 1, "f");
4169
4170             Newx(RExC_rx->data->data[n], 1,
4171                 struct regnode_charclass_class);
4172             StructCopy(data.start_class,
4173                        (struct regnode_charclass_class*)RExC_rx->data->data[n],
4174                        struct regnode_charclass_class);
4175             r->regstclass = (regnode*)RExC_rx->data->data[n];
4176             r->reganch &= ~ROPT_SKIP;   /* Used in find_byclass(). */
4177             DEBUG_COMPILE_r({ SV *sv = sv_newmortal();
4178                       regprop(r, sv, (regnode*)data.start_class);
4179                       PerlIO_printf(Perl_debug_log,
4180                                     "synthetic stclass \"%s\".\n",
4181                                     SvPVX_const(sv));});
4182         }
4183
4184         /* A temporary algorithm prefers floated substr to fixed one to dig more info. */
4185         if (longest_fixed_length > longest_float_length) {
4186             r->check_end_shift = r->anchored_end_shift;
4187             r->check_substr = r->anchored_substr;
4188             r->check_utf8 = r->anchored_utf8;
4189             r->check_offset_min = r->check_offset_max = r->anchored_offset;
4190             if (r->reganch & ROPT_ANCH_SINGLE)
4191                 r->reganch |= ROPT_NOSCAN;
4192         }
4193         else {
4194             r->check_end_shift = r->float_end_shift;
4195             r->check_substr = r->float_substr;
4196             r->check_utf8 = r->float_utf8;
4197             r->check_offset_min = r->float_min_offset;
4198             r->check_offset_max = r->float_max_offset;
4199         }
4200         /* XXXX Currently intuiting is not compatible with ANCH_GPOS.
4201            This should be changed ASAP!  */
4202         if ((r->check_substr || r->check_utf8) && !(r->reganch & ROPT_ANCH_GPOS)) {
4203             r->reganch |= RE_USE_INTUIT;
4204             if (SvTAIL(r->check_substr ? r->check_substr : r->check_utf8))
4205                 r->reganch |= RE_INTUIT_TAIL;
4206         }
4207         /* XXX Unneeded? dmq (shouldn't as this is handled elsewhere)
4208         if ( (STRLEN)minlen < longest_float_length )
4209             minlen= longest_float_length;
4210         if ( (STRLEN)minlen < longest_fixed_length )
4211             minlen= longest_fixed_length;
4212         */
4213     }
4214     else {
4215         /* Several toplevels. Best we can is to set minlen. */
4216         I32 fake;
4217         struct regnode_charclass_class ch_class;
4218         I32 last_close = 0;
4219
4220         DEBUG_COMPILE_r(PerlIO_printf(Perl_debug_log, "\n"));
4221
4222         scan = r->program + 1;
4223         cl_init(pRExC_state, &ch_class);
4224         data.start_class = &ch_class;
4225         data.last_closep = &last_close;
4226
4227         minlen = study_chunk(pRExC_state, &scan, &minlen, &fake, scan + RExC_size,
4228             &data, SCF_DO_STCLASS_AND|SCF_WHILEM_VISITED_POS,0);
4229
4230         CHECK_RESTUDY_GOTO;
4231
4232         r->check_substr = r->check_utf8 = r->anchored_substr = r->anchored_utf8
4233                 = r->float_substr = r->float_utf8 = NULL;
4234         if (!(data.start_class->flags & ANYOF_EOS)
4235             && !cl_is_anything(data.start_class))
4236         {
4237             const I32 n = add_data(pRExC_state, 1, "f");
4238
4239             Newx(RExC_rx->data->data[n], 1,
4240                 struct regnode_charclass_class);
4241             StructCopy(data.start_class,
4242                        (struct regnode_charclass_class*)RExC_rx->data->data[n],
4243                        struct regnode_charclass_class);
4244             r->regstclass = (regnode*)RExC_rx->data->data[n];
4245             r->reganch &= ~ROPT_SKIP;   /* Used in find_byclass(). */
4246             DEBUG_COMPILE_r({ SV* sv = sv_newmortal();
4247                       regprop(r, sv, (regnode*)data.start_class);
4248                       PerlIO_printf(Perl_debug_log,
4249                                     "synthetic stclass \"%s\".\n",
4250                                     SvPVX_const(sv));});
4251         }
4252     }
4253
4254     /* Guard against an embedded (?=) or (?<=) with a longer minlen than
4255        the "real" pattern. */
4256     if (r->minlen < minlen)
4257         r->minlen = minlen;
4258
4259     if (RExC_seen & REG_SEEN_GPOS)
4260         r->reganch |= ROPT_GPOS_SEEN;
4261     if (RExC_seen & REG_SEEN_LOOKBEHIND)
4262         r->reganch |= ROPT_LOOKBEHIND_SEEN;
4263     if (RExC_seen & REG_SEEN_EVAL)
4264         r->reganch |= ROPT_EVAL_SEEN;
4265     if (RExC_seen & REG_SEEN_CANY)
4266         r->reganch |= ROPT_CANY_SEEN;
4267     if (RExC_paren_names)
4268         r->paren_names = (HV*)SvREFCNT_inc(RExC_paren_names);
4269     else
4270         r->paren_names = NULL;
4271
4272     Newxz(r->startp, RExC_npar, I32);
4273     Newxz(r->endp, RExC_npar, I32);
4274
4275     DEBUG_r( RX_DEBUG_on(r) );
4276     DEBUG_DUMP_r({
4277         PerlIO_printf(Perl_debug_log,"Final program:\n");
4278         regdump(r);
4279     });
4280     DEBUG_OFFSETS_r(if (r->offsets) {
4281         const U32 len = r->offsets[0];
4282         U32 i;
4283         GET_RE_DEBUG_FLAGS_DECL;
4284         PerlIO_printf(Perl_debug_log, "Offsets: [%"UVuf"]\n\t", (UV)r->offsets[0]);
4285         for (i = 1; i <= len; i++) {
4286             if (r->offsets[i*2-1] || r->offsets[i*2])
4287                 PerlIO_printf(Perl_debug_log, "%"UVuf":%"UVuf"[%"UVuf"] ",
4288                 (UV)i, (UV)r->offsets[i*2-1], (UV)r->offsets[i*2]);
4289             }
4290         PerlIO_printf(Perl_debug_log, "\n");
4291     });
4292     return(r);
4293     END_BLOCK
4294 }
4295
4296 #undef CORE_ONLY_BLOCK
4297 #undef END_BLOCK
4298 #undef RE_ENGINE_PTR
4299
4300 #ifndef PERL_IN_XSUB_RE
4301 SV*
4302 Perl_reg_named_buff_sv(pTHX_ SV* namesv)
4303 {
4304     I32 parno = 0; /* no match */
4305     if (PL_curpm) {
4306         const REGEXP * const rx = PM_GETRE(PL_curpm);
4307         if (rx && rx->paren_names) {
4308             HE *he_str = hv_fetch_ent( rx->paren_names, namesv, 0, 0 );
4309             if (he_str) {
4310                 IV i;
4311                 SV* sv_dat=HeVAL(he_str);
4312                 I32 *nums=(I32*)SvPVX(sv_dat);
4313                 for ( i=0; i<SvIVX(sv_dat); i++ ) {
4314                     if ((I32)(rx->lastparen) >= nums[i] &&
4315                         rx->endp[nums[i]] != -1)
4316                     {
4317                         parno = nums[i];
4318                         break;
4319                     }
4320                 }
4321             }
4322         }
4323     }
4324     if ( !parno ) {
4325         return 0;
4326     } else {
4327         GV *gv_paren;
4328         SV *sv= sv_newmortal();
4329         Perl_sv_setpvf(aTHX_ sv, "%"IVdf,(IV)parno);
4330         gv_paren= Perl_gv_fetchsv(aTHX_ sv, GV_ADD, SVt_PVGV);
4331         return GvSVn(gv_paren);
4332     }
4333 }
4334 #endif
4335
4336 /* Scans the name of a named buffer from the pattern.
4337  * If flags is REG_RSN_RETURN_NULL returns null.
4338  * If flags is REG_RSN_RETURN_NAME returns an SV* containing the name
4339  * If flags is REG_RSN_RETURN_DATA returns the data SV* corresponding
4340  * to the parsed name as looked up in the RExC_paren_names hash.
4341  * If there is an error throws a vFAIL().. type exception.
4342  */
4343
4344 #define REG_RSN_RETURN_NULL    0
4345 #define REG_RSN_RETURN_NAME    1
4346 #define REG_RSN_RETURN_DATA    2
4347
4348 STATIC SV*
4349 S_reg_scan_name(pTHX_ RExC_state_t *pRExC_state, U32 flags) {
4350     char *name_start = RExC_parse;
4351     if ( UTF ) {
4352         STRLEN numlen;
4353         while( isIDFIRST_uni(utf8n_to_uvchr((U8*)RExC_parse,
4354             RExC_end - RExC_parse, &numlen, UTF8_ALLOW_DEFAULT)))
4355         {
4356                 RExC_parse += numlen;
4357         }
4358     } else {
4359         while( isIDFIRST(*RExC_parse) )
4360             RExC_parse++;
4361     }
4362     if ( flags ) {
4363         SV* sv_name = sv_2mortal(Perl_newSVpvn(aTHX_ name_start,
4364             (int)(RExC_parse - name_start)));
4365         if (UTF)
4366             SvUTF8_on(sv_name);
4367         if ( flags == REG_RSN_RETURN_NAME)
4368             return sv_name;
4369         else if (flags==REG_RSN_RETURN_DATA) {
4370             HE *he_str = NULL;
4371             SV *sv_dat = NULL;
4372             if ( ! sv_name )      /* should not happen*/
4373                 Perl_croak(aTHX_ "panic: no svname in reg_scan_name");
4374             if (RExC_paren_names)
4375                 he_str = hv_fetch_ent( RExC_paren_names, sv_name, 0, 0 );
4376             if ( he_str )
4377                 sv_dat = HeVAL(he_str);
4378             if ( ! sv_dat )
4379                 vFAIL("Reference to nonexistent named group");
4380             return sv_dat;
4381         }
4382         else {
4383             Perl_croak(aTHX_ "panic: bad flag in reg_scan_name");
4384         }
4385         /* NOT REACHED */
4386     }
4387     return NULL;
4388 }
4389
4390 #define DEBUG_PARSE_MSG(funcname)     DEBUG_PARSE_r({           \
4391     int rem=(int)(RExC_end - RExC_parse);                       \
4392     int cut;                                                    \
4393     int num;                                                    \
4394     int iscut=0;                                                \
4395     if (rem>10) {                                               \
4396         rem=10;                                                 \
4397         iscut=1;                                                \
4398     }                                                           \
4399     cut=10-rem;                                                 \
4400     if (RExC_lastparse!=RExC_parse)                             \
4401         PerlIO_printf(Perl_debug_log," >%.*s%-*s",              \
4402             rem, RExC_parse,                                    \
4403             cut + 4,                                            \
4404             iscut ? "..." : "<"                                 \
4405         );                                                      \
4406     else                                                        \
4407         PerlIO_printf(Perl_debug_log,"%16s","");                \
4408                                                                 \
4409     if (SIZE_ONLY)                                              \
4410        num=RExC_size;                                           \
4411     else                                                        \
4412        num=REG_NODE_NUM(RExC_emit);                             \
4413     if (RExC_lastnum!=num)                                      \
4414        PerlIO_printf(Perl_debug_log,"|%4d",num);                \
4415     else                                                        \
4416        PerlIO_printf(Perl_debug_log,"|%4s","");                 \
4417     PerlIO_printf(Perl_debug_log,"|%*s%-4s",                    \
4418         (int)((depth*2)), "",                                   \
4419         (funcname)                                              \
4420     );                                                          \
4421     RExC_lastnum=num;                                           \
4422     RExC_lastparse=RExC_parse;                                  \
4423 })
4424
4425
4426
4427 #define DEBUG_PARSE(funcname)     DEBUG_PARSE_r({           \
4428     DEBUG_PARSE_MSG((funcname));                            \
4429     PerlIO_printf(Perl_debug_log,"%4s","\n");               \
4430 })
4431 #define DEBUG_PARSE_FMT(funcname,fmt,args)     DEBUG_PARSE_r({           \
4432     DEBUG_PARSE_MSG((funcname));                            \
4433     PerlIO_printf(Perl_debug_log,fmt "\n",args);               \
4434 })
4435 /*
4436  - reg - regular expression, i.e. main body or parenthesized thing
4437  *
4438  * Caller must absorb opening parenthesis.
4439  *
4440  * Combining parenthesis handling with the base level of regular expression
4441  * is a trifle forced, but the need to tie the tails of the branches to what
4442  * follows makes it hard to avoid.
4443  */
4444 #define REGTAIL(x,y,z) regtail((x),(y),(z),depth+1)
4445 #ifdef DEBUGGING
4446 #define REGTAIL_STUDY(x,y,z) regtail_study((x),(y),(z),depth+1)
4447 #else
4448 #define REGTAIL_STUDY(x,y,z) regtail((x),(y),(z),depth+1)
4449 #endif
4450
4451 STATIC regnode *
4452 S_reg(pTHX_ RExC_state_t *pRExC_state, I32 paren, I32 *flagp,U32 depth)
4453     /* paren: Parenthesized? 0=top, 1=(, inside: changed to letter. */
4454 {
4455     dVAR;
4456     register regnode *ret;              /* Will be the head of the group. */
4457     register regnode *br;
4458     register regnode *lastbr;
4459     register regnode *ender = NULL;
4460     register I32 parno = 0;
4461     I32 flags;
4462     const I32 oregflags = RExC_flags;
4463     bool have_branch = 0;
4464     bool is_open = 0;
4465
4466     /* for (?g), (?gc), and (?o) warnings; warning
4467        about (?c) will warn about (?g) -- japhy    */
4468
4469 #define WASTED_O  0x01
4470 #define WASTED_G  0x02
4471 #define WASTED_C  0x04
4472 #define WASTED_GC (0x02|0x04)
4473     I32 wastedflags = 0x00;
4474
4475     char * parse_start = RExC_parse; /* MJD */
4476     char * const oregcomp_parse = RExC_parse;
4477
4478     GET_RE_DEBUG_FLAGS_DECL;
4479     DEBUG_PARSE("reg ");
4480
4481
4482     *flagp = 0;                         /* Tentatively. */
4483
4484
4485     /* Make an OPEN node, if parenthesized. */
4486     if (paren) {
4487         if (*RExC_parse == '?') { /* (?...) */
4488             U32 posflags = 0, negflags = 0;
4489             U32 *flagsp = &posflags;
4490             bool is_logical = 0;
4491             const char * const seqstart = RExC_parse;
4492
4493             RExC_parse++;
4494             paren = *RExC_parse++;
4495             ret = NULL;                 /* For look-ahead/behind. */
4496             switch (paren) {
4497
4498             case '<':           /* (?<...) */
4499                 if (*RExC_parse == '!')
4500                     paren = ',';
4501                 else if (*RExC_parse != '=')
4502                 {               /* (?<...>) */
4503                     char *name_start;
4504                     SV *svname;
4505                     paren= '>';
4506             case '\'':          /* (?'...') */
4507                     name_start= RExC_parse;
4508                     svname = reg_scan_name(pRExC_state,
4509                         SIZE_ONLY ?  /* reverse test from the others */
4510                         REG_RSN_RETURN_NAME :
4511                         REG_RSN_RETURN_NULL);
4512                     if (RExC_parse == name_start)
4513                         goto unknown;
4514                     if (*RExC_parse != paren)
4515                         vFAIL2("Sequence (?%c... not terminated",
4516                             paren=='>' ? '<' : paren);
4517                     if (SIZE_ONLY) {
4518                         HE *he_str;
4519                         SV *sv_dat = NULL;
4520                         if (!svname) /* shouldnt happen */
4521                             Perl_croak(aTHX_
4522                                 "panic: reg_scan_name returned NULL");
4523                         if (!RExC_paren_names) {
4524                             RExC_paren_names= newHV();
4525                             sv_2mortal((SV*)RExC_paren_names);
4526                         }
4527                         he_str = hv_fetch_ent( RExC_paren_names, svname, 1, 0 );
4528                         if ( he_str )
4529                             sv_dat = HeVAL(he_str);
4530                         if ( ! sv_dat ) {
4531                             /* croak baby croak */
4532                             Perl_croak(aTHX_
4533                                 "panic: paren_name hash element allocation failed");
4534                         } else if ( SvPOK(sv_dat) ) {
4535                             IV count=SvIV(sv_dat);
4536                             I32 *pv=(I32*)SvGROW(sv_dat,SvCUR(sv_dat)+sizeof(I32)+1);
4537                             SvCUR_set(sv_dat,SvCUR(sv_dat)+sizeof(I32));
4538                             pv[count]=RExC_npar;
4539                             SvIVX(sv_dat)++;
4540                         } else {
4541                             (void)SvUPGRADE(sv_dat,SVt_PVNV);
4542                             sv_setpvn(sv_dat, (char *)&(RExC_npar), sizeof(I32));
4543                             SvIOK_on(sv_dat);
4544                             SvIVX(sv_dat)= 1;
4545                         }
4546
4547                         /*sv_dump(sv_dat);*/
4548                     }
4549                     nextchar(pRExC_state);
4550                     paren = 1;
4551                     goto capturing_parens;
4552                 }
4553                 RExC_seen |= REG_SEEN_LOOKBEHIND;
4554                 RExC_parse++;
4555             case '=':           /* (?=...) */
4556             case '!':           /* (?!...) */
4557                 RExC_seen_zerolen++;
4558             case ':':           /* (?:...) */
4559             case '>':           /* (?>...) */
4560                 break;
4561             case '$':           /* (?$...) */
4562             case '@':           /* (?@...) */
4563                 vFAIL2("Sequence (?%c...) not implemented", (int)paren);
4564                 break;
4565             case '#':           /* (?#...) */
4566                 while (*RExC_parse && *RExC_parse != ')')
4567                     RExC_parse++;
4568                 if (*RExC_parse != ')')
4569                     FAIL("Sequence (?#... not terminated");
4570                 nextchar(pRExC_state);
4571                 *flagp = TRYAGAIN;
4572                 return NULL;
4573             case '0' :           /* (?0) */
4574             case 'R' :           /* (?R) */
4575                 if (*RExC_parse != ')')
4576                     FAIL("Sequence (?R) not terminated");
4577                 reg_node(pRExC_state, SRECURSE);
4578                 break;           /* (?PARNO) */
4579             { /* named and numeric backreferences */
4580                 I32 num;
4581                 char * parse_start;
4582             case '&':            /* (?&NAME) */
4583                 parse_start = RExC_parse - 1;
4584                 {
4585                     SV *sv_dat = reg_scan_name(pRExC_state,
4586                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
4587                      num = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
4588                 }
4589                 goto gen_recurse_regop;
4590                 /* NOT REACHED */
4591             case '1': case '2': case '3': case '4': /* (?1) */
4592             case '5': case '6': case '7': case '8': case '9':
4593                 RExC_parse--;
4594                 num = atoi(RExC_parse);
4595                 parse_start = RExC_parse - 1; /* MJD */
4596                 while (isDIGIT(*RExC_parse))
4597                         RExC_parse++;
4598                 if (*RExC_parse!=')')
4599                     vFAIL("Expecting close bracket");
4600
4601               gen_recurse_regop:
4602                 ret = reganode(pRExC_state, RECURSE, num);
4603                 if (!SIZE_ONLY) {
4604                     if (num > (I32)RExC_rx->nparens) {
4605                         RExC_parse++;
4606                         vFAIL("Reference to nonexistent group");
4607                     }
4608                     ARG2L_SET( ret, 0);
4609                     RExC_emit++;
4610                     DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
4611                         "Recurse #%"UVuf" to %"IVdf"\n", (UV)ARG(ret), (IV)ARG2L(ret)));
4612                 } else {
4613                     RExC_size++;
4614                 }
4615                 RExC_seen |= REG_SEEN_RECURSE;
4616                 Set_Node_Length(ret, 1 + regarglen[OP(ret)]); /* MJD */
4617                 Set_Node_Offset(ret, parse_start); /* MJD */
4618
4619                 nextchar(pRExC_state);
4620                 return ret;
4621             } /* named and numeric backreferences */
4622             /* NOT REACHED */
4623
4624             case 'p':           /* (?p...) */
4625                 if (SIZE_ONLY && ckWARN2(WARN_DEPRECATED, WARN_REGEXP))
4626                     vWARNdep(RExC_parse, "(?p{}) is deprecated - use (??{})");
4627                 /* FALL THROUGH*/
4628             case '?':           /* (??...) */
4629                 is_logical = 1;
4630                 if (*RExC_parse != '{')
4631                     goto unknown;
4632                 paren = *RExC_parse++;
4633                 /* FALL THROUGH */
4634             case '{':           /* (?{...}) */
4635             {
4636                 I32 count = 1, n = 0;
4637                 char c;
4638                 char *s = RExC_parse;
4639
4640                 RExC_seen_zerolen++;
4641                 RExC_seen |= REG_SEEN_EVAL;
4642                 while (count && (c = *RExC_parse)) {
4643                     if (c == '\\') {
4644                         if (RExC_parse[1])
4645                             RExC_parse++;
4646                     }
4647                     else if (c == '{')
4648                         count++;
4649                     else if (c == '}')
4650                         count--;
4651                     RExC_parse++;
4652                 }
4653                 if (*RExC_parse != ')') {
4654                     RExC_parse = s;
4655                     vFAIL("Sequence (?{...}) not terminated or not {}-balanced");
4656                 }
4657                 if (!SIZE_ONLY) {
4658                     PAD *pad;
4659                     OP_4tree *sop, *rop;
4660                     SV * const sv = newSVpvn(s, RExC_parse - 1 - s);
4661
4662                     ENTER;
4663                     Perl_save_re_context(aTHX);
4664                     rop = sv_compile_2op(sv, &sop, "re", &pad);
4665                     sop->op_private |= OPpREFCOUNTED;
4666                     /* re_dup will OpREFCNT_inc */
4667                     OpREFCNT_set(sop, 1);
4668                     LEAVE;
4669
4670                     n = add_data(pRExC_state, 3, "nop");
4671                     RExC_rx->data->data[n] = (void*)rop;
4672                     RExC_rx->data->data[n+1] = (void*)sop;
4673                     RExC_rx->data->data[n+2] = (void*)pad;
4674                     SvREFCNT_dec(sv);
4675                 }
4676                 else {                                          /* First pass */
4677                     if (PL_reginterp_cnt < ++RExC_seen_evals
4678                         && IN_PERL_RUNTIME)
4679                         /* No compiled RE interpolated, has runtime
4680                            components ===> unsafe.  */
4681                         FAIL("Eval-group not allowed at runtime, use re 'eval'");
4682                     if (PL_tainting && PL_tainted)
4683                         FAIL("Eval-group in insecure regular expression");
4684 #if PERL_VERSION > 8
4685                     if (IN_PERL_COMPILETIME)
4686                         PL_cv_has_eval = 1;
4687 #endif
4688                 }
4689
4690                 nextchar(pRExC_state);
4691                 if (is_logical) {
4692                     ret = reg_node(pRExC_state, LOGICAL);
4693                     if (!SIZE_ONLY)
4694                         ret->flags = 2;
4695                     REGTAIL(pRExC_state, ret, reganode(pRExC_state, EVAL, n));
4696                     /* deal with the length of this later - MJD */
4697                     return ret;
4698                 }
4699                 ret = reganode(pRExC_state, EVAL, n);
4700                 Set_Node_Length(ret, RExC_parse - parse_start + 1);
4701                 Set_Node_Offset(ret, parse_start);
4702                 return ret;
4703             }
4704             case '(':           /* (?(?{...})...) and (?(?=...)...) */
4705             {
4706                 int is_define= 0;
4707                 if (RExC_parse[0] == '?') {        /* (?(?...)) */
4708                     if (RExC_parse[1] == '=' || RExC_parse[1] == '!'
4709                         || RExC_parse[1] == '<'
4710                         || RExC_parse[1] == '{') { /* Lookahead or eval. */
4711                         I32 flag;
4712
4713                         ret = reg_node(pRExC_state, LOGICAL);
4714                         if (!SIZE_ONLY)
4715                             ret->flags = 1;
4716                         REGTAIL(pRExC_state, ret, reg(pRExC_state, 1, &flag,depth+1));
4717                         goto insert_if;
4718                     }
4719                 }
4720                 else if ( RExC_parse[0] == '<'     /* (?(<NAME>)...) */
4721                          || RExC_parse[0] == '\'' ) /* (?('NAME')...) */
4722                 {
4723                     char ch = RExC_parse[0] == '<' ? '>' : '\'';
4724                     char *name_start= RExC_parse++;
4725                     I32 num = 0;
4726                     SV *sv_dat=reg_scan_name(pRExC_state,
4727                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
4728                     if (RExC_parse == name_start || *RExC_parse != ch)
4729                         vFAIL2("Sequence (?(%c... not terminated",
4730                             (ch == '>' ? '<' : ch));
4731                     RExC_parse++;
4732                     if (!SIZE_ONLY) {
4733                         num = add_data( pRExC_state, 1, "S" );
4734                         RExC_rx->data->data[num]=(void*)sv_dat;
4735                         SvREFCNT_inc(sv_dat);
4736                     }
4737                     ret = reganode(pRExC_state,NGROUPP,num);
4738                     goto insert_if_check_paren;
4739                 }
4740                 else if (RExC_parse[0] == 'D' &&
4741                          RExC_parse[1] == 'E' &&
4742                          RExC_parse[2] == 'F' &&
4743                          RExC_parse[3] == 'I' &&
4744                          RExC_parse[4] == 'N' &&
4745                          RExC_parse[5] == 'E')
4746                 {
4747                     ret = reganode(pRExC_state,DEFINEP,0);
4748                     RExC_parse +=6 ;
4749                     is_define = 1;
4750                     goto insert_if_check_paren;
4751                 }
4752                 else if (RExC_parse[0] == 'R') {
4753                     RExC_parse++;
4754                     parno = 0;
4755                     if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
4756                         parno = atoi(RExC_parse++);
4757                         while (isDIGIT(*RExC_parse))
4758                             RExC_parse++;
4759                     } else if (RExC_parse[0] == '&') {
4760                         SV *sv_dat;
4761                         RExC_parse++;
4762                         sv_dat = reg_scan_name(pRExC_state,
4763                             SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
4764                         parno = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
4765                     }
4766                     ret = reganode(pRExC_state,RECURSEP,parno);
4767                     goto insert_if_check_paren;
4768                 }
4769                 else if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
4770                     /* (?(1)...) */
4771                     char c;
4772                     parno = atoi(RExC_parse++);
4773
4774                     while (isDIGIT(*RExC_parse))
4775                         RExC_parse++;
4776                     ret = reganode(pRExC_state, GROUPP, parno);
4777
4778                  insert_if_check_paren:
4779                     if ((c = *nextchar(pRExC_state)) != ')')
4780                         vFAIL("Switch condition not recognized");
4781                   insert_if:
4782                     REGTAIL(pRExC_state, ret, reganode(pRExC_state, IFTHEN, 0));
4783                     br = regbranch(pRExC_state, &flags, 1,depth+1);
4784                     if (br == NULL)
4785                         br = reganode(pRExC_state, LONGJMP, 0);
4786                     else
4787                         REGTAIL(pRExC_state, br, reganode(pRExC_state, LONGJMP, 0));
4788                     c = *nextchar(pRExC_state);
4789                     if (flags&HASWIDTH)
4790                         *flagp |= HASWIDTH;
4791                     if (c == '|') {
4792                         if (is_define)
4793                             vFAIL("(?(DEFINE)....) does not allow branches");
4794                         lastbr = reganode(pRExC_state, IFTHEN, 0); /* Fake one for optimizer. */
4795                         regbranch(pRExC_state, &flags, 1,depth+1);
4796                         REGTAIL(pRExC_state, ret, lastbr);
4797                         if (flags&HASWIDTH)
4798                             *flagp |= HASWIDTH;
4799                         c = *nextchar(pRExC_state);
4800                     }
4801                     else
4802                         lastbr = NULL;
4803                     if (c != ')')
4804                         vFAIL("Switch (?(condition)... contains too many branches");
4805                     ender = reg_node(pRExC_state, TAIL);
4806                     REGTAIL(pRExC_state, br, ender);
4807                     if (lastbr) {
4808                         REGTAIL(pRExC_state, lastbr, ender);
4809                         REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender);
4810                     }
4811                     else
4812                         REGTAIL(pRExC_state, ret, ender);
4813                     return ret;
4814                 }
4815                 else {
4816                     vFAIL2("Unknown switch condition (?(%.2s", RExC_parse);
4817                 }
4818             }
4819             case 0:
4820                 RExC_parse--; /* for vFAIL to print correctly */
4821                 vFAIL("Sequence (? incomplete");
4822                 break;
4823             default:
4824                 --RExC_parse;
4825               parse_flags:      /* (?i) */
4826                 while (*RExC_parse && strchr("iogcmsx", *RExC_parse)) {
4827                     /* (?g), (?gc) and (?o) are useless here
4828                        and must be globally applied -- japhy */
4829
4830                     if (*RExC_parse == 'o' || *RExC_parse == 'g') {
4831                         if (SIZE_ONLY && ckWARN(WARN_REGEXP)) {
4832                             const I32 wflagbit = *RExC_parse == 'o' ? WASTED_O : WASTED_G;
4833                             if (! (wastedflags & wflagbit) ) {
4834                                 wastedflags |= wflagbit;
4835                                 vWARN5(
4836                                     RExC_parse + 1,
4837                                     "Useless (%s%c) - %suse /%c modifier",
4838                                     flagsp == &negflags ? "?-" : "?",
4839                                     *RExC_parse,
4840                                     flagsp == &negflags ? "don't " : "",
4841                                     *RExC_parse
4842                                 );
4843                             }
4844                         }
4845                     }
4846                     else if (*RExC_parse == 'c') {
4847                         if (SIZE_ONLY && ckWARN(WARN_REGEXP)) {
4848                             if (! (wastedflags & WASTED_C) ) {
4849                                 wastedflags |= WASTED_GC;
4850                                 vWARN3(
4851                                     RExC_parse + 1,
4852                                     "Useless (%sc) - %suse /gc modifier",
4853                                     flagsp == &negflags ? "?-" : "?",
4854                                     flagsp == &negflags ? "don't " : ""
4855                                 );
4856                             }
4857                         }
4858                     }
4859                     else { pmflag(flagsp, *RExC_parse); }
4860
4861                     ++RExC_parse;
4862                 }
4863                 if (*RExC_parse == '-') {
4864                     flagsp = &negflags;
4865                     wastedflags = 0;  /* reset so (?g-c) warns twice */
4866                     ++RExC_parse;
4867                     goto parse_flags;
4868                 }
4869                 RExC_flags |= posflags;
4870                 RExC_flags &= ~negflags;
4871                 if (*RExC_parse == ':') {
4872                     RExC_parse++;
4873                     paren = ':';
4874                     break;
4875                 }
4876               unknown:
4877                 if (*RExC_parse != ')') {
4878                     RExC_parse++;
4879                     vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
4880                 }
4881                 nextchar(pRExC_state);
4882                 *flagp = TRYAGAIN;
4883                 return NULL;
4884             }
4885         }
4886         else {                  /* (...) */
4887           capturing_parens:
4888             parno = RExC_npar;
4889             RExC_npar++;
4890             ret = reganode(pRExC_state, OPEN, parno);
4891             if (!SIZE_ONLY && RExC_seen & REG_SEEN_RECURSE) {
4892                 DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
4893                         "Setting paren #%"IVdf" to %d\n", (IV)parno, REG_NODE_NUM(ret)));
4894                 RExC_parens[parno-1]= ret;
4895
4896             }
4897             Set_Node_Length(ret, 1); /* MJD */
4898             Set_Node_Offset(ret, RExC_parse); /* MJD */
4899             is_open = 1;
4900         }
4901     }
4902     else                        /* ! paren */
4903         ret = NULL;
4904
4905     /* Pick up the branches, linking them together. */
4906     parse_start = RExC_parse;   /* MJD */
4907     br = regbranch(pRExC_state, &flags, 1,depth+1);
4908     /*     branch_len = (paren != 0); */
4909
4910     if (br == NULL)
4911         return(NULL);
4912     if (*RExC_parse == '|') {
4913         if (!SIZE_ONLY && RExC_extralen) {
4914             reginsert(pRExC_state, BRANCHJ, br, depth+1);
4915         }
4916         else {                  /* MJD */
4917             reginsert(pRExC_state, BRANCH, br, depth+1);
4918             Set_Node_Length(br, paren != 0);
4919             Set_Node_Offset_To_R(br-RExC_emit_start, parse_start-RExC_start);
4920         }
4921         have_branch = 1;
4922         if (SIZE_ONLY)
4923             RExC_extralen += 1;         /* For BRANCHJ-BRANCH. */
4924     }
4925     else if (paren == ':') {
4926         *flagp |= flags&SIMPLE;
4927     }
4928     if (is_open) {                              /* Starts with OPEN. */
4929         REGTAIL(pRExC_state, ret, br);          /* OPEN -> first. */
4930     }
4931     else if (paren != '?')              /* Not Conditional */
4932         ret = br;
4933     *flagp |= flags & (SPSTART | HASWIDTH);
4934     lastbr = br;
4935     while (*RExC_parse == '|') {
4936         if (!SIZE_ONLY && RExC_extralen) {
4937             ender = reganode(pRExC_state, LONGJMP,0);
4938             REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender); /* Append to the previous. */
4939         }
4940         if (SIZE_ONLY)
4941             RExC_extralen += 2;         /* Account for LONGJMP. */
4942         nextchar(pRExC_state);
4943         br = regbranch(pRExC_state, &flags, 0, depth+1);
4944
4945         if (br == NULL)
4946             return(NULL);
4947         REGTAIL(pRExC_state, lastbr, br);               /* BRANCH -> BRANCH. */
4948         lastbr = br;
4949         if (flags&HASWIDTH)
4950             *flagp |= HASWIDTH;
4951         *flagp |= flags&SPSTART;
4952     }
4953
4954     if (have_branch || paren != ':') {
4955         /* Make a closing node, and hook it on the end. */
4956         switch (paren) {
4957         case ':':
4958             ender = reg_node(pRExC_state, TAIL);
4959             break;
4960         case 1:
4961             ender = reganode(pRExC_state, CLOSE, parno);
4962             Set_Node_Offset(ender,RExC_parse+1); /* MJD */
4963             Set_Node_Length(ender,1); /* MJD */
4964             break;
4965         case '<':
4966         case ',':
4967         case '=':
4968         case '!':
4969             *flagp &= ~HASWIDTH;
4970             /* FALL THROUGH */
4971         case '>':
4972             ender = reg_node(pRExC_state, SUCCEED);
4973             break;
4974         case 0:
4975             ender = reg_node(pRExC_state, END);
4976             break;
4977         }
4978         REGTAIL(pRExC_state, lastbr, ender);
4979
4980         if (have_branch && !SIZE_ONLY) {
4981             if (depth==1)
4982                 RExC_seen |= REG_TOP_LEVEL_BRANCHES;
4983
4984             /* Hook the tails of the branches to the closing node. */
4985             for (br = ret; br; br = regnext(br)) {
4986                 const U8 op = PL_regkind[OP(br)];
4987                 if (op == BRANCH) {
4988                     REGTAIL_STUDY(pRExC_state, NEXTOPER(br), ender);
4989                 }
4990                 else if (op == BRANCHJ) {
4991                     REGTAIL_STUDY(pRExC_state, NEXTOPER(NEXTOPER(br)), ender);
4992                 }
4993             }
4994         }
4995     }
4996
4997     {
4998         const char *p;
4999         static const char parens[] = "=!<,>";
5000
5001         if (paren && (p = strchr(parens, paren))) {
5002             U8 node = ((p - parens) % 2) ? UNLESSM : IFMATCH;
5003             int flag = (p - parens) > 1;
5004
5005             if (paren == '>')
5006                 node = SUSPEND, flag = 0;
5007             reginsert(pRExC_state, node,ret, depth+1);
5008             Set_Node_Cur_Length(ret);
5009             Set_Node_Offset(ret, parse_start + 1);
5010             ret->flags = flag;
5011             REGTAIL_STUDY(pRExC_state, ret, reg_node(pRExC_state, TAIL));
5012         }
5013     }
5014
5015     /* Check for proper termination. */
5016     if (paren) {
5017         RExC_flags = oregflags;
5018         if (RExC_parse >= RExC_end || *nextchar(pRExC_state) != ')') {
5019             RExC_parse = oregcomp_parse;
5020             vFAIL("Unmatched (");
5021         }
5022     }
5023     else if (!paren && RExC_parse < RExC_end) {
5024         if (*RExC_parse == ')') {
5025             RExC_parse++;
5026             vFAIL("Unmatched )");
5027         }
5028         else
5029             FAIL("Junk on end of regexp");      /* "Can't happen". */
5030         /* NOTREACHED */
5031     }
5032
5033     return(ret);
5034 }
5035
5036 /*
5037  - regbranch - one alternative of an | operator
5038  *
5039  * Implements the concatenation operator.
5040  */
5041 STATIC regnode *
5042 S_regbranch(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, I32 first, U32 depth)
5043 {
5044     dVAR;
5045     register regnode *ret;
5046     register regnode *chain = NULL;
5047     register regnode *latest;
5048     I32 flags = 0, c = 0;
5049     GET_RE_DEBUG_FLAGS_DECL;
5050     DEBUG_PARSE("brnc");
5051     if (first)
5052         ret = NULL;
5053     else {
5054         if (!SIZE_ONLY && RExC_extralen)
5055             ret = reganode(pRExC_state, BRANCHJ,0);
5056         else {
5057             ret = reg_node(pRExC_state, BRANCH);
5058             Set_Node_Length(ret, 1);
5059         }
5060     }
5061
5062     if (!first && SIZE_ONLY)
5063         RExC_extralen += 1;                     /* BRANCHJ */
5064
5065     *flagp = WORST;                     /* Tentatively. */
5066
5067     RExC_parse--;
5068     nextchar(pRExC_state);
5069     while (RExC_parse < RExC_end && *RExC_parse != '|' && *RExC_parse != ')') {
5070         flags &= ~TRYAGAIN;
5071         latest = regpiece(pRExC_state, &flags,depth+1);
5072         if (latest == NULL) {
5073             if (flags & TRYAGAIN)
5074                 continue;
5075             return(NULL);
5076         }
5077         else if (ret == NULL)
5078             ret = latest;
5079         *flagp |= flags&HASWIDTH;
5080         if (chain == NULL)      /* First piece. */
5081             *flagp |= flags&SPSTART;
5082         else {
5083             RExC_naughty++;
5084             REGTAIL(pRExC_state, chain, latest);
5085         }
5086         chain = latest;
5087         c++;
5088     }
5089     if (chain == NULL) {        /* Loop ran zero times. */
5090         chain = reg_node(pRExC_state, NOTHING);
5091         if (ret == NULL)
5092             ret = chain;
5093     }
5094     if (c == 1) {
5095         *flagp |= flags&SIMPLE;
5096     }
5097
5098     return ret;
5099 }
5100
5101 /*
5102  - regpiece - something followed by possible [*+?]
5103  *
5104  * Note that the branching code sequences used for ? and the general cases
5105  * of * and + are somewhat optimized:  they use the same NOTHING node as
5106  * both the endmarker for their branch list and the body of the last branch.
5107  * It might seem that this node could be dispensed with entirely, but the
5108  * endmarker role is not redundant.
5109  */
5110 STATIC regnode *
5111 S_regpiece(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
5112 {
5113     dVAR;
5114     register regnode *ret;
5115     register char op;
5116     register char *next;
5117     I32 flags;
5118     const char * const origparse = RExC_parse;
5119     I32 min;
5120     I32 max = REG_INFTY;
5121     char *parse_start;
5122     const char *maxpos = NULL;
5123     GET_RE_DEBUG_FLAGS_DECL;
5124     DEBUG_PARSE("piec");
5125
5126     ret = regatom(pRExC_state, &flags,depth+1);
5127     if (ret == NULL) {
5128         if (flags & TRYAGAIN)
5129             *flagp |= TRYAGAIN;
5130         return(NULL);
5131     }
5132
5133     op = *RExC_parse;
5134
5135     if (op == '{' && regcurly(RExC_parse)) {
5136         maxpos = NULL;
5137         parse_start = RExC_parse; /* MJD */
5138         next = RExC_parse + 1;
5139         while (isDIGIT(*next) || *next == ',') {
5140             if (*next == ',') {
5141                 if (maxpos)
5142                     break;
5143                 else
5144                     maxpos = next;
5145             }
5146             next++;
5147         }
5148         if (*next == '}') {             /* got one */
5149             if (!maxpos)
5150                 maxpos = next;
5151             RExC_parse++;
5152             min = atoi(RExC_parse);
5153             if (*maxpos == ',')
5154                 maxpos++;
5155             else
5156                 maxpos = RExC_parse;
5157             max = atoi(maxpos);
5158             if (!max && *maxpos != '0')
5159                 max = REG_INFTY;                /* meaning "infinity" */
5160             else if (max >= REG_INFTY)
5161                 vFAIL2("Quantifier in {,} bigger than %d", REG_INFTY - 1);
5162             RExC_parse = next;
5163             nextchar(pRExC_state);
5164
5165         do_curly:
5166             if ((flags&SIMPLE)) {
5167                 RExC_naughty += 2 + RExC_naughty / 2;
5168                 reginsert(pRExC_state, CURLY, ret, depth+1);
5169                 Set_Node_Offset(ret, parse_start+1); /* MJD */
5170                 Set_Node_Cur_Length(ret);
5171             }
5172             else {
5173                 regnode * const w = reg_node(pRExC_state, WHILEM);
5174
5175                 w->flags = 0;
5176                 REGTAIL(pRExC_state, ret, w);
5177                 if (!SIZE_ONLY && RExC_extralen) {
5178                     reginsert(pRExC_state, LONGJMP,ret, depth+1);
5179                     reginsert(pRExC_state, NOTHING,ret, depth+1);
5180                     NEXT_OFF(ret) = 3;  /* Go over LONGJMP. */
5181                 }
5182                 reginsert(pRExC_state, CURLYX,ret, depth+1);
5183                                 /* MJD hk */
5184                 Set_Node_Offset(ret, parse_start+1);
5185                 Set_Node_Length(ret,
5186                                 op == '{' ? (RExC_parse - parse_start) : 1);
5187
5188                 if (!SIZE_ONLY && RExC_extralen)
5189                     NEXT_OFF(ret) = 3;  /* Go over NOTHING to LONGJMP. */
5190                 REGTAIL(pRExC_state, ret, reg_node(pRExC_state, NOTHING));
5191                 if (SIZE_ONLY)
5192                     RExC_whilem_seen++, RExC_extralen += 3;
5193                 RExC_naughty += 4 + RExC_naughty;       /* compound interest */
5194             }
5195             ret->flags = 0;
5196
5197             if (min > 0)
5198                 *flagp = WORST;
5199             if (max > 0)
5200                 *flagp |= HASWIDTH;
5201             if (max && max < min)
5202                 vFAIL("Can't do {n,m} with n > m");
5203             if (!SIZE_ONLY) {
5204                 ARG1_SET(ret, (U16)min);
5205                 ARG2_SET(ret, (U16)max);
5206             }
5207
5208             goto nest_check;
5209         }
5210     }
5211
5212     if (!ISMULT1(op)) {
5213         *flagp = flags;
5214         return(ret);
5215     }
5216
5217 #if 0                           /* Now runtime fix should be reliable. */
5218
5219     /* if this is reinstated, don't forget to put this back into perldiag:
5220
5221             =item Regexp *+ operand could be empty at {#} in regex m/%s/
5222
5223            (F) The part of the regexp subject to either the * or + quantifier
5224            could match an empty string. The {#} shows in the regular
5225            expression about where the problem was discovered.
5226
5227     */
5228
5229     if (!(flags&HASWIDTH) && op != '?')
5230       vFAIL("Regexp *+ operand could be empty");
5231 #endif
5232
5233     parse_start = RExC_parse;
5234     nextchar(pRExC_state);
5235
5236     *flagp = (op != '+') ? (WORST|SPSTART|HASWIDTH) : (WORST|HASWIDTH);
5237
5238     if (op == '*' && (flags&SIMPLE)) {
5239         reginsert(pRExC_state, STAR, ret, depth+1);
5240         ret->flags = 0;
5241         RExC_naughty += 4;
5242     }
5243     else if (op == '*') {
5244         min = 0;
5245         goto do_curly;
5246     }
5247     else if (op == '+' && (flags&SIMPLE)) {
5248         reginsert(pRExC_state, PLUS, ret, depth+1);
5249         ret->flags = 0;
5250         RExC_naughty += 3;
5251     }
5252     else if (op == '+') {
5253         min = 1;
5254         goto do_curly;
5255     }
5256     else if (op == '?') {
5257         min = 0; max = 1;
5258         goto do_curly;
5259     }
5260   nest_check:
5261     if (!SIZE_ONLY && !(flags&HASWIDTH) && max > REG_INFTY/3 && ckWARN(WARN_REGEXP)) {
5262         vWARN3(RExC_parse,
5263                "%.*s matches null string many times",
5264                (int)(RExC_parse >= origparse ? RExC_parse - origparse : 0),
5265                origparse);
5266     }
5267
5268     if (RExC_parse < RExC_end && *RExC_parse == '?') {
5269         nextchar(pRExC_state);
5270         reginsert(pRExC_state, MINMOD, ret, depth+1);
5271         REGTAIL(pRExC_state, ret, ret + NODE_STEP_REGNODE);
5272     }
5273 #ifndef REG_ALLOW_MINMOD_SUSPEND
5274     else
5275 #endif
5276     if (RExC_parse < RExC_end && *RExC_parse == '+') {
5277         regnode *ender;
5278         nextchar(pRExC_state);
5279         ender = reg_node(pRExC_state, SUCCEED);
5280         REGTAIL(pRExC_state, ret, ender);
5281         reginsert(pRExC_state, SUSPEND, ret, depth+1);
5282         ret->flags = 0;
5283         ender = reg_node(pRExC_state, TAIL);
5284         REGTAIL(pRExC_state, ret, ender);
5285         /*ret= ender;*/
5286     }
5287
5288     if (RExC_parse < RExC_end && ISMULT2(RExC_parse)) {
5289         RExC_parse++;
5290         vFAIL("Nested quantifiers");
5291     }
5292
5293     return(ret);
5294 }
5295
5296
5297 /* reg_namedseq(pRExC_state,UVp)
5298
5299    This is expected to be called by a parser routine that has
5300    recognized'\N' and needs to handle the rest. RExC_parse is
5301    expected to point at the first char following the N at the time
5302    of the call.
5303
5304    If valuep is non-null then it is assumed that we are parsing inside
5305    of a charclass definition and the first codepoint in the resolved
5306    string is returned via *valuep and the routine will return NULL.
5307    In this mode if a multichar string is returned from the charnames
5308    handler a warning will be issued, and only the first char in the
5309    sequence will be examined. If the string returned is zero length
5310    then the value of *valuep is undefined and NON-NULL will
5311    be returned to indicate failure. (This will NOT be a valid pointer
5312    to a regnode.)
5313
5314    If value is null then it is assumed that we are parsing normal text
5315    and inserts a new EXACT node into the program containing the resolved
5316    string and returns a pointer to the new node. If the string is
5317    zerolength a NOTHING node is emitted.
5318
5319    On success RExC_parse is set to the char following the endbrace.
5320    Parsing failures will generate a fatal errorvia vFAIL(...)
5321
5322    NOTE: We cache all results from the charnames handler locally in
5323    the RExC_charnames hash (created on first use) to prevent a charnames
5324    handler from playing silly-buggers and returning a short string and
5325    then a long string for a given pattern. Since the regexp program
5326    size is calculated during an initial parse this would result
5327    in a buffer overrun so we cache to prevent the charname result from
5328    changing during the course of the parse.
5329
5330  */
5331 STATIC regnode *
5332 S_reg_namedseq(pTHX_ RExC_state_t *pRExC_state, UV *valuep)
5333 {
5334     char * name;        /* start of the content of the name */
5335     char * endbrace;    /* endbrace following the name */
5336     SV *sv_str = NULL;
5337     SV *sv_name = NULL;
5338     STRLEN len; /* this has various purposes throughout the code */
5339     bool cached = 0; /* if this is true then we shouldn't refcount dev sv_str */
5340     regnode *ret = NULL;
5341
5342     if (*RExC_parse != '{') {
5343         vFAIL("Missing braces on \\N{}");
5344     }
5345     name = RExC_parse+1;
5346     endbrace = strchr(RExC_parse, '}');
5347     if ( ! endbrace ) {
5348         RExC_parse++;
5349         vFAIL("Missing right brace on \\N{}");
5350     }
5351     RExC_parse = endbrace + 1;
5352
5353
5354     /* RExC_parse points at the beginning brace,
5355        endbrace points at the last */
5356     if ( name[0]=='U' && name[1]=='+' ) {
5357         /* its a "unicode hex" notation {U+89AB} */
5358         I32 fl = PERL_SCAN_ALLOW_UNDERSCORES
5359             | PERL_SCAN_DISALLOW_PREFIX
5360             | (SIZE_ONLY ? PERL_SCAN_SILENT_ILLDIGIT : 0);
5361         UV cp;
5362         len = (STRLEN)(endbrace - name - 2);
5363         cp = grok_hex(name + 2, &len, &fl, NULL);
5364         if ( len != (STRLEN)(endbrace - name - 2) ) {
5365             cp = 0xFFFD;
5366         }
5367         if (cp > 0xff)
5368             RExC_utf8 = 1;
5369         if ( valuep ) {
5370             *valuep = cp;
5371             return NULL;
5372         }
5373         sv_str= Perl_newSVpvf_nocontext("%c",(int)cp);
5374     } else {
5375         /* fetch the charnames handler for this scope */
5376         HV * const table = GvHV(PL_hintgv);
5377         SV **cvp= table ?
5378             hv_fetchs(table, "charnames", FALSE) :
5379             NULL;
5380         SV *cv= cvp ? *cvp : NULL;
5381         HE *he_str;
5382         int count;
5383         /* create an SV with the name as argument */
5384         sv_name = newSVpvn(name, endbrace - name);
5385
5386         if (!table || !(PL_hints & HINT_LOCALIZE_HH)) {
5387             vFAIL2("Constant(\\N{%s}) unknown: "
5388                   "(possibly a missing \"use charnames ...\")",
5389                   SvPVX(sv_name));
5390         }
5391         if (!cvp || !SvOK(*cvp)) { /* when $^H{charnames} = undef; */
5392             vFAIL2("Constant(\\N{%s}): "
5393                   "$^H{charnames} is not defined",SvPVX(sv_name));
5394         }
5395
5396
5397
5398         if (!RExC_charnames) {
5399             /* make sure our cache is allocated */
5400             RExC_charnames = newHV();
5401             sv_2mortal((SV*)RExC_charnames);
5402         }
5403             /* see if we have looked this one up before */
5404         he_str = hv_fetch_ent( RExC_charnames, sv_name, 0, 0 );
5405         if ( he_str ) {
5406             sv_str = HeVAL(he_str);
5407             cached = 1;
5408         } else {
5409             dSP ;
5410
5411             ENTER ;
5412             SAVETMPS ;
5413             PUSHMARK(SP) ;
5414
5415             XPUSHs(sv_name);
5416
5417             PUTBACK ;
5418
5419             count= call_sv(cv, G_SCALAR);
5420
5421             if (count == 1) { /* XXXX is this right? dmq */
5422                 sv_str = POPs;
5423                 SvREFCNT_inc_simple_void(sv_str);
5424             }
5425
5426             SPAGAIN ;
5427             PUTBACK ;
5428             FREETMPS ;
5429             LEAVE ;
5430
5431             if ( !sv_str || !SvOK(sv_str) ) {
5432                 vFAIL2("Constant(\\N{%s}): Call to &{$^H{charnames}} "
5433                       "did not return a defined value",SvPVX(sv_name));
5434             }
5435             if (hv_store_ent( RExC_charnames, sv_name, sv_str, 0))
5436                 cached = 1;
5437         }
5438     }
5439     if (valuep) {
5440         char *p = SvPV(sv_str, len);
5441         if (len) {
5442             STRLEN numlen = 1;
5443             if ( SvUTF8(sv_str) ) {
5444                 *valuep = utf8_to_uvchr((U8*)p, &numlen);
5445                 if (*valuep > 0x7F)
5446                     RExC_utf8 = 1;
5447                 /* XXXX
5448                   We have to turn on utf8 for high bit chars otherwise
5449                   we get failures with
5450
5451                    "ss" =~ /[\N{LATIN SMALL LETTER SHARP S}]/i
5452                    "SS" =~ /[\N{LATIN SMALL LETTER SHARP S}]/i
5453
5454                   This is different from what \x{} would do with the same
5455                   codepoint, where the condition is > 0xFF.
5456                   - dmq
5457                 */
5458
5459
5460             } else {
5461                 *valuep = (UV)*p;
5462                 /* warn if we havent used the whole string? */
5463             }
5464             if (numlen<len && SIZE_ONLY && ckWARN(WARN_REGEXP)) {
5465                 vWARN2(RExC_parse,
5466                     "Ignoring excess chars from \\N{%s} in character class",
5467                     SvPVX(sv_name)
5468                 );
5469             }
5470         } else if (SIZE_ONLY && ckWARN(WARN_REGEXP)) {
5471             vWARN2(RExC_parse,
5472                     "Ignoring zero length \\N{%s} in character class",
5473                     SvPVX(sv_name)
5474                 );
5475         }
5476         if (sv_name)
5477             SvREFCNT_dec(sv_name);
5478         if (!cached)
5479             SvREFCNT_dec(sv_str);
5480         return len ? NULL : (regnode *)&len;
5481     } else if(SvCUR(sv_str)) {
5482
5483         char *s;
5484         char *p, *pend;
5485         STRLEN charlen = 1;
5486         char * parse_start = name-3; /* needed for the offsets */
5487         GET_RE_DEBUG_FLAGS_DECL;     /* needed for the offsets */
5488
5489         ret = reg_node(pRExC_state,
5490             (U8)(FOLD ? (LOC ? EXACTFL : EXACTF) : EXACT));
5491         s= STRING(ret);
5492
5493         if ( RExC_utf8 && !SvUTF8(sv_str) ) {
5494             sv_utf8_upgrade(sv_str);
5495         } else if ( !RExC_utf8 && SvUTF8(sv_str) ) {
5496             RExC_utf8= 1;
5497         }
5498
5499         p = SvPV(sv_str, len);
5500         pend = p + len;
5501         /* len is the length written, charlen is the size the char read */
5502         for ( len = 0; p < pend; p += charlen ) {
5503             if (UTF) {
5504                 UV uvc = utf8_to_uvchr((U8*)p, &charlen);
5505                 if (FOLD) {
5506                     STRLEN foldlen,numlen;
5507                     U8 tmpbuf[UTF8_MAXBYTES_CASE+1], *foldbuf;
5508                     uvc = toFOLD_uni(uvc, tmpbuf, &foldlen);
5509                     /* Emit all the Unicode characters. */
5510
5511                     for (foldbuf = tmpbuf;
5512                         foldlen;
5513                         foldlen -= numlen)
5514                     {
5515                         uvc = utf8_to_uvchr(foldbuf, &numlen);
5516                         if (numlen > 0) {
5517                             const STRLEN unilen = reguni(pRExC_state, uvc, s);
5518                             s       += unilen;
5519                             len     += unilen;
5520                             /* In EBCDIC the numlen
5521                             * and unilen can differ. */
5522                             foldbuf += numlen;
5523                             if (numlen >= foldlen)
5524                                 break;
5525                         }
5526                         else
5527                             break; /* "Can't happen." */
5528                     }
5529                 } else {
5530                     const STRLEN unilen = reguni(pRExC_state, uvc, s);
5531                     if (unilen > 0) {
5532                        s   += unilen;
5533                        len += unilen;
5534                     }
5535                 }
5536             } else {
5537                 len++;
5538                 REGC(*p, s++);
5539             }
5540         }
5541         if (SIZE_ONLY) {
5542             RExC_size += STR_SZ(len);
5543         } else {
5544             STR_LEN(ret) = len;
5545             RExC_emit += STR_SZ(len);
5546         }
5547         Set_Node_Cur_Length(ret); /* MJD */
5548         RExC_parse--;
5549         nextchar(pRExC_state);
5550     } else {
5551         ret = reg_node(pRExC_state,NOTHING);
5552     }
5553     if (!cached) {
5554         SvREFCNT_dec(sv_str);
5555     }
5556     if (sv_name) {
5557         SvREFCNT_dec(sv_name);
5558     }
5559     return ret;
5560
5561 }
5562
5563
5564
5565 /*
5566  - regatom - the lowest level
5567  *
5568  * Optimization:  gobbles an entire sequence of ordinary characters so that
5569  * it can turn them into a single node, which is smaller to store and
5570  * faster to run.  Backslashed characters are exceptions, each becoming a
5571  * separate node; the code is simpler that way and it's not worth fixing.
5572  *
5573  * [Yes, it is worth fixing, some scripts can run twice the speed.]
5574  * [It looks like its ok, as in S_study_chunk we merge adjacent EXACT nodes]
5575  */
5576 STATIC regnode *
5577 S_regatom(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
5578 {
5579     dVAR;
5580     register regnode *ret = NULL;
5581     I32 flags;
5582     char *parse_start = RExC_parse;
5583     GET_RE_DEBUG_FLAGS_DECL;
5584     DEBUG_PARSE("atom");
5585     *flagp = WORST;             /* Tentatively. */
5586
5587 tryagain:
5588     switch (*RExC_parse) {
5589     case '^':
5590         RExC_seen_zerolen++;
5591         nextchar(pRExC_state);
5592         if (RExC_flags & PMf_MULTILINE)
5593             ret = reg_node(pRExC_state, MBOL);
5594         else if (RExC_flags & PMf_SINGLELINE)
5595             ret = reg_node(pRExC_state, SBOL);
5596         else
5597             ret = reg_node(pRExC_state, BOL);
5598         Set_Node_Length(ret, 1); /* MJD */
5599         break;
5600     case '$':
5601         nextchar(pRExC_state);
5602         if (*RExC_parse)
5603             RExC_seen_zerolen++;
5604         if (RExC_flags & PMf_MULTILINE)
5605             ret = reg_node(pRExC_state, MEOL);
5606         else if (RExC_flags & PMf_SINGLELINE)
5607             ret = reg_node(pRExC_state, SEOL);
5608         else
5609             ret = reg_node(pRExC_state, EOL);
5610         Set_Node_Length(ret, 1); /* MJD */
5611         break;
5612     case '.':
5613         nextchar(pRExC_state);
5614         if (RExC_flags & PMf_SINGLELINE)
5615             ret = reg_node(pRExC_state, SANY);
5616         else
5617             ret = reg_node(pRExC_state, REG_ANY);
5618         *flagp |= HASWIDTH|SIMPLE;
5619         RExC_naughty++;
5620         Set_Node_Length(ret, 1); /* MJD */
5621         break;
5622     case '[':
5623     {
5624         char * const oregcomp_parse = ++RExC_parse;
5625         ret = regclass(pRExC_state,depth+1);
5626         if (*RExC_parse != ']') {
5627             RExC_parse = oregcomp_parse;
5628             vFAIL("Unmatched [");
5629         }
5630         nextchar(pRExC_state);
5631         *flagp |= HASWIDTH|SIMPLE;
5632         Set_Node_Length(ret, RExC_parse - oregcomp_parse + 1); /* MJD */
5633         break;
5634     }
5635     case '(':
5636         nextchar(pRExC_state);
5637         ret = reg(pRExC_state, 1, &flags,depth+1);
5638         if (ret == NULL) {
5639                 if (flags & TRYAGAIN) {
5640                     if (RExC_parse == RExC_end) {
5641                          /* Make parent create an empty node if needed. */
5642                         *flagp |= TRYAGAIN;
5643                         return(NULL);
5644                     }
5645                     goto tryagain;
5646                 }
5647                 return(NULL);
5648         }
5649         *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE);
5650         break;
5651     case '|':
5652     case ')':
5653         if (flags & TRYAGAIN) {
5654             *flagp |= TRYAGAIN;
5655             return NULL;
5656         }
5657         vFAIL("Internal urp");
5658                                 /* Supposed to be caught earlier. */
5659         break;
5660     case '{':
5661         if (!regcurly(RExC_parse)) {
5662             RExC_parse++;
5663             goto defchar;
5664         }
5665         /* FALL THROUGH */
5666     case '?':
5667     case '+':
5668     case '*':
5669         RExC_parse++;
5670         vFAIL("Quantifier follows nothing");
5671         break;
5672     case '\\':
5673         switch (*++RExC_parse) {
5674         case 'A':
5675             RExC_seen_zerolen++;
5676             ret = reg_node(pRExC_state, SBOL);
5677             *flagp |= SIMPLE;
5678             nextchar(pRExC_state);
5679             Set_Node_Length(ret, 2); /* MJD */
5680             break;
5681         case 'G':
5682             ret = reg_node(pRExC_state, GPOS);
5683             RExC_seen |= REG_SEEN_GPOS;
5684             *flagp |= SIMPLE;
5685             nextchar(pRExC_state);
5686             Set_Node_Length(ret, 2); /* MJD */
5687             break;
5688         case 'Z':
5689             ret = reg_node(pRExC_state, SEOL);
5690             *flagp |= SIMPLE;
5691             RExC_seen_zerolen++;                /* Do not optimize RE away */
5692             nextchar(pRExC_state);
5693             break;
5694         case 'z':
5695             ret = reg_node(pRExC_state, EOS);
5696             *flagp |= SIMPLE;
5697             RExC_seen_zerolen++;                /* Do not optimize RE away */
5698             nextchar(pRExC_state);
5699             Set_Node_Length(ret, 2); /* MJD */
5700             break;
5701         case 'C':
5702             ret = reg_node(pRExC_state, CANY);
5703             RExC_seen |= REG_SEEN_CANY;
5704             *flagp |= HASWIDTH|SIMPLE;
5705             nextchar(pRExC_state);
5706             Set_Node_Length(ret, 2); /* MJD */
5707             break;
5708         case 'X':
5709             ret = reg_node(pRExC_state, CLUMP);
5710             *flagp |= HASWIDTH;
5711             nextchar(pRExC_state);
5712             Set_Node_Length(ret, 2); /* MJD */
5713             break;
5714         case 'w':
5715             ret = reg_node(pRExC_state, (U8)(LOC ? ALNUML     : ALNUM));
5716             *flagp |= HASWIDTH|SIMPLE;
5717             nextchar(pRExC_state);
5718             Set_Node_Length(ret, 2); /* MJD */
5719             break;
5720         case 'W':
5721             ret = reg_node(pRExC_state, (U8)(LOC ? NALNUML    : NALNUM));
5722             *flagp |= HASWIDTH|SIMPLE;
5723             nextchar(pRExC_state);
5724             Set_Node_Length(ret, 2); /* MJD */
5725             break;
5726         case 'b':
5727             RExC_seen_zerolen++;
5728             RExC_seen |= REG_SEEN_LOOKBEHIND;
5729             ret = reg_node(pRExC_state, (U8)(LOC ? BOUNDL     : BOUND));
5730             *flagp |= SIMPLE;
5731             nextchar(pRExC_state);
5732             Set_Node_Length(ret, 2); /* MJD */
5733             break;
5734         case 'B':
5735             RExC_seen_zerolen++;
5736             RExC_seen |= REG_SEEN_LOOKBEHIND;
5737             ret = reg_node(pRExC_state, (U8)(LOC ? NBOUNDL    : NBOUND));
5738             *flagp |= SIMPLE;
5739             nextchar(pRExC_state);
5740             Set_Node_Length(ret, 2); /* MJD */
5741             break;
5742         case 's':
5743             ret = reg_node(pRExC_state, (U8)(LOC ? SPACEL     : SPACE));
5744             *flagp |= HASWIDTH|SIMPLE;
5745             nextchar(pRExC_state);
5746             Set_Node_Length(ret, 2); /* MJD */
5747             break;
5748         case 'S':
5749             ret = reg_node(pRExC_state, (U8)(LOC ? NSPACEL    : NSPACE));
5750             *flagp |= HASWIDTH|SIMPLE;
5751             nextchar(pRExC_state);
5752             Set_Node_Length(ret, 2); /* MJD */
5753             break;
5754         case 'd':
5755             ret = reg_node(pRExC_state, DIGIT);
5756             *flagp |= HASWIDTH|SIMPLE;
5757             nextchar(pRExC_state);
5758             Set_Node_Length(ret, 2); /* MJD */
5759             break;
5760         case 'D':
5761             ret = reg_node(pRExC_state, NDIGIT);
5762             *flagp |= HASWIDTH|SIMPLE;
5763             nextchar(pRExC_state);
5764             Set_Node_Length(ret, 2); /* MJD */
5765             break;
5766         case 'p':
5767         case 'P':
5768             {
5769                 char* const oldregxend = RExC_end;
5770                 char* parse_start = RExC_parse - 2;
5771
5772                 if (RExC_parse[1] == '{') {
5773                   /* a lovely hack--pretend we saw [\pX] instead */
5774                     RExC_end = strchr(RExC_parse, '}');
5775                     if (!RExC_end) {
5776                         const U8 c = (U8)*RExC_parse;
5777                         RExC_parse += 2;
5778                         RExC_end = oldregxend;
5779                         vFAIL2("Missing right brace on \\%c{}", c);
5780                     }
5781                     RExC_end++;
5782                 }
5783                 else {
5784                     RExC_end = RExC_parse + 2;
5785                     if (RExC_end > oldregxend)
5786                         RExC_end = oldregxend;
5787                 }
5788                 RExC_parse--;
5789
5790                 ret = regclass(pRExC_state,depth+1);
5791
5792                 RExC_end = oldregxend;
5793                 RExC_parse--;
5794
5795                 Set_Node_Offset(ret, parse_start + 2);
5796                 Set_Node_Cur_Length(ret);
5797                 nextchar(pRExC_state);
5798                 *flagp |= HASWIDTH|SIMPLE;
5799             }
5800             break;
5801         case 'N':
5802             /* Handle \N{NAME} here and not below because it can be
5803             multicharacter. join_exact() will join them up later on.
5804             Also this makes sure that things like /\N{BLAH}+/ and
5805             \N{BLAH} being multi char Just Happen. dmq*/
5806             ++RExC_parse;
5807             ret= reg_namedseq(pRExC_state, NULL);
5808             break;
5809         case 'k':    /* Handle \k<NAME> and \k'NAME' */
5810         {
5811             char ch= RExC_parse[1];
5812             if (ch != '<' && ch != '\'') {
5813                 if (SIZE_ONLY)
5814                     vWARN( RExC_parse + 1,
5815                         "Possible broken named back reference treated as literal k");
5816                 parse_start--;
5817                 goto defchar;
5818             } else {
5819                 char* name_start = (RExC_parse += 2);
5820                 I32 num = 0;
5821                 SV *sv_dat = reg_scan_name(pRExC_state,
5822                     SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
5823                 ch= (ch == '<') ? '>' : '\'';
5824
5825                 if (RExC_parse == name_start || *RExC_parse != ch)
5826                     vFAIL2("Sequence \\k%c... not terminated",
5827                         (ch == '>' ? '<' : ch));
5828
5829                 RExC_sawback = 1;
5830                 ret = reganode(pRExC_state,
5831                            (U8)(FOLD ? (LOC ? NREFFL : NREFF) : NREF),
5832                            num);
5833                 *flagp |= HASWIDTH;
5834
5835
5836                 if (!SIZE_ONLY) {
5837                     num = add_data( pRExC_state, 1, "S" );
5838                     ARG_SET(ret,num);
5839                     RExC_rx->data->data[num]=(void*)sv_dat;
5840                     SvREFCNT_inc(sv_dat);
5841                 }
5842                 /* override incorrect value set in reganode MJD */
5843                 Set_Node_Offset(ret, parse_start+1);
5844                 Set_Node_Cur_Length(ret); /* MJD */
5845                 nextchar(pRExC_state);
5846
5847             }
5848             break;
5849         }
5850         case 'n':
5851         case 'r':
5852         case 't':
5853         case 'f':
5854         case 'e':
5855         case 'a':
5856         case 'x':
5857         case 'c':
5858         case '0':
5859             goto defchar;
5860         case '1': case '2': case '3': case '4':
5861         case '5': case '6': case '7': case '8': case '9':
5862             {
5863                 const I32 num = atoi(RExC_parse);
5864
5865                 if (num > 9 && num >= RExC_npar)
5866                     goto defchar;
5867                 else {
5868                     char * const parse_start = RExC_parse - 1; /* MJD */
5869                     while (isDIGIT(*RExC_parse))
5870                         RExC_parse++;
5871
5872                     if (!SIZE_ONLY && num > (I32)RExC_rx->nparens)
5873                         vFAIL("Reference to nonexistent group");
5874                     RExC_sawback = 1;
5875                     ret = reganode(pRExC_state,
5876                                    (U8)(FOLD ? (LOC ? REFFL : REFF) : REF),
5877                                    num);
5878                     *flagp |= HASWIDTH;
5879
5880                     /* override incorrect value set in reganode MJD */
5881                     Set_Node_Offset(ret, parse_start+1);
5882                     Set_Node_Cur_Length(ret); /* MJD */
5883                     RExC_parse--;
5884                     nextchar(pRExC_state);
5885                 }
5886             }
5887             break;
5888         case '\0':
5889             if (RExC_parse >= RExC_end)
5890                 FAIL("Trailing \\");
5891             /* FALL THROUGH */
5892         default:
5893             /* Do not generate "unrecognized" warnings here, we fall
5894                back into the quick-grab loop below */
5895             parse_start--;
5896             goto defchar;
5897         }
5898         break;
5899
5900     case '#':
5901         if (RExC_flags & PMf_EXTENDED) {
5902             while (RExC_parse < RExC_end && *RExC_parse != '\n')
5903                 RExC_parse++;
5904             if (RExC_parse < RExC_end)
5905                 goto tryagain;
5906         }
5907         /* FALL THROUGH */
5908
5909     default: {
5910             register STRLEN len;
5911             register UV ender;
5912             register char *p;
5913             char *s;
5914             STRLEN foldlen;
5915             U8 tmpbuf[UTF8_MAXBYTES_CASE+1], *foldbuf;
5916
5917             parse_start = RExC_parse - 1;
5918
5919             RExC_parse++;
5920
5921         defchar:
5922             ender = 0;
5923             ret = reg_node(pRExC_state,
5924                            (U8)(FOLD ? (LOC ? EXACTFL : EXACTF) : EXACT));
5925             s = STRING(ret);
5926             for (len = 0, p = RExC_parse - 1;
5927               len < 127 && p < RExC_end;
5928               len++)
5929             {
5930                 char * const oldp = p;
5931
5932                 if (RExC_flags & PMf_EXTENDED)
5933                     p = regwhite(p, RExC_end);
5934                 switch (*p) {
5935                 case '^':
5936                 case '$':
5937                 case '.':
5938                 case '[':
5939                 case '(':
5940                 case ')':
5941                 case '|':
5942                     goto loopdone;
5943                 case '\\':
5944                     switch (*++p) {
5945                     case 'A':
5946                     case 'C':
5947                     case 'X':
5948                     case 'G':
5949                     case 'Z':
5950                     case 'z':
5951                     case 'w':
5952                     case 'W':
5953                     case 'b':
5954                     case 'B':
5955                     case 's':
5956                     case 'S':
5957                     case 'd':
5958                     case 'D':
5959                     case 'p':
5960                     case 'P':
5961                     case 'N':
5962                         --p;
5963                         goto loopdone;
5964                     case 'n':
5965                         ender = '\n';
5966                         p++;
5967                         break;
5968                     case 'r':
5969                         ender = '\r';
5970                         p++;
5971                         break;
5972                     case 't':
5973                         ender = '\t';
5974                         p++;
5975                         break;
5976                     case 'f':
5977                         ender = '\f';
5978                         p++;
5979                         break;
5980                     case 'e':
5981                           ender = ASCII_TO_NATIVE('\033');
5982                         p++;
5983                         break;
5984                     case 'a':
5985                           ender = ASCII_TO_NATIVE('\007');
5986                         p++;
5987                         break;
5988                     case 'x':
5989                         if (*++p == '{') {
5990                             char* const e = strchr(p, '}');
5991
5992                             if (!e) {
5993                                 RExC_parse = p + 1;
5994                                 vFAIL("Missing right brace on \\x{}");
5995                             }
5996                             else {
5997                                 I32 flags = PERL_SCAN_ALLOW_UNDERSCORES
5998                                     | PERL_SCAN_DISALLOW_PREFIX;
5999                                 STRLEN numlen = e - p - 1;
6000                                 ender = grok_hex(p + 1, &numlen, &flags, NULL);
6001                                 if (ender > 0xff)
6002                                     RExC_utf8 = 1;
6003                                 p = e + 1;
6004                             }
6005                         }
6006                         else {
6007                             I32 flags = PERL_SCAN_DISALLOW_PREFIX;
6008                             STRLEN numlen = 2;
6009                             ender = grok_hex(p, &numlen, &flags, NULL);
6010                             p += numlen;
6011                         }
6012                         break;
6013                     case 'c':
6014                         p++;
6015                         ender = UCHARAT(p++);
6016                         ender = toCTRL(ender);
6017                         break;
6018                     case '0': case '1': case '2': case '3':case '4':
6019                     case '5': case '6': case '7': case '8':case '9':
6020                         if (*p == '0' ||
6021                           (isDIGIT(p[1]) && atoi(p) >= RExC_npar) ) {
6022                             I32 flags = 0;
6023                             STRLEN numlen = 3;
6024                             ender = grok_oct(p, &numlen, &flags, NULL);
6025                             p += numlen;
6026                         }
6027                         else {
6028                             --p;
6029                             goto loopdone;
6030                         }
6031                         break;
6032                     case '\0':
6033                         if (p >= RExC_end)
6034                             FAIL("Trailing \\");
6035                         /* FALL THROUGH */
6036                     default:
6037                         if (!SIZE_ONLY&& isALPHA(*p) && ckWARN(WARN_REGEXP))
6038                             vWARN2(p + 1, "Unrecognized escape \\%c passed through", UCHARAT(p));
6039                         goto normal_default;
6040                     }
6041                     break;
6042                 default:
6043                   normal_default:
6044                     if (UTF8_IS_START(*p) && UTF) {
6045                         STRLEN numlen;
6046                         ender = utf8n_to_uvchr((U8*)p, RExC_end - p,
6047                                                &numlen, UTF8_ALLOW_DEFAULT);
6048                         p += numlen;
6049                     }
6050                     else
6051                         ender = *p++;
6052                     break;
6053                 }
6054                 if (RExC_flags & PMf_EXTENDED)
6055                     p = regwhite(p, RExC_end);
6056                 if (UTF && FOLD) {
6057                     /* Prime the casefolded buffer. */
6058                     ender = toFOLD_uni(ender, tmpbuf, &foldlen);
6059                 }
6060                 if (ISMULT2(p)) { /* Back off on ?+*. */
6061                     if (len)
6062                         p = oldp;
6063                     else if (UTF) {
6064                          if (FOLD) {
6065                               /* Emit all the Unicode characters. */
6066                               STRLEN numlen;
6067                               for (foldbuf = tmpbuf;
6068                                    foldlen;
6069                                    foldlen -= numlen) {
6070                                    ender = utf8_to_uvchr(foldbuf, &numlen);
6071                                    if (numlen > 0) {
6072                                         const STRLEN unilen = reguni(pRExC_state, ender, s);
6073                                         s       += unilen;
6074                                         len     += unilen;
6075                                         /* In EBCDIC the numlen
6076                                          * and unilen can differ. */
6077                                         foldbuf += numlen;
6078                                         if (numlen >= foldlen)
6079                                              break;
6080                                    }
6081                                    else
6082                                         break; /* "Can't happen." */
6083                               }
6084                          }
6085                          else {
6086                               const STRLEN unilen = reguni(pRExC_state, ender, s);
6087                               if (unilen > 0) {
6088                                    s   += unilen;
6089                                    len += unilen;
6090                               }
6091                          }
6092                     }
6093                     else {
6094                         len++;
6095                         REGC((char)ender, s++);
6096                     }
6097                     break;
6098                 }
6099                 if (UTF) {
6100                      if (FOLD) {
6101                           /* Emit all the Unicode characters. */
6102                           STRLEN numlen;
6103                           for (foldbuf = tmpbuf;
6104                                foldlen;
6105                                foldlen -= numlen) {
6106                                ender = utf8_to_uvchr(foldbuf, &numlen);
6107                                if (numlen > 0) {
6108                                     const STRLEN unilen = reguni(pRExC_state, ender, s);
6109                                     len     += unilen;
6110                                     s       += unilen;
6111                                     /* In EBCDIC the numlen
6112                                      * and unilen can differ. */
6113                                     foldbuf += numlen;
6114                                     if (numlen >= foldlen)
6115                                          break;
6116                                }
6117                                else
6118                                     break;
6119                           }
6120                      }
6121                      else {
6122                           const STRLEN unilen = reguni(pRExC_state, ender, s);
6123                           if (unilen > 0) {
6124                                s   += unilen;
6125                                len += unilen;
6126                           }
6127                      }
6128                      len--;
6129                 }
6130                 else
6131                     REGC((char)ender, s++);
6132             }
6133         loopdone:
6134             RExC_parse = p - 1;
6135             Set_Node_Cur_Length(ret); /* MJD */
6136             nextchar(pRExC_state);
6137             {
6138                 /* len is STRLEN which is unsigned, need to copy to signed */
6139                 IV iv = len;
6140                 if (iv < 0)
6141                     vFAIL("Internal disaster");
6142             }
6143             if (len > 0)
6144                 *flagp |= HASWIDTH;
6145             if (len == 1 && UNI_IS_INVARIANT(ender))
6146                 *flagp |= SIMPLE;
6147
6148             if (SIZE_ONLY)
6149                 RExC_size += STR_SZ(len);
6150             else {
6151                 STR_LEN(ret) = len;
6152                 RExC_emit += STR_SZ(len);
6153             }
6154         }
6155         break;
6156     }
6157
6158     /* If the encoding pragma is in effect recode the text of
6159      * any EXACT-kind nodes. */
6160     if (ret && PL_encoding && PL_regkind[OP(ret)] == EXACT) {
6161         const STRLEN oldlen = STR_LEN(ret);
6162         SV * const sv = sv_2mortal(newSVpvn(STRING(ret), oldlen));
6163
6164         if (RExC_utf8)
6165             SvUTF8_on(sv);
6166         if (sv_utf8_downgrade(sv, TRUE)) {
6167             const char * const s = sv_recode_to_utf8(sv, PL_encoding);
6168             const STRLEN newlen = SvCUR(sv);
6169
6170             if (SvUTF8(sv))
6171                 RExC_utf8 = 1;
6172             if (!SIZE_ONLY) {
6173                 GET_RE_DEBUG_FLAGS_DECL;
6174                 DEBUG_COMPILE_r(PerlIO_printf(Perl_debug_log, "recode %*s to %*s\n",
6175                                       (int)oldlen, STRING(ret),
6176                                       (int)newlen, s));
6177                 Copy(s, STRING(ret), newlen, char);
6178                 STR_LEN(ret) += newlen - oldlen;
6179                 RExC_emit += STR_SZ(newlen) - STR_SZ(oldlen);
6180             } else
6181                 RExC_size += STR_SZ(newlen) - STR_SZ(oldlen);
6182         }
6183     }
6184
6185     return(ret);
6186 }
6187
6188 STATIC char *
6189 S_regwhite(char *p, const char *e)
6190 {
6191     while (p < e) {
6192         if (isSPACE(*p))
6193             ++p;
6194         else if (*p == '#') {
6195             do {
6196                 p++;
6197             } while (p < e && *p != '\n');
6198         }
6199         else
6200             break;
6201     }
6202     return p;
6203 }
6204
6205 /* Parse POSIX character classes: [[:foo:]], [[=foo=]], [[.foo.]].
6206    Character classes ([:foo:]) can also be negated ([:^foo:]).
6207    Returns a named class id (ANYOF_XXX) if successful, -1 otherwise.
6208    Equivalence classes ([=foo=]) and composites ([.foo.]) are parsed,
6209    but trigger failures because they are currently unimplemented. */
6210
6211 #define POSIXCC_DONE(c)   ((c) == ':')
6212 #define POSIXCC_NOTYET(c) ((c) == '=' || (c) == '.')
6213 #define POSIXCC(c) (POSIXCC_DONE(c) || POSIXCC_NOTYET(c))
6214
6215 STATIC I32
6216 S_regpposixcc(pTHX_ RExC_state_t *pRExC_state, I32 value)
6217 {
6218     dVAR;
6219     I32 namedclass = OOB_NAMEDCLASS;
6220
6221     if (value == '[' && RExC_parse + 1 < RExC_end &&
6222         /* I smell either [: or [= or [. -- POSIX has been here, right? */
6223         POSIXCC(UCHARAT(RExC_parse))) {
6224         const char c = UCHARAT(RExC_parse);
6225         char* const s = RExC_parse++;
6226
6227         while (RExC_parse < RExC_end && UCHARAT(RExC_parse) != c)
6228             RExC_parse++;
6229         if (RExC_parse == RExC_end)
6230             /* Grandfather lone [:, [=, [. */
6231             RExC_parse = s;
6232         else {
6233             const char* const t = RExC_parse++; /* skip over the c */
6234             assert(*t == c);
6235
6236             if (UCHARAT(RExC_parse) == ']') {
6237                 const char *posixcc = s + 1;
6238                 RExC_parse++; /* skip over the ending ] */
6239
6240                 if (*s == ':') {
6241                     const I32 complement = *posixcc == '^' ? *posixcc++ : 0;
6242                     const I32 skip = t - posixcc;
6243
6244                     /* Initially switch on the length of the name.  */
6245                     switch (skip) {
6246                     case 4:
6247                         if (memEQ(posixcc, "word", 4)) /* this is not POSIX, this is the Perl \w */
6248                             namedclass = complement ? ANYOF_NALNUM : ANYOF_ALNUM;
6249                         break;
6250                     case 5:
6251                         /* Names all of length 5.  */
6252                         /* alnum alpha ascii blank cntrl digit graph lower
6253                            print punct space upper  */
6254                         /* Offset 4 gives the best switch position.  */
6255                         switch (posixcc[4]) {
6256                         case 'a':
6257                             if (memEQ(posixcc, "alph", 4)) /* alpha */
6258                                 namedclass = complement ? ANYOF_NALPHA : ANYOF_ALPHA;
6259                             break;
6260                         case 'e':
6261                             if (memEQ(posixcc, "spac", 4)) /* space */
6262                                 namedclass = complement ? ANYOF_NPSXSPC : ANYOF_PSXSPC;
6263                             break;
6264                         case 'h':
6265                             if (memEQ(posixcc, "grap", 4)) /* graph */
6266                                 namedclass = complement ? ANYOF_NGRAPH : ANYOF_GRAPH;
6267                             break;
6268                         case 'i':
6269                             if (memEQ(posixcc, "asci", 4)) /* ascii */
6270                                 namedclass = complement ? ANYOF_NASCII : ANYOF_ASCII;
6271                             break;
6272                         case 'k':
6273                             if (memEQ(posixcc, "blan", 4)) /* blank */
6274                                 namedclass = complement ? ANYOF_NBLANK : ANYOF_BLANK;
6275                             break;
6276                         case 'l':
6277                             if (memEQ(posixcc, "cntr", 4)) /* cntrl */
6278                                 namedclass = complement ? ANYOF_NCNTRL : ANYOF_CNTRL;
6279                             break;
6280                         case 'm':
6281                             if (memEQ(posixcc, "alnu", 4)) /* alnum */
6282                                 namedclass = complement ? ANYOF_NALNUMC : ANYOF_ALNUMC;
6283                             break;
6284                         case 'r':
6285                             if (memEQ(posixcc, "lowe", 4)) /* lower */
6286                                 namedclass = complement ? ANYOF_NLOWER : ANYOF_LOWER;
6287                             else if (memEQ(posixcc, "uppe", 4)) /* upper */
6288                                 namedclass = complement ? ANYOF_NUPPER : ANYOF_UPPER;
6289                             break;
6290                         case 't':
6291                             if (memEQ(posixcc, "digi", 4)) /* digit */
6292                                 namedclass = complement ? ANYOF_NDIGIT : ANYOF_DIGIT;
6293                             else if (memEQ(posixcc, "prin", 4)) /* print */
6294                                 namedclass = complement ? ANYOF_NPRINT : ANYOF_PRINT;
6295                             else if (memEQ(posixcc, "punc", 4)) /* punct */
6296                                 namedclass = complement ? ANYOF_NPUNCT : ANYOF_PUNCT;
6297                             break;
6298                         }
6299                         break;
6300                     case 6:
6301                         if (memEQ(posixcc, "xdigit", 6))
6302                             namedclass = complement ? ANYOF_NXDIGIT : ANYOF_XDIGIT;
6303                         break;
6304                     }
6305
6306                     if (namedclass == OOB_NAMEDCLASS)
6307                         Simple_vFAIL3("POSIX class [:%.*s:] unknown",
6308                                       t - s - 1, s + 1);
6309                     assert (posixcc[skip] == ':');
6310                     assert (posixcc[skip+1] == ']');
6311                 } else if (!SIZE_ONLY) {
6312                     /* [[=foo=]] and [[.foo.]] are still future. */
6313
6314                     /* adjust RExC_parse so the warning shows after
6315                        the class closes */
6316                     while (UCHARAT(RExC_parse) && UCHARAT(RExC_parse) != ']')
6317                         RExC_parse++;
6318                     Simple_vFAIL3("POSIX syntax [%c %c] is reserved for future extensions", c, c);
6319                 }
6320             } else {
6321                 /* Maternal grandfather:
6322                  * "[:" ending in ":" but not in ":]" */
6323                 RExC_parse = s;
6324             }
6325         }
6326     }
6327
6328     return namedclass;
6329 }
6330
6331 STATIC void
6332 S_checkposixcc(pTHX_ RExC_state_t *pRExC_state)
6333 {
6334     dVAR;
6335     if (POSIXCC(UCHARAT(RExC_parse))) {
6336         const char *s = RExC_parse;
6337         const char  c = *s++;
6338
6339         while (isALNUM(*s))
6340             s++;
6341         if (*s && c == *s && s[1] == ']') {
6342             if (ckWARN(WARN_REGEXP))
6343                 vWARN3(s+2,
6344                         "POSIX syntax [%c %c] belongs inside character classes",
6345                         c, c);
6346
6347             /* [[=foo=]] and [[.foo.]] are still future. */
6348             if (POSIXCC_NOTYET(c)) {
6349                 /* adjust RExC_parse so the error shows after
6350                    the class closes */
6351                 while (UCHARAT(RExC_parse) && UCHARAT(RExC_parse++) != ']')
6352                     NOOP;
6353                 Simple_vFAIL3("POSIX syntax [%c %c] is reserved for future extensions", c, c);
6354             }
6355         }
6356     }
6357 }
6358
6359
6360 /*
6361    parse a class specification and produce either an ANYOF node that
6362    matches the pattern. If the pattern matches a single char only and
6363    that char is < 256 then we produce an EXACT node instead.
6364 */
6365 STATIC regnode *
6366 S_regclass(pTHX_ RExC_state_t *pRExC_state, U32 depth)
6367 {
6368     dVAR;
6369     register UV value = 0;
6370     register UV nextvalue;
6371     register IV prevvalue = OOB_UNICODE;
6372     register IV range = 0;
6373     register regnode *ret;
6374     STRLEN numlen;
6375     IV namedclass;
6376     char *rangebegin = NULL;
6377     bool need_class = 0;
6378     SV *listsv = NULL;
6379     UV n;
6380     bool optimize_invert   = TRUE;
6381     AV* unicode_alternate  = NULL;
6382 #ifdef EBCDIC
6383     UV literal_endpoint = 0;
6384 #endif
6385     UV stored = 0;  /* number of chars stored in the class */
6386
6387     regnode * const orig_emit = RExC_emit; /* Save the original RExC_emit in
6388         case we need to change the emitted regop to an EXACT. */
6389     const char * orig_parse = RExC_parse;
6390     GET_RE_DEBUG_FLAGS_DECL;
6391 #ifndef DEBUGGING
6392     PERL_UNUSED_ARG(depth);
6393 #endif
6394
6395     DEBUG_PARSE("clas");
6396
6397     /* Assume we are going to generate an ANYOF node. */
6398     ret = reganode(pRExC_state, ANYOF, 0);
6399
6400     if (!SIZE_ONLY)
6401         ANYOF_FLAGS(ret) = 0;
6402
6403     if (UCHARAT(RExC_parse) == '^') {   /* Complement of range. */
6404         RExC_naughty++;
6405         RExC_parse++;
6406         if (!SIZE_ONLY)
6407             ANYOF_FLAGS(ret) |= ANYOF_INVERT;
6408     }
6409
6410     if (SIZE_ONLY) {
6411         RExC_size += ANYOF_SKIP;
6412         listsv = &PL_sv_undef; /* For code scanners: listsv always non-NULL. */
6413     }
6414     else {
6415         RExC_emit += ANYOF_SKIP;
6416         if (FOLD)
6417             ANYOF_FLAGS(ret) |= ANYOF_FOLD;
6418         if (LOC)
6419             ANYOF_FLAGS(ret) |= ANYOF_LOCALE;
6420         ANYOF_BITMAP_ZERO(ret);
6421         listsv = newSVpvs("# comment\n");
6422     }
6423
6424     nextvalue = RExC_parse < RExC_end ? UCHARAT(RExC_parse) : 0;
6425
6426     if (!SIZE_ONLY && POSIXCC(nextvalue))
6427         checkposixcc(pRExC_state);
6428
6429     /* allow 1st char to be ] (allowing it to be - is dealt with later) */
6430     if (UCHARAT(RExC_parse) == ']')
6431         goto charclassloop;
6432
6433 parseit:
6434     while (RExC_parse < RExC_end && UCHARAT(RExC_parse) != ']') {
6435
6436     charclassloop:
6437
6438         namedclass = OOB_NAMEDCLASS; /* initialize as illegal */
6439
6440         if (!range)
6441             rangebegin = RExC_parse;
6442         if (UTF) {
6443             value = utf8n_to_uvchr((U8*)RExC_parse,
6444                                    RExC_end - RExC_parse,
6445                                    &numlen, UTF8_ALLOW_DEFAULT);
6446             RExC_parse += numlen;
6447         }
6448         else
6449             value = UCHARAT(RExC_parse++);
6450
6451         nextvalue = RExC_parse < RExC_end ? UCHARAT(RExC_parse) : 0;
6452         if (value == '[' && POSIXCC(nextvalue))
6453             namedclass = regpposixcc(pRExC_state, value);
6454         else if (value == '\\') {
6455             if (UTF) {
6456                 value = utf8n_to_uvchr((U8*)RExC_parse,
6457                                    RExC_end - RExC_parse,
6458                                    &numlen, UTF8_ALLOW_DEFAULT);
6459                 RExC_parse += numlen;
6460             }
6461             else
6462                 value = UCHARAT(RExC_parse++);
6463             /* Some compilers cannot handle switching on 64-bit integer
6464              * values, therefore value cannot be an UV.  Yes, this will
6465              * be a problem later if we want switch on Unicode.
6466              * A similar issue a little bit later when switching on
6467              * namedclass. --jhi */
6468             switch ((I32)value) {
6469             case 'w':   namedclass = ANYOF_ALNUM;       break;
6470             case 'W':   namedclass = ANYOF_NALNUM;      break;
6471             case 's':   namedclass = ANYOF_SPACE;       break;
6472             case 'S':   namedclass = ANYOF_NSPACE;      break;
6473             case 'd':   namedclass = ANYOF_DIGIT;       break;
6474             case 'D':   namedclass = ANYOF_NDIGIT;      break;
6475             case 'N':  /* Handle \N{NAME} in class */
6476                 {
6477                     /* We only pay attention to the first char of
6478                     multichar strings being returned. I kinda wonder
6479                     if this makes sense as it does change the behaviour
6480                     from earlier versions, OTOH that behaviour was broken
6481                     as well. */
6482                     UV v; /* value is register so we cant & it /grrr */
6483                     if (reg_namedseq(pRExC_state, &v)) {
6484                         goto parseit;
6485                     }
6486                     value= v;
6487                 }
6488                 break;
6489             case 'p':
6490             case 'P':
6491                 {
6492                 char *e;
6493                 if (RExC_parse >= RExC_end)
6494                     vFAIL2("Empty \\%c{}", (U8)value);
6495                 if (*RExC_parse == '{') {
6496                     const U8 c = (U8)value;
6497                     e = strchr(RExC_parse++, '}');
6498                     if (!e)
6499                         vFAIL2("Missing right brace on \\%c{}", c);
6500                     while (isSPACE(UCHARAT(RExC_parse)))
6501                         RExC_parse++;
6502                     if (e == RExC_parse)
6503                         vFAIL2("Empty \\%c{}", c);
6504                     n = e - RExC_parse;
6505                     while (isSPACE(UCHARAT(RExC_parse + n - 1)))
6506                         n--;
6507                 }
6508                 else {
6509                     e = RExC_parse;
6510                     n = 1;
6511                 }
6512                 if (!SIZE_ONLY) {
6513                     if (UCHARAT(RExC_parse) == '^') {
6514                          RExC_parse++;
6515                          n--;
6516                          value = value == 'p' ? 'P' : 'p'; /* toggle */
6517                          while (isSPACE(UCHARAT(RExC_parse))) {
6518                               RExC_parse++;
6519                               n--;
6520                          }
6521                     }
6522                     Perl_sv_catpvf(aTHX_ listsv, "%cutf8::%.*s\n",
6523                         (value=='p' ? '+' : '!'), (int)n, RExC_parse);
6524                 }
6525                 RExC_parse = e + 1;
6526                 ANYOF_FLAGS(ret) |= ANYOF_UNICODE;
6527                 namedclass = ANYOF_MAX;  /* no official name, but it's named */
6528                 }
6529                 break;
6530             case 'n':   value = '\n';                   break;
6531             case 'r':   value = '\r';                   break;
6532             case 't':   value = '\t';                   break;
6533             case 'f':   value = '\f';                   break;
6534             case 'b':   value = '\b';                   break;
6535             case 'e':   value = ASCII_TO_NATIVE('\033');break;
6536             case 'a':   value = ASCII_TO_NATIVE('\007');break;
6537             case 'x':
6538                 if (*RExC_parse == '{') {
6539                     I32 flags = PERL_SCAN_ALLOW_UNDERSCORES
6540                         | PERL_SCAN_DISALLOW_PREFIX;
6541                     char * const e = strchr(RExC_parse++, '}');
6542                     if (!e)
6543                         vFAIL("Missing right brace on \\x{}");
6544
6545                     numlen = e - RExC_parse;
6546                     value = grok_hex(RExC_parse, &numlen, &flags, NULL);
6547                     RExC_parse = e + 1;
6548                 }
6549                 else {
6550                     I32 flags = PERL_SCAN_DISALLOW_PREFIX;
6551                     numlen = 2;
6552                     value = grok_hex(RExC_parse, &numlen, &flags, NULL);
6553                     RExC_parse += numlen;
6554                 }
6555                 break;
6556             case 'c':
6557                 value = UCHARAT(RExC_parse++);
6558                 value = toCTRL(value);
6559                 break;
6560             case '0': case '1': case '2': case '3': case '4':
6561             case '5': case '6': case '7': case '8': case '9':
6562             {
6563                 I32 flags = 0;
6564                 numlen = 3;
6565                 value = grok_oct(--RExC_parse, &numlen, &flags, NULL);
6566                 RExC_parse += numlen;
6567                 break;
6568             }
6569             default:
6570                 if (!SIZE_ONLY && isALPHA(value) && ckWARN(WARN_REGEXP))
6571                     vWARN2(RExC_parse,
6572                            "Unrecognized escape \\%c in character class passed through",
6573                            (int)value);
6574                 break;
6575             }
6576         } /* end of \blah */
6577 #ifdef EBCDIC
6578         else
6579             literal_endpoint++;
6580 #endif
6581
6582         if (namedclass > OOB_NAMEDCLASS) { /* this is a named class \blah */
6583
6584             if (!SIZE_ONLY && !need_class)
6585                 ANYOF_CLASS_ZERO(ret);
6586
6587             need_class = 1;
6588
6589             /* a bad range like a-\d, a-[:digit:] ? */
6590             if (range) {
6591                 if (!SIZE_ONLY) {
6592                     if (ckWARN(WARN_REGEXP)) {
6593                         const int w =
6594                             RExC_parse >= rangebegin ?
6595                             RExC_parse - rangebegin : 0;
6596                         vWARN4(RExC_parse,
6597                                "False [] range \"%*.*s\"",
6598                                w, w, rangebegin);
6599                     }
6600                     if (prevvalue < 256) {
6601                         ANYOF_BITMAP_SET(ret, prevvalue);
6602                         ANYOF_BITMAP_SET(ret, '-');
6603                     }
6604                     else {
6605                         ANYOF_FLAGS(ret) |= ANYOF_UNICODE;
6606                         Perl_sv_catpvf(aTHX_ listsv,
6607                                        "%04"UVxf"\n%04"UVxf"\n", (UV)prevvalue, (UV) '-');
6608                     }
6609                 }
6610
6611                 range = 0; /* this was not a true range */
6612             }
6613
6614             if (!SIZE_ONLY) {
6615                 const char *what = NULL;
6616                 char yesno = 0;
6617
6618                 if (namedclass > OOB_NAMEDCLASS)
6619                     optimize_invert = FALSE;
6620                 /* Possible truncation here but in some 64-bit environments
6621                  * the compiler gets heartburn about switch on 64-bit values.
6622                  * A similar issue a little earlier when switching on value.
6623                  * --jhi */
6624                 switch ((I32)namedclass) {
6625                 case ANYOF_ALNUM:
6626                     if (LOC)
6627                         ANYOF_CLASS_SET(ret, ANYOF_ALNUM);
6628                     else {
6629                         for (value = 0; value < 256; value++)
6630                             if (isALNUM(value))
6631                                 ANYOF_BITMAP_SET(ret, value);
6632                     }
6633                     yesno = '+';
6634                     what = "Word";
6635                     break;
6636                 case ANYOF_NALNUM:
6637                     if (LOC)
6638                         ANYOF_CLASS_SET(ret, ANYOF_NALNUM);
6639                     else {
6640                         for (value = 0; value < 256; value++)
6641                             if (!isALNUM(value))
6642                                 ANYOF_BITMAP_SET(ret, value);
6643                     }
6644                     yesno = '!';
6645                     what = "Word";
6646                     break;
6647                 case ANYOF_ALNUMC:
6648                     if (LOC)
6649                         ANYOF_CLASS_SET(ret, ANYOF_ALNUMC);
6650                     else {
6651                         for (value = 0; value < 256; value++)
6652                             if (isALNUMC(value))
6653                                 ANYOF_BITMAP_SET(ret, value);
6654                     }
6655                     yesno = '+';
6656                     what = "Alnum";
6657                     break;
6658                 case ANYOF_NALNUMC:
6659                     if (LOC)
6660                         ANYOF_CLASS_SET(ret, ANYOF_NALNUMC);
6661                     else {
6662                         for (value = 0; value < 256; value++)
6663                             if (!isALNUMC(value))
6664                                 ANYOF_BITMAP_SET(ret, value);
6665                     }
6666                     yesno = '!';
6667                     what = "Alnum";
6668                     break;
6669                 case ANYOF_ALPHA:
6670                     if (LOC)
6671                         ANYOF_CLASS_SET(ret, ANYOF_ALPHA);
6672                     else {
6673                         for (value = 0; value < 256; value++)
6674                             if (isALPHA(value))
6675                                 ANYOF_BITMAP_SET(ret, value);
6676                     }
6677                     yesno = '+';
6678                     what = "Alpha";
6679                     break;
6680                 case ANYOF_NALPHA:
6681                     if (LOC)
6682                         ANYOF_CLASS_SET(ret, ANYOF_NALPHA);
6683                     else {
6684                         for (value = 0; value < 256; value++)
6685                             if (!isALPHA(value))
6686                                 ANYOF_BITMAP_SET(ret, value);
6687                     }
6688                     yesno = '!';
6689                     what = "Alpha";
6690                     break;
6691                 case ANYOF_ASCII:
6692                     if (LOC)
6693                         ANYOF_CLASS_SET(ret, ANYOF_ASCII);
6694                     else {
6695 #ifndef EBCDIC
6696                         for (value = 0; value < 128; value++)
6697                             ANYOF_BITMAP_SET(ret, value);
6698 #else  /* EBCDIC */
6699                         for (value = 0; value < 256; value++) {
6700                             if (isASCII(value))
6701                                 ANYOF_BITMAP_SET(ret, value);
6702                         }
6703 #endif /* EBCDIC */
6704                     }
6705                     yesno = '+';
6706                     what = "ASCII";
6707                     break;
6708                 case ANYOF_NASCII:
6709                     if (LOC)
6710                         ANYOF_CLASS_SET(ret, ANYOF_NASCII);
6711                     else {
6712 #ifndef EBCDIC
6713                         for (value = 128; value < 256; value++)
6714                             ANYOF_BITMAP_SET(ret, value);
6715 #else  /* EBCDIC */
6716                         for (value = 0; value < 256; value++) {
6717                             if (!isASCII(value))
6718                                 ANYOF_BITMAP_SET(ret, value);
6719                         }
6720 #endif /* EBCDIC */
6721                     }
6722                     yesno = '!';
6723                     what = "ASCII";
6724                     break;
6725                 case ANYOF_BLANK:
6726                     if (LOC)
6727                         ANYOF_CLASS_SET(ret, ANYOF_BLANK);
6728                     else {
6729                         for (value = 0; value < 256; value++)
6730                             if (isBLANK(value))
6731                                 ANYOF_BITMAP_SET(ret, value);
6732                     }
6733                     yesno = '+';
6734                     what = "Blank";
6735                     break;
6736                 case ANYOF_NBLANK:
6737                     if (LOC)
6738                         ANYOF_CLASS_SET(ret, ANYOF_NBLANK);
6739                     else {
6740                         for (value = 0; value < 256; value++)
6741                             if (!isBLANK(value))
6742                                 ANYOF_BITMAP_SET(ret, value);
6743                     }
6744                     yesno = '!';
6745                     what = "Blank";
6746                     break;
6747                 case ANYOF_CNTRL:
6748                     if (LOC)
6749                         ANYOF_CLASS_SET(ret, ANYOF_CNTRL);
6750                     else {
6751                         for (value = 0; value < 256; value++)
6752                             if (isCNTRL(value))
6753                                 ANYOF_BITMAP_SET(ret, value);
6754                     }
6755                     yesno = '+';
6756                     what = "Cntrl";
6757                     break;
6758                 case ANYOF_NCNTRL:
6759                     if (LOC)
6760                         ANYOF_CLASS_SET(ret, ANYOF_NCNTRL);
6761                     else {
6762                         for (value = 0; value < 256; value++)
6763                             if (!isCNTRL(value))
6764                                 ANYOF_BITMAP_SET(ret, value);
6765                     }
6766                     yesno = '!';
6767                     what = "Cntrl";
6768                     break;
6769                 case ANYOF_DIGIT:
6770                     if (LOC)
6771                         ANYOF_CLASS_SET(ret, ANYOF_DIGIT);
6772                     else {
6773                         /* consecutive digits assumed */
6774                         for (value = '0'; value <= '9'; value++)
6775                             ANYOF_BITMAP_SET(ret, value);
6776                     }
6777                     yesno = '+';
6778                     what = "Digit";
6779                     break;
6780                 case ANYOF_NDIGIT:
6781                     if (LOC)
6782                         ANYOF_CLASS_SET(ret, ANYOF_NDIGIT);
6783                     else {
6784                         /* consecutive digits assumed */
6785                         for (value = 0; value < '0'; value++)
6786                             ANYOF_BITMAP_SET(ret, value);
6787                         for (value = '9' + 1; value < 256; value++)
6788                             ANYOF_BITMAP_SET(ret, value);
6789                     }
6790                     yesno = '!';
6791                     what = "Digit";
6792                     break;
6793                 case ANYOF_GRAPH:
6794                     if (LOC)
6795                         ANYOF_CLASS_SET(ret, ANYOF_GRAPH);
6796                     else {
6797                         for (value = 0; value < 256; value++)
6798                             if (isGRAPH(value))
6799                                 ANYOF_BITMAP_SET(ret, value);
6800                     }
6801                     yesno = '+';
6802                     what = "Graph";
6803                     break;
6804                 case ANYOF_NGRAPH:
6805                     if (LOC)
6806                         ANYOF_CLASS_SET(ret, ANYOF_NGRAPH);
6807                     else {
6808                         for (value = 0; value < 256; value++)
6809                             if (!isGRAPH(value))
6810                                 ANYOF_BITMAP_SET(ret, value);
6811                     }
6812                     yesno = '!';
6813                     what = "Graph";
6814                     break;
6815                 case ANYOF_LOWER:
6816                     if (LOC)
6817                         ANYOF_CLASS_SET(ret, ANYOF_LOWER);
6818                     else {
6819                         for (value = 0; value < 256; value++)
6820                             if (isLOWER(value))
6821                                 ANYOF_BITMAP_SET(ret, value);
6822                     }
6823                     yesno = '+';
6824                     what = "Lower";
6825                     break;
6826                 case ANYOF_NLOWER:
6827                     if (LOC)
6828                         ANYOF_CLASS_SET(ret, ANYOF_NLOWER);
6829                     else {
6830                         for (value = 0; value < 256; value++)
6831                             if (!isLOWER(value))
6832                                 ANYOF_BITMAP_SET(ret, value);
6833                     }
6834                     yesno = '!';
6835                     what = "Lower";
6836                     break;
6837                 case ANYOF_PRINT:
6838                     if (LOC)
6839                         ANYOF_CLASS_SET(ret, ANYOF_PRINT);
6840                     else {
6841                         for (value = 0; value < 256; value++)
6842                             if (isPRINT(value))
6843                                 ANYOF_BITMAP_SET(ret, value);
6844                     }
6845                     yesno = '+';
6846                     what = "Print";
6847                     break;
6848                 case ANYOF_NPRINT:
6849                     if (LOC)
6850                         ANYOF_CLASS_SET(ret, ANYOF_NPRINT);
6851                     else {
6852                         for (value = 0; value < 256; value++)
6853                             if (!isPRINT(value))
6854                                 ANYOF_BITMAP_SET(ret, value);
6855                     }
6856                     yesno = '!';
6857                     what = "Print";
6858                     break;
6859                 case ANYOF_PSXSPC:
6860                     if (LOC)
6861                         ANYOF_CLASS_SET(ret, ANYOF_PSXSPC);
6862                     else {
6863                         for (value = 0; value < 256; value++)
6864                             if (isPSXSPC(value))
6865                                 ANYOF_BITMAP_SET(ret, value);
6866                     }
6867                     yesno = '+';
6868                     what = "Space";
6869                     break;
6870                 case ANYOF_NPSXSPC:
6871                     if (LOC)
6872                         ANYOF_CLASS_SET(ret, ANYOF_NPSXSPC);
6873                     else {
6874                         for (value = 0; value < 256; value++)
6875                             if (!isPSXSPC(value))
6876                                 ANYOF_BITMAP_SET(ret, value);
6877                     }
6878                     yesno = '!';
6879                     what = "Space";
6880                     break;
6881                 case ANYOF_PUNCT:
6882                     if (LOC)
6883                         ANYOF_CLASS_SET(ret, ANYOF_PUNCT);
6884                     else {
6885                         for (value = 0; value < 256; value++)
6886                             if (isPUNCT(value))
6887                                 ANYOF_BITMAP_SET(ret, value);
6888                     }
6889                     yesno = '+';
6890                     what = "Punct";
6891                     break;
6892                 case ANYOF_NPUNCT:
6893                     if (LOC)
6894                         ANYOF_CLASS_SET(ret, ANYOF_NPUNCT);
6895                     else {
6896                         for (value = 0; value < 256; value++)
6897                             if (!isPUNCT(value))
6898                                 ANYOF_BITMAP_SET(ret, value);
6899                     }
6900                     yesno = '!';
6901                     what = "Punct";
6902                     break;
6903                 case ANYOF_SPACE:
6904                     if (LOC)
6905                         ANYOF_CLASS_SET(ret, ANYOF_SPACE);
6906                     else {
6907                         for (value = 0; value < 256; value++)
6908                             if (isSPACE(value))
6909                                 ANYOF_BITMAP_SET(ret, value);
6910                     }
6911                     yesno = '+';
6912                     what = "SpacePerl";
6913                     break;
6914                 case ANYOF_NSPACE:
6915                     if (LOC)
6916                         ANYOF_CLASS_SET(ret, ANYOF_NSPACE);
6917                     else {
6918                         for (value = 0; value < 256; value++)
6919                             if (!isSPACE(value))
6920                                 ANYOF_BITMAP_SET(ret, value);
6921                     }
6922                     yesno = '!';
6923                     what = "SpacePerl";
6924                     break;
6925                 case ANYOF_UPPER:
6926                     if (LOC)
6927                         ANYOF_CLASS_SET(ret, ANYOF_UPPER);
6928                     else {
6929                         for (value = 0; value < 256; value++)
6930                             if (isUPPER(value))
6931                                 ANYOF_BITMAP_SET(ret, value);
6932                     }
6933                     yesno = '+';
6934                     what = "Upper";
6935                     break;
6936                 case ANYOF_NUPPER:
6937                     if (LOC)
6938                         ANYOF_CLASS_SET(ret, ANYOF_NUPPER);
6939                     else {
6940                         for (value = 0; value < 256; value++)
6941                             if (!isUPPER(value))
6942                                 ANYOF_BITMAP_SET(ret, value);
6943                     }
6944                     yesno = '!';
6945                     what = "Upper";
6946                     break;
6947                 case ANYOF_XDIGIT:
6948                     if (LOC)
6949                         ANYOF_CLASS_SET(ret, ANYOF_XDIGIT);
6950                     else {
6951                         for (value = 0; value < 256; value++)
6952                             if (isXDIGIT(value))
6953                                 ANYOF_BITMAP_SET(ret, value);
6954                     }
6955                     yesno = '+';
6956                     what = "XDigit";
6957                     break;
6958                 case ANYOF_NXDIGIT:
6959                     if (LOC)
6960                         ANYOF_CLASS_SET(ret, ANYOF_NXDIGIT);
6961                     else {
6962                         for (value = 0; value < 256; value++)
6963                             if (!isXDIGIT(value))
6964                                 ANYOF_BITMAP_SET(ret, value);
6965                     }
6966                     yesno = '!';
6967                     what = "XDigit";
6968                     break;
6969                 case ANYOF_MAX:
6970                     /* this is to handle \p and \P */
6971                     break;
6972                 default:
6973                     vFAIL("Invalid [::] class");
6974                     break;
6975                 }
6976                 if (what) {
6977                     /* Strings such as "+utf8::isWord\n" */
6978                     Perl_sv_catpvf(aTHX_ listsv, "%cutf8::Is%s\n", yesno, what);
6979                 }
6980                 if (LOC)
6981                     ANYOF_FLAGS(ret) |= ANYOF_CLASS;
6982                 continue;
6983             }
6984         } /* end of namedclass \blah */
6985
6986         if (range) {
6987             if (prevvalue > (IV)value) /* b-a */ {
6988                 const int w = RExC_parse - rangebegin;
6989                 Simple_vFAIL4("Invalid [] range \"%*.*s\"", w, w, rangebegin);
6990                 range = 0; /* not a valid range */
6991             }
6992         }
6993         else {
6994             prevvalue = value; /* save the beginning of the range */
6995             if (*RExC_parse == '-' && RExC_parse+1 < RExC_end &&
6996                 RExC_parse[1] != ']') {
6997                 RExC_parse++;
6998
6999                 /* a bad range like \w-, [:word:]- ? */
7000                 if (namedclass > OOB_NAMEDCLASS) {
7001                     if (ckWARN(WARN_REGEXP)) {
7002                         const int w =
7003                             RExC_parse >= rangebegin ?
7004                             RExC_parse - rangebegin : 0;
7005                         vWARN4(RExC_parse,
7006                                "False [] range \"%*.*s\"",
7007                                w, w, rangebegin);
7008                     }
7009                     if (!SIZE_ONLY)
7010                         ANYOF_BITMAP_SET(ret, '-');
7011                 } else
7012                     range = 1;  /* yeah, it's a range! */
7013                 continue;       /* but do it the next time */
7014             }
7015         }
7016
7017         /* now is the next time */
7018         /*stored += (value - prevvalue + 1);*/
7019         if (!SIZE_ONLY) {
7020             if (prevvalue < 256) {
7021                 const IV ceilvalue = value < 256 ? value : 255;
7022                 IV i;
7023 #ifdef EBCDIC
7024                 /* In EBCDIC [\x89-\x91] should include
7025                  * the \x8e but [i-j] should not. */
7026                 if (literal_endpoint == 2 &&
7027                     ((isLOWER(prevvalue) && isLOWER(ceilvalue)) ||
7028                      (isUPPER(prevvalue) && isUPPER(ceilvalue))))
7029                 {
7030                     if (isLOWER(prevvalue)) {
7031                         for (i = prevvalue; i <= ceilvalue; i++)
7032                             if (isLOWER(i))
7033                                 ANYOF_BITMAP_SET(ret, i);
7034                     } else {
7035                         for (i = prevvalue; i <= ceilvalue; i++)
7036                             if (isUPPER(i))
7037                                 ANYOF_BITMAP_SET(ret, i);
7038                     }
7039                 }
7040                 else
7041 #endif
7042                       for (i = prevvalue; i <= ceilvalue; i++) {
7043                         if (!ANYOF_BITMAP_TEST(ret,i)) {
7044                             stored++;
7045                             ANYOF_BITMAP_SET(ret, i);
7046                         }
7047                       }
7048           }
7049           if (value > 255 || UTF) {
7050                 const UV prevnatvalue  = NATIVE_TO_UNI(prevvalue);
7051                 const UV natvalue      = NATIVE_TO_UNI(value);
7052                 stored+=2; /* can't optimize this class */
7053                 ANYOF_FLAGS(ret) |= ANYOF_UNICODE;
7054                 if (prevnatvalue < natvalue) { /* what about > ? */
7055                     Perl_sv_catpvf(aTHX_ listsv, "%04"UVxf"\t%04"UVxf"\n",
7056                                    prevnatvalue, natvalue);
7057                 }
7058                 else if (prevnatvalue == natvalue) {
7059                     Perl_sv_catpvf(aTHX_ listsv, "%04"UVxf"\n", natvalue);
7060                     if (FOLD) {
7061                          U8 foldbuf[UTF8_MAXBYTES_CASE+1];
7062                          STRLEN foldlen;
7063                          const UV f = to_uni_fold(natvalue, foldbuf, &foldlen);
7064
7065 #ifdef EBCDIC /* RD t/uni/fold ff and 6b */
7066                          if (RExC_precomp[0] == ':' &&
7067                              RExC_precomp[1] == '[' &&
7068                              (f == 0xDF || f == 0x92)) {
7069                              f = NATIVE_TO_UNI(f);
7070                         }
7071 #endif
7072                          /* If folding and foldable and a single
7073                           * character, insert also the folded version
7074                           * to the charclass. */
7075                          if (f != value) {
7076 #ifdef EBCDIC /* RD tunifold ligatures s,t fb05, fb06 */
7077                              if ((RExC_precomp[0] == ':' &&
7078                                   RExC_precomp[1] == '[' &&
7079                                   (f == 0xA2 &&
7080                                    (value == 0xFB05 || value == 0xFB06))) ?
7081                                  foldlen == ((STRLEN)UNISKIP(f) - 1) :
7082                                  foldlen == (STRLEN)UNISKIP(f) )
7083 #else
7084                               if (foldlen == (STRLEN)UNISKIP(f))
7085 #endif
7086                                   Perl_sv_catpvf(aTHX_ listsv,
7087                                                  "%04"UVxf"\n", f);
7088                               else {
7089                                   /* Any multicharacter foldings
7090                                    * require the following transform:
7091                                    * [ABCDEF] -> (?:[ABCabcDEFd]|pq|rst)
7092                                    * where E folds into "pq" and F folds
7093                                    * into "rst", all other characters
7094                                    * fold to single characters.  We save
7095                                    * away these multicharacter foldings,
7096                                    * to be later saved as part of the
7097                                    * additional "s" data. */
7098                                   SV *sv;
7099
7100                                   if (!unicode_alternate)
7101                                       unicode_alternate = newAV();
7102                                   sv = newSVpvn((char*)foldbuf, foldlen);
7103                                   SvUTF8_on(sv);
7104                                   av_push(unicode_alternate, sv);
7105                               }
7106                          }
7107
7108                          /* If folding and the value is one of the Greek
7109                           * sigmas insert a few more sigmas to make the
7110                           * folding rules of the sigmas to work right.
7111                           * Note that not all the possible combinations
7112                           * are handled here: some of them are handled
7113                           * by the standard folding rules, and some of
7114                           * them (literal or EXACTF cases) are handled
7115                           * during runtime in regexec.c:S_find_byclass(). */
7116                          if (value == UNICODE_GREEK_SMALL_LETTER_FINAL_SIGMA) {
7117                               Perl_sv_catpvf(aTHX_ listsv, "%04"UVxf"\n",
7118                                              (UV)UNICODE_GREEK_CAPITAL_LETTER_SIGMA);
7119                               Perl_sv_catpvf(aTHX_ listsv, "%04"UVxf"\n",
7120                                              (UV)UNICODE_GREEK_SMALL_LETTER_SIGMA);
7121                          }
7122                          else if (value == UNICODE_GREEK_CAPITAL_LETTER_SIGMA)
7123                               Perl_sv_catpvf(aTHX_ listsv, "%04"UVxf"\n",
7124                                              (UV)UNICODE_GREEK_SMALL_LETTER_SIGMA);
7125                     }
7126                 }
7127             }
7128 #ifdef EBCDIC
7129             literal_endpoint = 0;
7130 #endif
7131         }
7132
7133         range = 0; /* this range (if it was one) is done now */
7134     }
7135
7136     if (need_class) {
7137         ANYOF_FLAGS(ret) |= ANYOF_LARGE;
7138         if (SIZE_ONLY)
7139             RExC_size += ANYOF_CLASS_ADD_SKIP;
7140         else
7141             RExC_emit += ANYOF_CLASS_ADD_SKIP;
7142     }
7143
7144
7145     if (SIZE_ONLY)
7146         return ret;
7147     /****** !SIZE_ONLY AFTER HERE *********/
7148
7149     if( stored == 1 && value < 256
7150         && !( ANYOF_FLAGS(ret) & ( ANYOF_FLAGS_ALL ^ ANYOF_FOLD ) )
7151     ) {
7152         /* optimize single char class to an EXACT node
7153            but *only* when its not a UTF/high char  */
7154         const char * cur_parse= RExC_parse;
7155         RExC_emit = (regnode *)orig_emit;
7156         RExC_parse = (char *)orig_parse;
7157         ret = reg_node(pRExC_state,
7158                        (U8)((ANYOF_FLAGS(ret) & ANYOF_FOLD) ? EXACTF : EXACT));
7159         RExC_parse = (char *)cur_parse;
7160         *STRING(ret)= (char)value;
7161         STR_LEN(ret)= 1;
7162         RExC_emit += STR_SZ(1);
7163         return ret;
7164     }
7165     /* optimize case-insensitive simple patterns (e.g. /[a-z]/i) */
7166     if ( /* If the only flag is folding (plus possibly inversion). */
7167         ((ANYOF_FLAGS(ret) & (ANYOF_FLAGS_ALL ^ ANYOF_INVERT)) == ANYOF_FOLD)
7168        ) {
7169         for (value = 0; value < 256; ++value) {
7170             if (ANYOF_BITMAP_TEST(ret, value)) {
7171                 UV fold = PL_fold[value];
7172
7173                 if (fold != value)
7174                     ANYOF_BITMAP_SET(ret, fold);
7175             }
7176         }
7177         ANYOF_FLAGS(ret) &= ~ANYOF_FOLD;
7178     }
7179
7180     /* optimize inverted simple patterns (e.g. [^a-z]) */
7181     if (optimize_invert &&
7182         /* If the only flag is inversion. */
7183         (ANYOF_FLAGS(ret) & ANYOF_FLAGS_ALL) == ANYOF_INVERT) {
7184         for (value = 0; value < ANYOF_BITMAP_SIZE; ++value)
7185             ANYOF_BITMAP(ret)[value] ^= ANYOF_FLAGS_ALL;
7186         ANYOF_FLAGS(ret) = ANYOF_UNICODE_ALL;
7187     }
7188     {
7189         AV * const av = newAV();
7190         SV *rv;
7191         /* The 0th element stores the character class description
7192          * in its textual form: used later (regexec.c:Perl_regclass_swash())
7193          * to initialize the appropriate swash (which gets stored in
7194          * the 1st element), and also useful for dumping the regnode.
7195          * The 2nd element stores the multicharacter foldings,
7196          * used later (regexec.c:S_reginclass()). */
7197         av_store(av, 0, listsv);
7198         av_store(av, 1, NULL);
7199         av_store(av, 2, (SV*)unicode_alternate);
7200         rv = newRV_noinc((SV*)av);
7201         n = add_data(pRExC_state, 1, "s");
7202         RExC_rx->data->data[n] = (void*)rv;
7203         ARG_SET(ret, n);
7204     }
7205     return ret;
7206 }
7207
7208 STATIC char*
7209 S_nextchar(pTHX_ RExC_state_t *pRExC_state)
7210 {
7211     char* const retval = RExC_parse++;
7212
7213     for (;;) {
7214         if (*RExC_parse == '(' && RExC_parse[1] == '?' &&
7215                 RExC_parse[2] == '#') {
7216             while (*RExC_parse != ')') {
7217                 if (RExC_parse == RExC_end)
7218                     FAIL("Sequence (?#... not terminated");
7219                 RExC_parse++;
7220             }
7221             RExC_parse++;
7222             continue;
7223         }
7224         if (RExC_flags & PMf_EXTENDED) {
7225             if (isSPACE(*RExC_parse)) {
7226                 RExC_parse++;
7227                 continue;
7228             }
7229             else if (*RExC_parse == '#') {
7230                 while (RExC_parse < RExC_end)
7231                     if (*RExC_parse++ == '\n') break;
7232                 continue;
7233             }
7234         }
7235         return retval;
7236     }
7237 }
7238
7239 /*
7240 - reg_node - emit a node
7241 */
7242 STATIC regnode *                        /* Location. */
7243 S_reg_node(pTHX_ RExC_state_t *pRExC_state, U8 op)
7244 {
7245     dVAR;
7246     register regnode *ptr;
7247     regnode * const ret = RExC_emit;
7248     GET_RE_DEBUG_FLAGS_DECL;
7249
7250     if (SIZE_ONLY) {
7251         SIZE_ALIGN(RExC_size);
7252         RExC_size += 1;
7253         return(ret);
7254     }
7255     NODE_ALIGN_FILL(ret);
7256     ptr = ret;
7257     FILL_ADVANCE_NODE(ptr, op);
7258     if (RExC_offsets) {         /* MJD */
7259         MJD_OFFSET_DEBUG(("%s:%d: (op %s) %s %"UVuf" (len %"UVuf") (max %"UVuf").\n",
7260               "reg_node", __LINE__,
7261               reg_name[op],
7262               (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0]
7263                 ? "Overwriting end of array!\n" : "OK",
7264               (UV)(RExC_emit - RExC_emit_start),
7265               (UV)(RExC_parse - RExC_start),
7266               (UV)RExC_offsets[0]));
7267         Set_Node_Offset(RExC_emit, RExC_parse + (op == END));
7268     }
7269
7270     RExC_emit = ptr;
7271
7272     return(ret);
7273 }
7274
7275 /*
7276 - reganode - emit a node with an argument
7277 */
7278 STATIC regnode *                        /* Location. */
7279 S_reganode(pTHX_ RExC_state_t *pRExC_state, U8 op, U32 arg)
7280 {
7281     dVAR;
7282     register regnode *ptr;
7283     regnode * const ret = RExC_emit;
7284     GET_RE_DEBUG_FLAGS_DECL;
7285
7286     if (SIZE_ONLY) {
7287         SIZE_ALIGN(RExC_size);
7288         RExC_size += 2;
7289         /*
7290            We can't do this:
7291
7292            assert(2==regarglen[op]+1);
7293
7294            Anything larger than this has to allocate the extra amount.
7295            If we changed this to be:
7296
7297            RExC_size += (1 + regarglen[op]);
7298
7299            then it wouldn't matter. Its not clear what side effect
7300            might come from that so its not done so far.
7301            -- dmq
7302         */
7303         return(ret);
7304     }
7305
7306     NODE_ALIGN_FILL(ret);
7307     ptr = ret;
7308     FILL_ADVANCE_NODE_ARG(ptr, op, arg);
7309     if (RExC_offsets) {         /* MJD */
7310         MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s %"UVuf" <- %"UVuf" (max %"UVuf").\n",
7311               "reganode",
7312               __LINE__,
7313               reg_name[op],
7314               (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0] ?
7315               "Overwriting end of array!\n" : "OK",
7316               (UV)(RExC_emit - RExC_emit_start),
7317               (UV)(RExC_parse - RExC_start),
7318               (UV)RExC_offsets[0]));
7319         Set_Cur_Node_Offset;
7320     }
7321
7322     RExC_emit = ptr;
7323
7324     return(ret);
7325 }
7326
7327 /*
7328 - reguni - emit (if appropriate) a Unicode character
7329 */
7330 STATIC STRLEN
7331 S_reguni(pTHX_ const RExC_state_t *pRExC_state, UV uv, char* s)
7332 {
7333     dVAR;
7334     return SIZE_ONLY ? UNISKIP(uv) : (uvchr_to_utf8((U8*)s, uv) - (U8*)s);
7335 }
7336
7337 /*
7338 - reginsert - insert an operator in front of already-emitted operand
7339 *
7340 * Means relocating the operand.
7341 */
7342 STATIC void
7343 S_reginsert(pTHX_ RExC_state_t *pRExC_state, U8 op, regnode *opnd, U32 depth)
7344 {
7345     dVAR;
7346     register regnode *src;
7347     register regnode *dst;
7348     register regnode *place;
7349     const int offset = regarglen[(U8)op];
7350     const int size = NODE_STEP_REGNODE + offset;
7351     GET_RE_DEBUG_FLAGS_DECL;
7352 /* (PL_regkind[(U8)op] == CURLY ? EXTRA_STEP_2ARGS : 0); */
7353     DEBUG_PARSE_FMT("inst"," - %s",reg_name[op]);
7354     if (SIZE_ONLY) {
7355         RExC_size += size;
7356         return;
7357     }
7358
7359     src = RExC_emit;
7360     RExC_emit += size;
7361     dst = RExC_emit;
7362     if (RExC_parens) {
7363         int paren;
7364         for ( paren=0 ; paren < RExC_npar ; paren++ ) {
7365             if ( RExC_parens[paren] >= src )
7366                 RExC_parens[paren] += size;
7367         }
7368     }
7369
7370     while (src > opnd) {
7371         StructCopy(--src, --dst, regnode);
7372         if (RExC_offsets) {     /* MJD 20010112 */
7373             MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s copy %"UVuf" -> %"UVuf" (max %"UVuf").\n",
7374                   "reg_insert",
7375                   __LINE__,
7376                   reg_name[op],
7377                   (UV)(dst - RExC_emit_start) > RExC_offsets[0]
7378                     ? "Overwriting end of array!\n" : "OK",
7379                   (UV)(src - RExC_emit_start),
7380                   (UV)(dst - RExC_emit_start),
7381                   (UV)RExC_offsets[0]));
7382             Set_Node_Offset_To_R(dst-RExC_emit_start, Node_Offset(src));
7383             Set_Node_Length_To_R(dst-RExC_emit_start, Node_Length(src));
7384         }
7385     }
7386
7387
7388     place = opnd;               /* Op node, where operand used to be. */
7389     if (RExC_offsets) {         /* MJD */
7390         MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s %"UVuf" <- %"UVuf" (max %"UVuf").\n",
7391               "reginsert",
7392               __LINE__,
7393               reg_name[op],
7394               (UV)(place - RExC_emit_start) > RExC_offsets[0]
7395               ? "Overwriting end of array!\n" : "OK",
7396               (UV)(place - RExC_emit_start),
7397               (UV)(RExC_parse - RExC_start),
7398               (UV)RExC_offsets[0]));
7399         Set_Node_Offset(place, RExC_parse);
7400         Set_Node_Length(place, 1);
7401     }
7402     src = NEXTOPER(place);
7403     FILL_ADVANCE_NODE(place, op);
7404     Zero(src, offset, regnode);
7405 }
7406
7407 /*
7408 - regtail - set the next-pointer at the end of a node chain of p to val.
7409 - SEE ALSO: regtail_study
7410 */
7411 /* TODO: All three parms should be const */
7412 STATIC void
7413 S_regtail(pTHX_ RExC_state_t *pRExC_state, regnode *p, const regnode *val,U32 depth)
7414 {
7415     dVAR;
7416     register regnode *scan;
7417     GET_RE_DEBUG_FLAGS_DECL;
7418 #ifndef DEBUGGING
7419     PERL_UNUSED_ARG(depth);
7420 #endif
7421
7422     if (SIZE_ONLY)
7423         return;
7424
7425     /* Find last node. */
7426     scan = p;
7427     for (;;) {
7428         regnode * const temp = regnext(scan);
7429         DEBUG_PARSE_r({
7430             SV * const mysv=sv_newmortal();
7431             DEBUG_PARSE_MSG((scan==p ? "tail" : ""));
7432             regprop(RExC_rx, mysv, scan);
7433             PerlIO_printf(Perl_debug_log, "~ %s (%d) %s %s\n",
7434                 SvPV_nolen_const(mysv), REG_NODE_NUM(scan),
7435                     (temp == NULL ? "->" : ""),
7436                     (temp == NULL ? reg_name[OP(val)] : "")
7437             );
7438         });
7439         if (temp == NULL)
7440             break;
7441         scan = temp;
7442     }
7443
7444     if (reg_off_by_arg[OP(scan)]) {
7445         ARG_SET(scan, val - scan);
7446     }
7447     else {
7448         NEXT_OFF(scan) = val - scan;
7449     }
7450 }
7451
7452 #ifdef DEBUGGING
7453 /*
7454 - regtail_study - set the next-pointer at the end of a node chain of p to val.
7455 - Look for optimizable sequences at the same time.
7456 - currently only looks for EXACT chains.
7457
7458 This is expermental code. The idea is to use this routine to perform
7459 in place optimizations on branches and groups as they are constructed,
7460 with the long term intention of removing optimization from study_chunk so
7461 that it is purely analytical.
7462
7463 Currently only used when in DEBUG mode. The macro REGTAIL_STUDY() is used
7464 to control which is which.
7465
7466 */
7467 /* TODO: All four parms should be const */
7468
7469 STATIC U8
7470 S_regtail_study(pTHX_ RExC_state_t *pRExC_state, regnode *p, const regnode *val,U32 depth)
7471 {
7472     dVAR;
7473     register regnode *scan;
7474     U8 exact = PSEUDO;
7475 #ifdef EXPERIMENTAL_INPLACESCAN
7476     I32 min = 0;
7477 #endif
7478
7479     GET_RE_DEBUG_FLAGS_DECL;
7480
7481
7482     if (SIZE_ONLY)
7483         return exact;
7484
7485     /* Find last node. */
7486
7487     scan = p;
7488     for (;;) {
7489         regnode * const temp = regnext(scan);
7490 #ifdef EXPERIMENTAL_INPLACESCAN
7491         if (PL_regkind[OP(scan)] == EXACT)
7492             if (join_exact(pRExC_state,scan,&min,1,val,depth+1))
7493                 return EXACT;
7494 #endif
7495         if ( exact ) {
7496             switch (OP(scan)) {
7497                 case EXACT:
7498                 case EXACTF:
7499                 case EXACTFL:
7500                         if( exact == PSEUDO )
7501                             exact= OP(scan);
7502                         else if ( exact != OP(scan) )
7503                             exact= 0;
7504                 case NOTHING:
7505                     break;
7506                 default:
7507                     exact= 0;
7508             }
7509         }
7510         DEBUG_PARSE_r({
7511             SV * const mysv=sv_newmortal();
7512             DEBUG_PARSE_MSG((scan==p ? "tsdy" : ""));
7513             regprop(RExC_rx, mysv, scan);
7514             PerlIO_printf(Perl_debug_log, "~ %s (%d) -> %s\n",
7515                 SvPV_nolen_const(mysv),
7516                 REG_NODE_NUM(scan),
7517                 reg_name[exact]);
7518         });
7519         if (temp == NULL)
7520             break;
7521         scan = temp;
7522     }
7523     DEBUG_PARSE_r({
7524         SV * const mysv_val=sv_newmortal();
7525         DEBUG_PARSE_MSG("");
7526         regprop(RExC_rx, mysv_val, val);
7527         PerlIO_printf(Perl_debug_log, "~ attach to %s (%d) offset to %d\n",
7528             SvPV_nolen_const(mysv_val),
7529             REG_NODE_NUM(val),
7530             val - scan
7531         );
7532     });
7533     if (reg_off_by_arg[OP(scan)]) {
7534         ARG_SET(scan, val - scan);
7535     }
7536     else {
7537         NEXT_OFF(scan) = val - scan;
7538     }
7539
7540     return exact;
7541 }
7542 #endif
7543
7544 /*
7545  - regcurly - a little FSA that accepts {\d+,?\d*}
7546  */
7547 STATIC I32
7548 S_regcurly(register const char *s)
7549 {
7550     if (*s++ != '{')
7551         return FALSE;
7552     if (!isDIGIT(*s))
7553         return FALSE;
7554     while (isDIGIT(*s))
7555         s++;
7556     if (*s == ',')
7557         s++;
7558     while (isDIGIT(*s))
7559         s++;
7560     if (*s != '}')
7561         return FALSE;
7562     return TRUE;
7563 }
7564
7565
7566 /*
7567  - regdump - dump a regexp onto Perl_debug_log in vaguely comprehensible form
7568  */
7569 void
7570 Perl_regdump(pTHX_ const regexp *r)
7571 {
7572 #ifdef DEBUGGING
7573     dVAR;
7574     SV * const sv = sv_newmortal();
7575     SV *dsv= sv_newmortal();
7576
7577     (void)dumpuntil(r, r->program, r->program + 1, NULL, NULL, sv, 0, 0);
7578
7579     /* Header fields of interest. */
7580     if (r->anchored_substr) {
7581         RE_PV_QUOTED_DECL(s, 0, dsv, SvPVX_const(r->anchored_substr),
7582             RE_SV_DUMPLEN(r->anchored_substr), 30);
7583         PerlIO_printf(Perl_debug_log,
7584                       "anchored %s%s at %"IVdf" ",
7585                       s, RE_SV_TAIL(r->anchored_substr),
7586                       (IV)r->anchored_offset);
7587     } else if (r->anchored_utf8) {
7588         RE_PV_QUOTED_DECL(s, 1, dsv, SvPVX_const(r->anchored_utf8),
7589             RE_SV_DUMPLEN(r->anchored_utf8), 30);
7590         PerlIO_printf(Perl_debug_log,
7591                       "anchored utf8 %s%s at %"IVdf" ",
7592                       s, RE_SV_TAIL(r->anchored_utf8),
7593                       (IV)r->anchored_offset);
7594     }
7595     if (r->float_substr) {
7596         RE_PV_QUOTED_DECL(s, 0, dsv, SvPVX_const(r->float_substr),
7597             RE_SV_DUMPLEN(r->float_substr), 30);
7598         PerlIO_printf(Perl_debug_log,
7599                       "floating %s%s at %"IVdf"..%"UVuf" ",
7600                       s, RE_SV_TAIL(r->float_substr),
7601                       (IV)r->float_min_offset, (UV)r->float_max_offset);
7602     } else if (r->float_utf8) {
7603         RE_PV_QUOTED_DECL(s, 1, dsv, SvPVX_const(r->float_utf8),
7604             RE_SV_DUMPLEN(r->float_utf8), 30);
7605         PerlIO_printf(Perl_debug_log,
7606                       "floating utf8 %s%s at %"IVdf"..%"UVuf" ",
7607                       s, RE_SV_TAIL(r->float_utf8),
7608                       (IV)r->float_min_offset, (UV)r->float_max_offset);
7609     }
7610     if (r->check_substr || r->check_utf8)
7611         PerlIO_printf(Perl_debug_log,
7612                       (const char *)
7613                       (r->check_substr == r->float_substr
7614                        && r->check_utf8 == r->float_utf8
7615                        ? "(checking floating" : "(checking anchored"));
7616     if (r->reganch & ROPT_NOSCAN)
7617         PerlIO_printf(Perl_debug_log, " noscan");
7618     if (r->reganch & ROPT_CHECK_ALL)
7619         PerlIO_printf(Perl_debug_log, " isall");
7620     if (r->check_substr || r->check_utf8)
7621         PerlIO_printf(Perl_debug_log, ") ");
7622
7623     if (r->regstclass) {
7624         regprop(r, sv, r->regstclass);
7625         PerlIO_printf(Perl_debug_log, "stclass %s ", SvPVX_const(sv));
7626     }
7627     if (r->reganch & ROPT_ANCH) {
7628         PerlIO_printf(Perl_debug_log, "anchored");
7629         if (r->reganch & ROPT_ANCH_BOL)
7630             PerlIO_printf(Perl_debug_log, "(BOL)");
7631         if (r->reganch & ROPT_ANCH_MBOL)
7632             PerlIO_printf(Perl_debug_log, "(MBOL)");
7633         if (r->reganch & ROPT_ANCH_SBOL)
7634             PerlIO_printf(Perl_debug_log, "(SBOL)");
7635         if (r->reganch & ROPT_ANCH_GPOS)
7636             PerlIO_printf(Perl_debug_log, "(GPOS)");
7637         PerlIO_putc(Perl_debug_log, ' ');
7638     }
7639     if (r->reganch & ROPT_GPOS_SEEN)
7640         PerlIO_printf(Perl_debug_log, "GPOS ");
7641     if (r->reganch & ROPT_SKIP)
7642         PerlIO_printf(Perl_debug_log, "plus ");
7643     if (r->reganch & ROPT_IMPLICIT)
7644         PerlIO_printf(Perl_debug_log, "implicit ");
7645     PerlIO_printf(Perl_debug_log, "minlen %ld ", (long) r->minlen);
7646     if (r->reganch & ROPT_EVAL_SEEN)
7647         PerlIO_printf(Perl_debug_log, "with eval ");
7648     PerlIO_printf(Perl_debug_log, "\n");
7649 #else
7650     PERL_UNUSED_CONTEXT;
7651     PERL_UNUSED_ARG(r);
7652 #endif  /* DEBUGGING */
7653 }
7654
7655 /*
7656 - regprop - printable representation of opcode
7657 */
7658 void
7659 Perl_regprop(pTHX_ const regexp *prog, SV *sv, const regnode *o)
7660 {
7661 #ifdef DEBUGGING
7662     dVAR;
7663     register int k;
7664     GET_RE_DEBUG_FLAGS_DECL;
7665
7666     sv_setpvn(sv, "", 0);
7667     if (OP(o) > REGNODE_MAX)            /* regnode.type is unsigned */
7668         /* It would be nice to FAIL() here, but this may be called from
7669            regexec.c, and it would be hard to supply pRExC_state. */
7670         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d", (int)OP(o), (int)REGNODE_MAX);
7671     sv_catpv(sv, reg_name[OP(o)]); /* Take off const! */
7672
7673     k = PL_regkind[OP(o)];
7674
7675     if (k == EXACT) {
7676         SV * const dsv = sv_2mortal(newSVpvs(""));
7677         /* Using is_utf8_string() (via PERL_PV_UNI_DETECT)
7678          * is a crude hack but it may be the best for now since
7679          * we have no flag "this EXACTish node was UTF-8"
7680          * --jhi */
7681         const char * const s =
7682             pv_pretty(dsv, STRING(o), STR_LEN(o), 60,
7683                 PL_colors[0], PL_colors[1],
7684                 PERL_PV_ESCAPE_UNI_DETECT |
7685                 PERL_PV_PRETTY_ELIPSES    |
7686                 PERL_PV_PRETTY_LTGT
7687             );
7688         Perl_sv_catpvf(aTHX_ sv, " %s", s );
7689     } else if (k == TRIE) {
7690         /* print the details of the trie in dumpuntil instead, as
7691          * prog->data isn't available here */
7692         const char op = OP(o);
7693         const I32 n = ARG(o);
7694         const reg_ac_data * const ac = IS_TRIE_AC(op) ?
7695                (reg_ac_data *)prog->data->data[n] :
7696                NULL;
7697         const reg_trie_data * const trie = !IS_TRIE_AC(op) ?
7698             (reg_trie_data*)prog->data->data[n] :
7699             ac->trie;
7700
7701         Perl_sv_catpvf(aTHX_ sv, "-%s",reg_name[o->flags]);
7702         DEBUG_TRIE_COMPILE_r(
7703             Perl_sv_catpvf(aTHX_ sv,
7704                 "<S:%"UVuf"/%"IVdf" W:%"UVuf" L:%"UVuf"/%"UVuf" C:%"UVuf"/%"UVuf">",
7705                 (UV)trie->startstate,
7706                 (IV)trie->laststate-1,
7707                 (UV)trie->wordcount,
7708                 (UV)trie->minlen,
7709                 (UV)trie->maxlen,
7710                 (UV)TRIE_CHARCOUNT(trie),
7711                 (UV)trie->uniquecharcount
7712             )
7713         );
7714         if ( IS_ANYOF_TRIE(op) || trie->bitmap ) {
7715             int i;
7716             int rangestart = -1;
7717             U8* bitmap = IS_ANYOF_TRIE(op) ? (U8*)ANYOF_BITMAP(o) : (U8*)TRIE_BITMAP(trie);
7718             Perl_sv_catpvf(aTHX_ sv, "[");
7719             for (i = 0; i <= 256; i++) {
7720                 if (i < 256 && BITMAP_TEST(bitmap,i)) {
7721                     if (rangestart == -1)
7722                         rangestart = i;
7723                 } else if (rangestart != -1) {
7724                     if (i <= rangestart + 3)
7725                         for (; rangestart < i; rangestart++)
7726                             put_byte(sv, rangestart);
7727                     else {
7728                         put_byte(sv, rangestart);
7729                         sv_catpvs(sv, "-");
7730                         put_byte(sv, i - 1);
7731                     }
7732                     rangestart = -1;
7733                 }
7734             }
7735             Perl_sv_catpvf(aTHX_ sv, "]");
7736         }
7737
7738     } else if (k == CURLY) {
7739         if (OP(o) == CURLYM || OP(o) == CURLYN || OP(o) == CURLYX)
7740             Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags); /* Parenth number */
7741         Perl_sv_catpvf(aTHX_ sv, " {%d,%d}", ARG1(o), ARG2(o));
7742     }
7743     else if (k == WHILEM && o->flags)                   /* Ordinal/of */
7744         Perl_sv_catpvf(aTHX_ sv, "[%d/%d]", o->flags & 0xf, o->flags>>4);
7745     else if (k == REF || k == OPEN || k == CLOSE || k == GROUPP)
7746         Perl_sv_catpvf(aTHX_ sv, "%d", (int)ARG(o));    /* Parenth number */
7747     else if (k == RECURSE)
7748         Perl_sv_catpvf(aTHX_ sv, "%d[%+d]", (int)ARG(o),(int)ARG2L(o)); /* Paren and offset */
7749     else if (k == LOGICAL)
7750         Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags);     /* 2: embedded, otherwise 1 */
7751     else if (k == ANYOF) {
7752         int i, rangestart = -1;
7753         const U8 flags = ANYOF_FLAGS(o);
7754
7755         /* Should be synchronized with * ANYOF_ #xdefines in regcomp.h */
7756         static const char * const anyofs[] = {
7757             "\\w",
7758             "\\W",
7759             "\\s",
7760             "\\S",
7761             "\\d",
7762             "\\D",
7763             "[:alnum:]",
7764             "[:^alnum:]",
7765             "[:alpha:]",
7766             "[:^alpha:]",
7767             "[:ascii:]",
7768             "[:^ascii:]",
7769             "[:ctrl:]",
7770             "[:^ctrl:]",
7771             "[:graph:]",
7772             "[:^graph:]",
7773             "[:lower:]",
7774             "[:^lower:]",
7775             "[:print:]",
7776             "[:^print:]",
7777             "[:punct:]",
7778             "[:^punct:]",
7779             "[:upper:]",
7780             "[:^upper:]",
7781             "[:xdigit:]",
7782             "[:^xdigit:]",
7783             "[:space:]",
7784             "[:^space:]",
7785             "[:blank:]",
7786             "[:^blank:]"
7787         };
7788
7789         if (flags & ANYOF_LOCALE)
7790             sv_catpvs(sv, "{loc}");
7791         if (flags & ANYOF_FOLD)
7792             sv_catpvs(sv, "{i}");
7793         Perl_sv_catpvf(aTHX_ sv, "[%s", PL_colors[0]);
7794         if (flags & ANYOF_INVERT)
7795             sv_catpvs(sv, "^");
7796         for (i = 0; i <= 256; i++) {
7797             if (i < 256 && ANYOF_BITMAP_TEST(o,i)) {
7798                 if (rangestart == -1)
7799                     rangestart = i;
7800             } else if (rangestart != -1) {
7801                 if (i <= rangestart + 3)
7802                     for (; rangestart < i; rangestart++)
7803                         put_byte(sv, rangestart);
7804                 else {
7805                     put_byte(sv, rangestart);
7806                     sv_catpvs(sv, "-");
7807                     put_byte(sv, i - 1);
7808                 }
7809                 rangestart = -1;
7810             }
7811         }
7812
7813         if (o->flags & ANYOF_CLASS)
7814             for (i = 0; i < (int)(sizeof(anyofs)/sizeof(char*)); i++)
7815                 if (ANYOF_CLASS_TEST(o,i))
7816                     sv_catpv(sv, anyofs[i]);
7817
7818         if (flags & ANYOF_UNICODE)
7819             sv_catpvs(sv, "{unicode}");
7820         else if (flags & ANYOF_UNICODE_ALL)
7821             sv_catpvs(sv, "{unicode_all}");
7822
7823         {
7824             SV *lv;
7825             SV * const sw = regclass_swash(prog, o, FALSE, &lv, 0);
7826
7827             if (lv) {
7828                 if (sw) {
7829                     U8 s[UTF8_MAXBYTES_CASE+1];
7830
7831                     for (i = 0; i <= 256; i++) { /* just the first 256 */
7832                         uvchr_to_utf8(s, i);
7833
7834                         if (i < 256 && swash_fetch(sw, s, TRUE)) {
7835                             if (rangestart == -1)
7836                                 rangestart = i;
7837                         } else if (rangestart != -1) {
7838                             if (i <= rangestart + 3)
7839                                 for (; rangestart < i; rangestart++) {
7840                                     const U8 * const e = uvchr_to_utf8(s,rangestart);
7841                                     U8 *p;
7842                                     for(p = s; p < e; p++)
7843                                         put_byte(sv, *p);
7844                                 }
7845                             else {
7846                                 const U8 *e = uvchr_to_utf8(s,rangestart);
7847                                 U8 *p;
7848                                 for (p = s; p < e; p++)
7849                                     put_byte(sv, *p);
7850                                 sv_catpvs(sv, "-");
7851                                 e = uvchr_to_utf8(s, i-1);
7852                                 for (p = s; p < e; p++)
7853                                     put_byte(sv, *p);
7854                                 }
7855                                 rangestart = -1;
7856                             }
7857                         }
7858
7859                     sv_catpvs(sv, "..."); /* et cetera */
7860                 }
7861
7862                 {
7863                     char *s = savesvpv(lv);
7864                     char * const origs = s;
7865
7866                     while (*s && *s != '\n')
7867                         s++;
7868
7869                     if (*s == '\n') {
7870                         const char * const t = ++s;
7871
7872                         while (*s) {
7873                             if (*s == '\n')
7874                                 *s = ' ';
7875                             s++;
7876                         }
7877                         if (s[-1] == ' ')
7878                             s[-1] = 0;
7879
7880                         sv_catpv(sv, t);
7881                     }
7882
7883                     Safefree(origs);
7884                 }
7885             }
7886         }
7887
7888         Perl_sv_catpvf(aTHX_ sv, "%s]", PL_colors[1]);
7889     }
7890     else if (k == BRANCHJ && (OP(o) == UNLESSM || OP(o) == IFMATCH))
7891         Perl_sv_catpvf(aTHX_ sv, "[%d]", -(o->flags));
7892 #else
7893     PERL_UNUSED_CONTEXT;
7894     PERL_UNUSED_ARG(sv);
7895     PERL_UNUSED_ARG(o);
7896     PERL_UNUSED_ARG(prog);
7897 #endif  /* DEBUGGING */
7898 }
7899
7900 SV *
7901 Perl_re_intuit_string(pTHX_ regexp *prog)
7902 {                               /* Assume that RE_INTUIT is set */
7903     dVAR;
7904     GET_RE_DEBUG_FLAGS_DECL;
7905     PERL_UNUSED_CONTEXT;
7906
7907     DEBUG_COMPILE_r(
7908         {
7909             const char * const s = SvPV_nolen_const(prog->check_substr
7910                       ? prog->check_substr : prog->check_utf8);
7911
7912             if (!PL_colorset) reginitcolors();
7913             PerlIO_printf(Perl_debug_log,
7914                       "%sUsing REx %ssubstr:%s \"%s%.60s%s%s\"\n",
7915                       PL_colors[4],
7916                       prog->check_substr ? "" : "utf8 ",
7917                       PL_colors[5],PL_colors[0],
7918                       s,
7919                       PL_colors[1],
7920                       (strlen(s) > 60 ? "..." : ""));
7921         } );
7922
7923     return prog->check_substr ? prog->check_substr : prog->check_utf8;
7924 }
7925
7926 /*
7927    pregfree - free a regexp
7928
7929    See regdupe below if you change anything here.
7930 */
7931
7932 void
7933 Perl_pregfree(pTHX_ struct regexp *r)
7934 {
7935     dVAR;
7936
7937     GET_RE_DEBUG_FLAGS_DECL;
7938
7939     if (!r || (--r->refcnt > 0))
7940         return;
7941     DEBUG_COMPILE_r({
7942         if (!PL_colorset)
7943             reginitcolors();
7944         if (RX_DEBUG(r)){
7945             SV *dsv= sv_newmortal();
7946             RE_PV_QUOTED_DECL(s, (r->reganch & ROPT_UTF8),
7947                 dsv, r->precomp, r->prelen, 60);
7948             PerlIO_printf(Perl_debug_log,"%sFreeing REx:%s %s\n",
7949                 PL_colors[4],PL_colors[5],s);
7950         }
7951     });
7952
7953     /* gcov results gave these as non-null 100% of the time, so there's no
7954        optimisation in checking them before calling Safefree  */
7955     Safefree(r->precomp);
7956     Safefree(r->offsets);             /* 20010421 MJD */
7957     RX_MATCH_COPY_FREE(r);
7958 #ifdef PERL_OLD_COPY_ON_WRITE
7959     if (r->saved_copy)
7960         SvREFCNT_dec(r->saved_copy);
7961 #endif
7962     if (r->substrs) {
7963         if (r->anchored_substr)
7964             SvREFCNT_dec(r->anchored_substr);
7965         if (r->anchored_utf8)
7966             SvREFCNT_dec(r->anchored_utf8);
7967         if (r->float_substr)
7968             SvREFCNT_dec(r->float_substr);
7969         if (r->float_utf8)
7970             SvREFCNT_dec(r->float_utf8);
7971         Safefree(r->substrs);
7972     }
7973     if (r->paren_names)
7974             SvREFCNT_dec(r->paren_names);
7975     if (r->data) {
7976         int n = r->data->count;
7977         PAD* new_comppad = NULL;
7978         PAD* old_comppad;
7979         PADOFFSET refcnt;
7980
7981         while (--n >= 0) {
7982           /* If you add a ->what type here, update the comment in regcomp.h */
7983             switch (r->data->what[n]) {
7984             case 's':
7985             case 'S':
7986                 SvREFCNT_dec((SV*)r->data->data[n]);
7987                 break;
7988             case 'f':
7989                 Safefree(r->data->data[n]);
7990                 break;
7991             case 'p':
7992                 new_comppad = (AV*)r->data->data[n];
7993                 break;
7994             case 'o':
7995                 if (new_comppad == NULL)
7996                     Perl_croak(aTHX_ "panic: pregfree comppad");
7997                 PAD_SAVE_LOCAL(old_comppad,
7998                     /* Watch out for global destruction's random ordering. */
7999                     (SvTYPE(new_comppad) == SVt_PVAV) ? new_comppad : NULL
8000                 );
8001                 OP_REFCNT_LOCK;
8002                 refcnt = OpREFCNT_dec((OP_4tree*)r->data->data[n]);
8003                 OP_REFCNT_UNLOCK;
8004                 if (!refcnt)
8005                     op_free((OP_4tree*)r->data->data[n]);
8006
8007                 PAD_RESTORE_LOCAL(old_comppad);
8008                 SvREFCNT_dec((SV*)new_comppad);
8009                 new_comppad = NULL;
8010                 break;
8011             case 'n':
8012                 break;
8013             case 'T':
8014                 { /* Aho Corasick add-on structure for a trie node.
8015                      Used in stclass optimization only */
8016                     U32 refcount;
8017                     reg_ac_data *aho=(reg_ac_data*)r->data->data[n];
8018                     OP_REFCNT_LOCK;
8019                     refcount = --aho->refcount;
8020                     OP_REFCNT_UNLOCK;
8021                     if ( !refcount ) {
8022                         Safefree(aho->states);
8023                         Safefree(aho->fail);
8024                         aho->trie=NULL; /* not necessary to free this as it is
8025                                            handled by the 't' case */
8026                         Safefree(r->data->data[n]); /* do this last!!!! */
8027                         Safefree(r->regstclass);
8028                     }
8029                 }
8030                 break;
8031             case 't':
8032                 {
8033                     /* trie structure. */
8034                     U32 refcount;
8035                     reg_trie_data *trie=(reg_trie_data*)r->data->data[n];
8036                     OP_REFCNT_LOCK;
8037                     refcount = --trie->refcount;
8038                     OP_REFCNT_UNLOCK;
8039                     if ( !refcount ) {
8040                         Safefree(trie->charmap);
8041                         if (trie->widecharmap)
8042                             SvREFCNT_dec((SV*)trie->widecharmap);
8043                         Safefree(trie->states);
8044                         Safefree(trie->trans);
8045                         if (trie->bitmap)
8046                             Safefree(trie->bitmap);
8047                         if (trie->wordlen)
8048                             Safefree(trie->wordlen);
8049                         if (trie->jump)
8050                             Safefree(trie->jump);
8051                         if (trie->nextword)
8052                             Safefree(trie->nextword);
8053 #ifdef DEBUGGING
8054                         if (RX_DEBUG(r)) {
8055                             if (trie->words)
8056                                 SvREFCNT_dec((SV*)trie->words);
8057                             if (trie->revcharmap)
8058                                 SvREFCNT_dec((SV*)trie->revcharmap);
8059                         }
8060 #endif
8061                         Safefree(r->data->data[n]); /* do this last!!!! */
8062                     }
8063                 }
8064                 break;
8065             default:
8066                 Perl_croak(aTHX_ "panic: regfree data code '%c'", r->data->what[n]);
8067             }
8068         }
8069         Safefree(r->data->what);
8070         Safefree(r->data);
8071     }
8072     Safefree(r->startp);
8073     Safefree(r->endp);
8074     Safefree(r);
8075 }
8076
8077 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8078 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8079 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8080 #define SAVEPVN(p,n)    ((p) ? savepvn(p,n) : NULL)
8081
8082 /*
8083    regdupe - duplicate a regexp.
8084
8085    This routine is called by sv.c's re_dup and is expected to clone a
8086    given regexp structure. It is a no-op when not under USE_ITHREADS.
8087    (Originally this *was* re_dup() for change history see sv.c)
8088
8089    See pregfree() above if you change anything here.
8090 */
8091 #if defined(USE_ITHREADS)
8092 regexp *
8093 Perl_regdupe(pTHX_ const regexp *r, CLONE_PARAMS *param)
8094 {
8095     dVAR;
8096     REGEXP *ret;
8097     int i, len, npar;
8098     struct reg_substr_datum *s;
8099
8100     if (!r)
8101         return (REGEXP *)NULL;
8102
8103     if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
8104         return ret;
8105
8106     len = r->offsets[0];
8107     npar = r->nparens+1;
8108
8109     Newxc(ret, sizeof(regexp) + (len+1)*sizeof(regnode), char, regexp);
8110     Copy(r->program, ret->program, len+1, regnode);
8111
8112     Newx(ret->startp, npar, I32);
8113     Copy(r->startp, ret->startp, npar, I32);
8114     Newx(ret->endp, npar, I32);
8115     Copy(r->startp, ret->startp, npar, I32);
8116
8117     Newx(ret->substrs, 1, struct reg_substr_data);
8118     for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
8119         s->min_offset = r->substrs->data[i].min_offset;
8120         s->max_offset = r->substrs->data[i].max_offset;
8121         s->end_shift  = r->substrs->data[i].end_shift;
8122         s->substr     = sv_dup_inc(r->substrs->data[i].substr, param);
8123         s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
8124     }
8125
8126     ret->regstclass = NULL;
8127     if (r->data) {
8128         struct reg_data *d;
8129         const int count = r->data->count;
8130         int i;
8131
8132         Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
8133                 char, struct reg_data);
8134         Newx(d->what, count, U8);
8135
8136         d->count = count;
8137         for (i = 0; i < count; i++) {
8138             d->what[i] = r->data->what[i];
8139             switch (d->what[i]) {
8140                 /* legal options are one of: sfpont
8141                    see also regcomp.h and pregfree() */
8142             case 's':
8143             case 'S':
8144                 d->data[i] = sv_dup_inc((SV *)r->data->data[i], param);
8145                 break;
8146             case 'p':
8147                 d->data[i] = av_dup_inc((AV *)r->data->data[i], param);
8148                 break;
8149             case 'f':
8150                 /* This is cheating. */
8151                 Newx(d->data[i], 1, struct regnode_charclass_class);
8152                 StructCopy(r->data->data[i], d->data[i],
8153                             struct regnode_charclass_class);
8154                 ret->regstclass = (regnode*)d->data[i];
8155                 break;
8156             case 'o':
8157                 /* Compiled op trees are readonly, and can thus be
8158                    shared without duplication. */
8159                 OP_REFCNT_LOCK;
8160                 d->data[i] = (void*)OpREFCNT_inc((OP*)r->data->data[i]);
8161                 OP_REFCNT_UNLOCK;
8162                 break;
8163             case 'n':
8164                 d->data[i] = r->data->data[i];
8165                 break;
8166             case 't':
8167                 d->data[i] = r->data->data[i];
8168                 OP_REFCNT_LOCK;
8169                 ((reg_trie_data*)d->data[i])->refcount++;
8170                 OP_REFCNT_UNLOCK;
8171                 break;
8172             case 'T':
8173                 d->data[i] = r->data->data[i];
8174                 OP_REFCNT_LOCK;
8175                 ((reg_ac_data*)d->data[i])->refcount++;
8176                 OP_REFCNT_UNLOCK;
8177                 /* Trie stclasses are readonly and can thus be shared
8178                  * without duplication. We free the stclass in pregfree
8179                  * when the corresponding reg_ac_data struct is freed.
8180                  */
8181                 ret->regstclass= r->regstclass;
8182                 break;
8183             default:
8184                 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", r->data->what[i]);
8185             }
8186         }
8187
8188         ret->data = d;
8189     }
8190     else
8191         ret->data = NULL;
8192
8193     Newx(ret->offsets, 2*len+1, U32);
8194     Copy(r->offsets, ret->offsets, 2*len+1, U32);
8195
8196     ret->precomp        = SAVEPVN(r->precomp, r->prelen);
8197     ret->refcnt         = r->refcnt;
8198     ret->minlen         = r->minlen;
8199     ret->prelen         = r->prelen;
8200     ret->nparens        = r->nparens;
8201     ret->lastparen      = r->lastparen;
8202     ret->lastcloseparen = r->lastcloseparen;
8203     ret->reganch        = r->reganch;
8204
8205     ret->sublen         = r->sublen;
8206
8207     ret->engine         = r->engine;
8208
8209     ret->paren_names    = hv_dup_inc(r->paren_names, param);
8210
8211     if (RX_MATCH_COPIED(ret))
8212         ret->subbeg  = SAVEPVN(r->subbeg, r->sublen);
8213     else
8214         ret->subbeg = NULL;
8215 #ifdef PERL_OLD_COPY_ON_WRITE
8216     ret->saved_copy = NULL;
8217 #endif
8218
8219     ptr_table_store(PL_ptr_table, r, ret);
8220     return ret;
8221 }
8222 #endif
8223
8224 #ifndef PERL_IN_XSUB_RE
8225 /*
8226  - regnext - dig the "next" pointer out of a node
8227  */
8228 regnode *
8229 Perl_regnext(pTHX_ register regnode *p)
8230 {
8231     dVAR;
8232     register I32 offset;
8233
8234     if (p == &PL_regdummy)
8235         return(NULL);
8236
8237     offset = (reg_off_by_arg[OP(p)] ? ARG(p) : NEXT_OFF(p));
8238     if (offset == 0)
8239         return(NULL);
8240
8241     return(p+offset);
8242 }
8243 #endif
8244
8245 STATIC void
8246 S_re_croak2(pTHX_ const char* pat1,const char* pat2,...)
8247 {
8248     va_list args;
8249     STRLEN l1 = strlen(pat1);
8250     STRLEN l2 = strlen(pat2);
8251     char buf[512];
8252     SV *msv;
8253     const char *message;
8254
8255     if (l1 > 510)
8256         l1 = 510;
8257     if (l1 + l2 > 510)
8258         l2 = 510 - l1;
8259     Copy(pat1, buf, l1 , char);
8260     Copy(pat2, buf + l1, l2 , char);
8261     buf[l1 + l2] = '\n';
8262     buf[l1 + l2 + 1] = '\0';
8263 #ifdef I_STDARG
8264     /* ANSI variant takes additional second argument */
8265     va_start(args, pat2);
8266 #else
8267     va_start(args);
8268 #endif
8269     msv = vmess(buf, &args);
8270     va_end(args);
8271     message = SvPV_const(msv,l1);
8272     if (l1 > 512)
8273         l1 = 512;
8274     Copy(message, buf, l1 , char);
8275     buf[l1-1] = '\0';                   /* Overwrite \n */
8276     Perl_croak(aTHX_ "%s", buf);
8277 }
8278
8279 /* XXX Here's a total kludge.  But we need to re-enter for swash routines. */
8280
8281 #ifndef PERL_IN_XSUB_RE
8282 void
8283 Perl_save_re_context(pTHX)
8284 {
8285     dVAR;
8286
8287     struct re_save_state *state;
8288
8289     SAVEVPTR(PL_curcop);
8290     SSGROW(SAVESTACK_ALLOC_FOR_RE_SAVE_STATE + 1);
8291
8292     state = (struct re_save_state *)(PL_savestack + PL_savestack_ix);
8293     PL_savestack_ix += SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
8294     SSPUSHINT(SAVEt_RE_STATE);
8295
8296     Copy(&PL_reg_state, state, 1, struct re_save_state);
8297
8298     PL_reg_start_tmp = 0;
8299     PL_reg_start_tmpl = 0;
8300     PL_reg_oldsaved = NULL;
8301     PL_reg_oldsavedlen = 0;
8302     PL_reg_maxiter = 0;
8303     PL_reg_leftiter = 0;
8304     PL_reg_poscache = NULL;
8305     PL_reg_poscache_size = 0;
8306 #ifdef PERL_OLD_COPY_ON_WRITE
8307     PL_nrs = NULL;
8308 #endif
8309
8310     /* Save $1..$n (#18107: UTF-8 s/(\w+)/uc($1)/e); AMS 20021106. */
8311     if (PL_curpm) {
8312         const REGEXP * const rx = PM_GETRE(PL_curpm);
8313         if (rx) {
8314             U32 i;
8315             for (i = 1; i <= rx->nparens; i++) {
8316                 char digits[TYPE_CHARS(long)];
8317                 const STRLEN len = my_snprintf(digits, sizeof(digits), "%lu", (long)i);
8318                 GV *const *const gvp
8319                     = (GV**)hv_fetch(PL_defstash, digits, len, 0);
8320
8321                 if (gvp) {
8322                     GV * const gv = *gvp;
8323                     if (SvTYPE(gv) == SVt_PVGV && GvSV(gv))
8324                         save_scalar(gv);
8325                 }
8326             }
8327         }
8328     }
8329 }
8330 #endif
8331
8332 static void
8333 clear_re(pTHX_ void *r)
8334 {
8335     dVAR;
8336     ReREFCNT_dec((regexp *)r);
8337 }
8338
8339 #ifdef DEBUGGING
8340
8341 STATIC void
8342 S_put_byte(pTHX_ SV *sv, int c)
8343 {
8344     if (isCNTRL(c) || c == 255 || !isPRINT(c))
8345         Perl_sv_catpvf(aTHX_ sv, "\\%o", c);
8346     else if (c == '-' || c == ']' || c == '\\' || c == '^')
8347         Perl_sv_catpvf(aTHX_ sv, "\\%c", c);
8348     else
8349         Perl_sv_catpvf(aTHX_ sv, "%c", c);
8350 }
8351
8352
8353 #define CLEAR_OPTSTART \
8354     if (optstart) STMT_START { \
8355             DEBUG_OPTIMISE_r(PerlIO_printf(Perl_debug_log, " (%d nodes)\n", node - optstart)); \
8356             optstart=NULL; \
8357     } STMT_END
8358
8359 #define DUMPUNTIL(b,e) CLEAR_OPTSTART; node=dumpuntil(r,start,(b),(e),last,sv,indent+1,depth+1);
8360
8361 STATIC const regnode *
8362 S_dumpuntil(pTHX_ const regexp *r, const regnode *start, const regnode *node,
8363             const regnode *last, const regnode *plast,
8364             SV* sv, I32 indent, U32 depth)
8365 {
8366     dVAR;
8367     register U8 op = PSEUDO;    /* Arbitrary non-END op. */
8368     register const regnode *next;
8369     const regnode *optstart= NULL;
8370     GET_RE_DEBUG_FLAGS_DECL;
8371
8372 #ifdef DEBUG_DUMPUNTIL
8373     PerlIO_printf(Perl_debug_log, "--- %d : %d - %d - %d\n",indent,node-start,
8374         last ? last-start : 0,plast ? plast-start : 0);
8375 #endif
8376
8377     if (plast && plast < last)
8378         last= plast;
8379
8380     while (PL_regkind[op] != END && (!last || node < last)) {
8381         /* While that wasn't END last time... */
8382
8383         NODE_ALIGN(node);
8384         op = OP(node);
8385         if (op == CLOSE)
8386             indent--;
8387         next = regnext((regnode *)node);
8388
8389         /* Where, what. */
8390         if (OP(node) == OPTIMIZED) {
8391             if (!optstart && RE_DEBUG_FLAG(RE_DEBUG_COMPILE_OPTIMISE))
8392                 optstart = node;
8393             else
8394                 goto after_print;
8395         } else
8396             CLEAR_OPTSTART;
8397
8398         regprop(r, sv, node);
8399         PerlIO_printf(Perl_debug_log, "%4"IVdf":%*s%s", (IV)(node - start),
8400                       (int)(2*indent + 1), "", SvPVX_const(sv));
8401
8402         if (OP(node) != OPTIMIZED) {
8403             if (next == NULL)           /* Next ptr. */
8404                 PerlIO_printf(Perl_debug_log, "(0)");
8405             else if (PL_regkind[(U8)op] == BRANCH && PL_regkind[OP(next)] != BRANCH )
8406                 PerlIO_printf(Perl_debug_log, "(FAIL)");
8407             else
8408                 PerlIO_printf(Perl_debug_log, "(%"IVdf")", (IV)(next - start));
8409
8410             /*if (PL_regkind[(U8)op]  != TRIE)*/
8411                 (void)PerlIO_putc(Perl_debug_log, '\n');
8412         }
8413
8414       after_print:
8415         if (PL_regkind[(U8)op] == BRANCHJ) {
8416             assert(next);
8417             {
8418                 register const regnode *nnode = (OP(next) == LONGJMP
8419                                              ? regnext((regnode *)next)
8420                                              : next);
8421                 if (last && nnode > last)
8422                     nnode = last;
8423                 DUMPUNTIL(NEXTOPER(NEXTOPER(node)), nnode);
8424             }
8425         }
8426         else if (PL_regkind[(U8)op] == BRANCH) {
8427             assert(next);
8428             DUMPUNTIL(NEXTOPER(node), next);
8429         }
8430         else if ( PL_regkind[(U8)op]  == TRIE ) {
8431             const char op = OP(node);
8432             const I32 n = ARG(node);
8433             const reg_ac_data * const ac = op>=AHOCORASICK ?
8434                (reg_ac_data *)r->data->data[n] :
8435                NULL;
8436             const reg_trie_data * const trie = op<AHOCORASICK ?
8437                 (reg_trie_data*)r->data->data[n] :
8438                 ac->trie;
8439             const regnode *nextbranch= NULL;
8440             I32 word_idx;
8441             sv_setpvn(sv, "", 0);
8442             for (word_idx= 0; word_idx < (I32)trie->wordcount; word_idx++) {
8443                 SV ** const elem_ptr = av_fetch(trie->words,word_idx,0);
8444
8445                 PerlIO_printf(Perl_debug_log, "%*s%s ",
8446                    (int)(2*(indent+3)), "",
8447                     elem_ptr ? pv_pretty(sv, SvPV_nolen_const(*elem_ptr), SvCUR(*elem_ptr), 60,
8448                             PL_colors[0], PL_colors[1],
8449                             (SvUTF8(*elem_ptr) ? PERL_PV_ESCAPE_UNI : 0) |
8450                             PERL_PV_PRETTY_ELIPSES    |
8451                             PERL_PV_PRETTY_LTGT
8452                             )
8453                             : "???"
8454                 );
8455                 if (trie->jump) {
8456                     U16 dist= trie->jump[word_idx+1];
8457                     PerlIO_printf(Perl_debug_log, "(%u)\n",(next - dist) - start);
8458                     if (dist) {
8459                         if (!nextbranch)
8460                             nextbranch= next - trie->jump[0];
8461                         DUMPUNTIL(next - dist, nextbranch);
8462                     }
8463                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
8464                         nextbranch= regnext((regnode *)nextbranch);
8465                 } else {
8466                     PerlIO_printf(Perl_debug_log, "\n");
8467                 }
8468             }
8469             if (last && next > last)
8470                 node= last;
8471             else
8472                 node= next;
8473         }
8474         else if ( op == CURLY ) {   /* "next" might be very big: optimizer */
8475             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS,
8476                     NEXTOPER(node) + EXTRA_STEP_2ARGS + 1);
8477         }
8478         else if (PL_regkind[(U8)op] == CURLY && op != CURLYX) {
8479             assert(next);
8480             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS, next);
8481         }
8482         else if ( op == PLUS || op == STAR) {
8483             DUMPUNTIL(NEXTOPER(node), NEXTOPER(node) + 1);
8484         }
8485         else if (op == ANYOF) {
8486             /* arglen 1 + class block */
8487             node += 1 + ((ANYOF_FLAGS(node) & ANYOF_LARGE)
8488                     ? ANYOF_CLASS_SKIP : ANYOF_SKIP);
8489             node = NEXTOPER(node);
8490         }
8491         else if (PL_regkind[(U8)op] == EXACT) {
8492             /* Literal string, where present. */
8493             node += NODE_SZ_STR(node) - 1;
8494             node = NEXTOPER(node);
8495         }
8496         else {
8497             node = NEXTOPER(node);
8498             node += regarglen[(U8)op];
8499         }
8500         if (op == CURLYX || op == OPEN)
8501             indent++;
8502         else if (op == WHILEM)
8503             indent--;
8504     }
8505     CLEAR_OPTSTART;
8506 #ifdef DEBUG_DUMPUNTIL
8507     PerlIO_printf(Perl_debug_log, "--- %d\n",indent);
8508 #endif
8509     return node;
8510 }
8511
8512 #endif  /* DEBUGGING */
8513
8514 /*
8515  * Local variables:
8516  * c-indentation-style: bsd
8517  * c-basic-offset: 4
8518  * indent-tabs-mode: t
8519  * End:
8520  *
8521  * ex: set ts=8 sts=4 sw=4 noet:
8522  */