]> git.vpit.fr Git - perl/modules/re-engine-Hooks.git/blob - src/5018001/orig/regcomp.c
Add support for perl 5.18.1
[perl/modules/re-engine-Hooks.git] / src / 5018001 / orig / 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 "INTERN.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
2446     /*  Finish populating the prev field of the wordinfo array.  Walk back
2447      *  from each accept state until we find another accept state, and if
2448      *  so, point the first word's .prev field at the second word. If the
2449      *  second already has a .prev field set, stop now. This will be the
2450      *  case either if we've already processed that word's accept state,
2451      *  or that state had multiple words, and the overspill words were
2452      *  already linked up earlier.
2453      */
2454     {
2455         U16 word;
2456         U32 state;
2457         U16 prev;
2458
2459         for (word=1; word <= trie->wordcount; word++) {
2460             prev = 0;
2461             if (trie->wordinfo[word].prev)
2462                 continue;
2463             state = trie->wordinfo[word].accept;
2464             while (state) {
2465                 state = prev_states[state];
2466                 if (!state)
2467                     break;
2468                 prev = trie->states[state].wordnum;
2469                 if (prev)
2470                     break;
2471             }
2472             trie->wordinfo[word].prev = prev;
2473         }
2474         Safefree(prev_states);
2475     }
2476
2477
2478     /* and now dump out the compressed format */
2479     DEBUG_TRIE_COMPILE_r(dump_trie(trie, widecharmap, revcharmap, depth+1));
2480
2481     RExC_rxi->data->data[ data_slot + 1 ] = (void*)widecharmap;
2482 #ifdef DEBUGGING
2483     RExC_rxi->data->data[ data_slot + TRIE_WORDS_OFFSET ] = (void*)trie_words;
2484     RExC_rxi->data->data[ data_slot + 3 ] = (void*)revcharmap;
2485 #else
2486     SvREFCNT_dec_NN(revcharmap);
2487 #endif
2488     return trie->jump 
2489            ? MADE_JUMP_TRIE 
2490            : trie->startstate>1 
2491              ? MADE_EXACT_TRIE 
2492              : MADE_TRIE;
2493 }
2494
2495 STATIC void
2496 S_make_trie_failtable(pTHX_ RExC_state_t *pRExC_state, regnode *source,  regnode *stclass, U32 depth)
2497 {
2498 /* The Trie is constructed and compressed now so we can build a fail array if it's needed
2499
2500    This is basically the Aho-Corasick algorithm. Its from exercise 3.31 and 3.32 in the
2501    "Red Dragon" -- Compilers, principles, techniques, and tools. Aho, Sethi, Ullman 1985/88
2502    ISBN 0-201-10088-6
2503
2504    We find the fail state for each state in the trie, this state is the longest proper
2505    suffix of the current state's 'word' that is also a proper prefix of another word in our
2506    trie. State 1 represents the word '' and is thus the default fail state. This allows
2507    the DFA not to have to restart after its tried and failed a word at a given point, it
2508    simply continues as though it had been matching the other word in the first place.
2509    Consider
2510       'abcdgu'=~/abcdefg|cdgu/
2511    When we get to 'd' we are still matching the first word, we would encounter 'g' which would
2512    fail, which would bring us to the state representing 'd' in the second word where we would
2513    try 'g' and succeed, proceeding to match 'cdgu'.
2514  */
2515  /* add a fail transition */
2516     const U32 trie_offset = ARG(source);
2517     reg_trie_data *trie=(reg_trie_data *)RExC_rxi->data->data[trie_offset];
2518     U32 *q;
2519     const U32 ucharcount = trie->uniquecharcount;
2520     const U32 numstates = trie->statecount;
2521     const U32 ubound = trie->lasttrans + ucharcount;
2522     U32 q_read = 0;
2523     U32 q_write = 0;
2524     U32 charid;
2525     U32 base = trie->states[ 1 ].trans.base;
2526     U32 *fail;
2527     reg_ac_data *aho;
2528     const U32 data_slot = add_data( pRExC_state, 1, "T" );
2529     GET_RE_DEBUG_FLAGS_DECL;
2530
2531     PERL_ARGS_ASSERT_MAKE_TRIE_FAILTABLE;
2532 #ifndef DEBUGGING
2533     PERL_UNUSED_ARG(depth);
2534 #endif
2535
2536
2537     ARG_SET( stclass, data_slot );
2538     aho = (reg_ac_data *) PerlMemShared_calloc( 1, sizeof(reg_ac_data) );
2539     RExC_rxi->data->data[ data_slot ] = (void*)aho;
2540     aho->trie=trie_offset;
2541     aho->states=(reg_trie_state *)PerlMemShared_malloc( numstates * sizeof(reg_trie_state) );
2542     Copy( trie->states, aho->states, numstates, reg_trie_state );
2543     Newxz( q, numstates, U32);
2544     aho->fail = (U32 *) PerlMemShared_calloc( numstates, sizeof(U32) );
2545     aho->refcount = 1;
2546     fail = aho->fail;
2547     /* initialize fail[0..1] to be 1 so that we always have
2548        a valid final fail state */
2549     fail[ 0 ] = fail[ 1 ] = 1;
2550
2551     for ( charid = 0; charid < ucharcount ; charid++ ) {
2552         const U32 newstate = TRIE_TRANS_STATE( 1, base, ucharcount, charid, 0 );
2553         if ( newstate ) {
2554             q[ q_write ] = newstate;
2555             /* set to point at the root */
2556             fail[ q[ q_write++ ] ]=1;
2557         }
2558     }
2559     while ( q_read < q_write) {
2560         const U32 cur = q[ q_read++ % numstates ];
2561         base = trie->states[ cur ].trans.base;
2562
2563         for ( charid = 0 ; charid < ucharcount ; charid++ ) {
2564             const U32 ch_state = TRIE_TRANS_STATE( cur, base, ucharcount, charid, 1 );
2565             if (ch_state) {
2566                 U32 fail_state = cur;
2567                 U32 fail_base;
2568                 do {
2569                     fail_state = fail[ fail_state ];
2570                     fail_base = aho->states[ fail_state ].trans.base;
2571                 } while ( !TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 ) );
2572
2573                 fail_state = TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 );
2574                 fail[ ch_state ] = fail_state;
2575                 if ( !aho->states[ ch_state ].wordnum && aho->states[ fail_state ].wordnum )
2576                 {
2577                         aho->states[ ch_state ].wordnum =  aho->states[ fail_state ].wordnum;
2578                 }
2579                 q[ q_write++ % numstates] = ch_state;
2580             }
2581         }
2582     }
2583     /* restore fail[0..1] to 0 so that we "fall out" of the AC loop
2584        when we fail in state 1, this allows us to use the
2585        charclass scan to find a valid start char. This is based on the principle
2586        that theres a good chance the string being searched contains lots of stuff
2587        that cant be a start char.
2588      */
2589     fail[ 0 ] = fail[ 1 ] = 0;
2590     DEBUG_TRIE_COMPILE_r({
2591         PerlIO_printf(Perl_debug_log,
2592                       "%*sStclass Failtable (%"UVuf" states): 0", 
2593                       (int)(depth * 2), "", (UV)numstates
2594         );
2595         for( q_read=1; q_read<numstates; q_read++ ) {
2596             PerlIO_printf(Perl_debug_log, ", %"UVuf, (UV)fail[q_read]);
2597         }
2598         PerlIO_printf(Perl_debug_log, "\n");
2599     });
2600     Safefree(q);
2601     /*RExC_seen |= REG_SEEN_TRIEDFA;*/
2602 }
2603
2604
2605 /*
2606  * There are strange code-generation bugs caused on sparc64 by gcc-2.95.2.
2607  * These need to be revisited when a newer toolchain becomes available.
2608  */
2609 #if defined(__sparc64__) && defined(__GNUC__)
2610 #   if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 96)
2611 #       undef  SPARC64_GCC_WORKAROUND
2612 #       define SPARC64_GCC_WORKAROUND 1
2613 #   endif
2614 #endif
2615
2616 #define DEBUG_PEEP(str,scan,depth) \
2617     DEBUG_OPTIMISE_r({if (scan){ \
2618        SV * const mysv=sv_newmortal(); \
2619        regnode *Next = regnext(scan); \
2620        regprop(RExC_rx, mysv, scan); \
2621        PerlIO_printf(Perl_debug_log, "%*s" str ">%3d: %s (%d)\n", \
2622        (int)depth*2, "", REG_NODE_NUM(scan), SvPV_nolen_const(mysv),\
2623        Next ? (REG_NODE_NUM(Next)) : 0 ); \
2624    }});
2625
2626
2627 /* The below joins as many adjacent EXACTish nodes as possible into a single
2628  * one.  The regop may be changed if the node(s) contain certain sequences that
2629  * require special handling.  The joining is only done if:
2630  * 1) there is room in the current conglomerated node to entirely contain the
2631  *    next one.
2632  * 2) they are the exact same node type
2633  *
2634  * The adjacent nodes actually may be separated by NOTHING-kind nodes, and
2635  * these get optimized out
2636  *
2637  * If a node is to match under /i (folded), the number of characters it matches
2638  * can be different than its character length if it contains a multi-character
2639  * fold.  *min_subtract is set to the total delta of the input nodes.
2640  *
2641  * And *has_exactf_sharp_s is set to indicate whether or not the node is EXACTF
2642  * and contains LATIN SMALL LETTER SHARP S
2643  *
2644  * This is as good a place as any to discuss the design of handling these
2645  * multi-character fold sequences.  It's been wrong in Perl for a very long
2646  * time.  There are three code points in Unicode whose multi-character folds
2647  * were long ago discovered to mess things up.  The previous designs for
2648  * dealing with these involved assigning a special node for them.  This
2649  * approach doesn't work, as evidenced by this example:
2650  *      "\xDFs" =~ /s\xDF/ui    # Used to fail before these patches
2651  * Both these fold to "sss", but if the pattern is parsed to create a node that
2652  * would match just the \xDF, it won't be able to handle the case where a
2653  * successful match would have to cross the node's boundary.  The new approach
2654  * that hopefully generally solves the problem generates an EXACTFU_SS node
2655  * that is "sss".
2656  *
2657  * It turns out that there are problems with all multi-character folds, and not
2658  * just these three.  Now the code is general, for all such cases, but the
2659  * three still have some special handling.  The approach taken is:
2660  * 1)   This routine examines each EXACTFish node that could contain multi-
2661  *      character fold sequences.  It returns in *min_subtract how much to
2662  *      subtract from the the actual length of the string to get a real minimum
2663  *      match length; it is 0 if there are no multi-char folds.  This delta is
2664  *      used by the caller to adjust the min length of the match, and the delta
2665  *      between min and max, so that the optimizer doesn't reject these
2666  *      possibilities based on size constraints.
2667  * 2)   Certain of these sequences require special handling by the trie code,
2668  *      so, if found, this code changes the joined node type to special ops:
2669  *      EXACTFU_TRICKYFOLD and EXACTFU_SS.
2670  * 3)   For the sequence involving the Sharp s (\xDF), the node type EXACTFU_SS
2671  *      is used for an EXACTFU node that contains at least one "ss" sequence in
2672  *      it.  For non-UTF-8 patterns and strings, this is the only case where
2673  *      there is a possible fold length change.  That means that a regular
2674  *      EXACTFU node without UTF-8 involvement doesn't have to concern itself
2675  *      with length changes, and so can be processed faster.  regexec.c takes
2676  *      advantage of this.  Generally, an EXACTFish node that is in UTF-8 is
2677  *      pre-folded by regcomp.c.  This saves effort in regex matching.
2678  *      However, the pre-folding isn't done for non-UTF8 patterns because the
2679  *      fold of the MICRO SIGN requires UTF-8, and we don't want to slow things
2680  *      down by forcing the pattern into UTF8 unless necessary.  Also what
2681  *      EXACTF and EXACTFL nodes fold to isn't known until runtime.  The fold
2682  *      possibilities for the non-UTF8 patterns are quite simple, except for
2683  *      the sharp s.  All the ones that don't involve a UTF-8 target string are
2684  *      members of a fold-pair, and arrays are set up for all of them so that
2685  *      the other member of the pair can be found quickly.  Code elsewhere in
2686  *      this file makes sure that in EXACTFU nodes, the sharp s gets folded to
2687  *      'ss', even if the pattern isn't UTF-8.  This avoids the issues
2688  *      described in the next item.
2689  * 4)   A problem remains for the sharp s in EXACTF nodes.  Whether it matches
2690  *      'ss' or not is not knowable at compile time.  It will match iff the
2691  *      target string is in UTF-8, unlike the EXACTFU nodes, where it always
2692  *      matches; and the EXACTFL and EXACTFA nodes where it never does.  Thus
2693  *      it can't be folded to "ss" at compile time, unlike EXACTFU does (as
2694  *      described in item 3).  An assumption that the optimizer part of
2695  *      regexec.c (probably unwittingly) makes is that a character in the
2696  *      pattern corresponds to at most a single character in the target string.
2697  *      (And I do mean character, and not byte here, unlike other parts of the
2698  *      documentation that have never been updated to account for multibyte
2699  *      Unicode.)  This assumption is wrong only in this case, as all other
2700  *      cases are either 1-1 folds when no UTF-8 is involved; or is true by
2701  *      virtue of having this file pre-fold UTF-8 patterns.   I'm
2702  *      reluctant to try to change this assumption, so instead the code punts.
2703  *      This routine examines EXACTF nodes for the sharp s, and returns a
2704  *      boolean indicating whether or not the node is an EXACTF node that
2705  *      contains a sharp s.  When it is true, the caller sets a flag that later
2706  *      causes the optimizer in this file to not set values for the floating
2707  *      and fixed string lengths, and thus avoids the optimizer code in
2708  *      regexec.c that makes the invalid assumption.  Thus, there is no
2709  *      optimization based on string lengths for EXACTF nodes that contain the
2710  *      sharp s.  This only happens for /id rules (which means the pattern
2711  *      isn't in UTF-8).
2712  */
2713
2714 #define JOIN_EXACT(scan,min_subtract,has_exactf_sharp_s, flags) \
2715     if (PL_regkind[OP(scan)] == EXACT) \
2716         join_exact(pRExC_state,(scan),(min_subtract),has_exactf_sharp_s, (flags),NULL,depth+1)
2717
2718 STATIC U32
2719 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) {
2720     /* Merge several consecutive EXACTish nodes into one. */
2721     regnode *n = regnext(scan);
2722     U32 stringok = 1;
2723     regnode *next = scan + NODE_SZ_STR(scan);
2724     U32 merged = 0;
2725     U32 stopnow = 0;
2726 #ifdef DEBUGGING
2727     regnode *stop = scan;
2728     GET_RE_DEBUG_FLAGS_DECL;
2729 #else
2730     PERL_UNUSED_ARG(depth);
2731 #endif
2732
2733     PERL_ARGS_ASSERT_JOIN_EXACT;
2734 #ifndef EXPERIMENTAL_INPLACESCAN
2735     PERL_UNUSED_ARG(flags);
2736     PERL_UNUSED_ARG(val);
2737 #endif
2738     DEBUG_PEEP("join",scan,depth);
2739
2740     /* Look through the subsequent nodes in the chain.  Skip NOTHING, merge
2741      * EXACT ones that are mergeable to the current one. */
2742     while (n
2743            && (PL_regkind[OP(n)] == NOTHING
2744                || (stringok && OP(n) == OP(scan)))
2745            && NEXT_OFF(n)
2746            && NEXT_OFF(scan) + NEXT_OFF(n) < I16_MAX)
2747     {
2748         
2749         if (OP(n) == TAIL || n > next)
2750             stringok = 0;
2751         if (PL_regkind[OP(n)] == NOTHING) {
2752             DEBUG_PEEP("skip:",n,depth);
2753             NEXT_OFF(scan) += NEXT_OFF(n);
2754             next = n + NODE_STEP_REGNODE;
2755 #ifdef DEBUGGING
2756             if (stringok)
2757                 stop = n;
2758 #endif
2759             n = regnext(n);
2760         }
2761         else if (stringok) {
2762             const unsigned int oldl = STR_LEN(scan);
2763             regnode * const nnext = regnext(n);
2764
2765             /* XXX I (khw) kind of doubt that this works on platforms where
2766              * U8_MAX is above 255 because of lots of other assumptions */
2767             /* Don't join if the sum can't fit into a single node */
2768             if (oldl + STR_LEN(n) > U8_MAX)
2769                 break;
2770             
2771             DEBUG_PEEP("merg",n,depth);
2772             merged++;
2773
2774             NEXT_OFF(scan) += NEXT_OFF(n);
2775             STR_LEN(scan) += STR_LEN(n);
2776             next = n + NODE_SZ_STR(n);
2777             /* Now we can overwrite *n : */
2778             Move(STRING(n), STRING(scan) + oldl, STR_LEN(n), char);
2779 #ifdef DEBUGGING
2780             stop = next - 1;
2781 #endif
2782             n = nnext;
2783             if (stopnow) break;
2784         }
2785
2786 #ifdef EXPERIMENTAL_INPLACESCAN
2787         if (flags && !NEXT_OFF(n)) {
2788             DEBUG_PEEP("atch", val, depth);
2789             if (reg_off_by_arg[OP(n)]) {
2790                 ARG_SET(n, val - n);
2791             }
2792             else {
2793                 NEXT_OFF(n) = val - n;
2794             }
2795             stopnow = 1;
2796         }
2797 #endif
2798     }
2799
2800     *min_subtract = 0;
2801     *has_exactf_sharp_s = FALSE;
2802
2803     /* Here, all the adjacent mergeable EXACTish nodes have been merged.  We
2804      * can now analyze for sequences of problematic code points.  (Prior to
2805      * this final joining, sequences could have been split over boundaries, and
2806      * hence missed).  The sequences only happen in folding, hence for any
2807      * non-EXACT EXACTish node */
2808     if (OP(scan) != EXACT) {
2809         const U8 * const s0 = (U8*) STRING(scan);
2810         const U8 * s = s0;
2811         const U8 * const s_end = s0 + STR_LEN(scan);
2812
2813         /* One pass is made over the node's string looking for all the
2814          * possibilities.  to avoid some tests in the loop, there are two main
2815          * cases, for UTF-8 patterns (which can't have EXACTF nodes) and
2816          * non-UTF-8 */
2817         if (UTF) {
2818
2819             /* Examine the string for a multi-character fold sequence.  UTF-8
2820              * patterns have all characters pre-folded by the time this code is
2821              * executed */
2822             while (s < s_end - 1) /* Can stop 1 before the end, as minimum
2823                                      length sequence we are looking for is 2 */
2824             {
2825                 int count = 0;
2826                 int len = is_MULTI_CHAR_FOLD_utf8_safe(s, s_end);
2827                 if (! len) {    /* Not a multi-char fold: get next char */
2828                     s += UTF8SKIP(s);
2829                     continue;
2830                 }
2831
2832                 /* Nodes with 'ss' require special handling, except for EXACTFL
2833                  * and EXACTFA for which there is no multi-char fold to this */
2834                 if (len == 2 && *s == 's' && *(s+1) == 's'
2835                     && OP(scan) != EXACTFL && OP(scan) != EXACTFA)
2836                 {
2837                     count = 2;
2838                     OP(scan) = EXACTFU_SS;
2839                     s += 2;
2840                 }
2841                 else if (len == 6   /* len is the same in both ASCII and EBCDIC for these */
2842                          && (memEQ(s, GREEK_SMALL_LETTER_IOTA_UTF8
2843                                       COMBINING_DIAERESIS_UTF8
2844                                       COMBINING_ACUTE_ACCENT_UTF8,
2845                                    6)
2846                              || memEQ(s, GREEK_SMALL_LETTER_UPSILON_UTF8
2847                                          COMBINING_DIAERESIS_UTF8
2848                                          COMBINING_ACUTE_ACCENT_UTF8,
2849                                      6)))
2850                 {
2851                     count = 3;
2852
2853                     /* These two folds require special handling by trie's, so
2854                      * change the node type to indicate this.  If EXACTFA and
2855                      * EXACTFL were ever to be handled by trie's, this would
2856                      * have to be changed.  If this node has already been
2857                      * changed to EXACTFU_SS in this loop, leave it as is.  (I
2858                      * (khw) think it doesn't matter in regexec.c for UTF
2859                      * patterns, but no need to change it */
2860                     if (OP(scan) == EXACTFU) {
2861                         OP(scan) = EXACTFU_TRICKYFOLD;
2862                     }
2863                     s += 6;
2864                 }
2865                 else { /* Here is a generic multi-char fold. */
2866                     const U8* multi_end  = s + len;
2867
2868                     /* Count how many characters in it.  In the case of /l and
2869                      * /aa, no folds which contain ASCII code points are
2870                      * allowed, so check for those, and skip if found.  (In
2871                      * EXACTFL, no folds are allowed to any Latin1 code point,
2872                      * not just ASCII.  But there aren't any of these
2873                      * currently, nor ever likely, so don't take the time to
2874                      * test for them.  The code that generates the
2875                      * is_MULTI_foo() macros croaks should one actually get put
2876                      * into Unicode .) */
2877                     if (OP(scan) != EXACTFL && OP(scan) != EXACTFA) {
2878                         count = utf8_length(s, multi_end);
2879                         s = multi_end;
2880                     }
2881                     else {
2882                         while (s < multi_end) {
2883                             if (isASCII(*s)) {
2884                                 s++;
2885                                 goto next_iteration;
2886                             }
2887                             else {
2888                                 s += UTF8SKIP(s);
2889                             }
2890                             count++;
2891                         }
2892                     }
2893                 }
2894
2895                 /* The delta is how long the sequence is minus 1 (1 is how long
2896                  * the character that folds to the sequence is) */
2897                 *min_subtract += count - 1;
2898             next_iteration: ;
2899             }
2900         }
2901         else if (OP(scan) != EXACTFL && OP(scan) != EXACTFA) {
2902
2903             /* Here, the pattern is not UTF-8.  Look for the multi-char folds
2904              * that are all ASCII.  As in the above case, EXACTFL and EXACTFA
2905              * nodes can't have multi-char folds to this range (and there are
2906              * no existing ones in the upper latin1 range).  In the EXACTF
2907              * case we look also for the sharp s, which can be in the final
2908              * position.  Otherwise we can stop looking 1 byte earlier because
2909              * have to find at least two characters for a multi-fold */
2910             const U8* upper = (OP(scan) == EXACTF) ? s_end : s_end -1;
2911
2912             /* The below is perhaps overboard, but this allows us to save a
2913              * test each time through the loop at the expense of a mask.  This
2914              * is because on both EBCDIC and ASCII machines, 'S' and 's' differ
2915              * by a single bit.  On ASCII they are 32 apart; on EBCDIC, they
2916              * are 64.  This uses an exclusive 'or' to find that bit and then
2917              * inverts it to form a mask, with just a single 0, in the bit
2918              * position where 'S' and 's' differ. */
2919             const U8 S_or_s_mask = (U8) ~ ('S' ^ 's');
2920             const U8 s_masked = 's' & S_or_s_mask;
2921
2922             while (s < upper) {
2923                 int len = is_MULTI_CHAR_FOLD_latin1_safe(s, s_end);
2924                 if (! len) {    /* Not a multi-char fold. */
2925                     if (*s == LATIN_SMALL_LETTER_SHARP_S && OP(scan) == EXACTF)
2926                     {
2927                         *has_exactf_sharp_s = TRUE;
2928                     }
2929                     s++;
2930                     continue;
2931                 }
2932
2933                 if (len == 2
2934                     && ((*s & S_or_s_mask) == s_masked)
2935                     && ((*(s+1) & S_or_s_mask) == s_masked))
2936                 {
2937
2938                     /* EXACTF nodes need to know that the minimum length
2939                      * changed so that a sharp s in the string can match this
2940                      * ss in the pattern, but they remain EXACTF nodes, as they
2941                      * won't match this unless the target string is is UTF-8,
2942                      * which we don't know until runtime */
2943                     if (OP(scan) != EXACTF) {
2944                         OP(scan) = EXACTFU_SS;
2945                     }
2946                 }
2947
2948                 *min_subtract += len - 1;
2949                 s += len;
2950             }
2951         }
2952     }
2953
2954 #ifdef DEBUGGING
2955     /* Allow dumping but overwriting the collection of skipped
2956      * ops and/or strings with fake optimized ops */
2957     n = scan + NODE_SZ_STR(scan);
2958     while (n <= stop) {
2959         OP(n) = OPTIMIZED;
2960         FLAGS(n) = 0;
2961         NEXT_OFF(n) = 0;
2962         n++;
2963     }
2964 #endif
2965     DEBUG_OPTIMISE_r(if (merged){DEBUG_PEEP("finl",scan,depth)});
2966     return stopnow;
2967 }
2968
2969 /* REx optimizer.  Converts nodes into quicker variants "in place".
2970    Finds fixed substrings.  */
2971
2972 /* Stops at toplevel WHILEM as well as at "last". At end *scanp is set
2973    to the position after last scanned or to NULL. */
2974
2975 #define INIT_AND_WITHP \
2976     assert(!and_withp); \
2977     Newx(and_withp,1,struct regnode_charclass_class); \
2978     SAVEFREEPV(and_withp)
2979
2980 /* this is a chain of data about sub patterns we are processing that
2981    need to be handled separately/specially in study_chunk. Its so
2982    we can simulate recursion without losing state.  */
2983 struct scan_frame;
2984 typedef struct scan_frame {
2985     regnode *last;  /* last node to process in this frame */
2986     regnode *next;  /* next node to process when last is reached */
2987     struct scan_frame *prev; /*previous frame*/
2988     I32 stop; /* what stopparen do we use */
2989 } scan_frame;
2990
2991
2992 #define SCAN_COMMIT(s, data, m) scan_commit(s, data, m, is_inf)
2993
2994 STATIC I32
2995 S_study_chunk(pTHX_ RExC_state_t *pRExC_state, regnode **scanp,
2996                         I32 *minlenp, I32 *deltap,
2997                         regnode *last,
2998                         scan_data_t *data,
2999                         I32 stopparen,
3000                         U8* recursed,
3001                         struct regnode_charclass_class *and_withp,
3002                         U32 flags, U32 depth)
3003                         /* scanp: Start here (read-write). */
3004                         /* deltap: Write maxlen-minlen here. */
3005                         /* last: Stop before this one. */
3006                         /* data: string data about the pattern */
3007                         /* stopparen: treat close N as END */
3008                         /* recursed: which subroutines have we recursed into */
3009                         /* and_withp: Valid if flags & SCF_DO_STCLASS_OR */
3010 {
3011     dVAR;
3012     I32 min = 0;    /* There must be at least this number of characters to match */
3013     I32 pars = 0, code;
3014     regnode *scan = *scanp, *next;
3015     I32 delta = 0;
3016     int is_inf = (flags & SCF_DO_SUBSTR) && (data->flags & SF_IS_INF);
3017     int is_inf_internal = 0;            /* The studied chunk is infinite */
3018     I32 is_par = OP(scan) == OPEN ? ARG(scan) : 0;
3019     scan_data_t data_fake;
3020     SV *re_trie_maxbuff = NULL;
3021     regnode *first_non_open = scan;
3022     I32 stopmin = I32_MAX;
3023     scan_frame *frame = NULL;
3024     GET_RE_DEBUG_FLAGS_DECL;
3025
3026     PERL_ARGS_ASSERT_STUDY_CHUNK;
3027
3028 #ifdef DEBUGGING
3029     StructCopy(&zero_scan_data, &data_fake, scan_data_t);
3030 #endif
3031
3032     if ( depth == 0 ) {
3033         while (first_non_open && OP(first_non_open) == OPEN)
3034             first_non_open=regnext(first_non_open);
3035     }
3036
3037
3038   fake_study_recurse:
3039     while ( scan && OP(scan) != END && scan < last ){
3040         UV min_subtract = 0;    /* How mmany chars to subtract from the minimum
3041                                    node length to get a real minimum (because
3042                                    the folded version may be shorter) */
3043         bool has_exactf_sharp_s = FALSE;
3044         /* Peephole optimizer: */
3045         DEBUG_STUDYDATA("Peep:", data,depth);
3046         DEBUG_PEEP("Peep",scan,depth);
3047
3048         /* Its not clear to khw or hv why this is done here, and not in the
3049          * clauses that deal with EXACT nodes.  khw's guess is that it's
3050          * because of a previous design */
3051         JOIN_EXACT(scan,&min_subtract, &has_exactf_sharp_s, 0);
3052
3053         /* Follow the next-chain of the current node and optimize
3054            away all the NOTHINGs from it.  */
3055         if (OP(scan) != CURLYX) {
3056             const int max = (reg_off_by_arg[OP(scan)]
3057                        ? I32_MAX
3058                        /* I32 may be smaller than U16 on CRAYs! */
3059                        : (I32_MAX < U16_MAX ? I32_MAX : U16_MAX));
3060             int off = (reg_off_by_arg[OP(scan)] ? ARG(scan) : NEXT_OFF(scan));
3061             int noff;
3062             regnode *n = scan;
3063
3064             /* Skip NOTHING and LONGJMP. */
3065             while ((n = regnext(n))
3066                    && ((PL_regkind[OP(n)] == NOTHING && (noff = NEXT_OFF(n)))
3067                        || ((OP(n) == LONGJMP) && (noff = ARG(n))))
3068                    && off + noff < max)
3069                 off += noff;
3070             if (reg_off_by_arg[OP(scan)])
3071                 ARG(scan) = off;
3072             else
3073                 NEXT_OFF(scan) = off;
3074         }
3075
3076
3077
3078         /* The principal pseudo-switch.  Cannot be a switch, since we
3079            look into several different things.  */
3080         if (OP(scan) == BRANCH || OP(scan) == BRANCHJ
3081                    || OP(scan) == IFTHEN) {
3082             next = regnext(scan);
3083             code = OP(scan);
3084             /* demq: the op(next)==code check is to see if we have "branch-branch" AFAICT */
3085
3086             if (OP(next) == code || code == IFTHEN) {
3087                 /* NOTE - There is similar code to this block below for handling
3088                    TRIE nodes on a re-study.  If you change stuff here check there
3089                    too. */
3090                 I32 max1 = 0, min1 = I32_MAX, num = 0;
3091                 struct regnode_charclass_class accum;
3092                 regnode * const startbranch=scan;
3093
3094                 if (flags & SCF_DO_SUBSTR)
3095                     SCAN_COMMIT(pRExC_state, data, minlenp); /* Cannot merge strings after this. */
3096                 if (flags & SCF_DO_STCLASS)
3097                     cl_init_zero(pRExC_state, &accum);
3098
3099                 while (OP(scan) == code) {
3100                     I32 deltanext, minnext, f = 0, fake;
3101                     struct regnode_charclass_class this_class;
3102
3103                     num++;
3104                     data_fake.flags = 0;
3105                     if (data) {
3106                         data_fake.whilem_c = data->whilem_c;
3107                         data_fake.last_closep = data->last_closep;
3108                     }
3109                     else
3110                         data_fake.last_closep = &fake;
3111
3112                     data_fake.pos_delta = delta;
3113                     next = regnext(scan);
3114                     scan = NEXTOPER(scan);
3115                     if (code != BRANCH)
3116                         scan = NEXTOPER(scan);
3117                     if (flags & SCF_DO_STCLASS) {
3118                         cl_init(pRExC_state, &this_class);
3119                         data_fake.start_class = &this_class;
3120                         f = SCF_DO_STCLASS_AND;
3121                     }
3122                     if (flags & SCF_WHILEM_VISITED_POS)
3123                         f |= SCF_WHILEM_VISITED_POS;
3124
3125                     /* we suppose the run is continuous, last=next...*/
3126                     minnext = study_chunk(pRExC_state, &scan, minlenp, &deltanext,
3127                                           next, &data_fake,
3128                                           stopparen, recursed, NULL, f,depth+1);
3129                     if (min1 > minnext)
3130                         min1 = minnext;
3131                     if (deltanext == I32_MAX) {
3132                         is_inf = is_inf_internal = 1;
3133                         max1 = I32_MAX;
3134                     } else if (max1 < minnext + deltanext)
3135                         max1 = minnext + deltanext;
3136                     scan = next;
3137                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
3138                         pars++;
3139                     if (data_fake.flags & SCF_SEEN_ACCEPT) {
3140                         if ( stopmin > minnext) 
3141                             stopmin = min + min1;
3142                         flags &= ~SCF_DO_SUBSTR;
3143                         if (data)
3144                             data->flags |= SCF_SEEN_ACCEPT;
3145                     }
3146                     if (data) {
3147                         if (data_fake.flags & SF_HAS_EVAL)
3148                             data->flags |= SF_HAS_EVAL;
3149                         data->whilem_c = data_fake.whilem_c;
3150                     }
3151                     if (flags & SCF_DO_STCLASS)
3152                         cl_or(pRExC_state, &accum, &this_class);
3153                 }
3154                 if (code == IFTHEN && num < 2) /* Empty ELSE branch */
3155                     min1 = 0;
3156                 if (flags & SCF_DO_SUBSTR) {
3157                     data->pos_min += min1;
3158                     if (data->pos_delta >= I32_MAX - (max1 - min1))
3159                         data->pos_delta = I32_MAX;
3160                     else
3161                         data->pos_delta += max1 - min1;
3162                     if (max1 != min1 || is_inf)
3163                         data->longest = &(data->longest_float);
3164                 }
3165                 min += min1;
3166                 if (delta == I32_MAX || I32_MAX - delta - (max1 - min1) < 0)
3167                     delta = I32_MAX;
3168                 else
3169                     delta += max1 - min1;
3170                 if (flags & SCF_DO_STCLASS_OR) {
3171                     cl_or(pRExC_state, data->start_class, &accum);
3172                     if (min1) {
3173                         cl_and(data->start_class, and_withp);
3174                         flags &= ~SCF_DO_STCLASS;
3175                     }
3176                 }
3177                 else if (flags & SCF_DO_STCLASS_AND) {
3178                     if (min1) {
3179                         cl_and(data->start_class, &accum);
3180                         flags &= ~SCF_DO_STCLASS;
3181                     }
3182                     else {
3183                         /* Switch to OR mode: cache the old value of
3184                          * data->start_class */
3185                         INIT_AND_WITHP;
3186                         StructCopy(data->start_class, and_withp,
3187                                    struct regnode_charclass_class);
3188                         flags &= ~SCF_DO_STCLASS_AND;
3189                         StructCopy(&accum, data->start_class,
3190                                    struct regnode_charclass_class);
3191                         flags |= SCF_DO_STCLASS_OR;
3192                         SET_SSC_EOS(data->start_class);
3193                     }
3194                 }
3195
3196                 if (PERL_ENABLE_TRIE_OPTIMISATION && OP( startbranch ) == BRANCH ) {
3197                 /* demq.
3198
3199                    Assuming this was/is a branch we are dealing with: 'scan' now
3200                    points at the item that follows the branch sequence, whatever
3201                    it is. We now start at the beginning of the sequence and look
3202                    for subsequences of
3203
3204                    BRANCH->EXACT=>x1
3205                    BRANCH->EXACT=>x2
3206                    tail
3207
3208                    which would be constructed from a pattern like /A|LIST|OF|WORDS/
3209
3210                    If we can find such a subsequence we need to turn the first
3211                    element into a trie and then add the subsequent branch exact
3212                    strings to the trie.
3213
3214                    We have two cases
3215
3216                      1. patterns where the whole set of branches can be converted. 
3217
3218                      2. patterns where only a subset can be converted.
3219
3220                    In case 1 we can replace the whole set with a single regop
3221                    for the trie. In case 2 we need to keep the start and end
3222                    branches so
3223
3224                      'BRANCH EXACT; BRANCH EXACT; BRANCH X'
3225                      becomes BRANCH TRIE; BRANCH X;
3226
3227                   There is an additional case, that being where there is a 
3228                   common prefix, which gets split out into an EXACT like node
3229                   preceding the TRIE node.
3230
3231                   If x(1..n)==tail then we can do a simple trie, if not we make
3232                   a "jump" trie, such that when we match the appropriate word
3233                   we "jump" to the appropriate tail node. Essentially we turn
3234                   a nested if into a case structure of sorts.
3235
3236                 */
3237
3238                     int made=0;
3239                     if (!re_trie_maxbuff) {
3240                         re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
3241                         if (!SvIOK(re_trie_maxbuff))
3242                             sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
3243                     }
3244                     if ( SvIV(re_trie_maxbuff)>=0  ) {
3245                         regnode *cur;
3246                         regnode *first = (regnode *)NULL;
3247                         regnode *last = (regnode *)NULL;
3248                         regnode *tail = scan;
3249                         U8 trietype = 0;
3250                         U32 count=0;
3251
3252 #ifdef DEBUGGING
3253                         SV * const mysv = sv_newmortal();       /* for dumping */
3254 #endif
3255                         /* var tail is used because there may be a TAIL
3256                            regop in the way. Ie, the exacts will point to the
3257                            thing following the TAIL, but the last branch will
3258                            point at the TAIL. So we advance tail. If we
3259                            have nested (?:) we may have to move through several
3260                            tails.
3261                          */
3262
3263                         while ( OP( tail ) == TAIL ) {
3264                             /* this is the TAIL generated by (?:) */
3265                             tail = regnext( tail );
3266                         }
3267
3268                         
3269                         DEBUG_TRIE_COMPILE_r({
3270                             regprop(RExC_rx, mysv, tail );
3271                             PerlIO_printf( Perl_debug_log, "%*s%s%s\n",
3272                                 (int)depth * 2 + 2, "", 
3273                                 "Looking for TRIE'able sequences. Tail node is: ", 
3274                                 SvPV_nolen_const( mysv )
3275                             );
3276                         });
3277                         
3278                         /*
3279
3280                             Step through the branches
3281                                 cur represents each branch,
3282                                 noper is the first thing to be matched as part of that branch
3283                                 noper_next is the regnext() of that node.
3284
3285                             We normally handle a case like this /FOO[xyz]|BAR[pqr]/
3286                             via a "jump trie" but we also support building with NOJUMPTRIE,
3287                             which restricts the trie logic to structures like /FOO|BAR/.
3288
3289                             If noper is a trieable nodetype then the branch is a possible optimization
3290                             target. If we are building under NOJUMPTRIE then we require that noper_next
3291                             is the same as scan (our current position in the regex program).
3292
3293                             Once we have two or more consecutive such branches we can create a
3294                             trie of the EXACT's contents and stitch it in place into the program.
3295
3296                             If the sequence represents all of the branches in the alternation we
3297                             replace the entire thing with a single TRIE node.
3298
3299                             Otherwise when it is a subsequence we need to stitch it in place and
3300                             replace only the relevant branches. This means the first branch has
3301                             to remain as it is used by the alternation logic, and its next pointer,
3302                             and needs to be repointed at the item on the branch chain following
3303                             the last branch we have optimized away.
3304
3305                             This could be either a BRANCH, in which case the subsequence is internal,
3306                             or it could be the item following the branch sequence in which case the
3307                             subsequence is at the end (which does not necessarily mean the first node
3308                             is the start of the alternation).
3309
3310                             TRIE_TYPE(X) is a define which maps the optype to a trietype.
3311
3312                                 optype          |  trietype
3313                                 ----------------+-----------
3314                                 NOTHING         | NOTHING
3315                                 EXACT           | EXACT
3316                                 EXACTFU         | EXACTFU
3317                                 EXACTFU_SS      | EXACTFU
3318                                 EXACTFU_TRICKYFOLD | EXACTFU
3319                                 EXACTFA         | 0
3320
3321
3322                         */
3323 #define TRIE_TYPE(X) ( ( NOTHING == (X) ) ? NOTHING :   \
3324                        ( EXACT == (X) )   ? EXACT :        \
3325                        ( EXACTFU == (X) || EXACTFU_SS == (X) || EXACTFU_TRICKYFOLD == (X) ) ? EXACTFU :        \
3326                        0 )
3327
3328                         /* dont use tail as the end marker for this traverse */
3329                         for ( cur = startbranch ; cur != scan ; cur = regnext( cur ) ) {
3330                             regnode * const noper = NEXTOPER( cur );
3331                             U8 noper_type = OP( noper );
3332                             U8 noper_trietype = TRIE_TYPE( noper_type );
3333 #if defined(DEBUGGING) || defined(NOJUMPTRIE)
3334                             regnode * const noper_next = regnext( noper );
3335                             U8 noper_next_type = (noper_next && noper_next != tail) ? OP(noper_next) : 0;
3336                             U8 noper_next_trietype = (noper_next && noper_next != tail) ? TRIE_TYPE( noper_next_type ) :0;
3337 #endif
3338
3339                             DEBUG_TRIE_COMPILE_r({
3340                                 regprop(RExC_rx, mysv, cur);
3341                                 PerlIO_printf( Perl_debug_log, "%*s- %s (%d)",
3342                                    (int)depth * 2 + 2,"", SvPV_nolen_const( mysv ), REG_NODE_NUM(cur) );
3343
3344                                 regprop(RExC_rx, mysv, noper);
3345                                 PerlIO_printf( Perl_debug_log, " -> %s",
3346                                     SvPV_nolen_const(mysv));
3347
3348                                 if ( noper_next ) {
3349                                   regprop(RExC_rx, mysv, noper_next );
3350                                   PerlIO_printf( Perl_debug_log,"\t=> %s\t",
3351                                     SvPV_nolen_const(mysv));
3352                                 }
3353                                 PerlIO_printf( Perl_debug_log, "(First==%d,Last==%d,Cur==%d,tt==%s,nt==%s,nnt==%s)\n",
3354                                    REG_NODE_NUM(first), REG_NODE_NUM(last), REG_NODE_NUM(cur),
3355                                    PL_reg_name[trietype], PL_reg_name[noper_trietype], PL_reg_name[noper_next_trietype] 
3356                                 );
3357                             });
3358
3359                             /* Is noper a trieable nodetype that can be merged with the
3360                              * current trie (if there is one)? */
3361                             if ( noper_trietype
3362                                   &&
3363                                   (
3364                                         ( noper_trietype == NOTHING)
3365                                         || ( trietype == NOTHING )
3366                                         || ( trietype == noper_trietype )
3367                                   )
3368 #ifdef NOJUMPTRIE
3369                                   && noper_next == tail
3370 #endif
3371                                   && count < U16_MAX)
3372                             {
3373                                 /* Handle mergable triable node
3374                                  * Either we are the first node in a new trieable sequence,
3375                                  * in which case we do some bookkeeping, otherwise we update
3376                                  * the end pointer. */
3377                                 if ( !first ) {
3378                                     first = cur;
3379                                     if ( noper_trietype == NOTHING ) {
3380 #if !defined(DEBUGGING) && !defined(NOJUMPTRIE)
3381                                         regnode * const noper_next = regnext( noper );
3382                                         U8 noper_next_type = (noper_next && noper_next!=tail) ? OP(noper_next) : 0;
3383                                         U8 noper_next_trietype = noper_next_type ? TRIE_TYPE( noper_next_type ) :0;
3384 #endif
3385
3386                                         if ( noper_next_trietype ) {
3387                                             trietype = noper_next_trietype;
3388                                         } else if (noper_next_type)  {
3389                                             /* a NOTHING regop is 1 regop wide. We need at least two
3390                                              * for a trie so we can't merge this in */
3391                                             first = NULL;
3392                                         }
3393                                     } else {
3394                                         trietype = noper_trietype;
3395                                     }
3396                                 } else {
3397                                     if ( trietype == NOTHING )
3398                                         trietype = noper_trietype;
3399                                     last = cur;
3400                                 }
3401                                 if (first)
3402                                     count++;
3403                             } /* end handle mergable triable node */
3404                             else {
3405                                 /* handle unmergable node -
3406                                  * noper may either be a triable node which can not be tried
3407                                  * together with the current trie, or a non triable node */
3408                                 if ( last ) {
3409                                     /* If last is set and trietype is not NOTHING then we have found
3410                                      * at least two triable branch sequences in a row of a similar
3411                                      * trietype so we can turn them into a trie. If/when we
3412                                      * allow NOTHING to start a trie sequence this condition will be
3413                                      * required, and it isn't expensive so we leave it in for now. */
3414                                     if ( trietype && trietype != NOTHING )
3415                                         make_trie( pRExC_state,
3416                                                 startbranch, first, cur, tail, count,
3417                                                 trietype, depth+1 );
3418                                     last = NULL; /* note: we clear/update first, trietype etc below, so we dont do it here */
3419                                 }
3420                                 if ( noper_trietype
3421 #ifdef NOJUMPTRIE
3422                                      && noper_next == tail
3423 #endif
3424                                 ){
3425                                     /* noper is triable, so we can start a new trie sequence */
3426                                     count = 1;
3427                                     first = cur;
3428                                     trietype = noper_trietype;
3429                                 } else if (first) {
3430                                     /* if we already saw a first but the current node is not triable then we have
3431                                      * to reset the first information. */
3432                                     count = 0;
3433                                     first = NULL;
3434                                     trietype = 0;
3435                                 }
3436                             } /* end handle unmergable node */
3437                         } /* loop over branches */
3438                         DEBUG_TRIE_COMPILE_r({
3439                             regprop(RExC_rx, mysv, cur);
3440                             PerlIO_printf( Perl_debug_log,
3441                               "%*s- %s (%d) <SCAN FINISHED>\n", (int)depth * 2 + 2,
3442                               "", SvPV_nolen_const( mysv ),REG_NODE_NUM(cur));
3443
3444                         });
3445                         if ( last && trietype ) {
3446                             if ( trietype != NOTHING ) {
3447                                 /* the last branch of the sequence was part of a trie,
3448                                  * so we have to construct it here outside of the loop
3449                                  */
3450                                 made= make_trie( pRExC_state, startbranch, first, scan, tail, count, trietype, depth+1 );
3451 #ifdef TRIE_STUDY_OPT
3452                                 if ( ((made == MADE_EXACT_TRIE &&
3453                                      startbranch == first)
3454                                      || ( first_non_open == first )) &&
3455                                      depth==0 ) {
3456                                     flags |= SCF_TRIE_RESTUDY;
3457                                     if ( startbranch == first
3458                                          && scan == tail )
3459                                     {
3460                                         RExC_seen &=~REG_TOP_LEVEL_BRANCHES;
3461                                     }
3462                                 }
3463 #endif
3464                             } else {
3465                                 /* at this point we know whatever we have is a NOTHING sequence/branch
3466                                  * AND if 'startbranch' is 'first' then we can turn the whole thing into a NOTHING
3467                                  */
3468                                 if ( startbranch == first ) {
3469                                     regnode *opt;
3470                                     /* the entire thing is a NOTHING sequence, something like this:
3471                                      * (?:|) So we can turn it into a plain NOTHING op. */
3472                                     DEBUG_TRIE_COMPILE_r({
3473                                         regprop(RExC_rx, mysv, cur);
3474                                         PerlIO_printf( Perl_debug_log,
3475                                           "%*s- %s (%d) <NOTHING BRANCH SEQUENCE>\n", (int)depth * 2 + 2,
3476                                           "", SvPV_nolen_const( mysv ),REG_NODE_NUM(cur));
3477
3478                                     });
3479                                     OP(startbranch)= NOTHING;
3480                                     NEXT_OFF(startbranch)= tail - startbranch;
3481                                     for ( opt= startbranch + 1; opt < tail ; opt++ )
3482                                         OP(opt)= OPTIMIZED;
3483                                 }
3484                             }
3485                         } /* end if ( last) */
3486                     } /* TRIE_MAXBUF is non zero */
3487                     
3488                 } /* do trie */
3489                 
3490             }
3491             else if ( code == BRANCHJ ) {  /* single branch is optimized. */
3492                 scan = NEXTOPER(NEXTOPER(scan));
3493             } else                      /* single branch is optimized. */
3494                 scan = NEXTOPER(scan);
3495             continue;
3496         } else if (OP(scan) == SUSPEND || OP(scan) == GOSUB || OP(scan) == GOSTART) {
3497             scan_frame *newframe = NULL;
3498             I32 paren;
3499             regnode *start;
3500             regnode *end;
3501
3502             if (OP(scan) != SUSPEND) {
3503             /* set the pointer */
3504                 if (OP(scan) == GOSUB) {
3505                     paren = ARG(scan);
3506                     RExC_recurse[ARG2L(scan)] = scan;
3507                     start = RExC_open_parens[paren-1];
3508                     end   = RExC_close_parens[paren-1];
3509                 } else {
3510                     paren = 0;
3511                     start = RExC_rxi->program + 1;
3512                     end   = RExC_opend;
3513                 }
3514                 if (!recursed) {
3515                     Newxz(recursed, (((RExC_npar)>>3) +1), U8);
3516                     SAVEFREEPV(recursed);
3517                 }
3518                 if (!PAREN_TEST(recursed,paren+1)) {
3519                     PAREN_SET(recursed,paren+1);
3520                     Newx(newframe,1,scan_frame);
3521                 } else {
3522                     if (flags & SCF_DO_SUBSTR) {
3523                         SCAN_COMMIT(pRExC_state,data,minlenp);
3524                         data->longest = &(data->longest_float);
3525                     }
3526                     is_inf = is_inf_internal = 1;
3527                     if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
3528                         cl_anything(pRExC_state, data->start_class);
3529                     flags &= ~SCF_DO_STCLASS;
3530                 }
3531             } else {
3532                 Newx(newframe,1,scan_frame);
3533                 paren = stopparen;
3534                 start = scan+2;
3535                 end = regnext(scan);
3536             }
3537             if (newframe) {
3538                 assert(start);
3539                 assert(end);
3540                 SAVEFREEPV(newframe);
3541                 newframe->next = regnext(scan);
3542                 newframe->last = last;
3543                 newframe->stop = stopparen;
3544                 newframe->prev = frame;
3545
3546                 frame = newframe;
3547                 scan =  start;
3548                 stopparen = paren;
3549                 last = end;
3550
3551                 continue;
3552             }
3553         }
3554         else if (OP(scan) == EXACT) {
3555             I32 l = STR_LEN(scan);
3556             UV uc;
3557             if (UTF) {
3558                 const U8 * const s = (U8*)STRING(scan);
3559                 uc = utf8_to_uvchr_buf(s, s + l, NULL);
3560                 l = utf8_length(s, s + l);
3561             } else {
3562                 uc = *((U8*)STRING(scan));
3563             }
3564             min += l;
3565             if (flags & SCF_DO_SUBSTR) { /* Update longest substr. */
3566                 /* The code below prefers earlier match for fixed
3567                    offset, later match for variable offset.  */
3568                 if (data->last_end == -1) { /* Update the start info. */
3569                     data->last_start_min = data->pos_min;
3570                     data->last_start_max = is_inf
3571                         ? I32_MAX : data->pos_min + data->pos_delta;
3572                 }
3573                 sv_catpvn(data->last_found, STRING(scan), STR_LEN(scan));
3574                 if (UTF)
3575                     SvUTF8_on(data->last_found);
3576                 {
3577                     SV * const sv = data->last_found;
3578                     MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
3579                         mg_find(sv, PERL_MAGIC_utf8) : NULL;
3580                     if (mg && mg->mg_len >= 0)
3581                         mg->mg_len += utf8_length((U8*)STRING(scan),
3582                                                   (U8*)STRING(scan)+STR_LEN(scan));
3583                 }
3584                 data->last_end = data->pos_min + l;
3585                 data->pos_min += l; /* As in the first entry. */
3586                 data->flags &= ~SF_BEFORE_EOL;
3587             }
3588             if (flags & SCF_DO_STCLASS_AND) {
3589                 /* Check whether it is compatible with what we know already! */
3590                 int compat = 1;
3591
3592
3593                 /* If compatible, we or it in below.  It is compatible if is
3594                  * in the bitmp and either 1) its bit or its fold is set, or 2)
3595                  * it's for a locale.  Even if there isn't unicode semantics
3596                  * here, at runtime there may be because of matching against a
3597                  * utf8 string, so accept a possible false positive for
3598                  * latin1-range folds */
3599                 if (uc >= 0x100 ||
3600                     (!(data->start_class->flags & ANYOF_LOCALE)
3601                     && !ANYOF_BITMAP_TEST(data->start_class, uc)
3602                     && (!(data->start_class->flags & ANYOF_LOC_FOLD)
3603                         || !ANYOF_BITMAP_TEST(data->start_class, PL_fold_latin1[uc])))
3604                     )
3605                 {
3606                     compat = 0;
3607                 }
3608                 ANYOF_CLASS_ZERO(data->start_class);
3609                 ANYOF_BITMAP_ZERO(data->start_class);
3610                 if (compat)
3611                     ANYOF_BITMAP_SET(data->start_class, uc);
3612                 else if (uc >= 0x100) {
3613                     int i;
3614
3615                     /* Some Unicode code points fold to the Latin1 range; as
3616                      * XXX temporary code, instead of figuring out if this is
3617                      * one, just assume it is and set all the start class bits
3618                      * that could be some such above 255 code point's fold
3619                      * which will generate fals positives.  As the code
3620                      * elsewhere that does compute the fold settles down, it
3621                      * can be extracted out and re-used here */
3622                     for (i = 0; i < 256; i++){
3623                         if (HAS_NONLATIN1_FOLD_CLOSURE(i)) {
3624                             ANYOF_BITMAP_SET(data->start_class, i);
3625                         }
3626                     }
3627                 }
3628                 CLEAR_SSC_EOS(data->start_class);
3629                 if (uc < 0x100)
3630                   data->start_class->flags &= ~ANYOF_UNICODE_ALL;
3631             }
3632             else if (flags & SCF_DO_STCLASS_OR) {
3633                 /* false positive possible if the class is case-folded */
3634                 if (uc < 0x100)
3635                     ANYOF_BITMAP_SET(data->start_class, uc);
3636                 else
3637                     data->start_class->flags |= ANYOF_UNICODE_ALL;
3638                 CLEAR_SSC_EOS(data->start_class);
3639                 cl_and(data->start_class, and_withp);
3640             }
3641             flags &= ~SCF_DO_STCLASS;
3642         }
3643         else if (PL_regkind[OP(scan)] == EXACT) { /* But OP != EXACT! */
3644             I32 l = STR_LEN(scan);
3645             UV uc = *((U8*)STRING(scan));
3646
3647             /* Search for fixed substrings supports EXACT only. */
3648             if (flags & SCF_DO_SUBSTR) {
3649                 assert(data);
3650                 SCAN_COMMIT(pRExC_state, data, minlenp);
3651             }
3652             if (UTF) {
3653                 const U8 * const s = (U8 *)STRING(scan);
3654                 uc = utf8_to_uvchr_buf(s, s + l, NULL);
3655                 l = utf8_length(s, s + l);
3656             }
3657             if (has_exactf_sharp_s) {
3658                 RExC_seen |= REG_SEEN_EXACTF_SHARP_S;
3659             }
3660             min += l - min_subtract;
3661             assert (min >= 0);
3662             delta += min_subtract;
3663             if (flags & SCF_DO_SUBSTR) {
3664                 data->pos_min += l - min_subtract;
3665                 if (data->pos_min < 0) {
3666                     data->pos_min = 0;
3667                 }
3668                 data->pos_delta += min_subtract;
3669                 if (min_subtract) {
3670                     data->longest = &(data->longest_float);
3671                 }
3672             }
3673             if (flags & SCF_DO_STCLASS_AND) {
3674                 /* Check whether it is compatible with what we know already! */
3675                 int compat = 1;
3676                 if (uc >= 0x100 ||
3677                  (!(data->start_class->flags & ANYOF_LOCALE)
3678                   && !ANYOF_BITMAP_TEST(data->start_class, uc)
3679                   && !ANYOF_BITMAP_TEST(data->start_class, PL_fold_latin1[uc])))
3680                 {
3681                     compat = 0;
3682                 }
3683                 ANYOF_CLASS_ZERO(data->start_class);
3684                 ANYOF_BITMAP_ZERO(data->start_class);
3685                 if (compat) {
3686                     ANYOF_BITMAP_SET(data->start_class, uc);
3687                     CLEAR_SSC_EOS(data->start_class);
3688                     if (OP(scan) == EXACTFL) {
3689                         /* XXX This set is probably no longer necessary, and
3690                          * probably wrong as LOCALE now is on in the initial
3691                          * state */
3692                         data->start_class->flags |= ANYOF_LOCALE|ANYOF_LOC_FOLD;
3693                     }
3694                     else {
3695
3696                         /* Also set the other member of the fold pair.  In case
3697                          * that unicode semantics is called for at runtime, use
3698                          * the full latin1 fold.  (Can't do this for locale,
3699                          * because not known until runtime) */
3700                         ANYOF_BITMAP_SET(data->start_class, PL_fold_latin1[uc]);
3701
3702                         /* All other (EXACTFL handled above) folds except under
3703                          * /iaa that include s, S, and sharp_s also may include
3704                          * the others */
3705                         if (OP(scan) != EXACTFA) {
3706                             if (uc == 's' || uc == 'S') {
3707                                 ANYOF_BITMAP_SET(data->start_class,
3708                                                  LATIN_SMALL_LETTER_SHARP_S);
3709                             }
3710                             else if (uc == LATIN_SMALL_LETTER_SHARP_S) {
3711                                 ANYOF_BITMAP_SET(data->start_class, 's');
3712                                 ANYOF_BITMAP_SET(data->start_class, 'S');
3713                             }
3714                         }
3715                     }
3716                 }
3717                 else if (uc >= 0x100) {
3718                     int i;
3719                     for (i = 0; i < 256; i++){
3720                         if (_HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(i)) {
3721                             ANYOF_BITMAP_SET(data->start_class, i);
3722                         }
3723                     }
3724                 }
3725             }
3726             else if (flags & SCF_DO_STCLASS_OR) {
3727                 if (data->start_class->flags & ANYOF_LOC_FOLD) {
3728                     /* false positive possible if the class is case-folded.
3729                        Assume that the locale settings are the same... */
3730                     if (uc < 0x100) {
3731                         ANYOF_BITMAP_SET(data->start_class, uc);
3732                         if (OP(scan) != EXACTFL) {
3733
3734                             /* And set the other member of the fold pair, but
3735                              * can't do that in locale because not known until
3736                              * run-time */
3737                             ANYOF_BITMAP_SET(data->start_class,
3738                                              PL_fold_latin1[uc]);
3739
3740                             /* All folds except under /iaa that include s, S,
3741                              * and sharp_s also may include the others */
3742                             if (OP(scan) != EXACTFA) {
3743                                 if (uc == 's' || uc == 'S') {
3744                                     ANYOF_BITMAP_SET(data->start_class,
3745                                                    LATIN_SMALL_LETTER_SHARP_S);
3746                                 }
3747                                 else if (uc == LATIN_SMALL_LETTER_SHARP_S) {
3748                                     ANYOF_BITMAP_SET(data->start_class, 's');
3749                                     ANYOF_BITMAP_SET(data->start_class, 'S');
3750                                 }
3751                             }
3752                         }
3753                     }
3754                     CLEAR_SSC_EOS(data->start_class);
3755                 }
3756                 cl_and(data->start_class, and_withp);
3757             }
3758             flags &= ~SCF_DO_STCLASS;
3759         }
3760         else if (REGNODE_VARIES(OP(scan))) {
3761             I32 mincount, maxcount, minnext, deltanext, fl = 0;
3762             I32 f = flags, pos_before = 0;
3763             regnode * const oscan = scan;
3764             struct regnode_charclass_class this_class;
3765             struct regnode_charclass_class *oclass = NULL;
3766             I32 next_is_eval = 0;
3767
3768             switch (PL_regkind[OP(scan)]) {
3769             case WHILEM:                /* End of (?:...)* . */
3770                 scan = NEXTOPER(scan);
3771                 goto finish;
3772             case PLUS:
3773                 if (flags & (SCF_DO_SUBSTR | SCF_DO_STCLASS)) {
3774                     next = NEXTOPER(scan);
3775                     if (OP(next) == EXACT || (flags & SCF_DO_STCLASS)) {
3776                         mincount = 1;
3777                         maxcount = REG_INFTY;
3778                         next = regnext(scan);
3779                         scan = NEXTOPER(scan);
3780                         goto do_curly;
3781                     }
3782                 }
3783                 if (flags & SCF_DO_SUBSTR)
3784                     data->pos_min++;
3785                 min++;
3786                 /* Fall through. */
3787             case STAR:
3788                 if (flags & SCF_DO_STCLASS) {
3789                     mincount = 0;
3790                     maxcount = REG_INFTY;
3791                     next = regnext(scan);
3792                     scan = NEXTOPER(scan);
3793                     goto do_curly;
3794                 }
3795                 is_inf = is_inf_internal = 1;
3796                 scan = regnext(scan);
3797                 if (flags & SCF_DO_SUBSTR) {
3798                     SCAN_COMMIT(pRExC_state, data, minlenp); /* Cannot extend fixed substrings */
3799                     data->longest = &(data->longest_float);
3800                 }
3801                 goto optimize_curly_tail;
3802             case CURLY:
3803                 if (stopparen>0 && (OP(scan)==CURLYN || OP(scan)==CURLYM)
3804                     && (scan->flags == stopparen))
3805                 {
3806                     mincount = 1;
3807                     maxcount = 1;
3808                 } else {
3809                     mincount = ARG1(scan);
3810                     maxcount = ARG2(scan);
3811                 }
3812                 next = regnext(scan);
3813                 if (OP(scan) == CURLYX) {
3814                     I32 lp = (data ? *(data->last_closep) : 0);
3815                     scan->flags = ((lp <= (I32)U8_MAX) ? (U8)lp : U8_MAX);
3816                 }
3817                 scan = NEXTOPER(scan) + EXTRA_STEP_2ARGS;
3818                 next_is_eval = (OP(scan) == EVAL);
3819               do_curly:
3820                 if (flags & SCF_DO_SUBSTR) {
3821                     if (mincount == 0) SCAN_COMMIT(pRExC_state,data,minlenp); /* Cannot extend fixed substrings */
3822                     pos_before = data->pos_min;
3823                 }
3824                 if (data) {
3825                     fl = data->flags;
3826                     data->flags &= ~(SF_HAS_PAR|SF_IN_PAR|SF_HAS_EVAL);
3827                     if (is_inf)
3828                         data->flags |= SF_IS_INF;
3829                 }
3830                 if (flags & SCF_DO_STCLASS) {
3831                     cl_init(pRExC_state, &this_class);
3832                     oclass = data->start_class;
3833                     data->start_class = &this_class;
3834                     f |= SCF_DO_STCLASS_AND;
3835                     f &= ~SCF_DO_STCLASS_OR;
3836                 }
3837                 /* Exclude from super-linear cache processing any {n,m}
3838                    regops for which the combination of input pos and regex
3839                    pos is not enough information to determine if a match
3840                    will be possible.
3841
3842                    For example, in the regex /foo(bar\s*){4,8}baz/ with the
3843                    regex pos at the \s*, the prospects for a match depend not
3844                    only on the input position but also on how many (bar\s*)
3845                    repeats into the {4,8} we are. */
3846                if ((mincount > 1) || (maxcount > 1 && maxcount != REG_INFTY))
3847                     f &= ~SCF_WHILEM_VISITED_POS;
3848
3849                 /* This will finish on WHILEM, setting scan, or on NULL: */
3850                 minnext = study_chunk(pRExC_state, &scan, minlenp, &deltanext, 
3851                                       last, data, stopparen, recursed, NULL,
3852                                       (mincount == 0
3853                                         ? (f & ~SCF_DO_SUBSTR) : f),depth+1);
3854
3855                 if (flags & SCF_DO_STCLASS)
3856                     data->start_class = oclass;
3857                 if (mincount == 0 || minnext == 0) {
3858                     if (flags & SCF_DO_STCLASS_OR) {
3859                         cl_or(pRExC_state, data->start_class, &this_class);
3860                     }
3861                     else if (flags & SCF_DO_STCLASS_AND) {
3862                         /* Switch to OR mode: cache the old value of
3863                          * data->start_class */
3864                         INIT_AND_WITHP;
3865                         StructCopy(data->start_class, and_withp,
3866                                    struct regnode_charclass_class);
3867                         flags &= ~SCF_DO_STCLASS_AND;
3868                         StructCopy(&this_class, data->start_class,
3869                                    struct regnode_charclass_class);
3870                         flags |= SCF_DO_STCLASS_OR;
3871                         SET_SSC_EOS(data->start_class);
3872                     }
3873                 } else {                /* Non-zero len */
3874                     if (flags & SCF_DO_STCLASS_OR) {
3875                         cl_or(pRExC_state, data->start_class, &this_class);
3876                         cl_and(data->start_class, and_withp);
3877                     }
3878                     else if (flags & SCF_DO_STCLASS_AND)
3879                         cl_and(data->start_class, &this_class);
3880                     flags &= ~SCF_DO_STCLASS;
3881                 }
3882                 if (!scan)              /* It was not CURLYX, but CURLY. */
3883                     scan = next;
3884                 if ( /* ? quantifier ok, except for (?{ ... }) */
3885                     (next_is_eval || !(mincount == 0 && maxcount == 1))
3886                     && (minnext == 0) && (deltanext == 0)
3887                     && data && !(data->flags & (SF_HAS_PAR|SF_IN_PAR))
3888                     && maxcount <= REG_INFTY/3) /* Complement check for big count */
3889                 {
3890                     /* Fatal warnings may leak the regexp without this: */
3891                     SAVEFREESV(RExC_rx_sv);
3892                     ckWARNreg(RExC_parse,
3893                               "Quantifier unexpected on zero-length expression");
3894                     (void)ReREFCNT_inc(RExC_rx_sv);
3895                 }
3896
3897                 min += minnext * mincount;
3898                 is_inf_internal |= deltanext == I32_MAX
3899                                      || (maxcount == REG_INFTY && minnext + deltanext > 0);
3900                 is_inf |= is_inf_internal;
3901                 if (is_inf)
3902                     delta = I32_MAX;
3903                 else
3904                     delta += (minnext + deltanext) * maxcount - minnext * mincount;
3905
3906                 /* Try powerful optimization CURLYX => CURLYN. */
3907                 if (  OP(oscan) == CURLYX && data
3908                       && data->flags & SF_IN_PAR
3909                       && !(data->flags & SF_HAS_EVAL)
3910                       && !deltanext && minnext == 1 ) {
3911                     /* Try to optimize to CURLYN.  */
3912                     regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS;
3913                     regnode * const nxt1 = nxt;
3914 #ifdef DEBUGGING
3915                     regnode *nxt2;
3916 #endif
3917
3918                     /* Skip open. */
3919                     nxt = regnext(nxt);
3920                     if (!REGNODE_SIMPLE(OP(nxt))
3921                         && !(PL_regkind[OP(nxt)] == EXACT
3922                              && STR_LEN(nxt) == 1))
3923                         goto nogo;
3924 #ifdef DEBUGGING
3925                     nxt2 = nxt;
3926 #endif
3927                     nxt = regnext(nxt);
3928                     if (OP(nxt) != CLOSE)
3929                         goto nogo;
3930                     if (RExC_open_parens) {
3931                         RExC_open_parens[ARG(nxt1)-1]=oscan; /*open->CURLYM*/
3932                         RExC_close_parens[ARG(nxt1)-1]=nxt+2; /*close->while*/
3933                     }
3934                     /* Now we know that nxt2 is the only contents: */
3935                     oscan->flags = (U8)ARG(nxt);
3936                     OP(oscan) = CURLYN;
3937                     OP(nxt1) = NOTHING; /* was OPEN. */
3938
3939 #ifdef DEBUGGING
3940                     OP(nxt1 + 1) = OPTIMIZED; /* was count. */
3941                     NEXT_OFF(nxt1+ 1) = 0; /* just for consistency. */
3942                     NEXT_OFF(nxt2) = 0; /* just for consistency with CURLY. */
3943                     OP(nxt) = OPTIMIZED;        /* was CLOSE. */
3944                     OP(nxt + 1) = OPTIMIZED; /* was count. */
3945                     NEXT_OFF(nxt+ 1) = 0; /* just for consistency. */
3946 #endif
3947                 }
3948               nogo:
3949
3950                 /* Try optimization CURLYX => CURLYM. */
3951                 if (  OP(oscan) == CURLYX && data
3952                       && !(data->flags & SF_HAS_PAR)
3953                       && !(data->flags & SF_HAS_EVAL)
3954                       && !deltanext     /* atom is fixed width */
3955                       && minnext != 0   /* CURLYM can't handle zero width */
3956                       && ! (RExC_seen & REG_SEEN_EXACTF_SHARP_S) /* Nor \xDF */
3957                 ) {
3958                     /* XXXX How to optimize if data == 0? */
3959                     /* Optimize to a simpler form.  */
3960                     regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN */
3961                     regnode *nxt2;
3962
3963                     OP(oscan) = CURLYM;
3964                     while ( (nxt2 = regnext(nxt)) /* skip over embedded stuff*/
3965                             && (OP(nxt2) != WHILEM))
3966                         nxt = nxt2;
3967                     OP(nxt2)  = SUCCEED; /* Whas WHILEM */
3968                     /* Need to optimize away parenths. */
3969                     if ((data->flags & SF_IN_PAR) && OP(nxt) == CLOSE) {
3970                         /* Set the parenth number.  */
3971                         regnode *nxt1 = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN*/
3972
3973                         oscan->flags = (U8)ARG(nxt);
3974                         if (RExC_open_parens) {
3975                             RExC_open_parens[ARG(nxt1)-1]=oscan; /*open->CURLYM*/
3976                             RExC_close_parens[ARG(nxt1)-1]=nxt2+1; /*close->NOTHING*/
3977                         }
3978                         OP(nxt1) = OPTIMIZED;   /* was OPEN. */
3979                         OP(nxt) = OPTIMIZED;    /* was CLOSE. */
3980
3981 #ifdef DEBUGGING
3982                         OP(nxt1 + 1) = OPTIMIZED; /* was count. */
3983                         OP(nxt + 1) = OPTIMIZED; /* was count. */
3984                         NEXT_OFF(nxt1 + 1) = 0; /* just for consistency. */
3985                         NEXT_OFF(nxt + 1) = 0; /* just for consistency. */
3986 #endif
3987 #if 0
3988                         while ( nxt1 && (OP(nxt1) != WHILEM)) {
3989                             regnode *nnxt = regnext(nxt1);
3990                             if (nnxt == nxt) {
3991                                 if (reg_off_by_arg[OP(nxt1)])
3992                                     ARG_SET(nxt1, nxt2 - nxt1);
3993                                 else if (nxt2 - nxt1 < U16_MAX)
3994                                     NEXT_OFF(nxt1) = nxt2 - nxt1;
3995                                 else
3996                                     OP(nxt) = NOTHING;  /* Cannot beautify */
3997                             }
3998                             nxt1 = nnxt;
3999                         }
4000 #endif
4001                         /* Optimize again: */
4002                         study_chunk(pRExC_state, &nxt1, minlenp, &deltanext, nxt,
4003                                     NULL, stopparen, recursed, NULL, 0,depth+1);
4004                     }
4005                     else
4006                         oscan->flags = 0;
4007                 }
4008                 else if ((OP(oscan) == CURLYX)
4009                          && (flags & SCF_WHILEM_VISITED_POS)
4010                          /* See the comment on a similar expression above.
4011                             However, this time it's not a subexpression
4012                             we care about, but the expression itself. */
4013                          && (maxcount == REG_INFTY)
4014                          && data && ++data->whilem_c < 16) {
4015                     /* This stays as CURLYX, we can put the count/of pair. */
4016                     /* Find WHILEM (as in regexec.c) */
4017                     regnode *nxt = oscan + NEXT_OFF(oscan);
4018
4019                     if (OP(PREVOPER(nxt)) == NOTHING) /* LONGJMP */
4020                         nxt += ARG(nxt);
4021                     PREVOPER(nxt)->flags = (U8)(data->whilem_c
4022                         | (RExC_whilem_seen << 4)); /* On WHILEM */
4023                 }
4024                 if (data && fl & (SF_HAS_PAR|SF_IN_PAR))
4025                     pars++;
4026                 if (flags & SCF_DO_SUBSTR) {
4027                     SV *last_str = NULL;
4028                     int counted = mincount != 0;
4029
4030                     if (data->last_end > 0 && mincount != 0) { /* Ends with a string. */
4031 #if defined(SPARC64_GCC_WORKAROUND)
4032                         I32 b = 0;
4033                         STRLEN l = 0;
4034                         const char *s = NULL;
4035                         I32 old = 0;
4036
4037                         if (pos_before >= data->last_start_min)
4038                             b = pos_before;
4039                         else
4040                             b = data->last_start_min;
4041
4042                         l = 0;
4043                         s = SvPV_const(data->last_found, l);
4044                         old = b - data->last_start_min;
4045
4046 #else
4047                         I32 b = pos_before >= data->last_start_min
4048                             ? pos_before : data->last_start_min;
4049                         STRLEN l;
4050                         const char * const s = SvPV_const(data->last_found, l);
4051                         I32 old = b - data->last_start_min;
4052 #endif
4053
4054                         if (UTF)
4055                             old = utf8_hop((U8*)s, old) - (U8*)s;
4056                         l -= old;
4057                         /* Get the added string: */
4058                         last_str = newSVpvn_utf8(s  + old, l, UTF);
4059                         if (deltanext == 0 && pos_before == b) {
4060                             /* What was added is a constant string */
4061                             if (mincount > 1) {
4062                                 SvGROW(last_str, (mincount * l) + 1);
4063                                 repeatcpy(SvPVX(last_str) + l,
4064                                           SvPVX_const(last_str), l, mincount - 1);
4065                                 SvCUR_set(last_str, SvCUR(last_str) * mincount);
4066                                 /* Add additional parts. */
4067                                 SvCUR_set(data->last_found,
4068                                           SvCUR(data->last_found) - l);
4069                                 sv_catsv(data->last_found, last_str);
4070                                 {
4071                                     SV * sv = data->last_found;
4072                                     MAGIC *mg =
4073                                         SvUTF8(sv) && SvMAGICAL(sv) ?
4074                                         mg_find(sv, PERL_MAGIC_utf8) : NULL;
4075                                     if (mg && mg->mg_len >= 0)
4076                                         mg->mg_len += CHR_SVLEN(last_str) - l;
4077                                 }
4078                                 data->last_end += l * (mincount - 1);
4079                             }
4080                         } else {
4081                             /* start offset must point into the last copy */
4082                             data->last_start_min += minnext * (mincount - 1);
4083                             data->last_start_max += is_inf ? I32_MAX
4084                                 : (maxcount - 1) * (minnext + data->pos_delta);
4085                         }
4086                     }
4087                     /* It is counted once already... */
4088                     data->pos_min += minnext * (mincount - counted);
4089 #if 0
4090 PerlIO_printf(Perl_debug_log, "counted=%d deltanext=%d I32_MAX=%d minnext=%d maxcount=%d mincount=%d\n",
4091     counted, deltanext, I32_MAX, minnext, maxcount, mincount);
4092 if (deltanext != I32_MAX)
4093 PerlIO_printf(Perl_debug_log, "LHS=%d RHS=%d\n", -counted * deltanext + (minnext + deltanext) * maxcount - minnext * mincount, I32_MAX - data->pos_delta);
4094 #endif
4095                     if (deltanext == I32_MAX || -counted * deltanext + (minnext + deltanext) * maxcount - minnext * mincount >= I32_MAX - data->pos_delta)
4096                         data->pos_delta = I32_MAX;
4097                     else
4098                         data->pos_delta += - counted * deltanext +
4099                         (minnext + deltanext) * maxcount - minnext * mincount;
4100                     if (mincount != maxcount) {
4101                          /* Cannot extend fixed substrings found inside
4102                             the group.  */
4103                         SCAN_COMMIT(pRExC_state,data,minlenp);
4104                         if (mincount && last_str) {
4105                             SV * const sv = data->last_found;
4106                             MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
4107                                 mg_find(sv, PERL_MAGIC_utf8) : NULL;
4108
4109                             if (mg)
4110                                 mg->mg_len = -1;
4111                             sv_setsv(sv, last_str);
4112                             data->last_end = data->pos_min;
4113                             data->last_start_min =
4114                                 data->pos_min - CHR_SVLEN(last_str);
4115                             data->last_start_max = is_inf
4116                                 ? I32_MAX
4117                                 : data->pos_min + data->pos_delta
4118                                 - CHR_SVLEN(last_str);
4119                         }
4120                         data->longest = &(data->longest_float);
4121                     }
4122                     SvREFCNT_dec(last_str);
4123                 }
4124                 if (data && (fl & SF_HAS_EVAL))
4125                     data->flags |= SF_HAS_EVAL;
4126               optimize_curly_tail:
4127                 if (OP(oscan) != CURLYX) {
4128                     while (PL_regkind[OP(next = regnext(oscan))] == NOTHING
4129                            && NEXT_OFF(next))
4130                         NEXT_OFF(oscan) += NEXT_OFF(next);
4131                 }
4132                 continue;
4133             default:                    /* REF, and CLUMP only? */
4134                 if (flags & SCF_DO_SUBSTR) {
4135                     SCAN_COMMIT(pRExC_state,data,minlenp);      /* Cannot expect anything... */
4136                     data->longest = &(data->longest_float);
4137                 }
4138                 is_inf = is_inf_internal = 1;
4139                 if (flags & SCF_DO_STCLASS_OR)
4140                     cl_anything(pRExC_state, data->start_class);
4141                 flags &= ~SCF_DO_STCLASS;
4142                 break;
4143             }
4144         }
4145         else if (OP(scan) == LNBREAK) {
4146             if (flags & SCF_DO_STCLASS) {
4147                 int value = 0;
4148                 CLEAR_SSC_EOS(data->start_class); /* No match on empty */
4149                 if (flags & SCF_DO_STCLASS_AND) {
4150                     for (value = 0; value < 256; value++)
4151                         if (!is_VERTWS_cp(value))
4152                             ANYOF_BITMAP_CLEAR(data->start_class, value);
4153                 }
4154                 else {
4155                     for (value = 0; value < 256; value++)
4156                         if (is_VERTWS_cp(value))
4157                             ANYOF_BITMAP_SET(data->start_class, value);
4158                 }
4159                 if (flags & SCF_DO_STCLASS_OR)
4160                     cl_and(data->start_class, and_withp);
4161                 flags &= ~SCF_DO_STCLASS;
4162             }
4163             min++;
4164             delta++;    /* Because of the 2 char string cr-lf */
4165             if (flags & SCF_DO_SUBSTR) {
4166                 SCAN_COMMIT(pRExC_state,data,minlenp);  /* Cannot expect anything... */
4167                 data->pos_min += 1;
4168                 data->pos_delta += 1;
4169                 data->longest = &(data->longest_float);
4170             }
4171         }
4172         else if (REGNODE_SIMPLE(OP(scan))) {
4173             int value = 0;
4174
4175             if (flags & SCF_DO_SUBSTR) {
4176                 SCAN_COMMIT(pRExC_state,data,minlenp);
4177                 data->pos_min++;
4178             }
4179             min++;
4180             if (flags & SCF_DO_STCLASS) {
4181                 int loop_max = 256;
4182                 CLEAR_SSC_EOS(data->start_class); /* No match on empty */
4183
4184                 /* Some of the logic below assumes that switching
4185                    locale on will only add false positives. */
4186                 switch (PL_regkind[OP(scan)]) {
4187                     U8 classnum;
4188
4189                 case SANY:
4190                 default:
4191 #ifdef DEBUGGING
4192                    Perl_croak(aTHX_ "panic: unexpected simple REx opcode %d", OP(scan));
4193 #endif
4194                  do_default:
4195                     if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
4196                         cl_anything(pRExC_state, data->start_class);
4197                     break;
4198                 case REG_ANY:
4199                     if (OP(scan) == SANY)
4200                         goto do_default;
4201                     if (flags & SCF_DO_STCLASS_OR) { /* Everything but \n */
4202                         value = (ANYOF_BITMAP_TEST(data->start_class,'\n')
4203                                 || ANYOF_CLASS_TEST_ANY_SET(data->start_class));
4204                         cl_anything(pRExC_state, data->start_class);
4205                     }
4206                     if (flags & SCF_DO_STCLASS_AND || !value)
4207                         ANYOF_BITMAP_CLEAR(data->start_class,'\n');
4208                     break;
4209                 case ANYOF:
4210                     if (flags & SCF_DO_STCLASS_AND)
4211                         cl_and(data->start_class,
4212                                (struct regnode_charclass_class*)scan);
4213                     else
4214                         cl_or(pRExC_state, data->start_class,
4215                               (struct regnode_charclass_class*)scan);
4216                     break;
4217                 case POSIXA:
4218                     loop_max = 128;
4219                     /* FALL THROUGH */
4220                 case POSIXL:
4221                 case POSIXD:
4222                 case POSIXU:
4223                     classnum = FLAGS(scan);
4224                     if (flags & SCF_DO_STCLASS_AND) {
4225                         if (!(data->start_class->flags & ANYOF_LOCALE)) {
4226                             ANYOF_CLASS_CLEAR(data->start_class, classnum_to_namedclass(classnum) + 1);
4227                             for (value = 0; value < loop_max; value++) {
4228                                 if (! _generic_isCC(UNI_TO_NATIVE(value), classnum)) {
4229                                     ANYOF_BITMAP_CLEAR(data->start_class, UNI_TO_NATIVE(value));
4230                                 }
4231                             }
4232                         }
4233                     }
4234                     else {
4235                         if (data->start_class->flags & ANYOF_LOCALE) {
4236                             ANYOF_CLASS_SET(data->start_class, classnum_to_namedclass(classnum));
4237                         }
4238                         else {
4239
4240                         /* Even if under locale, set the bits for non-locale
4241                          * in case it isn't a true locale-node.  This will
4242                          * create false positives if it truly is locale */
4243                         for (value = 0; value < loop_max; value++) {
4244                             if (_generic_isCC(UNI_TO_NATIVE(value), classnum)) {
4245                                 ANYOF_BITMAP_SET(data->start_class, UNI_TO_NATIVE(value));
4246                             }
4247                         }
4248                         }
4249                     }
4250                     break;
4251                 case NPOSIXA:
4252                     loop_max = 128;
4253                     /* FALL THROUGH */
4254                 case NPOSIXL:
4255                 case NPOSIXU:
4256                 case NPOSIXD:
4257                     classnum = FLAGS(scan);
4258                     if (flags & SCF_DO_STCLASS_AND) {
4259                         if (!(data->start_class->flags & ANYOF_LOCALE)) {
4260                             ANYOF_CLASS_CLEAR(data->start_class, classnum_to_namedclass(classnum));
4261                             for (value = 0; value < loop_max; value++) {
4262                                 if (_generic_isCC(UNI_TO_NATIVE(value), classnum)) {
4263                                     ANYOF_BITMAP_CLEAR(data->start_class, UNI_TO_NATIVE(value));
4264                                 }
4265                             }
4266                         }
4267                     }
4268                     else {
4269                         if (data->start_class->flags & ANYOF_LOCALE) {
4270                             ANYOF_CLASS_SET(data->start_class, classnum_to_namedclass(classnum) + 1);
4271                         }
4272                         else {
4273
4274                         /* Even if under locale, set the bits for non-locale in
4275                          * case it isn't a true locale-node.  This will create
4276                          * false positives if it truly is locale */
4277                         for (value = 0; value < loop_max; value++) {
4278                             if (! _generic_isCC(UNI_TO_NATIVE(value), classnum)) {
4279                                 ANYOF_BITMAP_SET(data->start_class, UNI_TO_NATIVE(value));
4280                             }
4281                         }
4282                         if (PL_regkind[OP(scan)] == NPOSIXD) {
4283                             data->start_class->flags |= ANYOF_NON_UTF8_LATIN1_ALL;
4284                         }
4285                         }
4286                     }
4287                     break;
4288                 }
4289                 if (flags & SCF_DO_STCLASS_OR)
4290                     cl_and(data->start_class, and_withp);
4291                 flags &= ~SCF_DO_STCLASS;
4292             }
4293         }
4294         else if (PL_regkind[OP(scan)] == EOL && flags & SCF_DO_SUBSTR) {
4295             data->flags |= (OP(scan) == MEOL
4296                             ? SF_BEFORE_MEOL
4297                             : SF_BEFORE_SEOL);
4298             SCAN_COMMIT(pRExC_state, data, minlenp);
4299
4300         }
4301         else if (  PL_regkind[OP(scan)] == BRANCHJ
4302                  /* Lookbehind, or need to calculate parens/evals/stclass: */
4303                    && (scan->flags || data || (flags & SCF_DO_STCLASS))
4304                    && (OP(scan) == IFMATCH || OP(scan) == UNLESSM)) {
4305             if ( OP(scan) == UNLESSM &&
4306                  scan->flags == 0 &&
4307                  OP(NEXTOPER(NEXTOPER(scan))) == NOTHING &&
4308                  OP(regnext(NEXTOPER(NEXTOPER(scan)))) == SUCCEED
4309             ) {
4310                 regnode *opt;
4311                 regnode *upto= regnext(scan);
4312                 DEBUG_PARSE_r({
4313                     SV * const mysv_val=sv_newmortal();
4314                     DEBUG_STUDYDATA("OPFAIL",data,depth);
4315
4316                     /*DEBUG_PARSE_MSG("opfail");*/
4317                     regprop(RExC_rx, mysv_val, upto);
4318                     PerlIO_printf(Perl_debug_log, "~ replace with OPFAIL pointed at %s (%"IVdf") offset %"IVdf"\n",
4319                                   SvPV_nolen_const(mysv_val),
4320                                   (IV)REG_NODE_NUM(upto),
4321                                   (IV)(upto - scan)
4322                     );
4323                 });
4324                 OP(scan) = OPFAIL;
4325                 NEXT_OFF(scan) = upto - scan;
4326                 for (opt= scan + 1; opt < upto ; opt++)
4327                     OP(opt) = OPTIMIZED;
4328                 scan= upto;
4329                 continue;
4330             }
4331             if ( !PERL_ENABLE_POSITIVE_ASSERTION_STUDY 
4332                 || OP(scan) == UNLESSM )
4333             {
4334                 /* Negative Lookahead/lookbehind
4335                    In this case we can't do fixed string optimisation.
4336                 */
4337
4338                 I32 deltanext, minnext, fake = 0;
4339                 regnode *nscan;
4340                 struct regnode_charclass_class intrnl;
4341                 int f = 0;
4342
4343                 data_fake.flags = 0;
4344                 if (data) {
4345                     data_fake.whilem_c = data->whilem_c;
4346                     data_fake.last_closep = data->last_closep;
4347                 }
4348                 else
4349                     data_fake.last_closep = &fake;
4350                 data_fake.pos_delta = delta;
4351                 if ( flags & SCF_DO_STCLASS && !scan->flags
4352                      && OP(scan) == IFMATCH ) { /* Lookahead */
4353                     cl_init(pRExC_state, &intrnl);
4354                     data_fake.start_class = &intrnl;
4355                     f |= SCF_DO_STCLASS_AND;
4356                 }
4357                 if (flags & SCF_WHILEM_VISITED_POS)
4358                     f |= SCF_WHILEM_VISITED_POS;
4359                 next = regnext(scan);
4360                 nscan = NEXTOPER(NEXTOPER(scan));
4361                 minnext = study_chunk(pRExC_state, &nscan, minlenp, &deltanext, 
4362                     last, &data_fake, stopparen, recursed, NULL, f, depth+1);
4363                 if (scan->flags) {
4364                     if (deltanext) {
4365                         FAIL("Variable length lookbehind not implemented");
4366                     }
4367                     else if (minnext > (I32)U8_MAX) {
4368                         FAIL2("Lookbehind longer than %"UVuf" not implemented", (UV)U8_MAX);
4369                     }
4370                     scan->flags = (U8)minnext;
4371                 }
4372                 if (data) {
4373                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4374                         pars++;
4375                     if (data_fake.flags & SF_HAS_EVAL)
4376                         data->flags |= SF_HAS_EVAL;
4377                     data->whilem_c = data_fake.whilem_c;
4378                 }
4379                 if (f & SCF_DO_STCLASS_AND) {
4380                     if (flags & SCF_DO_STCLASS_OR) {
4381                         /* OR before, AND after: ideally we would recurse with
4382                          * data_fake to get the AND applied by study of the
4383                          * remainder of the pattern, and then derecurse;
4384                          * *** HACK *** for now just treat as "no information".
4385                          * See [perl #56690].
4386                          */
4387                         cl_init(pRExC_state, data->start_class);
4388                     }  else {
4389                         /* AND before and after: combine and continue */
4390                         const int was = TEST_SSC_EOS(data->start_class);
4391
4392                         cl_and(data->start_class, &intrnl);
4393                         if (was)
4394                             SET_SSC_EOS(data->start_class);
4395                     }
4396                 }
4397             }
4398 #if PERL_ENABLE_POSITIVE_ASSERTION_STUDY
4399             else {
4400                 /* Positive Lookahead/lookbehind
4401                    In this case we can do fixed string optimisation,
4402                    but we must be careful about it. Note in the case of
4403                    lookbehind the positions will be offset by the minimum
4404                    length of the pattern, something we won't know about
4405                    until after the recurse.
4406                 */
4407                 I32 deltanext, fake = 0;
4408                 regnode *nscan;
4409                 struct regnode_charclass_class intrnl;
4410                 int f = 0;
4411                 /* We use SAVEFREEPV so that when the full compile 
4412                     is finished perl will clean up the allocated 
4413                     minlens when it's all done. This way we don't
4414                     have to worry about freeing them when we know
4415                     they wont be used, which would be a pain.
4416                  */
4417                 I32 *minnextp;
4418                 Newx( minnextp, 1, I32 );
4419                 SAVEFREEPV(minnextp);
4420
4421                 if (data) {
4422                     StructCopy(data, &data_fake, scan_data_t);
4423                     if ((flags & SCF_DO_SUBSTR) && data->last_found) {
4424                         f |= SCF_DO_SUBSTR;
4425                         if (scan->flags) 
4426                             SCAN_COMMIT(pRExC_state, &data_fake,minlenp);
4427                         data_fake.last_found=newSVsv(data->last_found);
4428                     }
4429                 }
4430                 else
4431                     data_fake.last_closep = &fake;
4432                 data_fake.flags = 0;
4433                 data_fake.pos_delta = delta;
4434                 if (is_inf)
4435                     data_fake.flags |= SF_IS_INF;
4436                 if ( flags & SCF_DO_STCLASS && !scan->flags
4437                      && OP(scan) == IFMATCH ) { /* Lookahead */
4438                     cl_init(pRExC_state, &intrnl);
4439                     data_fake.start_class = &intrnl;
4440                     f |= SCF_DO_STCLASS_AND;
4441                 }
4442                 if (flags & SCF_WHILEM_VISITED_POS)
4443                     f |= SCF_WHILEM_VISITED_POS;
4444                 next = regnext(scan);
4445                 nscan = NEXTOPER(NEXTOPER(scan));
4446
4447                 *minnextp = study_chunk(pRExC_state, &nscan, minnextp, &deltanext, 
4448                     last, &data_fake, stopparen, recursed, NULL, f,depth+1);
4449                 if (scan->flags) {
4450                     if (deltanext) {
4451                         FAIL("Variable length lookbehind not implemented");
4452                     }
4453                     else if (*minnextp > (I32)U8_MAX) {
4454                         FAIL2("Lookbehind longer than %"UVuf" not implemented", (UV)U8_MAX);
4455                     }
4456                     scan->flags = (U8)*minnextp;
4457                 }
4458
4459                 *minnextp += min;
4460
4461                 if (f & SCF_DO_STCLASS_AND) {
4462                     const int was = TEST_SSC_EOS(data.start_class);
4463
4464                     cl_and(data->start_class, &intrnl);
4465                     if (was)
4466                         SET_SSC_EOS(data->start_class);
4467                 }
4468                 if (data) {
4469                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4470                         pars++;
4471                     if (data_fake.flags & SF_HAS_EVAL)
4472                         data->flags |= SF_HAS_EVAL;
4473                     data->whilem_c = data_fake.whilem_c;
4474                     if ((flags & SCF_DO_SUBSTR) && data_fake.last_found) {
4475                         if (RExC_rx->minlen<*minnextp)
4476                             RExC_rx->minlen=*minnextp;
4477                         SCAN_COMMIT(pRExC_state, &data_fake, minnextp);
4478                         SvREFCNT_dec_NN(data_fake.last_found);
4479                         
4480                         if ( data_fake.minlen_fixed != minlenp ) 
4481                         {
4482                             data->offset_fixed= data_fake.offset_fixed;
4483                             data->minlen_fixed= data_fake.minlen_fixed;
4484                             data->lookbehind_fixed+= scan->flags;
4485                         }
4486                         if ( data_fake.minlen_float != minlenp )
4487                         {
4488                             data->minlen_float= data_fake.minlen_float;
4489                             data->offset_float_min=data_fake.offset_float_min;
4490                             data->offset_float_max=data_fake.offset_float_max;
4491                             data->lookbehind_float+= scan->flags;
4492                         }
4493                     }
4494                 }
4495             }
4496 #endif
4497         }
4498         else if (OP(scan) == OPEN) {
4499             if (stopparen != (I32)ARG(scan))
4500                 pars++;
4501         }
4502         else if (OP(scan) == CLOSE) {
4503             if (stopparen == (I32)ARG(scan)) {
4504                 break;
4505             }
4506             if ((I32)ARG(scan) == is_par) {
4507                 next = regnext(scan);
4508
4509                 if ( next && (OP(next) != WHILEM) && next < last)
4510                     is_par = 0;         /* Disable optimization */
4511             }
4512             if (data)
4513                 *(data->last_closep) = ARG(scan);
4514         }
4515         else if (OP(scan) == EVAL) {
4516                 if (data)
4517                     data->flags |= SF_HAS_EVAL;
4518         }
4519         else if ( PL_regkind[OP(scan)] == ENDLIKE ) {
4520             if (flags & SCF_DO_SUBSTR) {
4521                 SCAN_COMMIT(pRExC_state,data,minlenp);
4522                 flags &= ~SCF_DO_SUBSTR;
4523             }
4524             if (data && OP(scan)==ACCEPT) {
4525                 data->flags |= SCF_SEEN_ACCEPT;
4526                 if (stopmin > min)
4527                     stopmin = min;
4528             }
4529         }
4530         else if (OP(scan) == LOGICAL && scan->flags == 2) /* Embedded follows */
4531         {
4532                 if (flags & SCF_DO_SUBSTR) {
4533                     SCAN_COMMIT(pRExC_state,data,minlenp);
4534                     data->longest = &(data->longest_float);
4535                 }
4536                 is_inf = is_inf_internal = 1;
4537                 if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
4538                     cl_anything(pRExC_state, data->start_class);
4539                 flags &= ~SCF_DO_STCLASS;
4540         }
4541         else if (OP(scan) == GPOS) {
4542             if (!(RExC_rx->extflags & RXf_GPOS_FLOAT) &&
4543                 !(delta || is_inf || (data && data->pos_delta))) 
4544             {
4545                 if (!(RExC_rx->extflags & RXf_ANCH) && (flags & SCF_DO_SUBSTR))
4546                     RExC_rx->extflags |= RXf_ANCH_GPOS;
4547                 if (RExC_rx->gofs < (U32)min)
4548                     RExC_rx->gofs = min;
4549             } else {
4550                 RExC_rx->extflags |= RXf_GPOS_FLOAT;
4551                 RExC_rx->gofs = 0;
4552             }       
4553         }
4554 #ifdef TRIE_STUDY_OPT
4555 #ifdef FULL_TRIE_STUDY
4556         else if (PL_regkind[OP(scan)] == TRIE) {
4557             /* NOTE - There is similar code to this block above for handling
4558                BRANCH nodes on the initial study.  If you change stuff here
4559                check there too. */
4560             regnode *trie_node= scan;
4561             regnode *tail= regnext(scan);
4562             reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
4563             I32 max1 = 0, min1 = I32_MAX;
4564             struct regnode_charclass_class accum;
4565
4566             if (flags & SCF_DO_SUBSTR) /* XXXX Add !SUSPEND? */
4567                 SCAN_COMMIT(pRExC_state, data,minlenp); /* Cannot merge strings after this. */
4568             if (flags & SCF_DO_STCLASS)
4569                 cl_init_zero(pRExC_state, &accum);
4570                 
4571             if (!trie->jump) {
4572                 min1= trie->minlen;
4573                 max1= trie->maxlen;
4574             } else {
4575                 const regnode *nextbranch= NULL;
4576                 U32 word;
4577                 
4578                 for ( word=1 ; word <= trie->wordcount ; word++) 
4579                 {
4580                     I32 deltanext=0, minnext=0, f = 0, fake;
4581                     struct regnode_charclass_class this_class;
4582                     
4583                     data_fake.flags = 0;
4584                     if (data) {
4585                         data_fake.whilem_c = data->whilem_c;
4586                         data_fake.last_closep = data->last_closep;
4587                     }
4588                     else
4589                         data_fake.last_closep = &fake;
4590                     data_fake.pos_delta = delta;
4591                     if (flags & SCF_DO_STCLASS) {
4592                         cl_init(pRExC_state, &this_class);
4593                         data_fake.start_class = &this_class;
4594                         f = SCF_DO_STCLASS_AND;
4595                     }
4596                     if (flags & SCF_WHILEM_VISITED_POS)
4597                         f |= SCF_WHILEM_VISITED_POS;
4598     
4599                     if (trie->jump[word]) {
4600                         if (!nextbranch)
4601                             nextbranch = trie_node + trie->jump[0];
4602                         scan= trie_node + trie->jump[word];
4603                         /* We go from the jump point to the branch that follows
4604                            it. Note this means we need the vestigal unused branches
4605                            even though they arent otherwise used.
4606                          */
4607                         minnext = study_chunk(pRExC_state, &scan, minlenp, 
4608                             &deltanext, (regnode *)nextbranch, &data_fake, 
4609                             stopparen, recursed, NULL, f,depth+1);
4610                     }
4611                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
4612                         nextbranch= regnext((regnode*)nextbranch);
4613                     
4614                     if (min1 > (I32)(minnext + trie->minlen))
4615                         min1 = minnext + trie->minlen;
4616                     if (deltanext == I32_MAX) {
4617                         is_inf = is_inf_internal = 1;
4618                         max1 = I32_MAX;
4619                     } else if (max1 < (I32)(minnext + deltanext + trie->maxlen))
4620                         max1 = minnext + deltanext + trie->maxlen;
4621                     
4622                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4623                         pars++;
4624                     if (data_fake.flags & SCF_SEEN_ACCEPT) {
4625                         if ( stopmin > min + min1) 
4626                             stopmin = min + min1;
4627                         flags &= ~SCF_DO_SUBSTR;
4628                         if (data)
4629                             data->flags |= SCF_SEEN_ACCEPT;
4630                     }
4631                     if (data) {
4632                         if (data_fake.flags & SF_HAS_EVAL)
4633                             data->flags |= SF_HAS_EVAL;
4634                         data->whilem_c = data_fake.whilem_c;
4635                     }
4636                     if (flags & SCF_DO_STCLASS)
4637                         cl_or(pRExC_state, &accum, &this_class);
4638                 }
4639             }
4640             if (flags & SCF_DO_SUBSTR) {
4641                 data->pos_min += min1;
4642                 data->pos_delta += max1 - min1;
4643                 if (max1 != min1 || is_inf)
4644                     data->longest = &(data->longest_float);
4645             }
4646             min += min1;
4647             delta += max1 - min1;
4648             if (flags & SCF_DO_STCLASS_OR) {
4649                 cl_or(pRExC_state, data->start_class, &accum);
4650                 if (min1) {
4651                     cl_and(data->start_class, and_withp);
4652                     flags &= ~SCF_DO_STCLASS;
4653                 }
4654             }
4655             else if (flags & SCF_DO_STCLASS_AND) {
4656                 if (min1) {
4657                     cl_and(data->start_class, &accum);
4658                     flags &= ~SCF_DO_STCLASS;
4659                 }
4660                 else {
4661                     /* Switch to OR mode: cache the old value of
4662                      * data->start_class */
4663                     INIT_AND_WITHP;
4664                     StructCopy(data->start_class, and_withp,
4665                                struct regnode_charclass_class);
4666                     flags &= ~SCF_DO_STCLASS_AND;
4667                     StructCopy(&accum, data->start_class,
4668                                struct regnode_charclass_class);
4669                     flags |= SCF_DO_STCLASS_OR;
4670                     SET_SSC_EOS(data->start_class);
4671                 }
4672             }
4673             scan= tail;
4674             continue;
4675         }
4676 #else
4677         else if (PL_regkind[OP(scan)] == TRIE) {
4678             reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
4679             U8*bang=NULL;
4680             
4681             min += trie->minlen;
4682             delta += (trie->maxlen - trie->minlen);
4683             flags &= ~SCF_DO_STCLASS; /* xxx */
4684             if (flags & SCF_DO_SUBSTR) {
4685                 SCAN_COMMIT(pRExC_state,data,minlenp);  /* Cannot expect anything... */
4686                 data->pos_min += trie->minlen;
4687                 data->pos_delta += (trie->maxlen - trie->minlen);
4688                 if (trie->maxlen != trie->minlen)
4689                     data->longest = &(data->longest_float);
4690             }
4691             if (trie->jump) /* no more substrings -- for now /grr*/
4692                 flags &= ~SCF_DO_SUBSTR; 
4693         }
4694 #endif /* old or new */
4695 #endif /* TRIE_STUDY_OPT */
4696
4697         /* Else: zero-length, ignore. */
4698         scan = regnext(scan);
4699     }
4700     if (frame) {
4701         last = frame->last;
4702         scan = frame->next;
4703         stopparen = frame->stop;
4704         frame = frame->prev;
4705         goto fake_study_recurse;
4706     }
4707
4708   finish:
4709     assert(!frame);
4710     DEBUG_STUDYDATA("pre-fin:",data,depth);
4711
4712     *scanp = scan;
4713     *deltap = is_inf_internal ? I32_MAX : delta;
4714     if (flags & SCF_DO_SUBSTR && is_inf)
4715         data->pos_delta = I32_MAX - data->pos_min;
4716     if (is_par > (I32)U8_MAX)
4717         is_par = 0;
4718     if (is_par && pars==1 && data) {
4719         data->flags |= SF_IN_PAR;
4720         data->flags &= ~SF_HAS_PAR;
4721     }
4722     else if (pars && data) {
4723         data->flags |= SF_HAS_PAR;
4724         data->flags &= ~SF_IN_PAR;
4725     }
4726     if (flags & SCF_DO_STCLASS_OR)
4727         cl_and(data->start_class, and_withp);
4728     if (flags & SCF_TRIE_RESTUDY)
4729         data->flags |=  SCF_TRIE_RESTUDY;
4730     
4731     DEBUG_STUDYDATA("post-fin:",data,depth);
4732     
4733     return min < stopmin ? min : stopmin;
4734 }
4735
4736 STATIC U32
4737 S_add_data(RExC_state_t *pRExC_state, U32 n, const char *s)
4738 {
4739     U32 count = RExC_rxi->data ? RExC_rxi->data->count : 0;
4740
4741     PERL_ARGS_ASSERT_ADD_DATA;
4742
4743     Renewc(RExC_rxi->data,
4744            sizeof(*RExC_rxi->data) + sizeof(void*) * (count + n - 1),
4745            char, struct reg_data);
4746     if(count)
4747         Renew(RExC_rxi->data->what, count + n, U8);
4748     else
4749         Newx(RExC_rxi->data->what, n, U8);
4750     RExC_rxi->data->count = count + n;
4751     Copy(s, RExC_rxi->data->what + count, n, U8);
4752     return count;
4753 }
4754
4755 /*XXX: todo make this not included in a non debugging perl */
4756 #ifndef PERL_IN_XSUB_RE
4757 void
4758 Perl_reginitcolors(pTHX)
4759 {
4760     dVAR;
4761     const char * const s = PerlEnv_getenv("PERL_RE_COLORS");
4762     if (s) {
4763         char *t = savepv(s);
4764         int i = 0;
4765         PL_colors[0] = t;
4766         while (++i < 6) {
4767             t = strchr(t, '\t');
4768             if (t) {
4769                 *t = '\0';
4770                 PL_colors[i] = ++t;
4771             }
4772             else
4773                 PL_colors[i] = t = (char *)"";
4774         }
4775     } else {
4776         int i = 0;
4777         while (i < 6)
4778             PL_colors[i++] = (char *)"";
4779     }
4780     PL_colorset = 1;
4781 }
4782 #endif
4783
4784
4785 #ifdef TRIE_STUDY_OPT
4786 #define CHECK_RESTUDY_GOTO_butfirst(dOsomething)            \
4787     STMT_START {                                            \
4788         if (                                                \
4789               (data.flags & SCF_TRIE_RESTUDY)               \
4790               && ! restudied++                              \
4791         ) {                                                 \
4792             dOsomething;                                    \
4793             goto reStudy;                                   \
4794         }                                                   \
4795     } STMT_END
4796 #else
4797 #define CHECK_RESTUDY_GOTO_butfirst
4798 #endif        
4799
4800 /*
4801  * pregcomp - compile a regular expression into internal code
4802  *
4803  * Decides which engine's compiler to call based on the hint currently in
4804  * scope
4805  */
4806
4807 #ifndef PERL_IN_XSUB_RE 
4808
4809 /* return the currently in-scope regex engine (or the default if none)  */
4810
4811 regexp_engine const *
4812 Perl_current_re_engine(pTHX)
4813 {
4814     dVAR;
4815
4816     if (IN_PERL_COMPILETIME) {
4817         HV * const table = GvHV(PL_hintgv);
4818         SV **ptr;
4819
4820         if (!table)
4821             return &PL_core_reg_engine;
4822         ptr = hv_fetchs(table, "regcomp", FALSE);
4823         if ( !(ptr && SvIOK(*ptr) && SvIV(*ptr)))
4824             return &PL_core_reg_engine;
4825         return INT2PTR(regexp_engine*,SvIV(*ptr));
4826     }
4827     else {
4828         SV *ptr;
4829         if (!PL_curcop->cop_hints_hash)
4830             return &PL_core_reg_engine;
4831         ptr = cop_hints_fetch_pvs(PL_curcop, "regcomp", 0);
4832         if ( !(ptr && SvIOK(ptr) && SvIV(ptr)))
4833             return &PL_core_reg_engine;
4834         return INT2PTR(regexp_engine*,SvIV(ptr));
4835     }
4836 }
4837
4838
4839 REGEXP *
4840 Perl_pregcomp(pTHX_ SV * const pattern, const U32 flags)
4841 {
4842     dVAR;
4843     regexp_engine const *eng = current_re_engine();
4844     GET_RE_DEBUG_FLAGS_DECL;
4845
4846     PERL_ARGS_ASSERT_PREGCOMP;
4847
4848     /* Dispatch a request to compile a regexp to correct regexp engine. */
4849     DEBUG_COMPILE_r({
4850         PerlIO_printf(Perl_debug_log, "Using engine %"UVxf"\n",
4851                         PTR2UV(eng));
4852     });
4853     return CALLREGCOMP_ENG(eng, pattern, flags);
4854 }
4855 #endif
4856
4857 /* public(ish) entry point for the perl core's own regex compiling code.
4858  * It's actually a wrapper for Perl_re_op_compile that only takes an SV
4859  * pattern rather than a list of OPs, and uses the internal engine rather
4860  * than the current one */
4861
4862 REGEXP *
4863 Perl_re_compile(pTHX_ SV * const pattern, U32 rx_flags)
4864 {
4865     SV *pat = pattern; /* defeat constness! */
4866     PERL_ARGS_ASSERT_RE_COMPILE;
4867     return Perl_re_op_compile(aTHX_ &pat, 1, NULL,
4868 #ifdef PERL_IN_XSUB_RE
4869                                 &my_reg_engine,
4870 #else
4871                                 &PL_core_reg_engine,
4872 #endif
4873                                 NULL, NULL, rx_flags, 0);
4874 }
4875
4876
4877 /* upgrade pattern pat_p of length plen_p to UTF8, and if there are code
4878  * blocks, recalculate the indices. Update pat_p and plen_p in-place to
4879  * point to the realloced string and length.
4880  *
4881  * This is essentially a copy of Perl_bytes_to_utf8() with the code index
4882  * stuff added */
4883
4884 static void
4885 S_pat_upgrade_to_utf8(pTHX_ RExC_state_t * const pRExC_state,
4886                     char **pat_p, STRLEN *plen_p, int num_code_blocks)
4887 {
4888     U8 *const src = (U8*)*pat_p;
4889     U8 *dst;
4890     int n=0;
4891     STRLEN s = 0, d = 0;
4892     bool do_end = 0;
4893     GET_RE_DEBUG_FLAGS_DECL;
4894
4895     DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log,
4896         "UTF8 mismatch! Converting to utf8 for resizing and compile\n"));
4897
4898     Newx(dst, *plen_p * 2 + 1, U8);
4899
4900     while (s < *plen_p) {
4901         const UV uv = NATIVE_TO_ASCII(src[s]);
4902         if (UNI_IS_INVARIANT(uv))
4903             dst[d]   = (U8)UTF_TO_NATIVE(uv);
4904         else {
4905             dst[d++] = (U8)UTF8_EIGHT_BIT_HI(uv);
4906             dst[d]   = (U8)UTF8_EIGHT_BIT_LO(uv);
4907         }
4908         if (n < num_code_blocks) {
4909             if (!do_end && pRExC_state->code_blocks[n].start == s) {
4910                 pRExC_state->code_blocks[n].start = d;
4911                 assert(dst[d] == '(');
4912                 do_end = 1;
4913             }
4914             else if (do_end && pRExC_state->code_blocks[n].end == s) {
4915                 pRExC_state->code_blocks[n].end = d;
4916                 assert(dst[d] == ')');
4917                 do_end = 0;
4918                 n++;
4919             }
4920         }
4921         s++;
4922         d++;
4923     }
4924     dst[d] = '\0';
4925     *plen_p = d;
4926     *pat_p = (char*) dst;
4927     SAVEFREEPV(*pat_p);
4928     RExC_orig_utf8 = RExC_utf8 = 1;
4929 }
4930
4931
4932
4933 /* S_concat_pat(): concatenate a list of args to the pattern string pat,
4934  * while recording any code block indices, and handling overloading,
4935  * nested qr// objects etc.  If pat is null, it will allocate a new
4936  * string, or just return the first arg, if there's only one.
4937  *
4938  * Returns the malloced/updated pat.
4939  * patternp and pat_count is the array of SVs to be concatted;
4940  * oplist is the optional list of ops that generated the SVs;
4941  * recompile_p is a pointer to a boolean that will be set if
4942  *   the regex will need to be recompiled.
4943  * delim, if non-null is an SV that will be inserted between each element
4944  */
4945
4946 static SV*
4947 S_concat_pat(pTHX_ RExC_state_t * const pRExC_state,
4948                 SV *pat, SV ** const patternp, int pat_count,
4949                 OP *oplist, bool *recompile_p, SV *delim)
4950 {
4951     SV **svp;
4952     int n = 0;
4953     bool use_delim = FALSE;
4954     bool alloced = FALSE;
4955
4956     /* if we know we have at least two args, create an empty string,
4957      * then concatenate args to that. For no args, return an empty string */
4958     if (!pat && pat_count != 1) {
4959         pat = newSVpvn("", 0);
4960         SAVEFREESV(pat);
4961         alloced = TRUE;
4962     }
4963
4964     for (svp = patternp; svp < patternp + pat_count; svp++) {
4965         SV *sv;
4966         SV *rx  = NULL;
4967         STRLEN orig_patlen = 0;
4968         bool code = 0;
4969         SV *msv = use_delim ? delim : *svp;
4970
4971         /* if we've got a delimiter, we go round the loop twice for each
4972          * svp slot (except the last), using the delimiter the second
4973          * time round */
4974         if (use_delim) {
4975             svp--;
4976             use_delim = FALSE;
4977         }
4978         else if (delim)
4979             use_delim = TRUE;
4980
4981         if (SvTYPE(msv) == SVt_PVAV) {
4982             /* we've encountered an interpolated array within
4983              * the pattern, e.g. /...@a..../. Expand the list of elements,
4984              * then recursively append elements.
4985              * The code in this block is based on S_pushav() */
4986
4987             AV *const av = (AV*)msv;
4988             const I32 maxarg = AvFILL(av) + 1;
4989             SV **array;
4990
4991             if (oplist) {
4992                 assert(oplist->op_type == OP_PADAV
4993                     || oplist->op_type == OP_RV2AV); 
4994                 oplist = oplist->op_sibling;;
4995             }
4996
4997             if (SvRMAGICAL(av)) {
4998                 U32 i;
4999
5000                 Newx(array, maxarg, SV*);
5001                 SAVEFREEPV(array);
5002                 for (i=0; i < (U32)maxarg; i++) {
5003                     SV ** const svp = av_fetch(av, i, FALSE);
5004                     array[i] = svp ? *svp : &PL_sv_undef;
5005                 }
5006             }
5007             else
5008                 array = AvARRAY(av);
5009
5010             pat = S_concat_pat(aTHX_ pRExC_state, pat,
5011                                 array, maxarg, NULL, recompile_p,
5012                                 /* $" */
5013                                 GvSV((gv_fetchpvs("\"", GV_ADDMULTI, SVt_PV))));
5014
5015             continue;
5016         }
5017
5018
5019         /* we make the assumption here that each op in the list of
5020          * op_siblings maps to one SV pushed onto the stack,
5021          * except for code blocks, with have both an OP_NULL and
5022          * and OP_CONST.
5023          * This allows us to match up the list of SVs against the
5024          * list of OPs to find the next code block.
5025          *
5026          * Note that       PUSHMARK PADSV PADSV ..
5027          * is optimised to
5028          *                 PADRANGE PADSV  PADSV  ..
5029          * so the alignment still works. */
5030
5031         if (oplist) {
5032             if (oplist->op_type == OP_NULL
5033                 && (oplist->op_flags & OPf_SPECIAL))
5034             {
5035                 assert(n < pRExC_state->num_code_blocks);
5036                 pRExC_state->code_blocks[n].start = pat ? SvCUR(pat) : 0;
5037                 pRExC_state->code_blocks[n].block = oplist;
5038                 pRExC_state->code_blocks[n].src_regex = NULL;
5039                 n++;
5040                 code = 1;
5041                 oplist = oplist->op_sibling; /* skip CONST */
5042                 assert(oplist);
5043             }
5044             oplist = oplist->op_sibling;;
5045         }
5046
5047         /* apply magic and QR overloading to arg */
5048
5049         SvGETMAGIC(msv);
5050         if (SvROK(msv) && SvAMAGIC(msv)) {
5051             SV *sv = AMG_CALLunary(msv, regexp_amg);
5052             if (sv) {
5053                 if (SvROK(sv))
5054                     sv = SvRV(sv);
5055                 if (SvTYPE(sv) != SVt_REGEXP)
5056                     Perl_croak(aTHX_ "Overloaded qr did not return a REGEXP");
5057                 msv = sv;
5058             }
5059         }
5060
5061         /* try concatenation overload ... */
5062         if (pat && (SvAMAGIC(pat) || SvAMAGIC(msv)) &&
5063                 (sv = amagic_call(pat, msv, concat_amg, AMGf_assign)))
5064         {
5065             sv_setsv(pat, sv);
5066             /* overloading involved: all bets are off over literal
5067              * code. Pretend we haven't seen it */
5068             pRExC_state->num_code_blocks -= n;
5069             n = 0;
5070         }
5071         else  {
5072             /* ... or failing that, try "" overload */
5073             while (SvAMAGIC(msv)
5074                     && (sv = AMG_CALLunary(msv, string_amg))
5075                     && sv != msv
5076                     &&  !(   SvROK(msv)
5077                           && SvROK(sv)
5078                           && SvRV(msv) == SvRV(sv))
5079             ) {
5080                 msv = sv;
5081                 SvGETMAGIC(msv);
5082             }
5083             if (SvROK(msv) && SvTYPE(SvRV(msv)) == SVt_REGEXP)
5084                 msv = SvRV(msv);
5085
5086             if (pat) {
5087                 /* this is a partially unrolled
5088                  *     sv_catsv_nomg(pat, msv);
5089                  * that allows us to adjust code block indices if
5090                  * needed */
5091                 STRLEN dlen;
5092                 char *dst = SvPV_force_nomg(pat, dlen);
5093                 orig_patlen = dlen;
5094                 if (SvUTF8(msv) && !SvUTF8(pat)) {
5095                     S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &dst, &dlen, n);
5096                     sv_setpvn(pat, dst, dlen);
5097                     SvUTF8_on(pat);
5098                 }
5099                 sv_catsv_nomg(pat, msv);
5100                 rx = msv;
5101             }
5102             else
5103                 pat = msv;
5104
5105             if (code)
5106                 pRExC_state->code_blocks[n-1].end = SvCUR(pat)-1;
5107         }
5108
5109         /* extract any code blocks within any embedded qr//'s */
5110         if (rx && SvTYPE(rx) == SVt_REGEXP
5111             && RX_ENGINE((REGEXP*)rx)->op_comp)
5112         {
5113
5114             RXi_GET_DECL(ReANY((REGEXP *)rx), ri);
5115             if (ri->num_code_blocks) {
5116                 int i;
5117                 /* the presence of an embedded qr// with code means
5118                  * we should always recompile: the text of the
5119                  * qr// may not have changed, but it may be a
5120                  * different closure than last time */
5121                 *recompile_p = 1;
5122                 Renew(pRExC_state->code_blocks,
5123                     pRExC_state->num_code_blocks + ri->num_code_blocks,
5124                     struct reg_code_block);
5125                 pRExC_state->num_code_blocks += ri->num_code_blocks;
5126
5127                 for (i=0; i < ri->num_code_blocks; i++) {
5128                     struct reg_code_block *src, *dst;
5129                     STRLEN offset =  orig_patlen
5130                         + ReANY((REGEXP *)rx)->pre_prefix;
5131                     assert(n < pRExC_state->num_code_blocks);
5132                     src = &ri->code_blocks[i];
5133                     dst = &pRExC_state->code_blocks[n];
5134                     dst->start      = src->start + offset;
5135                     dst->end        = src->end   + offset;
5136                     dst->block      = src->block;
5137                     dst->src_regex  = (REGEXP*) SvREFCNT_inc( (SV*)
5138                                             src->src_regex
5139                                                 ? src->src_regex
5140                                                 : (REGEXP*)rx);
5141                     n++;
5142                 }
5143             }
5144         }
5145     }
5146     /* avoid calling magic multiple times on a single element e.g. =~ $qr */
5147     if (alloced)
5148         SvSETMAGIC(pat);
5149
5150     return pat;
5151 }
5152
5153
5154
5155 /* see if there are any run-time code blocks in the pattern.
5156  * False positives are allowed */
5157
5158 static bool
5159 S_has_runtime_code(pTHX_ RExC_state_t * const pRExC_state,
5160                     char *pat, STRLEN plen)
5161 {
5162     int n = 0;
5163     STRLEN s;
5164
5165     for (s = 0; s < plen; s++) {
5166         if (n < pRExC_state->num_code_blocks
5167             && s == pRExC_state->code_blocks[n].start)
5168         {
5169             s = pRExC_state->code_blocks[n].end;
5170             n++;
5171             continue;
5172         }
5173         /* TODO ideally should handle [..], (#..), /#.../x to reduce false
5174          * positives here */
5175         if (pat[s] == '(' && s+2 <= plen && pat[s+1] == '?' &&
5176             (pat[s+2] == '{'
5177                 || (s + 2 <= plen && pat[s+2] == '?' && pat[s+3] == '{'))
5178         )
5179             return 1;
5180     }
5181     return 0;
5182 }
5183
5184 /* Handle run-time code blocks. We will already have compiled any direct
5185  * or indirect literal code blocks. Now, take the pattern 'pat' and make a
5186  * copy of it, but with any literal code blocks blanked out and
5187  * appropriate chars escaped; then feed it into
5188  *
5189  *    eval "qr'modified_pattern'"
5190  *
5191  * For example,
5192  *
5193  *       a\bc(?{"this was literal"})def'ghi\\jkl(?{"this is runtime"})mno
5194  *
5195  * becomes
5196  *
5197  *    qr'a\\bc_______________________def\'ghi\\\\jkl(?{"this is runtime"})mno'
5198  *
5199  * After eval_sv()-ing that, grab any new code blocks from the returned qr
5200  * and merge them with any code blocks of the original regexp.
5201  *
5202  * If the pat is non-UTF8, while the evalled qr is UTF8, don't merge;
5203  * instead, just save the qr and return FALSE; this tells our caller that
5204  * the original pattern needs upgrading to utf8.
5205  */
5206
5207 static bool
5208 S_compile_runtime_code(pTHX_ RExC_state_t * const pRExC_state,
5209     char *pat, STRLEN plen)
5210 {
5211     SV *qr;
5212
5213     GET_RE_DEBUG_FLAGS_DECL;
5214
5215     if (pRExC_state->runtime_code_qr) {
5216         /* this is the second time we've been called; this should
5217          * only happen if the main pattern got upgraded to utf8
5218          * during compilation; re-use the qr we compiled first time
5219          * round (which should be utf8 too)
5220          */
5221         qr = pRExC_state->runtime_code_qr;
5222         pRExC_state->runtime_code_qr = NULL;
5223         assert(RExC_utf8 && SvUTF8(qr));
5224     }
5225     else {
5226         int n = 0;
5227         STRLEN s;
5228         char *p, *newpat;
5229         int newlen = plen + 6; /* allow for "qr''x\0" extra chars */
5230         SV *sv, *qr_ref;
5231         dSP;
5232
5233         /* determine how many extra chars we need for ' and \ escaping */
5234         for (s = 0; s < plen; s++) {
5235             if (pat[s] == '\'' || pat[s] == '\\')
5236                 newlen++;
5237         }
5238
5239         Newx(newpat, newlen, char);
5240         p = newpat;
5241         *p++ = 'q'; *p++ = 'r'; *p++ = '\'';
5242
5243         for (s = 0; s < plen; s++) {
5244             if (n < pRExC_state->num_code_blocks
5245                 && s == pRExC_state->code_blocks[n].start)
5246             {
5247                 /* blank out literal code block */
5248                 assert(pat[s] == '(');
5249                 while (s <= pRExC_state->code_blocks[n].end) {
5250                     *p++ = '_';
5251                     s++;
5252                 }
5253                 s--;
5254                 n++;
5255                 continue;
5256             }
5257             if (pat[s] == '\'' || pat[s] == '\\')
5258                 *p++ = '\\';
5259             *p++ = pat[s];
5260         }
5261         *p++ = '\'';
5262         if (pRExC_state->pm_flags & RXf_PMf_EXTENDED)
5263             *p++ = 'x';
5264         *p++ = '\0';
5265         DEBUG_COMPILE_r({
5266             PerlIO_printf(Perl_debug_log,
5267                 "%sre-parsing pattern for runtime code:%s %s\n",
5268                 PL_colors[4],PL_colors[5],newpat);
5269         });
5270
5271         sv = newSVpvn_flags(newpat, p-newpat-1, RExC_utf8 ? SVf_UTF8 : 0);
5272         Safefree(newpat);
5273
5274         ENTER;
5275         SAVETMPS;
5276         save_re_context();
5277         PUSHSTACKi(PERLSI_REQUIRE);
5278         /* G_RE_REPARSING causes the toker to collapse \\ into \ when
5279          * parsing qr''; normally only q'' does this. It also alters
5280          * hints handling */
5281         eval_sv(sv, G_SCALAR|G_RE_REPARSING);
5282         SvREFCNT_dec_NN(sv);
5283         SPAGAIN;
5284         qr_ref = POPs;
5285         PUTBACK;
5286         {
5287             SV * const errsv = ERRSV;
5288             if (SvTRUE_NN(errsv))
5289             {
5290                 Safefree(pRExC_state->code_blocks);
5291                 /* use croak_sv ? */
5292                 Perl_croak_nocontext("%s", SvPV_nolen_const(errsv));
5293             }
5294         }
5295         assert(SvROK(qr_ref));
5296         qr = SvRV(qr_ref);
5297         assert(SvTYPE(qr) == SVt_REGEXP && RX_ENGINE((REGEXP*)qr)->op_comp);
5298         /* the leaving below frees the tmp qr_ref.
5299          * Give qr a life of its own */
5300         SvREFCNT_inc(qr);
5301         POPSTACK;
5302         FREETMPS;
5303         LEAVE;
5304
5305     }
5306
5307     if (!RExC_utf8 && SvUTF8(qr)) {
5308         /* first time through; the pattern got upgraded; save the
5309          * qr for the next time through */
5310         assert(!pRExC_state->runtime_code_qr);
5311         pRExC_state->runtime_code_qr = qr;
5312         return 0;
5313     }
5314
5315
5316     /* extract any code blocks within the returned qr//  */
5317
5318
5319     /* merge the main (r1) and run-time (r2) code blocks into one */
5320     {
5321         RXi_GET_DECL(ReANY((REGEXP *)qr), r2);
5322         struct reg_code_block *new_block, *dst;
5323         RExC_state_t * const r1 = pRExC_state; /* convenient alias */
5324         int i1 = 0, i2 = 0;
5325
5326         if (!r2->num_code_blocks) /* we guessed wrong */
5327         {
5328             SvREFCNT_dec_NN(qr);
5329             return 1;
5330         }
5331
5332         Newx(new_block,
5333             r1->num_code_blocks + r2->num_code_blocks,
5334             struct reg_code_block);
5335         dst = new_block;
5336
5337         while (    i1 < r1->num_code_blocks
5338                 || i2 < r2->num_code_blocks)
5339         {
5340             struct reg_code_block *src;
5341             bool is_qr = 0;
5342
5343             if (i1 == r1->num_code_blocks) {
5344                 src = &r2->code_blocks[i2++];
5345                 is_qr = 1;
5346             }
5347             else if (i2 == r2->num_code_blocks)
5348                 src = &r1->code_blocks[i1++];
5349             else if (  r1->code_blocks[i1].start
5350                      < r2->code_blocks[i2].start)
5351             {
5352                 src = &r1->code_blocks[i1++];
5353                 assert(src->end < r2->code_blocks[i2].start);
5354             }
5355             else {
5356                 assert(  r1->code_blocks[i1].start
5357                        > r2->code_blocks[i2].start);
5358                 src = &r2->code_blocks[i2++];
5359                 is_qr = 1;
5360                 assert(src->end < r1->code_blocks[i1].start);
5361             }
5362
5363             assert(pat[src->start] == '(');
5364             assert(pat[src->end]   == ')');
5365             dst->start      = src->start;
5366             dst->end        = src->end;
5367             dst->block      = src->block;
5368             dst->src_regex  = is_qr ? (REGEXP*) SvREFCNT_inc( (SV*) qr)
5369                                     : src->src_regex;
5370             dst++;
5371         }
5372         r1->num_code_blocks += r2->num_code_blocks;
5373         Safefree(r1->code_blocks);
5374         r1->code_blocks = new_block;
5375     }
5376
5377     SvREFCNT_dec_NN(qr);
5378     return 1;
5379 }
5380
5381
5382 STATIC bool
5383 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)
5384 {
5385     /* This is the common code for setting up the floating and fixed length
5386      * string data extracted from Perl_re_op_compile() below.  Returns a boolean
5387      * as to whether succeeded or not */
5388
5389     I32 t,ml;
5390
5391     if (! (longest_length
5392            || (eol /* Can't have SEOL and MULTI */
5393                && (! meol || (RExC_flags & RXf_PMf_MULTILINE)))
5394           )
5395             /* See comments for join_exact for why REG_SEEN_EXACTF_SHARP_S */
5396         || (RExC_seen & REG_SEEN_EXACTF_SHARP_S))
5397     {
5398         return FALSE;
5399     }
5400
5401     /* copy the information about the longest from the reg_scan_data
5402         over to the program. */
5403     if (SvUTF8(sv_longest)) {
5404         *rx_utf8 = sv_longest;
5405         *rx_substr = NULL;
5406     } else {
5407         *rx_substr = sv_longest;
5408         *rx_utf8 = NULL;
5409     }
5410     /* end_shift is how many chars that must be matched that
5411         follow this item. We calculate it ahead of time as once the
5412         lookbehind offset is added in we lose the ability to correctly
5413         calculate it.*/
5414     ml = minlen ? *(minlen) : (I32)longest_length;
5415     *rx_end_shift = ml - offset
5416         - longest_length + (SvTAIL(sv_longest) != 0)
5417         + lookbehind;
5418
5419     t = (eol/* Can't have SEOL and MULTI */
5420          && (! meol || (RExC_flags & RXf_PMf_MULTILINE)));
5421     fbm_compile(sv_longest, t ? FBMcf_TAIL : 0);
5422
5423     return TRUE;
5424 }
5425
5426 /*
5427  * Perl_re_op_compile - the perl internal RE engine's function to compile a
5428  * regular expression into internal code.
5429  * The pattern may be passed either as:
5430  *    a list of SVs (patternp plus pat_count)
5431  *    a list of OPs (expr)
5432  * If both are passed, the SV list is used, but the OP list indicates
5433  * which SVs are actually pre-compiled code blocks
5434  *
5435  * The SVs in the list have magic and qr overloading applied to them (and
5436  * the list may be modified in-place with replacement SVs in the latter
5437  * case).
5438  *
5439  * If the pattern hasn't changed from old_re, then old_re will be
5440  * returned.
5441  *
5442  * eng is the current engine. If that engine has an op_comp method, then
5443  * handle directly (i.e. we assume that op_comp was us); otherwise, just
5444  * do the initial concatenation of arguments and pass on to the external
5445  * engine.
5446  *
5447  * If is_bare_re is not null, set it to a boolean indicating whether the
5448  * arg list reduced (after overloading) to a single bare regex which has
5449  * been returned (i.e. /$qr/).
5450  *
5451  * orig_rx_flags contains RXf_* flags. See perlreapi.pod for more details.
5452  *
5453  * pm_flags contains the PMf_* flags, typically based on those from the
5454  * pm_flags field of the related PMOP. Currently we're only interested in
5455  * PMf_HAS_CV, PMf_IS_QR, PMf_USE_RE_EVAL.
5456  *
5457  * We can't allocate space until we know how big the compiled form will be,
5458  * but we can't compile it (and thus know how big it is) until we've got a
5459  * place to put the code.  So we cheat:  we compile it twice, once with code
5460  * generation turned off and size counting turned on, and once "for real".
5461  * This also means that we don't allocate space until we are sure that the
5462  * thing really will compile successfully, and we never have to move the
5463  * code and thus invalidate pointers into it.  (Note that it has to be in
5464  * one piece because free() must be able to free it all.) [NB: not true in perl]
5465  *
5466  * Beware that the optimization-preparation code in here knows about some
5467  * of the structure of the compiled regexp.  [I'll say.]
5468  */
5469
5470 REGEXP *
5471 Perl_re_op_compile(pTHX_ SV ** const patternp, int pat_count,
5472                     OP *expr, const regexp_engine* eng, REGEXP *old_re,
5473                      bool *is_bare_re, U32 orig_rx_flags, U32 pm_flags)
5474 {
5475     dVAR;
5476     REGEXP *rx;
5477     struct regexp *r;
5478     regexp_internal *ri;
5479     STRLEN plen;
5480     char *exp;
5481     regnode *scan;
5482     I32 flags;
5483     I32 minlen = 0;
5484     U32 rx_flags;
5485     SV *pat;
5486     SV *code_blocksv = NULL;
5487     SV** new_patternp = patternp;
5488
5489     /* these are all flags - maybe they should be turned
5490      * into a single int with different bit masks */
5491     I32 sawlookahead = 0;
5492     I32 sawplus = 0;
5493     I32 sawopen = 0;
5494     regex_charset initial_charset = get_regex_charset(orig_rx_flags);
5495     bool recompile = 0;
5496     bool runtime_code = 0;
5497     scan_data_t data;
5498     RExC_state_t RExC_state;
5499     RExC_state_t * const pRExC_state = &RExC_state;
5500 #ifdef TRIE_STUDY_OPT    
5501     int restudied = 0;
5502     RExC_state_t copyRExC_state;
5503 #endif    
5504     GET_RE_DEBUG_FLAGS_DECL;
5505
5506     PERL_ARGS_ASSERT_RE_OP_COMPILE;
5507
5508     DEBUG_r(if (!PL_colorset) reginitcolors());
5509
5510 #ifndef PERL_IN_XSUB_RE
5511     /* Initialize these here instead of as-needed, as is quick and avoids
5512      * having to test them each time otherwise */
5513     if (! PL_AboveLatin1) {
5514         PL_AboveLatin1 = _new_invlist_C_array(AboveLatin1_invlist);
5515         PL_ASCII = _new_invlist_C_array(ASCII_invlist);
5516         PL_Latin1 = _new_invlist_C_array(Latin1_invlist);
5517
5518         PL_L1Posix_ptrs[_CC_ALPHANUMERIC]
5519                                 = _new_invlist_C_array(L1PosixAlnum_invlist);
5520         PL_Posix_ptrs[_CC_ALPHANUMERIC]
5521                                 = _new_invlist_C_array(PosixAlnum_invlist);
5522
5523         PL_L1Posix_ptrs[_CC_ALPHA]
5524                                 = _new_invlist_C_array(L1PosixAlpha_invlist);
5525         PL_Posix_ptrs[_CC_ALPHA] = _new_invlist_C_array(PosixAlpha_invlist);
5526
5527         PL_Posix_ptrs[_CC_BLANK] = _new_invlist_C_array(PosixBlank_invlist);
5528         PL_XPosix_ptrs[_CC_BLANK] = _new_invlist_C_array(XPosixBlank_invlist);
5529
5530         /* Cased is the same as Alpha in the ASCII range */
5531         PL_L1Posix_ptrs[_CC_CASED] =  _new_invlist_C_array(L1Cased_invlist);
5532         PL_Posix_ptrs[_CC_CASED] =  _new_invlist_C_array(PosixAlpha_invlist);
5533
5534         PL_Posix_ptrs[_CC_CNTRL] = _new_invlist_C_array(PosixCntrl_invlist);
5535         PL_XPosix_ptrs[_CC_CNTRL] = _new_invlist_C_array(XPosixCntrl_invlist);
5536
5537         PL_Posix_ptrs[_CC_DIGIT] = _new_invlist_C_array(PosixDigit_invlist);
5538         PL_L1Posix_ptrs[_CC_DIGIT] = _new_invlist_C_array(PosixDigit_invlist);
5539
5540         PL_L1Posix_ptrs[_CC_GRAPH] = _new_invlist_C_array(L1PosixGraph_invlist);
5541         PL_Posix_ptrs[_CC_GRAPH] = _new_invlist_C_array(PosixGraph_invlist);
5542
5543         PL_L1Posix_ptrs[_CC_LOWER] = _new_invlist_C_array(L1PosixLower_invlist);
5544         PL_Posix_ptrs[_CC_LOWER] = _new_invlist_C_array(PosixLower_invlist);
5545
5546         PL_L1Posix_ptrs[_CC_PRINT] = _new_invlist_C_array(L1PosixPrint_invlist);
5547         PL_Posix_ptrs[_CC_PRINT] = _new_invlist_C_array(PosixPrint_invlist);
5548
5549         PL_L1Posix_ptrs[_CC_PUNCT] = _new_invlist_C_array(L1PosixPunct_invlist);
5550         PL_Posix_ptrs[_CC_PUNCT] = _new_invlist_C_array(PosixPunct_invlist);
5551
5552         PL_Posix_ptrs[_CC_SPACE] = _new_invlist_C_array(PerlSpace_invlist);
5553         PL_XPosix_ptrs[_CC_SPACE] = _new_invlist_C_array(XPerlSpace_invlist);
5554         PL_Posix_ptrs[_CC_PSXSPC] = _new_invlist_C_array(PosixSpace_invlist);
5555         PL_XPosix_ptrs[_CC_PSXSPC] = _new_invlist_C_array(XPosixSpace_invlist);
5556
5557         PL_L1Posix_ptrs[_CC_UPPER] = _new_invlist_C_array(L1PosixUpper_invlist);
5558         PL_Posix_ptrs[_CC_UPPER] = _new_invlist_C_array(PosixUpper_invlist);
5559
5560         PL_XPosix_ptrs[_CC_VERTSPACE] = _new_invlist_C_array(VertSpace_invlist);
5561
5562         PL_Posix_ptrs[_CC_WORDCHAR] = _new_invlist_C_array(PosixWord_invlist);
5563         PL_L1Posix_ptrs[_CC_WORDCHAR]
5564                                 = _new_invlist_C_array(L1PosixWord_invlist);
5565
5566         PL_Posix_ptrs[_CC_XDIGIT] = _new_invlist_C_array(PosixXDigit_invlist);
5567         PL_XPosix_ptrs[_CC_XDIGIT] = _new_invlist_C_array(XPosixXDigit_invlist);
5568
5569         PL_HasMultiCharFold = _new_invlist_C_array(_Perl_Multi_Char_Folds_invlist);
5570     }
5571 #endif
5572
5573     pRExC_state->code_blocks = NULL;
5574     pRExC_state->num_code_blocks = 0;
5575
5576     if (is_bare_re)
5577         *is_bare_re = FALSE;
5578
5579     if (expr && (expr->op_type == OP_LIST ||
5580                 (expr->op_type == OP_NULL && expr->op_targ == OP_LIST))) {
5581         /* allocate code_blocks if needed */
5582         OP *o;
5583         int ncode = 0;
5584
5585         for (o = cLISTOPx(expr)->op_first; o; o = o->op_sibling)
5586             if (o->op_type == OP_NULL && (o->op_flags & OPf_SPECIAL))
5587                 ncode++; /* count of DO blocks */
5588         if (ncode) {
5589             pRExC_state->num_code_blocks = ncode;
5590             Newx(pRExC_state->code_blocks, ncode, struct reg_code_block);
5591         }
5592     }
5593
5594     if (!pat_count) {
5595         /* compile-time pattern with just OP_CONSTs and DO blocks */
5596
5597         int n;
5598         OP *o;
5599
5600         /* find how many CONSTs there are */
5601         assert(expr);
5602         n = 0;
5603         if (expr->op_type == OP_CONST)
5604             n = 1;
5605         else
5606             for (o = cLISTOPx(expr)->op_first; o; o = o->op_sibling) {
5607                 if (o->op_type == OP_CONST)
5608                     n++;
5609             }
5610
5611         /* fake up an SV array */
5612
5613         assert(!new_patternp);
5614         Newx(new_patternp, n, SV*);
5615         SAVEFREEPV(new_patternp);
5616         pat_count = n;
5617
5618         n = 0;
5619         if (expr->op_type == OP_CONST)
5620             new_patternp[n] = cSVOPx_sv(expr);
5621         else
5622             for (o = cLISTOPx(expr)->op_first; o; o = o->op_sibling) {
5623                 if (o->op_type == OP_CONST)
5624                     new_patternp[n++] = cSVOPo_sv;
5625             }
5626
5627     }
5628
5629     DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log,
5630         "Assembling pattern from %d elements%s\n", pat_count,
5631             orig_rx_flags & RXf_SPLIT ? " for split" : ""));
5632
5633     /* set expr to the first arg op */
5634
5635     if (pRExC_state->num_code_blocks
5636          && expr->op_type != OP_CONST)
5637     {
5638             expr = cLISTOPx(expr)->op_first;
5639             assert(   expr->op_type == OP_PUSHMARK
5640                    || (expr->op_type == OP_NULL && expr->op_targ == OP_PUSHMARK)
5641                    || expr->op_type == OP_PADRANGE);
5642             expr = expr->op_sibling;
5643     }
5644
5645     pat = S_concat_pat(aTHX_ pRExC_state, NULL, new_patternp, pat_count,
5646                         expr, &recompile, NULL);
5647
5648     /* handle bare (possibly after overloading) regex: foo =~ $re */
5649     {
5650         SV *re = pat;
5651         if (SvROK(re))
5652             re = SvRV(re);
5653         if (SvTYPE(re) == SVt_REGEXP) {
5654             if (is_bare_re)
5655                 *is_bare_re = TRUE;
5656             SvREFCNT_inc(re);
5657             Safefree(pRExC_state->code_blocks);
5658             DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log,
5659                 "Precompiled pattern%s\n",
5660                     orig_rx_flags & RXf_SPLIT ? " for split" : ""));
5661
5662             return (REGEXP*)re;
5663         }
5664     }
5665
5666     exp = SvPV_nomg(pat, plen);
5667
5668     if (!eng->op_comp) {
5669         if ((SvUTF8(pat) && IN_BYTES)
5670                 || SvGMAGICAL(pat) || SvAMAGIC(pat))
5671         {
5672             /* make a temporary copy; either to convert to bytes,
5673              * or to avoid repeating get-magic / overloaded stringify */
5674             pat = newSVpvn_flags(exp, plen, SVs_TEMP |
5675                                         (IN_BYTES ? 0 : SvUTF8(pat)));
5676         }
5677         Safefree(pRExC_state->code_blocks);
5678         return CALLREGCOMP_ENG(eng, pat, orig_rx_flags);
5679     }
5680
5681     /* ignore the utf8ness if the pattern is 0 length */
5682     RExC_utf8 = RExC_orig_utf8 = (plen == 0 || IN_BYTES) ? 0 : SvUTF8(pat);
5683     RExC_uni_semantics = 0;
5684     RExC_contains_locale = 0;
5685     pRExC_state->runtime_code_qr = NULL;
5686
5687     DEBUG_COMPILE_r({
5688             SV *dsv= sv_newmortal();
5689             RE_PV_QUOTED_DECL(s, RExC_utf8, dsv, exp, plen, 60);
5690             PerlIO_printf(Perl_debug_log, "%sCompiling REx%s %s\n",
5691                           PL_colors[4],PL_colors[5],s);
5692         });
5693
5694   redo_first_pass:
5695     /* we jump here if we upgrade the pattern to utf8 and have to
5696      * recompile */
5697
5698     if ((pm_flags & PMf_USE_RE_EVAL)
5699                 /* this second condition covers the non-regex literal case,
5700                  * i.e.  $foo =~ '(?{})'. */
5701                 || (IN_PERL_COMPILETIME && (PL_hints & HINT_RE_EVAL))
5702     )
5703         runtime_code = S_has_runtime_code(aTHX_ pRExC_state, exp, plen);
5704
5705     /* return old regex if pattern hasn't changed */
5706     /* XXX: note in the below we have to check the flags as well as the pattern.
5707      *
5708      * Things get a touch tricky as we have to compare the utf8 flag independently
5709      * from the compile flags.
5710      */
5711
5712     if (   old_re
5713         && !recompile
5714         && !!RX_UTF8(old_re) == !!RExC_utf8
5715         && ( RX_COMPFLAGS(old_re) == ( orig_rx_flags & RXf_PMf_FLAGCOPYMASK ) )
5716         && RX_PRECOMP(old_re)
5717         && RX_PRELEN(old_re) == plen
5718         && memEQ(RX_PRECOMP(old_re), exp, plen)
5719         && !runtime_code /* with runtime code, always recompile */ )
5720     {
5721         Safefree(pRExC_state->code_blocks);
5722         return old_re;
5723     }
5724
5725     rx_flags = orig_rx_flags;
5726
5727     if (initial_charset == REGEX_LOCALE_CHARSET) {
5728         RExC_contains_locale = 1;
5729     }
5730     else if (RExC_utf8 && initial_charset == REGEX_DEPENDS_CHARSET) {
5731
5732         /* Set to use unicode semantics if the pattern is in utf8 and has the
5733          * 'depends' charset specified, as it means unicode when utf8  */
5734         set_regex_charset(&rx_flags, REGEX_UNICODE_CHARSET);
5735     }
5736
5737     RExC_precomp = exp;
5738     RExC_flags = rx_flags;
5739     RExC_pm_flags = pm_flags;
5740
5741     if (runtime_code) {
5742         if (TAINTING_get && TAINT_get)
5743             Perl_croak(aTHX_ "Eval-group in insecure regular expression");
5744
5745         if (!S_compile_runtime_code(aTHX_ pRExC_state, exp, plen)) {
5746             /* whoops, we have a non-utf8 pattern, whilst run-time code
5747              * got compiled as utf8. Try again with a utf8 pattern */
5748             S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &exp, &plen,
5749                                     pRExC_state->num_code_blocks);
5750             goto redo_first_pass;
5751         }
5752     }
5753     assert(!pRExC_state->runtime_code_qr);
5754
5755     RExC_sawback = 0;
5756
5757     RExC_seen = 0;
5758     RExC_in_lookbehind = 0;
5759     RExC_seen_zerolen = *exp == '^' ? -1 : 0;
5760     RExC_extralen = 0;
5761     RExC_override_recoding = 0;
5762     RExC_in_multi_char_class = 0;
5763
5764     /* First pass: determine size, legality. */
5765     RExC_parse = exp;
5766     RExC_start = exp;
5767     RExC_end = exp + plen;
5768     RExC_naughty = 0;
5769     RExC_npar = 1;
5770     RExC_nestroot = 0;
5771     RExC_size = 0L;
5772     RExC_emit = &PL_regdummy;
5773     RExC_whilem_seen = 0;
5774     RExC_open_parens = NULL;
5775     RExC_close_parens = NULL;
5776     RExC_opend = NULL;
5777     RExC_paren_names = NULL;
5778 #ifdef DEBUGGING
5779     RExC_paren_name_list = NULL;
5780 #endif
5781     RExC_recurse = NULL;
5782     RExC_recurse_count = 0;
5783     pRExC_state->code_index = 0;
5784
5785 #if 0 /* REGC() is (currently) a NOP at the first pass.
5786        * Clever compilers notice this and complain. --jhi */
5787     REGC((U8)REG_MAGIC, (char*)RExC_emit);
5788 #endif
5789     DEBUG_PARSE_r(
5790         PerlIO_printf(Perl_debug_log, "Starting first pass (sizing)\n");
5791         RExC_lastnum=0;
5792         RExC_lastparse=NULL;
5793     );
5794     /* reg may croak on us, not giving us a chance to free
5795        pRExC_state->code_blocks.  We cannot SAVEFREEPV it now, as we may
5796        need it to survive as long as the regexp (qr/(?{})/).
5797        We must check that code_blocksv is not already set, because we may
5798        have jumped back to restart the sizing pass. */
5799     if (pRExC_state->code_blocks && !code_blocksv) {
5800         code_blocksv = newSV_type(SVt_PV);
5801         SAVEFREESV(code_blocksv);
5802         SvPV_set(code_blocksv, (char *)pRExC_state->code_blocks);
5803         SvLEN_set(code_blocksv, 1); /*sufficient to make sv_clear free it*/
5804     }
5805     if (reg(pRExC_state, 0, &flags,1) == NULL) {
5806         /* It's possible to write a regexp in ascii that represents Unicode
5807         codepoints outside of the byte range, such as via \x{100}. If we
5808         detect such a sequence we have to convert the entire pattern to utf8
5809         and then recompile, as our sizing calculation will have been based
5810         on 1 byte == 1 character, but we will need to use utf8 to encode
5811         at least some part of the pattern, and therefore must convert the whole
5812         thing.
5813         -- dmq */
5814         if (flags & RESTART_UTF8) {
5815             S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &exp, &plen,
5816                                     pRExC_state->num_code_blocks);
5817             goto redo_first_pass;
5818         }
5819         Perl_croak(aTHX_ "panic: reg returned NULL to re_op_compile for sizing pass, flags=%#X", flags);
5820     }
5821     if (code_blocksv)
5822         SvLEN_set(code_blocksv,0); /* no you can't have it, sv_clear */
5823
5824     DEBUG_PARSE_r({
5825         PerlIO_printf(Perl_debug_log, 
5826             "Required size %"IVdf" nodes\n"
5827             "Starting second pass (creation)\n", 
5828             (IV)RExC_size);
5829         RExC_lastnum=0; 
5830         RExC_lastparse=NULL; 
5831     });
5832
5833     /* The first pass could have found things that force Unicode semantics */
5834     if ((RExC_utf8 || RExC_uni_semantics)
5835          && get_regex_charset(rx_flags) == REGEX_DEPENDS_CHARSET)
5836     {
5837         set_regex_charset(&rx_flags, REGEX_UNICODE_CHARSET);
5838     }
5839
5840     /* Small enough for pointer-storage convention?
5841        If extralen==0, this means that we will not need long jumps. */
5842     if (RExC_size >= 0x10000L && RExC_extralen)
5843         RExC_size += RExC_extralen;
5844     else
5845         RExC_extralen = 0;
5846     if (RExC_whilem_seen > 15)
5847         RExC_whilem_seen = 15;
5848
5849     /* Allocate space and zero-initialize. Note, the two step process 
5850        of zeroing when in debug mode, thus anything assigned has to 
5851        happen after that */
5852     rx = (REGEXP*) newSV_type(SVt_REGEXP);
5853     r = ReANY(rx);
5854     Newxc(ri, sizeof(regexp_internal) + (unsigned)RExC_size * sizeof(regnode),
5855          char, regexp_internal);
5856     if ( r == NULL || ri == NULL )
5857         FAIL("Regexp out of space");
5858 #ifdef DEBUGGING
5859     /* avoid reading uninitialized memory in DEBUGGING code in study_chunk() */
5860     Zero(ri, sizeof(regexp_internal) + (unsigned)RExC_size * sizeof(regnode), char);
5861 #else 
5862     /* bulk initialize base fields with 0. */
5863     Zero(ri, sizeof(regexp_internal), char);        
5864 #endif
5865
5866     /* non-zero initialization begins here */
5867     RXi_SET( r, ri );
5868     r->engine= eng;
5869     r->extflags = rx_flags;
5870     RXp_COMPFLAGS(r) = orig_rx_flags & RXf_PMf_FLAGCOPYMASK;
5871
5872     if (pm_flags & PMf_IS_QR) {
5873         ri->code_blocks = pRExC_state->code_blocks;
5874         ri->num_code_blocks = pRExC_state->num_code_blocks;
5875     }
5876     else
5877     {
5878         int n;
5879         for (n = 0; n < pRExC_state->num_code_blocks; n++)
5880             if (pRExC_state->code_blocks[n].src_regex)
5881                 SAVEFREESV(pRExC_state->code_blocks[n].src_regex);
5882         SAVEFREEPV(pRExC_state->code_blocks);
5883     }
5884
5885     {
5886         bool has_p     = ((r->extflags & RXf_PMf_KEEPCOPY) == RXf_PMf_KEEPCOPY);
5887         bool has_charset = (get_regex_charset(r->extflags) != REGEX_DEPENDS_CHARSET);
5888
5889         /* The caret is output if there are any defaults: if not all the STD
5890          * flags are set, or if no character set specifier is needed */
5891         bool has_default =
5892                     (((r->extflags & RXf_PMf_STD_PMMOD) != RXf_PMf_STD_PMMOD)
5893                     || ! has_charset);
5894         bool has_runon = ((RExC_seen & REG_SEEN_RUN_ON_COMMENT)==REG_SEEN_RUN_ON_COMMENT);
5895         U16 reganch = (U16)((r->extflags & RXf_PMf_STD_PMMOD)
5896                             >> RXf_PMf_STD_PMMOD_SHIFT);
5897         const char *fptr = STD_PAT_MODS;        /*"msix"*/
5898         char *p;
5899         /* Allocate for the worst case, which is all the std flags are turned
5900          * on.  If more precision is desired, we could do a population count of
5901          * the flags set.  This could be done with a small lookup table, or by
5902          * shifting, masking and adding, or even, when available, assembly
5903          * language for a machine-language population count.
5904          * We never output a minus, as all those are defaults, so are
5905          * covered by the caret */
5906         const STRLEN wraplen = plen + has_p + has_runon
5907             + has_default       /* If needs a caret */
5908
5909                 /* If needs a character set specifier */
5910             + ((has_charset) ? MAX_CHARSET_NAME_LENGTH : 0)
5911             + (sizeof(STD_PAT_MODS) - 1)
5912             + (sizeof("(?:)") - 1);
5913
5914         Newx(p, wraplen + 1, char); /* +1 for the ending NUL */
5915         r->xpv_len_u.xpvlenu_pv = p;
5916         if (RExC_utf8)
5917             SvFLAGS(rx) |= SVf_UTF8;
5918         *p++='('; *p++='?';
5919
5920         /* If a default, cover it using the caret */
5921         if (has_default) {
5922             *p++= DEFAULT_PAT_MOD;
5923         }
5924         if (has_charset) {
5925             STRLEN len;
5926             const char* const name = get_regex_charset_name(r->extflags, &len);
5927             Copy(name, p, len, char);
5928             p += len;
5929         }
5930         if (has_p)
5931             *p++ = KEEPCOPY_PAT_MOD; /*'p'*/
5932         {
5933             char ch;
5934             while((ch = *fptr++)) {
5935                 if(reganch & 1)
5936                     *p++ = ch;
5937                 reganch >>= 1;
5938             }
5939         }
5940
5941         *p++ = ':';
5942         Copy(RExC_precomp, p, plen, char);
5943         assert ((RX_WRAPPED(rx) - p) < 16);
5944         r->pre_prefix = p - RX_WRAPPED(rx);
5945         p += plen;
5946         if (has_runon)
5947             *p++ = '\n';
5948         *p++ = ')';
5949         *p = 0;
5950         SvCUR_set(rx, p - RX_WRAPPED(rx));
5951     }
5952
5953     r->intflags = 0;
5954     r->nparens = RExC_npar - 1; /* set early to validate backrefs */
5955     
5956     if (RExC_seen & REG_SEEN_RECURSE) {
5957         Newxz(RExC_open_parens, RExC_npar,regnode *);
5958         SAVEFREEPV(RExC_open_parens);
5959         Newxz(RExC_close_parens,RExC_npar,regnode *);
5960         SAVEFREEPV(RExC_close_parens);
5961     }
5962
5963     /* Useful during FAIL. */
5964 #ifdef RE_TRACK_PATTERN_OFFSETS
5965     Newxz(ri->u.offsets, 2*RExC_size+1, U32); /* MJD 20001228 */
5966     DEBUG_OFFSETS_r(PerlIO_printf(Perl_debug_log,
5967                           "%s %"UVuf" bytes for offset annotations.\n",
5968                           ri->u.offsets ? "Got" : "Couldn't get",
5969                           (UV)((2*RExC_size+1) * sizeof(U32))));
5970 #endif
5971     SetProgLen(ri,RExC_size);
5972     RExC_rx_sv = rx;
5973     RExC_rx = r;
5974     RExC_rxi = ri;
5975
5976     /* Second pass: emit code. */
5977     RExC_flags = rx_flags;      /* don't let top level (?i) bleed */
5978     RExC_pm_flags = pm_flags;
5979     RExC_parse = exp;
5980     RExC_end = exp + plen;
5981     RExC_naughty = 0;
5982     RExC_npar = 1;
5983     RExC_emit_start = ri->program;
5984     RExC_emit = ri->program;
5985     RExC_emit_bound = ri->program + RExC_size + 1;
5986     pRExC_state->code_index = 0;
5987
5988     REGC((U8)REG_MAGIC, (char*) RExC_emit++);
5989     if (reg(pRExC_state, 0, &flags,1) == NULL) {
5990         ReREFCNT_dec(rx);   
5991         Perl_croak(aTHX_ "panic: reg returned NULL to re_op_compile for generation pass, flags=%#X", flags);
5992     }
5993     /* XXXX To minimize changes to RE engine we always allocate
5994        3-units-long substrs field. */
5995     Newx(r->substrs, 1, struct reg_substr_data);
5996     if (RExC_recurse_count) {
5997         Newxz(RExC_recurse,RExC_recurse_count,regnode *);
5998         SAVEFREEPV(RExC_recurse);
5999     }
6000
6001 reStudy:
6002     r->minlen = minlen = sawlookahead = sawplus = sawopen = 0;
6003     Zero(r->substrs, 1, struct reg_substr_data);
6004
6005 #ifdef TRIE_STUDY_OPT
6006     if (!restudied) {
6007         StructCopy(&zero_scan_data, &data, scan_data_t);
6008         copyRExC_state = RExC_state;
6009     } else {
6010         U32 seen=RExC_seen;
6011         DEBUG_OPTIMISE_r(PerlIO_printf(Perl_debug_log,"Restudying\n"));
6012         
6013         RExC_state = copyRExC_state;
6014         if (seen & REG_TOP_LEVEL_BRANCHES) 
6015             RExC_seen |= REG_TOP_LEVEL_BRANCHES;
6016         else
6017             RExC_seen &= ~REG_TOP_LEVEL_BRANCHES;
6018         StructCopy(&zero_scan_data, &data, scan_data_t);
6019     }
6020 #else
6021     StructCopy(&zero_scan_data, &data, scan_data_t);
6022 #endif    
6023
6024     /* Dig out information for optimizations. */
6025     r->extflags = RExC_flags; /* was pm_op */
6026     /*dmq: removed as part of de-PMOP: pm->op_pmflags = RExC_flags; */
6027  
6028     if (UTF)
6029         SvUTF8_on(rx);  /* Unicode in it? */
6030     ri->regstclass = NULL;
6031     if (RExC_naughty >= 10)     /* Probably an expensive pattern. */
6032         r->intflags |= PREGf_NAUGHTY;
6033     scan = ri->program + 1;             /* First BRANCH. */
6034
6035     /* testing for BRANCH here tells us whether there is "must appear"
6036        data in the pattern. If there is then we can use it for optimisations */
6037     if (!(RExC_seen & REG_TOP_LEVEL_BRANCHES)) { /*  Only one top-level choice. */
6038         I32 fake;
6039         STRLEN longest_float_length, longest_fixed_length;
6040         struct regnode_charclass_class ch_class; /* pointed to by data */
6041         int stclass_flag;
6042         I32 last_close = 0; /* pointed to by data */
6043         regnode *first= scan;
6044         regnode *first_next= regnext(first);
6045         /*
6046          * Skip introductions and multiplicators >= 1
6047          * so that we can extract the 'meat' of the pattern that must 
6048          * match in the large if() sequence following.
6049          * NOTE that EXACT is NOT covered here, as it is normally
6050          * picked up by the optimiser separately. 
6051          *
6052          * This is unfortunate as the optimiser isnt handling lookahead
6053          * properly currently.
6054          *
6055          */
6056         while ((OP(first) == OPEN && (sawopen = 1)) ||
6057                /* An OR of *one* alternative - should not happen now. */
6058             (OP(first) == BRANCH && OP(first_next) != BRANCH) ||
6059             /* for now we can't handle lookbehind IFMATCH*/
6060             (OP(first) == IFMATCH && !first->flags && (sawlookahead = 1)) ||
6061             (OP(first) == PLUS) ||
6062             (OP(first) == MINMOD) ||
6063                /* An {n,m} with n>0 */
6064             (PL_regkind[OP(first)] == CURLY && ARG1(first) > 0) ||
6065             (OP(first) == NOTHING && PL_regkind[OP(first_next)] != END ))
6066         {
6067                 /* 
6068                  * the only op that could be a regnode is PLUS, all the rest
6069                  * will be regnode_1 or regnode_2.
6070                  *
6071                  */
6072                 if (OP(first) == PLUS)
6073                     sawplus = 1;
6074                 else
6075                     first += regarglen[OP(first)];
6076
6077                 first = NEXTOPER(first);
6078                 first_next= regnext(first);
6079         }
6080
6081         /* Starting-point info. */
6082       again:
6083         DEBUG_PEEP("first:",first,0);
6084         /* Ignore EXACT as we deal with it later. */
6085         if (PL_regkind[OP(first)] == EXACT) {
6086             if (OP(first) == EXACT)
6087                 NOOP;   /* Empty, get anchored substr later. */
6088             else
6089                 ri->regstclass = first;
6090         }
6091 #ifdef TRIE_STCLASS
6092         else if (PL_regkind[OP(first)] == TRIE &&
6093                 ((reg_trie_data *)ri->data->data[ ARG(first) ])->minlen>0) 
6094         {
6095             regnode *trie_op;
6096             /* this can happen only on restudy */
6097             if ( OP(first) == TRIE ) {
6098                 struct regnode_1 *trieop = (struct regnode_1 *)
6099                     PerlMemShared_calloc(1, sizeof(struct regnode_1));
6100                 StructCopy(first,trieop,struct regnode_1);
6101                 trie_op=(regnode *)trieop;
6102             } else {
6103                 struct regnode_charclass *trieop = (struct regnode_charclass *)
6104                     PerlMemShared_calloc(1, sizeof(struct regnode_charclass));
6105                 StructCopy(first,trieop,struct regnode_charclass);
6106                 trie_op=(regnode *)trieop;
6107             }
6108             OP(trie_op)+=2;
6109             make_trie_failtable(pRExC_state, (regnode *)first, trie_op, 0);
6110             ri->regstclass = trie_op;
6111         }
6112 #endif
6113         else if (REGNODE_SIMPLE(OP(first)))
6114             ri->regstclass = first;
6115         else if (PL_regkind[OP(first)] == BOUND ||
6116                  PL_regkind[OP(first)] == NBOUND)
6117             ri->regstclass = first;
6118         else if (PL_regkind[OP(first)] == BOL) {
6119             r->extflags |= (OP(first) == MBOL
6120                            ? RXf_ANCH_MBOL
6121                            : (OP(first) == SBOL
6122                               ? RXf_ANCH_SBOL
6123                               : RXf_ANCH_BOL));
6124             first = NEXTOPER(first);
6125             goto again;
6126         }
6127         else if (OP(first) == GPOS) {
6128             r->extflags |= RXf_ANCH_GPOS;
6129             first = NEXTOPER(first);
6130             goto again;
6131         }
6132         else if ((!sawopen || !RExC_sawback) &&
6133             (OP(first) == STAR &&
6134             PL_regkind[OP(NEXTOPER(first))] == REG_ANY) &&
6135             !(r->extflags & RXf_ANCH) && !pRExC_state->num_code_blocks)
6136         {
6137             /* turn .* into ^.* with an implied $*=1 */
6138             const int type =
6139                 (OP(NEXTOPER(first)) == REG_ANY)
6140                     ? RXf_ANCH_MBOL
6141                     : RXf_ANCH_SBOL;
6142             r->extflags |= type;
6143             r->intflags |= PREGf_IMPLICIT;
6144             first = NEXTOPER(first);
6145             goto again;
6146         }
6147         if (sawplus && !sawlookahead && (!sawopen || !RExC_sawback)
6148             && !pRExC_state->num_code_blocks) /* May examine pos and $& */
6149             /* x+ must match at the 1st pos of run of x's */
6150             r->intflags |= PREGf_SKIP;
6151
6152         /* Scan is after the zeroth branch, first is atomic matcher. */
6153 #ifdef TRIE_STUDY_OPT
6154         DEBUG_PARSE_r(
6155             if (!restudied)
6156                 PerlIO_printf(Perl_debug_log, "first at %"IVdf"\n",
6157                               (IV)(first - scan + 1))
6158         );
6159 #else
6160         DEBUG_PARSE_r(
6161             PerlIO_printf(Perl_debug_log, "first at %"IVdf"\n",
6162                 (IV)(first - scan + 1))
6163         );
6164 #endif
6165
6166
6167         /*
6168         * If there's something expensive in the r.e., find the
6169         * longest literal string that must appear and make it the
6170         * regmust.  Resolve ties in favor of later strings, since
6171         * the regstart check works with the beginning of the r.e.
6172         * and avoiding duplication strengthens checking.  Not a
6173         * strong reason, but sufficient in the absence of others.
6174         * [Now we resolve ties in favor of the earlier string if
6175         * it happens that c_offset_min has been invalidated, since the
6176         * earlier string may buy us something the later one won't.]
6177         */
6178
6179         data.longest_fixed = newSVpvs("");
6180         data.longest_float = newSVpvs("");
6181         data.last_found = newSVpvs("");
6182         data.longest = &(data.longest_fixed);
6183         ENTER_with_name("study_chunk");
6184         SAVEFREESV(data.longest_fixed);
6185         SAVEFREESV(data.longest_float);
6186         SAVEFREESV(data.last_found);
6187         first = scan;
6188         if (!ri->regstclass) {
6189             cl_init(pRExC_state, &ch_class);
6190             data.start_class = &ch_class;
6191             stclass_flag = SCF_DO_STCLASS_AND;
6192         } else                          /* XXXX Check for BOUND? */
6193             stclass_flag = 0;
6194         data.last_closep = &last_close;
6195         
6196         minlen = study_chunk(pRExC_state, &first, &minlen, &fake, scan + RExC_size, /* Up to end */
6197             &data, -1, NULL, NULL,
6198             SCF_DO_SUBSTR | SCF_WHILEM_VISITED_POS | stclass_flag,0);
6199
6200
6201         CHECK_RESTUDY_GOTO_butfirst(LEAVE_with_name("study_chunk"));
6202
6203
6204         if ( RExC_npar == 1 && data.longest == &(data.longest_fixed)
6205              && data.last_start_min == 0 && data.last_end > 0
6206              && !RExC_seen_zerolen
6207              && !(RExC_seen & REG_SEEN_VERBARG)
6208              && (!(RExC_seen & REG_SEEN_GPOS) || (r->extflags & RXf_ANCH_GPOS)))
6209             r->extflags |= RXf_CHECK_ALL;
6210         scan_commit(pRExC_state, &data,&minlen,0);
6211
6212         longest_float_length = CHR_SVLEN(data.longest_float);
6213
6214         if (! ((SvCUR(data.longest_fixed)  /* ok to leave SvCUR */
6215                    && data.offset_fixed == data.offset_float_min
6216                    && SvCUR(data.longest_fixed) == SvCUR(data.longest_float)))
6217             && S_setup_longest (aTHX_ pRExC_state,
6218                                     data.longest_float,
6219                                     &(r->float_utf8),
6220                                     &(r->float_substr),
6221                                     &(r->float_end_shift),
6222                                     data.lookbehind_float,
6223                                     data.offset_float_min,
6224                                     data.minlen_float,
6225                                     longest_float_length,
6226                                     cBOOL(data.flags & SF_FL_BEFORE_EOL),
6227                                     cBOOL(data.flags & SF_FL_BEFORE_MEOL)))
6228         {
6229             r->float_min_offset = data.offset_float_min - data.lookbehind_float;
6230             r->float_max_offset = data.offset_float_max;
6231             if (data.offset_float_max < I32_MAX) /* Don't offset infinity */
6232                 r->float_max_offset -= data.lookbehind_float;
6233             SvREFCNT_inc_simple_void_NN(data.longest_float);
6234         }
6235         else {
6236             r->float_substr = r->float_utf8 = NULL;
6237             longest_float_length = 0;
6238         }
6239
6240         longest_fixed_length = CHR_SVLEN(data.longest_fixed);
6241
6242         if (S_setup_longest (aTHX_ pRExC_state,
6243                                 data.longest_fixed,
6244                                 &(r->anchored_utf8),
6245                                 &(r->anchored_substr),
6246                                 &(r->anchored_end_shift),
6247                                 data.lookbehind_fixed,
6248                                 data.offset_fixed,
6249                                 data.minlen_fixed,
6250                                 longest_fixed_length,
6251                                 cBOOL(data.flags & SF_FIX_BEFORE_EOL),
6252                                 cBOOL(data.flags & SF_FIX_BEFORE_MEOL)))
6253         {
6254             r->anchored_offset = data.offset_fixed - data.lookbehind_fixed;
6255             SvREFCNT_inc_simple_void_NN(data.longest_fixed);
6256         }
6257         else {
6258             r->anchored_substr = r->anchored_utf8 = NULL;
6259             longest_fixed_length = 0;
6260         }
6261         LEAVE_with_name("study_chunk");
6262
6263         if (ri->regstclass
6264             && (OP(ri->regstclass) == REG_ANY || OP(ri->regstclass) == SANY))
6265             ri->regstclass = NULL;
6266
6267         if ((!(r->anchored_substr || r->anchored_utf8) || r->anchored_offset)
6268             && stclass_flag
6269             && ! TEST_SSC_EOS(data.start_class)
6270             && !cl_is_anything(data.start_class))
6271         {
6272             const U32 n = add_data(pRExC_state, 1, "f");
6273             OP(data.start_class) = ANYOF_SYNTHETIC;
6274
6275             Newx(RExC_rxi->data->data[n], 1,
6276                 struct regnode_charclass_class);
6277             StructCopy(data.start_class,
6278                        (struct regnode_charclass_class*)RExC_rxi->data->data[n],
6279                        struct regnode_charclass_class);
6280             ri->regstclass = (regnode*)RExC_rxi->data->data[n];
6281             r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
6282             DEBUG_COMPILE_r({ SV *sv = sv_newmortal();
6283                       regprop(r, sv, (regnode*)data.start_class);
6284                       PerlIO_printf(Perl_debug_log,
6285                                     "synthetic stclass \"%s\".\n",
6286                                     SvPVX_const(sv));});
6287         }
6288
6289         /* A temporary algorithm prefers floated substr to fixed one to dig more info. */
6290         if (longest_fixed_length > longest_float_length) {
6291             r->check_end_shift = r->anchored_end_shift;
6292             r->check_substr = r->anchored_substr;
6293             r->check_utf8 = r->anchored_utf8;
6294             r->check_offset_min = r->check_offset_max = r->anchored_offset;
6295             if (r->extflags & RXf_ANCH_SINGLE)
6296                 r->extflags |= RXf_NOSCAN;
6297         }
6298         else {
6299             r->check_end_shift = r->float_end_shift;
6300             r->check_substr = r->float_substr;
6301             r->check_utf8 = r->float_utf8;
6302             r->check_offset_min = r->float_min_offset;
6303             r->check_offset_max = r->float_max_offset;
6304         }
6305         /* XXXX Currently intuiting is not compatible with ANCH_GPOS.
6306            This should be changed ASAP!  */
6307         if ((r->check_substr || r->check_utf8) && !(r->extflags & RXf_ANCH_GPOS)) {
6308             r->extflags |= RXf_USE_INTUIT;
6309             if (SvTAIL(r->check_substr ? r->check_substr : r->check_utf8))
6310                 r->extflags |= RXf_INTUIT_TAIL;
6311         }
6312         /* XXX Unneeded? dmq (shouldn't as this is handled elsewhere)
6313         if ( (STRLEN)minlen < longest_float_length )
6314             minlen= longest_float_length;
6315         if ( (STRLEN)minlen < longest_fixed_length )
6316             minlen= longest_fixed_length;     
6317         */
6318     }
6319     else {
6320         /* Several toplevels. Best we can is to set minlen. */
6321         I32 fake;
6322         struct regnode_charclass_class ch_class;
6323         I32 last_close = 0;
6324
6325         DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log, "\nMulti Top Level\n"));
6326
6327         scan = ri->program + 1;
6328         cl_init(pRExC_state, &ch_class);
6329         data.start_class = &ch_class;
6330         data.last_closep = &last_close;
6331
6332         
6333         minlen = study_chunk(pRExC_state, &scan, &minlen, &fake, scan + RExC_size,
6334             &data, -1, NULL, NULL, SCF_DO_STCLASS_AND|SCF_WHILEM_VISITED_POS,0);
6335         
6336         CHECK_RESTUDY_GOTO_butfirst(NOOP);
6337
6338         r->check_substr = r->check_utf8 = r->anchored_substr = r->anchored_utf8
6339                 = r->float_substr = r->float_utf8 = NULL;
6340
6341         if (! TEST_SSC_EOS(data.start_class)
6342             && !cl_is_anything(data.start_class))
6343         {
6344             const U32 n = add_data(pRExC_state, 1, "f");
6345             OP(data.start_class) = ANYOF_SYNTHETIC;
6346
6347             Newx(RExC_rxi->data->data[n], 1,
6348                 struct regnode_charclass_class);
6349             StructCopy(data.start_class,
6350                        (struct regnode_charclass_class*)RExC_rxi->data->data[n],
6351                        struct regnode_charclass_class);
6352             ri->regstclass = (regnode*)RExC_rxi->data->data[n];
6353             r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
6354             DEBUG_COMPILE_r({ SV* sv = sv_newmortal();
6355                       regprop(r, sv, (regnode*)data.start_class);
6356                       PerlIO_printf(Perl_debug_log,
6357                                     "synthetic stclass \"%s\".\n",
6358                                     SvPVX_const(sv));});
6359         }
6360     }
6361
6362     /* Guard against an embedded (?=) or (?<=) with a longer minlen than
6363        the "real" pattern. */
6364     DEBUG_OPTIMISE_r({
6365         PerlIO_printf(Perl_debug_log,"minlen: %"IVdf" r->minlen:%"IVdf"\n",
6366                       (IV)minlen, (IV)r->minlen);
6367     });
6368     r->minlenret = minlen;
6369     if (r->minlen < minlen) 
6370         r->minlen = minlen;
6371     
6372     if (RExC_seen & REG_SEEN_GPOS)
6373         r->extflags |= RXf_GPOS_SEEN;
6374     if (RExC_seen & REG_SEEN_LOOKBEHIND)
6375         r->extflags |= RXf_NO_INPLACE_SUBST; /* inplace might break the lookbehind */
6376     if (pRExC_state->num_code_blocks)
6377         r->extflags |= RXf_EVAL_SEEN;
6378     if (RExC_seen & REG_SEEN_CANY)
6379         r->extflags |= RXf_CANY_SEEN;
6380     if (RExC_seen & REG_SEEN_VERBARG)
6381     {
6382         r->intflags |= PREGf_VERBARG_SEEN;
6383         r->extflags |= RXf_NO_INPLACE_SUBST; /* don't understand this! Yves */
6384     }
6385     if (RExC_seen & REG_SEEN_CUTGROUP)
6386         r->intflags |= PREGf_CUTGROUP_SEEN;
6387     if (pm_flags & PMf_USE_RE_EVAL)
6388         r->intflags |= PREGf_USE_RE_EVAL;
6389     if (RExC_paren_names)
6390         RXp_PAREN_NAMES(r) = MUTABLE_HV(SvREFCNT_inc(RExC_paren_names));
6391     else
6392         RXp_PAREN_NAMES(r) = NULL;
6393
6394     {
6395         regnode *first = ri->program + 1;
6396         U8 fop = OP(first);
6397         regnode *next = NEXTOPER(first);
6398         U8 nop = OP(next);
6399
6400         if (PL_regkind[fop] == NOTHING && nop == END)
6401             r->extflags |= RXf_NULL;
6402         else if (PL_regkind[fop] == BOL && nop == END)
6403             r->extflags |= RXf_START_ONLY;
6404         else if (fop == PLUS && PL_regkind[nop] == POSIXD && FLAGS(next) == _CC_SPACE && OP(regnext(first)) == END)
6405             r->extflags |= RXf_WHITE;
6406         else if ( r->extflags & RXf_SPLIT && fop == EXACT && STR_LEN(first) == 1 && *(STRING(first)) == ' ' && OP(regnext(first)) == END )
6407             r->extflags |= (RXf_SKIPWHITE|RXf_WHITE);
6408
6409     }
6410 #ifdef DEBUGGING
6411     if (RExC_paren_names) {
6412         ri->name_list_idx = add_data( pRExC_state, 1, "a" );
6413         ri->data->data[ri->name_list_idx] = (void*)SvREFCNT_inc(RExC_paren_name_list);
6414     } else
6415 #endif
6416         ri->name_list_idx = 0;
6417
6418     if (RExC_recurse_count) {
6419         for ( ; RExC_recurse_count ; RExC_recurse_count-- ) {
6420             const regnode *scan = RExC_recurse[RExC_recurse_count-1];
6421             ARG2L_SET( scan, RExC_open_parens[ARG(scan)-1] - scan );
6422         }
6423     }
6424     Newxz(r->offs, RExC_npar, regexp_paren_pair);
6425     /* assume we don't need to swap parens around before we match */
6426
6427     DEBUG_DUMP_r({
6428         PerlIO_printf(Perl_debug_log,"Final program:\n");
6429         regdump(r);
6430     });
6431 #ifdef RE_TRACK_PATTERN_OFFSETS
6432     DEBUG_OFFSETS_r(if (ri->u.offsets) {
6433         const U32 len = ri->u.offsets[0];
6434         U32 i;
6435         GET_RE_DEBUG_FLAGS_DECL;
6436         PerlIO_printf(Perl_debug_log, "Offsets: [%"UVuf"]\n\t", (UV)ri->u.offsets[0]);
6437         for (i = 1; i <= len; i++) {
6438             if (ri->u.offsets[i*2-1] || ri->u.offsets[i*2])
6439                 PerlIO_printf(Perl_debug_log, "%"UVuf":%"UVuf"[%"UVuf"] ",
6440                 (UV)i, (UV)ri->u.offsets[i*2-1], (UV)ri->u.offsets[i*2]);
6441             }
6442         PerlIO_printf(Perl_debug_log, "\n");
6443     });
6444 #endif
6445
6446 #ifdef USE_ITHREADS
6447     /* under ithreads the ?pat? PMf_USED flag on the pmop is simulated
6448      * by setting the regexp SV to readonly-only instead. If the
6449      * pattern's been recompiled, the USEDness should remain. */
6450     if (old_re && SvREADONLY(old_re))
6451         SvREADONLY_on(rx);
6452 #endif
6453     return rx;
6454 }
6455
6456
6457 SV*
6458 Perl_reg_named_buff(pTHX_ REGEXP * const rx, SV * const key, SV * const value,
6459                     const U32 flags)
6460 {
6461     PERL_ARGS_ASSERT_REG_NAMED_BUFF;
6462
6463     PERL_UNUSED_ARG(value);
6464
6465     if (flags & RXapif_FETCH) {
6466         return reg_named_buff_fetch(rx, key, flags);
6467     } else if (flags & (RXapif_STORE | RXapif_DELETE | RXapif_CLEAR)) {
6468         Perl_croak_no_modify();
6469         return NULL;
6470     } else if (flags & RXapif_EXISTS) {
6471         return reg_named_buff_exists(rx, key, flags)
6472             ? &PL_sv_yes
6473             : &PL_sv_no;
6474     } else if (flags & RXapif_REGNAMES) {
6475         return reg_named_buff_all(rx, flags);
6476     } else if (flags & (RXapif_SCALAR | RXapif_REGNAMES_COUNT)) {
6477         return reg_named_buff_scalar(rx, flags);
6478     } else {
6479         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff", (int)flags);
6480         return NULL;
6481     }
6482 }
6483
6484 SV*
6485 Perl_reg_named_buff_iter(pTHX_ REGEXP * const rx, const SV * const lastkey,
6486                          const U32 flags)
6487 {
6488     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ITER;
6489     PERL_UNUSED_ARG(lastkey);
6490
6491     if (flags & RXapif_FIRSTKEY)
6492         return reg_named_buff_firstkey(rx, flags);
6493     else if (flags & RXapif_NEXTKEY)
6494         return reg_named_buff_nextkey(rx, flags);
6495     else {
6496         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_iter", (int)flags);
6497         return NULL;
6498     }
6499 }
6500
6501 SV*
6502 Perl_reg_named_buff_fetch(pTHX_ REGEXP * const r, SV * const namesv,
6503                           const U32 flags)
6504 {
6505     AV *retarray = NULL;
6506     SV *ret;
6507     struct regexp *const rx = ReANY(r);
6508
6509     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FETCH;
6510
6511     if (flags & RXapif_ALL)
6512         retarray=newAV();
6513
6514     if (rx && RXp_PAREN_NAMES(rx)) {
6515         HE *he_str = hv_fetch_ent( RXp_PAREN_NAMES(rx), namesv, 0, 0 );
6516         if (he_str) {
6517             IV i;
6518             SV* sv_dat=HeVAL(he_str);
6519             I32 *nums=(I32*)SvPVX(sv_dat);
6520             for ( i=0; i<SvIVX(sv_dat); i++ ) {
6521                 if ((I32)(rx->nparens) >= nums[i]
6522                     && rx->offs[nums[i]].start != -1
6523                     && rx->offs[nums[i]].end != -1)
6524                 {
6525                     ret = newSVpvs("");
6526                     CALLREG_NUMBUF_FETCH(r,nums[i],ret);
6527                     if (!retarray)
6528                         return ret;
6529                 } else {
6530                     if (retarray)
6531                         ret = newSVsv(&PL_sv_undef);
6532                 }
6533                 if (retarray)
6534                     av_push(retarray, ret);
6535             }
6536             if (retarray)
6537                 return newRV_noinc(MUTABLE_SV(retarray));
6538         }
6539     }
6540     return NULL;
6541 }
6542
6543 bool
6544 Perl_reg_named_buff_exists(pTHX_ REGEXP * const r, SV * const key,
6545                            const U32 flags)
6546 {
6547     struct regexp *const rx = ReANY(r);
6548
6549     PERL_ARGS_ASSERT_REG_NAMED_BUFF_EXISTS;
6550
6551     if (rx && RXp_PAREN_NAMES(rx)) {
6552         if (flags & RXapif_ALL) {
6553             return hv_exists_ent(RXp_PAREN_NAMES(rx), key, 0);
6554         } else {
6555             SV *sv = CALLREG_NAMED_BUFF_FETCH(r, key, flags);
6556             if (sv) {
6557                 SvREFCNT_dec_NN(sv);
6558                 return TRUE;
6559             } else {
6560                 return FALSE;
6561             }
6562         }
6563     } else {
6564         return FALSE;
6565     }
6566 }
6567
6568 SV*
6569 Perl_reg_named_buff_firstkey(pTHX_ REGEXP * const r, const U32 flags)
6570 {
6571     struct regexp *const rx = ReANY(r);
6572
6573     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FIRSTKEY;
6574
6575     if ( rx && RXp_PAREN_NAMES(rx) ) {
6576         (void)hv_iterinit(RXp_PAREN_NAMES(rx));
6577
6578         return CALLREG_NAMED_BUFF_NEXTKEY(r, NULL, flags & ~RXapif_FIRSTKEY);
6579     } else {
6580         return FALSE;
6581     }
6582 }
6583
6584 SV*
6585 Perl_reg_named_buff_nextkey(pTHX_ REGEXP * const r, const U32 flags)
6586 {
6587     struct regexp *const rx = ReANY(r);
6588     GET_RE_DEBUG_FLAGS_DECL;
6589
6590     PERL_ARGS_ASSERT_REG_NAMED_BUFF_NEXTKEY;
6591
6592     if (rx && RXp_PAREN_NAMES(rx)) {
6593         HV *hv = RXp_PAREN_NAMES(rx);
6594         HE *temphe;
6595         while ( (temphe = hv_iternext_flags(hv,0)) ) {
6596             IV i;
6597             IV parno = 0;
6598             SV* sv_dat = HeVAL(temphe);
6599             I32 *nums = (I32*)SvPVX(sv_dat);
6600             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
6601                 if ((I32)(rx->lastparen) >= nums[i] &&
6602                     rx->offs[nums[i]].start != -1 &&
6603                     rx->offs[nums[i]].end != -1)
6604                 {
6605                     parno = nums[i];
6606                     break;
6607                 }
6608             }
6609             if (parno || flags & RXapif_ALL) {
6610                 return newSVhek(HeKEY_hek(temphe));
6611             }
6612         }
6613     }
6614     return NULL;
6615 }
6616
6617 SV*
6618 Perl_reg_named_buff_scalar(pTHX_ REGEXP * const r, const U32 flags)
6619 {
6620     SV *ret;
6621     AV *av;
6622     I32 length;
6623     struct regexp *const rx = ReANY(r);
6624
6625     PERL_ARGS_ASSERT_REG_NAMED_BUFF_SCALAR;
6626
6627     if (rx && RXp_PAREN_NAMES(rx)) {
6628         if (flags & (RXapif_ALL | RXapif_REGNAMES_COUNT)) {
6629             return newSViv(HvTOTALKEYS(RXp_PAREN_NAMES(rx)));
6630         } else if (flags & RXapif_ONE) {
6631             ret = CALLREG_NAMED_BUFF_ALL(r, (flags | RXapif_REGNAMES));
6632             av = MUTABLE_AV(SvRV(ret));
6633             length = av_len(av);
6634             SvREFCNT_dec_NN(ret);
6635             return newSViv(length + 1);
6636         } else {
6637             Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_scalar", (int)flags);
6638             return NULL;
6639         }
6640     }
6641     return &PL_sv_undef;
6642 }
6643
6644 SV*
6645 Perl_reg_named_buff_all(pTHX_ REGEXP * const r, const U32 flags)
6646 {
6647     struct regexp *const rx = ReANY(r);
6648     AV *av = newAV();
6649
6650     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ALL;
6651
6652     if (rx && RXp_PAREN_NAMES(rx)) {
6653         HV *hv= RXp_PAREN_NAMES(rx);
6654         HE *temphe;
6655         (void)hv_iterinit(hv);
6656         while ( (temphe = hv_iternext_flags(hv,0)) ) {
6657             IV i;
6658             IV parno = 0;
6659             SV* sv_dat = HeVAL(temphe);
6660             I32 *nums = (I32*)SvPVX(sv_dat);
6661             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
6662                 if ((I32)(rx->lastparen) >= nums[i] &&
6663                     rx->offs[nums[i]].start != -1 &&
6664                     rx->offs[nums[i]].end != -1)
6665                 {
6666                     parno = nums[i];
6667                     break;
6668                 }
6669             }
6670             if (parno || flags & RXapif_ALL) {
6671                 av_push(av, newSVhek(HeKEY_hek(temphe)));
6672             }
6673         }
6674     }
6675
6676     return newRV_noinc(MUTABLE_SV(av));
6677 }
6678
6679 void
6680 Perl_reg_numbered_buff_fetch(pTHX_ REGEXP * const r, const I32 paren,
6681                              SV * const sv)
6682 {
6683     struct regexp *const rx = ReANY(r);
6684     char *s = NULL;
6685     I32 i = 0;
6686     I32 s1, t1;
6687     I32 n = paren;
6688
6689     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_FETCH;
6690         
6691     if ( (    n == RX_BUFF_IDX_CARET_PREMATCH
6692            || n == RX_BUFF_IDX_CARET_FULLMATCH
6693            || n == RX_BUFF_IDX_CARET_POSTMATCH
6694          )
6695          && !(rx->extflags & RXf_PMf_KEEPCOPY)
6696     )
6697         goto ret_undef;
6698
6699     if (!rx->subbeg)
6700         goto ret_undef;
6701
6702     if (n == RX_BUFF_IDX_CARET_FULLMATCH)
6703         /* no need to distinguish between them any more */
6704         n = RX_BUFF_IDX_FULLMATCH;
6705
6706     if ((n == RX_BUFF_IDX_PREMATCH || n == RX_BUFF_IDX_CARET_PREMATCH)
6707         && rx->offs[0].start != -1)
6708     {
6709         /* $`, ${^PREMATCH} */
6710         i = rx->offs[0].start;
6711         s = rx->subbeg;
6712     }
6713     else 
6714     if ((n == RX_BUFF_IDX_POSTMATCH || n == RX_BUFF_IDX_CARET_POSTMATCH)
6715         && rx->offs[0].end != -1)
6716     {
6717         /* $', ${^POSTMATCH} */
6718         s = rx->subbeg - rx->suboffset + rx->offs[0].end;
6719         i = rx->sublen + rx->suboffset - rx->offs[0].end;
6720     } 
6721     else
6722     if ( 0 <= n && n <= (I32)rx->nparens &&
6723         (s1 = rx->offs[n].start) != -1 &&
6724         (t1 = rx->offs[n].end) != -1)
6725     {
6726         /* $&, ${^MATCH},  $1 ... */
6727         i = t1 - s1;
6728         s = rx->subbeg + s1 - rx->suboffset;
6729     } else {
6730         goto ret_undef;
6731     }          
6732
6733     assert(s >= rx->subbeg);
6734     assert(rx->sublen >= (s - rx->subbeg) + i );
6735     if (i >= 0) {
6736 #if NO_TAINT_SUPPORT
6737         sv_setpvn(sv, s, i);
6738 #else
6739         const int oldtainted = TAINT_get;
6740         TAINT_NOT;
6741         sv_setpvn(sv, s, i);
6742         TAINT_set(oldtainted);
6743 #endif
6744         if ( (rx->extflags & RXf_CANY_SEEN)
6745             ? (RXp_MATCH_UTF8(rx)
6746                         && (!i || is_utf8_string((U8*)s, i)))
6747             : (RXp_MATCH_UTF8(rx)) )
6748         {
6749             SvUTF8_on(sv);
6750         }
6751         else
6752             SvUTF8_off(sv);
6753         if (TAINTING_get) {
6754             if (RXp_MATCH_TAINTED(rx)) {
6755                 if (SvTYPE(sv) >= SVt_PVMG) {
6756                     MAGIC* const mg = SvMAGIC(sv);
6757                     MAGIC* mgt;
6758                     TAINT;
6759                     SvMAGIC_set(sv, mg->mg_moremagic);
6760                     SvTAINT(sv);
6761                     if ((mgt = SvMAGIC(sv))) {
6762                         mg->mg_moremagic = mgt;
6763                         SvMAGIC_set(sv, mg);
6764                     }
6765                 } else {
6766                     TAINT;
6767                     SvTAINT(sv);
6768                 }
6769             } else 
6770                 SvTAINTED_off(sv);
6771         }
6772     } else {
6773       ret_undef:
6774         sv_setsv(sv,&PL_sv_undef);
6775         return;
6776     }
6777 }
6778
6779 void
6780 Perl_reg_numbered_buff_store(pTHX_ REGEXP * const rx, const I32 paren,
6781                                                          SV const * const value)
6782 {
6783     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_STORE;
6784
6785     PERL_UNUSED_ARG(rx);
6786     PERL_UNUSED_ARG(paren);
6787     PERL_UNUSED_ARG(value);
6788
6789     if (!PL_localizing)
6790         Perl_croak_no_modify();
6791 }
6792
6793 I32
6794 Perl_reg_numbered_buff_length(pTHX_ REGEXP * const r, const SV * const sv,
6795                               const I32 paren)
6796 {
6797     struct regexp *const rx = ReANY(r);
6798     I32 i;
6799     I32 s1, t1;
6800
6801     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_LENGTH;
6802
6803     /* Some of this code was originally in C<Perl_magic_len> in F<mg.c> */
6804     switch (paren) {
6805       case RX_BUFF_IDX_CARET_PREMATCH: /* ${^PREMATCH} */
6806          if (!(rx->extflags & RXf_PMf_KEEPCOPY))
6807             goto warn_undef;
6808         /*FALLTHROUGH*/
6809
6810       case RX_BUFF_IDX_PREMATCH:       /* $` */
6811         if (rx->offs[0].start != -1) {
6812                         i = rx->offs[0].start;
6813                         if (i > 0) {
6814                                 s1 = 0;
6815                                 t1 = i;
6816                                 goto getlen;
6817                         }
6818             }
6819         return 0;
6820
6821       case RX_BUFF_IDX_CARET_POSTMATCH: /* ${^POSTMATCH} */
6822          if (!(rx->extflags & RXf_PMf_KEEPCOPY))
6823             goto warn_undef;
6824       case RX_BUFF_IDX_POSTMATCH:       /* $' */
6825             if (rx->offs[0].end != -1) {
6826                         i = rx->sublen - rx->offs[0].end;
6827                         if (i > 0) {
6828                                 s1 = rx->offs[0].end;
6829                                 t1 = rx->sublen;
6830                                 goto getlen;
6831                         }
6832             }
6833         return 0;
6834
6835       case RX_BUFF_IDX_CARET_FULLMATCH: /* ${^MATCH} */
6836          if (!(rx->extflags & RXf_PMf_KEEPCOPY))
6837             goto warn_undef;
6838         /*FALLTHROUGH*/
6839
6840       /* $& / ${^MATCH}, $1, $2, ... */
6841       default:
6842             if (paren <= (I32)rx->nparens &&
6843             (s1 = rx->offs[paren].start) != -1 &&
6844             (t1 = rx->offs[paren].end) != -1)
6845             {
6846             i = t1 - s1;
6847             goto getlen;
6848         } else {
6849           warn_undef:
6850             if (ckWARN(WARN_UNINITIALIZED))
6851                 report_uninit((const SV *)sv);
6852             return 0;
6853         }
6854     }
6855   getlen:
6856     if (i > 0 && RXp_MATCH_UTF8(rx)) {
6857         const char * const s = rx->subbeg - rx->suboffset + s1;
6858         const U8 *ep;
6859         STRLEN el;
6860
6861         i = t1 - s1;
6862         if (is_utf8_string_loclen((U8*)s, i, &ep, &el))
6863                         i = el;
6864     }
6865     return i;
6866 }
6867
6868 SV*
6869 Perl_reg_qr_package(pTHX_ REGEXP * const rx)
6870 {
6871     PERL_ARGS_ASSERT_REG_QR_PACKAGE;
6872         PERL_UNUSED_ARG(rx);
6873         if (0)
6874             return NULL;
6875         else
6876             return newSVpvs("Regexp");
6877 }
6878
6879 /* Scans the name of a named buffer from the pattern.
6880  * If flags is REG_RSN_RETURN_NULL returns null.
6881  * If flags is REG_RSN_RETURN_NAME returns an SV* containing the name
6882  * If flags is REG_RSN_RETURN_DATA returns the data SV* corresponding
6883  * to the parsed name as looked up in the RExC_paren_names hash.
6884  * If there is an error throws a vFAIL().. type exception.
6885  */
6886
6887 #define REG_RSN_RETURN_NULL    0
6888 #define REG_RSN_RETURN_NAME    1
6889 #define REG_RSN_RETURN_DATA    2
6890
6891 STATIC SV*
6892 S_reg_scan_name(pTHX_ RExC_state_t *pRExC_state, U32 flags)
6893 {
6894     char *name_start = RExC_parse;
6895
6896     PERL_ARGS_ASSERT_REG_SCAN_NAME;
6897
6898     if (isIDFIRST_lazy_if(RExC_parse, UTF)) {
6899          /* skip IDFIRST by using do...while */
6900         if (UTF)
6901             do {
6902                 RExC_parse += UTF8SKIP(RExC_parse);
6903             } while (isWORDCHAR_utf8((U8*)RExC_parse));
6904         else
6905             do {
6906                 RExC_parse++;
6907             } while (isWORDCHAR(*RExC_parse));
6908     } else {
6909         RExC_parse++; /* so the <- from the vFAIL is after the offending character */
6910         vFAIL("Group name must start with a non-digit word character");
6911     }
6912     if ( flags ) {
6913         SV* sv_name
6914             = newSVpvn_flags(name_start, (int)(RExC_parse - name_start),
6915                              SVs_TEMP | (UTF ? SVf_UTF8 : 0));
6916         if ( flags == REG_RSN_RETURN_NAME)
6917             return sv_name;
6918         else if (flags==REG_RSN_RETURN_DATA) {
6919             HE *he_str = NULL;
6920             SV *sv_dat = NULL;
6921             if ( ! sv_name )      /* should not happen*/
6922                 Perl_croak(aTHX_ "panic: no svname in reg_scan_name");
6923             if (RExC_paren_names)
6924                 he_str = hv_fetch_ent( RExC_paren_names, sv_name, 0, 0 );
6925             if ( he_str )
6926                 sv_dat = HeVAL(he_str);
6927             if ( ! sv_dat )
6928                 vFAIL("Reference to nonexistent named group");
6929             return sv_dat;
6930         }
6931         else {
6932             Perl_croak(aTHX_ "panic: bad flag %lx in reg_scan_name",
6933                        (unsigned long) flags);
6934         }
6935         assert(0); /* NOT REACHED */
6936     }
6937     return NULL;
6938 }
6939
6940 #define DEBUG_PARSE_MSG(funcname)     DEBUG_PARSE_r({           \
6941     int rem=(int)(RExC_end - RExC_parse);                       \
6942     int cut;                                                    \
6943     int num;                                                    \
6944     int iscut=0;                                                \
6945     if (rem>10) {                                               \
6946         rem=10;                                                 \
6947         iscut=1;                                                \
6948     }                                                           \
6949     cut=10-rem;                                                 \
6950     if (RExC_lastparse!=RExC_parse)                             \
6951         PerlIO_printf(Perl_debug_log," >%.*s%-*s",              \
6952             rem, RExC_parse,                                    \
6953             cut + 4,                                            \
6954             iscut ? "..." : "<"                                 \
6955         );                                                      \
6956     else                                                        \
6957         PerlIO_printf(Perl_debug_log,"%16s","");                \
6958                                                                 \
6959     if (SIZE_ONLY)                                              \
6960        num = RExC_size + 1;                                     \
6961     else                                                        \
6962        num=REG_NODE_NUM(RExC_emit);                             \
6963     if (RExC_lastnum!=num)                                      \
6964        PerlIO_printf(Perl_debug_log,"|%4d",num);                \
6965     else                                                        \
6966        PerlIO_printf(Perl_debug_log,"|%4s","");                 \
6967     PerlIO_printf(Perl_debug_log,"|%*s%-4s",                    \
6968         (int)((depth*2)), "",                                   \
6969         (funcname)                                              \
6970     );                                                          \
6971     RExC_lastnum=num;                                           \
6972     RExC_lastparse=RExC_parse;                                  \
6973 })
6974
6975
6976
6977 #define DEBUG_PARSE(funcname)     DEBUG_PARSE_r({           \
6978     DEBUG_PARSE_MSG((funcname));                            \
6979     PerlIO_printf(Perl_debug_log,"%4s","\n");               \
6980 })
6981 #define DEBUG_PARSE_FMT(funcname,fmt,args)     DEBUG_PARSE_r({           \
6982     DEBUG_PARSE_MSG((funcname));                            \
6983     PerlIO_printf(Perl_debug_log,fmt "\n",args);               \
6984 })
6985
6986 /* This section of code defines the inversion list object and its methods.  The
6987  * interfaces are highly subject to change, so as much as possible is static to
6988  * this file.  An inversion list is here implemented as a malloc'd C UV array
6989  * with some added info that is placed as UVs at the beginning in a header
6990  * portion.  An inversion list for Unicode is an array of code points, sorted
6991  * by ordinal number.  The zeroth element is the first code point in the list.
6992  * The 1th element is the first element beyond that not in the list.  In other
6993  * words, the first range is
6994  *  invlist[0]..(invlist[1]-1)
6995  * The other ranges follow.  Thus every element whose index is divisible by two
6996  * marks the beginning of a range that is in the list, and every element not
6997  * divisible by two marks the beginning of a range not in the list.  A single
6998  * element inversion list that contains the single code point N generally
6999  * consists of two elements
7000  *  invlist[0] == N
7001  *  invlist[1] == N+1
7002  * (The exception is when N is the highest representable value on the
7003  * machine, in which case the list containing just it would be a single
7004  * element, itself.  By extension, if the last range in the list extends to
7005  * infinity, then the first element of that range will be in the inversion list
7006  * at a position that is divisible by two, and is the final element in the
7007  * list.)
7008  * Taking the complement (inverting) an inversion list is quite simple, if the
7009  * first element is 0, remove it; otherwise add a 0 element at the beginning.
7010  * This implementation reserves an element at the beginning of each inversion
7011  * list to contain 0 when the list contains 0, and contains 1 otherwise.  The
7012  * actual beginning of the list is either that element if 0, or the next one if
7013  * 1.
7014  *
7015  * More about inversion lists can be found in "Unicode Demystified"
7016  * Chapter 13 by Richard Gillam, published by Addison-Wesley.
7017  * More will be coming when functionality is added later.
7018  *
7019  * The inversion list data structure is currently implemented as an SV pointing
7020  * to an array of UVs that the SV thinks are bytes.  This allows us to have an
7021  * array of UV whose memory management is automatically handled by the existing
7022  * facilities for SV's.
7023  *
7024  * Some of the methods should always be private to the implementation, and some
7025  * should eventually be made public */
7026
7027 /* The header definitions are in F<inline_invlist.c> */
7028 #define TO_INTERNAL_SIZE(x) (((x) + HEADER_LENGTH) * sizeof(UV))
7029 #define FROM_INTERNAL_SIZE(x) (((x)/ sizeof(UV)) - HEADER_LENGTH)
7030
7031 #define INVLIST_INITIAL_LEN 10
7032
7033 PERL_STATIC_INLINE UV*
7034 S__invlist_array_init(pTHX_ SV* const invlist, const bool will_have_0)
7035 {
7036     /* Returns a pointer to the first element in the inversion list's array.
7037      * This is called upon initialization of an inversion list.  Where the
7038      * array begins depends on whether the list has the code point U+0000
7039      * in it or not.  The other parameter tells it whether the code that
7040      * follows this call is about to put a 0 in the inversion list or not.
7041      * The first element is either the element with 0, if 0, or the next one,
7042      * if 1 */
7043
7044     UV* zero = get_invlist_zero_addr(invlist);
7045
7046     PERL_ARGS_ASSERT__INVLIST_ARRAY_INIT;
7047
7048     /* Must be empty */
7049     assert(! *_get_invlist_len_addr(invlist));
7050
7051     /* 1^1 = 0; 1^0 = 1 */
7052     *zero = 1 ^ will_have_0;
7053     return zero + *zero;
7054 }
7055
7056 PERL_STATIC_INLINE UV*
7057 S_invlist_array(pTHX_ SV* const invlist)
7058 {
7059     /* Returns the pointer to the inversion list's array.  Every time the
7060      * length changes, this needs to be called in case malloc or realloc moved
7061      * it */
7062
7063     PERL_ARGS_ASSERT_INVLIST_ARRAY;
7064
7065     /* Must not be empty.  If these fail, you probably didn't check for <len>
7066      * being non-zero before trying to get the array */
7067     assert(*_get_invlist_len_addr(invlist));
7068     assert(*get_invlist_zero_addr(invlist) == 0
7069            || *get_invlist_zero_addr(invlist) == 1);
7070
7071     /* The array begins either at the element reserved for zero if the
7072      * list contains 0 (that element will be set to 0), or otherwise the next
7073      * element (in which case the reserved element will be set to 1). */
7074     return (UV *) (get_invlist_zero_addr(invlist)
7075                    + *get_invlist_zero_addr(invlist));
7076 }
7077
7078 PERL_STATIC_INLINE void
7079 S_invlist_set_len(pTHX_ SV* const invlist, const UV len)
7080 {
7081     /* Sets the current number of elements stored in the inversion list */
7082
7083     PERL_ARGS_ASSERT_INVLIST_SET_LEN;
7084
7085     *_get_invlist_len_addr(invlist) = len;
7086
7087     assert(len <= SvLEN(invlist));
7088
7089     SvCUR_set(invlist, TO_INTERNAL_SIZE(len));
7090     /* If the list contains U+0000, that element is part of the header,
7091      * and should not be counted as part of the array.  It will contain
7092      * 0 in that case, and 1 otherwise.  So we could flop 0=>1, 1=>0 and
7093      * subtract:
7094      *  SvCUR_set(invlist,
7095      *            TO_INTERNAL_SIZE(len
7096      *                             - (*get_invlist_zero_addr(inv_list) ^ 1)));
7097      * But, this is only valid if len is not 0.  The consequences of not doing
7098      * this is that the memory allocation code may think that 1 more UV is
7099      * being used than actually is, and so might do an unnecessary grow.  That
7100      * seems worth not bothering to make this the precise amount.
7101      *
7102      * Note that when inverting, SvCUR shouldn't change */
7103 }
7104
7105 PERL_STATIC_INLINE IV*
7106 S_get_invlist_previous_index_addr(pTHX_ SV* invlist)
7107 {
7108     /* Return the address of the UV that is reserved to hold the cached index
7109      * */
7110
7111     PERL_ARGS_ASSERT_GET_INVLIST_PREVIOUS_INDEX_ADDR;
7112
7113     return (IV *) (SvPVX(invlist) + (INVLIST_PREVIOUS_INDEX_OFFSET * sizeof (UV)));
7114 }
7115
7116 PERL_STATIC_INLINE IV
7117 S_invlist_previous_index(pTHX_ SV* const invlist)
7118 {
7119     /* Returns cached index of previous search */
7120
7121     PERL_ARGS_ASSERT_INVLIST_PREVIOUS_INDEX;
7122
7123     return *get_invlist_previous_index_addr(invlist);
7124 }
7125
7126 PERL_STATIC_INLINE void
7127 S_invlist_set_previous_index(pTHX_ SV* const invlist, const IV index)
7128 {
7129     /* Caches <index> for later retrieval */
7130
7131     PERL_ARGS_ASSERT_INVLIST_SET_PREVIOUS_INDEX;
7132
7133     assert(index == 0 || index < (int) _invlist_len(invlist));
7134
7135     *get_invlist_previous_index_addr(invlist) = index;
7136 }
7137
7138 PERL_STATIC_INLINE UV
7139 S_invlist_max(pTHX_ SV* const invlist)
7140 {
7141     /* Returns the maximum number of elements storable in the inversion list's
7142      * array, without having to realloc() */
7143
7144     PERL_ARGS_ASSERT_INVLIST_MAX;
7145
7146     return SvLEN(invlist) == 0  /* This happens under _new_invlist_C_array */
7147            ? _invlist_len(invlist)
7148            : FROM_INTERNAL_SIZE(SvLEN(invlist));
7149 }
7150
7151 PERL_STATIC_INLINE UV*
7152 S_get_invlist_zero_addr(pTHX_ SV* invlist)
7153 {
7154     /* Return the address of the UV that is reserved to hold 0 if the inversion
7155      * list contains 0.  This has to be the last element of the heading, as the
7156      * list proper starts with either it if 0, or the next element if not.
7157      * (But we force it to contain either 0 or 1) */
7158
7159     PERL_ARGS_ASSERT_GET_INVLIST_ZERO_ADDR;
7160
7161     return (UV *) (SvPVX(invlist) + (INVLIST_ZERO_OFFSET * sizeof (UV)));
7162 }
7163
7164 #ifndef PERL_IN_XSUB_RE
7165 SV*
7166 Perl__new_invlist(pTHX_ IV initial_size)
7167 {
7168
7169     /* Return a pointer to a newly constructed inversion list, with enough
7170      * space to store 'initial_size' elements.  If that number is negative, a
7171      * system default is used instead */
7172
7173     SV* new_list;
7174
7175     if (initial_size < 0) {
7176         initial_size = INVLIST_INITIAL_LEN;
7177     }
7178
7179     /* Allocate the initial space */
7180     new_list = newSV(TO_INTERNAL_SIZE(initial_size));
7181     invlist_set_len(new_list, 0);
7182
7183     /* Force iterinit() to be used to get iteration to work */
7184     *get_invlist_iter_addr(new_list) = UV_MAX;
7185
7186     /* This should force a segfault if a method doesn't initialize this
7187      * properly */
7188     *get_invlist_zero_addr(new_list) = UV_MAX;
7189
7190     *get_invlist_previous_index_addr(new_list) = 0;
7191     *get_invlist_version_id_addr(new_list) = INVLIST_VERSION_ID;
7192 #if HEADER_LENGTH != 5
7193 #   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
7194 #endif
7195
7196     return new_list;
7197 }
7198 #endif
7199
7200 STATIC SV*
7201 S__new_invlist_C_array(pTHX_ UV* list)
7202 {
7203     /* Return a pointer to a newly constructed inversion list, initialized to
7204      * point to <list>, which has to be in the exact correct inversion list
7205      * form, including internal fields.  Thus this is a dangerous routine that
7206      * should not be used in the wrong hands */
7207
7208     SV* invlist = newSV_type(SVt_PV);
7209
7210     PERL_ARGS_ASSERT__NEW_INVLIST_C_ARRAY;
7211
7212     SvPV_set(invlist, (char *) list);
7213     SvLEN_set(invlist, 0);  /* Means we own the contents, and the system
7214                                shouldn't touch it */
7215     SvCUR_set(invlist, TO_INTERNAL_SIZE(_invlist_len(invlist)));
7216
7217     if (*get_invlist_version_id_addr(invlist) != INVLIST_VERSION_ID) {
7218         Perl_croak(aTHX_ "panic: Incorrect version for previously generated inversion list");
7219     }
7220
7221     /* Initialize the iteration pointer.
7222      * XXX This could be done at compile time in charclass_invlists.h, but I
7223      * (khw) am not confident that the suffixes for specifying the C constant
7224      * UV_MAX are portable, e.g.  'ull' on a 32 bit machine that is configured
7225      * to use 64 bits; might need a Configure probe */
7226     invlist_iterfinish(invlist);
7227
7228     return invlist;
7229 }
7230
7231 STATIC void
7232 S_invlist_extend(pTHX_ SV* const invlist, const UV new_max)
7233 {
7234     /* Grow the maximum size of an inversion list */
7235
7236     PERL_ARGS_ASSERT_INVLIST_EXTEND;
7237
7238     SvGROW((SV *)invlist, TO_INTERNAL_SIZE(new_max));
7239 }
7240
7241 PERL_STATIC_INLINE void
7242 S_invlist_trim(pTHX_ SV* const invlist)
7243 {
7244     PERL_ARGS_ASSERT_INVLIST_TRIM;
7245
7246     /* Change the length of the inversion list to how many entries it currently
7247      * has */
7248
7249     SvPV_shrink_to_cur((SV *) invlist);
7250 }
7251
7252 #define _invlist_union_complement_2nd(a, b, output) _invlist_union_maybe_complement_2nd(a, b, TRUE, output)
7253
7254 STATIC void
7255 S__append_range_to_invlist(pTHX_ SV* const invlist, const UV start, const UV end)
7256 {
7257    /* Subject to change or removal.  Append the range from 'start' to 'end' at
7258     * the end of the inversion list.  The range must be above any existing
7259     * ones. */
7260
7261     UV* array;
7262     UV max = invlist_max(invlist);
7263     UV len = _invlist_len(invlist);
7264
7265     PERL_ARGS_ASSERT__APPEND_RANGE_TO_INVLIST;
7266
7267     if (len == 0) { /* Empty lists must be initialized */
7268         array = _invlist_array_init(invlist, start == 0);
7269     }
7270     else {
7271         /* Here, the existing list is non-empty. The current max entry in the
7272          * list is generally the first value not in the set, except when the
7273          * set extends to the end of permissible values, in which case it is
7274          * the first entry in that final set, and so this call is an attempt to
7275          * append out-of-order */
7276
7277         UV final_element = len - 1;
7278         array = invlist_array(invlist);
7279         if (array[final_element] > start
7280             || ELEMENT_RANGE_MATCHES_INVLIST(final_element))
7281         {
7282             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",
7283                        array[final_element], start,
7284                        ELEMENT_RANGE_MATCHES_INVLIST(final_element) ? 't' : 'f');
7285         }
7286
7287         /* Here, it is a legal append.  If the new range begins with the first
7288          * value not in the set, it is extending the set, so the new first
7289          * value not in the set is one greater than the newly extended range.
7290          * */
7291         if (array[final_element] == start) {
7292             if (end != UV_MAX) {
7293                 array[final_element] = end + 1;
7294             }
7295             else {
7296                 /* But if the end is the maximum representable on the machine,
7297                  * just let the range that this would extend to have no end */
7298                 invlist_set_len(invlist, len - 1);
7299             }
7300             return;
7301         }
7302     }
7303
7304     /* Here the new range doesn't extend any existing set.  Add it */
7305
7306     len += 2;   /* Includes an element each for the start and end of range */
7307
7308     /* If overflows the existing space, extend, which may cause the array to be
7309      * moved */
7310     if (max < len) {
7311         invlist_extend(invlist, len);
7312         invlist_set_len(invlist, len);  /* Have to set len here to avoid assert
7313                                            failure in invlist_array() */
7314         array = invlist_array(invlist);
7315     }
7316     else {
7317         invlist_set_len(invlist, len);
7318     }
7319
7320     /* The next item on the list starts the range, the one after that is
7321      * one past the new range.  */
7322     array[len - 2] = start;
7323     if (end != UV_MAX) {
7324         array[len - 1] = end + 1;
7325     }
7326     else {
7327         /* But if the end is the maximum representable on the machine, just let
7328          * the range have no end */
7329         invlist_set_len(invlist, len - 1);
7330     }
7331 }
7332
7333 #ifndef PERL_IN_XSUB_RE
7334
7335 IV
7336 Perl__invlist_search(pTHX_ SV* const invlist, const UV cp)
7337 {
7338     /* Searches the inversion list for the entry that contains the input code
7339      * point <cp>.  If <cp> is not in the list, -1 is returned.  Otherwise, the
7340      * return value is the index into the list's array of the range that
7341      * contains <cp> */
7342
7343     IV low = 0;
7344     IV mid;
7345     IV high = _invlist_len(invlist);
7346     const IV highest_element = high - 1;
7347     const UV* array;
7348
7349     PERL_ARGS_ASSERT__INVLIST_SEARCH;
7350
7351     /* If list is empty, return failure. */
7352     if (high == 0) {
7353         return -1;
7354     }
7355
7356     /* (We can't get the array unless we know the list is non-empty) */
7357     array = invlist_array(invlist);
7358
7359     mid = invlist_previous_index(invlist);
7360     assert(mid >=0 && mid <= highest_element);
7361
7362     /* <mid> contains the cache of the result of the previous call to this
7363      * function (0 the first time).  See if this call is for the same result,
7364      * or if it is for mid-1.  This is under the theory that calls to this
7365      * function will often be for related code points that are near each other.
7366      * And benchmarks show that caching gives better results.  We also test
7367      * here if the code point is within the bounds of the list.  These tests
7368      * replace others that would have had to be made anyway to make sure that
7369      * the array bounds were not exceeded, and these give us extra information
7370      * at the same time */
7371     if (cp >= array[mid]) {
7372         if (cp >= array[highest_element]) {
7373             return highest_element;
7374         }
7375
7376         /* Here, array[mid] <= cp < array[highest_element].  This means that
7377          * the final element is not the answer, so can exclude it; it also
7378          * means that <mid> is not the final element, so can refer to 'mid + 1'
7379          * safely */
7380         if (cp < array[mid + 1]) {
7381             return mid;
7382         }
7383         high--;
7384         low = mid + 1;
7385     }
7386     else { /* cp < aray[mid] */
7387         if (cp < array[0]) { /* Fail if outside the array */
7388             return -1;
7389         }
7390         high = mid;
7391         if (cp >= array[mid - 1]) {
7392             goto found_entry;
7393         }
7394     }
7395
7396     /* Binary search.  What we are looking for is <i> such that
7397      *  array[i] <= cp < array[i+1]
7398      * The loop below converges on the i+1.  Note that there may not be an
7399      * (i+1)th element in the array, and things work nonetheless */
7400     while (low < high) {
7401         mid = (low + high) / 2;
7402         assert(mid <= highest_element);
7403         if (array[mid] <= cp) { /* cp >= array[mid] */
7404             low = mid + 1;
7405
7406             /* We could do this extra test to exit the loop early.
7407             if (cp < array[low]) {
7408                 return mid;
7409             }
7410             */
7411         }
7412         else { /* cp < array[mid] */
7413             high = mid;
7414         }
7415     }
7416
7417   found_entry:
7418     high--;
7419     invlist_set_previous_index(invlist, high);
7420     return high;
7421 }
7422
7423 void
7424 Perl__invlist_populate_swatch(pTHX_ SV* const invlist, const UV start, const UV end, U8* swatch)
7425 {
7426     /* populates a swatch of a swash the same way swatch_get() does in utf8.c,
7427      * but is used when the swash has an inversion list.  This makes this much
7428      * faster, as it uses a binary search instead of a linear one.  This is
7429      * intimately tied to that function, and perhaps should be in utf8.c,
7430      * except it is intimately tied to inversion lists as well.  It assumes
7431      * that <swatch> is all 0's on input */
7432
7433     UV current = start;
7434     const IV len = _invlist_len(invlist);
7435     IV i;
7436     const UV * array;
7437
7438     PERL_ARGS_ASSERT__INVLIST_POPULATE_SWATCH;
7439
7440     if (len == 0) { /* Empty inversion list */
7441         return;
7442     }
7443
7444     array = invlist_array(invlist);
7445
7446     /* Find which element it is */
7447     i = _invlist_search(invlist, start);
7448
7449     /* We populate from <start> to <end> */
7450     while (current < end) {
7451         UV upper;
7452
7453         /* The inversion list gives the results for every possible code point
7454          * after the first one in the list.  Only those ranges whose index is
7455          * even are ones that the inversion list matches.  For the odd ones,
7456          * and if the initial code point is not in the list, we have to skip
7457          * forward to the next element */
7458         if (i == -1 || ! ELEMENT_RANGE_MATCHES_INVLIST(i)) {
7459             i++;
7460             if (i >= len) { /* Finished if beyond the end of the array */
7461                 return;
7462             }
7463             current = array[i];
7464             if (current >= end) {   /* Finished if beyond the end of what we
7465                                        are populating */
7466                 if (LIKELY(end < UV_MAX)) {
7467                     return;
7468                 }
7469
7470                 /* We get here when the upper bound is the maximum
7471                  * representable on the machine, and we are looking for just
7472                  * that code point.  Have to special case it */
7473                 i = len;
7474                 goto join_end_of_list;
7475             }
7476         }
7477         assert(current >= start);
7478
7479         /* The current range ends one below the next one, except don't go past
7480          * <end> */
7481         i++;
7482         upper = (i < len && array[i] < end) ? array[i] : end;
7483
7484         /* Here we are in a range that matches.  Populate a bit in the 3-bit U8
7485          * for each code point in it */
7486         for (; current < upper; current++) {
7487             const STRLEN offset = (STRLEN)(current - start);
7488             swatch[offset >> 3] |= 1 << (offset & 7);
7489         }
7490
7491     join_end_of_list:
7492
7493         /* Quit if at the end of the list */
7494         if (i >= len) {
7495
7496             /* But first, have to deal with the highest possible code point on
7497              * the platform.  The previous code assumes that <end> is one
7498              * beyond where we want to populate, but that is impossible at the
7499              * platform's infinity, so have to handle it specially */
7500             if (UNLIKELY(end == UV_MAX && ELEMENT_RANGE_MATCHES_INVLIST(len-1)))
7501             {
7502                 const STRLEN offset = (STRLEN)(end - start);
7503                 swatch[offset >> 3] |= 1 << (offset & 7);
7504             }
7505             return;
7506         }
7507
7508         /* Advance to the next range, which will be for code points not in the
7509          * inversion list */
7510         current = array[i];
7511     }
7512
7513     return;
7514 }
7515
7516 void
7517 Perl__invlist_union_maybe_complement_2nd(pTHX_ SV* const a, SV* const b, bool complement_b, SV** output)
7518 {
7519     /* Take the union of two inversion lists and point <output> to it.  *output
7520      * SHOULD BE DEFINED upon input, and if it points to one of the two lists,
7521      * the reference count to that list will be decremented.  The first list,
7522      * <a>, may be NULL, in which case a copy of the second list is returned.
7523      * If <complement_b> is TRUE, the union is taken of the complement
7524      * (inversion) of <b> instead of b itself.
7525      *
7526      * The basis for this comes from "Unicode Demystified" Chapter 13 by
7527      * Richard Gillam, published by Addison-Wesley, and explained at some
7528      * length there.  The preface says to incorporate its examples into your
7529      * code at your own risk.
7530      *
7531      * The algorithm is like a merge sort.
7532      *
7533      * XXX A potential performance improvement is to keep track as we go along
7534      * if only one of the inputs contributes to the result, meaning the other
7535      * is a subset of that one.  In that case, we can skip the final copy and
7536      * return the larger of the input lists, but then outside code might need
7537      * to keep track of whether to free the input list or not */
7538
7539     UV* array_a;    /* a's array */
7540     UV* array_b;
7541     UV len_a;       /* length of a's array */
7542     UV len_b;
7543
7544     SV* u;                      /* the resulting union */
7545     UV* array_u;
7546     UV len_u;
7547
7548     UV i_a = 0;             /* current index into a's array */
7549     UV i_b = 0;
7550     UV i_u = 0;
7551
7552     /* running count, as explained in the algorithm source book; items are
7553      * stopped accumulating and are output when the count changes to/from 0.
7554      * The count is incremented when we start a range that's in the set, and
7555      * decremented when we start a range that's not in the set.  So its range
7556      * is 0 to 2.  Only when the count is zero is something not in the set.
7557      */
7558     UV count = 0;
7559
7560     PERL_ARGS_ASSERT__INVLIST_UNION_MAYBE_COMPLEMENT_2ND;
7561     assert(a != b);
7562
7563     /* If either one is empty, the union is the other one */
7564     if (a == NULL || ((len_a = _invlist_len(a)) == 0)) {
7565         if (*output == a) {
7566             if (a != NULL) {
7567                 SvREFCNT_dec_NN(a);
7568             }
7569         }
7570         if (*output != b) {
7571             *output = invlist_clone(b);
7572             if (complement_b) {
7573                 _invlist_invert(*output);
7574             }
7575         } /* else *output already = b; */
7576         return;
7577     }
7578     else if ((len_b = _invlist_len(b)) == 0) {
7579         if (*output == b) {
7580             SvREFCNT_dec_NN(b);
7581         }
7582
7583         /* The complement of an empty list is a list that has everything in it,
7584          * so the union with <a> includes everything too */
7585         if (complement_b) {
7586             if (a == *output) {
7587                 SvREFCNT_dec_NN(a);
7588             }
7589             *output = _new_invlist(1);
7590             _append_range_to_invlist(*output, 0, UV_MAX);
7591         }
7592         else if (*output != a) {
7593             *output = invlist_clone(a);
7594         }
7595         /* else *output already = a; */
7596         return;
7597     }
7598
7599     /* Here both lists exist and are non-empty */
7600     array_a = invlist_array(a);
7601     array_b = invlist_array(b);
7602
7603     /* If are to take the union of 'a' with the complement of b, set it
7604      * up so are looking at b's complement. */
7605     if (complement_b) {
7606
7607         /* To complement, we invert: if the first element is 0, remove it.  To
7608          * do this, we just pretend the array starts one later, and clear the
7609          * flag as we don't have to do anything else later */
7610         if (array_b[0] == 0) {
7611             array_b++;
7612             len_b--;
7613             complement_b = FALSE;
7614         }
7615         else {
7616
7617             /* But if the first element is not zero, we unshift a 0 before the
7618              * array.  The data structure reserves a space for that 0 (which
7619              * should be a '1' right now), so physical shifting is unneeded,
7620              * but temporarily change that element to 0.  Before exiting the
7621              * routine, we must restore the element to '1' */
7622             array_b--;
7623             len_b++;
7624             array_b[0] = 0;
7625         }
7626     }
7627
7628     /* Size the union for the worst case: that the sets are completely
7629      * disjoint */
7630     u = _new_invlist(len_a + len_b);
7631
7632     /* Will contain U+0000 if either component does */
7633     array_u = _invlist_array_init(u, (len_a > 0 && array_a[0] == 0)
7634                                       || (len_b > 0 && array_b[0] == 0));
7635
7636     /* Go through each list item by item, stopping when exhausted one of
7637      * them */
7638     while (i_a < len_a && i_b < len_b) {
7639         UV cp;      /* The element to potentially add to the union's array */
7640         bool cp_in_set;   /* is it in the the input list's set or not */
7641
7642         /* We need to take one or the other of the two inputs for the union.
7643          * Since we are merging two sorted lists, we take the smaller of the
7644          * next items.  In case of a tie, we take the one that is in its set
7645          * first.  If we took one not in the set first, it would decrement the
7646          * count, possibly to 0 which would cause it to be output as ending the
7647          * range, and the next time through we would take the same number, and
7648          * output it again as beginning the next range.  By doing it the
7649          * opposite way, there is no possibility that the count will be
7650          * momentarily decremented to 0, and thus the two adjoining ranges will
7651          * be seamlessly merged.  (In a tie and both are in the set or both not
7652          * in the set, it doesn't matter which we take first.) */
7653         if (array_a[i_a] < array_b[i_b]
7654             || (array_a[i_a] == array_b[i_b]
7655                 && ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
7656         {
7657             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
7658             cp= array_a[i_a++];
7659         }
7660         else {
7661             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
7662             cp = array_b[i_b++];
7663         }
7664
7665         /* Here, have chosen which of the two inputs to look at.  Only output
7666          * if the running count changes to/from 0, which marks the
7667          * beginning/end of a range in that's in the set */
7668         if (cp_in_set) {
7669             if (count == 0) {
7670                 array_u[i_u++] = cp;
7671             }
7672             count++;
7673         }
7674         else {
7675             count--;
7676             if (count == 0) {
7677                 array_u[i_u++] = cp;
7678             }
7679         }
7680     }
7681
7682     /* Here, we are finished going through at least one of the lists, which
7683      * means there is something remaining in at most one.  We check if the list
7684      * that hasn't been exhausted is positioned such that we are in the middle
7685      * of a range in its set or not.  (i_a and i_b point to the element beyond
7686      * the one we care about.) If in the set, we decrement 'count'; if 0, there
7687      * is potentially more to output.
7688      * There are four cases:
7689      *  1) Both weren't in their sets, count is 0, and remains 0.  What's left
7690      *     in the union is entirely from the non-exhausted set.
7691      *  2) Both were in their sets, count is 2.  Nothing further should
7692      *     be output, as everything that remains will be in the exhausted
7693      *     list's set, hence in the union; decrementing to 1 but not 0 insures
7694      *     that
7695      *  3) the exhausted was in its set, non-exhausted isn't, count is 1.
7696      *     Nothing further should be output because the union includes
7697      *     everything from the exhausted set.  Not decrementing ensures that.
7698      *  4) the exhausted wasn't in its set, non-exhausted is, count is 1;
7699      *     decrementing to 0 insures that we look at the remainder of the
7700      *     non-exhausted set */
7701     if ((i_a != len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
7702         || (i_b != len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
7703     {
7704         count--;
7705     }
7706
7707     /* The final length is what we've output so far, plus what else is about to
7708      * be output.  (If 'count' is non-zero, then the input list we exhausted
7709      * has everything remaining up to the machine's limit in its set, and hence
7710      * in the union, so there will be no further output. */
7711     len_u = i_u;
7712     if (count == 0) {
7713         /* At most one of the subexpressions will be non-zero */
7714         len_u += (len_a - i_a) + (len_b - i_b);
7715     }
7716
7717     /* Set result to final length, which can change the pointer to array_u, so
7718      * re-find it */
7719     if (len_u != _invlist_len(u)) {
7720         invlist_set_len(u, len_u);
7721         invlist_trim(u);
7722         array_u = invlist_array(u);
7723     }
7724
7725     /* When 'count' is 0, the list that was exhausted (if one was shorter than
7726      * the other) ended with everything above it not in its set.  That means
7727      * that the remaining part of the union is precisely the same as the
7728      * non-exhausted list, so can just copy it unchanged.  (If both list were
7729      * exhausted at the same time, then the operations below will be both 0.)
7730      */
7731     if (count == 0) {
7732         IV copy_count; /* At most one will have a non-zero copy count */
7733         if ((copy_count = len_a - i_a) > 0) {
7734             Copy(array_a + i_a, array_u + i_u, copy_count, UV);
7735         }
7736         else if ((copy_count = len_b - i_b) > 0) {
7737             Copy(array_b + i_b, array_u + i_u, copy_count, UV);
7738         }
7739     }
7740
7741     /* If we've changed b, restore it */
7742     if (complement_b) {
7743         array_b[0] = 1;
7744     }
7745
7746     /*  We may be removing a reference to one of the inputs */
7747     if (a == *output || b == *output) {
7748         assert(! invlist_is_iterating(*output));
7749         SvREFCNT_dec_NN(*output);
7750     }
7751
7752     *output = u;
7753     return;
7754 }
7755
7756 void
7757 Perl__invlist_intersection_maybe_complement_2nd(pTHX_ SV* const a, SV* const b, bool complement_b, SV** i)
7758 {
7759     /* Take the intersection of two inversion lists and point <i> to it.  *i
7760      * SHOULD BE DEFINED upon input, and if it points to one of the two lists,
7761      * the reference count to that list will be decremented.
7762      * If <complement_b> is TRUE, the result will be the intersection of <a>
7763      * and the complement (or inversion) of <b> instead of <b> directly.
7764      *
7765      * The basis for this comes from "Unicode Demystified" Chapter 13 by
7766      * Richard Gillam, published by Addison-Wesley, and explained at some
7767      * length there.  The preface says to incorporate its examples into your
7768      * code at your own risk.  In fact, it had bugs
7769      *
7770      * The algorithm is like a merge sort, and is essentially the same as the
7771      * union above
7772      */
7773
7774     UV* array_a;                /* a's array */
7775     UV* array_b;
7776     UV len_a;   /* length of a's array */
7777     UV len_b;
7778
7779     SV* r;                   /* the resulting intersection */
7780     UV* array_r;
7781     UV len_r;
7782
7783     UV i_a = 0;             /* current index into a's array */
7784     UV i_b = 0;
7785     UV i_r = 0;
7786
7787     /* running count, as explained in the algorithm source book; items are
7788      * stopped accumulating and are output when the count changes to/from 2.
7789      * The count is incremented when we start a range that's in the set, and
7790      * decremented when we start a range that's not in the set.  So its range
7791      * is 0 to 2.  Only when the count is 2 is something in the intersection.
7792      */
7793     UV count = 0;
7794
7795     PERL_ARGS_ASSERT__INVLIST_INTERSECTION_MAYBE_COMPLEMENT_2ND;
7796     assert(a != b);
7797
7798     /* Special case if either one is empty */
7799     len_a = _invlist_len(a);
7800     if ((len_a == 0) || ((len_b = _invlist_len(b)) == 0)) {
7801
7802         if (len_a != 0 && complement_b) {
7803
7804             /* Here, 'a' is not empty, therefore from the above 'if', 'b' must
7805              * be empty.  Here, also we are using 'b's complement, which hence
7806              * must be every possible code point.  Thus the intersection is
7807              * simply 'a'. */
7808             if (*i != a) {
7809                 *i = invlist_clone(a);
7810
7811                 if (*i == b) {
7812                     SvREFCNT_dec_NN(b);
7813                 }
7814             }
7815             /* else *i is already 'a' */
7816             return;
7817         }
7818
7819         /* Here, 'a' or 'b' is empty and not using the complement of 'b'.  The
7820          * intersection must be empty */
7821         if (*i == a) {
7822             SvREFCNT_dec_NN(a);
7823         }
7824         else if (*i == b) {
7825             SvREFCNT_dec_NN(b);
7826         }
7827         *i = _new_invlist(0);
7828         return;
7829     }
7830
7831     /* Here both lists exist and are non-empty */
7832     array_a = invlist_array(a);
7833     array_b = invlist_array(b);
7834
7835     /* If are to take the intersection of 'a' with the complement of b, set it
7836      * up so are looking at b's complement. */
7837     if (complement_b) {
7838
7839         /* To complement, we invert: if the first element is 0, remove it.  To
7840          * do this, we just pretend the array starts one later, and clear the
7841          * flag as we don't have to do anything else later */
7842         if (array_b[0] == 0) {
7843             array_b++;
7844             len_b--;
7845             complement_b = FALSE;
7846         }
7847         else {
7848
7849             /* But if the first element is not zero, we unshift a 0 before the
7850              * array.  The data structure reserves a space for that 0 (which
7851              * should be a '1' right now), so physical shifting is unneeded,
7852              * but temporarily change that element to 0.  Before exiting the
7853              * routine, we must restore the element to '1' */
7854             array_b--;
7855             len_b++;
7856             array_b[0] = 0;
7857         }
7858     }
7859
7860     /* Size the intersection for the worst case: that the intersection ends up
7861      * fragmenting everything to be completely disjoint */
7862     r= _new_invlist(len_a + len_b);
7863
7864     /* Will contain U+0000 iff both components do */
7865     array_r = _invlist_array_init(r, len_a > 0 && array_a[0] == 0
7866                                      && len_b > 0 && array_b[0] == 0);
7867
7868     /* Go through each list item by item, stopping when exhausted one of
7869      * them */
7870     while (i_a < len_a && i_b < len_b) {
7871         UV cp;      /* The element to potentially add to the intersection's
7872                        array */
7873         bool cp_in_set; /* Is it in the input list's set or not */
7874
7875         /* We need to take one or the other of the two inputs for the
7876          * intersection.  Since we are merging two sorted lists, we take the
7877          * smaller of the next items.  In case of a tie, we take the one that
7878          * is not in its set first (a difference from the union algorithm).  If
7879          * we took one in the set first, it would increment the count, possibly
7880          * to 2 which would cause it to be output as starting a range in the
7881          * intersection, and the next time through we would take that same
7882          * number, and output it again as ending the set.  By doing it the
7883          * opposite of this, there is no possibility that the count will be
7884          * momentarily incremented to 2.  (In a tie and both are in the set or
7885          * both not in the set, it doesn't matter which we take first.) */
7886         if (array_a[i_a] < array_b[i_b]
7887             || (array_a[i_a] == array_b[i_b]
7888                 && ! ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
7889         {
7890             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
7891             cp= array_a[i_a++];
7892         }
7893         else {
7894             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
7895             cp= array_b[i_b++];
7896         }
7897
7898         /* Here, have chosen which of the two inputs to look at.  Only output
7899          * if the running count changes to/from 2, which marks the
7900          * beginning/end of a range that's in the intersection */
7901         if (cp_in_set) {
7902             count++;
7903             if (count == 2) {
7904                 array_r[i_r++] = cp;
7905             }
7906         }
7907         else {
7908             if (count == 2) {
7909                 array_r[i_r++] = cp;
7910             }
7911             count--;
7912         }
7913     }
7914
7915     /* Here, we are finished going through at least one of the lists, which
7916      * means there is something remaining in at most one.  We check if the list
7917      * that has been exhausted is positioned such that we are in the middle
7918      * of a range in its set or not.  (i_a and i_b point to elements 1 beyond
7919      * the ones we care about.)  There are four cases:
7920      *  1) Both weren't in their sets, count is 0, and remains 0.  There's
7921      *     nothing left in the intersection.
7922      *  2) Both were in their sets, count is 2 and perhaps is incremented to
7923      *     above 2.  What should be output is exactly that which is in the
7924      *     non-exhausted set, as everything it has is also in the intersection
7925      *     set, and everything it doesn't have can't be in the intersection
7926      *  3) The exhausted was in its set, non-exhausted isn't, count is 1, and
7927      *     gets incremented to 2.  Like the previous case, the intersection is
7928      *     everything that remains in the non-exhausted set.
7929      *  4) the exhausted wasn't in its set, non-exhausted is, count is 1, and
7930      *     remains 1.  And the intersection has nothing more. */
7931     if ((i_a == len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
7932         || (i_b == len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
7933     {
7934         count++;
7935     }
7936
7937     /* The final length is what we've output so far plus what else is in the
7938      * intersection.  At most one of the subexpressions below will be non-zero */
7939     len_r = i_r;
7940     if (count >= 2) {
7941         len_r += (len_a - i_a) + (len_b - i_b);
7942     }
7943
7944     /* Set result to final length, which can change the pointer to array_r, so
7945      * re-find it */
7946     if (len_r != _invlist_len(r)) {
7947         invlist_set_len(r, len_r);
7948         invlist_trim(r);
7949         array_r = invlist_array(r);
7950     }
7951
7952     /* Finish outputting any remaining */
7953     if (count >= 2) { /* At most one will have a non-zero copy count */
7954         IV copy_count;
7955         if ((copy_count = len_a - i_a) > 0) {
7956             Copy(array_a + i_a, array_r + i_r, copy_count, UV);
7957         }
7958         else if ((copy_count = len_b - i_b) > 0) {
7959             Copy(array_b + i_b, array_r + i_r, copy_count, UV);
7960         }
7961     }
7962
7963     /* If we've changed b, restore it */
7964     if (complement_b) {
7965         array_b[0] = 1;
7966     }
7967
7968     /*  We may be removing a reference to one of the inputs */
7969     if (a == *i || b == *i) {
7970         assert(! invlist_is_iterating(*i));
7971         SvREFCNT_dec_NN(*i);
7972     }
7973
7974     *i = r;
7975     return;
7976 }
7977
7978 SV*
7979 Perl__add_range_to_invlist(pTHX_ SV* invlist, const UV start, const UV end)
7980 {
7981     /* Add the range from 'start' to 'end' inclusive to the inversion list's
7982      * set.  A pointer to the inversion list is returned.  This may actually be
7983      * a new list, in which case the passed in one has been destroyed.  The
7984      * passed in inversion list can be NULL, in which case a new one is created
7985      * with just the one range in it */
7986
7987     SV* range_invlist;
7988     UV len;
7989
7990     if (invlist == NULL) {
7991         invlist = _new_invlist(2);
7992         len = 0;
7993     }
7994     else {
7995         len = _invlist_len(invlist);
7996     }
7997
7998     /* If comes after the final entry actually in the list, can just append it
7999      * to the end, */
8000     if (len == 0
8001         || (! ELEMENT_RANGE_MATCHES_INVLIST(len - 1)
8002             && start >= invlist_array(invlist)[len - 1]))
8003     {
8004         _append_range_to_invlist(invlist, start, end);
8005         return invlist;
8006     }
8007
8008     /* Here, can't just append things, create and return a new inversion list
8009      * which is the union of this range and the existing inversion list */
8010     range_invlist = _new_invlist(2);
8011     _append_range_to_invlist(range_invlist, start, end);
8012
8013     _invlist_union(invlist, range_invlist, &invlist);
8014
8015     /* The temporary can be freed */
8016     SvREFCNT_dec_NN(range_invlist);
8017
8018     return invlist;
8019 }
8020
8021 #endif
8022
8023 PERL_STATIC_INLINE SV*
8024 S_add_cp_to_invlist(pTHX_ SV* invlist, const UV cp) {
8025     return _add_range_to_invlist(invlist, cp, cp);
8026 }
8027
8028 #ifndef PERL_IN_XSUB_RE
8029 void
8030 Perl__invlist_invert(pTHX_ SV* const invlist)
8031 {
8032     /* Complement the input inversion list.  This adds a 0 if the list didn't
8033      * have a zero; removes it otherwise.  As described above, the data
8034      * structure is set up so that this is very efficient */
8035
8036     UV* len_pos = _get_invlist_len_addr(invlist);
8037
8038     PERL_ARGS_ASSERT__INVLIST_INVERT;
8039
8040     assert(! invlist_is_iterating(invlist));
8041
8042     /* The inverse of matching nothing is matching everything */
8043     if (*len_pos == 0) {
8044         _append_range_to_invlist(invlist, 0, UV_MAX);
8045         return;
8046     }
8047
8048     /* The exclusive or complents 0 to 1; and 1 to 0.  If the result is 1, the
8049      * zero element was a 0, so it is being removed, so the length decrements
8050      * by 1; and vice-versa.  SvCUR is unaffected */
8051     if (*get_invlist_zero_addr(invlist) ^= 1) {
8052         (*len_pos)--;
8053     }
8054     else {
8055         (*len_pos)++;
8056     }
8057 }
8058
8059 void
8060 Perl__invlist_invert_prop(pTHX_ SV* const invlist)
8061 {
8062     /* Complement the input inversion list (which must be a Unicode property,
8063      * all of which don't match above the Unicode maximum code point.)  And
8064      * Perl has chosen to not have the inversion match above that either.  This
8065      * adds a 0x110000 if the list didn't end with it, and removes it if it did
8066      */
8067
8068     UV len;
8069     UV* array;
8070
8071     PERL_ARGS_ASSERT__INVLIST_INVERT_PROP;
8072
8073     _invlist_invert(invlist);
8074
8075     len = _invlist_len(invlist);
8076
8077     if (len != 0) { /* If empty do nothing */
8078         array = invlist_array(invlist);
8079         if (array[len - 1] != PERL_UNICODE_MAX + 1) {
8080             /* Add 0x110000.  First, grow if necessary */
8081             len++;
8082             if (invlist_max(invlist) < len) {
8083                 invlist_extend(invlist, len);
8084                 array = invlist_array(invlist);
8085             }
8086             invlist_set_len(invlist, len);
8087             array[len - 1] = PERL_UNICODE_MAX + 1;
8088         }
8089         else {  /* Remove the 0x110000 */
8090             invlist_set_len(invlist, len - 1);
8091         }
8092     }
8093
8094     return;
8095 }
8096 #endif
8097
8098 PERL_STATIC_INLINE SV*
8099 S_invlist_clone(pTHX_ SV* const invlist)
8100 {
8101
8102     /* Return a new inversion list that is a copy of the input one, which is
8103      * unchanged */
8104
8105     /* Need to allocate extra space to accommodate Perl's addition of a
8106      * trailing NUL to SvPV's, since it thinks they are always strings */
8107     SV* new_invlist = _new_invlist(_invlist_len(invlist) + 1);
8108     STRLEN length = SvCUR(invlist);
8109
8110     PERL_ARGS_ASSERT_INVLIST_CLONE;
8111
8112     SvCUR_set(new_invlist, length); /* This isn't done automatically */
8113     Copy(SvPVX(invlist), SvPVX(new_invlist), length, char);
8114
8115     return new_invlist;
8116 }
8117
8118 PERL_STATIC_INLINE UV*
8119 S_get_invlist_iter_addr(pTHX_ SV* invlist)
8120 {
8121     /* Return the address of the UV that contains the current iteration
8122      * position */
8123
8124     PERL_ARGS_ASSERT_GET_INVLIST_ITER_ADDR;
8125
8126     return (UV *) (SvPVX(invlist) + (INVLIST_ITER_OFFSET * sizeof (UV)));
8127 }
8128
8129 PERL_STATIC_INLINE UV*
8130 S_get_invlist_version_id_addr(pTHX_ SV* invlist)
8131 {
8132     /* Return the address of the UV that contains the version id. */
8133
8134     PERL_ARGS_ASSERT_GET_INVLIST_VERSION_ID_ADDR;
8135
8136     return (UV *) (SvPVX(invlist) + (INVLIST_VERSION_ID_OFFSET * sizeof (UV)));
8137 }
8138
8139 PERL_STATIC_INLINE void
8140 S_invlist_iterinit(pTHX_ SV* invlist)   /* Initialize iterator for invlist */
8141 {
8142     PERL_ARGS_ASSERT_INVLIST_ITERINIT;
8143
8144     *get_invlist_iter_addr(invlist) = 0;
8145 }
8146
8147 PERL_STATIC_INLINE void
8148 S_invlist_iterfinish(pTHX_ SV* invlist)
8149 {
8150     /* Terminate iterator for invlist.  This is to catch development errors.
8151      * Any iteration that is interrupted before completed should call this
8152      * function.  Functions that add code points anywhere else but to the end
8153      * of an inversion list assert that they are not in the middle of an
8154      * iteration.  If they were, the addition would make the iteration
8155      * problematical: if the iteration hadn't reached the place where things
8156      * were being added, it would be ok */
8157
8158     PERL_ARGS_ASSERT_INVLIST_ITERFINISH;
8159
8160     *get_invlist_iter_addr(invlist) = UV_MAX;
8161 }
8162
8163 STATIC bool
8164 S_invlist_iternext(pTHX_ SV* invlist, UV* start, UV* end)
8165 {
8166     /* An C<invlist_iterinit> call on <invlist> must be used to set this up.
8167      * This call sets in <*start> and <*end>, the next range in <invlist>.
8168      * Returns <TRUE> if successful and the next call will return the next
8169      * range; <FALSE> if was already at the end of the list.  If the latter,
8170      * <*start> and <*end> are unchanged, and the next call to this function
8171      * will start over at the beginning of the list */
8172
8173     UV* pos = get_invlist_iter_addr(invlist);
8174     UV len = _invlist_len(invlist);
8175     UV *array;
8176
8177     PERL_ARGS_ASSERT_INVLIST_ITERNEXT;
8178
8179     if (*pos >= len) {
8180         *pos = UV_MAX;  /* Force iterinit() to be required next time */
8181         return FALSE;
8182     }
8183
8184     array = invlist_array(invlist);
8185
8186     *start = array[(*pos)++];
8187
8188     if (*pos >= len) {
8189         *end = UV_MAX;
8190     }
8191     else {
8192         *end = array[(*pos)++] - 1;
8193     }
8194
8195     return TRUE;
8196 }
8197
8198 PERL_STATIC_INLINE bool
8199 S_invlist_is_iterating(pTHX_ SV* const invlist)
8200 {
8201     PERL_ARGS_ASSERT_INVLIST_IS_ITERATING;
8202
8203     return *(get_invlist_iter_addr(invlist)) < UV_MAX;
8204 }
8205
8206 PERL_STATIC_INLINE UV
8207 S_invlist_highest(pTHX_ SV* const invlist)
8208 {
8209     /* Returns the highest code point that matches an inversion list.  This API
8210      * has an ambiguity, as it returns 0 under either the highest is actually
8211      * 0, or if the list is empty.  If this distinction matters to you, check
8212      * for emptiness before calling this function */
8213
8214     UV len = _invlist_len(invlist);
8215     UV *array;
8216
8217     PERL_ARGS_ASSERT_INVLIST_HIGHEST;
8218
8219     if (len == 0) {
8220         return 0;
8221     }
8222
8223     array = invlist_array(invlist);
8224
8225     /* The last element in the array in the inversion list always starts a
8226      * range that goes to infinity.  That range may be for code points that are
8227      * matched in the inversion list, or it may be for ones that aren't
8228      * matched.  In the latter case, the highest code point in the set is one
8229      * less than the beginning of this range; otherwise it is the final element
8230      * of this range: infinity */
8231     return (ELEMENT_RANGE_MATCHES_INVLIST(len - 1))
8232            ? UV_MAX
8233            : array[len - 1] - 1;
8234 }
8235
8236 #ifndef PERL_IN_XSUB_RE
8237 SV *
8238 Perl__invlist_contents(pTHX_ SV* const invlist)
8239 {
8240     /* Get the contents of an inversion list into a string SV so that they can
8241      * be printed out.  It uses the format traditionally done for debug tracing
8242      */
8243
8244     UV start, end;
8245     SV* output = newSVpvs("\n");
8246
8247     PERL_ARGS_ASSERT__INVLIST_CONTENTS;
8248
8249     assert(! invlist_is_iterating(invlist));
8250
8251     invlist_iterinit(invlist);
8252     while (invlist_iternext(invlist, &start, &end)) {
8253         if (end == UV_MAX) {
8254             Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\tINFINITY\n", start);
8255         }
8256         else if (end != start) {
8257             Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\t%04"UVXf"\n",
8258                     start,       end);
8259         }
8260         else {
8261             Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\n", start);
8262         }
8263     }
8264
8265     return output;
8266 }
8267 #endif
8268
8269 #ifdef PERL_ARGS_ASSERT__INVLIST_DUMP
8270 void
8271 Perl__invlist_dump(pTHX_ SV* const invlist, const char * const header)
8272 {
8273     /* Dumps out the ranges in an inversion list.  The string 'header'
8274      * if present is output on a line before the first range */
8275
8276     UV start, end;
8277
8278     PERL_ARGS_ASSERT__INVLIST_DUMP;
8279
8280     if (header && strlen(header)) {
8281         PerlIO_printf(Perl_debug_log, "%s\n", header);
8282     }
8283     if (invlist_is_iterating(invlist)) {
8284         PerlIO_printf(Perl_debug_log, "Can't dump because is in middle of iterating\n");
8285         return;
8286     }
8287
8288     invlist_iterinit(invlist);
8289     while (invlist_iternext(invlist, &start, &end)) {
8290         if (end == UV_MAX) {
8291             PerlIO_printf(Perl_debug_log, "0x%04"UVXf" .. INFINITY\n", start);
8292         }
8293         else if (end != start) {
8294             PerlIO_printf(Perl_debug_log, "0x%04"UVXf" .. 0x%04"UVXf"\n",
8295                                                  start,         end);
8296         }
8297         else {
8298             PerlIO_printf(Perl_debug_log, "0x%04"UVXf"\n", start);
8299         }
8300     }
8301 }
8302 #endif
8303
8304 #if 0
8305 bool
8306 S__invlistEQ(pTHX_ SV* const a, SV* const b, bool complement_b)
8307 {
8308     /* Return a boolean as to if the two passed in inversion lists are
8309      * identical.  The final argument, if TRUE, says to take the complement of
8310      * the second inversion list before doing the comparison */
8311
8312     UV* array_a = invlist_array(a);
8313     UV* array_b = invlist_array(b);
8314     UV len_a = _invlist_len(a);
8315     UV len_b = _invlist_len(b);
8316
8317     UV i = 0;               /* current index into the arrays */
8318     bool retval = TRUE;     /* Assume are identical until proven otherwise */
8319
8320     PERL_ARGS_ASSERT__INVLISTEQ;
8321
8322     /* If are to compare 'a' with the complement of b, set it
8323      * up so are looking at b's complement. */
8324     if (complement_b) {
8325
8326         /* The complement of nothing is everything, so <a> would have to have
8327          * just one element, starting at zero (ending at infinity) */
8328         if (len_b == 0) {
8329             return (len_a == 1 && array_a[0] == 0);
8330         }
8331         else if (array_b[0] == 0) {
8332
8333             /* Otherwise, to complement, we invert.  Here, the first element is
8334              * 0, just remove it.  To do this, we just pretend the array starts
8335              * one later, and clear the flag as we don't have to do anything
8336              * else later */
8337
8338             array_b++;
8339             len_b--;
8340             complement_b = FALSE;
8341         }
8342         else {
8343
8344             /* But if the first element is not zero, we unshift a 0 before the
8345              * array.  The data structure reserves a space for that 0 (which
8346              * should be a '1' right now), so physical shifting is unneeded,
8347              * but temporarily change that element to 0.  Before exiting the
8348              * routine, we must restore the element to '1' */
8349             array_b--;
8350             len_b++;
8351             array_b[0] = 0;
8352         }
8353     }
8354
8355     /* Make sure that the lengths are the same, as well as the final element
8356      * before looping through the remainder.  (Thus we test the length, final,
8357      * and first elements right off the bat) */
8358     if (len_a != len_b || array_a[len_a-1] != array_b[len_a-1]) {
8359         retval = FALSE;
8360     }
8361     else for (i = 0; i < len_a - 1; i++) {
8362         if (array_a[i] != array_b[i]) {
8363             retval = FALSE;
8364             break;
8365         }
8366     }
8367
8368     if (complement_b) {
8369         array_b[0] = 1;
8370     }
8371     return retval;
8372 }
8373 #endif
8374
8375 #undef HEADER_LENGTH
8376 #undef INVLIST_INITIAL_LENGTH
8377 #undef TO_INTERNAL_SIZE
8378 #undef FROM_INTERNAL_SIZE
8379 #undef INVLIST_LEN_OFFSET
8380 #undef INVLIST_ZERO_OFFSET
8381 #undef INVLIST_ITER_OFFSET
8382 #undef INVLIST_VERSION_ID
8383 #undef INVLIST_PREVIOUS_INDEX_OFFSET
8384
8385 /* End of inversion list object */
8386
8387 STATIC void
8388 S_parse_lparen_question_flags(pTHX_ struct RExC_state_t *pRExC_state)
8389 {
8390     /* This parses the flags that are in either the '(?foo)' or '(?foo:bar)'
8391      * constructs, and updates RExC_flags with them.  On input, RExC_parse
8392      * should point to the first flag; it is updated on output to point to the
8393      * final ')' or ':'.  There needs to be at least one flag, or this will
8394      * abort */
8395
8396     /* for (?g), (?gc), and (?o) warnings; warning
8397        about (?c) will warn about (?g) -- japhy    */
8398
8399 #define WASTED_O  0x01
8400 #define WASTED_G  0x02
8401 #define WASTED_C  0x04
8402 #define WASTED_GC (0x02|0x04)
8403     I32 wastedflags = 0x00;
8404     U32 posflags = 0, negflags = 0;
8405     U32 *flagsp = &posflags;
8406     char has_charset_modifier = '\0';
8407     regex_charset cs;
8408     bool has_use_defaults = FALSE;
8409     const char* const seqstart = RExC_parse - 1; /* Point to the '?' */
8410
8411     PERL_ARGS_ASSERT_PARSE_LPAREN_QUESTION_FLAGS;
8412
8413     /* '^' as an initial flag sets certain defaults */
8414     if (UCHARAT(RExC_parse) == '^') {
8415         RExC_parse++;
8416         has_use_defaults = TRUE;
8417         STD_PMMOD_FLAGS_CLEAR(&RExC_flags);
8418         set_regex_charset(&RExC_flags, (RExC_utf8 || RExC_uni_semantics)
8419                                         ? REGEX_UNICODE_CHARSET
8420                                         : REGEX_DEPENDS_CHARSET);
8421     }
8422
8423     cs = get_regex_charset(RExC_flags);
8424     if (cs == REGEX_DEPENDS_CHARSET
8425         && (RExC_utf8 || RExC_uni_semantics))
8426     {
8427         cs = REGEX_UNICODE_CHARSET;
8428     }
8429
8430     while (*RExC_parse) {
8431         /* && strchr("iogcmsx", *RExC_parse) */
8432         /* (?g), (?gc) and (?o) are useless here
8433            and must be globally applied -- japhy */
8434         switch (*RExC_parse) {
8435
8436             /* Code for the imsx flags */
8437             CASE_STD_PMMOD_FLAGS_PARSE_SET(flagsp);
8438
8439             case LOCALE_PAT_MOD:
8440                 if (has_charset_modifier) {
8441                     goto excess_modifier;
8442                 }
8443                 else if (flagsp == &negflags) {
8444                     goto neg_modifier;
8445                 }
8446                 cs = REGEX_LOCALE_CHARSET;
8447                 has_charset_modifier = LOCALE_PAT_MOD;
8448                 RExC_contains_locale = 1;
8449                 break;
8450             case UNICODE_PAT_MOD:
8451                 if (has_charset_modifier) {
8452                     goto excess_modifier;
8453                 }
8454                 else if (flagsp == &negflags) {
8455                     goto neg_modifier;
8456                 }
8457                 cs = REGEX_UNICODE_CHARSET;
8458                 has_charset_modifier = UNICODE_PAT_MOD;
8459                 break;
8460             case ASCII_RESTRICT_PAT_MOD:
8461                 if (flagsp == &negflags) {
8462                     goto neg_modifier;
8463                 }
8464                 if (has_charset_modifier) {
8465                     if (cs != REGEX_ASCII_RESTRICTED_CHARSET) {
8466                         goto excess_modifier;
8467                     }
8468                     /* Doubled modifier implies more restricted */
8469                     cs = REGEX_ASCII_MORE_RESTRICTED_CHARSET;
8470                 }
8471                 else {
8472                     cs = REGEX_ASCII_RESTRICTED_CHARSET;
8473                 }
8474                 has_charset_modifier = ASCII_RESTRICT_PAT_MOD;
8475                 break;
8476             case DEPENDS_PAT_MOD:
8477                 if (has_use_defaults) {
8478                     goto fail_modifiers;
8479                 }
8480                 else if (flagsp == &negflags) {
8481                     goto neg_modifier;
8482                 }
8483                 else if (has_charset_modifier) {
8484                     goto excess_modifier;
8485                 }
8486
8487                 /* The dual charset means unicode semantics if the
8488                  * pattern (or target, not known until runtime) are
8489                  * utf8, or something in the pattern indicates unicode
8490                  * semantics */
8491                 cs = (RExC_utf8 || RExC_uni_semantics)
8492                      ? REGEX_UNICODE_CHARSET
8493                      : REGEX_DEPENDS_CHARSET;
8494                 has_charset_modifier = DEPENDS_PAT_MOD;
8495                 break;
8496             excess_modifier:
8497                 RExC_parse++;
8498                 if (has_charset_modifier == ASCII_RESTRICT_PAT_MOD) {
8499                     vFAIL2("Regexp modifier \"%c\" may appear a maximum of twice", ASCII_RESTRICT_PAT_MOD);
8500                 }
8501                 else if (has_charset_modifier == *(RExC_parse - 1)) {
8502                     vFAIL2("Regexp modifier \"%c\" may not appear twice", *(RExC_parse - 1));
8503                 }
8504                 else {
8505                     vFAIL3("Regexp modifiers \"%c\" and \"%c\" are mutually exclusive", has_charset_modifier, *(RExC_parse - 1));
8506                 }
8507                 /*NOTREACHED*/
8508             neg_modifier:
8509                 RExC_parse++;
8510                 vFAIL2("Regexp modifier \"%c\" may not appear after the \"-\"", *(RExC_parse - 1));
8511                 /*NOTREACHED*/
8512             case ONCE_PAT_MOD: /* 'o' */
8513             case GLOBAL_PAT_MOD: /* 'g' */
8514                 if (SIZE_ONLY && ckWARN(WARN_REGEXP)) {
8515                     const I32 wflagbit = *RExC_parse == 'o' ? WASTED_O : WASTED_G;
8516                     if (! (wastedflags & wflagbit) ) {
8517                         wastedflags |= wflagbit;
8518                         vWARN5(
8519                             RExC_parse + 1,
8520                             "Useless (%s%c) - %suse /%c modifier",
8521                             flagsp == &negflags ? "?-" : "?",
8522                             *RExC_parse,
8523                             flagsp == &negflags ? "don't " : "",
8524                             *RExC_parse
8525                         );
8526                     }
8527                 }
8528                 break;
8529
8530             case CONTINUE_PAT_MOD: /* 'c' */
8531                 if (SIZE_ONLY && ckWARN(WARN_REGEXP)) {
8532                     if (! (wastedflags & WASTED_C) ) {
8533                         wastedflags |= WASTED_GC;
8534                         vWARN3(
8535                             RExC_parse + 1,
8536                             "Useless (%sc) - %suse /gc modifier",
8537                             flagsp == &negflags ? "?-" : "?",
8538                             flagsp == &negflags ? "don't " : ""
8539                         );
8540                     }
8541                 }
8542                 break;
8543             case KEEPCOPY_PAT_MOD: /* 'p' */
8544                 if (flagsp == &negflags) {
8545                     if (SIZE_ONLY)
8546                         ckWARNreg(RExC_parse + 1,"Useless use of (?-p)");
8547                 } else {
8548                     *flagsp |= RXf_PMf_KEEPCOPY;
8549                 }
8550                 break;
8551             case '-':
8552                 /* A flag is a default iff it is following a minus, so
8553                  * if there is a minus, it means will be trying to
8554                  * re-specify a default which is an error */
8555                 if (has_use_defaults || flagsp == &negflags) {
8556                     goto fail_modifiers;
8557                 }
8558                 flagsp = &negflags;
8559                 wastedflags = 0;  /* reset so (?g-c) warns twice */
8560                 break;
8561             case ':':
8562             case ')':
8563                 RExC_flags |= posflags;
8564                 RExC_flags &= ~negflags;
8565                 set_regex_charset(&RExC_flags, cs);
8566                 return;
8567                 /*NOTREACHED*/
8568             default:
8569             fail_modifiers:
8570                 RExC_parse++;
8571                 vFAIL3("Sequence (%.*s...) not recognized",
8572                        RExC_parse-seqstart, seqstart);
8573                 /*NOTREACHED*/
8574         }
8575
8576         ++RExC_parse;
8577     }
8578 }
8579
8580 /*
8581  - reg - regular expression, i.e. main body or parenthesized thing
8582  *
8583  * Caller must absorb opening parenthesis.
8584  *
8585  * Combining parenthesis handling with the base level of regular expression
8586  * is a trifle forced, but the need to tie the tails of the branches to what
8587  * follows makes it hard to avoid.
8588  */
8589 #define REGTAIL(x,y,z) regtail((x),(y),(z),depth+1)
8590 #ifdef DEBUGGING
8591 #define REGTAIL_STUDY(x,y,z) regtail_study((x),(y),(z),depth+1)
8592 #else
8593 #define REGTAIL_STUDY(x,y,z) regtail((x),(y),(z),depth+1)
8594 #endif
8595
8596 /* Returns NULL, setting *flagp to TRYAGAIN at the end of (?) that only sets
8597    flags. Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan
8598    needs to be restarted.
8599    Otherwise would only return NULL if regbranch() returns NULL, which
8600    cannot happen.  */
8601 STATIC regnode *
8602 S_reg(pTHX_ RExC_state_t *pRExC_state, I32 paren, I32 *flagp,U32 depth)
8603     /* paren: Parenthesized? 0=top; 1,2=inside '(': changed to letter.
8604      * 2 is like 1, but indicates that nextchar() has been called to advance
8605      * RExC_parse beyond the '('.  Things like '(?' are indivisible tokens, and
8606      * this flag alerts us to the need to check for that */
8607 {
8608     dVAR;
8609     regnode *ret;               /* Will be the head of the group. */
8610     regnode *br;
8611     regnode *lastbr;
8612     regnode *ender = NULL;
8613     I32 parno = 0;
8614     I32 flags;
8615     U32 oregflags = RExC_flags;
8616     bool have_branch = 0;
8617     bool is_open = 0;
8618     I32 freeze_paren = 0;
8619     I32 after_freeze = 0;
8620
8621     char * parse_start = RExC_parse; /* MJD */
8622     char * const oregcomp_parse = RExC_parse;
8623
8624     GET_RE_DEBUG_FLAGS_DECL;
8625
8626     PERL_ARGS_ASSERT_REG;
8627     DEBUG_PARSE("reg ");
8628
8629     *flagp = 0;                         /* Tentatively. */
8630
8631
8632     /* Make an OPEN node, if parenthesized. */
8633     if (paren) {
8634
8635         /* Under /x, space and comments can be gobbled up between the '(' and
8636          * here (if paren ==2).  The forms '(*VERB' and '(?...' disallow such
8637          * intervening space, as the sequence is a token, and a token should be
8638          * indivisible */
8639         bool has_intervening_patws = paren == 2 && *(RExC_parse - 1) != '(';
8640
8641         if ( *RExC_parse == '*') { /* (*VERB:ARG) */
8642             char *start_verb = RExC_parse;
8643             STRLEN verb_len = 0;
8644             char *start_arg = NULL;
8645             unsigned char op = 0;
8646             int argok = 1;
8647             int internal_argval = 0; /* internal_argval is only useful if !argok */
8648
8649             if (has_intervening_patws && SIZE_ONLY) {
8650                 ckWARNregdep(RExC_parse + 1, "In '(*VERB...)', splitting the initial '(*' is deprecated");
8651             }
8652             while ( *RExC_parse && *RExC_parse != ')' ) {
8653                 if ( *RExC_parse == ':' ) {
8654                     start_arg = RExC_parse + 1;
8655                     break;
8656                 }
8657                 RExC_parse++;
8658             }
8659             ++start_verb;
8660             verb_len = RExC_parse - start_verb;
8661             if ( start_arg ) {
8662                 RExC_parse++;
8663                 while ( *RExC_parse && *RExC_parse != ')' ) 
8664                     RExC_parse++;
8665                 if ( *RExC_parse != ')' ) 
8666                     vFAIL("Unterminated verb pattern argument");
8667                 if ( RExC_parse == start_arg )
8668                     start_arg = NULL;
8669             } else {
8670                 if ( *RExC_parse != ')' )
8671                     vFAIL("Unterminated verb pattern");
8672             }
8673             
8674             switch ( *start_verb ) {
8675             case 'A':  /* (*ACCEPT) */
8676                 if ( memEQs(start_verb,verb_len,"ACCEPT") ) {
8677                     op = ACCEPT;
8678                     internal_argval = RExC_nestroot;
8679                 }
8680                 break;
8681             case 'C':  /* (*COMMIT) */
8682                 if ( memEQs(start_verb,verb_len,"COMMIT") )
8683                     op = COMMIT;
8684                 break;
8685             case 'F':  /* (*FAIL) */
8686                 if ( verb_len==1 || memEQs(start_verb,verb_len,"FAIL") ) {
8687                     op = OPFAIL;
8688                     argok = 0;
8689                 }
8690                 break;
8691             case ':':  /* (*:NAME) */
8692             case 'M':  /* (*MARK:NAME) */
8693                 if ( verb_len==0 || memEQs(start_verb,verb_len,"MARK") ) {
8694                     op = MARKPOINT;
8695                     argok = -1;
8696                 }
8697                 break;
8698             case 'P':  /* (*PRUNE) */
8699                 if ( memEQs(start_verb,verb_len,"PRUNE") )
8700                     op = PRUNE;
8701                 break;
8702             case 'S':   /* (*SKIP) */  
8703                 if ( memEQs(start_verb,verb_len,"SKIP") ) 
8704                     op = SKIP;
8705                 break;
8706             case 'T':  /* (*THEN) */
8707                 /* [19:06] <TimToady> :: is then */
8708                 if ( memEQs(start_verb,verb_len,"THEN") ) {
8709                     op = CUTGROUP;
8710                     RExC_seen |= REG_SEEN_CUTGROUP;
8711                 }
8712                 break;
8713             }
8714             if ( ! op ) {
8715                 RExC_parse++;
8716                 vFAIL3("Unknown verb pattern '%.*s'",
8717                     verb_len, start_verb);
8718             }
8719             if ( argok ) {
8720                 if ( start_arg && internal_argval ) {
8721                     vFAIL3("Verb pattern '%.*s' may not have an argument",
8722                         verb_len, start_verb); 
8723                 } else if ( argok < 0 && !start_arg ) {
8724                     vFAIL3("Verb pattern '%.*s' has a mandatory argument",
8725                         verb_len, start_verb);    
8726                 } else {
8727                     ret = reganode(pRExC_state, op, internal_argval);
8728                     if ( ! internal_argval && ! SIZE_ONLY ) {
8729                         if (start_arg) {
8730                             SV *sv = newSVpvn( start_arg, RExC_parse - start_arg);
8731                             ARG(ret) = add_data( pRExC_state, 1, "S" );
8732                             RExC_rxi->data->data[ARG(ret)]=(void*)sv;
8733                             ret->flags = 0;
8734                         } else {
8735                             ret->flags = 1; 
8736                         }
8737                     }               
8738                 }
8739                 if (!internal_argval)
8740                     RExC_seen |= REG_SEEN_VERBARG;
8741             } else if ( start_arg ) {
8742                 vFAIL3("Verb pattern '%.*s' may not have an argument",
8743                         verb_len, start_verb);    
8744             } else {
8745                 ret = reg_node(pRExC_state, op);
8746             }
8747             nextchar(pRExC_state);
8748             return ret;
8749         } else 
8750         if (*RExC_parse == '?') { /* (?...) */
8751             bool is_logical = 0;
8752             const char * const seqstart = RExC_parse;
8753             if (has_intervening_patws && SIZE_ONLY) {
8754                 ckWARNregdep(RExC_parse + 1, "In '(?...)', splitting the initial '(?' is deprecated");
8755             }
8756
8757             RExC_parse++;
8758             paren = *RExC_parse++;
8759             ret = NULL;                 /* For look-ahead/behind. */
8760             switch (paren) {
8761
8762             case 'P':   /* (?P...) variants for those used to PCRE/Python */
8763                 paren = *RExC_parse++;
8764                 if ( paren == '<')         /* (?P<...>) named capture */
8765                     goto named_capture;
8766                 else if (paren == '>') {   /* (?P>name) named recursion */
8767                     goto named_recursion;
8768                 }
8769                 else if (paren == '=') {   /* (?P=...)  named backref */
8770                     /* this pretty much dupes the code for \k<NAME> in regatom(), if
8771                        you change this make sure you change that */
8772                     char* name_start = RExC_parse;
8773                     U32 num = 0;
8774                     SV *sv_dat = reg_scan_name(pRExC_state,
8775                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
8776                     if (RExC_parse == name_start || *RExC_parse != ')')
8777                         vFAIL2("Sequence %.3s... not terminated",parse_start);
8778
8779                     if (!SIZE_ONLY) {
8780                         num = add_data( pRExC_state, 1, "S" );
8781                         RExC_rxi->data->data[num]=(void*)sv_dat;
8782                         SvREFCNT_inc_simple_void(sv_dat);
8783                     }
8784                     RExC_sawback = 1;
8785                     ret = reganode(pRExC_state,
8786                                    ((! FOLD)
8787                                      ? NREF
8788                                      : (ASCII_FOLD_RESTRICTED)
8789                                        ? NREFFA
8790                                        : (AT_LEAST_UNI_SEMANTICS)
8791                                          ? NREFFU
8792                                          : (LOC)
8793                                            ? NREFFL
8794                                            : NREFF),
8795                                     num);
8796                     *flagp |= HASWIDTH;
8797
8798                     Set_Node_Offset(ret, parse_start+1);
8799                     Set_Node_Cur_Length(ret); /* MJD */
8800
8801                     nextchar(pRExC_state);
8802                     return ret;
8803                 }
8804                 RExC_parse++;
8805                 vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
8806                 /*NOTREACHED*/
8807             case '<':           /* (?<...) */
8808                 if (*RExC_parse == '!')
8809                     paren = ',';
8810                 else if (*RExC_parse != '=') 
8811               named_capture:
8812                 {               /* (?<...>) */
8813                     char *name_start;
8814                     SV *svname;
8815                     paren= '>';
8816             case '\'':          /* (?'...') */
8817                     name_start= RExC_parse;
8818                     svname = reg_scan_name(pRExC_state,
8819                         SIZE_ONLY ?  /* reverse test from the others */
8820                         REG_RSN_RETURN_NAME : 
8821                         REG_RSN_RETURN_NULL);
8822                     if (RExC_parse == name_start) {
8823                         RExC_parse++;
8824                         vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
8825                         /*NOTREACHED*/
8826                     }
8827                     if (*RExC_parse != paren)
8828                         vFAIL2("Sequence (?%c... not terminated",
8829                             paren=='>' ? '<' : paren);
8830                     if (SIZE_ONLY) {
8831                         HE *he_str;
8832                         SV *sv_dat = NULL;
8833                         if (!svname) /* shouldn't happen */
8834                             Perl_croak(aTHX_
8835                                 "panic: reg_scan_name returned NULL");
8836                         if (!RExC_paren_names) {
8837                             RExC_paren_names= newHV();
8838                             sv_2mortal(MUTABLE_SV(RExC_paren_names));
8839 #ifdef DEBUGGING
8840                             RExC_paren_name_list= newAV();
8841                             sv_2mortal(MUTABLE_SV(RExC_paren_name_list));
8842 #endif
8843                         }
8844                         he_str = hv_fetch_ent( RExC_paren_names, svname, 1, 0 );
8845                         if ( he_str )
8846                             sv_dat = HeVAL(he_str);
8847                         if ( ! sv_dat ) {
8848                             /* croak baby croak */
8849                             Perl_croak(aTHX_
8850                                 "panic: paren_name hash element allocation failed");
8851                         } else if ( SvPOK(sv_dat) ) {
8852                             /* (?|...) can mean we have dupes so scan to check
8853                                its already been stored. Maybe a flag indicating
8854                                we are inside such a construct would be useful,
8855                                but the arrays are likely to be quite small, so
8856                                for now we punt -- dmq */
8857                             IV count = SvIV(sv_dat);
8858                             I32 *pv = (I32*)SvPVX(sv_dat);
8859                             IV i;
8860                             for ( i = 0 ; i < count ; i++ ) {
8861                                 if ( pv[i] == RExC_npar ) {
8862                                     count = 0;
8863                                     break;
8864                                 }
8865                             }
8866                             if ( count ) {
8867                                 pv = (I32*)SvGROW(sv_dat, SvCUR(sv_dat) + sizeof(I32)+1);
8868                                 SvCUR_set(sv_dat, SvCUR(sv_dat) + sizeof(I32));
8869                                 pv[count] = RExC_npar;
8870                                 SvIV_set(sv_dat, SvIVX(sv_dat) + 1);
8871                             }
8872                         } else {
8873                             (void)SvUPGRADE(sv_dat,SVt_PVNV);
8874                             sv_setpvn(sv_dat, (char *)&(RExC_npar), sizeof(I32));
8875                             SvIOK_on(sv_dat);
8876                             SvIV_set(sv_dat, 1);
8877                         }
8878 #ifdef DEBUGGING
8879                         /* Yes this does cause a memory leak in debugging Perls */
8880                         if (!av_store(RExC_paren_name_list, RExC_npar, SvREFCNT_inc(svname)))
8881                             SvREFCNT_dec_NN(svname);
8882 #endif
8883
8884                         /*sv_dump(sv_dat);*/
8885                     }
8886                     nextchar(pRExC_state);
8887                     paren = 1;
8888                     goto capturing_parens;
8889                 }
8890                 RExC_seen |= REG_SEEN_LOOKBEHIND;
8891                 RExC_in_lookbehind++;
8892                 RExC_parse++;
8893             case '=':           /* (?=...) */
8894                 RExC_seen_zerolen++;
8895                 break;
8896             case '!':           /* (?!...) */
8897                 RExC_seen_zerolen++;
8898                 if (*RExC_parse == ')') {
8899                     ret=reg_node(pRExC_state, OPFAIL);
8900                     nextchar(pRExC_state);
8901                     return ret;
8902                 }
8903                 break;
8904             case '|':           /* (?|...) */
8905                 /* branch reset, behave like a (?:...) except that
8906                    buffers in alternations share the same numbers */
8907                 paren = ':'; 
8908                 after_freeze = freeze_paren = RExC_npar;
8909                 break;
8910             case ':':           /* (?:...) */
8911             case '>':           /* (?>...) */
8912                 break;
8913             case '$':           /* (?$...) */
8914             case '@':           /* (?@...) */
8915                 vFAIL2("Sequence (?%c...) not implemented", (int)paren);
8916                 break;
8917             case '#':           /* (?#...) */
8918                 /* XXX As soon as we disallow separating the '?' and '*' (by
8919                  * spaces or (?#...) comment), it is believed that this case
8920                  * will be unreachable and can be removed.  See
8921                  * [perl #117327] */
8922                 while (*RExC_parse && *RExC_parse != ')')
8923                     RExC_parse++;
8924                 if (*RExC_parse != ')')
8925                     FAIL("Sequence (?#... not terminated");
8926                 nextchar(pRExC_state);
8927                 *flagp = TRYAGAIN;
8928                 return NULL;
8929             case '0' :           /* (?0) */
8930             case 'R' :           /* (?R) */
8931                 if (*RExC_parse != ')')
8932                     FAIL("Sequence (?R) not terminated");
8933                 ret = reg_node(pRExC_state, GOSTART);
8934                 *flagp |= POSTPONED;
8935                 nextchar(pRExC_state);
8936                 return ret;
8937                 /*notreached*/
8938             { /* named and numeric backreferences */
8939                 I32 num;
8940             case '&':            /* (?&NAME) */
8941                 parse_start = RExC_parse - 1;
8942               named_recursion:
8943                 {
8944                     SV *sv_dat = reg_scan_name(pRExC_state,
8945                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
8946                      num = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
8947                 }
8948                 goto gen_recurse_regop;
8949                 assert(0); /* NOT REACHED */
8950             case '+':
8951                 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
8952                     RExC_parse++;
8953                     vFAIL("Illegal pattern");
8954                 }
8955                 goto parse_recursion;
8956                 /* NOT REACHED*/
8957             case '-': /* (?-1) */
8958                 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
8959                     RExC_parse--; /* rewind to let it be handled later */
8960                     goto parse_flags;
8961                 } 
8962                 /*FALLTHROUGH */
8963             case '1': case '2': case '3': case '4': /* (?1) */
8964             case '5': case '6': case '7': case '8': case '9':
8965                 RExC_parse--;
8966               parse_recursion:
8967                 num = atoi(RExC_parse);
8968                 parse_start = RExC_parse - 1; /* MJD */
8969                 if (*RExC_parse == '-')
8970                     RExC_parse++;
8971                 while (isDIGIT(*RExC_parse))
8972                         RExC_parse++;
8973                 if (*RExC_parse!=')') 
8974                     vFAIL("Expecting close bracket");
8975
8976               gen_recurse_regop:
8977                 if ( paren == '-' ) {
8978                     /*
8979                     Diagram of capture buffer numbering.
8980                     Top line is the normal capture buffer numbers
8981                     Bottom line is the negative indexing as from
8982                     the X (the (?-2))
8983
8984                     +   1 2    3 4 5 X          6 7
8985                        /(a(x)y)(a(b(c(?-2)d)e)f)(g(h))/
8986                     -   5 4    3 2 1 X          x x
8987
8988                     */
8989                     num = RExC_npar + num;
8990                     if (num < 1)  {
8991                         RExC_parse++;
8992                         vFAIL("Reference to nonexistent group");
8993                     }
8994                 } else if ( paren == '+' ) {
8995                     num = RExC_npar + num - 1;
8996                 }
8997
8998                 ret = reganode(pRExC_state, GOSUB, num);
8999                 if (!SIZE_ONLY) {
9000                     if (num > (I32)RExC_rx->nparens) {
9001                         RExC_parse++;
9002                         vFAIL("Reference to nonexistent group");
9003                     }
9004                     ARG2L_SET( ret, RExC_recurse_count++);
9005                     RExC_emit++;
9006                     DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
9007                         "Recurse #%"UVuf" to %"IVdf"\n", (UV)ARG(ret), (IV)ARG2L(ret)));
9008                 } else {
9009                     RExC_size++;
9010                 }
9011                 RExC_seen |= REG_SEEN_RECURSE;
9012                 Set_Node_Length(ret, 1 + regarglen[OP(ret)]); /* MJD */
9013                 Set_Node_Offset(ret, parse_start); /* MJD */
9014
9015                 *flagp |= POSTPONED;
9016                 nextchar(pRExC_state);
9017                 return ret;
9018             } /* named and numeric backreferences */
9019             assert(0); /* NOT REACHED */
9020
9021             case '?':           /* (??...) */
9022                 is_logical = 1;
9023                 if (*RExC_parse != '{') {
9024                     RExC_parse++;
9025                     vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
9026                     /*NOTREACHED*/
9027                 }
9028                 *flagp |= POSTPONED;
9029                 paren = *RExC_parse++;
9030                 /* FALL THROUGH */
9031             case '{':           /* (?{...}) */
9032             {
9033                 U32 n = 0;
9034                 struct reg_code_block *cb;
9035
9036                 RExC_seen_zerolen++;
9037
9038                 if (   !pRExC_state->num_code_blocks
9039                     || pRExC_state->code_index >= pRExC_state->num_code_blocks
9040                     || pRExC_state->code_blocks[pRExC_state->code_index].start
9041                         != (STRLEN)((RExC_parse -3 - (is_logical ? 1 : 0))
9042                             - RExC_start)
9043                 ) {
9044                     if (RExC_pm_flags & PMf_USE_RE_EVAL)
9045                         FAIL("panic: Sequence (?{...}): no code block found\n");
9046                     FAIL("Eval-group not allowed at runtime, use re 'eval'");
9047                 }
9048                 /* this is a pre-compiled code block (?{...}) */
9049                 cb = &pRExC_state->code_blocks[pRExC_state->code_index];
9050                 RExC_parse = RExC_start + cb->end;
9051                 if (!SIZE_ONLY) {
9052                     OP *o = cb->block;
9053                     if (cb->src_regex) {
9054                         n = add_data(pRExC_state, 2, "rl");
9055                         RExC_rxi->data->data[n] =
9056                             (void*)SvREFCNT_inc((SV*)cb->src_regex);
9057                         RExC_rxi->data->data[n+1] = (void*)o;
9058                     }
9059                     else {
9060                         n = add_data(pRExC_state, 1,
9061                                (RExC_pm_flags & PMf_HAS_CV) ? "L" : "l");
9062                         RExC_rxi->data->data[n] = (void*)o;
9063                     }
9064                 }
9065                 pRExC_state->code_index++;
9066                 nextchar(pRExC_state);
9067
9068                 if (is_logical) {
9069                     regnode *eval;
9070                     ret = reg_node(pRExC_state, LOGICAL);
9071                     eval = reganode(pRExC_state, EVAL, n);
9072                     if (!SIZE_ONLY) {
9073                         ret->flags = 2;
9074                         /* for later propagation into (??{}) return value */
9075                         eval->flags = (U8) (RExC_flags & RXf_PMf_COMPILETIME);
9076                     }
9077                     REGTAIL(pRExC_state, ret, eval);
9078                     /* deal with the length of this later - MJD */
9079                     return ret;
9080                 }
9081                 ret = reganode(pRExC_state, EVAL, n);
9082                 Set_Node_Length(ret, RExC_parse - parse_start + 1);
9083                 Set_Node_Offset(ret, parse_start);
9084                 return ret;
9085             }
9086             case '(':           /* (?(?{...})...) and (?(?=...)...) */
9087             {
9088                 int is_define= 0;
9089                 if (RExC_parse[0] == '?') {        /* (?(?...)) */
9090                     if (RExC_parse[1] == '=' || RExC_parse[1] == '!'
9091                         || RExC_parse[1] == '<'
9092                         || RExC_parse[1] == '{') { /* Lookahead or eval. */
9093                         I32 flag;
9094                         regnode *tail;
9095
9096                         ret = reg_node(pRExC_state, LOGICAL);
9097                         if (!SIZE_ONLY)
9098                             ret->flags = 1;
9099                         
9100                         tail = reg(pRExC_state, 1, &flag, depth+1);
9101                         if (flag & RESTART_UTF8) {
9102                             *flagp = RESTART_UTF8;
9103                             return NULL;
9104                         }
9105                         REGTAIL(pRExC_state, ret, tail);
9106                         goto insert_if;
9107                     }
9108                 }
9109                 else if ( RExC_parse[0] == '<'     /* (?(<NAME>)...) */
9110                          || RExC_parse[0] == '\'' ) /* (?('NAME')...) */
9111                 {
9112                     char ch = RExC_parse[0] == '<' ? '>' : '\'';
9113                     char *name_start= RExC_parse++;
9114                     U32 num = 0;
9115                     SV *sv_dat=reg_scan_name(pRExC_state,
9116                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
9117                     if (RExC_parse == name_start || *RExC_parse != ch)
9118                         vFAIL2("Sequence (?(%c... not terminated",
9119                             (ch == '>' ? '<' : ch));
9120                     RExC_parse++;
9121                     if (!SIZE_ONLY) {
9122                         num = add_data( pRExC_state, 1, "S" );
9123                         RExC_rxi->data->data[num]=(void*)sv_dat;
9124                         SvREFCNT_inc_simple_void(sv_dat);
9125                     }
9126                     ret = reganode(pRExC_state,NGROUPP,num);
9127                     goto insert_if_check_paren;
9128                 }
9129                 else if (RExC_parse[0] == 'D' &&
9130                          RExC_parse[1] == 'E' &&
9131                          RExC_parse[2] == 'F' &&
9132                          RExC_parse[3] == 'I' &&
9133                          RExC_parse[4] == 'N' &&
9134                          RExC_parse[5] == 'E')
9135                 {
9136                     ret = reganode(pRExC_state,DEFINEP,0);
9137                     RExC_parse +=6 ;
9138                     is_define = 1;
9139                     goto insert_if_check_paren;
9140                 }
9141                 else if (RExC_parse[0] == 'R') {
9142                     RExC_parse++;
9143                     parno = 0;
9144                     if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
9145                         parno = atoi(RExC_parse++);
9146                         while (isDIGIT(*RExC_parse))
9147                             RExC_parse++;
9148                     } else if (RExC_parse[0] == '&') {
9149                         SV *sv_dat;
9150                         RExC_parse++;
9151                         sv_dat = reg_scan_name(pRExC_state,
9152                             SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
9153                         parno = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
9154                     }
9155                     ret = reganode(pRExC_state,INSUBP,parno); 
9156                     goto insert_if_check_paren;
9157                 }
9158                 else if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
9159                     /* (?(1)...) */
9160                     char c;
9161                     parno = atoi(RExC_parse++);
9162
9163                     while (isDIGIT(*RExC_parse))
9164                         RExC_parse++;
9165                     ret = reganode(pRExC_state, GROUPP, parno);
9166
9167                  insert_if_check_paren:
9168                     if ((c = *nextchar(pRExC_state)) != ')')
9169                         vFAIL("Switch condition not recognized");
9170                   insert_if:
9171                     REGTAIL(pRExC_state, ret, reganode(pRExC_state, IFTHEN, 0));
9172                     br = regbranch(pRExC_state, &flags, 1,depth+1);
9173                     if (br == NULL) {
9174                         if (flags & RESTART_UTF8) {
9175                             *flagp = RESTART_UTF8;
9176                             return NULL;
9177                         }
9178                         FAIL2("panic: regbranch returned NULL, flags=%#X",
9179                               flags);
9180                     } else
9181                         REGTAIL(pRExC_state, br, reganode(pRExC_state, LONGJMP, 0));
9182                     c = *nextchar(pRExC_state);
9183                     if (flags&HASWIDTH)
9184                         *flagp |= HASWIDTH;
9185                     if (c == '|') {
9186                         if (is_define) 
9187                             vFAIL("(?(DEFINE)....) does not allow branches");
9188                         lastbr = reganode(pRExC_state, IFTHEN, 0); /* Fake one for optimizer. */
9189                         if (!regbranch(pRExC_state, &flags, 1,depth+1)) {
9190                             if (flags & RESTART_UTF8) {
9191                                 *flagp = RESTART_UTF8;
9192                                 return NULL;
9193                             }
9194                             FAIL2("panic: regbranch returned NULL, flags=%#X",
9195                                   flags);
9196                         }
9197                         REGTAIL(pRExC_state, ret, lastbr);
9198                         if (flags&HASWIDTH)
9199                             *flagp |= HASWIDTH;
9200                         c = *nextchar(pRExC_state);
9201                     }
9202                     else
9203                         lastbr = NULL;
9204                     if (c != ')')
9205                         vFAIL("Switch (?(condition)... contains too many branches");
9206                     ender = reg_node(pRExC_state, TAIL);
9207                     REGTAIL(pRExC_state, br, ender);
9208                     if (lastbr) {
9209                         REGTAIL(pRExC_state, lastbr, ender);
9210                         REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender);
9211                     }
9212                     else
9213                         REGTAIL(pRExC_state, ret, ender);
9214                     RExC_size++; /* XXX WHY do we need this?!!
9215                                     For large programs it seems to be required
9216                                     but I can't figure out why. -- dmq*/
9217                     return ret;
9218                 }
9219                 else {
9220                     vFAIL2("Unknown switch condition (?(%.2s", RExC_parse);
9221                 }
9222             }
9223             case '[':           /* (?[ ... ]) */
9224                 return handle_regex_sets(pRExC_state, NULL, flagp, depth,
9225                                          oregcomp_parse);
9226             case 0:
9227                 RExC_parse--; /* for vFAIL to print correctly */
9228                 vFAIL("Sequence (? incomplete");
9229                 break;
9230             default: /* e.g., (?i) */
9231                 --RExC_parse;
9232               parse_flags:
9233                 parse_lparen_question_flags(pRExC_state);
9234                 if (UCHARAT(RExC_parse) != ':') {
9235                     nextchar(pRExC_state);
9236                     *flagp = TRYAGAIN;
9237                     return NULL;
9238                 }
9239                 paren = ':';
9240                 nextchar(pRExC_state);
9241                 ret = NULL;
9242                 goto parse_rest;
9243             } /* end switch */
9244         }
9245         else {                  /* (...) */
9246           capturing_parens:
9247             parno = RExC_npar;
9248             RExC_npar++;
9249             
9250             ret = reganode(pRExC_state, OPEN, parno);
9251             if (!SIZE_ONLY ){
9252                 if (!RExC_nestroot) 
9253                     RExC_nestroot = parno;
9254                 if (RExC_seen & REG_SEEN_RECURSE
9255                     && !RExC_open_parens[parno-1])
9256                 {
9257                     DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
9258                         "Setting open paren #%"IVdf" to %d\n", 
9259                         (IV)parno, REG_NODE_NUM(ret)));
9260                     RExC_open_parens[parno-1]= ret;
9261                 }
9262             }
9263             Set_Node_Length(ret, 1); /* MJD */
9264             Set_Node_Offset(ret, RExC_parse); /* MJD */
9265             is_open = 1;
9266         }
9267     }
9268     else                        /* ! paren */
9269         ret = NULL;
9270    
9271    parse_rest:
9272     /* Pick up the branches, linking them together. */
9273     parse_start = RExC_parse;   /* MJD */
9274     br = regbranch(pRExC_state, &flags, 1,depth+1);
9275
9276     /*     branch_len = (paren != 0); */
9277
9278     if (br == NULL) {
9279         if (flags & RESTART_UTF8) {
9280             *flagp = RESTART_UTF8;
9281             return NULL;
9282         }
9283         FAIL2("panic: regbranch returned NULL, flags=%#X", flags);
9284     }
9285     if (*RExC_parse == '|') {
9286         if (!SIZE_ONLY && RExC_extralen) {
9287             reginsert(pRExC_state, BRANCHJ, br, depth+1);
9288         }
9289         else {                  /* MJD */
9290             reginsert(pRExC_state, BRANCH, br, depth+1);
9291             Set_Node_Length(br, paren != 0);
9292             Set_Node_Offset_To_R(br-RExC_emit_start, parse_start-RExC_start);
9293         }
9294         have_branch = 1;
9295         if (SIZE_ONLY)
9296             RExC_extralen += 1;         /* For BRANCHJ-BRANCH. */
9297     }
9298     else if (paren == ':') {
9299         *flagp |= flags&SIMPLE;
9300     }
9301     if (is_open) {                              /* Starts with OPEN. */
9302         REGTAIL(pRExC_state, ret, br);          /* OPEN -> first. */
9303     }
9304     else if (paren != '?')              /* Not Conditional */
9305         ret = br;
9306     *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
9307     lastbr = br;
9308     while (*RExC_parse == '|') {
9309         if (!SIZE_ONLY && RExC_extralen) {
9310             ender = reganode(pRExC_state, LONGJMP,0);
9311             REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender); /* Append to the previous. */
9312         }
9313         if (SIZE_ONLY)
9314             RExC_extralen += 2;         /* Account for LONGJMP. */
9315         nextchar(pRExC_state);
9316         if (freeze_paren) {
9317             if (RExC_npar > after_freeze)
9318                 after_freeze = RExC_npar;
9319             RExC_npar = freeze_paren;       
9320         }
9321         br = regbranch(pRExC_state, &flags, 0, depth+1);
9322
9323         if (br == NULL) {
9324             if (flags & RESTART_UTF8) {
9325                 *flagp = RESTART_UTF8;
9326                 return NULL;
9327             }
9328             FAIL2("panic: regbranch returned NULL, flags=%#X", flags);
9329         }
9330         REGTAIL(pRExC_state, lastbr, br);               /* BRANCH -> BRANCH. */
9331         lastbr = br;
9332         *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
9333     }
9334
9335     if (have_branch || paren != ':') {
9336         /* Make a closing node, and hook it on the end. */
9337         switch (paren) {
9338         case ':':
9339             ender = reg_node(pRExC_state, TAIL);
9340             break;
9341         case 1: case 2:
9342             ender = reganode(pRExC_state, CLOSE, parno);
9343             if (!SIZE_ONLY && RExC_seen & REG_SEEN_RECURSE) {
9344                 DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
9345                         "Setting close paren #%"IVdf" to %d\n", 
9346                         (IV)parno, REG_NODE_NUM(ender)));
9347                 RExC_close_parens[parno-1]= ender;
9348                 if (RExC_nestroot == parno) 
9349                     RExC_nestroot = 0;
9350             }       
9351             Set_Node_Offset(ender,RExC_parse+1); /* MJD */
9352             Set_Node_Length(ender,1); /* MJD */
9353             break;
9354         case '<':
9355         case ',':
9356         case '=':
9357         case '!':
9358             *flagp &= ~HASWIDTH;
9359             /* FALL THROUGH */
9360         case '>':
9361             ender = reg_node(pRExC_state, SUCCEED);
9362             break;
9363         case 0:
9364             ender = reg_node(pRExC_state, END);
9365             if (!SIZE_ONLY) {
9366                 assert(!RExC_opend); /* there can only be one! */
9367                 RExC_opend = ender;
9368             }
9369             break;
9370         }
9371         DEBUG_PARSE_r(if (!SIZE_ONLY) {
9372             SV * const mysv_val1=sv_newmortal();
9373             SV * const mysv_val2=sv_newmortal();
9374             DEBUG_PARSE_MSG("lsbr");
9375             regprop(RExC_rx, mysv_val1, lastbr);
9376             regprop(RExC_rx, mysv_val2, ender);
9377             PerlIO_printf(Perl_debug_log, "~ tying lastbr %s (%"IVdf") to ender %s (%"IVdf") offset %"IVdf"\n",
9378                           SvPV_nolen_const(mysv_val1),
9379                           (IV)REG_NODE_NUM(lastbr),
9380                           SvPV_nolen_const(mysv_val2),
9381                           (IV)REG_NODE_NUM(ender),
9382                           (IV)(ender - lastbr)
9383             );
9384         });
9385         REGTAIL(pRExC_state, lastbr, ender);
9386
9387         if (have_branch && !SIZE_ONLY) {
9388             char is_nothing= 1;
9389             if (depth==1)
9390                 RExC_seen |= REG_TOP_LEVEL_BRANCHES;
9391
9392             /* Hook the tails of the branches to the closing node. */
9393             for (br = ret; br; br = regnext(br)) {
9394                 const U8 op = PL_regkind[OP(br)];
9395                 if (op == BRANCH) {
9396                     REGTAIL_STUDY(pRExC_state, NEXTOPER(br), ender);
9397                     if (OP(NEXTOPER(br)) != NOTHING || regnext(NEXTOPER(br)) != ender)
9398                         is_nothing= 0;
9399                 }
9400                 else if (op == BRANCHJ) {
9401                     REGTAIL_STUDY(pRExC_state, NEXTOPER(NEXTOPER(br)), ender);
9402                     /* for now we always disable this optimisation * /
9403                     if (OP(NEXTOPER(NEXTOPER(br))) != NOTHING || regnext(NEXTOPER(NEXTOPER(br))) != ender)
9404                     */
9405                         is_nothing= 0;
9406                 }
9407             }
9408             if (is_nothing) {
9409                 br= PL_regkind[OP(ret)] != BRANCH ? regnext(ret) : ret;
9410                 DEBUG_PARSE_r(if (!SIZE_ONLY) {
9411                     SV * const mysv_val1=sv_newmortal();
9412                     SV * const mysv_val2=sv_newmortal();
9413                     DEBUG_PARSE_MSG("NADA");
9414                     regprop(RExC_rx, mysv_val1, ret);
9415                     regprop(RExC_rx, mysv_val2, ender);
9416                     PerlIO_printf(Perl_debug_log, "~ converting ret %s (%"IVdf") to ender %s (%"IVdf") offset %"IVdf"\n",
9417                                   SvPV_nolen_const(mysv_val1),
9418                                   (IV)REG_NODE_NUM(ret),
9419                                   SvPV_nolen_const(mysv_val2),
9420                                   (IV)REG_NODE_NUM(ender),
9421                                   (IV)(ender - ret)
9422                     );
9423                 });
9424                 OP(br)= NOTHING;
9425                 if (OP(ender) == TAIL) {
9426                     NEXT_OFF(br)= 0;
9427                     RExC_emit= br + 1;
9428                 } else {
9429                     regnode *opt;
9430                     for ( opt= br + 1; opt < ender ; opt++ )
9431                         OP(opt)= OPTIMIZED;
9432                     NEXT_OFF(br)= ender - br;
9433                 }
9434             }
9435         }
9436     }
9437
9438     {
9439         const char *p;
9440         static const char parens[] = "=!<,>";
9441
9442         if (paren && (p = strchr(parens, paren))) {
9443             U8 node = ((p - parens) % 2) ? UNLESSM : IFMATCH;
9444             int flag = (p - parens) > 1;
9445
9446             if (paren == '>')
9447                 node = SUSPEND, flag = 0;
9448             reginsert(pRExC_state, node,ret, depth+1);
9449             Set_Node_Cur_Length(ret);
9450             Set_Node_Offset(ret, parse_start + 1);
9451             ret->flags = flag;
9452             REGTAIL_STUDY(pRExC_state, ret, reg_node(pRExC_state, TAIL));
9453         }
9454     }
9455
9456     /* Check for proper termination. */
9457     if (paren) {
9458         /* restore original flags, but keep (?p) */
9459         RExC_flags = oregflags | (RExC_flags & RXf_PMf_KEEPCOPY);
9460         if (RExC_parse >= RExC_end || *nextchar(pRExC_state) != ')') {
9461             RExC_parse = oregcomp_parse;
9462             vFAIL("Unmatched (");
9463         }
9464     }
9465     else if (!paren && RExC_parse < RExC_end) {
9466         if (*RExC_parse == ')') {
9467             RExC_parse++;
9468             vFAIL("Unmatched )");
9469         }
9470         else
9471             FAIL("Junk on end of regexp");      /* "Can't happen". */
9472         assert(0); /* NOTREACHED */
9473     }
9474
9475     if (RExC_in_lookbehind) {
9476         RExC_in_lookbehind--;
9477     }
9478     if (after_freeze > RExC_npar)
9479         RExC_npar = after_freeze;
9480     return(ret);
9481 }
9482
9483 /*
9484  - regbranch - one alternative of an | operator
9485  *
9486  * Implements the concatenation operator.
9487  *
9488  * Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan needs to be
9489  * restarted.
9490  */
9491 STATIC regnode *
9492 S_regbranch(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, I32 first, U32 depth)
9493 {
9494     dVAR;
9495     regnode *ret;
9496     regnode *chain = NULL;
9497     regnode *latest;
9498     I32 flags = 0, c = 0;
9499     GET_RE_DEBUG_FLAGS_DECL;
9500
9501     PERL_ARGS_ASSERT_REGBRANCH;
9502
9503     DEBUG_PARSE("brnc");
9504
9505     if (first)
9506         ret = NULL;
9507     else {
9508         if (!SIZE_ONLY && RExC_extralen)
9509             ret = reganode(pRExC_state, BRANCHJ,0);
9510         else {
9511             ret = reg_node(pRExC_state, BRANCH);
9512             Set_Node_Length(ret, 1);
9513         }
9514     }
9515
9516     if (!first && SIZE_ONLY)
9517         RExC_extralen += 1;                     /* BRANCHJ */
9518
9519     *flagp = WORST;                     /* Tentatively. */
9520
9521     RExC_parse--;
9522     nextchar(pRExC_state);
9523     while (RExC_parse < RExC_end && *RExC_parse != '|' && *RExC_parse != ')') {
9524         flags &= ~TRYAGAIN;
9525         latest = regpiece(pRExC_state, &flags,depth+1);
9526         if (latest == NULL) {
9527             if (flags & TRYAGAIN)
9528                 continue;
9529             if (flags & RESTART_UTF8) {
9530                 *flagp = RESTART_UTF8;
9531                 return NULL;
9532             }
9533             FAIL2("panic: regpiece returned NULL, flags=%#X", flags);
9534         }
9535         else if (ret == NULL)
9536             ret = latest;
9537         *flagp |= flags&(HASWIDTH|POSTPONED);
9538         if (chain == NULL)      /* First piece. */
9539             *flagp |= flags&SPSTART;
9540         else {
9541             RExC_naughty++;
9542             REGTAIL(pRExC_state, chain, latest);
9543         }
9544         chain = latest;
9545         c++;
9546     }
9547     if (chain == NULL) {        /* Loop ran zero times. */
9548         chain = reg_node(pRExC_state, NOTHING);
9549         if (ret == NULL)
9550             ret = chain;
9551     }
9552     if (c == 1) {
9553         *flagp |= flags&SIMPLE;
9554     }
9555
9556     return ret;
9557 }
9558
9559 /*
9560  - regpiece - something followed by possible [*+?]
9561  *
9562  * Note that the branching code sequences used for ? and the general cases
9563  * of * and + are somewhat optimized:  they use the same NOTHING node as
9564  * both the endmarker for their branch list and the body of the last branch.
9565  * It might seem that this node could be dispensed with entirely, but the
9566  * endmarker role is not redundant.
9567  *
9568  * Returns NULL, setting *flagp to TRYAGAIN if regatom() returns NULL with
9569  * TRYAGAIN.
9570  * Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan needs to be
9571  * restarted.
9572  */
9573 STATIC regnode *
9574 S_regpiece(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
9575 {
9576     dVAR;
9577     regnode *ret;
9578     char op;
9579     char *next;
9580     I32 flags;
9581     const char * const origparse = RExC_parse;
9582     I32 min;
9583     I32 max = REG_INFTY;
9584 #ifdef RE_TRACK_PATTERN_OFFSETS
9585     char *parse_start;
9586 #endif
9587     const char *maxpos = NULL;
9588
9589     /* Save the original in case we change the emitted regop to a FAIL. */
9590     regnode * const orig_emit = RExC_emit;
9591
9592     GET_RE_DEBUG_FLAGS_DECL;
9593
9594     PERL_ARGS_ASSERT_REGPIECE;
9595
9596     DEBUG_PARSE("piec");
9597
9598     ret = regatom(pRExC_state, &flags,depth+1);
9599     if (ret == NULL) {
9600         if (flags & (TRYAGAIN|RESTART_UTF8))
9601             *flagp |= flags & (TRYAGAIN|RESTART_UTF8);
9602         else
9603             FAIL2("panic: regatom returned NULL, flags=%#X", flags);
9604         return(NULL);
9605     }
9606
9607     op = *RExC_parse;
9608
9609     if (op == '{' && regcurly(RExC_parse, FALSE)) {
9610         maxpos = NULL;
9611 #ifdef RE_TRACK_PATTERN_OFFSETS
9612         parse_start = RExC_parse; /* MJD */
9613 #endif
9614         next = RExC_parse + 1;
9615         while (isDIGIT(*next) || *next == ',') {
9616             if (*next == ',') {
9617                 if (maxpos)
9618                     break;
9619                 else
9620                     maxpos = next;
9621             }
9622             next++;
9623         }
9624         if (*next == '}') {             /* got one */
9625             if (!maxpos)
9626                 maxpos = next;
9627             RExC_parse++;
9628             min = atoi(RExC_parse);
9629             if (*maxpos == ',')
9630                 maxpos++;
9631             else
9632                 maxpos = RExC_parse;
9633             max = atoi(maxpos);
9634             if (!max && *maxpos != '0')
9635                 max = REG_INFTY;                /* meaning "infinity" */
9636             else if (max >= REG_INFTY)
9637                 vFAIL2("Quantifier in {,} bigger than %d", REG_INFTY - 1);
9638             RExC_parse = next;
9639             nextchar(pRExC_state);
9640             if (max < min) {    /* If can't match, warn and optimize to fail
9641                                    unconditionally */
9642                 if (SIZE_ONLY) {
9643                     ckWARNreg(RExC_parse, "Quantifier {n,m} with n > m can't match");
9644
9645                     /* We can't back off the size because we have to reserve
9646                      * enough space for all the things we are about to throw
9647                      * away, but we can shrink it by the ammount we are about
9648                      * to re-use here */
9649                     RExC_size = PREVOPER(RExC_size) - regarglen[(U8)OPFAIL];
9650                 }
9651                 else {
9652                     RExC_emit = orig_emit;
9653                 }
9654                 ret = reg_node(pRExC_state, OPFAIL);
9655                 return ret;
9656             }
9657
9658         do_curly:
9659             if ((flags&SIMPLE)) {
9660                 RExC_naughty += 2 + RExC_naughty / 2;
9661                 reginsert(pRExC_state, CURLY, ret, depth+1);
9662                 Set_Node_Offset(ret, parse_start+1); /* MJD */
9663                 Set_Node_Cur_Length(ret);
9664             }
9665             else {
9666                 regnode * const w = reg_node(pRExC_state, WHILEM);
9667
9668                 w->flags = 0;
9669                 REGTAIL(pRExC_state, ret, w);
9670                 if (!SIZE_ONLY && RExC_extralen) {
9671                     reginsert(pRExC_state, LONGJMP,ret, depth+1);
9672                     reginsert(pRExC_state, NOTHING,ret, depth+1);
9673                     NEXT_OFF(ret) = 3;  /* Go over LONGJMP. */
9674                 }
9675                 reginsert(pRExC_state, CURLYX,ret, depth+1);
9676                                 /* MJD hk */
9677                 Set_Node_Offset(ret, parse_start+1);
9678                 Set_Node_Length(ret,
9679                                 op == '{' ? (RExC_parse - parse_start) : 1);
9680
9681                 if (!SIZE_ONLY && RExC_extralen)
9682                     NEXT_OFF(ret) = 3;  /* Go over NOTHING to LONGJMP. */
9683                 REGTAIL(pRExC_state, ret, reg_node(pRExC_state, NOTHING));
9684                 if (SIZE_ONLY)
9685                     RExC_whilem_seen++, RExC_extralen += 3;
9686                 RExC_naughty += 4 + RExC_naughty;       /* compound interest */
9687             }
9688             ret->flags = 0;
9689
9690             if (min > 0)
9691                 *flagp = WORST;
9692             if (max > 0)
9693                 *flagp |= HASWIDTH;
9694             if (!SIZE_ONLY) {
9695                 ARG1_SET(ret, (U16)min);
9696                 ARG2_SET(ret, (U16)max);
9697             }
9698
9699             goto nest_check;
9700         }
9701     }
9702
9703     if (!ISMULT1(op)) {
9704         *flagp = flags;
9705         return(ret);
9706     }
9707
9708 #if 0                           /* Now runtime fix should be reliable. */
9709
9710     /* if this is reinstated, don't forget to put this back into perldiag:
9711
9712             =item Regexp *+ operand could be empty at {#} in regex m/%s/
9713
9714            (F) The part of the regexp subject to either the * or + quantifier
9715            could match an empty string. The {#} shows in the regular
9716            expression about where the problem was discovered.
9717
9718     */
9719
9720     if (!(flags&HASWIDTH) && op != '?')
9721       vFAIL("Regexp *+ operand could be empty");
9722 #endif
9723
9724 #ifdef RE_TRACK_PATTERN_OFFSETS
9725     parse_start = RExC_parse;
9726 #endif
9727     nextchar(pRExC_state);
9728
9729     *flagp = (op != '+') ? (WORST|SPSTART|HASWIDTH) : (WORST|HASWIDTH);
9730
9731     if (op == '*' && (flags&SIMPLE)) {
9732         reginsert(pRExC_state, STAR, ret, depth+1);
9733         ret->flags = 0;
9734         RExC_naughty += 4;
9735     }
9736     else if (op == '*') {
9737         min = 0;
9738         goto do_curly;
9739     }
9740     else if (op == '+' && (flags&SIMPLE)) {
9741         reginsert(pRExC_state, PLUS, ret, depth+1);
9742         ret->flags = 0;
9743         RExC_naughty += 3;
9744     }
9745     else if (op == '+') {
9746         min = 1;
9747         goto do_curly;
9748     }
9749     else if (op == '?') {
9750         min = 0; max = 1;
9751         goto do_curly;
9752     }
9753   nest_check:
9754     if (!SIZE_ONLY && !(flags&(HASWIDTH|POSTPONED)) && max > REG_INFTY/3) {
9755         SAVEFREESV(RExC_rx_sv); /* in case of fatal warnings */
9756         ckWARN3reg(RExC_parse,
9757                    "%.*s matches null string many times",
9758                    (int)(RExC_parse >= origparse ? RExC_parse - origparse : 0),
9759                    origparse);
9760         (void)ReREFCNT_inc(RExC_rx_sv);
9761     }
9762
9763     if (RExC_parse < RExC_end && *RExC_parse == '?') {
9764         nextchar(pRExC_state);
9765         reginsert(pRExC_state, MINMOD, ret, depth+1);
9766         REGTAIL(pRExC_state, ret, ret + NODE_STEP_REGNODE);
9767     }
9768 #ifndef REG_ALLOW_MINMOD_SUSPEND
9769     else
9770 #endif
9771     if (RExC_parse < RExC_end && *RExC_parse == '+') {
9772         regnode *ender;
9773         nextchar(pRExC_state);
9774         ender = reg_node(pRExC_state, SUCCEED);
9775         REGTAIL(pRExC_state, ret, ender);
9776         reginsert(pRExC_state, SUSPEND, ret, depth+1);
9777         ret->flags = 0;
9778         ender = reg_node(pRExC_state, TAIL);
9779         REGTAIL(pRExC_state, ret, ender);
9780         /*ret= ender;*/
9781     }
9782
9783     if (RExC_parse < RExC_end && ISMULT2(RExC_parse)) {
9784         RExC_parse++;
9785         vFAIL("Nested quantifiers");
9786     }
9787
9788     return(ret);
9789 }
9790
9791 STATIC bool
9792 S_grok_bslash_N(pTHX_ RExC_state_t *pRExC_state, regnode** node_p, UV *valuep, I32 *flagp, U32 depth, bool in_char_class,
9793         const bool strict   /* Apply stricter parsing rules? */
9794     )
9795 {
9796    
9797  /* This is expected to be called by a parser routine that has recognized '\N'
9798    and needs to handle the rest. RExC_parse is expected to point at the first
9799    char following the N at the time of the call.  On successful return,
9800    RExC_parse has been updated to point to just after the sequence identified
9801    by this routine, and <*flagp> has been updated.
9802
9803    The \N may be inside (indicated by the boolean <in_char_class>) or outside a
9804    character class.
9805
9806    \N may begin either a named sequence, or if outside a character class, mean
9807    to match a non-newline.  For non single-quoted regexes, the tokenizer has
9808    attempted to decide which, and in the case of a named sequence, converted it
9809    into one of the forms: \N{} (if the sequence is null), or \N{U+c1.c2...},
9810    where c1... are the characters in the sequence.  For single-quoted regexes,
9811    the tokenizer passes the \N sequence through unchanged; this code will not
9812    attempt to determine this nor expand those, instead raising a syntax error.
9813    The net effect is that if the beginning of the passed-in pattern isn't '{U+'
9814    or there is no '}', it signals that this \N occurrence means to match a
9815    non-newline.
9816
9817    Only the \N{U+...} form should occur in a character class, for the same
9818    reason that '.' inside a character class means to just match a period: it
9819    just doesn't make sense.
9820
9821    The function raises an error (via vFAIL), and doesn't return for various
9822    syntax errors.  Otherwise it returns TRUE and sets <node_p> or <valuep> on
9823    success; it returns FALSE otherwise. Returns FALSE, setting *flagp to
9824    RESTART_UTF8 if the sizing scan needs to be restarted. Such a restart is
9825    only possible if node_p is non-NULL.
9826
9827
9828    If <valuep> is non-null, it means the caller can accept an input sequence
9829    consisting of a just a single code point; <*valuep> is set to that value
9830    if the input is such.
9831
9832    If <node_p> is non-null it signifies that the caller can accept any other
9833    legal sequence (i.e., one that isn't just a single code point).  <*node_p>
9834    is set as follows:
9835     1) \N means not-a-NL: points to a newly created REG_ANY node;
9836     2) \N{}:              points to a new NOTHING node;
9837     3) otherwise:         points to a new EXACT node containing the resolved
9838                           string.
9839    Note that FALSE is returned for single code point sequences if <valuep> is
9840    null.
9841  */
9842
9843     char * endbrace;    /* '}' following the name */
9844     char* p;
9845     char *endchar;      /* Points to '.' or '}' ending cur char in the input
9846                            stream */
9847     bool has_multiple_chars; /* true if the input stream contains a sequence of
9848                                 more than one character */
9849
9850     GET_RE_DEBUG_FLAGS_DECL;
9851  
9852     PERL_ARGS_ASSERT_GROK_BSLASH_N;
9853
9854     GET_RE_DEBUG_FLAGS;
9855
9856     assert(cBOOL(node_p) ^ cBOOL(valuep));  /* Exactly one should be set */
9857
9858     /* The [^\n] meaning of \N ignores spaces and comments under the /x
9859      * modifier.  The other meaning does not */
9860     p = (RExC_flags & RXf_PMf_EXTENDED)
9861         ? regwhite( pRExC_state, RExC_parse )
9862         : RExC_parse;
9863
9864     /* Disambiguate between \N meaning a named character versus \N meaning
9865      * [^\n].  The former is assumed when it can't be the latter. */
9866     if (*p != '{' || regcurly(p, FALSE)) {
9867         RExC_parse = p;
9868         if (! node_p) {
9869             /* no bare \N in a charclass */
9870             if (in_char_class) {
9871                 vFAIL("\\N in a character class must be a named character: \\N{...}");
9872             }
9873             return FALSE;
9874         }
9875         nextchar(pRExC_state);
9876         *node_p = reg_node(pRExC_state, REG_ANY);
9877         *flagp |= HASWIDTH|SIMPLE;
9878         RExC_naughty++;
9879         RExC_parse--;
9880         Set_Node_Length(*node_p, 1); /* MJD */
9881         return TRUE;
9882     }
9883
9884     /* Here, we have decided it should be a named character or sequence */
9885
9886     /* The test above made sure that the next real character is a '{', but
9887      * under the /x modifier, it could be separated by space (or a comment and
9888      * \n) and this is not allowed (for consistency with \x{...} and the
9889      * tokenizer handling of \N{NAME}). */
9890     if (*RExC_parse != '{') {
9891         vFAIL("Missing braces on \\N{}");
9892     }
9893
9894     RExC_parse++;       /* Skip past the '{' */
9895
9896     if (! (endbrace = strchr(RExC_parse, '}')) /* no trailing brace */
9897         || ! (endbrace == RExC_parse            /* nothing between the {} */
9898               || (endbrace - RExC_parse >= 2    /* U+ (bad hex is checked below */
9899                   && strnEQ(RExC_parse, "U+", 2)))) /* for a better error msg) */
9900     {
9901         if (endbrace) RExC_parse = endbrace;    /* position msg's '<--HERE' */
9902         vFAIL("\\N{NAME} must be resolved by the lexer");
9903     }
9904
9905     if (endbrace == RExC_parse) {   /* empty: \N{} */
9906         bool ret = TRUE;
9907         if (node_p) {
9908             *node_p = reg_node(pRExC_state,NOTHING);
9909         }
9910         else if (in_char_class) {
9911             if (SIZE_ONLY && in_char_class) {
9912                 if (strict) {
9913                     RExC_parse++;   /* Position after the "}" */
9914                     vFAIL("Zero length \\N{}");
9915                 }
9916                 else {
9917                     ckWARNreg(RExC_parse,
9918                               "Ignoring zero length \\N{} in character class");
9919                 }
9920             }
9921             ret = FALSE;
9922         }
9923         else {
9924             return FALSE;
9925         }
9926         nextchar(pRExC_state);
9927         return ret;
9928     }
9929
9930     RExC_uni_semantics = 1; /* Unicode named chars imply Unicode semantics */
9931     RExC_parse += 2;    /* Skip past the 'U+' */
9932
9933     endchar = RExC_parse + strcspn(RExC_parse, ".}");
9934
9935     /* Code points are separated by dots.  If none, there is only one code
9936      * point, and is terminated by the brace */
9937     has_multiple_chars = (endchar < endbrace);
9938
9939     if (valuep && (! has_multiple_chars || in_char_class)) {
9940         /* We only pay attention to the first char of
9941         multichar strings being returned in char classes. I kinda wonder
9942         if this makes sense as it does change the behaviour
9943         from earlier versions, OTOH that behaviour was broken
9944         as well. XXX Solution is to recharacterize as
9945         [rest-of-class]|multi1|multi2... */
9946
9947         STRLEN length_of_hex = (STRLEN)(endchar - RExC_parse);
9948         I32 grok_hex_flags = PERL_SCAN_ALLOW_UNDERSCORES
9949             | PERL_SCAN_DISALLOW_PREFIX
9950             | (SIZE_ONLY ? PERL_SCAN_SILENT_ILLDIGIT : 0);
9951
9952         *valuep = grok_hex(RExC_parse, &length_of_hex, &grok_hex_flags, NULL);
9953
9954         /* The tokenizer should have guaranteed validity, but it's possible to
9955          * bypass it by using single quoting, so check */
9956         if (length_of_hex == 0
9957             || length_of_hex != (STRLEN)(endchar - RExC_parse) )
9958         {
9959             RExC_parse += length_of_hex;        /* Includes all the valid */
9960             RExC_parse += (RExC_orig_utf8)      /* point to after 1st invalid */
9961                             ? UTF8SKIP(RExC_parse)
9962                             : 1;
9963             /* Guard against malformed utf8 */
9964             if (RExC_parse >= endchar) {
9965                 RExC_parse = endchar;
9966             }
9967             vFAIL("Invalid hexadecimal number in \\N{U+...}");
9968         }
9969
9970         if (in_char_class && has_multiple_chars) {
9971             if (strict) {
9972                 RExC_parse = endbrace;
9973                 vFAIL("\\N{} in character class restricted to one character");
9974             }
9975             else {
9976                 ckWARNreg(endchar, "Using just the first character returned by \\N{} in character class");
9977             }
9978         }
9979
9980         RExC_parse = endbrace + 1;
9981     }
9982     else if (! node_p || ! has_multiple_chars) {
9983
9984         /* Here, the input is legal, but not according to the caller's
9985          * options.  We fail without advancing the parse, so that the
9986          * caller can try again */
9987         RExC_parse = p;
9988         return FALSE;
9989     }
9990     else {
9991
9992         /* What is done here is to convert this to a sub-pattern of the form
9993          * (?:\x{char1}\x{char2}...)
9994          * and then call reg recursively.  That way, it retains its atomicness,
9995          * while not having to worry about special handling that some code
9996          * points may have.  toke.c has converted the original Unicode values
9997          * to native, so that we can just pass on the hex values unchanged.  We
9998          * do have to set a flag to keep recoding from happening in the
9999          * recursion */
10000
10001         SV * substitute_parse = newSVpvn_flags("?:", 2, SVf_UTF8|SVs_TEMP);
10002         STRLEN len;
10003         char *orig_end = RExC_end;
10004         I32 flags;
10005
10006         while (RExC_parse < endbrace) {
10007
10008             /* Convert to notation the rest of the code understands */
10009             sv_catpv(substitute_parse, "\\x{");
10010             sv_catpvn(substitute_parse, RExC_parse, endchar - RExC_parse);
10011             sv_catpv(substitute_parse, "}");
10012
10013             /* Point to the beginning of the next character in the sequence. */
10014             RExC_parse = endchar + 1;
10015             endchar = RExC_parse + strcspn(RExC_parse, ".}");
10016         }
10017         sv_catpv(substitute_parse, ")");
10018
10019         RExC_parse = SvPV(substitute_parse, len);
10020
10021         /* Don't allow empty number */
10022         if (len < 8) {
10023             vFAIL("Invalid hexadecimal number in \\N{U+...}");
10024         }
10025         RExC_end = RExC_parse + len;
10026
10027         /* The values are Unicode, and therefore not subject to recoding */
10028         RExC_override_recoding = 1;
10029
10030         if (!(*node_p = reg(pRExC_state, 1, &flags, depth+1))) {
10031             if (flags & RESTART_UTF8) {
10032                 *flagp = RESTART_UTF8;
10033                 return FALSE;
10034             }
10035             FAIL2("panic: reg returned NULL to grok_bslash_N, flags=%#X",
10036                   flags);
10037         } 
10038         *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
10039
10040         RExC_parse = endbrace;
10041         RExC_end = orig_end;
10042         RExC_override_recoding = 0;
10043
10044         nextchar(pRExC_state);
10045     }
10046
10047     return TRUE;
10048 }
10049
10050
10051 /*
10052  * reg_recode
10053  *
10054  * It returns the code point in utf8 for the value in *encp.
10055  *    value: a code value in the source encoding
10056  *    encp:  a pointer to an Encode object
10057  *
10058  * If the result from Encode is not a single character,
10059  * it returns U+FFFD (Replacement character) and sets *encp to NULL.
10060  */
10061 STATIC UV
10062 S_reg_recode(pTHX_ const char value, SV **encp)
10063 {
10064     STRLEN numlen = 1;
10065     SV * const sv = newSVpvn_flags(&value, numlen, SVs_TEMP);
10066     const char * const s = *encp ? sv_recode_to_utf8(sv, *encp) : SvPVX(sv);
10067     const STRLEN newlen = SvCUR(sv);
10068     UV uv = UNICODE_REPLACEMENT;
10069
10070     PERL_ARGS_ASSERT_REG_RECODE;
10071
10072     if (newlen)
10073         uv = SvUTF8(sv)
10074              ? utf8n_to_uvchr((U8*)s, newlen, &numlen, UTF8_ALLOW_DEFAULT)
10075              : *(U8*)s;
10076
10077     if (!newlen || numlen != newlen) {
10078         uv = UNICODE_REPLACEMENT;
10079         *encp = NULL;
10080     }
10081     return uv;
10082 }
10083
10084 PERL_STATIC_INLINE U8
10085 S_compute_EXACTish(pTHX_ RExC_state_t *pRExC_state)
10086 {
10087     U8 op;
10088
10089     PERL_ARGS_ASSERT_COMPUTE_EXACTISH;
10090
10091     if (! FOLD) {
10092         return EXACT;
10093     }
10094
10095     op = get_regex_charset(RExC_flags);
10096     if (op >= REGEX_ASCII_RESTRICTED_CHARSET) {
10097         op--; /* /a is same as /u, and map /aa's offset to what /a's would have
10098                  been, so there is no hole */
10099     }
10100
10101     return op + EXACTF;
10102 }
10103
10104 PERL_STATIC_INLINE void
10105 S_alloc_maybe_populate_EXACT(pTHX_ RExC_state_t *pRExC_state, regnode *node, I32* flagp, STRLEN len, UV code_point)
10106 {
10107     /* This knows the details about sizing an EXACTish node, setting flags for
10108      * it (by setting <*flagp>, and potentially populating it with a single
10109      * character.
10110      *
10111      * If <len> (the length in bytes) is non-zero, this function assumes that
10112      * the node has already been populated, and just does the sizing.  In this
10113      * case <code_point> should be the final code point that has already been
10114      * placed into the node.  This value will be ignored except that under some
10115      * circumstances <*flagp> is set based on it.
10116      *
10117      * If <len> is zero, the function assumes that the node is to contain only
10118      * the single character given by <code_point> and calculates what <len>
10119      * should be.  In pass 1, it sizes the node appropriately.  In pass 2, it
10120      * additionally will populate the node's STRING with <code_point>, if <len>
10121      * is 0.  In both cases <*flagp> is appropriately set
10122      *
10123      * It knows that under FOLD, the Latin Sharp S and UTF characters above
10124      * 255, must be folded (the former only when the rules indicate it can
10125      * match 'ss') */
10126
10127     bool len_passed_in = cBOOL(len != 0);
10128     U8 character[UTF8_MAXBYTES_CASE+1];
10129
10130     PERL_ARGS_ASSERT_ALLOC_MAYBE_POPULATE_EXACT;
10131
10132     if (! len_passed_in) {
10133         if (UTF) {
10134             if (FOLD && (! LOC || code_point > 255)) {
10135                 _to_uni_fold_flags(NATIVE_TO_UNI(code_point),
10136                                    character,
10137                                    &len,
10138                                    FOLD_FLAGS_FULL | ((LOC)
10139                                                      ? FOLD_FLAGS_LOCALE
10140                                                      : (ASCII_FOLD_RESTRICTED)
10141                                                        ? FOLD_FLAGS_NOMIX_ASCII
10142                                                        : 0));
10143             }
10144             else {
10145                 uvchr_to_utf8( character, code_point);
10146                 len = UTF8SKIP(character);
10147             }
10148         }
10149         else if (! FOLD
10150                  || code_point != LATIN_SMALL_LETTER_SHARP_S
10151                  || ASCII_FOLD_RESTRICTED
10152                  || ! AT_LEAST_UNI_SEMANTICS)
10153         {
10154             *character = (U8) code_point;
10155             len = 1;
10156         }
10157         else {
10158             *character = 's';
10159             *(character + 1) = 's';
10160             len = 2;
10161         }
10162     }
10163
10164     if (SIZE_ONLY) {
10165         RExC_size += STR_SZ(len);
10166     }
10167     else {
10168         RExC_emit += STR_SZ(len);
10169         STR_LEN(node) = len;
10170         if (! len_passed_in) {
10171             Copy((char *) character, STRING(node), len, char);
10172         }
10173     }
10174
10175     *flagp |= HASWIDTH;
10176
10177     /* A single character node is SIMPLE, except for the special-cased SHARP S
10178      * under /di. */
10179     if ((len == 1 || (UTF && len == UNISKIP(code_point)))
10180         && (code_point != LATIN_SMALL_LETTER_SHARP_S
10181             || ! FOLD || ! DEPENDS_SEMANTICS))
10182     {
10183         *flagp |= SIMPLE;
10184     }
10185 }
10186
10187 /*
10188  - regatom - the lowest level
10189
10190    Try to identify anything special at the start of the pattern. If there
10191    is, then handle it as required. This may involve generating a single regop,
10192    such as for an assertion; or it may involve recursing, such as to
10193    handle a () structure.
10194
10195    If the string doesn't start with something special then we gobble up
10196    as much literal text as we can.
10197
10198    Once we have been able to handle whatever type of thing started the
10199    sequence, we return.
10200
10201    Note: we have to be careful with escapes, as they can be both literal
10202    and special, and in the case of \10 and friends, context determines which.
10203
10204    A summary of the code structure is:
10205
10206    switch (first_byte) {
10207         cases for each special:
10208             handle this special;
10209             break;
10210         case '\\':
10211             switch (2nd byte) {
10212                 cases for each unambiguous special:
10213                     handle this special;
10214                     break;
10215                 cases for each ambigous special/literal:
10216                     disambiguate;
10217                     if (special)  handle here
10218                     else goto defchar;
10219                 default: // unambiguously literal:
10220                     goto defchar;
10221             }
10222         default:  // is a literal char
10223             // FALL THROUGH
10224         defchar:
10225             create EXACTish node for literal;
10226             while (more input and node isn't full) {
10227                 switch (input_byte) {
10228                    cases for each special;
10229                        make sure parse pointer is set so that the next call to
10230                            regatom will see this special first
10231                        goto loopdone; // EXACTish node terminated by prev. char
10232                    default:
10233                        append char to EXACTISH node;
10234                 }
10235                 get next input byte;
10236             }
10237         loopdone:
10238    }
10239    return the generated node;
10240
10241    Specifically there are two separate switches for handling
10242    escape sequences, with the one for handling literal escapes requiring
10243    a dummy entry for all of the special escapes that are actually handled
10244    by the other.
10245
10246    Returns NULL, setting *flagp to TRYAGAIN if reg() returns NULL with
10247    TRYAGAIN.  
10248    Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan needs to be
10249    restarted.
10250    Otherwise does not return NULL.
10251 */
10252
10253 STATIC regnode *
10254 S_regatom(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
10255 {
10256     dVAR;
10257     regnode *ret = NULL;
10258     I32 flags = 0;
10259     char *parse_start = RExC_parse;
10260     U8 op;
10261     int invert = 0;
10262
10263     GET_RE_DEBUG_FLAGS_DECL;
10264
10265     *flagp = WORST;             /* Tentatively. */
10266
10267     DEBUG_PARSE("atom");
10268
10269     PERL_ARGS_ASSERT_REGATOM;
10270
10271 tryagain:
10272     switch ((U8)*RExC_parse) {
10273     case '^':
10274         RExC_seen_zerolen++;
10275         nextchar(pRExC_state);
10276         if (RExC_flags & RXf_PMf_MULTILINE)
10277             ret = reg_node(pRExC_state, MBOL);
10278         else if (RExC_flags & RXf_PMf_SINGLELINE)
10279             ret = reg_node(pRExC_state, SBOL);
10280         else
10281             ret = reg_node(pRExC_state, BOL);
10282         Set_Node_Length(ret, 1); /* MJD */
10283         break;
10284     case '$':
10285         nextchar(pRExC_state);
10286         if (*RExC_parse)
10287             RExC_seen_zerolen++;
10288         if (RExC_flags & RXf_PMf_MULTILINE)
10289             ret = reg_node(pRExC_state, MEOL);
10290         else if (RExC_flags & RXf_PMf_SINGLELINE)
10291             ret = reg_node(pRExC_state, SEOL);
10292         else
10293             ret = reg_node(pRExC_state, EOL);
10294         Set_Node_Length(ret, 1); /* MJD */
10295         break;
10296     case '.':
10297         nextchar(pRExC_state);
10298         if (RExC_flags & RXf_PMf_SINGLELINE)
10299             ret = reg_node(pRExC_state, SANY);
10300         else
10301             ret = reg_node(pRExC_state, REG_ANY);
10302         *flagp |= HASWIDTH|SIMPLE;
10303         RExC_naughty++;
10304         Set_Node_Length(ret, 1); /* MJD */
10305         break;
10306     case '[':
10307     {
10308         char * const oregcomp_parse = ++RExC_parse;
10309         ret = regclass(pRExC_state, flagp,depth+1,
10310                        FALSE, /* means parse the whole char class */
10311                        TRUE, /* allow multi-char folds */
10312                        FALSE, /* don't silence non-portable warnings. */
10313                        NULL);
10314         if (*RExC_parse != ']') {
10315             RExC_parse = oregcomp_parse;
10316             vFAIL("Unmatched [");
10317         }
10318         if (ret == NULL) {
10319             if (*flagp & RESTART_UTF8)
10320                 return NULL;
10321             FAIL2("panic: regclass returned NULL to regatom, flags=%#X",
10322                   *flagp);
10323         }
10324         nextchar(pRExC_state);
10325         Set_Node_Length(ret, RExC_parse - oregcomp_parse + 1); /* MJD */
10326         break;
10327     }
10328     case '(':
10329         nextchar(pRExC_state);
10330         ret = reg(pRExC_state, 2, &flags,depth+1);
10331         if (ret == NULL) {
10332                 if (flags & TRYAGAIN) {
10333                     if (RExC_parse == RExC_end) {
10334                          /* Make parent create an empty node if needed. */
10335                         *flagp |= TRYAGAIN;
10336                         return(NULL);
10337                     }
10338                     goto tryagain;
10339                 }
10340                 if (flags & RESTART_UTF8) {
10341                     *flagp = RESTART_UTF8;
10342                     return NULL;
10343                 }
10344                 FAIL2("panic: reg returned NULL to regatom, flags=%#X", flags);
10345         }
10346         *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
10347         break;
10348     case '|':
10349     case ')':
10350         if (flags & TRYAGAIN) {
10351             *flagp |= TRYAGAIN;
10352             return NULL;
10353         }
10354         vFAIL("Internal urp");
10355                                 /* Supposed to be caught earlier. */
10356         break;
10357     case '{':
10358         if (!regcurly(RExC_parse, FALSE)) {
10359             RExC_parse++;
10360             goto defchar;
10361         }
10362         /* FALL THROUGH */
10363     case '?':
10364     case '+':
10365     case '*':
10366         RExC_parse++;
10367         vFAIL("Quantifier follows nothing");
10368         break;
10369     case '\\':
10370         /* Special Escapes
10371
10372            This switch handles escape sequences that resolve to some kind
10373            of special regop and not to literal text. Escape sequnces that
10374            resolve to literal text are handled below in the switch marked
10375            "Literal Escapes".
10376
10377            Every entry in this switch *must* have a corresponding entry
10378            in the literal escape switch. However, the opposite is not
10379            required, as the default for this switch is to jump to the
10380            literal text handling code.
10381         */
10382         switch ((U8)*++RExC_parse) {
10383             U8 arg;
10384         /* Special Escapes */
10385         case 'A':
10386             RExC_seen_zerolen++;
10387             ret = reg_node(pRExC_state, SBOL);
10388             *flagp |= SIMPLE;
10389             goto finish_meta_pat;
10390         case 'G':
10391             ret = reg_node(pRExC_state, GPOS);
10392             RExC_seen |= REG_SEEN_GPOS;
10393             *flagp |= SIMPLE;
10394             goto finish_meta_pat;
10395         case 'K':
10396             RExC_seen_zerolen++;
10397             ret = reg_node(pRExC_state, KEEPS);
10398             *flagp |= SIMPLE;
10399             /* XXX:dmq : disabling in-place substitution seems to
10400              * be necessary here to avoid cases of memory corruption, as
10401              * with: C<$_="x" x 80; s/x\K/y/> -- rgs
10402              */
10403             RExC_seen |= REG_SEEN_LOOKBEHIND;
10404             goto finish_meta_pat;
10405         case 'Z':
10406             ret = reg_node(pRExC_state, SEOL);
10407             *flagp |= SIMPLE;
10408             RExC_seen_zerolen++;                /* Do not optimize RE away */
10409             goto finish_meta_pat;
10410         case 'z':
10411             ret = reg_node(pRExC_state, EOS);
10412             *flagp |= SIMPLE;
10413             RExC_seen_zerolen++;                /* Do not optimize RE away */
10414             goto finish_meta_pat;
10415         case 'C':
10416             ret = reg_node(pRExC_state, CANY);
10417             RExC_seen |= REG_SEEN_CANY;
10418             *flagp |= HASWIDTH|SIMPLE;
10419             goto finish_meta_pat;
10420         case 'X':
10421             ret = reg_node(pRExC_state, CLUMP);
10422             *flagp |= HASWIDTH;
10423             goto finish_meta_pat;
10424
10425         case 'W':
10426             invert = 1;
10427             /* FALLTHROUGH */
10428         case 'w':
10429             arg = ANYOF_WORDCHAR;
10430             goto join_posix;
10431
10432         case 'b':
10433             RExC_seen_zerolen++;
10434             RExC_seen |= REG_SEEN_LOOKBEHIND;
10435             op = BOUND + get_regex_charset(RExC_flags);
10436             if (op > BOUNDA) {  /* /aa is same as /a */
10437                 op = BOUNDA;
10438             }
10439             ret = reg_node(pRExC_state, op);
10440             FLAGS(ret) = get_regex_charset(RExC_flags);
10441             *flagp |= SIMPLE;
10442             if (! SIZE_ONLY && (U8) *(RExC_parse + 1) == '{') {
10443                 ckWARNdep(RExC_parse, "\"\\b{\" is deprecated; use \"\\b\\{\" or \"\\b[{]\" instead");
10444             }
10445             goto finish_meta_pat;
10446         case 'B':
10447             RExC_seen_zerolen++;
10448             RExC_seen |= REG_SEEN_LOOKBEHIND;
10449             op = NBOUND + get_regex_charset(RExC_flags);
10450             if (op > NBOUNDA) { /* /aa is same as /a */
10451                 op = NBOUNDA;
10452             }
10453             ret = reg_node(pRExC_state, op);
10454             FLAGS(ret) = get_regex_charset(RExC_flags);
10455             *flagp |= SIMPLE;
10456             if (! SIZE_ONLY && (U8) *(RExC_parse + 1) == '{') {
10457                 ckWARNdep(RExC_parse, "\"\\B{\" is deprecated; use \"\\B\\{\" or \"\\B[{]\" instead");
10458             }
10459             goto finish_meta_pat;
10460
10461         case 'D':
10462             invert = 1;
10463             /* FALLTHROUGH */
10464         case 'd':
10465             arg = ANYOF_DIGIT;
10466             goto join_posix;
10467
10468         case 'R':
10469             ret = reg_node(pRExC_state, LNBREAK);
10470             *flagp |= HASWIDTH|SIMPLE;
10471             goto finish_meta_pat;
10472
10473         case 'H':
10474             invert = 1;
10475             /* FALLTHROUGH */
10476         case 'h':
10477             arg = ANYOF_BLANK;
10478             op = POSIXU;
10479             goto join_posix_op_known;
10480
10481         case 'V':
10482             invert = 1;
10483             /* FALLTHROUGH */
10484         case 'v':
10485             arg = ANYOF_VERTWS;
10486             op = POSIXU;
10487             goto join_posix_op_known;
10488
10489         case 'S':
10490             invert = 1;
10491             /* FALLTHROUGH */
10492         case 's':
10493             arg = ANYOF_SPACE;
10494
10495         join_posix:
10496
10497             op = POSIXD + get_regex_charset(RExC_flags);
10498             if (op > POSIXA) {  /* /aa is same as /a */
10499                 op = POSIXA;
10500             }
10501
10502         join_posix_op_known:
10503
10504             if (invert) {
10505                 op += NPOSIXD - POSIXD;
10506             }
10507
10508             ret = reg_node(pRExC_state, op);
10509             if (! SIZE_ONLY) {
10510                 FLAGS(ret) = namedclass_to_classnum(arg);
10511             }
10512
10513             *flagp |= HASWIDTH|SIMPLE;
10514             /* FALL THROUGH */
10515
10516          finish_meta_pat:           
10517             nextchar(pRExC_state);
10518             Set_Node_Length(ret, 2); /* MJD */
10519             break;          
10520         case 'p':
10521         case 'P':
10522             {
10523 #ifdef DEBUGGING
10524                 char* parse_start = RExC_parse - 2;
10525 #endif
10526
10527                 RExC_parse--;
10528
10529                 ret = regclass(pRExC_state, flagp,depth+1,
10530                                TRUE, /* means just parse this element */
10531                                FALSE, /* don't allow multi-char folds */
10532                                FALSE, /* don't silence non-portable warnings.
10533                                          It would be a bug if these returned
10534                                          non-portables */
10535                                NULL);
10536                 /* regclass() can only return RESTART_UTF8 if multi-char folds
10537                    are allowed.  */
10538                 if (!ret)
10539                     FAIL2("panic: regclass returned NULL to regatom, flags=%#X",
10540                           *flagp);
10541
10542                 RExC_parse--;
10543
10544                 Set_Node_Offset(ret, parse_start + 2);
10545                 Set_Node_Cur_Length(ret);
10546                 nextchar(pRExC_state);
10547             }
10548             break;
10549         case 'N': 
10550             /* Handle \N and \N{NAME} with multiple code points here and not
10551              * below because it can be multicharacter. join_exact() will join
10552              * them up later on.  Also this makes sure that things like
10553              * /\N{BLAH}+/ and \N{BLAH} being multi char Just Happen. dmq.
10554              * The options to the grok function call causes it to fail if the
10555              * sequence is just a single code point.  We then go treat it as
10556              * just another character in the current EXACT node, and hence it
10557              * gets uniform treatment with all the other characters.  The
10558              * special treatment for quantifiers is not needed for such single
10559              * character sequences */
10560             ++RExC_parse;
10561             if (! grok_bslash_N(pRExC_state, &ret, NULL, flagp, depth, FALSE,
10562                                 FALSE /* not strict */ )) {
10563                 if (*flagp & RESTART_UTF8)
10564                     return NULL;
10565                 RExC_parse--;
10566                 goto defchar;
10567             }
10568             break;
10569         case 'k':    /* Handle \k<NAME> and \k'NAME' */
10570         parse_named_seq:
10571         {   
10572             char ch= RExC_parse[1];         
10573             if (ch != '<' && ch != '\'' && ch != '{') {
10574                 RExC_parse++;
10575                 vFAIL2("Sequence %.2s... not terminated",parse_start);
10576             } else {
10577                 /* this pretty much dupes the code for (?P=...) in reg(), if
10578                    you change this make sure you change that */
10579                 char* name_start = (RExC_parse += 2);
10580                 U32 num = 0;
10581                 SV *sv_dat = reg_scan_name(pRExC_state,
10582                     SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
10583                 ch= (ch == '<') ? '>' : (ch == '{') ? '}' : '\'';
10584                 if (RExC_parse == name_start || *RExC_parse != ch)
10585                     vFAIL2("Sequence %.3s... not terminated",parse_start);
10586
10587                 if (!SIZE_ONLY) {
10588                     num = add_data( pRExC_state, 1, "S" );
10589                     RExC_rxi->data->data[num]=(void*)sv_dat;
10590                     SvREFCNT_inc_simple_void(sv_dat);
10591                 }
10592
10593                 RExC_sawback = 1;
10594                 ret = reganode(pRExC_state,
10595                                ((! FOLD)
10596                                  ? NREF
10597                                  : (ASCII_FOLD_RESTRICTED)
10598                                    ? NREFFA
10599                                    : (AT_LEAST_UNI_SEMANTICS)
10600                                      ? NREFFU
10601                                      : (LOC)
10602                                        ? NREFFL
10603                                        : NREFF),
10604                                 num);
10605                 *flagp |= HASWIDTH;
10606
10607                 /* override incorrect value set in reganode MJD */
10608                 Set_Node_Offset(ret, parse_start+1);
10609                 Set_Node_Cur_Length(ret); /* MJD */
10610                 nextchar(pRExC_state);
10611
10612             }
10613             break;
10614         }
10615         case 'g': 
10616         case '1': case '2': case '3': case '4':
10617         case '5': case '6': case '7': case '8': case '9':
10618             {
10619                 I32 num;
10620                 bool isg = *RExC_parse == 'g';
10621                 bool isrel = 0; 
10622                 bool hasbrace = 0;
10623                 if (isg) {
10624                     RExC_parse++;
10625                     if (*RExC_parse == '{') {
10626                         RExC_parse++;
10627                         hasbrace = 1;
10628                     }
10629                     if (*RExC_parse == '-') {
10630                         RExC_parse++;
10631                         isrel = 1;
10632                     }
10633                     if (hasbrace && !isDIGIT(*RExC_parse)) {
10634                         if (isrel) RExC_parse--;
10635                         RExC_parse -= 2;                            
10636                         goto parse_named_seq;
10637                 }   }
10638                 num = atoi(RExC_parse);
10639                 if (isg && num == 0)
10640                     vFAIL("Reference to invalid group 0");
10641                 if (isrel) {
10642                     num = RExC_npar - num;
10643                     if (num < 1)
10644                         vFAIL("Reference to nonexistent or unclosed group");
10645                 }
10646                 if (!isg && num > 9 && num >= RExC_npar)
10647                     /* Probably a character specified in octal, e.g. \35 */
10648                     goto defchar;
10649                 else {
10650                     char * const parse_start = RExC_parse - 1; /* MJD */
10651                     while (isDIGIT(*RExC_parse))
10652                         RExC_parse++;
10653                     if (parse_start == RExC_parse - 1) 
10654                         vFAIL("Unterminated \\g... pattern");
10655                     if (hasbrace) {
10656                         if (*RExC_parse != '}') 
10657                             vFAIL("Unterminated \\g{...} pattern");
10658                         RExC_parse++;
10659                     }    
10660                     if (!SIZE_ONLY) {
10661                         if (num > (I32)RExC_rx->nparens)
10662                             vFAIL("Reference to nonexistent group");
10663                     }
10664                     RExC_sawback = 1;
10665                     ret = reganode(pRExC_state,
10666                                    ((! FOLD)
10667                                      ? REF
10668                                      : (ASCII_FOLD_RESTRICTED)
10669                                        ? REFFA
10670                                        : (AT_LEAST_UNI_SEMANTICS)
10671                                          ? REFFU
10672                                          : (LOC)
10673                                            ? REFFL
10674                                            : REFF),
10675                                     num);
10676                     *flagp |= HASWIDTH;
10677
10678                     /* override incorrect value set in reganode MJD */
10679                     Set_Node_Offset(ret, parse_start+1);
10680                     Set_Node_Cur_Length(ret); /* MJD */
10681                     RExC_parse--;
10682                     nextchar(pRExC_state);
10683                 }
10684             }
10685             break;
10686         case '\0':
10687             if (RExC_parse >= RExC_end)
10688                 FAIL("Trailing \\");
10689             /* FALL THROUGH */
10690         default:
10691             /* Do not generate "unrecognized" warnings here, we fall
10692                back into the quick-grab loop below */
10693             parse_start--;
10694             goto defchar;
10695         }
10696         break;
10697
10698     case '#':
10699         if (RExC_flags & RXf_PMf_EXTENDED) {
10700             if ( reg_skipcomment( pRExC_state ) )
10701                 goto tryagain;
10702         }
10703         /* FALL THROUGH */
10704
10705     default:
10706
10707             parse_start = RExC_parse - 1;
10708
10709             RExC_parse++;
10710
10711         defchar: {
10712             STRLEN len = 0;
10713             UV ender;
10714             char *p;
10715             char *s;
10716 #define MAX_NODE_STRING_SIZE 127
10717             char foldbuf[MAX_NODE_STRING_SIZE+UTF8_MAXBYTES_CASE];
10718             char *s0;
10719             U8 upper_parse = MAX_NODE_STRING_SIZE;
10720             STRLEN foldlen;
10721             U8 node_type;
10722             bool next_is_quantifier;
10723             char * oldp = NULL;
10724
10725             /* If a folding node contains only code points that don't
10726              * participate in folds, it can be changed into an EXACT node,
10727              * which allows the optimizer more things to look for */
10728             bool maybe_exact;
10729
10730             ender = 0;
10731             node_type = compute_EXACTish(pRExC_state);
10732             ret = reg_node(pRExC_state, node_type);
10733
10734             /* In pass1, folded, we use a temporary buffer instead of the
10735              * actual node, as the node doesn't exist yet */
10736             s = (SIZE_ONLY && FOLD) ? foldbuf : STRING(ret);
10737
10738             s0 = s;
10739
10740         reparse:
10741
10742             /* We do the EXACTFish to EXACT node only if folding, and not if in
10743              * locale, as whether a character folds or not isn't known until
10744              * runtime */
10745             maybe_exact = FOLD && ! LOC;
10746
10747             /* XXX The node can hold up to 255 bytes, yet this only goes to
10748              * 127.  I (khw) do not know why.  Keeping it somewhat less than
10749              * 255 allows us to not have to worry about overflow due to
10750              * converting to utf8 and fold expansion, but that value is
10751              * 255-UTF8_MAXBYTES_CASE.  join_exact() may join adjacent nodes
10752              * split up by this limit into a single one using the real max of
10753              * 255.  Even at 127, this breaks under rare circumstances.  If
10754              * folding, we do not want to split a node at a character that is a
10755              * non-final in a multi-char fold, as an input string could just
10756              * happen to want to match across the node boundary.  The join
10757              * would solve that problem if the join actually happens.  But a
10758              * series of more than two nodes in a row each of 127 would cause
10759              * the first join to succeed to get to 254, but then there wouldn't
10760              * be room for the next one, which could at be one of those split
10761              * multi-char folds.  I don't know of any fool-proof solution.  One
10762              * could back off to end with only a code point that isn't such a
10763              * non-final, but it is possible for there not to be any in the
10764              * entire node. */
10765             for (p = RExC_parse - 1;
10766                  len < upper_parse && p < RExC_end;
10767                  len++)
10768             {
10769                 oldp = p;
10770
10771                 if (RExC_flags & RXf_PMf_EXTENDED)
10772                     p = regwhite( pRExC_state, p );
10773                 switch ((U8)*p) {
10774                 case '^':
10775                 case '$':
10776                 case '.':
10777                 case '[':
10778                 case '(':
10779                 case ')':
10780                 case '|':
10781                     goto loopdone;
10782                 case '\\':
10783                     /* Literal Escapes Switch
10784
10785                        This switch is meant to handle escape sequences that
10786                        resolve to a literal character.
10787
10788                        Every escape sequence that represents something
10789                        else, like an assertion or a char class, is handled
10790                        in the switch marked 'Special Escapes' above in this
10791                        routine, but also has an entry here as anything that
10792                        isn't explicitly mentioned here will be treated as
10793                        an unescaped equivalent literal.
10794                     */
10795
10796                     switch ((U8)*++p) {
10797                     /* These are all the special escapes. */
10798                     case 'A':             /* Start assertion */
10799                     case 'b': case 'B':   /* Word-boundary assertion*/
10800                     case 'C':             /* Single char !DANGEROUS! */
10801                     case 'd': case 'D':   /* digit class */
10802                     case 'g': case 'G':   /* generic-backref, pos assertion */
10803                     case 'h': case 'H':   /* HORIZWS */
10804                     case 'k': case 'K':   /* named backref, keep marker */
10805                     case 'p': case 'P':   /* Unicode property */
10806                               case 'R':   /* LNBREAK */
10807                     case 's': case 'S':   /* space class */
10808                     case 'v': case 'V':   /* VERTWS */
10809                     case 'w': case 'W':   /* word class */
10810                     case 'X':             /* eXtended Unicode "combining character sequence" */
10811                     case 'z': case 'Z':   /* End of line/string assertion */
10812                         --p;
10813                         goto loopdone;
10814
10815                     /* Anything after here is an escape that resolves to a
10816                        literal. (Except digits, which may or may not)
10817                      */
10818                     case 'n':
10819                         ender = '\n';
10820                         p++;
10821                         break;
10822                     case 'N': /* Handle a single-code point named character. */
10823                         /* The options cause it to fail if a multiple code
10824                          * point sequence.  Handle those in the switch() above
10825                          * */
10826                         RExC_parse = p + 1;
10827                         if (! grok_bslash_N(pRExC_state, NULL, &ender,
10828                                             flagp, depth, FALSE,
10829                                             FALSE /* not strict */ ))
10830                         {
10831                             if (*flagp & RESTART_UTF8)
10832                                 FAIL("panic: grok_bslash_N set RESTART_UTF8");
10833                             RExC_parse = p = oldp;
10834                             goto loopdone;
10835                         }
10836                         p = RExC_parse;
10837                         if (ender > 0xff) {
10838                             REQUIRE_UTF8;
10839                         }
10840                         break;
10841                     case 'r':
10842                         ender = '\r';
10843                         p++;
10844                         break;
10845                     case 't':
10846                         ender = '\t';
10847                         p++;
10848                         break;
10849                     case 'f':
10850                         ender = '\f';
10851                         p++;
10852                         break;
10853                     case 'e':
10854                           ender = ASCII_TO_NATIVE('\033');
10855                         p++;
10856                         break;
10857                     case 'a':
10858                           ender = ASCII_TO_NATIVE('\007');
10859                         p++;
10860                         break;
10861                     case 'o':
10862                         {
10863                             UV result;
10864                             const char* error_msg;
10865
10866                             bool valid = grok_bslash_o(&p,
10867                                                        &result,
10868                                                        &error_msg,
10869                                                        TRUE, /* out warnings */
10870                                                        FALSE, /* not strict */
10871                                                        TRUE, /* Output warnings
10872                                                                 for non-
10873                                                                 portables */
10874                                                        UTF);
10875                             if (! valid) {
10876                                 RExC_parse = p; /* going to die anyway; point
10877                                                    to exact spot of failure */
10878                                 vFAIL(error_msg);
10879                             }
10880                             ender = result;
10881                             if (PL_encoding && ender < 0x100) {
10882                                 goto recode_encoding;
10883                             }
10884                             if (ender > 0xff) {
10885                                 REQUIRE_UTF8;
10886                             }
10887                             break;
10888                         }
10889                     case 'x':
10890                         {
10891                             UV result = UV_MAX; /* initialize to erroneous
10892                                                    value */
10893                             const char* error_msg;
10894
10895                             bool valid = grok_bslash_x(&p,
10896                                                        &result,
10897                                                        &error_msg,
10898                                                        TRUE, /* out warnings */
10899                                                        FALSE, /* not strict */
10900                                                        TRUE, /* Output warnings
10901                                                                 for non-
10902                                                                 portables */
10903                                                        UTF);
10904                             if (! valid) {
10905                                 RExC_parse = p; /* going to die anyway; point
10906                                                    to exact spot of failure */
10907                                 vFAIL(error_msg);
10908                             }
10909                             ender = result;
10910
10911                             if (PL_encoding && ender < 0x100) {
10912                                 goto recode_encoding;
10913                             }
10914                             if (ender > 0xff) {
10915                                 REQUIRE_UTF8;
10916                             }
10917                             break;
10918                         }
10919                     case 'c':
10920                         p++;
10921                         ender = grok_bslash_c(*p++, UTF, SIZE_ONLY);
10922                         break;
10923                     case '0': case '1': case '2': case '3':case '4':
10924                     case '5': case '6': case '7':
10925                         if (*p == '0' ||
10926                             (isDIGIT(p[1]) && atoi(p) >= RExC_npar))
10927                         {
10928                             I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
10929                             STRLEN numlen = 3;
10930                             ender = grok_oct(p, &numlen, &flags, NULL);
10931                             if (ender > 0xff) {
10932                                 REQUIRE_UTF8;
10933                             }
10934                             p += numlen;
10935                             if (SIZE_ONLY   /* like \08, \178 */
10936                                 && numlen < 3
10937                                 && p < RExC_end
10938                                 && isDIGIT(*p) && ckWARN(WARN_REGEXP))
10939                             {
10940                                 reg_warn_non_literal_string(
10941                                          p + 1,
10942                                          form_short_octal_warning(p, numlen));
10943                             }
10944                         }
10945                         else {  /* Not to be treated as an octal constant, go
10946                                    find backref */
10947                             --p;
10948                             goto loopdone;
10949                         }
10950                         if (PL_encoding && ender < 0x100)
10951                             goto recode_encoding;
10952                         break;
10953                     recode_encoding:
10954                         if (! RExC_override_recoding) {
10955                             SV* enc = PL_encoding;
10956                             ender = reg_recode((const char)(U8)ender, &enc);
10957                             if (!enc && SIZE_ONLY)
10958                                 ckWARNreg(p, "Invalid escape in the specified encoding");
10959                             REQUIRE_UTF8;
10960                         }
10961                         break;
10962                     case '\0':
10963                         if (p >= RExC_end)
10964                             FAIL("Trailing \\");
10965                         /* FALL THROUGH */
10966                     default:
10967                         if (!SIZE_ONLY&& isALPHANUMERIC(*p)) {
10968                             /* Include any { following the alpha to emphasize
10969                              * that it could be part of an escape at some point
10970                              * in the future */
10971                             int len = (isALPHA(*p) && *(p + 1) == '{') ? 2 : 1;
10972                             ckWARN3reg(p + len, "Unrecognized escape \\%.*s passed through", len, p);
10973                         }
10974                         goto normal_default;
10975                     } /* End of switch on '\' */
10976                     break;
10977                 default:    /* A literal character */
10978
10979                     if (! SIZE_ONLY
10980                         && RExC_flags & RXf_PMf_EXTENDED
10981                         && ckWARN(WARN_DEPRECATED)
10982                         && is_PATWS_non_low(p, UTF))
10983                     {
10984                         vWARN_dep(p + ((UTF) ? UTF8SKIP(p) : 1),
10985                                 "Escape literal pattern white space under /x");
10986                     }
10987
10988                   normal_default:
10989                     if (UTF8_IS_START(*p) && UTF) {
10990                         STRLEN numlen;
10991                         ender = utf8n_to_uvchr((U8*)p, RExC_end - p,
10992                                                &numlen, UTF8_ALLOW_DEFAULT);
10993                         p += numlen;
10994                     }
10995                     else
10996                         ender = (U8) *p++;
10997                     break;
10998                 } /* End of switch on the literal */
10999
11000                 /* Here, have looked at the literal character and <ender>
11001                  * contains its ordinal, <p> points to the character after it
11002                  */
11003
11004                 if ( RExC_flags & RXf_PMf_EXTENDED)
11005                     p = regwhite( pRExC_state, p );
11006
11007                 /* If the next thing is a quantifier, it applies to this
11008                  * character only, which means that this character has to be in
11009                  * its own node and can't just be appended to the string in an
11010                  * existing node, so if there are already other characters in
11011                  * the node, close the node with just them, and set up to do
11012                  * this character again next time through, when it will be the
11013                  * only thing in its new node */
11014                 if ((next_is_quantifier = (p < RExC_end && ISMULT2(p))) && len)
11015                 {
11016                     p = oldp;
11017                     goto loopdone;
11018                 }
11019
11020                 if (FOLD) {
11021                     if (UTF
11022                             /* See comments for join_exact() as to why we fold
11023                              * this non-UTF at compile time */
11024                         || (node_type == EXACTFU
11025                             && ender == LATIN_SMALL_LETTER_SHARP_S))
11026                     {
11027
11028
11029                         /* Prime the casefolded buffer.  Locale rules, which
11030                          * apply only to code points < 256, aren't known until
11031                          * execution, so for them, just output the original
11032                          * character using utf8.  If we start to fold non-UTF
11033                          * patterns, be sure to update join_exact() */
11034                         if (LOC && ender < 256) {
11035                             if (UNI_IS_INVARIANT(ender)) {
11036                                 *s = (U8) ender;
11037                                 foldlen = 1;
11038                             } else {
11039                                 *s = UTF8_TWO_BYTE_HI(ender);
11040                                 *(s + 1) = UTF8_TWO_BYTE_LO(ender);
11041                                 foldlen = 2;
11042                             }
11043                         }
11044                         else {
11045                             UV folded = _to_uni_fold_flags(
11046                                            ender,
11047                                            (U8 *) s,
11048                                            &foldlen,
11049                                            FOLD_FLAGS_FULL
11050                                            | ((LOC) ?  FOLD_FLAGS_LOCALE
11051                                                     : (ASCII_FOLD_RESTRICTED)
11052                                                       ? FOLD_FLAGS_NOMIX_ASCII
11053                                                       : 0)
11054                                             );
11055
11056                             /* If this node only contains non-folding code
11057                              * points so far, see if this new one is also
11058                              * non-folding */
11059                             if (maybe_exact) {
11060                                 if (folded != ender) {
11061                                     maybe_exact = FALSE;
11062                                 }
11063                                 else {
11064                                     /* Here the fold is the original; we have
11065                                      * to check further to see if anything
11066                                      * folds to it */
11067                                     if (! PL_utf8_foldable) {
11068                                         SV* swash = swash_init("utf8",
11069                                                            "_Perl_Any_Folds",
11070                                                            &PL_sv_undef, 1, 0);
11071                                         PL_utf8_foldable =
11072                                                     _get_swash_invlist(swash);
11073                                         SvREFCNT_dec_NN(swash);
11074                                     }
11075                                     if (_invlist_contains_cp(PL_utf8_foldable,
11076                                                              ender))
11077                                     {
11078                                         maybe_exact = FALSE;
11079                                     }
11080                                 }
11081                             }
11082                             ender = folded;
11083                         }
11084                         s += foldlen;
11085
11086                         /* The loop increments <len> each time, as all but this
11087                          * path (and the one just below for UTF) through it add
11088                          * a single byte to the EXACTish node.  But this one
11089                          * has changed len to be the correct final value, so
11090                          * subtract one to cancel out the increment that
11091                          * follows */
11092                         len += foldlen - 1;
11093                     }
11094                     else {
11095                         *(s++) = (char) ender;
11096                         maybe_exact &= ! IS_IN_SOME_FOLD_L1(ender);
11097                     }
11098                 }
11099                 else if (UTF) {
11100                     const STRLEN unilen = reguni(pRExC_state, ender, s);
11101                     if (unilen > 0) {
11102                        s   += unilen;
11103                        len += unilen;
11104                     }
11105
11106                     /* See comment just above for - 1 */
11107                     len--;
11108                 }
11109                 else {
11110                     REGC((char)ender, s++);
11111                 }
11112
11113                 if (next_is_quantifier) {
11114
11115                     /* Here, the next input is a quantifier, and to get here,
11116                      * the current character is the only one in the node.
11117                      * Also, here <len> doesn't include the final byte for this
11118                      * character */
11119                     len++;
11120                     goto loopdone;
11121                 }
11122
11123             } /* End of loop through literal characters */
11124
11125             /* Here we have either exhausted the input or ran out of room in
11126              * the node.  (If we encountered a character that can't be in the
11127              * node, transfer is made directly to <loopdone>, and so we
11128              * wouldn't have fallen off the end of the loop.)  In the latter
11129              * case, we artificially have to split the node into two, because
11130              * we just don't have enough space to hold everything.  This
11131              * creates a problem if the final character participates in a
11132              * multi-character fold in the non-final position, as a match that
11133              * should have occurred won't, due to the way nodes are matched,
11134              * and our artificial boundary.  So back off until we find a non-
11135              * problematic character -- one that isn't at the beginning or
11136              * middle of such a fold.  (Either it doesn't participate in any
11137              * folds, or appears only in the final position of all the folds it
11138              * does participate in.)  A better solution with far fewer false
11139              * positives, and that would fill the nodes more completely, would
11140              * be to actually have available all the multi-character folds to
11141              * test against, and to back-off only far enough to be sure that
11142              * this node isn't ending with a partial one.  <upper_parse> is set
11143              * further below (if we need to reparse the node) to include just
11144              * up through that final non-problematic character that this code
11145              * identifies, so when it is set to less than the full node, we can
11146              * skip the rest of this */
11147             if (FOLD && p < RExC_end && upper_parse == MAX_NODE_STRING_SIZE) {
11148
11149                 const STRLEN full_len = len;
11150
11151                 assert(len >= MAX_NODE_STRING_SIZE);
11152
11153                 /* Here, <s> points to the final byte of the final character.
11154                  * Look backwards through the string until find a non-
11155                  * problematic character */
11156
11157                 if (! UTF) {
11158
11159                     /* These two have no multi-char folds to non-UTF characters
11160                      */
11161                     if (ASCII_FOLD_RESTRICTED || LOC) {
11162                         goto loopdone;
11163                     }
11164
11165                     while (--s >= s0 && IS_NON_FINAL_FOLD(*s)) { }
11166                     len = s - s0 + 1;
11167                 }
11168                 else {
11169                     if (!  PL_NonL1NonFinalFold) {
11170                         PL_NonL1NonFinalFold = _new_invlist_C_array(
11171                                         NonL1_Perl_Non_Final_Folds_invlist);
11172                     }
11173
11174                     /* Point to the first byte of the final character */
11175                     s = (char *) utf8_hop((U8 *) s, -1);
11176
11177                     while (s >= s0) {   /* Search backwards until find
11178                                            non-problematic char */
11179                         if (UTF8_IS_INVARIANT(*s)) {
11180
11181                             /* There are no ascii characters that participate
11182                              * in multi-char folds under /aa.  In EBCDIC, the
11183                              * non-ascii invariants are all control characters,
11184                              * so don't ever participate in any folds. */
11185                             if (ASCII_FOLD_RESTRICTED
11186                                 || ! IS_NON_FINAL_FOLD(*s))
11187                             {
11188                                 break;
11189                             }
11190                         }
11191                         else if (UTF8_IS_DOWNGRADEABLE_START(*s)) {
11192
11193                             /* No Latin1 characters participate in multi-char
11194                              * folds under /l */
11195                             if (LOC
11196                                 || ! IS_NON_FINAL_FOLD(TWO_BYTE_UTF8_TO_UNI(
11197                                                                 *s, *(s+1))))
11198                             {
11199                                 break;
11200                             }
11201                         }
11202                         else if (! _invlist_contains_cp(
11203                                         PL_NonL1NonFinalFold,
11204                                         valid_utf8_to_uvchr((U8 *) s, NULL)))
11205                         {
11206                             break;
11207                         }
11208
11209                         /* Here, the current character is problematic in that
11210                          * it does occur in the non-final position of some
11211                          * fold, so try the character before it, but have to
11212                          * special case the very first byte in the string, so
11213                          * we don't read outside the string */
11214                         s = (s == s0) ? s -1 : (char *) utf8_hop((U8 *) s, -1);
11215                     } /* End of loop backwards through the string */
11216
11217                     /* If there were only problematic characters in the string,
11218                      * <s> will point to before s0, in which case the length
11219                      * should be 0, otherwise include the length of the
11220                      * non-problematic character just found */
11221                     len = (s < s0) ? 0 : s - s0 + UTF8SKIP(s);
11222                 }
11223
11224                 /* Here, have found the final character, if any, that is
11225                  * non-problematic as far as ending the node without splitting
11226                  * it across a potential multi-char fold.  <len> contains the
11227                  * number of bytes in the node up-to and including that
11228                  * character, or is 0 if there is no such character, meaning
11229                  * the whole node contains only problematic characters.  In
11230                  * this case, give up and just take the node as-is.  We can't
11231                  * do any better */
11232                 if (len == 0) {
11233                     len = full_len;
11234                 } else {
11235
11236                     /* Here, the node does contain some characters that aren't
11237                      * problematic.  If one such is the final character in the
11238                      * node, we are done */
11239                     if (len == full_len) {
11240                         goto loopdone;
11241                     }
11242                     else if (len + ((UTF) ? UTF8SKIP(s) : 1) == full_len) {
11243
11244                         /* If the final character is problematic, but the
11245                          * penultimate is not, back-off that last character to
11246                          * later start a new node with it */
11247                         p = oldp;
11248                         goto loopdone;
11249                     }
11250
11251                     /* Here, the final non-problematic character is earlier
11252                      * in the input than the penultimate character.  What we do
11253                      * is reparse from the beginning, going up only as far as
11254                      * this final ok one, thus guaranteeing that the node ends
11255                      * in an acceptable character.  The reason we reparse is
11256                      * that we know how far in the character is, but we don't
11257                      * know how to correlate its position with the input parse.
11258                      * An alternate implementation would be to build that
11259                      * correlation as we go along during the original parse,
11260                      * but that would entail extra work for every node, whereas
11261                      * this code gets executed only when the string is too
11262                      * large for the node, and the final two characters are
11263                      * problematic, an infrequent occurrence.  Yet another
11264                      * possible strategy would be to save the tail of the
11265                      * string, and the next time regatom is called, initialize
11266                      * with that.  The problem with this is that unless you
11267                      * back off one more character, you won't be guaranteed
11268                      * regatom will get called again, unless regbranch,
11269                      * regpiece ... are also changed.  If you do back off that
11270                      * extra character, so that there is input guaranteed to
11271                      * force calling regatom, you can't handle the case where
11272                      * just the first character in the node is acceptable.  I
11273                      * (khw) decided to try this method which doesn't have that
11274                      * pitfall; if performance issues are found, we can do a
11275                      * combination of the current approach plus that one */
11276                     upper_parse = len;
11277                     len = 0;
11278                     s = s0;
11279                     goto reparse;
11280                 }
11281             }   /* End of verifying node ends with an appropriate char */
11282
11283         loopdone:   /* Jumped to when encounters something that shouldn't be in
11284                        the node */
11285
11286             /* If 'maybe_exact' is still set here, means there are no
11287              * code points in the node that participate in folds */
11288             if (FOLD && maybe_exact) {
11289                 OP(ret) = EXACT;
11290             }
11291
11292             /* I (khw) don't know if you can get here with zero length, but the
11293              * old code handled this situation by creating a zero-length EXACT
11294              * node.  Might as well be NOTHING instead */
11295             if (len == 0) {
11296                 OP(ret) = NOTHING;
11297             }
11298             else{
11299                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, len, ender);
11300             }
11301
11302             RExC_parse = p - 1;
11303             Set_Node_Cur_Length(ret); /* MJD */
11304             nextchar(pRExC_state);
11305             {
11306                 /* len is STRLEN which is unsigned, need to copy to signed */
11307                 IV iv = len;
11308                 if (iv < 0)
11309                     vFAIL("Internal disaster");
11310             }
11311
11312         } /* End of label 'defchar:' */
11313         break;
11314     } /* End of giant switch on input character */
11315
11316     return(ret);
11317 }
11318
11319 STATIC char *
11320 S_regwhite( RExC_state_t *pRExC_state, char *p )
11321 {
11322     const char *e = RExC_end;
11323
11324     PERL_ARGS_ASSERT_REGWHITE;
11325
11326     while (p < e) {
11327         if (isSPACE(*p))
11328             ++p;
11329         else if (*p == '#') {
11330             bool ended = 0;
11331             do {
11332                 if (*p++ == '\n') {
11333                     ended = 1;
11334                     break;
11335                 }
11336             } while (p < e);
11337             if (!ended)
11338                 RExC_seen |= REG_SEEN_RUN_ON_COMMENT;
11339         }
11340         else
11341             break;
11342     }
11343     return p;
11344 }
11345
11346 STATIC char *
11347 S_regpatws( RExC_state_t *pRExC_state, char *p , const bool recognize_comment )
11348 {
11349     /* Returns the next non-pattern-white space, non-comment character (the
11350      * latter only if 'recognize_comment is true) in the string p, which is
11351      * ended by RExC_end.  If there is no line break ending a comment,
11352      * RExC_seen has added the REG_SEEN_RUN_ON_COMMENT flag; */
11353     const char *e = RExC_end;
11354
11355     PERL_ARGS_ASSERT_REGPATWS;
11356
11357     while (p < e) {
11358         STRLEN len;
11359         if ((len = is_PATWS_safe(p, e, UTF))) {
11360             p += len;
11361         }
11362         else if (recognize_comment && *p == '#') {
11363             bool ended = 0;
11364             do {
11365                 p++;
11366                 if (is_LNBREAK_safe(p, e, UTF)) {
11367                     ended = 1;
11368                     break;
11369                 }
11370             } while (p < e);
11371             if (!ended)
11372                 RExC_seen |= REG_SEEN_RUN_ON_COMMENT;
11373         }
11374         else
11375             break;
11376     }
11377     return p;
11378 }
11379
11380 /* Parse POSIX character classes: [[:foo:]], [[=foo=]], [[.foo.]].
11381    Character classes ([:foo:]) can also be negated ([:^foo:]).
11382    Returns a named class id (ANYOF_XXX) if successful, -1 otherwise.
11383    Equivalence classes ([=foo=]) and composites ([.foo.]) are parsed,
11384    but trigger failures because they are currently unimplemented. */
11385
11386 #define POSIXCC_DONE(c)   ((c) == ':')
11387 #define POSIXCC_NOTYET(c) ((c) == '=' || (c) == '.')
11388 #define POSIXCC(c) (POSIXCC_DONE(c) || POSIXCC_NOTYET(c))
11389
11390 PERL_STATIC_INLINE I32
11391 S_regpposixcc(pTHX_ RExC_state_t *pRExC_state, I32 value, const bool strict)
11392 {
11393     dVAR;
11394     I32 namedclass = OOB_NAMEDCLASS;
11395
11396     PERL_ARGS_ASSERT_REGPPOSIXCC;
11397
11398     if (value == '[' && RExC_parse + 1 < RExC_end &&
11399         /* I smell either [: or [= or [. -- POSIX has been here, right? */
11400         POSIXCC(UCHARAT(RExC_parse)))
11401     {
11402         const char c = UCHARAT(RExC_parse);
11403         char* const s = RExC_parse++;
11404
11405         while (RExC_parse < RExC_end && UCHARAT(RExC_parse) != c)
11406             RExC_parse++;
11407         if (RExC_parse == RExC_end) {
11408             if (strict) {
11409
11410                 /* Try to give a better location for the error (than the end of
11411                  * the string) by looking for the matching ']' */
11412                 RExC_parse = s;
11413                 while (RExC_parse < RExC_end && UCHARAT(RExC_parse) != ']') {
11414                     RExC_parse++;
11415                 }
11416                 vFAIL2("Unmatched '%c' in POSIX class", c);
11417             }
11418             /* Grandfather lone [:, [=, [. */
11419             RExC_parse = s;
11420         }
11421         else {
11422             const char* const t = RExC_parse++; /* skip over the c */
11423             assert(*t == c);
11424
11425             if (UCHARAT(RExC_parse) == ']') {
11426                 const char *posixcc = s + 1;
11427                 RExC_parse++; /* skip over the ending ] */
11428
11429                 if (*s == ':') {
11430                     const I32 complement = *posixcc == '^' ? *posixcc++ : 0;
11431                     const I32 skip = t - posixcc;
11432
11433                     /* Initially switch on the length of the name.  */
11434                     switch (skip) {
11435                     case 4:
11436                         if (memEQ(posixcc, "word", 4)) /* this is not POSIX,
11437                                                           this is the Perl \w
11438                                                         */
11439                             namedclass = ANYOF_WORDCHAR;
11440                         break;
11441                     case 5:
11442                         /* Names all of length 5.  */
11443                         /* alnum alpha ascii blank cntrl digit graph lower
11444                            print punct space upper  */
11445                         /* Offset 4 gives the best switch position.  */
11446                         switch (posixcc[4]) {
11447                         case 'a':
11448                             if (memEQ(posixcc, "alph", 4)) /* alpha */
11449                                 namedclass = ANYOF_ALPHA;
11450                             break;
11451                         case 'e':
11452                             if (memEQ(posixcc, "spac", 4)) /* space */
11453                                 namedclass = ANYOF_PSXSPC;
11454                             break;
11455                         case 'h':
11456                             if (memEQ(posixcc, "grap", 4)) /* graph */
11457                                 namedclass = ANYOF_GRAPH;
11458                             break;
11459                         case 'i':
11460                             if (memEQ(posixcc, "asci", 4)) /* ascii */
11461                                 namedclass = ANYOF_ASCII;
11462                             break;
11463                         case 'k':
11464                             if (memEQ(posixcc, "blan", 4)) /* blank */
11465                                 namedclass = ANYOF_BLANK;
11466                             break;
11467                         case 'l':
11468                             if (memEQ(posixcc, "cntr", 4)) /* cntrl */
11469                                 namedclass = ANYOF_CNTRL;
11470                             break;
11471                         case 'm':
11472                             if (memEQ(posixcc, "alnu", 4)) /* alnum */
11473                                 namedclass = ANYOF_ALPHANUMERIC;
11474                             break;
11475                         case 'r':
11476                             if (memEQ(posixcc, "lowe", 4)) /* lower */
11477                                 namedclass = (FOLD) ? ANYOF_CASED : ANYOF_LOWER;
11478                             else if (memEQ(posixcc, "uppe", 4)) /* upper */
11479                                 namedclass = (FOLD) ? ANYOF_CASED : ANYOF_UPPER;
11480                             break;
11481                         case 't':
11482                             if (memEQ(posixcc, "digi", 4)) /* digit */
11483                                 namedclass = ANYOF_DIGIT;
11484                             else if (memEQ(posixcc, "prin", 4)) /* print */
11485                                 namedclass = ANYOF_PRINT;
11486                             else if (memEQ(posixcc, "punc", 4)) /* punct */
11487                                 namedclass = ANYOF_PUNCT;
11488                             break;
11489                         }
11490                         break;
11491                     case 6:
11492                         if (memEQ(posixcc, "xdigit", 6))
11493                             namedclass = ANYOF_XDIGIT;
11494                         break;
11495                     }
11496
11497                     if (namedclass == OOB_NAMEDCLASS)
11498                         Simple_vFAIL3("POSIX class [:%.*s:] unknown",
11499                                       t - s - 1, s + 1);
11500
11501                     /* The #defines are structured so each complement is +1 to
11502                      * the normal one */
11503                     if (complement) {
11504                         namedclass++;
11505                     }
11506                     assert (posixcc[skip] == ':');
11507                     assert (posixcc[skip+1] == ']');
11508                 } else if (!SIZE_ONLY) {
11509                     /* [[=foo=]] and [[.foo.]] are still future. */
11510
11511                     /* adjust RExC_parse so the warning shows after
11512                        the class closes */
11513                     while (UCHARAT(RExC_parse) && UCHARAT(RExC_parse) != ']')
11514                         RExC_parse++;
11515                     vFAIL3("POSIX syntax [%c %c] is reserved for future extensions", c, c);
11516                 }
11517             } else {
11518                 /* Maternal grandfather:
11519                  * "[:" ending in ":" but not in ":]" */
11520                 if (strict) {
11521                     vFAIL("Unmatched '[' in POSIX class");
11522                 }
11523
11524                 /* Grandfather lone [:, [=, [. */
11525                 RExC_parse = s;
11526             }
11527         }
11528     }
11529
11530     return namedclass;
11531 }
11532
11533 STATIC bool
11534 S_could_it_be_a_POSIX_class(pTHX_ RExC_state_t *pRExC_state)
11535 {
11536     /* This applies some heuristics at the current parse position (which should
11537      * be at a '[') to see if what follows might be intended to be a [:posix:]
11538      * class.  It returns true if it really is a posix class, of course, but it
11539      * also can return true if it thinks that what was intended was a posix
11540      * class that didn't quite make it.
11541      *
11542      * It will return true for
11543      *      [:alphanumerics:
11544      *      [:alphanumerics]  (as long as the ] isn't followed immediately by a
11545      *                         ')' indicating the end of the (?[
11546      *      [:any garbage including %^&$ punctuation:]
11547      *
11548      * This is designed to be called only from S_handle_regex_sets; it could be
11549      * easily adapted to be called from the spot at the beginning of regclass()
11550      * that checks to see in a normal bracketed class if the surrounding []
11551      * have been omitted ([:word:] instead of [[:word:]]).  But doing so would
11552      * change long-standing behavior, so I (khw) didn't do that */
11553     char* p = RExC_parse + 1;
11554     char first_char = *p;
11555
11556     PERL_ARGS_ASSERT_COULD_IT_BE_A_POSIX_CLASS;
11557
11558     assert(*(p - 1) == '[');
11559
11560     if (! POSIXCC(first_char)) {
11561         return FALSE;
11562     }
11563
11564     p++;
11565     while (p < RExC_end && isWORDCHAR(*p)) p++;
11566
11567     if (p >= RExC_end) {
11568         return FALSE;
11569     }
11570
11571     if (p - RExC_parse > 2    /* Got at least 1 word character */
11572         && (*p == first_char
11573             || (*p == ']' && p + 1 < RExC_end && *(p + 1) != ')')))
11574     {
11575         return TRUE;
11576     }
11577
11578     p = (char *) memchr(RExC_parse, ']', RExC_end - RExC_parse);
11579
11580     return (p
11581             && p - RExC_parse > 2 /* [:] evaluates to colon;
11582                                       [::] is a bad posix class. */
11583             && first_char == *(p - 1));
11584 }
11585
11586 STATIC regnode *
11587 S_handle_regex_sets(pTHX_ RExC_state_t *pRExC_state, SV** return_invlist, I32 *flagp, U32 depth,
11588                    char * const oregcomp_parse)
11589 {
11590     /* Handle the (?[...]) construct to do set operations */
11591
11592     U8 curchar;
11593     UV start, end;      /* End points of code point ranges */
11594     SV* result_string;
11595     char *save_end, *save_parse;
11596     SV* final;
11597     STRLEN len;
11598     regnode* node;
11599     AV* stack;
11600     const bool save_fold = FOLD;
11601
11602     GET_RE_DEBUG_FLAGS_DECL;
11603
11604     PERL_ARGS_ASSERT_HANDLE_REGEX_SETS;
11605
11606     if (LOC) {
11607         vFAIL("(?[...]) not valid in locale");
11608     }
11609     RExC_uni_semantics = 1;
11610
11611     /* This will return only an ANYOF regnode, or (unlikely) something smaller
11612      * (such as EXACT).  Thus we can skip most everything if just sizing.  We
11613      * call regclass to handle '[]' so as to not have to reinvent its parsing
11614      * rules here (throwing away the size it computes each time).  And, we exit
11615      * upon an unescaped ']' that isn't one ending a regclass.  To do both
11616      * these things, we need to realize that something preceded by a backslash
11617      * is escaped, so we have to keep track of backslashes */
11618     if (SIZE_ONLY) {
11619
11620         Perl_ck_warner_d(aTHX_
11621             packWARN(WARN_EXPERIMENTAL__REGEX_SETS),
11622             "The regex_sets feature is experimental" REPORT_LOCATION,
11623             (int) (RExC_parse - RExC_precomp) , RExC_precomp, RExC_parse);
11624
11625         while (RExC_parse < RExC_end) {
11626             SV* current = NULL;
11627             RExC_parse = regpatws(pRExC_state, RExC_parse,
11628                                 TRUE); /* means recognize comments */
11629             switch (*RExC_parse) {
11630                 default:
11631                     break;
11632                 case '\\':
11633                     /* Skip the next byte (which could cause us to end up in
11634                      * the middle of a UTF-8 character, but since none of those
11635                      * are confusable with anything we currently handle in this
11636                      * switch (invariants all), it's safe.  We'll just hit the
11637                      * default: case next time and keep on incrementing until
11638                      * we find one of the invariants we do handle. */
11639                     RExC_parse++;
11640                     break;
11641                 case '[':
11642                 {
11643                     /* If this looks like it is a [:posix:] class, leave the
11644                      * parse pointer at the '[' to fool regclass() into
11645                      * thinking it is part of a '[[:posix:]]'.  That function
11646                      * will use strict checking to force a syntax error if it
11647                      * doesn't work out to a legitimate class */
11648                     bool is_posix_class
11649                                     = could_it_be_a_POSIX_class(pRExC_state);
11650                     if (! is_posix_class) {
11651                         RExC_parse++;
11652                     }
11653
11654                     /* regclass() can only return RESTART_UTF8 if multi-char
11655                        folds are allowed.  */
11656                     if (!regclass(pRExC_state, flagp,depth+1,
11657                                   is_posix_class, /* parse the whole char
11658                                                      class only if not a
11659                                                      posix class */
11660                                   FALSE, /* don't allow multi-char folds */
11661                                   TRUE, /* silence non-portable warnings. */
11662                                   &current))
11663                         FAIL2("panic: regclass returned NULL to handle_sets, flags=%#X",
11664                               *flagp);
11665
11666                     /* function call leaves parse pointing to the ']', except
11667                      * if we faked it */
11668                     if (is_posix_class) {
11669                         RExC_parse--;
11670                     }
11671
11672                     SvREFCNT_dec(current);   /* In case it returned something */
11673                     break;
11674                 }
11675
11676                 case ']':
11677                     RExC_parse++;
11678                     if (RExC_parse < RExC_end
11679                         && *RExC_parse == ')')
11680                     {
11681                         node = reganode(pRExC_state, ANYOF, 0);
11682                         RExC_size += ANYOF_SKIP;
11683                         nextchar(pRExC_state);
11684                         Set_Node_Length(node,
11685                                 RExC_parse - oregcomp_parse + 1); /* MJD */
11686                         return node;
11687                     }
11688                     goto no_close;
11689             }
11690             RExC_parse++;
11691         }
11692
11693         no_close:
11694         FAIL("Syntax error in (?[...])");
11695     }
11696
11697     /* Pass 2 only after this.  Everything in this construct is a
11698      * metacharacter.  Operands begin with either a '\' (for an escape
11699      * sequence), or a '[' for a bracketed character class.  Any other
11700      * character should be an operator, or parenthesis for grouping.  Both
11701      * types of operands are handled by calling regclass() to parse them.  It
11702      * is called with a parameter to indicate to return the computed inversion
11703      * list.  The parsing here is implemented via a stack.  Each entry on the
11704      * stack is a single character representing one of the operators, or the
11705      * '('; or else a pointer to an operand inversion list. */
11706
11707 #define IS_OPERAND(a)  (! SvIOK(a))
11708
11709     /* The stack starts empty.  It is a syntax error if the first thing parsed
11710      * is a binary operator; everything else is pushed on the stack.  When an
11711      * operand is parsed, the top of the stack is examined.  If it is a binary
11712      * operator, the item before it should be an operand, and both are replaced
11713      * by the result of doing that operation on the new operand and the one on
11714      * the stack.   Thus a sequence of binary operands is reduced to a single
11715      * one before the next one is parsed.
11716      *
11717      * A unary operator may immediately follow a binary in the input, for
11718      * example
11719      *      [a] + ! [b]
11720      * When an operand is parsed and the top of the stack is a unary operator,
11721      * the operation is performed, and then the stack is rechecked to see if
11722      * this new operand is part of a binary operation; if so, it is handled as
11723      * above.
11724      *
11725      * A '(' is simply pushed on the stack; it is valid only if the stack is
11726      * empty, or the top element of the stack is an operator or another '('
11727      * (for which the parenthesized expression will become an operand).  By the
11728      * time the corresponding ')' is parsed everything in between should have
11729      * been parsed and evaluated to a single operand (or else is a syntax
11730      * error), and is handled as a regular operand */
11731
11732     sv_2mortal((SV *)(stack = newAV()));
11733
11734     while (RExC_parse < RExC_end) {
11735         I32 top_index = av_tindex(stack);
11736         SV** top_ptr;
11737         SV* current = NULL;
11738
11739         /* Skip white space */
11740         RExC_parse = regpatws(pRExC_state, RExC_parse,
11741                                 TRUE); /* means recognize comments */
11742         if (RExC_parse >= RExC_end) {
11743             Perl_croak(aTHX_ "panic: Read past end of '(?[ ])'");
11744         }
11745         if ((curchar = UCHARAT(RExC_parse)) == ']') {
11746             break;
11747         }
11748
11749         switch (curchar) {
11750
11751             case '?':
11752                 if (av_tindex(stack) >= 0   /* This makes sure that we can
11753                                                safely subtract 1 from
11754                                                RExC_parse in the next clause.
11755                                                If we have something on the
11756                                                stack, we have parsed something
11757                                              */
11758                     && UCHARAT(RExC_parse - 1) == '('
11759                     && RExC_parse < RExC_end)
11760                 {
11761                     /* If is a '(?', could be an embedded '(?flags:(?[...])'.
11762                      * This happens when we have some thing like
11763                      *
11764                      *   my $thai_or_lao = qr/(?[ \p{Thai} + \p{Lao} ])/;
11765                      *   ...
11766                      *   qr/(?[ \p{Digit} & $thai_or_lao ])/;
11767                      *
11768                      * Here we would be handling the interpolated
11769                      * '$thai_or_lao'.  We handle this by a recursive call to
11770                      * ourselves which returns the inversion list the
11771                      * interpolated expression evaluates to.  We use the flags
11772                      * from the interpolated pattern. */
11773                     U32 save_flags = RExC_flags;
11774                     const char * const save_parse = ++RExC_parse;
11775
11776                     parse_lparen_question_flags(pRExC_state);
11777
11778                     if (RExC_parse == save_parse  /* Makes sure there was at
11779                                                      least one flag (or this
11780                                                      embedding wasn't compiled)
11781                                                    */
11782                         || RExC_parse >= RExC_end - 4
11783                         || UCHARAT(RExC_parse) != ':'
11784                         || UCHARAT(++RExC_parse) != '('
11785                         || UCHARAT(++RExC_parse) != '?'
11786                         || UCHARAT(++RExC_parse) != '[')
11787                     {
11788
11789                         /* In combination with the above, this moves the
11790                          * pointer to the point just after the first erroneous
11791                          * character (or if there are no flags, to where they
11792                          * should have been) */
11793                         if (RExC_parse >= RExC_end - 4) {
11794                             RExC_parse = RExC_end;
11795                         }
11796                         else if (RExC_parse != save_parse) {
11797                             RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
11798                         }
11799                         vFAIL("Expecting '(?flags:(?[...'");
11800                     }
11801                     RExC_parse++;
11802                     (void) handle_regex_sets(pRExC_state, &current, flagp,
11803                                                     depth+1, oregcomp_parse);
11804
11805                     /* Here, 'current' contains the embedded expression's
11806                      * inversion list, and RExC_parse points to the trailing
11807                      * ']'; the next character should be the ')' which will be
11808                      * paired with the '(' that has been put on the stack, so
11809                      * the whole embedded expression reduces to '(operand)' */
11810                     RExC_parse++;
11811
11812                     RExC_flags = save_flags;
11813                     goto handle_operand;
11814                 }
11815                 /* FALL THROUGH */
11816
11817             default:
11818                 RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
11819                 vFAIL("Unexpected character");
11820
11821             case '\\':
11822                 /* regclass() can only return RESTART_UTF8 if multi-char
11823                    folds are allowed.  */
11824                 if (!regclass(pRExC_state, flagp,depth+1,
11825                               TRUE, /* means parse just the next thing */
11826                               FALSE, /* don't allow multi-char folds */
11827                               FALSE, /* don't silence non-portable warnings.  */
11828                               &current))
11829                     FAIL2("panic: regclass returned NULL to handle_sets, flags=%#X",
11830                           *flagp);
11831                 /* regclass() will return with parsing just the \ sequence,
11832                  * leaving the parse pointer at the next thing to parse */
11833                 RExC_parse--;
11834                 goto handle_operand;
11835
11836             case '[':   /* Is a bracketed character class */
11837             {
11838                 bool is_posix_class = could_it_be_a_POSIX_class(pRExC_state);
11839
11840                 if (! is_posix_class) {
11841                     RExC_parse++;
11842                 }
11843
11844                 /* regclass() can only return RESTART_UTF8 if multi-char
11845                    folds are allowed.  */
11846                 if(!regclass(pRExC_state, flagp,depth+1,
11847                              is_posix_class, /* parse the whole char class
11848                                                 only if not a posix class */
11849                              FALSE, /* don't allow multi-char folds */
11850                              FALSE, /* don't silence non-portable warnings.  */
11851                              &current))
11852                     FAIL2("panic: regclass returned NULL to handle_sets, flags=%#X",
11853                           *flagp);
11854                 /* function call leaves parse pointing to the ']', except if we
11855                  * faked it */
11856                 if (is_posix_class) {
11857                     RExC_parse--;
11858                 }
11859
11860                 goto handle_operand;
11861             }
11862
11863             case '&':
11864             case '|':
11865             case '+':
11866             case '-':
11867             case '^':
11868                 if (top_index < 0
11869                     || ( ! (top_ptr = av_fetch(stack, top_index, FALSE)))
11870                     || ! IS_OPERAND(*top_ptr))
11871                 {
11872                     RExC_parse++;
11873                     vFAIL2("Unexpected binary operator '%c' with no preceding operand", curchar);
11874                 }
11875                 av_push(stack, newSVuv(curchar));
11876                 break;
11877
11878             case '!':
11879                 av_push(stack, newSVuv(curchar));
11880                 break;
11881
11882             case '(':
11883                 if (top_index >= 0) {
11884                     top_ptr = av_fetch(stack, top_index, FALSE);
11885                     assert(top_ptr);
11886                     if (IS_OPERAND(*top_ptr)) {
11887                         RExC_parse++;
11888                         vFAIL("Unexpected '(' with no preceding operator");
11889                     }
11890                 }
11891                 av_push(stack, newSVuv(curchar));
11892                 break;
11893
11894             case ')':
11895             {
11896                 SV* lparen;
11897                 if (top_index < 1
11898                     || ! (current = av_pop(stack))
11899                     || ! IS_OPERAND(current)
11900                     || ! (lparen = av_pop(stack))
11901                     || IS_OPERAND(lparen)
11902                     || SvUV(lparen) != '(')
11903                 {
11904                     SvREFCNT_dec(current);
11905                     RExC_parse++;
11906                     vFAIL("Unexpected ')'");
11907                 }
11908                 top_index -= 2;
11909                 SvREFCNT_dec_NN(lparen);
11910
11911                 /* FALL THROUGH */
11912             }
11913
11914               handle_operand:
11915
11916                 /* Here, we have an operand to process, in 'current' */
11917
11918                 if (top_index < 0) {    /* Just push if stack is empty */
11919                     av_push(stack, current);
11920                 }
11921                 else {
11922                     SV* top = av_pop(stack);
11923                     SV *prev = NULL;
11924                     char current_operator;
11925
11926                     if (IS_OPERAND(top)) {
11927                         SvREFCNT_dec_NN(top);
11928                         SvREFCNT_dec_NN(current);
11929                         vFAIL("Operand with no preceding operator");
11930                     }
11931                     current_operator = (char) SvUV(top);
11932                     switch (current_operator) {
11933                         case '(':   /* Push the '(' back on followed by the new
11934                                        operand */
11935                             av_push(stack, top);
11936                             av_push(stack, current);
11937                             SvREFCNT_inc(top);  /* Counters the '_dec' done
11938                                                    just after the 'break', so
11939                                                    it doesn't get wrongly freed
11940                                                  */
11941                             break;
11942
11943                         case '!':
11944                             _invlist_invert(current);
11945
11946                             /* Unlike binary operators, the top of the stack,
11947                              * now that this unary one has been popped off, may
11948                              * legally be an operator, and we now have operand
11949                              * for it. */
11950                             top_index--;
11951                             SvREFCNT_dec_NN(top);
11952                             goto handle_operand;
11953
11954                         case '&':
11955                             prev = av_pop(stack);
11956                             _invlist_intersection(prev,
11957                                                    current,
11958                                                    &current);
11959                             av_push(stack, current);
11960                             break;
11961
11962                         case '|':
11963                         case '+':
11964                             prev = av_pop(stack);
11965                             _invlist_union(prev, current, &current);
11966                             av_push(stack, current);
11967                             break;
11968
11969                         case '-':
11970                             prev = av_pop(stack);;
11971                             _invlist_subtract(prev, current, &current);
11972                             av_push(stack, current);
11973                             break;
11974
11975                         case '^':   /* The union minus the intersection */
11976                         {
11977                             SV* i = NULL;
11978                             SV* u = NULL;
11979                             SV* element;
11980
11981                             prev = av_pop(stack);
11982                             _invlist_union(prev, current, &u);
11983                             _invlist_intersection(prev, current, &i);
11984                             /* _invlist_subtract will overwrite current
11985                                 without freeing what it already contains */
11986                             element = current;
11987                             _invlist_subtract(u, i, &current);
11988                             av_push(stack, current);
11989                             SvREFCNT_dec_NN(i);
11990                             SvREFCNT_dec_NN(u);
11991                             SvREFCNT_dec_NN(element);
11992                             break;
11993                         }
11994
11995                         default:
11996                             Perl_croak(aTHX_ "panic: Unexpected item on '(?[ ])' stack");
11997                 }
11998                 SvREFCNT_dec_NN(top);
11999                 SvREFCNT_dec(prev);
12000             }
12001         }
12002
12003         RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
12004     }
12005
12006     if (av_tindex(stack) < 0   /* Was empty */
12007         || ((final = av_pop(stack)) == NULL)
12008         || ! IS_OPERAND(final)
12009         || av_tindex(stack) >= 0)  /* More left on stack */
12010     {
12011         vFAIL("Incomplete expression within '(?[ ])'");
12012     }
12013
12014     /* Here, 'final' is the resultant inversion list from evaluating the
12015      * expression.  Return it if so requested */
12016     if (return_invlist) {
12017         *return_invlist = final;
12018         return END;
12019     }
12020
12021     /* Otherwise generate a resultant node, based on 'final'.  regclass() is
12022      * expecting a string of ranges and individual code points */
12023     invlist_iterinit(final);
12024     result_string = newSVpvs("");
12025     while (invlist_iternext(final, &start, &end)) {
12026         if (start == end) {
12027             Perl_sv_catpvf(aTHX_ result_string, "\\x{%"UVXf"}", start);
12028         }
12029         else {
12030             Perl_sv_catpvf(aTHX_ result_string, "\\x{%"UVXf"}-\\x{%"UVXf"}",
12031                                                      start,          end);
12032         }
12033     }
12034
12035     save_parse = RExC_parse;
12036     RExC_parse = SvPV(result_string, len);
12037     save_end = RExC_end;
12038     RExC_end = RExC_parse + len;
12039
12040     /* We turn off folding around the call, as the class we have constructed
12041      * already has all folding taken into consideration, and we don't want
12042      * regclass() to add to that */
12043     RExC_flags &= ~RXf_PMf_FOLD;
12044     /* regclass() can only return RESTART_UTF8 if multi-char folds are allowed.
12045      */
12046     node = regclass(pRExC_state, flagp,depth+1,
12047                     FALSE, /* means parse the whole char class */
12048                     FALSE, /* don't allow multi-char folds */
12049                     TRUE, /* silence non-portable warnings.  The above may very
12050                              well have generated non-portable code points, but
12051                              they're valid on this machine */
12052                     NULL);
12053     if (!node)
12054         FAIL2("panic: regclass returned NULL to handle_sets, flags=%#"UVxf,
12055                     PTR2UV(flagp));
12056     if (save_fold) {
12057         RExC_flags |= RXf_PMf_FOLD;
12058     }
12059     RExC_parse = save_parse + 1;
12060     RExC_end = save_end;
12061     SvREFCNT_dec_NN(final);
12062     SvREFCNT_dec_NN(result_string);
12063
12064     nextchar(pRExC_state);
12065     Set_Node_Length(node, RExC_parse - oregcomp_parse + 1); /* MJD */
12066     return node;
12067 }
12068 #undef IS_OPERAND
12069
12070 /* The names of properties whose definitions are not known at compile time are
12071  * stored in this SV, after a constant heading.  So if the length has been
12072  * changed since initialization, then there is a run-time definition. */
12073 #define HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION (SvCUR(listsv) != initial_listsv_len)
12074
12075 STATIC regnode *
12076 S_regclass(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth,
12077                  const bool stop_at_1,  /* Just parse the next thing, don't
12078                                            look for a full character class */
12079                  bool allow_multi_folds,
12080                  const bool silence_non_portable,   /* Don't output warnings
12081                                                        about too large
12082                                                        characters */
12083                  SV** ret_invlist)  /* Return an inversion list, not a node */
12084 {
12085     /* parse a bracketed class specification.  Most of these will produce an
12086      * ANYOF node; but something like [a] will produce an EXACT node; [aA], an
12087      * EXACTFish node; [[:ascii:]], a POSIXA node; etc.  It is more complex
12088      * under /i with multi-character folds: it will be rewritten following the
12089      * paradigm of this example, where the <multi-fold>s are characters which
12090      * fold to multiple character sequences:
12091      *      /[abc\x{multi-fold1}def\x{multi-fold2}ghi]/i
12092      * gets effectively rewritten as:
12093      *      /(?:\x{multi-fold1}|\x{multi-fold2}|[abcdefghi]/i
12094      * reg() gets called (recursively) on the rewritten version, and this
12095      * function will return what it constructs.  (Actually the <multi-fold>s
12096      * aren't physically removed from the [abcdefghi], it's just that they are
12097      * ignored in the recursion by means of a flag:
12098      * <RExC_in_multi_char_class>.)
12099      *
12100      * ANYOF nodes contain a bit map for the first 256 characters, with the
12101      * corresponding bit set if that character is in the list.  For characters
12102      * above 255, a range list or swash is used.  There are extra bits for \w,
12103      * etc. in locale ANYOFs, as what these match is not determinable at
12104      * compile time
12105      *
12106      * Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan needs
12107      * to be restarted.  This can only happen if ret_invlist is non-NULL.
12108      */
12109
12110     dVAR;
12111     UV prevvalue = OOB_UNICODE, save_prevvalue = OOB_UNICODE;
12112     IV range = 0;
12113     UV value = OOB_UNICODE, save_value = OOB_UNICODE;
12114     regnode *ret;
12115     STRLEN numlen;
12116     IV namedclass = OOB_NAMEDCLASS;
12117     char *rangebegin = NULL;
12118     bool need_class = 0;
12119     SV *listsv = NULL;
12120     STRLEN initial_listsv_len = 0; /* Kind of a kludge to see if it is more
12121                                       than just initialized.  */
12122     SV* properties = NULL;    /* Code points that match \p{} \P{} */
12123     SV* posixes = NULL;     /* Code points that match classes like, [:word:],
12124                                extended beyond the Latin1 range */
12125     UV element_count = 0;   /* Number of distinct elements in the class.
12126                                Optimizations may be possible if this is tiny */
12127     AV * multi_char_matches = NULL; /* Code points that fold to more than one
12128                                        character; used under /i */
12129     UV n;
12130     char * stop_ptr = RExC_end;    /* where to stop parsing */
12131     const bool skip_white = cBOOL(ret_invlist); /* ignore unescaped white
12132                                                    space? */
12133     const bool strict = cBOOL(ret_invlist); /* Apply strict parsing rules? */
12134
12135     /* Unicode properties are stored in a swash; this holds the current one
12136      * being parsed.  If this swash is the only above-latin1 component of the
12137      * character class, an optimization is to pass it directly on to the
12138      * execution engine.  Otherwise, it is set to NULL to indicate that there
12139      * are other things in the class that have to be dealt with at execution
12140      * time */
12141     SV* swash = NULL;           /* Code points that match \p{} \P{} */
12142
12143     /* Set if a component of this character class is user-defined; just passed
12144      * on to the engine */
12145     bool has_user_defined_property = FALSE;
12146
12147     /* inversion list of code points this node matches only when the target
12148      * string is in UTF-8.  (Because is under /d) */
12149     SV* depends_list = NULL;
12150
12151     /* inversion list of code points this node matches.  For much of the
12152      * function, it includes only those that match regardless of the utf8ness
12153      * of the target string */
12154     SV* cp_list = NULL;
12155
12156 #ifdef EBCDIC
12157     /* In a range, counts how many 0-2 of the ends of it came from literals,
12158      * not escapes.  Thus we can tell if 'A' was input vs \x{C1} */
12159     UV literal_endpoint = 0;
12160 #endif
12161     bool invert = FALSE;    /* Is this class to be complemented */
12162
12163     /* Is there any thing like \W or [:^digit:] that matches above the legal
12164      * Unicode range? */
12165     bool runtime_posix_matches_above_Unicode = FALSE;
12166
12167     regnode * const orig_emit = RExC_emit; /* Save the original RExC_emit in
12168         case we need to change the emitted regop to an EXACT. */
12169     const char * orig_parse = RExC_parse;
12170     const I32 orig_size = RExC_size;
12171     GET_RE_DEBUG_FLAGS_DECL;
12172
12173     PERL_ARGS_ASSERT_REGCLASS;
12174 #ifndef DEBUGGING
12175     PERL_UNUSED_ARG(depth);
12176 #endif
12177
12178     DEBUG_PARSE("clas");
12179
12180     /* Assume we are going to generate an ANYOF node. */
12181     ret = reganode(pRExC_state, ANYOF, 0);
12182
12183     if (SIZE_ONLY) {
12184         RExC_size += ANYOF_SKIP;
12185         listsv = &PL_sv_undef; /* For code scanners: listsv always non-NULL. */
12186     }
12187     else {
12188         ANYOF_FLAGS(ret) = 0;
12189
12190         RExC_emit += ANYOF_SKIP;
12191         if (LOC) {
12192             ANYOF_FLAGS(ret) |= ANYOF_LOCALE;
12193         }
12194         listsv = newSVpvs_flags("# comment\n", SVs_TEMP);
12195         initial_listsv_len = SvCUR(listsv);
12196         SvTEMP_off(listsv); /* Grr, TEMPs and mortals are conflated.  */
12197     }
12198
12199     if (skip_white) {
12200         RExC_parse = regpatws(pRExC_state, RExC_parse,
12201                               FALSE /* means don't recognize comments */);
12202     }
12203
12204     if (UCHARAT(RExC_parse) == '^') {   /* Complement of range. */
12205         RExC_parse++;
12206         invert = TRUE;
12207         allow_multi_folds = FALSE;
12208         RExC_naughty++;
12209         if (skip_white) {
12210             RExC_parse = regpatws(pRExC_state, RExC_parse,
12211                                   FALSE /* means don't recognize comments */);
12212         }
12213     }
12214
12215     /* Check that they didn't say [:posix:] instead of [[:posix:]] */
12216     if (!SIZE_ONLY && RExC_parse < RExC_end && POSIXCC(UCHARAT(RExC_parse))) {
12217         const char *s = RExC_parse;
12218         const char  c = *s++;
12219
12220         while (isWORDCHAR(*s))
12221             s++;
12222         if (*s && c == *s && s[1] == ']') {
12223             SAVEFREESV(RExC_rx_sv);
12224             ckWARN3reg(s+2,
12225                        "POSIX syntax [%c %c] belongs inside character classes",
12226                        c, c);
12227             (void)ReREFCNT_inc(RExC_rx_sv);
12228         }
12229     }
12230
12231     /* If the caller wants us to just parse a single element, accomplish this
12232      * by faking the loop ending condition */
12233     if (stop_at_1 && RExC_end > RExC_parse) {
12234         stop_ptr = RExC_parse + 1;
12235     }
12236
12237     /* allow 1st char to be ']' (allowing it to be '-' is dealt with later) */
12238     if (UCHARAT(RExC_parse) == ']')
12239         goto charclassloop;
12240
12241 parseit:
12242     while (1) {
12243         if  (RExC_parse >= stop_ptr) {
12244             break;
12245         }
12246
12247         if (skip_white) {
12248             RExC_parse = regpatws(pRExC_state, RExC_parse,
12249                                   FALSE /* means don't recognize comments */);
12250         }
12251
12252         if  (UCHARAT(RExC_parse) == ']') {
12253             break;
12254         }
12255
12256     charclassloop:
12257
12258         namedclass = OOB_NAMEDCLASS; /* initialize as illegal */
12259         save_value = value;
12260         save_prevvalue = prevvalue;
12261
12262         if (!range) {
12263             rangebegin = RExC_parse;
12264             element_count++;
12265         }
12266         if (UTF) {
12267             value = utf8n_to_uvchr((U8*)RExC_parse,
12268                                    RExC_end - RExC_parse,
12269                                    &numlen, UTF8_ALLOW_DEFAULT);
12270             RExC_parse += numlen;
12271         }
12272         else
12273             value = UCHARAT(RExC_parse++);
12274
12275         if (value == '['
12276             && RExC_parse < RExC_end
12277             && POSIXCC(UCHARAT(RExC_parse)))
12278         {
12279             namedclass = regpposixcc(pRExC_state, value, strict);
12280         }
12281         else if (value == '\\') {
12282             if (UTF) {
12283                 value = utf8n_to_uvchr((U8*)RExC_parse,
12284                                    RExC_end - RExC_parse,
12285                                    &numlen, UTF8_ALLOW_DEFAULT);
12286                 RExC_parse += numlen;
12287             }
12288             else
12289                 value = UCHARAT(RExC_parse++);
12290
12291             /* Some compilers cannot handle switching on 64-bit integer
12292              * values, therefore value cannot be an UV.  Yes, this will
12293              * be a problem later if we want switch on Unicode.
12294              * A similar issue a little bit later when switching on
12295              * namedclass. --jhi */
12296
12297             /* If the \ is escaping white space when white space is being
12298              * skipped, it means that that white space is wanted literally, and
12299              * is already in 'value'.  Otherwise, need to translate the escape
12300              * into what it signifies. */
12301             if (! skip_white || ! is_PATWS_cp(value)) switch ((I32)value) {
12302
12303             case 'w':   namedclass = ANYOF_WORDCHAR;    break;
12304             case 'W':   namedclass = ANYOF_NWORDCHAR;   break;
12305             case 's':   namedclass = ANYOF_SPACE;       break;
12306             case 'S':   namedclass = ANYOF_NSPACE;      break;
12307             case 'd':   namedclass = ANYOF_DIGIT;       break;
12308             case 'D':   namedclass = ANYOF_NDIGIT;      break;
12309             case 'v':   namedclass = ANYOF_VERTWS;      break;
12310             case 'V':   namedclass = ANYOF_NVERTWS;     break;
12311             case 'h':   namedclass = ANYOF_HORIZWS;     break;
12312             case 'H':   namedclass = ANYOF_NHORIZWS;    break;
12313             case 'N':  /* Handle \N{NAME} in class */
12314                 {
12315                     /* We only pay attention to the first char of 
12316                     multichar strings being returned. I kinda wonder
12317                     if this makes sense as it does change the behaviour
12318                     from earlier versions, OTOH that behaviour was broken
12319                     as well. */
12320                     if (! grok_bslash_N(pRExC_state, NULL, &value, flagp, depth,
12321                                       TRUE, /* => charclass */
12322                                       strict))
12323                     {
12324                         if (*flagp & RESTART_UTF8)
12325                             FAIL("panic: grok_bslash_N set RESTART_UTF8");
12326                         goto parseit;
12327                     }
12328                 }
12329                 break;
12330             case 'p':
12331             case 'P':
12332                 {
12333                 char *e;
12334
12335                 /* We will handle any undefined properties ourselves */
12336                 U8 swash_init_flags = _CORE_SWASH_INIT_RETURN_IF_UNDEF;
12337
12338                 if (RExC_parse >= RExC_end)
12339                     vFAIL2("Empty \\%c{}", (U8)value);
12340                 if (*RExC_parse == '{') {
12341                     const U8 c = (U8)value;
12342                     e = strchr(RExC_parse++, '}');
12343                     if (!e)
12344                         vFAIL2("Missing right brace on \\%c{}", c);
12345                     while (isSPACE(UCHARAT(RExC_parse)))
12346                         RExC_parse++;
12347                     if (e == RExC_parse)
12348                         vFAIL2("Empty \\%c{}", c);
12349                     n = e - RExC_parse;
12350                     while (isSPACE(UCHARAT(RExC_parse + n - 1)))
12351                         n--;
12352                 }
12353                 else {
12354                     e = RExC_parse;
12355                     n = 1;
12356                 }
12357                 if (!SIZE_ONLY) {
12358                     SV* invlist;
12359                     char* name;
12360
12361                     if (UCHARAT(RExC_parse) == '^') {
12362                          RExC_parse++;
12363                          n--;
12364                          /* toggle.  (The rhs xor gets the single bit that
12365                           * differs between P and p; the other xor inverts just
12366                           * that bit) */
12367                          value ^= 'P' ^ 'p';
12368
12369                          while (isSPACE(UCHARAT(RExC_parse))) {
12370                               RExC_parse++;
12371                               n--;
12372                          }
12373                     }
12374                     /* Try to get the definition of the property into
12375                      * <invlist>.  If /i is in effect, the effective property
12376                      * will have its name be <__NAME_i>.  The design is
12377                      * discussed in commit
12378                      * 2f833f5208e26b208886e51e09e2c072b5eabb46 */
12379                     Newx(name, n + sizeof("_i__\n"), char);
12380
12381                     sprintf(name, "%s%.*s%s\n",
12382                                     (FOLD) ? "__" : "",
12383                                     (int)n,
12384                                     RExC_parse,
12385                                     (FOLD) ? "_i" : ""
12386                     );
12387
12388                     /* Look up the property name, and get its swash and
12389                      * inversion list, if the property is found  */
12390                     if (swash) {
12391                         SvREFCNT_dec_NN(swash);
12392                     }
12393                     swash = _core_swash_init("utf8", name, &PL_sv_undef,
12394                                              1, /* binary */
12395                                              0, /* not tr/// */
12396                                              NULL, /* No inversion list */
12397                                              &swash_init_flags
12398                                             );
12399                     if (! swash || ! (invlist = _get_swash_invlist(swash))) {
12400                         if (swash) {
12401                             SvREFCNT_dec_NN(swash);
12402                             swash = NULL;
12403                         }
12404
12405                         /* Here didn't find it.  It could be a user-defined
12406                          * property that will be available at run-time.  If we
12407                          * accept only compile-time properties, is an error;
12408                          * otherwise add it to the list for run-time look up */
12409                         if (ret_invlist) {
12410                             RExC_parse = e + 1;
12411                             vFAIL3("Property '%.*s' is unknown", (int) n, name);
12412                         }
12413                         Perl_sv_catpvf(aTHX_ listsv, "%cutf8::%s\n",
12414                                         (value == 'p' ? '+' : '!'),
12415                                         name);
12416                         has_user_defined_property = TRUE;
12417
12418                         /* We don't know yet, so have to assume that the
12419                          * property could match something in the Latin1 range,
12420                          * hence something that isn't utf8.  Note that this
12421                          * would cause things in <depends_list> to match
12422                          * inappropriately, except that any \p{}, including
12423                          * this one forces Unicode semantics, which means there
12424                          * is <no depends_list> */
12425                         ANYOF_FLAGS(ret) |= ANYOF_NONBITMAP_NON_UTF8;
12426                     }
12427                     else {
12428
12429                         /* Here, did get the swash and its inversion list.  If
12430                          * the swash is from a user-defined property, then this
12431                          * whole character class should be regarded as such */
12432                         has_user_defined_property =
12433                                     (swash_init_flags
12434                                      & _CORE_SWASH_INIT_USER_DEFINED_PROPERTY);
12435
12436                         /* Invert if asking for the complement */
12437                         if (value == 'P') {
12438                             _invlist_union_complement_2nd(properties,
12439                                                           invlist,
12440                                                           &properties);
12441
12442                             /* The swash can't be used as-is, because we've
12443                              * inverted things; delay removing it to here after
12444                              * have copied its invlist above */
12445                             SvREFCNT_dec_NN(swash);
12446                             swash = NULL;
12447                         }
12448                         else {
12449                             _invlist_union(properties, invlist, &properties);
12450                         }
12451                     }
12452                     Safefree(name);
12453                 }
12454                 RExC_parse = e + 1;
12455                 namedclass = ANYOF_UNIPROP;  /* no official name, but it's
12456                                                 named */
12457
12458                 /* \p means they want Unicode semantics */
12459                 RExC_uni_semantics = 1;
12460                 }
12461                 break;
12462             case 'n':   value = '\n';                   break;
12463             case 'r':   value = '\r';                   break;
12464             case 't':   value = '\t';                   break;
12465             case 'f':   value = '\f';                   break;
12466             case 'b':   value = '\b';                   break;
12467             case 'e':   value = ASCII_TO_NATIVE('\033');break;
12468             case 'a':   value = ASCII_TO_NATIVE('\007');break;
12469             case 'o':
12470                 RExC_parse--;   /* function expects to be pointed at the 'o' */
12471                 {
12472                     const char* error_msg;
12473                     bool valid = grok_bslash_o(&RExC_parse,
12474                                                &value,
12475                                                &error_msg,
12476                                                SIZE_ONLY,   /* warnings in pass
12477                                                                1 only */
12478                                                strict,
12479                                                silence_non_portable,
12480                                                UTF);
12481                     if (! valid) {
12482                         vFAIL(error_msg);
12483                     }
12484                 }
12485                 if (PL_encoding && value < 0x100) {
12486                     goto recode_encoding;
12487                 }
12488                 break;
12489             case 'x':
12490                 RExC_parse--;   /* function expects to be pointed at the 'x' */
12491                 {
12492                     const char* error_msg;
12493                     bool valid = grok_bslash_x(&RExC_parse,
12494                                                &value,
12495                                                &error_msg,
12496                                                TRUE, /* Output warnings */
12497                                                strict,
12498                                                silence_non_portable,
12499                                                UTF);
12500                     if (! valid) {
12501                         vFAIL(error_msg);
12502                     }
12503                 }
12504                 if (PL_encoding && value < 0x100)
12505                     goto recode_encoding;
12506                 break;
12507             case 'c':
12508                 value = grok_bslash_c(*RExC_parse++, UTF, SIZE_ONLY);
12509                 break;
12510             case '0': case '1': case '2': case '3': case '4':
12511             case '5': case '6': case '7':
12512                 {
12513                     /* Take 1-3 octal digits */
12514                     I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
12515                     numlen = (strict) ? 4 : 3;
12516                     value = grok_oct(--RExC_parse, &numlen, &flags, NULL);
12517                     RExC_parse += numlen;
12518                     if (numlen != 3) {
12519                         if (strict) {
12520                             RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
12521                             vFAIL("Need exactly 3 octal digits");
12522                         }
12523                         else if (! SIZE_ONLY /* like \08, \178 */
12524                                  && numlen < 3
12525                                  && RExC_parse < RExC_end
12526                                  && isDIGIT(*RExC_parse)
12527                                  && ckWARN(WARN_REGEXP))
12528                         {
12529                             SAVEFREESV(RExC_rx_sv);
12530                             reg_warn_non_literal_string(
12531                                  RExC_parse + 1,
12532                                  form_short_octal_warning(RExC_parse, numlen));
12533                             (void)ReREFCNT_inc(RExC_rx_sv);
12534                         }
12535                     }
12536                     if (PL_encoding && value < 0x100)
12537                         goto recode_encoding;
12538                     break;
12539                 }
12540             recode_encoding:
12541                 if (! RExC_override_recoding) {
12542                     SV* enc = PL_encoding;
12543                     value = reg_recode((const char)(U8)value, &enc);
12544                     if (!enc) {
12545                         if (strict) {
12546                             vFAIL("Invalid escape in the specified encoding");
12547                         }
12548                         else if (SIZE_ONLY) {
12549                             ckWARNreg(RExC_parse,
12550                                   "Invalid escape in the specified encoding");
12551                         }
12552                     }
12553                     break;
12554                 }
12555             default:
12556                 /* Allow \_ to not give an error */
12557                 if (!SIZE_ONLY && isWORDCHAR(value) && value != '_') {
12558                     if (strict) {
12559                         vFAIL2("Unrecognized escape \\%c in character class",
12560                                (int)value);
12561                     }
12562                     else {
12563                         SAVEFREESV(RExC_rx_sv);
12564                         ckWARN2reg(RExC_parse,
12565                             "Unrecognized escape \\%c in character class passed through",
12566                             (int)value);
12567                         (void)ReREFCNT_inc(RExC_rx_sv);
12568                     }
12569                 }
12570                 break;
12571             }   /* End of switch on char following backslash */
12572         } /* end of handling backslash escape sequences */
12573 #ifdef EBCDIC
12574         else
12575             literal_endpoint++;
12576 #endif
12577
12578         /* Here, we have the current token in 'value' */
12579
12580         /* What matches in a locale is not known until runtime.  This includes
12581          * what the Posix classes (like \w, [:space:]) match.  Room must be
12582          * reserved (one time per class) to store such classes, either if Perl
12583          * is compiled so that locale nodes always should have this space, or
12584          * if there is such class info to be stored.  The space will contain a
12585          * bit for each named class that is to be matched against.  This isn't
12586          * needed for \p{} and pseudo-classes, as they are not affected by
12587          * locale, and hence are dealt with separately */
12588         if (LOC
12589             && ! need_class
12590             && (ANYOF_LOCALE == ANYOF_CLASS
12591                 || (namedclass > OOB_NAMEDCLASS && namedclass < ANYOF_MAX)))
12592         {
12593             need_class = 1;
12594             if (SIZE_ONLY) {
12595                 RExC_size += ANYOF_CLASS_SKIP - ANYOF_SKIP;
12596             }
12597             else {
12598                 RExC_emit += ANYOF_CLASS_SKIP - ANYOF_SKIP;
12599                 ANYOF_CLASS_ZERO(ret);
12600             }
12601             ANYOF_FLAGS(ret) |= ANYOF_CLASS;
12602         }
12603
12604         if (namedclass > OOB_NAMEDCLASS) { /* this is a named class \blah */
12605
12606             /* a bad range like a-\d, a-[:digit:].  The '-' is taken as a
12607              * literal, as is the character that began the false range, i.e.
12608              * the 'a' in the examples */
12609             if (range) {
12610                 if (!SIZE_ONLY) {
12611                     const int w = (RExC_parse >= rangebegin)
12612                                   ? RExC_parse - rangebegin
12613                                   : 0;
12614                     if (strict) {
12615                         vFAIL4("False [] range \"%*.*s\"", w, w, rangebegin);
12616                     }
12617                     else {
12618                         SAVEFREESV(RExC_rx_sv); /* in case of fatal warnings */
12619                         ckWARN4reg(RExC_parse,
12620                                 "False [] range \"%*.*s\"",
12621                                 w, w, rangebegin);
12622                         (void)ReREFCNT_inc(RExC_rx_sv);
12623                         cp_list = add_cp_to_invlist(cp_list, '-');
12624                         cp_list = add_cp_to_invlist(cp_list, prevvalue);
12625                     }
12626                 }
12627
12628                 range = 0; /* this was not a true range */
12629                 element_count += 2; /* So counts for three values */
12630             }
12631
12632             if (! SIZE_ONLY) {
12633                 U8 classnum = namedclass_to_classnum(namedclass);
12634                 if (namedclass >= ANYOF_MAX) {  /* If a special class */
12635                     if (namedclass != ANYOF_UNIPROP) { /* UNIPROP = \p and \P */
12636
12637                         /* Here, should be \h, \H, \v, or \V.  Neither /d nor
12638                          * /l make a difference in what these match.  There
12639                          * would be problems if these characters had folds
12640                          * other than themselves, as cp_list is subject to
12641                          * folding. */
12642                         if (classnum != _CC_VERTSPACE) {
12643                             assert(   namedclass == ANYOF_HORIZWS
12644                                    || namedclass == ANYOF_NHORIZWS);
12645
12646                             /* It turns out that \h is just a synonym for
12647                              * XPosixBlank */
12648                             classnum = _CC_BLANK;
12649                         }
12650
12651                         _invlist_union_maybe_complement_2nd(
12652                                 cp_list,
12653                                 PL_XPosix_ptrs[classnum],
12654                                 cBOOL(namedclass % 2), /* Complement if odd
12655                                                           (NHORIZWS, NVERTWS)
12656                                                         */
12657                                 &cp_list);
12658                     }
12659                 }
12660                 else if (classnum == _CC_ASCII) {
12661 #ifdef HAS_ISASCII
12662                     if (LOC) {
12663                         ANYOF_CLASS_SET(ret, namedclass);
12664                     }
12665                     else
12666 #endif  /* Not isascii(); just use the hard-coded definition for it */
12667                         _invlist_union_maybe_complement_2nd(
12668                                 posixes,
12669                                 PL_ASCII,
12670                                 cBOOL(namedclass % 2), /* Complement if odd
12671                                                           (NASCII) */
12672                                 &posixes);
12673                 }
12674                 else {  /* Garden variety class */
12675
12676                     /* The ascii range inversion list */
12677                     SV* ascii_source = PL_Posix_ptrs[classnum];
12678
12679                     /* The full Latin1 range inversion list */
12680                     SV* l1_source = PL_L1Posix_ptrs[classnum];
12681
12682                     /* This code is structured into two major clauses.  The
12683                      * first is for classes whose complete definitions may not
12684                      * already be known.  It not, the Latin1 definition
12685                      * (guaranteed to already known) is used plus code is
12686                      * generated to load the rest at run-time (only if needed).
12687                      * If the complete definition is known, it drops down to
12688                      * the second clause, where the complete definition is
12689                      * known */
12690
12691                     if (classnum < _FIRST_NON_SWASH_CC) {
12692
12693                         /* Here, the class has a swash, which may or not
12694                          * already be loaded */
12695
12696                         /* The name of the property to use to match the full
12697                          * eXtended Unicode range swash for this character
12698                          * class */
12699                         const char *Xname = swash_property_names[classnum];
12700
12701                         /* If returning the inversion list, we can't defer
12702                          * getting this until runtime */
12703                         if (ret_invlist && !  PL_utf8_swash_ptrs[classnum]) {
12704                             PL_utf8_swash_ptrs[classnum] =
12705                                 _core_swash_init("utf8", Xname, &PL_sv_undef,
12706                                              1, /* binary */
12707                                              0, /* not tr/// */
12708                                              NULL, /* No inversion list */
12709                                              NULL  /* No flags */
12710                                             );
12711                             assert(PL_utf8_swash_ptrs[classnum]);
12712                         }
12713                         if ( !  PL_utf8_swash_ptrs[classnum]) {
12714                             if (namedclass % 2 == 0) { /* A non-complemented
12715                                                           class */
12716                                 /* If not /a matching, there are code points we
12717                                  * don't know at compile time.  Arrange for the
12718                                  * unknown matches to be loaded at run-time, if
12719                                  * needed */
12720                                 if (! AT_LEAST_ASCII_RESTRICTED) {
12721                                     Perl_sv_catpvf(aTHX_ listsv, "+utf8::%s\n",
12722                                                                  Xname);
12723                                 }
12724                                 if (LOC) {  /* Under locale, set run-time
12725                                                lookup */
12726                                     ANYOF_CLASS_SET(ret, namedclass);
12727                                 }
12728                                 else {
12729                                     /* Add the current class's code points to
12730                                      * the running total */
12731                                     _invlist_union(posixes,
12732                                                    (AT_LEAST_ASCII_RESTRICTED)
12733                                                         ? ascii_source
12734                                                         : l1_source,
12735                                                    &posixes);
12736                                 }
12737                             }
12738                             else {  /* A complemented class */
12739                                 if (AT_LEAST_ASCII_RESTRICTED) {
12740                                     /* Under /a should match everything above
12741                                      * ASCII, plus the complement of the set's
12742                                      * ASCII matches */
12743                                     _invlist_union_complement_2nd(posixes,
12744                                                                   ascii_source,
12745                                                                   &posixes);
12746                                 }
12747                                 else {
12748                                     /* Arrange for the unknown matches to be
12749                                      * loaded at run-time, if needed */
12750                                     Perl_sv_catpvf(aTHX_ listsv, "!utf8::%s\n",
12751                                                                  Xname);
12752                                     runtime_posix_matches_above_Unicode = TRUE;
12753                                     if (LOC) {
12754                                         ANYOF_CLASS_SET(ret, namedclass);
12755                                     }
12756                                     else {
12757
12758                                         /* We want to match everything in
12759                                          * Latin1, except those things that
12760                                          * l1_source matches */
12761                                         SV* scratch_list = NULL;
12762                                         _invlist_subtract(PL_Latin1, l1_source,
12763                                                           &scratch_list);
12764
12765                                         /* Add the list from this class to the
12766                                          * running total */
12767                                         if (! posixes) {
12768                                             posixes = scratch_list;
12769                                         }
12770                                         else {
12771                                             _invlist_union(posixes,
12772                                                            scratch_list,
12773                                                            &posixes);
12774                                             SvREFCNT_dec_NN(scratch_list);
12775                                         }
12776                                         if (DEPENDS_SEMANTICS) {
12777                                             ANYOF_FLAGS(ret)
12778                                                   |= ANYOF_NON_UTF8_LATIN1_ALL;
12779                                         }
12780                                     }
12781                                 }
12782                             }
12783                             goto namedclass_done;
12784                         }
12785
12786                         /* Here, there is a swash loaded for the class.  If no
12787                          * inversion list for it yet, get it */
12788                         if (! PL_XPosix_ptrs[classnum]) {
12789                             PL_XPosix_ptrs[classnum]
12790                              = _swash_to_invlist(PL_utf8_swash_ptrs[classnum]);
12791                         }
12792                     }
12793
12794                     /* Here there is an inversion list already loaded for the
12795                      * entire class */
12796
12797                     if (namedclass % 2 == 0) {  /* A non-complemented class,
12798                                                    like ANYOF_PUNCT */
12799                         if (! LOC) {
12800                             /* For non-locale, just add it to any existing list
12801                              * */
12802                             _invlist_union(posixes,
12803                                            (AT_LEAST_ASCII_RESTRICTED)
12804                                                ? ascii_source
12805                                                : PL_XPosix_ptrs[classnum],
12806                                            &posixes);
12807                         }
12808                         else {  /* Locale */
12809                             SV* scratch_list = NULL;
12810
12811                             /* For above Latin1 code points, we use the full
12812                              * Unicode range */
12813                             _invlist_intersection(PL_AboveLatin1,
12814                                                   PL_XPosix_ptrs[classnum],
12815                                                   &scratch_list);
12816                             /* And set the output to it, adding instead if
12817                              * there already is an output.  Checking if
12818                              * 'posixes' is NULL first saves an extra clone.
12819                              * Its reference count will be decremented at the
12820                              * next union, etc, or if this is the only
12821                              * instance, at the end of the routine */
12822                             if (! posixes) {
12823                                 posixes = scratch_list;
12824                             }
12825                             else {
12826                                 _invlist_union(posixes, scratch_list, &posixes);
12827                                 SvREFCNT_dec_NN(scratch_list);
12828                             }
12829
12830 #ifndef HAS_ISBLANK
12831                             if (namedclass != ANYOF_BLANK) {
12832 #endif
12833                                 /* Set this class in the node for runtime
12834                                  * matching */
12835                                 ANYOF_CLASS_SET(ret, namedclass);
12836 #ifndef HAS_ISBLANK
12837                             }
12838                             else {
12839                                 /* No isblank(), use the hard-coded ASCII-range
12840                                  * blanks, adding them to the running total. */
12841
12842                                 _invlist_union(posixes, ascii_source, &posixes);
12843                             }
12844 #endif
12845                         }
12846                     }
12847                     else {  /* A complemented class, like ANYOF_NPUNCT */
12848                         if (! LOC) {
12849                             _invlist_union_complement_2nd(
12850                                                 posixes,
12851                                                 (AT_LEAST_ASCII_RESTRICTED)
12852                                                     ? ascii_source
12853                                                     : PL_XPosix_ptrs[classnum],
12854                                                 &posixes);
12855                             /* Under /d, everything in the upper half of the
12856                              * Latin1 range matches this complement */
12857                             if (DEPENDS_SEMANTICS) {
12858                                 ANYOF_FLAGS(ret) |= ANYOF_NON_UTF8_LATIN1_ALL;
12859                             }
12860                         }
12861                         else {  /* Locale */
12862                             SV* scratch_list = NULL;
12863                             _invlist_subtract(PL_AboveLatin1,
12864                                               PL_XPosix_ptrs[classnum],
12865                                               &scratch_list);
12866                             if (! posixes) {
12867                                 posixes = scratch_list;
12868                             }
12869                             else {
12870                                 _invlist_union(posixes, scratch_list, &posixes);
12871                                 SvREFCNT_dec_NN(scratch_list);
12872                             }
12873 #ifndef HAS_ISBLANK
12874                             if (namedclass != ANYOF_NBLANK) {
12875 #endif
12876                                 ANYOF_CLASS_SET(ret, namedclass);
12877 #ifndef HAS_ISBLANK
12878                             }
12879                             else {
12880                                 /* Get the list of all code points in Latin1
12881                                  * that are not ASCII blanks, and add them to
12882                                  * the running total */
12883                                 _invlist_subtract(PL_Latin1, ascii_source,
12884                                                   &scratch_list);
12885                                 _invlist_union(posixes, scratch_list, &posixes);
12886                                 SvREFCNT_dec_NN(scratch_list);
12887                             }
12888 #endif
12889                         }
12890                     }
12891                 }
12892               namedclass_done:
12893                 continue;   /* Go get next character */
12894             }
12895         } /* end of namedclass \blah */
12896
12897         /* Here, we have a single value.  If 'range' is set, it is the ending
12898          * of a range--check its validity.  Later, we will handle each
12899          * individual code point in the range.  If 'range' isn't set, this
12900          * could be the beginning of a range, so check for that by looking
12901          * ahead to see if the next real character to be processed is the range
12902          * indicator--the minus sign */
12903
12904         if (skip_white) {
12905             RExC_parse = regpatws(pRExC_state, RExC_parse,
12906                                 FALSE /* means don't recognize comments */);
12907         }
12908
12909         if (range) {
12910             if (prevvalue > value) /* b-a */ {
12911                 const int w = RExC_parse - rangebegin;
12912                 Simple_vFAIL4("Invalid [] range \"%*.*s\"", w, w, rangebegin);
12913                 range = 0; /* not a valid range */
12914             }
12915         }
12916         else {
12917             prevvalue = value; /* save the beginning of the potential range */
12918             if (! stop_at_1     /* Can't be a range if parsing just one thing */
12919                 && *RExC_parse == '-')
12920             {
12921                 char* next_char_ptr = RExC_parse + 1;
12922                 if (skip_white) {   /* Get the next real char after the '-' */
12923                     next_char_ptr = regpatws(pRExC_state,
12924                                              RExC_parse + 1,
12925                                              FALSE); /* means don't recognize
12926                                                         comments */
12927                 }
12928
12929                 /* If the '-' is at the end of the class (just before the ']',
12930                  * it is a literal minus; otherwise it is a range */
12931                 if (next_char_ptr < RExC_end && *next_char_ptr != ']') {
12932                     RExC_parse = next_char_ptr;
12933
12934                     /* a bad range like \w-, [:word:]- ? */
12935                     if (namedclass > OOB_NAMEDCLASS) {
12936                         if (strict || ckWARN(WARN_REGEXP)) {
12937                             const int w =
12938                                 RExC_parse >= rangebegin ?
12939                                 RExC_parse - rangebegin : 0;
12940                             if (strict) {
12941                                 vFAIL4("False [] range \"%*.*s\"",
12942                                     w, w, rangebegin);
12943                             }
12944                             else {
12945                                 vWARN4(RExC_parse,
12946                                     "False [] range \"%*.*s\"",
12947                                     w, w, rangebegin);
12948                             }
12949                         }
12950                         if (!SIZE_ONLY) {
12951                             cp_list = add_cp_to_invlist(cp_list, '-');
12952                         }
12953                         element_count++;
12954                     } else
12955                         range = 1;      /* yeah, it's a range! */
12956                     continue;   /* but do it the next time */
12957                 }
12958             }
12959         }
12960
12961         /* Here, <prevvalue> is the beginning of the range, if any; or <value>
12962          * if not */
12963
12964         /* non-Latin1 code point implies unicode semantics.  Must be set in
12965          * pass1 so is there for the whole of pass 2 */
12966         if (value > 255) {
12967             RExC_uni_semantics = 1;
12968         }
12969
12970         /* Ready to process either the single value, or the completed range.
12971          * For single-valued non-inverted ranges, we consider the possibility
12972          * of multi-char folds.  (We made a conscious decision to not do this
12973          * for the other cases because it can often lead to non-intuitive
12974          * results.  For example, you have the peculiar case that:
12975          *  "s s" =~ /^[^\xDF]+$/i => Y
12976          *  "ss"  =~ /^[^\xDF]+$/i => N
12977          *
12978          * See [perl #89750] */
12979         if (FOLD && allow_multi_folds && value == prevvalue) {
12980             if (value == LATIN_SMALL_LETTER_SHARP_S
12981                 || (value > 255 && _invlist_contains_cp(PL_HasMultiCharFold,
12982                                                         value)))
12983             {
12984                 /* Here <value> is indeed a multi-char fold.  Get what it is */
12985
12986                 U8 foldbuf[UTF8_MAXBYTES_CASE];
12987                 STRLEN foldlen;
12988
12989                 UV folded = _to_uni_fold_flags(
12990                                 value,
12991                                 foldbuf,
12992                                 &foldlen,
12993                                 FOLD_FLAGS_FULL
12994                                 | ((LOC) ?  FOLD_FLAGS_LOCALE
12995                                             : (ASCII_FOLD_RESTRICTED)
12996                                               ? FOLD_FLAGS_NOMIX_ASCII
12997                                               : 0)
12998                                 );
12999
13000                 /* Here, <folded> should be the first character of the
13001                  * multi-char fold of <value>, with <foldbuf> containing the
13002                  * whole thing.  But, if this fold is not allowed (because of
13003                  * the flags), <fold> will be the same as <value>, and should
13004                  * be processed like any other character, so skip the special
13005                  * handling */
13006                 if (folded != value) {
13007
13008                     /* Skip if we are recursed, currently parsing the class
13009                      * again.  Otherwise add this character to the list of
13010                      * multi-char folds. */
13011                     if (! RExC_in_multi_char_class) {
13012                         AV** this_array_ptr;
13013                         AV* this_array;
13014                         STRLEN cp_count = utf8_length(foldbuf,
13015                                                       foldbuf + foldlen);
13016                         SV* multi_fold = sv_2mortal(newSVpvn("", 0));
13017
13018                         Perl_sv_catpvf(aTHX_ multi_fold, "\\x{%"UVXf"}", value);
13019
13020
13021                         if (! multi_char_matches) {
13022                             multi_char_matches = newAV();
13023                         }
13024
13025                         /* <multi_char_matches> is actually an array of arrays.
13026                          * There will be one or two top-level elements: [2],
13027                          * and/or [3].  The [2] element is an array, each
13028                          * element thereof is a character which folds to two
13029                          * characters; likewise for [3].  (Unicode guarantees a
13030                          * maximum of 3 characters in any fold.)  When we
13031                          * rewrite the character class below, we will do so
13032                          * such that the longest folds are written first, so
13033                          * that it prefers the longest matching strings first.
13034                          * This is done even if it turns out that any
13035                          * quantifier is non-greedy, out of programmer
13036                          * laziness.  Tom Christiansen has agreed that this is
13037                          * ok.  This makes the test for the ligature 'ffi' come
13038                          * before the test for 'ff' */
13039                         if (av_exists(multi_char_matches, cp_count)) {
13040                             this_array_ptr = (AV**) av_fetch(multi_char_matches,
13041                                                              cp_count, FALSE);
13042                             this_array = *this_array_ptr;
13043                         }
13044                         else {
13045                             this_array = newAV();
13046                             av_store(multi_char_matches, cp_count,
13047                                      (SV*) this_array);
13048                         }
13049                         av_push(this_array, multi_fold);
13050                     }
13051
13052                     /* This element should not be processed further in this
13053                      * class */
13054                     element_count--;
13055                     value = save_value;
13056                     prevvalue = save_prevvalue;
13057                     continue;
13058                 }
13059             }
13060         }
13061
13062         /* Deal with this element of the class */
13063         if (! SIZE_ONLY) {
13064 #ifndef EBCDIC
13065             cp_list = _add_range_to_invlist(cp_list, prevvalue, value);
13066 #else
13067             SV* this_range = _new_invlist(1);
13068             _append_range_to_invlist(this_range, prevvalue, value);
13069
13070             /* In EBCDIC, the ranges 'A-Z' and 'a-z' are each not contiguous.
13071              * If this range was specified using something like 'i-j', we want
13072              * to include only the 'i' and the 'j', and not anything in
13073              * between, so exclude non-ASCII, non-alphabetics from it.
13074              * However, if the range was specified with something like
13075              * [\x89-\x91] or [\x89-j], all code points within it should be
13076              * included.  literal_endpoint==2 means both ends of the range used
13077              * a literal character, not \x{foo} */
13078             if (literal_endpoint == 2
13079                 && (prevvalue >= 'a' && value <= 'z')
13080                     || (prevvalue >= 'A' && value <= 'Z'))
13081             {
13082                 _invlist_intersection(this_range, PL_Posix_ptrs[_CC_ALPHA],
13083                                       &this_range);
13084             }
13085             _invlist_union(cp_list, this_range, &cp_list);
13086             literal_endpoint = 0;
13087 #endif
13088         }
13089
13090         range = 0; /* this range (if it was one) is done now */
13091     } /* End of loop through all the text within the brackets */
13092
13093     /* If anything in the class expands to more than one character, we have to
13094      * deal with them by building up a substitute parse string, and recursively
13095      * calling reg() on it, instead of proceeding */
13096     if (multi_char_matches) {
13097         SV * substitute_parse = newSVpvn_flags("?:", 2, SVs_TEMP);
13098         I32 cp_count;
13099         STRLEN len;
13100         char *save_end = RExC_end;
13101         char *save_parse = RExC_parse;
13102         bool first_time = TRUE;     /* First multi-char occurrence doesn't get
13103                                        a "|" */
13104         I32 reg_flags;
13105
13106         assert(! invert);
13107 #if 0   /* Have decided not to deal with multi-char folds in inverted classes,
13108            because too confusing */
13109         if (invert) {
13110             sv_catpv(substitute_parse, "(?:");
13111         }
13112 #endif
13113
13114         /* Look at the longest folds first */
13115         for (cp_count = av_len(multi_char_matches); cp_count > 0; cp_count--) {
13116
13117             if (av_exists(multi_char_matches, cp_count)) {
13118                 AV** this_array_ptr;
13119                 SV* this_sequence;
13120
13121                 this_array_ptr = (AV**) av_fetch(multi_char_matches,
13122                                                  cp_count, FALSE);
13123                 while ((this_sequence = av_pop(*this_array_ptr)) !=
13124                                                                 &PL_sv_undef)
13125                 {
13126                     if (! first_time) {
13127                         sv_catpv(substitute_parse, "|");
13128                     }
13129                     first_time = FALSE;
13130
13131                     sv_catpv(substitute_parse, SvPVX(this_sequence));
13132                 }
13133             }
13134         }
13135
13136         /* If the character class contains anything else besides these
13137          * multi-character folds, have to include it in recursive parsing */
13138         if (element_count) {
13139             sv_catpv(substitute_parse, "|[");
13140             sv_catpvn(substitute_parse, orig_parse, RExC_parse - orig_parse);
13141             sv_catpv(substitute_parse, "]");
13142         }
13143
13144         sv_catpv(substitute_parse, ")");
13145 #if 0
13146         if (invert) {
13147             /* This is a way to get the parse to skip forward a whole named
13148              * sequence instead of matching the 2nd character when it fails the
13149              * first */
13150             sv_catpv(substitute_parse, "(*THEN)(*SKIP)(*FAIL)|.)");
13151         }
13152 #endif
13153
13154         RExC_parse = SvPV(substitute_parse, len);
13155         RExC_end = RExC_parse + len;
13156         RExC_in_multi_char_class = 1;
13157         RExC_emit = (regnode *)orig_emit;
13158
13159         ret = reg(pRExC_state, 1, &reg_flags, depth+1);
13160
13161         *flagp |= reg_flags&(HASWIDTH|SIMPLE|SPSTART|POSTPONED|RESTART_UTF8);
13162
13163         RExC_parse = save_parse;
13164         RExC_end = save_end;
13165         RExC_in_multi_char_class = 0;
13166         SvREFCNT_dec_NN(multi_char_matches);
13167         return ret;
13168     }
13169
13170     /* If the character class contains only a single element, it may be
13171      * optimizable into another node type which is smaller and runs faster.
13172      * Check if this is the case for this class */
13173     if (element_count == 1 && ! ret_invlist) {
13174         U8 op = END;
13175         U8 arg = 0;
13176
13177         if (namedclass > OOB_NAMEDCLASS) { /* this is a named class, like \w or
13178                                               [:digit:] or \p{foo} */
13179
13180             /* All named classes are mapped into POSIXish nodes, with its FLAG
13181              * argument giving which class it is */
13182             switch ((I32)namedclass) {
13183                 case ANYOF_UNIPROP:
13184                     break;
13185
13186                 /* These don't depend on the charset modifiers.  They always
13187                  * match under /u rules */
13188                 case ANYOF_NHORIZWS:
13189                 case ANYOF_HORIZWS:
13190                     namedclass = ANYOF_BLANK + namedclass - ANYOF_HORIZWS;
13191                     /* FALLTHROUGH */
13192
13193                 case ANYOF_NVERTWS:
13194                 case ANYOF_VERTWS:
13195                     op = POSIXU;
13196                     goto join_posix;
13197
13198                 /* The actual POSIXish node for all the rest depends on the
13199                  * charset modifier.  The ones in the first set depend only on
13200                  * ASCII or, if available on this platform, locale */
13201                 case ANYOF_ASCII:
13202                 case ANYOF_NASCII:
13203 #ifdef HAS_ISASCII
13204                     op = (LOC) ? POSIXL : POSIXA;
13205 #else
13206                     op = POSIXA;
13207 #endif
13208                     goto join_posix;
13209
13210                 case ANYOF_NCASED:
13211                 case ANYOF_LOWER:
13212                 case ANYOF_NLOWER:
13213                 case ANYOF_UPPER:
13214                 case ANYOF_NUPPER:
13215                     /* under /a could be alpha */
13216                     if (FOLD) {
13217                         if (ASCII_RESTRICTED) {
13218                             namedclass = ANYOF_ALPHA + (namedclass % 2);
13219                         }
13220                         else if (! LOC) {
13221                             break;
13222                         }
13223                     }
13224                     /* FALLTHROUGH */
13225
13226                 /* The rest have more possibilities depending on the charset.
13227                  * We take advantage of the enum ordering of the charset
13228                  * modifiers to get the exact node type, */
13229                 default:
13230                     op = POSIXD + get_regex_charset(RExC_flags);
13231                     if (op > POSIXA) { /* /aa is same as /a */
13232                         op = POSIXA;
13233                     }
13234 #ifndef HAS_ISBLANK
13235                     if (op == POSIXL
13236                         && (namedclass == ANYOF_BLANK
13237                             || namedclass == ANYOF_NBLANK))
13238                     {
13239                         op = POSIXA;
13240                     }
13241 #endif
13242
13243                 join_posix:
13244                     /* The odd numbered ones are the complements of the
13245                      * next-lower even number one */
13246                     if (namedclass % 2 == 1) {
13247                         invert = ! invert;
13248                         namedclass--;
13249                     }
13250                     arg = namedclass_to_classnum(namedclass);
13251                     break;
13252             }
13253         }
13254         else if (value == prevvalue) {
13255
13256             /* Here, the class consists of just a single code point */
13257
13258             if (invert) {
13259                 if (! LOC && value == '\n') {
13260                     op = REG_ANY; /* Optimize [^\n] */
13261                     *flagp |= HASWIDTH|SIMPLE;
13262                     RExC_naughty++;
13263                 }
13264             }
13265             else if (value < 256 || UTF) {
13266
13267                 /* Optimize a single value into an EXACTish node, but not if it
13268                  * would require converting the pattern to UTF-8. */
13269                 op = compute_EXACTish(pRExC_state);
13270             }
13271         } /* Otherwise is a range */
13272         else if (! LOC) {   /* locale could vary these */
13273             if (prevvalue == '0') {
13274                 if (value == '9') {
13275                     arg = _CC_DIGIT;
13276                     op = POSIXA;
13277                 }
13278             }
13279         }
13280
13281         /* Here, we have changed <op> away from its initial value iff we found
13282          * an optimization */
13283         if (op != END) {
13284
13285             /* Throw away this ANYOF regnode, and emit the calculated one,
13286              * which should correspond to the beginning, not current, state of
13287              * the parse */
13288             const char * cur_parse = RExC_parse;
13289             RExC_parse = (char *)orig_parse;
13290             if ( SIZE_ONLY) {
13291                 if (! LOC) {
13292
13293                     /* To get locale nodes to not use the full ANYOF size would
13294                      * require moving the code above that writes the portions
13295                      * of it that aren't in other nodes to after this point.
13296                      * e.g.  ANYOF_CLASS_SET */
13297                     RExC_size = orig_size;
13298                 }
13299             }
13300             else {
13301                 RExC_emit = (regnode *)orig_emit;
13302                 if (PL_regkind[op] == POSIXD) {
13303                     if (invert) {
13304                         op += NPOSIXD - POSIXD;
13305                     }
13306                 }
13307             }
13308
13309             ret = reg_node(pRExC_state, op);
13310
13311             if (PL_regkind[op] == POSIXD || PL_regkind[op] == NPOSIXD) {
13312                 if (! SIZE_ONLY) {
13313                     FLAGS(ret) = arg;
13314                 }
13315                 *flagp |= HASWIDTH|SIMPLE;
13316             }
13317             else if (PL_regkind[op] == EXACT) {
13318                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, 0, value);
13319             }
13320
13321             RExC_parse = (char *) cur_parse;
13322
13323             SvREFCNT_dec(posixes);
13324             SvREFCNT_dec(cp_list);
13325             return ret;
13326         }
13327     }
13328
13329     if (SIZE_ONLY)
13330         return ret;
13331     /****** !SIZE_ONLY (Pass 2) AFTER HERE *********/
13332
13333     /* If folding, we calculate all characters that could fold to or from the
13334      * ones already on the list */
13335     if (FOLD && cp_list) {
13336         UV start, end;  /* End points of code point ranges */
13337
13338         SV* fold_intersection = NULL;
13339
13340         /* If the highest code point is within Latin1, we can use the
13341          * compiled-in Alphas list, and not have to go out to disk.  This
13342          * yields two false positives, the masculine and feminine ordinal
13343          * indicators, which are weeded out below using the
13344          * IS_IN_SOME_FOLD_L1() macro */
13345         if (invlist_highest(cp_list) < 256) {
13346             _invlist_intersection(PL_L1Posix_ptrs[_CC_ALPHA], cp_list,
13347                                                            &fold_intersection);
13348         }
13349         else {
13350
13351             /* Here, there are non-Latin1 code points, so we will have to go
13352              * fetch the list of all the characters that participate in folds
13353              */
13354             if (! PL_utf8_foldable) {
13355                 SV* swash = swash_init("utf8", "_Perl_Any_Folds",
13356                                        &PL_sv_undef, 1, 0);
13357                 PL_utf8_foldable = _get_swash_invlist(swash);
13358                 SvREFCNT_dec_NN(swash);
13359             }
13360
13361             /* This is a hash that for a particular fold gives all characters
13362              * that are involved in it */
13363             if (! PL_utf8_foldclosures) {
13364
13365                 /* If we were unable to find any folds, then we likely won't be
13366                  * able to find the closures.  So just create an empty list.
13367                  * Folding will effectively be restricted to the non-Unicode
13368                  * rules hard-coded into Perl.  (This case happens legitimately
13369                  * during compilation of Perl itself before the Unicode tables
13370                  * are generated) */
13371                 if (_invlist_len(PL_utf8_foldable) == 0) {
13372                     PL_utf8_foldclosures = newHV();
13373                 }
13374                 else {
13375                     /* If the folds haven't been read in, call a fold function
13376                      * to force that */
13377                     if (! PL_utf8_tofold) {
13378                         U8 dummy[UTF8_MAXBYTES+1];
13379
13380                         /* This string is just a short named one above \xff */
13381                         to_utf8_fold((U8*) HYPHEN_UTF8, dummy, NULL);
13382                         assert(PL_utf8_tofold); /* Verify that worked */
13383                     }
13384                     PL_utf8_foldclosures =
13385                                     _swash_inversion_hash(PL_utf8_tofold);
13386                 }
13387             }
13388
13389             /* Only the characters in this class that participate in folds need
13390              * be checked.  Get the intersection of this class and all the
13391              * possible characters that are foldable.  This can quickly narrow
13392              * down a large class */
13393             _invlist_intersection(PL_utf8_foldable, cp_list,
13394                                   &fold_intersection);
13395         }
13396
13397         /* Now look at the foldable characters in this class individually */
13398         invlist_iterinit(fold_intersection);
13399         while (invlist_iternext(fold_intersection, &start, &end)) {
13400             UV j;
13401
13402             /* Locale folding for Latin1 characters is deferred until runtime */
13403             if (LOC && start < 256) {
13404                 start = 256;
13405             }
13406
13407             /* Look at every character in the range */
13408             for (j = start; j <= end; j++) {
13409
13410                 U8 foldbuf[UTF8_MAXBYTES_CASE+1];
13411                 STRLEN foldlen;
13412                 SV** listp;
13413
13414                 if (j < 256) {
13415
13416                     /* We have the latin1 folding rules hard-coded here so that
13417                      * an innocent-looking character class, like /[ks]/i won't
13418                      * have to go out to disk to find the possible matches.
13419                      * XXX It would be better to generate these via regen, in
13420                      * case a new version of the Unicode standard adds new
13421                      * mappings, though that is not really likely, and may be
13422                      * caught by the default: case of the switch below. */
13423
13424                     if (IS_IN_SOME_FOLD_L1(j)) {
13425
13426                         /* ASCII is always matched; non-ASCII is matched only
13427                          * under Unicode rules */
13428                         if (isASCII(j) || AT_LEAST_UNI_SEMANTICS) {
13429                             cp_list =
13430                                 add_cp_to_invlist(cp_list, PL_fold_latin1[j]);
13431                         }
13432                         else {
13433                             depends_list =
13434                              add_cp_to_invlist(depends_list, PL_fold_latin1[j]);
13435                         }
13436                     }
13437
13438                     if (HAS_NONLATIN1_FOLD_CLOSURE(j)
13439                         && (! isASCII(j) || ! ASCII_FOLD_RESTRICTED))
13440                     {
13441                         /* Certain Latin1 characters have matches outside
13442                          * Latin1.  To get here, <j> is one of those
13443                          * characters.   None of these matches is valid for
13444                          * ASCII characters under /aa, which is why the 'if'
13445                          * just above excludes those.  These matches only
13446                          * happen when the target string is utf8.  The code
13447                          * below adds the single fold closures for <j> to the
13448                          * inversion list. */
13449                         switch (j) {
13450                             case 'k':
13451                             case 'K':
13452                                 cp_list =
13453                                     add_cp_to_invlist(cp_list, KELVIN_SIGN);
13454                                 break;
13455                             case 's':
13456                             case 'S':
13457                                 cp_list = add_cp_to_invlist(cp_list,
13458                                                     LATIN_SMALL_LETTER_LONG_S);
13459                                 break;
13460                             case MICRO_SIGN:
13461                                 cp_list = add_cp_to_invlist(cp_list,
13462                                                     GREEK_CAPITAL_LETTER_MU);
13463                                 cp_list = add_cp_to_invlist(cp_list,
13464                                                     GREEK_SMALL_LETTER_MU);
13465                                 break;
13466                             case LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE:
13467                             case LATIN_SMALL_LETTER_A_WITH_RING_ABOVE:
13468                                 cp_list =
13469                                     add_cp_to_invlist(cp_list, ANGSTROM_SIGN);
13470                                 break;
13471                             case LATIN_SMALL_LETTER_Y_WITH_DIAERESIS:
13472                                 cp_list = add_cp_to_invlist(cp_list,
13473                                         LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS);
13474                                 break;
13475                             case LATIN_SMALL_LETTER_SHARP_S:
13476                                 cp_list = add_cp_to_invlist(cp_list,
13477                                                 LATIN_CAPITAL_LETTER_SHARP_S);
13478                                 break;
13479                             case 'F': case 'f':
13480                             case 'I': case 'i':
13481                             case 'L': case 'l':
13482                             case 'T': case 't':
13483                             case 'A': case 'a':
13484                             case 'H': case 'h':
13485                             case 'J': case 'j':
13486                             case 'N': case 'n':
13487                             case 'W': case 'w':
13488                             case 'Y': case 'y':
13489                                 /* These all are targets of multi-character
13490                                  * folds from code points that require UTF8 to
13491                                  * express, so they can't match unless the
13492                                  * target string is in UTF-8, so no action here
13493                                  * is necessary, as regexec.c properly handles
13494                                  * the general case for UTF-8 matching and
13495                                  * multi-char folds */
13496                                 break;
13497                             default:
13498                                 /* Use deprecated warning to increase the
13499                                  * chances of this being output */
13500                                 ckWARN2regdep(RExC_parse, "Perl folding rules are not up-to-date for 0x%"UVXf"; please use the perlbug utility to report;", j);
13501                                 break;
13502                         }
13503                     }
13504                     continue;
13505                 }
13506
13507                 /* Here is an above Latin1 character.  We don't have the rules
13508                  * hard-coded for it.  First, get its fold.  This is the simple
13509                  * fold, as the multi-character folds have been handled earlier
13510                  * and separated out */
13511                 _to_uni_fold_flags(j, foldbuf, &foldlen,
13512                                                ((LOC)
13513                                                ? FOLD_FLAGS_LOCALE
13514                                                : (ASCII_FOLD_RESTRICTED)
13515                                                   ? FOLD_FLAGS_NOMIX_ASCII
13516                                                   : 0));
13517
13518                 /* Single character fold of above Latin1.  Add everything in
13519                  * its fold closure to the list that this node should match.
13520                  * The fold closures data structure is a hash with the keys
13521                  * being the UTF-8 of every character that is folded to, like
13522                  * 'k', and the values each an array of all code points that
13523                  * fold to its key.  e.g. [ 'k', 'K', KELVIN_SIGN ].
13524                  * Multi-character folds are not included */
13525                 if ((listp = hv_fetch(PL_utf8_foldclosures,
13526                                       (char *) foldbuf, foldlen, FALSE)))
13527                 {
13528                     AV* list = (AV*) *listp;
13529                     IV k;
13530                     for (k = 0; k <= av_len(list); k++) {
13531                         SV** c_p = av_fetch(list, k, FALSE);
13532                         UV c;
13533                         if (c_p == NULL) {
13534                             Perl_croak(aTHX_ "panic: invalid PL_utf8_foldclosures structure");
13535                         }
13536                         c = SvUV(*c_p);
13537
13538                         /* /aa doesn't allow folds between ASCII and non-; /l
13539                          * doesn't allow them between above and below 256 */
13540                         if ((ASCII_FOLD_RESTRICTED
13541                                   && (isASCII(c) != isASCII(j)))
13542                             || (LOC && ((c < 256) != (j < 256))))
13543                         {
13544                             continue;
13545                         }
13546
13547                         /* Folds involving non-ascii Latin1 characters
13548                          * under /d are added to a separate list */
13549                         if (isASCII(c) || c > 255 || AT_LEAST_UNI_SEMANTICS)
13550                         {
13551                             cp_list = add_cp_to_invlist(cp_list, c);
13552                         }
13553                         else {
13554                           depends_list = add_cp_to_invlist(depends_list, c);
13555                         }
13556                     }
13557                 }
13558             }
13559         }
13560         SvREFCNT_dec_NN(fold_intersection);
13561     }
13562
13563     /* And combine the result (if any) with any inversion list from posix
13564      * classes.  The lists are kept separate up to now because we don't want to
13565      * fold the classes (folding of those is automatically handled by the swash
13566      * fetching code) */
13567     if (posixes) {
13568         if (! DEPENDS_SEMANTICS) {
13569             if (cp_list) {
13570                 _invlist_union(cp_list, posixes, &cp_list);
13571                 SvREFCNT_dec_NN(posixes);
13572             }
13573             else {
13574                 cp_list = posixes;
13575             }
13576         }
13577         else {
13578             /* Under /d, we put into a separate list the Latin1 things that
13579              * match only when the target string is utf8 */
13580             SV* nonascii_but_latin1_properties = NULL;
13581             _invlist_intersection(posixes, PL_Latin1,
13582                                   &nonascii_but_latin1_properties);
13583             _invlist_subtract(nonascii_but_latin1_properties, PL_ASCII,
13584                               &nonascii_but_latin1_properties);
13585             _invlist_subtract(posixes, nonascii_but_latin1_properties,
13586                               &posixes);
13587             if (cp_list) {
13588                 _invlist_union(cp_list, posixes, &cp_list);
13589                 SvREFCNT_dec_NN(posixes);
13590             }
13591             else {
13592                 cp_list = posixes;
13593             }
13594
13595             if (depends_list) {
13596                 _invlist_union(depends_list, nonascii_but_latin1_properties,
13597                                &depends_list);
13598                 SvREFCNT_dec_NN(nonascii_but_latin1_properties);
13599             }
13600             else {
13601                 depends_list = nonascii_but_latin1_properties;
13602             }
13603         }
13604     }
13605
13606     /* And combine the result (if any) with any inversion list from properties.
13607      * The lists are kept separate up to now so that we can distinguish the two
13608      * in regards to matching above-Unicode.  A run-time warning is generated
13609      * if a Unicode property is matched against a non-Unicode code point. But,
13610      * we allow user-defined properties to match anything, without any warning,
13611      * and we also suppress the warning if there is a portion of the character
13612      * class that isn't a Unicode property, and which matches above Unicode, \W
13613      * or [\x{110000}] for example.
13614      * (Note that in this case, unlike the Posix one above, there is no
13615      * <depends_list>, because having a Unicode property forces Unicode
13616      * semantics */
13617     if (properties) {
13618         bool warn_super = ! has_user_defined_property;
13619         if (cp_list) {
13620
13621             /* If it matters to the final outcome, see if a non-property
13622              * component of the class matches above Unicode.  If so, the
13623              * warning gets suppressed.  This is true even if just a single
13624              * such code point is specified, as though not strictly correct if
13625              * another such code point is matched against, the fact that they
13626              * are using above-Unicode code points indicates they should know
13627              * the issues involved */
13628             if (warn_super) {
13629                 bool non_prop_matches_above_Unicode =
13630                             runtime_posix_matches_above_Unicode
13631                             | (invlist_highest(cp_list) > PERL_UNICODE_MAX);
13632                 if (invert) {
13633                     non_prop_matches_above_Unicode =
13634                                             !  non_prop_matches_above_Unicode;
13635                 }
13636                 warn_super = ! non_prop_matches_above_Unicode;
13637             }
13638
13639             _invlist_union(properties, cp_list, &cp_list);
13640             SvREFCNT_dec_NN(properties);
13641         }
13642         else {
13643             cp_list = properties;
13644         }
13645
13646         if (warn_super) {
13647             OP(ret) = ANYOF_WARN_SUPER;
13648         }
13649     }
13650
13651     /* Here, we have calculated what code points should be in the character
13652      * class.
13653      *
13654      * Now we can see about various optimizations.  Fold calculation (which we
13655      * did above) needs to take place before inversion.  Otherwise /[^k]/i
13656      * would invert to include K, which under /i would match k, which it
13657      * shouldn't.  Therefore we can't invert folded locale now, as it won't be
13658      * folded until runtime */
13659
13660     /* Optimize inverted simple patterns (e.g. [^a-z]) when everything is known
13661      * at compile time.  Besides not inverting folded locale now, we can't
13662      * invert if there are things such as \w, which aren't known until runtime
13663      * */
13664     if (invert
13665         && ! (LOC && (FOLD || (ANYOF_FLAGS(ret) & ANYOF_CLASS)))
13666         && ! depends_list
13667         && ! HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
13668     {
13669         _invlist_invert(cp_list);
13670
13671         /* Any swash can't be used as-is, because we've inverted things */
13672         if (swash) {
13673             SvREFCNT_dec_NN(swash);
13674             swash = NULL;
13675         }
13676
13677         /* Clear the invert flag since have just done it here */
13678         invert = FALSE;
13679     }
13680
13681     if (ret_invlist) {
13682         *ret_invlist = cp_list;
13683         SvREFCNT_dec(swash);
13684
13685         /* Discard the generated node */
13686         if (SIZE_ONLY) {
13687             RExC_size = orig_size;
13688         }
13689         else {
13690             RExC_emit = orig_emit;
13691         }
13692         return orig_emit;
13693     }
13694
13695     /* If we didn't do folding, it's because some information isn't available
13696      * until runtime; set the run-time fold flag for these.  (We don't have to
13697      * worry about properties folding, as that is taken care of by the swash
13698      * fetching) */
13699     if (FOLD && LOC)
13700     {
13701        ANYOF_FLAGS(ret) |= ANYOF_LOC_FOLD;
13702     }
13703
13704     /* Some character classes are equivalent to other nodes.  Such nodes take
13705      * up less room and generally fewer operations to execute than ANYOF nodes.
13706      * Above, we checked for and optimized into some such equivalents for
13707      * certain common classes that are easy to test.  Getting to this point in
13708      * the code means that the class didn't get optimized there.  Since this
13709      * code is only executed in Pass 2, it is too late to save space--it has
13710      * been allocated in Pass 1, and currently isn't given back.  But turning
13711      * things into an EXACTish node can allow the optimizer to join it to any
13712      * adjacent such nodes.  And if the class is equivalent to things like /./,
13713      * expensive run-time swashes can be avoided.  Now that we have more
13714      * complete information, we can find things necessarily missed by the
13715      * earlier code.  I (khw) am not sure how much to look for here.  It would
13716      * be easy, but perhaps too slow, to check any candidates against all the
13717      * node types they could possibly match using _invlistEQ(). */
13718
13719     if (cp_list
13720         && ! invert
13721         && ! depends_list
13722         && ! (ANYOF_FLAGS(ret) & ANYOF_CLASS)
13723         && ! HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
13724     {
13725         UV start, end;
13726         U8 op = END;  /* The optimzation node-type */
13727         const char * cur_parse= RExC_parse;
13728
13729         invlist_iterinit(cp_list);
13730         if (! invlist_iternext(cp_list, &start, &end)) {
13731
13732             /* Here, the list is empty.  This happens, for example, when a
13733              * Unicode property is the only thing in the character class, and
13734              * it doesn't match anything.  (perluniprops.pod notes such
13735              * properties) */
13736             op = OPFAIL;
13737             *flagp |= HASWIDTH|SIMPLE;
13738         }
13739         else if (start == end) {    /* The range is a single code point */
13740             if (! invlist_iternext(cp_list, &start, &end)
13741
13742                     /* Don't do this optimization if it would require changing
13743                      * the pattern to UTF-8 */
13744                 && (start < 256 || UTF))
13745             {
13746                 /* Here, the list contains a single code point.  Can optimize
13747                  * into an EXACT node */
13748
13749                 value = start;
13750
13751                 if (! FOLD) {
13752                     op = EXACT;
13753                 }
13754                 else if (LOC) {
13755
13756                     /* A locale node under folding with one code point can be
13757                      * an EXACTFL, as its fold won't be calculated until
13758                      * runtime */
13759                     op = EXACTFL;
13760                 }
13761                 else {
13762
13763                     /* Here, we are generally folding, but there is only one
13764                      * code point to match.  If we have to, we use an EXACT
13765                      * node, but it would be better for joining with adjacent
13766                      * nodes in the optimization pass if we used the same
13767                      * EXACTFish node that any such are likely to be.  We can
13768                      * do this iff the code point doesn't participate in any
13769                      * folds.  For example, an EXACTF of a colon is the same as
13770                      * an EXACT one, since nothing folds to or from a colon. */
13771                     if (value < 256) {
13772                         if (IS_IN_SOME_FOLD_L1(value)) {
13773                             op = EXACT;
13774                         }
13775                     }
13776                     else {
13777                         if (! PL_utf8_foldable) {
13778                             SV* swash = swash_init("utf8", "_Perl_Any_Folds",
13779                                                 &PL_sv_undef, 1, 0);
13780                             PL_utf8_foldable = _get_swash_invlist(swash);
13781                             SvREFCNT_dec_NN(swash);
13782                         }
13783                         if (_invlist_contains_cp(PL_utf8_foldable, value)) {
13784                             op = EXACT;
13785                         }
13786                     }
13787
13788                     /* If we haven't found the node type, above, it means we
13789                      * can use the prevailing one */
13790                     if (op == END) {
13791                         op = compute_EXACTish(pRExC_state);
13792                     }
13793                 }
13794             }
13795         }
13796         else if (start == 0) {
13797             if (end == UV_MAX) {
13798                 op = SANY;
13799                 *flagp |= HASWIDTH|SIMPLE;
13800                 RExC_naughty++;
13801             }
13802             else if (end == '\n' - 1
13803                     && invlist_iternext(cp_list, &start, &end)
13804                     && start == '\n' + 1 && end == UV_MAX)
13805             {
13806                 op = REG_ANY;
13807                 *flagp |= HASWIDTH|SIMPLE;
13808                 RExC_naughty++;
13809             }
13810         }
13811         invlist_iterfinish(cp_list);
13812
13813         if (op != END) {
13814             RExC_parse = (char *)orig_parse;
13815             RExC_emit = (regnode *)orig_emit;
13816
13817             ret = reg_node(pRExC_state, op);
13818
13819             RExC_parse = (char *)cur_parse;
13820
13821             if (PL_regkind[op] == EXACT) {
13822                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, 0, value);
13823             }
13824
13825             SvREFCNT_dec_NN(cp_list);
13826             return ret;
13827         }
13828     }
13829
13830     /* Here, <cp_list> contains all the code points we can determine at
13831      * compile time that match under all conditions.  Go through it, and
13832      * for things that belong in the bitmap, put them there, and delete from
13833      * <cp_list>.  While we are at it, see if everything above 255 is in the
13834      * list, and if so, set a flag to speed up execution */
13835     ANYOF_BITMAP_ZERO(ret);
13836     if (cp_list) {
13837
13838         /* This gets set if we actually need to modify things */
13839         bool change_invlist = FALSE;
13840
13841         UV start, end;
13842
13843         /* Start looking through <cp_list> */
13844         invlist_iterinit(cp_list);
13845         while (invlist_iternext(cp_list, &start, &end)) {
13846             UV high;
13847             int i;
13848
13849             if (end == UV_MAX && start <= 256) {
13850                 ANYOF_FLAGS(ret) |= ANYOF_UNICODE_ALL;
13851             }
13852
13853             /* Quit if are above what we should change */
13854             if (start > 255) {
13855                 break;
13856             }
13857
13858             change_invlist = TRUE;
13859
13860             /* Set all the bits in the range, up to the max that we are doing */
13861             high = (end < 255) ? end : 255;
13862             for (i = start; i <= (int) high; i++) {
13863                 if (! ANYOF_BITMAP_TEST(ret, i)) {
13864                     ANYOF_BITMAP_SET(ret, i);
13865                     prevvalue = value;
13866                     value = i;
13867                 }
13868             }
13869         }
13870         invlist_iterfinish(cp_list);
13871
13872         /* Done with loop; remove any code points that are in the bitmap from
13873          * <cp_list> */
13874         if (change_invlist) {
13875             _invlist_subtract(cp_list, PL_Latin1, &cp_list);
13876         }
13877
13878         /* If have completely emptied it, remove it completely */
13879         if (_invlist_len(cp_list) == 0) {
13880             SvREFCNT_dec_NN(cp_list);
13881             cp_list = NULL;
13882         }
13883     }
13884
13885     if (invert) {
13886         ANYOF_FLAGS(ret) |= ANYOF_INVERT;
13887     }
13888
13889     /* Here, the bitmap has been populated with all the Latin1 code points that
13890      * always match.  Can now add to the overall list those that match only
13891      * when the target string is UTF-8 (<depends_list>). */
13892     if (depends_list) {
13893         if (cp_list) {
13894             _invlist_union(cp_list, depends_list, &cp_list);
13895             SvREFCNT_dec_NN(depends_list);
13896         }
13897         else {
13898             cp_list = depends_list;
13899         }
13900     }
13901
13902     /* If there is a swash and more than one element, we can't use the swash in
13903      * the optimization below. */
13904     if (swash && element_count > 1) {
13905         SvREFCNT_dec_NN(swash);
13906         swash = NULL;
13907     }
13908
13909     if (! cp_list
13910         && ! HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
13911     {
13912         ARG_SET(ret, ANYOF_NONBITMAP_EMPTY);
13913     }
13914     else {
13915         /* av[0] stores the character class description in its textual form:
13916          *       used later (regexec.c:Perl_regclass_swash()) to initialize the
13917          *       appropriate swash, and is also useful for dumping the regnode.
13918          * av[1] if NULL, is a placeholder to later contain the swash computed
13919          *       from av[0].  But if no further computation need be done, the
13920          *       swash is stored there now.
13921          * av[2] stores the cp_list inversion list for use in addition or
13922          *       instead of av[0]; used only if av[1] is NULL
13923          * av[3] is set if any component of the class is from a user-defined
13924          *       property; used only if av[1] is NULL */
13925         AV * const av = newAV();
13926         SV *rv;
13927
13928         av_store(av, 0, (HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
13929                         ? SvREFCNT_inc(listsv) : &PL_sv_undef);
13930         if (swash) {
13931             av_store(av, 1, swash);
13932             SvREFCNT_dec_NN(cp_list);
13933         }
13934         else {
13935             av_store(av, 1, NULL);
13936             if (cp_list) {
13937                 av_store(av, 2, cp_list);
13938                 av_store(av, 3, newSVuv(has_user_defined_property));
13939             }
13940         }
13941
13942         rv = newRV_noinc(MUTABLE_SV(av));
13943         n = add_data(pRExC_state, 1, "s");
13944         RExC_rxi->data->data[n] = (void*)rv;
13945         ARG_SET(ret, n);
13946     }
13947
13948     *flagp |= HASWIDTH|SIMPLE;
13949     return ret;
13950 }
13951 #undef HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION
13952
13953
13954 /* reg_skipcomment()
13955
13956    Absorbs an /x style # comments from the input stream.
13957    Returns true if there is more text remaining in the stream.
13958    Will set the REG_SEEN_RUN_ON_COMMENT flag if the comment
13959    terminates the pattern without including a newline.
13960
13961    Note its the callers responsibility to ensure that we are
13962    actually in /x mode
13963
13964 */
13965
13966 STATIC bool
13967 S_reg_skipcomment(pTHX_ RExC_state_t *pRExC_state)
13968 {
13969     bool ended = 0;
13970
13971     PERL_ARGS_ASSERT_REG_SKIPCOMMENT;
13972
13973     while (RExC_parse < RExC_end)
13974         if (*RExC_parse++ == '\n') {
13975             ended = 1;
13976             break;
13977         }
13978     if (!ended) {
13979         /* we ran off the end of the pattern without ending
13980            the comment, so we have to add an \n when wrapping */
13981         RExC_seen |= REG_SEEN_RUN_ON_COMMENT;
13982         return 0;
13983     } else
13984         return 1;
13985 }
13986
13987 /* nextchar()
13988
13989    Advances the parse position, and optionally absorbs
13990    "whitespace" from the inputstream.
13991
13992    Without /x "whitespace" means (?#...) style comments only,
13993    with /x this means (?#...) and # comments and whitespace proper.
13994
13995    Returns the RExC_parse point from BEFORE the scan occurs.
13996
13997    This is the /x friendly way of saying RExC_parse++.
13998 */
13999
14000 STATIC char*
14001 S_nextchar(pTHX_ RExC_state_t *pRExC_state)
14002 {
14003     char* const retval = RExC_parse++;
14004
14005     PERL_ARGS_ASSERT_NEXTCHAR;
14006
14007     for (;;) {
14008         if (RExC_end - RExC_parse >= 3
14009             && *RExC_parse == '('
14010             && RExC_parse[1] == '?'
14011             && RExC_parse[2] == '#')
14012         {
14013             while (*RExC_parse != ')') {
14014                 if (RExC_parse == RExC_end)
14015                     FAIL("Sequence (?#... not terminated");
14016                 RExC_parse++;
14017             }
14018             RExC_parse++;
14019             continue;
14020         }
14021         if (RExC_flags & RXf_PMf_EXTENDED) {
14022             if (isSPACE(*RExC_parse)) {
14023                 RExC_parse++;
14024                 continue;
14025             }
14026             else if (*RExC_parse == '#') {
14027                 if ( reg_skipcomment( pRExC_state ) )
14028                     continue;
14029             }
14030         }
14031         return retval;
14032     }
14033 }
14034
14035 /*
14036 - reg_node - emit a node
14037 */
14038 STATIC regnode *                        /* Location. */
14039 S_reg_node(pTHX_ RExC_state_t *pRExC_state, U8 op)
14040 {
14041     dVAR;
14042     regnode *ptr;
14043     regnode * const ret = RExC_emit;
14044     GET_RE_DEBUG_FLAGS_DECL;
14045
14046     PERL_ARGS_ASSERT_REG_NODE;
14047
14048     if (SIZE_ONLY) {
14049         SIZE_ALIGN(RExC_size);
14050         RExC_size += 1;
14051         return(ret);
14052     }
14053     if (RExC_emit >= RExC_emit_bound)
14054         Perl_croak(aTHX_ "panic: reg_node overrun trying to emit %d, %p>=%p",
14055                    op, RExC_emit, RExC_emit_bound);
14056
14057     NODE_ALIGN_FILL(ret);
14058     ptr = ret;
14059     FILL_ADVANCE_NODE(ptr, op);
14060 #ifdef RE_TRACK_PATTERN_OFFSETS
14061     if (RExC_offsets) {         /* MJD */
14062         MJD_OFFSET_DEBUG(("%s:%d: (op %s) %s %"UVuf" (len %"UVuf") (max %"UVuf").\n", 
14063               "reg_node", __LINE__, 
14064               PL_reg_name[op],
14065               (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0] 
14066                 ? "Overwriting end of array!\n" : "OK",
14067               (UV)(RExC_emit - RExC_emit_start),
14068               (UV)(RExC_parse - RExC_start),
14069               (UV)RExC_offsets[0])); 
14070         Set_Node_Offset(RExC_emit, RExC_parse + (op == END));
14071     }
14072 #endif
14073     RExC_emit = ptr;
14074     return(ret);
14075 }
14076
14077 /*
14078 - reganode - emit a node with an argument
14079 */
14080 STATIC regnode *                        /* Location. */
14081 S_reganode(pTHX_ RExC_state_t *pRExC_state, U8 op, U32 arg)
14082 {
14083     dVAR;
14084     regnode *ptr;
14085     regnode * const ret = RExC_emit;
14086     GET_RE_DEBUG_FLAGS_DECL;
14087
14088     PERL_ARGS_ASSERT_REGANODE;
14089
14090     if (SIZE_ONLY) {
14091         SIZE_ALIGN(RExC_size);
14092         RExC_size += 2;
14093         /* 
14094            We can't do this:
14095            
14096            assert(2==regarglen[op]+1); 
14097
14098            Anything larger than this has to allocate the extra amount.
14099            If we changed this to be:
14100            
14101            RExC_size += (1 + regarglen[op]);
14102            
14103            then it wouldn't matter. Its not clear what side effect
14104            might come from that so its not done so far.
14105            -- dmq
14106         */
14107         return(ret);
14108     }
14109     if (RExC_emit >= RExC_emit_bound)
14110         Perl_croak(aTHX_ "panic: reg_node overrun trying to emit %d, %p>=%p",
14111                    op, RExC_emit, RExC_emit_bound);
14112
14113     NODE_ALIGN_FILL(ret);
14114     ptr = ret;
14115     FILL_ADVANCE_NODE_ARG(ptr, op, arg);
14116 #ifdef RE_TRACK_PATTERN_OFFSETS
14117     if (RExC_offsets) {         /* MJD */
14118         MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s %"UVuf" <- %"UVuf" (max %"UVuf").\n", 
14119               "reganode",
14120               __LINE__,
14121               PL_reg_name[op],
14122               (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0] ? 
14123               "Overwriting end of array!\n" : "OK",
14124               (UV)(RExC_emit - RExC_emit_start),
14125               (UV)(RExC_parse - RExC_start),
14126               (UV)RExC_offsets[0])); 
14127         Set_Cur_Node_Offset;
14128     }
14129 #endif            
14130     RExC_emit = ptr;
14131     return(ret);
14132 }
14133
14134 /*
14135 - reguni - emit (if appropriate) a Unicode character
14136 */
14137 STATIC STRLEN
14138 S_reguni(pTHX_ const RExC_state_t *pRExC_state, UV uv, char* s)
14139 {
14140     dVAR;
14141
14142     PERL_ARGS_ASSERT_REGUNI;
14143
14144     return SIZE_ONLY ? UNISKIP(uv) : (uvchr_to_utf8((U8*)s, uv) - (U8*)s);
14145 }
14146
14147 /*
14148 - reginsert - insert an operator in front of already-emitted operand
14149 *
14150 * Means relocating the operand.
14151 */
14152 STATIC void
14153 S_reginsert(pTHX_ RExC_state_t *pRExC_state, U8 op, regnode *opnd, U32 depth)
14154 {
14155     dVAR;
14156     regnode *src;
14157     regnode *dst;
14158     regnode *place;
14159     const int offset = regarglen[(U8)op];
14160     const int size = NODE_STEP_REGNODE + offset;
14161     GET_RE_DEBUG_FLAGS_DECL;
14162
14163     PERL_ARGS_ASSERT_REGINSERT;
14164     PERL_UNUSED_ARG(depth);
14165 /* (PL_regkind[(U8)op] == CURLY ? EXTRA_STEP_2ARGS : 0); */
14166     DEBUG_PARSE_FMT("inst"," - %s",PL_reg_name[op]);
14167     if (SIZE_ONLY) {
14168         RExC_size += size;
14169         return;
14170     }
14171
14172     src = RExC_emit;
14173     RExC_emit += size;
14174     dst = RExC_emit;
14175     if (RExC_open_parens) {
14176         int paren;
14177         /*DEBUG_PARSE_FMT("inst"," - %"IVdf, (IV)RExC_npar);*/
14178         for ( paren=0 ; paren < RExC_npar ; paren++ ) {
14179             if ( RExC_open_parens[paren] >= opnd ) {
14180                 /*DEBUG_PARSE_FMT("open"," - %d",size);*/
14181                 RExC_open_parens[paren] += size;
14182             } else {
14183                 /*DEBUG_PARSE_FMT("open"," - %s","ok");*/
14184             }
14185             if ( RExC_close_parens[paren] >= opnd ) {
14186                 /*DEBUG_PARSE_FMT("close"," - %d",size);*/
14187                 RExC_close_parens[paren] += size;
14188             } else {
14189                 /*DEBUG_PARSE_FMT("close"," - %s","ok");*/
14190             }
14191         }
14192     }
14193
14194     while (src > opnd) {
14195         StructCopy(--src, --dst, regnode);
14196 #ifdef RE_TRACK_PATTERN_OFFSETS
14197         if (RExC_offsets) {     /* MJD 20010112 */
14198             MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s copy %"UVuf" -> %"UVuf" (max %"UVuf").\n",
14199                   "reg_insert",
14200                   __LINE__,
14201                   PL_reg_name[op],
14202                   (UV)(dst - RExC_emit_start) > RExC_offsets[0] 
14203                     ? "Overwriting end of array!\n" : "OK",
14204                   (UV)(src - RExC_emit_start),
14205                   (UV)(dst - RExC_emit_start),
14206                   (UV)RExC_offsets[0])); 
14207             Set_Node_Offset_To_R(dst-RExC_emit_start, Node_Offset(src));
14208             Set_Node_Length_To_R(dst-RExC_emit_start, Node_Length(src));
14209         }
14210 #endif
14211     }
14212     
14213
14214     place = opnd;               /* Op node, where operand used to be. */
14215 #ifdef RE_TRACK_PATTERN_OFFSETS
14216     if (RExC_offsets) {         /* MJD */
14217         MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s %"UVuf" <- %"UVuf" (max %"UVuf").\n", 
14218               "reginsert",
14219               __LINE__,
14220               PL_reg_name[op],
14221               (UV)(place - RExC_emit_start) > RExC_offsets[0] 
14222               ? "Overwriting end of array!\n" : "OK",
14223               (UV)(place - RExC_emit_start),
14224               (UV)(RExC_parse - RExC_start),
14225               (UV)RExC_offsets[0]));
14226         Set_Node_Offset(place, RExC_parse);
14227         Set_Node_Length(place, 1);
14228     }
14229 #endif    
14230     src = NEXTOPER(place);
14231     FILL_ADVANCE_NODE(place, op);
14232     Zero(src, offset, regnode);
14233 }
14234
14235 /*
14236 - regtail - set the next-pointer at the end of a node chain of p to val.
14237 - SEE ALSO: regtail_study
14238 */
14239 /* TODO: All three parms should be const */
14240 STATIC void
14241 S_regtail(pTHX_ RExC_state_t *pRExC_state, regnode *p, const regnode *val,U32 depth)
14242 {
14243     dVAR;
14244     regnode *scan;
14245     GET_RE_DEBUG_FLAGS_DECL;
14246
14247     PERL_ARGS_ASSERT_REGTAIL;
14248 #ifndef DEBUGGING
14249     PERL_UNUSED_ARG(depth);
14250 #endif
14251
14252     if (SIZE_ONLY)
14253         return;
14254
14255     /* Find last node. */
14256     scan = p;
14257     for (;;) {
14258         regnode * const temp = regnext(scan);
14259         DEBUG_PARSE_r({
14260             SV * const mysv=sv_newmortal();
14261             DEBUG_PARSE_MSG((scan==p ? "tail" : ""));
14262             regprop(RExC_rx, mysv, scan);
14263             PerlIO_printf(Perl_debug_log, "~ %s (%d) %s %s\n",
14264                 SvPV_nolen_const(mysv), REG_NODE_NUM(scan),
14265                     (temp == NULL ? "->" : ""),
14266                     (temp == NULL ? PL_reg_name[OP(val)] : "")
14267             );
14268         });
14269         if (temp == NULL)
14270             break;
14271         scan = temp;
14272     }
14273
14274     if (reg_off_by_arg[OP(scan)]) {
14275         ARG_SET(scan, val - scan);
14276     }
14277     else {
14278         NEXT_OFF(scan) = val - scan;
14279     }
14280 }
14281
14282 #ifdef DEBUGGING
14283 /*
14284 - regtail_study - set the next-pointer at the end of a node chain of p to val.
14285 - Look for optimizable sequences at the same time.
14286 - currently only looks for EXACT chains.
14287
14288 This is experimental code. The idea is to use this routine to perform 
14289 in place optimizations on branches and groups as they are constructed,
14290 with the long term intention of removing optimization from study_chunk so
14291 that it is purely analytical.
14292
14293 Currently only used when in DEBUG mode. The macro REGTAIL_STUDY() is used
14294 to control which is which.
14295
14296 */
14297 /* TODO: All four parms should be const */
14298
14299 STATIC U8
14300 S_regtail_study(pTHX_ RExC_state_t *pRExC_state, regnode *p, const regnode *val,U32 depth)
14301 {
14302     dVAR;
14303     regnode *scan;
14304     U8 exact = PSEUDO;
14305 #ifdef EXPERIMENTAL_INPLACESCAN
14306     I32 min = 0;
14307 #endif
14308     GET_RE_DEBUG_FLAGS_DECL;
14309
14310     PERL_ARGS_ASSERT_REGTAIL_STUDY;
14311
14312
14313     if (SIZE_ONLY)
14314         return exact;
14315
14316     /* Find last node. */
14317
14318     scan = p;
14319     for (;;) {
14320         regnode * const temp = regnext(scan);
14321 #ifdef EXPERIMENTAL_INPLACESCAN
14322         if (PL_regkind[OP(scan)] == EXACT) {
14323             bool has_exactf_sharp_s;    /* Unexamined in this routine */
14324             if (join_exact(pRExC_state,scan,&min, &has_exactf_sharp_s, 1,val,depth+1))
14325                 return EXACT;
14326         }
14327 #endif
14328         if ( exact ) {
14329             switch (OP(scan)) {
14330                 case EXACT:
14331                 case EXACTF:
14332                 case EXACTFA:
14333                 case EXACTFU:
14334                 case EXACTFU_SS:
14335                 case EXACTFU_TRICKYFOLD:
14336                 case EXACTFL:
14337                         if( exact == PSEUDO )
14338                             exact= OP(scan);
14339                         else if ( exact != OP(scan) )
14340                             exact= 0;
14341                 case NOTHING:
14342                     break;
14343                 default:
14344                     exact= 0;
14345             }
14346         }
14347         DEBUG_PARSE_r({
14348             SV * const mysv=sv_newmortal();
14349             DEBUG_PARSE_MSG((scan==p ? "tsdy" : ""));
14350             regprop(RExC_rx, mysv, scan);
14351             PerlIO_printf(Perl_debug_log, "~ %s (%d) -> %s\n",
14352                 SvPV_nolen_const(mysv),
14353                 REG_NODE_NUM(scan),
14354                 PL_reg_name[exact]);
14355         });
14356         if (temp == NULL)
14357             break;
14358         scan = temp;
14359     }
14360     DEBUG_PARSE_r({
14361         SV * const mysv_val=sv_newmortal();
14362         DEBUG_PARSE_MSG("");
14363         regprop(RExC_rx, mysv_val, val);
14364         PerlIO_printf(Perl_debug_log, "~ attach to %s (%"IVdf") offset to %"IVdf"\n",
14365                       SvPV_nolen_const(mysv_val),
14366                       (IV)REG_NODE_NUM(val),
14367                       (IV)(val - scan)
14368         );
14369     });
14370     if (reg_off_by_arg[OP(scan)]) {
14371         ARG_SET(scan, val - scan);
14372     }
14373     else {
14374         NEXT_OFF(scan) = val - scan;
14375     }
14376
14377     return exact;
14378 }
14379 #endif
14380
14381 /*
14382  - regdump - dump a regexp onto Perl_debug_log in vaguely comprehensible form
14383  */
14384 #ifdef DEBUGGING
14385 static void 
14386 S_regdump_extflags(pTHX_ const char *lead, const U32 flags)
14387 {
14388     int bit;
14389     int set=0;
14390     regex_charset cs;
14391
14392     for (bit=0; bit<32; bit++) {
14393         if (flags & (1<<bit)) {
14394             if ((1<<bit) & RXf_PMf_CHARSET) {   /* Output separately, below */
14395                 continue;
14396             }
14397             if (!set++ && lead) 
14398                 PerlIO_printf(Perl_debug_log, "%s",lead);
14399             PerlIO_printf(Perl_debug_log, "%s ",PL_reg_extflags_name[bit]);
14400         }               
14401     }      
14402     if ((cs = get_regex_charset(flags)) != REGEX_DEPENDS_CHARSET) {
14403             if (!set++ && lead) {
14404                 PerlIO_printf(Perl_debug_log, "%s",lead);
14405             }
14406             switch (cs) {
14407                 case REGEX_UNICODE_CHARSET:
14408                     PerlIO_printf(Perl_debug_log, "UNICODE");
14409                     break;
14410                 case REGEX_LOCALE_CHARSET:
14411                     PerlIO_printf(Perl_debug_log, "LOCALE");
14412                     break;
14413                 case REGEX_ASCII_RESTRICTED_CHARSET:
14414                     PerlIO_printf(Perl_debug_log, "ASCII-RESTRICTED");
14415                     break;
14416                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
14417                     PerlIO_printf(Perl_debug_log, "ASCII-MORE_RESTRICTED");
14418                     break;
14419                 default:
14420                     PerlIO_printf(Perl_debug_log, "UNKNOWN CHARACTER SET");
14421                     break;
14422             }
14423     }
14424     if (lead)  {
14425         if (set) 
14426             PerlIO_printf(Perl_debug_log, "\n");
14427         else 
14428             PerlIO_printf(Perl_debug_log, "%s[none-set]\n",lead);
14429     }            
14430 }   
14431 #endif
14432
14433 void
14434 Perl_regdump(pTHX_ const regexp *r)
14435 {
14436 #ifdef DEBUGGING
14437     dVAR;
14438     SV * const sv = sv_newmortal();
14439     SV *dsv= sv_newmortal();
14440     RXi_GET_DECL(r,ri);
14441     GET_RE_DEBUG_FLAGS_DECL;
14442
14443     PERL_ARGS_ASSERT_REGDUMP;
14444
14445     (void)dumpuntil(r, ri->program, ri->program + 1, NULL, NULL, sv, 0, 0);
14446
14447     /* Header fields of interest. */
14448     if (r->anchored_substr) {
14449         RE_PV_QUOTED_DECL(s, 0, dsv, SvPVX_const(r->anchored_substr), 
14450             RE_SV_DUMPLEN(r->anchored_substr), 30);
14451         PerlIO_printf(Perl_debug_log,
14452                       "anchored %s%s at %"IVdf" ",
14453                       s, RE_SV_TAIL(r->anchored_substr),
14454                       (IV)r->anchored_offset);
14455     } else if (r->anchored_utf8) {
14456         RE_PV_QUOTED_DECL(s, 1, dsv, SvPVX_const(r->anchored_utf8), 
14457             RE_SV_DUMPLEN(r->anchored_utf8), 30);
14458         PerlIO_printf(Perl_debug_log,
14459                       "anchored utf8 %s%s at %"IVdf" ",
14460                       s, RE_SV_TAIL(r->anchored_utf8),
14461                       (IV)r->anchored_offset);
14462     }                 
14463     if (r->float_substr) {
14464         RE_PV_QUOTED_DECL(s, 0, dsv, SvPVX_const(r->float_substr), 
14465             RE_SV_DUMPLEN(r->float_substr), 30);
14466         PerlIO_printf(Perl_debug_log,
14467                       "floating %s%s at %"IVdf"..%"UVuf" ",
14468                       s, RE_SV_TAIL(r->float_substr),
14469                       (IV)r->float_min_offset, (UV)r->float_max_offset);
14470     } else if (r->float_utf8) {
14471         RE_PV_QUOTED_DECL(s, 1, dsv, SvPVX_const(r->float_utf8), 
14472             RE_SV_DUMPLEN(r->float_utf8), 30);
14473         PerlIO_printf(Perl_debug_log,
14474                       "floating utf8 %s%s at %"IVdf"..%"UVuf" ",
14475                       s, RE_SV_TAIL(r->float_utf8),
14476                       (IV)r->float_min_offset, (UV)r->float_max_offset);
14477     }
14478     if (r->check_substr || r->check_utf8)
14479         PerlIO_printf(Perl_debug_log,
14480                       (const char *)
14481                       (r->check_substr == r->float_substr
14482                        && r->check_utf8 == r->float_utf8
14483                        ? "(checking floating" : "(checking anchored"));
14484     if (r->extflags & RXf_NOSCAN)
14485         PerlIO_printf(Perl_debug_log, " noscan");
14486     if (r->extflags & RXf_CHECK_ALL)
14487         PerlIO_printf(Perl_debug_log, " isall");
14488     if (r->check_substr || r->check_utf8)
14489         PerlIO_printf(Perl_debug_log, ") ");
14490
14491     if (ri->regstclass) {
14492         regprop(r, sv, ri->regstclass);
14493         PerlIO_printf(Perl_debug_log, "stclass %s ", SvPVX_const(sv));
14494     }
14495     if (r->extflags & RXf_ANCH) {
14496         PerlIO_printf(Perl_debug_log, "anchored");
14497         if (r->extflags & RXf_ANCH_BOL)
14498             PerlIO_printf(Perl_debug_log, "(BOL)");
14499         if (r->extflags & RXf_ANCH_MBOL)
14500             PerlIO_printf(Perl_debug_log, "(MBOL)");
14501         if (r->extflags & RXf_ANCH_SBOL)
14502             PerlIO_printf(Perl_debug_log, "(SBOL)");
14503         if (r->extflags & RXf_ANCH_GPOS)
14504             PerlIO_printf(Perl_debug_log, "(GPOS)");
14505         PerlIO_putc(Perl_debug_log, ' ');
14506     }
14507     if (r->extflags & RXf_GPOS_SEEN)
14508         PerlIO_printf(Perl_debug_log, "GPOS:%"UVuf" ", (UV)r->gofs);
14509     if (r->intflags & PREGf_SKIP)
14510         PerlIO_printf(Perl_debug_log, "plus ");
14511     if (r->intflags & PREGf_IMPLICIT)
14512         PerlIO_printf(Perl_debug_log, "implicit ");
14513     PerlIO_printf(Perl_debug_log, "minlen %"IVdf" ", (IV)r->minlen);
14514     if (r->extflags & RXf_EVAL_SEEN)
14515         PerlIO_printf(Perl_debug_log, "with eval ");
14516     PerlIO_printf(Perl_debug_log, "\n");
14517     DEBUG_FLAGS_r(regdump_extflags("r->extflags: ",r->extflags));            
14518 #else
14519     PERL_ARGS_ASSERT_REGDUMP;
14520     PERL_UNUSED_CONTEXT;
14521     PERL_UNUSED_ARG(r);
14522 #endif  /* DEBUGGING */
14523 }
14524
14525 /*
14526 - regprop - printable representation of opcode
14527 */
14528 #define EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags) \
14529 STMT_START { \
14530         if (do_sep) {                           \
14531             Perl_sv_catpvf(aTHX_ sv,"%s][%s",PL_colors[1],PL_colors[0]); \
14532             if (flags & ANYOF_INVERT)           \
14533                 /*make sure the invert info is in each */ \
14534                 sv_catpvs(sv, "^");             \
14535             do_sep = 0;                         \
14536         }                                       \
14537 } STMT_END
14538
14539 void
14540 Perl_regprop(pTHX_ const regexp *prog, SV *sv, const regnode *o)
14541 {
14542 #ifdef DEBUGGING
14543     dVAR;
14544     int k;
14545
14546     /* Should be synchronized with * ANYOF_ #xdefines in regcomp.h */
14547     static const char * const anyofs[] = {
14548 #if _CC_WORDCHAR != 0 || _CC_DIGIT != 1 || _CC_ALPHA != 2 || _CC_LOWER != 3 \
14549     || _CC_UPPER != 4 || _CC_PUNCT != 5 || _CC_PRINT != 6                   \
14550     || _CC_ALPHANUMERIC != 7 || _CC_GRAPH != 8 || _CC_CASED != 9            \
14551     || _CC_SPACE != 10 || _CC_BLANK != 11 || _CC_XDIGIT != 12               \
14552     || _CC_PSXSPC != 13 || _CC_CNTRL != 14 || _CC_ASCII != 15               \
14553     || _CC_VERTSPACE != 16
14554   #error Need to adjust order of anyofs[]
14555 #endif
14556         "[\\w]",
14557         "[\\W]",
14558         "[\\d]",
14559         "[\\D]",
14560         "[:alpha:]",
14561         "[:^alpha:]",
14562         "[:lower:]",
14563         "[:^lower:]",
14564         "[:upper:]",
14565         "[:^upper:]",
14566         "[:punct:]",
14567         "[:^punct:]",
14568         "[:print:]",
14569         "[:^print:]",
14570         "[:alnum:]",
14571         "[:^alnum:]",
14572         "[:graph:]",
14573         "[:^graph:]",
14574         "[:cased:]",
14575         "[:^cased:]",
14576         "[\\s]",
14577         "[\\S]",
14578         "[:blank:]",
14579         "[:^blank:]",
14580         "[:xdigit:]",
14581         "[:^xdigit:]",
14582         "[:space:]",
14583         "[:^space:]",
14584         "[:cntrl:]",
14585         "[:^cntrl:]",
14586         "[:ascii:]",
14587         "[:^ascii:]",
14588         "[\\v]",
14589         "[\\V]"
14590     };
14591     RXi_GET_DECL(prog,progi);
14592     GET_RE_DEBUG_FLAGS_DECL;
14593     
14594     PERL_ARGS_ASSERT_REGPROP;
14595
14596     sv_setpvs(sv, "");
14597
14598     if (OP(o) > REGNODE_MAX)            /* regnode.type is unsigned */
14599         /* It would be nice to FAIL() here, but this may be called from
14600            regexec.c, and it would be hard to supply pRExC_state. */
14601         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d", (int)OP(o), (int)REGNODE_MAX);
14602     sv_catpv(sv, PL_reg_name[OP(o)]); /* Take off const! */
14603
14604     k = PL_regkind[OP(o)];
14605
14606     if (k == EXACT) {
14607         sv_catpvs(sv, " ");
14608         /* Using is_utf8_string() (via PERL_PV_UNI_DETECT) 
14609          * is a crude hack but it may be the best for now since 
14610          * we have no flag "this EXACTish node was UTF-8" 
14611          * --jhi */
14612         pv_pretty(sv, STRING(o), STR_LEN(o), 60, PL_colors[0], PL_colors[1],
14613                   PERL_PV_ESCAPE_UNI_DETECT |
14614                   PERL_PV_ESCAPE_NONASCII   |
14615                   PERL_PV_PRETTY_ELLIPSES   |
14616                   PERL_PV_PRETTY_LTGT       |
14617                   PERL_PV_PRETTY_NOCLEAR
14618                   );
14619     } else if (k == TRIE) {
14620         /* print the details of the trie in dumpuntil instead, as
14621          * progi->data isn't available here */
14622         const char op = OP(o);
14623         const U32 n = ARG(o);
14624         const reg_ac_data * const ac = IS_TRIE_AC(op) ?
14625                (reg_ac_data *)progi->data->data[n] :
14626                NULL;
14627         const reg_trie_data * const trie
14628             = (reg_trie_data*)progi->data->data[!IS_TRIE_AC(op) ? n : ac->trie];
14629         
14630         Perl_sv_catpvf(aTHX_ sv, "-%s",PL_reg_name[o->flags]);
14631         DEBUG_TRIE_COMPILE_r(
14632             Perl_sv_catpvf(aTHX_ sv,
14633                 "<S:%"UVuf"/%"IVdf" W:%"UVuf" L:%"UVuf"/%"UVuf" C:%"UVuf"/%"UVuf">",
14634                 (UV)trie->startstate,
14635                 (IV)trie->statecount-1, /* -1 because of the unused 0 element */
14636                 (UV)trie->wordcount,
14637                 (UV)trie->minlen,
14638                 (UV)trie->maxlen,
14639                 (UV)TRIE_CHARCOUNT(trie),
14640                 (UV)trie->uniquecharcount
14641             )
14642         );
14643         if ( IS_ANYOF_TRIE(op) || trie->bitmap ) {
14644             int i;
14645             int rangestart = -1;
14646             U8* bitmap = IS_ANYOF_TRIE(op) ? (U8*)ANYOF_BITMAP(o) : (U8*)TRIE_BITMAP(trie);
14647             sv_catpvs(sv, "[");
14648             for (i = 0; i <= 256; i++) {
14649                 if (i < 256 && BITMAP_TEST(bitmap,i)) {
14650                     if (rangestart == -1)
14651                         rangestart = i;
14652                 } else if (rangestart != -1) {
14653                     if (i <= rangestart + 3)
14654                         for (; rangestart < i; rangestart++)
14655                             put_byte(sv, rangestart);
14656                     else {
14657                         put_byte(sv, rangestart);
14658                         sv_catpvs(sv, "-");
14659                         put_byte(sv, i - 1);
14660                     }
14661                     rangestart = -1;
14662                 }
14663             }
14664             sv_catpvs(sv, "]");
14665         } 
14666          
14667     } else if (k == CURLY) {
14668         if (OP(o) == CURLYM || OP(o) == CURLYN || OP(o) == CURLYX)
14669             Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags); /* Parenth number */
14670         Perl_sv_catpvf(aTHX_ sv, " {%d,%d}", ARG1(o), ARG2(o));
14671     }
14672     else if (k == WHILEM && o->flags)                   /* Ordinal/of */
14673         Perl_sv_catpvf(aTHX_ sv, "[%d/%d]", o->flags & 0xf, o->flags>>4);
14674     else if (k == REF || k == OPEN || k == CLOSE || k == GROUPP || OP(o)==ACCEPT) {
14675         Perl_sv_catpvf(aTHX_ sv, "%d", (int)ARG(o));    /* Parenth number */
14676         if ( RXp_PAREN_NAMES(prog) ) {
14677             if ( k != REF || (OP(o) < NREF)) {
14678                 AV *list= MUTABLE_AV(progi->data->data[progi->name_list_idx]);
14679                 SV **name= av_fetch(list, ARG(o), 0 );
14680                 if (name)
14681                     Perl_sv_catpvf(aTHX_ sv, " '%"SVf"'", SVfARG(*name));
14682             }       
14683             else {
14684                 AV *list= MUTABLE_AV(progi->data->data[ progi->name_list_idx ]);
14685                 SV *sv_dat= MUTABLE_SV(progi->data->data[ ARG( o ) ]);
14686                 I32 *nums=(I32*)SvPVX(sv_dat);
14687                 SV **name= av_fetch(list, nums[0], 0 );
14688                 I32 n;
14689                 if (name) {
14690                     for ( n=0; n<SvIVX(sv_dat); n++ ) {
14691                         Perl_sv_catpvf(aTHX_ sv, "%s%"IVdf,
14692                                     (n ? "," : ""), (IV)nums[n]);
14693                     }
14694                     Perl_sv_catpvf(aTHX_ sv, " '%"SVf"'", SVfARG(*name));
14695                 }
14696             }
14697         }            
14698     } else if (k == GOSUB) 
14699         Perl_sv_catpvf(aTHX_ sv, "%d[%+d]", (int)ARG(o),(int)ARG2L(o)); /* Paren and offset */
14700     else if (k == VERB) {
14701         if (!o->flags) 
14702             Perl_sv_catpvf(aTHX_ sv, ":%"SVf, 
14703                            SVfARG((MUTABLE_SV(progi->data->data[ ARG( o ) ]))));
14704     } else if (k == LOGICAL)
14705         Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags);     /* 2: embedded, otherwise 1 */
14706     else if (k == ANYOF) {
14707         int i, rangestart = -1;
14708         const U8 flags = ANYOF_FLAGS(o);
14709         int do_sep = 0;
14710
14711
14712         if (flags & ANYOF_LOCALE)
14713             sv_catpvs(sv, "{loc}");
14714         if (flags & ANYOF_LOC_FOLD)
14715             sv_catpvs(sv, "{i}");
14716         Perl_sv_catpvf(aTHX_ sv, "[%s", PL_colors[0]);
14717         if (flags & ANYOF_INVERT)
14718             sv_catpvs(sv, "^");
14719
14720         /* output what the standard cp 0-255 bitmap matches */
14721         for (i = 0; i <= 256; i++) {
14722             if (i < 256 && ANYOF_BITMAP_TEST(o,i)) {
14723                 if (rangestart == -1)
14724                     rangestart = i;
14725             } else if (rangestart != -1) {
14726                 if (i <= rangestart + 3)
14727                     for (; rangestart < i; rangestart++)
14728                         put_byte(sv, rangestart);
14729                 else {
14730                     put_byte(sv, rangestart);
14731                     sv_catpvs(sv, "-");
14732                     put_byte(sv, i - 1);
14733                 }
14734                 do_sep = 1;
14735                 rangestart = -1;
14736             }
14737         }
14738         
14739         EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags);
14740         /* output any special charclass tests (used entirely under use locale) */
14741         if (ANYOF_CLASS_TEST_ANY_SET(o))
14742             for (i = 0; i < (int)(sizeof(anyofs)/sizeof(char*)); i++)
14743                 if (ANYOF_CLASS_TEST(o,i)) {
14744                     sv_catpv(sv, anyofs[i]);
14745                     do_sep = 1;
14746                 }
14747         
14748         EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags);
14749         
14750         if (flags & ANYOF_NON_UTF8_LATIN1_ALL) {
14751             sv_catpvs(sv, "{non-utf8-latin1-all}");
14752         }
14753
14754         /* output information about the unicode matching */
14755         if (flags & ANYOF_UNICODE_ALL)
14756             sv_catpvs(sv, "{unicode_all}");
14757         else if (ANYOF_NONBITMAP(o))
14758             sv_catpvs(sv, "{unicode}");
14759         if (flags & ANYOF_NONBITMAP_NON_UTF8)
14760             sv_catpvs(sv, "{outside bitmap}");
14761
14762         if (ANYOF_NONBITMAP(o)) {
14763             SV *lv; /* Set if there is something outside the bit map */
14764             SV * const sw = regclass_swash(prog, o, FALSE, &lv, NULL);
14765             bool byte_output = FALSE;   /* If something in the bitmap has been
14766                                            output */
14767
14768             if (lv && lv != &PL_sv_undef) {
14769                 if (sw) {
14770                     U8 s[UTF8_MAXBYTES_CASE+1];
14771
14772                     for (i = 0; i <= 256; i++) { /* Look at chars in bitmap */
14773                         uvchr_to_utf8(s, i);
14774
14775                         if (i < 256
14776                             && ! ANYOF_BITMAP_TEST(o, i)    /* Don't duplicate
14777                                                                things already
14778                                                                output as part
14779                                                                of the bitmap */
14780                             && swash_fetch(sw, s, TRUE))
14781                         {
14782                             if (rangestart == -1)
14783                                 rangestart = i;
14784                         } else if (rangestart != -1) {
14785                             byte_output = TRUE;
14786                             if (i <= rangestart + 3)
14787                                 for (; rangestart < i; rangestart++) {
14788                                     put_byte(sv, rangestart);
14789                                 }
14790                             else {
14791                                 put_byte(sv, rangestart);
14792                                 sv_catpvs(sv, "-");
14793                                 put_byte(sv, i-1);
14794                             }
14795                             rangestart = -1;
14796                         }
14797                     }
14798                 }
14799
14800                 {
14801                     char *s = savesvpv(lv);
14802                     char * const origs = s;
14803
14804                     while (*s && *s != '\n')
14805                         s++;
14806
14807                     if (*s == '\n') {
14808                         const char * const t = ++s;
14809
14810                         if (byte_output) {
14811                             sv_catpvs(sv, " ");
14812                         }
14813
14814                         while (*s) {
14815                             if (*s == '\n') {
14816
14817                                 /* Truncate very long output */
14818                                 if (s - origs > 256) {
14819                                     Perl_sv_catpvf(aTHX_ sv,
14820                                                    "%.*s...",
14821                                                    (int) (s - origs - 1),
14822                                                    t);
14823                                     goto out_dump;
14824                                 }
14825                                 *s = ' ';
14826                             }
14827                             else if (*s == '\t') {
14828                                 *s = '-';
14829                             }
14830                             s++;
14831                         }
14832                         if (s[-1] == ' ')
14833                             s[-1] = 0;
14834
14835                         sv_catpv(sv, t);
14836                     }
14837
14838                 out_dump:
14839
14840                     Safefree(origs);
14841                 }
14842                 SvREFCNT_dec_NN(lv);
14843             }
14844         }
14845
14846         Perl_sv_catpvf(aTHX_ sv, "%s]", PL_colors[1]);
14847     }
14848     else if (k == POSIXD || k == NPOSIXD) {
14849         U8 index = FLAGS(o) * 2;
14850         if (index > (sizeof(anyofs) / sizeof(anyofs[0]))) {
14851             Perl_sv_catpvf(aTHX_ sv, "[illegal type=%d])", index);
14852         }
14853         else {
14854             sv_catpv(sv, anyofs[index]);
14855         }
14856     }
14857     else if (k == BRANCHJ && (OP(o) == UNLESSM || OP(o) == IFMATCH))
14858         Perl_sv_catpvf(aTHX_ sv, "[%d]", -(o->flags));
14859 #else
14860     PERL_UNUSED_CONTEXT;
14861     PERL_UNUSED_ARG(sv);
14862     PERL_UNUSED_ARG(o);
14863     PERL_UNUSED_ARG(prog);
14864 #endif  /* DEBUGGING */
14865 }
14866
14867 SV *
14868 Perl_re_intuit_string(pTHX_ REGEXP * const r)
14869 {                               /* Assume that RE_INTUIT is set */
14870     dVAR;
14871     struct regexp *const prog = ReANY(r);
14872     GET_RE_DEBUG_FLAGS_DECL;
14873
14874     PERL_ARGS_ASSERT_RE_INTUIT_STRING;
14875     PERL_UNUSED_CONTEXT;
14876
14877     DEBUG_COMPILE_r(
14878         {
14879             const char * const s = SvPV_nolen_const(prog->check_substr
14880                       ? prog->check_substr : prog->check_utf8);
14881
14882             if (!PL_colorset) reginitcolors();
14883             PerlIO_printf(Perl_debug_log,
14884                       "%sUsing REx %ssubstr:%s \"%s%.60s%s%s\"\n",
14885                       PL_colors[4],
14886                       prog->check_substr ? "" : "utf8 ",
14887                       PL_colors[5],PL_colors[0],
14888                       s,
14889                       PL_colors[1],
14890                       (strlen(s) > 60 ? "..." : ""));
14891         } );
14892
14893     return prog->check_substr ? prog->check_substr : prog->check_utf8;
14894 }
14895
14896 /* 
14897    pregfree() 
14898    
14899    handles refcounting and freeing the perl core regexp structure. When 
14900    it is necessary to actually free the structure the first thing it 
14901    does is call the 'free' method of the regexp_engine associated to
14902    the regexp, allowing the handling of the void *pprivate; member 
14903    first. (This routine is not overridable by extensions, which is why 
14904    the extensions free is called first.)
14905    
14906    See regdupe and regdupe_internal if you change anything here. 
14907 */
14908 #ifndef PERL_IN_XSUB_RE
14909 void
14910 Perl_pregfree(pTHX_ REGEXP *r)
14911 {
14912     SvREFCNT_dec(r);
14913 }
14914
14915 void
14916 Perl_pregfree2(pTHX_ REGEXP *rx)
14917 {
14918     dVAR;
14919     struct regexp *const r = ReANY(rx);
14920     GET_RE_DEBUG_FLAGS_DECL;
14921
14922     PERL_ARGS_ASSERT_PREGFREE2;
14923
14924     if (r->mother_re) {
14925         ReREFCNT_dec(r->mother_re);
14926     } else {
14927         CALLREGFREE_PVT(rx); /* free the private data */
14928         SvREFCNT_dec(RXp_PAREN_NAMES(r));
14929         Safefree(r->xpv_len_u.xpvlenu_pv);
14930     }        
14931     if (r->substrs) {
14932         SvREFCNT_dec(r->anchored_substr);
14933         SvREFCNT_dec(r->anchored_utf8);
14934         SvREFCNT_dec(r->float_substr);
14935         SvREFCNT_dec(r->float_utf8);
14936         Safefree(r->substrs);
14937     }
14938     RX_MATCH_COPY_FREE(rx);
14939 #ifdef PERL_ANY_COW
14940     SvREFCNT_dec(r->saved_copy);
14941 #endif
14942     Safefree(r->offs);
14943     SvREFCNT_dec(r->qr_anoncv);
14944     rx->sv_u.svu_rx = 0;
14945 }
14946
14947 /*  reg_temp_copy()
14948     
14949     This is a hacky workaround to the structural issue of match results
14950     being stored in the regexp structure which is in turn stored in
14951     PL_curpm/PL_reg_curpm. The problem is that due to qr// the pattern
14952     could be PL_curpm in multiple contexts, and could require multiple
14953     result sets being associated with the pattern simultaneously, such
14954     as when doing a recursive match with (??{$qr})
14955     
14956     The solution is to make a lightweight copy of the regexp structure 
14957     when a qr// is returned from the code executed by (??{$qr}) this
14958     lightweight copy doesn't actually own any of its data except for
14959     the starp/end and the actual regexp structure itself. 
14960     
14961 */    
14962     
14963     
14964 REGEXP *
14965 Perl_reg_temp_copy (pTHX_ REGEXP *ret_x, REGEXP *rx)
14966 {
14967     struct regexp *ret;
14968     struct regexp *const r = ReANY(rx);
14969     const bool islv = ret_x && SvTYPE(ret_x) == SVt_PVLV;
14970
14971     PERL_ARGS_ASSERT_REG_TEMP_COPY;
14972
14973     if (!ret_x)
14974         ret_x = (REGEXP*) newSV_type(SVt_REGEXP);
14975     else {
14976         SvOK_off((SV *)ret_x);
14977         if (islv) {
14978             /* For PVLVs, SvANY points to the xpvlv body while sv_u points
14979                to the regexp.  (For SVt_REGEXPs, sv_upgrade has already
14980                made both spots point to the same regexp body.) */
14981             REGEXP *temp = (REGEXP *)newSV_type(SVt_REGEXP);
14982             assert(!SvPVX(ret_x));
14983             ret_x->sv_u.svu_rx = temp->sv_any;
14984             temp->sv_any = NULL;
14985             SvFLAGS(temp) = (SvFLAGS(temp) & ~SVTYPEMASK) | SVt_NULL;
14986             SvREFCNT_dec_NN(temp);
14987             /* SvCUR still resides in the xpvlv struct, so the regexp copy-
14988                ing below will not set it. */
14989             SvCUR_set(ret_x, SvCUR(rx));
14990         }
14991     }
14992     /* This ensures that SvTHINKFIRST(sv) is true, and hence that
14993        sv_force_normal(sv) is called.  */
14994     SvFAKE_on(ret_x);
14995     ret = ReANY(ret_x);
14996     
14997     SvFLAGS(ret_x) |= SvUTF8(rx);
14998     /* We share the same string buffer as the original regexp, on which we
14999        hold a reference count, incremented when mother_re is set below.
15000        The string pointer is copied here, being part of the regexp struct.
15001      */
15002     memcpy(&(ret->xpv_cur), &(r->xpv_cur),
15003            sizeof(regexp) - STRUCT_OFFSET(regexp, xpv_cur));
15004     if (r->offs) {
15005         const I32 npar = r->nparens+1;
15006         Newx(ret->offs, npar, regexp_paren_pair);
15007         Copy(r->offs, ret->offs, npar, regexp_paren_pair);
15008     }
15009     if (r->substrs) {
15010         Newx(ret->substrs, 1, struct reg_substr_data);
15011         StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
15012
15013         SvREFCNT_inc_void(ret->anchored_substr);
15014         SvREFCNT_inc_void(ret->anchored_utf8);
15015         SvREFCNT_inc_void(ret->float_substr);
15016         SvREFCNT_inc_void(ret->float_utf8);
15017
15018         /* check_substr and check_utf8, if non-NULL, point to either their
15019            anchored or float namesakes, and don't hold a second reference.  */
15020     }
15021     RX_MATCH_COPIED_off(ret_x);
15022 #ifdef PERL_ANY_COW
15023     ret->saved_copy = NULL;
15024 #endif
15025     ret->mother_re = ReREFCNT_inc(r->mother_re ? r->mother_re : rx);
15026     SvREFCNT_inc_void(ret->qr_anoncv);
15027     
15028     return ret_x;
15029 }
15030 #endif
15031
15032 /* regfree_internal() 
15033
15034    Free the private data in a regexp. This is overloadable by 
15035    extensions. Perl takes care of the regexp structure in pregfree(), 
15036    this covers the *pprivate pointer which technically perl doesn't 
15037    know about, however of course we have to handle the 
15038    regexp_internal structure when no extension is in use. 
15039    
15040    Note this is called before freeing anything in the regexp 
15041    structure. 
15042  */
15043  
15044 void
15045 Perl_regfree_internal(pTHX_ REGEXP * const rx)
15046 {
15047     dVAR;
15048     struct regexp *const r = ReANY(rx);
15049     RXi_GET_DECL(r,ri);
15050     GET_RE_DEBUG_FLAGS_DECL;
15051
15052     PERL_ARGS_ASSERT_REGFREE_INTERNAL;
15053
15054     DEBUG_COMPILE_r({
15055         if (!PL_colorset)
15056             reginitcolors();
15057         {
15058             SV *dsv= sv_newmortal();
15059             RE_PV_QUOTED_DECL(s, RX_UTF8(rx),
15060                 dsv, RX_PRECOMP(rx), RX_PRELEN(rx), 60);
15061             PerlIO_printf(Perl_debug_log,"%sFreeing REx:%s %s\n", 
15062                 PL_colors[4],PL_colors[5],s);
15063         }
15064     });
15065 #ifdef RE_TRACK_PATTERN_OFFSETS
15066     if (ri->u.offsets)
15067         Safefree(ri->u.offsets);             /* 20010421 MJD */
15068 #endif
15069     if (ri->code_blocks) {
15070         int n;
15071         for (n = 0; n < ri->num_code_blocks; n++)
15072             SvREFCNT_dec(ri->code_blocks[n].src_regex);
15073         Safefree(ri->code_blocks);
15074     }
15075
15076     if (ri->data) {
15077         int n = ri->data->count;
15078
15079         while (--n >= 0) {
15080           /* If you add a ->what type here, update the comment in regcomp.h */
15081             switch (ri->data->what[n]) {
15082             case 'a':
15083             case 'r':
15084             case 's':
15085             case 'S':
15086             case 'u':
15087                 SvREFCNT_dec(MUTABLE_SV(ri->data->data[n]));
15088                 break;
15089             case 'f':
15090                 Safefree(ri->data->data[n]);
15091                 break;
15092             case 'l':
15093             case 'L':
15094                 break;
15095             case 'T':           
15096                 { /* Aho Corasick add-on structure for a trie node.
15097                      Used in stclass optimization only */
15098                     U32 refcount;
15099                     reg_ac_data *aho=(reg_ac_data*)ri->data->data[n];
15100                     OP_REFCNT_LOCK;
15101                     refcount = --aho->refcount;
15102                     OP_REFCNT_UNLOCK;
15103                     if ( !refcount ) {
15104                         PerlMemShared_free(aho->states);
15105                         PerlMemShared_free(aho->fail);
15106                          /* do this last!!!! */
15107                         PerlMemShared_free(ri->data->data[n]);
15108                         PerlMemShared_free(ri->regstclass);
15109                     }
15110                 }
15111                 break;
15112             case 't':
15113                 {
15114                     /* trie structure. */
15115                     U32 refcount;
15116                     reg_trie_data *trie=(reg_trie_data*)ri->data->data[n];
15117                     OP_REFCNT_LOCK;
15118                     refcount = --trie->refcount;
15119                     OP_REFCNT_UNLOCK;
15120                     if ( !refcount ) {
15121                         PerlMemShared_free(trie->charmap);
15122                         PerlMemShared_free(trie->states);
15123                         PerlMemShared_free(trie->trans);
15124                         if (trie->bitmap)
15125                             PerlMemShared_free(trie->bitmap);
15126                         if (trie->jump)
15127                             PerlMemShared_free(trie->jump);
15128                         PerlMemShared_free(trie->wordinfo);
15129                         /* do this last!!!! */
15130                         PerlMemShared_free(ri->data->data[n]);
15131                     }
15132                 }
15133                 break;
15134             default:
15135                 Perl_croak(aTHX_ "panic: regfree data code '%c'", ri->data->what[n]);
15136             }
15137         }
15138         Safefree(ri->data->what);
15139         Safefree(ri->data);
15140     }
15141
15142     Safefree(ri);
15143 }
15144
15145 #define av_dup_inc(s,t) MUTABLE_AV(sv_dup_inc((const SV *)s,t))
15146 #define hv_dup_inc(s,t) MUTABLE_HV(sv_dup_inc((const SV *)s,t))
15147 #define SAVEPVN(p,n)    ((p) ? savepvn(p,n) : NULL)
15148
15149 /* 
15150    re_dup - duplicate a regexp. 
15151    
15152    This routine is expected to clone a given regexp structure. It is only
15153    compiled under USE_ITHREADS.
15154
15155    After all of the core data stored in struct regexp is duplicated
15156    the regexp_engine.dupe method is used to copy any private data
15157    stored in the *pprivate pointer. This allows extensions to handle
15158    any duplication it needs to do.
15159
15160    See pregfree() and regfree_internal() if you change anything here. 
15161 */
15162 #if defined(USE_ITHREADS)
15163 #ifndef PERL_IN_XSUB_RE
15164 void
15165 Perl_re_dup_guts(pTHX_ const REGEXP *sstr, REGEXP *dstr, CLONE_PARAMS *param)
15166 {
15167     dVAR;
15168     I32 npar;
15169     const struct regexp *r = ReANY(sstr);
15170     struct regexp *ret = ReANY(dstr);
15171     
15172     PERL_ARGS_ASSERT_RE_DUP_GUTS;
15173
15174     npar = r->nparens+1;
15175     Newx(ret->offs, npar, regexp_paren_pair);
15176     Copy(r->offs, ret->offs, npar, regexp_paren_pair);
15177
15178     if (ret->substrs) {
15179         /* Do it this way to avoid reading from *r after the StructCopy().
15180            That way, if any of the sv_dup_inc()s dislodge *r from the L1
15181            cache, it doesn't matter.  */
15182         const bool anchored = r->check_substr
15183             ? r->check_substr == r->anchored_substr
15184             : r->check_utf8 == r->anchored_utf8;
15185         Newx(ret->substrs, 1, struct reg_substr_data);
15186         StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
15187
15188         ret->anchored_substr = sv_dup_inc(ret->anchored_substr, param);
15189         ret->anchored_utf8 = sv_dup_inc(ret->anchored_utf8, param);
15190         ret->float_substr = sv_dup_inc(ret->float_substr, param);
15191         ret->float_utf8 = sv_dup_inc(ret->float_utf8, param);
15192
15193         /* check_substr and check_utf8, if non-NULL, point to either their
15194            anchored or float namesakes, and don't hold a second reference.  */
15195
15196         if (ret->check_substr) {
15197             if (anchored) {
15198                 assert(r->check_utf8 == r->anchored_utf8);
15199                 ret->check_substr = ret->anchored_substr;
15200                 ret->check_utf8 = ret->anchored_utf8;
15201             } else {
15202                 assert(r->check_substr == r->float_substr);
15203                 assert(r->check_utf8 == r->float_utf8);
15204                 ret->check_substr = ret->float_substr;
15205                 ret->check_utf8 = ret->float_utf8;
15206             }
15207         } else if (ret->check_utf8) {
15208             if (anchored) {
15209                 ret->check_utf8 = ret->anchored_utf8;
15210             } else {
15211                 ret->check_utf8 = ret->float_utf8;
15212             }
15213         }
15214     }
15215
15216     RXp_PAREN_NAMES(ret) = hv_dup_inc(RXp_PAREN_NAMES(ret), param);
15217     ret->qr_anoncv = MUTABLE_CV(sv_dup_inc((const SV *)ret->qr_anoncv, param));
15218
15219     if (ret->pprivate)
15220         RXi_SET(ret,CALLREGDUPE_PVT(dstr,param));
15221
15222     if (RX_MATCH_COPIED(dstr))
15223         ret->subbeg  = SAVEPVN(ret->subbeg, ret->sublen);
15224     else
15225         ret->subbeg = NULL;
15226 #ifdef PERL_ANY_COW
15227     ret->saved_copy = NULL;
15228 #endif
15229
15230     /* Whether mother_re be set or no, we need to copy the string.  We
15231        cannot refrain from copying it when the storage points directly to
15232        our mother regexp, because that's
15233                1: a buffer in a different thread
15234                2: something we no longer hold a reference on
15235                so we need to copy it locally.  */
15236     RX_WRAPPED(dstr) = SAVEPVN(RX_WRAPPED(sstr), SvCUR(sstr)+1);
15237     ret->mother_re   = NULL;
15238     ret->gofs = 0;
15239 }
15240 #endif /* PERL_IN_XSUB_RE */
15241
15242 /*
15243    regdupe_internal()
15244    
15245    This is the internal complement to regdupe() which is used to copy
15246    the structure pointed to by the *pprivate pointer in the regexp.
15247    This is the core version of the extension overridable cloning hook.
15248    The regexp structure being duplicated will be copied by perl prior
15249    to this and will be provided as the regexp *r argument, however 
15250    with the /old/ structures pprivate pointer value. Thus this routine
15251    may override any copying normally done by perl.
15252    
15253    It returns a pointer to the new regexp_internal structure.
15254 */
15255
15256 void *
15257 Perl_regdupe_internal(pTHX_ REGEXP * const rx, CLONE_PARAMS *param)
15258 {
15259     dVAR;
15260     struct regexp *const r = ReANY(rx);
15261     regexp_internal *reti;
15262     int len;
15263     RXi_GET_DECL(r,ri);
15264
15265     PERL_ARGS_ASSERT_REGDUPE_INTERNAL;
15266     
15267     len = ProgLen(ri);
15268     
15269     Newxc(reti, sizeof(regexp_internal) + len*sizeof(regnode), char, regexp_internal);
15270     Copy(ri->program, reti->program, len+1, regnode);
15271
15272     reti->num_code_blocks = ri->num_code_blocks;
15273     if (ri->code_blocks) {
15274         int n;
15275         Newxc(reti->code_blocks, ri->num_code_blocks, struct reg_code_block,
15276                 struct reg_code_block);
15277         Copy(ri->code_blocks, reti->code_blocks, ri->num_code_blocks,
15278                 struct reg_code_block);
15279         for (n = 0; n < ri->num_code_blocks; n++)
15280              reti->code_blocks[n].src_regex = (REGEXP*)
15281                     sv_dup_inc((SV*)(ri->code_blocks[n].src_regex), param);
15282     }
15283     else
15284         reti->code_blocks = NULL;
15285
15286     reti->regstclass = NULL;
15287
15288     if (ri->data) {
15289         struct reg_data *d;
15290         const int count = ri->data->count;
15291         int i;
15292
15293         Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
15294                 char, struct reg_data);
15295         Newx(d->what, count, U8);
15296
15297         d->count = count;
15298         for (i = 0; i < count; i++) {
15299             d->what[i] = ri->data->what[i];
15300             switch (d->what[i]) {
15301                 /* see also regcomp.h and regfree_internal() */
15302             case 'a': /* actually an AV, but the dup function is identical.  */
15303             case 'r':
15304             case 's':
15305             case 'S':
15306             case 'u': /* actually an HV, but the dup function is identical.  */
15307                 d->data[i] = sv_dup_inc((const SV *)ri->data->data[i], param);
15308                 break;
15309             case 'f':
15310                 /* This is cheating. */
15311                 Newx(d->data[i], 1, struct regnode_charclass_class);
15312                 StructCopy(ri->data->data[i], d->data[i],
15313                             struct regnode_charclass_class);
15314                 reti->regstclass = (regnode*)d->data[i];
15315                 break;
15316             case 'T':
15317                 /* Trie stclasses are readonly and can thus be shared
15318                  * without duplication. We free the stclass in pregfree
15319                  * when the corresponding reg_ac_data struct is freed.
15320                  */
15321                 reti->regstclass= ri->regstclass;
15322                 /* Fall through */
15323             case 't':
15324                 OP_REFCNT_LOCK;
15325                 ((reg_trie_data*)ri->data->data[i])->refcount++;
15326                 OP_REFCNT_UNLOCK;
15327                 /* Fall through */
15328             case 'l':
15329             case 'L':
15330                 d->data[i] = ri->data->data[i];
15331                 break;
15332             default:
15333                 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", ri->data->what[i]);
15334             }
15335         }
15336
15337         reti->data = d;
15338     }
15339     else
15340         reti->data = NULL;
15341
15342     reti->name_list_idx = ri->name_list_idx;
15343
15344 #ifdef RE_TRACK_PATTERN_OFFSETS
15345     if (ri->u.offsets) {
15346         Newx(reti->u.offsets, 2*len+1, U32);
15347         Copy(ri->u.offsets, reti->u.offsets, 2*len+1, U32);
15348     }
15349 #else
15350     SetProgLen(reti,len);
15351 #endif
15352
15353     return (void*)reti;
15354 }
15355
15356 #endif    /* USE_ITHREADS */
15357
15358 #ifndef PERL_IN_XSUB_RE
15359
15360 /*
15361  - regnext - dig the "next" pointer out of a node
15362  */
15363 regnode *
15364 Perl_regnext(pTHX_ regnode *p)
15365 {
15366     dVAR;
15367     I32 offset;
15368
15369     if (!p)
15370         return(NULL);
15371
15372     if (OP(p) > REGNODE_MAX) {          /* regnode.type is unsigned */
15373         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d", (int)OP(p), (int)REGNODE_MAX);
15374     }
15375
15376     offset = (reg_off_by_arg[OP(p)] ? ARG(p) : NEXT_OFF(p));
15377     if (offset == 0)
15378         return(NULL);
15379
15380     return(p+offset);
15381 }
15382 #endif
15383
15384 STATIC void
15385 S_re_croak2(pTHX_ const char* pat1,const char* pat2,...)
15386 {
15387     va_list args;
15388     STRLEN l1 = strlen(pat1);
15389     STRLEN l2 = strlen(pat2);
15390     char buf[512];
15391     SV *msv;
15392     const char *message;
15393
15394     PERL_ARGS_ASSERT_RE_CROAK2;
15395
15396     if (l1 > 510)
15397         l1 = 510;
15398     if (l1 + l2 > 510)
15399         l2 = 510 - l1;
15400     Copy(pat1, buf, l1 , char);
15401     Copy(pat2, buf + l1, l2 , char);
15402     buf[l1 + l2] = '\n';
15403     buf[l1 + l2 + 1] = '\0';
15404 #ifdef I_STDARG
15405     /* ANSI variant takes additional second argument */
15406     va_start(args, pat2);
15407 #else
15408     va_start(args);
15409 #endif
15410     msv = vmess(buf, &args);
15411     va_end(args);
15412     message = SvPV_const(msv,l1);
15413     if (l1 > 512)
15414         l1 = 512;
15415     Copy(message, buf, l1 , char);
15416     buf[l1-1] = '\0';                   /* Overwrite \n */
15417     Perl_croak(aTHX_ "%s", buf);
15418 }
15419
15420 /* XXX Here's a total kludge.  But we need to re-enter for swash routines. */
15421
15422 #ifndef PERL_IN_XSUB_RE
15423 void
15424 Perl_save_re_context(pTHX)
15425 {
15426     dVAR;
15427
15428     struct re_save_state *state;
15429
15430     SAVEVPTR(PL_curcop);
15431     SSGROW(SAVESTACK_ALLOC_FOR_RE_SAVE_STATE + 1);
15432
15433     state = (struct re_save_state *)(PL_savestack + PL_savestack_ix);
15434     PL_savestack_ix += SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
15435     SSPUSHUV(SAVEt_RE_STATE);
15436
15437     Copy(&PL_reg_state, state, 1, struct re_save_state);
15438
15439     PL_reg_oldsaved = NULL;
15440     PL_reg_oldsavedlen = 0;
15441     PL_reg_oldsavedoffset = 0;
15442     PL_reg_oldsavedcoffset = 0;
15443     PL_reg_maxiter = 0;
15444     PL_reg_leftiter = 0;
15445     PL_reg_poscache = NULL;
15446     PL_reg_poscache_size = 0;
15447 #ifdef PERL_ANY_COW
15448     PL_nrs = NULL;
15449 #endif
15450
15451     /* Save $1..$n (#18107: UTF-8 s/(\w+)/uc($1)/e); AMS 20021106. */
15452     if (PL_curpm) {
15453         const REGEXP * const rx = PM_GETRE(PL_curpm);
15454         if (rx) {
15455             U32 i;
15456             for (i = 1; i <= RX_NPARENS(rx); i++) {
15457                 char digits[TYPE_CHARS(long)];
15458                 const STRLEN len = my_snprintf(digits, sizeof(digits), "%lu", (long)i);
15459                 GV *const *const gvp
15460                     = (GV**)hv_fetch(PL_defstash, digits, len, 0);
15461
15462                 if (gvp) {
15463                     GV * const gv = *gvp;
15464                     if (SvTYPE(gv) == SVt_PVGV && GvSV(gv))
15465                         save_scalar(gv);
15466                 }
15467             }
15468         }
15469     }
15470 }
15471 #endif
15472
15473 #ifdef DEBUGGING
15474
15475 STATIC void
15476 S_put_byte(pTHX_ SV *sv, int c)
15477 {
15478     PERL_ARGS_ASSERT_PUT_BYTE;
15479
15480     /* Our definition of isPRINT() ignores locales, so only bytes that are
15481        not part of UTF-8 are considered printable. I assume that the same
15482        holds for UTF-EBCDIC.
15483        Also, code point 255 is not printable in either (it's E0 in EBCDIC,
15484        which Wikipedia says:
15485
15486        EO, or Eight Ones, is an 8-bit EBCDIC character code represented as all
15487        ones (binary 1111 1111, hexadecimal FF). It is similar, but not
15488        identical, to the ASCII delete (DEL) or rubout control character. ...
15489        it is typically mapped to hexadecimal code 9F, in order to provide a
15490        unique character mapping in both directions)
15491
15492        So the old condition can be simplified to !isPRINT(c)  */
15493     if (!isPRINT(c)) {
15494         if (c < 256) {
15495             Perl_sv_catpvf(aTHX_ sv, "\\x%02x", c);
15496         }
15497         else {
15498             Perl_sv_catpvf(aTHX_ sv, "\\x{%x}", c);
15499         }
15500     }
15501     else {
15502         const char string = c;
15503         if (c == '-' || c == ']' || c == '\\' || c == '^')
15504             sv_catpvs(sv, "\\");
15505         sv_catpvn(sv, &string, 1);
15506     }
15507 }
15508
15509
15510 #define CLEAR_OPTSTART \
15511     if (optstart) STMT_START { \
15512             DEBUG_OPTIMISE_r(PerlIO_printf(Perl_debug_log, " (%"IVdf" nodes)\n", (IV)(node - optstart))); \
15513             optstart=NULL; \
15514     } STMT_END
15515
15516 #define DUMPUNTIL(b,e) CLEAR_OPTSTART; node=dumpuntil(r,start,(b),(e),last,sv,indent+1,depth+1);
15517
15518 STATIC const regnode *
15519 S_dumpuntil(pTHX_ const regexp *r, const regnode *start, const regnode *node,
15520             const regnode *last, const regnode *plast, 
15521             SV* sv, I32 indent, U32 depth)
15522 {
15523     dVAR;
15524     U8 op = PSEUDO;     /* Arbitrary non-END op. */
15525     const regnode *next;
15526     const regnode *optstart= NULL;
15527     
15528     RXi_GET_DECL(r,ri);
15529     GET_RE_DEBUG_FLAGS_DECL;
15530
15531     PERL_ARGS_ASSERT_DUMPUNTIL;
15532
15533 #ifdef DEBUG_DUMPUNTIL
15534     PerlIO_printf(Perl_debug_log, "--- %d : %d - %d - %d\n",indent,node-start,
15535         last ? last-start : 0,plast ? plast-start : 0);
15536 #endif
15537             
15538     if (plast && plast < last) 
15539         last= plast;
15540
15541     while (PL_regkind[op] != END && (!last || node < last)) {
15542         /* While that wasn't END last time... */
15543         NODE_ALIGN(node);
15544         op = OP(node);
15545         if (op == CLOSE || op == WHILEM)
15546             indent--;
15547         next = regnext((regnode *)node);
15548
15549         /* Where, what. */
15550         if (OP(node) == OPTIMIZED) {
15551             if (!optstart && RE_DEBUG_FLAG(RE_DEBUG_COMPILE_OPTIMISE))
15552                 optstart = node;
15553             else
15554                 goto after_print;
15555         } else
15556             CLEAR_OPTSTART;
15557
15558         regprop(r, sv, node);
15559         PerlIO_printf(Perl_debug_log, "%4"IVdf":%*s%s", (IV)(node - start),
15560                       (int)(2*indent + 1), "", SvPVX_const(sv));
15561         
15562         if (OP(node) != OPTIMIZED) {                  
15563             if (next == NULL)           /* Next ptr. */
15564                 PerlIO_printf(Perl_debug_log, " (0)");
15565             else if (PL_regkind[(U8)op] == BRANCH && PL_regkind[OP(next)] != BRANCH )
15566                 PerlIO_printf(Perl_debug_log, " (FAIL)");
15567             else 
15568                 PerlIO_printf(Perl_debug_log, " (%"IVdf")", (IV)(next - start));
15569             (void)PerlIO_putc(Perl_debug_log, '\n'); 
15570         }
15571         
15572       after_print:
15573         if (PL_regkind[(U8)op] == BRANCHJ) {
15574             assert(next);
15575             {
15576                 const regnode *nnode = (OP(next) == LONGJMP
15577                                        ? regnext((regnode *)next)
15578                                        : next);
15579                 if (last && nnode > last)
15580                     nnode = last;
15581                 DUMPUNTIL(NEXTOPER(NEXTOPER(node)), nnode);
15582             }
15583         }
15584         else if (PL_regkind[(U8)op] == BRANCH) {
15585             assert(next);
15586             DUMPUNTIL(NEXTOPER(node), next);
15587         }
15588         else if ( PL_regkind[(U8)op]  == TRIE ) {
15589             const regnode *this_trie = node;
15590             const char op = OP(node);
15591             const U32 n = ARG(node);
15592             const reg_ac_data * const ac = op>=AHOCORASICK ?
15593                (reg_ac_data *)ri->data->data[n] :
15594                NULL;
15595             const reg_trie_data * const trie =
15596                 (reg_trie_data*)ri->data->data[op<AHOCORASICK ? n : ac->trie];
15597 #ifdef DEBUGGING
15598             AV *const trie_words = MUTABLE_AV(ri->data->data[n + TRIE_WORDS_OFFSET]);
15599 #endif
15600             const regnode *nextbranch= NULL;
15601             I32 word_idx;
15602             sv_setpvs(sv, "");
15603             for (word_idx= 0; word_idx < (I32)trie->wordcount; word_idx++) {
15604                 SV ** const elem_ptr = av_fetch(trie_words,word_idx,0);
15605
15606                 PerlIO_printf(Perl_debug_log, "%*s%s ",
15607                    (int)(2*(indent+3)), "",
15608                     elem_ptr ? pv_pretty(sv, SvPV_nolen_const(*elem_ptr), SvCUR(*elem_ptr), 60,
15609                             PL_colors[0], PL_colors[1],
15610                             (SvUTF8(*elem_ptr) ? PERL_PV_ESCAPE_UNI : 0) |
15611                             PERL_PV_PRETTY_ELLIPSES    |
15612                             PERL_PV_PRETTY_LTGT
15613                             )
15614                             : "???"
15615                 );
15616                 if (trie->jump) {
15617                     U16 dist= trie->jump[word_idx+1];
15618                     PerlIO_printf(Perl_debug_log, "(%"UVuf")\n",
15619                                   (UV)((dist ? this_trie + dist : next) - start));
15620                     if (dist) {
15621                         if (!nextbranch)
15622                             nextbranch= this_trie + trie->jump[0];    
15623                         DUMPUNTIL(this_trie + dist, nextbranch);
15624                     }
15625                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
15626                         nextbranch= regnext((regnode *)nextbranch);
15627                 } else {
15628                     PerlIO_printf(Perl_debug_log, "\n");
15629                 }
15630             }
15631             if (last && next > last)
15632                 node= last;
15633             else
15634                 node= next;
15635         }
15636         else if ( op == CURLY ) {   /* "next" might be very big: optimizer */
15637             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS,
15638                     NEXTOPER(node) + EXTRA_STEP_2ARGS + 1);
15639         }
15640         else if (PL_regkind[(U8)op] == CURLY && op != CURLYX) {
15641             assert(next);
15642             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS, next);
15643         }
15644         else if ( op == PLUS || op == STAR) {
15645             DUMPUNTIL(NEXTOPER(node), NEXTOPER(node) + 1);
15646         }
15647         else if (PL_regkind[(U8)op] == ANYOF) {
15648             /* arglen 1 + class block */
15649             node += 1 + ((ANYOF_FLAGS(node) & ANYOF_CLASS)
15650                     ? ANYOF_CLASS_SKIP : ANYOF_SKIP);
15651             node = NEXTOPER(node);
15652         }
15653         else if (PL_regkind[(U8)op] == EXACT) {
15654             /* Literal string, where present. */
15655             node += NODE_SZ_STR(node) - 1;
15656             node = NEXTOPER(node);
15657         }
15658         else {
15659             node = NEXTOPER(node);
15660             node += regarglen[(U8)op];
15661         }
15662         if (op == CURLYX || op == OPEN)
15663             indent++;
15664     }
15665     CLEAR_OPTSTART;
15666 #ifdef DEBUG_DUMPUNTIL    
15667     PerlIO_printf(Perl_debug_log, "--- %d\n", (int)indent);
15668 #endif
15669     return node;
15670 }
15671
15672 #endif  /* DEBUGGING */
15673
15674 /*
15675  * Local variables:
15676  * c-indentation-style: bsd
15677  * c-basic-offset: 4
15678  * indent-tabs-mode: nil
15679  * End:
15680  *
15681  * ex: set ts=8 sts=4 sw=4 et:
15682  */