]> git.vpit.fr Git - perl/modules/re-engine-Hooks.git/blob - src/5017010/regcomp.c
Add support for perl 5.14.4, 5.16.3, 5.17.{9,10}, 5.18.0 and 5.19.0
[perl/modules/re-engine-Hooks.git] / src / 5017010 / regcomp.c
1 /*    regcomp.c
2  */
3
4 /*
5  * 'A fair jaw-cracker dwarf-language must be.'            --Samwise Gamgee
6  *
7  *     [p.285 of _The Lord of the Rings_, II/iii: "The Ring Goes South"]
8  */
9
10 /* This file contains functions for compiling a regular expression.  See
11  * also regexec.c which funnily enough, contains functions for executing
12  * a regular expression.
13  *
14  * This file is also copied at build time to ext/re/re_comp.c, where
15  * it's built with -DPERL_EXT_RE_BUILD -DPERL_EXT_RE_DEBUG -DPERL_EXT.
16  * This causes the main functions to be compiled under new names and with
17  * debugging support added, which makes "use re 'debug'" work.
18  */
19
20 /* NOTE: this is derived from Henry Spencer's regexp code, and should not
21  * confused with the original package (see point 3 below).  Thanks, Henry!
22  */
23
24 /* Additional note: this code is very heavily munged from Henry's version
25  * in places.  In some spots I've traded clarity for efficiency, so don't
26  * blame Henry for some of the lack of readability.
27  */
28
29 /* The names of the functions have been changed from regcomp and
30  * regexec to pregcomp and pregexec in order to avoid conflicts
31  * with the POSIX routines of the same names.
32 */
33
34 #ifdef PERL_EXT_RE_BUILD
35 #include "re_top.h"
36 #endif
37
38 /*
39  * pregcomp and pregexec -- regsub and regerror are not used in perl
40  *
41  *      Copyright (c) 1986 by University of Toronto.
42  *      Written by Henry Spencer.  Not derived from licensed software.
43  *
44  *      Permission is granted to anyone to use this software for any
45  *      purpose on any computer system, and to redistribute it freely,
46  *      subject to the following restrictions:
47  *
48  *      1. The author is not responsible for the consequences of use of
49  *              this software, no matter how awful, even if they arise
50  *              from defects in it.
51  *
52  *      2. The origin of this software must not be misrepresented, either
53  *              by explicit claim or by omission.
54  *
55  *      3. Altered versions must be plainly marked as such, and must not
56  *              be misrepresented as being the original software.
57  *
58  *
59  ****    Alterations to Henry's code are...
60  ****
61  ****    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
62  ****    2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
63  ****    by Larry Wall and others
64  ****
65  ****    You may distribute under the terms of either the GNU General Public
66  ****    License or the Artistic License, as specified in the README file.
67
68  *
69  * Beware that some of this code is subtly aware of the way operator
70  * precedence is structured in regular expressions.  Serious changes in
71  * regular-expression syntax might require a total rethink.
72  */
73 #include "EXTERN.h"
74 #define PERL_IN_REGCOMP_C
75 #include "perl.h"
76
77 #ifndef PERL_IN_XSUB_RE
78 #include "re_defs.h"
79 #endif
80
81 #define REG_COMP_C
82 #ifdef PERL_IN_XSUB_RE
83 #  include "re_comp.h"
84 extern const struct regexp_engine my_reg_engine;
85 #else
86 #  include "regcomp.h"
87 #endif
88
89 #include "dquote_static.c"
90 #include "charclass_invlists.h"
91 #include "inline_invlist.c"
92 #include "unicode_constants.h"
93
94 #define HAS_NONLATIN1_FOLD_CLOSURE(i) _HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(i)
95 #define IS_NON_FINAL_FOLD(c) _IS_NON_FINAL_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c)
96 #define IS_IN_SOME_FOLD_L1(c) _IS_IN_SOME_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c)
97
98 #ifdef op
99 #undef op
100 #endif /* op */
101
102 #ifdef MSDOS
103 #  if defined(BUGGY_MSC6)
104  /* MSC 6.00A breaks on op/regexp.t test 85 unless we turn this off */
105 #    pragma optimize("a",off)
106  /* But MSC 6.00A is happy with 'w', for aliases only across function calls*/
107 #    pragma optimize("w",on )
108 #  endif /* BUGGY_MSC6 */
109 #endif /* MSDOS */
110
111 #ifndef STATIC
112 #define STATIC  static
113 #endif
114
115
116 typedef struct RExC_state_t {
117     U32         flags;                  /* RXf_* are we folding, multilining? */
118     U32         pm_flags;               /* PMf_* stuff from the calling PMOP */
119     char        *precomp;               /* uncompiled string. */
120     REGEXP      *rx_sv;                 /* The SV that is the regexp. */
121     regexp      *rx;                    /* perl core regexp structure */
122     regexp_internal     *rxi;           /* internal data for regexp object pprivate field */        
123     char        *start;                 /* Start of input for compile */
124     char        *end;                   /* End of input for compile */
125     char        *parse;                 /* Input-scan pointer. */
126     I32         whilem_seen;            /* number of WHILEM in this expr */
127     regnode     *emit_start;            /* Start of emitted-code area */
128     regnode     *emit_bound;            /* First regnode outside of the allocated space */
129     regnode     *emit;                  /* Code-emit pointer; &regdummy = don't = compiling */
130     I32         naughty;                /* How bad is this pattern? */
131     I32         sawback;                /* Did we see \1, ...? */
132     U32         seen;
133     I32         size;                   /* Code size. */
134     I32         npar;                   /* Capture buffer count, (OPEN). */
135     I32         cpar;                   /* Capture buffer count, (CLOSE). */
136     I32         nestroot;               /* root parens we are in - used by accept */
137     I32         extralen;
138     I32         seen_zerolen;
139     regnode     **open_parens;          /* pointers to open parens */
140     regnode     **close_parens;         /* pointers to close parens */
141     regnode     *opend;                 /* END node in program */
142     I32         utf8;           /* whether the pattern is utf8 or not */
143     I32         orig_utf8;      /* whether the pattern was originally in utf8 */
144                                 /* XXX use this for future optimisation of case
145                                  * where pattern must be upgraded to utf8. */
146     I32         uni_semantics;  /* If a d charset modifier should use unicode
147                                    rules, even if the pattern is not in
148                                    utf8 */
149     HV          *paren_names;           /* Paren names */
150     
151     regnode     **recurse;              /* Recurse regops */
152     I32         recurse_count;          /* Number of recurse regops */
153     I32         in_lookbehind;
154     I32         contains_locale;
155     I32         override_recoding;
156     I32         in_multi_char_class;
157     struct reg_code_block *code_blocks; /* positions of literal (?{})
158                                             within pattern */
159     int         num_code_blocks;        /* size of code_blocks[] */
160     int         code_index;             /* next code_blocks[] slot */
161 #if ADD_TO_REGEXEC
162     char        *starttry;              /* -Dr: where regtry was called. */
163 #define RExC_starttry   (pRExC_state->starttry)
164 #endif
165     SV          *runtime_code_qr;       /* qr with the runtime code blocks */
166 #ifdef DEBUGGING
167     const char  *lastparse;
168     I32         lastnum;
169     AV          *paren_name_list;       /* idx -> name */
170 #define RExC_lastparse  (pRExC_state->lastparse)
171 #define RExC_lastnum    (pRExC_state->lastnum)
172 #define RExC_paren_name_list    (pRExC_state->paren_name_list)
173 #endif
174 } RExC_state_t;
175
176 #define RExC_flags      (pRExC_state->flags)
177 #define RExC_pm_flags   (pRExC_state->pm_flags)
178 #define RExC_precomp    (pRExC_state->precomp)
179 #define RExC_rx_sv      (pRExC_state->rx_sv)
180 #define RExC_rx         (pRExC_state->rx)
181 #define RExC_rxi        (pRExC_state->rxi)
182 #define RExC_start      (pRExC_state->start)
183 #define RExC_end        (pRExC_state->end)
184 #define RExC_parse      (pRExC_state->parse)
185 #define RExC_whilem_seen        (pRExC_state->whilem_seen)
186 #ifdef RE_TRACK_PATTERN_OFFSETS
187 #define RExC_offsets    (pRExC_state->rxi->u.offsets) /* I am not like the others */
188 #endif
189 #define RExC_emit       (pRExC_state->emit)
190 #define RExC_emit_start (pRExC_state->emit_start)
191 #define RExC_emit_bound (pRExC_state->emit_bound)
192 #define RExC_naughty    (pRExC_state->naughty)
193 #define RExC_sawback    (pRExC_state->sawback)
194 #define RExC_seen       (pRExC_state->seen)
195 #define RExC_size       (pRExC_state->size)
196 #define RExC_npar       (pRExC_state->npar)
197 #define RExC_nestroot   (pRExC_state->nestroot)
198 #define RExC_extralen   (pRExC_state->extralen)
199 #define RExC_seen_zerolen       (pRExC_state->seen_zerolen)
200 #define RExC_utf8       (pRExC_state->utf8)
201 #define RExC_uni_semantics      (pRExC_state->uni_semantics)
202 #define RExC_orig_utf8  (pRExC_state->orig_utf8)
203 #define RExC_open_parens        (pRExC_state->open_parens)
204 #define RExC_close_parens       (pRExC_state->close_parens)
205 #define RExC_opend      (pRExC_state->opend)
206 #define RExC_paren_names        (pRExC_state->paren_names)
207 #define RExC_recurse    (pRExC_state->recurse)
208 #define RExC_recurse_count      (pRExC_state->recurse_count)
209 #define RExC_in_lookbehind      (pRExC_state->in_lookbehind)
210 #define RExC_contains_locale    (pRExC_state->contains_locale)
211 #define RExC_override_recoding (pRExC_state->override_recoding)
212 #define RExC_in_multi_char_class (pRExC_state->in_multi_char_class)
213
214
215 #define ISMULT1(c)      ((c) == '*' || (c) == '+' || (c) == '?')
216 #define ISMULT2(s)      ((*s) == '*' || (*s) == '+' || (*s) == '?' || \
217         ((*s) == '{' && regcurly(s, FALSE)))
218
219 #ifdef SPSTART
220 #undef SPSTART          /* dratted cpp namespace... */
221 #endif
222 /*
223  * Flags to be passed up and down.
224  */
225 #define WORST           0       /* Worst case. */
226 #define HASWIDTH        0x01    /* Known to match non-null strings. */
227
228 /* Simple enough to be STAR/PLUS operand; in an EXACTish node must be a single
229  * character.  (There needs to be a case: in the switch statement in regexec.c
230  * for any node marked SIMPLE.)  Note that this is not the same thing as
231  * REGNODE_SIMPLE */
232 #define SIMPLE          0x02
233 #define SPSTART         0x04    /* Starts with * or + */
234 #define POSTPONED       0x08    /* (?1),(?&name), (??{...}) or similar */
235 #define TRYAGAIN        0x10    /* Weeded out a declaration. */
236 #define RESTART_UTF8    0x20    /* Restart, need to calcuate sizes as UTF-8 */
237
238 #define REG_NODE_NUM(x) ((x) ? (int)((x)-RExC_emit_start) : -1)
239
240 /* whether trie related optimizations are enabled */
241 #if PERL_ENABLE_EXTENDED_TRIE_OPTIMISATION
242 #define TRIE_STUDY_OPT
243 #define FULL_TRIE_STUDY
244 #define TRIE_STCLASS
245 #endif
246
247
248
249 #define PBYTE(u8str,paren) ((U8*)(u8str))[(paren) >> 3]
250 #define PBITVAL(paren) (1 << ((paren) & 7))
251 #define PAREN_TEST(u8str,paren) ( PBYTE(u8str,paren) & PBITVAL(paren))
252 #define PAREN_SET(u8str,paren) PBYTE(u8str,paren) |= PBITVAL(paren)
253 #define PAREN_UNSET(u8str,paren) PBYTE(u8str,paren) &= (~PBITVAL(paren))
254
255 #define REQUIRE_UTF8    STMT_START {                                       \
256                                      if (!UTF) {                           \
257                                          *flagp = RESTART_UTF8;            \
258                                          return NULL;                      \
259                                      }                                     \
260                         } STMT_END
261
262 /* This converts the named class defined in regcomp.h to its equivalent class
263  * number defined in handy.h. */
264 #define namedclass_to_classnum(class)  ((int) ((class) / 2))
265 #define classnum_to_namedclass(classnum)  ((classnum) * 2)
266
267 /* About scan_data_t.
268
269   During optimisation we recurse through the regexp program performing
270   various inplace (keyhole style) optimisations. In addition study_chunk
271   and scan_commit populate this data structure with information about
272   what strings MUST appear in the pattern. We look for the longest 
273   string that must appear at a fixed location, and we look for the
274   longest string that may appear at a floating location. So for instance
275   in the pattern:
276   
277     /FOO[xX]A.*B[xX]BAR/
278     
279   Both 'FOO' and 'A' are fixed strings. Both 'B' and 'BAR' are floating
280   strings (because they follow a .* construct). study_chunk will identify
281   both FOO and BAR as being the longest fixed and floating strings respectively.
282   
283   The strings can be composites, for instance
284   
285      /(f)(o)(o)/
286      
287   will result in a composite fixed substring 'foo'.
288   
289   For each string some basic information is maintained:
290   
291   - offset or min_offset
292     This is the position the string must appear at, or not before.
293     It also implicitly (when combined with minlenp) tells us how many
294     characters must match before the string we are searching for.
295     Likewise when combined with minlenp and the length of the string it
296     tells us how many characters must appear after the string we have 
297     found.
298   
299   - max_offset
300     Only used for floating strings. This is the rightmost point that
301     the string can appear at. If set to I32 max it indicates that the
302     string can occur infinitely far to the right.
303   
304   - minlenp
305     A pointer to the minimum number of characters of the pattern that the
306     string was found inside. This is important as in the case of positive
307     lookahead or positive lookbehind we can have multiple patterns 
308     involved. Consider
309     
310     /(?=FOO).*F/
311     
312     The minimum length of the pattern overall is 3, the minimum length
313     of the lookahead part is 3, but the minimum length of the part that
314     will actually match is 1. So 'FOO's minimum length is 3, but the 
315     minimum length for the F is 1. This is important as the minimum length
316     is used to determine offsets in front of and behind the string being 
317     looked for.  Since strings can be composites this is the length of the
318     pattern at the time it was committed with a scan_commit. Note that
319     the length is calculated by study_chunk, so that the minimum lengths
320     are not known until the full pattern has been compiled, thus the 
321     pointer to the value.
322   
323   - lookbehind
324   
325     In the case of lookbehind the string being searched for can be
326     offset past the start point of the final matching string. 
327     If this value was just blithely removed from the min_offset it would
328     invalidate some of the calculations for how many chars must match
329     before or after (as they are derived from min_offset and minlen and
330     the length of the string being searched for). 
331     When the final pattern is compiled and the data is moved from the
332     scan_data_t structure into the regexp structure the information
333     about lookbehind is factored in, with the information that would 
334     have been lost precalculated in the end_shift field for the 
335     associated string.
336
337   The fields pos_min and pos_delta are used to store the minimum offset
338   and the delta to the maximum offset at the current point in the pattern.    
339
340 */
341
342 typedef struct scan_data_t {
343     /*I32 len_min;      unused */
344     /*I32 len_delta;    unused */
345     I32 pos_min;
346     I32 pos_delta;
347     SV *last_found;
348     I32 last_end;           /* min value, <0 unless valid. */
349     I32 last_start_min;
350     I32 last_start_max;
351     SV **longest;           /* Either &l_fixed, or &l_float. */
352     SV *longest_fixed;      /* longest fixed string found in pattern */
353     I32 offset_fixed;       /* offset where it starts */
354     I32 *minlen_fixed;      /* pointer to the minlen relevant to the string */
355     I32 lookbehind_fixed;   /* is the position of the string modfied by LB */
356     SV *longest_float;      /* longest floating string found in pattern */
357     I32 offset_float_min;   /* earliest point in string it can appear */
358     I32 offset_float_max;   /* latest point in string it can appear */
359     I32 *minlen_float;      /* pointer to the minlen relevant to the string */
360     I32 lookbehind_float;   /* is the position of the string modified by LB */
361     I32 flags;
362     I32 whilem_c;
363     I32 *last_closep;
364     struct regnode_charclass_class *start_class;
365 } scan_data_t;
366
367 /*
368  * Forward declarations for pregcomp()'s friends.
369  */
370
371 static const scan_data_t zero_scan_data =
372   { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ,0};
373
374 #define SF_BEFORE_EOL           (SF_BEFORE_SEOL|SF_BEFORE_MEOL)
375 #define SF_BEFORE_SEOL          0x0001
376 #define SF_BEFORE_MEOL          0x0002
377 #define SF_FIX_BEFORE_EOL       (SF_FIX_BEFORE_SEOL|SF_FIX_BEFORE_MEOL)
378 #define SF_FL_BEFORE_EOL        (SF_FL_BEFORE_SEOL|SF_FL_BEFORE_MEOL)
379
380 #ifdef NO_UNARY_PLUS
381 #  define SF_FIX_SHIFT_EOL      (0+2)
382 #  define SF_FL_SHIFT_EOL               (0+4)
383 #else
384 #  define SF_FIX_SHIFT_EOL      (+2)
385 #  define SF_FL_SHIFT_EOL               (+4)
386 #endif
387
388 #define SF_FIX_BEFORE_SEOL      (SF_BEFORE_SEOL << SF_FIX_SHIFT_EOL)
389 #define SF_FIX_BEFORE_MEOL      (SF_BEFORE_MEOL << SF_FIX_SHIFT_EOL)
390
391 #define SF_FL_BEFORE_SEOL       (SF_BEFORE_SEOL << SF_FL_SHIFT_EOL)
392 #define SF_FL_BEFORE_MEOL       (SF_BEFORE_MEOL << SF_FL_SHIFT_EOL) /* 0x20 */
393 #define SF_IS_INF               0x0040
394 #define SF_HAS_PAR              0x0080
395 #define SF_IN_PAR               0x0100
396 #define SF_HAS_EVAL             0x0200
397 #define SCF_DO_SUBSTR           0x0400
398 #define SCF_DO_STCLASS_AND      0x0800
399 #define SCF_DO_STCLASS_OR       0x1000
400 #define SCF_DO_STCLASS          (SCF_DO_STCLASS_AND|SCF_DO_STCLASS_OR)
401 #define SCF_WHILEM_VISITED_POS  0x2000
402
403 #define SCF_TRIE_RESTUDY        0x4000 /* Do restudy? */
404 #define SCF_SEEN_ACCEPT         0x8000 
405
406 #define UTF cBOOL(RExC_utf8)
407
408 /* The enums for all these are ordered so things work out correctly */
409 #define LOC (get_regex_charset(RExC_flags) == REGEX_LOCALE_CHARSET)
410 #define DEPENDS_SEMANTICS (get_regex_charset(RExC_flags) == REGEX_DEPENDS_CHARSET)
411 #define UNI_SEMANTICS (get_regex_charset(RExC_flags) == REGEX_UNICODE_CHARSET)
412 #define AT_LEAST_UNI_SEMANTICS (get_regex_charset(RExC_flags) >= REGEX_UNICODE_CHARSET)
413 #define ASCII_RESTRICTED (get_regex_charset(RExC_flags) == REGEX_ASCII_RESTRICTED_CHARSET)
414 #define AT_LEAST_ASCII_RESTRICTED (get_regex_charset(RExC_flags) >= REGEX_ASCII_RESTRICTED_CHARSET)
415 #define ASCII_FOLD_RESTRICTED (get_regex_charset(RExC_flags) == REGEX_ASCII_MORE_RESTRICTED_CHARSET)
416
417 #define FOLD cBOOL(RExC_flags & RXf_PMf_FOLD)
418
419 #define OOB_NAMEDCLASS          -1
420
421 /* There is no code point that is out-of-bounds, so this is problematic.  But
422  * its only current use is to initialize a variable that is always set before
423  * looked at. */
424 #define OOB_UNICODE             0xDEADBEEF
425
426 #define CHR_SVLEN(sv) (UTF ? sv_len_utf8(sv) : SvCUR(sv))
427 #define CHR_DIST(a,b) (UTF ? utf8_distance(a,b) : a - b)
428
429
430 /* length of regex to show in messages that don't mark a position within */
431 #define RegexLengthToShowInErrorMessages 127
432
433 /*
434  * If MARKER[12] are adjusted, be sure to adjust the constants at the top
435  * of t/op/regmesg.t, the tests in t/op/re_tests, and those in
436  * op/pragma/warn/regcomp.
437  */
438 #define MARKER1 "<-- HERE"    /* marker as it appears in the description */
439 #define MARKER2 " <-- HERE "  /* marker as it appears within the regex */
440
441 #define REPORT_LOCATION " in regex; marked by " MARKER1 " in m/%.*s" MARKER2 "%s/"
442
443 /*
444  * Calls SAVEDESTRUCTOR_X if needed, then calls Perl_croak with the given
445  * arg. Show regex, up to a maximum length. If it's too long, chop and add
446  * "...".
447  */
448 #define _FAIL(code) STMT_START {                                        \
449     const char *ellipses = "";                                          \
450     IV len = RExC_end - RExC_precomp;                                   \
451                                                                         \
452     if (!SIZE_ONLY)                                                     \
453         SAVEFREESV(RExC_rx_sv);                                         \
454     if (len > RegexLengthToShowInErrorMessages) {                       \
455         /* chop 10 shorter than the max, to ensure meaning of "..." */  \
456         len = RegexLengthToShowInErrorMessages - 10;                    \
457         ellipses = "...";                                               \
458     }                                                                   \
459     code;                                                               \
460 } STMT_END
461
462 #define FAIL(msg) _FAIL(                            \
463     Perl_croak(aTHX_ "%s in regex m/%.*s%s/",       \
464             msg, (int)len, RExC_precomp, ellipses))
465
466 #define FAIL2(msg,arg) _FAIL(                       \
467     Perl_croak(aTHX_ msg " in regex m/%.*s%s/",     \
468             arg, (int)len, RExC_precomp, ellipses))
469
470 /*
471  * Simple_vFAIL -- like FAIL, but marks the current location in the scan
472  */
473 #define Simple_vFAIL(m) STMT_START {                                    \
474     const IV offset = RExC_parse - RExC_precomp;                        \
475     Perl_croak(aTHX_ "%s" REPORT_LOCATION,                              \
476             m, (int)offset, RExC_precomp, RExC_precomp + offset);       \
477 } STMT_END
478
479 /*
480  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL()
481  */
482 #define vFAIL(m) STMT_START {                           \
483     if (!SIZE_ONLY)                                     \
484         SAVEFREESV(RExC_rx_sv);                         \
485     Simple_vFAIL(m);                                    \
486 } STMT_END
487
488 /*
489  * Like Simple_vFAIL(), but accepts two arguments.
490  */
491 #define Simple_vFAIL2(m,a1) STMT_START {                        \
492     const IV offset = RExC_parse - RExC_precomp;                        \
493     S_re_croak2(aTHX_ m, REPORT_LOCATION, a1,                   \
494             (int)offset, RExC_precomp, RExC_precomp + offset);  \
495 } STMT_END
496
497 /*
498  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL2().
499  */
500 #define vFAIL2(m,a1) STMT_START {                       \
501     if (!SIZE_ONLY)                                     \
502         SAVEFREESV(RExC_rx_sv);                         \
503     Simple_vFAIL2(m, a1);                               \
504 } STMT_END
505
506
507 /*
508  * Like Simple_vFAIL(), but accepts three arguments.
509  */
510 #define Simple_vFAIL3(m, a1, a2) STMT_START {                   \
511     const IV offset = RExC_parse - RExC_precomp;                \
512     S_re_croak2(aTHX_ m, REPORT_LOCATION, a1, a2,               \
513             (int)offset, RExC_precomp, RExC_precomp + offset);  \
514 } STMT_END
515
516 /*
517  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL3().
518  */
519 #define vFAIL3(m,a1,a2) STMT_START {                    \
520     if (!SIZE_ONLY)                                     \
521         SAVEFREESV(RExC_rx_sv);                         \
522     Simple_vFAIL3(m, a1, a2);                           \
523 } STMT_END
524
525 /*
526  * Like Simple_vFAIL(), but accepts four arguments.
527  */
528 #define Simple_vFAIL4(m, a1, a2, a3) STMT_START {               \
529     const IV offset = RExC_parse - RExC_precomp;                \
530     S_re_croak2(aTHX_ m, REPORT_LOCATION, a1, a2, a3,           \
531             (int)offset, RExC_precomp, RExC_precomp + offset);  \
532 } STMT_END
533
534 #define vFAIL4(m,a1,a2,a3) STMT_START {                 \
535     if (!SIZE_ONLY)                                     \
536         SAVEFREESV(RExC_rx_sv);                         \
537     Simple_vFAIL4(m, a1, a2, a3);                       \
538 } STMT_END
539
540 /* m is not necessarily a "literal string", in this macro */
541 #define reg_warn_non_literal_string(loc, m) STMT_START {                \
542     const IV offset = loc - RExC_precomp;                               \
543     Perl_warner(aTHX_ packWARN(WARN_REGEXP), "%s" REPORT_LOCATION,      \
544             m, (int)offset, RExC_precomp, RExC_precomp + offset);       \
545 } STMT_END
546
547 #define ckWARNreg(loc,m) STMT_START {                                   \
548     const IV offset = loc - RExC_precomp;                               \
549     Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,      \
550             (int)offset, RExC_precomp, RExC_precomp + offset);          \
551 } STMT_END
552
553 #define vWARN_dep(loc, m) STMT_START {                                  \
554     const IV offset = loc - RExC_precomp;                               \
555     Perl_warner(aTHX_ packWARN(WARN_DEPRECATED), m REPORT_LOCATION,     \
556             (int)offset, RExC_precomp, RExC_precomp + offset);          \
557 } STMT_END
558
559 #define ckWARNdep(loc,m) STMT_START {                                   \
560     const IV offset = loc - RExC_precomp;                               \
561     Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED),                   \
562             m REPORT_LOCATION,                                          \
563             (int)offset, RExC_precomp, RExC_precomp + offset);          \
564 } STMT_END
565
566 #define ckWARNregdep(loc,m) STMT_START {                                \
567     const IV offset = loc - RExC_precomp;                               \
568     Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_REGEXP),     \
569             m REPORT_LOCATION,                                          \
570             (int)offset, RExC_precomp, RExC_precomp + offset);          \
571 } STMT_END
572
573 #define ckWARN2regdep(loc,m, a1) STMT_START {                           \
574     const IV offset = loc - RExC_precomp;                               \
575     Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_REGEXP),     \
576             m REPORT_LOCATION,                                          \
577             a1, (int)offset, RExC_precomp, RExC_precomp + offset);      \
578 } STMT_END
579
580 #define ckWARN2reg(loc, m, a1) STMT_START {                             \
581     const IV offset = loc - RExC_precomp;                               \
582     Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,      \
583             a1, (int)offset, RExC_precomp, RExC_precomp + offset);      \
584 } STMT_END
585
586 #define vWARN3(loc, m, a1, a2) STMT_START {                             \
587     const IV offset = loc - RExC_precomp;                               \
588     Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,         \
589             a1, a2, (int)offset, RExC_precomp, RExC_precomp + offset);  \
590 } STMT_END
591
592 #define ckWARN3reg(loc, m, a1, a2) STMT_START {                         \
593     const IV offset = loc - RExC_precomp;                               \
594     Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,      \
595             a1, a2, (int)offset, RExC_precomp, RExC_precomp + offset);  \
596 } STMT_END
597
598 #define vWARN4(loc, m, a1, a2, a3) STMT_START {                         \
599     const IV offset = loc - RExC_precomp;                               \
600     Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,         \
601             a1, a2, a3, (int)offset, RExC_precomp, RExC_precomp + offset); \
602 } STMT_END
603
604 #define ckWARN4reg(loc, m, a1, a2, a3) STMT_START {                     \
605     const IV offset = loc - RExC_precomp;                               \
606     Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,      \
607             a1, a2, a3, (int)offset, RExC_precomp, RExC_precomp + offset); \
608 } STMT_END
609
610 #define vWARN5(loc, m, a1, a2, a3, a4) STMT_START {                     \
611     const IV offset = loc - RExC_precomp;                               \
612     Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,         \
613             a1, a2, a3, a4, (int)offset, RExC_precomp, RExC_precomp + offset); \
614 } STMT_END
615
616
617 /* Allow for side effects in s */
618 #define REGC(c,s) STMT_START {                  \
619     if (!SIZE_ONLY) *(s) = (c); else (void)(s); \
620 } STMT_END
621
622 /* Macros for recording node offsets.   20001227 mjd@plover.com 
623  * Nodes are numbered 1, 2, 3, 4.  Node #n's position is recorded in
624  * element 2*n-1 of the array.  Element #2n holds the byte length node #n.
625  * Element 0 holds the number n.
626  * Position is 1 indexed.
627  */
628 #ifndef RE_TRACK_PATTERN_OFFSETS
629 #define Set_Node_Offset_To_R(node,byte)
630 #define Set_Node_Offset(node,byte)
631 #define Set_Cur_Node_Offset
632 #define Set_Node_Length_To_R(node,len)
633 #define Set_Node_Length(node,len)
634 #define Set_Node_Cur_Length(node)
635 #define Node_Offset(n) 
636 #define Node_Length(n) 
637 #define Set_Node_Offset_Length(node,offset,len)
638 #define ProgLen(ri) ri->u.proglen
639 #define SetProgLen(ri,x) ri->u.proglen = x
640 #else
641 #define ProgLen(ri) ri->u.offsets[0]
642 #define SetProgLen(ri,x) ri->u.offsets[0] = x
643 #define Set_Node_Offset_To_R(node,byte) STMT_START {                    \
644     if (! SIZE_ONLY) {                                                  \
645         MJD_OFFSET_DEBUG(("** (%d) offset of node %d is %d.\n",         \
646                     __LINE__, (int)(node), (int)(byte)));               \
647         if((node) < 0) {                                                \
648             Perl_croak(aTHX_ "value of node is %d in Offset macro", (int)(node)); \
649         } else {                                                        \
650             RExC_offsets[2*(node)-1] = (byte);                          \
651         }                                                               \
652     }                                                                   \
653 } STMT_END
654
655 #define Set_Node_Offset(node,byte) \
656     Set_Node_Offset_To_R((node)-RExC_emit_start, (byte)-RExC_start)
657 #define Set_Cur_Node_Offset Set_Node_Offset(RExC_emit, RExC_parse)
658
659 #define Set_Node_Length_To_R(node,len) STMT_START {                     \
660     if (! SIZE_ONLY) {                                                  \
661         MJD_OFFSET_DEBUG(("** (%d) size of node %d is %d.\n",           \
662                 __LINE__, (int)(node), (int)(len)));                    \
663         if((node) < 0) {                                                \
664             Perl_croak(aTHX_ "value of node is %d in Length macro", (int)(node)); \
665         } else {                                                        \
666             RExC_offsets[2*(node)] = (len);                             \
667         }                                                               \
668     }                                                                   \
669 } STMT_END
670
671 #define Set_Node_Length(node,len) \
672     Set_Node_Length_To_R((node)-RExC_emit_start, len)
673 #define Set_Cur_Node_Length(len) Set_Node_Length(RExC_emit, len)
674 #define Set_Node_Cur_Length(node) \
675     Set_Node_Length(node, RExC_parse - parse_start)
676
677 /* Get offsets and lengths */
678 #define Node_Offset(n) (RExC_offsets[2*((n)-RExC_emit_start)-1])
679 #define Node_Length(n) (RExC_offsets[2*((n)-RExC_emit_start)])
680
681 #define Set_Node_Offset_Length(node,offset,len) STMT_START {    \
682     Set_Node_Offset_To_R((node)-RExC_emit_start, (offset));     \
683     Set_Node_Length_To_R((node)-RExC_emit_start, (len));        \
684 } STMT_END
685 #endif
686
687 #if PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS
688 #define EXPERIMENTAL_INPLACESCAN
689 #endif /*PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS*/
690
691 #define DEBUG_STUDYDATA(str,data,depth)                              \
692 DEBUG_OPTIMISE_MORE_r(if(data){                                      \
693     PerlIO_printf(Perl_debug_log,                                    \
694         "%*s" str "Pos:%"IVdf"/%"IVdf                                \
695         " Flags: 0x%"UVXf" Whilem_c: %"IVdf" Lcp: %"IVdf" %s",       \
696         (int)(depth)*2, "",                                          \
697         (IV)((data)->pos_min),                                       \
698         (IV)((data)->pos_delta),                                     \
699         (UV)((data)->flags),                                         \
700         (IV)((data)->whilem_c),                                      \
701         (IV)((data)->last_closep ? *((data)->last_closep) : -1),     \
702         is_inf ? "INF " : ""                                         \
703     );                                                               \
704     if ((data)->last_found)                                          \
705         PerlIO_printf(Perl_debug_log,                                \
706             "Last:'%s' %"IVdf":%"IVdf"/%"IVdf" %sFixed:'%s' @ %"IVdf \
707             " %sFloat: '%s' @ %"IVdf"/%"IVdf"",                      \
708             SvPVX_const((data)->last_found),                         \
709             (IV)((data)->last_end),                                  \
710             (IV)((data)->last_start_min),                            \
711             (IV)((data)->last_start_max),                            \
712             ((data)->longest &&                                      \
713              (data)->longest==&((data)->longest_fixed)) ? "*" : "",  \
714             SvPVX_const((data)->longest_fixed),                      \
715             (IV)((data)->offset_fixed),                              \
716             ((data)->longest &&                                      \
717              (data)->longest==&((data)->longest_float)) ? "*" : "",  \
718             SvPVX_const((data)->longest_float),                      \
719             (IV)((data)->offset_float_min),                          \
720             (IV)((data)->offset_float_max)                           \
721         );                                                           \
722     PerlIO_printf(Perl_debug_log,"\n");                              \
723 });
724
725 /* Mark that we cannot extend a found fixed substring at this point.
726    Update the longest found anchored substring and the longest found
727    floating substrings if needed. */
728
729 STATIC void
730 S_scan_commit(pTHX_ const RExC_state_t *pRExC_state, scan_data_t *data, I32 *minlenp, int is_inf)
731 {
732     const STRLEN l = CHR_SVLEN(data->last_found);
733     const STRLEN old_l = CHR_SVLEN(*data->longest);
734     GET_RE_DEBUG_FLAGS_DECL;
735
736     PERL_ARGS_ASSERT_SCAN_COMMIT;
737
738     if ((l >= old_l) && ((l > old_l) || (data->flags & SF_BEFORE_EOL))) {
739         SvSetMagicSV(*data->longest, data->last_found);
740         if (*data->longest == data->longest_fixed) {
741             data->offset_fixed = l ? data->last_start_min : data->pos_min;
742             if (data->flags & SF_BEFORE_EOL)
743                 data->flags
744                     |= ((data->flags & SF_BEFORE_EOL) << SF_FIX_SHIFT_EOL);
745             else
746                 data->flags &= ~SF_FIX_BEFORE_EOL;
747             data->minlen_fixed=minlenp;
748             data->lookbehind_fixed=0;
749         }
750         else { /* *data->longest == data->longest_float */
751             data->offset_float_min = l ? data->last_start_min : data->pos_min;
752             data->offset_float_max = (l
753                                       ? data->last_start_max
754                                       : (data->pos_delta == I32_MAX ? I32_MAX : data->pos_min + data->pos_delta));
755             if (is_inf || (U32)data->offset_float_max > (U32)I32_MAX)
756                 data->offset_float_max = I32_MAX;
757             if (data->flags & SF_BEFORE_EOL)
758                 data->flags
759                     |= ((data->flags & SF_BEFORE_EOL) << SF_FL_SHIFT_EOL);
760             else
761                 data->flags &= ~SF_FL_BEFORE_EOL;
762             data->minlen_float=minlenp;
763             data->lookbehind_float=0;
764         }
765     }
766     SvCUR_set(data->last_found, 0);
767     {
768         SV * const sv = data->last_found;
769         if (SvUTF8(sv) && SvMAGICAL(sv)) {
770             MAGIC * const mg = mg_find(sv, PERL_MAGIC_utf8);
771             if (mg)
772                 mg->mg_len = 0;
773         }
774     }
775     data->last_end = -1;
776     data->flags &= ~SF_BEFORE_EOL;
777     DEBUG_STUDYDATA("commit: ",data,0);
778 }
779
780 /* These macros set, clear and test whether the synthetic start class ('ssc',
781  * given by the parameter) matches an empty string (EOS).  This uses the
782  * 'next_off' field in the node, to save a bit in the flags field.  The ssc
783  * stands alone, so there is never a next_off, so this field is otherwise
784  * unused.  The EOS information is used only for compilation, but theoretically
785  * it could be passed on to the execution code.  This could be used to store
786  * more than one bit of information, but only this one is currently used. */
787 #define SET_SSC_EOS(node)   STMT_START { (node)->next_off = TRUE; } STMT_END
788 #define CLEAR_SSC_EOS(node) STMT_START { (node)->next_off = FALSE; } STMT_END
789 #define TEST_SSC_EOS(node)  cBOOL((node)->next_off)
790
791 /* Can match anything (initialization) */
792 STATIC void
793 S_cl_anything(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl)
794 {
795     PERL_ARGS_ASSERT_CL_ANYTHING;
796
797     ANYOF_BITMAP_SETALL(cl);
798     cl->flags = ANYOF_UNICODE_ALL;
799     SET_SSC_EOS(cl);
800
801     /* If any portion of the regex is to operate under locale rules,
802      * initialization includes it.  The reason this isn't done for all regexes
803      * is that the optimizer was written under the assumption that locale was
804      * all-or-nothing.  Given the complexity and lack of documentation in the
805      * optimizer, and that there are inadequate test cases for locale, so many
806      * parts of it may not work properly, it is safest to avoid locale unless
807      * necessary. */
808     if (RExC_contains_locale) {
809         ANYOF_CLASS_SETALL(cl);     /* /l uses class */
810         cl->flags |= ANYOF_LOCALE|ANYOF_CLASS|ANYOF_LOC_FOLD;
811     }
812     else {
813         ANYOF_CLASS_ZERO(cl);       /* Only /l uses class now */
814     }
815 }
816
817 /* Can match anything (initialization) */
818 STATIC int
819 S_cl_is_anything(const struct regnode_charclass_class *cl)
820 {
821     int value;
822
823     PERL_ARGS_ASSERT_CL_IS_ANYTHING;
824
825     for (value = 0; value < ANYOF_MAX; value += 2)
826         if (ANYOF_CLASS_TEST(cl, value) && ANYOF_CLASS_TEST(cl, value + 1))
827             return 1;
828     if (!(cl->flags & ANYOF_UNICODE_ALL))
829         return 0;
830     if (!ANYOF_BITMAP_TESTALLSET((const void*)cl))
831         return 0;
832     return 1;
833 }
834
835 /* Can match anything (initialization) */
836 STATIC void
837 S_cl_init(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl)
838 {
839     PERL_ARGS_ASSERT_CL_INIT;
840
841     Zero(cl, 1, struct regnode_charclass_class);
842     cl->type = ANYOF;
843     cl_anything(pRExC_state, cl);
844     ARG_SET(cl, ANYOF_NONBITMAP_EMPTY);
845 }
846
847 /* These two functions currently do the exact same thing */
848 #define cl_init_zero            S_cl_init
849
850 /* 'AND' a given class with another one.  Can create false positives.  'cl'
851  * should not be inverted.  'and_with->flags & ANYOF_CLASS' should be 0 if
852  * 'and_with' is a regnode_charclass instead of a regnode_charclass_class. */
853 STATIC void
854 S_cl_and(struct regnode_charclass_class *cl,
855         const struct regnode_charclass_class *and_with)
856 {
857     PERL_ARGS_ASSERT_CL_AND;
858
859     assert(PL_regkind[and_with->type] == ANYOF);
860
861     /* I (khw) am not sure all these restrictions are necessary XXX */
862     if (!(ANYOF_CLASS_TEST_ANY_SET(and_with))
863         && !(ANYOF_CLASS_TEST_ANY_SET(cl))
864         && (and_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
865         && !(and_with->flags & ANYOF_LOC_FOLD)
866         && !(cl->flags & ANYOF_LOC_FOLD)) {
867         int i;
868
869         if (and_with->flags & ANYOF_INVERT)
870             for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
871                 cl->bitmap[i] &= ~and_with->bitmap[i];
872         else
873             for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
874                 cl->bitmap[i] &= and_with->bitmap[i];
875     } /* XXXX: logic is complicated otherwise, leave it along for a moment. */
876
877     if (and_with->flags & ANYOF_INVERT) {
878
879         /* Here, the and'ed node is inverted.  Get the AND of the flags that
880          * aren't affected by the inversion.  Those that are affected are
881          * handled individually below */
882         U8 affected_flags = cl->flags & ~INVERSION_UNAFFECTED_FLAGS;
883         cl->flags &= (and_with->flags & INVERSION_UNAFFECTED_FLAGS);
884         cl->flags |= affected_flags;
885
886         /* We currently don't know how to deal with things that aren't in the
887          * bitmap, but we know that the intersection is no greater than what
888          * is already in cl, so let there be false positives that get sorted
889          * out after the synthetic start class succeeds, and the node is
890          * matched for real. */
891
892         /* The inversion of these two flags indicate that the resulting
893          * intersection doesn't have them */
894         if (and_with->flags & ANYOF_UNICODE_ALL) {
895             cl->flags &= ~ANYOF_UNICODE_ALL;
896         }
897         if (and_with->flags & ANYOF_NON_UTF8_LATIN1_ALL) {
898             cl->flags &= ~ANYOF_NON_UTF8_LATIN1_ALL;
899         }
900     }
901     else {   /* and'd node is not inverted */
902         U8 outside_bitmap_but_not_utf8; /* Temp variable */
903
904         if (! ANYOF_NONBITMAP(and_with)) {
905
906             /* Here 'and_with' doesn't match anything outside the bitmap
907              * (except possibly ANYOF_UNICODE_ALL), which means the
908              * intersection can't either, except for ANYOF_UNICODE_ALL, in
909              * which case we don't know what the intersection is, but it's no
910              * greater than what cl already has, so can just leave it alone,
911              * with possible false positives */
912             if (! (and_with->flags & ANYOF_UNICODE_ALL)) {
913                 ARG_SET(cl, ANYOF_NONBITMAP_EMPTY);
914                 cl->flags &= ~ANYOF_NONBITMAP_NON_UTF8;
915             }
916         }
917         else if (! ANYOF_NONBITMAP(cl)) {
918
919             /* Here, 'and_with' does match something outside the bitmap, and cl
920              * doesn't have a list of things to match outside the bitmap.  If
921              * cl can match all code points above 255, the intersection will
922              * be those above-255 code points that 'and_with' matches.  If cl
923              * can't match all Unicode code points, it means that it can't
924              * match anything outside the bitmap (since the 'if' that got us
925              * into this block tested for that), so we leave the bitmap empty.
926              */
927             if (cl->flags & ANYOF_UNICODE_ALL) {
928                 ARG_SET(cl, ARG(and_with));
929
930                 /* and_with's ARG may match things that don't require UTF8.
931                  * And now cl's will too, in spite of this being an 'and'.  See
932                  * the comments below about the kludge */
933                 cl->flags |= and_with->flags & ANYOF_NONBITMAP_NON_UTF8;
934             }
935         }
936         else {
937             /* Here, both 'and_with' and cl match something outside the
938              * bitmap.  Currently we do not do the intersection, so just match
939              * whatever cl had at the beginning.  */
940         }
941
942
943         /* Take the intersection of the two sets of flags.  However, the
944          * ANYOF_NONBITMAP_NON_UTF8 flag is treated as an 'or'.  This is a
945          * kludge around the fact that this flag is not treated like the others
946          * which are initialized in cl_anything().  The way the optimizer works
947          * is that the synthetic start class (SSC) is initialized to match
948          * anything, and then the first time a real node is encountered, its
949          * values are AND'd with the SSC's with the result being the values of
950          * the real node.  However, there are paths through the optimizer where
951          * the AND never gets called, so those initialized bits are set
952          * inappropriately, which is not usually a big deal, as they just cause
953          * false positives in the SSC, which will just mean a probably
954          * imperceptible slow down in execution.  However this bit has a
955          * higher false positive consequence in that it can cause utf8.pm,
956          * utf8_heavy.pl ... to be loaded when not necessary, which is a much
957          * bigger slowdown and also causes significant extra memory to be used.
958          * In order to prevent this, the code now takes a different tack.  The
959          * bit isn't set unless some part of the regular expression needs it,
960          * but once set it won't get cleared.  This means that these extra
961          * modules won't get loaded unless there was some path through the
962          * pattern that would have required them anyway, and  so any false
963          * positives that occur by not ANDing them out when they could be
964          * aren't as severe as they would be if we treated this bit like all
965          * the others */
966         outside_bitmap_but_not_utf8 = (cl->flags | and_with->flags)
967                                       & ANYOF_NONBITMAP_NON_UTF8;
968         cl->flags &= and_with->flags;
969         cl->flags |= outside_bitmap_but_not_utf8;
970     }
971 }
972
973 /* 'OR' a given class with another one.  Can create false positives.  'cl'
974  * should not be inverted.  'or_with->flags & ANYOF_CLASS' should be 0 if
975  * 'or_with' is a regnode_charclass instead of a regnode_charclass_class. */
976 STATIC void
977 S_cl_or(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl, const struct regnode_charclass_class *or_with)
978 {
979     PERL_ARGS_ASSERT_CL_OR;
980
981     if (or_with->flags & ANYOF_INVERT) {
982
983         /* Here, the or'd node is to be inverted.  This means we take the
984          * complement of everything not in the bitmap, but currently we don't
985          * know what that is, so give up and match anything */
986         if (ANYOF_NONBITMAP(or_with)) {
987             cl_anything(pRExC_state, cl);
988         }
989         /* We do not use
990          * (B1 | CL1) | (!B2 & !CL2) = (B1 | !B2 & !CL2) | (CL1 | (!B2 & !CL2))
991          *   <= (B1 | !B2) | (CL1 | !CL2)
992          * which is wasteful if CL2 is small, but we ignore CL2:
993          *   (B1 | CL1) | (!B2 & !CL2) <= (B1 | CL1) | !B2 = (B1 | !B2) | CL1
994          * XXXX Can we handle case-fold?  Unclear:
995          *   (OK1(i) | OK1(i')) | !(OK1(i) | OK1(i')) =
996          *   (OK1(i) | OK1(i')) | (!OK1(i) & !OK1(i'))
997          */
998         else if ( (or_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
999              && !(or_with->flags & ANYOF_LOC_FOLD)
1000              && !(cl->flags & ANYOF_LOC_FOLD) ) {
1001             int i;
1002
1003             for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
1004                 cl->bitmap[i] |= ~or_with->bitmap[i];
1005         } /* XXXX: logic is complicated otherwise */
1006         else {
1007             cl_anything(pRExC_state, cl);
1008         }
1009
1010         /* And, we can just take the union of the flags that aren't affected
1011          * by the inversion */
1012         cl->flags |= or_with->flags & INVERSION_UNAFFECTED_FLAGS;
1013
1014         /* For the remaining flags:
1015             ANYOF_UNICODE_ALL and inverted means to not match anything above
1016                     255, which means that the union with cl should just be
1017                     what cl has in it, so can ignore this flag
1018             ANYOF_NON_UTF8_LATIN1_ALL and inverted means if not utf8 and ord
1019                     is 127-255 to match them, but then invert that, so the
1020                     union with cl should just be what cl has in it, so can
1021                     ignore this flag
1022          */
1023     } else {    /* 'or_with' is not inverted */
1024         /* (B1 | CL1) | (B2 | CL2) = (B1 | B2) | (CL1 | CL2)) */
1025         if ( (or_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
1026              && (!(or_with->flags & ANYOF_LOC_FOLD)
1027                  || (cl->flags & ANYOF_LOC_FOLD)) ) {
1028             int i;
1029
1030             /* OR char bitmap and class bitmap separately */
1031             for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
1032                 cl->bitmap[i] |= or_with->bitmap[i];
1033             if (or_with->flags & ANYOF_CLASS) {
1034                 ANYOF_CLASS_OR(or_with, cl);
1035             }
1036         }
1037         else { /* XXXX: logic is complicated, leave it along for a moment. */
1038             cl_anything(pRExC_state, cl);
1039         }
1040
1041         if (ANYOF_NONBITMAP(or_with)) {
1042
1043             /* Use the added node's outside-the-bit-map match if there isn't a
1044              * conflict.  If there is a conflict (both nodes match something
1045              * outside the bitmap, but what they match outside is not the same
1046              * pointer, and hence not easily compared until XXX we extend
1047              * inversion lists this far), give up and allow the start class to
1048              * match everything outside the bitmap.  If that stuff is all above
1049              * 255, can just set UNICODE_ALL, otherwise caould be anything. */
1050             if (! ANYOF_NONBITMAP(cl)) {
1051                 ARG_SET(cl, ARG(or_with));
1052             }
1053             else if (ARG(cl) != ARG(or_with)) {
1054
1055                 if ((or_with->flags & ANYOF_NONBITMAP_NON_UTF8)) {
1056                     cl_anything(pRExC_state, cl);
1057                 }
1058                 else {
1059                     cl->flags |= ANYOF_UNICODE_ALL;
1060                 }
1061             }
1062         }
1063
1064         /* Take the union */
1065         cl->flags |= or_with->flags;
1066     }
1067 }
1068
1069 #define TRIE_LIST_ITEM(state,idx) (trie->states[state].trans.list)[ idx ]
1070 #define TRIE_LIST_CUR(state)  ( TRIE_LIST_ITEM( state, 0 ).forid )
1071 #define TRIE_LIST_LEN(state) ( TRIE_LIST_ITEM( state, 0 ).newstate )
1072 #define TRIE_LIST_USED(idx)  ( trie->states[state].trans.list ? (TRIE_LIST_CUR( idx ) - 1) : 0 )
1073
1074
1075 #ifdef DEBUGGING
1076 /*
1077    dump_trie(trie,widecharmap,revcharmap)
1078    dump_trie_interim_list(trie,widecharmap,revcharmap,next_alloc)
1079    dump_trie_interim_table(trie,widecharmap,revcharmap,next_alloc)
1080
1081    These routines dump out a trie in a somewhat readable format.
1082    The _interim_ variants are used for debugging the interim
1083    tables that are used to generate the final compressed
1084    representation which is what dump_trie expects.
1085
1086    Part of the reason for their existence is to provide a form
1087    of documentation as to how the different representations function.
1088
1089 */
1090
1091 /*
1092   Dumps the final compressed table form of the trie to Perl_debug_log.
1093   Used for debugging make_trie().
1094 */
1095
1096 STATIC void
1097 S_dump_trie(pTHX_ const struct _reg_trie_data *trie, HV *widecharmap,
1098             AV *revcharmap, U32 depth)
1099 {
1100     U32 state;
1101     SV *sv=sv_newmortal();
1102     int colwidth= widecharmap ? 6 : 4;
1103     U16 word;
1104     GET_RE_DEBUG_FLAGS_DECL;
1105
1106     PERL_ARGS_ASSERT_DUMP_TRIE;
1107
1108     PerlIO_printf( Perl_debug_log, "%*sChar : %-6s%-6s%-4s ",
1109         (int)depth * 2 + 2,"",
1110         "Match","Base","Ofs" );
1111
1112     for( state = 0 ; state < trie->uniquecharcount ; state++ ) {
1113         SV ** const tmp = av_fetch( revcharmap, state, 0);
1114         if ( tmp ) {
1115             PerlIO_printf( Perl_debug_log, "%*s", 
1116                 colwidth,
1117                 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth, 
1118                             PL_colors[0], PL_colors[1],
1119                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1120                             PERL_PV_ESCAPE_FIRSTCHAR 
1121                 ) 
1122             );
1123         }
1124     }
1125     PerlIO_printf( Perl_debug_log, "\n%*sState|-----------------------",
1126         (int)depth * 2 + 2,"");
1127
1128     for( state = 0 ; state < trie->uniquecharcount ; state++ )
1129         PerlIO_printf( Perl_debug_log, "%.*s", colwidth, "--------");
1130     PerlIO_printf( Perl_debug_log, "\n");
1131
1132     for( state = 1 ; state < trie->statecount ; state++ ) {
1133         const U32 base = trie->states[ state ].trans.base;
1134
1135         PerlIO_printf( Perl_debug_log, "%*s#%4"UVXf"|", (int)depth * 2 + 2,"", (UV)state);
1136
1137         if ( trie->states[ state ].wordnum ) {
1138             PerlIO_printf( Perl_debug_log, " W%4X", trie->states[ state ].wordnum );
1139         } else {
1140             PerlIO_printf( Perl_debug_log, "%6s", "" );
1141         }
1142
1143         PerlIO_printf( Perl_debug_log, " @%4"UVXf" ", (UV)base );
1144
1145         if ( base ) {
1146             U32 ofs = 0;
1147
1148             while( ( base + ofs  < trie->uniquecharcount ) ||
1149                    ( base + ofs - trie->uniquecharcount < trie->lasttrans
1150                      && trie->trans[ base + ofs - trie->uniquecharcount ].check != state))
1151                     ofs++;
1152
1153             PerlIO_printf( Perl_debug_log, "+%2"UVXf"[ ", (UV)ofs);
1154
1155             for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
1156                 if ( ( base + ofs >= trie->uniquecharcount ) &&
1157                      ( base + ofs - trie->uniquecharcount < trie->lasttrans ) &&
1158                      trie->trans[ base + ofs - trie->uniquecharcount ].check == state )
1159                 {
1160                    PerlIO_printf( Perl_debug_log, "%*"UVXf,
1161                     colwidth,
1162                     (UV)trie->trans[ base + ofs - trie->uniquecharcount ].next );
1163                 } else {
1164                     PerlIO_printf( Perl_debug_log, "%*s",colwidth,"   ." );
1165                 }
1166             }
1167
1168             PerlIO_printf( Perl_debug_log, "]");
1169
1170         }
1171         PerlIO_printf( Perl_debug_log, "\n" );
1172     }
1173     PerlIO_printf(Perl_debug_log, "%*sword_info N:(prev,len)=", (int)depth*2, "");
1174     for (word=1; word <= trie->wordcount; word++) {
1175         PerlIO_printf(Perl_debug_log, " %d:(%d,%d)",
1176             (int)word, (int)(trie->wordinfo[word].prev),
1177             (int)(trie->wordinfo[word].len));
1178     }
1179     PerlIO_printf(Perl_debug_log, "\n" );
1180 }    
1181 /*
1182   Dumps a fully constructed but uncompressed trie in list form.
1183   List tries normally only are used for construction when the number of 
1184   possible chars (trie->uniquecharcount) is very high.
1185   Used for debugging make_trie().
1186 */
1187 STATIC void
1188 S_dump_trie_interim_list(pTHX_ const struct _reg_trie_data *trie,
1189                          HV *widecharmap, AV *revcharmap, U32 next_alloc,
1190                          U32 depth)
1191 {
1192     U32 state;
1193     SV *sv=sv_newmortal();
1194     int colwidth= widecharmap ? 6 : 4;
1195     GET_RE_DEBUG_FLAGS_DECL;
1196
1197     PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_LIST;
1198
1199     /* print out the table precompression.  */
1200     PerlIO_printf( Perl_debug_log, "%*sState :Word | Transition Data\n%*s%s",
1201         (int)depth * 2 + 2,"", (int)depth * 2 + 2,"",
1202         "------:-----+-----------------\n" );
1203     
1204     for( state=1 ; state < next_alloc ; state ++ ) {
1205         U16 charid;
1206     
1207         PerlIO_printf( Perl_debug_log, "%*s %4"UVXf" :",
1208             (int)depth * 2 + 2,"", (UV)state  );
1209         if ( ! trie->states[ state ].wordnum ) {
1210             PerlIO_printf( Perl_debug_log, "%5s| ","");
1211         } else {
1212             PerlIO_printf( Perl_debug_log, "W%4x| ",
1213                 trie->states[ state ].wordnum
1214             );
1215         }
1216         for( charid = 1 ; charid <= TRIE_LIST_USED( state ) ; charid++ ) {
1217             SV ** const tmp = av_fetch( revcharmap, TRIE_LIST_ITEM(state,charid).forid, 0);
1218             if ( tmp ) {
1219                 PerlIO_printf( Perl_debug_log, "%*s:%3X=%4"UVXf" | ",
1220                     colwidth,
1221                     pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth, 
1222                             PL_colors[0], PL_colors[1],
1223                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1224                             PERL_PV_ESCAPE_FIRSTCHAR 
1225                     ) ,
1226                     TRIE_LIST_ITEM(state,charid).forid,
1227                     (UV)TRIE_LIST_ITEM(state,charid).newstate
1228                 );
1229                 if (!(charid % 10)) 
1230                     PerlIO_printf(Perl_debug_log, "\n%*s| ",
1231                         (int)((depth * 2) + 14), "");
1232             }
1233         }
1234         PerlIO_printf( Perl_debug_log, "\n");
1235     }
1236 }    
1237
1238 /*
1239   Dumps a fully constructed but uncompressed trie in table form.
1240   This is the normal DFA style state transition table, with a few 
1241   twists to facilitate compression later. 
1242   Used for debugging make_trie().
1243 */
1244 STATIC void
1245 S_dump_trie_interim_table(pTHX_ const struct _reg_trie_data *trie,
1246                           HV *widecharmap, AV *revcharmap, U32 next_alloc,
1247                           U32 depth)
1248 {
1249     U32 state;
1250     U16 charid;
1251     SV *sv=sv_newmortal();
1252     int colwidth= widecharmap ? 6 : 4;
1253     GET_RE_DEBUG_FLAGS_DECL;
1254
1255     PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_TABLE;
1256     
1257     /*
1258        print out the table precompression so that we can do a visual check
1259        that they are identical.
1260      */
1261     
1262     PerlIO_printf( Perl_debug_log, "%*sChar : ",(int)depth * 2 + 2,"" );
1263
1264     for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
1265         SV ** const tmp = av_fetch( revcharmap, charid, 0);
1266         if ( tmp ) {
1267             PerlIO_printf( Perl_debug_log, "%*s", 
1268                 colwidth,
1269                 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth, 
1270                             PL_colors[0], PL_colors[1],
1271                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1272                             PERL_PV_ESCAPE_FIRSTCHAR 
1273                 ) 
1274             );
1275         }
1276     }
1277
1278     PerlIO_printf( Perl_debug_log, "\n%*sState+-",(int)depth * 2 + 2,"" );
1279
1280     for( charid=0 ; charid < trie->uniquecharcount ; charid++ ) {
1281         PerlIO_printf( Perl_debug_log, "%.*s", colwidth,"--------");
1282     }
1283
1284     PerlIO_printf( Perl_debug_log, "\n" );
1285
1286     for( state=1 ; state < next_alloc ; state += trie->uniquecharcount ) {
1287
1288         PerlIO_printf( Perl_debug_log, "%*s%4"UVXf" : ", 
1289             (int)depth * 2 + 2,"",
1290             (UV)TRIE_NODENUM( state ) );
1291
1292         for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
1293             UV v=(UV)SAFE_TRIE_NODENUM( trie->trans[ state + charid ].next );
1294             if (v)
1295                 PerlIO_printf( Perl_debug_log, "%*"UVXf, colwidth, v );
1296             else
1297                 PerlIO_printf( Perl_debug_log, "%*s", colwidth, "." );
1298         }
1299         if ( ! trie->states[ TRIE_NODENUM( state ) ].wordnum ) {
1300             PerlIO_printf( Perl_debug_log, " (%4"UVXf")\n", (UV)trie->trans[ state ].check );
1301         } else {
1302             PerlIO_printf( Perl_debug_log, " (%4"UVXf") W%4X\n", (UV)trie->trans[ state ].check,
1303             trie->states[ TRIE_NODENUM( state ) ].wordnum );
1304         }
1305     }
1306 }
1307
1308 #endif
1309
1310
1311 /* make_trie(startbranch,first,last,tail,word_count,flags,depth)
1312   startbranch: the first branch in the whole branch sequence
1313   first      : start branch of sequence of branch-exact nodes.
1314                May be the same as startbranch
1315   last       : Thing following the last branch.
1316                May be the same as tail.
1317   tail       : item following the branch sequence
1318   count      : words in the sequence
1319   flags      : currently the OP() type we will be building one of /EXACT(|F|Fl)/
1320   depth      : indent depth
1321
1322 Inplace optimizes a sequence of 2 or more Branch-Exact nodes into a TRIE node.
1323
1324 A trie is an N'ary tree where the branches are determined by digital
1325 decomposition of the key. IE, at the root node you look up the 1st character and
1326 follow that branch repeat until you find the end of the branches. Nodes can be
1327 marked as "accepting" meaning they represent a complete word. Eg:
1328
1329   /he|she|his|hers/
1330
1331 would convert into the following structure. Numbers represent states, letters
1332 following numbers represent valid transitions on the letter from that state, if
1333 the number is in square brackets it represents an accepting state, otherwise it
1334 will be in parenthesis.
1335
1336       +-h->+-e->[3]-+-r->(8)-+-s->[9]
1337       |    |
1338       |   (2)
1339       |    |
1340      (1)   +-i->(6)-+-s->[7]
1341       |
1342       +-s->(3)-+-h->(4)-+-e->[5]
1343
1344       Accept Word Mapping: 3=>1 (he),5=>2 (she), 7=>3 (his), 9=>4 (hers)
1345
1346 This shows that when matching against the string 'hers' we will begin at state 1
1347 read 'h' and move to state 2, read 'e' and move to state 3 which is accepting,
1348 then read 'r' and go to state 8 followed by 's' which takes us to state 9 which
1349 is also accepting. Thus we know that we can match both 'he' and 'hers' with a
1350 single traverse. We store a mapping from accepting to state to which word was
1351 matched, and then when we have multiple possibilities we try to complete the
1352 rest of the regex in the order in which they occured in the alternation.
1353
1354 The only prior NFA like behaviour that would be changed by the TRIE support is
1355 the silent ignoring of duplicate alternations which are of the form:
1356
1357  / (DUPE|DUPE) X? (?{ ... }) Y /x
1358
1359 Thus EVAL blocks following a trie may be called a different number of times with
1360 and without the optimisation. With the optimisations dupes will be silently
1361 ignored. This inconsistent behaviour of EVAL type nodes is well established as
1362 the following demonstrates:
1363
1364  'words'=~/(word|word|word)(?{ print $1 })[xyz]/
1365
1366 which prints out 'word' three times, but
1367
1368  'words'=~/(word|word|word)(?{ print $1 })S/
1369
1370 which doesnt print it out at all. This is due to other optimisations kicking in.
1371
1372 Example of what happens on a structural level:
1373
1374 The regexp /(ac|ad|ab)+/ will produce the following debug output:
1375
1376    1: CURLYM[1] {1,32767}(18)
1377    5:   BRANCH(8)
1378    6:     EXACT <ac>(16)
1379    8:   BRANCH(11)
1380    9:     EXACT <ad>(16)
1381   11:   BRANCH(14)
1382   12:     EXACT <ab>(16)
1383   16:   SUCCEED(0)
1384   17:   NOTHING(18)
1385   18: END(0)
1386
1387 This would be optimizable with startbranch=5, first=5, last=16, tail=16
1388 and should turn into:
1389
1390    1: CURLYM[1] {1,32767}(18)
1391    5:   TRIE(16)
1392         [Words:3 Chars Stored:6 Unique Chars:4 States:5 NCP:1]
1393           <ac>
1394           <ad>
1395           <ab>
1396   16:   SUCCEED(0)
1397   17:   NOTHING(18)
1398   18: END(0)
1399
1400 Cases where tail != last would be like /(?foo|bar)baz/:
1401
1402    1: BRANCH(4)
1403    2:   EXACT <foo>(8)
1404    4: BRANCH(7)
1405    5:   EXACT <bar>(8)
1406    7: TAIL(8)
1407    8: EXACT <baz>(10)
1408   10: END(0)
1409
1410 which would be optimizable with startbranch=1, first=1, last=7, tail=8
1411 and would end up looking like:
1412
1413     1: TRIE(8)
1414       [Words:2 Chars Stored:6 Unique Chars:5 States:7 NCP:1]
1415         <foo>
1416         <bar>
1417    7: TAIL(8)
1418    8: EXACT <baz>(10)
1419   10: END(0)
1420
1421     d = uvuni_to_utf8_flags(d, uv, 0);
1422
1423 is the recommended Unicode-aware way of saying
1424
1425     *(d++) = uv;
1426 */
1427
1428 #define TRIE_STORE_REVCHAR(val)                                            \
1429     STMT_START {                                                           \
1430         if (UTF) {                                                         \
1431             SV *zlopp = newSV(7); /* XXX: optimize me */                   \
1432             unsigned char *flrbbbbb = (unsigned char *) SvPVX(zlopp);      \
1433             unsigned const char *const kapow = uvuni_to_utf8(flrbbbbb, val); \
1434             SvCUR_set(zlopp, kapow - flrbbbbb);                            \
1435             SvPOK_on(zlopp);                                               \
1436             SvUTF8_on(zlopp);                                              \
1437             av_push(revcharmap, zlopp);                                    \
1438         } else {                                                           \
1439             char ooooff = (char)val;                                           \
1440             av_push(revcharmap, newSVpvn(&ooooff, 1));                     \
1441         }                                                                  \
1442         } STMT_END
1443
1444 #define TRIE_READ_CHAR STMT_START {                                                     \
1445     wordlen++;                                                                          \
1446     if ( UTF ) {                                                                        \
1447         /* if it is UTF then it is either already folded, or does not need folding */   \
1448         uvc = utf8n_to_uvuni( (const U8*) uc, UTF8_MAXLEN, &len, uniflags);             \
1449     }                                                                                   \
1450     else if (folder == PL_fold_latin1) {                                                \
1451         /* if we use this folder we have to obey unicode rules on latin-1 data */       \
1452         if ( foldlen > 0 ) {                                                            \
1453            uvc = utf8n_to_uvuni( (const U8*) scan, UTF8_MAXLEN, &len, uniflags );       \
1454            foldlen -= len;                                                              \
1455            scan += len;                                                                 \
1456            len = 0;                                                                     \
1457         } else {                                                                        \
1458             len = 1;                                                                    \
1459             uvc = _to_fold_latin1( (U8) *uc, foldbuf, &foldlen, 1);                     \
1460             skiplen = UNISKIP(uvc);                                                     \
1461             foldlen -= skiplen;                                                         \
1462             scan = foldbuf + skiplen;                                                   \
1463         }                                                                               \
1464     } else {                                                                            \
1465         /* raw data, will be folded later if needed */                                  \
1466         uvc = (U32)*uc;                                                                 \
1467         len = 1;                                                                        \
1468     }                                                                                   \
1469 } STMT_END
1470
1471
1472
1473 #define TRIE_LIST_PUSH(state,fid,ns) STMT_START {               \
1474     if ( TRIE_LIST_CUR( state ) >=TRIE_LIST_LEN( state ) ) {    \
1475         U32 ging = TRIE_LIST_LEN( state ) *= 2;                 \
1476         Renew( trie->states[ state ].trans.list, ging, reg_trie_trans_le ); \
1477     }                                                           \
1478     TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).forid = fid;     \
1479     TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).newstate = ns;   \
1480     TRIE_LIST_CUR( state )++;                                   \
1481 } STMT_END
1482
1483 #define TRIE_LIST_NEW(state) STMT_START {                       \
1484     Newxz( trie->states[ state ].trans.list,               \
1485         4, reg_trie_trans_le );                                 \
1486      TRIE_LIST_CUR( state ) = 1;                                \
1487      TRIE_LIST_LEN( state ) = 4;                                \
1488 } STMT_END
1489
1490 #define TRIE_HANDLE_WORD(state) STMT_START {                    \
1491     U16 dupe= trie->states[ state ].wordnum;                    \
1492     regnode * const noper_next = regnext( noper );              \
1493                                                                 \
1494     DEBUG_r({                                                   \
1495         /* store the word for dumping */                        \
1496         SV* tmp;                                                \
1497         if (OP(noper) != NOTHING)                               \
1498             tmp = newSVpvn_utf8(STRING(noper), STR_LEN(noper), UTF);    \
1499         else                                                    \
1500             tmp = newSVpvn_utf8( "", 0, UTF );                  \
1501         av_push( trie_words, tmp );                             \
1502     });                                                         \
1503                                                                 \
1504     curword++;                                                  \
1505     trie->wordinfo[curword].prev   = 0;                         \
1506     trie->wordinfo[curword].len    = wordlen;                   \
1507     trie->wordinfo[curword].accept = state;                     \
1508                                                                 \
1509     if ( noper_next < tail ) {                                  \
1510         if (!trie->jump)                                        \
1511             trie->jump = (U16 *) PerlMemShared_calloc( word_count + 1, sizeof(U16) ); \
1512         trie->jump[curword] = (U16)(noper_next - convert);      \
1513         if (!jumper)                                            \
1514             jumper = noper_next;                                \
1515         if (!nextbranch)                                        \
1516             nextbranch= regnext(cur);                           \
1517     }                                                           \
1518                                                                 \
1519     if ( dupe ) {                                               \
1520         /* It's a dupe. Pre-insert into the wordinfo[].prev   */\
1521         /* chain, so that when the bits of chain are later    */\
1522         /* linked together, the dups appear in the chain      */\
1523         trie->wordinfo[curword].prev = trie->wordinfo[dupe].prev; \
1524         trie->wordinfo[dupe].prev = curword;                    \
1525     } else {                                                    \
1526         /* we haven't inserted this word yet.                */ \
1527         trie->states[ state ].wordnum = curword;                \
1528     }                                                           \
1529 } STMT_END
1530
1531
1532 #define TRIE_TRANS_STATE(state,base,ucharcount,charid,special)          \
1533      ( ( base + charid >=  ucharcount                                   \
1534          && base + charid < ubound                                      \
1535          && state == trie->trans[ base - ucharcount + charid ].check    \
1536          && trie->trans[ base - ucharcount + charid ].next )            \
1537            ? trie->trans[ base - ucharcount + charid ].next             \
1538            : ( state==1 ? special : 0 )                                 \
1539       )
1540
1541 #define MADE_TRIE       1
1542 #define MADE_JUMP_TRIE  2
1543 #define MADE_EXACT_TRIE 4
1544
1545 STATIC I32
1546 S_make_trie(pTHX_ RExC_state_t *pRExC_state, regnode *startbranch, regnode *first, regnode *last, regnode *tail, U32 word_count, U32 flags, U32 depth)
1547 {
1548     dVAR;
1549     /* first pass, loop through and scan words */
1550     reg_trie_data *trie;
1551     HV *widecharmap = NULL;
1552     AV *revcharmap = newAV();
1553     regnode *cur;
1554     const U32 uniflags = UTF8_ALLOW_DEFAULT;
1555     STRLEN len = 0;
1556     UV uvc = 0;
1557     U16 curword = 0;
1558     U32 next_alloc = 0;
1559     regnode *jumper = NULL;
1560     regnode *nextbranch = NULL;
1561     regnode *convert = NULL;
1562     U32 *prev_states; /* temp array mapping each state to previous one */
1563     /* we just use folder as a flag in utf8 */
1564     const U8 * folder = NULL;
1565
1566 #ifdef DEBUGGING
1567     const U32 data_slot = add_data( pRExC_state, 4, "tuuu" );
1568     AV *trie_words = NULL;
1569     /* along with revcharmap, this only used during construction but both are
1570      * useful during debugging so we store them in the struct when debugging.
1571      */
1572 #else
1573     const U32 data_slot = add_data( pRExC_state, 2, "tu" );
1574     STRLEN trie_charcount=0;
1575 #endif
1576     SV *re_trie_maxbuff;
1577     GET_RE_DEBUG_FLAGS_DECL;
1578
1579     PERL_ARGS_ASSERT_MAKE_TRIE;
1580 #ifndef DEBUGGING
1581     PERL_UNUSED_ARG(depth);
1582 #endif
1583
1584     switch (flags) {
1585         case EXACT: break;
1586         case EXACTFA:
1587         case EXACTFU_SS:
1588         case EXACTFU_TRICKYFOLD:
1589         case EXACTFU: folder = PL_fold_latin1; break;
1590         case EXACTF:  folder = PL_fold; break;
1591         case EXACTFL: folder = PL_fold_locale; break;
1592         default: Perl_croak( aTHX_ "panic! In trie construction, unknown node type %u %s", (unsigned) flags, PL_reg_name[flags] );
1593     }
1594
1595     trie = (reg_trie_data *) PerlMemShared_calloc( 1, sizeof(reg_trie_data) );
1596     trie->refcount = 1;
1597     trie->startstate = 1;
1598     trie->wordcount = word_count;
1599     RExC_rxi->data->data[ data_slot ] = (void*)trie;
1600     trie->charmap = (U16 *) PerlMemShared_calloc( 256, sizeof(U16) );
1601     if (flags == EXACT)
1602         trie->bitmap = (char *) PerlMemShared_calloc( ANYOF_BITMAP_SIZE, 1 );
1603     trie->wordinfo = (reg_trie_wordinfo *) PerlMemShared_calloc(
1604                        trie->wordcount+1, sizeof(reg_trie_wordinfo));
1605
1606     DEBUG_r({
1607         trie_words = newAV();
1608     });
1609
1610     re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
1611     if (!SvIOK(re_trie_maxbuff)) {
1612         sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
1613     }
1614     DEBUG_TRIE_COMPILE_r({
1615                 PerlIO_printf( Perl_debug_log,
1616                   "%*smake_trie start==%d, first==%d, last==%d, tail==%d depth=%d\n",
1617                   (int)depth * 2 + 2, "", 
1618                   REG_NODE_NUM(startbranch),REG_NODE_NUM(first), 
1619                   REG_NODE_NUM(last), REG_NODE_NUM(tail),
1620                   (int)depth);
1621     });
1622    
1623    /* Find the node we are going to overwrite */
1624     if ( first == startbranch && OP( last ) != BRANCH ) {
1625         /* whole branch chain */
1626         convert = first;
1627     } else {
1628         /* branch sub-chain */
1629         convert = NEXTOPER( first );
1630     }
1631         
1632     /*  -- First loop and Setup --
1633
1634        We first traverse the branches and scan each word to determine if it
1635        contains widechars, and how many unique chars there are, this is
1636        important as we have to build a table with at least as many columns as we
1637        have unique chars.
1638
1639        We use an array of integers to represent the character codes 0..255
1640        (trie->charmap) and we use a an HV* to store Unicode characters. We use the
1641        native representation of the character value as the key and IV's for the
1642        coded index.
1643
1644        *TODO* If we keep track of how many times each character is used we can
1645        remap the columns so that the table compression later on is more
1646        efficient in terms of memory by ensuring the most common value is in the
1647        middle and the least common are on the outside.  IMO this would be better
1648        than a most to least common mapping as theres a decent chance the most
1649        common letter will share a node with the least common, meaning the node
1650        will not be compressible. With a middle is most common approach the worst
1651        case is when we have the least common nodes twice.
1652
1653      */
1654
1655     for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
1656         regnode *noper = NEXTOPER( cur );
1657         const U8 *uc = (U8*)STRING( noper );
1658         const U8 *e  = uc + STR_LEN( noper );
1659         STRLEN foldlen = 0;
1660         U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
1661         STRLEN skiplen = 0;
1662         const U8 *scan = (U8*)NULL;
1663         U32 wordlen      = 0;         /* required init */
1664         STRLEN chars = 0;
1665         bool set_bit = trie->bitmap ? 1 : 0; /*store the first char in the bitmap?*/
1666
1667         if (OP(noper) == NOTHING) {
1668             regnode *noper_next= regnext(noper);
1669             if (noper_next != tail && OP(noper_next) == flags) {
1670                 noper = noper_next;
1671                 uc= (U8*)STRING(noper);
1672                 e= uc + STR_LEN(noper);
1673                 trie->minlen= STR_LEN(noper);
1674             } else {
1675                 trie->minlen= 0;
1676                 continue;
1677             }
1678         }
1679
1680         if ( set_bit ) { /* bitmap only alloced when !(UTF&&Folding) */
1681             TRIE_BITMAP_SET(trie,*uc); /* store the raw first byte
1682                                           regardless of encoding */
1683             if (OP( noper ) == EXACTFU_SS) {
1684                 /* false positives are ok, so just set this */
1685                 TRIE_BITMAP_SET(trie,0xDF);
1686             }
1687         }
1688         for ( ; uc < e ; uc += len ) {
1689             TRIE_CHARCOUNT(trie)++;
1690             TRIE_READ_CHAR;
1691             chars++;
1692             if ( uvc < 256 ) {
1693                 if ( folder ) {
1694                     U8 folded= folder[ (U8) uvc ];
1695                     if ( !trie->charmap[ folded ] ) {
1696                         trie->charmap[ folded ]=( ++trie->uniquecharcount );
1697                         TRIE_STORE_REVCHAR( folded );
1698                     }
1699                 }
1700                 if ( !trie->charmap[ uvc ] ) {
1701                     trie->charmap[ uvc ]=( ++trie->uniquecharcount );
1702                     TRIE_STORE_REVCHAR( uvc );
1703                 }
1704                 if ( set_bit ) {
1705                     /* store the codepoint in the bitmap, and its folded
1706                      * equivalent. */
1707                     TRIE_BITMAP_SET(trie, uvc);
1708
1709                     /* store the folded codepoint */
1710                     if ( folder ) TRIE_BITMAP_SET(trie, folder[(U8) uvc ]);
1711
1712                     if ( !UTF ) {
1713                         /* store first byte of utf8 representation of
1714                            variant codepoints */
1715                         if (! UNI_IS_INVARIANT(uvc)) {
1716                             TRIE_BITMAP_SET(trie, UTF8_TWO_BYTE_HI(uvc));
1717                         }
1718                     }
1719                     set_bit = 0; /* We've done our bit :-) */
1720                 }
1721             } else {
1722                 SV** svpp;
1723                 if ( !widecharmap )
1724                     widecharmap = newHV();
1725
1726                 svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 1 );
1727
1728                 if ( !svpp )
1729                     Perl_croak( aTHX_ "error creating/fetching widecharmap entry for 0x%"UVXf, uvc );
1730
1731                 if ( !SvTRUE( *svpp ) ) {
1732                     sv_setiv( *svpp, ++trie->uniquecharcount );
1733                     TRIE_STORE_REVCHAR(uvc);
1734                 }
1735             }
1736         }
1737         if( cur == first ) {
1738             trie->minlen = chars;
1739             trie->maxlen = chars;
1740         } else if (chars < trie->minlen) {
1741             trie->minlen = chars;
1742         } else if (chars > trie->maxlen) {
1743             trie->maxlen = chars;
1744         }
1745         if (OP( noper ) == EXACTFU_SS) {
1746             /* XXX: workaround - 'ss' could match "\x{DF}" so minlen could be 1 and not 2*/
1747             if (trie->minlen > 1)
1748                 trie->minlen= 1;
1749         }
1750         if (OP( noper ) == EXACTFU_TRICKYFOLD) {
1751             /* XXX: workround - things like "\x{1FBE}\x{0308}\x{0301}" can match "\x{0390}" 
1752              *                - We assume that any such sequence might match a 2 byte string */
1753             if (trie->minlen > 2 )
1754                 trie->minlen= 2;
1755         }
1756
1757     } /* end first pass */
1758     DEBUG_TRIE_COMPILE_r(
1759         PerlIO_printf( Perl_debug_log, "%*sTRIE(%s): W:%d C:%d Uq:%d Min:%d Max:%d\n",
1760                 (int)depth * 2 + 2,"",
1761                 ( widecharmap ? "UTF8" : "NATIVE" ), (int)word_count,
1762                 (int)TRIE_CHARCOUNT(trie), trie->uniquecharcount,
1763                 (int)trie->minlen, (int)trie->maxlen )
1764     );
1765
1766     /*
1767         We now know what we are dealing with in terms of unique chars and
1768         string sizes so we can calculate how much memory a naive
1769         representation using a flat table  will take. If it's over a reasonable
1770         limit (as specified by ${^RE_TRIE_MAXBUF}) we use a more memory
1771         conservative but potentially much slower representation using an array
1772         of lists.
1773
1774         At the end we convert both representations into the same compressed
1775         form that will be used in regexec.c for matching with. The latter
1776         is a form that cannot be used to construct with but has memory
1777         properties similar to the list form and access properties similar
1778         to the table form making it both suitable for fast searches and
1779         small enough that its feasable to store for the duration of a program.
1780
1781         See the comment in the code where the compressed table is produced
1782         inplace from the flat tabe representation for an explanation of how
1783         the compression works.
1784
1785     */
1786
1787
1788     Newx(prev_states, TRIE_CHARCOUNT(trie) + 2, U32);
1789     prev_states[1] = 0;
1790
1791     if ( (IV)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1) > SvIV(re_trie_maxbuff) ) {
1792         /*
1793             Second Pass -- Array Of Lists Representation
1794
1795             Each state will be represented by a list of charid:state records
1796             (reg_trie_trans_le) the first such element holds the CUR and LEN
1797             points of the allocated array. (See defines above).
1798
1799             We build the initial structure using the lists, and then convert
1800             it into the compressed table form which allows faster lookups
1801             (but cant be modified once converted).
1802         */
1803
1804         STRLEN transcount = 1;
1805
1806         DEBUG_TRIE_COMPILE_MORE_r( PerlIO_printf( Perl_debug_log, 
1807             "%*sCompiling trie using list compiler\n",
1808             (int)depth * 2 + 2, ""));
1809
1810         trie->states = (reg_trie_state *)
1811             PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
1812                                   sizeof(reg_trie_state) );
1813         TRIE_LIST_NEW(1);
1814         next_alloc = 2;
1815
1816         for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
1817
1818             regnode *noper   = NEXTOPER( cur );
1819             U8 *uc           = (U8*)STRING( noper );
1820             const U8 *e      = uc + STR_LEN( noper );
1821             U32 state        = 1;         /* required init */
1822             U16 charid       = 0;         /* sanity init */
1823             U8 *scan         = (U8*)NULL; /* sanity init */
1824             STRLEN foldlen   = 0;         /* required init */
1825             U32 wordlen      = 0;         /* required init */
1826             U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
1827             STRLEN skiplen   = 0;
1828
1829             if (OP(noper) == NOTHING) {
1830                 regnode *noper_next= regnext(noper);
1831                 if (noper_next != tail && OP(noper_next) == flags) {
1832                     noper = noper_next;
1833                     uc= (U8*)STRING(noper);
1834                     e= uc + STR_LEN(noper);
1835                 }
1836             }
1837
1838             if (OP(noper) != NOTHING) {
1839                 for ( ; uc < e ; uc += len ) {
1840
1841                     TRIE_READ_CHAR;
1842
1843                     if ( uvc < 256 ) {
1844                         charid = trie->charmap[ uvc ];
1845                     } else {
1846                         SV** const svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 0);
1847                         if ( !svpp ) {
1848                             charid = 0;
1849                         } else {
1850                             charid=(U16)SvIV( *svpp );
1851                         }
1852                     }
1853                     /* charid is now 0 if we dont know the char read, or nonzero if we do */
1854                     if ( charid ) {
1855
1856                         U16 check;
1857                         U32 newstate = 0;
1858
1859                         charid--;
1860                         if ( !trie->states[ state ].trans.list ) {
1861                             TRIE_LIST_NEW( state );
1862                         }
1863                         for ( check = 1; check <= TRIE_LIST_USED( state ); check++ ) {
1864                             if ( TRIE_LIST_ITEM( state, check ).forid == charid ) {
1865                                 newstate = TRIE_LIST_ITEM( state, check ).newstate;
1866                                 break;
1867                             }
1868                         }
1869                         if ( ! newstate ) {
1870                             newstate = next_alloc++;
1871                             prev_states[newstate] = state;
1872                             TRIE_LIST_PUSH( state, charid, newstate );
1873                             transcount++;
1874                         }
1875                         state = newstate;
1876                     } else {
1877                         Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %"IVdf, uvc );
1878                     }
1879                 }
1880             }
1881             TRIE_HANDLE_WORD(state);
1882
1883         } /* end second pass */
1884
1885         /* next alloc is the NEXT state to be allocated */
1886         trie->statecount = next_alloc; 
1887         trie->states = (reg_trie_state *)
1888             PerlMemShared_realloc( trie->states,
1889                                    next_alloc
1890                                    * sizeof(reg_trie_state) );
1891
1892         /* and now dump it out before we compress it */
1893         DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_list(trie, widecharmap,
1894                                                          revcharmap, next_alloc,
1895                                                          depth+1)
1896         );
1897
1898         trie->trans = (reg_trie_trans *)
1899             PerlMemShared_calloc( transcount, sizeof(reg_trie_trans) );
1900         {
1901             U32 state;
1902             U32 tp = 0;
1903             U32 zp = 0;
1904
1905
1906             for( state=1 ; state < next_alloc ; state ++ ) {
1907                 U32 base=0;
1908
1909                 /*
1910                 DEBUG_TRIE_COMPILE_MORE_r(
1911                     PerlIO_printf( Perl_debug_log, "tp: %d zp: %d ",tp,zp)
1912                 );
1913                 */
1914
1915                 if (trie->states[state].trans.list) {
1916                     U16 minid=TRIE_LIST_ITEM( state, 1).forid;
1917                     U16 maxid=minid;
1918                     U16 idx;
1919
1920                     for( idx = 2 ; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
1921                         const U16 forid = TRIE_LIST_ITEM( state, idx).forid;
1922                         if ( forid < minid ) {
1923                             minid=forid;
1924                         } else if ( forid > maxid ) {
1925                             maxid=forid;
1926                         }
1927                     }
1928                     if ( transcount < tp + maxid - minid + 1) {
1929                         transcount *= 2;
1930                         trie->trans = (reg_trie_trans *)
1931                             PerlMemShared_realloc( trie->trans,
1932                                                      transcount
1933                                                      * sizeof(reg_trie_trans) );
1934                         Zero( trie->trans + (transcount / 2), transcount / 2 , reg_trie_trans );
1935                     }
1936                     base = trie->uniquecharcount + tp - minid;
1937                     if ( maxid == minid ) {
1938                         U32 set = 0;
1939                         for ( ; zp < tp ; zp++ ) {
1940                             if ( ! trie->trans[ zp ].next ) {
1941                                 base = trie->uniquecharcount + zp - minid;
1942                                 trie->trans[ zp ].next = TRIE_LIST_ITEM( state, 1).newstate;
1943                                 trie->trans[ zp ].check = state;
1944                                 set = 1;
1945                                 break;
1946                             }
1947                         }
1948                         if ( !set ) {
1949                             trie->trans[ tp ].next = TRIE_LIST_ITEM( state, 1).newstate;
1950                             trie->trans[ tp ].check = state;
1951                             tp++;
1952                             zp = tp;
1953                         }
1954                     } else {
1955                         for ( idx=1; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
1956                             const U32 tid = base -  trie->uniquecharcount + TRIE_LIST_ITEM( state, idx ).forid;
1957                             trie->trans[ tid ].next = TRIE_LIST_ITEM( state, idx ).newstate;
1958                             trie->trans[ tid ].check = state;
1959                         }
1960                         tp += ( maxid - minid + 1 );
1961                     }
1962                     Safefree(trie->states[ state ].trans.list);
1963                 }
1964                 /*
1965                 DEBUG_TRIE_COMPILE_MORE_r(
1966                     PerlIO_printf( Perl_debug_log, " base: %d\n",base);
1967                 );
1968                 */
1969                 trie->states[ state ].trans.base=base;
1970             }
1971             trie->lasttrans = tp + 1;
1972         }
1973     } else {
1974         /*
1975            Second Pass -- Flat Table Representation.
1976
1977            we dont use the 0 slot of either trans[] or states[] so we add 1 to each.
1978            We know that we will need Charcount+1 trans at most to store the data
1979            (one row per char at worst case) So we preallocate both structures
1980            assuming worst case.
1981
1982            We then construct the trie using only the .next slots of the entry
1983            structs.
1984
1985            We use the .check field of the first entry of the node temporarily to
1986            make compression both faster and easier by keeping track of how many non
1987            zero fields are in the node.
1988
1989            Since trans are numbered from 1 any 0 pointer in the table is a FAIL
1990            transition.
1991
1992            There are two terms at use here: state as a TRIE_NODEIDX() which is a
1993            number representing the first entry of the node, and state as a
1994            TRIE_NODENUM() which is the trans number. state 1 is TRIE_NODEIDX(1) and
1995            TRIE_NODENUM(1), state 2 is TRIE_NODEIDX(2) and TRIE_NODENUM(3) if there
1996            are 2 entrys per node. eg:
1997
1998              A B       A B
1999           1. 2 4    1. 3 7
2000           2. 0 3    3. 0 5
2001           3. 0 0    5. 0 0
2002           4. 0 0    7. 0 0
2003
2004            The table is internally in the right hand, idx form. However as we also
2005            have to deal with the states array which is indexed by nodenum we have to
2006            use TRIE_NODENUM() to convert.
2007
2008         */
2009         DEBUG_TRIE_COMPILE_MORE_r( PerlIO_printf( Perl_debug_log, 
2010             "%*sCompiling trie using table compiler\n",
2011             (int)depth * 2 + 2, ""));
2012
2013         trie->trans = (reg_trie_trans *)
2014             PerlMemShared_calloc( ( TRIE_CHARCOUNT(trie) + 1 )
2015                                   * trie->uniquecharcount + 1,
2016                                   sizeof(reg_trie_trans) );
2017         trie->states = (reg_trie_state *)
2018             PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
2019                                   sizeof(reg_trie_state) );
2020         next_alloc = trie->uniquecharcount + 1;
2021
2022
2023         for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
2024
2025             regnode *noper   = NEXTOPER( cur );
2026             const U8 *uc     = (U8*)STRING( noper );
2027             const U8 *e      = uc + STR_LEN( noper );
2028
2029             U32 state        = 1;         /* required init */
2030
2031             U16 charid       = 0;         /* sanity init */
2032             U32 accept_state = 0;         /* sanity init */
2033             U8 *scan         = (U8*)NULL; /* sanity init */
2034
2035             STRLEN foldlen   = 0;         /* required init */
2036             U32 wordlen      = 0;         /* required init */
2037             STRLEN skiplen   = 0;
2038             U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
2039
2040             if (OP(noper) == NOTHING) {
2041                 regnode *noper_next= regnext(noper);
2042                 if (noper_next != tail && OP(noper_next) == flags) {
2043                     noper = noper_next;
2044                     uc= (U8*)STRING(noper);
2045                     e= uc + STR_LEN(noper);
2046                 }
2047             }
2048
2049             if ( OP(noper) != NOTHING ) {
2050                 for ( ; uc < e ; uc += len ) {
2051
2052                     TRIE_READ_CHAR;
2053
2054                     if ( uvc < 256 ) {
2055                         charid = trie->charmap[ uvc ];
2056                     } else {
2057                         SV* const * const svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 0);
2058                         charid = svpp ? (U16)SvIV(*svpp) : 0;
2059                     }
2060                     if ( charid ) {
2061                         charid--;
2062                         if ( !trie->trans[ state + charid ].next ) {
2063                             trie->trans[ state + charid ].next = next_alloc;
2064                             trie->trans[ state ].check++;
2065                             prev_states[TRIE_NODENUM(next_alloc)]
2066                                     = TRIE_NODENUM(state);
2067                             next_alloc += trie->uniquecharcount;
2068                         }
2069                         state = trie->trans[ state + charid ].next;
2070                     } else {
2071                         Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %"IVdf, uvc );
2072                     }
2073                     /* charid is now 0 if we dont know the char read, or nonzero if we do */
2074                 }
2075             }
2076             accept_state = TRIE_NODENUM( state );
2077             TRIE_HANDLE_WORD(accept_state);
2078
2079         } /* end second pass */
2080
2081         /* and now dump it out before we compress it */
2082         DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_table(trie, widecharmap,
2083                                                           revcharmap,
2084                                                           next_alloc, depth+1));
2085
2086         {
2087         /*
2088            * Inplace compress the table.*
2089
2090            For sparse data sets the table constructed by the trie algorithm will
2091            be mostly 0/FAIL transitions or to put it another way mostly empty.
2092            (Note that leaf nodes will not contain any transitions.)
2093
2094            This algorithm compresses the tables by eliminating most such
2095            transitions, at the cost of a modest bit of extra work during lookup:
2096
2097            - Each states[] entry contains a .base field which indicates the
2098            index in the state[] array wheres its transition data is stored.
2099
2100            - If .base is 0 there are no valid transitions from that node.
2101
2102            - If .base is nonzero then charid is added to it to find an entry in
2103            the trans array.
2104
2105            -If trans[states[state].base+charid].check!=state then the
2106            transition is taken to be a 0/Fail transition. Thus if there are fail
2107            transitions at the front of the node then the .base offset will point
2108            somewhere inside the previous nodes data (or maybe even into a node
2109            even earlier), but the .check field determines if the transition is
2110            valid.
2111
2112            XXX - wrong maybe?
2113            The following process inplace converts the table to the compressed
2114            table: We first do not compress the root node 1,and mark all its
2115            .check pointers as 1 and set its .base pointer as 1 as well. This
2116            allows us to do a DFA construction from the compressed table later,
2117            and ensures that any .base pointers we calculate later are greater
2118            than 0.
2119
2120            - We set 'pos' to indicate the first entry of the second node.
2121
2122            - We then iterate over the columns of the node, finding the first and
2123            last used entry at l and m. We then copy l..m into pos..(pos+m-l),
2124            and set the .check pointers accordingly, and advance pos
2125            appropriately and repreat for the next node. Note that when we copy
2126            the next pointers we have to convert them from the original
2127            NODEIDX form to NODENUM form as the former is not valid post
2128            compression.
2129
2130            - If a node has no transitions used we mark its base as 0 and do not
2131            advance the pos pointer.
2132
2133            - If a node only has one transition we use a second pointer into the
2134            structure to fill in allocated fail transitions from other states.
2135            This pointer is independent of the main pointer and scans forward
2136            looking for null transitions that are allocated to a state. When it
2137            finds one it writes the single transition into the "hole".  If the
2138            pointer doesnt find one the single transition is appended as normal.
2139
2140            - Once compressed we can Renew/realloc the structures to release the
2141            excess space.
2142
2143            See "Table-Compression Methods" in sec 3.9 of the Red Dragon,
2144            specifically Fig 3.47 and the associated pseudocode.
2145
2146            demq
2147         */
2148         const U32 laststate = TRIE_NODENUM( next_alloc );
2149         U32 state, charid;
2150         U32 pos = 0, zp=0;
2151         trie->statecount = laststate;
2152
2153         for ( state = 1 ; state < laststate ; state++ ) {
2154             U8 flag = 0;
2155             const U32 stateidx = TRIE_NODEIDX( state );
2156             const U32 o_used = trie->trans[ stateidx ].check;
2157             U32 used = trie->trans[ stateidx ].check;
2158             trie->trans[ stateidx ].check = 0;
2159
2160             for ( charid = 0 ; used && charid < trie->uniquecharcount ; charid++ ) {
2161                 if ( flag || trie->trans[ stateidx + charid ].next ) {
2162                     if ( trie->trans[ stateidx + charid ].next ) {
2163                         if (o_used == 1) {
2164                             for ( ; zp < pos ; zp++ ) {
2165                                 if ( ! trie->trans[ zp ].next ) {
2166                                     break;
2167                                 }
2168                             }
2169                             trie->states[ state ].trans.base = zp + trie->uniquecharcount - charid ;
2170                             trie->trans[ zp ].next = SAFE_TRIE_NODENUM( trie->trans[ stateidx + charid ].next );
2171                             trie->trans[ zp ].check = state;
2172                             if ( ++zp > pos ) pos = zp;
2173                             break;
2174                         }
2175                         used--;
2176                     }
2177                     if ( !flag ) {
2178                         flag = 1;
2179                         trie->states[ state ].trans.base = pos + trie->uniquecharcount - charid ;
2180                     }
2181                     trie->trans[ pos ].next = SAFE_TRIE_NODENUM( trie->trans[ stateidx + charid ].next );
2182                     trie->trans[ pos ].check = state;
2183                     pos++;
2184                 }
2185             }
2186         }
2187         trie->lasttrans = pos + 1;
2188         trie->states = (reg_trie_state *)
2189             PerlMemShared_realloc( trie->states, laststate
2190                                    * sizeof(reg_trie_state) );
2191         DEBUG_TRIE_COMPILE_MORE_r(
2192                 PerlIO_printf( Perl_debug_log,
2193                     "%*sAlloc: %d Orig: %"IVdf" elements, Final:%"IVdf". Savings of %%%5.2f\n",
2194                     (int)depth * 2 + 2,"",
2195                     (int)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1 ),
2196                     (IV)next_alloc,
2197                     (IV)pos,
2198                     ( ( next_alloc - pos ) * 100 ) / (double)next_alloc );
2199             );
2200
2201         } /* end table compress */
2202     }
2203     DEBUG_TRIE_COMPILE_MORE_r(
2204             PerlIO_printf(Perl_debug_log, "%*sStatecount:%"UVxf" Lasttrans:%"UVxf"\n",
2205                 (int)depth * 2 + 2, "",
2206                 (UV)trie->statecount,
2207                 (UV)trie->lasttrans)
2208     );
2209     /* resize the trans array to remove unused space */
2210     trie->trans = (reg_trie_trans *)
2211         PerlMemShared_realloc( trie->trans, trie->lasttrans
2212                                * sizeof(reg_trie_trans) );
2213
2214     {   /* Modify the program and insert the new TRIE node */ 
2215         U8 nodetype =(U8)(flags & 0xFF);
2216         char *str=NULL;
2217         
2218 #ifdef DEBUGGING
2219         regnode *optimize = NULL;
2220 #ifdef RE_TRACK_PATTERN_OFFSETS
2221
2222         U32 mjd_offset = 0;
2223         U32 mjd_nodelen = 0;
2224 #endif /* RE_TRACK_PATTERN_OFFSETS */
2225 #endif /* DEBUGGING */
2226         /*
2227            This means we convert either the first branch or the first Exact,
2228            depending on whether the thing following (in 'last') is a branch
2229            or not and whther first is the startbranch (ie is it a sub part of
2230            the alternation or is it the whole thing.)
2231            Assuming its a sub part we convert the EXACT otherwise we convert
2232            the whole branch sequence, including the first.
2233          */
2234         /* Find the node we are going to overwrite */
2235         if ( first != startbranch || OP( last ) == BRANCH ) {
2236             /* branch sub-chain */
2237             NEXT_OFF( first ) = (U16)(last - first);
2238 #ifdef RE_TRACK_PATTERN_OFFSETS
2239             DEBUG_r({
2240                 mjd_offset= Node_Offset((convert));
2241                 mjd_nodelen= Node_Length((convert));
2242             });
2243 #endif
2244             /* whole branch chain */
2245         }
2246 #ifdef RE_TRACK_PATTERN_OFFSETS
2247         else {
2248             DEBUG_r({
2249                 const  regnode *nop = NEXTOPER( convert );
2250                 mjd_offset= Node_Offset((nop));
2251                 mjd_nodelen= Node_Length((nop));
2252             });
2253         }
2254         DEBUG_OPTIMISE_r(
2255             PerlIO_printf(Perl_debug_log, "%*sMJD offset:%"UVuf" MJD length:%"UVuf"\n",
2256                 (int)depth * 2 + 2, "",
2257                 (UV)mjd_offset, (UV)mjd_nodelen)
2258         );
2259 #endif
2260         /* But first we check to see if there is a common prefix we can 
2261            split out as an EXACT and put in front of the TRIE node.  */
2262         trie->startstate= 1;
2263         if ( trie->bitmap && !widecharmap && !trie->jump  ) {
2264             U32 state;
2265             for ( state = 1 ; state < trie->statecount-1 ; state++ ) {
2266                 U32 ofs = 0;
2267                 I32 idx = -1;
2268                 U32 count = 0;
2269                 const U32 base = trie->states[ state ].trans.base;
2270
2271                 if ( trie->states[state].wordnum )
2272                         count = 1;
2273
2274                 for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
2275                     if ( ( base + ofs >= trie->uniquecharcount ) &&
2276                          ( base + ofs - trie->uniquecharcount < trie->lasttrans ) &&
2277                          trie->trans[ base + ofs - trie->uniquecharcount ].check == state )
2278                     {
2279                         if ( ++count > 1 ) {
2280                             SV **tmp = av_fetch( revcharmap, ofs, 0);
2281                             const U8 *ch = (U8*)SvPV_nolen_const( *tmp );
2282                             if ( state == 1 ) break;
2283                             if ( count == 2 ) {
2284                                 Zero(trie->bitmap, ANYOF_BITMAP_SIZE, char);
2285                                 DEBUG_OPTIMISE_r(
2286                                     PerlIO_printf(Perl_debug_log,
2287                                         "%*sNew Start State=%"UVuf" Class: [",
2288                                         (int)depth * 2 + 2, "",
2289                                         (UV)state));
2290                                 if (idx >= 0) {
2291                                     SV ** const tmp = av_fetch( revcharmap, idx, 0);
2292                                     const U8 * const ch = (U8*)SvPV_nolen_const( *tmp );
2293
2294                                     TRIE_BITMAP_SET(trie,*ch);
2295                                     if ( folder )
2296                                         TRIE_BITMAP_SET(trie, folder[ *ch ]);
2297                                     DEBUG_OPTIMISE_r(
2298                                         PerlIO_printf(Perl_debug_log, "%s", (char*)ch)
2299                                     );
2300                                 }
2301                             }
2302                             TRIE_BITMAP_SET(trie,*ch);
2303                             if ( folder )
2304                                 TRIE_BITMAP_SET(trie,folder[ *ch ]);
2305                             DEBUG_OPTIMISE_r(PerlIO_printf( Perl_debug_log,"%s", ch));
2306                         }
2307                         idx = ofs;
2308                     }
2309                 }
2310                 if ( count == 1 ) {
2311                     SV **tmp = av_fetch( revcharmap, idx, 0);
2312                     STRLEN len;
2313                     char *ch = SvPV( *tmp, len );
2314                     DEBUG_OPTIMISE_r({
2315                         SV *sv=sv_newmortal();
2316                         PerlIO_printf( Perl_debug_log,
2317                             "%*sPrefix State: %"UVuf" Idx:%"UVuf" Char='%s'\n",
2318                             (int)depth * 2 + 2, "",
2319                             (UV)state, (UV)idx, 
2320                             pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), 6, 
2321                                 PL_colors[0], PL_colors[1],
2322                                 (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
2323                                 PERL_PV_ESCAPE_FIRSTCHAR 
2324                             )
2325                         );
2326                     });
2327                     if ( state==1 ) {
2328                         OP( convert ) = nodetype;
2329                         str=STRING(convert);
2330                         STR_LEN(convert)=0;
2331                     }
2332                     STR_LEN(convert) += len;
2333                     while (len--)
2334                         *str++ = *ch++;
2335                 } else {
2336 #ifdef DEBUGGING            
2337                     if (state>1)
2338                         DEBUG_OPTIMISE_r(PerlIO_printf( Perl_debug_log,"]\n"));
2339 #endif
2340                     break;
2341                 }
2342             }
2343             trie->prefixlen = (state-1);
2344             if (str) {
2345                 regnode *n = convert+NODE_SZ_STR(convert);
2346                 NEXT_OFF(convert) = NODE_SZ_STR(convert);
2347                 trie->startstate = state;
2348                 trie->minlen -= (state - 1);
2349                 trie->maxlen -= (state - 1);
2350 #ifdef DEBUGGING
2351                /* At least the UNICOS C compiler choked on this
2352                 * being argument to DEBUG_r(), so let's just have
2353                 * it right here. */
2354                if (
2355 #ifdef PERL_EXT_RE_BUILD
2356                    1
2357 #else
2358                    DEBUG_r_TEST
2359 #endif
2360                    ) {
2361                    regnode *fix = convert;
2362                    U32 word = trie->wordcount;
2363                    mjd_nodelen++;
2364                    Set_Node_Offset_Length(convert, mjd_offset, state - 1);
2365                    while( ++fix < n ) {
2366                        Set_Node_Offset_Length(fix, 0, 0);
2367                    }
2368                    while (word--) {
2369                        SV ** const tmp = av_fetch( trie_words, word, 0 );
2370                        if (tmp) {
2371                            if ( STR_LEN(convert) <= SvCUR(*tmp) )
2372                                sv_chop(*tmp, SvPV_nolen(*tmp) + STR_LEN(convert));
2373                            else
2374                                sv_chop(*tmp, SvPV_nolen(*tmp) + SvCUR(*tmp));
2375                        }
2376                    }
2377                }
2378 #endif
2379                 if (trie->maxlen) {
2380                     convert = n;
2381                 } else {
2382                     NEXT_OFF(convert) = (U16)(tail - convert);
2383                     DEBUG_r(optimize= n);
2384                 }
2385             }
2386         }
2387         if (!jumper) 
2388             jumper = last; 
2389         if ( trie->maxlen ) {
2390             NEXT_OFF( convert ) = (U16)(tail - convert);
2391             ARG_SET( convert, data_slot );
2392             /* Store the offset to the first unabsorbed branch in 
2393                jump[0], which is otherwise unused by the jump logic. 
2394                We use this when dumping a trie and during optimisation. */
2395             if (trie->jump) 
2396                 trie->jump[0] = (U16)(nextbranch - convert);
2397             
2398             /* If the start state is not accepting (meaning there is no empty string/NOTHING)
2399              *   and there is a bitmap
2400              *   and the first "jump target" node we found leaves enough room
2401              * then convert the TRIE node into a TRIEC node, with the bitmap
2402              * embedded inline in the opcode - this is hypothetically faster.
2403              */
2404             if ( !trie->states[trie->startstate].wordnum
2405                  && trie->bitmap
2406                  && ( (char *)jumper - (char *)convert) >= (int)sizeof(struct regnode_charclass) )
2407             {
2408                 OP( convert ) = TRIEC;
2409                 Copy(trie->bitmap, ((struct regnode_charclass *)convert)->bitmap, ANYOF_BITMAP_SIZE, char);
2410                 PerlMemShared_free(trie->bitmap);
2411                 trie->bitmap= NULL;
2412             } else 
2413                 OP( convert ) = TRIE;
2414
2415             /* store the type in the flags */
2416             convert->flags = nodetype;
2417             DEBUG_r({
2418             optimize = convert 
2419                       + NODE_STEP_REGNODE 
2420                       + regarglen[ OP( convert ) ];
2421             });
2422             /* XXX We really should free up the resource in trie now, 
2423                    as we won't use them - (which resources?) dmq */
2424         }
2425         /* needed for dumping*/
2426         DEBUG_r(if (optimize) {
2427             regnode *opt = convert;
2428
2429             while ( ++opt < optimize) {
2430                 Set_Node_Offset_Length(opt,0,0);
2431             }
2432             /* 
2433                 Try to clean up some of the debris left after the 
2434                 optimisation.
2435              */
2436             while( optimize < jumper ) {
2437                 mjd_nodelen += Node_Length((optimize));
2438                 OP( optimize ) = OPTIMIZED;
2439                 Set_Node_Offset_Length(optimize,0,0);
2440                 optimize++;
2441             }
2442             Set_Node_Offset_Length(convert,mjd_offset,mjd_nodelen);
2443         });
2444     } /* end node insert */
2445     REH_CALL_COMP_NODE_HOOK(pRExC_state->rx, convert);
2446
2447     /*  Finish populating the prev field of the wordinfo array.  Walk back
2448      *  from each accept state until we find another accept state, and if
2449      *  so, point the first word's .prev field at the second word. If the
2450      *  second already has a .prev field set, stop now. This will be the
2451      *  case either if we've already processed that word's accept state,
2452      *  or that state had multiple words, and the overspill words were
2453      *  already linked up earlier.
2454      */
2455     {
2456         U16 word;
2457         U32 state;
2458         U16 prev;
2459
2460         for (word=1; word <= trie->wordcount; word++) {
2461             prev = 0;
2462             if (trie->wordinfo[word].prev)
2463                 continue;
2464             state = trie->wordinfo[word].accept;
2465             while (state) {
2466                 state = prev_states[state];
2467                 if (!state)
2468                     break;
2469                 prev = trie->states[state].wordnum;
2470                 if (prev)
2471                     break;
2472             }
2473             trie->wordinfo[word].prev = prev;
2474         }
2475         Safefree(prev_states);
2476     }
2477
2478
2479     /* and now dump out the compressed format */
2480     DEBUG_TRIE_COMPILE_r(dump_trie(trie, widecharmap, revcharmap, depth+1));
2481
2482     RExC_rxi->data->data[ data_slot + 1 ] = (void*)widecharmap;
2483 #ifdef DEBUGGING
2484     RExC_rxi->data->data[ data_slot + TRIE_WORDS_OFFSET ] = (void*)trie_words;
2485     RExC_rxi->data->data[ data_slot + 3 ] = (void*)revcharmap;
2486 #else
2487     SvREFCNT_dec_NN(revcharmap);
2488 #endif
2489     return trie->jump 
2490            ? MADE_JUMP_TRIE 
2491            : trie->startstate>1 
2492              ? MADE_EXACT_TRIE 
2493              : MADE_TRIE;
2494 }
2495
2496 STATIC void
2497 S_make_trie_failtable(pTHX_ RExC_state_t *pRExC_state, regnode *source,  regnode *stclass, U32 depth)
2498 {
2499 /* The Trie is constructed and compressed now so we can build a fail array if it's needed
2500
2501    This is basically the Aho-Corasick algorithm. Its from exercise 3.31 and 3.32 in the
2502    "Red Dragon" -- Compilers, principles, techniques, and tools. Aho, Sethi, Ullman 1985/88
2503    ISBN 0-201-10088-6
2504
2505    We find the fail state for each state in the trie, this state is the longest proper
2506    suffix of the current state's 'word' that is also a proper prefix of another word in our
2507    trie. State 1 represents the word '' and is thus the default fail state. This allows
2508    the DFA not to have to restart after its tried and failed a word at a given point, it
2509    simply continues as though it had been matching the other word in the first place.
2510    Consider
2511       'abcdgu'=~/abcdefg|cdgu/
2512    When we get to 'd' we are still matching the first word, we would encounter 'g' which would
2513    fail, which would bring us to the state representing 'd' in the second word where we would
2514    try 'g' and succeed, proceeding to match 'cdgu'.
2515  */
2516  /* add a fail transition */
2517     const U32 trie_offset = ARG(source);
2518     reg_trie_data *trie=(reg_trie_data *)RExC_rxi->data->data[trie_offset];
2519     U32 *q;
2520     const U32 ucharcount = trie->uniquecharcount;
2521     const U32 numstates = trie->statecount;
2522     const U32 ubound = trie->lasttrans + ucharcount;
2523     U32 q_read = 0;
2524     U32 q_write = 0;
2525     U32 charid;
2526     U32 base = trie->states[ 1 ].trans.base;
2527     U32 *fail;
2528     reg_ac_data *aho;
2529     const U32 data_slot = add_data( pRExC_state, 1, "T" );
2530     GET_RE_DEBUG_FLAGS_DECL;
2531
2532     PERL_ARGS_ASSERT_MAKE_TRIE_FAILTABLE;
2533 #ifndef DEBUGGING
2534     PERL_UNUSED_ARG(depth);
2535 #endif
2536
2537
2538     ARG_SET( stclass, data_slot );
2539     aho = (reg_ac_data *) PerlMemShared_calloc( 1, sizeof(reg_ac_data) );
2540     RExC_rxi->data->data[ data_slot ] = (void*)aho;
2541     aho->trie=trie_offset;
2542     aho->states=(reg_trie_state *)PerlMemShared_malloc( numstates * sizeof(reg_trie_state) );
2543     Copy( trie->states, aho->states, numstates, reg_trie_state );
2544     Newxz( q, numstates, U32);
2545     aho->fail = (U32 *) PerlMemShared_calloc( numstates, sizeof(U32) );
2546     aho->refcount = 1;
2547     fail = aho->fail;
2548     /* initialize fail[0..1] to be 1 so that we always have
2549        a valid final fail state */
2550     fail[ 0 ] = fail[ 1 ] = 1;
2551
2552     for ( charid = 0; charid < ucharcount ; charid++ ) {
2553         const U32 newstate = TRIE_TRANS_STATE( 1, base, ucharcount, charid, 0 );
2554         if ( newstate ) {
2555             q[ q_write ] = newstate;
2556             /* set to point at the root */
2557             fail[ q[ q_write++ ] ]=1;
2558         }
2559     }
2560     while ( q_read < q_write) {
2561         const U32 cur = q[ q_read++ % numstates ];
2562         base = trie->states[ cur ].trans.base;
2563
2564         for ( charid = 0 ; charid < ucharcount ; charid++ ) {
2565             const U32 ch_state = TRIE_TRANS_STATE( cur, base, ucharcount, charid, 1 );
2566             if (ch_state) {
2567                 U32 fail_state = cur;
2568                 U32 fail_base;
2569                 do {
2570                     fail_state = fail[ fail_state ];
2571                     fail_base = aho->states[ fail_state ].trans.base;
2572                 } while ( !TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 ) );
2573
2574                 fail_state = TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 );
2575                 fail[ ch_state ] = fail_state;
2576                 if ( !aho->states[ ch_state ].wordnum && aho->states[ fail_state ].wordnum )
2577                 {
2578                         aho->states[ ch_state ].wordnum =  aho->states[ fail_state ].wordnum;
2579                 }
2580                 q[ q_write++ % numstates] = ch_state;
2581             }
2582         }
2583     }
2584     /* restore fail[0..1] to 0 so that we "fall out" of the AC loop
2585        when we fail in state 1, this allows us to use the
2586        charclass scan to find a valid start char. This is based on the principle
2587        that theres a good chance the string being searched contains lots of stuff
2588        that cant be a start char.
2589      */
2590     fail[ 0 ] = fail[ 1 ] = 0;
2591     DEBUG_TRIE_COMPILE_r({
2592         PerlIO_printf(Perl_debug_log,
2593                       "%*sStclass Failtable (%"UVuf" states): 0", 
2594                       (int)(depth * 2), "", (UV)numstates
2595         );
2596         for( q_read=1; q_read<numstates; q_read++ ) {
2597             PerlIO_printf(Perl_debug_log, ", %"UVuf, (UV)fail[q_read]);
2598         }
2599         PerlIO_printf(Perl_debug_log, "\n");
2600     });
2601     Safefree(q);
2602     /*RExC_seen |= REG_SEEN_TRIEDFA;*/
2603 }
2604
2605
2606 /*
2607  * There are strange code-generation bugs caused on sparc64 by gcc-2.95.2.
2608  * These need to be revisited when a newer toolchain becomes available.
2609  */
2610 #if defined(__sparc64__) && defined(__GNUC__)
2611 #   if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 96)
2612 #       undef  SPARC64_GCC_WORKAROUND
2613 #       define SPARC64_GCC_WORKAROUND 1
2614 #   endif
2615 #endif
2616
2617 #define DEBUG_PEEP(str,scan,depth) \
2618     DEBUG_OPTIMISE_r({if (scan){ \
2619        SV * const mysv=sv_newmortal(); \
2620        regnode *Next = regnext(scan); \
2621        regprop(RExC_rx, mysv, scan); \
2622        PerlIO_printf(Perl_debug_log, "%*s" str ">%3d: %s (%d)\n", \
2623        (int)depth*2, "", REG_NODE_NUM(scan), SvPV_nolen_const(mysv),\
2624        Next ? (REG_NODE_NUM(Next)) : 0 ); \
2625    }});
2626
2627
2628 /* The below joins as many adjacent EXACTish nodes as possible into a single
2629  * one.  The regop may be changed if the node(s) contain certain sequences that
2630  * require special handling.  The joining is only done if:
2631  * 1) there is room in the current conglomerated node to entirely contain the
2632  *    next one.
2633  * 2) they are the exact same node type
2634  *
2635  * The adjacent nodes actually may be separated by NOTHING-kind nodes, and
2636  * these get optimized out
2637  *
2638  * If a node is to match under /i (folded), the number of characters it matches
2639  * can be different than its character length if it contains a multi-character
2640  * fold.  *min_subtract is set to the total delta of the input nodes.
2641  *
2642  * And *has_exactf_sharp_s is set to indicate whether or not the node is EXACTF
2643  * and contains LATIN SMALL LETTER SHARP S
2644  *
2645  * This is as good a place as any to discuss the design of handling these
2646  * multi-character fold sequences.  It's been wrong in Perl for a very long
2647  * time.  There are three code points in Unicode whose multi-character folds
2648  * were long ago discovered to mess things up.  The previous designs for
2649  * dealing with these involved assigning a special node for them.  This
2650  * approach doesn't work, as evidenced by this example:
2651  *      "\xDFs" =~ /s\xDF/ui    # Used to fail before these patches
2652  * Both these fold to "sss", but if the pattern is parsed to create a node that
2653  * would match just the \xDF, it won't be able to handle the case where a
2654  * successful match would have to cross the node's boundary.  The new approach
2655  * that hopefully generally solves the problem generates an EXACTFU_SS node
2656  * that is "sss".
2657  *
2658  * It turns out that there are problems with all multi-character folds, and not
2659  * just these three.  Now the code is general, for all such cases, but the
2660  * three still have some special handling.  The approach taken is:
2661  * 1)   This routine examines each EXACTFish node that could contain multi-
2662  *      character fold sequences.  It returns in *min_subtract how much to
2663  *      subtract from the the actual length of the string to get a real minimum
2664  *      match length; it is 0 if there are no multi-char folds.  This delta is
2665  *      used by the caller to adjust the min length of the match, and the delta
2666  *      between min and max, so that the optimizer doesn't reject these
2667  *      possibilities based on size constraints.
2668  * 2)   Certain of these sequences require special handling by the trie code,
2669  *      so, if found, this code changes the joined node type to special ops:
2670  *      EXACTFU_TRICKYFOLD and EXACTFU_SS.
2671  * 3)   For the sequence involving the Sharp s (\xDF), the node type EXACTFU_SS
2672  *      is used for an EXACTFU node that contains at least one "ss" sequence in
2673  *      it.  For non-UTF-8 patterns and strings, this is the only case where
2674  *      there is a possible fold length change.  That means that a regular
2675  *      EXACTFU node without UTF-8 involvement doesn't have to concern itself
2676  *      with length changes, and so can be processed faster.  regexec.c takes
2677  *      advantage of this.  Generally, an EXACTFish node that is in UTF-8 is
2678  *      pre-folded by regcomp.c.  This saves effort in regex matching.
2679  *      However, the pre-folding isn't done for non-UTF8 patterns because the
2680  *      fold of the MICRO SIGN requires UTF-8, and we don't want to slow things
2681  *      down by forcing the pattern into UTF8 unless necessary.  Also what
2682  *      EXACTF and EXACTFL nodes fold to isn't known until runtime.  The fold
2683  *      possibilities for the non-UTF8 patterns are quite simple, except for
2684  *      the sharp s.  All the ones that don't involve a UTF-8 target string are
2685  *      members of a fold-pair, and arrays are set up for all of them so that
2686  *      the other member of the pair can be found quickly.  Code elsewhere in
2687  *      this file makes sure that in EXACTFU nodes, the sharp s gets folded to
2688  *      'ss', even if the pattern isn't UTF-8.  This avoids the issues
2689  *      described in the next item.
2690  * 4)   A problem remains for the sharp s in EXACTF nodes.  Whether it matches
2691  *      'ss' or not is not knowable at compile time.  It will match iff the
2692  *      target string is in UTF-8, unlike the EXACTFU nodes, where it always
2693  *      matches; and the EXACTFL and EXACTFA nodes where it never does.  Thus
2694  *      it can't be folded to "ss" at compile time, unlike EXACTFU does (as
2695  *      described in item 3).  An assumption that the optimizer part of
2696  *      regexec.c (probably unwittingly) makes is that a character in the
2697  *      pattern corresponds to at most a single character in the target string.
2698  *      (And I do mean character, and not byte here, unlike other parts of the
2699  *      documentation that have never been updated to account for multibyte
2700  *      Unicode.)  This assumption is wrong only in this case, as all other
2701  *      cases are either 1-1 folds when no UTF-8 is involved; or is true by
2702  *      virtue of having this file pre-fold UTF-8 patterns.   I'm
2703  *      reluctant to try to change this assumption, so instead the code punts.
2704  *      This routine examines EXACTF nodes for the sharp s, and returns a
2705  *      boolean indicating whether or not the node is an EXACTF node that
2706  *      contains a sharp s.  When it is true, the caller sets a flag that later
2707  *      causes the optimizer in this file to not set values for the floating
2708  *      and fixed string lengths, and thus avoids the optimizer code in
2709  *      regexec.c that makes the invalid assumption.  Thus, there is no
2710  *      optimization based on string lengths for EXACTF nodes that contain the
2711  *      sharp s.  This only happens for /id rules (which means the pattern
2712  *      isn't in UTF-8).
2713  */
2714
2715 #define JOIN_EXACT(scan,min_subtract,has_exactf_sharp_s, flags) \
2716     if (PL_regkind[OP(scan)] == EXACT) \
2717         join_exact(pRExC_state,(scan),(min_subtract),has_exactf_sharp_s, (flags),NULL,depth+1)
2718
2719 STATIC U32
2720 S_join_exact(pTHX_ RExC_state_t *pRExC_state, regnode *scan, UV *min_subtract, bool *has_exactf_sharp_s, U32 flags,regnode *val, U32 depth) {
2721     /* Merge several consecutive EXACTish nodes into one. */
2722     regnode *n = regnext(scan);
2723     U32 stringok = 1;
2724     regnode *next = scan + NODE_SZ_STR(scan);
2725     U32 merged = 0;
2726     U32 stopnow = 0;
2727 #ifdef DEBUGGING
2728     regnode *stop = scan;
2729     GET_RE_DEBUG_FLAGS_DECL;
2730 #else
2731     PERL_UNUSED_ARG(depth);
2732 #endif
2733
2734     PERL_ARGS_ASSERT_JOIN_EXACT;
2735 #ifndef EXPERIMENTAL_INPLACESCAN
2736     PERL_UNUSED_ARG(flags);
2737     PERL_UNUSED_ARG(val);
2738 #endif
2739     DEBUG_PEEP("join",scan,depth);
2740
2741     /* Look through the subsequent nodes in the chain.  Skip NOTHING, merge
2742      * EXACT ones that are mergeable to the current one. */
2743     while (n
2744            && (PL_regkind[OP(n)] == NOTHING
2745                || (stringok && OP(n) == OP(scan)))
2746            && NEXT_OFF(n)
2747            && NEXT_OFF(scan) + NEXT_OFF(n) < I16_MAX)
2748     {
2749         
2750         if (OP(n) == TAIL || n > next)
2751             stringok = 0;
2752         if (PL_regkind[OP(n)] == NOTHING) {
2753             DEBUG_PEEP("skip:",n,depth);
2754             NEXT_OFF(scan) += NEXT_OFF(n);
2755             next = n + NODE_STEP_REGNODE;
2756 #ifdef DEBUGGING
2757             if (stringok)
2758                 stop = n;
2759 #endif
2760             n = regnext(n);
2761         }
2762         else if (stringok) {
2763             const unsigned int oldl = STR_LEN(scan);
2764             regnode * const nnext = regnext(n);
2765
2766             /* XXX I (khw) kind of doubt that this works on platforms where
2767              * U8_MAX is above 255 because of lots of other assumptions */
2768             /* Don't join if the sum can't fit into a single node */
2769             if (oldl + STR_LEN(n) > U8_MAX)
2770                 break;
2771             
2772             DEBUG_PEEP("merg",n,depth);
2773             merged++;
2774
2775             NEXT_OFF(scan) += NEXT_OFF(n);
2776             STR_LEN(scan) += STR_LEN(n);
2777             next = n + NODE_SZ_STR(n);
2778             /* Now we can overwrite *n : */
2779             Move(STRING(n), STRING(scan) + oldl, STR_LEN(n), char);
2780 #ifdef DEBUGGING
2781             stop = next - 1;
2782 #endif
2783             n = nnext;
2784             if (stopnow) break;
2785         }
2786
2787 #ifdef EXPERIMENTAL_INPLACESCAN
2788         if (flags && !NEXT_OFF(n)) {
2789             DEBUG_PEEP("atch", val, depth);
2790             if (reg_off_by_arg[OP(n)]) {
2791                 ARG_SET(n, val - n);
2792             }
2793             else {
2794                 NEXT_OFF(n) = val - n;
2795             }
2796             stopnow = 1;
2797         }
2798 #endif
2799     }
2800
2801     *min_subtract = 0;
2802     *has_exactf_sharp_s = FALSE;
2803
2804     /* Here, all the adjacent mergeable EXACTish nodes have been merged.  We
2805      * can now analyze for sequences of problematic code points.  (Prior to
2806      * this final joining, sequences could have been split over boundaries, and
2807      * hence missed).  The sequences only happen in folding, hence for any
2808      * non-EXACT EXACTish node */
2809     if (OP(scan) != EXACT) {
2810         const U8 * const s0 = (U8*) STRING(scan);
2811         const U8 * s = s0;
2812         const U8 * const s_end = s0 + STR_LEN(scan);
2813
2814         /* One pass is made over the node's string looking for all the
2815          * possibilities.  to avoid some tests in the loop, there are two main
2816          * cases, for UTF-8 patterns (which can't have EXACTF nodes) and
2817          * non-UTF-8 */
2818         if (UTF) {
2819
2820             /* Examine the string for a multi-character fold sequence.  UTF-8
2821              * patterns have all characters pre-folded by the time this code is
2822              * executed */
2823             while (s < s_end - 1) /* Can stop 1 before the end, as minimum
2824                                      length sequence we are looking for is 2 */
2825             {
2826                 int count = 0;
2827                 int len = is_MULTI_CHAR_FOLD_utf8_safe(s, s_end);
2828                 if (! len) {    /* Not a multi-char fold: get next char */
2829                     s += UTF8SKIP(s);
2830                     continue;
2831                 }
2832
2833                 /* Nodes with 'ss' require special handling, except for EXACTFL
2834                  * and EXACTFA for which there is no multi-char fold to this */
2835                 if (len == 2 && *s == 's' && *(s+1) == 's'
2836                     && OP(scan) != EXACTFL && OP(scan) != EXACTFA)
2837                 {
2838                     count = 2;
2839                     OP(scan) = EXACTFU_SS;
2840                     s += 2;
2841                 }
2842                 else if (len == 6   /* len is the same in both ASCII and EBCDIC for these */
2843                          && (memEQ(s, GREEK_SMALL_LETTER_IOTA_UTF8
2844                                       COMBINING_DIAERESIS_UTF8
2845                                       COMBINING_ACUTE_ACCENT_UTF8,
2846                                    6)
2847                              || memEQ(s, GREEK_SMALL_LETTER_UPSILON_UTF8
2848                                          COMBINING_DIAERESIS_UTF8
2849                                          COMBINING_ACUTE_ACCENT_UTF8,
2850                                      6)))
2851                 {
2852                     count = 3;
2853
2854                     /* These two folds require special handling by trie's, so
2855                      * change the node type to indicate this.  If EXACTFA and
2856                      * EXACTFL were ever to be handled by trie's, this would
2857                      * have to be changed.  If this node has already been
2858                      * changed to EXACTFU_SS in this loop, leave it as is.  (I
2859                      * (khw) think it doesn't matter in regexec.c for UTF
2860                      * patterns, but no need to change it */
2861                     if (OP(scan) == EXACTFU) {
2862                         OP(scan) = EXACTFU_TRICKYFOLD;
2863                     }
2864                     s += 6;
2865                 }
2866                 else { /* Here is a generic multi-char fold. */
2867                     const U8* multi_end  = s + len;
2868
2869                     /* Count how many characters in it.  In the case of /l and
2870                      * /aa, no folds which contain ASCII code points are
2871                      * allowed, so check for those, and skip if found.  (In
2872                      * EXACTFL, no folds are allowed to any Latin1 code point,
2873                      * not just ASCII.  But there aren't any of these
2874                      * currently, nor ever likely, so don't take the time to
2875                      * test for them.  The code that generates the
2876                      * is_MULTI_foo() macros croaks should one actually get put
2877                      * into Unicode .) */
2878                     if (OP(scan) != EXACTFL && OP(scan) != EXACTFA) {
2879                         count = utf8_length(s, multi_end);
2880                         s = multi_end;
2881                     }
2882                     else {
2883                         while (s < multi_end) {
2884                             if (isASCII(*s)) {
2885                                 s++;
2886                                 goto next_iteration;
2887                             }
2888                             else {
2889                                 s += UTF8SKIP(s);
2890                             }
2891                             count++;
2892                         }
2893                     }
2894                 }
2895
2896                 /* The delta is how long the sequence is minus 1 (1 is how long
2897                  * the character that folds to the sequence is) */
2898                 *min_subtract += count - 1;
2899             next_iteration: ;
2900             }
2901         }
2902         else if (OP(scan) != EXACTFL && OP(scan) != EXACTFA) {
2903
2904             /* Here, the pattern is not UTF-8.  Look for the multi-char folds
2905              * that are all ASCII.  As in the above case, EXACTFL and EXACTFA
2906              * nodes can't have multi-char folds to this range (and there are
2907              * no existing ones in the upper latin1 range).  In the EXACTF
2908              * case we look also for the sharp s, which can be in the final
2909              * position.  Otherwise we can stop looking 1 byte earlier because
2910              * have to find at least two characters for a multi-fold */
2911             const U8* upper = (OP(scan) == EXACTF) ? s_end : s_end -1;
2912
2913             /* The below is perhaps overboard, but this allows us to save a
2914              * test each time through the loop at the expense of a mask.  This
2915              * is because on both EBCDIC and ASCII machines, 'S' and 's' differ
2916              * by a single bit.  On ASCII they are 32 apart; on EBCDIC, they
2917              * are 64.  This uses an exclusive 'or' to find that bit and then
2918              * inverts it to form a mask, with just a single 0, in the bit
2919              * position where 'S' and 's' differ. */
2920             const U8 S_or_s_mask = (U8) ~ ('S' ^ 's');
2921             const U8 s_masked = 's' & S_or_s_mask;
2922
2923             while (s < upper) {
2924                 int len = is_MULTI_CHAR_FOLD_latin1_safe(s, s_end);
2925                 if (! len) {    /* Not a multi-char fold. */
2926                     if (*s == LATIN_SMALL_LETTER_SHARP_S && OP(scan) == EXACTF)
2927                     {
2928                         *has_exactf_sharp_s = TRUE;
2929                     }
2930                     s++;
2931                     continue;
2932                 }
2933
2934                 if (len == 2
2935                     && ((*s & S_or_s_mask) == s_masked)
2936                     && ((*(s+1) & S_or_s_mask) == s_masked))
2937                 {
2938
2939                     /* EXACTF nodes need to know that the minimum length
2940                      * changed so that a sharp s in the string can match this
2941                      * ss in the pattern, but they remain EXACTF nodes, as they
2942                      * won't match this unless the target string is is UTF-8,
2943                      * which we don't know until runtime */
2944                     if (OP(scan) != EXACTF) {
2945                         OP(scan) = EXACTFU_SS;
2946                     }
2947                 }
2948
2949                 *min_subtract += len - 1;
2950                 s += len;
2951             }
2952         }
2953     }
2954
2955 #ifdef DEBUGGING
2956     /* Allow dumping but overwriting the collection of skipped
2957      * ops and/or strings with fake optimized ops */
2958     n = scan + NODE_SZ_STR(scan);
2959     while (n <= stop) {
2960         OP(n) = OPTIMIZED;
2961         FLAGS(n) = 0;
2962         NEXT_OFF(n) = 0;
2963         n++;
2964     }
2965 #endif
2966     DEBUG_OPTIMISE_r(if (merged){DEBUG_PEEP("finl",scan,depth)});
2967     return stopnow;
2968 }
2969
2970 /* REx optimizer.  Converts nodes into quicker variants "in place".
2971    Finds fixed substrings.  */
2972
2973 /* Stops at toplevel WHILEM as well as at "last". At end *scanp is set
2974    to the position after last scanned or to NULL. */
2975
2976 #define INIT_AND_WITHP \
2977     assert(!and_withp); \
2978     Newx(and_withp,1,struct regnode_charclass_class); \
2979     SAVEFREEPV(and_withp)
2980
2981 /* this is a chain of data about sub patterns we are processing that
2982    need to be handled separately/specially in study_chunk. Its so
2983    we can simulate recursion without losing state.  */
2984 struct scan_frame;
2985 typedef struct scan_frame {
2986     regnode *last;  /* last node to process in this frame */
2987     regnode *next;  /* next node to process when last is reached */
2988     struct scan_frame *prev; /*previous frame*/
2989     I32 stop; /* what stopparen do we use */
2990 } scan_frame;
2991
2992
2993 #define SCAN_COMMIT(s, data, m) scan_commit(s, data, m, is_inf)
2994
2995 STATIC I32
2996 S_study_chunk(pTHX_ RExC_state_t *pRExC_state, regnode **scanp,
2997                         I32 *minlenp, I32 *deltap,
2998                         regnode *last,
2999                         scan_data_t *data,
3000                         I32 stopparen,
3001                         U8* recursed,
3002                         struct regnode_charclass_class *and_withp,
3003                         U32 flags, U32 depth)
3004                         /* scanp: Start here (read-write). */
3005                         /* deltap: Write maxlen-minlen here. */
3006                         /* last: Stop before this one. */
3007                         /* data: string data about the pattern */
3008                         /* stopparen: treat close N as END */
3009                         /* recursed: which subroutines have we recursed into */
3010                         /* and_withp: Valid if flags & SCF_DO_STCLASS_OR */
3011 {
3012     dVAR;
3013     I32 min = 0;    /* There must be at least this number of characters to match */
3014     I32 pars = 0, code;
3015     regnode *scan = *scanp, *next;
3016     I32 delta = 0;
3017     int is_inf = (flags & SCF_DO_SUBSTR) && (data->flags & SF_IS_INF);
3018     int is_inf_internal = 0;            /* The studied chunk is infinite */
3019     I32 is_par = OP(scan) == OPEN ? ARG(scan) : 0;
3020     scan_data_t data_fake;
3021     SV *re_trie_maxbuff = NULL;
3022     regnode *first_non_open = scan;
3023     I32 stopmin = I32_MAX;
3024     scan_frame *frame = NULL;
3025     GET_RE_DEBUG_FLAGS_DECL;
3026
3027     PERL_ARGS_ASSERT_STUDY_CHUNK;
3028
3029 #ifdef DEBUGGING
3030     StructCopy(&zero_scan_data, &data_fake, scan_data_t);
3031 #endif
3032
3033     if ( depth == 0 ) {
3034         while (first_non_open && OP(first_non_open) == OPEN)
3035             first_non_open=regnext(first_non_open);
3036     }
3037
3038
3039   fake_study_recurse:
3040     while ( scan && OP(scan) != END && scan < last ){
3041         UV min_subtract = 0;    /* How mmany chars to subtract from the minimum
3042                                    node length to get a real minimum (because
3043                                    the folded version may be shorter) */
3044         bool has_exactf_sharp_s = FALSE;
3045         /* Peephole optimizer: */
3046         DEBUG_STUDYDATA("Peep:", data,depth);
3047         DEBUG_PEEP("Peep",scan,depth);
3048
3049         /* Its not clear to khw or hv why this is done here, and not in the
3050          * clauses that deal with EXACT nodes.  khw's guess is that it's
3051          * because of a previous design */
3052         JOIN_EXACT(scan,&min_subtract, &has_exactf_sharp_s, 0);
3053
3054         /* Follow the next-chain of the current node and optimize
3055            away all the NOTHINGs from it.  */
3056         if (OP(scan) != CURLYX) {
3057             const int max = (reg_off_by_arg[OP(scan)]
3058                        ? I32_MAX
3059                        /* I32 may be smaller than U16 on CRAYs! */
3060                        : (I32_MAX < U16_MAX ? I32_MAX : U16_MAX));
3061             int off = (reg_off_by_arg[OP(scan)] ? ARG(scan) : NEXT_OFF(scan));
3062             int noff;
3063             regnode *n = scan;
3064
3065             /* Skip NOTHING and LONGJMP. */
3066             while ((n = regnext(n))
3067                    && ((PL_regkind[OP(n)] == NOTHING && (noff = NEXT_OFF(n)))
3068                        || ((OP(n) == LONGJMP) && (noff = ARG(n))))
3069                    && off + noff < max)
3070                 off += noff;
3071             if (reg_off_by_arg[OP(scan)])
3072                 ARG(scan) = off;
3073             else
3074                 NEXT_OFF(scan) = off;
3075         }
3076
3077
3078
3079         /* The principal pseudo-switch.  Cannot be a switch, since we
3080            look into several different things.  */
3081         if (OP(scan) == BRANCH || OP(scan) == BRANCHJ
3082                    || OP(scan) == IFTHEN) {
3083             next = regnext(scan);
3084             code = OP(scan);
3085             /* demq: the op(next)==code check is to see if we have "branch-branch" AFAICT */
3086
3087             if (OP(next) == code || code == IFTHEN) {
3088                 /* NOTE - There is similar code to this block below for handling
3089                    TRIE nodes on a re-study.  If you change stuff here check there
3090                    too. */
3091                 I32 max1 = 0, min1 = I32_MAX, num = 0;
3092                 struct regnode_charclass_class accum;
3093                 regnode * const startbranch=scan;
3094
3095                 if (flags & SCF_DO_SUBSTR)
3096                     SCAN_COMMIT(pRExC_state, data, minlenp); /* Cannot merge strings after this. */
3097                 if (flags & SCF_DO_STCLASS)
3098                     cl_init_zero(pRExC_state, &accum);
3099
3100                 while (OP(scan) == code) {
3101                     I32 deltanext, minnext, f = 0, fake;
3102                     struct regnode_charclass_class this_class;
3103
3104                     num++;
3105                     data_fake.flags = 0;
3106                     if (data) {
3107                         data_fake.whilem_c = data->whilem_c;
3108                         data_fake.last_closep = data->last_closep;
3109                     }
3110                     else
3111                         data_fake.last_closep = &fake;
3112
3113                     data_fake.pos_delta = delta;
3114                     next = regnext(scan);
3115                     scan = NEXTOPER(scan);
3116                     if (code != BRANCH)
3117                         scan = NEXTOPER(scan);
3118                     if (flags & SCF_DO_STCLASS) {
3119                         cl_init(pRExC_state, &this_class);
3120                         data_fake.start_class = &this_class;
3121                         f = SCF_DO_STCLASS_AND;
3122                     }
3123                     if (flags & SCF_WHILEM_VISITED_POS)
3124                         f |= SCF_WHILEM_VISITED_POS;
3125
3126                     /* we suppose the run is continuous, last=next...*/
3127                     minnext = study_chunk(pRExC_state, &scan, minlenp, &deltanext,
3128                                           next, &data_fake,
3129                                           stopparen, recursed, NULL, f,depth+1);
3130                     if (min1 > minnext)
3131                         min1 = minnext;
3132                     if (deltanext == I32_MAX) {
3133                         is_inf = is_inf_internal = 1;
3134                         max1 = I32_MAX;
3135                     } else if (max1 < minnext + deltanext)
3136                         max1 = minnext + deltanext;
3137                     scan = next;
3138                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
3139                         pars++;
3140                     if (data_fake.flags & SCF_SEEN_ACCEPT) {
3141                         if ( stopmin > minnext) 
3142                             stopmin = min + min1;
3143                         flags &= ~SCF_DO_SUBSTR;
3144                         if (data)
3145                             data->flags |= SCF_SEEN_ACCEPT;
3146                     }
3147                     if (data) {
3148                         if (data_fake.flags & SF_HAS_EVAL)
3149                             data->flags |= SF_HAS_EVAL;
3150                         data->whilem_c = data_fake.whilem_c;
3151                     }
3152                     if (flags & SCF_DO_STCLASS)
3153                         cl_or(pRExC_state, &accum, &this_class);
3154                 }
3155                 if (code == IFTHEN && num < 2) /* Empty ELSE branch */
3156                     min1 = 0;
3157                 if (flags & SCF_DO_SUBSTR) {
3158                     data->pos_min += min1;
3159                     if (data->pos_delta >= I32_MAX - (max1 - min1))
3160                         data->pos_delta = I32_MAX;
3161                     else
3162                         data->pos_delta += max1 - min1;
3163                     if (max1 != min1 || is_inf)
3164                         data->longest = &(data->longest_float);
3165                 }
3166                 min += min1;
3167                 if (delta == I32_MAX || I32_MAX - delta - (max1 - min1) < 0)
3168                     delta = I32_MAX;
3169                 else
3170                     delta += max1 - min1;
3171                 if (flags & SCF_DO_STCLASS_OR) {
3172                     cl_or(pRExC_state, data->start_class, &accum);
3173                     if (min1) {
3174                         cl_and(data->start_class, and_withp);
3175                         flags &= ~SCF_DO_STCLASS;
3176                     }
3177                 }
3178                 else if (flags & SCF_DO_STCLASS_AND) {
3179                     if (min1) {
3180                         cl_and(data->start_class, &accum);
3181                         flags &= ~SCF_DO_STCLASS;
3182                     }
3183                     else {
3184                         /* Switch to OR mode: cache the old value of
3185                          * data->start_class */
3186                         INIT_AND_WITHP;
3187                         StructCopy(data->start_class, and_withp,
3188                                    struct regnode_charclass_class);
3189                         flags &= ~SCF_DO_STCLASS_AND;
3190                         StructCopy(&accum, data->start_class,
3191                                    struct regnode_charclass_class);
3192                         flags |= SCF_DO_STCLASS_OR;
3193                         SET_SSC_EOS(data->start_class);
3194                     }
3195                 }
3196
3197                 if (PERL_ENABLE_TRIE_OPTIMISATION && OP( startbranch ) == BRANCH ) {
3198                 /* demq.
3199
3200                    Assuming this was/is a branch we are dealing with: 'scan' now
3201                    points at the item that follows the branch sequence, whatever
3202                    it is. We now start at the beginning of the sequence and look
3203                    for subsequences of
3204
3205                    BRANCH->EXACT=>x1
3206                    BRANCH->EXACT=>x2
3207                    tail
3208
3209                    which would be constructed from a pattern like /A|LIST|OF|WORDS/
3210
3211                    If we can find such a subsequence we need to turn the first
3212                    element into a trie and then add the subsequent branch exact
3213                    strings to the trie.
3214
3215                    We have two cases
3216
3217                      1. patterns where the whole set of branches can be converted. 
3218
3219                      2. patterns where only a subset can be converted.
3220
3221                    In case 1 we can replace the whole set with a single regop
3222                    for the trie. In case 2 we need to keep the start and end
3223                    branches so
3224
3225                      'BRANCH EXACT; BRANCH EXACT; BRANCH X'
3226                      becomes BRANCH TRIE; BRANCH X;
3227
3228                   There is an additional case, that being where there is a 
3229                   common prefix, which gets split out into an EXACT like node
3230                   preceding the TRIE node.
3231
3232                   If x(1..n)==tail then we can do a simple trie, if not we make
3233                   a "jump" trie, such that when we match the appropriate word
3234                   we "jump" to the appropriate tail node. Essentially we turn
3235                   a nested if into a case structure of sorts.
3236
3237                 */
3238
3239                     int made=0;
3240                     if (!re_trie_maxbuff) {
3241                         re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
3242                         if (!SvIOK(re_trie_maxbuff))
3243                             sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
3244                     }
3245                     if ( SvIV(re_trie_maxbuff)>=0  ) {
3246                         regnode *cur;
3247                         regnode *first = (regnode *)NULL;
3248                         regnode *last = (regnode *)NULL;
3249                         regnode *tail = scan;
3250                         U8 trietype = 0;
3251                         U32 count=0;
3252
3253 #ifdef DEBUGGING
3254                         SV * const mysv = sv_newmortal();       /* for dumping */
3255 #endif
3256                         /* var tail is used because there may be a TAIL
3257                            regop in the way. Ie, the exacts will point to the
3258                            thing following the TAIL, but the last branch will
3259                            point at the TAIL. So we advance tail. If we
3260                            have nested (?:) we may have to move through several
3261                            tails.
3262                          */
3263
3264                         while ( OP( tail ) == TAIL ) {
3265                             /* this is the TAIL generated by (?:) */
3266                             tail = regnext( tail );
3267                         }
3268
3269                         
3270                         DEBUG_TRIE_COMPILE_r({
3271                             regprop(RExC_rx, mysv, tail );
3272                             PerlIO_printf( Perl_debug_log, "%*s%s%s\n",
3273                                 (int)depth * 2 + 2, "", 
3274                                 "Looking for TRIE'able sequences. Tail node is: ", 
3275                                 SvPV_nolen_const( mysv )
3276                             );
3277                         });
3278                         
3279                         /*
3280
3281                             Step through the branches
3282                                 cur represents each branch,
3283                                 noper is the first thing to be matched as part of that branch
3284                                 noper_next is the regnext() of that node.
3285
3286                             We normally handle a case like this /FOO[xyz]|BAR[pqr]/
3287                             via a "jump trie" but we also support building with NOJUMPTRIE,
3288                             which restricts the trie logic to structures like /FOO|BAR/.
3289
3290                             If noper is a trieable nodetype then the branch is a possible optimization
3291                             target. If we are building under NOJUMPTRIE then we require that noper_next
3292                             is the same as scan (our current position in the regex program).
3293
3294                             Once we have two or more consecutive such branches we can create a
3295                             trie of the EXACT's contents and stitch it in place into the program.
3296
3297                             If the sequence represents all of the branches in the alternation we
3298                             replace the entire thing with a single TRIE node.
3299
3300                             Otherwise when it is a subsequence we need to stitch it in place and
3301                             replace only the relevant branches. This means the first branch has
3302                             to remain as it is used by the alternation logic, and its next pointer,
3303                             and needs to be repointed at the item on the branch chain following
3304                             the last branch we have optimized away.
3305
3306                             This could be either a BRANCH, in which case the subsequence is internal,
3307                             or it could be the item following the branch sequence in which case the
3308                             subsequence is at the end (which does not necessarily mean the first node
3309                             is the start of the alternation).
3310
3311                             TRIE_TYPE(X) is a define which maps the optype to a trietype.
3312
3313                                 optype          |  trietype
3314                                 ----------------+-----------
3315                                 NOTHING         | NOTHING
3316                                 EXACT           | EXACT
3317                                 EXACTFU         | EXACTFU
3318                                 EXACTFU_SS      | EXACTFU
3319                                 EXACTFU_TRICKYFOLD | EXACTFU
3320                                 EXACTFA         | 0
3321
3322
3323                         */
3324 #define TRIE_TYPE(X) ( ( NOTHING == (X) ) ? NOTHING :   \
3325                        ( EXACT == (X) )   ? EXACT :        \
3326                        ( EXACTFU == (X) || EXACTFU_SS == (X) || EXACTFU_TRICKYFOLD == (X) ) ? EXACTFU :        \
3327                        0 )
3328
3329                         /* dont use tail as the end marker for this traverse */
3330                         for ( cur = startbranch ; cur != scan ; cur = regnext( cur ) ) {
3331                             regnode * const noper = NEXTOPER( cur );
3332                             U8 noper_type = OP( noper );
3333                             U8 noper_trietype = TRIE_TYPE( noper_type );
3334 #if defined(DEBUGGING) || defined(NOJUMPTRIE)
3335                             regnode * const noper_next = regnext( noper );
3336                             U8 noper_next_type = (noper_next && noper_next != tail) ? OP(noper_next) : 0;
3337                             U8 noper_next_trietype = (noper_next && noper_next != tail) ? TRIE_TYPE( noper_next_type ) :0;
3338 #endif
3339
3340                             DEBUG_TRIE_COMPILE_r({
3341                                 regprop(RExC_rx, mysv, cur);
3342                                 PerlIO_printf( Perl_debug_log, "%*s- %s (%d)",
3343                                    (int)depth * 2 + 2,"", SvPV_nolen_const( mysv ), REG_NODE_NUM(cur) );
3344
3345                                 regprop(RExC_rx, mysv, noper);
3346                                 PerlIO_printf( Perl_debug_log, " -> %s",
3347                                     SvPV_nolen_const(mysv));
3348
3349                                 if ( noper_next ) {
3350                                   regprop(RExC_rx, mysv, noper_next );
3351                                   PerlIO_printf( Perl_debug_log,"\t=> %s\t",
3352                                     SvPV_nolen_const(mysv));
3353                                 }
3354                                 PerlIO_printf( Perl_debug_log, "(First==%d,Last==%d,Cur==%d,tt==%s,nt==%s,nnt==%s)\n",
3355                                    REG_NODE_NUM(first), REG_NODE_NUM(last), REG_NODE_NUM(cur),
3356                                    PL_reg_name[trietype], PL_reg_name[noper_trietype], PL_reg_name[noper_next_trietype] 
3357                                 );
3358                             });
3359
3360                             /* Is noper a trieable nodetype that can be merged with the
3361                              * current trie (if there is one)? */
3362                             if ( noper_trietype
3363                                   &&
3364                                   (
3365                                         ( noper_trietype == NOTHING)
3366                                         || ( trietype == NOTHING )
3367                                         || ( trietype == noper_trietype )
3368                                   )
3369 #ifdef NOJUMPTRIE
3370                                   && noper_next == tail
3371 #endif
3372                                   && count < U16_MAX)
3373                             {
3374                                 /* Handle mergable triable node
3375                                  * Either we are the first node in a new trieable sequence,
3376                                  * in which case we do some bookkeeping, otherwise we update
3377                                  * the end pointer. */
3378                                 if ( !first ) {
3379                                     first = cur;
3380                                     if ( noper_trietype == NOTHING ) {
3381 #if !defined(DEBUGGING) && !defined(NOJUMPTRIE)
3382                                         regnode * const noper_next = regnext( noper );
3383                                         U8 noper_next_type = (noper_next && noper_next!=tail) ? OP(noper_next) : 0;
3384                                         U8 noper_next_trietype = noper_next_type ? TRIE_TYPE( noper_next_type ) :0;
3385 #endif
3386
3387                                         if ( noper_next_trietype ) {
3388                                             trietype = noper_next_trietype;
3389                                         } else if (noper_next_type)  {
3390                                             /* a NOTHING regop is 1 regop wide. We need at least two
3391                                              * for a trie so we can't merge this in */
3392                                             first = NULL;
3393                                         }
3394                                     } else {
3395                                         trietype = noper_trietype;
3396                                     }
3397                                 } else {
3398                                     if ( trietype == NOTHING )
3399                                         trietype = noper_trietype;
3400                                     last = cur;
3401                                 }
3402                                 if (first)
3403                                     count++;
3404                             } /* end handle mergable triable node */
3405                             else {
3406                                 /* handle unmergable node -
3407                                  * noper may either be a triable node which can not be tried
3408                                  * together with the current trie, or a non triable node */
3409                                 if ( last ) {
3410                                     /* If last is set and trietype is not NOTHING then we have found
3411                                      * at least two triable branch sequences in a row of a similar
3412                                      * trietype so we can turn them into a trie. If/when we
3413                                      * allow NOTHING to start a trie sequence this condition will be
3414                                      * required, and it isn't expensive so we leave it in for now. */
3415                                     if ( trietype && trietype != NOTHING )
3416                                         make_trie( pRExC_state,
3417                                                 startbranch, first, cur, tail, count,
3418                                                 trietype, depth+1 );
3419                                     last = NULL; /* note: we clear/update first, trietype etc below, so we dont do it here */
3420                                 }
3421                                 if ( noper_trietype
3422 #ifdef NOJUMPTRIE
3423                                      && noper_next == tail
3424 #endif
3425                                 ){
3426                                     /* noper is triable, so we can start a new trie sequence */
3427                                     count = 1;
3428                                     first = cur;
3429                                     trietype = noper_trietype;
3430                                 } else if (first) {
3431                                     /* if we already saw a first but the current node is not triable then we have
3432                                      * to reset the first information. */
3433                                     count = 0;
3434                                     first = NULL;
3435                                     trietype = 0;
3436                                 }
3437                             } /* end handle unmergable node */
3438                         } /* loop over branches */
3439                         DEBUG_TRIE_COMPILE_r({
3440                             regprop(RExC_rx, mysv, cur);
3441                             PerlIO_printf( Perl_debug_log,
3442                               "%*s- %s (%d) <SCAN FINISHED>\n", (int)depth * 2 + 2,
3443                               "", SvPV_nolen_const( mysv ),REG_NODE_NUM(cur));
3444
3445                         });
3446                         if ( last && trietype ) {
3447                             if ( trietype != NOTHING ) {
3448                                 /* the last branch of the sequence was part of a trie,
3449                                  * so we have to construct it here outside of the loop
3450                                  */
3451                                 made= make_trie( pRExC_state, startbranch, first, scan, tail, count, trietype, depth+1 );
3452 #ifdef TRIE_STUDY_OPT
3453                                 if ( ((made == MADE_EXACT_TRIE &&
3454                                      startbranch == first)
3455                                      || ( first_non_open == first )) &&
3456                                      depth==0 ) {
3457                                     flags |= SCF_TRIE_RESTUDY;
3458                                     if ( startbranch == first
3459                                          && scan == tail )
3460                                     {
3461                                         RExC_seen &=~REG_TOP_LEVEL_BRANCHES;
3462                                     }
3463                                 }
3464 #endif
3465                             } else {
3466                                 /* at this point we know whatever we have is a NOTHING sequence/branch
3467                                  * AND if 'startbranch' is 'first' then we can turn the whole thing into a NOTHING
3468                                  */
3469                                 if ( startbranch == first ) {
3470                                     regnode *opt;
3471                                     /* the entire thing is a NOTHING sequence, something like this:
3472                                      * (?:|) So we can turn it into a plain NOTHING op. */
3473                                     DEBUG_TRIE_COMPILE_r({
3474                                         regprop(RExC_rx, mysv, cur);
3475                                         PerlIO_printf( Perl_debug_log,
3476                                           "%*s- %s (%d) <NOTHING BRANCH SEQUENCE>\n", (int)depth * 2 + 2,
3477                                           "", SvPV_nolen_const( mysv ),REG_NODE_NUM(cur));
3478
3479                                     });
3480                                     OP(startbranch)= NOTHING;
3481                                     NEXT_OFF(startbranch)= tail - startbranch;
3482                                     for ( opt= startbranch + 1; opt < tail ; opt++ )
3483                                         OP(opt)= OPTIMIZED;
3484                                 }
3485                             }
3486                         } /* end if ( last) */
3487                     } /* TRIE_MAXBUF is non zero */
3488                     
3489                 } /* do trie */
3490                 
3491             }
3492             else if ( code == BRANCHJ ) {  /* single branch is optimized. */
3493                 scan = NEXTOPER(NEXTOPER(scan));
3494             } else                      /* single branch is optimized. */
3495                 scan = NEXTOPER(scan);
3496             continue;
3497         } else if (OP(scan) == SUSPEND || OP(scan) == GOSUB || OP(scan) == GOSTART) {
3498             scan_frame *newframe = NULL;
3499             I32 paren;
3500             regnode *start;
3501             regnode *end;
3502
3503             if (OP(scan) != SUSPEND) {
3504             /* set the pointer */
3505                 if (OP(scan) == GOSUB) {
3506                     paren = ARG(scan);
3507                     RExC_recurse[ARG2L(scan)] = scan;
3508                     start = RExC_open_parens[paren-1];
3509                     end   = RExC_close_parens[paren-1];
3510                 } else {
3511                     paren = 0;
3512                     start = RExC_rxi->program + 1;
3513                     end   = RExC_opend;
3514                 }
3515                 if (!recursed) {
3516                     Newxz(recursed, (((RExC_npar)>>3) +1), U8);
3517                     SAVEFREEPV(recursed);
3518                 }
3519                 if (!PAREN_TEST(recursed,paren+1)) {
3520                     PAREN_SET(recursed,paren+1);
3521                     Newx(newframe,1,scan_frame);
3522                 } else {
3523                     if (flags & SCF_DO_SUBSTR) {
3524                         SCAN_COMMIT(pRExC_state,data,minlenp);
3525                         data->longest = &(data->longest_float);
3526                     }
3527                     is_inf = is_inf_internal = 1;
3528                     if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
3529                         cl_anything(pRExC_state, data->start_class);
3530                     flags &= ~SCF_DO_STCLASS;
3531                 }
3532             } else {
3533                 Newx(newframe,1,scan_frame);
3534                 paren = stopparen;
3535                 start = scan+2;
3536                 end = regnext(scan);
3537             }
3538             if (newframe) {
3539                 assert(start);
3540                 assert(end);
3541                 SAVEFREEPV(newframe);
3542                 newframe->next = regnext(scan);
3543                 newframe->last = last;
3544                 newframe->stop = stopparen;
3545                 newframe->prev = frame;
3546
3547                 frame = newframe;
3548                 scan =  start;
3549                 stopparen = paren;
3550                 last = end;
3551
3552                 continue;
3553             }
3554         }
3555         else if (OP(scan) == EXACT) {
3556             I32 l = STR_LEN(scan);
3557             UV uc;
3558             if (UTF) {
3559                 const U8 * const s = (U8*)STRING(scan);
3560                 uc = utf8_to_uvchr_buf(s, s + l, NULL);
3561                 l = utf8_length(s, s + l);
3562             } else {
3563                 uc = *((U8*)STRING(scan));
3564             }
3565             min += l;
3566             if (flags & SCF_DO_SUBSTR) { /* Update longest substr. */
3567                 /* The code below prefers earlier match for fixed
3568                    offset, later match for variable offset.  */
3569                 if (data->last_end == -1) { /* Update the start info. */
3570                     data->last_start_min = data->pos_min;
3571                     data->last_start_max = is_inf
3572                         ? I32_MAX : data->pos_min + data->pos_delta;
3573                 }
3574                 sv_catpvn(data->last_found, STRING(scan), STR_LEN(scan));
3575                 if (UTF)
3576                     SvUTF8_on(data->last_found);
3577                 {
3578                     SV * const sv = data->last_found;
3579                     MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
3580                         mg_find(sv, PERL_MAGIC_utf8) : NULL;
3581                     if (mg && mg->mg_len >= 0)
3582                         mg->mg_len += utf8_length((U8*)STRING(scan),
3583                                                   (U8*)STRING(scan)+STR_LEN(scan));
3584                 }
3585                 data->last_end = data->pos_min + l;
3586                 data->pos_min += l; /* As in the first entry. */
3587                 data->flags &= ~SF_BEFORE_EOL;
3588             }
3589             if (flags & SCF_DO_STCLASS_AND) {
3590                 /* Check whether it is compatible with what we know already! */
3591                 int compat = 1;
3592
3593
3594                 /* If compatible, we or it in below.  It is compatible if is
3595                  * in the bitmp and either 1) its bit or its fold is set, or 2)
3596                  * it's for a locale.  Even if there isn't unicode semantics
3597                  * here, at runtime there may be because of matching against a
3598                  * utf8 string, so accept a possible false positive for
3599                  * latin1-range folds */
3600                 if (uc >= 0x100 ||
3601                     (!(data->start_class->flags & ANYOF_LOCALE)
3602                     && !ANYOF_BITMAP_TEST(data->start_class, uc)
3603                     && (!(data->start_class->flags & ANYOF_LOC_FOLD)
3604                         || !ANYOF_BITMAP_TEST(data->start_class, PL_fold_latin1[uc])))
3605                     )
3606                 {
3607                     compat = 0;
3608                 }
3609                 ANYOF_CLASS_ZERO(data->start_class);
3610                 ANYOF_BITMAP_ZERO(data->start_class);
3611                 if (compat)
3612                     ANYOF_BITMAP_SET(data->start_class, uc);
3613                 else if (uc >= 0x100) {
3614                     int i;
3615
3616                     /* Some Unicode code points fold to the Latin1 range; as
3617                      * XXX temporary code, instead of figuring out if this is
3618                      * one, just assume it is and set all the start class bits
3619                      * that could be some such above 255 code point's fold
3620                      * which will generate fals positives.  As the code
3621                      * elsewhere that does compute the fold settles down, it
3622                      * can be extracted out and re-used here */
3623                     for (i = 0; i < 256; i++){
3624                         if (HAS_NONLATIN1_FOLD_CLOSURE(i)) {
3625                             ANYOF_BITMAP_SET(data->start_class, i);
3626                         }
3627                     }
3628                 }
3629                 CLEAR_SSC_EOS(data->start_class);
3630                 if (uc < 0x100)
3631                   data->start_class->flags &= ~ANYOF_UNICODE_ALL;
3632             }
3633             else if (flags & SCF_DO_STCLASS_OR) {
3634                 /* false positive possible if the class is case-folded */
3635                 if (uc < 0x100)
3636                     ANYOF_BITMAP_SET(data->start_class, uc);
3637                 else
3638                     data->start_class->flags |= ANYOF_UNICODE_ALL;
3639                 CLEAR_SSC_EOS(data->start_class);
3640                 cl_and(data->start_class, and_withp);
3641             }
3642             flags &= ~SCF_DO_STCLASS;
3643         }
3644         else if (PL_regkind[OP(scan)] == EXACT) { /* But OP != EXACT! */
3645             I32 l = STR_LEN(scan);
3646             UV uc = *((U8*)STRING(scan));
3647
3648             /* Search for fixed substrings supports EXACT only. */
3649             if (flags & SCF_DO_SUBSTR) {
3650                 assert(data);
3651                 SCAN_COMMIT(pRExC_state, data, minlenp);
3652             }
3653             if (UTF) {
3654                 const U8 * const s = (U8 *)STRING(scan);
3655                 uc = utf8_to_uvchr_buf(s, s + l, NULL);
3656                 l = utf8_length(s, s + l);
3657             }
3658             if (has_exactf_sharp_s) {
3659                 RExC_seen |= REG_SEEN_EXACTF_SHARP_S;
3660             }
3661             min += l - min_subtract;
3662             assert (min >= 0);
3663             delta += min_subtract;
3664             if (flags & SCF_DO_SUBSTR) {
3665                 data->pos_min += l - min_subtract;
3666                 if (data->pos_min < 0) {
3667                     data->pos_min = 0;
3668                 }
3669                 data->pos_delta += min_subtract;
3670                 if (min_subtract) {
3671                     data->longest = &(data->longest_float);
3672                 }
3673             }
3674             if (flags & SCF_DO_STCLASS_AND) {
3675                 /* Check whether it is compatible with what we know already! */
3676                 int compat = 1;
3677                 if (uc >= 0x100 ||
3678                  (!(data->start_class->flags & ANYOF_LOCALE)
3679                   && !ANYOF_BITMAP_TEST(data->start_class, uc)
3680                   && !ANYOF_BITMAP_TEST(data->start_class, PL_fold_latin1[uc])))
3681                 {
3682                     compat = 0;
3683                 }
3684                 ANYOF_CLASS_ZERO(data->start_class);
3685                 ANYOF_BITMAP_ZERO(data->start_class);
3686                 if (compat) {
3687                     ANYOF_BITMAP_SET(data->start_class, uc);
3688                     CLEAR_SSC_EOS(data->start_class);
3689                     if (OP(scan) == EXACTFL) {
3690                         /* XXX This set is probably no longer necessary, and
3691                          * probably wrong as LOCALE now is on in the initial
3692                          * state */
3693                         data->start_class->flags |= ANYOF_LOCALE|ANYOF_LOC_FOLD;
3694                     }
3695                     else {
3696
3697                         /* Also set the other member of the fold pair.  In case
3698                          * that unicode semantics is called for at runtime, use
3699                          * the full latin1 fold.  (Can't do this for locale,
3700                          * because not known until runtime) */
3701                         ANYOF_BITMAP_SET(data->start_class, PL_fold_latin1[uc]);
3702
3703                         /* All other (EXACTFL handled above) folds except under
3704                          * /iaa that include s, S, and sharp_s also may include
3705                          * the others */
3706                         if (OP(scan) != EXACTFA) {
3707                             if (uc == 's' || uc == 'S') {
3708                                 ANYOF_BITMAP_SET(data->start_class,
3709                                                  LATIN_SMALL_LETTER_SHARP_S);
3710                             }
3711                             else if (uc == LATIN_SMALL_LETTER_SHARP_S) {
3712                                 ANYOF_BITMAP_SET(data->start_class, 's');
3713                                 ANYOF_BITMAP_SET(data->start_class, 'S');
3714                             }
3715                         }
3716                     }
3717                 }
3718                 else if (uc >= 0x100) {
3719                     int i;
3720                     for (i = 0; i < 256; i++){
3721                         if (_HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(i)) {
3722                             ANYOF_BITMAP_SET(data->start_class, i);
3723                         }
3724                     }
3725                 }
3726             }
3727             else if (flags & SCF_DO_STCLASS_OR) {
3728                 if (data->start_class->flags & ANYOF_LOC_FOLD) {
3729                     /* false positive possible if the class is case-folded.
3730                        Assume that the locale settings are the same... */
3731                     if (uc < 0x100) {
3732                         ANYOF_BITMAP_SET(data->start_class, uc);
3733                         if (OP(scan) != EXACTFL) {
3734
3735                             /* And set the other member of the fold pair, but
3736                              * can't do that in locale because not known until
3737                              * run-time */
3738                             ANYOF_BITMAP_SET(data->start_class,
3739                                              PL_fold_latin1[uc]);
3740
3741                             /* All folds except under /iaa that include s, S,
3742                              * and sharp_s also may include the others */
3743                             if (OP(scan) != EXACTFA) {
3744                                 if (uc == 's' || uc == 'S') {
3745                                     ANYOF_BITMAP_SET(data->start_class,
3746                                                    LATIN_SMALL_LETTER_SHARP_S);
3747                                 }
3748                                 else if (uc == LATIN_SMALL_LETTER_SHARP_S) {
3749                                     ANYOF_BITMAP_SET(data->start_class, 's');
3750                                     ANYOF_BITMAP_SET(data->start_class, 'S');
3751                                 }
3752                             }
3753                         }
3754                     }
3755                     CLEAR_SSC_EOS(data->start_class);
3756                 }
3757                 cl_and(data->start_class, and_withp);
3758             }
3759             flags &= ~SCF_DO_STCLASS;
3760         }
3761         else if (REGNODE_VARIES(OP(scan))) {
3762             I32 mincount, maxcount, minnext, deltanext, fl = 0;
3763             I32 f = flags, pos_before = 0;
3764             regnode * const oscan = scan;
3765             struct regnode_charclass_class this_class;
3766             struct regnode_charclass_class *oclass = NULL;
3767             I32 next_is_eval = 0;
3768
3769             switch (PL_regkind[OP(scan)]) {
3770             case WHILEM:                /* End of (?:...)* . */
3771                 scan = NEXTOPER(scan);
3772                 goto finish;
3773             case PLUS:
3774                 if (flags & (SCF_DO_SUBSTR | SCF_DO_STCLASS)) {
3775                     next = NEXTOPER(scan);
3776                     if (OP(next) == EXACT || (flags & SCF_DO_STCLASS)) {
3777                         mincount = 1;
3778                         maxcount = REG_INFTY;
3779                         next = regnext(scan);
3780                         scan = NEXTOPER(scan);
3781                         goto do_curly;
3782                     }
3783                 }
3784                 if (flags & SCF_DO_SUBSTR)
3785                     data->pos_min++;
3786                 min++;
3787                 /* Fall through. */
3788             case STAR:
3789                 if (flags & SCF_DO_STCLASS) {
3790                     mincount = 0;
3791                     maxcount = REG_INFTY;
3792                     next = regnext(scan);
3793                     scan = NEXTOPER(scan);
3794                     goto do_curly;
3795                 }
3796                 is_inf = is_inf_internal = 1;
3797                 scan = regnext(scan);
3798                 if (flags & SCF_DO_SUBSTR) {
3799                     SCAN_COMMIT(pRExC_state, data, minlenp); /* Cannot extend fixed substrings */
3800                     data->longest = &(data->longest_float);
3801                 }
3802                 goto optimize_curly_tail;
3803             case CURLY:
3804                 if (stopparen>0 && (OP(scan)==CURLYN || OP(scan)==CURLYM)
3805                     && (scan->flags == stopparen))
3806                 {
3807                     mincount = 1;
3808                     maxcount = 1;
3809                 } else {
3810                     mincount = ARG1(scan);
3811                     maxcount = ARG2(scan);
3812                 }
3813                 next = regnext(scan);
3814                 if (OP(scan) == CURLYX) {
3815                     I32 lp = (data ? *(data->last_closep) : 0);
3816                     scan->flags = ((lp <= (I32)U8_MAX) ? (U8)lp : U8_MAX);
3817                 }
3818                 scan = NEXTOPER(scan) + EXTRA_STEP_2ARGS;
3819                 next_is_eval = (OP(scan) == EVAL);
3820               do_curly:
3821                 if (flags & SCF_DO_SUBSTR) {
3822                     if (mincount == 0) SCAN_COMMIT(pRExC_state,data,minlenp); /* Cannot extend fixed substrings */
3823                     pos_before = data->pos_min;
3824                 }
3825                 if (data) {
3826                     fl = data->flags;
3827                     data->flags &= ~(SF_HAS_PAR|SF_IN_PAR|SF_HAS_EVAL);
3828                     if (is_inf)
3829                         data->flags |= SF_IS_INF;
3830                 }
3831                 if (flags & SCF_DO_STCLASS) {
3832                     cl_init(pRExC_state, &this_class);
3833                     oclass = data->start_class;
3834                     data->start_class = &this_class;
3835                     f |= SCF_DO_STCLASS_AND;
3836                     f &= ~SCF_DO_STCLASS_OR;
3837                 }
3838                 /* Exclude from super-linear cache processing any {n,m}
3839                    regops for which the combination of input pos and regex
3840                    pos is not enough information to determine if a match
3841                    will be possible.
3842
3843                    For example, in the regex /foo(bar\s*){4,8}baz/ with the
3844                    regex pos at the \s*, the prospects for a match depend not
3845                    only on the input position but also on how many (bar\s*)
3846                    repeats into the {4,8} we are. */
3847                if ((mincount > 1) || (maxcount > 1 && maxcount != REG_INFTY))
3848                     f &= ~SCF_WHILEM_VISITED_POS;
3849
3850                 /* This will finish on WHILEM, setting scan, or on NULL: */
3851                 minnext = study_chunk(pRExC_state, &scan, minlenp, &deltanext, 
3852                                       last, data, stopparen, recursed, NULL,
3853                                       (mincount == 0
3854                                         ? (f & ~SCF_DO_SUBSTR) : f),depth+1);
3855
3856                 if (flags & SCF_DO_STCLASS)
3857                     data->start_class = oclass;
3858                 if (mincount == 0 || minnext == 0) {
3859                     if (flags & SCF_DO_STCLASS_OR) {
3860                         cl_or(pRExC_state, data->start_class, &this_class);
3861                     }
3862                     else if (flags & SCF_DO_STCLASS_AND) {
3863                         /* Switch to OR mode: cache the old value of
3864                          * data->start_class */
3865                         INIT_AND_WITHP;
3866                         StructCopy(data->start_class, and_withp,
3867                                    struct regnode_charclass_class);
3868                         flags &= ~SCF_DO_STCLASS_AND;
3869                         StructCopy(&this_class, data->start_class,
3870                                    struct regnode_charclass_class);
3871                         flags |= SCF_DO_STCLASS_OR;
3872                         SET_SSC_EOS(data->start_class);
3873                     }
3874                 } else {                /* Non-zero len */
3875                     if (flags & SCF_DO_STCLASS_OR) {
3876                         cl_or(pRExC_state, data->start_class, &this_class);
3877                         cl_and(data->start_class, and_withp);
3878                     }
3879                     else if (flags & SCF_DO_STCLASS_AND)
3880                         cl_and(data->start_class, &this_class);
3881                     flags &= ~SCF_DO_STCLASS;
3882                 }
3883                 if (!scan)              /* It was not CURLYX, but CURLY. */
3884                     scan = next;
3885                 if ( /* ? quantifier ok, except for (?{ ... }) */
3886                     (next_is_eval || !(mincount == 0 && maxcount == 1))
3887                     && (minnext == 0) && (deltanext == 0)
3888                     && data && !(data->flags & (SF_HAS_PAR|SF_IN_PAR))
3889                     && maxcount <= REG_INFTY/3) /* Complement check for big count */
3890                 {
3891                     /* Fatal warnings may leak the regexp without this: */
3892                     SAVEFREESV(RExC_rx_sv);
3893                     ckWARNreg(RExC_parse,
3894                               "Quantifier unexpected on zero-length expression");
3895                     (void)ReREFCNT_inc(RExC_rx_sv);
3896                 }
3897
3898                 min += minnext * mincount;
3899                 is_inf_internal |= deltanext == I32_MAX
3900                                      || (maxcount == REG_INFTY && minnext + deltanext > 0);
3901                 is_inf |= is_inf_internal;
3902                 if (is_inf)
3903                     delta = I32_MAX;
3904                 else
3905                     delta += (minnext + deltanext) * maxcount - minnext * mincount;
3906
3907                 /* Try powerful optimization CURLYX => CURLYN. */
3908                 if (  OP(oscan) == CURLYX && data
3909                       && data->flags & SF_IN_PAR
3910                       && !(data->flags & SF_HAS_EVAL)
3911                       && !deltanext && minnext == 1 ) {
3912                     /* Try to optimize to CURLYN.  */
3913                     regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS;
3914                     regnode * const nxt1 = nxt;
3915 #ifdef DEBUGGING
3916                     regnode *nxt2;
3917 #endif
3918
3919                     /* Skip open. */
3920                     nxt = regnext(nxt);
3921                     if (!REGNODE_SIMPLE(OP(nxt))
3922                         && !(PL_regkind[OP(nxt)] == EXACT
3923                              && STR_LEN(nxt) == 1))
3924                         goto nogo;
3925 #ifdef DEBUGGING
3926                     nxt2 = nxt;
3927 #endif
3928                     nxt = regnext(nxt);
3929                     if (OP(nxt) != CLOSE)
3930                         goto nogo;
3931                     if (RExC_open_parens) {
3932                         RExC_open_parens[ARG(nxt1)-1]=oscan; /*open->CURLYM*/
3933                         RExC_close_parens[ARG(nxt1)-1]=nxt+2; /*close->while*/
3934                     }
3935                     /* Now we know that nxt2 is the only contents: */
3936                     oscan->flags = (U8)ARG(nxt);
3937                     OP(oscan) = CURLYN;
3938                     OP(nxt1) = NOTHING; /* was OPEN. */
3939
3940 #ifdef DEBUGGING
3941                     OP(nxt1 + 1) = OPTIMIZED; /* was count. */
3942                     NEXT_OFF(nxt1+ 1) = 0; /* just for consistency. */
3943                     NEXT_OFF(nxt2) = 0; /* just for consistency with CURLY. */
3944                     OP(nxt) = OPTIMIZED;        /* was CLOSE. */
3945                     OP(nxt + 1) = OPTIMIZED; /* was count. */
3946                     NEXT_OFF(nxt+ 1) = 0; /* just for consistency. */
3947 #endif
3948                 }
3949               nogo:
3950
3951                 /* Try optimization CURLYX => CURLYM. */
3952                 if (  OP(oscan) == CURLYX && data
3953                       && !(data->flags & SF_HAS_PAR)
3954                       && !(data->flags & SF_HAS_EVAL)
3955                       && !deltanext     /* atom is fixed width */
3956                       && minnext != 0   /* CURLYM can't handle zero width */
3957                       && ! (RExC_seen & REG_SEEN_EXACTF_SHARP_S) /* Nor \xDF */
3958                 ) {
3959                     /* XXXX How to optimize if data == 0? */
3960                     /* Optimize to a simpler form.  */
3961                     regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN */
3962                     regnode *nxt2;
3963
3964                     OP(oscan) = CURLYM;
3965                     while ( (nxt2 = regnext(nxt)) /* skip over embedded stuff*/
3966                             && (OP(nxt2) != WHILEM))
3967                         nxt = nxt2;
3968                     OP(nxt2)  = SUCCEED; /* Whas WHILEM */
3969                     /* Need to optimize away parenths. */
3970                     if ((data->flags & SF_IN_PAR) && OP(nxt) == CLOSE) {
3971                         /* Set the parenth number.  */
3972                         regnode *nxt1 = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN*/
3973
3974                         oscan->flags = (U8)ARG(nxt);
3975                         if (RExC_open_parens) {
3976                             RExC_open_parens[ARG(nxt1)-1]=oscan; /*open->CURLYM*/
3977                             RExC_close_parens[ARG(nxt1)-1]=nxt2+1; /*close->NOTHING*/
3978                         }
3979                         OP(nxt1) = OPTIMIZED;   /* was OPEN. */
3980                         OP(nxt) = OPTIMIZED;    /* was CLOSE. */
3981
3982 #ifdef DEBUGGING
3983                         OP(nxt1 + 1) = OPTIMIZED; /* was count. */
3984                         OP(nxt + 1) = OPTIMIZED; /* was count. */
3985                         NEXT_OFF(nxt1 + 1) = 0; /* just for consistency. */
3986                         NEXT_OFF(nxt + 1) = 0; /* just for consistency. */
3987 #endif
3988 #if 0
3989                         while ( nxt1 && (OP(nxt1) != WHILEM)) {
3990                             regnode *nnxt = regnext(nxt1);
3991                             if (nnxt == nxt) {
3992                                 if (reg_off_by_arg[OP(nxt1)])
3993                                     ARG_SET(nxt1, nxt2 - nxt1);
3994                                 else if (nxt2 - nxt1 < U16_MAX)
3995                                     NEXT_OFF(nxt1) = nxt2 - nxt1;
3996                                 else
3997                                     OP(nxt) = NOTHING;  /* Cannot beautify */
3998                             }
3999                             nxt1 = nnxt;
4000                         }
4001 #endif
4002                         /* Optimize again: */
4003                         study_chunk(pRExC_state, &nxt1, minlenp, &deltanext, nxt,
4004                                     NULL, stopparen, recursed, NULL, 0,depth+1);
4005                     }
4006                     else
4007                         oscan->flags = 0;
4008                 }
4009                 else if ((OP(oscan) == CURLYX)
4010                          && (flags & SCF_WHILEM_VISITED_POS)
4011                          /* See the comment on a similar expression above.
4012                             However, this time it's not a subexpression
4013                             we care about, but the expression itself. */
4014                          && (maxcount == REG_INFTY)
4015                          && data && ++data->whilem_c < 16) {
4016                     /* This stays as CURLYX, we can put the count/of pair. */
4017                     /* Find WHILEM (as in regexec.c) */
4018                     regnode *nxt = oscan + NEXT_OFF(oscan);
4019
4020                     if (OP(PREVOPER(nxt)) == NOTHING) /* LONGJMP */
4021                         nxt += ARG(nxt);
4022                     PREVOPER(nxt)->flags = (U8)(data->whilem_c
4023                         | (RExC_whilem_seen << 4)); /* On WHILEM */
4024                 }
4025                 if (data && fl & (SF_HAS_PAR|SF_IN_PAR))
4026                     pars++;
4027                 if (flags & SCF_DO_SUBSTR) {
4028                     SV *last_str = NULL;
4029                     int counted = mincount != 0;
4030
4031                     if (data->last_end > 0 && mincount != 0) { /* Ends with a string. */
4032 #if defined(SPARC64_GCC_WORKAROUND)
4033                         I32 b = 0;
4034                         STRLEN l = 0;
4035                         const char *s = NULL;
4036                         I32 old = 0;
4037
4038                         if (pos_before >= data->last_start_min)
4039                             b = pos_before;
4040                         else
4041                             b = data->last_start_min;
4042
4043                         l = 0;
4044                         s = SvPV_const(data->last_found, l);
4045                         old = b - data->last_start_min;
4046
4047 #else
4048                         I32 b = pos_before >= data->last_start_min
4049                             ? pos_before : data->last_start_min;
4050                         STRLEN l;
4051                         const char * const s = SvPV_const(data->last_found, l);
4052                         I32 old = b - data->last_start_min;
4053 #endif
4054
4055                         if (UTF)
4056                             old = utf8_hop((U8*)s, old) - (U8*)s;
4057                         l -= old;
4058                         /* Get the added string: */
4059                         last_str = newSVpvn_utf8(s  + old, l, UTF);
4060                         if (deltanext == 0 && pos_before == b) {
4061                             /* What was added is a constant string */
4062                             if (mincount > 1) {
4063                                 SvGROW(last_str, (mincount * l) + 1);
4064                                 repeatcpy(SvPVX(last_str) + l,
4065                                           SvPVX_const(last_str), l, mincount - 1);
4066                                 SvCUR_set(last_str, SvCUR(last_str) * mincount);
4067                                 /* Add additional parts. */
4068                                 SvCUR_set(data->last_found,
4069                                           SvCUR(data->last_found) - l);
4070                                 sv_catsv(data->last_found, last_str);
4071                                 {
4072                                     SV * sv = data->last_found;
4073                                     MAGIC *mg =
4074                                         SvUTF8(sv) && SvMAGICAL(sv) ?
4075                                         mg_find(sv, PERL_MAGIC_utf8) : NULL;
4076                                     if (mg && mg->mg_len >= 0)
4077                                         mg->mg_len += CHR_SVLEN(last_str) - l;
4078                                 }
4079                                 data->last_end += l * (mincount - 1);
4080                             }
4081                         } else {
4082                             /* start offset must point into the last copy */
4083                             data->last_start_min += minnext * (mincount - 1);
4084                             data->last_start_max += is_inf ? I32_MAX
4085                                 : (maxcount - 1) * (minnext + data->pos_delta);
4086                         }
4087                     }
4088                     /* It is counted once already... */
4089                     data->pos_min += minnext * (mincount - counted);
4090 #if 0
4091 PerlIO_printf(Perl_debug_log, "counted=%d deltanext=%d I32_MAX=%d minnext=%d maxcount=%d mincount=%d\n",
4092     counted, deltanext, I32_MAX, minnext, maxcount, mincount);
4093 if (deltanext != I32_MAX)
4094 PerlIO_printf(Perl_debug_log, "LHS=%d RHS=%d\n", -counted * deltanext + (minnext + deltanext) * maxcount - minnext * mincount, I32_MAX - data->pos_delta);
4095 #endif
4096                     if (deltanext == I32_MAX || -counted * deltanext + (minnext + deltanext) * maxcount - minnext * mincount >= I32_MAX - data->pos_delta)
4097                         data->pos_delta = I32_MAX;
4098                     else
4099                         data->pos_delta += - counted * deltanext +
4100                         (minnext + deltanext) * maxcount - minnext * mincount;
4101                     if (mincount != maxcount) {
4102                          /* Cannot extend fixed substrings found inside
4103                             the group.  */
4104                         SCAN_COMMIT(pRExC_state,data,minlenp);
4105                         if (mincount && last_str) {
4106                             SV * const sv = data->last_found;
4107                             MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
4108                                 mg_find(sv, PERL_MAGIC_utf8) : NULL;
4109
4110                             if (mg)
4111                                 mg->mg_len = -1;
4112                             sv_setsv(sv, last_str);
4113                             data->last_end = data->pos_min;
4114                             data->last_start_min =
4115                                 data->pos_min - CHR_SVLEN(last_str);
4116                             data->last_start_max = is_inf
4117                                 ? I32_MAX
4118                                 : data->pos_min + data->pos_delta
4119                                 - CHR_SVLEN(last_str);
4120                         }
4121                         data->longest = &(data->longest_float);
4122                     }
4123                     SvREFCNT_dec(last_str);
4124                 }
4125                 if (data && (fl & SF_HAS_EVAL))
4126                     data->flags |= SF_HAS_EVAL;
4127               optimize_curly_tail:
4128                 if (OP(oscan) != CURLYX) {
4129                     while (PL_regkind[OP(next = regnext(oscan))] == NOTHING
4130                            && NEXT_OFF(next))
4131                         NEXT_OFF(oscan) += NEXT_OFF(next);
4132                 }
4133                 continue;
4134             default:                    /* REF, and CLUMP only? */
4135                 if (flags & SCF_DO_SUBSTR) {
4136                     SCAN_COMMIT(pRExC_state,data,minlenp);      /* Cannot expect anything... */
4137                     data->longest = &(data->longest_float);
4138                 }
4139                 is_inf = is_inf_internal = 1;
4140                 if (flags & SCF_DO_STCLASS_OR)
4141                     cl_anything(pRExC_state, data->start_class);
4142                 flags &= ~SCF_DO_STCLASS;
4143                 break;
4144             }
4145         }
4146         else if (OP(scan) == LNBREAK) {
4147             if (flags & SCF_DO_STCLASS) {
4148                 int value = 0;
4149                 CLEAR_SSC_EOS(data->start_class); /* No match on empty */
4150                 if (flags & SCF_DO_STCLASS_AND) {
4151                     for (value = 0; value < 256; value++)
4152                         if (!is_VERTWS_cp(value))
4153                             ANYOF_BITMAP_CLEAR(data->start_class, value);
4154                 }
4155                 else {
4156                     for (value = 0; value < 256; value++)
4157                         if (is_VERTWS_cp(value))
4158                             ANYOF_BITMAP_SET(data->start_class, value);
4159                 }
4160                 if (flags & SCF_DO_STCLASS_OR)
4161                     cl_and(data->start_class, and_withp);
4162                 flags &= ~SCF_DO_STCLASS;
4163             }
4164             min++;
4165             delta++;    /* Because of the 2 char string cr-lf */
4166             if (flags & SCF_DO_SUBSTR) {
4167                 SCAN_COMMIT(pRExC_state,data,minlenp);  /* Cannot expect anything... */
4168                 data->pos_min += 1;
4169                 data->pos_delta += 1;
4170                 data->longest = &(data->longest_float);
4171             }
4172         }
4173         else if (REGNODE_SIMPLE(OP(scan))) {
4174             int value = 0;
4175
4176             if (flags & SCF_DO_SUBSTR) {
4177                 SCAN_COMMIT(pRExC_state,data,minlenp);
4178                 data->pos_min++;
4179             }
4180             min++;
4181             if (flags & SCF_DO_STCLASS) {
4182                 int loop_max = 256;
4183                 CLEAR_SSC_EOS(data->start_class); /* No match on empty */
4184
4185                 /* Some of the logic below assumes that switching
4186                    locale on will only add false positives. */
4187                 switch (PL_regkind[OP(scan)]) {
4188                     U8 classnum;
4189
4190                 case SANY:
4191                 default:
4192 #ifdef DEBUGGING
4193                    Perl_croak(aTHX_ "panic: unexpected simple REx opcode %d", OP(scan));
4194 #endif
4195                  do_default:
4196                     if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
4197                         cl_anything(pRExC_state, data->start_class);
4198                     break;
4199                 case REG_ANY:
4200                     if (OP(scan) == SANY)
4201                         goto do_default;
4202                     if (flags & SCF_DO_STCLASS_OR) { /* Everything but \n */
4203                         value = (ANYOF_BITMAP_TEST(data->start_class,'\n')
4204                                 || ANYOF_CLASS_TEST_ANY_SET(data->start_class));
4205                         cl_anything(pRExC_state, data->start_class);
4206                     }
4207                     if (flags & SCF_DO_STCLASS_AND || !value)
4208                         ANYOF_BITMAP_CLEAR(data->start_class,'\n');
4209                     break;
4210                 case ANYOF:
4211                     if (flags & SCF_DO_STCLASS_AND)
4212                         cl_and(data->start_class,
4213                                (struct regnode_charclass_class*)scan);
4214                     else
4215                         cl_or(pRExC_state, data->start_class,
4216                               (struct regnode_charclass_class*)scan);
4217                     break;
4218                 case POSIXA:
4219                     loop_max = 128;
4220                     /* FALL THROUGH */
4221                 case POSIXL:
4222                 case POSIXD:
4223                 case POSIXU:
4224                     classnum = FLAGS(scan);
4225                     if (flags & SCF_DO_STCLASS_AND) {
4226                         if (!(data->start_class->flags & ANYOF_LOCALE)) {
4227                             ANYOF_CLASS_CLEAR(data->start_class, classnum_to_namedclass(classnum) + 1);
4228                             for (value = 0; value < loop_max; value++) {
4229                                 if (! _generic_isCC(UNI_TO_NATIVE(value), classnum)) {
4230                                     ANYOF_BITMAP_CLEAR(data->start_class, UNI_TO_NATIVE(value));
4231                                 }
4232                             }
4233                         }
4234                     }
4235                     else {
4236                         if (data->start_class->flags & ANYOF_LOCALE) {
4237                             ANYOF_CLASS_SET(data->start_class, classnum_to_namedclass(classnum));
4238                         }
4239                         else {
4240
4241                         /* Even if under locale, set the bits for non-locale
4242                          * in case it isn't a true locale-node.  This will
4243                          * create false positives if it truly is locale */
4244                         for (value = 0; value < loop_max; value++) {
4245                             if (_generic_isCC(UNI_TO_NATIVE(value), classnum)) {
4246                                 ANYOF_BITMAP_SET(data->start_class, UNI_TO_NATIVE(value));
4247                             }
4248                         }
4249                         }
4250                     }
4251                     break;
4252                 case NPOSIXA:
4253                     loop_max = 128;
4254                     /* FALL THROUGH */
4255                 case NPOSIXL:
4256                 case NPOSIXU:
4257                 case NPOSIXD:
4258                     classnum = FLAGS(scan);
4259                     if (flags & SCF_DO_STCLASS_AND) {
4260                         if (!(data->start_class->flags & ANYOF_LOCALE)) {
4261                             ANYOF_CLASS_CLEAR(data->start_class, classnum_to_namedclass(classnum));
4262                             for (value = 0; value < loop_max; value++) {
4263                                 if (_generic_isCC(UNI_TO_NATIVE(value), classnum)) {
4264                                     ANYOF_BITMAP_CLEAR(data->start_class, UNI_TO_NATIVE(value));
4265                                 }
4266                             }
4267                         }
4268                     }
4269                     else {
4270                         if (data->start_class->flags & ANYOF_LOCALE) {
4271                             ANYOF_CLASS_SET(data->start_class, classnum_to_namedclass(classnum) + 1);
4272                         }
4273                         else {
4274
4275                         /* Even if under locale, set the bits for non-locale in
4276                          * case it isn't a true locale-node.  This will create
4277                          * false positives if it truly is locale */
4278                         for (value = 0; value < loop_max; value++) {
4279                             if (! _generic_isCC(UNI_TO_NATIVE(value), classnum)) {
4280                                 ANYOF_BITMAP_SET(data->start_class, UNI_TO_NATIVE(value));
4281                             }
4282                         }
4283                         if (PL_regkind[OP(scan)] == NPOSIXD) {
4284                             data->start_class->flags |= ANYOF_NON_UTF8_LATIN1_ALL;
4285                         }
4286                         }
4287                     }
4288                     break;
4289                 }
4290                 if (flags & SCF_DO_STCLASS_OR)
4291                     cl_and(data->start_class, and_withp);
4292                 flags &= ~SCF_DO_STCLASS;
4293             }
4294         }
4295         else if (PL_regkind[OP(scan)] == EOL && flags & SCF_DO_SUBSTR) {
4296             data->flags |= (OP(scan) == MEOL
4297                             ? SF_BEFORE_MEOL
4298                             : SF_BEFORE_SEOL);
4299             SCAN_COMMIT(pRExC_state, data, minlenp);
4300
4301         }
4302         else if (  PL_regkind[OP(scan)] == BRANCHJ
4303                  /* Lookbehind, or need to calculate parens/evals/stclass: */
4304                    && (scan->flags || data || (flags & SCF_DO_STCLASS))
4305                    && (OP(scan) == IFMATCH || OP(scan) == UNLESSM)) {
4306             if ( OP(scan) == UNLESSM &&
4307                  scan->flags == 0 &&
4308                  OP(NEXTOPER(NEXTOPER(scan))) == NOTHING &&
4309                  OP(regnext(NEXTOPER(NEXTOPER(scan)))) == SUCCEED
4310             ) {
4311                 regnode *opt;
4312                 regnode *upto= regnext(scan);
4313                 DEBUG_PARSE_r({
4314                     SV * const mysv_val=sv_newmortal();
4315                     DEBUG_STUDYDATA("OPFAIL",data,depth);
4316
4317                     /*DEBUG_PARSE_MSG("opfail");*/
4318                     regprop(RExC_rx, mysv_val, upto);
4319                     PerlIO_printf(Perl_debug_log, "~ replace with OPFAIL pointed at %s (%"IVdf") offset %"IVdf"\n",
4320                                   SvPV_nolen_const(mysv_val),
4321                                   (IV)REG_NODE_NUM(upto),
4322                                   (IV)(upto - scan)
4323                     );
4324                 });
4325                 OP(scan) = OPFAIL;
4326                 NEXT_OFF(scan) = upto - scan;
4327                 for (opt= scan + 1; opt < upto ; opt++)
4328                     OP(opt) = OPTIMIZED;
4329                 scan= upto;
4330                 continue;
4331             }
4332             if ( !PERL_ENABLE_POSITIVE_ASSERTION_STUDY 
4333                 || OP(scan) == UNLESSM )
4334             {
4335                 /* Negative Lookahead/lookbehind
4336                    In this case we can't do fixed string optimisation.
4337                 */
4338
4339                 I32 deltanext, minnext, fake = 0;
4340                 regnode *nscan;
4341                 struct regnode_charclass_class intrnl;
4342                 int f = 0;
4343
4344                 data_fake.flags = 0;
4345                 if (data) {
4346                     data_fake.whilem_c = data->whilem_c;
4347                     data_fake.last_closep = data->last_closep;
4348                 }
4349                 else
4350                     data_fake.last_closep = &fake;
4351                 data_fake.pos_delta = delta;
4352                 if ( flags & SCF_DO_STCLASS && !scan->flags
4353                      && OP(scan) == IFMATCH ) { /* Lookahead */
4354                     cl_init(pRExC_state, &intrnl);
4355                     data_fake.start_class = &intrnl;
4356                     f |= SCF_DO_STCLASS_AND;
4357                 }
4358                 if (flags & SCF_WHILEM_VISITED_POS)
4359                     f |= SCF_WHILEM_VISITED_POS;
4360                 next = regnext(scan);
4361                 nscan = NEXTOPER(NEXTOPER(scan));
4362                 minnext = study_chunk(pRExC_state, &nscan, minlenp, &deltanext, 
4363                     last, &data_fake, stopparen, recursed, NULL, f, depth+1);
4364                 if (scan->flags) {
4365                     if (deltanext) {
4366                         FAIL("Variable length lookbehind not implemented");
4367                     }
4368                     else if (minnext > (I32)U8_MAX) {
4369                         FAIL2("Lookbehind longer than %"UVuf" not implemented", (UV)U8_MAX);
4370                     }
4371                     scan->flags = (U8)minnext;
4372                 }
4373                 if (data) {
4374                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4375                         pars++;
4376                     if (data_fake.flags & SF_HAS_EVAL)
4377                         data->flags |= SF_HAS_EVAL;
4378                     data->whilem_c = data_fake.whilem_c;
4379                 }
4380                 if (f & SCF_DO_STCLASS_AND) {
4381                     if (flags & SCF_DO_STCLASS_OR) {
4382                         /* OR before, AND after: ideally we would recurse with
4383                          * data_fake to get the AND applied by study of the
4384                          * remainder of the pattern, and then derecurse;
4385                          * *** HACK *** for now just treat as "no information".
4386                          * See [perl #56690].
4387                          */
4388                         cl_init(pRExC_state, data->start_class);
4389                     }  else {
4390                         /* AND before and after: combine and continue */
4391                         const int was = TEST_SSC_EOS(data->start_class);
4392
4393                         cl_and(data->start_class, &intrnl);
4394                         if (was)
4395                             SET_SSC_EOS(data->start_class);
4396                     }
4397                 }
4398             }
4399 #if PERL_ENABLE_POSITIVE_ASSERTION_STUDY
4400             else {
4401                 /* Positive Lookahead/lookbehind
4402                    In this case we can do fixed string optimisation,
4403                    but we must be careful about it. Note in the case of
4404                    lookbehind the positions will be offset by the minimum
4405                    length of the pattern, something we won't know about
4406                    until after the recurse.
4407                 */
4408                 I32 deltanext, fake = 0;
4409                 regnode *nscan;
4410                 struct regnode_charclass_class intrnl;
4411                 int f = 0;
4412                 /* We use SAVEFREEPV so that when the full compile 
4413                     is finished perl will clean up the allocated 
4414                     minlens when it's all done. This way we don't
4415                     have to worry about freeing them when we know
4416                     they wont be used, which would be a pain.
4417                  */
4418                 I32 *minnextp;
4419                 Newx( minnextp, 1, I32 );
4420                 SAVEFREEPV(minnextp);
4421
4422                 if (data) {
4423                     StructCopy(data, &data_fake, scan_data_t);
4424                     if ((flags & SCF_DO_SUBSTR) && data->last_found) {
4425                         f |= SCF_DO_SUBSTR;
4426                         if (scan->flags) 
4427                             SCAN_COMMIT(pRExC_state, &data_fake,minlenp);
4428                         data_fake.last_found=newSVsv(data->last_found);
4429                     }
4430                 }
4431                 else
4432                     data_fake.last_closep = &fake;
4433                 data_fake.flags = 0;
4434                 data_fake.pos_delta = delta;
4435                 if (is_inf)
4436                     data_fake.flags |= SF_IS_INF;
4437                 if ( flags & SCF_DO_STCLASS && !scan->flags
4438                      && OP(scan) == IFMATCH ) { /* Lookahead */
4439                     cl_init(pRExC_state, &intrnl);
4440                     data_fake.start_class = &intrnl;
4441                     f |= SCF_DO_STCLASS_AND;
4442                 }
4443                 if (flags & SCF_WHILEM_VISITED_POS)
4444                     f |= SCF_WHILEM_VISITED_POS;
4445                 next = regnext(scan);
4446                 nscan = NEXTOPER(NEXTOPER(scan));
4447
4448                 *minnextp = study_chunk(pRExC_state, &nscan, minnextp, &deltanext, 
4449                     last, &data_fake, stopparen, recursed, NULL, f,depth+1);
4450                 if (scan->flags) {
4451                     if (deltanext) {
4452                         FAIL("Variable length lookbehind not implemented");
4453                     }
4454                     else if (*minnextp > (I32)U8_MAX) {
4455                         FAIL2("Lookbehind longer than %"UVuf" not implemented", (UV)U8_MAX);
4456                     }
4457                     scan->flags = (U8)*minnextp;
4458                 }
4459
4460                 *minnextp += min;
4461
4462                 if (f & SCF_DO_STCLASS_AND) {
4463                     const int was = TEST_SSC_EOS(data.start_class);
4464
4465                     cl_and(data->start_class, &intrnl);
4466                     if (was)
4467                         SET_SSC_EOS(data->start_class);
4468                 }
4469                 if (data) {
4470                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4471                         pars++;
4472                     if (data_fake.flags & SF_HAS_EVAL)
4473                         data->flags |= SF_HAS_EVAL;
4474                     data->whilem_c = data_fake.whilem_c;
4475                     if ((flags & SCF_DO_SUBSTR) && data_fake.last_found) {
4476                         if (RExC_rx->minlen<*minnextp)
4477                             RExC_rx->minlen=*minnextp;
4478                         SCAN_COMMIT(pRExC_state, &data_fake, minnextp);
4479                         SvREFCNT_dec_NN(data_fake.last_found);
4480                         
4481                         if ( data_fake.minlen_fixed != minlenp ) 
4482                         {
4483                             data->offset_fixed= data_fake.offset_fixed;
4484                             data->minlen_fixed= data_fake.minlen_fixed;
4485                             data->lookbehind_fixed+= scan->flags;
4486                         }
4487                         if ( data_fake.minlen_float != minlenp )
4488                         {
4489                             data->minlen_float= data_fake.minlen_float;
4490                             data->offset_float_min=data_fake.offset_float_min;
4491                             data->offset_float_max=data_fake.offset_float_max;
4492                             data->lookbehind_float+= scan->flags;
4493                         }
4494                     }
4495                 }
4496             }
4497 #endif
4498         }
4499         else if (OP(scan) == OPEN) {
4500             if (stopparen != (I32)ARG(scan))
4501                 pars++;
4502         }
4503         else if (OP(scan) == CLOSE) {
4504             if (stopparen == (I32)ARG(scan)) {
4505                 break;
4506             }
4507             if ((I32)ARG(scan) == is_par) {
4508                 next = regnext(scan);
4509
4510                 if ( next && (OP(next) != WHILEM) && next < last)
4511                     is_par = 0;         /* Disable optimization */
4512             }
4513             if (data)
4514                 *(data->last_closep) = ARG(scan);
4515         }
4516         else if (OP(scan) == EVAL) {
4517                 if (data)
4518                     data->flags |= SF_HAS_EVAL;
4519         }
4520         else if ( PL_regkind[OP(scan)] == ENDLIKE ) {
4521             if (flags & SCF_DO_SUBSTR) {
4522                 SCAN_COMMIT(pRExC_state,data,minlenp);
4523                 flags &= ~SCF_DO_SUBSTR;
4524             }
4525             if (data && OP(scan)==ACCEPT) {
4526                 data->flags |= SCF_SEEN_ACCEPT;
4527                 if (stopmin > min)
4528                     stopmin = min;
4529             }
4530         }
4531         else if (OP(scan) == LOGICAL && scan->flags == 2) /* Embedded follows */
4532         {
4533                 if (flags & SCF_DO_SUBSTR) {
4534                     SCAN_COMMIT(pRExC_state,data,minlenp);
4535                     data->longest = &(data->longest_float);
4536                 }
4537                 is_inf = is_inf_internal = 1;
4538                 if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
4539                     cl_anything(pRExC_state, data->start_class);
4540                 flags &= ~SCF_DO_STCLASS;
4541         }
4542         else if (OP(scan) == GPOS) {
4543             if (!(RExC_rx->extflags & RXf_GPOS_FLOAT) &&
4544                 !(delta || is_inf || (data && data->pos_delta))) 
4545             {
4546                 if (!(RExC_rx->extflags & RXf_ANCH) && (flags & SCF_DO_SUBSTR))
4547                     RExC_rx->extflags |= RXf_ANCH_GPOS;
4548                 if (RExC_rx->gofs < (U32)min)
4549                     RExC_rx->gofs = min;
4550             } else {
4551                 RExC_rx->extflags |= RXf_GPOS_FLOAT;
4552                 RExC_rx->gofs = 0;
4553             }       
4554         }
4555 #ifdef TRIE_STUDY_OPT
4556 #ifdef FULL_TRIE_STUDY
4557         else if (PL_regkind[OP(scan)] == TRIE) {
4558             /* NOTE - There is similar code to this block above for handling
4559                BRANCH nodes on the initial study.  If you change stuff here
4560                check there too. */
4561             regnode *trie_node= scan;
4562             regnode *tail= regnext(scan);
4563             reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
4564             I32 max1 = 0, min1 = I32_MAX;
4565             struct regnode_charclass_class accum;
4566
4567             if (flags & SCF_DO_SUBSTR) /* XXXX Add !SUSPEND? */
4568                 SCAN_COMMIT(pRExC_state, data,minlenp); /* Cannot merge strings after this. */
4569             if (flags & SCF_DO_STCLASS)
4570                 cl_init_zero(pRExC_state, &accum);
4571                 
4572             if (!trie->jump) {
4573                 min1= trie->minlen;
4574                 max1= trie->maxlen;
4575             } else {
4576                 const regnode *nextbranch= NULL;
4577                 U32 word;
4578                 
4579                 for ( word=1 ; word <= trie->wordcount ; word++) 
4580                 {
4581                     I32 deltanext=0, minnext=0, f = 0, fake;
4582                     struct regnode_charclass_class this_class;
4583                     
4584                     data_fake.flags = 0;
4585                     if (data) {
4586                         data_fake.whilem_c = data->whilem_c;
4587                         data_fake.last_closep = data->last_closep;
4588                     }
4589                     else
4590                         data_fake.last_closep = &fake;
4591                     data_fake.pos_delta = delta;
4592                     if (flags & SCF_DO_STCLASS) {
4593                         cl_init(pRExC_state, &this_class);
4594                         data_fake.start_class = &this_class;
4595                         f = SCF_DO_STCLASS_AND;
4596                     }
4597                     if (flags & SCF_WHILEM_VISITED_POS)
4598                         f |= SCF_WHILEM_VISITED_POS;
4599     
4600                     if (trie->jump[word]) {
4601                         if (!nextbranch)
4602                             nextbranch = trie_node + trie->jump[0];
4603                         scan= trie_node + trie->jump[word];
4604                         /* We go from the jump point to the branch that follows
4605                            it. Note this means we need the vestigal unused branches
4606                            even though they arent otherwise used.
4607                          */
4608                         minnext = study_chunk(pRExC_state, &scan, minlenp, 
4609                             &deltanext, (regnode *)nextbranch, &data_fake, 
4610                             stopparen, recursed, NULL, f,depth+1);
4611                     }
4612                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
4613                         nextbranch= regnext((regnode*)nextbranch);
4614                     
4615                     if (min1 > (I32)(minnext + trie->minlen))
4616                         min1 = minnext + trie->minlen;
4617                     if (deltanext == I32_MAX) {
4618                         is_inf = is_inf_internal = 1;
4619                         max1 = I32_MAX;
4620                     } else if (max1 < (I32)(minnext + deltanext + trie->maxlen))
4621                         max1 = minnext + deltanext + trie->maxlen;
4622                     
4623                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4624                         pars++;
4625                     if (data_fake.flags & SCF_SEEN_ACCEPT) {
4626                         if ( stopmin > min + min1) 
4627                             stopmin = min + min1;
4628                         flags &= ~SCF_DO_SUBSTR;
4629                         if (data)
4630                             data->flags |= SCF_SEEN_ACCEPT;
4631                     }
4632                     if (data) {
4633                         if (data_fake.flags & SF_HAS_EVAL)
4634                             data->flags |= SF_HAS_EVAL;
4635                         data->whilem_c = data_fake.whilem_c;
4636                     }
4637                     if (flags & SCF_DO_STCLASS)
4638                         cl_or(pRExC_state, &accum, &this_class);
4639                 }
4640             }
4641             if (flags & SCF_DO_SUBSTR) {
4642                 data->pos_min += min1;
4643                 data->pos_delta += max1 - min1;
4644                 if (max1 != min1 || is_inf)
4645                     data->longest = &(data->longest_float);
4646             }
4647             min += min1;
4648             delta += max1 - min1;
4649             if (flags & SCF_DO_STCLASS_OR) {
4650                 cl_or(pRExC_state, data->start_class, &accum);
4651                 if (min1) {
4652                     cl_and(data->start_class, and_withp);
4653                     flags &= ~SCF_DO_STCLASS;
4654                 }
4655             }
4656             else if (flags & SCF_DO_STCLASS_AND) {
4657                 if (min1) {
4658                     cl_and(data->start_class, &accum);
4659                     flags &= ~SCF_DO_STCLASS;
4660                 }
4661                 else {
4662                     /* Switch to OR mode: cache the old value of
4663                      * data->start_class */
4664                     INIT_AND_WITHP;
4665                     StructCopy(data->start_class, and_withp,
4666                                struct regnode_charclass_class);
4667                     flags &= ~SCF_DO_STCLASS_AND;
4668                     StructCopy(&accum, data->start_class,
4669                                struct regnode_charclass_class);
4670                     flags |= SCF_DO_STCLASS_OR;
4671                     SET_SSC_EOS(data->start_class);
4672                 }
4673             }
4674             scan= tail;
4675             continue;
4676         }
4677 #else
4678         else if (PL_regkind[OP(scan)] == TRIE) {
4679             reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
4680             U8*bang=NULL;
4681             
4682             min += trie->minlen;
4683             delta += (trie->maxlen - trie->minlen);
4684             flags &= ~SCF_DO_STCLASS; /* xxx */
4685             if (flags & SCF_DO_SUBSTR) {
4686                 SCAN_COMMIT(pRExC_state,data,minlenp);  /* Cannot expect anything... */
4687                 data->pos_min += trie->minlen;
4688                 data->pos_delta += (trie->maxlen - trie->minlen);
4689                 if (trie->maxlen != trie->minlen)
4690                     data->longest = &(data->longest_float);
4691             }
4692             if (trie->jump) /* no more substrings -- for now /grr*/
4693                 flags &= ~SCF_DO_SUBSTR; 
4694         }
4695 #endif /* old or new */
4696 #endif /* TRIE_STUDY_OPT */
4697
4698         /* Else: zero-length, ignore. */
4699         scan = regnext(scan);
4700     }
4701     if (frame) {
4702         last = frame->last;
4703         scan = frame->next;
4704         stopparen = frame->stop;
4705         frame = frame->prev;
4706         goto fake_study_recurse;
4707     }
4708
4709   finish:
4710     assert(!frame);
4711     DEBUG_STUDYDATA("pre-fin:",data,depth);
4712
4713     *scanp = scan;
4714     *deltap = is_inf_internal ? I32_MAX : delta;
4715     if (flags & SCF_DO_SUBSTR && is_inf)
4716         data->pos_delta = I32_MAX - data->pos_min;
4717     if (is_par > (I32)U8_MAX)
4718         is_par = 0;
4719     if (is_par && pars==1 && data) {
4720         data->flags |= SF_IN_PAR;
4721         data->flags &= ~SF_HAS_PAR;
4722     }
4723     else if (pars && data) {
4724         data->flags |= SF_HAS_PAR;
4725         data->flags &= ~SF_IN_PAR;
4726     }
4727     if (flags & SCF_DO_STCLASS_OR)
4728         cl_and(data->start_class, and_withp);
4729     if (flags & SCF_TRIE_RESTUDY)
4730         data->flags |=  SCF_TRIE_RESTUDY;
4731     
4732     DEBUG_STUDYDATA("post-fin:",data,depth);
4733     
4734     return min < stopmin ? min : stopmin;
4735 }
4736
4737 STATIC U32
4738 S_add_data(RExC_state_t *pRExC_state, U32 n, const char *s)
4739 {
4740     U32 count = RExC_rxi->data ? RExC_rxi->data->count : 0;
4741
4742     PERL_ARGS_ASSERT_ADD_DATA;
4743
4744     Renewc(RExC_rxi->data,
4745            sizeof(*RExC_rxi->data) + sizeof(void*) * (count + n - 1),
4746            char, struct reg_data);
4747     if(count)
4748         Renew(RExC_rxi->data->what, count + n, U8);
4749     else
4750         Newx(RExC_rxi->data->what, n, U8);
4751     RExC_rxi->data->count = count + n;
4752     Copy(s, RExC_rxi->data->what + count, n, U8);
4753     return count;
4754 }
4755
4756 /*XXX: todo make this not included in a non debugging perl */
4757 #ifndef PERL_IN_XSUB_RE
4758 void
4759 Perl_reginitcolors(pTHX)
4760 {
4761     dVAR;
4762     const char * const s = PerlEnv_getenv("PERL_RE_COLORS");
4763     if (s) {
4764         char *t = savepv(s);
4765         int i = 0;
4766         PL_colors[0] = t;
4767         while (++i < 6) {
4768             t = strchr(t, '\t');
4769             if (t) {
4770                 *t = '\0';
4771                 PL_colors[i] = ++t;
4772             }
4773             else
4774                 PL_colors[i] = t = (char *)"";
4775         }
4776     } else {
4777         int i = 0;
4778         while (i < 6)
4779             PL_colors[i++] = (char *)"";
4780     }
4781     PL_colorset = 1;
4782 }
4783 #endif
4784
4785
4786 #ifdef TRIE_STUDY_OPT
4787 #define CHECK_RESTUDY_GOTO_butfirst(dOsomething)            \
4788     STMT_START {                                            \
4789         if (                                                \
4790               (data.flags & SCF_TRIE_RESTUDY)               \
4791               && ! restudied++                              \
4792         ) {                                                 \
4793             dOsomething;                                    \
4794             goto reStudy;                                   \
4795         }                                                   \
4796     } STMT_END
4797 #else
4798 #define CHECK_RESTUDY_GOTO_butfirst
4799 #endif        
4800
4801 /*
4802  * pregcomp - compile a regular expression into internal code
4803  *
4804  * Decides which engine's compiler to call based on the hint currently in
4805  * scope
4806  */
4807
4808 #ifndef PERL_IN_XSUB_RE 
4809
4810 /* return the currently in-scope regex engine (or the default if none)  */
4811
4812 regexp_engine const *
4813 Perl_current_re_engine(pTHX)
4814 {
4815     dVAR;
4816
4817     if (IN_PERL_COMPILETIME) {
4818         HV * const table = GvHV(PL_hintgv);
4819         SV **ptr;
4820
4821         if (!table)
4822             return &reh_regexp_engine;
4823         ptr = hv_fetchs(table, "regcomp", FALSE);
4824         if ( !(ptr && SvIOK(*ptr) && SvIV(*ptr)))
4825             return &reh_regexp_engine;
4826         return INT2PTR(regexp_engine*,SvIV(*ptr));
4827     }
4828     else {
4829         SV *ptr;
4830         if (!PL_curcop->cop_hints_hash)
4831             return &reh_regexp_engine;
4832         ptr = cop_hints_fetch_pvs(PL_curcop, "regcomp", 0);
4833         if ( !(ptr && SvIOK(ptr) && SvIV(ptr)))
4834             return &reh_regexp_engine;
4835         return INT2PTR(regexp_engine*,SvIV(ptr));
4836     }
4837 }
4838
4839
4840 REGEXP *
4841 Perl_pregcomp(pTHX_ SV * const pattern, const U32 flags)
4842 {
4843     dVAR;
4844     regexp_engine const *eng = current_re_engine();
4845     GET_RE_DEBUG_FLAGS_DECL;
4846
4847     PERL_ARGS_ASSERT_PREGCOMP;
4848
4849     /* Dispatch a request to compile a regexp to correct regexp engine. */
4850     DEBUG_COMPILE_r({
4851         PerlIO_printf(Perl_debug_log, "Using engine %"UVxf"\n",
4852                         PTR2UV(eng));
4853     });
4854     return CALLREGCOMP_ENG(eng, pattern, flags);
4855 }
4856 #endif
4857
4858 /* public(ish) entry point for the perl core's own regex compiling code.
4859  * It's actually a wrapper for Perl_re_op_compile that only takes an SV
4860  * pattern rather than a list of OPs, and uses the internal engine rather
4861  * than the current one */
4862
4863 REGEXP *
4864 Perl_re_compile(pTHX_ SV * const pattern, U32 rx_flags)
4865 {
4866     SV *pat = pattern; /* defeat constness! */
4867     PERL_ARGS_ASSERT_RE_COMPILE;
4868     return Perl_re_op_compile(aTHX_ &pat, 1, NULL,
4869 #ifdef PERL_IN_XSUB_RE
4870                                 &my_reg_engine,
4871 #else
4872                                 &reh_regexp_engine,
4873 #endif
4874                                 NULL, NULL, rx_flags, 0);
4875 }
4876
4877 /* see if there are any run-time code blocks in the pattern.
4878  * False positives are allowed */
4879
4880 static bool
4881 S_has_runtime_code(pTHX_ RExC_state_t * const pRExC_state, OP *expr,
4882                     U32 pm_flags, char *pat, STRLEN plen)
4883 {
4884     int n = 0;
4885     STRLEN s;
4886
4887     /* avoid infinitely recursing when we recompile the pattern parcelled up
4888      * as qr'...'. A single constant qr// string can't have have any
4889      * run-time component in it, and thus, no runtime code. (A non-qr
4890      * string, however, can, e.g. $x =~ '(?{})') */
4891     if  ((pm_flags & PMf_IS_QR) && expr && expr->op_type == OP_CONST)
4892         return 0;
4893
4894     for (s = 0; s < plen; s++) {
4895         if (n < pRExC_state->num_code_blocks
4896             && s == pRExC_state->code_blocks[n].start)
4897         {
4898             s = pRExC_state->code_blocks[n].end;
4899             n++;
4900             continue;
4901         }
4902         /* TODO ideally should handle [..], (#..), /#.../x to reduce false
4903          * positives here */
4904         if (pat[s] == '(' && s+2 <= plen && pat[s+1] == '?' &&
4905             (pat[s+2] == '{'
4906                 || (s + 2 <= plen && pat[s+2] == '?' && pat[s+3] == '{'))
4907         )
4908             return 1;
4909     }
4910     return 0;
4911 }
4912
4913 /* Handle run-time code blocks. We will already have compiled any direct
4914  * or indirect literal code blocks. Now, take the pattern 'pat' and make a
4915  * copy of it, but with any literal code blocks blanked out and
4916  * appropriate chars escaped; then feed it into
4917  *
4918  *    eval "qr'modified_pattern'"
4919  *
4920  * For example,
4921  *
4922  *       a\bc(?{"this was literal"})def'ghi\\jkl(?{"this is runtime"})mno
4923  *
4924  * becomes
4925  *
4926  *    qr'a\\bc_______________________def\'ghi\\\\jkl(?{"this is runtime"})mno'
4927  *
4928  * After eval_sv()-ing that, grab any new code blocks from the returned qr
4929  * and merge them with any code blocks of the original regexp.
4930  *
4931  * If the pat is non-UTF8, while the evalled qr is UTF8, don't merge;
4932  * instead, just save the qr and return FALSE; this tells our caller that
4933  * the original pattern needs upgrading to utf8.
4934  */
4935
4936 static bool
4937 S_compile_runtime_code(pTHX_ RExC_state_t * const pRExC_state,
4938     char *pat, STRLEN plen)
4939 {
4940     SV *qr;
4941
4942     GET_RE_DEBUG_FLAGS_DECL;
4943
4944     if (pRExC_state->runtime_code_qr) {
4945         /* this is the second time we've been called; this should
4946          * only happen if the main pattern got upgraded to utf8
4947          * during compilation; re-use the qr we compiled first time
4948          * round (which should be utf8 too)
4949          */
4950         qr = pRExC_state->runtime_code_qr;
4951         pRExC_state->runtime_code_qr = NULL;
4952         assert(RExC_utf8 && SvUTF8(qr));
4953     }
4954     else {
4955         int n = 0;
4956         STRLEN s;
4957         char *p, *newpat;
4958         int newlen = plen + 6; /* allow for "qr''x\0" extra chars */
4959         SV *sv, *qr_ref;
4960         dSP;
4961
4962         /* determine how many extra chars we need for ' and \ escaping */
4963         for (s = 0; s < plen; s++) {
4964             if (pat[s] == '\'' || pat[s] == '\\')
4965                 newlen++;
4966         }
4967
4968         Newx(newpat, newlen, char);
4969         p = newpat;
4970         *p++ = 'q'; *p++ = 'r'; *p++ = '\'';
4971
4972         for (s = 0; s < plen; s++) {
4973             if (n < pRExC_state->num_code_blocks
4974                 && s == pRExC_state->code_blocks[n].start)
4975             {
4976                 /* blank out literal code block */
4977                 assert(pat[s] == '(');
4978                 while (s <= pRExC_state->code_blocks[n].end) {
4979                     *p++ = '_';
4980                     s++;
4981                 }
4982                 s--;
4983                 n++;
4984                 continue;
4985             }
4986             if (pat[s] == '\'' || pat[s] == '\\')
4987                 *p++ = '\\';
4988             *p++ = pat[s];
4989         }
4990         *p++ = '\'';
4991         if (pRExC_state->pm_flags & RXf_PMf_EXTENDED)
4992             *p++ = 'x';
4993         *p++ = '\0';
4994         DEBUG_COMPILE_r({
4995             PerlIO_printf(Perl_debug_log,
4996                 "%sre-parsing pattern for runtime code:%s %s\n",
4997                 PL_colors[4],PL_colors[5],newpat);
4998         });
4999
5000         sv = newSVpvn_flags(newpat, p-newpat-1, RExC_utf8 ? SVf_UTF8 : 0);
5001         Safefree(newpat);
5002
5003         ENTER;
5004         SAVETMPS;
5005         save_re_context();
5006         PUSHSTACKi(PERLSI_REQUIRE);
5007         /* this causes the toker to collapse \\ into \ when parsing
5008          * qr''; normally only q'' does this. It also alters hints
5009          * handling */
5010         PL_reg_state.re_reparsing = TRUE;
5011         eval_sv(sv, G_SCALAR);
5012         SvREFCNT_dec_NN(sv);
5013         SPAGAIN;
5014         qr_ref = POPs;
5015         PUTBACK;
5016         {
5017             SV * const errsv = ERRSV;
5018             if (SvTRUE_NN(errsv))
5019             {
5020                 Safefree(pRExC_state->code_blocks);
5021                 /* use croak_sv ? */
5022                 Perl_croak_nocontext("%s", SvPV_nolen_const(errsv));
5023             }
5024         }
5025         assert(SvROK(qr_ref));
5026         qr = SvRV(qr_ref);
5027         assert(SvTYPE(qr) == SVt_REGEXP && RX_ENGINE((REGEXP*)qr)->op_comp);
5028         /* the leaving below frees the tmp qr_ref.
5029          * Give qr a life of its own */
5030         SvREFCNT_inc(qr);
5031         POPSTACK;
5032         FREETMPS;
5033         LEAVE;
5034
5035     }
5036
5037     if (!RExC_utf8 && SvUTF8(qr)) {
5038         /* first time through; the pattern got upgraded; save the
5039          * qr for the next time through */
5040         assert(!pRExC_state->runtime_code_qr);
5041         pRExC_state->runtime_code_qr = qr;
5042         return 0;
5043     }
5044
5045
5046     /* extract any code blocks within the returned qr//  */
5047
5048
5049     /* merge the main (r1) and run-time (r2) code blocks into one */
5050     {
5051         RXi_GET_DECL(ReANY((REGEXP *)qr), r2);
5052         struct reg_code_block *new_block, *dst;
5053         RExC_state_t * const r1 = pRExC_state; /* convenient alias */
5054         int i1 = 0, i2 = 0;
5055
5056         if (!r2->num_code_blocks) /* we guessed wrong */
5057         {
5058             SvREFCNT_dec_NN(qr);
5059             return 1;
5060         }
5061
5062         Newx(new_block,
5063             r1->num_code_blocks + r2->num_code_blocks,
5064             struct reg_code_block);
5065         dst = new_block;
5066
5067         while (    i1 < r1->num_code_blocks
5068                 || i2 < r2->num_code_blocks)
5069         {
5070             struct reg_code_block *src;
5071             bool is_qr = 0;
5072
5073             if (i1 == r1->num_code_blocks) {
5074                 src = &r2->code_blocks[i2++];
5075                 is_qr = 1;
5076             }
5077             else if (i2 == r2->num_code_blocks)
5078                 src = &r1->code_blocks[i1++];
5079             else if (  r1->code_blocks[i1].start
5080                      < r2->code_blocks[i2].start)
5081             {
5082                 src = &r1->code_blocks[i1++];
5083                 assert(src->end < r2->code_blocks[i2].start);
5084             }
5085             else {
5086                 assert(  r1->code_blocks[i1].start
5087                        > r2->code_blocks[i2].start);
5088                 src = &r2->code_blocks[i2++];
5089                 is_qr = 1;
5090                 assert(src->end < r1->code_blocks[i1].start);
5091             }
5092
5093             assert(pat[src->start] == '(');
5094             assert(pat[src->end]   == ')');
5095             dst->start      = src->start;
5096             dst->end        = src->end;
5097             dst->block      = src->block;
5098             dst->src_regex  = is_qr ? (REGEXP*) SvREFCNT_inc( (SV*) qr)
5099                                     : src->src_regex;
5100             dst++;
5101         }
5102         r1->num_code_blocks += r2->num_code_blocks;
5103         Safefree(r1->code_blocks);
5104         r1->code_blocks = new_block;
5105     }
5106
5107     SvREFCNT_dec_NN(qr);
5108     return 1;
5109 }
5110
5111
5112 STATIC bool
5113 S_setup_longest(pTHX_ RExC_state_t *pRExC_state, SV* sv_longest, SV** rx_utf8, SV** rx_substr, I32* rx_end_shift, I32 lookbehind, I32 offset, I32 *minlen, STRLEN longest_length, bool eol, bool meol)
5114 {
5115     /* This is the common code for setting up the floating and fixed length
5116      * string data extracted from Perlre_op_compile() below.  Returns a boolean
5117      * as to whether succeeded or not */
5118
5119     I32 t,ml;
5120
5121     if (! (longest_length
5122            || (eol /* Can't have SEOL and MULTI */
5123                && (! meol || (RExC_flags & RXf_PMf_MULTILINE)))
5124           )
5125             /* See comments for join_exact for why REG_SEEN_EXACTF_SHARP_S */
5126         || (RExC_seen & REG_SEEN_EXACTF_SHARP_S))
5127     {
5128         return FALSE;
5129     }
5130
5131     /* copy the information about the longest from the reg_scan_data
5132         over to the program. */
5133     if (SvUTF8(sv_longest)) {
5134         *rx_utf8 = sv_longest;
5135         *rx_substr = NULL;
5136     } else {
5137         *rx_substr = sv_longest;
5138         *rx_utf8 = NULL;
5139     }
5140     /* end_shift is how many chars that must be matched that
5141         follow this item. We calculate it ahead of time as once the
5142         lookbehind offset is added in we lose the ability to correctly
5143         calculate it.*/
5144     ml = minlen ? *(minlen) : (I32)longest_length;
5145     *rx_end_shift = ml - offset
5146         - longest_length + (SvTAIL(sv_longest) != 0)
5147         + lookbehind;
5148
5149     t = (eol/* Can't have SEOL and MULTI */
5150          && (! meol || (RExC_flags & RXf_PMf_MULTILINE)));
5151     fbm_compile(sv_longest, t ? FBMcf_TAIL : 0);
5152
5153     return TRUE;
5154 }
5155
5156 /*
5157  * Perl_re_op_compile - the perl internal RE engine's function to compile a
5158  * regular expression into internal code.
5159  * The pattern may be passed either as:
5160  *    a list of SVs (patternp plus pat_count)
5161  *    a list of OPs (expr)
5162  * If both are passed, the SV list is used, but the OP list indicates
5163  * which SVs are actually pre-compiled code blocks
5164  *
5165  * The SVs in the list have magic and qr overloading applied to them (and
5166  * the list may be modified in-place with replacement SVs in the latter
5167  * case).
5168  *
5169  * If the pattern hasn't changed from old_re, then old_re will be
5170  * returned.
5171  *
5172  * eng is the current engine. If that engine has an op_comp method, then
5173  * handle directly (i.e. we assume that op_comp was us); otherwise, just
5174  * do the initial concatenation of arguments and pass on to the external
5175  * engine.
5176  *
5177  * If is_bare_re is not null, set it to a boolean indicating whether the
5178  * arg list reduced (after overloading) to a single bare regex which has
5179  * been returned (i.e. /$qr/).
5180  *
5181  * orig_rx_flags contains RXf_* flags. See perlreapi.pod for more details.
5182  *
5183  * pm_flags contains the PMf_* flags, typically based on those from the
5184  * pm_flags field of the related PMOP. Currently we're only interested in
5185  * PMf_HAS_CV, PMf_IS_QR, PMf_USE_RE_EVAL.
5186  *
5187  * We can't allocate space until we know how big the compiled form will be,
5188  * but we can't compile it (and thus know how big it is) until we've got a
5189  * place to put the code.  So we cheat:  we compile it twice, once with code
5190  * generation turned off and size counting turned on, and once "for real".
5191  * This also means that we don't allocate space until we are sure that the
5192  * thing really will compile successfully, and we never have to move the
5193  * code and thus invalidate pointers into it.  (Note that it has to be in
5194  * one piece because free() must be able to free it all.) [NB: not true in perl]
5195  *
5196  * Beware that the optimization-preparation code in here knows about some
5197  * of the structure of the compiled regexp.  [I'll say.]
5198  */
5199
5200 REGEXP *
5201 Perl_re_op_compile(pTHX_ SV ** const patternp, int pat_count,
5202                     OP *expr, const regexp_engine* eng, REGEXP *old_re,
5203                      bool *is_bare_re, U32 orig_rx_flags, U32 pm_flags)
5204 {
5205     dVAR;
5206     REGEXP *rx;
5207     struct regexp *r;
5208     regexp_internal *ri;
5209     STRLEN plen;
5210     char *exp;
5211     char* xend;
5212     regnode *scan;
5213     I32 flags;
5214     I32 minlen = 0;
5215     U32 rx_flags;
5216     SV *pat;
5217     SV *code_blocksv = NULL;
5218
5219     /* these are all flags - maybe they should be turned
5220      * into a single int with different bit masks */
5221     I32 sawlookahead = 0;
5222     I32 sawplus = 0;
5223     I32 sawopen = 0;
5224     regex_charset initial_charset = get_regex_charset(orig_rx_flags);
5225     bool code_is_utf8 = 0;
5226     bool recompile = 0;
5227     bool runtime_code = 0;
5228     scan_data_t data;
5229     RExC_state_t RExC_state;
5230     RExC_state_t * const pRExC_state = &RExC_state;
5231 #ifdef TRIE_STUDY_OPT    
5232     int restudied = 0;
5233     RExC_state_t copyRExC_state;
5234 #endif    
5235     GET_RE_DEBUG_FLAGS_DECL;
5236
5237     PERL_ARGS_ASSERT_RE_OP_COMPILE;
5238
5239     DEBUG_r(if (!PL_colorset) reginitcolors());
5240
5241 #ifndef PERL_IN_XSUB_RE
5242     /* Initialize these here instead of as-needed, as is quick and avoids
5243      * having to test them each time otherwise */
5244     if (! PL_AboveLatin1) {
5245         PL_AboveLatin1 = _new_invlist_C_array(AboveLatin1_invlist);
5246         PL_ASCII = _new_invlist_C_array(ASCII_invlist);
5247         PL_Latin1 = _new_invlist_C_array(Latin1_invlist);
5248
5249         PL_L1Posix_ptrs[_CC_ALPHANUMERIC]
5250                                 = _new_invlist_C_array(L1PosixAlnum_invlist);
5251         PL_Posix_ptrs[_CC_ALPHANUMERIC]
5252                                 = _new_invlist_C_array(PosixAlnum_invlist);
5253
5254         PL_L1Posix_ptrs[_CC_ALPHA]
5255                                 = _new_invlist_C_array(L1PosixAlpha_invlist);
5256         PL_Posix_ptrs[_CC_ALPHA] = _new_invlist_C_array(PosixAlpha_invlist);
5257
5258         PL_Posix_ptrs[_CC_BLANK] = _new_invlist_C_array(PosixBlank_invlist);
5259         PL_XPosix_ptrs[_CC_BLANK] = _new_invlist_C_array(XPosixBlank_invlist);
5260
5261         /* Cased is the same as Alpha in the ASCII range */
5262         PL_L1Posix_ptrs[_CC_CASED] =  _new_invlist_C_array(L1Cased_invlist);
5263         PL_Posix_ptrs[_CC_CASED] =  _new_invlist_C_array(PosixAlpha_invlist);
5264
5265         PL_Posix_ptrs[_CC_CNTRL] = _new_invlist_C_array(PosixCntrl_invlist);
5266         PL_XPosix_ptrs[_CC_CNTRL] = _new_invlist_C_array(XPosixCntrl_invlist);
5267
5268         PL_Posix_ptrs[_CC_DIGIT] = _new_invlist_C_array(PosixDigit_invlist);
5269         PL_L1Posix_ptrs[_CC_DIGIT] = _new_invlist_C_array(PosixDigit_invlist);
5270
5271         PL_L1Posix_ptrs[_CC_GRAPH] = _new_invlist_C_array(L1PosixGraph_invlist);
5272         PL_Posix_ptrs[_CC_GRAPH] = _new_invlist_C_array(PosixGraph_invlist);
5273
5274         PL_L1Posix_ptrs[_CC_LOWER] = _new_invlist_C_array(L1PosixLower_invlist);
5275         PL_Posix_ptrs[_CC_LOWER] = _new_invlist_C_array(PosixLower_invlist);
5276
5277         PL_L1Posix_ptrs[_CC_PRINT] = _new_invlist_C_array(L1PosixPrint_invlist);
5278         PL_Posix_ptrs[_CC_PRINT] = _new_invlist_C_array(PosixPrint_invlist);
5279
5280         PL_L1Posix_ptrs[_CC_PUNCT] = _new_invlist_C_array(L1PosixPunct_invlist);
5281         PL_Posix_ptrs[_CC_PUNCT] = _new_invlist_C_array(PosixPunct_invlist);
5282
5283         PL_Posix_ptrs[_CC_SPACE] = _new_invlist_C_array(PerlSpace_invlist);
5284         PL_XPosix_ptrs[_CC_SPACE] = _new_invlist_C_array(XPerlSpace_invlist);
5285         PL_Posix_ptrs[_CC_PSXSPC] = _new_invlist_C_array(PosixSpace_invlist);
5286         PL_XPosix_ptrs[_CC_PSXSPC] = _new_invlist_C_array(XPosixSpace_invlist);
5287
5288         PL_L1Posix_ptrs[_CC_UPPER] = _new_invlist_C_array(L1PosixUpper_invlist);
5289         PL_Posix_ptrs[_CC_UPPER] = _new_invlist_C_array(PosixUpper_invlist);
5290
5291         PL_XPosix_ptrs[_CC_VERTSPACE] = _new_invlist_C_array(VertSpace_invlist);
5292
5293         PL_Posix_ptrs[_CC_WORDCHAR] = _new_invlist_C_array(PosixWord_invlist);
5294         PL_L1Posix_ptrs[_CC_WORDCHAR]
5295                                 = _new_invlist_C_array(L1PosixWord_invlist);
5296
5297         PL_Posix_ptrs[_CC_XDIGIT] = _new_invlist_C_array(PosixXDigit_invlist);
5298         PL_XPosix_ptrs[_CC_XDIGIT] = _new_invlist_C_array(XPosixXDigit_invlist);
5299
5300         PL_HasMultiCharFold = _new_invlist_C_array(_Perl_Multi_Char_Folds_invlist);
5301     }
5302 #endif
5303
5304     pRExC_state->code_blocks = NULL;
5305     pRExC_state->num_code_blocks = 0;
5306
5307     if (is_bare_re)
5308         *is_bare_re = FALSE;
5309
5310     if (expr && (expr->op_type == OP_LIST ||
5311                 (expr->op_type == OP_NULL && expr->op_targ == OP_LIST))) {
5312
5313         /* is the source UTF8, and how many code blocks are there? */
5314         OP *o;
5315         int ncode = 0;
5316
5317         for (o = cLISTOPx(expr)->op_first; o; o = o->op_sibling) {
5318             if (o->op_type == OP_CONST) {
5319                 /* skip if we have SVs as well as OPs. In this case,
5320                  * a) we decide utf8 based on SVs not OPs;
5321                  * b) the current pad may not match that which the ops
5322                  *    were compiled in, so, so on threaded builds,
5323                  *    cSVOPo_sv would look in the wrong pad */
5324                 if (!pat_count && SvUTF8(cSVOPo_sv))
5325                     code_is_utf8 = 1;
5326             }
5327             else if (o->op_type == OP_NULL && (o->op_flags & OPf_SPECIAL))
5328                 /* count of DO blocks */
5329                 ncode++;
5330         }
5331         if (ncode) {
5332             pRExC_state->num_code_blocks = ncode;
5333             Newx(pRExC_state->code_blocks, ncode, struct reg_code_block);
5334         }
5335     }
5336
5337     if (pat_count) {
5338         /* handle a list of SVs */
5339
5340         SV **svp;
5341
5342         /* apply magic and RE overloading to each arg */
5343         for (svp = patternp; svp < patternp + pat_count; svp++) {
5344             SV *rx = *svp;
5345             SvGETMAGIC(rx);
5346             if (SvROK(rx) && SvAMAGIC(rx)) {
5347                 SV *sv = AMG_CALLunary(rx, regexp_amg);
5348                 if (sv) {
5349                     if (SvROK(sv))
5350                         sv = SvRV(sv);
5351                     if (SvTYPE(sv) != SVt_REGEXP)
5352                         Perl_croak(aTHX_ "Overloaded qr did not return a REGEXP");
5353                     *svp = sv;
5354                 }
5355             }
5356         }
5357
5358         if (pat_count > 1) {
5359             /* concat multiple args and find any code block indexes */
5360
5361             OP *o = NULL;
5362             int n = 0;
5363             bool utf8 = 0;
5364             STRLEN orig_patlen = 0;
5365
5366             if (pRExC_state->num_code_blocks) {
5367                 o = cLISTOPx(expr)->op_first;
5368                 assert(   o->op_type == OP_PUSHMARK
5369                        || (o->op_type == OP_NULL && o->op_targ == OP_PUSHMARK)
5370                        || o->op_type == OP_PADRANGE);
5371                 o = o->op_sibling;
5372             }
5373
5374             pat = newSVpvn("", 0);
5375             SAVEFREESV(pat);
5376
5377             /* determine if the pattern is going to be utf8 (needed
5378              * in advance to align code block indices correctly).
5379              * XXX This could fail to be detected for an arg with
5380              * overloading but not concat overloading; but the main effect
5381              * in this obscure case is to need a 'use re eval' for a
5382              * literal code block */
5383             for (svp = patternp; svp < patternp + pat_count; svp++) {
5384                 if (SvUTF8(*svp))
5385                     utf8 = 1;
5386             }
5387             if (utf8)
5388                 SvUTF8_on(pat);
5389
5390             for (svp = patternp; svp < patternp + pat_count; svp++) {
5391                 SV *sv, *msv = *svp;
5392                 SV *rx;
5393                 bool code = 0;
5394                 /* we make the assumption here that each op in the list of
5395                  * op_siblings maps to one SV pushed onto the stack,
5396                  * except for code blocks, with have both an OP_NULL and
5397                  * and OP_CONST.
5398                  * This allows us to match up the list of SVs against the
5399                  * list of OPs to find the next code block.
5400                  *
5401                  * Note that       PUSHMARK PADSV PADSV ..
5402                  * is optimised to
5403                  *                 PADRANGE NULL  NULL  ..
5404                  * so the alignment still works. */
5405                 if (o) {
5406                     if (o->op_type == OP_NULL && (o->op_flags & OPf_SPECIAL)) {
5407                         assert(n < pRExC_state->num_code_blocks);
5408                         pRExC_state->code_blocks[n].start = SvCUR(pat);
5409                         pRExC_state->code_blocks[n].block = o;
5410                         pRExC_state->code_blocks[n].src_regex = NULL;
5411                         n++;
5412                         code = 1;
5413                         o = o->op_sibling; /* skip CONST */
5414                         assert(o);
5415                     }
5416                     o = o->op_sibling;;
5417                 }
5418
5419                 if ((SvAMAGIC(pat) || SvAMAGIC(msv)) &&
5420                         (sv = amagic_call(pat, msv, concat_amg, AMGf_assign)))
5421                 {
5422                     sv_setsv(pat, sv);
5423                     /* overloading involved: all bets are off over literal
5424                      * code. Pretend we haven't seen it */
5425                     pRExC_state->num_code_blocks -= n;
5426                     n = 0;
5427                     rx = NULL;
5428
5429                 }
5430                 else  {
5431                     while (SvAMAGIC(msv)
5432                             && (sv = AMG_CALLunary(msv, string_amg))
5433                             && sv != msv
5434                             &&  !(   SvROK(msv)
5435                                   && SvROK(sv)
5436                                   && SvRV(msv) == SvRV(sv))
5437                     ) {
5438                         msv = sv;
5439                         SvGETMAGIC(msv);
5440                     }
5441                     if (SvROK(msv) && SvTYPE(SvRV(msv)) == SVt_REGEXP)
5442                         msv = SvRV(msv);
5443                     orig_patlen = SvCUR(pat);
5444                     sv_catsv_nomg(pat, msv);
5445                     rx = msv;
5446                     if (code)
5447                         pRExC_state->code_blocks[n-1].end = SvCUR(pat)-1;
5448                 }
5449
5450                 /* extract any code blocks within any embedded qr//'s */
5451                 if (rx && SvTYPE(rx) == SVt_REGEXP
5452                     && RX_ENGINE((REGEXP*)rx)->op_comp)
5453                 {
5454
5455                     RXi_GET_DECL(ReANY((REGEXP *)rx), ri);
5456                     if (ri->num_code_blocks) {
5457                         int i;
5458                         /* the presence of an embedded qr// with code means
5459                          * we should always recompile: the text of the
5460                          * qr// may not have changed, but it may be a
5461                          * different closure than last time */
5462                         recompile = 1;
5463                         Renew(pRExC_state->code_blocks,
5464                             pRExC_state->num_code_blocks + ri->num_code_blocks,
5465                             struct reg_code_block);
5466                         pRExC_state->num_code_blocks += ri->num_code_blocks;
5467                         for (i=0; i < ri->num_code_blocks; i++) {
5468                             struct reg_code_block *src, *dst;
5469                             STRLEN offset =  orig_patlen
5470                                 + ReANY((REGEXP *)rx)->pre_prefix;
5471                             assert(n < pRExC_state->num_code_blocks);
5472                             src = &ri->code_blocks[i];
5473                             dst = &pRExC_state->code_blocks[n];
5474                             dst->start      = src->start + offset;
5475                             dst->end        = src->end   + offset;
5476                             dst->block      = src->block;
5477                             dst->src_regex  = (REGEXP*) SvREFCNT_inc( (SV*)
5478                                                     src->src_regex
5479                                                         ? src->src_regex
5480                                                         : (REGEXP*)rx);
5481                             n++;
5482                         }
5483                     }
5484                 }
5485             }
5486             SvSETMAGIC(pat);
5487         }
5488         else {
5489             SV *sv;
5490             pat = *patternp;
5491             while (SvAMAGIC(pat)
5492                     && (sv = AMG_CALLunary(pat, string_amg))
5493                     && sv != pat)
5494             {
5495                 pat = sv;
5496                 SvGETMAGIC(pat);
5497             }
5498         }
5499
5500         /* handle bare regex: foo =~ $re */
5501         {
5502             SV *re = pat;
5503             if (SvROK(re))
5504                 re = SvRV(re);
5505             if (SvTYPE(re) == SVt_REGEXP) {
5506                 if (is_bare_re)
5507                     *is_bare_re = TRUE;
5508                 SvREFCNT_inc(re);
5509                 Safefree(pRExC_state->code_blocks);
5510                 return (REGEXP*)re;
5511             }
5512         }
5513     }
5514     else {
5515         /* not a list of SVs, so must be a list of OPs */
5516         assert(expr);
5517         if (expr->op_type == OP_LIST) {
5518             int i = -1;
5519             bool is_code = 0;
5520             OP *o;
5521
5522             pat = newSVpvn("", 0);
5523             SAVEFREESV(pat);
5524             if (code_is_utf8)
5525                 SvUTF8_on(pat);
5526
5527             /* given a list of CONSTs and DO blocks in expr, append all
5528              * the CONSTs to pat, and record the start and end of each
5529              * code block in code_blocks[] (each DO{} op is followed by an
5530              * OP_CONST containing the corresponding literal '(?{...})
5531              * text)
5532              */
5533             for (o = cLISTOPx(expr)->op_first; o; o = o->op_sibling) {
5534                 if (o->op_type == OP_CONST) {
5535                     sv_catsv(pat, cSVOPo_sv);
5536                     if (is_code) {
5537                         pRExC_state->code_blocks[i].end = SvCUR(pat)-1;
5538                         is_code = 0;
5539                     }
5540                 }
5541                 else if (o->op_type == OP_NULL && (o->op_flags & OPf_SPECIAL)) {
5542                     assert(i+1 < pRExC_state->num_code_blocks);
5543                     pRExC_state->code_blocks[++i].start = SvCUR(pat);
5544                     pRExC_state->code_blocks[i].block = o;
5545                     pRExC_state->code_blocks[i].src_regex = NULL;
5546                     is_code = 1;
5547                 }
5548             }
5549         }
5550         else {
5551             assert(expr->op_type == OP_CONST);
5552             pat = cSVOPx_sv(expr);
5553         }
5554     }
5555
5556     exp = SvPV_nomg(pat, plen);
5557     xend = exp + plen;
5558
5559     if (!eng->op_comp) {
5560         if ((SvUTF8(pat) && IN_BYTES)
5561                 || SvGMAGICAL(pat) || SvAMAGIC(pat))
5562         {
5563             /* make a temporary copy; either to convert to bytes,
5564              * or to avoid repeating get-magic / overloaded stringify */
5565             pat = newSVpvn_flags(exp, plen, SVs_TEMP |
5566                                         (IN_BYTES ? 0 : SvUTF8(pat)));
5567         }
5568         Safefree(pRExC_state->code_blocks);
5569         return CALLREGCOMP_ENG(eng, pat, orig_rx_flags);
5570     }
5571
5572     /* ignore the utf8ness if the pattern is 0 length */
5573     RExC_utf8 = RExC_orig_utf8 = (plen == 0 || IN_BYTES) ? 0 : SvUTF8(pat);
5574     RExC_uni_semantics = 0;
5575     RExC_contains_locale = 0;
5576     pRExC_state->runtime_code_qr = NULL;
5577
5578     DEBUG_COMPILE_r({
5579             SV *dsv= sv_newmortal();
5580             RE_PV_QUOTED_DECL(s, RExC_utf8, dsv, exp, plen, 60);
5581             PerlIO_printf(Perl_debug_log, "%sCompiling REx%s %s\n",
5582                           PL_colors[4],PL_colors[5],s);
5583         });
5584
5585     if (0) {
5586       redo_first_pass:
5587         {
5588         U8 *const src = (U8*)exp;
5589         U8 *dst;
5590         int n=0;
5591         STRLEN s = 0, d = 0;
5592         bool do_end = 0;
5593
5594         /* It's possible to write a regexp in ascii that represents Unicode
5595         codepoints outside of the byte range, such as via \x{100}. If we
5596         detect such a sequence we have to convert the entire pattern to utf8
5597         and then recompile, as our sizing calculation will have been based
5598         on 1 byte == 1 character, but we will need to use utf8 to encode
5599         at least some part of the pattern, and therefore must convert the whole
5600         thing.
5601         -- dmq */
5602         DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log,
5603             "UTF8 mismatch! Converting to utf8 for resizing and compile\n"));
5604
5605         /* upgrade pattern to UTF8, and if there are code blocks,
5606          * recalculate the indices.
5607          * This is essentially an unrolled Perl_bytes_to_utf8() */
5608
5609         Newx(dst, plen * 2 + 1, U8);
5610
5611         while (s < plen) {
5612             const UV uv = NATIVE_TO_ASCII(src[s]);
5613             if (UNI_IS_INVARIANT(uv))
5614                 dst[d]   = (U8)UTF_TO_NATIVE(uv);
5615             else {
5616                 dst[d++] = (U8)UTF8_EIGHT_BIT_HI(uv);
5617                 dst[d]   = (U8)UTF8_EIGHT_BIT_LO(uv);
5618             }
5619             if (n < pRExC_state->num_code_blocks) {
5620                 if (!do_end && pRExC_state->code_blocks[n].start == s) {
5621                     pRExC_state->code_blocks[n].start = d;
5622                     assert(dst[d] == '(');
5623                     do_end = 1;
5624                 }
5625                 else if (do_end && pRExC_state->code_blocks[n].end == s) {
5626                     pRExC_state->code_blocks[n].end = d;
5627                     assert(dst[d] == ')');
5628                     do_end = 0;
5629                     n++;
5630                 }
5631             }
5632             s++;
5633             d++;
5634         }
5635         dst[d] = '\0';
5636         plen = d;
5637         exp = (char*) dst;
5638         xend = exp + plen;
5639         SAVEFREEPV(exp);
5640         RExC_orig_utf8 = RExC_utf8 = 1;
5641         }
5642     }
5643
5644     /* return old regex if pattern hasn't changed */
5645
5646     if (   old_re
5647         && !recompile
5648         && !!RX_UTF8(old_re) == !!RExC_utf8
5649         && RX_PRECOMP(old_re)
5650         && RX_PRELEN(old_re) == plen
5651         && memEQ(RX_PRECOMP(old_re), exp, plen))
5652     {
5653         /* with runtime code, always recompile */
5654         runtime_code = S_has_runtime_code(aTHX_ pRExC_state, expr, pm_flags,
5655                                             exp, plen);
5656         if (!runtime_code) {
5657             Safefree(pRExC_state->code_blocks);
5658             return old_re;
5659         }
5660     }
5661     else if ((pm_flags & PMf_USE_RE_EVAL)
5662                 /* this second condition covers the non-regex literal case,
5663                  * i.e.  $foo =~ '(?{})'. */
5664                 || ( !PL_reg_state.re_reparsing && IN_PERL_COMPILETIME
5665                     && (PL_hints & HINT_RE_EVAL))
5666     )
5667         runtime_code = S_has_runtime_code(aTHX_ pRExC_state, expr, pm_flags,
5668                             exp, plen);
5669
5670     rx_flags = orig_rx_flags;
5671
5672     if (initial_charset == REGEX_LOCALE_CHARSET) {
5673         RExC_contains_locale = 1;
5674     }
5675     else if (RExC_utf8 && initial_charset == REGEX_DEPENDS_CHARSET) {
5676
5677         /* Set to use unicode semantics if the pattern is in utf8 and has the
5678          * 'depends' charset specified, as it means unicode when utf8  */
5679         set_regex_charset(&rx_flags, REGEX_UNICODE_CHARSET);
5680     }
5681
5682     RExC_precomp = exp;
5683     RExC_flags = rx_flags;
5684     RExC_pm_flags = pm_flags;
5685
5686     if (runtime_code) {
5687         if (TAINTING_get && TAINT_get)
5688             Perl_croak(aTHX_ "Eval-group in insecure regular expression");
5689
5690         if (!S_compile_runtime_code(aTHX_ pRExC_state, exp, plen)) {
5691             /* whoops, we have a non-utf8 pattern, whilst run-time code
5692              * got compiled as utf8. Try again with a utf8 pattern */
5693             goto redo_first_pass;
5694         }
5695     }
5696     assert(!pRExC_state->runtime_code_qr);
5697
5698     RExC_sawback = 0;
5699
5700     RExC_seen = 0;
5701     RExC_in_lookbehind = 0;
5702     RExC_seen_zerolen = *exp == '^' ? -1 : 0;
5703     RExC_extralen = 0;
5704     RExC_override_recoding = 0;
5705     RExC_in_multi_char_class = 0;
5706
5707     /* First pass: determine size, legality. */
5708     RExC_parse = exp;
5709     RExC_start = exp;
5710     RExC_end = xend;
5711     RExC_naughty = 0;
5712     RExC_npar = 1;
5713     RExC_nestroot = 0;
5714     RExC_size = 0L;
5715     RExC_emit = &PL_regdummy;
5716     RExC_whilem_seen = 0;
5717     RExC_open_parens = NULL;
5718     RExC_close_parens = NULL;
5719     RExC_opend = NULL;
5720     RExC_paren_names = NULL;
5721 #ifdef DEBUGGING
5722     RExC_paren_name_list = NULL;
5723 #endif
5724     RExC_recurse = NULL;
5725     RExC_recurse_count = 0;
5726     pRExC_state->code_index = 0;
5727
5728 #if 0 /* REGC() is (currently) a NOP at the first pass.
5729        * Clever compilers notice this and complain. --jhi */
5730     REGC((U8)REG_MAGIC, (char*)RExC_emit);
5731 #endif
5732     DEBUG_PARSE_r(
5733         PerlIO_printf(Perl_debug_log, "Starting first pass (sizing)\n");
5734         RExC_lastnum=0;
5735         RExC_lastparse=NULL;
5736     );
5737     /* reg may croak on us, not giving us a chance to free
5738        pRExC_state->code_blocks.  We cannot SAVEFREEPV it now, as we may
5739        need it to survive as long as the regexp (qr/(?{})/).
5740        We must check that code_blocksv is not already set, because we may
5741        have jumped back to restart the sizing pass. */
5742     if (pRExC_state->code_blocks && !code_blocksv) {
5743         code_blocksv = newSV_type(SVt_PV);
5744         SAVEFREESV(code_blocksv);
5745         SvPV_set(code_blocksv, (char *)pRExC_state->code_blocks);
5746         SvLEN_set(code_blocksv, 1); /*sufficient to make sv_clear free it*/
5747     }
5748     if (reg(pRExC_state, 0, &flags,1) == NULL) {
5749         if (flags & RESTART_UTF8) {
5750             goto redo_first_pass;
5751         }
5752         Perl_croak(aTHX_ "panic: reg returned NULL to re_op_compile for sizing pass, flags=%#X", flags);
5753     }
5754     if (code_blocksv)
5755         SvLEN_set(code_blocksv,0); /* no you can't have it, sv_clear */
5756
5757     DEBUG_PARSE_r({
5758         PerlIO_printf(Perl_debug_log, 
5759             "Required size %"IVdf" nodes\n"
5760             "Starting second pass (creation)\n", 
5761             (IV)RExC_size);
5762         RExC_lastnum=0; 
5763         RExC_lastparse=NULL; 
5764     });
5765
5766     /* The first pass could have found things that force Unicode semantics */
5767     if ((RExC_utf8 || RExC_uni_semantics)
5768          && get_regex_charset(rx_flags) == REGEX_DEPENDS_CHARSET)
5769     {
5770         set_regex_charset(&rx_flags, REGEX_UNICODE_CHARSET);
5771     }
5772
5773     /* Small enough for pointer-storage convention?
5774        If extralen==0, this means that we will not need long jumps. */
5775     if (RExC_size >= 0x10000L && RExC_extralen)
5776         RExC_size += RExC_extralen;
5777     else
5778         RExC_extralen = 0;
5779     if (RExC_whilem_seen > 15)
5780         RExC_whilem_seen = 15;
5781
5782     /* Allocate space and zero-initialize. Note, the two step process 
5783        of zeroing when in debug mode, thus anything assigned has to 
5784        happen after that */
5785     rx = (REGEXP*) newSV_type(SVt_REGEXP);
5786     r = ReANY(rx);
5787     Newxc(ri, sizeof(regexp_internal) + (unsigned)RExC_size * sizeof(regnode),
5788          char, regexp_internal);
5789     if ( r == NULL || ri == NULL )
5790         FAIL("Regexp out of space");
5791 #ifdef DEBUGGING
5792     /* avoid reading uninitialized memory in DEBUGGING code in study_chunk() */
5793     Zero(ri, sizeof(regexp_internal) + (unsigned)RExC_size * sizeof(regnode), char);
5794 #else 
5795     /* bulk initialize base fields with 0. */
5796     Zero(ri, sizeof(regexp_internal), char);        
5797 #endif
5798
5799     /* non-zero initialization begins here */
5800     RXi_SET( r, ri );
5801     r->engine= eng;
5802     r->extflags = rx_flags;
5803     if (pm_flags & PMf_IS_QR) {
5804         ri->code_blocks = pRExC_state->code_blocks;
5805         ri->num_code_blocks = pRExC_state->num_code_blocks;
5806     }
5807     else
5808     {
5809         int n;
5810         for (n = 0; n < pRExC_state->num_code_blocks; n++)
5811             if (pRExC_state->code_blocks[n].src_regex)
5812                 SAVEFREESV(pRExC_state->code_blocks[n].src_regex);
5813         SAVEFREEPV(pRExC_state->code_blocks);
5814     }
5815
5816     {
5817         bool has_p     = ((r->extflags & RXf_PMf_KEEPCOPY) == RXf_PMf_KEEPCOPY);
5818         bool has_charset = (get_regex_charset(r->extflags) != REGEX_DEPENDS_CHARSET);
5819
5820         /* The caret is output if there are any defaults: if not all the STD
5821          * flags are set, or if no character set specifier is needed */
5822         bool has_default =
5823                     (((r->extflags & RXf_PMf_STD_PMMOD) != RXf_PMf_STD_PMMOD)
5824                     || ! has_charset);
5825         bool has_runon = ((RExC_seen & REG_SEEN_RUN_ON_COMMENT)==REG_SEEN_RUN_ON_COMMENT);
5826         U16 reganch = (U16)((r->extflags & RXf_PMf_STD_PMMOD)
5827                             >> RXf_PMf_STD_PMMOD_SHIFT);
5828         const char *fptr = STD_PAT_MODS;        /*"msix"*/
5829         char *p;
5830         /* Allocate for the worst case, which is all the std flags are turned
5831          * on.  If more precision is desired, we could do a population count of
5832          * the flags set.  This could be done with a small lookup table, or by
5833          * shifting, masking and adding, or even, when available, assembly
5834          * language for a machine-language population count.
5835          * We never output a minus, as all those are defaults, so are
5836          * covered by the caret */
5837         const STRLEN wraplen = plen + has_p + has_runon
5838             + has_default       /* If needs a caret */
5839
5840                 /* If needs a character set specifier */
5841             + ((has_charset) ? MAX_CHARSET_NAME_LENGTH : 0)
5842             + (sizeof(STD_PAT_MODS) - 1)
5843             + (sizeof("(?:)") - 1);
5844
5845         Newx(p, wraplen + 1, char); /* +1 for the ending NUL */
5846         r->xpv_len_u.xpvlenu_pv = p;
5847         if (RExC_utf8)
5848             SvFLAGS(rx) |= SVf_UTF8;
5849         *p++='('; *p++='?';
5850
5851         /* If a default, cover it using the caret */
5852         if (has_default) {
5853             *p++= DEFAULT_PAT_MOD;
5854         }
5855         if (has_charset) {
5856             STRLEN len;
5857             const char* const name = get_regex_charset_name(r->extflags, &len);
5858             Copy(name, p, len, char);
5859             p += len;
5860         }
5861         if (has_p)
5862             *p++ = KEEPCOPY_PAT_MOD; /*'p'*/
5863         {
5864             char ch;
5865             while((ch = *fptr++)) {
5866                 if(reganch & 1)
5867                     *p++ = ch;
5868                 reganch >>= 1;
5869             }
5870         }
5871
5872         *p++ = ':';
5873         Copy(RExC_precomp, p, plen, char);
5874         assert ((RX_WRAPPED(rx) - p) < 16);
5875         r->pre_prefix = p - RX_WRAPPED(rx);
5876         p += plen;
5877         if (has_runon)
5878             *p++ = '\n';
5879         *p++ = ')';
5880         *p = 0;
5881         SvCUR_set(rx, p - RX_WRAPPED(rx));
5882     }
5883
5884     r->intflags = 0;
5885     r->nparens = RExC_npar - 1; /* set early to validate backrefs */
5886     
5887     if (RExC_seen & REG_SEEN_RECURSE) {
5888         Newxz(RExC_open_parens, RExC_npar,regnode *);
5889         SAVEFREEPV(RExC_open_parens);
5890         Newxz(RExC_close_parens,RExC_npar,regnode *);
5891         SAVEFREEPV(RExC_close_parens);
5892     }
5893
5894     /* Useful during FAIL. */
5895 #ifdef RE_TRACK_PATTERN_OFFSETS
5896     Newxz(ri->u.offsets, 2*RExC_size+1, U32); /* MJD 20001228 */
5897     DEBUG_OFFSETS_r(PerlIO_printf(Perl_debug_log,
5898                           "%s %"UVuf" bytes for offset annotations.\n",
5899                           ri->u.offsets ? "Got" : "Couldn't get",
5900                           (UV)((2*RExC_size+1) * sizeof(U32))));
5901 #endif
5902     SetProgLen(ri,RExC_size);
5903     RExC_rx_sv = rx;
5904     RExC_rx = r;
5905     RExC_rxi = ri;
5906     REH_CALL_COMP_BEGIN_HOOK(pRExC_state->rx);
5907
5908     /* Second pass: emit code. */
5909     RExC_flags = rx_flags;      /* don't let top level (?i) bleed */
5910     RExC_pm_flags = pm_flags;
5911     RExC_parse = exp;
5912     RExC_end = xend;
5913     RExC_naughty = 0;
5914     RExC_npar = 1;
5915     RExC_emit_start = ri->program;
5916     RExC_emit = ri->program;
5917     RExC_emit_bound = ri->program + RExC_size + 1;
5918     pRExC_state->code_index = 0;
5919
5920     REGC((U8)REG_MAGIC, (char*) RExC_emit++);
5921     if (reg(pRExC_state, 0, &flags,1) == NULL) {
5922         ReREFCNT_dec(rx);   
5923         Perl_croak(aTHX_ "panic: reg returned NULL to re_op_compile for generation pass, flags=%#X", flags);
5924     }
5925     /* XXXX To minimize changes to RE engine we always allocate
5926        3-units-long substrs field. */
5927     Newx(r->substrs, 1, struct reg_substr_data);
5928     if (RExC_recurse_count) {
5929         Newxz(RExC_recurse,RExC_recurse_count,regnode *);
5930         SAVEFREEPV(RExC_recurse);
5931     }
5932
5933 reStudy:
5934     r->minlen = minlen = sawlookahead = sawplus = sawopen = 0;
5935     Zero(r->substrs, 1, struct reg_substr_data);
5936
5937 #ifdef TRIE_STUDY_OPT
5938     if (!restudied) {
5939         StructCopy(&zero_scan_data, &data, scan_data_t);
5940         copyRExC_state = RExC_state;
5941     } else {
5942         U32 seen=RExC_seen;
5943         DEBUG_OPTIMISE_r(PerlIO_printf(Perl_debug_log,"Restudying\n"));
5944         
5945         RExC_state = copyRExC_state;
5946         if (seen & REG_TOP_LEVEL_BRANCHES) 
5947             RExC_seen |= REG_TOP_LEVEL_BRANCHES;
5948         else
5949             RExC_seen &= ~REG_TOP_LEVEL_BRANCHES;
5950         StructCopy(&zero_scan_data, &data, scan_data_t);
5951     }
5952 #else
5953     StructCopy(&zero_scan_data, &data, scan_data_t);
5954 #endif    
5955
5956     /* Dig out information for optimizations. */
5957     r->extflags = RExC_flags; /* was pm_op */
5958     /*dmq: removed as part of de-PMOP: pm->op_pmflags = RExC_flags; */
5959  
5960     if (UTF)
5961         SvUTF8_on(rx);  /* Unicode in it? */
5962     ri->regstclass = NULL;
5963     if (RExC_naughty >= 10)     /* Probably an expensive pattern. */
5964         r->intflags |= PREGf_NAUGHTY;
5965     scan = ri->program + 1;             /* First BRANCH. */
5966
5967     /* testing for BRANCH here tells us whether there is "must appear"
5968        data in the pattern. If there is then we can use it for optimisations */
5969     if (!(RExC_seen & REG_TOP_LEVEL_BRANCHES)) { /*  Only one top-level choice. */
5970         I32 fake;
5971         STRLEN longest_float_length, longest_fixed_length;
5972         struct regnode_charclass_class ch_class; /* pointed to by data */
5973         int stclass_flag;
5974         I32 last_close = 0; /* pointed to by data */
5975         regnode *first= scan;
5976         regnode *first_next= regnext(first);
5977         /*
5978          * Skip introductions and multiplicators >= 1
5979          * so that we can extract the 'meat' of the pattern that must 
5980          * match in the large if() sequence following.
5981          * NOTE that EXACT is NOT covered here, as it is normally
5982          * picked up by the optimiser separately. 
5983          *
5984          * This is unfortunate as the optimiser isnt handling lookahead
5985          * properly currently.
5986          *
5987          */
5988         while ((OP(first) == OPEN && (sawopen = 1)) ||
5989                /* An OR of *one* alternative - should not happen now. */
5990             (OP(first) == BRANCH && OP(first_next) != BRANCH) ||
5991             /* for now we can't handle lookbehind IFMATCH*/
5992             (OP(first) == IFMATCH && !first->flags && (sawlookahead = 1)) ||
5993             (OP(first) == PLUS) ||
5994             (OP(first) == MINMOD) ||
5995                /* An {n,m} with n>0 */
5996             (PL_regkind[OP(first)] == CURLY && ARG1(first) > 0) ||
5997             (OP(first) == NOTHING && PL_regkind[OP(first_next)] != END ))
5998         {
5999                 /* 
6000                  * the only op that could be a regnode is PLUS, all the rest
6001                  * will be regnode_1 or regnode_2.
6002                  *
6003                  */
6004                 if (OP(first) == PLUS)
6005                     sawplus = 1;
6006                 else
6007                     first += regarglen[OP(first)];
6008
6009                 first = NEXTOPER(first);
6010                 first_next= regnext(first);
6011         }
6012
6013         /* Starting-point info. */
6014       again:
6015         DEBUG_PEEP("first:",first,0);
6016         /* Ignore EXACT as we deal with it later. */
6017         if (PL_regkind[OP(first)] == EXACT) {
6018             if (OP(first) == EXACT)
6019                 NOOP;   /* Empty, get anchored substr later. */
6020             else
6021                 ri->regstclass = first;
6022         }
6023 #ifdef TRIE_STCLASS
6024         else if (PL_regkind[OP(first)] == TRIE &&
6025                 ((reg_trie_data *)ri->data->data[ ARG(first) ])->minlen>0) 
6026         {
6027             regnode *trie_op;
6028             /* this can happen only on restudy */
6029             if ( OP(first) == TRIE ) {
6030                 struct regnode_1 *trieop = (struct regnode_1 *)
6031                     PerlMemShared_calloc(1, sizeof(struct regnode_1));
6032                 StructCopy(first,trieop,struct regnode_1);
6033                 trie_op=(regnode *)trieop;
6034             } else {
6035                 struct regnode_charclass *trieop = (struct regnode_charclass *)
6036                     PerlMemShared_calloc(1, sizeof(struct regnode_charclass));
6037                 StructCopy(first,trieop,struct regnode_charclass);
6038                 trie_op=(regnode *)trieop;
6039             }
6040             OP(trie_op)+=2;
6041             make_trie_failtable(pRExC_state, (regnode *)first, trie_op, 0);
6042             ri->regstclass = trie_op;
6043         }
6044 #endif
6045         else if (REGNODE_SIMPLE(OP(first)))
6046             ri->regstclass = first;
6047         else if (PL_regkind[OP(first)] == BOUND ||
6048                  PL_regkind[OP(first)] == NBOUND)
6049             ri->regstclass = first;
6050         else if (PL_regkind[OP(first)] == BOL) {
6051             r->extflags |= (OP(first) == MBOL
6052                            ? RXf_ANCH_MBOL
6053                            : (OP(first) == SBOL
6054                               ? RXf_ANCH_SBOL
6055                               : RXf_ANCH_BOL));
6056             first = NEXTOPER(first);
6057             goto again;
6058         }
6059         else if (OP(first) == GPOS) {
6060             r->extflags |= RXf_ANCH_GPOS;
6061             first = NEXTOPER(first);
6062             goto again;
6063         }
6064         else if ((!sawopen || !RExC_sawback) &&
6065             (OP(first) == STAR &&
6066             PL_regkind[OP(NEXTOPER(first))] == REG_ANY) &&
6067             !(r->extflags & RXf_ANCH) && !pRExC_state->num_code_blocks)
6068         {
6069             /* turn .* into ^.* with an implied $*=1 */
6070             const int type =
6071                 (OP(NEXTOPER(first)) == REG_ANY)
6072                     ? RXf_ANCH_MBOL
6073                     : RXf_ANCH_SBOL;
6074             r->extflags |= type;
6075             r->intflags |= PREGf_IMPLICIT;
6076             first = NEXTOPER(first);
6077             goto again;
6078         }
6079         if (sawplus && !sawlookahead && (!sawopen || !RExC_sawback)
6080             && !pRExC_state->num_code_blocks) /* May examine pos and $& */
6081             /* x+ must match at the 1st pos of run of x's */
6082             r->intflags |= PREGf_SKIP;
6083
6084         /* Scan is after the zeroth branch, first is atomic matcher. */
6085 #ifdef TRIE_STUDY_OPT
6086         DEBUG_PARSE_r(
6087             if (!restudied)
6088                 PerlIO_printf(Perl_debug_log, "first at %"IVdf"\n",
6089                               (IV)(first - scan + 1))
6090         );
6091 #else
6092         DEBUG_PARSE_r(
6093             PerlIO_printf(Perl_debug_log, "first at %"IVdf"\n",
6094                 (IV)(first - scan + 1))
6095         );
6096 #endif
6097
6098
6099         /*
6100         * If there's something expensive in the r.e., find the
6101         * longest literal string that must appear and make it the
6102         * regmust.  Resolve ties in favor of later strings, since
6103         * the regstart check works with the beginning of the r.e.
6104         * and avoiding duplication strengthens checking.  Not a
6105         * strong reason, but sufficient in the absence of others.
6106         * [Now we resolve ties in favor of the earlier string if
6107         * it happens that c_offset_min has been invalidated, since the
6108         * earlier string may buy us something the later one won't.]
6109         */
6110
6111         data.longest_fixed = newSVpvs("");
6112         data.longest_float = newSVpvs("");
6113         data.last_found = newSVpvs("");
6114         data.longest = &(data.longest_fixed);
6115         ENTER_with_name("study_chunk");
6116         SAVEFREESV(data.longest_fixed);
6117         SAVEFREESV(data.longest_float);
6118         SAVEFREESV(data.last_found);
6119         first = scan;
6120         if (!ri->regstclass) {
6121             cl_init(pRExC_state, &ch_class);
6122             data.start_class = &ch_class;
6123             stclass_flag = SCF_DO_STCLASS_AND;
6124         } else                          /* XXXX Check for BOUND? */
6125             stclass_flag = 0;
6126         data.last_closep = &last_close;
6127         
6128         minlen = study_chunk(pRExC_state, &first, &minlen, &fake, scan + RExC_size, /* Up to end */
6129             &data, -1, NULL, NULL,
6130             SCF_DO_SUBSTR | SCF_WHILEM_VISITED_POS | stclass_flag,0);
6131
6132
6133         CHECK_RESTUDY_GOTO_butfirst(LEAVE_with_name("study_chunk"));
6134
6135
6136         if ( RExC_npar == 1 && data.longest == &(data.longest_fixed)
6137              && data.last_start_min == 0 && data.last_end > 0
6138              && !RExC_seen_zerolen
6139              && !(RExC_seen & REG_SEEN_VERBARG)
6140              && (!(RExC_seen & REG_SEEN_GPOS) || (r->extflags & RXf_ANCH_GPOS)))
6141             r->extflags |= RXf_CHECK_ALL;
6142         scan_commit(pRExC_state, &data,&minlen,0);
6143
6144         longest_float_length = CHR_SVLEN(data.longest_float);
6145
6146         if (! ((SvCUR(data.longest_fixed)  /* ok to leave SvCUR */
6147                    && data.offset_fixed == data.offset_float_min
6148                    && SvCUR(data.longest_fixed) == SvCUR(data.longest_float)))
6149             && S_setup_longest (aTHX_ pRExC_state,
6150                                     data.longest_float,
6151                                     &(r->float_utf8),
6152                                     &(r->float_substr),
6153                                     &(r->float_end_shift),
6154                                     data.lookbehind_float,
6155                                     data.offset_float_min,
6156                                     data.minlen_float,
6157                                     longest_float_length,
6158                                     cBOOL(data.flags & SF_FL_BEFORE_EOL),
6159                                     cBOOL(data.flags & SF_FL_BEFORE_MEOL)))
6160         {
6161             r->float_min_offset = data.offset_float_min - data.lookbehind_float;
6162             r->float_max_offset = data.offset_float_max;
6163             if (data.offset_float_max < I32_MAX) /* Don't offset infinity */
6164                 r->float_max_offset -= data.lookbehind_float;
6165             SvREFCNT_inc_simple_void_NN(data.longest_float);
6166         }
6167         else {
6168             r->float_substr = r->float_utf8 = NULL;
6169             longest_float_length = 0;
6170         }
6171
6172         longest_fixed_length = CHR_SVLEN(data.longest_fixed);
6173
6174         if (S_setup_longest (aTHX_ pRExC_state,
6175                                 data.longest_fixed,
6176                                 &(r->anchored_utf8),
6177                                 &(r->anchored_substr),
6178                                 &(r->anchored_end_shift),
6179                                 data.lookbehind_fixed,
6180                                 data.offset_fixed,
6181                                 data.minlen_fixed,
6182                                 longest_fixed_length,
6183                                 cBOOL(data.flags & SF_FIX_BEFORE_EOL),
6184                                 cBOOL(data.flags & SF_FIX_BEFORE_MEOL)))
6185         {
6186             r->anchored_offset = data.offset_fixed - data.lookbehind_fixed;
6187             SvREFCNT_inc_simple_void_NN(data.longest_fixed);
6188         }
6189         else {
6190             r->anchored_substr = r->anchored_utf8 = NULL;
6191             longest_fixed_length = 0;
6192         }
6193         LEAVE_with_name("study_chunk");
6194
6195         if (ri->regstclass
6196             && (OP(ri->regstclass) == REG_ANY || OP(ri->regstclass) == SANY))
6197             ri->regstclass = NULL;
6198
6199         if ((!(r->anchored_substr || r->anchored_utf8) || r->anchored_offset)
6200             && stclass_flag
6201             && ! TEST_SSC_EOS(data.start_class)
6202             && !cl_is_anything(data.start_class))
6203         {
6204             const U32 n = add_data(pRExC_state, 1, "f");
6205             OP(data.start_class) = ANYOF_SYNTHETIC;
6206
6207             Newx(RExC_rxi->data->data[n], 1,
6208                 struct regnode_charclass_class);
6209             StructCopy(data.start_class,
6210                        (struct regnode_charclass_class*)RExC_rxi->data->data[n],
6211                        struct regnode_charclass_class);
6212             ri->regstclass = (regnode*)RExC_rxi->data->data[n];
6213             r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
6214             DEBUG_COMPILE_r({ SV *sv = sv_newmortal();
6215                       regprop(r, sv, (regnode*)data.start_class);
6216                       PerlIO_printf(Perl_debug_log,
6217                                     "synthetic stclass \"%s\".\n",
6218                                     SvPVX_const(sv));});
6219         }
6220
6221         /* A temporary algorithm prefers floated substr to fixed one to dig more info. */
6222         if (longest_fixed_length > longest_float_length) {
6223             r->check_end_shift = r->anchored_end_shift;
6224             r->check_substr = r->anchored_substr;
6225             r->check_utf8 = r->anchored_utf8;
6226             r->check_offset_min = r->check_offset_max = r->anchored_offset;
6227             if (r->extflags & RXf_ANCH_SINGLE)
6228                 r->extflags |= RXf_NOSCAN;
6229         }
6230         else {
6231             r->check_end_shift = r->float_end_shift;
6232             r->check_substr = r->float_substr;
6233             r->check_utf8 = r->float_utf8;
6234             r->check_offset_min = r->float_min_offset;
6235             r->check_offset_max = r->float_max_offset;
6236         }
6237         /* XXXX Currently intuiting is not compatible with ANCH_GPOS.
6238            This should be changed ASAP!  */
6239         if ((r->check_substr || r->check_utf8) && !(r->extflags & RXf_ANCH_GPOS)) {
6240             r->extflags |= RXf_USE_INTUIT;
6241             if (SvTAIL(r->check_substr ? r->check_substr : r->check_utf8))
6242                 r->extflags |= RXf_INTUIT_TAIL;
6243         }
6244         /* XXX Unneeded? dmq (shouldn't as this is handled elsewhere)
6245         if ( (STRLEN)minlen < longest_float_length )
6246             minlen= longest_float_length;
6247         if ( (STRLEN)minlen < longest_fixed_length )
6248             minlen= longest_fixed_length;     
6249         */
6250     }
6251     else {
6252         /* Several toplevels. Best we can is to set minlen. */
6253         I32 fake;
6254         struct regnode_charclass_class ch_class;
6255         I32 last_close = 0;
6256
6257         DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log, "\nMulti Top Level\n"));
6258
6259         scan = ri->program + 1;
6260         cl_init(pRExC_state, &ch_class);
6261         data.start_class = &ch_class;
6262         data.last_closep = &last_close;
6263
6264         
6265         minlen = study_chunk(pRExC_state, &scan, &minlen, &fake, scan + RExC_size,
6266             &data, -1, NULL, NULL, SCF_DO_STCLASS_AND|SCF_WHILEM_VISITED_POS,0);
6267         
6268         CHECK_RESTUDY_GOTO_butfirst(NOOP);
6269
6270         r->check_substr = r->check_utf8 = r->anchored_substr = r->anchored_utf8
6271                 = r->float_substr = r->float_utf8 = NULL;
6272
6273         if (! TEST_SSC_EOS(data.start_class)
6274             && !cl_is_anything(data.start_class))
6275         {
6276             const U32 n = add_data(pRExC_state, 1, "f");
6277             OP(data.start_class) = ANYOF_SYNTHETIC;
6278
6279             Newx(RExC_rxi->data->data[n], 1,
6280                 struct regnode_charclass_class);
6281             StructCopy(data.start_class,
6282                        (struct regnode_charclass_class*)RExC_rxi->data->data[n],
6283                        struct regnode_charclass_class);
6284             ri->regstclass = (regnode*)RExC_rxi->data->data[n];
6285             r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
6286             DEBUG_COMPILE_r({ SV* sv = sv_newmortal();
6287                       regprop(r, sv, (regnode*)data.start_class);
6288                       PerlIO_printf(Perl_debug_log,
6289                                     "synthetic stclass \"%s\".\n",
6290                                     SvPVX_const(sv));});
6291         }
6292     }
6293
6294     /* Guard against an embedded (?=) or (?<=) with a longer minlen than
6295        the "real" pattern. */
6296     DEBUG_OPTIMISE_r({
6297         PerlIO_printf(Perl_debug_log,"minlen: %"IVdf" r->minlen:%"IVdf"\n",
6298                       (IV)minlen, (IV)r->minlen);
6299     });
6300     r->minlenret = minlen;
6301     if (r->minlen < minlen) 
6302         r->minlen = minlen;
6303     
6304     if (RExC_seen & REG_SEEN_GPOS)
6305         r->extflags |= RXf_GPOS_SEEN;
6306     if (RExC_seen & REG_SEEN_LOOKBEHIND)
6307         r->extflags |= RXf_LOOKBEHIND_SEEN;
6308     if (pRExC_state->num_code_blocks)
6309         r->extflags |= RXf_EVAL_SEEN;
6310     if (RExC_seen & REG_SEEN_CANY)
6311         r->extflags |= RXf_CANY_SEEN;
6312     if (RExC_seen & REG_SEEN_VERBARG)
6313     {
6314         r->intflags |= PREGf_VERBARG_SEEN;
6315         r->extflags |= RXf_MODIFIES_VARS;
6316     }
6317     if (RExC_seen & REG_SEEN_CUTGROUP)
6318         r->intflags |= PREGf_CUTGROUP_SEEN;
6319     if (pm_flags & PMf_USE_RE_EVAL)
6320         r->intflags |= PREGf_USE_RE_EVAL;
6321     if (RExC_paren_names)
6322         RXp_PAREN_NAMES(r) = MUTABLE_HV(SvREFCNT_inc(RExC_paren_names));
6323     else
6324         RXp_PAREN_NAMES(r) = NULL;
6325
6326 #ifdef STUPID_PATTERN_CHECKS            
6327     if (RX_PRELEN(rx) == 0)
6328         r->extflags |= RXf_NULL;
6329     if (RX_PRELEN(rx) == 3 && memEQ("\\s+", RX_PRECOMP(rx), 3))
6330         r->extflags |= RXf_WHITE;
6331     else if (RX_PRELEN(rx) == 1 && RXp_PRECOMP(rx)[0] == '^')
6332         r->extflags |= RXf_START_ONLY;
6333 #else
6334     {
6335         regnode *first = ri->program + 1;
6336         U8 fop = OP(first);
6337
6338         if (PL_regkind[fop] == NOTHING && OP(NEXTOPER(first)) == END)
6339             r->extflags |= RXf_NULL;
6340         else if (PL_regkind[fop] == BOL && OP(NEXTOPER(first)) == END)
6341             r->extflags |= RXf_START_ONLY;
6342         else if (fop == PLUS && PL_regkind[OP(NEXTOPER(first))] == POSIXD && FLAGS(NEXTOPER(first)) == _CC_SPACE
6343                              && OP(regnext(first)) == END)
6344             r->extflags |= RXf_WHITE;    
6345     }
6346 #endif
6347 #ifdef DEBUGGING
6348     if (RExC_paren_names) {
6349         ri->name_list_idx = add_data( pRExC_state, 1, "a" );
6350         ri->data->data[ri->name_list_idx] = (void*)SvREFCNT_inc(RExC_paren_name_list);
6351     } else
6352 #endif
6353         ri->name_list_idx = 0;
6354
6355     if (RExC_recurse_count) {
6356         for ( ; RExC_recurse_count ; RExC_recurse_count-- ) {
6357             const regnode *scan = RExC_recurse[RExC_recurse_count-1];
6358             ARG2L_SET( scan, RExC_open_parens[ARG(scan)-1] - scan );
6359         }
6360     }
6361     Newxz(r->offs, RExC_npar, regexp_paren_pair);
6362     /* assume we don't need to swap parens around before we match */
6363
6364     DEBUG_DUMP_r({
6365         PerlIO_printf(Perl_debug_log,"Final program:\n");
6366         regdump(r);
6367     });
6368 #ifdef RE_TRACK_PATTERN_OFFSETS
6369     DEBUG_OFFSETS_r(if (ri->u.offsets) {
6370         const U32 len = ri->u.offsets[0];
6371         U32 i;
6372         GET_RE_DEBUG_FLAGS_DECL;
6373         PerlIO_printf(Perl_debug_log, "Offsets: [%"UVuf"]\n\t", (UV)ri->u.offsets[0]);
6374         for (i = 1; i <= len; i++) {
6375             if (ri->u.offsets[i*2-1] || ri->u.offsets[i*2])
6376                 PerlIO_printf(Perl_debug_log, "%"UVuf":%"UVuf"[%"UVuf"] ",
6377                 (UV)i, (UV)ri->u.offsets[i*2-1], (UV)ri->u.offsets[i*2]);
6378             }
6379         PerlIO_printf(Perl_debug_log, "\n");
6380     });
6381 #endif
6382
6383 #ifdef USE_ITHREADS
6384     /* under ithreads the ?pat? PMf_USED flag on the pmop is simulated
6385      * by setting the regexp SV to readonly-only instead. If the
6386      * pattern's been recompiled, the USEDness should remain. */
6387     if (old_re && SvREADONLY(old_re))
6388         SvREADONLY_on(rx);
6389 #endif
6390     return rx;
6391 }
6392
6393
6394 SV*
6395 Perl_reg_named_buff(pTHX_ REGEXP * const rx, SV * const key, SV * const value,
6396                     const U32 flags)
6397 {
6398     PERL_ARGS_ASSERT_REG_NAMED_BUFF;
6399
6400     PERL_UNUSED_ARG(value);
6401
6402     if (flags & RXapif_FETCH) {
6403         return reg_named_buff_fetch(rx, key, flags);
6404     } else if (flags & (RXapif_STORE | RXapif_DELETE | RXapif_CLEAR)) {
6405         Perl_croak_no_modify();
6406         return NULL;
6407     } else if (flags & RXapif_EXISTS) {
6408         return reg_named_buff_exists(rx, key, flags)
6409             ? &PL_sv_yes
6410             : &PL_sv_no;
6411     } else if (flags & RXapif_REGNAMES) {
6412         return reg_named_buff_all(rx, flags);
6413     } else if (flags & (RXapif_SCALAR | RXapif_REGNAMES_COUNT)) {
6414         return reg_named_buff_scalar(rx, flags);
6415     } else {
6416         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff", (int)flags);
6417         return NULL;
6418     }
6419 }
6420
6421 SV*
6422 Perl_reg_named_buff_iter(pTHX_ REGEXP * const rx, const SV * const lastkey,
6423                          const U32 flags)
6424 {
6425     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ITER;
6426     PERL_UNUSED_ARG(lastkey);
6427
6428     if (flags & RXapif_FIRSTKEY)
6429         return reg_named_buff_firstkey(rx, flags);
6430     else if (flags & RXapif_NEXTKEY)
6431         return reg_named_buff_nextkey(rx, flags);
6432     else {
6433         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_iter", (int)flags);
6434         return NULL;
6435     }
6436 }
6437
6438 SV*
6439 Perl_reg_named_buff_fetch(pTHX_ REGEXP * const r, SV * const namesv,
6440                           const U32 flags)
6441 {
6442     AV *retarray = NULL;
6443     SV *ret;
6444     struct regexp *const rx = ReANY(r);
6445
6446     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FETCH;
6447
6448     if (flags & RXapif_ALL)
6449         retarray=newAV();
6450
6451     if (rx && RXp_PAREN_NAMES(rx)) {
6452         HE *he_str = hv_fetch_ent( RXp_PAREN_NAMES(rx), namesv, 0, 0 );
6453         if (he_str) {
6454             IV i;
6455             SV* sv_dat=HeVAL(he_str);
6456             I32 *nums=(I32*)SvPVX(sv_dat);
6457             for ( i=0; i<SvIVX(sv_dat); i++ ) {
6458                 if ((I32)(rx->nparens) >= nums[i]
6459                     && rx->offs[nums[i]].start != -1
6460                     && rx->offs[nums[i]].end != -1)
6461                 {
6462                     ret = newSVpvs("");
6463                     CALLREG_NUMBUF_FETCH(r,nums[i],ret);
6464                     if (!retarray)
6465                         return ret;
6466                 } else {
6467                     if (retarray)
6468                         ret = newSVsv(&PL_sv_undef);
6469                 }
6470                 if (retarray)
6471                     av_push(retarray, ret);
6472             }
6473             if (retarray)
6474                 return newRV_noinc(MUTABLE_SV(retarray));
6475         }
6476     }
6477     return NULL;
6478 }
6479
6480 bool
6481 Perl_reg_named_buff_exists(pTHX_ REGEXP * const r, SV * const key,
6482                            const U32 flags)
6483 {
6484     struct regexp *const rx = ReANY(r);
6485
6486     PERL_ARGS_ASSERT_REG_NAMED_BUFF_EXISTS;
6487
6488     if (rx && RXp_PAREN_NAMES(rx)) {
6489         if (flags & RXapif_ALL) {
6490             return hv_exists_ent(RXp_PAREN_NAMES(rx), key, 0);
6491         } else {
6492             SV *sv = CALLREG_NAMED_BUFF_FETCH(r, key, flags);
6493             if (sv) {
6494                 SvREFCNT_dec_NN(sv);
6495                 return TRUE;
6496             } else {
6497                 return FALSE;
6498             }
6499         }
6500     } else {
6501         return FALSE;
6502     }
6503 }
6504
6505 SV*
6506 Perl_reg_named_buff_firstkey(pTHX_ REGEXP * const r, const U32 flags)
6507 {
6508     struct regexp *const rx = ReANY(r);
6509
6510     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FIRSTKEY;
6511
6512     if ( rx && RXp_PAREN_NAMES(rx) ) {
6513         (void)hv_iterinit(RXp_PAREN_NAMES(rx));
6514
6515         return CALLREG_NAMED_BUFF_NEXTKEY(r, NULL, flags & ~RXapif_FIRSTKEY);
6516     } else {
6517         return FALSE;
6518     }
6519 }
6520
6521 SV*
6522 Perl_reg_named_buff_nextkey(pTHX_ REGEXP * const r, const U32 flags)
6523 {
6524     struct regexp *const rx = ReANY(r);
6525     GET_RE_DEBUG_FLAGS_DECL;
6526
6527     PERL_ARGS_ASSERT_REG_NAMED_BUFF_NEXTKEY;
6528
6529     if (rx && RXp_PAREN_NAMES(rx)) {
6530         HV *hv = RXp_PAREN_NAMES(rx);
6531         HE *temphe;
6532         while ( (temphe = hv_iternext_flags(hv,0)) ) {
6533             IV i;
6534             IV parno = 0;
6535             SV* sv_dat = HeVAL(temphe);
6536             I32 *nums = (I32*)SvPVX(sv_dat);
6537             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
6538                 if ((I32)(rx->lastparen) >= nums[i] &&
6539                     rx->offs[nums[i]].start != -1 &&
6540                     rx->offs[nums[i]].end != -1)
6541                 {
6542                     parno = nums[i];
6543                     break;
6544                 }
6545             }
6546             if (parno || flags & RXapif_ALL) {
6547                 return newSVhek(HeKEY_hek(temphe));
6548             }
6549         }
6550     }
6551     return NULL;
6552 }
6553
6554 SV*
6555 Perl_reg_named_buff_scalar(pTHX_ REGEXP * const r, const U32 flags)
6556 {
6557     SV *ret;
6558     AV *av;
6559     I32 length;
6560     struct regexp *const rx = ReANY(r);
6561
6562     PERL_ARGS_ASSERT_REG_NAMED_BUFF_SCALAR;
6563
6564     if (rx && RXp_PAREN_NAMES(rx)) {
6565         if (flags & (RXapif_ALL | RXapif_REGNAMES_COUNT)) {
6566             return newSViv(HvTOTALKEYS(RXp_PAREN_NAMES(rx)));
6567         } else if (flags & RXapif_ONE) {
6568             ret = CALLREG_NAMED_BUFF_ALL(r, (flags | RXapif_REGNAMES));
6569             av = MUTABLE_AV(SvRV(ret));
6570             length = av_len(av);
6571             SvREFCNT_dec_NN(ret);
6572             return newSViv(length + 1);
6573         } else {
6574             Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_scalar", (int)flags);
6575             return NULL;
6576         }
6577     }
6578     return &PL_sv_undef;
6579 }
6580
6581 SV*
6582 Perl_reg_named_buff_all(pTHX_ REGEXP * const r, const U32 flags)
6583 {
6584     struct regexp *const rx = ReANY(r);
6585     AV *av = newAV();
6586
6587     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ALL;
6588
6589     if (rx && RXp_PAREN_NAMES(rx)) {
6590         HV *hv= RXp_PAREN_NAMES(rx);
6591         HE *temphe;
6592         (void)hv_iterinit(hv);
6593         while ( (temphe = hv_iternext_flags(hv,0)) ) {
6594             IV i;
6595             IV parno = 0;
6596             SV* sv_dat = HeVAL(temphe);
6597             I32 *nums = (I32*)SvPVX(sv_dat);
6598             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
6599                 if ((I32)(rx->lastparen) >= nums[i] &&
6600                     rx->offs[nums[i]].start != -1 &&
6601                     rx->offs[nums[i]].end != -1)
6602                 {
6603                     parno = nums[i];
6604                     break;
6605                 }
6606             }
6607             if (parno || flags & RXapif_ALL) {
6608                 av_push(av, newSVhek(HeKEY_hek(temphe)));
6609             }
6610         }
6611     }
6612
6613     return newRV_noinc(MUTABLE_SV(av));
6614 }
6615
6616 void
6617 Perl_reg_numbered_buff_fetch(pTHX_ REGEXP * const r, const I32 paren,
6618                              SV * const sv)
6619 {
6620     struct regexp *const rx = ReANY(r);
6621     char *s = NULL;
6622     I32 i = 0;
6623     I32 s1, t1;
6624     I32 n = paren;
6625
6626     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_FETCH;
6627         
6628     if ( (    n == RX_BUFF_IDX_CARET_PREMATCH
6629            || n == RX_BUFF_IDX_CARET_FULLMATCH
6630            || n == RX_BUFF_IDX_CARET_POSTMATCH
6631          )
6632          && !(rx->extflags & RXf_PMf_KEEPCOPY)
6633     )
6634         goto ret_undef;
6635
6636     if (!rx->subbeg)
6637         goto ret_undef;
6638
6639     if (n == RX_BUFF_IDX_CARET_FULLMATCH)
6640         /* no need to distinguish between them any more */
6641         n = RX_BUFF_IDX_FULLMATCH;
6642
6643     if ((n == RX_BUFF_IDX_PREMATCH || n == RX_BUFF_IDX_CARET_PREMATCH)
6644         && rx->offs[0].start != -1)
6645     {
6646         /* $`, ${^PREMATCH} */
6647         i = rx->offs[0].start;
6648         s = rx->subbeg;
6649     }
6650     else 
6651     if ((n == RX_BUFF_IDX_POSTMATCH || n == RX_BUFF_IDX_CARET_POSTMATCH)
6652         && rx->offs[0].end != -1)
6653     {
6654         /* $', ${^POSTMATCH} */
6655         s = rx->subbeg - rx->suboffset + rx->offs[0].end;
6656         i = rx->sublen + rx->suboffset - rx->offs[0].end;
6657     } 
6658     else
6659     if ( 0 <= n && n <= (I32)rx->nparens &&
6660         (s1 = rx->offs[n].start) != -1 &&
6661         (t1 = rx->offs[n].end) != -1)
6662     {
6663         /* $&, ${^MATCH},  $1 ... */
6664         i = t1 - s1;
6665         s = rx->subbeg + s1 - rx->suboffset;
6666     } else {
6667         goto ret_undef;
6668     }          
6669
6670     assert(s >= rx->subbeg);
6671     assert(rx->sublen >= (s - rx->subbeg) + i );
6672     if (i >= 0) {
6673 #if NO_TAINT_SUPPORT
6674         sv_setpvn(sv, s, i);
6675 #else
6676         const int oldtainted = TAINT_get;
6677         TAINT_NOT;
6678         sv_setpvn(sv, s, i);
6679         TAINT_set(oldtainted);
6680 #endif
6681         if ( (rx->extflags & RXf_CANY_SEEN)
6682             ? (RXp_MATCH_UTF8(rx)
6683                         && (!i || is_utf8_string((U8*)s, i)))
6684             : (RXp_MATCH_UTF8(rx)) )
6685         {
6686             SvUTF8_on(sv);
6687         }
6688         else
6689             SvUTF8_off(sv);
6690         if (TAINTING_get) {
6691             if (RXp_MATCH_TAINTED(rx)) {
6692                 if (SvTYPE(sv) >= SVt_PVMG) {
6693                     MAGIC* const mg = SvMAGIC(sv);
6694                     MAGIC* mgt;
6695                     TAINT;
6696                     SvMAGIC_set(sv, mg->mg_moremagic);
6697                     SvTAINT(sv);
6698                     if ((mgt = SvMAGIC(sv))) {
6699                         mg->mg_moremagic = mgt;
6700                         SvMAGIC_set(sv, mg);
6701                     }
6702                 } else {
6703                     TAINT;
6704                     SvTAINT(sv);
6705                 }
6706             } else 
6707                 SvTAINTED_off(sv);
6708         }
6709     } else {
6710       ret_undef:
6711         sv_setsv(sv,&PL_sv_undef);
6712         return;
6713     }
6714 }
6715
6716 void
6717 Perl_reg_numbered_buff_store(pTHX_ REGEXP * const rx, const I32 paren,
6718                                                          SV const * const value)
6719 {
6720     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_STORE;
6721
6722     PERL_UNUSED_ARG(rx);
6723     PERL_UNUSED_ARG(paren);
6724     PERL_UNUSED_ARG(value);
6725
6726     if (!PL_localizing)
6727         Perl_croak_no_modify();
6728 }
6729
6730 I32
6731 Perl_reg_numbered_buff_length(pTHX_ REGEXP * const r, const SV * const sv,
6732                               const I32 paren)
6733 {
6734     struct regexp *const rx = ReANY(r);
6735     I32 i;
6736     I32 s1, t1;
6737
6738     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_LENGTH;
6739
6740     /* Some of this code was originally in C<Perl_magic_len> in F<mg.c> */
6741     switch (paren) {
6742       case RX_BUFF_IDX_CARET_PREMATCH: /* ${^PREMATCH} */
6743          if (!(rx->extflags & RXf_PMf_KEEPCOPY))
6744             goto warn_undef;
6745         /*FALLTHROUGH*/
6746
6747       case RX_BUFF_IDX_PREMATCH:       /* $` */
6748         if (rx->offs[0].start != -1) {
6749                         i = rx->offs[0].start;
6750                         if (i > 0) {
6751                                 s1 = 0;
6752                                 t1 = i;
6753                                 goto getlen;
6754                         }
6755             }
6756         return 0;
6757
6758       case RX_BUFF_IDX_CARET_POSTMATCH: /* ${^POSTMATCH} */
6759          if (!(rx->extflags & RXf_PMf_KEEPCOPY))
6760             goto warn_undef;
6761       case RX_BUFF_IDX_POSTMATCH:       /* $' */
6762             if (rx->offs[0].end != -1) {
6763                         i = rx->sublen - rx->offs[0].end;
6764                         if (i > 0) {
6765                                 s1 = rx->offs[0].end;
6766                                 t1 = rx->sublen;
6767                                 goto getlen;
6768                         }
6769             }
6770         return 0;
6771
6772       case RX_BUFF_IDX_CARET_FULLMATCH: /* ${^MATCH} */
6773          if (!(rx->extflags & RXf_PMf_KEEPCOPY))
6774             goto warn_undef;
6775         /*FALLTHROUGH*/
6776
6777       /* $& / ${^MATCH}, $1, $2, ... */
6778       default:
6779             if (paren <= (I32)rx->nparens &&
6780             (s1 = rx->offs[paren].start) != -1 &&
6781             (t1 = rx->offs[paren].end) != -1)
6782             {
6783             i = t1 - s1;
6784             goto getlen;
6785         } else {
6786           warn_undef:
6787             if (ckWARN(WARN_UNINITIALIZED))
6788                 report_uninit((const SV *)sv);
6789             return 0;
6790         }
6791     }
6792   getlen:
6793     if (i > 0 && RXp_MATCH_UTF8(rx)) {
6794         const char * const s = rx->subbeg - rx->suboffset + s1;
6795         const U8 *ep;
6796         STRLEN el;
6797
6798         i = t1 - s1;
6799         if (is_utf8_string_loclen((U8*)s, i, &ep, &el))
6800                         i = el;
6801     }
6802     return i;
6803 }
6804
6805 SV*
6806 Perl_reg_qr_package(pTHX_ REGEXP * const rx)
6807 {
6808     PERL_ARGS_ASSERT_REG_QR_PACKAGE;
6809         PERL_UNUSED_ARG(rx);
6810         if (0)
6811             return NULL;
6812         else
6813             return newSVpvs("Regexp");
6814 }
6815
6816 /* Scans the name of a named buffer from the pattern.
6817  * If flags is REG_RSN_RETURN_NULL returns null.
6818  * If flags is REG_RSN_RETURN_NAME returns an SV* containing the name
6819  * If flags is REG_RSN_RETURN_DATA returns the data SV* corresponding
6820  * to the parsed name as looked up in the RExC_paren_names hash.
6821  * If there is an error throws a vFAIL().. type exception.
6822  */
6823
6824 #define REG_RSN_RETURN_NULL    0
6825 #define REG_RSN_RETURN_NAME    1
6826 #define REG_RSN_RETURN_DATA    2
6827
6828 STATIC SV*
6829 S_reg_scan_name(pTHX_ RExC_state_t *pRExC_state, U32 flags)
6830 {
6831     char *name_start = RExC_parse;
6832
6833     PERL_ARGS_ASSERT_REG_SCAN_NAME;
6834
6835     if (isIDFIRST_lazy_if(RExC_parse, UTF)) {
6836          /* skip IDFIRST by using do...while */
6837         if (UTF)
6838             do {
6839                 RExC_parse += UTF8SKIP(RExC_parse);
6840             } while (isWORDCHAR_utf8((U8*)RExC_parse));
6841         else
6842             do {
6843                 RExC_parse++;
6844             } while (isWORDCHAR(*RExC_parse));
6845     } else {
6846         RExC_parse++; /* so the <- from the vFAIL is after the offending character */
6847         vFAIL("Group name must start with a non-digit word character");
6848     }
6849     if ( flags ) {
6850         SV* sv_name
6851             = newSVpvn_flags(name_start, (int)(RExC_parse - name_start),
6852                              SVs_TEMP | (UTF ? SVf_UTF8 : 0));
6853         if ( flags == REG_RSN_RETURN_NAME)
6854             return sv_name;
6855         else if (flags==REG_RSN_RETURN_DATA) {
6856             HE *he_str = NULL;
6857             SV *sv_dat = NULL;
6858             if ( ! sv_name )      /* should not happen*/
6859                 Perl_croak(aTHX_ "panic: no svname in reg_scan_name");
6860             if (RExC_paren_names)
6861                 he_str = hv_fetch_ent( RExC_paren_names, sv_name, 0, 0 );
6862             if ( he_str )
6863                 sv_dat = HeVAL(he_str);
6864             if ( ! sv_dat )
6865                 vFAIL("Reference to nonexistent named group");
6866             return sv_dat;
6867         }
6868         else {
6869             Perl_croak(aTHX_ "panic: bad flag %lx in reg_scan_name",
6870                        (unsigned long) flags);
6871         }
6872         assert(0); /* NOT REACHED */
6873     }
6874     return NULL;
6875 }
6876
6877 #define DEBUG_PARSE_MSG(funcname)     DEBUG_PARSE_r({           \
6878     int rem=(int)(RExC_end - RExC_parse);                       \
6879     int cut;                                                    \
6880     int num;                                                    \
6881     int iscut=0;                                                \
6882     if (rem>10) {                                               \
6883         rem=10;                                                 \
6884         iscut=1;                                                \
6885     }                                                           \
6886     cut=10-rem;                                                 \
6887     if (RExC_lastparse!=RExC_parse)                             \
6888         PerlIO_printf(Perl_debug_log," >%.*s%-*s",              \
6889             rem, RExC_parse,                                    \
6890             cut + 4,                                            \
6891             iscut ? "..." : "<"                                 \
6892         );                                                      \
6893     else                                                        \
6894         PerlIO_printf(Perl_debug_log,"%16s","");                \
6895                                                                 \
6896     if (SIZE_ONLY)                                              \
6897        num = RExC_size + 1;                                     \
6898     else                                                        \
6899        num=REG_NODE_NUM(RExC_emit);                             \
6900     if (RExC_lastnum!=num)                                      \
6901        PerlIO_printf(Perl_debug_log,"|%4d",num);                \
6902     else                                                        \
6903        PerlIO_printf(Perl_debug_log,"|%4s","");                 \
6904     PerlIO_printf(Perl_debug_log,"|%*s%-4s",                    \
6905         (int)((depth*2)), "",                                   \
6906         (funcname)                                              \
6907     );                                                          \
6908     RExC_lastnum=num;                                           \
6909     RExC_lastparse=RExC_parse;                                  \
6910 })
6911
6912
6913
6914 #define DEBUG_PARSE(funcname)     DEBUG_PARSE_r({           \
6915     DEBUG_PARSE_MSG((funcname));                            \
6916     PerlIO_printf(Perl_debug_log,"%4s","\n");               \
6917 })
6918 #define DEBUG_PARSE_FMT(funcname,fmt,args)     DEBUG_PARSE_r({           \
6919     DEBUG_PARSE_MSG((funcname));                            \
6920     PerlIO_printf(Perl_debug_log,fmt "\n",args);               \
6921 })
6922
6923 /* This section of code defines the inversion list object and its methods.  The
6924  * interfaces are highly subject to change, so as much as possible is static to
6925  * this file.  An inversion list is here implemented as a malloc'd C UV array
6926  * with some added info that is placed as UVs at the beginning in a header
6927  * portion.  An inversion list for Unicode is an array of code points, sorted
6928  * by ordinal number.  The zeroth element is the first code point in the list.
6929  * The 1th element is the first element beyond that not in the list.  In other
6930  * words, the first range is
6931  *  invlist[0]..(invlist[1]-1)
6932  * The other ranges follow.  Thus every element whose index is divisible by two
6933  * marks the beginning of a range that is in the list, and every element not
6934  * divisible by two marks the beginning of a range not in the list.  A single
6935  * element inversion list that contains the single code point N generally
6936  * consists of two elements
6937  *  invlist[0] == N
6938  *  invlist[1] == N+1
6939  * (The exception is when N is the highest representable value on the
6940  * machine, in which case the list containing just it would be a single
6941  * element, itself.  By extension, if the last range in the list extends to
6942  * infinity, then the first element of that range will be in the inversion list
6943  * at a position that is divisible by two, and is the final element in the
6944  * list.)
6945  * Taking the complement (inverting) an inversion list is quite simple, if the
6946  * first element is 0, remove it; otherwise add a 0 element at the beginning.
6947  * This implementation reserves an element at the beginning of each inversion
6948  * list to contain 0 when the list contains 0, and contains 1 otherwise.  The
6949  * actual beginning of the list is either that element if 0, or the next one if
6950  * 1.
6951  *
6952  * More about inversion lists can be found in "Unicode Demystified"
6953  * Chapter 13 by Richard Gillam, published by Addison-Wesley.
6954  * More will be coming when functionality is added later.
6955  *
6956  * The inversion list data structure is currently implemented as an SV pointing
6957  * to an array of UVs that the SV thinks are bytes.  This allows us to have an
6958  * array of UV whose memory management is automatically handled by the existing
6959  * facilities for SV's.
6960  *
6961  * Some of the methods should always be private to the implementation, and some
6962  * should eventually be made public */
6963
6964 /* The header definitions are in F<inline_invlist.c> */
6965 #define TO_INTERNAL_SIZE(x) (((x) + HEADER_LENGTH) * sizeof(UV))
6966 #define FROM_INTERNAL_SIZE(x) (((x)/ sizeof(UV)) - HEADER_LENGTH)
6967
6968 #define INVLIST_INITIAL_LEN 10
6969
6970 PERL_STATIC_INLINE UV*
6971 S__invlist_array_init(pTHX_ SV* const invlist, const bool will_have_0)
6972 {
6973     /* Returns a pointer to the first element in the inversion list's array.
6974      * This is called upon initialization of an inversion list.  Where the
6975      * array begins depends on whether the list has the code point U+0000
6976      * in it or not.  The other parameter tells it whether the code that
6977      * follows this call is about to put a 0 in the inversion list or not.
6978      * The first element is either the element with 0, if 0, or the next one,
6979      * if 1 */
6980
6981     UV* zero = get_invlist_zero_addr(invlist);
6982
6983     PERL_ARGS_ASSERT__INVLIST_ARRAY_INIT;
6984
6985     /* Must be empty */
6986     assert(! *_get_invlist_len_addr(invlist));
6987
6988     /* 1^1 = 0; 1^0 = 1 */
6989     *zero = 1 ^ will_have_0;
6990     return zero + *zero;
6991 }
6992
6993 PERL_STATIC_INLINE UV*
6994 S_invlist_array(pTHX_ SV* const invlist)
6995 {
6996     /* Returns the pointer to the inversion list's array.  Every time the
6997      * length changes, this needs to be called in case malloc or realloc moved
6998      * it */
6999
7000     PERL_ARGS_ASSERT_INVLIST_ARRAY;
7001
7002     /* Must not be empty.  If these fail, you probably didn't check for <len>
7003      * being non-zero before trying to get the array */
7004     assert(*_get_invlist_len_addr(invlist));
7005     assert(*get_invlist_zero_addr(invlist) == 0
7006            || *get_invlist_zero_addr(invlist) == 1);
7007
7008     /* The array begins either at the element reserved for zero if the
7009      * list contains 0 (that element will be set to 0), or otherwise the next
7010      * element (in which case the reserved element will be set to 1). */
7011     return (UV *) (get_invlist_zero_addr(invlist)
7012                    + *get_invlist_zero_addr(invlist));
7013 }
7014
7015 PERL_STATIC_INLINE void
7016 S_invlist_set_len(pTHX_ SV* const invlist, const UV len)
7017 {
7018     /* Sets the current number of elements stored in the inversion list */
7019
7020     PERL_ARGS_ASSERT_INVLIST_SET_LEN;
7021
7022     *_get_invlist_len_addr(invlist) = len;
7023
7024     assert(len <= SvLEN(invlist));
7025
7026     SvCUR_set(invlist, TO_INTERNAL_SIZE(len));
7027     /* If the list contains U+0000, that element is part of the header,
7028      * and should not be counted as part of the array.  It will contain
7029      * 0 in that case, and 1 otherwise.  So we could flop 0=>1, 1=>0 and
7030      * subtract:
7031      *  SvCUR_set(invlist,
7032      *            TO_INTERNAL_SIZE(len
7033      *                             - (*get_invlist_zero_addr(inv_list) ^ 1)));
7034      * But, this is only valid if len is not 0.  The consequences of not doing
7035      * this is that the memory allocation code may think that 1 more UV is
7036      * being used than actually is, and so might do an unnecessary grow.  That
7037      * seems worth not bothering to make this the precise amount.
7038      *
7039      * Note that when inverting, SvCUR shouldn't change */
7040 }
7041
7042 PERL_STATIC_INLINE IV*
7043 S_get_invlist_previous_index_addr(pTHX_ SV* invlist)
7044 {
7045     /* Return the address of the UV that is reserved to hold the cached index
7046      * */
7047
7048     PERL_ARGS_ASSERT_GET_INVLIST_PREVIOUS_INDEX_ADDR;
7049
7050     return (IV *) (SvPVX(invlist) + (INVLIST_PREVIOUS_INDEX_OFFSET * sizeof (UV)));
7051 }
7052
7053 PERL_STATIC_INLINE IV
7054 S_invlist_previous_index(pTHX_ SV* const invlist)
7055 {
7056     /* Returns cached index of previous search */
7057
7058     PERL_ARGS_ASSERT_INVLIST_PREVIOUS_INDEX;
7059
7060     return *get_invlist_previous_index_addr(invlist);
7061 }
7062
7063 PERL_STATIC_INLINE void
7064 S_invlist_set_previous_index(pTHX_ SV* const invlist, const IV index)
7065 {
7066     /* Caches <index> for later retrieval */
7067
7068     PERL_ARGS_ASSERT_INVLIST_SET_PREVIOUS_INDEX;
7069
7070     assert(index == 0 || index < (int) _invlist_len(invlist));
7071
7072     *get_invlist_previous_index_addr(invlist) = index;
7073 }
7074
7075 PERL_STATIC_INLINE UV
7076 S_invlist_max(pTHX_ SV* const invlist)
7077 {
7078     /* Returns the maximum number of elements storable in the inversion list's
7079      * array, without having to realloc() */
7080
7081     PERL_ARGS_ASSERT_INVLIST_MAX;
7082
7083     return SvLEN(invlist) == 0  /* This happens under _new_invlist_C_array */
7084            ? _invlist_len(invlist)
7085            : FROM_INTERNAL_SIZE(SvLEN(invlist));
7086 }
7087
7088 PERL_STATIC_INLINE UV*
7089 S_get_invlist_zero_addr(pTHX_ SV* invlist)
7090 {
7091     /* Return the address of the UV that is reserved to hold 0 if the inversion
7092      * list contains 0.  This has to be the last element of the heading, as the
7093      * list proper starts with either it if 0, or the next element if not.
7094      * (But we force it to contain either 0 or 1) */
7095
7096     PERL_ARGS_ASSERT_GET_INVLIST_ZERO_ADDR;
7097
7098     return (UV *) (SvPVX(invlist) + (INVLIST_ZERO_OFFSET * sizeof (UV)));
7099 }
7100
7101 #ifndef PERL_IN_XSUB_RE
7102 SV*
7103 Perl__new_invlist(pTHX_ IV initial_size)
7104 {
7105
7106     /* Return a pointer to a newly constructed inversion list, with enough
7107      * space to store 'initial_size' elements.  If that number is negative, a
7108      * system default is used instead */
7109
7110     SV* new_list;
7111
7112     if (initial_size < 0) {
7113         initial_size = INVLIST_INITIAL_LEN;
7114     }
7115
7116     /* Allocate the initial space */
7117     new_list = newSV(TO_INTERNAL_SIZE(initial_size));
7118     invlist_set_len(new_list, 0);
7119
7120     /* Force iterinit() to be used to get iteration to work */
7121     *get_invlist_iter_addr(new_list) = UV_MAX;
7122
7123     /* This should force a segfault if a method doesn't initialize this
7124      * properly */
7125     *get_invlist_zero_addr(new_list) = UV_MAX;
7126
7127     *get_invlist_previous_index_addr(new_list) = 0;
7128     *get_invlist_version_id_addr(new_list) = INVLIST_VERSION_ID;
7129 #if HEADER_LENGTH != 5
7130 #   error Need to regenerate INVLIST_VERSION_ID by running perl -E 'say int(rand 2**31-1)', and then changing the #if to the new length
7131 #endif
7132
7133     return new_list;
7134 }
7135 #endif
7136
7137 STATIC SV*
7138 S__new_invlist_C_array(pTHX_ UV* list)
7139 {
7140     /* Return a pointer to a newly constructed inversion list, initialized to
7141      * point to <list>, which has to be in the exact correct inversion list
7142      * form, including internal fields.  Thus this is a dangerous routine that
7143      * should not be used in the wrong hands */
7144
7145     SV* invlist = newSV_type(SVt_PV);
7146
7147     PERL_ARGS_ASSERT__NEW_INVLIST_C_ARRAY;
7148
7149     SvPV_set(invlist, (char *) list);
7150     SvLEN_set(invlist, 0);  /* Means we own the contents, and the system
7151                                shouldn't touch it */
7152     SvCUR_set(invlist, TO_INTERNAL_SIZE(_invlist_len(invlist)));
7153
7154     if (*get_invlist_version_id_addr(invlist) != INVLIST_VERSION_ID) {
7155         Perl_croak(aTHX_ "panic: Incorrect version for previously generated inversion list");
7156     }
7157
7158     /* Initialize the iteration pointer.
7159      * XXX This could be done at compile time in charclass_invlists.h, but I
7160      * (khw) am not confident that the suffixes for specifying the C constant
7161      * UV_MAX are portable, e.g.  'ull' on a 32 bit machine that is configured
7162      * to use 64 bits; might need a Configure probe */
7163     invlist_iterfinish(invlist);
7164
7165     return invlist;
7166 }
7167
7168 STATIC void
7169 S_invlist_extend(pTHX_ SV* const invlist, const UV new_max)
7170 {
7171     /* Grow the maximum size of an inversion list */
7172
7173     PERL_ARGS_ASSERT_INVLIST_EXTEND;
7174
7175     SvGROW((SV *)invlist, TO_INTERNAL_SIZE(new_max));
7176 }
7177
7178 PERL_STATIC_INLINE void
7179 S_invlist_trim(pTHX_ SV* const invlist)
7180 {
7181     PERL_ARGS_ASSERT_INVLIST_TRIM;
7182
7183     /* Change the length of the inversion list to how many entries it currently
7184      * has */
7185
7186     SvPV_shrink_to_cur((SV *) invlist);
7187 }
7188
7189 #define _invlist_union_complement_2nd(a, b, output) _invlist_union_maybe_complement_2nd(a, b, TRUE, output)
7190
7191 STATIC void
7192 S__append_range_to_invlist(pTHX_ SV* const invlist, const UV start, const UV end)
7193 {
7194    /* Subject to change or removal.  Append the range from 'start' to 'end' at
7195     * the end of the inversion list.  The range must be above any existing
7196     * ones. */
7197
7198     UV* array;
7199     UV max = invlist_max(invlist);
7200     UV len = _invlist_len(invlist);
7201
7202     PERL_ARGS_ASSERT__APPEND_RANGE_TO_INVLIST;
7203
7204     if (len == 0) { /* Empty lists must be initialized */
7205         array = _invlist_array_init(invlist, start == 0);
7206     }
7207     else {
7208         /* Here, the existing list is non-empty. The current max entry in the
7209          * list is generally the first value not in the set, except when the
7210          * set extends to the end of permissible values, in which case it is
7211          * the first entry in that final set, and so this call is an attempt to
7212          * append out-of-order */
7213
7214         UV final_element = len - 1;
7215         array = invlist_array(invlist);
7216         if (array[final_element] > start
7217             || ELEMENT_RANGE_MATCHES_INVLIST(final_element))
7218         {
7219             Perl_croak(aTHX_ "panic: attempting to append to an inversion list, but wasn't at the end of the list, final=%"UVuf", start=%"UVuf", match=%c",
7220                        array[final_element], start,
7221                        ELEMENT_RANGE_MATCHES_INVLIST(final_element) ? 't' : 'f');
7222         }
7223
7224         /* Here, it is a legal append.  If the new range begins with the first
7225          * value not in the set, it is extending the set, so the new first
7226          * value not in the set is one greater than the newly extended range.
7227          * */
7228         if (array[final_element] == start) {
7229             if (end != UV_MAX) {
7230                 array[final_element] = end + 1;
7231             }
7232             else {
7233                 /* But if the end is the maximum representable on the machine,
7234                  * just let the range that this would extend to have no end */
7235                 invlist_set_len(invlist, len - 1);
7236             }
7237             return;
7238         }
7239     }
7240
7241     /* Here the new range doesn't extend any existing set.  Add it */
7242
7243     len += 2;   /* Includes an element each for the start and end of range */
7244
7245     /* If overflows the existing space, extend, which may cause the array to be
7246      * moved */
7247     if (max < len) {
7248         invlist_extend(invlist, len);
7249         invlist_set_len(invlist, len);  /* Have to set len here to avoid assert
7250                                            failure in invlist_array() */
7251         array = invlist_array(invlist);
7252     }
7253     else {
7254         invlist_set_len(invlist, len);
7255     }
7256
7257     /* The next item on the list starts the range, the one after that is
7258      * one past the new range.  */
7259     array[len - 2] = start;
7260     if (end != UV_MAX) {
7261         array[len - 1] = end + 1;
7262     }
7263     else {
7264         /* But if the end is the maximum representable on the machine, just let
7265          * the range have no end */
7266         invlist_set_len(invlist, len - 1);
7267     }
7268 }
7269
7270 #ifndef PERL_IN_XSUB_RE
7271
7272 IV
7273 Perl__invlist_search(pTHX_ SV* const invlist, const UV cp)
7274 {
7275     /* Searches the inversion list for the entry that contains the input code
7276      * point <cp>.  If <cp> is not in the list, -1 is returned.  Otherwise, the
7277      * return value is the index into the list's array of the range that
7278      * contains <cp> */
7279
7280     IV low = 0;
7281     IV mid;
7282     IV high = _invlist_len(invlist);
7283     const IV highest_element = high - 1;
7284     const UV* array;
7285
7286     PERL_ARGS_ASSERT__INVLIST_SEARCH;
7287
7288     /* If list is empty, return failure. */
7289     if (high == 0) {
7290         return -1;
7291     }
7292
7293     /* (We can't get the array unless we know the list is non-empty) */
7294     array = invlist_array(invlist);
7295
7296     mid = invlist_previous_index(invlist);
7297     assert(mid >=0 && mid <= highest_element);
7298
7299     /* <mid> contains the cache of the result of the previous call to this
7300      * function (0 the first time).  See if this call is for the same result,
7301      * or if it is for mid-1.  This is under the theory that calls to this
7302      * function will often be for related code points that are near each other.
7303      * And benchmarks show that caching gives better results.  We also test
7304      * here if the code point is within the bounds of the list.  These tests
7305      * replace others that would have had to be made anyway to make sure that
7306      * the array bounds were not exceeded, and these give us extra information
7307      * at the same time */
7308     if (cp >= array[mid]) {
7309         if (cp >= array[highest_element]) {
7310             return highest_element;
7311         }
7312
7313         /* Here, array[mid] <= cp < array[highest_element].  This means that
7314          * the final element is not the answer, so can exclude it; it also
7315          * means that <mid> is not the final element, so can refer to 'mid + 1'
7316          * safely */
7317         if (cp < array[mid + 1]) {
7318             return mid;
7319         }
7320         high--;
7321         low = mid + 1;
7322     }
7323     else { /* cp < aray[mid] */
7324         if (cp < array[0]) { /* Fail if outside the array */
7325             return -1;
7326         }
7327         high = mid;
7328         if (cp >= array[mid - 1]) {
7329             goto found_entry;
7330         }
7331     }
7332
7333     /* Binary search.  What we are looking for is <i> such that
7334      *  array[i] <= cp < array[i+1]
7335      * The loop below converges on the i+1.  Note that there may not be an
7336      * (i+1)th element in the array, and things work nonetheless */
7337     while (low < high) {
7338         mid = (low + high) / 2;
7339         assert(mid <= highest_element);
7340         if (array[mid] <= cp) { /* cp >= array[mid] */
7341             low = mid + 1;
7342
7343             /* We could do this extra test to exit the loop early.
7344             if (cp < array[low]) {
7345                 return mid;
7346             }
7347             */
7348         }
7349         else { /* cp < array[mid] */
7350             high = mid;
7351         }
7352     }
7353
7354   found_entry:
7355     high--;
7356     invlist_set_previous_index(invlist, high);
7357     return high;
7358 }
7359
7360 void
7361 Perl__invlist_populate_swatch(pTHX_ SV* const invlist, const UV start, const UV end, U8* swatch)
7362 {
7363     /* populates a swatch of a swash the same way swatch_get() does in utf8.c,
7364      * but is used when the swash has an inversion list.  This makes this much
7365      * faster, as it uses a binary search instead of a linear one.  This is
7366      * intimately tied to that function, and perhaps should be in utf8.c,
7367      * except it is intimately tied to inversion lists as well.  It assumes
7368      * that <swatch> is all 0's on input */
7369
7370     UV current = start;
7371     const IV len = _invlist_len(invlist);
7372     IV i;
7373     const UV * array;
7374
7375     PERL_ARGS_ASSERT__INVLIST_POPULATE_SWATCH;
7376
7377     if (len == 0) { /* Empty inversion list */
7378         return;
7379     }
7380
7381     array = invlist_array(invlist);
7382
7383     /* Find which element it is */
7384     i = _invlist_search(invlist, start);
7385
7386     /* We populate from <start> to <end> */
7387     while (current < end) {
7388         UV upper;
7389
7390         /* The inversion list gives the results for every possible code point
7391          * after the first one in the list.  Only those ranges whose index is
7392          * even are ones that the inversion list matches.  For the odd ones,
7393          * and if the initial code point is not in the list, we have to skip
7394          * forward to the next element */
7395         if (i == -1 || ! ELEMENT_RANGE_MATCHES_INVLIST(i)) {
7396             i++;
7397             if (i >= len) { /* Finished if beyond the end of the array */
7398                 return;
7399             }
7400             current = array[i];
7401             if (current >= end) {   /* Finished if beyond the end of what we
7402                                        are populating */
7403                 if (LIKELY(end < UV_MAX)) {
7404                     return;
7405                 }
7406
7407                 /* We get here when the upper bound is the maximum
7408                  * representable on the machine, and we are looking for just
7409                  * that code point.  Have to special case it */
7410                 i = len;
7411                 goto join_end_of_list;
7412             }
7413         }
7414         assert(current >= start);
7415
7416         /* The current range ends one below the next one, except don't go past
7417          * <end> */
7418         i++;
7419         upper = (i < len && array[i] < end) ? array[i] : end;
7420
7421         /* Here we are in a range that matches.  Populate a bit in the 3-bit U8
7422          * for each code point in it */
7423         for (; current < upper; current++) {
7424             const STRLEN offset = (STRLEN)(current - start);
7425             swatch[offset >> 3] |= 1 << (offset & 7);
7426         }
7427
7428     join_end_of_list:
7429
7430         /* Quit if at the end of the list */
7431         if (i >= len) {
7432
7433             /* But first, have to deal with the highest possible code point on
7434              * the platform.  The previous code assumes that <end> is one
7435              * beyond where we want to populate, but that is impossible at the
7436              * platform's infinity, so have to handle it specially */
7437             if (UNLIKELY(end == UV_MAX && ELEMENT_RANGE_MATCHES_INVLIST(len-1)))
7438             {
7439                 const STRLEN offset = (STRLEN)(end - start);
7440                 swatch[offset >> 3] |= 1 << (offset & 7);
7441             }
7442             return;
7443         }
7444
7445         /* Advance to the next range, which will be for code points not in the
7446          * inversion list */
7447         current = array[i];
7448     }
7449
7450     return;
7451 }
7452
7453 void
7454 Perl__invlist_union_maybe_complement_2nd(pTHX_ SV* const a, SV* const b, bool complement_b, SV** output)
7455 {
7456     /* Take the union of two inversion lists and point <output> to it.  *output
7457      * SHOULD BE DEFINED upon input, and if it points to one of the two lists,
7458      * the reference count to that list will be decremented.  The first list,
7459      * <a>, may be NULL, in which case a copy of the second list is returned.
7460      * If <complement_b> is TRUE, the union is taken of the complement
7461      * (inversion) of <b> instead of b itself.
7462      *
7463      * The basis for this comes from "Unicode Demystified" Chapter 13 by
7464      * Richard Gillam, published by Addison-Wesley, and explained at some
7465      * length there.  The preface says to incorporate its examples into your
7466      * code at your own risk.
7467      *
7468      * The algorithm is like a merge sort.
7469      *
7470      * XXX A potential performance improvement is to keep track as we go along
7471      * if only one of the inputs contributes to the result, meaning the other
7472      * is a subset of that one.  In that case, we can skip the final copy and
7473      * return the larger of the input lists, but then outside code might need
7474      * to keep track of whether to free the input list or not */
7475
7476     UV* array_a;    /* a's array */
7477     UV* array_b;
7478     UV len_a;       /* length of a's array */
7479     UV len_b;
7480
7481     SV* u;                      /* the resulting union */
7482     UV* array_u;
7483     UV len_u;
7484
7485     UV i_a = 0;             /* current index into a's array */
7486     UV i_b = 0;
7487     UV i_u = 0;
7488
7489     /* running count, as explained in the algorithm source book; items are
7490      * stopped accumulating and are output when the count changes to/from 0.
7491      * The count is incremented when we start a range that's in the set, and
7492      * decremented when we start a range that's not in the set.  So its range
7493      * is 0 to 2.  Only when the count is zero is something not in the set.
7494      */
7495     UV count = 0;
7496
7497     PERL_ARGS_ASSERT__INVLIST_UNION_MAYBE_COMPLEMENT_2ND;
7498     assert(a != b);
7499
7500     /* If either one is empty, the union is the other one */
7501     if (a == NULL || ((len_a = _invlist_len(a)) == 0)) {
7502         if (*output == a) {
7503             if (a != NULL) {
7504                 SvREFCNT_dec_NN(a);
7505             }
7506         }
7507         if (*output != b) {
7508             *output = invlist_clone(b);
7509             if (complement_b) {
7510                 _invlist_invert(*output);
7511             }
7512         } /* else *output already = b; */
7513         return;
7514     }
7515     else if ((len_b = _invlist_len(b)) == 0) {
7516         if (*output == b) {
7517             SvREFCNT_dec_NN(b);
7518         }
7519
7520         /* The complement of an empty list is a list that has everything in it,
7521          * so the union with <a> includes everything too */
7522         if (complement_b) {
7523             if (a == *output) {
7524                 SvREFCNT_dec_NN(a);
7525             }
7526             *output = _new_invlist(1);
7527             _append_range_to_invlist(*output, 0, UV_MAX);
7528         }
7529         else if (*output != a) {
7530             *output = invlist_clone(a);
7531         }
7532         /* else *output already = a; */
7533         return;
7534     }
7535
7536     /* Here both lists exist and are non-empty */
7537     array_a = invlist_array(a);
7538     array_b = invlist_array(b);
7539
7540     /* If are to take the union of 'a' with the complement of b, set it
7541      * up so are looking at b's complement. */
7542     if (complement_b) {
7543
7544         /* To complement, we invert: if the first element is 0, remove it.  To
7545          * do this, we just pretend the array starts one later, and clear the
7546          * flag as we don't have to do anything else later */
7547         if (array_b[0] == 0) {
7548             array_b++;
7549             len_b--;
7550             complement_b = FALSE;
7551         }
7552         else {
7553
7554             /* But if the first element is not zero, we unshift a 0 before the
7555              * array.  The data structure reserves a space for that 0 (which
7556              * should be a '1' right now), so physical shifting is unneeded,
7557              * but temporarily change that element to 0.  Before exiting the
7558              * routine, we must restore the element to '1' */
7559             array_b--;
7560             len_b++;
7561             array_b[0] = 0;
7562         }
7563     }
7564
7565     /* Size the union for the worst case: that the sets are completely
7566      * disjoint */
7567     u = _new_invlist(len_a + len_b);
7568
7569     /* Will contain U+0000 if either component does */
7570     array_u = _invlist_array_init(u, (len_a > 0 && array_a[0] == 0)
7571                                       || (len_b > 0 && array_b[0] == 0));
7572
7573     /* Go through each list item by item, stopping when exhausted one of
7574      * them */
7575     while (i_a < len_a && i_b < len_b) {
7576         UV cp;      /* The element to potentially add to the union's array */
7577         bool cp_in_set;   /* is it in the the input list's set or not */
7578
7579         /* We need to take one or the other of the two inputs for the union.
7580          * Since we are merging two sorted lists, we take the smaller of the
7581          * next items.  In case of a tie, we take the one that is in its set
7582          * first.  If we took one not in the set first, it would decrement the
7583          * count, possibly to 0 which would cause it to be output as ending the
7584          * range, and the next time through we would take the same number, and
7585          * output it again as beginning the next range.  By doing it the
7586          * opposite way, there is no possibility that the count will be
7587          * momentarily decremented to 0, and thus the two adjoining ranges will
7588          * be seamlessly merged.  (In a tie and both are in the set or both not
7589          * in the set, it doesn't matter which we take first.) */
7590         if (array_a[i_a] < array_b[i_b]
7591             || (array_a[i_a] == array_b[i_b]
7592                 && ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
7593         {
7594             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
7595             cp= array_a[i_a++];
7596         }
7597         else {
7598             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
7599             cp = array_b[i_b++];
7600         }
7601
7602         /* Here, have chosen which of the two inputs to look at.  Only output
7603          * if the running count changes to/from 0, which marks the
7604          * beginning/end of a range in that's in the set */
7605         if (cp_in_set) {
7606             if (count == 0) {
7607                 array_u[i_u++] = cp;
7608             }
7609             count++;
7610         }
7611         else {
7612             count--;
7613             if (count == 0) {
7614                 array_u[i_u++] = cp;
7615             }
7616         }
7617     }
7618
7619     /* Here, we are finished going through at least one of the lists, which
7620      * means there is something remaining in at most one.  We check if the list
7621      * that hasn't been exhausted is positioned such that we are in the middle
7622      * of a range in its set or not.  (i_a and i_b point to the element beyond
7623      * the one we care about.) If in the set, we decrement 'count'; if 0, there
7624      * is potentially more to output.
7625      * There are four cases:
7626      *  1) Both weren't in their sets, count is 0, and remains 0.  What's left
7627      *     in the union is entirely from the non-exhausted set.
7628      *  2) Both were in their sets, count is 2.  Nothing further should
7629      *     be output, as everything that remains will be in the exhausted
7630      *     list's set, hence in the union; decrementing to 1 but not 0 insures
7631      *     that
7632      *  3) the exhausted was in its set, non-exhausted isn't, count is 1.
7633      *     Nothing further should be output because the union includes
7634      *     everything from the exhausted set.  Not decrementing ensures that.
7635      *  4) the exhausted wasn't in its set, non-exhausted is, count is 1;
7636      *     decrementing to 0 insures that we look at the remainder of the
7637      *     non-exhausted set */
7638     if ((i_a != len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
7639         || (i_b != len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
7640     {
7641         count--;
7642     }
7643
7644     /* The final length is what we've output so far, plus what else is about to
7645      * be output.  (If 'count' is non-zero, then the input list we exhausted
7646      * has everything remaining up to the machine's limit in its set, and hence
7647      * in the union, so there will be no further output. */
7648     len_u = i_u;
7649     if (count == 0) {
7650         /* At most one of the subexpressions will be non-zero */
7651         len_u += (len_a - i_a) + (len_b - i_b);
7652     }
7653
7654     /* Set result to final length, which can change the pointer to array_u, so
7655      * re-find it */
7656     if (len_u != _invlist_len(u)) {
7657         invlist_set_len(u, len_u);
7658         invlist_trim(u);
7659         array_u = invlist_array(u);
7660     }
7661
7662     /* When 'count' is 0, the list that was exhausted (if one was shorter than
7663      * the other) ended with everything above it not in its set.  That means
7664      * that the remaining part of the union is precisely the same as the
7665      * non-exhausted list, so can just copy it unchanged.  (If both list were
7666      * exhausted at the same time, then the operations below will be both 0.)
7667      */
7668     if (count == 0) {
7669         IV copy_count; /* At most one will have a non-zero copy count */
7670         if ((copy_count = len_a - i_a) > 0) {
7671             Copy(array_a + i_a, array_u + i_u, copy_count, UV);
7672         }
7673         else if ((copy_count = len_b - i_b) > 0) {
7674             Copy(array_b + i_b, array_u + i_u, copy_count, UV);
7675         }
7676     }
7677
7678     /* If we've changed b, restore it */
7679     if (complement_b) {
7680         array_b[0] = 1;
7681     }
7682
7683     /*  We may be removing a reference to one of the inputs */
7684     if (a == *output || b == *output) {
7685         assert(! invlist_is_iterating(*output));
7686         SvREFCNT_dec_NN(*output);
7687     }
7688
7689     *output = u;
7690     return;
7691 }
7692
7693 void
7694 Perl__invlist_intersection_maybe_complement_2nd(pTHX_ SV* const a, SV* const b, bool complement_b, SV** i)
7695 {
7696     /* Take the intersection of two inversion lists and point <i> to it.  *i
7697      * SHOULD BE DEFINED upon input, and if it points to one of the two lists,
7698      * the reference count to that list will be decremented.
7699      * If <complement_b> is TRUE, the result will be the intersection of <a>
7700      * and the complement (or inversion) of <b> instead of <b> directly.
7701      *
7702      * The basis for this comes from "Unicode Demystified" Chapter 13 by
7703      * Richard Gillam, published by Addison-Wesley, and explained at some
7704      * length there.  The preface says to incorporate its examples into your
7705      * code at your own risk.  In fact, it had bugs
7706      *
7707      * The algorithm is like a merge sort, and is essentially the same as the
7708      * union above
7709      */
7710
7711     UV* array_a;                /* a's array */
7712     UV* array_b;
7713     UV len_a;   /* length of a's array */
7714     UV len_b;
7715
7716     SV* r;                   /* the resulting intersection */
7717     UV* array_r;
7718     UV len_r;
7719
7720     UV i_a = 0;             /* current index into a's array */
7721     UV i_b = 0;
7722     UV i_r = 0;
7723
7724     /* running count, as explained in the algorithm source book; items are
7725      * stopped accumulating and are output when the count changes to/from 2.
7726      * The count is incremented when we start a range that's in the set, and
7727      * decremented when we start a range that's not in the set.  So its range
7728      * is 0 to 2.  Only when the count is 2 is something in the intersection.
7729      */
7730     UV count = 0;
7731
7732     PERL_ARGS_ASSERT__INVLIST_INTERSECTION_MAYBE_COMPLEMENT_2ND;
7733     assert(a != b);
7734
7735     /* Special case if either one is empty */
7736     len_a = _invlist_len(a);
7737     if ((len_a == 0) || ((len_b = _invlist_len(b)) == 0)) {
7738
7739         if (len_a != 0 && complement_b) {
7740
7741             /* Here, 'a' is not empty, therefore from the above 'if', 'b' must
7742              * be empty.  Here, also we are using 'b's complement, which hence
7743              * must be every possible code point.  Thus the intersection is
7744              * simply 'a'. */
7745             if (*i != a) {
7746                 *i = invlist_clone(a);
7747
7748                 if (*i == b) {
7749                     SvREFCNT_dec_NN(b);
7750                 }
7751             }
7752             /* else *i is already 'a' */
7753             return;
7754         }
7755
7756         /* Here, 'a' or 'b' is empty and not using the complement of 'b'.  The
7757          * intersection must be empty */
7758         if (*i == a) {
7759             SvREFCNT_dec_NN(a);
7760         }
7761         else if (*i == b) {
7762             SvREFCNT_dec_NN(b);
7763         }
7764         *i = _new_invlist(0);
7765         return;
7766     }
7767
7768     /* Here both lists exist and are non-empty */
7769     array_a = invlist_array(a);
7770     array_b = invlist_array(b);
7771
7772     /* If are to take the intersection of 'a' with the complement of b, set it
7773      * up so are looking at b's complement. */
7774     if (complement_b) {
7775
7776         /* To complement, we invert: if the first element is 0, remove it.  To
7777          * do this, we just pretend the array starts one later, and clear the
7778          * flag as we don't have to do anything else later */
7779         if (array_b[0] == 0) {
7780             array_b++;
7781             len_b--;
7782             complement_b = FALSE;
7783         }
7784         else {
7785
7786             /* But if the first element is not zero, we unshift a 0 before the
7787              * array.  The data structure reserves a space for that 0 (which
7788              * should be a '1' right now), so physical shifting is unneeded,
7789              * but temporarily change that element to 0.  Before exiting the
7790              * routine, we must restore the element to '1' */
7791             array_b--;
7792             len_b++;
7793             array_b[0] = 0;
7794         }
7795     }
7796
7797     /* Size the intersection for the worst case: that the intersection ends up
7798      * fragmenting everything to be completely disjoint */
7799     r= _new_invlist(len_a + len_b);
7800
7801     /* Will contain U+0000 iff both components do */
7802     array_r = _invlist_array_init(r, len_a > 0 && array_a[0] == 0
7803                                      && len_b > 0 && array_b[0] == 0);
7804
7805     /* Go through each list item by item, stopping when exhausted one of
7806      * them */
7807     while (i_a < len_a && i_b < len_b) {
7808         UV cp;      /* The element to potentially add to the intersection's
7809                        array */
7810         bool cp_in_set; /* Is it in the input list's set or not */
7811
7812         /* We need to take one or the other of the two inputs for the
7813          * intersection.  Since we are merging two sorted lists, we take the
7814          * smaller of the next items.  In case of a tie, we take the one that
7815          * is not in its set first (a difference from the union algorithm).  If
7816          * we took one in the set first, it would increment the count, possibly
7817          * to 2 which would cause it to be output as starting a range in the
7818          * intersection, and the next time through we would take that same
7819          * number, and output it again as ending the set.  By doing it the
7820          * opposite of this, there is no possibility that the count will be
7821          * momentarily incremented to 2.  (In a tie and both are in the set or
7822          * both not in the set, it doesn't matter which we take first.) */
7823         if (array_a[i_a] < array_b[i_b]
7824             || (array_a[i_a] == array_b[i_b]
7825                 && ! ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
7826         {
7827             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
7828             cp= array_a[i_a++];
7829         }
7830         else {
7831             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
7832             cp= array_b[i_b++];
7833         }
7834
7835         /* Here, have chosen which of the two inputs to look at.  Only output
7836          * if the running count changes to/from 2, which marks the
7837          * beginning/end of a range that's in the intersection */
7838         if (cp_in_set) {
7839             count++;
7840             if (count == 2) {
7841                 array_r[i_r++] = cp;
7842             }
7843         }
7844         else {
7845             if (count == 2) {
7846                 array_r[i_r++] = cp;
7847             }
7848             count--;
7849         }
7850     }
7851
7852     /* Here, we are finished going through at least one of the lists, which
7853      * means there is something remaining in at most one.  We check if the list
7854      * that has been exhausted is positioned such that we are in the middle
7855      * of a range in its set or not.  (i_a and i_b point to elements 1 beyond
7856      * the ones we care about.)  There are four cases:
7857      *  1) Both weren't in their sets, count is 0, and remains 0.  There's
7858      *     nothing left in the intersection.
7859      *  2) Both were in their sets, count is 2 and perhaps is incremented to
7860      *     above 2.  What should be output is exactly that which is in the
7861      *     non-exhausted set, as everything it has is also in the intersection
7862      *     set, and everything it doesn't have can't be in the intersection
7863      *  3) The exhausted was in its set, non-exhausted isn't, count is 1, and
7864      *     gets incremented to 2.  Like the previous case, the intersection is
7865      *     everything that remains in the non-exhausted set.
7866      *  4) the exhausted wasn't in its set, non-exhausted is, count is 1, and
7867      *     remains 1.  And the intersection has nothing more. */
7868     if ((i_a == len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
7869         || (i_b == len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
7870     {
7871         count++;
7872     }
7873
7874     /* The final length is what we've output so far plus what else is in the
7875      * intersection.  At most one of the subexpressions below will be non-zero */
7876     len_r = i_r;
7877     if (count >= 2) {
7878         len_r += (len_a - i_a) + (len_b - i_b);
7879     }
7880
7881     /* Set result to final length, which can change the pointer to array_r, so
7882      * re-find it */
7883     if (len_r != _invlist_len(r)) {
7884         invlist_set_len(r, len_r);
7885         invlist_trim(r);
7886         array_r = invlist_array(r);
7887     }
7888
7889     /* Finish outputting any remaining */
7890     if (count >= 2) { /* At most one will have a non-zero copy count */
7891         IV copy_count;
7892         if ((copy_count = len_a - i_a) > 0) {
7893             Copy(array_a + i_a, array_r + i_r, copy_count, UV);
7894         }
7895         else if ((copy_count = len_b - i_b) > 0) {
7896             Copy(array_b + i_b, array_r + i_r, copy_count, UV);
7897         }
7898     }
7899
7900     /* If we've changed b, restore it */
7901     if (complement_b) {
7902         array_b[0] = 1;
7903     }
7904
7905     /*  We may be removing a reference to one of the inputs */
7906     if (a == *i || b == *i) {
7907         assert(! invlist_is_iterating(*i));
7908         SvREFCNT_dec_NN(*i);
7909     }
7910
7911     *i = r;
7912     return;
7913 }
7914
7915 SV*
7916 Perl__add_range_to_invlist(pTHX_ SV* invlist, const UV start, const UV end)
7917 {
7918     /* Add the range from 'start' to 'end' inclusive to the inversion list's
7919      * set.  A pointer to the inversion list is returned.  This may actually be
7920      * a new list, in which case the passed in one has been destroyed.  The
7921      * passed in inversion list can be NULL, in which case a new one is created
7922      * with just the one range in it */
7923
7924     SV* range_invlist;
7925     UV len;
7926
7927     if (invlist == NULL) {
7928         invlist = _new_invlist(2);
7929         len = 0;
7930     }
7931     else {
7932         len = _invlist_len(invlist);
7933     }
7934
7935     /* If comes after the final entry actually in the list, can just append it
7936      * to the end, */
7937     if (len == 0
7938         || (! ELEMENT_RANGE_MATCHES_INVLIST(len - 1)
7939             && start >= invlist_array(invlist)[len - 1]))
7940     {
7941         _append_range_to_invlist(invlist, start, end);
7942         return invlist;
7943     }
7944
7945     /* Here, can't just append things, create and return a new inversion list
7946      * which is the union of this range and the existing inversion list */
7947     range_invlist = _new_invlist(2);
7948     _append_range_to_invlist(range_invlist, start, end);
7949
7950     _invlist_union(invlist, range_invlist, &invlist);
7951
7952     /* The temporary can be freed */
7953     SvREFCNT_dec_NN(range_invlist);
7954
7955     return invlist;
7956 }
7957
7958 #endif
7959
7960 PERL_STATIC_INLINE SV*
7961 S_add_cp_to_invlist(pTHX_ SV* invlist, const UV cp) {
7962     return _add_range_to_invlist(invlist, cp, cp);
7963 }
7964
7965 #ifndef PERL_IN_XSUB_RE
7966 void
7967 Perl__invlist_invert(pTHX_ SV* const invlist)
7968 {
7969     /* Complement the input inversion list.  This adds a 0 if the list didn't
7970      * have a zero; removes it otherwise.  As described above, the data
7971      * structure is set up so that this is very efficient */
7972
7973     UV* len_pos = _get_invlist_len_addr(invlist);
7974
7975     PERL_ARGS_ASSERT__INVLIST_INVERT;
7976
7977     assert(! invlist_is_iterating(invlist));
7978
7979     /* The inverse of matching nothing is matching everything */
7980     if (*len_pos == 0) {
7981         _append_range_to_invlist(invlist, 0, UV_MAX);
7982         return;
7983     }
7984
7985     /* The exclusive or complents 0 to 1; and 1 to 0.  If the result is 1, the
7986      * zero element was a 0, so it is being removed, so the length decrements
7987      * by 1; and vice-versa.  SvCUR is unaffected */
7988     if (*get_invlist_zero_addr(invlist) ^= 1) {
7989         (*len_pos)--;
7990     }
7991     else {
7992         (*len_pos)++;
7993     }
7994 }
7995
7996 void
7997 Perl__invlist_invert_prop(pTHX_ SV* const invlist)
7998 {
7999     /* Complement the input inversion list (which must be a Unicode property,
8000      * all of which don't match above the Unicode maximum code point.)  And
8001      * Perl has chosen to not have the inversion match above that either.  This
8002      * adds a 0x110000 if the list didn't end with it, and removes it if it did
8003      */
8004
8005     UV len;
8006     UV* array;
8007
8008     PERL_ARGS_ASSERT__INVLIST_INVERT_PROP;
8009
8010     _invlist_invert(invlist);
8011
8012     len = _invlist_len(invlist);
8013
8014     if (len != 0) { /* If empty do nothing */
8015         array = invlist_array(invlist);
8016         if (array[len - 1] != PERL_UNICODE_MAX + 1) {
8017             /* Add 0x110000.  First, grow if necessary */
8018             len++;
8019             if (invlist_max(invlist) < len) {
8020                 invlist_extend(invlist, len);
8021                 array = invlist_array(invlist);
8022             }
8023             invlist_set_len(invlist, len);
8024             array[len - 1] = PERL_UNICODE_MAX + 1;
8025         }
8026         else {  /* Remove the 0x110000 */
8027             invlist_set_len(invlist, len - 1);
8028         }
8029     }
8030
8031     return;
8032 }
8033 #endif
8034
8035 PERL_STATIC_INLINE SV*
8036 S_invlist_clone(pTHX_ SV* const invlist)
8037 {
8038
8039     /* Return a new inversion list that is a copy of the input one, which is
8040      * unchanged */
8041
8042     /* Need to allocate extra space to accommodate Perl's addition of a
8043      * trailing NUL to SvPV's, since it thinks they are always strings */
8044     SV* new_invlist = _new_invlist(_invlist_len(invlist) + 1);
8045     STRLEN length = SvCUR(invlist);
8046
8047     PERL_ARGS_ASSERT_INVLIST_CLONE;
8048
8049     SvCUR_set(new_invlist, length); /* This isn't done automatically */
8050     Copy(SvPVX(invlist), SvPVX(new_invlist), length, char);
8051
8052     return new_invlist;
8053 }
8054
8055 PERL_STATIC_INLINE UV*
8056 S_get_invlist_iter_addr(pTHX_ SV* invlist)
8057 {
8058     /* Return the address of the UV that contains the current iteration
8059      * position */
8060
8061     PERL_ARGS_ASSERT_GET_INVLIST_ITER_ADDR;
8062
8063     return (UV *) (SvPVX(invlist) + (INVLIST_ITER_OFFSET * sizeof (UV)));
8064 }
8065
8066 PERL_STATIC_INLINE UV*
8067 S_get_invlist_version_id_addr(pTHX_ SV* invlist)
8068 {
8069     /* Return the address of the UV that contains the version id. */
8070
8071     PERL_ARGS_ASSERT_GET_INVLIST_VERSION_ID_ADDR;
8072
8073     return (UV *) (SvPVX(invlist) + (INVLIST_VERSION_ID_OFFSET * sizeof (UV)));
8074 }
8075
8076 PERL_STATIC_INLINE void
8077 S_invlist_iterinit(pTHX_ SV* invlist)   /* Initialize iterator for invlist */
8078 {
8079     PERL_ARGS_ASSERT_INVLIST_ITERINIT;
8080
8081     *get_invlist_iter_addr(invlist) = 0;
8082 }
8083
8084 PERL_STATIC_INLINE void
8085 S_invlist_iterfinish(pTHX_ SV* invlist)
8086 {
8087     /* Terminate iterator for invlist.  This is to catch development errors.
8088      * Any iteration that is interrupted before completed should call this
8089      * function.  Functions that add code points anywhere else but to the end
8090      * of an inversion list assert that they are not in the middle of an
8091      * iteration.  If they were, the addition would make the iteration
8092      * problematical: if the iteration hadn't reached the place where things
8093      * were being added, it would be ok */
8094
8095     PERL_ARGS_ASSERT_INVLIST_ITERFINISH;
8096
8097     *get_invlist_iter_addr(invlist) = UV_MAX;
8098 }
8099
8100 STATIC bool
8101 S_invlist_iternext(pTHX_ SV* invlist, UV* start, UV* end)
8102 {
8103     /* An C<invlist_iterinit> call on <invlist> must be used to set this up.
8104      * This call sets in <*start> and <*end>, the next range in <invlist>.
8105      * Returns <TRUE> if successful and the next call will return the next
8106      * range; <FALSE> if was already at the end of the list.  If the latter,
8107      * <*start> and <*end> are unchanged, and the next call to this function
8108      * will start over at the beginning of the list */
8109
8110     UV* pos = get_invlist_iter_addr(invlist);
8111     UV len = _invlist_len(invlist);
8112     UV *array;
8113
8114     PERL_ARGS_ASSERT_INVLIST_ITERNEXT;
8115
8116     if (*pos >= len) {
8117         *pos = UV_MAX;  /* Force iterinit() to be required next time */
8118         return FALSE;
8119     }
8120
8121     array = invlist_array(invlist);
8122
8123     *start = array[(*pos)++];
8124
8125     if (*pos >= len) {
8126         *end = UV_MAX;
8127     }
8128     else {
8129         *end = array[(*pos)++] - 1;
8130     }
8131
8132     return TRUE;
8133 }
8134
8135 PERL_STATIC_INLINE bool
8136 S_invlist_is_iterating(pTHX_ SV* const invlist)
8137 {
8138     PERL_ARGS_ASSERT_INVLIST_IS_ITERATING;
8139
8140     return *(get_invlist_iter_addr(invlist)) < UV_MAX;
8141 }
8142
8143 PERL_STATIC_INLINE UV
8144 S_invlist_highest(pTHX_ SV* const invlist)
8145 {
8146     /* Returns the highest code point that matches an inversion list.  This API
8147      * has an ambiguity, as it returns 0 under either the highest is actually
8148      * 0, or if the list is empty.  If this distinction matters to you, check
8149      * for emptiness before calling this function */
8150
8151     UV len = _invlist_len(invlist);
8152     UV *array;
8153
8154     PERL_ARGS_ASSERT_INVLIST_HIGHEST;
8155
8156     if (len == 0) {
8157         return 0;
8158     }
8159
8160     array = invlist_array(invlist);
8161
8162     /* The last element in the array in the inversion list always starts a
8163      * range that goes to infinity.  That range may be for code points that are
8164      * matched in the inversion list, or it may be for ones that aren't
8165      * matched.  In the latter case, the highest code point in the set is one
8166      * less than the beginning of this range; otherwise it is the final element
8167      * of this range: infinity */
8168     return (ELEMENT_RANGE_MATCHES_INVLIST(len - 1))
8169            ? UV_MAX
8170            : array[len - 1] - 1;
8171 }
8172
8173 #ifndef PERL_IN_XSUB_RE
8174 SV *
8175 Perl__invlist_contents(pTHX_ SV* const invlist)
8176 {
8177     /* Get the contents of an inversion list into a string SV so that they can
8178      * be printed out.  It uses the format traditionally done for debug tracing
8179      */
8180
8181     UV start, end;
8182     SV* output = newSVpvs("\n");
8183
8184     PERL_ARGS_ASSERT__INVLIST_CONTENTS;
8185
8186     assert(! invlist_is_iterating(invlist));
8187
8188     invlist_iterinit(invlist);
8189     while (invlist_iternext(invlist, &start, &end)) {
8190         if (end == UV_MAX) {
8191             Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\tINFINITY\n", start);
8192         }
8193         else if (end != start) {
8194             Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\t%04"UVXf"\n",
8195                     start,       end);
8196         }
8197         else {
8198             Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\n", start);
8199         }
8200     }
8201
8202     return output;
8203 }
8204 #endif
8205
8206 #ifdef PERL_ARGS_ASSERT__INVLIST_DUMP
8207 void
8208 Perl__invlist_dump(pTHX_ SV* const invlist, const char * const header)
8209 {
8210     /* Dumps out the ranges in an inversion list.  The string 'header'
8211      * if present is output on a line before the first range */
8212
8213     UV start, end;
8214
8215     PERL_ARGS_ASSERT__INVLIST_DUMP;
8216
8217     if (header && strlen(header)) {
8218         PerlIO_printf(Perl_debug_log, "%s\n", header);
8219     }
8220     if (invlist_is_iterating(invlist)) {
8221         PerlIO_printf(Perl_debug_log, "Can't dump because is in middle of iterating\n");
8222         return;
8223     }
8224
8225     invlist_iterinit(invlist);
8226     while (invlist_iternext(invlist, &start, &end)) {
8227         if (end == UV_MAX) {
8228             PerlIO_printf(Perl_debug_log, "0x%04"UVXf" .. INFINITY\n", start);
8229         }
8230         else if (end != start) {
8231             PerlIO_printf(Perl_debug_log, "0x%04"UVXf" .. 0x%04"UVXf"\n",
8232                                                  start,         end);
8233         }
8234         else {
8235             PerlIO_printf(Perl_debug_log, "0x%04"UVXf"\n", start);
8236         }
8237     }
8238 }
8239 #endif
8240
8241 #if 0
8242 bool
8243 S__invlistEQ(pTHX_ SV* const a, SV* const b, bool complement_b)
8244 {
8245     /* Return a boolean as to if the two passed in inversion lists are
8246      * identical.  The final argument, if TRUE, says to take the complement of
8247      * the second inversion list before doing the comparison */
8248
8249     UV* array_a = invlist_array(a);
8250     UV* array_b = invlist_array(b);
8251     UV len_a = _invlist_len(a);
8252     UV len_b = _invlist_len(b);
8253
8254     UV i = 0;               /* current index into the arrays */
8255     bool retval = TRUE;     /* Assume are identical until proven otherwise */
8256
8257     PERL_ARGS_ASSERT__INVLISTEQ;
8258
8259     /* If are to compare 'a' with the complement of b, set it
8260      * up so are looking at b's complement. */
8261     if (complement_b) {
8262
8263         /* The complement of nothing is everything, so <a> would have to have
8264          * just one element, starting at zero (ending at infinity) */
8265         if (len_b == 0) {
8266             return (len_a == 1 && array_a[0] == 0);
8267         }
8268         else if (array_b[0] == 0) {
8269
8270             /* Otherwise, to complement, we invert.  Here, the first element is
8271              * 0, just remove it.  To do this, we just pretend the array starts
8272              * one later, and clear the flag as we don't have to do anything
8273              * else later */
8274
8275             array_b++;
8276             len_b--;
8277             complement_b = FALSE;
8278         }
8279         else {
8280
8281             /* But if the first element is not zero, we unshift a 0 before the
8282              * array.  The data structure reserves a space for that 0 (which
8283              * should be a '1' right now), so physical shifting is unneeded,
8284              * but temporarily change that element to 0.  Before exiting the
8285              * routine, we must restore the element to '1' */
8286             array_b--;
8287             len_b++;
8288             array_b[0] = 0;
8289         }
8290     }
8291
8292     /* Make sure that the lengths are the same, as well as the final element
8293      * before looping through the remainder.  (Thus we test the length, final,
8294      * and first elements right off the bat) */
8295     if (len_a != len_b || array_a[len_a-1] != array_b[len_a-1]) {
8296         retval = FALSE;
8297     }
8298     else for (i = 0; i < len_a - 1; i++) {
8299         if (array_a[i] != array_b[i]) {
8300             retval = FALSE;
8301             break;
8302         }
8303     }
8304
8305     if (complement_b) {
8306         array_b[0] = 1;
8307     }
8308     return retval;
8309 }
8310 #endif
8311
8312 #undef HEADER_LENGTH
8313 #undef INVLIST_INITIAL_LENGTH
8314 #undef TO_INTERNAL_SIZE
8315 #undef FROM_INTERNAL_SIZE
8316 #undef INVLIST_LEN_OFFSET
8317 #undef INVLIST_ZERO_OFFSET
8318 #undef INVLIST_ITER_OFFSET
8319 #undef INVLIST_VERSION_ID
8320 #undef INVLIST_PREVIOUS_INDEX_OFFSET
8321
8322 /* End of inversion list object */
8323
8324 STATIC void
8325 S_parse_lparen_question_flags(pTHX_ struct RExC_state_t *pRExC_state)
8326 {
8327     /* This parses the flags that are in either the '(?foo)' or '(?foo:bar)'
8328      * constructs, and updates RExC_flags with them.  On input, RExC_parse
8329      * should point to the first flag; it is updated on output to point to the
8330      * final ')' or ':'.  There needs to be at least one flag, or this will
8331      * abort */
8332
8333     /* for (?g), (?gc), and (?o) warnings; warning
8334        about (?c) will warn about (?g) -- japhy    */
8335
8336 #define WASTED_O  0x01
8337 #define WASTED_G  0x02
8338 #define WASTED_C  0x04
8339 #define WASTED_GC (0x02|0x04)
8340     I32 wastedflags = 0x00;
8341     U32 posflags = 0, negflags = 0;
8342     U32 *flagsp = &posflags;
8343     char has_charset_modifier = '\0';
8344     regex_charset cs;
8345     bool has_use_defaults = FALSE;
8346     const char* const seqstart = RExC_parse - 1; /* Point to the '?' */
8347
8348     PERL_ARGS_ASSERT_PARSE_LPAREN_QUESTION_FLAGS;
8349
8350     /* '^' as an initial flag sets certain defaults */
8351     if (UCHARAT(RExC_parse) == '^') {
8352         RExC_parse++;
8353         has_use_defaults = TRUE;
8354         STD_PMMOD_FLAGS_CLEAR(&RExC_flags);
8355         set_regex_charset(&RExC_flags, (RExC_utf8 || RExC_uni_semantics)
8356                                         ? REGEX_UNICODE_CHARSET
8357                                         : REGEX_DEPENDS_CHARSET);
8358     }
8359
8360     cs = get_regex_charset(RExC_flags);
8361     if (cs == REGEX_DEPENDS_CHARSET
8362         && (RExC_utf8 || RExC_uni_semantics))
8363     {
8364         cs = REGEX_UNICODE_CHARSET;
8365     }
8366
8367     while (*RExC_parse) {
8368         /* && strchr("iogcmsx", *RExC_parse) */
8369         /* (?g), (?gc) and (?o) are useless here
8370            and must be globally applied -- japhy */
8371         switch (*RExC_parse) {
8372
8373             /* Code for the imsx flags */
8374             CASE_STD_PMMOD_FLAGS_PARSE_SET(flagsp);
8375
8376             case LOCALE_PAT_MOD:
8377                 if (has_charset_modifier) {
8378                     goto excess_modifier;
8379                 }
8380                 else if (flagsp == &negflags) {
8381                     goto neg_modifier;
8382                 }
8383                 cs = REGEX_LOCALE_CHARSET;
8384                 has_charset_modifier = LOCALE_PAT_MOD;
8385                 RExC_contains_locale = 1;
8386                 break;
8387             case UNICODE_PAT_MOD:
8388                 if (has_charset_modifier) {
8389                     goto excess_modifier;
8390                 }
8391                 else if (flagsp == &negflags) {
8392                     goto neg_modifier;
8393                 }
8394                 cs = REGEX_UNICODE_CHARSET;
8395                 has_charset_modifier = UNICODE_PAT_MOD;
8396                 break;
8397             case ASCII_RESTRICT_PAT_MOD:
8398                 if (flagsp == &negflags) {
8399                     goto neg_modifier;
8400                 }
8401                 if (has_charset_modifier) {
8402                     if (cs != REGEX_ASCII_RESTRICTED_CHARSET) {
8403                         goto excess_modifier;
8404                     }
8405                     /* Doubled modifier implies more restricted */
8406                     cs = REGEX_ASCII_MORE_RESTRICTED_CHARSET;
8407                 }
8408                 else {
8409                     cs = REGEX_ASCII_RESTRICTED_CHARSET;
8410                 }
8411                 has_charset_modifier = ASCII_RESTRICT_PAT_MOD;
8412                 break;
8413             case DEPENDS_PAT_MOD:
8414                 if (has_use_defaults) {
8415                     goto fail_modifiers;
8416                 }
8417                 else if (flagsp == &negflags) {
8418                     goto neg_modifier;
8419                 }
8420                 else if (has_charset_modifier) {
8421                     goto excess_modifier;
8422                 }
8423
8424                 /* The dual charset means unicode semantics if the
8425                  * pattern (or target, not known until runtime) are
8426                  * utf8, or something in the pattern indicates unicode
8427                  * semantics */
8428                 cs = (RExC_utf8 || RExC_uni_semantics)
8429                      ? REGEX_UNICODE_CHARSET
8430                      : REGEX_DEPENDS_CHARSET;
8431                 has_charset_modifier = DEPENDS_PAT_MOD;
8432                 break;
8433             excess_modifier:
8434                 RExC_parse++;
8435                 if (has_charset_modifier == ASCII_RESTRICT_PAT_MOD) {
8436                     vFAIL2("Regexp modifier \"%c\" may appear a maximum of twice", ASCII_RESTRICT_PAT_MOD);
8437                 }
8438                 else if (has_charset_modifier == *(RExC_parse - 1)) {
8439                     vFAIL2("Regexp modifier \"%c\" may not appear twice", *(RExC_parse - 1));
8440                 }
8441                 else {
8442                     vFAIL3("Regexp modifiers \"%c\" and \"%c\" are mutually exclusive", has_charset_modifier, *(RExC_parse - 1));
8443                 }
8444                 /*NOTREACHED*/
8445             neg_modifier:
8446                 RExC_parse++;
8447                 vFAIL2("Regexp modifier \"%c\" may not appear after the \"-\"", *(RExC_parse - 1));
8448                 /*NOTREACHED*/
8449             case ONCE_PAT_MOD: /* 'o' */
8450             case GLOBAL_PAT_MOD: /* 'g' */
8451                 if (SIZE_ONLY && ckWARN(WARN_REGEXP)) {
8452                     const I32 wflagbit = *RExC_parse == 'o' ? WASTED_O : WASTED_G;
8453                     if (! (wastedflags & wflagbit) ) {
8454                         wastedflags |= wflagbit;
8455                         vWARN5(
8456                             RExC_parse + 1,
8457                             "Useless (%s%c) - %suse /%c modifier",
8458                             flagsp == &negflags ? "?-" : "?",
8459                             *RExC_parse,
8460                             flagsp == &negflags ? "don't " : "",
8461                             *RExC_parse
8462                         );
8463                     }
8464                 }
8465                 break;
8466
8467             case CONTINUE_PAT_MOD: /* 'c' */
8468                 if (SIZE_ONLY && ckWARN(WARN_REGEXP)) {
8469                     if (! (wastedflags & WASTED_C) ) {
8470                         wastedflags |= WASTED_GC;
8471                         vWARN3(
8472                             RExC_parse + 1,
8473                             "Useless (%sc) - %suse /gc modifier",
8474                             flagsp == &negflags ? "?-" : "?",
8475                             flagsp == &negflags ? "don't " : ""
8476                         );
8477                     }
8478                 }
8479                 break;
8480             case KEEPCOPY_PAT_MOD: /* 'p' */
8481                 if (flagsp == &negflags) {
8482                     if (SIZE_ONLY)
8483                         ckWARNreg(RExC_parse + 1,"Useless use of (?-p)");
8484                 } else {
8485                     *flagsp |= RXf_PMf_KEEPCOPY;
8486                 }
8487                 break;
8488             case '-':
8489                 /* A flag is a default iff it is following a minus, so
8490                  * if there is a minus, it means will be trying to
8491                  * re-specify a default which is an error */
8492                 if (has_use_defaults || flagsp == &negflags) {
8493                     goto fail_modifiers;
8494                 }
8495                 flagsp = &negflags;
8496                 wastedflags = 0;  /* reset so (?g-c) warns twice */
8497                 break;
8498             case ':':
8499             case ')':
8500                 RExC_flags |= posflags;
8501                 RExC_flags &= ~negflags;
8502                 set_regex_charset(&RExC_flags, cs);
8503                 return;
8504                 /*NOTREACHED*/
8505             default:
8506             fail_modifiers:
8507                 RExC_parse++;
8508                 vFAIL3("Sequence (%.*s...) not recognized",
8509                        RExC_parse-seqstart, seqstart);
8510                 /*NOTREACHED*/
8511         }
8512
8513         ++RExC_parse;
8514     }
8515 }
8516
8517 /*
8518  - reg - regular expression, i.e. main body or parenthesized thing
8519  *
8520  * Caller must absorb opening parenthesis.
8521  *
8522  * Combining parenthesis handling with the base level of regular expression
8523  * is a trifle forced, but the need to tie the tails of the branches to what
8524  * follows makes it hard to avoid.
8525  */
8526 #define REGTAIL(x,y,z) regtail((x),(y),(z),depth+1)
8527 #ifdef DEBUGGING
8528 #define REGTAIL_STUDY(x,y,z) regtail_study((x),(y),(z),depth+1)
8529 #else
8530 #define REGTAIL_STUDY(x,y,z) regtail((x),(y),(z),depth+1)
8531 #endif
8532
8533 /* Returns NULL, setting *flagp to TRYAGAIN at the end of (?) that only sets
8534    flags. Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan
8535    needs to be restarted.
8536    Otherwise would only return NULL if regbranch() returns NULL, which
8537    cannot happen.  */
8538 STATIC regnode *
8539 S_reg(pTHX_ RExC_state_t *pRExC_state, I32 paren, I32 *flagp,U32 depth)
8540     /* paren: Parenthesized? 0=top, 1=(, inside: changed to letter. */
8541 {
8542     dVAR;
8543     regnode *ret;               /* Will be the head of the group. */
8544     regnode *br;
8545     regnode *lastbr;
8546     regnode *ender = NULL;
8547     I32 parno = 0;
8548     I32 flags;
8549     U32 oregflags = RExC_flags;
8550     bool have_branch = 0;
8551     bool is_open = 0;
8552     I32 freeze_paren = 0;
8553     I32 after_freeze = 0;
8554
8555     char * parse_start = RExC_parse; /* MJD */
8556     char * const oregcomp_parse = RExC_parse;
8557
8558     GET_RE_DEBUG_FLAGS_DECL;
8559
8560     PERL_ARGS_ASSERT_REG;
8561     DEBUG_PARSE("reg ");
8562
8563     *flagp = 0;                         /* Tentatively. */
8564
8565
8566     /* Make an OPEN node, if parenthesized. */
8567     if (paren) {
8568         if ( *RExC_parse == '*') { /* (*VERB:ARG) */
8569             char *start_verb = RExC_parse;
8570             STRLEN verb_len = 0;
8571             char *start_arg = NULL;
8572             unsigned char op = 0;
8573             int argok = 1;
8574             int internal_argval = 0; /* internal_argval is only useful if !argok */
8575             while ( *RExC_parse && *RExC_parse != ')' ) {
8576                 if ( *RExC_parse == ':' ) {
8577                     start_arg = RExC_parse + 1;
8578                     break;
8579                 }
8580                 RExC_parse++;
8581             }
8582             ++start_verb;
8583             verb_len = RExC_parse - start_verb;
8584             if ( start_arg ) {
8585                 RExC_parse++;
8586                 while ( *RExC_parse && *RExC_parse != ')' ) 
8587                     RExC_parse++;
8588                 if ( *RExC_parse != ')' ) 
8589                     vFAIL("Unterminated verb pattern argument");
8590                 if ( RExC_parse == start_arg )
8591                     start_arg = NULL;
8592             } else {
8593                 if ( *RExC_parse != ')' )
8594                     vFAIL("Unterminated verb pattern");
8595             }
8596             
8597             switch ( *start_verb ) {
8598             case 'A':  /* (*ACCEPT) */
8599                 if ( memEQs(start_verb,verb_len,"ACCEPT") ) {
8600                     op = ACCEPT;
8601                     internal_argval = RExC_nestroot;
8602                 }
8603                 break;
8604             case 'C':  /* (*COMMIT) */
8605                 if ( memEQs(start_verb,verb_len,"COMMIT") )
8606                     op = COMMIT;
8607                 break;
8608             case 'F':  /* (*FAIL) */
8609                 if ( verb_len==1 || memEQs(start_verb,verb_len,"FAIL") ) {
8610                     op = OPFAIL;
8611                     argok = 0;
8612                 }
8613                 break;
8614             case ':':  /* (*:NAME) */
8615             case 'M':  /* (*MARK:NAME) */
8616                 if ( verb_len==0 || memEQs(start_verb,verb_len,"MARK") ) {
8617                     op = MARKPOINT;
8618                     argok = -1;
8619                 }
8620                 break;
8621             case 'P':  /* (*PRUNE) */
8622                 if ( memEQs(start_verb,verb_len,"PRUNE") )
8623                     op = PRUNE;
8624                 break;
8625             case 'S':   /* (*SKIP) */  
8626                 if ( memEQs(start_verb,verb_len,"SKIP") ) 
8627                     op = SKIP;
8628                 break;
8629             case 'T':  /* (*THEN) */
8630                 /* [19:06] <TimToady> :: is then */
8631                 if ( memEQs(start_verb,verb_len,"THEN") ) {
8632                     op = CUTGROUP;
8633                     RExC_seen |= REG_SEEN_CUTGROUP;
8634                 }
8635                 break;
8636             }
8637             if ( ! op ) {
8638                 RExC_parse++;
8639                 vFAIL3("Unknown verb pattern '%.*s'",
8640                     verb_len, start_verb);
8641             }
8642             if ( argok ) {
8643                 if ( start_arg && internal_argval ) {
8644                     vFAIL3("Verb pattern '%.*s' may not have an argument",
8645                         verb_len, start_verb); 
8646                 } else if ( argok < 0 && !start_arg ) {
8647                     vFAIL3("Verb pattern '%.*s' has a mandatory argument",
8648                         verb_len, start_verb);    
8649                 } else {
8650                     ret = reganode(pRExC_state, op, internal_argval);
8651                     if ( ! internal_argval && ! SIZE_ONLY ) {
8652                         if (start_arg) {
8653                             SV *sv = newSVpvn( start_arg, RExC_parse - start_arg);
8654                             ARG(ret) = add_data( pRExC_state, 1, "S" );
8655                             RExC_rxi->data->data[ARG(ret)]=(void*)sv;
8656                             ret->flags = 0;
8657                         } else {
8658                             ret->flags = 1; 
8659                         }
8660                     }               
8661                 }
8662                 if (!internal_argval)
8663                     RExC_seen |= REG_SEEN_VERBARG;
8664             } else if ( start_arg ) {
8665                 vFAIL3("Verb pattern '%.*s' may not have an argument",
8666                         verb_len, start_verb);    
8667             } else {
8668                 ret = reg_node(pRExC_state, op);
8669             }
8670             nextchar(pRExC_state);
8671             return ret;
8672         } else 
8673         if (*RExC_parse == '?') { /* (?...) */
8674             bool is_logical = 0;
8675             const char * const seqstart = RExC_parse;
8676
8677             RExC_parse++;
8678             paren = *RExC_parse++;
8679             ret = NULL;                 /* For look-ahead/behind. */
8680             switch (paren) {
8681
8682             case 'P':   /* (?P...) variants for those used to PCRE/Python */
8683                 paren = *RExC_parse++;
8684                 if ( paren == '<')         /* (?P<...>) named capture */
8685                     goto named_capture;
8686                 else if (paren == '>') {   /* (?P>name) named recursion */
8687                     goto named_recursion;
8688                 }
8689                 else if (paren == '=') {   /* (?P=...)  named backref */
8690                     /* this pretty much dupes the code for \k<NAME> in regatom(), if
8691                        you change this make sure you change that */
8692                     char* name_start = RExC_parse;
8693                     U32 num = 0;
8694                     SV *sv_dat = reg_scan_name(pRExC_state,
8695                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
8696                     if (RExC_parse == name_start || *RExC_parse != ')')
8697                         vFAIL2("Sequence %.3s... not terminated",parse_start);
8698
8699                     if (!SIZE_ONLY) {
8700                         num = add_data( pRExC_state, 1, "S" );
8701                         RExC_rxi->data->data[num]=(void*)sv_dat;
8702                         SvREFCNT_inc_simple_void(sv_dat);
8703                     }
8704                     RExC_sawback = 1;
8705                     ret = reganode(pRExC_state,
8706                                    ((! FOLD)
8707                                      ? NREF
8708                                      : (ASCII_FOLD_RESTRICTED)
8709                                        ? NREFFA
8710                                        : (AT_LEAST_UNI_SEMANTICS)
8711                                          ? NREFFU
8712                                          : (LOC)
8713                                            ? NREFFL
8714                                            : NREFF),
8715                                     num);
8716                     *flagp |= HASWIDTH;
8717
8718                     Set_Node_Offset(ret, parse_start+1);
8719                     Set_Node_Cur_Length(ret); /* MJD */
8720
8721                     nextchar(pRExC_state);
8722                     return ret;
8723                 }
8724                 RExC_parse++;
8725                 vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
8726                 /*NOTREACHED*/
8727             case '<':           /* (?<...) */
8728                 if (*RExC_parse == '!')
8729                     paren = ',';
8730                 else if (*RExC_parse != '=') 
8731               named_capture:
8732                 {               /* (?<...>) */
8733                     char *name_start;
8734                     SV *svname;
8735                     paren= '>';
8736             case '\'':          /* (?'...') */
8737                     name_start= RExC_parse;
8738                     svname = reg_scan_name(pRExC_state,
8739                         SIZE_ONLY ?  /* reverse test from the others */
8740                         REG_RSN_RETURN_NAME : 
8741                         REG_RSN_RETURN_NULL);
8742                     if (RExC_parse == name_start) {
8743                         RExC_parse++;
8744                         vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
8745                         /*NOTREACHED*/
8746                     }
8747                     if (*RExC_parse != paren)
8748                         vFAIL2("Sequence (?%c... not terminated",
8749                             paren=='>' ? '<' : paren);
8750                     if (SIZE_ONLY) {
8751                         HE *he_str;
8752                         SV *sv_dat = NULL;
8753                         if (!svname) /* shouldn't happen */
8754                             Perl_croak(aTHX_
8755                                 "panic: reg_scan_name returned NULL");
8756                         if (!RExC_paren_names) {
8757                             RExC_paren_names= newHV();
8758                             sv_2mortal(MUTABLE_SV(RExC_paren_names));
8759 #ifdef DEBUGGING
8760                             RExC_paren_name_list= newAV();
8761                             sv_2mortal(MUTABLE_SV(RExC_paren_name_list));
8762 #endif
8763                         }
8764                         he_str = hv_fetch_ent( RExC_paren_names, svname, 1, 0 );
8765                         if ( he_str )
8766                             sv_dat = HeVAL(he_str);
8767                         if ( ! sv_dat ) {
8768                             /* croak baby croak */
8769                             Perl_croak(aTHX_
8770                                 "panic: paren_name hash element allocation failed");
8771                         } else if ( SvPOK(sv_dat) ) {
8772                             /* (?|...) can mean we have dupes so scan to check
8773                                its already been stored. Maybe a flag indicating
8774                                we are inside such a construct would be useful,
8775                                but the arrays are likely to be quite small, so
8776                                for now we punt -- dmq */
8777                             IV count = SvIV(sv_dat);
8778                             I32 *pv = (I32*)SvPVX(sv_dat);
8779                             IV i;
8780                             for ( i = 0 ; i < count ; i++ ) {
8781                                 if ( pv[i] == RExC_npar ) {
8782                                     count = 0;
8783                                     break;
8784                                 }
8785                             }
8786                             if ( count ) {
8787                                 pv = (I32*)SvGROW(sv_dat, SvCUR(sv_dat) + sizeof(I32)+1);
8788                                 SvCUR_set(sv_dat, SvCUR(sv_dat) + sizeof(I32));
8789                                 pv[count] = RExC_npar;
8790                                 SvIV_set(sv_dat, SvIVX(sv_dat) + 1);
8791                             }
8792                         } else {
8793                             (void)SvUPGRADE(sv_dat,SVt_PVNV);
8794                             sv_setpvn(sv_dat, (char *)&(RExC_npar), sizeof(I32));
8795                             SvIOK_on(sv_dat);
8796                             SvIV_set(sv_dat, 1);
8797                         }
8798 #ifdef DEBUGGING
8799                         /* Yes this does cause a memory leak in debugging Perls */
8800                         if (!av_store(RExC_paren_name_list, RExC_npar, SvREFCNT_inc(svname)))
8801                             SvREFCNT_dec_NN(svname);
8802 #endif
8803
8804                         /*sv_dump(sv_dat);*/
8805                     }
8806                     nextchar(pRExC_state);
8807                     paren = 1;
8808                     goto capturing_parens;
8809                 }
8810                 RExC_seen |= REG_SEEN_LOOKBEHIND;
8811                 RExC_in_lookbehind++;
8812                 RExC_parse++;
8813             case '=':           /* (?=...) */
8814                 RExC_seen_zerolen++;
8815                 break;
8816             case '!':           /* (?!...) */
8817                 RExC_seen_zerolen++;
8818                 if (*RExC_parse == ')') {
8819                     ret=reg_node(pRExC_state, OPFAIL);
8820                     nextchar(pRExC_state);
8821                     return ret;
8822                 }
8823                 break;
8824             case '|':           /* (?|...) */
8825                 /* branch reset, behave like a (?:...) except that
8826                    buffers in alternations share the same numbers */
8827                 paren = ':'; 
8828                 after_freeze = freeze_paren = RExC_npar;
8829                 break;
8830             case ':':           /* (?:...) */
8831             case '>':           /* (?>...) */
8832                 break;
8833             case '$':           /* (?$...) */
8834             case '@':           /* (?@...) */
8835                 vFAIL2("Sequence (?%c...) not implemented", (int)paren);
8836                 break;
8837             case '0' :           /* (?0) */
8838             case 'R' :           /* (?R) */
8839                 if (*RExC_parse != ')')
8840                     FAIL("Sequence (?R) not terminated");
8841                 ret = reg_node(pRExC_state, GOSTART);
8842                 *flagp |= POSTPONED;
8843                 nextchar(pRExC_state);
8844                 return ret;
8845                 /*notreached*/
8846             { /* named and numeric backreferences */
8847                 I32 num;
8848             case '&':            /* (?&NAME) */
8849                 parse_start = RExC_parse - 1;
8850               named_recursion:
8851                 {
8852                     SV *sv_dat = reg_scan_name(pRExC_state,
8853                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
8854                      num = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
8855                 }
8856                 goto gen_recurse_regop;
8857                 assert(0); /* NOT REACHED */
8858             case '+':
8859                 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
8860                     RExC_parse++;
8861                     vFAIL("Illegal pattern");
8862                 }
8863                 goto parse_recursion;
8864                 /* NOT REACHED*/
8865             case '-': /* (?-1) */
8866                 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
8867                     RExC_parse--; /* rewind to let it be handled later */
8868                     goto parse_flags;
8869                 } 
8870                 /*FALLTHROUGH */
8871             case '1': case '2': case '3': case '4': /* (?1) */
8872             case '5': case '6': case '7': case '8': case '9':
8873                 RExC_parse--;
8874               parse_recursion:
8875                 num = atoi(RExC_parse);
8876                 parse_start = RExC_parse - 1; /* MJD */
8877                 if (*RExC_parse == '-')
8878                     RExC_parse++;
8879                 while (isDIGIT(*RExC_parse))
8880                         RExC_parse++;
8881                 if (*RExC_parse!=')') 
8882                     vFAIL("Expecting close bracket");
8883
8884               gen_recurse_regop:
8885                 if ( paren == '-' ) {
8886                     /*
8887                     Diagram of capture buffer numbering.
8888                     Top line is the normal capture buffer numbers
8889                     Bottom line is the negative indexing as from
8890                     the X (the (?-2))
8891
8892                     +   1 2    3 4 5 X          6 7
8893                        /(a(x)y)(a(b(c(?-2)d)e)f)(g(h))/
8894                     -   5 4    3 2 1 X          x x
8895
8896                     */
8897                     num = RExC_npar + num;
8898                     if (num < 1)  {
8899                         RExC_parse++;
8900                         vFAIL("Reference to nonexistent group");
8901                     }
8902                 } else if ( paren == '+' ) {
8903                     num = RExC_npar + num - 1;
8904                 }
8905
8906                 ret = reganode(pRExC_state, GOSUB, num);
8907                 if (!SIZE_ONLY) {
8908                     if (num > (I32)RExC_rx->nparens) {
8909                         RExC_parse++;
8910                         vFAIL("Reference to nonexistent group");
8911                     }
8912                     ARG2L_SET( ret, RExC_recurse_count++);
8913                     RExC_emit++;
8914                     DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
8915                         "Recurse #%"UVuf" to %"IVdf"\n", (UV)ARG(ret), (IV)ARG2L(ret)));
8916                 } else {
8917                     RExC_size++;
8918                 }
8919                 RExC_seen |= REG_SEEN_RECURSE;
8920                 Set_Node_Length(ret, 1 + regarglen[OP(ret)]); /* MJD */
8921                 Set_Node_Offset(ret, parse_start); /* MJD */
8922
8923                 *flagp |= POSTPONED;
8924                 nextchar(pRExC_state);
8925                 return ret;
8926             } /* named and numeric backreferences */
8927             assert(0); /* NOT REACHED */
8928
8929             case '?':           /* (??...) */
8930                 is_logical = 1;
8931                 if (*RExC_parse != '{') {
8932                     RExC_parse++;
8933                     vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
8934                     /*NOTREACHED*/
8935                 }
8936                 *flagp |= POSTPONED;
8937                 paren = *RExC_parse++;
8938                 /* FALL THROUGH */
8939             case '{':           /* (?{...}) */
8940             {
8941                 U32 n = 0;
8942                 struct reg_code_block *cb;
8943
8944                 RExC_seen_zerolen++;
8945
8946                 if (   !pRExC_state->num_code_blocks
8947                     || pRExC_state->code_index >= pRExC_state->num_code_blocks
8948                     || pRExC_state->code_blocks[pRExC_state->code_index].start
8949                         != (STRLEN)((RExC_parse -3 - (is_logical ? 1 : 0))
8950                             - RExC_start)
8951                 ) {
8952                     if (RExC_pm_flags & PMf_USE_RE_EVAL)
8953                         FAIL("panic: Sequence (?{...}): no code block found\n");
8954                     FAIL("Eval-group not allowed at runtime, use re 'eval'");
8955                 }
8956                 /* this is a pre-compiled code block (?{...}) */
8957                 cb = &pRExC_state->code_blocks[pRExC_state->code_index];
8958                 RExC_parse = RExC_start + cb->end;
8959                 if (!SIZE_ONLY) {
8960                     OP *o = cb->block;
8961                     if (cb->src_regex) {
8962                         n = add_data(pRExC_state, 2, "rl");
8963                         RExC_rxi->data->data[n] =
8964                             (void*)SvREFCNT_inc((SV*)cb->src_regex);
8965                         RExC_rxi->data->data[n+1] = (void*)o;
8966                     }
8967                     else {
8968                         n = add_data(pRExC_state, 1,
8969                                (RExC_pm_flags & PMf_HAS_CV) ? "L" : "l");
8970                         RExC_rxi->data->data[n] = (void*)o;
8971                     }
8972                 }
8973                 pRExC_state->code_index++;
8974                 nextchar(pRExC_state);
8975
8976                 if (is_logical) {
8977                     regnode *eval;
8978                     ret = reg_node(pRExC_state, LOGICAL);
8979                     eval = reganode(pRExC_state, EVAL, n);
8980                     if (!SIZE_ONLY) {
8981                         ret->flags = 2;
8982                         /* for later propagation into (??{}) return value */
8983                         eval->flags = (U8) (RExC_flags & RXf_PMf_COMPILETIME);
8984                     }
8985                     REGTAIL(pRExC_state, ret, eval);
8986                     /* deal with the length of this later - MJD */
8987                     return ret;
8988                 }
8989                 ret = reganode(pRExC_state, EVAL, n);
8990                 Set_Node_Length(ret, RExC_parse - parse_start + 1);
8991                 Set_Node_Offset(ret, parse_start);
8992                 return ret;
8993             }
8994             case '(':           /* (?(?{...})...) and (?(?=...)...) */
8995             {
8996                 int is_define= 0;
8997                 if (RExC_parse[0] == '?') {        /* (?(?...)) */
8998                     if (RExC_parse[1] == '=' || RExC_parse[1] == '!'
8999                         || RExC_parse[1] == '<'
9000                         || RExC_parse[1] == '{') { /* Lookahead or eval. */
9001                         I32 flag;
9002                         regnode *tail;
9003
9004                         ret = reg_node(pRExC_state, LOGICAL);
9005                         if (!SIZE_ONLY)
9006                             ret->flags = 1;
9007                         
9008                         tail = reg(pRExC_state, 1, &flag, depth+1);
9009                         if (flag & RESTART_UTF8) {
9010                             *flagp = RESTART_UTF8;
9011                             return NULL;
9012                         }
9013                         REGTAIL(pRExC_state, ret, tail);
9014                         goto insert_if;
9015                     }
9016                 }
9017                 else if ( RExC_parse[0] == '<'     /* (?(<NAME>)...) */
9018                          || RExC_parse[0] == '\'' ) /* (?('NAME')...) */
9019                 {
9020                     char ch = RExC_parse[0] == '<' ? '>' : '\'';
9021                     char *name_start= RExC_parse++;
9022                     U32 num = 0;
9023                     SV *sv_dat=reg_scan_name(pRExC_state,
9024                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
9025                     if (RExC_parse == name_start || *RExC_parse != ch)
9026                         vFAIL2("Sequence (?(%c... not terminated",
9027                             (ch == '>' ? '<' : ch));
9028                     RExC_parse++;
9029                     if (!SIZE_ONLY) {
9030                         num = add_data( pRExC_state, 1, "S" );
9031                         RExC_rxi->data->data[num]=(void*)sv_dat;
9032                         SvREFCNT_inc_simple_void(sv_dat);
9033                     }
9034                     ret = reganode(pRExC_state,NGROUPP,num);
9035                     goto insert_if_check_paren;
9036                 }
9037                 else if (RExC_parse[0] == 'D' &&
9038                          RExC_parse[1] == 'E' &&
9039                          RExC_parse[2] == 'F' &&
9040                          RExC_parse[3] == 'I' &&
9041                          RExC_parse[4] == 'N' &&
9042                          RExC_parse[5] == 'E')
9043                 {
9044                     ret = reganode(pRExC_state,DEFINEP,0);
9045                     RExC_parse +=6 ;
9046                     is_define = 1;
9047                     goto insert_if_check_paren;
9048                 }
9049                 else if (RExC_parse[0] == 'R') {
9050                     RExC_parse++;
9051                     parno = 0;
9052                     if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
9053                         parno = atoi(RExC_parse++);
9054                         while (isDIGIT(*RExC_parse))
9055                             RExC_parse++;
9056                     } else if (RExC_parse[0] == '&') {
9057                         SV *sv_dat;
9058                         RExC_parse++;
9059                         sv_dat = reg_scan_name(pRExC_state,
9060                             SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
9061                         parno = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
9062                     }
9063                     ret = reganode(pRExC_state,INSUBP,parno); 
9064                     goto insert_if_check_paren;
9065                 }
9066                 else if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
9067                     /* (?(1)...) */
9068                     char c;
9069                     parno = atoi(RExC_parse++);
9070
9071                     while (isDIGIT(*RExC_parse))
9072                         RExC_parse++;
9073                     ret = reganode(pRExC_state, GROUPP, parno);
9074
9075                  insert_if_check_paren:
9076                     if ((c = *nextchar(pRExC_state)) != ')')
9077                         vFAIL("Switch condition not recognized");
9078                   insert_if:
9079                     REGTAIL(pRExC_state, ret, reganode(pRExC_state, IFTHEN, 0));
9080                     br = regbranch(pRExC_state, &flags, 1,depth+1);
9081                     if (br == NULL) {
9082                         if (flags & RESTART_UTF8) {
9083                             *flagp = RESTART_UTF8;
9084                             return NULL;
9085                         }
9086                         FAIL2("panic: regbranch returned NULL, flags=%#X",
9087                               flags);
9088                     } else
9089                         REGTAIL(pRExC_state, br, reganode(pRExC_state, LONGJMP, 0));
9090                     c = *nextchar(pRExC_state);
9091                     if (flags&HASWIDTH)
9092                         *flagp |= HASWIDTH;
9093                     if (c == '|') {
9094                         if (is_define) 
9095                             vFAIL("(?(DEFINE)....) does not allow branches");
9096                         lastbr = reganode(pRExC_state, IFTHEN, 0); /* Fake one for optimizer. */
9097                         if (!regbranch(pRExC_state, &flags, 1,depth+1)) {
9098                             if (flags & RESTART_UTF8) {
9099                                 *flagp = RESTART_UTF8;
9100                                 return NULL;
9101                             }
9102                             FAIL2("panic: regbranch returned NULL, flags=%#X",
9103                                   flags);
9104                         }
9105                         REGTAIL(pRExC_state, ret, lastbr);
9106                         if (flags&HASWIDTH)
9107                             *flagp |= HASWIDTH;
9108                         c = *nextchar(pRExC_state);
9109                     }
9110                     else
9111                         lastbr = NULL;
9112                     if (c != ')')
9113                         vFAIL("Switch (?(condition)... contains too many branches");
9114                     ender = reg_node(pRExC_state, TAIL);
9115                     REGTAIL(pRExC_state, br, ender);
9116                     if (lastbr) {
9117                         REGTAIL(pRExC_state, lastbr, ender);
9118                         REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender);
9119                     }
9120                     else
9121                         REGTAIL(pRExC_state, ret, ender);
9122                     RExC_size++; /* XXX WHY do we need this?!!
9123                                     For large programs it seems to be required
9124                                     but I can't figure out why. -- dmq*/
9125                     return ret;
9126                 }
9127                 else {
9128                     vFAIL2("Unknown switch condition (?(%.2s", RExC_parse);
9129                 }
9130             }
9131             case '[':           /* (?[ ... ]) */
9132                 return handle_regex_sets(pRExC_state, NULL, flagp, depth,
9133                                          oregcomp_parse);
9134             case 0:
9135                 RExC_parse--; /* for vFAIL to print correctly */
9136                 vFAIL("Sequence (? incomplete");
9137                 break;
9138             default: /* e.g., (?i) */
9139                 --RExC_parse;
9140               parse_flags:
9141                 parse_lparen_question_flags(pRExC_state);
9142                 if (UCHARAT(RExC_parse) != ':') {
9143                     nextchar(pRExC_state);
9144                     *flagp = TRYAGAIN;
9145                     return NULL;
9146                 }
9147                 paren = ':';
9148                 nextchar(pRExC_state);
9149                 ret = NULL;
9150                 goto parse_rest;
9151             } /* end switch */
9152         }
9153         else {                  /* (...) */
9154           capturing_parens:
9155             parno = RExC_npar;
9156             RExC_npar++;
9157             
9158             ret = reganode(pRExC_state, OPEN, parno);
9159             if (!SIZE_ONLY ){
9160                 if (!RExC_nestroot) 
9161                     RExC_nestroot = parno;
9162                 if (RExC_seen & REG_SEEN_RECURSE
9163                     && !RExC_open_parens[parno-1])
9164                 {
9165                     DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
9166                         "Setting open paren #%"IVdf" to %d\n", 
9167                         (IV)parno, REG_NODE_NUM(ret)));
9168                     RExC_open_parens[parno-1]= ret;
9169                 }
9170             }
9171             Set_Node_Length(ret, 1); /* MJD */
9172             Set_Node_Offset(ret, RExC_parse); /* MJD */
9173             is_open = 1;
9174         }
9175     }
9176     else                        /* ! paren */
9177         ret = NULL;
9178    
9179    parse_rest:
9180     /* Pick up the branches, linking them together. */
9181     parse_start = RExC_parse;   /* MJD */
9182     br = regbranch(pRExC_state, &flags, 1,depth+1);
9183
9184     /*     branch_len = (paren != 0); */
9185
9186     if (br == NULL) {
9187         if (flags & RESTART_UTF8) {
9188             *flagp = RESTART_UTF8;
9189             return NULL;
9190         }
9191         FAIL2("panic: regbranch returned NULL, flags=%#X", flags);
9192     }
9193     if (*RExC_parse == '|') {
9194         if (!SIZE_ONLY && RExC_extralen) {
9195             reginsert(pRExC_state, BRANCHJ, br, depth+1);
9196         }
9197         else {                  /* MJD */
9198             reginsert(pRExC_state, BRANCH, br, depth+1);
9199             Set_Node_Length(br, paren != 0);
9200             Set_Node_Offset_To_R(br-RExC_emit_start, parse_start-RExC_start);
9201         }
9202         have_branch = 1;
9203         if (SIZE_ONLY)
9204             RExC_extralen += 1;         /* For BRANCHJ-BRANCH. */
9205     }
9206     else if (paren == ':') {
9207         *flagp |= flags&SIMPLE;
9208     }
9209     if (is_open) {                              /* Starts with OPEN. */
9210         REGTAIL(pRExC_state, ret, br);          /* OPEN -> first. */
9211     }
9212     else if (paren != '?')              /* Not Conditional */
9213         ret = br;
9214     *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
9215     lastbr = br;
9216     while (*RExC_parse == '|') {
9217         if (!SIZE_ONLY && RExC_extralen) {
9218             ender = reganode(pRExC_state, LONGJMP,0);
9219             REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender); /* Append to the previous. */
9220         }
9221         if (SIZE_ONLY)
9222             RExC_extralen += 2;         /* Account for LONGJMP. */
9223         nextchar(pRExC_state);
9224         if (freeze_paren) {
9225             if (RExC_npar > after_freeze)
9226                 after_freeze = RExC_npar;
9227             RExC_npar = freeze_paren;       
9228         }
9229         br = regbranch(pRExC_state, &flags, 0, depth+1);
9230
9231         if (br == NULL) {
9232             if (flags & RESTART_UTF8) {
9233                 *flagp = RESTART_UTF8;
9234                 return NULL;
9235             }
9236             FAIL2("panic: regbranch returned NULL, flags=%#X", flags);
9237         }
9238         REGTAIL(pRExC_state, lastbr, br);               /* BRANCH -> BRANCH. */
9239         lastbr = br;
9240         *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
9241     }
9242
9243     if (have_branch || paren != ':') {
9244         /* Make a closing node, and hook it on the end. */
9245         switch (paren) {
9246         case ':':
9247             ender = reg_node(pRExC_state, TAIL);
9248             break;
9249         case 1:
9250             ender = reganode(pRExC_state, CLOSE, parno);
9251             if (!SIZE_ONLY && RExC_seen & REG_SEEN_RECURSE) {
9252                 DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
9253                         "Setting close paren #%"IVdf" to %d\n", 
9254                         (IV)parno, REG_NODE_NUM(ender)));
9255                 RExC_close_parens[parno-1]= ender;
9256                 if (RExC_nestroot == parno) 
9257                     RExC_nestroot = 0;
9258             }       
9259             Set_Node_Offset(ender,RExC_parse+1); /* MJD */
9260             Set_Node_Length(ender,1); /* MJD */
9261             break;
9262         case '<':
9263         case ',':
9264         case '=':
9265         case '!':
9266             *flagp &= ~HASWIDTH;
9267             /* FALL THROUGH */
9268         case '>':
9269             ender = reg_node(pRExC_state, SUCCEED);
9270             break;
9271         case 0:
9272             ender = reg_node(pRExC_state, END);
9273             if (!SIZE_ONLY) {
9274                 assert(!RExC_opend); /* there can only be one! */
9275                 RExC_opend = ender;
9276             }
9277             break;
9278         }
9279         DEBUG_PARSE_r(if (!SIZE_ONLY) {
9280             SV * const mysv_val1=sv_newmortal();
9281             SV * const mysv_val2=sv_newmortal();
9282             DEBUG_PARSE_MSG("lsbr");
9283             regprop(RExC_rx, mysv_val1, lastbr);
9284             regprop(RExC_rx, mysv_val2, ender);
9285             PerlIO_printf(Perl_debug_log, "~ tying lastbr %s (%"IVdf") to ender %s (%"IVdf") offset %"IVdf"\n",
9286                           SvPV_nolen_const(mysv_val1),
9287                           (IV)REG_NODE_NUM(lastbr),
9288                           SvPV_nolen_const(mysv_val2),
9289                           (IV)REG_NODE_NUM(ender),
9290                           (IV)(ender - lastbr)
9291             );
9292         });
9293         REGTAIL(pRExC_state, lastbr, ender);
9294
9295         if (have_branch && !SIZE_ONLY) {
9296             char is_nothing= 1;
9297             if (depth==1)
9298                 RExC_seen |= REG_TOP_LEVEL_BRANCHES;
9299
9300             /* Hook the tails of the branches to the closing node. */
9301             for (br = ret; br; br = regnext(br)) {
9302                 const U8 op = PL_regkind[OP(br)];
9303                 if (op == BRANCH) {
9304                     REGTAIL_STUDY(pRExC_state, NEXTOPER(br), ender);
9305                     if (OP(NEXTOPER(br)) != NOTHING || regnext(NEXTOPER(br)) != ender)
9306                         is_nothing= 0;
9307                 }
9308                 else if (op == BRANCHJ) {
9309                     REGTAIL_STUDY(pRExC_state, NEXTOPER(NEXTOPER(br)), ender);
9310                     /* for now we always disable this optimisation * /
9311                     if (OP(NEXTOPER(NEXTOPER(br))) != NOTHING || regnext(NEXTOPER(NEXTOPER(br))) != ender)
9312                     */
9313                         is_nothing= 0;
9314                 }
9315             }
9316             if (is_nothing) {
9317                 br= PL_regkind[OP(ret)] != BRANCH ? regnext(ret) : ret;
9318                 DEBUG_PARSE_r(if (!SIZE_ONLY) {
9319                     SV * const mysv_val1=sv_newmortal();
9320                     SV * const mysv_val2=sv_newmortal();
9321                     DEBUG_PARSE_MSG("NADA");
9322                     regprop(RExC_rx, mysv_val1, ret);
9323                     regprop(RExC_rx, mysv_val2, ender);
9324                     PerlIO_printf(Perl_debug_log, "~ converting ret %s (%"IVdf") to ender %s (%"IVdf") offset %"IVdf"\n",
9325                                   SvPV_nolen_const(mysv_val1),
9326                                   (IV)REG_NODE_NUM(ret),
9327                                   SvPV_nolen_const(mysv_val2),
9328                                   (IV)REG_NODE_NUM(ender),
9329                                   (IV)(ender - ret)
9330                     );
9331                 });
9332                 OP(br)= NOTHING;
9333                 if (OP(ender) == TAIL) {
9334                     NEXT_OFF(br)= 0;
9335                     RExC_emit= br + 1;
9336                 } else {
9337                     regnode *opt;
9338                     for ( opt= br + 1; opt < ender ; opt++ )
9339                         OP(opt)= OPTIMIZED;
9340                     NEXT_OFF(br)= ender - br;
9341                 }
9342             }
9343         }
9344     }
9345
9346     {
9347         const char *p;
9348         static const char parens[] = "=!<,>";
9349
9350         if (paren && (p = strchr(parens, paren))) {
9351             U8 node = ((p - parens) % 2) ? UNLESSM : IFMATCH;
9352             int flag = (p - parens) > 1;
9353
9354             if (paren == '>')
9355                 node = SUSPEND, flag = 0;
9356             reginsert(pRExC_state, node,ret, depth+1);
9357             Set_Node_Cur_Length(ret);
9358             Set_Node_Offset(ret, parse_start + 1);
9359             ret->flags = flag;
9360             REGTAIL_STUDY(pRExC_state, ret, reg_node(pRExC_state, TAIL));
9361         }
9362     }
9363
9364     /* Check for proper termination. */
9365     if (paren) {
9366         RExC_flags = oregflags;
9367         if (RExC_parse >= RExC_end || *nextchar(pRExC_state) != ')') {
9368             RExC_parse = oregcomp_parse;
9369             vFAIL("Unmatched (");
9370         }
9371     }
9372     else if (!paren && RExC_parse < RExC_end) {
9373         if (*RExC_parse == ')') {
9374             RExC_parse++;
9375             vFAIL("Unmatched )");
9376         }
9377         else
9378             FAIL("Junk on end of regexp");      /* "Can't happen". */
9379         assert(0); /* NOTREACHED */
9380     }
9381
9382     if (RExC_in_lookbehind) {
9383         RExC_in_lookbehind--;
9384     }
9385     if (after_freeze > RExC_npar)
9386         RExC_npar = after_freeze;
9387     return(ret);
9388 }
9389
9390 /*
9391  - regbranch - one alternative of an | operator
9392  *
9393  * Implements the concatenation operator.
9394  *
9395  * Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan needs to be
9396  * restarted.
9397  */
9398 STATIC regnode *
9399 S_regbranch(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, I32 first, U32 depth)
9400 {
9401     dVAR;
9402     regnode *ret;
9403     regnode *chain = NULL;
9404     regnode *latest;
9405     I32 flags = 0, c = 0;
9406     GET_RE_DEBUG_FLAGS_DECL;
9407
9408     PERL_ARGS_ASSERT_REGBRANCH;
9409
9410     DEBUG_PARSE("brnc");
9411
9412     if (first)
9413         ret = NULL;
9414     else {
9415         if (!SIZE_ONLY && RExC_extralen)
9416             ret = reganode(pRExC_state, BRANCHJ,0);
9417         else {
9418             ret = reg_node(pRExC_state, BRANCH);
9419             Set_Node_Length(ret, 1);
9420         }
9421     }
9422
9423     if (!first && SIZE_ONLY)
9424         RExC_extralen += 1;                     /* BRANCHJ */
9425
9426     *flagp = WORST;                     /* Tentatively. */
9427
9428     RExC_parse--;
9429     nextchar(pRExC_state);
9430     while (RExC_parse < RExC_end && *RExC_parse != '|' && *RExC_parse != ')') {
9431         flags &= ~TRYAGAIN;
9432         latest = regpiece(pRExC_state, &flags,depth+1);
9433         if (latest == NULL) {
9434             if (flags & TRYAGAIN)
9435                 continue;
9436             if (flags & RESTART_UTF8) {
9437                 *flagp = RESTART_UTF8;
9438                 return NULL;
9439             }
9440             FAIL2("panic: regpiece returned NULL, flags=%#X", flags);
9441         }
9442         else if (ret == NULL)
9443             ret = latest;
9444         *flagp |= flags&(HASWIDTH|POSTPONED);
9445         if (chain == NULL)      /* First piece. */
9446             *flagp |= flags&SPSTART;
9447         else {
9448             RExC_naughty++;
9449             REGTAIL(pRExC_state, chain, latest);
9450         }
9451         chain = latest;
9452         c++;
9453     }
9454     if (chain == NULL) {        /* Loop ran zero times. */
9455         chain = reg_node(pRExC_state, NOTHING);
9456         if (ret == NULL)
9457             ret = chain;
9458     }
9459     if (c == 1) {
9460         *flagp |= flags&SIMPLE;
9461     }
9462
9463     return ret;
9464 }
9465
9466 /*
9467  - regpiece - something followed by possible [*+?]
9468  *
9469  * Note that the branching code sequences used for ? and the general cases
9470  * of * and + are somewhat optimized:  they use the same NOTHING node as
9471  * both the endmarker for their branch list and the body of the last branch.
9472  * It might seem that this node could be dispensed with entirely, but the
9473  * endmarker role is not redundant.
9474  *
9475  * Returns NULL, setting *flagp to TRYAGAIN if regatom() returns NULL with
9476  * TRYAGAIN.
9477  * Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan needs to be
9478  * restarted.
9479  */
9480 STATIC regnode *
9481 S_regpiece(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
9482 {
9483     dVAR;
9484     regnode *ret;
9485     char op;
9486     char *next;
9487     I32 flags;
9488     const char * const origparse = RExC_parse;
9489     I32 min;
9490     I32 max = REG_INFTY;
9491 #ifdef RE_TRACK_PATTERN_OFFSETS
9492     char *parse_start;
9493 #endif
9494     const char *maxpos = NULL;
9495
9496     /* Save the original in case we change the emitted regop to a FAIL. */
9497     regnode * const orig_emit = RExC_emit;
9498
9499     GET_RE_DEBUG_FLAGS_DECL;
9500
9501     PERL_ARGS_ASSERT_REGPIECE;
9502
9503     DEBUG_PARSE("piec");
9504
9505     ret = regatom(pRExC_state, &flags,depth+1);
9506     if (ret == NULL) {
9507         if (flags & (TRYAGAIN|RESTART_UTF8))
9508             *flagp |= flags & (TRYAGAIN|RESTART_UTF8);
9509         else
9510             FAIL2("panic: regatom returned NULL, flags=%#X", flags);
9511         return(NULL);
9512     }
9513
9514     op = *RExC_parse;
9515
9516     if (op == '{' && regcurly(RExC_parse, FALSE)) {
9517         maxpos = NULL;
9518 #ifdef RE_TRACK_PATTERN_OFFSETS
9519         parse_start = RExC_parse; /* MJD */
9520 #endif
9521         next = RExC_parse + 1;
9522         while (isDIGIT(*next) || *next == ',') {
9523             if (*next == ',') {
9524                 if (maxpos)
9525                     break;
9526                 else
9527                     maxpos = next;
9528             }
9529             next++;
9530         }
9531         if (*next == '}') {             /* got one */
9532             if (!maxpos)
9533                 maxpos = next;
9534             RExC_parse++;
9535             min = atoi(RExC_parse);
9536             if (*maxpos == ',')
9537                 maxpos++;
9538             else
9539                 maxpos = RExC_parse;
9540             max = atoi(maxpos);
9541             if (!max && *maxpos != '0')
9542                 max = REG_INFTY;                /* meaning "infinity" */
9543             else if (max >= REG_INFTY)
9544                 vFAIL2("Quantifier in {,} bigger than %d", REG_INFTY - 1);
9545             RExC_parse = next;
9546             nextchar(pRExC_state);
9547             if (max < min) {    /* If can't match, warn and optimize to fail
9548                                    unconditionally */
9549                 if (SIZE_ONLY) {
9550                     ckWARNreg(RExC_parse, "Quantifier {n,m} with n > m can't match");
9551
9552                     /* We can't back off the size because we have to reserve
9553                      * enough space for all the things we are about to throw
9554                      * away, but we can shrink it by the ammount we are about
9555                      * to re-use here */
9556                     RExC_size = PREVOPER(RExC_size) - regarglen[(U8)OPFAIL];
9557                 }
9558                 else {
9559                     RExC_emit = orig_emit;
9560                 }
9561                 ret = reg_node(pRExC_state, OPFAIL);
9562                 return ret;
9563             }
9564             else if (max == 0) {    /* replace {0} with a nothing node */
9565                 if (SIZE_ONLY) {
9566                     RExC_size = PREVOPER(RExC_size) - regarglen[(U8)NOTHING];
9567                 }
9568                 else {
9569                     RExC_emit = orig_emit;
9570                 }
9571                 ret = reg_node(pRExC_state, NOTHING);
9572                 return ret;
9573             }
9574
9575         do_curly:
9576             if ((flags&SIMPLE)) {
9577                 RExC_naughty += 2 + RExC_naughty / 2;
9578                 reginsert(pRExC_state, CURLY, ret, depth+1);
9579                 Set_Node_Offset(ret, parse_start+1); /* MJD */
9580                 Set_Node_Cur_Length(ret);
9581             }
9582             else {
9583                 regnode * const w = reg_node(pRExC_state, WHILEM);
9584
9585                 w->flags = 0;
9586                 REGTAIL(pRExC_state, ret, w);
9587                 if (!SIZE_ONLY && RExC_extralen) {
9588                     reginsert(pRExC_state, LONGJMP,ret, depth+1);
9589                     reginsert(pRExC_state, NOTHING,ret, depth+1);
9590                     NEXT_OFF(ret) = 3;  /* Go over LONGJMP. */
9591                 }
9592                 reginsert(pRExC_state, CURLYX,ret, depth+1);
9593                                 /* MJD hk */
9594                 Set_Node_Offset(ret, parse_start+1);
9595                 Set_Node_Length(ret,
9596                                 op == '{' ? (RExC_parse - parse_start) : 1);
9597
9598                 if (!SIZE_ONLY && RExC_extralen)
9599                     NEXT_OFF(ret) = 3;  /* Go over NOTHING to LONGJMP. */
9600                 REGTAIL(pRExC_state, ret, reg_node(pRExC_state, NOTHING));
9601                 if (SIZE_ONLY)
9602                     RExC_whilem_seen++, RExC_extralen += 3;
9603                 RExC_naughty += 4 + RExC_naughty;       /* compound interest */
9604             }
9605             ret->flags = 0;
9606
9607             if (min > 0)
9608                 *flagp = WORST;
9609             if (max > 0)
9610                 *flagp |= HASWIDTH;
9611             if (!SIZE_ONLY) {
9612                 ARG1_SET(ret, (U16)min);
9613                 ARG2_SET(ret, (U16)max);
9614             }
9615
9616             goto nest_check;
9617         }
9618     }
9619
9620     if (!ISMULT1(op)) {
9621         *flagp = flags;
9622         return(ret);
9623     }
9624
9625 #if 0                           /* Now runtime fix should be reliable. */
9626
9627     /* if this is reinstated, don't forget to put this back into perldiag:
9628
9629             =item Regexp *+ operand could be empty at {#} in regex m/%s/
9630
9631            (F) The part of the regexp subject to either the * or + quantifier
9632            could match an empty string. The {#} shows in the regular
9633            expression about where the problem was discovered.
9634
9635     */
9636
9637     if (!(flags&HASWIDTH) && op != '?')
9638       vFAIL("Regexp *+ operand could be empty");
9639 #endif
9640
9641 #ifdef RE_TRACK_PATTERN_OFFSETS
9642     parse_start = RExC_parse;
9643 #endif
9644     nextchar(pRExC_state);
9645
9646     *flagp = (op != '+') ? (WORST|SPSTART|HASWIDTH) : (WORST|HASWIDTH);
9647
9648     if (op == '*' && (flags&SIMPLE)) {
9649         reginsert(pRExC_state, STAR, ret, depth+1);
9650         ret->flags = 0;
9651         RExC_naughty += 4;
9652     }
9653     else if (op == '*') {
9654         min = 0;
9655         goto do_curly;
9656     }
9657     else if (op == '+' && (flags&SIMPLE)) {
9658         reginsert(pRExC_state, PLUS, ret, depth+1);
9659         ret->flags = 0;
9660         RExC_naughty += 3;
9661     }
9662     else if (op == '+') {
9663         min = 1;
9664         goto do_curly;
9665     }
9666     else if (op == '?') {
9667         min = 0; max = 1;
9668         goto do_curly;
9669     }
9670   nest_check:
9671     if (!SIZE_ONLY && !(flags&(HASWIDTH|POSTPONED)) && max > REG_INFTY/3) {
9672         SAVEFREESV(RExC_rx_sv); /* in case of fatal warnings */
9673         ckWARN3reg(RExC_parse,
9674                    "%.*s matches null string many times",
9675                    (int)(RExC_parse >= origparse ? RExC_parse - origparse : 0),
9676                    origparse);
9677         (void)ReREFCNT_inc(RExC_rx_sv);
9678     }
9679
9680     if (RExC_parse < RExC_end && *RExC_parse == '?') {
9681         nextchar(pRExC_state);
9682         reginsert(pRExC_state, MINMOD, ret, depth+1);
9683         REGTAIL(pRExC_state, ret, ret + NODE_STEP_REGNODE);
9684     }
9685 #ifndef REG_ALLOW_MINMOD_SUSPEND
9686     else
9687 #endif
9688     if (RExC_parse < RExC_end && *RExC_parse == '+') {
9689         regnode *ender;
9690         nextchar(pRExC_state);
9691         ender = reg_node(pRExC_state, SUCCEED);
9692         REGTAIL(pRExC_state, ret, ender);
9693         reginsert(pRExC_state, SUSPEND, ret, depth+1);
9694         ret->flags = 0;
9695         ender = reg_node(pRExC_state, TAIL);
9696         REGTAIL(pRExC_state, ret, ender);
9697         /*ret= ender;*/
9698     }
9699
9700     if (RExC_parse < RExC_end && ISMULT2(RExC_parse)) {
9701         RExC_parse++;
9702         vFAIL("Nested quantifiers");
9703     }
9704
9705     return(ret);
9706 }
9707
9708 STATIC bool
9709 S_grok_bslash_N(pTHX_ RExC_state_t *pRExC_state, regnode** node_p, UV *valuep, I32 *flagp, U32 depth, bool in_char_class,
9710         const bool strict   /* Apply stricter parsing rules? */
9711     )
9712 {
9713    
9714  /* This is expected to be called by a parser routine that has recognized '\N'
9715    and needs to handle the rest. RExC_parse is expected to point at the first
9716    char following the N at the time of the call.  On successful return,
9717    RExC_parse has been updated to point to just after the sequence identified
9718    by this routine, and <*flagp> has been updated.
9719
9720    The \N may be inside (indicated by the boolean <in_char_class>) or outside a
9721    character class.
9722
9723    \N may begin either a named sequence, or if outside a character class, mean
9724    to match a non-newline.  For non single-quoted regexes, the tokenizer has
9725    attempted to decide which, and in the case of a named sequence, converted it
9726    into one of the forms: \N{} (if the sequence is null), or \N{U+c1.c2...},
9727    where c1... are the characters in the sequence.  For single-quoted regexes,
9728    the tokenizer passes the \N sequence through unchanged; this code will not
9729    attempt to determine this nor expand those, instead raising a syntax error.
9730    The net effect is that if the beginning of the passed-in pattern isn't '{U+'
9731    or there is no '}', it signals that this \N occurrence means to match a
9732    non-newline.
9733
9734    Only the \N{U+...} form should occur in a character class, for the same
9735    reason that '.' inside a character class means to just match a period: it
9736    just doesn't make sense.
9737
9738    The function raises an error (via vFAIL), and doesn't return for various
9739    syntax errors.  Otherwise it returns TRUE and sets <node_p> or <valuep> on
9740    success; it returns FALSE otherwise. Returns FALSE, setting *flagp to
9741    RESTART_UTF8 if the sizing scan needs to be restarted. Such a restart is
9742    only possible if node_p is non-NULL.
9743
9744
9745    If <valuep> is non-null, it means the caller can accept an input sequence
9746    consisting of a just a single code point; <*valuep> is set to that value
9747    if the input is such.
9748
9749    If <node_p> is non-null it signifies that the caller can accept any other
9750    legal sequence (i.e., one that isn't just a single code point).  <*node_p>
9751    is set as follows:
9752     1) \N means not-a-NL: points to a newly created REG_ANY node;
9753     2) \N{}:              points to a new NOTHING node;
9754     3) otherwise:         points to a new EXACT node containing the resolved
9755                           string.
9756    Note that FALSE is returned for single code point sequences if <valuep> is
9757    null.
9758  */
9759
9760     char * endbrace;    /* '}' following the name */
9761     char* p;
9762     char *endchar;      /* Points to '.' or '}' ending cur char in the input
9763                            stream */
9764     bool has_multiple_chars; /* true if the input stream contains a sequence of
9765                                 more than one character */
9766
9767     GET_RE_DEBUG_FLAGS_DECL;
9768  
9769     PERL_ARGS_ASSERT_GROK_BSLASH_N;
9770
9771     GET_RE_DEBUG_FLAGS;
9772
9773     assert(cBOOL(node_p) ^ cBOOL(valuep));  /* Exactly one should be set */
9774
9775     /* The [^\n] meaning of \N ignores spaces and comments under the /x
9776      * modifier.  The other meaning does not */
9777     p = (RExC_flags & RXf_PMf_EXTENDED)
9778         ? regwhite( pRExC_state, RExC_parse )
9779         : RExC_parse;
9780
9781     /* Disambiguate between \N meaning a named character versus \N meaning
9782      * [^\n].  The former is assumed when it can't be the latter. */
9783     if (*p != '{' || regcurly(p, FALSE)) {
9784         RExC_parse = p;
9785         if (! node_p) {
9786             /* no bare \N in a charclass */
9787             if (in_char_class) {
9788                 vFAIL("\\N in a character class must be a named character: \\N{...}");
9789             }
9790             return FALSE;
9791         }
9792         nextchar(pRExC_state);
9793         *node_p = reg_node(pRExC_state, REG_ANY);
9794         *flagp |= HASWIDTH|SIMPLE;
9795         RExC_naughty++;
9796         RExC_parse--;
9797         Set_Node_Length(*node_p, 1); /* MJD */
9798         return TRUE;
9799     }
9800
9801     /* Here, we have decided it should be a named character or sequence */
9802
9803     /* The test above made sure that the next real character is a '{', but
9804      * under the /x modifier, it could be separated by space (or a comment and
9805      * \n) and this is not allowed (for consistency with \x{...} and the
9806      * tokenizer handling of \N{NAME}). */
9807     if (*RExC_parse != '{') {
9808         vFAIL("Missing braces on \\N{}");
9809     }
9810
9811     RExC_parse++;       /* Skip past the '{' */
9812
9813     if (! (endbrace = strchr(RExC_parse, '}')) /* no trailing brace */
9814         || ! (endbrace == RExC_parse            /* nothing between the {} */
9815               || (endbrace - RExC_parse >= 2    /* U+ (bad hex is checked below */
9816                   && strnEQ(RExC_parse, "U+", 2)))) /* for a better error msg) */
9817     {
9818         if (endbrace) RExC_parse = endbrace;    /* position msg's '<--HERE' */
9819         vFAIL("\\N{NAME} must be resolved by the lexer");
9820     }
9821
9822     if (endbrace == RExC_parse) {   /* empty: \N{} */
9823         bool ret = TRUE;
9824         if (node_p) {
9825             *node_p = reg_node(pRExC_state,NOTHING);
9826         }
9827         else if (in_char_class) {
9828             if (SIZE_ONLY && in_char_class) {
9829                 if (strict) {
9830                     RExC_parse++;   /* Position after the "}" */
9831                     vFAIL("Zero length \\N{}");
9832                 }
9833                 else {
9834                     ckWARNreg(RExC_parse,
9835                               "Ignoring zero length \\N{} in character class");
9836                 }
9837             }
9838             ret = FALSE;
9839         }
9840         else {
9841             return FALSE;
9842         }
9843         nextchar(pRExC_state);
9844         return ret;
9845     }
9846
9847     RExC_uni_semantics = 1; /* Unicode named chars imply Unicode semantics */
9848     RExC_parse += 2;    /* Skip past the 'U+' */
9849
9850     endchar = RExC_parse + strcspn(RExC_parse, ".}");
9851
9852     /* Code points are separated by dots.  If none, there is only one code
9853      * point, and is terminated by the brace */
9854     has_multiple_chars = (endchar < endbrace);
9855
9856     if (valuep && (! has_multiple_chars || in_char_class)) {
9857         /* We only pay attention to the first char of
9858         multichar strings being returned in char classes. I kinda wonder
9859         if this makes sense as it does change the behaviour
9860         from earlier versions, OTOH that behaviour was broken
9861         as well. XXX Solution is to recharacterize as
9862         [rest-of-class]|multi1|multi2... */
9863
9864         STRLEN length_of_hex = (STRLEN)(endchar - RExC_parse);
9865         I32 grok_hex_flags = PERL_SCAN_ALLOW_UNDERSCORES
9866             | PERL_SCAN_DISALLOW_PREFIX
9867             | (SIZE_ONLY ? PERL_SCAN_SILENT_ILLDIGIT : 0);
9868
9869         *valuep = grok_hex(RExC_parse, &length_of_hex, &grok_hex_flags, NULL);
9870
9871         /* The tokenizer should have guaranteed validity, but it's possible to
9872          * bypass it by using single quoting, so check */
9873         if (length_of_hex == 0
9874             || length_of_hex != (STRLEN)(endchar - RExC_parse) )
9875         {
9876             RExC_parse += length_of_hex;        /* Includes all the valid */
9877             RExC_parse += (RExC_orig_utf8)      /* point to after 1st invalid */
9878                             ? UTF8SKIP(RExC_parse)
9879                             : 1;
9880             /* Guard against malformed utf8 */
9881             if (RExC_parse >= endchar) {
9882                 RExC_parse = endchar;
9883             }
9884             vFAIL("Invalid hexadecimal number in \\N{U+...}");
9885         }
9886
9887         if (in_char_class && has_multiple_chars) {
9888             if (strict) {
9889                 RExC_parse = endbrace;
9890                 vFAIL("\\N{} in character class restricted to one character");
9891             }
9892             else {
9893                 ckWARNreg(endchar, "Using just the first character returned by \\N{} in character class");
9894             }
9895         }
9896
9897         RExC_parse = endbrace + 1;
9898     }
9899     else if (! node_p || ! has_multiple_chars) {
9900
9901         /* Here, the input is legal, but not according to the caller's
9902          * options.  We fail without advancing the parse, so that the
9903          * caller can try again */
9904         RExC_parse = p;
9905         return FALSE;
9906     }
9907     else {
9908
9909         /* What is done here is to convert this to a sub-pattern of the form
9910          * (?:\x{char1}\x{char2}...)
9911          * and then call reg recursively.  That way, it retains its atomicness,
9912          * while not having to worry about special handling that some code
9913          * points may have.  toke.c has converted the original Unicode values
9914          * to native, so that we can just pass on the hex values unchanged.  We
9915          * do have to set a flag to keep recoding from happening in the
9916          * recursion */
9917
9918         SV * substitute_parse = newSVpvn_flags("?:", 2, SVf_UTF8|SVs_TEMP);
9919         STRLEN len;
9920         char *orig_end = RExC_end;
9921         I32 flags;
9922
9923         while (RExC_parse < endbrace) {
9924
9925             /* Convert to notation the rest of the code understands */
9926             sv_catpv(substitute_parse, "\\x{");
9927             sv_catpvn(substitute_parse, RExC_parse, endchar - RExC_parse);
9928             sv_catpv(substitute_parse, "}");
9929
9930             /* Point to the beginning of the next character in the sequence. */
9931             RExC_parse = endchar + 1;
9932             endchar = RExC_parse + strcspn(RExC_parse, ".}");
9933         }
9934         sv_catpv(substitute_parse, ")");
9935
9936         RExC_parse = SvPV(substitute_parse, len);
9937
9938         /* Don't allow empty number */
9939         if (len < 8) {
9940             vFAIL("Invalid hexadecimal number in \\N{U+...}");
9941         }
9942         RExC_end = RExC_parse + len;
9943
9944         /* The values are Unicode, and therefore not subject to recoding */
9945         RExC_override_recoding = 1;
9946
9947         if (!(*node_p = reg(pRExC_state, 1, &flags, depth+1))) {
9948             if (flags & RESTART_UTF8) {
9949                 *flagp = RESTART_UTF8;
9950                 return FALSE;
9951             }
9952             FAIL2("panic: reg returned NULL to grok_bslash_N, flags=%#X",
9953                   flags);
9954         } 
9955         *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
9956
9957         RExC_parse = endbrace;
9958         RExC_end = orig_end;
9959         RExC_override_recoding = 0;
9960
9961         nextchar(pRExC_state);
9962     }
9963
9964     return TRUE;
9965 }
9966
9967
9968 /*
9969  * reg_recode
9970  *
9971  * It returns the code point in utf8 for the value in *encp.
9972  *    value: a code value in the source encoding
9973  *    encp:  a pointer to an Encode object
9974  *
9975  * If the result from Encode is not a single character,
9976  * it returns U+FFFD (Replacement character) and sets *encp to NULL.
9977  */
9978 STATIC UV
9979 S_reg_recode(pTHX_ const char value, SV **encp)
9980 {
9981     STRLEN numlen = 1;
9982     SV * const sv = newSVpvn_flags(&value, numlen, SVs_TEMP);
9983     const char * const s = *encp ? sv_recode_to_utf8(sv, *encp) : SvPVX(sv);
9984     const STRLEN newlen = SvCUR(sv);
9985     UV uv = UNICODE_REPLACEMENT;
9986
9987     PERL_ARGS_ASSERT_REG_RECODE;
9988
9989     if (newlen)
9990         uv = SvUTF8(sv)
9991              ? utf8n_to_uvchr((U8*)s, newlen, &numlen, UTF8_ALLOW_DEFAULT)
9992              : *(U8*)s;
9993
9994     if (!newlen || numlen != newlen) {
9995         uv = UNICODE_REPLACEMENT;
9996         *encp = NULL;
9997     }
9998     return uv;
9999 }
10000
10001 PERL_STATIC_INLINE U8
10002 S_compute_EXACTish(pTHX_ RExC_state_t *pRExC_state)
10003 {
10004     U8 op;
10005
10006     PERL_ARGS_ASSERT_COMPUTE_EXACTISH;
10007
10008     if (! FOLD) {
10009         return EXACT;
10010     }
10011
10012     op = get_regex_charset(RExC_flags);
10013     if (op >= REGEX_ASCII_RESTRICTED_CHARSET) {
10014         op--; /* /a is same as /u, and map /aa's offset to what /a's would have
10015                  been, so there is no hole */
10016     }
10017
10018     return op + EXACTF;
10019 }
10020
10021 PERL_STATIC_INLINE void
10022 S_alloc_maybe_populate_EXACT(pTHX_ RExC_state_t *pRExC_state, regnode *node, I32* flagp, STRLEN len, UV code_point)
10023 {
10024     /* This knows the details about sizing an EXACTish node, setting flags for
10025      * it (by setting <*flagp>, and potentially populating it with a single
10026      * character.
10027      *
10028      * If <len> (the length in bytes) is non-zero, this function assumes that
10029      * the node has already been populated, and just does the sizing.  In this
10030      * case <code_point> should be the final code point that has already been
10031      * placed into the node.  This value will be ignored except that under some
10032      * circumstances <*flagp> is set based on it.
10033      *
10034      * If <len> is zero, the function assumes that the node is to contain only
10035      * the single character given by <code_point> and calculates what <len>
10036      * should be.  In pass 1, it sizes the node appropriately.  In pass 2, it
10037      * additionally will populate the node's STRING with <code_point>, if <len>
10038      * is 0.  In both cases <*flagp> is appropriately set
10039      *
10040      * It knows that under FOLD, UTF characters and the Latin Sharp S must be
10041      * folded (the latter only when the rules indicate it can match 'ss') */
10042
10043     bool len_passed_in = cBOOL(len != 0);
10044     U8 character[UTF8_MAXBYTES_CASE+1];
10045
10046     PERL_ARGS_ASSERT_ALLOC_MAYBE_POPULATE_EXACT;
10047
10048     if (! len_passed_in) {
10049         if (UTF) {
10050             if (FOLD) {
10051                 to_uni_fold(NATIVE_TO_UNI(code_point), character, &len);
10052             }
10053             else {
10054                 uvchr_to_utf8( character, code_point);
10055                 len = UTF8SKIP(character);
10056             }
10057         }
10058         else if (! FOLD
10059                  || code_point != LATIN_SMALL_LETTER_SHARP_S
10060                  || ASCII_FOLD_RESTRICTED
10061                  || ! AT_LEAST_UNI_SEMANTICS)
10062         {
10063             *character = (U8) code_point;
10064             len = 1;
10065         }
10066         else {
10067             *character = 's';
10068             *(character + 1) = 's';
10069             len = 2;
10070         }
10071     }
10072
10073     if (SIZE_ONLY) {
10074         RExC_size += STR_SZ(len);
10075     }
10076     else {
10077         RExC_emit += STR_SZ(len);
10078         STR_LEN(node) = len;
10079         if (! len_passed_in) {
10080             Copy((char *) character, STRING(node), len, char);
10081         }
10082     }
10083
10084     *flagp |= HASWIDTH;
10085
10086     /* A single character node is SIMPLE, except for the special-cased SHARP S
10087      * under /di. */
10088     if ((len == 1 || (UTF && len == UNISKIP(code_point)))
10089         && (code_point != LATIN_SMALL_LETTER_SHARP_S
10090             || ! FOLD || ! DEPENDS_SEMANTICS))
10091     {
10092         *flagp |= SIMPLE;
10093     }
10094 }
10095
10096 /*
10097  - regatom - the lowest level
10098
10099    Try to identify anything special at the start of the pattern. If there
10100    is, then handle it as required. This may involve generating a single regop,
10101    such as for an assertion; or it may involve recursing, such as to
10102    handle a () structure.
10103
10104    If the string doesn't start with something special then we gobble up
10105    as much literal text as we can.
10106
10107    Once we have been able to handle whatever type of thing started the
10108    sequence, we return.
10109
10110    Note: we have to be careful with escapes, as they can be both literal
10111    and special, and in the case of \10 and friends, context determines which.
10112
10113    A summary of the code structure is:
10114
10115    switch (first_byte) {
10116         cases for each special:
10117             handle this special;
10118             break;
10119         case '\\':
10120             switch (2nd byte) {
10121                 cases for each unambiguous special:
10122                     handle this special;
10123                     break;
10124                 cases for each ambigous special/literal:
10125                     disambiguate;
10126                     if (special)  handle here
10127                     else goto defchar;
10128                 default: // unambiguously literal:
10129                     goto defchar;
10130             }
10131         default:  // is a literal char
10132             // FALL THROUGH
10133         defchar:
10134             create EXACTish node for literal;
10135             while (more input and node isn't full) {
10136                 switch (input_byte) {
10137                    cases for each special;
10138                        make sure parse pointer is set so that the next call to
10139                            regatom will see this special first
10140                        goto loopdone; // EXACTish node terminated by prev. char
10141                    default:
10142                        append char to EXACTISH node;
10143                 }
10144                 get next input byte;
10145             }
10146         loopdone:
10147    }
10148    return the generated node;
10149
10150    Specifically there are two separate switches for handling
10151    escape sequences, with the one for handling literal escapes requiring
10152    a dummy entry for all of the special escapes that are actually handled
10153    by the other.
10154
10155    Returns NULL, setting *flagp to TRYAGAIN if reg() returns NULL with
10156    TRYAGAIN.  
10157    Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan needs to be
10158    restarted.
10159    Otherwise does not return NULL.
10160 */
10161
10162 STATIC regnode *
10163 S_regatom(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
10164 {
10165     dVAR;
10166     regnode *ret = NULL;
10167     I32 flags = 0;
10168     char *parse_start = RExC_parse;
10169     U8 op;
10170     int invert = 0;
10171
10172     GET_RE_DEBUG_FLAGS_DECL;
10173
10174     *flagp = WORST;             /* Tentatively. */
10175
10176     DEBUG_PARSE("atom");
10177
10178     PERL_ARGS_ASSERT_REGATOM;
10179
10180 tryagain:
10181     switch ((U8)*RExC_parse) {
10182     case '^':
10183         RExC_seen_zerolen++;
10184         nextchar(pRExC_state);
10185         if (RExC_flags & RXf_PMf_MULTILINE)
10186             ret = reg_node(pRExC_state, MBOL);
10187         else if (RExC_flags & RXf_PMf_SINGLELINE)
10188             ret = reg_node(pRExC_state, SBOL);
10189         else
10190             ret = reg_node(pRExC_state, BOL);
10191         Set_Node_Length(ret, 1); /* MJD */
10192         break;
10193     case '$':
10194         nextchar(pRExC_state);
10195         if (*RExC_parse)
10196             RExC_seen_zerolen++;
10197         if (RExC_flags & RXf_PMf_MULTILINE)
10198             ret = reg_node(pRExC_state, MEOL);
10199         else if (RExC_flags & RXf_PMf_SINGLELINE)
10200             ret = reg_node(pRExC_state, SEOL);
10201         else
10202             ret = reg_node(pRExC_state, EOL);
10203         Set_Node_Length(ret, 1); /* MJD */
10204         break;
10205     case '.':
10206         nextchar(pRExC_state);
10207         if (RExC_flags & RXf_PMf_SINGLELINE)
10208             ret = reg_node(pRExC_state, SANY);
10209         else
10210             ret = reg_node(pRExC_state, REG_ANY);
10211         *flagp |= HASWIDTH|SIMPLE;
10212         RExC_naughty++;
10213         Set_Node_Length(ret, 1); /* MJD */
10214         break;
10215     case '[':
10216     {
10217         char * const oregcomp_parse = ++RExC_parse;
10218         ret = regclass(pRExC_state, flagp,depth+1,
10219                        FALSE, /* means parse the whole char class */
10220                        TRUE, /* allow multi-char folds */
10221                        FALSE, /* don't silence non-portable warnings. */
10222                        NULL);
10223         if (*RExC_parse != ']') {
10224             RExC_parse = oregcomp_parse;
10225             vFAIL("Unmatched [");
10226         }
10227         if (ret == NULL) {
10228             if (*flagp & RESTART_UTF8)
10229                 return NULL;
10230             FAIL2("panic: regclass returned NULL to regatom, flags=%#X",
10231                   *flagp);
10232         }
10233         nextchar(pRExC_state);
10234         Set_Node_Length(ret, RExC_parse - oregcomp_parse + 1); /* MJD */
10235         break;
10236     }
10237     case '(':
10238         nextchar(pRExC_state);
10239         ret = reg(pRExC_state, 1, &flags,depth+1);
10240         if (ret == NULL) {
10241                 if (flags & TRYAGAIN) {
10242                     if (RExC_parse == RExC_end) {
10243                          /* Make parent create an empty node if needed. */
10244                         *flagp |= TRYAGAIN;
10245                         return(NULL);
10246                     }
10247                     goto tryagain;
10248                 }
10249                 if (flags & RESTART_UTF8) {
10250                     *flagp = RESTART_UTF8;
10251                     return NULL;
10252                 }
10253                 FAIL2("panic: reg returned NULL to regatom, flags=%#X", flags);
10254         }
10255         *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
10256         break;
10257     case '|':
10258     case ')':
10259         if (flags & TRYAGAIN) {
10260             *flagp |= TRYAGAIN;
10261             return NULL;
10262         }
10263         vFAIL("Internal urp");
10264                                 /* Supposed to be caught earlier. */
10265         break;
10266     case '{':
10267         if (!regcurly(RExC_parse, FALSE)) {
10268             RExC_parse++;
10269             goto defchar;
10270         }
10271         /* FALL THROUGH */
10272     case '?':
10273     case '+':
10274     case '*':
10275         RExC_parse++;
10276         vFAIL("Quantifier follows nothing");
10277         break;
10278     case '\\':
10279         /* Special Escapes
10280
10281            This switch handles escape sequences that resolve to some kind
10282            of special regop and not to literal text. Escape sequnces that
10283            resolve to literal text are handled below in the switch marked
10284            "Literal Escapes".
10285
10286            Every entry in this switch *must* have a corresponding entry
10287            in the literal escape switch. However, the opposite is not
10288            required, as the default for this switch is to jump to the
10289            literal text handling code.
10290         */
10291         switch ((U8)*++RExC_parse) {
10292             U8 arg;
10293         /* Special Escapes */
10294         case 'A':
10295             RExC_seen_zerolen++;
10296             ret = reg_node(pRExC_state, SBOL);
10297             *flagp |= SIMPLE;
10298             goto finish_meta_pat;
10299         case 'G':
10300             ret = reg_node(pRExC_state, GPOS);
10301             RExC_seen |= REG_SEEN_GPOS;
10302             *flagp |= SIMPLE;
10303             goto finish_meta_pat;
10304         case 'K':
10305             RExC_seen_zerolen++;
10306             ret = reg_node(pRExC_state, KEEPS);
10307             *flagp |= SIMPLE;
10308             /* XXX:dmq : disabling in-place substitution seems to
10309              * be necessary here to avoid cases of memory corruption, as
10310              * with: C<$_="x" x 80; s/x\K/y/> -- rgs
10311              */
10312             RExC_seen |= REG_SEEN_LOOKBEHIND;
10313             goto finish_meta_pat;
10314         case 'Z':
10315             ret = reg_node(pRExC_state, SEOL);
10316             *flagp |= SIMPLE;
10317             RExC_seen_zerolen++;                /* Do not optimize RE away */
10318             goto finish_meta_pat;
10319         case 'z':
10320             ret = reg_node(pRExC_state, EOS);
10321             *flagp |= SIMPLE;
10322             RExC_seen_zerolen++;                /* Do not optimize RE away */
10323             goto finish_meta_pat;
10324         case 'C':
10325             ret = reg_node(pRExC_state, CANY);
10326             RExC_seen |= REG_SEEN_CANY;
10327             *flagp |= HASWIDTH|SIMPLE;
10328             goto finish_meta_pat;
10329         case 'X':
10330             ret = reg_node(pRExC_state, CLUMP);
10331             *flagp |= HASWIDTH;
10332             goto finish_meta_pat;
10333
10334         case 'W':
10335             invert = 1;
10336             /* FALLTHROUGH */
10337         case 'w':
10338             arg = ANYOF_WORDCHAR;
10339             goto join_posix;
10340
10341         case 'b':
10342             RExC_seen_zerolen++;
10343             RExC_seen |= REG_SEEN_LOOKBEHIND;
10344             op = BOUND + get_regex_charset(RExC_flags);
10345             if (op > BOUNDA) {  /* /aa is same as /a */
10346                 op = BOUNDA;
10347             }
10348             ret = reg_node(pRExC_state, op);
10349             FLAGS(ret) = get_regex_charset(RExC_flags);
10350             *flagp |= SIMPLE;
10351             if (! SIZE_ONLY && (U8) *(RExC_parse + 1) == '{') {
10352                 ckWARNdep(RExC_parse, "\"\\b{\" is deprecated; use \"\\b\\{\" or \"\\b[{]\" instead");
10353             }
10354             goto finish_meta_pat;
10355         case 'B':
10356             RExC_seen_zerolen++;
10357             RExC_seen |= REG_SEEN_LOOKBEHIND;
10358             op = NBOUND + get_regex_charset(RExC_flags);
10359             if (op > NBOUNDA) { /* /aa is same as /a */
10360                 op = NBOUNDA;
10361             }
10362             ret = reg_node(pRExC_state, op);
10363             FLAGS(ret) = get_regex_charset(RExC_flags);
10364             *flagp |= SIMPLE;
10365             if (! SIZE_ONLY && (U8) *(RExC_parse + 1) == '{') {
10366                 ckWARNdep(RExC_parse, "\"\\B{\" is deprecated; use \"\\B\\{\" or \"\\B[{]\" instead");
10367             }
10368             goto finish_meta_pat;
10369
10370         case 'D':
10371             invert = 1;
10372             /* FALLTHROUGH */
10373         case 'd':
10374             arg = ANYOF_DIGIT;
10375             goto join_posix;
10376
10377         case 'R':
10378             ret = reg_node(pRExC_state, LNBREAK);
10379             *flagp |= HASWIDTH|SIMPLE;
10380             goto finish_meta_pat;
10381
10382         case 'H':
10383             invert = 1;
10384             /* FALLTHROUGH */
10385         case 'h':
10386             arg = ANYOF_BLANK;
10387             op = POSIXU;
10388             goto join_posix_op_known;
10389
10390         case 'V':
10391             invert = 1;
10392             /* FALLTHROUGH */
10393         case 'v':
10394             arg = ANYOF_VERTWS;
10395             op = POSIXU;
10396             goto join_posix_op_known;
10397
10398         case 'S':
10399             invert = 1;
10400             /* FALLTHROUGH */
10401         case 's':
10402             arg = ANYOF_SPACE;
10403
10404         join_posix:
10405
10406             op = POSIXD + get_regex_charset(RExC_flags);
10407             if (op > POSIXA) {  /* /aa is same as /a */
10408                 op = POSIXA;
10409             }
10410
10411         join_posix_op_known:
10412
10413             if (invert) {
10414                 op += NPOSIXD - POSIXD;
10415             }
10416
10417             ret = reg_node(pRExC_state, op);
10418             if (! SIZE_ONLY) {
10419                 FLAGS(ret) = namedclass_to_classnum(arg);
10420             }
10421
10422             *flagp |= HASWIDTH|SIMPLE;
10423             /* FALL THROUGH */
10424
10425          finish_meta_pat:           
10426             nextchar(pRExC_state);
10427             Set_Node_Length(ret, 2); /* MJD */
10428             break;          
10429         case 'p':
10430         case 'P':
10431             {
10432 #ifdef DEBUGGING
10433                 char* parse_start = RExC_parse - 2;
10434 #endif
10435
10436                 RExC_parse--;
10437
10438                 ret = regclass(pRExC_state, flagp,depth+1,
10439                                TRUE, /* means just parse this element */
10440                                FALSE, /* don't allow multi-char folds */
10441                                FALSE, /* don't silence non-portable warnings.
10442                                          It would be a bug if these returned
10443                                          non-portables */
10444                                NULL);
10445                 /* regclass() can only return RESTART_UTF8 if multi-char folds
10446                    are allowed.  */
10447                 if (!ret)
10448                     FAIL2("panic: regclass returned NULL to regatom, flags=%#X",
10449                           *flagp);
10450
10451                 RExC_parse--;
10452
10453                 Set_Node_Offset(ret, parse_start + 2);
10454                 Set_Node_Cur_Length(ret);
10455                 nextchar(pRExC_state);
10456             }
10457             break;
10458         case 'N': 
10459             /* Handle \N and \N{NAME} with multiple code points here and not
10460              * below because it can be multicharacter. join_exact() will join
10461              * them up later on.  Also this makes sure that things like
10462              * /\N{BLAH}+/ and \N{BLAH} being multi char Just Happen. dmq.
10463              * The options to the grok function call causes it to fail if the
10464              * sequence is just a single code point.  We then go treat it as
10465              * just another character in the current EXACT node, and hence it
10466              * gets uniform treatment with all the other characters.  The
10467              * special treatment for quantifiers is not needed for such single
10468              * character sequences */
10469             ++RExC_parse;
10470             if (! grok_bslash_N(pRExC_state, &ret, NULL, flagp, depth, FALSE,
10471                                 FALSE /* not strict */ )) {
10472                 if (*flagp & RESTART_UTF8)
10473                     return NULL;
10474                 RExC_parse--;
10475                 goto defchar;
10476             }
10477             break;
10478         case 'k':    /* Handle \k<NAME> and \k'NAME' */
10479         parse_named_seq:
10480         {   
10481             char ch= RExC_parse[1];         
10482             if (ch != '<' && ch != '\'' && ch != '{') {
10483                 RExC_parse++;
10484                 vFAIL2("Sequence %.2s... not terminated",parse_start);
10485             } else {
10486                 /* this pretty much dupes the code for (?P=...) in reg(), if
10487                    you change this make sure you change that */
10488                 char* name_start = (RExC_parse += 2);
10489                 U32 num = 0;
10490                 SV *sv_dat = reg_scan_name(pRExC_state,
10491                     SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
10492                 ch= (ch == '<') ? '>' : (ch == '{') ? '}' : '\'';
10493                 if (RExC_parse == name_start || *RExC_parse != ch)
10494                     vFAIL2("Sequence %.3s... not terminated",parse_start);
10495
10496                 if (!SIZE_ONLY) {
10497                     num = add_data( pRExC_state, 1, "S" );
10498                     RExC_rxi->data->data[num]=(void*)sv_dat;
10499                     SvREFCNT_inc_simple_void(sv_dat);
10500                 }
10501
10502                 RExC_sawback = 1;
10503                 ret = reganode(pRExC_state,
10504                                ((! FOLD)
10505                                  ? NREF
10506                                  : (ASCII_FOLD_RESTRICTED)
10507                                    ? NREFFA
10508                                    : (AT_LEAST_UNI_SEMANTICS)
10509                                      ? NREFFU
10510                                      : (LOC)
10511                                        ? NREFFL
10512                                        : NREFF),
10513                                 num);
10514                 *flagp |= HASWIDTH;
10515
10516                 /* override incorrect value set in reganode MJD */
10517                 Set_Node_Offset(ret, parse_start+1);
10518                 Set_Node_Cur_Length(ret); /* MJD */
10519                 nextchar(pRExC_state);
10520
10521             }
10522             break;
10523         }
10524         case 'g': 
10525         case '1': case '2': case '3': case '4':
10526         case '5': case '6': case '7': case '8': case '9':
10527             {
10528                 I32 num;
10529                 bool isg = *RExC_parse == 'g';
10530                 bool isrel = 0; 
10531                 bool hasbrace = 0;
10532                 if (isg) {
10533                     RExC_parse++;
10534                     if (*RExC_parse == '{') {
10535                         RExC_parse++;
10536                         hasbrace = 1;
10537                     }
10538                     if (*RExC_parse == '-') {
10539                         RExC_parse++;
10540                         isrel = 1;
10541                     }
10542                     if (hasbrace && !isDIGIT(*RExC_parse)) {
10543                         if (isrel) RExC_parse--;
10544                         RExC_parse -= 2;                            
10545                         goto parse_named_seq;
10546                 }   }
10547                 num = atoi(RExC_parse);
10548                 if (isg && num == 0)
10549                     vFAIL("Reference to invalid group 0");
10550                 if (isrel) {
10551                     num = RExC_npar - num;
10552                     if (num < 1)
10553                         vFAIL("Reference to nonexistent or unclosed group");
10554                 }
10555                 if (!isg && num > 9 && num >= RExC_npar)
10556                     /* Probably a character specified in octal, e.g. \35 */
10557                     goto defchar;
10558                 else {
10559                     char * const parse_start = RExC_parse - 1; /* MJD */
10560                     while (isDIGIT(*RExC_parse))
10561                         RExC_parse++;
10562                     if (parse_start == RExC_parse - 1) 
10563                         vFAIL("Unterminated \\g... pattern");
10564                     if (hasbrace) {
10565                         if (*RExC_parse != '}') 
10566                             vFAIL("Unterminated \\g{...} pattern");
10567                         RExC_parse++;
10568                     }    
10569                     if (!SIZE_ONLY) {
10570                         if (num > (I32)RExC_rx->nparens)
10571                             vFAIL("Reference to nonexistent group");
10572                     }
10573                     RExC_sawback = 1;
10574                     ret = reganode(pRExC_state,
10575                                    ((! FOLD)
10576                                      ? REF
10577                                      : (ASCII_FOLD_RESTRICTED)
10578                                        ? REFFA
10579                                        : (AT_LEAST_UNI_SEMANTICS)
10580                                          ? REFFU
10581                                          : (LOC)
10582                                            ? REFFL
10583                                            : REFF),
10584                                     num);
10585                     *flagp |= HASWIDTH;
10586
10587                     /* override incorrect value set in reganode MJD */
10588                     Set_Node_Offset(ret, parse_start+1);
10589                     Set_Node_Cur_Length(ret); /* MJD */
10590                     RExC_parse--;
10591                     nextchar(pRExC_state);
10592                 }
10593             }
10594             break;
10595         case '\0':
10596             if (RExC_parse >= RExC_end)
10597                 FAIL("Trailing \\");
10598             /* FALL THROUGH */
10599         default:
10600             /* Do not generate "unrecognized" warnings here, we fall
10601                back into the quick-grab loop below */
10602             parse_start--;
10603             goto defchar;
10604         }
10605         break;
10606
10607     case '#':
10608         if (RExC_flags & RXf_PMf_EXTENDED) {
10609             if ( reg_skipcomment( pRExC_state ) )
10610                 goto tryagain;
10611         }
10612         /* FALL THROUGH */
10613
10614     default:
10615
10616             parse_start = RExC_parse - 1;
10617
10618             RExC_parse++;
10619
10620         defchar: {
10621             STRLEN len = 0;
10622             UV ender;
10623             char *p;
10624             char *s;
10625 #define MAX_NODE_STRING_SIZE 127
10626             char foldbuf[MAX_NODE_STRING_SIZE+UTF8_MAXBYTES_CASE];
10627             char *s0;
10628             U8 upper_parse = MAX_NODE_STRING_SIZE;
10629             STRLEN foldlen;
10630             U8 node_type;
10631             bool next_is_quantifier;
10632             char * oldp = NULL;
10633
10634             /* If a folding node contains only code points that don't
10635              * participate in folds, it can be changed into an EXACT node,
10636              * which allows the optimizer more things to look for */
10637             bool maybe_exact;
10638
10639             ender = 0;
10640             node_type = compute_EXACTish(pRExC_state);
10641             ret = reg_node(pRExC_state, node_type);
10642
10643             /* In pass1, folded, we use a temporary buffer instead of the
10644              * actual node, as the node doesn't exist yet */
10645             s = (SIZE_ONLY && FOLD) ? foldbuf : STRING(ret);
10646
10647             s0 = s;
10648
10649         reparse:
10650
10651             /* We do the EXACTFish to EXACT node only if folding, and not if in
10652              * locale, as whether a character folds or not isn't known until
10653              * runtime */
10654             maybe_exact = FOLD && ! LOC;
10655
10656             /* XXX The node can hold up to 255 bytes, yet this only goes to
10657              * 127.  I (khw) do not know why.  Keeping it somewhat less than
10658              * 255 allows us to not have to worry about overflow due to
10659              * converting to utf8 and fold expansion, but that value is
10660              * 255-UTF8_MAXBYTES_CASE.  join_exact() may join adjacent nodes
10661              * split up by this limit into a single one using the real max of
10662              * 255.  Even at 127, this breaks under rare circumstances.  If
10663              * folding, we do not want to split a node at a character that is a
10664              * non-final in a multi-char fold, as an input string could just
10665              * happen to want to match across the node boundary.  The join
10666              * would solve that problem if the join actually happens.  But a
10667              * series of more than two nodes in a row each of 127 would cause
10668              * the first join to succeed to get to 254, but then there wouldn't
10669              * be room for the next one, which could at be one of those split
10670              * multi-char folds.  I don't know of any fool-proof solution.  One
10671              * could back off to end with only a code point that isn't such a
10672              * non-final, but it is possible for there not to be any in the
10673              * entire node. */
10674             for (p = RExC_parse - 1;
10675                  len < upper_parse && p < RExC_end;
10676                  len++)
10677             {
10678                 oldp = p;
10679
10680                 if (RExC_flags & RXf_PMf_EXTENDED)
10681                     p = regwhite( pRExC_state, p );
10682                 switch ((U8)*p) {
10683                 case '^':
10684                 case '$':
10685                 case '.':
10686                 case '[':
10687                 case '(':
10688                 case ')':
10689                 case '|':
10690                     goto loopdone;
10691                 case '\\':
10692                     /* Literal Escapes Switch
10693
10694                        This switch is meant to handle escape sequences that
10695                        resolve to a literal character.
10696
10697                        Every escape sequence that represents something
10698                        else, like an assertion or a char class, is handled
10699                        in the switch marked 'Special Escapes' above in this
10700                        routine, but also has an entry here as anything that
10701                        isn't explicitly mentioned here will be treated as
10702                        an unescaped equivalent literal.
10703                     */
10704
10705                     switch ((U8)*++p) {
10706                     /* These are all the special escapes. */
10707                     case 'A':             /* Start assertion */
10708                     case 'b': case 'B':   /* Word-boundary assertion*/
10709                     case 'C':             /* Single char !DANGEROUS! */
10710                     case 'd': case 'D':   /* digit class */
10711                     case 'g': case 'G':   /* generic-backref, pos assertion */
10712                     case 'h': case 'H':   /* HORIZWS */
10713                     case 'k': case 'K':   /* named backref, keep marker */
10714                     case 'p': case 'P':   /* Unicode property */
10715                               case 'R':   /* LNBREAK */
10716                     case 's': case 'S':   /* space class */
10717                     case 'v': case 'V':   /* VERTWS */
10718                     case 'w': case 'W':   /* word class */
10719                     case 'X':             /* eXtended Unicode "combining character sequence" */
10720                     case 'z': case 'Z':   /* End of line/string assertion */
10721                         --p;
10722                         goto loopdone;
10723
10724                     /* Anything after here is an escape that resolves to a
10725                        literal. (Except digits, which may or may not)
10726                      */
10727                     case 'n':
10728                         ender = '\n';
10729                         p++;
10730                         break;
10731                     case 'N': /* Handle a single-code point named character. */
10732                         /* The options cause it to fail if a multiple code
10733                          * point sequence.  Handle those in the switch() above
10734                          * */
10735                         RExC_parse = p + 1;
10736                         if (! grok_bslash_N(pRExC_state, NULL, &ender,
10737                                             flagp, depth, FALSE,
10738                                             FALSE /* not strict */ ))
10739                         {
10740                             if (*flagp & RESTART_UTF8)
10741                                 FAIL("panic: grok_bslash_N set RESTART_UTF8");
10742                             RExC_parse = p = oldp;
10743                             goto loopdone;
10744                         }
10745                         p = RExC_parse;
10746                         if (ender > 0xff) {
10747                             REQUIRE_UTF8;
10748                         }
10749                         break;
10750                     case 'r':
10751                         ender = '\r';
10752                         p++;
10753                         break;
10754                     case 't':
10755                         ender = '\t';
10756                         p++;
10757                         break;
10758                     case 'f':
10759                         ender = '\f';
10760                         p++;
10761                         break;
10762                     case 'e':
10763                           ender = ASCII_TO_NATIVE('\033');
10764                         p++;
10765                         break;
10766                     case 'a':
10767                           ender = ASCII_TO_NATIVE('\007');
10768                         p++;
10769                         break;
10770                     case 'o':
10771                         {
10772                             UV result;
10773                             const char* error_msg;
10774
10775                             bool valid = grok_bslash_o(&p,
10776                                                        &result,
10777                                                        &error_msg,
10778                                                        TRUE, /* out warnings */
10779                                                        FALSE, /* not strict */
10780                                                        TRUE, /* Output warnings
10781                                                                 for non-
10782                                                                 portables */
10783                                                        UTF);
10784                             if (! valid) {
10785                                 RExC_parse = p; /* going to die anyway; point
10786                                                    to exact spot of failure */
10787                                 vFAIL(error_msg);
10788                             }
10789                             ender = result;
10790                             if (PL_encoding && ender < 0x100) {
10791                                 goto recode_encoding;
10792                             }
10793                             if (ender > 0xff) {
10794                                 REQUIRE_UTF8;
10795                             }
10796                             break;
10797                         }
10798                     case 'x':
10799                         {
10800                             UV result = UV_MAX; /* initialize to erroneous
10801                                                    value */
10802                             const char* error_msg;
10803
10804                             bool valid = grok_bslash_x(&p,
10805                                                        &result,
10806                                                        &error_msg,
10807                                                        TRUE, /* out warnings */
10808                                                        FALSE, /* not strict */
10809                                                        TRUE, /* Output warnings
10810                                                                 for non-
10811                                                                 portables */
10812                                                        UTF);
10813                             if (! valid) {
10814                                 RExC_parse = p; /* going to die anyway; point
10815                                                    to exact spot of failure */
10816                                 vFAIL(error_msg);
10817                             }
10818                             ender = result;
10819
10820                             if (PL_encoding && ender < 0x100) {
10821                                 goto recode_encoding;
10822                             }
10823                             if (ender > 0xff) {
10824                                 REQUIRE_UTF8;
10825                             }
10826                             break;
10827                         }
10828                     case 'c':
10829                         p++;
10830                         ender = grok_bslash_c(*p++, UTF, SIZE_ONLY);
10831                         break;
10832                     case '0': case '1': case '2': case '3':case '4':
10833                     case '5': case '6': case '7':
10834                         if (*p == '0' ||
10835                             (isDIGIT(p[1]) && atoi(p) >= RExC_npar))
10836                         {
10837                             I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
10838                             STRLEN numlen = 3;
10839                             ender = grok_oct(p, &numlen, &flags, NULL);
10840                             if (ender > 0xff) {
10841                                 REQUIRE_UTF8;
10842                             }
10843                             p += numlen;
10844                             if (SIZE_ONLY   /* like \08, \178 */
10845                                 && numlen < 3
10846                                 && p < RExC_end
10847                                 && isDIGIT(*p) && ckWARN(WARN_REGEXP))
10848                             {
10849                                 reg_warn_non_literal_string(
10850                                          p + 1,
10851                                          form_short_octal_warning(p, numlen));
10852                             }
10853                         }
10854                         else {  /* Not to be treated as an octal constant, go
10855                                    find backref */
10856                             --p;
10857                             goto loopdone;
10858                         }
10859                         if (PL_encoding && ender < 0x100)
10860                             goto recode_encoding;
10861                         break;
10862                     recode_encoding:
10863                         if (! RExC_override_recoding) {
10864                             SV* enc = PL_encoding;
10865                             ender = reg_recode((const char)(U8)ender, &enc);
10866                             if (!enc && SIZE_ONLY)
10867                                 ckWARNreg(p, "Invalid escape in the specified encoding");
10868                             REQUIRE_UTF8;
10869                         }
10870                         break;
10871                     case '\0':
10872                         if (p >= RExC_end)
10873                             FAIL("Trailing \\");
10874                         /* FALL THROUGH */
10875                     default:
10876                         if (!SIZE_ONLY&& isALPHANUMERIC(*p)) {
10877                             /* Include any { following the alpha to emphasize
10878                              * that it could be part of an escape at some point
10879                              * in the future */
10880                             int len = (isALPHA(*p) && *(p + 1) == '{') ? 2 : 1;
10881                             ckWARN3reg(p + len, "Unrecognized escape \\%.*s passed through", len, p);
10882                         }
10883                         goto normal_default;
10884                     } /* End of switch on '\' */
10885                     break;
10886                 default:    /* A literal character */
10887
10888                     if (! SIZE_ONLY
10889                         && RExC_flags & RXf_PMf_EXTENDED
10890                         && ckWARN(WARN_DEPRECATED)
10891                         && is_PATWS_non_low(p, UTF))
10892                     {
10893                         vWARN_dep(p + ((UTF) ? UTF8SKIP(p) : 1),
10894                                 "Escape literal pattern white space under /x");
10895                     }
10896
10897                   normal_default:
10898                     if (UTF8_IS_START(*p) && UTF) {
10899                         STRLEN numlen;
10900                         ender = utf8n_to_uvchr((U8*)p, RExC_end - p,
10901                                                &numlen, UTF8_ALLOW_DEFAULT);
10902                         p += numlen;
10903                     }
10904                     else
10905                         ender = (U8) *p++;
10906                     break;
10907                 } /* End of switch on the literal */
10908
10909                 /* Here, have looked at the literal character and <ender>
10910                  * contains its ordinal, <p> points to the character after it
10911                  */
10912
10913                 if ( RExC_flags & RXf_PMf_EXTENDED)
10914                     p = regwhite( pRExC_state, p );
10915
10916                 /* If the next thing is a quantifier, it applies to this
10917                  * character only, which means that this character has to be in
10918                  * its own node and can't just be appended to the string in an
10919                  * existing node, so if there are already other characters in
10920                  * the node, close the node with just them, and set up to do
10921                  * this character again next time through, when it will be the
10922                  * only thing in its new node */
10923                 if ((next_is_quantifier = (p < RExC_end && ISMULT2(p))) && len)
10924                 {
10925                     p = oldp;
10926                     goto loopdone;
10927                 }
10928
10929                 if (FOLD) {
10930                     if (UTF
10931                             /* See comments for join_exact() as to why we fold
10932                              * this non-UTF at compile time */
10933                         || (node_type == EXACTFU
10934                             && ender == LATIN_SMALL_LETTER_SHARP_S))
10935                     {
10936
10937
10938                         /* Prime the casefolded buffer.  Locale rules, which
10939                          * apply only to code points < 256, aren't known until
10940                          * execution, so for them, just output the original
10941                          * character using utf8.  If we start to fold non-UTF
10942                          * patterns, be sure to update join_exact() */
10943                         if (LOC && ender < 256) {
10944                             if (UNI_IS_INVARIANT(ender)) {
10945                                 *s = (U8) ender;
10946                                 foldlen = 1;
10947                             } else {
10948                                 *s = UTF8_TWO_BYTE_HI(ender);
10949                                 *(s + 1) = UTF8_TWO_BYTE_LO(ender);
10950                                 foldlen = 2;
10951                             }
10952                         }
10953                         else {
10954                             UV folded = _to_uni_fold_flags(
10955                                            ender,
10956                                            (U8 *) s,
10957                                            &foldlen,
10958                                            FOLD_FLAGS_FULL
10959                                            | ((LOC) ?  FOLD_FLAGS_LOCALE
10960                                                     : (ASCII_FOLD_RESTRICTED)
10961                                                       ? FOLD_FLAGS_NOMIX_ASCII
10962                                                       : 0)
10963                                             );
10964
10965                             /* If this node only contains non-folding code
10966                              * points so far, see if this new one is also
10967                              * non-folding */
10968                             if (maybe_exact) {
10969                                 if (folded != ender) {
10970                                     maybe_exact = FALSE;
10971                                 }
10972                                 else {
10973                                     /* Here the fold is the original; we have
10974                                      * to check further to see if anything
10975                                      * folds to it */
10976                                     if (! PL_utf8_foldable) {
10977                                         SV* swash = swash_init("utf8",
10978                                                            "_Perl_Any_Folds",
10979                                                            &PL_sv_undef, 1, 0);
10980                                         PL_utf8_foldable =
10981                                                     _get_swash_invlist(swash);
10982                                         SvREFCNT_dec_NN(swash);
10983                                     }
10984                                     if (_invlist_contains_cp(PL_utf8_foldable,
10985                                                              ender))
10986                                     {
10987                                         maybe_exact = FALSE;
10988                                     }
10989                                 }
10990                             }
10991                             ender = folded;
10992                         }
10993                         s += foldlen;
10994
10995                         /* The loop increments <len> each time, as all but this
10996                          * path (and the one just below for UTF) through it add
10997                          * a single byte to the EXACTish node.  But this one
10998                          * has changed len to be the correct final value, so
10999                          * subtract one to cancel out the increment that
11000                          * follows */
11001                         len += foldlen - 1;
11002                     }
11003                     else {
11004                         *(s++) = (char) ender;
11005                         maybe_exact &= ! IS_IN_SOME_FOLD_L1(ender);
11006                     }
11007                 }
11008                 else if (UTF) {
11009                     const STRLEN unilen = reguni(pRExC_state, ender, s);
11010                     if (unilen > 0) {
11011                        s   += unilen;
11012                        len += unilen;
11013                     }
11014
11015                     /* See comment just above for - 1 */
11016                     len--;
11017                 }
11018                 else {
11019                     REGC((char)ender, s++);
11020                 }
11021
11022                 if (next_is_quantifier) {
11023
11024                     /* Here, the next input is a quantifier, and to get here,
11025                      * the current character is the only one in the node.
11026                      * Also, here <len> doesn't include the final byte for this
11027                      * character */
11028                     len++;
11029                     goto loopdone;
11030                 }
11031
11032             } /* End of loop through literal characters */
11033
11034             /* Here we have either exhausted the input or ran out of room in
11035              * the node.  (If we encountered a character that can't be in the
11036              * node, transfer is made directly to <loopdone>, and so we
11037              * wouldn't have fallen off the end of the loop.)  In the latter
11038              * case, we artificially have to split the node into two, because
11039              * we just don't have enough space to hold everything.  This
11040              * creates a problem if the final character participates in a
11041              * multi-character fold in the non-final position, as a match that
11042              * should have occurred won't, due to the way nodes are matched,
11043              * and our artificial boundary.  So back off until we find a non-
11044              * problematic character -- one that isn't at the beginning or
11045              * middle of such a fold.  (Either it doesn't participate in any
11046              * folds, or appears only in the final position of all the folds it
11047              * does participate in.)  A better solution with far fewer false
11048              * positives, and that would fill the nodes more completely, would
11049              * be to actually have available all the multi-character folds to
11050              * test against, and to back-off only far enough to be sure that
11051              * this node isn't ending with a partial one.  <upper_parse> is set
11052              * further below (if we need to reparse the node) to include just
11053              * up through that final non-problematic character that this code
11054              * identifies, so when it is set to less than the full node, we can
11055              * skip the rest of this */
11056             if (FOLD && p < RExC_end && upper_parse == MAX_NODE_STRING_SIZE) {
11057
11058                 const STRLEN full_len = len;
11059
11060                 assert(len >= MAX_NODE_STRING_SIZE);
11061
11062                 /* Here, <s> points to the final byte of the final character.
11063                  * Look backwards through the string until find a non-
11064                  * problematic character */
11065
11066                 if (! UTF) {
11067
11068                     /* These two have no multi-char folds to non-UTF characters
11069                      */
11070                     if (ASCII_FOLD_RESTRICTED || LOC) {
11071                         goto loopdone;
11072                     }
11073
11074                     while (--s >= s0 && IS_NON_FINAL_FOLD(*s)) { }
11075                     len = s - s0 + 1;
11076                 }
11077                 else {
11078                     if (!  PL_NonL1NonFinalFold) {
11079                         PL_NonL1NonFinalFold = _new_invlist_C_array(
11080                                         NonL1_Perl_Non_Final_Folds_invlist);
11081                     }
11082
11083                     /* Point to the first byte of the final character */
11084                     s = (char *) utf8_hop((U8 *) s, -1);
11085
11086                     while (s >= s0) {   /* Search backwards until find
11087                                            non-problematic char */
11088                         if (UTF8_IS_INVARIANT(*s)) {
11089
11090                             /* There are no ascii characters that participate
11091                              * in multi-char folds under /aa.  In EBCDIC, the
11092                              * non-ascii invariants are all control characters,
11093                              * so don't ever participate in any folds. */
11094                             if (ASCII_FOLD_RESTRICTED
11095                                 || ! IS_NON_FINAL_FOLD(*s))
11096                             {
11097                                 break;
11098                             }
11099                         }
11100                         else if (UTF8_IS_DOWNGRADEABLE_START(*s)) {
11101
11102                             /* No Latin1 characters participate in multi-char
11103                              * folds under /l */
11104                             if (LOC
11105                                 || ! IS_NON_FINAL_FOLD(TWO_BYTE_UTF8_TO_UNI(
11106                                                                 *s, *(s+1))))
11107                             {
11108                                 break;
11109                             }
11110                         }
11111                         else if (! _invlist_contains_cp(
11112                                         PL_NonL1NonFinalFold,
11113                                         valid_utf8_to_uvchr((U8 *) s, NULL)))
11114                         {
11115                             break;
11116                         }
11117
11118                         /* Here, the current character is problematic in that
11119                          * it does occur in the non-final position of some
11120                          * fold, so try the character before it, but have to
11121                          * special case the very first byte in the string, so
11122                          * we don't read outside the string */
11123                         s = (s == s0) ? s -1 : (char *) utf8_hop((U8 *) s, -1);
11124                     } /* End of loop backwards through the string */
11125
11126                     /* If there were only problematic characters in the string,
11127                      * <s> will point to before s0, in which case the length
11128                      * should be 0, otherwise include the length of the
11129                      * non-problematic character just found */
11130                     len = (s < s0) ? 0 : s - s0 + UTF8SKIP(s);
11131                 }
11132
11133                 /* Here, have found the final character, if any, that is
11134                  * non-problematic as far as ending the node without splitting
11135                  * it across a potential multi-char fold.  <len> contains the
11136                  * number of bytes in the node up-to and including that
11137                  * character, or is 0 if there is no such character, meaning
11138                  * the whole node contains only problematic characters.  In
11139                  * this case, give up and just take the node as-is.  We can't
11140                  * do any better */
11141                 if (len == 0) {
11142                     len = full_len;
11143                 } else {
11144
11145                     /* Here, the node does contain some characters that aren't
11146                      * problematic.  If one such is the final character in the
11147                      * node, we are done */
11148                     if (len == full_len) {
11149                         goto loopdone;
11150                     }
11151                     else if (len + ((UTF) ? UTF8SKIP(s) : 1) == full_len) {
11152
11153                         /* If the final character is problematic, but the
11154                          * penultimate is not, back-off that last character to
11155                          * later start a new node with it */
11156                         p = oldp;
11157                         goto loopdone;
11158                     }
11159
11160                     /* Here, the final non-problematic character is earlier
11161                      * in the input than the penultimate character.  What we do
11162                      * is reparse from the beginning, going up only as far as
11163                      * this final ok one, thus guaranteeing that the node ends
11164                      * in an acceptable character.  The reason we reparse is
11165                      * that we know how far in the character is, but we don't
11166                      * know how to correlate its position with the input parse.
11167                      * An alternate implementation would be to build that
11168                      * correlation as we go along during the original parse,
11169                      * but that would entail extra work for every node, whereas
11170                      * this code gets executed only when the string is too
11171                      * large for the node, and the final two characters are
11172                      * problematic, an infrequent occurrence.  Yet another
11173                      * possible strategy would be to save the tail of the
11174                      * string, and the next time regatom is called, initialize
11175                      * with that.  The problem with this is that unless you
11176                      * back off one more character, you won't be guaranteed
11177                      * regatom will get called again, unless regbranch,
11178                      * regpiece ... are also changed.  If you do back off that
11179                      * extra character, so that there is input guaranteed to
11180                      * force calling regatom, you can't handle the case where
11181                      * just the first character in the node is acceptable.  I
11182                      * (khw) decided to try this method which doesn't have that
11183                      * pitfall; if performance issues are found, we can do a
11184                      * combination of the current approach plus that one */
11185                     upper_parse = len;
11186                     len = 0;
11187                     s = s0;
11188                     goto reparse;
11189                 }
11190             }   /* End of verifying node ends with an appropriate char */
11191
11192         loopdone:   /* Jumped to when encounters something that shouldn't be in
11193                        the node */
11194
11195             /* If 'maybe_exact' is still set here, means there are no
11196              * code points in the node that participate in folds */
11197             if (FOLD && maybe_exact) {
11198                 OP(ret) = EXACT;
11199             }
11200
11201             /* I (khw) don't know if you can get here with zero length, but the
11202              * old code handled this situation by creating a zero-length EXACT
11203              * node.  Might as well be NOTHING instead */
11204             if (len == 0) {
11205                 OP(ret) = NOTHING;
11206             }
11207             else{
11208                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, len, ender);
11209             }
11210
11211             RExC_parse = p - 1;
11212             Set_Node_Cur_Length(ret); /* MJD */
11213             nextchar(pRExC_state);
11214             {
11215                 /* len is STRLEN which is unsigned, need to copy to signed */
11216                 IV iv = len;
11217                 if (iv < 0)
11218                     vFAIL("Internal disaster");
11219             }
11220
11221         } /* End of label 'defchar:' */
11222         break;
11223     } /* End of giant switch on input character */
11224
11225     return(ret);
11226 }
11227
11228 STATIC char *
11229 S_regwhite( RExC_state_t *pRExC_state, char *p )
11230 {
11231     const char *e = RExC_end;
11232
11233     PERL_ARGS_ASSERT_REGWHITE;
11234
11235     while (p < e) {
11236         if (isSPACE(*p))
11237             ++p;
11238         else if (*p == '#') {
11239             bool ended = 0;
11240             do {
11241                 if (*p++ == '\n') {
11242                     ended = 1;
11243                     break;
11244                 }
11245             } while (p < e);
11246             if (!ended)
11247                 RExC_seen |= REG_SEEN_RUN_ON_COMMENT;
11248         }
11249         else
11250             break;
11251     }
11252     return p;
11253 }
11254
11255 STATIC char *
11256 S_regpatws( RExC_state_t *pRExC_state, char *p , const bool recognize_comment )
11257 {
11258     /* Returns the next non-pattern-white space, non-comment character (the
11259      * latter only if 'recognize_comment is true) in the string p, which is
11260      * ended by RExC_end.  If there is no line break ending a comment,
11261      * RExC_seen has added the REG_SEEN_RUN_ON_COMMENT flag; */
11262     const char *e = RExC_end;
11263
11264     PERL_ARGS_ASSERT_REGPATWS;
11265
11266     while (p < e) {
11267         STRLEN len;
11268         if ((len = is_PATWS_safe(p, e, UTF))) {
11269             p += len;
11270         }
11271         else if (recognize_comment && *p == '#') {
11272             bool ended = 0;
11273             do {
11274                 p++;
11275                 if (is_LNBREAK_safe(p, e, UTF)) {
11276                     ended = 1;
11277                     break;
11278                 }
11279             } while (p < e);
11280             if (!ended)
11281                 RExC_seen |= REG_SEEN_RUN_ON_COMMENT;
11282         }
11283         else
11284             break;
11285     }
11286     return p;
11287 }
11288
11289 /* Parse POSIX character classes: [[:foo:]], [[=foo=]], [[.foo.]].
11290    Character classes ([:foo:]) can also be negated ([:^foo:]).
11291    Returns a named class id (ANYOF_XXX) if successful, -1 otherwise.
11292    Equivalence classes ([=foo=]) and composites ([.foo.]) are parsed,
11293    but trigger failures because they are currently unimplemented. */
11294
11295 #define POSIXCC_DONE(c)   ((c) == ':')
11296 #define POSIXCC_NOTYET(c) ((c) == '=' || (c) == '.')
11297 #define POSIXCC(c) (POSIXCC_DONE(c) || POSIXCC_NOTYET(c))
11298
11299 PERL_STATIC_INLINE I32
11300 S_regpposixcc(pTHX_ RExC_state_t *pRExC_state, I32 value, const bool strict)
11301 {
11302     dVAR;
11303     I32 namedclass = OOB_NAMEDCLASS;
11304
11305     PERL_ARGS_ASSERT_REGPPOSIXCC;
11306
11307     if (value == '[' && RExC_parse + 1 < RExC_end &&
11308         /* I smell either [: or [= or [. -- POSIX has been here, right? */
11309         POSIXCC(UCHARAT(RExC_parse)))
11310     {
11311         const char c = UCHARAT(RExC_parse);
11312         char* const s = RExC_parse++;
11313
11314         while (RExC_parse < RExC_end && UCHARAT(RExC_parse) != c)
11315             RExC_parse++;
11316         if (RExC_parse == RExC_end) {
11317             if (strict) {
11318
11319                 /* Try to give a better location for the error (than the end of
11320                  * the string) by looking for the matching ']' */
11321                 RExC_parse = s;
11322                 while (RExC_parse < RExC_end && UCHARAT(RExC_parse) != ']') {
11323                     RExC_parse++;
11324                 }
11325                 vFAIL2("Unmatched '%c' in POSIX class", c);
11326             }
11327             /* Grandfather lone [:, [=, [. */
11328             RExC_parse = s;
11329         }
11330         else {
11331             const char* const t = RExC_parse++; /* skip over the c */
11332             assert(*t == c);
11333
11334             if (UCHARAT(RExC_parse) == ']') {
11335                 const char *posixcc = s + 1;
11336                 RExC_parse++; /* skip over the ending ] */
11337
11338                 if (*s == ':') {
11339                     const I32 complement = *posixcc == '^' ? *posixcc++ : 0;
11340                     const I32 skip = t - posixcc;
11341
11342                     /* Initially switch on the length of the name.  */
11343                     switch (skip) {
11344                     case 4:
11345                         if (memEQ(posixcc, "word", 4)) /* this is not POSIX,
11346                                                           this is the Perl \w
11347                                                         */
11348                             namedclass = ANYOF_WORDCHAR;
11349                         break;
11350                     case 5:
11351                         /* Names all of length 5.  */
11352                         /* alnum alpha ascii blank cntrl digit graph lower
11353                            print punct space upper  */
11354                         /* Offset 4 gives the best switch position.  */
11355                         switch (posixcc[4]) {
11356                         case 'a':
11357                             if (memEQ(posixcc, "alph", 4)) /* alpha */
11358                                 namedclass = ANYOF_ALPHA;
11359                             break;
11360                         case 'e':
11361                             if (memEQ(posixcc, "spac", 4)) /* space */
11362                                 namedclass = ANYOF_PSXSPC;
11363                             break;
11364                         case 'h':
11365                             if (memEQ(posixcc, "grap", 4)) /* graph */
11366                                 namedclass = ANYOF_GRAPH;
11367                             break;
11368                         case 'i':
11369                             if (memEQ(posixcc, "asci", 4)) /* ascii */
11370                                 namedclass = ANYOF_ASCII;
11371                             break;
11372                         case 'k':
11373                             if (memEQ(posixcc, "blan", 4)) /* blank */
11374                                 namedclass = ANYOF_BLANK;
11375                             break;
11376                         case 'l':
11377                             if (memEQ(posixcc, "cntr", 4)) /* cntrl */
11378                                 namedclass = ANYOF_CNTRL;
11379                             break;
11380                         case 'm':
11381                             if (memEQ(posixcc, "alnu", 4)) /* alnum */
11382                                 namedclass = ANYOF_ALPHANUMERIC;
11383                             break;
11384                         case 'r':
11385                             if (memEQ(posixcc, "lowe", 4)) /* lower */
11386                                 namedclass = (FOLD) ? ANYOF_CASED : ANYOF_LOWER;
11387                             else if (memEQ(posixcc, "uppe", 4)) /* upper */
11388                                 namedclass = (FOLD) ? ANYOF_CASED : ANYOF_UPPER;
11389                             break;
11390                         case 't':
11391                             if (memEQ(posixcc, "digi", 4)) /* digit */
11392                                 namedclass = ANYOF_DIGIT;
11393                             else if (memEQ(posixcc, "prin", 4)) /* print */
11394                                 namedclass = ANYOF_PRINT;
11395                             else if (memEQ(posixcc, "punc", 4)) /* punct */
11396                                 namedclass = ANYOF_PUNCT;
11397                             break;
11398                         }
11399                         break;
11400                     case 6:
11401                         if (memEQ(posixcc, "xdigit", 6))
11402                             namedclass = ANYOF_XDIGIT;
11403                         break;
11404                     }
11405
11406                     if (namedclass == OOB_NAMEDCLASS)
11407                         Simple_vFAIL3("POSIX class [:%.*s:] unknown",
11408                                       t - s - 1, s + 1);
11409
11410                     /* The #defines are structured so each complement is +1 to
11411                      * the normal one */
11412                     if (complement) {
11413                         namedclass++;
11414                     }
11415                     assert (posixcc[skip] == ':');
11416                     assert (posixcc[skip+1] == ']');
11417                 } else if (!SIZE_ONLY) {
11418                     /* [[=foo=]] and [[.foo.]] are still future. */
11419
11420                     /* adjust RExC_parse so the warning shows after
11421                        the class closes */
11422                     while (UCHARAT(RExC_parse) && UCHARAT(RExC_parse) != ']')
11423                         RExC_parse++;
11424                     vFAIL3("POSIX syntax [%c %c] is reserved for future extensions", c, c);
11425                 }
11426             } else {
11427                 /* Maternal grandfather:
11428                  * "[:" ending in ":" but not in ":]" */
11429                 if (strict) {
11430                     vFAIL("Unmatched '[' in POSIX class");
11431                 }
11432
11433                 /* Grandfather lone [:, [=, [. */
11434                 RExC_parse = s;
11435             }
11436         }
11437     }
11438
11439     return namedclass;
11440 }
11441
11442 STATIC bool
11443 S_could_it_be_a_POSIX_class(pTHX_ RExC_state_t *pRExC_state)
11444 {
11445     /* This applies some heuristics at the current parse position (which should
11446      * be at a '[') to see if what follows might be intended to be a [:posix:]
11447      * class.  It returns true if it really is a posix class, of course, but it
11448      * also can return true if it thinks that what was intended was a posix
11449      * class that didn't quite make it.
11450      *
11451      * It will return true for
11452      *      [:alphanumerics:
11453      *      [:alphanumerics]  (as long as the ] isn't followed immediately by a
11454      *                         ')' indicating the end of the (?[
11455      *      [:any garbage including %^&$ punctuation:]
11456      *
11457      * This is designed to be called only from S_handle_regex_sets; it could be
11458      * easily adapted to be called from the spot at the beginning of regclass()
11459      * that checks to see in a normal bracketed class if the surrounding []
11460      * have been omitted ([:word:] instead of [[:word:]]).  But doing so would
11461      * change long-standing behavior, so I (khw) didn't do that */
11462     char* p = RExC_parse + 1;
11463     char first_char = *p;
11464
11465     PERL_ARGS_ASSERT_COULD_IT_BE_A_POSIX_CLASS;
11466
11467     assert(*(p - 1) == '[');
11468
11469     if (! POSIXCC(first_char)) {
11470         return FALSE;
11471     }
11472
11473     p++;
11474     while (p < RExC_end && isWORDCHAR(*p)) p++;
11475
11476     if (p >= RExC_end) {
11477         return FALSE;
11478     }
11479
11480     if (p - RExC_parse > 2    /* Got at least 1 word character */
11481         && (*p == first_char
11482             || (*p == ']' && p + 1 < RExC_end && *(p + 1) != ')')))
11483     {
11484         return TRUE;
11485     }
11486
11487     p = (char *) memchr(RExC_parse, ']', RExC_end - RExC_parse);
11488
11489     return (p
11490             && p - RExC_parse > 2 /* [:] evaluates to colon;
11491                                       [::] is a bad posix class. */
11492             && first_char == *(p - 1));
11493 }
11494
11495 STATIC regnode *
11496 S_handle_regex_sets(pTHX_ RExC_state_t *pRExC_state, SV** return_invlist, I32 *flagp, U32 depth,
11497                    char * const oregcomp_parse)
11498 {
11499     /* Handle the (?[...]) construct to do set operations */
11500
11501     U8 curchar;
11502     UV start, end;      /* End points of code point ranges */
11503     SV* result_string;
11504     char *save_end, *save_parse;
11505     SV* final;
11506     STRLEN len;
11507     regnode* node;
11508     AV* stack;
11509     const bool save_fold = FOLD;
11510
11511     GET_RE_DEBUG_FLAGS_DECL;
11512
11513     PERL_ARGS_ASSERT_HANDLE_REGEX_SETS;
11514
11515     if (LOC) {
11516         vFAIL("(?[...]) not valid in locale");
11517     }
11518     RExC_uni_semantics = 1;
11519
11520     /* This will return only an ANYOF regnode, or (unlikely) something smaller
11521      * (such as EXACT).  Thus we can skip most everything if just sizing.  We
11522      * call regclass to handle '[]' so as to not have to reinvent its parsing
11523      * rules here (throwing away the size it computes each time).  And, we exit
11524      * upon an unescaped ']' that isn't one ending a regclass.  To do both
11525      * these things, we need to realize that something preceded by a backslash
11526      * is escaped, so we have to keep track of backslashes */
11527     if (SIZE_ONLY) {
11528
11529         Perl_ck_warner_d(aTHX_
11530             packWARN(WARN_EXPERIMENTAL__REGEX_SETS),
11531             "The regex_sets feature is experimental" REPORT_LOCATION,
11532             (int) (RExC_parse - RExC_precomp) , RExC_precomp, RExC_parse);
11533
11534         while (RExC_parse < RExC_end) {
11535             SV* current = NULL;
11536             RExC_parse = regpatws(pRExC_state, RExC_parse,
11537                                 TRUE); /* means recognize comments */
11538             switch (*RExC_parse) {
11539                 default:
11540                     break;
11541                 case '\\':
11542                     /* Skip the next byte (which could cause us to end up in
11543                      * the middle of a UTF-8 character, but since none of those
11544                      * are confusable with anything we currently handle in this
11545                      * switch (invariants all), it's safe.  We'll just hit the
11546                      * default: case next time and keep on incrementing until
11547                      * we find one of the invariants we do handle. */
11548                     RExC_parse++;
11549                     break;
11550                 case '[':
11551                 {
11552                     /* If this looks like it is a [:posix:] class, leave the
11553                      * parse pointer at the '[' to fool regclass() into
11554                      * thinking it is part of a '[[:posix:]]'.  That function
11555                      * will use strict checking to force a syntax error if it
11556                      * doesn't work out to a legitimate class */
11557                     bool is_posix_class
11558                                     = could_it_be_a_POSIX_class(pRExC_state);
11559                     if (! is_posix_class) {
11560                         RExC_parse++;
11561                     }
11562
11563                     /* regclass() can only return RESTART_UTF8 if multi-char
11564                        folds are allowed.  */
11565                     if (!regclass(pRExC_state, flagp,depth+1,
11566                                   is_posix_class, /* parse the whole char
11567                                                      class only if not a
11568                                                      posix class */
11569                                   FALSE, /* don't allow multi-char folds */
11570                                   TRUE, /* silence non-portable warnings. */
11571                                   &current))
11572                         FAIL2("panic: regclass returned NULL to handle_sets, flags=%#X",
11573                               *flagp);
11574
11575                     /* function call leaves parse pointing to the ']', except
11576                      * if we faked it */
11577                     if (is_posix_class) {
11578                         RExC_parse--;
11579                     }
11580
11581                     SvREFCNT_dec(current);   /* In case it returned something */
11582                     break;
11583                 }
11584
11585                 case ']':
11586                     RExC_parse++;
11587                     if (RExC_parse < RExC_end
11588                         && *RExC_parse == ')')
11589                     {
11590                         node = reganode(pRExC_state, ANYOF, 0);
11591                         RExC_size += ANYOF_SKIP;
11592                         nextchar(pRExC_state);
11593                         Set_Node_Length(node,
11594                                 RExC_parse - oregcomp_parse + 1); /* MJD */
11595                         return node;
11596                     }
11597                     goto no_close;
11598             }
11599             RExC_parse++;
11600         }
11601
11602         no_close:
11603         FAIL("Syntax error in (?[...])");
11604     }
11605
11606     /* Pass 2 only after this.  Everything in this construct is a
11607      * metacharacter.  Operands begin with either a '\' (for an escape
11608      * sequence), or a '[' for a bracketed character class.  Any other
11609      * character should be an operator, or parenthesis for grouping.  Both
11610      * types of operands are handled by calling regclass() to parse them.  It
11611      * is called with a parameter to indicate to return the computed inversion
11612      * list.  The parsing here is implemented via a stack.  Each entry on the
11613      * stack is a single character representing one of the operators, or the
11614      * '('; or else a pointer to an operand inversion list. */
11615
11616 #define IS_OPERAND(a)  (! SvIOK(a))
11617
11618     /* The stack starts empty.  It is a syntax error if the first thing parsed
11619      * is a binary operator; everything else is pushed on the stack.  When an
11620      * operand is parsed, the top of the stack is examined.  If it is a binary
11621      * operator, the item before it should be an operand, and both are replaced
11622      * by the result of doing that operation on the new operand and the one on
11623      * the stack.   Thus a sequence of binary operands is reduced to a single
11624      * one before the next one is parsed.
11625      *
11626      * A unary operator may immediately follow a binary in the input, for
11627      * example
11628      *      [a] + ! [b]
11629      * When an operand is parsed and the top of the stack is a unary operator,
11630      * the operation is performed, and then the stack is rechecked to see if
11631      * this new operand is part of a binary operation; if so, it is handled as
11632      * above.
11633      *
11634      * A '(' is simply pushed on the stack; it is valid only if the stack is
11635      * empty, or the top element of the stack is an operator or another '('
11636      * (for which the parenthesized expression will become an operand).  By the
11637      * time the corresponding ')' is parsed everything in between should have
11638      * been parsed and evaluated to a single operand (or else is a syntax
11639      * error), and is handled as a regular operand */
11640
11641     stack = newAV();
11642
11643     while (RExC_parse < RExC_end) {
11644         I32 top_index = av_tindex(stack);
11645         SV** top_ptr;
11646         SV* current = NULL;
11647
11648         /* Skip white space */
11649         RExC_parse = regpatws(pRExC_state, RExC_parse,
11650                                 TRUE); /* means recognize comments */
11651         if (RExC_parse >= RExC_end) {
11652             Perl_croak(aTHX_ "panic: Read past end of '(?[ ])'");
11653         }
11654         if ((curchar = UCHARAT(RExC_parse)) == ']') {
11655             break;
11656         }
11657
11658         switch (curchar) {
11659
11660             case '?':
11661                 if (av_tindex(stack) >= 0   /* This makes sure that we can
11662                                                safely subtract 1 from
11663                                                RExC_parse in the next clause.
11664                                                If we have something on the
11665                                                stack, we have parsed something
11666                                              */
11667                     && UCHARAT(RExC_parse - 1) == '('
11668                     && RExC_parse < RExC_end)
11669                 {
11670                     /* If is a '(?', could be an embedded '(?flags:(?[...])'.
11671                      * This happens when we have some thing like
11672                      *
11673                      *   my $thai_or_lao = qr/(?[ \p{Thai} + \p{Lao} ])/;
11674                      *   ...
11675                      *   qr/(?[ \p{Digit} & $thai_or_lao ])/;
11676                      *
11677                      * Here we would be handling the interpolated
11678                      * '$thai_or_lao'.  We handle this by a recursive call to
11679                      * ourselves which returns the inversion list the
11680                      * interpolated expression evaluates to.  We use the flags
11681                      * from the interpolated pattern. */
11682                     U32 save_flags = RExC_flags;
11683                     const char * const save_parse = ++RExC_parse;
11684
11685                     parse_lparen_question_flags(pRExC_state);
11686
11687                     if (RExC_parse == save_parse  /* Makes sure there was at
11688                                                      least one flag (or this
11689                                                      embedding wasn't compiled)
11690                                                    */
11691                         || RExC_parse >= RExC_end - 4
11692                         || UCHARAT(RExC_parse) != ':'
11693                         || UCHARAT(++RExC_parse) != '('
11694                         || UCHARAT(++RExC_parse) != '?'
11695                         || UCHARAT(++RExC_parse) != '[')
11696                     {
11697
11698                         /* In combination with the above, this moves the
11699                          * pointer to the point just after the first erroneous
11700                          * character (or if there are no flags, to where they
11701                          * should have been) */
11702                         if (RExC_parse >= RExC_end - 4) {
11703                             RExC_parse = RExC_end;
11704                         }
11705                         else if (RExC_parse != save_parse) {
11706                             RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
11707                         }
11708                         vFAIL("Expecting '(?flags:(?[...'");
11709                     }
11710                     RExC_parse++;
11711                     (void) handle_regex_sets(pRExC_state, &current, flagp,
11712                                                     depth+1, oregcomp_parse);
11713
11714                     /* Here, 'current' contains the embedded expression's
11715                      * inversion list, and RExC_parse points to the trailing
11716                      * ']'; the next character should be the ')' which will be
11717                      * paired with the '(' that has been put on the stack, so
11718                      * the whole embedded expression reduces to '(operand)' */
11719                     RExC_parse++;
11720
11721                     RExC_flags = save_flags;
11722                     goto handle_operand;
11723                 }
11724                 /* FALL THROUGH */
11725
11726             default:
11727                 RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
11728                 vFAIL("Unexpected character");
11729
11730             case '\\':
11731                 /* regclass() can only return RESTART_UTF8 if multi-char
11732                    folds are allowed.  */
11733                 if (!regclass(pRExC_state, flagp,depth+1,
11734                               TRUE, /* means parse just the next thing */
11735                               FALSE, /* don't allow multi-char folds */
11736                               FALSE, /* don't silence non-portable warnings.  */
11737                               &current))
11738                     FAIL2("panic: regclass returned NULL to handle_sets, flags=%#X",
11739                           *flagp);
11740                 /* regclass() will return with parsing just the \ sequence,
11741                  * leaving the parse pointer at the next thing to parse */
11742                 RExC_parse--;
11743                 goto handle_operand;
11744
11745             case '[':   /* Is a bracketed character class */
11746             {
11747                 bool is_posix_class = could_it_be_a_POSIX_class(pRExC_state);
11748
11749                 if (! is_posix_class) {
11750                     RExC_parse++;
11751                 }
11752
11753                 /* regclass() can only return RESTART_UTF8 if multi-char
11754                    folds are allowed.  */
11755                 if(!regclass(pRExC_state, flagp,depth+1,
11756                              is_posix_class, /* parse the whole char class
11757                                                 only if not a posix class */
11758                              FALSE, /* don't allow multi-char folds */
11759                              FALSE, /* don't silence non-portable warnings.  */
11760                              &current))
11761                     FAIL2("panic: regclass returned NULL to handle_sets, flags=%#X",
11762                           *flagp);
11763                 /* function call leaves parse pointing to the ']', except if we
11764                  * faked it */
11765                 if (is_posix_class) {
11766                     RExC_parse--;
11767                 }
11768
11769                 goto handle_operand;
11770             }
11771
11772             case '&':
11773             case '|':
11774             case '+':
11775             case '-':
11776             case '^':
11777                 if (top_index < 0
11778                     || ( ! (top_ptr = av_fetch(stack, top_index, FALSE)))
11779                     || ! IS_OPERAND(*top_ptr))
11780                 {
11781                     RExC_parse++;
11782                     vFAIL2("Unexpected binary operator '%c' with no preceding operand", curchar);
11783                 }
11784                 av_push(stack, newSVuv(curchar));
11785                 break;
11786
11787             case '!':
11788                 av_push(stack, newSVuv(curchar));
11789                 break;
11790
11791             case '(':
11792                 if (top_index >= 0) {
11793                     top_ptr = av_fetch(stack, top_index, FALSE);
11794                     assert(top_ptr);
11795                     if (IS_OPERAND(*top_ptr)) {
11796                         RExC_parse++;
11797                         vFAIL("Unexpected '(' with no preceding operator");
11798                     }
11799                 }
11800                 av_push(stack, newSVuv(curchar));
11801                 break;
11802
11803             case ')':
11804             {
11805                 SV* lparen;
11806                 if (top_index < 1
11807                     || ! (current = av_pop(stack))
11808                     || ! IS_OPERAND(current)
11809                     || ! (lparen = av_pop(stack))
11810                     || IS_OPERAND(lparen)
11811                     || SvUV(lparen) != '(')
11812                 {
11813                     RExC_parse++;
11814                     vFAIL("Unexpected ')'");
11815                 }
11816                 top_index -= 2;
11817                 SvREFCNT_dec_NN(lparen);
11818
11819                 /* FALL THROUGH */
11820             }
11821
11822               handle_operand:
11823
11824                 /* Here, we have an operand to process, in 'current' */
11825
11826                 if (top_index < 0) {    /* Just push if stack is empty */
11827                     av_push(stack, current);
11828                 }
11829                 else {
11830                     SV* top = av_pop(stack);
11831                     char current_operator;
11832
11833                     if (IS_OPERAND(top)) {
11834                         vFAIL("Operand with no preceding operator");
11835                     }
11836                     current_operator = (char) SvUV(top);
11837                     switch (current_operator) {
11838                         case '(':   /* Push the '(' back on followed by the new
11839                                        operand */
11840                             av_push(stack, top);
11841                             av_push(stack, current);
11842                             SvREFCNT_inc(top);  /* Counters the '_dec' done
11843                                                    just after the 'break', so
11844                                                    it doesn't get wrongly freed
11845                                                  */
11846                             break;
11847
11848                         case '!':
11849                             _invlist_invert(current);
11850
11851                             /* Unlike binary operators, the top of the stack,
11852                              * now that this unary one has been popped off, may
11853                              * legally be an operator, and we now have operand
11854                              * for it. */
11855                             top_index--;
11856                             SvREFCNT_dec_NN(top);
11857                             goto handle_operand;
11858
11859                         case '&':
11860                             _invlist_intersection(av_pop(stack),
11861                                                    current,
11862                                                    &current);
11863                             av_push(stack, current);
11864                             break;
11865
11866                         case '|':
11867                         case '+':
11868                             _invlist_union(av_pop(stack), current, &current);
11869                             av_push(stack, current);
11870                             break;
11871
11872                         case '-':
11873                             _invlist_subtract(av_pop(stack), current, &current);
11874                             av_push(stack, current);
11875                             break;
11876
11877                         case '^':   /* The union minus the intersection */
11878                         {
11879                             SV* i = NULL;
11880                             SV* u = NULL;
11881                             SV* element;
11882
11883                             element = av_pop(stack);
11884                             _invlist_union(element, current, &u);
11885                             _invlist_intersection(element, current, &i);
11886                             _invlist_subtract(u, i, &current);
11887                             av_push(stack, current);
11888                             SvREFCNT_dec_NN(i);
11889                             SvREFCNT_dec_NN(u);
11890                             SvREFCNT_dec_NN(element);
11891                             break;
11892                         }
11893
11894                         default:
11895                             Perl_croak(aTHX_ "panic: Unexpected item on '(?[ ])' stack");
11896                 }
11897                 SvREFCNT_dec_NN(top);
11898             }
11899         }
11900
11901         RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
11902     }
11903
11904     if (av_tindex(stack) < 0   /* Was empty */
11905         || ((final = av_pop(stack)) == NULL)
11906         || ! IS_OPERAND(final)
11907         || av_tindex(stack) >= 0)  /* More left on stack */
11908     {
11909         vFAIL("Incomplete expression within '(?[ ])'");
11910     }
11911
11912     /* Here, 'final' is the resultant inversion list from evaluating the
11913      * expression.  Return it if so requested */
11914     if (return_invlist) {
11915         *return_invlist = final;
11916         return END;
11917     }
11918
11919     /* Otherwise generate a resultant node, based on 'final'.  regclass() is
11920      * expecting a string of ranges and individual code points */
11921     invlist_iterinit(final);
11922     result_string = newSVpvs("");
11923     while (invlist_iternext(final, &start, &end)) {
11924         if (start == end) {
11925             Perl_sv_catpvf(aTHX_ result_string, "\\x{%"UVXf"}", start);
11926         }
11927         else {
11928             Perl_sv_catpvf(aTHX_ result_string, "\\x{%"UVXf"}-\\x{%"UVXf"}",
11929                                                      start,          end);
11930         }
11931     }
11932
11933     save_parse = RExC_parse;
11934     RExC_parse = SvPV(result_string, len);
11935     save_end = RExC_end;
11936     RExC_end = RExC_parse + len;
11937
11938     /* We turn off folding around the call, as the class we have constructed
11939      * already has all folding taken into consideration, and we don't want
11940      * regclass() to add to that */
11941     RExC_flags &= ~RXf_PMf_FOLD;
11942     /* regclass() can only return RESTART_UTF8 if multi-char folds are allowed.
11943      */
11944     node = regclass(pRExC_state, flagp,depth+1,
11945                     FALSE, /* means parse the whole char class */
11946                     FALSE, /* don't allow multi-char folds */
11947                     TRUE, /* silence non-portable warnings.  The above may very
11948                              well have generated non-portable code points, but
11949                              they're valid on this machine */
11950                     NULL);
11951     if (!node)
11952         FAIL2("panic: regclass returned NULL to handle_sets, flags=%#X", flagp);
11953     if (save_fold) {
11954         RExC_flags |= RXf_PMf_FOLD;
11955     }
11956     RExC_parse = save_parse + 1;
11957     RExC_end = save_end;
11958     SvREFCNT_dec_NN(final);
11959     SvREFCNT_dec_NN(result_string);
11960     SvREFCNT_dec_NN(stack);
11961
11962     nextchar(pRExC_state);
11963     Set_Node_Length(node, RExC_parse - oregcomp_parse + 1); /* MJD */
11964     return node;
11965 }
11966 #undef IS_OPERAND
11967
11968 /* The names of properties whose definitions are not known at compile time are
11969  * stored in this SV, after a constant heading.  So if the length has been
11970  * changed since initialization, then there is a run-time definition. */
11971 #define HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION (SvCUR(listsv) != initial_listsv_len)
11972
11973 STATIC regnode *
11974 S_regclass(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth,
11975                  const bool stop_at_1,  /* Just parse the next thing, don't
11976                                            look for a full character class */
11977                  bool allow_multi_folds,
11978                  const bool silence_non_portable,   /* Don't output warnings
11979                                                        about too large
11980                                                        characters */
11981                  SV** ret_invlist)  /* Return an inversion list, not a node */
11982 {
11983     /* parse a bracketed class specification.  Most of these will produce an
11984      * ANYOF node; but something like [a] will produce an EXACT node; [aA], an
11985      * EXACTFish node; [[:ascii:]], a POSIXA node; etc.  It is more complex
11986      * under /i with multi-character folds: it will be rewritten following the
11987      * paradigm of this example, where the <multi-fold>s are characters which
11988      * fold to multiple character sequences:
11989      *      /[abc\x{multi-fold1}def\x{multi-fold2}ghi]/i
11990      * gets effectively rewritten as:
11991      *      /(?:\x{multi-fold1}|\x{multi-fold2}|[abcdefghi]/i
11992      * reg() gets called (recursively) on the rewritten version, and this
11993      * function will return what it constructs.  (Actually the <multi-fold>s
11994      * aren't physically removed from the [abcdefghi], it's just that they are
11995      * ignored in the recursion by means of a flag:
11996      * <RExC_in_multi_char_class>.)
11997      *
11998      * ANYOF nodes contain a bit map for the first 256 characters, with the
11999      * corresponding bit set if that character is in the list.  For characters
12000      * above 255, a range list or swash is used.  There are extra bits for \w,
12001      * etc. in locale ANYOFs, as what these match is not determinable at
12002      * compile time
12003      *
12004      * Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan needs
12005      * to be restarted.  This can only happen if ret_invlist is non-NULL.
12006      */
12007
12008     dVAR;
12009     UV prevvalue = OOB_UNICODE, save_prevvalue = OOB_UNICODE;
12010     IV range = 0;
12011     UV value = OOB_UNICODE, save_value = OOB_UNICODE;
12012     regnode *ret;
12013     STRLEN numlen;
12014     IV namedclass = OOB_NAMEDCLASS;
12015     char *rangebegin = NULL;
12016     bool need_class = 0;
12017     SV *listsv = NULL;
12018     STRLEN initial_listsv_len = 0; /* Kind of a kludge to see if it is more
12019                                       than just initialized.  */
12020     SV* properties = NULL;    /* Code points that match \p{} \P{} */
12021     SV* posixes = NULL;     /* Code points that match classes like, [:word:],
12022                                extended beyond the Latin1 range */
12023     UV element_count = 0;   /* Number of distinct elements in the class.
12024                                Optimizations may be possible if this is tiny */
12025     AV * multi_char_matches = NULL; /* Code points that fold to more than one
12026                                        character; used under /i */
12027     UV n;
12028     char * stop_ptr = RExC_end;    /* where to stop parsing */
12029     const bool skip_white = cBOOL(ret_invlist); /* ignore unescaped white
12030                                                    space? */
12031     const bool strict = cBOOL(ret_invlist); /* Apply strict parsing rules? */
12032
12033     /* Unicode properties are stored in a swash; this holds the current one
12034      * being parsed.  If this swash is the only above-latin1 component of the
12035      * character class, an optimization is to pass it directly on to the
12036      * execution engine.  Otherwise, it is set to NULL to indicate that there
12037      * are other things in the class that have to be dealt with at execution
12038      * time */
12039     SV* swash = NULL;           /* Code points that match \p{} \P{} */
12040
12041     /* Set if a component of this character class is user-defined; just passed
12042      * on to the engine */
12043     bool has_user_defined_property = FALSE;
12044
12045     /* inversion list of code points this node matches only when the target
12046      * string is in UTF-8.  (Because is under /d) */
12047     SV* depends_list = NULL;
12048
12049     /* inversion list of code points this node matches.  For much of the
12050      * function, it includes only those that match regardless of the utf8ness
12051      * of the target string */
12052     SV* cp_list = NULL;
12053
12054 #ifdef EBCDIC
12055     /* In a range, counts how many 0-2 of the ends of it came from literals,
12056      * not escapes.  Thus we can tell if 'A' was input vs \x{C1} */
12057     UV literal_endpoint = 0;
12058 #endif
12059     bool invert = FALSE;    /* Is this class to be complemented */
12060
12061     /* Is there any thing like \W or [:^digit:] that matches above the legal
12062      * Unicode range? */
12063     bool runtime_posix_matches_above_Unicode = FALSE;
12064
12065     regnode * const orig_emit = RExC_emit; /* Save the original RExC_emit in
12066         case we need to change the emitted regop to an EXACT. */
12067     const char * orig_parse = RExC_parse;
12068     const I32 orig_size = RExC_size;
12069     GET_RE_DEBUG_FLAGS_DECL;
12070
12071     PERL_ARGS_ASSERT_REGCLASS;
12072 #ifndef DEBUGGING
12073     PERL_UNUSED_ARG(depth);
12074 #endif
12075
12076     DEBUG_PARSE("clas");
12077
12078     /* Assume we are going to generate an ANYOF node. */
12079     ret = reganode(pRExC_state, ANYOF, 0);
12080
12081     if (SIZE_ONLY) {
12082         RExC_size += ANYOF_SKIP;
12083         listsv = &PL_sv_undef; /* For code scanners: listsv always non-NULL. */
12084     }
12085     else {
12086         ANYOF_FLAGS(ret) = 0;
12087
12088         RExC_emit += ANYOF_SKIP;
12089         if (LOC) {
12090             ANYOF_FLAGS(ret) |= ANYOF_LOCALE;
12091         }
12092         listsv = newSVpvs_flags("# comment\n", SVs_TEMP);
12093         initial_listsv_len = SvCUR(listsv);
12094         SvTEMP_off(listsv); /* Grr, TEMPs and mortals are conflated.  */
12095     }
12096
12097     if (skip_white) {
12098         RExC_parse = regpatws(pRExC_state, RExC_parse,
12099                               FALSE /* means don't recognize comments */);
12100     }
12101
12102     if (UCHARAT(RExC_parse) == '^') {   /* Complement of range. */
12103         RExC_parse++;
12104         invert = TRUE;
12105         allow_multi_folds = FALSE;
12106         RExC_naughty++;
12107         if (skip_white) {
12108             RExC_parse = regpatws(pRExC_state, RExC_parse,
12109                                   FALSE /* means don't recognize comments */);
12110         }
12111     }
12112
12113     /* Check that they didn't say [:posix:] instead of [[:posix:]] */
12114     if (!SIZE_ONLY && RExC_parse < RExC_end && POSIXCC(UCHARAT(RExC_parse))) {
12115         const char *s = RExC_parse;
12116         const char  c = *s++;
12117
12118         while (isWORDCHAR(*s))
12119             s++;
12120         if (*s && c == *s && s[1] == ']') {
12121             SAVEFREESV(RExC_rx_sv);
12122             ckWARN3reg(s+2,
12123                        "POSIX syntax [%c %c] belongs inside character classes",
12124                        c, c);
12125             (void)ReREFCNT_inc(RExC_rx_sv);
12126         }
12127     }
12128
12129     /* If the caller wants us to just parse a single element, accomplish this
12130      * by faking the loop ending condition */
12131     if (stop_at_1 && RExC_end > RExC_parse) {
12132         stop_ptr = RExC_parse + 1;
12133     }
12134
12135     /* allow 1st char to be ']' (allowing it to be '-' is dealt with later) */
12136     if (UCHARAT(RExC_parse) == ']')
12137         goto charclassloop;
12138
12139 parseit:
12140     while (1) {
12141         if  (RExC_parse >= stop_ptr) {
12142             break;
12143         }
12144
12145         if (skip_white) {
12146             RExC_parse = regpatws(pRExC_state, RExC_parse,
12147                                   FALSE /* means don't recognize comments */);
12148         }
12149
12150         if  (UCHARAT(RExC_parse) == ']') {
12151             break;
12152         }
12153
12154     charclassloop:
12155
12156         namedclass = OOB_NAMEDCLASS; /* initialize as illegal */
12157         save_value = value;
12158         save_prevvalue = prevvalue;
12159
12160         if (!range) {
12161             rangebegin = RExC_parse;
12162             element_count++;
12163         }
12164         if (UTF) {
12165             value = utf8n_to_uvchr((U8*)RExC_parse,
12166                                    RExC_end - RExC_parse,
12167                                    &numlen, UTF8_ALLOW_DEFAULT);
12168             RExC_parse += numlen;
12169         }
12170         else
12171             value = UCHARAT(RExC_parse++);
12172
12173         if (value == '['
12174             && RExC_parse < RExC_end
12175             && POSIXCC(UCHARAT(RExC_parse)))
12176         {
12177             namedclass = regpposixcc(pRExC_state, value, strict);
12178         }
12179         else if (value == '\\') {
12180             if (UTF) {
12181                 value = utf8n_to_uvchr((U8*)RExC_parse,
12182                                    RExC_end - RExC_parse,
12183                                    &numlen, UTF8_ALLOW_DEFAULT);
12184                 RExC_parse += numlen;
12185             }
12186             else
12187                 value = UCHARAT(RExC_parse++);
12188
12189             /* Some compilers cannot handle switching on 64-bit integer
12190              * values, therefore value cannot be an UV.  Yes, this will
12191              * be a problem later if we want switch on Unicode.
12192              * A similar issue a little bit later when switching on
12193              * namedclass. --jhi */
12194
12195             /* If the \ is escaping white space when white space is being
12196              * skipped, it means that that white space is wanted literally, and
12197              * is already in 'value'.  Otherwise, need to translate the escape
12198              * into what it signifies. */
12199             if (! skip_white || ! is_PATWS_cp(value)) switch ((I32)value) {
12200
12201             case 'w':   namedclass = ANYOF_WORDCHAR;    break;
12202             case 'W':   namedclass = ANYOF_NWORDCHAR;   break;
12203             case 's':   namedclass = ANYOF_SPACE;       break;
12204             case 'S':   namedclass = ANYOF_NSPACE;      break;
12205             case 'd':   namedclass = ANYOF_DIGIT;       break;
12206             case 'D':   namedclass = ANYOF_NDIGIT;      break;
12207             case 'v':   namedclass = ANYOF_VERTWS;      break;
12208             case 'V':   namedclass = ANYOF_NVERTWS;     break;
12209             case 'h':   namedclass = ANYOF_HORIZWS;     break;
12210             case 'H':   namedclass = ANYOF_NHORIZWS;    break;
12211             case 'N':  /* Handle \N{NAME} in class */
12212                 {
12213                     /* We only pay attention to the first char of 
12214                     multichar strings being returned. I kinda wonder
12215                     if this makes sense as it does change the behaviour
12216                     from earlier versions, OTOH that behaviour was broken
12217                     as well. */
12218                     if (! grok_bslash_N(pRExC_state, NULL, &value, flagp, depth,
12219                                       TRUE, /* => charclass */
12220                                       strict))
12221                     {
12222                         if (*flagp & RESTART_UTF8)
12223                             FAIL("panic: grok_bslash_N set RESTART_UTF8");
12224                         goto parseit;
12225                     }
12226                 }
12227                 break;
12228             case 'p':
12229             case 'P':
12230                 {
12231                 char *e;
12232
12233                 /* We will handle any undefined properties ourselves */
12234                 U8 swash_init_flags = _CORE_SWASH_INIT_RETURN_IF_UNDEF;
12235
12236                 if (RExC_parse >= RExC_end)
12237                     vFAIL2("Empty \\%c{}", (U8)value);
12238                 if (*RExC_parse == '{') {
12239                     const U8 c = (U8)value;
12240                     e = strchr(RExC_parse++, '}');
12241                     if (!e)
12242                         vFAIL2("Missing right brace on \\%c{}", c);
12243                     while (isSPACE(UCHARAT(RExC_parse)))
12244                         RExC_parse++;
12245                     if (e == RExC_parse)
12246                         vFAIL2("Empty \\%c{}", c);
12247                     n = e - RExC_parse;
12248                     while (isSPACE(UCHARAT(RExC_parse + n - 1)))
12249                         n--;
12250                 }
12251                 else {
12252                     e = RExC_parse;
12253                     n = 1;
12254                 }
12255                 if (!SIZE_ONLY) {
12256                     SV* invlist;
12257                     char* name;
12258
12259                     if (UCHARAT(RExC_parse) == '^') {
12260                          RExC_parse++;
12261                          n--;
12262                          /* toggle.  (The rhs xor gets the single bit that
12263                           * differs between P and p; the other xor inverts just
12264                           * that bit) */
12265                          value ^= 'P' ^ 'p';
12266
12267                          while (isSPACE(UCHARAT(RExC_parse))) {
12268                               RExC_parse++;
12269                               n--;
12270                          }
12271                     }
12272                     /* Try to get the definition of the property into
12273                      * <invlist>.  If /i is in effect, the effective property
12274                      * will have its name be <__NAME_i>.  The design is
12275                      * discussed in commit
12276                      * 2f833f5208e26b208886e51e09e2c072b5eabb46 */
12277                     Newx(name, n + sizeof("_i__\n"), char);
12278
12279                     sprintf(name, "%s%.*s%s\n",
12280                                     (FOLD) ? "__" : "",
12281                                     (int)n,
12282                                     RExC_parse,
12283                                     (FOLD) ? "_i" : ""
12284                     );
12285
12286                     /* Look up the property name, and get its swash and
12287                      * inversion list, if the property is found  */
12288                     if (swash) {
12289                         SvREFCNT_dec_NN(swash);
12290                     }
12291                     swash = _core_swash_init("utf8", name, &PL_sv_undef,
12292                                              1, /* binary */
12293                                              0, /* not tr/// */
12294                                              NULL, /* No inversion list */
12295                                              &swash_init_flags
12296                                             );
12297                     if (! swash || ! (invlist = _get_swash_invlist(swash))) {
12298                         if (swash) {
12299                             SvREFCNT_dec_NN(swash);
12300                             swash = NULL;
12301                         }
12302
12303                         /* Here didn't find it.  It could be a user-defined
12304                          * property that will be available at run-time.  If we
12305                          * accept only compile-time properties, is an error;
12306                          * otherwise add it to the list for run-time look up */
12307                         if (ret_invlist) {
12308                             RExC_parse = e + 1;
12309                             vFAIL3("Property '%.*s' is unknown", (int) n, name);
12310                         }
12311                         Perl_sv_catpvf(aTHX_ listsv, "%cutf8::%s\n",
12312                                         (value == 'p' ? '+' : '!'),
12313                                         name);
12314                         has_user_defined_property = TRUE;
12315
12316                         /* We don't know yet, so have to assume that the
12317                          * property could match something in the Latin1 range,
12318                          * hence something that isn't utf8.  Note that this
12319                          * would cause things in <depends_list> to match
12320                          * inappropriately, except that any \p{}, including
12321                          * this one forces Unicode semantics, which means there
12322                          * is <no depends_list> */
12323                         ANYOF_FLAGS(ret) |= ANYOF_NONBITMAP_NON_UTF8;
12324                     }
12325                     else {
12326
12327                         /* Here, did get the swash and its inversion list.  If
12328                          * the swash is from a user-defined property, then this
12329                          * whole character class should be regarded as such */
12330                         has_user_defined_property =
12331                                     (swash_init_flags
12332                                      & _CORE_SWASH_INIT_USER_DEFINED_PROPERTY);
12333
12334                         /* Invert if asking for the complement */
12335                         if (value == 'P') {
12336                             _invlist_union_complement_2nd(properties,
12337                                                           invlist,
12338                                                           &properties);
12339
12340                             /* The swash can't be used as-is, because we've
12341                              * inverted things; delay removing it to here after
12342                              * have copied its invlist above */
12343                             SvREFCNT_dec_NN(swash);
12344                             swash = NULL;
12345                         }
12346                         else {
12347                             _invlist_union(properties, invlist, &properties);
12348                         }
12349                     }
12350                     Safefree(name);
12351                 }
12352                 RExC_parse = e + 1;
12353                 namedclass = ANYOF_UNIPROP;  /* no official name, but it's
12354                                                 named */
12355
12356                 /* \p means they want Unicode semantics */
12357                 RExC_uni_semantics = 1;
12358                 }
12359                 break;
12360             case 'n':   value = '\n';                   break;
12361             case 'r':   value = '\r';                   break;
12362             case 't':   value = '\t';                   break;
12363             case 'f':   value = '\f';                   break;
12364             case 'b':   value = '\b';                   break;
12365             case 'e':   value = ASCII_TO_NATIVE('\033');break;
12366             case 'a':   value = ASCII_TO_NATIVE('\007');break;
12367             case 'o':
12368                 RExC_parse--;   /* function expects to be pointed at the 'o' */
12369                 {
12370                     const char* error_msg;
12371                     bool valid = grok_bslash_o(&RExC_parse,
12372                                                &value,
12373                                                &error_msg,
12374                                                SIZE_ONLY,   /* warnings in pass
12375                                                                1 only */
12376                                                strict,
12377                                                silence_non_portable,
12378                                                UTF);
12379                     if (! valid) {
12380                         vFAIL(error_msg);
12381                     }
12382                 }
12383                 if (PL_encoding && value < 0x100) {
12384                     goto recode_encoding;
12385                 }
12386                 break;
12387             case 'x':
12388                 RExC_parse--;   /* function expects to be pointed at the 'x' */
12389                 {
12390                     const char* error_msg;
12391                     bool valid = grok_bslash_x(&RExC_parse,
12392                                                &value,
12393                                                &error_msg,
12394                                                TRUE, /* Output warnings */
12395                                                strict,
12396                                                silence_non_portable,
12397                                                UTF);
12398                     if (! valid) {
12399                         vFAIL(error_msg);
12400                     }
12401                 }
12402                 if (PL_encoding && value < 0x100)
12403                     goto recode_encoding;
12404                 break;
12405             case 'c':
12406                 value = grok_bslash_c(*RExC_parse++, UTF, SIZE_ONLY);
12407                 break;
12408             case '0': case '1': case '2': case '3': case '4':
12409             case '5': case '6': case '7':
12410                 {
12411                     /* Take 1-3 octal digits */
12412                     I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
12413                     numlen = (strict) ? 4 : 3;
12414                     value = grok_oct(--RExC_parse, &numlen, &flags, NULL);
12415                     RExC_parse += numlen;
12416                     if (numlen != 3) {
12417                         if (strict) {
12418                             RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
12419                             vFAIL("Need exactly 3 octal digits");
12420                         }
12421                         else if (! SIZE_ONLY /* like \08, \178 */
12422                                  && numlen < 3
12423                                  && RExC_parse < RExC_end
12424                                  && isDIGIT(*RExC_parse)
12425                                  && ckWARN(WARN_REGEXP))
12426                         {
12427                             SAVEFREESV(RExC_rx_sv);
12428                             reg_warn_non_literal_string(
12429                                  RExC_parse + 1,
12430                                  form_short_octal_warning(RExC_parse, numlen));
12431                             (void)ReREFCNT_inc(RExC_rx_sv);
12432                         }
12433                     }
12434                     if (PL_encoding && value < 0x100)
12435                         goto recode_encoding;
12436                     break;
12437                 }
12438             recode_encoding:
12439                 if (! RExC_override_recoding) {
12440                     SV* enc = PL_encoding;
12441                     value = reg_recode((const char)(U8)value, &enc);
12442                     if (!enc) {
12443                         if (strict) {
12444                             vFAIL("Invalid escape in the specified encoding");
12445                         }
12446                         else if (SIZE_ONLY) {
12447                             ckWARNreg(RExC_parse,
12448                                   "Invalid escape in the specified encoding");
12449                         }
12450                     }
12451                     break;
12452                 }
12453             default:
12454                 /* Allow \_ to not give an error */
12455                 if (!SIZE_ONLY && isWORDCHAR(value) && value != '_') {
12456                     if (strict) {
12457                         vFAIL2("Unrecognized escape \\%c in character class",
12458                                (int)value);
12459                     }
12460                     else {
12461                         SAVEFREESV(RExC_rx_sv);
12462                         ckWARN2reg(RExC_parse,
12463                             "Unrecognized escape \\%c in character class passed through",
12464                             (int)value);
12465                         (void)ReREFCNT_inc(RExC_rx_sv);
12466                     }
12467                 }
12468                 break;
12469             }   /* End of switch on char following backslash */
12470         } /* end of handling backslash escape sequences */
12471 #ifdef EBCDIC
12472         else
12473             literal_endpoint++;
12474 #endif
12475
12476         /* Here, we have the current token in 'value' */
12477
12478         /* What matches in a locale is not known until runtime.  This includes
12479          * what the Posix classes (like \w, [:space:]) match.  Room must be
12480          * reserved (one time per class) to store such classes, either if Perl
12481          * is compiled so that locale nodes always should have this space, or
12482          * if there is such class info to be stored.  The space will contain a
12483          * bit for each named class that is to be matched against.  This isn't
12484          * needed for \p{} and pseudo-classes, as they are not affected by
12485          * locale, and hence are dealt with separately */
12486         if (LOC
12487             && ! need_class
12488             && (ANYOF_LOCALE == ANYOF_CLASS
12489                 || (namedclass > OOB_NAMEDCLASS && namedclass < ANYOF_MAX)))
12490         {
12491             need_class = 1;
12492             if (SIZE_ONLY) {
12493                 RExC_size += ANYOF_CLASS_SKIP - ANYOF_SKIP;
12494             }
12495             else {
12496                 RExC_emit += ANYOF_CLASS_SKIP - ANYOF_SKIP;
12497                 ANYOF_CLASS_ZERO(ret);
12498             }
12499             ANYOF_FLAGS(ret) |= ANYOF_CLASS;
12500         }
12501
12502         if (namedclass > OOB_NAMEDCLASS) { /* this is a named class \blah */
12503
12504             /* a bad range like a-\d, a-[:digit:].  The '-' is taken as a
12505              * literal, as is the character that began the false range, i.e.
12506              * the 'a' in the examples */
12507             if (range) {
12508                 if (!SIZE_ONLY) {
12509                     const int w = (RExC_parse >= rangebegin)
12510                                   ? RExC_parse - rangebegin
12511                                   : 0;
12512                     if (strict) {
12513                         vFAIL4("False [] range \"%*.*s\"", w, w, rangebegin);
12514                     }
12515                     else {
12516                         SAVEFREESV(RExC_rx_sv); /* in case of fatal warnings */
12517                         ckWARN4reg(RExC_parse,
12518                                 "False [] range \"%*.*s\"",
12519                                 w, w, rangebegin);
12520                         (void)ReREFCNT_inc(RExC_rx_sv);
12521                         cp_list = add_cp_to_invlist(cp_list, '-');
12522                         cp_list = add_cp_to_invlist(cp_list, prevvalue);
12523                     }
12524                 }
12525
12526                 range = 0; /* this was not a true range */
12527                 element_count += 2; /* So counts for three values */
12528             }
12529
12530             if (! SIZE_ONLY) {
12531                 U8 classnum = namedclass_to_classnum(namedclass);
12532                 if (namedclass >= ANYOF_MAX) {  /* If a special class */
12533                     if (namedclass != ANYOF_UNIPROP) { /* UNIPROP = \p and \P */
12534
12535                         /* Here, should be \h, \H, \v, or \V.  Neither /d nor
12536                          * /l make a difference in what these match.  There
12537                          * would be problems if these characters had folds
12538                          * other than themselves, as cp_list is subject to
12539                          * folding. */
12540                         if (classnum != _CC_VERTSPACE) {
12541                             assert(   namedclass == ANYOF_HORIZWS
12542                                    || namedclass == ANYOF_NHORIZWS);
12543
12544                             /* It turns out that \h is just a synonym for
12545                              * XPosixBlank */
12546                             classnum = _CC_BLANK;
12547                         }
12548
12549                         _invlist_union_maybe_complement_2nd(
12550                                 cp_list,
12551                                 PL_XPosix_ptrs[classnum],
12552                                 cBOOL(namedclass % 2), /* Complement if odd
12553                                                           (NHORIZWS, NVERTWS)
12554                                                         */
12555                                 &cp_list);
12556                     }
12557                 }
12558                 else if (classnum == _CC_ASCII) {
12559 #ifdef HAS_ISASCII
12560                     if (LOC) {
12561                         ANYOF_CLASS_SET(ret, namedclass);
12562                     }
12563                     else
12564 #endif  /* Not isascii(); just use the hard-coded definition for it */
12565                         _invlist_union_maybe_complement_2nd(
12566                                 posixes,
12567                                 PL_ASCII,
12568                                 cBOOL(namedclass % 2), /* Complement if odd
12569                                                           (NASCII) */
12570                                 &posixes);
12571                 }
12572                 else {  /* Garden variety class */
12573
12574                     /* The ascii range inversion list */
12575                     SV* ascii_source = PL_Posix_ptrs[classnum];
12576
12577                     /* The full Latin1 range inversion list */
12578                     SV* l1_source = PL_L1Posix_ptrs[classnum];
12579
12580                     /* This code is structured into two major clauses.  The
12581                      * first is for classes whose complete definitions may not
12582                      * already be known.  It not, the Latin1 definition
12583                      * (guaranteed to already known) is used plus code is
12584                      * generated to load the rest at run-time (only if needed).
12585                      * If the complete definition is known, it drops down to
12586                      * the second clause, where the complete definition is
12587                      * known */
12588
12589                     if (classnum < _FIRST_NON_SWASH_CC) {
12590
12591                         /* Here, the class has a swash, which may or not
12592                          * already be loaded */
12593
12594                         /* The name of the property to use to match the full
12595                          * eXtended Unicode range swash for this character
12596                          * class */
12597                         const char *Xname = swash_property_names[classnum];
12598
12599                         /* If returning the inversion list, we can't defer
12600                          * getting this until runtime */
12601                         if (ret_invlist && !  PL_utf8_swash_ptrs[classnum]) {
12602                             PL_utf8_swash_ptrs[classnum] =
12603                                 _core_swash_init("utf8", Xname, &PL_sv_undef,
12604                                              1, /* binary */
12605                                              0, /* not tr/// */
12606                                              NULL, /* No inversion list */
12607                                              NULL  /* No flags */
12608                                             );
12609                             assert(PL_utf8_swash_ptrs[classnum]);
12610                         }
12611                         if ( !  PL_utf8_swash_ptrs[classnum]) {
12612                             if (namedclass % 2 == 0) { /* A non-complemented
12613                                                           class */
12614                                 /* If not /a matching, there are code points we
12615                                  * don't know at compile time.  Arrange for the
12616                                  * unknown matches to be loaded at run-time, if
12617                                  * needed */
12618                                 if (! AT_LEAST_ASCII_RESTRICTED) {
12619                                     Perl_sv_catpvf(aTHX_ listsv, "+utf8::%s\n",
12620                                                                  Xname);
12621                                 }
12622                                 if (LOC) {  /* Under locale, set run-time
12623                                                lookup */
12624                                     ANYOF_CLASS_SET(ret, namedclass);
12625                                 }
12626                                 else {
12627                                     /* Add the current class's code points to
12628                                      * the running total */
12629                                     _invlist_union(posixes,
12630                                                    (AT_LEAST_ASCII_RESTRICTED)
12631                                                         ? ascii_source
12632                                                         : l1_source,
12633                                                    &posixes);
12634                                 }
12635                             }
12636                             else {  /* A complemented class */
12637                                 if (AT_LEAST_ASCII_RESTRICTED) {
12638                                     /* Under /a should match everything above
12639                                      * ASCII, plus the complement of the set's
12640                                      * ASCII matches */
12641                                     _invlist_union_complement_2nd(posixes,
12642                                                                   ascii_source,
12643                                                                   &posixes);
12644                                 }
12645                                 else {
12646                                     /* Arrange for the unknown matches to be
12647                                      * loaded at run-time, if needed */
12648                                     Perl_sv_catpvf(aTHX_ listsv, "!utf8::%s\n",
12649                                                                  Xname);
12650                                     runtime_posix_matches_above_Unicode = TRUE;
12651                                     if (LOC) {
12652                                         ANYOF_CLASS_SET(ret, namedclass);
12653                                     }
12654                                     else {
12655
12656                                         /* We want to match everything in
12657                                          * Latin1, except those things that
12658                                          * l1_source matches */
12659                                         SV* scratch_list = NULL;
12660                                         _invlist_subtract(PL_Latin1, l1_source,
12661                                                           &scratch_list);
12662
12663                                         /* Add the list from this class to the
12664                                          * running total */
12665                                         if (! posixes) {
12666                                             posixes = scratch_list;
12667                                         }
12668                                         else {
12669                                             _invlist_union(posixes,
12670                                                            scratch_list,
12671                                                            &posixes);
12672                                             SvREFCNT_dec_NN(scratch_list);
12673                                         }
12674                                         if (DEPENDS_SEMANTICS) {
12675                                             ANYOF_FLAGS(ret)
12676                                                   |= ANYOF_NON_UTF8_LATIN1_ALL;
12677                                         }
12678                                     }
12679                                 }
12680                             }
12681                             goto namedclass_done;
12682                         }
12683
12684                         /* Here, there is a swash loaded for the class.  If no
12685                          * inversion list for it yet, get it */
12686                         if (! PL_XPosix_ptrs[classnum]) {
12687                             PL_XPosix_ptrs[classnum]
12688                              = _swash_to_invlist(PL_utf8_swash_ptrs[classnum]);
12689                         }
12690                     }
12691
12692                     /* Here there is an inversion list already loaded for the
12693                      * entire class */
12694
12695                     if (namedclass % 2 == 0) {  /* A non-complemented class,
12696                                                    like ANYOF_PUNCT */
12697                         if (! LOC) {
12698                             /* For non-locale, just add it to any existing list
12699                              * */
12700                             _invlist_union(posixes,
12701                                            (AT_LEAST_ASCII_RESTRICTED)
12702                                                ? ascii_source
12703                                                : PL_XPosix_ptrs[classnum],
12704                                            &posixes);
12705                         }
12706                         else {  /* Locale */
12707                             SV* scratch_list = NULL;
12708
12709                             /* For above Latin1 code points, we use the full
12710                              * Unicode range */
12711                             _invlist_intersection(PL_AboveLatin1,
12712                                                   PL_XPosix_ptrs[classnum],
12713                                                   &scratch_list);
12714                             /* And set the output to it, adding instead if
12715                              * there already is an output.  Checking if
12716                              * 'posixes' is NULL first saves an extra clone.
12717                              * Its reference count will be decremented at the
12718                              * next union, etc, or if this is the only
12719                              * instance, at the end of the routine */
12720                             if (! posixes) {
12721                                 posixes = scratch_list;
12722                             }
12723                             else {
12724                                 _invlist_union(posixes, scratch_list, &posixes);
12725                                 SvREFCNT_dec_NN(scratch_list);
12726                             }
12727
12728 #ifndef HAS_ISBLANK
12729                             if (namedclass != ANYOF_BLANK) {
12730 #endif
12731                                 /* Set this class in the node for runtime
12732                                  * matching */
12733                                 ANYOF_CLASS_SET(ret, namedclass);
12734 #ifndef HAS_ISBLANK
12735                             }
12736                             else {
12737                                 /* No isblank(), use the hard-coded ASCII-range
12738                                  * blanks, adding them to the running total. */
12739
12740                                 _invlist_union(posixes, ascii_source, &posixes);
12741                             }
12742 #endif
12743                         }
12744                     }
12745                     else {  /* A complemented class, like ANYOF_NPUNCT */
12746                         if (! LOC) {
12747                             _invlist_union_complement_2nd(
12748                                                 posixes,
12749                                                 (AT_LEAST_ASCII_RESTRICTED)
12750                                                     ? ascii_source
12751                                                     : PL_XPosix_ptrs[classnum],
12752                                                 &posixes);
12753                             /* Under /d, everything in the upper half of the
12754                              * Latin1 range matches this complement */
12755                             if (DEPENDS_SEMANTICS) {
12756                                 ANYOF_FLAGS(ret) |= ANYOF_NON_UTF8_LATIN1_ALL;
12757                             }
12758                         }
12759                         else {  /* Locale */
12760                             SV* scratch_list = NULL;
12761                             _invlist_subtract(PL_AboveLatin1,
12762                                               PL_XPosix_ptrs[classnum],
12763                                               &scratch_list);
12764                             if (! posixes) {
12765                                 posixes = scratch_list;
12766                             }
12767                             else {
12768                                 _invlist_union(posixes, scratch_list, &posixes);
12769                                 SvREFCNT_dec_NN(scratch_list);
12770                             }
12771 #ifndef HAS_ISBLANK
12772                             if (namedclass != ANYOF_NBLANK) {
12773 #endif
12774                                 ANYOF_CLASS_SET(ret, namedclass);
12775 #ifndef HAS_ISBLANK
12776                             }
12777                             else {
12778                                 /* Get the list of all code points in Latin1
12779                                  * that are not ASCII blanks, and add them to
12780                                  * the running total */
12781                                 _invlist_subtract(PL_Latin1, ascii_source,
12782                                                   &scratch_list);
12783                                 _invlist_union(posixes, scratch_list, &posixes);
12784                                 SvREFCNT_dec_NN(scratch_list);
12785                             }
12786 #endif
12787                         }
12788                     }
12789                 }
12790               namedclass_done:
12791                 continue;   /* Go get next character */
12792             }
12793         } /* end of namedclass \blah */
12794
12795         /* Here, we have a single value.  If 'range' is set, it is the ending
12796          * of a range--check its validity.  Later, we will handle each
12797          * individual code point in the range.  If 'range' isn't set, this
12798          * could be the beginning of a range, so check for that by looking
12799          * ahead to see if the next real character to be processed is the range
12800          * indicator--the minus sign */
12801
12802         if (skip_white) {
12803             RExC_parse = regpatws(pRExC_state, RExC_parse,
12804                                 FALSE /* means don't recognize comments */);
12805         }
12806
12807         if (range) {
12808             if (prevvalue > value) /* b-a */ {
12809                 const int w = RExC_parse - rangebegin;
12810                 Simple_vFAIL4("Invalid [] range \"%*.*s\"", w, w, rangebegin);
12811                 range = 0; /* not a valid range */
12812             }
12813         }
12814         else {
12815             prevvalue = value; /* save the beginning of the potential range */
12816             if (! stop_at_1     /* Can't be a range if parsing just one thing */
12817                 && *RExC_parse == '-')
12818             {
12819                 char* next_char_ptr = RExC_parse + 1;
12820                 if (skip_white) {   /* Get the next real char after the '-' */
12821                     next_char_ptr = regpatws(pRExC_state,
12822                                              RExC_parse + 1,
12823                                              FALSE); /* means don't recognize
12824                                                         comments */
12825                 }
12826
12827                 /* If the '-' is at the end of the class (just before the ']',
12828                  * it is a literal minus; otherwise it is a range */
12829                 if (next_char_ptr < RExC_end && *next_char_ptr != ']') {
12830                     RExC_parse = next_char_ptr;
12831
12832                     /* a bad range like \w-, [:word:]- ? */
12833                     if (namedclass > OOB_NAMEDCLASS) {
12834                         if (strict || ckWARN(WARN_REGEXP)) {
12835                             const int w =
12836                                 RExC_parse >= rangebegin ?
12837                                 RExC_parse - rangebegin : 0;
12838                             if (strict) {
12839                                 vFAIL4("False [] range \"%*.*s\"",
12840                                     w, w, rangebegin);
12841                             }
12842                             else {
12843                                 vWARN4(RExC_parse,
12844                                     "False [] range \"%*.*s\"",
12845                                     w, w, rangebegin);
12846                             }
12847                         }
12848                         if (!SIZE_ONLY) {
12849                             cp_list = add_cp_to_invlist(cp_list, '-');
12850                         }
12851                         element_count++;
12852                     } else
12853                         range = 1;      /* yeah, it's a range! */
12854                     continue;   /* but do it the next time */
12855                 }
12856             }
12857         }
12858
12859         /* Here, <prevvalue> is the beginning of the range, if any; or <value>
12860          * if not */
12861
12862         /* non-Latin1 code point implies unicode semantics.  Must be set in
12863          * pass1 so is there for the whole of pass 2 */
12864         if (value > 255) {
12865             RExC_uni_semantics = 1;
12866         }
12867
12868         /* Ready to process either the single value, or the completed range.
12869          * For single-valued non-inverted ranges, we consider the possibility
12870          * of multi-char folds.  (We made a conscious decision to not do this
12871          * for the other cases because it can often lead to non-intuitive
12872          * results.  For example, you have the peculiar case that:
12873          *  "s s" =~ /^[^\xDF]+$/i => Y
12874          *  "ss"  =~ /^[^\xDF]+$/i => N
12875          *
12876          * See [perl #89750] */
12877         if (FOLD && allow_multi_folds && value == prevvalue) {
12878             if (value == LATIN_SMALL_LETTER_SHARP_S
12879                 || (value > 255 && _invlist_contains_cp(PL_HasMultiCharFold,
12880                                                         value)))
12881             {
12882                 /* Here <value> is indeed a multi-char fold.  Get what it is */
12883
12884                 U8 foldbuf[UTF8_MAXBYTES_CASE];
12885                 STRLEN foldlen;
12886
12887                 UV folded = _to_uni_fold_flags(
12888                                 value,
12889                                 foldbuf,
12890                                 &foldlen,
12891                                 FOLD_FLAGS_FULL
12892                                 | ((LOC) ?  FOLD_FLAGS_LOCALE
12893                                             : (ASCII_FOLD_RESTRICTED)
12894                                               ? FOLD_FLAGS_NOMIX_ASCII
12895                                               : 0)
12896                                 );
12897
12898                 /* Here, <folded> should be the first character of the
12899                  * multi-char fold of <value>, with <foldbuf> containing the
12900                  * whole thing.  But, if this fold is not allowed (because of
12901                  * the flags), <fold> will be the same as <value>, and should
12902                  * be processed like any other character, so skip the special
12903                  * handling */
12904                 if (folded != value) {
12905
12906                     /* Skip if we are recursed, currently parsing the class
12907                      * again.  Otherwise add this character to the list of
12908                      * multi-char folds. */
12909                     if (! RExC_in_multi_char_class) {
12910                         AV** this_array_ptr;
12911                         AV* this_array;
12912                         STRLEN cp_count = utf8_length(foldbuf,
12913                                                       foldbuf + foldlen);
12914                         SV* multi_fold = sv_2mortal(newSVpvn("", 0));
12915
12916                         Perl_sv_catpvf(aTHX_ multi_fold, "\\x{%"UVXf"}", value);
12917
12918
12919                         if (! multi_char_matches) {
12920                             multi_char_matches = newAV();
12921                         }
12922
12923                         /* <multi_char_matches> is actually an array of arrays.
12924                          * There will be one or two top-level elements: [2],
12925                          * and/or [3].  The [2] element is an array, each
12926                          * element thereof is a character which folds to two
12927                          * characters; likewise for [3].  (Unicode guarantees a
12928                          * maximum of 3 characters in any fold.)  When we
12929                          * rewrite the character class below, we will do so
12930                          * such that the longest folds are written first, so
12931                          * that it prefers the longest matching strings first.
12932                          * This is done even if it turns out that any
12933                          * quantifier is non-greedy, out of programmer
12934                          * laziness.  Tom Christiansen has agreed that this is
12935                          * ok.  This makes the test for the ligature 'ffi' come
12936                          * before the test for 'ff' */
12937                         if (av_exists(multi_char_matches, cp_count)) {
12938                             this_array_ptr = (AV**) av_fetch(multi_char_matches,
12939                                                              cp_count, FALSE);
12940                             this_array = *this_array_ptr;
12941                         }
12942                         else {
12943                             this_array = newAV();
12944                             av_store(multi_char_matches, cp_count,
12945                                      (SV*) this_array);
12946                         }
12947                         av_push(this_array, multi_fold);
12948                     }
12949
12950                     /* This element should not be processed further in this
12951                      * class */
12952                     element_count--;
12953                     value = save_value;
12954                     prevvalue = save_prevvalue;
12955                     continue;
12956                 }
12957             }
12958         }
12959
12960         /* Deal with this element of the class */
12961         if (! SIZE_ONLY) {
12962 #ifndef EBCDIC
12963             cp_list = _add_range_to_invlist(cp_list, prevvalue, value);
12964 #else
12965             SV* this_range = _new_invlist(1);
12966             _append_range_to_invlist(this_range, prevvalue, value);
12967
12968             /* In EBCDIC, the ranges 'A-Z' and 'a-z' are each not contiguous.
12969              * If this range was specified using something like 'i-j', we want
12970              * to include only the 'i' and the 'j', and not anything in
12971              * between, so exclude non-ASCII, non-alphabetics from it.
12972              * However, if the range was specified with something like
12973              * [\x89-\x91] or [\x89-j], all code points within it should be
12974              * included.  literal_endpoint==2 means both ends of the range used
12975              * a literal character, not \x{foo} */
12976             if (literal_endpoint == 2
12977                 && (prevvalue >= 'a' && value <= 'z')
12978                     || (prevvalue >= 'A' && value <= 'Z'))
12979             {
12980                 _invlist_intersection(this_range, PL_Posix_ptrs[_CC_ALPHA],
12981                                       &this_range);
12982             }
12983             _invlist_union(cp_list, this_range, &cp_list);
12984             literal_endpoint = 0;
12985 #endif
12986         }
12987
12988         range = 0; /* this range (if it was one) is done now */
12989     } /* End of loop through all the text within the brackets */
12990
12991     /* If anything in the class expands to more than one character, we have to
12992      * deal with them by building up a substitute parse string, and recursively
12993      * calling reg() on it, instead of proceeding */
12994     if (multi_char_matches) {
12995         SV * substitute_parse = newSVpvn_flags("?:", 2, SVs_TEMP);
12996         I32 cp_count;
12997         STRLEN len;
12998         char *save_end = RExC_end;
12999         char *save_parse = RExC_parse;
13000         bool first_time = TRUE;     /* First multi-char occurrence doesn't get
13001                                        a "|" */
13002         I32 reg_flags;
13003
13004         assert(! invert);
13005 #if 0   /* Have decided not to deal with multi-char folds in inverted classes,
13006            because too confusing */
13007         if (invert) {
13008             sv_catpv(substitute_parse, "(?:");
13009         }
13010 #endif
13011
13012         /* Look at the longest folds first */
13013         for (cp_count = av_len(multi_char_matches); cp_count > 0; cp_count--) {
13014
13015             if (av_exists(multi_char_matches, cp_count)) {
13016                 AV** this_array_ptr;
13017                 SV* this_sequence;
13018
13019                 this_array_ptr = (AV**) av_fetch(multi_char_matches,
13020                                                  cp_count, FALSE);
13021                 while ((this_sequence = av_pop(*this_array_ptr)) !=
13022                                                                 &PL_sv_undef)
13023                 {
13024                     if (! first_time) {
13025                         sv_catpv(substitute_parse, "|");
13026                     }
13027                     first_time = FALSE;
13028
13029                     sv_catpv(substitute_parse, SvPVX(this_sequence));
13030                 }
13031             }
13032         }
13033
13034         /* If the character class contains anything else besides these
13035          * multi-character folds, have to include it in recursive parsing */
13036         if (element_count) {
13037             sv_catpv(substitute_parse, "|[");
13038             sv_catpvn(substitute_parse, orig_parse, RExC_parse - orig_parse);
13039             sv_catpv(substitute_parse, "]");
13040         }
13041
13042         sv_catpv(substitute_parse, ")");
13043 #if 0
13044         if (invert) {
13045             /* This is a way to get the parse to skip forward a whole named
13046              * sequence instead of matching the 2nd character when it fails the
13047              * first */
13048             sv_catpv(substitute_parse, "(*THEN)(*SKIP)(*FAIL)|.)");
13049         }
13050 #endif
13051
13052         RExC_parse = SvPV(substitute_parse, len);
13053         RExC_end = RExC_parse + len;
13054         RExC_in_multi_char_class = 1;
13055         RExC_emit = (regnode *)orig_emit;
13056
13057         ret = reg(pRExC_state, 1, &reg_flags, depth+1);
13058
13059         *flagp |= reg_flags&(HASWIDTH|SIMPLE|SPSTART|POSTPONED|RESTART_UTF8);
13060
13061         RExC_parse = save_parse;
13062         RExC_end = save_end;
13063         RExC_in_multi_char_class = 0;
13064         SvREFCNT_dec_NN(multi_char_matches);
13065         return ret;
13066     }
13067
13068     /* If the character class contains only a single element, it may be
13069      * optimizable into another node type which is smaller and runs faster.
13070      * Check if this is the case for this class */
13071     if (element_count == 1 && ! ret_invlist) {
13072         U8 op = END;
13073         U8 arg = 0;
13074
13075         if (namedclass > OOB_NAMEDCLASS) { /* this is a named class, like \w or
13076                                               [:digit:] or \p{foo} */
13077
13078             /* All named classes are mapped into POSIXish nodes, with its FLAG
13079              * argument giving which class it is */
13080             switch ((I32)namedclass) {
13081                 case ANYOF_UNIPROP:
13082                     break;
13083
13084                 /* These don't depend on the charset modifiers.  They always
13085                  * match under /u rules */
13086                 case ANYOF_NHORIZWS:
13087                 case ANYOF_HORIZWS:
13088                     namedclass = ANYOF_BLANK + namedclass - ANYOF_HORIZWS;
13089                     /* FALLTHROUGH */
13090
13091                 case ANYOF_NVERTWS:
13092                 case ANYOF_VERTWS:
13093                     op = POSIXU;
13094                     goto join_posix;
13095
13096                 /* The actual POSIXish node for all the rest depends on the
13097                  * charset modifier.  The ones in the first set depend only on
13098                  * ASCII or, if available on this platform, locale */
13099                 case ANYOF_ASCII:
13100                 case ANYOF_NASCII:
13101 #ifdef HAS_ISASCII
13102                     op = (LOC) ? POSIXL : POSIXA;
13103 #else
13104                     op = POSIXA;
13105 #endif
13106                     goto join_posix;
13107
13108                 case ANYOF_NCASED:
13109                 case ANYOF_LOWER:
13110                 case ANYOF_NLOWER:
13111                 case ANYOF_UPPER:
13112                 case ANYOF_NUPPER:
13113                     /* under /a could be alpha */
13114                     if (FOLD) {
13115                         if (ASCII_RESTRICTED) {
13116                             namedclass = ANYOF_ALPHA + (namedclass % 2);
13117                         }
13118                         else if (! LOC) {
13119                             break;
13120                         }
13121                     }
13122                     /* FALLTHROUGH */
13123
13124                 /* The rest have more possibilities depending on the charset.
13125                  * We take advantage of the enum ordering of the charset
13126                  * modifiers to get the exact node type, */
13127                 default:
13128                     op = POSIXD + get_regex_charset(RExC_flags);
13129                     if (op > POSIXA) { /* /aa is same as /a */
13130                         op = POSIXA;
13131                     }
13132 #ifndef HAS_ISBLANK
13133                     if (op == POSIXL
13134                         && (namedclass == ANYOF_BLANK
13135                             || namedclass == ANYOF_NBLANK))
13136                     {
13137                         op = POSIXA;
13138                     }
13139 #endif
13140
13141                 join_posix:
13142                     /* The odd numbered ones are the complements of the
13143                      * next-lower even number one */
13144                     if (namedclass % 2 == 1) {
13145                         invert = ! invert;
13146                         namedclass--;
13147                     }
13148                     arg = namedclass_to_classnum(namedclass);
13149                     break;
13150             }
13151         }
13152         else if (value == prevvalue) {
13153
13154             /* Here, the class consists of just a single code point */
13155
13156             if (invert) {
13157                 if (! LOC && value == '\n') {
13158                     op = REG_ANY; /* Optimize [^\n] */
13159                     *flagp |= HASWIDTH|SIMPLE;
13160                     RExC_naughty++;
13161                 }
13162             }
13163             else if (value < 256 || UTF) {
13164
13165                 /* Optimize a single value into an EXACTish node, but not if it
13166                  * would require converting the pattern to UTF-8. */
13167                 op = compute_EXACTish(pRExC_state);
13168             }
13169         } /* Otherwise is a range */
13170         else if (! LOC) {   /* locale could vary these */
13171             if (prevvalue == '0') {
13172                 if (value == '9') {
13173                     arg = _CC_DIGIT;
13174                     op = POSIXA;
13175                 }
13176             }
13177         }
13178
13179         /* Here, we have changed <op> away from its initial value iff we found
13180          * an optimization */
13181         if (op != END) {
13182
13183             /* Throw away this ANYOF regnode, and emit the calculated one,
13184              * which should correspond to the beginning, not current, state of
13185              * the parse */
13186             const char * cur_parse = RExC_parse;
13187             RExC_parse = (char *)orig_parse;
13188             if ( SIZE_ONLY) {
13189                 if (! LOC) {
13190
13191                     /* To get locale nodes to not use the full ANYOF size would
13192                      * require moving the code above that writes the portions
13193                      * of it that aren't in other nodes to after this point.
13194                      * e.g.  ANYOF_CLASS_SET */
13195                     RExC_size = orig_size;
13196                 }
13197             }
13198             else {
13199                 RExC_emit = (regnode *)orig_emit;
13200                 if (PL_regkind[op] == POSIXD) {
13201                     if (invert) {
13202                         op += NPOSIXD - POSIXD;
13203                     }
13204                 }
13205             }
13206
13207             ret = reg_node(pRExC_state, op);
13208
13209             if (PL_regkind[op] == POSIXD || PL_regkind[op] == NPOSIXD) {
13210                 if (! SIZE_ONLY) {
13211                     FLAGS(ret) = arg;
13212                 }
13213                 *flagp |= HASWIDTH|SIMPLE;
13214             }
13215             else if (PL_regkind[op] == EXACT) {
13216                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, 0, value);
13217             }
13218
13219             RExC_parse = (char *) cur_parse;
13220
13221             SvREFCNT_dec(posixes);
13222             SvREFCNT_dec(cp_list);
13223             return ret;
13224         }
13225     }
13226
13227     if (SIZE_ONLY)
13228         return ret;
13229     /****** !SIZE_ONLY (Pass 2) AFTER HERE *********/
13230
13231     /* If folding, we calculate all characters that could fold to or from the
13232      * ones already on the list */
13233     if (FOLD && cp_list) {
13234         UV start, end;  /* End points of code point ranges */
13235
13236         SV* fold_intersection = NULL;
13237
13238         /* If the highest code point is within Latin1, we can use the
13239          * compiled-in Alphas list, and not have to go out to disk.  This
13240          * yields two false positives, the masculine and feminine ordinal
13241          * indicators, which are weeded out below using the
13242          * IS_IN_SOME_FOLD_L1() macro */
13243         if (invlist_highest(cp_list) < 256) {
13244             _invlist_intersection(PL_L1Posix_ptrs[_CC_ALPHA], cp_list,
13245                                                            &fold_intersection);
13246         }
13247         else {
13248
13249             /* Here, there are non-Latin1 code points, so we will have to go
13250              * fetch the list of all the characters that participate in folds
13251              */
13252             if (! PL_utf8_foldable) {
13253                 SV* swash = swash_init("utf8", "_Perl_Any_Folds",
13254                                        &PL_sv_undef, 1, 0);
13255                 PL_utf8_foldable = _get_swash_invlist(swash);
13256                 SvREFCNT_dec_NN(swash);
13257             }
13258
13259             /* This is a hash that for a particular fold gives all characters
13260              * that are involved in it */
13261             if (! PL_utf8_foldclosures) {
13262
13263                 /* If we were unable to find any folds, then we likely won't be
13264                  * able to find the closures.  So just create an empty list.
13265                  * Folding will effectively be restricted to the non-Unicode
13266                  * rules hard-coded into Perl.  (This case happens legitimately
13267                  * during compilation of Perl itself before the Unicode tables
13268                  * are generated) */
13269                 if (_invlist_len(PL_utf8_foldable) == 0) {
13270                     PL_utf8_foldclosures = newHV();
13271                 }
13272                 else {
13273                     /* If the folds haven't been read in, call a fold function
13274                      * to force that */
13275                     if (! PL_utf8_tofold) {
13276                         U8 dummy[UTF8_MAXBYTES+1];
13277
13278                         /* This string is just a short named one above \xff */
13279                         to_utf8_fold((U8*) HYPHEN_UTF8, dummy, NULL);
13280                         assert(PL_utf8_tofold); /* Verify that worked */
13281                     }
13282                     PL_utf8_foldclosures =
13283                                     _swash_inversion_hash(PL_utf8_tofold);
13284                 }
13285             }
13286
13287             /* Only the characters in this class that participate in folds need
13288              * be checked.  Get the intersection of this class and all the
13289              * possible characters that are foldable.  This can quickly narrow
13290              * down a large class */
13291             _invlist_intersection(PL_utf8_foldable, cp_list,
13292                                   &fold_intersection);
13293         }
13294
13295         /* Now look at the foldable characters in this class individually */
13296         invlist_iterinit(fold_intersection);
13297         while (invlist_iternext(fold_intersection, &start, &end)) {
13298             UV j;
13299
13300             /* Locale folding for Latin1 characters is deferred until runtime */
13301             if (LOC && start < 256) {
13302                 start = 256;
13303             }
13304
13305             /* Look at every character in the range */
13306             for (j = start; j <= end; j++) {
13307
13308                 U8 foldbuf[UTF8_MAXBYTES_CASE+1];
13309                 STRLEN foldlen;
13310                 SV** listp;
13311
13312                 if (j < 256) {
13313
13314                     /* We have the latin1 folding rules hard-coded here so that
13315                      * an innocent-looking character class, like /[ks]/i won't
13316                      * have to go out to disk to find the possible matches.
13317                      * XXX It would be better to generate these via regen, in
13318                      * case a new version of the Unicode standard adds new
13319                      * mappings, though that is not really likely, and may be
13320                      * caught by the default: case of the switch below. */
13321
13322                     if (IS_IN_SOME_FOLD_L1(j)) {
13323
13324                         /* ASCII is always matched; non-ASCII is matched only
13325                          * under Unicode rules */
13326                         if (isASCII(j) || AT_LEAST_UNI_SEMANTICS) {
13327                             cp_list =
13328                                 add_cp_to_invlist(cp_list, PL_fold_latin1[j]);
13329                         }
13330                         else {
13331                             depends_list =
13332                              add_cp_to_invlist(depends_list, PL_fold_latin1[j]);
13333                         }
13334                     }
13335
13336                     if (HAS_NONLATIN1_FOLD_CLOSURE(j)
13337                         && (! isASCII(j) || ! ASCII_FOLD_RESTRICTED))
13338                     {
13339                         /* Certain Latin1 characters have matches outside
13340                          * Latin1.  To get here, <j> is one of those
13341                          * characters.   None of these matches is valid for
13342                          * ASCII characters under /aa, which is why the 'if'
13343                          * just above excludes those.  These matches only
13344                          * happen when the target string is utf8.  The code
13345                          * below adds the single fold closures for <j> to the
13346                          * inversion list. */
13347                         switch (j) {
13348                             case 'k':
13349                             case 'K':
13350                                 cp_list =
13351                                     add_cp_to_invlist(cp_list, KELVIN_SIGN);
13352                                 break;
13353                             case 's':
13354                             case 'S':
13355                                 cp_list = add_cp_to_invlist(cp_list,
13356                                                     LATIN_SMALL_LETTER_LONG_S);
13357                                 break;
13358                             case MICRO_SIGN:
13359                                 cp_list = add_cp_to_invlist(cp_list,
13360                                                     GREEK_CAPITAL_LETTER_MU);
13361                                 cp_list = add_cp_to_invlist(cp_list,
13362                                                     GREEK_SMALL_LETTER_MU);
13363                                 break;
13364                             case LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE:
13365                             case LATIN_SMALL_LETTER_A_WITH_RING_ABOVE:
13366                                 cp_list =
13367                                     add_cp_to_invlist(cp_list, ANGSTROM_SIGN);
13368                                 break;
13369                             case LATIN_SMALL_LETTER_Y_WITH_DIAERESIS:
13370                                 cp_list = add_cp_to_invlist(cp_list,
13371                                         LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS);
13372                                 break;
13373                             case LATIN_SMALL_LETTER_SHARP_S:
13374                                 cp_list = add_cp_to_invlist(cp_list,
13375                                                 LATIN_CAPITAL_LETTER_SHARP_S);
13376                                 break;
13377                             case 'F': case 'f':
13378                             case 'I': case 'i':
13379                             case 'L': case 'l':
13380                             case 'T': case 't':
13381                             case 'A': case 'a':
13382                             case 'H': case 'h':
13383                             case 'J': case 'j':
13384                             case 'N': case 'n':
13385                             case 'W': case 'w':
13386                             case 'Y': case 'y':
13387                                 /* These all are targets of multi-character
13388                                  * folds from code points that require UTF8 to
13389                                  * express, so they can't match unless the
13390                                  * target string is in UTF-8, so no action here
13391                                  * is necessary, as regexec.c properly handles
13392                                  * the general case for UTF-8 matching and
13393                                  * multi-char folds */
13394                                 break;
13395                             default:
13396                                 /* Use deprecated warning to increase the
13397                                  * chances of this being output */
13398                                 ckWARN2regdep(RExC_parse, "Perl folding rules are not up-to-date for 0x%"UVXf"; please use the perlbug utility to report;", j);
13399                                 break;
13400                         }
13401                     }
13402                     continue;
13403                 }
13404
13405                 /* Here is an above Latin1 character.  We don't have the rules
13406                  * hard-coded for it.  First, get its fold.  This is the simple
13407                  * fold, as the multi-character folds have been handled earlier
13408                  * and separated out */
13409                 _to_uni_fold_flags(j, foldbuf, &foldlen,
13410                                                ((LOC)
13411                                                ? FOLD_FLAGS_LOCALE
13412                                                : (ASCII_FOLD_RESTRICTED)
13413                                                   ? FOLD_FLAGS_NOMIX_ASCII
13414                                                   : 0));
13415
13416                 /* Single character fold of above Latin1.  Add everything in
13417                  * its fold closure to the list that this node should match.
13418                  * The fold closures data structure is a hash with the keys
13419                  * being the UTF-8 of every character that is folded to, like
13420                  * 'k', and the values each an array of all code points that
13421                  * fold to its key.  e.g. [ 'k', 'K', KELVIN_SIGN ].
13422                  * Multi-character folds are not included */
13423                 if ((listp = hv_fetch(PL_utf8_foldclosures,
13424                                       (char *) foldbuf, foldlen, FALSE)))
13425                 {
13426                     AV* list = (AV*) *listp;
13427                     IV k;
13428                     for (k = 0; k <= av_len(list); k++) {
13429                         SV** c_p = av_fetch(list, k, FALSE);
13430                         UV c;
13431                         if (c_p == NULL) {
13432                             Perl_croak(aTHX_ "panic: invalid PL_utf8_foldclosures structure");
13433                         }
13434                         c = SvUV(*c_p);
13435
13436                         /* /aa doesn't allow folds between ASCII and non-; /l
13437                          * doesn't allow them between above and below 256 */
13438                         if ((ASCII_FOLD_RESTRICTED
13439                                   && (isASCII(c) != isASCII(j)))
13440                             || (LOC && ((c < 256) != (j < 256))))
13441                         {
13442                             continue;
13443                         }
13444
13445                         /* Folds involving non-ascii Latin1 characters
13446                          * under /d are added to a separate list */
13447                         if (isASCII(c) || c > 255 || AT_LEAST_UNI_SEMANTICS)
13448                         {
13449                             cp_list = add_cp_to_invlist(cp_list, c);
13450                         }
13451                         else {
13452                           depends_list = add_cp_to_invlist(depends_list, c);
13453                         }
13454                     }
13455                 }
13456             }
13457         }
13458         SvREFCNT_dec_NN(fold_intersection);
13459     }
13460
13461     /* And combine the result (if any) with any inversion list from posix
13462      * classes.  The lists are kept separate up to now because we don't want to
13463      * fold the classes (folding of those is automatically handled by the swash
13464      * fetching code) */
13465     if (posixes) {
13466         if (! DEPENDS_SEMANTICS) {
13467             if (cp_list) {
13468                 _invlist_union(cp_list, posixes, &cp_list);
13469                 SvREFCNT_dec_NN(posixes);
13470             }
13471             else {
13472                 cp_list = posixes;
13473             }
13474         }
13475         else {
13476             /* Under /d, we put into a separate list the Latin1 things that
13477              * match only when the target string is utf8 */
13478             SV* nonascii_but_latin1_properties = NULL;
13479             _invlist_intersection(posixes, PL_Latin1,
13480                                   &nonascii_but_latin1_properties);
13481             _invlist_subtract(nonascii_but_latin1_properties, PL_ASCII,
13482                               &nonascii_but_latin1_properties);
13483             _invlist_subtract(posixes, nonascii_but_latin1_properties,
13484                               &posixes);
13485             if (cp_list) {
13486                 _invlist_union(cp_list, posixes, &cp_list);
13487                 SvREFCNT_dec_NN(posixes);
13488             }
13489             else {
13490                 cp_list = posixes;
13491             }
13492
13493             if (depends_list) {
13494                 _invlist_union(depends_list, nonascii_but_latin1_properties,
13495                                &depends_list);
13496                 SvREFCNT_dec_NN(nonascii_but_latin1_properties);
13497             }
13498             else {
13499                 depends_list = nonascii_but_latin1_properties;
13500             }
13501         }
13502     }
13503
13504     /* And combine the result (if any) with any inversion list from properties.
13505      * The lists are kept separate up to now so that we can distinguish the two
13506      * in regards to matching above-Unicode.  A run-time warning is generated
13507      * if a Unicode property is matched against a non-Unicode code point. But,
13508      * we allow user-defined properties to match anything, without any warning,
13509      * and we also suppress the warning if there is a portion of the character
13510      * class that isn't a Unicode property, and which matches above Unicode, \W
13511      * or [\x{110000}] for example.
13512      * (Note that in this case, unlike the Posix one above, there is no
13513      * <depends_list>, because having a Unicode property forces Unicode
13514      * semantics */
13515     if (properties) {
13516         bool warn_super = ! has_user_defined_property;
13517         if (cp_list) {
13518
13519             /* If it matters to the final outcome, see if a non-property
13520              * component of the class matches above Unicode.  If so, the
13521              * warning gets suppressed.  This is true even if just a single
13522              * such code point is specified, as though not strictly correct if
13523              * another such code point is matched against, the fact that they
13524              * are using above-Unicode code points indicates they should know
13525              * the issues involved */
13526             if (warn_super) {
13527                 bool non_prop_matches_above_Unicode =
13528                             runtime_posix_matches_above_Unicode
13529                             | (invlist_highest(cp_list) > PERL_UNICODE_MAX);
13530                 if (invert) {
13531                     non_prop_matches_above_Unicode =
13532                                             !  non_prop_matches_above_Unicode;
13533                 }
13534                 warn_super = ! non_prop_matches_above_Unicode;
13535             }
13536
13537             _invlist_union(properties, cp_list, &cp_list);
13538             SvREFCNT_dec_NN(properties);
13539         }
13540         else {
13541             cp_list = properties;
13542         }
13543
13544         if (warn_super) {
13545             OP(ret) = ANYOF_WARN_SUPER;
13546         }
13547     }
13548
13549     /* Here, we have calculated what code points should be in the character
13550      * class.
13551      *
13552      * Now we can see about various optimizations.  Fold calculation (which we
13553      * did above) needs to take place before inversion.  Otherwise /[^k]/i
13554      * would invert to include K, which under /i would match k, which it
13555      * shouldn't.  Therefore we can't invert folded locale now, as it won't be
13556      * folded until runtime */
13557
13558     /* Optimize inverted simple patterns (e.g. [^a-z]) when everything is known
13559      * at compile time.  Besides not inverting folded locale now, we can't
13560      * invert if there are things such as \w, which aren't known until runtime
13561      * */
13562     if (invert
13563         && ! (LOC && (FOLD || (ANYOF_FLAGS(ret) & ANYOF_CLASS)))
13564         && ! depends_list
13565         && ! HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
13566     {
13567         _invlist_invert(cp_list);
13568
13569         /* Any swash can't be used as-is, because we've inverted things */
13570         if (swash) {
13571             SvREFCNT_dec_NN(swash);
13572             swash = NULL;
13573         }
13574
13575         /* Clear the invert flag since have just done it here */
13576         invert = FALSE;
13577     }
13578
13579     if (ret_invlist) {
13580         *ret_invlist = cp_list;
13581
13582         /* Discard the generated node */
13583         if (SIZE_ONLY) {
13584             RExC_size = orig_size;
13585         }
13586         else {
13587             RExC_emit = orig_emit;
13588         }
13589         return orig_emit;
13590     }
13591
13592     /* If we didn't do folding, it's because some information isn't available
13593      * until runtime; set the run-time fold flag for these.  (We don't have to
13594      * worry about properties folding, as that is taken care of by the swash
13595      * fetching) */
13596     if (FOLD && LOC)
13597     {
13598        ANYOF_FLAGS(ret) |= ANYOF_LOC_FOLD;
13599     }
13600
13601     /* Some character classes are equivalent to other nodes.  Such nodes take
13602      * up less room and generally fewer operations to execute than ANYOF nodes.
13603      * Above, we checked for and optimized into some such equivalents for
13604      * certain common classes that are easy to test.  Getting to this point in
13605      * the code means that the class didn't get optimized there.  Since this
13606      * code is only executed in Pass 2, it is too late to save space--it has
13607      * been allocated in Pass 1, and currently isn't given back.  But turning
13608      * things into an EXACTish node can allow the optimizer to join it to any
13609      * adjacent such nodes.  And if the class is equivalent to things like /./,
13610      * expensive run-time swashes can be avoided.  Now that we have more
13611      * complete information, we can find things necessarily missed by the
13612      * earlier code.  I (khw) am not sure how much to look for here.  It would
13613      * be easy, but perhaps too slow, to check any candidates against all the
13614      * node types they could possibly match using _invlistEQ(). */
13615
13616     if (cp_list
13617         && ! invert
13618         && ! depends_list
13619         && ! (ANYOF_FLAGS(ret) & ANYOF_CLASS)
13620         && ! HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
13621     {
13622         UV start, end;
13623         U8 op = END;  /* The optimzation node-type */
13624         const char * cur_parse= RExC_parse;
13625
13626         invlist_iterinit(cp_list);
13627         if (! invlist_iternext(cp_list, &start, &end)) {
13628
13629             /* Here, the list is empty.  This happens, for example, when a
13630              * Unicode property is the only thing in the character class, and
13631              * it doesn't match anything.  (perluniprops.pod notes such
13632              * properties) */
13633             op = OPFAIL;
13634             *flagp |= HASWIDTH|SIMPLE;
13635         }
13636         else if (start == end) {    /* The range is a single code point */
13637             if (! invlist_iternext(cp_list, &start, &end)
13638
13639                     /* Don't do this optimization if it would require changing
13640                      * the pattern to UTF-8 */
13641                 && (start < 256 || UTF))
13642             {
13643                 /* Here, the list contains a single code point.  Can optimize
13644                  * into an EXACT node */
13645
13646                 value = start;
13647
13648                 if (! FOLD) {
13649                     op = EXACT;
13650                 }
13651                 else if (LOC) {
13652
13653                     /* A locale node under folding with one code point can be
13654                      * an EXACTFL, as its fold won't be calculated until
13655                      * runtime */
13656                     op = EXACTFL;
13657                 }
13658                 else {
13659
13660                     /* Here, we are generally folding, but there is only one
13661                      * code point to match.  If we have to, we use an EXACT
13662                      * node, but it would be better for joining with adjacent
13663                      * nodes in the optimization pass if we used the same
13664                      * EXACTFish node that any such are likely to be.  We can
13665                      * do this iff the code point doesn't participate in any
13666                      * folds.  For example, an EXACTF of a colon is the same as
13667                      * an EXACT one, since nothing folds to or from a colon. */
13668                     if (value < 256) {
13669                         if (IS_IN_SOME_FOLD_L1(value)) {
13670                             op = EXACT;
13671                         }
13672                     }
13673                     else {
13674                         if (! PL_utf8_foldable) {
13675                             SV* swash = swash_init("utf8", "_Perl_Any_Folds",
13676                                                 &PL_sv_undef, 1, 0);
13677                             PL_utf8_foldable = _get_swash_invlist(swash);
13678                             SvREFCNT_dec_NN(swash);
13679                         }
13680                         if (_invlist_contains_cp(PL_utf8_foldable, value)) {
13681                             op = EXACT;
13682                         }
13683                     }
13684
13685                     /* If we haven't found the node type, above, it means we
13686                      * can use the prevailing one */
13687                     if (op == END) {
13688                         op = compute_EXACTish(pRExC_state);
13689                     }
13690                 }
13691             }
13692         }
13693         else if (start == 0) {
13694             if (end == UV_MAX) {
13695                 op = SANY;
13696                 *flagp |= HASWIDTH|SIMPLE;
13697                 RExC_naughty++;
13698             }
13699             else if (end == '\n' - 1
13700                     && invlist_iternext(cp_list, &start, &end)
13701                     && start == '\n' + 1 && end == UV_MAX)
13702             {
13703                 op = REG_ANY;
13704                 *flagp |= HASWIDTH|SIMPLE;
13705                 RExC_naughty++;
13706             }
13707         }
13708         invlist_iterfinish(cp_list);
13709
13710         if (op != END) {
13711             RExC_parse = (char *)orig_parse;
13712             RExC_emit = (regnode *)orig_emit;
13713
13714             ret = reg_node(pRExC_state, op);
13715
13716             RExC_parse = (char *)cur_parse;
13717
13718             if (PL_regkind[op] == EXACT) {
13719                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, 0, value);
13720             }
13721
13722             SvREFCNT_dec_NN(cp_list);
13723             return ret;
13724         }
13725     }
13726
13727     /* Here, <cp_list> contains all the code points we can determine at
13728      * compile time that match under all conditions.  Go through it, and
13729      * for things that belong in the bitmap, put them there, and delete from
13730      * <cp_list>.  While we are at it, see if everything above 255 is in the
13731      * list, and if so, set a flag to speed up execution */
13732     ANYOF_BITMAP_ZERO(ret);
13733     if (cp_list) {
13734
13735         /* This gets set if we actually need to modify things */
13736         bool change_invlist = FALSE;
13737
13738         UV start, end;
13739
13740         /* Start looking through <cp_list> */
13741         invlist_iterinit(cp_list);
13742         while (invlist_iternext(cp_list, &start, &end)) {
13743             UV high;
13744             int i;
13745
13746             if (end == UV_MAX && start <= 256) {
13747                 ANYOF_FLAGS(ret) |= ANYOF_UNICODE_ALL;
13748             }
13749
13750             /* Quit if are above what we should change */
13751             if (start > 255) {
13752                 break;
13753             }
13754
13755             change_invlist = TRUE;
13756
13757             /* Set all the bits in the range, up to the max that we are doing */
13758             high = (end < 255) ? end : 255;
13759             for (i = start; i <= (int) high; i++) {
13760                 if (! ANYOF_BITMAP_TEST(ret, i)) {
13761                     ANYOF_BITMAP_SET(ret, i);
13762                     prevvalue = value;
13763                     value = i;
13764                 }
13765             }
13766         }
13767         invlist_iterfinish(cp_list);
13768
13769         /* Done with loop; remove any code points that are in the bitmap from
13770          * <cp_list> */
13771         if (change_invlist) {
13772             _invlist_subtract(cp_list, PL_Latin1, &cp_list);
13773         }
13774
13775         /* If have completely emptied it, remove it completely */
13776         if (_invlist_len(cp_list) == 0) {
13777             SvREFCNT_dec_NN(cp_list);
13778             cp_list = NULL;
13779         }
13780     }
13781
13782     if (invert) {
13783         ANYOF_FLAGS(ret) |= ANYOF_INVERT;
13784     }
13785
13786     /* Here, the bitmap has been populated with all the Latin1 code points that
13787      * always match.  Can now add to the overall list those that match only
13788      * when the target string is UTF-8 (<depends_list>). */
13789     if (depends_list) {
13790         if (cp_list) {
13791             _invlist_union(cp_list, depends_list, &cp_list);
13792             SvREFCNT_dec_NN(depends_list);
13793         }
13794         else {
13795             cp_list = depends_list;
13796         }
13797     }
13798
13799     /* If there is a swash and more than one element, we can't use the swash in
13800      * the optimization below. */
13801     if (swash && element_count > 1) {
13802         SvREFCNT_dec_NN(swash);
13803         swash = NULL;
13804     }
13805
13806     if (! cp_list
13807         && ! HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
13808     {
13809         ARG_SET(ret, ANYOF_NONBITMAP_EMPTY);
13810     }
13811     else {
13812         /* av[0] stores the character class description in its textual form:
13813          *       used later (regexec.c:Perl_regclass_swash()) to initialize the
13814          *       appropriate swash, and is also useful for dumping the regnode.
13815          * av[1] if NULL, is a placeholder to later contain the swash computed
13816          *       from av[0].  But if no further computation need be done, the
13817          *       swash is stored there now.
13818          * av[2] stores the cp_list inversion list for use in addition or
13819          *       instead of av[0]; used only if av[1] is NULL
13820          * av[3] is set if any component of the class is from a user-defined
13821          *       property; used only if av[1] is NULL */
13822         AV * const av = newAV();
13823         SV *rv;
13824
13825         av_store(av, 0, (HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
13826                         ? SvREFCNT_inc(listsv) : &PL_sv_undef);
13827         if (swash) {
13828             av_store(av, 1, swash);
13829             SvREFCNT_dec_NN(cp_list);
13830         }
13831         else {
13832             av_store(av, 1, NULL);
13833             if (cp_list) {
13834                 av_store(av, 2, cp_list);
13835                 av_store(av, 3, newSVuv(has_user_defined_property));
13836             }
13837         }
13838
13839         rv = newRV_noinc(MUTABLE_SV(av));
13840         n = add_data(pRExC_state, 1, "s");
13841         RExC_rxi->data->data[n] = (void*)rv;
13842         ARG_SET(ret, n);
13843     }
13844
13845     *flagp |= HASWIDTH|SIMPLE;
13846     return ret;
13847 }
13848 #undef HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION
13849
13850
13851 /* reg_skipcomment()
13852
13853    Absorbs an /x style # comments from the input stream.
13854    Returns true if there is more text remaining in the stream.
13855    Will set the REG_SEEN_RUN_ON_COMMENT flag if the comment
13856    terminates the pattern without including a newline.
13857
13858    Note its the callers responsibility to ensure that we are
13859    actually in /x mode
13860
13861 */
13862
13863 STATIC bool
13864 S_reg_skipcomment(pTHX_ RExC_state_t *pRExC_state)
13865 {
13866     bool ended = 0;
13867
13868     PERL_ARGS_ASSERT_REG_SKIPCOMMENT;
13869
13870     while (RExC_parse < RExC_end)
13871         if (*RExC_parse++ == '\n') {
13872             ended = 1;
13873             break;
13874         }
13875     if (!ended) {
13876         /* we ran off the end of the pattern without ending
13877            the comment, so we have to add an \n when wrapping */
13878         RExC_seen |= REG_SEEN_RUN_ON_COMMENT;
13879         return 0;
13880     } else
13881         return 1;
13882 }
13883
13884 /* nextchar()
13885
13886    Advances the parse position, and optionally absorbs
13887    "whitespace" from the inputstream.
13888
13889    Without /x "whitespace" means (?#...) style comments only,
13890    with /x this means (?#...) and # comments and whitespace proper.
13891
13892    Returns the RExC_parse point from BEFORE the scan occurs.
13893
13894    This is the /x friendly way of saying RExC_parse++.
13895 */
13896
13897 STATIC char*
13898 S_nextchar(pTHX_ RExC_state_t *pRExC_state)
13899 {
13900     char* const retval = RExC_parse++;
13901
13902     PERL_ARGS_ASSERT_NEXTCHAR;
13903
13904     for (;;) {
13905         if (RExC_end - RExC_parse >= 3
13906             && *RExC_parse == '('
13907             && RExC_parse[1] == '?'
13908             && RExC_parse[2] == '#')
13909         {
13910             while (*RExC_parse != ')') {
13911                 if (RExC_parse == RExC_end)
13912                     FAIL("Sequence (?#... not terminated");
13913                 RExC_parse++;
13914             }
13915             RExC_parse++;
13916             continue;
13917         }
13918         if (RExC_flags & RXf_PMf_EXTENDED) {
13919             if (isSPACE(*RExC_parse)) {
13920                 RExC_parse++;
13921                 continue;
13922             }
13923             else if (*RExC_parse == '#') {
13924                 if ( reg_skipcomment( pRExC_state ) )
13925                     continue;
13926             }
13927         }
13928         return retval;
13929     }
13930 }
13931
13932 /*
13933 - reg_node - emit a node
13934 */
13935 STATIC regnode *                        /* Location. */
13936 S_reg_node(pTHX_ RExC_state_t *pRExC_state, U8 op)
13937 {
13938     dVAR;
13939     regnode *ptr;
13940     regnode * const ret = RExC_emit;
13941     GET_RE_DEBUG_FLAGS_DECL;
13942
13943     PERL_ARGS_ASSERT_REG_NODE;
13944
13945     if (SIZE_ONLY) {
13946         SIZE_ALIGN(RExC_size);
13947         RExC_size += 1;
13948         return(ret);
13949     }
13950     if (RExC_emit >= RExC_emit_bound)
13951         Perl_croak(aTHX_ "panic: reg_node overrun trying to emit %d, %p>=%p",
13952                    op, RExC_emit, RExC_emit_bound);
13953
13954     NODE_ALIGN_FILL(ret);
13955     ptr = ret;
13956     FILL_ADVANCE_NODE(ptr, op);
13957     REH_CALL_COMP_NODE_HOOK(pRExC_state->rx, (ptr) - 1);
13958 #ifdef RE_TRACK_PATTERN_OFFSETS
13959     if (RExC_offsets) {         /* MJD */
13960         MJD_OFFSET_DEBUG(("%s:%d: (op %s) %s %"UVuf" (len %"UVuf") (max %"UVuf").\n", 
13961               "reg_node", __LINE__, 
13962               PL_reg_name[op],
13963               (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0] 
13964                 ? "Overwriting end of array!\n" : "OK",
13965               (UV)(RExC_emit - RExC_emit_start),
13966               (UV)(RExC_parse - RExC_start),
13967               (UV)RExC_offsets[0])); 
13968         Set_Node_Offset(RExC_emit, RExC_parse + (op == END));
13969     }
13970 #endif
13971     RExC_emit = ptr;
13972     return(ret);
13973 }
13974
13975 /*
13976 - reganode - emit a node with an argument
13977 */
13978 STATIC regnode *                        /* Location. */
13979 S_reganode(pTHX_ RExC_state_t *pRExC_state, U8 op, U32 arg)
13980 {
13981     dVAR;
13982     regnode *ptr;
13983     regnode * const ret = RExC_emit;
13984     GET_RE_DEBUG_FLAGS_DECL;
13985
13986     PERL_ARGS_ASSERT_REGANODE;
13987
13988     if (SIZE_ONLY) {
13989         SIZE_ALIGN(RExC_size);
13990         RExC_size += 2;
13991         /* 
13992            We can't do this:
13993            
13994            assert(2==regarglen[op]+1); 
13995
13996            Anything larger than this has to allocate the extra amount.
13997            If we changed this to be:
13998            
13999            RExC_size += (1 + regarglen[op]);
14000            
14001            then it wouldn't matter. Its not clear what side effect
14002            might come from that so its not done so far.
14003            -- dmq
14004         */
14005         return(ret);
14006     }
14007     if (RExC_emit >= RExC_emit_bound)
14008         Perl_croak(aTHX_ "panic: reg_node overrun trying to emit %d, %p>=%p",
14009                    op, RExC_emit, RExC_emit_bound);
14010
14011     NODE_ALIGN_FILL(ret);
14012     ptr = ret;
14013     FILL_ADVANCE_NODE_ARG(ptr, op, arg);
14014     REH_CALL_COMP_NODE_HOOK(pRExC_state->rx, (ptr) - 2);
14015 #ifdef RE_TRACK_PATTERN_OFFSETS
14016     if (RExC_offsets) {         /* MJD */
14017         MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s %"UVuf" <- %"UVuf" (max %"UVuf").\n", 
14018               "reganode",
14019               __LINE__,
14020               PL_reg_name[op],
14021               (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0] ? 
14022               "Overwriting end of array!\n" : "OK",
14023               (UV)(RExC_emit - RExC_emit_start),
14024               (UV)(RExC_parse - RExC_start),
14025               (UV)RExC_offsets[0])); 
14026         Set_Cur_Node_Offset;
14027     }
14028 #endif            
14029     RExC_emit = ptr;
14030     return(ret);
14031 }
14032
14033 /*
14034 - reguni - emit (if appropriate) a Unicode character
14035 */
14036 STATIC STRLEN
14037 S_reguni(pTHX_ const RExC_state_t *pRExC_state, UV uv, char* s)
14038 {
14039     dVAR;
14040
14041     PERL_ARGS_ASSERT_REGUNI;
14042
14043     return SIZE_ONLY ? UNISKIP(uv) : (uvchr_to_utf8((U8*)s, uv) - (U8*)s);
14044 }
14045
14046 /*
14047 - reginsert - insert an operator in front of already-emitted operand
14048 *
14049 * Means relocating the operand.
14050 */
14051 STATIC void
14052 S_reginsert(pTHX_ RExC_state_t *pRExC_state, U8 op, regnode *opnd, U32 depth)
14053 {
14054     dVAR;
14055     regnode *src;
14056     regnode *dst;
14057     regnode *place;
14058     const int offset = regarglen[(U8)op];
14059     const int size = NODE_STEP_REGNODE + offset;
14060     GET_RE_DEBUG_FLAGS_DECL;
14061
14062     PERL_ARGS_ASSERT_REGINSERT;
14063     PERL_UNUSED_ARG(depth);
14064 /* (PL_regkind[(U8)op] == CURLY ? EXTRA_STEP_2ARGS : 0); */
14065     DEBUG_PARSE_FMT("inst"," - %s",PL_reg_name[op]);
14066     if (SIZE_ONLY) {
14067         RExC_size += size;
14068         return;
14069     }
14070
14071     src = RExC_emit;
14072     RExC_emit += size;
14073     dst = RExC_emit;
14074     if (RExC_open_parens) {
14075         int paren;
14076         /*DEBUG_PARSE_FMT("inst"," - %"IVdf, (IV)RExC_npar);*/
14077         for ( paren=0 ; paren < RExC_npar ; paren++ ) {
14078             if ( RExC_open_parens[paren] >= opnd ) {
14079                 /*DEBUG_PARSE_FMT("open"," - %d",size);*/
14080                 RExC_open_parens[paren] += size;
14081             } else {
14082                 /*DEBUG_PARSE_FMT("open"," - %s","ok");*/
14083             }
14084             if ( RExC_close_parens[paren] >= opnd ) {
14085                 /*DEBUG_PARSE_FMT("close"," - %d",size);*/
14086                 RExC_close_parens[paren] += size;
14087             } else {
14088                 /*DEBUG_PARSE_FMT("close"," - %s","ok");*/
14089             }
14090         }
14091     }
14092
14093     while (src > opnd) {
14094         StructCopy(--src, --dst, regnode);
14095 #ifdef RE_TRACK_PATTERN_OFFSETS
14096         if (RExC_offsets) {     /* MJD 20010112 */
14097             MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s copy %"UVuf" -> %"UVuf" (max %"UVuf").\n",
14098                   "reg_insert",
14099                   __LINE__,
14100                   PL_reg_name[op],
14101                   (UV)(dst - RExC_emit_start) > RExC_offsets[0] 
14102                     ? "Overwriting end of array!\n" : "OK",
14103                   (UV)(src - RExC_emit_start),
14104                   (UV)(dst - RExC_emit_start),
14105                   (UV)RExC_offsets[0])); 
14106             Set_Node_Offset_To_R(dst-RExC_emit_start, Node_Offset(src));
14107             Set_Node_Length_To_R(dst-RExC_emit_start, Node_Length(src));
14108         }
14109 #endif
14110     }
14111     
14112
14113     place = opnd;               /* Op node, where operand used to be. */
14114 #ifdef RE_TRACK_PATTERN_OFFSETS
14115     if (RExC_offsets) {         /* MJD */
14116         MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s %"UVuf" <- %"UVuf" (max %"UVuf").\n", 
14117               "reginsert",
14118               __LINE__,
14119               PL_reg_name[op],
14120               (UV)(place - RExC_emit_start) > RExC_offsets[0] 
14121               ? "Overwriting end of array!\n" : "OK",
14122               (UV)(place - RExC_emit_start),
14123               (UV)(RExC_parse - RExC_start),
14124               (UV)RExC_offsets[0]));
14125         Set_Node_Offset(place, RExC_parse);
14126         Set_Node_Length(place, 1);
14127     }
14128 #endif    
14129     src = NEXTOPER(place);
14130     FILL_ADVANCE_NODE(place, op);
14131     REH_CALL_COMP_NODE_HOOK(pRExC_state->rx, (place) - 1);
14132     Zero(src, offset, regnode);
14133 }
14134
14135 /*
14136 - regtail - set the next-pointer at the end of a node chain of p to val.
14137 - SEE ALSO: regtail_study
14138 */
14139 /* TODO: All three parms should be const */
14140 STATIC void
14141 S_regtail(pTHX_ RExC_state_t *pRExC_state, regnode *p, const regnode *val,U32 depth)
14142 {
14143     dVAR;
14144     regnode *scan;
14145     GET_RE_DEBUG_FLAGS_DECL;
14146
14147     PERL_ARGS_ASSERT_REGTAIL;
14148 #ifndef DEBUGGING
14149     PERL_UNUSED_ARG(depth);
14150 #endif
14151
14152     if (SIZE_ONLY)
14153         return;
14154
14155     /* Find last node. */
14156     scan = p;
14157     for (;;) {
14158         regnode * const temp = regnext(scan);
14159         DEBUG_PARSE_r({
14160             SV * const mysv=sv_newmortal();
14161             DEBUG_PARSE_MSG((scan==p ? "tail" : ""));
14162             regprop(RExC_rx, mysv, scan);
14163             PerlIO_printf(Perl_debug_log, "~ %s (%d) %s %s\n",
14164                 SvPV_nolen_const(mysv), REG_NODE_NUM(scan),
14165                     (temp == NULL ? "->" : ""),
14166                     (temp == NULL ? PL_reg_name[OP(val)] : "")
14167             );
14168         });
14169         if (temp == NULL)
14170             break;
14171         scan = temp;
14172     }
14173
14174     if (reg_off_by_arg[OP(scan)]) {
14175         ARG_SET(scan, val - scan);
14176     }
14177     else {
14178         NEXT_OFF(scan) = val - scan;
14179     }
14180 }
14181
14182 #ifdef DEBUGGING
14183 /*
14184 - regtail_study - set the next-pointer at the end of a node chain of p to val.
14185 - Look for optimizable sequences at the same time.
14186 - currently only looks for EXACT chains.
14187
14188 This is experimental code. The idea is to use this routine to perform 
14189 in place optimizations on branches and groups as they are constructed,
14190 with the long term intention of removing optimization from study_chunk so
14191 that it is purely analytical.
14192
14193 Currently only used when in DEBUG mode. The macro REGTAIL_STUDY() is used
14194 to control which is which.
14195
14196 */
14197 /* TODO: All four parms should be const */
14198
14199 STATIC U8
14200 S_regtail_study(pTHX_ RExC_state_t *pRExC_state, regnode *p, const regnode *val,U32 depth)
14201 {
14202     dVAR;
14203     regnode *scan;
14204     U8 exact = PSEUDO;
14205 #ifdef EXPERIMENTAL_INPLACESCAN
14206     I32 min = 0;
14207 #endif
14208     GET_RE_DEBUG_FLAGS_DECL;
14209
14210     PERL_ARGS_ASSERT_REGTAIL_STUDY;
14211
14212
14213     if (SIZE_ONLY)
14214         return exact;
14215
14216     /* Find last node. */
14217
14218     scan = p;
14219     for (;;) {
14220         regnode * const temp = regnext(scan);
14221 #ifdef EXPERIMENTAL_INPLACESCAN
14222         if (PL_regkind[OP(scan)] == EXACT) {
14223             bool has_exactf_sharp_s;    /* Unexamined in this routine */
14224             if (join_exact(pRExC_state,scan,&min, &has_exactf_sharp_s, 1,val,depth+1))
14225                 return EXACT;
14226         }
14227 #endif
14228         if ( exact ) {
14229             switch (OP(scan)) {
14230                 case EXACT:
14231                 case EXACTF:
14232                 case EXACTFA:
14233                 case EXACTFU:
14234                 case EXACTFU_SS:
14235                 case EXACTFU_TRICKYFOLD:
14236                 case EXACTFL:
14237                         if( exact == PSEUDO )
14238                             exact= OP(scan);
14239                         else if ( exact != OP(scan) )
14240                             exact= 0;
14241                 case NOTHING:
14242                     break;
14243                 default:
14244                     exact= 0;
14245             }
14246         }
14247         DEBUG_PARSE_r({
14248             SV * const mysv=sv_newmortal();
14249             DEBUG_PARSE_MSG((scan==p ? "tsdy" : ""));
14250             regprop(RExC_rx, mysv, scan);
14251             PerlIO_printf(Perl_debug_log, "~ %s (%d) -> %s\n",
14252                 SvPV_nolen_const(mysv),
14253                 REG_NODE_NUM(scan),
14254                 PL_reg_name[exact]);
14255         });
14256         if (temp == NULL)
14257             break;
14258         scan = temp;
14259     }
14260     DEBUG_PARSE_r({
14261         SV * const mysv_val=sv_newmortal();
14262         DEBUG_PARSE_MSG("");
14263         regprop(RExC_rx, mysv_val, val);
14264         PerlIO_printf(Perl_debug_log, "~ attach to %s (%"IVdf") offset to %"IVdf"\n",
14265                       SvPV_nolen_const(mysv_val),
14266                       (IV)REG_NODE_NUM(val),
14267                       (IV)(val - scan)
14268         );
14269     });
14270     if (reg_off_by_arg[OP(scan)]) {
14271         ARG_SET(scan, val - scan);
14272     }
14273     else {
14274         NEXT_OFF(scan) = val - scan;
14275     }
14276
14277     return exact;
14278 }
14279 #endif
14280
14281 /*
14282  - regdump - dump a regexp onto Perl_debug_log in vaguely comprehensible form
14283  */
14284 #ifdef DEBUGGING
14285 static void 
14286 S_regdump_extflags(pTHX_ const char *lead, const U32 flags)
14287 {
14288     int bit;
14289     int set=0;
14290     regex_charset cs;
14291
14292     for (bit=0; bit<32; bit++) {
14293         if (flags & (1<<bit)) {
14294             if ((1<<bit) & RXf_PMf_CHARSET) {   /* Output separately, below */
14295                 continue;
14296             }
14297             if (!set++ && lead) 
14298                 PerlIO_printf(Perl_debug_log, "%s",lead);
14299             PerlIO_printf(Perl_debug_log, "%s ",PL_reg_extflags_name[bit]);
14300         }               
14301     }      
14302     if ((cs = get_regex_charset(flags)) != REGEX_DEPENDS_CHARSET) {
14303             if (!set++ && lead) {
14304                 PerlIO_printf(Perl_debug_log, "%s",lead);
14305             }
14306             switch (cs) {
14307                 case REGEX_UNICODE_CHARSET:
14308                     PerlIO_printf(Perl_debug_log, "UNICODE");
14309                     break;
14310                 case REGEX_LOCALE_CHARSET:
14311                     PerlIO_printf(Perl_debug_log, "LOCALE");
14312                     break;
14313                 case REGEX_ASCII_RESTRICTED_CHARSET:
14314                     PerlIO_printf(Perl_debug_log, "ASCII-RESTRICTED");
14315                     break;
14316                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
14317                     PerlIO_printf(Perl_debug_log, "ASCII-MORE_RESTRICTED");
14318                     break;
14319                 default:
14320                     PerlIO_printf(Perl_debug_log, "UNKNOWN CHARACTER SET");
14321                     break;
14322             }
14323     }
14324     if (lead)  {
14325         if (set) 
14326             PerlIO_printf(Perl_debug_log, "\n");
14327         else 
14328             PerlIO_printf(Perl_debug_log, "%s[none-set]\n",lead);
14329     }            
14330 }   
14331 #endif
14332
14333 void
14334 Perl_regdump(pTHX_ const regexp *r)
14335 {
14336 #ifdef DEBUGGING
14337     dVAR;
14338     SV * const sv = sv_newmortal();
14339     SV *dsv= sv_newmortal();
14340     RXi_GET_DECL(r,ri);
14341     GET_RE_DEBUG_FLAGS_DECL;
14342
14343     PERL_ARGS_ASSERT_REGDUMP;
14344
14345     (void)dumpuntil(r, ri->program, ri->program + 1, NULL, NULL, sv, 0, 0);
14346
14347     /* Header fields of interest. */
14348     if (r->anchored_substr) {
14349         RE_PV_QUOTED_DECL(s, 0, dsv, SvPVX_const(r->anchored_substr), 
14350             RE_SV_DUMPLEN(r->anchored_substr), 30);
14351         PerlIO_printf(Perl_debug_log,
14352                       "anchored %s%s at %"IVdf" ",
14353                       s, RE_SV_TAIL(r->anchored_substr),
14354                       (IV)r->anchored_offset);
14355     } else if (r->anchored_utf8) {
14356         RE_PV_QUOTED_DECL(s, 1, dsv, SvPVX_const(r->anchored_utf8), 
14357             RE_SV_DUMPLEN(r->anchored_utf8), 30);
14358         PerlIO_printf(Perl_debug_log,
14359                       "anchored utf8 %s%s at %"IVdf" ",
14360                       s, RE_SV_TAIL(r->anchored_utf8),
14361                       (IV)r->anchored_offset);
14362     }                 
14363     if (r->float_substr) {
14364         RE_PV_QUOTED_DECL(s, 0, dsv, SvPVX_const(r->float_substr), 
14365             RE_SV_DUMPLEN(r->float_substr), 30);
14366         PerlIO_printf(Perl_debug_log,
14367                       "floating %s%s at %"IVdf"..%"UVuf" ",
14368                       s, RE_SV_TAIL(r->float_substr),
14369                       (IV)r->float_min_offset, (UV)r->float_max_offset);
14370     } else if (r->float_utf8) {
14371         RE_PV_QUOTED_DECL(s, 1, dsv, SvPVX_const(r->float_utf8), 
14372             RE_SV_DUMPLEN(r->float_utf8), 30);
14373         PerlIO_printf(Perl_debug_log,
14374                       "floating utf8 %s%s at %"IVdf"..%"UVuf" ",
14375                       s, RE_SV_TAIL(r->float_utf8),
14376                       (IV)r->float_min_offset, (UV)r->float_max_offset);
14377     }
14378     if (r->check_substr || r->check_utf8)
14379         PerlIO_printf(Perl_debug_log,
14380                       (const char *)
14381                       (r->check_substr == r->float_substr
14382                        && r->check_utf8 == r->float_utf8
14383                        ? "(checking floating" : "(checking anchored"));
14384     if (r->extflags & RXf_NOSCAN)
14385         PerlIO_printf(Perl_debug_log, " noscan");
14386     if (r->extflags & RXf_CHECK_ALL)
14387         PerlIO_printf(Perl_debug_log, " isall");
14388     if (r->check_substr || r->check_utf8)
14389         PerlIO_printf(Perl_debug_log, ") ");
14390
14391     if (ri->regstclass) {
14392         regprop(r, sv, ri->regstclass);
14393         PerlIO_printf(Perl_debug_log, "stclass %s ", SvPVX_const(sv));
14394     }
14395     if (r->extflags & RXf_ANCH) {
14396         PerlIO_printf(Perl_debug_log, "anchored");
14397         if (r->extflags & RXf_ANCH_BOL)
14398             PerlIO_printf(Perl_debug_log, "(BOL)");
14399         if (r->extflags & RXf_ANCH_MBOL)
14400             PerlIO_printf(Perl_debug_log, "(MBOL)");
14401         if (r->extflags & RXf_ANCH_SBOL)
14402             PerlIO_printf(Perl_debug_log, "(SBOL)");
14403         if (r->extflags & RXf_ANCH_GPOS)
14404             PerlIO_printf(Perl_debug_log, "(GPOS)");
14405         PerlIO_putc(Perl_debug_log, ' ');
14406     }
14407     if (r->extflags & RXf_GPOS_SEEN)
14408         PerlIO_printf(Perl_debug_log, "GPOS:%"UVuf" ", (UV)r->gofs);
14409     if (r->intflags & PREGf_SKIP)
14410         PerlIO_printf(Perl_debug_log, "plus ");
14411     if (r->intflags & PREGf_IMPLICIT)
14412         PerlIO_printf(Perl_debug_log, "implicit ");
14413     PerlIO_printf(Perl_debug_log, "minlen %"IVdf" ", (IV)r->minlen);
14414     if (r->extflags & RXf_EVAL_SEEN)
14415         PerlIO_printf(Perl_debug_log, "with eval ");
14416     PerlIO_printf(Perl_debug_log, "\n");
14417     DEBUG_FLAGS_r(regdump_extflags("r->extflags: ",r->extflags));            
14418 #else
14419     PERL_ARGS_ASSERT_REGDUMP;
14420     PERL_UNUSED_CONTEXT;
14421     PERL_UNUSED_ARG(r);
14422 #endif  /* DEBUGGING */
14423 }
14424
14425 /*
14426 - regprop - printable representation of opcode
14427 */
14428 #define EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags) \
14429 STMT_START { \
14430         if (do_sep) {                           \
14431             Perl_sv_catpvf(aTHX_ sv,"%s][%s",PL_colors[1],PL_colors[0]); \
14432             if (flags & ANYOF_INVERT)           \
14433                 /*make sure the invert info is in each */ \
14434                 sv_catpvs(sv, "^");             \
14435             do_sep = 0;                         \
14436         }                                       \
14437 } STMT_END
14438
14439 void
14440 Perl_regprop(pTHX_ const regexp *prog, SV *sv, const regnode *o)
14441 {
14442 #ifdef DEBUGGING
14443     dVAR;
14444     int k;
14445
14446     /* Should be synchronized with * ANYOF_ #xdefines in regcomp.h */
14447     static const char * const anyofs[] = {
14448 #if _CC_WORDCHAR != 0 || _CC_DIGIT != 1 || _CC_ALPHA != 2 || _CC_LOWER != 3 \
14449     || _CC_UPPER != 4 || _CC_PUNCT != 5 || _CC_PRINT != 6                   \
14450     || _CC_ALPHANUMERIC != 7 || _CC_GRAPH != 8 || _CC_CASED != 9            \
14451     || _CC_SPACE != 10 || _CC_BLANK != 11 || _CC_XDIGIT != 12               \
14452     || _CC_PSXSPC != 13 || _CC_CNTRL != 14 || _CC_ASCII != 15               \
14453     || _CC_VERTSPACE != 16
14454   #error Need to adjust order of anyofs[]
14455 #endif
14456         "[\\w]",
14457         "[\\W]",
14458         "[\\d]",
14459         "[\\D]",
14460         "[:alpha:]",
14461         "[:^alpha:]",
14462         "[:lower:]",
14463         "[:^lower:]",
14464         "[:upper:]",
14465         "[:^upper:]",
14466         "[:punct:]",
14467         "[:^punct:]",
14468         "[:print:]",
14469         "[:^print:]",
14470         "[:alnum:]",
14471         "[:^alnum:]",
14472         "[:graph:]",
14473         "[:^graph:]",
14474         "[:cased:]",
14475         "[:^cased:]",
14476         "[\\s]",
14477         "[\\S]",
14478         "[:blank:]",
14479         "[:^blank:]",
14480         "[:xdigit:]",
14481         "[:^xdigit:]",
14482         "[:space:]",
14483         "[:^space:]",
14484         "[:cntrl:]",
14485         "[:^cntrl:]",
14486         "[:ascii:]",
14487         "[:^ascii:]",
14488         "[\\v]",
14489         "[\\V]"
14490     };
14491     RXi_GET_DECL(prog,progi);
14492     GET_RE_DEBUG_FLAGS_DECL;
14493     
14494     PERL_ARGS_ASSERT_REGPROP;
14495
14496     sv_setpvs(sv, "");
14497
14498     if (OP(o) > REGNODE_MAX)            /* regnode.type is unsigned */
14499         /* It would be nice to FAIL() here, but this may be called from
14500            regexec.c, and it would be hard to supply pRExC_state. */
14501         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d", (int)OP(o), (int)REGNODE_MAX);
14502     sv_catpv(sv, PL_reg_name[OP(o)]); /* Take off const! */
14503
14504     k = PL_regkind[OP(o)];
14505
14506     if (k == EXACT) {
14507         sv_catpvs(sv, " ");
14508         /* Using is_utf8_string() (via PERL_PV_UNI_DETECT) 
14509          * is a crude hack but it may be the best for now since 
14510          * we have no flag "this EXACTish node was UTF-8" 
14511          * --jhi */
14512         pv_pretty(sv, STRING(o), STR_LEN(o), 60, PL_colors[0], PL_colors[1],
14513                   PERL_PV_ESCAPE_UNI_DETECT |
14514                   PERL_PV_ESCAPE_NONASCII   |
14515                   PERL_PV_PRETTY_ELLIPSES   |
14516                   PERL_PV_PRETTY_LTGT       |
14517                   PERL_PV_PRETTY_NOCLEAR
14518                   );
14519     } else if (k == TRIE) {
14520         /* print the details of the trie in dumpuntil instead, as
14521          * progi->data isn't available here */
14522         const char op = OP(o);
14523         const U32 n = ARG(o);
14524         const reg_ac_data * const ac = IS_TRIE_AC(op) ?
14525                (reg_ac_data *)progi->data->data[n] :
14526                NULL;
14527         const reg_trie_data * const trie
14528             = (reg_trie_data*)progi->data->data[!IS_TRIE_AC(op) ? n : ac->trie];
14529         
14530         Perl_sv_catpvf(aTHX_ sv, "-%s",PL_reg_name[o->flags]);
14531         DEBUG_TRIE_COMPILE_r(
14532             Perl_sv_catpvf(aTHX_ sv,
14533                 "<S:%"UVuf"/%"IVdf" W:%"UVuf" L:%"UVuf"/%"UVuf" C:%"UVuf"/%"UVuf">",
14534                 (UV)trie->startstate,
14535                 (IV)trie->statecount-1, /* -1 because of the unused 0 element */
14536                 (UV)trie->wordcount,
14537                 (UV)trie->minlen,
14538                 (UV)trie->maxlen,
14539                 (UV)TRIE_CHARCOUNT(trie),
14540                 (UV)trie->uniquecharcount
14541             )
14542         );
14543         if ( IS_ANYOF_TRIE(op) || trie->bitmap ) {
14544             int i;
14545             int rangestart = -1;
14546             U8* bitmap = IS_ANYOF_TRIE(op) ? (U8*)ANYOF_BITMAP(o) : (U8*)TRIE_BITMAP(trie);
14547             sv_catpvs(sv, "[");
14548             for (i = 0; i <= 256; i++) {
14549                 if (i < 256 && BITMAP_TEST(bitmap,i)) {
14550                     if (rangestart == -1)
14551                         rangestart = i;
14552                 } else if (rangestart != -1) {
14553                     if (i <= rangestart + 3)
14554                         for (; rangestart < i; rangestart++)
14555                             put_byte(sv, rangestart);
14556                     else {
14557                         put_byte(sv, rangestart);
14558                         sv_catpvs(sv, "-");
14559                         put_byte(sv, i - 1);
14560                     }
14561                     rangestart = -1;
14562                 }
14563             }
14564             sv_catpvs(sv, "]");
14565         } 
14566          
14567     } else if (k == CURLY) {
14568         if (OP(o) == CURLYM || OP(o) == CURLYN || OP(o) == CURLYX)
14569             Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags); /* Parenth number */
14570         Perl_sv_catpvf(aTHX_ sv, " {%d,%d}", ARG1(o), ARG2(o));
14571     }
14572     else if (k == WHILEM && o->flags)                   /* Ordinal/of */
14573         Perl_sv_catpvf(aTHX_ sv, "[%d/%d]", o->flags & 0xf, o->flags>>4);
14574     else if (k == REF || k == OPEN || k == CLOSE || k == GROUPP || OP(o)==ACCEPT) {
14575         Perl_sv_catpvf(aTHX_ sv, "%d", (int)ARG(o));    /* Parenth number */
14576         if ( RXp_PAREN_NAMES(prog) ) {
14577             if ( k != REF || (OP(o) < NREF)) {
14578                 AV *list= MUTABLE_AV(progi->data->data[progi->name_list_idx]);
14579                 SV **name= av_fetch(list, ARG(o), 0 );
14580                 if (name)
14581                     Perl_sv_catpvf(aTHX_ sv, " '%"SVf"'", SVfARG(*name));
14582             }       
14583             else {
14584                 AV *list= MUTABLE_AV(progi->data->data[ progi->name_list_idx ]);
14585                 SV *sv_dat= MUTABLE_SV(progi->data->data[ ARG( o ) ]);
14586                 I32 *nums=(I32*)SvPVX(sv_dat);
14587                 SV **name= av_fetch(list, nums[0], 0 );
14588                 I32 n;
14589                 if (name) {
14590                     for ( n=0; n<SvIVX(sv_dat); n++ ) {
14591                         Perl_sv_catpvf(aTHX_ sv, "%s%"IVdf,
14592                                     (n ? "," : ""), (IV)nums[n]);
14593                     }
14594                     Perl_sv_catpvf(aTHX_ sv, " '%"SVf"'", SVfARG(*name));
14595                 }
14596             }
14597         }            
14598     } else if (k == GOSUB) 
14599         Perl_sv_catpvf(aTHX_ sv, "%d[%+d]", (int)ARG(o),(int)ARG2L(o)); /* Paren and offset */
14600     else if (k == VERB) {
14601         if (!o->flags) 
14602             Perl_sv_catpvf(aTHX_ sv, ":%"SVf, 
14603                            SVfARG((MUTABLE_SV(progi->data->data[ ARG( o ) ]))));
14604     } else if (k == LOGICAL)
14605         Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags);     /* 2: embedded, otherwise 1 */
14606     else if (k == ANYOF) {
14607         int i, rangestart = -1;
14608         const U8 flags = ANYOF_FLAGS(o);
14609         int do_sep = 0;
14610
14611
14612         if (flags & ANYOF_LOCALE)
14613             sv_catpvs(sv, "{loc}");
14614         if (flags & ANYOF_LOC_FOLD)
14615             sv_catpvs(sv, "{i}");
14616         Perl_sv_catpvf(aTHX_ sv, "[%s", PL_colors[0]);
14617         if (flags & ANYOF_INVERT)
14618             sv_catpvs(sv, "^");
14619
14620         /* output what the standard cp 0-255 bitmap matches */
14621         for (i = 0; i <= 256; i++) {
14622             if (i < 256 && ANYOF_BITMAP_TEST(o,i)) {
14623                 if (rangestart == -1)
14624                     rangestart = i;
14625             } else if (rangestart != -1) {
14626                 if (i <= rangestart + 3)
14627                     for (; rangestart < i; rangestart++)
14628                         put_byte(sv, rangestart);
14629                 else {
14630                     put_byte(sv, rangestart);
14631                     sv_catpvs(sv, "-");
14632                     put_byte(sv, i - 1);
14633                 }
14634                 do_sep = 1;
14635                 rangestart = -1;
14636             }
14637         }
14638         
14639         EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags);
14640         /* output any special charclass tests (used entirely under use locale) */
14641         if (ANYOF_CLASS_TEST_ANY_SET(o))
14642             for (i = 0; i < (int)(sizeof(anyofs)/sizeof(char*)); i++)
14643                 if (ANYOF_CLASS_TEST(o,i)) {
14644                     sv_catpv(sv, anyofs[i]);
14645                     do_sep = 1;
14646                 }
14647         
14648         EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags);
14649         
14650         if (flags & ANYOF_NON_UTF8_LATIN1_ALL) {
14651             sv_catpvs(sv, "{non-utf8-latin1-all}");
14652         }
14653
14654         /* output information about the unicode matching */
14655         if (flags & ANYOF_UNICODE_ALL)
14656             sv_catpvs(sv, "{unicode_all}");
14657         else if (ANYOF_NONBITMAP(o))
14658             sv_catpvs(sv, "{unicode}");
14659         if (flags & ANYOF_NONBITMAP_NON_UTF8)
14660             sv_catpvs(sv, "{outside bitmap}");
14661
14662         if (ANYOF_NONBITMAP(o)) {
14663             SV *lv; /* Set if there is something outside the bit map */
14664             SV * const sw = regclass_swash(prog, o, FALSE, &lv, NULL);
14665             bool byte_output = FALSE;   /* If something in the bitmap has been
14666                                            output */
14667
14668             if (lv && lv != &PL_sv_undef) {
14669                 if (sw) {
14670                     U8 s[UTF8_MAXBYTES_CASE+1];
14671
14672                     for (i = 0; i <= 256; i++) { /* Look at chars in bitmap */
14673                         uvchr_to_utf8(s, i);
14674
14675                         if (i < 256
14676                             && ! ANYOF_BITMAP_TEST(o, i)    /* Don't duplicate
14677                                                                things already
14678                                                                output as part
14679                                                                of the bitmap */
14680                             && swash_fetch(sw, s, TRUE))
14681                         {
14682                             if (rangestart == -1)
14683                                 rangestart = i;
14684                         } else if (rangestart != -1) {
14685                             byte_output = TRUE;
14686                             if (i <= rangestart + 3)
14687                                 for (; rangestart < i; rangestart++) {
14688                                     put_byte(sv, rangestart);
14689                                 }
14690                             else {
14691                                 put_byte(sv, rangestart);
14692                                 sv_catpvs(sv, "-");
14693                                 put_byte(sv, i-1);
14694                             }
14695                             rangestart = -1;
14696                         }
14697                     }
14698                 }
14699
14700                 {
14701                     char *s = savesvpv(lv);
14702                     char * const origs = s;
14703
14704                     while (*s && *s != '\n')
14705                         s++;
14706
14707                     if (*s == '\n') {
14708                         const char * const t = ++s;
14709
14710                         if (byte_output) {
14711                             sv_catpvs(sv, " ");
14712                         }
14713
14714                         while (*s) {
14715                             if (*s == '\n') {
14716
14717                                 /* Truncate very long output */
14718                                 if (s - origs > 256) {
14719                                     Perl_sv_catpvf(aTHX_ sv,
14720                                                    "%.*s...",
14721                                                    (int) (s - origs - 1),
14722                                                    t);
14723                                     goto out_dump;
14724                                 }
14725                                 *s = ' ';
14726                             }
14727                             else if (*s == '\t') {
14728                                 *s = '-';
14729                             }
14730                             s++;
14731                         }
14732                         if (s[-1] == ' ')
14733                             s[-1] = 0;
14734
14735                         sv_catpv(sv, t);
14736                     }
14737
14738                 out_dump:
14739
14740                     Safefree(origs);
14741                 }
14742                 SvREFCNT_dec_NN(lv);
14743             }
14744         }
14745
14746         Perl_sv_catpvf(aTHX_ sv, "%s]", PL_colors[1]);
14747     }
14748     else if (k == POSIXD || k == NPOSIXD) {
14749         U8 index = FLAGS(o) * 2;
14750         if (index > (sizeof(anyofs) / sizeof(anyofs[0]))) {
14751             Perl_sv_catpvf(aTHX_ sv, "[illegal type=%d])", index);
14752         }
14753         else {
14754             sv_catpv(sv, anyofs[index]);
14755         }
14756     }
14757     else if (k == BRANCHJ && (OP(o) == UNLESSM || OP(o) == IFMATCH))
14758         Perl_sv_catpvf(aTHX_ sv, "[%d]", -(o->flags));
14759 #else
14760     PERL_UNUSED_CONTEXT;
14761     PERL_UNUSED_ARG(sv);
14762     PERL_UNUSED_ARG(o);
14763     PERL_UNUSED_ARG(prog);
14764 #endif  /* DEBUGGING */
14765 }
14766
14767 SV *
14768 Perl_re_intuit_string(pTHX_ REGEXP * const r)
14769 {                               /* Assume that RE_INTUIT is set */
14770     dVAR;
14771     struct regexp *const prog = ReANY(r);
14772     GET_RE_DEBUG_FLAGS_DECL;
14773
14774     PERL_ARGS_ASSERT_RE_INTUIT_STRING;
14775     PERL_UNUSED_CONTEXT;
14776
14777     DEBUG_COMPILE_r(
14778         {
14779             const char * const s = SvPV_nolen_const(prog->check_substr
14780                       ? prog->check_substr : prog->check_utf8);
14781
14782             if (!PL_colorset) reginitcolors();
14783             PerlIO_printf(Perl_debug_log,
14784                       "%sUsing REx %ssubstr:%s \"%s%.60s%s%s\"\n",
14785                       PL_colors[4],
14786                       prog->check_substr ? "" : "utf8 ",
14787                       PL_colors[5],PL_colors[0],
14788                       s,
14789                       PL_colors[1],
14790                       (strlen(s) > 60 ? "..." : ""));
14791         } );
14792
14793     return prog->check_substr ? prog->check_substr : prog->check_utf8;
14794 }
14795
14796 /* 
14797    pregfree() 
14798    
14799    handles refcounting and freeing the perl core regexp structure. When 
14800    it is necessary to actually free the structure the first thing it 
14801    does is call the 'free' method of the regexp_engine associated to
14802    the regexp, allowing the handling of the void *pprivate; member 
14803    first. (This routine is not overridable by extensions, which is why 
14804    the extensions free is called first.)
14805    
14806    See regdupe and regdupe_internal if you change anything here. 
14807 */
14808 #ifndef PERL_IN_XSUB_RE
14809 void
14810 Perl_pregfree(pTHX_ REGEXP *r)
14811 {
14812     SvREFCNT_dec(r);
14813 }
14814
14815 void
14816 Perl_pregfree2(pTHX_ REGEXP *rx)
14817 {
14818     dVAR;
14819     struct regexp *const r = ReANY(rx);
14820     GET_RE_DEBUG_FLAGS_DECL;
14821
14822     PERL_ARGS_ASSERT_PREGFREE2;
14823
14824     if (r->mother_re) {
14825         ReREFCNT_dec(r->mother_re);
14826     } else {
14827         CALLREGFREE_PVT(rx); /* free the private data */
14828         SvREFCNT_dec(RXp_PAREN_NAMES(r));
14829         Safefree(r->xpv_len_u.xpvlenu_pv);
14830     }        
14831     if (r->substrs) {
14832         SvREFCNT_dec(r->anchored_substr);
14833         SvREFCNT_dec(r->anchored_utf8);
14834         SvREFCNT_dec(r->float_substr);
14835         SvREFCNT_dec(r->float_utf8);
14836         Safefree(r->substrs);
14837     }
14838     RX_MATCH_COPY_FREE(rx);
14839 #ifdef PERL_ANY_COW
14840     SvREFCNT_dec(r->saved_copy);
14841 #endif
14842     Safefree(r->offs);
14843     SvREFCNT_dec(r->qr_anoncv);
14844     rx->sv_u.svu_rx = 0;
14845 }
14846
14847 /*  reg_temp_copy()
14848     
14849     This is a hacky workaround to the structural issue of match results
14850     being stored in the regexp structure which is in turn stored in
14851     PL_curpm/PL_reg_curpm. The problem is that due to qr// the pattern
14852     could be PL_curpm in multiple contexts, and could require multiple
14853     result sets being associated with the pattern simultaneously, such
14854     as when doing a recursive match with (??{$qr})
14855     
14856     The solution is to make a lightweight copy of the regexp structure 
14857     when a qr// is returned from the code executed by (??{$qr}) this
14858     lightweight copy doesn't actually own any of its data except for
14859     the starp/end and the actual regexp structure itself. 
14860     
14861 */    
14862     
14863     
14864 REGEXP *
14865 Perl_reg_temp_copy (pTHX_ REGEXP *ret_x, REGEXP *rx)
14866 {
14867     struct regexp *ret;
14868     struct regexp *const r = ReANY(rx);
14869     const bool islv = ret_x && SvTYPE(ret_x) == SVt_PVLV;
14870
14871     PERL_ARGS_ASSERT_REG_TEMP_COPY;
14872
14873     if (!ret_x)
14874         ret_x = (REGEXP*) newSV_type(SVt_REGEXP);
14875     else {
14876         SvOK_off((SV *)ret_x);
14877         if (islv) {
14878             /* For PVLVs, SvANY points to the xpvlv body while sv_u points
14879                to the regexp.  (For SVt_REGEXPs, sv_upgrade has already
14880                made both spots point to the same regexp body.) */
14881             REGEXP *temp = (REGEXP *)newSV_type(SVt_REGEXP);
14882             assert(!SvPVX(ret_x));
14883             ret_x->sv_u.svu_rx = temp->sv_any;
14884             temp->sv_any = NULL;
14885             SvFLAGS(temp) = (SvFLAGS(temp) & ~SVTYPEMASK) | SVt_NULL;
14886             SvREFCNT_dec_NN(temp);
14887             /* SvCUR still resides in the xpvlv struct, so the regexp copy-
14888                ing below will not set it. */
14889             SvCUR_set(ret_x, SvCUR(rx));
14890         }
14891     }
14892     /* This ensures that SvTHINKFIRST(sv) is true, and hence that
14893        sv_force_normal(sv) is called.  */
14894     SvFAKE_on(ret_x);
14895     ret = ReANY(ret_x);
14896     
14897     SvFLAGS(ret_x) |= SvUTF8(rx);
14898     /* We share the same string buffer as the original regexp, on which we
14899        hold a reference count, incremented when mother_re is set below.
14900        The string pointer is copied here, being part of the regexp struct.
14901      */
14902     memcpy(&(ret->xpv_cur), &(r->xpv_cur),
14903            sizeof(regexp) - STRUCT_OFFSET(regexp, xpv_cur));
14904     if (r->offs) {
14905         const I32 npar = r->nparens+1;
14906         Newx(ret->offs, npar, regexp_paren_pair);
14907         Copy(r->offs, ret->offs, npar, regexp_paren_pair);
14908     }
14909     if (r->substrs) {
14910         Newx(ret->substrs, 1, struct reg_substr_data);
14911         StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
14912
14913         SvREFCNT_inc_void(ret->anchored_substr);
14914         SvREFCNT_inc_void(ret->anchored_utf8);
14915         SvREFCNT_inc_void(ret->float_substr);
14916         SvREFCNT_inc_void(ret->float_utf8);
14917
14918         /* check_substr and check_utf8, if non-NULL, point to either their
14919            anchored or float namesakes, and don't hold a second reference.  */
14920     }
14921     RX_MATCH_COPIED_off(ret_x);
14922 #ifdef PERL_ANY_COW
14923     ret->saved_copy = NULL;
14924 #endif
14925     ret->mother_re = ReREFCNT_inc(r->mother_re ? r->mother_re : rx);
14926     SvREFCNT_inc_void(ret->qr_anoncv);
14927     
14928     return ret_x;
14929 }
14930 #endif
14931
14932 /* regfree_internal() 
14933
14934    Free the private data in a regexp. This is overloadable by 
14935    extensions. Perl takes care of the regexp structure in pregfree(), 
14936    this covers the *pprivate pointer which technically perl doesn't 
14937    know about, however of course we have to handle the 
14938    regexp_internal structure when no extension is in use. 
14939    
14940    Note this is called before freeing anything in the regexp 
14941    structure. 
14942  */
14943  
14944 void
14945 Perl_regfree_internal(pTHX_ REGEXP * const rx)
14946 {
14947     dVAR;
14948     struct regexp *const r = ReANY(rx);
14949     RXi_GET_DECL(r,ri);
14950     GET_RE_DEBUG_FLAGS_DECL;
14951
14952     PERL_ARGS_ASSERT_REGFREE_INTERNAL;
14953
14954     DEBUG_COMPILE_r({
14955         if (!PL_colorset)
14956             reginitcolors();
14957         {
14958             SV *dsv= sv_newmortal();
14959             RE_PV_QUOTED_DECL(s, RX_UTF8(rx),
14960                 dsv, RX_PRECOMP(rx), RX_PRELEN(rx), 60);
14961             PerlIO_printf(Perl_debug_log,"%sFreeing REx:%s %s\n", 
14962                 PL_colors[4],PL_colors[5],s);
14963         }
14964     });
14965 #ifdef RE_TRACK_PATTERN_OFFSETS
14966     if (ri->u.offsets)
14967         Safefree(ri->u.offsets);             /* 20010421 MJD */
14968 #endif
14969     if (ri->code_blocks) {
14970         int n;
14971         for (n = 0; n < ri->num_code_blocks; n++)
14972             SvREFCNT_dec(ri->code_blocks[n].src_regex);
14973         Safefree(ri->code_blocks);
14974     }
14975
14976     if (ri->data) {
14977         int n = ri->data->count;
14978
14979         while (--n >= 0) {
14980           /* If you add a ->what type here, update the comment in regcomp.h */
14981             switch (ri->data->what[n]) {
14982             case 'a':
14983             case 'r':
14984             case 's':
14985             case 'S':
14986             case 'u':
14987                 SvREFCNT_dec(MUTABLE_SV(ri->data->data[n]));
14988                 break;
14989             case 'f':
14990                 Safefree(ri->data->data[n]);
14991                 break;
14992             case 'l':
14993             case 'L':
14994                 break;
14995             case 'T':           
14996                 { /* Aho Corasick add-on structure for a trie node.
14997                      Used in stclass optimization only */
14998                     U32 refcount;
14999                     reg_ac_data *aho=(reg_ac_data*)ri->data->data[n];
15000                     OP_REFCNT_LOCK;
15001                     refcount = --aho->refcount;
15002                     OP_REFCNT_UNLOCK;
15003                     if ( !refcount ) {
15004                         PerlMemShared_free(aho->states);
15005                         PerlMemShared_free(aho->fail);
15006                          /* do this last!!!! */
15007                         PerlMemShared_free(ri->data->data[n]);
15008                         PerlMemShared_free(ri->regstclass);
15009                     }
15010                 }
15011                 break;
15012             case 't':
15013                 {
15014                     /* trie structure. */
15015                     U32 refcount;
15016                     reg_trie_data *trie=(reg_trie_data*)ri->data->data[n];
15017                     OP_REFCNT_LOCK;
15018                     refcount = --trie->refcount;
15019                     OP_REFCNT_UNLOCK;
15020                     if ( !refcount ) {
15021                         PerlMemShared_free(trie->charmap);
15022                         PerlMemShared_free(trie->states);
15023                         PerlMemShared_free(trie->trans);
15024                         if (trie->bitmap)
15025                             PerlMemShared_free(trie->bitmap);
15026                         if (trie->jump)
15027                             PerlMemShared_free(trie->jump);
15028                         PerlMemShared_free(trie->wordinfo);
15029                         /* do this last!!!! */
15030                         PerlMemShared_free(ri->data->data[n]);
15031                     }
15032                 }
15033                 break;
15034             default:
15035                 Perl_croak(aTHX_ "panic: regfree data code '%c'", ri->data->what[n]);
15036             }
15037         }
15038         Safefree(ri->data->what);
15039         Safefree(ri->data);
15040     }
15041
15042     Safefree(ri);
15043 }
15044
15045 #define av_dup_inc(s,t) MUTABLE_AV(sv_dup_inc((const SV *)s,t))
15046 #define hv_dup_inc(s,t) MUTABLE_HV(sv_dup_inc((const SV *)s,t))
15047 #define SAVEPVN(p,n)    ((p) ? savepvn(p,n) : NULL)
15048
15049 /* 
15050    re_dup - duplicate a regexp. 
15051    
15052    This routine is expected to clone a given regexp structure. It is only
15053    compiled under USE_ITHREADS.
15054
15055    After all of the core data stored in struct regexp is duplicated
15056    the regexp_engine.dupe method is used to copy any private data
15057    stored in the *pprivate pointer. This allows extensions to handle
15058    any duplication it needs to do.
15059
15060    See pregfree() and regfree_internal() if you change anything here. 
15061 */
15062 #if defined(USE_ITHREADS)
15063 #ifndef PERL_IN_XSUB_RE
15064 void
15065 Perl_re_dup_guts(pTHX_ const REGEXP *sstr, REGEXP *dstr, CLONE_PARAMS *param)
15066 {
15067     dVAR;
15068     I32 npar;
15069     const struct regexp *r = ReANY(sstr);
15070     struct regexp *ret = ReANY(dstr);
15071     
15072     PERL_ARGS_ASSERT_RE_DUP_GUTS;
15073
15074     npar = r->nparens+1;
15075     Newx(ret->offs, npar, regexp_paren_pair);
15076     Copy(r->offs, ret->offs, npar, regexp_paren_pair);
15077
15078     if (ret->substrs) {
15079         /* Do it this way to avoid reading from *r after the StructCopy().
15080            That way, if any of the sv_dup_inc()s dislodge *r from the L1
15081            cache, it doesn't matter.  */
15082         const bool anchored = r->check_substr
15083             ? r->check_substr == r->anchored_substr
15084             : r->check_utf8 == r->anchored_utf8;
15085         Newx(ret->substrs, 1, struct reg_substr_data);
15086         StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
15087
15088         ret->anchored_substr = sv_dup_inc(ret->anchored_substr, param);
15089         ret->anchored_utf8 = sv_dup_inc(ret->anchored_utf8, param);
15090         ret->float_substr = sv_dup_inc(ret->float_substr, param);
15091         ret->float_utf8 = sv_dup_inc(ret->float_utf8, param);
15092
15093         /* check_substr and check_utf8, if non-NULL, point to either their
15094            anchored or float namesakes, and don't hold a second reference.  */
15095
15096         if (ret->check_substr) {
15097             if (anchored) {
15098                 assert(r->check_utf8 == r->anchored_utf8);
15099                 ret->check_substr = ret->anchored_substr;
15100                 ret->check_utf8 = ret->anchored_utf8;
15101             } else {
15102                 assert(r->check_substr == r->float_substr);
15103                 assert(r->check_utf8 == r->float_utf8);
15104                 ret->check_substr = ret->float_substr;
15105                 ret->check_utf8 = ret->float_utf8;
15106             }
15107         } else if (ret->check_utf8) {
15108             if (anchored) {
15109                 ret->check_utf8 = ret->anchored_utf8;
15110             } else {
15111                 ret->check_utf8 = ret->float_utf8;
15112             }
15113         }
15114     }
15115
15116     RXp_PAREN_NAMES(ret) = hv_dup_inc(RXp_PAREN_NAMES(ret), param);
15117     ret->qr_anoncv = MUTABLE_CV(sv_dup_inc((const SV *)ret->qr_anoncv, param));
15118
15119     if (ret->pprivate)
15120         RXi_SET(ret,CALLREGDUPE_PVT(dstr,param));
15121
15122     if (RX_MATCH_COPIED(dstr))
15123         ret->subbeg  = SAVEPVN(ret->subbeg, ret->sublen);
15124     else
15125         ret->subbeg = NULL;
15126 #ifdef PERL_ANY_COW
15127     ret->saved_copy = NULL;
15128 #endif
15129
15130     /* Whether mother_re be set or no, we need to copy the string.  We
15131        cannot refrain from copying it when the storage points directly to
15132        our mother regexp, because that's
15133                1: a buffer in a different thread
15134                2: something we no longer hold a reference on
15135                so we need to copy it locally.  */
15136     RX_WRAPPED(dstr) = SAVEPVN(RX_WRAPPED(sstr), SvCUR(sstr)+1);
15137     ret->mother_re   = NULL;
15138     ret->gofs = 0;
15139 }
15140 #endif /* PERL_IN_XSUB_RE */
15141
15142 /*
15143    regdupe_internal()
15144    
15145    This is the internal complement to regdupe() which is used to copy
15146    the structure pointed to by the *pprivate pointer in the regexp.
15147    This is the core version of the extension overridable cloning hook.
15148    The regexp structure being duplicated will be copied by perl prior
15149    to this and will be provided as the regexp *r argument, however 
15150    with the /old/ structures pprivate pointer value. Thus this routine
15151    may override any copying normally done by perl.
15152    
15153    It returns a pointer to the new regexp_internal structure.
15154 */
15155
15156 void *
15157 Perl_regdupe_internal(pTHX_ REGEXP * const rx, CLONE_PARAMS *param)
15158 {
15159     dVAR;
15160     struct regexp *const r = ReANY(rx);
15161     regexp_internal *reti;
15162     int len;
15163     RXi_GET_DECL(r,ri);
15164
15165     PERL_ARGS_ASSERT_REGDUPE_INTERNAL;
15166     
15167     len = ProgLen(ri);
15168     
15169     Newxc(reti, sizeof(regexp_internal) + len*sizeof(regnode), char, regexp_internal);
15170     Copy(ri->program, reti->program, len+1, regnode);
15171
15172     reti->num_code_blocks = ri->num_code_blocks;
15173     if (ri->code_blocks) {
15174         int n;
15175         Newxc(reti->code_blocks, ri->num_code_blocks, struct reg_code_block,
15176                 struct reg_code_block);
15177         Copy(ri->code_blocks, reti->code_blocks, ri->num_code_blocks,
15178                 struct reg_code_block);
15179         for (n = 0; n < ri->num_code_blocks; n++)
15180              reti->code_blocks[n].src_regex = (REGEXP*)
15181                     sv_dup_inc((SV*)(ri->code_blocks[n].src_regex), param);
15182     }
15183     else
15184         reti->code_blocks = NULL;
15185
15186     reti->regstclass = NULL;
15187
15188     if (ri->data) {
15189         struct reg_data *d;
15190         const int count = ri->data->count;
15191         int i;
15192
15193         Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
15194                 char, struct reg_data);
15195         Newx(d->what, count, U8);
15196
15197         d->count = count;
15198         for (i = 0; i < count; i++) {
15199             d->what[i] = ri->data->what[i];
15200             switch (d->what[i]) {
15201                 /* see also regcomp.h and regfree_internal() */
15202             case 'a': /* actually an AV, but the dup function is identical.  */
15203             case 'r':
15204             case 's':
15205             case 'S':
15206             case 'u': /* actually an HV, but the dup function is identical.  */
15207                 d->data[i] = sv_dup_inc((const SV *)ri->data->data[i], param);
15208                 break;
15209             case 'f':
15210                 /* This is cheating. */
15211                 Newx(d->data[i], 1, struct regnode_charclass_class);
15212                 StructCopy(ri->data->data[i], d->data[i],
15213                             struct regnode_charclass_class);
15214                 reti->regstclass = (regnode*)d->data[i];
15215                 break;
15216             case 'T':
15217                 /* Trie stclasses are readonly and can thus be shared
15218                  * without duplication. We free the stclass in pregfree
15219                  * when the corresponding reg_ac_data struct is freed.
15220                  */
15221                 reti->regstclass= ri->regstclass;
15222                 /* Fall through */
15223             case 't':
15224                 OP_REFCNT_LOCK;
15225                 ((reg_trie_data*)ri->data->data[i])->refcount++;
15226                 OP_REFCNT_UNLOCK;
15227                 /* Fall through */
15228             case 'l':
15229             case 'L':
15230                 d->data[i] = ri->data->data[i];
15231                 break;
15232             default:
15233                 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", ri->data->what[i]);
15234             }
15235         }
15236
15237         reti->data = d;
15238     }
15239     else
15240         reti->data = NULL;
15241
15242     reti->name_list_idx = ri->name_list_idx;
15243
15244 #ifdef RE_TRACK_PATTERN_OFFSETS
15245     if (ri->u.offsets) {
15246         Newx(reti->u.offsets, 2*len+1, U32);
15247         Copy(ri->u.offsets, reti->u.offsets, 2*len+1, U32);
15248     }
15249 #else
15250     SetProgLen(reti,len);
15251 #endif
15252
15253     return (void*)reti;
15254 }
15255
15256 #endif    /* USE_ITHREADS */
15257
15258 #ifndef PERL_IN_XSUB_RE
15259
15260 /*
15261  - regnext - dig the "next" pointer out of a node
15262  */
15263 regnode *
15264 Perl_regnext(pTHX_ regnode *p)
15265 {
15266     dVAR;
15267     I32 offset;
15268
15269     if (!p)
15270         return(NULL);
15271
15272     if (OP(p) > REGNODE_MAX) {          /* regnode.type is unsigned */
15273         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d", (int)OP(p), (int)REGNODE_MAX);
15274     }
15275
15276     offset = (reg_off_by_arg[OP(p)] ? ARG(p) : NEXT_OFF(p));
15277     if (offset == 0)
15278         return(NULL);
15279
15280     return(p+offset);
15281 }
15282 #endif
15283
15284 STATIC void
15285 S_re_croak2(pTHX_ const char* pat1,const char* pat2,...)
15286 {
15287     va_list args;
15288     STRLEN l1 = strlen(pat1);
15289     STRLEN l2 = strlen(pat2);
15290     char buf[512];
15291     SV *msv;
15292     const char *message;
15293
15294     PERL_ARGS_ASSERT_RE_CROAK2;
15295
15296     if (l1 > 510)
15297         l1 = 510;
15298     if (l1 + l2 > 510)
15299         l2 = 510 - l1;
15300     Copy(pat1, buf, l1 , char);
15301     Copy(pat2, buf + l1, l2 , char);
15302     buf[l1 + l2] = '\n';
15303     buf[l1 + l2 + 1] = '\0';
15304 #ifdef I_STDARG
15305     /* ANSI variant takes additional second argument */
15306     va_start(args, pat2);
15307 #else
15308     va_start(args);
15309 #endif
15310     msv = vmess(buf, &args);
15311     va_end(args);
15312     message = SvPV_const(msv,l1);
15313     if (l1 > 512)
15314         l1 = 512;
15315     Copy(message, buf, l1 , char);
15316     buf[l1-1] = '\0';                   /* Overwrite \n */
15317     Perl_croak(aTHX_ "%s", buf);
15318 }
15319
15320 /* XXX Here's a total kludge.  But we need to re-enter for swash routines. */
15321
15322 #ifndef PERL_IN_XSUB_RE
15323 void
15324 Perl_save_re_context(pTHX)
15325 {
15326     dVAR;
15327
15328     struct re_save_state *state;
15329
15330     SAVEVPTR(PL_curcop);
15331     SSGROW(SAVESTACK_ALLOC_FOR_RE_SAVE_STATE + 1);
15332
15333     state = (struct re_save_state *)(PL_savestack + PL_savestack_ix);
15334     PL_savestack_ix += SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
15335     SSPUSHUV(SAVEt_RE_STATE);
15336
15337     Copy(&PL_reg_state, state, 1, struct re_save_state);
15338
15339     PL_reg_oldsaved = NULL;
15340     PL_reg_oldsavedlen = 0;
15341     PL_reg_oldsavedoffset = 0;
15342     PL_reg_oldsavedcoffset = 0;
15343     PL_reg_maxiter = 0;
15344     PL_reg_leftiter = 0;
15345     PL_reg_poscache = NULL;
15346     PL_reg_poscache_size = 0;
15347 #ifdef PERL_ANY_COW
15348     PL_nrs = NULL;
15349 #endif
15350
15351     /* Save $1..$n (#18107: UTF-8 s/(\w+)/uc($1)/e); AMS 20021106. */
15352     if (PL_curpm) {
15353         const REGEXP * const rx = PM_GETRE(PL_curpm);
15354         if (rx) {
15355             U32 i;
15356             for (i = 1; i <= RX_NPARENS(rx); i++) {
15357                 char digits[TYPE_CHARS(long)];
15358                 const STRLEN len = my_snprintf(digits, sizeof(digits), "%lu", (long)i);
15359                 GV *const *const gvp
15360                     = (GV**)hv_fetch(PL_defstash, digits, len, 0);
15361
15362                 if (gvp) {
15363                     GV * const gv = *gvp;
15364                     if (SvTYPE(gv) == SVt_PVGV && GvSV(gv))
15365                         save_scalar(gv);
15366                 }
15367             }
15368         }
15369     }
15370 }
15371 #endif
15372
15373 #ifdef DEBUGGING
15374
15375 STATIC void
15376 S_put_byte(pTHX_ SV *sv, int c)
15377 {
15378     PERL_ARGS_ASSERT_PUT_BYTE;
15379
15380     /* Our definition of isPRINT() ignores locales, so only bytes that are
15381        not part of UTF-8 are considered printable. I assume that the same
15382        holds for UTF-EBCDIC.
15383        Also, code point 255 is not printable in either (it's E0 in EBCDIC,
15384        which Wikipedia says:
15385
15386        EO, or Eight Ones, is an 8-bit EBCDIC character code represented as all
15387        ones (binary 1111 1111, hexadecimal FF). It is similar, but not
15388        identical, to the ASCII delete (DEL) or rubout control character. ...
15389        it is typically mapped to hexadecimal code 9F, in order to provide a
15390        unique character mapping in both directions)
15391
15392        So the old condition can be simplified to !isPRINT(c)  */
15393     if (!isPRINT(c)) {
15394         if (c < 256) {
15395             Perl_sv_catpvf(aTHX_ sv, "\\x%02x", c);
15396         }
15397         else {
15398             Perl_sv_catpvf(aTHX_ sv, "\\x{%x}", c);
15399         }
15400     }
15401     else {
15402         const char string = c;
15403         if (c == '-' || c == ']' || c == '\\' || c == '^')
15404             sv_catpvs(sv, "\\");
15405         sv_catpvn(sv, &string, 1);
15406     }
15407 }
15408
15409
15410 #define CLEAR_OPTSTART \
15411     if (optstart) STMT_START { \
15412             DEBUG_OPTIMISE_r(PerlIO_printf(Perl_debug_log, " (%"IVdf" nodes)\n", (IV)(node - optstart))); \
15413             optstart=NULL; \
15414     } STMT_END
15415
15416 #define DUMPUNTIL(b,e) CLEAR_OPTSTART; node=dumpuntil(r,start,(b),(e),last,sv,indent+1,depth+1);
15417
15418 STATIC const regnode *
15419 S_dumpuntil(pTHX_ const regexp *r, const regnode *start, const regnode *node,
15420             const regnode *last, const regnode *plast, 
15421             SV* sv, I32 indent, U32 depth)
15422 {
15423     dVAR;
15424     U8 op = PSEUDO;     /* Arbitrary non-END op. */
15425     const regnode *next;
15426     const regnode *optstart= NULL;
15427     
15428     RXi_GET_DECL(r,ri);
15429     GET_RE_DEBUG_FLAGS_DECL;
15430
15431     PERL_ARGS_ASSERT_DUMPUNTIL;
15432
15433 #ifdef DEBUG_DUMPUNTIL
15434     PerlIO_printf(Perl_debug_log, "--- %d : %d - %d - %d\n",indent,node-start,
15435         last ? last-start : 0,plast ? plast-start : 0);
15436 #endif
15437             
15438     if (plast && plast < last) 
15439         last= plast;
15440
15441     while (PL_regkind[op] != END && (!last || node < last)) {
15442         /* While that wasn't END last time... */
15443         NODE_ALIGN(node);
15444         op = OP(node);
15445         if (op == CLOSE || op == WHILEM)
15446             indent--;
15447         next = regnext((regnode *)node);
15448
15449         /* Where, what. */
15450         if (OP(node) == OPTIMIZED) {
15451             if (!optstart && RE_DEBUG_FLAG(RE_DEBUG_COMPILE_OPTIMISE))
15452                 optstart = node;
15453             else
15454                 goto after_print;
15455         } else
15456             CLEAR_OPTSTART;
15457
15458         regprop(r, sv, node);
15459         PerlIO_printf(Perl_debug_log, "%4"IVdf":%*s%s", (IV)(node - start),
15460                       (int)(2*indent + 1), "", SvPVX_const(sv));
15461         
15462         if (OP(node) != OPTIMIZED) {                  
15463             if (next == NULL)           /* Next ptr. */
15464                 PerlIO_printf(Perl_debug_log, " (0)");
15465             else if (PL_regkind[(U8)op] == BRANCH && PL_regkind[OP(next)] != BRANCH )
15466                 PerlIO_printf(Perl_debug_log, " (FAIL)");
15467             else 
15468                 PerlIO_printf(Perl_debug_log, " (%"IVdf")", (IV)(next - start));
15469             (void)PerlIO_putc(Perl_debug_log, '\n'); 
15470         }
15471         
15472       after_print:
15473         if (PL_regkind[(U8)op] == BRANCHJ) {
15474             assert(next);
15475             {
15476                 const regnode *nnode = (OP(next) == LONGJMP
15477                                        ? regnext((regnode *)next)
15478                                        : next);
15479                 if (last && nnode > last)
15480                     nnode = last;
15481                 DUMPUNTIL(NEXTOPER(NEXTOPER(node)), nnode);
15482             }
15483         }
15484         else if (PL_regkind[(U8)op] == BRANCH) {
15485             assert(next);
15486             DUMPUNTIL(NEXTOPER(node), next);
15487         }
15488         else if ( PL_regkind[(U8)op]  == TRIE ) {
15489             const regnode *this_trie = node;
15490             const char op = OP(node);
15491             const U32 n = ARG(node);
15492             const reg_ac_data * const ac = op>=AHOCORASICK ?
15493                (reg_ac_data *)ri->data->data[n] :
15494                NULL;
15495             const reg_trie_data * const trie =
15496                 (reg_trie_data*)ri->data->data[op<AHOCORASICK ? n : ac->trie];
15497 #ifdef DEBUGGING
15498             AV *const trie_words = MUTABLE_AV(ri->data->data[n + TRIE_WORDS_OFFSET]);
15499 #endif
15500             const regnode *nextbranch= NULL;
15501             I32 word_idx;
15502             sv_setpvs(sv, "");
15503             for (word_idx= 0; word_idx < (I32)trie->wordcount; word_idx++) {
15504                 SV ** const elem_ptr = av_fetch(trie_words,word_idx,0);
15505
15506                 PerlIO_printf(Perl_debug_log, "%*s%s ",
15507                    (int)(2*(indent+3)), "",
15508                     elem_ptr ? pv_pretty(sv, SvPV_nolen_const(*elem_ptr), SvCUR(*elem_ptr), 60,
15509                             PL_colors[0], PL_colors[1],
15510                             (SvUTF8(*elem_ptr) ? PERL_PV_ESCAPE_UNI : 0) |
15511                             PERL_PV_PRETTY_ELLIPSES    |
15512                             PERL_PV_PRETTY_LTGT
15513                             )
15514                             : "???"
15515                 );
15516                 if (trie->jump) {
15517                     U16 dist= trie->jump[word_idx+1];
15518                     PerlIO_printf(Perl_debug_log, "(%"UVuf")\n",
15519                                   (UV)((dist ? this_trie + dist : next) - start));
15520                     if (dist) {
15521                         if (!nextbranch)
15522                             nextbranch= this_trie + trie->jump[0];    
15523                         DUMPUNTIL(this_trie + dist, nextbranch);
15524                     }
15525                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
15526                         nextbranch= regnext((regnode *)nextbranch);
15527                 } else {
15528                     PerlIO_printf(Perl_debug_log, "\n");
15529                 }
15530             }
15531             if (last && next > last)
15532                 node= last;
15533             else
15534                 node= next;
15535         }
15536         else if ( op == CURLY ) {   /* "next" might be very big: optimizer */
15537             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS,
15538                     NEXTOPER(node) + EXTRA_STEP_2ARGS + 1);
15539         }
15540         else if (PL_regkind[(U8)op] == CURLY && op != CURLYX) {
15541             assert(next);
15542             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS, next);
15543         }
15544         else if ( op == PLUS || op == STAR) {
15545             DUMPUNTIL(NEXTOPER(node), NEXTOPER(node) + 1);
15546         }
15547         else if (PL_regkind[(U8)op] == ANYOF) {
15548             /* arglen 1 + class block */
15549             node += 1 + ((ANYOF_FLAGS(node) & ANYOF_CLASS)
15550                     ? ANYOF_CLASS_SKIP : ANYOF_SKIP);
15551             node = NEXTOPER(node);
15552         }
15553         else if (PL_regkind[(U8)op] == EXACT) {
15554             /* Literal string, where present. */
15555             node += NODE_SZ_STR(node) - 1;
15556             node = NEXTOPER(node);
15557         }
15558         else {
15559             node = NEXTOPER(node);
15560             node += regarglen[(U8)op];
15561         }
15562         if (op == CURLYX || op == OPEN)
15563             indent++;
15564     }
15565     CLEAR_OPTSTART;
15566 #ifdef DEBUG_DUMPUNTIL    
15567     PerlIO_printf(Perl_debug_log, "--- %d\n", (int)indent);
15568 #endif
15569     return node;
15570 }
15571
15572 #endif  /* DEBUGGING */
15573
15574 /*
15575  * Local variables:
15576  * c-indentation-style: bsd
15577  * c-basic-offset: 4
15578  * indent-tabs-mode: nil
15579  * End:
15580  *
15581  * ex: set ts=8 sts=4 sw=4 et:
15582  */