regex and overload: unifiy 1 and N arg branches
[platform/upstream/perl.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; &regdummy = don't = compiling */
130     I32         naughty;                /* How bad is this pattern? */
131     I32         sawback;                /* Did we see \1, ...? */
132     U32         seen;
133     I32         size;                   /* Code size. */
134     I32         npar;                   /* Capture buffer count, (OPEN). */
135     I32         cpar;                   /* Capture buffer count, (CLOSE). */
136     I32         nestroot;               /* root parens we are in - used by accept */
137     I32         extralen;
138     I32         seen_zerolen;
139     regnode     **open_parens;          /* pointers to open parens */
140     regnode     **close_parens;         /* pointers to close parens */
141     regnode     *opend;                 /* END node in program */
142     I32         utf8;           /* whether the pattern is utf8 or not */
143     I32         orig_utf8;      /* whether the pattern was originally in utf8 */
144                                 /* XXX use this for future optimisation of case
145                                  * where pattern must be upgraded to utf8. */
146     I32         uni_semantics;  /* If a d charset modifier should use unicode
147                                    rules, even if the pattern is not in
148                                    utf8 */
149     HV          *paren_names;           /* Paren names */
150     
151     regnode     **recurse;              /* Recurse regops */
152     I32         recurse_count;          /* Number of recurse regops */
153     I32         in_lookbehind;
154     I32         contains_locale;
155     I32         override_recoding;
156     I32         in_multi_char_class;
157     struct reg_code_block *code_blocks; /* positions of literal (?{})
158                                             within pattern */
159     int         num_code_blocks;        /* size of code_blocks[] */
160     int         code_index;             /* next code_blocks[] slot */
161 #if ADD_TO_REGEXEC
162     char        *starttry;              /* -Dr: where regtry was called. */
163 #define RExC_starttry   (pRExC_state->starttry)
164 #endif
165     SV          *runtime_code_qr;       /* qr with the runtime code blocks */
166 #ifdef DEBUGGING
167     const char  *lastparse;
168     I32         lastnum;
169     AV          *paren_name_list;       /* idx -> name */
170 #define RExC_lastparse  (pRExC_state->lastparse)
171 #define RExC_lastnum    (pRExC_state->lastnum)
172 #define RExC_paren_name_list    (pRExC_state->paren_name_list)
173 #endif
174 } RExC_state_t;
175
176 #define RExC_flags      (pRExC_state->flags)
177 #define RExC_pm_flags   (pRExC_state->pm_flags)
178 #define RExC_precomp    (pRExC_state->precomp)
179 #define RExC_rx_sv      (pRExC_state->rx_sv)
180 #define RExC_rx         (pRExC_state->rx)
181 #define RExC_rxi        (pRExC_state->rxi)
182 #define RExC_start      (pRExC_state->start)
183 #define RExC_end        (pRExC_state->end)
184 #define RExC_parse      (pRExC_state->parse)
185 #define RExC_whilem_seen        (pRExC_state->whilem_seen)
186 #ifdef RE_TRACK_PATTERN_OFFSETS
187 #define RExC_offsets    (pRExC_state->rxi->u.offsets) /* I am not like the others */
188 #endif
189 #define RExC_emit       (pRExC_state->emit)
190 #define RExC_emit_start (pRExC_state->emit_start)
191 #define RExC_emit_bound (pRExC_state->emit_bound)
192 #define RExC_naughty    (pRExC_state->naughty)
193 #define RExC_sawback    (pRExC_state->sawback)
194 #define RExC_seen       (pRExC_state->seen)
195 #define RExC_size       (pRExC_state->size)
196 #define RExC_npar       (pRExC_state->npar)
197 #define RExC_nestroot   (pRExC_state->nestroot)
198 #define RExC_extralen   (pRExC_state->extralen)
199 #define RExC_seen_zerolen       (pRExC_state->seen_zerolen)
200 #define RExC_utf8       (pRExC_state->utf8)
201 #define RExC_uni_semantics      (pRExC_state->uni_semantics)
202 #define RExC_orig_utf8  (pRExC_state->orig_utf8)
203 #define RExC_open_parens        (pRExC_state->open_parens)
204 #define RExC_close_parens       (pRExC_state->close_parens)
205 #define RExC_opend      (pRExC_state->opend)
206 #define RExC_paren_names        (pRExC_state->paren_names)
207 #define RExC_recurse    (pRExC_state->recurse)
208 #define RExC_recurse_count      (pRExC_state->recurse_count)
209 #define RExC_in_lookbehind      (pRExC_state->in_lookbehind)
210 #define RExC_contains_locale    (pRExC_state->contains_locale)
211 #define RExC_override_recoding (pRExC_state->override_recoding)
212 #define RExC_in_multi_char_class (pRExC_state->in_multi_char_class)
213
214
215 #define ISMULT1(c)      ((c) == '*' || (c) == '+' || (c) == '?')
216 #define ISMULT2(s)      ((*s) == '*' || (*s) == '+' || (*s) == '?' || \
217         ((*s) == '{' && regcurly(s, FALSE)))
218
219 #ifdef SPSTART
220 #undef SPSTART          /* dratted cpp namespace... */
221 #endif
222 /*
223  * Flags to be passed up and down.
224  */
225 #define WORST           0       /* Worst case. */
226 #define HASWIDTH        0x01    /* Known to match non-null strings. */
227
228 /* Simple enough to be STAR/PLUS operand; in an EXACTish node must be a single
229  * character.  (There needs to be a case: in the switch statement in regexec.c
230  * for any node marked SIMPLE.)  Note that this is not the same thing as
231  * REGNODE_SIMPLE */
232 #define SIMPLE          0x02
233 #define SPSTART         0x04    /* Starts with * or + */
234 #define POSTPONED       0x08    /* (?1),(?&name), (??{...}) or similar */
235 #define TRYAGAIN        0x10    /* Weeded out a declaration. */
236 #define RESTART_UTF8    0x20    /* Restart, need to calcuate sizes as UTF-8 */
237
238 #define REG_NODE_NUM(x) ((x) ? (int)((x)-RExC_emit_start) : -1)
239
240 /* whether trie related optimizations are enabled */
241 #if PERL_ENABLE_EXTENDED_TRIE_OPTIMISATION
242 #define TRIE_STUDY_OPT
243 #define FULL_TRIE_STUDY
244 #define TRIE_STCLASS
245 #endif
246
247
248
249 #define PBYTE(u8str,paren) ((U8*)(u8str))[(paren) >> 3]
250 #define PBITVAL(paren) (1 << ((paren) & 7))
251 #define PAREN_TEST(u8str,paren) ( PBYTE(u8str,paren) & PBITVAL(paren))
252 #define PAREN_SET(u8str,paren) PBYTE(u8str,paren) |= PBITVAL(paren)
253 #define PAREN_UNSET(u8str,paren) PBYTE(u8str,paren) &= (~PBITVAL(paren))
254
255 #define REQUIRE_UTF8    STMT_START {                                       \
256                                      if (!UTF) {                           \
257                                          *flagp = RESTART_UTF8;            \
258                                          return NULL;                      \
259                                      }                                     \
260                         } STMT_END
261
262 /* This converts the named class defined in regcomp.h to its equivalent class
263  * number defined in handy.h. */
264 #define namedclass_to_classnum(class)  ((int) ((class) / 2))
265 #define classnum_to_namedclass(classnum)  ((classnum) * 2)
266
267 /* About scan_data_t.
268
269   During optimisation we recurse through the regexp program performing
270   various inplace (keyhole style) optimisations. In addition study_chunk
271   and scan_commit populate this data structure with information about
272   what strings MUST appear in the pattern. We look for the longest 
273   string that must appear at a fixed location, and we look for the
274   longest string that may appear at a floating location. So for instance
275   in the pattern:
276   
277     /FOO[xX]A.*B[xX]BAR/
278     
279   Both 'FOO' and 'A' are fixed strings. Both 'B' and 'BAR' are floating
280   strings (because they follow a .* construct). study_chunk will identify
281   both FOO and BAR as being the longest fixed and floating strings respectively.
282   
283   The strings can be composites, for instance
284   
285      /(f)(o)(o)/
286      
287   will result in a composite fixed substring 'foo'.
288   
289   For each string some basic information is maintained:
290   
291   - offset or min_offset
292     This is the position the string must appear at, or not before.
293     It also implicitly (when combined with minlenp) tells us how many
294     characters must match before the string we are searching for.
295     Likewise when combined with minlenp and the length of the string it
296     tells us how many characters must appear after the string we have 
297     found.
298   
299   - max_offset
300     Only used for floating strings. This is the rightmost point that
301     the string can appear at. If set to I32 max it indicates that the
302     string can occur infinitely far to the right.
303   
304   - minlenp
305     A pointer to the minimum number of characters of the pattern that the
306     string was found inside. This is important as in the case of positive
307     lookahead or positive lookbehind we can have multiple patterns 
308     involved. Consider
309     
310     /(?=FOO).*F/
311     
312     The minimum length of the pattern overall is 3, the minimum length
313     of the lookahead part is 3, but the minimum length of the part that
314     will actually match is 1. So 'FOO's minimum length is 3, but the 
315     minimum length for the F is 1. This is important as the minimum length
316     is used to determine offsets in front of and behind the string being 
317     looked for.  Since strings can be composites this is the length of the
318     pattern at the time it was committed with a scan_commit. Note that
319     the length is calculated by study_chunk, so that the minimum lengths
320     are not known until the full pattern has been compiled, thus the 
321     pointer to the value.
322   
323   - lookbehind
324   
325     In the case of lookbehind the string being searched for can be
326     offset past the start point of the final matching string. 
327     If this value was just blithely removed from the min_offset it would
328     invalidate some of the calculations for how many chars must match
329     before or after (as they are derived from min_offset and minlen and
330     the length of the string being searched for). 
331     When the final pattern is compiled and the data is moved from the
332     scan_data_t structure into the regexp structure the information
333     about lookbehind is factored in, with the information that would 
334     have been lost precalculated in the end_shift field for the 
335     associated string.
336
337   The fields pos_min and pos_delta are used to store the minimum offset
338   and the delta to the maximum offset at the current point in the pattern.    
339
340 */
341
342 typedef struct scan_data_t {
343     /*I32 len_min;      unused */
344     /*I32 len_delta;    unused */
345     I32 pos_min;
346     I32 pos_delta;
347     SV *last_found;
348     I32 last_end;           /* min value, <0 unless valid. */
349     I32 last_start_min;
350     I32 last_start_max;
351     SV **longest;           /* Either &l_fixed, or &l_float. */
352     SV *longest_fixed;      /* longest fixed string found in pattern */
353     I32 offset_fixed;       /* offset where it starts */
354     I32 *minlen_fixed;      /* pointer to the minlen relevant to the string */
355     I32 lookbehind_fixed;   /* is the position of the string modfied by LB */
356     SV *longest_float;      /* longest floating string found in pattern */
357     I32 offset_float_min;   /* earliest point in string it can appear */
358     I32 offset_float_max;   /* latest point in string it can appear */
359     I32 *minlen_float;      /* pointer to the minlen relevant to the string */
360     I32 lookbehind_float;   /* is the position of the string modified by LB */
361     I32 flags;
362     I32 whilem_c;
363     I32 *last_closep;
364     struct regnode_charclass_class *start_class;
365 } scan_data_t;
366
367 /*
368  * Forward declarations for pregcomp()'s friends.
369  */
370
371 static const scan_data_t zero_scan_data =
372   { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ,0};
373
374 #define SF_BEFORE_EOL           (SF_BEFORE_SEOL|SF_BEFORE_MEOL)
375 #define SF_BEFORE_SEOL          0x0001
376 #define SF_BEFORE_MEOL          0x0002
377 #define SF_FIX_BEFORE_EOL       (SF_FIX_BEFORE_SEOL|SF_FIX_BEFORE_MEOL)
378 #define SF_FL_BEFORE_EOL        (SF_FL_BEFORE_SEOL|SF_FL_BEFORE_MEOL)
379
380 #ifdef NO_UNARY_PLUS
381 #  define SF_FIX_SHIFT_EOL      (0+2)
382 #  define SF_FL_SHIFT_EOL               (0+4)
383 #else
384 #  define SF_FIX_SHIFT_EOL      (+2)
385 #  define SF_FL_SHIFT_EOL               (+4)
386 #endif
387
388 #define SF_FIX_BEFORE_SEOL      (SF_BEFORE_SEOL << SF_FIX_SHIFT_EOL)
389 #define SF_FIX_BEFORE_MEOL      (SF_BEFORE_MEOL << SF_FIX_SHIFT_EOL)
390
391 #define SF_FL_BEFORE_SEOL       (SF_BEFORE_SEOL << SF_FL_SHIFT_EOL)
392 #define SF_FL_BEFORE_MEOL       (SF_BEFORE_MEOL << SF_FL_SHIFT_EOL) /* 0x20 */
393 #define SF_IS_INF               0x0040
394 #define SF_HAS_PAR              0x0080
395 #define SF_IN_PAR               0x0100
396 #define SF_HAS_EVAL             0x0200
397 #define SCF_DO_SUBSTR           0x0400
398 #define SCF_DO_STCLASS_AND      0x0800
399 #define SCF_DO_STCLASS_OR       0x1000
400 #define SCF_DO_STCLASS          (SCF_DO_STCLASS_AND|SCF_DO_STCLASS_OR)
401 #define SCF_WHILEM_VISITED_POS  0x2000
402
403 #define SCF_TRIE_RESTUDY        0x4000 /* Do restudy? */
404 #define SCF_SEEN_ACCEPT         0x8000 
405
406 #define UTF cBOOL(RExC_utf8)
407
408 /* The enums for all these are ordered so things work out correctly */
409 #define LOC (get_regex_charset(RExC_flags) == REGEX_LOCALE_CHARSET)
410 #define DEPENDS_SEMANTICS (get_regex_charset(RExC_flags) == REGEX_DEPENDS_CHARSET)
411 #define UNI_SEMANTICS (get_regex_charset(RExC_flags) == REGEX_UNICODE_CHARSET)
412 #define AT_LEAST_UNI_SEMANTICS (get_regex_charset(RExC_flags) >= REGEX_UNICODE_CHARSET)
413 #define ASCII_RESTRICTED (get_regex_charset(RExC_flags) == REGEX_ASCII_RESTRICTED_CHARSET)
414 #define AT_LEAST_ASCII_RESTRICTED (get_regex_charset(RExC_flags) >= REGEX_ASCII_RESTRICTED_CHARSET)
415 #define ASCII_FOLD_RESTRICTED (get_regex_charset(RExC_flags) == REGEX_ASCII_MORE_RESTRICTED_CHARSET)
416
417 #define FOLD cBOOL(RExC_flags & RXf_PMf_FOLD)
418
419 #define OOB_NAMEDCLASS          -1
420
421 /* There is no code point that is out-of-bounds, so this is problematic.  But
422  * its only current use is to initialize a variable that is always set before
423  * looked at. */
424 #define OOB_UNICODE             0xDEADBEEF
425
426 #define CHR_SVLEN(sv) (UTF ? sv_len_utf8(sv) : SvCUR(sv))
427 #define CHR_DIST(a,b) (UTF ? utf8_distance(a,b) : a - b)
428
429
430 /* length of regex to show in messages that don't mark a position within */
431 #define RegexLengthToShowInErrorMessages 127
432
433 /*
434  * If MARKER[12] are adjusted, be sure to adjust the constants at the top
435  * of t/op/regmesg.t, the tests in t/op/re_tests, and those in
436  * op/pragma/warn/regcomp.
437  */
438 #define MARKER1 "<-- HERE"    /* marker as it appears in the description */
439 #define MARKER2 " <-- HERE "  /* marker as it appears within the regex */
440
441 #define REPORT_LOCATION " in regex; marked by " MARKER1 " in m/%.*s" MARKER2 "%s/"
442
443 /*
444  * Calls SAVEDESTRUCTOR_X if needed, then calls Perl_croak with the given
445  * arg. Show regex, up to a maximum length. If it's too long, chop and add
446  * "...".
447  */
448 #define _FAIL(code) STMT_START {                                        \
449     const char *ellipses = "";                                          \
450     IV len = RExC_end - RExC_precomp;                                   \
451                                                                         \
452     if (!SIZE_ONLY)                                                     \
453         SAVEFREESV(RExC_rx_sv);                                         \
454     if (len > RegexLengthToShowInErrorMessages) {                       \
455         /* chop 10 shorter than the max, to ensure meaning of "..." */  \
456         len = RegexLengthToShowInErrorMessages - 10;                    \
457         ellipses = "...";                                               \
458     }                                                                   \
459     code;                                                               \
460 } STMT_END
461
462 #define FAIL(msg) _FAIL(                            \
463     Perl_croak(aTHX_ "%s in regex m/%.*s%s/",       \
464             msg, (int)len, RExC_precomp, ellipses))
465
466 #define FAIL2(msg,arg) _FAIL(                       \
467     Perl_croak(aTHX_ msg " in regex m/%.*s%s/",     \
468             arg, (int)len, RExC_precomp, ellipses))
469
470 /*
471  * Simple_vFAIL -- like FAIL, but marks the current location in the scan
472  */
473 #define Simple_vFAIL(m) STMT_START {                                    \
474     const IV offset = RExC_parse - RExC_precomp;                        \
475     Perl_croak(aTHX_ "%s" REPORT_LOCATION,                              \
476             m, (int)offset, RExC_precomp, RExC_precomp + offset);       \
477 } STMT_END
478
479 /*
480  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL()
481  */
482 #define vFAIL(m) STMT_START {                           \
483     if (!SIZE_ONLY)                                     \
484         SAVEFREESV(RExC_rx_sv);                         \
485     Simple_vFAIL(m);                                    \
486 } STMT_END
487
488 /*
489  * Like Simple_vFAIL(), but accepts two arguments.
490  */
491 #define Simple_vFAIL2(m,a1) STMT_START {                        \
492     const IV offset = RExC_parse - RExC_precomp;                        \
493     S_re_croak2(aTHX_ m, REPORT_LOCATION, a1,                   \
494             (int)offset, RExC_precomp, RExC_precomp + offset);  \
495 } STMT_END
496
497 /*
498  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL2().
499  */
500 #define vFAIL2(m,a1) STMT_START {                       \
501     if (!SIZE_ONLY)                                     \
502         SAVEFREESV(RExC_rx_sv);                         \
503     Simple_vFAIL2(m, a1);                               \
504 } STMT_END
505
506
507 /*
508  * Like Simple_vFAIL(), but accepts three arguments.
509  */
510 #define Simple_vFAIL3(m, a1, a2) STMT_START {                   \
511     const IV offset = RExC_parse - RExC_precomp;                \
512     S_re_croak2(aTHX_ m, REPORT_LOCATION, a1, a2,               \
513             (int)offset, RExC_precomp, RExC_precomp + offset);  \
514 } STMT_END
515
516 /*
517  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL3().
518  */
519 #define vFAIL3(m,a1,a2) STMT_START {                    \
520     if (!SIZE_ONLY)                                     \
521         SAVEFREESV(RExC_rx_sv);                         \
522     Simple_vFAIL3(m, a1, a2);                           \
523 } STMT_END
524
525 /*
526  * Like Simple_vFAIL(), but accepts four arguments.
527  */
528 #define Simple_vFAIL4(m, a1, a2, a3) STMT_START {               \
529     const IV offset = RExC_parse - RExC_precomp;                \
530     S_re_croak2(aTHX_ m, REPORT_LOCATION, a1, a2, a3,           \
531             (int)offset, RExC_precomp, RExC_precomp + offset);  \
532 } STMT_END
533
534 #define vFAIL4(m,a1,a2,a3) STMT_START {                 \
535     if (!SIZE_ONLY)                                     \
536         SAVEFREESV(RExC_rx_sv);                         \
537     Simple_vFAIL4(m, a1, a2, a3);                       \
538 } STMT_END
539
540 /* m is not necessarily a "literal string", in this macro */
541 #define reg_warn_non_literal_string(loc, m) STMT_START {                \
542     const IV offset = loc - RExC_precomp;                               \
543     Perl_warner(aTHX_ packWARN(WARN_REGEXP), "%s" REPORT_LOCATION,      \
544             m, (int)offset, RExC_precomp, RExC_precomp + offset);       \
545 } STMT_END
546
547 #define ckWARNreg(loc,m) STMT_START {                                   \
548     const IV offset = loc - RExC_precomp;                               \
549     Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,      \
550             (int)offset, RExC_precomp, RExC_precomp + offset);          \
551 } STMT_END
552
553 #define vWARN_dep(loc, m) STMT_START {                                  \
554     const IV offset = loc - RExC_precomp;                               \
555     Perl_warner(aTHX_ packWARN(WARN_DEPRECATED), m REPORT_LOCATION,     \
556             (int)offset, RExC_precomp, RExC_precomp + offset);          \
557 } STMT_END
558
559 #define ckWARNdep(loc,m) STMT_START {                                   \
560     const IV offset = loc - RExC_precomp;                               \
561     Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED),                   \
562             m REPORT_LOCATION,                                          \
563             (int)offset, RExC_precomp, RExC_precomp + offset);          \
564 } STMT_END
565
566 #define ckWARNregdep(loc,m) STMT_START {                                \
567     const IV offset = loc - RExC_precomp;                               \
568     Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_REGEXP),     \
569             m REPORT_LOCATION,                                          \
570             (int)offset, RExC_precomp, RExC_precomp + offset);          \
571 } STMT_END
572
573 #define ckWARN2regdep(loc,m, a1) STMT_START {                           \
574     const IV offset = loc - RExC_precomp;                               \
575     Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_REGEXP),     \
576             m REPORT_LOCATION,                                          \
577             a1, (int)offset, RExC_precomp, RExC_precomp + offset);      \
578 } STMT_END
579
580 #define ckWARN2reg(loc, m, a1) STMT_START {                             \
581     const IV offset = loc - RExC_precomp;                               \
582     Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,      \
583             a1, (int)offset, RExC_precomp, RExC_precomp + offset);      \
584 } STMT_END
585
586 #define vWARN3(loc, m, a1, a2) STMT_START {                             \
587     const IV offset = loc - RExC_precomp;                               \
588     Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,         \
589             a1, a2, (int)offset, RExC_precomp, RExC_precomp + offset);  \
590 } STMT_END
591
592 #define ckWARN3reg(loc, m, a1, a2) STMT_START {                         \
593     const IV offset = loc - RExC_precomp;                               \
594     Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,      \
595             a1, a2, (int)offset, RExC_precomp, RExC_precomp + offset);  \
596 } STMT_END
597
598 #define vWARN4(loc, m, a1, a2, a3) STMT_START {                         \
599     const IV offset = loc - RExC_precomp;                               \
600     Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,         \
601             a1, a2, a3, (int)offset, RExC_precomp, RExC_precomp + offset); \
602 } STMT_END
603
604 #define ckWARN4reg(loc, m, a1, a2, a3) STMT_START {                     \
605     const IV offset = loc - RExC_precomp;                               \
606     Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,      \
607             a1, a2, a3, (int)offset, RExC_precomp, RExC_precomp + offset); \
608 } STMT_END
609
610 #define vWARN5(loc, m, a1, a2, a3, a4) STMT_START {                     \
611     const IV offset = loc - RExC_precomp;                               \
612     Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,         \
613             a1, a2, a3, a4, (int)offset, RExC_precomp, RExC_precomp + offset); \
614 } STMT_END
615
616
617 /* Allow for side effects in s */
618 #define REGC(c,s) STMT_START {                  \
619     if (!SIZE_ONLY) *(s) = (c); else (void)(s); \
620 } STMT_END
621
622 /* Macros for recording node offsets.   20001227 mjd@plover.com 
623  * Nodes are numbered 1, 2, 3, 4.  Node #n's position is recorded in
624  * element 2*n-1 of the array.  Element #2n holds the byte length node #n.
625  * Element 0 holds the number n.
626  * Position is 1 indexed.
627  */
628 #ifndef RE_TRACK_PATTERN_OFFSETS
629 #define Set_Node_Offset_To_R(node,byte)
630 #define Set_Node_Offset(node,byte)
631 #define Set_Cur_Node_Offset
632 #define Set_Node_Length_To_R(node,len)
633 #define Set_Node_Length(node,len)
634 #define Set_Node_Cur_Length(node)
635 #define Node_Offset(n) 
636 #define Node_Length(n) 
637 #define Set_Node_Offset_Length(node,offset,len)
638 #define ProgLen(ri) ri->u.proglen
639 #define SetProgLen(ri,x) ri->u.proglen = x
640 #else
641 #define ProgLen(ri) ri->u.offsets[0]
642 #define SetProgLen(ri,x) ri->u.offsets[0] = x
643 #define Set_Node_Offset_To_R(node,byte) STMT_START {                    \
644     if (! SIZE_ONLY) {                                                  \
645         MJD_OFFSET_DEBUG(("** (%d) offset of node %d is %d.\n",         \
646                     __LINE__, (int)(node), (int)(byte)));               \
647         if((node) < 0) {                                                \
648             Perl_croak(aTHX_ "value of node is %d in Offset macro", (int)(node)); \
649         } else {                                                        \
650             RExC_offsets[2*(node)-1] = (byte);                          \
651         }                                                               \
652     }                                                                   \
653 } STMT_END
654
655 #define Set_Node_Offset(node,byte) \
656     Set_Node_Offset_To_R((node)-RExC_emit_start, (byte)-RExC_start)
657 #define Set_Cur_Node_Offset Set_Node_Offset(RExC_emit, RExC_parse)
658
659 #define Set_Node_Length_To_R(node,len) STMT_START {                     \
660     if (! SIZE_ONLY) {                                                  \
661         MJD_OFFSET_DEBUG(("** (%d) size of node %d is %d.\n",           \
662                 __LINE__, (int)(node), (int)(len)));                    \
663         if((node) < 0) {                                                \
664             Perl_croak(aTHX_ "value of node is %d in Length macro", (int)(node)); \
665         } else {                                                        \
666             RExC_offsets[2*(node)] = (len);                             \
667         }                                                               \
668     }                                                                   \
669 } STMT_END
670
671 #define Set_Node_Length(node,len) \
672     Set_Node_Length_To_R((node)-RExC_emit_start, len)
673 #define Set_Cur_Node_Length(len) Set_Node_Length(RExC_emit, len)
674 #define Set_Node_Cur_Length(node) \
675     Set_Node_Length(node, RExC_parse - parse_start)
676
677 /* Get offsets and lengths */
678 #define Node_Offset(n) (RExC_offsets[2*((n)-RExC_emit_start)-1])
679 #define Node_Length(n) (RExC_offsets[2*((n)-RExC_emit_start)])
680
681 #define Set_Node_Offset_Length(node,offset,len) STMT_START {    \
682     Set_Node_Offset_To_R((node)-RExC_emit_start, (offset));     \
683     Set_Node_Length_To_R((node)-RExC_emit_start, (len));        \
684 } STMT_END
685 #endif
686
687 #if PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS
688 #define EXPERIMENTAL_INPLACESCAN
689 #endif /*PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS*/
690
691 #define DEBUG_STUDYDATA(str,data,depth)                              \
692 DEBUG_OPTIMISE_MORE_r(if(data){                                      \
693     PerlIO_printf(Perl_debug_log,                                    \
694         "%*s" str "Pos:%"IVdf"/%"IVdf                                \
695         " Flags: 0x%"UVXf" Whilem_c: %"IVdf" Lcp: %"IVdf" %s",       \
696         (int)(depth)*2, "",                                          \
697         (IV)((data)->pos_min),                                       \
698         (IV)((data)->pos_delta),                                     \
699         (UV)((data)->flags),                                         \
700         (IV)((data)->whilem_c),                                      \
701         (IV)((data)->last_closep ? *((data)->last_closep) : -1),     \
702         is_inf ? "INF " : ""                                         \
703     );                                                               \
704     if ((data)->last_found)                                          \
705         PerlIO_printf(Perl_debug_log,                                \
706             "Last:'%s' %"IVdf":%"IVdf"/%"IVdf" %sFixed:'%s' @ %"IVdf \
707             " %sFloat: '%s' @ %"IVdf"/%"IVdf"",                      \
708             SvPVX_const((data)->last_found),                         \
709             (IV)((data)->last_end),                                  \
710             (IV)((data)->last_start_min),                            \
711             (IV)((data)->last_start_max),                            \
712             ((data)->longest &&                                      \
713              (data)->longest==&((data)->longest_fixed)) ? "*" : "",  \
714             SvPVX_const((data)->longest_fixed),                      \
715             (IV)((data)->offset_fixed),                              \
716             ((data)->longest &&                                      \
717              (data)->longest==&((data)->longest_float)) ? "*" : "",  \
718             SvPVX_const((data)->longest_float),                      \
719             (IV)((data)->offset_float_min),                          \
720             (IV)((data)->offset_float_max)                           \
721         );                                                           \
722     PerlIO_printf(Perl_debug_log,"\n");                              \
723 });
724
725 /* Mark that we cannot extend a found fixed substring at this point.
726    Update the longest found anchored substring and the longest found
727    floating substrings if needed. */
728
729 STATIC void
730 S_scan_commit(pTHX_ const RExC_state_t *pRExC_state, scan_data_t *data, I32 *minlenp, int is_inf)
731 {
732     const STRLEN l = CHR_SVLEN(data->last_found);
733     const STRLEN old_l = CHR_SVLEN(*data->longest);
734     GET_RE_DEBUG_FLAGS_DECL;
735
736     PERL_ARGS_ASSERT_SCAN_COMMIT;
737
738     if ((l >= old_l) && ((l > old_l) || (data->flags & SF_BEFORE_EOL))) {
739         SvSetMagicSV(*data->longest, data->last_found);
740         if (*data->longest == data->longest_fixed) {
741             data->offset_fixed = l ? data->last_start_min : data->pos_min;
742             if (data->flags & SF_BEFORE_EOL)
743                 data->flags
744                     |= ((data->flags & SF_BEFORE_EOL) << SF_FIX_SHIFT_EOL);
745             else
746                 data->flags &= ~SF_FIX_BEFORE_EOL;
747             data->minlen_fixed=minlenp;
748             data->lookbehind_fixed=0;
749         }
750         else { /* *data->longest == data->longest_float */
751             data->offset_float_min = l ? data->last_start_min : data->pos_min;
752             data->offset_float_max = (l
753                                       ? data->last_start_max
754                                       : (data->pos_delta == I32_MAX ? I32_MAX : data->pos_min + data->pos_delta));
755             if (is_inf || (U32)data->offset_float_max > (U32)I32_MAX)
756                 data->offset_float_max = I32_MAX;
757             if (data->flags & SF_BEFORE_EOL)
758                 data->flags
759                     |= ((data->flags & SF_BEFORE_EOL) << SF_FL_SHIFT_EOL);
760             else
761                 data->flags &= ~SF_FL_BEFORE_EOL;
762             data->minlen_float=minlenp;
763             data->lookbehind_float=0;
764         }
765     }
766     SvCUR_set(data->last_found, 0);
767     {
768         SV * const sv = data->last_found;
769         if (SvUTF8(sv) && SvMAGICAL(sv)) {
770             MAGIC * const mg = mg_find(sv, PERL_MAGIC_utf8);
771             if (mg)
772                 mg->mg_len = 0;
773         }
774     }
775     data->last_end = -1;
776     data->flags &= ~SF_BEFORE_EOL;
777     DEBUG_STUDYDATA("commit: ",data,0);
778 }
779
780 /* These macros set, clear and test whether the synthetic start class ('ssc',
781  * given by the parameter) matches an empty string (EOS).  This uses the
782  * 'next_off' field in the node, to save a bit in the flags field.  The ssc
783  * stands alone, so there is never a next_off, so this field is otherwise
784  * unused.  The EOS information is used only for compilation, but theoretically
785  * it could be passed on to the execution code.  This could be used to store
786  * more than one bit of information, but only this one is currently used. */
787 #define SET_SSC_EOS(node)   STMT_START { (node)->next_off = TRUE; } STMT_END
788 #define CLEAR_SSC_EOS(node) STMT_START { (node)->next_off = FALSE; } STMT_END
789 #define TEST_SSC_EOS(node)  cBOOL((node)->next_off)
790
791 /* Can match anything (initialization) */
792 STATIC void
793 S_cl_anything(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl)
794 {
795     PERL_ARGS_ASSERT_CL_ANYTHING;
796
797     ANYOF_BITMAP_SETALL(cl);
798     cl->flags = ANYOF_UNICODE_ALL;
799     SET_SSC_EOS(cl);
800
801     /* If any portion of the regex is to operate under locale rules,
802      * initialization includes it.  The reason this isn't done for all regexes
803      * is that the optimizer was written under the assumption that locale was
804      * all-or-nothing.  Given the complexity and lack of documentation in the
805      * optimizer, and that there are inadequate test cases for locale, so many
806      * parts of it may not work properly, it is safest to avoid locale unless
807      * necessary. */
808     if (RExC_contains_locale) {
809         ANYOF_CLASS_SETALL(cl);     /* /l uses class */
810         cl->flags |= ANYOF_LOCALE|ANYOF_CLASS|ANYOF_LOC_FOLD;
811     }
812     else {
813         ANYOF_CLASS_ZERO(cl);       /* Only /l uses class now */
814     }
815 }
816
817 /* Can match anything (initialization) */
818 STATIC int
819 S_cl_is_anything(const struct regnode_charclass_class *cl)
820 {
821     int value;
822
823     PERL_ARGS_ASSERT_CL_IS_ANYTHING;
824
825     for (value = 0; value < ANYOF_MAX; value += 2)
826         if (ANYOF_CLASS_TEST(cl, value) && ANYOF_CLASS_TEST(cl, value + 1))
827             return 1;
828     if (!(cl->flags & ANYOF_UNICODE_ALL))
829         return 0;
830     if (!ANYOF_BITMAP_TESTALLSET((const void*)cl))
831         return 0;
832     return 1;
833 }
834
835 /* Can match anything (initialization) */
836 STATIC void
837 S_cl_init(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl)
838 {
839     PERL_ARGS_ASSERT_CL_INIT;
840
841     Zero(cl, 1, struct regnode_charclass_class);
842     cl->type = ANYOF;
843     cl_anything(pRExC_state, cl);
844     ARG_SET(cl, ANYOF_NONBITMAP_EMPTY);
845 }
846
847 /* These two functions currently do the exact same thing */
848 #define cl_init_zero            S_cl_init
849
850 /* 'AND' a given class with another one.  Can create false positives.  'cl'
851  * should not be inverted.  'and_with->flags & ANYOF_CLASS' should be 0 if
852  * 'and_with' is a regnode_charclass instead of a regnode_charclass_class. */
853 STATIC void
854 S_cl_and(struct regnode_charclass_class *cl,
855         const struct regnode_charclass_class *and_with)
856 {
857     PERL_ARGS_ASSERT_CL_AND;
858
859     assert(PL_regkind[and_with->type] == ANYOF);
860
861     /* I (khw) am not sure all these restrictions are necessary XXX */
862     if (!(ANYOF_CLASS_TEST_ANY_SET(and_with))
863         && !(ANYOF_CLASS_TEST_ANY_SET(cl))
864         && (and_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
865         && !(and_with->flags & ANYOF_LOC_FOLD)
866         && !(cl->flags & ANYOF_LOC_FOLD)) {
867         int i;
868
869         if (and_with->flags & ANYOF_INVERT)
870             for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
871                 cl->bitmap[i] &= ~and_with->bitmap[i];
872         else
873             for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
874                 cl->bitmap[i] &= and_with->bitmap[i];
875     } /* XXXX: logic is complicated otherwise, leave it along for a moment. */
876
877     if (and_with->flags & ANYOF_INVERT) {
878
879         /* Here, the and'ed node is inverted.  Get the AND of the flags that
880          * aren't affected by the inversion.  Those that are affected are
881          * handled individually below */
882         U8 affected_flags = cl->flags & ~INVERSION_UNAFFECTED_FLAGS;
883         cl->flags &= (and_with->flags & INVERSION_UNAFFECTED_FLAGS);
884         cl->flags |= affected_flags;
885
886         /* We currently don't know how to deal with things that aren't in the
887          * bitmap, but we know that the intersection is no greater than what
888          * is already in cl, so let there be false positives that get sorted
889          * out after the synthetic start class succeeds, and the node is
890          * matched for real. */
891
892         /* The inversion of these two flags indicate that the resulting
893          * intersection doesn't have them */
894         if (and_with->flags & ANYOF_UNICODE_ALL) {
895             cl->flags &= ~ANYOF_UNICODE_ALL;
896         }
897         if (and_with->flags & ANYOF_NON_UTF8_LATIN1_ALL) {
898             cl->flags &= ~ANYOF_NON_UTF8_LATIN1_ALL;
899         }
900     }
901     else {   /* and'd node is not inverted */
902         U8 outside_bitmap_but_not_utf8; /* Temp variable */
903
904         if (! ANYOF_NONBITMAP(and_with)) {
905
906             /* Here 'and_with' doesn't match anything outside the bitmap
907              * (except possibly ANYOF_UNICODE_ALL), which means the
908              * intersection can't either, except for ANYOF_UNICODE_ALL, in
909              * which case we don't know what the intersection is, but it's no
910              * greater than what cl already has, so can just leave it alone,
911              * with possible false positives */
912             if (! (and_with->flags & ANYOF_UNICODE_ALL)) {
913                 ARG_SET(cl, ANYOF_NONBITMAP_EMPTY);
914                 cl->flags &= ~ANYOF_NONBITMAP_NON_UTF8;
915             }
916         }
917         else if (! ANYOF_NONBITMAP(cl)) {
918
919             /* Here, 'and_with' does match something outside the bitmap, and cl
920              * doesn't have a list of things to match outside the bitmap.  If
921              * cl can match all code points above 255, the intersection will
922              * be those above-255 code points that 'and_with' matches.  If cl
923              * can't match all Unicode code points, it means that it can't
924              * match anything outside the bitmap (since the 'if' that got us
925              * into this block tested for that), so we leave the bitmap empty.
926              */
927             if (cl->flags & ANYOF_UNICODE_ALL) {
928                 ARG_SET(cl, ARG(and_with));
929
930                 /* and_with's ARG may match things that don't require UTF8.
931                  * And now cl's will too, in spite of this being an 'and'.  See
932                  * the comments below about the kludge */
933                 cl->flags |= and_with->flags & ANYOF_NONBITMAP_NON_UTF8;
934             }
935         }
936         else {
937             /* Here, both 'and_with' and cl match something outside the
938              * bitmap.  Currently we do not do the intersection, so just match
939              * whatever cl had at the beginning.  */
940         }
941
942
943         /* Take the intersection of the two sets of flags.  However, the
944          * ANYOF_NONBITMAP_NON_UTF8 flag is treated as an 'or'.  This is a
945          * kludge around the fact that this flag is not treated like the others
946          * which are initialized in cl_anything().  The way the optimizer works
947          * is that the synthetic start class (SSC) is initialized to match
948          * anything, and then the first time a real node is encountered, its
949          * values are AND'd with the SSC's with the result being the values of
950          * the real node.  However, there are paths through the optimizer where
951          * the AND never gets called, so those initialized bits are set
952          * inappropriately, which is not usually a big deal, as they just cause
953          * false positives in the SSC, which will just mean a probably
954          * imperceptible slow down in execution.  However this bit has a
955          * higher false positive consequence in that it can cause utf8.pm,
956          * utf8_heavy.pl ... to be loaded when not necessary, which is a much
957          * bigger slowdown and also causes significant extra memory to be used.
958          * In order to prevent this, the code now takes a different tack.  The
959          * bit isn't set unless some part of the regular expression needs it,
960          * but once set it won't get cleared.  This means that these extra
961          * modules won't get loaded unless there was some path through the
962          * pattern that would have required them anyway, and  so any false
963          * positives that occur by not ANDing them out when they could be
964          * aren't as severe as they would be if we treated this bit like all
965          * the others */
966         outside_bitmap_but_not_utf8 = (cl->flags | and_with->flags)
967                                       & ANYOF_NONBITMAP_NON_UTF8;
968         cl->flags &= and_with->flags;
969         cl->flags |= outside_bitmap_but_not_utf8;
970     }
971 }
972
973 /* 'OR' a given class with another one.  Can create false positives.  'cl'
974  * should not be inverted.  'or_with->flags & ANYOF_CLASS' should be 0 if
975  * 'or_with' is a regnode_charclass instead of a regnode_charclass_class. */
976 STATIC void
977 S_cl_or(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl, const struct regnode_charclass_class *or_with)
978 {
979     PERL_ARGS_ASSERT_CL_OR;
980
981     if (or_with->flags & ANYOF_INVERT) {
982
983         /* Here, the or'd node is to be inverted.  This means we take the
984          * complement of everything not in the bitmap, but currently we don't
985          * know what that is, so give up and match anything */
986         if (ANYOF_NONBITMAP(or_with)) {
987             cl_anything(pRExC_state, cl);
988         }
989         /* We do not use
990          * (B1 | CL1) | (!B2 & !CL2) = (B1 | !B2 & !CL2) | (CL1 | (!B2 & !CL2))
991          *   <= (B1 | !B2) | (CL1 | !CL2)
992          * which is wasteful if CL2 is small, but we ignore CL2:
993          *   (B1 | CL1) | (!B2 & !CL2) <= (B1 | CL1) | !B2 = (B1 | !B2) | CL1
994          * XXXX Can we handle case-fold?  Unclear:
995          *   (OK1(i) | OK1(i')) | !(OK1(i) | OK1(i')) =
996          *   (OK1(i) | OK1(i')) | (!OK1(i) & !OK1(i'))
997          */
998         else if ( (or_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
999              && !(or_with->flags & ANYOF_LOC_FOLD)
1000              && !(cl->flags & ANYOF_LOC_FOLD) ) {
1001             int i;
1002
1003             for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
1004                 cl->bitmap[i] |= ~or_with->bitmap[i];
1005         } /* XXXX: logic is complicated otherwise */
1006         else {
1007             cl_anything(pRExC_state, cl);
1008         }
1009
1010         /* And, we can just take the union of the flags that aren't affected
1011          * by the inversion */
1012         cl->flags |= or_with->flags & INVERSION_UNAFFECTED_FLAGS;
1013
1014         /* For the remaining flags:
1015             ANYOF_UNICODE_ALL and inverted means to not match anything above
1016                     255, which means that the union with cl should just be
1017                     what cl has in it, so can ignore this flag
1018             ANYOF_NON_UTF8_LATIN1_ALL and inverted means if not utf8 and ord
1019                     is 127-255 to match them, but then invert that, so the
1020                     union with cl should just be what cl has in it, so can
1021                     ignore this flag
1022          */
1023     } else {    /* 'or_with' is not inverted */
1024         /* (B1 | CL1) | (B2 | CL2) = (B1 | B2) | (CL1 | CL2)) */
1025         if ( (or_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
1026              && (!(or_with->flags & ANYOF_LOC_FOLD)
1027                  || (cl->flags & ANYOF_LOC_FOLD)) ) {
1028             int i;
1029
1030             /* OR char bitmap and class bitmap separately */
1031             for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
1032                 cl->bitmap[i] |= or_with->bitmap[i];
1033             if (or_with->flags & ANYOF_CLASS) {
1034                 ANYOF_CLASS_OR(or_with, cl);
1035             }
1036         }
1037         else { /* XXXX: logic is complicated, leave it along for a moment. */
1038             cl_anything(pRExC_state, cl);
1039         }
1040
1041         if (ANYOF_NONBITMAP(or_with)) {
1042
1043             /* Use the added node's outside-the-bit-map match if there isn't a
1044              * conflict.  If there is a conflict (both nodes match something
1045              * outside the bitmap, but what they match outside is not the same
1046              * pointer, and hence not easily compared until XXX we extend
1047              * inversion lists this far), give up and allow the start class to
1048              * match everything outside the bitmap.  If that stuff is all above
1049              * 255, can just set UNICODE_ALL, otherwise caould be anything. */
1050             if (! ANYOF_NONBITMAP(cl)) {
1051                 ARG_SET(cl, ARG(or_with));
1052             }
1053             else if (ARG(cl) != ARG(or_with)) {
1054
1055                 if ((or_with->flags & ANYOF_NONBITMAP_NON_UTF8)) {
1056                     cl_anything(pRExC_state, cl);
1057                 }
1058                 else {
1059                     cl->flags |= ANYOF_UNICODE_ALL;
1060                 }
1061             }
1062         }
1063
1064         /* Take the union */
1065         cl->flags |= or_with->flags;
1066     }
1067 }
1068
1069 #define TRIE_LIST_ITEM(state,idx) (trie->states[state].trans.list)[ idx ]
1070 #define TRIE_LIST_CUR(state)  ( TRIE_LIST_ITEM( state, 0 ).forid )
1071 #define TRIE_LIST_LEN(state) ( TRIE_LIST_ITEM( state, 0 ).newstate )
1072 #define TRIE_LIST_USED(idx)  ( trie->states[state].trans.list ? (TRIE_LIST_CUR( idx ) - 1) : 0 )
1073
1074
1075 #ifdef DEBUGGING
1076 /*
1077    dump_trie(trie,widecharmap,revcharmap)
1078    dump_trie_interim_list(trie,widecharmap,revcharmap,next_alloc)
1079    dump_trie_interim_table(trie,widecharmap,revcharmap,next_alloc)
1080
1081    These routines dump out a trie in a somewhat readable format.
1082    The _interim_ variants are used for debugging the interim
1083    tables that are used to generate the final compressed
1084    representation which is what dump_trie expects.
1085
1086    Part of the reason for their existence is to provide a form
1087    of documentation as to how the different representations function.
1088
1089 */
1090
1091 /*
1092   Dumps the final compressed table form of the trie to Perl_debug_log.
1093   Used for debugging make_trie().
1094 */
1095
1096 STATIC void
1097 S_dump_trie(pTHX_ const struct _reg_trie_data *trie, HV *widecharmap,
1098             AV *revcharmap, U32 depth)
1099 {
1100     U32 state;
1101     SV *sv=sv_newmortal();
1102     int colwidth= widecharmap ? 6 : 4;
1103     U16 word;
1104     GET_RE_DEBUG_FLAGS_DECL;
1105
1106     PERL_ARGS_ASSERT_DUMP_TRIE;
1107
1108     PerlIO_printf( Perl_debug_log, "%*sChar : %-6s%-6s%-4s ",
1109         (int)depth * 2 + 2,"",
1110         "Match","Base","Ofs" );
1111
1112     for( state = 0 ; state < trie->uniquecharcount ; state++ ) {
1113         SV ** const tmp = av_fetch( revcharmap, state, 0);
1114         if ( tmp ) {
1115             PerlIO_printf( Perl_debug_log, "%*s", 
1116                 colwidth,
1117                 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth, 
1118                             PL_colors[0], PL_colors[1],
1119                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1120                             PERL_PV_ESCAPE_FIRSTCHAR 
1121                 ) 
1122             );
1123         }
1124     }
1125     PerlIO_printf( Perl_debug_log, "\n%*sState|-----------------------",
1126         (int)depth * 2 + 2,"");
1127
1128     for( state = 0 ; state < trie->uniquecharcount ; state++ )
1129         PerlIO_printf( Perl_debug_log, "%.*s", colwidth, "--------");
1130     PerlIO_printf( Perl_debug_log, "\n");
1131
1132     for( state = 1 ; state < trie->statecount ; state++ ) {
1133         const U32 base = trie->states[ state ].trans.base;
1134
1135         PerlIO_printf( Perl_debug_log, "%*s#%4"UVXf"|", (int)depth * 2 + 2,"", (UV)state);
1136
1137         if ( trie->states[ state ].wordnum ) {
1138             PerlIO_printf( Perl_debug_log, " W%4X", trie->states[ state ].wordnum );
1139         } else {
1140             PerlIO_printf( Perl_debug_log, "%6s", "" );
1141         }
1142
1143         PerlIO_printf( Perl_debug_log, " @%4"UVXf" ", (UV)base );
1144
1145         if ( base ) {
1146             U32 ofs = 0;
1147
1148             while( ( base + ofs  < trie->uniquecharcount ) ||
1149                    ( base + ofs - trie->uniquecharcount < trie->lasttrans
1150                      && trie->trans[ base + ofs - trie->uniquecharcount ].check != state))
1151                     ofs++;
1152
1153             PerlIO_printf( Perl_debug_log, "+%2"UVXf"[ ", (UV)ofs);
1154
1155             for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
1156                 if ( ( base + ofs >= trie->uniquecharcount ) &&
1157                      ( base + ofs - trie->uniquecharcount < trie->lasttrans ) &&
1158                      trie->trans[ base + ofs - trie->uniquecharcount ].check == state )
1159                 {
1160                    PerlIO_printf( Perl_debug_log, "%*"UVXf,
1161                     colwidth,
1162                     (UV)trie->trans[ base + ofs - trie->uniquecharcount ].next );
1163                 } else {
1164                     PerlIO_printf( Perl_debug_log, "%*s",colwidth,"   ." );
1165                 }
1166             }
1167
1168             PerlIO_printf( Perl_debug_log, "]");
1169
1170         }
1171         PerlIO_printf( Perl_debug_log, "\n" );
1172     }
1173     PerlIO_printf(Perl_debug_log, "%*sword_info N:(prev,len)=", (int)depth*2, "");
1174     for (word=1; word <= trie->wordcount; word++) {
1175         PerlIO_printf(Perl_debug_log, " %d:(%d,%d)",
1176             (int)word, (int)(trie->wordinfo[word].prev),
1177             (int)(trie->wordinfo[word].len));
1178     }
1179     PerlIO_printf(Perl_debug_log, "\n" );
1180 }    
1181 /*
1182   Dumps a fully constructed but uncompressed trie in list form.
1183   List tries normally only are used for construction when the number of 
1184   possible chars (trie->uniquecharcount) is very high.
1185   Used for debugging make_trie().
1186 */
1187 STATIC void
1188 S_dump_trie_interim_list(pTHX_ const struct _reg_trie_data *trie,
1189                          HV *widecharmap, AV *revcharmap, U32 next_alloc,
1190                          U32 depth)
1191 {
1192     U32 state;
1193     SV *sv=sv_newmortal();
1194     int colwidth= widecharmap ? 6 : 4;
1195     GET_RE_DEBUG_FLAGS_DECL;
1196
1197     PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_LIST;
1198
1199     /* print out the table precompression.  */
1200     PerlIO_printf( Perl_debug_log, "%*sState :Word | Transition Data\n%*s%s",
1201         (int)depth * 2 + 2,"", (int)depth * 2 + 2,"",
1202         "------:-----+-----------------\n" );
1203     
1204     for( state=1 ; state < next_alloc ; state ++ ) {
1205         U16 charid;
1206     
1207         PerlIO_printf( Perl_debug_log, "%*s %4"UVXf" :",
1208             (int)depth * 2 + 2,"", (UV)state  );
1209         if ( ! trie->states[ state ].wordnum ) {
1210             PerlIO_printf( Perl_debug_log, "%5s| ","");
1211         } else {
1212             PerlIO_printf( Perl_debug_log, "W%4x| ",
1213                 trie->states[ state ].wordnum
1214             );
1215         }
1216         for( charid = 1 ; charid <= TRIE_LIST_USED( state ) ; charid++ ) {
1217             SV ** const tmp = av_fetch( revcharmap, TRIE_LIST_ITEM(state,charid).forid, 0);
1218             if ( tmp ) {
1219                 PerlIO_printf( Perl_debug_log, "%*s:%3X=%4"UVXf" | ",
1220                     colwidth,
1221                     pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth, 
1222                             PL_colors[0], PL_colors[1],
1223                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1224                             PERL_PV_ESCAPE_FIRSTCHAR 
1225                     ) ,
1226                     TRIE_LIST_ITEM(state,charid).forid,
1227                     (UV)TRIE_LIST_ITEM(state,charid).newstate
1228                 );
1229                 if (!(charid % 10)) 
1230                     PerlIO_printf(Perl_debug_log, "\n%*s| ",
1231                         (int)((depth * 2) + 14), "");
1232             }
1233         }
1234         PerlIO_printf( Perl_debug_log, "\n");
1235     }
1236 }    
1237
1238 /*
1239   Dumps a fully constructed but uncompressed trie in table form.
1240   This is the normal DFA style state transition table, with a few 
1241   twists to facilitate compression later. 
1242   Used for debugging make_trie().
1243 */
1244 STATIC void
1245 S_dump_trie_interim_table(pTHX_ const struct _reg_trie_data *trie,
1246                           HV *widecharmap, AV *revcharmap, U32 next_alloc,
1247                           U32 depth)
1248 {
1249     U32 state;
1250     U16 charid;
1251     SV *sv=sv_newmortal();
1252     int colwidth= widecharmap ? 6 : 4;
1253     GET_RE_DEBUG_FLAGS_DECL;
1254
1255     PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_TABLE;
1256     
1257     /*
1258        print out the table precompression so that we can do a visual check
1259        that they are identical.
1260      */
1261     
1262     PerlIO_printf( Perl_debug_log, "%*sChar : ",(int)depth * 2 + 2,"" );
1263
1264     for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
1265         SV ** const tmp = av_fetch( revcharmap, charid, 0);
1266         if ( tmp ) {
1267             PerlIO_printf( Perl_debug_log, "%*s", 
1268                 colwidth,
1269                 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth, 
1270                             PL_colors[0], PL_colors[1],
1271                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1272                             PERL_PV_ESCAPE_FIRSTCHAR 
1273                 ) 
1274             );
1275         }
1276     }
1277
1278     PerlIO_printf( Perl_debug_log, "\n%*sState+-",(int)depth * 2 + 2,"" );
1279
1280     for( charid=0 ; charid < trie->uniquecharcount ; charid++ ) {
1281         PerlIO_printf( Perl_debug_log, "%.*s", colwidth,"--------");
1282     }
1283
1284     PerlIO_printf( Perl_debug_log, "\n" );
1285
1286     for( state=1 ; state < next_alloc ; state += trie->uniquecharcount ) {
1287
1288         PerlIO_printf( Perl_debug_log, "%*s%4"UVXf" : ", 
1289             (int)depth * 2 + 2,"",
1290             (UV)TRIE_NODENUM( state ) );
1291
1292         for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
1293             UV v=(UV)SAFE_TRIE_NODENUM( trie->trans[ state + charid ].next );
1294             if (v)
1295                 PerlIO_printf( Perl_debug_log, "%*"UVXf, colwidth, v );
1296             else
1297                 PerlIO_printf( Perl_debug_log, "%*s", colwidth, "." );
1298         }
1299         if ( ! trie->states[ TRIE_NODENUM( state ) ].wordnum ) {
1300             PerlIO_printf( Perl_debug_log, " (%4"UVXf")\n", (UV)trie->trans[ state ].check );
1301         } else {
1302             PerlIO_printf( Perl_debug_log, " (%4"UVXf") W%4X\n", (UV)trie->trans[ state ].check,
1303             trie->states[ TRIE_NODENUM( state ) ].wordnum );
1304         }
1305     }
1306 }
1307
1308 #endif
1309
1310
1311 /* make_trie(startbranch,first,last,tail,word_count,flags,depth)
1312   startbranch: the first branch in the whole branch sequence
1313   first      : start branch of sequence of branch-exact nodes.
1314                May be the same as startbranch
1315   last       : Thing following the last branch.
1316                May be the same as tail.
1317   tail       : item following the branch sequence
1318   count      : words in the sequence
1319   flags      : currently the OP() type we will be building one of /EXACT(|F|Fl)/
1320   depth      : indent depth
1321
1322 Inplace optimizes a sequence of 2 or more Branch-Exact nodes into a TRIE node.
1323
1324 A trie is an N'ary tree where the branches are determined by digital
1325 decomposition of the key. IE, at the root node you look up the 1st character and
1326 follow that branch repeat until you find the end of the branches. Nodes can be
1327 marked as "accepting" meaning they represent a complete word. Eg:
1328
1329   /he|she|his|hers/
1330
1331 would convert into the following structure. Numbers represent states, letters
1332 following numbers represent valid transitions on the letter from that state, if
1333 the number is in square brackets it represents an accepting state, otherwise it
1334 will be in parenthesis.
1335
1336       +-h->+-e->[3]-+-r->(8)-+-s->[9]
1337       |    |
1338       |   (2)
1339       |    |
1340      (1)   +-i->(6)-+-s->[7]
1341       |
1342       +-s->(3)-+-h->(4)-+-e->[5]
1343
1344       Accept Word Mapping: 3=>1 (he),5=>2 (she), 7=>3 (his), 9=>4 (hers)
1345
1346 This shows that when matching against the string 'hers' we will begin at state 1
1347 read 'h' and move to state 2, read 'e' and move to state 3 which is accepting,
1348 then read 'r' and go to state 8 followed by 's' which takes us to state 9 which
1349 is also accepting. Thus we know that we can match both 'he' and 'hers' with a
1350 single traverse. We store a mapping from accepting to state to which word was
1351 matched, and then when we have multiple possibilities we try to complete the
1352 rest of the regex in the order in which they occured in the alternation.
1353
1354 The only prior NFA like behaviour that would be changed by the TRIE support is
1355 the silent ignoring of duplicate alternations which are of the form:
1356
1357  / (DUPE|DUPE) X? (?{ ... }) Y /x
1358
1359 Thus EVAL blocks following a trie may be called a different number of times with
1360 and without the optimisation. With the optimisations dupes will be silently
1361 ignored. This inconsistent behaviour of EVAL type nodes is well established as
1362 the following demonstrates:
1363
1364  'words'=~/(word|word|word)(?{ print $1 })[xyz]/
1365
1366 which prints out 'word' three times, but
1367
1368  'words'=~/(word|word|word)(?{ print $1 })S/
1369
1370 which doesnt print it out at all. This is due to other optimisations kicking in.
1371
1372 Example of what happens on a structural level:
1373
1374 The regexp /(ac|ad|ab)+/ will produce the following debug output:
1375
1376    1: CURLYM[1] {1,32767}(18)
1377    5:   BRANCH(8)
1378    6:     EXACT <ac>(16)
1379    8:   BRANCH(11)
1380    9:     EXACT <ad>(16)
1381   11:   BRANCH(14)
1382   12:     EXACT <ab>(16)
1383   16:   SUCCEED(0)
1384   17:   NOTHING(18)
1385   18: END(0)
1386
1387 This would be optimizable with startbranch=5, first=5, last=16, tail=16
1388 and should turn into:
1389
1390    1: CURLYM[1] {1,32767}(18)
1391    5:   TRIE(16)
1392         [Words:3 Chars Stored:6 Unique Chars:4 States:5 NCP:1]
1393           <ac>
1394           <ad>
1395           <ab>
1396   16:   SUCCEED(0)
1397   17:   NOTHING(18)
1398   18: END(0)
1399
1400 Cases where tail != last would be like /(?foo|bar)baz/:
1401
1402    1: BRANCH(4)
1403    2:   EXACT <foo>(8)
1404    4: BRANCH(7)
1405    5:   EXACT <bar>(8)
1406    7: TAIL(8)
1407    8: EXACT <baz>(10)
1408   10: END(0)
1409
1410 which would be optimizable with startbranch=1, first=1, last=7, tail=8
1411 and would end up looking like:
1412
1413     1: TRIE(8)
1414       [Words:2 Chars Stored:6 Unique Chars:5 States:7 NCP:1]
1415         <foo>
1416         <bar>
1417    7: TAIL(8)
1418    8: EXACT <baz>(10)
1419   10: END(0)
1420
1421     d = uvuni_to_utf8_flags(d, uv, 0);
1422
1423 is the recommended Unicode-aware way of saying
1424
1425     *(d++) = uv;
1426 */
1427
1428 #define TRIE_STORE_REVCHAR(val)                                            \
1429     STMT_START {                                                           \
1430         if (UTF) {                                                         \
1431             SV *zlopp = newSV(7); /* XXX: optimize me */                   \
1432             unsigned char *flrbbbbb = (unsigned char *) SvPVX(zlopp);      \
1433             unsigned const char *const kapow = uvuni_to_utf8(flrbbbbb, val); \
1434             SvCUR_set(zlopp, kapow - flrbbbbb);                            \
1435             SvPOK_on(zlopp);                                               \
1436             SvUTF8_on(zlopp);                                              \
1437             av_push(revcharmap, zlopp);                                    \
1438         } else {                                                           \
1439             char ooooff = (char)val;                                           \
1440             av_push(revcharmap, newSVpvn(&ooooff, 1));                     \
1441         }                                                                  \
1442         } STMT_END
1443
1444 #define TRIE_READ_CHAR STMT_START {                                                     \
1445     wordlen++;                                                                          \
1446     if ( UTF ) {                                                                        \
1447         /* if it is UTF then it is either already folded, or does not need folding */   \
1448         uvc = utf8n_to_uvuni( (const U8*) uc, UTF8_MAXLEN, &len, uniflags);             \
1449     }                                                                                   \
1450     else if (folder == PL_fold_latin1) {                                                \
1451         /* if we use this folder we have to obey unicode rules on latin-1 data */       \
1452         if ( foldlen > 0 ) {                                                            \
1453            uvc = utf8n_to_uvuni( (const U8*) scan, UTF8_MAXLEN, &len, uniflags );       \
1454            foldlen -= len;                                                              \
1455            scan += len;                                                                 \
1456            len = 0;                                                                     \
1457         } else {                                                                        \
1458             len = 1;                                                                    \
1459             uvc = _to_fold_latin1( (U8) *uc, foldbuf, &foldlen, 1);                     \
1460             skiplen = UNISKIP(uvc);                                                     \
1461             foldlen -= skiplen;                                                         \
1462             scan = foldbuf + skiplen;                                                   \
1463         }                                                                               \
1464     } else {                                                                            \
1465         /* raw data, will be folded later if needed */                                  \
1466         uvc = (U32)*uc;                                                                 \
1467         len = 1;                                                                        \
1468     }                                                                                   \
1469 } STMT_END
1470
1471
1472
1473 #define TRIE_LIST_PUSH(state,fid,ns) STMT_START {               \
1474     if ( TRIE_LIST_CUR( state ) >=TRIE_LIST_LEN( state ) ) {    \
1475         U32 ging = TRIE_LIST_LEN( state ) *= 2;                 \
1476         Renew( trie->states[ state ].trans.list, ging, reg_trie_trans_le ); \
1477     }                                                           \
1478     TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).forid = fid;     \
1479     TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).newstate = ns;   \
1480     TRIE_LIST_CUR( state )++;                                   \
1481 } STMT_END
1482
1483 #define TRIE_LIST_NEW(state) STMT_START {                       \
1484     Newxz( trie->states[ state ].trans.list,               \
1485         4, reg_trie_trans_le );                                 \
1486      TRIE_LIST_CUR( state ) = 1;                                \
1487      TRIE_LIST_LEN( state ) = 4;                                \
1488 } STMT_END
1489
1490 #define TRIE_HANDLE_WORD(state) STMT_START {                    \
1491     U16 dupe= trie->states[ state ].wordnum;                    \
1492     regnode * const noper_next = regnext( noper );              \
1493                                                                 \
1494     DEBUG_r({                                                   \
1495         /* store the word for dumping */                        \
1496         SV* tmp;                                                \
1497         if (OP(noper) != NOTHING)                               \
1498             tmp = newSVpvn_utf8(STRING(noper), STR_LEN(noper), UTF);    \
1499         else                                                    \
1500             tmp = newSVpvn_utf8( "", 0, UTF );                  \
1501         av_push( trie_words, tmp );                             \
1502     });                                                         \
1503                                                                 \
1504     curword++;                                                  \
1505     trie->wordinfo[curword].prev   = 0;                         \
1506     trie->wordinfo[curword].len    = wordlen;                   \
1507     trie->wordinfo[curword].accept = state;                     \
1508                                                                 \
1509     if ( noper_next < tail ) {                                  \
1510         if (!trie->jump)                                        \
1511             trie->jump = (U16 *) PerlMemShared_calloc( word_count + 1, sizeof(U16) ); \
1512         trie->jump[curword] = (U16)(noper_next - convert);      \
1513         if (!jumper)                                            \
1514             jumper = noper_next;                                \
1515         if (!nextbranch)                                        \
1516             nextbranch= regnext(cur);                           \
1517     }                                                           \
1518                                                                 \
1519     if ( dupe ) {                                               \
1520         /* It's a dupe. Pre-insert into the wordinfo[].prev   */\
1521         /* chain, so that when the bits of chain are later    */\
1522         /* linked together, the dups appear in the chain      */\
1523         trie->wordinfo[curword].prev = trie->wordinfo[dupe].prev; \
1524         trie->wordinfo[dupe].prev = curword;                    \
1525     } else {                                                    \
1526         /* we haven't inserted this word yet.                */ \
1527         trie->states[ state ].wordnum = curword;                \
1528     }                                                           \
1529 } STMT_END
1530
1531
1532 #define TRIE_TRANS_STATE(state,base,ucharcount,charid,special)          \
1533      ( ( base + charid >=  ucharcount                                   \
1534          && base + charid < ubound                                      \
1535          && state == trie->trans[ base - ucharcount + charid ].check    \
1536          && trie->trans[ base - ucharcount + charid ].next )            \
1537            ? trie->trans[ base - ucharcount + charid ].next             \
1538            : ( state==1 ? special : 0 )                                 \
1539       )
1540
1541 #define MADE_TRIE       1
1542 #define MADE_JUMP_TRIE  2
1543 #define MADE_EXACT_TRIE 4
1544
1545 STATIC I32
1546 S_make_trie(pTHX_ RExC_state_t *pRExC_state, regnode *startbranch, regnode *first, regnode *last, regnode *tail, U32 word_count, U32 flags, U32 depth)
1547 {
1548     dVAR;
1549     /* first pass, loop through and scan words */
1550     reg_trie_data *trie;
1551     HV *widecharmap = NULL;
1552     AV *revcharmap = newAV();
1553     regnode *cur;
1554     const U32 uniflags = UTF8_ALLOW_DEFAULT;
1555     STRLEN len = 0;
1556     UV uvc = 0;
1557     U16 curword = 0;
1558     U32 next_alloc = 0;
1559     regnode *jumper = NULL;
1560     regnode *nextbranch = NULL;
1561     regnode *convert = NULL;
1562     U32 *prev_states; /* temp array mapping each state to previous one */
1563     /* we just use folder as a flag in utf8 */
1564     const U8 * folder = NULL;
1565
1566 #ifdef DEBUGGING
1567     const U32 data_slot = add_data( pRExC_state, 4, "tuuu" );
1568     AV *trie_words = NULL;
1569     /* along with revcharmap, this only used during construction but both are
1570      * useful during debugging so we store them in the struct when debugging.
1571      */
1572 #else
1573     const U32 data_slot = add_data( pRExC_state, 2, "tu" );
1574     STRLEN trie_charcount=0;
1575 #endif
1576     SV *re_trie_maxbuff;
1577     GET_RE_DEBUG_FLAGS_DECL;
1578
1579     PERL_ARGS_ASSERT_MAKE_TRIE;
1580 #ifndef DEBUGGING
1581     PERL_UNUSED_ARG(depth);
1582 #endif
1583
1584     switch (flags) {
1585         case EXACT: break;
1586         case EXACTFA:
1587         case EXACTFU_SS:
1588         case EXACTFU_TRICKYFOLD:
1589         case EXACTFU: folder = PL_fold_latin1; break;
1590         case EXACTF:  folder = PL_fold; break;
1591         case EXACTFL: folder = PL_fold_locale; break;
1592         default: Perl_croak( aTHX_ "panic! In trie construction, unknown node type %u %s", (unsigned) flags, PL_reg_name[flags] );
1593     }
1594
1595     trie = (reg_trie_data *) PerlMemShared_calloc( 1, sizeof(reg_trie_data) );
1596     trie->refcount = 1;
1597     trie->startstate = 1;
1598     trie->wordcount = word_count;
1599     RExC_rxi->data->data[ data_slot ] = (void*)trie;
1600     trie->charmap = (U16 *) PerlMemShared_calloc( 256, sizeof(U16) );
1601     if (flags == EXACT)
1602         trie->bitmap = (char *) PerlMemShared_calloc( ANYOF_BITMAP_SIZE, 1 );
1603     trie->wordinfo = (reg_trie_wordinfo *) PerlMemShared_calloc(
1604                        trie->wordcount+1, sizeof(reg_trie_wordinfo));
1605
1606     DEBUG_r({
1607         trie_words = newAV();
1608     });
1609
1610     re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
1611     if (!SvIOK(re_trie_maxbuff)) {
1612         sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
1613     }
1614     DEBUG_TRIE_COMPILE_r({
1615                 PerlIO_printf( Perl_debug_log,
1616                   "%*smake_trie start==%d, first==%d, last==%d, tail==%d depth=%d\n",
1617                   (int)depth * 2 + 2, "", 
1618                   REG_NODE_NUM(startbranch),REG_NODE_NUM(first), 
1619                   REG_NODE_NUM(last), REG_NODE_NUM(tail),
1620                   (int)depth);
1621     });
1622    
1623    /* Find the node we are going to overwrite */
1624     if ( first == startbranch && OP( last ) != BRANCH ) {
1625         /* whole branch chain */
1626         convert = first;
1627     } else {
1628         /* branch sub-chain */
1629         convert = NEXTOPER( first );
1630     }
1631         
1632     /*  -- First loop and Setup --
1633
1634        We first traverse the branches and scan each word to determine if it
1635        contains widechars, and how many unique chars there are, this is
1636        important as we have to build a table with at least as many columns as we
1637        have unique chars.
1638
1639        We use an array of integers to represent the character codes 0..255
1640        (trie->charmap) and we use a an HV* to store Unicode characters. We use the
1641        native representation of the character value as the key and IV's for the
1642        coded index.
1643
1644        *TODO* If we keep track of how many times each character is used we can
1645        remap the columns so that the table compression later on is more
1646        efficient in terms of memory by ensuring the most common value is in the
1647        middle and the least common are on the outside.  IMO this would be better
1648        than a most to least common mapping as theres a decent chance the most
1649        common letter will share a node with the least common, meaning the node
1650        will not be compressible. With a middle is most common approach the worst
1651        case is when we have the least common nodes twice.
1652
1653      */
1654
1655     for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
1656         regnode *noper = NEXTOPER( cur );
1657         const U8 *uc = (U8*)STRING( noper );
1658         const U8 *e  = uc + STR_LEN( noper );
1659         STRLEN foldlen = 0;
1660         U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
1661         STRLEN skiplen = 0;
1662         const U8 *scan = (U8*)NULL;
1663         U32 wordlen      = 0;         /* required init */
1664         STRLEN chars = 0;
1665         bool set_bit = trie->bitmap ? 1 : 0; /*store the first char in the bitmap?*/
1666
1667         if (OP(noper) == NOTHING) {
1668             regnode *noper_next= regnext(noper);
1669             if (noper_next != tail && OP(noper_next) == flags) {
1670                 noper = noper_next;
1671                 uc= (U8*)STRING(noper);
1672                 e= uc + STR_LEN(noper);
1673                 trie->minlen= STR_LEN(noper);
1674             } else {
1675                 trie->minlen= 0;
1676                 continue;
1677             }
1678         }
1679
1680         if ( set_bit ) { /* bitmap only alloced when !(UTF&&Folding) */
1681             TRIE_BITMAP_SET(trie,*uc); /* store the raw first byte
1682                                           regardless of encoding */
1683             if (OP( noper ) == EXACTFU_SS) {
1684                 /* false positives are ok, so just set this */
1685                 TRIE_BITMAP_SET(trie,0xDF);
1686             }
1687         }
1688         for ( ; uc < e ; uc += len ) {
1689             TRIE_CHARCOUNT(trie)++;
1690             TRIE_READ_CHAR;
1691             chars++;
1692             if ( uvc < 256 ) {
1693                 if ( folder ) {
1694                     U8 folded= folder[ (U8) uvc ];
1695                     if ( !trie->charmap[ folded ] ) {
1696                         trie->charmap[ folded ]=( ++trie->uniquecharcount );
1697                         TRIE_STORE_REVCHAR( folded );
1698                     }
1699                 }
1700                 if ( !trie->charmap[ uvc ] ) {
1701                     trie->charmap[ uvc ]=( ++trie->uniquecharcount );
1702                     TRIE_STORE_REVCHAR( uvc );
1703                 }
1704                 if ( set_bit ) {
1705                     /* store the codepoint in the bitmap, and its folded
1706                      * equivalent. */
1707                     TRIE_BITMAP_SET(trie, uvc);
1708
1709                     /* store the folded codepoint */
1710                     if ( folder ) TRIE_BITMAP_SET(trie, folder[(U8) uvc ]);
1711
1712                     if ( !UTF ) {
1713                         /* store first byte of utf8 representation of
1714                            variant codepoints */
1715                         if (! UNI_IS_INVARIANT(uvc)) {
1716                             TRIE_BITMAP_SET(trie, UTF8_TWO_BYTE_HI(uvc));
1717                         }
1718                     }
1719                     set_bit = 0; /* We've done our bit :-) */
1720                 }
1721             } else {
1722                 SV** svpp;
1723                 if ( !widecharmap )
1724                     widecharmap = newHV();
1725
1726                 svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 1 );
1727
1728                 if ( !svpp )
1729                     Perl_croak( aTHX_ "error creating/fetching widecharmap entry for 0x%"UVXf, uvc );
1730
1731                 if ( !SvTRUE( *svpp ) ) {
1732                     sv_setiv( *svpp, ++trie->uniquecharcount );
1733                     TRIE_STORE_REVCHAR(uvc);
1734                 }
1735             }
1736         }
1737         if( cur == first ) {
1738             trie->minlen = chars;
1739             trie->maxlen = chars;
1740         } else if (chars < trie->minlen) {
1741             trie->minlen = chars;
1742         } else if (chars > trie->maxlen) {
1743             trie->maxlen = chars;
1744         }
1745         if (OP( noper ) == EXACTFU_SS) {
1746             /* XXX: workaround - 'ss' could match "\x{DF}" so minlen could be 1 and not 2*/
1747             if (trie->minlen > 1)
1748                 trie->minlen= 1;
1749         }
1750         if (OP( noper ) == EXACTFU_TRICKYFOLD) {
1751             /* XXX: workround - things like "\x{1FBE}\x{0308}\x{0301}" can match "\x{0390}" 
1752              *                - We assume that any such sequence might match a 2 byte string */
1753             if (trie->minlen > 2 )
1754                 trie->minlen= 2;
1755         }
1756
1757     } /* end first pass */
1758     DEBUG_TRIE_COMPILE_r(
1759         PerlIO_printf( Perl_debug_log, "%*sTRIE(%s): W:%d C:%d Uq:%d Min:%d Max:%d\n",
1760                 (int)depth * 2 + 2,"",
1761                 ( widecharmap ? "UTF8" : "NATIVE" ), (int)word_count,
1762                 (int)TRIE_CHARCOUNT(trie), trie->uniquecharcount,
1763                 (int)trie->minlen, (int)trie->maxlen )
1764     );
1765
1766     /*
1767         We now know what we are dealing with in terms of unique chars and
1768         string sizes so we can calculate how much memory a naive
1769         representation using a flat table  will take. If it's over a reasonable
1770         limit (as specified by ${^RE_TRIE_MAXBUF}) we use a more memory
1771         conservative but potentially much slower representation using an array
1772         of lists.
1773
1774         At the end we convert both representations into the same compressed
1775         form that will be used in regexec.c for matching with. The latter
1776         is a form that cannot be used to construct with but has memory
1777         properties similar to the list form and access properties similar
1778         to the table form making it both suitable for fast searches and
1779         small enough that its feasable to store for the duration of a program.
1780
1781         See the comment in the code where the compressed table is produced
1782         inplace from the flat tabe representation for an explanation of how
1783         the compression works.
1784
1785     */
1786
1787
1788     Newx(prev_states, TRIE_CHARCOUNT(trie) + 2, U32);
1789     prev_states[1] = 0;
1790
1791     if ( (IV)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1) > SvIV(re_trie_maxbuff) ) {
1792         /*
1793             Second Pass -- Array Of Lists Representation
1794
1795             Each state will be represented by a list of charid:state records
1796             (reg_trie_trans_le) the first such element holds the CUR and LEN
1797             points of the allocated array. (See defines above).
1798
1799             We build the initial structure using the lists, and then convert
1800             it into the compressed table form which allows faster lookups
1801             (but cant be modified once converted).
1802         */
1803
1804         STRLEN transcount = 1;
1805
1806         DEBUG_TRIE_COMPILE_MORE_r( PerlIO_printf( Perl_debug_log, 
1807             "%*sCompiling trie using list compiler\n",
1808             (int)depth * 2 + 2, ""));
1809
1810         trie->states = (reg_trie_state *)
1811             PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
1812                                   sizeof(reg_trie_state) );
1813         TRIE_LIST_NEW(1);
1814         next_alloc = 2;
1815
1816         for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
1817
1818             regnode *noper   = NEXTOPER( cur );
1819             U8 *uc           = (U8*)STRING( noper );
1820             const U8 *e      = uc + STR_LEN( noper );
1821             U32 state        = 1;         /* required init */
1822             U16 charid       = 0;         /* sanity init */
1823             U8 *scan         = (U8*)NULL; /* sanity init */
1824             STRLEN foldlen   = 0;         /* required init */
1825             U32 wordlen      = 0;         /* required init */
1826             U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
1827             STRLEN skiplen   = 0;
1828
1829             if (OP(noper) == NOTHING) {
1830                 regnode *noper_next= regnext(noper);
1831                 if (noper_next != tail && OP(noper_next) == flags) {
1832                     noper = noper_next;
1833                     uc= (U8*)STRING(noper);
1834                     e= uc + STR_LEN(noper);
1835                 }
1836             }
1837
1838             if (OP(noper) != NOTHING) {
1839                 for ( ; uc < e ; uc += len ) {
1840
1841                     TRIE_READ_CHAR;
1842
1843                     if ( uvc < 256 ) {
1844                         charid = trie->charmap[ uvc ];
1845                     } else {
1846                         SV** const svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 0);
1847                         if ( !svpp ) {
1848                             charid = 0;
1849                         } else {
1850                             charid=(U16)SvIV( *svpp );
1851                         }
1852                     }
1853                     /* charid is now 0 if we dont know the char read, or nonzero if we do */
1854                     if ( charid ) {
1855
1856                         U16 check;
1857                         U32 newstate = 0;
1858
1859                         charid--;
1860                         if ( !trie->states[ state ].trans.list ) {
1861                             TRIE_LIST_NEW( state );
1862                         }
1863                         for ( check = 1; check <= TRIE_LIST_USED( state ); check++ ) {
1864                             if ( TRIE_LIST_ITEM( state, check ).forid == charid ) {
1865                                 newstate = TRIE_LIST_ITEM( state, check ).newstate;
1866                                 break;
1867                             }
1868                         }
1869                         if ( ! newstate ) {
1870                             newstate = next_alloc++;
1871                             prev_states[newstate] = state;
1872                             TRIE_LIST_PUSH( state, charid, newstate );
1873                             transcount++;
1874                         }
1875                         state = newstate;
1876                     } else {
1877                         Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %"IVdf, uvc );
1878                     }
1879                 }
1880             }
1881             TRIE_HANDLE_WORD(state);
1882
1883         } /* end second pass */
1884
1885         /* next alloc is the NEXT state to be allocated */
1886         trie->statecount = next_alloc; 
1887         trie->states = (reg_trie_state *)
1888             PerlMemShared_realloc( trie->states,
1889                                    next_alloc
1890                                    * sizeof(reg_trie_state) );
1891
1892         /* and now dump it out before we compress it */
1893         DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_list(trie, widecharmap,
1894                                                          revcharmap, next_alloc,
1895                                                          depth+1)
1896         );
1897
1898         trie->trans = (reg_trie_trans *)
1899             PerlMemShared_calloc( transcount, sizeof(reg_trie_trans) );
1900         {
1901             U32 state;
1902             U32 tp = 0;
1903             U32 zp = 0;
1904
1905
1906             for( state=1 ; state < next_alloc ; state ++ ) {
1907                 U32 base=0;
1908
1909                 /*
1910                 DEBUG_TRIE_COMPILE_MORE_r(
1911                     PerlIO_printf( Perl_debug_log, "tp: %d zp: %d ",tp,zp)
1912                 );
1913                 */
1914
1915                 if (trie->states[state].trans.list) {
1916                     U16 minid=TRIE_LIST_ITEM( state, 1).forid;
1917                     U16 maxid=minid;
1918                     U16 idx;
1919
1920                     for( idx = 2 ; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
1921                         const U16 forid = TRIE_LIST_ITEM( state, idx).forid;
1922                         if ( forid < minid ) {
1923                             minid=forid;
1924                         } else if ( forid > maxid ) {
1925                             maxid=forid;
1926                         }
1927                     }
1928                     if ( transcount < tp + maxid - minid + 1) {
1929                         transcount *= 2;
1930                         trie->trans = (reg_trie_trans *)
1931                             PerlMemShared_realloc( trie->trans,
1932                                                      transcount
1933                                                      * sizeof(reg_trie_trans) );
1934                         Zero( trie->trans + (transcount / 2), transcount / 2 , reg_trie_trans );
1935                     }
1936                     base = trie->uniquecharcount + tp - minid;
1937                     if ( maxid == minid ) {
1938                         U32 set = 0;
1939                         for ( ; zp < tp ; zp++ ) {
1940                             if ( ! trie->trans[ zp ].next ) {
1941                                 base = trie->uniquecharcount + zp - minid;
1942                                 trie->trans[ zp ].next = TRIE_LIST_ITEM( state, 1).newstate;
1943                                 trie->trans[ zp ].check = state;
1944                                 set = 1;
1945                                 break;
1946                             }
1947                         }
1948                         if ( !set ) {
1949                             trie->trans[ tp ].next = TRIE_LIST_ITEM( state, 1).newstate;
1950                             trie->trans[ tp ].check = state;
1951                             tp++;
1952                             zp = tp;
1953                         }
1954                     } else {
1955                         for ( idx=1; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
1956                             const U32 tid = base -  trie->uniquecharcount + TRIE_LIST_ITEM( state, idx ).forid;
1957                             trie->trans[ tid ].next = TRIE_LIST_ITEM( state, idx ).newstate;
1958                             trie->trans[ tid ].check = state;
1959                         }
1960                         tp += ( maxid - minid + 1 );
1961                     }
1962                     Safefree(trie->states[ state ].trans.list);
1963                 }
1964                 /*
1965                 DEBUG_TRIE_COMPILE_MORE_r(
1966                     PerlIO_printf( Perl_debug_log, " base: %d\n",base);
1967                 );
1968                 */
1969                 trie->states[ state ].trans.base=base;
1970             }
1971             trie->lasttrans = tp + 1;
1972         }
1973     } else {
1974         /*
1975            Second Pass -- Flat Table Representation.
1976
1977            we dont use the 0 slot of either trans[] or states[] so we add 1 to each.
1978            We know that we will need Charcount+1 trans at most to store the data
1979            (one row per char at worst case) So we preallocate both structures
1980            assuming worst case.
1981
1982            We then construct the trie using only the .next slots of the entry
1983            structs.
1984
1985            We use the .check field of the first entry of the node temporarily to
1986            make compression both faster and easier by keeping track of how many non
1987            zero fields are in the node.
1988
1989            Since trans are numbered from 1 any 0 pointer in the table is a FAIL
1990            transition.
1991
1992            There are two terms at use here: state as a TRIE_NODEIDX() which is a
1993            number representing the first entry of the node, and state as a
1994            TRIE_NODENUM() which is the trans number. state 1 is TRIE_NODEIDX(1) and
1995            TRIE_NODENUM(1), state 2 is TRIE_NODEIDX(2) and TRIE_NODENUM(3) if there
1996            are 2 entrys per node. eg:
1997
1998              A B       A B
1999           1. 2 4    1. 3 7
2000           2. 0 3    3. 0 5
2001           3. 0 0    5. 0 0
2002           4. 0 0    7. 0 0
2003
2004            The table is internally in the right hand, idx form. However as we also
2005            have to deal with the states array which is indexed by nodenum we have to
2006            use TRIE_NODENUM() to convert.
2007
2008         */
2009         DEBUG_TRIE_COMPILE_MORE_r( PerlIO_printf( Perl_debug_log, 
2010             "%*sCompiling trie using table compiler\n",
2011             (int)depth * 2 + 2, ""));
2012
2013         trie->trans = (reg_trie_trans *)
2014             PerlMemShared_calloc( ( TRIE_CHARCOUNT(trie) + 1 )
2015                                   * trie->uniquecharcount + 1,
2016                                   sizeof(reg_trie_trans) );
2017         trie->states = (reg_trie_state *)
2018             PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
2019                                   sizeof(reg_trie_state) );
2020         next_alloc = trie->uniquecharcount + 1;
2021
2022
2023         for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
2024
2025             regnode *noper   = NEXTOPER( cur );
2026             const U8 *uc     = (U8*)STRING( noper );
2027             const U8 *e      = uc + STR_LEN( noper );
2028
2029             U32 state        = 1;         /* required init */
2030
2031             U16 charid       = 0;         /* sanity init */
2032             U32 accept_state = 0;         /* sanity init */
2033             U8 *scan         = (U8*)NULL; /* sanity init */
2034
2035             STRLEN foldlen   = 0;         /* required init */
2036             U32 wordlen      = 0;         /* required init */
2037             STRLEN skiplen   = 0;
2038             U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
2039
2040             if (OP(noper) == NOTHING) {
2041                 regnode *noper_next= regnext(noper);
2042                 if (noper_next != tail && OP(noper_next) == flags) {
2043                     noper = noper_next;
2044                     uc= (U8*)STRING(noper);
2045                     e= uc + STR_LEN(noper);
2046                 }
2047             }
2048
2049             if ( OP(noper) != NOTHING ) {
2050                 for ( ; uc < e ; uc += len ) {
2051
2052                     TRIE_READ_CHAR;
2053
2054                     if ( uvc < 256 ) {
2055                         charid = trie->charmap[ uvc ];
2056                     } else {
2057                         SV* const * const svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 0);
2058                         charid = svpp ? (U16)SvIV(*svpp) : 0;
2059                     }
2060                     if ( charid ) {
2061                         charid--;
2062                         if ( !trie->trans[ state + charid ].next ) {
2063                             trie->trans[ state + charid ].next = next_alloc;
2064                             trie->trans[ state ].check++;
2065                             prev_states[TRIE_NODENUM(next_alloc)]
2066                                     = TRIE_NODENUM(state);
2067                             next_alloc += trie->uniquecharcount;
2068                         }
2069                         state = trie->trans[ state + charid ].next;
2070                     } else {
2071                         Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %"IVdf, uvc );
2072                     }
2073                     /* charid is now 0 if we dont know the char read, or nonzero if we do */
2074                 }
2075             }
2076             accept_state = TRIE_NODENUM( state );
2077             TRIE_HANDLE_WORD(accept_state);
2078
2079         } /* end second pass */
2080
2081         /* and now dump it out before we compress it */
2082         DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_table(trie, widecharmap,
2083                                                           revcharmap,
2084                                                           next_alloc, depth+1));
2085
2086         {
2087         /*
2088            * Inplace compress the table.*
2089
2090            For sparse data sets the table constructed by the trie algorithm will
2091            be mostly 0/FAIL transitions or to put it another way mostly empty.
2092            (Note that leaf nodes will not contain any transitions.)
2093
2094            This algorithm compresses the tables by eliminating most such
2095            transitions, at the cost of a modest bit of extra work during lookup:
2096
2097            - Each states[] entry contains a .base field which indicates the
2098            index in the state[] array wheres its transition data is stored.
2099
2100            - If .base is 0 there are no valid transitions from that node.
2101
2102            - If .base is nonzero then charid is added to it to find an entry in
2103            the trans array.
2104
2105            -If trans[states[state].base+charid].check!=state then the
2106            transition is taken to be a 0/Fail transition. Thus if there are fail
2107            transitions at the front of the node then the .base offset will point
2108            somewhere inside the previous nodes data (or maybe even into a node
2109            even earlier), but the .check field determines if the transition is
2110            valid.
2111
2112            XXX - wrong maybe?
2113            The following process inplace converts the table to the compressed
2114            table: We first do not compress the root node 1,and mark all its
2115            .check pointers as 1 and set its .base pointer as 1 as well. This
2116            allows us to do a DFA construction from the compressed table later,
2117            and ensures that any .base pointers we calculate later are greater
2118            than 0.
2119
2120            - We set 'pos' to indicate the first entry of the second node.
2121
2122            - We then iterate over the columns of the node, finding the first and
2123            last used entry at l and m. We then copy l..m into pos..(pos+m-l),
2124            and set the .check pointers accordingly, and advance pos
2125            appropriately and repreat for the next node. Note that when we copy
2126            the next pointers we have to convert them from the original
2127            NODEIDX form to NODENUM form as the former is not valid post
2128            compression.
2129
2130            - If a node has no transitions used we mark its base as 0 and do not
2131            advance the pos pointer.
2132
2133            - If a node only has one transition we use a second pointer into the
2134            structure to fill in allocated fail transitions from other states.
2135            This pointer is independent of the main pointer and scans forward
2136            looking for null transitions that are allocated to a state. When it
2137            finds one it writes the single transition into the "hole".  If the
2138            pointer doesnt find one the single transition is appended as normal.
2139
2140            - Once compressed we can Renew/realloc the structures to release the
2141            excess space.
2142
2143            See "Table-Compression Methods" in sec 3.9 of the Red Dragon,
2144            specifically Fig 3.47 and the associated pseudocode.
2145
2146            demq
2147         */
2148         const U32 laststate = TRIE_NODENUM( next_alloc );
2149         U32 state, charid;
2150         U32 pos = 0, zp=0;
2151         trie->statecount = laststate;
2152
2153         for ( state = 1 ; state < laststate ; state++ ) {
2154             U8 flag = 0;
2155             const U32 stateidx = TRIE_NODEIDX( state );
2156             const U32 o_used = trie->trans[ stateidx ].check;
2157             U32 used = trie->trans[ stateidx ].check;
2158             trie->trans[ stateidx ].check = 0;
2159
2160             for ( charid = 0 ; used && charid < trie->uniquecharcount ; charid++ ) {
2161                 if ( flag || trie->trans[ stateidx + charid ].next ) {
2162                     if ( trie->trans[ stateidx + charid ].next ) {
2163                         if (o_used == 1) {
2164                             for ( ; zp < pos ; zp++ ) {
2165                                 if ( ! trie->trans[ zp ].next ) {
2166                                     break;
2167                                 }
2168                             }
2169                             trie->states[ state ].trans.base = zp + trie->uniquecharcount - charid ;
2170                             trie->trans[ zp ].next = SAFE_TRIE_NODENUM( trie->trans[ stateidx + charid ].next );
2171                             trie->trans[ zp ].check = state;
2172                             if ( ++zp > pos ) pos = zp;
2173                             break;
2174                         }
2175                         used--;
2176                     }
2177                     if ( !flag ) {
2178                         flag = 1;
2179                         trie->states[ state ].trans.base = pos + trie->uniquecharcount - charid ;
2180                     }
2181                     trie->trans[ pos ].next = SAFE_TRIE_NODENUM( trie->trans[ stateidx + charid ].next );
2182                     trie->trans[ pos ].check = state;
2183                     pos++;
2184                 }
2185             }
2186         }
2187         trie->lasttrans = pos + 1;
2188         trie->states = (reg_trie_state *)
2189             PerlMemShared_realloc( trie->states, laststate
2190                                    * sizeof(reg_trie_state) );
2191         DEBUG_TRIE_COMPILE_MORE_r(
2192                 PerlIO_printf( Perl_debug_log,
2193                     "%*sAlloc: %d Orig: %"IVdf" elements, Final:%"IVdf". Savings of %%%5.2f\n",
2194                     (int)depth * 2 + 2,"",
2195                     (int)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1 ),
2196                     (IV)next_alloc,
2197                     (IV)pos,
2198                     ( ( next_alloc - pos ) * 100 ) / (double)next_alloc );
2199             );
2200
2201         } /* end table compress */
2202     }
2203     DEBUG_TRIE_COMPILE_MORE_r(
2204             PerlIO_printf(Perl_debug_log, "%*sStatecount:%"UVxf" Lasttrans:%"UVxf"\n",
2205                 (int)depth * 2 + 2, "",
2206                 (UV)trie->statecount,
2207                 (UV)trie->lasttrans)
2208     );
2209     /* resize the trans array to remove unused space */
2210     trie->trans = (reg_trie_trans *)
2211         PerlMemShared_realloc( trie->trans, trie->lasttrans
2212                                * sizeof(reg_trie_trans) );
2213
2214     {   /* Modify the program and insert the new TRIE node */ 
2215         U8 nodetype =(U8)(flags & 0xFF);
2216         char *str=NULL;
2217         
2218 #ifdef DEBUGGING
2219         regnode *optimize = NULL;
2220 #ifdef RE_TRACK_PATTERN_OFFSETS
2221
2222         U32 mjd_offset = 0;
2223         U32 mjd_nodelen = 0;
2224 #endif /* RE_TRACK_PATTERN_OFFSETS */
2225 #endif /* DEBUGGING */
2226         /*
2227            This means we convert either the first branch or the first Exact,
2228            depending on whether the thing following (in 'last') is a branch
2229            or not and whther first is the startbranch (ie is it a sub part of
2230            the alternation or is it the whole thing.)
2231            Assuming its a sub part we convert the EXACT otherwise we convert
2232            the whole branch sequence, including the first.
2233          */
2234         /* Find the node we are going to overwrite */
2235         if ( first != startbranch || OP( last ) == BRANCH ) {
2236             /* branch sub-chain */
2237             NEXT_OFF( first ) = (U16)(last - first);
2238 #ifdef RE_TRACK_PATTERN_OFFSETS
2239             DEBUG_r({
2240                 mjd_offset= Node_Offset((convert));
2241                 mjd_nodelen= Node_Length((convert));
2242             });
2243 #endif
2244             /* whole branch chain */
2245         }
2246 #ifdef RE_TRACK_PATTERN_OFFSETS
2247         else {
2248             DEBUG_r({
2249                 const  regnode *nop = NEXTOPER( convert );
2250                 mjd_offset= Node_Offset((nop));
2251                 mjd_nodelen= Node_Length((nop));
2252             });
2253         }
2254         DEBUG_OPTIMISE_r(
2255             PerlIO_printf(Perl_debug_log, "%*sMJD offset:%"UVuf" MJD length:%"UVuf"\n",
2256                 (int)depth * 2 + 2, "",
2257                 (UV)mjd_offset, (UV)mjd_nodelen)
2258         );
2259 #endif
2260         /* But first we check to see if there is a common prefix we can 
2261            split out as an EXACT and put in front of the TRIE node.  */
2262         trie->startstate= 1;
2263         if ( trie->bitmap && !widecharmap && !trie->jump  ) {
2264             U32 state;
2265             for ( state = 1 ; state < trie->statecount-1 ; state++ ) {
2266                 U32 ofs = 0;
2267                 I32 idx = -1;
2268                 U32 count = 0;
2269                 const U32 base = trie->states[ state ].trans.base;
2270
2271                 if ( trie->states[state].wordnum )
2272                         count = 1;
2273
2274                 for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
2275                     if ( ( base + ofs >= trie->uniquecharcount ) &&
2276                          ( base + ofs - trie->uniquecharcount < trie->lasttrans ) &&
2277                          trie->trans[ base + ofs - trie->uniquecharcount ].check == state )
2278                     {
2279                         if ( ++count > 1 ) {
2280                             SV **tmp = av_fetch( revcharmap, ofs, 0);
2281                             const U8 *ch = (U8*)SvPV_nolen_const( *tmp );
2282                             if ( state == 1 ) break;
2283                             if ( count == 2 ) {
2284                                 Zero(trie->bitmap, ANYOF_BITMAP_SIZE, char);
2285                                 DEBUG_OPTIMISE_r(
2286                                     PerlIO_printf(Perl_debug_log,
2287                                         "%*sNew Start State=%"UVuf" Class: [",
2288                                         (int)depth * 2 + 2, "",
2289                                         (UV)state));
2290                                 if (idx >= 0) {
2291                                     SV ** const tmp = av_fetch( revcharmap, idx, 0);
2292                                     const U8 * const ch = (U8*)SvPV_nolen_const( *tmp );
2293
2294                                     TRIE_BITMAP_SET(trie,*ch);
2295                                     if ( folder )
2296                                         TRIE_BITMAP_SET(trie, folder[ *ch ]);
2297                                     DEBUG_OPTIMISE_r(
2298                                         PerlIO_printf(Perl_debug_log, "%s", (char*)ch)
2299                                     );
2300                                 }
2301                             }
2302                             TRIE_BITMAP_SET(trie,*ch);
2303                             if ( folder )
2304                                 TRIE_BITMAP_SET(trie,folder[ *ch ]);
2305                             DEBUG_OPTIMISE_r(PerlIO_printf( Perl_debug_log,"%s", ch));
2306                         }
2307                         idx = ofs;
2308                     }
2309                 }
2310                 if ( count == 1 ) {
2311                     SV **tmp = av_fetch( revcharmap, idx, 0);
2312                     STRLEN len;
2313                     char *ch = SvPV( *tmp, len );
2314                     DEBUG_OPTIMISE_r({
2315                         SV *sv=sv_newmortal();
2316                         PerlIO_printf( Perl_debug_log,
2317                             "%*sPrefix State: %"UVuf" Idx:%"UVuf" Char='%s'\n",
2318                             (int)depth * 2 + 2, "",
2319                             (UV)state, (UV)idx, 
2320                             pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), 6, 
2321                                 PL_colors[0], PL_colors[1],
2322                                 (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
2323                                 PERL_PV_ESCAPE_FIRSTCHAR 
2324                             )
2325                         );
2326                     });
2327                     if ( state==1 ) {
2328                         OP( convert ) = nodetype;
2329                         str=STRING(convert);
2330                         STR_LEN(convert)=0;
2331                     }
2332                     STR_LEN(convert) += len;
2333                     while (len--)
2334                         *str++ = *ch++;
2335                 } else {
2336 #ifdef DEBUGGING            
2337                     if (state>1)
2338                         DEBUG_OPTIMISE_r(PerlIO_printf( Perl_debug_log,"]\n"));
2339 #endif
2340                     break;
2341                 }
2342             }
2343             trie->prefixlen = (state-1);
2344             if (str) {
2345                 regnode *n = convert+NODE_SZ_STR(convert);
2346                 NEXT_OFF(convert) = NODE_SZ_STR(convert);
2347                 trie->startstate = state;
2348                 trie->minlen -= (state - 1);
2349                 trie->maxlen -= (state - 1);
2350 #ifdef DEBUGGING
2351                /* At least the UNICOS C compiler choked on this
2352                 * being argument to DEBUG_r(), so let's just have
2353                 * it right here. */
2354                if (
2355 #ifdef PERL_EXT_RE_BUILD
2356                    1
2357 #else
2358                    DEBUG_r_TEST
2359 #endif
2360                    ) {
2361                    regnode *fix = convert;
2362                    U32 word = trie->wordcount;
2363                    mjd_nodelen++;
2364                    Set_Node_Offset_Length(convert, mjd_offset, state - 1);
2365                    while( ++fix < n ) {
2366                        Set_Node_Offset_Length(fix, 0, 0);
2367                    }
2368                    while (word--) {
2369                        SV ** const tmp = av_fetch( trie_words, word, 0 );
2370                        if (tmp) {
2371                            if ( STR_LEN(convert) <= SvCUR(*tmp) )
2372                                sv_chop(*tmp, SvPV_nolen(*tmp) + STR_LEN(convert));
2373                            else
2374                                sv_chop(*tmp, SvPV_nolen(*tmp) + SvCUR(*tmp));
2375                        }
2376                    }
2377                }
2378 #endif
2379                 if (trie->maxlen) {
2380                     convert = n;
2381                 } else {
2382                     NEXT_OFF(convert) = (U16)(tail - convert);
2383                     DEBUG_r(optimize= n);
2384                 }
2385             }
2386         }
2387         if (!jumper) 
2388             jumper = last; 
2389         if ( trie->maxlen ) {
2390             NEXT_OFF( convert ) = (U16)(tail - convert);
2391             ARG_SET( convert, data_slot );
2392             /* Store the offset to the first unabsorbed branch in 
2393                jump[0], which is otherwise unused by the jump logic. 
2394                We use this when dumping a trie and during optimisation. */
2395             if (trie->jump) 
2396                 trie->jump[0] = (U16)(nextbranch - convert);
2397             
2398             /* If the start state is not accepting (meaning there is no empty string/NOTHING)
2399              *   and there is a bitmap
2400              *   and the first "jump target" node we found leaves enough room
2401              * then convert the TRIE node into a TRIEC node, with the bitmap
2402              * embedded inline in the opcode - this is hypothetically faster.
2403              */
2404             if ( !trie->states[trie->startstate].wordnum
2405                  && trie->bitmap
2406                  && ( (char *)jumper - (char *)convert) >= (int)sizeof(struct regnode_charclass) )
2407             {
2408                 OP( convert ) = TRIEC;
2409                 Copy(trie->bitmap, ((struct regnode_charclass *)convert)->bitmap, ANYOF_BITMAP_SIZE, char);
2410                 PerlMemShared_free(trie->bitmap);
2411                 trie->bitmap= NULL;
2412             } else 
2413                 OP( convert ) = TRIE;
2414
2415             /* store the type in the flags */
2416             convert->flags = nodetype;
2417             DEBUG_r({
2418             optimize = convert 
2419                       + NODE_STEP_REGNODE 
2420                       + regarglen[ OP( convert ) ];
2421             });
2422             /* XXX We really should free up the resource in trie now, 
2423                    as we won't use them - (which resources?) dmq */
2424         }
2425         /* needed for dumping*/
2426         DEBUG_r(if (optimize) {
2427             regnode *opt = convert;
2428
2429             while ( ++opt < optimize) {
2430                 Set_Node_Offset_Length(opt,0,0);
2431             }
2432             /* 
2433                 Try to clean up some of the debris left after the 
2434                 optimisation.
2435              */
2436             while( optimize < jumper ) {
2437                 mjd_nodelen += Node_Length((optimize));
2438                 OP( optimize ) = OPTIMIZED;
2439                 Set_Node_Offset_Length(optimize,0,0);
2440                 optimize++;
2441             }
2442             Set_Node_Offset_Length(convert,mjd_offset,mjd_nodelen);
2443         });
2444     } /* end node insert */
2445
2446     /*  Finish populating the prev field of the wordinfo array.  Walk back
2447      *  from each accept state until we find another accept state, and if
2448      *  so, point the first word's .prev field at the second word. If the
2449      *  second already has a .prev field set, stop now. This will be the
2450      *  case either if we've already processed that word's accept state,
2451      *  or that state had multiple words, and the overspill words were
2452      *  already linked up earlier.
2453      */
2454     {
2455         U16 word;
2456         U32 state;
2457         U16 prev;
2458
2459         for (word=1; word <= trie->wordcount; word++) {
2460             prev = 0;
2461             if (trie->wordinfo[word].prev)
2462                 continue;
2463             state = trie->wordinfo[word].accept;
2464             while (state) {
2465                 state = prev_states[state];
2466                 if (!state)
2467                     break;
2468                 prev = trie->states[state].wordnum;
2469                 if (prev)
2470                     break;
2471             }
2472             trie->wordinfo[word].prev = prev;
2473         }
2474         Safefree(prev_states);
2475     }
2476
2477
2478     /* and now dump out the compressed format */
2479     DEBUG_TRIE_COMPILE_r(dump_trie(trie, widecharmap, revcharmap, depth+1));
2480
2481     RExC_rxi->data->data[ data_slot + 1 ] = (void*)widecharmap;
2482 #ifdef DEBUGGING
2483     RExC_rxi->data->data[ data_slot + TRIE_WORDS_OFFSET ] = (void*)trie_words;
2484     RExC_rxi->data->data[ data_slot + 3 ] = (void*)revcharmap;
2485 #else
2486     SvREFCNT_dec_NN(revcharmap);
2487 #endif
2488     return trie->jump 
2489            ? MADE_JUMP_TRIE 
2490            : trie->startstate>1 
2491              ? MADE_EXACT_TRIE 
2492              : MADE_TRIE;
2493 }
2494
2495 STATIC void
2496 S_make_trie_failtable(pTHX_ RExC_state_t *pRExC_state, regnode *source,  regnode *stclass, U32 depth)
2497 {
2498 /* The Trie is constructed and compressed now so we can build a fail array if it's needed
2499
2500    This is basically the Aho-Corasick algorithm. Its from exercise 3.31 and 3.32 in the
2501    "Red Dragon" -- Compilers, principles, techniques, and tools. Aho, Sethi, Ullman 1985/88
2502    ISBN 0-201-10088-6
2503
2504    We find the fail state for each state in the trie, this state is the longest proper
2505    suffix of the current state's 'word' that is also a proper prefix of another word in our
2506    trie. State 1 represents the word '' and is thus the default fail state. This allows
2507    the DFA not to have to restart after its tried and failed a word at a given point, it
2508    simply continues as though it had been matching the other word in the first place.
2509    Consider
2510       'abcdgu'=~/abcdefg|cdgu/
2511    When we get to 'd' we are still matching the first word, we would encounter 'g' which would
2512    fail, which would bring us to the state representing 'd' in the second word where we would
2513    try 'g' and succeed, proceeding to match 'cdgu'.
2514  */
2515  /* add a fail transition */
2516     const U32 trie_offset = ARG(source);
2517     reg_trie_data *trie=(reg_trie_data *)RExC_rxi->data->data[trie_offset];
2518     U32 *q;
2519     const U32 ucharcount = trie->uniquecharcount;
2520     const U32 numstates = trie->statecount;
2521     const U32 ubound = trie->lasttrans + ucharcount;
2522     U32 q_read = 0;
2523     U32 q_write = 0;
2524     U32 charid;
2525     U32 base = trie->states[ 1 ].trans.base;
2526     U32 *fail;
2527     reg_ac_data *aho;
2528     const U32 data_slot = add_data( pRExC_state, 1, "T" );
2529     GET_RE_DEBUG_FLAGS_DECL;
2530
2531     PERL_ARGS_ASSERT_MAKE_TRIE_FAILTABLE;
2532 #ifndef DEBUGGING
2533     PERL_UNUSED_ARG(depth);
2534 #endif
2535
2536
2537     ARG_SET( stclass, data_slot );
2538     aho = (reg_ac_data *) PerlMemShared_calloc( 1, sizeof(reg_ac_data) );
2539     RExC_rxi->data->data[ data_slot ] = (void*)aho;
2540     aho->trie=trie_offset;
2541     aho->states=(reg_trie_state *)PerlMemShared_malloc( numstates * sizeof(reg_trie_state) );
2542     Copy( trie->states, aho->states, numstates, reg_trie_state );
2543     Newxz( q, numstates, U32);
2544     aho->fail = (U32 *) PerlMemShared_calloc( numstates, sizeof(U32) );
2545     aho->refcount = 1;
2546     fail = aho->fail;
2547     /* initialize fail[0..1] to be 1 so that we always have
2548        a valid final fail state */
2549     fail[ 0 ] = fail[ 1 ] = 1;
2550
2551     for ( charid = 0; charid < ucharcount ; charid++ ) {
2552         const U32 newstate = TRIE_TRANS_STATE( 1, base, ucharcount, charid, 0 );
2553         if ( newstate ) {
2554             q[ q_write ] = newstate;
2555             /* set to point at the root */
2556             fail[ q[ q_write++ ] ]=1;
2557         }
2558     }
2559     while ( q_read < q_write) {
2560         const U32 cur = q[ q_read++ % numstates ];
2561         base = trie->states[ cur ].trans.base;
2562
2563         for ( charid = 0 ; charid < ucharcount ; charid++ ) {
2564             const U32 ch_state = TRIE_TRANS_STATE( cur, base, ucharcount, charid, 1 );
2565             if (ch_state) {
2566                 U32 fail_state = cur;
2567                 U32 fail_base;
2568                 do {
2569                     fail_state = fail[ fail_state ];
2570                     fail_base = aho->states[ fail_state ].trans.base;
2571                 } while ( !TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 ) );
2572
2573                 fail_state = TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 );
2574                 fail[ ch_state ] = fail_state;
2575                 if ( !aho->states[ ch_state ].wordnum && aho->states[ fail_state ].wordnum )
2576                 {
2577                         aho->states[ ch_state ].wordnum =  aho->states[ fail_state ].wordnum;
2578                 }
2579                 q[ q_write++ % numstates] = ch_state;
2580             }
2581         }
2582     }
2583     /* restore fail[0..1] to 0 so that we "fall out" of the AC loop
2584        when we fail in state 1, this allows us to use the
2585        charclass scan to find a valid start char. This is based on the principle
2586        that theres a good chance the string being searched contains lots of stuff
2587        that cant be a start char.
2588      */
2589     fail[ 0 ] = fail[ 1 ] = 0;
2590     DEBUG_TRIE_COMPILE_r({
2591         PerlIO_printf(Perl_debug_log,
2592                       "%*sStclass Failtable (%"UVuf" states): 0", 
2593                       (int)(depth * 2), "", (UV)numstates
2594         );
2595         for( q_read=1; q_read<numstates; q_read++ ) {
2596             PerlIO_printf(Perl_debug_log, ", %"UVuf, (UV)fail[q_read]);
2597         }
2598         PerlIO_printf(Perl_debug_log, "\n");
2599     });
2600     Safefree(q);
2601     /*RExC_seen |= REG_SEEN_TRIEDFA;*/
2602 }
2603
2604
2605 /*
2606  * There are strange code-generation bugs caused on sparc64 by gcc-2.95.2.
2607  * These need to be revisited when a newer toolchain becomes available.
2608  */
2609 #if defined(__sparc64__) && defined(__GNUC__)
2610 #   if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 96)
2611 #       undef  SPARC64_GCC_WORKAROUND
2612 #       define SPARC64_GCC_WORKAROUND 1
2613 #   endif
2614 #endif
2615
2616 #define DEBUG_PEEP(str,scan,depth) \
2617     DEBUG_OPTIMISE_r({if (scan){ \
2618        SV * const mysv=sv_newmortal(); \
2619        regnode *Next = regnext(scan); \
2620        regprop(RExC_rx, mysv, scan); \
2621        PerlIO_printf(Perl_debug_log, "%*s" str ">%3d: %s (%d)\n", \
2622        (int)depth*2, "", REG_NODE_NUM(scan), SvPV_nolen_const(mysv),\
2623        Next ? (REG_NODE_NUM(Next)) : 0 ); \
2624    }});
2625
2626
2627 /* The below joins as many adjacent EXACTish nodes as possible into a single
2628  * one.  The regop may be changed if the node(s) contain certain sequences that
2629  * require special handling.  The joining is only done if:
2630  * 1) there is room in the current conglomerated node to entirely contain the
2631  *    next one.
2632  * 2) they are the exact same node type
2633  *
2634  * The adjacent nodes actually may be separated by NOTHING-kind nodes, and
2635  * these get optimized out
2636  *
2637  * If a node is to match under /i (folded), the number of characters it matches
2638  * can be different than its character length if it contains a multi-character
2639  * fold.  *min_subtract is set to the total delta of the input nodes.
2640  *
2641  * And *has_exactf_sharp_s is set to indicate whether or not the node is EXACTF
2642  * and contains LATIN SMALL LETTER SHARP S
2643  *
2644  * This is as good a place as any to discuss the design of handling these
2645  * multi-character fold sequences.  It's been wrong in Perl for a very long
2646  * time.  There are three code points in Unicode whose multi-character folds
2647  * were long ago discovered to mess things up.  The previous designs for
2648  * dealing with these involved assigning a special node for them.  This
2649  * approach doesn't work, as evidenced by this example:
2650  *      "\xDFs" =~ /s\xDF/ui    # Used to fail before these patches
2651  * Both these fold to "sss", but if the pattern is parsed to create a node that
2652  * would match just the \xDF, it won't be able to handle the case where a
2653  * successful match would have to cross the node's boundary.  The new approach
2654  * that hopefully generally solves the problem generates an EXACTFU_SS node
2655  * that is "sss".
2656  *
2657  * It turns out that there are problems with all multi-character folds, and not
2658  * just these three.  Now the code is general, for all such cases, but the
2659  * three still have some special handling.  The approach taken is:
2660  * 1)   This routine examines each EXACTFish node that could contain multi-
2661  *      character fold sequences.  It returns in *min_subtract how much to
2662  *      subtract from the the actual length of the string to get a real minimum
2663  *      match length; it is 0 if there are no multi-char folds.  This delta is
2664  *      used by the caller to adjust the min length of the match, and the delta
2665  *      between min and max, so that the optimizer doesn't reject these
2666  *      possibilities based on size constraints.
2667  * 2)   Certain of these sequences require special handling by the trie code,
2668  *      so, if found, this code changes the joined node type to special ops:
2669  *      EXACTFU_TRICKYFOLD and EXACTFU_SS.
2670  * 3)   For the sequence involving the Sharp s (\xDF), the node type EXACTFU_SS
2671  *      is used for an EXACTFU node that contains at least one "ss" sequence in
2672  *      it.  For non-UTF-8 patterns and strings, this is the only case where
2673  *      there is a possible fold length change.  That means that a regular
2674  *      EXACTFU node without UTF-8 involvement doesn't have to concern itself
2675  *      with length changes, and so can be processed faster.  regexec.c takes
2676  *      advantage of this.  Generally, an EXACTFish node that is in UTF-8 is
2677  *      pre-folded by regcomp.c.  This saves effort in regex matching.
2678  *      However, the pre-folding isn't done for non-UTF8 patterns because the
2679  *      fold of the MICRO SIGN requires UTF-8, and we don't want to slow things
2680  *      down by forcing the pattern into UTF8 unless necessary.  Also what
2681  *      EXACTF and EXACTFL nodes fold to isn't known until runtime.  The fold
2682  *      possibilities for the non-UTF8 patterns are quite simple, except for
2683  *      the sharp s.  All the ones that don't involve a UTF-8 target string are
2684  *      members of a fold-pair, and arrays are set up for all of them so that
2685  *      the other member of the pair can be found quickly.  Code elsewhere in
2686  *      this file makes sure that in EXACTFU nodes, the sharp s gets folded to
2687  *      'ss', even if the pattern isn't UTF-8.  This avoids the issues
2688  *      described in the next item.
2689  * 4)   A problem remains for the sharp s in EXACTF nodes.  Whether it matches
2690  *      'ss' or not is not knowable at compile time.  It will match iff the
2691  *      target string is in UTF-8, unlike the EXACTFU nodes, where it always
2692  *      matches; and the EXACTFL and EXACTFA nodes where it never does.  Thus
2693  *      it can't be folded to "ss" at compile time, unlike EXACTFU does (as
2694  *      described in item 3).  An assumption that the optimizer part of
2695  *      regexec.c (probably unwittingly) makes is that a character in the
2696  *      pattern corresponds to at most a single character in the target string.
2697  *      (And I do mean character, and not byte here, unlike other parts of the
2698  *      documentation that have never been updated to account for multibyte
2699  *      Unicode.)  This assumption is wrong only in this case, as all other
2700  *      cases are either 1-1 folds when no UTF-8 is involved; or is true by
2701  *      virtue of having this file pre-fold UTF-8 patterns.   I'm
2702  *      reluctant to try to change this assumption, so instead the code punts.
2703  *      This routine examines EXACTF nodes for the sharp s, and returns a
2704  *      boolean indicating whether or not the node is an EXACTF node that
2705  *      contains a sharp s.  When it is true, the caller sets a flag that later
2706  *      causes the optimizer in this file to not set values for the floating
2707  *      and fixed string lengths, and thus avoids the optimizer code in
2708  *      regexec.c that makes the invalid assumption.  Thus, there is no
2709  *      optimization based on string lengths for EXACTF nodes that contain the
2710  *      sharp s.  This only happens for /id rules (which means the pattern
2711  *      isn't in UTF-8).
2712  */
2713
2714 #define JOIN_EXACT(scan,min_subtract,has_exactf_sharp_s, flags) \
2715     if (PL_regkind[OP(scan)] == EXACT) \
2716         join_exact(pRExC_state,(scan),(min_subtract),has_exactf_sharp_s, (flags),NULL,depth+1)
2717
2718 STATIC U32
2719 S_join_exact(pTHX_ RExC_state_t *pRExC_state, regnode *scan, UV *min_subtract, bool *has_exactf_sharp_s, U32 flags,regnode *val, U32 depth) {
2720     /* Merge several consecutive EXACTish nodes into one. */
2721     regnode *n = regnext(scan);
2722     U32 stringok = 1;
2723     regnode *next = scan + NODE_SZ_STR(scan);
2724     U32 merged = 0;
2725     U32 stopnow = 0;
2726 #ifdef DEBUGGING
2727     regnode *stop = scan;
2728     GET_RE_DEBUG_FLAGS_DECL;
2729 #else
2730     PERL_UNUSED_ARG(depth);
2731 #endif
2732
2733     PERL_ARGS_ASSERT_JOIN_EXACT;
2734 #ifndef EXPERIMENTAL_INPLACESCAN
2735     PERL_UNUSED_ARG(flags);
2736     PERL_UNUSED_ARG(val);
2737 #endif
2738     DEBUG_PEEP("join",scan,depth);
2739
2740     /* Look through the subsequent nodes in the chain.  Skip NOTHING, merge
2741      * EXACT ones that are mergeable to the current one. */
2742     while (n
2743            && (PL_regkind[OP(n)] == NOTHING
2744                || (stringok && OP(n) == OP(scan)))
2745            && NEXT_OFF(n)
2746            && NEXT_OFF(scan) + NEXT_OFF(n) < I16_MAX)
2747     {
2748         
2749         if (OP(n) == TAIL || n > next)
2750             stringok = 0;
2751         if (PL_regkind[OP(n)] == NOTHING) {
2752             DEBUG_PEEP("skip:",n,depth);
2753             NEXT_OFF(scan) += NEXT_OFF(n);
2754             next = n + NODE_STEP_REGNODE;
2755 #ifdef DEBUGGING
2756             if (stringok)
2757                 stop = n;
2758 #endif
2759             n = regnext(n);
2760         }
2761         else if (stringok) {
2762             const unsigned int oldl = STR_LEN(scan);
2763             regnode * const nnext = regnext(n);
2764
2765             /* XXX I (khw) kind of doubt that this works on platforms where
2766              * U8_MAX is above 255 because of lots of other assumptions */
2767             /* Don't join if the sum can't fit into a single node */
2768             if (oldl + STR_LEN(n) > U8_MAX)
2769                 break;
2770             
2771             DEBUG_PEEP("merg",n,depth);
2772             merged++;
2773
2774             NEXT_OFF(scan) += NEXT_OFF(n);
2775             STR_LEN(scan) += STR_LEN(n);
2776             next = n + NODE_SZ_STR(n);
2777             /* Now we can overwrite *n : */
2778             Move(STRING(n), STRING(scan) + oldl, STR_LEN(n), char);
2779 #ifdef DEBUGGING
2780             stop = next - 1;
2781 #endif
2782             n = nnext;
2783             if (stopnow) break;
2784         }
2785
2786 #ifdef EXPERIMENTAL_INPLACESCAN
2787         if (flags && !NEXT_OFF(n)) {
2788             DEBUG_PEEP("atch", val, depth);
2789             if (reg_off_by_arg[OP(n)]) {
2790                 ARG_SET(n, val - n);
2791             }
2792             else {
2793                 NEXT_OFF(n) = val - n;
2794             }
2795             stopnow = 1;
2796         }
2797 #endif
2798     }
2799
2800     *min_subtract = 0;
2801     *has_exactf_sharp_s = FALSE;
2802
2803     /* Here, all the adjacent mergeable EXACTish nodes have been merged.  We
2804      * can now analyze for sequences of problematic code points.  (Prior to
2805      * this final joining, sequences could have been split over boundaries, and
2806      * hence missed).  The sequences only happen in folding, hence for any
2807      * non-EXACT EXACTish node */
2808     if (OP(scan) != EXACT) {
2809         const U8 * const s0 = (U8*) STRING(scan);
2810         const U8 * s = s0;
2811         const U8 * const s_end = s0 + STR_LEN(scan);
2812
2813         /* One pass is made over the node's string looking for all the
2814          * possibilities.  to avoid some tests in the loop, there are two main
2815          * cases, for UTF-8 patterns (which can't have EXACTF nodes) and
2816          * non-UTF-8 */
2817         if (UTF) {
2818
2819             /* Examine the string for a multi-character fold sequence.  UTF-8
2820              * patterns have all characters pre-folded by the time this code is
2821              * executed */
2822             while (s < s_end - 1) /* Can stop 1 before the end, as minimum
2823                                      length sequence we are looking for is 2 */
2824             {
2825                 int count = 0;
2826                 int len = is_MULTI_CHAR_FOLD_utf8_safe(s, s_end);
2827                 if (! len) {    /* Not a multi-char fold: get next char */
2828                     s += UTF8SKIP(s);
2829                     continue;
2830                 }
2831
2832                 /* Nodes with 'ss' require special handling, except for EXACTFL
2833                  * and EXACTFA for which there is no multi-char fold to this */
2834                 if (len == 2 && *s == 's' && *(s+1) == 's'
2835                     && OP(scan) != EXACTFL && OP(scan) != EXACTFA)
2836                 {
2837                     count = 2;
2838                     OP(scan) = EXACTFU_SS;
2839                     s += 2;
2840                 }
2841                 else if (len == 6   /* len is the same in both ASCII and EBCDIC for these */
2842                          && (memEQ(s, GREEK_SMALL_LETTER_IOTA_UTF8
2843                                       COMBINING_DIAERESIS_UTF8
2844                                       COMBINING_ACUTE_ACCENT_UTF8,
2845                                    6)
2846                              || memEQ(s, GREEK_SMALL_LETTER_UPSILON_UTF8
2847                                          COMBINING_DIAERESIS_UTF8
2848                                          COMBINING_ACUTE_ACCENT_UTF8,
2849                                      6)))
2850                 {
2851                     count = 3;
2852
2853                     /* These two folds require special handling by trie's, so
2854                      * change the node type to indicate this.  If EXACTFA and
2855                      * EXACTFL were ever to be handled by trie's, this would
2856                      * have to be changed.  If this node has already been
2857                      * changed to EXACTFU_SS in this loop, leave it as is.  (I
2858                      * (khw) think it doesn't matter in regexec.c for UTF
2859                      * patterns, but no need to change it */
2860                     if (OP(scan) == EXACTFU) {
2861                         OP(scan) = EXACTFU_TRICKYFOLD;
2862                     }
2863                     s += 6;
2864                 }
2865                 else { /* Here is a generic multi-char fold. */
2866                     const U8* multi_end  = s + len;
2867
2868                     /* Count how many characters in it.  In the case of /l and
2869                      * /aa, no folds which contain ASCII code points are
2870                      * allowed, so check for those, and skip if found.  (In
2871                      * EXACTFL, no folds are allowed to any Latin1 code point,
2872                      * not just ASCII.  But there aren't any of these
2873                      * currently, nor ever likely, so don't take the time to
2874                      * test for them.  The code that generates the
2875                      * is_MULTI_foo() macros croaks should one actually get put
2876                      * into Unicode .) */
2877                     if (OP(scan) != EXACTFL && OP(scan) != EXACTFA) {
2878                         count = utf8_length(s, multi_end);
2879                         s = multi_end;
2880                     }
2881                     else {
2882                         while (s < multi_end) {
2883                             if (isASCII(*s)) {
2884                                 s++;
2885                                 goto next_iteration;
2886                             }
2887                             else {
2888                                 s += UTF8SKIP(s);
2889                             }
2890                             count++;
2891                         }
2892                     }
2893                 }
2894
2895                 /* The delta is how long the sequence is minus 1 (1 is how long
2896                  * the character that folds to the sequence is) */
2897                 *min_subtract += count - 1;
2898             next_iteration: ;
2899             }
2900         }
2901         else if (OP(scan) != EXACTFL && OP(scan) != EXACTFA) {
2902
2903             /* Here, the pattern is not UTF-8.  Look for the multi-char folds
2904              * that are all ASCII.  As in the above case, EXACTFL and EXACTFA
2905              * nodes can't have multi-char folds to this range (and there are
2906              * no existing ones in the upper latin1 range).  In the EXACTF
2907              * case we look also for the sharp s, which can be in the final
2908              * position.  Otherwise we can stop looking 1 byte earlier because
2909              * have to find at least two characters for a multi-fold */
2910             const U8* upper = (OP(scan) == EXACTF) ? s_end : s_end -1;
2911
2912             /* The below is perhaps overboard, but this allows us to save a
2913              * test each time through the loop at the expense of a mask.  This
2914              * is because on both EBCDIC and ASCII machines, 'S' and 's' differ
2915              * by a single bit.  On ASCII they are 32 apart; on EBCDIC, they
2916              * are 64.  This uses an exclusive 'or' to find that bit and then
2917              * inverts it to form a mask, with just a single 0, in the bit
2918              * position where 'S' and 's' differ. */
2919             const U8 S_or_s_mask = (U8) ~ ('S' ^ 's');
2920             const U8 s_masked = 's' & S_or_s_mask;
2921
2922             while (s < upper) {
2923                 int len = is_MULTI_CHAR_FOLD_latin1_safe(s, s_end);
2924                 if (! len) {    /* Not a multi-char fold. */
2925                     if (*s == LATIN_SMALL_LETTER_SHARP_S && OP(scan) == EXACTF)
2926                     {
2927                         *has_exactf_sharp_s = TRUE;
2928                     }
2929                     s++;
2930                     continue;
2931                 }
2932
2933                 if (len == 2
2934                     && ((*s & S_or_s_mask) == s_masked)
2935                     && ((*(s+1) & S_or_s_mask) == s_masked))
2936                 {
2937
2938                     /* EXACTF nodes need to know that the minimum length
2939                      * changed so that a sharp s in the string can match this
2940                      * ss in the pattern, but they remain EXACTF nodes, as they
2941                      * won't match this unless the target string is is UTF-8,
2942                      * which we don't know until runtime */
2943                     if (OP(scan) != EXACTF) {
2944                         OP(scan) = EXACTFU_SS;
2945                     }
2946                 }
2947
2948                 *min_subtract += len - 1;
2949                 s += len;
2950             }
2951         }
2952     }
2953
2954 #ifdef DEBUGGING
2955     /* Allow dumping but overwriting the collection of skipped
2956      * ops and/or strings with fake optimized ops */
2957     n = scan + NODE_SZ_STR(scan);
2958     while (n <= stop) {
2959         OP(n) = OPTIMIZED;
2960         FLAGS(n) = 0;
2961         NEXT_OFF(n) = 0;
2962         n++;
2963     }
2964 #endif
2965     DEBUG_OPTIMISE_r(if (merged){DEBUG_PEEP("finl",scan,depth)});
2966     return stopnow;
2967 }
2968
2969 /* REx optimizer.  Converts nodes into quicker variants "in place".
2970    Finds fixed substrings.  */
2971
2972 /* Stops at toplevel WHILEM as well as at "last". At end *scanp is set
2973    to the position after last scanned or to NULL. */
2974
2975 #define INIT_AND_WITHP \
2976     assert(!and_withp); \
2977     Newx(and_withp,1,struct regnode_charclass_class); \
2978     SAVEFREEPV(and_withp)
2979
2980 /* this is a chain of data about sub patterns we are processing that
2981    need to be handled separately/specially in study_chunk. Its so
2982    we can simulate recursion without losing state.  */
2983 struct scan_frame;
2984 typedef struct scan_frame {
2985     regnode *last;  /* last node to process in this frame */
2986     regnode *next;  /* next node to process when last is reached */
2987     struct scan_frame *prev; /*previous frame*/
2988     I32 stop; /* what stopparen do we use */
2989 } scan_frame;
2990
2991
2992 #define SCAN_COMMIT(s, data, m) scan_commit(s, data, m, is_inf)
2993
2994 STATIC I32
2995 S_study_chunk(pTHX_ RExC_state_t *pRExC_state, regnode **scanp,
2996                         I32 *minlenp, I32 *deltap,
2997                         regnode *last,
2998                         scan_data_t *data,
2999                         I32 stopparen,
3000                         U8* recursed,
3001                         struct regnode_charclass_class *and_withp,
3002                         U32 flags, U32 depth)
3003                         /* scanp: Start here (read-write). */
3004                         /* deltap: Write maxlen-minlen here. */
3005                         /* last: Stop before this one. */
3006                         /* data: string data about the pattern */
3007                         /* stopparen: treat close N as END */
3008                         /* recursed: which subroutines have we recursed into */
3009                         /* and_withp: Valid if flags & SCF_DO_STCLASS_OR */
3010 {
3011     dVAR;
3012     I32 min = 0;    /* There must be at least this number of characters to match */
3013     I32 pars = 0, code;
3014     regnode *scan = *scanp, *next;
3015     I32 delta = 0;
3016     int is_inf = (flags & SCF_DO_SUBSTR) && (data->flags & SF_IS_INF);
3017     int is_inf_internal = 0;            /* The studied chunk is infinite */
3018     I32 is_par = OP(scan) == OPEN ? ARG(scan) : 0;
3019     scan_data_t data_fake;
3020     SV *re_trie_maxbuff = NULL;
3021     regnode *first_non_open = scan;
3022     I32 stopmin = I32_MAX;
3023     scan_frame *frame = NULL;
3024     GET_RE_DEBUG_FLAGS_DECL;
3025
3026     PERL_ARGS_ASSERT_STUDY_CHUNK;
3027
3028 #ifdef DEBUGGING
3029     StructCopy(&zero_scan_data, &data_fake, scan_data_t);
3030 #endif
3031
3032     if ( depth == 0 ) {
3033         while (first_non_open && OP(first_non_open) == OPEN)
3034             first_non_open=regnext(first_non_open);
3035     }
3036
3037
3038   fake_study_recurse:
3039     while ( scan && OP(scan) != END && scan < last ){
3040         UV min_subtract = 0;    /* How mmany chars to subtract from the minimum
3041                                    node length to get a real minimum (because
3042                                    the folded version may be shorter) */
3043         bool has_exactf_sharp_s = FALSE;
3044         /* Peephole optimizer: */
3045         DEBUG_STUDYDATA("Peep:", data,depth);
3046         DEBUG_PEEP("Peep",scan,depth);
3047
3048         /* Its not clear to khw or hv why this is done here, and not in the
3049          * clauses that deal with EXACT nodes.  khw's guess is that it's
3050          * because of a previous design */
3051         JOIN_EXACT(scan,&min_subtract, &has_exactf_sharp_s, 0);
3052
3053         /* Follow the next-chain of the current node and optimize
3054            away all the NOTHINGs from it.  */
3055         if (OP(scan) != CURLYX) {
3056             const int max = (reg_off_by_arg[OP(scan)]
3057                        ? I32_MAX
3058                        /* I32 may be smaller than U16 on CRAYs! */
3059                        : (I32_MAX < U16_MAX ? I32_MAX : U16_MAX));
3060             int off = (reg_off_by_arg[OP(scan)] ? ARG(scan) : NEXT_OFF(scan));
3061             int noff;
3062             regnode *n = scan;
3063
3064             /* Skip NOTHING and LONGJMP. */
3065             while ((n = regnext(n))
3066                    && ((PL_regkind[OP(n)] == NOTHING && (noff = NEXT_OFF(n)))
3067                        || ((OP(n) == LONGJMP) && (noff = ARG(n))))
3068                    && off + noff < max)
3069                 off += noff;
3070             if (reg_off_by_arg[OP(scan)])
3071                 ARG(scan) = off;
3072             else
3073                 NEXT_OFF(scan) = off;
3074         }
3075
3076
3077
3078         /* The principal pseudo-switch.  Cannot be a switch, since we
3079            look into several different things.  */
3080         if (OP(scan) == BRANCH || OP(scan) == BRANCHJ
3081                    || OP(scan) == IFTHEN) {
3082             next = regnext(scan);
3083             code = OP(scan);
3084             /* demq: the op(next)==code check is to see if we have "branch-branch" AFAICT */
3085
3086             if (OP(next) == code || code == IFTHEN) {
3087                 /* NOTE - There is similar code to this block below for handling
3088                    TRIE nodes on a re-study.  If you change stuff here check there
3089                    too. */
3090                 I32 max1 = 0, min1 = I32_MAX, num = 0;
3091                 struct regnode_charclass_class accum;
3092                 regnode * const startbranch=scan;
3093
3094                 if (flags & SCF_DO_SUBSTR)
3095                     SCAN_COMMIT(pRExC_state, data, minlenp); /* Cannot merge strings after this. */
3096                 if (flags & SCF_DO_STCLASS)
3097                     cl_init_zero(pRExC_state, &accum);
3098
3099                 while (OP(scan) == code) {
3100                     I32 deltanext, minnext, f = 0, fake;
3101                     struct regnode_charclass_class this_class;
3102
3103                     num++;
3104                     data_fake.flags = 0;
3105                     if (data) {
3106                         data_fake.whilem_c = data->whilem_c;
3107                         data_fake.last_closep = data->last_closep;
3108                     }
3109                     else
3110                         data_fake.last_closep = &fake;
3111
3112                     data_fake.pos_delta = delta;
3113                     next = regnext(scan);
3114                     scan = NEXTOPER(scan);
3115                     if (code != BRANCH)
3116                         scan = NEXTOPER(scan);
3117                     if (flags & SCF_DO_STCLASS) {
3118                         cl_init(pRExC_state, &this_class);
3119                         data_fake.start_class = &this_class;
3120                         f = SCF_DO_STCLASS_AND;
3121                     }
3122                     if (flags & SCF_WHILEM_VISITED_POS)
3123                         f |= SCF_WHILEM_VISITED_POS;
3124
3125                     /* we suppose the run is continuous, last=next...*/
3126                     minnext = study_chunk(pRExC_state, &scan, minlenp, &deltanext,
3127                                           next, &data_fake,
3128                                           stopparen, recursed, NULL, f,depth+1);
3129                     if (min1 > minnext)
3130                         min1 = minnext;
3131                     if (deltanext == I32_MAX) {
3132                         is_inf = is_inf_internal = 1;
3133                         max1 = I32_MAX;
3134                     } else if (max1 < minnext + deltanext)
3135                         max1 = minnext + deltanext;
3136                     scan = next;
3137                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
3138                         pars++;
3139                     if (data_fake.flags & SCF_SEEN_ACCEPT) {
3140                         if ( stopmin > minnext) 
3141                             stopmin = min + min1;
3142                         flags &= ~SCF_DO_SUBSTR;
3143                         if (data)
3144                             data->flags |= SCF_SEEN_ACCEPT;
3145                     }
3146                     if (data) {
3147                         if (data_fake.flags & SF_HAS_EVAL)
3148                             data->flags |= SF_HAS_EVAL;
3149                         data->whilem_c = data_fake.whilem_c;
3150                     }
3151                     if (flags & SCF_DO_STCLASS)
3152                         cl_or(pRExC_state, &accum, &this_class);
3153                 }
3154                 if (code == IFTHEN && num < 2) /* Empty ELSE branch */
3155                     min1 = 0;
3156                 if (flags & SCF_DO_SUBSTR) {
3157                     data->pos_min += min1;
3158                     if (data->pos_delta >= I32_MAX - (max1 - min1))
3159                         data->pos_delta = I32_MAX;
3160                     else
3161                         data->pos_delta += max1 - min1;
3162                     if (max1 != min1 || is_inf)
3163                         data->longest = &(data->longest_float);
3164                 }
3165                 min += min1;
3166                 if (delta == I32_MAX || I32_MAX - delta - (max1 - min1) < 0)
3167                     delta = I32_MAX;
3168                 else
3169                     delta += max1 - min1;
3170                 if (flags & SCF_DO_STCLASS_OR) {
3171                     cl_or(pRExC_state, data->start_class, &accum);
3172                     if (min1) {
3173                         cl_and(data->start_class, and_withp);
3174                         flags &= ~SCF_DO_STCLASS;
3175                     }
3176                 }
3177                 else if (flags & SCF_DO_STCLASS_AND) {
3178                     if (min1) {
3179                         cl_and(data->start_class, &accum);
3180                         flags &= ~SCF_DO_STCLASS;
3181                     }
3182                     else {
3183                         /* Switch to OR mode: cache the old value of
3184                          * data->start_class */
3185                         INIT_AND_WITHP;
3186                         StructCopy(data->start_class, and_withp,
3187                                    struct regnode_charclass_class);
3188                         flags &= ~SCF_DO_STCLASS_AND;
3189                         StructCopy(&accum, data->start_class,
3190                                    struct regnode_charclass_class);
3191                         flags |= SCF_DO_STCLASS_OR;
3192                         SET_SSC_EOS(data->start_class);
3193                     }
3194                 }
3195
3196                 if (PERL_ENABLE_TRIE_OPTIMISATION && OP( startbranch ) == BRANCH ) {
3197                 /* demq.
3198
3199                    Assuming this was/is a branch we are dealing with: 'scan' now
3200                    points at the item that follows the branch sequence, whatever
3201                    it is. We now start at the beginning of the sequence and look
3202                    for subsequences of
3203
3204                    BRANCH->EXACT=>x1
3205                    BRANCH->EXACT=>x2
3206                    tail
3207
3208                    which would be constructed from a pattern like /A|LIST|OF|WORDS/
3209
3210                    If we can find such a subsequence we need to turn the first
3211                    element into a trie and then add the subsequent branch exact
3212                    strings to the trie.
3213
3214                    We have two cases
3215
3216                      1. patterns where the whole set of branches can be converted. 
3217
3218                      2. patterns where only a subset can be converted.
3219
3220                    In case 1 we can replace the whole set with a single regop
3221                    for the trie. In case 2 we need to keep the start and end
3222                    branches so
3223
3224                      'BRANCH EXACT; BRANCH EXACT; BRANCH X'
3225                      becomes BRANCH TRIE; BRANCH X;
3226
3227                   There is an additional case, that being where there is a 
3228                   common prefix, which gets split out into an EXACT like node
3229                   preceding the TRIE node.
3230
3231                   If x(1..n)==tail then we can do a simple trie, if not we make
3232                   a "jump" trie, such that when we match the appropriate word
3233                   we "jump" to the appropriate tail node. Essentially we turn
3234                   a nested if into a case structure of sorts.
3235
3236                 */
3237
3238                     int made=0;
3239                     if (!re_trie_maxbuff) {
3240                         re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
3241                         if (!SvIOK(re_trie_maxbuff))
3242                             sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
3243                     }
3244                     if ( SvIV(re_trie_maxbuff)>=0  ) {
3245                         regnode *cur;
3246                         regnode *first = (regnode *)NULL;
3247                         regnode *last = (regnode *)NULL;
3248                         regnode *tail = scan;
3249                         U8 trietype = 0;
3250                         U32 count=0;
3251
3252 #ifdef DEBUGGING
3253                         SV * const mysv = sv_newmortal();       /* for dumping */
3254 #endif
3255                         /* var tail is used because there may be a TAIL
3256                            regop in the way. Ie, the exacts will point to the
3257                            thing following the TAIL, but the last branch will
3258                            point at the TAIL. So we advance tail. If we
3259                            have nested (?:) we may have to move through several
3260                            tails.
3261                          */
3262
3263                         while ( OP( tail ) == TAIL ) {
3264                             /* this is the TAIL generated by (?:) */
3265                             tail = regnext( tail );
3266                         }
3267
3268                         
3269                         DEBUG_TRIE_COMPILE_r({
3270                             regprop(RExC_rx, mysv, tail );
3271                             PerlIO_printf( Perl_debug_log, "%*s%s%s\n",
3272                                 (int)depth * 2 + 2, "", 
3273                                 "Looking for TRIE'able sequences. Tail node is: ", 
3274                                 SvPV_nolen_const( mysv )
3275                             );
3276                         });
3277                         
3278                         /*
3279
3280                             Step through the branches
3281                                 cur represents each branch,
3282                                 noper is the first thing to be matched as part of that branch
3283                                 noper_next is the regnext() of that node.
3284
3285                             We normally handle a case like this /FOO[xyz]|BAR[pqr]/
3286                             via a "jump trie" but we also support building with NOJUMPTRIE,
3287                             which restricts the trie logic to structures like /FOO|BAR/.
3288
3289                             If noper is a trieable nodetype then the branch is a possible optimization
3290                             target. If we are building under NOJUMPTRIE then we require that noper_next
3291                             is the same as scan (our current position in the regex program).
3292
3293                             Once we have two or more consecutive such branches we can create a
3294                             trie of the EXACT's contents and stitch it in place into the program.
3295
3296                             If the sequence represents all of the branches in the alternation we
3297                             replace the entire thing with a single TRIE node.
3298
3299                             Otherwise when it is a subsequence we need to stitch it in place and
3300                             replace only the relevant branches. This means the first branch has
3301                             to remain as it is used by the alternation logic, and its next pointer,
3302                             and needs to be repointed at the item on the branch chain following
3303                             the last branch we have optimized away.
3304
3305                             This could be either a BRANCH, in which case the subsequence is internal,
3306                             or it could be the item following the branch sequence in which case the
3307                             subsequence is at the end (which does not necessarily mean the first node
3308                             is the start of the alternation).
3309
3310                             TRIE_TYPE(X) is a define which maps the optype to a trietype.
3311
3312                                 optype          |  trietype
3313                                 ----------------+-----------
3314                                 NOTHING         | NOTHING
3315                                 EXACT           | EXACT
3316                                 EXACTFU         | EXACTFU
3317                                 EXACTFU_SS      | EXACTFU
3318                                 EXACTFU_TRICKYFOLD | EXACTFU
3319                                 EXACTFA         | 0
3320
3321
3322                         */
3323 #define TRIE_TYPE(X) ( ( NOTHING == (X) ) ? NOTHING :   \
3324                        ( EXACT == (X) )   ? EXACT :        \
3325                        ( EXACTFU == (X) || EXACTFU_SS == (X) || EXACTFU_TRICKYFOLD == (X) ) ? EXACTFU :        \
3326                        0 )
3327
3328                         /* dont use tail as the end marker for this traverse */
3329                         for ( cur = startbranch ; cur != scan ; cur = regnext( cur ) ) {
3330                             regnode * const noper = NEXTOPER( cur );
3331                             U8 noper_type = OP( noper );
3332                             U8 noper_trietype = TRIE_TYPE( noper_type );
3333 #if defined(DEBUGGING) || defined(NOJUMPTRIE)
3334                             regnode * const noper_next = regnext( noper );
3335                             U8 noper_next_type = (noper_next && noper_next != tail) ? OP(noper_next) : 0;
3336                             U8 noper_next_trietype = (noper_next && noper_next != tail) ? TRIE_TYPE( noper_next_type ) :0;
3337 #endif
3338
3339                             DEBUG_TRIE_COMPILE_r({
3340                                 regprop(RExC_rx, mysv, cur);
3341                                 PerlIO_printf( Perl_debug_log, "%*s- %s (%d)",
3342                                    (int)depth * 2 + 2,"", SvPV_nolen_const( mysv ), REG_NODE_NUM(cur) );
3343
3344                                 regprop(RExC_rx, mysv, noper);
3345                                 PerlIO_printf( Perl_debug_log, " -> %s",
3346                                     SvPV_nolen_const(mysv));
3347
3348                                 if ( noper_next ) {
3349                                   regprop(RExC_rx, mysv, noper_next );
3350                                   PerlIO_printf( Perl_debug_log,"\t=> %s\t",
3351                                     SvPV_nolen_const(mysv));
3352                                 }
3353                                 PerlIO_printf( Perl_debug_log, "(First==%d,Last==%d,Cur==%d,tt==%s,nt==%s,nnt==%s)\n",
3354                                    REG_NODE_NUM(first), REG_NODE_NUM(last), REG_NODE_NUM(cur),
3355                                    PL_reg_name[trietype], PL_reg_name[noper_trietype], PL_reg_name[noper_next_trietype] 
3356                                 );
3357                             });
3358
3359                             /* Is noper a trieable nodetype that can be merged with the
3360                              * current trie (if there is one)? */
3361                             if ( noper_trietype
3362                                   &&
3363                                   (
3364                                         ( noper_trietype == NOTHING)
3365                                         || ( trietype == NOTHING )
3366                                         || ( trietype == noper_trietype )
3367                                   )
3368 #ifdef NOJUMPTRIE
3369                                   && noper_next == tail
3370 #endif
3371                                   && count < U16_MAX)
3372                             {
3373                                 /* Handle mergable triable node
3374                                  * Either we are the first node in a new trieable sequence,
3375                                  * in which case we do some bookkeeping, otherwise we update
3376                                  * the end pointer. */
3377                                 if ( !first ) {
3378                                     first = cur;
3379                                     if ( noper_trietype == NOTHING ) {
3380 #if !defined(DEBUGGING) && !defined(NOJUMPTRIE)
3381                                         regnode * const noper_next = regnext( noper );
3382                                         U8 noper_next_type = (noper_next && noper_next!=tail) ? OP(noper_next) : 0;
3383                                         U8 noper_next_trietype = noper_next_type ? TRIE_TYPE( noper_next_type ) :0;
3384 #endif
3385
3386                                         if ( noper_next_trietype ) {
3387                                             trietype = noper_next_trietype;
3388                                         } else if (noper_next_type)  {
3389                                             /* a NOTHING regop is 1 regop wide. We need at least two
3390                                              * for a trie so we can't merge this in */
3391                                             first = NULL;
3392                                         }
3393                                     } else {
3394                                         trietype = noper_trietype;
3395                                     }
3396                                 } else {
3397                                     if ( trietype == NOTHING )
3398                                         trietype = noper_trietype;
3399                                     last = cur;
3400                                 }
3401                                 if (first)
3402                                     count++;
3403                             } /* end handle mergable triable node */
3404                             else {
3405                                 /* handle unmergable node -
3406                                  * noper may either be a triable node which can not be tried
3407                                  * together with the current trie, or a non triable node */
3408                                 if ( last ) {
3409                                     /* If last is set and trietype is not NOTHING then we have found
3410                                      * at least two triable branch sequences in a row of a similar
3411                                      * trietype so we can turn them into a trie. If/when we
3412                                      * allow NOTHING to start a trie sequence this condition will be
3413                                      * required, and it isn't expensive so we leave it in for now. */
3414                                     if ( trietype && trietype != NOTHING )
3415                                         make_trie( pRExC_state,
3416                                                 startbranch, first, cur, tail, count,
3417                                                 trietype, depth+1 );
3418                                     last = NULL; /* note: we clear/update first, trietype etc below, so we dont do it here */
3419                                 }
3420                                 if ( noper_trietype
3421 #ifdef NOJUMPTRIE
3422                                      && noper_next == tail
3423 #endif
3424                                 ){
3425                                     /* noper is triable, so we can start a new trie sequence */
3426                                     count = 1;
3427                                     first = cur;
3428                                     trietype = noper_trietype;
3429                                 } else if (first) {
3430                                     /* if we already saw a first but the current node is not triable then we have
3431                                      * to reset the first information. */
3432                                     count = 0;
3433                                     first = NULL;
3434                                     trietype = 0;
3435                                 }
3436                             } /* end handle unmergable node */
3437                         } /* loop over branches */
3438                         DEBUG_TRIE_COMPILE_r({
3439                             regprop(RExC_rx, mysv, cur);
3440                             PerlIO_printf( Perl_debug_log,
3441                               "%*s- %s (%d) <SCAN FINISHED>\n", (int)depth * 2 + 2,
3442                               "", SvPV_nolen_const( mysv ),REG_NODE_NUM(cur));
3443
3444                         });
3445                         if ( last && trietype ) {
3446                             if ( trietype != NOTHING ) {
3447                                 /* the last branch of the sequence was part of a trie,
3448                                  * so we have to construct it here outside of the loop
3449                                  */
3450                                 made= make_trie( pRExC_state, startbranch, first, scan, tail, count, trietype, depth+1 );
3451 #ifdef TRIE_STUDY_OPT
3452                                 if ( ((made == MADE_EXACT_TRIE &&
3453                                      startbranch == first)
3454                                      || ( first_non_open == first )) &&
3455                                      depth==0 ) {
3456                                     flags |= SCF_TRIE_RESTUDY;
3457                                     if ( startbranch == first
3458                                          && scan == tail )
3459                                     {
3460                                         RExC_seen &=~REG_TOP_LEVEL_BRANCHES;
3461                                     }
3462                                 }
3463 #endif
3464                             } else {
3465                                 /* at this point we know whatever we have is a NOTHING sequence/branch
3466                                  * AND if 'startbranch' is 'first' then we can turn the whole thing into a NOTHING
3467                                  */
3468                                 if ( startbranch == first ) {
3469                                     regnode *opt;
3470                                     /* the entire thing is a NOTHING sequence, something like this:
3471                                      * (?:|) So we can turn it into a plain NOTHING op. */
3472                                     DEBUG_TRIE_COMPILE_r({
3473                                         regprop(RExC_rx, mysv, cur);
3474                                         PerlIO_printf( Perl_debug_log,
3475                                           "%*s- %s (%d) <NOTHING BRANCH SEQUENCE>\n", (int)depth * 2 + 2,
3476                                           "", SvPV_nolen_const( mysv ),REG_NODE_NUM(cur));
3477
3478                                     });
3479                                     OP(startbranch)= NOTHING;
3480                                     NEXT_OFF(startbranch)= tail - startbranch;
3481                                     for ( opt= startbranch + 1; opt < tail ; opt++ )
3482                                         OP(opt)= OPTIMIZED;
3483                                 }
3484                             }
3485                         } /* end if ( last) */
3486                     } /* TRIE_MAXBUF is non zero */
3487                     
3488                 } /* do trie */
3489                 
3490             }
3491             else if ( code == BRANCHJ ) {  /* single branch is optimized. */
3492                 scan = NEXTOPER(NEXTOPER(scan));
3493             } else                      /* single branch is optimized. */
3494                 scan = NEXTOPER(scan);
3495             continue;
3496         } else if (OP(scan) == SUSPEND || OP(scan) == GOSUB || OP(scan) == GOSTART) {
3497             scan_frame *newframe = NULL;
3498             I32 paren;
3499             regnode *start;
3500             regnode *end;
3501
3502             if (OP(scan) != SUSPEND) {
3503             /* set the pointer */
3504                 if (OP(scan) == GOSUB) {
3505                     paren = ARG(scan);
3506                     RExC_recurse[ARG2L(scan)] = scan;
3507                     start = RExC_open_parens[paren-1];
3508                     end   = RExC_close_parens[paren-1];
3509                 } else {
3510                     paren = 0;
3511                     start = RExC_rxi->program + 1;
3512                     end   = RExC_opend;
3513                 }
3514                 if (!recursed) {
3515                     Newxz(recursed, (((RExC_npar)>>3) +1), U8);
3516                     SAVEFREEPV(recursed);
3517                 }
3518                 if (!PAREN_TEST(recursed,paren+1)) {
3519                     PAREN_SET(recursed,paren+1);
3520                     Newx(newframe,1,scan_frame);
3521                 } else {
3522                     if (flags & SCF_DO_SUBSTR) {
3523                         SCAN_COMMIT(pRExC_state,data,minlenp);
3524                         data->longest = &(data->longest_float);
3525                     }
3526                     is_inf = is_inf_internal = 1;
3527                     if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
3528                         cl_anything(pRExC_state, data->start_class);
3529                     flags &= ~SCF_DO_STCLASS;
3530                 }
3531             } else {
3532                 Newx(newframe,1,scan_frame);
3533                 paren = stopparen;
3534                 start = scan+2;
3535                 end = regnext(scan);
3536             }
3537             if (newframe) {
3538                 assert(start);
3539                 assert(end);
3540                 SAVEFREEPV(newframe);
3541                 newframe->next = regnext(scan);
3542                 newframe->last = last;
3543                 newframe->stop = stopparen;
3544                 newframe->prev = frame;
3545
3546                 frame = newframe;
3547                 scan =  start;
3548                 stopparen = paren;
3549                 last = end;
3550
3551                 continue;
3552             }
3553         }
3554         else if (OP(scan) == EXACT) {
3555             I32 l = STR_LEN(scan);
3556             UV uc;
3557             if (UTF) {
3558                 const U8 * const s = (U8*)STRING(scan);
3559                 uc = utf8_to_uvchr_buf(s, s + l, NULL);
3560                 l = utf8_length(s, s + l);
3561             } else {
3562                 uc = *((U8*)STRING(scan));
3563             }
3564             min += l;
3565             if (flags & SCF_DO_SUBSTR) { /* Update longest substr. */
3566                 /* The code below prefers earlier match for fixed
3567                    offset, later match for variable offset.  */
3568                 if (data->last_end == -1) { /* Update the start info. */
3569                     data->last_start_min = data->pos_min;
3570                     data->last_start_max = is_inf
3571                         ? I32_MAX : data->pos_min + data->pos_delta;
3572                 }
3573                 sv_catpvn(data->last_found, STRING(scan), STR_LEN(scan));
3574                 if (UTF)
3575                     SvUTF8_on(data->last_found);
3576                 {
3577                     SV * const sv = data->last_found;
3578                     MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
3579                         mg_find(sv, PERL_MAGIC_utf8) : NULL;
3580                     if (mg && mg->mg_len >= 0)
3581                         mg->mg_len += utf8_length((U8*)STRING(scan),
3582                                                   (U8*)STRING(scan)+STR_LEN(scan));
3583                 }
3584                 data->last_end = data->pos_min + l;
3585                 data->pos_min += l; /* As in the first entry. */
3586                 data->flags &= ~SF_BEFORE_EOL;
3587             }
3588             if (flags & SCF_DO_STCLASS_AND) {
3589                 /* Check whether it is compatible with what we know already! */
3590                 int compat = 1;
3591
3592
3593                 /* If compatible, we or it in below.  It is compatible if is
3594                  * in the bitmp and either 1) its bit or its fold is set, or 2)
3595                  * it's for a locale.  Even if there isn't unicode semantics
3596                  * here, at runtime there may be because of matching against a
3597                  * utf8 string, so accept a possible false positive for
3598                  * latin1-range folds */
3599                 if (uc >= 0x100 ||
3600                     (!(data->start_class->flags & ANYOF_LOCALE)
3601                     && !ANYOF_BITMAP_TEST(data->start_class, uc)
3602                     && (!(data->start_class->flags & ANYOF_LOC_FOLD)
3603                         || !ANYOF_BITMAP_TEST(data->start_class, PL_fold_latin1[uc])))
3604                     )
3605                 {
3606                     compat = 0;
3607                 }
3608                 ANYOF_CLASS_ZERO(data->start_class);
3609                 ANYOF_BITMAP_ZERO(data->start_class);
3610                 if (compat)
3611                     ANYOF_BITMAP_SET(data->start_class, uc);
3612                 else if (uc >= 0x100) {
3613                     int i;
3614
3615                     /* Some Unicode code points fold to the Latin1 range; as
3616                      * XXX temporary code, instead of figuring out if this is
3617                      * one, just assume it is and set all the start class bits
3618                      * that could be some such above 255 code point's fold
3619                      * which will generate fals positives.  As the code
3620                      * elsewhere that does compute the fold settles down, it
3621                      * can be extracted out and re-used here */
3622                     for (i = 0; i < 256; i++){
3623                         if (HAS_NONLATIN1_FOLD_CLOSURE(i)) {
3624                             ANYOF_BITMAP_SET(data->start_class, i);
3625                         }
3626                     }
3627                 }
3628                 CLEAR_SSC_EOS(data->start_class);
3629                 if (uc < 0x100)
3630                   data->start_class->flags &= ~ANYOF_UNICODE_ALL;
3631             }
3632             else if (flags & SCF_DO_STCLASS_OR) {
3633                 /* false positive possible if the class is case-folded */
3634                 if (uc < 0x100)
3635                     ANYOF_BITMAP_SET(data->start_class, uc);
3636                 else
3637                     data->start_class->flags |= ANYOF_UNICODE_ALL;
3638                 CLEAR_SSC_EOS(data->start_class);
3639                 cl_and(data->start_class, and_withp);
3640             }
3641             flags &= ~SCF_DO_STCLASS;
3642         }
3643         else if (PL_regkind[OP(scan)] == EXACT) { /* But OP != EXACT! */
3644             I32 l = STR_LEN(scan);
3645             UV uc = *((U8*)STRING(scan));
3646
3647             /* Search for fixed substrings supports EXACT only. */
3648             if (flags & SCF_DO_SUBSTR) {
3649                 assert(data);
3650                 SCAN_COMMIT(pRExC_state, data, minlenp);
3651             }
3652             if (UTF) {
3653                 const U8 * const s = (U8 *)STRING(scan);
3654                 uc = utf8_to_uvchr_buf(s, s + l, NULL);
3655                 l = utf8_length(s, s + l);
3656             }
3657             if (has_exactf_sharp_s) {
3658                 RExC_seen |= REG_SEEN_EXACTF_SHARP_S;
3659             }
3660             min += l - min_subtract;
3661             assert (min >= 0);
3662             delta += min_subtract;
3663             if (flags & SCF_DO_SUBSTR) {
3664                 data->pos_min += l - min_subtract;
3665                 if (data->pos_min < 0) {
3666                     data->pos_min = 0;
3667                 }
3668                 data->pos_delta += min_subtract;
3669                 if (min_subtract) {
3670                     data->longest = &(data->longest_float);
3671                 }
3672             }
3673             if (flags & SCF_DO_STCLASS_AND) {
3674                 /* Check whether it is compatible with what we know already! */
3675                 int compat = 1;
3676                 if (uc >= 0x100 ||
3677                  (!(data->start_class->flags & ANYOF_LOCALE)
3678                   && !ANYOF_BITMAP_TEST(data->start_class, uc)
3679                   && !ANYOF_BITMAP_TEST(data->start_class, PL_fold_latin1[uc])))
3680                 {
3681                     compat = 0;
3682                 }
3683                 ANYOF_CLASS_ZERO(data->start_class);
3684                 ANYOF_BITMAP_ZERO(data->start_class);
3685                 if (compat) {
3686                     ANYOF_BITMAP_SET(data->start_class, uc);
3687                     CLEAR_SSC_EOS(data->start_class);
3688                     if (OP(scan) == EXACTFL) {
3689                         /* XXX This set is probably no longer necessary, and
3690                          * probably wrong as LOCALE now is on in the initial
3691                          * state */
3692                         data->start_class->flags |= ANYOF_LOCALE|ANYOF_LOC_FOLD;
3693                     }
3694                     else {
3695
3696                         /* Also set the other member of the fold pair.  In case
3697                          * that unicode semantics is called for at runtime, use
3698                          * the full latin1 fold.  (Can't do this for locale,
3699                          * because not known until runtime) */
3700                         ANYOF_BITMAP_SET(data->start_class, PL_fold_latin1[uc]);
3701
3702                         /* All other (EXACTFL handled above) folds except under
3703                          * /iaa that include s, S, and sharp_s also may include
3704                          * the others */
3705                         if (OP(scan) != EXACTFA) {
3706                             if (uc == 's' || uc == 'S') {
3707                                 ANYOF_BITMAP_SET(data->start_class,
3708                                                  LATIN_SMALL_LETTER_SHARP_S);
3709                             }
3710                             else if (uc == LATIN_SMALL_LETTER_SHARP_S) {
3711                                 ANYOF_BITMAP_SET(data->start_class, 's');
3712                                 ANYOF_BITMAP_SET(data->start_class, 'S');
3713                             }
3714                         }
3715                     }
3716                 }
3717                 else if (uc >= 0x100) {
3718                     int i;
3719                     for (i = 0; i < 256; i++){
3720                         if (_HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(i)) {
3721                             ANYOF_BITMAP_SET(data->start_class, i);
3722                         }
3723                     }
3724                 }
3725             }
3726             else if (flags & SCF_DO_STCLASS_OR) {
3727                 if (data->start_class->flags & ANYOF_LOC_FOLD) {
3728                     /* false positive possible if the class is case-folded.
3729                        Assume that the locale settings are the same... */
3730                     if (uc < 0x100) {
3731                         ANYOF_BITMAP_SET(data->start_class, uc);
3732                         if (OP(scan) != EXACTFL) {
3733
3734                             /* And set the other member of the fold pair, but
3735                              * can't do that in locale because not known until
3736                              * run-time */
3737                             ANYOF_BITMAP_SET(data->start_class,
3738                                              PL_fold_latin1[uc]);
3739
3740                             /* All folds except under /iaa that include s, S,
3741                              * and sharp_s also may include the others */
3742                             if (OP(scan) != EXACTFA) {
3743                                 if (uc == 's' || uc == 'S') {
3744                                     ANYOF_BITMAP_SET(data->start_class,
3745                                                    LATIN_SMALL_LETTER_SHARP_S);
3746                                 }
3747                                 else if (uc == LATIN_SMALL_LETTER_SHARP_S) {
3748                                     ANYOF_BITMAP_SET(data->start_class, 's');
3749                                     ANYOF_BITMAP_SET(data->start_class, 'S');
3750                                 }
3751                             }
3752                         }
3753                     }
3754                     CLEAR_SSC_EOS(data->start_class);
3755                 }
3756                 cl_and(data->start_class, and_withp);
3757             }
3758             flags &= ~SCF_DO_STCLASS;
3759         }
3760         else if (REGNODE_VARIES(OP(scan))) {
3761             I32 mincount, maxcount, minnext, deltanext, fl = 0;
3762             I32 f = flags, pos_before = 0;
3763             regnode * const oscan = scan;
3764             struct regnode_charclass_class this_class;
3765             struct regnode_charclass_class *oclass = NULL;
3766             I32 next_is_eval = 0;
3767
3768             switch (PL_regkind[OP(scan)]) {
3769             case WHILEM:                /* End of (?:...)* . */
3770                 scan = NEXTOPER(scan);
3771                 goto finish;
3772             case PLUS:
3773                 if (flags & (SCF_DO_SUBSTR | SCF_DO_STCLASS)) {
3774                     next = NEXTOPER(scan);
3775                     if (OP(next) == EXACT || (flags & SCF_DO_STCLASS)) {
3776                         mincount = 1;
3777                         maxcount = REG_INFTY;
3778                         next = regnext(scan);
3779                         scan = NEXTOPER(scan);
3780                         goto do_curly;
3781                     }
3782                 }
3783                 if (flags & SCF_DO_SUBSTR)
3784                     data->pos_min++;
3785                 min++;
3786                 /* Fall through. */
3787             case STAR:
3788                 if (flags & SCF_DO_STCLASS) {
3789                     mincount = 0;
3790                     maxcount = REG_INFTY;
3791                     next = regnext(scan);
3792                     scan = NEXTOPER(scan);
3793                     goto do_curly;
3794                 }
3795                 is_inf = is_inf_internal = 1;
3796                 scan = regnext(scan);
3797                 if (flags & SCF_DO_SUBSTR) {
3798                     SCAN_COMMIT(pRExC_state, data, minlenp); /* Cannot extend fixed substrings */
3799                     data->longest = &(data->longest_float);
3800                 }
3801                 goto optimize_curly_tail;
3802             case CURLY:
3803                 if (stopparen>0 && (OP(scan)==CURLYN || OP(scan)==CURLYM)
3804                     && (scan->flags == stopparen))
3805                 {
3806                     mincount = 1;
3807                     maxcount = 1;
3808                 } else {
3809                     mincount = ARG1(scan);
3810                     maxcount = ARG2(scan);
3811                 }
3812                 next = regnext(scan);
3813                 if (OP(scan) == CURLYX) {
3814                     I32 lp = (data ? *(data->last_closep) : 0);
3815                     scan->flags = ((lp <= (I32)U8_MAX) ? (U8)lp : U8_MAX);
3816                 }
3817                 scan = NEXTOPER(scan) + EXTRA_STEP_2ARGS;
3818                 next_is_eval = (OP(scan) == EVAL);
3819               do_curly:
3820                 if (flags & SCF_DO_SUBSTR) {
3821                     if (mincount == 0) SCAN_COMMIT(pRExC_state,data,minlenp); /* Cannot extend fixed substrings */
3822                     pos_before = data->pos_min;
3823                 }
3824                 if (data) {
3825                     fl = data->flags;
3826                     data->flags &= ~(SF_HAS_PAR|SF_IN_PAR|SF_HAS_EVAL);
3827                     if (is_inf)
3828                         data->flags |= SF_IS_INF;
3829                 }
3830                 if (flags & SCF_DO_STCLASS) {
3831                     cl_init(pRExC_state, &this_class);
3832                     oclass = data->start_class;
3833                     data->start_class = &this_class;
3834                     f |= SCF_DO_STCLASS_AND;
3835                     f &= ~SCF_DO_STCLASS_OR;
3836                 }
3837                 /* Exclude from super-linear cache processing any {n,m}
3838                    regops for which the combination of input pos and regex
3839                    pos is not enough information to determine if a match
3840                    will be possible.
3841
3842                    For example, in the regex /foo(bar\s*){4,8}baz/ with the
3843                    regex pos at the \s*, the prospects for a match depend not
3844                    only on the input position but also on how many (bar\s*)
3845                    repeats into the {4,8} we are. */
3846                if ((mincount > 1) || (maxcount > 1 && maxcount != REG_INFTY))
3847                     f &= ~SCF_WHILEM_VISITED_POS;
3848
3849                 /* This will finish on WHILEM, setting scan, or on NULL: */
3850                 minnext = study_chunk(pRExC_state, &scan, minlenp, &deltanext, 
3851                                       last, data, stopparen, recursed, NULL,
3852                                       (mincount == 0
3853                                         ? (f & ~SCF_DO_SUBSTR) : f),depth+1);
3854
3855                 if (flags & SCF_DO_STCLASS)
3856                     data->start_class = oclass;
3857                 if (mincount == 0 || minnext == 0) {
3858                     if (flags & SCF_DO_STCLASS_OR) {
3859                         cl_or(pRExC_state, data->start_class, &this_class);
3860                     }
3861                     else if (flags & SCF_DO_STCLASS_AND) {
3862                         /* Switch to OR mode: cache the old value of
3863                          * data->start_class */
3864                         INIT_AND_WITHP;
3865                         StructCopy(data->start_class, and_withp,
3866                                    struct regnode_charclass_class);
3867                         flags &= ~SCF_DO_STCLASS_AND;
3868                         StructCopy(&this_class, data->start_class,
3869                                    struct regnode_charclass_class);
3870                         flags |= SCF_DO_STCLASS_OR;
3871                         SET_SSC_EOS(data->start_class);
3872                     }
3873                 } else {                /* Non-zero len */
3874                     if (flags & SCF_DO_STCLASS_OR) {
3875                         cl_or(pRExC_state, data->start_class, &this_class);
3876                         cl_and(data->start_class, and_withp);
3877                     }
3878                     else if (flags & SCF_DO_STCLASS_AND)
3879                         cl_and(data->start_class, &this_class);
3880                     flags &= ~SCF_DO_STCLASS;
3881                 }
3882                 if (!scan)              /* It was not CURLYX, but CURLY. */
3883                     scan = next;
3884                 if ( /* ? quantifier ok, except for (?{ ... }) */
3885                     (next_is_eval || !(mincount == 0 && maxcount == 1))
3886                     && (minnext == 0) && (deltanext == 0)
3887                     && data && !(data->flags & (SF_HAS_PAR|SF_IN_PAR))
3888                     && maxcount <= REG_INFTY/3) /* Complement check for big count */
3889                 {
3890                     /* Fatal warnings may leak the regexp without this: */
3891                     SAVEFREESV(RExC_rx_sv);
3892                     ckWARNreg(RExC_parse,
3893                               "Quantifier unexpected on zero-length expression");
3894                     (void)ReREFCNT_inc(RExC_rx_sv);
3895                 }
3896
3897                 min += minnext * mincount;
3898                 is_inf_internal |= deltanext == I32_MAX
3899                                      || (maxcount == REG_INFTY && minnext + deltanext > 0);
3900                 is_inf |= is_inf_internal;
3901                 if (is_inf)
3902                     delta = I32_MAX;
3903                 else
3904                     delta += (minnext + deltanext) * maxcount - minnext * mincount;
3905
3906                 /* Try powerful optimization CURLYX => CURLYN. */
3907                 if (  OP(oscan) == CURLYX && data
3908                       && data->flags & SF_IN_PAR
3909                       && !(data->flags & SF_HAS_EVAL)
3910                       && !deltanext && minnext == 1 ) {
3911                     /* Try to optimize to CURLYN.  */
3912                     regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS;
3913                     regnode * const nxt1 = nxt;
3914 #ifdef DEBUGGING
3915                     regnode *nxt2;
3916 #endif
3917
3918                     /* Skip open. */
3919                     nxt = regnext(nxt);
3920                     if (!REGNODE_SIMPLE(OP(nxt))
3921                         && !(PL_regkind[OP(nxt)] == EXACT
3922                              && STR_LEN(nxt) == 1))
3923                         goto nogo;
3924 #ifdef DEBUGGING
3925                     nxt2 = nxt;
3926 #endif
3927                     nxt = regnext(nxt);
3928                     if (OP(nxt) != CLOSE)
3929                         goto nogo;
3930                     if (RExC_open_parens) {
3931                         RExC_open_parens[ARG(nxt1)-1]=oscan; /*open->CURLYM*/
3932                         RExC_close_parens[ARG(nxt1)-1]=nxt+2; /*close->while*/
3933                     }
3934                     /* Now we know that nxt2 is the only contents: */
3935                     oscan->flags = (U8)ARG(nxt);
3936                     OP(oscan) = CURLYN;
3937                     OP(nxt1) = NOTHING; /* was OPEN. */
3938
3939 #ifdef DEBUGGING
3940                     OP(nxt1 + 1) = OPTIMIZED; /* was count. */
3941                     NEXT_OFF(nxt1+ 1) = 0; /* just for consistency. */
3942                     NEXT_OFF(nxt2) = 0; /* just for consistency with CURLY. */
3943                     OP(nxt) = OPTIMIZED;        /* was CLOSE. */
3944                     OP(nxt + 1) = OPTIMIZED; /* was count. */
3945                     NEXT_OFF(nxt+ 1) = 0; /* just for consistency. */
3946 #endif
3947                 }
3948               nogo:
3949
3950                 /* Try optimization CURLYX => CURLYM. */
3951                 if (  OP(oscan) == CURLYX && data
3952                       && !(data->flags & SF_HAS_PAR)
3953                       && !(data->flags & SF_HAS_EVAL)
3954                       && !deltanext     /* atom is fixed width */
3955                       && minnext != 0   /* CURLYM can't handle zero width */
3956                       && ! (RExC_seen & REG_SEEN_EXACTF_SHARP_S) /* Nor \xDF */
3957                 ) {
3958                     /* XXXX How to optimize if data == 0? */
3959                     /* Optimize to a simpler form.  */
3960                     regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN */
3961                     regnode *nxt2;
3962
3963                     OP(oscan) = CURLYM;
3964                     while ( (nxt2 = regnext(nxt)) /* skip over embedded stuff*/
3965                             && (OP(nxt2) != WHILEM))
3966                         nxt = nxt2;
3967                     OP(nxt2)  = SUCCEED; /* Whas WHILEM */
3968                     /* Need to optimize away parenths. */
3969                     if ((data->flags & SF_IN_PAR) && OP(nxt) == CLOSE) {
3970                         /* Set the parenth number.  */
3971                         regnode *nxt1 = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN*/
3972
3973                         oscan->flags = (U8)ARG(nxt);
3974                         if (RExC_open_parens) {
3975                             RExC_open_parens[ARG(nxt1)-1]=oscan; /*open->CURLYM*/
3976                             RExC_close_parens[ARG(nxt1)-1]=nxt2+1; /*close->NOTHING*/
3977                         }
3978                         OP(nxt1) = OPTIMIZED;   /* was OPEN. */
3979                         OP(nxt) = OPTIMIZED;    /* was CLOSE. */
3980
3981 #ifdef DEBUGGING
3982                         OP(nxt1 + 1) = OPTIMIZED; /* was count. */
3983                         OP(nxt + 1) = OPTIMIZED; /* was count. */
3984                         NEXT_OFF(nxt1 + 1) = 0; /* just for consistency. */
3985                         NEXT_OFF(nxt + 1) = 0; /* just for consistency. */
3986 #endif
3987 #if 0
3988                         while ( nxt1 && (OP(nxt1) != WHILEM)) {
3989                             regnode *nnxt = regnext(nxt1);
3990                             if (nnxt == nxt) {
3991                                 if (reg_off_by_arg[OP(nxt1)])
3992                                     ARG_SET(nxt1, nxt2 - nxt1);
3993                                 else if (nxt2 - nxt1 < U16_MAX)
3994                                     NEXT_OFF(nxt1) = nxt2 - nxt1;
3995                                 else
3996                                     OP(nxt) = NOTHING;  /* Cannot beautify */
3997                             }
3998                             nxt1 = nnxt;
3999                         }
4000 #endif
4001                         /* Optimize again: */
4002                         study_chunk(pRExC_state, &nxt1, minlenp, &deltanext, nxt,
4003                                     NULL, stopparen, recursed, NULL, 0,depth+1);
4004                     }
4005                     else
4006                         oscan->flags = 0;
4007                 }
4008                 else if ((OP(oscan) == CURLYX)
4009                          && (flags & SCF_WHILEM_VISITED_POS)
4010                          /* See the comment on a similar expression above.
4011                             However, this time it's not a subexpression
4012                             we care about, but the expression itself. */
4013                          && (maxcount == REG_INFTY)
4014                          && data && ++data->whilem_c < 16) {
4015                     /* This stays as CURLYX, we can put the count/of pair. */
4016                     /* Find WHILEM (as in regexec.c) */
4017                     regnode *nxt = oscan + NEXT_OFF(oscan);
4018
4019                     if (OP(PREVOPER(nxt)) == NOTHING) /* LONGJMP */
4020                         nxt += ARG(nxt);
4021                     PREVOPER(nxt)->flags = (U8)(data->whilem_c
4022                         | (RExC_whilem_seen << 4)); /* On WHILEM */
4023                 }
4024                 if (data && fl & (SF_HAS_PAR|SF_IN_PAR))
4025                     pars++;
4026                 if (flags & SCF_DO_SUBSTR) {
4027                     SV *last_str = NULL;
4028                     int counted = mincount != 0;
4029
4030                     if (data->last_end > 0 && mincount != 0) { /* Ends with a string. */
4031 #if defined(SPARC64_GCC_WORKAROUND)
4032                         I32 b = 0;
4033                         STRLEN l = 0;
4034                         const char *s = NULL;
4035                         I32 old = 0;
4036
4037                         if (pos_before >= data->last_start_min)
4038                             b = pos_before;
4039                         else
4040                             b = data->last_start_min;
4041
4042                         l = 0;
4043                         s = SvPV_const(data->last_found, l);
4044                         old = b - data->last_start_min;
4045
4046 #else
4047                         I32 b = pos_before >= data->last_start_min
4048                             ? pos_before : data->last_start_min;
4049                         STRLEN l;
4050                         const char * const s = SvPV_const(data->last_found, l);
4051                         I32 old = b - data->last_start_min;
4052 #endif
4053
4054                         if (UTF)
4055                             old = utf8_hop((U8*)s, old) - (U8*)s;
4056                         l -= old;
4057                         /* Get the added string: */
4058                         last_str = newSVpvn_utf8(s  + old, l, UTF);
4059                         if (deltanext == 0 && pos_before == b) {
4060                             /* What was added is a constant string */
4061                             if (mincount > 1) {
4062                                 SvGROW(last_str, (mincount * l) + 1);
4063                                 repeatcpy(SvPVX(last_str) + l,
4064                                           SvPVX_const(last_str), l, mincount - 1);
4065                                 SvCUR_set(last_str, SvCUR(last_str) * mincount);
4066                                 /* Add additional parts. */
4067                                 SvCUR_set(data->last_found,
4068                                           SvCUR(data->last_found) - l);
4069                                 sv_catsv(data->last_found, last_str);
4070                                 {
4071                                     SV * sv = data->last_found;
4072                                     MAGIC *mg =
4073                                         SvUTF8(sv) && SvMAGICAL(sv) ?
4074                                         mg_find(sv, PERL_MAGIC_utf8) : NULL;
4075                                     if (mg && mg->mg_len >= 0)
4076                                         mg->mg_len += CHR_SVLEN(last_str) - l;
4077                                 }
4078                                 data->last_end += l * (mincount - 1);
4079                             }
4080                         } else {
4081                             /* start offset must point into the last copy */
4082                             data->last_start_min += minnext * (mincount - 1);
4083                             data->last_start_max += is_inf ? I32_MAX
4084                                 : (maxcount - 1) * (minnext + data->pos_delta);
4085                         }
4086                     }
4087                     /* It is counted once already... */
4088                     data->pos_min += minnext * (mincount - counted);
4089 #if 0
4090 PerlIO_printf(Perl_debug_log, "counted=%d deltanext=%d I32_MAX=%d minnext=%d maxcount=%d mincount=%d\n",
4091     counted, deltanext, I32_MAX, minnext, maxcount, mincount);
4092 if (deltanext != I32_MAX)
4093 PerlIO_printf(Perl_debug_log, "LHS=%d RHS=%d\n", -counted * deltanext + (minnext + deltanext) * maxcount - minnext * mincount, I32_MAX - data->pos_delta);
4094 #endif
4095                     if (deltanext == I32_MAX || -counted * deltanext + (minnext + deltanext) * maxcount - minnext * mincount >= I32_MAX - data->pos_delta)
4096                         data->pos_delta = I32_MAX;
4097                     else
4098                         data->pos_delta += - counted * deltanext +
4099                         (minnext + deltanext) * maxcount - minnext * mincount;
4100                     if (mincount != maxcount) {
4101                          /* Cannot extend fixed substrings found inside
4102                             the group.  */
4103                         SCAN_COMMIT(pRExC_state,data,minlenp);
4104                         if (mincount && last_str) {
4105                             SV * const sv = data->last_found;
4106                             MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
4107                                 mg_find(sv, PERL_MAGIC_utf8) : NULL;
4108
4109                             if (mg)
4110                                 mg->mg_len = -1;
4111                             sv_setsv(sv, last_str);
4112                             data->last_end = data->pos_min;
4113                             data->last_start_min =
4114                                 data->pos_min - CHR_SVLEN(last_str);
4115                             data->last_start_max = is_inf
4116                                 ? I32_MAX
4117                                 : data->pos_min + data->pos_delta
4118                                 - CHR_SVLEN(last_str);
4119                         }
4120                         data->longest = &(data->longest_float);
4121                     }
4122                     SvREFCNT_dec(last_str);
4123                 }
4124                 if (data && (fl & SF_HAS_EVAL))
4125                     data->flags |= SF_HAS_EVAL;
4126               optimize_curly_tail:
4127                 if (OP(oscan) != CURLYX) {
4128                     while (PL_regkind[OP(next = regnext(oscan))] == NOTHING
4129                            && NEXT_OFF(next))
4130                         NEXT_OFF(oscan) += NEXT_OFF(next);
4131                 }
4132                 continue;
4133             default:                    /* REF, and CLUMP only? */
4134                 if (flags & SCF_DO_SUBSTR) {
4135                     SCAN_COMMIT(pRExC_state,data,minlenp);      /* Cannot expect anything... */
4136                     data->longest = &(data->longest_float);
4137                 }
4138                 is_inf = is_inf_internal = 1;
4139                 if (flags & SCF_DO_STCLASS_OR)
4140                     cl_anything(pRExC_state, data->start_class);
4141                 flags &= ~SCF_DO_STCLASS;
4142                 break;
4143             }
4144         }
4145         else if (OP(scan) == LNBREAK) {
4146             if (flags & SCF_DO_STCLASS) {
4147                 int value = 0;
4148                 CLEAR_SSC_EOS(data->start_class); /* No match on empty */
4149                 if (flags & SCF_DO_STCLASS_AND) {
4150                     for (value = 0; value < 256; value++)
4151                         if (!is_VERTWS_cp(value))
4152                             ANYOF_BITMAP_CLEAR(data->start_class, value);
4153                 }
4154                 else {
4155                     for (value = 0; value < 256; value++)
4156                         if (is_VERTWS_cp(value))
4157                             ANYOF_BITMAP_SET(data->start_class, value);
4158                 }
4159                 if (flags & SCF_DO_STCLASS_OR)
4160                     cl_and(data->start_class, and_withp);
4161                 flags &= ~SCF_DO_STCLASS;
4162             }
4163             min++;
4164             delta++;    /* Because of the 2 char string cr-lf */
4165             if (flags & SCF_DO_SUBSTR) {
4166                 SCAN_COMMIT(pRExC_state,data,minlenp);  /* Cannot expect anything... */
4167                 data->pos_min += 1;
4168                 data->pos_delta += 1;
4169                 data->longest = &(data->longest_float);
4170             }
4171         }
4172         else if (REGNODE_SIMPLE(OP(scan))) {
4173             int value = 0;
4174
4175             if (flags & SCF_DO_SUBSTR) {
4176                 SCAN_COMMIT(pRExC_state,data,minlenp);
4177                 data->pos_min++;
4178             }
4179             min++;
4180             if (flags & SCF_DO_STCLASS) {
4181                 int loop_max = 256;
4182                 CLEAR_SSC_EOS(data->start_class); /* No match on empty */
4183
4184                 /* Some of the logic below assumes that switching
4185                    locale on will only add false positives. */
4186                 switch (PL_regkind[OP(scan)]) {
4187                     U8 classnum;
4188
4189                 case SANY:
4190                 default:
4191 #ifdef DEBUGGING
4192                    Perl_croak(aTHX_ "panic: unexpected simple REx opcode %d", OP(scan));
4193 #endif
4194                  do_default:
4195                     if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
4196                         cl_anything(pRExC_state, data->start_class);
4197                     break;
4198                 case REG_ANY:
4199                     if (OP(scan) == SANY)
4200                         goto do_default;
4201                     if (flags & SCF_DO_STCLASS_OR) { /* Everything but \n */
4202                         value = (ANYOF_BITMAP_TEST(data->start_class,'\n')
4203                                 || ANYOF_CLASS_TEST_ANY_SET(data->start_class));
4204                         cl_anything(pRExC_state, data->start_class);
4205                     }
4206                     if (flags & SCF_DO_STCLASS_AND || !value)
4207                         ANYOF_BITMAP_CLEAR(data->start_class,'\n');
4208                     break;
4209                 case ANYOF:
4210                     if (flags & SCF_DO_STCLASS_AND)
4211                         cl_and(data->start_class,
4212                                (struct regnode_charclass_class*)scan);
4213                     else
4214                         cl_or(pRExC_state, data->start_class,
4215                               (struct regnode_charclass_class*)scan);
4216                     break;
4217                 case POSIXA:
4218                     loop_max = 128;
4219                     /* FALL THROUGH */
4220                 case POSIXL:
4221                 case POSIXD:
4222                 case POSIXU:
4223                     classnum = FLAGS(scan);
4224                     if (flags & SCF_DO_STCLASS_AND) {
4225                         if (!(data->start_class->flags & ANYOF_LOCALE)) {
4226                             ANYOF_CLASS_CLEAR(data->start_class, classnum_to_namedclass(classnum) + 1);
4227                             for (value = 0; value < loop_max; value++) {
4228                                 if (! _generic_isCC(UNI_TO_NATIVE(value), classnum)) {
4229                                     ANYOF_BITMAP_CLEAR(data->start_class, UNI_TO_NATIVE(value));
4230                                 }
4231                             }
4232                         }
4233                     }
4234                     else {
4235                         if (data->start_class->flags & ANYOF_LOCALE) {
4236                             ANYOF_CLASS_SET(data->start_class, classnum_to_namedclass(classnum));
4237                         }
4238                         else {
4239
4240                         /* Even if under locale, set the bits for non-locale
4241                          * in case it isn't a true locale-node.  This will
4242                          * create false positives if it truly is locale */
4243                         for (value = 0; value < loop_max; value++) {
4244                             if (_generic_isCC(UNI_TO_NATIVE(value), classnum)) {
4245                                 ANYOF_BITMAP_SET(data->start_class, UNI_TO_NATIVE(value));
4246                             }
4247                         }
4248                         }
4249                     }
4250                     break;
4251                 case NPOSIXA:
4252                     loop_max = 128;
4253                     /* FALL THROUGH */
4254                 case NPOSIXL:
4255                 case NPOSIXU:
4256                 case NPOSIXD:
4257                     classnum = FLAGS(scan);
4258                     if (flags & SCF_DO_STCLASS_AND) {
4259                         if (!(data->start_class->flags & ANYOF_LOCALE)) {
4260                             ANYOF_CLASS_CLEAR(data->start_class, classnum_to_namedclass(classnum));
4261                             for (value = 0; value < loop_max; value++) {
4262                                 if (_generic_isCC(UNI_TO_NATIVE(value), classnum)) {
4263                                     ANYOF_BITMAP_CLEAR(data->start_class, UNI_TO_NATIVE(value));
4264                                 }
4265                             }
4266                         }
4267                     }
4268                     else {
4269                         if (data->start_class->flags & ANYOF_LOCALE) {
4270                             ANYOF_CLASS_SET(data->start_class, classnum_to_namedclass(classnum) + 1);
4271                         }
4272                         else {
4273
4274                         /* Even if under locale, set the bits for non-locale in
4275                          * case it isn't a true locale-node.  This will create
4276                          * false positives if it truly is locale */
4277                         for (value = 0; value < loop_max; value++) {
4278                             if (! _generic_isCC(UNI_TO_NATIVE(value), classnum)) {
4279                                 ANYOF_BITMAP_SET(data->start_class, UNI_TO_NATIVE(value));
4280                             }
4281                         }
4282                         if (PL_regkind[OP(scan)] == NPOSIXD) {
4283                             data->start_class->flags |= ANYOF_NON_UTF8_LATIN1_ALL;
4284                         }
4285                         }
4286                     }
4287                     break;
4288                 }
4289                 if (flags & SCF_DO_STCLASS_OR)
4290                     cl_and(data->start_class, and_withp);
4291                 flags &= ~SCF_DO_STCLASS;
4292             }
4293         }
4294         else if (PL_regkind[OP(scan)] == EOL && flags & SCF_DO_SUBSTR) {
4295             data->flags |= (OP(scan) == MEOL
4296                             ? SF_BEFORE_MEOL
4297                             : SF_BEFORE_SEOL);
4298             SCAN_COMMIT(pRExC_state, data, minlenp);
4299
4300         }
4301         else if (  PL_regkind[OP(scan)] == BRANCHJ
4302                  /* Lookbehind, or need to calculate parens/evals/stclass: */
4303                    && (scan->flags || data || (flags & SCF_DO_STCLASS))
4304                    && (OP(scan) == IFMATCH || OP(scan) == UNLESSM)) {
4305             if ( OP(scan) == UNLESSM &&
4306                  scan->flags == 0 &&
4307                  OP(NEXTOPER(NEXTOPER(scan))) == NOTHING &&
4308                  OP(regnext(NEXTOPER(NEXTOPER(scan)))) == SUCCEED
4309             ) {
4310                 regnode *opt;
4311                 regnode *upto= regnext(scan);
4312                 DEBUG_PARSE_r({
4313                     SV * const mysv_val=sv_newmortal();
4314                     DEBUG_STUDYDATA("OPFAIL",data,depth);
4315
4316                     /*DEBUG_PARSE_MSG("opfail");*/
4317                     regprop(RExC_rx, mysv_val, upto);
4318                     PerlIO_printf(Perl_debug_log, "~ replace with OPFAIL pointed at %s (%"IVdf") offset %"IVdf"\n",
4319                                   SvPV_nolen_const(mysv_val),
4320                                   (IV)REG_NODE_NUM(upto),
4321                                   (IV)(upto - scan)
4322                     );
4323                 });
4324                 OP(scan) = OPFAIL;
4325                 NEXT_OFF(scan) = upto - scan;
4326                 for (opt= scan + 1; opt < upto ; opt++)
4327                     OP(opt) = OPTIMIZED;
4328                 scan= upto;
4329                 continue;
4330             }
4331             if ( !PERL_ENABLE_POSITIVE_ASSERTION_STUDY 
4332                 || OP(scan) == UNLESSM )
4333             {
4334                 /* Negative Lookahead/lookbehind
4335                    In this case we can't do fixed string optimisation.
4336                 */
4337
4338                 I32 deltanext, minnext, fake = 0;
4339                 regnode *nscan;
4340                 struct regnode_charclass_class intrnl;
4341                 int f = 0;
4342
4343                 data_fake.flags = 0;
4344                 if (data) {
4345                     data_fake.whilem_c = data->whilem_c;
4346                     data_fake.last_closep = data->last_closep;
4347                 }
4348                 else
4349                     data_fake.last_closep = &fake;
4350                 data_fake.pos_delta = delta;
4351                 if ( flags & SCF_DO_STCLASS && !scan->flags
4352                      && OP(scan) == IFMATCH ) { /* Lookahead */
4353                     cl_init(pRExC_state, &intrnl);
4354                     data_fake.start_class = &intrnl;
4355                     f |= SCF_DO_STCLASS_AND;
4356                 }
4357                 if (flags & SCF_WHILEM_VISITED_POS)
4358                     f |= SCF_WHILEM_VISITED_POS;
4359                 next = regnext(scan);
4360                 nscan = NEXTOPER(NEXTOPER(scan));
4361                 minnext = study_chunk(pRExC_state, &nscan, minlenp, &deltanext, 
4362                     last, &data_fake, stopparen, recursed, NULL, f, depth+1);
4363                 if (scan->flags) {
4364                     if (deltanext) {
4365                         FAIL("Variable length lookbehind not implemented");
4366                     }
4367                     else if (minnext > (I32)U8_MAX) {
4368                         FAIL2("Lookbehind longer than %"UVuf" not implemented", (UV)U8_MAX);
4369                     }
4370                     scan->flags = (U8)minnext;
4371                 }
4372                 if (data) {
4373                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4374                         pars++;
4375                     if (data_fake.flags & SF_HAS_EVAL)
4376                         data->flags |= SF_HAS_EVAL;
4377                     data->whilem_c = data_fake.whilem_c;
4378                 }
4379                 if (f & SCF_DO_STCLASS_AND) {
4380                     if (flags & SCF_DO_STCLASS_OR) {
4381                         /* OR before, AND after: ideally we would recurse with
4382                          * data_fake to get the AND applied by study of the
4383                          * remainder of the pattern, and then derecurse;
4384                          * *** HACK *** for now just treat as "no information".
4385                          * See [perl #56690].
4386                          */
4387                         cl_init(pRExC_state, data->start_class);
4388                     }  else {
4389                         /* AND before and after: combine and continue */
4390                         const int was = TEST_SSC_EOS(data->start_class);
4391
4392                         cl_and(data->start_class, &intrnl);
4393                         if (was)
4394                             SET_SSC_EOS(data->start_class);
4395                     }
4396                 }
4397             }
4398 #if PERL_ENABLE_POSITIVE_ASSERTION_STUDY
4399             else {
4400                 /* Positive Lookahead/lookbehind
4401                    In this case we can do fixed string optimisation,
4402                    but we must be careful about it. Note in the case of
4403                    lookbehind the positions will be offset by the minimum
4404                    length of the pattern, something we won't know about
4405                    until after the recurse.
4406                 */
4407                 I32 deltanext, fake = 0;
4408                 regnode *nscan;
4409                 struct regnode_charclass_class intrnl;
4410                 int f = 0;
4411                 /* We use SAVEFREEPV so that when the full compile 
4412                     is finished perl will clean up the allocated 
4413                     minlens when it's all done. This way we don't
4414                     have to worry about freeing them when we know
4415                     they wont be used, which would be a pain.
4416                  */
4417                 I32 *minnextp;
4418                 Newx( minnextp, 1, I32 );
4419                 SAVEFREEPV(minnextp);
4420
4421                 if (data) {
4422                     StructCopy(data, &data_fake, scan_data_t);
4423                     if ((flags & SCF_DO_SUBSTR) && data->last_found) {
4424                         f |= SCF_DO_SUBSTR;
4425                         if (scan->flags) 
4426                             SCAN_COMMIT(pRExC_state, &data_fake,minlenp);
4427                         data_fake.last_found=newSVsv(data->last_found);
4428                     }
4429                 }
4430                 else
4431                     data_fake.last_closep = &fake;
4432                 data_fake.flags = 0;
4433                 data_fake.pos_delta = delta;
4434                 if (is_inf)
4435                     data_fake.flags |= SF_IS_INF;
4436                 if ( flags & SCF_DO_STCLASS && !scan->flags
4437                      && OP(scan) == IFMATCH ) { /* Lookahead */
4438                     cl_init(pRExC_state, &intrnl);
4439                     data_fake.start_class = &intrnl;
4440                     f |= SCF_DO_STCLASS_AND;
4441                 }
4442                 if (flags & SCF_WHILEM_VISITED_POS)
4443                     f |= SCF_WHILEM_VISITED_POS;
4444                 next = regnext(scan);
4445                 nscan = NEXTOPER(NEXTOPER(scan));
4446
4447                 *minnextp = study_chunk(pRExC_state, &nscan, minnextp, &deltanext, 
4448                     last, &data_fake, stopparen, recursed, NULL, f,depth+1);
4449                 if (scan->flags) {
4450                     if (deltanext) {
4451                         FAIL("Variable length lookbehind not implemented");
4452                     }
4453                     else if (*minnextp > (I32)U8_MAX) {
4454                         FAIL2("Lookbehind longer than %"UVuf" not implemented", (UV)U8_MAX);
4455                     }
4456                     scan->flags = (U8)*minnextp;
4457                 }
4458
4459                 *minnextp += min;
4460
4461                 if (f & SCF_DO_STCLASS_AND) {
4462                     const int was = TEST_SSC_EOS(data.start_class);
4463
4464                     cl_and(data->start_class, &intrnl);
4465                     if (was)
4466                         SET_SSC_EOS(data->start_class);
4467                 }
4468                 if (data) {
4469                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4470                         pars++;
4471                     if (data_fake.flags & SF_HAS_EVAL)
4472                         data->flags |= SF_HAS_EVAL;
4473                     data->whilem_c = data_fake.whilem_c;
4474                     if ((flags & SCF_DO_SUBSTR) && data_fake.last_found) {
4475                         if (RExC_rx->minlen<*minnextp)
4476                             RExC_rx->minlen=*minnextp;
4477                         SCAN_COMMIT(pRExC_state, &data_fake, minnextp);
4478                         SvREFCNT_dec_NN(data_fake.last_found);
4479                         
4480                         if ( data_fake.minlen_fixed != minlenp ) 
4481                         {
4482                             data->offset_fixed= data_fake.offset_fixed;
4483                             data->minlen_fixed= data_fake.minlen_fixed;
4484                             data->lookbehind_fixed+= scan->flags;
4485                         }
4486                         if ( data_fake.minlen_float != minlenp )
4487                         {
4488                             data->minlen_float= data_fake.minlen_float;
4489                             data->offset_float_min=data_fake.offset_float_min;
4490                             data->offset_float_max=data_fake.offset_float_max;
4491                             data->lookbehind_float+= scan->flags;
4492                         }
4493                     }
4494                 }
4495             }
4496 #endif
4497         }
4498         else if (OP(scan) == OPEN) {
4499             if (stopparen != (I32)ARG(scan))
4500                 pars++;
4501         }
4502         else if (OP(scan) == CLOSE) {
4503             if (stopparen == (I32)ARG(scan)) {
4504                 break;
4505             }
4506             if ((I32)ARG(scan) == is_par) {
4507                 next = regnext(scan);
4508
4509                 if ( next && (OP(next) != WHILEM) && next < last)
4510                     is_par = 0;         /* Disable optimization */
4511             }
4512             if (data)
4513                 *(data->last_closep) = ARG(scan);
4514         }
4515         else if (OP(scan) == EVAL) {
4516                 if (data)
4517                     data->flags |= SF_HAS_EVAL;
4518         }
4519         else if ( PL_regkind[OP(scan)] == ENDLIKE ) {
4520             if (flags & SCF_DO_SUBSTR) {
4521                 SCAN_COMMIT(pRExC_state,data,minlenp);
4522                 flags &= ~SCF_DO_SUBSTR;
4523             }
4524             if (data && OP(scan)==ACCEPT) {
4525                 data->flags |= SCF_SEEN_ACCEPT;
4526                 if (stopmin > min)
4527                     stopmin = min;
4528             }
4529         }
4530         else if (OP(scan) == LOGICAL && scan->flags == 2) /* Embedded follows */
4531         {
4532                 if (flags & SCF_DO_SUBSTR) {
4533                     SCAN_COMMIT(pRExC_state,data,minlenp);
4534                     data->longest = &(data->longest_float);
4535                 }
4536                 is_inf = is_inf_internal = 1;
4537                 if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
4538                     cl_anything(pRExC_state, data->start_class);
4539                 flags &= ~SCF_DO_STCLASS;
4540         }
4541         else if (OP(scan) == GPOS) {
4542             if (!(RExC_rx->extflags & RXf_GPOS_FLOAT) &&
4543                 !(delta || is_inf || (data && data->pos_delta))) 
4544             {
4545                 if (!(RExC_rx->extflags & RXf_ANCH) && (flags & SCF_DO_SUBSTR))
4546                     RExC_rx->extflags |= RXf_ANCH_GPOS;
4547                 if (RExC_rx->gofs < (U32)min)
4548                     RExC_rx->gofs = min;
4549             } else {
4550                 RExC_rx->extflags |= RXf_GPOS_FLOAT;
4551                 RExC_rx->gofs = 0;
4552             }       
4553         }
4554 #ifdef TRIE_STUDY_OPT
4555 #ifdef FULL_TRIE_STUDY
4556         else if (PL_regkind[OP(scan)] == TRIE) {
4557             /* NOTE - There is similar code to this block above for handling
4558                BRANCH nodes on the initial study.  If you change stuff here
4559                check there too. */
4560             regnode *trie_node= scan;
4561             regnode *tail= regnext(scan);
4562             reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
4563             I32 max1 = 0, min1 = I32_MAX;
4564             struct regnode_charclass_class accum;
4565
4566             if (flags & SCF_DO_SUBSTR) /* XXXX Add !SUSPEND? */
4567                 SCAN_COMMIT(pRExC_state, data,minlenp); /* Cannot merge strings after this. */
4568             if (flags & SCF_DO_STCLASS)
4569                 cl_init_zero(pRExC_state, &accum);
4570                 
4571             if (!trie->jump) {
4572                 min1= trie->minlen;
4573                 max1= trie->maxlen;
4574             } else {
4575                 const regnode *nextbranch= NULL;
4576                 U32 word;
4577                 
4578                 for ( word=1 ; word <= trie->wordcount ; word++) 
4579                 {
4580                     I32 deltanext=0, minnext=0, f = 0, fake;
4581                     struct regnode_charclass_class this_class;
4582                     
4583                     data_fake.flags = 0;
4584                     if (data) {
4585                         data_fake.whilem_c = data->whilem_c;
4586                         data_fake.last_closep = data->last_closep;
4587                     }
4588                     else
4589                         data_fake.last_closep = &fake;
4590                     data_fake.pos_delta = delta;
4591                     if (flags & SCF_DO_STCLASS) {
4592                         cl_init(pRExC_state, &this_class);
4593                         data_fake.start_class = &this_class;
4594                         f = SCF_DO_STCLASS_AND;
4595                     }
4596                     if (flags & SCF_WHILEM_VISITED_POS)
4597                         f |= SCF_WHILEM_VISITED_POS;
4598     
4599                     if (trie->jump[word]) {
4600                         if (!nextbranch)
4601                             nextbranch = trie_node + trie->jump[0];
4602                         scan= trie_node + trie->jump[word];
4603                         /* We go from the jump point to the branch that follows
4604                            it. Note this means we need the vestigal unused branches
4605                            even though they arent otherwise used.
4606                          */
4607                         minnext = study_chunk(pRExC_state, &scan, minlenp, 
4608                             &deltanext, (regnode *)nextbranch, &data_fake, 
4609                             stopparen, recursed, NULL, f,depth+1);
4610                     }
4611                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
4612                         nextbranch= regnext((regnode*)nextbranch);
4613                     
4614                     if (min1 > (I32)(minnext + trie->minlen))
4615                         min1 = minnext + trie->minlen;
4616                     if (deltanext == I32_MAX) {
4617                         is_inf = is_inf_internal = 1;
4618                         max1 = I32_MAX;
4619                     } else if (max1 < (I32)(minnext + deltanext + trie->maxlen))
4620                         max1 = minnext + deltanext + trie->maxlen;
4621                     
4622                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4623                         pars++;
4624                     if (data_fake.flags & SCF_SEEN_ACCEPT) {
4625                         if ( stopmin > min + min1) 
4626                             stopmin = min + min1;
4627                         flags &= ~SCF_DO_SUBSTR;
4628                         if (data)
4629                             data->flags |= SCF_SEEN_ACCEPT;
4630                     }
4631                     if (data) {
4632                         if (data_fake.flags & SF_HAS_EVAL)
4633                             data->flags |= SF_HAS_EVAL;
4634                         data->whilem_c = data_fake.whilem_c;
4635                     }
4636                     if (flags & SCF_DO_STCLASS)
4637                         cl_or(pRExC_state, &accum, &this_class);
4638                 }
4639             }
4640             if (flags & SCF_DO_SUBSTR) {
4641                 data->pos_min += min1;
4642                 data->pos_delta += max1 - min1;
4643                 if (max1 != min1 || is_inf)
4644                     data->longest = &(data->longest_float);
4645             }
4646             min += min1;
4647             delta += max1 - min1;
4648             if (flags & SCF_DO_STCLASS_OR) {
4649                 cl_or(pRExC_state, data->start_class, &accum);
4650                 if (min1) {
4651                     cl_and(data->start_class, and_withp);
4652                     flags &= ~SCF_DO_STCLASS;
4653                 }
4654             }
4655             else if (flags & SCF_DO_STCLASS_AND) {
4656                 if (min1) {
4657                     cl_and(data->start_class, &accum);
4658                     flags &= ~SCF_DO_STCLASS;
4659                 }
4660                 else {
4661                     /* Switch to OR mode: cache the old value of
4662                      * data->start_class */
4663                     INIT_AND_WITHP;
4664                     StructCopy(data->start_class, and_withp,
4665                                struct regnode_charclass_class);
4666                     flags &= ~SCF_DO_STCLASS_AND;
4667                     StructCopy(&accum, data->start_class,
4668                                struct regnode_charclass_class);
4669                     flags |= SCF_DO_STCLASS_OR;
4670                     SET_SSC_EOS(data->start_class);
4671                 }
4672             }
4673             scan= tail;
4674             continue;
4675         }
4676 #else
4677         else if (PL_regkind[OP(scan)] == TRIE) {
4678             reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
4679             U8*bang=NULL;
4680             
4681             min += trie->minlen;
4682             delta += (trie->maxlen - trie->minlen);
4683             flags &= ~SCF_DO_STCLASS; /* xxx */
4684             if (flags & SCF_DO_SUBSTR) {
4685                 SCAN_COMMIT(pRExC_state,data,minlenp);  /* Cannot expect anything... */
4686                 data->pos_min += trie->minlen;
4687                 data->pos_delta += (trie->maxlen - trie->minlen);
4688                 if (trie->maxlen != trie->minlen)
4689                     data->longest = &(data->longest_float);
4690             }
4691             if (trie->jump) /* no more substrings -- for now /grr*/
4692                 flags &= ~SCF_DO_SUBSTR; 
4693         }
4694 #endif /* old or new */
4695 #endif /* TRIE_STUDY_OPT */
4696
4697         /* Else: zero-length, ignore. */
4698         scan = regnext(scan);
4699     }
4700     if (frame) {
4701         last = frame->last;
4702         scan = frame->next;
4703         stopparen = frame->stop;
4704         frame = frame->prev;
4705         goto fake_study_recurse;
4706     }
4707
4708   finish:
4709     assert(!frame);
4710     DEBUG_STUDYDATA("pre-fin:",data,depth);
4711
4712     *scanp = scan;
4713     *deltap = is_inf_internal ? I32_MAX : delta;
4714     if (flags & SCF_DO_SUBSTR && is_inf)
4715         data->pos_delta = I32_MAX - data->pos_min;
4716     if (is_par > (I32)U8_MAX)
4717         is_par = 0;
4718     if (is_par && pars==1 && data) {
4719         data->flags |= SF_IN_PAR;
4720         data->flags &= ~SF_HAS_PAR;
4721     }
4722     else if (pars && data) {
4723         data->flags |= SF_HAS_PAR;
4724         data->flags &= ~SF_IN_PAR;
4725     }
4726     if (flags & SCF_DO_STCLASS_OR)
4727         cl_and(data->start_class, and_withp);
4728     if (flags & SCF_TRIE_RESTUDY)
4729         data->flags |=  SCF_TRIE_RESTUDY;
4730     
4731     DEBUG_STUDYDATA("post-fin:",data,depth);
4732     
4733     return min < stopmin ? min : stopmin;
4734 }
4735
4736 STATIC U32
4737 S_add_data(RExC_state_t *pRExC_state, U32 n, const char *s)
4738 {
4739     U32 count = RExC_rxi->data ? RExC_rxi->data->count : 0;
4740
4741     PERL_ARGS_ASSERT_ADD_DATA;
4742
4743     Renewc(RExC_rxi->data,
4744            sizeof(*RExC_rxi->data) + sizeof(void*) * (count + n - 1),
4745            char, struct reg_data);
4746     if(count)
4747         Renew(RExC_rxi->data->what, count + n, U8);
4748     else
4749         Newx(RExC_rxi->data->what, n, U8);
4750     RExC_rxi->data->count = count + n;
4751     Copy(s, RExC_rxi->data->what + count, n, U8);
4752     return count;
4753 }
4754
4755 /*XXX: todo make this not included in a non debugging perl */
4756 #ifndef PERL_IN_XSUB_RE
4757 void
4758 Perl_reginitcolors(pTHX)
4759 {
4760     dVAR;
4761     const char * const s = PerlEnv_getenv("PERL_RE_COLORS");
4762     if (s) {
4763         char *t = savepv(s);
4764         int i = 0;
4765         PL_colors[0] = t;
4766         while (++i < 6) {
4767             t = strchr(t, '\t');
4768             if (t) {
4769                 *t = '\0';
4770                 PL_colors[i] = ++t;
4771             }
4772             else
4773                 PL_colors[i] = t = (char *)"";
4774         }
4775     } else {
4776         int i = 0;
4777         while (i < 6)
4778             PL_colors[i++] = (char *)"";
4779     }
4780     PL_colorset = 1;
4781 }
4782 #endif
4783
4784
4785 #ifdef TRIE_STUDY_OPT
4786 #define CHECK_RESTUDY_GOTO_butfirst(dOsomething)            \
4787     STMT_START {                                            \
4788         if (                                                \
4789               (data.flags & SCF_TRIE_RESTUDY)               \
4790               && ! restudied++                              \
4791         ) {                                                 \
4792             dOsomething;                                    \
4793             goto reStudy;                                   \
4794         }                                                   \
4795     } STMT_END
4796 #else
4797 #define CHECK_RESTUDY_GOTO_butfirst
4798 #endif        
4799
4800 /*
4801  * pregcomp - compile a regular expression into internal code
4802  *
4803  * Decides which engine's compiler to call based on the hint currently in
4804  * scope
4805  */
4806
4807 #ifndef PERL_IN_XSUB_RE 
4808
4809 /* return the currently in-scope regex engine (or the default if none)  */
4810
4811 regexp_engine const *
4812 Perl_current_re_engine(pTHX)
4813 {
4814     dVAR;
4815
4816     if (IN_PERL_COMPILETIME) {
4817         HV * const table = GvHV(PL_hintgv);
4818         SV **ptr;
4819
4820         if (!table)
4821             return &PL_core_reg_engine;
4822         ptr = hv_fetchs(table, "regcomp", FALSE);
4823         if ( !(ptr && SvIOK(*ptr) && SvIV(*ptr)))
4824             return &PL_core_reg_engine;
4825         return INT2PTR(regexp_engine*,SvIV(*ptr));
4826     }
4827     else {
4828         SV *ptr;
4829         if (!PL_curcop->cop_hints_hash)
4830             return &PL_core_reg_engine;
4831         ptr = cop_hints_fetch_pvs(PL_curcop, "regcomp", 0);
4832         if ( !(ptr && SvIOK(ptr) && SvIV(ptr)))
4833             return &PL_core_reg_engine;
4834         return INT2PTR(regexp_engine*,SvIV(ptr));
4835     }
4836 }
4837
4838
4839 REGEXP *
4840 Perl_pregcomp(pTHX_ SV * const pattern, const U32 flags)
4841 {
4842     dVAR;
4843     regexp_engine const *eng = current_re_engine();
4844     GET_RE_DEBUG_FLAGS_DECL;
4845
4846     PERL_ARGS_ASSERT_PREGCOMP;
4847
4848     /* Dispatch a request to compile a regexp to correct regexp engine. */
4849     DEBUG_COMPILE_r({
4850         PerlIO_printf(Perl_debug_log, "Using engine %"UVxf"\n",
4851                         PTR2UV(eng));
4852     });
4853     return CALLREGCOMP_ENG(eng, pattern, flags);
4854 }
4855 #endif
4856
4857 /* public(ish) entry point for the perl core's own regex compiling code.
4858  * It's actually a wrapper for Perl_re_op_compile that only takes an SV
4859  * pattern rather than a list of OPs, and uses the internal engine rather
4860  * than the current one */
4861
4862 REGEXP *
4863 Perl_re_compile(pTHX_ SV * const pattern, U32 rx_flags)
4864 {
4865     SV *pat = pattern; /* defeat constness! */
4866     PERL_ARGS_ASSERT_RE_COMPILE;
4867     return Perl_re_op_compile(aTHX_ &pat, 1, NULL,
4868 #ifdef PERL_IN_XSUB_RE
4869                                 &my_reg_engine,
4870 #else
4871                                 &PL_core_reg_engine,
4872 #endif
4873                                 NULL, NULL, rx_flags, 0);
4874 }
4875
4876 /* see if there are any run-time code blocks in the pattern.
4877  * False positives are allowed */
4878
4879 static bool
4880 S_has_runtime_code(pTHX_ RExC_state_t * const pRExC_state, OP *expr,
4881                     U32 pm_flags, char *pat, STRLEN plen)
4882 {
4883     int n = 0;
4884     STRLEN s;
4885
4886     /* avoid infinitely recursing when we recompile the pattern parcelled up
4887      * as qr'...'. A single constant qr// string can't have have any
4888      * run-time component in it, and thus, no runtime code. (A non-qr
4889      * string, however, can, e.g. $x =~ '(?{})') */
4890     if  ((pm_flags & PMf_IS_QR) && expr && expr->op_type == OP_CONST)
4891         return 0;
4892
4893     for (s = 0; s < plen; s++) {
4894         if (n < pRExC_state->num_code_blocks
4895             && s == pRExC_state->code_blocks[n].start)
4896         {
4897             s = pRExC_state->code_blocks[n].end;
4898             n++;
4899             continue;
4900         }
4901         /* TODO ideally should handle [..], (#..), /#.../x to reduce false
4902          * positives here */
4903         if (pat[s] == '(' && s+2 <= plen && pat[s+1] == '?' &&
4904             (pat[s+2] == '{'
4905                 || (s + 2 <= plen && pat[s+2] == '?' && pat[s+3] == '{'))
4906         )
4907             return 1;
4908     }
4909     return 0;
4910 }
4911
4912 /* Handle run-time code blocks. We will already have compiled any direct
4913  * or indirect literal code blocks. Now, take the pattern 'pat' and make a
4914  * copy of it, but with any literal code blocks blanked out and
4915  * appropriate chars escaped; then feed it into
4916  *
4917  *    eval "qr'modified_pattern'"
4918  *
4919  * For example,
4920  *
4921  *       a\bc(?{"this was literal"})def'ghi\\jkl(?{"this is runtime"})mno
4922  *
4923  * becomes
4924  *
4925  *    qr'a\\bc_______________________def\'ghi\\\\jkl(?{"this is runtime"})mno'
4926  *
4927  * After eval_sv()-ing that, grab any new code blocks from the returned qr
4928  * and merge them with any code blocks of the original regexp.
4929  *
4930  * If the pat is non-UTF8, while the evalled qr is UTF8, don't merge;
4931  * instead, just save the qr and return FALSE; this tells our caller that
4932  * the original pattern needs upgrading to utf8.
4933  */
4934
4935 static bool
4936 S_compile_runtime_code(pTHX_ RExC_state_t * const pRExC_state,
4937     char *pat, STRLEN plen)
4938 {
4939     SV *qr;
4940
4941     GET_RE_DEBUG_FLAGS_DECL;
4942
4943     if (pRExC_state->runtime_code_qr) {
4944         /* this is the second time we've been called; this should
4945          * only happen if the main pattern got upgraded to utf8
4946          * during compilation; re-use the qr we compiled first time
4947          * round (which should be utf8 too)
4948          */
4949         qr = pRExC_state->runtime_code_qr;
4950         pRExC_state->runtime_code_qr = NULL;
4951         assert(RExC_utf8 && SvUTF8(qr));
4952     }
4953     else {
4954         int n = 0;
4955         STRLEN s;
4956         char *p, *newpat;
4957         int newlen = plen + 6; /* allow for "qr''x\0" extra chars */
4958         SV *sv, *qr_ref;
4959         dSP;
4960
4961         /* determine how many extra chars we need for ' and \ escaping */
4962         for (s = 0; s < plen; s++) {
4963             if (pat[s] == '\'' || pat[s] == '\\')
4964                 newlen++;
4965         }
4966
4967         Newx(newpat, newlen, char);
4968         p = newpat;
4969         *p++ = 'q'; *p++ = 'r'; *p++ = '\'';
4970
4971         for (s = 0; s < plen; s++) {
4972             if (n < pRExC_state->num_code_blocks
4973                 && s == pRExC_state->code_blocks[n].start)
4974             {
4975                 /* blank out literal code block */
4976                 assert(pat[s] == '(');
4977                 while (s <= pRExC_state->code_blocks[n].end) {
4978                     *p++ = '_';
4979                     s++;
4980                 }
4981                 s--;
4982                 n++;
4983                 continue;
4984             }
4985             if (pat[s] == '\'' || pat[s] == '\\')
4986                 *p++ = '\\';
4987             *p++ = pat[s];
4988         }
4989         *p++ = '\'';
4990         if (pRExC_state->pm_flags & RXf_PMf_EXTENDED)
4991             *p++ = 'x';
4992         *p++ = '\0';
4993         DEBUG_COMPILE_r({
4994             PerlIO_printf(Perl_debug_log,
4995                 "%sre-parsing pattern for runtime code:%s %s\n",
4996                 PL_colors[4],PL_colors[5],newpat);
4997         });
4998
4999         sv = newSVpvn_flags(newpat, p-newpat-1, RExC_utf8 ? SVf_UTF8 : 0);
5000         Safefree(newpat);
5001
5002         ENTER;
5003         SAVETMPS;
5004         save_re_context();
5005         PUSHSTACKi(PERLSI_REQUIRE);
5006         /* this causes the toker to collapse \\ into \ when parsing
5007          * qr''; normally only q'' does this. It also alters hints
5008          * handling */
5009         PL_reg_state.re_reparsing = TRUE;
5010         eval_sv(sv, G_SCALAR);
5011         SvREFCNT_dec_NN(sv);
5012         SPAGAIN;
5013         qr_ref = POPs;
5014         PUTBACK;
5015         {
5016             SV * const errsv = ERRSV;
5017             if (SvTRUE_NN(errsv))
5018             {
5019                 Safefree(pRExC_state->code_blocks);
5020                 /* use croak_sv ? */
5021                 Perl_croak_nocontext("%s", SvPV_nolen_const(errsv));
5022             }
5023         }
5024         assert(SvROK(qr_ref));
5025         qr = SvRV(qr_ref);
5026         assert(SvTYPE(qr) == SVt_REGEXP && RX_ENGINE((REGEXP*)qr)->op_comp);
5027         /* the leaving below frees the tmp qr_ref.
5028          * Give qr a life of its own */
5029         SvREFCNT_inc(qr);
5030         POPSTACK;
5031         FREETMPS;
5032         LEAVE;
5033
5034     }
5035
5036     if (!RExC_utf8 && SvUTF8(qr)) {
5037         /* first time through; the pattern got upgraded; save the
5038          * qr for the next time through */
5039         assert(!pRExC_state->runtime_code_qr);
5040         pRExC_state->runtime_code_qr = qr;
5041         return 0;
5042     }
5043
5044
5045     /* extract any code blocks within the returned qr//  */
5046
5047
5048     /* merge the main (r1) and run-time (r2) code blocks into one */
5049     {
5050         RXi_GET_DECL(ReANY((REGEXP *)qr), r2);
5051         struct reg_code_block *new_block, *dst;
5052         RExC_state_t * const r1 = pRExC_state; /* convenient alias */
5053         int i1 = 0, i2 = 0;
5054
5055         if (!r2->num_code_blocks) /* we guessed wrong */
5056         {
5057             SvREFCNT_dec_NN(qr);
5058             return 1;
5059         }
5060
5061         Newx(new_block,
5062             r1->num_code_blocks + r2->num_code_blocks,
5063             struct reg_code_block);
5064         dst = new_block;
5065
5066         while (    i1 < r1->num_code_blocks
5067                 || i2 < r2->num_code_blocks)
5068         {
5069             struct reg_code_block *src;
5070             bool is_qr = 0;
5071
5072             if (i1 == r1->num_code_blocks) {
5073                 src = &r2->code_blocks[i2++];
5074                 is_qr = 1;
5075             }
5076             else if (i2 == r2->num_code_blocks)
5077                 src = &r1->code_blocks[i1++];
5078             else if (  r1->code_blocks[i1].start
5079                      < r2->code_blocks[i2].start)
5080             {
5081                 src = &r1->code_blocks[i1++];
5082                 assert(src->end < r2->code_blocks[i2].start);
5083             }
5084             else {
5085                 assert(  r1->code_blocks[i1].start
5086                        > r2->code_blocks[i2].start);
5087                 src = &r2->code_blocks[i2++];
5088                 is_qr = 1;
5089                 assert(src->end < r1->code_blocks[i1].start);
5090             }
5091
5092             assert(pat[src->start] == '(');
5093             assert(pat[src->end]   == ')');
5094             dst->start      = src->start;
5095             dst->end        = src->end;
5096             dst->block      = src->block;
5097             dst->src_regex  = is_qr ? (REGEXP*) SvREFCNT_inc( (SV*) qr)
5098                                     : src->src_regex;
5099             dst++;
5100         }
5101         r1->num_code_blocks += r2->num_code_blocks;
5102         Safefree(r1->code_blocks);
5103         r1->code_blocks = new_block;
5104     }
5105
5106     SvREFCNT_dec_NN(qr);
5107     return 1;
5108 }
5109
5110
5111 STATIC bool
5112 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)
5113 {
5114     /* This is the common code for setting up the floating and fixed length
5115      * string data extracted from Perlre_op_compile() below.  Returns a boolean
5116      * as to whether succeeded or not */
5117
5118     I32 t,ml;
5119
5120     if (! (longest_length
5121            || (eol /* Can't have SEOL and MULTI */
5122                && (! meol || (RExC_flags & RXf_PMf_MULTILINE)))
5123           )
5124             /* See comments for join_exact for why REG_SEEN_EXACTF_SHARP_S */
5125         || (RExC_seen & REG_SEEN_EXACTF_SHARP_S))
5126     {
5127         return FALSE;
5128     }
5129
5130     /* copy the information about the longest from the reg_scan_data
5131         over to the program. */
5132     if (SvUTF8(sv_longest)) {
5133         *rx_utf8 = sv_longest;
5134         *rx_substr = NULL;
5135     } else {
5136         *rx_substr = sv_longest;
5137         *rx_utf8 = NULL;
5138     }
5139     /* end_shift is how many chars that must be matched that
5140         follow this item. We calculate it ahead of time as once the
5141         lookbehind offset is added in we lose the ability to correctly
5142         calculate it.*/
5143     ml = minlen ? *(minlen) : (I32)longest_length;
5144     *rx_end_shift = ml - offset
5145         - longest_length + (SvTAIL(sv_longest) != 0)
5146         + lookbehind;
5147
5148     t = (eol/* Can't have SEOL and MULTI */
5149          && (! meol || (RExC_flags & RXf_PMf_MULTILINE)));
5150     fbm_compile(sv_longest, t ? FBMcf_TAIL : 0);
5151
5152     return TRUE;
5153 }
5154
5155 /*
5156  * Perl_re_op_compile - the perl internal RE engine's function to compile a
5157  * regular expression into internal code.
5158  * The pattern may be passed either as:
5159  *    a list of SVs (patternp plus pat_count)
5160  *    a list of OPs (expr)
5161  * If both are passed, the SV list is used, but the OP list indicates
5162  * which SVs are actually pre-compiled code blocks
5163  *
5164  * The SVs in the list have magic and qr overloading applied to them (and
5165  * the list may be modified in-place with replacement SVs in the latter
5166  * case).
5167  *
5168  * If the pattern hasn't changed from old_re, then old_re will be
5169  * returned.
5170  *
5171  * eng is the current engine. If that engine has an op_comp method, then
5172  * handle directly (i.e. we assume that op_comp was us); otherwise, just
5173  * do the initial concatenation of arguments and pass on to the external
5174  * engine.
5175  *
5176  * If is_bare_re is not null, set it to a boolean indicating whether the
5177  * arg list reduced (after overloading) to a single bare regex which has
5178  * been returned (i.e. /$qr/).
5179  *
5180  * orig_rx_flags contains RXf_* flags. See perlreapi.pod for more details.
5181  *
5182  * pm_flags contains the PMf_* flags, typically based on those from the
5183  * pm_flags field of the related PMOP. Currently we're only interested in
5184  * PMf_HAS_CV, PMf_IS_QR, PMf_USE_RE_EVAL.
5185  *
5186  * We can't allocate space until we know how big the compiled form will be,
5187  * but we can't compile it (and thus know how big it is) until we've got a
5188  * place to put the code.  So we cheat:  we compile it twice, once with code
5189  * generation turned off and size counting turned on, and once "for real".
5190  * This also means that we don't allocate space until we are sure that the
5191  * thing really will compile successfully, and we never have to move the
5192  * code and thus invalidate pointers into it.  (Note that it has to be in
5193  * one piece because free() must be able to free it all.) [NB: not true in perl]
5194  *
5195  * Beware that the optimization-preparation code in here knows about some
5196  * of the structure of the compiled regexp.  [I'll say.]
5197  */
5198
5199 REGEXP *
5200 Perl_re_op_compile(pTHX_ SV ** const patternp, int pat_count,
5201                     OP *expr, const regexp_engine* eng, REGEXP *old_re,
5202                      bool *is_bare_re, U32 orig_rx_flags, U32 pm_flags)
5203 {
5204     dVAR;
5205     REGEXP *rx;
5206     struct regexp *r;
5207     regexp_internal *ri;
5208     STRLEN plen;
5209     char *exp;
5210     char* xend;
5211     regnode *scan;
5212     I32 flags;
5213     I32 minlen = 0;
5214     U32 rx_flags;
5215     SV *pat = NULL;
5216     SV *code_blocksv = NULL;
5217
5218     /* these are all flags - maybe they should be turned
5219      * into a single int with different bit masks */
5220     I32 sawlookahead = 0;
5221     I32 sawplus = 0;
5222     I32 sawopen = 0;
5223     regex_charset initial_charset = get_regex_charset(orig_rx_flags);
5224     bool code_is_utf8 = 0;
5225     bool recompile = 0;
5226     bool runtime_code = 0;
5227     scan_data_t data;
5228     RExC_state_t RExC_state;
5229     RExC_state_t * const pRExC_state = &RExC_state;
5230 #ifdef TRIE_STUDY_OPT    
5231     int restudied = 0;
5232     RExC_state_t copyRExC_state;
5233 #endif    
5234     GET_RE_DEBUG_FLAGS_DECL;
5235
5236     PERL_ARGS_ASSERT_RE_OP_COMPILE;
5237
5238     DEBUG_r(if (!PL_colorset) reginitcolors());
5239
5240 #ifndef PERL_IN_XSUB_RE
5241     /* Initialize these here instead of as-needed, as is quick and avoids
5242      * having to test them each time otherwise */
5243     if (! PL_AboveLatin1) {
5244         PL_AboveLatin1 = _new_invlist_C_array(AboveLatin1_invlist);
5245         PL_ASCII = _new_invlist_C_array(ASCII_invlist);
5246         PL_Latin1 = _new_invlist_C_array(Latin1_invlist);
5247
5248         PL_L1Posix_ptrs[_CC_ALPHANUMERIC]
5249                                 = _new_invlist_C_array(L1PosixAlnum_invlist);
5250         PL_Posix_ptrs[_CC_ALPHANUMERIC]
5251                                 = _new_invlist_C_array(PosixAlnum_invlist);
5252
5253         PL_L1Posix_ptrs[_CC_ALPHA]
5254                                 = _new_invlist_C_array(L1PosixAlpha_invlist);
5255         PL_Posix_ptrs[_CC_ALPHA] = _new_invlist_C_array(PosixAlpha_invlist);
5256
5257         PL_Posix_ptrs[_CC_BLANK] = _new_invlist_C_array(PosixBlank_invlist);
5258         PL_XPosix_ptrs[_CC_BLANK] = _new_invlist_C_array(XPosixBlank_invlist);
5259
5260         /* Cased is the same as Alpha in the ASCII range */
5261         PL_L1Posix_ptrs[_CC_CASED] =  _new_invlist_C_array(L1Cased_invlist);
5262         PL_Posix_ptrs[_CC_CASED] =  _new_invlist_C_array(PosixAlpha_invlist);
5263
5264         PL_Posix_ptrs[_CC_CNTRL] = _new_invlist_C_array(PosixCntrl_invlist);
5265         PL_XPosix_ptrs[_CC_CNTRL] = _new_invlist_C_array(XPosixCntrl_invlist);
5266
5267         PL_Posix_ptrs[_CC_DIGIT] = _new_invlist_C_array(PosixDigit_invlist);
5268         PL_L1Posix_ptrs[_CC_DIGIT] = _new_invlist_C_array(PosixDigit_invlist);
5269
5270         PL_L1Posix_ptrs[_CC_GRAPH] = _new_invlist_C_array(L1PosixGraph_invlist);
5271         PL_Posix_ptrs[_CC_GRAPH] = _new_invlist_C_array(PosixGraph_invlist);
5272
5273         PL_L1Posix_ptrs[_CC_LOWER] = _new_invlist_C_array(L1PosixLower_invlist);
5274         PL_Posix_ptrs[_CC_LOWER] = _new_invlist_C_array(PosixLower_invlist);
5275
5276         PL_L1Posix_ptrs[_CC_PRINT] = _new_invlist_C_array(L1PosixPrint_invlist);
5277         PL_Posix_ptrs[_CC_PRINT] = _new_invlist_C_array(PosixPrint_invlist);
5278
5279         PL_L1Posix_ptrs[_CC_PUNCT] = _new_invlist_C_array(L1PosixPunct_invlist);
5280         PL_Posix_ptrs[_CC_PUNCT] = _new_invlist_C_array(PosixPunct_invlist);
5281
5282         PL_Posix_ptrs[_CC_SPACE] = _new_invlist_C_array(PerlSpace_invlist);
5283         PL_XPosix_ptrs[_CC_SPACE] = _new_invlist_C_array(XPerlSpace_invlist);
5284         PL_Posix_ptrs[_CC_PSXSPC] = _new_invlist_C_array(PosixSpace_invlist);
5285         PL_XPosix_ptrs[_CC_PSXSPC] = _new_invlist_C_array(XPosixSpace_invlist);
5286
5287         PL_L1Posix_ptrs[_CC_UPPER] = _new_invlist_C_array(L1PosixUpper_invlist);
5288         PL_Posix_ptrs[_CC_UPPER] = _new_invlist_C_array(PosixUpper_invlist);
5289
5290         PL_XPosix_ptrs[_CC_VERTSPACE] = _new_invlist_C_array(VertSpace_invlist);
5291
5292         PL_Posix_ptrs[_CC_WORDCHAR] = _new_invlist_C_array(PosixWord_invlist);
5293         PL_L1Posix_ptrs[_CC_WORDCHAR]
5294                                 = _new_invlist_C_array(L1PosixWord_invlist);
5295
5296         PL_Posix_ptrs[_CC_XDIGIT] = _new_invlist_C_array(PosixXDigit_invlist);
5297         PL_XPosix_ptrs[_CC_XDIGIT] = _new_invlist_C_array(XPosixXDigit_invlist);
5298
5299         PL_HasMultiCharFold = _new_invlist_C_array(_Perl_Multi_Char_Folds_invlist);
5300     }
5301 #endif
5302
5303     pRExC_state->code_blocks = NULL;
5304     pRExC_state->num_code_blocks = 0;
5305
5306     if (is_bare_re)
5307         *is_bare_re = FALSE;
5308
5309     if (expr && (expr->op_type == OP_LIST ||
5310                 (expr->op_type == OP_NULL && expr->op_targ == OP_LIST))) {
5311
5312         /* is the source UTF8, and how many code blocks are there? */
5313         OP *o;
5314         int ncode = 0;
5315
5316         for (o = cLISTOPx(expr)->op_first; o; o = o->op_sibling) {
5317             if (o->op_type == OP_CONST) {
5318                 /* skip if we have SVs as well as OPs. In this case,
5319                  * a) we decide utf8 based on SVs not OPs;
5320                  * b) the current pad may not match that which the ops
5321                  *    were compiled in, so, so on threaded builds,
5322                  *    cSVOPo_sv would look in the wrong pad */
5323                 if (!pat_count && SvUTF8(cSVOPo_sv))
5324                     code_is_utf8 = 1;
5325             }
5326             else if (o->op_type == OP_NULL && (o->op_flags & OPf_SPECIAL))
5327                 /* count of DO blocks */
5328                 ncode++;
5329         }
5330         if (ncode) {
5331             pRExC_state->num_code_blocks = ncode;
5332             Newx(pRExC_state->code_blocks, ncode, struct reg_code_block);
5333         }
5334     }
5335
5336     if (pat_count) {
5337         /* handle a list of SVs */
5338
5339         SV **svp;
5340         OP *o = NULL;
5341         int n = 0;
5342         bool utf8 = 0;
5343         STRLEN orig_patlen = 0;
5344
5345         /* apply magic and RE overloading to each arg */
5346         for (svp = patternp; svp < patternp + pat_count; svp++) {
5347             SV *rx = *svp;
5348             SvGETMAGIC(rx);
5349             if (SvROK(rx) && SvAMAGIC(rx)) {
5350                 SV *sv = AMG_CALLunary(rx, regexp_amg);
5351                 if (sv) {
5352                     if (SvROK(sv))
5353                         sv = SvRV(sv);
5354                     if (SvTYPE(sv) != SVt_REGEXP)
5355                         Perl_croak(aTHX_ "Overloaded qr did not return a REGEXP");
5356                     *svp = sv;
5357                 }
5358             }
5359         }
5360
5361             /* process args, concat them if there are multiple ones,
5362              * and find any code block indexes */
5363
5364             if (pat_count > 1) {
5365             if (pRExC_state->num_code_blocks) {
5366                 o = cLISTOPx(expr)->op_first;
5367                 assert(   o->op_type == OP_PUSHMARK
5368                        || (o->op_type == OP_NULL && o->op_targ == OP_PUSHMARK)
5369                        || o->op_type == OP_PADRANGE);
5370                 o = o->op_sibling;
5371             }
5372
5373             pat = newSVpvn("", 0);
5374             SAVEFREESV(pat);
5375
5376             /* determine if the pattern is going to be utf8 (needed
5377              * in advance to align code block indices correctly).
5378              * XXX This could fail to be detected for an arg with
5379              * overloading but not concat overloading; but the main effect
5380              * in this obscure case is to need a 'use re eval' for a
5381              * literal code block */
5382             for (svp = patternp; svp < patternp + pat_count; svp++) {
5383                 if (SvUTF8(*svp))
5384                     utf8 = 1;
5385             }
5386             if (utf8)
5387                 SvUTF8_on(pat);
5388             }
5389
5390             for (svp = patternp; svp < patternp + pat_count; svp++) {
5391                 SV *sv, *msv = *svp;
5392                 SV *rx  = NULL;
5393                 bool code = 0;
5394                 /* we make the assumption here that each op in the list of
5395                  * op_siblings maps to one SV pushed onto the stack,
5396                  * except for code blocks, with have both an OP_NULL and
5397                  * and OP_CONST.
5398                  * This allows us to match up the list of SVs against the
5399                  * list of OPs to find the next code block.
5400                  *
5401                  * Note that       PUSHMARK PADSV PADSV ..
5402                  * is optimised to
5403                  *                 PADRANGE NULL  NULL  ..
5404                  * so the alignment still works. */
5405                 if (o) {
5406                     if (o->op_type == OP_NULL && (o->op_flags & OPf_SPECIAL)) {
5407                         assert(n < pRExC_state->num_code_blocks);
5408                         pRExC_state->code_blocks[n].start = SvCUR(pat);
5409                         pRExC_state->code_blocks[n].block = o;
5410                         pRExC_state->code_blocks[n].src_regex = NULL;
5411                         n++;
5412                         code = 1;
5413                         o = o->op_sibling; /* skip CONST */
5414                         assert(o);
5415                     }
5416                     o = o->op_sibling;;
5417                 }
5418
5419                 /* try concatenation overload ... */
5420                 if (pat && (SvAMAGIC(pat) || SvAMAGIC(msv)) &&
5421                         (sv = amagic_call(pat, msv, concat_amg, AMGf_assign)))
5422                 {
5423                     sv_setsv(pat, sv);
5424                     /* overloading involved: all bets are off over literal
5425                      * code. Pretend we haven't seen it */
5426                     pRExC_state->num_code_blocks -= n;
5427                     n = 0;
5428                 }
5429                 else  {
5430                     /* ... or failing that, try "" overload */
5431                     while (SvAMAGIC(msv)
5432                             && (sv = AMG_CALLunary(msv, string_amg))
5433                             && sv != msv
5434                             &&  !(   SvROK(msv)
5435                                   && SvROK(sv)
5436                                   && SvRV(msv) == SvRV(sv))
5437                     ) {
5438                         msv = sv;
5439                         SvGETMAGIC(msv);
5440                     }
5441                     if (SvROK(msv) && SvTYPE(SvRV(msv)) == SVt_REGEXP)
5442                         msv = SvRV(msv);
5443                     if (pat) {
5444                     orig_patlen = SvCUR(pat);
5445                     sv_catsv_nomg(pat, msv);
5446                     rx = msv;
5447                     }
5448                     else
5449                         pat = msv;
5450                     if (code)
5451                         pRExC_state->code_blocks[n-1].end = SvCUR(pat)-1;
5452                 }
5453
5454                 /* extract any code blocks within any embedded qr//'s */
5455                 if (rx && SvTYPE(rx) == SVt_REGEXP
5456                     && RX_ENGINE((REGEXP*)rx)->op_comp)
5457                 {
5458
5459                     RXi_GET_DECL(ReANY((REGEXP *)rx), ri);
5460                     if (ri->num_code_blocks) {
5461                         int i;
5462                         /* the presence of an embedded qr// with code means
5463                          * we should always recompile: the text of the
5464                          * qr// may not have changed, but it may be a
5465                          * different closure than last time */
5466                         recompile = 1;
5467                         Renew(pRExC_state->code_blocks,
5468                             pRExC_state->num_code_blocks + ri->num_code_blocks,
5469                             struct reg_code_block);
5470                         pRExC_state->num_code_blocks += ri->num_code_blocks;
5471                         for (i=0; i < ri->num_code_blocks; i++) {
5472                             struct reg_code_block *src, *dst;
5473                             STRLEN offset =  orig_patlen
5474                                 + ReANY((REGEXP *)rx)->pre_prefix;
5475                             assert(n < pRExC_state->num_code_blocks);
5476                             src = &ri->code_blocks[i];
5477                             dst = &pRExC_state->code_blocks[n];
5478                             dst->start      = src->start + offset;
5479                             dst->end        = src->end   + offset;
5480                             dst->block      = src->block;
5481                             dst->src_regex  = (REGEXP*) SvREFCNT_inc( (SV*)
5482                                                     src->src_regex
5483                                                         ? src->src_regex
5484                                                         : (REGEXP*)rx);
5485                             n++;
5486                         }
5487                     }
5488                 }
5489             }
5490             if (pat_count > 1)
5491                 SvSETMAGIC(pat);
5492
5493         /* handle bare (possibly after overloading) regex: foo =~ $re */
5494         {
5495             SV *re = pat;
5496             if (SvROK(re))
5497                 re = SvRV(re);
5498             if (SvTYPE(re) == SVt_REGEXP) {
5499                 if (is_bare_re)
5500                     *is_bare_re = TRUE;
5501                 SvREFCNT_inc(re);
5502                 Safefree(pRExC_state->code_blocks);
5503                 return (REGEXP*)re;
5504             }
5505         }
5506     }
5507     else {
5508         /* not a list of SVs, so must be a list of OPs */
5509         assert(expr);
5510         if (expr->op_type == OP_LIST) {
5511             int i = -1;
5512             bool is_code = 0;
5513             OP *o;
5514
5515             pat = newSVpvn("", 0);
5516             SAVEFREESV(pat);
5517             if (code_is_utf8)
5518                 SvUTF8_on(pat);
5519
5520             /* given a list of CONSTs and DO blocks in expr, append all
5521              * the CONSTs to pat, and record the start and end of each
5522              * code block in code_blocks[] (each DO{} op is followed by an
5523              * OP_CONST containing the corresponding literal '(?{...})
5524              * text)
5525              */
5526             for (o = cLISTOPx(expr)->op_first; o; o = o->op_sibling) {
5527                 if (o->op_type == OP_CONST) {
5528                     sv_catsv(pat, cSVOPo_sv);
5529                     if (is_code) {
5530                         pRExC_state->code_blocks[i].end = SvCUR(pat)-1;
5531                         is_code = 0;
5532                     }
5533                 }
5534                 else if (o->op_type == OP_NULL && (o->op_flags & OPf_SPECIAL)) {
5535                     assert(i+1 < pRExC_state->num_code_blocks);
5536                     pRExC_state->code_blocks[++i].start = SvCUR(pat);
5537                     pRExC_state->code_blocks[i].block = o;
5538                     pRExC_state->code_blocks[i].src_regex = NULL;
5539                     is_code = 1;
5540                 }
5541             }
5542         }
5543         else {
5544             assert(expr->op_type == OP_CONST);
5545             pat = cSVOPx_sv(expr);
5546         }
5547     }
5548
5549     exp = SvPV_nomg(pat, plen);
5550     xend = exp + plen;
5551
5552     if (!eng->op_comp) {
5553         if ((SvUTF8(pat) && IN_BYTES)
5554                 || SvGMAGICAL(pat) || SvAMAGIC(pat))
5555         {
5556             /* make a temporary copy; either to convert to bytes,
5557              * or to avoid repeating get-magic / overloaded stringify */
5558             pat = newSVpvn_flags(exp, plen, SVs_TEMP |
5559                                         (IN_BYTES ? 0 : SvUTF8(pat)));
5560         }
5561         Safefree(pRExC_state->code_blocks);
5562         return CALLREGCOMP_ENG(eng, pat, orig_rx_flags);
5563     }
5564
5565     /* ignore the utf8ness if the pattern is 0 length */
5566     RExC_utf8 = RExC_orig_utf8 = (plen == 0 || IN_BYTES) ? 0 : SvUTF8(pat);
5567     RExC_uni_semantics = 0;
5568     RExC_contains_locale = 0;
5569     pRExC_state->runtime_code_qr = NULL;
5570
5571     DEBUG_COMPILE_r({
5572             SV *dsv= sv_newmortal();
5573             RE_PV_QUOTED_DECL(s, RExC_utf8, dsv, exp, plen, 60);
5574             PerlIO_printf(Perl_debug_log, "%sCompiling REx%s %s\n",
5575                           PL_colors[4],PL_colors[5],s);
5576         });
5577
5578     if (0) {
5579       redo_first_pass:
5580         {
5581         U8 *const src = (U8*)exp;
5582         U8 *dst;
5583         int n=0;
5584         STRLEN s = 0, d = 0;
5585         bool do_end = 0;
5586
5587         /* It's possible to write a regexp in ascii that represents Unicode
5588         codepoints outside of the byte range, such as via \x{100}. If we
5589         detect such a sequence we have to convert the entire pattern to utf8
5590         and then recompile, as our sizing calculation will have been based
5591         on 1 byte == 1 character, but we will need to use utf8 to encode
5592         at least some part of the pattern, and therefore must convert the whole
5593         thing.
5594         -- dmq */
5595         DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log,
5596             "UTF8 mismatch! Converting to utf8 for resizing and compile\n"));
5597
5598         /* upgrade pattern to UTF8, and if there are code blocks,
5599          * recalculate the indices.
5600          * This is essentially an unrolled Perl_bytes_to_utf8() */
5601
5602         Newx(dst, plen * 2 + 1, U8);
5603
5604         while (s < plen) {
5605             const UV uv = NATIVE_TO_ASCII(src[s]);
5606             if (UNI_IS_INVARIANT(uv))
5607                 dst[d]   = (U8)UTF_TO_NATIVE(uv);
5608             else {
5609                 dst[d++] = (U8)UTF8_EIGHT_BIT_HI(uv);
5610                 dst[d]   = (U8)UTF8_EIGHT_BIT_LO(uv);
5611             }
5612             if (n < pRExC_state->num_code_blocks) {
5613                 if (!do_end && pRExC_state->code_blocks[n].start == s) {
5614                     pRExC_state->code_blocks[n].start = d;
5615                     assert(dst[d] == '(');
5616                     do_end = 1;
5617                 }
5618                 else if (do_end && pRExC_state->code_blocks[n].end == s) {
5619                     pRExC_state->code_blocks[n].end = d;
5620                     assert(dst[d] == ')');
5621                     do_end = 0;
5622                     n++;
5623                 }
5624             }
5625             s++;
5626             d++;
5627         }
5628         dst[d] = '\0';
5629         plen = d;
5630         exp = (char*) dst;
5631         xend = exp + plen;
5632         SAVEFREEPV(exp);
5633         RExC_orig_utf8 = RExC_utf8 = 1;
5634         }
5635     }
5636
5637     /* return old regex if pattern hasn't changed */
5638     /* XXX: note in the below we have to check the flags as well as the pattern.
5639      *
5640      * Things get a touch tricky as we have to compare the utf8 flag independently
5641      * from the compile flags.
5642      */
5643
5644     if (   old_re
5645         && !recompile
5646         && !!RX_UTF8(old_re) == !!RExC_utf8
5647         && ( RX_COMPFLAGS(old_re) == ( orig_rx_flags & RXf_PMf_FLAGCOPYMASK ) )
5648         && RX_PRECOMP(old_re)
5649         && RX_PRELEN(old_re) == plen
5650         && memEQ(RX_PRECOMP(old_re), exp, plen))
5651     {
5652         /* with runtime code, always recompile */
5653         runtime_code = S_has_runtime_code(aTHX_ pRExC_state, expr, pm_flags,
5654                                             exp, plen);
5655         if (!runtime_code) {
5656             Safefree(pRExC_state->code_blocks);
5657             return old_re;
5658         }
5659     }
5660     else if ((pm_flags & PMf_USE_RE_EVAL)
5661                 /* this second condition covers the non-regex literal case,
5662                  * i.e.  $foo =~ '(?{})'. */
5663                 || ( !PL_reg_state.re_reparsing && IN_PERL_COMPILETIME
5664                     && (PL_hints & HINT_RE_EVAL))
5665     )
5666         runtime_code = S_has_runtime_code(aTHX_ pRExC_state, expr, pm_flags,
5667                             exp, plen);
5668
5669     rx_flags = orig_rx_flags;
5670
5671     if (initial_charset == REGEX_LOCALE_CHARSET) {
5672         RExC_contains_locale = 1;
5673     }
5674     else if (RExC_utf8 && initial_charset == REGEX_DEPENDS_CHARSET) {
5675
5676         /* Set to use unicode semantics if the pattern is in utf8 and has the
5677          * 'depends' charset specified, as it means unicode when utf8  */
5678         set_regex_charset(&rx_flags, REGEX_UNICODE_CHARSET);
5679     }
5680
5681     RExC_precomp = exp;
5682     RExC_flags = rx_flags;
5683     RExC_pm_flags = pm_flags;
5684
5685     if (runtime_code) {
5686         if (TAINTING_get && TAINT_get)
5687             Perl_croak(aTHX_ "Eval-group in insecure regular expression");
5688
5689         if (!S_compile_runtime_code(aTHX_ pRExC_state, exp, plen)) {
5690             /* whoops, we have a non-utf8 pattern, whilst run-time code
5691              * got compiled as utf8. Try again with a utf8 pattern */
5692             goto redo_first_pass;
5693         }
5694     }
5695     assert(!pRExC_state->runtime_code_qr);
5696
5697     RExC_sawback = 0;
5698
5699     RExC_seen = 0;
5700     RExC_in_lookbehind = 0;
5701     RExC_seen_zerolen = *exp == '^' ? -1 : 0;
5702     RExC_extralen = 0;
5703     RExC_override_recoding = 0;
5704     RExC_in_multi_char_class = 0;
5705
5706     /* First pass: determine size, legality. */
5707     RExC_parse = exp;
5708     RExC_start = exp;
5709     RExC_end = xend;
5710     RExC_naughty = 0;
5711     RExC_npar = 1;
5712     RExC_nestroot = 0;
5713     RExC_size = 0L;
5714     RExC_emit = &PL_regdummy;
5715     RExC_whilem_seen = 0;
5716     RExC_open_parens = NULL;
5717     RExC_close_parens = NULL;
5718     RExC_opend = NULL;
5719     RExC_paren_names = NULL;
5720 #ifdef DEBUGGING
5721     RExC_paren_name_list = NULL;
5722 #endif
5723     RExC_recurse = NULL;
5724     RExC_recurse_count = 0;
5725     pRExC_state->code_index = 0;
5726
5727 #if 0 /* REGC() is (currently) a NOP at the first pass.
5728        * Clever compilers notice this and complain. --jhi */
5729     REGC((U8)REG_MAGIC, (char*)RExC_emit);
5730 #endif
5731     DEBUG_PARSE_r(
5732         PerlIO_printf(Perl_debug_log, "Starting first pass (sizing)\n");
5733         RExC_lastnum=0;
5734         RExC_lastparse=NULL;
5735     );
5736     /* reg may croak on us, not giving us a chance to free
5737        pRExC_state->code_blocks.  We cannot SAVEFREEPV it now, as we may
5738        need it to survive as long as the regexp (qr/(?{})/).
5739        We must check that code_blocksv is not already set, because we may
5740        have jumped back to restart the sizing pass. */
5741     if (pRExC_state->code_blocks && !code_blocksv) {
5742         code_blocksv = newSV_type(SVt_PV);
5743         SAVEFREESV(code_blocksv);
5744         SvPV_set(code_blocksv, (char *)pRExC_state->code_blocks);
5745         SvLEN_set(code_blocksv, 1); /*sufficient to make sv_clear free it*/
5746     }
5747     if (reg(pRExC_state, 0, &flags,1) == NULL) {
5748         if (flags & RESTART_UTF8) {
5749             goto redo_first_pass;
5750         }
5751         Perl_croak(aTHX_ "panic: reg returned NULL to re_op_compile for sizing pass, flags=%#X", flags);
5752     }
5753     if (code_blocksv)
5754         SvLEN_set(code_blocksv,0); /* no you can't have it, sv_clear */
5755
5756     DEBUG_PARSE_r({
5757         PerlIO_printf(Perl_debug_log, 
5758             "Required size %"IVdf" nodes\n"
5759             "Starting second pass (creation)\n", 
5760             (IV)RExC_size);
5761         RExC_lastnum=0; 
5762         RExC_lastparse=NULL; 
5763     });
5764
5765     /* The first pass could have found things that force Unicode semantics */
5766     if ((RExC_utf8 || RExC_uni_semantics)
5767          && get_regex_charset(rx_flags) == REGEX_DEPENDS_CHARSET)
5768     {
5769         set_regex_charset(&rx_flags, REGEX_UNICODE_CHARSET);
5770     }
5771
5772     /* Small enough for pointer-storage convention?
5773        If extralen==0, this means that we will not need long jumps. */
5774     if (RExC_size >= 0x10000L && RExC_extralen)
5775         RExC_size += RExC_extralen;
5776     else
5777         RExC_extralen = 0;
5778     if (RExC_whilem_seen > 15)
5779         RExC_whilem_seen = 15;
5780
5781     /* Allocate space and zero-initialize. Note, the two step process 
5782        of zeroing when in debug mode, thus anything assigned has to 
5783        happen after that */
5784     rx = (REGEXP*) newSV_type(SVt_REGEXP);
5785     r = ReANY(rx);
5786     Newxc(ri, sizeof(regexp_internal) + (unsigned)RExC_size * sizeof(regnode),
5787          char, regexp_internal);
5788     if ( r == NULL || ri == NULL )
5789         FAIL("Regexp out of space");
5790 #ifdef DEBUGGING
5791     /* avoid reading uninitialized memory in DEBUGGING code in study_chunk() */
5792     Zero(ri, sizeof(regexp_internal) + (unsigned)RExC_size * sizeof(regnode), char);
5793 #else 
5794     /* bulk initialize base fields with 0. */
5795     Zero(ri, sizeof(regexp_internal), char);        
5796 #endif
5797
5798     /* non-zero initialization begins here */
5799     RXi_SET( r, ri );
5800     r->engine= eng;
5801     r->extflags = rx_flags;
5802     RXp_COMPFLAGS(r) = orig_rx_flags & RXf_PMf_FLAGCOPYMASK;
5803
5804     if (pm_flags & PMf_IS_QR) {
5805         ri->code_blocks = pRExC_state->code_blocks;
5806         ri->num_code_blocks = pRExC_state->num_code_blocks;
5807     }
5808     else
5809     {
5810         int n;
5811         for (n = 0; n < pRExC_state->num_code_blocks; n++)
5812             if (pRExC_state->code_blocks[n].src_regex)
5813                 SAVEFREESV(pRExC_state->code_blocks[n].src_regex);
5814         SAVEFREEPV(pRExC_state->code_blocks);
5815     }
5816
5817     {
5818         bool has_p     = ((r->extflags & RXf_PMf_KEEPCOPY) == RXf_PMf_KEEPCOPY);
5819         bool has_charset = (get_regex_charset(r->extflags) != REGEX_DEPENDS_CHARSET);
5820
5821         /* The caret is output if there are any defaults: if not all the STD
5822          * flags are set, or if no character set specifier is needed */
5823         bool has_default =
5824                     (((r->extflags & RXf_PMf_STD_PMMOD) != RXf_PMf_STD_PMMOD)
5825                     || ! has_charset);
5826         bool has_runon = ((RExC_seen & REG_SEEN_RUN_ON_COMMENT)==REG_SEEN_RUN_ON_COMMENT);
5827         U16 reganch = (U16)((r->extflags & RXf_PMf_STD_PMMOD)
5828                             >> RXf_PMf_STD_PMMOD_SHIFT);
5829         const char *fptr = STD_PAT_MODS;        /*"msix"*/
5830         char *p;
5831         /* Allocate for the worst case, which is all the std flags are turned
5832          * on.  If more precision is desired, we could do a population count of
5833          * the flags set.  This could be done with a small lookup table, or by
5834          * shifting, masking and adding, or even, when available, assembly
5835          * language for a machine-language population count.
5836          * We never output a minus, as all those are defaults, so are
5837          * covered by the caret */
5838         const STRLEN wraplen = plen + has_p + has_runon
5839             + has_default       /* If needs a caret */
5840
5841                 /* If needs a character set specifier */
5842             + ((has_charset) ? MAX_CHARSET_NAME_LENGTH : 0)
5843             + (sizeof(STD_PAT_MODS) - 1)
5844             + (sizeof("(?:)") - 1);
5845
5846         Newx(p, wraplen + 1, char); /* +1 for the ending NUL */
5847         r->xpv_len_u.xpvlenu_pv = p;
5848         if (RExC_utf8)
5849             SvFLAGS(rx) |= SVf_UTF8;
5850         *p++='('; *p++='?';
5851
5852         /* If a default, cover it using the caret */
5853         if (has_default) {
5854             *p++= DEFAULT_PAT_MOD;
5855         }
5856         if (has_charset) {
5857             STRLEN len;
5858             const char* const name = get_regex_charset_name(r->extflags, &len);
5859             Copy(name, p, len, char);
5860             p += len;
5861         }
5862         if (has_p)
5863             *p++ = KEEPCOPY_PAT_MOD; /*'p'*/
5864         {
5865             char ch;
5866             while((ch = *fptr++)) {
5867                 if(reganch & 1)
5868                     *p++ = ch;
5869                 reganch >>= 1;
5870             }
5871         }
5872
5873         *p++ = ':';
5874         Copy(RExC_precomp, p, plen, char);
5875         assert ((RX_WRAPPED(rx) - p) < 16);
5876         r->pre_prefix = p - RX_WRAPPED(rx);
5877         p += plen;
5878         if (has_runon)
5879             *p++ = '\n';
5880         *p++ = ')';
5881         *p = 0;
5882         SvCUR_set(rx, p - RX_WRAPPED(rx));
5883     }
5884
5885     r->intflags = 0;
5886     r->nparens = RExC_npar - 1; /* set early to validate backrefs */
5887     
5888     if (RExC_seen & REG_SEEN_RECURSE) {
5889         Newxz(RExC_open_parens, RExC_npar,regnode *);
5890         SAVEFREEPV(RExC_open_parens);
5891         Newxz(RExC_close_parens,RExC_npar,regnode *);
5892         SAVEFREEPV(RExC_close_parens);
5893     }
5894
5895     /* Useful during FAIL. */
5896 #ifdef RE_TRACK_PATTERN_OFFSETS
5897     Newxz(ri->u.offsets, 2*RExC_size+1, U32); /* MJD 20001228 */
5898     DEBUG_OFFSETS_r(PerlIO_printf(Perl_debug_log,
5899                           "%s %"UVuf" bytes for offset annotations.\n",
5900                           ri->u.offsets ? "Got" : "Couldn't get",
5901                           (UV)((2*RExC_size+1) * sizeof(U32))));
5902 #endif
5903     SetProgLen(ri,RExC_size);
5904     RExC_rx_sv = rx;
5905     RExC_rx = r;
5906     RExC_rxi = ri;
5907
5908     /* Second pass: emit code. */
5909     RExC_flags = rx_flags;      /* don't let top level (?i) bleed */
5910     RExC_pm_flags = pm_flags;
5911     RExC_parse = exp;
5912     RExC_end = xend;
5913     RExC_naughty = 0;
5914     RExC_npar = 1;
5915     RExC_emit_start = ri->program;
5916     RExC_emit = ri->program;
5917     RExC_emit_bound = ri->program + RExC_size + 1;
5918     pRExC_state->code_index = 0;
5919
5920     REGC((U8)REG_MAGIC, (char*) RExC_emit++);
5921     if (reg(pRExC_state, 0, &flags,1) == NULL) {
5922         ReREFCNT_dec(rx);   
5923         Perl_croak(aTHX_ "panic: reg returned NULL to re_op_compile for generation pass, flags=%#X", flags);
5924     }
5925     /* XXXX To minimize changes to RE engine we always allocate
5926        3-units-long substrs field. */
5927     Newx(r->substrs, 1, struct reg_substr_data);
5928     if (RExC_recurse_count) {
5929         Newxz(RExC_recurse,RExC_recurse_count,regnode *);
5930         SAVEFREEPV(RExC_recurse);
5931     }
5932
5933 reStudy:
5934     r->minlen = minlen = sawlookahead = sawplus = sawopen = 0;
5935     Zero(r->substrs, 1, struct reg_substr_data);
5936
5937 #ifdef TRIE_STUDY_OPT
5938     if (!restudied) {
5939         StructCopy(&zero_scan_data, &data, scan_data_t);
5940         copyRExC_state = RExC_state;
5941     } else {
5942         U32 seen=RExC_seen;
5943         DEBUG_OPTIMISE_r(PerlIO_printf(Perl_debug_log,"Restudying\n"));
5944         
5945         RExC_state = copyRExC_state;
5946         if (seen & REG_TOP_LEVEL_BRANCHES) 
5947             RExC_seen |= REG_TOP_LEVEL_BRANCHES;
5948         else
5949             RExC_seen &= ~REG_TOP_LEVEL_BRANCHES;
5950         StructCopy(&zero_scan_data, &data, scan_data_t);
5951     }
5952 #else
5953     StructCopy(&zero_scan_data, &data, scan_data_t);
5954 #endif    
5955
5956     /* Dig out information for optimizations. */
5957     r->extflags = RExC_flags; /* was pm_op */
5958     /*dmq: removed as part of de-PMOP: pm->op_pmflags = RExC_flags; */
5959  
5960     if (UTF)
5961         SvUTF8_on(rx);  /* Unicode in it? */
5962     ri->regstclass = NULL;
5963     if (RExC_naughty >= 10)     /* Probably an expensive pattern. */
5964         r->intflags |= PREGf_NAUGHTY;
5965     scan = ri->program + 1;             /* First BRANCH. */
5966
5967     /* testing for BRANCH here tells us whether there is "must appear"
5968        data in the pattern. If there is then we can use it for optimisations */
5969     if (!(RExC_seen & REG_TOP_LEVEL_BRANCHES)) { /*  Only one top-level choice. */
5970         I32 fake;
5971         STRLEN longest_float_length, longest_fixed_length;
5972         struct regnode_charclass_class ch_class; /* pointed to by data */
5973         int stclass_flag;
5974         I32 last_close = 0; /* pointed to by data */
5975         regnode *first= scan;
5976         regnode *first_next= regnext(first);
5977         /*
5978          * Skip introductions and multiplicators >= 1
5979          * so that we can extract the 'meat' of the pattern that must 
5980          * match in the large if() sequence following.
5981          * NOTE that EXACT is NOT covered here, as it is normally
5982          * picked up by the optimiser separately. 
5983          *
5984          * This is unfortunate as the optimiser isnt handling lookahead
5985          * properly currently.
5986          *
5987          */
5988         while ((OP(first) == OPEN && (sawopen = 1)) ||
5989                /* An OR of *one* alternative - should not happen now. */
5990             (OP(first) == BRANCH && OP(first_next) != BRANCH) ||
5991             /* for now we can't handle lookbehind IFMATCH*/
5992             (OP(first) == IFMATCH && !first->flags && (sawlookahead = 1)) ||
5993             (OP(first) == PLUS) ||
5994             (OP(first) == MINMOD) ||
5995                /* An {n,m} with n>0 */
5996             (PL_regkind[OP(first)] == CURLY && ARG1(first) > 0) ||
5997             (OP(first) == NOTHING && PL_regkind[OP(first_next)] != END ))
5998         {
5999                 /* 
6000                  * the only op that could be a regnode is PLUS, all the rest
6001                  * will be regnode_1 or regnode_2.
6002                  *
6003                  */
6004                 if (OP(first) == PLUS)
6005                     sawplus = 1;
6006                 else
6007                     first += regarglen[OP(first)];
6008
6009                 first = NEXTOPER(first);
6010                 first_next= regnext(first);
6011         }
6012
6013         /* Starting-point info. */
6014       again:
6015         DEBUG_PEEP("first:",first,0);
6016         /* Ignore EXACT as we deal with it later. */
6017         if (PL_regkind[OP(first)] == EXACT) {
6018             if (OP(first) == EXACT)
6019                 NOOP;   /* Empty, get anchored substr later. */
6020             else
6021                 ri->regstclass = first;
6022         }
6023 #ifdef TRIE_STCLASS
6024         else if (PL_regkind[OP(first)] == TRIE &&
6025                 ((reg_trie_data *)ri->data->data[ ARG(first) ])->minlen>0) 
6026         {
6027             regnode *trie_op;
6028             /* this can happen only on restudy */
6029             if ( OP(first) == TRIE ) {
6030                 struct regnode_1 *trieop = (struct regnode_1 *)
6031                     PerlMemShared_calloc(1, sizeof(struct regnode_1));
6032                 StructCopy(first,trieop,struct regnode_1);
6033                 trie_op=(regnode *)trieop;
6034             } else {
6035                 struct regnode_charclass *trieop = (struct regnode_charclass *)
6036                     PerlMemShared_calloc(1, sizeof(struct regnode_charclass));
6037                 StructCopy(first,trieop,struct regnode_charclass);
6038                 trie_op=(regnode *)trieop;
6039             }
6040             OP(trie_op)+=2;
6041             make_trie_failtable(pRExC_state, (regnode *)first, trie_op, 0);
6042             ri->regstclass = trie_op;
6043         }
6044 #endif
6045         else if (REGNODE_SIMPLE(OP(first)))
6046             ri->regstclass = first;
6047         else if (PL_regkind[OP(first)] == BOUND ||
6048                  PL_regkind[OP(first)] == NBOUND)
6049             ri->regstclass = first;
6050         else if (PL_regkind[OP(first)] == BOL) {
6051             r->extflags |= (OP(first) == MBOL
6052                            ? RXf_ANCH_MBOL
6053                            : (OP(first) == SBOL
6054                               ? RXf_ANCH_SBOL
6055                               : RXf_ANCH_BOL));
6056             first = NEXTOPER(first);
6057             goto again;
6058         }
6059         else if (OP(first) == GPOS) {
6060             r->extflags |= RXf_ANCH_GPOS;
6061             first = NEXTOPER(first);
6062             goto again;
6063         }
6064         else if ((!sawopen || !RExC_sawback) &&
6065             (OP(first) == STAR &&
6066             PL_regkind[OP(NEXTOPER(first))] == REG_ANY) &&
6067             !(r->extflags & RXf_ANCH) && !pRExC_state->num_code_blocks)
6068         {
6069             /* turn .* into ^.* with an implied $*=1 */
6070             const int type =
6071                 (OP(NEXTOPER(first)) == REG_ANY)
6072                     ? RXf_ANCH_MBOL
6073                     : RXf_ANCH_SBOL;
6074             r->extflags |= type;
6075             r->intflags |= PREGf_IMPLICIT;
6076             first = NEXTOPER(first);
6077             goto again;
6078         }
6079         if (sawplus && !sawlookahead && (!sawopen || !RExC_sawback)
6080             && !pRExC_state->num_code_blocks) /* May examine pos and $& */
6081             /* x+ must match at the 1st pos of run of x's */
6082             r->intflags |= PREGf_SKIP;
6083
6084         /* Scan is after the zeroth branch, first is atomic matcher. */
6085 #ifdef TRIE_STUDY_OPT
6086         DEBUG_PARSE_r(
6087             if (!restudied)
6088                 PerlIO_printf(Perl_debug_log, "first at %"IVdf"\n",
6089                               (IV)(first - scan + 1))
6090         );
6091 #else
6092         DEBUG_PARSE_r(
6093             PerlIO_printf(Perl_debug_log, "first at %"IVdf"\n",
6094                 (IV)(first - scan + 1))
6095         );
6096 #endif
6097
6098
6099         /*
6100         * If there's something expensive in the r.e., find the
6101         * longest literal string that must appear and make it the
6102         * regmust.  Resolve ties in favor of later strings, since
6103         * the regstart check works with the beginning of the r.e.
6104         * and avoiding duplication strengthens checking.  Not a
6105         * strong reason, but sufficient in the absence of others.
6106         * [Now we resolve ties in favor of the earlier string if
6107         * it happens that c_offset_min has been invalidated, since the
6108         * earlier string may buy us something the later one won't.]
6109         */
6110
6111         data.longest_fixed = newSVpvs("");
6112         data.longest_float = newSVpvs("");
6113         data.last_found = newSVpvs("");
6114         data.longest = &(data.longest_fixed);
6115         ENTER_with_name("study_chunk");
6116         SAVEFREESV(data.longest_fixed);
6117         SAVEFREESV(data.longest_float);
6118         SAVEFREESV(data.last_found);
6119         first = scan;
6120         if (!ri->regstclass) {
6121             cl_init(pRExC_state, &ch_class);
6122             data.start_class = &ch_class;
6123             stclass_flag = SCF_DO_STCLASS_AND;
6124         } else                          /* XXXX Check for BOUND? */
6125             stclass_flag = 0;
6126         data.last_closep = &last_close;
6127         
6128         minlen = study_chunk(pRExC_state, &first, &minlen, &fake, scan + RExC_size, /* Up to end */
6129             &data, -1, NULL, NULL,
6130             SCF_DO_SUBSTR | SCF_WHILEM_VISITED_POS | stclass_flag,0);
6131
6132
6133         CHECK_RESTUDY_GOTO_butfirst(LEAVE_with_name("study_chunk"));
6134
6135
6136         if ( RExC_npar == 1 && data.longest == &(data.longest_fixed)
6137              && data.last_start_min == 0 && data.last_end > 0
6138              && !RExC_seen_zerolen
6139              && !(RExC_seen & REG_SEEN_VERBARG)
6140              && (!(RExC_seen & REG_SEEN_GPOS) || (r->extflags & RXf_ANCH_GPOS)))
6141             r->extflags |= RXf_CHECK_ALL;
6142         scan_commit(pRExC_state, &data,&minlen,0);
6143
6144         longest_float_length = CHR_SVLEN(data.longest_float);
6145
6146         if (! ((SvCUR(data.longest_fixed)  /* ok to leave SvCUR */
6147                    && data.offset_fixed == data.offset_float_min
6148                    && SvCUR(data.longest_fixed) == SvCUR(data.longest_float)))
6149             && S_setup_longest (aTHX_ pRExC_state,
6150                                     data.longest_float,
6151                                     &(r->float_utf8),
6152                                     &(r->float_substr),
6153                                     &(r->float_end_shift),
6154                                     data.lookbehind_float,
6155                                     data.offset_float_min,
6156                                     data.minlen_float,
6157                                     longest_float_length,
6158                                     cBOOL(data.flags & SF_FL_BEFORE_EOL),
6159                                     cBOOL(data.flags & SF_FL_BEFORE_MEOL)))
6160         {
6161             r->float_min_offset = data.offset_float_min - data.lookbehind_float;
6162             r->float_max_offset = data.offset_float_max;
6163             if (data.offset_float_max < I32_MAX) /* Don't offset infinity */
6164                 r->float_max_offset -= data.lookbehind_float;
6165             SvREFCNT_inc_simple_void_NN(data.longest_float);
6166         }
6167         else {
6168             r->float_substr = r->float_utf8 = NULL;
6169             longest_float_length = 0;
6170         }
6171
6172         longest_fixed_length = CHR_SVLEN(data.longest_fixed);
6173
6174         if (S_setup_longest (aTHX_ pRExC_state,
6175                                 data.longest_fixed,
6176                                 &(r->anchored_utf8),
6177                                 &(r->anchored_substr),
6178                                 &(r->anchored_end_shift),
6179                                 data.lookbehind_fixed,
6180                                 data.offset_fixed,
6181                                 data.minlen_fixed,
6182                                 longest_fixed_length,
6183                                 cBOOL(data.flags & SF_FIX_BEFORE_EOL),
6184                                 cBOOL(data.flags & SF_FIX_BEFORE_MEOL)))
6185         {
6186             r->anchored_offset = data.offset_fixed - data.lookbehind_fixed;
6187             SvREFCNT_inc_simple_void_NN(data.longest_fixed);
6188         }
6189         else {
6190             r->anchored_substr = r->anchored_utf8 = NULL;
6191             longest_fixed_length = 0;
6192         }
6193         LEAVE_with_name("study_chunk");
6194
6195         if (ri->regstclass
6196             && (OP(ri->regstclass) == REG_ANY || OP(ri->regstclass) == SANY))
6197             ri->regstclass = NULL;
6198
6199         if ((!(r->anchored_substr || r->anchored_utf8) || r->anchored_offset)
6200             && stclass_flag
6201             && ! TEST_SSC_EOS(data.start_class)
6202             && !cl_is_anything(data.start_class))
6203         {
6204             const U32 n = add_data(pRExC_state, 1, "f");
6205             OP(data.start_class) = ANYOF_SYNTHETIC;
6206
6207             Newx(RExC_rxi->data->data[n], 1,
6208                 struct regnode_charclass_class);
6209             StructCopy(data.start_class,
6210                        (struct regnode_charclass_class*)RExC_rxi->data->data[n],
6211                        struct regnode_charclass_class);
6212             ri->regstclass = (regnode*)RExC_rxi->data->data[n];
6213             r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
6214             DEBUG_COMPILE_r({ SV *sv = sv_newmortal();
6215                       regprop(r, sv, (regnode*)data.start_class);
6216                       PerlIO_printf(Perl_debug_log,
6217                                     "synthetic stclass \"%s\".\n",
6218                                     SvPVX_const(sv));});
6219         }
6220
6221         /* A temporary algorithm prefers floated substr to fixed one to dig more info. */
6222         if (longest_fixed_length > longest_float_length) {
6223             r->check_end_shift = r->anchored_end_shift;
6224             r->check_substr = r->anchored_substr;
6225             r->check_utf8 = r->anchored_utf8;
6226             r->check_offset_min = r->check_offset_max = r->anchored_offset;
6227             if (r->extflags & RXf_ANCH_SINGLE)
6228                 r->extflags |= RXf_NOSCAN;
6229         }
6230         else {
6231             r->check_end_shift = r->float_end_shift;
6232             r->check_substr = r->float_substr;
6233             r->check_utf8 = r->float_utf8;
6234             r->check_offset_min = r->float_min_offset;
6235             r->check_offset_max = r->float_max_offset;
6236         }
6237         /* XXXX Currently intuiting is not compatible with ANCH_GPOS.
6238            This should be changed ASAP!  */
6239         if ((r->check_substr || r->check_utf8) && !(r->extflags & RXf_ANCH_GPOS)) {
6240             r->extflags |= RXf_USE_INTUIT;
6241             if (SvTAIL(r->check_substr ? r->check_substr : r->check_utf8))
6242                 r->extflags |= RXf_INTUIT_TAIL;
6243         }
6244         /* XXX Unneeded? dmq (shouldn't as this is handled elsewhere)
6245         if ( (STRLEN)minlen < longest_float_length )
6246             minlen= longest_float_length;
6247         if ( (STRLEN)minlen < longest_fixed_length )
6248             minlen= longest_fixed_length;     
6249         */
6250     }
6251     else {
6252         /* Several toplevels. Best we can is to set minlen. */
6253         I32 fake;
6254         struct regnode_charclass_class ch_class;
6255         I32 last_close = 0;
6256
6257         DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log, "\nMulti Top Level\n"));
6258
6259         scan = ri->program + 1;
6260         cl_init(pRExC_state, &ch_class);
6261         data.start_class = &ch_class;
6262         data.last_closep = &last_close;
6263
6264         
6265         minlen = study_chunk(pRExC_state, &scan, &minlen, &fake, scan + RExC_size,
6266             &data, -1, NULL, NULL, SCF_DO_STCLASS_AND|SCF_WHILEM_VISITED_POS,0);
6267         
6268         CHECK_RESTUDY_GOTO_butfirst(NOOP);
6269
6270         r->check_substr = r->check_utf8 = r->anchored_substr = r->anchored_utf8
6271                 = r->float_substr = r->float_utf8 = NULL;
6272
6273         if (! TEST_SSC_EOS(data.start_class)
6274             && !cl_is_anything(data.start_class))
6275         {
6276             const U32 n = add_data(pRExC_state, 1, "f");
6277             OP(data.start_class) = ANYOF_SYNTHETIC;
6278
6279             Newx(RExC_rxi->data->data[n], 1,
6280                 struct regnode_charclass_class);
6281             StructCopy(data.start_class,
6282                        (struct regnode_charclass_class*)RExC_rxi->data->data[n],
6283                        struct regnode_charclass_class);
6284             ri->regstclass = (regnode*)RExC_rxi->data->data[n];
6285             r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
6286             DEBUG_COMPILE_r({ SV* sv = sv_newmortal();
6287                       regprop(r, sv, (regnode*)data.start_class);
6288                       PerlIO_printf(Perl_debug_log,
6289                                     "synthetic stclass \"%s\".\n",
6290                                     SvPVX_const(sv));});
6291         }
6292     }
6293
6294     /* Guard against an embedded (?=) or (?<=) with a longer minlen than
6295        the "real" pattern. */
6296     DEBUG_OPTIMISE_r({
6297         PerlIO_printf(Perl_debug_log,"minlen: %"IVdf" r->minlen:%"IVdf"\n",
6298                       (IV)minlen, (IV)r->minlen);
6299     });
6300     r->minlenret = minlen;
6301     if (r->minlen < minlen) 
6302         r->minlen = minlen;
6303     
6304     if (RExC_seen & REG_SEEN_GPOS)
6305         r->extflags |= RXf_GPOS_SEEN;
6306     if (RExC_seen & REG_SEEN_LOOKBEHIND)
6307         r->extflags |= RXf_NO_INPLACE_SUBST; /* inplace might break the lookbehind */
6308     if (pRExC_state->num_code_blocks)
6309         r->extflags |= RXf_EVAL_SEEN;
6310     if (RExC_seen & REG_SEEN_CANY)
6311         r->extflags |= RXf_CANY_SEEN;
6312     if (RExC_seen & REG_SEEN_VERBARG)
6313     {
6314         r->intflags |= PREGf_VERBARG_SEEN;
6315         r->extflags |= RXf_NO_INPLACE_SUBST; /* don't understand this! Yves */
6316     }
6317     if (RExC_seen & REG_SEEN_CUTGROUP)
6318         r->intflags |= PREGf_CUTGROUP_SEEN;
6319     if (pm_flags & PMf_USE_RE_EVAL)
6320         r->intflags |= PREGf_USE_RE_EVAL;
6321     if (RExC_paren_names)
6322         RXp_PAREN_NAMES(r) = MUTABLE_HV(SvREFCNT_inc(RExC_paren_names));
6323     else
6324         RXp_PAREN_NAMES(r) = NULL;
6325
6326     {
6327         regnode *first = ri->program + 1;
6328         U8 fop = OP(first);
6329         regnode *next = NEXTOPER(first);
6330         U8 nop = OP(next);
6331
6332         if (PL_regkind[fop] == NOTHING && nop == END)
6333             r->extflags |= RXf_NULL;
6334         else if (PL_regkind[fop] == BOL && nop == END)
6335             r->extflags |= RXf_START_ONLY;
6336         else if (fop == PLUS && PL_regkind[nop] == POSIXD && FLAGS(next) == _CC_SPACE && OP(regnext(first)) == END)
6337             r->extflags |= RXf_WHITE;
6338         else if ( r->extflags & RXf_SPLIT && fop == EXACT && STR_LEN(first) == 1 && *(STRING(first)) == ' ' && OP(regnext(first)) == END )
6339             r->extflags |= (RXf_SKIPWHITE|RXf_WHITE);
6340
6341     }
6342 #ifdef DEBUGGING
6343     if (RExC_paren_names) {
6344         ri->name_list_idx = add_data( pRExC_state, 1, "a" );
6345         ri->data->data[ri->name_list_idx] = (void*)SvREFCNT_inc(RExC_paren_name_list);
6346     } else
6347 #endif
6348         ri->name_list_idx = 0;
6349
6350     if (RExC_recurse_count) {
6351         for ( ; RExC_recurse_count ; RExC_recurse_count-- ) {
6352             const regnode *scan = RExC_recurse[RExC_recurse_count-1];
6353             ARG2L_SET( scan, RExC_open_parens[ARG(scan)-1] - scan );
6354         }
6355     }
6356     Newxz(r->offs, RExC_npar, regexp_paren_pair);
6357     /* assume we don't need to swap parens around before we match */
6358
6359     DEBUG_DUMP_r({
6360         PerlIO_printf(Perl_debug_log,"Final program:\n");
6361         regdump(r);
6362     });
6363 #ifdef RE_TRACK_PATTERN_OFFSETS
6364     DEBUG_OFFSETS_r(if (ri->u.offsets) {
6365         const U32 len = ri->u.offsets[0];
6366         U32 i;
6367         GET_RE_DEBUG_FLAGS_DECL;
6368         PerlIO_printf(Perl_debug_log, "Offsets: [%"UVuf"]\n\t", (UV)ri->u.offsets[0]);
6369         for (i = 1; i <= len; i++) {
6370             if (ri->u.offsets[i*2-1] || ri->u.offsets[i*2])
6371                 PerlIO_printf(Perl_debug_log, "%"UVuf":%"UVuf"[%"UVuf"] ",
6372                 (UV)i, (UV)ri->u.offsets[i*2-1], (UV)ri->u.offsets[i*2]);
6373             }
6374         PerlIO_printf(Perl_debug_log, "\n");
6375     });
6376 #endif
6377
6378 #ifdef USE_ITHREADS
6379     /* under ithreads the ?pat? PMf_USED flag on the pmop is simulated
6380      * by setting the regexp SV to readonly-only instead. If the
6381      * pattern's been recompiled, the USEDness should remain. */
6382     if (old_re && SvREADONLY(old_re))
6383         SvREADONLY_on(rx);
6384 #endif
6385     return rx;
6386 }
6387
6388
6389 SV*
6390 Perl_reg_named_buff(pTHX_ REGEXP * const rx, SV * const key, SV * const value,
6391                     const U32 flags)
6392 {
6393     PERL_ARGS_ASSERT_REG_NAMED_BUFF;
6394
6395     PERL_UNUSED_ARG(value);
6396
6397     if (flags & RXapif_FETCH) {
6398         return reg_named_buff_fetch(rx, key, flags);
6399     } else if (flags & (RXapif_STORE | RXapif_DELETE | RXapif_CLEAR)) {
6400         Perl_croak_no_modify();
6401         return NULL;
6402     } else if (flags & RXapif_EXISTS) {
6403         return reg_named_buff_exists(rx, key, flags)
6404             ? &PL_sv_yes
6405             : &PL_sv_no;
6406     } else if (flags & RXapif_REGNAMES) {
6407         return reg_named_buff_all(rx, flags);
6408     } else if (flags & (RXapif_SCALAR | RXapif_REGNAMES_COUNT)) {
6409         return reg_named_buff_scalar(rx, flags);
6410     } else {
6411         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff", (int)flags);
6412         return NULL;
6413     }
6414 }
6415
6416 SV*
6417 Perl_reg_named_buff_iter(pTHX_ REGEXP * const rx, const SV * const lastkey,
6418                          const U32 flags)
6419 {
6420     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ITER;
6421     PERL_UNUSED_ARG(lastkey);
6422
6423     if (flags & RXapif_FIRSTKEY)
6424         return reg_named_buff_firstkey(rx, flags);
6425     else if (flags & RXapif_NEXTKEY)
6426         return reg_named_buff_nextkey(rx, flags);
6427     else {
6428         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_iter", (int)flags);
6429         return NULL;
6430     }
6431 }
6432
6433 SV*
6434 Perl_reg_named_buff_fetch(pTHX_ REGEXP * const r, SV * const namesv,
6435                           const U32 flags)
6436 {
6437     AV *retarray = NULL;
6438     SV *ret;
6439     struct regexp *const rx = ReANY(r);
6440
6441     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FETCH;
6442
6443     if (flags & RXapif_ALL)
6444         retarray=newAV();
6445
6446     if (rx && RXp_PAREN_NAMES(rx)) {
6447         HE *he_str = hv_fetch_ent( RXp_PAREN_NAMES(rx), namesv, 0, 0 );
6448         if (he_str) {
6449             IV i;
6450             SV* sv_dat=HeVAL(he_str);
6451             I32 *nums=(I32*)SvPVX(sv_dat);
6452             for ( i=0; i<SvIVX(sv_dat); i++ ) {
6453                 if ((I32)(rx->nparens) >= nums[i]
6454                     && rx->offs[nums[i]].start != -1
6455                     && rx->offs[nums[i]].end != -1)
6456                 {
6457                     ret = newSVpvs("");
6458                     CALLREG_NUMBUF_FETCH(r,nums[i],ret);
6459                     if (!retarray)
6460                         return ret;
6461                 } else {
6462                     if (retarray)
6463                         ret = newSVsv(&PL_sv_undef);
6464                 }
6465                 if (retarray)
6466                     av_push(retarray, ret);
6467             }
6468             if (retarray)
6469                 return newRV_noinc(MUTABLE_SV(retarray));
6470         }
6471     }
6472     return NULL;
6473 }
6474
6475 bool
6476 Perl_reg_named_buff_exists(pTHX_ REGEXP * const r, SV * const key,
6477                            const U32 flags)
6478 {
6479     struct regexp *const rx = ReANY(r);
6480
6481     PERL_ARGS_ASSERT_REG_NAMED_BUFF_EXISTS;
6482
6483     if (rx && RXp_PAREN_NAMES(rx)) {
6484         if (flags & RXapif_ALL) {
6485             return hv_exists_ent(RXp_PAREN_NAMES(rx), key, 0);
6486         } else {
6487             SV *sv = CALLREG_NAMED_BUFF_FETCH(r, key, flags);
6488             if (sv) {
6489                 SvREFCNT_dec_NN(sv);
6490                 return TRUE;
6491             } else {
6492                 return FALSE;
6493             }
6494         }
6495     } else {
6496         return FALSE;
6497     }
6498 }
6499
6500 SV*
6501 Perl_reg_named_buff_firstkey(pTHX_ REGEXP * const r, const U32 flags)
6502 {
6503     struct regexp *const rx = ReANY(r);
6504
6505     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FIRSTKEY;
6506
6507     if ( rx && RXp_PAREN_NAMES(rx) ) {
6508         (void)hv_iterinit(RXp_PAREN_NAMES(rx));
6509
6510         return CALLREG_NAMED_BUFF_NEXTKEY(r, NULL, flags & ~RXapif_FIRSTKEY);
6511     } else {
6512         return FALSE;
6513     }
6514 }
6515
6516 SV*
6517 Perl_reg_named_buff_nextkey(pTHX_ REGEXP * const r, const U32 flags)
6518 {
6519     struct regexp *const rx = ReANY(r);
6520     GET_RE_DEBUG_FLAGS_DECL;
6521
6522     PERL_ARGS_ASSERT_REG_NAMED_BUFF_NEXTKEY;
6523
6524     if (rx && RXp_PAREN_NAMES(rx)) {
6525         HV *hv = RXp_PAREN_NAMES(rx);
6526         HE *temphe;
6527         while ( (temphe = hv_iternext_flags(hv,0)) ) {
6528             IV i;
6529             IV parno = 0;
6530             SV* sv_dat = HeVAL(temphe);
6531             I32 *nums = (I32*)SvPVX(sv_dat);
6532             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
6533                 if ((I32)(rx->lastparen) >= nums[i] &&
6534                     rx->offs[nums[i]].start != -1 &&
6535                     rx->offs[nums[i]].end != -1)
6536                 {
6537                     parno = nums[i];
6538                     break;
6539                 }
6540             }
6541             if (parno || flags & RXapif_ALL) {
6542                 return newSVhek(HeKEY_hek(temphe));
6543             }
6544         }
6545     }
6546     return NULL;
6547 }
6548
6549 SV*
6550 Perl_reg_named_buff_scalar(pTHX_ REGEXP * const r, const U32 flags)
6551 {
6552     SV *ret;
6553     AV *av;
6554     I32 length;
6555     struct regexp *const rx = ReANY(r);
6556
6557     PERL_ARGS_ASSERT_REG_NAMED_BUFF_SCALAR;
6558
6559     if (rx && RXp_PAREN_NAMES(rx)) {
6560         if (flags & (RXapif_ALL | RXapif_REGNAMES_COUNT)) {
6561             return newSViv(HvTOTALKEYS(RXp_PAREN_NAMES(rx)));
6562         } else if (flags & RXapif_ONE) {
6563             ret = CALLREG_NAMED_BUFF_ALL(r, (flags | RXapif_REGNAMES));
6564             av = MUTABLE_AV(SvRV(ret));
6565             length = av_len(av);
6566             SvREFCNT_dec_NN(ret);
6567             return newSViv(length + 1);
6568         } else {
6569             Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_scalar", (int)flags);
6570             return NULL;
6571         }
6572     }
6573     return &PL_sv_undef;
6574 }
6575
6576 SV*
6577 Perl_reg_named_buff_all(pTHX_ REGEXP * const r, const U32 flags)
6578 {
6579     struct regexp *const rx = ReANY(r);
6580     AV *av = newAV();
6581
6582     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ALL;
6583
6584     if (rx && RXp_PAREN_NAMES(rx)) {
6585         HV *hv= RXp_PAREN_NAMES(rx);
6586         HE *temphe;
6587         (void)hv_iterinit(hv);
6588         while ( (temphe = hv_iternext_flags(hv,0)) ) {
6589             IV i;
6590             IV parno = 0;
6591             SV* sv_dat = HeVAL(temphe);
6592             I32 *nums = (I32*)SvPVX(sv_dat);
6593             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
6594                 if ((I32)(rx->lastparen) >= nums[i] &&
6595                     rx->offs[nums[i]].start != -1 &&
6596                     rx->offs[nums[i]].end != -1)
6597                 {
6598                     parno = nums[i];
6599                     break;
6600                 }
6601             }
6602             if (parno || flags & RXapif_ALL) {
6603                 av_push(av, newSVhek(HeKEY_hek(temphe)));
6604             }
6605         }
6606     }
6607
6608     return newRV_noinc(MUTABLE_SV(av));
6609 }
6610
6611 void
6612 Perl_reg_numbered_buff_fetch(pTHX_ REGEXP * const r, const I32 paren,
6613                              SV * const sv)
6614 {
6615     struct regexp *const rx = ReANY(r);
6616     char *s = NULL;
6617     I32 i = 0;
6618     I32 s1, t1;
6619     I32 n = paren;
6620
6621     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_FETCH;
6622         
6623     if ( (    n == RX_BUFF_IDX_CARET_PREMATCH
6624            || n == RX_BUFF_IDX_CARET_FULLMATCH
6625            || n == RX_BUFF_IDX_CARET_POSTMATCH
6626          )
6627          && !(rx->extflags & RXf_PMf_KEEPCOPY)
6628     )
6629         goto ret_undef;
6630
6631     if (!rx->subbeg)
6632         goto ret_undef;
6633
6634     if (n == RX_BUFF_IDX_CARET_FULLMATCH)
6635         /* no need to distinguish between them any more */
6636         n = RX_BUFF_IDX_FULLMATCH;
6637
6638     if ((n == RX_BUFF_IDX_PREMATCH || n == RX_BUFF_IDX_CARET_PREMATCH)
6639         && rx->offs[0].start != -1)
6640     {
6641         /* $`, ${^PREMATCH} */
6642         i = rx->offs[0].start;
6643         s = rx->subbeg;
6644     }
6645     else 
6646     if ((n == RX_BUFF_IDX_POSTMATCH || n == RX_BUFF_IDX_CARET_POSTMATCH)
6647         && rx->offs[0].end != -1)
6648     {
6649         /* $', ${^POSTMATCH} */
6650         s = rx->subbeg - rx->suboffset + rx->offs[0].end;
6651         i = rx->sublen + rx->suboffset - rx->offs[0].end;
6652     } 
6653     else
6654     if ( 0 <= n && n <= (I32)rx->nparens &&
6655         (s1 = rx->offs[n].start) != -1 &&
6656         (t1 = rx->offs[n].end) != -1)
6657     {
6658         /* $&, ${^MATCH},  $1 ... */
6659         i = t1 - s1;
6660         s = rx->subbeg + s1 - rx->suboffset;
6661     } else {
6662         goto ret_undef;
6663     }          
6664
6665     assert(s >= rx->subbeg);
6666     assert(rx->sublen >= (s - rx->subbeg) + i );
6667     if (i >= 0) {
6668 #if NO_TAINT_SUPPORT
6669         sv_setpvn(sv, s, i);
6670 #else
6671         const int oldtainted = TAINT_get;
6672         TAINT_NOT;
6673         sv_setpvn(sv, s, i);
6674         TAINT_set(oldtainted);
6675 #endif
6676         if ( (rx->extflags & RXf_CANY_SEEN)
6677             ? (RXp_MATCH_UTF8(rx)
6678                         && (!i || is_utf8_string((U8*)s, i)))
6679             : (RXp_MATCH_UTF8(rx)) )
6680         {
6681             SvUTF8_on(sv);
6682         }
6683         else
6684             SvUTF8_off(sv);
6685         if (TAINTING_get) {
6686             if (RXp_MATCH_TAINTED(rx)) {
6687                 if (SvTYPE(sv) >= SVt_PVMG) {
6688                     MAGIC* const mg = SvMAGIC(sv);
6689                     MAGIC* mgt;
6690                     TAINT;
6691                     SvMAGIC_set(sv, mg->mg_moremagic);
6692                     SvTAINT(sv);
6693                     if ((mgt = SvMAGIC(sv))) {
6694                         mg->mg_moremagic = mgt;
6695                         SvMAGIC_set(sv, mg);
6696                     }
6697                 } else {
6698                     TAINT;
6699                     SvTAINT(sv);
6700                 }
6701             } else 
6702                 SvTAINTED_off(sv);
6703         }
6704     } else {
6705       ret_undef:
6706         sv_setsv(sv,&PL_sv_undef);
6707         return;
6708     }
6709 }
6710
6711 void
6712 Perl_reg_numbered_buff_store(pTHX_ REGEXP * const rx, const I32 paren,
6713                                                          SV const * const value)
6714 {
6715     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_STORE;
6716
6717     PERL_UNUSED_ARG(rx);
6718     PERL_UNUSED_ARG(paren);
6719     PERL_UNUSED_ARG(value);
6720
6721     if (!PL_localizing)
6722         Perl_croak_no_modify();
6723 }
6724
6725 I32
6726 Perl_reg_numbered_buff_length(pTHX_ REGEXP * const r, const SV * const sv,
6727                               const I32 paren)
6728 {
6729     struct regexp *const rx = ReANY(r);
6730     I32 i;
6731     I32 s1, t1;
6732
6733     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_LENGTH;
6734
6735     /* Some of this code was originally in C<Perl_magic_len> in F<mg.c> */
6736     switch (paren) {
6737       case RX_BUFF_IDX_CARET_PREMATCH: /* ${^PREMATCH} */
6738          if (!(rx->extflags & RXf_PMf_KEEPCOPY))
6739             goto warn_undef;
6740         /*FALLTHROUGH*/
6741
6742       case RX_BUFF_IDX_PREMATCH:       /* $` */
6743         if (rx->offs[0].start != -1) {
6744                         i = rx->offs[0].start;
6745                         if (i > 0) {
6746                                 s1 = 0;
6747                                 t1 = i;
6748                                 goto getlen;
6749                         }
6750             }
6751         return 0;
6752
6753       case RX_BUFF_IDX_CARET_POSTMATCH: /* ${^POSTMATCH} */
6754          if (!(rx->extflags & RXf_PMf_KEEPCOPY))
6755             goto warn_undef;
6756       case RX_BUFF_IDX_POSTMATCH:       /* $' */
6757             if (rx->offs[0].end != -1) {
6758                         i = rx->sublen - rx->offs[0].end;
6759                         if (i > 0) {
6760                                 s1 = rx->offs[0].end;
6761                                 t1 = rx->sublen;
6762                                 goto getlen;
6763                         }
6764             }
6765         return 0;
6766
6767       case RX_BUFF_IDX_CARET_FULLMATCH: /* ${^MATCH} */
6768          if (!(rx->extflags & RXf_PMf_KEEPCOPY))
6769             goto warn_undef;
6770         /*FALLTHROUGH*/
6771
6772       /* $& / ${^MATCH}, $1, $2, ... */
6773       default:
6774             if (paren <= (I32)rx->nparens &&
6775             (s1 = rx->offs[paren].start) != -1 &&
6776             (t1 = rx->offs[paren].end) != -1)
6777             {
6778             i = t1 - s1;
6779             goto getlen;
6780         } else {
6781           warn_undef:
6782             if (ckWARN(WARN_UNINITIALIZED))
6783                 report_uninit((const SV *)sv);
6784             return 0;
6785         }
6786     }
6787   getlen:
6788     if (i > 0 && RXp_MATCH_UTF8(rx)) {
6789         const char * const s = rx->subbeg - rx->suboffset + s1;
6790         const U8 *ep;
6791         STRLEN el;
6792
6793         i = t1 - s1;
6794         if (is_utf8_string_loclen((U8*)s, i, &ep, &el))
6795                         i = el;
6796     }
6797     return i;
6798 }
6799
6800 SV*
6801 Perl_reg_qr_package(pTHX_ REGEXP * const rx)
6802 {
6803     PERL_ARGS_ASSERT_REG_QR_PACKAGE;
6804         PERL_UNUSED_ARG(rx);
6805         if (0)
6806             return NULL;
6807         else
6808             return newSVpvs("Regexp");
6809 }
6810
6811 /* Scans the name of a named buffer from the pattern.
6812  * If flags is REG_RSN_RETURN_NULL returns null.
6813  * If flags is REG_RSN_RETURN_NAME returns an SV* containing the name
6814  * If flags is REG_RSN_RETURN_DATA returns the data SV* corresponding
6815  * to the parsed name as looked up in the RExC_paren_names hash.
6816  * If there is an error throws a vFAIL().. type exception.
6817  */
6818
6819 #define REG_RSN_RETURN_NULL    0
6820 #define REG_RSN_RETURN_NAME    1
6821 #define REG_RSN_RETURN_DATA    2
6822
6823 STATIC SV*
6824 S_reg_scan_name(pTHX_ RExC_state_t *pRExC_state, U32 flags)
6825 {
6826     char *name_start = RExC_parse;
6827
6828     PERL_ARGS_ASSERT_REG_SCAN_NAME;
6829
6830     if (isIDFIRST_lazy_if(RExC_parse, UTF)) {
6831          /* skip IDFIRST by using do...while */
6832         if (UTF)
6833             do {
6834                 RExC_parse += UTF8SKIP(RExC_parse);
6835             } while (isWORDCHAR_utf8((U8*)RExC_parse));
6836         else
6837             do {
6838                 RExC_parse++;
6839             } while (isWORDCHAR(*RExC_parse));
6840     } else {
6841         RExC_parse++; /* so the <- from the vFAIL is after the offending character */
6842         vFAIL("Group name must start with a non-digit word character");
6843     }
6844     if ( flags ) {
6845         SV* sv_name
6846             = newSVpvn_flags(name_start, (int)(RExC_parse - name_start),
6847                              SVs_TEMP | (UTF ? SVf_UTF8 : 0));
6848         if ( flags == REG_RSN_RETURN_NAME)
6849             return sv_name;
6850         else if (flags==REG_RSN_RETURN_DATA) {
6851             HE *he_str = NULL;
6852             SV *sv_dat = NULL;
6853             if ( ! sv_name )      /* should not happen*/
6854                 Perl_croak(aTHX_ "panic: no svname in reg_scan_name");
6855             if (RExC_paren_names)
6856                 he_str = hv_fetch_ent( RExC_paren_names, sv_name, 0, 0 );
6857             if ( he_str )
6858                 sv_dat = HeVAL(he_str);
6859             if ( ! sv_dat )
6860                 vFAIL("Reference to nonexistent named group");
6861             return sv_dat;
6862         }
6863         else {
6864             Perl_croak(aTHX_ "panic: bad flag %lx in reg_scan_name",
6865                        (unsigned long) flags);
6866         }
6867         assert(0); /* NOT REACHED */
6868     }
6869     return NULL;
6870 }
6871
6872 #define DEBUG_PARSE_MSG(funcname)     DEBUG_PARSE_r({           \
6873     int rem=(int)(RExC_end - RExC_parse);                       \
6874     int cut;                                                    \
6875     int num;                                                    \
6876     int iscut=0;                                                \
6877     if (rem>10) {                                               \
6878         rem=10;                                                 \
6879         iscut=1;                                                \
6880     }                                                           \
6881     cut=10-rem;                                                 \
6882     if (RExC_lastparse!=RExC_parse)                             \
6883         PerlIO_printf(Perl_debug_log," >%.*s%-*s",              \
6884             rem, RExC_parse,                                    \
6885             cut + 4,                                            \
6886             iscut ? "..." : "<"                                 \
6887         );                                                      \
6888     else                                                        \
6889         PerlIO_printf(Perl_debug_log,"%16s","");                \
6890                                                                 \
6891     if (SIZE_ONLY)                                              \
6892        num = RExC_size + 1;                                     \
6893     else                                                        \
6894        num=REG_NODE_NUM(RExC_emit);                             \
6895     if (RExC_lastnum!=num)                                      \
6896        PerlIO_printf(Perl_debug_log,"|%4d",num);                \
6897     else                                                        \
6898        PerlIO_printf(Perl_debug_log,"|%4s","");                 \
6899     PerlIO_printf(Perl_debug_log,"|%*s%-4s",                    \
6900         (int)((depth*2)), "",                                   \
6901         (funcname)                                              \
6902     );                                                          \
6903     RExC_lastnum=num;                                           \
6904     RExC_lastparse=RExC_parse;                                  \
6905 })
6906
6907
6908
6909 #define DEBUG_PARSE(funcname)     DEBUG_PARSE_r({           \
6910     DEBUG_PARSE_MSG((funcname));                            \
6911     PerlIO_printf(Perl_debug_log,"%4s","\n");               \
6912 })
6913 #define DEBUG_PARSE_FMT(funcname,fmt,args)     DEBUG_PARSE_r({           \
6914     DEBUG_PARSE_MSG((funcname));                            \
6915     PerlIO_printf(Perl_debug_log,fmt "\n",args);               \
6916 })
6917
6918 /* This section of code defines the inversion list object and its methods.  The
6919  * interfaces are highly subject to change, so as much as possible is static to
6920  * this file.  An inversion list is here implemented as a malloc'd C UV array
6921  * with some added info that is placed as UVs at the beginning in a header
6922  * portion.  An inversion list for Unicode is an array of code points, sorted
6923  * by ordinal number.  The zeroth element is the first code point in the list.
6924  * The 1th element is the first element beyond that not in the list.  In other
6925  * words, the first range is
6926  *  invlist[0]..(invlist[1]-1)
6927  * The other ranges follow.  Thus every element whose index is divisible by two
6928  * marks the beginning of a range that is in the list, and every element not
6929  * divisible by two marks the beginning of a range not in the list.  A single
6930  * element inversion list that contains the single code point N generally
6931  * consists of two elements
6932  *  invlist[0] == N
6933  *  invlist[1] == N+1
6934  * (The exception is when N is the highest representable value on the
6935  * machine, in which case the list containing just it would be a single
6936  * element, itself.  By extension, if the last range in the list extends to
6937  * infinity, then the first element of that range will be in the inversion list
6938  * at a position that is divisible by two, and is the final element in the
6939  * list.)
6940  * Taking the complement (inverting) an inversion list is quite simple, if the
6941  * first element is 0, remove it; otherwise add a 0 element at the beginning.
6942  * This implementation reserves an element at the beginning of each inversion
6943  * list to contain 0 when the list contains 0, and contains 1 otherwise.  The
6944  * actual beginning of the list is either that element if 0, or the next one if
6945  * 1.
6946  *
6947  * More about inversion lists can be found in "Unicode Demystified"
6948  * Chapter 13 by Richard Gillam, published by Addison-Wesley.
6949  * More will be coming when functionality is added later.
6950  *
6951  * The inversion list data structure is currently implemented as an SV pointing
6952  * to an array of UVs that the SV thinks are bytes.  This allows us to have an
6953  * array of UV whose memory management is automatically handled by the existing
6954  * facilities for SV's.
6955  *
6956  * Some of the methods should always be private to the implementation, and some
6957  * should eventually be made public */
6958
6959 /* The header definitions are in F<inline_invlist.c> */
6960 #define TO_INTERNAL_SIZE(x) (((x) + HEADER_LENGTH) * sizeof(UV))
6961 #define FROM_INTERNAL_SIZE(x) (((x)/ sizeof(UV)) - HEADER_LENGTH)
6962
6963 #define INVLIST_INITIAL_LEN 10
6964
6965 PERL_STATIC_INLINE UV*
6966 S__invlist_array_init(pTHX_ SV* const invlist, const bool will_have_0)
6967 {
6968     /* Returns a pointer to the first element in the inversion list's array.
6969      * This is called upon initialization of an inversion list.  Where the
6970      * array begins depends on whether the list has the code point U+0000
6971      * in it or not.  The other parameter tells it whether the code that
6972      * follows this call is about to put a 0 in the inversion list or not.
6973      * The first element is either the element with 0, if 0, or the next one,
6974      * if 1 */
6975
6976     UV* zero = get_invlist_zero_addr(invlist);
6977
6978     PERL_ARGS_ASSERT__INVLIST_ARRAY_INIT;
6979
6980     /* Must be empty */
6981     assert(! *_get_invlist_len_addr(invlist));
6982
6983     /* 1^1 = 0; 1^0 = 1 */
6984     *zero = 1 ^ will_have_0;
6985     return zero + *zero;
6986 }
6987
6988 PERL_STATIC_INLINE UV*
6989 S_invlist_array(pTHX_ SV* const invlist)
6990 {
6991     /* Returns the pointer to the inversion list's array.  Every time the
6992      * length changes, this needs to be called in case malloc or realloc moved
6993      * it */
6994
6995     PERL_ARGS_ASSERT_INVLIST_ARRAY;
6996
6997     /* Must not be empty.  If these fail, you probably didn't check for <len>
6998      * being non-zero before trying to get the array */
6999     assert(*_get_invlist_len_addr(invlist));
7000     assert(*get_invlist_zero_addr(invlist) == 0
7001            || *get_invlist_zero_addr(invlist) == 1);
7002
7003     /* The array begins either at the element reserved for zero if the
7004      * list contains 0 (that element will be set to 0), or otherwise the next
7005      * element (in which case the reserved element will be set to 1). */
7006     return (UV *) (get_invlist_zero_addr(invlist)
7007                    + *get_invlist_zero_addr(invlist));
7008 }
7009
7010 PERL_STATIC_INLINE void
7011 S_invlist_set_len(pTHX_ SV* const invlist, const UV len)
7012 {
7013     /* Sets the current number of elements stored in the inversion list */
7014
7015     PERL_ARGS_ASSERT_INVLIST_SET_LEN;
7016
7017     *_get_invlist_len_addr(invlist) = len;
7018
7019     assert(len <= SvLEN(invlist));
7020
7021     SvCUR_set(invlist, TO_INTERNAL_SIZE(len));
7022     /* If the list contains U+0000, that element is part of the header,
7023      * and should not be counted as part of the array.  It will contain
7024      * 0 in that case, and 1 otherwise.  So we could flop 0=>1, 1=>0 and
7025      * subtract:
7026      *  SvCUR_set(invlist,
7027      *            TO_INTERNAL_SIZE(len
7028      *                             - (*get_invlist_zero_addr(inv_list) ^ 1)));
7029      * But, this is only valid if len is not 0.  The consequences of not doing
7030      * this is that the memory allocation code may think that 1 more UV is
7031      * being used than actually is, and so might do an unnecessary grow.  That
7032      * seems worth not bothering to make this the precise amount.
7033      *
7034      * Note that when inverting, SvCUR shouldn't change */
7035 }
7036
7037 PERL_STATIC_INLINE IV*
7038 S_get_invlist_previous_index_addr(pTHX_ SV* invlist)
7039 {
7040     /* Return the address of the UV that is reserved to hold the cached index
7041      * */
7042
7043     PERL_ARGS_ASSERT_GET_INVLIST_PREVIOUS_INDEX_ADDR;
7044
7045     return (IV *) (SvPVX(invlist) + (INVLIST_PREVIOUS_INDEX_OFFSET * sizeof (UV)));
7046 }
7047
7048 PERL_STATIC_INLINE IV
7049 S_invlist_previous_index(pTHX_ SV* const invlist)
7050 {
7051     /* Returns cached index of previous search */
7052
7053     PERL_ARGS_ASSERT_INVLIST_PREVIOUS_INDEX;
7054
7055     return *get_invlist_previous_index_addr(invlist);
7056 }
7057
7058 PERL_STATIC_INLINE void
7059 S_invlist_set_previous_index(pTHX_ SV* const invlist, const IV index)
7060 {
7061     /* Caches <index> for later retrieval */
7062
7063     PERL_ARGS_ASSERT_INVLIST_SET_PREVIOUS_INDEX;
7064
7065     assert(index == 0 || index < (int) _invlist_len(invlist));
7066
7067     *get_invlist_previous_index_addr(invlist) = index;
7068 }
7069
7070 PERL_STATIC_INLINE UV
7071 S_invlist_max(pTHX_ SV* const invlist)
7072 {
7073     /* Returns the maximum number of elements storable in the inversion list's
7074      * array, without having to realloc() */
7075
7076     PERL_ARGS_ASSERT_INVLIST_MAX;
7077
7078     return SvLEN(invlist) == 0  /* This happens under _new_invlist_C_array */
7079            ? _invlist_len(invlist)
7080            : FROM_INTERNAL_SIZE(SvLEN(invlist));
7081 }
7082
7083 PERL_STATIC_INLINE UV*
7084 S_get_invlist_zero_addr(pTHX_ SV* invlist)
7085 {
7086     /* Return the address of the UV that is reserved to hold 0 if the inversion
7087      * list contains 0.  This has to be the last element of the heading, as the
7088      * list proper starts with either it if 0, or the next element if not.
7089      * (But we force it to contain either 0 or 1) */
7090
7091     PERL_ARGS_ASSERT_GET_INVLIST_ZERO_ADDR;
7092
7093     return (UV *) (SvPVX(invlist) + (INVLIST_ZERO_OFFSET * sizeof (UV)));
7094 }
7095
7096 #ifndef PERL_IN_XSUB_RE
7097 SV*
7098 Perl__new_invlist(pTHX_ IV initial_size)
7099 {
7100
7101     /* Return a pointer to a newly constructed inversion list, with enough
7102      * space to store 'initial_size' elements.  If that number is negative, a
7103      * system default is used instead */
7104
7105     SV* new_list;
7106
7107     if (initial_size < 0) {
7108         initial_size = INVLIST_INITIAL_LEN;
7109     }
7110
7111     /* Allocate the initial space */
7112     new_list = newSV(TO_INTERNAL_SIZE(initial_size));
7113     invlist_set_len(new_list, 0);
7114
7115     /* Force iterinit() to be used to get iteration to work */
7116     *get_invlist_iter_addr(new_list) = UV_MAX;
7117
7118     /* This should force a segfault if a method doesn't initialize this
7119      * properly */
7120     *get_invlist_zero_addr(new_list) = UV_MAX;
7121
7122     *get_invlist_previous_index_addr(new_list) = 0;
7123     *get_invlist_version_id_addr(new_list) = INVLIST_VERSION_ID;
7124 #if HEADER_LENGTH != 5
7125 #   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
7126 #endif
7127
7128     return new_list;
7129 }
7130 #endif
7131
7132 STATIC SV*
7133 S__new_invlist_C_array(pTHX_ UV* list)
7134 {
7135     /* Return a pointer to a newly constructed inversion list, initialized to
7136      * point to <list>, which has to be in the exact correct inversion list
7137      * form, including internal fields.  Thus this is a dangerous routine that
7138      * should not be used in the wrong hands */
7139
7140     SV* invlist = newSV_type(SVt_PV);
7141
7142     PERL_ARGS_ASSERT__NEW_INVLIST_C_ARRAY;
7143
7144     SvPV_set(invlist, (char *) list);
7145     SvLEN_set(invlist, 0);  /* Means we own the contents, and the system
7146                                shouldn't touch it */
7147     SvCUR_set(invlist, TO_INTERNAL_SIZE(_invlist_len(invlist)));
7148
7149     if (*get_invlist_version_id_addr(invlist) != INVLIST_VERSION_ID) {
7150         Perl_croak(aTHX_ "panic: Incorrect version for previously generated inversion list");
7151     }
7152
7153     /* Initialize the iteration pointer.
7154      * XXX This could be done at compile time in charclass_invlists.h, but I
7155      * (khw) am not confident that the suffixes for specifying the C constant
7156      * UV_MAX are portable, e.g.  'ull' on a 32 bit machine that is configured
7157      * to use 64 bits; might need a Configure probe */
7158     invlist_iterfinish(invlist);
7159
7160     return invlist;
7161 }
7162
7163 STATIC void
7164 S_invlist_extend(pTHX_ SV* const invlist, const UV new_max)
7165 {
7166     /* Grow the maximum size of an inversion list */
7167
7168     PERL_ARGS_ASSERT_INVLIST_EXTEND;
7169
7170     SvGROW((SV *)invlist, TO_INTERNAL_SIZE(new_max));
7171 }
7172
7173 PERL_STATIC_INLINE void
7174 S_invlist_trim(pTHX_ SV* const invlist)
7175 {
7176     PERL_ARGS_ASSERT_INVLIST_TRIM;
7177
7178     /* Change the length of the inversion list to how many entries it currently
7179      * has */
7180
7181     SvPV_shrink_to_cur((SV *) invlist);
7182 }
7183
7184 #define _invlist_union_complement_2nd(a, b, output) _invlist_union_maybe_complement_2nd(a, b, TRUE, output)
7185
7186 STATIC void
7187 S__append_range_to_invlist(pTHX_ SV* const invlist, const UV start, const UV end)
7188 {
7189    /* Subject to change or removal.  Append the range from 'start' to 'end' at
7190     * the end of the inversion list.  The range must be above any existing
7191     * ones. */
7192
7193     UV* array;
7194     UV max = invlist_max(invlist);
7195     UV len = _invlist_len(invlist);
7196
7197     PERL_ARGS_ASSERT__APPEND_RANGE_TO_INVLIST;
7198
7199     if (len == 0) { /* Empty lists must be initialized */
7200         array = _invlist_array_init(invlist, start == 0);
7201     }
7202     else {
7203         /* Here, the existing list is non-empty. The current max entry in the
7204          * list is generally the first value not in the set, except when the
7205          * set extends to the end of permissible values, in which case it is
7206          * the first entry in that final set, and so this call is an attempt to
7207          * append out-of-order */
7208
7209         UV final_element = len - 1;
7210         array = invlist_array(invlist);
7211         if (array[final_element] > start
7212             || ELEMENT_RANGE_MATCHES_INVLIST(final_element))
7213         {
7214             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",
7215                        array[final_element], start,
7216                        ELEMENT_RANGE_MATCHES_INVLIST(final_element) ? 't' : 'f');
7217         }
7218
7219         /* Here, it is a legal append.  If the new range begins with the first
7220          * value not in the set, it is extending the set, so the new first
7221          * value not in the set is one greater than the newly extended range.
7222          * */
7223         if (array[final_element] == start) {
7224             if (end != UV_MAX) {
7225                 array[final_element] = end + 1;
7226             }
7227             else {
7228                 /* But if the end is the maximum representable on the machine,
7229                  * just let the range that this would extend to have no end */
7230                 invlist_set_len(invlist, len - 1);
7231             }
7232             return;
7233         }
7234     }
7235
7236     /* Here the new range doesn't extend any existing set.  Add it */
7237
7238     len += 2;   /* Includes an element each for the start and end of range */
7239
7240     /* If overflows the existing space, extend, which may cause the array to be
7241      * moved */
7242     if (max < len) {
7243         invlist_extend(invlist, len);
7244         invlist_set_len(invlist, len);  /* Have to set len here to avoid assert
7245                                            failure in invlist_array() */
7246         array = invlist_array(invlist);
7247     }
7248     else {
7249         invlist_set_len(invlist, len);
7250     }
7251
7252     /* The next item on the list starts the range, the one after that is
7253      * one past the new range.  */
7254     array[len - 2] = start;
7255     if (end != UV_MAX) {
7256         array[len - 1] = end + 1;
7257     }
7258     else {
7259         /* But if the end is the maximum representable on the machine, just let
7260          * the range have no end */
7261         invlist_set_len(invlist, len - 1);
7262     }
7263 }
7264
7265 #ifndef PERL_IN_XSUB_RE
7266
7267 IV
7268 Perl__invlist_search(pTHX_ SV* const invlist, const UV cp)
7269 {
7270     /* Searches the inversion list for the entry that contains the input code
7271      * point <cp>.  If <cp> is not in the list, -1 is returned.  Otherwise, the
7272      * return value is the index into the list's array of the range that
7273      * contains <cp> */
7274
7275     IV low = 0;
7276     IV mid;
7277     IV high = _invlist_len(invlist);
7278     const IV highest_element = high - 1;
7279     const UV* array;
7280
7281     PERL_ARGS_ASSERT__INVLIST_SEARCH;
7282
7283     /* If list is empty, return failure. */
7284     if (high == 0) {
7285         return -1;
7286     }
7287
7288     /* (We can't get the array unless we know the list is non-empty) */
7289     array = invlist_array(invlist);
7290
7291     mid = invlist_previous_index(invlist);
7292     assert(mid >=0 && mid <= highest_element);
7293
7294     /* <mid> contains the cache of the result of the previous call to this
7295      * function (0 the first time).  See if this call is for the same result,
7296      * or if it is for mid-1.  This is under the theory that calls to this
7297      * function will often be for related code points that are near each other.
7298      * And benchmarks show that caching gives better results.  We also test
7299      * here if the code point is within the bounds of the list.  These tests
7300      * replace others that would have had to be made anyway to make sure that
7301      * the array bounds were not exceeded, and these give us extra information
7302      * at the same time */
7303     if (cp >= array[mid]) {
7304         if (cp >= array[highest_element]) {
7305             return highest_element;
7306         }
7307
7308         /* Here, array[mid] <= cp < array[highest_element].  This means that
7309          * the final element is not the answer, so can exclude it; it also
7310          * means that <mid> is not the final element, so can refer to 'mid + 1'
7311          * safely */
7312         if (cp < array[mid + 1]) {
7313             return mid;
7314         }
7315         high--;
7316         low = mid + 1;
7317     }
7318     else { /* cp < aray[mid] */
7319         if (cp < array[0]) { /* Fail if outside the array */
7320             return -1;
7321         }
7322         high = mid;
7323         if (cp >= array[mid - 1]) {
7324             goto found_entry;
7325         }
7326     }
7327
7328     /* Binary search.  What we are looking for is <i> such that
7329      *  array[i] <= cp < array[i+1]
7330      * The loop below converges on the i+1.  Note that there may not be an
7331      * (i+1)th element in the array, and things work nonetheless */
7332     while (low < high) {
7333         mid = (low + high) / 2;
7334         assert(mid <= highest_element);
7335         if (array[mid] <= cp) { /* cp >= array[mid] */
7336             low = mid + 1;
7337
7338             /* We could do this extra test to exit the loop early.
7339             if (cp < array[low]) {
7340                 return mid;
7341             }
7342             */
7343         }
7344         else { /* cp < array[mid] */
7345             high = mid;
7346         }
7347     }
7348
7349   found_entry:
7350     high--;
7351     invlist_set_previous_index(invlist, high);
7352     return high;
7353 }
7354
7355 void
7356 Perl__invlist_populate_swatch(pTHX_ SV* const invlist, const UV start, const UV end, U8* swatch)
7357 {
7358     /* populates a swatch of a swash the same way swatch_get() does in utf8.c,
7359      * but is used when the swash has an inversion list.  This makes this much
7360      * faster, as it uses a binary search instead of a linear one.  This is
7361      * intimately tied to that function, and perhaps should be in utf8.c,
7362      * except it is intimately tied to inversion lists as well.  It assumes
7363      * that <swatch> is all 0's on input */
7364
7365     UV current = start;
7366     const IV len = _invlist_len(invlist);
7367     IV i;
7368     const UV * array;
7369
7370     PERL_ARGS_ASSERT__INVLIST_POPULATE_SWATCH;
7371
7372     if (len == 0) { /* Empty inversion list */
7373         return;
7374     }
7375
7376     array = invlist_array(invlist);
7377
7378     /* Find which element it is */
7379     i = _invlist_search(invlist, start);
7380
7381     /* We populate from <start> to <end> */
7382     while (current < end) {
7383         UV upper;
7384
7385         /* The inversion list gives the results for every possible code point
7386          * after the first one in the list.  Only those ranges whose index is
7387          * even are ones that the inversion list matches.  For the odd ones,
7388          * and if the initial code point is not in the list, we have to skip
7389          * forward to the next element */
7390         if (i == -1 || ! ELEMENT_RANGE_MATCHES_INVLIST(i)) {
7391             i++;
7392             if (i >= len) { /* Finished if beyond the end of the array */
7393                 return;
7394             }
7395             current = array[i];
7396             if (current >= end) {   /* Finished if beyond the end of what we
7397                                        are populating */
7398                 if (LIKELY(end < UV_MAX)) {
7399                     return;
7400                 }
7401
7402                 /* We get here when the upper bound is the maximum
7403                  * representable on the machine, and we are looking for just
7404                  * that code point.  Have to special case it */
7405                 i = len;
7406                 goto join_end_of_list;
7407             }
7408         }
7409         assert(current >= start);
7410
7411         /* The current range ends one below the next one, except don't go past
7412          * <end> */
7413         i++;
7414         upper = (i < len && array[i] < end) ? array[i] : end;
7415
7416         /* Here we are in a range that matches.  Populate a bit in the 3-bit U8
7417          * for each code point in it */
7418         for (; current < upper; current++) {
7419             const STRLEN offset = (STRLEN)(current - start);
7420             swatch[offset >> 3] |= 1 << (offset & 7);
7421         }
7422
7423     join_end_of_list:
7424
7425         /* Quit if at the end of the list */
7426         if (i >= len) {
7427
7428             /* But first, have to deal with the highest possible code point on
7429              * the platform.  The previous code assumes that <end> is one
7430              * beyond where we want to populate, but that is impossible at the
7431              * platform's infinity, so have to handle it specially */
7432             if (UNLIKELY(end == UV_MAX && ELEMENT_RANGE_MATCHES_INVLIST(len-1)))
7433             {
7434                 const STRLEN offset = (STRLEN)(end - start);
7435                 swatch[offset >> 3] |= 1 << (offset & 7);
7436             }
7437             return;
7438         }
7439
7440         /* Advance to the next range, which will be for code points not in the
7441          * inversion list */
7442         current = array[i];
7443     }
7444
7445     return;
7446 }
7447
7448 void
7449 Perl__invlist_union_maybe_complement_2nd(pTHX_ SV* const a, SV* const b, bool complement_b, SV** output)
7450 {
7451     /* Take the union of two inversion lists and point <output> to it.  *output
7452      * SHOULD BE DEFINED upon input, and if it points to one of the two lists,
7453      * the reference count to that list will be decremented.  The first list,
7454      * <a>, may be NULL, in which case a copy of the second list is returned.
7455      * If <complement_b> is TRUE, the union is taken of the complement
7456      * (inversion) of <b> instead of b itself.
7457      *
7458      * The basis for this comes from "Unicode Demystified" Chapter 13 by
7459      * Richard Gillam, published by Addison-Wesley, and explained at some
7460      * length there.  The preface says to incorporate its examples into your
7461      * code at your own risk.
7462      *
7463      * The algorithm is like a merge sort.
7464      *
7465      * XXX A potential performance improvement is to keep track as we go along
7466      * if only one of the inputs contributes to the result, meaning the other
7467      * is a subset of that one.  In that case, we can skip the final copy and
7468      * return the larger of the input lists, but then outside code might need
7469      * to keep track of whether to free the input list or not */
7470
7471     UV* array_a;    /* a's array */
7472     UV* array_b;
7473     UV len_a;       /* length of a's array */
7474     UV len_b;
7475
7476     SV* u;                      /* the resulting union */
7477     UV* array_u;
7478     UV len_u;
7479
7480     UV i_a = 0;             /* current index into a's array */
7481     UV i_b = 0;
7482     UV i_u = 0;
7483
7484     /* running count, as explained in the algorithm source book; items are
7485      * stopped accumulating and are output when the count changes to/from 0.
7486      * The count is incremented when we start a range that's in the set, and
7487      * decremented when we start a range that's not in the set.  So its range
7488      * is 0 to 2.  Only when the count is zero is something not in the set.
7489      */
7490     UV count = 0;
7491
7492     PERL_ARGS_ASSERT__INVLIST_UNION_MAYBE_COMPLEMENT_2ND;
7493     assert(a != b);
7494
7495     /* If either one is empty, the union is the other one */
7496     if (a == NULL || ((len_a = _invlist_len(a)) == 0)) {
7497         if (*output == a) {
7498             if (a != NULL) {
7499                 SvREFCNT_dec_NN(a);
7500             }
7501         }
7502         if (*output != b) {
7503             *output = invlist_clone(b);
7504             if (complement_b) {
7505                 _invlist_invert(*output);
7506             }
7507         } /* else *output already = b; */
7508         return;
7509     }
7510     else if ((len_b = _invlist_len(b)) == 0) {
7511         if (*output == b) {
7512             SvREFCNT_dec_NN(b);
7513         }
7514
7515         /* The complement of an empty list is a list that has everything in it,
7516          * so the union with <a> includes everything too */
7517         if (complement_b) {
7518             if (a == *output) {
7519                 SvREFCNT_dec_NN(a);
7520             }
7521             *output = _new_invlist(1);
7522             _append_range_to_invlist(*output, 0, UV_MAX);
7523         }
7524         else if (*output != a) {
7525             *output = invlist_clone(a);
7526         }
7527         /* else *output already = a; */
7528         return;
7529     }
7530
7531     /* Here both lists exist and are non-empty */
7532     array_a = invlist_array(a);
7533     array_b = invlist_array(b);
7534
7535     /* If are to take the union of 'a' with the complement of b, set it
7536      * up so are looking at b's complement. */
7537     if (complement_b) {
7538
7539         /* To complement, we invert: if the first element is 0, remove it.  To
7540          * do this, we just pretend the array starts one later, and clear the
7541          * flag as we don't have to do anything else later */
7542         if (array_b[0] == 0) {
7543             array_b++;
7544             len_b--;
7545             complement_b = FALSE;
7546         }
7547         else {
7548
7549             /* But if the first element is not zero, we unshift a 0 before the
7550              * array.  The data structure reserves a space for that 0 (which
7551              * should be a '1' right now), so physical shifting is unneeded,
7552              * but temporarily change that element to 0.  Before exiting the
7553              * routine, we must restore the element to '1' */
7554             array_b--;
7555             len_b++;
7556             array_b[0] = 0;
7557         }
7558     }
7559
7560     /* Size the union for the worst case: that the sets are completely
7561      * disjoint */
7562     u = _new_invlist(len_a + len_b);
7563
7564     /* Will contain U+0000 if either component does */
7565     array_u = _invlist_array_init(u, (len_a > 0 && array_a[0] == 0)
7566                                       || (len_b > 0 && array_b[0] == 0));
7567
7568     /* Go through each list item by item, stopping when exhausted one of
7569      * them */
7570     while (i_a < len_a && i_b < len_b) {
7571         UV cp;      /* The element to potentially add to the union's array */
7572         bool cp_in_set;   /* is it in the the input list's set or not */
7573
7574         /* We need to take one or the other of the two inputs for the union.
7575          * Since we are merging two sorted lists, we take the smaller of the
7576          * next items.  In case of a tie, we take the one that is in its set
7577          * first.  If we took one not in the set first, it would decrement the
7578          * count, possibly to 0 which would cause it to be output as ending the
7579          * range, and the next time through we would take the same number, and
7580          * output it again as beginning the next range.  By doing it the
7581          * opposite way, there is no possibility that the count will be
7582          * momentarily decremented to 0, and thus the two adjoining ranges will
7583          * be seamlessly merged.  (In a tie and both are in the set or both not
7584          * in the set, it doesn't matter which we take first.) */
7585         if (array_a[i_a] < array_b[i_b]
7586             || (array_a[i_a] == array_b[i_b]
7587                 && ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
7588         {
7589             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
7590             cp= array_a[i_a++];
7591         }
7592         else {
7593             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
7594             cp = array_b[i_b++];
7595         }
7596
7597         /* Here, have chosen which of the two inputs to look at.  Only output
7598          * if the running count changes to/from 0, which marks the
7599          * beginning/end of a range in that's in the set */
7600         if (cp_in_set) {
7601             if (count == 0) {
7602                 array_u[i_u++] = cp;
7603             }
7604             count++;
7605         }
7606         else {
7607             count--;
7608             if (count == 0) {
7609                 array_u[i_u++] = cp;
7610             }
7611         }
7612     }
7613
7614     /* Here, we are finished going through at least one of the lists, which
7615      * means there is something remaining in at most one.  We check if the list
7616      * that hasn't been exhausted is positioned such that we are in the middle
7617      * of a range in its set or not.  (i_a and i_b point to the element beyond
7618      * the one we care about.) If in the set, we decrement 'count'; if 0, there
7619      * is potentially more to output.
7620      * There are four cases:
7621      *  1) Both weren't in their sets, count is 0, and remains 0.  What's left
7622      *     in the union is entirely from the non-exhausted set.
7623      *  2) Both were in their sets, count is 2.  Nothing further should
7624      *     be output, as everything that remains will be in the exhausted
7625      *     list's set, hence in the union; decrementing to 1 but not 0 insures
7626      *     that
7627      *  3) the exhausted was in its set, non-exhausted isn't, count is 1.
7628      *     Nothing further should be output because the union includes
7629      *     everything from the exhausted set.  Not decrementing ensures that.
7630      *  4) the exhausted wasn't in its set, non-exhausted is, count is 1;
7631      *     decrementing to 0 insures that we look at the remainder of the
7632      *     non-exhausted set */
7633     if ((i_a != len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
7634         || (i_b != len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
7635     {
7636         count--;
7637     }
7638
7639     /* The final length is what we've output so far, plus what else is about to
7640      * be output.  (If 'count' is non-zero, then the input list we exhausted
7641      * has everything remaining up to the machine's limit in its set, and hence
7642      * in the union, so there will be no further output. */
7643     len_u = i_u;
7644     if (count == 0) {
7645         /* At most one of the subexpressions will be non-zero */
7646         len_u += (len_a - i_a) + (len_b - i_b);
7647     }
7648
7649     /* Set result to final length, which can change the pointer to array_u, so
7650      * re-find it */
7651     if (len_u != _invlist_len(u)) {
7652         invlist_set_len(u, len_u);
7653         invlist_trim(u);
7654         array_u = invlist_array(u);
7655     }
7656
7657     /* When 'count' is 0, the list that was exhausted (if one was shorter than
7658      * the other) ended with everything above it not in its set.  That means
7659      * that the remaining part of the union is precisely the same as the
7660      * non-exhausted list, so can just copy it unchanged.  (If both list were
7661      * exhausted at the same time, then the operations below will be both 0.)
7662      */
7663     if (count == 0) {
7664         IV copy_count; /* At most one will have a non-zero copy count */
7665         if ((copy_count = len_a - i_a) > 0) {
7666             Copy(array_a + i_a, array_u + i_u, copy_count, UV);
7667         }
7668         else if ((copy_count = len_b - i_b) > 0) {
7669             Copy(array_b + i_b, array_u + i_u, copy_count, UV);
7670         }
7671     }
7672
7673     /* If we've changed b, restore it */
7674     if (complement_b) {
7675         array_b[0] = 1;
7676     }
7677
7678     /*  We may be removing a reference to one of the inputs */
7679     if (a == *output || b == *output) {
7680         assert(! invlist_is_iterating(*output));
7681         SvREFCNT_dec_NN(*output);
7682     }
7683
7684     *output = u;
7685     return;
7686 }
7687
7688 void
7689 Perl__invlist_intersection_maybe_complement_2nd(pTHX_ SV* const a, SV* const b, bool complement_b, SV** i)
7690 {
7691     /* Take the intersection of two inversion lists and point <i> to it.  *i
7692      * SHOULD BE DEFINED upon input, and if it points to one of the two lists,
7693      * the reference count to that list will be decremented.
7694      * If <complement_b> is TRUE, the result will be the intersection of <a>
7695      * and the complement (or inversion) of <b> instead of <b> directly.
7696      *
7697      * The basis for this comes from "Unicode Demystified" Chapter 13 by
7698      * Richard Gillam, published by Addison-Wesley, and explained at some
7699      * length there.  The preface says to incorporate its examples into your
7700      * code at your own risk.  In fact, it had bugs
7701      *
7702      * The algorithm is like a merge sort, and is essentially the same as the
7703      * union above
7704      */
7705
7706     UV* array_a;                /* a's array */
7707     UV* array_b;
7708     UV len_a;   /* length of a's array */
7709     UV len_b;
7710
7711     SV* r;                   /* the resulting intersection */
7712     UV* array_r;
7713     UV len_r;
7714
7715     UV i_a = 0;             /* current index into a's array */
7716     UV i_b = 0;
7717     UV i_r = 0;
7718
7719     /* running count, as explained in the algorithm source book; items are
7720      * stopped accumulating and are output when the count changes to/from 2.
7721      * The count is incremented when we start a range that's in the set, and
7722      * decremented when we start a range that's not in the set.  So its range
7723      * is 0 to 2.  Only when the count is 2 is something in the intersection.
7724      */
7725     UV count = 0;
7726
7727     PERL_ARGS_ASSERT__INVLIST_INTERSECTION_MAYBE_COMPLEMENT_2ND;
7728     assert(a != b);
7729
7730     /* Special case if either one is empty */
7731     len_a = _invlist_len(a);
7732     if ((len_a == 0) || ((len_b = _invlist_len(b)) == 0)) {
7733
7734         if (len_a != 0 && complement_b) {
7735
7736             /* Here, 'a' is not empty, therefore from the above 'if', 'b' must
7737              * be empty.  Here, also we are using 'b's complement, which hence
7738              * must be every possible code point.  Thus the intersection is
7739              * simply 'a'. */
7740             if (*i != a) {
7741                 *i = invlist_clone(a);
7742
7743                 if (*i == b) {
7744                     SvREFCNT_dec_NN(b);
7745                 }
7746             }
7747             /* else *i is already 'a' */
7748             return;
7749         }
7750
7751         /* Here, 'a' or 'b' is empty and not using the complement of 'b'.  The
7752          * intersection must be empty */
7753         if (*i == a) {
7754             SvREFCNT_dec_NN(a);
7755         }
7756         else if (*i == b) {
7757             SvREFCNT_dec_NN(b);
7758         }
7759         *i = _new_invlist(0);
7760         return;
7761     }
7762
7763     /* Here both lists exist and are non-empty */
7764     array_a = invlist_array(a);
7765     array_b = invlist_array(b);
7766
7767     /* If are to take the intersection of 'a' with the complement of b, set it
7768      * up so are looking at b's complement. */
7769     if (complement_b) {
7770
7771         /* To complement, we invert: if the first element is 0, remove it.  To
7772          * do this, we just pretend the array starts one later, and clear the
7773          * flag as we don't have to do anything else later */
7774         if (array_b[0] == 0) {
7775             array_b++;
7776             len_b--;
7777             complement_b = FALSE;
7778         }
7779         else {
7780
7781             /* But if the first element is not zero, we unshift a 0 before the
7782              * array.  The data structure reserves a space for that 0 (which
7783              * should be a '1' right now), so physical shifting is unneeded,
7784              * but temporarily change that element to 0.  Before exiting the
7785              * routine, we must restore the element to '1' */
7786             array_b--;
7787             len_b++;
7788             array_b[0] = 0;
7789         }
7790     }
7791
7792     /* Size the intersection for the worst case: that the intersection ends up
7793      * fragmenting everything to be completely disjoint */
7794     r= _new_invlist(len_a + len_b);
7795
7796     /* Will contain U+0000 iff both components do */
7797     array_r = _invlist_array_init(r, len_a > 0 && array_a[0] == 0
7798                                      && len_b > 0 && array_b[0] == 0);
7799
7800     /* Go through each list item by item, stopping when exhausted one of
7801      * them */
7802     while (i_a < len_a && i_b < len_b) {
7803         UV cp;      /* The element to potentially add to the intersection's
7804                        array */
7805         bool cp_in_set; /* Is it in the input list's set or not */
7806
7807         /* We need to take one or the other of the two inputs for the
7808          * intersection.  Since we are merging two sorted lists, we take the
7809          * smaller of the next items.  In case of a tie, we take the one that
7810          * is not in its set first (a difference from the union algorithm).  If
7811          * we took one in the set first, it would increment the count, possibly
7812          * to 2 which would cause it to be output as starting a range in the
7813          * intersection, and the next time through we would take that same
7814          * number, and output it again as ending the set.  By doing it the
7815          * opposite of this, there is no possibility that the count will be
7816          * momentarily incremented to 2.  (In a tie and both are in the set or
7817          * both not in the set, it doesn't matter which we take first.) */
7818         if (array_a[i_a] < array_b[i_b]
7819             || (array_a[i_a] == array_b[i_b]
7820                 && ! ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
7821         {
7822             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
7823             cp= array_a[i_a++];
7824         }
7825         else {
7826             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
7827             cp= array_b[i_b++];
7828         }
7829
7830         /* Here, have chosen which of the two inputs to look at.  Only output
7831          * if the running count changes to/from 2, which marks the
7832          * beginning/end of a range that's in the intersection */
7833         if (cp_in_set) {
7834             count++;
7835             if (count == 2) {
7836                 array_r[i_r++] = cp;
7837             }
7838         }
7839         else {
7840             if (count == 2) {
7841                 array_r[i_r++] = cp;
7842             }
7843             count--;
7844         }
7845     }
7846
7847     /* Here, we are finished going through at least one of the lists, which
7848      * means there is something remaining in at most one.  We check if the list
7849      * that has been exhausted is positioned such that we are in the middle
7850      * of a range in its set or not.  (i_a and i_b point to elements 1 beyond
7851      * the ones we care about.)  There are four cases:
7852      *  1) Both weren't in their sets, count is 0, and remains 0.  There's
7853      *     nothing left in the intersection.
7854      *  2) Both were in their sets, count is 2 and perhaps is incremented to
7855      *     above 2.  What should be output is exactly that which is in the
7856      *     non-exhausted set, as everything it has is also in the intersection
7857      *     set, and everything it doesn't have can't be in the intersection
7858      *  3) The exhausted was in its set, non-exhausted isn't, count is 1, and
7859      *     gets incremented to 2.  Like the previous case, the intersection is
7860      *     everything that remains in the non-exhausted set.
7861      *  4) the exhausted wasn't in its set, non-exhausted is, count is 1, and
7862      *     remains 1.  And the intersection has nothing more. */
7863     if ((i_a == len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
7864         || (i_b == len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
7865     {
7866         count++;
7867     }
7868
7869     /* The final length is what we've output so far plus what else is in the
7870      * intersection.  At most one of the subexpressions below will be non-zero */
7871     len_r = i_r;
7872     if (count >= 2) {
7873         len_r += (len_a - i_a) + (len_b - i_b);
7874     }
7875
7876     /* Set result to final length, which can change the pointer to array_r, so
7877      * re-find it */
7878     if (len_r != _invlist_len(r)) {
7879         invlist_set_len(r, len_r);
7880         invlist_trim(r);
7881         array_r = invlist_array(r);
7882     }
7883
7884     /* Finish outputting any remaining */
7885     if (count >= 2) { /* At most one will have a non-zero copy count */
7886         IV copy_count;
7887         if ((copy_count = len_a - i_a) > 0) {
7888             Copy(array_a + i_a, array_r + i_r, copy_count, UV);
7889         }
7890         else if ((copy_count = len_b - i_b) > 0) {
7891             Copy(array_b + i_b, array_r + i_r, copy_count, UV);
7892         }
7893     }
7894
7895     /* If we've changed b, restore it */
7896     if (complement_b) {
7897         array_b[0] = 1;
7898     }
7899
7900     /*  We may be removing a reference to one of the inputs */
7901     if (a == *i || b == *i) {
7902         assert(! invlist_is_iterating(*i));
7903         SvREFCNT_dec_NN(*i);
7904     }
7905
7906     *i = r;
7907     return;
7908 }
7909
7910 SV*
7911 Perl__add_range_to_invlist(pTHX_ SV* invlist, const UV start, const UV end)
7912 {
7913     /* Add the range from 'start' to 'end' inclusive to the inversion list's
7914      * set.  A pointer to the inversion list is returned.  This may actually be
7915      * a new list, in which case the passed in one has been destroyed.  The
7916      * passed in inversion list can be NULL, in which case a new one is created
7917      * with just the one range in it */
7918
7919     SV* range_invlist;
7920     UV len;
7921
7922     if (invlist == NULL) {
7923         invlist = _new_invlist(2);
7924         len = 0;
7925     }
7926     else {
7927         len = _invlist_len(invlist);
7928     }
7929
7930     /* If comes after the final entry actually in the list, can just append it
7931      * to the end, */
7932     if (len == 0
7933         || (! ELEMENT_RANGE_MATCHES_INVLIST(len - 1)
7934             && start >= invlist_array(invlist)[len - 1]))
7935     {
7936         _append_range_to_invlist(invlist, start, end);
7937         return invlist;
7938     }
7939
7940     /* Here, can't just append things, create and return a new inversion list
7941      * which is the union of this range and the existing inversion list */
7942     range_invlist = _new_invlist(2);
7943     _append_range_to_invlist(range_invlist, start, end);
7944
7945     _invlist_union(invlist, range_invlist, &invlist);
7946
7947     /* The temporary can be freed */
7948     SvREFCNT_dec_NN(range_invlist);
7949
7950     return invlist;
7951 }
7952
7953 #endif
7954
7955 PERL_STATIC_INLINE SV*
7956 S_add_cp_to_invlist(pTHX_ SV* invlist, const UV cp) {
7957     return _add_range_to_invlist(invlist, cp, cp);
7958 }
7959
7960 #ifndef PERL_IN_XSUB_RE
7961 void
7962 Perl__invlist_invert(pTHX_ SV* const invlist)
7963 {
7964     /* Complement the input inversion list.  This adds a 0 if the list didn't
7965      * have a zero; removes it otherwise.  As described above, the data
7966      * structure is set up so that this is very efficient */
7967
7968     UV* len_pos = _get_invlist_len_addr(invlist);
7969
7970     PERL_ARGS_ASSERT__INVLIST_INVERT;
7971
7972     assert(! invlist_is_iterating(invlist));
7973
7974     /* The inverse of matching nothing is matching everything */
7975     if (*len_pos == 0) {
7976         _append_range_to_invlist(invlist, 0, UV_MAX);
7977         return;
7978     }
7979
7980     /* The exclusive or complents 0 to 1; and 1 to 0.  If the result is 1, the
7981      * zero element was a 0, so it is being removed, so the length decrements
7982      * by 1; and vice-versa.  SvCUR is unaffected */
7983     if (*get_invlist_zero_addr(invlist) ^= 1) {
7984         (*len_pos)--;
7985     }
7986     else {
7987         (*len_pos)++;
7988     }
7989 }
7990
7991 void
7992 Perl__invlist_invert_prop(pTHX_ SV* const invlist)
7993 {
7994     /* Complement the input inversion list (which must be a Unicode property,
7995      * all of which don't match above the Unicode maximum code point.)  And
7996      * Perl has chosen to not have the inversion match above that either.  This
7997      * adds a 0x110000 if the list didn't end with it, and removes it if it did
7998      */
7999
8000     UV len;
8001     UV* array;
8002
8003     PERL_ARGS_ASSERT__INVLIST_INVERT_PROP;
8004
8005     _invlist_invert(invlist);
8006
8007     len = _invlist_len(invlist);
8008
8009     if (len != 0) { /* If empty do nothing */
8010         array = invlist_array(invlist);
8011         if (array[len - 1] != PERL_UNICODE_MAX + 1) {
8012             /* Add 0x110000.  First, grow if necessary */
8013             len++;
8014             if (invlist_max(invlist) < len) {
8015                 invlist_extend(invlist, len);
8016                 array = invlist_array(invlist);
8017             }
8018             invlist_set_len(invlist, len);
8019             array[len - 1] = PERL_UNICODE_MAX + 1;
8020         }
8021         else {  /* Remove the 0x110000 */
8022             invlist_set_len(invlist, len - 1);
8023         }
8024     }
8025
8026     return;
8027 }
8028 #endif
8029
8030 PERL_STATIC_INLINE SV*
8031 S_invlist_clone(pTHX_ SV* const invlist)
8032 {
8033
8034     /* Return a new inversion list that is a copy of the input one, which is
8035      * unchanged */
8036
8037     /* Need to allocate extra space to accommodate Perl's addition of a
8038      * trailing NUL to SvPV's, since it thinks they are always strings */
8039     SV* new_invlist = _new_invlist(_invlist_len(invlist) + 1);
8040     STRLEN length = SvCUR(invlist);
8041
8042     PERL_ARGS_ASSERT_INVLIST_CLONE;
8043
8044     SvCUR_set(new_invlist, length); /* This isn't done automatically */
8045     Copy(SvPVX(invlist), SvPVX(new_invlist), length, char);
8046
8047     return new_invlist;
8048 }
8049
8050 PERL_STATIC_INLINE UV*
8051 S_get_invlist_iter_addr(pTHX_ SV* invlist)
8052 {
8053     /* Return the address of the UV that contains the current iteration
8054      * position */
8055
8056     PERL_ARGS_ASSERT_GET_INVLIST_ITER_ADDR;
8057
8058     return (UV *) (SvPVX(invlist) + (INVLIST_ITER_OFFSET * sizeof (UV)));
8059 }
8060
8061 PERL_STATIC_INLINE UV*
8062 S_get_invlist_version_id_addr(pTHX_ SV* invlist)
8063 {
8064     /* Return the address of the UV that contains the version id. */
8065
8066     PERL_ARGS_ASSERT_GET_INVLIST_VERSION_ID_ADDR;
8067
8068     return (UV *) (SvPVX(invlist) + (INVLIST_VERSION_ID_OFFSET * sizeof (UV)));
8069 }
8070
8071 PERL_STATIC_INLINE void
8072 S_invlist_iterinit(pTHX_ SV* invlist)   /* Initialize iterator for invlist */
8073 {
8074     PERL_ARGS_ASSERT_INVLIST_ITERINIT;
8075
8076     *get_invlist_iter_addr(invlist) = 0;
8077 }
8078
8079 PERL_STATIC_INLINE void
8080 S_invlist_iterfinish(pTHX_ SV* invlist)
8081 {
8082     /* Terminate iterator for invlist.  This is to catch development errors.
8083      * Any iteration that is interrupted before completed should call this
8084      * function.  Functions that add code points anywhere else but to the end
8085      * of an inversion list assert that they are not in the middle of an
8086      * iteration.  If they were, the addition would make the iteration
8087      * problematical: if the iteration hadn't reached the place where things
8088      * were being added, it would be ok */
8089
8090     PERL_ARGS_ASSERT_INVLIST_ITERFINISH;
8091
8092     *get_invlist_iter_addr(invlist) = UV_MAX;
8093 }
8094
8095 STATIC bool
8096 S_invlist_iternext(pTHX_ SV* invlist, UV* start, UV* end)
8097 {
8098     /* An C<invlist_iterinit> call on <invlist> must be used to set this up.
8099      * This call sets in <*start> and <*end>, the next range in <invlist>.
8100      * Returns <TRUE> if successful and the next call will return the next
8101      * range; <FALSE> if was already at the end of the list.  If the latter,
8102      * <*start> and <*end> are unchanged, and the next call to this function
8103      * will start over at the beginning of the list */
8104
8105     UV* pos = get_invlist_iter_addr(invlist);
8106     UV len = _invlist_len(invlist);
8107     UV *array;
8108
8109     PERL_ARGS_ASSERT_INVLIST_ITERNEXT;
8110
8111     if (*pos >= len) {
8112         *pos = UV_MAX;  /* Force iterinit() to be required next time */
8113         return FALSE;
8114     }
8115
8116     array = invlist_array(invlist);
8117
8118     *start = array[(*pos)++];
8119
8120     if (*pos >= len) {
8121         *end = UV_MAX;
8122     }
8123     else {
8124         *end = array[(*pos)++] - 1;
8125     }
8126
8127     return TRUE;
8128 }
8129
8130 PERL_STATIC_INLINE bool
8131 S_invlist_is_iterating(pTHX_ SV* const invlist)
8132 {
8133     PERL_ARGS_ASSERT_INVLIST_IS_ITERATING;
8134
8135     return *(get_invlist_iter_addr(invlist)) < UV_MAX;
8136 }
8137
8138 PERL_STATIC_INLINE UV
8139 S_invlist_highest(pTHX_ SV* const invlist)
8140 {
8141     /* Returns the highest code point that matches an inversion list.  This API
8142      * has an ambiguity, as it returns 0 under either the highest is actually
8143      * 0, or if the list is empty.  If this distinction matters to you, check
8144      * for emptiness before calling this function */
8145
8146     UV len = _invlist_len(invlist);
8147     UV *array;
8148
8149     PERL_ARGS_ASSERT_INVLIST_HIGHEST;
8150
8151     if (len == 0) {
8152         return 0;
8153     }
8154
8155     array = invlist_array(invlist);
8156
8157     /* The last element in the array in the inversion list always starts a
8158      * range that goes to infinity.  That range may be for code points that are
8159      * matched in the inversion list, or it may be for ones that aren't
8160      * matched.  In the latter case, the highest code point in the set is one
8161      * less than the beginning of this range; otherwise it is the final element
8162      * of this range: infinity */
8163     return (ELEMENT_RANGE_MATCHES_INVLIST(len - 1))
8164            ? UV_MAX
8165            : array[len - 1] - 1;
8166 }
8167
8168 #ifndef PERL_IN_XSUB_RE
8169 SV *
8170 Perl__invlist_contents(pTHX_ SV* const invlist)
8171 {
8172     /* Get the contents of an inversion list into a string SV so that they can
8173      * be printed out.  It uses the format traditionally done for debug tracing
8174      */
8175
8176     UV start, end;
8177     SV* output = newSVpvs("\n");
8178
8179     PERL_ARGS_ASSERT__INVLIST_CONTENTS;
8180
8181     assert(! invlist_is_iterating(invlist));
8182
8183     invlist_iterinit(invlist);
8184     while (invlist_iternext(invlist, &start, &end)) {
8185         if (end == UV_MAX) {
8186             Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\tINFINITY\n", start);
8187         }
8188         else if (end != start) {
8189             Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\t%04"UVXf"\n",
8190                     start,       end);
8191         }
8192         else {
8193             Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\n", start);
8194         }
8195     }
8196
8197     return output;
8198 }
8199 #endif
8200
8201 #ifdef PERL_ARGS_ASSERT__INVLIST_DUMP
8202 void
8203 Perl__invlist_dump(pTHX_ SV* const invlist, const char * const header)
8204 {
8205     /* Dumps out the ranges in an inversion list.  The string 'header'
8206      * if present is output on a line before the first range */
8207
8208     UV start, end;
8209
8210     PERL_ARGS_ASSERT__INVLIST_DUMP;
8211
8212     if (header && strlen(header)) {
8213         PerlIO_printf(Perl_debug_log, "%s\n", header);
8214     }
8215     if (invlist_is_iterating(invlist)) {
8216         PerlIO_printf(Perl_debug_log, "Can't dump because is in middle of iterating\n");
8217         return;
8218     }
8219
8220     invlist_iterinit(invlist);
8221     while (invlist_iternext(invlist, &start, &end)) {
8222         if (end == UV_MAX) {
8223             PerlIO_printf(Perl_debug_log, "0x%04"UVXf" .. INFINITY\n", start);
8224         }
8225         else if (end != start) {
8226             PerlIO_printf(Perl_debug_log, "0x%04"UVXf" .. 0x%04"UVXf"\n",
8227                                                  start,         end);
8228         }
8229         else {
8230             PerlIO_printf(Perl_debug_log, "0x%04"UVXf"\n", start);
8231         }
8232     }
8233 }
8234 #endif
8235
8236 #if 0
8237 bool
8238 S__invlistEQ(pTHX_ SV* const a, SV* const b, bool complement_b)
8239 {
8240     /* Return a boolean as to if the two passed in inversion lists are
8241      * identical.  The final argument, if TRUE, says to take the complement of
8242      * the second inversion list before doing the comparison */
8243
8244     UV* array_a = invlist_array(a);
8245     UV* array_b = invlist_array(b);
8246     UV len_a = _invlist_len(a);
8247     UV len_b = _invlist_len(b);
8248
8249     UV i = 0;               /* current index into the arrays */
8250     bool retval = TRUE;     /* Assume are identical until proven otherwise */
8251
8252     PERL_ARGS_ASSERT__INVLISTEQ;
8253
8254     /* If are to compare 'a' with the complement of b, set it
8255      * up so are looking at b's complement. */
8256     if (complement_b) {
8257
8258         /* The complement of nothing is everything, so <a> would have to have
8259          * just one element, starting at zero (ending at infinity) */
8260         if (len_b == 0) {
8261             return (len_a == 1 && array_a[0] == 0);
8262         }
8263         else if (array_b[0] == 0) {
8264
8265             /* Otherwise, to complement, we invert.  Here, the first element is
8266              * 0, just remove it.  To do this, we just pretend the array starts
8267              * one later, and clear the flag as we don't have to do anything
8268              * else later */
8269
8270             array_b++;
8271             len_b--;
8272             complement_b = FALSE;
8273         }
8274         else {
8275
8276             /* But if the first element is not zero, we unshift a 0 before the
8277              * array.  The data structure reserves a space for that 0 (which
8278              * should be a '1' right now), so physical shifting is unneeded,
8279              * but temporarily change that element to 0.  Before exiting the
8280              * routine, we must restore the element to '1' */
8281             array_b--;
8282             len_b++;
8283             array_b[0] = 0;
8284         }
8285     }
8286
8287     /* Make sure that the lengths are the same, as well as the final element
8288      * before looping through the remainder.  (Thus we test the length, final,
8289      * and first elements right off the bat) */
8290     if (len_a != len_b || array_a[len_a-1] != array_b[len_a-1]) {
8291         retval = FALSE;
8292     }
8293     else for (i = 0; i < len_a - 1; i++) {
8294         if (array_a[i] != array_b[i]) {
8295             retval = FALSE;
8296             break;
8297         }
8298     }
8299
8300     if (complement_b) {
8301         array_b[0] = 1;
8302     }
8303     return retval;
8304 }
8305 #endif
8306
8307 #undef HEADER_LENGTH
8308 #undef INVLIST_INITIAL_LENGTH
8309 #undef TO_INTERNAL_SIZE
8310 #undef FROM_INTERNAL_SIZE
8311 #undef INVLIST_LEN_OFFSET
8312 #undef INVLIST_ZERO_OFFSET
8313 #undef INVLIST_ITER_OFFSET
8314 #undef INVLIST_VERSION_ID
8315 #undef INVLIST_PREVIOUS_INDEX_OFFSET
8316
8317 /* End of inversion list object */
8318
8319 STATIC void
8320 S_parse_lparen_question_flags(pTHX_ struct RExC_state_t *pRExC_state)
8321 {
8322     /* This parses the flags that are in either the '(?foo)' or '(?foo:bar)'
8323      * constructs, and updates RExC_flags with them.  On input, RExC_parse
8324      * should point to the first flag; it is updated on output to point to the
8325      * final ')' or ':'.  There needs to be at least one flag, or this will
8326      * abort */
8327
8328     /* for (?g), (?gc), and (?o) warnings; warning
8329        about (?c) will warn about (?g) -- japhy    */
8330
8331 #define WASTED_O  0x01
8332 #define WASTED_G  0x02
8333 #define WASTED_C  0x04
8334 #define WASTED_GC (0x02|0x04)
8335     I32 wastedflags = 0x00;
8336     U32 posflags = 0, negflags = 0;
8337     U32 *flagsp = &posflags;
8338     char has_charset_modifier = '\0';
8339     regex_charset cs;
8340     bool has_use_defaults = FALSE;
8341     const char* const seqstart = RExC_parse - 1; /* Point to the '?' */
8342
8343     PERL_ARGS_ASSERT_PARSE_LPAREN_QUESTION_FLAGS;
8344
8345     /* '^' as an initial flag sets certain defaults */
8346     if (UCHARAT(RExC_parse) == '^') {
8347         RExC_parse++;
8348         has_use_defaults = TRUE;
8349         STD_PMMOD_FLAGS_CLEAR(&RExC_flags);
8350         set_regex_charset(&RExC_flags, (RExC_utf8 || RExC_uni_semantics)
8351                                         ? REGEX_UNICODE_CHARSET
8352                                         : REGEX_DEPENDS_CHARSET);
8353     }
8354
8355     cs = get_regex_charset(RExC_flags);
8356     if (cs == REGEX_DEPENDS_CHARSET
8357         && (RExC_utf8 || RExC_uni_semantics))
8358     {
8359         cs = REGEX_UNICODE_CHARSET;
8360     }
8361
8362     while (*RExC_parse) {
8363         /* && strchr("iogcmsx", *RExC_parse) */
8364         /* (?g), (?gc) and (?o) are useless here
8365            and must be globally applied -- japhy */
8366         switch (*RExC_parse) {
8367
8368             /* Code for the imsx flags */
8369             CASE_STD_PMMOD_FLAGS_PARSE_SET(flagsp);
8370
8371             case LOCALE_PAT_MOD:
8372                 if (has_charset_modifier) {
8373                     goto excess_modifier;
8374                 }
8375                 else if (flagsp == &negflags) {
8376                     goto neg_modifier;
8377                 }
8378                 cs = REGEX_LOCALE_CHARSET;
8379                 has_charset_modifier = LOCALE_PAT_MOD;
8380                 RExC_contains_locale = 1;
8381                 break;
8382             case UNICODE_PAT_MOD:
8383                 if (has_charset_modifier) {
8384                     goto excess_modifier;
8385                 }
8386                 else if (flagsp == &negflags) {
8387                     goto neg_modifier;
8388                 }
8389                 cs = REGEX_UNICODE_CHARSET;
8390                 has_charset_modifier = UNICODE_PAT_MOD;
8391                 break;
8392             case ASCII_RESTRICT_PAT_MOD:
8393                 if (flagsp == &negflags) {
8394                     goto neg_modifier;
8395                 }
8396                 if (has_charset_modifier) {
8397                     if (cs != REGEX_ASCII_RESTRICTED_CHARSET) {
8398                         goto excess_modifier;
8399                     }
8400                     /* Doubled modifier implies more restricted */
8401                     cs = REGEX_ASCII_MORE_RESTRICTED_CHARSET;
8402                 }
8403                 else {
8404                     cs = REGEX_ASCII_RESTRICTED_CHARSET;
8405                 }
8406                 has_charset_modifier = ASCII_RESTRICT_PAT_MOD;
8407                 break;
8408             case DEPENDS_PAT_MOD:
8409                 if (has_use_defaults) {
8410                     goto fail_modifiers;
8411                 }
8412                 else if (flagsp == &negflags) {
8413                     goto neg_modifier;
8414                 }
8415                 else if (has_charset_modifier) {
8416                     goto excess_modifier;
8417                 }
8418
8419                 /* The dual charset means unicode semantics if the
8420                  * pattern (or target, not known until runtime) are
8421                  * utf8, or something in the pattern indicates unicode
8422                  * semantics */
8423                 cs = (RExC_utf8 || RExC_uni_semantics)
8424                      ? REGEX_UNICODE_CHARSET
8425                      : REGEX_DEPENDS_CHARSET;
8426                 has_charset_modifier = DEPENDS_PAT_MOD;
8427                 break;
8428             excess_modifier:
8429                 RExC_parse++;
8430                 if (has_charset_modifier == ASCII_RESTRICT_PAT_MOD) {
8431                     vFAIL2("Regexp modifier \"%c\" may appear a maximum of twice", ASCII_RESTRICT_PAT_MOD);
8432                 }
8433                 else if (has_charset_modifier == *(RExC_parse - 1)) {
8434                     vFAIL2("Regexp modifier \"%c\" may not appear twice", *(RExC_parse - 1));
8435                 }
8436                 else {
8437                     vFAIL3("Regexp modifiers \"%c\" and \"%c\" are mutually exclusive", has_charset_modifier, *(RExC_parse - 1));
8438                 }
8439                 /*NOTREACHED*/
8440             neg_modifier:
8441                 RExC_parse++;
8442                 vFAIL2("Regexp modifier \"%c\" may not appear after the \"-\"", *(RExC_parse - 1));
8443                 /*NOTREACHED*/
8444             case ONCE_PAT_MOD: /* 'o' */
8445             case GLOBAL_PAT_MOD: /* 'g' */
8446                 if (SIZE_ONLY && ckWARN(WARN_REGEXP)) {
8447                     const I32 wflagbit = *RExC_parse == 'o' ? WASTED_O : WASTED_G;
8448                     if (! (wastedflags & wflagbit) ) {
8449                         wastedflags |= wflagbit;
8450                         vWARN5(
8451                             RExC_parse + 1,
8452                             "Useless (%s%c) - %suse /%c modifier",
8453                             flagsp == &negflags ? "?-" : "?",
8454                             *RExC_parse,
8455                             flagsp == &negflags ? "don't " : "",
8456                             *RExC_parse
8457                         );
8458                     }
8459                 }
8460                 break;
8461
8462             case CONTINUE_PAT_MOD: /* 'c' */
8463                 if (SIZE_ONLY && ckWARN(WARN_REGEXP)) {
8464                     if (! (wastedflags & WASTED_C) ) {
8465                         wastedflags |= WASTED_GC;
8466                         vWARN3(
8467                             RExC_parse + 1,
8468                             "Useless (%sc) - %suse /gc modifier",
8469                             flagsp == &negflags ? "?-" : "?",
8470                             flagsp == &negflags ? "don't " : ""
8471                         );
8472                     }
8473                 }
8474                 break;
8475             case KEEPCOPY_PAT_MOD: /* 'p' */
8476                 if (flagsp == &negflags) {
8477                     if (SIZE_ONLY)
8478                         ckWARNreg(RExC_parse + 1,"Useless use of (?-p)");
8479                 } else {
8480                     *flagsp |= RXf_PMf_KEEPCOPY;
8481                 }
8482                 break;
8483             case '-':
8484                 /* A flag is a default iff it is following a minus, so
8485                  * if there is a minus, it means will be trying to
8486                  * re-specify a default which is an error */
8487                 if (has_use_defaults || flagsp == &negflags) {
8488                     goto fail_modifiers;
8489                 }
8490                 flagsp = &negflags;
8491                 wastedflags = 0;  /* reset so (?g-c) warns twice */
8492                 break;
8493             case ':':
8494             case ')':
8495                 RExC_flags |= posflags;
8496                 RExC_flags &= ~negflags;
8497                 set_regex_charset(&RExC_flags, cs);
8498                 return;
8499                 /*NOTREACHED*/
8500             default:
8501             fail_modifiers:
8502                 RExC_parse++;
8503                 vFAIL3("Sequence (%.*s...) not recognized",
8504                        RExC_parse-seqstart, seqstart);
8505                 /*NOTREACHED*/
8506         }
8507
8508         ++RExC_parse;
8509     }
8510 }
8511
8512 /*
8513  - reg - regular expression, i.e. main body or parenthesized thing
8514  *
8515  * Caller must absorb opening parenthesis.
8516  *
8517  * Combining parenthesis handling with the base level of regular expression
8518  * is a trifle forced, but the need to tie the tails of the branches to what
8519  * follows makes it hard to avoid.
8520  */
8521 #define REGTAIL(x,y,z) regtail((x),(y),(z),depth+1)
8522 #ifdef DEBUGGING
8523 #define REGTAIL_STUDY(x,y,z) regtail_study((x),(y),(z),depth+1)
8524 #else
8525 #define REGTAIL_STUDY(x,y,z) regtail((x),(y),(z),depth+1)
8526 #endif
8527
8528 /* Returns NULL, setting *flagp to TRYAGAIN at the end of (?) that only sets
8529    flags. Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan
8530    needs to be restarted.
8531    Otherwise would only return NULL if regbranch() returns NULL, which
8532    cannot happen.  */
8533 STATIC regnode *
8534 S_reg(pTHX_ RExC_state_t *pRExC_state, I32 paren, I32 *flagp,U32 depth)
8535     /* paren: Parenthesized? 0=top, 1=(, inside: changed to letter. */
8536 {
8537     dVAR;
8538     regnode *ret;               /* Will be the head of the group. */
8539     regnode *br;
8540     regnode *lastbr;
8541     regnode *ender = NULL;
8542     I32 parno = 0;
8543     I32 flags;
8544     U32 oregflags = RExC_flags;
8545     bool have_branch = 0;
8546     bool is_open = 0;
8547     I32 freeze_paren = 0;
8548     I32 after_freeze = 0;
8549
8550     char * parse_start = RExC_parse; /* MJD */
8551     char * const oregcomp_parse = RExC_parse;
8552
8553     GET_RE_DEBUG_FLAGS_DECL;
8554
8555     PERL_ARGS_ASSERT_REG;
8556     DEBUG_PARSE("reg ");
8557
8558     *flagp = 0;                         /* Tentatively. */
8559
8560
8561     /* Make an OPEN node, if parenthesized. */
8562     if (paren) {
8563         if ( *RExC_parse == '*') { /* (*VERB:ARG) */
8564             char *start_verb = RExC_parse;
8565             STRLEN verb_len = 0;
8566             char *start_arg = NULL;
8567             unsigned char op = 0;
8568             int argok = 1;
8569             int internal_argval = 0; /* internal_argval is only useful if !argok */
8570             while ( *RExC_parse && *RExC_parse != ')' ) {
8571                 if ( *RExC_parse == ':' ) {
8572                     start_arg = RExC_parse + 1;
8573                     break;
8574                 }
8575                 RExC_parse++;
8576             }
8577             ++start_verb;
8578             verb_len = RExC_parse - start_verb;
8579             if ( start_arg ) {
8580                 RExC_parse++;
8581                 while ( *RExC_parse && *RExC_parse != ')' ) 
8582                     RExC_parse++;
8583                 if ( *RExC_parse != ')' ) 
8584                     vFAIL("Unterminated verb pattern argument");
8585                 if ( RExC_parse == start_arg )
8586                     start_arg = NULL;
8587             } else {
8588                 if ( *RExC_parse != ')' )
8589                     vFAIL("Unterminated verb pattern");
8590             }
8591             
8592             switch ( *start_verb ) {
8593             case 'A':  /* (*ACCEPT) */
8594                 if ( memEQs(start_verb,verb_len,"ACCEPT") ) {
8595                     op = ACCEPT;
8596                     internal_argval = RExC_nestroot;
8597                 }
8598                 break;
8599             case 'C':  /* (*COMMIT) */
8600                 if ( memEQs(start_verb,verb_len,"COMMIT") )
8601                     op = COMMIT;
8602                 break;
8603             case 'F':  /* (*FAIL) */
8604                 if ( verb_len==1 || memEQs(start_verb,verb_len,"FAIL") ) {
8605                     op = OPFAIL;
8606                     argok = 0;
8607                 }
8608                 break;
8609             case ':':  /* (*:NAME) */
8610             case 'M':  /* (*MARK:NAME) */
8611                 if ( verb_len==0 || memEQs(start_verb,verb_len,"MARK") ) {
8612                     op = MARKPOINT;
8613                     argok = -1;
8614                 }
8615                 break;
8616             case 'P':  /* (*PRUNE) */
8617                 if ( memEQs(start_verb,verb_len,"PRUNE") )
8618                     op = PRUNE;
8619                 break;
8620             case 'S':   /* (*SKIP) */  
8621                 if ( memEQs(start_verb,verb_len,"SKIP") ) 
8622                     op = SKIP;
8623                 break;
8624             case 'T':  /* (*THEN) */
8625                 /* [19:06] <TimToady> :: is then */
8626                 if ( memEQs(start_verb,verb_len,"THEN") ) {
8627                     op = CUTGROUP;
8628                     RExC_seen |= REG_SEEN_CUTGROUP;
8629                 }
8630                 break;
8631             }
8632             if ( ! op ) {
8633                 RExC_parse++;
8634                 vFAIL3("Unknown verb pattern '%.*s'",
8635                     verb_len, start_verb);
8636             }
8637             if ( argok ) {
8638                 if ( start_arg && internal_argval ) {
8639                     vFAIL3("Verb pattern '%.*s' may not have an argument",
8640                         verb_len, start_verb); 
8641                 } else if ( argok < 0 && !start_arg ) {
8642                     vFAIL3("Verb pattern '%.*s' has a mandatory argument",
8643                         verb_len, start_verb);    
8644                 } else {
8645                     ret = reganode(pRExC_state, op, internal_argval);
8646                     if ( ! internal_argval && ! SIZE_ONLY ) {
8647                         if (start_arg) {
8648                             SV *sv = newSVpvn( start_arg, RExC_parse - start_arg);
8649                             ARG(ret) = add_data( pRExC_state, 1, "S" );
8650                             RExC_rxi->data->data[ARG(ret)]=(void*)sv;
8651                             ret->flags = 0;
8652                         } else {
8653                             ret->flags = 1; 
8654                         }
8655                     }               
8656                 }
8657                 if (!internal_argval)
8658                     RExC_seen |= REG_SEEN_VERBARG;
8659             } else if ( start_arg ) {
8660                 vFAIL3("Verb pattern '%.*s' may not have an argument",
8661                         verb_len, start_verb);    
8662             } else {
8663                 ret = reg_node(pRExC_state, op);
8664             }
8665             nextchar(pRExC_state);
8666             return ret;
8667         } else 
8668         if (*RExC_parse == '?') { /* (?...) */
8669             bool is_logical = 0;
8670             const char * const seqstart = RExC_parse;
8671
8672             RExC_parse++;
8673             paren = *RExC_parse++;
8674             ret = NULL;                 /* For look-ahead/behind. */
8675             switch (paren) {
8676
8677             case 'P':   /* (?P...) variants for those used to PCRE/Python */
8678                 paren = *RExC_parse++;
8679                 if ( paren == '<')         /* (?P<...>) named capture */
8680                     goto named_capture;
8681                 else if (paren == '>') {   /* (?P>name) named recursion */
8682                     goto named_recursion;
8683                 }
8684                 else if (paren == '=') {   /* (?P=...)  named backref */
8685                     /* this pretty much dupes the code for \k<NAME> in regatom(), if
8686                        you change this make sure you change that */
8687                     char* name_start = RExC_parse;
8688                     U32 num = 0;
8689                     SV *sv_dat = reg_scan_name(pRExC_state,
8690                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
8691                     if (RExC_parse == name_start || *RExC_parse != ')')
8692                         vFAIL2("Sequence %.3s... not terminated",parse_start);
8693
8694                     if (!SIZE_ONLY) {
8695                         num = add_data( pRExC_state, 1, "S" );
8696                         RExC_rxi->data->data[num]=(void*)sv_dat;
8697                         SvREFCNT_inc_simple_void(sv_dat);
8698                     }
8699                     RExC_sawback = 1;
8700                     ret = reganode(pRExC_state,
8701                                    ((! FOLD)
8702                                      ? NREF
8703                                      : (ASCII_FOLD_RESTRICTED)
8704                                        ? NREFFA
8705                                        : (AT_LEAST_UNI_SEMANTICS)
8706                                          ? NREFFU
8707                                          : (LOC)
8708                                            ? NREFFL
8709                                            : NREFF),
8710                                     num);
8711                     *flagp |= HASWIDTH;
8712
8713                     Set_Node_Offset(ret, parse_start+1);
8714                     Set_Node_Cur_Length(ret); /* MJD */
8715
8716                     nextchar(pRExC_state);
8717                     return ret;
8718                 }
8719                 RExC_parse++;
8720                 vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
8721                 /*NOTREACHED*/
8722             case '<':           /* (?<...) */
8723                 if (*RExC_parse == '!')
8724                     paren = ',';
8725                 else if (*RExC_parse != '=') 
8726               named_capture:
8727                 {               /* (?<...>) */
8728                     char *name_start;
8729                     SV *svname;
8730                     paren= '>';
8731             case '\'':          /* (?'...') */
8732                     name_start= RExC_parse;
8733                     svname = reg_scan_name(pRExC_state,
8734                         SIZE_ONLY ?  /* reverse test from the others */
8735                         REG_RSN_RETURN_NAME : 
8736                         REG_RSN_RETURN_NULL);
8737                     if (RExC_parse == name_start) {
8738                         RExC_parse++;
8739                         vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
8740                         /*NOTREACHED*/
8741                     }
8742                     if (*RExC_parse != paren)
8743                         vFAIL2("Sequence (?%c... not terminated",
8744                             paren=='>' ? '<' : paren);
8745                     if (SIZE_ONLY) {
8746                         HE *he_str;
8747                         SV *sv_dat = NULL;
8748                         if (!svname) /* shouldn't happen */
8749                             Perl_croak(aTHX_
8750                                 "panic: reg_scan_name returned NULL");
8751                         if (!RExC_paren_names) {
8752                             RExC_paren_names= newHV();
8753                             sv_2mortal(MUTABLE_SV(RExC_paren_names));
8754 #ifdef DEBUGGING
8755                             RExC_paren_name_list= newAV();
8756                             sv_2mortal(MUTABLE_SV(RExC_paren_name_list));
8757 #endif
8758                         }
8759                         he_str = hv_fetch_ent( RExC_paren_names, svname, 1, 0 );
8760                         if ( he_str )
8761                             sv_dat = HeVAL(he_str);
8762                         if ( ! sv_dat ) {
8763                             /* croak baby croak */
8764                             Perl_croak(aTHX_
8765                                 "panic: paren_name hash element allocation failed");
8766                         } else if ( SvPOK(sv_dat) ) {
8767                             /* (?|...) can mean we have dupes so scan to check
8768                                its already been stored. Maybe a flag indicating
8769                                we are inside such a construct would be useful,
8770                                but the arrays are likely to be quite small, so
8771                                for now we punt -- dmq */
8772                             IV count = SvIV(sv_dat);
8773                             I32 *pv = (I32*)SvPVX(sv_dat);
8774                             IV i;
8775                             for ( i = 0 ; i < count ; i++ ) {
8776                                 if ( pv[i] == RExC_npar ) {
8777                                     count = 0;
8778                                     break;
8779                                 }
8780                             }
8781                             if ( count ) {
8782                                 pv = (I32*)SvGROW(sv_dat, SvCUR(sv_dat) + sizeof(I32)+1);
8783                                 SvCUR_set(sv_dat, SvCUR(sv_dat) + sizeof(I32));
8784                                 pv[count] = RExC_npar;
8785                                 SvIV_set(sv_dat, SvIVX(sv_dat) + 1);
8786                             }
8787                         } else {
8788                             (void)SvUPGRADE(sv_dat,SVt_PVNV);
8789                             sv_setpvn(sv_dat, (char *)&(RExC_npar), sizeof(I32));
8790                             SvIOK_on(sv_dat);
8791                             SvIV_set(sv_dat, 1);
8792                         }
8793 #ifdef DEBUGGING
8794                         /* Yes this does cause a memory leak in debugging Perls */
8795                         if (!av_store(RExC_paren_name_list, RExC_npar, SvREFCNT_inc(svname)))
8796                             SvREFCNT_dec_NN(svname);
8797 #endif
8798
8799                         /*sv_dump(sv_dat);*/
8800                     }
8801                     nextchar(pRExC_state);
8802                     paren = 1;
8803                     goto capturing_parens;
8804                 }
8805                 RExC_seen |= REG_SEEN_LOOKBEHIND;
8806                 RExC_in_lookbehind++;
8807                 RExC_parse++;
8808             case '=':           /* (?=...) */
8809                 RExC_seen_zerolen++;
8810                 break;
8811             case '!':           /* (?!...) */
8812                 RExC_seen_zerolen++;
8813                 if (*RExC_parse == ')') {
8814                     ret=reg_node(pRExC_state, OPFAIL);
8815                     nextchar(pRExC_state);
8816                     return ret;
8817                 }
8818                 break;
8819             case '|':           /* (?|...) */
8820                 /* branch reset, behave like a (?:...) except that
8821                    buffers in alternations share the same numbers */
8822                 paren = ':'; 
8823                 after_freeze = freeze_paren = RExC_npar;
8824                 break;
8825             case ':':           /* (?:...) */
8826             case '>':           /* (?>...) */
8827                 break;
8828             case '$':           /* (?$...) */
8829             case '@':           /* (?@...) */
8830                 vFAIL2("Sequence (?%c...) not implemented", (int)paren);
8831                 break;
8832             case '0' :           /* (?0) */
8833             case 'R' :           /* (?R) */
8834                 if (*RExC_parse != ')')
8835                     FAIL("Sequence (?R) not terminated");
8836                 ret = reg_node(pRExC_state, GOSTART);
8837                 *flagp |= POSTPONED;
8838                 nextchar(pRExC_state);
8839                 return ret;
8840                 /*notreached*/
8841             { /* named and numeric backreferences */
8842                 I32 num;
8843             case '&':            /* (?&NAME) */
8844                 parse_start = RExC_parse - 1;
8845               named_recursion:
8846                 {
8847                     SV *sv_dat = reg_scan_name(pRExC_state,
8848                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
8849                      num = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
8850                 }
8851                 goto gen_recurse_regop;
8852                 assert(0); /* NOT REACHED */
8853             case '+':
8854                 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
8855                     RExC_parse++;
8856                     vFAIL("Illegal pattern");
8857                 }
8858                 goto parse_recursion;
8859                 /* NOT REACHED*/
8860             case '-': /* (?-1) */
8861                 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
8862                     RExC_parse--; /* rewind to let it be handled later */
8863                     goto parse_flags;
8864                 } 
8865                 /*FALLTHROUGH */
8866             case '1': case '2': case '3': case '4': /* (?1) */
8867             case '5': case '6': case '7': case '8': case '9':
8868                 RExC_parse--;
8869               parse_recursion:
8870                 num = atoi(RExC_parse);
8871                 parse_start = RExC_parse - 1; /* MJD */
8872                 if (*RExC_parse == '-')
8873                     RExC_parse++;
8874                 while (isDIGIT(*RExC_parse))
8875                         RExC_parse++;
8876                 if (*RExC_parse!=')') 
8877                     vFAIL("Expecting close bracket");
8878
8879               gen_recurse_regop:
8880                 if ( paren == '-' ) {
8881                     /*
8882                     Diagram of capture buffer numbering.
8883                     Top line is the normal capture buffer numbers
8884                     Bottom line is the negative indexing as from
8885                     the X (the (?-2))
8886
8887                     +   1 2    3 4 5 X          6 7
8888                        /(a(x)y)(a(b(c(?-2)d)e)f)(g(h))/
8889                     -   5 4    3 2 1 X          x x
8890
8891                     */
8892                     num = RExC_npar + num;
8893                     if (num < 1)  {
8894                         RExC_parse++;
8895                         vFAIL("Reference to nonexistent group");
8896                     }
8897                 } else if ( paren == '+' ) {
8898                     num = RExC_npar + num - 1;
8899                 }
8900
8901                 ret = reganode(pRExC_state, GOSUB, num);
8902                 if (!SIZE_ONLY) {
8903                     if (num > (I32)RExC_rx->nparens) {
8904                         RExC_parse++;
8905                         vFAIL("Reference to nonexistent group");
8906                     }
8907                     ARG2L_SET( ret, RExC_recurse_count++);
8908                     RExC_emit++;
8909                     DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
8910                         "Recurse #%"UVuf" to %"IVdf"\n", (UV)ARG(ret), (IV)ARG2L(ret)));
8911                 } else {
8912                     RExC_size++;
8913                 }
8914                 RExC_seen |= REG_SEEN_RECURSE;
8915                 Set_Node_Length(ret, 1 + regarglen[OP(ret)]); /* MJD */
8916                 Set_Node_Offset(ret, parse_start); /* MJD */
8917
8918                 *flagp |= POSTPONED;
8919                 nextchar(pRExC_state);
8920                 return ret;
8921             } /* named and numeric backreferences */
8922             assert(0); /* NOT REACHED */
8923
8924             case '?':           /* (??...) */
8925                 is_logical = 1;
8926                 if (*RExC_parse != '{') {
8927                     RExC_parse++;
8928                     vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
8929                     /*NOTREACHED*/
8930                 }
8931                 *flagp |= POSTPONED;
8932                 paren = *RExC_parse++;
8933                 /* FALL THROUGH */
8934             case '{':           /* (?{...}) */
8935             {
8936                 U32 n = 0;
8937                 struct reg_code_block *cb;
8938
8939                 RExC_seen_zerolen++;
8940
8941                 if (   !pRExC_state->num_code_blocks
8942                     || pRExC_state->code_index >= pRExC_state->num_code_blocks
8943                     || pRExC_state->code_blocks[pRExC_state->code_index].start
8944                         != (STRLEN)((RExC_parse -3 - (is_logical ? 1 : 0))
8945                             - RExC_start)
8946                 ) {
8947                     if (RExC_pm_flags & PMf_USE_RE_EVAL)
8948                         FAIL("panic: Sequence (?{...}): no code block found\n");
8949                     FAIL("Eval-group not allowed at runtime, use re 'eval'");
8950                 }
8951                 /* this is a pre-compiled code block (?{...}) */
8952                 cb = &pRExC_state->code_blocks[pRExC_state->code_index];
8953                 RExC_parse = RExC_start + cb->end;
8954                 if (!SIZE_ONLY) {
8955                     OP *o = cb->block;
8956                     if (cb->src_regex) {
8957                         n = add_data(pRExC_state, 2, "rl");
8958                         RExC_rxi->data->data[n] =
8959                             (void*)SvREFCNT_inc((SV*)cb->src_regex);
8960                         RExC_rxi->data->data[n+1] = (void*)o;
8961                     }
8962                     else {
8963                         n = add_data(pRExC_state, 1,
8964                                (RExC_pm_flags & PMf_HAS_CV) ? "L" : "l");
8965                         RExC_rxi->data->data[n] = (void*)o;
8966                     }
8967                 }
8968                 pRExC_state->code_index++;
8969                 nextchar(pRExC_state);
8970
8971                 if (is_logical) {
8972                     regnode *eval;
8973                     ret = reg_node(pRExC_state, LOGICAL);
8974                     eval = reganode(pRExC_state, EVAL, n);
8975                     if (!SIZE_ONLY) {
8976                         ret->flags = 2;
8977                         /* for later propagation into (??{}) return value */
8978                         eval->flags = (U8) (RExC_flags & RXf_PMf_COMPILETIME);
8979                     }
8980                     REGTAIL(pRExC_state, ret, eval);
8981                     /* deal with the length of this later - MJD */
8982                     return ret;
8983                 }
8984                 ret = reganode(pRExC_state, EVAL, n);
8985                 Set_Node_Length(ret, RExC_parse - parse_start + 1);
8986                 Set_Node_Offset(ret, parse_start);
8987                 return ret;
8988             }
8989             case '(':           /* (?(?{...})...) and (?(?=...)...) */
8990             {
8991                 int is_define= 0;
8992                 if (RExC_parse[0] == '?') {        /* (?(?...)) */
8993                     if (RExC_parse[1] == '=' || RExC_parse[1] == '!'
8994                         || RExC_parse[1] == '<'
8995                         || RExC_parse[1] == '{') { /* Lookahead or eval. */
8996                         I32 flag;
8997                         regnode *tail;
8998
8999                         ret = reg_node(pRExC_state, LOGICAL);
9000                         if (!SIZE_ONLY)
9001                             ret->flags = 1;
9002                         
9003                         tail = reg(pRExC_state, 1, &flag, depth+1);
9004                         if (flag & RESTART_UTF8) {
9005                             *flagp = RESTART_UTF8;
9006                             return NULL;
9007                         }
9008                         REGTAIL(pRExC_state, ret, tail);
9009                         goto insert_if;
9010                     }
9011                 }
9012                 else if ( RExC_parse[0] == '<'     /* (?(<NAME>)...) */
9013                          || RExC_parse[0] == '\'' ) /* (?('NAME')...) */
9014                 {
9015                     char ch = RExC_parse[0] == '<' ? '>' : '\'';
9016                     char *name_start= RExC_parse++;
9017                     U32 num = 0;
9018                     SV *sv_dat=reg_scan_name(pRExC_state,
9019                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
9020                     if (RExC_parse == name_start || *RExC_parse != ch)
9021                         vFAIL2("Sequence (?(%c... not terminated",
9022                             (ch == '>' ? '<' : ch));
9023                     RExC_parse++;
9024                     if (!SIZE_ONLY) {
9025                         num = add_data( pRExC_state, 1, "S" );
9026                         RExC_rxi->data->data[num]=(void*)sv_dat;
9027                         SvREFCNT_inc_simple_void(sv_dat);
9028                     }
9029                     ret = reganode(pRExC_state,NGROUPP,num);
9030                     goto insert_if_check_paren;
9031                 }
9032                 else if (RExC_parse[0] == 'D' &&
9033                          RExC_parse[1] == 'E' &&
9034                          RExC_parse[2] == 'F' &&
9035                          RExC_parse[3] == 'I' &&
9036                          RExC_parse[4] == 'N' &&
9037                          RExC_parse[5] == 'E')
9038                 {
9039                     ret = reganode(pRExC_state,DEFINEP,0);
9040                     RExC_parse +=6 ;
9041                     is_define = 1;
9042                     goto insert_if_check_paren;
9043                 }
9044                 else if (RExC_parse[0] == 'R') {
9045                     RExC_parse++;
9046                     parno = 0;
9047                     if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
9048                         parno = atoi(RExC_parse++);
9049                         while (isDIGIT(*RExC_parse))
9050                             RExC_parse++;
9051                     } else if (RExC_parse[0] == '&') {
9052                         SV *sv_dat;
9053                         RExC_parse++;
9054                         sv_dat = reg_scan_name(pRExC_state,
9055                             SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
9056                         parno = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
9057                     }
9058                     ret = reganode(pRExC_state,INSUBP,parno); 
9059                     goto insert_if_check_paren;
9060                 }
9061                 else if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
9062                     /* (?(1)...) */
9063                     char c;
9064                     parno = atoi(RExC_parse++);
9065
9066                     while (isDIGIT(*RExC_parse))
9067                         RExC_parse++;
9068                     ret = reganode(pRExC_state, GROUPP, parno);
9069
9070                  insert_if_check_paren:
9071                     if ((c = *nextchar(pRExC_state)) != ')')
9072                         vFAIL("Switch condition not recognized");
9073                   insert_if:
9074                     REGTAIL(pRExC_state, ret, reganode(pRExC_state, IFTHEN, 0));
9075                     br = regbranch(pRExC_state, &flags, 1,depth+1);
9076                     if (br == NULL) {
9077                         if (flags & RESTART_UTF8) {
9078                             *flagp = RESTART_UTF8;
9079                             return NULL;
9080                         }
9081                         FAIL2("panic: regbranch returned NULL, flags=%#X",
9082                               flags);
9083                     } else
9084                         REGTAIL(pRExC_state, br, reganode(pRExC_state, LONGJMP, 0));
9085                     c = *nextchar(pRExC_state);
9086                     if (flags&HASWIDTH)
9087                         *flagp |= HASWIDTH;
9088                     if (c == '|') {
9089                         if (is_define) 
9090                             vFAIL("(?(DEFINE)....) does not allow branches");
9091                         lastbr = reganode(pRExC_state, IFTHEN, 0); /* Fake one for optimizer. */
9092                         if (!regbranch(pRExC_state, &flags, 1,depth+1)) {
9093                             if (flags & RESTART_UTF8) {
9094                                 *flagp = RESTART_UTF8;
9095                                 return NULL;
9096                             }
9097                             FAIL2("panic: regbranch returned NULL, flags=%#X",
9098                                   flags);
9099                         }
9100                         REGTAIL(pRExC_state, ret, lastbr);
9101                         if (flags&HASWIDTH)
9102                             *flagp |= HASWIDTH;
9103                         c = *nextchar(pRExC_state);
9104                     }
9105                     else
9106                         lastbr = NULL;
9107                     if (c != ')')
9108                         vFAIL("Switch (?(condition)... contains too many branches");
9109                     ender = reg_node(pRExC_state, TAIL);
9110                     REGTAIL(pRExC_state, br, ender);
9111                     if (lastbr) {
9112                         REGTAIL(pRExC_state, lastbr, ender);
9113                         REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender);
9114                     }
9115                     else
9116                         REGTAIL(pRExC_state, ret, ender);
9117                     RExC_size++; /* XXX WHY do we need this?!!
9118                                     For large programs it seems to be required
9119                                     but I can't figure out why. -- dmq*/
9120                     return ret;
9121                 }
9122                 else {
9123                     vFAIL2("Unknown switch condition (?(%.2s", RExC_parse);
9124                 }
9125             }
9126             case '[':           /* (?[ ... ]) */
9127                 return handle_regex_sets(pRExC_state, NULL, flagp, depth,
9128                                          oregcomp_parse);
9129             case 0:
9130                 RExC_parse--; /* for vFAIL to print correctly */
9131                 vFAIL("Sequence (? incomplete");
9132                 break;
9133             default: /* e.g., (?i) */
9134                 --RExC_parse;
9135               parse_flags:
9136                 parse_lparen_question_flags(pRExC_state);
9137                 if (UCHARAT(RExC_parse) != ':') {
9138                     nextchar(pRExC_state);
9139                     *flagp = TRYAGAIN;
9140                     return NULL;
9141                 }
9142                 paren = ':';
9143                 nextchar(pRExC_state);
9144                 ret = NULL;
9145                 goto parse_rest;
9146             } /* end switch */
9147         }
9148         else {                  /* (...) */
9149           capturing_parens:
9150             parno = RExC_npar;
9151             RExC_npar++;
9152             
9153             ret = reganode(pRExC_state, OPEN, parno);
9154             if (!SIZE_ONLY ){
9155                 if (!RExC_nestroot) 
9156                     RExC_nestroot = parno;
9157                 if (RExC_seen & REG_SEEN_RECURSE
9158                     && !RExC_open_parens[parno-1])
9159                 {
9160                     DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
9161                         "Setting open paren #%"IVdf" to %d\n", 
9162                         (IV)parno, REG_NODE_NUM(ret)));
9163                     RExC_open_parens[parno-1]= ret;
9164                 }
9165             }
9166             Set_Node_Length(ret, 1); /* MJD */
9167             Set_Node_Offset(ret, RExC_parse); /* MJD */
9168             is_open = 1;
9169         }
9170     }
9171     else                        /* ! paren */
9172         ret = NULL;
9173    
9174    parse_rest:
9175     /* Pick up the branches, linking them together. */
9176     parse_start = RExC_parse;   /* MJD */
9177     br = regbranch(pRExC_state, &flags, 1,depth+1);
9178
9179     /*     branch_len = (paren != 0); */
9180
9181     if (br == NULL) {
9182         if (flags & RESTART_UTF8) {
9183             *flagp = RESTART_UTF8;
9184             return NULL;
9185         }
9186         FAIL2("panic: regbranch returned NULL, flags=%#X", flags);
9187     }
9188     if (*RExC_parse == '|') {
9189         if (!SIZE_ONLY && RExC_extralen) {
9190             reginsert(pRExC_state, BRANCHJ, br, depth+1);
9191         }
9192         else {                  /* MJD */
9193             reginsert(pRExC_state, BRANCH, br, depth+1);
9194             Set_Node_Length(br, paren != 0);
9195             Set_Node_Offset_To_R(br-RExC_emit_start, parse_start-RExC_start);
9196         }
9197         have_branch = 1;
9198         if (SIZE_ONLY)
9199             RExC_extralen += 1;         /* For BRANCHJ-BRANCH. */
9200     }
9201     else if (paren == ':') {
9202         *flagp |= flags&SIMPLE;
9203     }
9204     if (is_open) {                              /* Starts with OPEN. */
9205         REGTAIL(pRExC_state, ret, br);          /* OPEN -> first. */
9206     }
9207     else if (paren != '?')              /* Not Conditional */
9208         ret = br;
9209     *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
9210     lastbr = br;
9211     while (*RExC_parse == '|') {
9212         if (!SIZE_ONLY && RExC_extralen) {
9213             ender = reganode(pRExC_state, LONGJMP,0);
9214             REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender); /* Append to the previous. */
9215         }
9216         if (SIZE_ONLY)
9217             RExC_extralen += 2;         /* Account for LONGJMP. */
9218         nextchar(pRExC_state);
9219         if (freeze_paren) {
9220             if (RExC_npar > after_freeze)
9221                 after_freeze = RExC_npar;
9222             RExC_npar = freeze_paren;       
9223         }
9224         br = regbranch(pRExC_state, &flags, 0, depth+1);
9225
9226         if (br == NULL) {
9227             if (flags & RESTART_UTF8) {
9228                 *flagp = RESTART_UTF8;
9229                 return NULL;
9230             }
9231             FAIL2("panic: regbranch returned NULL, flags=%#X", flags);
9232         }
9233         REGTAIL(pRExC_state, lastbr, br);               /* BRANCH -> BRANCH. */
9234         lastbr = br;
9235         *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
9236     }
9237
9238     if (have_branch || paren != ':') {
9239         /* Make a closing node, and hook it on the end. */
9240         switch (paren) {
9241         case ':':
9242             ender = reg_node(pRExC_state, TAIL);
9243             break;
9244         case 1:
9245             ender = reganode(pRExC_state, CLOSE, parno);
9246             if (!SIZE_ONLY && RExC_seen & REG_SEEN_RECURSE) {
9247                 DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
9248                         "Setting close paren #%"IVdf" to %d\n", 
9249                         (IV)parno, REG_NODE_NUM(ender)));
9250                 RExC_close_parens[parno-1]= ender;
9251                 if (RExC_nestroot == parno) 
9252                     RExC_nestroot = 0;
9253             }       
9254             Set_Node_Offset(ender,RExC_parse+1); /* MJD */
9255             Set_Node_Length(ender,1); /* MJD */
9256             break;
9257         case '<':
9258         case ',':
9259         case '=':
9260         case '!':
9261             *flagp &= ~HASWIDTH;
9262             /* FALL THROUGH */
9263         case '>':
9264             ender = reg_node(pRExC_state, SUCCEED);
9265             break;
9266         case 0:
9267             ender = reg_node(pRExC_state, END);
9268             if (!SIZE_ONLY) {
9269                 assert(!RExC_opend); /* there can only be one! */
9270                 RExC_opend = ender;
9271             }
9272             break;
9273         }
9274         DEBUG_PARSE_r(if (!SIZE_ONLY) {
9275             SV * const mysv_val1=sv_newmortal();
9276             SV * const mysv_val2=sv_newmortal();
9277             DEBUG_PARSE_MSG("lsbr");
9278             regprop(RExC_rx, mysv_val1, lastbr);
9279             regprop(RExC_rx, mysv_val2, ender);
9280             PerlIO_printf(Perl_debug_log, "~ tying lastbr %s (%"IVdf") to ender %s (%"IVdf") offset %"IVdf"\n",
9281                           SvPV_nolen_const(mysv_val1),
9282                           (IV)REG_NODE_NUM(lastbr),
9283                           SvPV_nolen_const(mysv_val2),
9284                           (IV)REG_NODE_NUM(ender),
9285                           (IV)(ender - lastbr)
9286             );
9287         });
9288         REGTAIL(pRExC_state, lastbr, ender);
9289
9290         if (have_branch && !SIZE_ONLY) {
9291             char is_nothing= 1;
9292             if (depth==1)
9293                 RExC_seen |= REG_TOP_LEVEL_BRANCHES;
9294
9295             /* Hook the tails of the branches to the closing node. */
9296             for (br = ret; br; br = regnext(br)) {
9297                 const U8 op = PL_regkind[OP(br)];
9298                 if (op == BRANCH) {
9299                     REGTAIL_STUDY(pRExC_state, NEXTOPER(br), ender);
9300                     if (OP(NEXTOPER(br)) != NOTHING || regnext(NEXTOPER(br)) != ender)
9301                         is_nothing= 0;
9302                 }
9303                 else if (op == BRANCHJ) {
9304                     REGTAIL_STUDY(pRExC_state, NEXTOPER(NEXTOPER(br)), ender);
9305                     /* for now we always disable this optimisation * /
9306                     if (OP(NEXTOPER(NEXTOPER(br))) != NOTHING || regnext(NEXTOPER(NEXTOPER(br))) != ender)
9307                     */
9308                         is_nothing= 0;
9309                 }
9310             }
9311             if (is_nothing) {
9312                 br= PL_regkind[OP(ret)] != BRANCH ? regnext(ret) : ret;
9313                 DEBUG_PARSE_r(if (!SIZE_ONLY) {
9314                     SV * const mysv_val1=sv_newmortal();
9315                     SV * const mysv_val2=sv_newmortal();
9316                     DEBUG_PARSE_MSG("NADA");
9317                     regprop(RExC_rx, mysv_val1, ret);
9318                     regprop(RExC_rx, mysv_val2, ender);
9319                     PerlIO_printf(Perl_debug_log, "~ converting ret %s (%"IVdf") to ender %s (%"IVdf") offset %"IVdf"\n",
9320                                   SvPV_nolen_const(mysv_val1),
9321                                   (IV)REG_NODE_NUM(ret),
9322                                   SvPV_nolen_const(mysv_val2),
9323                                   (IV)REG_NODE_NUM(ender),
9324                                   (IV)(ender - ret)
9325                     );
9326                 });
9327                 OP(br)= NOTHING;
9328                 if (OP(ender) == TAIL) {
9329                     NEXT_OFF(br)= 0;
9330                     RExC_emit= br + 1;
9331                 } else {
9332                     regnode *opt;
9333                     for ( opt= br + 1; opt < ender ; opt++ )
9334                         OP(opt)= OPTIMIZED;
9335                     NEXT_OFF(br)= ender - br;
9336                 }
9337             }
9338         }
9339     }
9340
9341     {
9342         const char *p;
9343         static const char parens[] = "=!<,>";
9344
9345         if (paren && (p = strchr(parens, paren))) {
9346             U8 node = ((p - parens) % 2) ? UNLESSM : IFMATCH;
9347             int flag = (p - parens) > 1;
9348
9349             if (paren == '>')
9350                 node = SUSPEND, flag = 0;
9351             reginsert(pRExC_state, node,ret, depth+1);
9352             Set_Node_Cur_Length(ret);
9353             Set_Node_Offset(ret, parse_start + 1);
9354             ret->flags = flag;
9355             REGTAIL_STUDY(pRExC_state, ret, reg_node(pRExC_state, TAIL));
9356         }
9357     }
9358
9359     /* Check for proper termination. */
9360     if (paren) {
9361         RExC_flags = oregflags;
9362         if (RExC_parse >= RExC_end || *nextchar(pRExC_state) != ')') {
9363             RExC_parse = oregcomp_parse;
9364             vFAIL("Unmatched (");
9365         }
9366     }
9367     else if (!paren && RExC_parse < RExC_end) {
9368         if (*RExC_parse == ')') {
9369             RExC_parse++;
9370             vFAIL("Unmatched )");
9371         }
9372         else
9373             FAIL("Junk on end of regexp");      /* "Can't happen". */
9374         assert(0); /* NOTREACHED */
9375     }
9376
9377     if (RExC_in_lookbehind) {
9378         RExC_in_lookbehind--;
9379     }
9380     if (after_freeze > RExC_npar)
9381         RExC_npar = after_freeze;
9382     return(ret);
9383 }
9384
9385 /*
9386  - regbranch - one alternative of an | operator
9387  *
9388  * Implements the concatenation operator.
9389  *
9390  * Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan needs to be
9391  * restarted.
9392  */
9393 STATIC regnode *
9394 S_regbranch(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, I32 first, U32 depth)
9395 {
9396     dVAR;
9397     regnode *ret;
9398     regnode *chain = NULL;
9399     regnode *latest;
9400     I32 flags = 0, c = 0;
9401     GET_RE_DEBUG_FLAGS_DECL;
9402
9403     PERL_ARGS_ASSERT_REGBRANCH;
9404
9405     DEBUG_PARSE("brnc");
9406
9407     if (first)
9408         ret = NULL;
9409     else {
9410         if (!SIZE_ONLY && RExC_extralen)
9411             ret = reganode(pRExC_state, BRANCHJ,0);
9412         else {
9413             ret = reg_node(pRExC_state, BRANCH);
9414             Set_Node_Length(ret, 1);
9415         }
9416     }
9417
9418     if (!first && SIZE_ONLY)
9419         RExC_extralen += 1;                     /* BRANCHJ */
9420
9421     *flagp = WORST;                     /* Tentatively. */
9422
9423     RExC_parse--;
9424     nextchar(pRExC_state);
9425     while (RExC_parse < RExC_end && *RExC_parse != '|' && *RExC_parse != ')') {
9426         flags &= ~TRYAGAIN;
9427         latest = regpiece(pRExC_state, &flags,depth+1);
9428         if (latest == NULL) {
9429             if (flags & TRYAGAIN)
9430                 continue;
9431             if (flags & RESTART_UTF8) {
9432                 *flagp = RESTART_UTF8;
9433                 return NULL;
9434             }
9435             FAIL2("panic: regpiece returned NULL, flags=%#X", flags);
9436         }
9437         else if (ret == NULL)
9438             ret = latest;
9439         *flagp |= flags&(HASWIDTH|POSTPONED);
9440         if (chain == NULL)      /* First piece. */
9441             *flagp |= flags&SPSTART;
9442         else {
9443             RExC_naughty++;
9444             REGTAIL(pRExC_state, chain, latest);
9445         }
9446         chain = latest;
9447         c++;
9448     }
9449     if (chain == NULL) {        /* Loop ran zero times. */
9450         chain = reg_node(pRExC_state, NOTHING);
9451         if (ret == NULL)
9452             ret = chain;
9453     }
9454     if (c == 1) {
9455         *flagp |= flags&SIMPLE;
9456     }
9457
9458     return ret;
9459 }
9460
9461 /*
9462  - regpiece - something followed by possible [*+?]
9463  *
9464  * Note that the branching code sequences used for ? and the general cases
9465  * of * and + are somewhat optimized:  they use the same NOTHING node as
9466  * both the endmarker for their branch list and the body of the last branch.
9467  * It might seem that this node could be dispensed with entirely, but the
9468  * endmarker role is not redundant.
9469  *
9470  * Returns NULL, setting *flagp to TRYAGAIN if regatom() returns NULL with
9471  * TRYAGAIN.
9472  * Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan needs to be
9473  * restarted.
9474  */
9475 STATIC regnode *
9476 S_regpiece(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
9477 {
9478     dVAR;
9479     regnode *ret;
9480     char op;
9481     char *next;
9482     I32 flags;
9483     const char * const origparse = RExC_parse;
9484     I32 min;
9485     I32 max = REG_INFTY;
9486 #ifdef RE_TRACK_PATTERN_OFFSETS
9487     char *parse_start;
9488 #endif
9489     const char *maxpos = NULL;
9490
9491     /* Save the original in case we change the emitted regop to a FAIL. */
9492     regnode * const orig_emit = RExC_emit;
9493
9494     GET_RE_DEBUG_FLAGS_DECL;
9495
9496     PERL_ARGS_ASSERT_REGPIECE;
9497
9498     DEBUG_PARSE("piec");
9499
9500     ret = regatom(pRExC_state, &flags,depth+1);
9501     if (ret == NULL) {
9502         if (flags & (TRYAGAIN|RESTART_UTF8))
9503             *flagp |= flags & (TRYAGAIN|RESTART_UTF8);
9504         else
9505             FAIL2("panic: regatom returned NULL, flags=%#X", flags);
9506         return(NULL);
9507     }
9508
9509     op = *RExC_parse;
9510
9511     if (op == '{' && regcurly(RExC_parse, FALSE)) {
9512         maxpos = NULL;
9513 #ifdef RE_TRACK_PATTERN_OFFSETS
9514         parse_start = RExC_parse; /* MJD */
9515 #endif
9516         next = RExC_parse + 1;
9517         while (isDIGIT(*next) || *next == ',') {
9518             if (*next == ',') {
9519                 if (maxpos)
9520                     break;
9521                 else
9522                     maxpos = next;
9523             }
9524             next++;
9525         }
9526         if (*next == '}') {             /* got one */
9527             if (!maxpos)
9528                 maxpos = next;
9529             RExC_parse++;
9530             min = atoi(RExC_parse);
9531             if (*maxpos == ',')
9532                 maxpos++;
9533             else
9534                 maxpos = RExC_parse;
9535             max = atoi(maxpos);
9536             if (!max && *maxpos != '0')
9537                 max = REG_INFTY;                /* meaning "infinity" */
9538             else if (max >= REG_INFTY)
9539                 vFAIL2("Quantifier in {,} bigger than %d", REG_INFTY - 1);
9540             RExC_parse = next;
9541             nextchar(pRExC_state);
9542             if (max < min) {    /* If can't match, warn and optimize to fail
9543                                    unconditionally */
9544                 if (SIZE_ONLY) {
9545                     ckWARNreg(RExC_parse, "Quantifier {n,m} with n > m can't match");
9546
9547                     /* We can't back off the size because we have to reserve
9548                      * enough space for all the things we are about to throw
9549                      * away, but we can shrink it by the ammount we are about
9550                      * to re-use here */
9551                     RExC_size = PREVOPER(RExC_size) - regarglen[(U8)OPFAIL];
9552                 }
9553                 else {
9554                     RExC_emit = orig_emit;
9555                 }
9556                 ret = reg_node(pRExC_state, OPFAIL);
9557                 return ret;
9558             }
9559             else if (max == 0) {    /* replace {0} with a nothing node */
9560                 if (SIZE_ONLY) {
9561                     RExC_size = PREVOPER(RExC_size) - regarglen[(U8)NOTHING];
9562                 }
9563                 else {
9564                     RExC_emit = orig_emit;
9565                 }
9566                 ret = reg_node(pRExC_state, NOTHING);
9567                 return ret;
9568             }
9569
9570         do_curly:
9571             if ((flags&SIMPLE)) {
9572                 RExC_naughty += 2 + RExC_naughty / 2;
9573                 reginsert(pRExC_state, CURLY, ret, depth+1);
9574                 Set_Node_Offset(ret, parse_start+1); /* MJD */
9575                 Set_Node_Cur_Length(ret);
9576             }
9577             else {
9578                 regnode * const w = reg_node(pRExC_state, WHILEM);
9579
9580                 w->flags = 0;
9581                 REGTAIL(pRExC_state, ret, w);
9582                 if (!SIZE_ONLY && RExC_extralen) {
9583                     reginsert(pRExC_state, LONGJMP,ret, depth+1);
9584                     reginsert(pRExC_state, NOTHING,ret, depth+1);
9585                     NEXT_OFF(ret) = 3;  /* Go over LONGJMP. */
9586                 }
9587                 reginsert(pRExC_state, CURLYX,ret, depth+1);
9588                                 /* MJD hk */
9589                 Set_Node_Offset(ret, parse_start+1);
9590                 Set_Node_Length(ret,
9591                                 op == '{' ? (RExC_parse - parse_start) : 1);
9592
9593                 if (!SIZE_ONLY && RExC_extralen)
9594                     NEXT_OFF(ret) = 3;  /* Go over NOTHING to LONGJMP. */
9595                 REGTAIL(pRExC_state, ret, reg_node(pRExC_state, NOTHING));
9596                 if (SIZE_ONLY)
9597                     RExC_whilem_seen++, RExC_extralen += 3;
9598                 RExC_naughty += 4 + RExC_naughty;       /* compound interest */
9599             }
9600             ret->flags = 0;
9601
9602             if (min > 0)
9603                 *flagp = WORST;
9604             if (max > 0)
9605                 *flagp |= HASWIDTH;
9606             if (!SIZE_ONLY) {
9607                 ARG1_SET(ret, (U16)min);
9608                 ARG2_SET(ret, (U16)max);
9609             }
9610
9611             goto nest_check;
9612         }
9613     }
9614
9615     if (!ISMULT1(op)) {
9616         *flagp = flags;
9617         return(ret);
9618     }
9619
9620 #if 0                           /* Now runtime fix should be reliable. */
9621
9622     /* if this is reinstated, don't forget to put this back into perldiag:
9623
9624             =item Regexp *+ operand could be empty at {#} in regex m/%s/
9625
9626            (F) The part of the regexp subject to either the * or + quantifier
9627            could match an empty string. The {#} shows in the regular
9628            expression about where the problem was discovered.
9629
9630     */
9631
9632     if (!(flags&HASWIDTH) && op != '?')
9633       vFAIL("Regexp *+ operand could be empty");
9634 #endif
9635
9636 #ifdef RE_TRACK_PATTERN_OFFSETS
9637     parse_start = RExC_parse;
9638 #endif
9639     nextchar(pRExC_state);
9640
9641     *flagp = (op != '+') ? (WORST|SPSTART|HASWIDTH) : (WORST|HASWIDTH);
9642
9643     if (op == '*' && (flags&SIMPLE)) {
9644         reginsert(pRExC_state, STAR, ret, depth+1);
9645         ret->flags = 0;
9646         RExC_naughty += 4;
9647     }
9648     else if (op == '*') {
9649         min = 0;
9650         goto do_curly;
9651     }
9652     else if (op == '+' && (flags&SIMPLE)) {
9653         reginsert(pRExC_state, PLUS, ret, depth+1);
9654         ret->flags = 0;
9655         RExC_naughty += 3;
9656     }
9657     else if (op == '+') {
9658         min = 1;
9659         goto do_curly;
9660     }
9661     else if (op == '?') {
9662         min = 0; max = 1;
9663         goto do_curly;
9664     }
9665   nest_check:
9666     if (!SIZE_ONLY && !(flags&(HASWIDTH|POSTPONED)) && max > REG_INFTY/3) {
9667         SAVEFREESV(RExC_rx_sv); /* in case of fatal warnings */
9668         ckWARN3reg(RExC_parse,
9669                    "%.*s matches null string many times",
9670                    (int)(RExC_parse >= origparse ? RExC_parse - origparse : 0),
9671                    origparse);
9672         (void)ReREFCNT_inc(RExC_rx_sv);
9673     }
9674
9675     if (RExC_parse < RExC_end && *RExC_parse == '?') {
9676         nextchar(pRExC_state);
9677         reginsert(pRExC_state, MINMOD, ret, depth+1);
9678         REGTAIL(pRExC_state, ret, ret + NODE_STEP_REGNODE);
9679     }
9680 #ifndef REG_ALLOW_MINMOD_SUSPEND
9681     else
9682 #endif
9683     if (RExC_parse < RExC_end && *RExC_parse == '+') {
9684         regnode *ender;
9685         nextchar(pRExC_state);
9686         ender = reg_node(pRExC_state, SUCCEED);
9687         REGTAIL(pRExC_state, ret, ender);
9688         reginsert(pRExC_state, SUSPEND, ret, depth+1);
9689         ret->flags = 0;
9690         ender = reg_node(pRExC_state, TAIL);
9691         REGTAIL(pRExC_state, ret, ender);
9692         /*ret= ender;*/
9693     }
9694
9695     if (RExC_parse < RExC_end && ISMULT2(RExC_parse)) {
9696         RExC_parse++;
9697         vFAIL("Nested quantifiers");
9698     }
9699
9700     return(ret);
9701 }
9702
9703 STATIC bool
9704 S_grok_bslash_N(pTHX_ RExC_state_t *pRExC_state, regnode** node_p, UV *valuep, I32 *flagp, U32 depth, bool in_char_class,
9705         const bool strict   /* Apply stricter parsing rules? */
9706     )
9707 {
9708    
9709  /* This is expected to be called by a parser routine that has recognized '\N'
9710    and needs to handle the rest. RExC_parse is expected to point at the first
9711    char following the N at the time of the call.  On successful return,
9712    RExC_parse has been updated to point to just after the sequence identified
9713    by this routine, and <*flagp> has been updated.
9714
9715    The \N may be inside (indicated by the boolean <in_char_class>) or outside a
9716    character class.
9717
9718    \N may begin either a named sequence, or if outside a character class, mean
9719    to match a non-newline.  For non single-quoted regexes, the tokenizer has
9720    attempted to decide which, and in the case of a named sequence, converted it
9721    into one of the forms: \N{} (if the sequence is null), or \N{U+c1.c2...},
9722    where c1... are the characters in the sequence.  For single-quoted regexes,
9723    the tokenizer passes the \N sequence through unchanged; this code will not
9724    attempt to determine this nor expand those, instead raising a syntax error.
9725    The net effect is that if the beginning of the passed-in pattern isn't '{U+'
9726    or there is no '}', it signals that this \N occurrence means to match a
9727    non-newline.
9728
9729    Only the \N{U+...} form should occur in a character class, for the same
9730    reason that '.' inside a character class means to just match a period: it
9731    just doesn't make sense.
9732
9733    The function raises an error (via vFAIL), and doesn't return for various
9734    syntax errors.  Otherwise it returns TRUE and sets <node_p> or <valuep> on
9735    success; it returns FALSE otherwise. Returns FALSE, setting *flagp to
9736    RESTART_UTF8 if the sizing scan needs to be restarted. Such a restart is
9737    only possible if node_p is non-NULL.
9738
9739
9740    If <valuep> is non-null, it means the caller can accept an input sequence
9741    consisting of a just a single code point; <*valuep> is set to that value
9742    if the input is such.
9743
9744    If <node_p> is non-null it signifies that the caller can accept any other
9745    legal sequence (i.e., one that isn't just a single code point).  <*node_p>
9746    is set as follows:
9747     1) \N means not-a-NL: points to a newly created REG_ANY node;
9748     2) \N{}:              points to a new NOTHING node;
9749     3) otherwise:         points to a new EXACT node containing the resolved
9750                           string.
9751    Note that FALSE is returned for single code point sequences if <valuep> is
9752    null.
9753  */
9754
9755     char * endbrace;    /* '}' following the name */
9756     char* p;
9757     char *endchar;      /* Points to '.' or '}' ending cur char in the input
9758                            stream */
9759     bool has_multiple_chars; /* true if the input stream contains a sequence of
9760                                 more than one character */
9761
9762     GET_RE_DEBUG_FLAGS_DECL;
9763  
9764     PERL_ARGS_ASSERT_GROK_BSLASH_N;
9765
9766     GET_RE_DEBUG_FLAGS;
9767
9768     assert(cBOOL(node_p) ^ cBOOL(valuep));  /* Exactly one should be set */
9769
9770     /* The [^\n] meaning of \N ignores spaces and comments under the /x
9771      * modifier.  The other meaning does not */
9772     p = (RExC_flags & RXf_PMf_EXTENDED)
9773         ? regwhite( pRExC_state, RExC_parse )
9774         : RExC_parse;
9775
9776     /* Disambiguate between \N meaning a named character versus \N meaning
9777      * [^\n].  The former is assumed when it can't be the latter. */
9778     if (*p != '{' || regcurly(p, FALSE)) {
9779         RExC_parse = p;
9780         if (! node_p) {
9781             /* no bare \N in a charclass */
9782             if (in_char_class) {
9783                 vFAIL("\\N in a character class must be a named character: \\N{...}");
9784             }
9785             return FALSE;
9786         }
9787         nextchar(pRExC_state);
9788         *node_p = reg_node(pRExC_state, REG_ANY);
9789         *flagp |= HASWIDTH|SIMPLE;
9790         RExC_naughty++;
9791         RExC_parse--;
9792         Set_Node_Length(*node_p, 1); /* MJD */
9793         return TRUE;
9794     }
9795
9796     /* Here, we have decided it should be a named character or sequence */
9797
9798     /* The test above made sure that the next real character is a '{', but
9799      * under the /x modifier, it could be separated by space (or a comment and
9800      * \n) and this is not allowed (for consistency with \x{...} and the
9801      * tokenizer handling of \N{NAME}). */
9802     if (*RExC_parse != '{') {
9803         vFAIL("Missing braces on \\N{}");
9804     }
9805
9806     RExC_parse++;       /* Skip past the '{' */
9807
9808     if (! (endbrace = strchr(RExC_parse, '}')) /* no trailing brace */
9809         || ! (endbrace == RExC_parse            /* nothing between the {} */
9810               || (endbrace - RExC_parse >= 2    /* U+ (bad hex is checked below */
9811                   && strnEQ(RExC_parse, "U+", 2)))) /* for a better error msg) */
9812     {
9813         if (endbrace) RExC_parse = endbrace;    /* position msg's '<--HERE' */
9814         vFAIL("\\N{NAME} must be resolved by the lexer");
9815     }
9816
9817     if (endbrace == RExC_parse) {   /* empty: \N{} */
9818         bool ret = TRUE;
9819         if (node_p) {
9820             *node_p = reg_node(pRExC_state,NOTHING);
9821         }
9822         else if (in_char_class) {
9823             if (SIZE_ONLY && in_char_class) {
9824                 if (strict) {
9825                     RExC_parse++;   /* Position after the "}" */
9826                     vFAIL("Zero length \\N{}");
9827                 }
9828                 else {
9829                     ckWARNreg(RExC_parse,
9830                               "Ignoring zero length \\N{} in character class");
9831                 }
9832             }
9833             ret = FALSE;
9834         }
9835         else {
9836             return FALSE;
9837         }
9838         nextchar(pRExC_state);
9839         return ret;
9840     }
9841
9842     RExC_uni_semantics = 1; /* Unicode named chars imply Unicode semantics */
9843     RExC_parse += 2;    /* Skip past the 'U+' */
9844
9845     endchar = RExC_parse + strcspn(RExC_parse, ".}");
9846
9847     /* Code points are separated by dots.  If none, there is only one code
9848      * point, and is terminated by the brace */
9849     has_multiple_chars = (endchar < endbrace);
9850
9851     if (valuep && (! has_multiple_chars || in_char_class)) {
9852         /* We only pay attention to the first char of
9853         multichar strings being returned in char classes. I kinda wonder
9854         if this makes sense as it does change the behaviour
9855         from earlier versions, OTOH that behaviour was broken
9856         as well. XXX Solution is to recharacterize as
9857         [rest-of-class]|multi1|multi2... */
9858
9859         STRLEN length_of_hex = (STRLEN)(endchar - RExC_parse);
9860         I32 grok_hex_flags = PERL_SCAN_ALLOW_UNDERSCORES
9861             | PERL_SCAN_DISALLOW_PREFIX
9862             | (SIZE_ONLY ? PERL_SCAN_SILENT_ILLDIGIT : 0);
9863
9864         *valuep = grok_hex(RExC_parse, &length_of_hex, &grok_hex_flags, NULL);
9865
9866         /* The tokenizer should have guaranteed validity, but it's possible to
9867          * bypass it by using single quoting, so check */
9868         if (length_of_hex == 0
9869             || length_of_hex != (STRLEN)(endchar - RExC_parse) )
9870         {
9871             RExC_parse += length_of_hex;        /* Includes all the valid */
9872             RExC_parse += (RExC_orig_utf8)      /* point to after 1st invalid */
9873                             ? UTF8SKIP(RExC_parse)
9874                             : 1;
9875             /* Guard against malformed utf8 */
9876             if (RExC_parse >= endchar) {
9877                 RExC_parse = endchar;
9878             }
9879             vFAIL("Invalid hexadecimal number in \\N{U+...}");
9880         }
9881
9882         if (in_char_class && has_multiple_chars) {
9883             if (strict) {
9884                 RExC_parse = endbrace;
9885                 vFAIL("\\N{} in character class restricted to one character");
9886             }
9887             else {
9888                 ckWARNreg(endchar, "Using just the first character returned by \\N{} in character class");
9889             }
9890         }
9891
9892         RExC_parse = endbrace + 1;
9893     }
9894     else if (! node_p || ! has_multiple_chars) {
9895
9896         /* Here, the input is legal, but not according to the caller's
9897          * options.  We fail without advancing the parse, so that the
9898          * caller can try again */
9899         RExC_parse = p;
9900         return FALSE;
9901     }
9902     else {
9903
9904         /* What is done here is to convert this to a sub-pattern of the form
9905          * (?:\x{char1}\x{char2}...)
9906          * and then call reg recursively.  That way, it retains its atomicness,
9907          * while not having to worry about special handling that some code
9908          * points may have.  toke.c has converted the original Unicode values
9909          * to native, so that we can just pass on the hex values unchanged.  We
9910          * do have to set a flag to keep recoding from happening in the
9911          * recursion */
9912
9913         SV * substitute_parse = newSVpvn_flags("?:", 2, SVf_UTF8|SVs_TEMP);
9914         STRLEN len;
9915         char *orig_end = RExC_end;
9916         I32 flags;
9917
9918         while (RExC_parse < endbrace) {
9919
9920             /* Convert to notation the rest of the code understands */
9921             sv_catpv(substitute_parse, "\\x{");
9922             sv_catpvn(substitute_parse, RExC_parse, endchar - RExC_parse);
9923             sv_catpv(substitute_parse, "}");
9924
9925             /* Point to the beginning of the next character in the sequence. */
9926             RExC_parse = endchar + 1;
9927             endchar = RExC_parse + strcspn(RExC_parse, ".}");
9928         }
9929         sv_catpv(substitute_parse, ")");
9930
9931         RExC_parse = SvPV(substitute_parse, len);
9932
9933         /* Don't allow empty number */
9934         if (len < 8) {
9935             vFAIL("Invalid hexadecimal number in \\N{U+...}");
9936         }
9937         RExC_end = RExC_parse + len;
9938
9939         /* The values are Unicode, and therefore not subject to recoding */
9940         RExC_override_recoding = 1;
9941
9942         if (!(*node_p = reg(pRExC_state, 1, &flags, depth+1))) {
9943             if (flags & RESTART_UTF8) {
9944                 *flagp = RESTART_UTF8;
9945                 return FALSE;
9946             }
9947             FAIL2("panic: reg returned NULL to grok_bslash_N, flags=%#X",
9948                   flags);
9949         } 
9950         *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
9951
9952         RExC_parse = endbrace;
9953         RExC_end = orig_end;
9954         RExC_override_recoding = 0;
9955
9956         nextchar(pRExC_state);
9957     }
9958
9959     return TRUE;
9960 }
9961
9962
9963 /*
9964  * reg_recode
9965  *
9966  * It returns the code point in utf8 for the value in *encp.
9967  *    value: a code value in the source encoding
9968  *    encp:  a pointer to an Encode object
9969  *
9970  * If the result from Encode is not a single character,
9971  * it returns U+FFFD (Replacement character) and sets *encp to NULL.
9972  */
9973 STATIC UV
9974 S_reg_recode(pTHX_ const char value, SV **encp)
9975 {
9976     STRLEN numlen = 1;
9977     SV * const sv = newSVpvn_flags(&value, numlen, SVs_TEMP);
9978     const char * const s = *encp ? sv_recode_to_utf8(sv, *encp) : SvPVX(sv);
9979     const STRLEN newlen = SvCUR(sv);
9980     UV uv = UNICODE_REPLACEMENT;
9981
9982     PERL_ARGS_ASSERT_REG_RECODE;
9983
9984     if (newlen)
9985         uv = SvUTF8(sv)
9986              ? utf8n_to_uvchr((U8*)s, newlen, &numlen, UTF8_ALLOW_DEFAULT)
9987              : *(U8*)s;
9988
9989     if (!newlen || numlen != newlen) {
9990         uv = UNICODE_REPLACEMENT;
9991         *encp = NULL;
9992     }
9993     return uv;
9994 }
9995
9996 PERL_STATIC_INLINE U8
9997 S_compute_EXACTish(pTHX_ RExC_state_t *pRExC_state)
9998 {
9999     U8 op;
10000
10001     PERL_ARGS_ASSERT_COMPUTE_EXACTISH;
10002
10003     if (! FOLD) {
10004         return EXACT;
10005     }
10006
10007     op = get_regex_charset(RExC_flags);
10008     if (op >= REGEX_ASCII_RESTRICTED_CHARSET) {
10009         op--; /* /a is same as /u, and map /aa's offset to what /a's would have
10010                  been, so there is no hole */
10011     }
10012
10013     return op + EXACTF;
10014 }
10015
10016 PERL_STATIC_INLINE void
10017 S_alloc_maybe_populate_EXACT(pTHX_ RExC_state_t *pRExC_state, regnode *node, I32* flagp, STRLEN len, UV code_point)
10018 {
10019     /* This knows the details about sizing an EXACTish node, setting flags for
10020      * it (by setting <*flagp>, and potentially populating it with a single
10021      * character.
10022      *
10023      * If <len> (the length in bytes) is non-zero, this function assumes that
10024      * the node has already been populated, and just does the sizing.  In this
10025      * case <code_point> should be the final code point that has already been
10026      * placed into the node.  This value will be ignored except that under some
10027      * circumstances <*flagp> is set based on it.
10028      *
10029      * If <len> is zero, the function assumes that the node is to contain only
10030      * the single character given by <code_point> and calculates what <len>
10031      * should be.  In pass 1, it sizes the node appropriately.  In pass 2, it
10032      * additionally will populate the node's STRING with <code_point>, if <len>
10033      * is 0.  In both cases <*flagp> is appropriately set
10034      *
10035      * It knows that under FOLD, UTF characters and the Latin Sharp S must be
10036      * folded (the latter only when the rules indicate it can match 'ss') */
10037
10038     bool len_passed_in = cBOOL(len != 0);
10039     U8 character[UTF8_MAXBYTES_CASE+1];
10040
10041     PERL_ARGS_ASSERT_ALLOC_MAYBE_POPULATE_EXACT;
10042
10043     if (! len_passed_in) {
10044         if (UTF) {
10045             if (FOLD) {
10046                 to_uni_fold(NATIVE_TO_UNI(code_point), character, &len);
10047             }
10048             else {
10049                 uvchr_to_utf8( character, code_point);
10050                 len = UTF8SKIP(character);
10051             }
10052         }
10053         else if (! FOLD
10054                  || code_point != LATIN_SMALL_LETTER_SHARP_S
10055                  || ASCII_FOLD_RESTRICTED
10056                  || ! AT_LEAST_UNI_SEMANTICS)
10057         {
10058             *character = (U8) code_point;
10059             len = 1;
10060         }
10061         else {
10062             *character = 's';
10063             *(character + 1) = 's';
10064             len = 2;
10065         }
10066     }
10067
10068     if (SIZE_ONLY) {
10069         RExC_size += STR_SZ(len);
10070     }
10071     else {
10072         RExC_emit += STR_SZ(len);
10073         STR_LEN(node) = len;
10074         if (! len_passed_in) {
10075             Copy((char *) character, STRING(node), len, char);
10076         }
10077     }
10078
10079     *flagp |= HASWIDTH;
10080
10081     /* A single character node is SIMPLE, except for the special-cased SHARP S
10082      * under /di. */
10083     if ((len == 1 || (UTF && len == UNISKIP(code_point)))
10084         && (code_point != LATIN_SMALL_LETTER_SHARP_S
10085             || ! FOLD || ! DEPENDS_SEMANTICS))
10086     {
10087         *flagp |= SIMPLE;
10088     }
10089 }
10090
10091 /*
10092  - regatom - the lowest level
10093
10094    Try to identify anything special at the start of the pattern. If there
10095    is, then handle it as required. This may involve generating a single regop,
10096    such as for an assertion; or it may involve recursing, such as to
10097    handle a () structure.
10098
10099    If the string doesn't start with something special then we gobble up
10100    as much literal text as we can.
10101
10102    Once we have been able to handle whatever type of thing started the
10103    sequence, we return.
10104
10105    Note: we have to be careful with escapes, as they can be both literal
10106    and special, and in the case of \10 and friends, context determines which.
10107
10108    A summary of the code structure is:
10109
10110    switch (first_byte) {
10111         cases for each special:
10112             handle this special;
10113             break;
10114         case '\\':
10115             switch (2nd byte) {
10116                 cases for each unambiguous special:
10117                     handle this special;
10118                     break;
10119                 cases for each ambigous special/literal:
10120                     disambiguate;
10121                     if (special)  handle here
10122                     else goto defchar;
10123                 default: // unambiguously literal:
10124                     goto defchar;
10125             }
10126         default:  // is a literal char
10127             // FALL THROUGH
10128         defchar:
10129             create EXACTish node for literal;
10130             while (more input and node isn't full) {
10131                 switch (input_byte) {
10132                    cases for each special;
10133                        make sure parse pointer is set so that the next call to
10134                            regatom will see this special first
10135                        goto loopdone; // EXACTish node terminated by prev. char
10136                    default:
10137                        append char to EXACTISH node;
10138                 }
10139                 get next input byte;
10140             }
10141         loopdone:
10142    }
10143    return the generated node;
10144
10145    Specifically there are two separate switches for handling
10146    escape sequences, with the one for handling literal escapes requiring
10147    a dummy entry for all of the special escapes that are actually handled
10148    by the other.
10149
10150    Returns NULL, setting *flagp to TRYAGAIN if reg() returns NULL with
10151    TRYAGAIN.  
10152    Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan needs to be
10153    restarted.
10154    Otherwise does not return NULL.
10155 */
10156
10157 STATIC regnode *
10158 S_regatom(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
10159 {
10160     dVAR;
10161     regnode *ret = NULL;
10162     I32 flags = 0;
10163     char *parse_start = RExC_parse;
10164     U8 op;
10165     int invert = 0;
10166
10167     GET_RE_DEBUG_FLAGS_DECL;
10168
10169     *flagp = WORST;             /* Tentatively. */
10170
10171     DEBUG_PARSE("atom");
10172
10173     PERL_ARGS_ASSERT_REGATOM;
10174
10175 tryagain:
10176     switch ((U8)*RExC_parse) {
10177     case '^':
10178         RExC_seen_zerolen++;
10179         nextchar(pRExC_state);
10180         if (RExC_flags & RXf_PMf_MULTILINE)
10181             ret = reg_node(pRExC_state, MBOL);
10182         else if (RExC_flags & RXf_PMf_SINGLELINE)
10183             ret = reg_node(pRExC_state, SBOL);
10184         else
10185             ret = reg_node(pRExC_state, BOL);
10186         Set_Node_Length(ret, 1); /* MJD */
10187         break;
10188     case '$':
10189         nextchar(pRExC_state);
10190         if (*RExC_parse)
10191             RExC_seen_zerolen++;
10192         if (RExC_flags & RXf_PMf_MULTILINE)
10193             ret = reg_node(pRExC_state, MEOL);
10194         else if (RExC_flags & RXf_PMf_SINGLELINE)
10195             ret = reg_node(pRExC_state, SEOL);
10196         else
10197             ret = reg_node(pRExC_state, EOL);
10198         Set_Node_Length(ret, 1); /* MJD */
10199         break;
10200     case '.':
10201         nextchar(pRExC_state);
10202         if (RExC_flags & RXf_PMf_SINGLELINE)
10203             ret = reg_node(pRExC_state, SANY);
10204         else
10205             ret = reg_node(pRExC_state, REG_ANY);
10206         *flagp |= HASWIDTH|SIMPLE;
10207         RExC_naughty++;
10208         Set_Node_Length(ret, 1); /* MJD */
10209         break;
10210     case '[':
10211     {
10212         char * const oregcomp_parse = ++RExC_parse;
10213         ret = regclass(pRExC_state, flagp,depth+1,
10214                        FALSE, /* means parse the whole char class */
10215                        TRUE, /* allow multi-char folds */
10216                        FALSE, /* don't silence non-portable warnings. */
10217                        NULL);
10218         if (*RExC_parse != ']') {
10219             RExC_parse = oregcomp_parse;
10220             vFAIL("Unmatched [");
10221         }
10222         if (ret == NULL) {
10223             if (*flagp & RESTART_UTF8)
10224                 return NULL;
10225             FAIL2("panic: regclass returned NULL to regatom, flags=%#X",
10226                   *flagp);
10227         }
10228         nextchar(pRExC_state);
10229         Set_Node_Length(ret, RExC_parse - oregcomp_parse + 1); /* MJD */
10230         break;
10231     }
10232     case '(':
10233         nextchar(pRExC_state);
10234         ret = reg(pRExC_state, 1, &flags,depth+1);
10235         if (ret == NULL) {
10236                 if (flags & TRYAGAIN) {
10237                     if (RExC_parse == RExC_end) {
10238                          /* Make parent create an empty node if needed. */
10239                         *flagp |= TRYAGAIN;
10240                         return(NULL);
10241                     }
10242                     goto tryagain;
10243                 }
10244                 if (flags & RESTART_UTF8) {
10245                     *flagp = RESTART_UTF8;
10246                     return NULL;
10247                 }
10248                 FAIL2("panic: reg returned NULL to regatom, flags=%#X", flags);
10249         }
10250         *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
10251         break;
10252     case '|':
10253     case ')':
10254         if (flags & TRYAGAIN) {
10255             *flagp |= TRYAGAIN;
10256             return NULL;
10257         }
10258         vFAIL("Internal urp");
10259                                 /* Supposed to be caught earlier. */
10260         break;
10261     case '{':
10262         if (!regcurly(RExC_parse, FALSE)) {
10263             RExC_parse++;
10264             goto defchar;
10265         }
10266         /* FALL THROUGH */
10267     case '?':
10268     case '+':
10269     case '*':
10270         RExC_parse++;
10271         vFAIL("Quantifier follows nothing");
10272         break;
10273     case '\\':
10274         /* Special Escapes
10275
10276            This switch handles escape sequences that resolve to some kind
10277            of special regop and not to literal text. Escape sequnces that
10278            resolve to literal text are handled below in the switch marked
10279            "Literal Escapes".
10280
10281            Every entry in this switch *must* have a corresponding entry
10282            in the literal escape switch. However, the opposite is not
10283            required, as the default for this switch is to jump to the
10284            literal text handling code.
10285         */
10286         switch ((U8)*++RExC_parse) {
10287             U8 arg;
10288         /* Special Escapes */
10289         case 'A':
10290             RExC_seen_zerolen++;
10291             ret = reg_node(pRExC_state, SBOL);
10292             *flagp |= SIMPLE;
10293             goto finish_meta_pat;
10294         case 'G':
10295             ret = reg_node(pRExC_state, GPOS);
10296             RExC_seen |= REG_SEEN_GPOS;
10297             *flagp |= SIMPLE;
10298             goto finish_meta_pat;
10299         case 'K':
10300             RExC_seen_zerolen++;
10301             ret = reg_node(pRExC_state, KEEPS);
10302             *flagp |= SIMPLE;
10303             /* XXX:dmq : disabling in-place substitution seems to
10304              * be necessary here to avoid cases of memory corruption, as
10305              * with: C<$_="x" x 80; s/x\K/y/> -- rgs
10306              */
10307             RExC_seen |= REG_SEEN_LOOKBEHIND;
10308             goto finish_meta_pat;
10309         case 'Z':
10310             ret = reg_node(pRExC_state, SEOL);
10311             *flagp |= SIMPLE;
10312             RExC_seen_zerolen++;                /* Do not optimize RE away */
10313             goto finish_meta_pat;
10314         case 'z':
10315             ret = reg_node(pRExC_state, EOS);
10316             *flagp |= SIMPLE;
10317             RExC_seen_zerolen++;                /* Do not optimize RE away */
10318             goto finish_meta_pat;
10319         case 'C':
10320             ret = reg_node(pRExC_state, CANY);
10321             RExC_seen |= REG_SEEN_CANY;
10322             *flagp |= HASWIDTH|SIMPLE;
10323             goto finish_meta_pat;
10324         case 'X':
10325             ret = reg_node(pRExC_state, CLUMP);
10326             *flagp |= HASWIDTH;
10327             goto finish_meta_pat;
10328
10329         case 'W':
10330             invert = 1;
10331             /* FALLTHROUGH */
10332         case 'w':
10333             arg = ANYOF_WORDCHAR;
10334             goto join_posix;
10335
10336         case 'b':
10337             RExC_seen_zerolen++;
10338             RExC_seen |= REG_SEEN_LOOKBEHIND;
10339             op = BOUND + get_regex_charset(RExC_flags);
10340             if (op > BOUNDA) {  /* /aa is same as /a */
10341                 op = BOUNDA;
10342             }
10343             ret = reg_node(pRExC_state, op);
10344             FLAGS(ret) = get_regex_charset(RExC_flags);
10345             *flagp |= SIMPLE;
10346             if (! SIZE_ONLY && (U8) *(RExC_parse + 1) == '{') {
10347                 ckWARNdep(RExC_parse, "\"\\b{\" is deprecated; use \"\\b\\{\" or \"\\b[{]\" instead");
10348             }
10349             goto finish_meta_pat;
10350         case 'B':
10351             RExC_seen_zerolen++;
10352             RExC_seen |= REG_SEEN_LOOKBEHIND;
10353             op = NBOUND + get_regex_charset(RExC_flags);
10354             if (op > NBOUNDA) { /* /aa is same as /a */
10355                 op = NBOUNDA;
10356             }
10357             ret = reg_node(pRExC_state, op);
10358             FLAGS(ret) = get_regex_charset(RExC_flags);
10359             *flagp |= SIMPLE;
10360             if (! SIZE_ONLY && (U8) *(RExC_parse + 1) == '{') {
10361                 ckWARNdep(RExC_parse, "\"\\B{\" is deprecated; use \"\\B\\{\" or \"\\B[{]\" instead");
10362             }
10363             goto finish_meta_pat;
10364
10365         case 'D':
10366             invert = 1;
10367             /* FALLTHROUGH */
10368         case 'd':
10369             arg = ANYOF_DIGIT;
10370             goto join_posix;
10371
10372         case 'R':
10373             ret = reg_node(pRExC_state, LNBREAK);
10374             *flagp |= HASWIDTH|SIMPLE;
10375             goto finish_meta_pat;
10376
10377         case 'H':
10378             invert = 1;
10379             /* FALLTHROUGH */
10380         case 'h':
10381             arg = ANYOF_BLANK;
10382             op = POSIXU;
10383             goto join_posix_op_known;
10384
10385         case 'V':
10386             invert = 1;
10387             /* FALLTHROUGH */
10388         case 'v':
10389             arg = ANYOF_VERTWS;
10390             op = POSIXU;
10391             goto join_posix_op_known;
10392
10393         case 'S':
10394             invert = 1;
10395             /* FALLTHROUGH */
10396         case 's':
10397             arg = ANYOF_SPACE;
10398
10399         join_posix:
10400
10401             op = POSIXD + get_regex_charset(RExC_flags);
10402             if (op > POSIXA) {  /* /aa is same as /a */
10403                 op = POSIXA;
10404             }
10405
10406         join_posix_op_known:
10407
10408             if (invert) {
10409                 op += NPOSIXD - POSIXD;
10410             }
10411
10412             ret = reg_node(pRExC_state, op);
10413             if (! SIZE_ONLY) {
10414                 FLAGS(ret) = namedclass_to_classnum(arg);
10415             }
10416
10417             *flagp |= HASWIDTH|SIMPLE;
10418             /* FALL THROUGH */
10419
10420          finish_meta_pat:           
10421             nextchar(pRExC_state);
10422             Set_Node_Length(ret, 2); /* MJD */
10423             break;          
10424         case 'p':
10425         case 'P':
10426             {
10427 #ifdef DEBUGGING
10428                 char* parse_start = RExC_parse - 2;
10429 #endif
10430
10431                 RExC_parse--;
10432
10433                 ret = regclass(pRExC_state, flagp,depth+1,
10434                                TRUE, /* means just parse this element */
10435                                FALSE, /* don't allow multi-char folds */
10436                                FALSE, /* don't silence non-portable warnings.
10437                                          It would be a bug if these returned
10438                                          non-portables */
10439                                NULL);
10440                 /* regclass() can only return RESTART_UTF8 if multi-char folds
10441                    are allowed.  */
10442                 if (!ret)
10443                     FAIL2("panic: regclass returned NULL to regatom, flags=%#X",
10444                           *flagp);
10445
10446                 RExC_parse--;
10447
10448                 Set_Node_Offset(ret, parse_start + 2);
10449                 Set_Node_Cur_Length(ret);
10450                 nextchar(pRExC_state);
10451             }
10452             break;
10453         case 'N': 
10454             /* Handle \N and \N{NAME} with multiple code points here and not
10455              * below because it can be multicharacter. join_exact() will join
10456              * them up later on.  Also this makes sure that things like
10457              * /\N{BLAH}+/ and \N{BLAH} being multi char Just Happen. dmq.
10458              * The options to the grok function call causes it to fail if the
10459              * sequence is just a single code point.  We then go treat it as
10460              * just another character in the current EXACT node, and hence it
10461              * gets uniform treatment with all the other characters.  The
10462              * special treatment for quantifiers is not needed for such single
10463              * character sequences */
10464             ++RExC_parse;
10465             if (! grok_bslash_N(pRExC_state, &ret, NULL, flagp, depth, FALSE,
10466                                 FALSE /* not strict */ )) {
10467                 if (*flagp & RESTART_UTF8)
10468                     return NULL;
10469                 RExC_parse--;
10470                 goto defchar;
10471             }
10472             break;
10473         case 'k':    /* Handle \k<NAME> and \k'NAME' */
10474         parse_named_seq:
10475         {   
10476             char ch= RExC_parse[1];         
10477             if (ch != '<' && ch != '\'' && ch != '{') {
10478                 RExC_parse++;
10479                 vFAIL2("Sequence %.2s... not terminated",parse_start);
10480             } else {
10481                 /* this pretty much dupes the code for (?P=...) in reg(), if
10482                    you change this make sure you change that */
10483                 char* name_start = (RExC_parse += 2);
10484                 U32 num = 0;
10485                 SV *sv_dat = reg_scan_name(pRExC_state,
10486                     SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
10487                 ch= (ch == '<') ? '>' : (ch == '{') ? '}' : '\'';
10488                 if (RExC_parse == name_start || *RExC_parse != ch)
10489                     vFAIL2("Sequence %.3s... not terminated",parse_start);
10490
10491                 if (!SIZE_ONLY) {
10492                     num = add_data( pRExC_state, 1, "S" );
10493                     RExC_rxi->data->data[num]=(void*)sv_dat;
10494                     SvREFCNT_inc_simple_void(sv_dat);
10495                 }
10496
10497                 RExC_sawback = 1;
10498                 ret = reganode(pRExC_state,
10499                                ((! FOLD)
10500                                  ? NREF
10501                                  : (ASCII_FOLD_RESTRICTED)
10502                                    ? NREFFA
10503                                    : (AT_LEAST_UNI_SEMANTICS)
10504                                      ? NREFFU
10505                                      : (LOC)
10506                                        ? NREFFL
10507                                        : NREFF),
10508                                 num);
10509                 *flagp |= HASWIDTH;
10510
10511                 /* override incorrect value set in reganode MJD */
10512                 Set_Node_Offset(ret, parse_start+1);
10513                 Set_Node_Cur_Length(ret); /* MJD */
10514                 nextchar(pRExC_state);
10515
10516             }
10517             break;
10518         }
10519         case 'g': 
10520         case '1': case '2': case '3': case '4':
10521         case '5': case '6': case '7': case '8': case '9':
10522             {
10523                 I32 num;
10524                 bool isg = *RExC_parse == 'g';
10525                 bool isrel = 0; 
10526                 bool hasbrace = 0;
10527                 if (isg) {
10528                     RExC_parse++;
10529                     if (*RExC_parse == '{') {
10530                         RExC_parse++;
10531                         hasbrace = 1;
10532                     }
10533                     if (*RExC_parse == '-') {
10534                         RExC_parse++;
10535                         isrel = 1;
10536                     }
10537                     if (hasbrace && !isDIGIT(*RExC_parse)) {
10538                         if (isrel) RExC_parse--;
10539                         RExC_parse -= 2;                            
10540                         goto parse_named_seq;
10541                 }   }
10542                 num = atoi(RExC_parse);
10543                 if (isg && num == 0)
10544                     vFAIL("Reference to invalid group 0");
10545                 if (isrel) {
10546                     num = RExC_npar - num;
10547                     if (num < 1)
10548                         vFAIL("Reference to nonexistent or unclosed group");
10549                 }
10550                 if (!isg && num > 9 && num >= RExC_npar)
10551                     /* Probably a character specified in octal, e.g. \35 */
10552                     goto defchar;
10553                 else {
10554                     char * const parse_start = RExC_parse - 1; /* MJD */
10555                     while (isDIGIT(*RExC_parse))
10556                         RExC_parse++;
10557                     if (parse_start == RExC_parse - 1) 
10558                         vFAIL("Unterminated \\g... pattern");
10559                     if (hasbrace) {
10560                         if (*RExC_parse != '}') 
10561                             vFAIL("Unterminated \\g{...} pattern");
10562                         RExC_parse++;
10563                     }    
10564                     if (!SIZE_ONLY) {
10565                         if (num > (I32)RExC_rx->nparens)
10566                             vFAIL("Reference to nonexistent group");
10567                     }
10568                     RExC_sawback = 1;
10569                     ret = reganode(pRExC_state,
10570                                    ((! FOLD)
10571                                      ? REF
10572                                      : (ASCII_FOLD_RESTRICTED)
10573                                        ? REFFA
10574                                        : (AT_LEAST_UNI_SEMANTICS)
10575                                          ? REFFU
10576                                          : (LOC)
10577                                            ? REFFL
10578                                            : REFF),
10579                                     num);
10580                     *flagp |= HASWIDTH;
10581
10582                     /* override incorrect value set in reganode MJD */
10583                     Set_Node_Offset(ret, parse_start+1);
10584                     Set_Node_Cur_Length(ret); /* MJD */
10585                     RExC_parse--;
10586                     nextchar(pRExC_state);
10587                 }
10588             }
10589             break;
10590         case '\0':
10591             if (RExC_parse >= RExC_end)
10592                 FAIL("Trailing \\");
10593             /* FALL THROUGH */
10594         default:
10595             /* Do not generate "unrecognized" warnings here, we fall
10596                back into the quick-grab loop below */
10597             parse_start--;
10598             goto defchar;
10599         }
10600         break;
10601
10602     case '#':
10603         if (RExC_flags & RXf_PMf_EXTENDED) {
10604             if ( reg_skipcomment( pRExC_state ) )
10605                 goto tryagain;
10606         }
10607         /* FALL THROUGH */
10608
10609     default:
10610
10611             parse_start = RExC_parse - 1;
10612
10613             RExC_parse++;
10614
10615         defchar: {
10616             STRLEN len = 0;
10617             UV ender;
10618             char *p;
10619             char *s;
10620 #define MAX_NODE_STRING_SIZE 127
10621             char foldbuf[MAX_NODE_STRING_SIZE+UTF8_MAXBYTES_CASE];
10622             char *s0;
10623             U8 upper_parse = MAX_NODE_STRING_SIZE;
10624             STRLEN foldlen;
10625             U8 node_type;
10626             bool next_is_quantifier;
10627             char * oldp = NULL;
10628
10629             /* If a folding node contains only code points that don't
10630              * participate in folds, it can be changed into an EXACT node,
10631              * which allows the optimizer more things to look for */
10632             bool maybe_exact;
10633
10634             ender = 0;
10635             node_type = compute_EXACTish(pRExC_state);
10636             ret = reg_node(pRExC_state, node_type);
10637
10638             /* In pass1, folded, we use a temporary buffer instead of the
10639              * actual node, as the node doesn't exist yet */
10640             s = (SIZE_ONLY && FOLD) ? foldbuf : STRING(ret);
10641
10642             s0 = s;
10643
10644         reparse:
10645
10646             /* We do the EXACTFish to EXACT node only if folding, and not if in
10647              * locale, as whether a character folds or not isn't known until
10648              * runtime */
10649             maybe_exact = FOLD && ! LOC;
10650
10651             /* XXX The node can hold up to 255 bytes, yet this only goes to
10652              * 127.  I (khw) do not know why.  Keeping it somewhat less than
10653              * 255 allows us to not have to worry about overflow due to
10654              * converting to utf8 and fold expansion, but that value is
10655              * 255-UTF8_MAXBYTES_CASE.  join_exact() may join adjacent nodes
10656              * split up by this limit into a single one using the real max of
10657              * 255.  Even at 127, this breaks under rare circumstances.  If
10658              * folding, we do not want to split a node at a character that is a
10659              * non-final in a multi-char fold, as an input string could just
10660              * happen to want to match across the node boundary.  The join
10661              * would solve that problem if the join actually happens.  But a
10662              * series of more than two nodes in a row each of 127 would cause
10663              * the first join to succeed to get to 254, but then there wouldn't
10664              * be room for the next one, which could at be one of those split
10665              * multi-char folds.  I don't know of any fool-proof solution.  One
10666              * could back off to end with only a code point that isn't such a
10667              * non-final, but it is possible for there not to be any in the
10668              * entire node. */
10669             for (p = RExC_parse - 1;
10670                  len < upper_parse && p < RExC_end;
10671                  len++)
10672             {
10673                 oldp = p;
10674
10675                 if (RExC_flags & RXf_PMf_EXTENDED)
10676                     p = regwhite( pRExC_state, p );
10677                 switch ((U8)*p) {
10678                 case '^':
10679                 case '$':
10680                 case '.':
10681                 case '[':
10682                 case '(':
10683                 case ')':
10684                 case '|':
10685                     goto loopdone;
10686                 case '\\':
10687                     /* Literal Escapes Switch
10688
10689                        This switch is meant to handle escape sequences that
10690                        resolve to a literal character.
10691
10692                        Every escape sequence that represents something
10693                        else, like an assertion or a char class, is handled
10694                        in the switch marked 'Special Escapes' above in this
10695                        routine, but also has an entry here as anything that
10696                        isn't explicitly mentioned here will be treated as
10697                        an unescaped equivalent literal.
10698                     */
10699
10700                     switch ((U8)*++p) {
10701                     /* These are all the special escapes. */
10702                     case 'A':             /* Start assertion */
10703                     case 'b': case 'B':   /* Word-boundary assertion*/
10704                     case 'C':             /* Single char !DANGEROUS! */
10705                     case 'd': case 'D':   /* digit class */
10706                     case 'g': case 'G':   /* generic-backref, pos assertion */
10707                     case 'h': case 'H':   /* HORIZWS */
10708                     case 'k': case 'K':   /* named backref, keep marker */
10709                     case 'p': case 'P':   /* Unicode property */
10710                               case 'R':   /* LNBREAK */
10711                     case 's': case 'S':   /* space class */
10712                     case 'v': case 'V':   /* VERTWS */
10713                     case 'w': case 'W':   /* word class */
10714                     case 'X':             /* eXtended Unicode "combining character sequence" */
10715                     case 'z': case 'Z':   /* End of line/string assertion */
10716                         --p;
10717                         goto loopdone;
10718
10719                     /* Anything after here is an escape that resolves to a
10720                        literal. (Except digits, which may or may not)
10721                      */
10722                     case 'n':
10723                         ender = '\n';
10724                         p++;
10725                         break;
10726                     case 'N': /* Handle a single-code point named character. */
10727                         /* The options cause it to fail if a multiple code
10728                          * point sequence.  Handle those in the switch() above
10729                          * */
10730                         RExC_parse = p + 1;
10731                         if (! grok_bslash_N(pRExC_state, NULL, &ender,
10732                                             flagp, depth, FALSE,
10733                                             FALSE /* not strict */ ))
10734                         {
10735                             if (*flagp & RESTART_UTF8)
10736                                 FAIL("panic: grok_bslash_N set RESTART_UTF8");
10737                             RExC_parse = p = oldp;
10738                             goto loopdone;
10739                         }
10740                         p = RExC_parse;
10741                         if (ender > 0xff) {
10742                             REQUIRE_UTF8;
10743                         }
10744                         break;
10745                     case 'r':
10746                         ender = '\r';
10747                         p++;
10748                         break;
10749                     case 't':
10750                         ender = '\t';
10751                         p++;
10752                         break;
10753                     case 'f':
10754                         ender = '\f';
10755                         p++;
10756                         break;
10757                     case 'e':
10758                           ender = ASCII_TO_NATIVE('\033');
10759                         p++;
10760                         break;
10761                     case 'a':
10762                           ender = ASCII_TO_NATIVE('\007');
10763                         p++;
10764                         break;
10765                     case 'o':
10766                         {
10767                             UV result;
10768                             const char* error_msg;
10769
10770                             bool valid = grok_bslash_o(&p,
10771                                                        &result,
10772                                                        &error_msg,
10773                                                        TRUE, /* out warnings */
10774                                                        FALSE, /* not strict */
10775                                                        TRUE, /* Output warnings
10776                                                                 for non-
10777                                                                 portables */
10778                                                        UTF);
10779                             if (! valid) {
10780                                 RExC_parse = p; /* going to die anyway; point
10781                                                    to exact spot of failure */
10782                                 vFAIL(error_msg);
10783                             }
10784                             ender = result;
10785                             if (PL_encoding && ender < 0x100) {
10786                                 goto recode_encoding;
10787                             }
10788                             if (ender > 0xff) {
10789                                 REQUIRE_UTF8;
10790                             }
10791                             break;
10792                         }
10793                     case 'x':
10794                         {
10795                             UV result = UV_MAX; /* initialize to erroneous
10796                                                    value */
10797                             const char* error_msg;
10798
10799                             bool valid = grok_bslash_x(&p,
10800                                                        &result,
10801                                                        &error_msg,
10802                                                        TRUE, /* out warnings */
10803                                                        FALSE, /* not strict */
10804                                                        TRUE, /* Output warnings
10805                                                                 for non-
10806                                                                 portables */
10807                                                        UTF);
10808                             if (! valid) {
10809                                 RExC_parse = p; /* going to die anyway; point
10810                                                    to exact spot of failure */
10811                                 vFAIL(error_msg);
10812                             }
10813                             ender = result;
10814
10815                             if (PL_encoding && ender < 0x100) {
10816                                 goto recode_encoding;
10817                             }
10818                             if (ender > 0xff) {
10819                                 REQUIRE_UTF8;
10820                             }
10821                             break;
10822                         }
10823                     case 'c':
10824                         p++;
10825                         ender = grok_bslash_c(*p++, UTF, SIZE_ONLY);
10826                         break;
10827                     case '0': case '1': case '2': case '3':case '4':
10828                     case '5': case '6': case '7':
10829                         if (*p == '0' ||
10830                             (isDIGIT(p[1]) && atoi(p) >= RExC_npar))
10831                         {
10832                             I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
10833                             STRLEN numlen = 3;
10834                             ender = grok_oct(p, &numlen, &flags, NULL);
10835                             if (ender > 0xff) {
10836                                 REQUIRE_UTF8;
10837                             }
10838                             p += numlen;
10839                             if (SIZE_ONLY   /* like \08, \178 */
10840                                 && numlen < 3
10841                                 && p < RExC_end
10842                                 && isDIGIT(*p) && ckWARN(WARN_REGEXP))
10843                             {
10844                                 reg_warn_non_literal_string(
10845                                          p + 1,
10846                                          form_short_octal_warning(p, numlen));
10847                             }
10848                         }
10849                         else {  /* Not to be treated as an octal constant, go
10850                                    find backref */
10851                             --p;
10852                             goto loopdone;
10853                         }
10854                         if (PL_encoding && ender < 0x100)
10855                             goto recode_encoding;
10856                         break;
10857                     recode_encoding:
10858                         if (! RExC_override_recoding) {
10859                             SV* enc = PL_encoding;
10860                             ender = reg_recode((const char)(U8)ender, &enc);
10861                             if (!enc && SIZE_ONLY)
10862                                 ckWARNreg(p, "Invalid escape in the specified encoding");
10863                             REQUIRE_UTF8;
10864                         }
10865                         break;
10866                     case '\0':
10867                         if (p >= RExC_end)
10868                             FAIL("Trailing \\");
10869                         /* FALL THROUGH */
10870                     default:
10871                         if (!SIZE_ONLY&& isALPHANUMERIC(*p)) {
10872                             /* Include any { following the alpha to emphasize
10873                              * that it could be part of an escape at some point
10874                              * in the future */
10875                             int len = (isALPHA(*p) && *(p + 1) == '{') ? 2 : 1;
10876                             ckWARN3reg(p + len, "Unrecognized escape \\%.*s passed through", len, p);
10877                         }
10878                         goto normal_default;
10879                     } /* End of switch on '\' */
10880                     break;
10881                 default:    /* A literal character */
10882
10883                     if (! SIZE_ONLY
10884                         && RExC_flags & RXf_PMf_EXTENDED
10885                         && ckWARN(WARN_DEPRECATED)
10886                         && is_PATWS_non_low(p, UTF))
10887                     {
10888                         vWARN_dep(p + ((UTF) ? UTF8SKIP(p) : 1),
10889                                 "Escape literal pattern white space under /x");
10890                     }
10891
10892                   normal_default:
10893                     if (UTF8_IS_START(*p) && UTF) {
10894                         STRLEN numlen;
10895                         ender = utf8n_to_uvchr((U8*)p, RExC_end - p,
10896                                                &numlen, UTF8_ALLOW_DEFAULT);
10897                         p += numlen;
10898                     }
10899                     else
10900                         ender = (U8) *p++;
10901                     break;
10902                 } /* End of switch on the literal */
10903
10904                 /* Here, have looked at the literal character and <ender>
10905                  * contains its ordinal, <p> points to the character after it
10906                  */
10907
10908                 if ( RExC_flags & RXf_PMf_EXTENDED)
10909                     p = regwhite( pRExC_state, p );
10910
10911                 /* If the next thing is a quantifier, it applies to this
10912                  * character only, which means that this character has to be in
10913                  * its own node and can't just be appended to the string in an
10914                  * existing node, so if there are already other characters in
10915                  * the node, close the node with just them, and set up to do
10916                  * this character again next time through, when it will be the
10917                  * only thing in its new node */
10918                 if ((next_is_quantifier = (p < RExC_end && ISMULT2(p))) && len)
10919                 {
10920                     p = oldp;
10921                     goto loopdone;
10922                 }
10923
10924                 if (FOLD) {
10925                     if (UTF
10926                             /* See comments for join_exact() as to why we fold
10927                              * this non-UTF at compile time */
10928                         || (node_type == EXACTFU
10929                             && ender == LATIN_SMALL_LETTER_SHARP_S))
10930                     {
10931
10932
10933                         /* Prime the casefolded buffer.  Locale rules, which
10934                          * apply only to code points < 256, aren't known until
10935                          * execution, so for them, just output the original
10936                          * character using utf8.  If we start to fold non-UTF
10937                          * patterns, be sure to update join_exact() */
10938                         if (LOC && ender < 256) {
10939                             if (UNI_IS_INVARIANT(ender)) {
10940                                 *s = (U8) ender;
10941                                 foldlen = 1;
10942                             } else {
10943                                 *s = UTF8_TWO_BYTE_HI(ender);
10944                                 *(s + 1) = UTF8_TWO_BYTE_LO(ender);
10945                                 foldlen = 2;
10946                             }
10947                         }
10948                         else {
10949                             UV folded = _to_uni_fold_flags(
10950                                            ender,
10951                                            (U8 *) s,
10952                                            &foldlen,
10953                                            FOLD_FLAGS_FULL
10954                                            | ((LOC) ?  FOLD_FLAGS_LOCALE
10955                                                     : (ASCII_FOLD_RESTRICTED)
10956                                                       ? FOLD_FLAGS_NOMIX_ASCII
10957                                                       : 0)
10958                                             );
10959
10960                             /* If this node only contains non-folding code
10961                              * points so far, see if this new one is also
10962                              * non-folding */
10963                             if (maybe_exact) {
10964                                 if (folded != ender) {
10965                                     maybe_exact = FALSE;
10966                                 }
10967                                 else {
10968                                     /* Here the fold is the original; we have
10969                                      * to check further to see if anything
10970                                      * folds to it */
10971                                     if (! PL_utf8_foldable) {
10972                                         SV* swash = swash_init("utf8",
10973                                                            "_Perl_Any_Folds",
10974                                                            &PL_sv_undef, 1, 0);
10975                                         PL_utf8_foldable =
10976                                                     _get_swash_invlist(swash);
10977                                         SvREFCNT_dec_NN(swash);
10978                                     }
10979                                     if (_invlist_contains_cp(PL_utf8_foldable,
10980                                                              ender))
10981                                     {
10982                                         maybe_exact = FALSE;
10983                                     }
10984                                 }
10985                             }
10986                             ender = folded;
10987                         }
10988                         s += foldlen;
10989
10990                         /* The loop increments <len> each time, as all but this
10991                          * path (and the one just below for UTF) through it add
10992                          * a single byte to the EXACTish node.  But this one
10993                          * has changed len to be the correct final value, so
10994                          * subtract one to cancel out the increment that
10995                          * follows */
10996                         len += foldlen - 1;
10997                     }
10998                     else {
10999                         *(s++) = (char) ender;
11000                         maybe_exact &= ! IS_IN_SOME_FOLD_L1(ender);
11001                     }
11002                 }
11003                 else if (UTF) {
11004                     const STRLEN unilen = reguni(pRExC_state, ender, s);
11005                     if (unilen > 0) {
11006                        s   += unilen;
11007                        len += unilen;
11008                     }
11009
11010                     /* See comment just above for - 1 */
11011                     len--;
11012                 }
11013                 else {
11014                     REGC((char)ender, s++);
11015                 }
11016
11017                 if (next_is_quantifier) {
11018
11019                     /* Here, the next input is a quantifier, and to get here,
11020                      * the current character is the only one in the node.
11021                      * Also, here <len> doesn't include the final byte for this
11022                      * character */
11023                     len++;
11024                     goto loopdone;
11025                 }
11026
11027             } /* End of loop through literal characters */
11028
11029             /* Here we have either exhausted the input or ran out of room in
11030              * the node.  (If we encountered a character that can't be in the
11031              * node, transfer is made directly to <loopdone>, and so we
11032              * wouldn't have fallen off the end of the loop.)  In the latter
11033              * case, we artificially have to split the node into two, because
11034              * we just don't have enough space to hold everything.  This
11035              * creates a problem if the final character participates in a
11036              * multi-character fold in the non-final position, as a match that
11037              * should have occurred won't, due to the way nodes are matched,
11038              * and our artificial boundary.  So back off until we find a non-
11039              * problematic character -- one that isn't at the beginning or
11040              * middle of such a fold.  (Either it doesn't participate in any
11041              * folds, or appears only in the final position of all the folds it
11042              * does participate in.)  A better solution with far fewer false
11043              * positives, and that would fill the nodes more completely, would
11044              * be to actually have available all the multi-character folds to
11045              * test against, and to back-off only far enough to be sure that
11046              * this node isn't ending with a partial one.  <upper_parse> is set
11047              * further below (if we need to reparse the node) to include just
11048              * up through that final non-problematic character that this code
11049              * identifies, so when it is set to less than the full node, we can
11050              * skip the rest of this */
11051             if (FOLD && p < RExC_end && upper_parse == MAX_NODE_STRING_SIZE) {
11052
11053                 const STRLEN full_len = len;
11054
11055                 assert(len >= MAX_NODE_STRING_SIZE);
11056
11057                 /* Here, <s> points to the final byte of the final character.
11058                  * Look backwards through the string until find a non-
11059                  * problematic character */
11060
11061                 if (! UTF) {
11062
11063                     /* These two have no multi-char folds to non-UTF characters
11064                      */
11065                     if (ASCII_FOLD_RESTRICTED || LOC) {
11066                         goto loopdone;
11067                     }
11068
11069                     while (--s >= s0 && IS_NON_FINAL_FOLD(*s)) { }
11070                     len = s - s0 + 1;
11071                 }
11072                 else {
11073                     if (!  PL_NonL1NonFinalFold) {
11074                         PL_NonL1NonFinalFold = _new_invlist_C_array(
11075                                         NonL1_Perl_Non_Final_Folds_invlist);
11076                     }
11077
11078                     /* Point to the first byte of the final character */
11079                     s = (char *) utf8_hop((U8 *) s, -1);
11080
11081                     while (s >= s0) {   /* Search backwards until find
11082                                            non-problematic char */
11083                         if (UTF8_IS_INVARIANT(*s)) {
11084
11085                             /* There are no ascii characters that participate
11086                              * in multi-char folds under /aa.  In EBCDIC, the
11087                              * non-ascii invariants are all control characters,
11088                              * so don't ever participate in any folds. */
11089                             if (ASCII_FOLD_RESTRICTED
11090                                 || ! IS_NON_FINAL_FOLD(*s))
11091                             {
11092                                 break;
11093                             }
11094                         }
11095                         else if (UTF8_IS_DOWNGRADEABLE_START(*s)) {
11096
11097                             /* No Latin1 characters participate in multi-char
11098                              * folds under /l */
11099                             if (LOC
11100                                 || ! IS_NON_FINAL_FOLD(TWO_BYTE_UTF8_TO_UNI(
11101                                                                 *s, *(s+1))))
11102                             {
11103                                 break;
11104                             }
11105                         }
11106                         else if (! _invlist_contains_cp(
11107                                         PL_NonL1NonFinalFold,
11108                                         valid_utf8_to_uvchr((U8 *) s, NULL)))
11109                         {
11110                             break;
11111                         }
11112
11113                         /* Here, the current character is problematic in that
11114                          * it does occur in the non-final position of some
11115                          * fold, so try the character before it, but have to
11116                          * special case the very first byte in the string, so
11117                          * we don't read outside the string */
11118                         s = (s == s0) ? s -1 : (char *) utf8_hop((U8 *) s, -1);
11119                     } /* End of loop backwards through the string */
11120
11121                     /* If there were only problematic characters in the string,
11122                      * <s> will point to before s0, in which case the length
11123                      * should be 0, otherwise include the length of the
11124                      * non-problematic character just found */
11125                     len = (s < s0) ? 0 : s - s0 + UTF8SKIP(s);
11126                 }
11127
11128                 /* Here, have found the final character, if any, that is
11129                  * non-problematic as far as ending the node without splitting
11130                  * it across a potential multi-char fold.  <len> contains the
11131                  * number of bytes in the node up-to and including that
11132                  * character, or is 0 if there is no such character, meaning
11133                  * the whole node contains only problematic characters.  In
11134                  * this case, give up and just take the node as-is.  We can't
11135                  * do any better */
11136                 if (len == 0) {
11137                     len = full_len;
11138                 } else {
11139
11140                     /* Here, the node does contain some characters that aren't
11141                      * problematic.  If one such is the final character in the
11142                      * node, we are done */
11143                     if (len == full_len) {
11144                         goto loopdone;
11145                     }
11146                     else if (len + ((UTF) ? UTF8SKIP(s) : 1) == full_len) {
11147
11148                         /* If the final character is problematic, but the
11149                          * penultimate is not, back-off that last character to
11150                          * later start a new node with it */
11151                         p = oldp;
11152                         goto loopdone;
11153                     }
11154
11155                     /* Here, the final non-problematic character is earlier
11156                      * in the input than the penultimate character.  What we do
11157                      * is reparse from the beginning, going up only as far as
11158                      * this final ok one, thus guaranteeing that the node ends
11159                      * in an acceptable character.  The reason we reparse is
11160                      * that we know how far in the character is, but we don't
11161                      * know how to correlate its position with the input parse.
11162                      * An alternate implementation would be to build that
11163                      * correlation as we go along during the original parse,
11164                      * but that would entail extra work for every node, whereas
11165                      * this code gets executed only when the string is too
11166                      * large for the node, and the final two characters are
11167                      * problematic, an infrequent occurrence.  Yet another
11168                      * possible strategy would be to save the tail of the
11169                      * string, and the next time regatom is called, initialize
11170                      * with that.  The problem with this is that unless you
11171                      * back off one more character, you won't be guaranteed
11172                      * regatom will get called again, unless regbranch,
11173                      * regpiece ... are also changed.  If you do back off that
11174                      * extra character, so that there is input guaranteed to
11175                      * force calling regatom, you can't handle the case where
11176                      * just the first character in the node is acceptable.  I
11177                      * (khw) decided to try this method which doesn't have that
11178                      * pitfall; if performance issues are found, we can do a
11179                      * combination of the current approach plus that one */
11180                     upper_parse = len;
11181                     len = 0;
11182                     s = s0;
11183                     goto reparse;
11184                 }
11185             }   /* End of verifying node ends with an appropriate char */
11186
11187         loopdone:   /* Jumped to when encounters something that shouldn't be in
11188                        the node */
11189
11190             /* If 'maybe_exact' is still set here, means there are no
11191              * code points in the node that participate in folds */
11192             if (FOLD && maybe_exact) {
11193                 OP(ret) = EXACT;
11194             }
11195
11196             /* I (khw) don't know if you can get here with zero length, but the
11197              * old code handled this situation by creating a zero-length EXACT
11198              * node.  Might as well be NOTHING instead */
11199             if (len == 0) {
11200                 OP(ret) = NOTHING;
11201             }
11202             else{
11203                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, len, ender);
11204             }
11205
11206             RExC_parse = p - 1;
11207             Set_Node_Cur_Length(ret); /* MJD */
11208             nextchar(pRExC_state);
11209             {
11210                 /* len is STRLEN which is unsigned, need to copy to signed */
11211                 IV iv = len;
11212                 if (iv < 0)
11213                     vFAIL("Internal disaster");
11214             }
11215
11216         } /* End of label 'defchar:' */
11217         break;
11218     } /* End of giant switch on input character */
11219
11220     return(ret);
11221 }
11222
11223 STATIC char *
11224 S_regwhite( RExC_state_t *pRExC_state, char *p )
11225 {
11226     const char *e = RExC_end;
11227
11228     PERL_ARGS_ASSERT_REGWHITE;
11229
11230     while (p < e) {
11231         if (isSPACE(*p))
11232             ++p;
11233         else if (*p == '#') {
11234             bool ended = 0;
11235             do {
11236                 if (*p++ == '\n') {
11237                     ended = 1;
11238                     break;
11239                 }
11240             } while (p < e);
11241             if (!ended)
11242                 RExC_seen |= REG_SEEN_RUN_ON_COMMENT;
11243         }
11244         else
11245             break;
11246     }
11247     return p;
11248 }
11249
11250 STATIC char *
11251 S_regpatws( RExC_state_t *pRExC_state, char *p , const bool recognize_comment )
11252 {
11253     /* Returns the next non-pattern-white space, non-comment character (the
11254      * latter only if 'recognize_comment is true) in the string p, which is
11255      * ended by RExC_end.  If there is no line break ending a comment,
11256      * RExC_seen has added the REG_SEEN_RUN_ON_COMMENT flag; */
11257     const char *e = RExC_end;
11258
11259     PERL_ARGS_ASSERT_REGPATWS;
11260
11261     while (p < e) {
11262         STRLEN len;
11263         if ((len = is_PATWS_safe(p, e, UTF))) {
11264             p += len;
11265         }
11266         else if (recognize_comment && *p == '#') {
11267             bool ended = 0;
11268             do {
11269                 p++;
11270                 if (is_LNBREAK_safe(p, e, UTF)) {
11271                     ended = 1;
11272                     break;
11273                 }
11274             } while (p < e);
11275             if (!ended)
11276                 RExC_seen |= REG_SEEN_RUN_ON_COMMENT;
11277         }
11278         else
11279             break;
11280     }
11281     return p;
11282 }
11283
11284 /* Parse POSIX character classes: [[:foo:]], [[=foo=]], [[.foo.]].
11285    Character classes ([:foo:]) can also be negated ([:^foo:]).
11286    Returns a named class id (ANYOF_XXX) if successful, -1 otherwise.
11287    Equivalence classes ([=foo=]) and composites ([.foo.]) are parsed,
11288    but trigger failures because they are currently unimplemented. */
11289
11290 #define POSIXCC_DONE(c)   ((c) == ':')
11291 #define POSIXCC_NOTYET(c) ((c) == '=' || (c) == '.')
11292 #define POSIXCC(c) (POSIXCC_DONE(c) || POSIXCC_NOTYET(c))
11293
11294 PERL_STATIC_INLINE I32
11295 S_regpposixcc(pTHX_ RExC_state_t *pRExC_state, I32 value, const bool strict)
11296 {
11297     dVAR;
11298     I32 namedclass = OOB_NAMEDCLASS;
11299
11300     PERL_ARGS_ASSERT_REGPPOSIXCC;
11301
11302     if (value == '[' && RExC_parse + 1 < RExC_end &&
11303         /* I smell either [: or [= or [. -- POSIX has been here, right? */
11304         POSIXCC(UCHARAT(RExC_parse)))
11305     {
11306         const char c = UCHARAT(RExC_parse);
11307         char* const s = RExC_parse++;
11308
11309         while (RExC_parse < RExC_end && UCHARAT(RExC_parse) != c)
11310             RExC_parse++;
11311         if (RExC_parse == RExC_end) {
11312             if (strict) {
11313
11314                 /* Try to give a better location for the error (than the end of
11315                  * the string) by looking for the matching ']' */
11316                 RExC_parse = s;
11317                 while (RExC_parse < RExC_end && UCHARAT(RExC_parse) != ']') {
11318                     RExC_parse++;
11319                 }
11320                 vFAIL2("Unmatched '%c' in POSIX class", c);
11321             }
11322             /* Grandfather lone [:, [=, [. */
11323             RExC_parse = s;
11324         }
11325         else {
11326             const char* const t = RExC_parse++; /* skip over the c */
11327             assert(*t == c);
11328
11329             if (UCHARAT(RExC_parse) == ']') {
11330                 const char *posixcc = s + 1;
11331                 RExC_parse++; /* skip over the ending ] */
11332
11333                 if (*s == ':') {
11334                     const I32 complement = *posixcc == '^' ? *posixcc++ : 0;
11335                     const I32 skip = t - posixcc;
11336
11337                     /* Initially switch on the length of the name.  */
11338                     switch (skip) {
11339                     case 4:
11340                         if (memEQ(posixcc, "word", 4)) /* this is not POSIX,
11341                                                           this is the Perl \w
11342                                                         */
11343                             namedclass = ANYOF_WORDCHAR;
11344                         break;
11345                     case 5:
11346                         /* Names all of length 5.  */
11347                         /* alnum alpha ascii blank cntrl digit graph lower
11348                            print punct space upper  */
11349                         /* Offset 4 gives the best switch position.  */
11350                         switch (posixcc[4]) {
11351                         case 'a':
11352                             if (memEQ(posixcc, "alph", 4)) /* alpha */
11353                                 namedclass = ANYOF_ALPHA;
11354                             break;
11355                         case 'e':
11356                             if (memEQ(posixcc, "spac", 4)) /* space */
11357                                 namedclass = ANYOF_PSXSPC;
11358                             break;
11359                         case 'h':
11360                             if (memEQ(posixcc, "grap", 4)) /* graph */
11361                                 namedclass = ANYOF_GRAPH;
11362                             break;
11363                         case 'i':
11364                             if (memEQ(posixcc, "asci", 4)) /* ascii */
11365                                 namedclass = ANYOF_ASCII;
11366                             break;
11367                         case 'k':
11368                             if (memEQ(posixcc, "blan", 4)) /* blank */
11369                                 namedclass = ANYOF_BLANK;
11370                             break;
11371                         case 'l':
11372                             if (memEQ(posixcc, "cntr", 4)) /* cntrl */
11373                                 namedclass = ANYOF_CNTRL;
11374                             break;
11375                         case 'm':
11376                             if (memEQ(posixcc, "alnu", 4)) /* alnum */
11377                                 namedclass = ANYOF_ALPHANUMERIC;
11378                             break;
11379                         case 'r':
11380                             if (memEQ(posixcc, "lowe", 4)) /* lower */
11381                                 namedclass = (FOLD) ? ANYOF_CASED : ANYOF_LOWER;
11382                             else if (memEQ(posixcc, "uppe", 4)) /* upper */
11383                                 namedclass = (FOLD) ? ANYOF_CASED : ANYOF_UPPER;
11384                             break;
11385                         case 't':
11386                             if (memEQ(posixcc, "digi", 4)) /* digit */
11387                                 namedclass = ANYOF_DIGIT;
11388                             else if (memEQ(posixcc, "prin", 4)) /* print */
11389                                 namedclass = ANYOF_PRINT;
11390                             else if (memEQ(posixcc, "punc", 4)) /* punct */
11391                                 namedclass = ANYOF_PUNCT;
11392                             break;
11393                         }
11394                         break;
11395                     case 6:
11396                         if (memEQ(posixcc, "xdigit", 6))
11397                             namedclass = ANYOF_XDIGIT;
11398                         break;
11399                     }
11400
11401                     if (namedclass == OOB_NAMEDCLASS)
11402                         Simple_vFAIL3("POSIX class [:%.*s:] unknown",
11403                                       t - s - 1, s + 1);
11404
11405                     /* The #defines are structured so each complement is +1 to
11406                      * the normal one */
11407                     if (complement) {
11408                         namedclass++;
11409                     }
11410                     assert (posixcc[skip] == ':');
11411                     assert (posixcc[skip+1] == ']');
11412                 } else if (!SIZE_ONLY) {
11413                     /* [[=foo=]] and [[.foo.]] are still future. */
11414
11415                     /* adjust RExC_parse so the warning shows after
11416                        the class closes */
11417                     while (UCHARAT(RExC_parse) && UCHARAT(RExC_parse) != ']')
11418                         RExC_parse++;
11419                     vFAIL3("POSIX syntax [%c %c] is reserved for future extensions", c, c);
11420                 }
11421             } else {
11422                 /* Maternal grandfather:
11423                  * "[:" ending in ":" but not in ":]" */
11424                 if (strict) {
11425                     vFAIL("Unmatched '[' in POSIX class");
11426                 }
11427
11428                 /* Grandfather lone [:, [=, [. */
11429                 RExC_parse = s;
11430             }
11431         }
11432     }
11433
11434     return namedclass;
11435 }
11436
11437 STATIC bool
11438 S_could_it_be_a_POSIX_class(pTHX_ RExC_state_t *pRExC_state)
11439 {
11440     /* This applies some heuristics at the current parse position (which should
11441      * be at a '[') to see if what follows might be intended to be a [:posix:]
11442      * class.  It returns true if it really is a posix class, of course, but it
11443      * also can return true if it thinks that what was intended was a posix
11444      * class that didn't quite make it.
11445      *
11446      * It will return true for
11447      *      [:alphanumerics:
11448      *      [:alphanumerics]  (as long as the ] isn't followed immediately by a
11449      *                         ')' indicating the end of the (?[
11450      *      [:any garbage including %^&$ punctuation:]
11451      *
11452      * This is designed to be called only from S_handle_regex_sets; it could be
11453      * easily adapted to be called from the spot at the beginning of regclass()
11454      * that checks to see in a normal bracketed class if the surrounding []
11455      * have been omitted ([:word:] instead of [[:word:]]).  But doing so would
11456      * change long-standing behavior, so I (khw) didn't do that */
11457     char* p = RExC_parse + 1;
11458     char first_char = *p;
11459
11460     PERL_ARGS_ASSERT_COULD_IT_BE_A_POSIX_CLASS;
11461
11462     assert(*(p - 1) == '[');
11463
11464     if (! POSIXCC(first_char)) {
11465         return FALSE;
11466     }
11467
11468     p++;
11469     while (p < RExC_end && isWORDCHAR(*p)) p++;
11470
11471     if (p >= RExC_end) {
11472         return FALSE;
11473     }
11474
11475     if (p - RExC_parse > 2    /* Got at least 1 word character */
11476         && (*p == first_char
11477             || (*p == ']' && p + 1 < RExC_end && *(p + 1) != ')')))
11478     {
11479         return TRUE;
11480     }
11481
11482     p = (char *) memchr(RExC_parse, ']', RExC_end - RExC_parse);
11483
11484     return (p
11485             && p - RExC_parse > 2 /* [:] evaluates to colon;
11486                                       [::] is a bad posix class. */
11487             && first_char == *(p - 1));
11488 }
11489
11490 STATIC regnode *
11491 S_handle_regex_sets(pTHX_ RExC_state_t *pRExC_state, SV** return_invlist, I32 *flagp, U32 depth,
11492                    char * const oregcomp_parse)
11493 {
11494     /* Handle the (?[...]) construct to do set operations */
11495
11496     U8 curchar;
11497     UV start, end;      /* End points of code point ranges */
11498     SV* result_string;
11499     char *save_end, *save_parse;
11500     SV* final;
11501     STRLEN len;
11502     regnode* node;
11503     AV* stack;
11504     const bool save_fold = FOLD;
11505
11506     GET_RE_DEBUG_FLAGS_DECL;
11507
11508     PERL_ARGS_ASSERT_HANDLE_REGEX_SETS;
11509
11510     if (LOC) {
11511         vFAIL("(?[...]) not valid in locale");
11512     }
11513     RExC_uni_semantics = 1;
11514
11515     /* This will return only an ANYOF regnode, or (unlikely) something smaller
11516      * (such as EXACT).  Thus we can skip most everything if just sizing.  We
11517      * call regclass to handle '[]' so as to not have to reinvent its parsing
11518      * rules here (throwing away the size it computes each time).  And, we exit
11519      * upon an unescaped ']' that isn't one ending a regclass.  To do both
11520      * these things, we need to realize that something preceded by a backslash
11521      * is escaped, so we have to keep track of backslashes */
11522     if (SIZE_ONLY) {
11523
11524         Perl_ck_warner_d(aTHX_
11525             packWARN(WARN_EXPERIMENTAL__REGEX_SETS),
11526             "The regex_sets feature is experimental" REPORT_LOCATION,
11527             (int) (RExC_parse - RExC_precomp) , RExC_precomp, RExC_parse);
11528
11529         while (RExC_parse < RExC_end) {
11530             SV* current = NULL;
11531             RExC_parse = regpatws(pRExC_state, RExC_parse,
11532                                 TRUE); /* means recognize comments */
11533             switch (*RExC_parse) {
11534                 default:
11535                     break;
11536                 case '\\':
11537                     /* Skip the next byte (which could cause us to end up in
11538                      * the middle of a UTF-8 character, but since none of those
11539                      * are confusable with anything we currently handle in this
11540                      * switch (invariants all), it's safe.  We'll just hit the
11541                      * default: case next time and keep on incrementing until
11542                      * we find one of the invariants we do handle. */
11543                     RExC_parse++;
11544                     break;
11545                 case '[':
11546                 {
11547                     /* If this looks like it is a [:posix:] class, leave the
11548                      * parse pointer at the '[' to fool regclass() into
11549                      * thinking it is part of a '[[:posix:]]'.  That function
11550                      * will use strict checking to force a syntax error if it
11551                      * doesn't work out to a legitimate class */
11552                     bool is_posix_class
11553                                     = could_it_be_a_POSIX_class(pRExC_state);
11554                     if (! is_posix_class) {
11555                         RExC_parse++;
11556                     }
11557
11558                     /* regclass() can only return RESTART_UTF8 if multi-char
11559                        folds are allowed.  */
11560                     if (!regclass(pRExC_state, flagp,depth+1,
11561                                   is_posix_class, /* parse the whole char
11562                                                      class only if not a
11563                                                      posix class */
11564                                   FALSE, /* don't allow multi-char folds */
11565                                   TRUE, /* silence non-portable warnings. */
11566                                   &current))
11567                         FAIL2("panic: regclass returned NULL to handle_sets, flags=%#X",
11568                               *flagp);
11569
11570                     /* function call leaves parse pointing to the ']', except
11571                      * if we faked it */
11572                     if (is_posix_class) {
11573                         RExC_parse--;
11574                     }
11575
11576                     SvREFCNT_dec(current);   /* In case it returned something */
11577                     break;
11578                 }
11579
11580                 case ']':
11581                     RExC_parse++;
11582                     if (RExC_parse < RExC_end
11583                         && *RExC_parse == ')')
11584                     {
11585                         node = reganode(pRExC_state, ANYOF, 0);
11586                         RExC_size += ANYOF_SKIP;
11587                         nextchar(pRExC_state);
11588                         Set_Node_Length(node,
11589                                 RExC_parse - oregcomp_parse + 1); /* MJD */
11590                         return node;
11591                     }
11592                     goto no_close;
11593             }
11594             RExC_parse++;
11595         }
11596
11597         no_close:
11598         FAIL("Syntax error in (?[...])");
11599     }
11600
11601     /* Pass 2 only after this.  Everything in this construct is a
11602      * metacharacter.  Operands begin with either a '\' (for an escape
11603      * sequence), or a '[' for a bracketed character class.  Any other
11604      * character should be an operator, or parenthesis for grouping.  Both
11605      * types of operands are handled by calling regclass() to parse them.  It
11606      * is called with a parameter to indicate to return the computed inversion
11607      * list.  The parsing here is implemented via a stack.  Each entry on the
11608      * stack is a single character representing one of the operators, or the
11609      * '('; or else a pointer to an operand inversion list. */
11610
11611 #define IS_OPERAND(a)  (! SvIOK(a))
11612
11613     /* The stack starts empty.  It is a syntax error if the first thing parsed
11614      * is a binary operator; everything else is pushed on the stack.  When an
11615      * operand is parsed, the top of the stack is examined.  If it is a binary
11616      * operator, the item before it should be an operand, and both are replaced
11617      * by the result of doing that operation on the new operand and the one on
11618      * the stack.   Thus a sequence of binary operands is reduced to a single
11619      * one before the next one is parsed.
11620      *
11621      * A unary operator may immediately follow a binary in the input, for
11622      * example
11623      *      [a] + ! [b]
11624      * When an operand is parsed and the top of the stack is a unary operator,
11625      * the operation is performed, and then the stack is rechecked to see if
11626      * this new operand is part of a binary operation; if so, it is handled as
11627      * above.
11628      *
11629      * A '(' is simply pushed on the stack; it is valid only if the stack is
11630      * empty, or the top element of the stack is an operator or another '('
11631      * (for which the parenthesized expression will become an operand).  By the
11632      * time the corresponding ')' is parsed everything in between should have
11633      * been parsed and evaluated to a single operand (or else is a syntax
11634      * error), and is handled as a regular operand */
11635
11636     stack = newAV();
11637
11638     while (RExC_parse < RExC_end) {
11639         I32 top_index = av_tindex(stack);
11640         SV** top_ptr;
11641         SV* current = NULL;
11642
11643         /* Skip white space */
11644         RExC_parse = regpatws(pRExC_state, RExC_parse,
11645                                 TRUE); /* means recognize comments */
11646         if (RExC_parse >= RExC_end) {
11647             Perl_croak(aTHX_ "panic: Read past end of '(?[ ])'");
11648         }
11649         if ((curchar = UCHARAT(RExC_parse)) == ']') {
11650             break;
11651         }
11652
11653         switch (curchar) {
11654
11655             case '?':
11656                 if (av_tindex(stack) >= 0   /* This makes sure that we can
11657                                                safely subtract 1 from
11658                                                RExC_parse in the next clause.
11659                                                If we have something on the
11660                                                stack, we have parsed something
11661                                              */
11662                     && UCHARAT(RExC_parse - 1) == '('
11663                     && RExC_parse < RExC_end)
11664                 {
11665                     /* If is a '(?', could be an embedded '(?flags:(?[...])'.
11666                      * This happens when we have some thing like
11667                      *
11668                      *   my $thai_or_lao = qr/(?[ \p{Thai} + \p{Lao} ])/;
11669                      *   ...
11670                      *   qr/(?[ \p{Digit} & $thai_or_lao ])/;
11671                      *
11672                      * Here we would be handling the interpolated
11673                      * '$thai_or_lao'.  We handle this by a recursive call to
11674                      * ourselves which returns the inversion list the
11675                      * interpolated expression evaluates to.  We use the flags
11676                      * from the interpolated pattern. */
11677                     U32 save_flags = RExC_flags;
11678                     const char * const save_parse = ++RExC_parse;
11679
11680                     parse_lparen_question_flags(pRExC_state);
11681
11682                     if (RExC_parse == save_parse  /* Makes sure there was at
11683                                                      least one flag (or this
11684                                                      embedding wasn't compiled)
11685                                                    */
11686                         || RExC_parse >= RExC_end - 4
11687                         || UCHARAT(RExC_parse) != ':'
11688                         || UCHARAT(++RExC_parse) != '('
11689                         || UCHARAT(++RExC_parse) != '?'
11690                         || UCHARAT(++RExC_parse) != '[')
11691                     {
11692
11693                         /* In combination with the above, this moves the
11694                          * pointer to the point just after the first erroneous
11695                          * character (or if there are no flags, to where they
11696                          * should have been) */
11697                         if (RExC_parse >= RExC_end - 4) {
11698                             RExC_parse = RExC_end;
11699                         }
11700                         else if (RExC_parse != save_parse) {
11701                             RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
11702                         }
11703                         vFAIL("Expecting '(?flags:(?[...'");
11704                     }
11705                     RExC_parse++;
11706                     (void) handle_regex_sets(pRExC_state, &current, flagp,
11707                                                     depth+1, oregcomp_parse);
11708
11709                     /* Here, 'current' contains the embedded expression's
11710                      * inversion list, and RExC_parse points to the trailing
11711                      * ']'; the next character should be the ')' which will be
11712                      * paired with the '(' that has been put on the stack, so
11713                      * the whole embedded expression reduces to '(operand)' */
11714                     RExC_parse++;
11715
11716                     RExC_flags = save_flags;
11717                     goto handle_operand;
11718                 }
11719                 /* FALL THROUGH */
11720
11721             default:
11722                 RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
11723                 vFAIL("Unexpected character");
11724
11725             case '\\':
11726                 /* regclass() can only return RESTART_UTF8 if multi-char
11727                    folds are allowed.  */
11728                 if (!regclass(pRExC_state, flagp,depth+1,
11729                               TRUE, /* means parse just the next thing */
11730                               FALSE, /* don't allow multi-char folds */
11731                               FALSE, /* don't silence non-portable warnings.  */
11732                               &current))
11733                     FAIL2("panic: regclass returned NULL to handle_sets, flags=%#X",
11734                           *flagp);
11735                 /* regclass() will return with parsing just the \ sequence,
11736                  * leaving the parse pointer at the next thing to parse */
11737                 RExC_parse--;
11738                 goto handle_operand;
11739
11740             case '[':   /* Is a bracketed character class */
11741             {
11742                 bool is_posix_class = could_it_be_a_POSIX_class(pRExC_state);
11743
11744                 if (! is_posix_class) {
11745                     RExC_parse++;
11746                 }
11747
11748                 /* regclass() can only return RESTART_UTF8 if multi-char
11749                    folds are allowed.  */
11750                 if(!regclass(pRExC_state, flagp,depth+1,
11751                              is_posix_class, /* parse the whole char class
11752                                                 only if not a posix class */
11753                              FALSE, /* don't allow multi-char folds */
11754                              FALSE, /* don't silence non-portable warnings.  */
11755                              &current))
11756                     FAIL2("panic: regclass returned NULL to handle_sets, flags=%#X",
11757                           *flagp);
11758                 /* function call leaves parse pointing to the ']', except if we
11759                  * faked it */
11760                 if (is_posix_class) {
11761                     RExC_parse--;
11762                 }
11763
11764                 goto handle_operand;
11765             }
11766
11767             case '&':
11768             case '|':
11769             case '+':
11770             case '-':
11771             case '^':
11772                 if (top_index < 0
11773                     || ( ! (top_ptr = av_fetch(stack, top_index, FALSE)))
11774                     || ! IS_OPERAND(*top_ptr))
11775                 {
11776                     RExC_parse++;
11777                     vFAIL2("Unexpected binary operator '%c' with no preceding operand", curchar);
11778                 }
11779                 av_push(stack, newSVuv(curchar));
11780                 break;
11781
11782             case '!':
11783                 av_push(stack, newSVuv(curchar));
11784                 break;
11785
11786             case '(':
11787                 if (top_index >= 0) {
11788                     top_ptr = av_fetch(stack, top_index, FALSE);
11789                     assert(top_ptr);
11790                     if (IS_OPERAND(*top_ptr)) {
11791                         RExC_parse++;
11792                         vFAIL("Unexpected '(' with no preceding operator");
11793                     }
11794                 }
11795                 av_push(stack, newSVuv(curchar));
11796                 break;
11797
11798             case ')':
11799             {
11800                 SV* lparen;
11801                 if (top_index < 1
11802                     || ! (current = av_pop(stack))
11803                     || ! IS_OPERAND(current)
11804                     || ! (lparen = av_pop(stack))
11805                     || IS_OPERAND(lparen)
11806                     || SvUV(lparen) != '(')
11807                 {
11808                     RExC_parse++;
11809                     vFAIL("Unexpected ')'");
11810                 }
11811                 top_index -= 2;
11812                 SvREFCNT_dec_NN(lparen);
11813
11814                 /* FALL THROUGH */
11815             }
11816
11817               handle_operand:
11818
11819                 /* Here, we have an operand to process, in 'current' */
11820
11821                 if (top_index < 0) {    /* Just push if stack is empty */
11822                     av_push(stack, current);
11823                 }
11824                 else {
11825                     SV* top = av_pop(stack);
11826                     char current_operator;
11827
11828                     if (IS_OPERAND(top)) {
11829                         vFAIL("Operand with no preceding operator");
11830                     }
11831                     current_operator = (char) SvUV(top);
11832                     switch (current_operator) {
11833                         case '(':   /* Push the '(' back on followed by the new
11834                                        operand */
11835                             av_push(stack, top);
11836                             av_push(stack, current);
11837                             SvREFCNT_inc(top);  /* Counters the '_dec' done
11838                                                    just after the 'break', so
11839                                                    it doesn't get wrongly freed
11840                                                  */
11841                             break;
11842
11843                         case '!':
11844                             _invlist_invert(current);
11845
11846                             /* Unlike binary operators, the top of the stack,
11847                              * now that this unary one has been popped off, may
11848                              * legally be an operator, and we now have operand
11849                              * for it. */
11850                             top_index--;
11851                             SvREFCNT_dec_NN(top);
11852                             goto handle_operand;
11853
11854                         case '&':
11855                             _invlist_intersection(av_pop(stack),
11856                                                    current,
11857                                                    &current);
11858                             av_push(stack, current);
11859                             break;
11860
11861                         case '|':
11862                         case '+':
11863                             _invlist_union(av_pop(stack), current, &current);
11864                             av_push(stack, current);
11865                             break;
11866
11867                         case '-':
11868                             _invlist_subtract(av_pop(stack), current, &current);
11869                             av_push(stack, current);
11870                             break;
11871
11872                         case '^':   /* The union minus the intersection */
11873                         {
11874                             SV* i = NULL;
11875                             SV* u = NULL;
11876                             SV* element;
11877
11878                             element = av_pop(stack);
11879                             _invlist_union(element, current, &u);
11880                             _invlist_intersection(element, current, &i);
11881                             _invlist_subtract(u, i, &current);
11882                             av_push(stack, current);
11883                             SvREFCNT_dec_NN(i);
11884                             SvREFCNT_dec_NN(u);
11885                             SvREFCNT_dec_NN(element);
11886                             break;
11887                         }
11888
11889                         default:
11890                             Perl_croak(aTHX_ "panic: Unexpected item on '(?[ ])' stack");
11891                 }
11892                 SvREFCNT_dec_NN(top);
11893             }
11894         }
11895
11896         RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
11897     }
11898
11899     if (av_tindex(stack) < 0   /* Was empty */
11900         || ((final = av_pop(stack)) == NULL)
11901         || ! IS_OPERAND(final)
11902         || av_tindex(stack) >= 0)  /* More left on stack */
11903     {
11904         vFAIL("Incomplete expression within '(?[ ])'");
11905     }
11906
11907     /* Here, 'final' is the resultant inversion list from evaluating the
11908      * expression.  Return it if so requested */
11909     if (return_invlist) {
11910         *return_invlist = final;
11911         return END;
11912     }
11913
11914     /* Otherwise generate a resultant node, based on 'final'.  regclass() is
11915      * expecting a string of ranges and individual code points */
11916     invlist_iterinit(final);
11917     result_string = newSVpvs("");
11918     while (invlist_iternext(final, &start, &end)) {
11919         if (start == end) {
11920             Perl_sv_catpvf(aTHX_ result_string, "\\x{%"UVXf"}", start);
11921         }
11922         else {
11923             Perl_sv_catpvf(aTHX_ result_string, "\\x{%"UVXf"}-\\x{%"UVXf"}",
11924                                                      start,          end);
11925         }
11926     }
11927
11928     save_parse = RExC_parse;
11929     RExC_parse = SvPV(result_string, len);
11930     save_end = RExC_end;
11931     RExC_end = RExC_parse + len;
11932
11933     /* We turn off folding around the call, as the class we have constructed
11934      * already has all folding taken into consideration, and we don't want
11935      * regclass() to add to that */
11936     RExC_flags &= ~RXf_PMf_FOLD;
11937     /* regclass() can only return RESTART_UTF8 if multi-char folds are allowed.
11938      */
11939     node = regclass(pRExC_state, flagp,depth+1,
11940                     FALSE, /* means parse the whole char class */
11941                     FALSE, /* don't allow multi-char folds */
11942                     TRUE, /* silence non-portable warnings.  The above may very
11943                              well have generated non-portable code points, but
11944                              they're valid on this machine */
11945                     NULL);
11946     if (!node)
11947         FAIL2("panic: regclass returned NULL to handle_sets, flags=%#"UVxf,
11948                     PTR2UV(flagp));
11949     if (save_fold) {
11950         RExC_flags |= RXf_PMf_FOLD;
11951     }
11952     RExC_parse = save_parse + 1;
11953     RExC_end = save_end;
11954     SvREFCNT_dec_NN(final);
11955     SvREFCNT_dec_NN(result_string);
11956     SvREFCNT_dec_NN(stack);
11957
11958     nextchar(pRExC_state);
11959     Set_Node_Length(node, RExC_parse - oregcomp_parse + 1); /* MJD */
11960     return node;
11961 }
11962 #undef IS_OPERAND
11963
11964 /* The names of properties whose definitions are not known at compile time are
11965  * stored in this SV, after a constant heading.  So if the length has been
11966  * changed since initialization, then there is a run-time definition. */
11967 #define HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION (SvCUR(listsv) != initial_listsv_len)
11968
11969 STATIC regnode *
11970 S_regclass(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth,
11971                  const bool stop_at_1,  /* Just parse the next thing, don't
11972                                            look for a full character class */
11973                  bool allow_multi_folds,
11974                  const bool silence_non_portable,   /* Don't output warnings
11975                                                        about too large
11976                                                        characters */
11977                  SV** ret_invlist)  /* Return an inversion list, not a node */
11978 {
11979     /* parse a bracketed class specification.  Most of these will produce an
11980      * ANYOF node; but something like [a] will produce an EXACT node; [aA], an
11981      * EXACTFish node; [[:ascii:]], a POSIXA node; etc.  It is more complex
11982      * under /i with multi-character folds: it will be rewritten following the
11983      * paradigm of this example, where the <multi-fold>s are characters which
11984      * fold to multiple character sequences:
11985      *      /[abc\x{multi-fold1}def\x{multi-fold2}ghi]/i
11986      * gets effectively rewritten as:
11987      *      /(?:\x{multi-fold1}|\x{multi-fold2}|[abcdefghi]/i
11988      * reg() gets called (recursively) on the rewritten version, and this
11989      * function will return what it constructs.  (Actually the <multi-fold>s
11990      * aren't physically removed from the [abcdefghi], it's just that they are
11991      * ignored in the recursion by means of a flag:
11992      * <RExC_in_multi_char_class>.)
11993      *
11994      * ANYOF nodes contain a bit map for the first 256 characters, with the
11995      * corresponding bit set if that character is in the list.  For characters
11996      * above 255, a range list or swash is used.  There are extra bits for \w,
11997      * etc. in locale ANYOFs, as what these match is not determinable at
11998      * compile time
11999      *
12000      * Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan needs
12001      * to be restarted.  This can only happen if ret_invlist is non-NULL.
12002      */
12003
12004     dVAR;
12005     UV prevvalue = OOB_UNICODE, save_prevvalue = OOB_UNICODE;
12006     IV range = 0;
12007     UV value = OOB_UNICODE, save_value = OOB_UNICODE;
12008     regnode *ret;
12009     STRLEN numlen;
12010     IV namedclass = OOB_NAMEDCLASS;
12011     char *rangebegin = NULL;
12012     bool need_class = 0;
12013     SV *listsv = NULL;
12014     STRLEN initial_listsv_len = 0; /* Kind of a kludge to see if it is more
12015                                       than just initialized.  */
12016     SV* properties = NULL;    /* Code points that match \p{} \P{} */
12017     SV* posixes = NULL;     /* Code points that match classes like, [:word:],
12018                                extended beyond the Latin1 range */
12019     UV element_count = 0;   /* Number of distinct elements in the class.
12020                                Optimizations may be possible if this is tiny */
12021     AV * multi_char_matches = NULL; /* Code points that fold to more than one
12022                                        character; used under /i */
12023     UV n;
12024     char * stop_ptr = RExC_end;    /* where to stop parsing */
12025     const bool skip_white = cBOOL(ret_invlist); /* ignore unescaped white
12026                                                    space? */
12027     const bool strict = cBOOL(ret_invlist); /* Apply strict parsing rules? */
12028
12029     /* Unicode properties are stored in a swash; this holds the current one
12030      * being parsed.  If this swash is the only above-latin1 component of the
12031      * character class, an optimization is to pass it directly on to the
12032      * execution engine.  Otherwise, it is set to NULL to indicate that there
12033      * are other things in the class that have to be dealt with at execution
12034      * time */
12035     SV* swash = NULL;           /* Code points that match \p{} \P{} */
12036
12037     /* Set if a component of this character class is user-defined; just passed
12038      * on to the engine */
12039     bool has_user_defined_property = FALSE;
12040
12041     /* inversion list of code points this node matches only when the target
12042      * string is in UTF-8.  (Because is under /d) */
12043     SV* depends_list = NULL;
12044
12045     /* inversion list of code points this node matches.  For much of the
12046      * function, it includes only those that match regardless of the utf8ness
12047      * of the target string */
12048     SV* cp_list = NULL;
12049
12050 #ifdef EBCDIC
12051     /* In a range, counts how many 0-2 of the ends of it came from literals,
12052      * not escapes.  Thus we can tell if 'A' was input vs \x{C1} */
12053     UV literal_endpoint = 0;
12054 #endif
12055     bool invert = FALSE;    /* Is this class to be complemented */
12056
12057     /* Is there any thing like \W or [:^digit:] that matches above the legal
12058      * Unicode range? */
12059     bool runtime_posix_matches_above_Unicode = FALSE;
12060
12061     regnode * const orig_emit = RExC_emit; /* Save the original RExC_emit in
12062         case we need to change the emitted regop to an EXACT. */
12063     const char * orig_parse = RExC_parse;
12064     const I32 orig_size = RExC_size;
12065     GET_RE_DEBUG_FLAGS_DECL;
12066
12067     PERL_ARGS_ASSERT_REGCLASS;
12068 #ifndef DEBUGGING
12069     PERL_UNUSED_ARG(depth);
12070 #endif
12071
12072     DEBUG_PARSE("clas");
12073
12074     /* Assume we are going to generate an ANYOF node. */
12075     ret = reganode(pRExC_state, ANYOF, 0);
12076
12077     if (SIZE_ONLY) {
12078         RExC_size += ANYOF_SKIP;
12079         listsv = &PL_sv_undef; /* For code scanners: listsv always non-NULL. */
12080     }
12081     else {
12082         ANYOF_FLAGS(ret) = 0;
12083
12084         RExC_emit += ANYOF_SKIP;
12085         if (LOC) {
12086             ANYOF_FLAGS(ret) |= ANYOF_LOCALE;
12087         }
12088         listsv = newSVpvs_flags("# comment\n", SVs_TEMP);
12089         initial_listsv_len = SvCUR(listsv);
12090         SvTEMP_off(listsv); /* Grr, TEMPs and mortals are conflated.  */
12091     }
12092
12093     if (skip_white) {
12094         RExC_parse = regpatws(pRExC_state, RExC_parse,
12095                               FALSE /* means don't recognize comments */);
12096     }
12097
12098     if (UCHARAT(RExC_parse) == '^') {   /* Complement of range. */
12099         RExC_parse++;
12100         invert = TRUE;
12101         allow_multi_folds = FALSE;
12102         RExC_naughty++;
12103         if (skip_white) {
12104             RExC_parse = regpatws(pRExC_state, RExC_parse,
12105                                   FALSE /* means don't recognize comments */);
12106         }
12107     }
12108
12109     /* Check that they didn't say [:posix:] instead of [[:posix:]] */
12110     if (!SIZE_ONLY && RExC_parse < RExC_end && POSIXCC(UCHARAT(RExC_parse))) {
12111         const char *s = RExC_parse;
12112         const char  c = *s++;
12113
12114         while (isWORDCHAR(*s))
12115             s++;
12116         if (*s && c == *s && s[1] == ']') {
12117             SAVEFREESV(RExC_rx_sv);
12118             ckWARN3reg(s+2,
12119                        "POSIX syntax [%c %c] belongs inside character classes",
12120                        c, c);
12121             (void)ReREFCNT_inc(RExC_rx_sv);
12122         }
12123     }
12124
12125     /* If the caller wants us to just parse a single element, accomplish this
12126      * by faking the loop ending condition */
12127     if (stop_at_1 && RExC_end > RExC_parse) {
12128         stop_ptr = RExC_parse + 1;
12129     }
12130
12131     /* allow 1st char to be ']' (allowing it to be '-' is dealt with later) */
12132     if (UCHARAT(RExC_parse) == ']')
12133         goto charclassloop;
12134
12135 parseit:
12136     while (1) {
12137         if  (RExC_parse >= stop_ptr) {
12138             break;
12139         }
12140
12141         if (skip_white) {
12142             RExC_parse = regpatws(pRExC_state, RExC_parse,
12143                                   FALSE /* means don't recognize comments */);
12144         }
12145
12146         if  (UCHARAT(RExC_parse) == ']') {
12147             break;
12148         }
12149
12150     charclassloop:
12151
12152         namedclass = OOB_NAMEDCLASS; /* initialize as illegal */
12153         save_value = value;
12154         save_prevvalue = prevvalue;
12155
12156         if (!range) {
12157             rangebegin = RExC_parse;
12158             element_count++;
12159         }
12160         if (UTF) {
12161             value = utf8n_to_uvchr((U8*)RExC_parse,
12162                                    RExC_end - RExC_parse,
12163                                    &numlen, UTF8_ALLOW_DEFAULT);
12164             RExC_parse += numlen;
12165         }
12166         else
12167             value = UCHARAT(RExC_parse++);
12168
12169         if (value == '['
12170             && RExC_parse < RExC_end
12171             && POSIXCC(UCHARAT(RExC_parse)))
12172         {
12173             namedclass = regpposixcc(pRExC_state, value, strict);
12174         }
12175         else if (value == '\\') {
12176             if (UTF) {
12177                 value = utf8n_to_uvchr((U8*)RExC_parse,
12178                                    RExC_end - RExC_parse,
12179                                    &numlen, UTF8_ALLOW_DEFAULT);
12180                 RExC_parse += numlen;
12181             }
12182             else
12183                 value = UCHARAT(RExC_parse++);
12184
12185             /* Some compilers cannot handle switching on 64-bit integer
12186              * values, therefore value cannot be an UV.  Yes, this will
12187              * be a problem later if we want switch on Unicode.
12188              * A similar issue a little bit later when switching on
12189              * namedclass. --jhi */
12190
12191             /* If the \ is escaping white space when white space is being
12192              * skipped, it means that that white space is wanted literally, and
12193              * is already in 'value'.  Otherwise, need to translate the escape
12194              * into what it signifies. */
12195             if (! skip_white || ! is_PATWS_cp(value)) switch ((I32)value) {
12196
12197             case 'w':   namedclass = ANYOF_WORDCHAR;    break;
12198             case 'W':   namedclass = ANYOF_NWORDCHAR;   break;
12199             case 's':   namedclass = ANYOF_SPACE;       break;
12200             case 'S':   namedclass = ANYOF_NSPACE;      break;
12201             case 'd':   namedclass = ANYOF_DIGIT;       break;
12202             case 'D':   namedclass = ANYOF_NDIGIT;      break;
12203             case 'v':   namedclass = ANYOF_VERTWS;      break;
12204             case 'V':   namedclass = ANYOF_NVERTWS;     break;
12205             case 'h':   namedclass = ANYOF_HORIZWS;     break;
12206             case 'H':   namedclass = ANYOF_NHORIZWS;    break;
12207             case 'N':  /* Handle \N{NAME} in class */
12208                 {
12209                     /* We only pay attention to the first char of 
12210                     multichar strings being returned. I kinda wonder
12211                     if this makes sense as it does change the behaviour
12212                     from earlier versions, OTOH that behaviour was broken
12213                     as well. */
12214                     if (! grok_bslash_N(pRExC_state, NULL, &value, flagp, depth,
12215                                       TRUE, /* => charclass */
12216                                       strict))
12217                     {
12218                         if (*flagp & RESTART_UTF8)
12219                             FAIL("panic: grok_bslash_N set RESTART_UTF8");
12220                         goto parseit;
12221                     }
12222                 }
12223                 break;
12224             case 'p':
12225             case 'P':
12226                 {
12227                 char *e;
12228
12229                 /* We will handle any undefined properties ourselves */
12230                 U8 swash_init_flags = _CORE_SWASH_INIT_RETURN_IF_UNDEF;
12231
12232                 if (RExC_parse >= RExC_end)
12233                     vFAIL2("Empty \\%c{}", (U8)value);
12234                 if (*RExC_parse == '{') {
12235                     const U8 c = (U8)value;
12236                     e = strchr(RExC_parse++, '}');
12237                     if (!e)
12238                         vFAIL2("Missing right brace on \\%c{}", c);
12239                     while (isSPACE(UCHARAT(RExC_parse)))
12240                         RExC_parse++;
12241                     if (e == RExC_parse)
12242                         vFAIL2("Empty \\%c{}", c);
12243                     n = e - RExC_parse;
12244                     while (isSPACE(UCHARAT(RExC_parse + n - 1)))
12245                         n--;
12246                 }
12247                 else {
12248                     e = RExC_parse;
12249                     n = 1;
12250                 }
12251                 if (!SIZE_ONLY) {
12252                     SV* invlist;
12253                     char* name;
12254
12255                     if (UCHARAT(RExC_parse) == '^') {
12256                          RExC_parse++;
12257                          n--;
12258                          /* toggle.  (The rhs xor gets the single bit that
12259                           * differs between P and p; the other xor inverts just
12260                           * that bit) */
12261                          value ^= 'P' ^ 'p';
12262
12263                          while (isSPACE(UCHARAT(RExC_parse))) {
12264                               RExC_parse++;
12265                               n--;
12266                          }
12267                     }
12268                     /* Try to get the definition of the property into
12269                      * <invlist>.  If /i is in effect, the effective property
12270                      * will have its name be <__NAME_i>.  The design is
12271                      * discussed in commit
12272                      * 2f833f5208e26b208886e51e09e2c072b5eabb46 */
12273                     Newx(name, n + sizeof("_i__\n"), char);
12274
12275                     sprintf(name, "%s%.*s%s\n",
12276                                     (FOLD) ? "__" : "",
12277                                     (int)n,
12278                                     RExC_parse,
12279                                     (FOLD) ? "_i" : ""
12280                     );
12281
12282                     /* Look up the property name, and get its swash and
12283                      * inversion list, if the property is found  */
12284                     if (swash) {
12285                         SvREFCNT_dec_NN(swash);
12286                     }
12287                     swash = _core_swash_init("utf8", name, &PL_sv_undef,
12288                                              1, /* binary */
12289                                              0, /* not tr/// */
12290                                              NULL, /* No inversion list */
12291                                              &swash_init_flags
12292                                             );
12293                     if (! swash || ! (invlist = _get_swash_invlist(swash))) {
12294                         if (swash) {
12295                             SvREFCNT_dec_NN(swash);
12296                             swash = NULL;
12297                         }
12298
12299                         /* Here didn't find it.  It could be a user-defined
12300                          * property that will be available at run-time.  If we
12301                          * accept only compile-time properties, is an error;
12302                          * otherwise add it to the list for run-time look up */
12303                         if (ret_invlist) {
12304                             RExC_parse = e + 1;
12305                             vFAIL3("Property '%.*s' is unknown", (int) n, name);
12306                         }
12307                         Perl_sv_catpvf(aTHX_ listsv, "%cutf8::%s\n",
12308                                         (value == 'p' ? '+' : '!'),
12309                                         name);
12310                         has_user_defined_property = TRUE;
12311
12312                         /* We don't know yet, so have to assume that the
12313                          * property could match something in the Latin1 range,
12314                          * hence something that isn't utf8.  Note that this
12315                          * would cause things in <depends_list> to match
12316                          * inappropriately, except that any \p{}, including
12317                          * this one forces Unicode semantics, which means there
12318                          * is <no depends_list> */
12319                         ANYOF_FLAGS(ret) |= ANYOF_NONBITMAP_NON_UTF8;
12320                     }
12321                     else {
12322
12323                         /* Here, did get the swash and its inversion list.  If
12324                          * the swash is from a user-defined property, then this
12325                          * whole character class should be regarded as such */
12326                         has_user_defined_property =
12327                                     (swash_init_flags
12328                                      & _CORE_SWASH_INIT_USER_DEFINED_PROPERTY);
12329
12330                         /* Invert if asking for the complement */
12331                         if (value == 'P') {
12332                             _invlist_union_complement_2nd(properties,
12333                                                           invlist,
12334                                                           &properties);
12335
12336                             /* The swash can't be used as-is, because we've
12337                              * inverted things; delay removing it to here after
12338                              * have copied its invlist above */
12339                             SvREFCNT_dec_NN(swash);
12340                             swash = NULL;
12341                         }
12342                         else {
12343                             _invlist_union(properties, invlist, &properties);
12344                         }
12345                     }
12346                     Safefree(name);
12347                 }
12348                 RExC_parse = e + 1;
12349                 namedclass = ANYOF_UNIPROP;  /* no official name, but it's
12350                                                 named */
12351
12352                 /* \p means they want Unicode semantics */
12353                 RExC_uni_semantics = 1;
12354                 }
12355                 break;
12356             case 'n':   value = '\n';                   break;
12357             case 'r':   value = '\r';                   break;
12358             case 't':   value = '\t';                   break;
12359             case 'f':   value = '\f';                   break;
12360             case 'b':   value = '\b';                   break;
12361             case 'e':   value = ASCII_TO_NATIVE('\033');break;
12362             case 'a':   value = ASCII_TO_NATIVE('\007');break;
12363             case 'o':
12364                 RExC_parse--;   /* function expects to be pointed at the 'o' */
12365                 {
12366                     const char* error_msg;
12367                     bool valid = grok_bslash_o(&RExC_parse,
12368                                                &value,
12369                                                &error_msg,
12370                                                SIZE_ONLY,   /* warnings in pass
12371                                                                1 only */
12372                                                strict,
12373                                                silence_non_portable,
12374                                                UTF);
12375                     if (! valid) {
12376                         vFAIL(error_msg);
12377                     }
12378                 }
12379                 if (PL_encoding && value < 0x100) {
12380                     goto recode_encoding;
12381                 }
12382                 break;
12383             case 'x':
12384                 RExC_parse--;   /* function expects to be pointed at the 'x' */
12385                 {
12386                     const char* error_msg;
12387                     bool valid = grok_bslash_x(&RExC_parse,
12388                                                &value,
12389                                                &error_msg,
12390                                                TRUE, /* Output warnings */
12391                                                strict,
12392                                                silence_non_portable,
12393                                                UTF);
12394                     if (! valid) {
12395                         vFAIL(error_msg);
12396                     }
12397                 }
12398                 if (PL_encoding && value < 0x100)
12399                     goto recode_encoding;
12400                 break;
12401             case 'c':
12402                 value = grok_bslash_c(*RExC_parse++, UTF, SIZE_ONLY);
12403                 break;
12404             case '0': case '1': case '2': case '3': case '4':
12405             case '5': case '6': case '7':
12406                 {
12407                     /* Take 1-3 octal digits */
12408                     I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
12409                     numlen = (strict) ? 4 : 3;
12410                     value = grok_oct(--RExC_parse, &numlen, &flags, NULL);
12411                     RExC_parse += numlen;
12412                     if (numlen != 3) {
12413                         if (strict) {
12414                             RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
12415                             vFAIL("Need exactly 3 octal digits");
12416                         }
12417                         else if (! SIZE_ONLY /* like \08, \178 */
12418                                  && numlen < 3
12419                                  && RExC_parse < RExC_end
12420                                  && isDIGIT(*RExC_parse)
12421                                  && ckWARN(WARN_REGEXP))
12422                         {
12423                             SAVEFREESV(RExC_rx_sv);
12424                             reg_warn_non_literal_string(
12425                                  RExC_parse + 1,
12426                                  form_short_octal_warning(RExC_parse, numlen));
12427                             (void)ReREFCNT_inc(RExC_rx_sv);
12428                         }
12429                     }
12430                     if (PL_encoding && value < 0x100)
12431                         goto recode_encoding;
12432                     break;
12433                 }
12434             recode_encoding:
12435                 if (! RExC_override_recoding) {
12436                     SV* enc = PL_encoding;
12437                     value = reg_recode((const char)(U8)value, &enc);
12438                     if (!enc) {
12439                         if (strict) {
12440                             vFAIL("Invalid escape in the specified encoding");
12441                         }
12442                         else if (SIZE_ONLY) {
12443                             ckWARNreg(RExC_parse,
12444                                   "Invalid escape in the specified encoding");
12445                         }
12446                     }
12447                     break;
12448                 }
12449             default:
12450                 /* Allow \_ to not give an error */
12451                 if (!SIZE_ONLY && isWORDCHAR(value) && value != '_') {
12452                     if (strict) {
12453                         vFAIL2("Unrecognized escape \\%c in character class",
12454                                (int)value);
12455                     }
12456                     else {
12457                         SAVEFREESV(RExC_rx_sv);
12458                         ckWARN2reg(RExC_parse,
12459                             "Unrecognized escape \\%c in character class passed through",
12460                             (int)value);
12461                         (void)ReREFCNT_inc(RExC_rx_sv);
12462                     }
12463                 }
12464                 break;
12465             }   /* End of switch on char following backslash */
12466         } /* end of handling backslash escape sequences */
12467 #ifdef EBCDIC
12468         else
12469             literal_endpoint++;
12470 #endif
12471
12472         /* Here, we have the current token in 'value' */
12473
12474         /* What matches in a locale is not known until runtime.  This includes
12475          * what the Posix classes (like \w, [:space:]) match.  Room must be
12476          * reserved (one time per class) to store such classes, either if Perl
12477          * is compiled so that locale nodes always should have this space, or
12478          * if there is such class info to be stored.  The space will contain a
12479          * bit for each named class that is to be matched against.  This isn't
12480          * needed for \p{} and pseudo-classes, as they are not affected by
12481          * locale, and hence are dealt with separately */
12482         if (LOC
12483             && ! need_class
12484             && (ANYOF_LOCALE == ANYOF_CLASS
12485                 || (namedclass > OOB_NAMEDCLASS && namedclass < ANYOF_MAX)))
12486         {
12487             need_class = 1;
12488             if (SIZE_ONLY) {
12489                 RExC_size += ANYOF_CLASS_SKIP - ANYOF_SKIP;
12490             }
12491             else {
12492                 RExC_emit += ANYOF_CLASS_SKIP - ANYOF_SKIP;
12493                 ANYOF_CLASS_ZERO(ret);
12494             }
12495             ANYOF_FLAGS(ret) |= ANYOF_CLASS;
12496         }
12497
12498         if (namedclass > OOB_NAMEDCLASS) { /* this is a named class \blah */
12499
12500             /* a bad range like a-\d, a-[:digit:].  The '-' is taken as a
12501              * literal, as is the character that began the false range, i.e.
12502              * the 'a' in the examples */
12503             if (range) {
12504                 if (!SIZE_ONLY) {
12505                     const int w = (RExC_parse >= rangebegin)
12506                                   ? RExC_parse - rangebegin
12507                                   : 0;
12508                     if (strict) {
12509                         vFAIL4("False [] range \"%*.*s\"", w, w, rangebegin);
12510                     }
12511                     else {
12512                         SAVEFREESV(RExC_rx_sv); /* in case of fatal warnings */
12513                         ckWARN4reg(RExC_parse,
12514                                 "False [] range \"%*.*s\"",
12515                                 w, w, rangebegin);
12516                         (void)ReREFCNT_inc(RExC_rx_sv);
12517                         cp_list = add_cp_to_invlist(cp_list, '-');
12518                         cp_list = add_cp_to_invlist(cp_list, prevvalue);
12519                     }
12520                 }
12521
12522                 range = 0; /* this was not a true range */
12523                 element_count += 2; /* So counts for three values */
12524             }
12525
12526             if (! SIZE_ONLY) {
12527                 U8 classnum = namedclass_to_classnum(namedclass);
12528                 if (namedclass >= ANYOF_MAX) {  /* If a special class */
12529                     if (namedclass != ANYOF_UNIPROP) { /* UNIPROP = \p and \P */
12530
12531                         /* Here, should be \h, \H, \v, or \V.  Neither /d nor
12532                          * /l make a difference in what these match.  There
12533                          * would be problems if these characters had folds
12534                          * other than themselves, as cp_list is subject to
12535                          * folding. */
12536                         if (classnum != _CC_VERTSPACE) {
12537                             assert(   namedclass == ANYOF_HORIZWS
12538                                    || namedclass == ANYOF_NHORIZWS);
12539
12540                             /* It turns out that \h is just a synonym for
12541                              * XPosixBlank */
12542                             classnum = _CC_BLANK;
12543                         }
12544
12545                         _invlist_union_maybe_complement_2nd(
12546                                 cp_list,
12547                                 PL_XPosix_ptrs[classnum],
12548                                 cBOOL(namedclass % 2), /* Complement if odd
12549                                                           (NHORIZWS, NVERTWS)
12550                                                         */
12551                                 &cp_list);
12552                     }
12553                 }
12554                 else if (classnum == _CC_ASCII) {
12555 #ifdef HAS_ISASCII
12556                     if (LOC) {
12557                         ANYOF_CLASS_SET(ret, namedclass);
12558                     }
12559                     else
12560 #endif  /* Not isascii(); just use the hard-coded definition for it */
12561                         _invlist_union_maybe_complement_2nd(
12562                                 posixes,
12563                                 PL_ASCII,
12564                                 cBOOL(namedclass % 2), /* Complement if odd
12565                                                           (NASCII) */
12566                                 &posixes);
12567                 }
12568                 else {  /* Garden variety class */
12569
12570                     /* The ascii range inversion list */
12571                     SV* ascii_source = PL_Posix_ptrs[classnum];
12572
12573                     /* The full Latin1 range inversion list */
12574                     SV* l1_source = PL_L1Posix_ptrs[classnum];
12575
12576                     /* This code is structured into two major clauses.  The
12577                      * first is for classes whose complete definitions may not
12578                      * already be known.  It not, the Latin1 definition
12579                      * (guaranteed to already known) is used plus code is
12580                      * generated to load the rest at run-time (only if needed).
12581                      * If the complete definition is known, it drops down to
12582                      * the second clause, where the complete definition is
12583                      * known */
12584
12585                     if (classnum < _FIRST_NON_SWASH_CC) {
12586
12587                         /* Here, the class has a swash, which may or not
12588                          * already be loaded */
12589
12590                         /* The name of the property to use to match the full
12591                          * eXtended Unicode range swash for this character
12592                          * class */
12593                         const char *Xname = swash_property_names[classnum];
12594
12595                         /* If returning the inversion list, we can't defer
12596                          * getting this until runtime */
12597                         if (ret_invlist && !  PL_utf8_swash_ptrs[classnum]) {
12598                             PL_utf8_swash_ptrs[classnum] =
12599                                 _core_swash_init("utf8", Xname, &PL_sv_undef,
12600                                              1, /* binary */
12601                                              0, /* not tr/// */
12602                                              NULL, /* No inversion list */
12603                                              NULL  /* No flags */
12604                                             );
12605                             assert(PL_utf8_swash_ptrs[classnum]);
12606                         }
12607                         if ( !  PL_utf8_swash_ptrs[classnum]) {
12608                             if (namedclass % 2 == 0) { /* A non-complemented
12609                                                           class */
12610                                 /* If not /a matching, there are code points we
12611                                  * don't know at compile time.  Arrange for the
12612                                  * unknown matches to be loaded at run-time, if
12613                                  * needed */
12614                                 if (! AT_LEAST_ASCII_RESTRICTED) {
12615                                     Perl_sv_catpvf(aTHX_ listsv, "+utf8::%s\n",
12616                                                                  Xname);
12617                                 }
12618                                 if (LOC) {  /* Under locale, set run-time
12619                                                lookup */
12620                                     ANYOF_CLASS_SET(ret, namedclass);
12621                                 }
12622                                 else {
12623                                     /* Add the current class's code points to
12624                                      * the running total */
12625                                     _invlist_union(posixes,
12626                                                    (AT_LEAST_ASCII_RESTRICTED)
12627                                                         ? ascii_source
12628                                                         : l1_source,
12629                                                    &posixes);
12630                                 }
12631                             }
12632                             else {  /* A complemented class */
12633                                 if (AT_LEAST_ASCII_RESTRICTED) {
12634                                     /* Under /a should match everything above
12635                                      * ASCII, plus the complement of the set's
12636                                      * ASCII matches */
12637                                     _invlist_union_complement_2nd(posixes,
12638                                                                   ascii_source,
12639                                                                   &posixes);
12640                                 }
12641                                 else {
12642                                     /* Arrange for the unknown matches to be
12643                                      * loaded at run-time, if needed */
12644                                     Perl_sv_catpvf(aTHX_ listsv, "!utf8::%s\n",
12645                                                                  Xname);
12646                                     runtime_posix_matches_above_Unicode = TRUE;
12647                                     if (LOC) {
12648                                         ANYOF_CLASS_SET(ret, namedclass);
12649                                     }
12650                                     else {
12651
12652                                         /* We want to match everything in
12653                                          * Latin1, except those things that
12654                                          * l1_source matches */
12655                                         SV* scratch_list = NULL;
12656                                         _invlist_subtract(PL_Latin1, l1_source,
12657                                                           &scratch_list);
12658
12659                                         /* Add the list from this class to the
12660                                          * running total */
12661                                         if (! posixes) {
12662                                             posixes = scratch_list;
12663                                         }
12664                                         else {
12665                                             _invlist_union(posixes,
12666                                                            scratch_list,
12667                                                            &posixes);
12668                                             SvREFCNT_dec_NN(scratch_list);
12669                                         }
12670                                         if (DEPENDS_SEMANTICS) {
12671                                             ANYOF_FLAGS(ret)
12672                                                   |= ANYOF_NON_UTF8_LATIN1_ALL;
12673                                         }
12674                                     }
12675                                 }
12676                             }
12677                             goto namedclass_done;
12678                         }
12679
12680                         /* Here, there is a swash loaded for the class.  If no
12681                          * inversion list for it yet, get it */
12682                         if (! PL_XPosix_ptrs[classnum]) {
12683                             PL_XPosix_ptrs[classnum]
12684                              = _swash_to_invlist(PL_utf8_swash_ptrs[classnum]);
12685                         }
12686                     }
12687
12688                     /* Here there is an inversion list already loaded for the
12689                      * entire class */
12690
12691                     if (namedclass % 2 == 0) {  /* A non-complemented class,
12692                                                    like ANYOF_PUNCT */
12693                         if (! LOC) {
12694                             /* For non-locale, just add it to any existing list
12695                              * */
12696                             _invlist_union(posixes,
12697                                            (AT_LEAST_ASCII_RESTRICTED)
12698                                                ? ascii_source
12699                                                : PL_XPosix_ptrs[classnum],
12700                                            &posixes);
12701                         }
12702                         else {  /* Locale */
12703                             SV* scratch_list = NULL;
12704
12705                             /* For above Latin1 code points, we use the full
12706                              * Unicode range */
12707                             _invlist_intersection(PL_AboveLatin1,
12708                                                   PL_XPosix_ptrs[classnum],
12709                                                   &scratch_list);
12710                             /* And set the output to it, adding instead if
12711                              * there already is an output.  Checking if
12712                              * 'posixes' is NULL first saves an extra clone.
12713                              * Its reference count will be decremented at the
12714                              * next union, etc, or if this is the only
12715                              * instance, at the end of the routine */
12716                             if (! posixes) {
12717                                 posixes = scratch_list;
12718                             }
12719                             else {
12720                                 _invlist_union(posixes, scratch_list, &posixes);
12721                                 SvREFCNT_dec_NN(scratch_list);
12722                             }
12723
12724 #ifndef HAS_ISBLANK
12725                             if (namedclass != ANYOF_BLANK) {
12726 #endif
12727                                 /* Set this class in the node for runtime
12728                                  * matching */
12729                                 ANYOF_CLASS_SET(ret, namedclass);
12730 #ifndef HAS_ISBLANK
12731                             }
12732                             else {
12733                                 /* No isblank(), use the hard-coded ASCII-range
12734                                  * blanks, adding them to the running total. */
12735
12736                                 _invlist_union(posixes, ascii_source, &posixes);
12737                             }
12738 #endif
12739                         }
12740                     }
12741                     else {  /* A complemented class, like ANYOF_NPUNCT */
12742                         if (! LOC) {
12743                             _invlist_union_complement_2nd(
12744                                                 posixes,
12745                                                 (AT_LEAST_ASCII_RESTRICTED)
12746                                                     ? ascii_source
12747                                                     : PL_XPosix_ptrs[classnum],
12748                                                 &posixes);
12749                             /* Under /d, everything in the upper half of the
12750                              * Latin1 range matches this complement */
12751                             if (DEPENDS_SEMANTICS) {
12752                                 ANYOF_FLAGS(ret) |= ANYOF_NON_UTF8_LATIN1_ALL;
12753                             }
12754                         }
12755                         else {  /* Locale */
12756                             SV* scratch_list = NULL;
12757                             _invlist_subtract(PL_AboveLatin1,
12758                                               PL_XPosix_ptrs[classnum],
12759                                               &scratch_list);
12760                             if (! posixes) {
12761                                 posixes = scratch_list;
12762                             }
12763                             else {
12764                                 _invlist_union(posixes, scratch_list, &posixes);
12765                                 SvREFCNT_dec_NN(scratch_list);
12766                             }
12767 #ifndef HAS_ISBLANK
12768                             if (namedclass != ANYOF_NBLANK) {
12769 #endif
12770                                 ANYOF_CLASS_SET(ret, namedclass);
12771 #ifndef HAS_ISBLANK
12772                             }
12773                             else {
12774                                 /* Get the list of all code points in Latin1
12775                                  * that are not ASCII blanks, and add them to
12776                                  * the running total */
12777                                 _invlist_subtract(PL_Latin1, ascii_source,
12778                                                   &scratch_list);
12779                                 _invlist_union(posixes, scratch_list, &posixes);
12780                                 SvREFCNT_dec_NN(scratch_list);
12781                             }
12782 #endif
12783                         }
12784                     }
12785                 }
12786               namedclass_done:
12787                 continue;   /* Go get next character */
12788             }
12789         } /* end of namedclass \blah */
12790
12791         /* Here, we have a single value.  If 'range' is set, it is the ending
12792          * of a range--check its validity.  Later, we will handle each
12793          * individual code point in the range.  If 'range' isn't set, this
12794          * could be the beginning of a range, so check for that by looking
12795          * ahead to see if the next real character to be processed is the range
12796          * indicator--the minus sign */
12797
12798         if (skip_white) {
12799             RExC_parse = regpatws(pRExC_state, RExC_parse,
12800                                 FALSE /* means don't recognize comments */);
12801         }
12802
12803         if (range) {
12804             if (prevvalue > value) /* b-a */ {
12805                 const int w = RExC_parse - rangebegin;
12806                 Simple_vFAIL4("Invalid [] range \"%*.*s\"", w, w, rangebegin);
12807                 range = 0; /* not a valid range */
12808             }
12809         }
12810         else {
12811             prevvalue = value; /* save the beginning of the potential range */
12812             if (! stop_at_1     /* Can't be a range if parsing just one thing */
12813                 && *RExC_parse == '-')
12814             {
12815                 char* next_char_ptr = RExC_parse + 1;
12816                 if (skip_white) {   /* Get the next real char after the '-' */
12817                     next_char_ptr = regpatws(pRExC_state,
12818                                              RExC_parse + 1,
12819                                              FALSE); /* means don't recognize
12820                                                         comments */
12821                 }
12822
12823                 /* If the '-' is at the end of the class (just before the ']',
12824                  * it is a literal minus; otherwise it is a range */
12825                 if (next_char_ptr < RExC_end && *next_char_ptr != ']') {
12826                     RExC_parse = next_char_ptr;
12827
12828                     /* a bad range like \w-, [:word:]- ? */
12829                     if (namedclass > OOB_NAMEDCLASS) {
12830                         if (strict || ckWARN(WARN_REGEXP)) {
12831                             const int w =
12832                                 RExC_parse >= rangebegin ?
12833                                 RExC_parse - rangebegin : 0;
12834                             if (strict) {
12835                                 vFAIL4("False [] range \"%*.*s\"",
12836                                     w, w, rangebegin);
12837                             }
12838                             else {
12839                                 vWARN4(RExC_parse,
12840                                     "False [] range \"%*.*s\"",
12841                                     w, w, rangebegin);
12842                             }
12843                         }
12844                         if (!SIZE_ONLY) {
12845                             cp_list = add_cp_to_invlist(cp_list, '-');
12846                         }
12847                         element_count++;
12848                     } else
12849                         range = 1;      /* yeah, it's a range! */
12850                     continue;   /* but do it the next time */
12851                 }
12852             }
12853         }
12854
12855         /* Here, <prevvalue> is the beginning of the range, if any; or <value>
12856          * if not */
12857
12858         /* non-Latin1 code point implies unicode semantics.  Must be set in
12859          * pass1 so is there for the whole of pass 2 */
12860         if (value > 255) {
12861             RExC_uni_semantics = 1;
12862         }
12863
12864         /* Ready to process either the single value, or the completed range.
12865          * For single-valued non-inverted ranges, we consider the possibility
12866          * of multi-char folds.  (We made a conscious decision to not do this
12867          * for the other cases because it can often lead to non-intuitive
12868          * results.  For example, you have the peculiar case that:
12869          *  "s s" =~ /^[^\xDF]+$/i => Y
12870          *  "ss"  =~ /^[^\xDF]+$/i => N
12871          *
12872          * See [perl #89750] */
12873         if (FOLD && allow_multi_folds && value == prevvalue) {
12874             if (value == LATIN_SMALL_LETTER_SHARP_S
12875                 || (value > 255 && _invlist_contains_cp(PL_HasMultiCharFold,
12876                                                         value)))
12877             {
12878                 /* Here <value> is indeed a multi-char fold.  Get what it is */
12879
12880                 U8 foldbuf[UTF8_MAXBYTES_CASE];
12881                 STRLEN foldlen;
12882
12883                 UV folded = _to_uni_fold_flags(
12884                                 value,
12885                                 foldbuf,
12886                                 &foldlen,
12887                                 FOLD_FLAGS_FULL
12888                                 | ((LOC) ?  FOLD_FLAGS_LOCALE
12889                                             : (ASCII_FOLD_RESTRICTED)
12890                                               ? FOLD_FLAGS_NOMIX_ASCII
12891                                               : 0)
12892                                 );
12893
12894                 /* Here, <folded> should be the first character of the
12895                  * multi-char fold of <value>, with <foldbuf> containing the
12896                  * whole thing.  But, if this fold is not allowed (because of
12897                  * the flags), <fold> will be the same as <value>, and should
12898                  * be processed like any other character, so skip the special
12899                  * handling */
12900                 if (folded != value) {
12901
12902                     /* Skip if we are recursed, currently parsing the class
12903                      * again.  Otherwise add this character to the list of
12904                      * multi-char folds. */
12905                     if (! RExC_in_multi_char_class) {
12906                         AV** this_array_ptr;
12907                         AV* this_array;
12908                         STRLEN cp_count = utf8_length(foldbuf,
12909                                                       foldbuf + foldlen);
12910                         SV* multi_fold = sv_2mortal(newSVpvn("", 0));
12911
12912                         Perl_sv_catpvf(aTHX_ multi_fold, "\\x{%"UVXf"}", value);
12913
12914
12915                         if (! multi_char_matches) {
12916                             multi_char_matches = newAV();
12917                         }
12918
12919                         /* <multi_char_matches> is actually an array of arrays.
12920                          * There will be one or two top-level elements: [2],
12921                          * and/or [3].  The [2] element is an array, each
12922                          * element thereof is a character which folds to two
12923                          * characters; likewise for [3].  (Unicode guarantees a
12924                          * maximum of 3 characters in any fold.)  When we
12925                          * rewrite the character class below, we will do so
12926                          * such that the longest folds are written first, so
12927                          * that it prefers the longest matching strings first.
12928                          * This is done even if it turns out that any
12929                          * quantifier is non-greedy, out of programmer
12930                          * laziness.  Tom Christiansen has agreed that this is
12931                          * ok.  This makes the test for the ligature 'ffi' come
12932                          * before the test for 'ff' */
12933                         if (av_exists(multi_char_matches, cp_count)) {
12934                             this_array_ptr = (AV**) av_fetch(multi_char_matches,
12935                                                              cp_count, FALSE);
12936                             this_array = *this_array_ptr;
12937                         }
12938                         else {
12939                             this_array = newAV();
12940                             av_store(multi_char_matches, cp_count,
12941                                      (SV*) this_array);
12942                         }
12943                         av_push(this_array, multi_fold);
12944                     }
12945
12946                     /* This element should not be processed further in this
12947                      * class */
12948                     element_count--;
12949                     value = save_value;
12950                     prevvalue = save_prevvalue;
12951                     continue;
12952                 }
12953             }
12954         }
12955
12956         /* Deal with this element of the class */
12957         if (! SIZE_ONLY) {
12958 #ifndef EBCDIC
12959             cp_list = _add_range_to_invlist(cp_list, prevvalue, value);
12960 #else
12961             SV* this_range = _new_invlist(1);
12962             _append_range_to_invlist(this_range, prevvalue, value);
12963
12964             /* In EBCDIC, the ranges 'A-Z' and 'a-z' are each not contiguous.
12965              * If this range was specified using something like 'i-j', we want
12966              * to include only the 'i' and the 'j', and not anything in
12967              * between, so exclude non-ASCII, non-alphabetics from it.
12968              * However, if the range was specified with something like
12969              * [\x89-\x91] or [\x89-j], all code points within it should be
12970              * included.  literal_endpoint==2 means both ends of the range used
12971              * a literal character, not \x{foo} */
12972             if (literal_endpoint == 2
12973                 && (prevvalue >= 'a' && value <= 'z')
12974                     || (prevvalue >= 'A' && value <= 'Z'))
12975             {
12976                 _invlist_intersection(this_range, PL_Posix_ptrs[_CC_ALPHA],
12977                                       &this_range);
12978             }
12979             _invlist_union(cp_list, this_range, &cp_list);
12980             literal_endpoint = 0;
12981 #endif
12982         }
12983
12984         range = 0; /* this range (if it was one) is done now */
12985     } /* End of loop through all the text within the brackets */
12986
12987     /* If anything in the class expands to more than one character, we have to
12988      * deal with them by building up a substitute parse string, and recursively
12989      * calling reg() on it, instead of proceeding */
12990     if (multi_char_matches) {
12991         SV * substitute_parse = newSVpvn_flags("?:", 2, SVs_TEMP);
12992         I32 cp_count;
12993         STRLEN len;
12994         char *save_end = RExC_end;
12995         char *save_parse = RExC_parse;
12996         bool first_time = TRUE;     /* First multi-char occurrence doesn't get
12997                                        a "|" */
12998         I32 reg_flags;
12999
13000         assert(! invert);
13001 #if 0   /* Have decided not to deal with multi-char folds in inverted classes,
13002            because too confusing */
13003         if (invert) {
13004             sv_catpv(substitute_parse, "(?:");
13005         }
13006 #endif
13007
13008         /* Look at the longest folds first */
13009         for (cp_count = av_len(multi_char_matches); cp_count > 0; cp_count--) {
13010
13011             if (av_exists(multi_char_matches, cp_count)) {
13012                 AV** this_array_ptr;
13013                 SV* this_sequence;
13014
13015                 this_array_ptr = (AV**) av_fetch(multi_char_matches,
13016                                                  cp_count, FALSE);
13017                 while ((this_sequence = av_pop(*this_array_ptr)) !=
13018                                                                 &PL_sv_undef)
13019                 {
13020                     if (! first_time) {
13021                         sv_catpv(substitute_parse, "|");
13022                     }
13023                     first_time = FALSE;
13024
13025                     sv_catpv(substitute_parse, SvPVX(this_sequence));
13026                 }
13027             }
13028         }
13029
13030         /* If the character class contains anything else besides these
13031          * multi-character folds, have to include it in recursive parsing */
13032         if (element_count) {
13033             sv_catpv(substitute_parse, "|[");
13034             sv_catpvn(substitute_parse, orig_parse, RExC_parse - orig_parse);
13035             sv_catpv(substitute_parse, "]");
13036         }
13037
13038         sv_catpv(substitute_parse, ")");
13039 #if 0
13040         if (invert) {
13041             /* This is a way to get the parse to skip forward a whole named
13042              * sequence instead of matching the 2nd character when it fails the
13043              * first */
13044             sv_catpv(substitute_parse, "(*THEN)(*SKIP)(*FAIL)|.)");
13045         }
13046 #endif
13047
13048         RExC_parse = SvPV(substitute_parse, len);
13049         RExC_end = RExC_parse + len;
13050         RExC_in_multi_char_class = 1;
13051         RExC_emit = (regnode *)orig_emit;
13052
13053         ret = reg(pRExC_state, 1, &reg_flags, depth+1);
13054
13055         *flagp |= reg_flags&(HASWIDTH|SIMPLE|SPSTART|POSTPONED|RESTART_UTF8);
13056
13057         RExC_parse = save_parse;
13058         RExC_end = save_end;
13059         RExC_in_multi_char_class = 0;
13060         SvREFCNT_dec_NN(multi_char_matches);
13061         return ret;
13062     }
13063
13064     /* If the character class contains only a single element, it may be
13065      * optimizable into another node type which is smaller and runs faster.
13066      * Check if this is the case for this class */
13067     if (element_count == 1 && ! ret_invlist) {
13068         U8 op = END;
13069         U8 arg = 0;
13070
13071         if (namedclass > OOB_NAMEDCLASS) { /* this is a named class, like \w or
13072                                               [:digit:] or \p{foo} */
13073
13074             /* All named classes are mapped into POSIXish nodes, with its FLAG
13075              * argument giving which class it is */
13076             switch ((I32)namedclass) {
13077                 case ANYOF_UNIPROP:
13078                     break;
13079
13080                 /* These don't depend on the charset modifiers.  They always
13081                  * match under /u rules */
13082                 case ANYOF_NHORIZWS:
13083                 case ANYOF_HORIZWS:
13084                     namedclass = ANYOF_BLANK + namedclass - ANYOF_HORIZWS;
13085                     /* FALLTHROUGH */
13086
13087                 case ANYOF_NVERTWS:
13088                 case ANYOF_VERTWS:
13089                     op = POSIXU;
13090                     goto join_posix;
13091
13092                 /* The actual POSIXish node for all the rest depends on the
13093                  * charset modifier.  The ones in the first set depend only on
13094                  * ASCII or, if available on this platform, locale */
13095                 case ANYOF_ASCII:
13096                 case ANYOF_NASCII:
13097 #ifdef HAS_ISASCII
13098                     op = (LOC) ? POSIXL : POSIXA;
13099 #else
13100                     op = POSIXA;
13101 #endif
13102                     goto join_posix;
13103
13104                 case ANYOF_NCASED:
13105                 case ANYOF_LOWER:
13106                 case ANYOF_NLOWER:
13107                 case ANYOF_UPPER:
13108                 case ANYOF_NUPPER:
13109                     /* under /a could be alpha */
13110                     if (FOLD) {
13111                         if (ASCII_RESTRICTED) {
13112                             namedclass = ANYOF_ALPHA + (namedclass % 2);
13113                         }
13114                         else if (! LOC) {
13115                             break;
13116                         }
13117                     }
13118                     /* FALLTHROUGH */
13119
13120                 /* The rest have more possibilities depending on the charset.
13121                  * We take advantage of the enum ordering of the charset
13122                  * modifiers to get the exact node type, */
13123                 default:
13124                     op = POSIXD + get_regex_charset(RExC_flags);
13125                     if (op > POSIXA) { /* /aa is same as /a */
13126                         op = POSIXA;
13127                     }
13128 #ifndef HAS_ISBLANK
13129                     if (op == POSIXL
13130                         && (namedclass == ANYOF_BLANK
13131                             || namedclass == ANYOF_NBLANK))
13132                     {
13133                         op = POSIXA;
13134                     }
13135 #endif
13136
13137                 join_posix:
13138                     /* The odd numbered ones are the complements of the
13139                      * next-lower even number one */
13140                     if (namedclass % 2 == 1) {
13141                         invert = ! invert;
13142                         namedclass--;
13143                     }
13144                     arg = namedclass_to_classnum(namedclass);
13145                     break;
13146             }
13147         }
13148         else if (value == prevvalue) {
13149
13150             /* Here, the class consists of just a single code point */
13151
13152             if (invert) {
13153                 if (! LOC && value == '\n') {
13154                     op = REG_ANY; /* Optimize [^\n] */
13155                     *flagp |= HASWIDTH|SIMPLE;
13156                     RExC_naughty++;
13157                 }
13158             }
13159             else if (value < 256 || UTF) {
13160
13161                 /* Optimize a single value into an EXACTish node, but not if it
13162                  * would require converting the pattern to UTF-8. */
13163                 op = compute_EXACTish(pRExC_state);
13164             }
13165         } /* Otherwise is a range */
13166         else if (! LOC) {   /* locale could vary these */
13167             if (prevvalue == '0') {
13168                 if (value == '9') {
13169                     arg = _CC_DIGIT;
13170                     op = POSIXA;
13171                 }
13172             }
13173         }
13174
13175         /* Here, we have changed <op> away from its initial value iff we found
13176          * an optimization */
13177         if (op != END) {
13178
13179             /* Throw away this ANYOF regnode, and emit the calculated one,
13180              * which should correspond to the beginning, not current, state of
13181              * the parse */
13182             const char * cur_parse = RExC_parse;
13183             RExC_parse = (char *)orig_parse;
13184             if ( SIZE_ONLY) {
13185                 if (! LOC) {
13186
13187                     /* To get locale nodes to not use the full ANYOF size would
13188                      * require moving the code above that writes the portions
13189                      * of it that aren't in other nodes to after this point.
13190                      * e.g.  ANYOF_CLASS_SET */
13191                     RExC_size = orig_size;
13192                 }
13193             }
13194             else {
13195                 RExC_emit = (regnode *)orig_emit;
13196                 if (PL_regkind[op] == POSIXD) {
13197                     if (invert) {
13198                         op += NPOSIXD - POSIXD;
13199                     }
13200                 }
13201             }
13202
13203             ret = reg_node(pRExC_state, op);
13204
13205             if (PL_regkind[op] == POSIXD || PL_regkind[op] == NPOSIXD) {
13206                 if (! SIZE_ONLY) {
13207                     FLAGS(ret) = arg;
13208                 }
13209                 *flagp |= HASWIDTH|SIMPLE;
13210             }
13211             else if (PL_regkind[op] == EXACT) {
13212                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, 0, value);
13213             }
13214
13215             RExC_parse = (char *) cur_parse;
13216
13217             SvREFCNT_dec(posixes);
13218             SvREFCNT_dec(cp_list);
13219             return ret;
13220         }
13221     }
13222
13223     if (SIZE_ONLY)
13224         return ret;
13225     /****** !SIZE_ONLY (Pass 2) AFTER HERE *********/
13226
13227     /* If folding, we calculate all characters that could fold to or from the
13228      * ones already on the list */
13229     if (FOLD && cp_list) {
13230         UV start, end;  /* End points of code point ranges */
13231
13232         SV* fold_intersection = NULL;
13233
13234         /* If the highest code point is within Latin1, we can use the
13235          * compiled-in Alphas list, and not have to go out to disk.  This
13236          * yields two false positives, the masculine and feminine ordinal
13237          * indicators, which are weeded out below using the
13238          * IS_IN_SOME_FOLD_L1() macro */
13239         if (invlist_highest(cp_list) < 256) {
13240             _invlist_intersection(PL_L1Posix_ptrs[_CC_ALPHA], cp_list,
13241                                                            &fold_intersection);
13242         }
13243         else {
13244
13245             /* Here, there are non-Latin1 code points, so we will have to go
13246              * fetch the list of all the characters that participate in folds
13247              */
13248             if (! PL_utf8_foldable) {
13249                 SV* swash = swash_init("utf8", "_Perl_Any_Folds",
13250                                        &PL_sv_undef, 1, 0);
13251                 PL_utf8_foldable = _get_swash_invlist(swash);
13252                 SvREFCNT_dec_NN(swash);
13253             }
13254
13255             /* This is a hash that for a particular fold gives all characters
13256              * that are involved in it */
13257             if (! PL_utf8_foldclosures) {
13258
13259                 /* If we were unable to find any folds, then we likely won't be
13260                  * able to find the closures.  So just create an empty list.
13261                  * Folding will effectively be restricted to the non-Unicode
13262                  * rules hard-coded into Perl.  (This case happens legitimately
13263                  * during compilation of Perl itself before the Unicode tables
13264                  * are generated) */
13265                 if (_invlist_len(PL_utf8_foldable) == 0) {
13266                     PL_utf8_foldclosures = newHV();
13267                 }
13268                 else {
13269                     /* If the folds haven't been read in, call a fold function
13270                      * to force that */
13271                     if (! PL_utf8_tofold) {
13272                         U8 dummy[UTF8_MAXBYTES+1];
13273
13274                         /* This string is just a short named one above \xff */
13275                         to_utf8_fold((U8*) HYPHEN_UTF8, dummy, NULL);
13276                         assert(PL_utf8_tofold); /* Verify that worked */
13277                     }
13278                     PL_utf8_foldclosures =
13279                                     _swash_inversion_hash(PL_utf8_tofold);
13280                 }
13281             }
13282
13283             /* Only the characters in this class that participate in folds need
13284              * be checked.  Get the intersection of this class and all the
13285              * possible characters that are foldable.  This can quickly narrow
13286              * down a large class */
13287             _invlist_intersection(PL_utf8_foldable, cp_list,
13288                                   &fold_intersection);
13289         }
13290
13291         /* Now look at the foldable characters in this class individually */
13292         invlist_iterinit(fold_intersection);
13293         while (invlist_iternext(fold_intersection, &start, &end)) {
13294             UV j;
13295
13296             /* Locale folding for Latin1 characters is deferred until runtime */
13297             if (LOC && start < 256) {
13298                 start = 256;
13299             }
13300
13301             /* Look at every character in the range */
13302             for (j = start; j <= end; j++) {
13303
13304                 U8 foldbuf[UTF8_MAXBYTES_CASE+1];
13305                 STRLEN foldlen;
13306                 SV** listp;
13307
13308                 if (j < 256) {
13309
13310                     /* We have the latin1 folding rules hard-coded here so that
13311                      * an innocent-looking character class, like /[ks]/i won't
13312                      * have to go out to disk to find the possible matches.
13313                      * XXX It would be better to generate these via regen, in
13314                      * case a new version of the Unicode standard adds new
13315                      * mappings, though that is not really likely, and may be
13316                      * caught by the default: case of the switch below. */
13317
13318                     if (IS_IN_SOME_FOLD_L1(j)) {
13319
13320                         /* ASCII is always matched; non-ASCII is matched only
13321                          * under Unicode rules */
13322                         if (isASCII(j) || AT_LEAST_UNI_SEMANTICS) {
13323                             cp_list =
13324                                 add_cp_to_invlist(cp_list, PL_fold_latin1[j]);
13325                         }
13326                         else {
13327                             depends_list =
13328                              add_cp_to_invlist(depends_list, PL_fold_latin1[j]);
13329                         }
13330                     }
13331
13332                     if (HAS_NONLATIN1_FOLD_CLOSURE(j)
13333                         && (! isASCII(j) || ! ASCII_FOLD_RESTRICTED))
13334                     {
13335                         /* Certain Latin1 characters have matches outside
13336                          * Latin1.  To get here, <j> is one of those
13337                          * characters.   None of these matches is valid for
13338                          * ASCII characters under /aa, which is why the 'if'
13339                          * just above excludes those.  These matches only
13340                          * happen when the target string is utf8.  The code
13341                          * below adds the single fold closures for <j> to the
13342                          * inversion list. */
13343                         switch (j) {
13344                             case 'k':
13345                             case 'K':
13346                                 cp_list =
13347                                     add_cp_to_invlist(cp_list, KELVIN_SIGN);
13348                                 break;
13349                             case 's':
13350                             case 'S':
13351                                 cp_list = add_cp_to_invlist(cp_list,
13352                                                     LATIN_SMALL_LETTER_LONG_S);
13353                                 break;
13354                             case MICRO_SIGN:
13355                                 cp_list = add_cp_to_invlist(cp_list,
13356                                                     GREEK_CAPITAL_LETTER_MU);
13357                                 cp_list = add_cp_to_invlist(cp_list,
13358                                                     GREEK_SMALL_LETTER_MU);
13359                                 break;
13360                             case LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE:
13361                             case LATIN_SMALL_LETTER_A_WITH_RING_ABOVE:
13362                                 cp_list =
13363                                     add_cp_to_invlist(cp_list, ANGSTROM_SIGN);
13364                                 break;
13365                             case LATIN_SMALL_LETTER_Y_WITH_DIAERESIS:
13366                                 cp_list = add_cp_to_invlist(cp_list,
13367                                         LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS);
13368                                 break;
13369                             case LATIN_SMALL_LETTER_SHARP_S:
13370                                 cp_list = add_cp_to_invlist(cp_list,
13371                                                 LATIN_CAPITAL_LETTER_SHARP_S);
13372                                 break;
13373                             case 'F': case 'f':
13374                             case 'I': case 'i':
13375                             case 'L': case 'l':
13376                             case 'T': case 't':
13377                             case 'A': case 'a':
13378                             case 'H': case 'h':
13379                             case 'J': case 'j':
13380                             case 'N': case 'n':
13381                             case 'W': case 'w':
13382                             case 'Y': case 'y':
13383                                 /* These all are targets of multi-character
13384                                  * folds from code points that require UTF8 to
13385                                  * express, so they can't match unless the
13386                                  * target string is in UTF-8, so no action here
13387                                  * is necessary, as regexec.c properly handles
13388                                  * the general case for UTF-8 matching and
13389                                  * multi-char folds */
13390                                 break;
13391                             default:
13392                                 /* Use deprecated warning to increase the
13393                                  * chances of this being output */
13394                                 ckWARN2regdep(RExC_parse, "Perl folding rules are not up-to-date for 0x%"UVXf"; please use the perlbug utility to report;", j);
13395                                 break;
13396                         }
13397                     }
13398                     continue;
13399                 }
13400
13401                 /* Here is an above Latin1 character.  We don't have the rules
13402                  * hard-coded for it.  First, get its fold.  This is the simple
13403                  * fold, as the multi-character folds have been handled earlier
13404                  * and separated out */
13405                 _to_uni_fold_flags(j, foldbuf, &foldlen,
13406                                                ((LOC)
13407                                                ? FOLD_FLAGS_LOCALE
13408                                                : (ASCII_FOLD_RESTRICTED)
13409                                                   ? FOLD_FLAGS_NOMIX_ASCII
13410                                                   : 0));
13411
13412                 /* Single character fold of above Latin1.  Add everything in
13413                  * its fold closure to the list that this node should match.
13414                  * The fold closures data structure is a hash with the keys
13415                  * being the UTF-8 of every character that is folded to, like
13416                  * 'k', and the values each an array of all code points that
13417                  * fold to its key.  e.g. [ 'k', 'K', KELVIN_SIGN ].
13418                  * Multi-character folds are not included */
13419                 if ((listp = hv_fetch(PL_utf8_foldclosures,
13420                                       (char *) foldbuf, foldlen, FALSE)))
13421                 {
13422                     AV* list = (AV*) *listp;
13423                     IV k;
13424                     for (k = 0; k <= av_len(list); k++) {
13425                         SV** c_p = av_fetch(list, k, FALSE);
13426                         UV c;
13427                         if (c_p == NULL) {
13428                             Perl_croak(aTHX_ "panic: invalid PL_utf8_foldclosures structure");
13429                         }
13430                         c = SvUV(*c_p);
13431
13432                         /* /aa doesn't allow folds between ASCII and non-; /l
13433                          * doesn't allow them between above and below 256 */
13434                         if ((ASCII_FOLD_RESTRICTED
13435                                   && (isASCII(c) != isASCII(j)))
13436                             || (LOC && ((c < 256) != (j < 256))))
13437                         {
13438                             continue;
13439                         }
13440
13441                         /* Folds involving non-ascii Latin1 characters
13442                          * under /d are added to a separate list */
13443                         if (isASCII(c) || c > 255 || AT_LEAST_UNI_SEMANTICS)
13444                         {
13445                             cp_list = add_cp_to_invlist(cp_list, c);
13446                         }
13447                         else {
13448                           depends_list = add_cp_to_invlist(depends_list, c);
13449                         }
13450                     }
13451                 }
13452             }
13453         }
13454         SvREFCNT_dec_NN(fold_intersection);
13455     }
13456
13457     /* And combine the result (if any) with any inversion list from posix
13458      * classes.  The lists are kept separate up to now because we don't want to
13459      * fold the classes (folding of those is automatically handled by the swash
13460      * fetching code) */
13461     if (posixes) {
13462         if (! DEPENDS_SEMANTICS) {
13463             if (cp_list) {
13464                 _invlist_union(cp_list, posixes, &cp_list);
13465                 SvREFCNT_dec_NN(posixes);
13466             }
13467             else {
13468                 cp_list = posixes;
13469             }
13470         }
13471         else {
13472             /* Under /d, we put into a separate list the Latin1 things that
13473              * match only when the target string is utf8 */
13474             SV* nonascii_but_latin1_properties = NULL;
13475             _invlist_intersection(posixes, PL_Latin1,
13476                                   &nonascii_but_latin1_properties);
13477             _invlist_subtract(nonascii_but_latin1_properties, PL_ASCII,
13478                               &nonascii_but_latin1_properties);
13479             _invlist_subtract(posixes, nonascii_but_latin1_properties,
13480                               &posixes);
13481             if (cp_list) {
13482                 _invlist_union(cp_list, posixes, &cp_list);
13483                 SvREFCNT_dec_NN(posixes);
13484             }
13485             else {
13486                 cp_list = posixes;
13487             }
13488
13489             if (depends_list) {
13490                 _invlist_union(depends_list, nonascii_but_latin1_properties,
13491                                &depends_list);
13492                 SvREFCNT_dec_NN(nonascii_but_latin1_properties);
13493             }
13494             else {
13495                 depends_list = nonascii_but_latin1_properties;
13496             }
13497         }
13498     }
13499
13500     /* And combine the result (if any) with any inversion list from properties.
13501      * The lists are kept separate up to now so that we can distinguish the two
13502      * in regards to matching above-Unicode.  A run-time warning is generated
13503      * if a Unicode property is matched against a non-Unicode code point. But,
13504      * we allow user-defined properties to match anything, without any warning,
13505      * and we also suppress the warning if there is a portion of the character
13506      * class that isn't a Unicode property, and which matches above Unicode, \W
13507      * or [\x{110000}] for example.
13508      * (Note that in this case, unlike the Posix one above, there is no
13509      * <depends_list>, because having a Unicode property forces Unicode
13510      * semantics */
13511     if (properties) {
13512         bool warn_super = ! has_user_defined_property;
13513         if (cp_list) {
13514
13515             /* If it matters to the final outcome, see if a non-property
13516              * component of the class matches above Unicode.  If so, the
13517              * warning gets suppressed.  This is true even if just a single
13518              * such code point is specified, as though not strictly correct if
13519              * another such code point is matched against, the fact that they
13520              * are using above-Unicode code points indicates they should know
13521              * the issues involved */
13522             if (warn_super) {
13523                 bool non_prop_matches_above_Unicode =
13524                             runtime_posix_matches_above_Unicode
13525                             | (invlist_highest(cp_list) > PERL_UNICODE_MAX);
13526                 if (invert) {
13527                     non_prop_matches_above_Unicode =
13528                                             !  non_prop_matches_above_Unicode;
13529                 }
13530                 warn_super = ! non_prop_matches_above_Unicode;
13531             }
13532
13533             _invlist_union(properties, cp_list, &cp_list);
13534             SvREFCNT_dec_NN(properties);
13535         }
13536         else {
13537             cp_list = properties;
13538         }
13539
13540         if (warn_super) {
13541             OP(ret) = ANYOF_WARN_SUPER;
13542         }
13543     }
13544
13545     /* Here, we have calculated what code points should be in the character
13546      * class.
13547      *
13548      * Now we can see about various optimizations.  Fold calculation (which we
13549      * did above) needs to take place before inversion.  Otherwise /[^k]/i
13550      * would invert to include K, which under /i would match k, which it
13551      * shouldn't.  Therefore we can't invert folded locale now, as it won't be
13552      * folded until runtime */
13553
13554     /* Optimize inverted simple patterns (e.g. [^a-z]) when everything is known
13555      * at compile time.  Besides not inverting folded locale now, we can't
13556      * invert if there are things such as \w, which aren't known until runtime
13557      * */
13558     if (invert
13559         && ! (LOC && (FOLD || (ANYOF_FLAGS(ret) & ANYOF_CLASS)))
13560         && ! depends_list
13561         && ! HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
13562     {
13563         _invlist_invert(cp_list);
13564
13565         /* Any swash can't be used as-is, because we've inverted things */
13566         if (swash) {
13567             SvREFCNT_dec_NN(swash);
13568             swash = NULL;
13569         }
13570
13571         /* Clear the invert flag since have just done it here */
13572         invert = FALSE;
13573     }
13574
13575     if (ret_invlist) {
13576         *ret_invlist = cp_list;
13577
13578         /* Discard the generated node */
13579         if (SIZE_ONLY) {
13580             RExC_size = orig_size;
13581         }
13582         else {
13583             RExC_emit = orig_emit;
13584         }
13585         return orig_emit;
13586     }
13587
13588     /* If we didn't do folding, it's because some information isn't available
13589      * until runtime; set the run-time fold flag for these.  (We don't have to
13590      * worry about properties folding, as that is taken care of by the swash
13591      * fetching) */
13592     if (FOLD && LOC)
13593     {
13594        ANYOF_FLAGS(ret) |= ANYOF_LOC_FOLD;
13595     }
13596
13597     /* Some character classes are equivalent to other nodes.  Such nodes take
13598      * up less room and generally fewer operations to execute than ANYOF nodes.
13599      * Above, we checked for and optimized into some such equivalents for
13600      * certain common classes that are easy to test.  Getting to this point in
13601      * the code means that the class didn't get optimized there.  Since this
13602      * code is only executed in Pass 2, it is too late to save space--it has
13603      * been allocated in Pass 1, and currently isn't given back.  But turning
13604      * things into an EXACTish node can allow the optimizer to join it to any
13605      * adjacent such nodes.  And if the class is equivalent to things like /./,
13606      * expensive run-time swashes can be avoided.  Now that we have more
13607      * complete information, we can find things necessarily missed by the
13608      * earlier code.  I (khw) am not sure how much to look for here.  It would
13609      * be easy, but perhaps too slow, to check any candidates against all the
13610      * node types they could possibly match using _invlistEQ(). */
13611
13612     if (cp_list
13613         && ! invert
13614         && ! depends_list
13615         && ! (ANYOF_FLAGS(ret) & ANYOF_CLASS)
13616         && ! HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
13617     {
13618         UV start, end;
13619         U8 op = END;  /* The optimzation node-type */
13620         const char * cur_parse= RExC_parse;
13621
13622         invlist_iterinit(cp_list);
13623         if (! invlist_iternext(cp_list, &start, &end)) {
13624
13625             /* Here, the list is empty.  This happens, for example, when a
13626              * Unicode property is the only thing in the character class, and
13627              * it doesn't match anything.  (perluniprops.pod notes such
13628              * properties) */
13629             op = OPFAIL;
13630             *flagp |= HASWIDTH|SIMPLE;
13631         }
13632         else if (start == end) {    /* The range is a single code point */
13633             if (! invlist_iternext(cp_list, &start, &end)
13634
13635                     /* Don't do this optimization if it would require changing
13636                      * the pattern to UTF-8 */
13637                 && (start < 256 || UTF))
13638             {
13639                 /* Here, the list contains a single code point.  Can optimize
13640                  * into an EXACT node */
13641
13642                 value = start;
13643
13644                 if (! FOLD) {
13645                     op = EXACT;
13646                 }
13647                 else if (LOC) {
13648
13649                     /* A locale node under folding with one code point can be
13650                      * an EXACTFL, as its fold won't be calculated until
13651                      * runtime */
13652                     op = EXACTFL;
13653                 }
13654                 else {
13655
13656                     /* Here, we are generally folding, but there is only one
13657                      * code point to match.  If we have to, we use an EXACT
13658                      * node, but it would be better for joining with adjacent
13659                      * nodes in the optimization pass if we used the same
13660                      * EXACTFish node that any such are likely to be.  We can
13661                      * do this iff the code point doesn't participate in any
13662                      * folds.  For example, an EXACTF of a colon is the same as
13663                      * an EXACT one, since nothing folds to or from a colon. */
13664                     if (value < 256) {
13665                         if (IS_IN_SOME_FOLD_L1(value)) {
13666                             op = EXACT;
13667                         }
13668                     }
13669                     else {
13670                         if (! PL_utf8_foldable) {
13671                             SV* swash = swash_init("utf8", "_Perl_Any_Folds",
13672                                                 &PL_sv_undef, 1, 0);
13673                             PL_utf8_foldable = _get_swash_invlist(swash);
13674                             SvREFCNT_dec_NN(swash);
13675                         }
13676                         if (_invlist_contains_cp(PL_utf8_foldable, value)) {
13677                             op = EXACT;
13678                         }
13679                     }
13680
13681                     /* If we haven't found the node type, above, it means we
13682                      * can use the prevailing one */
13683                     if (op == END) {
13684                         op = compute_EXACTish(pRExC_state);
13685                     }
13686                 }
13687             }
13688         }
13689         else if (start == 0) {
13690             if (end == UV_MAX) {
13691                 op = SANY;
13692                 *flagp |= HASWIDTH|SIMPLE;
13693                 RExC_naughty++;
13694             }
13695             else if (end == '\n' - 1
13696                     && invlist_iternext(cp_list, &start, &end)
13697                     && start == '\n' + 1 && end == UV_MAX)
13698             {
13699                 op = REG_ANY;
13700                 *flagp |= HASWIDTH|SIMPLE;
13701                 RExC_naughty++;
13702             }
13703         }
13704         invlist_iterfinish(cp_list);
13705
13706         if (op != END) {
13707             RExC_parse = (char *)orig_parse;
13708             RExC_emit = (regnode *)orig_emit;
13709
13710             ret = reg_node(pRExC_state, op);
13711
13712             RExC_parse = (char *)cur_parse;
13713
13714             if (PL_regkind[op] == EXACT) {
13715                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, 0, value);
13716             }
13717
13718             SvREFCNT_dec_NN(cp_list);
13719             return ret;
13720         }
13721     }
13722
13723     /* Here, <cp_list> contains all the code points we can determine at
13724      * compile time that match under all conditions.  Go through it, and
13725      * for things that belong in the bitmap, put them there, and delete from
13726      * <cp_list>.  While we are at it, see if everything above 255 is in the
13727      * list, and if so, set a flag to speed up execution */
13728     ANYOF_BITMAP_ZERO(ret);
13729     if (cp_list) {
13730
13731         /* This gets set if we actually need to modify things */
13732         bool change_invlist = FALSE;
13733
13734         UV start, end;
13735
13736         /* Start looking through <cp_list> */
13737         invlist_iterinit(cp_list);
13738         while (invlist_iternext(cp_list, &start, &end)) {
13739             UV high;
13740             int i;
13741
13742             if (end == UV_MAX && start <= 256) {
13743                 ANYOF_FLAGS(ret) |= ANYOF_UNICODE_ALL;
13744             }
13745
13746             /* Quit if are above what we should change */
13747             if (start > 255) {
13748                 break;
13749             }
13750
13751             change_invlist = TRUE;
13752
13753             /* Set all the bits in the range, up to the max that we are doing */
13754             high = (end < 255) ? end : 255;
13755             for (i = start; i <= (int) high; i++) {
13756                 if (! ANYOF_BITMAP_TEST(ret, i)) {
13757                     ANYOF_BITMAP_SET(ret, i);
13758                     prevvalue = value;
13759                     value = i;
13760                 }
13761             }
13762         }
13763         invlist_iterfinish(cp_list);
13764
13765         /* Done with loop; remove any code points that are in the bitmap from
13766          * <cp_list> */
13767         if (change_invlist) {
13768             _invlist_subtract(cp_list, PL_Latin1, &cp_list);
13769         }
13770
13771         /* If have completely emptied it, remove it completely */
13772         if (_invlist_len(cp_list) == 0) {
13773             SvREFCNT_dec_NN(cp_list);
13774             cp_list = NULL;
13775         }
13776     }
13777
13778     if (invert) {
13779         ANYOF_FLAGS(ret) |= ANYOF_INVERT;
13780     }
13781
13782     /* Here, the bitmap has been populated with all the Latin1 code points that
13783      * always match.  Can now add to the overall list those that match only
13784      * when the target string is UTF-8 (<depends_list>). */
13785     if (depends_list) {
13786         if (cp_list) {
13787             _invlist_union(cp_list, depends_list, &cp_list);
13788             SvREFCNT_dec_NN(depends_list);
13789         }
13790         else {
13791             cp_list = depends_list;
13792         }
13793     }
13794
13795     /* If there is a swash and more than one element, we can't use the swash in
13796      * the optimization below. */
13797     if (swash && element_count > 1) {
13798         SvREFCNT_dec_NN(swash);
13799         swash = NULL;
13800     }
13801
13802     if (! cp_list
13803         && ! HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
13804     {
13805         ARG_SET(ret, ANYOF_NONBITMAP_EMPTY);
13806     }
13807     else {
13808         /* av[0] stores the character class description in its textual form:
13809          *       used later (regexec.c:Perl_regclass_swash()) to initialize the
13810          *       appropriate swash, and is also useful for dumping the regnode.
13811          * av[1] if NULL, is a placeholder to later contain the swash computed
13812          *       from av[0].  But if no further computation need be done, the
13813          *       swash is stored there now.
13814          * av[2] stores the cp_list inversion list for use in addition or
13815          *       instead of av[0]; used only if av[1] is NULL
13816          * av[3] is set if any component of the class is from a user-defined
13817          *       property; used only if av[1] is NULL */
13818         AV * const av = newAV();
13819         SV *rv;
13820
13821         av_store(av, 0, (HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
13822                         ? SvREFCNT_inc(listsv) : &PL_sv_undef);
13823         if (swash) {
13824             av_store(av, 1, swash);
13825             SvREFCNT_dec_NN(cp_list);
13826         }
13827         else {
13828             av_store(av, 1, NULL);
13829             if (cp_list) {
13830                 av_store(av, 2, cp_list);
13831                 av_store(av, 3, newSVuv(has_user_defined_property));
13832             }
13833         }
13834
13835         rv = newRV_noinc(MUTABLE_SV(av));
13836         n = add_data(pRExC_state, 1, "s");
13837         RExC_rxi->data->data[n] = (void*)rv;
13838         ARG_SET(ret, n);
13839     }
13840
13841     *flagp |= HASWIDTH|SIMPLE;
13842     return ret;
13843 }
13844 #undef HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION
13845
13846
13847 /* reg_skipcomment()
13848
13849    Absorbs an /x style # comments from the input stream.
13850    Returns true if there is more text remaining in the stream.
13851    Will set the REG_SEEN_RUN_ON_COMMENT flag if the comment
13852    terminates the pattern without including a newline.
13853
13854    Note its the callers responsibility to ensure that we are
13855    actually in /x mode
13856
13857 */
13858
13859 STATIC bool
13860 S_reg_skipcomment(pTHX_ RExC_state_t *pRExC_state)
13861 {
13862     bool ended = 0;
13863
13864     PERL_ARGS_ASSERT_REG_SKIPCOMMENT;
13865
13866     while (RExC_parse < RExC_end)
13867         if (*RExC_parse++ == '\n') {
13868             ended = 1;
13869             break;
13870         }
13871     if (!ended) {
13872         /* we ran off the end of the pattern without ending
13873            the comment, so we have to add an \n when wrapping */
13874         RExC_seen |= REG_SEEN_RUN_ON_COMMENT;
13875         return 0;
13876     } else
13877         return 1;
13878 }
13879
13880 /* nextchar()
13881
13882    Advances the parse position, and optionally absorbs
13883    "whitespace" from the inputstream.
13884
13885    Without /x "whitespace" means (?#...) style comments only,
13886    with /x this means (?#...) and # comments and whitespace proper.
13887
13888    Returns the RExC_parse point from BEFORE the scan occurs.
13889
13890    This is the /x friendly way of saying RExC_parse++.
13891 */
13892
13893 STATIC char*
13894 S_nextchar(pTHX_ RExC_state_t *pRExC_state)
13895 {
13896     char* const retval = RExC_parse++;
13897
13898     PERL_ARGS_ASSERT_NEXTCHAR;
13899
13900     for (;;) {
13901         if (RExC_end - RExC_parse >= 3
13902             && *RExC_parse == '('
13903             && RExC_parse[1] == '?'
13904             && RExC_parse[2] == '#')
13905         {
13906             while (*RExC_parse != ')') {
13907                 if (RExC_parse == RExC_end)
13908                     FAIL("Sequence (?#... not terminated");
13909                 RExC_parse++;
13910             }
13911             RExC_parse++;
13912             continue;
13913         }
13914         if (RExC_flags & RXf_PMf_EXTENDED) {
13915             if (isSPACE(*RExC_parse)) {
13916                 RExC_parse++;
13917                 continue;
13918             }
13919             else if (*RExC_parse == '#') {
13920                 if ( reg_skipcomment( pRExC_state ) )
13921                     continue;
13922             }
13923         }
13924         return retval;
13925     }
13926 }
13927
13928 /*
13929 - reg_node - emit a node
13930 */
13931 STATIC regnode *                        /* Location. */
13932 S_reg_node(pTHX_ RExC_state_t *pRExC_state, U8 op)
13933 {
13934     dVAR;
13935     regnode *ptr;
13936     regnode * const ret = RExC_emit;
13937     GET_RE_DEBUG_FLAGS_DECL;
13938
13939     PERL_ARGS_ASSERT_REG_NODE;
13940
13941     if (SIZE_ONLY) {
13942         SIZE_ALIGN(RExC_size);
13943         RExC_size += 1;
13944         return(ret);
13945     }
13946     if (RExC_emit >= RExC_emit_bound)
13947         Perl_croak(aTHX_ "panic: reg_node overrun trying to emit %d, %p>=%p",
13948                    op, RExC_emit, RExC_emit_bound);
13949
13950     NODE_ALIGN_FILL(ret);
13951     ptr = ret;
13952     FILL_ADVANCE_NODE(ptr, op);
13953 #ifdef RE_TRACK_PATTERN_OFFSETS
13954     if (RExC_offsets) {         /* MJD */
13955         MJD_OFFSET_DEBUG(("%s:%d: (op %s) %s %"UVuf" (len %"UVuf") (max %"UVuf").\n", 
13956               "reg_node", __LINE__, 
13957               PL_reg_name[op],
13958               (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0] 
13959                 ? "Overwriting end of array!\n" : "OK",
13960               (UV)(RExC_emit - RExC_emit_start),
13961               (UV)(RExC_parse - RExC_start),
13962               (UV)RExC_offsets[0])); 
13963         Set_Node_Offset(RExC_emit, RExC_parse + (op == END));
13964     }
13965 #endif
13966     RExC_emit = ptr;
13967     return(ret);
13968 }
13969
13970 /*
13971 - reganode - emit a node with an argument
13972 */
13973 STATIC regnode *                        /* Location. */
13974 S_reganode(pTHX_ RExC_state_t *pRExC_state, U8 op, U32 arg)
13975 {
13976     dVAR;
13977     regnode *ptr;
13978     regnode * const ret = RExC_emit;
13979     GET_RE_DEBUG_FLAGS_DECL;
13980
13981     PERL_ARGS_ASSERT_REGANODE;
13982
13983     if (SIZE_ONLY) {
13984         SIZE_ALIGN(RExC_size);
13985         RExC_size += 2;
13986         /* 
13987            We can't do this:
13988            
13989            assert(2==regarglen[op]+1); 
13990
13991            Anything larger than this has to allocate the extra amount.
13992            If we changed this to be:
13993            
13994            RExC_size += (1 + regarglen[op]);
13995            
13996            then it wouldn't matter. Its not clear what side effect
13997            might come from that so its not done so far.
13998            -- dmq
13999         */
14000         return(ret);
14001     }
14002     if (RExC_emit >= RExC_emit_bound)
14003         Perl_croak(aTHX_ "panic: reg_node overrun trying to emit %d, %p>=%p",
14004                    op, RExC_emit, RExC_emit_bound);
14005
14006     NODE_ALIGN_FILL(ret);
14007     ptr = ret;
14008     FILL_ADVANCE_NODE_ARG(ptr, op, arg);
14009 #ifdef RE_TRACK_PATTERN_OFFSETS
14010     if (RExC_offsets) {         /* MJD */
14011         MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s %"UVuf" <- %"UVuf" (max %"UVuf").\n", 
14012               "reganode",
14013               __LINE__,
14014               PL_reg_name[op],
14015               (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0] ? 
14016               "Overwriting end of array!\n" : "OK",
14017               (UV)(RExC_emit - RExC_emit_start),
14018               (UV)(RExC_parse - RExC_start),
14019               (UV)RExC_offsets[0])); 
14020         Set_Cur_Node_Offset;
14021     }
14022 #endif            
14023     RExC_emit = ptr;
14024     return(ret);
14025 }
14026
14027 /*
14028 - reguni - emit (if appropriate) a Unicode character
14029 */
14030 STATIC STRLEN
14031 S_reguni(pTHX_ const RExC_state_t *pRExC_state, UV uv, char* s)
14032 {
14033     dVAR;
14034
14035     PERL_ARGS_ASSERT_REGUNI;
14036
14037     return SIZE_ONLY ? UNISKIP(uv) : (uvchr_to_utf8((U8*)s, uv) - (U8*)s);
14038 }
14039
14040 /*
14041 - reginsert - insert an operator in front of already-emitted operand
14042 *
14043 * Means relocating the operand.
14044 */
14045 STATIC void
14046 S_reginsert(pTHX_ RExC_state_t *pRExC_state, U8 op, regnode *opnd, U32 depth)
14047 {
14048     dVAR;
14049     regnode *src;
14050     regnode *dst;
14051     regnode *place;
14052     const int offset = regarglen[(U8)op];
14053     const int size = NODE_STEP_REGNODE + offset;
14054     GET_RE_DEBUG_FLAGS_DECL;
14055
14056     PERL_ARGS_ASSERT_REGINSERT;
14057     PERL_UNUSED_ARG(depth);
14058 /* (PL_regkind[(U8)op] == CURLY ? EXTRA_STEP_2ARGS : 0); */
14059     DEBUG_PARSE_FMT("inst"," - %s",PL_reg_name[op]);
14060     if (SIZE_ONLY) {
14061         RExC_size += size;
14062         return;
14063     }
14064
14065     src = RExC_emit;
14066     RExC_emit += size;
14067     dst = RExC_emit;
14068     if (RExC_open_parens) {
14069         int paren;
14070         /*DEBUG_PARSE_FMT("inst"," - %"IVdf, (IV)RExC_npar);*/
14071         for ( paren=0 ; paren < RExC_npar ; paren++ ) {
14072             if ( RExC_open_parens[paren] >= opnd ) {
14073                 /*DEBUG_PARSE_FMT("open"," - %d",size);*/
14074                 RExC_open_parens[paren] += size;
14075             } else {
14076                 /*DEBUG_PARSE_FMT("open"," - %s","ok");*/
14077             }
14078             if ( RExC_close_parens[paren] >= opnd ) {
14079                 /*DEBUG_PARSE_FMT("close"," - %d",size);*/
14080                 RExC_close_parens[paren] += size;
14081             } else {
14082                 /*DEBUG_PARSE_FMT("close"," - %s","ok");*/
14083             }
14084         }
14085     }
14086
14087     while (src > opnd) {
14088         StructCopy(--src, --dst, regnode);
14089 #ifdef RE_TRACK_PATTERN_OFFSETS
14090         if (RExC_offsets) {     /* MJD 20010112 */
14091             MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s copy %"UVuf" -> %"UVuf" (max %"UVuf").\n",
14092                   "reg_insert",
14093                   __LINE__,
14094                   PL_reg_name[op],
14095                   (UV)(dst - RExC_emit_start) > RExC_offsets[0] 
14096                     ? "Overwriting end of array!\n" : "OK",
14097                   (UV)(src - RExC_emit_start),
14098                   (UV)(dst - RExC_emit_start),
14099                   (UV)RExC_offsets[0])); 
14100             Set_Node_Offset_To_R(dst-RExC_emit_start, Node_Offset(src));
14101             Set_Node_Length_To_R(dst-RExC_emit_start, Node_Length(src));
14102         }
14103 #endif
14104     }
14105     
14106
14107     place = opnd;               /* Op node, where operand used to be. */
14108 #ifdef RE_TRACK_PATTERN_OFFSETS
14109     if (RExC_offsets) {         /* MJD */
14110         MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s %"UVuf" <- %"UVuf" (max %"UVuf").\n", 
14111               "reginsert",
14112               __LINE__,
14113               PL_reg_name[op],
14114               (UV)(place - RExC_emit_start) > RExC_offsets[0] 
14115               ? "Overwriting end of array!\n" : "OK",
14116               (UV)(place - RExC_emit_start),
14117               (UV)(RExC_parse - RExC_start),
14118               (UV)RExC_offsets[0]));
14119         Set_Node_Offset(place, RExC_parse);
14120         Set_Node_Length(place, 1);
14121     }
14122 #endif    
14123     src = NEXTOPER(place);
14124     FILL_ADVANCE_NODE(place, op);
14125     Zero(src, offset, regnode);
14126 }
14127
14128 /*
14129 - regtail - set the next-pointer at the end of a node chain of p to val.
14130 - SEE ALSO: regtail_study
14131 */
14132 /* TODO: All three parms should be const */
14133 STATIC void
14134 S_regtail(pTHX_ RExC_state_t *pRExC_state, regnode *p, const regnode *val,U32 depth)
14135 {
14136     dVAR;
14137     regnode *scan;
14138     GET_RE_DEBUG_FLAGS_DECL;
14139
14140     PERL_ARGS_ASSERT_REGTAIL;
14141 #ifndef DEBUGGING
14142     PERL_UNUSED_ARG(depth);
14143 #endif
14144
14145     if (SIZE_ONLY)
14146         return;
14147
14148     /* Find last node. */
14149     scan = p;
14150     for (;;) {
14151         regnode * const temp = regnext(scan);
14152         DEBUG_PARSE_r({
14153             SV * const mysv=sv_newmortal();
14154             DEBUG_PARSE_MSG((scan==p ? "tail" : ""));
14155             regprop(RExC_rx, mysv, scan);
14156             PerlIO_printf(Perl_debug_log, "~ %s (%d) %s %s\n",
14157                 SvPV_nolen_const(mysv), REG_NODE_NUM(scan),
14158                     (temp == NULL ? "->" : ""),
14159                     (temp == NULL ? PL_reg_name[OP(val)] : "")
14160             );
14161         });
14162         if (temp == NULL)
14163             break;
14164         scan = temp;
14165     }
14166
14167     if (reg_off_by_arg[OP(scan)]) {
14168         ARG_SET(scan, val - scan);
14169     }
14170     else {
14171         NEXT_OFF(scan) = val - scan;
14172     }
14173 }
14174
14175 #ifdef DEBUGGING
14176 /*
14177 - regtail_study - set the next-pointer at the end of a node chain of p to val.
14178 - Look for optimizable sequences at the same time.
14179 - currently only looks for EXACT chains.
14180
14181 This is experimental code. The idea is to use this routine to perform 
14182 in place optimizations on branches and groups as they are constructed,
14183 with the long term intention of removing optimization from study_chunk so
14184 that it is purely analytical.
14185
14186 Currently only used when in DEBUG mode. The macro REGTAIL_STUDY() is used
14187 to control which is which.
14188
14189 */
14190 /* TODO: All four parms should be const */
14191
14192 STATIC U8
14193 S_regtail_study(pTHX_ RExC_state_t *pRExC_state, regnode *p, const regnode *val,U32 depth)
14194 {
14195     dVAR;
14196     regnode *scan;
14197     U8 exact = PSEUDO;
14198 #ifdef EXPERIMENTAL_INPLACESCAN
14199     I32 min = 0;
14200 #endif
14201     GET_RE_DEBUG_FLAGS_DECL;
14202
14203     PERL_ARGS_ASSERT_REGTAIL_STUDY;
14204
14205
14206     if (SIZE_ONLY)
14207         return exact;
14208
14209     /* Find last node. */
14210
14211     scan = p;
14212     for (;;) {
14213         regnode * const temp = regnext(scan);
14214 #ifdef EXPERIMENTAL_INPLACESCAN
14215         if (PL_regkind[OP(scan)] == EXACT) {
14216             bool has_exactf_sharp_s;    /* Unexamined in this routine */
14217             if (join_exact(pRExC_state,scan,&min, &has_exactf_sharp_s, 1,val,depth+1))
14218                 return EXACT;
14219         }
14220 #endif
14221         if ( exact ) {
14222             switch (OP(scan)) {
14223                 case EXACT:
14224                 case EXACTF:
14225                 case EXACTFA:
14226                 case EXACTFU:
14227                 case EXACTFU_SS:
14228                 case EXACTFU_TRICKYFOLD:
14229                 case EXACTFL:
14230                         if( exact == PSEUDO )
14231                             exact= OP(scan);
14232                         else if ( exact != OP(scan) )
14233                             exact= 0;
14234                 case NOTHING:
14235                     break;
14236                 default:
14237                     exact= 0;
14238             }
14239         }
14240         DEBUG_PARSE_r({
14241             SV * const mysv=sv_newmortal();
14242             DEBUG_PARSE_MSG((scan==p ? "tsdy" : ""));
14243             regprop(RExC_rx, mysv, scan);
14244             PerlIO_printf(Perl_debug_log, "~ %s (%d) -> %s\n",
14245                 SvPV_nolen_const(mysv),
14246                 REG_NODE_NUM(scan),
14247                 PL_reg_name[exact]);
14248         });
14249         if (temp == NULL)
14250             break;
14251         scan = temp;
14252     }
14253     DEBUG_PARSE_r({
14254         SV * const mysv_val=sv_newmortal();
14255         DEBUG_PARSE_MSG("");
14256         regprop(RExC_rx, mysv_val, val);
14257         PerlIO_printf(Perl_debug_log, "~ attach to %s (%"IVdf") offset to %"IVdf"\n",
14258                       SvPV_nolen_const(mysv_val),
14259                       (IV)REG_NODE_NUM(val),
14260                       (IV)(val - scan)
14261         );
14262     });
14263     if (reg_off_by_arg[OP(scan)]) {
14264         ARG_SET(scan, val - scan);
14265     }
14266     else {
14267         NEXT_OFF(scan) = val - scan;
14268     }
14269
14270     return exact;
14271 }
14272 #endif
14273
14274 /*
14275  - regdump - dump a regexp onto Perl_debug_log in vaguely comprehensible form
14276  */
14277 #ifdef DEBUGGING
14278 static void 
14279 S_regdump_extflags(pTHX_ const char *lead, const U32 flags)
14280 {
14281     int bit;
14282     int set=0;
14283     regex_charset cs;
14284
14285     for (bit=0; bit<32; bit++) {
14286         if (flags & (1<<bit)) {
14287             if ((1<<bit) & RXf_PMf_CHARSET) {   /* Output separately, below */
14288                 continue;
14289             }
14290             if (!set++ && lead) 
14291                 PerlIO_printf(Perl_debug_log, "%s",lead);
14292             PerlIO_printf(Perl_debug_log, "%s ",PL_reg_extflags_name[bit]);
14293         }               
14294     }      
14295     if ((cs = get_regex_charset(flags)) != REGEX_DEPENDS_CHARSET) {
14296             if (!set++ && lead) {
14297                 PerlIO_printf(Perl_debug_log, "%s",lead);
14298             }
14299             switch (cs) {
14300                 case REGEX_UNICODE_CHARSET:
14301                     PerlIO_printf(Perl_debug_log, "UNICODE");
14302                     break;
14303                 case REGEX_LOCALE_CHARSET:
14304                     PerlIO_printf(Perl_debug_log, "LOCALE");
14305                     break;
14306                 case REGEX_ASCII_RESTRICTED_CHARSET:
14307                     PerlIO_printf(Perl_debug_log, "ASCII-RESTRICTED");
14308                     break;
14309                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
14310                     PerlIO_printf(Perl_debug_log, "ASCII-MORE_RESTRICTED");
14311                     break;
14312                 default:
14313                     PerlIO_printf(Perl_debug_log, "UNKNOWN CHARACTER SET");
14314                     break;
14315             }
14316     }
14317     if (lead)  {
14318         if (set) 
14319             PerlIO_printf(Perl_debug_log, "\n");
14320         else 
14321             PerlIO_printf(Perl_debug_log, "%s[none-set]\n",lead);
14322     }            
14323 }   
14324 #endif
14325
14326 void
14327 Perl_regdump(pTHX_ const regexp *r)
14328 {
14329 #ifdef DEBUGGING
14330     dVAR;
14331     SV * const sv = sv_newmortal();
14332     SV *dsv= sv_newmortal();
14333     RXi_GET_DECL(r,ri);
14334     GET_RE_DEBUG_FLAGS_DECL;
14335
14336     PERL_ARGS_ASSERT_REGDUMP;
14337
14338     (void)dumpuntil(r, ri->program, ri->program + 1, NULL, NULL, sv, 0, 0);
14339
14340     /* Header fields of interest. */
14341     if (r->anchored_substr) {
14342         RE_PV_QUOTED_DECL(s, 0, dsv, SvPVX_const(r->anchored_substr), 
14343             RE_SV_DUMPLEN(r->anchored_substr), 30);
14344         PerlIO_printf(Perl_debug_log,
14345                       "anchored %s%s at %"IVdf" ",
14346                       s, RE_SV_TAIL(r->anchored_substr),
14347                       (IV)r->anchored_offset);
14348     } else if (r->anchored_utf8) {
14349         RE_PV_QUOTED_DECL(s, 1, dsv, SvPVX_const(r->anchored_utf8), 
14350             RE_SV_DUMPLEN(r->anchored_utf8), 30);
14351         PerlIO_printf(Perl_debug_log,
14352                       "anchored utf8 %s%s at %"IVdf" ",
14353                       s, RE_SV_TAIL(r->anchored_utf8),
14354                       (IV)r->anchored_offset);
14355     }                 
14356     if (r->float_substr) {
14357         RE_PV_QUOTED_DECL(s, 0, dsv, SvPVX_const(r->float_substr), 
14358             RE_SV_DUMPLEN(r->float_substr), 30);
14359         PerlIO_printf(Perl_debug_log,
14360                       "floating %s%s at %"IVdf"..%"UVuf" ",
14361                       s, RE_SV_TAIL(r->float_substr),
14362                       (IV)r->float_min_offset, (UV)r->float_max_offset);
14363     } else if (r->float_utf8) {
14364         RE_PV_QUOTED_DECL(s, 1, dsv, SvPVX_const(r->float_utf8), 
14365             RE_SV_DUMPLEN(r->float_utf8), 30);
14366         PerlIO_printf(Perl_debug_log,
14367                       "floating utf8 %s%s at %"IVdf"..%"UVuf" ",
14368                       s, RE_SV_TAIL(r->float_utf8),
14369                       (IV)r->float_min_offset, (UV)r->float_max_offset);
14370     }
14371     if (r->check_substr || r->check_utf8)
14372         PerlIO_printf(Perl_debug_log,
14373                       (const char *)
14374                       (r->check_substr == r->float_substr
14375                        && r->check_utf8 == r->float_utf8
14376                        ? "(checking floating" : "(checking anchored"));
14377     if (r->extflags & RXf_NOSCAN)
14378         PerlIO_printf(Perl_debug_log, " noscan");
14379     if (r->extflags & RXf_CHECK_ALL)
14380         PerlIO_printf(Perl_debug_log, " isall");
14381     if (r->check_substr || r->check_utf8)
14382         PerlIO_printf(Perl_debug_log, ") ");
14383
14384     if (ri->regstclass) {
14385         regprop(r, sv, ri->regstclass);
14386         PerlIO_printf(Perl_debug_log, "stclass %s ", SvPVX_const(sv));
14387     }
14388     if (r->extflags & RXf_ANCH) {
14389         PerlIO_printf(Perl_debug_log, "anchored");
14390         if (r->extflags & RXf_ANCH_BOL)
14391             PerlIO_printf(Perl_debug_log, "(BOL)");
14392         if (r->extflags & RXf_ANCH_MBOL)
14393             PerlIO_printf(Perl_debug_log, "(MBOL)");
14394         if (r->extflags & RXf_ANCH_SBOL)
14395             PerlIO_printf(Perl_debug_log, "(SBOL)");
14396         if (r->extflags & RXf_ANCH_GPOS)
14397             PerlIO_printf(Perl_debug_log, "(GPOS)");
14398         PerlIO_putc(Perl_debug_log, ' ');
14399     }
14400     if (r->extflags & RXf_GPOS_SEEN)
14401         PerlIO_printf(Perl_debug_log, "GPOS:%"UVuf" ", (UV)r->gofs);
14402     if (r->intflags & PREGf_SKIP)
14403         PerlIO_printf(Perl_debug_log, "plus ");
14404     if (r->intflags & PREGf_IMPLICIT)
14405         PerlIO_printf(Perl_debug_log, "implicit ");
14406     PerlIO_printf(Perl_debug_log, "minlen %"IVdf" ", (IV)r->minlen);
14407     if (r->extflags & RXf_EVAL_SEEN)
14408         PerlIO_printf(Perl_debug_log, "with eval ");
14409     PerlIO_printf(Perl_debug_log, "\n");
14410     DEBUG_FLAGS_r(regdump_extflags("r->extflags: ",r->extflags));            
14411 #else
14412     PERL_ARGS_ASSERT_REGDUMP;
14413     PERL_UNUSED_CONTEXT;
14414     PERL_UNUSED_ARG(r);
14415 #endif  /* DEBUGGING */
14416 }
14417
14418 /*
14419 - regprop - printable representation of opcode
14420 */
14421 #define EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags) \
14422 STMT_START { \
14423         if (do_sep) {                           \
14424             Perl_sv_catpvf(aTHX_ sv,"%s][%s",PL_colors[1],PL_colors[0]); \
14425             if (flags & ANYOF_INVERT)           \
14426                 /*make sure the invert info is in each */ \
14427                 sv_catpvs(sv, "^");             \
14428             do_sep = 0;                         \
14429         }                                       \
14430 } STMT_END
14431
14432 void
14433 Perl_regprop(pTHX_ const regexp *prog, SV *sv, const regnode *o)
14434 {
14435 #ifdef DEBUGGING
14436     dVAR;
14437     int k;
14438
14439     /* Should be synchronized with * ANYOF_ #xdefines in regcomp.h */
14440     static const char * const anyofs[] = {
14441 #if _CC_WORDCHAR != 0 || _CC_DIGIT != 1 || _CC_ALPHA != 2 || _CC_LOWER != 3 \
14442     || _CC_UPPER != 4 || _CC_PUNCT != 5 || _CC_PRINT != 6                   \
14443     || _CC_ALPHANUMERIC != 7 || _CC_GRAPH != 8 || _CC_CASED != 9            \
14444     || _CC_SPACE != 10 || _CC_BLANK != 11 || _CC_XDIGIT != 12               \
14445     || _CC_PSXSPC != 13 || _CC_CNTRL != 14 || _CC_ASCII != 15               \
14446     || _CC_VERTSPACE != 16
14447   #error Need to adjust order of anyofs[]
14448 #endif
14449         "[\\w]",
14450         "[\\W]",
14451         "[\\d]",
14452         "[\\D]",
14453         "[:alpha:]",
14454         "[:^alpha:]",
14455         "[:lower:]",
14456         "[:^lower:]",
14457         "[:upper:]",
14458         "[:^upper:]",
14459         "[:punct:]",
14460         "[:^punct:]",
14461         "[:print:]",
14462         "[:^print:]",
14463         "[:alnum:]",
14464         "[:^alnum:]",
14465         "[:graph:]",
14466         "[:^graph:]",
14467         "[:cased:]",
14468         "[:^cased:]",
14469         "[\\s]",
14470         "[\\S]",
14471         "[:blank:]",
14472         "[:^blank:]",
14473         "[:xdigit:]",
14474         "[:^xdigit:]",
14475         "[:space:]",
14476         "[:^space:]",
14477         "[:cntrl:]",
14478         "[:^cntrl:]",
14479         "[:ascii:]",
14480         "[:^ascii:]",
14481         "[\\v]",
14482         "[\\V]"
14483     };
14484     RXi_GET_DECL(prog,progi);
14485     GET_RE_DEBUG_FLAGS_DECL;
14486     
14487     PERL_ARGS_ASSERT_REGPROP;
14488
14489     sv_setpvs(sv, "");
14490
14491     if (OP(o) > REGNODE_MAX)            /* regnode.type is unsigned */
14492         /* It would be nice to FAIL() here, but this may be called from
14493            regexec.c, and it would be hard to supply pRExC_state. */
14494         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d", (int)OP(o), (int)REGNODE_MAX);
14495     sv_catpv(sv, PL_reg_name[OP(o)]); /* Take off const! */
14496
14497     k = PL_regkind[OP(o)];
14498
14499     if (k == EXACT) {
14500         sv_catpvs(sv, " ");
14501         /* Using is_utf8_string() (via PERL_PV_UNI_DETECT) 
14502          * is a crude hack but it may be the best for now since 
14503          * we have no flag "this EXACTish node was UTF-8" 
14504          * --jhi */
14505         pv_pretty(sv, STRING(o), STR_LEN(o), 60, PL_colors[0], PL_colors[1],
14506                   PERL_PV_ESCAPE_UNI_DETECT |
14507                   PERL_PV_ESCAPE_NONASCII   |
14508                   PERL_PV_PRETTY_ELLIPSES   |
14509                   PERL_PV_PRETTY_LTGT       |
14510                   PERL_PV_PRETTY_NOCLEAR
14511                   );
14512     } else if (k == TRIE) {
14513         /* print the details of the trie in dumpuntil instead, as
14514          * progi->data isn't available here */
14515         const char op = OP(o);
14516         const U32 n = ARG(o);
14517         const reg_ac_data * const ac = IS_TRIE_AC(op) ?
14518                (reg_ac_data *)progi->data->data[n] :
14519                NULL;
14520         const reg_trie_data * const trie
14521             = (reg_trie_data*)progi->data->data[!IS_TRIE_AC(op) ? n : ac->trie];
14522         
14523         Perl_sv_catpvf(aTHX_ sv, "-%s",PL_reg_name[o->flags]);
14524         DEBUG_TRIE_COMPILE_r(
14525             Perl_sv_catpvf(aTHX_ sv,
14526                 "<S:%"UVuf"/%"IVdf" W:%"UVuf" L:%"UVuf"/%"UVuf" C:%"UVuf"/%"UVuf">",
14527                 (UV)trie->startstate,
14528                 (IV)trie->statecount-1, /* -1 because of the unused 0 element */
14529                 (UV)trie->wordcount,
14530                 (UV)trie->minlen,
14531                 (UV)trie->maxlen,
14532                 (UV)TRIE_CHARCOUNT(trie),
14533                 (UV)trie->uniquecharcount
14534             )
14535         );
14536         if ( IS_ANYOF_TRIE(op) || trie->bitmap ) {
14537             int i;
14538             int rangestart = -1;
14539             U8* bitmap = IS_ANYOF_TRIE(op) ? (U8*)ANYOF_BITMAP(o) : (U8*)TRIE_BITMAP(trie);
14540             sv_catpvs(sv, "[");
14541             for (i = 0; i <= 256; i++) {
14542                 if (i < 256 && BITMAP_TEST(bitmap,i)) {
14543                     if (rangestart == -1)
14544                         rangestart = i;
14545                 } else if (rangestart != -1) {
14546                     if (i <= rangestart + 3)
14547                         for (; rangestart < i; rangestart++)
14548                             put_byte(sv, rangestart);
14549                     else {
14550                         put_byte(sv, rangestart);
14551                         sv_catpvs(sv, "-");
14552                         put_byte(sv, i - 1);
14553                     }
14554                     rangestart = -1;
14555                 }
14556             }
14557             sv_catpvs(sv, "]");
14558         } 
14559          
14560     } else if (k == CURLY) {
14561         if (OP(o) == CURLYM || OP(o) == CURLYN || OP(o) == CURLYX)
14562             Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags); /* Parenth number */
14563         Perl_sv_catpvf(aTHX_ sv, " {%d,%d}", ARG1(o), ARG2(o));
14564     }
14565     else if (k == WHILEM && o->flags)                   /* Ordinal/of */
14566         Perl_sv_catpvf(aTHX_ sv, "[%d/%d]", o->flags & 0xf, o->flags>>4);
14567     else if (k == REF || k == OPEN || k == CLOSE || k == GROUPP || OP(o)==ACCEPT) {
14568         Perl_sv_catpvf(aTHX_ sv, "%d", (int)ARG(o));    /* Parenth number */
14569         if ( RXp_PAREN_NAMES(prog) ) {
14570             if ( k != REF || (OP(o) < NREF)) {
14571                 AV *list= MUTABLE_AV(progi->data->data[progi->name_list_idx]);
14572                 SV **name= av_fetch(list, ARG(o), 0 );
14573                 if (name)
14574                     Perl_sv_catpvf(aTHX_ sv, " '%"SVf"'", SVfARG(*name));
14575             }       
14576             else {
14577                 AV *list= MUTABLE_AV(progi->data->data[ progi->name_list_idx ]);
14578                 SV *sv_dat= MUTABLE_SV(progi->data->data[ ARG( o ) ]);
14579                 I32 *nums=(I32*)SvPVX(sv_dat);
14580                 SV **name= av_fetch(list, nums[0], 0 );
14581                 I32 n;
14582                 if (name) {
14583                     for ( n=0; n<SvIVX(sv_dat); n++ ) {
14584                         Perl_sv_catpvf(aTHX_ sv, "%s%"IVdf,
14585                                     (n ? "," : ""), (IV)nums[n]);
14586                     }
14587                     Perl_sv_catpvf(aTHX_ sv, " '%"SVf"'", SVfARG(*name));
14588                 }
14589             }
14590         }            
14591     } else if (k == GOSUB) 
14592         Perl_sv_catpvf(aTHX_ sv, "%d[%+d]", (int)ARG(o),(int)ARG2L(o)); /* Paren and offset */
14593     else if (k == VERB) {
14594         if (!o->flags) 
14595             Perl_sv_catpvf(aTHX_ sv, ":%"SVf, 
14596                            SVfARG((MUTABLE_SV(progi->data->data[ ARG( o ) ]))));
14597     } else if (k == LOGICAL)
14598         Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags);     /* 2: embedded, otherwise 1 */
14599     else if (k == ANYOF) {
14600         int i, rangestart = -1;
14601         const U8 flags = ANYOF_FLAGS(o);
14602         int do_sep = 0;
14603
14604
14605         if (flags & ANYOF_LOCALE)
14606             sv_catpvs(sv, "{loc}");
14607         if (flags & ANYOF_LOC_FOLD)
14608             sv_catpvs(sv, "{i}");
14609         Perl_sv_catpvf(aTHX_ sv, "[%s", PL_colors[0]);
14610         if (flags & ANYOF_INVERT)
14611             sv_catpvs(sv, "^");
14612
14613         /* output what the standard cp 0-255 bitmap matches */
14614         for (i = 0; i <= 256; i++) {
14615             if (i < 256 && ANYOF_BITMAP_TEST(o,i)) {
14616                 if (rangestart == -1)
14617                     rangestart = i;
14618             } else if (rangestart != -1) {
14619                 if (i <= rangestart + 3)
14620                     for (; rangestart < i; rangestart++)
14621                         put_byte(sv, rangestart);
14622                 else {
14623                     put_byte(sv, rangestart);
14624                     sv_catpvs(sv, "-");
14625                     put_byte(sv, i - 1);
14626                 }
14627                 do_sep = 1;
14628                 rangestart = -1;
14629             }
14630         }
14631         
14632         EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags);
14633         /* output any special charclass tests (used entirely under use locale) */
14634         if (ANYOF_CLASS_TEST_ANY_SET(o))
14635             for (i = 0; i < (int)(sizeof(anyofs)/sizeof(char*)); i++)
14636                 if (ANYOF_CLASS_TEST(o,i)) {
14637                     sv_catpv(sv, anyofs[i]);
14638                     do_sep = 1;
14639                 }
14640         
14641         EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags);
14642         
14643         if (flags & ANYOF_NON_UTF8_LATIN1_ALL) {
14644             sv_catpvs(sv, "{non-utf8-latin1-all}");
14645         }
14646
14647         /* output information about the unicode matching */
14648         if (flags & ANYOF_UNICODE_ALL)
14649             sv_catpvs(sv, "{unicode_all}");
14650         else if (ANYOF_NONBITMAP(o))
14651             sv_catpvs(sv, "{unicode}");
14652         if (flags & ANYOF_NONBITMAP_NON_UTF8)
14653             sv_catpvs(sv, "{outside bitmap}");
14654
14655         if (ANYOF_NONBITMAP(o)) {
14656             SV *lv; /* Set if there is something outside the bit map */
14657             SV * const sw = regclass_swash(prog, o, FALSE, &lv, NULL);
14658             bool byte_output = FALSE;   /* If something in the bitmap has been
14659                                            output */
14660
14661             if (lv && lv != &PL_sv_undef) {
14662                 if (sw) {
14663                     U8 s[UTF8_MAXBYTES_CASE+1];
14664
14665                     for (i = 0; i <= 256; i++) { /* Look at chars in bitmap */
14666                         uvchr_to_utf8(s, i);
14667
14668                         if (i < 256
14669                             && ! ANYOF_BITMAP_TEST(o, i)    /* Don't duplicate
14670                                                                things already
14671                                                                output as part
14672                                                                of the bitmap */
14673                             && swash_fetch(sw, s, TRUE))
14674                         {
14675                             if (rangestart == -1)
14676                                 rangestart = i;
14677                         } else if (rangestart != -1) {
14678                             byte_output = TRUE;
14679                             if (i <= rangestart + 3)
14680                                 for (; rangestart < i; rangestart++) {
14681                                     put_byte(sv, rangestart);
14682                                 }
14683                             else {
14684                                 put_byte(sv, rangestart);
14685                                 sv_catpvs(sv, "-");
14686                                 put_byte(sv, i-1);
14687                             }
14688                             rangestart = -1;
14689                         }
14690                     }
14691                 }
14692
14693                 {
14694                     char *s = savesvpv(lv);
14695                     char * const origs = s;
14696
14697                     while (*s && *s != '\n')
14698                         s++;
14699
14700                     if (*s == '\n') {
14701                         const char * const t = ++s;
14702
14703                         if (byte_output) {
14704                             sv_catpvs(sv, " ");
14705                         }
14706
14707                         while (*s) {
14708                             if (*s == '\n') {
14709
14710                                 /* Truncate very long output */
14711                                 if (s - origs > 256) {
14712                                     Perl_sv_catpvf(aTHX_ sv,
14713                                                    "%.*s...",
14714                                                    (int) (s - origs - 1),
14715                                                    t);
14716                                     goto out_dump;
14717                                 }
14718                                 *s = ' ';
14719                             }
14720                             else if (*s == '\t') {
14721                                 *s = '-';
14722                             }
14723                             s++;
14724                         }
14725                         if (s[-1] == ' ')
14726                             s[-1] = 0;
14727
14728                         sv_catpv(sv, t);
14729                     }
14730
14731                 out_dump:
14732
14733                     Safefree(origs);
14734                 }
14735                 SvREFCNT_dec_NN(lv);
14736             }
14737         }
14738
14739         Perl_sv_catpvf(aTHX_ sv, "%s]", PL_colors[1]);
14740     }
14741     else if (k == POSIXD || k == NPOSIXD) {
14742         U8 index = FLAGS(o) * 2;
14743         if (index > (sizeof(anyofs) / sizeof(anyofs[0]))) {
14744             Perl_sv_catpvf(aTHX_ sv, "[illegal type=%d])", index);
14745         }
14746         else {
14747             sv_catpv(sv, anyofs[index]);
14748         }
14749     }
14750     else if (k == BRANCHJ && (OP(o) == UNLESSM || OP(o) == IFMATCH))
14751         Perl_sv_catpvf(aTHX_ sv, "[%d]", -(o->flags));
14752 #else
14753     PERL_UNUSED_CONTEXT;
14754     PERL_UNUSED_ARG(sv);
14755     PERL_UNUSED_ARG(o);
14756     PERL_UNUSED_ARG(prog);
14757 #endif  /* DEBUGGING */
14758 }
14759
14760 SV *
14761 Perl_re_intuit_string(pTHX_ REGEXP * const r)
14762 {                               /* Assume that RE_INTUIT is set */
14763     dVAR;
14764     struct regexp *const prog = ReANY(r);
14765     GET_RE_DEBUG_FLAGS_DECL;
14766
14767     PERL_ARGS_ASSERT_RE_INTUIT_STRING;
14768     PERL_UNUSED_CONTEXT;
14769
14770     DEBUG_COMPILE_r(
14771         {
14772             const char * const s = SvPV_nolen_const(prog->check_substr
14773                       ? prog->check_substr : prog->check_utf8);
14774
14775             if (!PL_colorset) reginitcolors();
14776             PerlIO_printf(Perl_debug_log,
14777                       "%sUsing REx %ssubstr:%s \"%s%.60s%s%s\"\n",
14778                       PL_colors[4],
14779                       prog->check_substr ? "" : "utf8 ",
14780                       PL_colors[5],PL_colors[0],
14781                       s,
14782                       PL_colors[1],
14783                       (strlen(s) > 60 ? "..." : ""));
14784         } );
14785
14786     return prog->check_substr ? prog->check_substr : prog->check_utf8;
14787 }
14788
14789 /* 
14790    pregfree() 
14791    
14792    handles refcounting and freeing the perl core regexp structure. When 
14793    it is necessary to actually free the structure the first thing it 
14794    does is call the 'free' method of the regexp_engine associated to
14795    the regexp, allowing the handling of the void *pprivate; member 
14796    first. (This routine is not overridable by extensions, which is why 
14797    the extensions free is called first.)
14798    
14799    See regdupe and regdupe_internal if you change anything here. 
14800 */
14801 #ifndef PERL_IN_XSUB_RE
14802 void
14803 Perl_pregfree(pTHX_ REGEXP *r)
14804 {
14805     SvREFCNT_dec(r);
14806 }
14807
14808 void
14809 Perl_pregfree2(pTHX_ REGEXP *rx)
14810 {
14811     dVAR;
14812     struct regexp *const r = ReANY(rx);
14813     GET_RE_DEBUG_FLAGS_DECL;
14814
14815     PERL_ARGS_ASSERT_PREGFREE2;
14816
14817     if (r->mother_re) {
14818         ReREFCNT_dec(r->mother_re);
14819     } else {
14820         CALLREGFREE_PVT(rx); /* free the private data */
14821         SvREFCNT_dec(RXp_PAREN_NAMES(r));
14822         Safefree(r->xpv_len_u.xpvlenu_pv);
14823     }        
14824     if (r->substrs) {
14825         SvREFCNT_dec(r->anchored_substr);
14826         SvREFCNT_dec(r->anchored_utf8);
14827         SvREFCNT_dec(r->float_substr);
14828         SvREFCNT_dec(r->float_utf8);
14829         Safefree(r->substrs);
14830     }
14831     RX_MATCH_COPY_FREE(rx);
14832 #ifdef PERL_ANY_COW
14833     SvREFCNT_dec(r->saved_copy);
14834 #endif
14835     Safefree(r->offs);
14836     SvREFCNT_dec(r->qr_anoncv);
14837     rx->sv_u.svu_rx = 0;
14838 }
14839
14840 /*  reg_temp_copy()
14841     
14842     This is a hacky workaround to the structural issue of match results
14843     being stored in the regexp structure which is in turn stored in
14844     PL_curpm/PL_reg_curpm. The problem is that due to qr// the pattern
14845     could be PL_curpm in multiple contexts, and could require multiple
14846     result sets being associated with the pattern simultaneously, such
14847     as when doing a recursive match with (??{$qr})
14848     
14849     The solution is to make a lightweight copy of the regexp structure 
14850     when a qr// is returned from the code executed by (??{$qr}) this
14851     lightweight copy doesn't actually own any of its data except for
14852     the starp/end and the actual regexp structure itself. 
14853     
14854 */    
14855     
14856     
14857 REGEXP *
14858 Perl_reg_temp_copy (pTHX_ REGEXP *ret_x, REGEXP *rx)
14859 {
14860     struct regexp *ret;
14861     struct regexp *const r = ReANY(rx);
14862     const bool islv = ret_x && SvTYPE(ret_x) == SVt_PVLV;
14863
14864     PERL_ARGS_ASSERT_REG_TEMP_COPY;
14865
14866     if (!ret_x)
14867         ret_x = (REGEXP*) newSV_type(SVt_REGEXP);
14868     else {
14869         SvOK_off((SV *)ret_x);
14870         if (islv) {
14871             /* For PVLVs, SvANY points to the xpvlv body while sv_u points
14872                to the regexp.  (For SVt_REGEXPs, sv_upgrade has already
14873                made both spots point to the same regexp body.) */
14874             REGEXP *temp = (REGEXP *)newSV_type(SVt_REGEXP);
14875             assert(!SvPVX(ret_x));
14876             ret_x->sv_u.svu_rx = temp->sv_any;
14877             temp->sv_any = NULL;
14878             SvFLAGS(temp) = (SvFLAGS(temp) & ~SVTYPEMASK) | SVt_NULL;
14879             SvREFCNT_dec_NN(temp);
14880             /* SvCUR still resides in the xpvlv struct, so the regexp copy-
14881                ing below will not set it. */
14882             SvCUR_set(ret_x, SvCUR(rx));
14883         }
14884     }
14885     /* This ensures that SvTHINKFIRST(sv) is true, and hence that
14886        sv_force_normal(sv) is called.  */
14887     SvFAKE_on(ret_x);
14888     ret = ReANY(ret_x);
14889     
14890     SvFLAGS(ret_x) |= SvUTF8(rx);
14891     /* We share the same string buffer as the original regexp, on which we
14892        hold a reference count, incremented when mother_re is set below.
14893        The string pointer is copied here, being part of the regexp struct.
14894      */
14895     memcpy(&(ret->xpv_cur), &(r->xpv_cur),
14896            sizeof(regexp) - STRUCT_OFFSET(regexp, xpv_cur));
14897     if (r->offs) {
14898         const I32 npar = r->nparens+1;
14899         Newx(ret->offs, npar, regexp_paren_pair);
14900         Copy(r->offs, ret->offs, npar, regexp_paren_pair);
14901     }
14902     if (r->substrs) {
14903         Newx(ret->substrs, 1, struct reg_substr_data);
14904         StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
14905
14906         SvREFCNT_inc_void(ret->anchored_substr);
14907         SvREFCNT_inc_void(ret->anchored_utf8);
14908         SvREFCNT_inc_void(ret->float_substr);
14909         SvREFCNT_inc_void(ret->float_utf8);
14910
14911         /* check_substr and check_utf8, if non-NULL, point to either their
14912            anchored or float namesakes, and don't hold a second reference.  */
14913     }
14914     RX_MATCH_COPIED_off(ret_x);
14915 #ifdef PERL_ANY_COW
14916     ret->saved_copy = NULL;
14917 #endif
14918     ret->mother_re = ReREFCNT_inc(r->mother_re ? r->mother_re : rx);
14919     SvREFCNT_inc_void(ret->qr_anoncv);
14920     
14921     return ret_x;
14922 }
14923 #endif
14924
14925 /* regfree_internal() 
14926
14927    Free the private data in a regexp. This is overloadable by 
14928    extensions. Perl takes care of the regexp structure in pregfree(), 
14929    this covers the *pprivate pointer which technically perl doesn't 
14930    know about, however of course we have to handle the 
14931    regexp_internal structure when no extension is in use. 
14932    
14933    Note this is called before freeing anything in the regexp 
14934    structure. 
14935  */
14936  
14937 void
14938 Perl_regfree_internal(pTHX_ REGEXP * const rx)
14939 {
14940     dVAR;
14941     struct regexp *const r = ReANY(rx);
14942     RXi_GET_DECL(r,ri);
14943     GET_RE_DEBUG_FLAGS_DECL;
14944
14945     PERL_ARGS_ASSERT_REGFREE_INTERNAL;
14946
14947     DEBUG_COMPILE_r({
14948         if (!PL_colorset)
14949             reginitcolors();
14950         {
14951             SV *dsv= sv_newmortal();
14952             RE_PV_QUOTED_DECL(s, RX_UTF8(rx),
14953                 dsv, RX_PRECOMP(rx), RX_PRELEN(rx), 60);
14954             PerlIO_printf(Perl_debug_log,"%sFreeing REx:%s %s\n", 
14955                 PL_colors[4],PL_colors[5],s);
14956         }
14957     });
14958 #ifdef RE_TRACK_PATTERN_OFFSETS
14959     if (ri->u.offsets)
14960         Safefree(ri->u.offsets);             /* 20010421 MJD */
14961 #endif
14962     if (ri->code_blocks) {
14963         int n;
14964         for (n = 0; n < ri->num_code_blocks; n++)
14965             SvREFCNT_dec(ri->code_blocks[n].src_regex);
14966         Safefree(ri->code_blocks);
14967     }
14968
14969     if (ri->data) {
14970         int n = ri->data->count;
14971
14972         while (--n >= 0) {
14973           /* If you add a ->what type here, update the comment in regcomp.h */
14974             switch (ri->data->what[n]) {
14975             case 'a':
14976             case 'r':
14977             case 's':
14978             case 'S':
14979             case 'u':
14980                 SvREFCNT_dec(MUTABLE_SV(ri->data->data[n]));
14981                 break;
14982             case 'f':
14983                 Safefree(ri->data->data[n]);
14984                 break;
14985             case 'l':
14986             case 'L':
14987                 break;
14988             case 'T':           
14989                 { /* Aho Corasick add-on structure for a trie node.
14990                      Used in stclass optimization only */
14991                     U32 refcount;
14992                     reg_ac_data *aho=(reg_ac_data*)ri->data->data[n];
14993                     OP_REFCNT_LOCK;
14994                     refcount = --aho->refcount;
14995                     OP_REFCNT_UNLOCK;
14996                     if ( !refcount ) {
14997                         PerlMemShared_free(aho->states);
14998                         PerlMemShared_free(aho->fail);
14999                          /* do this last!!!! */
15000                         PerlMemShared_free(ri->data->data[n]);
15001                         PerlMemShared_free(ri->regstclass);
15002                     }
15003                 }
15004                 break;
15005             case 't':
15006                 {
15007                     /* trie structure. */
15008                     U32 refcount;
15009                     reg_trie_data *trie=(reg_trie_data*)ri->data->data[n];
15010                     OP_REFCNT_LOCK;
15011                     refcount = --trie->refcount;
15012                     OP_REFCNT_UNLOCK;
15013                     if ( !refcount ) {
15014                         PerlMemShared_free(trie->charmap);
15015                         PerlMemShared_free(trie->states);
15016                         PerlMemShared_free(trie->trans);
15017                         if (trie->bitmap)
15018                             PerlMemShared_free(trie->bitmap);
15019                         if (trie->jump)
15020                             PerlMemShared_free(trie->jump);
15021                         PerlMemShared_free(trie->wordinfo);
15022                         /* do this last!!!! */
15023                         PerlMemShared_free(ri->data->data[n]);
15024                     }
15025                 }
15026                 break;
15027             default:
15028                 Perl_croak(aTHX_ "panic: regfree data code '%c'", ri->data->what[n]);
15029             }
15030         }
15031         Safefree(ri->data->what);
15032         Safefree(ri->data);
15033     }
15034
15035     Safefree(ri);
15036 }
15037
15038 #define av_dup_inc(s,t) MUTABLE_AV(sv_dup_inc((const SV *)s,t))
15039 #define hv_dup_inc(s,t) MUTABLE_HV(sv_dup_inc((const SV *)s,t))
15040 #define SAVEPVN(p,n)    ((p) ? savepvn(p,n) : NULL)
15041
15042 /* 
15043    re_dup - duplicate a regexp. 
15044    
15045    This routine is expected to clone a given regexp structure. It is only
15046    compiled under USE_ITHREADS.
15047
15048    After all of the core data stored in struct regexp is duplicated
15049    the regexp_engine.dupe method is used to copy any private data
15050    stored in the *pprivate pointer. This allows extensions to handle
15051    any duplication it needs to do.
15052
15053    See pregfree() and regfree_internal() if you change anything here. 
15054 */
15055 #if defined(USE_ITHREADS)
15056 #ifndef PERL_IN_XSUB_RE
15057 void
15058 Perl_re_dup_guts(pTHX_ const REGEXP *sstr, REGEXP *dstr, CLONE_PARAMS *param)
15059 {
15060     dVAR;
15061     I32 npar;
15062     const struct regexp *r = ReANY(sstr);
15063     struct regexp *ret = ReANY(dstr);
15064     
15065     PERL_ARGS_ASSERT_RE_DUP_GUTS;
15066
15067     npar = r->nparens+1;
15068     Newx(ret->offs, npar, regexp_paren_pair);
15069     Copy(r->offs, ret->offs, npar, regexp_paren_pair);
15070
15071     if (ret->substrs) {
15072         /* Do it this way to avoid reading from *r after the StructCopy().
15073            That way, if any of the sv_dup_inc()s dislodge *r from the L1
15074            cache, it doesn't matter.  */
15075         const bool anchored = r->check_substr
15076             ? r->check_substr == r->anchored_substr
15077             : r->check_utf8 == r->anchored_utf8;
15078         Newx(ret->substrs, 1, struct reg_substr_data);
15079         StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
15080
15081         ret->anchored_substr = sv_dup_inc(ret->anchored_substr, param);
15082         ret->anchored_utf8 = sv_dup_inc(ret->anchored_utf8, param);
15083         ret->float_substr = sv_dup_inc(ret->float_substr, param);
15084         ret->float_utf8 = sv_dup_inc(ret->float_utf8, param);
15085
15086         /* check_substr and check_utf8, if non-NULL, point to either their
15087            anchored or float namesakes, and don't hold a second reference.  */
15088
15089         if (ret->check_substr) {
15090             if (anchored) {
15091                 assert(r->check_utf8 == r->anchored_utf8);
15092                 ret->check_substr = ret->anchored_substr;
15093                 ret->check_utf8 = ret->anchored_utf8;
15094             } else {
15095                 assert(r->check_substr == r->float_substr);
15096                 assert(r->check_utf8 == r->float_utf8);
15097                 ret->check_substr = ret->float_substr;
15098                 ret->check_utf8 = ret->float_utf8;
15099             }
15100         } else if (ret->check_utf8) {
15101             if (anchored) {
15102                 ret->check_utf8 = ret->anchored_utf8;
15103             } else {
15104                 ret->check_utf8 = ret->float_utf8;
15105             }
15106         }
15107     }
15108
15109     RXp_PAREN_NAMES(ret) = hv_dup_inc(RXp_PAREN_NAMES(ret), param);
15110     ret->qr_anoncv = MUTABLE_CV(sv_dup_inc((const SV *)ret->qr_anoncv, param));
15111
15112     if (ret->pprivate)
15113         RXi_SET(ret,CALLREGDUPE_PVT(dstr,param));
15114
15115     if (RX_MATCH_COPIED(dstr))
15116         ret->subbeg  = SAVEPVN(ret->subbeg, ret->sublen);
15117     else
15118         ret->subbeg = NULL;
15119 #ifdef PERL_ANY_COW
15120     ret->saved_copy = NULL;
15121 #endif
15122
15123     /* Whether mother_re be set or no, we need to copy the string.  We
15124        cannot refrain from copying it when the storage points directly to
15125        our mother regexp, because that's
15126                1: a buffer in a different thread
15127                2: something we no longer hold a reference on
15128                so we need to copy it locally.  */
15129     RX_WRAPPED(dstr) = SAVEPVN(RX_WRAPPED(sstr), SvCUR(sstr)+1);
15130     ret->mother_re   = NULL;
15131     ret->gofs = 0;
15132 }
15133 #endif /* PERL_IN_XSUB_RE */
15134
15135 /*
15136    regdupe_internal()
15137    
15138    This is the internal complement to regdupe() which is used to copy
15139    the structure pointed to by the *pprivate pointer in the regexp.
15140    This is the core version of the extension overridable cloning hook.
15141    The regexp structure being duplicated will be copied by perl prior
15142    to this and will be provided as the regexp *r argument, however 
15143    with the /old/ structures pprivate pointer value. Thus this routine
15144    may override any copying normally done by perl.
15145    
15146    It returns a pointer to the new regexp_internal structure.
15147 */
15148
15149 void *
15150 Perl_regdupe_internal(pTHX_ REGEXP * const rx, CLONE_PARAMS *param)
15151 {
15152     dVAR;
15153     struct regexp *const r = ReANY(rx);
15154     regexp_internal *reti;
15155     int len;
15156     RXi_GET_DECL(r,ri);
15157
15158     PERL_ARGS_ASSERT_REGDUPE_INTERNAL;
15159     
15160     len = ProgLen(ri);
15161     
15162     Newxc(reti, sizeof(regexp_internal) + len*sizeof(regnode), char, regexp_internal);
15163     Copy(ri->program, reti->program, len+1, regnode);
15164
15165     reti->num_code_blocks = ri->num_code_blocks;
15166     if (ri->code_blocks) {
15167         int n;
15168         Newxc(reti->code_blocks, ri->num_code_blocks, struct reg_code_block,
15169                 struct reg_code_block);
15170         Copy(ri->code_blocks, reti->code_blocks, ri->num_code_blocks,
15171                 struct reg_code_block);
15172         for (n = 0; n < ri->num_code_blocks; n++)
15173              reti->code_blocks[n].src_regex = (REGEXP*)
15174                     sv_dup_inc((SV*)(ri->code_blocks[n].src_regex), param);
15175     }
15176     else
15177         reti->code_blocks = NULL;
15178
15179     reti->regstclass = NULL;
15180
15181     if (ri->data) {
15182         struct reg_data *d;
15183         const int count = ri->data->count;
15184         int i;
15185
15186         Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
15187                 char, struct reg_data);
15188         Newx(d->what, count, U8);
15189
15190         d->count = count;
15191         for (i = 0; i < count; i++) {
15192             d->what[i] = ri->data->what[i];
15193             switch (d->what[i]) {
15194                 /* see also regcomp.h and regfree_internal() */
15195             case 'a': /* actually an AV, but the dup function is identical.  */
15196             case 'r':
15197             case 's':
15198             case 'S':
15199             case 'u': /* actually an HV, but the dup function is identical.  */
15200                 d->data[i] = sv_dup_inc((const SV *)ri->data->data[i], param);
15201                 break;
15202             case 'f':
15203                 /* This is cheating. */
15204                 Newx(d->data[i], 1, struct regnode_charclass_class);
15205                 StructCopy(ri->data->data[i], d->data[i],
15206                             struct regnode_charclass_class);
15207                 reti->regstclass = (regnode*)d->data[i];
15208                 break;
15209             case 'T':
15210                 /* Trie stclasses are readonly and can thus be shared
15211                  * without duplication. We free the stclass in pregfree
15212                  * when the corresponding reg_ac_data struct is freed.
15213                  */
15214                 reti->regstclass= ri->regstclass;
15215                 /* Fall through */
15216             case 't':
15217                 OP_REFCNT_LOCK;
15218                 ((reg_trie_data*)ri->data->data[i])->refcount++;
15219                 OP_REFCNT_UNLOCK;
15220                 /* Fall through */
15221             case 'l':
15222             case 'L':
15223                 d->data[i] = ri->data->data[i];
15224                 break;
15225             default:
15226                 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", ri->data->what[i]);
15227             }
15228         }
15229
15230         reti->data = d;
15231     }
15232     else
15233         reti->data = NULL;
15234
15235     reti->name_list_idx = ri->name_list_idx;
15236
15237 #ifdef RE_TRACK_PATTERN_OFFSETS
15238     if (ri->u.offsets) {
15239         Newx(reti->u.offsets, 2*len+1, U32);
15240         Copy(ri->u.offsets, reti->u.offsets, 2*len+1, U32);
15241     }
15242 #else
15243     SetProgLen(reti,len);
15244 #endif
15245
15246     return (void*)reti;
15247 }
15248
15249 #endif    /* USE_ITHREADS */
15250
15251 #ifndef PERL_IN_XSUB_RE
15252
15253 /*
15254  - regnext - dig the "next" pointer out of a node
15255  */
15256 regnode *
15257 Perl_regnext(pTHX_ regnode *p)
15258 {
15259     dVAR;
15260     I32 offset;
15261
15262     if (!p)
15263         return(NULL);
15264
15265     if (OP(p) > REGNODE_MAX) {          /* regnode.type is unsigned */
15266         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d", (int)OP(p), (int)REGNODE_MAX);
15267     }
15268
15269     offset = (reg_off_by_arg[OP(p)] ? ARG(p) : NEXT_OFF(p));
15270     if (offset == 0)
15271         return(NULL);
15272
15273     return(p+offset);
15274 }
15275 #endif
15276
15277 STATIC void
15278 S_re_croak2(pTHX_ const char* pat1,const char* pat2,...)
15279 {
15280     va_list args;
15281     STRLEN l1 = strlen(pat1);
15282     STRLEN l2 = strlen(pat2);
15283     char buf[512];
15284     SV *msv;
15285     const char *message;
15286
15287     PERL_ARGS_ASSERT_RE_CROAK2;
15288
15289     if (l1 > 510)
15290         l1 = 510;
15291     if (l1 + l2 > 510)
15292         l2 = 510 - l1;
15293     Copy(pat1, buf, l1 , char);
15294     Copy(pat2, buf + l1, l2 , char);
15295     buf[l1 + l2] = '\n';
15296     buf[l1 + l2 + 1] = '\0';
15297 #ifdef I_STDARG
15298     /* ANSI variant takes additional second argument */
15299     va_start(args, pat2);
15300 #else
15301     va_start(args);
15302 #endif
15303     msv = vmess(buf, &args);
15304     va_end(args);
15305     message = SvPV_const(msv,l1);
15306     if (l1 > 512)
15307         l1 = 512;
15308     Copy(message, buf, l1 , char);
15309     buf[l1-1] = '\0';                   /* Overwrite \n */
15310     Perl_croak(aTHX_ "%s", buf);
15311 }
15312
15313 /* XXX Here's a total kludge.  But we need to re-enter for swash routines. */
15314
15315 #ifndef PERL_IN_XSUB_RE
15316 void
15317 Perl_save_re_context(pTHX)
15318 {
15319     dVAR;
15320
15321     struct re_save_state *state;
15322
15323     SAVEVPTR(PL_curcop);
15324     SSGROW(SAVESTACK_ALLOC_FOR_RE_SAVE_STATE + 1);
15325
15326     state = (struct re_save_state *)(PL_savestack + PL_savestack_ix);
15327     PL_savestack_ix += SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
15328     SSPUSHUV(SAVEt_RE_STATE);
15329
15330     Copy(&PL_reg_state, state, 1, struct re_save_state);
15331
15332     PL_reg_oldsaved = NULL;
15333     PL_reg_oldsavedlen = 0;
15334     PL_reg_oldsavedoffset = 0;
15335     PL_reg_oldsavedcoffset = 0;
15336     PL_reg_maxiter = 0;
15337     PL_reg_leftiter = 0;
15338     PL_reg_poscache = NULL;
15339     PL_reg_poscache_size = 0;
15340 #ifdef PERL_ANY_COW
15341     PL_nrs = NULL;
15342 #endif
15343
15344     /* Save $1..$n (#18107: UTF-8 s/(\w+)/uc($1)/e); AMS 20021106. */
15345     if (PL_curpm) {
15346         const REGEXP * const rx = PM_GETRE(PL_curpm);
15347         if (rx) {
15348             U32 i;
15349             for (i = 1; i <= RX_NPARENS(rx); i++) {
15350                 char digits[TYPE_CHARS(long)];
15351                 const STRLEN len = my_snprintf(digits, sizeof(digits), "%lu", (long)i);
15352                 GV *const *const gvp
15353                     = (GV**)hv_fetch(PL_defstash, digits, len, 0);
15354
15355                 if (gvp) {
15356                     GV * const gv = *gvp;
15357                     if (SvTYPE(gv) == SVt_PVGV && GvSV(gv))
15358                         save_scalar(gv);
15359                 }
15360             }
15361         }
15362     }
15363 }
15364 #endif
15365
15366 #ifdef DEBUGGING
15367
15368 STATIC void
15369 S_put_byte(pTHX_ SV *sv, int c)
15370 {
15371     PERL_ARGS_ASSERT_PUT_BYTE;
15372
15373     /* Our definition of isPRINT() ignores locales, so only bytes that are
15374        not part of UTF-8 are considered printable. I assume that the same
15375        holds for UTF-EBCDIC.
15376        Also, code point 255 is not printable in either (it's E0 in EBCDIC,
15377        which Wikipedia says:
15378
15379        EO, or Eight Ones, is an 8-bit EBCDIC character code represented as all
15380        ones (binary 1111 1111, hexadecimal FF). It is similar, but not
15381        identical, to the ASCII delete (DEL) or rubout control character. ...
15382        it is typically mapped to hexadecimal code 9F, in order to provide a
15383        unique character mapping in both directions)
15384
15385        So the old condition can be simplified to !isPRINT(c)  */
15386     if (!isPRINT(c)) {
15387         if (c < 256) {
15388             Perl_sv_catpvf(aTHX_ sv, "\\x%02x", c);
15389         }
15390         else {
15391             Perl_sv_catpvf(aTHX_ sv, "\\x{%x}", c);
15392         }
15393     }
15394     else {
15395         const char string = c;
15396         if (c == '-' || c == ']' || c == '\\' || c == '^')
15397             sv_catpvs(sv, "\\");
15398         sv_catpvn(sv, &string, 1);
15399     }
15400 }
15401
15402
15403 #define CLEAR_OPTSTART \
15404     if (optstart) STMT_START { \
15405             DEBUG_OPTIMISE_r(PerlIO_printf(Perl_debug_log, " (%"IVdf" nodes)\n", (IV)(node - optstart))); \
15406             optstart=NULL; \
15407     } STMT_END
15408
15409 #define DUMPUNTIL(b,e) CLEAR_OPTSTART; node=dumpuntil(r,start,(b),(e),last,sv,indent+1,depth+1);
15410
15411 STATIC const regnode *
15412 S_dumpuntil(pTHX_ const regexp *r, const regnode *start, const regnode *node,
15413             const regnode *last, const regnode *plast, 
15414             SV* sv, I32 indent, U32 depth)
15415 {
15416     dVAR;
15417     U8 op = PSEUDO;     /* Arbitrary non-END op. */
15418     const regnode *next;
15419     const regnode *optstart= NULL;
15420     
15421     RXi_GET_DECL(r,ri);
15422     GET_RE_DEBUG_FLAGS_DECL;
15423
15424     PERL_ARGS_ASSERT_DUMPUNTIL;
15425
15426 #ifdef DEBUG_DUMPUNTIL
15427     PerlIO_printf(Perl_debug_log, "--- %d : %d - %d - %d\n",indent,node-start,
15428         last ? last-start : 0,plast ? plast-start : 0);
15429 #endif
15430             
15431     if (plast && plast < last) 
15432         last= plast;
15433
15434     while (PL_regkind[op] != END && (!last || node < last)) {
15435         /* While that wasn't END last time... */
15436         NODE_ALIGN(node);
15437         op = OP(node);
15438         if (op == CLOSE || op == WHILEM)
15439             indent--;
15440         next = regnext((regnode *)node);
15441
15442         /* Where, what. */
15443         if (OP(node) == OPTIMIZED) {
15444             if (!optstart && RE_DEBUG_FLAG(RE_DEBUG_COMPILE_OPTIMISE))
15445                 optstart = node;
15446             else
15447                 goto after_print;
15448         } else
15449             CLEAR_OPTSTART;
15450
15451         regprop(r, sv, node);
15452         PerlIO_printf(Perl_debug_log, "%4"IVdf":%*s%s", (IV)(node - start),
15453                       (int)(2*indent + 1), "", SvPVX_const(sv));
15454         
15455         if (OP(node) != OPTIMIZED) {                  
15456             if (next == NULL)           /* Next ptr. */
15457                 PerlIO_printf(Perl_debug_log, " (0)");
15458             else if (PL_regkind[(U8)op] == BRANCH && PL_regkind[OP(next)] != BRANCH )
15459                 PerlIO_printf(Perl_debug_log, " (FAIL)");
15460             else 
15461                 PerlIO_printf(Perl_debug_log, " (%"IVdf")", (IV)(next - start));
15462             (void)PerlIO_putc(Perl_debug_log, '\n'); 
15463         }
15464         
15465       after_print:
15466         if (PL_regkind[(U8)op] == BRANCHJ) {
15467             assert(next);
15468             {
15469                 const regnode *nnode = (OP(next) == LONGJMP
15470                                        ? regnext((regnode *)next)
15471                                        : next);
15472                 if (last && nnode > last)
15473                     nnode = last;
15474                 DUMPUNTIL(NEXTOPER(NEXTOPER(node)), nnode);
15475             }
15476         }
15477         else if (PL_regkind[(U8)op] == BRANCH) {
15478             assert(next);
15479             DUMPUNTIL(NEXTOPER(node), next);
15480         }
15481         else if ( PL_regkind[(U8)op]  == TRIE ) {
15482             const regnode *this_trie = node;
15483             const char op = OP(node);
15484             const U32 n = ARG(node);
15485             const reg_ac_data * const ac = op>=AHOCORASICK ?
15486                (reg_ac_data *)ri->data->data[n] :
15487                NULL;
15488             const reg_trie_data * const trie =
15489                 (reg_trie_data*)ri->data->data[op<AHOCORASICK ? n : ac->trie];
15490 #ifdef DEBUGGING
15491             AV *const trie_words = MUTABLE_AV(ri->data->data[n + TRIE_WORDS_OFFSET]);
15492 #endif
15493             const regnode *nextbranch= NULL;
15494             I32 word_idx;
15495             sv_setpvs(sv, "");
15496             for (word_idx= 0; word_idx < (I32)trie->wordcount; word_idx++) {
15497                 SV ** const elem_ptr = av_fetch(trie_words,word_idx,0);
15498
15499                 PerlIO_printf(Perl_debug_log, "%*s%s ",
15500                    (int)(2*(indent+3)), "",
15501                     elem_ptr ? pv_pretty(sv, SvPV_nolen_const(*elem_ptr), SvCUR(*elem_ptr), 60,
15502                             PL_colors[0], PL_colors[1],
15503                             (SvUTF8(*elem_ptr) ? PERL_PV_ESCAPE_UNI : 0) |
15504                             PERL_PV_PRETTY_ELLIPSES    |
15505                             PERL_PV_PRETTY_LTGT
15506                             )
15507                             : "???"
15508                 );
15509                 if (trie->jump) {
15510                     U16 dist= trie->jump[word_idx+1];
15511                     PerlIO_printf(Perl_debug_log, "(%"UVuf")\n",
15512                                   (UV)((dist ? this_trie + dist : next) - start));
15513                     if (dist) {
15514                         if (!nextbranch)
15515                             nextbranch= this_trie + trie->jump[0];    
15516                         DUMPUNTIL(this_trie + dist, nextbranch);
15517                     }
15518                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
15519                         nextbranch= regnext((regnode *)nextbranch);
15520                 } else {
15521                     PerlIO_printf(Perl_debug_log, "\n");
15522                 }
15523             }
15524             if (last && next > last)
15525                 node= last;
15526             else
15527                 node= next;
15528         }
15529         else if ( op == CURLY ) {   /* "next" might be very big: optimizer */
15530             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS,
15531                     NEXTOPER(node) + EXTRA_STEP_2ARGS + 1);
15532         }
15533         else if (PL_regkind[(U8)op] == CURLY && op != CURLYX) {
15534             assert(next);
15535             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS, next);
15536         }
15537         else if ( op == PLUS || op == STAR) {
15538             DUMPUNTIL(NEXTOPER(node), NEXTOPER(node) + 1);
15539         }
15540         else if (PL_regkind[(U8)op] == ANYOF) {
15541             /* arglen 1 + class block */
15542             node += 1 + ((ANYOF_FLAGS(node) & ANYOF_CLASS)
15543                     ? ANYOF_CLASS_SKIP : ANYOF_SKIP);
15544             node = NEXTOPER(node);
15545         }
15546         else if (PL_regkind[(U8)op] == EXACT) {
15547             /* Literal string, where present. */
15548             node += NODE_SZ_STR(node) - 1;
15549             node = NEXTOPER(node);
15550         }
15551         else {
15552             node = NEXTOPER(node);
15553             node += regarglen[(U8)op];
15554         }
15555         if (op == CURLYX || op == OPEN)
15556             indent++;
15557     }
15558     CLEAR_OPTSTART;
15559 #ifdef DEBUG_DUMPUNTIL    
15560     PerlIO_printf(Perl_debug_log, "--- %d\n", (int)indent);
15561 #endif
15562     return node;
15563 }
15564
15565 #endif  /* DEBUGGING */
15566
15567 /*
15568  * Local variables:
15569  * c-indentation-style: bsd
15570  * c-basic-offset: 4
15571  * indent-tabs-mode: nil
15572  * End:
15573  *
15574  * ex: set ts=8 sts=4 sw=4 et:
15575  */