This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta for 486b1e7f0
[perl5.git] / 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; if = &emit_dummy,
130                                            implies compiling, so don't emit */
131     regnode     emit_dummy;             /* placeholder for emit to point to */
132     I32         naughty;                /* How bad is this pattern? */
133     I32         sawback;                /* Did we see \1, ...? */
134     U32         seen;
135     I32         size;                   /* Code size. */
136     I32         npar;                   /* Capture buffer count, (OPEN). */
137     I32         cpar;                   /* Capture buffer count, (CLOSE). */
138     I32         nestroot;               /* root parens we are in - used by accept */
139     I32         extralen;
140     I32         seen_zerolen;
141     regnode     **open_parens;          /* pointers to open parens */
142     regnode     **close_parens;         /* pointers to close parens */
143     regnode     *opend;                 /* END node in program */
144     I32         utf8;           /* whether the pattern is utf8 or not */
145     I32         orig_utf8;      /* whether the pattern was originally in utf8 */
146                                 /* XXX use this for future optimisation of case
147                                  * where pattern must be upgraded to utf8. */
148     I32         uni_semantics;  /* If a d charset modifier should use unicode
149                                    rules, even if the pattern is not in
150                                    utf8 */
151     HV          *paren_names;           /* Paren names */
152     
153     regnode     **recurse;              /* Recurse regops */
154     I32         recurse_count;          /* Number of recurse regops */
155     I32         in_lookbehind;
156     I32         contains_locale;
157     I32         override_recoding;
158     I32         in_multi_char_class;
159     struct reg_code_block *code_blocks; /* positions of literal (?{})
160                                             within pattern */
161     int         num_code_blocks;        /* size of code_blocks[] */
162     int         code_index;             /* next code_blocks[] slot */
163 #if ADD_TO_REGEXEC
164     char        *starttry;              /* -Dr: where regtry was called. */
165 #define RExC_starttry   (pRExC_state->starttry)
166 #endif
167     SV          *runtime_code_qr;       /* qr with the runtime code blocks */
168 #ifdef DEBUGGING
169     const char  *lastparse;
170     I32         lastnum;
171     AV          *paren_name_list;       /* idx -> name */
172 #define RExC_lastparse  (pRExC_state->lastparse)
173 #define RExC_lastnum    (pRExC_state->lastnum)
174 #define RExC_paren_name_list    (pRExC_state->paren_name_list)
175 #endif
176 } RExC_state_t;
177
178 #define RExC_flags      (pRExC_state->flags)
179 #define RExC_pm_flags   (pRExC_state->pm_flags)
180 #define RExC_precomp    (pRExC_state->precomp)
181 #define RExC_rx_sv      (pRExC_state->rx_sv)
182 #define RExC_rx         (pRExC_state->rx)
183 #define RExC_rxi        (pRExC_state->rxi)
184 #define RExC_start      (pRExC_state->start)
185 #define RExC_end        (pRExC_state->end)
186 #define RExC_parse      (pRExC_state->parse)
187 #define RExC_whilem_seen        (pRExC_state->whilem_seen)
188 #ifdef RE_TRACK_PATTERN_OFFSETS
189 #define RExC_offsets    (pRExC_state->rxi->u.offsets) /* I am not like the others */
190 #endif
191 #define RExC_emit       (pRExC_state->emit)
192 #define RExC_emit_dummy (pRExC_state->emit_dummy)
193 #define RExC_emit_start (pRExC_state->emit_start)
194 #define RExC_emit_bound (pRExC_state->emit_bound)
195 #define RExC_naughty    (pRExC_state->naughty)
196 #define RExC_sawback    (pRExC_state->sawback)
197 #define RExC_seen       (pRExC_state->seen)
198 #define RExC_size       (pRExC_state->size)
199 #define RExC_npar       (pRExC_state->npar)
200 #define RExC_nestroot   (pRExC_state->nestroot)
201 #define RExC_extralen   (pRExC_state->extralen)
202 #define RExC_seen_zerolen       (pRExC_state->seen_zerolen)
203 #define RExC_utf8       (pRExC_state->utf8)
204 #define RExC_uni_semantics      (pRExC_state->uni_semantics)
205 #define RExC_orig_utf8  (pRExC_state->orig_utf8)
206 #define RExC_open_parens        (pRExC_state->open_parens)
207 #define RExC_close_parens       (pRExC_state->close_parens)
208 #define RExC_opend      (pRExC_state->opend)
209 #define RExC_paren_names        (pRExC_state->paren_names)
210 #define RExC_recurse    (pRExC_state->recurse)
211 #define RExC_recurse_count      (pRExC_state->recurse_count)
212 #define RExC_in_lookbehind      (pRExC_state->in_lookbehind)
213 #define RExC_contains_locale    (pRExC_state->contains_locale)
214 #define RExC_override_recoding (pRExC_state->override_recoding)
215 #define RExC_in_multi_char_class (pRExC_state->in_multi_char_class)
216
217
218 #define ISMULT1(c)      ((c) == '*' || (c) == '+' || (c) == '?')
219 #define ISMULT2(s)      ((*s) == '*' || (*s) == '+' || (*s) == '?' || \
220         ((*s) == '{' && regcurly(s, FALSE)))
221
222 #ifdef SPSTART
223 #undef SPSTART          /* dratted cpp namespace... */
224 #endif
225 /*
226  * Flags to be passed up and down.
227  */
228 #define WORST           0       /* Worst case. */
229 #define HASWIDTH        0x01    /* Known to match non-null strings. */
230
231 /* Simple enough to be STAR/PLUS operand; in an EXACTish node must be a single
232  * character.  (There needs to be a case: in the switch statement in regexec.c
233  * for any node marked SIMPLE.)  Note that this is not the same thing as
234  * REGNODE_SIMPLE */
235 #define SIMPLE          0x02
236 #define SPSTART         0x04    /* Starts with * or + */
237 #define POSTPONED       0x08    /* (?1),(?&name), (??{...}) or similar */
238 #define TRYAGAIN        0x10    /* Weeded out a declaration. */
239 #define RESTART_UTF8    0x20    /* Restart, need to calcuate sizes as UTF-8 */
240
241 #define REG_NODE_NUM(x) ((x) ? (int)((x)-RExC_emit_start) : -1)
242
243 /* whether trie related optimizations are enabled */
244 #if PERL_ENABLE_EXTENDED_TRIE_OPTIMISATION
245 #define TRIE_STUDY_OPT
246 #define FULL_TRIE_STUDY
247 #define TRIE_STCLASS
248 #endif
249
250
251
252 #define PBYTE(u8str,paren) ((U8*)(u8str))[(paren) >> 3]
253 #define PBITVAL(paren) (1 << ((paren) & 7))
254 #define PAREN_TEST(u8str,paren) ( PBYTE(u8str,paren) & PBITVAL(paren))
255 #define PAREN_SET(u8str,paren) PBYTE(u8str,paren) |= PBITVAL(paren)
256 #define PAREN_UNSET(u8str,paren) PBYTE(u8str,paren) &= (~PBITVAL(paren))
257
258 #define REQUIRE_UTF8    STMT_START {                                       \
259                                      if (!UTF) {                           \
260                                          *flagp = RESTART_UTF8;            \
261                                          return NULL;                      \
262                                      }                                     \
263                         } STMT_END
264
265 /* This converts the named class defined in regcomp.h to its equivalent class
266  * number defined in handy.h. */
267 #define namedclass_to_classnum(class)  ((int) ((class) / 2))
268 #define classnum_to_namedclass(classnum)  ((classnum) * 2)
269
270 /* About scan_data_t.
271
272   During optimisation we recurse through the regexp program performing
273   various inplace (keyhole style) optimisations. In addition study_chunk
274   and scan_commit populate this data structure with information about
275   what strings MUST appear in the pattern. We look for the longest 
276   string that must appear at a fixed location, and we look for the
277   longest string that may appear at a floating location. So for instance
278   in the pattern:
279   
280     /FOO[xX]A.*B[xX]BAR/
281     
282   Both 'FOO' and 'A' are fixed strings. Both 'B' and 'BAR' are floating
283   strings (because they follow a .* construct). study_chunk will identify
284   both FOO and BAR as being the longest fixed and floating strings respectively.
285   
286   The strings can be composites, for instance
287   
288      /(f)(o)(o)/
289      
290   will result in a composite fixed substring 'foo'.
291   
292   For each string some basic information is maintained:
293   
294   - offset or min_offset
295     This is the position the string must appear at, or not before.
296     It also implicitly (when combined with minlenp) tells us how many
297     characters must match before the string we are searching for.
298     Likewise when combined with minlenp and the length of the string it
299     tells us how many characters must appear after the string we have 
300     found.
301   
302   - max_offset
303     Only used for floating strings. This is the rightmost point that
304     the string can appear at. If set to I32 max it indicates that the
305     string can occur infinitely far to the right.
306   
307   - minlenp
308     A pointer to the minimum number of characters of the pattern that the
309     string was found inside. This is important as in the case of positive
310     lookahead or positive lookbehind we can have multiple patterns 
311     involved. Consider
312     
313     /(?=FOO).*F/
314     
315     The minimum length of the pattern overall is 3, the minimum length
316     of the lookahead part is 3, but the minimum length of the part that
317     will actually match is 1. So 'FOO's minimum length is 3, but the 
318     minimum length for the F is 1. This is important as the minimum length
319     is used to determine offsets in front of and behind the string being 
320     looked for.  Since strings can be composites this is the length of the
321     pattern at the time it was committed with a scan_commit. Note that
322     the length is calculated by study_chunk, so that the minimum lengths
323     are not known until the full pattern has been compiled, thus the 
324     pointer to the value.
325   
326   - lookbehind
327   
328     In the case of lookbehind the string being searched for can be
329     offset past the start point of the final matching string. 
330     If this value was just blithely removed from the min_offset it would
331     invalidate some of the calculations for how many chars must match
332     before or after (as they are derived from min_offset and minlen and
333     the length of the string being searched for). 
334     When the final pattern is compiled and the data is moved from the
335     scan_data_t structure into the regexp structure the information
336     about lookbehind is factored in, with the information that would 
337     have been lost precalculated in the end_shift field for the 
338     associated string.
339
340   The fields pos_min and pos_delta are used to store the minimum offset
341   and the delta to the maximum offset at the current point in the pattern.    
342
343 */
344
345 typedef struct scan_data_t {
346     /*I32 len_min;      unused */
347     /*I32 len_delta;    unused */
348     I32 pos_min;
349     I32 pos_delta;
350     SV *last_found;
351     I32 last_end;           /* min value, <0 unless valid. */
352     I32 last_start_min;
353     I32 last_start_max;
354     SV **longest;           /* Either &l_fixed, or &l_float. */
355     SV *longest_fixed;      /* longest fixed string found in pattern */
356     I32 offset_fixed;       /* offset where it starts */
357     I32 *minlen_fixed;      /* pointer to the minlen relevant to the string */
358     I32 lookbehind_fixed;   /* is the position of the string modfied by LB */
359     SV *longest_float;      /* longest floating string found in pattern */
360     I32 offset_float_min;   /* earliest point in string it can appear */
361     I32 offset_float_max;   /* latest point in string it can appear */
362     I32 *minlen_float;      /* pointer to the minlen relevant to the string */
363     I32 lookbehind_float;   /* is the position of the string modified by LB */
364     I32 flags;
365     I32 whilem_c;
366     I32 *last_closep;
367     struct regnode_charclass_class *start_class;
368 } scan_data_t;
369
370 /*
371  * Forward declarations for pregcomp()'s friends.
372  */
373
374 static const scan_data_t zero_scan_data =
375   { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ,0};
376
377 #define SF_BEFORE_EOL           (SF_BEFORE_SEOL|SF_BEFORE_MEOL)
378 #define SF_BEFORE_SEOL          0x0001
379 #define SF_BEFORE_MEOL          0x0002
380 #define SF_FIX_BEFORE_EOL       (SF_FIX_BEFORE_SEOL|SF_FIX_BEFORE_MEOL)
381 #define SF_FL_BEFORE_EOL        (SF_FL_BEFORE_SEOL|SF_FL_BEFORE_MEOL)
382
383 #ifdef NO_UNARY_PLUS
384 #  define SF_FIX_SHIFT_EOL      (0+2)
385 #  define SF_FL_SHIFT_EOL               (0+4)
386 #else
387 #  define SF_FIX_SHIFT_EOL      (+2)
388 #  define SF_FL_SHIFT_EOL               (+4)
389 #endif
390
391 #define SF_FIX_BEFORE_SEOL      (SF_BEFORE_SEOL << SF_FIX_SHIFT_EOL)
392 #define SF_FIX_BEFORE_MEOL      (SF_BEFORE_MEOL << SF_FIX_SHIFT_EOL)
393
394 #define SF_FL_BEFORE_SEOL       (SF_BEFORE_SEOL << SF_FL_SHIFT_EOL)
395 #define SF_FL_BEFORE_MEOL       (SF_BEFORE_MEOL << SF_FL_SHIFT_EOL) /* 0x20 */
396 #define SF_IS_INF               0x0040
397 #define SF_HAS_PAR              0x0080
398 #define SF_IN_PAR               0x0100
399 #define SF_HAS_EVAL             0x0200
400 #define SCF_DO_SUBSTR           0x0400
401 #define SCF_DO_STCLASS_AND      0x0800
402 #define SCF_DO_STCLASS_OR       0x1000
403 #define SCF_DO_STCLASS          (SCF_DO_STCLASS_AND|SCF_DO_STCLASS_OR)
404 #define SCF_WHILEM_VISITED_POS  0x2000
405
406 #define SCF_TRIE_RESTUDY        0x4000 /* Do restudy? */
407 #define SCF_SEEN_ACCEPT         0x8000 
408 #define SCF_TRIE_DOING_RESTUDY 0x10000
409
410 #define UTF cBOOL(RExC_utf8)
411
412 /* The enums for all these are ordered so things work out correctly */
413 #define LOC (get_regex_charset(RExC_flags) == REGEX_LOCALE_CHARSET)
414 #define DEPENDS_SEMANTICS (get_regex_charset(RExC_flags) == REGEX_DEPENDS_CHARSET)
415 #define UNI_SEMANTICS (get_regex_charset(RExC_flags) == REGEX_UNICODE_CHARSET)
416 #define AT_LEAST_UNI_SEMANTICS (get_regex_charset(RExC_flags) >= REGEX_UNICODE_CHARSET)
417 #define ASCII_RESTRICTED (get_regex_charset(RExC_flags) == REGEX_ASCII_RESTRICTED_CHARSET)
418 #define AT_LEAST_ASCII_RESTRICTED (get_regex_charset(RExC_flags) >= REGEX_ASCII_RESTRICTED_CHARSET)
419 #define ASCII_FOLD_RESTRICTED (get_regex_charset(RExC_flags) == REGEX_ASCII_MORE_RESTRICTED_CHARSET)
420
421 #define FOLD cBOOL(RExC_flags & RXf_PMf_FOLD)
422
423 #define OOB_NAMEDCLASS          -1
424
425 /* There is no code point that is out-of-bounds, so this is problematic.  But
426  * its only current use is to initialize a variable that is always set before
427  * looked at. */
428 #define OOB_UNICODE             0xDEADBEEF
429
430 #define CHR_SVLEN(sv) (UTF ? sv_len_utf8(sv) : SvCUR(sv))
431 #define CHR_DIST(a,b) (UTF ? utf8_distance(a,b) : a - b)
432
433
434 /* length of regex to show in messages that don't mark a position within */
435 #define RegexLengthToShowInErrorMessages 127
436
437 /*
438  * If MARKER[12] are adjusted, be sure to adjust the constants at the top
439  * of t/op/regmesg.t, the tests in t/op/re_tests, and those in
440  * op/pragma/warn/regcomp.
441  */
442 #define MARKER1 "<-- HERE"    /* marker as it appears in the description */
443 #define MARKER2 " <-- HERE "  /* marker as it appears within the regex */
444
445 #define REPORT_LOCATION " in regex; marked by " MARKER1 " in m/%.*s" MARKER2 "%s/"
446
447 /*
448  * Calls SAVEDESTRUCTOR_X if needed, then calls Perl_croak with the given
449  * arg. Show regex, up to a maximum length. If it's too long, chop and add
450  * "...".
451  */
452 #define _FAIL(code) STMT_START {                                        \
453     const char *ellipses = "";                                          \
454     IV len = RExC_end - RExC_precomp;                                   \
455                                                                         \
456     if (!SIZE_ONLY)                                                     \
457         SAVEFREESV(RExC_rx_sv);                                         \
458     if (len > RegexLengthToShowInErrorMessages) {                       \
459         /* chop 10 shorter than the max, to ensure meaning of "..." */  \
460         len = RegexLengthToShowInErrorMessages - 10;                    \
461         ellipses = "...";                                               \
462     }                                                                   \
463     code;                                                               \
464 } STMT_END
465
466 #define FAIL(msg) _FAIL(                            \
467     Perl_croak(aTHX_ "%s in regex m/%.*s%s/",       \
468             msg, (int)len, RExC_precomp, ellipses))
469
470 #define FAIL2(msg,arg) _FAIL(                       \
471     Perl_croak(aTHX_ msg " in regex m/%.*s%s/",     \
472             arg, (int)len, RExC_precomp, ellipses))
473
474 /*
475  * Simple_vFAIL -- like FAIL, but marks the current location in the scan
476  */
477 #define Simple_vFAIL(m) STMT_START {                                    \
478     const IV offset = RExC_parse - RExC_precomp;                        \
479     Perl_croak(aTHX_ "%s" REPORT_LOCATION,                              \
480             m, (int)offset, RExC_precomp, RExC_precomp + offset);       \
481 } STMT_END
482
483 /*
484  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL()
485  */
486 #define vFAIL(m) STMT_START {                           \
487     if (!SIZE_ONLY)                                     \
488         SAVEFREESV(RExC_rx_sv);                         \
489     Simple_vFAIL(m);                                    \
490 } STMT_END
491
492 /*
493  * Like Simple_vFAIL(), but accepts two arguments.
494  */
495 #define Simple_vFAIL2(m,a1) STMT_START {                        \
496     const IV offset = RExC_parse - RExC_precomp;                        \
497     S_re_croak2(aTHX_ m, REPORT_LOCATION, a1,                   \
498             (int)offset, RExC_precomp, RExC_precomp + offset);  \
499 } STMT_END
500
501 /*
502  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL2().
503  */
504 #define vFAIL2(m,a1) STMT_START {                       \
505     if (!SIZE_ONLY)                                     \
506         SAVEFREESV(RExC_rx_sv);                         \
507     Simple_vFAIL2(m, a1);                               \
508 } STMT_END
509
510
511 /*
512  * Like Simple_vFAIL(), but accepts three arguments.
513  */
514 #define Simple_vFAIL3(m, a1, a2) STMT_START {                   \
515     const IV offset = RExC_parse - RExC_precomp;                \
516     S_re_croak2(aTHX_ m, REPORT_LOCATION, a1, a2,               \
517             (int)offset, RExC_precomp, RExC_precomp + offset);  \
518 } STMT_END
519
520 /*
521  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL3().
522  */
523 #define vFAIL3(m,a1,a2) STMT_START {                    \
524     if (!SIZE_ONLY)                                     \
525         SAVEFREESV(RExC_rx_sv);                         \
526     Simple_vFAIL3(m, a1, a2);                           \
527 } STMT_END
528
529 /*
530  * Like Simple_vFAIL(), but accepts four arguments.
531  */
532 #define Simple_vFAIL4(m, a1, a2, a3) STMT_START {               \
533     const IV offset = RExC_parse - RExC_precomp;                \
534     S_re_croak2(aTHX_ m, REPORT_LOCATION, a1, a2, a3,           \
535             (int)offset, RExC_precomp, RExC_precomp + offset);  \
536 } STMT_END
537
538 #define vFAIL4(m,a1,a2,a3) STMT_START {                 \
539     if (!SIZE_ONLY)                                     \
540         SAVEFREESV(RExC_rx_sv);                         \
541     Simple_vFAIL4(m, a1, a2, a3);                       \
542 } STMT_END
543
544 /* m is not necessarily a "literal string", in this macro */
545 #define reg_warn_non_literal_string(loc, m) STMT_START {                \
546     const IV offset = loc - RExC_precomp;                               \
547     Perl_warner(aTHX_ packWARN(WARN_REGEXP), "%s" REPORT_LOCATION,      \
548             m, (int)offset, RExC_precomp, RExC_precomp + offset);       \
549 } STMT_END
550
551 #define ckWARNreg(loc,m) STMT_START {                                   \
552     const IV offset = loc - RExC_precomp;                               \
553     Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,      \
554             (int)offset, RExC_precomp, RExC_precomp + offset);          \
555 } STMT_END
556
557 #define vWARN_dep(loc, m) STMT_START {                                  \
558     const IV offset = loc - RExC_precomp;                               \
559     Perl_warner(aTHX_ packWARN(WARN_DEPRECATED), m REPORT_LOCATION,     \
560             (int)offset, RExC_precomp, RExC_precomp + offset);          \
561 } STMT_END
562
563 #define ckWARNdep(loc,m) STMT_START {                                   \
564     const IV offset = loc - RExC_precomp;                               \
565     Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED),                   \
566             m REPORT_LOCATION,                                          \
567             (int)offset, RExC_precomp, RExC_precomp + offset);          \
568 } STMT_END
569
570 #define ckWARNregdep(loc,m) STMT_START {                                \
571     const IV offset = loc - RExC_precomp;                               \
572     Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_REGEXP),     \
573             m REPORT_LOCATION,                                          \
574             (int)offset, RExC_precomp, RExC_precomp + offset);          \
575 } STMT_END
576
577 #define ckWARN2reg_d(loc,m, a1) STMT_START {                            \
578     const IV offset = loc - RExC_precomp;                               \
579     Perl_ck_warner_d(aTHX_ packWARN(WARN_REGEXP),                       \
580             m REPORT_LOCATION,                                          \
581             a1, (int)offset, RExC_precomp, RExC_precomp + offset);      \
582 } STMT_END
583
584 #define ckWARN2reg(loc, m, a1) STMT_START {                             \
585     const IV offset = loc - RExC_precomp;                               \
586     Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,      \
587             a1, (int)offset, RExC_precomp, RExC_precomp + offset);      \
588 } STMT_END
589
590 #define vWARN3(loc, m, a1, a2) STMT_START {                             \
591     const IV offset = loc - RExC_precomp;                               \
592     Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,         \
593             a1, a2, (int)offset, RExC_precomp, RExC_precomp + offset);  \
594 } STMT_END
595
596 #define ckWARN3reg(loc, m, a1, a2) STMT_START {                         \
597     const IV offset = loc - RExC_precomp;                               \
598     Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,      \
599             a1, a2, (int)offset, RExC_precomp, RExC_precomp + offset);  \
600 } STMT_END
601
602 #define vWARN4(loc, m, a1, a2, a3) STMT_START {                         \
603     const IV offset = loc - RExC_precomp;                               \
604     Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,         \
605             a1, a2, a3, (int)offset, RExC_precomp, RExC_precomp + offset); \
606 } STMT_END
607
608 #define ckWARN4reg(loc, m, a1, a2, a3) STMT_START {                     \
609     const IV offset = loc - RExC_precomp;                               \
610     Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,      \
611             a1, a2, a3, (int)offset, RExC_precomp, RExC_precomp + offset); \
612 } STMT_END
613
614 #define vWARN5(loc, m, a1, a2, a3, a4) STMT_START {                     \
615     const IV offset = loc - RExC_precomp;                               \
616     Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,         \
617             a1, a2, a3, a4, (int)offset, RExC_precomp, RExC_precomp + offset); \
618 } STMT_END
619
620
621 /* Allow for side effects in s */
622 #define REGC(c,s) STMT_START {                  \
623     if (!SIZE_ONLY) *(s) = (c); else (void)(s); \
624 } STMT_END
625
626 /* Macros for recording node offsets.   20001227 mjd@plover.com 
627  * Nodes are numbered 1, 2, 3, 4.  Node #n's position is recorded in
628  * element 2*n-1 of the array.  Element #2n holds the byte length node #n.
629  * Element 0 holds the number n.
630  * Position is 1 indexed.
631  */
632 #ifndef RE_TRACK_PATTERN_OFFSETS
633 #define Set_Node_Offset_To_R(node,byte)
634 #define Set_Node_Offset(node,byte)
635 #define Set_Cur_Node_Offset
636 #define Set_Node_Length_To_R(node,len)
637 #define Set_Node_Length(node,len)
638 #define Set_Node_Cur_Length(node,start)
639 #define Node_Offset(n) 
640 #define Node_Length(n) 
641 #define Set_Node_Offset_Length(node,offset,len)
642 #define ProgLen(ri) ri->u.proglen
643 #define SetProgLen(ri,x) ri->u.proglen = x
644 #else
645 #define ProgLen(ri) ri->u.offsets[0]
646 #define SetProgLen(ri,x) ri->u.offsets[0] = x
647 #define Set_Node_Offset_To_R(node,byte) STMT_START {                    \
648     if (! SIZE_ONLY) {                                                  \
649         MJD_OFFSET_DEBUG(("** (%d) offset of node %d is %d.\n",         \
650                     __LINE__, (int)(node), (int)(byte)));               \
651         if((node) < 0) {                                                \
652             Perl_croak(aTHX_ "value of node is %d in Offset macro", (int)(node)); \
653         } else {                                                        \
654             RExC_offsets[2*(node)-1] = (byte);                          \
655         }                                                               \
656     }                                                                   \
657 } STMT_END
658
659 #define Set_Node_Offset(node,byte) \
660     Set_Node_Offset_To_R((node)-RExC_emit_start, (byte)-RExC_start)
661 #define Set_Cur_Node_Offset Set_Node_Offset(RExC_emit, RExC_parse)
662
663 #define Set_Node_Length_To_R(node,len) STMT_START {                     \
664     if (! SIZE_ONLY) {                                                  \
665         MJD_OFFSET_DEBUG(("** (%d) size of node %d is %d.\n",           \
666                 __LINE__, (int)(node), (int)(len)));                    \
667         if((node) < 0) {                                                \
668             Perl_croak(aTHX_ "value of node is %d in Length macro", (int)(node)); \
669         } else {                                                        \
670             RExC_offsets[2*(node)] = (len);                             \
671         }                                                               \
672     }                                                                   \
673 } STMT_END
674
675 #define Set_Node_Length(node,len) \
676     Set_Node_Length_To_R((node)-RExC_emit_start, len)
677 #define Set_Node_Cur_Length(node, start)                \
678     Set_Node_Length(node, RExC_parse - start)
679
680 /* Get offsets and lengths */
681 #define Node_Offset(n) (RExC_offsets[2*((n)-RExC_emit_start)-1])
682 #define Node_Length(n) (RExC_offsets[2*((n)-RExC_emit_start)])
683
684 #define Set_Node_Offset_Length(node,offset,len) STMT_START {    \
685     Set_Node_Offset_To_R((node)-RExC_emit_start, (offset));     \
686     Set_Node_Length_To_R((node)-RExC_emit_start, (len));        \
687 } STMT_END
688 #endif
689
690 #if PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS
691 #define EXPERIMENTAL_INPLACESCAN
692 #endif /*PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS*/
693
694 #define DEBUG_STUDYDATA(str,data,depth)                              \
695 DEBUG_OPTIMISE_MORE_r(if(data){                                      \
696     PerlIO_printf(Perl_debug_log,                                    \
697         "%*s" str "Pos:%"IVdf"/%"IVdf                                \
698         " Flags: 0x%"UVXf" Whilem_c: %"IVdf" Lcp: %"IVdf" %s",       \
699         (int)(depth)*2, "",                                          \
700         (IV)((data)->pos_min),                                       \
701         (IV)((data)->pos_delta),                                     \
702         (UV)((data)->flags),                                         \
703         (IV)((data)->whilem_c),                                      \
704         (IV)((data)->last_closep ? *((data)->last_closep) : -1),     \
705         is_inf ? "INF " : ""                                         \
706     );                                                               \
707     if ((data)->last_found)                                          \
708         PerlIO_printf(Perl_debug_log,                                \
709             "Last:'%s' %"IVdf":%"IVdf"/%"IVdf" %sFixed:'%s' @ %"IVdf \
710             " %sFloat: '%s' @ %"IVdf"/%"IVdf"",                      \
711             SvPVX_const((data)->last_found),                         \
712             (IV)((data)->last_end),                                  \
713             (IV)((data)->last_start_min),                            \
714             (IV)((data)->last_start_max),                            \
715             ((data)->longest &&                                      \
716              (data)->longest==&((data)->longest_fixed)) ? "*" : "",  \
717             SvPVX_const((data)->longest_fixed),                      \
718             (IV)((data)->offset_fixed),                              \
719             ((data)->longest &&                                      \
720              (data)->longest==&((data)->longest_float)) ? "*" : "",  \
721             SvPVX_const((data)->longest_float),                      \
722             (IV)((data)->offset_float_min),                          \
723             (IV)((data)->offset_float_max)                           \
724         );                                                           \
725     PerlIO_printf(Perl_debug_log,"\n");                              \
726 });
727
728 /* Mark that we cannot extend a found fixed substring at this point.
729    Update the longest found anchored substring and the longest found
730    floating substrings if needed. */
731
732 STATIC void
733 S_scan_commit(pTHX_ const RExC_state_t *pRExC_state, scan_data_t *data, I32 *minlenp, int is_inf)
734 {
735     const STRLEN l = CHR_SVLEN(data->last_found);
736     const STRLEN old_l = CHR_SVLEN(*data->longest);
737     GET_RE_DEBUG_FLAGS_DECL;
738
739     PERL_ARGS_ASSERT_SCAN_COMMIT;
740
741     if ((l >= old_l) && ((l > old_l) || (data->flags & SF_BEFORE_EOL))) {
742         SvSetMagicSV(*data->longest, data->last_found);
743         if (*data->longest == data->longest_fixed) {
744             data->offset_fixed = l ? data->last_start_min : data->pos_min;
745             if (data->flags & SF_BEFORE_EOL)
746                 data->flags
747                     |= ((data->flags & SF_BEFORE_EOL) << SF_FIX_SHIFT_EOL);
748             else
749                 data->flags &= ~SF_FIX_BEFORE_EOL;
750             data->minlen_fixed=minlenp;
751             data->lookbehind_fixed=0;
752         }
753         else { /* *data->longest == data->longest_float */
754             data->offset_float_min = l ? data->last_start_min : data->pos_min;
755             data->offset_float_max = (l
756                                       ? data->last_start_max
757                                       : (data->pos_delta == I32_MAX ? I32_MAX : data->pos_min + data->pos_delta));
758             if (is_inf || (U32)data->offset_float_max > (U32)I32_MAX)
759                 data->offset_float_max = I32_MAX;
760             if (data->flags & SF_BEFORE_EOL)
761                 data->flags
762                     |= ((data->flags & SF_BEFORE_EOL) << SF_FL_SHIFT_EOL);
763             else
764                 data->flags &= ~SF_FL_BEFORE_EOL;
765             data->minlen_float=minlenp;
766             data->lookbehind_float=0;
767         }
768     }
769     SvCUR_set(data->last_found, 0);
770     {
771         SV * const sv = data->last_found;
772         if (SvUTF8(sv) && SvMAGICAL(sv)) {
773             MAGIC * const mg = mg_find(sv, PERL_MAGIC_utf8);
774             if (mg)
775                 mg->mg_len = 0;
776         }
777     }
778     data->last_end = -1;
779     data->flags &= ~SF_BEFORE_EOL;
780     DEBUG_STUDYDATA("commit: ",data,0);
781 }
782
783 /* These macros set, clear and test whether the synthetic start class ('ssc',
784  * given by the parameter) matches an empty string (EOS).  This uses the
785  * 'next_off' field in the node, to save a bit in the flags field.  The ssc
786  * stands alone, so there is never a next_off, so this field is otherwise
787  * unused.  The EOS information is used only for compilation, but theoretically
788  * it could be passed on to the execution code.  This could be used to store
789  * more than one bit of information, but only this one is currently used. */
790 #define SET_SSC_EOS(node)   STMT_START { (node)->next_off = TRUE; } STMT_END
791 #define CLEAR_SSC_EOS(node) STMT_START { (node)->next_off = FALSE; } STMT_END
792 #define TEST_SSC_EOS(node)  cBOOL((node)->next_off)
793
794 /* Can match anything (initialization) */
795 STATIC void
796 S_cl_anything(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl)
797 {
798     PERL_ARGS_ASSERT_CL_ANYTHING;
799
800     ANYOF_BITMAP_SETALL(cl);
801     cl->flags = ANYOF_UNICODE_ALL;
802     SET_SSC_EOS(cl);
803
804     /* If any portion of the regex is to operate under locale rules,
805      * initialization includes it.  The reason this isn't done for all regexes
806      * is that the optimizer was written under the assumption that locale was
807      * all-or-nothing.  Given the complexity and lack of documentation in the
808      * optimizer, and that there are inadequate test cases for locale, so many
809      * parts of it may not work properly, it is safest to avoid locale unless
810      * necessary. */
811     if (RExC_contains_locale) {
812         ANYOF_CLASS_SETALL(cl);     /* /l uses class */
813         cl->flags |= ANYOF_LOCALE|ANYOF_CLASS|ANYOF_LOC_FOLD;
814     }
815     else {
816         ANYOF_CLASS_ZERO(cl);       /* Only /l uses class now */
817     }
818 }
819
820 /* Can match anything (initialization) */
821 STATIC int
822 S_cl_is_anything(const struct regnode_charclass_class *cl)
823 {
824     int value;
825
826     PERL_ARGS_ASSERT_CL_IS_ANYTHING;
827
828     for (value = 0; value < ANYOF_MAX; value += 2)
829         if (ANYOF_CLASS_TEST(cl, value) && ANYOF_CLASS_TEST(cl, value + 1))
830             return 1;
831     if (!(cl->flags & ANYOF_UNICODE_ALL))
832         return 0;
833     if (!ANYOF_BITMAP_TESTALLSET((const void*)cl))
834         return 0;
835     return 1;
836 }
837
838 /* Can match anything (initialization) */
839 STATIC void
840 S_cl_init(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl)
841 {
842     PERL_ARGS_ASSERT_CL_INIT;
843
844     Zero(cl, 1, struct regnode_charclass_class);
845     cl->type = ANYOF;
846     cl_anything(pRExC_state, cl);
847     ARG_SET(cl, ANYOF_NONBITMAP_EMPTY);
848 }
849
850 /* These two functions currently do the exact same thing */
851 #define cl_init_zero            cl_init
852
853 /* 'AND' a given class with another one.  Can create false positives.  'cl'
854  * should not be inverted.  'and_with->flags & ANYOF_CLASS' should be 0 if
855  * 'and_with' is a regnode_charclass instead of a regnode_charclass_class. */
856 STATIC void
857 S_cl_and(struct regnode_charclass_class *cl,
858         const struct regnode_charclass_class *and_with)
859 {
860     PERL_ARGS_ASSERT_CL_AND;
861
862     assert(PL_regkind[and_with->type] == ANYOF);
863
864     /* I (khw) am not sure all these restrictions are necessary XXX */
865     if (!(ANYOF_CLASS_TEST_ANY_SET(and_with))
866         && !(ANYOF_CLASS_TEST_ANY_SET(cl))
867         && (and_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
868         && !(and_with->flags & ANYOF_LOC_FOLD)
869         && !(cl->flags & ANYOF_LOC_FOLD)) {
870         int i;
871
872         if (and_with->flags & ANYOF_INVERT)
873             for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
874                 cl->bitmap[i] &= ~and_with->bitmap[i];
875         else
876             for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
877                 cl->bitmap[i] &= and_with->bitmap[i];
878     } /* XXXX: logic is complicated otherwise, leave it along for a moment. */
879
880     if (and_with->flags & ANYOF_INVERT) {
881
882         /* Here, the and'ed node is inverted.  Get the AND of the flags that
883          * aren't affected by the inversion.  Those that are affected are
884          * handled individually below */
885         U8 affected_flags = cl->flags & ~INVERSION_UNAFFECTED_FLAGS;
886         cl->flags &= (and_with->flags & INVERSION_UNAFFECTED_FLAGS);
887         cl->flags |= affected_flags;
888
889         /* We currently don't know how to deal with things that aren't in the
890          * bitmap, but we know that the intersection is no greater than what
891          * is already in cl, so let there be false positives that get sorted
892          * out after the synthetic start class succeeds, and the node is
893          * matched for real. */
894
895         /* The inversion of these two flags indicate that the resulting
896          * intersection doesn't have them */
897         if (and_with->flags & ANYOF_UNICODE_ALL) {
898             cl->flags &= ~ANYOF_UNICODE_ALL;
899         }
900         if (and_with->flags & ANYOF_NON_UTF8_LATIN1_ALL) {
901             cl->flags &= ~ANYOF_NON_UTF8_LATIN1_ALL;
902         }
903     }
904     else {   /* and'd node is not inverted */
905         U8 outside_bitmap_but_not_utf8; /* Temp variable */
906
907         if (! ANYOF_NONBITMAP(and_with)) {
908
909             /* Here 'and_with' doesn't match anything outside the bitmap
910              * (except possibly ANYOF_UNICODE_ALL), which means the
911              * intersection can't either, except for ANYOF_UNICODE_ALL, in
912              * which case we don't know what the intersection is, but it's no
913              * greater than what cl already has, so can just leave it alone,
914              * with possible false positives */
915             if (! (and_with->flags & ANYOF_UNICODE_ALL)) {
916                 ARG_SET(cl, ANYOF_NONBITMAP_EMPTY);
917                 cl->flags &= ~ANYOF_NONBITMAP_NON_UTF8;
918             }
919         }
920         else if (! ANYOF_NONBITMAP(cl)) {
921
922             /* Here, 'and_with' does match something outside the bitmap, and cl
923              * doesn't have a list of things to match outside the bitmap.  If
924              * cl can match all code points above 255, the intersection will
925              * be those above-255 code points that 'and_with' matches.  If cl
926              * can't match all Unicode code points, it means that it can't
927              * match anything outside the bitmap (since the 'if' that got us
928              * into this block tested for that), so we leave the bitmap empty.
929              */
930             if (cl->flags & ANYOF_UNICODE_ALL) {
931                 ARG_SET(cl, ARG(and_with));
932
933                 /* and_with's ARG may match things that don't require UTF8.
934                  * And now cl's will too, in spite of this being an 'and'.  See
935                  * the comments below about the kludge */
936                 cl->flags |= and_with->flags & ANYOF_NONBITMAP_NON_UTF8;
937             }
938         }
939         else {
940             /* Here, both 'and_with' and cl match something outside the
941              * bitmap.  Currently we do not do the intersection, so just match
942              * whatever cl had at the beginning.  */
943         }
944
945
946         /* Take the intersection of the two sets of flags.  However, the
947          * ANYOF_NONBITMAP_NON_UTF8 flag is treated as an 'or'.  This is a
948          * kludge around the fact that this flag is not treated like the others
949          * which are initialized in cl_anything().  The way the optimizer works
950          * is that the synthetic start class (SSC) is initialized to match
951          * anything, and then the first time a real node is encountered, its
952          * values are AND'd with the SSC's with the result being the values of
953          * the real node.  However, there are paths through the optimizer where
954          * the AND never gets called, so those initialized bits are set
955          * inappropriately, which is not usually a big deal, as they just cause
956          * false positives in the SSC, which will just mean a probably
957          * imperceptible slow down in execution.  However this bit has a
958          * higher false positive consequence in that it can cause utf8.pm,
959          * utf8_heavy.pl ... to be loaded when not necessary, which is a much
960          * bigger slowdown and also causes significant extra memory to be used.
961          * In order to prevent this, the code now takes a different tack.  The
962          * bit isn't set unless some part of the regular expression needs it,
963          * but once set it won't get cleared.  This means that these extra
964          * modules won't get loaded unless there was some path through the
965          * pattern that would have required them anyway, and  so any false
966          * positives that occur by not ANDing them out when they could be
967          * aren't as severe as they would be if we treated this bit like all
968          * the others */
969         outside_bitmap_but_not_utf8 = (cl->flags | and_with->flags)
970                                       & ANYOF_NONBITMAP_NON_UTF8;
971         cl->flags &= and_with->flags;
972         cl->flags |= outside_bitmap_but_not_utf8;
973     }
974 }
975
976 /* 'OR' a given class with another one.  Can create false positives.  'cl'
977  * should not be inverted.  'or_with->flags & ANYOF_CLASS' should be 0 if
978  * 'or_with' is a regnode_charclass instead of a regnode_charclass_class. */
979 STATIC void
980 S_cl_or(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl, const struct regnode_charclass_class *or_with)
981 {
982     PERL_ARGS_ASSERT_CL_OR;
983
984     if (or_with->flags & ANYOF_INVERT) {
985
986         /* Here, the or'd node is to be inverted.  This means we take the
987          * complement of everything not in the bitmap, but currently we don't
988          * know what that is, so give up and match anything */
989         if (ANYOF_NONBITMAP(or_with)) {
990             cl_anything(pRExC_state, cl);
991         }
992         /* We do not use
993          * (B1 | CL1) | (!B2 & !CL2) = (B1 | !B2 & !CL2) | (CL1 | (!B2 & !CL2))
994          *   <= (B1 | !B2) | (CL1 | !CL2)
995          * which is wasteful if CL2 is small, but we ignore CL2:
996          *   (B1 | CL1) | (!B2 & !CL2) <= (B1 | CL1) | !B2 = (B1 | !B2) | CL1
997          * XXXX Can we handle case-fold?  Unclear:
998          *   (OK1(i) | OK1(i')) | !(OK1(i) | OK1(i')) =
999          *   (OK1(i) | OK1(i')) | (!OK1(i) & !OK1(i'))
1000          */
1001         else if ( (or_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
1002              && !(or_with->flags & ANYOF_LOC_FOLD)
1003              && !(cl->flags & ANYOF_LOC_FOLD) ) {
1004             int i;
1005
1006             for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
1007                 cl->bitmap[i] |= ~or_with->bitmap[i];
1008         } /* XXXX: logic is complicated otherwise */
1009         else {
1010             cl_anything(pRExC_state, cl);
1011         }
1012
1013         /* And, we can just take the union of the flags that aren't affected
1014          * by the inversion */
1015         cl->flags |= or_with->flags & INVERSION_UNAFFECTED_FLAGS;
1016
1017         /* For the remaining flags:
1018             ANYOF_UNICODE_ALL and inverted means to not match anything above
1019                     255, which means that the union with cl should just be
1020                     what cl has in it, so can ignore this flag
1021             ANYOF_NON_UTF8_LATIN1_ALL and inverted means if not utf8 and ord
1022                     is 127-255 to match them, but then invert that, so the
1023                     union with cl should just be what cl has in it, so can
1024                     ignore this flag
1025          */
1026     } else {    /* 'or_with' is not inverted */
1027         /* (B1 | CL1) | (B2 | CL2) = (B1 | B2) | (CL1 | CL2)) */
1028         if ( (or_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
1029              && (!(or_with->flags & ANYOF_LOC_FOLD)
1030                  || (cl->flags & ANYOF_LOC_FOLD)) ) {
1031             int i;
1032
1033             /* OR char bitmap and class bitmap separately */
1034             for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
1035                 cl->bitmap[i] |= or_with->bitmap[i];
1036             if (or_with->flags & ANYOF_CLASS) {
1037                 ANYOF_CLASS_OR(or_with, cl);
1038             }
1039         }
1040         else { /* XXXX: logic is complicated, leave it along for a moment. */
1041             cl_anything(pRExC_state, cl);
1042         }
1043
1044         if (ANYOF_NONBITMAP(or_with)) {
1045
1046             /* Use the added node's outside-the-bit-map match if there isn't a
1047              * conflict.  If there is a conflict (both nodes match something
1048              * outside the bitmap, but what they match outside is not the same
1049              * pointer, and hence not easily compared until XXX we extend
1050              * inversion lists this far), give up and allow the start class to
1051              * match everything outside the bitmap.  If that stuff is all above
1052              * 255, can just set UNICODE_ALL, otherwise caould be anything. */
1053             if (! ANYOF_NONBITMAP(cl)) {
1054                 ARG_SET(cl, ARG(or_with));
1055             }
1056             else if (ARG(cl) != ARG(or_with)) {
1057
1058                 if ((or_with->flags & ANYOF_NONBITMAP_NON_UTF8)) {
1059                     cl_anything(pRExC_state, cl);
1060                 }
1061                 else {
1062                     cl->flags |= ANYOF_UNICODE_ALL;
1063                 }
1064             }
1065         }
1066
1067         /* Take the union */
1068         cl->flags |= or_with->flags;
1069     }
1070 }
1071
1072 #define TRIE_LIST_ITEM(state,idx) (trie->states[state].trans.list)[ idx ]
1073 #define TRIE_LIST_CUR(state)  ( TRIE_LIST_ITEM( state, 0 ).forid )
1074 #define TRIE_LIST_LEN(state) ( TRIE_LIST_ITEM( state, 0 ).newstate )
1075 #define TRIE_LIST_USED(idx)  ( trie->states[state].trans.list ? (TRIE_LIST_CUR( idx ) - 1) : 0 )
1076
1077
1078 #ifdef DEBUGGING
1079 /*
1080    dump_trie(trie,widecharmap,revcharmap)
1081    dump_trie_interim_list(trie,widecharmap,revcharmap,next_alloc)
1082    dump_trie_interim_table(trie,widecharmap,revcharmap,next_alloc)
1083
1084    These routines dump out a trie in a somewhat readable format.
1085    The _interim_ variants are used for debugging the interim
1086    tables that are used to generate the final compressed
1087    representation which is what dump_trie expects.
1088
1089    Part of the reason for their existence is to provide a form
1090    of documentation as to how the different representations function.
1091
1092 */
1093
1094 /*
1095   Dumps the final compressed table form of the trie to Perl_debug_log.
1096   Used for debugging make_trie().
1097 */
1098
1099 STATIC void
1100 S_dump_trie(pTHX_ const struct _reg_trie_data *trie, HV *widecharmap,
1101             AV *revcharmap, U32 depth)
1102 {
1103     U32 state;
1104     SV *sv=sv_newmortal();
1105     int colwidth= widecharmap ? 6 : 4;
1106     U16 word;
1107     GET_RE_DEBUG_FLAGS_DECL;
1108
1109     PERL_ARGS_ASSERT_DUMP_TRIE;
1110
1111     PerlIO_printf( Perl_debug_log, "%*sChar : %-6s%-6s%-4s ",
1112         (int)depth * 2 + 2,"",
1113         "Match","Base","Ofs" );
1114
1115     for( state = 0 ; state < trie->uniquecharcount ; state++ ) {
1116         SV ** const tmp = av_fetch( revcharmap, state, 0);
1117         if ( tmp ) {
1118             PerlIO_printf( Perl_debug_log, "%*s", 
1119                 colwidth,
1120                 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth, 
1121                             PL_colors[0], PL_colors[1],
1122                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1123                             PERL_PV_ESCAPE_FIRSTCHAR 
1124                 ) 
1125             );
1126         }
1127     }
1128     PerlIO_printf( Perl_debug_log, "\n%*sState|-----------------------",
1129         (int)depth * 2 + 2,"");
1130
1131     for( state = 0 ; state < trie->uniquecharcount ; state++ )
1132         PerlIO_printf( Perl_debug_log, "%.*s", colwidth, "--------");
1133     PerlIO_printf( Perl_debug_log, "\n");
1134
1135     for( state = 1 ; state < trie->statecount ; state++ ) {
1136         const U32 base = trie->states[ state ].trans.base;
1137
1138         PerlIO_printf( Perl_debug_log, "%*s#%4"UVXf"|", (int)depth * 2 + 2,"", (UV)state);
1139
1140         if ( trie->states[ state ].wordnum ) {
1141             PerlIO_printf( Perl_debug_log, " W%4X", trie->states[ state ].wordnum );
1142         } else {
1143             PerlIO_printf( Perl_debug_log, "%6s", "" );
1144         }
1145
1146         PerlIO_printf( Perl_debug_log, " @%4"UVXf" ", (UV)base );
1147
1148         if ( base ) {
1149             U32 ofs = 0;
1150
1151             while( ( base + ofs  < trie->uniquecharcount ) ||
1152                    ( base + ofs - trie->uniquecharcount < trie->lasttrans
1153                      && trie->trans[ base + ofs - trie->uniquecharcount ].check != state))
1154                     ofs++;
1155
1156             PerlIO_printf( Perl_debug_log, "+%2"UVXf"[ ", (UV)ofs);
1157
1158             for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
1159                 if ( ( base + ofs >= trie->uniquecharcount ) &&
1160                      ( base + ofs - trie->uniquecharcount < trie->lasttrans ) &&
1161                      trie->trans[ base + ofs - trie->uniquecharcount ].check == state )
1162                 {
1163                    PerlIO_printf( Perl_debug_log, "%*"UVXf,
1164                     colwidth,
1165                     (UV)trie->trans[ base + ofs - trie->uniquecharcount ].next );
1166                 } else {
1167                     PerlIO_printf( Perl_debug_log, "%*s",colwidth,"   ." );
1168                 }
1169             }
1170
1171             PerlIO_printf( Perl_debug_log, "]");
1172
1173         }
1174         PerlIO_printf( Perl_debug_log, "\n" );
1175     }
1176     PerlIO_printf(Perl_debug_log, "%*sword_info N:(prev,len)=", (int)depth*2, "");
1177     for (word=1; word <= trie->wordcount; word++) {
1178         PerlIO_printf(Perl_debug_log, " %d:(%d,%d)",
1179             (int)word, (int)(trie->wordinfo[word].prev),
1180             (int)(trie->wordinfo[word].len));
1181     }
1182     PerlIO_printf(Perl_debug_log, "\n" );
1183 }    
1184 /*
1185   Dumps a fully constructed but uncompressed trie in list form.
1186   List tries normally only are used for construction when the number of 
1187   possible chars (trie->uniquecharcount) is very high.
1188   Used for debugging make_trie().
1189 */
1190 STATIC void
1191 S_dump_trie_interim_list(pTHX_ const struct _reg_trie_data *trie,
1192                          HV *widecharmap, AV *revcharmap, U32 next_alloc,
1193                          U32 depth)
1194 {
1195     U32 state;
1196     SV *sv=sv_newmortal();
1197     int colwidth= widecharmap ? 6 : 4;
1198     GET_RE_DEBUG_FLAGS_DECL;
1199
1200     PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_LIST;
1201
1202     /* print out the table precompression.  */
1203     PerlIO_printf( Perl_debug_log, "%*sState :Word | Transition Data\n%*s%s",
1204         (int)depth * 2 + 2,"", (int)depth * 2 + 2,"",
1205         "------:-----+-----------------\n" );
1206     
1207     for( state=1 ; state < next_alloc ; state ++ ) {
1208         U16 charid;
1209     
1210         PerlIO_printf( Perl_debug_log, "%*s %4"UVXf" :",
1211             (int)depth * 2 + 2,"", (UV)state  );
1212         if ( ! trie->states[ state ].wordnum ) {
1213             PerlIO_printf( Perl_debug_log, "%5s| ","");
1214         } else {
1215             PerlIO_printf( Perl_debug_log, "W%4x| ",
1216                 trie->states[ state ].wordnum
1217             );
1218         }
1219         for( charid = 1 ; charid <= TRIE_LIST_USED( state ) ; charid++ ) {
1220             SV ** const tmp = av_fetch( revcharmap, TRIE_LIST_ITEM(state,charid).forid, 0);
1221             if ( tmp ) {
1222                 PerlIO_printf( Perl_debug_log, "%*s:%3X=%4"UVXf" | ",
1223                     colwidth,
1224                     pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth, 
1225                             PL_colors[0], PL_colors[1],
1226                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1227                             PERL_PV_ESCAPE_FIRSTCHAR 
1228                     ) ,
1229                     TRIE_LIST_ITEM(state,charid).forid,
1230                     (UV)TRIE_LIST_ITEM(state,charid).newstate
1231                 );
1232                 if (!(charid % 10)) 
1233                     PerlIO_printf(Perl_debug_log, "\n%*s| ",
1234                         (int)((depth * 2) + 14), "");
1235             }
1236         }
1237         PerlIO_printf( Perl_debug_log, "\n");
1238     }
1239 }    
1240
1241 /*
1242   Dumps a fully constructed but uncompressed trie in table form.
1243   This is the normal DFA style state transition table, with a few 
1244   twists to facilitate compression later. 
1245   Used for debugging make_trie().
1246 */
1247 STATIC void
1248 S_dump_trie_interim_table(pTHX_ const struct _reg_trie_data *trie,
1249                           HV *widecharmap, AV *revcharmap, U32 next_alloc,
1250                           U32 depth)
1251 {
1252     U32 state;
1253     U16 charid;
1254     SV *sv=sv_newmortal();
1255     int colwidth= widecharmap ? 6 : 4;
1256     GET_RE_DEBUG_FLAGS_DECL;
1257
1258     PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_TABLE;
1259     
1260     /*
1261        print out the table precompression so that we can do a visual check
1262        that they are identical.
1263      */
1264     
1265     PerlIO_printf( Perl_debug_log, "%*sChar : ",(int)depth * 2 + 2,"" );
1266
1267     for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
1268         SV ** const tmp = av_fetch( revcharmap, charid, 0);
1269         if ( tmp ) {
1270             PerlIO_printf( Perl_debug_log, "%*s", 
1271                 colwidth,
1272                 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth, 
1273                             PL_colors[0], PL_colors[1],
1274                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1275                             PERL_PV_ESCAPE_FIRSTCHAR 
1276                 ) 
1277             );
1278         }
1279     }
1280
1281     PerlIO_printf( Perl_debug_log, "\n%*sState+-",(int)depth * 2 + 2,"" );
1282
1283     for( charid=0 ; charid < trie->uniquecharcount ; charid++ ) {
1284         PerlIO_printf( Perl_debug_log, "%.*s", colwidth,"--------");
1285     }
1286
1287     PerlIO_printf( Perl_debug_log, "\n" );
1288
1289     for( state=1 ; state < next_alloc ; state += trie->uniquecharcount ) {
1290
1291         PerlIO_printf( Perl_debug_log, "%*s%4"UVXf" : ", 
1292             (int)depth * 2 + 2,"",
1293             (UV)TRIE_NODENUM( state ) );
1294
1295         for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
1296             UV v=(UV)SAFE_TRIE_NODENUM( trie->trans[ state + charid ].next );
1297             if (v)
1298                 PerlIO_printf( Perl_debug_log, "%*"UVXf, colwidth, v );
1299             else
1300                 PerlIO_printf( Perl_debug_log, "%*s", colwidth, "." );
1301         }
1302         if ( ! trie->states[ TRIE_NODENUM( state ) ].wordnum ) {
1303             PerlIO_printf( Perl_debug_log, " (%4"UVXf")\n", (UV)trie->trans[ state ].check );
1304         } else {
1305             PerlIO_printf( Perl_debug_log, " (%4"UVXf") W%4X\n", (UV)trie->trans[ state ].check,
1306             trie->states[ TRIE_NODENUM( state ) ].wordnum );
1307         }
1308     }
1309 }
1310
1311 #endif
1312
1313
1314 /* make_trie(startbranch,first,last,tail,word_count,flags,depth)
1315   startbranch: the first branch in the whole branch sequence
1316   first      : start branch of sequence of branch-exact nodes.
1317                May be the same as startbranch
1318   last       : Thing following the last branch.
1319                May be the same as tail.
1320   tail       : item following the branch sequence
1321   count      : words in the sequence
1322   flags      : currently the OP() type we will be building one of /EXACT(|F|Fl)/
1323   depth      : indent depth
1324
1325 Inplace optimizes a sequence of 2 or more Branch-Exact nodes into a TRIE node.
1326
1327 A trie is an N'ary tree where the branches are determined by digital
1328 decomposition of the key. IE, at the root node you look up the 1st character and
1329 follow that branch repeat until you find the end of the branches. Nodes can be
1330 marked as "accepting" meaning they represent a complete word. Eg:
1331
1332   /he|she|his|hers/
1333
1334 would convert into the following structure. Numbers represent states, letters
1335 following numbers represent valid transitions on the letter from that state, if
1336 the number is in square brackets it represents an accepting state, otherwise it
1337 will be in parenthesis.
1338
1339       +-h->+-e->[3]-+-r->(8)-+-s->[9]
1340       |    |
1341       |   (2)
1342       |    |
1343      (1)   +-i->(6)-+-s->[7]
1344       |
1345       +-s->(3)-+-h->(4)-+-e->[5]
1346
1347       Accept Word Mapping: 3=>1 (he),5=>2 (she), 7=>3 (his), 9=>4 (hers)
1348
1349 This shows that when matching against the string 'hers' we will begin at state 1
1350 read 'h' and move to state 2, read 'e' and move to state 3 which is accepting,
1351 then read 'r' and go to state 8 followed by 's' which takes us to state 9 which
1352 is also accepting. Thus we know that we can match both 'he' and 'hers' with a
1353 single traverse. We store a mapping from accepting to state to which word was
1354 matched, and then when we have multiple possibilities we try to complete the
1355 rest of the regex in the order in which they occured in the alternation.
1356
1357 The only prior NFA like behaviour that would be changed by the TRIE support is
1358 the silent ignoring of duplicate alternations which are of the form:
1359
1360  / (DUPE|DUPE) X? (?{ ... }) Y /x
1361
1362 Thus EVAL blocks following a trie may be called a different number of times with
1363 and without the optimisation. With the optimisations dupes will be silently
1364 ignored. This inconsistent behaviour of EVAL type nodes is well established as
1365 the following demonstrates:
1366
1367  'words'=~/(word|word|word)(?{ print $1 })[xyz]/
1368
1369 which prints out 'word' three times, but
1370
1371  'words'=~/(word|word|word)(?{ print $1 })S/
1372
1373 which doesnt print it out at all. This is due to other optimisations kicking in.
1374
1375 Example of what happens on a structural level:
1376
1377 The regexp /(ac|ad|ab)+/ will produce the following debug output:
1378
1379    1: CURLYM[1] {1,32767}(18)
1380    5:   BRANCH(8)
1381    6:     EXACT <ac>(16)
1382    8:   BRANCH(11)
1383    9:     EXACT <ad>(16)
1384   11:   BRANCH(14)
1385   12:     EXACT <ab>(16)
1386   16:   SUCCEED(0)
1387   17:   NOTHING(18)
1388   18: END(0)
1389
1390 This would be optimizable with startbranch=5, first=5, last=16, tail=16
1391 and should turn into:
1392
1393    1: CURLYM[1] {1,32767}(18)
1394    5:   TRIE(16)
1395         [Words:3 Chars Stored:6 Unique Chars:4 States:5 NCP:1]
1396           <ac>
1397           <ad>
1398           <ab>
1399   16:   SUCCEED(0)
1400   17:   NOTHING(18)
1401   18: END(0)
1402
1403 Cases where tail != last would be like /(?foo|bar)baz/:
1404
1405    1: BRANCH(4)
1406    2:   EXACT <foo>(8)
1407    4: BRANCH(7)
1408    5:   EXACT <bar>(8)
1409    7: TAIL(8)
1410    8: EXACT <baz>(10)
1411   10: END(0)
1412
1413 which would be optimizable with startbranch=1, first=1, last=7, tail=8
1414 and would end up looking like:
1415
1416     1: TRIE(8)
1417       [Words:2 Chars Stored:6 Unique Chars:5 States:7 NCP:1]
1418         <foo>
1419         <bar>
1420    7: TAIL(8)
1421    8: EXACT <baz>(10)
1422   10: END(0)
1423
1424     d = uvuni_to_utf8_flags(d, uv, 0);
1425
1426 is the recommended Unicode-aware way of saying
1427
1428     *(d++) = uv;
1429 */
1430
1431 #define TRIE_STORE_REVCHAR(val)                                            \
1432     STMT_START {                                                           \
1433         if (UTF) {                                                         \
1434             SV *zlopp = newSV(7); /* XXX: optimize me */                   \
1435             unsigned char *flrbbbbb = (unsigned char *) SvPVX(zlopp);      \
1436             unsigned const char *const kapow = uvuni_to_utf8(flrbbbbb, val); \
1437             SvCUR_set(zlopp, kapow - flrbbbbb);                            \
1438             SvPOK_on(zlopp);                                               \
1439             SvUTF8_on(zlopp);                                              \
1440             av_push(revcharmap, zlopp);                                    \
1441         } else {                                                           \
1442             char ooooff = (char)val;                                           \
1443             av_push(revcharmap, newSVpvn(&ooooff, 1));                     \
1444         }                                                                  \
1445         } STMT_END
1446
1447 #define TRIE_READ_CHAR STMT_START {                                                     \
1448     wordlen++;                                                                          \
1449     if ( UTF ) {                                                                        \
1450         /* if it is UTF then it is either already folded, or does not need folding */   \
1451         uvc = utf8n_to_uvuni( (const U8*) uc, UTF8_MAXLEN, &len, uniflags);             \
1452     }                                                                                   \
1453     else if (folder == PL_fold_latin1) {                                                \
1454         /* if we use this folder we have to obey unicode rules on latin-1 data */       \
1455         if ( foldlen > 0 ) {                                                            \
1456            uvc = utf8n_to_uvuni( (const U8*) scan, UTF8_MAXLEN, &len, uniflags );       \
1457            foldlen -= len;                                                              \
1458            scan += len;                                                                 \
1459            len = 0;                                                                     \
1460         } else {                                                                        \
1461             len = 1;                                                                    \
1462             uvc = _to_fold_latin1( (U8) *uc, foldbuf, &foldlen, FOLD_FLAGS_FULL);       \
1463             skiplen = UNISKIP(uvc);                                                     \
1464             foldlen -= skiplen;                                                         \
1465             scan = foldbuf + skiplen;                                                   \
1466         }                                                                               \
1467     } else {                                                                            \
1468         /* raw data, will be folded later if needed */                                  \
1469         uvc = (U32)*uc;                                                                 \
1470         len = 1;                                                                        \
1471     }                                                                                   \
1472 } STMT_END
1473
1474
1475
1476 #define TRIE_LIST_PUSH(state,fid,ns) STMT_START {               \
1477     if ( TRIE_LIST_CUR( state ) >=TRIE_LIST_LEN( state ) ) {    \
1478         U32 ging = TRIE_LIST_LEN( state ) *= 2;                 \
1479         Renew( trie->states[ state ].trans.list, ging, reg_trie_trans_le ); \
1480     }                                                           \
1481     TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).forid = fid;     \
1482     TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).newstate = ns;   \
1483     TRIE_LIST_CUR( state )++;                                   \
1484 } STMT_END
1485
1486 #define TRIE_LIST_NEW(state) STMT_START {                       \
1487     Newxz( trie->states[ state ].trans.list,               \
1488         4, reg_trie_trans_le );                                 \
1489      TRIE_LIST_CUR( state ) = 1;                                \
1490      TRIE_LIST_LEN( state ) = 4;                                \
1491 } STMT_END
1492
1493 #define TRIE_HANDLE_WORD(state) STMT_START {                    \
1494     U16 dupe= trie->states[ state ].wordnum;                    \
1495     regnode * const noper_next = regnext( noper );              \
1496                                                                 \
1497     DEBUG_r({                                                   \
1498         /* store the word for dumping */                        \
1499         SV* tmp;                                                \
1500         if (OP(noper) != NOTHING)                               \
1501             tmp = newSVpvn_utf8(STRING(noper), STR_LEN(noper), UTF);    \
1502         else                                                    \
1503             tmp = newSVpvn_utf8( "", 0, UTF );                  \
1504         av_push( trie_words, tmp );                             \
1505     });                                                         \
1506                                                                 \
1507     curword++;                                                  \
1508     trie->wordinfo[curword].prev   = 0;                         \
1509     trie->wordinfo[curword].len    = wordlen;                   \
1510     trie->wordinfo[curword].accept = state;                     \
1511                                                                 \
1512     if ( noper_next < tail ) {                                  \
1513         if (!trie->jump)                                        \
1514             trie->jump = (U16 *) PerlMemShared_calloc( word_count + 1, sizeof(U16) ); \
1515         trie->jump[curword] = (U16)(noper_next - convert);      \
1516         if (!jumper)                                            \
1517             jumper = noper_next;                                \
1518         if (!nextbranch)                                        \
1519             nextbranch= regnext(cur);                           \
1520     }                                                           \
1521                                                                 \
1522     if ( dupe ) {                                               \
1523         /* It's a dupe. Pre-insert into the wordinfo[].prev   */\
1524         /* chain, so that when the bits of chain are later    */\
1525         /* linked together, the dups appear in the chain      */\
1526         trie->wordinfo[curword].prev = trie->wordinfo[dupe].prev; \
1527         trie->wordinfo[dupe].prev = curword;                    \
1528     } else {                                                    \
1529         /* we haven't inserted this word yet.                */ \
1530         trie->states[ state ].wordnum = curword;                \
1531     }                                                           \
1532 } STMT_END
1533
1534
1535 #define TRIE_TRANS_STATE(state,base,ucharcount,charid,special)          \
1536      ( ( base + charid >=  ucharcount                                   \
1537          && base + charid < ubound                                      \
1538          && state == trie->trans[ base - ucharcount + charid ].check    \
1539          && trie->trans[ base - ucharcount + charid ].next )            \
1540            ? trie->trans[ base - ucharcount + charid ].next             \
1541            : ( state==1 ? special : 0 )                                 \
1542       )
1543
1544 #define MADE_TRIE       1
1545 #define MADE_JUMP_TRIE  2
1546 #define MADE_EXACT_TRIE 4
1547
1548 STATIC I32
1549 S_make_trie(pTHX_ RExC_state_t *pRExC_state, regnode *startbranch, regnode *first, regnode *last, regnode *tail, U32 word_count, U32 flags, U32 depth)
1550 {
1551     dVAR;
1552     /* first pass, loop through and scan words */
1553     reg_trie_data *trie;
1554     HV *widecharmap = NULL;
1555     AV *revcharmap = newAV();
1556     regnode *cur;
1557     const U32 uniflags = UTF8_ALLOW_DEFAULT;
1558     STRLEN len = 0;
1559     UV uvc = 0;
1560     U16 curword = 0;
1561     U32 next_alloc = 0;
1562     regnode *jumper = NULL;
1563     regnode *nextbranch = NULL;
1564     regnode *convert = NULL;
1565     U32 *prev_states; /* temp array mapping each state to previous one */
1566     /* we just use folder as a flag in utf8 */
1567     const U8 * folder = NULL;
1568
1569 #ifdef DEBUGGING
1570     const U32 data_slot = add_data( pRExC_state, 4, "tuuu" );
1571     AV *trie_words = NULL;
1572     /* along with revcharmap, this only used during construction but both are
1573      * useful during debugging so we store them in the struct when debugging.
1574      */
1575 #else
1576     const U32 data_slot = add_data( pRExC_state, 2, "tu" );
1577     STRLEN trie_charcount=0;
1578 #endif
1579     SV *re_trie_maxbuff;
1580     GET_RE_DEBUG_FLAGS_DECL;
1581
1582     PERL_ARGS_ASSERT_MAKE_TRIE;
1583 #ifndef DEBUGGING
1584     PERL_UNUSED_ARG(depth);
1585 #endif
1586
1587     switch (flags) {
1588         case EXACT: break;
1589         case EXACTFA:
1590         case EXACTFU_SS:
1591         case EXACTFU_TRICKYFOLD:
1592         case EXACTFU: folder = PL_fold_latin1; break;
1593         case EXACTF:  folder = PL_fold; break;
1594         case EXACTFL: folder = PL_fold_locale; break;
1595         default: Perl_croak( aTHX_ "panic! In trie construction, unknown node type %u %s", (unsigned) flags, PL_reg_name[flags] );
1596     }
1597
1598     trie = (reg_trie_data *) PerlMemShared_calloc( 1, sizeof(reg_trie_data) );
1599     trie->refcount = 1;
1600     trie->startstate = 1;
1601     trie->wordcount = word_count;
1602     RExC_rxi->data->data[ data_slot ] = (void*)trie;
1603     trie->charmap = (U16 *) PerlMemShared_calloc( 256, sizeof(U16) );
1604     if (flags == EXACT)
1605         trie->bitmap = (char *) PerlMemShared_calloc( ANYOF_BITMAP_SIZE, 1 );
1606     trie->wordinfo = (reg_trie_wordinfo *) PerlMemShared_calloc(
1607                        trie->wordcount+1, sizeof(reg_trie_wordinfo));
1608
1609     DEBUG_r({
1610         trie_words = newAV();
1611     });
1612
1613     re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
1614     if (!SvIOK(re_trie_maxbuff)) {
1615         sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
1616     }
1617     DEBUG_TRIE_COMPILE_r({
1618                 PerlIO_printf( Perl_debug_log,
1619                   "%*smake_trie start==%d, first==%d, last==%d, tail==%d depth=%d\n",
1620                   (int)depth * 2 + 2, "", 
1621                   REG_NODE_NUM(startbranch),REG_NODE_NUM(first), 
1622                   REG_NODE_NUM(last), REG_NODE_NUM(tail),
1623                   (int)depth);
1624     });
1625    
1626    /* Find the node we are going to overwrite */
1627     if ( first == startbranch && OP( last ) != BRANCH ) {
1628         /* whole branch chain */
1629         convert = first;
1630     } else {
1631         /* branch sub-chain */
1632         convert = NEXTOPER( first );
1633     }
1634         
1635     /*  -- First loop and Setup --
1636
1637        We first traverse the branches and scan each word to determine if it
1638        contains widechars, and how many unique chars there are, this is
1639        important as we have to build a table with at least as many columns as we
1640        have unique chars.
1641
1642        We use an array of integers to represent the character codes 0..255
1643        (trie->charmap) and we use a an HV* to store Unicode characters. We use the
1644        native representation of the character value as the key and IV's for the
1645        coded index.
1646
1647        *TODO* If we keep track of how many times each character is used we can
1648        remap the columns so that the table compression later on is more
1649        efficient in terms of memory by ensuring the most common value is in the
1650        middle and the least common are on the outside.  IMO this would be better
1651        than a most to least common mapping as theres a decent chance the most
1652        common letter will share a node with the least common, meaning the node
1653        will not be compressible. With a middle is most common approach the worst
1654        case is when we have the least common nodes twice.
1655
1656      */
1657
1658     for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
1659         regnode *noper = NEXTOPER( cur );
1660         const U8 *uc = (U8*)STRING( noper );
1661         const U8 *e  = uc + STR_LEN( noper );
1662         STRLEN foldlen = 0;
1663         U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
1664         STRLEN skiplen = 0;
1665         const U8 *scan = (U8*)NULL;
1666         U32 wordlen      = 0;         /* required init */
1667         STRLEN chars = 0;
1668         bool set_bit = trie->bitmap ? 1 : 0; /*store the first char in the bitmap?*/
1669
1670         if (OP(noper) == NOTHING) {
1671             regnode *noper_next= regnext(noper);
1672             if (noper_next != tail && OP(noper_next) == flags) {
1673                 noper = noper_next;
1674                 uc= (U8*)STRING(noper);
1675                 e= uc + STR_LEN(noper);
1676                 trie->minlen= STR_LEN(noper);
1677             } else {
1678                 trie->minlen= 0;
1679                 continue;
1680             }
1681         }
1682
1683         if ( set_bit ) { /* bitmap only alloced when !(UTF&&Folding) */
1684             TRIE_BITMAP_SET(trie,*uc); /* store the raw first byte
1685                                           regardless of encoding */
1686             if (OP( noper ) == EXACTFU_SS) {
1687                 /* false positives are ok, so just set this */
1688                 TRIE_BITMAP_SET(trie,0xDF);
1689             }
1690         }
1691         for ( ; uc < e ; uc += len ) {
1692             TRIE_CHARCOUNT(trie)++;
1693             TRIE_READ_CHAR;
1694             chars++;
1695             if ( uvc < 256 ) {
1696                 if ( folder ) {
1697                     U8 folded= folder[ (U8) uvc ];
1698                     if ( !trie->charmap[ folded ] ) {
1699                         trie->charmap[ folded ]=( ++trie->uniquecharcount );
1700                         TRIE_STORE_REVCHAR( folded );
1701                     }
1702                 }
1703                 if ( !trie->charmap[ uvc ] ) {
1704                     trie->charmap[ uvc ]=( ++trie->uniquecharcount );
1705                     TRIE_STORE_REVCHAR( uvc );
1706                 }
1707                 if ( set_bit ) {
1708                     /* store the codepoint in the bitmap, and its folded
1709                      * equivalent. */
1710                     TRIE_BITMAP_SET(trie, uvc);
1711
1712                     /* store the folded codepoint */
1713                     if ( folder ) TRIE_BITMAP_SET(trie, folder[(U8) uvc ]);
1714
1715                     if ( !UTF ) {
1716                         /* store first byte of utf8 representation of
1717                            variant codepoints */
1718                         if (! UNI_IS_INVARIANT(uvc)) {
1719                             TRIE_BITMAP_SET(trie, UTF8_TWO_BYTE_HI(uvc));
1720                         }
1721                     }
1722                     set_bit = 0; /* We've done our bit :-) */
1723                 }
1724             } else {
1725                 SV** svpp;
1726                 if ( !widecharmap )
1727                     widecharmap = newHV();
1728
1729                 svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 1 );
1730
1731                 if ( !svpp )
1732                     Perl_croak( aTHX_ "error creating/fetching widecharmap entry for 0x%"UVXf, uvc );
1733
1734                 if ( !SvTRUE( *svpp ) ) {
1735                     sv_setiv( *svpp, ++trie->uniquecharcount );
1736                     TRIE_STORE_REVCHAR(uvc);
1737                 }
1738             }
1739         }
1740         if( cur == first ) {
1741             trie->minlen = chars;
1742             trie->maxlen = chars;
1743         } else if (chars < trie->minlen) {
1744             trie->minlen = chars;
1745         } else if (chars > trie->maxlen) {
1746             trie->maxlen = chars;
1747         }
1748         if (OP( noper ) == EXACTFU_SS) {
1749             /* XXX: workaround - 'ss' could match "\x{DF}" so minlen could be 1 and not 2*/
1750             if (trie->minlen > 1)
1751                 trie->minlen= 1;
1752         }
1753         if (OP( noper ) == EXACTFU_TRICKYFOLD) {
1754             /* XXX: workround - things like "\x{1FBE}\x{0308}\x{0301}" can match "\x{0390}" 
1755              *                - We assume that any such sequence might match a 2 byte string */
1756             if (trie->minlen > 2 )
1757                 trie->minlen= 2;
1758         }
1759
1760     } /* end first pass */
1761     DEBUG_TRIE_COMPILE_r(
1762         PerlIO_printf( Perl_debug_log, "%*sTRIE(%s): W:%d C:%d Uq:%d Min:%d Max:%d\n",
1763                 (int)depth * 2 + 2,"",
1764                 ( widecharmap ? "UTF8" : "NATIVE" ), (int)word_count,
1765                 (int)TRIE_CHARCOUNT(trie), trie->uniquecharcount,
1766                 (int)trie->minlen, (int)trie->maxlen )
1767     );
1768
1769     /*
1770         We now know what we are dealing with in terms of unique chars and
1771         string sizes so we can calculate how much memory a naive
1772         representation using a flat table  will take. If it's over a reasonable
1773         limit (as specified by ${^RE_TRIE_MAXBUF}) we use a more memory
1774         conservative but potentially much slower representation using an array
1775         of lists.
1776
1777         At the end we convert both representations into the same compressed
1778         form that will be used in regexec.c for matching with. The latter
1779         is a form that cannot be used to construct with but has memory
1780         properties similar to the list form and access properties similar
1781         to the table form making it both suitable for fast searches and
1782         small enough that its feasable to store for the duration of a program.
1783
1784         See the comment in the code where the compressed table is produced
1785         inplace from the flat tabe representation for an explanation of how
1786         the compression works.
1787
1788     */
1789
1790
1791     Newx(prev_states, TRIE_CHARCOUNT(trie) + 2, U32);
1792     prev_states[1] = 0;
1793
1794     if ( (IV)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1) > SvIV(re_trie_maxbuff) ) {
1795         /*
1796             Second Pass -- Array Of Lists Representation
1797
1798             Each state will be represented by a list of charid:state records
1799             (reg_trie_trans_le) the first such element holds the CUR and LEN
1800             points of the allocated array. (See defines above).
1801
1802             We build the initial structure using the lists, and then convert
1803             it into the compressed table form which allows faster lookups
1804             (but cant be modified once converted).
1805         */
1806
1807         STRLEN transcount = 1;
1808
1809         DEBUG_TRIE_COMPILE_MORE_r( PerlIO_printf( Perl_debug_log, 
1810             "%*sCompiling trie using list compiler\n",
1811             (int)depth * 2 + 2, ""));
1812
1813         trie->states = (reg_trie_state *)
1814             PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
1815                                   sizeof(reg_trie_state) );
1816         TRIE_LIST_NEW(1);
1817         next_alloc = 2;
1818
1819         for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
1820
1821             regnode *noper   = NEXTOPER( cur );
1822             U8 *uc           = (U8*)STRING( noper );
1823             const U8 *e      = uc + STR_LEN( noper );
1824             U32 state        = 1;         /* required init */
1825             U16 charid       = 0;         /* sanity init */
1826             U8 *scan         = (U8*)NULL; /* sanity init */
1827             STRLEN foldlen   = 0;         /* required init */
1828             U32 wordlen      = 0;         /* required init */
1829             U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
1830             STRLEN skiplen   = 0;
1831
1832             if (OP(noper) == NOTHING) {
1833                 regnode *noper_next= regnext(noper);
1834                 if (noper_next != tail && OP(noper_next) == flags) {
1835                     noper = noper_next;
1836                     uc= (U8*)STRING(noper);
1837                     e= uc + STR_LEN(noper);
1838                 }
1839             }
1840
1841             if (OP(noper) != NOTHING) {
1842                 for ( ; uc < e ; uc += len ) {
1843
1844                     TRIE_READ_CHAR;
1845
1846                     if ( uvc < 256 ) {
1847                         charid = trie->charmap[ uvc ];
1848                     } else {
1849                         SV** const svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 0);
1850                         if ( !svpp ) {
1851                             charid = 0;
1852                         } else {
1853                             charid=(U16)SvIV( *svpp );
1854                         }
1855                     }
1856                     /* charid is now 0 if we dont know the char read, or nonzero if we do */
1857                     if ( charid ) {
1858
1859                         U16 check;
1860                         U32 newstate = 0;
1861
1862                         charid--;
1863                         if ( !trie->states[ state ].trans.list ) {
1864                             TRIE_LIST_NEW( state );
1865                         }
1866                         for ( check = 1; check <= TRIE_LIST_USED( state ); check++ ) {
1867                             if ( TRIE_LIST_ITEM( state, check ).forid == charid ) {
1868                                 newstate = TRIE_LIST_ITEM( state, check ).newstate;
1869                                 break;
1870                             }
1871                         }
1872                         if ( ! newstate ) {
1873                             newstate = next_alloc++;
1874                             prev_states[newstate] = state;
1875                             TRIE_LIST_PUSH( state, charid, newstate );
1876                             transcount++;
1877                         }
1878                         state = newstate;
1879                     } else {
1880                         Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %"IVdf, uvc );
1881                     }
1882                 }
1883             }
1884             TRIE_HANDLE_WORD(state);
1885
1886         } /* end second pass */
1887
1888         /* next alloc is the NEXT state to be allocated */
1889         trie->statecount = next_alloc; 
1890         trie->states = (reg_trie_state *)
1891             PerlMemShared_realloc( trie->states,
1892                                    next_alloc
1893                                    * sizeof(reg_trie_state) );
1894
1895         /* and now dump it out before we compress it */
1896         DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_list(trie, widecharmap,
1897                                                          revcharmap, next_alloc,
1898                                                          depth+1)
1899         );
1900
1901         trie->trans = (reg_trie_trans *)
1902             PerlMemShared_calloc( transcount, sizeof(reg_trie_trans) );
1903         {
1904             U32 state;
1905             U32 tp = 0;
1906             U32 zp = 0;
1907
1908
1909             for( state=1 ; state < next_alloc ; state ++ ) {
1910                 U32 base=0;
1911
1912                 /*
1913                 DEBUG_TRIE_COMPILE_MORE_r(
1914                     PerlIO_printf( Perl_debug_log, "tp: %d zp: %d ",tp,zp)
1915                 );
1916                 */
1917
1918                 if (trie->states[state].trans.list) {
1919                     U16 minid=TRIE_LIST_ITEM( state, 1).forid;
1920                     U16 maxid=minid;
1921                     U16 idx;
1922
1923                     for( idx = 2 ; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
1924                         const U16 forid = TRIE_LIST_ITEM( state, idx).forid;
1925                         if ( forid < minid ) {
1926                             minid=forid;
1927                         } else if ( forid > maxid ) {
1928                             maxid=forid;
1929                         }
1930                     }
1931                     if ( transcount < tp + maxid - minid + 1) {
1932                         transcount *= 2;
1933                         trie->trans = (reg_trie_trans *)
1934                             PerlMemShared_realloc( trie->trans,
1935                                                      transcount
1936                                                      * sizeof(reg_trie_trans) );
1937                         Zero( trie->trans + (transcount / 2), transcount / 2 , reg_trie_trans );
1938                     }
1939                     base = trie->uniquecharcount + tp - minid;
1940                     if ( maxid == minid ) {
1941                         U32 set = 0;
1942                         for ( ; zp < tp ; zp++ ) {
1943                             if ( ! trie->trans[ zp ].next ) {
1944                                 base = trie->uniquecharcount + zp - minid;
1945                                 trie->trans[ zp ].next = TRIE_LIST_ITEM( state, 1).newstate;
1946                                 trie->trans[ zp ].check = state;
1947                                 set = 1;
1948                                 break;
1949                             }
1950                         }
1951                         if ( !set ) {
1952                             trie->trans[ tp ].next = TRIE_LIST_ITEM( state, 1).newstate;
1953                             trie->trans[ tp ].check = state;
1954                             tp++;
1955                             zp = tp;
1956                         }
1957                     } else {
1958                         for ( idx=1; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
1959                             const U32 tid = base -  trie->uniquecharcount + TRIE_LIST_ITEM( state, idx ).forid;
1960                             trie->trans[ tid ].next = TRIE_LIST_ITEM( state, idx ).newstate;
1961                             trie->trans[ tid ].check = state;
1962                         }
1963                         tp += ( maxid - minid + 1 );
1964                     }
1965                     Safefree(trie->states[ state ].trans.list);
1966                 }
1967                 /*
1968                 DEBUG_TRIE_COMPILE_MORE_r(
1969                     PerlIO_printf( Perl_debug_log, " base: %d\n",base);
1970                 );
1971                 */
1972                 trie->states[ state ].trans.base=base;
1973             }
1974             trie->lasttrans = tp + 1;
1975         }
1976     } else {
1977         /*
1978            Second Pass -- Flat Table Representation.
1979
1980            we dont use the 0 slot of either trans[] or states[] so we add 1 to each.
1981            We know that we will need Charcount+1 trans at most to store the data
1982            (one row per char at worst case) So we preallocate both structures
1983            assuming worst case.
1984
1985            We then construct the trie using only the .next slots of the entry
1986            structs.
1987
1988            We use the .check field of the first entry of the node temporarily to
1989            make compression both faster and easier by keeping track of how many non
1990            zero fields are in the node.
1991
1992            Since trans are numbered from 1 any 0 pointer in the table is a FAIL
1993            transition.
1994
1995            There are two terms at use here: state as a TRIE_NODEIDX() which is a
1996            number representing the first entry of the node, and state as a
1997            TRIE_NODENUM() which is the trans number. state 1 is TRIE_NODEIDX(1) and
1998            TRIE_NODENUM(1), state 2 is TRIE_NODEIDX(2) and TRIE_NODENUM(3) if there
1999            are 2 entrys per node. eg:
2000
2001              A B       A B
2002           1. 2 4    1. 3 7
2003           2. 0 3    3. 0 5
2004           3. 0 0    5. 0 0
2005           4. 0 0    7. 0 0
2006
2007            The table is internally in the right hand, idx form. However as we also
2008            have to deal with the states array which is indexed by nodenum we have to
2009            use TRIE_NODENUM() to convert.
2010
2011         */
2012         DEBUG_TRIE_COMPILE_MORE_r( PerlIO_printf( Perl_debug_log, 
2013             "%*sCompiling trie using table compiler\n",
2014             (int)depth * 2 + 2, ""));
2015
2016         trie->trans = (reg_trie_trans *)
2017             PerlMemShared_calloc( ( TRIE_CHARCOUNT(trie) + 1 )
2018                                   * trie->uniquecharcount + 1,
2019                                   sizeof(reg_trie_trans) );
2020         trie->states = (reg_trie_state *)
2021             PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
2022                                   sizeof(reg_trie_state) );
2023         next_alloc = trie->uniquecharcount + 1;
2024
2025
2026         for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
2027
2028             regnode *noper   = NEXTOPER( cur );
2029             const U8 *uc     = (U8*)STRING( noper );
2030             const U8 *e      = uc + STR_LEN( noper );
2031
2032             U32 state        = 1;         /* required init */
2033
2034             U16 charid       = 0;         /* sanity init */
2035             U32 accept_state = 0;         /* sanity init */
2036             U8 *scan         = (U8*)NULL; /* sanity init */
2037
2038             STRLEN foldlen   = 0;         /* required init */
2039             U32 wordlen      = 0;         /* required init */
2040             STRLEN skiplen   = 0;
2041             U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
2042
2043             if (OP(noper) == NOTHING) {
2044                 regnode *noper_next= regnext(noper);
2045                 if (noper_next != tail && OP(noper_next) == flags) {
2046                     noper = noper_next;
2047                     uc= (U8*)STRING(noper);
2048                     e= uc + STR_LEN(noper);
2049                 }
2050             }
2051
2052             if ( OP(noper) != NOTHING ) {
2053                 for ( ; uc < e ; uc += len ) {
2054
2055                     TRIE_READ_CHAR;
2056
2057                     if ( uvc < 256 ) {
2058                         charid = trie->charmap[ uvc ];
2059                     } else {
2060                         SV* const * const svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 0);
2061                         charid = svpp ? (U16)SvIV(*svpp) : 0;
2062                     }
2063                     if ( charid ) {
2064                         charid--;
2065                         if ( !trie->trans[ state + charid ].next ) {
2066                             trie->trans[ state + charid ].next = next_alloc;
2067                             trie->trans[ state ].check++;
2068                             prev_states[TRIE_NODENUM(next_alloc)]
2069                                     = TRIE_NODENUM(state);
2070                             next_alloc += trie->uniquecharcount;
2071                         }
2072                         state = trie->trans[ state + charid ].next;
2073                     } else {
2074                         Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %"IVdf, uvc );
2075                     }
2076                     /* charid is now 0 if we dont know the char read, or nonzero if we do */
2077                 }
2078             }
2079             accept_state = TRIE_NODENUM( state );
2080             TRIE_HANDLE_WORD(accept_state);
2081
2082         } /* end second pass */
2083
2084         /* and now dump it out before we compress it */
2085         DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_table(trie, widecharmap,
2086                                                           revcharmap,
2087                                                           next_alloc, depth+1));
2088
2089         {
2090         /*
2091            * Inplace compress the table.*
2092
2093            For sparse data sets the table constructed by the trie algorithm will
2094            be mostly 0/FAIL transitions or to put it another way mostly empty.
2095            (Note that leaf nodes will not contain any transitions.)
2096
2097            This algorithm compresses the tables by eliminating most such
2098            transitions, at the cost of a modest bit of extra work during lookup:
2099
2100            - Each states[] entry contains a .base field which indicates the
2101            index in the state[] array wheres its transition data is stored.
2102
2103            - If .base is 0 there are no valid transitions from that node.
2104
2105            - If .base is nonzero then charid is added to it to find an entry in
2106            the trans array.
2107
2108            -If trans[states[state].base+charid].check!=state then the
2109            transition is taken to be a 0/Fail transition. Thus if there are fail
2110            transitions at the front of the node then the .base offset will point
2111            somewhere inside the previous nodes data (or maybe even into a node
2112            even earlier), but the .check field determines if the transition is
2113            valid.
2114
2115            XXX - wrong maybe?
2116            The following process inplace converts the table to the compressed
2117            table: We first do not compress the root node 1,and mark all its
2118            .check pointers as 1 and set its .base pointer as 1 as well. This
2119            allows us to do a DFA construction from the compressed table later,
2120            and ensures that any .base pointers we calculate later are greater
2121            than 0.
2122
2123            - We set 'pos' to indicate the first entry of the second node.
2124
2125            - We then iterate over the columns of the node, finding the first and
2126            last used entry at l and m. We then copy l..m into pos..(pos+m-l),
2127            and set the .check pointers accordingly, and advance pos
2128            appropriately and repreat for the next node. Note that when we copy
2129            the next pointers we have to convert them from the original
2130            NODEIDX form to NODENUM form as the former is not valid post
2131            compression.
2132
2133            - If a node has no transitions used we mark its base as 0 and do not
2134            advance the pos pointer.
2135
2136            - If a node only has one transition we use a second pointer into the
2137            structure to fill in allocated fail transitions from other states.
2138            This pointer is independent of the main pointer and scans forward
2139            looking for null transitions that are allocated to a state. When it
2140            finds one it writes the single transition into the "hole".  If the
2141            pointer doesnt find one the single transition is appended as normal.
2142
2143            - Once compressed we can Renew/realloc the structures to release the
2144            excess space.
2145
2146            See "Table-Compression Methods" in sec 3.9 of the Red Dragon,
2147            specifically Fig 3.47 and the associated pseudocode.
2148
2149            demq
2150         */
2151         const U32 laststate = TRIE_NODENUM( next_alloc );
2152         U32 state, charid;
2153         U32 pos = 0, zp=0;
2154         trie->statecount = laststate;
2155
2156         for ( state = 1 ; state < laststate ; state++ ) {
2157             U8 flag = 0;
2158             const U32 stateidx = TRIE_NODEIDX( state );
2159             const U32 o_used = trie->trans[ stateidx ].check;
2160             U32 used = trie->trans[ stateidx ].check;
2161             trie->trans[ stateidx ].check = 0;
2162
2163             for ( charid = 0 ; used && charid < trie->uniquecharcount ; charid++ ) {
2164                 if ( flag || trie->trans[ stateidx + charid ].next ) {
2165                     if ( trie->trans[ stateidx + charid ].next ) {
2166                         if (o_used == 1) {
2167                             for ( ; zp < pos ; zp++ ) {
2168                                 if ( ! trie->trans[ zp ].next ) {
2169                                     break;
2170                                 }
2171                             }
2172                             trie->states[ state ].trans.base = zp + trie->uniquecharcount - charid ;
2173                             trie->trans[ zp ].next = SAFE_TRIE_NODENUM( trie->trans[ stateidx + charid ].next );
2174                             trie->trans[ zp ].check = state;
2175                             if ( ++zp > pos ) pos = zp;
2176                             break;
2177                         }
2178                         used--;
2179                     }
2180                     if ( !flag ) {
2181                         flag = 1;
2182                         trie->states[ state ].trans.base = pos + trie->uniquecharcount - charid ;
2183                     }
2184                     trie->trans[ pos ].next = SAFE_TRIE_NODENUM( trie->trans[ stateidx + charid ].next );
2185                     trie->trans[ pos ].check = state;
2186                     pos++;
2187                 }
2188             }
2189         }
2190         trie->lasttrans = pos + 1;
2191         trie->states = (reg_trie_state *)
2192             PerlMemShared_realloc( trie->states, laststate
2193                                    * sizeof(reg_trie_state) );
2194         DEBUG_TRIE_COMPILE_MORE_r(
2195                 PerlIO_printf( Perl_debug_log,
2196                     "%*sAlloc: %d Orig: %"IVdf" elements, Final:%"IVdf". Savings of %%%5.2f\n",
2197                     (int)depth * 2 + 2,"",
2198                     (int)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1 ),
2199                     (IV)next_alloc,
2200                     (IV)pos,
2201                     ( ( next_alloc - pos ) * 100 ) / (double)next_alloc );
2202             );
2203
2204         } /* end table compress */
2205     }
2206     DEBUG_TRIE_COMPILE_MORE_r(
2207             PerlIO_printf(Perl_debug_log, "%*sStatecount:%"UVxf" Lasttrans:%"UVxf"\n",
2208                 (int)depth * 2 + 2, "",
2209                 (UV)trie->statecount,
2210                 (UV)trie->lasttrans)
2211     );
2212     /* resize the trans array to remove unused space */
2213     trie->trans = (reg_trie_trans *)
2214         PerlMemShared_realloc( trie->trans, trie->lasttrans
2215                                * sizeof(reg_trie_trans) );
2216
2217     {   /* Modify the program and insert the new TRIE node */ 
2218         U8 nodetype =(U8)(flags & 0xFF);
2219         char *str=NULL;
2220         
2221 #ifdef DEBUGGING
2222         regnode *optimize = NULL;
2223 #ifdef RE_TRACK_PATTERN_OFFSETS
2224
2225         U32 mjd_offset = 0;
2226         U32 mjd_nodelen = 0;
2227 #endif /* RE_TRACK_PATTERN_OFFSETS */
2228 #endif /* DEBUGGING */
2229         /*
2230            This means we convert either the first branch or the first Exact,
2231            depending on whether the thing following (in 'last') is a branch
2232            or not and whther first is the startbranch (ie is it a sub part of
2233            the alternation or is it the whole thing.)
2234            Assuming its a sub part we convert the EXACT otherwise we convert
2235            the whole branch sequence, including the first.
2236          */
2237         /* Find the node we are going to overwrite */
2238         if ( first != startbranch || OP( last ) == BRANCH ) {
2239             /* branch sub-chain */
2240             NEXT_OFF( first ) = (U16)(last - first);
2241 #ifdef RE_TRACK_PATTERN_OFFSETS
2242             DEBUG_r({
2243                 mjd_offset= Node_Offset((convert));
2244                 mjd_nodelen= Node_Length((convert));
2245             });
2246 #endif
2247             /* whole branch chain */
2248         }
2249 #ifdef RE_TRACK_PATTERN_OFFSETS
2250         else {
2251             DEBUG_r({
2252                 const  regnode *nop = NEXTOPER( convert );
2253                 mjd_offset= Node_Offset((nop));
2254                 mjd_nodelen= Node_Length((nop));
2255             });
2256         }
2257         DEBUG_OPTIMISE_r(
2258             PerlIO_printf(Perl_debug_log, "%*sMJD offset:%"UVuf" MJD length:%"UVuf"\n",
2259                 (int)depth * 2 + 2, "",
2260                 (UV)mjd_offset, (UV)mjd_nodelen)
2261         );
2262 #endif
2263         /* But first we check to see if there is a common prefix we can 
2264            split out as an EXACT and put in front of the TRIE node.  */
2265         trie->startstate= 1;
2266         if ( trie->bitmap && !widecharmap && !trie->jump  ) {
2267             U32 state;
2268             for ( state = 1 ; state < trie->statecount-1 ; state++ ) {
2269                 U32 ofs = 0;
2270                 I32 idx = -1;
2271                 U32 count = 0;
2272                 const U32 base = trie->states[ state ].trans.base;
2273
2274                 if ( trie->states[state].wordnum )
2275                         count = 1;
2276
2277                 for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
2278                     if ( ( base + ofs >= trie->uniquecharcount ) &&
2279                          ( base + ofs - trie->uniquecharcount < trie->lasttrans ) &&
2280                          trie->trans[ base + ofs - trie->uniquecharcount ].check == state )
2281                     {
2282                         if ( ++count > 1 ) {
2283                             SV **tmp = av_fetch( revcharmap, ofs, 0);
2284                             const U8 *ch = (U8*)SvPV_nolen_const( *tmp );
2285                             if ( state == 1 ) break;
2286                             if ( count == 2 ) {
2287                                 Zero(trie->bitmap, ANYOF_BITMAP_SIZE, char);
2288                                 DEBUG_OPTIMISE_r(
2289                                     PerlIO_printf(Perl_debug_log,
2290                                         "%*sNew Start State=%"UVuf" Class: [",
2291                                         (int)depth * 2 + 2, "",
2292                                         (UV)state));
2293                                 if (idx >= 0) {
2294                                     SV ** const tmp = av_fetch( revcharmap, idx, 0);
2295                                     const U8 * const ch = (U8*)SvPV_nolen_const( *tmp );
2296
2297                                     TRIE_BITMAP_SET(trie,*ch);
2298                                     if ( folder )
2299                                         TRIE_BITMAP_SET(trie, folder[ *ch ]);
2300                                     DEBUG_OPTIMISE_r(
2301                                         PerlIO_printf(Perl_debug_log, "%s", (char*)ch)
2302                                     );
2303                                 }
2304                             }
2305                             TRIE_BITMAP_SET(trie,*ch);
2306                             if ( folder )
2307                                 TRIE_BITMAP_SET(trie,folder[ *ch ]);
2308                             DEBUG_OPTIMISE_r(PerlIO_printf( Perl_debug_log,"%s", ch));
2309                         }
2310                         idx = ofs;
2311                     }
2312                 }
2313                 if ( count == 1 ) {
2314                     SV **tmp = av_fetch( revcharmap, idx, 0);
2315                     STRLEN len;
2316                     char *ch = SvPV( *tmp, len );
2317                     DEBUG_OPTIMISE_r({
2318                         SV *sv=sv_newmortal();
2319                         PerlIO_printf( Perl_debug_log,
2320                             "%*sPrefix State: %"UVuf" Idx:%"UVuf" Char='%s'\n",
2321                             (int)depth * 2 + 2, "",
2322                             (UV)state, (UV)idx, 
2323                             pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), 6, 
2324                                 PL_colors[0], PL_colors[1],
2325                                 (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
2326                                 PERL_PV_ESCAPE_FIRSTCHAR 
2327                             )
2328                         );
2329                     });
2330                     if ( state==1 ) {
2331                         OP( convert ) = nodetype;
2332                         str=STRING(convert);
2333                         STR_LEN(convert)=0;
2334                     }
2335                     STR_LEN(convert) += len;
2336                     while (len--)
2337                         *str++ = *ch++;
2338                 } else {
2339 #ifdef DEBUGGING            
2340                     if (state>1)
2341                         DEBUG_OPTIMISE_r(PerlIO_printf( Perl_debug_log,"]\n"));
2342 #endif
2343                     break;
2344                 }
2345             }
2346             trie->prefixlen = (state-1);
2347             if (str) {
2348                 regnode *n = convert+NODE_SZ_STR(convert);
2349                 NEXT_OFF(convert) = NODE_SZ_STR(convert);
2350                 trie->startstate = state;
2351                 trie->minlen -= (state - 1);
2352                 trie->maxlen -= (state - 1);
2353 #ifdef DEBUGGING
2354                /* At least the UNICOS C compiler choked on this
2355                 * being argument to DEBUG_r(), so let's just have
2356                 * it right here. */
2357                if (
2358 #ifdef PERL_EXT_RE_BUILD
2359                    1
2360 #else
2361                    DEBUG_r_TEST
2362 #endif
2363                    ) {
2364                    regnode *fix = convert;
2365                    U32 word = trie->wordcount;
2366                    mjd_nodelen++;
2367                    Set_Node_Offset_Length(convert, mjd_offset, state - 1);
2368                    while( ++fix < n ) {
2369                        Set_Node_Offset_Length(fix, 0, 0);
2370                    }
2371                    while (word--) {
2372                        SV ** const tmp = av_fetch( trie_words, word, 0 );
2373                        if (tmp) {
2374                            if ( STR_LEN(convert) <= SvCUR(*tmp) )
2375                                sv_chop(*tmp, SvPV_nolen(*tmp) + STR_LEN(convert));
2376                            else
2377                                sv_chop(*tmp, SvPV_nolen(*tmp) + SvCUR(*tmp));
2378                        }
2379                    }
2380                }
2381 #endif
2382                 if (trie->maxlen) {
2383                     convert = n;
2384                 } else {
2385                     NEXT_OFF(convert) = (U16)(tail - convert);
2386                     DEBUG_r(optimize= n);
2387                 }
2388             }
2389         }
2390         if (!jumper) 
2391             jumper = last; 
2392         if ( trie->maxlen ) {
2393             NEXT_OFF( convert ) = (U16)(tail - convert);
2394             ARG_SET( convert, data_slot );
2395             /* Store the offset to the first unabsorbed branch in 
2396                jump[0], which is otherwise unused by the jump logic. 
2397                We use this when dumping a trie and during optimisation. */
2398             if (trie->jump) 
2399                 trie->jump[0] = (U16)(nextbranch - convert);
2400             
2401             /* If the start state is not accepting (meaning there is no empty string/NOTHING)
2402              *   and there is a bitmap
2403              *   and the first "jump target" node we found leaves enough room
2404              * then convert the TRIE node into a TRIEC node, with the bitmap
2405              * embedded inline in the opcode - this is hypothetically faster.
2406              */
2407             if ( !trie->states[trie->startstate].wordnum
2408                  && trie->bitmap
2409                  && ( (char *)jumper - (char *)convert) >= (int)sizeof(struct regnode_charclass) )
2410             {
2411                 OP( convert ) = TRIEC;
2412                 Copy(trie->bitmap, ((struct regnode_charclass *)convert)->bitmap, ANYOF_BITMAP_SIZE, char);
2413                 PerlMemShared_free(trie->bitmap);
2414                 trie->bitmap= NULL;
2415             } else 
2416                 OP( convert ) = TRIE;
2417
2418             /* store the type in the flags */
2419             convert->flags = nodetype;
2420             DEBUG_r({
2421             optimize = convert 
2422                       + NODE_STEP_REGNODE 
2423                       + regarglen[ OP( convert ) ];
2424             });
2425             /* XXX We really should free up the resource in trie now, 
2426                    as we won't use them - (which resources?) dmq */
2427         }
2428         /* needed for dumping*/
2429         DEBUG_r(if (optimize) {
2430             regnode *opt = convert;
2431
2432             while ( ++opt < optimize) {
2433                 Set_Node_Offset_Length(opt,0,0);
2434             }
2435             /* 
2436                 Try to clean up some of the debris left after the 
2437                 optimisation.
2438              */
2439             while( optimize < jumper ) {
2440                 mjd_nodelen += Node_Length((optimize));
2441                 OP( optimize ) = OPTIMIZED;
2442                 Set_Node_Offset_Length(optimize,0,0);
2443                 optimize++;
2444             }
2445             Set_Node_Offset_Length(convert,mjd_offset,mjd_nodelen);
2446         });
2447     } /* end node insert */
2448
2449     /*  Finish populating the prev field of the wordinfo array.  Walk back
2450      *  from each accept state until we find another accept state, and if
2451      *  so, point the first word's .prev field at the second word. If the
2452      *  second already has a .prev field set, stop now. This will be the
2453      *  case either if we've already processed that word's accept state,
2454      *  or that state had multiple words, and the overspill words were
2455      *  already linked up earlier.
2456      */
2457     {
2458         U16 word;
2459         U32 state;
2460         U16 prev;
2461
2462         for (word=1; word <= trie->wordcount; word++) {
2463             prev = 0;
2464             if (trie->wordinfo[word].prev)
2465                 continue;
2466             state = trie->wordinfo[word].accept;
2467             while (state) {
2468                 state = prev_states[state];
2469                 if (!state)
2470                     break;
2471                 prev = trie->states[state].wordnum;
2472                 if (prev)
2473                     break;
2474             }
2475             trie->wordinfo[word].prev = prev;
2476         }
2477         Safefree(prev_states);
2478     }
2479
2480
2481     /* and now dump out the compressed format */
2482     DEBUG_TRIE_COMPILE_r(dump_trie(trie, widecharmap, revcharmap, depth+1));
2483
2484     RExC_rxi->data->data[ data_slot + 1 ] = (void*)widecharmap;
2485 #ifdef DEBUGGING
2486     RExC_rxi->data->data[ data_slot + TRIE_WORDS_OFFSET ] = (void*)trie_words;
2487     RExC_rxi->data->data[ data_slot + 3 ] = (void*)revcharmap;
2488 #else
2489     SvREFCNT_dec_NN(revcharmap);
2490 #endif
2491     return trie->jump 
2492            ? MADE_JUMP_TRIE 
2493            : trie->startstate>1 
2494              ? MADE_EXACT_TRIE 
2495              : MADE_TRIE;
2496 }
2497
2498 STATIC void
2499 S_make_trie_failtable(pTHX_ RExC_state_t *pRExC_state, regnode *source,  regnode *stclass, U32 depth)
2500 {
2501 /* The Trie is constructed and compressed now so we can build a fail array if it's needed
2502
2503    This is basically the Aho-Corasick algorithm. Its from exercise 3.31 and 3.32 in the
2504    "Red Dragon" -- Compilers, principles, techniques, and tools. Aho, Sethi, Ullman 1985/88
2505    ISBN 0-201-10088-6
2506
2507    We find the fail state for each state in the trie, this state is the longest proper
2508    suffix of the current state's 'word' that is also a proper prefix of another word in our
2509    trie. State 1 represents the word '' and is thus the default fail state. This allows
2510    the DFA not to have to restart after its tried and failed a word at a given point, it
2511    simply continues as though it had been matching the other word in the first place.
2512    Consider
2513       'abcdgu'=~/abcdefg|cdgu/
2514    When we get to 'd' we are still matching the first word, we would encounter 'g' which would
2515    fail, which would bring us to the state representing 'd' in the second word where we would
2516    try 'g' and succeed, proceeding to match 'cdgu'.
2517  */
2518  /* add a fail transition */
2519     const U32 trie_offset = ARG(source);
2520     reg_trie_data *trie=(reg_trie_data *)RExC_rxi->data->data[trie_offset];
2521     U32 *q;
2522     const U32 ucharcount = trie->uniquecharcount;
2523     const U32 numstates = trie->statecount;
2524     const U32 ubound = trie->lasttrans + ucharcount;
2525     U32 q_read = 0;
2526     U32 q_write = 0;
2527     U32 charid;
2528     U32 base = trie->states[ 1 ].trans.base;
2529     U32 *fail;
2530     reg_ac_data *aho;
2531     const U32 data_slot = add_data( pRExC_state, 1, "T" );
2532     GET_RE_DEBUG_FLAGS_DECL;
2533
2534     PERL_ARGS_ASSERT_MAKE_TRIE_FAILTABLE;
2535 #ifndef DEBUGGING
2536     PERL_UNUSED_ARG(depth);
2537 #endif
2538
2539
2540     ARG_SET( stclass, data_slot );
2541     aho = (reg_ac_data *) PerlMemShared_calloc( 1, sizeof(reg_ac_data) );
2542     RExC_rxi->data->data[ data_slot ] = (void*)aho;
2543     aho->trie=trie_offset;
2544     aho->states=(reg_trie_state *)PerlMemShared_malloc( numstates * sizeof(reg_trie_state) );
2545     Copy( trie->states, aho->states, numstates, reg_trie_state );
2546     Newxz( q, numstates, U32);
2547     aho->fail = (U32 *) PerlMemShared_calloc( numstates, sizeof(U32) );
2548     aho->refcount = 1;
2549     fail = aho->fail;
2550     /* initialize fail[0..1] to be 1 so that we always have
2551        a valid final fail state */
2552     fail[ 0 ] = fail[ 1 ] = 1;
2553
2554     for ( charid = 0; charid < ucharcount ; charid++ ) {
2555         const U32 newstate = TRIE_TRANS_STATE( 1, base, ucharcount, charid, 0 );
2556         if ( newstate ) {
2557             q[ q_write ] = newstate;
2558             /* set to point at the root */
2559             fail[ q[ q_write++ ] ]=1;
2560         }
2561     }
2562     while ( q_read < q_write) {
2563         const U32 cur = q[ q_read++ % numstates ];
2564         base = trie->states[ cur ].trans.base;
2565
2566         for ( charid = 0 ; charid < ucharcount ; charid++ ) {
2567             const U32 ch_state = TRIE_TRANS_STATE( cur, base, ucharcount, charid, 1 );
2568             if (ch_state) {
2569                 U32 fail_state = cur;
2570                 U32 fail_base;
2571                 do {
2572                     fail_state = fail[ fail_state ];
2573                     fail_base = aho->states[ fail_state ].trans.base;
2574                 } while ( !TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 ) );
2575
2576                 fail_state = TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 );
2577                 fail[ ch_state ] = fail_state;
2578                 if ( !aho->states[ ch_state ].wordnum && aho->states[ fail_state ].wordnum )
2579                 {
2580                         aho->states[ ch_state ].wordnum =  aho->states[ fail_state ].wordnum;
2581                 }
2582                 q[ q_write++ % numstates] = ch_state;
2583             }
2584         }
2585     }
2586     /* restore fail[0..1] to 0 so that we "fall out" of the AC loop
2587        when we fail in state 1, this allows us to use the
2588        charclass scan to find a valid start char. This is based on the principle
2589        that theres a good chance the string being searched contains lots of stuff
2590        that cant be a start char.
2591      */
2592     fail[ 0 ] = fail[ 1 ] = 0;
2593     DEBUG_TRIE_COMPILE_r({
2594         PerlIO_printf(Perl_debug_log,
2595                       "%*sStclass Failtable (%"UVuf" states): 0", 
2596                       (int)(depth * 2), "", (UV)numstates
2597         );
2598         for( q_read=1; q_read<numstates; q_read++ ) {
2599             PerlIO_printf(Perl_debug_log, ", %"UVuf, (UV)fail[q_read]);
2600         }
2601         PerlIO_printf(Perl_debug_log, "\n");
2602     });
2603     Safefree(q);
2604     /*RExC_seen |= REG_SEEN_TRIEDFA;*/
2605 }
2606
2607
2608 /*
2609  * There are strange code-generation bugs caused on sparc64 by gcc-2.95.2.
2610  * These need to be revisited when a newer toolchain becomes available.
2611  */
2612 #if defined(__sparc64__) && defined(__GNUC__)
2613 #   if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 96)
2614 #       undef  SPARC64_GCC_WORKAROUND
2615 #       define SPARC64_GCC_WORKAROUND 1
2616 #   endif
2617 #endif
2618
2619 #define DEBUG_PEEP(str,scan,depth) \
2620     DEBUG_OPTIMISE_r({if (scan){ \
2621        SV * const mysv=sv_newmortal(); \
2622        regnode *Next = regnext(scan); \
2623        regprop(RExC_rx, mysv, scan); \
2624        PerlIO_printf(Perl_debug_log, "%*s" str ">%3d: %s (%d)\n", \
2625        (int)depth*2, "", REG_NODE_NUM(scan), SvPV_nolen_const(mysv),\
2626        Next ? (REG_NODE_NUM(Next)) : 0 ); \
2627    }});
2628
2629
2630 /* The below joins as many adjacent EXACTish nodes as possible into a single
2631  * one.  The regop may be changed if the node(s) contain certain sequences that
2632  * require special handling.  The joining is only done if:
2633  * 1) there is room in the current conglomerated node to entirely contain the
2634  *    next one.
2635  * 2) they are the exact same node type
2636  *
2637  * The adjacent nodes actually may be separated by NOTHING-kind nodes, and
2638  * these get optimized out
2639  *
2640  * If a node is to match under /i (folded), the number of characters it matches
2641  * can be different than its character length if it contains a multi-character
2642  * fold.  *min_subtract is set to the total delta of the input nodes.
2643  *
2644  * And *has_exactf_sharp_s is set to indicate whether or not the node is EXACTF
2645  * and contains LATIN SMALL LETTER SHARP S
2646  *
2647  * This is as good a place as any to discuss the design of handling these
2648  * multi-character fold sequences.  It's been wrong in Perl for a very long
2649  * time.  There are three code points in Unicode whose multi-character folds
2650  * were long ago discovered to mess things up.  The previous designs for
2651  * dealing with these involved assigning a special node for them.  This
2652  * approach doesn't work, as evidenced by this example:
2653  *      "\xDFs" =~ /s\xDF/ui    # Used to fail before these patches
2654  * Both these fold to "sss", but if the pattern is parsed to create a node that
2655  * would match just the \xDF, it won't be able to handle the case where a
2656  * successful match would have to cross the node's boundary.  The new approach
2657  * that hopefully generally solves the problem generates an EXACTFU_SS node
2658  * that is "sss".
2659  *
2660  * It turns out that there are problems with all multi-character folds, and not
2661  * just these three.  Now the code is general, for all such cases, but the
2662  * three still have some special handling.  The approach taken is:
2663  * 1)   This routine examines each EXACTFish node that could contain multi-
2664  *      character fold sequences.  It returns in *min_subtract how much to
2665  *      subtract from the the actual length of the string to get a real minimum
2666  *      match length; it is 0 if there are no multi-char folds.  This delta is
2667  *      used by the caller to adjust the min length of the match, and the delta
2668  *      between min and max, so that the optimizer doesn't reject these
2669  *      possibilities based on size constraints.
2670  * 2)   Certain of these sequences require special handling by the trie code,
2671  *      so, if found, this code changes the joined node type to special ops:
2672  *      EXACTFU_TRICKYFOLD and EXACTFU_SS.
2673  * 3)   For the sequence involving the Sharp s (\xDF), the node type EXACTFU_SS
2674  *      is used for an EXACTFU node that contains at least one "ss" sequence in
2675  *      it.  For non-UTF-8 patterns and strings, this is the only case where
2676  *      there is a possible fold length change.  That means that a regular
2677  *      EXACTFU node without UTF-8 involvement doesn't have to concern itself
2678  *      with length changes, and so can be processed faster.  regexec.c takes
2679  *      advantage of this.  Generally, an EXACTFish node that is in UTF-8 is
2680  *      pre-folded by regcomp.c.  This saves effort in regex matching.
2681  *      However, the pre-folding isn't done for non-UTF8 patterns because the
2682  *      fold of the MICRO SIGN requires UTF-8, and we don't want to slow things
2683  *      down by forcing the pattern into UTF8 unless necessary.  Also what
2684  *      EXACTF and EXACTFL nodes fold to isn't known until runtime.  The fold
2685  *      possibilities for the non-UTF8 patterns are quite simple, except for
2686  *      the sharp s.  All the ones that don't involve a UTF-8 target string are
2687  *      members of a fold-pair, and arrays are set up for all of them so that
2688  *      the other member of the pair can be found quickly.  Code elsewhere in
2689  *      this file makes sure that in EXACTFU nodes, the sharp s gets folded to
2690  *      'ss', even if the pattern isn't UTF-8.  This avoids the issues
2691  *      described in the next item.
2692  * 4)   A problem remains for the sharp s in EXACTF and EXACTFA nodes when the
2693  *      pattern isn't in UTF-8. (BTW, there cannot be an EXACTF node with a
2694  *      UTF-8 pattern.)  An assumption that the optimizer part of regexec.c
2695  *      (probably unwittingly, in Perl_regexec_flags()) makes is that a
2696  *      character in the pattern corresponds to at most a single character in
2697  *      the target string.  (And I do mean character, and not byte here, unlike
2698  *      other parts of the documentation that have never been updated to
2699  *      account for multibyte Unicode.)  sharp s in EXACTF nodes can match the
2700  *      two character string 'ss'; in EXACTFA nodes it can match
2701  *      "\x{17F}\x{17F}".  These violate the assumption, and they are the only
2702  *      instances where it is violated.  I'm reluctant to try to change the
2703  *      assumption, as the code involved is impenetrable to me (khw), so
2704  *      instead the code here punts.  This routine examines (when the pattern
2705  *      isn't UTF-8) EXACTF and EXACTFA nodes for the sharp s, and returns a
2706  *      boolean indicating whether or not the node contains a sharp s.  When it
2707  *      is true, the caller sets a flag that later causes the optimizer in this
2708  *      file to not set values for the floating and fixed string lengths, and
2709  *      thus avoids the optimizer code in regexec.c that makes the invalid
2710  *      assumption.  Thus, there is no optimization based on string lengths for
2711  *      non-UTF8-pattern EXACTF and EXACTFA nodes that contain the sharp s.
2712  *      (The reason the assumption is wrong only in these two cases is that all
2713  *      other non-UTF-8 folds are 1-1; and, for UTF-8 patterns, we pre-fold all
2714  *      other folds to their expanded versions.  We can't prefold sharp s to
2715  *      'ss' in EXACTF nodes because we don't know at compile time if it
2716  *      actually matches 'ss' or not.  It will match iff the target string is
2717  *      in UTF-8, unlike the EXACTFU nodes, where it always matches; and
2718  *      EXACTFA and EXACTFL where it never does.  In an EXACTFA node in a UTF-8
2719  *      pattern, sharp s is folded to "\x{17F}\x{17F}, avoiding the problem;
2720  *      but in a non-UTF8 pattern, folding it to that above-Latin1 string would
2721  *      require the pattern to be forced into UTF-8, the overhead of which we
2722  *      want to avoid.)
2723  */
2724
2725 #define JOIN_EXACT(scan,min_subtract,has_exactf_sharp_s, flags) \
2726     if (PL_regkind[OP(scan)] == EXACT) \
2727         join_exact(pRExC_state,(scan),(min_subtract),has_exactf_sharp_s, (flags),NULL,depth+1)
2728
2729 STATIC U32
2730 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) {
2731     /* Merge several consecutive EXACTish nodes into one. */
2732     regnode *n = regnext(scan);
2733     U32 stringok = 1;
2734     regnode *next = scan + NODE_SZ_STR(scan);
2735     U32 merged = 0;
2736     U32 stopnow = 0;
2737 #ifdef DEBUGGING
2738     regnode *stop = scan;
2739     GET_RE_DEBUG_FLAGS_DECL;
2740 #else
2741     PERL_UNUSED_ARG(depth);
2742 #endif
2743
2744     PERL_ARGS_ASSERT_JOIN_EXACT;
2745 #ifndef EXPERIMENTAL_INPLACESCAN
2746     PERL_UNUSED_ARG(flags);
2747     PERL_UNUSED_ARG(val);
2748 #endif
2749     DEBUG_PEEP("join",scan,depth);
2750
2751     /* Look through the subsequent nodes in the chain.  Skip NOTHING, merge
2752      * EXACT ones that are mergeable to the current one. */
2753     while (n
2754            && (PL_regkind[OP(n)] == NOTHING
2755                || (stringok && OP(n) == OP(scan)))
2756            && NEXT_OFF(n)
2757            && NEXT_OFF(scan) + NEXT_OFF(n) < I16_MAX)
2758     {
2759         
2760         if (OP(n) == TAIL || n > next)
2761             stringok = 0;
2762         if (PL_regkind[OP(n)] == NOTHING) {
2763             DEBUG_PEEP("skip:",n,depth);
2764             NEXT_OFF(scan) += NEXT_OFF(n);
2765             next = n + NODE_STEP_REGNODE;
2766 #ifdef DEBUGGING
2767             if (stringok)
2768                 stop = n;
2769 #endif
2770             n = regnext(n);
2771         }
2772         else if (stringok) {
2773             const unsigned int oldl = STR_LEN(scan);
2774             regnode * const nnext = regnext(n);
2775
2776             /* XXX I (khw) kind of doubt that this works on platforms where
2777              * U8_MAX is above 255 because of lots of other assumptions */
2778             /* Don't join if the sum can't fit into a single node */
2779             if (oldl + STR_LEN(n) > U8_MAX)
2780                 break;
2781             
2782             DEBUG_PEEP("merg",n,depth);
2783             merged++;
2784
2785             NEXT_OFF(scan) += NEXT_OFF(n);
2786             STR_LEN(scan) += STR_LEN(n);
2787             next = n + NODE_SZ_STR(n);
2788             /* Now we can overwrite *n : */
2789             Move(STRING(n), STRING(scan) + oldl, STR_LEN(n), char);
2790 #ifdef DEBUGGING
2791             stop = next - 1;
2792 #endif
2793             n = nnext;
2794             if (stopnow) break;
2795         }
2796
2797 #ifdef EXPERIMENTAL_INPLACESCAN
2798         if (flags && !NEXT_OFF(n)) {
2799             DEBUG_PEEP("atch", val, depth);
2800             if (reg_off_by_arg[OP(n)]) {
2801                 ARG_SET(n, val - n);
2802             }
2803             else {
2804                 NEXT_OFF(n) = val - n;
2805             }
2806             stopnow = 1;
2807         }
2808 #endif
2809     }
2810
2811     *min_subtract = 0;
2812     *has_exactf_sharp_s = FALSE;
2813
2814     /* Here, all the adjacent mergeable EXACTish nodes have been merged.  We
2815      * can now analyze for sequences of problematic code points.  (Prior to
2816      * this final joining, sequences could have been split over boundaries, and
2817      * hence missed).  The sequences only happen in folding, hence for any
2818      * non-EXACT EXACTish node */
2819     if (OP(scan) != EXACT) {
2820         const U8 * const s0 = (U8*) STRING(scan);
2821         const U8 * s = s0;
2822         const U8 * const s_end = s0 + STR_LEN(scan);
2823
2824         /* One pass is made over the node's string looking for all the
2825          * possibilities.  to avoid some tests in the loop, there are two main
2826          * cases, for UTF-8 patterns (which can't have EXACTF nodes) and
2827          * non-UTF-8 */
2828         if (UTF) {
2829
2830             /* Examine the string for a multi-character fold sequence.  UTF-8
2831              * patterns have all characters pre-folded by the time this code is
2832              * executed */
2833             while (s < s_end - 1) /* Can stop 1 before the end, as minimum
2834                                      length sequence we are looking for is 2 */
2835             {
2836                 int count = 0;
2837                 int len = is_MULTI_CHAR_FOLD_utf8_safe(s, s_end);
2838                 if (! len) {    /* Not a multi-char fold: get next char */
2839                     s += UTF8SKIP(s);
2840                     continue;
2841                 }
2842
2843                 /* Nodes with 'ss' require special handling, except for EXACTFL
2844                  * and EXACTFA for which there is no multi-char fold to this */
2845                 if (len == 2 && *s == 's' && *(s+1) == 's'
2846                     && OP(scan) != EXACTFL && OP(scan) != EXACTFA)
2847                 {
2848                     count = 2;
2849                     OP(scan) = EXACTFU_SS;
2850                     s += 2;
2851                 }
2852                 else if (len == 6   /* len is the same in both ASCII and EBCDIC
2853                                        for these */
2854                          && (memEQ(s, GREEK_SMALL_LETTER_IOTA_UTF8
2855                                       COMBINING_DIAERESIS_UTF8
2856                                       COMBINING_ACUTE_ACCENT_UTF8,
2857                                    6)
2858                              || memEQ(s, GREEK_SMALL_LETTER_UPSILON_UTF8
2859                                          COMBINING_DIAERESIS_UTF8
2860                                          COMBINING_ACUTE_ACCENT_UTF8,
2861                                      6)))
2862                 {
2863                     count = 3;
2864
2865                     /* These two folds require special handling by trie's, so
2866                      * change the node type to indicate this.  If EXACTFA and
2867                      * EXACTFL were ever to be handled by trie's, this would
2868                      * have to be changed.  If this node has already been
2869                      * changed to EXACTFU_SS in this loop, leave it as is.  (I
2870                      * (khw) think it doesn't matter in regexec.c for UTF
2871                      * patterns, but no need to change it */
2872                     if (OP(scan) == EXACTFU) {
2873                         OP(scan) = EXACTFU_TRICKYFOLD;
2874                     }
2875                     s += 6;
2876                 }
2877                 else { /* Here is a generic multi-char fold. */
2878                     const U8* multi_end  = s + len;
2879
2880                     /* Count how many characters in it.  In the case of /l and
2881                      * /aa, no folds which contain ASCII code points are
2882                      * allowed, so check for those, and skip if found.  (In
2883                      * EXACTFL, no folds are allowed to any Latin1 code point,
2884                      * not just ASCII.  But there aren't any of these
2885                      * currently, nor ever likely, so don't take the time to
2886                      * test for them.  The code that generates the
2887                      * is_MULTI_foo() macros croaks should one actually get put
2888                      * into Unicode .) */
2889                     if (OP(scan) != EXACTFL && OP(scan) != EXACTFA) {
2890                         count = utf8_length(s, multi_end);
2891                         s = multi_end;
2892                     }
2893                     else {
2894                         while (s < multi_end) {
2895                             if (isASCII(*s)) {
2896                                 s++;
2897                                 goto next_iteration;
2898                             }
2899                             else {
2900                                 s += UTF8SKIP(s);
2901                             }
2902                             count++;
2903                         }
2904                     }
2905                 }
2906
2907                 /* The delta is how long the sequence is minus 1 (1 is how long
2908                  * the character that folds to the sequence is) */
2909                 *min_subtract += count - 1;
2910             next_iteration: ;
2911             }
2912         }
2913         else if (OP(scan) == EXACTFA) {
2914
2915             /* Non-UTF-8 pattern, EXACTFA node.  There can't be a multi-char
2916              * fold to the ASCII range (and there are no existing ones in the
2917              * upper latin1 range).  But, as outlined in the comments preceding
2918              * this function, we need to flag any occurrences of the sharp s */
2919             while (s < s_end) {
2920                 if (*s == LATIN_SMALL_LETTER_SHARP_S) {
2921                     *has_exactf_sharp_s = TRUE;
2922                     break;
2923                 }
2924                 s++;
2925                 continue;
2926             }
2927         }
2928         else if (OP(scan) != EXACTFL) {
2929
2930             /* Non-UTF-8 pattern, not EXACTFA nor EXACTFL node.  Look for the
2931              * multi-char folds that are all Latin1.  (This code knows that
2932              * there are no current multi-char folds possible with EXACTFL,
2933              * relying on fold_grind.t to catch any errors if the very unlikely
2934              * event happens that some get added in future Unicode versions.)
2935              * As explained in the comments preceding this function, we look
2936              * also for the sharp s in EXACTF nodes; it can be in the final
2937              * position.  Otherwise we can stop looking 1 byte earlier because
2938              * have to find at least two characters for a multi-fold */
2939             const U8* upper = (OP(scan) == EXACTF) ? s_end : s_end -1;
2940
2941             /* The below is perhaps overboard, but this allows us to save a
2942              * test each time through the loop at the expense of a mask.  This
2943              * is because on both EBCDIC and ASCII machines, 'S' and 's' differ
2944              * by a single bit.  On ASCII they are 32 apart; on EBCDIC, they
2945              * are 64.  This uses an exclusive 'or' to find that bit and then
2946              * inverts it to form a mask, with just a single 0, in the bit
2947              * position where 'S' and 's' differ. */
2948             const U8 S_or_s_mask = (U8) ~ ('S' ^ 's');
2949             const U8 s_masked = 's' & S_or_s_mask;
2950
2951             while (s < upper) {
2952                 int len = is_MULTI_CHAR_FOLD_latin1_safe(s, s_end);
2953                 if (! len) {    /* Not a multi-char fold. */
2954                     if (*s == LATIN_SMALL_LETTER_SHARP_S && OP(scan) == EXACTF)
2955                     {
2956                         *has_exactf_sharp_s = TRUE;
2957                     }
2958                     s++;
2959                     continue;
2960                 }
2961
2962                 if (len == 2
2963                     && ((*s & S_or_s_mask) == s_masked)
2964                     && ((*(s+1) & S_or_s_mask) == s_masked))
2965                 {
2966
2967                     /* EXACTF nodes need to know that the minimum length
2968                      * changed so that a sharp s in the string can match this
2969                      * ss in the pattern, but they remain EXACTF nodes, as they
2970                      * won't match this unless the target string is is UTF-8,
2971                      * which we don't know until runtime */
2972                     if (OP(scan) != EXACTF) {
2973                         OP(scan) = EXACTFU_SS;
2974                     }
2975                 }
2976
2977                 *min_subtract += len - 1;
2978                 s += len;
2979             }
2980         }
2981     }
2982
2983 #ifdef DEBUGGING
2984     /* Allow dumping but overwriting the collection of skipped
2985      * ops and/or strings with fake optimized ops */
2986     n = scan + NODE_SZ_STR(scan);
2987     while (n <= stop) {
2988         OP(n) = OPTIMIZED;
2989         FLAGS(n) = 0;
2990         NEXT_OFF(n) = 0;
2991         n++;
2992     }
2993 #endif
2994     DEBUG_OPTIMISE_r(if (merged){DEBUG_PEEP("finl",scan,depth)});
2995     return stopnow;
2996 }
2997
2998 /* REx optimizer.  Converts nodes into quicker variants "in place".
2999    Finds fixed substrings.  */
3000
3001 /* Stops at toplevel WHILEM as well as at "last". At end *scanp is set
3002    to the position after last scanned or to NULL. */
3003
3004 #define INIT_AND_WITHP \
3005     assert(!and_withp); \
3006     Newx(and_withp,1,struct regnode_charclass_class); \
3007     SAVEFREEPV(and_withp)
3008
3009 /* this is a chain of data about sub patterns we are processing that
3010    need to be handled separately/specially in study_chunk. Its so
3011    we can simulate recursion without losing state.  */
3012 struct scan_frame;
3013 typedef struct scan_frame {
3014     regnode *last;  /* last node to process in this frame */
3015     regnode *next;  /* next node to process when last is reached */
3016     struct scan_frame *prev; /*previous frame*/
3017     I32 stop; /* what stopparen do we use */
3018 } scan_frame;
3019
3020
3021 #define SCAN_COMMIT(s, data, m) scan_commit(s, data, m, is_inf)
3022
3023 STATIC I32
3024 S_study_chunk(pTHX_ RExC_state_t *pRExC_state, regnode **scanp,
3025                         I32 *minlenp, I32 *deltap,
3026                         regnode *last,
3027                         scan_data_t *data,
3028                         I32 stopparen,
3029                         U8* recursed,
3030                         struct regnode_charclass_class *and_withp,
3031                         U32 flags, U32 depth)
3032                         /* scanp: Start here (read-write). */
3033                         /* deltap: Write maxlen-minlen here. */
3034                         /* last: Stop before this one. */
3035                         /* data: string data about the pattern */
3036                         /* stopparen: treat close N as END */
3037                         /* recursed: which subroutines have we recursed into */
3038                         /* and_withp: Valid if flags & SCF_DO_STCLASS_OR */
3039 {
3040     dVAR;
3041     I32 min = 0;    /* There must be at least this number of characters to match */
3042     I32 pars = 0, code;
3043     regnode *scan = *scanp, *next;
3044     I32 delta = 0;
3045     int is_inf = (flags & SCF_DO_SUBSTR) && (data->flags & SF_IS_INF);
3046     int is_inf_internal = 0;            /* The studied chunk is infinite */
3047     I32 is_par = OP(scan) == OPEN ? ARG(scan) : 0;
3048     scan_data_t data_fake;
3049     SV *re_trie_maxbuff = NULL;
3050     regnode *first_non_open = scan;
3051     I32 stopmin = I32_MAX;
3052     scan_frame *frame = NULL;
3053     GET_RE_DEBUG_FLAGS_DECL;
3054
3055     PERL_ARGS_ASSERT_STUDY_CHUNK;
3056
3057 #ifdef DEBUGGING
3058     StructCopy(&zero_scan_data, &data_fake, scan_data_t);
3059 #endif
3060
3061     if ( depth == 0 ) {
3062         while (first_non_open && OP(first_non_open) == OPEN)
3063             first_non_open=regnext(first_non_open);
3064     }
3065
3066
3067   fake_study_recurse:
3068     while ( scan && OP(scan) != END && scan < last ){
3069         UV min_subtract = 0;    /* How mmany chars to subtract from the minimum
3070                                    node length to get a real minimum (because
3071                                    the folded version may be shorter) */
3072         bool has_exactf_sharp_s = FALSE;
3073         /* Peephole optimizer: */
3074         DEBUG_STUDYDATA("Peep:", data,depth);
3075         DEBUG_PEEP("Peep",scan,depth);
3076
3077         /* Its not clear to khw or hv why this is done here, and not in the
3078          * clauses that deal with EXACT nodes.  khw's guess is that it's
3079          * because of a previous design */
3080         JOIN_EXACT(scan,&min_subtract, &has_exactf_sharp_s, 0);
3081
3082         /* Follow the next-chain of the current node and optimize
3083            away all the NOTHINGs from it.  */
3084         if (OP(scan) != CURLYX) {
3085             const int max = (reg_off_by_arg[OP(scan)]
3086                        ? I32_MAX
3087                        /* I32 may be smaller than U16 on CRAYs! */
3088                        : (I32_MAX < U16_MAX ? I32_MAX : U16_MAX));
3089             int off = (reg_off_by_arg[OP(scan)] ? ARG(scan) : NEXT_OFF(scan));
3090             int noff;
3091             regnode *n = scan;
3092
3093             /* Skip NOTHING and LONGJMP. */
3094             while ((n = regnext(n))
3095                    && ((PL_regkind[OP(n)] == NOTHING && (noff = NEXT_OFF(n)))
3096                        || ((OP(n) == LONGJMP) && (noff = ARG(n))))
3097                    && off + noff < max)
3098                 off += noff;
3099             if (reg_off_by_arg[OP(scan)])
3100                 ARG(scan) = off;
3101             else
3102                 NEXT_OFF(scan) = off;
3103         }
3104
3105
3106
3107         /* The principal pseudo-switch.  Cannot be a switch, since we
3108            look into several different things.  */
3109         if (OP(scan) == BRANCH || OP(scan) == BRANCHJ
3110                    || OP(scan) == IFTHEN) {
3111             next = regnext(scan);
3112             code = OP(scan);
3113             /* demq: the op(next)==code check is to see if we have "branch-branch" AFAICT */
3114
3115             if (OP(next) == code || code == IFTHEN) {
3116                 /* NOTE - There is similar code to this block below for handling
3117                    TRIE nodes on a re-study.  If you change stuff here check there
3118                    too. */
3119                 I32 max1 = 0, min1 = I32_MAX, num = 0;
3120                 struct regnode_charclass_class accum;
3121                 regnode * const startbranch=scan;
3122
3123                 if (flags & SCF_DO_SUBSTR)
3124                     SCAN_COMMIT(pRExC_state, data, minlenp); /* Cannot merge strings after this. */
3125                 if (flags & SCF_DO_STCLASS)
3126                     cl_init_zero(pRExC_state, &accum);
3127
3128                 while (OP(scan) == code) {
3129                     I32 deltanext, minnext, f = 0, fake;
3130                     struct regnode_charclass_class this_class;
3131
3132                     num++;
3133                     data_fake.flags = 0;
3134                     if (data) {
3135                         data_fake.whilem_c = data->whilem_c;
3136                         data_fake.last_closep = data->last_closep;
3137                     }
3138                     else
3139                         data_fake.last_closep = &fake;
3140
3141                     data_fake.pos_delta = delta;
3142                     next = regnext(scan);
3143                     scan = NEXTOPER(scan);
3144                     if (code != BRANCH)
3145                         scan = NEXTOPER(scan);
3146                     if (flags & SCF_DO_STCLASS) {
3147                         cl_init(pRExC_state, &this_class);
3148                         data_fake.start_class = &this_class;
3149                         f = SCF_DO_STCLASS_AND;
3150                     }
3151                     if (flags & SCF_WHILEM_VISITED_POS)
3152                         f |= SCF_WHILEM_VISITED_POS;
3153
3154                     /* we suppose the run is continuous, last=next...*/
3155                     minnext = study_chunk(pRExC_state, &scan, minlenp, &deltanext,
3156                                           next, &data_fake,
3157                                           stopparen, recursed, NULL, f,depth+1);
3158                     if (min1 > minnext)
3159                         min1 = minnext;
3160                     if (deltanext == I32_MAX) {
3161                         is_inf = is_inf_internal = 1;
3162                         max1 = I32_MAX;
3163                     } else if (max1 < minnext + deltanext)
3164                         max1 = minnext + deltanext;
3165                     scan = next;
3166                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
3167                         pars++;
3168                     if (data_fake.flags & SCF_SEEN_ACCEPT) {
3169                         if ( stopmin > minnext) 
3170                             stopmin = min + min1;
3171                         flags &= ~SCF_DO_SUBSTR;
3172                         if (data)
3173                             data->flags |= SCF_SEEN_ACCEPT;
3174                     }
3175                     if (data) {
3176                         if (data_fake.flags & SF_HAS_EVAL)
3177                             data->flags |= SF_HAS_EVAL;
3178                         data->whilem_c = data_fake.whilem_c;
3179                     }
3180                     if (flags & SCF_DO_STCLASS)
3181                         cl_or(pRExC_state, &accum, &this_class);
3182                 }
3183                 if (code == IFTHEN && num < 2) /* Empty ELSE branch */
3184                     min1 = 0;
3185                 if (flags & SCF_DO_SUBSTR) {
3186                     data->pos_min += min1;
3187                     if (data->pos_delta >= I32_MAX - (max1 - min1))
3188                         data->pos_delta = I32_MAX;
3189                     else
3190                         data->pos_delta += max1 - min1;
3191                     if (max1 != min1 || is_inf)
3192                         data->longest = &(data->longest_float);
3193                 }
3194                 min += min1;
3195                 if (delta == I32_MAX || I32_MAX - delta - (max1 - min1) < 0)
3196                     delta = I32_MAX;
3197                 else
3198                     delta += max1 - min1;
3199                 if (flags & SCF_DO_STCLASS_OR) {
3200                     cl_or(pRExC_state, data->start_class, &accum);
3201                     if (min1) {
3202                         cl_and(data->start_class, and_withp);
3203                         flags &= ~SCF_DO_STCLASS;
3204                     }
3205                 }
3206                 else if (flags & SCF_DO_STCLASS_AND) {
3207                     if (min1) {
3208                         cl_and(data->start_class, &accum);
3209                         flags &= ~SCF_DO_STCLASS;
3210                     }
3211                     else {
3212                         /* Switch to OR mode: cache the old value of
3213                          * data->start_class */
3214                         INIT_AND_WITHP;
3215                         StructCopy(data->start_class, and_withp,
3216                                    struct regnode_charclass_class);
3217                         flags &= ~SCF_DO_STCLASS_AND;
3218                         StructCopy(&accum, data->start_class,
3219                                    struct regnode_charclass_class);
3220                         flags |= SCF_DO_STCLASS_OR;
3221                         SET_SSC_EOS(data->start_class);
3222                     }
3223                 }
3224
3225                 if (PERL_ENABLE_TRIE_OPTIMISATION && OP( startbranch ) == BRANCH ) {
3226                 /* demq.
3227
3228                    Assuming this was/is a branch we are dealing with: 'scan' now
3229                    points at the item that follows the branch sequence, whatever
3230                    it is. We now start at the beginning of the sequence and look
3231                    for subsequences of
3232
3233                    BRANCH->EXACT=>x1
3234                    BRANCH->EXACT=>x2
3235                    tail
3236
3237                    which would be constructed from a pattern like /A|LIST|OF|WORDS/
3238
3239                    If we can find such a subsequence we need to turn the first
3240                    element into a trie and then add the subsequent branch exact
3241                    strings to the trie.
3242
3243                    We have two cases
3244
3245                      1. patterns where the whole set of branches can be converted. 
3246
3247                      2. patterns where only a subset can be converted.
3248
3249                    In case 1 we can replace the whole set with a single regop
3250                    for the trie. In case 2 we need to keep the start and end
3251                    branches so
3252
3253                      'BRANCH EXACT; BRANCH EXACT; BRANCH X'
3254                      becomes BRANCH TRIE; BRANCH X;
3255
3256                   There is an additional case, that being where there is a 
3257                   common prefix, which gets split out into an EXACT like node
3258                   preceding the TRIE node.
3259
3260                   If x(1..n)==tail then we can do a simple trie, if not we make
3261                   a "jump" trie, such that when we match the appropriate word
3262                   we "jump" to the appropriate tail node. Essentially we turn
3263                   a nested if into a case structure of sorts.
3264
3265                 */
3266
3267                     int made=0;
3268                     if (!re_trie_maxbuff) {
3269                         re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
3270                         if (!SvIOK(re_trie_maxbuff))
3271                             sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
3272                     }
3273                     if ( SvIV(re_trie_maxbuff)>=0  ) {
3274                         regnode *cur;
3275                         regnode *first = (regnode *)NULL;
3276                         regnode *last = (regnode *)NULL;
3277                         regnode *tail = scan;
3278                         U8 trietype = 0;
3279                         U32 count=0;
3280
3281 #ifdef DEBUGGING
3282                         SV * const mysv = sv_newmortal();       /* for dumping */
3283 #endif
3284                         /* var tail is used because there may be a TAIL
3285                            regop in the way. Ie, the exacts will point to the
3286                            thing following the TAIL, but the last branch will
3287                            point at the TAIL. So we advance tail. If we
3288                            have nested (?:) we may have to move through several
3289                            tails.
3290                          */
3291
3292                         while ( OP( tail ) == TAIL ) {
3293                             /* this is the TAIL generated by (?:) */
3294                             tail = regnext( tail );
3295                         }
3296
3297                         
3298                         DEBUG_TRIE_COMPILE_r({
3299                             regprop(RExC_rx, mysv, tail );
3300                             PerlIO_printf( Perl_debug_log, "%*s%s%s\n",
3301                                 (int)depth * 2 + 2, "", 
3302                                 "Looking for TRIE'able sequences. Tail node is: ", 
3303                                 SvPV_nolen_const( mysv )
3304                             );
3305                         });
3306                         
3307                         /*
3308
3309                             Step through the branches
3310                                 cur represents each branch,
3311                                 noper is the first thing to be matched as part of that branch
3312                                 noper_next is the regnext() of that node.
3313
3314                             We normally handle a case like this /FOO[xyz]|BAR[pqr]/
3315                             via a "jump trie" but we also support building with NOJUMPTRIE,
3316                             which restricts the trie logic to structures like /FOO|BAR/.
3317
3318                             If noper is a trieable nodetype then the branch is a possible optimization
3319                             target. If we are building under NOJUMPTRIE then we require that noper_next
3320                             is the same as scan (our current position in the regex program).
3321
3322                             Once we have two or more consecutive such branches we can create a
3323                             trie of the EXACT's contents and stitch it in place into the program.
3324
3325                             If the sequence represents all of the branches in the alternation we
3326                             replace the entire thing with a single TRIE node.
3327
3328                             Otherwise when it is a subsequence we need to stitch it in place and
3329                             replace only the relevant branches. This means the first branch has
3330                             to remain as it is used by the alternation logic, and its next pointer,
3331                             and needs to be repointed at the item on the branch chain following
3332                             the last branch we have optimized away.
3333
3334                             This could be either a BRANCH, in which case the subsequence is internal,
3335                             or it could be the item following the branch sequence in which case the
3336                             subsequence is at the end (which does not necessarily mean the first node
3337                             is the start of the alternation).
3338
3339                             TRIE_TYPE(X) is a define which maps the optype to a trietype.
3340
3341                                 optype          |  trietype
3342                                 ----------------+-----------
3343                                 NOTHING         | NOTHING
3344                                 EXACT           | EXACT
3345                                 EXACTFU         | EXACTFU
3346                                 EXACTFU_SS      | EXACTFU
3347                                 EXACTFU_TRICKYFOLD | EXACTFU
3348                                 EXACTFA         | 0
3349
3350
3351                         */
3352 #define TRIE_TYPE(X) ( ( NOTHING == (X) ) ? NOTHING :   \
3353                        ( EXACT == (X) )   ? EXACT :        \
3354                        ( EXACTFU == (X) || EXACTFU_SS == (X) || EXACTFU_TRICKYFOLD == (X) ) ? EXACTFU :        \
3355                        0 )
3356
3357                         /* dont use tail as the end marker for this traverse */
3358                         for ( cur = startbranch ; cur != scan ; cur = regnext( cur ) ) {
3359                             regnode * const noper = NEXTOPER( cur );
3360                             U8 noper_type = OP( noper );
3361                             U8 noper_trietype = TRIE_TYPE( noper_type );
3362 #if defined(DEBUGGING) || defined(NOJUMPTRIE)
3363                             regnode * const noper_next = regnext( noper );
3364                             U8 noper_next_type = (noper_next && noper_next != tail) ? OP(noper_next) : 0;
3365                             U8 noper_next_trietype = (noper_next && noper_next != tail) ? TRIE_TYPE( noper_next_type ) :0;
3366 #endif
3367
3368                             DEBUG_TRIE_COMPILE_r({
3369                                 regprop(RExC_rx, mysv, cur);
3370                                 PerlIO_printf( Perl_debug_log, "%*s- %s (%d)",
3371                                    (int)depth * 2 + 2,"", SvPV_nolen_const( mysv ), REG_NODE_NUM(cur) );
3372
3373                                 regprop(RExC_rx, mysv, noper);
3374                                 PerlIO_printf( Perl_debug_log, " -> %s",
3375                                     SvPV_nolen_const(mysv));
3376
3377                                 if ( noper_next ) {
3378                                   regprop(RExC_rx, mysv, noper_next );
3379                                   PerlIO_printf( Perl_debug_log,"\t=> %s\t",
3380                                     SvPV_nolen_const(mysv));
3381                                 }
3382                                 PerlIO_printf( Perl_debug_log, "(First==%d,Last==%d,Cur==%d,tt==%s,nt==%s,nnt==%s)\n",
3383                                    REG_NODE_NUM(first), REG_NODE_NUM(last), REG_NODE_NUM(cur),
3384                                    PL_reg_name[trietype], PL_reg_name[noper_trietype], PL_reg_name[noper_next_trietype] 
3385                                 );
3386                             });
3387
3388                             /* Is noper a trieable nodetype that can be merged with the
3389                              * current trie (if there is one)? */
3390                             if ( noper_trietype
3391                                   &&
3392                                   (
3393                                         ( noper_trietype == NOTHING)
3394                                         || ( trietype == NOTHING )
3395                                         || ( trietype == noper_trietype )
3396                                   )
3397 #ifdef NOJUMPTRIE
3398                                   && noper_next == tail
3399 #endif
3400                                   && count < U16_MAX)
3401                             {
3402                                 /* Handle mergable triable node
3403                                  * Either we are the first node in a new trieable sequence,
3404                                  * in which case we do some bookkeeping, otherwise we update
3405                                  * the end pointer. */
3406                                 if ( !first ) {
3407                                     first = cur;
3408                                     if ( noper_trietype == NOTHING ) {
3409 #if !defined(DEBUGGING) && !defined(NOJUMPTRIE)
3410                                         regnode * const noper_next = regnext( noper );
3411                                         U8 noper_next_type = (noper_next && noper_next!=tail) ? OP(noper_next) : 0;
3412                                         U8 noper_next_trietype = noper_next_type ? TRIE_TYPE( noper_next_type ) :0;
3413 #endif
3414
3415                                         if ( noper_next_trietype ) {
3416                                             trietype = noper_next_trietype;
3417                                         } else if (noper_next_type)  {
3418                                             /* a NOTHING regop is 1 regop wide. We need at least two
3419                                              * for a trie so we can't merge this in */
3420                                             first = NULL;
3421                                         }
3422                                     } else {
3423                                         trietype = noper_trietype;
3424                                     }
3425                                 } else {
3426                                     if ( trietype == NOTHING )
3427                                         trietype = noper_trietype;
3428                                     last = cur;
3429                                 }
3430                                 if (first)
3431                                     count++;
3432                             } /* end handle mergable triable node */
3433                             else {
3434                                 /* handle unmergable node -
3435                                  * noper may either be a triable node which can not be tried
3436                                  * together with the current trie, or a non triable node */
3437                                 if ( last ) {
3438                                     /* If last is set and trietype is not NOTHING then we have found
3439                                      * at least two triable branch sequences in a row of a similar
3440                                      * trietype so we can turn them into a trie. If/when we
3441                                      * allow NOTHING to start a trie sequence this condition will be
3442                                      * required, and it isn't expensive so we leave it in for now. */
3443                                     if ( trietype && trietype != NOTHING )
3444                                         make_trie( pRExC_state,
3445                                                 startbranch, first, cur, tail, count,
3446                                                 trietype, depth+1 );
3447                                     last = NULL; /* note: we clear/update first, trietype etc below, so we dont do it here */
3448                                 }
3449                                 if ( noper_trietype
3450 #ifdef NOJUMPTRIE
3451                                      && noper_next == tail
3452 #endif
3453                                 ){
3454                                     /* noper is triable, so we can start a new trie sequence */
3455                                     count = 1;
3456                                     first = cur;
3457                                     trietype = noper_trietype;
3458                                 } else if (first) {
3459                                     /* if we already saw a first but the current node is not triable then we have
3460                                      * to reset the first information. */
3461                                     count = 0;
3462                                     first = NULL;
3463                                     trietype = 0;
3464                                 }
3465                             } /* end handle unmergable node */
3466                         } /* loop over branches */
3467                         DEBUG_TRIE_COMPILE_r({
3468                             regprop(RExC_rx, mysv, cur);
3469                             PerlIO_printf( Perl_debug_log,
3470                               "%*s- %s (%d) <SCAN FINISHED>\n", (int)depth * 2 + 2,
3471                               "", SvPV_nolen_const( mysv ),REG_NODE_NUM(cur));
3472
3473                         });
3474                         if ( last && trietype ) {
3475                             if ( trietype != NOTHING ) {
3476                                 /* the last branch of the sequence was part of a trie,
3477                                  * so we have to construct it here outside of the loop
3478                                  */
3479                                 made= make_trie( pRExC_state, startbranch, first, scan, tail, count, trietype, depth+1 );
3480 #ifdef TRIE_STUDY_OPT
3481                                 if ( ((made == MADE_EXACT_TRIE &&
3482                                      startbranch == first)
3483                                      || ( first_non_open == first )) &&
3484                                      depth==0 ) {
3485                                     flags |= SCF_TRIE_RESTUDY;
3486                                     if ( startbranch == first
3487                                          && scan == tail )
3488                                     {
3489                                         RExC_seen &=~REG_TOP_LEVEL_BRANCHES;
3490                                     }
3491                                 }
3492 #endif
3493                             } else {
3494                                 /* at this point we know whatever we have is a NOTHING sequence/branch
3495                                  * AND if 'startbranch' is 'first' then we can turn the whole thing into a NOTHING
3496                                  */
3497                                 if ( startbranch == first ) {
3498                                     regnode *opt;
3499                                     /* the entire thing is a NOTHING sequence, something like this:
3500                                      * (?:|) So we can turn it into a plain NOTHING op. */
3501                                     DEBUG_TRIE_COMPILE_r({
3502                                         regprop(RExC_rx, mysv, cur);
3503                                         PerlIO_printf( Perl_debug_log,
3504                                           "%*s- %s (%d) <NOTHING BRANCH SEQUENCE>\n", (int)depth * 2 + 2,
3505                                           "", SvPV_nolen_const( mysv ),REG_NODE_NUM(cur));
3506
3507                                     });
3508                                     OP(startbranch)= NOTHING;
3509                                     NEXT_OFF(startbranch)= tail - startbranch;
3510                                     for ( opt= startbranch + 1; opt < tail ; opt++ )
3511                                         OP(opt)= OPTIMIZED;
3512                                 }
3513                             }
3514                         } /* end if ( last) */
3515                     } /* TRIE_MAXBUF is non zero */
3516                     
3517                 } /* do trie */
3518                 
3519             }
3520             else if ( code == BRANCHJ ) {  /* single branch is optimized. */
3521                 scan = NEXTOPER(NEXTOPER(scan));
3522             } else                      /* single branch is optimized. */
3523                 scan = NEXTOPER(scan);
3524             continue;
3525         } else if (OP(scan) == SUSPEND || OP(scan) == GOSUB || OP(scan) == GOSTART) {
3526             scan_frame *newframe = NULL;
3527             I32 paren;
3528             regnode *start;
3529             regnode *end;
3530
3531             if (OP(scan) != SUSPEND) {
3532             /* set the pointer */
3533                 if (OP(scan) == GOSUB) {
3534                     paren = ARG(scan);
3535                     RExC_recurse[ARG2L(scan)] = scan;
3536                     start = RExC_open_parens[paren-1];
3537                     end   = RExC_close_parens[paren-1];
3538                 } else {
3539                     paren = 0;
3540                     start = RExC_rxi->program + 1;
3541                     end   = RExC_opend;
3542                 }
3543                 if (!recursed) {
3544                     Newxz(recursed, (((RExC_npar)>>3) +1), U8);
3545                     SAVEFREEPV(recursed);
3546                 }
3547                 if (!PAREN_TEST(recursed,paren+1)) {
3548                     PAREN_SET(recursed,paren+1);
3549                     Newx(newframe,1,scan_frame);
3550                 } else {
3551                     if (flags & SCF_DO_SUBSTR) {
3552                         SCAN_COMMIT(pRExC_state,data,minlenp);
3553                         data->longest = &(data->longest_float);
3554                     }
3555                     is_inf = is_inf_internal = 1;
3556                     if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
3557                         cl_anything(pRExC_state, data->start_class);
3558                     flags &= ~SCF_DO_STCLASS;
3559                 }
3560             } else {
3561                 Newx(newframe,1,scan_frame);
3562                 paren = stopparen;
3563                 start = scan+2;
3564                 end = regnext(scan);
3565             }
3566             if (newframe) {
3567                 assert(start);
3568                 assert(end);
3569                 SAVEFREEPV(newframe);
3570                 newframe->next = regnext(scan);
3571                 newframe->last = last;
3572                 newframe->stop = stopparen;
3573                 newframe->prev = frame;
3574
3575                 frame = newframe;
3576                 scan =  start;
3577                 stopparen = paren;
3578                 last = end;
3579
3580                 continue;
3581             }
3582         }
3583         else if (OP(scan) == EXACT) {
3584             I32 l = STR_LEN(scan);
3585             UV uc;
3586             if (UTF) {
3587                 const U8 * const s = (U8*)STRING(scan);
3588                 uc = utf8_to_uvchr_buf(s, s + l, NULL);
3589                 l = utf8_length(s, s + l);
3590             } else {
3591                 uc = *((U8*)STRING(scan));
3592             }
3593             min += l;
3594             if (flags & SCF_DO_SUBSTR) { /* Update longest substr. */
3595                 /* The code below prefers earlier match for fixed
3596                    offset, later match for variable offset.  */
3597                 if (data->last_end == -1) { /* Update the start info. */
3598                     data->last_start_min = data->pos_min;
3599                     data->last_start_max = is_inf
3600                         ? I32_MAX : data->pos_min + data->pos_delta;
3601                 }
3602                 sv_catpvn(data->last_found, STRING(scan), STR_LEN(scan));
3603                 if (UTF)
3604                     SvUTF8_on(data->last_found);
3605                 {
3606                     SV * const sv = data->last_found;
3607                     MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
3608                         mg_find(sv, PERL_MAGIC_utf8) : NULL;
3609                     if (mg && mg->mg_len >= 0)
3610                         mg->mg_len += utf8_length((U8*)STRING(scan),
3611                                                   (U8*)STRING(scan)+STR_LEN(scan));
3612                 }
3613                 data->last_end = data->pos_min + l;
3614                 data->pos_min += l; /* As in the first entry. */
3615                 data->flags &= ~SF_BEFORE_EOL;
3616             }
3617             if (flags & SCF_DO_STCLASS_AND) {
3618                 /* Check whether it is compatible with what we know already! */
3619                 int compat = 1;
3620
3621
3622                 /* If compatible, we or it in below.  It is compatible if is
3623                  * in the bitmp and either 1) its bit or its fold is set, or 2)
3624                  * it's for a locale.  Even if there isn't unicode semantics
3625                  * here, at runtime there may be because of matching against a
3626                  * utf8 string, so accept a possible false positive for
3627                  * latin1-range folds */
3628                 if (uc >= 0x100 ||
3629                     (!(data->start_class->flags & ANYOF_LOCALE)
3630                     && !ANYOF_BITMAP_TEST(data->start_class, uc)
3631                     && (!(data->start_class->flags & ANYOF_LOC_FOLD)
3632                         || !ANYOF_BITMAP_TEST(data->start_class, PL_fold_latin1[uc])))
3633                     )
3634                 {
3635                     compat = 0;
3636                 }
3637                 ANYOF_CLASS_ZERO(data->start_class);
3638                 ANYOF_BITMAP_ZERO(data->start_class);
3639                 if (compat)
3640                     ANYOF_BITMAP_SET(data->start_class, uc);
3641                 else if (uc >= 0x100) {
3642                     int i;
3643
3644                     /* Some Unicode code points fold to the Latin1 range; as
3645                      * XXX temporary code, instead of figuring out if this is
3646                      * one, just assume it is and set all the start class bits
3647                      * that could be some such above 255 code point's fold
3648                      * which will generate fals positives.  As the code
3649                      * elsewhere that does compute the fold settles down, it
3650                      * can be extracted out and re-used here */
3651                     for (i = 0; i < 256; i++){
3652                         if (HAS_NONLATIN1_FOLD_CLOSURE(i)) {
3653                             ANYOF_BITMAP_SET(data->start_class, i);
3654                         }
3655                     }
3656                 }
3657                 CLEAR_SSC_EOS(data->start_class);
3658                 if (uc < 0x100)
3659                   data->start_class->flags &= ~ANYOF_UNICODE_ALL;
3660             }
3661             else if (flags & SCF_DO_STCLASS_OR) {
3662                 /* false positive possible if the class is case-folded */
3663                 if (uc < 0x100)
3664                     ANYOF_BITMAP_SET(data->start_class, uc);
3665                 else
3666                     data->start_class->flags |= ANYOF_UNICODE_ALL;
3667                 CLEAR_SSC_EOS(data->start_class);
3668                 cl_and(data->start_class, and_withp);
3669             }
3670             flags &= ~SCF_DO_STCLASS;
3671         }
3672         else if (PL_regkind[OP(scan)] == EXACT) { /* But OP != EXACT! */
3673             I32 l = STR_LEN(scan);
3674             UV uc = *((U8*)STRING(scan));
3675
3676             /* Search for fixed substrings supports EXACT only. */
3677             if (flags & SCF_DO_SUBSTR) {
3678                 assert(data);
3679                 SCAN_COMMIT(pRExC_state, data, minlenp);
3680             }
3681             if (UTF) {
3682                 const U8 * const s = (U8 *)STRING(scan);
3683                 uc = utf8_to_uvchr_buf(s, s + l, NULL);
3684                 l = utf8_length(s, s + l);
3685             }
3686             if (has_exactf_sharp_s) {
3687                 RExC_seen |= REG_SEEN_EXACTF_SHARP_S;
3688             }
3689             min += l - min_subtract;
3690             assert (min >= 0);
3691             delta += min_subtract;
3692             if (flags & SCF_DO_SUBSTR) {
3693                 data->pos_min += l - min_subtract;
3694                 if (data->pos_min < 0) {
3695                     data->pos_min = 0;
3696                 }
3697                 data->pos_delta += min_subtract;
3698                 if (min_subtract) {
3699                     data->longest = &(data->longest_float);
3700                 }
3701             }
3702             if (flags & SCF_DO_STCLASS_AND) {
3703                 /* Check whether it is compatible with what we know already! */
3704                 int compat = 1;
3705                 if (uc >= 0x100 ||
3706                  (!(data->start_class->flags & ANYOF_LOCALE)
3707                   && !ANYOF_BITMAP_TEST(data->start_class, uc)
3708                   && !ANYOF_BITMAP_TEST(data->start_class, PL_fold_latin1[uc])))
3709                 {
3710                     compat = 0;
3711                 }
3712                 ANYOF_CLASS_ZERO(data->start_class);
3713                 ANYOF_BITMAP_ZERO(data->start_class);
3714                 if (compat) {
3715                     ANYOF_BITMAP_SET(data->start_class, uc);
3716                     CLEAR_SSC_EOS(data->start_class);
3717                     if (OP(scan) == EXACTFL) {
3718                         /* XXX This set is probably no longer necessary, and
3719                          * probably wrong as LOCALE now is on in the initial
3720                          * state */
3721                         data->start_class->flags |= ANYOF_LOCALE|ANYOF_LOC_FOLD;
3722                     }
3723                     else {
3724
3725                         /* Also set the other member of the fold pair.  In case
3726                          * that unicode semantics is called for at runtime, use
3727                          * the full latin1 fold.  (Can't do this for locale,
3728                          * because not known until runtime) */
3729                         ANYOF_BITMAP_SET(data->start_class, PL_fold_latin1[uc]);
3730
3731                         /* All other (EXACTFL handled above) folds except under
3732                          * /iaa that include s, S, and sharp_s also may include
3733                          * the others */
3734                         if (OP(scan) != EXACTFA) {
3735                             if (uc == 's' || uc == 'S') {
3736                                 ANYOF_BITMAP_SET(data->start_class,
3737                                                  LATIN_SMALL_LETTER_SHARP_S);
3738                             }
3739                             else if (uc == LATIN_SMALL_LETTER_SHARP_S) {
3740                                 ANYOF_BITMAP_SET(data->start_class, 's');
3741                                 ANYOF_BITMAP_SET(data->start_class, 'S');
3742                             }
3743                         }
3744                     }
3745                 }
3746                 else if (uc >= 0x100) {
3747                     int i;
3748                     for (i = 0; i < 256; i++){
3749                         if (_HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(i)) {
3750                             ANYOF_BITMAP_SET(data->start_class, i);
3751                         }
3752                     }
3753                 }
3754             }
3755             else if (flags & SCF_DO_STCLASS_OR) {
3756                 if (data->start_class->flags & ANYOF_LOC_FOLD) {
3757                     /* false positive possible if the class is case-folded.
3758                        Assume that the locale settings are the same... */
3759                     if (uc < 0x100) {
3760                         ANYOF_BITMAP_SET(data->start_class, uc);
3761                         if (OP(scan) != EXACTFL) {
3762
3763                             /* And set the other member of the fold pair, but
3764                              * can't do that in locale because not known until
3765                              * run-time */
3766                             ANYOF_BITMAP_SET(data->start_class,
3767                                              PL_fold_latin1[uc]);
3768
3769                             /* All folds except under /iaa that include s, S,
3770                              * and sharp_s also may include the others */
3771                             if (OP(scan) != EXACTFA) {
3772                                 if (uc == 's' || uc == 'S') {
3773                                     ANYOF_BITMAP_SET(data->start_class,
3774                                                    LATIN_SMALL_LETTER_SHARP_S);
3775                                 }
3776                                 else if (uc == LATIN_SMALL_LETTER_SHARP_S) {
3777                                     ANYOF_BITMAP_SET(data->start_class, 's');
3778                                     ANYOF_BITMAP_SET(data->start_class, 'S');
3779                                 }
3780                             }
3781                         }
3782                     }
3783                     CLEAR_SSC_EOS(data->start_class);
3784                 }
3785                 cl_and(data->start_class, and_withp);
3786             }
3787             flags &= ~SCF_DO_STCLASS;
3788         }
3789         else if (REGNODE_VARIES(OP(scan))) {
3790             I32 mincount, maxcount, minnext, deltanext, fl = 0;
3791             I32 f = flags, pos_before = 0;
3792             regnode * const oscan = scan;
3793             struct regnode_charclass_class this_class;
3794             struct regnode_charclass_class *oclass = NULL;
3795             I32 next_is_eval = 0;
3796
3797             switch (PL_regkind[OP(scan)]) {
3798             case WHILEM:                /* End of (?:...)* . */
3799                 scan = NEXTOPER(scan);
3800                 goto finish;
3801             case PLUS:
3802                 if (flags & (SCF_DO_SUBSTR | SCF_DO_STCLASS)) {
3803                     next = NEXTOPER(scan);
3804                     if (OP(next) == EXACT || (flags & SCF_DO_STCLASS)) {
3805                         mincount = 1;
3806                         maxcount = REG_INFTY;
3807                         next = regnext(scan);
3808                         scan = NEXTOPER(scan);
3809                         goto do_curly;
3810                     }
3811                 }
3812                 if (flags & SCF_DO_SUBSTR)
3813                     data->pos_min++;
3814                 min++;
3815                 /* Fall through. */
3816             case STAR:
3817                 if (flags & SCF_DO_STCLASS) {
3818                     mincount = 0;
3819                     maxcount = REG_INFTY;
3820                     next = regnext(scan);
3821                     scan = NEXTOPER(scan);
3822                     goto do_curly;
3823                 }
3824                 is_inf = is_inf_internal = 1;
3825                 scan = regnext(scan);
3826                 if (flags & SCF_DO_SUBSTR) {
3827                     SCAN_COMMIT(pRExC_state, data, minlenp); /* Cannot extend fixed substrings */
3828                     data->longest = &(data->longest_float);
3829                 }
3830                 goto optimize_curly_tail;
3831             case CURLY:
3832                 if (stopparen>0 && (OP(scan)==CURLYN || OP(scan)==CURLYM)
3833                     && (scan->flags == stopparen))
3834                 {
3835                     mincount = 1;
3836                     maxcount = 1;
3837                 } else {
3838                     mincount = ARG1(scan);
3839                     maxcount = ARG2(scan);
3840                 }
3841                 next = regnext(scan);
3842                 if (OP(scan) == CURLYX) {
3843                     I32 lp = (data ? *(data->last_closep) : 0);
3844                     scan->flags = ((lp <= (I32)U8_MAX) ? (U8)lp : U8_MAX);
3845                 }
3846                 scan = NEXTOPER(scan) + EXTRA_STEP_2ARGS;
3847                 next_is_eval = (OP(scan) == EVAL);
3848               do_curly:
3849                 if (flags & SCF_DO_SUBSTR) {
3850                     if (mincount == 0) SCAN_COMMIT(pRExC_state,data,minlenp); /* Cannot extend fixed substrings */
3851                     pos_before = data->pos_min;
3852                 }
3853                 if (data) {
3854                     fl = data->flags;
3855                     data->flags &= ~(SF_HAS_PAR|SF_IN_PAR|SF_HAS_EVAL);
3856                     if (is_inf)
3857                         data->flags |= SF_IS_INF;
3858                 }
3859                 if (flags & SCF_DO_STCLASS) {
3860                     cl_init(pRExC_state, &this_class);
3861                     oclass = data->start_class;
3862                     data->start_class = &this_class;
3863                     f |= SCF_DO_STCLASS_AND;
3864                     f &= ~SCF_DO_STCLASS_OR;
3865                 }
3866                 /* Exclude from super-linear cache processing any {n,m}
3867                    regops for which the combination of input pos and regex
3868                    pos is not enough information to determine if a match
3869                    will be possible.
3870
3871                    For example, in the regex /foo(bar\s*){4,8}baz/ with the
3872                    regex pos at the \s*, the prospects for a match depend not
3873                    only on the input position but also on how many (bar\s*)
3874                    repeats into the {4,8} we are. */
3875                if ((mincount > 1) || (maxcount > 1 && maxcount != REG_INFTY))
3876                     f &= ~SCF_WHILEM_VISITED_POS;
3877
3878                 /* This will finish on WHILEM, setting scan, or on NULL: */
3879                 minnext = study_chunk(pRExC_state, &scan, minlenp, &deltanext, 
3880                                       last, data, stopparen, recursed, NULL,
3881                                       (mincount == 0
3882                                         ? (f & ~SCF_DO_SUBSTR) : f),depth+1);
3883
3884                 if (flags & SCF_DO_STCLASS)
3885                     data->start_class = oclass;
3886                 if (mincount == 0 || minnext == 0) {
3887                     if (flags & SCF_DO_STCLASS_OR) {
3888                         cl_or(pRExC_state, data->start_class, &this_class);
3889                     }
3890                     else if (flags & SCF_DO_STCLASS_AND) {
3891                         /* Switch to OR mode: cache the old value of
3892                          * data->start_class */
3893                         INIT_AND_WITHP;
3894                         StructCopy(data->start_class, and_withp,
3895                                    struct regnode_charclass_class);
3896                         flags &= ~SCF_DO_STCLASS_AND;
3897                         StructCopy(&this_class, data->start_class,
3898                                    struct regnode_charclass_class);
3899                         flags |= SCF_DO_STCLASS_OR;
3900                         SET_SSC_EOS(data->start_class);
3901                     }
3902                 } else {                /* Non-zero len */
3903                     if (flags & SCF_DO_STCLASS_OR) {
3904                         cl_or(pRExC_state, data->start_class, &this_class);
3905                         cl_and(data->start_class, and_withp);
3906                     }
3907                     else if (flags & SCF_DO_STCLASS_AND)
3908                         cl_and(data->start_class, &this_class);
3909                     flags &= ~SCF_DO_STCLASS;
3910                 }
3911                 if (!scan)              /* It was not CURLYX, but CURLY. */
3912                     scan = next;
3913                 if (!(flags & SCF_TRIE_DOING_RESTUDY)
3914                     /* ? quantifier ok, except for (?{ ... }) */
3915                     && (next_is_eval || !(mincount == 0 && maxcount == 1))
3916                     && (minnext == 0) && (deltanext == 0)
3917                     && data && !(data->flags & (SF_HAS_PAR|SF_IN_PAR))
3918                     && maxcount <= REG_INFTY/3) /* Complement check for big count */
3919                 {
3920                     /* Fatal warnings may leak the regexp without this: */
3921                     SAVEFREESV(RExC_rx_sv);
3922                     ckWARNreg(RExC_parse,
3923                               "Quantifier unexpected on zero-length expression");
3924                     (void)ReREFCNT_inc(RExC_rx_sv);
3925                 }
3926
3927                 min += minnext * mincount;
3928                 is_inf_internal |= deltanext == I32_MAX
3929                                      || (maxcount == REG_INFTY && minnext + deltanext > 0);
3930                 is_inf |= is_inf_internal;
3931                 if (is_inf)
3932                     delta = I32_MAX;
3933                 else
3934                     delta += (minnext + deltanext) * maxcount - minnext * mincount;
3935
3936                 /* Try powerful optimization CURLYX => CURLYN. */
3937                 if (  OP(oscan) == CURLYX && data
3938                       && data->flags & SF_IN_PAR
3939                       && !(data->flags & SF_HAS_EVAL)
3940                       && !deltanext && minnext == 1 ) {
3941                     /* Try to optimize to CURLYN.  */
3942                     regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS;
3943                     regnode * const nxt1 = nxt;
3944 #ifdef DEBUGGING
3945                     regnode *nxt2;
3946 #endif
3947
3948                     /* Skip open. */
3949                     nxt = regnext(nxt);
3950                     if (!REGNODE_SIMPLE(OP(nxt))
3951                         && !(PL_regkind[OP(nxt)] == EXACT
3952                              && STR_LEN(nxt) == 1))
3953                         goto nogo;
3954 #ifdef DEBUGGING
3955                     nxt2 = nxt;
3956 #endif
3957                     nxt = regnext(nxt);
3958                     if (OP(nxt) != CLOSE)
3959                         goto nogo;
3960                     if (RExC_open_parens) {
3961                         RExC_open_parens[ARG(nxt1)-1]=oscan; /*open->CURLYM*/
3962                         RExC_close_parens[ARG(nxt1)-1]=nxt+2; /*close->while*/
3963                     }
3964                     /* Now we know that nxt2 is the only contents: */
3965                     oscan->flags = (U8)ARG(nxt);
3966                     OP(oscan) = CURLYN;
3967                     OP(nxt1) = NOTHING; /* was OPEN. */
3968
3969 #ifdef DEBUGGING
3970                     OP(nxt1 + 1) = OPTIMIZED; /* was count. */
3971                     NEXT_OFF(nxt1+ 1) = 0; /* just for consistency. */
3972                     NEXT_OFF(nxt2) = 0; /* just for consistency with CURLY. */
3973                     OP(nxt) = OPTIMIZED;        /* was CLOSE. */
3974                     OP(nxt + 1) = OPTIMIZED; /* was count. */
3975                     NEXT_OFF(nxt+ 1) = 0; /* just for consistency. */
3976 #endif
3977                 }
3978               nogo:
3979
3980                 /* Try optimization CURLYX => CURLYM. */
3981                 if (  OP(oscan) == CURLYX && data
3982                       && !(data->flags & SF_HAS_PAR)
3983                       && !(data->flags & SF_HAS_EVAL)
3984                       && !deltanext     /* atom is fixed width */
3985                       && minnext != 0   /* CURLYM can't handle zero width */
3986                       && ! (RExC_seen & REG_SEEN_EXACTF_SHARP_S) /* Nor \xDF */
3987                 ) {
3988                     /* XXXX How to optimize if data == 0? */
3989                     /* Optimize to a simpler form.  */
3990                     regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN */
3991                     regnode *nxt2;
3992
3993                     OP(oscan) = CURLYM;
3994                     while ( (nxt2 = regnext(nxt)) /* skip over embedded stuff*/
3995                             && (OP(nxt2) != WHILEM))
3996                         nxt = nxt2;
3997                     OP(nxt2)  = SUCCEED; /* Whas WHILEM */
3998                     /* Need to optimize away parenths. */
3999                     if ((data->flags & SF_IN_PAR) && OP(nxt) == CLOSE) {
4000                         /* Set the parenth number.  */
4001                         regnode *nxt1 = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN*/
4002
4003                         oscan->flags = (U8)ARG(nxt);
4004                         if (RExC_open_parens) {
4005                             RExC_open_parens[ARG(nxt1)-1]=oscan; /*open->CURLYM*/
4006                             RExC_close_parens[ARG(nxt1)-1]=nxt2+1; /*close->NOTHING*/
4007                         }
4008                         OP(nxt1) = OPTIMIZED;   /* was OPEN. */
4009                         OP(nxt) = OPTIMIZED;    /* was CLOSE. */
4010
4011 #ifdef DEBUGGING
4012                         OP(nxt1 + 1) = OPTIMIZED; /* was count. */
4013                         OP(nxt + 1) = OPTIMIZED; /* was count. */
4014                         NEXT_OFF(nxt1 + 1) = 0; /* just for consistency. */
4015                         NEXT_OFF(nxt + 1) = 0; /* just for consistency. */
4016 #endif
4017 #if 0
4018                         while ( nxt1 && (OP(nxt1) != WHILEM)) {
4019                             regnode *nnxt = regnext(nxt1);
4020                             if (nnxt == nxt) {
4021                                 if (reg_off_by_arg[OP(nxt1)])
4022                                     ARG_SET(nxt1, nxt2 - nxt1);
4023                                 else if (nxt2 - nxt1 < U16_MAX)
4024                                     NEXT_OFF(nxt1) = nxt2 - nxt1;
4025                                 else
4026                                     OP(nxt) = NOTHING;  /* Cannot beautify */
4027                             }
4028                             nxt1 = nnxt;
4029                         }
4030 #endif
4031                         /* Optimize again: */
4032                         study_chunk(pRExC_state, &nxt1, minlenp, &deltanext, nxt,
4033                                     NULL, stopparen, recursed, NULL, 0,depth+1);
4034                     }
4035                     else
4036                         oscan->flags = 0;
4037                 }
4038                 else if ((OP(oscan) == CURLYX)
4039                          && (flags & SCF_WHILEM_VISITED_POS)
4040                          /* See the comment on a similar expression above.
4041                             However, this time it's not a subexpression
4042                             we care about, but the expression itself. */
4043                          && (maxcount == REG_INFTY)
4044                          && data && ++data->whilem_c < 16) {
4045                     /* This stays as CURLYX, we can put the count/of pair. */
4046                     /* Find WHILEM (as in regexec.c) */
4047                     regnode *nxt = oscan + NEXT_OFF(oscan);
4048
4049                     if (OP(PREVOPER(nxt)) == NOTHING) /* LONGJMP */
4050                         nxt += ARG(nxt);
4051                     PREVOPER(nxt)->flags = (U8)(data->whilem_c
4052                         | (RExC_whilem_seen << 4)); /* On WHILEM */
4053                 }
4054                 if (data && fl & (SF_HAS_PAR|SF_IN_PAR))
4055                     pars++;
4056                 if (flags & SCF_DO_SUBSTR) {
4057                     SV *last_str = NULL;
4058                     int counted = mincount != 0;
4059
4060                     if (data->last_end > 0 && mincount != 0) { /* Ends with a string. */
4061 #if defined(SPARC64_GCC_WORKAROUND)
4062                         I32 b = 0;
4063                         STRLEN l = 0;
4064                         const char *s = NULL;
4065                         I32 old = 0;
4066
4067                         if (pos_before >= data->last_start_min)
4068                             b = pos_before;
4069                         else
4070                             b = data->last_start_min;
4071
4072                         l = 0;
4073                         s = SvPV_const(data->last_found, l);
4074                         old = b - data->last_start_min;
4075
4076 #else
4077                         I32 b = pos_before >= data->last_start_min
4078                             ? pos_before : data->last_start_min;
4079                         STRLEN l;
4080                         const char * const s = SvPV_const(data->last_found, l);
4081                         I32 old = b - data->last_start_min;
4082 #endif
4083
4084                         if (UTF)
4085                             old = utf8_hop((U8*)s, old) - (U8*)s;
4086                         l -= old;
4087                         /* Get the added string: */
4088                         last_str = newSVpvn_utf8(s  + old, l, UTF);
4089                         if (deltanext == 0 && pos_before == b) {
4090                             /* What was added is a constant string */
4091                             if (mincount > 1) {
4092                                 SvGROW(last_str, (mincount * l) + 1);
4093                                 repeatcpy(SvPVX(last_str) + l,
4094                                           SvPVX_const(last_str), l, mincount - 1);
4095                                 SvCUR_set(last_str, SvCUR(last_str) * mincount);
4096                                 /* Add additional parts. */
4097                                 SvCUR_set(data->last_found,
4098                                           SvCUR(data->last_found) - l);
4099                                 sv_catsv(data->last_found, last_str);
4100                                 {
4101                                     SV * sv = data->last_found;
4102                                     MAGIC *mg =
4103                                         SvUTF8(sv) && SvMAGICAL(sv) ?
4104                                         mg_find(sv, PERL_MAGIC_utf8) : NULL;
4105                                     if (mg && mg->mg_len >= 0)
4106                                         mg->mg_len += CHR_SVLEN(last_str) - l;
4107                                 }
4108                                 data->last_end += l * (mincount - 1);
4109                             }
4110                         } else {
4111                             /* start offset must point into the last copy */
4112                             data->last_start_min += minnext * (mincount - 1);
4113                             data->last_start_max += is_inf ? I32_MAX
4114                                 : (maxcount - 1) * (minnext + data->pos_delta);
4115                         }
4116                     }
4117                     /* It is counted once already... */
4118                     data->pos_min += minnext * (mincount - counted);
4119 #if 0
4120 PerlIO_printf(Perl_debug_log, "counted=%d deltanext=%d I32_MAX=%d minnext=%d maxcount=%d mincount=%d\n",
4121     counted, deltanext, I32_MAX, minnext, maxcount, mincount);
4122 if (deltanext != I32_MAX)
4123 PerlIO_printf(Perl_debug_log, "LHS=%d RHS=%d\n", -counted * deltanext + (minnext + deltanext) * maxcount - minnext * mincount, I32_MAX - data->pos_delta);
4124 #endif
4125                     if (deltanext == I32_MAX || -counted * deltanext + (minnext + deltanext) * maxcount - minnext * mincount >= I32_MAX - data->pos_delta)
4126                         data->pos_delta = I32_MAX;
4127                     else
4128                         data->pos_delta += - counted * deltanext +
4129                         (minnext + deltanext) * maxcount - minnext * mincount;
4130                     if (mincount != maxcount) {
4131                          /* Cannot extend fixed substrings found inside
4132                             the group.  */
4133                         SCAN_COMMIT(pRExC_state,data,minlenp);
4134                         if (mincount && last_str) {
4135                             SV * const sv = data->last_found;
4136                             MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
4137                                 mg_find(sv, PERL_MAGIC_utf8) : NULL;
4138
4139                             if (mg)
4140                                 mg->mg_len = -1;
4141                             sv_setsv(sv, last_str);
4142                             data->last_end = data->pos_min;
4143                             data->last_start_min =
4144                                 data->pos_min - CHR_SVLEN(last_str);
4145                             data->last_start_max = is_inf
4146                                 ? I32_MAX
4147                                 : data->pos_min + data->pos_delta
4148                                 - CHR_SVLEN(last_str);
4149                         }
4150                         data->longest = &(data->longest_float);
4151                     }
4152                     SvREFCNT_dec(last_str);
4153                 }
4154                 if (data && (fl & SF_HAS_EVAL))
4155                     data->flags |= SF_HAS_EVAL;
4156               optimize_curly_tail:
4157                 if (OP(oscan) != CURLYX) {
4158                     while (PL_regkind[OP(next = regnext(oscan))] == NOTHING
4159                            && NEXT_OFF(next))
4160                         NEXT_OFF(oscan) += NEXT_OFF(next);
4161                 }
4162                 continue;
4163             default:                    /* REF, and CLUMP only? */
4164                 if (flags & SCF_DO_SUBSTR) {
4165                     SCAN_COMMIT(pRExC_state,data,minlenp);      /* Cannot expect anything... */
4166                     data->longest = &(data->longest_float);
4167                 }
4168                 is_inf = is_inf_internal = 1;
4169                 if (flags & SCF_DO_STCLASS_OR)
4170                     cl_anything(pRExC_state, data->start_class);
4171                 flags &= ~SCF_DO_STCLASS;
4172                 break;
4173             }
4174         }
4175         else if (OP(scan) == LNBREAK) {
4176             if (flags & SCF_DO_STCLASS) {
4177                 int value = 0;
4178                 CLEAR_SSC_EOS(data->start_class); /* No match on empty */
4179                 if (flags & SCF_DO_STCLASS_AND) {
4180                     for (value = 0; value < 256; value++)
4181                         if (!is_VERTWS_cp(value))
4182                             ANYOF_BITMAP_CLEAR(data->start_class, value);
4183                 }
4184                 else {
4185                     for (value = 0; value < 256; value++)
4186                         if (is_VERTWS_cp(value))
4187                             ANYOF_BITMAP_SET(data->start_class, value);
4188                 }
4189                 if (flags & SCF_DO_STCLASS_OR)
4190                     cl_and(data->start_class, and_withp);
4191                 flags &= ~SCF_DO_STCLASS;
4192             }
4193             min++;
4194             delta++;    /* Because of the 2 char string cr-lf */
4195             if (flags & SCF_DO_SUBSTR) {
4196                 SCAN_COMMIT(pRExC_state,data,minlenp);  /* Cannot expect anything... */
4197                 data->pos_min += 1;
4198                 data->pos_delta += 1;
4199                 data->longest = &(data->longest_float);
4200             }
4201         }
4202         else if (REGNODE_SIMPLE(OP(scan))) {
4203             int value = 0;
4204
4205             if (flags & SCF_DO_SUBSTR) {
4206                 SCAN_COMMIT(pRExC_state,data,minlenp);
4207                 data->pos_min++;
4208             }
4209             min++;
4210             if (flags & SCF_DO_STCLASS) {
4211                 int loop_max = 256;
4212                 CLEAR_SSC_EOS(data->start_class); /* No match on empty */
4213
4214                 /* Some of the logic below assumes that switching
4215                    locale on will only add false positives. */
4216                 switch (PL_regkind[OP(scan)]) {
4217                     U8 classnum;
4218
4219                 case SANY:
4220                 default:
4221 #ifdef DEBUGGING
4222                    Perl_croak(aTHX_ "panic: unexpected simple REx opcode %d", OP(scan));
4223 #endif
4224                  do_default:
4225                     if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
4226                         cl_anything(pRExC_state, data->start_class);
4227                     break;
4228                 case REG_ANY:
4229                     if (OP(scan) == SANY)
4230                         goto do_default;
4231                     if (flags & SCF_DO_STCLASS_OR) { /* Everything but \n */
4232                         value = (ANYOF_BITMAP_TEST(data->start_class,'\n')
4233                                 || ANYOF_CLASS_TEST_ANY_SET(data->start_class));
4234                         cl_anything(pRExC_state, data->start_class);
4235                     }
4236                     if (flags & SCF_DO_STCLASS_AND || !value)
4237                         ANYOF_BITMAP_CLEAR(data->start_class,'\n');
4238                     break;
4239                 case ANYOF:
4240                     if (flags & SCF_DO_STCLASS_AND)
4241                         cl_and(data->start_class,
4242                                (struct regnode_charclass_class*)scan);
4243                     else
4244                         cl_or(pRExC_state, data->start_class,
4245                               (struct regnode_charclass_class*)scan);
4246                     break;
4247                 case POSIXA:
4248                     loop_max = 128;
4249                     /* FALL THROUGH */
4250                 case POSIXL:
4251                 case POSIXD:
4252                 case POSIXU:
4253                     classnum = FLAGS(scan);
4254                     if (flags & SCF_DO_STCLASS_AND) {
4255                         if (!(data->start_class->flags & ANYOF_LOCALE)) {
4256                             ANYOF_CLASS_CLEAR(data->start_class, classnum_to_namedclass(classnum) + 1);
4257                             for (value = 0; value < loop_max; value++) {
4258                                 if (! _generic_isCC(UNI_TO_NATIVE(value), classnum)) {
4259                                     ANYOF_BITMAP_CLEAR(data->start_class, UNI_TO_NATIVE(value));
4260                                 }
4261                             }
4262                         }
4263                     }
4264                     else {
4265                         if (data->start_class->flags & ANYOF_LOCALE) {
4266                             ANYOF_CLASS_SET(data->start_class, classnum_to_namedclass(classnum));
4267                         }
4268                         else {
4269
4270                         /* Even if under locale, set the bits for non-locale
4271                          * in case it isn't a true locale-node.  This will
4272                          * create false positives if it truly is locale */
4273                         for (value = 0; value < loop_max; value++) {
4274                             if (_generic_isCC(UNI_TO_NATIVE(value), classnum)) {
4275                                 ANYOF_BITMAP_SET(data->start_class, UNI_TO_NATIVE(value));
4276                             }
4277                         }
4278                         }
4279                     }
4280                     break;
4281                 case NPOSIXA:
4282                     loop_max = 128;
4283                     /* FALL THROUGH */
4284                 case NPOSIXL:
4285                 case NPOSIXU:
4286                 case NPOSIXD:
4287                     classnum = FLAGS(scan);
4288                     if (flags & SCF_DO_STCLASS_AND) {
4289                         if (!(data->start_class->flags & ANYOF_LOCALE)) {
4290                             ANYOF_CLASS_CLEAR(data->start_class, classnum_to_namedclass(classnum));
4291                             for (value = 0; value < loop_max; value++) {
4292                                 if (_generic_isCC(UNI_TO_NATIVE(value), classnum)) {
4293                                     ANYOF_BITMAP_CLEAR(data->start_class, UNI_TO_NATIVE(value));
4294                                 }
4295                             }
4296                         }
4297                     }
4298                     else {
4299                         if (data->start_class->flags & ANYOF_LOCALE) {
4300                             ANYOF_CLASS_SET(data->start_class, classnum_to_namedclass(classnum) + 1);
4301                         }
4302                         else {
4303
4304                         /* Even if under locale, set the bits for non-locale in
4305                          * case it isn't a true locale-node.  This will create
4306                          * false positives if it truly is locale */
4307                         for (value = 0; value < loop_max; value++) {
4308                             if (! _generic_isCC(UNI_TO_NATIVE(value), classnum)) {
4309                                 ANYOF_BITMAP_SET(data->start_class, UNI_TO_NATIVE(value));
4310                             }
4311                         }
4312                         if (PL_regkind[OP(scan)] == NPOSIXD) {
4313                             data->start_class->flags |= ANYOF_NON_UTF8_LATIN1_ALL;
4314                         }
4315                         }
4316                     }
4317                     break;
4318                 }
4319                 if (flags & SCF_DO_STCLASS_OR)
4320                     cl_and(data->start_class, and_withp);
4321                 flags &= ~SCF_DO_STCLASS;
4322             }
4323         }
4324         else if (PL_regkind[OP(scan)] == EOL && flags & SCF_DO_SUBSTR) {
4325             data->flags |= (OP(scan) == MEOL
4326                             ? SF_BEFORE_MEOL
4327                             : SF_BEFORE_SEOL);
4328             SCAN_COMMIT(pRExC_state, data, minlenp);
4329
4330         }
4331         else if (  PL_regkind[OP(scan)] == BRANCHJ
4332                  /* Lookbehind, or need to calculate parens/evals/stclass: */
4333                    && (scan->flags || data || (flags & SCF_DO_STCLASS))
4334                    && (OP(scan) == IFMATCH || OP(scan) == UNLESSM)) {
4335             if ( OP(scan) == UNLESSM &&
4336                  scan->flags == 0 &&
4337                  OP(NEXTOPER(NEXTOPER(scan))) == NOTHING &&
4338                  OP(regnext(NEXTOPER(NEXTOPER(scan)))) == SUCCEED
4339             ) {
4340                 regnode *opt;
4341                 regnode *upto= regnext(scan);
4342                 DEBUG_PARSE_r({
4343                     SV * const mysv_val=sv_newmortal();
4344                     DEBUG_STUDYDATA("OPFAIL",data,depth);
4345
4346                     /*DEBUG_PARSE_MSG("opfail");*/
4347                     regprop(RExC_rx, mysv_val, upto);
4348                     PerlIO_printf(Perl_debug_log, "~ replace with OPFAIL pointed at %s (%"IVdf") offset %"IVdf"\n",
4349                                   SvPV_nolen_const(mysv_val),
4350                                   (IV)REG_NODE_NUM(upto),
4351                                   (IV)(upto - scan)
4352                     );
4353                 });
4354                 OP(scan) = OPFAIL;
4355                 NEXT_OFF(scan) = upto - scan;
4356                 for (opt= scan + 1; opt < upto ; opt++)
4357                     OP(opt) = OPTIMIZED;
4358                 scan= upto;
4359                 continue;
4360             }
4361             if ( !PERL_ENABLE_POSITIVE_ASSERTION_STUDY 
4362                 || OP(scan) == UNLESSM )
4363             {
4364                 /* Negative Lookahead/lookbehind
4365                    In this case we can't do fixed string optimisation.
4366                 */
4367
4368                 I32 deltanext, minnext, fake = 0;
4369                 regnode *nscan;
4370                 struct regnode_charclass_class intrnl;
4371                 int f = 0;
4372
4373                 data_fake.flags = 0;
4374                 if (data) {
4375                     data_fake.whilem_c = data->whilem_c;
4376                     data_fake.last_closep = data->last_closep;
4377                 }
4378                 else
4379                     data_fake.last_closep = &fake;
4380                 data_fake.pos_delta = delta;
4381                 if ( flags & SCF_DO_STCLASS && !scan->flags
4382                      && OP(scan) == IFMATCH ) { /* Lookahead */
4383                     cl_init(pRExC_state, &intrnl);
4384                     data_fake.start_class = &intrnl;
4385                     f |= SCF_DO_STCLASS_AND;
4386                 }
4387                 if (flags & SCF_WHILEM_VISITED_POS)
4388                     f |= SCF_WHILEM_VISITED_POS;
4389                 next = regnext(scan);
4390                 nscan = NEXTOPER(NEXTOPER(scan));
4391                 minnext = study_chunk(pRExC_state, &nscan, minlenp, &deltanext, 
4392                     last, &data_fake, stopparen, recursed, NULL, f, depth+1);
4393                 if (scan->flags) {
4394                     if (deltanext) {
4395                         FAIL("Variable length lookbehind not implemented");
4396                     }
4397                     else if (minnext > (I32)U8_MAX) {
4398                         FAIL2("Lookbehind longer than %"UVuf" not implemented", (UV)U8_MAX);
4399                     }
4400                     scan->flags = (U8)minnext;
4401                 }
4402                 if (data) {
4403                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4404                         pars++;
4405                     if (data_fake.flags & SF_HAS_EVAL)
4406                         data->flags |= SF_HAS_EVAL;
4407                     data->whilem_c = data_fake.whilem_c;
4408                 }
4409                 if (f & SCF_DO_STCLASS_AND) {
4410                     if (flags & SCF_DO_STCLASS_OR) {
4411                         /* OR before, AND after: ideally we would recurse with
4412                          * data_fake to get the AND applied by study of the
4413                          * remainder of the pattern, and then derecurse;
4414                          * *** HACK *** for now just treat as "no information".
4415                          * See [perl #56690].
4416                          */
4417                         cl_init(pRExC_state, data->start_class);
4418                     }  else {
4419                         /* AND before and after: combine and continue */
4420                         const int was = TEST_SSC_EOS(data->start_class);
4421
4422                         cl_and(data->start_class, &intrnl);
4423                         if (was)
4424                             SET_SSC_EOS(data->start_class);
4425                     }
4426                 }
4427             }
4428 #if PERL_ENABLE_POSITIVE_ASSERTION_STUDY
4429             else {
4430                 /* Positive Lookahead/lookbehind
4431                    In this case we can do fixed string optimisation,
4432                    but we must be careful about it. Note in the case of
4433                    lookbehind the positions will be offset by the minimum
4434                    length of the pattern, something we won't know about
4435                    until after the recurse.
4436                 */
4437                 I32 deltanext, fake = 0;
4438                 regnode *nscan;
4439                 struct regnode_charclass_class intrnl;
4440                 int f = 0;
4441                 /* We use SAVEFREEPV so that when the full compile 
4442                     is finished perl will clean up the allocated 
4443                     minlens when it's all done. This way we don't
4444                     have to worry about freeing them when we know
4445                     they wont be used, which would be a pain.
4446                  */
4447                 I32 *minnextp;
4448                 Newx( minnextp, 1, I32 );
4449                 SAVEFREEPV(minnextp);
4450
4451                 if (data) {
4452                     StructCopy(data, &data_fake, scan_data_t);
4453                     if ((flags & SCF_DO_SUBSTR) && data->last_found) {
4454                         f |= SCF_DO_SUBSTR;
4455                         if (scan->flags) 
4456                             SCAN_COMMIT(pRExC_state, &data_fake,minlenp);
4457                         data_fake.last_found=newSVsv(data->last_found);
4458                     }
4459                 }
4460                 else
4461                     data_fake.last_closep = &fake;
4462                 data_fake.flags = 0;
4463                 data_fake.pos_delta = delta;
4464                 if (is_inf)
4465                     data_fake.flags |= SF_IS_INF;
4466                 if ( flags & SCF_DO_STCLASS && !scan->flags
4467                      && OP(scan) == IFMATCH ) { /* Lookahead */
4468                     cl_init(pRExC_state, &intrnl);
4469                     data_fake.start_class = &intrnl;
4470                     f |= SCF_DO_STCLASS_AND;
4471                 }
4472                 if (flags & SCF_WHILEM_VISITED_POS)
4473                     f |= SCF_WHILEM_VISITED_POS;
4474                 next = regnext(scan);
4475                 nscan = NEXTOPER(NEXTOPER(scan));
4476
4477                 *minnextp = study_chunk(pRExC_state, &nscan, minnextp, &deltanext, 
4478                     last, &data_fake, stopparen, recursed, NULL, f,depth+1);
4479                 if (scan->flags) {
4480                     if (deltanext) {
4481                         FAIL("Variable length lookbehind not implemented");
4482                     }
4483                     else if (*minnextp > (I32)U8_MAX) {
4484                         FAIL2("Lookbehind longer than %"UVuf" not implemented", (UV)U8_MAX);
4485                     }
4486                     scan->flags = (U8)*minnextp;
4487                 }
4488
4489                 *minnextp += min;
4490
4491                 if (f & SCF_DO_STCLASS_AND) {
4492                     const int was = TEST_SSC_EOS(data.start_class);
4493
4494                     cl_and(data->start_class, &intrnl);
4495                     if (was)
4496                         SET_SSC_EOS(data->start_class);
4497                 }
4498                 if (data) {
4499                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4500                         pars++;
4501                     if (data_fake.flags & SF_HAS_EVAL)
4502                         data->flags |= SF_HAS_EVAL;
4503                     data->whilem_c = data_fake.whilem_c;
4504                     if ((flags & SCF_DO_SUBSTR) && data_fake.last_found) {
4505                         if (RExC_rx->minlen<*minnextp)
4506                             RExC_rx->minlen=*minnextp;
4507                         SCAN_COMMIT(pRExC_state, &data_fake, minnextp);
4508                         SvREFCNT_dec_NN(data_fake.last_found);
4509                         
4510                         if ( data_fake.minlen_fixed != minlenp ) 
4511                         {
4512                             data->offset_fixed= data_fake.offset_fixed;
4513                             data->minlen_fixed= data_fake.minlen_fixed;
4514                             data->lookbehind_fixed+= scan->flags;
4515                         }
4516                         if ( data_fake.minlen_float != minlenp )
4517                         {
4518                             data->minlen_float= data_fake.minlen_float;
4519                             data->offset_float_min=data_fake.offset_float_min;
4520                             data->offset_float_max=data_fake.offset_float_max;
4521                             data->lookbehind_float+= scan->flags;
4522                         }
4523                     }
4524                 }
4525             }
4526 #endif
4527         }
4528         else if (OP(scan) == OPEN) {
4529             if (stopparen != (I32)ARG(scan))
4530                 pars++;
4531         }
4532         else if (OP(scan) == CLOSE) {
4533             if (stopparen == (I32)ARG(scan)) {
4534                 break;
4535             }
4536             if ((I32)ARG(scan) == is_par) {
4537                 next = regnext(scan);
4538
4539                 if ( next && (OP(next) != WHILEM) && next < last)
4540                     is_par = 0;         /* Disable optimization */
4541             }
4542             if (data)
4543                 *(data->last_closep) = ARG(scan);
4544         }
4545         else if (OP(scan) == EVAL) {
4546                 if (data)
4547                     data->flags |= SF_HAS_EVAL;
4548         }
4549         else if ( PL_regkind[OP(scan)] == ENDLIKE ) {
4550             if (flags & SCF_DO_SUBSTR) {
4551                 SCAN_COMMIT(pRExC_state,data,minlenp);
4552                 flags &= ~SCF_DO_SUBSTR;
4553             }
4554             if (data && OP(scan)==ACCEPT) {
4555                 data->flags |= SCF_SEEN_ACCEPT;
4556                 if (stopmin > min)
4557                     stopmin = min;
4558             }
4559         }
4560         else if (OP(scan) == LOGICAL && scan->flags == 2) /* Embedded follows */
4561         {
4562                 if (flags & SCF_DO_SUBSTR) {
4563                     SCAN_COMMIT(pRExC_state,data,minlenp);
4564                     data->longest = &(data->longest_float);
4565                 }
4566                 is_inf = is_inf_internal = 1;
4567                 if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
4568                     cl_anything(pRExC_state, data->start_class);
4569                 flags &= ~SCF_DO_STCLASS;
4570         }
4571         else if (OP(scan) == GPOS) {
4572             if (!(RExC_rx->extflags & RXf_GPOS_FLOAT) &&
4573                 !(delta || is_inf || (data && data->pos_delta))) 
4574             {
4575                 if (!(RExC_rx->extflags & RXf_ANCH) && (flags & SCF_DO_SUBSTR))
4576                     RExC_rx->extflags |= RXf_ANCH_GPOS;
4577                 if (RExC_rx->gofs < (U32)min)
4578                     RExC_rx->gofs = min;
4579             } else {
4580                 RExC_rx->extflags |= RXf_GPOS_FLOAT;
4581                 RExC_rx->gofs = 0;
4582             }       
4583         }
4584 #ifdef TRIE_STUDY_OPT
4585 #ifdef FULL_TRIE_STUDY
4586         else if (PL_regkind[OP(scan)] == TRIE) {
4587             /* NOTE - There is similar code to this block above for handling
4588                BRANCH nodes on the initial study.  If you change stuff here
4589                check there too. */
4590             regnode *trie_node= scan;
4591             regnode *tail= regnext(scan);
4592             reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
4593             I32 max1 = 0, min1 = I32_MAX;
4594             struct regnode_charclass_class accum;
4595
4596             if (flags & SCF_DO_SUBSTR) /* XXXX Add !SUSPEND? */
4597                 SCAN_COMMIT(pRExC_state, data,minlenp); /* Cannot merge strings after this. */
4598             if (flags & SCF_DO_STCLASS)
4599                 cl_init_zero(pRExC_state, &accum);
4600                 
4601             if (!trie->jump) {
4602                 min1= trie->minlen;
4603                 max1= trie->maxlen;
4604             } else {
4605                 const regnode *nextbranch= NULL;
4606                 U32 word;
4607                 
4608                 for ( word=1 ; word <= trie->wordcount ; word++) 
4609                 {
4610                     I32 deltanext=0, minnext=0, f = 0, fake;
4611                     struct regnode_charclass_class this_class;
4612                     
4613                     data_fake.flags = 0;
4614                     if (data) {
4615                         data_fake.whilem_c = data->whilem_c;
4616                         data_fake.last_closep = data->last_closep;
4617                     }
4618                     else
4619                         data_fake.last_closep = &fake;
4620                     data_fake.pos_delta = delta;
4621                     if (flags & SCF_DO_STCLASS) {
4622                         cl_init(pRExC_state, &this_class);
4623                         data_fake.start_class = &this_class;
4624                         f = SCF_DO_STCLASS_AND;
4625                     }
4626                     if (flags & SCF_WHILEM_VISITED_POS)
4627                         f |= SCF_WHILEM_VISITED_POS;
4628     
4629                     if (trie->jump[word]) {
4630                         if (!nextbranch)
4631                             nextbranch = trie_node + trie->jump[0];
4632                         scan= trie_node + trie->jump[word];
4633                         /* We go from the jump point to the branch that follows
4634                            it. Note this means we need the vestigal unused branches
4635                            even though they arent otherwise used.
4636                          */
4637                         minnext = study_chunk(pRExC_state, &scan, minlenp, 
4638                             &deltanext, (regnode *)nextbranch, &data_fake, 
4639                             stopparen, recursed, NULL, f,depth+1);
4640                     }
4641                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
4642                         nextbranch= regnext((regnode*)nextbranch);
4643                     
4644                     if (min1 > (I32)(minnext + trie->minlen))
4645                         min1 = minnext + trie->minlen;
4646                     if (deltanext == I32_MAX) {
4647                         is_inf = is_inf_internal = 1;
4648                         max1 = I32_MAX;
4649                     } else if (max1 < (I32)(minnext + deltanext + trie->maxlen))
4650                         max1 = minnext + deltanext + trie->maxlen;
4651                     
4652                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4653                         pars++;
4654                     if (data_fake.flags & SCF_SEEN_ACCEPT) {
4655                         if ( stopmin > min + min1) 
4656                             stopmin = min + min1;
4657                         flags &= ~SCF_DO_SUBSTR;
4658                         if (data)
4659                             data->flags |= SCF_SEEN_ACCEPT;
4660                     }
4661                     if (data) {
4662                         if (data_fake.flags & SF_HAS_EVAL)
4663                             data->flags |= SF_HAS_EVAL;
4664                         data->whilem_c = data_fake.whilem_c;
4665                     }
4666                     if (flags & SCF_DO_STCLASS)
4667                         cl_or(pRExC_state, &accum, &this_class);
4668                 }
4669             }
4670             if (flags & SCF_DO_SUBSTR) {
4671                 data->pos_min += min1;
4672                 data->pos_delta += max1 - min1;
4673                 if (max1 != min1 || is_inf)
4674                     data->longest = &(data->longest_float);
4675             }
4676             min += min1;
4677             delta += max1 - min1;
4678             if (flags & SCF_DO_STCLASS_OR) {
4679                 cl_or(pRExC_state, data->start_class, &accum);
4680                 if (min1) {
4681                     cl_and(data->start_class, and_withp);
4682                     flags &= ~SCF_DO_STCLASS;
4683                 }
4684             }
4685             else if (flags & SCF_DO_STCLASS_AND) {
4686                 if (min1) {
4687                     cl_and(data->start_class, &accum);
4688                     flags &= ~SCF_DO_STCLASS;
4689                 }
4690                 else {
4691                     /* Switch to OR mode: cache the old value of
4692                      * data->start_class */
4693                     INIT_AND_WITHP;
4694                     StructCopy(data->start_class, and_withp,
4695                                struct regnode_charclass_class);
4696                     flags &= ~SCF_DO_STCLASS_AND;
4697                     StructCopy(&accum, data->start_class,
4698                                struct regnode_charclass_class);
4699                     flags |= SCF_DO_STCLASS_OR;
4700                     SET_SSC_EOS(data->start_class);
4701                 }
4702             }
4703             scan= tail;
4704             continue;
4705         }
4706 #else
4707         else if (PL_regkind[OP(scan)] == TRIE) {
4708             reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
4709             U8*bang=NULL;
4710             
4711             min += trie->minlen;
4712             delta += (trie->maxlen - trie->minlen);
4713             flags &= ~SCF_DO_STCLASS; /* xxx */
4714             if (flags & SCF_DO_SUBSTR) {
4715                 SCAN_COMMIT(pRExC_state,data,minlenp);  /* Cannot expect anything... */
4716                 data->pos_min += trie->minlen;
4717                 data->pos_delta += (trie->maxlen - trie->minlen);
4718                 if (trie->maxlen != trie->minlen)
4719                     data->longest = &(data->longest_float);
4720             }
4721             if (trie->jump) /* no more substrings -- for now /grr*/
4722                 flags &= ~SCF_DO_SUBSTR; 
4723         }
4724 #endif /* old or new */
4725 #endif /* TRIE_STUDY_OPT */
4726
4727         /* Else: zero-length, ignore. */
4728         scan = regnext(scan);
4729     }
4730     if (frame) {
4731         last = frame->last;
4732         scan = frame->next;
4733         stopparen = frame->stop;
4734         frame = frame->prev;
4735         goto fake_study_recurse;
4736     }
4737
4738   finish:
4739     assert(!frame);
4740     DEBUG_STUDYDATA("pre-fin:",data,depth);
4741
4742     *scanp = scan;
4743     *deltap = is_inf_internal ? I32_MAX : delta;
4744     if (flags & SCF_DO_SUBSTR && is_inf)
4745         data->pos_delta = I32_MAX - data->pos_min;
4746     if (is_par > (I32)U8_MAX)
4747         is_par = 0;
4748     if (is_par && pars==1 && data) {
4749         data->flags |= SF_IN_PAR;
4750         data->flags &= ~SF_HAS_PAR;
4751     }
4752     else if (pars && data) {
4753         data->flags |= SF_HAS_PAR;
4754         data->flags &= ~SF_IN_PAR;
4755     }
4756     if (flags & SCF_DO_STCLASS_OR)
4757         cl_and(data->start_class, and_withp);
4758     if (flags & SCF_TRIE_RESTUDY)
4759         data->flags |=  SCF_TRIE_RESTUDY;
4760     
4761     DEBUG_STUDYDATA("post-fin:",data,depth);
4762     
4763     return min < stopmin ? min : stopmin;
4764 }
4765
4766 STATIC U32
4767 S_add_data(RExC_state_t *pRExC_state, U32 n, const char *s)
4768 {
4769     U32 count = RExC_rxi->data ? RExC_rxi->data->count : 0;
4770
4771     PERL_ARGS_ASSERT_ADD_DATA;
4772
4773     Renewc(RExC_rxi->data,
4774            sizeof(*RExC_rxi->data) + sizeof(void*) * (count + n - 1),
4775            char, struct reg_data);
4776     if(count)
4777         Renew(RExC_rxi->data->what, count + n, U8);
4778     else
4779         Newx(RExC_rxi->data->what, n, U8);
4780     RExC_rxi->data->count = count + n;
4781     Copy(s, RExC_rxi->data->what + count, n, U8);
4782     return count;
4783 }
4784
4785 /*XXX: todo make this not included in a non debugging perl */
4786 #ifndef PERL_IN_XSUB_RE
4787 void
4788 Perl_reginitcolors(pTHX)
4789 {
4790     dVAR;
4791     const char * const s = PerlEnv_getenv("PERL_RE_COLORS");
4792     if (s) {
4793         char *t = savepv(s);
4794         int i = 0;
4795         PL_colors[0] = t;
4796         while (++i < 6) {
4797             t = strchr(t, '\t');
4798             if (t) {
4799                 *t = '\0';
4800                 PL_colors[i] = ++t;
4801             }
4802             else
4803                 PL_colors[i] = t = (char *)"";
4804         }
4805     } else {
4806         int i = 0;
4807         while (i < 6)
4808             PL_colors[i++] = (char *)"";
4809     }
4810     PL_colorset = 1;
4811 }
4812 #endif
4813
4814
4815 #ifdef TRIE_STUDY_OPT
4816 #define CHECK_RESTUDY_GOTO_butfirst(dOsomething)            \
4817     STMT_START {                                            \
4818         if (                                                \
4819               (data.flags & SCF_TRIE_RESTUDY)               \
4820               && ! restudied++                              \
4821         ) {                                                 \
4822             dOsomething;                                    \
4823             goto reStudy;                                   \
4824         }                                                   \
4825     } STMT_END
4826 #else
4827 #define CHECK_RESTUDY_GOTO_butfirst
4828 #endif        
4829
4830 /*
4831  * pregcomp - compile a regular expression into internal code
4832  *
4833  * Decides which engine's compiler to call based on the hint currently in
4834  * scope
4835  */
4836
4837 #ifndef PERL_IN_XSUB_RE 
4838
4839 /* return the currently in-scope regex engine (or the default if none)  */
4840
4841 regexp_engine const *
4842 Perl_current_re_engine(pTHX)
4843 {
4844     dVAR;
4845
4846     if (IN_PERL_COMPILETIME) {
4847         HV * const table = GvHV(PL_hintgv);
4848         SV **ptr;
4849
4850         if (!table)
4851             return &PL_core_reg_engine;
4852         ptr = hv_fetchs(table, "regcomp", FALSE);
4853         if ( !(ptr && SvIOK(*ptr) && SvIV(*ptr)))
4854             return &PL_core_reg_engine;
4855         return INT2PTR(regexp_engine*,SvIV(*ptr));
4856     }
4857     else {
4858         SV *ptr;
4859         if (!PL_curcop->cop_hints_hash)
4860             return &PL_core_reg_engine;
4861         ptr = cop_hints_fetch_pvs(PL_curcop, "regcomp", 0);
4862         if ( !(ptr && SvIOK(ptr) && SvIV(ptr)))
4863             return &PL_core_reg_engine;
4864         return INT2PTR(regexp_engine*,SvIV(ptr));
4865     }
4866 }
4867
4868
4869 REGEXP *
4870 Perl_pregcomp(pTHX_ SV * const pattern, const U32 flags)
4871 {
4872     dVAR;
4873     regexp_engine const *eng = current_re_engine();
4874     GET_RE_DEBUG_FLAGS_DECL;
4875
4876     PERL_ARGS_ASSERT_PREGCOMP;
4877
4878     /* Dispatch a request to compile a regexp to correct regexp engine. */
4879     DEBUG_COMPILE_r({
4880         PerlIO_printf(Perl_debug_log, "Using engine %"UVxf"\n",
4881                         PTR2UV(eng));
4882     });
4883     return CALLREGCOMP_ENG(eng, pattern, flags);
4884 }
4885 #endif
4886
4887 /* public(ish) entry point for the perl core's own regex compiling code.
4888  * It's actually a wrapper for Perl_re_op_compile that only takes an SV
4889  * pattern rather than a list of OPs, and uses the internal engine rather
4890  * than the current one */
4891
4892 REGEXP *
4893 Perl_re_compile(pTHX_ SV * const pattern, U32 rx_flags)
4894 {
4895     SV *pat = pattern; /* defeat constness! */
4896     PERL_ARGS_ASSERT_RE_COMPILE;
4897     return Perl_re_op_compile(aTHX_ &pat, 1, NULL,
4898 #ifdef PERL_IN_XSUB_RE
4899                                 &my_reg_engine,
4900 #else
4901                                 &PL_core_reg_engine,
4902 #endif
4903                                 NULL, NULL, rx_flags, 0);
4904 }
4905
4906
4907 /* upgrade pattern pat_p of length plen_p to UTF8, and if there are code
4908  * blocks, recalculate the indices. Update pat_p and plen_p in-place to
4909  * point to the realloced string and length.
4910  *
4911  * This is essentially a copy of Perl_bytes_to_utf8() with the code index
4912  * stuff added */
4913
4914 static void
4915 S_pat_upgrade_to_utf8(pTHX_ RExC_state_t * const pRExC_state,
4916                     char **pat_p, STRLEN *plen_p, int num_code_blocks)
4917 {
4918     U8 *const src = (U8*)*pat_p;
4919     U8 *dst;
4920     int n=0;
4921     STRLEN s = 0, d = 0;
4922     bool do_end = 0;
4923     GET_RE_DEBUG_FLAGS_DECL;
4924
4925     DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log,
4926         "UTF8 mismatch! Converting to utf8 for resizing and compile\n"));
4927
4928     Newx(dst, *plen_p * 2 + 1, U8);
4929
4930     while (s < *plen_p) {
4931         const UV uv = NATIVE_TO_ASCII(src[s]);
4932         if (UNI_IS_INVARIANT(uv))
4933             dst[d]   = (U8)UTF_TO_NATIVE(uv);
4934         else {
4935             dst[d++] = (U8)UTF8_EIGHT_BIT_HI(uv);
4936             dst[d]   = (U8)UTF8_EIGHT_BIT_LO(uv);
4937         }
4938         if (n < num_code_blocks) {
4939             if (!do_end && pRExC_state->code_blocks[n].start == s) {
4940                 pRExC_state->code_blocks[n].start = d;
4941                 assert(dst[d] == '(');
4942                 do_end = 1;
4943             }
4944             else if (do_end && pRExC_state->code_blocks[n].end == s) {
4945                 pRExC_state->code_blocks[n].end = d;
4946                 assert(dst[d] == ')');
4947                 do_end = 0;
4948                 n++;
4949             }
4950         }
4951         s++;
4952         d++;
4953     }
4954     dst[d] = '\0';
4955     *plen_p = d;
4956     *pat_p = (char*) dst;
4957     SAVEFREEPV(*pat_p);
4958     RExC_orig_utf8 = RExC_utf8 = 1;
4959 }
4960
4961
4962
4963 /* S_concat_pat(): concatenate a list of args to the pattern string pat,
4964  * while recording any code block indices, and handling overloading,
4965  * nested qr// objects etc.  If pat is null, it will allocate a new
4966  * string, or just return the first arg, if there's only one.
4967  *
4968  * Returns the malloced/updated pat.
4969  * patternp and pat_count is the array of SVs to be concatted;
4970  * oplist is the optional list of ops that generated the SVs;
4971  * recompile_p is a pointer to a boolean that will be set if
4972  *   the regex will need to be recompiled.
4973  * delim, if non-null is an SV that will be inserted between each element
4974  */
4975
4976 static SV*
4977 S_concat_pat(pTHX_ RExC_state_t * const pRExC_state,
4978                 SV *pat, SV ** const patternp, int pat_count,
4979                 OP *oplist, bool *recompile_p, SV *delim)
4980 {
4981     SV **svp;
4982     int n = 0;
4983     bool use_delim = FALSE;
4984     bool alloced = FALSE;
4985
4986     /* if we know we have at least two args, create an empty string,
4987      * then concatenate args to that. For no args, return an empty string */
4988     if (!pat && pat_count != 1) {
4989         pat = newSVpvn("", 0);
4990         SAVEFREESV(pat);
4991         alloced = TRUE;
4992     }
4993
4994     for (svp = patternp; svp < patternp + pat_count; svp++) {
4995         SV *sv;
4996         SV *rx  = NULL;
4997         STRLEN orig_patlen = 0;
4998         bool code = 0;
4999         SV *msv = use_delim ? delim : *svp;
5000
5001         /* if we've got a delimiter, we go round the loop twice for each
5002          * svp slot (except the last), using the delimiter the second
5003          * time round */
5004         if (use_delim) {
5005             svp--;
5006             use_delim = FALSE;
5007         }
5008         else if (delim)
5009             use_delim = TRUE;
5010
5011         if (SvTYPE(msv) == SVt_PVAV) {
5012             /* we've encountered an interpolated array within
5013              * the pattern, e.g. /...@a..../. Expand the list of elements,
5014              * then recursively append elements.
5015              * The code in this block is based on S_pushav() */
5016
5017             AV *const av = (AV*)msv;
5018             const I32 maxarg = AvFILL(av) + 1;
5019             SV **array;
5020
5021             if (oplist) {
5022                 assert(oplist->op_type == OP_PADAV
5023                     || oplist->op_type == OP_RV2AV); 
5024                 oplist = oplist->op_sibling;;
5025             }
5026
5027             if (SvRMAGICAL(av)) {
5028                 U32 i;
5029
5030                 Newx(array, maxarg, SV*);
5031                 SAVEFREEPV(array);
5032                 for (i=0; i < (U32)maxarg; i++) {
5033                     SV ** const svp = av_fetch(av, i, FALSE);
5034                     array[i] = svp ? *svp : &PL_sv_undef;
5035                 }
5036             }
5037             else
5038                 array = AvARRAY(av);
5039
5040             pat = S_concat_pat(aTHX_ pRExC_state, pat,
5041                                 array, maxarg, NULL, recompile_p,
5042                                 /* $" */
5043                                 GvSV((gv_fetchpvs("\"", GV_ADDMULTI, SVt_PV))));
5044
5045             continue;
5046         }
5047
5048
5049         /* we make the assumption here that each op in the list of
5050          * op_siblings maps to one SV pushed onto the stack,
5051          * except for code blocks, with have both an OP_NULL and
5052          * and OP_CONST.
5053          * This allows us to match up the list of SVs against the
5054          * list of OPs to find the next code block.
5055          *
5056          * Note that       PUSHMARK PADSV PADSV ..
5057          * is optimised to
5058          *                 PADRANGE PADSV  PADSV  ..
5059          * so the alignment still works. */
5060
5061         if (oplist) {
5062             if (oplist->op_type == OP_NULL
5063                 && (oplist->op_flags & OPf_SPECIAL))
5064             {
5065                 assert(n < pRExC_state->num_code_blocks);
5066                 pRExC_state->code_blocks[n].start = pat ? SvCUR(pat) : 0;
5067                 pRExC_state->code_blocks[n].block = oplist;
5068                 pRExC_state->code_blocks[n].src_regex = NULL;
5069                 n++;
5070                 code = 1;
5071                 oplist = oplist->op_sibling; /* skip CONST */
5072                 assert(oplist);
5073             }
5074             oplist = oplist->op_sibling;;
5075         }
5076
5077         /* apply magic and QR overloading to arg */
5078
5079         SvGETMAGIC(msv);
5080         if (SvROK(msv) && SvAMAGIC(msv)) {
5081             SV *sv = AMG_CALLunary(msv, regexp_amg);
5082             if (sv) {
5083                 if (SvROK(sv))
5084                     sv = SvRV(sv);
5085                 if (SvTYPE(sv) != SVt_REGEXP)
5086                     Perl_croak(aTHX_ "Overloaded qr did not return a REGEXP");
5087                 msv = sv;
5088             }
5089         }
5090
5091         /* try concatenation overload ... */
5092         if (pat && (SvAMAGIC(pat) || SvAMAGIC(msv)) &&
5093                 (sv = amagic_call(pat, msv, concat_amg, AMGf_assign)))
5094         {
5095             sv_setsv(pat, sv);
5096             /* overloading involved: all bets are off over literal
5097              * code. Pretend we haven't seen it */
5098             pRExC_state->num_code_blocks -= n;
5099             n = 0;
5100         }
5101         else  {
5102             /* ... or failing that, try "" overload */
5103             while (SvAMAGIC(msv)
5104                     && (sv = AMG_CALLunary(msv, string_amg))
5105                     && sv != msv
5106                     &&  !(   SvROK(msv)
5107                           && SvROK(sv)
5108                           && SvRV(msv) == SvRV(sv))
5109             ) {
5110                 msv = sv;
5111                 SvGETMAGIC(msv);
5112             }
5113             if (SvROK(msv) && SvTYPE(SvRV(msv)) == SVt_REGEXP)
5114                 msv = SvRV(msv);
5115
5116             if (pat) {
5117                 /* this is a partially unrolled
5118                  *     sv_catsv_nomg(pat, msv);
5119                  * that allows us to adjust code block indices if
5120                  * needed */
5121                 STRLEN dlen;
5122                 char *dst = SvPV_force_nomg(pat, dlen);
5123                 orig_patlen = dlen;
5124                 if (SvUTF8(msv) && !SvUTF8(pat)) {
5125                     S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &dst, &dlen, n);
5126                     sv_setpvn(pat, dst, dlen);
5127                     SvUTF8_on(pat);
5128                 }
5129                 sv_catsv_nomg(pat, msv);
5130                 rx = msv;
5131             }
5132             else
5133                 pat = msv;
5134
5135             if (code)
5136                 pRExC_state->code_blocks[n-1].end = SvCUR(pat)-1;
5137         }
5138
5139         /* extract any code blocks within any embedded qr//'s */
5140         if (rx && SvTYPE(rx) == SVt_REGEXP
5141             && RX_ENGINE((REGEXP*)rx)->op_comp)
5142         {
5143
5144             RXi_GET_DECL(ReANY((REGEXP *)rx), ri);
5145             if (ri->num_code_blocks) {
5146                 int i;
5147                 /* the presence of an embedded qr// with code means
5148                  * we should always recompile: the text of the
5149                  * qr// may not have changed, but it may be a
5150                  * different closure than last time */
5151                 *recompile_p = 1;
5152                 Renew(pRExC_state->code_blocks,
5153                     pRExC_state->num_code_blocks + ri->num_code_blocks,
5154                     struct reg_code_block);
5155                 pRExC_state->num_code_blocks += ri->num_code_blocks;
5156
5157                 for (i=0; i < ri->num_code_blocks; i++) {
5158                     struct reg_code_block *src, *dst;
5159                     STRLEN offset =  orig_patlen
5160                         + ReANY((REGEXP *)rx)->pre_prefix;
5161                     assert(n < pRExC_state->num_code_blocks);
5162                     src = &ri->code_blocks[i];
5163                     dst = &pRExC_state->code_blocks[n];
5164                     dst->start      = src->start + offset;
5165                     dst->end        = src->end   + offset;
5166                     dst->block      = src->block;
5167                     dst->src_regex  = (REGEXP*) SvREFCNT_inc( (SV*)
5168                                             src->src_regex
5169                                                 ? src->src_regex
5170                                                 : (REGEXP*)rx);
5171                     n++;
5172                 }
5173             }
5174         }
5175     }
5176     /* avoid calling magic multiple times on a single element e.g. =~ $qr */
5177     if (alloced)
5178         SvSETMAGIC(pat);
5179
5180     return pat;
5181 }
5182
5183
5184
5185 /* see if there are any run-time code blocks in the pattern.
5186  * False positives are allowed */
5187
5188 static bool
5189 S_has_runtime_code(pTHX_ RExC_state_t * const pRExC_state,
5190                     char *pat, STRLEN plen)
5191 {
5192     int n = 0;
5193     STRLEN s;
5194
5195     for (s = 0; s < plen; s++) {
5196         if (n < pRExC_state->num_code_blocks
5197             && s == pRExC_state->code_blocks[n].start)
5198         {
5199             s = pRExC_state->code_blocks[n].end;
5200             n++;
5201             continue;
5202         }
5203         /* TODO ideally should handle [..], (#..), /#.../x to reduce false
5204          * positives here */
5205         if (pat[s] == '(' && s+2 <= plen && pat[s+1] == '?' &&
5206             (pat[s+2] == '{'
5207                 || (s + 2 <= plen && pat[s+2] == '?' && pat[s+3] == '{'))
5208         )
5209             return 1;
5210     }
5211     return 0;
5212 }
5213
5214 /* Handle run-time code blocks. We will already have compiled any direct
5215  * or indirect literal code blocks. Now, take the pattern 'pat' and make a
5216  * copy of it, but with any literal code blocks blanked out and
5217  * appropriate chars escaped; then feed it into
5218  *
5219  *    eval "qr'modified_pattern'"
5220  *
5221  * For example,
5222  *
5223  *       a\bc(?{"this was literal"})def'ghi\\jkl(?{"this is runtime"})mno
5224  *
5225  * becomes
5226  *
5227  *    qr'a\\bc_______________________def\'ghi\\\\jkl(?{"this is runtime"})mno'
5228  *
5229  * After eval_sv()-ing that, grab any new code blocks from the returned qr
5230  * and merge them with any code blocks of the original regexp.
5231  *
5232  * If the pat is non-UTF8, while the evalled qr is UTF8, don't merge;
5233  * instead, just save the qr and return FALSE; this tells our caller that
5234  * the original pattern needs upgrading to utf8.
5235  */
5236
5237 static bool
5238 S_compile_runtime_code(pTHX_ RExC_state_t * const pRExC_state,
5239     char *pat, STRLEN plen)
5240 {
5241     SV *qr;
5242
5243     GET_RE_DEBUG_FLAGS_DECL;
5244
5245     if (pRExC_state->runtime_code_qr) {
5246         /* this is the second time we've been called; this should
5247          * only happen if the main pattern got upgraded to utf8
5248          * during compilation; re-use the qr we compiled first time
5249          * round (which should be utf8 too)
5250          */
5251         qr = pRExC_state->runtime_code_qr;
5252         pRExC_state->runtime_code_qr = NULL;
5253         assert(RExC_utf8 && SvUTF8(qr));
5254     }
5255     else {
5256         int n = 0;
5257         STRLEN s;
5258         char *p, *newpat;
5259         int newlen = plen + 6; /* allow for "qr''x\0" extra chars */
5260         SV *sv, *qr_ref;
5261         dSP;
5262
5263         /* determine how many extra chars we need for ' and \ escaping */
5264         for (s = 0; s < plen; s++) {
5265             if (pat[s] == '\'' || pat[s] == '\\')
5266                 newlen++;
5267         }
5268
5269         Newx(newpat, newlen, char);
5270         p = newpat;
5271         *p++ = 'q'; *p++ = 'r'; *p++ = '\'';
5272
5273         for (s = 0; s < plen; s++) {
5274             if (n < pRExC_state->num_code_blocks
5275                 && s == pRExC_state->code_blocks[n].start)
5276             {
5277                 /* blank out literal code block */
5278                 assert(pat[s] == '(');
5279                 while (s <= pRExC_state->code_blocks[n].end) {
5280                     *p++ = '_';
5281                     s++;
5282                 }
5283                 s--;
5284                 n++;
5285                 continue;
5286             }
5287             if (pat[s] == '\'' || pat[s] == '\\')
5288                 *p++ = '\\';
5289             *p++ = pat[s];
5290         }
5291         *p++ = '\'';
5292         if (pRExC_state->pm_flags & RXf_PMf_EXTENDED)
5293             *p++ = 'x';
5294         *p++ = '\0';
5295         DEBUG_COMPILE_r({
5296             PerlIO_printf(Perl_debug_log,
5297                 "%sre-parsing pattern for runtime code:%s %s\n",
5298                 PL_colors[4],PL_colors[5],newpat);
5299         });
5300
5301         sv = newSVpvn_flags(newpat, p-newpat-1, RExC_utf8 ? SVf_UTF8 : 0);
5302         Safefree(newpat);
5303
5304         ENTER;
5305         SAVETMPS;
5306         save_re_context();
5307         PUSHSTACKi(PERLSI_REQUIRE);
5308         /* G_RE_REPARSING causes the toker to collapse \\ into \ when
5309          * parsing qr''; normally only q'' does this. It also alters
5310          * hints handling */
5311         eval_sv(sv, G_SCALAR|G_RE_REPARSING);
5312         SvREFCNT_dec_NN(sv);
5313         SPAGAIN;
5314         qr_ref = POPs;
5315         PUTBACK;
5316         {
5317             SV * const errsv = ERRSV;
5318             if (SvTRUE_NN(errsv))
5319             {
5320                 Safefree(pRExC_state->code_blocks);
5321                 /* use croak_sv ? */
5322                 Perl_croak_nocontext("%s", SvPV_nolen_const(errsv));
5323             }
5324         }
5325         assert(SvROK(qr_ref));
5326         qr = SvRV(qr_ref);
5327         assert(SvTYPE(qr) == SVt_REGEXP && RX_ENGINE((REGEXP*)qr)->op_comp);
5328         /* the leaving below frees the tmp qr_ref.
5329          * Give qr a life of its own */
5330         SvREFCNT_inc(qr);
5331         POPSTACK;
5332         FREETMPS;
5333         LEAVE;
5334
5335     }
5336
5337     if (!RExC_utf8 && SvUTF8(qr)) {
5338         /* first time through; the pattern got upgraded; save the
5339          * qr for the next time through */
5340         assert(!pRExC_state->runtime_code_qr);
5341         pRExC_state->runtime_code_qr = qr;
5342         return 0;
5343     }
5344
5345
5346     /* extract any code blocks within the returned qr//  */
5347
5348
5349     /* merge the main (r1) and run-time (r2) code blocks into one */
5350     {
5351         RXi_GET_DECL(ReANY((REGEXP *)qr), r2);
5352         struct reg_code_block *new_block, *dst;
5353         RExC_state_t * const r1 = pRExC_state; /* convenient alias */
5354         int i1 = 0, i2 = 0;
5355
5356         if (!r2->num_code_blocks) /* we guessed wrong */
5357         {
5358             SvREFCNT_dec_NN(qr);
5359             return 1;
5360         }
5361
5362         Newx(new_block,
5363             r1->num_code_blocks + r2->num_code_blocks,
5364             struct reg_code_block);
5365         dst = new_block;
5366
5367         while (    i1 < r1->num_code_blocks
5368                 || i2 < r2->num_code_blocks)
5369         {
5370             struct reg_code_block *src;
5371             bool is_qr = 0;
5372
5373             if (i1 == r1->num_code_blocks) {
5374                 src = &r2->code_blocks[i2++];
5375                 is_qr = 1;
5376             }
5377             else if (i2 == r2->num_code_blocks)
5378                 src = &r1->code_blocks[i1++];
5379             else if (  r1->code_blocks[i1].start
5380                      < r2->code_blocks[i2].start)
5381             {
5382                 src = &r1->code_blocks[i1++];
5383                 assert(src->end < r2->code_blocks[i2].start);
5384             }
5385             else {
5386                 assert(  r1->code_blocks[i1].start
5387                        > r2->code_blocks[i2].start);
5388                 src = &r2->code_blocks[i2++];
5389                 is_qr = 1;
5390                 assert(src->end < r1->code_blocks[i1].start);
5391             }
5392
5393             assert(pat[src->start] == '(');
5394             assert(pat[src->end]   == ')');
5395             dst->start      = src->start;
5396             dst->end        = src->end;
5397             dst->block      = src->block;
5398             dst->src_regex  = is_qr ? (REGEXP*) SvREFCNT_inc( (SV*) qr)
5399                                     : src->src_regex;
5400             dst++;
5401         }
5402         r1->num_code_blocks += r2->num_code_blocks;
5403         Safefree(r1->code_blocks);
5404         r1->code_blocks = new_block;
5405     }
5406
5407     SvREFCNT_dec_NN(qr);
5408     return 1;
5409 }
5410
5411
5412 STATIC bool
5413 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)
5414 {
5415     /* This is the common code for setting up the floating and fixed length
5416      * string data extracted from Perl_re_op_compile() below.  Returns a boolean
5417      * as to whether succeeded or not */
5418
5419     I32 t,ml;
5420
5421     if (! (longest_length
5422            || (eol /* Can't have SEOL and MULTI */
5423                && (! meol || (RExC_flags & RXf_PMf_MULTILINE)))
5424           )
5425             /* See comments for join_exact for why REG_SEEN_EXACTF_SHARP_S */
5426         || (RExC_seen & REG_SEEN_EXACTF_SHARP_S))
5427     {
5428         return FALSE;
5429     }
5430
5431     /* copy the information about the longest from the reg_scan_data
5432         over to the program. */
5433     if (SvUTF8(sv_longest)) {
5434         *rx_utf8 = sv_longest;
5435         *rx_substr = NULL;
5436     } else {
5437         *rx_substr = sv_longest;
5438         *rx_utf8 = NULL;
5439     }
5440     /* end_shift is how many chars that must be matched that
5441         follow this item. We calculate it ahead of time as once the
5442         lookbehind offset is added in we lose the ability to correctly
5443         calculate it.*/
5444     ml = minlen ? *(minlen) : (I32)longest_length;
5445     *rx_end_shift = ml - offset
5446         - longest_length + (SvTAIL(sv_longest) != 0)
5447         + lookbehind;
5448
5449     t = (eol/* Can't have SEOL and MULTI */
5450          && (! meol || (RExC_flags & RXf_PMf_MULTILINE)));
5451     fbm_compile(sv_longest, t ? FBMcf_TAIL : 0);
5452
5453     return TRUE;
5454 }
5455
5456 /*
5457  * Perl_re_op_compile - the perl internal RE engine's function to compile a
5458  * regular expression into internal code.
5459  * The pattern may be passed either as:
5460  *    a list of SVs (patternp plus pat_count)
5461  *    a list of OPs (expr)
5462  * If both are passed, the SV list is used, but the OP list indicates
5463  * which SVs are actually pre-compiled code blocks
5464  *
5465  * The SVs in the list have magic and qr overloading applied to them (and
5466  * the list may be modified in-place with replacement SVs in the latter
5467  * case).
5468  *
5469  * If the pattern hasn't changed from old_re, then old_re will be
5470  * returned.
5471  *
5472  * eng is the current engine. If that engine has an op_comp method, then
5473  * handle directly (i.e. we assume that op_comp was us); otherwise, just
5474  * do the initial concatenation of arguments and pass on to the external
5475  * engine.
5476  *
5477  * If is_bare_re is not null, set it to a boolean indicating whether the
5478  * arg list reduced (after overloading) to a single bare regex which has
5479  * been returned (i.e. /$qr/).
5480  *
5481  * orig_rx_flags contains RXf_* flags. See perlreapi.pod for more details.
5482  *
5483  * pm_flags contains the PMf_* flags, typically based on those from the
5484  * pm_flags field of the related PMOP. Currently we're only interested in
5485  * PMf_HAS_CV, PMf_IS_QR, PMf_USE_RE_EVAL.
5486  *
5487  * We can't allocate space until we know how big the compiled form will be,
5488  * but we can't compile it (and thus know how big it is) until we've got a
5489  * place to put the code.  So we cheat:  we compile it twice, once with code
5490  * generation turned off and size counting turned on, and once "for real".
5491  * This also means that we don't allocate space until we are sure that the
5492  * thing really will compile successfully, and we never have to move the
5493  * code and thus invalidate pointers into it.  (Note that it has to be in
5494  * one piece because free() must be able to free it all.) [NB: not true in perl]
5495  *
5496  * Beware that the optimization-preparation code in here knows about some
5497  * of the structure of the compiled regexp.  [I'll say.]
5498  */
5499
5500 REGEXP *
5501 Perl_re_op_compile(pTHX_ SV ** const patternp, int pat_count,
5502                     OP *expr, const regexp_engine* eng, REGEXP *old_re,
5503                      bool *is_bare_re, U32 orig_rx_flags, U32 pm_flags)
5504 {
5505     dVAR;
5506     REGEXP *rx;
5507     struct regexp *r;
5508     regexp_internal *ri;
5509     STRLEN plen;
5510     char *exp;
5511     regnode *scan;
5512     I32 flags;
5513     I32 minlen = 0;
5514     U32 rx_flags;
5515     SV *pat;
5516     SV *code_blocksv = NULL;
5517     SV** new_patternp = patternp;
5518
5519     /* these are all flags - maybe they should be turned
5520      * into a single int with different bit masks */
5521     I32 sawlookahead = 0;
5522     I32 sawplus = 0;
5523     I32 sawopen = 0;
5524     I32 sawminmod = 0;
5525
5526     regex_charset initial_charset = get_regex_charset(orig_rx_flags);
5527     bool recompile = 0;
5528     bool runtime_code = 0;
5529     scan_data_t data;
5530     RExC_state_t RExC_state;
5531     RExC_state_t * const pRExC_state = &RExC_state;
5532 #ifdef TRIE_STUDY_OPT    
5533     int restudied = 0;
5534     RExC_state_t copyRExC_state;
5535 #endif    
5536     GET_RE_DEBUG_FLAGS_DECL;
5537
5538     PERL_ARGS_ASSERT_RE_OP_COMPILE;
5539
5540     DEBUG_r(if (!PL_colorset) reginitcolors());
5541
5542 #ifndef PERL_IN_XSUB_RE
5543     /* Initialize these here instead of as-needed, as is quick and avoids
5544      * having to test them each time otherwise */
5545     if (! PL_AboveLatin1) {
5546         PL_AboveLatin1 = _new_invlist_C_array(AboveLatin1_invlist);
5547         PL_ASCII = _new_invlist_C_array(ASCII_invlist);
5548         PL_Latin1 = _new_invlist_C_array(Latin1_invlist);
5549
5550         PL_L1Posix_ptrs[_CC_ALPHANUMERIC]
5551                                 = _new_invlist_C_array(L1PosixAlnum_invlist);
5552         PL_Posix_ptrs[_CC_ALPHANUMERIC]
5553                                 = _new_invlist_C_array(PosixAlnum_invlist);
5554
5555         PL_L1Posix_ptrs[_CC_ALPHA]
5556                                 = _new_invlist_C_array(L1PosixAlpha_invlist);
5557         PL_Posix_ptrs[_CC_ALPHA] = _new_invlist_C_array(PosixAlpha_invlist);
5558
5559         PL_Posix_ptrs[_CC_BLANK] = _new_invlist_C_array(PosixBlank_invlist);
5560         PL_XPosix_ptrs[_CC_BLANK] = _new_invlist_C_array(XPosixBlank_invlist);
5561
5562         /* Cased is the same as Alpha in the ASCII range */
5563         PL_L1Posix_ptrs[_CC_CASED] =  _new_invlist_C_array(L1Cased_invlist);
5564         PL_Posix_ptrs[_CC_CASED] =  _new_invlist_C_array(PosixAlpha_invlist);
5565
5566         PL_Posix_ptrs[_CC_CNTRL] = _new_invlist_C_array(PosixCntrl_invlist);
5567         PL_XPosix_ptrs[_CC_CNTRL] = _new_invlist_C_array(XPosixCntrl_invlist);
5568
5569         PL_Posix_ptrs[_CC_DIGIT] = _new_invlist_C_array(PosixDigit_invlist);
5570         PL_L1Posix_ptrs[_CC_DIGIT] = _new_invlist_C_array(PosixDigit_invlist);
5571
5572         PL_L1Posix_ptrs[_CC_GRAPH] = _new_invlist_C_array(L1PosixGraph_invlist);
5573         PL_Posix_ptrs[_CC_GRAPH] = _new_invlist_C_array(PosixGraph_invlist);
5574
5575         PL_L1Posix_ptrs[_CC_LOWER] = _new_invlist_C_array(L1PosixLower_invlist);
5576         PL_Posix_ptrs[_CC_LOWER] = _new_invlist_C_array(PosixLower_invlist);
5577
5578         PL_L1Posix_ptrs[_CC_PRINT] = _new_invlist_C_array(L1PosixPrint_invlist);
5579         PL_Posix_ptrs[_CC_PRINT] = _new_invlist_C_array(PosixPrint_invlist);
5580
5581         PL_L1Posix_ptrs[_CC_PUNCT] = _new_invlist_C_array(L1PosixPunct_invlist);
5582         PL_Posix_ptrs[_CC_PUNCT] = _new_invlist_C_array(PosixPunct_invlist);
5583
5584         PL_Posix_ptrs[_CC_SPACE] = _new_invlist_C_array(PerlSpace_invlist);
5585         PL_XPosix_ptrs[_CC_SPACE] = _new_invlist_C_array(XPerlSpace_invlist);
5586         PL_Posix_ptrs[_CC_PSXSPC] = _new_invlist_C_array(PosixSpace_invlist);
5587         PL_XPosix_ptrs[_CC_PSXSPC] = _new_invlist_C_array(XPosixSpace_invlist);
5588
5589         PL_L1Posix_ptrs[_CC_UPPER] = _new_invlist_C_array(L1PosixUpper_invlist);
5590         PL_Posix_ptrs[_CC_UPPER] = _new_invlist_C_array(PosixUpper_invlist);
5591
5592         PL_XPosix_ptrs[_CC_VERTSPACE] = _new_invlist_C_array(VertSpace_invlist);
5593
5594         PL_Posix_ptrs[_CC_WORDCHAR] = _new_invlist_C_array(PosixWord_invlist);
5595         PL_L1Posix_ptrs[_CC_WORDCHAR]
5596                                 = _new_invlist_C_array(L1PosixWord_invlist);
5597
5598         PL_Posix_ptrs[_CC_XDIGIT] = _new_invlist_C_array(PosixXDigit_invlist);
5599         PL_XPosix_ptrs[_CC_XDIGIT] = _new_invlist_C_array(XPosixXDigit_invlist);
5600
5601         PL_HasMultiCharFold = _new_invlist_C_array(_Perl_Multi_Char_Folds_invlist);
5602     }
5603 #endif
5604
5605     pRExC_state->code_blocks = NULL;
5606     pRExC_state->num_code_blocks = 0;
5607
5608     if (is_bare_re)
5609         *is_bare_re = FALSE;
5610
5611     if (expr && (expr->op_type == OP_LIST ||
5612                 (expr->op_type == OP_NULL && expr->op_targ == OP_LIST))) {
5613         /* allocate code_blocks if needed */
5614         OP *o;
5615         int ncode = 0;
5616
5617         for (o = cLISTOPx(expr)->op_first; o; o = o->op_sibling)
5618             if (o->op_type == OP_NULL && (o->op_flags & OPf_SPECIAL))
5619                 ncode++; /* count of DO blocks */
5620         if (ncode) {
5621             pRExC_state->num_code_blocks = ncode;
5622             Newx(pRExC_state->code_blocks, ncode, struct reg_code_block);
5623         }
5624     }
5625
5626     if (!pat_count) {
5627         /* compile-time pattern with just OP_CONSTs and DO blocks */
5628
5629         int n;
5630         OP *o;
5631
5632         /* find how many CONSTs there are */
5633         assert(expr);
5634         n = 0;
5635         if (expr->op_type == OP_CONST)
5636             n = 1;
5637         else
5638             for (o = cLISTOPx(expr)->op_first; o; o = o->op_sibling) {
5639                 if (o->op_type == OP_CONST)
5640                     n++;
5641             }
5642
5643         /* fake up an SV array */
5644
5645         assert(!new_patternp);
5646         Newx(new_patternp, n, SV*);
5647         SAVEFREEPV(new_patternp);
5648         pat_count = n;
5649
5650         n = 0;
5651         if (expr->op_type == OP_CONST)
5652             new_patternp[n] = cSVOPx_sv(expr);
5653         else
5654             for (o = cLISTOPx(expr)->op_first; o; o = o->op_sibling) {
5655                 if (o->op_type == OP_CONST)
5656                     new_patternp[n++] = cSVOPo_sv;
5657             }
5658
5659     }
5660
5661     DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log,
5662         "Assembling pattern from %d elements%s\n", pat_count,
5663             orig_rx_flags & RXf_SPLIT ? " for split" : ""));
5664
5665     /* set expr to the first arg op */
5666
5667     if (pRExC_state->num_code_blocks
5668          && expr->op_type != OP_CONST)
5669     {
5670             expr = cLISTOPx(expr)->op_first;
5671             assert(   expr->op_type == OP_PUSHMARK
5672                    || (expr->op_type == OP_NULL && expr->op_targ == OP_PUSHMARK)
5673                    || expr->op_type == OP_PADRANGE);
5674             expr = expr->op_sibling;
5675     }
5676
5677     pat = S_concat_pat(aTHX_ pRExC_state, NULL, new_patternp, pat_count,
5678                         expr, &recompile, NULL);
5679
5680     /* handle bare (possibly after overloading) regex: foo =~ $re */
5681     {
5682         SV *re = pat;
5683         if (SvROK(re))
5684             re = SvRV(re);
5685         if (SvTYPE(re) == SVt_REGEXP) {
5686             if (is_bare_re)
5687                 *is_bare_re = TRUE;
5688             SvREFCNT_inc(re);
5689             Safefree(pRExC_state->code_blocks);
5690             DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log,
5691                 "Precompiled pattern%s\n",
5692                     orig_rx_flags & RXf_SPLIT ? " for split" : ""));
5693
5694             return (REGEXP*)re;
5695         }
5696     }
5697
5698     exp = SvPV_nomg(pat, plen);
5699
5700     if (!eng->op_comp) {
5701         if ((SvUTF8(pat) && IN_BYTES)
5702                 || SvGMAGICAL(pat) || SvAMAGIC(pat))
5703         {
5704             /* make a temporary copy; either to convert to bytes,
5705              * or to avoid repeating get-magic / overloaded stringify */
5706             pat = newSVpvn_flags(exp, plen, SVs_TEMP |
5707                                         (IN_BYTES ? 0 : SvUTF8(pat)));
5708         }
5709         Safefree(pRExC_state->code_blocks);
5710         return CALLREGCOMP_ENG(eng, pat, orig_rx_flags);
5711     }
5712
5713     /* ignore the utf8ness if the pattern is 0 length */
5714     RExC_utf8 = RExC_orig_utf8 = (plen == 0 || IN_BYTES) ? 0 : SvUTF8(pat);
5715     RExC_uni_semantics = 0;
5716     RExC_contains_locale = 0;
5717     pRExC_state->runtime_code_qr = NULL;
5718
5719     DEBUG_COMPILE_r({
5720             SV *dsv= sv_newmortal();
5721             RE_PV_QUOTED_DECL(s, RExC_utf8, dsv, exp, plen, 60);
5722             PerlIO_printf(Perl_debug_log, "%sCompiling REx%s %s\n",
5723                           PL_colors[4],PL_colors[5],s);
5724         });
5725
5726   redo_first_pass:
5727     /* we jump here if we upgrade the pattern to utf8 and have to
5728      * recompile */
5729
5730     if ((pm_flags & PMf_USE_RE_EVAL)
5731                 /* this second condition covers the non-regex literal case,
5732                  * i.e.  $foo =~ '(?{})'. */
5733                 || (IN_PERL_COMPILETIME && (PL_hints & HINT_RE_EVAL))
5734     )
5735         runtime_code = S_has_runtime_code(aTHX_ pRExC_state, exp, plen);
5736
5737     /* return old regex if pattern hasn't changed */
5738     /* XXX: note in the below we have to check the flags as well as the pattern.
5739      *
5740      * Things get a touch tricky as we have to compare the utf8 flag independently
5741      * from the compile flags.
5742      */
5743
5744     if (   old_re
5745         && !recompile
5746         && !!RX_UTF8(old_re) == !!RExC_utf8
5747         && ( RX_COMPFLAGS(old_re) == ( orig_rx_flags & RXf_PMf_FLAGCOPYMASK ) )
5748         && RX_PRECOMP(old_re)
5749         && RX_PRELEN(old_re) == plen
5750         && memEQ(RX_PRECOMP(old_re), exp, plen)
5751         && !runtime_code /* with runtime code, always recompile */ )
5752     {
5753         Safefree(pRExC_state->code_blocks);
5754         return old_re;
5755     }
5756
5757     rx_flags = orig_rx_flags;
5758
5759     if (initial_charset == REGEX_LOCALE_CHARSET) {
5760         RExC_contains_locale = 1;
5761     }
5762     else if (RExC_utf8 && initial_charset == REGEX_DEPENDS_CHARSET) {
5763
5764         /* Set to use unicode semantics if the pattern is in utf8 and has the
5765          * 'depends' charset specified, as it means unicode when utf8  */
5766         set_regex_charset(&rx_flags, REGEX_UNICODE_CHARSET);
5767     }
5768
5769     RExC_precomp = exp;
5770     RExC_flags = rx_flags;
5771     RExC_pm_flags = pm_flags;
5772
5773     if (runtime_code) {
5774         if (TAINTING_get && TAINT_get)
5775             Perl_croak(aTHX_ "Eval-group in insecure regular expression");
5776
5777         if (!S_compile_runtime_code(aTHX_ pRExC_state, exp, plen)) {
5778             /* whoops, we have a non-utf8 pattern, whilst run-time code
5779              * got compiled as utf8. Try again with a utf8 pattern */
5780             S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &exp, &plen,
5781                                     pRExC_state->num_code_blocks);
5782             goto redo_first_pass;
5783         }
5784     }
5785     assert(!pRExC_state->runtime_code_qr);
5786
5787     RExC_sawback = 0;
5788
5789     RExC_seen = 0;
5790     RExC_in_lookbehind = 0;
5791     RExC_seen_zerolen = *exp == '^' ? -1 : 0;
5792     RExC_extralen = 0;
5793     RExC_override_recoding = 0;
5794     RExC_in_multi_char_class = 0;
5795
5796     /* First pass: determine size, legality. */
5797     RExC_parse = exp;
5798     RExC_start = exp;
5799     RExC_end = exp + plen;
5800     RExC_naughty = 0;
5801     RExC_npar = 1;
5802     RExC_nestroot = 0;
5803     RExC_size = 0L;
5804     RExC_emit = &RExC_emit_dummy;
5805     RExC_whilem_seen = 0;
5806     RExC_open_parens = NULL;
5807     RExC_close_parens = NULL;
5808     RExC_opend = NULL;
5809     RExC_paren_names = NULL;
5810 #ifdef DEBUGGING
5811     RExC_paren_name_list = NULL;
5812 #endif
5813     RExC_recurse = NULL;
5814     RExC_recurse_count = 0;
5815     pRExC_state->code_index = 0;
5816
5817 #if 0 /* REGC() is (currently) a NOP at the first pass.
5818        * Clever compilers notice this and complain. --jhi */
5819     REGC((U8)REG_MAGIC, (char*)RExC_emit);
5820 #endif
5821     DEBUG_PARSE_r(
5822         PerlIO_printf(Perl_debug_log, "Starting first pass (sizing)\n");
5823         RExC_lastnum=0;
5824         RExC_lastparse=NULL;
5825     );
5826     /* reg may croak on us, not giving us a chance to free
5827        pRExC_state->code_blocks.  We cannot SAVEFREEPV it now, as we may
5828        need it to survive as long as the regexp (qr/(?{})/).
5829        We must check that code_blocksv is not already set, because we may
5830        have jumped back to restart the sizing pass. */
5831     if (pRExC_state->code_blocks && !code_blocksv) {
5832         code_blocksv = newSV_type(SVt_PV);
5833         SAVEFREESV(code_blocksv);
5834         SvPV_set(code_blocksv, (char *)pRExC_state->code_blocks);
5835         SvLEN_set(code_blocksv, 1); /*sufficient to make sv_clear free it*/
5836     }
5837     if (reg(pRExC_state, 0, &flags,1) == NULL) {
5838         /* It's possible to write a regexp in ascii that represents Unicode
5839         codepoints outside of the byte range, such as via \x{100}. If we
5840         detect such a sequence we have to convert the entire pattern to utf8
5841         and then recompile, as our sizing calculation will have been based
5842         on 1 byte == 1 character, but we will need to use utf8 to encode
5843         at least some part of the pattern, and therefore must convert the whole
5844         thing.
5845         -- dmq */
5846         if (flags & RESTART_UTF8) {
5847             S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &exp, &plen,
5848                                     pRExC_state->num_code_blocks);
5849             goto redo_first_pass;
5850         }
5851         Perl_croak(aTHX_ "panic: reg returned NULL to re_op_compile for sizing pass, flags=%#"UVxf"", (UV) flags);
5852     }
5853     if (code_blocksv)
5854         SvLEN_set(code_blocksv,0); /* no you can't have it, sv_clear */
5855
5856     DEBUG_PARSE_r({
5857         PerlIO_printf(Perl_debug_log, 
5858             "Required size %"IVdf" nodes\n"
5859             "Starting second pass (creation)\n", 
5860             (IV)RExC_size);
5861         RExC_lastnum=0; 
5862         RExC_lastparse=NULL; 
5863     });
5864
5865     /* The first pass could have found things that force Unicode semantics */
5866     if ((RExC_utf8 || RExC_uni_semantics)
5867          && get_regex_charset(rx_flags) == REGEX_DEPENDS_CHARSET)
5868     {
5869         set_regex_charset(&rx_flags, REGEX_UNICODE_CHARSET);
5870     }
5871
5872     /* Small enough for pointer-storage convention?
5873        If extralen==0, this means that we will not need long jumps. */
5874     if (RExC_size >= 0x10000L && RExC_extralen)
5875         RExC_size += RExC_extralen;
5876     else
5877         RExC_extralen = 0;
5878     if (RExC_whilem_seen > 15)
5879         RExC_whilem_seen = 15;
5880
5881     /* Allocate space and zero-initialize. Note, the two step process 
5882        of zeroing when in debug mode, thus anything assigned has to 
5883        happen after that */
5884     rx = (REGEXP*) newSV_type(SVt_REGEXP);
5885     r = ReANY(rx);
5886     Newxc(ri, sizeof(regexp_internal) + (unsigned)RExC_size * sizeof(regnode),
5887          char, regexp_internal);
5888     if ( r == NULL || ri == NULL )
5889         FAIL("Regexp out of space");
5890 #ifdef DEBUGGING
5891     /* avoid reading uninitialized memory in DEBUGGING code in study_chunk() */
5892     Zero(ri, sizeof(regexp_internal) + (unsigned)RExC_size * sizeof(regnode), char);
5893 #else 
5894     /* bulk initialize base fields with 0. */
5895     Zero(ri, sizeof(regexp_internal), char);        
5896 #endif
5897
5898     /* non-zero initialization begins here */
5899     RXi_SET( r, ri );
5900     r->engine= eng;
5901     r->extflags = rx_flags;
5902     RXp_COMPFLAGS(r) = orig_rx_flags & RXf_PMf_FLAGCOPYMASK;
5903
5904     if (pm_flags & PMf_IS_QR) {
5905         ri->code_blocks = pRExC_state->code_blocks;
5906         ri->num_code_blocks = pRExC_state->num_code_blocks;
5907     }
5908     else
5909     {
5910         int n;
5911         for (n = 0; n < pRExC_state->num_code_blocks; n++)
5912             if (pRExC_state->code_blocks[n].src_regex)
5913                 SAVEFREESV(pRExC_state->code_blocks[n].src_regex);
5914         SAVEFREEPV(pRExC_state->code_blocks);
5915     }
5916
5917     {
5918         bool has_p     = ((r->extflags & RXf_PMf_KEEPCOPY) == RXf_PMf_KEEPCOPY);
5919         bool has_charset = (get_regex_charset(r->extflags) != REGEX_DEPENDS_CHARSET);
5920
5921         /* The caret is output if there are any defaults: if not all the STD
5922          * flags are set, or if no character set specifier is needed */
5923         bool has_default =
5924                     (((r->extflags & RXf_PMf_STD_PMMOD) != RXf_PMf_STD_PMMOD)
5925                     || ! has_charset);
5926         bool has_runon = ((RExC_seen & REG_SEEN_RUN_ON_COMMENT)==REG_SEEN_RUN_ON_COMMENT);
5927         U16 reganch = (U16)((r->extflags & RXf_PMf_STD_PMMOD)
5928                             >> RXf_PMf_STD_PMMOD_SHIFT);
5929         const char *fptr = STD_PAT_MODS;        /*"msix"*/
5930         char *p;
5931         /* Allocate for the worst case, which is all the std flags are turned
5932          * on.  If more precision is desired, we could do a population count of
5933          * the flags set.  This could be done with a small lookup table, or by
5934          * shifting, masking and adding, or even, when available, assembly
5935          * language for a machine-language population count.
5936          * We never output a minus, as all those are defaults, so are
5937          * covered by the caret */
5938         const STRLEN wraplen = plen + has_p + has_runon
5939             + has_default       /* If needs a caret */
5940
5941                 /* If needs a character set specifier */
5942             + ((has_charset) ? MAX_CHARSET_NAME_LENGTH : 0)
5943             + (sizeof(STD_PAT_MODS) - 1)
5944             + (sizeof("(?:)") - 1);
5945
5946         Newx(p, wraplen + 1, char); /* +1 for the ending NUL */
5947         r->xpv_len_u.xpvlenu_pv = p;
5948         if (RExC_utf8)
5949             SvFLAGS(rx) |= SVf_UTF8;
5950         *p++='('; *p++='?';
5951
5952         /* If a default, cover it using the caret */
5953         if (has_default) {
5954             *p++= DEFAULT_PAT_MOD;
5955         }
5956         if (has_charset) {
5957             STRLEN len;
5958             const char* const name = get_regex_charset_name(r->extflags, &len);
5959             Copy(name, p, len, char);
5960             p += len;
5961         }
5962         if (has_p)
5963             *p++ = KEEPCOPY_PAT_MOD; /*'p'*/
5964         {
5965             char ch;
5966             while((ch = *fptr++)) {
5967                 if(reganch & 1)
5968                     *p++ = ch;
5969                 reganch >>= 1;
5970             }
5971         }
5972
5973         *p++ = ':';
5974         Copy(RExC_precomp, p, plen, char);
5975         assert ((RX_WRAPPED(rx) - p) < 16);
5976         r->pre_prefix = p - RX_WRAPPED(rx);
5977         p += plen;
5978         if (has_runon)
5979             *p++ = '\n';
5980         *p++ = ')';
5981         *p = 0;
5982         SvCUR_set(rx, p - RX_WRAPPED(rx));
5983     }
5984
5985     r->intflags = 0;
5986     r->nparens = RExC_npar - 1; /* set early to validate backrefs */
5987     
5988     if (RExC_seen & REG_SEEN_RECURSE) {
5989         Newxz(RExC_open_parens, RExC_npar,regnode *);
5990         SAVEFREEPV(RExC_open_parens);
5991         Newxz(RExC_close_parens,RExC_npar,regnode *);
5992         SAVEFREEPV(RExC_close_parens);
5993     }
5994
5995     /* Useful during FAIL. */
5996 #ifdef RE_TRACK_PATTERN_OFFSETS
5997     Newxz(ri->u.offsets, 2*RExC_size+1, U32); /* MJD 20001228 */
5998     DEBUG_OFFSETS_r(PerlIO_printf(Perl_debug_log,
5999                           "%s %"UVuf" bytes for offset annotations.\n",
6000                           ri->u.offsets ? "Got" : "Couldn't get",
6001                           (UV)((2*RExC_size+1) * sizeof(U32))));
6002 #endif
6003     SetProgLen(ri,RExC_size);
6004     RExC_rx_sv = rx;
6005     RExC_rx = r;
6006     RExC_rxi = ri;
6007
6008     /* Second pass: emit code. */
6009     RExC_flags = rx_flags;      /* don't let top level (?i) bleed */
6010     RExC_pm_flags = pm_flags;
6011     RExC_parse = exp;
6012     RExC_end = exp + plen;
6013     RExC_naughty = 0;
6014     RExC_npar = 1;
6015     RExC_emit_start = ri->program;
6016     RExC_emit = ri->program;
6017     RExC_emit_bound = ri->program + RExC_size + 1;
6018     pRExC_state->code_index = 0;
6019
6020     REGC((U8)REG_MAGIC, (char*) RExC_emit++);
6021     if (reg(pRExC_state, 0, &flags,1) == NULL) {
6022         ReREFCNT_dec(rx);   
6023         Perl_croak(aTHX_ "panic: reg returned NULL to re_op_compile for generation pass, flags=%#"UVxf"", (UV) flags);
6024     }
6025     /* XXXX To minimize changes to RE engine we always allocate
6026        3-units-long substrs field. */
6027     Newx(r->substrs, 1, struct reg_substr_data);
6028     if (RExC_recurse_count) {
6029         Newxz(RExC_recurse,RExC_recurse_count,regnode *);
6030         SAVEFREEPV(RExC_recurse);
6031     }
6032
6033 reStudy:
6034     r->minlen = minlen = sawlookahead = sawplus = sawopen = sawminmod = 0;
6035     Zero(r->substrs, 1, struct reg_substr_data);
6036
6037 #ifdef TRIE_STUDY_OPT
6038     if (!restudied) {
6039         StructCopy(&zero_scan_data, &data, scan_data_t);
6040         copyRExC_state = RExC_state;
6041     } else {
6042         U32 seen=RExC_seen;
6043         DEBUG_OPTIMISE_r(PerlIO_printf(Perl_debug_log,"Restudying\n"));
6044         
6045         RExC_state = copyRExC_state;
6046         if (seen & REG_TOP_LEVEL_BRANCHES) 
6047             RExC_seen |= REG_TOP_LEVEL_BRANCHES;
6048         else
6049             RExC_seen &= ~REG_TOP_LEVEL_BRANCHES;
6050         StructCopy(&zero_scan_data, &data, scan_data_t);
6051     }
6052 #else
6053     StructCopy(&zero_scan_data, &data, scan_data_t);
6054 #endif    
6055
6056     /* Dig out information for optimizations. */
6057     r->extflags = RExC_flags; /* was pm_op */
6058     /*dmq: removed as part of de-PMOP: pm->op_pmflags = RExC_flags; */
6059  
6060     if (UTF)
6061         SvUTF8_on(rx);  /* Unicode in it? */
6062     ri->regstclass = NULL;
6063     if (RExC_naughty >= 10)     /* Probably an expensive pattern. */
6064         r->intflags |= PREGf_NAUGHTY;
6065     scan = ri->program + 1;             /* First BRANCH. */
6066
6067     /* testing for BRANCH here tells us whether there is "must appear"
6068        data in the pattern. If there is then we can use it for optimisations */
6069     if (!(RExC_seen & REG_TOP_LEVEL_BRANCHES)) { /*  Only one top-level choice. */
6070         I32 fake;
6071         STRLEN longest_float_length, longest_fixed_length;
6072         struct regnode_charclass_class ch_class; /* pointed to by data */
6073         int stclass_flag;
6074         I32 last_close = 0; /* pointed to by data */
6075         regnode *first= scan;
6076         regnode *first_next= regnext(first);
6077         /*
6078          * Skip introductions and multiplicators >= 1
6079          * so that we can extract the 'meat' of the pattern that must 
6080          * match in the large if() sequence following.
6081          * NOTE that EXACT is NOT covered here, as it is normally
6082          * picked up by the optimiser separately. 
6083          *
6084          * This is unfortunate as the optimiser isnt handling lookahead
6085          * properly currently.
6086          *
6087          */
6088         while ((OP(first) == OPEN && (sawopen = 1)) ||
6089                /* An OR of *one* alternative - should not happen now. */
6090             (OP(first) == BRANCH && OP(first_next) != BRANCH) ||
6091             /* for now we can't handle lookbehind IFMATCH*/
6092             (OP(first) == IFMATCH && !first->flags && (sawlookahead = 1)) ||
6093             (OP(first) == PLUS) ||
6094             (OP(first) == MINMOD) ||
6095                /* An {n,m} with n>0 */
6096             (PL_regkind[OP(first)] == CURLY && ARG1(first) > 0) ||
6097             (OP(first) == NOTHING && PL_regkind[OP(first_next)] != END ))
6098         {
6099                 /* 
6100                  * the only op that could be a regnode is PLUS, all the rest
6101                  * will be regnode_1 or regnode_2.
6102                  *
6103                  * (yves doesn't think this is true)
6104                  */
6105                 if (OP(first) == PLUS)
6106                     sawplus = 1;
6107                 else {
6108                     if (OP(first) == MINMOD)
6109                         sawminmod = 1;
6110                     first += regarglen[OP(first)];
6111                 }
6112                 first = NEXTOPER(first);
6113                 first_next= regnext(first);
6114         }
6115
6116         /* Starting-point info. */
6117       again:
6118         DEBUG_PEEP("first:",first,0);
6119         /* Ignore EXACT as we deal with it later. */
6120         if (PL_regkind[OP(first)] == EXACT) {
6121             if (OP(first) == EXACT)
6122                 NOOP;   /* Empty, get anchored substr later. */
6123             else
6124                 ri->regstclass = first;
6125         }
6126 #ifdef TRIE_STCLASS
6127         else if (PL_regkind[OP(first)] == TRIE &&
6128                 ((reg_trie_data *)ri->data->data[ ARG(first) ])->minlen>0) 
6129         {
6130             regnode *trie_op;
6131             /* this can happen only on restudy */
6132             if ( OP(first) == TRIE ) {
6133                 struct regnode_1 *trieop = (struct regnode_1 *)
6134                     PerlMemShared_calloc(1, sizeof(struct regnode_1));
6135                 StructCopy(first,trieop,struct regnode_1);
6136                 trie_op=(regnode *)trieop;
6137             } else {
6138                 struct regnode_charclass *trieop = (struct regnode_charclass *)
6139                     PerlMemShared_calloc(1, sizeof(struct regnode_charclass));
6140                 StructCopy(first,trieop,struct regnode_charclass);
6141                 trie_op=(regnode *)trieop;
6142             }
6143             OP(trie_op)+=2;
6144             make_trie_failtable(pRExC_state, (regnode *)first, trie_op, 0);
6145             ri->regstclass = trie_op;
6146         }
6147 #endif
6148         else if (REGNODE_SIMPLE(OP(first)))
6149             ri->regstclass = first;
6150         else if (PL_regkind[OP(first)] == BOUND ||
6151                  PL_regkind[OP(first)] == NBOUND)
6152             ri->regstclass = first;
6153         else if (PL_regkind[OP(first)] == BOL) {
6154             r->extflags |= (OP(first) == MBOL
6155                            ? RXf_ANCH_MBOL
6156                            : (OP(first) == SBOL
6157                               ? RXf_ANCH_SBOL
6158                               : RXf_ANCH_BOL));
6159             first = NEXTOPER(first);
6160             goto again;
6161         }
6162         else if (OP(first) == GPOS) {
6163             r->extflags |= RXf_ANCH_GPOS;
6164             first = NEXTOPER(first);
6165             goto again;
6166         }
6167         else if ((!sawopen || !RExC_sawback) &&
6168             (OP(first) == STAR &&
6169             PL_regkind[OP(NEXTOPER(first))] == REG_ANY) &&
6170             !(r->extflags & RXf_ANCH) && !pRExC_state->num_code_blocks)
6171         {
6172             /* turn .* into ^.* with an implied $*=1 */
6173             const int type =
6174                 (OP(NEXTOPER(first)) == REG_ANY)
6175                     ? RXf_ANCH_MBOL
6176                     : RXf_ANCH_SBOL;
6177             r->extflags |= type;
6178             r->intflags |= PREGf_IMPLICIT;
6179             first = NEXTOPER(first);
6180             goto again;
6181         }
6182         if (sawplus && !sawminmod && !sawlookahead && (!sawopen || !RExC_sawback)
6183             && !pRExC_state->num_code_blocks) /* May examine pos and $& */
6184             /* x+ must match at the 1st pos of run of x's */
6185             r->intflags |= PREGf_SKIP;
6186
6187         /* Scan is after the zeroth branch, first is atomic matcher. */
6188 #ifdef TRIE_STUDY_OPT
6189         DEBUG_PARSE_r(
6190             if (!restudied)
6191                 PerlIO_printf(Perl_debug_log, "first at %"IVdf"\n",
6192                               (IV)(first - scan + 1))
6193         );
6194 #else
6195         DEBUG_PARSE_r(
6196             PerlIO_printf(Perl_debug_log, "first at %"IVdf"\n",
6197                 (IV)(first - scan + 1))
6198         );
6199 #endif
6200
6201
6202         /*
6203         * If there's something expensive in the r.e., find the
6204         * longest literal string that must appear and make it the
6205         * regmust.  Resolve ties in favor of later strings, since
6206         * the regstart check works with the beginning of the r.e.
6207         * and avoiding duplication strengthens checking.  Not a
6208         * strong reason, but sufficient in the absence of others.
6209         * [Now we resolve ties in favor of the earlier string if
6210         * it happens that c_offset_min has been invalidated, since the
6211         * earlier string may buy us something the later one won't.]
6212         */
6213
6214         data.longest_fixed = newSVpvs("");
6215         data.longest_float = newSVpvs("");
6216         data.last_found = newSVpvs("");
6217         data.longest = &(data.longest_fixed);
6218         ENTER_with_name("study_chunk");
6219         SAVEFREESV(data.longest_fixed);
6220         SAVEFREESV(data.longest_float);
6221         SAVEFREESV(data.last_found);
6222         first = scan;
6223         if (!ri->regstclass) {
6224             cl_init(pRExC_state, &ch_class);
6225             data.start_class = &ch_class;
6226             stclass_flag = SCF_DO_STCLASS_AND;
6227         } else                          /* XXXX Check for BOUND? */
6228             stclass_flag = 0;
6229         data.last_closep = &last_close;
6230         
6231         minlen = study_chunk(pRExC_state, &first, &minlen, &fake, scan + RExC_size, /* Up to end */
6232             &data, -1, NULL, NULL,
6233             SCF_DO_SUBSTR | SCF_WHILEM_VISITED_POS | stclass_flag
6234                           | (restudied ? SCF_TRIE_DOING_RESTUDY : 0),
6235             0);
6236
6237
6238         CHECK_RESTUDY_GOTO_butfirst(LEAVE_with_name("study_chunk"));
6239
6240
6241         if ( RExC_npar == 1 && data.longest == &(data.longest_fixed)
6242              && data.last_start_min == 0 && data.last_end > 0
6243              && !RExC_seen_zerolen
6244              && !(RExC_seen & REG_SEEN_VERBARG)
6245              && !((RExC_seen & REG_SEEN_GPOS) || (r->extflags & RXf_ANCH_GPOS)))
6246             r->extflags |= RXf_CHECK_ALL;
6247         scan_commit(pRExC_state, &data,&minlen,0);
6248
6249         longest_float_length = CHR_SVLEN(data.longest_float);
6250
6251         if (! ((SvCUR(data.longest_fixed)  /* ok to leave SvCUR */
6252                    && data.offset_fixed == data.offset_float_min
6253                    && SvCUR(data.longest_fixed) == SvCUR(data.longest_float)))
6254             && S_setup_longest (aTHX_ pRExC_state,
6255                                     data.longest_float,
6256                                     &(r->float_utf8),
6257                                     &(r->float_substr),
6258                                     &(r->float_end_shift),
6259                                     data.lookbehind_float,
6260                                     data.offset_float_min,
6261                                     data.minlen_float,
6262                                     longest_float_length,
6263                                     cBOOL(data.flags & SF_FL_BEFORE_EOL),
6264                                     cBOOL(data.flags & SF_FL_BEFORE_MEOL)))
6265         {
6266             r->float_min_offset = data.offset_float_min - data.lookbehind_float;
6267             r->float_max_offset = data.offset_float_max;
6268             if (data.offset_float_max < I32_MAX) /* Don't offset infinity */
6269                 r->float_max_offset -= data.lookbehind_float;
6270             SvREFCNT_inc_simple_void_NN(data.longest_float);
6271         }
6272         else {
6273             r->float_substr = r->float_utf8 = NULL;
6274             longest_float_length = 0;
6275         }
6276
6277         longest_fixed_length = CHR_SVLEN(data.longest_fixed);
6278
6279         if (S_setup_longest (aTHX_ pRExC_state,
6280                                 data.longest_fixed,
6281                                 &(r->anchored_utf8),
6282                                 &(r->anchored_substr),
6283                                 &(r->anchored_end_shift),
6284                                 data.lookbehind_fixed,
6285                                 data.offset_fixed,
6286                                 data.minlen_fixed,
6287                                 longest_fixed_length,
6288                                 cBOOL(data.flags & SF_FIX_BEFORE_EOL),
6289                                 cBOOL(data.flags & SF_FIX_BEFORE_MEOL)))
6290         {
6291             r->anchored_offset = data.offset_fixed - data.lookbehind_fixed;
6292             SvREFCNT_inc_simple_void_NN(data.longest_fixed);
6293         }
6294         else {
6295             r->anchored_substr = r->anchored_utf8 = NULL;
6296             longest_fixed_length = 0;
6297         }
6298         LEAVE_with_name("study_chunk");
6299
6300         if (ri->regstclass
6301             && (OP(ri->regstclass) == REG_ANY || OP(ri->regstclass) == SANY))
6302             ri->regstclass = NULL;
6303
6304         if ((!(r->anchored_substr || r->anchored_utf8) || r->anchored_offset)
6305             && stclass_flag
6306             && ! TEST_SSC_EOS(data.start_class)
6307             && !cl_is_anything(data.start_class))
6308         {
6309             const U32 n = add_data(pRExC_state, 1, "f");
6310             OP(data.start_class) = ANYOF_SYNTHETIC;
6311
6312             Newx(RExC_rxi->data->data[n], 1,
6313                 struct regnode_charclass_class);
6314             StructCopy(data.start_class,
6315                        (struct regnode_charclass_class*)RExC_rxi->data->data[n],
6316                        struct regnode_charclass_class);
6317             ri->regstclass = (regnode*)RExC_rxi->data->data[n];
6318             r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
6319             DEBUG_COMPILE_r({ SV *sv = sv_newmortal();
6320                       regprop(r, sv, (regnode*)data.start_class);
6321                       PerlIO_printf(Perl_debug_log,
6322                                     "synthetic stclass \"%s\".\n",
6323                                     SvPVX_const(sv));});
6324         }
6325
6326         /* A temporary algorithm prefers floated substr to fixed one to dig more info. */
6327         if (longest_fixed_length > longest_float_length) {
6328             r->check_end_shift = r->anchored_end_shift;
6329             r->check_substr = r->anchored_substr;
6330             r->check_utf8 = r->anchored_utf8;
6331             r->check_offset_min = r->check_offset_max = r->anchored_offset;
6332             if (r->extflags & RXf_ANCH_SINGLE)
6333                 r->extflags |= RXf_NOSCAN;
6334         }
6335         else {
6336             r->check_end_shift = r->float_end_shift;
6337             r->check_substr = r->float_substr;
6338             r->check_utf8 = r->float_utf8;
6339             r->check_offset_min = r->float_min_offset;
6340             r->check_offset_max = r->float_max_offset;
6341         }
6342         if ((r->check_substr || r->check_utf8) ) {
6343             r->extflags |= RXf_USE_INTUIT;
6344             if (SvTAIL(r->check_substr ? r->check_substr : r->check_utf8))
6345                 r->extflags |= RXf_INTUIT_TAIL;
6346         }
6347         /* XXX Unneeded? dmq (shouldn't as this is handled elsewhere)
6348         if ( (STRLEN)minlen < longest_float_length )
6349             minlen= longest_float_length;
6350         if ( (STRLEN)minlen < longest_fixed_length )
6351             minlen= longest_fixed_length;     
6352         */
6353     }
6354     else {
6355         /* Several toplevels. Best we can is to set minlen. */
6356         I32 fake;
6357         struct regnode_charclass_class ch_class;
6358         I32 last_close = 0;
6359
6360         DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log, "\nMulti Top Level\n"));
6361
6362         scan = ri->program + 1;
6363         cl_init(pRExC_state, &ch_class);
6364         data.start_class = &ch_class;
6365         data.last_closep = &last_close;
6366
6367         
6368         minlen = study_chunk(pRExC_state, &scan, &minlen, &fake, scan + RExC_size,
6369             &data, -1, NULL, NULL,
6370             SCF_DO_STCLASS_AND|SCF_WHILEM_VISITED_POS
6371                               |(restudied ? SCF_TRIE_DOING_RESTUDY : 0),
6372             0);
6373         
6374         CHECK_RESTUDY_GOTO_butfirst(NOOP);
6375
6376         r->check_substr = r->check_utf8 = r->anchored_substr = r->anchored_utf8
6377                 = r->float_substr = r->float_utf8 = NULL;
6378
6379         if (! TEST_SSC_EOS(data.start_class)
6380             && !cl_is_anything(data.start_class))
6381         {
6382             const U32 n = add_data(pRExC_state, 1, "f");
6383             OP(data.start_class) = ANYOF_SYNTHETIC;
6384
6385             Newx(RExC_rxi->data->data[n], 1,
6386                 struct regnode_charclass_class);
6387             StructCopy(data.start_class,
6388                        (struct regnode_charclass_class*)RExC_rxi->data->data[n],
6389                        struct regnode_charclass_class);
6390             ri->regstclass = (regnode*)RExC_rxi->data->data[n];
6391             r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
6392             DEBUG_COMPILE_r({ SV* sv = sv_newmortal();
6393                       regprop(r, sv, (regnode*)data.start_class);
6394                       PerlIO_printf(Perl_debug_log,
6395                                     "synthetic stclass \"%s\".\n",
6396                                     SvPVX_const(sv));});
6397         }
6398     }
6399
6400     /* Guard against an embedded (?=) or (?<=) with a longer minlen than
6401        the "real" pattern. */
6402     DEBUG_OPTIMISE_r({
6403         PerlIO_printf(Perl_debug_log,"minlen: %"IVdf" r->minlen:%"IVdf"\n",
6404                       (IV)minlen, (IV)r->minlen);
6405     });
6406     r->minlenret = minlen;
6407     if (r->minlen < minlen) 
6408         r->minlen = minlen;
6409     
6410     if (RExC_seen & REG_SEEN_GPOS)
6411         r->extflags |= RXf_GPOS_SEEN;
6412     if (RExC_seen & REG_SEEN_LOOKBEHIND)
6413         r->extflags |= RXf_NO_INPLACE_SUBST; /* inplace might break the lookbehind */
6414     if (pRExC_state->num_code_blocks)
6415         r->extflags |= RXf_EVAL_SEEN;
6416     if (RExC_seen & REG_SEEN_CANY)
6417         r->extflags |= RXf_CANY_SEEN;
6418     if (RExC_seen & REG_SEEN_VERBARG)
6419     {
6420         r->intflags |= PREGf_VERBARG_SEEN;
6421         r->extflags |= RXf_NO_INPLACE_SUBST; /* don't understand this! Yves */
6422     }
6423     if (RExC_seen & REG_SEEN_CUTGROUP)
6424         r->intflags |= PREGf_CUTGROUP_SEEN;
6425     if (pm_flags & PMf_USE_RE_EVAL)
6426         r->intflags |= PREGf_USE_RE_EVAL;
6427     if (RExC_paren_names)
6428         RXp_PAREN_NAMES(r) = MUTABLE_HV(SvREFCNT_inc(RExC_paren_names));
6429     else
6430         RXp_PAREN_NAMES(r) = NULL;
6431
6432     {
6433         regnode *first = ri->program + 1;
6434         U8 fop = OP(first);
6435         regnode *next = NEXTOPER(first);
6436         U8 nop = OP(next);
6437
6438         if (PL_regkind[fop] == NOTHING && nop == END)
6439             r->extflags |= RXf_NULL;
6440         else if (PL_regkind[fop] == BOL && nop == END)
6441             r->extflags |= RXf_START_ONLY;
6442         else if (fop == PLUS && PL_regkind[nop] == POSIXD && FLAGS(next) == _CC_SPACE && OP(regnext(first)) == END)
6443             r->extflags |= RXf_WHITE;
6444         else if ( r->extflags & RXf_SPLIT && fop == EXACT && STR_LEN(first) == 1 && *(STRING(first)) == ' ' && OP(regnext(first)) == END )
6445             r->extflags |= (RXf_SKIPWHITE|RXf_WHITE);
6446
6447     }
6448 #ifdef DEBUGGING
6449     if (RExC_paren_names) {
6450         ri->name_list_idx = add_data( pRExC_state, 1, "a" );
6451         ri->data->data[ri->name_list_idx] = (void*)SvREFCNT_inc(RExC_paren_name_list);
6452     } else
6453 #endif
6454         ri->name_list_idx = 0;
6455
6456     if (RExC_recurse_count) {
6457         for ( ; RExC_recurse_count ; RExC_recurse_count-- ) {
6458             const regnode *scan = RExC_recurse[RExC_recurse_count-1];
6459             ARG2L_SET( scan, RExC_open_parens[ARG(scan)-1] - scan );
6460         }
6461     }
6462     Newxz(r->offs, RExC_npar, regexp_paren_pair);
6463     /* assume we don't need to swap parens around before we match */
6464
6465     DEBUG_DUMP_r({
6466         PerlIO_printf(Perl_debug_log,"Final program:\n");
6467         regdump(r);
6468     });
6469 #ifdef RE_TRACK_PATTERN_OFFSETS
6470     DEBUG_OFFSETS_r(if (ri->u.offsets) {
6471         const U32 len = ri->u.offsets[0];
6472         U32 i;
6473         GET_RE_DEBUG_FLAGS_DECL;
6474         PerlIO_printf(Perl_debug_log, "Offsets: [%"UVuf"]\n\t", (UV)ri->u.offsets[0]);
6475         for (i = 1; i <= len; i++) {
6476             if (ri->u.offsets[i*2-1] || ri->u.offsets[i*2])
6477                 PerlIO_printf(Perl_debug_log, "%"UVuf":%"UVuf"[%"UVuf"] ",
6478                 (UV)i, (UV)ri->u.offsets[i*2-1], (UV)ri->u.offsets[i*2]);
6479             }
6480         PerlIO_printf(Perl_debug_log, "\n");
6481     });
6482 #endif
6483
6484 #ifdef USE_ITHREADS
6485     /* under ithreads the ?pat? PMf_USED flag on the pmop is simulated
6486      * by setting the regexp SV to readonly-only instead. If the
6487      * pattern's been recompiled, the USEDness should remain. */
6488     if (old_re && SvREADONLY(old_re))
6489         SvREADONLY_on(rx);
6490 #endif
6491     return rx;
6492 }
6493
6494
6495 SV*
6496 Perl_reg_named_buff(pTHX_ REGEXP * const rx, SV * const key, SV * const value,
6497                     const U32 flags)
6498 {
6499     PERL_ARGS_ASSERT_REG_NAMED_BUFF;
6500
6501     PERL_UNUSED_ARG(value);
6502
6503     if (flags & RXapif_FETCH) {
6504         return reg_named_buff_fetch(rx, key, flags);
6505     } else if (flags & (RXapif_STORE | RXapif_DELETE | RXapif_CLEAR)) {
6506         Perl_croak_no_modify();
6507         return NULL;
6508     } else if (flags & RXapif_EXISTS) {
6509         return reg_named_buff_exists(rx, key, flags)
6510             ? &PL_sv_yes
6511             : &PL_sv_no;
6512     } else if (flags & RXapif_REGNAMES) {
6513         return reg_named_buff_all(rx, flags);
6514     } else if (flags & (RXapif_SCALAR | RXapif_REGNAMES_COUNT)) {
6515         return reg_named_buff_scalar(rx, flags);
6516     } else {
6517         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff", (int)flags);
6518         return NULL;
6519     }
6520 }
6521
6522 SV*
6523 Perl_reg_named_buff_iter(pTHX_ REGEXP * const rx, const SV * const lastkey,
6524                          const U32 flags)
6525 {
6526     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ITER;
6527     PERL_UNUSED_ARG(lastkey);
6528
6529     if (flags & RXapif_FIRSTKEY)
6530         return reg_named_buff_firstkey(rx, flags);
6531     else if (flags & RXapif_NEXTKEY)
6532         return reg_named_buff_nextkey(rx, flags);
6533     else {
6534         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_iter", (int)flags);
6535         return NULL;
6536     }
6537 }
6538
6539 SV*
6540 Perl_reg_named_buff_fetch(pTHX_ REGEXP * const r, SV * const namesv,
6541                           const U32 flags)
6542 {
6543     AV *retarray = NULL;
6544     SV *ret;
6545     struct regexp *const rx = ReANY(r);
6546
6547     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FETCH;
6548
6549     if (flags & RXapif_ALL)
6550         retarray=newAV();
6551
6552     if (rx && RXp_PAREN_NAMES(rx)) {
6553         HE *he_str = hv_fetch_ent( RXp_PAREN_NAMES(rx), namesv, 0, 0 );
6554         if (he_str) {
6555             IV i;
6556             SV* sv_dat=HeVAL(he_str);
6557             I32 *nums=(I32*)SvPVX(sv_dat);
6558             for ( i=0; i<SvIVX(sv_dat); i++ ) {
6559                 if ((I32)(rx->nparens) >= nums[i]
6560                     && rx->offs[nums[i]].start != -1
6561                     && rx->offs[nums[i]].end != -1)
6562                 {
6563                     ret = newSVpvs("");
6564                     CALLREG_NUMBUF_FETCH(r,nums[i],ret);
6565                     if (!retarray)
6566                         return ret;
6567                 } else {
6568                     if (retarray)
6569                         ret = newSVsv(&PL_sv_undef);
6570                 }
6571                 if (retarray)
6572                     av_push(retarray, ret);
6573             }
6574             if (retarray)
6575                 return newRV_noinc(MUTABLE_SV(retarray));
6576         }
6577     }
6578     return NULL;
6579 }
6580
6581 bool
6582 Perl_reg_named_buff_exists(pTHX_ REGEXP * const r, SV * const key,
6583                            const U32 flags)
6584 {
6585     struct regexp *const rx = ReANY(r);
6586
6587     PERL_ARGS_ASSERT_REG_NAMED_BUFF_EXISTS;
6588
6589     if (rx && RXp_PAREN_NAMES(rx)) {
6590         if (flags & RXapif_ALL) {
6591             return hv_exists_ent(RXp_PAREN_NAMES(rx), key, 0);
6592         } else {
6593             SV *sv = CALLREG_NAMED_BUFF_FETCH(r, key, flags);
6594             if (sv) {
6595                 SvREFCNT_dec_NN(sv);
6596                 return TRUE;
6597             } else {
6598                 return FALSE;
6599             }
6600         }
6601     } else {
6602         return FALSE;
6603     }
6604 }
6605
6606 SV*
6607 Perl_reg_named_buff_firstkey(pTHX_ REGEXP * const r, const U32 flags)
6608 {
6609     struct regexp *const rx = ReANY(r);
6610
6611     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FIRSTKEY;
6612
6613     if ( rx && RXp_PAREN_NAMES(rx) ) {
6614         (void)hv_iterinit(RXp_PAREN_NAMES(rx));
6615
6616         return CALLREG_NAMED_BUFF_NEXTKEY(r, NULL, flags & ~RXapif_FIRSTKEY);
6617     } else {
6618         return FALSE;
6619     }
6620 }
6621
6622 SV*
6623 Perl_reg_named_buff_nextkey(pTHX_ REGEXP * const r, const U32 flags)
6624 {
6625     struct regexp *const rx = ReANY(r);
6626     GET_RE_DEBUG_FLAGS_DECL;
6627
6628     PERL_ARGS_ASSERT_REG_NAMED_BUFF_NEXTKEY;
6629
6630     if (rx && RXp_PAREN_NAMES(rx)) {
6631         HV *hv = RXp_PAREN_NAMES(rx);
6632         HE *temphe;
6633         while ( (temphe = hv_iternext_flags(hv,0)) ) {
6634             IV i;
6635             IV parno = 0;
6636             SV* sv_dat = HeVAL(temphe);
6637             I32 *nums = (I32*)SvPVX(sv_dat);
6638             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
6639                 if ((I32)(rx->lastparen) >= nums[i] &&
6640                     rx->offs[nums[i]].start != -1 &&
6641                     rx->offs[nums[i]].end != -1)
6642                 {
6643                     parno = nums[i];
6644                     break;
6645                 }
6646             }
6647             if (parno || flags & RXapif_ALL) {
6648                 return newSVhek(HeKEY_hek(temphe));
6649             }
6650         }
6651     }
6652     return NULL;
6653 }
6654
6655 SV*
6656 Perl_reg_named_buff_scalar(pTHX_ REGEXP * const r, const U32 flags)
6657 {
6658     SV *ret;
6659     AV *av;
6660     I32 length;
6661     struct regexp *const rx = ReANY(r);
6662
6663     PERL_ARGS_ASSERT_REG_NAMED_BUFF_SCALAR;
6664
6665     if (rx && RXp_PAREN_NAMES(rx)) {
6666         if (flags & (RXapif_ALL | RXapif_REGNAMES_COUNT)) {
6667             return newSViv(HvTOTALKEYS(RXp_PAREN_NAMES(rx)));
6668         } else if (flags & RXapif_ONE) {
6669             ret = CALLREG_NAMED_BUFF_ALL(r, (flags | RXapif_REGNAMES));
6670             av = MUTABLE_AV(SvRV(ret));
6671             length = av_len(av);
6672             SvREFCNT_dec_NN(ret);
6673             return newSViv(length + 1);
6674         } else {
6675             Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_scalar", (int)flags);
6676             return NULL;
6677         }
6678     }
6679     return &PL_sv_undef;
6680 }
6681
6682 SV*
6683 Perl_reg_named_buff_all(pTHX_ REGEXP * const r, const U32 flags)
6684 {
6685     struct regexp *const rx = ReANY(r);
6686     AV *av = newAV();
6687
6688     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ALL;
6689
6690     if (rx && RXp_PAREN_NAMES(rx)) {
6691         HV *hv= RXp_PAREN_NAMES(rx);
6692         HE *temphe;
6693         (void)hv_iterinit(hv);
6694         while ( (temphe = hv_iternext_flags(hv,0)) ) {
6695             IV i;
6696             IV parno = 0;
6697             SV* sv_dat = HeVAL(temphe);
6698             I32 *nums = (I32*)SvPVX(sv_dat);
6699             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
6700                 if ((I32)(rx->lastparen) >= nums[i] &&
6701                     rx->offs[nums[i]].start != -1 &&
6702                     rx->offs[nums[i]].end != -1)
6703                 {
6704                     parno = nums[i];
6705                     break;
6706                 }
6707             }
6708             if (parno || flags & RXapif_ALL) {
6709                 av_push(av, newSVhek(HeKEY_hek(temphe)));
6710             }
6711         }
6712     }
6713
6714     return newRV_noinc(MUTABLE_SV(av));
6715 }
6716
6717 void
6718 Perl_reg_numbered_buff_fetch(pTHX_ REGEXP * const r, const I32 paren,
6719                              SV * const sv)
6720 {
6721     struct regexp *const rx = ReANY(r);
6722     char *s = NULL;
6723     I32 i = 0;
6724     I32 s1, t1;
6725     I32 n = paren;
6726
6727     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_FETCH;
6728         
6729     if ( (    n == RX_BUFF_IDX_CARET_PREMATCH
6730            || n == RX_BUFF_IDX_CARET_FULLMATCH
6731            || n == RX_BUFF_IDX_CARET_POSTMATCH
6732          )
6733          && !(rx->extflags & RXf_PMf_KEEPCOPY)
6734     )
6735         goto ret_undef;
6736
6737     if (!rx->subbeg)
6738         goto ret_undef;
6739
6740     if (n == RX_BUFF_IDX_CARET_FULLMATCH)
6741         /* no need to distinguish between them any more */
6742         n = RX_BUFF_IDX_FULLMATCH;
6743
6744     if ((n == RX_BUFF_IDX_PREMATCH || n == RX_BUFF_IDX_CARET_PREMATCH)
6745         && rx->offs[0].start != -1)
6746     {
6747         /* $`, ${^PREMATCH} */
6748         i = rx->offs[0].start;
6749         s = rx->subbeg;
6750     }
6751     else 
6752     if ((n == RX_BUFF_IDX_POSTMATCH || n == RX_BUFF_IDX_CARET_POSTMATCH)
6753         && rx->offs[0].end != -1)
6754     {
6755         /* $', ${^POSTMATCH} */
6756         s = rx->subbeg - rx->suboffset + rx->offs[0].end;
6757         i = rx->sublen + rx->suboffset - rx->offs[0].end;
6758     } 
6759     else
6760     if ( 0 <= n && n <= (I32)rx->nparens &&
6761         (s1 = rx->offs[n].start) != -1 &&
6762         (t1 = rx->offs[n].end) != -1)
6763     {
6764         /* $&, ${^MATCH},  $1 ... */
6765         i = t1 - s1;
6766         s = rx->subbeg + s1 - rx->suboffset;
6767     } else {
6768         goto ret_undef;
6769     }          
6770
6771     assert(s >= rx->subbeg);
6772     assert(rx->sublen >= (s - rx->subbeg) + i );
6773     if (i >= 0) {
6774 #if NO_TAINT_SUPPORT
6775         sv_setpvn(sv, s, i);
6776 #else
6777         const int oldtainted = TAINT_get;
6778         TAINT_NOT;
6779         sv_setpvn(sv, s, i);
6780         TAINT_set(oldtainted);
6781 #endif
6782         if ( (rx->extflags & RXf_CANY_SEEN)
6783             ? (RXp_MATCH_UTF8(rx)
6784                         && (!i || is_utf8_string((U8*)s, i)))
6785             : (RXp_MATCH_UTF8(rx)) )
6786         {
6787             SvUTF8_on(sv);
6788         }
6789         else
6790             SvUTF8_off(sv);
6791         if (TAINTING_get) {
6792             if (RXp_MATCH_TAINTED(rx)) {
6793                 if (SvTYPE(sv) >= SVt_PVMG) {
6794                     MAGIC* const mg = SvMAGIC(sv);
6795                     MAGIC* mgt;
6796                     TAINT;
6797                     SvMAGIC_set(sv, mg->mg_moremagic);
6798                     SvTAINT(sv);
6799                     if ((mgt = SvMAGIC(sv))) {
6800                         mg->mg_moremagic = mgt;
6801                         SvMAGIC_set(sv, mg);
6802                     }
6803                 } else {
6804                     TAINT;
6805                     SvTAINT(sv);
6806                 }
6807             } else 
6808                 SvTAINTED_off(sv);
6809         }
6810     } else {
6811       ret_undef:
6812         sv_setsv(sv,&PL_sv_undef);
6813         return;
6814     }
6815 }
6816
6817 void
6818 Perl_reg_numbered_buff_store(pTHX_ REGEXP * const rx, const I32 paren,
6819                                                          SV const * const value)
6820 {
6821     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_STORE;
6822
6823     PERL_UNUSED_ARG(rx);
6824     PERL_UNUSED_ARG(paren);
6825     PERL_UNUSED_ARG(value);
6826
6827     if (!PL_localizing)
6828         Perl_croak_no_modify();
6829 }
6830
6831 I32
6832 Perl_reg_numbered_buff_length(pTHX_ REGEXP * const r, const SV * const sv,
6833                               const I32 paren)
6834 {
6835     struct regexp *const rx = ReANY(r);
6836     I32 i;
6837     I32 s1, t1;
6838
6839     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_LENGTH;
6840
6841     /* Some of this code was originally in C<Perl_magic_len> in F<mg.c> */
6842     switch (paren) {
6843       case RX_BUFF_IDX_CARET_PREMATCH: /* ${^PREMATCH} */
6844          if (!(rx->extflags & RXf_PMf_KEEPCOPY))
6845             goto warn_undef;
6846         /*FALLTHROUGH*/
6847
6848       case RX_BUFF_IDX_PREMATCH:       /* $` */
6849         if (rx->offs[0].start != -1) {
6850                         i = rx->offs[0].start;
6851                         if (i > 0) {
6852                                 s1 = 0;
6853                                 t1 = i;
6854                                 goto getlen;
6855                         }
6856             }
6857         return 0;
6858
6859       case RX_BUFF_IDX_CARET_POSTMATCH: /* ${^POSTMATCH} */
6860          if (!(rx->extflags & RXf_PMf_KEEPCOPY))
6861             goto warn_undef;
6862       case RX_BUFF_IDX_POSTMATCH:       /* $' */
6863             if (rx->offs[0].end != -1) {
6864                         i = rx->sublen - rx->offs[0].end;
6865                         if (i > 0) {
6866                                 s1 = rx->offs[0].end;
6867                                 t1 = rx->sublen;
6868                                 goto getlen;
6869                         }
6870             }
6871         return 0;
6872
6873       case RX_BUFF_IDX_CARET_FULLMATCH: /* ${^MATCH} */
6874          if (!(rx->extflags & RXf_PMf_KEEPCOPY))
6875             goto warn_undef;
6876         /*FALLTHROUGH*/
6877
6878       /* $& / ${^MATCH}, $1, $2, ... */
6879       default:
6880             if (paren <= (I32)rx->nparens &&
6881             (s1 = rx->offs[paren].start) != -1 &&
6882             (t1 = rx->offs[paren].end) != -1)
6883             {
6884             i = t1 - s1;
6885             goto getlen;
6886         } else {
6887           warn_undef:
6888             if (ckWARN(WARN_UNINITIALIZED))
6889                 report_uninit((const SV *)sv);
6890             return 0;
6891         }
6892     }
6893   getlen:
6894     if (i > 0 && RXp_MATCH_UTF8(rx)) {
6895         const char * const s = rx->subbeg - rx->suboffset + s1;
6896         const U8 *ep;
6897         STRLEN el;
6898
6899         i = t1 - s1;
6900         if (is_utf8_string_loclen((U8*)s, i, &ep, &el))
6901                         i = el;
6902     }
6903     return i;
6904 }
6905
6906 SV*
6907 Perl_reg_qr_package(pTHX_ REGEXP * const rx)
6908 {
6909     PERL_ARGS_ASSERT_REG_QR_PACKAGE;
6910         PERL_UNUSED_ARG(rx);
6911         if (0)
6912             return NULL;
6913         else
6914             return newSVpvs("Regexp");
6915 }
6916
6917 /* Scans the name of a named buffer from the pattern.
6918  * If flags is REG_RSN_RETURN_NULL returns null.
6919  * If flags is REG_RSN_RETURN_NAME returns an SV* containing the name
6920  * If flags is REG_RSN_RETURN_DATA returns the data SV* corresponding
6921  * to the parsed name as looked up in the RExC_paren_names hash.
6922  * If there is an error throws a vFAIL().. type exception.
6923  */
6924
6925 #define REG_RSN_RETURN_NULL    0
6926 #define REG_RSN_RETURN_NAME    1
6927 #define REG_RSN_RETURN_DATA    2
6928
6929 STATIC SV*
6930 S_reg_scan_name(pTHX_ RExC_state_t *pRExC_state, U32 flags)
6931 {
6932     char *name_start = RExC_parse;
6933
6934     PERL_ARGS_ASSERT_REG_SCAN_NAME;
6935
6936     if (isIDFIRST_lazy_if(RExC_parse, UTF)) {
6937          /* skip IDFIRST by using do...while */
6938         if (UTF)
6939             do {
6940                 RExC_parse += UTF8SKIP(RExC_parse);
6941             } while (isWORDCHAR_utf8((U8*)RExC_parse));
6942         else
6943             do {
6944                 RExC_parse++;
6945             } while (isWORDCHAR(*RExC_parse));
6946     } else {
6947         RExC_parse++; /* so the <- from the vFAIL is after the offending character */
6948         vFAIL("Group name must start with a non-digit word character");
6949     }
6950     if ( flags ) {
6951         SV* sv_name
6952             = newSVpvn_flags(name_start, (int)(RExC_parse - name_start),
6953                              SVs_TEMP | (UTF ? SVf_UTF8 : 0));
6954         if ( flags == REG_RSN_RETURN_NAME)
6955             return sv_name;
6956         else if (flags==REG_RSN_RETURN_DATA) {
6957             HE *he_str = NULL;
6958             SV *sv_dat = NULL;
6959             if ( ! sv_name )      /* should not happen*/
6960                 Perl_croak(aTHX_ "panic: no svname in reg_scan_name");
6961             if (RExC_paren_names)
6962                 he_str = hv_fetch_ent( RExC_paren_names, sv_name, 0, 0 );
6963             if ( he_str )
6964                 sv_dat = HeVAL(he_str);
6965             if ( ! sv_dat )
6966                 vFAIL("Reference to nonexistent named group");
6967             return sv_dat;
6968         }
6969         else {
6970             Perl_croak(aTHX_ "panic: bad flag %lx in reg_scan_name",
6971                        (unsigned long) flags);
6972         }
6973         assert(0); /* NOT REACHED */
6974     }
6975     return NULL;
6976 }
6977
6978 #define DEBUG_PARSE_MSG(funcname)     DEBUG_PARSE_r({           \
6979     int rem=(int)(RExC_end - RExC_parse);                       \
6980     int cut;                                                    \
6981     int num;                                                    \
6982     int iscut=0;                                                \
6983     if (rem>10) {                                               \
6984         rem=10;                                                 \
6985         iscut=1;                                                \
6986     }                                                           \
6987     cut=10-rem;                                                 \
6988     if (RExC_lastparse!=RExC_parse)                             \
6989         PerlIO_printf(Perl_debug_log," >%.*s%-*s",              \
6990             rem, RExC_parse,                                    \
6991             cut + 4,                                            \
6992             iscut ? "..." : "<"                                 \
6993         );                                                      \
6994     else                                                        \
6995         PerlIO_printf(Perl_debug_log,"%16s","");                \
6996                                                                 \
6997     if (SIZE_ONLY)                                              \
6998        num = RExC_size + 1;                                     \
6999     else                                                        \
7000        num=REG_NODE_NUM(RExC_emit);                             \
7001     if (RExC_lastnum!=num)                                      \
7002        PerlIO_printf(Perl_debug_log,"|%4d",num);                \
7003     else                                                        \
7004        PerlIO_printf(Perl_debug_log,"|%4s","");                 \
7005     PerlIO_printf(Perl_debug_log,"|%*s%-4s",                    \
7006         (int)((depth*2)), "",                                   \
7007         (funcname)                                              \
7008     );                                                          \
7009     RExC_lastnum=num;                                           \
7010     RExC_lastparse=RExC_parse;                                  \
7011 })
7012
7013
7014
7015 #define DEBUG_PARSE(funcname)     DEBUG_PARSE_r({           \
7016     DEBUG_PARSE_MSG((funcname));                            \
7017     PerlIO_printf(Perl_debug_log,"%4s","\n");               \
7018 })
7019 #define DEBUG_PARSE_FMT(funcname,fmt,args)     DEBUG_PARSE_r({           \
7020     DEBUG_PARSE_MSG((funcname));                            \
7021     PerlIO_printf(Perl_debug_log,fmt "\n",args);               \
7022 })
7023
7024 /* This section of code defines the inversion list object and its methods.  The
7025  * interfaces are highly subject to change, so as much as possible is static to
7026  * this file.  An inversion list is here implemented as a malloc'd C UV array
7027  * as an SVt_INVLIST scalar.
7028  *
7029  * An inversion list for Unicode is an array of code points, sorted by ordinal
7030  * number.  The zeroth element is the first code point in the list.  The 1th
7031  * element is the first element beyond that not in the list.  In other words,
7032  * the first range is
7033  *  invlist[0]..(invlist[1]-1)
7034  * The other ranges follow.  Thus every element whose index is divisible by two
7035  * marks the beginning of a range that is in the list, and every element not
7036  * divisible by two marks the beginning of a range not in the list.  A single
7037  * element inversion list that contains the single code point N generally
7038  * consists of two elements
7039  *  invlist[0] == N
7040  *  invlist[1] == N+1
7041  * (The exception is when N is the highest representable value on the
7042  * machine, in which case the list containing just it would be a single
7043  * element, itself.  By extension, if the last range in the list extends to
7044  * infinity, then the first element of that range will be in the inversion list
7045  * at a position that is divisible by two, and is the final element in the
7046  * list.)
7047  * Taking the complement (inverting) an inversion list is quite simple, if the
7048  * first element is 0, remove it; otherwise add a 0 element at the beginning.
7049  * This implementation reserves an element at the beginning of each inversion
7050  * list to always contain 0; there is an additional flag in the header which
7051  * indicates if the list begins at the 0, or is offset to begin at the next
7052  * element.
7053  *
7054  * More about inversion lists can be found in "Unicode Demystified"
7055  * Chapter 13 by Richard Gillam, published by Addison-Wesley.
7056  * More will be coming when functionality is added later.
7057  *
7058  * The inversion list data structure is currently implemented as an SV pointing
7059  * to an array of UVs that the SV thinks are bytes.  This allows us to have an
7060  * array of UV whose memory management is automatically handled by the existing
7061  * facilities for SV's.
7062  *
7063  * Some of the methods should always be private to the implementation, and some
7064  * should eventually be made public */
7065
7066 /* The header definitions are in F<inline_invlist.c> */
7067
7068 PERL_STATIC_INLINE UV*
7069 S__invlist_array_init(pTHX_ SV* const invlist, const bool will_have_0)
7070 {
7071     /* Returns a pointer to the first element in the inversion list's array.
7072      * This is called upon initialization of an inversion list.  Where the
7073      * array begins depends on whether the list has the code point U+0000 in it
7074      * or not.  The other parameter tells it whether the code that follows this
7075      * call is about to put a 0 in the inversion list or not.  The first
7076      * element is either the element reserved for 0, if TRUE, or the element
7077      * after it, if FALSE */
7078
7079     bool* offset = get_invlist_offset_addr(invlist);
7080     UV* zero_addr = (UV *) SvPVX(invlist);
7081
7082     PERL_ARGS_ASSERT__INVLIST_ARRAY_INIT;
7083
7084     /* Must be empty */
7085     assert(! _invlist_len(invlist));
7086
7087     *zero_addr = 0;
7088
7089     /* 1^1 = 0; 1^0 = 1 */
7090     *offset = 1 ^ will_have_0;
7091     return zero_addr + *offset;
7092 }
7093
7094 PERL_STATIC_INLINE UV*
7095 S_invlist_array(pTHX_ SV* const invlist)
7096 {
7097     /* Returns the pointer to the inversion list's array.  Every time the
7098      * length changes, this needs to be called in case malloc or realloc moved
7099      * it */
7100
7101     PERL_ARGS_ASSERT_INVLIST_ARRAY;
7102
7103     /* Must not be empty.  If these fail, you probably didn't check for <len>
7104      * being non-zero before trying to get the array */
7105     assert(_invlist_len(invlist));
7106
7107     /* The very first element always contains zero, The array begins either
7108      * there, or if the inversion list is offset, at the element after it.
7109      * The offset header field determines which; it contains 0 or 1 to indicate
7110      * how much additionally to add */
7111     assert(0 == *(SvPVX(invlist)));
7112     return ((UV *) SvPVX(invlist) + *get_invlist_offset_addr(invlist));
7113 }
7114
7115 PERL_STATIC_INLINE void
7116 S_invlist_set_len(pTHX_ SV* const invlist, const UV len, const bool offset)
7117 {
7118     /* Sets the current number of elements stored in the inversion list.
7119      * Updates SvCUR correspondingly */
7120
7121     PERL_ARGS_ASSERT_INVLIST_SET_LEN;
7122
7123     assert(SvTYPE(invlist) == SVt_INVLIST);
7124
7125     SvCUR_set(invlist,
7126               (len == 0)
7127                ? 0
7128                : TO_INTERNAL_SIZE(len + offset));
7129     assert(SvLEN(invlist) == 0 || SvCUR(invlist) <= SvLEN(invlist));
7130 }
7131
7132 PERL_STATIC_INLINE IV*
7133 S_get_invlist_previous_index_addr(pTHX_ SV* invlist)
7134 {
7135     /* Return the address of the IV that is reserved to hold the cached index
7136      * */
7137
7138     PERL_ARGS_ASSERT_GET_INVLIST_PREVIOUS_INDEX_ADDR;
7139
7140     assert(SvTYPE(invlist) == SVt_INVLIST);
7141
7142     return &(((XINVLIST*) SvANY(invlist))->prev_index);
7143 }
7144
7145 PERL_STATIC_INLINE IV
7146 S_invlist_previous_index(pTHX_ SV* const invlist)
7147 {
7148     /* Returns cached index of previous search */
7149
7150     PERL_ARGS_ASSERT_INVLIST_PREVIOUS_INDEX;
7151
7152     return *get_invlist_previous_index_addr(invlist);
7153 }
7154
7155 PERL_STATIC_INLINE void
7156 S_invlist_set_previous_index(pTHX_ SV* const invlist, const IV index)
7157 {
7158     /* Caches <index> for later retrieval */
7159
7160     PERL_ARGS_ASSERT_INVLIST_SET_PREVIOUS_INDEX;
7161
7162     assert(index == 0 || index < (int) _invlist_len(invlist));
7163
7164     *get_invlist_previous_index_addr(invlist) = index;
7165 }
7166
7167 PERL_STATIC_INLINE UV
7168 S_invlist_max(pTHX_ SV* const invlist)
7169 {
7170     /* Returns the maximum number of elements storable in the inversion list's
7171      * array, without having to realloc() */
7172
7173     PERL_ARGS_ASSERT_INVLIST_MAX;
7174
7175     assert(SvTYPE(invlist) == SVt_INVLIST);
7176
7177     /* Assumes worst case, in which the 0 element is not counted in the
7178      * inversion list, so subtracts 1 for that */
7179     return SvLEN(invlist) == 0  /* This happens under _new_invlist_C_array */
7180            ? FROM_INTERNAL_SIZE(SvCUR(invlist)) - 1
7181            : FROM_INTERNAL_SIZE(SvLEN(invlist)) - 1;
7182 }
7183
7184 #ifndef PERL_IN_XSUB_RE
7185 SV*
7186 Perl__new_invlist(pTHX_ IV initial_size)
7187 {
7188
7189     /* Return a pointer to a newly constructed inversion list, with enough
7190      * space to store 'initial_size' elements.  If that number is negative, a
7191      * system default is used instead */
7192
7193     SV* new_list;
7194
7195     if (initial_size < 0) {
7196         initial_size = 10;
7197     }
7198
7199     /* Allocate the initial space */
7200     new_list = newSV_type(SVt_INVLIST);
7201
7202     /* First 1 is in case the zero element isn't in the list; second 1 is for
7203      * trailing NUL */
7204     SvGROW(new_list, TO_INTERNAL_SIZE(initial_size + 1) + 1);
7205     invlist_set_len(new_list, 0, 0);
7206
7207     /* Force iterinit() to be used to get iteration to work */
7208     *get_invlist_iter_addr(new_list) = (STRLEN) UV_MAX;
7209
7210     *get_invlist_previous_index_addr(new_list) = 0;
7211
7212     return new_list;
7213 }
7214 #endif
7215
7216 STATIC SV*
7217 S__new_invlist_C_array(pTHX_ const UV* const list)
7218 {
7219     /* Return a pointer to a newly constructed inversion list, initialized to
7220      * point to <list>, which has to be in the exact correct inversion list
7221      * form, including internal fields.  Thus this is a dangerous routine that
7222      * should not be used in the wrong hands.  The passed in 'list' contains
7223      * several header fields at the beginning that are not part of the
7224      * inversion list body proper */
7225
7226     const STRLEN length = (STRLEN) list[0];
7227     const UV version_id =          list[1];
7228     const bool offset   =    cBOOL(list[2]);
7229 #define HEADER_LENGTH 3
7230     /* If any of the above changes in any way, you must change HEADER_LENGTH
7231      * (if appropriate) and regenerate INVLIST_VERSION_ID by running
7232      *      perl -E 'say int(rand 2**31-1)'
7233      */
7234 #define INVLIST_VERSION_ID 148565664 /* This is a combination of a version and
7235                                         data structure type, so that one being
7236                                         passed in can be validated to be an
7237                                         inversion list of the correct vintage.
7238                                        */
7239
7240     SV* invlist = newSV_type(SVt_INVLIST);
7241
7242     PERL_ARGS_ASSERT__NEW_INVLIST_C_ARRAY;
7243
7244     if (version_id != INVLIST_VERSION_ID) {
7245         Perl_croak(aTHX_ "panic: Incorrect version for previously generated inversion list");
7246     }
7247
7248     /* The generated array passed in includes header elements that aren't part
7249      * of the list proper, so start it just after them */
7250     SvPV_set(invlist, (char *) (list + HEADER_LENGTH));
7251
7252     SvLEN_set(invlist, 0);  /* Means we own the contents, and the system
7253                                shouldn't touch it */
7254
7255     *(get_invlist_offset_addr(invlist)) = offset;
7256
7257     /* The 'length' passed to us is the physical number of elements in the
7258      * inversion list.  But if there is an offset the logical number is one
7259      * less than that */
7260     invlist_set_len(invlist, length  - offset, offset);
7261
7262     invlist_set_previous_index(invlist, 0);
7263
7264     /* Initialize the iteration pointer. */
7265     invlist_iterfinish(invlist);
7266
7267     return invlist;
7268 }
7269
7270 STATIC void
7271 S_invlist_extend(pTHX_ SV* const invlist, const UV new_max)
7272 {
7273     /* Grow the maximum size of an inversion list */
7274
7275     PERL_ARGS_ASSERT_INVLIST_EXTEND;
7276
7277     assert(SvTYPE(invlist) == SVt_INVLIST);
7278
7279     /* Add one to account for the zero element at the beginning which may not
7280      * be counted by the calling parameters */
7281     SvGROW((SV *)invlist, TO_INTERNAL_SIZE(new_max + 1));
7282 }
7283
7284 PERL_STATIC_INLINE void
7285 S_invlist_trim(pTHX_ SV* const invlist)
7286 {
7287     PERL_ARGS_ASSERT_INVLIST_TRIM;
7288
7289     assert(SvTYPE(invlist) == SVt_INVLIST);
7290
7291     /* Change the length of the inversion list to how many entries it currently
7292      * has */
7293     SvPV_shrink_to_cur((SV *) invlist);
7294 }
7295
7296 #define _invlist_union_complement_2nd(a, b, output) _invlist_union_maybe_complement_2nd(a, b, TRUE, output)
7297
7298 STATIC void
7299 S__append_range_to_invlist(pTHX_ SV* const invlist, const UV start, const UV end)
7300 {
7301    /* Subject to change or removal.  Append the range from 'start' to 'end' at
7302     * the end of the inversion list.  The range must be above any existing
7303     * ones. */
7304
7305     UV* array;
7306     UV max = invlist_max(invlist);
7307     UV len = _invlist_len(invlist);
7308     bool offset;
7309
7310     PERL_ARGS_ASSERT__APPEND_RANGE_TO_INVLIST;
7311
7312     if (len == 0) { /* Empty lists must be initialized */
7313         offset = start != 0;
7314         array = _invlist_array_init(invlist, ! offset);
7315     }
7316     else {
7317         /* Here, the existing list is non-empty. The current max entry in the
7318          * list is generally the first value not in the set, except when the
7319          * set extends to the end of permissible values, in which case it is
7320          * the first entry in that final set, and so this call is an attempt to
7321          * append out-of-order */
7322
7323         UV final_element = len - 1;
7324         array = invlist_array(invlist);
7325         if (array[final_element] > start
7326             || ELEMENT_RANGE_MATCHES_INVLIST(final_element))
7327         {
7328             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",
7329                        array[final_element], start,
7330                        ELEMENT_RANGE_MATCHES_INVLIST(final_element) ? 't' : 'f');
7331         }
7332
7333         /* Here, it is a legal append.  If the new range begins with the first
7334          * value not in the set, it is extending the set, so the new first
7335          * value not in the set is one greater than the newly extended range.
7336          * */
7337         offset = *get_invlist_offset_addr(invlist);
7338         if (array[final_element] == start) {
7339             if (end != UV_MAX) {
7340                 array[final_element] = end + 1;
7341             }
7342             else {
7343                 /* But if the end is the maximum representable on the machine,
7344                  * just let the range that this would extend to have no end */
7345                 invlist_set_len(invlist, len - 1, offset);
7346             }
7347             return;
7348         }
7349     }
7350
7351     /* Here the new range doesn't extend any existing set.  Add it */
7352
7353     len += 2;   /* Includes an element each for the start and end of range */
7354
7355     /* If wll overflow the existing space, extend, which may cause the array to
7356      * be moved */
7357     if (max < len) {
7358         invlist_extend(invlist, len);
7359
7360         /* Have to set len here to avoid assert failure in invlist_array() */
7361         invlist_set_len(invlist, len, offset);
7362
7363         array = invlist_array(invlist);
7364     }
7365     else {
7366         invlist_set_len(invlist, len, offset);
7367     }
7368
7369     /* The next item on the list starts the range, the one after that is
7370      * one past the new range.  */
7371     array[len - 2] = start;
7372     if (end != UV_MAX) {
7373         array[len - 1] = end + 1;
7374     }
7375     else {
7376         /* But if the end is the maximum representable on the machine, just let
7377          * the range have no end */
7378         invlist_set_len(invlist, len - 1, offset);
7379     }
7380 }
7381
7382 #ifndef PERL_IN_XSUB_RE
7383
7384 IV
7385 Perl__invlist_search(pTHX_ SV* const invlist, const UV cp)
7386 {
7387     /* Searches the inversion list for the entry that contains the input code
7388      * point <cp>.  If <cp> is not in the list, -1 is returned.  Otherwise, the
7389      * return value is the index into the list's array of the range that
7390      * contains <cp> */
7391
7392     IV low = 0;
7393     IV mid;
7394     IV high = _invlist_len(invlist);
7395     const IV highest_element = high - 1;
7396     const UV* array;
7397
7398     PERL_ARGS_ASSERT__INVLIST_SEARCH;
7399
7400     /* If list is empty, return failure. */
7401     if (high == 0) {
7402         return -1;
7403     }
7404
7405     /* (We can't get the array unless we know the list is non-empty) */
7406     array = invlist_array(invlist);
7407
7408     mid = invlist_previous_index(invlist);
7409     assert(mid >=0 && mid <= highest_element);
7410
7411     /* <mid> contains the cache of the result of the previous call to this
7412      * function (0 the first time).  See if this call is for the same result,
7413      * or if it is for mid-1.  This is under the theory that calls to this
7414      * function will often be for related code points that are near each other.
7415      * And benchmarks show that caching gives better results.  We also test
7416      * here if the code point is within the bounds of the list.  These tests
7417      * replace others that would have had to be made anyway to make sure that
7418      * the array bounds were not exceeded, and these give us extra information
7419      * at the same time */
7420     if (cp >= array[mid]) {
7421         if (cp >= array[highest_element]) {
7422             return highest_element;
7423         }
7424
7425         /* Here, array[mid] <= cp < array[highest_element].  This means that
7426          * the final element is not the answer, so can exclude it; it also
7427          * means that <mid> is not the final element, so can refer to 'mid + 1'
7428          * safely */
7429         if (cp < array[mid + 1]) {
7430             return mid;
7431         }
7432         high--;
7433         low = mid + 1;
7434     }
7435     else { /* cp < aray[mid] */
7436         if (cp < array[0]) { /* Fail if outside the array */
7437             return -1;
7438         }
7439         high = mid;
7440         if (cp >= array[mid - 1]) {
7441             goto found_entry;
7442         }
7443     }
7444
7445     /* Binary search.  What we are looking for is <i> such that
7446      *  array[i] <= cp < array[i+1]
7447      * The loop below converges on the i+1.  Note that there may not be an
7448      * (i+1)th element in the array, and things work nonetheless */
7449     while (low < high) {
7450         mid = (low + high) / 2;
7451         assert(mid <= highest_element);
7452         if (array[mid] <= cp) { /* cp >= array[mid] */
7453             low = mid + 1;
7454
7455             /* We could do this extra test to exit the loop early.
7456             if (cp < array[low]) {
7457                 return mid;
7458             }
7459             */
7460         }
7461         else { /* cp < array[mid] */
7462             high = mid;
7463         }
7464     }
7465
7466   found_entry:
7467     high--;
7468     invlist_set_previous_index(invlist, high);
7469     return high;
7470 }
7471
7472 void
7473 Perl__invlist_populate_swatch(pTHX_ SV* const invlist, const UV start, const UV end, U8* swatch)
7474 {
7475     /* populates a swatch of a swash the same way swatch_get() does in utf8.c,
7476      * but is used when the swash has an inversion list.  This makes this much
7477      * faster, as it uses a binary search instead of a linear one.  This is
7478      * intimately tied to that function, and perhaps should be in utf8.c,
7479      * except it is intimately tied to inversion lists as well.  It assumes
7480      * that <swatch> is all 0's on input */
7481
7482     UV current = start;
7483     const IV len = _invlist_len(invlist);
7484     IV i;
7485     const UV * array;
7486
7487     PERL_ARGS_ASSERT__INVLIST_POPULATE_SWATCH;
7488
7489     if (len == 0) { /* Empty inversion list */
7490         return;
7491     }
7492
7493     array = invlist_array(invlist);
7494
7495     /* Find which element it is */
7496     i = _invlist_search(invlist, start);
7497
7498     /* We populate from <start> to <end> */
7499     while (current < end) {
7500         UV upper;
7501
7502         /* The inversion list gives the results for every possible code point
7503          * after the first one in the list.  Only those ranges whose index is
7504          * even are ones that the inversion list matches.  For the odd ones,
7505          * and if the initial code point is not in the list, we have to skip
7506          * forward to the next element */
7507         if (i == -1 || ! ELEMENT_RANGE_MATCHES_INVLIST(i)) {
7508             i++;
7509             if (i >= len) { /* Finished if beyond the end of the array */
7510                 return;
7511             }
7512             current = array[i];
7513             if (current >= end) {   /* Finished if beyond the end of what we
7514                                        are populating */
7515                 if (LIKELY(end < UV_MAX)) {
7516                     return;
7517                 }
7518
7519                 /* We get here when the upper bound is the maximum
7520                  * representable on the machine, and we are looking for just
7521                  * that code point.  Have to special case it */
7522                 i = len;
7523                 goto join_end_of_list;
7524             }
7525         }
7526         assert(current >= start);
7527
7528         /* The current range ends one below the next one, except don't go past
7529          * <end> */
7530         i++;
7531         upper = (i < len && array[i] < end) ? array[i] : end;
7532
7533         /* Here we are in a range that matches.  Populate a bit in the 3-bit U8
7534          * for each code point in it */
7535         for (; current < upper; current++) {
7536             const STRLEN offset = (STRLEN)(current - start);
7537             swatch[offset >> 3] |= 1 << (offset & 7);
7538         }
7539
7540     join_end_of_list:
7541
7542         /* Quit if at the end of the list */
7543         if (i >= len) {
7544
7545             /* But first, have to deal with the highest possible code point on
7546              * the platform.  The previous code assumes that <end> is one
7547              * beyond where we want to populate, but that is impossible at the
7548              * platform's infinity, so have to handle it specially */
7549             if (UNLIKELY(end == UV_MAX && ELEMENT_RANGE_MATCHES_INVLIST(len-1)))
7550             {
7551                 const STRLEN offset = (STRLEN)(end - start);
7552                 swatch[offset >> 3] |= 1 << (offset & 7);
7553             }
7554             return;
7555         }
7556
7557         /* Advance to the next range, which will be for code points not in the
7558          * inversion list */
7559         current = array[i];
7560     }
7561
7562     return;
7563 }
7564
7565 void
7566 Perl__invlist_union_maybe_complement_2nd(pTHX_ SV* const a, SV* const b, const bool complement_b, SV** output)
7567 {
7568     /* Take the union of two inversion lists and point <output> to it.  *output
7569      * SHOULD BE DEFINED upon input, and if it points to one of the two lists,
7570      * the reference count to that list will be decremented.  The first list,
7571      * <a>, may be NULL, in which case a copy of the second list is returned.
7572      * If <complement_b> is TRUE, the union is taken of the complement
7573      * (inversion) of <b> instead of b itself.
7574      *
7575      * The basis for this comes from "Unicode Demystified" Chapter 13 by
7576      * Richard Gillam, published by Addison-Wesley, and explained at some
7577      * length there.  The preface says to incorporate its examples into your
7578      * code at your own risk.
7579      *
7580      * The algorithm is like a merge sort.
7581      *
7582      * XXX A potential performance improvement is to keep track as we go along
7583      * if only one of the inputs contributes to the result, meaning the other
7584      * is a subset of that one.  In that case, we can skip the final copy and
7585      * return the larger of the input lists, but then outside code might need
7586      * to keep track of whether to free the input list or not */
7587
7588     const UV* array_a;    /* a's array */
7589     const UV* array_b;
7590     UV len_a;       /* length of a's array */
7591     UV len_b;
7592
7593     SV* u;                      /* the resulting union */
7594     UV* array_u;
7595     UV len_u;
7596
7597     UV i_a = 0;             /* current index into a's array */
7598     UV i_b = 0;
7599     UV i_u = 0;
7600
7601     /* running count, as explained in the algorithm source book; items are
7602      * stopped accumulating and are output when the count changes to/from 0.
7603      * The count is incremented when we start a range that's in the set, and
7604      * decremented when we start a range that's not in the set.  So its range
7605      * is 0 to 2.  Only when the count is zero is something not in the set.
7606      */
7607     UV count = 0;
7608
7609     PERL_ARGS_ASSERT__INVLIST_UNION_MAYBE_COMPLEMENT_2ND;
7610     assert(a != b);
7611
7612     /* If either one is empty, the union is the other one */
7613     if (a == NULL || ((len_a = _invlist_len(a)) == 0)) {
7614         if (*output == a) {
7615             if (a != NULL) {
7616                 SvREFCNT_dec_NN(a);
7617             }
7618         }
7619         if (*output != b) {
7620             *output = invlist_clone(b);
7621             if (complement_b) {
7622                 _invlist_invert(*output);
7623             }
7624         } /* else *output already = b; */
7625         return;
7626     }
7627     else if ((len_b = _invlist_len(b)) == 0) {
7628         if (*output == b) {
7629             SvREFCNT_dec_NN(b);
7630         }
7631
7632         /* The complement of an empty list is a list that has everything in it,
7633          * so the union with <a> includes everything too */
7634         if (complement_b) {
7635             if (a == *output) {
7636                 SvREFCNT_dec_NN(a);
7637             }
7638             *output = _new_invlist(1);
7639             _append_range_to_invlist(*output, 0, UV_MAX);
7640         }
7641         else if (*output != a) {
7642             *output = invlist_clone(a);
7643         }
7644         /* else *output already = a; */
7645         return;
7646     }
7647
7648     /* Here both lists exist and are non-empty */
7649     array_a = invlist_array(a);
7650     array_b = invlist_array(b);
7651
7652     /* If are to take the union of 'a' with the complement of b, set it
7653      * up so are looking at b's complement. */
7654     if (complement_b) {
7655
7656         /* To complement, we invert: if the first element is 0, remove it.  To
7657          * do this, we just pretend the array starts one later */
7658         if (array_b[0] == 0) {
7659             array_b++;
7660             len_b--;
7661         }
7662         else {
7663
7664             /* But if the first element is not zero, we pretend the list starts
7665              * at the 0 that is always stored immediately before the array. */
7666             array_b--;
7667             len_b++;
7668         }
7669     }
7670
7671     /* Size the union for the worst case: that the sets are completely
7672      * disjoint */
7673     u = _new_invlist(len_a + len_b);
7674
7675     /* Will contain U+0000 if either component does */
7676     array_u = _invlist_array_init(u, (len_a > 0 && array_a[0] == 0)
7677                                       || (len_b > 0 && array_b[0] == 0));
7678
7679     /* Go through each list item by item, stopping when exhausted one of
7680      * them */
7681     while (i_a < len_a && i_b < len_b) {
7682         UV cp;      /* The element to potentially add to the union's array */
7683         bool cp_in_set;   /* is it in the the input list's set or not */
7684
7685         /* We need to take one or the other of the two inputs for the union.
7686          * Since we are merging two sorted lists, we take the smaller of the
7687          * next items.  In case of a tie, we take the one that is in its set
7688          * first.  If we took one not in the set first, it would decrement the
7689          * count, possibly to 0 which would cause it to be output as ending the
7690          * range, and the next time through we would take the same number, and
7691          * output it again as beginning the next range.  By doing it the
7692          * opposite way, there is no possibility that the count will be
7693          * momentarily decremented to 0, and thus the two adjoining ranges will
7694          * be seamlessly merged.  (In a tie and both are in the set or both not
7695          * in the set, it doesn't matter which we take first.) */
7696         if (array_a[i_a] < array_b[i_b]
7697             || (array_a[i_a] == array_b[i_b]
7698                 && ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
7699         {
7700             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
7701             cp= array_a[i_a++];
7702         }
7703         else {
7704             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
7705             cp = array_b[i_b++];
7706         }
7707
7708         /* Here, have chosen which of the two inputs to look at.  Only output
7709          * if the running count changes to/from 0, which marks the
7710          * beginning/end of a range in that's in the set */
7711         if (cp_in_set) {
7712             if (count == 0) {
7713                 array_u[i_u++] = cp;
7714             }
7715             count++;
7716         }
7717         else {
7718             count--;
7719             if (count == 0) {
7720                 array_u[i_u++] = cp;
7721             }
7722         }
7723     }
7724
7725     /* Here, we are finished going through at least one of the lists, which
7726      * means there is something remaining in at most one.  We check if the list
7727      * that hasn't been exhausted is positioned such that we are in the middle
7728      * of a range in its set or not.  (i_a and i_b point to the element beyond
7729      * the one we care about.) If in the set, we decrement 'count'; if 0, there
7730      * is potentially more to output.
7731      * There are four cases:
7732      *  1) Both weren't in their sets, count is 0, and remains 0.  What's left
7733      *     in the union is entirely from the non-exhausted set.
7734      *  2) Both were in their sets, count is 2.  Nothing further should
7735      *     be output, as everything that remains will be in the exhausted
7736      *     list's set, hence in the union; decrementing to 1 but not 0 insures
7737      *     that
7738      *  3) the exhausted was in its set, non-exhausted isn't, count is 1.
7739      *     Nothing further should be output because the union includes
7740      *     everything from the exhausted set.  Not decrementing ensures that.
7741      *  4) the exhausted wasn't in its set, non-exhausted is, count is 1;
7742      *     decrementing to 0 insures that we look at the remainder of the
7743      *     non-exhausted set */
7744     if ((i_a != len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
7745         || (i_b != len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
7746     {
7747         count--;
7748     }
7749
7750     /* The final length is what we've output so far, plus what else is about to
7751      * be output.  (If 'count' is non-zero, then the input list we exhausted
7752      * has everything remaining up to the machine's limit in its set, and hence
7753      * in the union, so there will be no further output. */
7754     len_u = i_u;
7755     if (count == 0) {
7756         /* At most one of the subexpressions will be non-zero */
7757         len_u += (len_a - i_a) + (len_b - i_b);
7758     }
7759
7760     /* Set result to final length, which can change the pointer to array_u, so
7761      * re-find it */
7762     if (len_u != _invlist_len(u)) {
7763         invlist_set_len(u, len_u, *get_invlist_offset_addr(u));
7764         invlist_trim(u);
7765         array_u = invlist_array(u);
7766     }
7767
7768     /* When 'count' is 0, the list that was exhausted (if one was shorter than
7769      * the other) ended with everything above it not in its set.  That means
7770      * that the remaining part of the union is precisely the same as the
7771      * non-exhausted list, so can just copy it unchanged.  (If both list were
7772      * exhausted at the same time, then the operations below will be both 0.)
7773      */
7774     if (count == 0) {
7775         IV copy_count; /* At most one will have a non-zero copy count */
7776         if ((copy_count = len_a - i_a) > 0) {
7777             Copy(array_a + i_a, array_u + i_u, copy_count, UV);
7778         }
7779         else if ((copy_count = len_b - i_b) > 0) {
7780             Copy(array_b + i_b, array_u + i_u, copy_count, UV);
7781         }
7782     }
7783
7784     /*  We may be removing a reference to one of the inputs */
7785     if (a == *output || b == *output) {
7786         assert(! invlist_is_iterating(*output));
7787         SvREFCNT_dec_NN(*output);
7788     }
7789
7790     *output = u;
7791     return;
7792 }
7793
7794 void
7795 Perl__invlist_intersection_maybe_complement_2nd(pTHX_ SV* const a, SV* const b, const bool complement_b, SV** i)
7796 {
7797     /* Take the intersection of two inversion lists and point <i> to it.  *i
7798      * SHOULD BE DEFINED upon input, and if it points to one of the two lists,
7799      * the reference count to that list will be decremented.
7800      * If <complement_b> is TRUE, the result will be the intersection of <a>
7801      * and the complement (or inversion) of <b> instead of <b> directly.
7802      *
7803      * The basis for this comes from "Unicode Demystified" Chapter 13 by
7804      * Richard Gillam, published by Addison-Wesley, and explained at some
7805      * length there.  The preface says to incorporate its examples into your
7806      * code at your own risk.  In fact, it had bugs
7807      *
7808      * The algorithm is like a merge sort, and is essentially the same as the
7809      * union above
7810      */
7811
7812     const UV* array_a;          /* a's array */
7813     const UV* array_b;
7814     UV len_a;   /* length of a's array */
7815     UV len_b;
7816
7817     SV* r;                   /* the resulting intersection */
7818     UV* array_r;
7819     UV len_r;
7820
7821     UV i_a = 0;             /* current index into a's array */
7822     UV i_b = 0;
7823     UV i_r = 0;
7824
7825     /* running count, as explained in the algorithm source book; items are
7826      * stopped accumulating and are output when the count changes to/from 2.
7827      * The count is incremented when we start a range that's in the set, and
7828      * decremented when we start a range that's not in the set.  So its range
7829      * is 0 to 2.  Only when the count is 2 is something in the intersection.
7830      */
7831     UV count = 0;
7832
7833     PERL_ARGS_ASSERT__INVLIST_INTERSECTION_MAYBE_COMPLEMENT_2ND;
7834     assert(a != b);
7835
7836     /* Special case if either one is empty */
7837     len_a = (a == NULL) ? 0 : _invlist_len(a);
7838     if ((len_a == 0) || ((len_b = _invlist_len(b)) == 0)) {
7839
7840         if (len_a != 0 && complement_b) {
7841
7842             /* Here, 'a' is not empty, therefore from the above 'if', 'b' must
7843              * be empty.  Here, also we are using 'b's complement, which hence
7844              * must be every possible code point.  Thus the intersection is
7845              * simply 'a'. */
7846             if (*i != a) {
7847                 *i = invlist_clone(a);
7848
7849                 if (*i == b) {
7850                     SvREFCNT_dec_NN(b);
7851                 }
7852             }
7853             /* else *i is already 'a' */
7854             return;
7855         }
7856
7857         /* Here, 'a' or 'b' is empty and not using the complement of 'b'.  The
7858          * intersection must be empty */
7859         if (*i == a) {
7860             SvREFCNT_dec_NN(a);
7861         }
7862         else if (*i == b) {
7863             SvREFCNT_dec_NN(b);
7864         }
7865         *i = _new_invlist(0);
7866         return;
7867     }
7868
7869     /* Here both lists exist and are non-empty */
7870     array_a = invlist_array(a);
7871     array_b = invlist_array(b);
7872
7873     /* If are to take the intersection of 'a' with the complement of b, set it
7874      * up so are looking at b's complement. */
7875     if (complement_b) {
7876
7877         /* To complement, we invert: if the first element is 0, remove it.  To
7878          * do this, we just pretend the array starts one later */
7879         if (array_b[0] == 0) {
7880             array_b++;
7881             len_b--;
7882         }
7883         else {
7884
7885             /* But if the first element is not zero, we pretend the list starts
7886              * at the 0 that is always stored immediately before the array. */
7887             array_b--;
7888             len_b++;
7889         }
7890     }
7891
7892     /* Size the intersection for the worst case: that the intersection ends up
7893      * fragmenting everything to be completely disjoint */
7894     r= _new_invlist(len_a + len_b);
7895
7896     /* Will contain U+0000 iff both components do */
7897     array_r = _invlist_array_init(r, len_a > 0 && array_a[0] == 0
7898                                      && len_b > 0 && array_b[0] == 0);
7899
7900     /* Go through each list item by item, stopping when exhausted one of
7901      * them */
7902     while (i_a < len_a && i_b < len_b) {
7903         UV cp;      /* The element to potentially add to the intersection's
7904                        array */
7905         bool cp_in_set; /* Is it in the input list's set or not */
7906
7907         /* We need to take one or the other of the two inputs for the
7908          * intersection.  Since we are merging two sorted lists, we take the
7909          * smaller of the next items.  In case of a tie, we take the one that
7910          * is not in its set first (a difference from the union algorithm).  If
7911          * we took one in the set first, it would increment the count, possibly
7912          * to 2 which would cause it to be output as starting a range in the
7913          * intersection, and the next time through we would take that same
7914          * number, and output it again as ending the set.  By doing it the
7915          * opposite of this, there is no possibility that the count will be
7916          * momentarily incremented to 2.  (In a tie and both are in the set or
7917          * both not in the set, it doesn't matter which we take first.) */
7918         if (array_a[i_a] < array_b[i_b]
7919             || (array_a[i_a] == array_b[i_b]
7920                 && ! ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
7921         {
7922             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
7923             cp= array_a[i_a++];
7924         }
7925         else {
7926             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
7927             cp= array_b[i_b++];
7928         }
7929
7930         /* Here, have chosen which of the two inputs to look at.  Only output
7931          * if the running count changes to/from 2, which marks the
7932          * beginning/end of a range that's in the intersection */
7933         if (cp_in_set) {
7934             count++;
7935             if (count == 2) {
7936                 array_r[i_r++] = cp;
7937             }
7938         }
7939         else {
7940             if (count == 2) {
7941                 array_r[i_r++] = cp;
7942             }
7943             count--;
7944         }
7945     }
7946
7947     /* Here, we are finished going through at least one of the lists, which
7948      * means there is something remaining in at most one.  We check if the list
7949      * that has been exhausted is positioned such that we are in the middle
7950      * of a range in its set or not.  (i_a and i_b point to elements 1 beyond
7951      * the ones we care about.)  There are four cases:
7952      *  1) Both weren't in their sets, count is 0, and remains 0.  There's
7953      *     nothing left in the intersection.
7954      *  2) Both were in their sets, count is 2 and perhaps is incremented to
7955      *     above 2.  What should be output is exactly that which is in the
7956      *     non-exhausted set, as everything it has is also in the intersection
7957      *     set, and everything it doesn't have can't be in the intersection
7958      *  3) The exhausted was in its set, non-exhausted isn't, count is 1, and
7959      *     gets incremented to 2.  Like the previous case, the intersection is
7960      *     everything that remains in the non-exhausted set.
7961      *  4) the exhausted wasn't in its set, non-exhausted is, count is 1, and
7962      *     remains 1.  And the intersection has nothing more. */
7963     if ((i_a == len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
7964         || (i_b == len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
7965     {
7966         count++;
7967     }
7968
7969     /* The final length is what we've output so far plus what else is in the
7970      * intersection.  At most one of the subexpressions below will be non-zero */
7971     len_r = i_r;
7972     if (count >= 2) {
7973         len_r += (len_a - i_a) + (len_b - i_b);
7974     }
7975
7976     /* Set result to final length, which can change the pointer to array_r, so
7977      * re-find it */
7978     if (len_r != _invlist_len(r)) {
7979         invlist_set_len(r, len_r, *get_invlist_offset_addr(r));
7980         invlist_trim(r);
7981         array_r = invlist_array(r);
7982     }
7983
7984     /* Finish outputting any remaining */
7985     if (count >= 2) { /* At most one will have a non-zero copy count */
7986         IV copy_count;
7987         if ((copy_count = len_a - i_a) > 0) {
7988             Copy(array_a + i_a, array_r + i_r, copy_count, UV);
7989         }
7990         else if ((copy_count = len_b - i_b) > 0) {
7991             Copy(array_b + i_b, array_r + i_r, copy_count, UV);
7992         }
7993     }
7994
7995     /*  We may be removing a reference to one of the inputs */
7996     if (a == *i || b == *i) {
7997         assert(! invlist_is_iterating(*i));
7998         SvREFCNT_dec_NN(*i);
7999     }
8000
8001     *i = r;
8002     return;
8003 }
8004
8005 SV*
8006 Perl__add_range_to_invlist(pTHX_ SV* invlist, const UV start, const UV end)
8007 {
8008     /* Add the range from 'start' to 'end' inclusive to the inversion list's
8009      * set.  A pointer to the inversion list is returned.  This may actually be
8010      * a new list, in which case the passed in one has been destroyed.  The
8011      * passed in inversion list can be NULL, in which case a new one is created
8012      * with just the one range in it */
8013
8014     SV* range_invlist;
8015     UV len;
8016
8017     if (invlist == NULL) {
8018         invlist = _new_invlist(2);
8019         len = 0;
8020     }
8021     else {
8022         len = _invlist_len(invlist);
8023     }
8024
8025     /* If comes after the final entry actually in the list, can just append it
8026      * to the end, */
8027     if (len == 0
8028         || (! ELEMENT_RANGE_MATCHES_INVLIST(len - 1)
8029             && start >= invlist_array(invlist)[len - 1]))
8030     {
8031         _append_range_to_invlist(invlist, start, end);
8032         return invlist;
8033     }
8034
8035     /* Here, can't just append things, create and return a new inversion list
8036      * which is the union of this range and the existing inversion list */
8037     range_invlist = _new_invlist(2);
8038     _append_range_to_invlist(range_invlist, start, end);
8039
8040     _invlist_union(invlist, range_invlist, &invlist);
8041
8042     /* The temporary can be freed */
8043     SvREFCNT_dec_NN(range_invlist);
8044
8045     return invlist;
8046 }
8047
8048 #endif
8049
8050 PERL_STATIC_INLINE SV*
8051 S_add_cp_to_invlist(pTHX_ SV* invlist, const UV cp) {
8052     return _add_range_to_invlist(invlist, cp, cp);
8053 }
8054
8055 #ifndef PERL_IN_XSUB_RE
8056 void
8057 Perl__invlist_invert(pTHX_ SV* const invlist)
8058 {
8059     /* Complement the input inversion list.  This adds a 0 if the list didn't
8060      * have a zero; removes it otherwise.  As described above, the data
8061      * structure is set up so that this is very efficient */
8062
8063     PERL_ARGS_ASSERT__INVLIST_INVERT;
8064
8065     assert(! invlist_is_iterating(invlist));
8066
8067     /* The inverse of matching nothing is matching everything */
8068     if (_invlist_len(invlist) == 0) {
8069         _append_range_to_invlist(invlist, 0, UV_MAX);
8070         return;
8071     }
8072
8073     *get_invlist_offset_addr(invlist) = ! *get_invlist_offset_addr(invlist);
8074 }
8075
8076 void
8077 Perl__invlist_invert_prop(pTHX_ SV* const invlist)
8078 {
8079     /* Complement the input inversion list (which must be a Unicode property,
8080      * all of which don't match above the Unicode maximum code point.)  And
8081      * Perl has chosen to not have the inversion match above that either.  This
8082      * adds a 0x110000 if the list didn't end with it, and removes it if it did
8083      */
8084
8085     UV len;
8086     UV* array;
8087
8088     PERL_ARGS_ASSERT__INVLIST_INVERT_PROP;
8089
8090     _invlist_invert(invlist);
8091
8092     len = _invlist_len(invlist);
8093
8094     if (len != 0) { /* If empty do nothing */
8095         array = invlist_array(invlist);
8096         if (array[len - 1] != PERL_UNICODE_MAX + 1) {
8097             /* Add 0x110000.  First, grow if necessary */
8098             len++;
8099             if (invlist_max(invlist) < len) {
8100                 invlist_extend(invlist, len);
8101                 array = invlist_array(invlist);
8102             }
8103             invlist_set_len(invlist, len, *get_invlist_offset_addr(invlist));
8104             array[len - 1] = PERL_UNICODE_MAX + 1;
8105         }
8106         else {  /* Remove the 0x110000 */
8107             invlist_set_len(invlist, len - 1, *get_invlist_offset_addr(invlist));
8108         }
8109     }
8110
8111     return;
8112 }
8113 #endif
8114
8115 PERL_STATIC_INLINE SV*
8116 S_invlist_clone(pTHX_ SV* const invlist)
8117 {
8118
8119     /* Return a new inversion list that is a copy of the input one, which is
8120      * unchanged */
8121
8122     /* Need to allocate extra space to accommodate Perl's addition of a
8123      * trailing NUL to SvPV's, since it thinks they are always strings */
8124     SV* new_invlist = _new_invlist(_invlist_len(invlist) + 1);
8125     STRLEN physical_length = SvCUR(invlist);
8126     bool offset = *(get_invlist_offset_addr(invlist));
8127
8128     PERL_ARGS_ASSERT_INVLIST_CLONE;
8129
8130     *(get_invlist_offset_addr(new_invlist)) = offset;
8131     invlist_set_len(new_invlist, _invlist_len(invlist), offset);
8132     Copy(SvPVX(invlist), SvPVX(new_invlist), physical_length, char);
8133
8134     return new_invlist;
8135 }
8136
8137 PERL_STATIC_INLINE STRLEN*
8138 S_get_invlist_iter_addr(pTHX_ SV* invlist)
8139 {
8140     /* Return the address of the UV that contains the current iteration
8141      * position */
8142
8143     PERL_ARGS_ASSERT_GET_INVLIST_ITER_ADDR;
8144
8145     assert(SvTYPE(invlist) == SVt_INVLIST);
8146
8147     return &(((XINVLIST*) SvANY(invlist))->iterator);
8148 }
8149
8150 PERL_STATIC_INLINE void
8151 S_invlist_iterinit(pTHX_ SV* invlist)   /* Initialize iterator for invlist */
8152 {
8153     PERL_ARGS_ASSERT_INVLIST_ITERINIT;
8154
8155     *get_invlist_iter_addr(invlist) = 0;
8156 }
8157
8158 PERL_STATIC_INLINE void
8159 S_invlist_iterfinish(pTHX_ SV* invlist)
8160 {
8161     /* Terminate iterator for invlist.  This is to catch development errors.
8162      * Any iteration that is interrupted before completed should call this
8163      * function.  Functions that add code points anywhere else but to the end
8164      * of an inversion list assert that they are not in the middle of an
8165      * iteration.  If they were, the addition would make the iteration
8166      * problematical: if the iteration hadn't reached the place where things
8167      * were being added, it would be ok */
8168
8169     PERL_ARGS_ASSERT_INVLIST_ITERFINISH;
8170
8171     *get_invlist_iter_addr(invlist) = (STRLEN) UV_MAX;
8172 }
8173
8174 STATIC bool
8175 S_invlist_iternext(pTHX_ SV* invlist, UV* start, UV* end)
8176 {
8177     /* An C<invlist_iterinit> call on <invlist> must be used to set this up.
8178      * This call sets in <*start> and <*end>, the next range in <invlist>.
8179      * Returns <TRUE> if successful and the next call will return the next
8180      * range; <FALSE> if was already at the end of the list.  If the latter,
8181      * <*start> and <*end> are unchanged, and the next call to this function
8182      * will start over at the beginning of the list */
8183
8184     STRLEN* pos = get_invlist_iter_addr(invlist);
8185     UV len = _invlist_len(invlist);
8186     UV *array;
8187
8188     PERL_ARGS_ASSERT_INVLIST_ITERNEXT;
8189
8190     if (*pos >= len) {
8191         *pos = (STRLEN) UV_MAX; /* Force iterinit() to be required next time */
8192         return FALSE;
8193     }
8194
8195     array = invlist_array(invlist);
8196
8197     *start = array[(*pos)++];
8198
8199     if (*pos >= len) {
8200         *end = UV_MAX;
8201     }
8202     else {
8203         *end = array[(*pos)++] - 1;
8204     }
8205
8206     return TRUE;
8207 }
8208
8209 PERL_STATIC_INLINE bool
8210 S_invlist_is_iterating(pTHX_ SV* const invlist)
8211 {
8212     PERL_ARGS_ASSERT_INVLIST_IS_ITERATING;
8213
8214     return *(get_invlist_iter_addr(invlist)) < (STRLEN) UV_MAX;
8215 }
8216
8217 PERL_STATIC_INLINE UV
8218 S_invlist_highest(pTHX_ SV* const invlist)
8219 {
8220     /* Returns the highest code point that matches an inversion list.  This API
8221      * has an ambiguity, as it returns 0 under either the highest is actually
8222      * 0, or if the list is empty.  If this distinction matters to you, check
8223      * for emptiness before calling this function */
8224
8225     UV len = _invlist_len(invlist);
8226     UV *array;
8227
8228     PERL_ARGS_ASSERT_INVLIST_HIGHEST;
8229
8230     if (len == 0) {
8231         return 0;
8232     }
8233
8234     array = invlist_array(invlist);
8235
8236     /* The last element in the array in the inversion list always starts a
8237      * range that goes to infinity.  That range may be for code points that are
8238      * matched in the inversion list, or it may be for ones that aren't
8239      * matched.  In the latter case, the highest code point in the set is one
8240      * less than the beginning of this range; otherwise it is the final element
8241      * of this range: infinity */
8242     return (ELEMENT_RANGE_MATCHES_INVLIST(len - 1))
8243            ? UV_MAX
8244            : array[len - 1] - 1;
8245 }
8246
8247 #ifndef PERL_IN_XSUB_RE
8248 SV *
8249 Perl__invlist_contents(pTHX_ SV* const invlist)
8250 {
8251     /* Get the contents of an inversion list into a string SV so that they can
8252      * be printed out.  It uses the format traditionally done for debug tracing
8253      */
8254
8255     UV start, end;
8256     SV* output = newSVpvs("\n");
8257
8258     PERL_ARGS_ASSERT__INVLIST_CONTENTS;
8259
8260     assert(! invlist_is_iterating(invlist));
8261
8262     invlist_iterinit(invlist);
8263     while (invlist_iternext(invlist, &start, &end)) {
8264         if (end == UV_MAX) {
8265             Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\tINFINITY\n", start);
8266         }
8267         else if (end != start) {
8268             Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\t%04"UVXf"\n",
8269                     start,       end);
8270         }
8271         else {
8272             Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\n", start);
8273         }
8274     }
8275
8276     return output;
8277 }
8278 #endif
8279
8280 #ifdef PERL_ARGS_ASSERT__INVLIST_DUMP
8281 void
8282 Perl__invlist_dump(pTHX_ SV* const invlist, const char * const header)
8283 {
8284     /* Dumps out the ranges in an inversion list.  The string 'header'
8285      * if present is output on a line before the first range */
8286
8287     UV start, end;
8288
8289     PERL_ARGS_ASSERT__INVLIST_DUMP;
8290
8291     if (header && strlen(header)) {
8292         PerlIO_printf(Perl_debug_log, "%s\n", header);
8293     }
8294     if (invlist_is_iterating(invlist)) {
8295         PerlIO_printf(Perl_debug_log, "Can't dump because is in middle of iterating\n");
8296         return;
8297     }
8298
8299     invlist_iterinit(invlist);
8300     while (invlist_iternext(invlist, &start, &end)) {
8301         if (end == UV_MAX) {
8302             PerlIO_printf(Perl_debug_log, "0x%04"UVXf" .. INFINITY\n", start);
8303         }
8304         else if (end != start) {
8305             PerlIO_printf(Perl_debug_log, "0x%04"UVXf" .. 0x%04"UVXf"\n",
8306                                                  start,         end);
8307         }
8308         else {
8309             PerlIO_printf(Perl_debug_log, "0x%04"UVXf"\n", start);
8310         }
8311     }
8312 }
8313 #endif
8314
8315 #if 0
8316 bool
8317 S__invlistEQ(pTHX_ SV* const a, SV* const b, const bool complement_b)
8318 {
8319     /* Return a boolean as to if the two passed in inversion lists are
8320      * identical.  The final argument, if TRUE, says to take the complement of
8321      * the second inversion list before doing the comparison */
8322
8323     const UV* array_a = invlist_array(a);
8324     const UV* array_b = invlist_array(b);
8325     UV len_a = _invlist_len(a);
8326     UV len_b = _invlist_len(b);
8327
8328     UV i = 0;               /* current index into the arrays */
8329     bool retval = TRUE;     /* Assume are identical until proven otherwise */
8330
8331     PERL_ARGS_ASSERT__INVLISTEQ;
8332
8333     /* If are to compare 'a' with the complement of b, set it
8334      * up so are looking at b's complement. */
8335     if (complement_b) {
8336
8337         /* The complement of nothing is everything, so <a> would have to have
8338          * just one element, starting at zero (ending at infinity) */
8339         if (len_b == 0) {
8340             return (len_a == 1 && array_a[0] == 0);
8341         }
8342         else if (array_b[0] == 0) {
8343
8344             /* Otherwise, to complement, we invert.  Here, the first element is
8345              * 0, just remove it.  To do this, we just pretend the array starts
8346              * one later */
8347
8348             array_b++;
8349             len_b--;
8350         }
8351         else {
8352
8353             /* But if the first element is not zero, we pretend the list starts
8354              * at the 0 that is always stored immediately before the array. */
8355             array_b--;
8356             len_b++;
8357         }
8358     }
8359
8360     /* Make sure that the lengths are the same, as well as the final element
8361      * before looping through the remainder.  (Thus we test the length, final,
8362      * and first elements right off the bat) */
8363     if (len_a != len_b || array_a[len_a-1] != array_b[len_a-1]) {
8364         retval = FALSE;
8365     }
8366     else for (i = 0; i < len_a - 1; i++) {
8367         if (array_a[i] != array_b[i]) {
8368             retval = FALSE;
8369             break;
8370         }
8371     }
8372
8373     return retval;
8374 }
8375 #endif
8376
8377 #undef HEADER_LENGTH
8378 #undef TO_INTERNAL_SIZE
8379 #undef FROM_INTERNAL_SIZE
8380 #undef INVLIST_VERSION_ID
8381
8382 /* End of inversion list object */
8383
8384 STATIC void
8385 S_parse_lparen_question_flags(pTHX_ struct RExC_state_t *pRExC_state)
8386 {
8387     /* This parses the flags that are in either the '(?foo)' or '(?foo:bar)'
8388      * constructs, and updates RExC_flags with them.  On input, RExC_parse
8389      * should point to the first flag; it is updated on output to point to the
8390      * final ')' or ':'.  There needs to be at least one flag, or this will
8391      * abort */
8392
8393     /* for (?g), (?gc), and (?o) warnings; warning
8394        about (?c) will warn about (?g) -- japhy    */
8395
8396 #define WASTED_O  0x01
8397 #define WASTED_G  0x02
8398 #define WASTED_C  0x04
8399 #define WASTED_GC (WASTED_G|WASTED_C)
8400     I32 wastedflags = 0x00;
8401     U32 posflags = 0, negflags = 0;
8402     U32 *flagsp = &posflags;
8403     char has_charset_modifier = '\0';
8404     regex_charset cs;
8405     bool has_use_defaults = FALSE;
8406     const char* const seqstart = RExC_parse - 1; /* Point to the '?' */
8407
8408     PERL_ARGS_ASSERT_PARSE_LPAREN_QUESTION_FLAGS;
8409
8410     /* '^' as an initial flag sets certain defaults */
8411     if (UCHARAT(RExC_parse) == '^') {
8412         RExC_parse++;
8413         has_use_defaults = TRUE;
8414         STD_PMMOD_FLAGS_CLEAR(&RExC_flags);
8415         set_regex_charset(&RExC_flags, (RExC_utf8 || RExC_uni_semantics)
8416                                         ? REGEX_UNICODE_CHARSET
8417                                         : REGEX_DEPENDS_CHARSET);
8418     }
8419
8420     cs = get_regex_charset(RExC_flags);
8421     if (cs == REGEX_DEPENDS_CHARSET
8422         && (RExC_utf8 || RExC_uni_semantics))
8423     {
8424         cs = REGEX_UNICODE_CHARSET;
8425     }
8426
8427     while (*RExC_parse) {
8428         /* && strchr("iogcmsx", *RExC_parse) */
8429         /* (?g), (?gc) and (?o) are useless here
8430            and must be globally applied -- japhy */
8431         switch (*RExC_parse) {
8432
8433             /* Code for the imsx flags */
8434             CASE_STD_PMMOD_FLAGS_PARSE_SET(flagsp);
8435
8436             case LOCALE_PAT_MOD:
8437                 if (has_charset_modifier) {
8438                     goto excess_modifier;
8439                 }
8440                 else if (flagsp == &negflags) {
8441                     goto neg_modifier;
8442                 }
8443                 cs = REGEX_LOCALE_CHARSET;
8444                 has_charset_modifier = LOCALE_PAT_MOD;
8445                 RExC_contains_locale = 1;
8446                 break;
8447             case UNICODE_PAT_MOD:
8448                 if (has_charset_modifier) {
8449                     goto excess_modifier;
8450                 }
8451                 else if (flagsp == &negflags) {
8452                     goto neg_modifier;
8453                 }
8454                 cs = REGEX_UNICODE_CHARSET;
8455                 has_charset_modifier = UNICODE_PAT_MOD;
8456                 break;
8457             case ASCII_RESTRICT_PAT_MOD:
8458                 if (flagsp == &negflags) {
8459                     goto neg_modifier;
8460                 }
8461                 if (has_charset_modifier) {
8462                     if (cs != REGEX_ASCII_RESTRICTED_CHARSET) {
8463                         goto excess_modifier;
8464                     }
8465                     /* Doubled modifier implies more restricted */
8466                     cs = REGEX_ASCII_MORE_RESTRICTED_CHARSET;
8467                 }
8468                 else {
8469                     cs = REGEX_ASCII_RESTRICTED_CHARSET;
8470                 }
8471                 has_charset_modifier = ASCII_RESTRICT_PAT_MOD;
8472                 break;
8473             case DEPENDS_PAT_MOD:
8474                 if (has_use_defaults) {
8475                     goto fail_modifiers;
8476                 }
8477                 else if (flagsp == &negflags) {
8478                     goto neg_modifier;
8479                 }
8480                 else if (has_charset_modifier) {
8481                     goto excess_modifier;
8482                 }
8483
8484                 /* The dual charset means unicode semantics if the
8485                  * pattern (or target, not known until runtime) are
8486                  * utf8, or something in the pattern indicates unicode
8487                  * semantics */
8488                 cs = (RExC_utf8 || RExC_uni_semantics)
8489                      ? REGEX_UNICODE_CHARSET
8490                      : REGEX_DEPENDS_CHARSET;
8491                 has_charset_modifier = DEPENDS_PAT_MOD;
8492                 break;
8493             excess_modifier:
8494                 RExC_parse++;
8495                 if (has_charset_modifier == ASCII_RESTRICT_PAT_MOD) {
8496                     vFAIL2("Regexp modifier \"%c\" may appear a maximum of twice", ASCII_RESTRICT_PAT_MOD);
8497                 }
8498                 else if (has_charset_modifier == *(RExC_parse - 1)) {
8499                     vFAIL2("Regexp modifier \"%c\" may not appear twice", *(RExC_parse - 1));
8500                 }
8501                 else {
8502                     vFAIL3("Regexp modifiers \"%c\" and \"%c\" are mutually exclusive", has_charset_modifier, *(RExC_parse - 1));
8503                 }
8504                 /*NOTREACHED*/
8505             neg_modifier:
8506                 RExC_parse++;
8507                 vFAIL2("Regexp modifier \"%c\" may not appear after the \"-\"", *(RExC_parse - 1));
8508                 /*NOTREACHED*/
8509             case ONCE_PAT_MOD: /* 'o' */
8510             case GLOBAL_PAT_MOD: /* 'g' */
8511                 if (SIZE_ONLY && ckWARN(WARN_REGEXP)) {
8512                     const I32 wflagbit = *RExC_parse == 'o' ? WASTED_O : WASTED_G;
8513                     if (! (wastedflags & wflagbit) ) {
8514                         wastedflags |= wflagbit;
8515                         /* diag_listed_as: Useless (?-%s) - don't use /%s modifier in regex; marked by <-- HERE in m/%s/ */
8516                         vWARN5(
8517                             RExC_parse + 1,
8518                             "Useless (%s%c) - %suse /%c modifier",
8519                             flagsp == &negflags ? "?-" : "?",
8520                             *RExC_parse,
8521                             flagsp == &negflags ? "don't " : "",
8522                             *RExC_parse
8523                         );
8524                     }
8525                 }
8526                 break;
8527
8528             case CONTINUE_PAT_MOD: /* 'c' */
8529                 if (SIZE_ONLY && ckWARN(WARN_REGEXP)) {
8530                     if (! (wastedflags & WASTED_C) ) {
8531                         wastedflags |= WASTED_GC;
8532                         /* diag_listed_as: Useless (?-%s) - don't use /%s modifier in regex; marked by <-- HERE in m/%s/ */
8533                         vWARN3(
8534                             RExC_parse + 1,
8535                             "Useless (%sc) - %suse /gc modifier",
8536                             flagsp == &negflags ? "?-" : "?",
8537                             flagsp == &negflags ? "don't " : ""
8538                         );
8539                     }
8540                 }
8541                 break;
8542             case KEEPCOPY_PAT_MOD: /* 'p' */
8543                 if (flagsp == &negflags) {
8544                     if (SIZE_ONLY)
8545                         ckWARNreg(RExC_parse + 1,"Useless use of (?-p)");
8546                 } else {
8547                     *flagsp |= RXf_PMf_KEEPCOPY;
8548                 }
8549                 break;
8550             case '-':
8551                 /* A flag is a default iff it is following a minus, so
8552                  * if there is a minus, it means will be trying to
8553                  * re-specify a default which is an error */
8554                 if (has_use_defaults || flagsp == &negflags) {
8555                     goto fail_modifiers;
8556                 }
8557                 flagsp = &negflags;
8558                 wastedflags = 0;  /* reset so (?g-c) warns twice */
8559                 break;
8560             case ':':
8561             case ')':
8562                 RExC_flags |= posflags;
8563                 RExC_flags &= ~negflags;
8564                 set_regex_charset(&RExC_flags, cs);
8565                 return;
8566                 /*NOTREACHED*/
8567             default:
8568             fail_modifiers:
8569                 RExC_parse++;
8570                 vFAIL3("Sequence (%.*s...) not recognized",
8571                        RExC_parse-seqstart, seqstart);
8572                 /*NOTREACHED*/
8573         }
8574
8575         ++RExC_parse;
8576     }
8577 }
8578
8579 /*
8580  - reg - regular expression, i.e. main body or parenthesized thing
8581  *
8582  * Caller must absorb opening parenthesis.
8583  *
8584  * Combining parenthesis handling with the base level of regular expression
8585  * is a trifle forced, but the need to tie the tails of the branches to what
8586  * follows makes it hard to avoid.
8587  */
8588 #define REGTAIL(x,y,z) regtail((x),(y),(z),depth+1)
8589 #ifdef DEBUGGING
8590 #define REGTAIL_STUDY(x,y,z) regtail_study((x),(y),(z),depth+1)
8591 #else
8592 #define REGTAIL_STUDY(x,y,z) regtail((x),(y),(z),depth+1)
8593 #endif
8594
8595 /* Returns NULL, setting *flagp to TRYAGAIN at the end of (?) that only sets
8596    flags. Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan
8597    needs to be restarted.
8598    Otherwise would only return NULL if regbranch() returns NULL, which
8599    cannot happen.  */
8600 STATIC regnode *
8601 S_reg(pTHX_ RExC_state_t *pRExC_state, I32 paren, I32 *flagp,U32 depth)
8602     /* paren: Parenthesized? 0=top; 1,2=inside '(': changed to letter.
8603      * 2 is like 1, but indicates that nextchar() has been called to advance
8604      * RExC_parse beyond the '('.  Things like '(?' are indivisible tokens, and
8605      * this flag alerts us to the need to check for that */
8606 {
8607     dVAR;
8608     regnode *ret;               /* Will be the head of the group. */
8609     regnode *br;
8610     regnode *lastbr;
8611     regnode *ender = NULL;
8612     I32 parno = 0;
8613     I32 flags;
8614     U32 oregflags = RExC_flags;
8615     bool have_branch = 0;
8616     bool is_open = 0;
8617     I32 freeze_paren = 0;
8618     I32 after_freeze = 0;
8619
8620     char * parse_start = RExC_parse; /* MJD */
8621     char * const oregcomp_parse = RExC_parse;
8622
8623     GET_RE_DEBUG_FLAGS_DECL;
8624
8625     PERL_ARGS_ASSERT_REG;
8626     DEBUG_PARSE("reg ");
8627
8628     *flagp = 0;                         /* Tentatively. */
8629
8630
8631     /* Make an OPEN node, if parenthesized. */
8632     if (paren) {
8633
8634         /* Under /x, space and comments can be gobbled up between the '(' and
8635          * here (if paren ==2).  The forms '(*VERB' and '(?...' disallow such
8636          * intervening space, as the sequence is a token, and a token should be
8637          * indivisible */
8638         bool has_intervening_patws = paren == 2 && *(RExC_parse - 1) != '(';
8639
8640         if ( *RExC_parse == '*') { /* (*VERB:ARG) */
8641             char *start_verb = RExC_parse;
8642             STRLEN verb_len = 0;
8643             char *start_arg = NULL;
8644             unsigned char op = 0;
8645             int argok = 1;
8646             int internal_argval = 0; /* internal_argval is only useful if !argok */
8647
8648             if (has_intervening_patws && SIZE_ONLY) {
8649                 ckWARNregdep(RExC_parse + 1, "In '(*VERB...)', splitting the initial '(*' is deprecated");
8650             }
8651             while ( *RExC_parse && *RExC_parse != ')' ) {
8652                 if ( *RExC_parse == ':' ) {
8653                     start_arg = RExC_parse + 1;
8654                     break;
8655                 }
8656                 RExC_parse++;
8657             }
8658             ++start_verb;
8659             verb_len = RExC_parse - start_verb;
8660             if ( start_arg ) {
8661                 RExC_parse++;
8662                 while ( *RExC_parse && *RExC_parse != ')' ) 
8663                     RExC_parse++;
8664                 if ( *RExC_parse != ')' ) 
8665                     vFAIL("Unterminated verb pattern argument");
8666                 if ( RExC_parse == start_arg )
8667                     start_arg = NULL;
8668             } else {
8669                 if ( *RExC_parse != ')' )
8670                     vFAIL("Unterminated verb pattern");
8671             }
8672             
8673             switch ( *start_verb ) {
8674             case 'A':  /* (*ACCEPT) */
8675                 if ( memEQs(start_verb,verb_len,"ACCEPT") ) {
8676                     op = ACCEPT;
8677                     internal_argval = RExC_nestroot;
8678                 }
8679                 break;
8680             case 'C':  /* (*COMMIT) */
8681                 if ( memEQs(start_verb,verb_len,"COMMIT") )
8682                     op = COMMIT;
8683                 break;
8684             case 'F':  /* (*FAIL) */
8685                 if ( verb_len==1 || memEQs(start_verb,verb_len,"FAIL") ) {
8686                     op = OPFAIL;
8687                     argok = 0;
8688                 }
8689                 break;
8690             case ':':  /* (*:NAME) */
8691             case 'M':  /* (*MARK:NAME) */
8692                 if ( verb_len==0 || memEQs(start_verb,verb_len,"MARK") ) {
8693                     op = MARKPOINT;
8694                     argok = -1;
8695                 }
8696                 break;
8697             case 'P':  /* (*PRUNE) */
8698                 if ( memEQs(start_verb,verb_len,"PRUNE") )
8699                     op = PRUNE;
8700                 break;
8701             case 'S':   /* (*SKIP) */  
8702                 if ( memEQs(start_verb,verb_len,"SKIP") ) 
8703                     op = SKIP;
8704                 break;
8705             case 'T':  /* (*THEN) */
8706                 /* [19:06] <TimToady> :: is then */
8707                 if ( memEQs(start_verb,verb_len,"THEN") ) {
8708                     op = CUTGROUP;
8709                     RExC_seen |= REG_SEEN_CUTGROUP;
8710                 }
8711                 break;
8712             }
8713             if ( ! op ) {
8714                 RExC_parse++;
8715                 vFAIL3("Unknown verb pattern '%.*s'",
8716                     verb_len, start_verb);
8717             }
8718             if ( argok ) {
8719                 if ( start_arg && internal_argval ) {
8720                     vFAIL3("Verb pattern '%.*s' may not have an argument",
8721                         verb_len, start_verb); 
8722                 } else if ( argok < 0 && !start_arg ) {
8723                     vFAIL3("Verb pattern '%.*s' has a mandatory argument",
8724                         verb_len, start_verb);    
8725                 } else {
8726                     ret = reganode(pRExC_state, op, internal_argval);
8727                     if ( ! internal_argval && ! SIZE_ONLY ) {
8728                         if (start_arg) {
8729                             SV *sv = newSVpvn( start_arg, RExC_parse - start_arg);
8730                             ARG(ret) = add_data( pRExC_state, 1, "S" );
8731                             RExC_rxi->data->data[ARG(ret)]=(void*)sv;
8732                             ret->flags = 0;
8733                         } else {
8734                             ret->flags = 1; 
8735                         }
8736                     }               
8737                 }
8738                 if (!internal_argval)
8739                     RExC_seen |= REG_SEEN_VERBARG;
8740             } else if ( start_arg ) {
8741                 vFAIL3("Verb pattern '%.*s' may not have an argument",
8742                         verb_len, start_verb);    
8743             } else {
8744                 ret = reg_node(pRExC_state, op);
8745             }
8746             nextchar(pRExC_state);
8747             return ret;
8748         }
8749         else if (*RExC_parse == '?') { /* (?...) */
8750             bool is_logical = 0;
8751             const char * const seqstart = RExC_parse;
8752             if (has_intervening_patws && SIZE_ONLY) {
8753                 ckWARNregdep(RExC_parse + 1, "In '(?...)', splitting the initial '(?' is deprecated");
8754             }
8755
8756             RExC_parse++;
8757             paren = *RExC_parse++;
8758             ret = NULL;                 /* For look-ahead/behind. */
8759             switch (paren) {
8760
8761             case 'P':   /* (?P...) variants for those used to PCRE/Python */
8762                 paren = *RExC_parse++;
8763                 if ( paren == '<')         /* (?P<...>) named capture */
8764                     goto named_capture;
8765                 else if (paren == '>') {   /* (?P>name) named recursion */
8766                     goto named_recursion;
8767                 }
8768                 else if (paren == '=') {   /* (?P=...)  named backref */
8769                     /* this pretty much dupes the code for \k<NAME> in regatom(), if
8770                        you change this make sure you change that */
8771                     char* name_start = RExC_parse;
8772                     U32 num = 0;
8773                     SV *sv_dat = reg_scan_name(pRExC_state,
8774                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
8775                     if (RExC_parse == name_start || *RExC_parse != ')')
8776                         vFAIL2("Sequence %.3s... not terminated",parse_start);
8777
8778                     if (!SIZE_ONLY) {
8779                         num = add_data( pRExC_state, 1, "S" );
8780                         RExC_rxi->data->data[num]=(void*)sv_dat;
8781                         SvREFCNT_inc_simple_void(sv_dat);
8782                     }
8783                     RExC_sawback = 1;
8784                     ret = reganode(pRExC_state,
8785                                    ((! FOLD)
8786                                      ? NREF
8787                                      : (ASCII_FOLD_RESTRICTED)
8788                                        ? NREFFA
8789                                        : (AT_LEAST_UNI_SEMANTICS)
8790                                          ? NREFFU
8791                                          : (LOC)
8792                                            ? NREFFL
8793                                            : NREFF),
8794                                     num);
8795                     *flagp |= HASWIDTH;
8796
8797                     Set_Node_Offset(ret, parse_start+1);
8798                     Set_Node_Cur_Length(ret, parse_start);
8799
8800                     nextchar(pRExC_state);
8801                     return ret;
8802                 }
8803                 RExC_parse++;
8804                 vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
8805                 /*NOTREACHED*/
8806             case '<':           /* (?<...) */
8807                 if (*RExC_parse == '!')
8808                     paren = ',';
8809                 else if (*RExC_parse != '=') 
8810               named_capture:
8811                 {               /* (?<...>) */
8812                     char *name_start;
8813                     SV *svname;
8814                     paren= '>';
8815             case '\'':          /* (?'...') */
8816                     name_start= RExC_parse;
8817                     svname = reg_scan_name(pRExC_state,
8818                         SIZE_ONLY ?  /* reverse test from the others */
8819                         REG_RSN_RETURN_NAME : 
8820                         REG_RSN_RETURN_NULL);
8821                     if (RExC_parse == name_start) {
8822                         RExC_parse++;
8823                         vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
8824                         /*NOTREACHED*/
8825                     }
8826                     if (*RExC_parse != paren)
8827                         vFAIL2("Sequence (?%c... not terminated",
8828                             paren=='>' ? '<' : paren);
8829                     if (SIZE_ONLY) {
8830                         HE *he_str;
8831                         SV *sv_dat = NULL;
8832                         if (!svname) /* shouldn't happen */
8833                             Perl_croak(aTHX_
8834                                 "panic: reg_scan_name returned NULL");
8835                         if (!RExC_paren_names) {
8836                             RExC_paren_names= newHV();
8837                             sv_2mortal(MUTABLE_SV(RExC_paren_names));
8838 #ifdef DEBUGGING
8839                             RExC_paren_name_list= newAV();
8840                             sv_2mortal(MUTABLE_SV(RExC_paren_name_list));
8841 #endif
8842                         }
8843                         he_str = hv_fetch_ent( RExC_paren_names, svname, 1, 0 );
8844                         if ( he_str )
8845                             sv_dat = HeVAL(he_str);
8846                         if ( ! sv_dat ) {
8847                             /* croak baby croak */
8848                             Perl_croak(aTHX_
8849                                 "panic: paren_name hash element allocation failed");
8850                         } else if ( SvPOK(sv_dat) ) {
8851                             /* (?|...) can mean we have dupes so scan to check
8852                                its already been stored. Maybe a flag indicating
8853                                we are inside such a construct would be useful,
8854                                but the arrays are likely to be quite small, so
8855                                for now we punt -- dmq */
8856                             IV count = SvIV(sv_dat);
8857                             I32 *pv = (I32*)SvPVX(sv_dat);
8858                             IV i;
8859                             for ( i = 0 ; i < count ; i++ ) {
8860                                 if ( pv[i] == RExC_npar ) {
8861                                     count = 0;
8862                                     break;
8863                                 }
8864                             }
8865                             if ( count ) {
8866                                 pv = (I32*)SvGROW(sv_dat, SvCUR(sv_dat) + sizeof(I32)+1);
8867                                 SvCUR_set(sv_dat, SvCUR(sv_dat) + sizeof(I32));
8868                                 pv[count] = RExC_npar;
8869                                 SvIV_set(sv_dat, SvIVX(sv_dat) + 1);
8870                             }
8871                         } else {
8872                             (void)SvUPGRADE(sv_dat,SVt_PVNV);
8873                             sv_setpvn(sv_dat, (char *)&(RExC_npar), sizeof(I32));
8874                             SvIOK_on(sv_dat);
8875                             SvIV_set(sv_dat, 1);
8876                         }
8877 #ifdef DEBUGGING
8878                         /* Yes this does cause a memory leak in debugging Perls */
8879                         if (!av_store(RExC_paren_name_list, RExC_npar, SvREFCNT_inc(svname)))
8880                             SvREFCNT_dec_NN(svname);
8881 #endif
8882
8883                         /*sv_dump(sv_dat);*/
8884                     }
8885                     nextchar(pRExC_state);
8886                     paren = 1;
8887                     goto capturing_parens;
8888                 }
8889                 RExC_seen |= REG_SEEN_LOOKBEHIND;
8890                 RExC_in_lookbehind++;
8891                 RExC_parse++;
8892             case '=':           /* (?=...) */
8893                 RExC_seen_zerolen++;
8894                 break;
8895             case '!':           /* (?!...) */
8896                 RExC_seen_zerolen++;
8897                 if (*RExC_parse == ')') {
8898                     ret=reg_node(pRExC_state, OPFAIL);
8899                     nextchar(pRExC_state);
8900                     return ret;
8901                 }
8902                 break;
8903             case '|':           /* (?|...) */
8904                 /* branch reset, behave like a (?:...) except that
8905                    buffers in alternations share the same numbers */
8906                 paren = ':'; 
8907                 after_freeze = freeze_paren = RExC_npar;
8908                 break;
8909             case ':':           /* (?:...) */
8910             case '>':           /* (?>...) */
8911                 break;
8912             case '$':           /* (?$...) */
8913             case '@':           /* (?@...) */
8914                 vFAIL2("Sequence (?%c...) not implemented", (int)paren);
8915                 break;
8916             case '#':           /* (?#...) */
8917                 /* XXX As soon as we disallow separating the '?' and '*' (by
8918                  * spaces or (?#...) comment), it is believed that this case
8919                  * will be unreachable and can be removed.  See
8920                  * [perl #117327] */
8921                 while (*RExC_parse && *RExC_parse != ')')
8922                     RExC_parse++;
8923                 if (*RExC_parse != ')')
8924                     FAIL("Sequence (?#... not terminated");
8925                 nextchar(pRExC_state);
8926                 *flagp = TRYAGAIN;
8927                 return NULL;
8928             case '0' :           /* (?0) */
8929             case 'R' :           /* (?R) */
8930                 if (*RExC_parse != ')')
8931                     FAIL("Sequence (?R) not terminated");
8932                 ret = reg_node(pRExC_state, GOSTART);
8933                 *flagp |= POSTPONED;
8934                 nextchar(pRExC_state);
8935                 return ret;
8936                 /*notreached*/
8937             { /* named and numeric backreferences */
8938                 I32 num;
8939             case '&':            /* (?&NAME) */
8940                 parse_start = RExC_parse - 1;
8941               named_recursion:
8942                 {
8943                     SV *sv_dat = reg_scan_name(pRExC_state,
8944                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
8945                      num = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
8946                 }
8947                 goto gen_recurse_regop;
8948                 assert(0); /* NOT REACHED */
8949             case '+':
8950                 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
8951                     RExC_parse++;
8952                     vFAIL("Illegal pattern");
8953                 }
8954                 goto parse_recursion;
8955                 /* NOT REACHED*/
8956             case '-': /* (?-1) */
8957                 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
8958                     RExC_parse--; /* rewind to let it be handled later */
8959                     goto parse_flags;
8960                 } 
8961                 /*FALLTHROUGH */
8962             case '1': case '2': case '3': case '4': /* (?1) */
8963             case '5': case '6': case '7': case '8': case '9':
8964                 RExC_parse--;
8965               parse_recursion:
8966                 num = atoi(RExC_parse);
8967                 parse_start = RExC_parse - 1; /* MJD */
8968                 if (*RExC_parse == '-')
8969                     RExC_parse++;
8970                 while (isDIGIT(*RExC_parse))
8971                         RExC_parse++;
8972                 if (*RExC_parse!=')') 
8973                     vFAIL("Expecting close bracket");
8974
8975               gen_recurse_regop:
8976                 if ( paren == '-' ) {
8977                     /*
8978                     Diagram of capture buffer numbering.
8979                     Top line is the normal capture buffer numbers
8980                     Bottom line is the negative indexing as from
8981                     the X (the (?-2))
8982
8983                     +   1 2    3 4 5 X          6 7
8984                        /(a(x)y)(a(b(c(?-2)d)e)f)(g(h))/
8985                     -   5 4    3 2 1 X          x x
8986
8987                     */
8988                     num = RExC_npar + num;
8989                     if (num < 1)  {
8990                         RExC_parse++;
8991                         vFAIL("Reference to nonexistent group");
8992                     }
8993                 } else if ( paren == '+' ) {
8994                     num = RExC_npar + num - 1;
8995                 }
8996
8997                 ret = reganode(pRExC_state, GOSUB, num);
8998                 if (!SIZE_ONLY) {
8999                     if (num > (I32)RExC_rx->nparens) {
9000                         RExC_parse++;
9001                         vFAIL("Reference to nonexistent group");
9002                     }
9003                     ARG2L_SET( ret, RExC_recurse_count++);
9004                     RExC_emit++;
9005                     DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
9006                         "Recurse #%"UVuf" to %"IVdf"\n", (UV)ARG(ret), (IV)ARG2L(ret)));
9007                 } else {
9008                     RExC_size++;
9009                 }
9010                 RExC_seen |= REG_SEEN_RECURSE;
9011                 Set_Node_Length(ret, 1 + regarglen[OP(ret)]); /* MJD */
9012                 Set_Node_Offset(ret, parse_start); /* MJD */
9013
9014                 *flagp |= POSTPONED;
9015                 nextchar(pRExC_state);
9016                 return ret;
9017             } /* named and numeric backreferences */
9018             assert(0); /* NOT REACHED */
9019
9020             case '?':           /* (??...) */
9021                 is_logical = 1;
9022                 if (*RExC_parse != '{') {
9023                     RExC_parse++;
9024                     vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
9025                     /*NOTREACHED*/
9026                 }
9027                 *flagp |= POSTPONED;
9028                 paren = *RExC_parse++;
9029                 /* FALL THROUGH */
9030             case '{':           /* (?{...}) */
9031             {
9032                 U32 n = 0;
9033                 struct reg_code_block *cb;
9034
9035                 RExC_seen_zerolen++;
9036
9037                 if (   !pRExC_state->num_code_blocks
9038                     || pRExC_state->code_index >= pRExC_state->num_code_blocks
9039                     || pRExC_state->code_blocks[pRExC_state->code_index].start
9040                         != (STRLEN)((RExC_parse -3 - (is_logical ? 1 : 0))
9041                             - RExC_start)
9042                 ) {
9043                     if (RExC_pm_flags & PMf_USE_RE_EVAL)
9044                         FAIL("panic: Sequence (?{...}): no code block found\n");
9045                     FAIL("Eval-group not allowed at runtime, use re 'eval'");
9046                 }
9047                 /* this is a pre-compiled code block (?{...}) */
9048                 cb = &pRExC_state->code_blocks[pRExC_state->code_index];
9049                 RExC_parse = RExC_start + cb->end;
9050                 if (!SIZE_ONLY) {
9051                     OP *o = cb->block;
9052                     if (cb->src_regex) {
9053                         n = add_data(pRExC_state, 2, "rl");
9054                         RExC_rxi->data->data[n] =
9055                             (void*)SvREFCNT_inc((SV*)cb->src_regex);
9056                         RExC_rxi->data->data[n+1] = (void*)o;
9057                     }
9058                     else {
9059                         n = add_data(pRExC_state, 1,
9060                                (RExC_pm_flags & PMf_HAS_CV) ? "L" : "l");
9061                         RExC_rxi->data->data[n] = (void*)o;
9062                     }
9063                 }
9064                 pRExC_state->code_index++;
9065                 nextchar(pRExC_state);
9066
9067                 if (is_logical) {
9068                     regnode *eval;
9069                     ret = reg_node(pRExC_state, LOGICAL);
9070                     eval = reganode(pRExC_state, EVAL, n);
9071                     if (!SIZE_ONLY) {
9072                         ret->flags = 2;
9073                         /* for later propagation into (??{}) return value */
9074                         eval->flags = (U8) (RExC_flags & RXf_PMf_COMPILETIME);
9075                     }
9076                     REGTAIL(pRExC_state, ret, eval);
9077                     /* deal with the length of this later - MJD */
9078                     return ret;
9079                 }
9080                 ret = reganode(pRExC_state, EVAL, n);
9081                 Set_Node_Length(ret, RExC_parse - parse_start + 1);
9082                 Set_Node_Offset(ret, parse_start);
9083                 return ret;
9084             }
9085             case '(':           /* (?(?{...})...) and (?(?=...)...) */
9086             {
9087                 int is_define= 0;
9088                 if (RExC_parse[0] == '?') {        /* (?(?...)) */
9089                     if (RExC_parse[1] == '=' || RExC_parse[1] == '!'
9090                         || RExC_parse[1] == '<'
9091                         || RExC_parse[1] == '{') { /* Lookahead or eval. */
9092                         I32 flag;
9093                         regnode *tail;
9094
9095                         ret = reg_node(pRExC_state, LOGICAL);
9096                         if (!SIZE_ONLY)
9097                             ret->flags = 1;
9098                         
9099                         tail = reg(pRExC_state, 1, &flag, depth+1);
9100                         if (flag & RESTART_UTF8) {
9101                             *flagp = RESTART_UTF8;
9102                             return NULL;
9103                         }
9104                         REGTAIL(pRExC_state, ret, tail);
9105                         goto insert_if;
9106                     }
9107                 }
9108                 else if ( RExC_parse[0] == '<'     /* (?(<NAME>)...) */
9109                          || RExC_parse[0] == '\'' ) /* (?('NAME')...) */
9110                 {
9111                     char ch = RExC_parse[0] == '<' ? '>' : '\'';
9112                     char *name_start= RExC_parse++;
9113                     U32 num = 0;
9114                     SV *sv_dat=reg_scan_name(pRExC_state,
9115                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
9116                     if (RExC_parse == name_start || *RExC_parse != ch)
9117                         vFAIL2("Sequence (?(%c... not terminated",
9118                             (ch == '>' ? '<' : ch));
9119                     RExC_parse++;
9120                     if (!SIZE_ONLY) {
9121                         num = add_data( pRExC_state, 1, "S" );
9122                         RExC_rxi->data->data[num]=(void*)sv_dat;
9123                         SvREFCNT_inc_simple_void(sv_dat);
9124                     }
9125                     ret = reganode(pRExC_state,NGROUPP,num);
9126                     goto insert_if_check_paren;
9127                 }
9128                 else if (RExC_parse[0] == 'D' &&
9129                          RExC_parse[1] == 'E' &&
9130                          RExC_parse[2] == 'F' &&
9131                          RExC_parse[3] == 'I' &&
9132                          RExC_parse[4] == 'N' &&
9133                          RExC_parse[5] == 'E')
9134                 {
9135                     ret = reganode(pRExC_state,DEFINEP,0);
9136                     RExC_parse +=6 ;
9137                     is_define = 1;
9138                     goto insert_if_check_paren;
9139                 }
9140                 else if (RExC_parse[0] == 'R') {
9141                     RExC_parse++;
9142                     parno = 0;
9143                     if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
9144                         parno = atoi(RExC_parse++);
9145                         while (isDIGIT(*RExC_parse))
9146                             RExC_parse++;
9147                     } else if (RExC_parse[0] == '&') {
9148                         SV *sv_dat;
9149                         RExC_parse++;
9150                         sv_dat = reg_scan_name(pRExC_state,
9151                             SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
9152                         parno = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
9153                     }
9154                     ret = reganode(pRExC_state,INSUBP,parno); 
9155                     goto insert_if_check_paren;
9156                 }
9157                 else if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
9158                     /* (?(1)...) */
9159                     char c;
9160                     parno = atoi(RExC_parse++);
9161
9162                     while (isDIGIT(*RExC_parse))
9163                         RExC_parse++;
9164                     ret = reganode(pRExC_state, GROUPP, parno);
9165
9166                  insert_if_check_paren:
9167                     if ((c = *nextchar(pRExC_state)) != ')')
9168                         vFAIL("Switch condition not recognized");
9169                   insert_if:
9170                     REGTAIL(pRExC_state, ret, reganode(pRExC_state, IFTHEN, 0));
9171                     br = regbranch(pRExC_state, &flags, 1,depth+1);
9172                     if (br == NULL) {
9173                         if (flags & RESTART_UTF8) {
9174                             *flagp = RESTART_UTF8;
9175                             return NULL;
9176                         }
9177                         FAIL2("panic: regbranch returned NULL, flags=%#"UVxf"",
9178                               (UV) flags);
9179                     } else
9180                         REGTAIL(pRExC_state, br, reganode(pRExC_state, LONGJMP, 0));
9181                     c = *nextchar(pRExC_state);
9182                     if (flags&HASWIDTH)
9183                         *flagp |= HASWIDTH;
9184                     if (c == '|') {
9185                         if (is_define) 
9186                             vFAIL("(?(DEFINE)....) does not allow branches");
9187                         lastbr = reganode(pRExC_state, IFTHEN, 0); /* Fake one for optimizer. */
9188                         if (!regbranch(pRExC_state, &flags, 1,depth+1)) {
9189                             if (flags & RESTART_UTF8) {
9190                                 *flagp = RESTART_UTF8;
9191                                 return NULL;
9192                             }
9193                             FAIL2("panic: regbranch returned NULL, flags=%#"UVxf"",
9194                                   (UV) flags);
9195                         }
9196                         REGTAIL(pRExC_state, ret, lastbr);
9197                         if (flags&HASWIDTH)
9198                             *flagp |= HASWIDTH;
9199                         c = *nextchar(pRExC_state);
9200                     }
9201                     else
9202                         lastbr = NULL;
9203                     if (c != ')')
9204                         vFAIL("Switch (?(condition)... contains too many branches");
9205                     ender = reg_node(pRExC_state, TAIL);
9206                     REGTAIL(pRExC_state, br, ender);
9207                     if (lastbr) {
9208                         REGTAIL(pRExC_state, lastbr, ender);
9209                         REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender);
9210                     }
9211                     else
9212                         REGTAIL(pRExC_state, ret, ender);
9213                     RExC_size++; /* XXX WHY do we need this?!!
9214                                     For large programs it seems to be required
9215                                     but I can't figure out why. -- dmq*/
9216                     return ret;
9217                 }
9218                 else {
9219                     vFAIL2("Unknown switch condition (?(%.2s", RExC_parse);
9220                 }
9221             }
9222             case '[':           /* (?[ ... ]) */
9223                 return handle_regex_sets(pRExC_state, NULL, flagp, depth,
9224                                          oregcomp_parse);
9225             case 0:
9226                 RExC_parse--; /* for vFAIL to print correctly */
9227                 vFAIL("Sequence (? incomplete");
9228                 break;
9229             default: /* e.g., (?i) */
9230                 --RExC_parse;
9231               parse_flags:
9232                 parse_lparen_question_flags(pRExC_state);
9233                 if (UCHARAT(RExC_parse) != ':') {
9234                     nextchar(pRExC_state);
9235                     *flagp = TRYAGAIN;
9236                     return NULL;
9237                 }
9238                 paren = ':';
9239                 nextchar(pRExC_state);
9240                 ret = NULL;
9241                 goto parse_rest;
9242             } /* end switch */
9243         }
9244         else {                  /* (...) */
9245           capturing_parens:
9246             parno = RExC_npar;
9247             RExC_npar++;
9248             
9249             ret = reganode(pRExC_state, OPEN, parno);
9250             if (!SIZE_ONLY ){
9251                 if (!RExC_nestroot) 
9252                     RExC_nestroot = parno;
9253                 if (RExC_seen & REG_SEEN_RECURSE
9254                     && !RExC_open_parens[parno-1])
9255                 {
9256                     DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
9257                         "Setting open paren #%"IVdf" to %d\n", 
9258                         (IV)parno, REG_NODE_NUM(ret)));
9259                     RExC_open_parens[parno-1]= ret;
9260                 }
9261             }
9262             Set_Node_Length(ret, 1); /* MJD */
9263             Set_Node_Offset(ret, RExC_parse); /* MJD */
9264             is_open = 1;
9265         }
9266     }
9267     else                        /* ! paren */
9268         ret = NULL;
9269    
9270    parse_rest:
9271     /* Pick up the branches, linking them together. */
9272     parse_start = RExC_parse;   /* MJD */
9273     br = regbranch(pRExC_state, &flags, 1,depth+1);
9274
9275     /*     branch_len = (paren != 0); */
9276
9277     if (br == NULL) {
9278         if (flags & RESTART_UTF8) {
9279             *flagp = RESTART_UTF8;
9280             return NULL;
9281         }
9282         FAIL2("panic: regbranch returned NULL, flags=%#"UVxf"", (UV) flags);
9283     }
9284     if (*RExC_parse == '|') {
9285         if (!SIZE_ONLY && RExC_extralen) {
9286             reginsert(pRExC_state, BRANCHJ, br, depth+1);
9287         }
9288         else {                  /* MJD */
9289             reginsert(pRExC_state, BRANCH, br, depth+1);
9290             Set_Node_Length(br, paren != 0);
9291             Set_Node_Offset_To_R(br-RExC_emit_start, parse_start-RExC_start);
9292         }
9293         have_branch = 1;
9294         if (SIZE_ONLY)
9295             RExC_extralen += 1;         /* For BRANCHJ-BRANCH. */
9296     }
9297     else if (paren == ':') {
9298         *flagp |= flags&SIMPLE;
9299     }
9300     if (is_open) {                              /* Starts with OPEN. */
9301         REGTAIL(pRExC_state, ret, br);          /* OPEN -> first. */
9302     }
9303     else if (paren != '?')              /* Not Conditional */
9304         ret = br;
9305     *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
9306     lastbr = br;
9307     while (*RExC_parse == '|') {
9308         if (!SIZE_ONLY && RExC_extralen) {
9309             ender = reganode(pRExC_state, LONGJMP,0);
9310             REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender); /* Append to the previous. */
9311         }
9312         if (SIZE_ONLY)
9313             RExC_extralen += 2;         /* Account for LONGJMP. */
9314         nextchar(pRExC_state);
9315         if (freeze_paren) {
9316             if (RExC_npar > after_freeze)
9317                 after_freeze = RExC_npar;
9318             RExC_npar = freeze_paren;       
9319         }
9320         br = regbranch(pRExC_state, &flags, 0, depth+1);
9321
9322         if (br == NULL) {
9323             if (flags & RESTART_UTF8) {
9324                 *flagp = RESTART_UTF8;
9325                 return NULL;
9326             }
9327             FAIL2("panic: regbranch returned NULL, flags=%#"UVxf"", (UV) flags);
9328         }
9329         REGTAIL(pRExC_state, lastbr, br);               /* BRANCH -> BRANCH. */
9330         lastbr = br;
9331         *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
9332     }
9333
9334     if (have_branch || paren != ':') {
9335         /* Make a closing node, and hook it on the end. */
9336         switch (paren) {
9337         case ':':
9338             ender = reg_node(pRExC_state, TAIL);
9339             break;
9340         case 1: case 2:
9341             ender = reganode(pRExC_state, CLOSE, parno);
9342             if (!SIZE_ONLY && RExC_seen & REG_SEEN_RECURSE) {
9343                 DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
9344                         "Setting close paren #%"IVdf" to %d\n", 
9345                         (IV)parno, REG_NODE_NUM(ender)));
9346                 RExC_close_parens[parno-1]= ender;
9347                 if (RExC_nestroot == parno) 
9348                     RExC_nestroot = 0;
9349             }       
9350             Set_Node_Offset(ender,RExC_parse+1); /* MJD */
9351             Set_Node_Length(ender,1); /* MJD */
9352             break;
9353         case '<':
9354         case ',':
9355         case '=':
9356         case '!':
9357             *flagp &= ~HASWIDTH;
9358             /* FALL THROUGH */
9359         case '>':
9360             ender = reg_node(pRExC_state, SUCCEED);
9361             break;
9362         case 0:
9363             ender = reg_node(pRExC_state, END);
9364             if (!SIZE_ONLY) {
9365                 assert(!RExC_opend); /* there can only be one! */
9366                 RExC_opend = ender;
9367             }
9368             break;
9369         }
9370         DEBUG_PARSE_r(if (!SIZE_ONLY) {
9371             SV * const mysv_val1=sv_newmortal();
9372             SV * const mysv_val2=sv_newmortal();
9373             DEBUG_PARSE_MSG("lsbr");
9374             regprop(RExC_rx, mysv_val1, lastbr);
9375             regprop(RExC_rx, mysv_val2, ender);
9376             PerlIO_printf(Perl_debug_log, "~ tying lastbr %s (%"IVdf") to ender %s (%"IVdf") offset %"IVdf"\n",
9377                           SvPV_nolen_const(mysv_val1),
9378                           (IV)REG_NODE_NUM(lastbr),
9379                           SvPV_nolen_const(mysv_val2),
9380                           (IV)REG_NODE_NUM(ender),
9381                           (IV)(ender - lastbr)
9382             );
9383         });
9384         REGTAIL(pRExC_state, lastbr, ender);
9385
9386         if (have_branch && !SIZE_ONLY) {
9387             char is_nothing= 1;
9388             if (depth==1)
9389                 RExC_seen |= REG_TOP_LEVEL_BRANCHES;
9390
9391             /* Hook the tails of the branches to the closing node. */
9392             for (br = ret; br; br = regnext(br)) {
9393                 const U8 op = PL_regkind[OP(br)];
9394                 if (op == BRANCH) {
9395                     REGTAIL_STUDY(pRExC_state, NEXTOPER(br), ender);
9396                     if (OP(NEXTOPER(br)) != NOTHING || regnext(NEXTOPER(br)) != ender)
9397                         is_nothing= 0;
9398                 }
9399                 else if (op == BRANCHJ) {
9400                     REGTAIL_STUDY(pRExC_state, NEXTOPER(NEXTOPER(br)), ender);
9401                     /* for now we always disable this optimisation * /
9402                     if (OP(NEXTOPER(NEXTOPER(br))) != NOTHING || regnext(NEXTOPER(NEXTOPER(br))) != ender)
9403                     */
9404                         is_nothing= 0;
9405                 }
9406             }
9407             if (is_nothing) {
9408                 br= PL_regkind[OP(ret)] != BRANCH ? regnext(ret) : ret;
9409                 DEBUG_PARSE_r(if (!SIZE_ONLY) {
9410                     SV * const mysv_val1=sv_newmortal();
9411                     SV * const mysv_val2=sv_newmortal();
9412                     DEBUG_PARSE_MSG("NADA");
9413                     regprop(RExC_rx, mysv_val1, ret);
9414                     regprop(RExC_rx, mysv_val2, ender);
9415                     PerlIO_printf(Perl_debug_log, "~ converting ret %s (%"IVdf") to ender %s (%"IVdf") offset %"IVdf"\n",
9416                                   SvPV_nolen_const(mysv_val1),
9417                                   (IV)REG_NODE_NUM(ret),
9418                                   SvPV_nolen_const(mysv_val2),
9419                                   (IV)REG_NODE_NUM(ender),
9420                                   (IV)(ender - ret)
9421                     );
9422                 });
9423                 OP(br)= NOTHING;
9424                 if (OP(ender) == TAIL) {
9425                     NEXT_OFF(br)= 0;
9426                     RExC_emit= br + 1;
9427                 } else {
9428                     regnode *opt;
9429                     for ( opt= br + 1; opt < ender ; opt++ )
9430                         OP(opt)= OPTIMIZED;
9431                     NEXT_OFF(br)= ender - br;
9432                 }
9433             }
9434         }
9435     }
9436
9437     {
9438         const char *p;
9439         static const char parens[] = "=!<,>";
9440
9441         if (paren && (p = strchr(parens, paren))) {
9442             U8 node = ((p - parens) % 2) ? UNLESSM : IFMATCH;
9443             int flag = (p - parens) > 1;
9444
9445             if (paren == '>')
9446                 node = SUSPEND, flag = 0;
9447             reginsert(pRExC_state, node,ret, depth+1);
9448             Set_Node_Cur_Length(ret, parse_start);
9449             Set_Node_Offset(ret, parse_start + 1);
9450             ret->flags = flag;
9451             REGTAIL_STUDY(pRExC_state, ret, reg_node(pRExC_state, TAIL));
9452         }
9453     }
9454
9455     /* Check for proper termination. */
9456     if (paren) {
9457         /* restore original flags, but keep (?p) */
9458         RExC_flags = oregflags | (RExC_flags & RXf_PMf_KEEPCOPY);
9459         if (RExC_parse >= RExC_end || *nextchar(pRExC_state) != ')') {
9460             RExC_parse = oregcomp_parse;
9461             vFAIL("Unmatched (");
9462         }
9463     }
9464     else if (!paren && RExC_parse < RExC_end) {
9465         if (*RExC_parse == ')') {
9466             RExC_parse++;
9467             vFAIL("Unmatched )");
9468         }
9469         else
9470             FAIL("Junk on end of regexp");      /* "Can't happen". */
9471         assert(0); /* NOTREACHED */
9472     }
9473
9474     if (RExC_in_lookbehind) {
9475         RExC_in_lookbehind--;
9476     }
9477     if (after_freeze > RExC_npar)
9478         RExC_npar = after_freeze;
9479     return(ret);
9480 }
9481
9482 /*
9483  - regbranch - one alternative of an | operator
9484  *
9485  * Implements the concatenation operator.
9486  *
9487  * Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan needs to be
9488  * restarted.
9489  */
9490 STATIC regnode *
9491 S_regbranch(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, I32 first, U32 depth)
9492 {
9493     dVAR;
9494     regnode *ret;
9495     regnode *chain = NULL;
9496     regnode *latest;
9497     I32 flags = 0, c = 0;
9498     GET_RE_DEBUG_FLAGS_DECL;
9499
9500     PERL_ARGS_ASSERT_REGBRANCH;
9501
9502     DEBUG_PARSE("brnc");
9503
9504     if (first)
9505         ret = NULL;
9506     else {
9507         if (!SIZE_ONLY && RExC_extralen)
9508             ret = reganode(pRExC_state, BRANCHJ,0);
9509         else {
9510             ret = reg_node(pRExC_state, BRANCH);
9511             Set_Node_Length(ret, 1);
9512         }
9513     }
9514
9515     if (!first && SIZE_ONLY)
9516         RExC_extralen += 1;                     /* BRANCHJ */
9517
9518     *flagp = WORST;                     /* Tentatively. */
9519
9520     RExC_parse--;
9521     nextchar(pRExC_state);
9522     while (RExC_parse < RExC_end && *RExC_parse != '|' && *RExC_parse != ')') {
9523         flags &= ~TRYAGAIN;
9524         latest = regpiece(pRExC_state, &flags,depth+1);
9525         if (latest == NULL) {
9526             if (flags & TRYAGAIN)
9527                 continue;
9528             if (flags & RESTART_UTF8) {
9529                 *flagp = RESTART_UTF8;
9530                 return NULL;
9531             }
9532             FAIL2("panic: regpiece returned NULL, flags=%#"UVxf"", (UV) flags);
9533         }
9534         else if (ret == NULL)
9535             ret = latest;
9536         *flagp |= flags&(HASWIDTH|POSTPONED);
9537         if (chain == NULL)      /* First piece. */
9538             *flagp |= flags&SPSTART;
9539         else {
9540             RExC_naughty++;
9541             REGTAIL(pRExC_state, chain, latest);
9542         }
9543         chain = latest;
9544         c++;
9545     }
9546     if (chain == NULL) {        /* Loop ran zero times. */
9547         chain = reg_node(pRExC_state, NOTHING);
9548         if (ret == NULL)
9549             ret = chain;
9550     }
9551     if (c == 1) {
9552         *flagp |= flags&SIMPLE;
9553     }
9554
9555     return ret;
9556 }
9557
9558 /*
9559  - regpiece - something followed by possible [*+?]
9560  *
9561  * Note that the branching code sequences used for ? and the general cases
9562  * of * and + are somewhat optimized:  they use the same NOTHING node as
9563  * both the endmarker for their branch list and the body of the last branch.
9564  * It might seem that this node could be dispensed with entirely, but the
9565  * endmarker role is not redundant.
9566  *
9567  * Returns NULL, setting *flagp to TRYAGAIN if regatom() returns NULL with
9568  * TRYAGAIN.
9569  * Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan needs to be
9570  * restarted.
9571  */
9572 STATIC regnode *
9573 S_regpiece(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
9574 {
9575     dVAR;
9576     regnode *ret;
9577     char op;
9578     char *next;
9579     I32 flags;
9580     const char * const origparse = RExC_parse;
9581     I32 min;
9582     I32 max = REG_INFTY;
9583 #ifdef RE_TRACK_PATTERN_OFFSETS
9584     char *parse_start;
9585 #endif
9586     const char *maxpos = NULL;
9587
9588     /* Save the original in case we change the emitted regop to a FAIL. */
9589     regnode * const orig_emit = RExC_emit;
9590
9591     GET_RE_DEBUG_FLAGS_DECL;
9592
9593     PERL_ARGS_ASSERT_REGPIECE;
9594
9595     DEBUG_PARSE("piec");
9596
9597     ret = regatom(pRExC_state, &flags,depth+1);
9598     if (ret == NULL) {
9599         if (flags & (TRYAGAIN|RESTART_UTF8))
9600             *flagp |= flags & (TRYAGAIN|RESTART_UTF8);
9601         else
9602             FAIL2("panic: regatom returned NULL, flags=%#"UVxf"", (UV) flags);
9603         return(NULL);
9604     }
9605
9606     op = *RExC_parse;
9607
9608     if (op == '{' && regcurly(RExC_parse, FALSE)) {
9609         maxpos = NULL;
9610 #ifdef RE_TRACK_PATTERN_OFFSETS
9611         parse_start = RExC_parse; /* MJD */
9612 #endif
9613         next = RExC_parse + 1;
9614         while (isDIGIT(*next) || *next == ',') {
9615             if (*next == ',') {
9616                 if (maxpos)
9617                     break;
9618                 else
9619                     maxpos = next;
9620             }
9621             next++;
9622         }
9623         if (*next == '}') {             /* got one */
9624             if (!maxpos)
9625                 maxpos = next;
9626             RExC_parse++;
9627             min = atoi(RExC_parse);
9628             if (*maxpos == ',')
9629                 maxpos++;
9630             else
9631                 maxpos = RExC_parse;
9632             max = atoi(maxpos);
9633             if (!max && *maxpos != '0')
9634                 max = REG_INFTY;                /* meaning "infinity" */
9635             else if (max >= REG_INFTY)
9636                 vFAIL2("Quantifier in {,} bigger than %d", REG_INFTY - 1);
9637             RExC_parse = next;
9638             nextchar(pRExC_state);
9639             if (max < min) {    /* If can't match, warn and optimize to fail
9640                                    unconditionally */
9641                 if (SIZE_ONLY) {
9642                     ckWARNreg(RExC_parse, "Quantifier {n,m} with n > m can't match");
9643
9644                     /* We can't back off the size because we have to reserve
9645                      * enough space for all the things we are about to throw
9646                      * away, but we can shrink it by the ammount we are about
9647                      * to re-use here */
9648                     RExC_size = PREVOPER(RExC_size) - regarglen[(U8)OPFAIL];
9649                 }
9650                 else {
9651                     RExC_emit = orig_emit;
9652                 }
9653                 ret = reg_node(pRExC_state, OPFAIL);
9654                 return ret;
9655             }
9656
9657         do_curly:
9658             if ((flags&SIMPLE)) {
9659                 RExC_naughty += 2 + RExC_naughty / 2;
9660                 reginsert(pRExC_state, CURLY, ret, depth+1);
9661                 Set_Node_Offset(ret, parse_start+1); /* MJD */
9662                 Set_Node_Cur_Length(ret, parse_start);
9663             }
9664             else {
9665                 regnode * const w = reg_node(pRExC_state, WHILEM);
9666
9667                 w->flags = 0;
9668                 REGTAIL(pRExC_state, ret, w);
9669                 if (!SIZE_ONLY && RExC_extralen) {
9670                     reginsert(pRExC_state, LONGJMP,ret, depth+1);
9671                     reginsert(pRExC_state, NOTHING,ret, depth+1);
9672                     NEXT_OFF(ret) = 3;  /* Go over LONGJMP. */
9673                 }
9674                 reginsert(pRExC_state, CURLYX,ret, depth+1);
9675                                 /* MJD hk */
9676                 Set_Node_Offset(ret, parse_start+1);
9677                 Set_Node_Length(ret,
9678                                 op == '{' ? (RExC_parse - parse_start) : 1);
9679
9680                 if (!SIZE_ONLY && RExC_extralen)
9681                     NEXT_OFF(ret) = 3;  /* Go over NOTHING to LONGJMP. */
9682                 REGTAIL(pRExC_state, ret, reg_node(pRExC_state, NOTHING));
9683                 if (SIZE_ONLY)
9684                     RExC_whilem_seen++, RExC_extralen += 3;
9685                 RExC_naughty += 4 + RExC_naughty;       /* compound interest */
9686             }
9687             ret->flags = 0;
9688
9689             if (min > 0)
9690                 *flagp = WORST;
9691             if (max > 0)
9692                 *flagp |= HASWIDTH;
9693             if (!SIZE_ONLY) {
9694                 ARG1_SET(ret, (U16)min);
9695                 ARG2_SET(ret, (U16)max);
9696             }
9697
9698             goto nest_check;
9699         }
9700     }
9701
9702     if (!ISMULT1(op)) {
9703         *flagp = flags;
9704         return(ret);
9705     }
9706
9707 #if 0                           /* Now runtime fix should be reliable. */
9708
9709     /* if this is reinstated, don't forget to put this back into perldiag:
9710
9711             =item Regexp *+ operand could be empty at {#} in regex m/%s/
9712
9713            (F) The part of the regexp subject to either the * or + quantifier
9714            could match an empty string. The {#} shows in the regular
9715            expression about where the problem was discovered.
9716
9717     */
9718
9719     if (!(flags&HASWIDTH) && op != '?')
9720       vFAIL("Regexp *+ operand could be empty");
9721 #endif
9722
9723 #ifdef RE_TRACK_PATTERN_OFFSETS
9724     parse_start = RExC_parse;
9725 #endif
9726     nextchar(pRExC_state);
9727
9728     *flagp = (op != '+') ? (WORST|SPSTART|HASWIDTH) : (WORST|HASWIDTH);
9729
9730     if (op == '*' && (flags&SIMPLE)) {
9731         reginsert(pRExC_state, STAR, ret, depth+1);
9732         ret->flags = 0;
9733         RExC_naughty += 4;
9734     }
9735     else if (op == '*') {
9736         min = 0;
9737         goto do_curly;
9738     }
9739     else if (op == '+' && (flags&SIMPLE)) {
9740         reginsert(pRExC_state, PLUS, ret, depth+1);
9741         ret->flags = 0;
9742         RExC_naughty += 3;
9743     }
9744     else if (op == '+') {
9745         min = 1;
9746         goto do_curly;
9747     }
9748     else if (op == '?') {
9749         min = 0; max = 1;
9750         goto do_curly;
9751     }
9752   nest_check:
9753     if (!SIZE_ONLY && !(flags&(HASWIDTH|POSTPONED)) && max > REG_INFTY/3) {
9754         SAVEFREESV(RExC_rx_sv); /* in case of fatal warnings */
9755         ckWARN3reg(RExC_parse,
9756                    "%.*s matches null string many times",
9757                    (int)(RExC_parse >= origparse ? RExC_parse - origparse : 0),
9758                    origparse);
9759         (void)ReREFCNT_inc(RExC_rx_sv);
9760     }
9761
9762     if (RExC_parse < RExC_end && *RExC_parse == '?') {
9763         nextchar(pRExC_state);
9764         reginsert(pRExC_state, MINMOD, ret, depth+1);
9765         REGTAIL(pRExC_state, ret, ret + NODE_STEP_REGNODE);
9766     }
9767     else
9768     if (RExC_parse < RExC_end && *RExC_parse == '+') {
9769         regnode *ender;
9770         nextchar(pRExC_state);
9771         ender = reg_node(pRExC_state, SUCCEED);
9772         REGTAIL(pRExC_state, ret, ender);
9773         reginsert(pRExC_state, SUSPEND, ret, depth+1);
9774         ret->flags = 0;
9775         ender = reg_node(pRExC_state, TAIL);
9776         REGTAIL(pRExC_state, ret, ender);
9777     }
9778
9779     if (RExC_parse < RExC_end && ISMULT2(RExC_parse)) {
9780         RExC_parse++;
9781         vFAIL("Nested quantifiers");
9782     }
9783
9784     return(ret);
9785 }
9786
9787 STATIC bool
9788 S_grok_bslash_N(pTHX_ RExC_state_t *pRExC_state, regnode** node_p, UV *valuep, I32 *flagp, U32 depth, bool in_char_class,
9789         const bool strict   /* Apply stricter parsing rules? */
9790     )
9791 {
9792    
9793  /* This is expected to be called by a parser routine that has recognized '\N'
9794    and needs to handle the rest. RExC_parse is expected to point at the first
9795    char following the N at the time of the call.  On successful return,
9796    RExC_parse has been updated to point to just after the sequence identified
9797    by this routine, and <*flagp> has been updated.
9798
9799    The \N may be inside (indicated by the boolean <in_char_class>) or outside a
9800    character class.
9801
9802    \N may begin either a named sequence, or if outside a character class, mean
9803    to match a non-newline.  For non single-quoted regexes, the tokenizer has
9804    attempted to decide which, and in the case of a named sequence, converted it
9805    into one of the forms: \N{} (if the sequence is null), or \N{U+c1.c2...},
9806    where c1... are the characters in the sequence.  For single-quoted regexes,
9807    the tokenizer passes the \N sequence through unchanged; this code will not
9808    attempt to determine this nor expand those, instead raising a syntax error.
9809    The net effect is that if the beginning of the passed-in pattern isn't '{U+'
9810    or there is no '}', it signals that this \N occurrence means to match a
9811    non-newline.
9812
9813    Only the \N{U+...} form should occur in a character class, for the same
9814    reason that '.' inside a character class means to just match a period: it
9815    just doesn't make sense.
9816
9817    The function raises an error (via vFAIL), and doesn't return for various
9818    syntax errors.  Otherwise it returns TRUE and sets <node_p> or <valuep> on
9819    success; it returns FALSE otherwise. Returns FALSE, setting *flagp to
9820    RESTART_UTF8 if the sizing scan needs to be restarted. Such a restart is
9821    only possible if node_p is non-NULL.
9822
9823
9824    If <valuep> is non-null, it means the caller can accept an input sequence
9825    consisting of a just a single code point; <*valuep> is set to that value
9826    if the input is such.
9827
9828    If <node_p> is non-null it signifies that the caller can accept any other
9829    legal sequence (i.e., one that isn't just a single code point).  <*node_p>
9830    is set as follows:
9831     1) \N means not-a-NL: points to a newly created REG_ANY node;
9832     2) \N{}:              points to a new NOTHING node;
9833     3) otherwise:         points to a new EXACT node containing the resolved
9834                           string.
9835    Note that FALSE is returned for single code point sequences if <valuep> is
9836    null.
9837  */
9838
9839     char * endbrace;    /* '}' following the name */
9840     char* p;
9841     char *endchar;      /* Points to '.' or '}' ending cur char in the input
9842                            stream */
9843     bool has_multiple_chars; /* true if the input stream contains a sequence of
9844                                 more than one character */
9845
9846     GET_RE_DEBUG_FLAGS_DECL;
9847  
9848     PERL_ARGS_ASSERT_GROK_BSLASH_N;
9849
9850     GET_RE_DEBUG_FLAGS;
9851
9852     assert(cBOOL(node_p) ^ cBOOL(valuep));  /* Exactly one should be set */
9853
9854     /* The [^\n] meaning of \N ignores spaces and comments under the /x
9855      * modifier.  The other meaning does not */
9856     p = (RExC_flags & RXf_PMf_EXTENDED)
9857         ? regwhite( pRExC_state, RExC_parse )
9858         : RExC_parse;
9859
9860     /* Disambiguate between \N meaning a named character versus \N meaning
9861      * [^\n].  The former is assumed when it can't be the latter. */
9862     if (*p != '{' || regcurly(p, FALSE)) {
9863         RExC_parse = p;
9864         if (! node_p) {
9865             /* no bare \N in a charclass */
9866             if (in_char_class) {
9867                 vFAIL("\\N in a character class must be a named character: \\N{...}");
9868             }
9869             return FALSE;
9870         }
9871         nextchar(pRExC_state);
9872         *node_p = reg_node(pRExC_state, REG_ANY);
9873         *flagp |= HASWIDTH|SIMPLE;
9874         RExC_naughty++;
9875         RExC_parse--;
9876         Set_Node_Length(*node_p, 1); /* MJD */
9877         return TRUE;
9878     }
9879
9880     /* Here, we have decided it should be a named character or sequence */
9881
9882     /* The test above made sure that the next real character is a '{', but
9883      * under the /x modifier, it could be separated by space (or a comment and
9884      * \n) and this is not allowed (for consistency with \x{...} and the
9885      * tokenizer handling of \N{NAME}). */
9886     if (*RExC_parse != '{') {
9887         vFAIL("Missing braces on \\N{}");
9888     }
9889
9890     RExC_parse++;       /* Skip past the '{' */
9891
9892     if (! (endbrace = strchr(RExC_parse, '}')) /* no trailing brace */
9893         || ! (endbrace == RExC_parse            /* nothing between the {} */
9894               || (endbrace - RExC_parse >= 2    /* U+ (bad hex is checked below */
9895                   && strnEQ(RExC_parse, "U+", 2)))) /* for a better error msg) */
9896     {
9897         if (endbrace) RExC_parse = endbrace;    /* position msg's '<--HERE' */
9898         vFAIL("\\N{NAME} must be resolved by the lexer");
9899     }
9900
9901     if (endbrace == RExC_parse) {   /* empty: \N{} */
9902         bool ret = TRUE;
9903         if (node_p) {
9904             *node_p = reg_node(pRExC_state,NOTHING);
9905         }
9906         else if (in_char_class) {
9907             if (SIZE_ONLY && in_char_class) {
9908                 if (strict) {
9909                     RExC_parse++;   /* Position after the "}" */
9910                     vFAIL("Zero length \\N{}");
9911                 }
9912                 else {
9913                     ckWARNreg(RExC_parse,
9914                               "Ignoring zero length \\N{} in character class");
9915                 }
9916             }
9917             ret = FALSE;
9918         }
9919         else {
9920             return FALSE;
9921         }
9922         nextchar(pRExC_state);
9923         return ret;
9924     }
9925
9926     RExC_uni_semantics = 1; /* Unicode named chars imply Unicode semantics */
9927     RExC_parse += 2;    /* Skip past the 'U+' */
9928
9929     endchar = RExC_parse + strcspn(RExC_parse, ".}");
9930
9931     /* Code points are separated by dots.  If none, there is only one code
9932      * point, and is terminated by the brace */
9933     has_multiple_chars = (endchar < endbrace);
9934
9935     if (valuep && (! has_multiple_chars || in_char_class)) {
9936         /* We only pay attention to the first char of
9937         multichar strings being returned in char classes. I kinda wonder
9938         if this makes sense as it does change the behaviour
9939         from earlier versions, OTOH that behaviour was broken
9940         as well. XXX Solution is to recharacterize as
9941         [rest-of-class]|multi1|multi2... */
9942
9943         STRLEN length_of_hex = (STRLEN)(endchar - RExC_parse);
9944         I32 grok_hex_flags = PERL_SCAN_ALLOW_UNDERSCORES
9945             | PERL_SCAN_DISALLOW_PREFIX
9946             | (SIZE_ONLY ? PERL_SCAN_SILENT_ILLDIGIT : 0);
9947
9948         *valuep = grok_hex(RExC_parse, &length_of_hex, &grok_hex_flags, NULL);
9949
9950         /* The tokenizer should have guaranteed validity, but it's possible to
9951          * bypass it by using single quoting, so check */
9952         if (length_of_hex == 0
9953             || length_of_hex != (STRLEN)(endchar - RExC_parse) )
9954         {
9955             RExC_parse += length_of_hex;        /* Includes all the valid */
9956             RExC_parse += (RExC_orig_utf8)      /* point to after 1st invalid */
9957                             ? UTF8SKIP(RExC_parse)
9958                             : 1;
9959             /* Guard against malformed utf8 */
9960             if (RExC_parse >= endchar) {
9961                 RExC_parse = endchar;
9962             }
9963             vFAIL("Invalid hexadecimal number in \\N{U+...}");
9964         }
9965
9966         if (in_char_class && has_multiple_chars) {
9967             if (strict) {
9968                 RExC_parse = endbrace;
9969                 vFAIL("\\N{} in character class restricted to one character");
9970             }
9971             else {
9972                 ckWARNreg(endchar, "Using just the first character returned by \\N{} in character class");
9973             }
9974         }
9975
9976         RExC_parse = endbrace + 1;
9977     }
9978     else if (! node_p || ! has_multiple_chars) {
9979
9980         /* Here, the input is legal, but not according to the caller's
9981          * options.  We fail without advancing the parse, so that the
9982          * caller can try again */
9983         RExC_parse = p;
9984         return FALSE;
9985     }
9986     else {
9987
9988         /* What is done here is to convert this to a sub-pattern of the form
9989          * (?:\x{char1}\x{char2}...)
9990          * and then call reg recursively.  That way, it retains its atomicness,
9991          * while not having to worry about special handling that some code
9992          * points may have.  toke.c has converted the original Unicode values
9993          * to native, so that we can just pass on the hex values unchanged.  We
9994          * do have to set a flag to keep recoding from happening in the
9995          * recursion */
9996
9997         SV * substitute_parse = newSVpvn_flags("?:", 2, SVf_UTF8|SVs_TEMP);
9998         STRLEN len;
9999         char *orig_end = RExC_end;
10000         I32 flags;
10001
10002         while (RExC_parse < endbrace) {
10003
10004             /* Convert to notation the rest of the code understands */
10005             sv_catpv(substitute_parse, "\\x{");
10006             sv_catpvn(substitute_parse, RExC_parse, endchar - RExC_parse);
10007             sv_catpv(substitute_parse, "}");
10008
10009             /* Point to the beginning of the next character in the sequence. */
10010             RExC_parse = endchar + 1;
10011             endchar = RExC_parse + strcspn(RExC_parse, ".}");
10012         }
10013         sv_catpv(substitute_parse, ")");
10014
10015         RExC_parse = SvPV(substitute_parse, len);
10016
10017         /* Don't allow empty number */
10018         if (len < 8) {
10019             vFAIL("Invalid hexadecimal number in \\N{U+...}");
10020         }
10021         RExC_end = RExC_parse + len;
10022
10023         /* The values are Unicode, and therefore not subject to recoding */
10024         RExC_override_recoding = 1;
10025
10026         if (!(*node_p = reg(pRExC_state, 1, &flags, depth+1))) {
10027             if (flags & RESTART_UTF8) {
10028                 *flagp = RESTART_UTF8;
10029                 return FALSE;
10030             }
10031             FAIL2("panic: reg returned NULL to grok_bslash_N, flags=%#"UVxf"",
10032                   (UV) flags);
10033         } 
10034         *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
10035
10036         RExC_parse = endbrace;
10037         RExC_end = orig_end;
10038         RExC_override_recoding = 0;
10039
10040         nextchar(pRExC_state);
10041     }
10042
10043     return TRUE;
10044 }
10045
10046
10047 /*
10048  * reg_recode
10049  *
10050  * It returns the code point in utf8 for the value in *encp.
10051  *    value: a code value in the source encoding
10052  *    encp:  a pointer to an Encode object
10053  *
10054  * If the result from Encode is not a single character,
10055  * it returns U+FFFD (Replacement character) and sets *encp to NULL.
10056  */
10057 STATIC UV
10058 S_reg_recode(pTHX_ const char value, SV **encp)
10059 {
10060     STRLEN numlen = 1;
10061     SV * const sv = newSVpvn_flags(&value, numlen, SVs_TEMP);
10062     const char * const s = *encp ? sv_recode_to_utf8(sv, *encp) : SvPVX(sv);
10063     const STRLEN newlen = SvCUR(sv);
10064     UV uv = UNICODE_REPLACEMENT;
10065
10066     PERL_ARGS_ASSERT_REG_RECODE;
10067
10068     if (newlen)
10069         uv = SvUTF8(sv)
10070              ? utf8n_to_uvchr((U8*)s, newlen, &numlen, UTF8_ALLOW_DEFAULT)
10071              : *(U8*)s;
10072
10073     if (!newlen || numlen != newlen) {
10074         uv = UNICODE_REPLACEMENT;
10075         *encp = NULL;
10076     }
10077     return uv;
10078 }
10079
10080 PERL_STATIC_INLINE U8
10081 S_compute_EXACTish(pTHX_ RExC_state_t *pRExC_state)
10082 {
10083     U8 op;
10084
10085     PERL_ARGS_ASSERT_COMPUTE_EXACTISH;
10086
10087     if (! FOLD) {
10088         return EXACT;
10089     }
10090
10091     op = get_regex_charset(RExC_flags);
10092     if (op >= REGEX_ASCII_RESTRICTED_CHARSET) {
10093         op--; /* /a is same as /u, and map /aa's offset to what /a's would have
10094                  been, so there is no hole */
10095     }
10096
10097     return op + EXACTF;
10098 }
10099
10100 PERL_STATIC_INLINE void
10101 S_alloc_maybe_populate_EXACT(pTHX_ RExC_state_t *pRExC_state, regnode *node, I32* flagp, STRLEN len, UV code_point)
10102 {
10103     /* This knows the details about sizing an EXACTish node, setting flags for
10104      * it (by setting <*flagp>, and potentially populating it with a single
10105      * character.
10106      *
10107      * If <len> (the length in bytes) is non-zero, this function assumes that
10108      * the node has already been populated, and just does the sizing.  In this
10109      * case <code_point> should be the final code point that has already been
10110      * placed into the node.  This value will be ignored except that under some
10111      * circumstances <*flagp> is set based on it.
10112      *
10113      * If <len> is zero, the function assumes that the node is to contain only
10114      * the single character given by <code_point> and calculates what <len>
10115      * should be.  In pass 1, it sizes the node appropriately.  In pass 2, it
10116      * additionally will populate the node's STRING with <code_point>, if <len>
10117      * is 0.  In both cases <*flagp> is appropriately set
10118      *
10119      * It knows that under FOLD, the Latin Sharp S and UTF characters above
10120      * 255, must be folded (the former only when the rules indicate it can
10121      * match 'ss') */
10122
10123     bool len_passed_in = cBOOL(len != 0);
10124     U8 character[UTF8_MAXBYTES_CASE+1];
10125
10126     PERL_ARGS_ASSERT_ALLOC_MAYBE_POPULATE_EXACT;
10127
10128     if (! len_passed_in) {
10129         if (UTF) {
10130             if (FOLD && (! LOC || code_point > 255)) {
10131                 _to_uni_fold_flags(NATIVE_TO_UNI(code_point),
10132                                    character,
10133                                    &len,
10134                                    FOLD_FLAGS_FULL | ((LOC)
10135                                                      ? FOLD_FLAGS_LOCALE
10136                                                      : (ASCII_FOLD_RESTRICTED)
10137                                                        ? FOLD_FLAGS_NOMIX_ASCII
10138                                                        : 0));
10139             }
10140             else {
10141                 uvchr_to_utf8( character, code_point);
10142                 len = UTF8SKIP(character);
10143             }
10144         }
10145         else if (! FOLD
10146                  || code_point != LATIN_SMALL_LETTER_SHARP_S
10147                  || ASCII_FOLD_RESTRICTED
10148                  || ! AT_LEAST_UNI_SEMANTICS)
10149         {
10150             *character = (U8) code_point;
10151             len = 1;
10152         }
10153         else {
10154             *character = 's';
10155             *(character + 1) = 's';
10156             len = 2;
10157         }
10158     }
10159
10160     if (SIZE_ONLY) {
10161         RExC_size += STR_SZ(len);
10162     }
10163     else {
10164         RExC_emit += STR_SZ(len);
10165         STR_LEN(node) = len;
10166         if (! len_passed_in) {
10167             Copy((char *) character, STRING(node), len, char);
10168         }
10169     }
10170
10171     *flagp |= HASWIDTH;
10172
10173     /* A single character node is SIMPLE, except for the special-cased SHARP S
10174      * under /di. */
10175     if ((len == 1 || (UTF && len == UNISKIP(code_point)))
10176         && (code_point != LATIN_SMALL_LETTER_SHARP_S
10177             || ! FOLD || ! DEPENDS_SEMANTICS))
10178     {
10179         *flagp |= SIMPLE;
10180     }
10181 }
10182
10183 /*
10184  - regatom - the lowest level
10185
10186    Try to identify anything special at the start of the pattern. If there
10187    is, then handle it as required. This may involve generating a single regop,
10188    such as for an assertion; or it may involve recursing, such as to
10189    handle a () structure.
10190
10191    If the string doesn't start with something special then we gobble up
10192    as much literal text as we can.
10193
10194    Once we have been able to handle whatever type of thing started the
10195    sequence, we return.
10196
10197    Note: we have to be careful with escapes, as they can be both literal
10198    and special, and in the case of \10 and friends, context determines which.
10199
10200    A summary of the code structure is:
10201
10202    switch (first_byte) {
10203         cases for each special:
10204             handle this special;
10205             break;
10206         case '\\':
10207             switch (2nd byte) {
10208                 cases for each unambiguous special:
10209                     handle this special;
10210                     break;
10211                 cases for each ambigous special/literal:
10212                     disambiguate;
10213                     if (special)  handle here
10214                     else goto defchar;
10215                 default: // unambiguously literal:
10216                     goto defchar;
10217             }
10218         default:  // is a literal char
10219             // FALL THROUGH
10220         defchar:
10221             create EXACTish node for literal;
10222             while (more input and node isn't full) {
10223                 switch (input_byte) {
10224                    cases for each special;
10225                        make sure parse pointer is set so that the next call to
10226                            regatom will see this special first
10227                        goto loopdone; // EXACTish node terminated by prev. char
10228                    default:
10229                        append char to EXACTISH node;
10230                 }
10231                 get next input byte;
10232             }
10233         loopdone:
10234    }
10235    return the generated node;
10236
10237    Specifically there are two separate switches for handling
10238    escape sequences, with the one for handling literal escapes requiring
10239    a dummy entry for all of the special escapes that are actually handled
10240    by the other.
10241
10242    Returns NULL, setting *flagp to TRYAGAIN if reg() returns NULL with
10243    TRYAGAIN.  
10244    Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan needs to be
10245    restarted.
10246    Otherwise does not return NULL.
10247 */
10248
10249 STATIC regnode *
10250 S_regatom(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
10251 {
10252     dVAR;
10253     regnode *ret = NULL;
10254     I32 flags = 0;
10255     char *parse_start = RExC_parse;
10256     U8 op;
10257     int invert = 0;
10258
10259     GET_RE_DEBUG_FLAGS_DECL;
10260
10261     *flagp = WORST;             /* Tentatively. */
10262
10263     DEBUG_PARSE("atom");
10264
10265     PERL_ARGS_ASSERT_REGATOM;
10266
10267 tryagain:
10268     switch ((U8)*RExC_parse) {
10269     case '^':
10270         RExC_seen_zerolen++;
10271         nextchar(pRExC_state);
10272         if (RExC_flags & RXf_PMf_MULTILINE)
10273             ret = reg_node(pRExC_state, MBOL);
10274         else if (RExC_flags & RXf_PMf_SINGLELINE)
10275             ret = reg_node(pRExC_state, SBOL);
10276         else
10277             ret = reg_node(pRExC_state, BOL);
10278         Set_Node_Length(ret, 1); /* MJD */
10279         break;
10280     case '$':
10281         nextchar(pRExC_state);
10282         if (*RExC_parse)
10283             RExC_seen_zerolen++;
10284         if (RExC_flags & RXf_PMf_MULTILINE)
10285             ret = reg_node(pRExC_state, MEOL);
10286         else if (RExC_flags & RXf_PMf_SINGLELINE)
10287             ret = reg_node(pRExC_state, SEOL);
10288         else
10289             ret = reg_node(pRExC_state, EOL);
10290         Set_Node_Length(ret, 1); /* MJD */
10291         break;
10292     case '.':
10293         nextchar(pRExC_state);
10294         if (RExC_flags & RXf_PMf_SINGLELINE)
10295             ret = reg_node(pRExC_state, SANY);
10296         else
10297             ret = reg_node(pRExC_state, REG_ANY);
10298         *flagp |= HASWIDTH|SIMPLE;
10299         RExC_naughty++;
10300         Set_Node_Length(ret, 1); /* MJD */
10301         break;
10302     case '[':
10303     {
10304         char * const oregcomp_parse = ++RExC_parse;
10305         ret = regclass(pRExC_state, flagp,depth+1,
10306                        FALSE, /* means parse the whole char class */
10307                        TRUE, /* allow multi-char folds */
10308                        FALSE, /* don't silence non-portable warnings. */
10309                        NULL);
10310         if (*RExC_parse != ']') {
10311             RExC_parse = oregcomp_parse;
10312             vFAIL("Unmatched [");
10313         }
10314         if (ret == NULL) {
10315             if (*flagp & RESTART_UTF8)
10316                 return NULL;
10317             FAIL2("panic: regclass returned NULL to regatom, flags=%#"UVxf"",
10318                   (UV) *flagp);
10319         }
10320         nextchar(pRExC_state);
10321         Set_Node_Length(ret, RExC_parse - oregcomp_parse + 1); /* MJD */
10322         break;
10323     }
10324     case '(':
10325         nextchar(pRExC_state);
10326         ret = reg(pRExC_state, 2, &flags,depth+1);
10327         if (ret == NULL) {
10328                 if (flags & TRYAGAIN) {
10329                     if (RExC_parse == RExC_end) {
10330                          /* Make parent create an empty node if needed. */
10331                         *flagp |= TRYAGAIN;
10332                         return(NULL);
10333                     }
10334                     goto tryagain;
10335                 }
10336                 if (flags & RESTART_UTF8) {
10337                     *flagp = RESTART_UTF8;
10338                     return NULL;
10339                 }
10340                 FAIL2("panic: reg returned NULL to regatom, flags=%#"UVxf"", (UV) flags);
10341         }
10342         *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
10343         break;
10344     case '|':
10345     case ')':
10346         if (flags & TRYAGAIN) {
10347             *flagp |= TRYAGAIN;
10348             return NULL;
10349         }
10350         vFAIL("Internal urp");
10351                                 /* Supposed to be caught earlier. */
10352         break;
10353     case '{':
10354         if (!regcurly(RExC_parse, FALSE)) {
10355             RExC_parse++;
10356             goto defchar;
10357         }
10358         /* FALL THROUGH */
10359     case '?':
10360     case '+':
10361     case '*':
10362         RExC_parse++;
10363         vFAIL("Quantifier follows nothing");
10364         break;
10365     case '\\':
10366         /* Special Escapes
10367
10368            This switch handles escape sequences that resolve to some kind
10369            of special regop and not to literal text. Escape sequnces that
10370            resolve to literal text are handled below in the switch marked
10371            "Literal Escapes".
10372
10373            Every entry in this switch *must* have a corresponding entry
10374            in the literal escape switch. However, the opposite is not
10375            required, as the default for this switch is to jump to the
10376            literal text handling code.
10377         */
10378         switch ((U8)*++RExC_parse) {
10379             U8 arg;
10380         /* Special Escapes */
10381         case 'A':
10382             RExC_seen_zerolen++;
10383             ret = reg_node(pRExC_state, SBOL);
10384             *flagp |= SIMPLE;
10385             goto finish_meta_pat;
10386         case 'G':
10387             ret = reg_node(pRExC_state, GPOS);
10388             RExC_seen |= REG_SEEN_GPOS;
10389             *flagp |= SIMPLE;
10390             goto finish_meta_pat;
10391         case 'K':
10392             RExC_seen_zerolen++;
10393             ret = reg_node(pRExC_state, KEEPS);
10394             *flagp |= SIMPLE;
10395             /* XXX:dmq : disabling in-place substitution seems to
10396              * be necessary here to avoid cases of memory corruption, as
10397              * with: C<$_="x" x 80; s/x\K/y/> -- rgs
10398              */
10399             RExC_seen |= REG_SEEN_LOOKBEHIND;
10400             goto finish_meta_pat;
10401         case 'Z':
10402             ret = reg_node(pRExC_state, SEOL);
10403             *flagp |= SIMPLE;
10404             RExC_seen_zerolen++;                /* Do not optimize RE away */
10405             goto finish_meta_pat;
10406         case 'z':
10407             ret = reg_node(pRExC_state, EOS);
10408             *flagp |= SIMPLE;
10409             RExC_seen_zerolen++;                /* Do not optimize RE away */
10410             goto finish_meta_pat;
10411         case 'C':
10412             ret = reg_node(pRExC_state, CANY);
10413             RExC_seen |= REG_SEEN_CANY;
10414             *flagp |= HASWIDTH|SIMPLE;
10415             goto finish_meta_pat;
10416         case 'X':
10417             ret = reg_node(pRExC_state, CLUMP);
10418             *flagp |= HASWIDTH;
10419             goto finish_meta_pat;
10420
10421         case 'W':
10422             invert = 1;
10423             /* FALLTHROUGH */
10424         case 'w':
10425             arg = ANYOF_WORDCHAR;
10426             goto join_posix;
10427
10428         case 'b':
10429             RExC_seen_zerolen++;
10430             RExC_seen |= REG_SEEN_LOOKBEHIND;
10431             op = BOUND + get_regex_charset(RExC_flags);
10432             if (op > BOUNDA) {  /* /aa is same as /a */
10433                 op = BOUNDA;
10434             }
10435             ret = reg_node(pRExC_state, op);
10436             FLAGS(ret) = get_regex_charset(RExC_flags);
10437             *flagp |= SIMPLE;
10438             if (! SIZE_ONLY && (U8) *(RExC_parse + 1) == '{') {
10439                 ckWARNdep(RExC_parse, "\"\\b{\" is deprecated; use \"\\b\\{\" or \"\\b[{]\" instead");
10440             }
10441             goto finish_meta_pat;
10442         case 'B':
10443             RExC_seen_zerolen++;
10444             RExC_seen |= REG_SEEN_LOOKBEHIND;
10445             op = NBOUND + get_regex_charset(RExC_flags);
10446             if (op > NBOUNDA) { /* /aa is same as /a */
10447                 op = NBOUNDA;
10448             }
10449             ret = reg_node(pRExC_state, op);
10450             FLAGS(ret) = get_regex_charset(RExC_flags);
10451             *flagp |= SIMPLE;
10452             if (! SIZE_ONLY && (U8) *(RExC_parse + 1) == '{') {
10453                 ckWARNdep(RExC_parse, "\"\\B{\" is deprecated; use \"\\B\\{\" or \"\\B[{]\" instead");
10454             }
10455             goto finish_meta_pat;
10456
10457         case 'D':
10458             invert = 1;
10459             /* FALLTHROUGH */
10460         case 'd':
10461             arg = ANYOF_DIGIT;
10462             goto join_posix;
10463
10464         case 'R':
10465             ret = reg_node(pRExC_state, LNBREAK);
10466             *flagp |= HASWIDTH|SIMPLE;
10467             goto finish_meta_pat;
10468
10469         case 'H':
10470             invert = 1;
10471             /* FALLTHROUGH */
10472         case 'h':
10473             arg = ANYOF_BLANK;
10474             op = POSIXU;
10475             goto join_posix_op_known;
10476
10477         case 'V':
10478             invert = 1;
10479             /* FALLTHROUGH */
10480         case 'v':
10481             arg = ANYOF_VERTWS;
10482             op = POSIXU;
10483             goto join_posix_op_known;
10484
10485         case 'S':
10486             invert = 1;
10487             /* FALLTHROUGH */
10488         case 's':
10489             arg = ANYOF_SPACE;
10490
10491         join_posix:
10492
10493             op = POSIXD + get_regex_charset(RExC_flags);
10494             if (op > POSIXA) {  /* /aa is same as /a */
10495                 op = POSIXA;
10496             }
10497
10498         join_posix_op_known:
10499
10500             if (invert) {
10501                 op += NPOSIXD - POSIXD;
10502             }
10503
10504             ret = reg_node(pRExC_state, op);
10505             if (! SIZE_ONLY) {
10506                 FLAGS(ret) = namedclass_to_classnum(arg);
10507             }
10508
10509             *flagp |= HASWIDTH|SIMPLE;
10510             /* FALL THROUGH */
10511
10512          finish_meta_pat:           
10513             nextchar(pRExC_state);
10514             Set_Node_Length(ret, 2); /* MJD */
10515             break;          
10516         case 'p':
10517         case 'P':
10518             {
10519 #ifdef DEBUGGING
10520                 char* parse_start = RExC_parse - 2;
10521 #endif
10522
10523                 RExC_parse--;
10524
10525                 ret = regclass(pRExC_state, flagp,depth+1,
10526                                TRUE, /* means just parse this element */
10527                                FALSE, /* don't allow multi-char folds */
10528                                FALSE, /* don't silence non-portable warnings.
10529                                          It would be a bug if these returned
10530                                          non-portables */
10531                                NULL);
10532                 /* regclass() can only return RESTART_UTF8 if multi-char folds
10533                    are allowed.  */
10534                 if (!ret)
10535                     FAIL2("panic: regclass returned NULL to regatom, flags=%#"UVxf"",
10536                           (UV) *flagp);
10537
10538                 RExC_parse--;
10539
10540                 Set_Node_Offset(ret, parse_start + 2);
10541                 Set_Node_Cur_Length(ret, parse_start);
10542                 nextchar(pRExC_state);
10543             }
10544             break;
10545         case 'N': 
10546             /* Handle \N and \N{NAME} with multiple code points here and not
10547              * below because it can be multicharacter. join_exact() will join
10548              * them up later on.  Also this makes sure that things like
10549              * /\N{BLAH}+/ and \N{BLAH} being multi char Just Happen. dmq.
10550              * The options to the grok function call causes it to fail if the
10551              * sequence is just a single code point.  We then go treat it as
10552              * just another character in the current EXACT node, and hence it
10553              * gets uniform treatment with all the other characters.  The
10554              * special treatment for quantifiers is not needed for such single
10555              * character sequences */
10556             ++RExC_parse;
10557             if (! grok_bslash_N(pRExC_state, &ret, NULL, flagp, depth, FALSE,
10558                                 FALSE /* not strict */ )) {
10559                 if (*flagp & RESTART_UTF8)
10560                     return NULL;
10561                 RExC_parse--;
10562                 goto defchar;
10563             }
10564             break;
10565         case 'k':    /* Handle \k<NAME> and \k'NAME' */
10566         parse_named_seq:
10567         {   
10568             char ch= RExC_parse[1];         
10569             if (ch != '<' && ch != '\'' && ch != '{') {
10570                 RExC_parse++;
10571                 vFAIL2("Sequence %.2s... not terminated",parse_start);
10572             } else {
10573                 /* this pretty much dupes the code for (?P=...) in reg(), if
10574                    you change this make sure you change that */
10575                 char* name_start = (RExC_parse += 2);
10576                 U32 num = 0;
10577                 SV *sv_dat = reg_scan_name(pRExC_state,
10578                     SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
10579                 ch= (ch == '<') ? '>' : (ch == '{') ? '}' : '\'';
10580                 if (RExC_parse == name_start || *RExC_parse != ch)
10581                     vFAIL2("Sequence %.3s... not terminated",parse_start);
10582
10583                 if (!SIZE_ONLY) {
10584                     num = add_data( pRExC_state, 1, "S" );
10585                     RExC_rxi->data->data[num]=(void*)sv_dat;
10586                     SvREFCNT_inc_simple_void(sv_dat);
10587                 }
10588
10589                 RExC_sawback = 1;
10590                 ret = reganode(pRExC_state,
10591                                ((! FOLD)
10592                                  ? NREF
10593                                  : (ASCII_FOLD_RESTRICTED)
10594                                    ? NREFFA
10595                                    : (AT_LEAST_UNI_SEMANTICS)
10596                                      ? NREFFU
10597                                      : (LOC)
10598                                        ? NREFFL
10599                                        : NREFF),
10600                                 num);
10601                 *flagp |= HASWIDTH;
10602
10603                 /* override incorrect value set in reganode MJD */
10604                 Set_Node_Offset(ret, parse_start+1);
10605                 Set_Node_Cur_Length(ret, parse_start);
10606                 nextchar(pRExC_state);
10607
10608             }
10609             break;
10610         }
10611         case 'g': 
10612         case '1': case '2': case '3': case '4':
10613         case '5': case '6': case '7': case '8': case '9':
10614             {
10615                 I32 num;
10616                 bool isg = *RExC_parse == 'g';
10617                 bool isrel = 0; 
10618                 bool hasbrace = 0;
10619                 if (isg) {
10620                     RExC_parse++;
10621                     if (*RExC_parse == '{') {
10622                         RExC_parse++;
10623                         hasbrace = 1;
10624                     }
10625                     if (*RExC_parse == '-') {
10626                         RExC_parse++;
10627                         isrel = 1;
10628                     }
10629                     if (hasbrace && !isDIGIT(*RExC_parse)) {
10630                         if (isrel) RExC_parse--;
10631                         RExC_parse -= 2;                            
10632                         goto parse_named_seq;
10633                 }   }
10634                 num = atoi(RExC_parse);
10635                 if (isg && num == 0) {
10636                     if (*RExC_parse == '0') {
10637                         vFAIL("Reference to invalid group 0");
10638                     }
10639                     else {
10640                         vFAIL("Unterminated \\g... pattern");
10641                     }
10642                 }
10643                 if (isrel) {
10644                     num = RExC_npar - num;
10645                     if (num < 1)
10646                         vFAIL("Reference to nonexistent or unclosed group");
10647                 }
10648                 if (!isg && num > 9 && num >= RExC_npar && *RExC_parse != '8' && *RExC_parse != '9')
10649                     /* Probably a character specified in octal, e.g. \35 */
10650                     goto defchar;
10651                 else {
10652 #ifdef RE_TRACK_PATTERN_OFFSETS
10653                     char * const parse_start = RExC_parse - 1; /* MJD */
10654 #endif
10655                     while (isDIGIT(*RExC_parse))
10656                         RExC_parse++;
10657                     if (hasbrace) {
10658                         if (*RExC_parse != '}') 
10659                             vFAIL("Unterminated \\g{...} pattern");
10660                         RExC_parse++;
10661                     }    
10662                     if (!SIZE_ONLY) {
10663                         if (num > (I32)RExC_rx->nparens)
10664                             vFAIL("Reference to nonexistent group");
10665                     }
10666                     RExC_sawback = 1;
10667                     ret = reganode(pRExC_state,
10668                                    ((! FOLD)
10669                                      ? REF
10670                                      : (ASCII_FOLD_RESTRICTED)
10671                                        ? REFFA
10672                                        : (AT_LEAST_UNI_SEMANTICS)
10673                                          ? REFFU
10674                                          : (LOC)
10675                                            ? REFFL
10676                                            : REFF),
10677                                     num);
10678                     *flagp |= HASWIDTH;
10679
10680                     /* override incorrect value set in reganode MJD */
10681                     Set_Node_Offset(ret, parse_start+1);
10682                     Set_Node_Cur_Length(ret, parse_start);
10683                     RExC_parse--;
10684                     nextchar(pRExC_state);
10685                 }
10686             }
10687             break;
10688         case '\0':
10689             if (RExC_parse >= RExC_end)
10690                 FAIL("Trailing \\");
10691             /* FALL THROUGH */
10692         default:
10693             /* Do not generate "unrecognized" warnings here, we fall
10694                back into the quick-grab loop below */
10695             parse_start--;
10696             goto defchar;
10697         }
10698         break;
10699
10700     case '#':
10701         if (RExC_flags & RXf_PMf_EXTENDED) {
10702             if ( reg_skipcomment( pRExC_state ) )
10703                 goto tryagain;
10704         }
10705         /* FALL THROUGH */
10706
10707     default:
10708
10709             parse_start = RExC_parse - 1;
10710
10711             RExC_parse++;
10712
10713         defchar: {
10714             STRLEN len = 0;
10715             UV ender;
10716             char *p;
10717             char *s;
10718 #define MAX_NODE_STRING_SIZE 127
10719             char foldbuf[MAX_NODE_STRING_SIZE+UTF8_MAXBYTES_CASE];
10720             char *s0;
10721             U8 upper_parse = MAX_NODE_STRING_SIZE;
10722             STRLEN foldlen;
10723             U8 node_type;
10724             bool next_is_quantifier;
10725             char * oldp = NULL;
10726
10727             /* If a folding node contains only code points that don't
10728              * participate in folds, it can be changed into an EXACT node,
10729              * which allows the optimizer more things to look for */
10730             bool maybe_exact;
10731
10732             ender = 0;
10733             node_type = compute_EXACTish(pRExC_state);
10734             ret = reg_node(pRExC_state, node_type);
10735
10736             /* In pass1, folded, we use a temporary buffer instead of the
10737              * actual node, as the node doesn't exist yet */
10738             s = (SIZE_ONLY && FOLD) ? foldbuf : STRING(ret);
10739
10740             s0 = s;
10741
10742         reparse:
10743
10744             /* We do the EXACTFish to EXACT node only if folding, and not if in
10745              * locale, as whether a character folds or not isn't known until
10746              * runtime */
10747             maybe_exact = FOLD && ! LOC;
10748
10749             /* XXX The node can hold up to 255 bytes, yet this only goes to
10750              * 127.  I (khw) do not know why.  Keeping it somewhat less than
10751              * 255 allows us to not have to worry about overflow due to
10752              * converting to utf8 and fold expansion, but that value is
10753              * 255-UTF8_MAXBYTES_CASE.  join_exact() may join adjacent nodes
10754              * split up by this limit into a single one using the real max of
10755              * 255.  Even at 127, this breaks under rare circumstances.  If
10756              * folding, we do not want to split a node at a character that is a
10757              * non-final in a multi-char fold, as an input string could just
10758              * happen to want to match across the node boundary.  The join
10759              * would solve that problem if the join actually happens.  But a
10760              * series of more than two nodes in a row each of 127 would cause
10761              * the first join to succeed to get to 254, but then there wouldn't
10762              * be room for the next one, which could at be one of those split
10763              * multi-char folds.  I don't know of any fool-proof solution.  One
10764              * could back off to end with only a code point that isn't such a
10765              * non-final, but it is possible for there not to be any in the
10766              * entire node. */
10767             for (p = RExC_parse - 1;
10768                  len < upper_parse && p < RExC_end;
10769                  len++)
10770             {
10771                 oldp = p;
10772
10773                 if (RExC_flags & RXf_PMf_EXTENDED)
10774                     p = regwhite( pRExC_state, p );
10775                 switch ((U8)*p) {
10776                 case '^':
10777                 case '$':
10778                 case '.':
10779                 case '[':
10780                 case '(':
10781                 case ')':
10782                 case '|':
10783                     goto loopdone;
10784                 case '\\':
10785                     /* Literal Escapes Switch
10786
10787                        This switch is meant to handle escape sequences that
10788                        resolve to a literal character.
10789
10790                        Every escape sequence that represents something
10791                        else, like an assertion or a char class, is handled
10792                        in the switch marked 'Special Escapes' above in this
10793                        routine, but also has an entry here as anything that
10794                        isn't explicitly mentioned here will be treated as
10795                        an unescaped equivalent literal.
10796                     */
10797
10798                     switch ((U8)*++p) {
10799                     /* These are all the special escapes. */
10800                     case 'A':             /* Start assertion */
10801                     case 'b': case 'B':   /* Word-boundary assertion*/
10802                     case 'C':             /* Single char !DANGEROUS! */
10803                     case 'd': case 'D':   /* digit class */
10804                     case 'g': case 'G':   /* generic-backref, pos assertion */
10805                     case 'h': case 'H':   /* HORIZWS */
10806                     case 'k': case 'K':   /* named backref, keep marker */
10807                     case 'p': case 'P':   /* Unicode property */
10808                               case 'R':   /* LNBREAK */
10809                     case 's': case 'S':   /* space class */
10810                     case 'v': case 'V':   /* VERTWS */
10811                     case 'w': case 'W':   /* word class */
10812                     case 'X':             /* eXtended Unicode "combining character sequence" */
10813                     case 'z': case 'Z':   /* End of line/string assertion */
10814                         --p;
10815                         goto loopdone;
10816
10817                     /* Anything after here is an escape that resolves to a
10818                        literal. (Except digits, which may or may not)
10819                      */
10820                     case 'n':
10821                         ender = '\n';
10822                         p++;
10823                         break;
10824                     case 'N': /* Handle a single-code point named character. */
10825                         /* The options cause it to fail if a multiple code
10826                          * point sequence.  Handle those in the switch() above
10827                          * */
10828                         RExC_parse = p + 1;
10829                         if (! grok_bslash_N(pRExC_state, NULL, &ender,
10830                                             flagp, depth, FALSE,
10831                                             FALSE /* not strict */ ))
10832                         {
10833                             if (*flagp & RESTART_UTF8)
10834                                 FAIL("panic: grok_bslash_N set RESTART_UTF8");
10835                             RExC_parse = p = oldp;
10836                             goto loopdone;
10837                         }
10838                         p = RExC_parse;
10839                         if (ender > 0xff) {
10840                             REQUIRE_UTF8;
10841                         }
10842                         break;
10843                     case 'r':
10844                         ender = '\r';
10845                         p++;
10846                         break;
10847                     case 't':
10848                         ender = '\t';
10849                         p++;
10850                         break;
10851                     case 'f':
10852                         ender = '\f';
10853                         p++;
10854                         break;
10855                     case 'e':
10856                           ender = ASCII_TO_NATIVE('\033');
10857                         p++;
10858                         break;
10859                     case 'a':
10860                           ender = ASCII_TO_NATIVE('\007');
10861                         p++;
10862                         break;
10863                     case 'o':
10864                         {
10865                             UV result;
10866                             const char* error_msg;
10867
10868                             bool valid = grok_bslash_o(&p,
10869                                                        &result,
10870                                                        &error_msg,
10871                                                        TRUE, /* out warnings */
10872                                                        FALSE, /* not strict */
10873                                                        TRUE, /* Output warnings
10874                                                                 for non-
10875                                                                 portables */
10876                                                        UTF);
10877                             if (! valid) {
10878                                 RExC_parse = p; /* going to die anyway; point
10879                                                    to exact spot of failure */
10880                                 vFAIL(error_msg);
10881                             }
10882                             ender = result;
10883                             if (PL_encoding && ender < 0x100) {
10884                                 goto recode_encoding;
10885                             }
10886                             if (ender > 0xff) {
10887                                 REQUIRE_UTF8;
10888                             }
10889                             break;
10890                         }
10891                     case 'x':
10892                         {
10893                             UV result = UV_MAX; /* initialize to erroneous
10894                                                    value */
10895                             const char* error_msg;
10896
10897                             bool valid = grok_bslash_x(&p,
10898                                                        &result,
10899                                                        &error_msg,
10900                                                        TRUE, /* out warnings */
10901                                                        FALSE, /* not strict */
10902                                                        TRUE, /* Output warnings
10903                                                                 for non-
10904                                                                 portables */
10905                                                        UTF);
10906                             if (! valid) {
10907                                 RExC_parse = p; /* going to die anyway; point
10908                                                    to exact spot of failure */
10909                                 vFAIL(error_msg);
10910                             }
10911                             ender = result;
10912
10913                             if (PL_encoding && ender < 0x100) {
10914                                 goto recode_encoding;
10915                             }
10916                             if (ender > 0xff) {
10917                                 REQUIRE_UTF8;
10918                             }
10919                             break;
10920                         }
10921                     case 'c':
10922                         p++;
10923                         ender = grok_bslash_c(*p++, UTF, SIZE_ONLY);
10924                         break;
10925                     case '8': case '9': /* must be a backreference */
10926                         --p;
10927                         goto loopdone;
10928                     case '1': case '2': case '3':case '4':
10929                     case '5': case '6': case '7':
10930                         /* When we parse backslash escapes there is ambiguity between
10931                          * backreferences and octal escapes. Any escape from \1 - \9 is
10932                          * a backreference, any multi-digit escape which does not start with
10933                          * 0 and which when evaluated as decimal could refer to an already
10934                          * parsed capture buffer is a backslash. Anything else is octal.
10935                          *
10936                          * Note this implies that \118 could be interpreted as 118 OR as
10937                          * "\11" . "8" depending on whether there were 118 capture buffers
10938                          * defined already in the pattern.
10939                          */
10940                         if ( !isDIGIT(p[1]) || atoi(p) <= RExC_npar )
10941                         {  /* Not to be treated as an octal constant, go
10942                                    find backref */
10943                             --p;
10944                             goto loopdone;
10945                         }
10946                     case '0':
10947                         {
10948                             I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
10949                             STRLEN numlen = 3;
10950                             ender = grok_oct(p, &numlen, &flags, NULL);
10951                             if (ender > 0xff) {
10952                                 REQUIRE_UTF8;
10953                             }
10954                             p += numlen;
10955                             if (SIZE_ONLY   /* like \08, \178 */
10956                                 && numlen < 3
10957                                 && p < RExC_end
10958                                 && isDIGIT(*p) && ckWARN(WARN_REGEXP))
10959                             {
10960                                 reg_warn_non_literal_string(
10961                                          p + 1,
10962                                          form_short_octal_warning(p, numlen));
10963                             }
10964                         }
10965                         if (PL_encoding && ender < 0x100)
10966                             goto recode_encoding;
10967                         break;
10968                     recode_encoding:
10969                         if (! RExC_override_recoding) {
10970                             SV* enc = PL_encoding;
10971                             ender = reg_recode((const char)(U8)ender, &enc);
10972                             if (!enc && SIZE_ONLY)
10973                                 ckWARNreg(p, "Invalid escape in the specified encoding");
10974                             REQUIRE_UTF8;
10975                         }
10976                         break;
10977                     case '\0':
10978                         if (p >= RExC_end)
10979                             FAIL("Trailing \\");
10980                         /* FALL THROUGH */
10981                     default:
10982                         if (!SIZE_ONLY&& isALPHANUMERIC(*p)) {
10983                             /* Include any { following the alpha to emphasize
10984                              * that it could be part of an escape at some point
10985                              * in the future */
10986                             int len = (isALPHA(*p) && *(p + 1) == '{') ? 2 : 1;
10987                             ckWARN3reg(p + len, "Unrecognized escape \\%.*s passed through", len, p);
10988                         }
10989                         goto normal_default;
10990                     } /* End of switch on '\' */
10991                     break;
10992                 default:    /* A literal character */
10993
10994                     if (! SIZE_ONLY
10995                         && RExC_flags & RXf_PMf_EXTENDED
10996                         && ckWARN_d(WARN_DEPRECATED)
10997                         && is_PATWS_non_low(p, UTF))
10998                     {
10999                         vWARN_dep(p + ((UTF) ? UTF8SKIP(p) : 1),
11000                                 "Escape literal pattern white space under /x");
11001                     }
11002
11003                   normal_default:
11004                     if (UTF8_IS_START(*p) && UTF) {
11005                         STRLEN numlen;
11006                         ender = utf8n_to_uvchr((U8*)p, RExC_end - p,
11007                                                &numlen, UTF8_ALLOW_DEFAULT);
11008                         p += numlen;
11009                     }
11010                     else
11011                         ender = (U8) *p++;
11012                     break;
11013                 } /* End of switch on the literal */
11014
11015                 /* Here, have looked at the literal character and <ender>
11016                  * contains its ordinal, <p> points to the character after it
11017                  */
11018
11019                 if ( RExC_flags & RXf_PMf_EXTENDED)
11020                     p = regwhite( pRExC_state, p );
11021
11022                 /* If the next thing is a quantifier, it applies to this
11023                  * character only, which means that this character has to be in
11024                  * its own node and can't just be appended to the string in an
11025                  * existing node, so if there are already other characters in
11026                  * the node, close the node with just them, and set up to do
11027                  * this character again next time through, when it will be the
11028                  * only thing in its new node */
11029                 if ((next_is_quantifier = (p < RExC_end && ISMULT2(p))) && len)
11030                 {
11031                     p = oldp;
11032                     goto loopdone;
11033                 }
11034
11035                 if (! FOLD) {
11036                     if (UTF) {
11037                         const STRLEN unilen = reguni(pRExC_state, ender, s);
11038                         if (unilen > 0) {
11039                            s   += unilen;
11040                            len += unilen;
11041                         }
11042
11043                         /* The loop increments <len> each time, as all but this
11044                          * path (and one other) through it add a single byte to
11045                          * the EXACTish node.  But this one has changed len to
11046                          * be the correct final value, so subtract one to
11047                          * cancel out the increment that follows */
11048                         len--;
11049                     }
11050                     else {
11051                         REGC((char)ender, s++);
11052                     }
11053                 }
11054                 else /* FOLD */
11055                      if (! ( UTF
11056                         /* See comments for join_exact() as to why we fold this
11057                          * non-UTF at compile time */
11058                         || (node_type == EXACTFU
11059                             && ender == LATIN_SMALL_LETTER_SHARP_S)))
11060                 {
11061                     *(s++) = (char) ender;
11062                     maybe_exact &= ! IS_IN_SOME_FOLD_L1(ender);
11063                 }
11064                 else {  /* UTF */
11065
11066                     /* Prime the casefolded buffer.  Locale rules, which apply
11067                      * only to code points < 256, aren't known until execution,
11068                      * so for them, just output the original character using
11069                      * utf8.  If we start to fold non-UTF patterns, be sure to
11070                      * update join_exact() */
11071                     if (LOC && ender < 256) {
11072                         if (UNI_IS_INVARIANT(ender)) {
11073                             *s = (U8) ender;
11074                             foldlen = 1;
11075                         } else {
11076                             *s = UTF8_TWO_BYTE_HI(ender);
11077                             *(s + 1) = UTF8_TWO_BYTE_LO(ender);
11078                             foldlen = 2;
11079                         }
11080                     }
11081                     else {
11082                         UV folded = _to_uni_fold_flags(
11083                                        ender,
11084                                        (U8 *) s,
11085                                        &foldlen,
11086                                        FOLD_FLAGS_FULL
11087                                        | ((LOC) ?  FOLD_FLAGS_LOCALE
11088                                                 : (ASCII_FOLD_RESTRICTED)
11089                                                   ? FOLD_FLAGS_NOMIX_ASCII
11090                                                   : 0)
11091                                         );
11092
11093                         /* If this node only contains non-folding code points
11094                          * so far, see if this new one is also non-folding */
11095                         if (maybe_exact) {
11096                             if (folded != ender) {
11097                                 maybe_exact = FALSE;
11098                             }
11099                             else {
11100                                 /* Here the fold is the original; we have
11101                                  * to check further to see if anything
11102                                  * folds to it */
11103                                 if (! PL_utf8_foldable) {
11104                                     SV* swash = swash_init("utf8",
11105                                                        "_Perl_Any_Folds",
11106                                                        &PL_sv_undef, 1, 0);
11107                                     PL_utf8_foldable =
11108                                                 _get_swash_invlist(swash);
11109                                     SvREFCNT_dec_NN(swash);
11110                                 }
11111                                 if (_invlist_contains_cp(PL_utf8_foldable,
11112                                                          ender))
11113                                 {
11114                                     maybe_exact = FALSE;
11115                                 }
11116                             }
11117                         }
11118                         ender = folded;
11119                     }
11120                     s += foldlen;
11121
11122                     /* The loop increments <len> each time, as all but this
11123                      * path (and one other) through it add a single byte to the
11124                      * EXACTish node.  But this one has changed len to be the
11125                      * correct final value, so subtract one to cancel out the
11126                      * increment that follows */
11127                     len += foldlen - 1;
11128                 }
11129
11130                 if (next_is_quantifier) {
11131
11132                     /* Here, the next input is a quantifier, and to get here,
11133                      * the current character is the only one in the node.
11134                      * Also, here <len> doesn't include the final byte for this
11135                      * character */
11136                     len++;
11137                     goto loopdone;
11138                 }
11139
11140             } /* End of loop through literal characters */
11141
11142             /* Here we have either exhausted the input or ran out of room in
11143              * the node.  (If we encountered a character that can't be in the
11144              * node, transfer is made directly to <loopdone>, and so we
11145              * wouldn't have fallen off the end of the loop.)  In the latter
11146              * case, we artificially have to split the node into two, because
11147              * we just don't have enough space to hold everything.  This
11148              * creates a problem if the final character participates in a
11149              * multi-character fold in the non-final position, as a match that
11150              * should have occurred won't, due to the way nodes are matched,
11151              * and our artificial boundary.  So back off until we find a non-
11152              * problematic character -- one that isn't at the beginning or
11153              * middle of such a fold.  (Either it doesn't participate in any
11154              * folds, or appears only in the final position of all the folds it
11155              * does participate in.)  A better solution with far fewer false
11156              * positives, and that would fill the nodes more completely, would
11157              * be to actually have available all the multi-character folds to
11158              * test against, and to back-off only far enough to be sure that
11159              * this node isn't ending with a partial one.  <upper_parse> is set
11160              * further below (if we need to reparse the node) to include just
11161              * up through that final non-problematic character that this code
11162              * identifies, so when it is set to less than the full node, we can
11163              * skip the rest of this */
11164             if (FOLD && p < RExC_end && upper_parse == MAX_NODE_STRING_SIZE) {
11165
11166                 const STRLEN full_len = len;
11167
11168                 assert(len >= MAX_NODE_STRING_SIZE);
11169
11170                 /* Here, <s> points to the final byte of the final character.
11171                  * Look backwards through the string until find a non-
11172                  * problematic character */
11173
11174                 if (! UTF) {
11175
11176                     /* These two have no multi-char folds to non-UTF characters
11177                      */
11178                     if (ASCII_FOLD_RESTRICTED || LOC) {
11179                         goto loopdone;
11180                     }
11181
11182                     while (--s >= s0 && IS_NON_FINAL_FOLD(*s)) { }
11183                     len = s - s0 + 1;
11184                 }
11185                 else {
11186                     if (!  PL_NonL1NonFinalFold) {
11187                         PL_NonL1NonFinalFold = _new_invlist_C_array(
11188                                         NonL1_Perl_Non_Final_Folds_invlist);
11189                     }
11190
11191                     /* Point to the first byte of the final character */
11192                     s = (char *) utf8_hop((U8 *) s, -1);
11193
11194                     while (s >= s0) {   /* Search backwards until find
11195                                            non-problematic char */
11196                         if (UTF8_IS_INVARIANT(*s)) {
11197
11198                             /* There are no ascii characters that participate
11199                              * in multi-char folds under /aa.  In EBCDIC, the
11200                              * non-ascii invariants are all control characters,
11201                              * so don't ever participate in any folds. */
11202                             if (ASCII_FOLD_RESTRICTED
11203                                 || ! IS_NON_FINAL_FOLD(*s))
11204                             {
11205                                 break;
11206                             }
11207                         }
11208                         else if (UTF8_IS_DOWNGRADEABLE_START(*s)) {
11209
11210                             /* No Latin1 characters participate in multi-char
11211                              * folds under /l */
11212                             if (LOC
11213                                 || ! IS_NON_FINAL_FOLD(TWO_BYTE_UTF8_TO_UNI(
11214                                                                 *s, *(s+1))))
11215                             {
11216                                 break;
11217                             }
11218                         }
11219                         else if (! _invlist_contains_cp(
11220                                         PL_NonL1NonFinalFold,
11221                                         valid_utf8_to_uvchr((U8 *) s, NULL)))
11222                         {
11223                             break;
11224                         }
11225
11226                         /* Here, the current character is problematic in that
11227                          * it does occur in the non-final position of some
11228                          * fold, so try the character before it, but have to
11229                          * special case the very first byte in the string, so
11230                          * we don't read outside the string */
11231                         s = (s == s0) ? s -1 : (char *) utf8_hop((U8 *) s, -1);
11232                     } /* End of loop backwards through the string */
11233
11234                     /* If there were only problematic characters in the string,
11235                      * <s> will point to before s0, in which case the length
11236                      * should be 0, otherwise include the length of the
11237                      * non-problematic character just found */
11238                     len = (s < s0) ? 0 : s - s0 + UTF8SKIP(s);
11239                 }
11240
11241                 /* Here, have found the final character, if any, that is
11242                  * non-problematic as far as ending the node without splitting
11243                  * it across a potential multi-char fold.  <len> contains the
11244                  * number of bytes in the node up-to and including that
11245                  * character, or is 0 if there is no such character, meaning
11246                  * the whole node contains only problematic characters.  In
11247                  * this case, give up and just take the node as-is.  We can't
11248                  * do any better */
11249                 if (len == 0) {
11250                     len = full_len;
11251                 } else {
11252
11253                     /* Here, the node does contain some characters that aren't
11254                      * problematic.  If one such is the final character in the
11255                      * node, we are done */
11256                     if (len == full_len) {
11257                         goto loopdone;
11258                     }
11259                     else if (len + ((UTF) ? UTF8SKIP(s) : 1) == full_len) {
11260
11261                         /* If the final character is problematic, but the
11262                          * penultimate is not, back-off that last character to
11263                          * later start a new node with it */
11264                         p = oldp;
11265                         goto loopdone;
11266                     }
11267
11268                     /* Here, the final non-problematic character is earlier
11269                      * in the input than the penultimate character.  What we do
11270                      * is reparse from the beginning, going up only as far as
11271                      * this final ok one, thus guaranteeing that the node ends
11272                      * in an acceptable character.  The reason we reparse is
11273                      * that we know how far in the character is, but we don't
11274                      * know how to correlate its position with the input parse.
11275                      * An alternate implementation would be to build that
11276                      * correlation as we go along during the original parse,
11277                      * but that would entail extra work for every node, whereas
11278                      * this code gets executed only when the string is too
11279                      * large for the node, and the final two characters are
11280                      * problematic, an infrequent occurrence.  Yet another
11281                      * possible strategy would be to save the tail of the
11282                      * string, and the next time regatom is called, initialize
11283                      * with that.  The problem with this is that unless you
11284                      * back off one more character, you won't be guaranteed
11285                      * regatom will get called again, unless regbranch,
11286                      * regpiece ... are also changed.  If you do back off that
11287                      * extra character, so that there is input guaranteed to
11288                      * force calling regatom, you can't handle the case where
11289                      * just the first character in the node is acceptable.  I
11290                      * (khw) decided to try this method which doesn't have that
11291                      * pitfall; if performance issues are found, we can do a
11292                      * combination of the current approach plus that one */
11293                     upper_parse = len;
11294                     len = 0;
11295                     s = s0;
11296                     goto reparse;
11297                 }
11298             }   /* End of verifying node ends with an appropriate char */
11299
11300         loopdone:   /* Jumped to when encounters something that shouldn't be in
11301                        the node */
11302
11303             /* I (khw) don't know if you can get here with zero length, but the
11304              * old code handled this situation by creating a zero-length EXACT
11305              * node.  Might as well be NOTHING instead */
11306             if (len == 0) {
11307                 OP(ret) = NOTHING;
11308             }
11309             else{
11310
11311                 /* If 'maybe_exact' is still set here, means there are no
11312                  * code points in the node that participate in folds */
11313                 if (FOLD && maybe_exact) {
11314                     OP(ret) = EXACT;
11315                 }
11316                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, len, ender);
11317             }
11318
11319             RExC_parse = p - 1;
11320             Set_Node_Cur_Length(ret, parse_start);
11321             nextchar(pRExC_state);
11322             {
11323                 /* len is STRLEN which is unsigned, need to copy to signed */
11324                 IV iv = len;
11325                 if (iv < 0)
11326                     vFAIL("Internal disaster");
11327             }
11328
11329         } /* End of label 'defchar:' */
11330         break;
11331     } /* End of giant switch on input character */
11332
11333     return(ret);
11334 }
11335
11336 STATIC char *
11337 S_regwhite( RExC_state_t *pRExC_state, char *p )
11338 {
11339     const char *e = RExC_end;
11340
11341     PERL_ARGS_ASSERT_REGWHITE;
11342
11343     while (p < e) {
11344         if (isSPACE(*p))
11345             ++p;
11346         else if (*p == '#') {
11347             bool ended = 0;
11348             do {
11349                 if (*p++ == '\n') {
11350                     ended = 1;
11351                     break;
11352                 }
11353             } while (p < e);
11354             if (!ended)
11355                 RExC_seen |= REG_SEEN_RUN_ON_COMMENT;
11356         }
11357         else
11358             break;
11359     }
11360     return p;
11361 }
11362
11363 STATIC char *
11364 S_regpatws( RExC_state_t *pRExC_state, char *p , const bool recognize_comment )
11365 {
11366     /* Returns the next non-pattern-white space, non-comment character (the
11367      * latter only if 'recognize_comment is true) in the string p, which is
11368      * ended by RExC_end.  If there is no line break ending a comment,
11369      * RExC_seen has added the REG_SEEN_RUN_ON_COMMENT flag; */
11370     const char *e = RExC_end;
11371
11372     PERL_ARGS_ASSERT_REGPATWS;
11373
11374     while (p < e) {
11375         STRLEN len;
11376         if ((len = is_PATWS_safe(p, e, UTF))) {
11377             p += len;
11378         }
11379         else if (recognize_comment && *p == '#') {
11380             bool ended = 0;
11381             do {
11382                 p++;
11383                 if (is_LNBREAK_safe(p, e, UTF)) {
11384                     ended = 1;
11385                     break;
11386                 }
11387             } while (p < e);
11388             if (!ended)
11389                 RExC_seen |= REG_SEEN_RUN_ON_COMMENT;
11390         }
11391         else
11392             break;
11393     }
11394     return p;
11395 }
11396
11397 /* Parse POSIX character classes: [[:foo:]], [[=foo=]], [[.foo.]].
11398    Character classes ([:foo:]) can also be negated ([:^foo:]).
11399    Returns a named class id (ANYOF_XXX) if successful, -1 otherwise.
11400    Equivalence classes ([=foo=]) and composites ([.foo.]) are parsed,
11401    but trigger failures because they are currently unimplemented. */
11402
11403 #define POSIXCC_DONE(c)   ((c) == ':')
11404 #define POSIXCC_NOTYET(c) ((c) == '=' || (c) == '.')
11405 #define POSIXCC(c) (POSIXCC_DONE(c) || POSIXCC_NOTYET(c))
11406
11407 PERL_STATIC_INLINE I32
11408 S_regpposixcc(pTHX_ RExC_state_t *pRExC_state, I32 value, const bool strict)
11409 {
11410     dVAR;
11411     I32 namedclass = OOB_NAMEDCLASS;
11412
11413     PERL_ARGS_ASSERT_REGPPOSIXCC;
11414
11415     if (value == '[' && RExC_parse + 1 < RExC_end &&
11416         /* I smell either [: or [= or [. -- POSIX has been here, right? */
11417         POSIXCC(UCHARAT(RExC_parse)))
11418     {
11419         const char c = UCHARAT(RExC_parse);
11420         char* const s = RExC_parse++;
11421
11422         while (RExC_parse < RExC_end && UCHARAT(RExC_parse) != c)
11423             RExC_parse++;
11424         if (RExC_parse == RExC_end) {
11425             if (strict) {
11426
11427                 /* Try to give a better location for the error (than the end of
11428                  * the string) by looking for the matching ']' */
11429                 RExC_parse = s;
11430                 while (RExC_parse < RExC_end && UCHARAT(RExC_parse) != ']') {
11431                     RExC_parse++;
11432                 }
11433                 vFAIL2("Unmatched '%c' in POSIX class", c);
11434             }
11435             /* Grandfather lone [:, [=, [. */
11436             RExC_parse = s;
11437         }
11438         else {
11439             const char* const t = RExC_parse++; /* skip over the c */
11440             assert(*t == c);
11441
11442             if (UCHARAT(RExC_parse) == ']') {
11443                 const char *posixcc = s + 1;
11444                 RExC_parse++; /* skip over the ending ] */
11445
11446                 if (*s == ':') {
11447                     const I32 complement = *posixcc == '^' ? *posixcc++ : 0;
11448                     const I32 skip = t - posixcc;
11449
11450                     /* Initially switch on the length of the name.  */
11451                     switch (skip) {
11452                     case 4:
11453                         if (memEQ(posixcc, "word", 4)) /* this is not POSIX,
11454                                                           this is the Perl \w
11455                                                         */
11456                             namedclass = ANYOF_WORDCHAR;
11457                         break;
11458                     case 5:
11459                         /* Names all of length 5.  */
11460                         /* alnum alpha ascii blank cntrl digit graph lower
11461                            print punct space upper  */
11462                         /* Offset 4 gives the best switch position.  */
11463                         switch (posixcc[4]) {
11464                         case 'a':
11465                             if (memEQ(posixcc, "alph", 4)) /* alpha */
11466                                 namedclass = ANYOF_ALPHA;
11467                             break;
11468                         case 'e':
11469                             if (memEQ(posixcc, "spac", 4)) /* space */
11470                                 namedclass = ANYOF_PSXSPC;
11471                             break;
11472                         case 'h':
11473                             if (memEQ(posixcc, "grap", 4)) /* graph */
11474                                 namedclass = ANYOF_GRAPH;
11475                             break;
11476                         case 'i':
11477                             if (memEQ(posixcc, "asci", 4)) /* ascii */
11478                                 namedclass = ANYOF_ASCII;
11479                             break;
11480                         case 'k':
11481                             if (memEQ(posixcc, "blan", 4)) /* blank */
11482                                 namedclass = ANYOF_BLANK;
11483                             break;
11484                         case 'l':
11485                             if (memEQ(posixcc, "cntr", 4)) /* cntrl */
11486                                 namedclass = ANYOF_CNTRL;
11487                             break;
11488                         case 'm':
11489                             if (memEQ(posixcc, "alnu", 4)) /* alnum */
11490                                 namedclass = ANYOF_ALPHANUMERIC;
11491                             break;
11492                         case 'r':
11493                             if (memEQ(posixcc, "lowe", 4)) /* lower */
11494                                 namedclass = (FOLD) ? ANYOF_CASED : ANYOF_LOWER;
11495                             else if (memEQ(posixcc, "uppe", 4)) /* upper */
11496                                 namedclass = (FOLD) ? ANYOF_CASED : ANYOF_UPPER;
11497                             break;
11498                         case 't':
11499                             if (memEQ(posixcc, "digi", 4)) /* digit */
11500                                 namedclass = ANYOF_DIGIT;
11501                             else if (memEQ(posixcc, "prin", 4)) /* print */
11502                                 namedclass = ANYOF_PRINT;
11503                             else if (memEQ(posixcc, "punc", 4)) /* punct */
11504                                 namedclass = ANYOF_PUNCT;
11505                             break;
11506                         }
11507                         break;
11508                     case 6:
11509                         if (memEQ(posixcc, "xdigit", 6))
11510                             namedclass = ANYOF_XDIGIT;
11511                         break;
11512                     }
11513
11514                     if (namedclass == OOB_NAMEDCLASS)
11515                         Simple_vFAIL3("POSIX class [:%.*s:] unknown",
11516                                       t - s - 1, s + 1);
11517
11518                     /* The #defines are structured so each complement is +1 to
11519                      * the normal one */
11520                     if (complement) {
11521                         namedclass++;
11522                     }
11523                     assert (posixcc[skip] == ':');
11524                     assert (posixcc[skip+1] == ']');
11525                 } else if (!SIZE_ONLY) {
11526                     /* [[=foo=]] and [[.foo.]] are still future. */
11527
11528                     /* adjust RExC_parse so the warning shows after
11529                        the class closes */
11530                     while (UCHARAT(RExC_parse) && UCHARAT(RExC_parse) != ']')
11531                         RExC_parse++;
11532                     vFAIL3("POSIX syntax [%c %c] is reserved for future extensions", c, c);
11533                 }
11534             } else {
11535                 /* Maternal grandfather:
11536                  * "[:" ending in ":" but not in ":]" */
11537                 if (strict) {
11538                     vFAIL("Unmatched '[' in POSIX class");
11539                 }
11540
11541                 /* Grandfather lone [:, [=, [. */
11542                 RExC_parse = s;
11543             }
11544         }
11545     }
11546
11547     return namedclass;
11548 }
11549
11550 STATIC bool
11551 S_could_it_be_a_POSIX_class(pTHX_ RExC_state_t *pRExC_state)
11552 {
11553     /* This applies some heuristics at the current parse position (which should
11554      * be at a '[') to see if what follows might be intended to be a [:posix:]
11555      * class.  It returns true if it really is a posix class, of course, but it
11556      * also can return true if it thinks that what was intended was a posix
11557      * class that didn't quite make it.
11558      *
11559      * It will return true for
11560      *      [:alphanumerics:
11561      *      [:alphanumerics]  (as long as the ] isn't followed immediately by a
11562      *                         ')' indicating the end of the (?[
11563      *      [:any garbage including %^&$ punctuation:]
11564      *
11565      * This is designed to be called only from S_handle_regex_sets; it could be
11566      * easily adapted to be called from the spot at the beginning of regclass()
11567      * that checks to see in a normal bracketed class if the surrounding []
11568      * have been omitted ([:word:] instead of [[:word:]]).  But doing so would
11569      * change long-standing behavior, so I (khw) didn't do that */
11570     char* p = RExC_parse + 1;
11571     char first_char = *p;
11572
11573     PERL_ARGS_ASSERT_COULD_IT_BE_A_POSIX_CLASS;
11574
11575     assert(*(p - 1) == '[');
11576
11577     if (! POSIXCC(first_char)) {
11578         return FALSE;
11579     }
11580
11581     p++;
11582     while (p < RExC_end && isWORDCHAR(*p)) p++;
11583
11584     if (p >= RExC_end) {
11585         return FALSE;
11586     }
11587
11588     if (p - RExC_parse > 2    /* Got at least 1 word character */
11589         && (*p == first_char
11590             || (*p == ']' && p + 1 < RExC_end && *(p + 1) != ')')))
11591     {
11592         return TRUE;
11593     }
11594
11595     p = (char *) memchr(RExC_parse, ']', RExC_end - RExC_parse);
11596
11597     return (p
11598             && p - RExC_parse > 2 /* [:] evaluates to colon;
11599                                       [::] is a bad posix class. */
11600             && first_char == *(p - 1));
11601 }
11602
11603 STATIC regnode *
11604 S_handle_regex_sets(pTHX_ RExC_state_t *pRExC_state, SV** return_invlist, I32 *flagp, U32 depth,
11605                    char * const oregcomp_parse)
11606 {
11607     /* Handle the (?[...]) construct to do set operations */
11608
11609     U8 curchar;
11610     UV start, end;      /* End points of code point ranges */
11611     SV* result_string;
11612     char *save_end, *save_parse;
11613     SV* final;
11614     STRLEN len;
11615     regnode* node;
11616     AV* stack;
11617     const bool save_fold = FOLD;
11618
11619     GET_RE_DEBUG_FLAGS_DECL;
11620
11621     PERL_ARGS_ASSERT_HANDLE_REGEX_SETS;
11622
11623     if (LOC) {
11624         vFAIL("(?[...]) not valid in locale");
11625     }
11626     RExC_uni_semantics = 1;
11627
11628     /* This will return only an ANYOF regnode, or (unlikely) something smaller
11629      * (such as EXACT).  Thus we can skip most everything if just sizing.  We
11630      * call regclass to handle '[]' so as to not have to reinvent its parsing
11631      * rules here (throwing away the size it computes each time).  And, we exit
11632      * upon an unescaped ']' that isn't one ending a regclass.  To do both
11633      * these things, we need to realize that something preceded by a backslash
11634      * is escaped, so we have to keep track of backslashes */
11635     if (SIZE_ONLY) {
11636         UV depth = 0; /* how many nested (?[...]) constructs */
11637
11638         Perl_ck_warner_d(aTHX_
11639             packWARN(WARN_EXPERIMENTAL__REGEX_SETS),
11640             "The regex_sets feature is experimental" REPORT_LOCATION,
11641             (int) (RExC_parse - RExC_precomp) , RExC_precomp, RExC_parse);
11642
11643         while (RExC_parse < RExC_end) {
11644             SV* current = NULL;
11645             RExC_parse = regpatws(pRExC_state, RExC_parse,
11646                                 TRUE); /* means recognize comments */
11647             switch (*RExC_parse) {
11648                 case '?':
11649                     if (RExC_parse[1] == '[') depth++, RExC_parse++;
11650                     /* FALL THROUGH */
11651                 default:
11652                     break;
11653                 case '\\':
11654                     /* Skip the next byte (which could cause us to end up in
11655                      * the middle of a UTF-8 character, but since none of those
11656                      * are confusable with anything we currently handle in this
11657                      * switch (invariants all), it's safe.  We'll just hit the
11658                      * default: case next time and keep on incrementing until
11659                      * we find one of the invariants we do handle. */
11660                     RExC_parse++;
11661                     break;
11662                 case '[':
11663                 {
11664                     /* If this looks like it is a [:posix:] class, leave the
11665                      * parse pointer at the '[' to fool regclass() into
11666                      * thinking it is part of a '[[:posix:]]'.  That function
11667                      * will use strict checking to force a syntax error if it
11668                      * doesn't work out to a legitimate class */
11669                     bool is_posix_class
11670                                     = could_it_be_a_POSIX_class(pRExC_state);
11671                     if (! is_posix_class) {
11672                         RExC_parse++;
11673                     }
11674
11675                     /* regclass() can only return RESTART_UTF8 if multi-char
11676                        folds are allowed.  */
11677                     if (!regclass(pRExC_state, flagp,depth+1,
11678                                   is_posix_class, /* parse the whole char
11679                                                      class only if not a
11680                                                      posix class */
11681                                   FALSE, /* don't allow multi-char folds */
11682                                   TRUE, /* silence non-portable warnings. */
11683                                   &current))
11684                         FAIL2("panic: regclass returned NULL to handle_sets, flags=%#"UVxf"",
11685                               (UV) *flagp);
11686
11687                     /* function call leaves parse pointing to the ']', except
11688                      * if we faked it */
11689                     if (is_posix_class) {
11690                         RExC_parse--;
11691                     }
11692
11693                     SvREFCNT_dec(current);   /* In case it returned something */
11694                     break;
11695                 }
11696
11697                 case ']':
11698                     if (depth--) break;
11699                     RExC_parse++;
11700                     if (RExC_parse < RExC_end
11701                         && *RExC_parse == ')')
11702                     {
11703                         node = reganode(pRExC_state, ANYOF, 0);
11704                         RExC_size += ANYOF_SKIP;
11705                         nextchar(pRExC_state);
11706                         Set_Node_Length(node,
11707                                 RExC_parse - oregcomp_parse + 1); /* MJD */
11708                         return node;
11709                     }
11710                     goto no_close;
11711             }
11712             RExC_parse++;
11713         }
11714
11715         no_close:
11716         FAIL("Syntax error in (?[...])");
11717     }
11718
11719     /* Pass 2 only after this.  Everything in this construct is a
11720      * metacharacter.  Operands begin with either a '\' (for an escape
11721      * sequence), or a '[' for a bracketed character class.  Any other
11722      * character should be an operator, or parenthesis for grouping.  Both
11723      * types of operands are handled by calling regclass() to parse them.  It
11724      * is called with a parameter to indicate to return the computed inversion
11725      * list.  The parsing here is implemented via a stack.  Each entry on the
11726      * stack is a single character representing one of the operators, or the
11727      * '('; or else a pointer to an operand inversion list. */
11728
11729 #define IS_OPERAND(a)  (! SvIOK(a))
11730
11731     /* The stack starts empty.  It is a syntax error if the first thing parsed
11732      * is a binary operator; everything else is pushed on the stack.  When an
11733      * operand is parsed, the top of the stack is examined.  If it is a binary
11734      * operator, the item before it should be an operand, and both are replaced
11735      * by the result of doing that operation on the new operand and the one on
11736      * the stack.   Thus a sequence of binary operands is reduced to a single
11737      * one before the next one is parsed.
11738      *
11739      * A unary operator may immediately follow a binary in the input, for
11740      * example
11741      *      [a] + ! [b]
11742      * When an operand is parsed and the top of the stack is a unary operator,
11743      * the operation is performed, and then the stack is rechecked to see if
11744      * this new operand is part of a binary operation; if so, it is handled as
11745      * above.
11746      *
11747      * A '(' is simply pushed on the stack; it is valid only if the stack is
11748      * empty, or the top element of the stack is an operator or another '('
11749      * (for which the parenthesized expression will become an operand).  By the
11750      * time the corresponding ')' is parsed everything in between should have
11751      * been parsed and evaluated to a single operand (or else is a syntax
11752      * error), and is handled as a regular operand */
11753
11754     sv_2mortal((SV *)(stack = newAV()));
11755
11756     while (RExC_parse < RExC_end) {
11757         I32 top_index = av_tindex(stack);
11758         SV** top_ptr;
11759         SV* current = NULL;
11760
11761         /* Skip white space */
11762         RExC_parse = regpatws(pRExC_state, RExC_parse,
11763                                 TRUE); /* means recognize comments */
11764         if (RExC_parse >= RExC_end) {
11765             Perl_croak(aTHX_ "panic: Read past end of '(?[ ])'");
11766         }
11767         if ((curchar = UCHARAT(RExC_parse)) == ']') {
11768             break;
11769         }
11770
11771         switch (curchar) {
11772
11773             case '?':
11774                 if (av_tindex(stack) >= 0   /* This makes sure that we can
11775                                                safely subtract 1 from
11776                                                RExC_parse in the next clause.
11777                                                If we have something on the
11778                                                stack, we have parsed something
11779                                              */
11780                     && UCHARAT(RExC_parse - 1) == '('
11781                     && RExC_parse < RExC_end)
11782                 {
11783                     /* If is a '(?', could be an embedded '(?flags:(?[...])'.
11784                      * This happens when we have some thing like
11785                      *
11786                      *   my $thai_or_lao = qr/(?[ \p{Thai} + \p{Lao} ])/;
11787                      *   ...
11788                      *   qr/(?[ \p{Digit} & $thai_or_lao ])/;
11789                      *
11790                      * Here we would be handling the interpolated
11791                      * '$thai_or_lao'.  We handle this by a recursive call to
11792                      * ourselves which returns the inversion list the
11793                      * interpolated expression evaluates to.  We use the flags
11794                      * from the interpolated pattern. */
11795                     U32 save_flags = RExC_flags;
11796                     const char * const save_parse = ++RExC_parse;
11797
11798                     parse_lparen_question_flags(pRExC_state);
11799
11800                     if (RExC_parse == save_parse  /* Makes sure there was at
11801                                                      least one flag (or this
11802                                                      embedding wasn't compiled)
11803                                                    */
11804                         || RExC_parse >= RExC_end - 4
11805                         || UCHARAT(RExC_parse) != ':'
11806                         || UCHARAT(++RExC_parse) != '('
11807                         || UCHARAT(++RExC_parse) != '?'
11808                         || UCHARAT(++RExC_parse) != '[')
11809                     {
11810
11811                         /* In combination with the above, this moves the
11812                          * pointer to the point just after the first erroneous
11813                          * character (or if there are no flags, to where they
11814                          * should have been) */
11815                         if (RExC_parse >= RExC_end - 4) {
11816                             RExC_parse = RExC_end;
11817                         }
11818                         else if (RExC_parse != save_parse) {
11819                             RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
11820                         }
11821                         vFAIL("Expecting '(?flags:(?[...'");
11822                     }
11823                     RExC_parse++;
11824                     (void) handle_regex_sets(pRExC_state, &current, flagp,
11825                                                     depth+1, oregcomp_parse);
11826
11827                     /* Here, 'current' contains the embedded expression's
11828                      * inversion list, and RExC_parse points to the trailing
11829                      * ']'; the next character should be the ')' which will be
11830                      * paired with the '(' that has been put on the stack, so
11831                      * the whole embedded expression reduces to '(operand)' */
11832                     RExC_parse++;
11833
11834                     RExC_flags = save_flags;
11835                     goto handle_operand;
11836                 }
11837                 /* FALL THROUGH */
11838
11839             default:
11840                 RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
11841                 vFAIL("Unexpected character");
11842
11843             case '\\':
11844                 /* regclass() can only return RESTART_UTF8 if multi-char
11845                    folds are allowed.  */
11846                 if (!regclass(pRExC_state, flagp,depth+1,
11847                               TRUE, /* means parse just the next thing */
11848                               FALSE, /* don't allow multi-char folds */
11849                               FALSE, /* don't silence non-portable warnings.  */
11850                               &current))
11851                     FAIL2("panic: regclass returned NULL to handle_sets, flags=%#"UVxf"",
11852                           (UV) *flagp);
11853                 /* regclass() will return with parsing just the \ sequence,
11854                  * leaving the parse pointer at the next thing to parse */
11855                 RExC_parse--;
11856                 goto handle_operand;
11857
11858             case '[':   /* Is a bracketed character class */
11859             {
11860                 bool is_posix_class = could_it_be_a_POSIX_class(pRExC_state);
11861
11862                 if (! is_posix_class) {
11863                     RExC_parse++;
11864                 }
11865
11866                 /* regclass() can only return RESTART_UTF8 if multi-char
11867                    folds are allowed.  */
11868                 if(!regclass(pRExC_state, flagp,depth+1,
11869                              is_posix_class, /* parse the whole char class
11870                                                 only if not a posix class */
11871                              FALSE, /* don't allow multi-char folds */
11872                              FALSE, /* don't silence non-portable warnings.  */
11873                              &current))
11874                     FAIL2("panic: regclass returned NULL to handle_sets, flags=%#"UVxf"",
11875                           (UV) *flagp);
11876                 /* function call leaves parse pointing to the ']', except if we
11877                  * faked it */
11878                 if (is_posix_class) {
11879                     RExC_parse--;
11880                 }
11881
11882                 goto handle_operand;
11883             }
11884
11885             case '&':
11886             case '|':
11887             case '+':
11888             case '-':
11889             case '^':
11890                 if (top_index < 0
11891                     || ( ! (top_ptr = av_fetch(stack, top_index, FALSE)))
11892                     || ! IS_OPERAND(*top_ptr))
11893                 {
11894                     RExC_parse++;
11895                     vFAIL2("Unexpected binary operator '%c' with no preceding operand", curchar);
11896                 }
11897                 av_push(stack, newSVuv(curchar));
11898                 break;
11899
11900             case '!':
11901                 av_push(stack, newSVuv(curchar));
11902                 break;
11903
11904             case '(':
11905                 if (top_index >= 0) {
11906                     top_ptr = av_fetch(stack, top_index, FALSE);
11907                     assert(top_ptr);
11908                     if (IS_OPERAND(*top_ptr)) {
11909                         RExC_parse++;
11910                         vFAIL("Unexpected '(' with no preceding operator");
11911                     }
11912                 }
11913                 av_push(stack, newSVuv(curchar));
11914                 break;
11915
11916             case ')':
11917             {
11918                 SV* lparen;
11919                 if (top_index < 1
11920                     || ! (current = av_pop(stack))
11921                     || ! IS_OPERAND(current)
11922                     || ! (lparen = av_pop(stack))
11923                     || IS_OPERAND(lparen)
11924                     || SvUV(lparen) != '(')
11925                 {
11926                     SvREFCNT_dec(current);
11927                     RExC_parse++;
11928                     vFAIL("Unexpected ')'");
11929                 }
11930                 top_index -= 2;
11931                 SvREFCNT_dec_NN(lparen);
11932
11933                 /* FALL THROUGH */
11934             }
11935
11936               handle_operand:
11937
11938                 /* Here, we have an operand to process, in 'current' */
11939
11940                 if (top_index < 0) {    /* Just push if stack is empty */
11941                     av_push(stack, current);
11942                 }
11943                 else {
11944                     SV* top = av_pop(stack);
11945                     SV *prev = NULL;
11946                     char current_operator;
11947
11948                     if (IS_OPERAND(top)) {
11949                         SvREFCNT_dec_NN(top);
11950                         SvREFCNT_dec_NN(current);
11951                         vFAIL("Operand with no preceding operator");
11952                     }
11953                     current_operator = (char) SvUV(top);
11954                     switch (current_operator) {
11955                         case '(':   /* Push the '(' back on followed by the new
11956                                        operand */
11957                             av_push(stack, top);
11958                             av_push(stack, current);
11959                             SvREFCNT_inc(top);  /* Counters the '_dec' done
11960                                                    just after the 'break', so
11961                                                    it doesn't get wrongly freed
11962                                                  */
11963                             break;
11964
11965                         case '!':
11966                             _invlist_invert(current);
11967
11968                             /* Unlike binary operators, the top of the stack,
11969                              * now that this unary one has been popped off, may
11970                              * legally be an operator, and we now have operand
11971                              * for it. */
11972                             top_index--;
11973                             SvREFCNT_dec_NN(top);
11974                             goto handle_operand;
11975
11976                         case '&':
11977                             prev = av_pop(stack);
11978                             _invlist_intersection(prev,
11979                                                    current,
11980                                                    &current);
11981                             av_push(stack, current);
11982                             break;
11983
11984                         case '|':
11985                         case '+':
11986                             prev = av_pop(stack);
11987                             _invlist_union(prev, current, &current);
11988                             av_push(stack, current);
11989                             break;
11990
11991                         case '-':
11992                             prev = av_pop(stack);;
11993                             _invlist_subtract(prev, current, &current);
11994                             av_push(stack, current);
11995                             break;
11996
11997                         case '^':   /* The union minus the intersection */
11998                         {
11999                             SV* i = NULL;
12000                             SV* u = NULL;
12001                             SV* element;
12002
12003                             prev = av_pop(stack);
12004                             _invlist_union(prev, current, &u);
12005                             _invlist_intersection(prev, current, &i);
12006                             /* _invlist_subtract will overwrite current
12007                                 without freeing what it already contains */
12008                             element = current;
12009                             _invlist_subtract(u, i, &current);
12010                             av_push(stack, current);
12011                             SvREFCNT_dec_NN(i);
12012                             SvREFCNT_dec_NN(u);
12013                             SvREFCNT_dec_NN(element);
12014                             break;
12015                         }
12016
12017                         default:
12018                             Perl_croak(aTHX_ "panic: Unexpected item on '(?[ ])' stack");
12019                 }
12020                 SvREFCNT_dec_NN(top);
12021                 SvREFCNT_dec(prev);
12022             }
12023         }
12024
12025         RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
12026     }
12027
12028     if (av_tindex(stack) < 0   /* Was empty */
12029         || ((final = av_pop(stack)) == NULL)
12030         || ! IS_OPERAND(final)
12031         || av_tindex(stack) >= 0)  /* More left on stack */
12032     {
12033         vFAIL("Incomplete expression within '(?[ ])'");
12034     }
12035
12036     /* Here, 'final' is the resultant inversion list from evaluating the
12037      * expression.  Return it if so requested */
12038     if (return_invlist) {
12039         *return_invlist = final;
12040         return END;
12041     }
12042
12043     /* Otherwise generate a resultant node, based on 'final'.  regclass() is
12044      * expecting a string of ranges and individual code points */
12045     invlist_iterinit(final);
12046     result_string = newSVpvs("");
12047     while (invlist_iternext(final, &start, &end)) {
12048         if (start == end) {
12049             Perl_sv_catpvf(aTHX_ result_string, "\\x{%"UVXf"}", start);
12050         }
12051         else {
12052             Perl_sv_catpvf(aTHX_ result_string, "\\x{%"UVXf"}-\\x{%"UVXf"}",
12053                                                      start,          end);
12054         }
12055     }
12056
12057     save_parse = RExC_parse;
12058     RExC_parse = SvPV(result_string, len);
12059     save_end = RExC_end;
12060     RExC_end = RExC_parse + len;
12061
12062     /* We turn off folding around the call, as the class we have constructed
12063      * already has all folding taken into consideration, and we don't want
12064      * regclass() to add to that */
12065     RExC_flags &= ~RXf_PMf_FOLD;
12066     /* regclass() can only return RESTART_UTF8 if multi-char folds are allowed.
12067      */
12068     node = regclass(pRExC_state, flagp,depth+1,
12069                     FALSE, /* means parse the whole char class */
12070                     FALSE, /* don't allow multi-char folds */
12071                     TRUE, /* silence non-portable warnings.  The above may very
12072                              well have generated non-portable code points, but
12073                              they're valid on this machine */
12074                     NULL);
12075     if (!node)
12076         FAIL2("panic: regclass returned NULL to handle_sets, flags=%#"UVxf,
12077                     PTR2UV(flagp));
12078     if (save_fold) {
12079         RExC_flags |= RXf_PMf_FOLD;
12080     }
12081     RExC_parse = save_parse + 1;
12082     RExC_end = save_end;
12083     SvREFCNT_dec_NN(final);
12084     SvREFCNT_dec_NN(result_string);
12085
12086     nextchar(pRExC_state);
12087     Set_Node_Length(node, RExC_parse - oregcomp_parse + 1); /* MJD */
12088     return node;
12089 }
12090 #undef IS_OPERAND
12091
12092 /* The names of properties whose definitions are not known at compile time are
12093  * stored in this SV, after a constant heading.  So if the length has been
12094  * changed since initialization, then there is a run-time definition. */
12095 #define HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION (SvCUR(listsv) != initial_listsv_len)
12096
12097 STATIC regnode *
12098 S_regclass(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth,
12099                  const bool stop_at_1,  /* Just parse the next thing, don't
12100                                            look for a full character class */
12101                  bool allow_multi_folds,
12102                  const bool silence_non_portable,   /* Don't output warnings
12103                                                        about too large
12104                                                        characters */
12105                  SV** ret_invlist)  /* Return an inversion list, not a node */
12106 {
12107     /* parse a bracketed class specification.  Most of these will produce an
12108      * ANYOF node; but something like [a] will produce an EXACT node; [aA], an
12109      * EXACTFish node; [[:ascii:]], a POSIXA node; etc.  It is more complex
12110      * under /i with multi-character folds: it will be rewritten following the
12111      * paradigm of this example, where the <multi-fold>s are characters which
12112      * fold to multiple character sequences:
12113      *      /[abc\x{multi-fold1}def\x{multi-fold2}ghi]/i
12114      * gets effectively rewritten as:
12115      *      /(?:\x{multi-fold1}|\x{multi-fold2}|[abcdefghi]/i
12116      * reg() gets called (recursively) on the rewritten version, and this
12117      * function will return what it constructs.  (Actually the <multi-fold>s
12118      * aren't physically removed from the [abcdefghi], it's just that they are
12119      * ignored in the recursion by means of a flag:
12120      * <RExC_in_multi_char_class>.)
12121      *
12122      * ANYOF nodes contain a bit map for the first 256 characters, with the
12123      * corresponding bit set if that character is in the list.  For characters
12124      * above 255, a range list or swash is used.  There are extra bits for \w,
12125      * etc. in locale ANYOFs, as what these match is not determinable at
12126      * compile time
12127      *
12128      * Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan needs
12129      * to be restarted.  This can only happen if ret_invlist is non-NULL.
12130      */
12131
12132     dVAR;
12133     UV prevvalue = OOB_UNICODE, save_prevvalue = OOB_UNICODE;
12134     IV range = 0;
12135     UV value = OOB_UNICODE, save_value = OOB_UNICODE;
12136     regnode *ret;
12137     STRLEN numlen;
12138     IV namedclass = OOB_NAMEDCLASS;
12139     char *rangebegin = NULL;
12140     bool need_class = 0;
12141     SV *listsv = NULL;
12142     STRLEN initial_listsv_len = 0; /* Kind of a kludge to see if it is more
12143                                       than just initialized.  */
12144     SV* properties = NULL;    /* Code points that match \p{} \P{} */
12145     SV* posixes = NULL;     /* Code points that match classes like, [:word:],
12146                                extended beyond the Latin1 range */
12147     UV element_count = 0;   /* Number of distinct elements in the class.
12148                                Optimizations may be possible if this is tiny */
12149     AV * multi_char_matches = NULL; /* Code points that fold to more than one
12150                                        character; used under /i */
12151     UV n;
12152     char * stop_ptr = RExC_end;    /* where to stop parsing */
12153     const bool skip_white = cBOOL(ret_invlist); /* ignore unescaped white
12154                                                    space? */
12155     const bool strict = cBOOL(ret_invlist); /* Apply strict parsing rules? */
12156
12157     /* Unicode properties are stored in a swash; this holds the current one
12158      * being parsed.  If this swash is the only above-latin1 component of the
12159      * character class, an optimization is to pass it directly on to the
12160      * execution engine.  Otherwise, it is set to NULL to indicate that there
12161      * are other things in the class that have to be dealt with at execution
12162      * time */
12163     SV* swash = NULL;           /* Code points that match \p{} \P{} */
12164
12165     /* Set if a component of this character class is user-defined; just passed
12166      * on to the engine */
12167     bool has_user_defined_property = FALSE;
12168
12169     /* inversion list of code points this node matches only when the target
12170      * string is in UTF-8.  (Because is under /d) */
12171     SV* depends_list = NULL;
12172
12173     /* inversion list of code points this node matches.  For much of the
12174      * function, it includes only those that match regardless of the utf8ness
12175      * of the target string */
12176     SV* cp_list = NULL;
12177
12178 #ifdef EBCDIC
12179     /* In a range, counts how many 0-2 of the ends of it came from literals,
12180      * not escapes.  Thus we can tell if 'A' was input vs \x{C1} */
12181     UV literal_endpoint = 0;
12182 #endif
12183     bool invert = FALSE;    /* Is this class to be complemented */
12184
12185     /* Is there any thing like \W or [:^digit:] that matches above the legal
12186      * Unicode range? */
12187     bool runtime_posix_matches_above_Unicode = FALSE;
12188
12189     regnode * const orig_emit = RExC_emit; /* Save the original RExC_emit in
12190         case we need to change the emitted regop to an EXACT. */
12191     const char * orig_parse = RExC_parse;
12192     const I32 orig_size = RExC_size;
12193     GET_RE_DEBUG_FLAGS_DECL;
12194
12195     PERL_ARGS_ASSERT_REGCLASS;
12196 #ifndef DEBUGGING
12197     PERL_UNUSED_ARG(depth);
12198 #endif
12199
12200     DEBUG_PARSE("clas");
12201
12202     /* Assume we are going to generate an ANYOF node. */
12203     ret = reganode(pRExC_state, ANYOF, 0);
12204
12205     if (SIZE_ONLY) {
12206         RExC_size += ANYOF_SKIP;
12207         listsv = &PL_sv_undef; /* For code scanners: listsv always non-NULL. */
12208     }
12209     else {
12210         ANYOF_FLAGS(ret) = 0;
12211
12212         RExC_emit += ANYOF_SKIP;
12213         if (LOC) {
12214             ANYOF_FLAGS(ret) |= ANYOF_LOCALE;
12215         }
12216         listsv = newSVpvs_flags("# comment\n", SVs_TEMP);
12217         initial_listsv_len = SvCUR(listsv);
12218         SvTEMP_off(listsv); /* Grr, TEMPs and mortals are conflated.  */
12219     }
12220
12221     if (skip_white) {
12222         RExC_parse = regpatws(pRExC_state, RExC_parse,
12223                               FALSE /* means don't recognize comments */);
12224     }
12225
12226     if (UCHARAT(RExC_parse) == '^') {   /* Complement of range. */
12227         RExC_parse++;
12228         invert = TRUE;
12229         allow_multi_folds = FALSE;
12230         RExC_naughty++;
12231         if (skip_white) {
12232             RExC_parse = regpatws(pRExC_state, RExC_parse,
12233                                   FALSE /* means don't recognize comments */);
12234         }
12235     }
12236
12237     /* Check that they didn't say [:posix:] instead of [[:posix:]] */
12238     if (!SIZE_ONLY && RExC_parse < RExC_end && POSIXCC(UCHARAT(RExC_parse))) {
12239         const char *s = RExC_parse;
12240         const char  c = *s++;
12241
12242         while (isWORDCHAR(*s))
12243             s++;
12244         if (*s && c == *s && s[1] == ']') {
12245             SAVEFREESV(RExC_rx_sv);
12246             ckWARN3reg(s+2,
12247                        "POSIX syntax [%c %c] belongs inside character classes",
12248                        c, c);
12249             (void)ReREFCNT_inc(RExC_rx_sv);
12250         }
12251     }
12252
12253     /* If the caller wants us to just parse a single element, accomplish this
12254      * by faking the loop ending condition */
12255     if (stop_at_1 && RExC_end > RExC_parse) {
12256         stop_ptr = RExC_parse + 1;
12257     }
12258
12259     /* allow 1st char to be ']' (allowing it to be '-' is dealt with later) */
12260     if (UCHARAT(RExC_parse) == ']')
12261         goto charclassloop;
12262
12263 parseit:
12264     while (1) {
12265         if  (RExC_parse >= stop_ptr) {
12266             break;
12267         }
12268
12269         if (skip_white) {
12270             RExC_parse = regpatws(pRExC_state, RExC_parse,
12271                                   FALSE /* means don't recognize comments */);
12272         }
12273
12274         if  (UCHARAT(RExC_parse) == ']') {
12275             break;
12276         }
12277
12278     charclassloop:
12279
12280         namedclass = OOB_NAMEDCLASS; /* initialize as illegal */
12281         save_value = value;
12282         save_prevvalue = prevvalue;
12283
12284         if (!range) {
12285             rangebegin = RExC_parse;
12286             element_count++;
12287         }
12288         if (UTF) {
12289             value = utf8n_to_uvchr((U8*)RExC_parse,
12290                                    RExC_end - RExC_parse,
12291                                    &numlen, UTF8_ALLOW_DEFAULT);
12292             RExC_parse += numlen;
12293         }
12294         else
12295             value = UCHARAT(RExC_parse++);
12296
12297         if (value == '['
12298             && RExC_parse < RExC_end
12299             && POSIXCC(UCHARAT(RExC_parse)))
12300         {
12301             namedclass = regpposixcc(pRExC_state, value, strict);
12302         }
12303         else if (value == '\\') {
12304             if (UTF) {
12305                 value = utf8n_to_uvchr((U8*)RExC_parse,
12306                                    RExC_end - RExC_parse,
12307                                    &numlen, UTF8_ALLOW_DEFAULT);
12308                 RExC_parse += numlen;
12309             }
12310             else
12311                 value = UCHARAT(RExC_parse++);
12312
12313             /* Some compilers cannot handle switching on 64-bit integer
12314              * values, therefore value cannot be an UV.  Yes, this will
12315              * be a problem later if we want switch on Unicode.
12316              * A similar issue a little bit later when switching on
12317              * namedclass. --jhi */
12318
12319             /* If the \ is escaping white space when white space is being
12320              * skipped, it means that that white space is wanted literally, and
12321              * is already in 'value'.  Otherwise, need to translate the escape
12322              * into what it signifies. */
12323             if (! skip_white || ! is_PATWS_cp(value)) switch ((I32)value) {
12324
12325             case 'w':   namedclass = ANYOF_WORDCHAR;    break;
12326             case 'W':   namedclass = ANYOF_NWORDCHAR;   break;
12327             case 's':   namedclass = ANYOF_SPACE;       break;
12328             case 'S':   namedclass = ANYOF_NSPACE;      break;
12329             case 'd':   namedclass = ANYOF_DIGIT;       break;
12330             case 'D':   namedclass = ANYOF_NDIGIT;      break;
12331             case 'v':   namedclass = ANYOF_VERTWS;      break;
12332             case 'V':   namedclass = ANYOF_NVERTWS;     break;
12333             case 'h':   namedclass = ANYOF_HORIZWS;     break;
12334             case 'H':   namedclass = ANYOF_NHORIZWS;    break;
12335             case 'N':  /* Handle \N{NAME} in class */
12336                 {
12337                     /* We only pay attention to the first char of 
12338                     multichar strings being returned. I kinda wonder
12339                     if this makes sense as it does change the behaviour
12340                     from earlier versions, OTOH that behaviour was broken
12341                     as well. */
12342                     if (! grok_bslash_N(pRExC_state, NULL, &value, flagp, depth,
12343                                       TRUE, /* => charclass */
12344                                       strict))
12345                     {
12346                         if (*flagp & RESTART_UTF8)
12347                             FAIL("panic: grok_bslash_N set RESTART_UTF8");
12348                         goto parseit;
12349                     }
12350                 }
12351                 break;
12352             case 'p':
12353             case 'P':
12354                 {
12355                 char *e;
12356
12357                 /* We will handle any undefined properties ourselves */
12358                 U8 swash_init_flags = _CORE_SWASH_INIT_RETURN_IF_UNDEF;
12359
12360                 if (RExC_parse >= RExC_end)
12361                     vFAIL2("Empty \\%c{}", (U8)value);
12362                 if (*RExC_parse == '{') {
12363                     const U8 c = (U8)value;
12364                     e = strchr(RExC_parse++, '}');
12365                     if (!e)
12366                         vFAIL2("Missing right brace on \\%c{}", c);
12367                     while (isSPACE(UCHARAT(RExC_parse)))
12368                         RExC_parse++;
12369                     if (e == RExC_parse)
12370                         vFAIL2("Empty \\%c{}", c);
12371                     n = e - RExC_parse;
12372                     while (isSPACE(UCHARAT(RExC_parse + n - 1)))
12373                         n--;
12374                 }
12375                 else {
12376                     e = RExC_parse;
12377                     n = 1;
12378                 }
12379                 if (!SIZE_ONLY) {
12380                     SV* invlist;
12381                     char* name;
12382
12383                     if (UCHARAT(RExC_parse) == '^') {
12384                          RExC_parse++;
12385                          n--;
12386                          /* toggle.  (The rhs xor gets the single bit that
12387                           * differs between P and p; the other xor inverts just
12388                           * that bit) */
12389                          value ^= 'P' ^ 'p';
12390
12391                          while (isSPACE(UCHARAT(RExC_parse))) {
12392                               RExC_parse++;
12393                               n--;
12394                          }
12395                     }
12396                     /* Try to get the definition of the property into
12397                      * <invlist>.  If /i is in effect, the effective property
12398                      * will have its name be <__NAME_i>.  The design is
12399                      * discussed in commit
12400                      * 2f833f5208e26b208886e51e09e2c072b5eabb46 */
12401                     Newx(name, n + sizeof("_i__\n"), char);
12402
12403                     sprintf(name, "%s%.*s%s\n",
12404                                     (FOLD) ? "__" : "",
12405                                     (int)n,
12406                                     RExC_parse,
12407                                     (FOLD) ? "_i" : ""
12408                     );
12409
12410                     /* Look up the property name, and get its swash and
12411                      * inversion list, if the property is found  */
12412                     if (swash) {
12413                         SvREFCNT_dec_NN(swash);
12414                     }
12415                     swash = _core_swash_init("utf8", name, &PL_sv_undef,
12416                                              1, /* binary */
12417                                              0, /* not tr/// */
12418                                              NULL, /* No inversion list */
12419                                              &swash_init_flags
12420                                             );
12421                     if (! swash || ! (invlist = _get_swash_invlist(swash))) {
12422                         if (swash) {
12423                             SvREFCNT_dec_NN(swash);
12424                             swash = NULL;
12425                         }
12426
12427                         /* Here didn't find it.  It could be a user-defined
12428                          * property that will be available at run-time.  If we
12429                          * accept only compile-time properties, is an error;
12430                          * otherwise add it to the list for run-time look up */
12431                         if (ret_invlist) {
12432                             RExC_parse = e + 1;
12433                             vFAIL3("Property '%.*s' is unknown", (int) n, name);
12434                         }
12435                         Perl_sv_catpvf(aTHX_ listsv, "%cutf8::%s\n",
12436                                         (value == 'p' ? '+' : '!'),
12437                                         name);
12438                         has_user_defined_property = TRUE;
12439
12440                         /* We don't know yet, so have to assume that the
12441                          * property could match something in the Latin1 range,
12442                          * hence something that isn't utf8.  Note that this
12443                          * would cause things in <depends_list> to match
12444                          * inappropriately, except that any \p{}, including
12445                          * this one forces Unicode semantics, which means there
12446                          * is <no depends_list> */
12447                         ANYOF_FLAGS(ret) |= ANYOF_NONBITMAP_NON_UTF8;
12448                     }
12449                     else {
12450
12451                         /* Here, did get the swash and its inversion list.  If
12452                          * the swash is from a user-defined property, then this
12453                          * whole character class should be regarded as such */
12454                         has_user_defined_property =
12455                                     (swash_init_flags
12456                                      & _CORE_SWASH_INIT_USER_DEFINED_PROPERTY);
12457
12458                         /* Invert if asking for the complement */
12459                         if (value == 'P') {
12460                             _invlist_union_complement_2nd(properties,
12461                                                           invlist,
12462                                                           &properties);
12463
12464                             /* The swash can't be used as-is, because we've
12465                              * inverted things; delay removing it to here after
12466                              * have copied its invlist above */
12467                             SvREFCNT_dec_NN(swash);
12468                             swash = NULL;
12469                         }
12470                         else {
12471                             _invlist_union(properties, invlist, &properties);
12472                         }
12473                     }
12474                     Safefree(name);
12475                 }
12476                 RExC_parse = e + 1;
12477                 namedclass = ANYOF_UNIPROP;  /* no official name, but it's
12478                                                 named */
12479
12480                 /* \p means they want Unicode semantics */
12481                 RExC_uni_semantics = 1;
12482                 }
12483                 break;
12484             case 'n':   value = '\n';                   break;
12485             case 'r':   value = '\r';                   break;
12486             case 't':   value = '\t';                   break;
12487             case 'f':   value = '\f';                   break;
12488             case 'b':   value = '\b';                   break;
12489             case 'e':   value = ASCII_TO_NATIVE('\033');break;
12490             case 'a':   value = ASCII_TO_NATIVE('\007');break;
12491             case 'o':
12492                 RExC_parse--;   /* function expects to be pointed at the 'o' */
12493                 {
12494                     const char* error_msg;
12495                     bool valid = grok_bslash_o(&RExC_parse,
12496                                                &value,
12497                                                &error_msg,
12498                                                SIZE_ONLY,   /* warnings in pass
12499                                                                1 only */
12500                                                strict,
12501                                                silence_non_portable,
12502                                                UTF);
12503                     if (! valid) {
12504                         vFAIL(error_msg);
12505                     }
12506                 }
12507                 if (PL_encoding && value < 0x100) {
12508                     goto recode_encoding;
12509                 }
12510                 break;
12511             case 'x':
12512                 RExC_parse--;   /* function expects to be pointed at the 'x' */
12513                 {
12514                     const char* error_msg;
12515                     bool valid = grok_bslash_x(&RExC_parse,
12516                                                &value,
12517                                                &error_msg,
12518                                                TRUE, /* Output warnings */
12519                                                strict,
12520                                                silence_non_portable,
12521                                                UTF);
12522                     if (! valid) {
12523                         vFAIL(error_msg);
12524                     }
12525                 }
12526                 if (PL_encoding && value < 0x100)
12527                     goto recode_encoding;
12528                 break;
12529             case 'c':
12530                 value = grok_bslash_c(*RExC_parse++, UTF, SIZE_ONLY);
12531                 break;
12532             case '0': case '1': case '2': case '3': case '4':
12533             case '5': case '6': case '7':
12534                 {
12535                     /* Take 1-3 octal digits */
12536                     I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
12537                     numlen = (strict) ? 4 : 3;
12538                     value = grok_oct(--RExC_parse, &numlen, &flags, NULL);
12539                     RExC_parse += numlen;
12540                     if (numlen != 3) {
12541                         if (strict) {
12542                             RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
12543                             vFAIL("Need exactly 3 octal digits");
12544                         }
12545                         else if (! SIZE_ONLY /* like \08, \178 */
12546                                  && numlen < 3
12547                                  && RExC_parse < RExC_end
12548                                  && isDIGIT(*RExC_parse)
12549                                  && ckWARN(WARN_REGEXP))
12550                         {
12551                             SAVEFREESV(RExC_rx_sv);
12552                             reg_warn_non_literal_string(
12553                                  RExC_parse + 1,
12554                                  form_short_octal_warning(RExC_parse, numlen));
12555                             (void)ReREFCNT_inc(RExC_rx_sv);
12556                         }
12557                     }
12558                     if (PL_encoding && value < 0x100)
12559                         goto recode_encoding;
12560                     break;
12561                 }
12562             recode_encoding:
12563                 if (! RExC_override_recoding) {
12564                     SV* enc = PL_encoding;
12565                     value = reg_recode((const char)(U8)value, &enc);
12566                     if (!enc) {
12567                         if (strict) {
12568                             vFAIL("Invalid escape in the specified encoding");
12569                         }
12570                         else if (SIZE_ONLY) {
12571                             ckWARNreg(RExC_parse,
12572                                   "Invalid escape in the specified encoding");
12573                         }
12574                     }
12575                     break;
12576                 }
12577             default:
12578                 /* Allow \_ to not give an error */
12579                 if (!SIZE_ONLY && isWORDCHAR(value) && value != '_') {
12580                     if (strict) {
12581                         vFAIL2("Unrecognized escape \\%c in character class",
12582                                (int)value);
12583                     }
12584                     else {
12585                         SAVEFREESV(RExC_rx_sv);
12586                         ckWARN2reg(RExC_parse,
12587                             "Unrecognized escape \\%c in character class passed through",
12588                             (int)value);
12589                         (void)ReREFCNT_inc(RExC_rx_sv);
12590                     }
12591                 }
12592                 break;
12593             }   /* End of switch on char following backslash */
12594         } /* end of handling backslash escape sequences */
12595 #ifdef EBCDIC
12596         else
12597             literal_endpoint++;
12598 #endif
12599
12600         /* Here, we have the current token in 'value' */
12601
12602         /* What matches in a locale is not known until runtime.  This includes
12603          * what the Posix classes (like \w, [:space:]) match.  Room must be
12604          * reserved (one time per class) to store such classes, either if Perl
12605          * is compiled so that locale nodes always should have this space, or
12606          * if there is such class info to be stored.  The space will contain a
12607          * bit for each named class that is to be matched against.  This isn't
12608          * needed for \p{} and pseudo-classes, as they are not affected by
12609          * locale, and hence are dealt with separately */
12610         if (LOC
12611             && ! need_class
12612             && (ANYOF_LOCALE == ANYOF_CLASS
12613                 || (namedclass > OOB_NAMEDCLASS && namedclass < ANYOF_MAX)))
12614         {
12615             need_class = 1;
12616             if (SIZE_ONLY) {
12617                 RExC_size += ANYOF_CLASS_SKIP - ANYOF_SKIP;
12618             }
12619             else {
12620                 RExC_emit += ANYOF_CLASS_SKIP - ANYOF_SKIP;
12621                 ANYOF_CLASS_ZERO(ret);
12622             }
12623             ANYOF_FLAGS(ret) |= ANYOF_CLASS;
12624         }
12625
12626         if (namedclass > OOB_NAMEDCLASS) { /* this is a named class \blah */
12627
12628             /* a bad range like a-\d, a-[:digit:].  The '-' is taken as a
12629              * literal, as is the character that began the false range, i.e.
12630              * the 'a' in the examples */
12631             if (range) {
12632                 if (!SIZE_ONLY) {
12633                     const int w = (RExC_parse >= rangebegin)
12634                                   ? RExC_parse - rangebegin
12635                                   : 0;
12636                     if (strict) {
12637                         vFAIL4("False [] range \"%*.*s\"", w, w, rangebegin);
12638                     }
12639                     else {
12640                         SAVEFREESV(RExC_rx_sv); /* in case of fatal warnings */
12641                         ckWARN4reg(RExC_parse,
12642                                 "False [] range \"%*.*s\"",
12643                                 w, w, rangebegin);
12644                         (void)ReREFCNT_inc(RExC_rx_sv);
12645                         cp_list = add_cp_to_invlist(cp_list, '-');
12646                         cp_list = add_cp_to_invlist(cp_list, prevvalue);
12647                     }
12648                 }
12649
12650                 range = 0; /* this was not a true range */
12651                 element_count += 2; /* So counts for three values */
12652             }
12653
12654             if (! SIZE_ONLY) {
12655                 U8 classnum = namedclass_to_classnum(namedclass);
12656                 if (namedclass >= ANYOF_MAX) {  /* If a special class */
12657                     if (namedclass != ANYOF_UNIPROP) { /* UNIPROP = \p and \P */
12658
12659                         /* Here, should be \h, \H, \v, or \V.  Neither /d nor
12660                          * /l make a difference in what these match.  There
12661                          * would be problems if these characters had folds
12662                          * other than themselves, as cp_list is subject to
12663                          * folding. */
12664                         if (classnum != _CC_VERTSPACE) {
12665                             assert(   namedclass == ANYOF_HORIZWS
12666                                    || namedclass == ANYOF_NHORIZWS);
12667
12668                             /* It turns out that \h is just a synonym for
12669                              * XPosixBlank */
12670                             classnum = _CC_BLANK;
12671                         }
12672
12673                         _invlist_union_maybe_complement_2nd(
12674                                 cp_list,
12675                                 PL_XPosix_ptrs[classnum],
12676                                 cBOOL(namedclass % 2), /* Complement if odd
12677                                                           (NHORIZWS, NVERTWS)
12678                                                         */
12679                                 &cp_list);
12680                     }
12681                 }
12682                 else if (classnum == _CC_ASCII) {
12683 #ifdef HAS_ISASCII
12684                     if (LOC) {
12685                         ANYOF_CLASS_SET(ret, namedclass);
12686                     }
12687                     else
12688 #endif  /* Not isascii(); just use the hard-coded definition for it */
12689                         _invlist_union_maybe_complement_2nd(
12690                                 posixes,
12691                                 PL_ASCII,
12692                                 cBOOL(namedclass % 2), /* Complement if odd
12693                                                           (NASCII) */
12694                                 &posixes);
12695                 }
12696                 else {  /* Garden variety class */
12697
12698                     /* The ascii range inversion list */
12699                     SV* ascii_source = PL_Posix_ptrs[classnum];
12700
12701                     /* The full Latin1 range inversion list */
12702                     SV* l1_source = PL_L1Posix_ptrs[classnum];
12703
12704                     /* This code is structured into two major clauses.  The
12705                      * first is for classes whose complete definitions may not
12706                      * already be known.  It not, the Latin1 definition
12707                      * (guaranteed to already known) is used plus code is
12708                      * generated to load the rest at run-time (only if needed).
12709                      * If the complete definition is known, it drops down to
12710                      * the second clause, where the complete definition is
12711                      * known */
12712
12713                     if (classnum < _FIRST_NON_SWASH_CC) {
12714
12715                         /* Here, the class has a swash, which may or not
12716                          * already be loaded */
12717
12718                         /* The name of the property to use to match the full
12719                          * eXtended Unicode range swash for this character
12720                          * class */
12721                         const char *Xname = swash_property_names[classnum];
12722
12723                         /* If returning the inversion list, we can't defer
12724                          * getting this until runtime */
12725                         if (ret_invlist && !  PL_utf8_swash_ptrs[classnum]) {
12726                             PL_utf8_swash_ptrs[classnum] =
12727                                 _core_swash_init("utf8", Xname, &PL_sv_undef,
12728                                              1, /* binary */
12729                                              0, /* not tr/// */
12730                                              NULL, /* No inversion list */
12731                                              NULL  /* No flags */
12732                                             );
12733                             assert(PL_utf8_swash_ptrs[classnum]);
12734                         }
12735                         if ( !  PL_utf8_swash_ptrs[classnum]) {
12736                             if (namedclass % 2 == 0) { /* A non-complemented
12737                                                           class */
12738                                 /* If not /a matching, there are code points we
12739                                  * don't know at compile time.  Arrange for the
12740                                  * unknown matches to be loaded at run-time, if
12741                                  * needed */
12742                                 if (! AT_LEAST_ASCII_RESTRICTED) {
12743                                     Perl_sv_catpvf(aTHX_ listsv, "+utf8::%s\n",
12744                                                                  Xname);
12745                                 }
12746                                 if (LOC) {  /* Under locale, set run-time
12747                                                lookup */
12748                                     ANYOF_CLASS_SET(ret, namedclass);
12749                                 }
12750                                 else {
12751                                     /* Add the current class's code points to
12752                                      * the running total */
12753                                     _invlist_union(posixes,
12754                                                    (AT_LEAST_ASCII_RESTRICTED)
12755                                                         ? ascii_source
12756                                                         : l1_source,
12757                                                    &posixes);
12758                                 }
12759                             }
12760                             else {  /* A complemented class */
12761                                 if (AT_LEAST_ASCII_RESTRICTED) {
12762                                     /* Under /a should match everything above
12763                                      * ASCII, plus the complement of the set's
12764                                      * ASCII matches */
12765                                     _invlist_union_complement_2nd(posixes,
12766                                                                   ascii_source,
12767                                                                   &posixes);
12768                                 }
12769                                 else {
12770                                     /* Arrange for the unknown matches to be
12771                                      * loaded at run-time, if needed */
12772                                     Perl_sv_catpvf(aTHX_ listsv, "!utf8::%s\n",
12773                                                                  Xname);
12774                                     runtime_posix_matches_above_Unicode = TRUE;
12775                                     if (LOC) {
12776                                         ANYOF_CLASS_SET(ret, namedclass);
12777                                     }
12778                                     else {
12779
12780                                         /* We want to match everything in
12781                                          * Latin1, except those things that
12782                                          * l1_source matches */
12783                                         SV* scratch_list = NULL;
12784                                         _invlist_subtract(PL_Latin1, l1_source,
12785                                                           &scratch_list);
12786
12787                                         /* Add the list from this class to the
12788                                          * running total */
12789                                         if (! posixes) {
12790                                             posixes = scratch_list;
12791                                         }
12792                                         else {
12793                                             _invlist_union(posixes,
12794                                                            scratch_list,
12795                                                            &posixes);
12796                                             SvREFCNT_dec_NN(scratch_list);
12797                                         }
12798                                         if (DEPENDS_SEMANTICS) {
12799                                             ANYOF_FLAGS(ret)
12800                                                   |= ANYOF_NON_UTF8_LATIN1_ALL;
12801                                         }
12802                                     }
12803                                 }
12804                             }
12805                             goto namedclass_done;
12806                         }
12807
12808                         /* Here, there is a swash loaded for the class.  If no
12809                          * inversion list for it yet, get it */
12810                         if (! PL_XPosix_ptrs[classnum]) {
12811                             PL_XPosix_ptrs[classnum]
12812                              = _swash_to_invlist(PL_utf8_swash_ptrs[classnum]);
12813                         }
12814                     }
12815
12816                     /* Here there is an inversion list already loaded for the
12817                      * entire class */
12818
12819                     if (namedclass % 2 == 0) {  /* A non-complemented class,
12820                                                    like ANYOF_PUNCT */
12821                         if (! LOC) {
12822                             /* For non-locale, just add it to any existing list
12823                              * */
12824                             _invlist_union(posixes,
12825                                            (AT_LEAST_ASCII_RESTRICTED)
12826                                                ? ascii_source
12827                                                : PL_XPosix_ptrs[classnum],
12828                                            &posixes);
12829                         }
12830                         else {  /* Locale */
12831                             SV* scratch_list = NULL;
12832
12833                             /* For above Latin1 code points, we use the full
12834                              * Unicode range */
12835                             _invlist_intersection(PL_AboveLatin1,
12836                                                   PL_XPosix_ptrs[classnum],
12837                                                   &scratch_list);
12838                             /* And set the output to it, adding instead if
12839                              * there already is an output.  Checking if
12840                              * 'posixes' is NULL first saves an extra clone.
12841                              * Its reference count will be decremented at the
12842                              * next union, etc, or if this is the only
12843                              * instance, at the end of the routine */
12844                             if (! posixes) {
12845                                 posixes = scratch_list;
12846                             }
12847                             else {
12848                                 _invlist_union(posixes, scratch_list, &posixes);
12849                                 SvREFCNT_dec_NN(scratch_list);
12850                             }
12851
12852 #ifndef HAS_ISBLANK
12853                             if (namedclass != ANYOF_BLANK) {
12854 #endif
12855                                 /* Set this class in the node for runtime
12856                                  * matching */
12857                                 ANYOF_CLASS_SET(ret, namedclass);
12858 #ifndef HAS_ISBLANK
12859                             }
12860                             else {
12861                                 /* No isblank(), use the hard-coded ASCII-range
12862                                  * blanks, adding them to the running total. */
12863
12864                                 _invlist_union(posixes, ascii_source, &posixes);
12865                             }
12866 #endif
12867                         }
12868                     }
12869                     else {  /* A complemented class, like ANYOF_NPUNCT */
12870                         if (! LOC) {
12871                             _invlist_union_complement_2nd(
12872                                                 posixes,
12873                                                 (AT_LEAST_ASCII_RESTRICTED)
12874                                                     ? ascii_source
12875                                                     : PL_XPosix_ptrs[classnum],
12876                                                 &posixes);
12877                             /* Under /d, everything in the upper half of the
12878                              * Latin1 range matches this complement */
12879                             if (DEPENDS_SEMANTICS) {
12880                                 ANYOF_FLAGS(ret) |= ANYOF_NON_UTF8_LATIN1_ALL;
12881                             }
12882                         }
12883                         else {  /* Locale */
12884                             SV* scratch_list = NULL;
12885                             _invlist_subtract(PL_AboveLatin1,
12886                                               PL_XPosix_ptrs[classnum],
12887                                               &scratch_list);
12888                             if (! posixes) {
12889                                 posixes = scratch_list;
12890                             }
12891                             else {
12892                                 _invlist_union(posixes, scratch_list, &posixes);
12893                                 SvREFCNT_dec_NN(scratch_list);
12894                             }
12895 #ifndef HAS_ISBLANK
12896                             if (namedclass != ANYOF_NBLANK) {
12897 #endif
12898                                 ANYOF_CLASS_SET(ret, namedclass);
12899 #ifndef HAS_ISBLANK
12900                             }
12901                             else {
12902                                 /* Get the list of all code points in Latin1
12903                                  * that are not ASCII blanks, and add them to
12904                                  * the running total */
12905                                 _invlist_subtract(PL_Latin1, ascii_source,
12906                                                   &scratch_list);
12907                                 _invlist_union(posixes, scratch_list, &posixes);
12908                                 SvREFCNT_dec_NN(scratch_list);
12909                             }
12910 #endif
12911                         }
12912                     }
12913                 }
12914               namedclass_done:
12915                 continue;   /* Go get next character */
12916             }
12917         } /* end of namedclass \blah */
12918
12919         /* Here, we have a single value.  If 'range' is set, it is the ending
12920          * of a range--check its validity.  Later, we will handle each
12921          * individual code point in the range.  If 'range' isn't set, this
12922          * could be the beginning of a range, so check for that by looking
12923          * ahead to see if the next real character to be processed is the range
12924          * indicator--the minus sign */
12925
12926         if (skip_white) {
12927             RExC_parse = regpatws(pRExC_state, RExC_parse,
12928                                 FALSE /* means don't recognize comments */);
12929         }
12930
12931         if (range) {
12932             if (prevvalue > value) /* b-a */ {
12933                 const int w = RExC_parse - rangebegin;
12934                 Simple_vFAIL4("Invalid [] range \"%*.*s\"", w, w, rangebegin);
12935                 range = 0; /* not a valid range */
12936             }
12937         }
12938         else {
12939             prevvalue = value; /* save the beginning of the potential range */
12940             if (! stop_at_1     /* Can't be a range if parsing just one thing */
12941                 && *RExC_parse == '-')
12942             {
12943                 char* next_char_ptr = RExC_parse + 1;
12944                 if (skip_white) {   /* Get the next real char after the '-' */
12945                     next_char_ptr = regpatws(pRExC_state,
12946                                              RExC_parse + 1,
12947                                              FALSE); /* means don't recognize
12948                                                         comments */
12949                 }
12950
12951                 /* If the '-' is at the end of the class (just before the ']',
12952                  * it is a literal minus; otherwise it is a range */
12953                 if (next_char_ptr < RExC_end && *next_char_ptr != ']') {
12954                     RExC_parse = next_char_ptr;
12955
12956                     /* a bad range like \w-, [:word:]- ? */
12957                     if (namedclass > OOB_NAMEDCLASS) {
12958                         if (strict || ckWARN(WARN_REGEXP)) {
12959                             const int w =
12960                                 RExC_parse >= rangebegin ?
12961                                 RExC_parse - rangebegin : 0;
12962                             if (strict) {
12963                                 vFAIL4("False [] range \"%*.*s\"",
12964                                     w, w, rangebegin);
12965                             }
12966                             else {
12967                                 vWARN4(RExC_parse,
12968                                     "False [] range \"%*.*s\"",
12969                                     w, w, rangebegin);
12970                             }
12971                         }
12972                         if (!SIZE_ONLY) {
12973                             cp_list = add_cp_to_invlist(cp_list, '-');
12974                         }
12975                         element_count++;
12976                     } else
12977                         range = 1;      /* yeah, it's a range! */
12978                     continue;   /* but do it the next time */
12979                 }
12980             }
12981         }
12982
12983         /* Here, <prevvalue> is the beginning of the range, if any; or <value>
12984          * if not */
12985
12986         /* non-Latin1 code point implies unicode semantics.  Must be set in
12987          * pass1 so is there for the whole of pass 2 */
12988         if (value > 255) {
12989             RExC_uni_semantics = 1;
12990         }
12991
12992         /* Ready to process either the single value, or the completed range.
12993          * For single-valued non-inverted ranges, we consider the possibility
12994          * of multi-char folds.  (We made a conscious decision to not do this
12995          * for the other cases because it can often lead to non-intuitive
12996          * results.  For example, you have the peculiar case that:
12997          *  "s s" =~ /^[^\xDF]+$/i => Y
12998          *  "ss"  =~ /^[^\xDF]+$/i => N
12999          *
13000          * See [perl #89750] */
13001         if (FOLD && allow_multi_folds && value == prevvalue) {
13002             if (value == LATIN_SMALL_LETTER_SHARP_S
13003                 || (value > 255 && _invlist_contains_cp(PL_HasMultiCharFold,
13004                                                         value)))
13005             {
13006                 /* Here <value> is indeed a multi-char fold.  Get what it is */
13007
13008                 U8 foldbuf[UTF8_MAXBYTES_CASE];
13009                 STRLEN foldlen;
13010
13011                 UV folded = _to_uni_fold_flags(
13012                                 value,
13013                                 foldbuf,
13014                                 &foldlen,
13015                                 FOLD_FLAGS_FULL
13016                                 | ((LOC) ?  FOLD_FLAGS_LOCALE
13017                                             : (ASCII_FOLD_RESTRICTED)
13018                                               ? FOLD_FLAGS_NOMIX_ASCII
13019                                               : 0)
13020                                 );
13021
13022                 /* Here, <folded> should be the first character of the
13023                  * multi-char fold of <value>, with <foldbuf> containing the
13024                  * whole thing.  But, if this fold is not allowed (because of
13025                  * the flags), <fold> will be the same as <value>, and should
13026                  * be processed like any other character, so skip the special
13027                  * handling */
13028                 if (folded != value) {
13029
13030                     /* Skip if we are recursed, currently parsing the class
13031                      * again.  Otherwise add this character to the list of
13032                      * multi-char folds. */
13033                     if (! RExC_in_multi_char_class) {
13034                         AV** this_array_ptr;
13035                         AV* this_array;
13036                         STRLEN cp_count = utf8_length(foldbuf,
13037                                                       foldbuf + foldlen);
13038                         SV* multi_fold = sv_2mortal(newSVpvn("", 0));
13039
13040                         Perl_sv_catpvf(aTHX_ multi_fold, "\\x{%"UVXf"}", value);
13041
13042
13043                         if (! multi_char_matches) {
13044                             multi_char_matches = newAV();
13045                         }
13046
13047                         /* <multi_char_matches> is actually an array of arrays.
13048                          * There will be one or two top-level elements: [2],
13049                          * and/or [3].  The [2] element is an array, each
13050                          * element thereof is a character which folds to TWO
13051                          * characters; [3] is for folds to THREE characters.
13052                          * (Unicode guarantees a maximum of 3 characters in any
13053                          * fold.)  When we rewrite the character class below,
13054                          * we will do so such that the longest folds are
13055                          * written first, so that it prefers the longest
13056                          * matching strings first.  This is done even if it
13057                          * turns out that any quantifier is non-greedy, out of
13058                          * programmer laziness.  Tom Christiansen has agreed
13059                          * that this is ok.  This makes the test for the
13060                          * ligature 'ffi' come before the test for 'ff' */
13061                         if (av_exists(multi_char_matches, cp_count)) {
13062                             this_array_ptr = (AV**) av_fetch(multi_char_matches,
13063                                                              cp_count, FALSE);
13064                             this_array = *this_array_ptr;
13065                         }
13066                         else {
13067                             this_array = newAV();
13068                             av_store(multi_char_matches, cp_count,
13069                                      (SV*) this_array);
13070                         }
13071                         av_push(this_array, multi_fold);
13072                     }
13073
13074                     /* This element should not be processed further in this
13075                      * class */
13076                     element_count--;
13077                     value = save_value;
13078                     prevvalue = save_prevvalue;
13079                     continue;
13080                 }
13081             }
13082         }
13083
13084         /* Deal with this element of the class */
13085         if (! SIZE_ONLY) {
13086 #ifndef EBCDIC
13087             cp_list = _add_range_to_invlist(cp_list, prevvalue, value);
13088 #else
13089             SV* this_range = _new_invlist(1);
13090             _append_range_to_invlist(this_range, prevvalue, value);
13091
13092             /* In EBCDIC, the ranges 'A-Z' and 'a-z' are each not contiguous.
13093              * If this range was specified using something like 'i-j', we want
13094              * to include only the 'i' and the 'j', and not anything in
13095              * between, so exclude non-ASCII, non-alphabetics from it.
13096              * However, if the range was specified with something like
13097              * [\x89-\x91] or [\x89-j], all code points within it should be
13098              * included.  literal_endpoint==2 means both ends of the range used
13099              * a literal character, not \x{foo} */
13100             if (literal_endpoint == 2
13101                 && (prevvalue >= 'a' && value <= 'z')
13102                     || (prevvalue >= 'A' && value <= 'Z'))
13103             {
13104                 _invlist_intersection(this_range, PL_Posix_ptrs[_CC_ALPHA],
13105                                       &this_range);
13106             }
13107             _invlist_union(cp_list, this_range, &cp_list);
13108             literal_endpoint = 0;
13109 #endif
13110         }
13111
13112         range = 0; /* this range (if it was one) is done now */
13113     } /* End of loop through all the text within the brackets */
13114
13115     /* If anything in the class expands to more than one character, we have to
13116      * deal with them by building up a substitute parse string, and recursively
13117      * calling reg() on it, instead of proceeding */
13118     if (multi_char_matches) {
13119         SV * substitute_parse = newSVpvn_flags("?:", 2, SVs_TEMP);
13120         I32 cp_count;
13121         STRLEN len;
13122         char *save_end = RExC_end;
13123         char *save_parse = RExC_parse;
13124         bool first_time = TRUE;     /* First multi-char occurrence doesn't get
13125                                        a "|" */
13126         I32 reg_flags;
13127
13128         assert(! invert);
13129 #if 0   /* Have decided not to deal with multi-char folds in inverted classes,
13130            because too confusing */
13131         if (invert) {
13132             sv_catpv(substitute_parse, "(?:");
13133         }
13134 #endif
13135
13136         /* Look at the longest folds first */
13137         for (cp_count = av_len(multi_char_matches); cp_count > 0; cp_count--) {
13138
13139             if (av_exists(multi_char_matches, cp_count)) {
13140                 AV** this_array_ptr;
13141                 SV* this_sequence;
13142
13143                 this_array_ptr = (AV**) av_fetch(multi_char_matches,
13144                                                  cp_count, FALSE);
13145                 while ((this_sequence = av_pop(*this_array_ptr)) !=
13146                                                                 &PL_sv_undef)
13147                 {
13148                     if (! first_time) {
13149                         sv_catpv(substitute_parse, "|");
13150                     }
13151                     first_time = FALSE;
13152
13153                     sv_catpv(substitute_parse, SvPVX(this_sequence));
13154                 }
13155             }
13156         }
13157
13158         /* If the character class contains anything else besides these
13159          * multi-character folds, have to include it in recursive parsing */
13160         if (element_count) {
13161             sv_catpv(substitute_parse, "|[");
13162             sv_catpvn(substitute_parse, orig_parse, RExC_parse - orig_parse);
13163             sv_catpv(substitute_parse, "]");
13164         }
13165
13166         sv_catpv(substitute_parse, ")");
13167 #if 0
13168         if (invert) {
13169             /* This is a way to get the parse to skip forward a whole named
13170              * sequence instead of matching the 2nd character when it fails the
13171              * first */
13172             sv_catpv(substitute_parse, "(*THEN)(*SKIP)(*FAIL)|.)");
13173         }
13174 #endif
13175
13176         RExC_parse = SvPV(substitute_parse, len);
13177         RExC_end = RExC_parse + len;
13178         RExC_in_multi_char_class = 1;
13179         RExC_emit = (regnode *)orig_emit;
13180
13181         ret = reg(pRExC_state, 1, &reg_flags, depth+1);
13182
13183         *flagp |= reg_flags&(HASWIDTH|SIMPLE|SPSTART|POSTPONED|RESTART_UTF8);
13184
13185         RExC_parse = save_parse;
13186         RExC_end = save_end;
13187         RExC_in_multi_char_class = 0;
13188         SvREFCNT_dec_NN(multi_char_matches);
13189         return ret;
13190     }
13191
13192     /* If the character class contains only a single element, it may be
13193      * optimizable into another node type which is smaller and runs faster.
13194      * Check if this is the case for this class */
13195     if (element_count == 1 && ! ret_invlist) {
13196         U8 op = END;
13197         U8 arg = 0;
13198
13199         if (namedclass > OOB_NAMEDCLASS) { /* this is a named class, like \w or
13200                                               [:digit:] or \p{foo} */
13201
13202             /* All named classes are mapped into POSIXish nodes, with its FLAG
13203              * argument giving which class it is */
13204             switch ((I32)namedclass) {
13205                 case ANYOF_UNIPROP:
13206                     break;
13207
13208                 /* These don't depend on the charset modifiers.  They always
13209                  * match under /u rules */
13210                 case ANYOF_NHORIZWS:
13211                 case ANYOF_HORIZWS:
13212                     namedclass = ANYOF_BLANK + namedclass - ANYOF_HORIZWS;
13213                     /* FALLTHROUGH */
13214
13215                 case ANYOF_NVERTWS:
13216                 case ANYOF_VERTWS:
13217                     op = POSIXU;
13218                     goto join_posix;
13219
13220                 /* The actual POSIXish node for all the rest depends on the
13221                  * charset modifier.  The ones in the first set depend only on
13222                  * ASCII or, if available on this platform, locale */
13223                 case ANYOF_ASCII:
13224                 case ANYOF_NASCII:
13225 #ifdef HAS_ISASCII
13226                     op = (LOC) ? POSIXL : POSIXA;
13227 #else
13228                     op = POSIXA;
13229 #endif
13230                     goto join_posix;
13231
13232                 case ANYOF_NCASED:
13233                 case ANYOF_LOWER:
13234                 case ANYOF_NLOWER:
13235                 case ANYOF_UPPER:
13236                 case ANYOF_NUPPER:
13237                     /* under /a could be alpha */
13238                     if (FOLD) {
13239                         if (ASCII_RESTRICTED) {
13240                             namedclass = ANYOF_ALPHA + (namedclass % 2);
13241                         }
13242                         else if (! LOC) {
13243                             break;
13244                         }
13245                     }
13246                     /* FALLTHROUGH */
13247
13248                 /* The rest have more possibilities depending on the charset.
13249                  * We take advantage of the enum ordering of the charset
13250                  * modifiers to get the exact node type, */
13251                 default:
13252                     op = POSIXD + get_regex_charset(RExC_flags);
13253                     if (op > POSIXA) { /* /aa is same as /a */
13254                         op = POSIXA;
13255                     }
13256 #ifndef HAS_ISBLANK
13257                     if (op == POSIXL
13258                         && (namedclass == ANYOF_BLANK
13259                             || namedclass == ANYOF_NBLANK))
13260                     {
13261                         op = POSIXA;
13262                     }
13263 #endif
13264
13265                 join_posix:
13266                     /* The odd numbered ones are the complements of the
13267                      * next-lower even number one */
13268                     if (namedclass % 2 == 1) {
13269                         invert = ! invert;
13270                         namedclass--;
13271                     }
13272                     arg = namedclass_to_classnum(namedclass);
13273                     break;
13274             }
13275         }
13276         else if (value == prevvalue) {
13277
13278             /* Here, the class consists of just a single code point */
13279
13280             if (invert) {
13281                 if (! LOC && value == '\n') {
13282                     op = REG_ANY; /* Optimize [^\n] */
13283                     *flagp |= HASWIDTH|SIMPLE;
13284                     RExC_naughty++;
13285                 }
13286             }
13287             else if (value < 256 || UTF) {
13288
13289                 /* Optimize a single value into an EXACTish node, but not if it
13290                  * would require converting the pattern to UTF-8. */
13291                 op = compute_EXACTish(pRExC_state);
13292             }
13293         } /* Otherwise is a range */
13294         else if (! LOC) {   /* locale could vary these */
13295             if (prevvalue == '0') {
13296                 if (value == '9') {
13297                     arg = _CC_DIGIT;
13298                     op = POSIXA;
13299                 }
13300             }
13301         }
13302
13303         /* Here, we have changed <op> away from its initial value iff we found
13304          * an optimization */
13305         if (op != END) {
13306
13307             /* Throw away this ANYOF regnode, and emit the calculated one,
13308              * which should correspond to the beginning, not current, state of
13309              * the parse */
13310             const char * cur_parse = RExC_parse;
13311             RExC_parse = (char *)orig_parse;
13312             if ( SIZE_ONLY) {
13313                 if (! LOC) {
13314
13315                     /* To get locale nodes to not use the full ANYOF size would
13316                      * require moving the code above that writes the portions
13317                      * of it that aren't in other nodes to after this point.
13318                      * e.g.  ANYOF_CLASS_SET */
13319                     RExC_size = orig_size;
13320                 }
13321             }
13322             else {
13323                 RExC_emit = (regnode *)orig_emit;
13324                 if (PL_regkind[op] == POSIXD) {
13325                     if (invert) {
13326                         op += NPOSIXD - POSIXD;
13327                     }
13328                 }
13329             }
13330
13331             ret = reg_node(pRExC_state, op);
13332
13333             if (PL_regkind[op] == POSIXD || PL_regkind[op] == NPOSIXD) {
13334                 if (! SIZE_ONLY) {
13335                     FLAGS(ret) = arg;
13336                 }
13337                 *flagp |= HASWIDTH|SIMPLE;
13338             }
13339             else if (PL_regkind[op] == EXACT) {
13340                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, 0, value);
13341             }
13342
13343             RExC_parse = (char *) cur_parse;
13344
13345             SvREFCNT_dec(posixes);
13346             SvREFCNT_dec(cp_list);
13347             return ret;
13348         }
13349     }
13350
13351     if (SIZE_ONLY)
13352         return ret;
13353     /****** !SIZE_ONLY (Pass 2) AFTER HERE *********/
13354
13355     /* If folding, we calculate all characters that could fold to or from the
13356      * ones already on the list */
13357     if (FOLD && cp_list) {
13358         UV start, end;  /* End points of code point ranges */
13359
13360         SV* fold_intersection = NULL;
13361
13362         /* If the highest code point is within Latin1, we can use the
13363          * compiled-in Alphas list, and not have to go out to disk.  This
13364          * yields two false positives, the masculine and feminine ordinal
13365          * indicators, which are weeded out below using the
13366          * IS_IN_SOME_FOLD_L1() macro */
13367         if (invlist_highest(cp_list) < 256) {
13368             _invlist_intersection(PL_L1Posix_ptrs[_CC_ALPHA], cp_list,
13369                                                            &fold_intersection);
13370         }
13371         else {
13372
13373             /* Here, there are non-Latin1 code points, so we will have to go
13374              * fetch the list of all the characters that participate in folds
13375              */
13376             if (! PL_utf8_foldable) {
13377                 SV* swash = swash_init("utf8", "_Perl_Any_Folds",
13378                                        &PL_sv_undef, 1, 0);
13379                 PL_utf8_foldable = _get_swash_invlist(swash);
13380                 SvREFCNT_dec_NN(swash);
13381             }
13382
13383             /* This is a hash that for a particular fold gives all characters
13384              * that are involved in it */
13385             if (! PL_utf8_foldclosures) {
13386
13387                 /* If we were unable to find any folds, then we likely won't be
13388                  * able to find the closures.  So just create an empty list.
13389                  * Folding will effectively be restricted to the non-Unicode
13390                  * rules hard-coded into Perl.  (This case happens legitimately
13391                  * during compilation of Perl itself before the Unicode tables
13392                  * are generated) */
13393                 if (_invlist_len(PL_utf8_foldable) == 0) {
13394                     PL_utf8_foldclosures = newHV();
13395                 }
13396                 else {
13397                     /* If the folds haven't been read in, call a fold function
13398                      * to force that */
13399                     if (! PL_utf8_tofold) {
13400                         U8 dummy[UTF8_MAXBYTES+1];
13401
13402                         /* This string is just a short named one above \xff */
13403                         to_utf8_fold((U8*) HYPHEN_UTF8, dummy, NULL);
13404                         assert(PL_utf8_tofold); /* Verify that worked */
13405                     }
13406                     PL_utf8_foldclosures =
13407                                     _swash_inversion_hash(PL_utf8_tofold);
13408                 }
13409             }
13410
13411             /* Only the characters in this class that participate in folds need
13412              * be checked.  Get the intersection of this class and all the
13413              * possible characters that are foldable.  This can quickly narrow
13414              * down a large class */
13415             _invlist_intersection(PL_utf8_foldable, cp_list,
13416                                   &fold_intersection);
13417         }
13418
13419         /* Now look at the foldable characters in this class individually */
13420         invlist_iterinit(fold_intersection);
13421         while (invlist_iternext(fold_intersection, &start, &end)) {
13422             UV j;
13423
13424             /* Locale folding for Latin1 characters is deferred until runtime */
13425             if (LOC && start < 256) {
13426                 start = 256;
13427             }
13428
13429             /* Look at every character in the range */
13430             for (j = start; j <= end; j++) {
13431
13432                 U8 foldbuf[UTF8_MAXBYTES_CASE+1];
13433                 STRLEN foldlen;
13434                 SV** listp;
13435
13436                 if (j < 256) {
13437
13438                     /* We have the latin1 folding rules hard-coded here so that
13439                      * an innocent-looking character class, like /[ks]/i won't
13440                      * have to go out to disk to find the possible matches.
13441                      * XXX It would be better to generate these via regen, in
13442                      * case a new version of the Unicode standard adds new
13443                      * mappings, though that is not really likely, and may be
13444                      * caught by the default: case of the switch below. */
13445
13446                     if (IS_IN_SOME_FOLD_L1(j)) {
13447
13448                         /* ASCII is always matched; non-ASCII is matched only
13449                          * under Unicode rules */
13450                         if (isASCII(j) || AT_LEAST_UNI_SEMANTICS) {
13451                             cp_list =
13452                                 add_cp_to_invlist(cp_list, PL_fold_latin1[j]);
13453                         }
13454                         else {
13455                             depends_list =
13456                              add_cp_to_invlist(depends_list, PL_fold_latin1[j]);
13457                         }
13458                     }
13459
13460                     if (HAS_NONLATIN1_FOLD_CLOSURE(j)
13461                         && (! isASCII(j) || ! ASCII_FOLD_RESTRICTED))
13462                     {
13463                         /* Certain Latin1 characters have matches outside
13464                          * Latin1.  To get here, <j> is one of those
13465                          * characters.   None of these matches is valid for
13466                          * ASCII characters under /aa, which is why the 'if'
13467                          * just above excludes those.  These matches only
13468                          * happen when the target string is utf8.  The code
13469                          * below adds the single fold closures for <j> to the
13470                          * inversion list. */
13471                         switch (j) {
13472                             case 'k':
13473                             case 'K':
13474                                 cp_list =
13475                                     add_cp_to_invlist(cp_list, KELVIN_SIGN);
13476                                 break;
13477                             case 's':
13478                             case 'S':
13479                                 cp_list = add_cp_to_invlist(cp_list,
13480                                                     LATIN_SMALL_LETTER_LONG_S);
13481                                 break;
13482                             case MICRO_SIGN:
13483                                 cp_list = add_cp_to_invlist(cp_list,
13484                                                     GREEK_CAPITAL_LETTER_MU);
13485                                 cp_list = add_cp_to_invlist(cp_list,
13486                                                     GREEK_SMALL_LETTER_MU);
13487                                 break;
13488                             case LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE:
13489                             case LATIN_SMALL_LETTER_A_WITH_RING_ABOVE:
13490                                 cp_list =
13491                                     add_cp_to_invlist(cp_list, ANGSTROM_SIGN);
13492                                 break;
13493                             case LATIN_SMALL_LETTER_Y_WITH_DIAERESIS:
13494                                 cp_list = add_cp_to_invlist(cp_list,
13495                                         LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS);
13496                                 break;
13497                             case LATIN_SMALL_LETTER_SHARP_S:
13498                                 cp_list = add_cp_to_invlist(cp_list,
13499                                                 LATIN_CAPITAL_LETTER_SHARP_S);
13500                                 break;
13501                             case 'F': case 'f':
13502                             case 'I': case 'i':
13503                             case 'L': case 'l':
13504                             case 'T': case 't':
13505                             case 'A': case 'a':
13506                             case 'H': case 'h':
13507                             case 'J': case 'j':
13508                             case 'N': case 'n':
13509                             case 'W': case 'w':
13510                             case 'Y': case 'y':
13511                                 /* These all are targets of multi-character
13512                                  * folds from code points that require UTF8 to
13513                                  * express, so they can't match unless the
13514                                  * target string is in UTF-8, so no action here
13515                                  * is necessary, as regexec.c properly handles
13516                                  * the general case for UTF-8 matching and
13517                                  * multi-char folds */
13518                                 break;
13519                             default:
13520                                 /* Use deprecated warning to increase the
13521                                  * chances of this being output */
13522                                 ckWARN2reg_d(RExC_parse, "Perl folding rules are not up-to-date for 0x%"UVXf"; please use the perlbug utility to report;", j);
13523                                 break;
13524                         }
13525                     }
13526                     continue;
13527                 }
13528
13529                 /* Here is an above Latin1 character.  We don't have the rules
13530                  * hard-coded for it.  First, get its fold.  This is the simple
13531                  * fold, as the multi-character folds have been handled earlier
13532                  * and separated out */
13533                 _to_uni_fold_flags(j, foldbuf, &foldlen,
13534                                                ((LOC)
13535                                                ? FOLD_FLAGS_LOCALE
13536                                                : (ASCII_FOLD_RESTRICTED)
13537                                                   ? FOLD_FLAGS_NOMIX_ASCII
13538                                                   : 0));
13539
13540                 /* Single character fold of above Latin1.  Add everything in
13541                  * its fold closure to the list that this node should match.
13542                  * The fold closures data structure is a hash with the keys
13543                  * being the UTF-8 of every character that is folded to, like
13544                  * 'k', and the values each an array of all code points that
13545                  * fold to its key.  e.g. [ 'k', 'K', KELVIN_SIGN ].
13546                  * Multi-character folds are not included */
13547                 if ((listp = hv_fetch(PL_utf8_foldclosures,
13548                                       (char *) foldbuf, foldlen, FALSE)))
13549                 {
13550                     AV* list = (AV*) *listp;
13551                     IV k;
13552                     for (k = 0; k <= av_len(list); k++) {
13553                         SV** c_p = av_fetch(list, k, FALSE);
13554                         UV c;
13555                         if (c_p == NULL) {
13556                             Perl_croak(aTHX_ "panic: invalid PL_utf8_foldclosures structure");
13557                         }
13558                         c = SvUV(*c_p);
13559
13560                         /* /aa doesn't allow folds between ASCII and non-; /l
13561                          * doesn't allow them between above and below 256 */
13562                         if ((ASCII_FOLD_RESTRICTED
13563                                   && (isASCII(c) != isASCII(j)))
13564                             || (LOC && c < 256)) {
13565                             continue;
13566                         }
13567
13568                         /* Folds involving non-ascii Latin1 characters
13569                          * under /d are added to a separate list */
13570                         if (isASCII(c) || c > 255 || AT_LEAST_UNI_SEMANTICS)
13571                         {
13572                             cp_list = add_cp_to_invlist(cp_list, c);
13573                         }
13574                         else {
13575                           depends_list = add_cp_to_invlist(depends_list, c);
13576                         }
13577                     }
13578                 }
13579             }
13580         }
13581         SvREFCNT_dec_NN(fold_intersection);
13582     }
13583
13584     /* And combine the result (if any) with any inversion list from posix
13585      * classes.  The lists are kept separate up to now because we don't want to
13586      * fold the classes (folding of those is automatically handled by the swash
13587      * fetching code) */
13588     if (posixes) {
13589         if (! DEPENDS_SEMANTICS) {
13590             if (cp_list) {
13591                 _invlist_union(cp_list, posixes, &cp_list);
13592                 SvREFCNT_dec_NN(posixes);
13593             }
13594             else {
13595                 cp_list = posixes;
13596             }
13597         }
13598         else {
13599             /* Under /d, we put into a separate list the Latin1 things that
13600              * match only when the target string is utf8 */
13601             SV* nonascii_but_latin1_properties = NULL;
13602             _invlist_intersection(posixes, PL_Latin1,
13603                                   &nonascii_but_latin1_properties);
13604             _invlist_subtract(nonascii_but_latin1_properties, PL_ASCII,
13605                               &nonascii_but_latin1_properties);
13606             _invlist_subtract(posixes, nonascii_but_latin1_properties,
13607                               &posixes);
13608             if (cp_list) {
13609                 _invlist_union(cp_list, posixes, &cp_list);
13610                 SvREFCNT_dec_NN(posixes);
13611             }
13612             else {
13613                 cp_list = posixes;
13614             }
13615
13616             if (depends_list) {
13617                 _invlist_union(depends_list, nonascii_but_latin1_properties,
13618                                &depends_list);
13619                 SvREFCNT_dec_NN(nonascii_but_latin1_properties);
13620             }
13621             else {
13622                 depends_list = nonascii_but_latin1_properties;
13623             }
13624         }
13625     }
13626
13627     /* And combine the result (if any) with any inversion list from properties.
13628      * The lists are kept separate up to now so that we can distinguish the two
13629      * in regards to matching above-Unicode.  A run-time warning is generated
13630      * if a Unicode property is matched against a non-Unicode code point. But,
13631      * we allow user-defined properties to match anything, without any warning,
13632      * and we also suppress the warning if there is a portion of the character
13633      * class that isn't a Unicode property, and which matches above Unicode, \W
13634      * or [\x{110000}] for example.
13635      * (Note that in this case, unlike the Posix one above, there is no
13636      * <depends_list>, because having a Unicode property forces Unicode
13637      * semantics */
13638     if (properties) {
13639         bool warn_super = ! has_user_defined_property;
13640         if (cp_list) {
13641
13642             /* If it matters to the final outcome, see if a non-property
13643              * component of the class matches above Unicode.  If so, the
13644              * warning gets suppressed.  This is true even if just a single
13645              * such code point is specified, as though not strictly correct if
13646              * another such code point is matched against, the fact that they
13647              * are using above-Unicode code points indicates they should know
13648              * the issues involved */
13649             if (warn_super) {
13650                 bool non_prop_matches_above_Unicode =
13651                             runtime_posix_matches_above_Unicode
13652                             | (invlist_highest(cp_list) > PERL_UNICODE_MAX);
13653                 if (invert) {
13654                     non_prop_matches_above_Unicode =
13655                                             !  non_prop_matches_above_Unicode;
13656                 }
13657                 warn_super = ! non_prop_matches_above_Unicode;
13658             }
13659
13660             _invlist_union(properties, cp_list, &cp_list);
13661             SvREFCNT_dec_NN(properties);
13662         }
13663         else {
13664             cp_list = properties;
13665         }
13666
13667         if (warn_super) {
13668             OP(ret) = ANYOF_WARN_SUPER;
13669         }
13670     }
13671
13672     /* Here, we have calculated what code points should be in the character
13673      * class.
13674      *
13675      * Now we can see about various optimizations.  Fold calculation (which we
13676      * did above) needs to take place before inversion.  Otherwise /[^k]/i
13677      * would invert to include K, which under /i would match k, which it
13678      * shouldn't.  Therefore we can't invert folded locale now, as it won't be
13679      * folded until runtime */
13680
13681     /* Optimize inverted simple patterns (e.g. [^a-z]) when everything is known
13682      * at compile time.  Besides not inverting folded locale now, we can't
13683      * invert if there are things such as \w, which aren't known until runtime
13684      * */
13685     if (invert
13686         && ! (LOC && (FOLD || (ANYOF_FLAGS(ret) & ANYOF_CLASS)))
13687         && ! depends_list
13688         && ! HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
13689     {
13690         _invlist_invert(cp_list);
13691
13692         /* Any swash can't be used as-is, because we've inverted things */
13693         if (swash) {
13694             SvREFCNT_dec_NN(swash);
13695             swash = NULL;
13696         }
13697
13698         /* Clear the invert flag since have just done it here */
13699         invert = FALSE;
13700     }
13701
13702     if (ret_invlist) {
13703         *ret_invlist = cp_list;
13704         SvREFCNT_dec(swash);
13705
13706         /* Discard the generated node */
13707         if (SIZE_ONLY) {
13708             RExC_size = orig_size;
13709         }
13710         else {
13711             RExC_emit = orig_emit;
13712         }
13713         return orig_emit;
13714     }
13715
13716     /* If we didn't do folding, it's because some information isn't available
13717      * until runtime; set the run-time fold flag for these.  (We don't have to
13718      * worry about properties folding, as that is taken care of by the swash
13719      * fetching) */
13720     if (FOLD && LOC)
13721     {
13722        ANYOF_FLAGS(ret) |= ANYOF_LOC_FOLD;
13723     }
13724
13725     /* Some character classes are equivalent to other nodes.  Such nodes take
13726      * up less room and generally fewer operations to execute than ANYOF nodes.
13727      * Above, we checked for and optimized into some such equivalents for
13728      * certain common classes that are easy to test.  Getting to this point in
13729      * the code means that the class didn't get optimized there.  Since this
13730      * code is only executed in Pass 2, it is too late to save space--it has
13731      * been allocated in Pass 1, and currently isn't given back.  But turning
13732      * things into an EXACTish node can allow the optimizer to join it to any
13733      * adjacent such nodes.  And if the class is equivalent to things like /./,
13734      * expensive run-time swashes can be avoided.  Now that we have more
13735      * complete information, we can find things necessarily missed by the
13736      * earlier code.  I (khw) am not sure how much to look for here.  It would
13737      * be easy, but perhaps too slow, to check any candidates against all the
13738      * node types they could possibly match using _invlistEQ(). */
13739
13740     if (cp_list
13741         && ! invert
13742         && ! depends_list
13743         && ! (ANYOF_FLAGS(ret) & ANYOF_CLASS)
13744         && ! HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
13745     {
13746         UV start, end;
13747         U8 op = END;  /* The optimzation node-type */
13748         const char * cur_parse= RExC_parse;
13749
13750         invlist_iterinit(cp_list);
13751         if (! invlist_iternext(cp_list, &start, &end)) {
13752
13753             /* Here, the list is empty.  This happens, for example, when a
13754              * Unicode property is the only thing in the character class, and
13755              * it doesn't match anything.  (perluniprops.pod notes such
13756              * properties) */
13757             op = OPFAIL;
13758             *flagp |= HASWIDTH|SIMPLE;
13759         }
13760         else if (start == end) {    /* The range is a single code point */
13761             if (! invlist_iternext(cp_list, &start, &end)
13762
13763                     /* Don't do this optimization if it would require changing
13764                      * the pattern to UTF-8 */
13765                 && (start < 256 || UTF))
13766             {
13767                 /* Here, the list contains a single code point.  Can optimize
13768                  * into an EXACT node */
13769
13770                 value = start;
13771
13772                 if (! FOLD) {
13773                     op = EXACT;
13774                 }
13775                 else if (LOC) {
13776
13777                     /* A locale node under folding with one code point can be
13778                      * an EXACTFL, as its fold won't be calculated until
13779                      * runtime */
13780                     op = EXACTFL;
13781                 }
13782                 else {
13783
13784                     /* Here, we are generally folding, but there is only one
13785                      * code point to match.  If we have to, we use an EXACT
13786                      * node, but it would be better for joining with adjacent
13787                      * nodes in the optimization pass if we used the same
13788                      * EXACTFish node that any such are likely to be.  We can
13789                      * do this iff the code point doesn't participate in any
13790                      * folds.  For example, an EXACTF of a colon is the same as
13791                      * an EXACT one, since nothing folds to or from a colon. */
13792                     if (value < 256) {
13793                         if (IS_IN_SOME_FOLD_L1(value)) {
13794                             op = EXACT;
13795                         }
13796                     }
13797                     else {
13798                         if (! PL_utf8_foldable) {
13799                             SV* swash = swash_init("utf8", "_Perl_Any_Folds",
13800                                                 &PL_sv_undef, 1, 0);
13801                             PL_utf8_foldable = _get_swash_invlist(swash);
13802                             SvREFCNT_dec_NN(swash);
13803                         }
13804                         if (_invlist_contains_cp(PL_utf8_foldable, value)) {
13805                             op = EXACT;
13806                         }
13807                     }
13808
13809                     /* If we haven't found the node type, above, it means we
13810                      * can use the prevailing one */
13811                     if (op == END) {
13812                         op = compute_EXACTish(pRExC_state);
13813                     }
13814                 }
13815             }
13816         }
13817         else if (start == 0) {
13818             if (end == UV_MAX) {
13819                 op = SANY;
13820                 *flagp |= HASWIDTH|SIMPLE;
13821                 RExC_naughty++;
13822             }
13823             else if (end == '\n' - 1
13824                     && invlist_iternext(cp_list, &start, &end)
13825                     && start == '\n' + 1 && end == UV_MAX)
13826             {
13827                 op = REG_ANY;
13828                 *flagp |= HASWIDTH|SIMPLE;
13829                 RExC_naughty++;
13830             }
13831         }
13832         invlist_iterfinish(cp_list);
13833
13834         if (op != END) {
13835             RExC_parse = (char *)orig_parse;
13836             RExC_emit = (regnode *)orig_emit;
13837
13838             ret = reg_node(pRExC_state, op);
13839
13840             RExC_parse = (char *)cur_parse;
13841
13842             if (PL_regkind[op] == EXACT) {
13843                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, 0, value);
13844             }
13845
13846             SvREFCNT_dec_NN(cp_list);
13847             return ret;
13848         }
13849     }
13850
13851     /* Here, <cp_list> contains all the code points we can determine at
13852      * compile time that match under all conditions.  Go through it, and
13853      * for things that belong in the bitmap, put them there, and delete from
13854      * <cp_list>.  While we are at it, see if everything above 255 is in the
13855      * list, and if so, set a flag to speed up execution */
13856     ANYOF_BITMAP_ZERO(ret);
13857     if (cp_list) {
13858
13859         /* This gets set if we actually need to modify things */
13860         bool change_invlist = FALSE;
13861
13862         UV start, end;
13863
13864         /* Start looking through <cp_list> */
13865         invlist_iterinit(cp_list);
13866         while (invlist_iternext(cp_list, &start, &end)) {
13867             UV high;
13868             int i;
13869
13870             if (end == UV_MAX && start <= 256) {
13871                 ANYOF_FLAGS(ret) |= ANYOF_UNICODE_ALL;
13872             }
13873
13874             /* Quit if are above what we should change */
13875             if (start > 255) {
13876                 break;
13877             }
13878
13879             change_invlist = TRUE;
13880
13881             /* Set all the bits in the range, up to the max that we are doing */
13882             high = (end < 255) ? end : 255;
13883             for (i = start; i <= (int) high; i++) {
13884                 if (! ANYOF_BITMAP_TEST(ret, i)) {
13885                     ANYOF_BITMAP_SET(ret, i);
13886                 }
13887             }
13888         }
13889         invlist_iterfinish(cp_list);
13890
13891         /* Done with loop; remove any code points that are in the bitmap from
13892          * <cp_list> */
13893         if (change_invlist) {
13894             _invlist_subtract(cp_list, PL_Latin1, &cp_list);
13895         }
13896
13897         /* If have completely emptied it, remove it completely */
13898         if (_invlist_len(cp_list) == 0) {
13899             SvREFCNT_dec_NN(cp_list);
13900             cp_list = NULL;
13901         }
13902     }
13903
13904     if (invert) {
13905         ANYOF_FLAGS(ret) |= ANYOF_INVERT;
13906     }
13907
13908     /* Here, the bitmap has been populated with all the Latin1 code points that
13909      * always match.  Can now add to the overall list those that match only
13910      * when the target string is UTF-8 (<depends_list>). */
13911     if (depends_list) {
13912         if (cp_list) {
13913             _invlist_union(cp_list, depends_list, &cp_list);
13914             SvREFCNT_dec_NN(depends_list);
13915         }
13916         else {
13917             cp_list = depends_list;
13918         }
13919     }
13920
13921     /* If there is a swash and more than one element, we can't use the swash in
13922      * the optimization below. */
13923     if (swash && element_count > 1) {
13924         SvREFCNT_dec_NN(swash);
13925         swash = NULL;
13926     }
13927
13928     if (! cp_list
13929         && ! HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
13930     {
13931         ARG_SET(ret, ANYOF_NONBITMAP_EMPTY);
13932     }
13933     else {
13934         /* av[0] stores the character class description in its textual form:
13935          *       used later (regexec.c:Perl_regclass_swash()) to initialize the
13936          *       appropriate swash, and is also useful for dumping the regnode.
13937          * av[1] if NULL, is a placeholder to later contain the swash computed
13938          *       from av[0].  But if no further computation need be done, the
13939          *       swash is stored there now.
13940          * av[2] stores the cp_list inversion list for use in addition or
13941          *       instead of av[0]; used only if av[1] is NULL
13942          * av[3] is set if any component of the class is from a user-defined
13943          *       property; used only if av[1] is NULL */
13944         AV * const av = newAV();
13945         SV *rv;
13946
13947         av_store(av, 0, (HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
13948                         ? SvREFCNT_inc(listsv) : &PL_sv_undef);
13949         if (swash) {
13950             av_store(av, 1, swash);
13951             SvREFCNT_dec_NN(cp_list);
13952         }
13953         else {
13954             av_store(av, 1, NULL);
13955             if (cp_list) {
13956                 av_store(av, 2, cp_list);
13957                 av_store(av, 3, newSVuv(has_user_defined_property));
13958             }
13959         }
13960
13961         rv = newRV_noinc(MUTABLE_SV(av));
13962         n = add_data(pRExC_state, 1, "s");
13963         RExC_rxi->data->data[n] = (void*)rv;
13964         ARG_SET(ret, n);
13965     }
13966
13967     *flagp |= HASWIDTH|SIMPLE;
13968     return ret;
13969 }
13970 #undef HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION
13971
13972
13973 /* reg_skipcomment()
13974
13975    Absorbs an /x style # comments from the input stream.
13976    Returns true if there is more text remaining in the stream.
13977    Will set the REG_SEEN_RUN_ON_COMMENT flag if the comment
13978    terminates the pattern without including a newline.
13979
13980    Note its the callers responsibility to ensure that we are
13981    actually in /x mode
13982
13983 */
13984
13985 STATIC bool
13986 S_reg_skipcomment(pTHX_ RExC_state_t *pRExC_state)
13987 {
13988     bool ended = 0;
13989
13990     PERL_ARGS_ASSERT_REG_SKIPCOMMENT;
13991
13992     while (RExC_parse < RExC_end)
13993         if (*RExC_parse++ == '\n') {
13994             ended = 1;
13995             break;
13996         }
13997     if (!ended) {
13998         /* we ran off the end of the pattern without ending
13999            the comment, so we have to add an \n when wrapping */
14000         RExC_seen |= REG_SEEN_RUN_ON_COMMENT;
14001         return 0;
14002     } else
14003         return 1;
14004 }
14005
14006 /* nextchar()
14007
14008    Advances the parse position, and optionally absorbs
14009    "whitespace" from the inputstream.
14010
14011    Without /x "whitespace" means (?#...) style comments only,
14012    with /x this means (?#...) and # comments and whitespace proper.
14013
14014    Returns the RExC_parse point from BEFORE the scan occurs.
14015
14016    This is the /x friendly way of saying RExC_parse++.
14017 */
14018
14019 STATIC char*
14020 S_nextchar(pTHX_ RExC_state_t *pRExC_state)
14021 {
14022     char* const retval = RExC_parse++;
14023
14024     PERL_ARGS_ASSERT_NEXTCHAR;
14025
14026     for (;;) {
14027         if (RExC_end - RExC_parse >= 3
14028             && *RExC_parse == '('
14029             && RExC_parse[1] == '?'
14030             && RExC_parse[2] == '#')
14031         {
14032             while (*RExC_parse != ')') {
14033                 if (RExC_parse == RExC_end)
14034                     FAIL("Sequence (?#... not terminated");
14035                 RExC_parse++;
14036             }
14037             RExC_parse++;
14038             continue;
14039         }
14040         if (RExC_flags & RXf_PMf_EXTENDED) {
14041             if (isSPACE(*RExC_parse)) {
14042                 RExC_parse++;
14043                 continue;
14044             }
14045             else if (*RExC_parse == '#') {
14046                 if ( reg_skipcomment( pRExC_state ) )
14047                     continue;
14048             }
14049         }
14050         return retval;
14051     }
14052 }
14053
14054 /*
14055 - reg_node - emit a node
14056 */
14057 STATIC regnode *                        /* Location. */
14058 S_reg_node(pTHX_ RExC_state_t *pRExC_state, U8 op)
14059 {
14060     dVAR;
14061     regnode *ptr;
14062     regnode * const ret = RExC_emit;
14063     GET_RE_DEBUG_FLAGS_DECL;
14064
14065     PERL_ARGS_ASSERT_REG_NODE;
14066
14067     if (SIZE_ONLY) {
14068         SIZE_ALIGN(RExC_size);
14069         RExC_size += 1;
14070         return(ret);
14071     }
14072     if (RExC_emit >= RExC_emit_bound)
14073         Perl_croak(aTHX_ "panic: reg_node overrun trying to emit %d, %p>=%p",
14074                    op, RExC_emit, RExC_emit_bound);
14075
14076     NODE_ALIGN_FILL(ret);
14077     ptr = ret;
14078     FILL_ADVANCE_NODE(ptr, op);
14079 #ifdef RE_TRACK_PATTERN_OFFSETS
14080     if (RExC_offsets) {         /* MJD */
14081         MJD_OFFSET_DEBUG(("%s:%d: (op %s) %s %"UVuf" (len %"UVuf") (max %"UVuf").\n", 
14082               "reg_node", __LINE__, 
14083               PL_reg_name[op],
14084               (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0] 
14085                 ? "Overwriting end of array!\n" : "OK",
14086               (UV)(RExC_emit - RExC_emit_start),
14087               (UV)(RExC_parse - RExC_start),
14088               (UV)RExC_offsets[0])); 
14089         Set_Node_Offset(RExC_emit, RExC_parse + (op == END));
14090     }
14091 #endif
14092     RExC_emit = ptr;
14093     return(ret);
14094 }
14095
14096 /*
14097 - reganode - emit a node with an argument
14098 */
14099 STATIC regnode *                        /* Location. */
14100 S_reganode(pTHX_ RExC_state_t *pRExC_state, U8 op, U32 arg)
14101 {
14102     dVAR;
14103     regnode *ptr;
14104     regnode * const ret = RExC_emit;
14105     GET_RE_DEBUG_FLAGS_DECL;
14106
14107     PERL_ARGS_ASSERT_REGANODE;
14108
14109     if (SIZE_ONLY) {
14110         SIZE_ALIGN(RExC_size);
14111         RExC_size += 2;
14112         /* 
14113            We can't do this:
14114            
14115            assert(2==regarglen[op]+1); 
14116
14117            Anything larger than this has to allocate the extra amount.
14118            If we changed this to be:
14119            
14120            RExC_size += (1 + regarglen[op]);
14121            
14122            then it wouldn't matter. Its not clear what side effect
14123            might come from that so its not done so far.
14124            -- dmq
14125         */
14126         return(ret);
14127     }
14128     if (RExC_emit >= RExC_emit_bound)
14129         Perl_croak(aTHX_ "panic: reg_node overrun trying to emit %d, %p>=%p",
14130                    op, RExC_emit, RExC_emit_bound);
14131
14132     NODE_ALIGN_FILL(ret);
14133     ptr = ret;
14134     FILL_ADVANCE_NODE_ARG(ptr, op, arg);
14135 #ifdef RE_TRACK_PATTERN_OFFSETS
14136     if (RExC_offsets) {         /* MJD */
14137         MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s %"UVuf" <- %"UVuf" (max %"UVuf").\n", 
14138               "reganode",
14139               __LINE__,
14140               PL_reg_name[op],
14141               (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0] ? 
14142               "Overwriting end of array!\n" : "OK",
14143               (UV)(RExC_emit - RExC_emit_start),
14144               (UV)(RExC_parse - RExC_start),
14145               (UV)RExC_offsets[0])); 
14146         Set_Cur_Node_Offset;
14147     }
14148 #endif            
14149     RExC_emit = ptr;
14150     return(ret);
14151 }
14152
14153 /*
14154 - reguni - emit (if appropriate) a Unicode character
14155 */
14156 STATIC STRLEN
14157 S_reguni(pTHX_ const RExC_state_t *pRExC_state, UV uv, char* s)
14158 {
14159     dVAR;
14160
14161     PERL_ARGS_ASSERT_REGUNI;
14162
14163     return SIZE_ONLY ? UNISKIP(uv) : (uvchr_to_utf8((U8*)s, uv) - (U8*)s);
14164 }
14165
14166 /*
14167 - reginsert - insert an operator in front of already-emitted operand
14168 *
14169 * Means relocating the operand.
14170 */
14171 STATIC void
14172 S_reginsert(pTHX_ RExC_state_t *pRExC_state, U8 op, regnode *opnd, U32 depth)
14173 {
14174     dVAR;
14175     regnode *src;
14176     regnode *dst;
14177     regnode *place;
14178     const int offset = regarglen[(U8)op];
14179     const int size = NODE_STEP_REGNODE + offset;
14180     GET_RE_DEBUG_FLAGS_DECL;
14181
14182     PERL_ARGS_ASSERT_REGINSERT;
14183     PERL_UNUSED_ARG(depth);
14184 /* (PL_regkind[(U8)op] == CURLY ? EXTRA_STEP_2ARGS : 0); */
14185     DEBUG_PARSE_FMT("inst"," - %s",PL_reg_name[op]);
14186     if (SIZE_ONLY) {
14187         RExC_size += size;
14188         return;
14189     }
14190
14191     src = RExC_emit;
14192     RExC_emit += size;
14193     dst = RExC_emit;
14194     if (RExC_open_parens) {
14195         int paren;
14196         /*DEBUG_PARSE_FMT("inst"," - %"IVdf, (IV)RExC_npar);*/
14197         for ( paren=0 ; paren < RExC_npar ; paren++ ) {
14198             if ( RExC_open_parens[paren] >= opnd ) {
14199                 /*DEBUG_PARSE_FMT("open"," - %d",size);*/
14200                 RExC_open_parens[paren] += size;
14201             } else {
14202                 /*DEBUG_PARSE_FMT("open"," - %s","ok");*/
14203             }
14204             if ( RExC_close_parens[paren] >= opnd ) {
14205                 /*DEBUG_PARSE_FMT("close"," - %d",size);*/
14206                 RExC_close_parens[paren] += size;
14207             } else {
14208                 /*DEBUG_PARSE_FMT("close"," - %s","ok");*/
14209             }
14210         }
14211     }
14212
14213     while (src > opnd) {
14214         StructCopy(--src, --dst, regnode);
14215 #ifdef RE_TRACK_PATTERN_OFFSETS
14216         if (RExC_offsets) {     /* MJD 20010112 */
14217             MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s copy %"UVuf" -> %"UVuf" (max %"UVuf").\n",
14218                   "reg_insert",
14219                   __LINE__,
14220                   PL_reg_name[op],
14221                   (UV)(dst - RExC_emit_start) > RExC_offsets[0] 
14222                     ? "Overwriting end of array!\n" : "OK",
14223                   (UV)(src - RExC_emit_start),
14224                   (UV)(dst - RExC_emit_start),
14225                   (UV)RExC_offsets[0])); 
14226             Set_Node_Offset_To_R(dst-RExC_emit_start, Node_Offset(src));
14227             Set_Node_Length_To_R(dst-RExC_emit_start, Node_Length(src));
14228         }
14229 #endif
14230     }
14231     
14232
14233     place = opnd;               /* Op node, where operand used to be. */
14234 #ifdef RE_TRACK_PATTERN_OFFSETS
14235     if (RExC_offsets) {         /* MJD */
14236         MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s %"UVuf" <- %"UVuf" (max %"UVuf").\n", 
14237               "reginsert",
14238               __LINE__,
14239               PL_reg_name[op],
14240               (UV)(place - RExC_emit_start) > RExC_offsets[0] 
14241               ? "Overwriting end of array!\n" : "OK",
14242               (UV)(place - RExC_emit_start),
14243               (UV)(RExC_parse - RExC_start),
14244               (UV)RExC_offsets[0]));
14245         Set_Node_Offset(place, RExC_parse);
14246         Set_Node_Length(place, 1);
14247     }
14248 #endif    
14249     src = NEXTOPER(place);
14250     FILL_ADVANCE_NODE(place, op);
14251     Zero(src, offset, regnode);
14252 }
14253
14254 /*
14255 - regtail - set the next-pointer at the end of a node chain of p to val.
14256 - SEE ALSO: regtail_study
14257 */
14258 /* TODO: All three parms should be const */
14259 STATIC void
14260 S_regtail(pTHX_ RExC_state_t *pRExC_state, regnode *p, const regnode *val,U32 depth)
14261 {
14262     dVAR;
14263     regnode *scan;
14264     GET_RE_DEBUG_FLAGS_DECL;
14265
14266     PERL_ARGS_ASSERT_REGTAIL;
14267 #ifndef DEBUGGING
14268     PERL_UNUSED_ARG(depth);
14269 #endif
14270
14271     if (SIZE_ONLY)
14272         return;
14273
14274     /* Find last node. */
14275     scan = p;
14276     for (;;) {
14277         regnode * const temp = regnext(scan);
14278         DEBUG_PARSE_r({
14279             SV * const mysv=sv_newmortal();
14280             DEBUG_PARSE_MSG((scan==p ? "tail" : ""));
14281             regprop(RExC_rx, mysv, scan);
14282             PerlIO_printf(Perl_debug_log, "~ %s (%d) %s %s\n",
14283                 SvPV_nolen_const(mysv), REG_NODE_NUM(scan),
14284                     (temp == NULL ? "->" : ""),
14285                     (temp == NULL ? PL_reg_name[OP(val)] : "")
14286             );
14287         });
14288         if (temp == NULL)
14289             break;
14290         scan = temp;
14291     }
14292
14293     if (reg_off_by_arg[OP(scan)]) {
14294         ARG_SET(scan, val - scan);
14295     }
14296     else {
14297         NEXT_OFF(scan) = val - scan;
14298     }
14299 }
14300
14301 #ifdef DEBUGGING
14302 /*
14303 - regtail_study - set the next-pointer at the end of a node chain of p to val.
14304 - Look for optimizable sequences at the same time.
14305 - currently only looks for EXACT chains.
14306
14307 This is experimental code. The idea is to use this routine to perform 
14308 in place optimizations on branches and groups as they are constructed,
14309 with the long term intention of removing optimization from study_chunk so
14310 that it is purely analytical.
14311
14312 Currently only used when in DEBUG mode. The macro REGTAIL_STUDY() is used
14313 to control which is which.
14314
14315 */
14316 /* TODO: All four parms should be const */
14317
14318 STATIC U8
14319 S_regtail_study(pTHX_ RExC_state_t *pRExC_state, regnode *p, const regnode *val,U32 depth)
14320 {
14321     dVAR;
14322     regnode *scan;
14323     U8 exact = PSEUDO;
14324 #ifdef EXPERIMENTAL_INPLACESCAN
14325     I32 min = 0;
14326 #endif
14327     GET_RE_DEBUG_FLAGS_DECL;
14328
14329     PERL_ARGS_ASSERT_REGTAIL_STUDY;
14330
14331
14332     if (SIZE_ONLY)
14333         return exact;
14334
14335     /* Find last node. */
14336
14337     scan = p;
14338     for (;;) {
14339         regnode * const temp = regnext(scan);
14340 #ifdef EXPERIMENTAL_INPLACESCAN
14341         if (PL_regkind[OP(scan)] == EXACT) {
14342             bool has_exactf_sharp_s;    /* Unexamined in this routine */
14343             if (join_exact(pRExC_state,scan,&min, &has_exactf_sharp_s, 1,val,depth+1))
14344                 return EXACT;
14345         }
14346 #endif
14347         if ( exact ) {
14348             switch (OP(scan)) {
14349                 case EXACT:
14350                 case EXACTF:
14351                 case EXACTFA:
14352                 case EXACTFU:
14353                 case EXACTFU_SS:
14354                 case EXACTFU_TRICKYFOLD:
14355                 case EXACTFL:
14356                         if( exact == PSEUDO )
14357                             exact= OP(scan);
14358                         else if ( exact != OP(scan) )
14359                             exact= 0;
14360                 case NOTHING:
14361                     break;
14362                 default:
14363                     exact= 0;
14364             }
14365         }
14366         DEBUG_PARSE_r({
14367             SV * const mysv=sv_newmortal();
14368             DEBUG_PARSE_MSG((scan==p ? "tsdy" : ""));
14369             regprop(RExC_rx, mysv, scan);
14370             PerlIO_printf(Perl_debug_log, "~ %s (%d) -> %s\n",
14371                 SvPV_nolen_const(mysv),
14372                 REG_NODE_NUM(scan),
14373                 PL_reg_name[exact]);
14374         });
14375         if (temp == NULL)
14376             break;
14377         scan = temp;
14378     }
14379     DEBUG_PARSE_r({
14380         SV * const mysv_val=sv_newmortal();
14381         DEBUG_PARSE_MSG("");
14382         regprop(RExC_rx, mysv_val, val);
14383         PerlIO_printf(Perl_debug_log, "~ attach to %s (%"IVdf") offset to %"IVdf"\n",
14384                       SvPV_nolen_const(mysv_val),
14385                       (IV)REG_NODE_NUM(val),
14386                       (IV)(val - scan)
14387         );
14388     });
14389     if (reg_off_by_arg[OP(scan)]) {
14390         ARG_SET(scan, val - scan);
14391     }
14392     else {
14393         NEXT_OFF(scan) = val - scan;
14394     }
14395
14396     return exact;
14397 }
14398 #endif
14399
14400 /*
14401  - regdump - dump a regexp onto Perl_debug_log in vaguely comprehensible form
14402  */
14403 #ifdef DEBUGGING
14404
14405 static void
14406 S_regdump_intflags(pTHX_ const char *lead, const U32 flags)
14407 {
14408     int bit;
14409     int set=0;
14410
14411     for (bit=0; bit<32; bit++) {
14412         if (flags & (1<<bit)) {
14413             if (!set++ && lead)
14414                 PerlIO_printf(Perl_debug_log, "%s",lead);
14415             PerlIO_printf(Perl_debug_log, "%s ",PL_reg_intflags_name[bit]);
14416         }
14417     }
14418     if (lead)  {
14419         if (set)
14420             PerlIO_printf(Perl_debug_log, "\n");
14421         else
14422             PerlIO_printf(Perl_debug_log, "%s[none-set]\n",lead);
14423     }
14424 }
14425
14426 static void 
14427 S_regdump_extflags(pTHX_ const char *lead, const U32 flags)
14428 {
14429     int bit;
14430     int set=0;
14431     regex_charset cs;
14432
14433     for (bit=0; bit<32; bit++) {
14434         if (flags & (1<<bit)) {
14435             if ((1<<bit) & RXf_PMf_CHARSET) {   /* Output separately, below */
14436                 continue;
14437             }
14438             if (!set++ && lead) 
14439                 PerlIO_printf(Perl_debug_log, "%s",lead);
14440             PerlIO_printf(Perl_debug_log, "%s ",PL_reg_extflags_name[bit]);
14441         }               
14442     }      
14443     if ((cs = get_regex_charset(flags)) != REGEX_DEPENDS_CHARSET) {
14444             if (!set++ && lead) {
14445                 PerlIO_printf(Perl_debug_log, "%s",lead);
14446             }
14447             switch (cs) {
14448                 case REGEX_UNICODE_CHARSET:
14449                     PerlIO_printf(Perl_debug_log, "UNICODE");
14450                     break;
14451                 case REGEX_LOCALE_CHARSET:
14452                     PerlIO_printf(Perl_debug_log, "LOCALE");
14453                     break;
14454                 case REGEX_ASCII_RESTRICTED_CHARSET:
14455                     PerlIO_printf(Perl_debug_log, "ASCII-RESTRICTED");
14456                     break;
14457                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
14458                     PerlIO_printf(Perl_debug_log, "ASCII-MORE_RESTRICTED");
14459                     break;
14460                 default:
14461                     PerlIO_printf(Perl_debug_log, "UNKNOWN CHARACTER SET");
14462                     break;
14463             }
14464     }
14465     if (lead)  {
14466         if (set) 
14467             PerlIO_printf(Perl_debug_log, "\n");
14468         else 
14469             PerlIO_printf(Perl_debug_log, "%s[none-set]\n",lead);
14470     }            
14471 }   
14472 #endif
14473
14474 void
14475 Perl_regdump(pTHX_ const regexp *r)
14476 {
14477 #ifdef DEBUGGING
14478     dVAR;
14479     SV * const sv = sv_newmortal();
14480     SV *dsv= sv_newmortal();
14481     RXi_GET_DECL(r,ri);
14482     GET_RE_DEBUG_FLAGS_DECL;
14483
14484     PERL_ARGS_ASSERT_REGDUMP;
14485
14486     (void)dumpuntil(r, ri->program, ri->program + 1, NULL, NULL, sv, 0, 0);
14487
14488     /* Header fields of interest. */
14489     if (r->anchored_substr) {
14490         RE_PV_QUOTED_DECL(s, 0, dsv, SvPVX_const(r->anchored_substr), 
14491             RE_SV_DUMPLEN(r->anchored_substr), 30);
14492         PerlIO_printf(Perl_debug_log,
14493                       "anchored %s%s at %"IVdf" ",
14494                       s, RE_SV_TAIL(r->anchored_substr),
14495                       (IV)r->anchored_offset);
14496     } else if (r->anchored_utf8) {
14497         RE_PV_QUOTED_DECL(s, 1, dsv, SvPVX_const(r->anchored_utf8), 
14498             RE_SV_DUMPLEN(r->anchored_utf8), 30);
14499         PerlIO_printf(Perl_debug_log,
14500                       "anchored utf8 %s%s at %"IVdf" ",
14501                       s, RE_SV_TAIL(r->anchored_utf8),
14502                       (IV)r->anchored_offset);
14503     }                 
14504     if (r->float_substr) {
14505         RE_PV_QUOTED_DECL(s, 0, dsv, SvPVX_const(r->float_substr), 
14506             RE_SV_DUMPLEN(r->float_substr), 30);
14507         PerlIO_printf(Perl_debug_log,
14508                       "floating %s%s at %"IVdf"..%"UVuf" ",
14509                       s, RE_SV_TAIL(r->float_substr),
14510                       (IV)r->float_min_offset, (UV)r->float_max_offset);
14511     } else if (r->float_utf8) {
14512         RE_PV_QUOTED_DECL(s, 1, dsv, SvPVX_const(r->float_utf8), 
14513             RE_SV_DUMPLEN(r->float_utf8), 30);
14514         PerlIO_printf(Perl_debug_log,
14515                       "floating utf8 %s%s at %"IVdf"..%"UVuf" ",
14516                       s, RE_SV_TAIL(r->float_utf8),
14517                       (IV)r->float_min_offset, (UV)r->float_max_offset);
14518     }
14519     if (r->check_substr || r->check_utf8)
14520         PerlIO_printf(Perl_debug_log,
14521                       (const char *)
14522                       (r->check_substr == r->float_substr
14523                        && r->check_utf8 == r->float_utf8
14524                        ? "(checking floating" : "(checking anchored"));
14525     if (r->extflags & RXf_NOSCAN)
14526         PerlIO_printf(Perl_debug_log, " noscan");
14527     if (r->extflags & RXf_CHECK_ALL)
14528         PerlIO_printf(Perl_debug_log, " isall");
14529     if (r->check_substr || r->check_utf8)
14530         PerlIO_printf(Perl_debug_log, ") ");
14531
14532     if (ri->regstclass) {
14533         regprop(r, sv, ri->regstclass);
14534         PerlIO_printf(Perl_debug_log, "stclass %s ", SvPVX_const(sv));
14535     }
14536     if (r->extflags & RXf_ANCH) {
14537         PerlIO_printf(Perl_debug_log, "anchored");
14538         if (r->extflags & RXf_ANCH_BOL)
14539             PerlIO_printf(Perl_debug_log, "(BOL)");
14540         if (r->extflags & RXf_ANCH_MBOL)
14541             PerlIO_printf(Perl_debug_log, "(MBOL)");
14542         if (r->extflags & RXf_ANCH_SBOL)
14543             PerlIO_printf(Perl_debug_log, "(SBOL)");
14544         if (r->extflags & RXf_ANCH_GPOS)
14545             PerlIO_printf(Perl_debug_log, "(GPOS)");
14546         PerlIO_putc(Perl_debug_log, ' ');
14547     }
14548     if (r->extflags & RXf_GPOS_SEEN)
14549         PerlIO_printf(Perl_debug_log, "GPOS:%"UVuf" ", (UV)r->gofs);
14550     if (r->intflags & PREGf_SKIP)
14551         PerlIO_printf(Perl_debug_log, "plus ");
14552     if (r->intflags & PREGf_IMPLICIT)
14553         PerlIO_printf(Perl_debug_log, "implicit ");
14554     PerlIO_printf(Perl_debug_log, "minlen %"IVdf" ", (IV)r->minlen);
14555     if (r->extflags & RXf_EVAL_SEEN)
14556         PerlIO_printf(Perl_debug_log, "with eval ");
14557     PerlIO_printf(Perl_debug_log, "\n");
14558     DEBUG_FLAGS_r({
14559         regdump_extflags("r->extflags: ",r->extflags);
14560         regdump_intflags("r->intflags: ",r->intflags);
14561     });
14562 #else
14563     PERL_ARGS_ASSERT_REGDUMP;
14564     PERL_UNUSED_CONTEXT;
14565     PERL_UNUSED_ARG(r);
14566 #endif  /* DEBUGGING */
14567 }
14568
14569 /*
14570 - regprop - printable representation of opcode
14571 */
14572 #define EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags) \
14573 STMT_START { \
14574         if (do_sep) {                           \
14575             Perl_sv_catpvf(aTHX_ sv,"%s][%s",PL_colors[1],PL_colors[0]); \
14576             if (flags & ANYOF_INVERT)           \
14577                 /*make sure the invert info is in each */ \
14578                 sv_catpvs(sv, "^");             \
14579             do_sep = 0;                         \
14580         }                                       \
14581 } STMT_END
14582
14583 void
14584 Perl_regprop(pTHX_ const regexp *prog, SV *sv, const regnode *o)
14585 {
14586 #ifdef DEBUGGING
14587     dVAR;
14588     int k;
14589
14590     /* Should be synchronized with * ANYOF_ #xdefines in regcomp.h */
14591     static const char * const anyofs[] = {
14592 #if _CC_WORDCHAR != 0 || _CC_DIGIT != 1 || _CC_ALPHA != 2 || _CC_LOWER != 3 \
14593     || _CC_UPPER != 4 || _CC_PUNCT != 5 || _CC_PRINT != 6                   \
14594     || _CC_ALPHANUMERIC != 7 || _CC_GRAPH != 8 || _CC_CASED != 9            \
14595     || _CC_SPACE != 10 || _CC_BLANK != 11 || _CC_XDIGIT != 12               \
14596     || _CC_PSXSPC != 13 || _CC_CNTRL != 14 || _CC_ASCII != 15               \
14597     || _CC_VERTSPACE != 16
14598   #error Need to adjust order of anyofs[]
14599 #endif
14600         "[\\w]",
14601         "[\\W]",
14602         "[\\d]",
14603         "[\\D]",
14604         "[:alpha:]",
14605         "[:^alpha:]",
14606         "[:lower:]",
14607         "[:^lower:]",
14608         "[:upper:]",
14609         "[:^upper:]",
14610         "[:punct:]",
14611         "[:^punct:]",
14612         "[:print:]",
14613         "[:^print:]",
14614         "[:alnum:]",
14615         "[:^alnum:]",
14616         "[:graph:]",
14617         "[:^graph:]",
14618         "[:cased:]",
14619         "[:^cased:]",
14620         "[\\s]",
14621         "[\\S]",
14622         "[:blank:]",
14623         "[:^blank:]",
14624         "[:xdigit:]",
14625         "[:^xdigit:]",
14626         "[:space:]",
14627         "[:^space:]",
14628         "[:cntrl:]",
14629         "[:^cntrl:]",
14630         "[:ascii:]",
14631         "[:^ascii:]",
14632         "[\\v]",
14633         "[\\V]"
14634     };
14635     RXi_GET_DECL(prog,progi);
14636     GET_RE_DEBUG_FLAGS_DECL;
14637     
14638     PERL_ARGS_ASSERT_REGPROP;
14639
14640     sv_setpvs(sv, "");
14641
14642     if (OP(o) > REGNODE_MAX)            /* regnode.type is unsigned */
14643         /* It would be nice to FAIL() here, but this may be called from
14644            regexec.c, and it would be hard to supply pRExC_state. */
14645         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d", (int)OP(o), (int)REGNODE_MAX);
14646     sv_catpv(sv, PL_reg_name[OP(o)]); /* Take off const! */
14647
14648     k = PL_regkind[OP(o)];
14649
14650     if (k == EXACT) {
14651         sv_catpvs(sv, " ");
14652         /* Using is_utf8_string() (via PERL_PV_UNI_DETECT) 
14653          * is a crude hack but it may be the best for now since 
14654          * we have no flag "this EXACTish node was UTF-8" 
14655          * --jhi */
14656         pv_pretty(sv, STRING(o), STR_LEN(o), 60, PL_colors[0], PL_colors[1],
14657                   PERL_PV_ESCAPE_UNI_DETECT |
14658                   PERL_PV_ESCAPE_NONASCII   |
14659                   PERL_PV_PRETTY_ELLIPSES   |
14660                   PERL_PV_PRETTY_LTGT       |
14661                   PERL_PV_PRETTY_NOCLEAR
14662                   );
14663     } else if (k == TRIE) {
14664         /* print the details of the trie in dumpuntil instead, as
14665          * progi->data isn't available here */
14666         const char op = OP(o);
14667         const U32 n = ARG(o);
14668         const reg_ac_data * const ac = IS_TRIE_AC(op) ?
14669                (reg_ac_data *)progi->data->data[n] :
14670                NULL;
14671         const reg_trie_data * const trie
14672             = (reg_trie_data*)progi->data->data[!IS_TRIE_AC(op) ? n : ac->trie];
14673         
14674         Perl_sv_catpvf(aTHX_ sv, "-%s",PL_reg_name[o->flags]);
14675         DEBUG_TRIE_COMPILE_r(
14676             Perl_sv_catpvf(aTHX_ sv,
14677                 "<S:%"UVuf"/%"IVdf" W:%"UVuf" L:%"UVuf"/%"UVuf" C:%"UVuf"/%"UVuf">",
14678                 (UV)trie->startstate,
14679                 (IV)trie->statecount-1, /* -1 because of the unused 0 element */
14680                 (UV)trie->wordcount,
14681                 (UV)trie->minlen,
14682                 (UV)trie->maxlen,
14683                 (UV)TRIE_CHARCOUNT(trie),
14684                 (UV)trie->uniquecharcount
14685             )
14686         );
14687         if ( IS_ANYOF_TRIE(op) || trie->bitmap ) {
14688             int i;
14689             int rangestart = -1;
14690             U8* bitmap = IS_ANYOF_TRIE(op) ? (U8*)ANYOF_BITMAP(o) : (U8*)TRIE_BITMAP(trie);
14691             sv_catpvs(sv, "[");
14692             for (i = 0; i <= 256; i++) {
14693                 if (i < 256 && BITMAP_TEST(bitmap,i)) {
14694                     if (rangestart == -1)
14695                         rangestart = i;
14696                 } else if (rangestart != -1) {
14697                     if (i <= rangestart + 3)
14698                         for (; rangestart < i; rangestart++)
14699                             put_byte(sv, rangestart);
14700                     else {
14701                         put_byte(sv, rangestart);
14702                         sv_catpvs(sv, "-");
14703                         put_byte(sv, i - 1);
14704                     }
14705                     rangestart = -1;
14706                 }
14707             }
14708             sv_catpvs(sv, "]");
14709         } 
14710          
14711     } else if (k == CURLY) {
14712         if (OP(o) == CURLYM || OP(o) == CURLYN || OP(o) == CURLYX)
14713             Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags); /* Parenth number */
14714         Perl_sv_catpvf(aTHX_ sv, " {%d,%d}", ARG1(o), ARG2(o));
14715     }
14716     else if (k == WHILEM && o->flags)                   /* Ordinal/of */
14717         Perl_sv_catpvf(aTHX_ sv, "[%d/%d]", o->flags & 0xf, o->flags>>4);
14718     else if (k == REF || k == OPEN || k == CLOSE || k == GROUPP || OP(o)==ACCEPT) {
14719         Perl_sv_catpvf(aTHX_ sv, "%d", (int)ARG(o));    /* Parenth number */
14720         if ( RXp_PAREN_NAMES(prog) ) {
14721             if ( k != REF || (OP(o) < NREF)) {
14722                 AV *list= MUTABLE_AV(progi->data->data[progi->name_list_idx]);
14723                 SV **name= av_fetch(list, ARG(o), 0 );
14724                 if (name)
14725                     Perl_sv_catpvf(aTHX_ sv, " '%"SVf"'", SVfARG(*name));
14726             }       
14727             else {
14728                 AV *list= MUTABLE_AV(progi->data->data[ progi->name_list_idx ]);
14729                 SV *sv_dat= MUTABLE_SV(progi->data->data[ ARG( o ) ]);
14730                 I32 *nums=(I32*)SvPVX(sv_dat);
14731                 SV **name= av_fetch(list, nums[0], 0 );
14732                 I32 n;
14733                 if (name) {
14734                     for ( n=0; n<SvIVX(sv_dat); n++ ) {
14735                         Perl_sv_catpvf(aTHX_ sv, "%s%"IVdf,
14736                                     (n ? "," : ""), (IV)nums[n]);
14737                     }
14738                     Perl_sv_catpvf(aTHX_ sv, " '%"SVf"'", SVfARG(*name));
14739                 }
14740             }
14741         }            
14742     } else if (k == GOSUB) 
14743         Perl_sv_catpvf(aTHX_ sv, "%d[%+d]", (int)ARG(o),(int)ARG2L(o)); /* Paren and offset */
14744     else if (k == VERB) {
14745         if (!o->flags) 
14746             Perl_sv_catpvf(aTHX_ sv, ":%"SVf, 
14747                            SVfARG((MUTABLE_SV(progi->data->data[ ARG( o ) ]))));
14748     } else if (k == LOGICAL)
14749         Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags);     /* 2: embedded, otherwise 1 */
14750     else if (k == ANYOF) {
14751         int i, rangestart = -1;
14752         const U8 flags = ANYOF_FLAGS(o);
14753         int do_sep = 0;
14754
14755
14756         if (flags & ANYOF_LOCALE)
14757             sv_catpvs(sv, "{loc}");
14758         if (flags & ANYOF_LOC_FOLD)
14759             sv_catpvs(sv, "{i}");
14760         Perl_sv_catpvf(aTHX_ sv, "[%s", PL_colors[0]);
14761         if (flags & ANYOF_INVERT)
14762             sv_catpvs(sv, "^");
14763
14764         /* output what the standard cp 0-255 bitmap matches */
14765         for (i = 0; i <= 256; i++) {
14766             if (i < 256 && ANYOF_BITMAP_TEST(o,i)) {
14767                 if (rangestart == -1)
14768                     rangestart = i;
14769             } else if (rangestart != -1) {
14770                 if (i <= rangestart + 3)
14771                     for (; rangestart < i; rangestart++)
14772                         put_byte(sv, rangestart);
14773                 else {
14774                     put_byte(sv, rangestart);
14775                     sv_catpvs(sv, "-");
14776                     put_byte(sv, i - 1);
14777                 }
14778                 do_sep = 1;
14779                 rangestart = -1;
14780             }
14781         }
14782         
14783         EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags);
14784         /* output any special charclass tests (used entirely under use locale) */
14785         if (ANYOF_CLASS_TEST_ANY_SET(o))
14786             for (i = 0; i < (int)(sizeof(anyofs)/sizeof(char*)); i++)
14787                 if (ANYOF_CLASS_TEST(o,i)) {
14788                     sv_catpv(sv, anyofs[i]);
14789                     do_sep = 1;
14790                 }
14791         
14792         EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags);
14793         
14794         if (flags & ANYOF_NON_UTF8_LATIN1_ALL) {
14795             sv_catpvs(sv, "{non-utf8-latin1-all}");
14796         }
14797
14798         /* output information about the unicode matching */
14799         if (flags & ANYOF_UNICODE_ALL)
14800             sv_catpvs(sv, "{unicode_all}");
14801         else if (ANYOF_NONBITMAP(o))
14802             sv_catpvs(sv, "{unicode}");
14803         if (flags & ANYOF_NONBITMAP_NON_UTF8)
14804             sv_catpvs(sv, "{outside bitmap}");
14805
14806         if (ANYOF_NONBITMAP(o)) {
14807             SV *lv; /* Set if there is something outside the bit map */
14808             SV * const sw = regclass_swash(prog, o, FALSE, &lv, NULL);
14809             bool byte_output = FALSE;   /* If something in the bitmap has been
14810                                            output */
14811
14812             if (lv && lv != &PL_sv_undef) {
14813                 if (sw) {
14814                     U8 s[UTF8_MAXBYTES_CASE+1];
14815
14816                     for (i = 0; i <= 256; i++) { /* Look at chars in bitmap */
14817                         uvchr_to_utf8(s, i);
14818
14819                         if (i < 256
14820                             && ! ANYOF_BITMAP_TEST(o, i)    /* Don't duplicate
14821                                                                things already
14822                                                                output as part
14823                                                                of the bitmap */
14824                             && swash_fetch(sw, s, TRUE))
14825                         {
14826                             if (rangestart == -1)
14827                                 rangestart = i;
14828                         } else if (rangestart != -1) {
14829                             byte_output = TRUE;
14830                             if (i <= rangestart + 3)
14831                                 for (; rangestart < i; rangestart++) {
14832                                     put_byte(sv, rangestart);
14833                                 }
14834                             else {
14835                                 put_byte(sv, rangestart);
14836                                 sv_catpvs(sv, "-");
14837                                 put_byte(sv, i-1);
14838                             }
14839                             rangestart = -1;
14840                         }
14841                     }
14842                 }
14843
14844                 {
14845                     char *s = savesvpv(lv);
14846                     char * const origs = s;
14847
14848                     while (*s && *s != '\n')
14849                         s++;
14850
14851                     if (*s == '\n') {
14852                         const char * const t = ++s;
14853
14854                         if (byte_output) {
14855                             sv_catpvs(sv, " ");
14856                         }
14857
14858                         while (*s) {
14859                             if (*s == '\n') {
14860
14861                                 /* Truncate very long output */
14862                                 if (s - origs > 256) {
14863                                     Perl_sv_catpvf(aTHX_ sv,
14864                                                    "%.*s...",
14865                                                    (int) (s - origs - 1),
14866                                                    t);
14867                                     goto out_dump;
14868                                 }
14869                                 *s = ' ';
14870                             }
14871                             else if (*s == '\t') {
14872                                 *s = '-';
14873                             }
14874                             s++;
14875                         }
14876                         if (s[-1] == ' ')
14877                             s[-1] = 0;
14878
14879                         sv_catpv(sv, t);
14880                     }
14881
14882                 out_dump:
14883
14884                     Safefree(origs);
14885                 }
14886                 SvREFCNT_dec_NN(lv);
14887             }
14888         }
14889
14890         Perl_sv_catpvf(aTHX_ sv, "%s]", PL_colors[1]);
14891     }
14892     else if (k == POSIXD || k == NPOSIXD) {
14893         U8 index = FLAGS(o) * 2;
14894         if (index > (sizeof(anyofs) / sizeof(anyofs[0]))) {
14895             Perl_sv_catpvf(aTHX_ sv, "[illegal type=%d])", index);
14896         }
14897         else {
14898             sv_catpv(sv, anyofs[index]);
14899         }
14900     }
14901     else if (k == BRANCHJ && (OP(o) == UNLESSM || OP(o) == IFMATCH))
14902         Perl_sv_catpvf(aTHX_ sv, "[%d]", -(o->flags));
14903 #else
14904     PERL_UNUSED_CONTEXT;
14905     PERL_UNUSED_ARG(sv);
14906     PERL_UNUSED_ARG(o);
14907     PERL_UNUSED_ARG(prog);
14908 #endif  /* DEBUGGING */
14909 }
14910
14911 SV *
14912 Perl_re_intuit_string(pTHX_ REGEXP * const r)
14913 {                               /* Assume that RE_INTUIT is set */
14914     dVAR;
14915     struct regexp *const prog = ReANY(r);
14916     GET_RE_DEBUG_FLAGS_DECL;
14917
14918     PERL_ARGS_ASSERT_RE_INTUIT_STRING;
14919     PERL_UNUSED_CONTEXT;
14920
14921     DEBUG_COMPILE_r(
14922         {
14923             const char * const s = SvPV_nolen_const(prog->check_substr
14924                       ? prog->check_substr : prog->check_utf8);
14925
14926             if (!PL_colorset) reginitcolors();
14927             PerlIO_printf(Perl_debug_log,
14928                       "%sUsing REx %ssubstr:%s \"%s%.60s%s%s\"\n",
14929                       PL_colors[4],
14930                       prog->check_substr ? "" : "utf8 ",
14931                       PL_colors[5],PL_colors[0],
14932                       s,
14933                       PL_colors[1],
14934                       (strlen(s) > 60 ? "..." : ""));
14935         } );
14936
14937     return prog->check_substr ? prog->check_substr : prog->check_utf8;
14938 }
14939
14940 /* 
14941    pregfree() 
14942    
14943    handles refcounting and freeing the perl core regexp structure. When 
14944    it is necessary to actually free the structure the first thing it 
14945    does is call the 'free' method of the regexp_engine associated to
14946    the regexp, allowing the handling of the void *pprivate; member 
14947    first. (This routine is not overridable by extensions, which is why 
14948    the extensions free is called first.)
14949    
14950    See regdupe and regdupe_internal if you change anything here. 
14951 */
14952 #ifndef PERL_IN_XSUB_RE
14953 void
14954 Perl_pregfree(pTHX_ REGEXP *r)
14955 {
14956     SvREFCNT_dec(r);
14957 }
14958
14959 void
14960 Perl_pregfree2(pTHX_ REGEXP *rx)
14961 {
14962     dVAR;
14963     struct regexp *const r = ReANY(rx);
14964     GET_RE_DEBUG_FLAGS_DECL;
14965
14966     PERL_ARGS_ASSERT_PREGFREE2;
14967
14968     if (r->mother_re) {
14969         ReREFCNT_dec(r->mother_re);
14970     } else {
14971         CALLREGFREE_PVT(rx); /* free the private data */
14972         SvREFCNT_dec(RXp_PAREN_NAMES(r));
14973         Safefree(r->xpv_len_u.xpvlenu_pv);
14974     }        
14975     if (r->substrs) {
14976         SvREFCNT_dec(r->anchored_substr);
14977         SvREFCNT_dec(r->anchored_utf8);
14978         SvREFCNT_dec(r->float_substr);
14979         SvREFCNT_dec(r->float_utf8);
14980         Safefree(r->substrs);
14981     }
14982     RX_MATCH_COPY_FREE(rx);
14983 #ifdef PERL_ANY_COW
14984     SvREFCNT_dec(r->saved_copy);
14985 #endif
14986     Safefree(r->offs);
14987     SvREFCNT_dec(r->qr_anoncv);
14988     rx->sv_u.svu_rx = 0;
14989 }
14990
14991 /*  reg_temp_copy()
14992     
14993     This is a hacky workaround to the structural issue of match results
14994     being stored in the regexp structure which is in turn stored in
14995     PL_curpm/PL_reg_curpm. The problem is that due to qr// the pattern
14996     could be PL_curpm in multiple contexts, and could require multiple
14997     result sets being associated with the pattern simultaneously, such
14998     as when doing a recursive match with (??{$qr})
14999     
15000     The solution is to make a lightweight copy of the regexp structure 
15001     when a qr// is returned from the code executed by (??{$qr}) this
15002     lightweight copy doesn't actually own any of its data except for
15003     the starp/end and the actual regexp structure itself. 
15004     
15005 */    
15006     
15007     
15008 REGEXP *
15009 Perl_reg_temp_copy (pTHX_ REGEXP *ret_x, REGEXP *rx)
15010 {
15011     struct regexp *ret;
15012     struct regexp *const r = ReANY(rx);
15013     const bool islv = ret_x && SvTYPE(ret_x) == SVt_PVLV;
15014
15015     PERL_ARGS_ASSERT_REG_TEMP_COPY;
15016
15017     if (!ret_x)
15018         ret_x = (REGEXP*) newSV_type(SVt_REGEXP);
15019     else {
15020         SvOK_off((SV *)ret_x);
15021         if (islv) {
15022             /* For PVLVs, SvANY points to the xpvlv body while sv_u points
15023                to the regexp.  (For SVt_REGEXPs, sv_upgrade has already
15024                made both spots point to the same regexp body.) */
15025             REGEXP *temp = (REGEXP *)newSV_type(SVt_REGEXP);
15026             assert(!SvPVX(ret_x));
15027             ret_x->sv_u.svu_rx = temp->sv_any;
15028             temp->sv_any = NULL;
15029             SvFLAGS(temp) = (SvFLAGS(temp) & ~SVTYPEMASK) | SVt_NULL;
15030             SvREFCNT_dec_NN(temp);
15031             /* SvCUR still resides in the xpvlv struct, so the regexp copy-
15032                ing below will not set it. */
15033             SvCUR_set(ret_x, SvCUR(rx));
15034         }
15035     }
15036     /* This ensures that SvTHINKFIRST(sv) is true, and hence that
15037        sv_force_normal(sv) is called.  */
15038     SvFAKE_on(ret_x);
15039     ret = ReANY(ret_x);
15040     
15041     SvFLAGS(ret_x) |= SvUTF8(rx);
15042     /* We share the same string buffer as the original regexp, on which we
15043        hold a reference count, incremented when mother_re is set below.
15044        The string pointer is copied here, being part of the regexp struct.
15045      */
15046     memcpy(&(ret->xpv_cur), &(r->xpv_cur),
15047            sizeof(regexp) - STRUCT_OFFSET(regexp, xpv_cur));
15048     if (r->offs) {
15049         const I32 npar = r->nparens+1;
15050         Newx(ret->offs, npar, regexp_paren_pair);
15051         Copy(r->offs, ret->offs, npar, regexp_paren_pair);
15052     }
15053     if (r->substrs) {
15054         Newx(ret->substrs, 1, struct reg_substr_data);
15055         StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
15056
15057         SvREFCNT_inc_void(ret->anchored_substr);
15058         SvREFCNT_inc_void(ret->anchored_utf8);
15059         SvREFCNT_inc_void(ret->float_substr);
15060         SvREFCNT_inc_void(ret->float_utf8);
15061
15062         /* check_substr and check_utf8, if non-NULL, point to either their
15063            anchored or float namesakes, and don't hold a second reference.  */
15064     }
15065     RX_MATCH_COPIED_off(ret_x);
15066 #ifdef PERL_ANY_COW
15067     ret->saved_copy = NULL;
15068 #endif
15069     ret->mother_re = ReREFCNT_inc(r->mother_re ? r->mother_re : rx);
15070     SvREFCNT_inc_void(ret->qr_anoncv);
15071     
15072     return ret_x;
15073 }
15074 #endif
15075
15076 /* regfree_internal() 
15077
15078    Free the private data in a regexp. This is overloadable by 
15079    extensions. Perl takes care of the regexp structure in pregfree(), 
15080    this covers the *pprivate pointer which technically perl doesn't 
15081    know about, however of course we have to handle the 
15082    regexp_internal structure when no extension is in use. 
15083    
15084    Note this is called before freeing anything in the regexp 
15085    structure. 
15086  */
15087  
15088 void
15089 Perl_regfree_internal(pTHX_ REGEXP * const rx)
15090 {
15091     dVAR;
15092     struct regexp *const r = ReANY(rx);
15093     RXi_GET_DECL(r,ri);
15094     GET_RE_DEBUG_FLAGS_DECL;
15095
15096     PERL_ARGS_ASSERT_REGFREE_INTERNAL;
15097
15098     DEBUG_COMPILE_r({
15099         if (!PL_colorset)
15100             reginitcolors();
15101         {
15102             SV *dsv= sv_newmortal();
15103             RE_PV_QUOTED_DECL(s, RX_UTF8(rx),
15104                 dsv, RX_PRECOMP(rx), RX_PRELEN(rx), 60);
15105             PerlIO_printf(Perl_debug_log,"%sFreeing REx:%s %s\n", 
15106                 PL_colors[4],PL_colors[5],s);
15107         }
15108     });
15109 #ifdef RE_TRACK_PATTERN_OFFSETS
15110     if (ri->u.offsets)
15111         Safefree(ri->u.offsets);             /* 20010421 MJD */
15112 #endif
15113     if (ri->code_blocks) {
15114         int n;
15115         for (n = 0; n < ri->num_code_blocks; n++)
15116             SvREFCNT_dec(ri->code_blocks[n].src_regex);
15117         Safefree(ri->code_blocks);
15118     }
15119
15120     if (ri->data) {
15121         int n = ri->data->count;
15122
15123         while (--n >= 0) {
15124           /* If you add a ->what type here, update the comment in regcomp.h */
15125             switch (ri->data->what[n]) {
15126             case 'a':
15127             case 'r':
15128             case 's':
15129             case 'S':
15130             case 'u':
15131                 SvREFCNT_dec(MUTABLE_SV(ri->data->data[n]));
15132                 break;
15133             case 'f':
15134                 Safefree(ri->data->data[n]);
15135                 break;
15136             case 'l':
15137             case 'L':
15138                 break;
15139             case 'T':           
15140                 { /* Aho Corasick add-on structure for a trie node.
15141                      Used in stclass optimization only */
15142                     U32 refcount;
15143                     reg_ac_data *aho=(reg_ac_data*)ri->data->data[n];
15144                     OP_REFCNT_LOCK;
15145                     refcount = --aho->refcount;
15146                     OP_REFCNT_UNLOCK;
15147                     if ( !refcount ) {
15148                         PerlMemShared_free(aho->states);
15149                         PerlMemShared_free(aho->fail);
15150                          /* do this last!!!! */
15151                         PerlMemShared_free(ri->data->data[n]);
15152                         PerlMemShared_free(ri->regstclass);
15153                     }
15154                 }
15155                 break;
15156             case 't':
15157                 {
15158                     /* trie structure. */
15159                     U32 refcount;
15160                     reg_trie_data *trie=(reg_trie_data*)ri->data->data[n];
15161                     OP_REFCNT_LOCK;
15162                     refcount = --trie->refcount;
15163                     OP_REFCNT_UNLOCK;
15164                     if ( !refcount ) {
15165                         PerlMemShared_free(trie->charmap);
15166                         PerlMemShared_free(trie->states);
15167                         PerlMemShared_free(trie->trans);
15168                         if (trie->bitmap)
15169                             PerlMemShared_free(trie->bitmap);
15170                         if (trie->jump)
15171                             PerlMemShared_free(trie->jump);
15172                         PerlMemShared_free(trie->wordinfo);
15173                         /* do this last!!!! */
15174                         PerlMemShared_free(ri->data->data[n]);
15175                     }
15176                 }
15177                 break;
15178             default:
15179                 Perl_croak(aTHX_ "panic: regfree data code '%c'", ri->data->what[n]);
15180             }
15181         }
15182         Safefree(ri->data->what);
15183         Safefree(ri->data);
15184     }
15185
15186     Safefree(ri);
15187 }
15188
15189 #define av_dup_inc(s,t) MUTABLE_AV(sv_dup_inc((const SV *)s,t))
15190 #define hv_dup_inc(s,t) MUTABLE_HV(sv_dup_inc((const SV *)s,t))
15191 #define SAVEPVN(p,n)    ((p) ? savepvn(p,n) : NULL)
15192
15193 /* 
15194    re_dup - duplicate a regexp. 
15195    
15196    This routine is expected to clone a given regexp structure. It is only
15197    compiled under USE_ITHREADS.
15198
15199    After all of the core data stored in struct regexp is duplicated
15200    the regexp_engine.dupe method is used to copy any private data
15201    stored in the *pprivate pointer. This allows extensions to handle
15202    any duplication it needs to do.
15203
15204    See pregfree() and regfree_internal() if you change anything here. 
15205 */
15206 #if defined(USE_ITHREADS)
15207 #ifndef PERL_IN_XSUB_RE
15208 void
15209 Perl_re_dup_guts(pTHX_ const REGEXP *sstr, REGEXP *dstr, CLONE_PARAMS *param)
15210 {
15211     dVAR;
15212     I32 npar;
15213     const struct regexp *r = ReANY(sstr);
15214     struct regexp *ret = ReANY(dstr);
15215     
15216     PERL_ARGS_ASSERT_RE_DUP_GUTS;
15217
15218     npar = r->nparens+1;
15219     Newx(ret->offs, npar, regexp_paren_pair);
15220     Copy(r->offs, ret->offs, npar, regexp_paren_pair);
15221
15222     if (ret->substrs) {
15223         /* Do it this way to avoid reading from *r after the StructCopy().
15224            That way, if any of the sv_dup_inc()s dislodge *r from the L1
15225            cache, it doesn't matter.  */
15226         const bool anchored = r->check_substr
15227             ? r->check_substr == r->anchored_substr
15228             : r->check_utf8 == r->anchored_utf8;
15229         Newx(ret->substrs, 1, struct reg_substr_data);
15230         StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
15231
15232         ret->anchored_substr = sv_dup_inc(ret->anchored_substr, param);
15233         ret->anchored_utf8 = sv_dup_inc(ret->anchored_utf8, param);
15234         ret->float_substr = sv_dup_inc(ret->float_substr, param);
15235         ret->float_utf8 = sv_dup_inc(ret->float_utf8, param);
15236
15237         /* check_substr and check_utf8, if non-NULL, point to either their
15238            anchored or float namesakes, and don't hold a second reference.  */
15239
15240         if (ret->check_substr) {
15241             if (anchored) {
15242                 assert(r->check_utf8 == r->anchored_utf8);
15243                 ret->check_substr = ret->anchored_substr;
15244                 ret->check_utf8 = ret->anchored_utf8;
15245             } else {
15246                 assert(r->check_substr == r->float_substr);
15247                 assert(r->check_utf8 == r->float_utf8);
15248                 ret->check_substr = ret->float_substr;
15249                 ret->check_utf8 = ret->float_utf8;
15250             }
15251         } else if (ret->check_utf8) {
15252             if (anchored) {
15253                 ret->check_utf8 = ret->anchored_utf8;
15254             } else {
15255                 ret->check_utf8 = ret->float_utf8;
15256             }
15257         }
15258     }
15259
15260     RXp_PAREN_NAMES(ret) = hv_dup_inc(RXp_PAREN_NAMES(ret), param);
15261     ret->qr_anoncv = MUTABLE_CV(sv_dup_inc((const SV *)ret->qr_anoncv, param));
15262
15263     if (ret->pprivate)
15264         RXi_SET(ret,CALLREGDUPE_PVT(dstr,param));
15265
15266     if (RX_MATCH_COPIED(dstr))
15267         ret->subbeg  = SAVEPVN(ret->subbeg, ret->sublen);
15268     else
15269         ret->subbeg = NULL;
15270 #ifdef PERL_ANY_COW
15271     ret->saved_copy = NULL;
15272 #endif
15273
15274     /* Whether mother_re be set or no, we need to copy the string.  We
15275        cannot refrain from copying it when the storage points directly to
15276        our mother regexp, because that's
15277                1: a buffer in a different thread
15278                2: something we no longer hold a reference on
15279                so we need to copy it locally.  */
15280     RX_WRAPPED(dstr) = SAVEPVN(RX_WRAPPED(sstr), SvCUR(sstr)+1);
15281     ret->mother_re   = NULL;
15282 }
15283 #endif /* PERL_IN_XSUB_RE */
15284
15285 /*
15286    regdupe_internal()
15287    
15288    This is the internal complement to regdupe() which is used to copy
15289    the structure pointed to by the *pprivate pointer in the regexp.
15290    This is the core version of the extension overridable cloning hook.
15291    The regexp structure being duplicated will be copied by perl prior
15292    to this and will be provided as the regexp *r argument, however 
15293    with the /old/ structures pprivate pointer value. Thus this routine
15294    may override any copying normally done by perl.
15295    
15296    It returns a pointer to the new regexp_internal structure.
15297 */
15298
15299 void *
15300 Perl_regdupe_internal(pTHX_ REGEXP * const rx, CLONE_PARAMS *param)
15301 {
15302     dVAR;
15303     struct regexp *const r = ReANY(rx);
15304     regexp_internal *reti;
15305     int len;
15306     RXi_GET_DECL(r,ri);
15307
15308     PERL_ARGS_ASSERT_REGDUPE_INTERNAL;
15309     
15310     len = ProgLen(ri);
15311     
15312     Newxc(reti, sizeof(regexp_internal) + len*sizeof(regnode), char, regexp_internal);
15313     Copy(ri->program, reti->program, len+1, regnode);
15314
15315     reti->num_code_blocks = ri->num_code_blocks;
15316     if (ri->code_blocks) {
15317         int n;
15318         Newxc(reti->code_blocks, ri->num_code_blocks, struct reg_code_block,
15319                 struct reg_code_block);
15320         Copy(ri->code_blocks, reti->code_blocks, ri->num_code_blocks,
15321                 struct reg_code_block);
15322         for (n = 0; n < ri->num_code_blocks; n++)
15323              reti->code_blocks[n].src_regex = (REGEXP*)
15324                     sv_dup_inc((SV*)(ri->code_blocks[n].src_regex), param);
15325     }
15326     else
15327         reti->code_blocks = NULL;
15328
15329     reti->regstclass = NULL;
15330
15331     if (ri->data) {
15332         struct reg_data *d;
15333         const int count = ri->data->count;
15334         int i;
15335
15336         Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
15337                 char, struct reg_data);
15338         Newx(d->what, count, U8);
15339
15340         d->count = count;
15341         for (i = 0; i < count; i++) {
15342             d->what[i] = ri->data->what[i];
15343             switch (d->what[i]) {
15344                 /* see also regcomp.h and regfree_internal() */
15345             case 'a': /* actually an AV, but the dup function is identical.  */
15346             case 'r':
15347             case 's':
15348             case 'S':
15349             case 'u': /* actually an HV, but the dup function is identical.  */
15350                 d->data[i] = sv_dup_inc((const SV *)ri->data->data[i], param);
15351                 break;
15352             case 'f':
15353                 /* This is cheating. */
15354                 Newx(d->data[i], 1, struct regnode_charclass_class);
15355                 StructCopy(ri->data->data[i], d->data[i],
15356                             struct regnode_charclass_class);
15357                 reti->regstclass = (regnode*)d->data[i];
15358                 break;
15359             case 'T':
15360                 /* Trie stclasses are readonly and can thus be shared
15361                  * without duplication. We free the stclass in pregfree
15362                  * when the corresponding reg_ac_data struct is freed.
15363                  */
15364                 reti->regstclass= ri->regstclass;
15365                 /* Fall through */
15366             case 't':
15367                 OP_REFCNT_LOCK;
15368                 ((reg_trie_data*)ri->data->data[i])->refcount++;
15369                 OP_REFCNT_UNLOCK;
15370                 /* Fall through */
15371             case 'l':
15372             case 'L':
15373                 d->data[i] = ri->data->data[i];
15374                 break;
15375             default:
15376                 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", ri->data->what[i]);
15377             }
15378         }
15379
15380         reti->data = d;
15381     }
15382     else
15383         reti->data = NULL;
15384
15385     reti->name_list_idx = ri->name_list_idx;
15386
15387 #ifdef RE_TRACK_PATTERN_OFFSETS
15388     if (ri->u.offsets) {
15389         Newx(reti->u.offsets, 2*len+1, U32);
15390         Copy(ri->u.offsets, reti->u.offsets, 2*len+1, U32);
15391     }
15392 #else
15393     SetProgLen(reti,len);
15394 #endif
15395
15396     return (void*)reti;
15397 }
15398
15399 #endif    /* USE_ITHREADS */
15400
15401 #ifndef PERL_IN_XSUB_RE
15402
15403 /*
15404  - regnext - dig the "next" pointer out of a node
15405  */
15406 regnode *
15407 Perl_regnext(pTHX_ regnode *p)
15408 {
15409     dVAR;
15410     I32 offset;
15411
15412     if (!p)
15413         return(NULL);
15414
15415     if (OP(p) > REGNODE_MAX) {          /* regnode.type is unsigned */
15416         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d", (int)OP(p), (int)REGNODE_MAX);
15417     }
15418
15419     offset = (reg_off_by_arg[OP(p)] ? ARG(p) : NEXT_OFF(p));
15420     if (offset == 0)
15421         return(NULL);
15422
15423     return(p+offset);
15424 }
15425 #endif
15426
15427 STATIC void
15428 S_re_croak2(pTHX_ const char* pat1,const char* pat2,...)
15429 {
15430     va_list args;
15431     STRLEN l1 = strlen(pat1);
15432     STRLEN l2 = strlen(pat2);
15433     char buf[512];
15434     SV *msv;
15435     const char *message;
15436
15437     PERL_ARGS_ASSERT_RE_CROAK2;
15438
15439     if (l1 > 510)
15440         l1 = 510;
15441     if (l1 + l2 > 510)
15442         l2 = 510 - l1;
15443     Copy(pat1, buf, l1 , char);
15444     Copy(pat2, buf + l1, l2 , char);
15445     buf[l1 + l2] = '\n';
15446     buf[l1 + l2 + 1] = '\0';
15447 #ifdef I_STDARG
15448     /* ANSI variant takes additional second argument */
15449     va_start(args, pat2);
15450 #else
15451     va_start(args);
15452 #endif
15453     msv = vmess(buf, &args);
15454     va_end(args);
15455     message = SvPV_const(msv,l1);
15456     if (l1 > 512)
15457         l1 = 512;
15458     Copy(message, buf, l1 , char);
15459     buf[l1-1] = '\0';                   /* Overwrite \n */
15460     Perl_croak(aTHX_ "%s", buf);
15461 }
15462
15463 /* XXX Here's a total kludge.  But we need to re-enter for swash routines. */
15464
15465 #ifndef PERL_IN_XSUB_RE
15466 void
15467 Perl_save_re_context(pTHX)
15468 {
15469     dVAR;
15470
15471     /* Save $1..$n (#18107: UTF-8 s/(\w+)/uc($1)/e); AMS 20021106. */
15472     if (PL_curpm) {
15473         const REGEXP * const rx = PM_GETRE(PL_curpm);
15474         if (rx) {
15475             U32 i;
15476             for (i = 1; i <= RX_NPARENS(rx); i++) {
15477                 char digits[TYPE_CHARS(long)];
15478                 const STRLEN len = my_snprintf(digits, sizeof(digits), "%lu", (long)i);
15479                 GV *const *const gvp
15480                     = (GV**)hv_fetch(PL_defstash, digits, len, 0);
15481
15482                 if (gvp) {
15483                     GV * const gv = *gvp;
15484                     if (SvTYPE(gv) == SVt_PVGV && GvSV(gv))
15485                         save_scalar(gv);
15486                 }
15487             }
15488         }
15489     }
15490 }
15491 #endif
15492
15493 #ifdef DEBUGGING
15494
15495 STATIC void
15496 S_put_byte(pTHX_ SV *sv, int c)
15497 {
15498     PERL_ARGS_ASSERT_PUT_BYTE;
15499
15500     /* Our definition of isPRINT() ignores locales, so only bytes that are
15501        not part of UTF-8 are considered printable. I assume that the same
15502        holds for UTF-EBCDIC.
15503        Also, code point 255 is not printable in either (it's E0 in EBCDIC,
15504        which Wikipedia says:
15505
15506        EO, or Eight Ones, is an 8-bit EBCDIC character code represented as all
15507        ones (binary 1111 1111, hexadecimal FF). It is similar, but not
15508        identical, to the ASCII delete (DEL) or rubout control character. ...
15509        it is typically mapped to hexadecimal code 9F, in order to provide a
15510        unique character mapping in both directions)
15511
15512        So the old condition can be simplified to !isPRINT(c)  */
15513     if (!isPRINT(c)) {
15514         if (c < 256) {
15515             Perl_sv_catpvf(aTHX_ sv, "\\x%02x", c);
15516         }
15517         else {
15518             Perl_sv_catpvf(aTHX_ sv, "\\x{%x}", c);
15519         }
15520     }
15521     else {
15522         const char string = c;
15523         if (c == '-' || c == ']' || c == '\\' || c == '^')
15524             sv_catpvs(sv, "\\");
15525         sv_catpvn(sv, &string, 1);
15526     }
15527 }
15528
15529
15530 #define CLEAR_OPTSTART \
15531     if (optstart) STMT_START { \
15532             DEBUG_OPTIMISE_r(PerlIO_printf(Perl_debug_log, " (%"IVdf" nodes)\n", (IV)(node - optstart))); \
15533             optstart=NULL; \
15534     } STMT_END
15535
15536 #define DUMPUNTIL(b,e) CLEAR_OPTSTART; node=dumpuntil(r,start,(b),(e),last,sv,indent+1,depth+1);
15537
15538 STATIC const regnode *
15539 S_dumpuntil(pTHX_ const regexp *r, const regnode *start, const regnode *node,
15540             const regnode *last, const regnode *plast, 
15541             SV* sv, I32 indent, U32 depth)
15542 {
15543     dVAR;
15544     U8 op = PSEUDO;     /* Arbitrary non-END op. */
15545     const regnode *next;
15546     const regnode *optstart= NULL;
15547     
15548     RXi_GET_DECL(r,ri);
15549     GET_RE_DEBUG_FLAGS_DECL;
15550
15551     PERL_ARGS_ASSERT_DUMPUNTIL;
15552
15553 #ifdef DEBUG_DUMPUNTIL
15554     PerlIO_printf(Perl_debug_log, "--- %d : %d - %d - %d\n",indent,node-start,
15555         last ? last-start : 0,plast ? plast-start : 0);
15556 #endif
15557             
15558     if (plast && plast < last) 
15559         last= plast;
15560
15561     while (PL_regkind[op] != END && (!last || node < last)) {
15562         /* While that wasn't END last time... */
15563         NODE_ALIGN(node);
15564         op = OP(node);
15565         if (op == CLOSE || op == WHILEM)
15566             indent--;
15567         next = regnext((regnode *)node);
15568
15569         /* Where, what. */
15570         if (OP(node) == OPTIMIZED) {
15571             if (!optstart && RE_DEBUG_FLAG(RE_DEBUG_COMPILE_OPTIMISE))
15572                 optstart = node;
15573             else
15574                 goto after_print;
15575         } else
15576             CLEAR_OPTSTART;
15577
15578         regprop(r, sv, node);
15579         PerlIO_printf(Perl_debug_log, "%4"IVdf":%*s%s", (IV)(node - start),
15580                       (int)(2*indent + 1), "", SvPVX_const(sv));
15581         
15582         if (OP(node) != OPTIMIZED) {                  
15583             if (next == NULL)           /* Next ptr. */
15584                 PerlIO_printf(Perl_debug_log, " (0)");
15585             else if (PL_regkind[(U8)op] == BRANCH && PL_regkind[OP(next)] != BRANCH )
15586                 PerlIO_printf(Perl_debug_log, " (FAIL)");
15587             else 
15588                 PerlIO_printf(Perl_debug_log, " (%"IVdf")", (IV)(next - start));
15589             (void)PerlIO_putc(Perl_debug_log, '\n'); 
15590         }
15591         
15592       after_print:
15593         if (PL_regkind[(U8)op] == BRANCHJ) {
15594             assert(next);
15595             {
15596                 const regnode *nnode = (OP(next) == LONGJMP
15597                                        ? regnext((regnode *)next)
15598                                        : next);
15599                 if (last && nnode > last)
15600                     nnode = last;
15601                 DUMPUNTIL(NEXTOPER(NEXTOPER(node)), nnode);
15602             }
15603         }
15604         else if (PL_regkind[(U8)op] == BRANCH) {
15605             assert(next);
15606             DUMPUNTIL(NEXTOPER(node), next);
15607         }
15608         else if ( PL_regkind[(U8)op]  == TRIE ) {
15609             const regnode *this_trie = node;
15610             const char op = OP(node);
15611             const U32 n = ARG(node);
15612             const reg_ac_data * const ac = op>=AHOCORASICK ?
15613                (reg_ac_data *)ri->data->data[n] :
15614                NULL;
15615             const reg_trie_data * const trie =
15616                 (reg_trie_data*)ri->data->data[op<AHOCORASICK ? n : ac->trie];
15617 #ifdef DEBUGGING
15618             AV *const trie_words = MUTABLE_AV(ri->data->data[n + TRIE_WORDS_OFFSET]);
15619 #endif
15620             const regnode *nextbranch= NULL;
15621             I32 word_idx;
15622             sv_setpvs(sv, "");
15623             for (word_idx= 0; word_idx < (I32)trie->wordcount; word_idx++) {
15624                 SV ** const elem_ptr = av_fetch(trie_words,word_idx,0);
15625
15626                 PerlIO_printf(Perl_debug_log, "%*s%s ",
15627                    (int)(2*(indent+3)), "",
15628                     elem_ptr ? pv_pretty(sv, SvPV_nolen_const(*elem_ptr), SvCUR(*elem_ptr), 60,
15629                             PL_colors[0], PL_colors[1],
15630                             (SvUTF8(*elem_ptr) ? PERL_PV_ESCAPE_UNI : 0) |
15631                             PERL_PV_PRETTY_ELLIPSES    |
15632                             PERL_PV_PRETTY_LTGT
15633                             )
15634                             : "???"
15635                 );
15636                 if (trie->jump) {
15637                     U16 dist= trie->jump[word_idx+1];
15638                     PerlIO_printf(Perl_debug_log, "(%"UVuf")\n",
15639                                   (UV)((dist ? this_trie + dist : next) - start));
15640                     if (dist) {
15641                         if (!nextbranch)
15642                             nextbranch= this_trie + trie->jump[0];    
15643                         DUMPUNTIL(this_trie + dist, nextbranch);
15644                     }
15645                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
15646                         nextbranch= regnext((regnode *)nextbranch);
15647                 } else {
15648                     PerlIO_printf(Perl_debug_log, "\n");
15649                 }
15650             }
15651             if (last && next > last)
15652                 node= last;
15653             else
15654                 node= next;
15655         }
15656         else if ( op == CURLY ) {   /* "next" might be very big: optimizer */
15657             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS,
15658                     NEXTOPER(node) + EXTRA_STEP_2ARGS + 1);
15659         }
15660         else if (PL_regkind[(U8)op] == CURLY && op != CURLYX) {
15661             assert(next);
15662             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS, next);
15663         }
15664         else if ( op == PLUS || op == STAR) {
15665             DUMPUNTIL(NEXTOPER(node), NEXTOPER(node) + 1);
15666         }
15667         else if (PL_regkind[(U8)op] == ANYOF) {
15668             /* arglen 1 + class block */
15669             node += 1 + ((ANYOF_FLAGS(node) & ANYOF_CLASS)
15670                     ? ANYOF_CLASS_SKIP : ANYOF_SKIP);
15671             node = NEXTOPER(node);
15672         }
15673         else if (PL_regkind[(U8)op] == EXACT) {
15674             /* Literal string, where present. */
15675             node += NODE_SZ_STR(node) - 1;
15676             node = NEXTOPER(node);
15677         }
15678         else {
15679             node = NEXTOPER(node);
15680             node += regarglen[(U8)op];
15681         }
15682         if (op == CURLYX || op == OPEN)
15683             indent++;
15684     }
15685     CLEAR_OPTSTART;
15686 #ifdef DEBUG_DUMPUNTIL    
15687     PerlIO_printf(Perl_debug_log, "--- %d\n", (int)indent);
15688 #endif
15689     return node;
15690 }
15691
15692 #endif  /* DEBUGGING */
15693
15694 /*
15695  * Local variables:
15696  * c-indentation-style: bsd
15697  * c-basic-offset: 4
15698  * indent-tabs-mode: nil
15699  * End:
15700  *
15701  * ex: set ts=8 sts=4 sw=4 et:
15702  */