This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta for PL_stashcacheh and glob-to-glob assignment (210fdecd4)
[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 ckWARN2regdep(loc,m, a1) STMT_START {                           \
578     const IV offset = loc - RExC_precomp;                               \
579     Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, 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            S_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     regex_charset initial_charset = get_regex_charset(orig_rx_flags);
5525     bool recompile = 0;
5526     bool runtime_code = 0;
5527     scan_data_t data;
5528     RExC_state_t RExC_state;
5529     RExC_state_t * const pRExC_state = &RExC_state;
5530 #ifdef TRIE_STUDY_OPT    
5531     int restudied = 0;
5532     RExC_state_t copyRExC_state;
5533 #endif    
5534     GET_RE_DEBUG_FLAGS_DECL;
5535
5536     PERL_ARGS_ASSERT_RE_OP_COMPILE;
5537
5538     DEBUG_r(if (!PL_colorset) reginitcolors());
5539
5540 #ifndef PERL_IN_XSUB_RE
5541     /* Initialize these here instead of as-needed, as is quick and avoids
5542      * having to test them each time otherwise */
5543     if (! PL_AboveLatin1) {
5544         PL_AboveLatin1 = _new_invlist_C_array(AboveLatin1_invlist);
5545         PL_ASCII = _new_invlist_C_array(ASCII_invlist);
5546         PL_Latin1 = _new_invlist_C_array(Latin1_invlist);
5547
5548         PL_L1Posix_ptrs[_CC_ALPHANUMERIC]
5549                                 = _new_invlist_C_array(L1PosixAlnum_invlist);
5550         PL_Posix_ptrs[_CC_ALPHANUMERIC]
5551                                 = _new_invlist_C_array(PosixAlnum_invlist);
5552
5553         PL_L1Posix_ptrs[_CC_ALPHA]
5554                                 = _new_invlist_C_array(L1PosixAlpha_invlist);
5555         PL_Posix_ptrs[_CC_ALPHA] = _new_invlist_C_array(PosixAlpha_invlist);
5556
5557         PL_Posix_ptrs[_CC_BLANK] = _new_invlist_C_array(PosixBlank_invlist);
5558         PL_XPosix_ptrs[_CC_BLANK] = _new_invlist_C_array(XPosixBlank_invlist);
5559
5560         /* Cased is the same as Alpha in the ASCII range */
5561         PL_L1Posix_ptrs[_CC_CASED] =  _new_invlist_C_array(L1Cased_invlist);
5562         PL_Posix_ptrs[_CC_CASED] =  _new_invlist_C_array(PosixAlpha_invlist);
5563
5564         PL_Posix_ptrs[_CC_CNTRL] = _new_invlist_C_array(PosixCntrl_invlist);
5565         PL_XPosix_ptrs[_CC_CNTRL] = _new_invlist_C_array(XPosixCntrl_invlist);
5566
5567         PL_Posix_ptrs[_CC_DIGIT] = _new_invlist_C_array(PosixDigit_invlist);
5568         PL_L1Posix_ptrs[_CC_DIGIT] = _new_invlist_C_array(PosixDigit_invlist);
5569
5570         PL_L1Posix_ptrs[_CC_GRAPH] = _new_invlist_C_array(L1PosixGraph_invlist);
5571         PL_Posix_ptrs[_CC_GRAPH] = _new_invlist_C_array(PosixGraph_invlist);
5572
5573         PL_L1Posix_ptrs[_CC_LOWER] = _new_invlist_C_array(L1PosixLower_invlist);
5574         PL_Posix_ptrs[_CC_LOWER] = _new_invlist_C_array(PosixLower_invlist);
5575
5576         PL_L1Posix_ptrs[_CC_PRINT] = _new_invlist_C_array(L1PosixPrint_invlist);
5577         PL_Posix_ptrs[_CC_PRINT] = _new_invlist_C_array(PosixPrint_invlist);
5578
5579         PL_L1Posix_ptrs[_CC_PUNCT] = _new_invlist_C_array(L1PosixPunct_invlist);
5580         PL_Posix_ptrs[_CC_PUNCT] = _new_invlist_C_array(PosixPunct_invlist);
5581
5582         PL_Posix_ptrs[_CC_SPACE] = _new_invlist_C_array(PerlSpace_invlist);
5583         PL_XPosix_ptrs[_CC_SPACE] = _new_invlist_C_array(XPerlSpace_invlist);
5584         PL_Posix_ptrs[_CC_PSXSPC] = _new_invlist_C_array(PosixSpace_invlist);
5585         PL_XPosix_ptrs[_CC_PSXSPC] = _new_invlist_C_array(XPosixSpace_invlist);
5586
5587         PL_L1Posix_ptrs[_CC_UPPER] = _new_invlist_C_array(L1PosixUpper_invlist);
5588         PL_Posix_ptrs[_CC_UPPER] = _new_invlist_C_array(PosixUpper_invlist);
5589
5590         PL_XPosix_ptrs[_CC_VERTSPACE] = _new_invlist_C_array(VertSpace_invlist);
5591
5592         PL_Posix_ptrs[_CC_WORDCHAR] = _new_invlist_C_array(PosixWord_invlist);
5593         PL_L1Posix_ptrs[_CC_WORDCHAR]
5594                                 = _new_invlist_C_array(L1PosixWord_invlist);
5595
5596         PL_Posix_ptrs[_CC_XDIGIT] = _new_invlist_C_array(PosixXDigit_invlist);
5597         PL_XPosix_ptrs[_CC_XDIGIT] = _new_invlist_C_array(XPosixXDigit_invlist);
5598
5599         PL_HasMultiCharFold = _new_invlist_C_array(_Perl_Multi_Char_Folds_invlist);
5600     }
5601 #endif
5602
5603     pRExC_state->code_blocks = NULL;
5604     pRExC_state->num_code_blocks = 0;
5605
5606     if (is_bare_re)
5607         *is_bare_re = FALSE;
5608
5609     if (expr && (expr->op_type == OP_LIST ||
5610                 (expr->op_type == OP_NULL && expr->op_targ == OP_LIST))) {
5611         /* allocate code_blocks if needed */
5612         OP *o;
5613         int ncode = 0;
5614
5615         for (o = cLISTOPx(expr)->op_first; o; o = o->op_sibling)
5616             if (o->op_type == OP_NULL && (o->op_flags & OPf_SPECIAL))
5617                 ncode++; /* count of DO blocks */
5618         if (ncode) {
5619             pRExC_state->num_code_blocks = ncode;
5620             Newx(pRExC_state->code_blocks, ncode, struct reg_code_block);
5621         }
5622     }
5623
5624     if (!pat_count) {
5625         /* compile-time pattern with just OP_CONSTs and DO blocks */
5626
5627         int n;
5628         OP *o;
5629
5630         /* find how many CONSTs there are */
5631         assert(expr);
5632         n = 0;
5633         if (expr->op_type == OP_CONST)
5634             n = 1;
5635         else
5636             for (o = cLISTOPx(expr)->op_first; o; o = o->op_sibling) {
5637                 if (o->op_type == OP_CONST)
5638                     n++;
5639             }
5640
5641         /* fake up an SV array */
5642
5643         assert(!new_patternp);
5644         Newx(new_patternp, n, SV*);
5645         SAVEFREEPV(new_patternp);
5646         pat_count = n;
5647
5648         n = 0;
5649         if (expr->op_type == OP_CONST)
5650             new_patternp[n] = cSVOPx_sv(expr);
5651         else
5652             for (o = cLISTOPx(expr)->op_first; o; o = o->op_sibling) {
5653                 if (o->op_type == OP_CONST)
5654                     new_patternp[n++] = cSVOPo_sv;
5655             }
5656
5657     }
5658
5659     DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log,
5660         "Assembling pattern from %d elements%s\n", pat_count,
5661             orig_rx_flags & RXf_SPLIT ? " for split" : ""));
5662
5663     /* set expr to the first arg op */
5664
5665     if (pRExC_state->num_code_blocks
5666          && expr->op_type != OP_CONST)
5667     {
5668             expr = cLISTOPx(expr)->op_first;
5669             assert(   expr->op_type == OP_PUSHMARK
5670                    || (expr->op_type == OP_NULL && expr->op_targ == OP_PUSHMARK)
5671                    || expr->op_type == OP_PADRANGE);
5672             expr = expr->op_sibling;
5673     }
5674
5675     pat = S_concat_pat(aTHX_ pRExC_state, NULL, new_patternp, pat_count,
5676                         expr, &recompile, NULL);
5677
5678     /* handle bare (possibly after overloading) regex: foo =~ $re */
5679     {
5680         SV *re = pat;
5681         if (SvROK(re))
5682             re = SvRV(re);
5683         if (SvTYPE(re) == SVt_REGEXP) {
5684             if (is_bare_re)
5685                 *is_bare_re = TRUE;
5686             SvREFCNT_inc(re);
5687             Safefree(pRExC_state->code_blocks);
5688             DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log,
5689                 "Precompiled pattern%s\n",
5690                     orig_rx_flags & RXf_SPLIT ? " for split" : ""));
5691
5692             return (REGEXP*)re;
5693         }
5694     }
5695
5696     exp = SvPV_nomg(pat, plen);
5697
5698     if (!eng->op_comp) {
5699         if ((SvUTF8(pat) && IN_BYTES)
5700                 || SvGMAGICAL(pat) || SvAMAGIC(pat))
5701         {
5702             /* make a temporary copy; either to convert to bytes,
5703              * or to avoid repeating get-magic / overloaded stringify */
5704             pat = newSVpvn_flags(exp, plen, SVs_TEMP |
5705                                         (IN_BYTES ? 0 : SvUTF8(pat)));
5706         }
5707         Safefree(pRExC_state->code_blocks);
5708         return CALLREGCOMP_ENG(eng, pat, orig_rx_flags);
5709     }
5710
5711     /* ignore the utf8ness if the pattern is 0 length */
5712     RExC_utf8 = RExC_orig_utf8 = (plen == 0 || IN_BYTES) ? 0 : SvUTF8(pat);
5713     RExC_uni_semantics = 0;
5714     RExC_contains_locale = 0;
5715     pRExC_state->runtime_code_qr = NULL;
5716
5717     DEBUG_COMPILE_r({
5718             SV *dsv= sv_newmortal();
5719             RE_PV_QUOTED_DECL(s, RExC_utf8, dsv, exp, plen, 60);
5720             PerlIO_printf(Perl_debug_log, "%sCompiling REx%s %s\n",
5721                           PL_colors[4],PL_colors[5],s);
5722         });
5723
5724   redo_first_pass:
5725     /* we jump here if we upgrade the pattern to utf8 and have to
5726      * recompile */
5727
5728     if ((pm_flags & PMf_USE_RE_EVAL)
5729                 /* this second condition covers the non-regex literal case,
5730                  * i.e.  $foo =~ '(?{})'. */
5731                 || (IN_PERL_COMPILETIME && (PL_hints & HINT_RE_EVAL))
5732     )
5733         runtime_code = S_has_runtime_code(aTHX_ pRExC_state, exp, plen);
5734
5735     /* return old regex if pattern hasn't changed */
5736     /* XXX: note in the below we have to check the flags as well as the pattern.
5737      *
5738      * Things get a touch tricky as we have to compare the utf8 flag independently
5739      * from the compile flags.
5740      */
5741
5742     if (   old_re
5743         && !recompile
5744         && !!RX_UTF8(old_re) == !!RExC_utf8
5745         && ( RX_COMPFLAGS(old_re) == ( orig_rx_flags & RXf_PMf_FLAGCOPYMASK ) )
5746         && RX_PRECOMP(old_re)
5747         && RX_PRELEN(old_re) == plen
5748         && memEQ(RX_PRECOMP(old_re), exp, plen)
5749         && !runtime_code /* with runtime code, always recompile */ )
5750     {
5751         Safefree(pRExC_state->code_blocks);
5752         return old_re;
5753     }
5754
5755     rx_flags = orig_rx_flags;
5756
5757     if (initial_charset == REGEX_LOCALE_CHARSET) {
5758         RExC_contains_locale = 1;
5759     }
5760     else if (RExC_utf8 && initial_charset == REGEX_DEPENDS_CHARSET) {
5761
5762         /* Set to use unicode semantics if the pattern is in utf8 and has the
5763          * 'depends' charset specified, as it means unicode when utf8  */
5764         set_regex_charset(&rx_flags, REGEX_UNICODE_CHARSET);
5765     }
5766
5767     RExC_precomp = exp;
5768     RExC_flags = rx_flags;
5769     RExC_pm_flags = pm_flags;
5770
5771     if (runtime_code) {
5772         if (TAINTING_get && TAINT_get)
5773             Perl_croak(aTHX_ "Eval-group in insecure regular expression");
5774
5775         if (!S_compile_runtime_code(aTHX_ pRExC_state, exp, plen)) {
5776             /* whoops, we have a non-utf8 pattern, whilst run-time code
5777              * got compiled as utf8. Try again with a utf8 pattern */
5778             S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &exp, &plen,
5779                                     pRExC_state->num_code_blocks);
5780             goto redo_first_pass;
5781         }
5782     }
5783     assert(!pRExC_state->runtime_code_qr);
5784
5785     RExC_sawback = 0;
5786
5787     RExC_seen = 0;
5788     RExC_in_lookbehind = 0;
5789     RExC_seen_zerolen = *exp == '^' ? -1 : 0;
5790     RExC_extralen = 0;
5791     RExC_override_recoding = 0;
5792     RExC_in_multi_char_class = 0;
5793
5794     /* First pass: determine size, legality. */
5795     RExC_parse = exp;
5796     RExC_start = exp;
5797     RExC_end = exp + plen;
5798     RExC_naughty = 0;
5799     RExC_npar = 1;
5800     RExC_nestroot = 0;
5801     RExC_size = 0L;
5802     RExC_emit = &RExC_emit_dummy;
5803     RExC_whilem_seen = 0;
5804     RExC_open_parens = NULL;
5805     RExC_close_parens = NULL;
5806     RExC_opend = NULL;
5807     RExC_paren_names = NULL;
5808 #ifdef DEBUGGING
5809     RExC_paren_name_list = NULL;
5810 #endif
5811     RExC_recurse = NULL;
5812     RExC_recurse_count = 0;
5813     pRExC_state->code_index = 0;
5814
5815 #if 0 /* REGC() is (currently) a NOP at the first pass.
5816        * Clever compilers notice this and complain. --jhi */
5817     REGC((U8)REG_MAGIC, (char*)RExC_emit);
5818 #endif
5819     DEBUG_PARSE_r(
5820         PerlIO_printf(Perl_debug_log, "Starting first pass (sizing)\n");
5821         RExC_lastnum=0;
5822         RExC_lastparse=NULL;
5823     );
5824     /* reg may croak on us, not giving us a chance to free
5825        pRExC_state->code_blocks.  We cannot SAVEFREEPV it now, as we may
5826        need it to survive as long as the regexp (qr/(?{})/).
5827        We must check that code_blocksv is not already set, because we may
5828        have jumped back to restart the sizing pass. */
5829     if (pRExC_state->code_blocks && !code_blocksv) {
5830         code_blocksv = newSV_type(SVt_PV);
5831         SAVEFREESV(code_blocksv);
5832         SvPV_set(code_blocksv, (char *)pRExC_state->code_blocks);
5833         SvLEN_set(code_blocksv, 1); /*sufficient to make sv_clear free it*/
5834     }
5835     if (reg(pRExC_state, 0, &flags,1) == NULL) {
5836         /* It's possible to write a regexp in ascii that represents Unicode
5837         codepoints outside of the byte range, such as via \x{100}. If we
5838         detect such a sequence we have to convert the entire pattern to utf8
5839         and then recompile, as our sizing calculation will have been based
5840         on 1 byte == 1 character, but we will need to use utf8 to encode
5841         at least some part of the pattern, and therefore must convert the whole
5842         thing.
5843         -- dmq */
5844         if (flags & RESTART_UTF8) {
5845             S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &exp, &plen,
5846                                     pRExC_state->num_code_blocks);
5847             goto redo_first_pass;
5848         }
5849         Perl_croak(aTHX_ "panic: reg returned NULL to re_op_compile for sizing pass, flags=%#"UVxf"", (UV) flags);
5850     }
5851     if (code_blocksv)
5852         SvLEN_set(code_blocksv,0); /* no you can't have it, sv_clear */
5853
5854     DEBUG_PARSE_r({
5855         PerlIO_printf(Perl_debug_log, 
5856             "Required size %"IVdf" nodes\n"
5857             "Starting second pass (creation)\n", 
5858             (IV)RExC_size);
5859         RExC_lastnum=0; 
5860         RExC_lastparse=NULL; 
5861     });
5862
5863     /* The first pass could have found things that force Unicode semantics */
5864     if ((RExC_utf8 || RExC_uni_semantics)
5865          && get_regex_charset(rx_flags) == REGEX_DEPENDS_CHARSET)
5866     {
5867         set_regex_charset(&rx_flags, REGEX_UNICODE_CHARSET);
5868     }
5869
5870     /* Small enough for pointer-storage convention?
5871        If extralen==0, this means that we will not need long jumps. */
5872     if (RExC_size >= 0x10000L && RExC_extralen)
5873         RExC_size += RExC_extralen;
5874     else
5875         RExC_extralen = 0;
5876     if (RExC_whilem_seen > 15)
5877         RExC_whilem_seen = 15;
5878
5879     /* Allocate space and zero-initialize. Note, the two step process 
5880        of zeroing when in debug mode, thus anything assigned has to 
5881        happen after that */
5882     rx = (REGEXP*) newSV_type(SVt_REGEXP);
5883     r = ReANY(rx);
5884     Newxc(ri, sizeof(regexp_internal) + (unsigned)RExC_size * sizeof(regnode),
5885          char, regexp_internal);
5886     if ( r == NULL || ri == NULL )
5887         FAIL("Regexp out of space");
5888 #ifdef DEBUGGING
5889     /* avoid reading uninitialized memory in DEBUGGING code in study_chunk() */
5890     Zero(ri, sizeof(regexp_internal) + (unsigned)RExC_size * sizeof(regnode), char);
5891 #else 
5892     /* bulk initialize base fields with 0. */
5893     Zero(ri, sizeof(regexp_internal), char);        
5894 #endif
5895
5896     /* non-zero initialization begins here */
5897     RXi_SET( r, ri );
5898     r->engine= eng;
5899     r->extflags = rx_flags;
5900     RXp_COMPFLAGS(r) = orig_rx_flags & RXf_PMf_FLAGCOPYMASK;
5901
5902     if (pm_flags & PMf_IS_QR) {
5903         ri->code_blocks = pRExC_state->code_blocks;
5904         ri->num_code_blocks = pRExC_state->num_code_blocks;
5905     }
5906     else
5907     {
5908         int n;
5909         for (n = 0; n < pRExC_state->num_code_blocks; n++)
5910             if (pRExC_state->code_blocks[n].src_regex)
5911                 SAVEFREESV(pRExC_state->code_blocks[n].src_regex);
5912         SAVEFREEPV(pRExC_state->code_blocks);
5913     }
5914
5915     {
5916         bool has_p     = ((r->extflags & RXf_PMf_KEEPCOPY) == RXf_PMf_KEEPCOPY);
5917         bool has_charset = (get_regex_charset(r->extflags) != REGEX_DEPENDS_CHARSET);
5918
5919         /* The caret is output if there are any defaults: if not all the STD
5920          * flags are set, or if no character set specifier is needed */
5921         bool has_default =
5922                     (((r->extflags & RXf_PMf_STD_PMMOD) != RXf_PMf_STD_PMMOD)
5923                     || ! has_charset);
5924         bool has_runon = ((RExC_seen & REG_SEEN_RUN_ON_COMMENT)==REG_SEEN_RUN_ON_COMMENT);
5925         U16 reganch = (U16)((r->extflags & RXf_PMf_STD_PMMOD)
5926                             >> RXf_PMf_STD_PMMOD_SHIFT);
5927         const char *fptr = STD_PAT_MODS;        /*"msix"*/
5928         char *p;
5929         /* Allocate for the worst case, which is all the std flags are turned
5930          * on.  If more precision is desired, we could do a population count of
5931          * the flags set.  This could be done with a small lookup table, or by
5932          * shifting, masking and adding, or even, when available, assembly
5933          * language for a machine-language population count.
5934          * We never output a minus, as all those are defaults, so are
5935          * covered by the caret */
5936         const STRLEN wraplen = plen + has_p + has_runon
5937             + has_default       /* If needs a caret */
5938
5939                 /* If needs a character set specifier */
5940             + ((has_charset) ? MAX_CHARSET_NAME_LENGTH : 0)
5941             + (sizeof(STD_PAT_MODS) - 1)
5942             + (sizeof("(?:)") - 1);
5943
5944         Newx(p, wraplen + 1, char); /* +1 for the ending NUL */
5945         r->xpv_len_u.xpvlenu_pv = p;
5946         if (RExC_utf8)
5947             SvFLAGS(rx) |= SVf_UTF8;
5948         *p++='('; *p++='?';
5949
5950         /* If a default, cover it using the caret */
5951         if (has_default) {
5952             *p++= DEFAULT_PAT_MOD;
5953         }
5954         if (has_charset) {
5955             STRLEN len;
5956             const char* const name = get_regex_charset_name(r->extflags, &len);
5957             Copy(name, p, len, char);
5958             p += len;
5959         }
5960         if (has_p)
5961             *p++ = KEEPCOPY_PAT_MOD; /*'p'*/
5962         {
5963             char ch;
5964             while((ch = *fptr++)) {
5965                 if(reganch & 1)
5966                     *p++ = ch;
5967                 reganch >>= 1;
5968             }
5969         }
5970
5971         *p++ = ':';
5972         Copy(RExC_precomp, p, plen, char);
5973         assert ((RX_WRAPPED(rx) - p) < 16);
5974         r->pre_prefix = p - RX_WRAPPED(rx);
5975         p += plen;
5976         if (has_runon)
5977             *p++ = '\n';
5978         *p++ = ')';
5979         *p = 0;
5980         SvCUR_set(rx, p - RX_WRAPPED(rx));
5981     }
5982
5983     r->intflags = 0;
5984     r->nparens = RExC_npar - 1; /* set early to validate backrefs */
5985     
5986     if (RExC_seen & REG_SEEN_RECURSE) {
5987         Newxz(RExC_open_parens, RExC_npar,regnode *);
5988         SAVEFREEPV(RExC_open_parens);
5989         Newxz(RExC_close_parens,RExC_npar,regnode *);
5990         SAVEFREEPV(RExC_close_parens);
5991     }
5992
5993     /* Useful during FAIL. */
5994 #ifdef RE_TRACK_PATTERN_OFFSETS
5995     Newxz(ri->u.offsets, 2*RExC_size+1, U32); /* MJD 20001228 */
5996     DEBUG_OFFSETS_r(PerlIO_printf(Perl_debug_log,
5997                           "%s %"UVuf" bytes for offset annotations.\n",
5998                           ri->u.offsets ? "Got" : "Couldn't get",
5999                           (UV)((2*RExC_size+1) * sizeof(U32))));
6000 #endif
6001     SetProgLen(ri,RExC_size);
6002     RExC_rx_sv = rx;
6003     RExC_rx = r;
6004     RExC_rxi = ri;
6005
6006     /* Second pass: emit code. */
6007     RExC_flags = rx_flags;      /* don't let top level (?i) bleed */
6008     RExC_pm_flags = pm_flags;
6009     RExC_parse = exp;
6010     RExC_end = exp + plen;
6011     RExC_naughty = 0;
6012     RExC_npar = 1;
6013     RExC_emit_start = ri->program;
6014     RExC_emit = ri->program;
6015     RExC_emit_bound = ri->program + RExC_size + 1;
6016     pRExC_state->code_index = 0;
6017
6018     REGC((U8)REG_MAGIC, (char*) RExC_emit++);
6019     if (reg(pRExC_state, 0, &flags,1) == NULL) {
6020         ReREFCNT_dec(rx);   
6021         Perl_croak(aTHX_ "panic: reg returned NULL to re_op_compile for generation pass, flags=%#"UVxf"", (UV) flags);
6022     }
6023     /* XXXX To minimize changes to RE engine we always allocate
6024        3-units-long substrs field. */
6025     Newx(r->substrs, 1, struct reg_substr_data);
6026     if (RExC_recurse_count) {
6027         Newxz(RExC_recurse,RExC_recurse_count,regnode *);
6028         SAVEFREEPV(RExC_recurse);
6029     }
6030
6031 reStudy:
6032     r->minlen = minlen = sawlookahead = sawplus = sawopen = 0;
6033     Zero(r->substrs, 1, struct reg_substr_data);
6034
6035 #ifdef TRIE_STUDY_OPT
6036     if (!restudied) {
6037         StructCopy(&zero_scan_data, &data, scan_data_t);
6038         copyRExC_state = RExC_state;
6039     } else {
6040         U32 seen=RExC_seen;
6041         DEBUG_OPTIMISE_r(PerlIO_printf(Perl_debug_log,"Restudying\n"));
6042         
6043         RExC_state = copyRExC_state;
6044         if (seen & REG_TOP_LEVEL_BRANCHES) 
6045             RExC_seen |= REG_TOP_LEVEL_BRANCHES;
6046         else
6047             RExC_seen &= ~REG_TOP_LEVEL_BRANCHES;
6048         StructCopy(&zero_scan_data, &data, scan_data_t);
6049     }
6050 #else
6051     StructCopy(&zero_scan_data, &data, scan_data_t);
6052 #endif    
6053
6054     /* Dig out information for optimizations. */
6055     r->extflags = RExC_flags; /* was pm_op */
6056     /*dmq: removed as part of de-PMOP: pm->op_pmflags = RExC_flags; */
6057  
6058     if (UTF)
6059         SvUTF8_on(rx);  /* Unicode in it? */
6060     ri->regstclass = NULL;
6061     if (RExC_naughty >= 10)     /* Probably an expensive pattern. */
6062         r->intflags |= PREGf_NAUGHTY;
6063     scan = ri->program + 1;             /* First BRANCH. */
6064
6065     /* testing for BRANCH here tells us whether there is "must appear"
6066        data in the pattern. If there is then we can use it for optimisations */
6067     if (!(RExC_seen & REG_TOP_LEVEL_BRANCHES)) { /*  Only one top-level choice. */
6068         I32 fake;
6069         STRLEN longest_float_length, longest_fixed_length;
6070         struct regnode_charclass_class ch_class; /* pointed to by data */
6071         int stclass_flag;
6072         I32 last_close = 0; /* pointed to by data */
6073         regnode *first= scan;
6074         regnode *first_next= regnext(first);
6075         /*
6076          * Skip introductions and multiplicators >= 1
6077          * so that we can extract the 'meat' of the pattern that must 
6078          * match in the large if() sequence following.
6079          * NOTE that EXACT is NOT covered here, as it is normally
6080          * picked up by the optimiser separately. 
6081          *
6082          * This is unfortunate as the optimiser isnt handling lookahead
6083          * properly currently.
6084          *
6085          */
6086         while ((OP(first) == OPEN && (sawopen = 1)) ||
6087                /* An OR of *one* alternative - should not happen now. */
6088             (OP(first) == BRANCH && OP(first_next) != BRANCH) ||
6089             /* for now we can't handle lookbehind IFMATCH*/
6090             (OP(first) == IFMATCH && !first->flags && (sawlookahead = 1)) ||
6091             (OP(first) == PLUS) ||
6092             (OP(first) == MINMOD) ||
6093                /* An {n,m} with n>0 */
6094             (PL_regkind[OP(first)] == CURLY && ARG1(first) > 0) ||
6095             (OP(first) == NOTHING && PL_regkind[OP(first_next)] != END ))
6096         {
6097                 /* 
6098                  * the only op that could be a regnode is PLUS, all the rest
6099                  * will be regnode_1 or regnode_2.
6100                  *
6101                  */
6102                 if (OP(first) == PLUS)
6103                     sawplus = 1;
6104                 else
6105                     first += regarglen[OP(first)];
6106
6107                 first = NEXTOPER(first);
6108                 first_next= regnext(first);
6109         }
6110
6111         /* Starting-point info. */
6112       again:
6113         DEBUG_PEEP("first:",first,0);
6114         /* Ignore EXACT as we deal with it later. */
6115         if (PL_regkind[OP(first)] == EXACT) {
6116             if (OP(first) == EXACT)
6117                 NOOP;   /* Empty, get anchored substr later. */
6118             else
6119                 ri->regstclass = first;
6120         }
6121 #ifdef TRIE_STCLASS
6122         else if (PL_regkind[OP(first)] == TRIE &&
6123                 ((reg_trie_data *)ri->data->data[ ARG(first) ])->minlen>0) 
6124         {
6125             regnode *trie_op;
6126             /* this can happen only on restudy */
6127             if ( OP(first) == TRIE ) {
6128                 struct regnode_1 *trieop = (struct regnode_1 *)
6129                     PerlMemShared_calloc(1, sizeof(struct regnode_1));
6130                 StructCopy(first,trieop,struct regnode_1);
6131                 trie_op=(regnode *)trieop;
6132             } else {
6133                 struct regnode_charclass *trieop = (struct regnode_charclass *)
6134                     PerlMemShared_calloc(1, sizeof(struct regnode_charclass));
6135                 StructCopy(first,trieop,struct regnode_charclass);
6136                 trie_op=(regnode *)trieop;
6137             }
6138             OP(trie_op)+=2;
6139             make_trie_failtable(pRExC_state, (regnode *)first, trie_op, 0);
6140             ri->regstclass = trie_op;
6141         }
6142 #endif
6143         else if (REGNODE_SIMPLE(OP(first)))
6144             ri->regstclass = first;
6145         else if (PL_regkind[OP(first)] == BOUND ||
6146                  PL_regkind[OP(first)] == NBOUND)
6147             ri->regstclass = first;
6148         else if (PL_regkind[OP(first)] == BOL) {
6149             r->extflags |= (OP(first) == MBOL
6150                            ? RXf_ANCH_MBOL
6151                            : (OP(first) == SBOL
6152                               ? RXf_ANCH_SBOL
6153                               : RXf_ANCH_BOL));
6154             first = NEXTOPER(first);
6155             goto again;
6156         }
6157         else if (OP(first) == GPOS) {
6158             r->extflags |= RXf_ANCH_GPOS;
6159             first = NEXTOPER(first);
6160             goto again;
6161         }
6162         else if ((!sawopen || !RExC_sawback) &&
6163             (OP(first) == STAR &&
6164             PL_regkind[OP(NEXTOPER(first))] == REG_ANY) &&
6165             !(r->extflags & RXf_ANCH) && !pRExC_state->num_code_blocks)
6166         {
6167             /* turn .* into ^.* with an implied $*=1 */
6168             const int type =
6169                 (OP(NEXTOPER(first)) == REG_ANY)
6170                     ? RXf_ANCH_MBOL
6171                     : RXf_ANCH_SBOL;
6172             r->extflags |= type;
6173             r->intflags |= PREGf_IMPLICIT;
6174             first = NEXTOPER(first);
6175             goto again;
6176         }
6177         if (sawplus && !sawlookahead && (!sawopen || !RExC_sawback)
6178             && !pRExC_state->num_code_blocks) /* May examine pos and $& */
6179             /* x+ must match at the 1st pos of run of x's */
6180             r->intflags |= PREGf_SKIP;
6181
6182         /* Scan is after the zeroth branch, first is atomic matcher. */
6183 #ifdef TRIE_STUDY_OPT
6184         DEBUG_PARSE_r(
6185             if (!restudied)
6186                 PerlIO_printf(Perl_debug_log, "first at %"IVdf"\n",
6187                               (IV)(first - scan + 1))
6188         );
6189 #else
6190         DEBUG_PARSE_r(
6191             PerlIO_printf(Perl_debug_log, "first at %"IVdf"\n",
6192                 (IV)(first - scan + 1))
6193         );
6194 #endif
6195
6196
6197         /*
6198         * If there's something expensive in the r.e., find the
6199         * longest literal string that must appear and make it the
6200         * regmust.  Resolve ties in favor of later strings, since
6201         * the regstart check works with the beginning of the r.e.
6202         * and avoiding duplication strengthens checking.  Not a
6203         * strong reason, but sufficient in the absence of others.
6204         * [Now we resolve ties in favor of the earlier string if
6205         * it happens that c_offset_min has been invalidated, since the
6206         * earlier string may buy us something the later one won't.]
6207         */
6208
6209         data.longest_fixed = newSVpvs("");
6210         data.longest_float = newSVpvs("");
6211         data.last_found = newSVpvs("");
6212         data.longest = &(data.longest_fixed);
6213         ENTER_with_name("study_chunk");
6214         SAVEFREESV(data.longest_fixed);
6215         SAVEFREESV(data.longest_float);
6216         SAVEFREESV(data.last_found);
6217         first = scan;
6218         if (!ri->regstclass) {
6219             cl_init(pRExC_state, &ch_class);
6220             data.start_class = &ch_class;
6221             stclass_flag = SCF_DO_STCLASS_AND;
6222         } else                          /* XXXX Check for BOUND? */
6223             stclass_flag = 0;
6224         data.last_closep = &last_close;
6225         
6226         minlen = study_chunk(pRExC_state, &first, &minlen, &fake, scan + RExC_size, /* Up to end */
6227             &data, -1, NULL, NULL,
6228             SCF_DO_SUBSTR | SCF_WHILEM_VISITED_POS | stclass_flag
6229                           | (restudied ? SCF_TRIE_DOING_RESTUDY : 0),
6230             0);
6231
6232
6233         CHECK_RESTUDY_GOTO_butfirst(LEAVE_with_name("study_chunk"));
6234
6235
6236         if ( RExC_npar == 1 && data.longest == &(data.longest_fixed)
6237              && data.last_start_min == 0 && data.last_end > 0
6238              && !RExC_seen_zerolen
6239              && !(RExC_seen & REG_SEEN_VERBARG)
6240              && (!(RExC_seen & REG_SEEN_GPOS) || (r->extflags & RXf_ANCH_GPOS)))
6241             r->extflags |= RXf_CHECK_ALL;
6242         scan_commit(pRExC_state, &data,&minlen,0);
6243
6244         longest_float_length = CHR_SVLEN(data.longest_float);
6245
6246         if (! ((SvCUR(data.longest_fixed)  /* ok to leave SvCUR */
6247                    && data.offset_fixed == data.offset_float_min
6248                    && SvCUR(data.longest_fixed) == SvCUR(data.longest_float)))
6249             && S_setup_longest (aTHX_ pRExC_state,
6250                                     data.longest_float,
6251                                     &(r->float_utf8),
6252                                     &(r->float_substr),
6253                                     &(r->float_end_shift),
6254                                     data.lookbehind_float,
6255                                     data.offset_float_min,
6256                                     data.minlen_float,
6257                                     longest_float_length,
6258                                     cBOOL(data.flags & SF_FL_BEFORE_EOL),
6259                                     cBOOL(data.flags & SF_FL_BEFORE_MEOL)))
6260         {
6261             r->float_min_offset = data.offset_float_min - data.lookbehind_float;
6262             r->float_max_offset = data.offset_float_max;
6263             if (data.offset_float_max < I32_MAX) /* Don't offset infinity */
6264                 r->float_max_offset -= data.lookbehind_float;
6265             SvREFCNT_inc_simple_void_NN(data.longest_float);
6266         }
6267         else {
6268             r->float_substr = r->float_utf8 = NULL;
6269             longest_float_length = 0;
6270         }
6271
6272         longest_fixed_length = CHR_SVLEN(data.longest_fixed);
6273
6274         if (S_setup_longest (aTHX_ pRExC_state,
6275                                 data.longest_fixed,
6276                                 &(r->anchored_utf8),
6277                                 &(r->anchored_substr),
6278                                 &(r->anchored_end_shift),
6279                                 data.lookbehind_fixed,
6280                                 data.offset_fixed,
6281                                 data.minlen_fixed,
6282                                 longest_fixed_length,
6283                                 cBOOL(data.flags & SF_FIX_BEFORE_EOL),
6284                                 cBOOL(data.flags & SF_FIX_BEFORE_MEOL)))
6285         {
6286             r->anchored_offset = data.offset_fixed - data.lookbehind_fixed;
6287             SvREFCNT_inc_simple_void_NN(data.longest_fixed);
6288         }
6289         else {
6290             r->anchored_substr = r->anchored_utf8 = NULL;
6291             longest_fixed_length = 0;
6292         }
6293         LEAVE_with_name("study_chunk");
6294
6295         if (ri->regstclass
6296             && (OP(ri->regstclass) == REG_ANY || OP(ri->regstclass) == SANY))
6297             ri->regstclass = NULL;
6298
6299         if ((!(r->anchored_substr || r->anchored_utf8) || r->anchored_offset)
6300             && stclass_flag
6301             && ! TEST_SSC_EOS(data.start_class)
6302             && !cl_is_anything(data.start_class))
6303         {
6304             const U32 n = add_data(pRExC_state, 1, "f");
6305             OP(data.start_class) = ANYOF_SYNTHETIC;
6306
6307             Newx(RExC_rxi->data->data[n], 1,
6308                 struct regnode_charclass_class);
6309             StructCopy(data.start_class,
6310                        (struct regnode_charclass_class*)RExC_rxi->data->data[n],
6311                        struct regnode_charclass_class);
6312             ri->regstclass = (regnode*)RExC_rxi->data->data[n];
6313             r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
6314             DEBUG_COMPILE_r({ SV *sv = sv_newmortal();
6315                       regprop(r, sv, (regnode*)data.start_class);
6316                       PerlIO_printf(Perl_debug_log,
6317                                     "synthetic stclass \"%s\".\n",
6318                                     SvPVX_const(sv));});
6319         }
6320
6321         /* A temporary algorithm prefers floated substr to fixed one to dig more info. */
6322         if (longest_fixed_length > longest_float_length) {
6323             r->check_end_shift = r->anchored_end_shift;
6324             r->check_substr = r->anchored_substr;
6325             r->check_utf8 = r->anchored_utf8;
6326             r->check_offset_min = r->check_offset_max = r->anchored_offset;
6327             if (r->extflags & RXf_ANCH_SINGLE)
6328                 r->extflags |= RXf_NOSCAN;
6329         }
6330         else {
6331             r->check_end_shift = r->float_end_shift;
6332             r->check_substr = r->float_substr;
6333             r->check_utf8 = r->float_utf8;
6334             r->check_offset_min = r->float_min_offset;
6335             r->check_offset_max = r->float_max_offset;
6336         }
6337         /* XXXX Currently intuiting is not compatible with ANCH_GPOS.
6338            This should be changed ASAP!  */
6339         if ((r->check_substr || r->check_utf8) && !(r->extflags & RXf_ANCH_GPOS)) {
6340             r->extflags |= RXf_USE_INTUIT;
6341             if (SvTAIL(r->check_substr ? r->check_substr : r->check_utf8))
6342                 r->extflags |= RXf_INTUIT_TAIL;
6343         }
6344         /* XXX Unneeded? dmq (shouldn't as this is handled elsewhere)
6345         if ( (STRLEN)minlen < longest_float_length )
6346             minlen= longest_float_length;
6347         if ( (STRLEN)minlen < longest_fixed_length )
6348             minlen= longest_fixed_length;     
6349         */
6350     }
6351     else {
6352         /* Several toplevels. Best we can is to set minlen. */
6353         I32 fake;
6354         struct regnode_charclass_class ch_class;
6355         I32 last_close = 0;
6356
6357         DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log, "\nMulti Top Level\n"));
6358
6359         scan = ri->program + 1;
6360         cl_init(pRExC_state, &ch_class);
6361         data.start_class = &ch_class;
6362         data.last_closep = &last_close;
6363
6364         
6365         minlen = study_chunk(pRExC_state, &scan, &minlen, &fake, scan + RExC_size,
6366             &data, -1, NULL, NULL,
6367             SCF_DO_STCLASS_AND|SCF_WHILEM_VISITED_POS
6368                               |(restudied ? SCF_TRIE_DOING_RESTUDY : 0),
6369             0);
6370         
6371         CHECK_RESTUDY_GOTO_butfirst(NOOP);
6372
6373         r->check_substr = r->check_utf8 = r->anchored_substr = r->anchored_utf8
6374                 = r->float_substr = r->float_utf8 = NULL;
6375
6376         if (! TEST_SSC_EOS(data.start_class)
6377             && !cl_is_anything(data.start_class))
6378         {
6379             const U32 n = add_data(pRExC_state, 1, "f");
6380             OP(data.start_class) = ANYOF_SYNTHETIC;
6381
6382             Newx(RExC_rxi->data->data[n], 1,
6383                 struct regnode_charclass_class);
6384             StructCopy(data.start_class,
6385                        (struct regnode_charclass_class*)RExC_rxi->data->data[n],
6386                        struct regnode_charclass_class);
6387             ri->regstclass = (regnode*)RExC_rxi->data->data[n];
6388             r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
6389             DEBUG_COMPILE_r({ SV* sv = sv_newmortal();
6390                       regprop(r, sv, (regnode*)data.start_class);
6391                       PerlIO_printf(Perl_debug_log,
6392                                     "synthetic stclass \"%s\".\n",
6393                                     SvPVX_const(sv));});
6394         }
6395     }
6396
6397     /* Guard against an embedded (?=) or (?<=) with a longer minlen than
6398        the "real" pattern. */
6399     DEBUG_OPTIMISE_r({
6400         PerlIO_printf(Perl_debug_log,"minlen: %"IVdf" r->minlen:%"IVdf"\n",
6401                       (IV)minlen, (IV)r->minlen);
6402     });
6403     r->minlenret = minlen;
6404     if (r->minlen < minlen) 
6405         r->minlen = minlen;
6406     
6407     if (RExC_seen & REG_SEEN_GPOS)
6408         r->extflags |= RXf_GPOS_SEEN;
6409     if (RExC_seen & REG_SEEN_LOOKBEHIND)
6410         r->extflags |= RXf_NO_INPLACE_SUBST; /* inplace might break the lookbehind */
6411     if (pRExC_state->num_code_blocks)
6412         r->extflags |= RXf_EVAL_SEEN;
6413     if (RExC_seen & REG_SEEN_CANY)
6414         r->extflags |= RXf_CANY_SEEN;
6415     if (RExC_seen & REG_SEEN_VERBARG)
6416     {
6417         r->intflags |= PREGf_VERBARG_SEEN;
6418         r->extflags |= RXf_NO_INPLACE_SUBST; /* don't understand this! Yves */
6419     }
6420     if (RExC_seen & REG_SEEN_CUTGROUP)
6421         r->intflags |= PREGf_CUTGROUP_SEEN;
6422     if (pm_flags & PMf_USE_RE_EVAL)
6423         r->intflags |= PREGf_USE_RE_EVAL;
6424     if (RExC_paren_names)
6425         RXp_PAREN_NAMES(r) = MUTABLE_HV(SvREFCNT_inc(RExC_paren_names));
6426     else
6427         RXp_PAREN_NAMES(r) = NULL;
6428
6429     {
6430         regnode *first = ri->program + 1;
6431         U8 fop = OP(first);
6432         regnode *next = NEXTOPER(first);
6433         U8 nop = OP(next);
6434
6435         if (PL_regkind[fop] == NOTHING && nop == END)
6436             r->extflags |= RXf_NULL;
6437         else if (PL_regkind[fop] == BOL && nop == END)
6438             r->extflags |= RXf_START_ONLY;
6439         else if (fop == PLUS && PL_regkind[nop] == POSIXD && FLAGS(next) == _CC_SPACE && OP(regnext(first)) == END)
6440             r->extflags |= RXf_WHITE;
6441         else if ( r->extflags & RXf_SPLIT && fop == EXACT && STR_LEN(first) == 1 && *(STRING(first)) == ' ' && OP(regnext(first)) == END )
6442             r->extflags |= (RXf_SKIPWHITE|RXf_WHITE);
6443
6444     }
6445 #ifdef DEBUGGING
6446     if (RExC_paren_names) {
6447         ri->name_list_idx = add_data( pRExC_state, 1, "a" );
6448         ri->data->data[ri->name_list_idx] = (void*)SvREFCNT_inc(RExC_paren_name_list);
6449     } else
6450 #endif
6451         ri->name_list_idx = 0;
6452
6453     if (RExC_recurse_count) {
6454         for ( ; RExC_recurse_count ; RExC_recurse_count-- ) {
6455             const regnode *scan = RExC_recurse[RExC_recurse_count-1];
6456             ARG2L_SET( scan, RExC_open_parens[ARG(scan)-1] - scan );
6457         }
6458     }
6459     Newxz(r->offs, RExC_npar, regexp_paren_pair);
6460     /* assume we don't need to swap parens around before we match */
6461
6462     DEBUG_DUMP_r({
6463         PerlIO_printf(Perl_debug_log,"Final program:\n");
6464         regdump(r);
6465     });
6466 #ifdef RE_TRACK_PATTERN_OFFSETS
6467     DEBUG_OFFSETS_r(if (ri->u.offsets) {
6468         const U32 len = ri->u.offsets[0];
6469         U32 i;
6470         GET_RE_DEBUG_FLAGS_DECL;
6471         PerlIO_printf(Perl_debug_log, "Offsets: [%"UVuf"]\n\t", (UV)ri->u.offsets[0]);
6472         for (i = 1; i <= len; i++) {
6473             if (ri->u.offsets[i*2-1] || ri->u.offsets[i*2])
6474                 PerlIO_printf(Perl_debug_log, "%"UVuf":%"UVuf"[%"UVuf"] ",
6475                 (UV)i, (UV)ri->u.offsets[i*2-1], (UV)ri->u.offsets[i*2]);
6476             }
6477         PerlIO_printf(Perl_debug_log, "\n");
6478     });
6479 #endif
6480
6481 #ifdef USE_ITHREADS
6482     /* under ithreads the ?pat? PMf_USED flag on the pmop is simulated
6483      * by setting the regexp SV to readonly-only instead. If the
6484      * pattern's been recompiled, the USEDness should remain. */
6485     if (old_re && SvREADONLY(old_re))
6486         SvREADONLY_on(rx);
6487 #endif
6488     return rx;
6489 }
6490
6491
6492 SV*
6493 Perl_reg_named_buff(pTHX_ REGEXP * const rx, SV * const key, SV * const value,
6494                     const U32 flags)
6495 {
6496     PERL_ARGS_ASSERT_REG_NAMED_BUFF;
6497
6498     PERL_UNUSED_ARG(value);
6499
6500     if (flags & RXapif_FETCH) {
6501         return reg_named_buff_fetch(rx, key, flags);
6502     } else if (flags & (RXapif_STORE | RXapif_DELETE | RXapif_CLEAR)) {
6503         Perl_croak_no_modify();
6504         return NULL;
6505     } else if (flags & RXapif_EXISTS) {
6506         return reg_named_buff_exists(rx, key, flags)
6507             ? &PL_sv_yes
6508             : &PL_sv_no;
6509     } else if (flags & RXapif_REGNAMES) {
6510         return reg_named_buff_all(rx, flags);
6511     } else if (flags & (RXapif_SCALAR | RXapif_REGNAMES_COUNT)) {
6512         return reg_named_buff_scalar(rx, flags);
6513     } else {
6514         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff", (int)flags);
6515         return NULL;
6516     }
6517 }
6518
6519 SV*
6520 Perl_reg_named_buff_iter(pTHX_ REGEXP * const rx, const SV * const lastkey,
6521                          const U32 flags)
6522 {
6523     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ITER;
6524     PERL_UNUSED_ARG(lastkey);
6525
6526     if (flags & RXapif_FIRSTKEY)
6527         return reg_named_buff_firstkey(rx, flags);
6528     else if (flags & RXapif_NEXTKEY)
6529         return reg_named_buff_nextkey(rx, flags);
6530     else {
6531         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_iter", (int)flags);
6532         return NULL;
6533     }
6534 }
6535
6536 SV*
6537 Perl_reg_named_buff_fetch(pTHX_ REGEXP * const r, SV * const namesv,
6538                           const U32 flags)
6539 {
6540     AV *retarray = NULL;
6541     SV *ret;
6542     struct regexp *const rx = ReANY(r);
6543
6544     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FETCH;
6545
6546     if (flags & RXapif_ALL)
6547         retarray=newAV();
6548
6549     if (rx && RXp_PAREN_NAMES(rx)) {
6550         HE *he_str = hv_fetch_ent( RXp_PAREN_NAMES(rx), namesv, 0, 0 );
6551         if (he_str) {
6552             IV i;
6553             SV* sv_dat=HeVAL(he_str);
6554             I32 *nums=(I32*)SvPVX(sv_dat);
6555             for ( i=0; i<SvIVX(sv_dat); i++ ) {
6556                 if ((I32)(rx->nparens) >= nums[i]
6557                     && rx->offs[nums[i]].start != -1
6558                     && rx->offs[nums[i]].end != -1)
6559                 {
6560                     ret = newSVpvs("");
6561                     CALLREG_NUMBUF_FETCH(r,nums[i],ret);
6562                     if (!retarray)
6563                         return ret;
6564                 } else {
6565                     if (retarray)
6566                         ret = newSVsv(&PL_sv_undef);
6567                 }
6568                 if (retarray)
6569                     av_push(retarray, ret);
6570             }
6571             if (retarray)
6572                 return newRV_noinc(MUTABLE_SV(retarray));
6573         }
6574     }
6575     return NULL;
6576 }
6577
6578 bool
6579 Perl_reg_named_buff_exists(pTHX_ REGEXP * const r, SV * const key,
6580                            const U32 flags)
6581 {
6582     struct regexp *const rx = ReANY(r);
6583
6584     PERL_ARGS_ASSERT_REG_NAMED_BUFF_EXISTS;
6585
6586     if (rx && RXp_PAREN_NAMES(rx)) {
6587         if (flags & RXapif_ALL) {
6588             return hv_exists_ent(RXp_PAREN_NAMES(rx), key, 0);
6589         } else {
6590             SV *sv = CALLREG_NAMED_BUFF_FETCH(r, key, flags);
6591             if (sv) {
6592                 SvREFCNT_dec_NN(sv);
6593                 return TRUE;
6594             } else {
6595                 return FALSE;
6596             }
6597         }
6598     } else {
6599         return FALSE;
6600     }
6601 }
6602
6603 SV*
6604 Perl_reg_named_buff_firstkey(pTHX_ REGEXP * const r, const U32 flags)
6605 {
6606     struct regexp *const rx = ReANY(r);
6607
6608     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FIRSTKEY;
6609
6610     if ( rx && RXp_PAREN_NAMES(rx) ) {
6611         (void)hv_iterinit(RXp_PAREN_NAMES(rx));
6612
6613         return CALLREG_NAMED_BUFF_NEXTKEY(r, NULL, flags & ~RXapif_FIRSTKEY);
6614     } else {
6615         return FALSE;
6616     }
6617 }
6618
6619 SV*
6620 Perl_reg_named_buff_nextkey(pTHX_ REGEXP * const r, const U32 flags)
6621 {
6622     struct regexp *const rx = ReANY(r);
6623     GET_RE_DEBUG_FLAGS_DECL;
6624
6625     PERL_ARGS_ASSERT_REG_NAMED_BUFF_NEXTKEY;
6626
6627     if (rx && RXp_PAREN_NAMES(rx)) {
6628         HV *hv = RXp_PAREN_NAMES(rx);
6629         HE *temphe;
6630         while ( (temphe = hv_iternext_flags(hv,0)) ) {
6631             IV i;
6632             IV parno = 0;
6633             SV* sv_dat = HeVAL(temphe);
6634             I32 *nums = (I32*)SvPVX(sv_dat);
6635             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
6636                 if ((I32)(rx->lastparen) >= nums[i] &&
6637                     rx->offs[nums[i]].start != -1 &&
6638                     rx->offs[nums[i]].end != -1)
6639                 {
6640                     parno = nums[i];
6641                     break;
6642                 }
6643             }
6644             if (parno || flags & RXapif_ALL) {
6645                 return newSVhek(HeKEY_hek(temphe));
6646             }
6647         }
6648     }
6649     return NULL;
6650 }
6651
6652 SV*
6653 Perl_reg_named_buff_scalar(pTHX_ REGEXP * const r, const U32 flags)
6654 {
6655     SV *ret;
6656     AV *av;
6657     I32 length;
6658     struct regexp *const rx = ReANY(r);
6659
6660     PERL_ARGS_ASSERT_REG_NAMED_BUFF_SCALAR;
6661
6662     if (rx && RXp_PAREN_NAMES(rx)) {
6663         if (flags & (RXapif_ALL | RXapif_REGNAMES_COUNT)) {
6664             return newSViv(HvTOTALKEYS(RXp_PAREN_NAMES(rx)));
6665         } else if (flags & RXapif_ONE) {
6666             ret = CALLREG_NAMED_BUFF_ALL(r, (flags | RXapif_REGNAMES));
6667             av = MUTABLE_AV(SvRV(ret));
6668             length = av_len(av);
6669             SvREFCNT_dec_NN(ret);
6670             return newSViv(length + 1);
6671         } else {
6672             Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_scalar", (int)flags);
6673             return NULL;
6674         }
6675     }
6676     return &PL_sv_undef;
6677 }
6678
6679 SV*
6680 Perl_reg_named_buff_all(pTHX_ REGEXP * const r, const U32 flags)
6681 {
6682     struct regexp *const rx = ReANY(r);
6683     AV *av = newAV();
6684
6685     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ALL;
6686
6687     if (rx && RXp_PAREN_NAMES(rx)) {
6688         HV *hv= RXp_PAREN_NAMES(rx);
6689         HE *temphe;
6690         (void)hv_iterinit(hv);
6691         while ( (temphe = hv_iternext_flags(hv,0)) ) {
6692             IV i;
6693             IV parno = 0;
6694             SV* sv_dat = HeVAL(temphe);
6695             I32 *nums = (I32*)SvPVX(sv_dat);
6696             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
6697                 if ((I32)(rx->lastparen) >= nums[i] &&
6698                     rx->offs[nums[i]].start != -1 &&
6699                     rx->offs[nums[i]].end != -1)
6700                 {
6701                     parno = nums[i];
6702                     break;
6703                 }
6704             }
6705             if (parno || flags & RXapif_ALL) {
6706                 av_push(av, newSVhek(HeKEY_hek(temphe)));
6707             }
6708         }
6709     }
6710
6711     return newRV_noinc(MUTABLE_SV(av));
6712 }
6713
6714 void
6715 Perl_reg_numbered_buff_fetch(pTHX_ REGEXP * const r, const I32 paren,
6716                              SV * const sv)
6717 {
6718     struct regexp *const rx = ReANY(r);
6719     char *s = NULL;
6720     I32 i = 0;
6721     I32 s1, t1;
6722     I32 n = paren;
6723
6724     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_FETCH;
6725         
6726     if ( (    n == RX_BUFF_IDX_CARET_PREMATCH
6727            || n == RX_BUFF_IDX_CARET_FULLMATCH
6728            || n == RX_BUFF_IDX_CARET_POSTMATCH
6729          )
6730          && !(rx->extflags & RXf_PMf_KEEPCOPY)
6731     )
6732         goto ret_undef;
6733
6734     if (!rx->subbeg)
6735         goto ret_undef;
6736
6737     if (n == RX_BUFF_IDX_CARET_FULLMATCH)
6738         /* no need to distinguish between them any more */
6739         n = RX_BUFF_IDX_FULLMATCH;
6740
6741     if ((n == RX_BUFF_IDX_PREMATCH || n == RX_BUFF_IDX_CARET_PREMATCH)
6742         && rx->offs[0].start != -1)
6743     {
6744         /* $`, ${^PREMATCH} */
6745         i = rx->offs[0].start;
6746         s = rx->subbeg;
6747     }
6748     else 
6749     if ((n == RX_BUFF_IDX_POSTMATCH || n == RX_BUFF_IDX_CARET_POSTMATCH)
6750         && rx->offs[0].end != -1)
6751     {
6752         /* $', ${^POSTMATCH} */
6753         s = rx->subbeg - rx->suboffset + rx->offs[0].end;
6754         i = rx->sublen + rx->suboffset - rx->offs[0].end;
6755     } 
6756     else
6757     if ( 0 <= n && n <= (I32)rx->nparens &&
6758         (s1 = rx->offs[n].start) != -1 &&
6759         (t1 = rx->offs[n].end) != -1)
6760     {
6761         /* $&, ${^MATCH},  $1 ... */
6762         i = t1 - s1;
6763         s = rx->subbeg + s1 - rx->suboffset;
6764     } else {
6765         goto ret_undef;
6766     }          
6767
6768     assert(s >= rx->subbeg);
6769     assert(rx->sublen >= (s - rx->subbeg) + i );
6770     if (i >= 0) {
6771 #if NO_TAINT_SUPPORT
6772         sv_setpvn(sv, s, i);
6773 #else
6774         const int oldtainted = TAINT_get;
6775         TAINT_NOT;
6776         sv_setpvn(sv, s, i);
6777         TAINT_set(oldtainted);
6778 #endif
6779         if ( (rx->extflags & RXf_CANY_SEEN)
6780             ? (RXp_MATCH_UTF8(rx)
6781                         && (!i || is_utf8_string((U8*)s, i)))
6782             : (RXp_MATCH_UTF8(rx)) )
6783         {
6784             SvUTF8_on(sv);
6785         }
6786         else
6787             SvUTF8_off(sv);
6788         if (TAINTING_get) {
6789             if (RXp_MATCH_TAINTED(rx)) {
6790                 if (SvTYPE(sv) >= SVt_PVMG) {
6791                     MAGIC* const mg = SvMAGIC(sv);
6792                     MAGIC* mgt;
6793                     TAINT;
6794                     SvMAGIC_set(sv, mg->mg_moremagic);
6795                     SvTAINT(sv);
6796                     if ((mgt = SvMAGIC(sv))) {
6797                         mg->mg_moremagic = mgt;
6798                         SvMAGIC_set(sv, mg);
6799                     }
6800                 } else {
6801                     TAINT;
6802                     SvTAINT(sv);
6803                 }
6804             } else 
6805                 SvTAINTED_off(sv);
6806         }
6807     } else {
6808       ret_undef:
6809         sv_setsv(sv,&PL_sv_undef);
6810         return;
6811     }
6812 }
6813
6814 void
6815 Perl_reg_numbered_buff_store(pTHX_ REGEXP * const rx, const I32 paren,
6816                                                          SV const * const value)
6817 {
6818     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_STORE;
6819
6820     PERL_UNUSED_ARG(rx);
6821     PERL_UNUSED_ARG(paren);
6822     PERL_UNUSED_ARG(value);
6823
6824     if (!PL_localizing)
6825         Perl_croak_no_modify();
6826 }
6827
6828 I32
6829 Perl_reg_numbered_buff_length(pTHX_ REGEXP * const r, const SV * const sv,
6830                               const I32 paren)
6831 {
6832     struct regexp *const rx = ReANY(r);
6833     I32 i;
6834     I32 s1, t1;
6835
6836     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_LENGTH;
6837
6838     /* Some of this code was originally in C<Perl_magic_len> in F<mg.c> */
6839     switch (paren) {
6840       case RX_BUFF_IDX_CARET_PREMATCH: /* ${^PREMATCH} */
6841          if (!(rx->extflags & RXf_PMf_KEEPCOPY))
6842             goto warn_undef;
6843         /*FALLTHROUGH*/
6844
6845       case RX_BUFF_IDX_PREMATCH:       /* $` */
6846         if (rx->offs[0].start != -1) {
6847                         i = rx->offs[0].start;
6848                         if (i > 0) {
6849                                 s1 = 0;
6850                                 t1 = i;
6851                                 goto getlen;
6852                         }
6853             }
6854         return 0;
6855
6856       case RX_BUFF_IDX_CARET_POSTMATCH: /* ${^POSTMATCH} */
6857          if (!(rx->extflags & RXf_PMf_KEEPCOPY))
6858             goto warn_undef;
6859       case RX_BUFF_IDX_POSTMATCH:       /* $' */
6860             if (rx->offs[0].end != -1) {
6861                         i = rx->sublen - rx->offs[0].end;
6862                         if (i > 0) {
6863                                 s1 = rx->offs[0].end;
6864                                 t1 = rx->sublen;
6865                                 goto getlen;
6866                         }
6867             }
6868         return 0;
6869
6870       case RX_BUFF_IDX_CARET_FULLMATCH: /* ${^MATCH} */
6871          if (!(rx->extflags & RXf_PMf_KEEPCOPY))
6872             goto warn_undef;
6873         /*FALLTHROUGH*/
6874
6875       /* $& / ${^MATCH}, $1, $2, ... */
6876       default:
6877             if (paren <= (I32)rx->nparens &&
6878             (s1 = rx->offs[paren].start) != -1 &&
6879             (t1 = rx->offs[paren].end) != -1)
6880             {
6881             i = t1 - s1;
6882             goto getlen;
6883         } else {
6884           warn_undef:
6885             if (ckWARN(WARN_UNINITIALIZED))
6886                 report_uninit((const SV *)sv);
6887             return 0;
6888         }
6889     }
6890   getlen:
6891     if (i > 0 && RXp_MATCH_UTF8(rx)) {
6892         const char * const s = rx->subbeg - rx->suboffset + s1;
6893         const U8 *ep;
6894         STRLEN el;
6895
6896         i = t1 - s1;
6897         if (is_utf8_string_loclen((U8*)s, i, &ep, &el))
6898                         i = el;
6899     }
6900     return i;
6901 }
6902
6903 SV*
6904 Perl_reg_qr_package(pTHX_ REGEXP * const rx)
6905 {
6906     PERL_ARGS_ASSERT_REG_QR_PACKAGE;
6907         PERL_UNUSED_ARG(rx);
6908         if (0)
6909             return NULL;
6910         else
6911             return newSVpvs("Regexp");
6912 }
6913
6914 /* Scans the name of a named buffer from the pattern.
6915  * If flags is REG_RSN_RETURN_NULL returns null.
6916  * If flags is REG_RSN_RETURN_NAME returns an SV* containing the name
6917  * If flags is REG_RSN_RETURN_DATA returns the data SV* corresponding
6918  * to the parsed name as looked up in the RExC_paren_names hash.
6919  * If there is an error throws a vFAIL().. type exception.
6920  */
6921
6922 #define REG_RSN_RETURN_NULL    0
6923 #define REG_RSN_RETURN_NAME    1
6924 #define REG_RSN_RETURN_DATA    2
6925
6926 STATIC SV*
6927 S_reg_scan_name(pTHX_ RExC_state_t *pRExC_state, U32 flags)
6928 {
6929     char *name_start = RExC_parse;
6930
6931     PERL_ARGS_ASSERT_REG_SCAN_NAME;
6932
6933     if (isIDFIRST_lazy_if(RExC_parse, UTF)) {
6934          /* skip IDFIRST by using do...while */
6935         if (UTF)
6936             do {
6937                 RExC_parse += UTF8SKIP(RExC_parse);
6938             } while (isWORDCHAR_utf8((U8*)RExC_parse));
6939         else
6940             do {
6941                 RExC_parse++;
6942             } while (isWORDCHAR(*RExC_parse));
6943     } else {
6944         RExC_parse++; /* so the <- from the vFAIL is after the offending character */
6945         vFAIL("Group name must start with a non-digit word character");
6946     }
6947     if ( flags ) {
6948         SV* sv_name
6949             = newSVpvn_flags(name_start, (int)(RExC_parse - name_start),
6950                              SVs_TEMP | (UTF ? SVf_UTF8 : 0));
6951         if ( flags == REG_RSN_RETURN_NAME)
6952             return sv_name;
6953         else if (flags==REG_RSN_RETURN_DATA) {
6954             HE *he_str = NULL;
6955             SV *sv_dat = NULL;
6956             if ( ! sv_name )      /* should not happen*/
6957                 Perl_croak(aTHX_ "panic: no svname in reg_scan_name");
6958             if (RExC_paren_names)
6959                 he_str = hv_fetch_ent( RExC_paren_names, sv_name, 0, 0 );
6960             if ( he_str )
6961                 sv_dat = HeVAL(he_str);
6962             if ( ! sv_dat )
6963                 vFAIL("Reference to nonexistent named group");
6964             return sv_dat;
6965         }
6966         else {
6967             Perl_croak(aTHX_ "panic: bad flag %lx in reg_scan_name",
6968                        (unsigned long) flags);
6969         }
6970         assert(0); /* NOT REACHED */
6971     }
6972     return NULL;
6973 }
6974
6975 #define DEBUG_PARSE_MSG(funcname)     DEBUG_PARSE_r({           \
6976     int rem=(int)(RExC_end - RExC_parse);                       \
6977     int cut;                                                    \
6978     int num;                                                    \
6979     int iscut=0;                                                \
6980     if (rem>10) {                                               \
6981         rem=10;                                                 \
6982         iscut=1;                                                \
6983     }                                                           \
6984     cut=10-rem;                                                 \
6985     if (RExC_lastparse!=RExC_parse)                             \
6986         PerlIO_printf(Perl_debug_log," >%.*s%-*s",              \
6987             rem, RExC_parse,                                    \
6988             cut + 4,                                            \
6989             iscut ? "..." : "<"                                 \
6990         );                                                      \
6991     else                                                        \
6992         PerlIO_printf(Perl_debug_log,"%16s","");                \
6993                                                                 \
6994     if (SIZE_ONLY)                                              \
6995        num = RExC_size + 1;                                     \
6996     else                                                        \
6997        num=REG_NODE_NUM(RExC_emit);                             \
6998     if (RExC_lastnum!=num)                                      \
6999        PerlIO_printf(Perl_debug_log,"|%4d",num);                \
7000     else                                                        \
7001        PerlIO_printf(Perl_debug_log,"|%4s","");                 \
7002     PerlIO_printf(Perl_debug_log,"|%*s%-4s",                    \
7003         (int)((depth*2)), "",                                   \
7004         (funcname)                                              \
7005     );                                                          \
7006     RExC_lastnum=num;                                           \
7007     RExC_lastparse=RExC_parse;                                  \
7008 })
7009
7010
7011
7012 #define DEBUG_PARSE(funcname)     DEBUG_PARSE_r({           \
7013     DEBUG_PARSE_MSG((funcname));                            \
7014     PerlIO_printf(Perl_debug_log,"%4s","\n");               \
7015 })
7016 #define DEBUG_PARSE_FMT(funcname,fmt,args)     DEBUG_PARSE_r({           \
7017     DEBUG_PARSE_MSG((funcname));                            \
7018     PerlIO_printf(Perl_debug_log,fmt "\n",args);               \
7019 })
7020
7021 /* This section of code defines the inversion list object and its methods.  The
7022  * interfaces are highly subject to change, so as much as possible is static to
7023  * this file.  An inversion list is here implemented as a malloc'd C UV array
7024  * with some added info that is placed as UVs at the beginning in a header
7025  * portion.  An inversion list for Unicode is an array of code points, sorted
7026  * by ordinal number.  The zeroth element is the first code point in the list.
7027  * The 1th element is the first element beyond that not in the list.  In other
7028  * words, the first range is
7029  *  invlist[0]..(invlist[1]-1)
7030  * The other ranges follow.  Thus every element whose index is divisible by two
7031  * marks the beginning of a range that is in the list, and every element not
7032  * divisible by two marks the beginning of a range not in the list.  A single
7033  * element inversion list that contains the single code point N generally
7034  * consists of two elements
7035  *  invlist[0] == N
7036  *  invlist[1] == N+1
7037  * (The exception is when N is the highest representable value on the
7038  * machine, in which case the list containing just it would be a single
7039  * element, itself.  By extension, if the last range in the list extends to
7040  * infinity, then the first element of that range will be in the inversion list
7041  * at a position that is divisible by two, and is the final element in the
7042  * list.)
7043  * Taking the complement (inverting) an inversion list is quite simple, if the
7044  * first element is 0, remove it; otherwise add a 0 element at the beginning.
7045  * This implementation reserves an element at the beginning of each inversion
7046  * list to contain 0 when the list contains 0, and contains 1 otherwise.  The
7047  * actual beginning of the list is either that element if 0, or the next one if
7048  * 1.
7049  *
7050  * More about inversion lists can be found in "Unicode Demystified"
7051  * Chapter 13 by Richard Gillam, published by Addison-Wesley.
7052  * More will be coming when functionality is added later.
7053  *
7054  * The inversion list data structure is currently implemented as an SV pointing
7055  * to an array of UVs that the SV thinks are bytes.  This allows us to have an
7056  * array of UV whose memory management is automatically handled by the existing
7057  * facilities for SV's.
7058  *
7059  * Some of the methods should always be private to the implementation, and some
7060  * should eventually be made public */
7061
7062 /* The header definitions are in F<inline_invlist.c> */
7063 #define TO_INTERNAL_SIZE(x) (((x) + HEADER_LENGTH) * sizeof(UV))
7064 #define FROM_INTERNAL_SIZE(x) (((x)/ sizeof(UV)) - HEADER_LENGTH)
7065
7066 #define INVLIST_INITIAL_LEN 10
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
7074      * in it or not.  The other parameter tells it whether the code that
7075      * follows this call is about to put a 0 in the inversion list or not.
7076      * The first element is either the element with 0, if 0, or the next one,
7077      * if 1 */
7078
7079     UV* zero = get_invlist_zero_addr(invlist);
7080
7081     PERL_ARGS_ASSERT__INVLIST_ARRAY_INIT;
7082
7083     /* Must be empty */
7084     assert(! *_get_invlist_len_addr(invlist));
7085
7086     /* 1^1 = 0; 1^0 = 1 */
7087     *zero = 1 ^ will_have_0;
7088     return zero + *zero;
7089 }
7090
7091 PERL_STATIC_INLINE UV*
7092 S_invlist_array(pTHX_ SV* const invlist)
7093 {
7094     /* Returns the pointer to the inversion list's array.  Every time the
7095      * length changes, this needs to be called in case malloc or realloc moved
7096      * it */
7097
7098     PERL_ARGS_ASSERT_INVLIST_ARRAY;
7099
7100     /* Must not be empty.  If these fail, you probably didn't check for <len>
7101      * being non-zero before trying to get the array */
7102     assert(*_get_invlist_len_addr(invlist));
7103     assert(*get_invlist_zero_addr(invlist) == 0
7104            || *get_invlist_zero_addr(invlist) == 1);
7105
7106     /* The array begins either at the element reserved for zero if the
7107      * list contains 0 (that element will be set to 0), or otherwise the next
7108      * element (in which case the reserved element will be set to 1). */
7109     return (UV *) (get_invlist_zero_addr(invlist)
7110                    + *get_invlist_zero_addr(invlist));
7111 }
7112
7113 PERL_STATIC_INLINE void
7114 S_invlist_set_len(pTHX_ SV* const invlist, const UV len)
7115 {
7116     /* Sets the current number of elements stored in the inversion list */
7117
7118     PERL_ARGS_ASSERT_INVLIST_SET_LEN;
7119
7120     *_get_invlist_len_addr(invlist) = len;
7121
7122     assert(len <= SvLEN(invlist));
7123
7124     SvCUR_set(invlist, TO_INTERNAL_SIZE(len));
7125     /* If the list contains U+0000, that element is part of the header,
7126      * and should not be counted as part of the array.  It will contain
7127      * 0 in that case, and 1 otherwise.  So we could flop 0=>1, 1=>0 and
7128      * subtract:
7129      *  SvCUR_set(invlist,
7130      *            TO_INTERNAL_SIZE(len
7131      *                             - (*get_invlist_zero_addr(inv_list) ^ 1)));
7132      * But, this is only valid if len is not 0.  The consequences of not doing
7133      * this is that the memory allocation code may think that 1 more UV is
7134      * being used than actually is, and so might do an unnecessary grow.  That
7135      * seems worth not bothering to make this the precise amount.
7136      *
7137      * Note that when inverting, SvCUR shouldn't change */
7138 }
7139
7140 PERL_STATIC_INLINE IV*
7141 S_get_invlist_previous_index_addr(pTHX_ SV* invlist)
7142 {
7143     /* Return the address of the UV that is reserved to hold the cached index
7144      * */
7145
7146     PERL_ARGS_ASSERT_GET_INVLIST_PREVIOUS_INDEX_ADDR;
7147
7148     return (IV *) (SvPVX(invlist) + (INVLIST_PREVIOUS_INDEX_OFFSET * sizeof (UV)));
7149 }
7150
7151 PERL_STATIC_INLINE IV
7152 S_invlist_previous_index(pTHX_ SV* const invlist)
7153 {
7154     /* Returns cached index of previous search */
7155
7156     PERL_ARGS_ASSERT_INVLIST_PREVIOUS_INDEX;
7157
7158     return *get_invlist_previous_index_addr(invlist);
7159 }
7160
7161 PERL_STATIC_INLINE void
7162 S_invlist_set_previous_index(pTHX_ SV* const invlist, const IV index)
7163 {
7164     /* Caches <index> for later retrieval */
7165
7166     PERL_ARGS_ASSERT_INVLIST_SET_PREVIOUS_INDEX;
7167
7168     assert(index == 0 || index < (int) _invlist_len(invlist));
7169
7170     *get_invlist_previous_index_addr(invlist) = index;
7171 }
7172
7173 PERL_STATIC_INLINE UV
7174 S_invlist_max(pTHX_ SV* const invlist)
7175 {
7176     /* Returns the maximum number of elements storable in the inversion list's
7177      * array, without having to realloc() */
7178
7179     PERL_ARGS_ASSERT_INVLIST_MAX;
7180
7181     return SvLEN(invlist) == 0  /* This happens under _new_invlist_C_array */
7182            ? _invlist_len(invlist)
7183            : FROM_INTERNAL_SIZE(SvLEN(invlist));
7184 }
7185
7186 PERL_STATIC_INLINE UV*
7187 S_get_invlist_zero_addr(pTHX_ SV* invlist)
7188 {
7189     /* Return the address of the UV that is reserved to hold 0 if the inversion
7190      * list contains 0.  This has to be the last element of the heading, as the
7191      * list proper starts with either it if 0, or the next element if not.
7192      * (But we force it to contain either 0 or 1) */
7193
7194     PERL_ARGS_ASSERT_GET_INVLIST_ZERO_ADDR;
7195
7196     return (UV *) (SvPVX(invlist) + (INVLIST_ZERO_OFFSET * sizeof (UV)));
7197 }
7198
7199 #ifndef PERL_IN_XSUB_RE
7200 SV*
7201 Perl__new_invlist(pTHX_ IV initial_size)
7202 {
7203
7204     /* Return a pointer to a newly constructed inversion list, with enough
7205      * space to store 'initial_size' elements.  If that number is negative, a
7206      * system default is used instead */
7207
7208     SV* new_list;
7209
7210     if (initial_size < 0) {
7211         initial_size = INVLIST_INITIAL_LEN;
7212     }
7213
7214     /* Allocate the initial space */
7215     new_list = newSV(TO_INTERNAL_SIZE(initial_size));
7216     invlist_set_len(new_list, 0);
7217
7218     /* Force iterinit() to be used to get iteration to work */
7219     *get_invlist_iter_addr(new_list) = UV_MAX;
7220
7221     /* This should force a segfault if a method doesn't initialize this
7222      * properly */
7223     *get_invlist_zero_addr(new_list) = UV_MAX;
7224
7225     *get_invlist_previous_index_addr(new_list) = 0;
7226     *get_invlist_version_id_addr(new_list) = INVLIST_VERSION_ID;
7227 #if HEADER_LENGTH != 5
7228 #   error Need to regenerate INVLIST_VERSION_ID by running perl -E 'say int(rand 2**31-1)', and then changing the #if to the new length
7229 #endif
7230
7231     return new_list;
7232 }
7233 #endif
7234
7235 STATIC SV*
7236 S__new_invlist_C_array(pTHX_ UV* list)
7237 {
7238     /* Return a pointer to a newly constructed inversion list, initialized to
7239      * point to <list>, which has to be in the exact correct inversion list
7240      * form, including internal fields.  Thus this is a dangerous routine that
7241      * should not be used in the wrong hands */
7242
7243     SV* invlist = newSV_type(SVt_PV);
7244
7245     PERL_ARGS_ASSERT__NEW_INVLIST_C_ARRAY;
7246
7247     SvPV_set(invlist, (char *) list);
7248     SvLEN_set(invlist, 0);  /* Means we own the contents, and the system
7249                                shouldn't touch it */
7250     SvCUR_set(invlist, TO_INTERNAL_SIZE(_invlist_len(invlist)));
7251
7252     if (*get_invlist_version_id_addr(invlist) != INVLIST_VERSION_ID) {
7253         Perl_croak(aTHX_ "panic: Incorrect version for previously generated inversion list");
7254     }
7255
7256     /* Initialize the iteration pointer.
7257      * XXX This could be done at compile time in charclass_invlists.h, but I
7258      * (khw) am not confident that the suffixes for specifying the C constant
7259      * UV_MAX are portable, e.g.  'ull' on a 32 bit machine that is configured
7260      * to use 64 bits; might need a Configure probe */
7261     invlist_iterfinish(invlist);
7262
7263     return invlist;
7264 }
7265
7266 STATIC void
7267 S_invlist_extend(pTHX_ SV* const invlist, const UV new_max)
7268 {
7269     /* Grow the maximum size of an inversion list */
7270
7271     PERL_ARGS_ASSERT_INVLIST_EXTEND;
7272
7273     SvGROW((SV *)invlist, TO_INTERNAL_SIZE(new_max));
7274 }
7275
7276 PERL_STATIC_INLINE void
7277 S_invlist_trim(pTHX_ SV* const invlist)
7278 {
7279     PERL_ARGS_ASSERT_INVLIST_TRIM;
7280
7281     /* Change the length of the inversion list to how many entries it currently
7282      * has */
7283
7284     SvPV_shrink_to_cur((SV *) invlist);
7285 }
7286
7287 #define _invlist_union_complement_2nd(a, b, output) _invlist_union_maybe_complement_2nd(a, b, TRUE, output)
7288
7289 STATIC void
7290 S__append_range_to_invlist(pTHX_ SV* const invlist, const UV start, const UV end)
7291 {
7292    /* Subject to change or removal.  Append the range from 'start' to 'end' at
7293     * the end of the inversion list.  The range must be above any existing
7294     * ones. */
7295
7296     UV* array;
7297     UV max = invlist_max(invlist);
7298     UV len = _invlist_len(invlist);
7299
7300     PERL_ARGS_ASSERT__APPEND_RANGE_TO_INVLIST;
7301
7302     if (len == 0) { /* Empty lists must be initialized */
7303         array = _invlist_array_init(invlist, start == 0);
7304     }
7305     else {
7306         /* Here, the existing list is non-empty. The current max entry in the
7307          * list is generally the first value not in the set, except when the
7308          * set extends to the end of permissible values, in which case it is
7309          * the first entry in that final set, and so this call is an attempt to
7310          * append out-of-order */
7311
7312         UV final_element = len - 1;
7313         array = invlist_array(invlist);
7314         if (array[final_element] > start
7315             || ELEMENT_RANGE_MATCHES_INVLIST(final_element))
7316         {
7317             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",
7318                        array[final_element], start,
7319                        ELEMENT_RANGE_MATCHES_INVLIST(final_element) ? 't' : 'f');
7320         }
7321
7322         /* Here, it is a legal append.  If the new range begins with the first
7323          * value not in the set, it is extending the set, so the new first
7324          * value not in the set is one greater than the newly extended range.
7325          * */
7326         if (array[final_element] == start) {
7327             if (end != UV_MAX) {
7328                 array[final_element] = end + 1;
7329             }
7330             else {
7331                 /* But if the end is the maximum representable on the machine,
7332                  * just let the range that this would extend to have no end */
7333                 invlist_set_len(invlist, len - 1);
7334             }
7335             return;
7336         }
7337     }
7338
7339     /* Here the new range doesn't extend any existing set.  Add it */
7340
7341     len += 2;   /* Includes an element each for the start and end of range */
7342
7343     /* If overflows the existing space, extend, which may cause the array to be
7344      * moved */
7345     if (max < len) {
7346         invlist_extend(invlist, len);
7347         invlist_set_len(invlist, len);  /* Have to set len here to avoid assert
7348                                            failure in invlist_array() */
7349         array = invlist_array(invlist);
7350     }
7351     else {
7352         invlist_set_len(invlist, len);
7353     }
7354
7355     /* The next item on the list starts the range, the one after that is
7356      * one past the new range.  */
7357     array[len - 2] = start;
7358     if (end != UV_MAX) {
7359         array[len - 1] = end + 1;
7360     }
7361     else {
7362         /* But if the end is the maximum representable on the machine, just let
7363          * the range have no end */
7364         invlist_set_len(invlist, len - 1);
7365     }
7366 }
7367
7368 #ifndef PERL_IN_XSUB_RE
7369
7370 IV
7371 Perl__invlist_search(pTHX_ SV* const invlist, const UV cp)
7372 {
7373     /* Searches the inversion list for the entry that contains the input code
7374      * point <cp>.  If <cp> is not in the list, -1 is returned.  Otherwise, the
7375      * return value is the index into the list's array of the range that
7376      * contains <cp> */
7377
7378     IV low = 0;
7379     IV mid;
7380     IV high = _invlist_len(invlist);
7381     const IV highest_element = high - 1;
7382     const UV* array;
7383
7384     PERL_ARGS_ASSERT__INVLIST_SEARCH;
7385
7386     /* If list is empty, return failure. */
7387     if (high == 0) {
7388         return -1;
7389     }
7390
7391     /* (We can't get the array unless we know the list is non-empty) */
7392     array = invlist_array(invlist);
7393
7394     mid = invlist_previous_index(invlist);
7395     assert(mid >=0 && mid <= highest_element);
7396
7397     /* <mid> contains the cache of the result of the previous call to this
7398      * function (0 the first time).  See if this call is for the same result,
7399      * or if it is for mid-1.  This is under the theory that calls to this
7400      * function will often be for related code points that are near each other.
7401      * And benchmarks show that caching gives better results.  We also test
7402      * here if the code point is within the bounds of the list.  These tests
7403      * replace others that would have had to be made anyway to make sure that
7404      * the array bounds were not exceeded, and these give us extra information
7405      * at the same time */
7406     if (cp >= array[mid]) {
7407         if (cp >= array[highest_element]) {
7408             return highest_element;
7409         }
7410
7411         /* Here, array[mid] <= cp < array[highest_element].  This means that
7412          * the final element is not the answer, so can exclude it; it also
7413          * means that <mid> is not the final element, so can refer to 'mid + 1'
7414          * safely */
7415         if (cp < array[mid + 1]) {
7416             return mid;
7417         }
7418         high--;
7419         low = mid + 1;
7420     }
7421     else { /* cp < aray[mid] */
7422         if (cp < array[0]) { /* Fail if outside the array */
7423             return -1;
7424         }
7425         high = mid;
7426         if (cp >= array[mid - 1]) {
7427             goto found_entry;
7428         }
7429     }
7430
7431     /* Binary search.  What we are looking for is <i> such that
7432      *  array[i] <= cp < array[i+1]
7433      * The loop below converges on the i+1.  Note that there may not be an
7434      * (i+1)th element in the array, and things work nonetheless */
7435     while (low < high) {
7436         mid = (low + high) / 2;
7437         assert(mid <= highest_element);
7438         if (array[mid] <= cp) { /* cp >= array[mid] */
7439             low = mid + 1;
7440
7441             /* We could do this extra test to exit the loop early.
7442             if (cp < array[low]) {
7443                 return mid;
7444             }
7445             */
7446         }
7447         else { /* cp < array[mid] */
7448             high = mid;
7449         }
7450     }
7451
7452   found_entry:
7453     high--;
7454     invlist_set_previous_index(invlist, high);
7455     return high;
7456 }
7457
7458 void
7459 Perl__invlist_populate_swatch(pTHX_ SV* const invlist, const UV start, const UV end, U8* swatch)
7460 {
7461     /* populates a swatch of a swash the same way swatch_get() does in utf8.c,
7462      * but is used when the swash has an inversion list.  This makes this much
7463      * faster, as it uses a binary search instead of a linear one.  This is
7464      * intimately tied to that function, and perhaps should be in utf8.c,
7465      * except it is intimately tied to inversion lists as well.  It assumes
7466      * that <swatch> is all 0's on input */
7467
7468     UV current = start;
7469     const IV len = _invlist_len(invlist);
7470     IV i;
7471     const UV * array;
7472
7473     PERL_ARGS_ASSERT__INVLIST_POPULATE_SWATCH;
7474
7475     if (len == 0) { /* Empty inversion list */
7476         return;
7477     }
7478
7479     array = invlist_array(invlist);
7480
7481     /* Find which element it is */
7482     i = _invlist_search(invlist, start);
7483
7484     /* We populate from <start> to <end> */
7485     while (current < end) {
7486         UV upper;
7487
7488         /* The inversion list gives the results for every possible code point
7489          * after the first one in the list.  Only those ranges whose index is
7490          * even are ones that the inversion list matches.  For the odd ones,
7491          * and if the initial code point is not in the list, we have to skip
7492          * forward to the next element */
7493         if (i == -1 || ! ELEMENT_RANGE_MATCHES_INVLIST(i)) {
7494             i++;
7495             if (i >= len) { /* Finished if beyond the end of the array */
7496                 return;
7497             }
7498             current = array[i];
7499             if (current >= end) {   /* Finished if beyond the end of what we
7500                                        are populating */
7501                 if (LIKELY(end < UV_MAX)) {
7502                     return;
7503                 }
7504
7505                 /* We get here when the upper bound is the maximum
7506                  * representable on the machine, and we are looking for just
7507                  * that code point.  Have to special case it */
7508                 i = len;
7509                 goto join_end_of_list;
7510             }
7511         }
7512         assert(current >= start);
7513
7514         /* The current range ends one below the next one, except don't go past
7515          * <end> */
7516         i++;
7517         upper = (i < len && array[i] < end) ? array[i] : end;
7518
7519         /* Here we are in a range that matches.  Populate a bit in the 3-bit U8
7520          * for each code point in it */
7521         for (; current < upper; current++) {
7522             const STRLEN offset = (STRLEN)(current - start);
7523             swatch[offset >> 3] |= 1 << (offset & 7);
7524         }
7525
7526     join_end_of_list:
7527
7528         /* Quit if at the end of the list */
7529         if (i >= len) {
7530
7531             /* But first, have to deal with the highest possible code point on
7532              * the platform.  The previous code assumes that <end> is one
7533              * beyond where we want to populate, but that is impossible at the
7534              * platform's infinity, so have to handle it specially */
7535             if (UNLIKELY(end == UV_MAX && ELEMENT_RANGE_MATCHES_INVLIST(len-1)))
7536             {
7537                 const STRLEN offset = (STRLEN)(end - start);
7538                 swatch[offset >> 3] |= 1 << (offset & 7);
7539             }
7540             return;
7541         }
7542
7543         /* Advance to the next range, which will be for code points not in the
7544          * inversion list */
7545         current = array[i];
7546     }
7547
7548     return;
7549 }
7550
7551 void
7552 Perl__invlist_union_maybe_complement_2nd(pTHX_ SV* const a, SV* const b, bool complement_b, SV** output)
7553 {
7554     /* Take the union of two inversion lists and point <output> to it.  *output
7555      * SHOULD BE DEFINED upon input, and if it points to one of the two lists,
7556      * the reference count to that list will be decremented.  The first list,
7557      * <a>, may be NULL, in which case a copy of the second list is returned.
7558      * If <complement_b> is TRUE, the union is taken of the complement
7559      * (inversion) of <b> instead of b itself.
7560      *
7561      * The basis for this comes from "Unicode Demystified" Chapter 13 by
7562      * Richard Gillam, published by Addison-Wesley, and explained at some
7563      * length there.  The preface says to incorporate its examples into your
7564      * code at your own risk.
7565      *
7566      * The algorithm is like a merge sort.
7567      *
7568      * XXX A potential performance improvement is to keep track as we go along
7569      * if only one of the inputs contributes to the result, meaning the other
7570      * is a subset of that one.  In that case, we can skip the final copy and
7571      * return the larger of the input lists, but then outside code might need
7572      * to keep track of whether to free the input list or not */
7573
7574     UV* array_a;    /* a's array */
7575     UV* array_b;
7576     UV len_a;       /* length of a's array */
7577     UV len_b;
7578
7579     SV* u;                      /* the resulting union */
7580     UV* array_u;
7581     UV len_u;
7582
7583     UV i_a = 0;             /* current index into a's array */
7584     UV i_b = 0;
7585     UV i_u = 0;
7586
7587     /* running count, as explained in the algorithm source book; items are
7588      * stopped accumulating and are output when the count changes to/from 0.
7589      * The count is incremented when we start a range that's in the set, and
7590      * decremented when we start a range that's not in the set.  So its range
7591      * is 0 to 2.  Only when the count is zero is something not in the set.
7592      */
7593     UV count = 0;
7594
7595     PERL_ARGS_ASSERT__INVLIST_UNION_MAYBE_COMPLEMENT_2ND;
7596     assert(a != b);
7597
7598     /* If either one is empty, the union is the other one */
7599     if (a == NULL || ((len_a = _invlist_len(a)) == 0)) {
7600         if (*output == a) {
7601             if (a != NULL) {
7602                 SvREFCNT_dec_NN(a);
7603             }
7604         }
7605         if (*output != b) {
7606             *output = invlist_clone(b);
7607             if (complement_b) {
7608                 _invlist_invert(*output);
7609             }
7610         } /* else *output already = b; */
7611         return;
7612     }
7613     else if ((len_b = _invlist_len(b)) == 0) {
7614         if (*output == b) {
7615             SvREFCNT_dec_NN(b);
7616         }
7617
7618         /* The complement of an empty list is a list that has everything in it,
7619          * so the union with <a> includes everything too */
7620         if (complement_b) {
7621             if (a == *output) {
7622                 SvREFCNT_dec_NN(a);
7623             }
7624             *output = _new_invlist(1);
7625             _append_range_to_invlist(*output, 0, UV_MAX);
7626         }
7627         else if (*output != a) {
7628             *output = invlist_clone(a);
7629         }
7630         /* else *output already = a; */
7631         return;
7632     }
7633
7634     /* Here both lists exist and are non-empty */
7635     array_a = invlist_array(a);
7636     array_b = invlist_array(b);
7637
7638     /* If are to take the union of 'a' with the complement of b, set it
7639      * up so are looking at b's complement. */
7640     if (complement_b) {
7641
7642         /* To complement, we invert: if the first element is 0, remove it.  To
7643          * do this, we just pretend the array starts one later, and clear the
7644          * flag as we don't have to do anything else later */
7645         if (array_b[0] == 0) {
7646             array_b++;
7647             len_b--;
7648             complement_b = FALSE;
7649         }
7650         else {
7651
7652             /* But if the first element is not zero, we unshift a 0 before the
7653              * array.  The data structure reserves a space for that 0 (which
7654              * should be a '1' right now), so physical shifting is unneeded,
7655              * but temporarily change that element to 0.  Before exiting the
7656              * routine, we must restore the element to '1' */
7657             array_b--;
7658             len_b++;
7659             array_b[0] = 0;
7660         }
7661     }
7662
7663     /* Size the union for the worst case: that the sets are completely
7664      * disjoint */
7665     u = _new_invlist(len_a + len_b);
7666
7667     /* Will contain U+0000 if either component does */
7668     array_u = _invlist_array_init(u, (len_a > 0 && array_a[0] == 0)
7669                                       || (len_b > 0 && array_b[0] == 0));
7670
7671     /* Go through each list item by item, stopping when exhausted one of
7672      * them */
7673     while (i_a < len_a && i_b < len_b) {
7674         UV cp;      /* The element to potentially add to the union's array */
7675         bool cp_in_set;   /* is it in the the input list's set or not */
7676
7677         /* We need to take one or the other of the two inputs for the union.
7678          * Since we are merging two sorted lists, we take the smaller of the
7679          * next items.  In case of a tie, we take the one that is in its set
7680          * first.  If we took one not in the set first, it would decrement the
7681          * count, possibly to 0 which would cause it to be output as ending the
7682          * range, and the next time through we would take the same number, and
7683          * output it again as beginning the next range.  By doing it the
7684          * opposite way, there is no possibility that the count will be
7685          * momentarily decremented to 0, and thus the two adjoining ranges will
7686          * be seamlessly merged.  (In a tie and both are in the set or both not
7687          * in the set, it doesn't matter which we take first.) */
7688         if (array_a[i_a] < array_b[i_b]
7689             || (array_a[i_a] == array_b[i_b]
7690                 && ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
7691         {
7692             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
7693             cp= array_a[i_a++];
7694         }
7695         else {
7696             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
7697             cp = array_b[i_b++];
7698         }
7699
7700         /* Here, have chosen which of the two inputs to look at.  Only output
7701          * if the running count changes to/from 0, which marks the
7702          * beginning/end of a range in that's in the set */
7703         if (cp_in_set) {
7704             if (count == 0) {
7705                 array_u[i_u++] = cp;
7706             }
7707             count++;
7708         }
7709         else {
7710             count--;
7711             if (count == 0) {
7712                 array_u[i_u++] = cp;
7713             }
7714         }
7715     }
7716
7717     /* Here, we are finished going through at least one of the lists, which
7718      * means there is something remaining in at most one.  We check if the list
7719      * that hasn't been exhausted is positioned such that we are in the middle
7720      * of a range in its set or not.  (i_a and i_b point to the element beyond
7721      * the one we care about.) If in the set, we decrement 'count'; if 0, there
7722      * is potentially more to output.
7723      * There are four cases:
7724      *  1) Both weren't in their sets, count is 0, and remains 0.  What's left
7725      *     in the union is entirely from the non-exhausted set.
7726      *  2) Both were in their sets, count is 2.  Nothing further should
7727      *     be output, as everything that remains will be in the exhausted
7728      *     list's set, hence in the union; decrementing to 1 but not 0 insures
7729      *     that
7730      *  3) the exhausted was in its set, non-exhausted isn't, count is 1.
7731      *     Nothing further should be output because the union includes
7732      *     everything from the exhausted set.  Not decrementing ensures that.
7733      *  4) the exhausted wasn't in its set, non-exhausted is, count is 1;
7734      *     decrementing to 0 insures that we look at the remainder of the
7735      *     non-exhausted set */
7736     if ((i_a != len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
7737         || (i_b != len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
7738     {
7739         count--;
7740     }
7741
7742     /* The final length is what we've output so far, plus what else is about to
7743      * be output.  (If 'count' is non-zero, then the input list we exhausted
7744      * has everything remaining up to the machine's limit in its set, and hence
7745      * in the union, so there will be no further output. */
7746     len_u = i_u;
7747     if (count == 0) {
7748         /* At most one of the subexpressions will be non-zero */
7749         len_u += (len_a - i_a) + (len_b - i_b);
7750     }
7751
7752     /* Set result to final length, which can change the pointer to array_u, so
7753      * re-find it */
7754     if (len_u != _invlist_len(u)) {
7755         invlist_set_len(u, len_u);
7756         invlist_trim(u);
7757         array_u = invlist_array(u);
7758     }
7759
7760     /* When 'count' is 0, the list that was exhausted (if one was shorter than
7761      * the other) ended with everything above it not in its set.  That means
7762      * that the remaining part of the union is precisely the same as the
7763      * non-exhausted list, so can just copy it unchanged.  (If both list were
7764      * exhausted at the same time, then the operations below will be both 0.)
7765      */
7766     if (count == 0) {
7767         IV copy_count; /* At most one will have a non-zero copy count */
7768         if ((copy_count = len_a - i_a) > 0) {
7769             Copy(array_a + i_a, array_u + i_u, copy_count, UV);
7770         }
7771         else if ((copy_count = len_b - i_b) > 0) {
7772             Copy(array_b + i_b, array_u + i_u, copy_count, UV);
7773         }
7774     }
7775
7776     /* If we've changed b, restore it */
7777     if (complement_b) {
7778         array_b[0] = 1;
7779     }
7780
7781     /*  We may be removing a reference to one of the inputs */
7782     if (a == *output || b == *output) {
7783         assert(! invlist_is_iterating(*output));
7784         SvREFCNT_dec_NN(*output);
7785     }
7786
7787     *output = u;
7788     return;
7789 }
7790
7791 void
7792 Perl__invlist_intersection_maybe_complement_2nd(pTHX_ SV* const a, SV* const b, bool complement_b, SV** i)
7793 {
7794     /* Take the intersection of two inversion lists and point <i> to it.  *i
7795      * SHOULD BE DEFINED upon input, and if it points to one of the two lists,
7796      * the reference count to that list will be decremented.
7797      * If <complement_b> is TRUE, the result will be the intersection of <a>
7798      * and the complement (or inversion) of <b> instead of <b> directly.
7799      *
7800      * The basis for this comes from "Unicode Demystified" Chapter 13 by
7801      * Richard Gillam, published by Addison-Wesley, and explained at some
7802      * length there.  The preface says to incorporate its examples into your
7803      * code at your own risk.  In fact, it had bugs
7804      *
7805      * The algorithm is like a merge sort, and is essentially the same as the
7806      * union above
7807      */
7808
7809     UV* array_a;                /* a's array */
7810     UV* array_b;
7811     UV len_a;   /* length of a's array */
7812     UV len_b;
7813
7814     SV* r;                   /* the resulting intersection */
7815     UV* array_r;
7816     UV len_r;
7817
7818     UV i_a = 0;             /* current index into a's array */
7819     UV i_b = 0;
7820     UV i_r = 0;
7821
7822     /* running count, as explained in the algorithm source book; items are
7823      * stopped accumulating and are output when the count changes to/from 2.
7824      * The count is incremented when we start a range that's in the set, and
7825      * decremented when we start a range that's not in the set.  So its range
7826      * is 0 to 2.  Only when the count is 2 is something in the intersection.
7827      */
7828     UV count = 0;
7829
7830     PERL_ARGS_ASSERT__INVLIST_INTERSECTION_MAYBE_COMPLEMENT_2ND;
7831     assert(a != b);
7832
7833     /* Special case if either one is empty */
7834     len_a = _invlist_len(a);
7835     if ((len_a == 0) || ((len_b = _invlist_len(b)) == 0)) {
7836
7837         if (len_a != 0 && complement_b) {
7838
7839             /* Here, 'a' is not empty, therefore from the above 'if', 'b' must
7840              * be empty.  Here, also we are using 'b's complement, which hence
7841              * must be every possible code point.  Thus the intersection is
7842              * simply 'a'. */
7843             if (*i != a) {
7844                 *i = invlist_clone(a);
7845
7846                 if (*i == b) {
7847                     SvREFCNT_dec_NN(b);
7848                 }
7849             }
7850             /* else *i is already 'a' */
7851             return;
7852         }
7853
7854         /* Here, 'a' or 'b' is empty and not using the complement of 'b'.  The
7855          * intersection must be empty */
7856         if (*i == a) {
7857             SvREFCNT_dec_NN(a);
7858         }
7859         else if (*i == b) {
7860             SvREFCNT_dec_NN(b);
7861         }
7862         *i = _new_invlist(0);
7863         return;
7864     }
7865
7866     /* Here both lists exist and are non-empty */
7867     array_a = invlist_array(a);
7868     array_b = invlist_array(b);
7869
7870     /* If are to take the intersection of 'a' with the complement of b, set it
7871      * up so are looking at b's complement. */
7872     if (complement_b) {
7873
7874         /* To complement, we invert: if the first element is 0, remove it.  To
7875          * do this, we just pretend the array starts one later, and clear the
7876          * flag as we don't have to do anything else later */
7877         if (array_b[0] == 0) {
7878             array_b++;
7879             len_b--;
7880             complement_b = FALSE;
7881         }
7882         else {
7883
7884             /* But if the first element is not zero, we unshift a 0 before the
7885              * array.  The data structure reserves a space for that 0 (which
7886              * should be a '1' right now), so physical shifting is unneeded,
7887              * but temporarily change that element to 0.  Before exiting the
7888              * routine, we must restore the element to '1' */
7889             array_b--;
7890             len_b++;
7891             array_b[0] = 0;
7892         }
7893     }
7894
7895     /* Size the intersection for the worst case: that the intersection ends up
7896      * fragmenting everything to be completely disjoint */
7897     r= _new_invlist(len_a + len_b);
7898
7899     /* Will contain U+0000 iff both components do */
7900     array_r = _invlist_array_init(r, len_a > 0 && array_a[0] == 0
7901                                      && len_b > 0 && array_b[0] == 0);
7902
7903     /* Go through each list item by item, stopping when exhausted one of
7904      * them */
7905     while (i_a < len_a && i_b < len_b) {
7906         UV cp;      /* The element to potentially add to the intersection's
7907                        array */
7908         bool cp_in_set; /* Is it in the input list's set or not */
7909
7910         /* We need to take one or the other of the two inputs for the
7911          * intersection.  Since we are merging two sorted lists, we take the
7912          * smaller of the next items.  In case of a tie, we take the one that
7913          * is not in its set first (a difference from the union algorithm).  If
7914          * we took one in the set first, it would increment the count, possibly
7915          * to 2 which would cause it to be output as starting a range in the
7916          * intersection, and the next time through we would take that same
7917          * number, and output it again as ending the set.  By doing it the
7918          * opposite of this, there is no possibility that the count will be
7919          * momentarily incremented to 2.  (In a tie and both are in the set or
7920          * both not in the set, it doesn't matter which we take first.) */
7921         if (array_a[i_a] < array_b[i_b]
7922             || (array_a[i_a] == array_b[i_b]
7923                 && ! ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
7924         {
7925             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
7926             cp= array_a[i_a++];
7927         }
7928         else {
7929             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
7930             cp= array_b[i_b++];
7931         }
7932
7933         /* Here, have chosen which of the two inputs to look at.  Only output
7934          * if the running count changes to/from 2, which marks the
7935          * beginning/end of a range that's in the intersection */
7936         if (cp_in_set) {
7937             count++;
7938             if (count == 2) {
7939                 array_r[i_r++] = cp;
7940             }
7941         }
7942         else {
7943             if (count == 2) {
7944                 array_r[i_r++] = cp;
7945             }
7946             count--;
7947         }
7948     }
7949
7950     /* Here, we are finished going through at least one of the lists, which
7951      * means there is something remaining in at most one.  We check if the list
7952      * that has been exhausted is positioned such that we are in the middle
7953      * of a range in its set or not.  (i_a and i_b point to elements 1 beyond
7954      * the ones we care about.)  There are four cases:
7955      *  1) Both weren't in their sets, count is 0, and remains 0.  There's
7956      *     nothing left in the intersection.
7957      *  2) Both were in their sets, count is 2 and perhaps is incremented to
7958      *     above 2.  What should be output is exactly that which is in the
7959      *     non-exhausted set, as everything it has is also in the intersection
7960      *     set, and everything it doesn't have can't be in the intersection
7961      *  3) The exhausted was in its set, non-exhausted isn't, count is 1, and
7962      *     gets incremented to 2.  Like the previous case, the intersection is
7963      *     everything that remains in the non-exhausted set.
7964      *  4) the exhausted wasn't in its set, non-exhausted is, count is 1, and
7965      *     remains 1.  And the intersection has nothing more. */
7966     if ((i_a == len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
7967         || (i_b == len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
7968     {
7969         count++;
7970     }
7971
7972     /* The final length is what we've output so far plus what else is in the
7973      * intersection.  At most one of the subexpressions below will be non-zero */
7974     len_r = i_r;
7975     if (count >= 2) {
7976         len_r += (len_a - i_a) + (len_b - i_b);
7977     }
7978
7979     /* Set result to final length, which can change the pointer to array_r, so
7980      * re-find it */
7981     if (len_r != _invlist_len(r)) {
7982         invlist_set_len(r, len_r);
7983         invlist_trim(r);
7984         array_r = invlist_array(r);
7985     }
7986
7987     /* Finish outputting any remaining */
7988     if (count >= 2) { /* At most one will have a non-zero copy count */
7989         IV copy_count;
7990         if ((copy_count = len_a - i_a) > 0) {
7991             Copy(array_a + i_a, array_r + i_r, copy_count, UV);
7992         }
7993         else if ((copy_count = len_b - i_b) > 0) {
7994             Copy(array_b + i_b, array_r + i_r, copy_count, UV);
7995         }
7996     }
7997
7998     /* If we've changed b, restore it */
7999     if (complement_b) {
8000         array_b[0] = 1;
8001     }
8002
8003     /*  We may be removing a reference to one of the inputs */
8004     if (a == *i || b == *i) {
8005         assert(! invlist_is_iterating(*i));
8006         SvREFCNT_dec_NN(*i);
8007     }
8008
8009     *i = r;
8010     return;
8011 }
8012
8013 SV*
8014 Perl__add_range_to_invlist(pTHX_ SV* invlist, const UV start, const UV end)
8015 {
8016     /* Add the range from 'start' to 'end' inclusive to the inversion list's
8017      * set.  A pointer to the inversion list is returned.  This may actually be
8018      * a new list, in which case the passed in one has been destroyed.  The
8019      * passed in inversion list can be NULL, in which case a new one is created
8020      * with just the one range in it */
8021
8022     SV* range_invlist;
8023     UV len;
8024
8025     if (invlist == NULL) {
8026         invlist = _new_invlist(2);
8027         len = 0;
8028     }
8029     else {
8030         len = _invlist_len(invlist);
8031     }
8032
8033     /* If comes after the final entry actually in the list, can just append it
8034      * to the end, */
8035     if (len == 0
8036         || (! ELEMENT_RANGE_MATCHES_INVLIST(len - 1)
8037             && start >= invlist_array(invlist)[len - 1]))
8038     {
8039         _append_range_to_invlist(invlist, start, end);
8040         return invlist;
8041     }
8042
8043     /* Here, can't just append things, create and return a new inversion list
8044      * which is the union of this range and the existing inversion list */
8045     range_invlist = _new_invlist(2);
8046     _append_range_to_invlist(range_invlist, start, end);
8047
8048     _invlist_union(invlist, range_invlist, &invlist);
8049
8050     /* The temporary can be freed */
8051     SvREFCNT_dec_NN(range_invlist);
8052
8053     return invlist;
8054 }
8055
8056 #endif
8057
8058 PERL_STATIC_INLINE SV*
8059 S_add_cp_to_invlist(pTHX_ SV* invlist, const UV cp) {
8060     return _add_range_to_invlist(invlist, cp, cp);
8061 }
8062
8063 #ifndef PERL_IN_XSUB_RE
8064 void
8065 Perl__invlist_invert(pTHX_ SV* const invlist)
8066 {
8067     /* Complement the input inversion list.  This adds a 0 if the list didn't
8068      * have a zero; removes it otherwise.  As described above, the data
8069      * structure is set up so that this is very efficient */
8070
8071     UV* len_pos = _get_invlist_len_addr(invlist);
8072
8073     PERL_ARGS_ASSERT__INVLIST_INVERT;
8074
8075     assert(! invlist_is_iterating(invlist));
8076
8077     /* The inverse of matching nothing is matching everything */
8078     if (*len_pos == 0) {
8079         _append_range_to_invlist(invlist, 0, UV_MAX);
8080         return;
8081     }
8082
8083     /* The exclusive or complents 0 to 1; and 1 to 0.  If the result is 1, the
8084      * zero element was a 0, so it is being removed, so the length decrements
8085      * by 1; and vice-versa.  SvCUR is unaffected */
8086     if (*get_invlist_zero_addr(invlist) ^= 1) {
8087         (*len_pos)--;
8088     }
8089     else {
8090         (*len_pos)++;
8091     }
8092 }
8093
8094 void
8095 Perl__invlist_invert_prop(pTHX_ SV* const invlist)
8096 {
8097     /* Complement the input inversion list (which must be a Unicode property,
8098      * all of which don't match above the Unicode maximum code point.)  And
8099      * Perl has chosen to not have the inversion match above that either.  This
8100      * adds a 0x110000 if the list didn't end with it, and removes it if it did
8101      */
8102
8103     UV len;
8104     UV* array;
8105
8106     PERL_ARGS_ASSERT__INVLIST_INVERT_PROP;
8107
8108     _invlist_invert(invlist);
8109
8110     len = _invlist_len(invlist);
8111
8112     if (len != 0) { /* If empty do nothing */
8113         array = invlist_array(invlist);
8114         if (array[len - 1] != PERL_UNICODE_MAX + 1) {
8115             /* Add 0x110000.  First, grow if necessary */
8116             len++;
8117             if (invlist_max(invlist) < len) {
8118                 invlist_extend(invlist, len);
8119                 array = invlist_array(invlist);
8120             }
8121             invlist_set_len(invlist, len);
8122             array[len - 1] = PERL_UNICODE_MAX + 1;
8123         }
8124         else {  /* Remove the 0x110000 */
8125             invlist_set_len(invlist, len - 1);
8126         }
8127     }
8128
8129     return;
8130 }
8131 #endif
8132
8133 PERL_STATIC_INLINE SV*
8134 S_invlist_clone(pTHX_ SV* const invlist)
8135 {
8136
8137     /* Return a new inversion list that is a copy of the input one, which is
8138      * unchanged */
8139
8140     /* Need to allocate extra space to accommodate Perl's addition of a
8141      * trailing NUL to SvPV's, since it thinks they are always strings */
8142     SV* new_invlist = _new_invlist(_invlist_len(invlist) + 1);
8143     STRLEN length = SvCUR(invlist);
8144
8145     PERL_ARGS_ASSERT_INVLIST_CLONE;
8146
8147     SvCUR_set(new_invlist, length); /* This isn't done automatically */
8148     Copy(SvPVX(invlist), SvPVX(new_invlist), length, char);
8149
8150     return new_invlist;
8151 }
8152
8153 PERL_STATIC_INLINE UV*
8154 S_get_invlist_iter_addr(pTHX_ SV* invlist)
8155 {
8156     /* Return the address of the UV that contains the current iteration
8157      * position */
8158
8159     PERL_ARGS_ASSERT_GET_INVLIST_ITER_ADDR;
8160
8161     return (UV *) (SvPVX(invlist) + (INVLIST_ITER_OFFSET * sizeof (UV)));
8162 }
8163
8164 PERL_STATIC_INLINE UV*
8165 S_get_invlist_version_id_addr(pTHX_ SV* invlist)
8166 {
8167     /* Return the address of the UV that contains the version id. */
8168
8169     PERL_ARGS_ASSERT_GET_INVLIST_VERSION_ID_ADDR;
8170
8171     return (UV *) (SvPVX(invlist) + (INVLIST_VERSION_ID_OFFSET * sizeof (UV)));
8172 }
8173
8174 PERL_STATIC_INLINE void
8175 S_invlist_iterinit(pTHX_ SV* invlist)   /* Initialize iterator for invlist */
8176 {
8177     PERL_ARGS_ASSERT_INVLIST_ITERINIT;
8178
8179     *get_invlist_iter_addr(invlist) = 0;
8180 }
8181
8182 PERL_STATIC_INLINE void
8183 S_invlist_iterfinish(pTHX_ SV* invlist)
8184 {
8185     /* Terminate iterator for invlist.  This is to catch development errors.
8186      * Any iteration that is interrupted before completed should call this
8187      * function.  Functions that add code points anywhere else but to the end
8188      * of an inversion list assert that they are not in the middle of an
8189      * iteration.  If they were, the addition would make the iteration
8190      * problematical: if the iteration hadn't reached the place where things
8191      * were being added, it would be ok */
8192
8193     PERL_ARGS_ASSERT_INVLIST_ITERFINISH;
8194
8195     *get_invlist_iter_addr(invlist) = UV_MAX;
8196 }
8197
8198 STATIC bool
8199 S_invlist_iternext(pTHX_ SV* invlist, UV* start, UV* end)
8200 {
8201     /* An C<invlist_iterinit> call on <invlist> must be used to set this up.
8202      * This call sets in <*start> and <*end>, the next range in <invlist>.
8203      * Returns <TRUE> if successful and the next call will return the next
8204      * range; <FALSE> if was already at the end of the list.  If the latter,
8205      * <*start> and <*end> are unchanged, and the next call to this function
8206      * will start over at the beginning of the list */
8207
8208     UV* pos = get_invlist_iter_addr(invlist);
8209     UV len = _invlist_len(invlist);
8210     UV *array;
8211
8212     PERL_ARGS_ASSERT_INVLIST_ITERNEXT;
8213
8214     if (*pos >= len) {
8215         *pos = UV_MAX;  /* Force iterinit() to be required next time */
8216         return FALSE;
8217     }
8218
8219     array = invlist_array(invlist);
8220
8221     *start = array[(*pos)++];
8222
8223     if (*pos >= len) {
8224         *end = UV_MAX;
8225     }
8226     else {
8227         *end = array[(*pos)++] - 1;
8228     }
8229
8230     return TRUE;
8231 }
8232
8233 PERL_STATIC_INLINE bool
8234 S_invlist_is_iterating(pTHX_ SV* const invlist)
8235 {
8236     PERL_ARGS_ASSERT_INVLIST_IS_ITERATING;
8237
8238     return *(get_invlist_iter_addr(invlist)) < UV_MAX;
8239 }
8240
8241 PERL_STATIC_INLINE UV
8242 S_invlist_highest(pTHX_ SV* const invlist)
8243 {
8244     /* Returns the highest code point that matches an inversion list.  This API
8245      * has an ambiguity, as it returns 0 under either the highest is actually
8246      * 0, or if the list is empty.  If this distinction matters to you, check
8247      * for emptiness before calling this function */
8248
8249     UV len = _invlist_len(invlist);
8250     UV *array;
8251
8252     PERL_ARGS_ASSERT_INVLIST_HIGHEST;
8253
8254     if (len == 0) {
8255         return 0;
8256     }
8257
8258     array = invlist_array(invlist);
8259
8260     /* The last element in the array in the inversion list always starts a
8261      * range that goes to infinity.  That range may be for code points that are
8262      * matched in the inversion list, or it may be for ones that aren't
8263      * matched.  In the latter case, the highest code point in the set is one
8264      * less than the beginning of this range; otherwise it is the final element
8265      * of this range: infinity */
8266     return (ELEMENT_RANGE_MATCHES_INVLIST(len - 1))
8267            ? UV_MAX
8268            : array[len - 1] - 1;
8269 }
8270
8271 #ifndef PERL_IN_XSUB_RE
8272 SV *
8273 Perl__invlist_contents(pTHX_ SV* const invlist)
8274 {
8275     /* Get the contents of an inversion list into a string SV so that they can
8276      * be printed out.  It uses the format traditionally done for debug tracing
8277      */
8278
8279     UV start, end;
8280     SV* output = newSVpvs("\n");
8281
8282     PERL_ARGS_ASSERT__INVLIST_CONTENTS;
8283
8284     assert(! invlist_is_iterating(invlist));
8285
8286     invlist_iterinit(invlist);
8287     while (invlist_iternext(invlist, &start, &end)) {
8288         if (end == UV_MAX) {
8289             Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\tINFINITY\n", start);
8290         }
8291         else if (end != start) {
8292             Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\t%04"UVXf"\n",
8293                     start,       end);
8294         }
8295         else {
8296             Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\n", start);
8297         }
8298     }
8299
8300     return output;
8301 }
8302 #endif
8303
8304 #ifdef PERL_ARGS_ASSERT__INVLIST_DUMP
8305 void
8306 Perl__invlist_dump(pTHX_ SV* const invlist, const char * const header)
8307 {
8308     /* Dumps out the ranges in an inversion list.  The string 'header'
8309      * if present is output on a line before the first range */
8310
8311     UV start, end;
8312
8313     PERL_ARGS_ASSERT__INVLIST_DUMP;
8314
8315     if (header && strlen(header)) {
8316         PerlIO_printf(Perl_debug_log, "%s\n", header);
8317     }
8318     if (invlist_is_iterating(invlist)) {
8319         PerlIO_printf(Perl_debug_log, "Can't dump because is in middle of iterating\n");
8320         return;
8321     }
8322
8323     invlist_iterinit(invlist);
8324     while (invlist_iternext(invlist, &start, &end)) {
8325         if (end == UV_MAX) {
8326             PerlIO_printf(Perl_debug_log, "0x%04"UVXf" .. INFINITY\n", start);
8327         }
8328         else if (end != start) {
8329             PerlIO_printf(Perl_debug_log, "0x%04"UVXf" .. 0x%04"UVXf"\n",
8330                                                  start,         end);
8331         }
8332         else {
8333             PerlIO_printf(Perl_debug_log, "0x%04"UVXf"\n", start);
8334         }
8335     }
8336 }
8337 #endif
8338
8339 #if 0
8340 bool
8341 S__invlistEQ(pTHX_ SV* const a, SV* const b, bool complement_b)
8342 {
8343     /* Return a boolean as to if the two passed in inversion lists are
8344      * identical.  The final argument, if TRUE, says to take the complement of
8345      * the second inversion list before doing the comparison */
8346
8347     UV* array_a = invlist_array(a);
8348     UV* array_b = invlist_array(b);
8349     UV len_a = _invlist_len(a);
8350     UV len_b = _invlist_len(b);
8351
8352     UV i = 0;               /* current index into the arrays */
8353     bool retval = TRUE;     /* Assume are identical until proven otherwise */
8354
8355     PERL_ARGS_ASSERT__INVLISTEQ;
8356
8357     /* If are to compare 'a' with the complement of b, set it
8358      * up so are looking at b's complement. */
8359     if (complement_b) {
8360
8361         /* The complement of nothing is everything, so <a> would have to have
8362          * just one element, starting at zero (ending at infinity) */
8363         if (len_b == 0) {
8364             return (len_a == 1 && array_a[0] == 0);
8365         }
8366         else if (array_b[0] == 0) {
8367
8368             /* Otherwise, to complement, we invert.  Here, the first element is
8369              * 0, just remove it.  To do this, we just pretend the array starts
8370              * one later, and clear the flag as we don't have to do anything
8371              * else later */
8372
8373             array_b++;
8374             len_b--;
8375             complement_b = FALSE;
8376         }
8377         else {
8378
8379             /* But if the first element is not zero, we unshift a 0 before the
8380              * array.  The data structure reserves a space for that 0 (which
8381              * should be a '1' right now), so physical shifting is unneeded,
8382              * but temporarily change that element to 0.  Before exiting the
8383              * routine, we must restore the element to '1' */
8384             array_b--;
8385             len_b++;
8386             array_b[0] = 0;
8387         }
8388     }
8389
8390     /* Make sure that the lengths are the same, as well as the final element
8391      * before looping through the remainder.  (Thus we test the length, final,
8392      * and first elements right off the bat) */
8393     if (len_a != len_b || array_a[len_a-1] != array_b[len_a-1]) {
8394         retval = FALSE;
8395     }
8396     else for (i = 0; i < len_a - 1; i++) {
8397         if (array_a[i] != array_b[i]) {
8398             retval = FALSE;
8399             break;
8400         }
8401     }
8402
8403     if (complement_b) {
8404         array_b[0] = 1;
8405     }
8406     return retval;
8407 }
8408 #endif
8409
8410 #undef HEADER_LENGTH
8411 #undef INVLIST_INITIAL_LENGTH
8412 #undef TO_INTERNAL_SIZE
8413 #undef FROM_INTERNAL_SIZE
8414 #undef INVLIST_LEN_OFFSET
8415 #undef INVLIST_ZERO_OFFSET
8416 #undef INVLIST_ITER_OFFSET
8417 #undef INVLIST_VERSION_ID
8418 #undef INVLIST_PREVIOUS_INDEX_OFFSET
8419
8420 /* End of inversion list object */
8421
8422 STATIC void
8423 S_parse_lparen_question_flags(pTHX_ struct RExC_state_t *pRExC_state)
8424 {
8425     /* This parses the flags that are in either the '(?foo)' or '(?foo:bar)'
8426      * constructs, and updates RExC_flags with them.  On input, RExC_parse
8427      * should point to the first flag; it is updated on output to point to the
8428      * final ')' or ':'.  There needs to be at least one flag, or this will
8429      * abort */
8430
8431     /* for (?g), (?gc), and (?o) warnings; warning
8432        about (?c) will warn about (?g) -- japhy    */
8433
8434 #define WASTED_O  0x01
8435 #define WASTED_G  0x02
8436 #define WASTED_C  0x04
8437 #define WASTED_GC (WASTED_G|WASTED_C)
8438     I32 wastedflags = 0x00;
8439     U32 posflags = 0, negflags = 0;
8440     U32 *flagsp = &posflags;
8441     char has_charset_modifier = '\0';
8442     regex_charset cs;
8443     bool has_use_defaults = FALSE;
8444     const char* const seqstart = RExC_parse - 1; /* Point to the '?' */
8445
8446     PERL_ARGS_ASSERT_PARSE_LPAREN_QUESTION_FLAGS;
8447
8448     /* '^' as an initial flag sets certain defaults */
8449     if (UCHARAT(RExC_parse) == '^') {
8450         RExC_parse++;
8451         has_use_defaults = TRUE;
8452         STD_PMMOD_FLAGS_CLEAR(&RExC_flags);
8453         set_regex_charset(&RExC_flags, (RExC_utf8 || RExC_uni_semantics)
8454                                         ? REGEX_UNICODE_CHARSET
8455                                         : REGEX_DEPENDS_CHARSET);
8456     }
8457
8458     cs = get_regex_charset(RExC_flags);
8459     if (cs == REGEX_DEPENDS_CHARSET
8460         && (RExC_utf8 || RExC_uni_semantics))
8461     {
8462         cs = REGEX_UNICODE_CHARSET;
8463     }
8464
8465     while (*RExC_parse) {
8466         /* && strchr("iogcmsx", *RExC_parse) */
8467         /* (?g), (?gc) and (?o) are useless here
8468            and must be globally applied -- japhy */
8469         switch (*RExC_parse) {
8470
8471             /* Code for the imsx flags */
8472             CASE_STD_PMMOD_FLAGS_PARSE_SET(flagsp);
8473
8474             case LOCALE_PAT_MOD:
8475                 if (has_charset_modifier) {
8476                     goto excess_modifier;
8477                 }
8478                 else if (flagsp == &negflags) {
8479                     goto neg_modifier;
8480                 }
8481                 cs = REGEX_LOCALE_CHARSET;
8482                 has_charset_modifier = LOCALE_PAT_MOD;
8483                 RExC_contains_locale = 1;
8484                 break;
8485             case UNICODE_PAT_MOD:
8486                 if (has_charset_modifier) {
8487                     goto excess_modifier;
8488                 }
8489                 else if (flagsp == &negflags) {
8490                     goto neg_modifier;
8491                 }
8492                 cs = REGEX_UNICODE_CHARSET;
8493                 has_charset_modifier = UNICODE_PAT_MOD;
8494                 break;
8495             case ASCII_RESTRICT_PAT_MOD:
8496                 if (flagsp == &negflags) {
8497                     goto neg_modifier;
8498                 }
8499                 if (has_charset_modifier) {
8500                     if (cs != REGEX_ASCII_RESTRICTED_CHARSET) {
8501                         goto excess_modifier;
8502                     }
8503                     /* Doubled modifier implies more restricted */
8504                     cs = REGEX_ASCII_MORE_RESTRICTED_CHARSET;
8505                 }
8506                 else {
8507                     cs = REGEX_ASCII_RESTRICTED_CHARSET;
8508                 }
8509                 has_charset_modifier = ASCII_RESTRICT_PAT_MOD;
8510                 break;
8511             case DEPENDS_PAT_MOD:
8512                 if (has_use_defaults) {
8513                     goto fail_modifiers;
8514                 }
8515                 else if (flagsp == &negflags) {
8516                     goto neg_modifier;
8517                 }
8518                 else if (has_charset_modifier) {
8519                     goto excess_modifier;
8520                 }
8521
8522                 /* The dual charset means unicode semantics if the
8523                  * pattern (or target, not known until runtime) are
8524                  * utf8, or something in the pattern indicates unicode
8525                  * semantics */
8526                 cs = (RExC_utf8 || RExC_uni_semantics)
8527                      ? REGEX_UNICODE_CHARSET
8528                      : REGEX_DEPENDS_CHARSET;
8529                 has_charset_modifier = DEPENDS_PAT_MOD;
8530                 break;
8531             excess_modifier:
8532                 RExC_parse++;
8533                 if (has_charset_modifier == ASCII_RESTRICT_PAT_MOD) {
8534                     vFAIL2("Regexp modifier \"%c\" may appear a maximum of twice", ASCII_RESTRICT_PAT_MOD);
8535                 }
8536                 else if (has_charset_modifier == *(RExC_parse - 1)) {
8537                     vFAIL2("Regexp modifier \"%c\" may not appear twice", *(RExC_parse - 1));
8538                 }
8539                 else {
8540                     vFAIL3("Regexp modifiers \"%c\" and \"%c\" are mutually exclusive", has_charset_modifier, *(RExC_parse - 1));
8541                 }
8542                 /*NOTREACHED*/
8543             neg_modifier:
8544                 RExC_parse++;
8545                 vFAIL2("Regexp modifier \"%c\" may not appear after the \"-\"", *(RExC_parse - 1));
8546                 /*NOTREACHED*/
8547             case ONCE_PAT_MOD: /* 'o' */
8548             case GLOBAL_PAT_MOD: /* 'g' */
8549                 if (SIZE_ONLY && ckWARN(WARN_REGEXP)) {
8550                     const I32 wflagbit = *RExC_parse == 'o' ? WASTED_O : WASTED_G;
8551                     if (! (wastedflags & wflagbit) ) {
8552                         wastedflags |= wflagbit;
8553                         /* diag_listed_as: Useless (?-%s) - don't use /%s modifier in regex; marked by <-- HERE in m/%s/ */
8554                         vWARN5(
8555                             RExC_parse + 1,
8556                             "Useless (%s%c) - %suse /%c modifier",
8557                             flagsp == &negflags ? "?-" : "?",
8558                             *RExC_parse,
8559                             flagsp == &negflags ? "don't " : "",
8560                             *RExC_parse
8561                         );
8562                     }
8563                 }
8564                 break;
8565
8566             case CONTINUE_PAT_MOD: /* 'c' */
8567                 if (SIZE_ONLY && ckWARN(WARN_REGEXP)) {
8568                     if (! (wastedflags & WASTED_C) ) {
8569                         wastedflags |= WASTED_GC;
8570                         /* diag_listed_as: Useless (?-%s) - don't use /%s modifier in regex; marked by <-- HERE in m/%s/ */
8571                         vWARN3(
8572                             RExC_parse + 1,
8573                             "Useless (%sc) - %suse /gc modifier",
8574                             flagsp == &negflags ? "?-" : "?",
8575                             flagsp == &negflags ? "don't " : ""
8576                         );
8577                     }
8578                 }
8579                 break;
8580             case KEEPCOPY_PAT_MOD: /* 'p' */
8581                 if (flagsp == &negflags) {
8582                     if (SIZE_ONLY)
8583                         ckWARNreg(RExC_parse + 1,"Useless use of (?-p)");
8584                 } else {
8585                     *flagsp |= RXf_PMf_KEEPCOPY;
8586                 }
8587                 break;
8588             case '-':
8589                 /* A flag is a default iff it is following a minus, so
8590                  * if there is a minus, it means will be trying to
8591                  * re-specify a default which is an error */
8592                 if (has_use_defaults || flagsp == &negflags) {
8593                     goto fail_modifiers;
8594                 }
8595                 flagsp = &negflags;
8596                 wastedflags = 0;  /* reset so (?g-c) warns twice */
8597                 break;
8598             case ':':
8599             case ')':
8600                 RExC_flags |= posflags;
8601                 RExC_flags &= ~negflags;
8602                 set_regex_charset(&RExC_flags, cs);
8603                 return;
8604                 /*NOTREACHED*/
8605             default:
8606             fail_modifiers:
8607                 RExC_parse++;
8608                 vFAIL3("Sequence (%.*s...) not recognized",
8609                        RExC_parse-seqstart, seqstart);
8610                 /*NOTREACHED*/
8611         }
8612
8613         ++RExC_parse;
8614     }
8615 }
8616
8617 /*
8618  - reg - regular expression, i.e. main body or parenthesized thing
8619  *
8620  * Caller must absorb opening parenthesis.
8621  *
8622  * Combining parenthesis handling with the base level of regular expression
8623  * is a trifle forced, but the need to tie the tails of the branches to what
8624  * follows makes it hard to avoid.
8625  */
8626 #define REGTAIL(x,y,z) regtail((x),(y),(z),depth+1)
8627 #ifdef DEBUGGING
8628 #define REGTAIL_STUDY(x,y,z) regtail_study((x),(y),(z),depth+1)
8629 #else
8630 #define REGTAIL_STUDY(x,y,z) regtail((x),(y),(z),depth+1)
8631 #endif
8632
8633 /* Returns NULL, setting *flagp to TRYAGAIN at the end of (?) that only sets
8634    flags. Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan
8635    needs to be restarted.
8636    Otherwise would only return NULL if regbranch() returns NULL, which
8637    cannot happen.  */
8638 STATIC regnode *
8639 S_reg(pTHX_ RExC_state_t *pRExC_state, I32 paren, I32 *flagp,U32 depth)
8640     /* paren: Parenthesized? 0=top; 1,2=inside '(': changed to letter.
8641      * 2 is like 1, but indicates that nextchar() has been called to advance
8642      * RExC_parse beyond the '('.  Things like '(?' are indivisible tokens, and
8643      * this flag alerts us to the need to check for that */
8644 {
8645     dVAR;
8646     regnode *ret;               /* Will be the head of the group. */
8647     regnode *br;
8648     regnode *lastbr;
8649     regnode *ender = NULL;
8650     I32 parno = 0;
8651     I32 flags;
8652     U32 oregflags = RExC_flags;
8653     bool have_branch = 0;
8654     bool is_open = 0;
8655     I32 freeze_paren = 0;
8656     I32 after_freeze = 0;
8657
8658     char * parse_start = RExC_parse; /* MJD */
8659     char * const oregcomp_parse = RExC_parse;
8660
8661     GET_RE_DEBUG_FLAGS_DECL;
8662
8663     PERL_ARGS_ASSERT_REG;
8664     DEBUG_PARSE("reg ");
8665
8666     *flagp = 0;                         /* Tentatively. */
8667
8668
8669     /* Make an OPEN node, if parenthesized. */
8670     if (paren) {
8671
8672         /* Under /x, space and comments can be gobbled up between the '(' and
8673          * here (if paren ==2).  The forms '(*VERB' and '(?...' disallow such
8674          * intervening space, as the sequence is a token, and a token should be
8675          * indivisible */
8676         bool has_intervening_patws = paren == 2 && *(RExC_parse - 1) != '(';
8677
8678         if ( *RExC_parse == '*') { /* (*VERB:ARG) */
8679             char *start_verb = RExC_parse;
8680             STRLEN verb_len = 0;
8681             char *start_arg = NULL;
8682             unsigned char op = 0;
8683             int argok = 1;
8684             int internal_argval = 0; /* internal_argval is only useful if !argok */
8685
8686             if (has_intervening_patws && SIZE_ONLY) {
8687                 ckWARNregdep(RExC_parse + 1, "In '(*VERB...)', splitting the initial '(*' is deprecated");
8688             }
8689             while ( *RExC_parse && *RExC_parse != ')' ) {
8690                 if ( *RExC_parse == ':' ) {
8691                     start_arg = RExC_parse + 1;
8692                     break;
8693                 }
8694                 RExC_parse++;
8695             }
8696             ++start_verb;
8697             verb_len = RExC_parse - start_verb;
8698             if ( start_arg ) {
8699                 RExC_parse++;
8700                 while ( *RExC_parse && *RExC_parse != ')' ) 
8701                     RExC_parse++;
8702                 if ( *RExC_parse != ')' ) 
8703                     vFAIL("Unterminated verb pattern argument");
8704                 if ( RExC_parse == start_arg )
8705                     start_arg = NULL;
8706             } else {
8707                 if ( *RExC_parse != ')' )
8708                     vFAIL("Unterminated verb pattern");
8709             }
8710             
8711             switch ( *start_verb ) {
8712             case 'A':  /* (*ACCEPT) */
8713                 if ( memEQs(start_verb,verb_len,"ACCEPT") ) {
8714                     op = ACCEPT;
8715                     internal_argval = RExC_nestroot;
8716                 }
8717                 break;
8718             case 'C':  /* (*COMMIT) */
8719                 if ( memEQs(start_verb,verb_len,"COMMIT") )
8720                     op = COMMIT;
8721                 break;
8722             case 'F':  /* (*FAIL) */
8723                 if ( verb_len==1 || memEQs(start_verb,verb_len,"FAIL") ) {
8724                     op = OPFAIL;
8725                     argok = 0;
8726                 }
8727                 break;
8728             case ':':  /* (*:NAME) */
8729             case 'M':  /* (*MARK:NAME) */
8730                 if ( verb_len==0 || memEQs(start_verb,verb_len,"MARK") ) {
8731                     op = MARKPOINT;
8732                     argok = -1;
8733                 }
8734                 break;
8735             case 'P':  /* (*PRUNE) */
8736                 if ( memEQs(start_verb,verb_len,"PRUNE") )
8737                     op = PRUNE;
8738                 break;
8739             case 'S':   /* (*SKIP) */  
8740                 if ( memEQs(start_verb,verb_len,"SKIP") ) 
8741                     op = SKIP;
8742                 break;
8743             case 'T':  /* (*THEN) */
8744                 /* [19:06] <TimToady> :: is then */
8745                 if ( memEQs(start_verb,verb_len,"THEN") ) {
8746                     op = CUTGROUP;
8747                     RExC_seen |= REG_SEEN_CUTGROUP;
8748                 }
8749                 break;
8750             }
8751             if ( ! op ) {
8752                 RExC_parse++;
8753                 vFAIL3("Unknown verb pattern '%.*s'",
8754                     verb_len, start_verb);
8755             }
8756             if ( argok ) {
8757                 if ( start_arg && internal_argval ) {
8758                     vFAIL3("Verb pattern '%.*s' may not have an argument",
8759                         verb_len, start_verb); 
8760                 } else if ( argok < 0 && !start_arg ) {
8761                     vFAIL3("Verb pattern '%.*s' has a mandatory argument",
8762                         verb_len, start_verb);    
8763                 } else {
8764                     ret = reganode(pRExC_state, op, internal_argval);
8765                     if ( ! internal_argval && ! SIZE_ONLY ) {
8766                         if (start_arg) {
8767                             SV *sv = newSVpvn( start_arg, RExC_parse - start_arg);
8768                             ARG(ret) = add_data( pRExC_state, 1, "S" );
8769                             RExC_rxi->data->data[ARG(ret)]=(void*)sv;
8770                             ret->flags = 0;
8771                         } else {
8772                             ret->flags = 1; 
8773                         }
8774                     }               
8775                 }
8776                 if (!internal_argval)
8777                     RExC_seen |= REG_SEEN_VERBARG;
8778             } else if ( start_arg ) {
8779                 vFAIL3("Verb pattern '%.*s' may not have an argument",
8780                         verb_len, start_verb);    
8781             } else {
8782                 ret = reg_node(pRExC_state, op);
8783             }
8784             nextchar(pRExC_state);
8785             return ret;
8786         }
8787         else if (*RExC_parse == '?') { /* (?...) */
8788             bool is_logical = 0;
8789             const char * const seqstart = RExC_parse;
8790             if (has_intervening_patws && SIZE_ONLY) {
8791                 ckWARNregdep(RExC_parse + 1, "In '(?...)', splitting the initial '(?' is deprecated");
8792             }
8793
8794             RExC_parse++;
8795             paren = *RExC_parse++;
8796             ret = NULL;                 /* For look-ahead/behind. */
8797             switch (paren) {
8798
8799             case 'P':   /* (?P...) variants for those used to PCRE/Python */
8800                 paren = *RExC_parse++;
8801                 if ( paren == '<')         /* (?P<...>) named capture */
8802                     goto named_capture;
8803                 else if (paren == '>') {   /* (?P>name) named recursion */
8804                     goto named_recursion;
8805                 }
8806                 else if (paren == '=') {   /* (?P=...)  named backref */
8807                     /* this pretty much dupes the code for \k<NAME> in regatom(), if
8808                        you change this make sure you change that */
8809                     char* name_start = RExC_parse;
8810                     U32 num = 0;
8811                     SV *sv_dat = reg_scan_name(pRExC_state,
8812                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
8813                     if (RExC_parse == name_start || *RExC_parse != ')')
8814                         vFAIL2("Sequence %.3s... not terminated",parse_start);
8815
8816                     if (!SIZE_ONLY) {
8817                         num = add_data( pRExC_state, 1, "S" );
8818                         RExC_rxi->data->data[num]=(void*)sv_dat;
8819                         SvREFCNT_inc_simple_void(sv_dat);
8820                     }
8821                     RExC_sawback = 1;
8822                     ret = reganode(pRExC_state,
8823                                    ((! FOLD)
8824                                      ? NREF
8825                                      : (ASCII_FOLD_RESTRICTED)
8826                                        ? NREFFA
8827                                        : (AT_LEAST_UNI_SEMANTICS)
8828                                          ? NREFFU
8829                                          : (LOC)
8830                                            ? NREFFL
8831                                            : NREFF),
8832                                     num);
8833                     *flagp |= HASWIDTH;
8834
8835                     Set_Node_Offset(ret, parse_start+1);
8836                     Set_Node_Cur_Length(ret, parse_start);
8837
8838                     nextchar(pRExC_state);
8839                     return ret;
8840                 }
8841                 RExC_parse++;
8842                 vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
8843                 /*NOTREACHED*/
8844             case '<':           /* (?<...) */
8845                 if (*RExC_parse == '!')
8846                     paren = ',';
8847                 else if (*RExC_parse != '=') 
8848               named_capture:
8849                 {               /* (?<...>) */
8850                     char *name_start;
8851                     SV *svname;
8852                     paren= '>';
8853             case '\'':          /* (?'...') */
8854                     name_start= RExC_parse;
8855                     svname = reg_scan_name(pRExC_state,
8856                         SIZE_ONLY ?  /* reverse test from the others */
8857                         REG_RSN_RETURN_NAME : 
8858                         REG_RSN_RETURN_NULL);
8859                     if (RExC_parse == name_start) {
8860                         RExC_parse++;
8861                         vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
8862                         /*NOTREACHED*/
8863                     }
8864                     if (*RExC_parse != paren)
8865                         vFAIL2("Sequence (?%c... not terminated",
8866                             paren=='>' ? '<' : paren);
8867                     if (SIZE_ONLY) {
8868                         HE *he_str;
8869                         SV *sv_dat = NULL;
8870                         if (!svname) /* shouldn't happen */
8871                             Perl_croak(aTHX_
8872                                 "panic: reg_scan_name returned NULL");
8873                         if (!RExC_paren_names) {
8874                             RExC_paren_names= newHV();
8875                             sv_2mortal(MUTABLE_SV(RExC_paren_names));
8876 #ifdef DEBUGGING
8877                             RExC_paren_name_list= newAV();
8878                             sv_2mortal(MUTABLE_SV(RExC_paren_name_list));
8879 #endif
8880                         }
8881                         he_str = hv_fetch_ent( RExC_paren_names, svname, 1, 0 );
8882                         if ( he_str )
8883                             sv_dat = HeVAL(he_str);
8884                         if ( ! sv_dat ) {
8885                             /* croak baby croak */
8886                             Perl_croak(aTHX_
8887                                 "panic: paren_name hash element allocation failed");
8888                         } else if ( SvPOK(sv_dat) ) {
8889                             /* (?|...) can mean we have dupes so scan to check
8890                                its already been stored. Maybe a flag indicating
8891                                we are inside such a construct would be useful,
8892                                but the arrays are likely to be quite small, so
8893                                for now we punt -- dmq */
8894                             IV count = SvIV(sv_dat);
8895                             I32 *pv = (I32*)SvPVX(sv_dat);
8896                             IV i;
8897                             for ( i = 0 ; i < count ; i++ ) {
8898                                 if ( pv[i] == RExC_npar ) {
8899                                     count = 0;
8900                                     break;
8901                                 }
8902                             }
8903                             if ( count ) {
8904                                 pv = (I32*)SvGROW(sv_dat, SvCUR(sv_dat) + sizeof(I32)+1);
8905                                 SvCUR_set(sv_dat, SvCUR(sv_dat) + sizeof(I32));
8906                                 pv[count] = RExC_npar;
8907                                 SvIV_set(sv_dat, SvIVX(sv_dat) + 1);
8908                             }
8909                         } else {
8910                             (void)SvUPGRADE(sv_dat,SVt_PVNV);
8911                             sv_setpvn(sv_dat, (char *)&(RExC_npar), sizeof(I32));
8912                             SvIOK_on(sv_dat);
8913                             SvIV_set(sv_dat, 1);
8914                         }
8915 #ifdef DEBUGGING
8916                         /* Yes this does cause a memory leak in debugging Perls */
8917                         if (!av_store(RExC_paren_name_list, RExC_npar, SvREFCNT_inc(svname)))
8918                             SvREFCNT_dec_NN(svname);
8919 #endif
8920
8921                         /*sv_dump(sv_dat);*/
8922                     }
8923                     nextchar(pRExC_state);
8924                     paren = 1;
8925                     goto capturing_parens;
8926                 }
8927                 RExC_seen |= REG_SEEN_LOOKBEHIND;
8928                 RExC_in_lookbehind++;
8929                 RExC_parse++;
8930             case '=':           /* (?=...) */
8931                 RExC_seen_zerolen++;
8932                 break;
8933             case '!':           /* (?!...) */
8934                 RExC_seen_zerolen++;
8935                 if (*RExC_parse == ')') {
8936                     ret=reg_node(pRExC_state, OPFAIL);
8937                     nextchar(pRExC_state);
8938                     return ret;
8939                 }
8940                 break;
8941             case '|':           /* (?|...) */
8942                 /* branch reset, behave like a (?:...) except that
8943                    buffers in alternations share the same numbers */
8944                 paren = ':'; 
8945                 after_freeze = freeze_paren = RExC_npar;
8946                 break;
8947             case ':':           /* (?:...) */
8948             case '>':           /* (?>...) */
8949                 break;
8950             case '$':           /* (?$...) */
8951             case '@':           /* (?@...) */
8952                 vFAIL2("Sequence (?%c...) not implemented", (int)paren);
8953                 break;
8954             case '#':           /* (?#...) */
8955                 /* XXX As soon as we disallow separating the '?' and '*' (by
8956                  * spaces or (?#...) comment), it is believed that this case
8957                  * will be unreachable and can be removed.  See
8958                  * [perl #117327] */
8959                 while (*RExC_parse && *RExC_parse != ')')
8960                     RExC_parse++;
8961                 if (*RExC_parse != ')')
8962                     FAIL("Sequence (?#... not terminated");
8963                 nextchar(pRExC_state);
8964                 *flagp = TRYAGAIN;
8965                 return NULL;
8966             case '0' :           /* (?0) */
8967             case 'R' :           /* (?R) */
8968                 if (*RExC_parse != ')')
8969                     FAIL("Sequence (?R) not terminated");
8970                 ret = reg_node(pRExC_state, GOSTART);
8971                 *flagp |= POSTPONED;
8972                 nextchar(pRExC_state);
8973                 return ret;
8974                 /*notreached*/
8975             { /* named and numeric backreferences */
8976                 I32 num;
8977             case '&':            /* (?&NAME) */
8978                 parse_start = RExC_parse - 1;
8979               named_recursion:
8980                 {
8981                     SV *sv_dat = reg_scan_name(pRExC_state,
8982                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
8983                      num = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
8984                 }
8985                 goto gen_recurse_regop;
8986                 assert(0); /* NOT REACHED */
8987             case '+':
8988                 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
8989                     RExC_parse++;
8990                     vFAIL("Illegal pattern");
8991                 }
8992                 goto parse_recursion;
8993                 /* NOT REACHED*/
8994             case '-': /* (?-1) */
8995                 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
8996                     RExC_parse--; /* rewind to let it be handled later */
8997                     goto parse_flags;
8998                 } 
8999                 /*FALLTHROUGH */
9000             case '1': case '2': case '3': case '4': /* (?1) */
9001             case '5': case '6': case '7': case '8': case '9':
9002                 RExC_parse--;
9003               parse_recursion:
9004                 num = atoi(RExC_parse);
9005                 parse_start = RExC_parse - 1; /* MJD */
9006                 if (*RExC_parse == '-')
9007                     RExC_parse++;
9008                 while (isDIGIT(*RExC_parse))
9009                         RExC_parse++;
9010                 if (*RExC_parse!=')') 
9011                     vFAIL("Expecting close bracket");
9012
9013               gen_recurse_regop:
9014                 if ( paren == '-' ) {
9015                     /*
9016                     Diagram of capture buffer numbering.
9017                     Top line is the normal capture buffer numbers
9018                     Bottom line is the negative indexing as from
9019                     the X (the (?-2))
9020
9021                     +   1 2    3 4 5 X          6 7
9022                        /(a(x)y)(a(b(c(?-2)d)e)f)(g(h))/
9023                     -   5 4    3 2 1 X          x x
9024
9025                     */
9026                     num = RExC_npar + num;
9027                     if (num < 1)  {
9028                         RExC_parse++;
9029                         vFAIL("Reference to nonexistent group");
9030                     }
9031                 } else if ( paren == '+' ) {
9032                     num = RExC_npar + num - 1;
9033                 }
9034
9035                 ret = reganode(pRExC_state, GOSUB, num);
9036                 if (!SIZE_ONLY) {
9037                     if (num > (I32)RExC_rx->nparens) {
9038                         RExC_parse++;
9039                         vFAIL("Reference to nonexistent group");
9040                     }
9041                     ARG2L_SET( ret, RExC_recurse_count++);
9042                     RExC_emit++;
9043                     DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
9044                         "Recurse #%"UVuf" to %"IVdf"\n", (UV)ARG(ret), (IV)ARG2L(ret)));
9045                 } else {
9046                     RExC_size++;
9047                 }
9048                 RExC_seen |= REG_SEEN_RECURSE;
9049                 Set_Node_Length(ret, 1 + regarglen[OP(ret)]); /* MJD */
9050                 Set_Node_Offset(ret, parse_start); /* MJD */
9051
9052                 *flagp |= POSTPONED;
9053                 nextchar(pRExC_state);
9054                 return ret;
9055             } /* named and numeric backreferences */
9056             assert(0); /* NOT REACHED */
9057
9058             case '?':           /* (??...) */
9059                 is_logical = 1;
9060                 if (*RExC_parse != '{') {
9061                     RExC_parse++;
9062                     vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
9063                     /*NOTREACHED*/
9064                 }
9065                 *flagp |= POSTPONED;
9066                 paren = *RExC_parse++;
9067                 /* FALL THROUGH */
9068             case '{':           /* (?{...}) */
9069             {
9070                 U32 n = 0;
9071                 struct reg_code_block *cb;
9072
9073                 RExC_seen_zerolen++;
9074
9075                 if (   !pRExC_state->num_code_blocks
9076                     || pRExC_state->code_index >= pRExC_state->num_code_blocks
9077                     || pRExC_state->code_blocks[pRExC_state->code_index].start
9078                         != (STRLEN)((RExC_parse -3 - (is_logical ? 1 : 0))
9079                             - RExC_start)
9080                 ) {
9081                     if (RExC_pm_flags & PMf_USE_RE_EVAL)
9082                         FAIL("panic: Sequence (?{...}): no code block found\n");
9083                     FAIL("Eval-group not allowed at runtime, use re 'eval'");
9084                 }
9085                 /* this is a pre-compiled code block (?{...}) */
9086                 cb = &pRExC_state->code_blocks[pRExC_state->code_index];
9087                 RExC_parse = RExC_start + cb->end;
9088                 if (!SIZE_ONLY) {
9089                     OP *o = cb->block;
9090                     if (cb->src_regex) {
9091                         n = add_data(pRExC_state, 2, "rl");
9092                         RExC_rxi->data->data[n] =
9093                             (void*)SvREFCNT_inc((SV*)cb->src_regex);
9094                         RExC_rxi->data->data[n+1] = (void*)o;
9095                     }
9096                     else {
9097                         n = add_data(pRExC_state, 1,
9098                                (RExC_pm_flags & PMf_HAS_CV) ? "L" : "l");
9099                         RExC_rxi->data->data[n] = (void*)o;
9100                     }
9101                 }
9102                 pRExC_state->code_index++;
9103                 nextchar(pRExC_state);
9104
9105                 if (is_logical) {
9106                     regnode *eval;
9107                     ret = reg_node(pRExC_state, LOGICAL);
9108                     eval = reganode(pRExC_state, EVAL, n);
9109                     if (!SIZE_ONLY) {
9110                         ret->flags = 2;
9111                         /* for later propagation into (??{}) return value */
9112                         eval->flags = (U8) (RExC_flags & RXf_PMf_COMPILETIME);
9113                     }
9114                     REGTAIL(pRExC_state, ret, eval);
9115                     /* deal with the length of this later - MJD */
9116                     return ret;
9117                 }
9118                 ret = reganode(pRExC_state, EVAL, n);
9119                 Set_Node_Length(ret, RExC_parse - parse_start + 1);
9120                 Set_Node_Offset(ret, parse_start);
9121                 return ret;
9122             }
9123             case '(':           /* (?(?{...})...) and (?(?=...)...) */
9124             {
9125                 int is_define= 0;
9126                 if (RExC_parse[0] == '?') {        /* (?(?...)) */
9127                     if (RExC_parse[1] == '=' || RExC_parse[1] == '!'
9128                         || RExC_parse[1] == '<'
9129                         || RExC_parse[1] == '{') { /* Lookahead or eval. */
9130                         I32 flag;
9131                         regnode *tail;
9132
9133                         ret = reg_node(pRExC_state, LOGICAL);
9134                         if (!SIZE_ONLY)
9135                             ret->flags = 1;
9136                         
9137                         tail = reg(pRExC_state, 1, &flag, depth+1);
9138                         if (flag & RESTART_UTF8) {
9139                             *flagp = RESTART_UTF8;
9140                             return NULL;
9141                         }
9142                         REGTAIL(pRExC_state, ret, tail);
9143                         goto insert_if;
9144                     }
9145                 }
9146                 else if ( RExC_parse[0] == '<'     /* (?(<NAME>)...) */
9147                          || RExC_parse[0] == '\'' ) /* (?('NAME')...) */
9148                 {
9149                     char ch = RExC_parse[0] == '<' ? '>' : '\'';
9150                     char *name_start= RExC_parse++;
9151                     U32 num = 0;
9152                     SV *sv_dat=reg_scan_name(pRExC_state,
9153                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
9154                     if (RExC_parse == name_start || *RExC_parse != ch)
9155                         vFAIL2("Sequence (?(%c... not terminated",
9156                             (ch == '>' ? '<' : ch));
9157                     RExC_parse++;
9158                     if (!SIZE_ONLY) {
9159                         num = add_data( pRExC_state, 1, "S" );
9160                         RExC_rxi->data->data[num]=(void*)sv_dat;
9161                         SvREFCNT_inc_simple_void(sv_dat);
9162                     }
9163                     ret = reganode(pRExC_state,NGROUPP,num);
9164                     goto insert_if_check_paren;
9165                 }
9166                 else if (RExC_parse[0] == 'D' &&
9167                          RExC_parse[1] == 'E' &&
9168                          RExC_parse[2] == 'F' &&
9169                          RExC_parse[3] == 'I' &&
9170                          RExC_parse[4] == 'N' &&
9171                          RExC_parse[5] == 'E')
9172                 {
9173                     ret = reganode(pRExC_state,DEFINEP,0);
9174                     RExC_parse +=6 ;
9175                     is_define = 1;
9176                     goto insert_if_check_paren;
9177                 }
9178                 else if (RExC_parse[0] == 'R') {
9179                     RExC_parse++;
9180                     parno = 0;
9181                     if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
9182                         parno = atoi(RExC_parse++);
9183                         while (isDIGIT(*RExC_parse))
9184                             RExC_parse++;
9185                     } else if (RExC_parse[0] == '&') {
9186                         SV *sv_dat;
9187                         RExC_parse++;
9188                         sv_dat = reg_scan_name(pRExC_state,
9189                             SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
9190                         parno = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
9191                     }
9192                     ret = reganode(pRExC_state,INSUBP,parno); 
9193                     goto insert_if_check_paren;
9194                 }
9195                 else if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
9196                     /* (?(1)...) */
9197                     char c;
9198                     parno = atoi(RExC_parse++);
9199
9200                     while (isDIGIT(*RExC_parse))
9201                         RExC_parse++;
9202                     ret = reganode(pRExC_state, GROUPP, parno);
9203
9204                  insert_if_check_paren:
9205                     if ((c = *nextchar(pRExC_state)) != ')')
9206                         vFAIL("Switch condition not recognized");
9207                   insert_if:
9208                     REGTAIL(pRExC_state, ret, reganode(pRExC_state, IFTHEN, 0));
9209                     br = regbranch(pRExC_state, &flags, 1,depth+1);
9210                     if (br == NULL) {
9211                         if (flags & RESTART_UTF8) {
9212                             *flagp = RESTART_UTF8;
9213                             return NULL;
9214                         }
9215                         FAIL2("panic: regbranch returned NULL, flags=%#"UVxf"",
9216                               (UV) flags);
9217                     } else
9218                         REGTAIL(pRExC_state, br, reganode(pRExC_state, LONGJMP, 0));
9219                     c = *nextchar(pRExC_state);
9220                     if (flags&HASWIDTH)
9221                         *flagp |= HASWIDTH;
9222                     if (c == '|') {
9223                         if (is_define) 
9224                             vFAIL("(?(DEFINE)....) does not allow branches");
9225                         lastbr = reganode(pRExC_state, IFTHEN, 0); /* Fake one for optimizer. */
9226                         if (!regbranch(pRExC_state, &flags, 1,depth+1)) {
9227                             if (flags & RESTART_UTF8) {
9228                                 *flagp = RESTART_UTF8;
9229                                 return NULL;
9230                             }
9231                             FAIL2("panic: regbranch returned NULL, flags=%#"UVxf"",
9232                                   (UV) flags);
9233                         }
9234                         REGTAIL(pRExC_state, ret, lastbr);
9235                         if (flags&HASWIDTH)
9236                             *flagp |= HASWIDTH;
9237                         c = *nextchar(pRExC_state);
9238                     }
9239                     else
9240                         lastbr = NULL;
9241                     if (c != ')')
9242                         vFAIL("Switch (?(condition)... contains too many branches");
9243                     ender = reg_node(pRExC_state, TAIL);
9244                     REGTAIL(pRExC_state, br, ender);
9245                     if (lastbr) {
9246                         REGTAIL(pRExC_state, lastbr, ender);
9247                         REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender);
9248                     }
9249                     else
9250                         REGTAIL(pRExC_state, ret, ender);
9251                     RExC_size++; /* XXX WHY do we need this?!!
9252                                     For large programs it seems to be required
9253                                     but I can't figure out why. -- dmq*/
9254                     return ret;
9255                 }
9256                 else {
9257                     vFAIL2("Unknown switch condition (?(%.2s", RExC_parse);
9258                 }
9259             }
9260             case '[':           /* (?[ ... ]) */
9261                 return handle_regex_sets(pRExC_state, NULL, flagp, depth,
9262                                          oregcomp_parse);
9263             case 0:
9264                 RExC_parse--; /* for vFAIL to print correctly */
9265                 vFAIL("Sequence (? incomplete");
9266                 break;
9267             default: /* e.g., (?i) */
9268                 --RExC_parse;
9269               parse_flags:
9270                 parse_lparen_question_flags(pRExC_state);
9271                 if (UCHARAT(RExC_parse) != ':') {
9272                     nextchar(pRExC_state);
9273                     *flagp = TRYAGAIN;
9274                     return NULL;
9275                 }
9276                 paren = ':';
9277                 nextchar(pRExC_state);
9278                 ret = NULL;
9279                 goto parse_rest;
9280             } /* end switch */
9281         }
9282         else {                  /* (...) */
9283           capturing_parens:
9284             parno = RExC_npar;
9285             RExC_npar++;
9286             
9287             ret = reganode(pRExC_state, OPEN, parno);
9288             if (!SIZE_ONLY ){
9289                 if (!RExC_nestroot) 
9290                     RExC_nestroot = parno;
9291                 if (RExC_seen & REG_SEEN_RECURSE
9292                     && !RExC_open_parens[parno-1])
9293                 {
9294                     DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
9295                         "Setting open paren #%"IVdf" to %d\n", 
9296                         (IV)parno, REG_NODE_NUM(ret)));
9297                     RExC_open_parens[parno-1]= ret;
9298                 }
9299             }
9300             Set_Node_Length(ret, 1); /* MJD */
9301             Set_Node_Offset(ret, RExC_parse); /* MJD */
9302             is_open = 1;
9303         }
9304     }
9305     else                        /* ! paren */
9306         ret = NULL;
9307    
9308    parse_rest:
9309     /* Pick up the branches, linking them together. */
9310     parse_start = RExC_parse;   /* MJD */
9311     br = regbranch(pRExC_state, &flags, 1,depth+1);
9312
9313     /*     branch_len = (paren != 0); */
9314
9315     if (br == NULL) {
9316         if (flags & RESTART_UTF8) {
9317             *flagp = RESTART_UTF8;
9318             return NULL;
9319         }
9320         FAIL2("panic: regbranch returned NULL, flags=%#"UVxf"", (UV) flags);
9321     }
9322     if (*RExC_parse == '|') {
9323         if (!SIZE_ONLY && RExC_extralen) {
9324             reginsert(pRExC_state, BRANCHJ, br, depth+1);
9325         }
9326         else {                  /* MJD */
9327             reginsert(pRExC_state, BRANCH, br, depth+1);
9328             Set_Node_Length(br, paren != 0);
9329             Set_Node_Offset_To_R(br-RExC_emit_start, parse_start-RExC_start);
9330         }
9331         have_branch = 1;
9332         if (SIZE_ONLY)
9333             RExC_extralen += 1;         /* For BRANCHJ-BRANCH. */
9334     }
9335     else if (paren == ':') {
9336         *flagp |= flags&SIMPLE;
9337     }
9338     if (is_open) {                              /* Starts with OPEN. */
9339         REGTAIL(pRExC_state, ret, br);          /* OPEN -> first. */
9340     }
9341     else if (paren != '?')              /* Not Conditional */
9342         ret = br;
9343     *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
9344     lastbr = br;
9345     while (*RExC_parse == '|') {
9346         if (!SIZE_ONLY && RExC_extralen) {
9347             ender = reganode(pRExC_state, LONGJMP,0);
9348             REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender); /* Append to the previous. */
9349         }
9350         if (SIZE_ONLY)
9351             RExC_extralen += 2;         /* Account for LONGJMP. */
9352         nextchar(pRExC_state);
9353         if (freeze_paren) {
9354             if (RExC_npar > after_freeze)
9355                 after_freeze = RExC_npar;
9356             RExC_npar = freeze_paren;       
9357         }
9358         br = regbranch(pRExC_state, &flags, 0, depth+1);
9359
9360         if (br == NULL) {
9361             if (flags & RESTART_UTF8) {
9362                 *flagp = RESTART_UTF8;
9363                 return NULL;
9364             }
9365             FAIL2("panic: regbranch returned NULL, flags=%#"UVxf"", (UV) flags);
9366         }
9367         REGTAIL(pRExC_state, lastbr, br);               /* BRANCH -> BRANCH. */
9368         lastbr = br;
9369         *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
9370     }
9371
9372     if (have_branch || paren != ':') {
9373         /* Make a closing node, and hook it on the end. */
9374         switch (paren) {
9375         case ':':
9376             ender = reg_node(pRExC_state, TAIL);
9377             break;
9378         case 1: case 2:
9379             ender = reganode(pRExC_state, CLOSE, parno);
9380             if (!SIZE_ONLY && RExC_seen & REG_SEEN_RECURSE) {
9381                 DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
9382                         "Setting close paren #%"IVdf" to %d\n", 
9383                         (IV)parno, REG_NODE_NUM(ender)));
9384                 RExC_close_parens[parno-1]= ender;
9385                 if (RExC_nestroot == parno) 
9386                     RExC_nestroot = 0;
9387             }       
9388             Set_Node_Offset(ender,RExC_parse+1); /* MJD */
9389             Set_Node_Length(ender,1); /* MJD */
9390             break;
9391         case '<':
9392         case ',':
9393         case '=':
9394         case '!':
9395             *flagp &= ~HASWIDTH;
9396             /* FALL THROUGH */
9397         case '>':
9398             ender = reg_node(pRExC_state, SUCCEED);
9399             break;
9400         case 0:
9401             ender = reg_node(pRExC_state, END);
9402             if (!SIZE_ONLY) {
9403                 assert(!RExC_opend); /* there can only be one! */
9404                 RExC_opend = ender;
9405             }
9406             break;
9407         }
9408         DEBUG_PARSE_r(if (!SIZE_ONLY) {
9409             SV * const mysv_val1=sv_newmortal();
9410             SV * const mysv_val2=sv_newmortal();
9411             DEBUG_PARSE_MSG("lsbr");
9412             regprop(RExC_rx, mysv_val1, lastbr);
9413             regprop(RExC_rx, mysv_val2, ender);
9414             PerlIO_printf(Perl_debug_log, "~ tying lastbr %s (%"IVdf") to ender %s (%"IVdf") offset %"IVdf"\n",
9415                           SvPV_nolen_const(mysv_val1),
9416                           (IV)REG_NODE_NUM(lastbr),
9417                           SvPV_nolen_const(mysv_val2),
9418                           (IV)REG_NODE_NUM(ender),
9419                           (IV)(ender - lastbr)
9420             );
9421         });
9422         REGTAIL(pRExC_state, lastbr, ender);
9423
9424         if (have_branch && !SIZE_ONLY) {
9425             char is_nothing= 1;
9426             if (depth==1)
9427                 RExC_seen |= REG_TOP_LEVEL_BRANCHES;
9428
9429             /* Hook the tails of the branches to the closing node. */
9430             for (br = ret; br; br = regnext(br)) {
9431                 const U8 op = PL_regkind[OP(br)];
9432                 if (op == BRANCH) {
9433                     REGTAIL_STUDY(pRExC_state, NEXTOPER(br), ender);
9434                     if (OP(NEXTOPER(br)) != NOTHING || regnext(NEXTOPER(br)) != ender)
9435                         is_nothing= 0;
9436                 }
9437                 else if (op == BRANCHJ) {
9438                     REGTAIL_STUDY(pRExC_state, NEXTOPER(NEXTOPER(br)), ender);
9439                     /* for now we always disable this optimisation * /
9440                     if (OP(NEXTOPER(NEXTOPER(br))) != NOTHING || regnext(NEXTOPER(NEXTOPER(br))) != ender)
9441                     */
9442                         is_nothing= 0;
9443                 }
9444             }
9445             if (is_nothing) {
9446                 br= PL_regkind[OP(ret)] != BRANCH ? regnext(ret) : ret;
9447                 DEBUG_PARSE_r(if (!SIZE_ONLY) {
9448                     SV * const mysv_val1=sv_newmortal();
9449                     SV * const mysv_val2=sv_newmortal();
9450                     DEBUG_PARSE_MSG("NADA");
9451                     regprop(RExC_rx, mysv_val1, ret);
9452                     regprop(RExC_rx, mysv_val2, ender);
9453                     PerlIO_printf(Perl_debug_log, "~ converting ret %s (%"IVdf") to ender %s (%"IVdf") offset %"IVdf"\n",
9454                                   SvPV_nolen_const(mysv_val1),
9455                                   (IV)REG_NODE_NUM(ret),
9456                                   SvPV_nolen_const(mysv_val2),
9457                                   (IV)REG_NODE_NUM(ender),
9458                                   (IV)(ender - ret)
9459                     );
9460                 });
9461                 OP(br)= NOTHING;
9462                 if (OP(ender) == TAIL) {
9463                     NEXT_OFF(br)= 0;
9464                     RExC_emit= br + 1;
9465                 } else {
9466                     regnode *opt;
9467                     for ( opt= br + 1; opt < ender ; opt++ )
9468                         OP(opt)= OPTIMIZED;
9469                     NEXT_OFF(br)= ender - br;
9470                 }
9471             }
9472         }
9473     }
9474
9475     {
9476         const char *p;
9477         static const char parens[] = "=!<,>";
9478
9479         if (paren && (p = strchr(parens, paren))) {
9480             U8 node = ((p - parens) % 2) ? UNLESSM : IFMATCH;
9481             int flag = (p - parens) > 1;
9482
9483             if (paren == '>')
9484                 node = SUSPEND, flag = 0;
9485             reginsert(pRExC_state, node,ret, depth+1);
9486             Set_Node_Cur_Length(ret, parse_start);
9487             Set_Node_Offset(ret, parse_start + 1);
9488             ret->flags = flag;
9489             REGTAIL_STUDY(pRExC_state, ret, reg_node(pRExC_state, TAIL));
9490         }
9491     }
9492
9493     /* Check for proper termination. */
9494     if (paren) {
9495         /* restore original flags, but keep (?p) */
9496         RExC_flags = oregflags | (RExC_flags & RXf_PMf_KEEPCOPY);
9497         if (RExC_parse >= RExC_end || *nextchar(pRExC_state) != ')') {
9498             RExC_parse = oregcomp_parse;
9499             vFAIL("Unmatched (");
9500         }
9501     }
9502     else if (!paren && RExC_parse < RExC_end) {
9503         if (*RExC_parse == ')') {
9504             RExC_parse++;
9505             vFAIL("Unmatched )");
9506         }
9507         else
9508             FAIL("Junk on end of regexp");      /* "Can't happen". */
9509         assert(0); /* NOTREACHED */
9510     }
9511
9512     if (RExC_in_lookbehind) {
9513         RExC_in_lookbehind--;
9514     }
9515     if (after_freeze > RExC_npar)
9516         RExC_npar = after_freeze;
9517     return(ret);
9518 }
9519
9520 /*
9521  - regbranch - one alternative of an | operator
9522  *
9523  * Implements the concatenation operator.
9524  *
9525  * Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan needs to be
9526  * restarted.
9527  */
9528 STATIC regnode *
9529 S_regbranch(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, I32 first, U32 depth)
9530 {
9531     dVAR;
9532     regnode *ret;
9533     regnode *chain = NULL;
9534     regnode *latest;
9535     I32 flags = 0, c = 0;
9536     GET_RE_DEBUG_FLAGS_DECL;
9537
9538     PERL_ARGS_ASSERT_REGBRANCH;
9539
9540     DEBUG_PARSE("brnc");
9541
9542     if (first)
9543         ret = NULL;
9544     else {
9545         if (!SIZE_ONLY && RExC_extralen)
9546             ret = reganode(pRExC_state, BRANCHJ,0);
9547         else {
9548             ret = reg_node(pRExC_state, BRANCH);
9549             Set_Node_Length(ret, 1);
9550         }
9551     }
9552
9553     if (!first && SIZE_ONLY)
9554         RExC_extralen += 1;                     /* BRANCHJ */
9555
9556     *flagp = WORST;                     /* Tentatively. */
9557
9558     RExC_parse--;
9559     nextchar(pRExC_state);
9560     while (RExC_parse < RExC_end && *RExC_parse != '|' && *RExC_parse != ')') {
9561         flags &= ~TRYAGAIN;
9562         latest = regpiece(pRExC_state, &flags,depth+1);
9563         if (latest == NULL) {
9564             if (flags & TRYAGAIN)
9565                 continue;
9566             if (flags & RESTART_UTF8) {
9567                 *flagp = RESTART_UTF8;
9568                 return NULL;
9569             }
9570             FAIL2("panic: regpiece returned NULL, flags=%#"UVxf"", (UV) flags);
9571         }
9572         else if (ret == NULL)
9573             ret = latest;
9574         *flagp |= flags&(HASWIDTH|POSTPONED);
9575         if (chain == NULL)      /* First piece. */
9576             *flagp |= flags&SPSTART;
9577         else {
9578             RExC_naughty++;
9579             REGTAIL(pRExC_state, chain, latest);
9580         }
9581         chain = latest;
9582         c++;
9583     }
9584     if (chain == NULL) {        /* Loop ran zero times. */
9585         chain = reg_node(pRExC_state, NOTHING);
9586         if (ret == NULL)
9587             ret = chain;
9588     }
9589     if (c == 1) {
9590         *flagp |= flags&SIMPLE;
9591     }
9592
9593     return ret;
9594 }
9595
9596 /*
9597  - regpiece - something followed by possible [*+?]
9598  *
9599  * Note that the branching code sequences used for ? and the general cases
9600  * of * and + are somewhat optimized:  they use the same NOTHING node as
9601  * both the endmarker for their branch list and the body of the last branch.
9602  * It might seem that this node could be dispensed with entirely, but the
9603  * endmarker role is not redundant.
9604  *
9605  * Returns NULL, setting *flagp to TRYAGAIN if regatom() returns NULL with
9606  * TRYAGAIN.
9607  * Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan needs to be
9608  * restarted.
9609  */
9610 STATIC regnode *
9611 S_regpiece(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
9612 {
9613     dVAR;
9614     regnode *ret;
9615     char op;
9616     char *next;
9617     I32 flags;
9618     const char * const origparse = RExC_parse;
9619     I32 min;
9620     I32 max = REG_INFTY;
9621 #ifdef RE_TRACK_PATTERN_OFFSETS
9622     char *parse_start;
9623 #endif
9624     const char *maxpos = NULL;
9625
9626     /* Save the original in case we change the emitted regop to a FAIL. */
9627     regnode * const orig_emit = RExC_emit;
9628
9629     GET_RE_DEBUG_FLAGS_DECL;
9630
9631     PERL_ARGS_ASSERT_REGPIECE;
9632
9633     DEBUG_PARSE("piec");
9634
9635     ret = regatom(pRExC_state, &flags,depth+1);
9636     if (ret == NULL) {
9637         if (flags & (TRYAGAIN|RESTART_UTF8))
9638             *flagp |= flags & (TRYAGAIN|RESTART_UTF8);
9639         else
9640             FAIL2("panic: regatom returned NULL, flags=%#"UVxf"", (UV) flags);
9641         return(NULL);
9642     }
9643
9644     op = *RExC_parse;
9645
9646     if (op == '{' && regcurly(RExC_parse, FALSE)) {
9647         maxpos = NULL;
9648 #ifdef RE_TRACK_PATTERN_OFFSETS
9649         parse_start = RExC_parse; /* MJD */
9650 #endif
9651         next = RExC_parse + 1;
9652         while (isDIGIT(*next) || *next == ',') {
9653             if (*next == ',') {
9654                 if (maxpos)
9655                     break;
9656                 else
9657                     maxpos = next;
9658             }
9659             next++;
9660         }
9661         if (*next == '}') {             /* got one */
9662             if (!maxpos)
9663                 maxpos = next;
9664             RExC_parse++;
9665             min = atoi(RExC_parse);
9666             if (*maxpos == ',')
9667                 maxpos++;
9668             else
9669                 maxpos = RExC_parse;
9670             max = atoi(maxpos);
9671             if (!max && *maxpos != '0')
9672                 max = REG_INFTY;                /* meaning "infinity" */
9673             else if (max >= REG_INFTY)
9674                 vFAIL2("Quantifier in {,} bigger than %d", REG_INFTY - 1);
9675             RExC_parse = next;
9676             nextchar(pRExC_state);
9677             if (max < min) {    /* If can't match, warn and optimize to fail
9678                                    unconditionally */
9679                 if (SIZE_ONLY) {
9680                     ckWARNreg(RExC_parse, "Quantifier {n,m} with n > m can't match");
9681
9682                     /* We can't back off the size because we have to reserve
9683                      * enough space for all the things we are about to throw
9684                      * away, but we can shrink it by the ammount we are about
9685                      * to re-use here */
9686                     RExC_size = PREVOPER(RExC_size) - regarglen[(U8)OPFAIL];
9687                 }
9688                 else {
9689                     RExC_emit = orig_emit;
9690                 }
9691                 ret = reg_node(pRExC_state, OPFAIL);
9692                 return ret;
9693             }
9694             else if (max == 0) {    /* replace {0} with a nothing node */
9695                 if (SIZE_ONLY) {
9696                     RExC_size = PREVOPER(RExC_size) - regarglen[(U8)NOTHING];
9697                 }
9698                 else {
9699                     RExC_emit = orig_emit;
9700                 }
9701                 ret = reg_node(pRExC_state, NOTHING);
9702                 return ret;
9703             }
9704
9705         do_curly:
9706             if ((flags&SIMPLE)) {
9707                 RExC_naughty += 2 + RExC_naughty / 2;
9708                 reginsert(pRExC_state, CURLY, ret, depth+1);
9709                 Set_Node_Offset(ret, parse_start+1); /* MJD */
9710                 Set_Node_Cur_Length(ret, parse_start);
9711             }
9712             else {
9713                 regnode * const w = reg_node(pRExC_state, WHILEM);
9714
9715                 w->flags = 0;
9716                 REGTAIL(pRExC_state, ret, w);
9717                 if (!SIZE_ONLY && RExC_extralen) {
9718                     reginsert(pRExC_state, LONGJMP,ret, depth+1);
9719                     reginsert(pRExC_state, NOTHING,ret, depth+1);
9720                     NEXT_OFF(ret) = 3;  /* Go over LONGJMP. */
9721                 }
9722                 reginsert(pRExC_state, CURLYX,ret, depth+1);
9723                                 /* MJD hk */
9724                 Set_Node_Offset(ret, parse_start+1);
9725                 Set_Node_Length(ret,
9726                                 op == '{' ? (RExC_parse - parse_start) : 1);
9727
9728                 if (!SIZE_ONLY && RExC_extralen)
9729                     NEXT_OFF(ret) = 3;  /* Go over NOTHING to LONGJMP. */
9730                 REGTAIL(pRExC_state, ret, reg_node(pRExC_state, NOTHING));
9731                 if (SIZE_ONLY)
9732                     RExC_whilem_seen++, RExC_extralen += 3;
9733                 RExC_naughty += 4 + RExC_naughty;       /* compound interest */
9734             }
9735             ret->flags = 0;
9736
9737             if (min > 0)
9738                 *flagp = WORST;
9739             if (max > 0)
9740                 *flagp |= HASWIDTH;
9741             if (!SIZE_ONLY) {
9742                 ARG1_SET(ret, (U16)min);
9743                 ARG2_SET(ret, (U16)max);
9744             }
9745
9746             goto nest_check;
9747         }
9748     }
9749
9750     if (!ISMULT1(op)) {
9751         *flagp = flags;
9752         return(ret);
9753     }
9754
9755 #if 0                           /* Now runtime fix should be reliable. */
9756
9757     /* if this is reinstated, don't forget to put this back into perldiag:
9758
9759             =item Regexp *+ operand could be empty at {#} in regex m/%s/
9760
9761            (F) The part of the regexp subject to either the * or + quantifier
9762            could match an empty string. The {#} shows in the regular
9763            expression about where the problem was discovered.
9764
9765     */
9766
9767     if (!(flags&HASWIDTH) && op != '?')
9768       vFAIL("Regexp *+ operand could be empty");
9769 #endif
9770
9771 #ifdef RE_TRACK_PATTERN_OFFSETS
9772     parse_start = RExC_parse;
9773 #endif
9774     nextchar(pRExC_state);
9775
9776     *flagp = (op != '+') ? (WORST|SPSTART|HASWIDTH) : (WORST|HASWIDTH);
9777
9778     if (op == '*' && (flags&SIMPLE)) {
9779         reginsert(pRExC_state, STAR, ret, depth+1);
9780         ret->flags = 0;
9781         RExC_naughty += 4;
9782     }
9783     else if (op == '*') {
9784         min = 0;
9785         goto do_curly;
9786     }
9787     else if (op == '+' && (flags&SIMPLE)) {
9788         reginsert(pRExC_state, PLUS, ret, depth+1);
9789         ret->flags = 0;
9790         RExC_naughty += 3;
9791     }
9792     else if (op == '+') {
9793         min = 1;
9794         goto do_curly;
9795     }
9796     else if (op == '?') {
9797         min = 0; max = 1;
9798         goto do_curly;
9799     }
9800   nest_check:
9801     if (!SIZE_ONLY && !(flags&(HASWIDTH|POSTPONED)) && max > REG_INFTY/3) {
9802         SAVEFREESV(RExC_rx_sv); /* in case of fatal warnings */
9803         ckWARN3reg(RExC_parse,
9804                    "%.*s matches null string many times",
9805                    (int)(RExC_parse >= origparse ? RExC_parse - origparse : 0),
9806                    origparse);
9807         (void)ReREFCNT_inc(RExC_rx_sv);
9808     }
9809
9810     if (RExC_parse < RExC_end && *RExC_parse == '?') {
9811         nextchar(pRExC_state);
9812         reginsert(pRExC_state, MINMOD, ret, depth+1);
9813         REGTAIL(pRExC_state, ret, ret + NODE_STEP_REGNODE);
9814     }
9815 #ifndef REG_ALLOW_MINMOD_SUSPEND
9816     else
9817 #endif
9818     if (RExC_parse < RExC_end && *RExC_parse == '+') {
9819         regnode *ender;
9820         nextchar(pRExC_state);
9821         ender = reg_node(pRExC_state, SUCCEED);
9822         REGTAIL(pRExC_state, ret, ender);
9823         reginsert(pRExC_state, SUSPEND, ret, depth+1);
9824         ret->flags = 0;
9825         ender = reg_node(pRExC_state, TAIL);
9826         REGTAIL(pRExC_state, ret, ender);
9827         /*ret= ender;*/
9828     }
9829
9830     if (RExC_parse < RExC_end && ISMULT2(RExC_parse)) {
9831         RExC_parse++;
9832         vFAIL("Nested quantifiers");
9833     }
9834
9835     return(ret);
9836 }
9837
9838 STATIC bool
9839 S_grok_bslash_N(pTHX_ RExC_state_t *pRExC_state, regnode** node_p, UV *valuep, I32 *flagp, U32 depth, bool in_char_class,
9840         const bool strict   /* Apply stricter parsing rules? */
9841     )
9842 {
9843    
9844  /* This is expected to be called by a parser routine that has recognized '\N'
9845    and needs to handle the rest. RExC_parse is expected to point at the first
9846    char following the N at the time of the call.  On successful return,
9847    RExC_parse has been updated to point to just after the sequence identified
9848    by this routine, and <*flagp> has been updated.
9849
9850    The \N may be inside (indicated by the boolean <in_char_class>) or outside a
9851    character class.
9852
9853    \N may begin either a named sequence, or if outside a character class, mean
9854    to match a non-newline.  For non single-quoted regexes, the tokenizer has
9855    attempted to decide which, and in the case of a named sequence, converted it
9856    into one of the forms: \N{} (if the sequence is null), or \N{U+c1.c2...},
9857    where c1... are the characters in the sequence.  For single-quoted regexes,
9858    the tokenizer passes the \N sequence through unchanged; this code will not
9859    attempt to determine this nor expand those, instead raising a syntax error.
9860    The net effect is that if the beginning of the passed-in pattern isn't '{U+'
9861    or there is no '}', it signals that this \N occurrence means to match a
9862    non-newline.
9863
9864    Only the \N{U+...} form should occur in a character class, for the same
9865    reason that '.' inside a character class means to just match a period: it
9866    just doesn't make sense.
9867
9868    The function raises an error (via vFAIL), and doesn't return for various
9869    syntax errors.  Otherwise it returns TRUE and sets <node_p> or <valuep> on
9870    success; it returns FALSE otherwise. Returns FALSE, setting *flagp to
9871    RESTART_UTF8 if the sizing scan needs to be restarted. Such a restart is
9872    only possible if node_p is non-NULL.
9873
9874
9875    If <valuep> is non-null, it means the caller can accept an input sequence
9876    consisting of a just a single code point; <*valuep> is set to that value
9877    if the input is such.
9878
9879    If <node_p> is non-null it signifies that the caller can accept any other
9880    legal sequence (i.e., one that isn't just a single code point).  <*node_p>
9881    is set as follows:
9882     1) \N means not-a-NL: points to a newly created REG_ANY node;
9883     2) \N{}:              points to a new NOTHING node;
9884     3) otherwise:         points to a new EXACT node containing the resolved
9885                           string.
9886    Note that FALSE is returned for single code point sequences if <valuep> is
9887    null.
9888  */
9889
9890     char * endbrace;    /* '}' following the name */
9891     char* p;
9892     char *endchar;      /* Points to '.' or '}' ending cur char in the input
9893                            stream */
9894     bool has_multiple_chars; /* true if the input stream contains a sequence of
9895                                 more than one character */
9896
9897     GET_RE_DEBUG_FLAGS_DECL;
9898  
9899     PERL_ARGS_ASSERT_GROK_BSLASH_N;
9900
9901     GET_RE_DEBUG_FLAGS;
9902
9903     assert(cBOOL(node_p) ^ cBOOL(valuep));  /* Exactly one should be set */
9904
9905     /* The [^\n] meaning of \N ignores spaces and comments under the /x
9906      * modifier.  The other meaning does not */
9907     p = (RExC_flags & RXf_PMf_EXTENDED)
9908         ? regwhite( pRExC_state, RExC_parse )
9909         : RExC_parse;
9910
9911     /* Disambiguate between \N meaning a named character versus \N meaning
9912      * [^\n].  The former is assumed when it can't be the latter. */
9913     if (*p != '{' || regcurly(p, FALSE)) {
9914         RExC_parse = p;
9915         if (! node_p) {
9916             /* no bare \N in a charclass */
9917             if (in_char_class) {
9918                 vFAIL("\\N in a character class must be a named character: \\N{...}");
9919             }
9920             return FALSE;
9921         }
9922         nextchar(pRExC_state);
9923         *node_p = reg_node(pRExC_state, REG_ANY);
9924         *flagp |= HASWIDTH|SIMPLE;
9925         RExC_naughty++;
9926         RExC_parse--;
9927         Set_Node_Length(*node_p, 1); /* MJD */
9928         return TRUE;
9929     }
9930
9931     /* Here, we have decided it should be a named character or sequence */
9932
9933     /* The test above made sure that the next real character is a '{', but
9934      * under the /x modifier, it could be separated by space (or a comment and
9935      * \n) and this is not allowed (for consistency with \x{...} and the
9936      * tokenizer handling of \N{NAME}). */
9937     if (*RExC_parse != '{') {
9938         vFAIL("Missing braces on \\N{}");
9939     }
9940
9941     RExC_parse++;       /* Skip past the '{' */
9942
9943     if (! (endbrace = strchr(RExC_parse, '}')) /* no trailing brace */
9944         || ! (endbrace == RExC_parse            /* nothing between the {} */
9945               || (endbrace - RExC_parse >= 2    /* U+ (bad hex is checked below */
9946                   && strnEQ(RExC_parse, "U+", 2)))) /* for a better error msg) */
9947     {
9948         if (endbrace) RExC_parse = endbrace;    /* position msg's '<--HERE' */
9949         vFAIL("\\N{NAME} must be resolved by the lexer");
9950     }
9951
9952     if (endbrace == RExC_parse) {   /* empty: \N{} */
9953         bool ret = TRUE;
9954         if (node_p) {
9955             *node_p = reg_node(pRExC_state,NOTHING);
9956         }
9957         else if (in_char_class) {
9958             if (SIZE_ONLY && in_char_class) {
9959                 if (strict) {
9960                     RExC_parse++;   /* Position after the "}" */
9961                     vFAIL("Zero length \\N{}");
9962                 }
9963                 else {
9964                     ckWARNreg(RExC_parse,
9965                               "Ignoring zero length \\N{} in character class");
9966                 }
9967             }
9968             ret = FALSE;
9969         }
9970         else {
9971             return FALSE;
9972         }
9973         nextchar(pRExC_state);
9974         return ret;
9975     }
9976
9977     RExC_uni_semantics = 1; /* Unicode named chars imply Unicode semantics */
9978     RExC_parse += 2;    /* Skip past the 'U+' */
9979
9980     endchar = RExC_parse + strcspn(RExC_parse, ".}");
9981
9982     /* Code points are separated by dots.  If none, there is only one code
9983      * point, and is terminated by the brace */
9984     has_multiple_chars = (endchar < endbrace);
9985
9986     if (valuep && (! has_multiple_chars || in_char_class)) {
9987         /* We only pay attention to the first char of
9988         multichar strings being returned in char classes. I kinda wonder
9989         if this makes sense as it does change the behaviour
9990         from earlier versions, OTOH that behaviour was broken
9991         as well. XXX Solution is to recharacterize as
9992         [rest-of-class]|multi1|multi2... */
9993
9994         STRLEN length_of_hex = (STRLEN)(endchar - RExC_parse);
9995         I32 grok_hex_flags = PERL_SCAN_ALLOW_UNDERSCORES
9996             | PERL_SCAN_DISALLOW_PREFIX
9997             | (SIZE_ONLY ? PERL_SCAN_SILENT_ILLDIGIT : 0);
9998
9999         *valuep = grok_hex(RExC_parse, &length_of_hex, &grok_hex_flags, NULL);
10000
10001         /* The tokenizer should have guaranteed validity, but it's possible to
10002          * bypass it by using single quoting, so check */
10003         if (length_of_hex == 0
10004             || length_of_hex != (STRLEN)(endchar - RExC_parse) )
10005         {
10006             RExC_parse += length_of_hex;        /* Includes all the valid */
10007             RExC_parse += (RExC_orig_utf8)      /* point to after 1st invalid */
10008                             ? UTF8SKIP(RExC_parse)
10009                             : 1;
10010             /* Guard against malformed utf8 */
10011             if (RExC_parse >= endchar) {
10012                 RExC_parse = endchar;
10013             }
10014             vFAIL("Invalid hexadecimal number in \\N{U+...}");
10015         }
10016
10017         if (in_char_class && has_multiple_chars) {
10018             if (strict) {
10019                 RExC_parse = endbrace;
10020                 vFAIL("\\N{} in character class restricted to one character");
10021             }
10022             else {
10023                 ckWARNreg(endchar, "Using just the first character returned by \\N{} in character class");
10024             }
10025         }
10026
10027         RExC_parse = endbrace + 1;
10028     }
10029     else if (! node_p || ! has_multiple_chars) {
10030
10031         /* Here, the input is legal, but not according to the caller's
10032          * options.  We fail without advancing the parse, so that the
10033          * caller can try again */
10034         RExC_parse = p;
10035         return FALSE;
10036     }
10037     else {
10038
10039         /* What is done here is to convert this to a sub-pattern of the form
10040          * (?:\x{char1}\x{char2}...)
10041          * and then call reg recursively.  That way, it retains its atomicness,
10042          * while not having to worry about special handling that some code
10043          * points may have.  toke.c has converted the original Unicode values
10044          * to native, so that we can just pass on the hex values unchanged.  We
10045          * do have to set a flag to keep recoding from happening in the
10046          * recursion */
10047
10048         SV * substitute_parse = newSVpvn_flags("?:", 2, SVf_UTF8|SVs_TEMP);
10049         STRLEN len;
10050         char *orig_end = RExC_end;
10051         I32 flags;
10052
10053         while (RExC_parse < endbrace) {
10054
10055             /* Convert to notation the rest of the code understands */
10056             sv_catpv(substitute_parse, "\\x{");
10057             sv_catpvn(substitute_parse, RExC_parse, endchar - RExC_parse);
10058             sv_catpv(substitute_parse, "}");
10059
10060             /* Point to the beginning of the next character in the sequence. */
10061             RExC_parse = endchar + 1;
10062             endchar = RExC_parse + strcspn(RExC_parse, ".}");
10063         }
10064         sv_catpv(substitute_parse, ")");
10065
10066         RExC_parse = SvPV(substitute_parse, len);
10067
10068         /* Don't allow empty number */
10069         if (len < 8) {
10070             vFAIL("Invalid hexadecimal number in \\N{U+...}");
10071         }
10072         RExC_end = RExC_parse + len;
10073
10074         /* The values are Unicode, and therefore not subject to recoding */
10075         RExC_override_recoding = 1;
10076
10077         if (!(*node_p = reg(pRExC_state, 1, &flags, depth+1))) {
10078             if (flags & RESTART_UTF8) {
10079                 *flagp = RESTART_UTF8;
10080                 return FALSE;
10081             }
10082             FAIL2("panic: reg returned NULL to grok_bslash_N, flags=%#"UVxf"",
10083                   (UV) flags);
10084         } 
10085         *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
10086
10087         RExC_parse = endbrace;
10088         RExC_end = orig_end;
10089         RExC_override_recoding = 0;
10090
10091         nextchar(pRExC_state);
10092     }
10093
10094     return TRUE;
10095 }
10096
10097
10098 /*
10099  * reg_recode
10100  *
10101  * It returns the code point in utf8 for the value in *encp.
10102  *    value: a code value in the source encoding
10103  *    encp:  a pointer to an Encode object
10104  *
10105  * If the result from Encode is not a single character,
10106  * it returns U+FFFD (Replacement character) and sets *encp to NULL.
10107  */
10108 STATIC UV
10109 S_reg_recode(pTHX_ const char value, SV **encp)
10110 {
10111     STRLEN numlen = 1;
10112     SV * const sv = newSVpvn_flags(&value, numlen, SVs_TEMP);
10113     const char * const s = *encp ? sv_recode_to_utf8(sv, *encp) : SvPVX(sv);
10114     const STRLEN newlen = SvCUR(sv);
10115     UV uv = UNICODE_REPLACEMENT;
10116
10117     PERL_ARGS_ASSERT_REG_RECODE;
10118
10119     if (newlen)
10120         uv = SvUTF8(sv)
10121              ? utf8n_to_uvchr((U8*)s, newlen, &numlen, UTF8_ALLOW_DEFAULT)
10122              : *(U8*)s;
10123
10124     if (!newlen || numlen != newlen) {
10125         uv = UNICODE_REPLACEMENT;
10126         *encp = NULL;
10127     }
10128     return uv;
10129 }
10130
10131 PERL_STATIC_INLINE U8
10132 S_compute_EXACTish(pTHX_ RExC_state_t *pRExC_state)
10133 {
10134     U8 op;
10135
10136     PERL_ARGS_ASSERT_COMPUTE_EXACTISH;
10137
10138     if (! FOLD) {
10139         return EXACT;
10140     }
10141
10142     op = get_regex_charset(RExC_flags);
10143     if (op >= REGEX_ASCII_RESTRICTED_CHARSET) {
10144         op--; /* /a is same as /u, and map /aa's offset to what /a's would have
10145                  been, so there is no hole */
10146     }
10147
10148     return op + EXACTF;
10149 }
10150
10151 PERL_STATIC_INLINE void
10152 S_alloc_maybe_populate_EXACT(pTHX_ RExC_state_t *pRExC_state, regnode *node, I32* flagp, STRLEN len, UV code_point)
10153 {
10154     /* This knows the details about sizing an EXACTish node, setting flags for
10155      * it (by setting <*flagp>, and potentially populating it with a single
10156      * character.
10157      *
10158      * If <len> (the length in bytes) is non-zero, this function assumes that
10159      * the node has already been populated, and just does the sizing.  In this
10160      * case <code_point> should be the final code point that has already been
10161      * placed into the node.  This value will be ignored except that under some
10162      * circumstances <*flagp> is set based on it.
10163      *
10164      * If <len> is zero, the function assumes that the node is to contain only
10165      * the single character given by <code_point> and calculates what <len>
10166      * should be.  In pass 1, it sizes the node appropriately.  In pass 2, it
10167      * additionally will populate the node's STRING with <code_point>, if <len>
10168      * is 0.  In both cases <*flagp> is appropriately set
10169      *
10170      * It knows that under FOLD, the Latin Sharp S and UTF characters above
10171      * 255, must be folded (the former only when the rules indicate it can
10172      * match 'ss') */
10173
10174     bool len_passed_in = cBOOL(len != 0);
10175     U8 character[UTF8_MAXBYTES_CASE+1];
10176
10177     PERL_ARGS_ASSERT_ALLOC_MAYBE_POPULATE_EXACT;
10178
10179     if (! len_passed_in) {
10180         if (UTF) {
10181             if (FOLD && (! LOC || code_point > 255)) {
10182                 _to_uni_fold_flags(NATIVE_TO_UNI(code_point),
10183                                    character,
10184                                    &len,
10185                                    FOLD_FLAGS_FULL | ((LOC)
10186                                                      ? FOLD_FLAGS_LOCALE
10187                                                      : (ASCII_FOLD_RESTRICTED)
10188                                                        ? FOLD_FLAGS_NOMIX_ASCII
10189                                                        : 0));
10190             }
10191             else {
10192                 uvchr_to_utf8( character, code_point);
10193                 len = UTF8SKIP(character);
10194             }
10195         }
10196         else if (! FOLD
10197                  || code_point != LATIN_SMALL_LETTER_SHARP_S
10198                  || ASCII_FOLD_RESTRICTED
10199                  || ! AT_LEAST_UNI_SEMANTICS)
10200         {
10201             *character = (U8) code_point;
10202             len = 1;
10203         }
10204         else {
10205             *character = 's';
10206             *(character + 1) = 's';
10207             len = 2;
10208         }
10209     }
10210
10211     if (SIZE_ONLY) {
10212         RExC_size += STR_SZ(len);
10213     }
10214     else {
10215         RExC_emit += STR_SZ(len);
10216         STR_LEN(node) = len;
10217         if (! len_passed_in) {
10218             Copy((char *) character, STRING(node), len, char);
10219         }
10220     }
10221
10222     *flagp |= HASWIDTH;
10223
10224     /* A single character node is SIMPLE, except for the special-cased SHARP S
10225      * under /di. */
10226     if ((len == 1 || (UTF && len == UNISKIP(code_point)))
10227         && (code_point != LATIN_SMALL_LETTER_SHARP_S
10228             || ! FOLD || ! DEPENDS_SEMANTICS))
10229     {
10230         *flagp |= SIMPLE;
10231     }
10232 }
10233
10234 /*
10235  - regatom - the lowest level
10236
10237    Try to identify anything special at the start of the pattern. If there
10238    is, then handle it as required. This may involve generating a single regop,
10239    such as for an assertion; or it may involve recursing, such as to
10240    handle a () structure.
10241
10242    If the string doesn't start with something special then we gobble up
10243    as much literal text as we can.
10244
10245    Once we have been able to handle whatever type of thing started the
10246    sequence, we return.
10247
10248    Note: we have to be careful with escapes, as they can be both literal
10249    and special, and in the case of \10 and friends, context determines which.
10250
10251    A summary of the code structure is:
10252
10253    switch (first_byte) {
10254         cases for each special:
10255             handle this special;
10256             break;
10257         case '\\':
10258             switch (2nd byte) {
10259                 cases for each unambiguous special:
10260                     handle this special;
10261                     break;
10262                 cases for each ambigous special/literal:
10263                     disambiguate;
10264                     if (special)  handle here
10265                     else goto defchar;
10266                 default: // unambiguously literal:
10267                     goto defchar;
10268             }
10269         default:  // is a literal char
10270             // FALL THROUGH
10271         defchar:
10272             create EXACTish node for literal;
10273             while (more input and node isn't full) {
10274                 switch (input_byte) {
10275                    cases for each special;
10276                        make sure parse pointer is set so that the next call to
10277                            regatom will see this special first
10278                        goto loopdone; // EXACTish node terminated by prev. char
10279                    default:
10280                        append char to EXACTISH node;
10281                 }
10282                 get next input byte;
10283             }
10284         loopdone:
10285    }
10286    return the generated node;
10287
10288    Specifically there are two separate switches for handling
10289    escape sequences, with the one for handling literal escapes requiring
10290    a dummy entry for all of the special escapes that are actually handled
10291    by the other.
10292
10293    Returns NULL, setting *flagp to TRYAGAIN if reg() returns NULL with
10294    TRYAGAIN.  
10295    Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan needs to be
10296    restarted.
10297    Otherwise does not return NULL.
10298 */
10299
10300 STATIC regnode *
10301 S_regatom(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
10302 {
10303     dVAR;
10304     regnode *ret = NULL;
10305     I32 flags = 0;
10306     char *parse_start = RExC_parse;
10307     U8 op;
10308     int invert = 0;
10309
10310     GET_RE_DEBUG_FLAGS_DECL;
10311
10312     *flagp = WORST;             /* Tentatively. */
10313
10314     DEBUG_PARSE("atom");
10315
10316     PERL_ARGS_ASSERT_REGATOM;
10317
10318 tryagain:
10319     switch ((U8)*RExC_parse) {
10320     case '^':
10321         RExC_seen_zerolen++;
10322         nextchar(pRExC_state);
10323         if (RExC_flags & RXf_PMf_MULTILINE)
10324             ret = reg_node(pRExC_state, MBOL);
10325         else if (RExC_flags & RXf_PMf_SINGLELINE)
10326             ret = reg_node(pRExC_state, SBOL);
10327         else
10328             ret = reg_node(pRExC_state, BOL);
10329         Set_Node_Length(ret, 1); /* MJD */
10330         break;
10331     case '$':
10332         nextchar(pRExC_state);
10333         if (*RExC_parse)
10334             RExC_seen_zerolen++;
10335         if (RExC_flags & RXf_PMf_MULTILINE)
10336             ret = reg_node(pRExC_state, MEOL);
10337         else if (RExC_flags & RXf_PMf_SINGLELINE)
10338             ret = reg_node(pRExC_state, SEOL);
10339         else
10340             ret = reg_node(pRExC_state, EOL);
10341         Set_Node_Length(ret, 1); /* MJD */
10342         break;
10343     case '.':
10344         nextchar(pRExC_state);
10345         if (RExC_flags & RXf_PMf_SINGLELINE)
10346             ret = reg_node(pRExC_state, SANY);
10347         else
10348             ret = reg_node(pRExC_state, REG_ANY);
10349         *flagp |= HASWIDTH|SIMPLE;
10350         RExC_naughty++;
10351         Set_Node_Length(ret, 1); /* MJD */
10352         break;
10353     case '[':
10354     {
10355         char * const oregcomp_parse = ++RExC_parse;
10356         ret = regclass(pRExC_state, flagp,depth+1,
10357                        FALSE, /* means parse the whole char class */
10358                        TRUE, /* allow multi-char folds */
10359                        FALSE, /* don't silence non-portable warnings. */
10360                        NULL);
10361         if (*RExC_parse != ']') {
10362             RExC_parse = oregcomp_parse;
10363             vFAIL("Unmatched [");
10364         }
10365         if (ret == NULL) {
10366             if (*flagp & RESTART_UTF8)
10367                 return NULL;
10368             FAIL2("panic: regclass returned NULL to regatom, flags=%#"UVxf"",
10369                   (UV) *flagp);
10370         }
10371         nextchar(pRExC_state);
10372         Set_Node_Length(ret, RExC_parse - oregcomp_parse + 1); /* MJD */
10373         break;
10374     }
10375     case '(':
10376         nextchar(pRExC_state);
10377         ret = reg(pRExC_state, 2, &flags,depth+1);
10378         if (ret == NULL) {
10379                 if (flags & TRYAGAIN) {
10380                     if (RExC_parse == RExC_end) {
10381                          /* Make parent create an empty node if needed. */
10382                         *flagp |= TRYAGAIN;
10383                         return(NULL);
10384                     }
10385                     goto tryagain;
10386                 }
10387                 if (flags & RESTART_UTF8) {
10388                     *flagp = RESTART_UTF8;
10389                     return NULL;
10390                 }
10391                 FAIL2("panic: reg returned NULL to regatom, flags=%#"UVxf"", (UV) flags);
10392         }
10393         *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
10394         break;
10395     case '|':
10396     case ')':
10397         if (flags & TRYAGAIN) {
10398             *flagp |= TRYAGAIN;
10399             return NULL;
10400         }
10401         vFAIL("Internal urp");
10402                                 /* Supposed to be caught earlier. */
10403         break;
10404     case '{':
10405         if (!regcurly(RExC_parse, FALSE)) {
10406             RExC_parse++;
10407             goto defchar;
10408         }
10409         /* FALL THROUGH */
10410     case '?':
10411     case '+':
10412     case '*':
10413         RExC_parse++;
10414         vFAIL("Quantifier follows nothing");
10415         break;
10416     case '\\':
10417         /* Special Escapes
10418
10419            This switch handles escape sequences that resolve to some kind
10420            of special regop and not to literal text. Escape sequnces that
10421            resolve to literal text are handled below in the switch marked
10422            "Literal Escapes".
10423
10424            Every entry in this switch *must* have a corresponding entry
10425            in the literal escape switch. However, the opposite is not
10426            required, as the default for this switch is to jump to the
10427            literal text handling code.
10428         */
10429         switch ((U8)*++RExC_parse) {
10430             U8 arg;
10431         /* Special Escapes */
10432         case 'A':
10433             RExC_seen_zerolen++;
10434             ret = reg_node(pRExC_state, SBOL);
10435             *flagp |= SIMPLE;
10436             goto finish_meta_pat;
10437         case 'G':
10438             ret = reg_node(pRExC_state, GPOS);
10439             RExC_seen |= REG_SEEN_GPOS;
10440             *flagp |= SIMPLE;
10441             goto finish_meta_pat;
10442         case 'K':
10443             RExC_seen_zerolen++;
10444             ret = reg_node(pRExC_state, KEEPS);
10445             *flagp |= SIMPLE;
10446             /* XXX:dmq : disabling in-place substitution seems to
10447              * be necessary here to avoid cases of memory corruption, as
10448              * with: C<$_="x" x 80; s/x\K/y/> -- rgs
10449              */
10450             RExC_seen |= REG_SEEN_LOOKBEHIND;
10451             goto finish_meta_pat;
10452         case 'Z':
10453             ret = reg_node(pRExC_state, SEOL);
10454             *flagp |= SIMPLE;
10455             RExC_seen_zerolen++;                /* Do not optimize RE away */
10456             goto finish_meta_pat;
10457         case 'z':
10458             ret = reg_node(pRExC_state, EOS);
10459             *flagp |= SIMPLE;
10460             RExC_seen_zerolen++;                /* Do not optimize RE away */
10461             goto finish_meta_pat;
10462         case 'C':
10463             ret = reg_node(pRExC_state, CANY);
10464             RExC_seen |= REG_SEEN_CANY;
10465             *flagp |= HASWIDTH|SIMPLE;
10466             goto finish_meta_pat;
10467         case 'X':
10468             ret = reg_node(pRExC_state, CLUMP);
10469             *flagp |= HASWIDTH;
10470             goto finish_meta_pat;
10471
10472         case 'W':
10473             invert = 1;
10474             /* FALLTHROUGH */
10475         case 'w':
10476             arg = ANYOF_WORDCHAR;
10477             goto join_posix;
10478
10479         case 'b':
10480             RExC_seen_zerolen++;
10481             RExC_seen |= REG_SEEN_LOOKBEHIND;
10482             op = BOUND + get_regex_charset(RExC_flags);
10483             if (op > BOUNDA) {  /* /aa is same as /a */
10484                 op = BOUNDA;
10485             }
10486             ret = reg_node(pRExC_state, op);
10487             FLAGS(ret) = get_regex_charset(RExC_flags);
10488             *flagp |= SIMPLE;
10489             if (! SIZE_ONLY && (U8) *(RExC_parse + 1) == '{') {
10490                 ckWARNdep(RExC_parse, "\"\\b{\" is deprecated; use \"\\b\\{\" or \"\\b[{]\" instead");
10491             }
10492             goto finish_meta_pat;
10493         case 'B':
10494             RExC_seen_zerolen++;
10495             RExC_seen |= REG_SEEN_LOOKBEHIND;
10496             op = NBOUND + get_regex_charset(RExC_flags);
10497             if (op > NBOUNDA) { /* /aa is same as /a */
10498                 op = NBOUNDA;
10499             }
10500             ret = reg_node(pRExC_state, op);
10501             FLAGS(ret) = get_regex_charset(RExC_flags);
10502             *flagp |= SIMPLE;
10503             if (! SIZE_ONLY && (U8) *(RExC_parse + 1) == '{') {
10504                 ckWARNdep(RExC_parse, "\"\\B{\" is deprecated; use \"\\B\\{\" or \"\\B[{]\" instead");
10505             }
10506             goto finish_meta_pat;
10507
10508         case 'D':
10509             invert = 1;
10510             /* FALLTHROUGH */
10511         case 'd':
10512             arg = ANYOF_DIGIT;
10513             goto join_posix;
10514
10515         case 'R':
10516             ret = reg_node(pRExC_state, LNBREAK);
10517             *flagp |= HASWIDTH|SIMPLE;
10518             goto finish_meta_pat;
10519
10520         case 'H':
10521             invert = 1;
10522             /* FALLTHROUGH */
10523         case 'h':
10524             arg = ANYOF_BLANK;
10525             op = POSIXU;
10526             goto join_posix_op_known;
10527
10528         case 'V':
10529             invert = 1;
10530             /* FALLTHROUGH */
10531         case 'v':
10532             arg = ANYOF_VERTWS;
10533             op = POSIXU;
10534             goto join_posix_op_known;
10535
10536         case 'S':
10537             invert = 1;
10538             /* FALLTHROUGH */
10539         case 's':
10540             arg = ANYOF_SPACE;
10541
10542         join_posix:
10543
10544             op = POSIXD + get_regex_charset(RExC_flags);
10545             if (op > POSIXA) {  /* /aa is same as /a */
10546                 op = POSIXA;
10547             }
10548
10549         join_posix_op_known:
10550
10551             if (invert) {
10552                 op += NPOSIXD - POSIXD;
10553             }
10554
10555             ret = reg_node(pRExC_state, op);
10556             if (! SIZE_ONLY) {
10557                 FLAGS(ret) = namedclass_to_classnum(arg);
10558             }
10559
10560             *flagp |= HASWIDTH|SIMPLE;
10561             /* FALL THROUGH */
10562
10563          finish_meta_pat:           
10564             nextchar(pRExC_state);
10565             Set_Node_Length(ret, 2); /* MJD */
10566             break;          
10567         case 'p':
10568         case 'P':
10569             {
10570 #ifdef DEBUGGING
10571                 char* parse_start = RExC_parse - 2;
10572 #endif
10573
10574                 RExC_parse--;
10575
10576                 ret = regclass(pRExC_state, flagp,depth+1,
10577                                TRUE, /* means just parse this element */
10578                                FALSE, /* don't allow multi-char folds */
10579                                FALSE, /* don't silence non-portable warnings.
10580                                          It would be a bug if these returned
10581                                          non-portables */
10582                                NULL);
10583                 /* regclass() can only return RESTART_UTF8 if multi-char folds
10584                    are allowed.  */
10585                 if (!ret)
10586                     FAIL2("panic: regclass returned NULL to regatom, flags=%#"UVxf"",
10587                           (UV) *flagp);
10588
10589                 RExC_parse--;
10590
10591                 Set_Node_Offset(ret, parse_start + 2);
10592                 Set_Node_Cur_Length(ret, parse_start);
10593                 nextchar(pRExC_state);
10594             }
10595             break;
10596         case 'N': 
10597             /* Handle \N and \N{NAME} with multiple code points here and not
10598              * below because it can be multicharacter. join_exact() will join
10599              * them up later on.  Also this makes sure that things like
10600              * /\N{BLAH}+/ and \N{BLAH} being multi char Just Happen. dmq.
10601              * The options to the grok function call causes it to fail if the
10602              * sequence is just a single code point.  We then go treat it as
10603              * just another character in the current EXACT node, and hence it
10604              * gets uniform treatment with all the other characters.  The
10605              * special treatment for quantifiers is not needed for such single
10606              * character sequences */
10607             ++RExC_parse;
10608             if (! grok_bslash_N(pRExC_state, &ret, NULL, flagp, depth, FALSE,
10609                                 FALSE /* not strict */ )) {
10610                 if (*flagp & RESTART_UTF8)
10611                     return NULL;
10612                 RExC_parse--;
10613                 goto defchar;
10614             }
10615             break;
10616         case 'k':    /* Handle \k<NAME> and \k'NAME' */
10617         parse_named_seq:
10618         {   
10619             char ch= RExC_parse[1];         
10620             if (ch != '<' && ch != '\'' && ch != '{') {
10621                 RExC_parse++;
10622                 vFAIL2("Sequence %.2s... not terminated",parse_start);
10623             } else {
10624                 /* this pretty much dupes the code for (?P=...) in reg(), if
10625                    you change this make sure you change that */
10626                 char* name_start = (RExC_parse += 2);
10627                 U32 num = 0;
10628                 SV *sv_dat = reg_scan_name(pRExC_state,
10629                     SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
10630                 ch= (ch == '<') ? '>' : (ch == '{') ? '}' : '\'';
10631                 if (RExC_parse == name_start || *RExC_parse != ch)
10632                     vFAIL2("Sequence %.3s... not terminated",parse_start);
10633
10634                 if (!SIZE_ONLY) {
10635                     num = add_data( pRExC_state, 1, "S" );
10636                     RExC_rxi->data->data[num]=(void*)sv_dat;
10637                     SvREFCNT_inc_simple_void(sv_dat);
10638                 }
10639
10640                 RExC_sawback = 1;
10641                 ret = reganode(pRExC_state,
10642                                ((! FOLD)
10643                                  ? NREF
10644                                  : (ASCII_FOLD_RESTRICTED)
10645                                    ? NREFFA
10646                                    : (AT_LEAST_UNI_SEMANTICS)
10647                                      ? NREFFU
10648                                      : (LOC)
10649                                        ? NREFFL
10650                                        : NREFF),
10651                                 num);
10652                 *flagp |= HASWIDTH;
10653
10654                 /* override incorrect value set in reganode MJD */
10655                 Set_Node_Offset(ret, parse_start+1);
10656                 Set_Node_Cur_Length(ret, parse_start);
10657                 nextchar(pRExC_state);
10658
10659             }
10660             break;
10661         }
10662         case 'g': 
10663         case '1': case '2': case '3': case '4':
10664         case '5': case '6': case '7': case '8': case '9':
10665             {
10666                 I32 num;
10667                 bool isg = *RExC_parse == 'g';
10668                 bool isrel = 0; 
10669                 bool hasbrace = 0;
10670                 if (isg) {
10671                     RExC_parse++;
10672                     if (*RExC_parse == '{') {
10673                         RExC_parse++;
10674                         hasbrace = 1;
10675                     }
10676                     if (*RExC_parse == '-') {
10677                         RExC_parse++;
10678                         isrel = 1;
10679                     }
10680                     if (hasbrace && !isDIGIT(*RExC_parse)) {
10681                         if (isrel) RExC_parse--;
10682                         RExC_parse -= 2;                            
10683                         goto parse_named_seq;
10684                 }   }
10685                 num = atoi(RExC_parse);
10686                 if (isg && num == 0) {
10687                     if (*RExC_parse == '0') {
10688                         vFAIL("Reference to invalid group 0");
10689                     }
10690                     else {
10691                         vFAIL("Unterminated \\g... pattern");
10692                     }
10693                 }
10694                 if (isrel) {
10695                     num = RExC_npar - num;
10696                     if (num < 1)
10697                         vFAIL("Reference to nonexistent or unclosed group");
10698                 }
10699                 if (!isg && num > 9 && num >= RExC_npar)
10700                     /* Probably a character specified in octal, e.g. \35 */
10701                     goto defchar;
10702                 else {
10703 #ifdef RE_TRACK_PATTERN_OFFSETS
10704                     char * const parse_start = RExC_parse - 1; /* MJD */
10705 #endif
10706                     while (isDIGIT(*RExC_parse))
10707                         RExC_parse++;
10708                     if (hasbrace) {
10709                         if (*RExC_parse != '}') 
10710                             vFAIL("Unterminated \\g{...} pattern");
10711                         RExC_parse++;
10712                     }    
10713                     if (!SIZE_ONLY) {
10714                         if (num > (I32)RExC_rx->nparens)
10715                             vFAIL("Reference to nonexistent group");
10716                     }
10717                     RExC_sawback = 1;
10718                     ret = reganode(pRExC_state,
10719                                    ((! FOLD)
10720                                      ? REF
10721                                      : (ASCII_FOLD_RESTRICTED)
10722                                        ? REFFA
10723                                        : (AT_LEAST_UNI_SEMANTICS)
10724                                          ? REFFU
10725                                          : (LOC)
10726                                            ? REFFL
10727                                            : REFF),
10728                                     num);
10729                     *flagp |= HASWIDTH;
10730
10731                     /* override incorrect value set in reganode MJD */
10732                     Set_Node_Offset(ret, parse_start+1);
10733                     Set_Node_Cur_Length(ret, parse_start);
10734                     RExC_parse--;
10735                     nextchar(pRExC_state);
10736                 }
10737             }
10738             break;
10739         case '\0':
10740             if (RExC_parse >= RExC_end)
10741                 FAIL("Trailing \\");
10742             /* FALL THROUGH */
10743         default:
10744             /* Do not generate "unrecognized" warnings here, we fall
10745                back into the quick-grab loop below */
10746             parse_start--;
10747             goto defchar;
10748         }
10749         break;
10750
10751     case '#':
10752         if (RExC_flags & RXf_PMf_EXTENDED) {
10753             if ( reg_skipcomment( pRExC_state ) )
10754                 goto tryagain;
10755         }
10756         /* FALL THROUGH */
10757
10758     default:
10759
10760             parse_start = RExC_parse - 1;
10761
10762             RExC_parse++;
10763
10764         defchar: {
10765             STRLEN len = 0;
10766             UV ender;
10767             char *p;
10768             char *s;
10769 #define MAX_NODE_STRING_SIZE 127
10770             char foldbuf[MAX_NODE_STRING_SIZE+UTF8_MAXBYTES_CASE];
10771             char *s0;
10772             U8 upper_parse = MAX_NODE_STRING_SIZE;
10773             STRLEN foldlen;
10774             U8 node_type;
10775             bool next_is_quantifier;
10776             char * oldp = NULL;
10777
10778             /* If a folding node contains only code points that don't
10779              * participate in folds, it can be changed into an EXACT node,
10780              * which allows the optimizer more things to look for */
10781             bool maybe_exact;
10782
10783             ender = 0;
10784             node_type = compute_EXACTish(pRExC_state);
10785             ret = reg_node(pRExC_state, node_type);
10786
10787             /* In pass1, folded, we use a temporary buffer instead of the
10788              * actual node, as the node doesn't exist yet */
10789             s = (SIZE_ONLY && FOLD) ? foldbuf : STRING(ret);
10790
10791             s0 = s;
10792
10793         reparse:
10794
10795             /* We do the EXACTFish to EXACT node only if folding, and not if in
10796              * locale, as whether a character folds or not isn't known until
10797              * runtime */
10798             maybe_exact = FOLD && ! LOC;
10799
10800             /* XXX The node can hold up to 255 bytes, yet this only goes to
10801              * 127.  I (khw) do not know why.  Keeping it somewhat less than
10802              * 255 allows us to not have to worry about overflow due to
10803              * converting to utf8 and fold expansion, but that value is
10804              * 255-UTF8_MAXBYTES_CASE.  join_exact() may join adjacent nodes
10805              * split up by this limit into a single one using the real max of
10806              * 255.  Even at 127, this breaks under rare circumstances.  If
10807              * folding, we do not want to split a node at a character that is a
10808              * non-final in a multi-char fold, as an input string could just
10809              * happen to want to match across the node boundary.  The join
10810              * would solve that problem if the join actually happens.  But a
10811              * series of more than two nodes in a row each of 127 would cause
10812              * the first join to succeed to get to 254, but then there wouldn't
10813              * be room for the next one, which could at be one of those split
10814              * multi-char folds.  I don't know of any fool-proof solution.  One
10815              * could back off to end with only a code point that isn't such a
10816              * non-final, but it is possible for there not to be any in the
10817              * entire node. */
10818             for (p = RExC_parse - 1;
10819                  len < upper_parse && p < RExC_end;
10820                  len++)
10821             {
10822                 oldp = p;
10823
10824                 if (RExC_flags & RXf_PMf_EXTENDED)
10825                     p = regwhite( pRExC_state, p );
10826                 switch ((U8)*p) {
10827                 case '^':
10828                 case '$':
10829                 case '.':
10830                 case '[':
10831                 case '(':
10832                 case ')':
10833                 case '|':
10834                     goto loopdone;
10835                 case '\\':
10836                     /* Literal Escapes Switch
10837
10838                        This switch is meant to handle escape sequences that
10839                        resolve to a literal character.
10840
10841                        Every escape sequence that represents something
10842                        else, like an assertion or a char class, is handled
10843                        in the switch marked 'Special Escapes' above in this
10844                        routine, but also has an entry here as anything that
10845                        isn't explicitly mentioned here will be treated as
10846                        an unescaped equivalent literal.
10847                     */
10848
10849                     switch ((U8)*++p) {
10850                     /* These are all the special escapes. */
10851                     case 'A':             /* Start assertion */
10852                     case 'b': case 'B':   /* Word-boundary assertion*/
10853                     case 'C':             /* Single char !DANGEROUS! */
10854                     case 'd': case 'D':   /* digit class */
10855                     case 'g': case 'G':   /* generic-backref, pos assertion */
10856                     case 'h': case 'H':   /* HORIZWS */
10857                     case 'k': case 'K':   /* named backref, keep marker */
10858                     case 'p': case 'P':   /* Unicode property */
10859                               case 'R':   /* LNBREAK */
10860                     case 's': case 'S':   /* space class */
10861                     case 'v': case 'V':   /* VERTWS */
10862                     case 'w': case 'W':   /* word class */
10863                     case 'X':             /* eXtended Unicode "combining character sequence" */
10864                     case 'z': case 'Z':   /* End of line/string assertion */
10865                         --p;
10866                         goto loopdone;
10867
10868                     /* Anything after here is an escape that resolves to a
10869                        literal. (Except digits, which may or may not)
10870                      */
10871                     case 'n':
10872                         ender = '\n';
10873                         p++;
10874                         break;
10875                     case 'N': /* Handle a single-code point named character. */
10876                         /* The options cause it to fail if a multiple code
10877                          * point sequence.  Handle those in the switch() above
10878                          * */
10879                         RExC_parse = p + 1;
10880                         if (! grok_bslash_N(pRExC_state, NULL, &ender,
10881                                             flagp, depth, FALSE,
10882                                             FALSE /* not strict */ ))
10883                         {
10884                             if (*flagp & RESTART_UTF8)
10885                                 FAIL("panic: grok_bslash_N set RESTART_UTF8");
10886                             RExC_parse = p = oldp;
10887                             goto loopdone;
10888                         }
10889                         p = RExC_parse;
10890                         if (ender > 0xff) {
10891                             REQUIRE_UTF8;
10892                         }
10893                         break;
10894                     case 'r':
10895                         ender = '\r';
10896                         p++;
10897                         break;
10898                     case 't':
10899                         ender = '\t';
10900                         p++;
10901                         break;
10902                     case 'f':
10903                         ender = '\f';
10904                         p++;
10905                         break;
10906                     case 'e':
10907                           ender = ASCII_TO_NATIVE('\033');
10908                         p++;
10909                         break;
10910                     case 'a':
10911                           ender = ASCII_TO_NATIVE('\007');
10912                         p++;
10913                         break;
10914                     case 'o':
10915                         {
10916                             UV result;
10917                             const char* error_msg;
10918
10919                             bool valid = grok_bslash_o(&p,
10920                                                        &result,
10921                                                        &error_msg,
10922                                                        TRUE, /* out warnings */
10923                                                        FALSE, /* not strict */
10924                                                        TRUE, /* Output warnings
10925                                                                 for non-
10926                                                                 portables */
10927                                                        UTF);
10928                             if (! valid) {
10929                                 RExC_parse = p; /* going to die anyway; point
10930                                                    to exact spot of failure */
10931                                 vFAIL(error_msg);
10932                             }
10933                             ender = result;
10934                             if (PL_encoding && ender < 0x100) {
10935                                 goto recode_encoding;
10936                             }
10937                             if (ender > 0xff) {
10938                                 REQUIRE_UTF8;
10939                             }
10940                             break;
10941                         }
10942                     case 'x':
10943                         {
10944                             UV result = UV_MAX; /* initialize to erroneous
10945                                                    value */
10946                             const char* error_msg;
10947
10948                             bool valid = grok_bslash_x(&p,
10949                                                        &result,
10950                                                        &error_msg,
10951                                                        TRUE, /* out warnings */
10952                                                        FALSE, /* not strict */
10953                                                        TRUE, /* Output warnings
10954                                                                 for non-
10955                                                                 portables */
10956                                                        UTF);
10957                             if (! valid) {
10958                                 RExC_parse = p; /* going to die anyway; point
10959                                                    to exact spot of failure */
10960                                 vFAIL(error_msg);
10961                             }
10962                             ender = result;
10963
10964                             if (PL_encoding && ender < 0x100) {
10965                                 goto recode_encoding;
10966                             }
10967                             if (ender > 0xff) {
10968                                 REQUIRE_UTF8;
10969                             }
10970                             break;
10971                         }
10972                     case 'c':
10973                         p++;
10974                         ender = grok_bslash_c(*p++, UTF, SIZE_ONLY);
10975                         break;
10976                     case '0': case '1': case '2': case '3':case '4':
10977                     case '5': case '6': case '7':
10978                         if (*p == '0' ||
10979                             (isDIGIT(p[1]) && atoi(p) >= RExC_npar))
10980                         {
10981                             I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
10982                             STRLEN numlen = 3;
10983                             ender = grok_oct(p, &numlen, &flags, NULL);
10984                             if (ender > 0xff) {
10985                                 REQUIRE_UTF8;
10986                             }
10987                             p += numlen;
10988                             if (SIZE_ONLY   /* like \08, \178 */
10989                                 && numlen < 3
10990                                 && p < RExC_end
10991                                 && isDIGIT(*p) && ckWARN(WARN_REGEXP))
10992                             {
10993                                 reg_warn_non_literal_string(
10994                                          p + 1,
10995                                          form_short_octal_warning(p, numlen));
10996                             }
10997                         }
10998                         else {  /* Not to be treated as an octal constant, go
10999                                    find backref */
11000                             --p;
11001                             goto loopdone;
11002                         }
11003                         if (PL_encoding && ender < 0x100)
11004                             goto recode_encoding;
11005                         break;
11006                     recode_encoding:
11007                         if (! RExC_override_recoding) {
11008                             SV* enc = PL_encoding;
11009                             ender = reg_recode((const char)(U8)ender, &enc);
11010                             if (!enc && SIZE_ONLY)
11011                                 ckWARNreg(p, "Invalid escape in the specified encoding");
11012                             REQUIRE_UTF8;
11013                         }
11014                         break;
11015                     case '\0':
11016                         if (p >= RExC_end)
11017                             FAIL("Trailing \\");
11018                         /* FALL THROUGH */
11019                     default:
11020                         if (!SIZE_ONLY&& isALPHANUMERIC(*p)) {
11021                             /* Include any { following the alpha to emphasize
11022                              * that it could be part of an escape at some point
11023                              * in the future */
11024                             int len = (isALPHA(*p) && *(p + 1) == '{') ? 2 : 1;
11025                             ckWARN3reg(p + len, "Unrecognized escape \\%.*s passed through", len, p);
11026                         }
11027                         goto normal_default;
11028                     } /* End of switch on '\' */
11029                     break;
11030                 default:    /* A literal character */
11031
11032                     if (! SIZE_ONLY
11033                         && RExC_flags & RXf_PMf_EXTENDED
11034                         && ckWARN_d(WARN_DEPRECATED)
11035                         && is_PATWS_non_low(p, UTF))
11036                     {
11037                         vWARN_dep(p + ((UTF) ? UTF8SKIP(p) : 1),
11038                                 "Escape literal pattern white space under /x");
11039                     }
11040
11041                   normal_default:
11042                     if (UTF8_IS_START(*p) && UTF) {
11043                         STRLEN numlen;
11044                         ender = utf8n_to_uvchr((U8*)p, RExC_end - p,
11045                                                &numlen, UTF8_ALLOW_DEFAULT);
11046                         p += numlen;
11047                     }
11048                     else
11049                         ender = (U8) *p++;
11050                     break;
11051                 } /* End of switch on the literal */
11052
11053                 /* Here, have looked at the literal character and <ender>
11054                  * contains its ordinal, <p> points to the character after it
11055                  */
11056
11057                 if ( RExC_flags & RXf_PMf_EXTENDED)
11058                     p = regwhite( pRExC_state, p );
11059
11060                 /* If the next thing is a quantifier, it applies to this
11061                  * character only, which means that this character has to be in
11062                  * its own node and can't just be appended to the string in an
11063                  * existing node, so if there are already other characters in
11064                  * the node, close the node with just them, and set up to do
11065                  * this character again next time through, when it will be the
11066                  * only thing in its new node */
11067                 if ((next_is_quantifier = (p < RExC_end && ISMULT2(p))) && len)
11068                 {
11069                     p = oldp;
11070                     goto loopdone;
11071                 }
11072
11073                 if (! FOLD) {
11074                     if (UTF) {
11075                         const STRLEN unilen = reguni(pRExC_state, ender, s);
11076                         if (unilen > 0) {
11077                            s   += unilen;
11078                            len += unilen;
11079                         }
11080
11081                         /* The loop increments <len> each time, as all but this
11082                          * path (and one other) through it add a single byte to
11083                          * the EXACTish node.  But this one has changed len to
11084                          * be the correct final value, so subtract one to
11085                          * cancel out the increment that follows */
11086                         len--;
11087                     }
11088                     else {
11089                         REGC((char)ender, s++);
11090                     }
11091                 }
11092                 else /* FOLD */
11093                      if (! ( UTF
11094                         /* See comments for join_exact() as to why we fold this
11095                          * non-UTF at compile time */
11096                         || (node_type == EXACTFU
11097                             && ender == LATIN_SMALL_LETTER_SHARP_S)))
11098                 {
11099                     *(s++) = (char) ender;
11100                     maybe_exact &= ! IS_IN_SOME_FOLD_L1(ender);
11101                 }
11102                 else {  /* UTF */
11103
11104                     /* Prime the casefolded buffer.  Locale rules, which apply
11105                      * only to code points < 256, aren't known until execution,
11106                      * so for them, just output the original character using
11107                      * utf8.  If we start to fold non-UTF patterns, be sure to
11108                      * update join_exact() */
11109                     if (LOC && ender < 256) {
11110                         if (UNI_IS_INVARIANT(ender)) {
11111                             *s = (U8) ender;
11112                             foldlen = 1;
11113                         } else {
11114                             *s = UTF8_TWO_BYTE_HI(ender);
11115                             *(s + 1) = UTF8_TWO_BYTE_LO(ender);
11116                             foldlen = 2;
11117                         }
11118                     }
11119                     else {
11120                         UV folded = _to_uni_fold_flags(
11121                                        ender,
11122                                        (U8 *) s,
11123                                        &foldlen,
11124                                        FOLD_FLAGS_FULL
11125                                        | ((LOC) ?  FOLD_FLAGS_LOCALE
11126                                                 : (ASCII_FOLD_RESTRICTED)
11127                                                   ? FOLD_FLAGS_NOMIX_ASCII
11128                                                   : 0)
11129                                         );
11130
11131                         /* If this node only contains non-folding code points
11132                          * so far, see if this new one is also non-folding */
11133                         if (maybe_exact) {
11134                             if (folded != ender) {
11135                                 maybe_exact = FALSE;
11136                             }
11137                             else {
11138                                 /* Here the fold is the original; we have
11139                                  * to check further to see if anything
11140                                  * folds to it */
11141                                 if (! PL_utf8_foldable) {
11142                                     SV* swash = swash_init("utf8",
11143                                                        "_Perl_Any_Folds",
11144                                                        &PL_sv_undef, 1, 0);
11145                                     PL_utf8_foldable =
11146                                                 _get_swash_invlist(swash);
11147                                     SvREFCNT_dec_NN(swash);
11148                                 }
11149                                 if (_invlist_contains_cp(PL_utf8_foldable,
11150                                                          ender))
11151                                 {
11152                                     maybe_exact = FALSE;
11153                                 }
11154                             }
11155                         }
11156                         ender = folded;
11157                     }
11158                     s += foldlen;
11159
11160                     /* The loop increments <len> each time, as all but this
11161                      * path (and one other) through it add a single byte to the
11162                      * EXACTish node.  But this one has changed len to be the
11163                      * correct final value, so subtract one to cancel out the
11164                      * increment that follows */
11165                     len += foldlen - 1;
11166                 }
11167
11168                 if (next_is_quantifier) {
11169
11170                     /* Here, the next input is a quantifier, and to get here,
11171                      * the current character is the only one in the node.
11172                      * Also, here <len> doesn't include the final byte for this
11173                      * character */
11174                     len++;
11175                     goto loopdone;
11176                 }
11177
11178             } /* End of loop through literal characters */
11179
11180             /* Here we have either exhausted the input or ran out of room in
11181              * the node.  (If we encountered a character that can't be in the
11182              * node, transfer is made directly to <loopdone>, and so we
11183              * wouldn't have fallen off the end of the loop.)  In the latter
11184              * case, we artificially have to split the node into two, because
11185              * we just don't have enough space to hold everything.  This
11186              * creates a problem if the final character participates in a
11187              * multi-character fold in the non-final position, as a match that
11188              * should have occurred won't, due to the way nodes are matched,
11189              * and our artificial boundary.  So back off until we find a non-
11190              * problematic character -- one that isn't at the beginning or
11191              * middle of such a fold.  (Either it doesn't participate in any
11192              * folds, or appears only in the final position of all the folds it
11193              * does participate in.)  A better solution with far fewer false
11194              * positives, and that would fill the nodes more completely, would
11195              * be to actually have available all the multi-character folds to
11196              * test against, and to back-off only far enough to be sure that
11197              * this node isn't ending with a partial one.  <upper_parse> is set
11198              * further below (if we need to reparse the node) to include just
11199              * up through that final non-problematic character that this code
11200              * identifies, so when it is set to less than the full node, we can
11201              * skip the rest of this */
11202             if (FOLD && p < RExC_end && upper_parse == MAX_NODE_STRING_SIZE) {
11203
11204                 const STRLEN full_len = len;
11205
11206                 assert(len >= MAX_NODE_STRING_SIZE);
11207
11208                 /* Here, <s> points to the final byte of the final character.
11209                  * Look backwards through the string until find a non-
11210                  * problematic character */
11211
11212                 if (! UTF) {
11213
11214                     /* These two have no multi-char folds to non-UTF characters
11215                      */
11216                     if (ASCII_FOLD_RESTRICTED || LOC) {
11217                         goto loopdone;
11218                     }
11219
11220                     while (--s >= s0 && IS_NON_FINAL_FOLD(*s)) { }
11221                     len = s - s0 + 1;
11222                 }
11223                 else {
11224                     if (!  PL_NonL1NonFinalFold) {
11225                         PL_NonL1NonFinalFold = _new_invlist_C_array(
11226                                         NonL1_Perl_Non_Final_Folds_invlist);
11227                     }
11228
11229                     /* Point to the first byte of the final character */
11230                     s = (char *) utf8_hop((U8 *) s, -1);
11231
11232                     while (s >= s0) {   /* Search backwards until find
11233                                            non-problematic char */
11234                         if (UTF8_IS_INVARIANT(*s)) {
11235
11236                             /* There are no ascii characters that participate
11237                              * in multi-char folds under /aa.  In EBCDIC, the
11238                              * non-ascii invariants are all control characters,
11239                              * so don't ever participate in any folds. */
11240                             if (ASCII_FOLD_RESTRICTED
11241                                 || ! IS_NON_FINAL_FOLD(*s))
11242                             {
11243                                 break;
11244                             }
11245                         }
11246                         else if (UTF8_IS_DOWNGRADEABLE_START(*s)) {
11247
11248                             /* No Latin1 characters participate in multi-char
11249                              * folds under /l */
11250                             if (LOC
11251                                 || ! IS_NON_FINAL_FOLD(TWO_BYTE_UTF8_TO_UNI(
11252                                                                 *s, *(s+1))))
11253                             {
11254                                 break;
11255                             }
11256                         }
11257                         else if (! _invlist_contains_cp(
11258                                         PL_NonL1NonFinalFold,
11259                                         valid_utf8_to_uvchr((U8 *) s, NULL)))
11260                         {
11261                             break;
11262                         }
11263
11264                         /* Here, the current character is problematic in that
11265                          * it does occur in the non-final position of some
11266                          * fold, so try the character before it, but have to
11267                          * special case the very first byte in the string, so
11268                          * we don't read outside the string */
11269                         s = (s == s0) ? s -1 : (char *) utf8_hop((U8 *) s, -1);
11270                     } /* End of loop backwards through the string */
11271
11272                     /* If there were only problematic characters in the string,
11273                      * <s> will point to before s0, in which case the length
11274                      * should be 0, otherwise include the length of the
11275                      * non-problematic character just found */
11276                     len = (s < s0) ? 0 : s - s0 + UTF8SKIP(s);
11277                 }
11278
11279                 /* Here, have found the final character, if any, that is
11280                  * non-problematic as far as ending the node without splitting
11281                  * it across a potential multi-char fold.  <len> contains the
11282                  * number of bytes in the node up-to and including that
11283                  * character, or is 0 if there is no such character, meaning
11284                  * the whole node contains only problematic characters.  In
11285                  * this case, give up and just take the node as-is.  We can't
11286                  * do any better */
11287                 if (len == 0) {
11288                     len = full_len;
11289                 } else {
11290
11291                     /* Here, the node does contain some characters that aren't
11292                      * problematic.  If one such is the final character in the
11293                      * node, we are done */
11294                     if (len == full_len) {
11295                         goto loopdone;
11296                     }
11297                     else if (len + ((UTF) ? UTF8SKIP(s) : 1) == full_len) {
11298
11299                         /* If the final character is problematic, but the
11300                          * penultimate is not, back-off that last character to
11301                          * later start a new node with it */
11302                         p = oldp;
11303                         goto loopdone;
11304                     }
11305
11306                     /* Here, the final non-problematic character is earlier
11307                      * in the input than the penultimate character.  What we do
11308                      * is reparse from the beginning, going up only as far as
11309                      * this final ok one, thus guaranteeing that the node ends
11310                      * in an acceptable character.  The reason we reparse is
11311                      * that we know how far in the character is, but we don't
11312                      * know how to correlate its position with the input parse.
11313                      * An alternate implementation would be to build that
11314                      * correlation as we go along during the original parse,
11315                      * but that would entail extra work for every node, whereas
11316                      * this code gets executed only when the string is too
11317                      * large for the node, and the final two characters are
11318                      * problematic, an infrequent occurrence.  Yet another
11319                      * possible strategy would be to save the tail of the
11320                      * string, and the next time regatom is called, initialize
11321                      * with that.  The problem with this is that unless you
11322                      * back off one more character, you won't be guaranteed
11323                      * regatom will get called again, unless regbranch,
11324                      * regpiece ... are also changed.  If you do back off that
11325                      * extra character, so that there is input guaranteed to
11326                      * force calling regatom, you can't handle the case where
11327                      * just the first character in the node is acceptable.  I
11328                      * (khw) decided to try this method which doesn't have that
11329                      * pitfall; if performance issues are found, we can do a
11330                      * combination of the current approach plus that one */
11331                     upper_parse = len;
11332                     len = 0;
11333                     s = s0;
11334                     goto reparse;
11335                 }
11336             }   /* End of verifying node ends with an appropriate char */
11337
11338         loopdone:   /* Jumped to when encounters something that shouldn't be in
11339                        the node */
11340
11341             /* If 'maybe_exact' is still set here, means there are no
11342              * code points in the node that participate in folds */
11343             if (FOLD && maybe_exact) {
11344                 OP(ret) = EXACT;
11345             }
11346
11347             /* I (khw) don't know if you can get here with zero length, but the
11348              * old code handled this situation by creating a zero-length EXACT
11349              * node.  Might as well be NOTHING instead */
11350             if (len == 0) {
11351                 OP(ret) = NOTHING;
11352             }
11353             else{
11354                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, len, ender);
11355             }
11356
11357             RExC_parse = p - 1;
11358             Set_Node_Cur_Length(ret, parse_start);
11359             nextchar(pRExC_state);
11360             {
11361                 /* len is STRLEN which is unsigned, need to copy to signed */
11362                 IV iv = len;
11363                 if (iv < 0)
11364                     vFAIL("Internal disaster");
11365             }
11366
11367         } /* End of label 'defchar:' */
11368         break;
11369     } /* End of giant switch on input character */
11370
11371     return(ret);
11372 }
11373
11374 STATIC char *
11375 S_regwhite( RExC_state_t *pRExC_state, char *p )
11376 {
11377     const char *e = RExC_end;
11378
11379     PERL_ARGS_ASSERT_REGWHITE;
11380
11381     while (p < e) {
11382         if (isSPACE(*p))
11383             ++p;
11384         else if (*p == '#') {
11385             bool ended = 0;
11386             do {
11387                 if (*p++ == '\n') {
11388                     ended = 1;
11389                     break;
11390                 }
11391             } while (p < e);
11392             if (!ended)
11393                 RExC_seen |= REG_SEEN_RUN_ON_COMMENT;
11394         }
11395         else
11396             break;
11397     }
11398     return p;
11399 }
11400
11401 STATIC char *
11402 S_regpatws( RExC_state_t *pRExC_state, char *p , const bool recognize_comment )
11403 {
11404     /* Returns the next non-pattern-white space, non-comment character (the
11405      * latter only if 'recognize_comment is true) in the string p, which is
11406      * ended by RExC_end.  If there is no line break ending a comment,
11407      * RExC_seen has added the REG_SEEN_RUN_ON_COMMENT flag; */
11408     const char *e = RExC_end;
11409
11410     PERL_ARGS_ASSERT_REGPATWS;
11411
11412     while (p < e) {
11413         STRLEN len;
11414         if ((len = is_PATWS_safe(p, e, UTF))) {
11415             p += len;
11416         }
11417         else if (recognize_comment && *p == '#') {
11418             bool ended = 0;
11419             do {
11420                 p++;
11421                 if (is_LNBREAK_safe(p, e, UTF)) {
11422                     ended = 1;
11423                     break;
11424                 }
11425             } while (p < e);
11426             if (!ended)
11427                 RExC_seen |= REG_SEEN_RUN_ON_COMMENT;
11428         }
11429         else
11430             break;
11431     }
11432     return p;
11433 }
11434
11435 /* Parse POSIX character classes: [[:foo:]], [[=foo=]], [[.foo.]].
11436    Character classes ([:foo:]) can also be negated ([:^foo:]).
11437    Returns a named class id (ANYOF_XXX) if successful, -1 otherwise.
11438    Equivalence classes ([=foo=]) and composites ([.foo.]) are parsed,
11439    but trigger failures because they are currently unimplemented. */
11440
11441 #define POSIXCC_DONE(c)   ((c) == ':')
11442 #define POSIXCC_NOTYET(c) ((c) == '=' || (c) == '.')
11443 #define POSIXCC(c) (POSIXCC_DONE(c) || POSIXCC_NOTYET(c))
11444
11445 PERL_STATIC_INLINE I32
11446 S_regpposixcc(pTHX_ RExC_state_t *pRExC_state, I32 value, const bool strict)
11447 {
11448     dVAR;
11449     I32 namedclass = OOB_NAMEDCLASS;
11450
11451     PERL_ARGS_ASSERT_REGPPOSIXCC;
11452
11453     if (value == '[' && RExC_parse + 1 < RExC_end &&
11454         /* I smell either [: or [= or [. -- POSIX has been here, right? */
11455         POSIXCC(UCHARAT(RExC_parse)))
11456     {
11457         const char c = UCHARAT(RExC_parse);
11458         char* const s = RExC_parse++;
11459
11460         while (RExC_parse < RExC_end && UCHARAT(RExC_parse) != c)
11461             RExC_parse++;
11462         if (RExC_parse == RExC_end) {
11463             if (strict) {
11464
11465                 /* Try to give a better location for the error (than the end of
11466                  * the string) by looking for the matching ']' */
11467                 RExC_parse = s;
11468                 while (RExC_parse < RExC_end && UCHARAT(RExC_parse) != ']') {
11469                     RExC_parse++;
11470                 }
11471                 vFAIL2("Unmatched '%c' in POSIX class", c);
11472             }
11473             /* Grandfather lone [:, [=, [. */
11474             RExC_parse = s;
11475         }
11476         else {
11477             const char* const t = RExC_parse++; /* skip over the c */
11478             assert(*t == c);
11479
11480             if (UCHARAT(RExC_parse) == ']') {
11481                 const char *posixcc = s + 1;
11482                 RExC_parse++; /* skip over the ending ] */
11483
11484                 if (*s == ':') {
11485                     const I32 complement = *posixcc == '^' ? *posixcc++ : 0;
11486                     const I32 skip = t - posixcc;
11487
11488                     /* Initially switch on the length of the name.  */
11489                     switch (skip) {
11490                     case 4:
11491                         if (memEQ(posixcc, "word", 4)) /* this is not POSIX,
11492                                                           this is the Perl \w
11493                                                         */
11494                             namedclass = ANYOF_WORDCHAR;
11495                         break;
11496                     case 5:
11497                         /* Names all of length 5.  */
11498                         /* alnum alpha ascii blank cntrl digit graph lower
11499                            print punct space upper  */
11500                         /* Offset 4 gives the best switch position.  */
11501                         switch (posixcc[4]) {
11502                         case 'a':
11503                             if (memEQ(posixcc, "alph", 4)) /* alpha */
11504                                 namedclass = ANYOF_ALPHA;
11505                             break;
11506                         case 'e':
11507                             if (memEQ(posixcc, "spac", 4)) /* space */
11508                                 namedclass = ANYOF_PSXSPC;
11509                             break;
11510                         case 'h':
11511                             if (memEQ(posixcc, "grap", 4)) /* graph */
11512                                 namedclass = ANYOF_GRAPH;
11513                             break;
11514                         case 'i':
11515                             if (memEQ(posixcc, "asci", 4)) /* ascii */
11516                                 namedclass = ANYOF_ASCII;
11517                             break;
11518                         case 'k':
11519                             if (memEQ(posixcc, "blan", 4)) /* blank */
11520                                 namedclass = ANYOF_BLANK;
11521                             break;
11522                         case 'l':
11523                             if (memEQ(posixcc, "cntr", 4)) /* cntrl */
11524                                 namedclass = ANYOF_CNTRL;
11525                             break;
11526                         case 'm':
11527                             if (memEQ(posixcc, "alnu", 4)) /* alnum */
11528                                 namedclass = ANYOF_ALPHANUMERIC;
11529                             break;
11530                         case 'r':
11531                             if (memEQ(posixcc, "lowe", 4)) /* lower */
11532                                 namedclass = (FOLD) ? ANYOF_CASED : ANYOF_LOWER;
11533                             else if (memEQ(posixcc, "uppe", 4)) /* upper */
11534                                 namedclass = (FOLD) ? ANYOF_CASED : ANYOF_UPPER;
11535                             break;
11536                         case 't':
11537                             if (memEQ(posixcc, "digi", 4)) /* digit */
11538                                 namedclass = ANYOF_DIGIT;
11539                             else if (memEQ(posixcc, "prin", 4)) /* print */
11540                                 namedclass = ANYOF_PRINT;
11541                             else if (memEQ(posixcc, "punc", 4)) /* punct */
11542                                 namedclass = ANYOF_PUNCT;
11543                             break;
11544                         }
11545                         break;
11546                     case 6:
11547                         if (memEQ(posixcc, "xdigit", 6))
11548                             namedclass = ANYOF_XDIGIT;
11549                         break;
11550                     }
11551
11552                     if (namedclass == OOB_NAMEDCLASS)
11553                         Simple_vFAIL3("POSIX class [:%.*s:] unknown",
11554                                       t - s - 1, s + 1);
11555
11556                     /* The #defines are structured so each complement is +1 to
11557                      * the normal one */
11558                     if (complement) {
11559                         namedclass++;
11560                     }
11561                     assert (posixcc[skip] == ':');
11562                     assert (posixcc[skip+1] == ']');
11563                 } else if (!SIZE_ONLY) {
11564                     /* [[=foo=]] and [[.foo.]] are still future. */
11565
11566                     /* adjust RExC_parse so the warning shows after
11567                        the class closes */
11568                     while (UCHARAT(RExC_parse) && UCHARAT(RExC_parse) != ']')
11569                         RExC_parse++;
11570                     vFAIL3("POSIX syntax [%c %c] is reserved for future extensions", c, c);
11571                 }
11572             } else {
11573                 /* Maternal grandfather:
11574                  * "[:" ending in ":" but not in ":]" */
11575                 if (strict) {
11576                     vFAIL("Unmatched '[' in POSIX class");
11577                 }
11578
11579                 /* Grandfather lone [:, [=, [. */
11580                 RExC_parse = s;
11581             }
11582         }
11583     }
11584
11585     return namedclass;
11586 }
11587
11588 STATIC bool
11589 S_could_it_be_a_POSIX_class(pTHX_ RExC_state_t *pRExC_state)
11590 {
11591     /* This applies some heuristics at the current parse position (which should
11592      * be at a '[') to see if what follows might be intended to be a [:posix:]
11593      * class.  It returns true if it really is a posix class, of course, but it
11594      * also can return true if it thinks that what was intended was a posix
11595      * class that didn't quite make it.
11596      *
11597      * It will return true for
11598      *      [:alphanumerics:
11599      *      [:alphanumerics]  (as long as the ] isn't followed immediately by a
11600      *                         ')' indicating the end of the (?[
11601      *      [:any garbage including %^&$ punctuation:]
11602      *
11603      * This is designed to be called only from S_handle_regex_sets; it could be
11604      * easily adapted to be called from the spot at the beginning of regclass()
11605      * that checks to see in a normal bracketed class if the surrounding []
11606      * have been omitted ([:word:] instead of [[:word:]]).  But doing so would
11607      * change long-standing behavior, so I (khw) didn't do that */
11608     char* p = RExC_parse + 1;
11609     char first_char = *p;
11610
11611     PERL_ARGS_ASSERT_COULD_IT_BE_A_POSIX_CLASS;
11612
11613     assert(*(p - 1) == '[');
11614
11615     if (! POSIXCC(first_char)) {
11616         return FALSE;
11617     }
11618
11619     p++;
11620     while (p < RExC_end && isWORDCHAR(*p)) p++;
11621
11622     if (p >= RExC_end) {
11623         return FALSE;
11624     }
11625
11626     if (p - RExC_parse > 2    /* Got at least 1 word character */
11627         && (*p == first_char
11628             || (*p == ']' && p + 1 < RExC_end && *(p + 1) != ')')))
11629     {
11630         return TRUE;
11631     }
11632
11633     p = (char *) memchr(RExC_parse, ']', RExC_end - RExC_parse);
11634
11635     return (p
11636             && p - RExC_parse > 2 /* [:] evaluates to colon;
11637                                       [::] is a bad posix class. */
11638             && first_char == *(p - 1));
11639 }
11640
11641 STATIC regnode *
11642 S_handle_regex_sets(pTHX_ RExC_state_t *pRExC_state, SV** return_invlist, I32 *flagp, U32 depth,
11643                    char * const oregcomp_parse)
11644 {
11645     /* Handle the (?[...]) construct to do set operations */
11646
11647     U8 curchar;
11648     UV start, end;      /* End points of code point ranges */
11649     SV* result_string;
11650     char *save_end, *save_parse;
11651     SV* final;
11652     STRLEN len;
11653     regnode* node;
11654     AV* stack;
11655     const bool save_fold = FOLD;
11656
11657     GET_RE_DEBUG_FLAGS_DECL;
11658
11659     PERL_ARGS_ASSERT_HANDLE_REGEX_SETS;
11660
11661     if (LOC) {
11662         vFAIL("(?[...]) not valid in locale");
11663     }
11664     RExC_uni_semantics = 1;
11665
11666     /* This will return only an ANYOF regnode, or (unlikely) something smaller
11667      * (such as EXACT).  Thus we can skip most everything if just sizing.  We
11668      * call regclass to handle '[]' so as to not have to reinvent its parsing
11669      * rules here (throwing away the size it computes each time).  And, we exit
11670      * upon an unescaped ']' that isn't one ending a regclass.  To do both
11671      * these things, we need to realize that something preceded by a backslash
11672      * is escaped, so we have to keep track of backslashes */
11673     if (SIZE_ONLY) {
11674         UV depth = 0; /* how many nested (?[...]) constructs */
11675
11676         Perl_ck_warner_d(aTHX_
11677             packWARN(WARN_EXPERIMENTAL__REGEX_SETS),
11678             "The regex_sets feature is experimental" REPORT_LOCATION,
11679             (int) (RExC_parse - RExC_precomp) , RExC_precomp, RExC_parse);
11680
11681         while (RExC_parse < RExC_end) {
11682             SV* current = NULL;
11683             RExC_parse = regpatws(pRExC_state, RExC_parse,
11684                                 TRUE); /* means recognize comments */
11685             switch (*RExC_parse) {
11686                 case '?':
11687                     if (RExC_parse[1] == '[') depth++, RExC_parse++;
11688                     /* FALL THROUGH */
11689                 default:
11690                     break;
11691                 case '\\':
11692                     /* Skip the next byte (which could cause us to end up in
11693                      * the middle of a UTF-8 character, but since none of those
11694                      * are confusable with anything we currently handle in this
11695                      * switch (invariants all), it's safe.  We'll just hit the
11696                      * default: case next time and keep on incrementing until
11697                      * we find one of the invariants we do handle. */
11698                     RExC_parse++;
11699                     break;
11700                 case '[':
11701                 {
11702                     /* If this looks like it is a [:posix:] class, leave the
11703                      * parse pointer at the '[' to fool regclass() into
11704                      * thinking it is part of a '[[:posix:]]'.  That function
11705                      * will use strict checking to force a syntax error if it
11706                      * doesn't work out to a legitimate class */
11707                     bool is_posix_class
11708                                     = could_it_be_a_POSIX_class(pRExC_state);
11709                     if (! is_posix_class) {
11710                         RExC_parse++;
11711                     }
11712
11713                     /* regclass() can only return RESTART_UTF8 if multi-char
11714                        folds are allowed.  */
11715                     if (!regclass(pRExC_state, flagp,depth+1,
11716                                   is_posix_class, /* parse the whole char
11717                                                      class only if not a
11718                                                      posix class */
11719                                   FALSE, /* don't allow multi-char folds */
11720                                   TRUE, /* silence non-portable warnings. */
11721                                   &current))
11722                         FAIL2("panic: regclass returned NULL to handle_sets, flags=%#"UVxf"",
11723                               (UV) *flagp);
11724
11725                     /* function call leaves parse pointing to the ']', except
11726                      * if we faked it */
11727                     if (is_posix_class) {
11728                         RExC_parse--;
11729                     }
11730
11731                     SvREFCNT_dec(current);   /* In case it returned something */
11732                     break;
11733                 }
11734
11735                 case ']':
11736                     if (depth--) break;
11737                     RExC_parse++;
11738                     if (RExC_parse < RExC_end
11739                         && *RExC_parse == ')')
11740                     {
11741                         node = reganode(pRExC_state, ANYOF, 0);
11742                         RExC_size += ANYOF_SKIP;
11743                         nextchar(pRExC_state);
11744                         Set_Node_Length(node,
11745                                 RExC_parse - oregcomp_parse + 1); /* MJD */
11746                         return node;
11747                     }
11748                     goto no_close;
11749             }
11750             RExC_parse++;
11751         }
11752
11753         no_close:
11754         FAIL("Syntax error in (?[...])");
11755     }
11756
11757     /* Pass 2 only after this.  Everything in this construct is a
11758      * metacharacter.  Operands begin with either a '\' (for an escape
11759      * sequence), or a '[' for a bracketed character class.  Any other
11760      * character should be an operator, or parenthesis for grouping.  Both
11761      * types of operands are handled by calling regclass() to parse them.  It
11762      * is called with a parameter to indicate to return the computed inversion
11763      * list.  The parsing here is implemented via a stack.  Each entry on the
11764      * stack is a single character representing one of the operators, or the
11765      * '('; or else a pointer to an operand inversion list. */
11766
11767 #define IS_OPERAND(a)  (! SvIOK(a))
11768
11769     /* The stack starts empty.  It is a syntax error if the first thing parsed
11770      * is a binary operator; everything else is pushed on the stack.  When an
11771      * operand is parsed, the top of the stack is examined.  If it is a binary
11772      * operator, the item before it should be an operand, and both are replaced
11773      * by the result of doing that operation on the new operand and the one on
11774      * the stack.   Thus a sequence of binary operands is reduced to a single
11775      * one before the next one is parsed.
11776      *
11777      * A unary operator may immediately follow a binary in the input, for
11778      * example
11779      *      [a] + ! [b]
11780      * When an operand is parsed and the top of the stack is a unary operator,
11781      * the operation is performed, and then the stack is rechecked to see if
11782      * this new operand is part of a binary operation; if so, it is handled as
11783      * above.
11784      *
11785      * A '(' is simply pushed on the stack; it is valid only if the stack is
11786      * empty, or the top element of the stack is an operator or another '('
11787      * (for which the parenthesized expression will become an operand).  By the
11788      * time the corresponding ')' is parsed everything in between should have
11789      * been parsed and evaluated to a single operand (or else is a syntax
11790      * error), and is handled as a regular operand */
11791
11792     sv_2mortal((SV *)(stack = newAV()));
11793
11794     while (RExC_parse < RExC_end) {
11795         I32 top_index = av_tindex(stack);
11796         SV** top_ptr;
11797         SV* current = NULL;
11798
11799         /* Skip white space */
11800         RExC_parse = regpatws(pRExC_state, RExC_parse,
11801                                 TRUE); /* means recognize comments */
11802         if (RExC_parse >= RExC_end) {
11803             Perl_croak(aTHX_ "panic: Read past end of '(?[ ])'");
11804         }
11805         if ((curchar = UCHARAT(RExC_parse)) == ']') {
11806             break;
11807         }
11808
11809         switch (curchar) {
11810
11811             case '?':
11812                 if (av_tindex(stack) >= 0   /* This makes sure that we can
11813                                                safely subtract 1 from
11814                                                RExC_parse in the next clause.
11815                                                If we have something on the
11816                                                stack, we have parsed something
11817                                              */
11818                     && UCHARAT(RExC_parse - 1) == '('
11819                     && RExC_parse < RExC_end)
11820                 {
11821                     /* If is a '(?', could be an embedded '(?flags:(?[...])'.
11822                      * This happens when we have some thing like
11823                      *
11824                      *   my $thai_or_lao = qr/(?[ \p{Thai} + \p{Lao} ])/;
11825                      *   ...
11826                      *   qr/(?[ \p{Digit} & $thai_or_lao ])/;
11827                      *
11828                      * Here we would be handling the interpolated
11829                      * '$thai_or_lao'.  We handle this by a recursive call to
11830                      * ourselves which returns the inversion list the
11831                      * interpolated expression evaluates to.  We use the flags
11832                      * from the interpolated pattern. */
11833                     U32 save_flags = RExC_flags;
11834                     const char * const save_parse = ++RExC_parse;
11835
11836                     parse_lparen_question_flags(pRExC_state);
11837
11838                     if (RExC_parse == save_parse  /* Makes sure there was at
11839                                                      least one flag (or this
11840                                                      embedding wasn't compiled)
11841                                                    */
11842                         || RExC_parse >= RExC_end - 4
11843                         || UCHARAT(RExC_parse) != ':'
11844                         || UCHARAT(++RExC_parse) != '('
11845                         || UCHARAT(++RExC_parse) != '?'
11846                         || UCHARAT(++RExC_parse) != '[')
11847                     {
11848
11849                         /* In combination with the above, this moves the
11850                          * pointer to the point just after the first erroneous
11851                          * character (or if there are no flags, to where they
11852                          * should have been) */
11853                         if (RExC_parse >= RExC_end - 4) {
11854                             RExC_parse = RExC_end;
11855                         }
11856                         else if (RExC_parse != save_parse) {
11857                             RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
11858                         }
11859                         vFAIL("Expecting '(?flags:(?[...'");
11860                     }
11861                     RExC_parse++;
11862                     (void) handle_regex_sets(pRExC_state, &current, flagp,
11863                                                     depth+1, oregcomp_parse);
11864
11865                     /* Here, 'current' contains the embedded expression's
11866                      * inversion list, and RExC_parse points to the trailing
11867                      * ']'; the next character should be the ')' which will be
11868                      * paired with the '(' that has been put on the stack, so
11869                      * the whole embedded expression reduces to '(operand)' */
11870                     RExC_parse++;
11871
11872                     RExC_flags = save_flags;
11873                     goto handle_operand;
11874                 }
11875                 /* FALL THROUGH */
11876
11877             default:
11878                 RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
11879                 vFAIL("Unexpected character");
11880
11881             case '\\':
11882                 /* regclass() can only return RESTART_UTF8 if multi-char
11883                    folds are allowed.  */
11884                 if (!regclass(pRExC_state, flagp,depth+1,
11885                               TRUE, /* means parse just the next thing */
11886                               FALSE, /* don't allow multi-char folds */
11887                               FALSE, /* don't silence non-portable warnings.  */
11888                               &current))
11889                     FAIL2("panic: regclass returned NULL to handle_sets, flags=%#"UVxf"",
11890                           (UV) *flagp);
11891                 /* regclass() will return with parsing just the \ sequence,
11892                  * leaving the parse pointer at the next thing to parse */
11893                 RExC_parse--;
11894                 goto handle_operand;
11895
11896             case '[':   /* Is a bracketed character class */
11897             {
11898                 bool is_posix_class = could_it_be_a_POSIX_class(pRExC_state);
11899
11900                 if (! is_posix_class) {
11901                     RExC_parse++;
11902                 }
11903
11904                 /* regclass() can only return RESTART_UTF8 if multi-char
11905                    folds are allowed.  */
11906                 if(!regclass(pRExC_state, flagp,depth+1,
11907                              is_posix_class, /* parse the whole char class
11908                                                 only if not a posix class */
11909                              FALSE, /* don't allow multi-char folds */
11910                              FALSE, /* don't silence non-portable warnings.  */
11911                              &current))
11912                     FAIL2("panic: regclass returned NULL to handle_sets, flags=%#"UVxf"",
11913                           (UV) *flagp);
11914                 /* function call leaves parse pointing to the ']', except if we
11915                  * faked it */
11916                 if (is_posix_class) {
11917                     RExC_parse--;
11918                 }
11919
11920                 goto handle_operand;
11921             }
11922
11923             case '&':
11924             case '|':
11925             case '+':
11926             case '-':
11927             case '^':
11928                 if (top_index < 0
11929                     || ( ! (top_ptr = av_fetch(stack, top_index, FALSE)))
11930                     || ! IS_OPERAND(*top_ptr))
11931                 {
11932                     RExC_parse++;
11933                     vFAIL2("Unexpected binary operator '%c' with no preceding operand", curchar);
11934                 }
11935                 av_push(stack, newSVuv(curchar));
11936                 break;
11937
11938             case '!':
11939                 av_push(stack, newSVuv(curchar));
11940                 break;
11941
11942             case '(':
11943                 if (top_index >= 0) {
11944                     top_ptr = av_fetch(stack, top_index, FALSE);
11945                     assert(top_ptr);
11946                     if (IS_OPERAND(*top_ptr)) {
11947                         RExC_parse++;
11948                         vFAIL("Unexpected '(' with no preceding operator");
11949                     }
11950                 }
11951                 av_push(stack, newSVuv(curchar));
11952                 break;
11953
11954             case ')':
11955             {
11956                 SV* lparen;
11957                 if (top_index < 1
11958                     || ! (current = av_pop(stack))
11959                     || ! IS_OPERAND(current)
11960                     || ! (lparen = av_pop(stack))
11961                     || IS_OPERAND(lparen)
11962                     || SvUV(lparen) != '(')
11963                 {
11964                     SvREFCNT_dec(current);
11965                     RExC_parse++;
11966                     vFAIL("Unexpected ')'");
11967                 }
11968                 top_index -= 2;
11969                 SvREFCNT_dec_NN(lparen);
11970
11971                 /* FALL THROUGH */
11972             }
11973
11974               handle_operand:
11975
11976                 /* Here, we have an operand to process, in 'current' */
11977
11978                 if (top_index < 0) {    /* Just push if stack is empty */
11979                     av_push(stack, current);
11980                 }
11981                 else {
11982                     SV* top = av_pop(stack);
11983                     SV *prev = NULL;
11984                     char current_operator;
11985
11986                     if (IS_OPERAND(top)) {
11987                         SvREFCNT_dec_NN(top);
11988                         SvREFCNT_dec_NN(current);
11989                         vFAIL("Operand with no preceding operator");
11990                     }
11991                     current_operator = (char) SvUV(top);
11992                     switch (current_operator) {
11993                         case '(':   /* Push the '(' back on followed by the new
11994                                        operand */
11995                             av_push(stack, top);
11996                             av_push(stack, current);
11997                             SvREFCNT_inc(top);  /* Counters the '_dec' done
11998                                                    just after the 'break', so
11999                                                    it doesn't get wrongly freed
12000                                                  */
12001                             break;
12002
12003                         case '!':
12004                             _invlist_invert(current);
12005
12006                             /* Unlike binary operators, the top of the stack,
12007                              * now that this unary one has been popped off, may
12008                              * legally be an operator, and we now have operand
12009                              * for it. */
12010                             top_index--;
12011                             SvREFCNT_dec_NN(top);
12012                             goto handle_operand;
12013
12014                         case '&':
12015                             prev = av_pop(stack);
12016                             _invlist_intersection(prev,
12017                                                    current,
12018                                                    &current);
12019                             av_push(stack, current);
12020                             break;
12021
12022                         case '|':
12023                         case '+':
12024                             prev = av_pop(stack);
12025                             _invlist_union(prev, current, &current);
12026                             av_push(stack, current);
12027                             break;
12028
12029                         case '-':
12030                             prev = av_pop(stack);;
12031                             _invlist_subtract(prev, current, &current);
12032                             av_push(stack, current);
12033                             break;
12034
12035                         case '^':   /* The union minus the intersection */
12036                         {
12037                             SV* i = NULL;
12038                             SV* u = NULL;
12039                             SV* element;
12040
12041                             prev = av_pop(stack);
12042                             _invlist_union(prev, current, &u);
12043                             _invlist_intersection(prev, current, &i);
12044                             /* _invlist_subtract will overwrite current
12045                                 without freeing what it already contains */
12046                             element = current;
12047                             _invlist_subtract(u, i, &current);
12048                             av_push(stack, current);
12049                             SvREFCNT_dec_NN(i);
12050                             SvREFCNT_dec_NN(u);
12051                             SvREFCNT_dec_NN(element);
12052                             break;
12053                         }
12054
12055                         default:
12056                             Perl_croak(aTHX_ "panic: Unexpected item on '(?[ ])' stack");
12057                 }
12058                 SvREFCNT_dec_NN(top);
12059                 SvREFCNT_dec(prev);
12060             }
12061         }
12062
12063         RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
12064     }
12065
12066     if (av_tindex(stack) < 0   /* Was empty */
12067         || ((final = av_pop(stack)) == NULL)
12068         || ! IS_OPERAND(final)
12069         || av_tindex(stack) >= 0)  /* More left on stack */
12070     {
12071         vFAIL("Incomplete expression within '(?[ ])'");
12072     }
12073
12074     /* Here, 'final' is the resultant inversion list from evaluating the
12075      * expression.  Return it if so requested */
12076     if (return_invlist) {
12077         *return_invlist = final;
12078         return END;
12079     }
12080
12081     /* Otherwise generate a resultant node, based on 'final'.  regclass() is
12082      * expecting a string of ranges and individual code points */
12083     invlist_iterinit(final);
12084     result_string = newSVpvs("");
12085     while (invlist_iternext(final, &start, &end)) {
12086         if (start == end) {
12087             Perl_sv_catpvf(aTHX_ result_string, "\\x{%"UVXf"}", start);
12088         }
12089         else {
12090             Perl_sv_catpvf(aTHX_ result_string, "\\x{%"UVXf"}-\\x{%"UVXf"}",
12091                                                      start,          end);
12092         }
12093     }
12094
12095     save_parse = RExC_parse;
12096     RExC_parse = SvPV(result_string, len);
12097     save_end = RExC_end;
12098     RExC_end = RExC_parse + len;
12099
12100     /* We turn off folding around the call, as the class we have constructed
12101      * already has all folding taken into consideration, and we don't want
12102      * regclass() to add to that */
12103     RExC_flags &= ~RXf_PMf_FOLD;
12104     /* regclass() can only return RESTART_UTF8 if multi-char folds are allowed.
12105      */
12106     node = regclass(pRExC_state, flagp,depth+1,
12107                     FALSE, /* means parse the whole char class */
12108                     FALSE, /* don't allow multi-char folds */
12109                     TRUE, /* silence non-portable warnings.  The above may very
12110                              well have generated non-portable code points, but
12111                              they're valid on this machine */
12112                     NULL);
12113     if (!node)
12114         FAIL2("panic: regclass returned NULL to handle_sets, flags=%#"UVxf,
12115                     PTR2UV(flagp));
12116     if (save_fold) {
12117         RExC_flags |= RXf_PMf_FOLD;
12118     }
12119     RExC_parse = save_parse + 1;
12120     RExC_end = save_end;
12121     SvREFCNT_dec_NN(final);
12122     SvREFCNT_dec_NN(result_string);
12123
12124     nextchar(pRExC_state);
12125     Set_Node_Length(node, RExC_parse - oregcomp_parse + 1); /* MJD */
12126     return node;
12127 }
12128 #undef IS_OPERAND
12129
12130 /* The names of properties whose definitions are not known at compile time are
12131  * stored in this SV, after a constant heading.  So if the length has been
12132  * changed since initialization, then there is a run-time definition. */
12133 #define HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION (SvCUR(listsv) != initial_listsv_len)
12134
12135 STATIC regnode *
12136 S_regclass(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth,
12137                  const bool stop_at_1,  /* Just parse the next thing, don't
12138                                            look for a full character class */
12139                  bool allow_multi_folds,
12140                  const bool silence_non_portable,   /* Don't output warnings
12141                                                        about too large
12142                                                        characters */
12143                  SV** ret_invlist)  /* Return an inversion list, not a node */
12144 {
12145     /* parse a bracketed class specification.  Most of these will produce an
12146      * ANYOF node; but something like [a] will produce an EXACT node; [aA], an
12147      * EXACTFish node; [[:ascii:]], a POSIXA node; etc.  It is more complex
12148      * under /i with multi-character folds: it will be rewritten following the
12149      * paradigm of this example, where the <multi-fold>s are characters which
12150      * fold to multiple character sequences:
12151      *      /[abc\x{multi-fold1}def\x{multi-fold2}ghi]/i
12152      * gets effectively rewritten as:
12153      *      /(?:\x{multi-fold1}|\x{multi-fold2}|[abcdefghi]/i
12154      * reg() gets called (recursively) on the rewritten version, and this
12155      * function will return what it constructs.  (Actually the <multi-fold>s
12156      * aren't physically removed from the [abcdefghi], it's just that they are
12157      * ignored in the recursion by means of a flag:
12158      * <RExC_in_multi_char_class>.)
12159      *
12160      * ANYOF nodes contain a bit map for the first 256 characters, with the
12161      * corresponding bit set if that character is in the list.  For characters
12162      * above 255, a range list or swash is used.  There are extra bits for \w,
12163      * etc. in locale ANYOFs, as what these match is not determinable at
12164      * compile time
12165      *
12166      * Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan needs
12167      * to be restarted.  This can only happen if ret_invlist is non-NULL.
12168      */
12169
12170     dVAR;
12171     UV prevvalue = OOB_UNICODE, save_prevvalue = OOB_UNICODE;
12172     IV range = 0;
12173     UV value = OOB_UNICODE, save_value = OOB_UNICODE;
12174     regnode *ret;
12175     STRLEN numlen;
12176     IV namedclass = OOB_NAMEDCLASS;
12177     char *rangebegin = NULL;
12178     bool need_class = 0;
12179     SV *listsv = NULL;
12180     STRLEN initial_listsv_len = 0; /* Kind of a kludge to see if it is more
12181                                       than just initialized.  */
12182     SV* properties = NULL;    /* Code points that match \p{} \P{} */
12183     SV* posixes = NULL;     /* Code points that match classes like, [:word:],
12184                                extended beyond the Latin1 range */
12185     UV element_count = 0;   /* Number of distinct elements in the class.
12186                                Optimizations may be possible if this is tiny */
12187     AV * multi_char_matches = NULL; /* Code points that fold to more than one
12188                                        character; used under /i */
12189     UV n;
12190     char * stop_ptr = RExC_end;    /* where to stop parsing */
12191     const bool skip_white = cBOOL(ret_invlist); /* ignore unescaped white
12192                                                    space? */
12193     const bool strict = cBOOL(ret_invlist); /* Apply strict parsing rules? */
12194
12195     /* Unicode properties are stored in a swash; this holds the current one
12196      * being parsed.  If this swash is the only above-latin1 component of the
12197      * character class, an optimization is to pass it directly on to the
12198      * execution engine.  Otherwise, it is set to NULL to indicate that there
12199      * are other things in the class that have to be dealt with at execution
12200      * time */
12201     SV* swash = NULL;           /* Code points that match \p{} \P{} */
12202
12203     /* Set if a component of this character class is user-defined; just passed
12204      * on to the engine */
12205     bool has_user_defined_property = FALSE;
12206
12207     /* inversion list of code points this node matches only when the target
12208      * string is in UTF-8.  (Because is under /d) */
12209     SV* depends_list = NULL;
12210
12211     /* inversion list of code points this node matches.  For much of the
12212      * function, it includes only those that match regardless of the utf8ness
12213      * of the target string */
12214     SV* cp_list = NULL;
12215
12216 #ifdef EBCDIC
12217     /* In a range, counts how many 0-2 of the ends of it came from literals,
12218      * not escapes.  Thus we can tell if 'A' was input vs \x{C1} */
12219     UV literal_endpoint = 0;
12220 #endif
12221     bool invert = FALSE;    /* Is this class to be complemented */
12222
12223     /* Is there any thing like \W or [:^digit:] that matches above the legal
12224      * Unicode range? */
12225     bool runtime_posix_matches_above_Unicode = FALSE;
12226
12227     regnode * const orig_emit = RExC_emit; /* Save the original RExC_emit in
12228         case we need to change the emitted regop to an EXACT. */
12229     const char * orig_parse = RExC_parse;
12230     const I32 orig_size = RExC_size;
12231     GET_RE_DEBUG_FLAGS_DECL;
12232
12233     PERL_ARGS_ASSERT_REGCLASS;
12234 #ifndef DEBUGGING
12235     PERL_UNUSED_ARG(depth);
12236 #endif
12237
12238     DEBUG_PARSE("clas");
12239
12240     /* Assume we are going to generate an ANYOF node. */
12241     ret = reganode(pRExC_state, ANYOF, 0);
12242
12243     if (SIZE_ONLY) {
12244         RExC_size += ANYOF_SKIP;
12245         listsv = &PL_sv_undef; /* For code scanners: listsv always non-NULL. */
12246     }
12247     else {
12248         ANYOF_FLAGS(ret) = 0;
12249
12250         RExC_emit += ANYOF_SKIP;
12251         if (LOC) {
12252             ANYOF_FLAGS(ret) |= ANYOF_LOCALE;
12253         }
12254         listsv = newSVpvs_flags("# comment\n", SVs_TEMP);
12255         initial_listsv_len = SvCUR(listsv);
12256         SvTEMP_off(listsv); /* Grr, TEMPs and mortals are conflated.  */
12257     }
12258
12259     if (skip_white) {
12260         RExC_parse = regpatws(pRExC_state, RExC_parse,
12261                               FALSE /* means don't recognize comments */);
12262     }
12263
12264     if (UCHARAT(RExC_parse) == '^') {   /* Complement of range. */
12265         RExC_parse++;
12266         invert = TRUE;
12267         allow_multi_folds = FALSE;
12268         RExC_naughty++;
12269         if (skip_white) {
12270             RExC_parse = regpatws(pRExC_state, RExC_parse,
12271                                   FALSE /* means don't recognize comments */);
12272         }
12273     }
12274
12275     /* Check that they didn't say [:posix:] instead of [[:posix:]] */
12276     if (!SIZE_ONLY && RExC_parse < RExC_end && POSIXCC(UCHARAT(RExC_parse))) {
12277         const char *s = RExC_parse;
12278         const char  c = *s++;
12279
12280         while (isWORDCHAR(*s))
12281             s++;
12282         if (*s && c == *s && s[1] == ']') {
12283             SAVEFREESV(RExC_rx_sv);
12284             ckWARN3reg(s+2,
12285                        "POSIX syntax [%c %c] belongs inside character classes",
12286                        c, c);
12287             (void)ReREFCNT_inc(RExC_rx_sv);
12288         }
12289     }
12290
12291     /* If the caller wants us to just parse a single element, accomplish this
12292      * by faking the loop ending condition */
12293     if (stop_at_1 && RExC_end > RExC_parse) {
12294         stop_ptr = RExC_parse + 1;
12295     }
12296
12297     /* allow 1st char to be ']' (allowing it to be '-' is dealt with later) */
12298     if (UCHARAT(RExC_parse) == ']')
12299         goto charclassloop;
12300
12301 parseit:
12302     while (1) {
12303         if  (RExC_parse >= stop_ptr) {
12304             break;
12305         }
12306
12307         if (skip_white) {
12308             RExC_parse = regpatws(pRExC_state, RExC_parse,
12309                                   FALSE /* means don't recognize comments */);
12310         }
12311
12312         if  (UCHARAT(RExC_parse) == ']') {
12313             break;
12314         }
12315
12316     charclassloop:
12317
12318         namedclass = OOB_NAMEDCLASS; /* initialize as illegal */
12319         save_value = value;
12320         save_prevvalue = prevvalue;
12321
12322         if (!range) {
12323             rangebegin = RExC_parse;
12324             element_count++;
12325         }
12326         if (UTF) {
12327             value = utf8n_to_uvchr((U8*)RExC_parse,
12328                                    RExC_end - RExC_parse,
12329                                    &numlen, UTF8_ALLOW_DEFAULT);
12330             RExC_parse += numlen;
12331         }
12332         else
12333             value = UCHARAT(RExC_parse++);
12334
12335         if (value == '['
12336             && RExC_parse < RExC_end
12337             && POSIXCC(UCHARAT(RExC_parse)))
12338         {
12339             namedclass = regpposixcc(pRExC_state, value, strict);
12340         }
12341         else if (value == '\\') {
12342             if (UTF) {
12343                 value = utf8n_to_uvchr((U8*)RExC_parse,
12344                                    RExC_end - RExC_parse,
12345                                    &numlen, UTF8_ALLOW_DEFAULT);
12346                 RExC_parse += numlen;
12347             }
12348             else
12349                 value = UCHARAT(RExC_parse++);
12350
12351             /* Some compilers cannot handle switching on 64-bit integer
12352              * values, therefore value cannot be an UV.  Yes, this will
12353              * be a problem later if we want switch on Unicode.
12354              * A similar issue a little bit later when switching on
12355              * namedclass. --jhi */
12356
12357             /* If the \ is escaping white space when white space is being
12358              * skipped, it means that that white space is wanted literally, and
12359              * is already in 'value'.  Otherwise, need to translate the escape
12360              * into what it signifies. */
12361             if (! skip_white || ! is_PATWS_cp(value)) switch ((I32)value) {
12362
12363             case 'w':   namedclass = ANYOF_WORDCHAR;    break;
12364             case 'W':   namedclass = ANYOF_NWORDCHAR;   break;
12365             case 's':   namedclass = ANYOF_SPACE;       break;
12366             case 'S':   namedclass = ANYOF_NSPACE;      break;
12367             case 'd':   namedclass = ANYOF_DIGIT;       break;
12368             case 'D':   namedclass = ANYOF_NDIGIT;      break;
12369             case 'v':   namedclass = ANYOF_VERTWS;      break;
12370             case 'V':   namedclass = ANYOF_NVERTWS;     break;
12371             case 'h':   namedclass = ANYOF_HORIZWS;     break;
12372             case 'H':   namedclass = ANYOF_NHORIZWS;    break;
12373             case 'N':  /* Handle \N{NAME} in class */
12374                 {
12375                     /* We only pay attention to the first char of 
12376                     multichar strings being returned. I kinda wonder
12377                     if this makes sense as it does change the behaviour
12378                     from earlier versions, OTOH that behaviour was broken
12379                     as well. */
12380                     if (! grok_bslash_N(pRExC_state, NULL, &value, flagp, depth,
12381                                       TRUE, /* => charclass */
12382                                       strict))
12383                     {
12384                         if (*flagp & RESTART_UTF8)
12385                             FAIL("panic: grok_bslash_N set RESTART_UTF8");
12386                         goto parseit;
12387                     }
12388                 }
12389                 break;
12390             case 'p':
12391             case 'P':
12392                 {
12393                 char *e;
12394
12395                 /* We will handle any undefined properties ourselves */
12396                 U8 swash_init_flags = _CORE_SWASH_INIT_RETURN_IF_UNDEF;
12397
12398                 if (RExC_parse >= RExC_end)
12399                     vFAIL2("Empty \\%c{}", (U8)value);
12400                 if (*RExC_parse == '{') {
12401                     const U8 c = (U8)value;
12402                     e = strchr(RExC_parse++, '}');
12403                     if (!e)
12404                         vFAIL2("Missing right brace on \\%c{}", c);
12405                     while (isSPACE(UCHARAT(RExC_parse)))
12406                         RExC_parse++;
12407                     if (e == RExC_parse)
12408                         vFAIL2("Empty \\%c{}", c);
12409                     n = e - RExC_parse;
12410                     while (isSPACE(UCHARAT(RExC_parse + n - 1)))
12411                         n--;
12412                 }
12413                 else {
12414                     e = RExC_parse;
12415                     n = 1;
12416                 }
12417                 if (!SIZE_ONLY) {
12418                     SV* invlist;
12419                     char* name;
12420
12421                     if (UCHARAT(RExC_parse) == '^') {
12422                          RExC_parse++;
12423                          n--;
12424                          /* toggle.  (The rhs xor gets the single bit that
12425                           * differs between P and p; the other xor inverts just
12426                           * that bit) */
12427                          value ^= 'P' ^ 'p';
12428
12429                          while (isSPACE(UCHARAT(RExC_parse))) {
12430                               RExC_parse++;
12431                               n--;
12432                          }
12433                     }
12434                     /* Try to get the definition of the property into
12435                      * <invlist>.  If /i is in effect, the effective property
12436                      * will have its name be <__NAME_i>.  The design is
12437                      * discussed in commit
12438                      * 2f833f5208e26b208886e51e09e2c072b5eabb46 */
12439                     Newx(name, n + sizeof("_i__\n"), char);
12440
12441                     sprintf(name, "%s%.*s%s\n",
12442                                     (FOLD) ? "__" : "",
12443                                     (int)n,
12444                                     RExC_parse,
12445                                     (FOLD) ? "_i" : ""
12446                     );
12447
12448                     /* Look up the property name, and get its swash and
12449                      * inversion list, if the property is found  */
12450                     if (swash) {
12451                         SvREFCNT_dec_NN(swash);
12452                     }
12453                     swash = _core_swash_init("utf8", name, &PL_sv_undef,
12454                                              1, /* binary */
12455                                              0, /* not tr/// */
12456                                              NULL, /* No inversion list */
12457                                              &swash_init_flags
12458                                             );
12459                     if (! swash || ! (invlist = _get_swash_invlist(swash))) {
12460                         if (swash) {
12461                             SvREFCNT_dec_NN(swash);
12462                             swash = NULL;
12463                         }
12464
12465                         /* Here didn't find it.  It could be a user-defined
12466                          * property that will be available at run-time.  If we
12467                          * accept only compile-time properties, is an error;
12468                          * otherwise add it to the list for run-time look up */
12469                         if (ret_invlist) {
12470                             RExC_parse = e + 1;
12471                             vFAIL3("Property '%.*s' is unknown", (int) n, name);
12472                         }
12473                         Perl_sv_catpvf(aTHX_ listsv, "%cutf8::%s\n",
12474                                         (value == 'p' ? '+' : '!'),
12475                                         name);
12476                         has_user_defined_property = TRUE;
12477
12478                         /* We don't know yet, so have to assume that the
12479                          * property could match something in the Latin1 range,
12480                          * hence something that isn't utf8.  Note that this
12481                          * would cause things in <depends_list> to match
12482                          * inappropriately, except that any \p{}, including
12483                          * this one forces Unicode semantics, which means there
12484                          * is <no depends_list> */
12485                         ANYOF_FLAGS(ret) |= ANYOF_NONBITMAP_NON_UTF8;
12486                     }
12487                     else {
12488
12489                         /* Here, did get the swash and its inversion list.  If
12490                          * the swash is from a user-defined property, then this
12491                          * whole character class should be regarded as such */
12492                         has_user_defined_property =
12493                                     (swash_init_flags
12494                                      & _CORE_SWASH_INIT_USER_DEFINED_PROPERTY);
12495
12496                         /* Invert if asking for the complement */
12497                         if (value == 'P') {
12498                             _invlist_union_complement_2nd(properties,
12499                                                           invlist,
12500                                                           &properties);
12501
12502                             /* The swash can't be used as-is, because we've
12503                              * inverted things; delay removing it to here after
12504                              * have copied its invlist above */
12505                             SvREFCNT_dec_NN(swash);
12506                             swash = NULL;
12507                         }
12508                         else {
12509                             _invlist_union(properties, invlist, &properties);
12510                         }
12511                     }
12512                     Safefree(name);
12513                 }
12514                 RExC_parse = e + 1;
12515                 namedclass = ANYOF_UNIPROP;  /* no official name, but it's
12516                                                 named */
12517
12518                 /* \p means they want Unicode semantics */
12519                 RExC_uni_semantics = 1;
12520                 }
12521                 break;
12522             case 'n':   value = '\n';                   break;
12523             case 'r':   value = '\r';                   break;
12524             case 't':   value = '\t';                   break;
12525             case 'f':   value = '\f';                   break;
12526             case 'b':   value = '\b';                   break;
12527             case 'e':   value = ASCII_TO_NATIVE('\033');break;
12528             case 'a':   value = ASCII_TO_NATIVE('\007');break;
12529             case 'o':
12530                 RExC_parse--;   /* function expects to be pointed at the 'o' */
12531                 {
12532                     const char* error_msg;
12533                     bool valid = grok_bslash_o(&RExC_parse,
12534                                                &value,
12535                                                &error_msg,
12536                                                SIZE_ONLY,   /* warnings in pass
12537                                                                1 only */
12538                                                strict,
12539                                                silence_non_portable,
12540                                                UTF);
12541                     if (! valid) {
12542                         vFAIL(error_msg);
12543                     }
12544                 }
12545                 if (PL_encoding && value < 0x100) {
12546                     goto recode_encoding;
12547                 }
12548                 break;
12549             case 'x':
12550                 RExC_parse--;   /* function expects to be pointed at the 'x' */
12551                 {
12552                     const char* error_msg;
12553                     bool valid = grok_bslash_x(&RExC_parse,
12554                                                &value,
12555                                                &error_msg,
12556                                                TRUE, /* Output warnings */
12557                                                strict,
12558                                                silence_non_portable,
12559                                                UTF);
12560                     if (! valid) {
12561                         vFAIL(error_msg);
12562                     }
12563                 }
12564                 if (PL_encoding && value < 0x100)
12565                     goto recode_encoding;
12566                 break;
12567             case 'c':
12568                 value = grok_bslash_c(*RExC_parse++, UTF, SIZE_ONLY);
12569                 break;
12570             case '0': case '1': case '2': case '3': case '4':
12571             case '5': case '6': case '7':
12572                 {
12573                     /* Take 1-3 octal digits */
12574                     I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
12575                     numlen = (strict) ? 4 : 3;
12576                     value = grok_oct(--RExC_parse, &numlen, &flags, NULL);
12577                     RExC_parse += numlen;
12578                     if (numlen != 3) {
12579                         if (strict) {
12580                             RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
12581                             vFAIL("Need exactly 3 octal digits");
12582                         }
12583                         else if (! SIZE_ONLY /* like \08, \178 */
12584                                  && numlen < 3
12585                                  && RExC_parse < RExC_end
12586                                  && isDIGIT(*RExC_parse)
12587                                  && ckWARN(WARN_REGEXP))
12588                         {
12589                             SAVEFREESV(RExC_rx_sv);
12590                             reg_warn_non_literal_string(
12591                                  RExC_parse + 1,
12592                                  form_short_octal_warning(RExC_parse, numlen));
12593                             (void)ReREFCNT_inc(RExC_rx_sv);
12594                         }
12595                     }
12596                     if (PL_encoding && value < 0x100)
12597                         goto recode_encoding;
12598                     break;
12599                 }
12600             recode_encoding:
12601                 if (! RExC_override_recoding) {
12602                     SV* enc = PL_encoding;
12603                     value = reg_recode((const char)(U8)value, &enc);
12604                     if (!enc) {
12605                         if (strict) {
12606                             vFAIL("Invalid escape in the specified encoding");
12607                         }
12608                         else if (SIZE_ONLY) {
12609                             ckWARNreg(RExC_parse,
12610                                   "Invalid escape in the specified encoding");
12611                         }
12612                     }
12613                     break;
12614                 }
12615             default:
12616                 /* Allow \_ to not give an error */
12617                 if (!SIZE_ONLY && isWORDCHAR(value) && value != '_') {
12618                     if (strict) {
12619                         vFAIL2("Unrecognized escape \\%c in character class",
12620                                (int)value);
12621                     }
12622                     else {
12623                         SAVEFREESV(RExC_rx_sv);
12624                         ckWARN2reg(RExC_parse,
12625                             "Unrecognized escape \\%c in character class passed through",
12626                             (int)value);
12627                         (void)ReREFCNT_inc(RExC_rx_sv);
12628                     }
12629                 }
12630                 break;
12631             }   /* End of switch on char following backslash */
12632         } /* end of handling backslash escape sequences */
12633 #ifdef EBCDIC
12634         else
12635             literal_endpoint++;
12636 #endif
12637
12638         /* Here, we have the current token in 'value' */
12639
12640         /* What matches in a locale is not known until runtime.  This includes
12641          * what the Posix classes (like \w, [:space:]) match.  Room must be
12642          * reserved (one time per class) to store such classes, either if Perl
12643          * is compiled so that locale nodes always should have this space, or
12644          * if there is such class info to be stored.  The space will contain a
12645          * bit for each named class that is to be matched against.  This isn't
12646          * needed for \p{} and pseudo-classes, as they are not affected by
12647          * locale, and hence are dealt with separately */
12648         if (LOC
12649             && ! need_class
12650             && (ANYOF_LOCALE == ANYOF_CLASS
12651                 || (namedclass > OOB_NAMEDCLASS && namedclass < ANYOF_MAX)))
12652         {
12653             need_class = 1;
12654             if (SIZE_ONLY) {
12655                 RExC_size += ANYOF_CLASS_SKIP - ANYOF_SKIP;
12656             }
12657             else {
12658                 RExC_emit += ANYOF_CLASS_SKIP - ANYOF_SKIP;
12659                 ANYOF_CLASS_ZERO(ret);
12660             }
12661             ANYOF_FLAGS(ret) |= ANYOF_CLASS;
12662         }
12663
12664         if (namedclass > OOB_NAMEDCLASS) { /* this is a named class \blah */
12665
12666             /* a bad range like a-\d, a-[:digit:].  The '-' is taken as a
12667              * literal, as is the character that began the false range, i.e.
12668              * the 'a' in the examples */
12669             if (range) {
12670                 if (!SIZE_ONLY) {
12671                     const int w = (RExC_parse >= rangebegin)
12672                                   ? RExC_parse - rangebegin
12673                                   : 0;
12674                     if (strict) {
12675                         vFAIL4("False [] range \"%*.*s\"", w, w, rangebegin);
12676                     }
12677                     else {
12678                         SAVEFREESV(RExC_rx_sv); /* in case of fatal warnings */
12679                         ckWARN4reg(RExC_parse,
12680                                 "False [] range \"%*.*s\"",
12681                                 w, w, rangebegin);
12682                         (void)ReREFCNT_inc(RExC_rx_sv);
12683                         cp_list = add_cp_to_invlist(cp_list, '-');
12684                         cp_list = add_cp_to_invlist(cp_list, prevvalue);
12685                     }
12686                 }
12687
12688                 range = 0; /* this was not a true range */
12689                 element_count += 2; /* So counts for three values */
12690             }
12691
12692             if (! SIZE_ONLY) {
12693                 U8 classnum = namedclass_to_classnum(namedclass);
12694                 if (namedclass >= ANYOF_MAX) {  /* If a special class */
12695                     if (namedclass != ANYOF_UNIPROP) { /* UNIPROP = \p and \P */
12696
12697                         /* Here, should be \h, \H, \v, or \V.  Neither /d nor
12698                          * /l make a difference in what these match.  There
12699                          * would be problems if these characters had folds
12700                          * other than themselves, as cp_list is subject to
12701                          * folding. */
12702                         if (classnum != _CC_VERTSPACE) {
12703                             assert(   namedclass == ANYOF_HORIZWS
12704                                    || namedclass == ANYOF_NHORIZWS);
12705
12706                             /* It turns out that \h is just a synonym for
12707                              * XPosixBlank */
12708                             classnum = _CC_BLANK;
12709                         }
12710
12711                         _invlist_union_maybe_complement_2nd(
12712                                 cp_list,
12713                                 PL_XPosix_ptrs[classnum],
12714                                 cBOOL(namedclass % 2), /* Complement if odd
12715                                                           (NHORIZWS, NVERTWS)
12716                                                         */
12717                                 &cp_list);
12718                     }
12719                 }
12720                 else if (classnum == _CC_ASCII) {
12721 #ifdef HAS_ISASCII
12722                     if (LOC) {
12723                         ANYOF_CLASS_SET(ret, namedclass);
12724                     }
12725                     else
12726 #endif  /* Not isascii(); just use the hard-coded definition for it */
12727                         _invlist_union_maybe_complement_2nd(
12728                                 posixes,
12729                                 PL_ASCII,
12730                                 cBOOL(namedclass % 2), /* Complement if odd
12731                                                           (NASCII) */
12732                                 &posixes);
12733                 }
12734                 else {  /* Garden variety class */
12735
12736                     /* The ascii range inversion list */
12737                     SV* ascii_source = PL_Posix_ptrs[classnum];
12738
12739                     /* The full Latin1 range inversion list */
12740                     SV* l1_source = PL_L1Posix_ptrs[classnum];
12741
12742                     /* This code is structured into two major clauses.  The
12743                      * first is for classes whose complete definitions may not
12744                      * already be known.  It not, the Latin1 definition
12745                      * (guaranteed to already known) is used plus code is
12746                      * generated to load the rest at run-time (only if needed).
12747                      * If the complete definition is known, it drops down to
12748                      * the second clause, where the complete definition is
12749                      * known */
12750
12751                     if (classnum < _FIRST_NON_SWASH_CC) {
12752
12753                         /* Here, the class has a swash, which may or not
12754                          * already be loaded */
12755
12756                         /* The name of the property to use to match the full
12757                          * eXtended Unicode range swash for this character
12758                          * class */
12759                         const char *Xname = swash_property_names[classnum];
12760
12761                         /* If returning the inversion list, we can't defer
12762                          * getting this until runtime */
12763                         if (ret_invlist && !  PL_utf8_swash_ptrs[classnum]) {
12764                             PL_utf8_swash_ptrs[classnum] =
12765                                 _core_swash_init("utf8", Xname, &PL_sv_undef,
12766                                              1, /* binary */
12767                                              0, /* not tr/// */
12768                                              NULL, /* No inversion list */
12769                                              NULL  /* No flags */
12770                                             );
12771                             assert(PL_utf8_swash_ptrs[classnum]);
12772                         }
12773                         if ( !  PL_utf8_swash_ptrs[classnum]) {
12774                             if (namedclass % 2 == 0) { /* A non-complemented
12775                                                           class */
12776                                 /* If not /a matching, there are code points we
12777                                  * don't know at compile time.  Arrange for the
12778                                  * unknown matches to be loaded at run-time, if
12779                                  * needed */
12780                                 if (! AT_LEAST_ASCII_RESTRICTED) {
12781                                     Perl_sv_catpvf(aTHX_ listsv, "+utf8::%s\n",
12782                                                                  Xname);
12783                                 }
12784                                 if (LOC) {  /* Under locale, set run-time
12785                                                lookup */
12786                                     ANYOF_CLASS_SET(ret, namedclass);
12787                                 }
12788                                 else {
12789                                     /* Add the current class's code points to
12790                                      * the running total */
12791                                     _invlist_union(posixes,
12792                                                    (AT_LEAST_ASCII_RESTRICTED)
12793                                                         ? ascii_source
12794                                                         : l1_source,
12795                                                    &posixes);
12796                                 }
12797                             }
12798                             else {  /* A complemented class */
12799                                 if (AT_LEAST_ASCII_RESTRICTED) {
12800                                     /* Under /a should match everything above
12801                                      * ASCII, plus the complement of the set's
12802                                      * ASCII matches */
12803                                     _invlist_union_complement_2nd(posixes,
12804                                                                   ascii_source,
12805                                                                   &posixes);
12806                                 }
12807                                 else {
12808                                     /* Arrange for the unknown matches to be
12809                                      * loaded at run-time, if needed */
12810                                     Perl_sv_catpvf(aTHX_ listsv, "!utf8::%s\n",
12811                                                                  Xname);
12812                                     runtime_posix_matches_above_Unicode = TRUE;
12813                                     if (LOC) {
12814                                         ANYOF_CLASS_SET(ret, namedclass);
12815                                     }
12816                                     else {
12817
12818                                         /* We want to match everything in
12819                                          * Latin1, except those things that
12820                                          * l1_source matches */
12821                                         SV* scratch_list = NULL;
12822                                         _invlist_subtract(PL_Latin1, l1_source,
12823                                                           &scratch_list);
12824
12825                                         /* Add the list from this class to the
12826                                          * running total */
12827                                         if (! posixes) {
12828                                             posixes = scratch_list;
12829                                         }
12830                                         else {
12831                                             _invlist_union(posixes,
12832                                                            scratch_list,
12833                                                            &posixes);
12834                                             SvREFCNT_dec_NN(scratch_list);
12835                                         }
12836                                         if (DEPENDS_SEMANTICS) {
12837                                             ANYOF_FLAGS(ret)
12838                                                   |= ANYOF_NON_UTF8_LATIN1_ALL;
12839                                         }
12840                                     }
12841                                 }
12842                             }
12843                             goto namedclass_done;
12844                         }
12845
12846                         /* Here, there is a swash loaded for the class.  If no
12847                          * inversion list for it yet, get it */
12848                         if (! PL_XPosix_ptrs[classnum]) {
12849                             PL_XPosix_ptrs[classnum]
12850                              = _swash_to_invlist(PL_utf8_swash_ptrs[classnum]);
12851                         }
12852                     }
12853
12854                     /* Here there is an inversion list already loaded for the
12855                      * entire class */
12856
12857                     if (namedclass % 2 == 0) {  /* A non-complemented class,
12858                                                    like ANYOF_PUNCT */
12859                         if (! LOC) {
12860                             /* For non-locale, just add it to any existing list
12861                              * */
12862                             _invlist_union(posixes,
12863                                            (AT_LEAST_ASCII_RESTRICTED)
12864                                                ? ascii_source
12865                                                : PL_XPosix_ptrs[classnum],
12866                                            &posixes);
12867                         }
12868                         else {  /* Locale */
12869                             SV* scratch_list = NULL;
12870
12871                             /* For above Latin1 code points, we use the full
12872                              * Unicode range */
12873                             _invlist_intersection(PL_AboveLatin1,
12874                                                   PL_XPosix_ptrs[classnum],
12875                                                   &scratch_list);
12876                             /* And set the output to it, adding instead if
12877                              * there already is an output.  Checking if
12878                              * 'posixes' is NULL first saves an extra clone.
12879                              * Its reference count will be decremented at the
12880                              * next union, etc, or if this is the only
12881                              * instance, at the end of the routine */
12882                             if (! posixes) {
12883                                 posixes = scratch_list;
12884                             }
12885                             else {
12886                                 _invlist_union(posixes, scratch_list, &posixes);
12887                                 SvREFCNT_dec_NN(scratch_list);
12888                             }
12889
12890 #ifndef HAS_ISBLANK
12891                             if (namedclass != ANYOF_BLANK) {
12892 #endif
12893                                 /* Set this class in the node for runtime
12894                                  * matching */
12895                                 ANYOF_CLASS_SET(ret, namedclass);
12896 #ifndef HAS_ISBLANK
12897                             }
12898                             else {
12899                                 /* No isblank(), use the hard-coded ASCII-range
12900                                  * blanks, adding them to the running total. */
12901
12902                                 _invlist_union(posixes, ascii_source, &posixes);
12903                             }
12904 #endif
12905                         }
12906                     }
12907                     else {  /* A complemented class, like ANYOF_NPUNCT */
12908                         if (! LOC) {
12909                             _invlist_union_complement_2nd(
12910                                                 posixes,
12911                                                 (AT_LEAST_ASCII_RESTRICTED)
12912                                                     ? ascii_source
12913                                                     : PL_XPosix_ptrs[classnum],
12914                                                 &posixes);
12915                             /* Under /d, everything in the upper half of the
12916                              * Latin1 range matches this complement */
12917                             if (DEPENDS_SEMANTICS) {
12918                                 ANYOF_FLAGS(ret) |= ANYOF_NON_UTF8_LATIN1_ALL;
12919                             }
12920                         }
12921                         else {  /* Locale */
12922                             SV* scratch_list = NULL;
12923                             _invlist_subtract(PL_AboveLatin1,
12924                                               PL_XPosix_ptrs[classnum],
12925                                               &scratch_list);
12926                             if (! posixes) {
12927                                 posixes = scratch_list;
12928                             }
12929                             else {
12930                                 _invlist_union(posixes, scratch_list, &posixes);
12931                                 SvREFCNT_dec_NN(scratch_list);
12932                             }
12933 #ifndef HAS_ISBLANK
12934                             if (namedclass != ANYOF_NBLANK) {
12935 #endif
12936                                 ANYOF_CLASS_SET(ret, namedclass);
12937 #ifndef HAS_ISBLANK
12938                             }
12939                             else {
12940                                 /* Get the list of all code points in Latin1
12941                                  * that are not ASCII blanks, and add them to
12942                                  * the running total */
12943                                 _invlist_subtract(PL_Latin1, ascii_source,
12944                                                   &scratch_list);
12945                                 _invlist_union(posixes, scratch_list, &posixes);
12946                                 SvREFCNT_dec_NN(scratch_list);
12947                             }
12948 #endif
12949                         }
12950                     }
12951                 }
12952               namedclass_done:
12953                 continue;   /* Go get next character */
12954             }
12955         } /* end of namedclass \blah */
12956
12957         /* Here, we have a single value.  If 'range' is set, it is the ending
12958          * of a range--check its validity.  Later, we will handle each
12959          * individual code point in the range.  If 'range' isn't set, this
12960          * could be the beginning of a range, so check for that by looking
12961          * ahead to see if the next real character to be processed is the range
12962          * indicator--the minus sign */
12963
12964         if (skip_white) {
12965             RExC_parse = regpatws(pRExC_state, RExC_parse,
12966                                 FALSE /* means don't recognize comments */);
12967         }
12968
12969         if (range) {
12970             if (prevvalue > value) /* b-a */ {
12971                 const int w = RExC_parse - rangebegin;
12972                 Simple_vFAIL4("Invalid [] range \"%*.*s\"", w, w, rangebegin);
12973                 range = 0; /* not a valid range */
12974             }
12975         }
12976         else {
12977             prevvalue = value; /* save the beginning of the potential range */
12978             if (! stop_at_1     /* Can't be a range if parsing just one thing */
12979                 && *RExC_parse == '-')
12980             {
12981                 char* next_char_ptr = RExC_parse + 1;
12982                 if (skip_white) {   /* Get the next real char after the '-' */
12983                     next_char_ptr = regpatws(pRExC_state,
12984                                              RExC_parse + 1,
12985                                              FALSE); /* means don't recognize
12986                                                         comments */
12987                 }
12988
12989                 /* If the '-' is at the end of the class (just before the ']',
12990                  * it is a literal minus; otherwise it is a range */
12991                 if (next_char_ptr < RExC_end && *next_char_ptr != ']') {
12992                     RExC_parse = next_char_ptr;
12993
12994                     /* a bad range like \w-, [:word:]- ? */
12995                     if (namedclass > OOB_NAMEDCLASS) {
12996                         if (strict || ckWARN(WARN_REGEXP)) {
12997                             const int w =
12998                                 RExC_parse >= rangebegin ?
12999                                 RExC_parse - rangebegin : 0;
13000                             if (strict) {
13001                                 vFAIL4("False [] range \"%*.*s\"",
13002                                     w, w, rangebegin);
13003                             }
13004                             else {
13005                                 vWARN4(RExC_parse,
13006                                     "False [] range \"%*.*s\"",
13007                                     w, w, rangebegin);
13008                             }
13009                         }
13010                         if (!SIZE_ONLY) {
13011                             cp_list = add_cp_to_invlist(cp_list, '-');
13012                         }
13013                         element_count++;
13014                     } else
13015                         range = 1;      /* yeah, it's a range! */
13016                     continue;   /* but do it the next time */
13017                 }
13018             }
13019         }
13020
13021         /* Here, <prevvalue> is the beginning of the range, if any; or <value>
13022          * if not */
13023
13024         /* non-Latin1 code point implies unicode semantics.  Must be set in
13025          * pass1 so is there for the whole of pass 2 */
13026         if (value > 255) {
13027             RExC_uni_semantics = 1;
13028         }
13029
13030         /* Ready to process either the single value, or the completed range.
13031          * For single-valued non-inverted ranges, we consider the possibility
13032          * of multi-char folds.  (We made a conscious decision to not do this
13033          * for the other cases because it can often lead to non-intuitive
13034          * results.  For example, you have the peculiar case that:
13035          *  "s s" =~ /^[^\xDF]+$/i => Y
13036          *  "ss"  =~ /^[^\xDF]+$/i => N
13037          *
13038          * See [perl #89750] */
13039         if (FOLD && allow_multi_folds && value == prevvalue) {
13040             if (value == LATIN_SMALL_LETTER_SHARP_S
13041                 || (value > 255 && _invlist_contains_cp(PL_HasMultiCharFold,
13042                                                         value)))
13043             {
13044                 /* Here <value> is indeed a multi-char fold.  Get what it is */
13045
13046                 U8 foldbuf[UTF8_MAXBYTES_CASE];
13047                 STRLEN foldlen;
13048
13049                 UV folded = _to_uni_fold_flags(
13050                                 value,
13051                                 foldbuf,
13052                                 &foldlen,
13053                                 FOLD_FLAGS_FULL
13054                                 | ((LOC) ?  FOLD_FLAGS_LOCALE
13055                                             : (ASCII_FOLD_RESTRICTED)
13056                                               ? FOLD_FLAGS_NOMIX_ASCII
13057                                               : 0)
13058                                 );
13059
13060                 /* Here, <folded> should be the first character of the
13061                  * multi-char fold of <value>, with <foldbuf> containing the
13062                  * whole thing.  But, if this fold is not allowed (because of
13063                  * the flags), <fold> will be the same as <value>, and should
13064                  * be processed like any other character, so skip the special
13065                  * handling */
13066                 if (folded != value) {
13067
13068                     /* Skip if we are recursed, currently parsing the class
13069                      * again.  Otherwise add this character to the list of
13070                      * multi-char folds. */
13071                     if (! RExC_in_multi_char_class) {
13072                         AV** this_array_ptr;
13073                         AV* this_array;
13074                         STRLEN cp_count = utf8_length(foldbuf,
13075                                                       foldbuf + foldlen);
13076                         SV* multi_fold = sv_2mortal(newSVpvn("", 0));
13077
13078                         Perl_sv_catpvf(aTHX_ multi_fold, "\\x{%"UVXf"}", value);
13079
13080
13081                         if (! multi_char_matches) {
13082                             multi_char_matches = newAV();
13083                         }
13084
13085                         /* <multi_char_matches> is actually an array of arrays.
13086                          * There will be one or two top-level elements: [2],
13087                          * and/or [3].  The [2] element is an array, each
13088                          * element thereof is a character which folds to TWO
13089                          * characters; [3] is for folds to THREE characters.
13090                          * (Unicode guarantees a maximum of 3 characters in any
13091                          * fold.)  When we rewrite the character class below,
13092                          * we will do so such that the longest folds are
13093                          * written first, so that it prefers the longest
13094                          * matching strings first.  This is done even if it
13095                          * turns out that any quantifier is non-greedy, out of
13096                          * programmer laziness.  Tom Christiansen has agreed
13097                          * that this is ok.  This makes the test for the
13098                          * ligature 'ffi' come before the test for 'ff' */
13099                         if (av_exists(multi_char_matches, cp_count)) {
13100                             this_array_ptr = (AV**) av_fetch(multi_char_matches,
13101                                                              cp_count, FALSE);
13102                             this_array = *this_array_ptr;
13103                         }
13104                         else {
13105                             this_array = newAV();
13106                             av_store(multi_char_matches, cp_count,
13107                                      (SV*) this_array);
13108                         }
13109                         av_push(this_array, multi_fold);
13110                     }
13111
13112                     /* This element should not be processed further in this
13113                      * class */
13114                     element_count--;
13115                     value = save_value;
13116                     prevvalue = save_prevvalue;
13117                     continue;
13118                 }
13119             }
13120         }
13121
13122         /* Deal with this element of the class */
13123         if (! SIZE_ONLY) {
13124 #ifndef EBCDIC
13125             cp_list = _add_range_to_invlist(cp_list, prevvalue, value);
13126 #else
13127             SV* this_range = _new_invlist(1);
13128             _append_range_to_invlist(this_range, prevvalue, value);
13129
13130             /* In EBCDIC, the ranges 'A-Z' and 'a-z' are each not contiguous.
13131              * If this range was specified using something like 'i-j', we want
13132              * to include only the 'i' and the 'j', and not anything in
13133              * between, so exclude non-ASCII, non-alphabetics from it.
13134              * However, if the range was specified with something like
13135              * [\x89-\x91] or [\x89-j], all code points within it should be
13136              * included.  literal_endpoint==2 means both ends of the range used
13137              * a literal character, not \x{foo} */
13138             if (literal_endpoint == 2
13139                 && (prevvalue >= 'a' && value <= 'z')
13140                     || (prevvalue >= 'A' && value <= 'Z'))
13141             {
13142                 _invlist_intersection(this_range, PL_Posix_ptrs[_CC_ALPHA],
13143                                       &this_range);
13144             }
13145             _invlist_union(cp_list, this_range, &cp_list);
13146             literal_endpoint = 0;
13147 #endif
13148         }
13149
13150         range = 0; /* this range (if it was one) is done now */
13151     } /* End of loop through all the text within the brackets */
13152
13153     /* If anything in the class expands to more than one character, we have to
13154      * deal with them by building up a substitute parse string, and recursively
13155      * calling reg() on it, instead of proceeding */
13156     if (multi_char_matches) {
13157         SV * substitute_parse = newSVpvn_flags("?:", 2, SVs_TEMP);
13158         I32 cp_count;
13159         STRLEN len;
13160         char *save_end = RExC_end;
13161         char *save_parse = RExC_parse;
13162         bool first_time = TRUE;     /* First multi-char occurrence doesn't get
13163                                        a "|" */
13164         I32 reg_flags;
13165
13166         assert(! invert);
13167 #if 0   /* Have decided not to deal with multi-char folds in inverted classes,
13168            because too confusing */
13169         if (invert) {
13170             sv_catpv(substitute_parse, "(?:");
13171         }
13172 #endif
13173
13174         /* Look at the longest folds first */
13175         for (cp_count = av_len(multi_char_matches); cp_count > 0; cp_count--) {
13176
13177             if (av_exists(multi_char_matches, cp_count)) {
13178                 AV** this_array_ptr;
13179                 SV* this_sequence;
13180
13181                 this_array_ptr = (AV**) av_fetch(multi_char_matches,
13182                                                  cp_count, FALSE);
13183                 while ((this_sequence = av_pop(*this_array_ptr)) !=
13184                                                                 &PL_sv_undef)
13185                 {
13186                     if (! first_time) {
13187                         sv_catpv(substitute_parse, "|");
13188                     }
13189                     first_time = FALSE;
13190
13191                     sv_catpv(substitute_parse, SvPVX(this_sequence));
13192                 }
13193             }
13194         }
13195
13196         /* If the character class contains anything else besides these
13197          * multi-character folds, have to include it in recursive parsing */
13198         if (element_count) {
13199             sv_catpv(substitute_parse, "|[");
13200             sv_catpvn(substitute_parse, orig_parse, RExC_parse - orig_parse);
13201             sv_catpv(substitute_parse, "]");
13202         }
13203
13204         sv_catpv(substitute_parse, ")");
13205 #if 0
13206         if (invert) {
13207             /* This is a way to get the parse to skip forward a whole named
13208              * sequence instead of matching the 2nd character when it fails the
13209              * first */
13210             sv_catpv(substitute_parse, "(*THEN)(*SKIP)(*FAIL)|.)");
13211         }
13212 #endif
13213
13214         RExC_parse = SvPV(substitute_parse, len);
13215         RExC_end = RExC_parse + len;
13216         RExC_in_multi_char_class = 1;
13217         RExC_emit = (regnode *)orig_emit;
13218
13219         ret = reg(pRExC_state, 1, &reg_flags, depth+1);
13220
13221         *flagp |= reg_flags&(HASWIDTH|SIMPLE|SPSTART|POSTPONED|RESTART_UTF8);
13222
13223         RExC_parse = save_parse;
13224         RExC_end = save_end;
13225         RExC_in_multi_char_class = 0;
13226         SvREFCNT_dec_NN(multi_char_matches);
13227         return ret;
13228     }
13229
13230     /* If the character class contains only a single element, it may be
13231      * optimizable into another node type which is smaller and runs faster.
13232      * Check if this is the case for this class */
13233     if (element_count == 1 && ! ret_invlist) {
13234         U8 op = END;
13235         U8 arg = 0;
13236
13237         if (namedclass > OOB_NAMEDCLASS) { /* this is a named class, like \w or
13238                                               [:digit:] or \p{foo} */
13239
13240             /* All named classes are mapped into POSIXish nodes, with its FLAG
13241              * argument giving which class it is */
13242             switch ((I32)namedclass) {
13243                 case ANYOF_UNIPROP:
13244                     break;
13245
13246                 /* These don't depend on the charset modifiers.  They always
13247                  * match under /u rules */
13248                 case ANYOF_NHORIZWS:
13249                 case ANYOF_HORIZWS:
13250                     namedclass = ANYOF_BLANK + namedclass - ANYOF_HORIZWS;
13251                     /* FALLTHROUGH */
13252
13253                 case ANYOF_NVERTWS:
13254                 case ANYOF_VERTWS:
13255                     op = POSIXU;
13256                     goto join_posix;
13257
13258                 /* The actual POSIXish node for all the rest depends on the
13259                  * charset modifier.  The ones in the first set depend only on
13260                  * ASCII or, if available on this platform, locale */
13261                 case ANYOF_ASCII:
13262                 case ANYOF_NASCII:
13263 #ifdef HAS_ISASCII
13264                     op = (LOC) ? POSIXL : POSIXA;
13265 #else
13266                     op = POSIXA;
13267 #endif
13268                     goto join_posix;
13269
13270                 case ANYOF_NCASED:
13271                 case ANYOF_LOWER:
13272                 case ANYOF_NLOWER:
13273                 case ANYOF_UPPER:
13274                 case ANYOF_NUPPER:
13275                     /* under /a could be alpha */
13276                     if (FOLD) {
13277                         if (ASCII_RESTRICTED) {
13278                             namedclass = ANYOF_ALPHA + (namedclass % 2);
13279                         }
13280                         else if (! LOC) {
13281                             break;
13282                         }
13283                     }
13284                     /* FALLTHROUGH */
13285
13286                 /* The rest have more possibilities depending on the charset.
13287                  * We take advantage of the enum ordering of the charset
13288                  * modifiers to get the exact node type, */
13289                 default:
13290                     op = POSIXD + get_regex_charset(RExC_flags);
13291                     if (op > POSIXA) { /* /aa is same as /a */
13292                         op = POSIXA;
13293                     }
13294 #ifndef HAS_ISBLANK
13295                     if (op == POSIXL
13296                         && (namedclass == ANYOF_BLANK
13297                             || namedclass == ANYOF_NBLANK))
13298                     {
13299                         op = POSIXA;
13300                     }
13301 #endif
13302
13303                 join_posix:
13304                     /* The odd numbered ones are the complements of the
13305                      * next-lower even number one */
13306                     if (namedclass % 2 == 1) {
13307                         invert = ! invert;
13308                         namedclass--;
13309                     }
13310                     arg = namedclass_to_classnum(namedclass);
13311                     break;
13312             }
13313         }
13314         else if (value == prevvalue) {
13315
13316             /* Here, the class consists of just a single code point */
13317
13318             if (invert) {
13319                 if (! LOC && value == '\n') {
13320                     op = REG_ANY; /* Optimize [^\n] */
13321                     *flagp |= HASWIDTH|SIMPLE;
13322                     RExC_naughty++;
13323                 }
13324             }
13325             else if (value < 256 || UTF) {
13326
13327                 /* Optimize a single value into an EXACTish node, but not if it
13328                  * would require converting the pattern to UTF-8. */
13329                 op = compute_EXACTish(pRExC_state);
13330             }
13331         } /* Otherwise is a range */
13332         else if (! LOC) {   /* locale could vary these */
13333             if (prevvalue == '0') {
13334                 if (value == '9') {
13335                     arg = _CC_DIGIT;
13336                     op = POSIXA;
13337                 }
13338             }
13339         }
13340
13341         /* Here, we have changed <op> away from its initial value iff we found
13342          * an optimization */
13343         if (op != END) {
13344
13345             /* Throw away this ANYOF regnode, and emit the calculated one,
13346              * which should correspond to the beginning, not current, state of
13347              * the parse */
13348             const char * cur_parse = RExC_parse;
13349             RExC_parse = (char *)orig_parse;
13350             if ( SIZE_ONLY) {
13351                 if (! LOC) {
13352
13353                     /* To get locale nodes to not use the full ANYOF size would
13354                      * require moving the code above that writes the portions
13355                      * of it that aren't in other nodes to after this point.
13356                      * e.g.  ANYOF_CLASS_SET */
13357                     RExC_size = orig_size;
13358                 }
13359             }
13360             else {
13361                 RExC_emit = (regnode *)orig_emit;
13362                 if (PL_regkind[op] == POSIXD) {
13363                     if (invert) {
13364                         op += NPOSIXD - POSIXD;
13365                     }
13366                 }
13367             }
13368
13369             ret = reg_node(pRExC_state, op);
13370
13371             if (PL_regkind[op] == POSIXD || PL_regkind[op] == NPOSIXD) {
13372                 if (! SIZE_ONLY) {
13373                     FLAGS(ret) = arg;
13374                 }
13375                 *flagp |= HASWIDTH|SIMPLE;
13376             }
13377             else if (PL_regkind[op] == EXACT) {
13378                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, 0, value);
13379             }
13380
13381             RExC_parse = (char *) cur_parse;
13382
13383             SvREFCNT_dec(posixes);
13384             SvREFCNT_dec(cp_list);
13385             return ret;
13386         }
13387     }
13388
13389     if (SIZE_ONLY)
13390         return ret;
13391     /****** !SIZE_ONLY (Pass 2) AFTER HERE *********/
13392
13393     /* If folding, we calculate all characters that could fold to or from the
13394      * ones already on the list */
13395     if (FOLD && cp_list) {
13396         UV start, end;  /* End points of code point ranges */
13397
13398         SV* fold_intersection = NULL;
13399
13400         /* If the highest code point is within Latin1, we can use the
13401          * compiled-in Alphas list, and not have to go out to disk.  This
13402          * yields two false positives, the masculine and feminine ordinal
13403          * indicators, which are weeded out below using the
13404          * IS_IN_SOME_FOLD_L1() macro */
13405         if (invlist_highest(cp_list) < 256) {
13406             _invlist_intersection(PL_L1Posix_ptrs[_CC_ALPHA], cp_list,
13407                                                            &fold_intersection);
13408         }
13409         else {
13410
13411             /* Here, there are non-Latin1 code points, so we will have to go
13412              * fetch the list of all the characters that participate in folds
13413              */
13414             if (! PL_utf8_foldable) {
13415                 SV* swash = swash_init("utf8", "_Perl_Any_Folds",
13416                                        &PL_sv_undef, 1, 0);
13417                 PL_utf8_foldable = _get_swash_invlist(swash);
13418                 SvREFCNT_dec_NN(swash);
13419             }
13420
13421             /* This is a hash that for a particular fold gives all characters
13422              * that are involved in it */
13423             if (! PL_utf8_foldclosures) {
13424
13425                 /* If we were unable to find any folds, then we likely won't be
13426                  * able to find the closures.  So just create an empty list.
13427                  * Folding will effectively be restricted to the non-Unicode
13428                  * rules hard-coded into Perl.  (This case happens legitimately
13429                  * during compilation of Perl itself before the Unicode tables
13430                  * are generated) */
13431                 if (_invlist_len(PL_utf8_foldable) == 0) {
13432                     PL_utf8_foldclosures = newHV();
13433                 }
13434                 else {
13435                     /* If the folds haven't been read in, call a fold function
13436                      * to force that */
13437                     if (! PL_utf8_tofold) {
13438                         U8 dummy[UTF8_MAXBYTES+1];
13439
13440                         /* This string is just a short named one above \xff */
13441                         to_utf8_fold((U8*) HYPHEN_UTF8, dummy, NULL);
13442                         assert(PL_utf8_tofold); /* Verify that worked */
13443                     }
13444                     PL_utf8_foldclosures =
13445                                     _swash_inversion_hash(PL_utf8_tofold);
13446                 }
13447             }
13448
13449             /* Only the characters in this class that participate in folds need
13450              * be checked.  Get the intersection of this class and all the
13451              * possible characters that are foldable.  This can quickly narrow
13452              * down a large class */
13453             _invlist_intersection(PL_utf8_foldable, cp_list,
13454                                   &fold_intersection);
13455         }
13456
13457         /* Now look at the foldable characters in this class individually */
13458         invlist_iterinit(fold_intersection);
13459         while (invlist_iternext(fold_intersection, &start, &end)) {
13460             UV j;
13461
13462             /* Locale folding for Latin1 characters is deferred until runtime */
13463             if (LOC && start < 256) {
13464                 start = 256;
13465             }
13466
13467             /* Look at every character in the range */
13468             for (j = start; j <= end; j++) {
13469
13470                 U8 foldbuf[UTF8_MAXBYTES_CASE+1];
13471                 STRLEN foldlen;
13472                 SV** listp;
13473
13474                 if (j < 256) {
13475
13476                     /* We have the latin1 folding rules hard-coded here so that
13477                      * an innocent-looking character class, like /[ks]/i won't
13478                      * have to go out to disk to find the possible matches.
13479                      * XXX It would be better to generate these via regen, in
13480                      * case a new version of the Unicode standard adds new
13481                      * mappings, though that is not really likely, and may be
13482                      * caught by the default: case of the switch below. */
13483
13484                     if (IS_IN_SOME_FOLD_L1(j)) {
13485
13486                         /* ASCII is always matched; non-ASCII is matched only
13487                          * under Unicode rules */
13488                         if (isASCII(j) || AT_LEAST_UNI_SEMANTICS) {
13489                             cp_list =
13490                                 add_cp_to_invlist(cp_list, PL_fold_latin1[j]);
13491                         }
13492                         else {
13493                             depends_list =
13494                              add_cp_to_invlist(depends_list, PL_fold_latin1[j]);
13495                         }
13496                     }
13497
13498                     if (HAS_NONLATIN1_FOLD_CLOSURE(j)
13499                         && (! isASCII(j) || ! ASCII_FOLD_RESTRICTED))
13500                     {
13501                         /* Certain Latin1 characters have matches outside
13502                          * Latin1.  To get here, <j> is one of those
13503                          * characters.   None of these matches is valid for
13504                          * ASCII characters under /aa, which is why the 'if'
13505                          * just above excludes those.  These matches only
13506                          * happen when the target string is utf8.  The code
13507                          * below adds the single fold closures for <j> to the
13508                          * inversion list. */
13509                         switch (j) {
13510                             case 'k':
13511                             case 'K':
13512                                 cp_list =
13513                                     add_cp_to_invlist(cp_list, KELVIN_SIGN);
13514                                 break;
13515                             case 's':
13516                             case 'S':
13517                                 cp_list = add_cp_to_invlist(cp_list,
13518                                                     LATIN_SMALL_LETTER_LONG_S);
13519                                 break;
13520                             case MICRO_SIGN:
13521                                 cp_list = add_cp_to_invlist(cp_list,
13522                                                     GREEK_CAPITAL_LETTER_MU);
13523                                 cp_list = add_cp_to_invlist(cp_list,
13524                                                     GREEK_SMALL_LETTER_MU);
13525                                 break;
13526                             case LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE:
13527                             case LATIN_SMALL_LETTER_A_WITH_RING_ABOVE:
13528                                 cp_list =
13529                                     add_cp_to_invlist(cp_list, ANGSTROM_SIGN);
13530                                 break;
13531                             case LATIN_SMALL_LETTER_Y_WITH_DIAERESIS:
13532                                 cp_list = add_cp_to_invlist(cp_list,
13533                                         LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS);
13534                                 break;
13535                             case LATIN_SMALL_LETTER_SHARP_S:
13536                                 cp_list = add_cp_to_invlist(cp_list,
13537                                                 LATIN_CAPITAL_LETTER_SHARP_S);
13538                                 break;
13539                             case 'F': case 'f':
13540                             case 'I': case 'i':
13541                             case 'L': case 'l':
13542                             case 'T': case 't':
13543                             case 'A': case 'a':
13544                             case 'H': case 'h':
13545                             case 'J': case 'j':
13546                             case 'N': case 'n':
13547                             case 'W': case 'w':
13548                             case 'Y': case 'y':
13549                                 /* These all are targets of multi-character
13550                                  * folds from code points that require UTF8 to
13551                                  * express, so they can't match unless the
13552                                  * target string is in UTF-8, so no action here
13553                                  * is necessary, as regexec.c properly handles
13554                                  * the general case for UTF-8 matching and
13555                                  * multi-char folds */
13556                                 break;
13557                             default:
13558                                 /* Use deprecated warning to increase the
13559                                  * chances of this being output */
13560                                 ckWARN2regdep(RExC_parse, "Perl folding rules are not up-to-date for 0x%"UVXf"; please use the perlbug utility to report;", j);
13561                                 break;
13562                         }
13563                     }
13564                     continue;
13565                 }
13566
13567                 /* Here is an above Latin1 character.  We don't have the rules
13568                  * hard-coded for it.  First, get its fold.  This is the simple
13569                  * fold, as the multi-character folds have been handled earlier
13570                  * and separated out */
13571                 _to_uni_fold_flags(j, foldbuf, &foldlen,
13572                                                ((LOC)
13573                                                ? FOLD_FLAGS_LOCALE
13574                                                : (ASCII_FOLD_RESTRICTED)
13575                                                   ? FOLD_FLAGS_NOMIX_ASCII
13576                                                   : 0));
13577
13578                 /* Single character fold of above Latin1.  Add everything in
13579                  * its fold closure to the list that this node should match.
13580                  * The fold closures data structure is a hash with the keys
13581                  * being the UTF-8 of every character that is folded to, like
13582                  * 'k', and the values each an array of all code points that
13583                  * fold to its key.  e.g. [ 'k', 'K', KELVIN_SIGN ].
13584                  * Multi-character folds are not included */
13585                 if ((listp = hv_fetch(PL_utf8_foldclosures,
13586                                       (char *) foldbuf, foldlen, FALSE)))
13587                 {
13588                     AV* list = (AV*) *listp;
13589                     IV k;
13590                     for (k = 0; k <= av_len(list); k++) {
13591                         SV** c_p = av_fetch(list, k, FALSE);
13592                         UV c;
13593                         if (c_p == NULL) {
13594                             Perl_croak(aTHX_ "panic: invalid PL_utf8_foldclosures structure");
13595                         }
13596                         c = SvUV(*c_p);
13597
13598                         /* /aa doesn't allow folds between ASCII and non-; /l
13599                          * doesn't allow them between above and below 256 */
13600                         if ((ASCII_FOLD_RESTRICTED
13601                                   && (isASCII(c) != isASCII(j)))
13602                             || (LOC && c < 256)) {
13603                             continue;
13604                         }
13605
13606                         /* Folds involving non-ascii Latin1 characters
13607                          * under /d are added to a separate list */
13608                         if (isASCII(c) || c > 255 || AT_LEAST_UNI_SEMANTICS)
13609                         {
13610                             cp_list = add_cp_to_invlist(cp_list, c);
13611                         }
13612                         else {
13613                           depends_list = add_cp_to_invlist(depends_list, c);
13614                         }
13615                     }
13616                 }
13617             }
13618         }
13619         SvREFCNT_dec_NN(fold_intersection);
13620     }
13621
13622     /* And combine the result (if any) with any inversion list from posix
13623      * classes.  The lists are kept separate up to now because we don't want to
13624      * fold the classes (folding of those is automatically handled by the swash
13625      * fetching code) */
13626     if (posixes) {
13627         if (! DEPENDS_SEMANTICS) {
13628             if (cp_list) {
13629                 _invlist_union(cp_list, posixes, &cp_list);
13630                 SvREFCNT_dec_NN(posixes);
13631             }
13632             else {
13633                 cp_list = posixes;
13634             }
13635         }
13636         else {
13637             /* Under /d, we put into a separate list the Latin1 things that
13638              * match only when the target string is utf8 */
13639             SV* nonascii_but_latin1_properties = NULL;
13640             _invlist_intersection(posixes, PL_Latin1,
13641                                   &nonascii_but_latin1_properties);
13642             _invlist_subtract(nonascii_but_latin1_properties, PL_ASCII,
13643                               &nonascii_but_latin1_properties);
13644             _invlist_subtract(posixes, nonascii_but_latin1_properties,
13645                               &posixes);
13646             if (cp_list) {
13647                 _invlist_union(cp_list, posixes, &cp_list);
13648                 SvREFCNT_dec_NN(posixes);
13649             }
13650             else {
13651                 cp_list = posixes;
13652             }
13653
13654             if (depends_list) {
13655                 _invlist_union(depends_list, nonascii_but_latin1_properties,
13656                                &depends_list);
13657                 SvREFCNT_dec_NN(nonascii_but_latin1_properties);
13658             }
13659             else {
13660                 depends_list = nonascii_but_latin1_properties;
13661             }
13662         }
13663     }
13664
13665     /* And combine the result (if any) with any inversion list from properties.
13666      * The lists are kept separate up to now so that we can distinguish the two
13667      * in regards to matching above-Unicode.  A run-time warning is generated
13668      * if a Unicode property is matched against a non-Unicode code point. But,
13669      * we allow user-defined properties to match anything, without any warning,
13670      * and we also suppress the warning if there is a portion of the character
13671      * class that isn't a Unicode property, and which matches above Unicode, \W
13672      * or [\x{110000}] for example.
13673      * (Note that in this case, unlike the Posix one above, there is no
13674      * <depends_list>, because having a Unicode property forces Unicode
13675      * semantics */
13676     if (properties) {
13677         bool warn_super = ! has_user_defined_property;
13678         if (cp_list) {
13679
13680             /* If it matters to the final outcome, see if a non-property
13681              * component of the class matches above Unicode.  If so, the
13682              * warning gets suppressed.  This is true even if just a single
13683              * such code point is specified, as though not strictly correct if
13684              * another such code point is matched against, the fact that they
13685              * are using above-Unicode code points indicates they should know
13686              * the issues involved */
13687             if (warn_super) {
13688                 bool non_prop_matches_above_Unicode =
13689                             runtime_posix_matches_above_Unicode
13690                             | (invlist_highest(cp_list) > PERL_UNICODE_MAX);
13691                 if (invert) {
13692                     non_prop_matches_above_Unicode =
13693                                             !  non_prop_matches_above_Unicode;
13694                 }
13695                 warn_super = ! non_prop_matches_above_Unicode;
13696             }
13697
13698             _invlist_union(properties, cp_list, &cp_list);
13699             SvREFCNT_dec_NN(properties);
13700         }
13701         else {
13702             cp_list = properties;
13703         }
13704
13705         if (warn_super) {
13706             OP(ret) = ANYOF_WARN_SUPER;
13707         }
13708     }
13709
13710     /* Here, we have calculated what code points should be in the character
13711      * class.
13712      *
13713      * Now we can see about various optimizations.  Fold calculation (which we
13714      * did above) needs to take place before inversion.  Otherwise /[^k]/i
13715      * would invert to include K, which under /i would match k, which it
13716      * shouldn't.  Therefore we can't invert folded locale now, as it won't be
13717      * folded until runtime */
13718
13719     /* Optimize inverted simple patterns (e.g. [^a-z]) when everything is known
13720      * at compile time.  Besides not inverting folded locale now, we can't
13721      * invert if there are things such as \w, which aren't known until runtime
13722      * */
13723     if (invert
13724         && ! (LOC && (FOLD || (ANYOF_FLAGS(ret) & ANYOF_CLASS)))
13725         && ! depends_list
13726         && ! HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
13727     {
13728         _invlist_invert(cp_list);
13729
13730         /* Any swash can't be used as-is, because we've inverted things */
13731         if (swash) {
13732             SvREFCNT_dec_NN(swash);
13733             swash = NULL;
13734         }
13735
13736         /* Clear the invert flag since have just done it here */
13737         invert = FALSE;
13738     }
13739
13740     if (ret_invlist) {
13741         *ret_invlist = cp_list;
13742         SvREFCNT_dec(swash);
13743
13744         /* Discard the generated node */
13745         if (SIZE_ONLY) {
13746             RExC_size = orig_size;
13747         }
13748         else {
13749             RExC_emit = orig_emit;
13750         }
13751         return orig_emit;
13752     }
13753
13754     /* If we didn't do folding, it's because some information isn't available
13755      * until runtime; set the run-time fold flag for these.  (We don't have to
13756      * worry about properties folding, as that is taken care of by the swash
13757      * fetching) */
13758     if (FOLD && LOC)
13759     {
13760        ANYOF_FLAGS(ret) |= ANYOF_LOC_FOLD;
13761     }
13762
13763     /* Some character classes are equivalent to other nodes.  Such nodes take
13764      * up less room and generally fewer operations to execute than ANYOF nodes.
13765      * Above, we checked for and optimized into some such equivalents for
13766      * certain common classes that are easy to test.  Getting to this point in
13767      * the code means that the class didn't get optimized there.  Since this
13768      * code is only executed in Pass 2, it is too late to save space--it has
13769      * been allocated in Pass 1, and currently isn't given back.  But turning
13770      * things into an EXACTish node can allow the optimizer to join it to any
13771      * adjacent such nodes.  And if the class is equivalent to things like /./,
13772      * expensive run-time swashes can be avoided.  Now that we have more
13773      * complete information, we can find things necessarily missed by the
13774      * earlier code.  I (khw) am not sure how much to look for here.  It would
13775      * be easy, but perhaps too slow, to check any candidates against all the
13776      * node types they could possibly match using _invlistEQ(). */
13777
13778     if (cp_list
13779         && ! invert
13780         && ! depends_list
13781         && ! (ANYOF_FLAGS(ret) & ANYOF_CLASS)
13782         && ! HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
13783     {
13784         UV start, end;
13785         U8 op = END;  /* The optimzation node-type */
13786         const char * cur_parse= RExC_parse;
13787
13788         invlist_iterinit(cp_list);
13789         if (! invlist_iternext(cp_list, &start, &end)) {
13790
13791             /* Here, the list is empty.  This happens, for example, when a
13792              * Unicode property is the only thing in the character class, and
13793              * it doesn't match anything.  (perluniprops.pod notes such
13794              * properties) */
13795             op = OPFAIL;
13796             *flagp |= HASWIDTH|SIMPLE;
13797         }
13798         else if (start == end) {    /* The range is a single code point */
13799             if (! invlist_iternext(cp_list, &start, &end)
13800
13801                     /* Don't do this optimization if it would require changing
13802                      * the pattern to UTF-8 */
13803                 && (start < 256 || UTF))
13804             {
13805                 /* Here, the list contains a single code point.  Can optimize
13806                  * into an EXACT node */
13807
13808                 value = start;
13809
13810                 if (! FOLD) {
13811                     op = EXACT;
13812                 }
13813                 else if (LOC) {
13814
13815                     /* A locale node under folding with one code point can be
13816                      * an EXACTFL, as its fold won't be calculated until
13817                      * runtime */
13818                     op = EXACTFL;
13819                 }
13820                 else {
13821
13822                     /* Here, we are generally folding, but there is only one
13823                      * code point to match.  If we have to, we use an EXACT
13824                      * node, but it would be better for joining with adjacent
13825                      * nodes in the optimization pass if we used the same
13826                      * EXACTFish node that any such are likely to be.  We can
13827                      * do this iff the code point doesn't participate in any
13828                      * folds.  For example, an EXACTF of a colon is the same as
13829                      * an EXACT one, since nothing folds to or from a colon. */
13830                     if (value < 256) {
13831                         if (IS_IN_SOME_FOLD_L1(value)) {
13832                             op = EXACT;
13833                         }
13834                     }
13835                     else {
13836                         if (! PL_utf8_foldable) {
13837                             SV* swash = swash_init("utf8", "_Perl_Any_Folds",
13838                                                 &PL_sv_undef, 1, 0);
13839                             PL_utf8_foldable = _get_swash_invlist(swash);
13840                             SvREFCNT_dec_NN(swash);
13841                         }
13842                         if (_invlist_contains_cp(PL_utf8_foldable, value)) {
13843                             op = EXACT;
13844                         }
13845                     }
13846
13847                     /* If we haven't found the node type, above, it means we
13848                      * can use the prevailing one */
13849                     if (op == END) {
13850                         op = compute_EXACTish(pRExC_state);
13851                     }
13852                 }
13853             }
13854         }
13855         else if (start == 0) {
13856             if (end == UV_MAX) {
13857                 op = SANY;
13858                 *flagp |= HASWIDTH|SIMPLE;
13859                 RExC_naughty++;
13860             }
13861             else if (end == '\n' - 1
13862                     && invlist_iternext(cp_list, &start, &end)
13863                     && start == '\n' + 1 && end == UV_MAX)
13864             {
13865                 op = REG_ANY;
13866                 *flagp |= HASWIDTH|SIMPLE;
13867                 RExC_naughty++;
13868             }
13869         }
13870         invlist_iterfinish(cp_list);
13871
13872         if (op != END) {
13873             RExC_parse = (char *)orig_parse;
13874             RExC_emit = (regnode *)orig_emit;
13875
13876             ret = reg_node(pRExC_state, op);
13877
13878             RExC_parse = (char *)cur_parse;
13879
13880             if (PL_regkind[op] == EXACT) {
13881                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, 0, value);
13882             }
13883
13884             SvREFCNT_dec_NN(cp_list);
13885             return ret;
13886         }
13887     }
13888
13889     /* Here, <cp_list> contains all the code points we can determine at
13890      * compile time that match under all conditions.  Go through it, and
13891      * for things that belong in the bitmap, put them there, and delete from
13892      * <cp_list>.  While we are at it, see if everything above 255 is in the
13893      * list, and if so, set a flag to speed up execution */
13894     ANYOF_BITMAP_ZERO(ret);
13895     if (cp_list) {
13896
13897         /* This gets set if we actually need to modify things */
13898         bool change_invlist = FALSE;
13899
13900         UV start, end;
13901
13902         /* Start looking through <cp_list> */
13903         invlist_iterinit(cp_list);
13904         while (invlist_iternext(cp_list, &start, &end)) {
13905             UV high;
13906             int i;
13907
13908             if (end == UV_MAX && start <= 256) {
13909                 ANYOF_FLAGS(ret) |= ANYOF_UNICODE_ALL;
13910             }
13911
13912             /* Quit if are above what we should change */
13913             if (start > 255) {
13914                 break;
13915             }
13916
13917             change_invlist = TRUE;
13918
13919             /* Set all the bits in the range, up to the max that we are doing */
13920             high = (end < 255) ? end : 255;
13921             for (i = start; i <= (int) high; i++) {
13922                 if (! ANYOF_BITMAP_TEST(ret, i)) {
13923                     ANYOF_BITMAP_SET(ret, i);
13924                     prevvalue = value;
13925                     value = i;
13926                 }
13927             }
13928         }
13929         invlist_iterfinish(cp_list);
13930
13931         /* Done with loop; remove any code points that are in the bitmap from
13932          * <cp_list> */
13933         if (change_invlist) {
13934             _invlist_subtract(cp_list, PL_Latin1, &cp_list);
13935         }
13936
13937         /* If have completely emptied it, remove it completely */
13938         if (_invlist_len(cp_list) == 0) {
13939             SvREFCNT_dec_NN(cp_list);
13940             cp_list = NULL;
13941         }
13942     }
13943
13944     if (invert) {
13945         ANYOF_FLAGS(ret) |= ANYOF_INVERT;
13946     }
13947
13948     /* Here, the bitmap has been populated with all the Latin1 code points that
13949      * always match.  Can now add to the overall list those that match only
13950      * when the target string is UTF-8 (<depends_list>). */
13951     if (depends_list) {
13952         if (cp_list) {
13953             _invlist_union(cp_list, depends_list, &cp_list);
13954             SvREFCNT_dec_NN(depends_list);
13955         }
13956         else {
13957             cp_list = depends_list;
13958         }
13959     }
13960
13961     /* If there is a swash and more than one element, we can't use the swash in
13962      * the optimization below. */
13963     if (swash && element_count > 1) {
13964         SvREFCNT_dec_NN(swash);
13965         swash = NULL;
13966     }
13967
13968     if (! cp_list
13969         && ! HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
13970     {
13971         ARG_SET(ret, ANYOF_NONBITMAP_EMPTY);
13972     }
13973     else {
13974         /* av[0] stores the character class description in its textual form:
13975          *       used later (regexec.c:Perl_regclass_swash()) to initialize the
13976          *       appropriate swash, and is also useful for dumping the regnode.
13977          * av[1] if NULL, is a placeholder to later contain the swash computed
13978          *       from av[0].  But if no further computation need be done, the
13979          *       swash is stored there now.
13980          * av[2] stores the cp_list inversion list for use in addition or
13981          *       instead of av[0]; used only if av[1] is NULL
13982          * av[3] is set if any component of the class is from a user-defined
13983          *       property; used only if av[1] is NULL */
13984         AV * const av = newAV();
13985         SV *rv;
13986
13987         av_store(av, 0, (HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
13988                         ? SvREFCNT_inc(listsv) : &PL_sv_undef);
13989         if (swash) {
13990             av_store(av, 1, swash);
13991             SvREFCNT_dec_NN(cp_list);
13992         }
13993         else {
13994             av_store(av, 1, NULL);
13995             if (cp_list) {
13996                 av_store(av, 2, cp_list);
13997                 av_store(av, 3, newSVuv(has_user_defined_property));
13998             }
13999         }
14000
14001         rv = newRV_noinc(MUTABLE_SV(av));
14002         n = add_data(pRExC_state, 1, "s");
14003         RExC_rxi->data->data[n] = (void*)rv;
14004         ARG_SET(ret, n);
14005     }
14006
14007     *flagp |= HASWIDTH|SIMPLE;
14008     return ret;
14009 }
14010 #undef HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION
14011
14012
14013 /* reg_skipcomment()
14014
14015    Absorbs an /x style # comments from the input stream.
14016    Returns true if there is more text remaining in the stream.
14017    Will set the REG_SEEN_RUN_ON_COMMENT flag if the comment
14018    terminates the pattern without including a newline.
14019
14020    Note its the callers responsibility to ensure that we are
14021    actually in /x mode
14022
14023 */
14024
14025 STATIC bool
14026 S_reg_skipcomment(pTHX_ RExC_state_t *pRExC_state)
14027 {
14028     bool ended = 0;
14029
14030     PERL_ARGS_ASSERT_REG_SKIPCOMMENT;
14031
14032     while (RExC_parse < RExC_end)
14033         if (*RExC_parse++ == '\n') {
14034             ended = 1;
14035             break;
14036         }
14037     if (!ended) {
14038         /* we ran off the end of the pattern without ending
14039            the comment, so we have to add an \n when wrapping */
14040         RExC_seen |= REG_SEEN_RUN_ON_COMMENT;
14041         return 0;
14042     } else
14043         return 1;
14044 }
14045
14046 /* nextchar()
14047
14048    Advances the parse position, and optionally absorbs
14049    "whitespace" from the inputstream.
14050
14051    Without /x "whitespace" means (?#...) style comments only,
14052    with /x this means (?#...) and # comments and whitespace proper.
14053
14054    Returns the RExC_parse point from BEFORE the scan occurs.
14055
14056    This is the /x friendly way of saying RExC_parse++.
14057 */
14058
14059 STATIC char*
14060 S_nextchar(pTHX_ RExC_state_t *pRExC_state)
14061 {
14062     char* const retval = RExC_parse++;
14063
14064     PERL_ARGS_ASSERT_NEXTCHAR;
14065
14066     for (;;) {
14067         if (RExC_end - RExC_parse >= 3
14068             && *RExC_parse == '('
14069             && RExC_parse[1] == '?'
14070             && RExC_parse[2] == '#')
14071         {
14072             while (*RExC_parse != ')') {
14073                 if (RExC_parse == RExC_end)
14074                     FAIL("Sequence (?#... not terminated");
14075                 RExC_parse++;
14076             }
14077             RExC_parse++;
14078             continue;
14079         }
14080         if (RExC_flags & RXf_PMf_EXTENDED) {
14081             if (isSPACE(*RExC_parse)) {
14082                 RExC_parse++;
14083                 continue;
14084             }
14085             else if (*RExC_parse == '#') {
14086                 if ( reg_skipcomment( pRExC_state ) )
14087                     continue;
14088             }
14089         }
14090         return retval;
14091     }
14092 }
14093
14094 /*
14095 - reg_node - emit a node
14096 */
14097 STATIC regnode *                        /* Location. */
14098 S_reg_node(pTHX_ RExC_state_t *pRExC_state, U8 op)
14099 {
14100     dVAR;
14101     regnode *ptr;
14102     regnode * const ret = RExC_emit;
14103     GET_RE_DEBUG_FLAGS_DECL;
14104
14105     PERL_ARGS_ASSERT_REG_NODE;
14106
14107     if (SIZE_ONLY) {
14108         SIZE_ALIGN(RExC_size);
14109         RExC_size += 1;
14110         return(ret);
14111     }
14112     if (RExC_emit >= RExC_emit_bound)
14113         Perl_croak(aTHX_ "panic: reg_node overrun trying to emit %d, %p>=%p",
14114                    op, RExC_emit, RExC_emit_bound);
14115
14116     NODE_ALIGN_FILL(ret);
14117     ptr = ret;
14118     FILL_ADVANCE_NODE(ptr, op);
14119 #ifdef RE_TRACK_PATTERN_OFFSETS
14120     if (RExC_offsets) {         /* MJD */
14121         MJD_OFFSET_DEBUG(("%s:%d: (op %s) %s %"UVuf" (len %"UVuf") (max %"UVuf").\n", 
14122               "reg_node", __LINE__, 
14123               PL_reg_name[op],
14124               (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0] 
14125                 ? "Overwriting end of array!\n" : "OK",
14126               (UV)(RExC_emit - RExC_emit_start),
14127               (UV)(RExC_parse - RExC_start),
14128               (UV)RExC_offsets[0])); 
14129         Set_Node_Offset(RExC_emit, RExC_parse + (op == END));
14130     }
14131 #endif
14132     RExC_emit = ptr;
14133     return(ret);
14134 }
14135
14136 /*
14137 - reganode - emit a node with an argument
14138 */
14139 STATIC regnode *                        /* Location. */
14140 S_reganode(pTHX_ RExC_state_t *pRExC_state, U8 op, U32 arg)
14141 {
14142     dVAR;
14143     regnode *ptr;
14144     regnode * const ret = RExC_emit;
14145     GET_RE_DEBUG_FLAGS_DECL;
14146
14147     PERL_ARGS_ASSERT_REGANODE;
14148
14149     if (SIZE_ONLY) {
14150         SIZE_ALIGN(RExC_size);
14151         RExC_size += 2;
14152         /* 
14153            We can't do this:
14154            
14155            assert(2==regarglen[op]+1); 
14156
14157            Anything larger than this has to allocate the extra amount.
14158            If we changed this to be:
14159            
14160            RExC_size += (1 + regarglen[op]);
14161            
14162            then it wouldn't matter. Its not clear what side effect
14163            might come from that so its not done so far.
14164            -- dmq
14165         */
14166         return(ret);
14167     }
14168     if (RExC_emit >= RExC_emit_bound)
14169         Perl_croak(aTHX_ "panic: reg_node overrun trying to emit %d, %p>=%p",
14170                    op, RExC_emit, RExC_emit_bound);
14171
14172     NODE_ALIGN_FILL(ret);
14173     ptr = ret;
14174     FILL_ADVANCE_NODE_ARG(ptr, op, arg);
14175 #ifdef RE_TRACK_PATTERN_OFFSETS
14176     if (RExC_offsets) {         /* MJD */
14177         MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s %"UVuf" <- %"UVuf" (max %"UVuf").\n", 
14178               "reganode",
14179               __LINE__,
14180               PL_reg_name[op],
14181               (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0] ? 
14182               "Overwriting end of array!\n" : "OK",
14183               (UV)(RExC_emit - RExC_emit_start),
14184               (UV)(RExC_parse - RExC_start),
14185               (UV)RExC_offsets[0])); 
14186         Set_Cur_Node_Offset;
14187     }
14188 #endif            
14189     RExC_emit = ptr;
14190     return(ret);
14191 }
14192
14193 /*
14194 - reguni - emit (if appropriate) a Unicode character
14195 */
14196 STATIC STRLEN
14197 S_reguni(pTHX_ const RExC_state_t *pRExC_state, UV uv, char* s)
14198 {
14199     dVAR;
14200
14201     PERL_ARGS_ASSERT_REGUNI;
14202
14203     return SIZE_ONLY ? UNISKIP(uv) : (uvchr_to_utf8((U8*)s, uv) - (U8*)s);
14204 }
14205
14206 /*
14207 - reginsert - insert an operator in front of already-emitted operand
14208 *
14209 * Means relocating the operand.
14210 */
14211 STATIC void
14212 S_reginsert(pTHX_ RExC_state_t *pRExC_state, U8 op, regnode *opnd, U32 depth)
14213 {
14214     dVAR;
14215     regnode *src;
14216     regnode *dst;
14217     regnode *place;
14218     const int offset = regarglen[(U8)op];
14219     const int size = NODE_STEP_REGNODE + offset;
14220     GET_RE_DEBUG_FLAGS_DECL;
14221
14222     PERL_ARGS_ASSERT_REGINSERT;
14223     PERL_UNUSED_ARG(depth);
14224 /* (PL_regkind[(U8)op] == CURLY ? EXTRA_STEP_2ARGS : 0); */
14225     DEBUG_PARSE_FMT("inst"," - %s",PL_reg_name[op]);
14226     if (SIZE_ONLY) {
14227         RExC_size += size;
14228         return;
14229     }
14230
14231     src = RExC_emit;
14232     RExC_emit += size;
14233     dst = RExC_emit;
14234     if (RExC_open_parens) {
14235         int paren;
14236         /*DEBUG_PARSE_FMT("inst"," - %"IVdf, (IV)RExC_npar);*/
14237         for ( paren=0 ; paren < RExC_npar ; paren++ ) {
14238             if ( RExC_open_parens[paren] >= opnd ) {
14239                 /*DEBUG_PARSE_FMT("open"," - %d",size);*/
14240                 RExC_open_parens[paren] += size;
14241             } else {
14242                 /*DEBUG_PARSE_FMT("open"," - %s","ok");*/
14243             }
14244             if ( RExC_close_parens[paren] >= opnd ) {
14245                 /*DEBUG_PARSE_FMT("close"," - %d",size);*/
14246                 RExC_close_parens[paren] += size;
14247             } else {
14248                 /*DEBUG_PARSE_FMT("close"," - %s","ok");*/
14249             }
14250         }
14251     }
14252
14253     while (src > opnd) {
14254         StructCopy(--src, --dst, regnode);
14255 #ifdef RE_TRACK_PATTERN_OFFSETS
14256         if (RExC_offsets) {     /* MJD 20010112 */
14257             MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s copy %"UVuf" -> %"UVuf" (max %"UVuf").\n",
14258                   "reg_insert",
14259                   __LINE__,
14260                   PL_reg_name[op],
14261                   (UV)(dst - RExC_emit_start) > RExC_offsets[0] 
14262                     ? "Overwriting end of array!\n" : "OK",
14263                   (UV)(src - RExC_emit_start),
14264                   (UV)(dst - RExC_emit_start),
14265                   (UV)RExC_offsets[0])); 
14266             Set_Node_Offset_To_R(dst-RExC_emit_start, Node_Offset(src));
14267             Set_Node_Length_To_R(dst-RExC_emit_start, Node_Length(src));
14268         }
14269 #endif
14270     }
14271     
14272
14273     place = opnd;               /* Op node, where operand used to be. */
14274 #ifdef RE_TRACK_PATTERN_OFFSETS
14275     if (RExC_offsets) {         /* MJD */
14276         MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s %"UVuf" <- %"UVuf" (max %"UVuf").\n", 
14277               "reginsert",
14278               __LINE__,
14279               PL_reg_name[op],
14280               (UV)(place - RExC_emit_start) > RExC_offsets[0] 
14281               ? "Overwriting end of array!\n" : "OK",
14282               (UV)(place - RExC_emit_start),
14283               (UV)(RExC_parse - RExC_start),
14284               (UV)RExC_offsets[0]));
14285         Set_Node_Offset(place, RExC_parse);
14286         Set_Node_Length(place, 1);
14287     }
14288 #endif    
14289     src = NEXTOPER(place);
14290     FILL_ADVANCE_NODE(place, op);
14291     Zero(src, offset, regnode);
14292 }
14293
14294 /*
14295 - regtail - set the next-pointer at the end of a node chain of p to val.
14296 - SEE ALSO: regtail_study
14297 */
14298 /* TODO: All three parms should be const */
14299 STATIC void
14300 S_regtail(pTHX_ RExC_state_t *pRExC_state, regnode *p, const regnode *val,U32 depth)
14301 {
14302     dVAR;
14303     regnode *scan;
14304     GET_RE_DEBUG_FLAGS_DECL;
14305
14306     PERL_ARGS_ASSERT_REGTAIL;
14307 #ifndef DEBUGGING
14308     PERL_UNUSED_ARG(depth);
14309 #endif
14310
14311     if (SIZE_ONLY)
14312         return;
14313
14314     /* Find last node. */
14315     scan = p;
14316     for (;;) {
14317         regnode * const temp = regnext(scan);
14318         DEBUG_PARSE_r({
14319             SV * const mysv=sv_newmortal();
14320             DEBUG_PARSE_MSG((scan==p ? "tail" : ""));
14321             regprop(RExC_rx, mysv, scan);
14322             PerlIO_printf(Perl_debug_log, "~ %s (%d) %s %s\n",
14323                 SvPV_nolen_const(mysv), REG_NODE_NUM(scan),
14324                     (temp == NULL ? "->" : ""),
14325                     (temp == NULL ? PL_reg_name[OP(val)] : "")
14326             );
14327         });
14328         if (temp == NULL)
14329             break;
14330         scan = temp;
14331     }
14332
14333     if (reg_off_by_arg[OP(scan)]) {
14334         ARG_SET(scan, val - scan);
14335     }
14336     else {
14337         NEXT_OFF(scan) = val - scan;
14338     }
14339 }
14340
14341 #ifdef DEBUGGING
14342 /*
14343 - regtail_study - set the next-pointer at the end of a node chain of p to val.
14344 - Look for optimizable sequences at the same time.
14345 - currently only looks for EXACT chains.
14346
14347 This is experimental code. The idea is to use this routine to perform 
14348 in place optimizations on branches and groups as they are constructed,
14349 with the long term intention of removing optimization from study_chunk so
14350 that it is purely analytical.
14351
14352 Currently only used when in DEBUG mode. The macro REGTAIL_STUDY() is used
14353 to control which is which.
14354
14355 */
14356 /* TODO: All four parms should be const */
14357
14358 STATIC U8
14359 S_regtail_study(pTHX_ RExC_state_t *pRExC_state, regnode *p, const regnode *val,U32 depth)
14360 {
14361     dVAR;
14362     regnode *scan;
14363     U8 exact = PSEUDO;
14364 #ifdef EXPERIMENTAL_INPLACESCAN
14365     I32 min = 0;
14366 #endif
14367     GET_RE_DEBUG_FLAGS_DECL;
14368
14369     PERL_ARGS_ASSERT_REGTAIL_STUDY;
14370
14371
14372     if (SIZE_ONLY)
14373         return exact;
14374
14375     /* Find last node. */
14376
14377     scan = p;
14378     for (;;) {
14379         regnode * const temp = regnext(scan);
14380 #ifdef EXPERIMENTAL_INPLACESCAN
14381         if (PL_regkind[OP(scan)] == EXACT) {
14382             bool has_exactf_sharp_s;    /* Unexamined in this routine */
14383             if (join_exact(pRExC_state,scan,&min, &has_exactf_sharp_s, 1,val,depth+1))
14384                 return EXACT;
14385         }
14386 #endif
14387         if ( exact ) {
14388             switch (OP(scan)) {
14389                 case EXACT:
14390                 case EXACTF:
14391                 case EXACTFA:
14392                 case EXACTFU:
14393                 case EXACTFU_SS:
14394                 case EXACTFU_TRICKYFOLD:
14395                 case EXACTFL:
14396                         if( exact == PSEUDO )
14397                             exact= OP(scan);
14398                         else if ( exact != OP(scan) )
14399                             exact= 0;
14400                 case NOTHING:
14401                     break;
14402                 default:
14403                     exact= 0;
14404             }
14405         }
14406         DEBUG_PARSE_r({
14407             SV * const mysv=sv_newmortal();
14408             DEBUG_PARSE_MSG((scan==p ? "tsdy" : ""));
14409             regprop(RExC_rx, mysv, scan);
14410             PerlIO_printf(Perl_debug_log, "~ %s (%d) -> %s\n",
14411                 SvPV_nolen_const(mysv),
14412                 REG_NODE_NUM(scan),
14413                 PL_reg_name[exact]);
14414         });
14415         if (temp == NULL)
14416             break;
14417         scan = temp;
14418     }
14419     DEBUG_PARSE_r({
14420         SV * const mysv_val=sv_newmortal();
14421         DEBUG_PARSE_MSG("");
14422         regprop(RExC_rx, mysv_val, val);
14423         PerlIO_printf(Perl_debug_log, "~ attach to %s (%"IVdf") offset to %"IVdf"\n",
14424                       SvPV_nolen_const(mysv_val),
14425                       (IV)REG_NODE_NUM(val),
14426                       (IV)(val - scan)
14427         );
14428     });
14429     if (reg_off_by_arg[OP(scan)]) {
14430         ARG_SET(scan, val - scan);
14431     }
14432     else {
14433         NEXT_OFF(scan) = val - scan;
14434     }
14435
14436     return exact;
14437 }
14438 #endif
14439
14440 /*
14441  - regdump - dump a regexp onto Perl_debug_log in vaguely comprehensible form
14442  */
14443 #ifdef DEBUGGING
14444 static void 
14445 S_regdump_extflags(pTHX_ const char *lead, const U32 flags)
14446 {
14447     int bit;
14448     int set=0;
14449     regex_charset cs;
14450
14451     for (bit=0; bit<32; bit++) {
14452         if (flags & (1<<bit)) {
14453             if ((1<<bit) & RXf_PMf_CHARSET) {   /* Output separately, below */
14454                 continue;
14455             }
14456             if (!set++ && lead) 
14457                 PerlIO_printf(Perl_debug_log, "%s",lead);
14458             PerlIO_printf(Perl_debug_log, "%s ",PL_reg_extflags_name[bit]);
14459         }               
14460     }      
14461     if ((cs = get_regex_charset(flags)) != REGEX_DEPENDS_CHARSET) {
14462             if (!set++ && lead) {
14463                 PerlIO_printf(Perl_debug_log, "%s",lead);
14464             }
14465             switch (cs) {
14466                 case REGEX_UNICODE_CHARSET:
14467                     PerlIO_printf(Perl_debug_log, "UNICODE");
14468                     break;
14469                 case REGEX_LOCALE_CHARSET:
14470                     PerlIO_printf(Perl_debug_log, "LOCALE");
14471                     break;
14472                 case REGEX_ASCII_RESTRICTED_CHARSET:
14473                     PerlIO_printf(Perl_debug_log, "ASCII-RESTRICTED");
14474                     break;
14475                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
14476                     PerlIO_printf(Perl_debug_log, "ASCII-MORE_RESTRICTED");
14477                     break;
14478                 default:
14479                     PerlIO_printf(Perl_debug_log, "UNKNOWN CHARACTER SET");
14480                     break;
14481             }
14482     }
14483     if (lead)  {
14484         if (set) 
14485             PerlIO_printf(Perl_debug_log, "\n");
14486         else 
14487             PerlIO_printf(Perl_debug_log, "%s[none-set]\n",lead);
14488     }            
14489 }   
14490 #endif
14491
14492 void
14493 Perl_regdump(pTHX_ const regexp *r)
14494 {
14495 #ifdef DEBUGGING
14496     dVAR;
14497     SV * const sv = sv_newmortal();
14498     SV *dsv= sv_newmortal();
14499     RXi_GET_DECL(r,ri);
14500     GET_RE_DEBUG_FLAGS_DECL;
14501
14502     PERL_ARGS_ASSERT_REGDUMP;
14503
14504     (void)dumpuntil(r, ri->program, ri->program + 1, NULL, NULL, sv, 0, 0);
14505
14506     /* Header fields of interest. */
14507     if (r->anchored_substr) {
14508         RE_PV_QUOTED_DECL(s, 0, dsv, SvPVX_const(r->anchored_substr), 
14509             RE_SV_DUMPLEN(r->anchored_substr), 30);
14510         PerlIO_printf(Perl_debug_log,
14511                       "anchored %s%s at %"IVdf" ",
14512                       s, RE_SV_TAIL(r->anchored_substr),
14513                       (IV)r->anchored_offset);
14514     } else if (r->anchored_utf8) {
14515         RE_PV_QUOTED_DECL(s, 1, dsv, SvPVX_const(r->anchored_utf8), 
14516             RE_SV_DUMPLEN(r->anchored_utf8), 30);
14517         PerlIO_printf(Perl_debug_log,
14518                       "anchored utf8 %s%s at %"IVdf" ",
14519                       s, RE_SV_TAIL(r->anchored_utf8),
14520                       (IV)r->anchored_offset);
14521     }                 
14522     if (r->float_substr) {
14523         RE_PV_QUOTED_DECL(s, 0, dsv, SvPVX_const(r->float_substr), 
14524             RE_SV_DUMPLEN(r->float_substr), 30);
14525         PerlIO_printf(Perl_debug_log,
14526                       "floating %s%s at %"IVdf"..%"UVuf" ",
14527                       s, RE_SV_TAIL(r->float_substr),
14528                       (IV)r->float_min_offset, (UV)r->float_max_offset);
14529     } else if (r->float_utf8) {
14530         RE_PV_QUOTED_DECL(s, 1, dsv, SvPVX_const(r->float_utf8), 
14531             RE_SV_DUMPLEN(r->float_utf8), 30);
14532         PerlIO_printf(Perl_debug_log,
14533                       "floating utf8 %s%s at %"IVdf"..%"UVuf" ",
14534                       s, RE_SV_TAIL(r->float_utf8),
14535                       (IV)r->float_min_offset, (UV)r->float_max_offset);
14536     }
14537     if (r->check_substr || r->check_utf8)
14538         PerlIO_printf(Perl_debug_log,
14539                       (const char *)
14540                       (r->check_substr == r->float_substr
14541                        && r->check_utf8 == r->float_utf8
14542                        ? "(checking floating" : "(checking anchored"));
14543     if (r->extflags & RXf_NOSCAN)
14544         PerlIO_printf(Perl_debug_log, " noscan");
14545     if (r->extflags & RXf_CHECK_ALL)
14546         PerlIO_printf(Perl_debug_log, " isall");
14547     if (r->check_substr || r->check_utf8)
14548         PerlIO_printf(Perl_debug_log, ") ");
14549
14550     if (ri->regstclass) {
14551         regprop(r, sv, ri->regstclass);
14552         PerlIO_printf(Perl_debug_log, "stclass %s ", SvPVX_const(sv));
14553     }
14554     if (r->extflags & RXf_ANCH) {
14555         PerlIO_printf(Perl_debug_log, "anchored");
14556         if (r->extflags & RXf_ANCH_BOL)
14557             PerlIO_printf(Perl_debug_log, "(BOL)");
14558         if (r->extflags & RXf_ANCH_MBOL)
14559             PerlIO_printf(Perl_debug_log, "(MBOL)");
14560         if (r->extflags & RXf_ANCH_SBOL)
14561             PerlIO_printf(Perl_debug_log, "(SBOL)");
14562         if (r->extflags & RXf_ANCH_GPOS)
14563             PerlIO_printf(Perl_debug_log, "(GPOS)");
14564         PerlIO_putc(Perl_debug_log, ' ');
14565     }
14566     if (r->extflags & RXf_GPOS_SEEN)
14567         PerlIO_printf(Perl_debug_log, "GPOS:%"UVuf" ", (UV)r->gofs);
14568     if (r->intflags & PREGf_SKIP)
14569         PerlIO_printf(Perl_debug_log, "plus ");
14570     if (r->intflags & PREGf_IMPLICIT)
14571         PerlIO_printf(Perl_debug_log, "implicit ");
14572     PerlIO_printf(Perl_debug_log, "minlen %"IVdf" ", (IV)r->minlen);
14573     if (r->extflags & RXf_EVAL_SEEN)
14574         PerlIO_printf(Perl_debug_log, "with eval ");
14575     PerlIO_printf(Perl_debug_log, "\n");
14576     DEBUG_FLAGS_r(regdump_extflags("r->extflags: ",r->extflags));            
14577 #else
14578     PERL_ARGS_ASSERT_REGDUMP;
14579     PERL_UNUSED_CONTEXT;
14580     PERL_UNUSED_ARG(r);
14581 #endif  /* DEBUGGING */
14582 }
14583
14584 /*
14585 - regprop - printable representation of opcode
14586 */
14587 #define EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags) \
14588 STMT_START { \
14589         if (do_sep) {                           \
14590             Perl_sv_catpvf(aTHX_ sv,"%s][%s",PL_colors[1],PL_colors[0]); \
14591             if (flags & ANYOF_INVERT)           \
14592                 /*make sure the invert info is in each */ \
14593                 sv_catpvs(sv, "^");             \
14594             do_sep = 0;                         \
14595         }                                       \
14596 } STMT_END
14597
14598 void
14599 Perl_regprop(pTHX_ const regexp *prog, SV *sv, const regnode *o)
14600 {
14601 #ifdef DEBUGGING
14602     dVAR;
14603     int k;
14604
14605     /* Should be synchronized with * ANYOF_ #xdefines in regcomp.h */
14606     static const char * const anyofs[] = {
14607 #if _CC_WORDCHAR != 0 || _CC_DIGIT != 1 || _CC_ALPHA != 2 || _CC_LOWER != 3 \
14608     || _CC_UPPER != 4 || _CC_PUNCT != 5 || _CC_PRINT != 6                   \
14609     || _CC_ALPHANUMERIC != 7 || _CC_GRAPH != 8 || _CC_CASED != 9            \
14610     || _CC_SPACE != 10 || _CC_BLANK != 11 || _CC_XDIGIT != 12               \
14611     || _CC_PSXSPC != 13 || _CC_CNTRL != 14 || _CC_ASCII != 15               \
14612     || _CC_VERTSPACE != 16
14613   #error Need to adjust order of anyofs[]
14614 #endif
14615         "[\\w]",
14616         "[\\W]",
14617         "[\\d]",
14618         "[\\D]",
14619         "[:alpha:]",
14620         "[:^alpha:]",
14621         "[:lower:]",
14622         "[:^lower:]",
14623         "[:upper:]",
14624         "[:^upper:]",
14625         "[:punct:]",
14626         "[:^punct:]",
14627         "[:print:]",
14628         "[:^print:]",
14629         "[:alnum:]",
14630         "[:^alnum:]",
14631         "[:graph:]",
14632         "[:^graph:]",
14633         "[:cased:]",
14634         "[:^cased:]",
14635         "[\\s]",
14636         "[\\S]",
14637         "[:blank:]",
14638         "[:^blank:]",
14639         "[:xdigit:]",
14640         "[:^xdigit:]",
14641         "[:space:]",
14642         "[:^space:]",
14643         "[:cntrl:]",
14644         "[:^cntrl:]",
14645         "[:ascii:]",
14646         "[:^ascii:]",
14647         "[\\v]",
14648         "[\\V]"
14649     };
14650     RXi_GET_DECL(prog,progi);
14651     GET_RE_DEBUG_FLAGS_DECL;
14652     
14653     PERL_ARGS_ASSERT_REGPROP;
14654
14655     sv_setpvs(sv, "");
14656
14657     if (OP(o) > REGNODE_MAX)            /* regnode.type is unsigned */
14658         /* It would be nice to FAIL() here, but this may be called from
14659            regexec.c, and it would be hard to supply pRExC_state. */
14660         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d", (int)OP(o), (int)REGNODE_MAX);
14661     sv_catpv(sv, PL_reg_name[OP(o)]); /* Take off const! */
14662
14663     k = PL_regkind[OP(o)];
14664
14665     if (k == EXACT) {
14666         sv_catpvs(sv, " ");
14667         /* Using is_utf8_string() (via PERL_PV_UNI_DETECT) 
14668          * is a crude hack but it may be the best for now since 
14669          * we have no flag "this EXACTish node was UTF-8" 
14670          * --jhi */
14671         pv_pretty(sv, STRING(o), STR_LEN(o), 60, PL_colors[0], PL_colors[1],
14672                   PERL_PV_ESCAPE_UNI_DETECT |
14673                   PERL_PV_ESCAPE_NONASCII   |
14674                   PERL_PV_PRETTY_ELLIPSES   |
14675                   PERL_PV_PRETTY_LTGT       |
14676                   PERL_PV_PRETTY_NOCLEAR
14677                   );
14678     } else if (k == TRIE) {
14679         /* print the details of the trie in dumpuntil instead, as
14680          * progi->data isn't available here */
14681         const char op = OP(o);
14682         const U32 n = ARG(o);
14683         const reg_ac_data * const ac = IS_TRIE_AC(op) ?
14684                (reg_ac_data *)progi->data->data[n] :
14685                NULL;
14686         const reg_trie_data * const trie
14687             = (reg_trie_data*)progi->data->data[!IS_TRIE_AC(op) ? n : ac->trie];
14688         
14689         Perl_sv_catpvf(aTHX_ sv, "-%s",PL_reg_name[o->flags]);
14690         DEBUG_TRIE_COMPILE_r(
14691             Perl_sv_catpvf(aTHX_ sv,
14692                 "<S:%"UVuf"/%"IVdf" W:%"UVuf" L:%"UVuf"/%"UVuf" C:%"UVuf"/%"UVuf">",
14693                 (UV)trie->startstate,
14694                 (IV)trie->statecount-1, /* -1 because of the unused 0 element */
14695                 (UV)trie->wordcount,
14696                 (UV)trie->minlen,
14697                 (UV)trie->maxlen,
14698                 (UV)TRIE_CHARCOUNT(trie),
14699                 (UV)trie->uniquecharcount
14700             )
14701         );
14702         if ( IS_ANYOF_TRIE(op) || trie->bitmap ) {
14703             int i;
14704             int rangestart = -1;
14705             U8* bitmap = IS_ANYOF_TRIE(op) ? (U8*)ANYOF_BITMAP(o) : (U8*)TRIE_BITMAP(trie);
14706             sv_catpvs(sv, "[");
14707             for (i = 0; i <= 256; i++) {
14708                 if (i < 256 && BITMAP_TEST(bitmap,i)) {
14709                     if (rangestart == -1)
14710                         rangestart = i;
14711                 } else if (rangestart != -1) {
14712                     if (i <= rangestart + 3)
14713                         for (; rangestart < i; rangestart++)
14714                             put_byte(sv, rangestart);
14715                     else {
14716                         put_byte(sv, rangestart);
14717                         sv_catpvs(sv, "-");
14718                         put_byte(sv, i - 1);
14719                     }
14720                     rangestart = -1;
14721                 }
14722             }
14723             sv_catpvs(sv, "]");
14724         } 
14725          
14726     } else if (k == CURLY) {
14727         if (OP(o) == CURLYM || OP(o) == CURLYN || OP(o) == CURLYX)
14728             Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags); /* Parenth number */
14729         Perl_sv_catpvf(aTHX_ sv, " {%d,%d}", ARG1(o), ARG2(o));
14730     }
14731     else if (k == WHILEM && o->flags)                   /* Ordinal/of */
14732         Perl_sv_catpvf(aTHX_ sv, "[%d/%d]", o->flags & 0xf, o->flags>>4);
14733     else if (k == REF || k == OPEN || k == CLOSE || k == GROUPP || OP(o)==ACCEPT) {
14734         Perl_sv_catpvf(aTHX_ sv, "%d", (int)ARG(o));    /* Parenth number */
14735         if ( RXp_PAREN_NAMES(prog) ) {
14736             if ( k != REF || (OP(o) < NREF)) {
14737                 AV *list= MUTABLE_AV(progi->data->data[progi->name_list_idx]);
14738                 SV **name= av_fetch(list, ARG(o), 0 );
14739                 if (name)
14740                     Perl_sv_catpvf(aTHX_ sv, " '%"SVf"'", SVfARG(*name));
14741             }       
14742             else {
14743                 AV *list= MUTABLE_AV(progi->data->data[ progi->name_list_idx ]);
14744                 SV *sv_dat= MUTABLE_SV(progi->data->data[ ARG( o ) ]);
14745                 I32 *nums=(I32*)SvPVX(sv_dat);
14746                 SV **name= av_fetch(list, nums[0], 0 );
14747                 I32 n;
14748                 if (name) {
14749                     for ( n=0; n<SvIVX(sv_dat); n++ ) {
14750                         Perl_sv_catpvf(aTHX_ sv, "%s%"IVdf,
14751                                     (n ? "," : ""), (IV)nums[n]);
14752                     }
14753                     Perl_sv_catpvf(aTHX_ sv, " '%"SVf"'", SVfARG(*name));
14754                 }
14755             }
14756         }            
14757     } else if (k == GOSUB) 
14758         Perl_sv_catpvf(aTHX_ sv, "%d[%+d]", (int)ARG(o),(int)ARG2L(o)); /* Paren and offset */
14759     else if (k == VERB) {
14760         if (!o->flags) 
14761             Perl_sv_catpvf(aTHX_ sv, ":%"SVf, 
14762                            SVfARG((MUTABLE_SV(progi->data->data[ ARG( o ) ]))));
14763     } else if (k == LOGICAL)
14764         Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags);     /* 2: embedded, otherwise 1 */
14765     else if (k == ANYOF) {
14766         int i, rangestart = -1;
14767         const U8 flags = ANYOF_FLAGS(o);
14768         int do_sep = 0;
14769
14770
14771         if (flags & ANYOF_LOCALE)
14772             sv_catpvs(sv, "{loc}");
14773         if (flags & ANYOF_LOC_FOLD)
14774             sv_catpvs(sv, "{i}");
14775         Perl_sv_catpvf(aTHX_ sv, "[%s", PL_colors[0]);
14776         if (flags & ANYOF_INVERT)
14777             sv_catpvs(sv, "^");
14778
14779         /* output what the standard cp 0-255 bitmap matches */
14780         for (i = 0; i <= 256; i++) {
14781             if (i < 256 && ANYOF_BITMAP_TEST(o,i)) {
14782                 if (rangestart == -1)
14783                     rangestart = i;
14784             } else if (rangestart != -1) {
14785                 if (i <= rangestart + 3)
14786                     for (; rangestart < i; rangestart++)
14787                         put_byte(sv, rangestart);
14788                 else {
14789                     put_byte(sv, rangestart);
14790                     sv_catpvs(sv, "-");
14791                     put_byte(sv, i - 1);
14792                 }
14793                 do_sep = 1;
14794                 rangestart = -1;
14795             }
14796         }
14797         
14798         EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags);
14799         /* output any special charclass tests (used entirely under use locale) */
14800         if (ANYOF_CLASS_TEST_ANY_SET(o))
14801             for (i = 0; i < (int)(sizeof(anyofs)/sizeof(char*)); i++)
14802                 if (ANYOF_CLASS_TEST(o,i)) {
14803                     sv_catpv(sv, anyofs[i]);
14804                     do_sep = 1;
14805                 }
14806         
14807         EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags);
14808         
14809         if (flags & ANYOF_NON_UTF8_LATIN1_ALL) {
14810             sv_catpvs(sv, "{non-utf8-latin1-all}");
14811         }
14812
14813         /* output information about the unicode matching */
14814         if (flags & ANYOF_UNICODE_ALL)
14815             sv_catpvs(sv, "{unicode_all}");
14816         else if (ANYOF_NONBITMAP(o))
14817             sv_catpvs(sv, "{unicode}");
14818         if (flags & ANYOF_NONBITMAP_NON_UTF8)
14819             sv_catpvs(sv, "{outside bitmap}");
14820
14821         if (ANYOF_NONBITMAP(o)) {
14822             SV *lv; /* Set if there is something outside the bit map */
14823             SV * const sw = regclass_swash(prog, o, FALSE, &lv, NULL);
14824             bool byte_output = FALSE;   /* If something in the bitmap has been
14825                                            output */
14826
14827             if (lv && lv != &PL_sv_undef) {
14828                 if (sw) {
14829                     U8 s[UTF8_MAXBYTES_CASE+1];
14830
14831                     for (i = 0; i <= 256; i++) { /* Look at chars in bitmap */
14832                         uvchr_to_utf8(s, i);
14833
14834                         if (i < 256
14835                             && ! ANYOF_BITMAP_TEST(o, i)    /* Don't duplicate
14836                                                                things already
14837                                                                output as part
14838                                                                of the bitmap */
14839                             && swash_fetch(sw, s, TRUE))
14840                         {
14841                             if (rangestart == -1)
14842                                 rangestart = i;
14843                         } else if (rangestart != -1) {
14844                             byte_output = TRUE;
14845                             if (i <= rangestart + 3)
14846                                 for (; rangestart < i; rangestart++) {
14847                                     put_byte(sv, rangestart);
14848                                 }
14849                             else {
14850                                 put_byte(sv, rangestart);
14851                                 sv_catpvs(sv, "-");
14852                                 put_byte(sv, i-1);
14853                             }
14854                             rangestart = -1;
14855                         }
14856                     }
14857                 }
14858
14859                 {
14860                     char *s = savesvpv(lv);
14861                     char * const origs = s;
14862
14863                     while (*s && *s != '\n')
14864                         s++;
14865
14866                     if (*s == '\n') {
14867                         const char * const t = ++s;
14868
14869                         if (byte_output) {
14870                             sv_catpvs(sv, " ");
14871                         }
14872
14873                         while (*s) {
14874                             if (*s == '\n') {
14875
14876                                 /* Truncate very long output */
14877                                 if (s - origs > 256) {
14878                                     Perl_sv_catpvf(aTHX_ sv,
14879                                                    "%.*s...",
14880                                                    (int) (s - origs - 1),
14881                                                    t);
14882                                     goto out_dump;
14883                                 }
14884                                 *s = ' ';
14885                             }
14886                             else if (*s == '\t') {
14887                                 *s = '-';
14888                             }
14889                             s++;
14890                         }
14891                         if (s[-1] == ' ')
14892                             s[-1] = 0;
14893
14894                         sv_catpv(sv, t);
14895                     }
14896
14897                 out_dump:
14898
14899                     Safefree(origs);
14900                 }
14901                 SvREFCNT_dec_NN(lv);
14902             }
14903         }
14904
14905         Perl_sv_catpvf(aTHX_ sv, "%s]", PL_colors[1]);
14906     }
14907     else if (k == POSIXD || k == NPOSIXD) {
14908         U8 index = FLAGS(o) * 2;
14909         if (index > (sizeof(anyofs) / sizeof(anyofs[0]))) {
14910             Perl_sv_catpvf(aTHX_ sv, "[illegal type=%d])", index);
14911         }
14912         else {
14913             sv_catpv(sv, anyofs[index]);
14914         }
14915     }
14916     else if (k == BRANCHJ && (OP(o) == UNLESSM || OP(o) == IFMATCH))
14917         Perl_sv_catpvf(aTHX_ sv, "[%d]", -(o->flags));
14918 #else
14919     PERL_UNUSED_CONTEXT;
14920     PERL_UNUSED_ARG(sv);
14921     PERL_UNUSED_ARG(o);
14922     PERL_UNUSED_ARG(prog);
14923 #endif  /* DEBUGGING */
14924 }
14925
14926 SV *
14927 Perl_re_intuit_string(pTHX_ REGEXP * const r)
14928 {                               /* Assume that RE_INTUIT is set */
14929     dVAR;
14930     struct regexp *const prog = ReANY(r);
14931     GET_RE_DEBUG_FLAGS_DECL;
14932
14933     PERL_ARGS_ASSERT_RE_INTUIT_STRING;
14934     PERL_UNUSED_CONTEXT;
14935
14936     DEBUG_COMPILE_r(
14937         {
14938             const char * const s = SvPV_nolen_const(prog->check_substr
14939                       ? prog->check_substr : prog->check_utf8);
14940
14941             if (!PL_colorset) reginitcolors();
14942             PerlIO_printf(Perl_debug_log,
14943                       "%sUsing REx %ssubstr:%s \"%s%.60s%s%s\"\n",
14944                       PL_colors[4],
14945                       prog->check_substr ? "" : "utf8 ",
14946                       PL_colors[5],PL_colors[0],
14947                       s,
14948                       PL_colors[1],
14949                       (strlen(s) > 60 ? "..." : ""));
14950         } );
14951
14952     return prog->check_substr ? prog->check_substr : prog->check_utf8;
14953 }
14954
14955 /* 
14956    pregfree() 
14957    
14958    handles refcounting and freeing the perl core regexp structure. When 
14959    it is necessary to actually free the structure the first thing it 
14960    does is call the 'free' method of the regexp_engine associated to
14961    the regexp, allowing the handling of the void *pprivate; member 
14962    first. (This routine is not overridable by extensions, which is why 
14963    the extensions free is called first.)
14964    
14965    See regdupe and regdupe_internal if you change anything here. 
14966 */
14967 #ifndef PERL_IN_XSUB_RE
14968 void
14969 Perl_pregfree(pTHX_ REGEXP *r)
14970 {
14971     SvREFCNT_dec(r);
14972 }
14973
14974 void
14975 Perl_pregfree2(pTHX_ REGEXP *rx)
14976 {
14977     dVAR;
14978     struct regexp *const r = ReANY(rx);
14979     GET_RE_DEBUG_FLAGS_DECL;
14980
14981     PERL_ARGS_ASSERT_PREGFREE2;
14982
14983     if (r->mother_re) {
14984         ReREFCNT_dec(r->mother_re);
14985     } else {
14986         CALLREGFREE_PVT(rx); /* free the private data */
14987         SvREFCNT_dec(RXp_PAREN_NAMES(r));
14988         Safefree(r->xpv_len_u.xpvlenu_pv);
14989     }        
14990     if (r->substrs) {
14991         SvREFCNT_dec(r->anchored_substr);
14992         SvREFCNT_dec(r->anchored_utf8);
14993         SvREFCNT_dec(r->float_substr);
14994         SvREFCNT_dec(r->float_utf8);
14995         Safefree(r->substrs);
14996     }
14997     RX_MATCH_COPY_FREE(rx);
14998 #ifdef PERL_ANY_COW
14999     SvREFCNT_dec(r->saved_copy);
15000 #endif
15001     Safefree(r->offs);
15002     SvREFCNT_dec(r->qr_anoncv);
15003     rx->sv_u.svu_rx = 0;
15004 }
15005
15006 /*  reg_temp_copy()
15007     
15008     This is a hacky workaround to the structural issue of match results
15009     being stored in the regexp structure which is in turn stored in
15010     PL_curpm/PL_reg_curpm. The problem is that due to qr// the pattern
15011     could be PL_curpm in multiple contexts, and could require multiple
15012     result sets being associated with the pattern simultaneously, such
15013     as when doing a recursive match with (??{$qr})
15014     
15015     The solution is to make a lightweight copy of the regexp structure 
15016     when a qr// is returned from the code executed by (??{$qr}) this
15017     lightweight copy doesn't actually own any of its data except for
15018     the starp/end and the actual regexp structure itself. 
15019     
15020 */    
15021     
15022     
15023 REGEXP *
15024 Perl_reg_temp_copy (pTHX_ REGEXP *ret_x, REGEXP *rx)
15025 {
15026     struct regexp *ret;
15027     struct regexp *const r = ReANY(rx);
15028     const bool islv = ret_x && SvTYPE(ret_x) == SVt_PVLV;
15029
15030     PERL_ARGS_ASSERT_REG_TEMP_COPY;
15031
15032     if (!ret_x)
15033         ret_x = (REGEXP*) newSV_type(SVt_REGEXP);
15034     else {
15035         SvOK_off((SV *)ret_x);
15036         if (islv) {
15037             /* For PVLVs, SvANY points to the xpvlv body while sv_u points
15038                to the regexp.  (For SVt_REGEXPs, sv_upgrade has already
15039                made both spots point to the same regexp body.) */
15040             REGEXP *temp = (REGEXP *)newSV_type(SVt_REGEXP);
15041             assert(!SvPVX(ret_x));
15042             ret_x->sv_u.svu_rx = temp->sv_any;
15043             temp->sv_any = NULL;
15044             SvFLAGS(temp) = (SvFLAGS(temp) & ~SVTYPEMASK) | SVt_NULL;
15045             SvREFCNT_dec_NN(temp);
15046             /* SvCUR still resides in the xpvlv struct, so the regexp copy-
15047                ing below will not set it. */
15048             SvCUR_set(ret_x, SvCUR(rx));
15049         }
15050     }
15051     /* This ensures that SvTHINKFIRST(sv) is true, and hence that
15052        sv_force_normal(sv) is called.  */
15053     SvFAKE_on(ret_x);
15054     ret = ReANY(ret_x);
15055     
15056     SvFLAGS(ret_x) |= SvUTF8(rx);
15057     /* We share the same string buffer as the original regexp, on which we
15058        hold a reference count, incremented when mother_re is set below.
15059        The string pointer is copied here, being part of the regexp struct.
15060      */
15061     memcpy(&(ret->xpv_cur), &(r->xpv_cur),
15062            sizeof(regexp) - STRUCT_OFFSET(regexp, xpv_cur));
15063     if (r->offs) {
15064         const I32 npar = r->nparens+1;
15065         Newx(ret->offs, npar, regexp_paren_pair);
15066         Copy(r->offs, ret->offs, npar, regexp_paren_pair);
15067     }
15068     if (r->substrs) {
15069         Newx(ret->substrs, 1, struct reg_substr_data);
15070         StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
15071
15072         SvREFCNT_inc_void(ret->anchored_substr);
15073         SvREFCNT_inc_void(ret->anchored_utf8);
15074         SvREFCNT_inc_void(ret->float_substr);
15075         SvREFCNT_inc_void(ret->float_utf8);
15076
15077         /* check_substr and check_utf8, if non-NULL, point to either their
15078            anchored or float namesakes, and don't hold a second reference.  */
15079     }
15080     RX_MATCH_COPIED_off(ret_x);
15081 #ifdef PERL_ANY_COW
15082     ret->saved_copy = NULL;
15083 #endif
15084     ret->mother_re = ReREFCNT_inc(r->mother_re ? r->mother_re : rx);
15085     SvREFCNT_inc_void(ret->qr_anoncv);
15086     
15087     return ret_x;
15088 }
15089 #endif
15090
15091 /* regfree_internal() 
15092
15093    Free the private data in a regexp. This is overloadable by 
15094    extensions. Perl takes care of the regexp structure in pregfree(), 
15095    this covers the *pprivate pointer which technically perl doesn't 
15096    know about, however of course we have to handle the 
15097    regexp_internal structure when no extension is in use. 
15098    
15099    Note this is called before freeing anything in the regexp 
15100    structure. 
15101  */
15102  
15103 void
15104 Perl_regfree_internal(pTHX_ REGEXP * const rx)
15105 {
15106     dVAR;
15107     struct regexp *const r = ReANY(rx);
15108     RXi_GET_DECL(r,ri);
15109     GET_RE_DEBUG_FLAGS_DECL;
15110
15111     PERL_ARGS_ASSERT_REGFREE_INTERNAL;
15112
15113     DEBUG_COMPILE_r({
15114         if (!PL_colorset)
15115             reginitcolors();
15116         {
15117             SV *dsv= sv_newmortal();
15118             RE_PV_QUOTED_DECL(s, RX_UTF8(rx),
15119                 dsv, RX_PRECOMP(rx), RX_PRELEN(rx), 60);
15120             PerlIO_printf(Perl_debug_log,"%sFreeing REx:%s %s\n", 
15121                 PL_colors[4],PL_colors[5],s);
15122         }
15123     });
15124 #ifdef RE_TRACK_PATTERN_OFFSETS
15125     if (ri->u.offsets)
15126         Safefree(ri->u.offsets);             /* 20010421 MJD */
15127 #endif
15128     if (ri->code_blocks) {
15129         int n;
15130         for (n = 0; n < ri->num_code_blocks; n++)
15131             SvREFCNT_dec(ri->code_blocks[n].src_regex);
15132         Safefree(ri->code_blocks);
15133     }
15134
15135     if (ri->data) {
15136         int n = ri->data->count;
15137
15138         while (--n >= 0) {
15139           /* If you add a ->what type here, update the comment in regcomp.h */
15140             switch (ri->data->what[n]) {
15141             case 'a':
15142             case 'r':
15143             case 's':
15144             case 'S':
15145             case 'u':
15146                 SvREFCNT_dec(MUTABLE_SV(ri->data->data[n]));
15147                 break;
15148             case 'f':
15149                 Safefree(ri->data->data[n]);
15150                 break;
15151             case 'l':
15152             case 'L':
15153                 break;
15154             case 'T':           
15155                 { /* Aho Corasick add-on structure for a trie node.
15156                      Used in stclass optimization only */
15157                     U32 refcount;
15158                     reg_ac_data *aho=(reg_ac_data*)ri->data->data[n];
15159                     OP_REFCNT_LOCK;
15160                     refcount = --aho->refcount;
15161                     OP_REFCNT_UNLOCK;
15162                     if ( !refcount ) {
15163                         PerlMemShared_free(aho->states);
15164                         PerlMemShared_free(aho->fail);
15165                          /* do this last!!!! */
15166                         PerlMemShared_free(ri->data->data[n]);
15167                         PerlMemShared_free(ri->regstclass);
15168                     }
15169                 }
15170                 break;
15171             case 't':
15172                 {
15173                     /* trie structure. */
15174                     U32 refcount;
15175                     reg_trie_data *trie=(reg_trie_data*)ri->data->data[n];
15176                     OP_REFCNT_LOCK;
15177                     refcount = --trie->refcount;
15178                     OP_REFCNT_UNLOCK;
15179                     if ( !refcount ) {
15180                         PerlMemShared_free(trie->charmap);
15181                         PerlMemShared_free(trie->states);
15182                         PerlMemShared_free(trie->trans);
15183                         if (trie->bitmap)
15184                             PerlMemShared_free(trie->bitmap);
15185                         if (trie->jump)
15186                             PerlMemShared_free(trie->jump);
15187                         PerlMemShared_free(trie->wordinfo);
15188                         /* do this last!!!! */
15189                         PerlMemShared_free(ri->data->data[n]);
15190                     }
15191                 }
15192                 break;
15193             default:
15194                 Perl_croak(aTHX_ "panic: regfree data code '%c'", ri->data->what[n]);
15195             }
15196         }
15197         Safefree(ri->data->what);
15198         Safefree(ri->data);
15199     }
15200
15201     Safefree(ri);
15202 }
15203
15204 #define av_dup_inc(s,t) MUTABLE_AV(sv_dup_inc((const SV *)s,t))
15205 #define hv_dup_inc(s,t) MUTABLE_HV(sv_dup_inc((const SV *)s,t))
15206 #define SAVEPVN(p,n)    ((p) ? savepvn(p,n) : NULL)
15207
15208 /* 
15209    re_dup - duplicate a regexp. 
15210    
15211    This routine is expected to clone a given regexp structure. It is only
15212    compiled under USE_ITHREADS.
15213
15214    After all of the core data stored in struct regexp is duplicated
15215    the regexp_engine.dupe method is used to copy any private data
15216    stored in the *pprivate pointer. This allows extensions to handle
15217    any duplication it needs to do.
15218
15219    See pregfree() and regfree_internal() if you change anything here. 
15220 */
15221 #if defined(USE_ITHREADS)
15222 #ifndef PERL_IN_XSUB_RE
15223 void
15224 Perl_re_dup_guts(pTHX_ const REGEXP *sstr, REGEXP *dstr, CLONE_PARAMS *param)
15225 {
15226     dVAR;
15227     I32 npar;
15228     const struct regexp *r = ReANY(sstr);
15229     struct regexp *ret = ReANY(dstr);
15230     
15231     PERL_ARGS_ASSERT_RE_DUP_GUTS;
15232
15233     npar = r->nparens+1;
15234     Newx(ret->offs, npar, regexp_paren_pair);
15235     Copy(r->offs, ret->offs, npar, regexp_paren_pair);
15236
15237     if (ret->substrs) {
15238         /* Do it this way to avoid reading from *r after the StructCopy().
15239            That way, if any of the sv_dup_inc()s dislodge *r from the L1
15240            cache, it doesn't matter.  */
15241         const bool anchored = r->check_substr
15242             ? r->check_substr == r->anchored_substr
15243             : r->check_utf8 == r->anchored_utf8;
15244         Newx(ret->substrs, 1, struct reg_substr_data);
15245         StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
15246
15247         ret->anchored_substr = sv_dup_inc(ret->anchored_substr, param);
15248         ret->anchored_utf8 = sv_dup_inc(ret->anchored_utf8, param);
15249         ret->float_substr = sv_dup_inc(ret->float_substr, param);
15250         ret->float_utf8 = sv_dup_inc(ret->float_utf8, param);
15251
15252         /* check_substr and check_utf8, if non-NULL, point to either their
15253            anchored or float namesakes, and don't hold a second reference.  */
15254
15255         if (ret->check_substr) {
15256             if (anchored) {
15257                 assert(r->check_utf8 == r->anchored_utf8);
15258                 ret->check_substr = ret->anchored_substr;
15259                 ret->check_utf8 = ret->anchored_utf8;
15260             } else {
15261                 assert(r->check_substr == r->float_substr);
15262                 assert(r->check_utf8 == r->float_utf8);
15263                 ret->check_substr = ret->float_substr;
15264                 ret->check_utf8 = ret->float_utf8;
15265             }
15266         } else if (ret->check_utf8) {
15267             if (anchored) {
15268                 ret->check_utf8 = ret->anchored_utf8;
15269             } else {
15270                 ret->check_utf8 = ret->float_utf8;
15271             }
15272         }
15273     }
15274
15275     RXp_PAREN_NAMES(ret) = hv_dup_inc(RXp_PAREN_NAMES(ret), param);
15276     ret->qr_anoncv = MUTABLE_CV(sv_dup_inc((const SV *)ret->qr_anoncv, param));
15277
15278     if (ret->pprivate)
15279         RXi_SET(ret,CALLREGDUPE_PVT(dstr,param));
15280
15281     if (RX_MATCH_COPIED(dstr))
15282         ret->subbeg  = SAVEPVN(ret->subbeg, ret->sublen);
15283     else
15284         ret->subbeg = NULL;
15285 #ifdef PERL_ANY_COW
15286     ret->saved_copy = NULL;
15287 #endif
15288
15289     /* Whether mother_re be set or no, we need to copy the string.  We
15290        cannot refrain from copying it when the storage points directly to
15291        our mother regexp, because that's
15292                1: a buffer in a different thread
15293                2: something we no longer hold a reference on
15294                so we need to copy it locally.  */
15295     RX_WRAPPED(dstr) = SAVEPVN(RX_WRAPPED(sstr), SvCUR(sstr)+1);
15296     ret->mother_re   = NULL;
15297     ret->gofs = 0;
15298 }
15299 #endif /* PERL_IN_XSUB_RE */
15300
15301 /*
15302    regdupe_internal()
15303    
15304    This is the internal complement to regdupe() which is used to copy
15305    the structure pointed to by the *pprivate pointer in the regexp.
15306    This is the core version of the extension overridable cloning hook.
15307    The regexp structure being duplicated will be copied by perl prior
15308    to this and will be provided as the regexp *r argument, however 
15309    with the /old/ structures pprivate pointer value. Thus this routine
15310    may override any copying normally done by perl.
15311    
15312    It returns a pointer to the new regexp_internal structure.
15313 */
15314
15315 void *
15316 Perl_regdupe_internal(pTHX_ REGEXP * const rx, CLONE_PARAMS *param)
15317 {
15318     dVAR;
15319     struct regexp *const r = ReANY(rx);
15320     regexp_internal *reti;
15321     int len;
15322     RXi_GET_DECL(r,ri);
15323
15324     PERL_ARGS_ASSERT_REGDUPE_INTERNAL;
15325     
15326     len = ProgLen(ri);
15327     
15328     Newxc(reti, sizeof(regexp_internal) + len*sizeof(regnode), char, regexp_internal);
15329     Copy(ri->program, reti->program, len+1, regnode);
15330
15331     reti->num_code_blocks = ri->num_code_blocks;
15332     if (ri->code_blocks) {
15333         int n;
15334         Newxc(reti->code_blocks, ri->num_code_blocks, struct reg_code_block,
15335                 struct reg_code_block);
15336         Copy(ri->code_blocks, reti->code_blocks, ri->num_code_blocks,
15337                 struct reg_code_block);
15338         for (n = 0; n < ri->num_code_blocks; n++)
15339              reti->code_blocks[n].src_regex = (REGEXP*)
15340                     sv_dup_inc((SV*)(ri->code_blocks[n].src_regex), param);
15341     }
15342     else
15343         reti->code_blocks = NULL;
15344
15345     reti->regstclass = NULL;
15346
15347     if (ri->data) {
15348         struct reg_data *d;
15349         const int count = ri->data->count;
15350         int i;
15351
15352         Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
15353                 char, struct reg_data);
15354         Newx(d->what, count, U8);
15355
15356         d->count = count;
15357         for (i = 0; i < count; i++) {
15358             d->what[i] = ri->data->what[i];
15359             switch (d->what[i]) {
15360                 /* see also regcomp.h and regfree_internal() */
15361             case 'a': /* actually an AV, but the dup function is identical.  */
15362             case 'r':
15363             case 's':
15364             case 'S':
15365             case 'u': /* actually an HV, but the dup function is identical.  */
15366                 d->data[i] = sv_dup_inc((const SV *)ri->data->data[i], param);
15367                 break;
15368             case 'f':
15369                 /* This is cheating. */
15370                 Newx(d->data[i], 1, struct regnode_charclass_class);
15371                 StructCopy(ri->data->data[i], d->data[i],
15372                             struct regnode_charclass_class);
15373                 reti->regstclass = (regnode*)d->data[i];
15374                 break;
15375             case 'T':
15376                 /* Trie stclasses are readonly and can thus be shared
15377                  * without duplication. We free the stclass in pregfree
15378                  * when the corresponding reg_ac_data struct is freed.
15379                  */
15380                 reti->regstclass= ri->regstclass;
15381                 /* Fall through */
15382             case 't':
15383                 OP_REFCNT_LOCK;
15384                 ((reg_trie_data*)ri->data->data[i])->refcount++;
15385                 OP_REFCNT_UNLOCK;
15386                 /* Fall through */
15387             case 'l':
15388             case 'L':
15389                 d->data[i] = ri->data->data[i];
15390                 break;
15391             default:
15392                 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", ri->data->what[i]);
15393             }
15394         }
15395
15396         reti->data = d;
15397     }
15398     else
15399         reti->data = NULL;
15400
15401     reti->name_list_idx = ri->name_list_idx;
15402
15403 #ifdef RE_TRACK_PATTERN_OFFSETS
15404     if (ri->u.offsets) {
15405         Newx(reti->u.offsets, 2*len+1, U32);
15406         Copy(ri->u.offsets, reti->u.offsets, 2*len+1, U32);
15407     }
15408 #else
15409     SetProgLen(reti,len);
15410 #endif
15411
15412     return (void*)reti;
15413 }
15414
15415 #endif    /* USE_ITHREADS */
15416
15417 #ifndef PERL_IN_XSUB_RE
15418
15419 /*
15420  - regnext - dig the "next" pointer out of a node
15421  */
15422 regnode *
15423 Perl_regnext(pTHX_ regnode *p)
15424 {
15425     dVAR;
15426     I32 offset;
15427
15428     if (!p)
15429         return(NULL);
15430
15431     if (OP(p) > REGNODE_MAX) {          /* regnode.type is unsigned */
15432         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d", (int)OP(p), (int)REGNODE_MAX);
15433     }
15434
15435     offset = (reg_off_by_arg[OP(p)] ? ARG(p) : NEXT_OFF(p));
15436     if (offset == 0)
15437         return(NULL);
15438
15439     return(p+offset);
15440 }
15441 #endif
15442
15443 STATIC void
15444 S_re_croak2(pTHX_ const char* pat1,const char* pat2,...)
15445 {
15446     va_list args;
15447     STRLEN l1 = strlen(pat1);
15448     STRLEN l2 = strlen(pat2);
15449     char buf[512];
15450     SV *msv;
15451     const char *message;
15452
15453     PERL_ARGS_ASSERT_RE_CROAK2;
15454
15455     if (l1 > 510)
15456         l1 = 510;
15457     if (l1 + l2 > 510)
15458         l2 = 510 - l1;
15459     Copy(pat1, buf, l1 , char);
15460     Copy(pat2, buf + l1, l2 , char);
15461     buf[l1 + l2] = '\n';
15462     buf[l1 + l2 + 1] = '\0';
15463 #ifdef I_STDARG
15464     /* ANSI variant takes additional second argument */
15465     va_start(args, pat2);
15466 #else
15467     va_start(args);
15468 #endif
15469     msv = vmess(buf, &args);
15470     va_end(args);
15471     message = SvPV_const(msv,l1);
15472     if (l1 > 512)
15473         l1 = 512;
15474     Copy(message, buf, l1 , char);
15475     buf[l1-1] = '\0';                   /* Overwrite \n */
15476     Perl_croak(aTHX_ "%s", buf);
15477 }
15478
15479 /* XXX Here's a total kludge.  But we need to re-enter for swash routines. */
15480
15481 #ifndef PERL_IN_XSUB_RE
15482 void
15483 Perl_save_re_context(pTHX)
15484 {
15485     dVAR;
15486
15487     /* Save $1..$n (#18107: UTF-8 s/(\w+)/uc($1)/e); AMS 20021106. */
15488     if (PL_curpm) {
15489         const REGEXP * const rx = PM_GETRE(PL_curpm);
15490         if (rx) {
15491             U32 i;
15492             for (i = 1; i <= RX_NPARENS(rx); i++) {
15493                 char digits[TYPE_CHARS(long)];
15494                 const STRLEN len = my_snprintf(digits, sizeof(digits), "%lu", (long)i);
15495                 GV *const *const gvp
15496                     = (GV**)hv_fetch(PL_defstash, digits, len, 0);
15497
15498                 if (gvp) {
15499                     GV * const gv = *gvp;
15500                     if (SvTYPE(gv) == SVt_PVGV && GvSV(gv))
15501                         save_scalar(gv);
15502                 }
15503             }
15504         }
15505     }
15506 }
15507 #endif
15508
15509 #ifdef DEBUGGING
15510
15511 STATIC void
15512 S_put_byte(pTHX_ SV *sv, int c)
15513 {
15514     PERL_ARGS_ASSERT_PUT_BYTE;
15515
15516     /* Our definition of isPRINT() ignores locales, so only bytes that are
15517        not part of UTF-8 are considered printable. I assume that the same
15518        holds for UTF-EBCDIC.
15519        Also, code point 255 is not printable in either (it's E0 in EBCDIC,
15520        which Wikipedia says:
15521
15522        EO, or Eight Ones, is an 8-bit EBCDIC character code represented as all
15523        ones (binary 1111 1111, hexadecimal FF). It is similar, but not
15524        identical, to the ASCII delete (DEL) or rubout control character. ...
15525        it is typically mapped to hexadecimal code 9F, in order to provide a
15526        unique character mapping in both directions)
15527
15528        So the old condition can be simplified to !isPRINT(c)  */
15529     if (!isPRINT(c)) {
15530         if (c < 256) {
15531             Perl_sv_catpvf(aTHX_ sv, "\\x%02x", c);
15532         }
15533         else {
15534             Perl_sv_catpvf(aTHX_ sv, "\\x{%x}", c);
15535         }
15536     }
15537     else {
15538         const char string = c;
15539         if (c == '-' || c == ']' || c == '\\' || c == '^')
15540             sv_catpvs(sv, "\\");
15541         sv_catpvn(sv, &string, 1);
15542     }
15543 }
15544
15545
15546 #define CLEAR_OPTSTART \
15547     if (optstart) STMT_START { \
15548             DEBUG_OPTIMISE_r(PerlIO_printf(Perl_debug_log, " (%"IVdf" nodes)\n", (IV)(node - optstart))); \
15549             optstart=NULL; \
15550     } STMT_END
15551
15552 #define DUMPUNTIL(b,e) CLEAR_OPTSTART; node=dumpuntil(r,start,(b),(e),last,sv,indent+1,depth+1);
15553
15554 STATIC const regnode *
15555 S_dumpuntil(pTHX_ const regexp *r, const regnode *start, const regnode *node,
15556             const regnode *last, const regnode *plast, 
15557             SV* sv, I32 indent, U32 depth)
15558 {
15559     dVAR;
15560     U8 op = PSEUDO;     /* Arbitrary non-END op. */
15561     const regnode *next;
15562     const regnode *optstart= NULL;
15563     
15564     RXi_GET_DECL(r,ri);
15565     GET_RE_DEBUG_FLAGS_DECL;
15566
15567     PERL_ARGS_ASSERT_DUMPUNTIL;
15568
15569 #ifdef DEBUG_DUMPUNTIL
15570     PerlIO_printf(Perl_debug_log, "--- %d : %d - %d - %d\n",indent,node-start,
15571         last ? last-start : 0,plast ? plast-start : 0);
15572 #endif
15573             
15574     if (plast && plast < last) 
15575         last= plast;
15576
15577     while (PL_regkind[op] != END && (!last || node < last)) {
15578         /* While that wasn't END last time... */
15579         NODE_ALIGN(node);
15580         op = OP(node);
15581         if (op == CLOSE || op == WHILEM)
15582             indent--;
15583         next = regnext((regnode *)node);
15584
15585         /* Where, what. */
15586         if (OP(node) == OPTIMIZED) {
15587             if (!optstart && RE_DEBUG_FLAG(RE_DEBUG_COMPILE_OPTIMISE))
15588                 optstart = node;
15589             else
15590                 goto after_print;
15591         } else
15592             CLEAR_OPTSTART;
15593
15594         regprop(r, sv, node);
15595         PerlIO_printf(Perl_debug_log, "%4"IVdf":%*s%s", (IV)(node - start),
15596                       (int)(2*indent + 1), "", SvPVX_const(sv));
15597         
15598         if (OP(node) != OPTIMIZED) {                  
15599             if (next == NULL)           /* Next ptr. */
15600                 PerlIO_printf(Perl_debug_log, " (0)");
15601             else if (PL_regkind[(U8)op] == BRANCH && PL_regkind[OP(next)] != BRANCH )
15602                 PerlIO_printf(Perl_debug_log, " (FAIL)");
15603             else 
15604                 PerlIO_printf(Perl_debug_log, " (%"IVdf")", (IV)(next - start));
15605             (void)PerlIO_putc(Perl_debug_log, '\n'); 
15606         }
15607         
15608       after_print:
15609         if (PL_regkind[(U8)op] == BRANCHJ) {
15610             assert(next);
15611             {
15612                 const regnode *nnode = (OP(next) == LONGJMP
15613                                        ? regnext((regnode *)next)
15614                                        : next);
15615                 if (last && nnode > last)
15616                     nnode = last;
15617                 DUMPUNTIL(NEXTOPER(NEXTOPER(node)), nnode);
15618             }
15619         }
15620         else if (PL_regkind[(U8)op] == BRANCH) {
15621             assert(next);
15622             DUMPUNTIL(NEXTOPER(node), next);
15623         }
15624         else if ( PL_regkind[(U8)op]  == TRIE ) {
15625             const regnode *this_trie = node;
15626             const char op = OP(node);
15627             const U32 n = ARG(node);
15628             const reg_ac_data * const ac = op>=AHOCORASICK ?
15629                (reg_ac_data *)ri->data->data[n] :
15630                NULL;
15631             const reg_trie_data * const trie =
15632                 (reg_trie_data*)ri->data->data[op<AHOCORASICK ? n : ac->trie];
15633 #ifdef DEBUGGING
15634             AV *const trie_words = MUTABLE_AV(ri->data->data[n + TRIE_WORDS_OFFSET]);
15635 #endif
15636             const regnode *nextbranch= NULL;
15637             I32 word_idx;
15638             sv_setpvs(sv, "");
15639             for (word_idx= 0; word_idx < (I32)trie->wordcount; word_idx++) {
15640                 SV ** const elem_ptr = av_fetch(trie_words,word_idx,0);
15641
15642                 PerlIO_printf(Perl_debug_log, "%*s%s ",
15643                    (int)(2*(indent+3)), "",
15644                     elem_ptr ? pv_pretty(sv, SvPV_nolen_const(*elem_ptr), SvCUR(*elem_ptr), 60,
15645                             PL_colors[0], PL_colors[1],
15646                             (SvUTF8(*elem_ptr) ? PERL_PV_ESCAPE_UNI : 0) |
15647                             PERL_PV_PRETTY_ELLIPSES    |
15648                             PERL_PV_PRETTY_LTGT
15649                             )
15650                             : "???"
15651                 );
15652                 if (trie->jump) {
15653                     U16 dist= trie->jump[word_idx+1];
15654                     PerlIO_printf(Perl_debug_log, "(%"UVuf")\n",
15655                                   (UV)((dist ? this_trie + dist : next) - start));
15656                     if (dist) {
15657                         if (!nextbranch)
15658                             nextbranch= this_trie + trie->jump[0];    
15659                         DUMPUNTIL(this_trie + dist, nextbranch);
15660                     }
15661                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
15662                         nextbranch= regnext((regnode *)nextbranch);
15663                 } else {
15664                     PerlIO_printf(Perl_debug_log, "\n");
15665                 }
15666             }
15667             if (last && next > last)
15668                 node= last;
15669             else
15670                 node= next;
15671         }
15672         else if ( op == CURLY ) {   /* "next" might be very big: optimizer */
15673             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS,
15674                     NEXTOPER(node) + EXTRA_STEP_2ARGS + 1);
15675         }
15676         else if (PL_regkind[(U8)op] == CURLY && op != CURLYX) {
15677             assert(next);
15678             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS, next);
15679         }
15680         else if ( op == PLUS || op == STAR) {
15681             DUMPUNTIL(NEXTOPER(node), NEXTOPER(node) + 1);
15682         }
15683         else if (PL_regkind[(U8)op] == ANYOF) {
15684             /* arglen 1 + class block */
15685             node += 1 + ((ANYOF_FLAGS(node) & ANYOF_CLASS)
15686                     ? ANYOF_CLASS_SKIP : ANYOF_SKIP);
15687             node = NEXTOPER(node);
15688         }
15689         else if (PL_regkind[(U8)op] == EXACT) {
15690             /* Literal string, where present. */
15691             node += NODE_SZ_STR(node) - 1;
15692             node = NEXTOPER(node);
15693         }
15694         else {
15695             node = NEXTOPER(node);
15696             node += regarglen[(U8)op];
15697         }
15698         if (op == CURLYX || op == OPEN)
15699             indent++;
15700     }
15701     CLEAR_OPTSTART;
15702 #ifdef DEBUG_DUMPUNTIL    
15703     PerlIO_printf(Perl_debug_log, "--- %d\n", (int)indent);
15704 #endif
15705     return node;
15706 }
15707
15708 #endif  /* DEBUGGING */
15709
15710 /*
15711  * Local variables:
15712  * c-indentation-style: bsd
15713  * c-basic-offset: 4
15714  * indent-tabs-mode: nil
15715  * End:
15716  *
15717  * ex: set ts=8 sts=4 sw=4 et:
15718  */