]> git.vpit.fr Git - perl/modules/re-engine-Hooks.git/blob - src/5017009/regcomp.c
Add support for perl 5.14.4, 5.16.3, 5.17.{9,10}, 5.18.0 and 5.19.0
[perl/modules/re-engine-Hooks.git] / src / 5017009 / regcomp.c
1 /*    regcomp.c
2  */
3
4 /*
5  * 'A fair jaw-cracker dwarf-language must be.'            --Samwise Gamgee
6  *
7  *     [p.285 of _The Lord of the Rings_, II/iii: "The Ring Goes South"]
8  */
9
10 /* This file contains functions for compiling a regular expression.  See
11  * also regexec.c which funnily enough, contains functions for executing
12  * a regular expression.
13  *
14  * This file is also copied at build time to ext/re/re_comp.c, where
15  * it's built with -DPERL_EXT_RE_BUILD -DPERL_EXT_RE_DEBUG -DPERL_EXT.
16  * This causes the main functions to be compiled under new names and with
17  * debugging support added, which makes "use re 'debug'" work.
18  */
19
20 /* NOTE: this is derived from Henry Spencer's regexp code, and should not
21  * confused with the original package (see point 3 below).  Thanks, Henry!
22  */
23
24 /* Additional note: this code is very heavily munged from Henry's version
25  * in places.  In some spots I've traded clarity for efficiency, so don't
26  * blame Henry for some of the lack of readability.
27  */
28
29 /* The names of the functions have been changed from regcomp and
30  * regexec to pregcomp and pregexec in order to avoid conflicts
31  * with the POSIX routines of the same names.
32 */
33
34 #ifdef PERL_EXT_RE_BUILD
35 #include "re_top.h"
36 #endif
37
38 /*
39  * pregcomp and pregexec -- regsub and regerror are not used in perl
40  *
41  *      Copyright (c) 1986 by University of Toronto.
42  *      Written by Henry Spencer.  Not derived from licensed software.
43  *
44  *      Permission is granted to anyone to use this software for any
45  *      purpose on any computer system, and to redistribute it freely,
46  *      subject to the following restrictions:
47  *
48  *      1. The author is not responsible for the consequences of use of
49  *              this software, no matter how awful, even if they arise
50  *              from defects in it.
51  *
52  *      2. The origin of this software must not be misrepresented, either
53  *              by explicit claim or by omission.
54  *
55  *      3. Altered versions must be plainly marked as such, and must not
56  *              be misrepresented as being the original software.
57  *
58  *
59  ****    Alterations to Henry's code are...
60  ****
61  ****    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
62  ****    2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
63  ****    by Larry Wall and others
64  ****
65  ****    You may distribute under the terms of either the GNU General Public
66  ****    License or the Artistic License, as specified in the README file.
67
68  *
69  * Beware that some of this code is subtly aware of the way operator
70  * precedence is structured in regular expressions.  Serious changes in
71  * regular-expression syntax might require a total rethink.
72  */
73 #include "EXTERN.h"
74 #define PERL_IN_REGCOMP_C
75 #include "perl.h"
76
77 #ifndef PERL_IN_XSUB_RE
78 #include "re_defs.h"
79 #endif
80
81 #define REG_COMP_C
82 #ifdef PERL_IN_XSUB_RE
83 #  include "re_comp.h"
84 extern const struct regexp_engine my_reg_engine;
85 #else
86 #  include "regcomp.h"
87 #endif
88
89 #include "dquote_static.c"
90 #include "charclass_invlists.h"
91 #include "inline_invlist.c"
92 #include "unicode_constants.h"
93
94 #define HAS_NONLATIN1_FOLD_CLOSURE(i) _HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(i)
95 #define IS_NON_FINAL_FOLD(c) _IS_NON_FINAL_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c)
96 #define IS_IN_SOME_FOLD_L1(c) _IS_IN_SOME_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c)
97
98 #ifdef op
99 #undef op
100 #endif /* op */
101
102 #ifdef MSDOS
103 #  if defined(BUGGY_MSC6)
104  /* MSC 6.00A breaks on op/regexp.t test 85 unless we turn this off */
105 #    pragma optimize("a",off)
106  /* But MSC 6.00A is happy with 'w', for aliases only across function calls*/
107 #    pragma optimize("w",on )
108 #  endif /* BUGGY_MSC6 */
109 #endif /* MSDOS */
110
111 #ifndef STATIC
112 #define STATIC  static
113 #endif
114
115
116 typedef struct RExC_state_t {
117     U32         flags;                  /* RXf_* are we folding, multilining? */
118     U32         pm_flags;               /* PMf_* stuff from the calling PMOP */
119     char        *precomp;               /* uncompiled string. */
120     REGEXP      *rx_sv;                 /* The SV that is the regexp. */
121     regexp      *rx;                    /* perl core regexp structure */
122     regexp_internal     *rxi;           /* internal data for regexp object pprivate field */        
123     char        *start;                 /* Start of input for compile */
124     char        *end;                   /* End of input for compile */
125     char        *parse;                 /* Input-scan pointer. */
126     I32         whilem_seen;            /* number of WHILEM in this expr */
127     regnode     *emit_start;            /* Start of emitted-code area */
128     regnode     *emit_bound;            /* First regnode outside of the allocated space */
129     regnode     *emit;                  /* Code-emit pointer; &regdummy = don't = compiling */
130     I32         naughty;                /* How bad is this pattern? */
131     I32         sawback;                /* Did we see \1, ...? */
132     U32         seen;
133     I32         size;                   /* Code size. */
134     I32         npar;                   /* Capture buffer count, (OPEN). */
135     I32         cpar;                   /* Capture buffer count, (CLOSE). */
136     I32         nestroot;               /* root parens we are in - used by accept */
137     I32         extralen;
138     I32         seen_zerolen;
139     regnode     **open_parens;          /* pointers to open parens */
140     regnode     **close_parens;         /* pointers to close parens */
141     regnode     *opend;                 /* END node in program */
142     I32         utf8;           /* whether the pattern is utf8 or not */
143     I32         orig_utf8;      /* whether the pattern was originally in utf8 */
144                                 /* XXX use this for future optimisation of case
145                                  * where pattern must be upgraded to utf8. */
146     I32         uni_semantics;  /* If a d charset modifier should use unicode
147                                    rules, even if the pattern is not in
148                                    utf8 */
149     HV          *paren_names;           /* Paren names */
150     
151     regnode     **recurse;              /* Recurse regops */
152     I32         recurse_count;          /* Number of recurse regops */
153     I32         in_lookbehind;
154     I32         contains_locale;
155     I32         override_recoding;
156     I32         in_multi_char_class;
157     struct reg_code_block *code_blocks; /* positions of literal (?{})
158                                             within pattern */
159     int         num_code_blocks;        /* size of code_blocks[] */
160     int         code_index;             /* next code_blocks[] slot */
161 #if ADD_TO_REGEXEC
162     char        *starttry;              /* -Dr: where regtry was called. */
163 #define RExC_starttry   (pRExC_state->starttry)
164 #endif
165     SV          *runtime_code_qr;       /* qr with the runtime code blocks */
166 #ifdef DEBUGGING
167     const char  *lastparse;
168     I32         lastnum;
169     AV          *paren_name_list;       /* idx -> name */
170 #define RExC_lastparse  (pRExC_state->lastparse)
171 #define RExC_lastnum    (pRExC_state->lastnum)
172 #define RExC_paren_name_list    (pRExC_state->paren_name_list)
173 #endif
174 } RExC_state_t;
175
176 #define RExC_flags      (pRExC_state->flags)
177 #define RExC_pm_flags   (pRExC_state->pm_flags)
178 #define RExC_precomp    (pRExC_state->precomp)
179 #define RExC_rx_sv      (pRExC_state->rx_sv)
180 #define RExC_rx         (pRExC_state->rx)
181 #define RExC_rxi        (pRExC_state->rxi)
182 #define RExC_start      (pRExC_state->start)
183 #define RExC_end        (pRExC_state->end)
184 #define RExC_parse      (pRExC_state->parse)
185 #define RExC_whilem_seen        (pRExC_state->whilem_seen)
186 #ifdef RE_TRACK_PATTERN_OFFSETS
187 #define RExC_offsets    (pRExC_state->rxi->u.offsets) /* I am not like the others */
188 #endif
189 #define RExC_emit       (pRExC_state->emit)
190 #define RExC_emit_start (pRExC_state->emit_start)
191 #define RExC_emit_bound (pRExC_state->emit_bound)
192 #define RExC_naughty    (pRExC_state->naughty)
193 #define RExC_sawback    (pRExC_state->sawback)
194 #define RExC_seen       (pRExC_state->seen)
195 #define RExC_size       (pRExC_state->size)
196 #define RExC_npar       (pRExC_state->npar)
197 #define RExC_nestroot   (pRExC_state->nestroot)
198 #define RExC_extralen   (pRExC_state->extralen)
199 #define RExC_seen_zerolen       (pRExC_state->seen_zerolen)
200 #define RExC_utf8       (pRExC_state->utf8)
201 #define RExC_uni_semantics      (pRExC_state->uni_semantics)
202 #define RExC_orig_utf8  (pRExC_state->orig_utf8)
203 #define RExC_open_parens        (pRExC_state->open_parens)
204 #define RExC_close_parens       (pRExC_state->close_parens)
205 #define RExC_opend      (pRExC_state->opend)
206 #define RExC_paren_names        (pRExC_state->paren_names)
207 #define RExC_recurse    (pRExC_state->recurse)
208 #define RExC_recurse_count      (pRExC_state->recurse_count)
209 #define RExC_in_lookbehind      (pRExC_state->in_lookbehind)
210 #define RExC_contains_locale    (pRExC_state->contains_locale)
211 #define RExC_override_recoding (pRExC_state->override_recoding)
212 #define RExC_in_multi_char_class (pRExC_state->in_multi_char_class)
213
214
215 #define ISMULT1(c)      ((c) == '*' || (c) == '+' || (c) == '?')
216 #define ISMULT2(s)      ((*s) == '*' || (*s) == '+' || (*s) == '?' || \
217         ((*s) == '{' && regcurly(s, FALSE)))
218
219 #ifdef SPSTART
220 #undef SPSTART          /* dratted cpp namespace... */
221 #endif
222 /*
223  * Flags to be passed up and down.
224  */
225 #define WORST           0       /* Worst case. */
226 #define HASWIDTH        0x01    /* Known to match non-null strings. */
227
228 /* Simple enough to be STAR/PLUS operand; in an EXACTish node must be a single
229  * character.  (There needs to be a case: in the switch statement in regexec.c
230  * for any node marked SIMPLE.)  Note that this is not the same thing as
231  * REGNODE_SIMPLE */
232 #define SIMPLE          0x02
233 #define SPSTART         0x04    /* Starts with * or + */
234 #define TRYAGAIN        0x08    /* Weeded out a declaration. */
235 #define POSTPONED       0x10    /* (?1),(?&name), (??{...}) or similar */
236
237 #define REG_NODE_NUM(x) ((x) ? (int)((x)-RExC_emit_start) : -1)
238
239 /* whether trie related optimizations are enabled */
240 #if PERL_ENABLE_EXTENDED_TRIE_OPTIMISATION
241 #define TRIE_STUDY_OPT
242 #define FULL_TRIE_STUDY
243 #define TRIE_STCLASS
244 #endif
245
246
247
248 #define PBYTE(u8str,paren) ((U8*)(u8str))[(paren) >> 3]
249 #define PBITVAL(paren) (1 << ((paren) & 7))
250 #define PAREN_TEST(u8str,paren) ( PBYTE(u8str,paren) & PBITVAL(paren))
251 #define PAREN_SET(u8str,paren) PBYTE(u8str,paren) |= PBITVAL(paren)
252 #define PAREN_UNSET(u8str,paren) PBYTE(u8str,paren) &= (~PBITVAL(paren))
253
254 /* If not already in utf8, do a longjmp back to the beginning */
255 #define UTF8_LONGJMP 42 /* Choose a value not likely to ever conflict */
256 #define REQUIRE_UTF8    STMT_START {                                       \
257                                      if (! UTF) JMPENV_JUMP(UTF8_LONGJMP); \
258                         } STMT_END
259
260 /* This converts the named class defined in regcomp.h to its equivalent class
261  * number defined in handy.h. */
262 #define namedclass_to_classnum(class)  ((int) ((class) / 2))
263 #define classnum_to_namedclass(classnum)  ((classnum) * 2)
264
265 /* About scan_data_t.
266
267   During optimisation we recurse through the regexp program performing
268   various inplace (keyhole style) optimisations. In addition study_chunk
269   and scan_commit populate this data structure with information about
270   what strings MUST appear in the pattern. We look for the longest 
271   string that must appear at a fixed location, and we look for the
272   longest string that may appear at a floating location. So for instance
273   in the pattern:
274   
275     /FOO[xX]A.*B[xX]BAR/
276     
277   Both 'FOO' and 'A' are fixed strings. Both 'B' and 'BAR' are floating
278   strings (because they follow a .* construct). study_chunk will identify
279   both FOO and BAR as being the longest fixed and floating strings respectively.
280   
281   The strings can be composites, for instance
282   
283      /(f)(o)(o)/
284      
285   will result in a composite fixed substring 'foo'.
286   
287   For each string some basic information is maintained:
288   
289   - offset or min_offset
290     This is the position the string must appear at, or not before.
291     It also implicitly (when combined with minlenp) tells us how many
292     characters must match before the string we are searching for.
293     Likewise when combined with minlenp and the length of the string it
294     tells us how many characters must appear after the string we have 
295     found.
296   
297   - max_offset
298     Only used for floating strings. This is the rightmost point that
299     the string can appear at. If set to I32 max it indicates that the
300     string can occur infinitely far to the right.
301   
302   - minlenp
303     A pointer to the minimum number of characters of the pattern that the
304     string was found inside. This is important as in the case of positive
305     lookahead or positive lookbehind we can have multiple patterns 
306     involved. Consider
307     
308     /(?=FOO).*F/
309     
310     The minimum length of the pattern overall is 3, the minimum length
311     of the lookahead part is 3, but the minimum length of the part that
312     will actually match is 1. So 'FOO's minimum length is 3, but the 
313     minimum length for the F is 1. This is important as the minimum length
314     is used to determine offsets in front of and behind the string being 
315     looked for.  Since strings can be composites this is the length of the
316     pattern at the time it was committed with a scan_commit. Note that
317     the length is calculated by study_chunk, so that the minimum lengths
318     are not known until the full pattern has been compiled, thus the 
319     pointer to the value.
320   
321   - lookbehind
322   
323     In the case of lookbehind the string being searched for can be
324     offset past the start point of the final matching string. 
325     If this value was just blithely removed from the min_offset it would
326     invalidate some of the calculations for how many chars must match
327     before or after (as they are derived from min_offset and minlen and
328     the length of the string being searched for). 
329     When the final pattern is compiled and the data is moved from the
330     scan_data_t structure into the regexp structure the information
331     about lookbehind is factored in, with the information that would 
332     have been lost precalculated in the end_shift field for the 
333     associated string.
334
335   The fields pos_min and pos_delta are used to store the minimum offset
336   and the delta to the maximum offset at the current point in the pattern.    
337
338 */
339
340 typedef struct scan_data_t {
341     /*I32 len_min;      unused */
342     /*I32 len_delta;    unused */
343     I32 pos_min;
344     I32 pos_delta;
345     SV *last_found;
346     I32 last_end;           /* min value, <0 unless valid. */
347     I32 last_start_min;
348     I32 last_start_max;
349     SV **longest;           /* Either &l_fixed, or &l_float. */
350     SV *longest_fixed;      /* longest fixed string found in pattern */
351     I32 offset_fixed;       /* offset where it starts */
352     I32 *minlen_fixed;      /* pointer to the minlen relevant to the string */
353     I32 lookbehind_fixed;   /* is the position of the string modfied by LB */
354     SV *longest_float;      /* longest floating string found in pattern */
355     I32 offset_float_min;   /* earliest point in string it can appear */
356     I32 offset_float_max;   /* latest point in string it can appear */
357     I32 *minlen_float;      /* pointer to the minlen relevant to the string */
358     I32 lookbehind_float;   /* is the position of the string modified by LB */
359     I32 flags;
360     I32 whilem_c;
361     I32 *last_closep;
362     struct regnode_charclass_class *start_class;
363 } scan_data_t;
364
365 /*
366  * Forward declarations for pregcomp()'s friends.
367  */
368
369 static const scan_data_t zero_scan_data =
370   { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ,0};
371
372 #define SF_BEFORE_EOL           (SF_BEFORE_SEOL|SF_BEFORE_MEOL)
373 #define SF_BEFORE_SEOL          0x0001
374 #define SF_BEFORE_MEOL          0x0002
375 #define SF_FIX_BEFORE_EOL       (SF_FIX_BEFORE_SEOL|SF_FIX_BEFORE_MEOL)
376 #define SF_FL_BEFORE_EOL        (SF_FL_BEFORE_SEOL|SF_FL_BEFORE_MEOL)
377
378 #ifdef NO_UNARY_PLUS
379 #  define SF_FIX_SHIFT_EOL      (0+2)
380 #  define SF_FL_SHIFT_EOL               (0+4)
381 #else
382 #  define SF_FIX_SHIFT_EOL      (+2)
383 #  define SF_FL_SHIFT_EOL               (+4)
384 #endif
385
386 #define SF_FIX_BEFORE_SEOL      (SF_BEFORE_SEOL << SF_FIX_SHIFT_EOL)
387 #define SF_FIX_BEFORE_MEOL      (SF_BEFORE_MEOL << SF_FIX_SHIFT_EOL)
388
389 #define SF_FL_BEFORE_SEOL       (SF_BEFORE_SEOL << SF_FL_SHIFT_EOL)
390 #define SF_FL_BEFORE_MEOL       (SF_BEFORE_MEOL << SF_FL_SHIFT_EOL) /* 0x20 */
391 #define SF_IS_INF               0x0040
392 #define SF_HAS_PAR              0x0080
393 #define SF_IN_PAR               0x0100
394 #define SF_HAS_EVAL             0x0200
395 #define SCF_DO_SUBSTR           0x0400
396 #define SCF_DO_STCLASS_AND      0x0800
397 #define SCF_DO_STCLASS_OR       0x1000
398 #define SCF_DO_STCLASS          (SCF_DO_STCLASS_AND|SCF_DO_STCLASS_OR)
399 #define SCF_WHILEM_VISITED_POS  0x2000
400
401 #define SCF_TRIE_RESTUDY        0x4000 /* Do restudy? */
402 #define SCF_SEEN_ACCEPT         0x8000 
403
404 #define UTF cBOOL(RExC_utf8)
405
406 /* The enums for all these are ordered so things work out correctly */
407 #define LOC (get_regex_charset(RExC_flags) == REGEX_LOCALE_CHARSET)
408 #define DEPENDS_SEMANTICS (get_regex_charset(RExC_flags) == REGEX_DEPENDS_CHARSET)
409 #define UNI_SEMANTICS (get_regex_charset(RExC_flags) == REGEX_UNICODE_CHARSET)
410 #define AT_LEAST_UNI_SEMANTICS (get_regex_charset(RExC_flags) >= REGEX_UNICODE_CHARSET)
411 #define ASCII_RESTRICTED (get_regex_charset(RExC_flags) == REGEX_ASCII_RESTRICTED_CHARSET)
412 #define AT_LEAST_ASCII_RESTRICTED (get_regex_charset(RExC_flags) >= REGEX_ASCII_RESTRICTED_CHARSET)
413 #define ASCII_FOLD_RESTRICTED (get_regex_charset(RExC_flags) == REGEX_ASCII_MORE_RESTRICTED_CHARSET)
414
415 #define FOLD cBOOL(RExC_flags & RXf_PMf_FOLD)
416
417 #define OOB_NAMEDCLASS          -1
418
419 /* There is no code point that is out-of-bounds, so this is problematic.  But
420  * its only current use is to initialize a variable that is always set before
421  * looked at. */
422 #define OOB_UNICODE             0xDEADBEEF
423
424 #define CHR_SVLEN(sv) (UTF ? sv_len_utf8(sv) : SvCUR(sv))
425 #define CHR_DIST(a,b) (UTF ? utf8_distance(a,b) : a - b)
426
427
428 /* length of regex to show in messages that don't mark a position within */
429 #define RegexLengthToShowInErrorMessages 127
430
431 /*
432  * If MARKER[12] are adjusted, be sure to adjust the constants at the top
433  * of t/op/regmesg.t, the tests in t/op/re_tests, and those in
434  * op/pragma/warn/regcomp.
435  */
436 #define MARKER1 "<-- HERE"    /* marker as it appears in the description */
437 #define MARKER2 " <-- HERE "  /* marker as it appears within the regex */
438
439 #define REPORT_LOCATION " in regex; marked by " MARKER1 " in m/%.*s" MARKER2 "%s/"
440
441 /*
442  * Calls SAVEDESTRUCTOR_X if needed, then calls Perl_croak with the given
443  * arg. Show regex, up to a maximum length. If it's too long, chop and add
444  * "...".
445  */
446 #define _FAIL(code) STMT_START {                                        \
447     const char *ellipses = "";                                          \
448     IV len = RExC_end - RExC_precomp;                                   \
449                                                                         \
450     if (!SIZE_ONLY)                                                     \
451         SAVEFREESV(RExC_rx_sv);                                         \
452     if (len > RegexLengthToShowInErrorMessages) {                       \
453         /* chop 10 shorter than the max, to ensure meaning of "..." */  \
454         len = RegexLengthToShowInErrorMessages - 10;                    \
455         ellipses = "...";                                               \
456     }                                                                   \
457     code;                                                               \
458 } STMT_END
459
460 #define FAIL(msg) _FAIL(                            \
461     Perl_croak(aTHX_ "%s in regex m/%.*s%s/",       \
462             msg, (int)len, RExC_precomp, ellipses))
463
464 #define FAIL2(msg,arg) _FAIL(                       \
465     Perl_croak(aTHX_ msg " in regex m/%.*s%s/",     \
466             arg, (int)len, RExC_precomp, ellipses))
467
468 /*
469  * Simple_vFAIL -- like FAIL, but marks the current location in the scan
470  */
471 #define Simple_vFAIL(m) STMT_START {                                    \
472     const IV offset = RExC_parse - RExC_precomp;                        \
473     Perl_croak(aTHX_ "%s" REPORT_LOCATION,                              \
474             m, (int)offset, RExC_precomp, RExC_precomp + offset);       \
475 } STMT_END
476
477 /*
478  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL()
479  */
480 #define vFAIL(m) STMT_START {                           \
481     if (!SIZE_ONLY)                                     \
482         SAVEFREESV(RExC_rx_sv);                         \
483     Simple_vFAIL(m);                                    \
484 } STMT_END
485
486 /*
487  * Like Simple_vFAIL(), but accepts two arguments.
488  */
489 #define Simple_vFAIL2(m,a1) STMT_START {                        \
490     const IV offset = RExC_parse - RExC_precomp;                        \
491     S_re_croak2(aTHX_ m, REPORT_LOCATION, a1,                   \
492             (int)offset, RExC_precomp, RExC_precomp + offset);  \
493 } STMT_END
494
495 /*
496  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL2().
497  */
498 #define vFAIL2(m,a1) STMT_START {                       \
499     if (!SIZE_ONLY)                                     \
500         SAVEFREESV(RExC_rx_sv);                         \
501     Simple_vFAIL2(m, a1);                               \
502 } STMT_END
503
504
505 /*
506  * Like Simple_vFAIL(), but accepts three arguments.
507  */
508 #define Simple_vFAIL3(m, a1, a2) STMT_START {                   \
509     const IV offset = RExC_parse - RExC_precomp;                \
510     S_re_croak2(aTHX_ m, REPORT_LOCATION, a1, a2,               \
511             (int)offset, RExC_precomp, RExC_precomp + offset);  \
512 } STMT_END
513
514 /*
515  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL3().
516  */
517 #define vFAIL3(m,a1,a2) STMT_START {                    \
518     if (!SIZE_ONLY)                                     \
519         SAVEFREESV(RExC_rx_sv);                         \
520     Simple_vFAIL3(m, a1, a2);                           \
521 } STMT_END
522
523 /*
524  * Like Simple_vFAIL(), but accepts four arguments.
525  */
526 #define Simple_vFAIL4(m, a1, a2, a3) STMT_START {               \
527     const IV offset = RExC_parse - RExC_precomp;                \
528     S_re_croak2(aTHX_ m, REPORT_LOCATION, a1, a2, a3,           \
529             (int)offset, RExC_precomp, RExC_precomp + offset);  \
530 } STMT_END
531
532 #define vFAIL4(m,a1,a2,a3) STMT_START {                 \
533     if (!SIZE_ONLY)                                     \
534         SAVEFREESV(RExC_rx_sv);                         \
535     Simple_vFAIL4(m, a1, a2, a3);                       \
536 } STMT_END
537
538 /* m is not necessarily a "literal string", in this macro */
539 #define reg_warn_non_literal_string(loc, m) STMT_START {                \
540     const IV offset = loc - RExC_precomp;                               \
541     Perl_warner(aTHX_ packWARN(WARN_REGEXP), "%s" REPORT_LOCATION,      \
542             m, (int)offset, RExC_precomp, RExC_precomp + offset);       \
543 } STMT_END
544
545 #define ckWARNreg(loc,m) STMT_START {                                   \
546     const IV offset = loc - RExC_precomp;                               \
547     Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,      \
548             (int)offset, RExC_precomp, RExC_precomp + offset);          \
549 } STMT_END
550
551 #define vWARN_dep(loc, m) STMT_START {                                  \
552     const IV offset = loc - RExC_precomp;                               \
553     Perl_warner(aTHX_ packWARN(WARN_DEPRECATED), m REPORT_LOCATION,     \
554             (int)offset, RExC_precomp, RExC_precomp + offset);          \
555 } STMT_END
556
557 #define ckWARNdep(loc,m) STMT_START {                                   \
558     const IV offset = loc - RExC_precomp;                               \
559     Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED),                   \
560             m REPORT_LOCATION,                                          \
561             (int)offset, RExC_precomp, RExC_precomp + offset);          \
562 } STMT_END
563
564 #define ckWARNregdep(loc,m) STMT_START {                                \
565     const IV offset = loc - RExC_precomp;                               \
566     Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_REGEXP),     \
567             m REPORT_LOCATION,                                          \
568             (int)offset, RExC_precomp, RExC_precomp + offset);          \
569 } STMT_END
570
571 #define ckWARN2regdep(loc,m, a1) STMT_START {                           \
572     const IV offset = loc - RExC_precomp;                               \
573     Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_REGEXP),     \
574             m REPORT_LOCATION,                                          \
575             a1, (int)offset, RExC_precomp, RExC_precomp + offset);      \
576 } STMT_END
577
578 #define ckWARN2reg(loc, m, a1) STMT_START {                             \
579     const IV offset = loc - RExC_precomp;                               \
580     Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,      \
581             a1, (int)offset, RExC_precomp, RExC_precomp + offset);      \
582 } STMT_END
583
584 #define vWARN3(loc, m, a1, a2) STMT_START {                             \
585     const IV offset = loc - RExC_precomp;                               \
586     Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,         \
587             a1, a2, (int)offset, RExC_precomp, RExC_precomp + offset);  \
588 } STMT_END
589
590 #define ckWARN3reg(loc, m, a1, a2) STMT_START {                         \
591     const IV offset = loc - RExC_precomp;                               \
592     Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,      \
593             a1, a2, (int)offset, RExC_precomp, RExC_precomp + offset);  \
594 } STMT_END
595
596 #define vWARN4(loc, m, a1, a2, a3) STMT_START {                         \
597     const IV offset = loc - RExC_precomp;                               \
598     Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,         \
599             a1, a2, a3, (int)offset, RExC_precomp, RExC_precomp + offset); \
600 } STMT_END
601
602 #define ckWARN4reg(loc, m, a1, a2, a3) STMT_START {                     \
603     const IV offset = loc - RExC_precomp;                               \
604     Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,      \
605             a1, a2, a3, (int)offset, RExC_precomp, RExC_precomp + offset); \
606 } STMT_END
607
608 #define vWARN5(loc, m, a1, a2, a3, a4) STMT_START {                     \
609     const IV offset = loc - RExC_precomp;                               \
610     Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,         \
611             a1, a2, a3, a4, (int)offset, RExC_precomp, RExC_precomp + offset); \
612 } STMT_END
613
614
615 /* Allow for side effects in s */
616 #define REGC(c,s) STMT_START {                  \
617     if (!SIZE_ONLY) *(s) = (c); else (void)(s); \
618 } STMT_END
619
620 /* Macros for recording node offsets.   20001227 mjd@plover.com 
621  * Nodes are numbered 1, 2, 3, 4.  Node #n's position is recorded in
622  * element 2*n-1 of the array.  Element #2n holds the byte length node #n.
623  * Element 0 holds the number n.
624  * Position is 1 indexed.
625  */
626 #ifndef RE_TRACK_PATTERN_OFFSETS
627 #define Set_Node_Offset_To_R(node,byte)
628 #define Set_Node_Offset(node,byte)
629 #define Set_Cur_Node_Offset
630 #define Set_Node_Length_To_R(node,len)
631 #define Set_Node_Length(node,len)
632 #define Set_Node_Cur_Length(node)
633 #define Node_Offset(n) 
634 #define Node_Length(n) 
635 #define Set_Node_Offset_Length(node,offset,len)
636 #define ProgLen(ri) ri->u.proglen
637 #define SetProgLen(ri,x) ri->u.proglen = x
638 #else
639 #define ProgLen(ri) ri->u.offsets[0]
640 #define SetProgLen(ri,x) ri->u.offsets[0] = x
641 #define Set_Node_Offset_To_R(node,byte) STMT_START {                    \
642     if (! SIZE_ONLY) {                                                  \
643         MJD_OFFSET_DEBUG(("** (%d) offset of node %d is %d.\n",         \
644                     __LINE__, (int)(node), (int)(byte)));               \
645         if((node) < 0) {                                                \
646             Perl_croak(aTHX_ "value of node is %d in Offset macro", (int)(node)); \
647         } else {                                                        \
648             RExC_offsets[2*(node)-1] = (byte);                          \
649         }                                                               \
650     }                                                                   \
651 } STMT_END
652
653 #define Set_Node_Offset(node,byte) \
654     Set_Node_Offset_To_R((node)-RExC_emit_start, (byte)-RExC_start)
655 #define Set_Cur_Node_Offset Set_Node_Offset(RExC_emit, RExC_parse)
656
657 #define Set_Node_Length_To_R(node,len) STMT_START {                     \
658     if (! SIZE_ONLY) {                                                  \
659         MJD_OFFSET_DEBUG(("** (%d) size of node %d is %d.\n",           \
660                 __LINE__, (int)(node), (int)(len)));                    \
661         if((node) < 0) {                                                \
662             Perl_croak(aTHX_ "value of node is %d in Length macro", (int)(node)); \
663         } else {                                                        \
664             RExC_offsets[2*(node)] = (len);                             \
665         }                                                               \
666     }                                                                   \
667 } STMT_END
668
669 #define Set_Node_Length(node,len) \
670     Set_Node_Length_To_R((node)-RExC_emit_start, len)
671 #define Set_Cur_Node_Length(len) Set_Node_Length(RExC_emit, len)
672 #define Set_Node_Cur_Length(node) \
673     Set_Node_Length(node, RExC_parse - parse_start)
674
675 /* Get offsets and lengths */
676 #define Node_Offset(n) (RExC_offsets[2*((n)-RExC_emit_start)-1])
677 #define Node_Length(n) (RExC_offsets[2*((n)-RExC_emit_start)])
678
679 #define Set_Node_Offset_Length(node,offset,len) STMT_START {    \
680     Set_Node_Offset_To_R((node)-RExC_emit_start, (offset));     \
681     Set_Node_Length_To_R((node)-RExC_emit_start, (len));        \
682 } STMT_END
683 #endif
684
685 #if PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS
686 #define EXPERIMENTAL_INPLACESCAN
687 #endif /*PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS*/
688
689 #define DEBUG_STUDYDATA(str,data,depth)                              \
690 DEBUG_OPTIMISE_MORE_r(if(data){                                      \
691     PerlIO_printf(Perl_debug_log,                                    \
692         "%*s" str "Pos:%"IVdf"/%"IVdf                                \
693         " Flags: 0x%"UVXf" Whilem_c: %"IVdf" Lcp: %"IVdf" %s",       \
694         (int)(depth)*2, "",                                          \
695         (IV)((data)->pos_min),                                       \
696         (IV)((data)->pos_delta),                                     \
697         (UV)((data)->flags),                                         \
698         (IV)((data)->whilem_c),                                      \
699         (IV)((data)->last_closep ? *((data)->last_closep) : -1),     \
700         is_inf ? "INF " : ""                                         \
701     );                                                               \
702     if ((data)->last_found)                                          \
703         PerlIO_printf(Perl_debug_log,                                \
704             "Last:'%s' %"IVdf":%"IVdf"/%"IVdf" %sFixed:'%s' @ %"IVdf \
705             " %sFloat: '%s' @ %"IVdf"/%"IVdf"",                      \
706             SvPVX_const((data)->last_found),                         \
707             (IV)((data)->last_end),                                  \
708             (IV)((data)->last_start_min),                            \
709             (IV)((data)->last_start_max),                            \
710             ((data)->longest &&                                      \
711              (data)->longest==&((data)->longest_fixed)) ? "*" : "",  \
712             SvPVX_const((data)->longest_fixed),                      \
713             (IV)((data)->offset_fixed),                              \
714             ((data)->longest &&                                      \
715              (data)->longest==&((data)->longest_float)) ? "*" : "",  \
716             SvPVX_const((data)->longest_float),                      \
717             (IV)((data)->offset_float_min),                          \
718             (IV)((data)->offset_float_max)                           \
719         );                                                           \
720     PerlIO_printf(Perl_debug_log,"\n");                              \
721 });
722
723 /* Mark that we cannot extend a found fixed substring at this point.
724    Update the longest found anchored substring and the longest found
725    floating substrings if needed. */
726
727 STATIC void
728 S_scan_commit(pTHX_ const RExC_state_t *pRExC_state, scan_data_t *data, I32 *minlenp, int is_inf)
729 {
730     const STRLEN l = CHR_SVLEN(data->last_found);
731     const STRLEN old_l = CHR_SVLEN(*data->longest);
732     GET_RE_DEBUG_FLAGS_DECL;
733
734     PERL_ARGS_ASSERT_SCAN_COMMIT;
735
736     if ((l >= old_l) && ((l > old_l) || (data->flags & SF_BEFORE_EOL))) {
737         SvSetMagicSV(*data->longest, data->last_found);
738         if (*data->longest == data->longest_fixed) {
739             data->offset_fixed = l ? data->last_start_min : data->pos_min;
740             if (data->flags & SF_BEFORE_EOL)
741                 data->flags
742                     |= ((data->flags & SF_BEFORE_EOL) << SF_FIX_SHIFT_EOL);
743             else
744                 data->flags &= ~SF_FIX_BEFORE_EOL;
745             data->minlen_fixed=minlenp;
746             data->lookbehind_fixed=0;
747         }
748         else { /* *data->longest == data->longest_float */
749             data->offset_float_min = l ? data->last_start_min : data->pos_min;
750             data->offset_float_max = (l
751                                       ? data->last_start_max
752                                       : data->pos_min + data->pos_delta);
753             if (is_inf || (U32)data->offset_float_max > (U32)I32_MAX)
754                 data->offset_float_max = I32_MAX;
755             if (data->flags & SF_BEFORE_EOL)
756                 data->flags
757                     |= ((data->flags & SF_BEFORE_EOL) << SF_FL_SHIFT_EOL);
758             else
759                 data->flags &= ~SF_FL_BEFORE_EOL;
760             data->minlen_float=minlenp;
761             data->lookbehind_float=0;
762         }
763     }
764     SvCUR_set(data->last_found, 0);
765     {
766         SV * const sv = data->last_found;
767         if (SvUTF8(sv) && SvMAGICAL(sv)) {
768             MAGIC * const mg = mg_find(sv, PERL_MAGIC_utf8);
769             if (mg)
770                 mg->mg_len = 0;
771         }
772     }
773     data->last_end = -1;
774     data->flags &= ~SF_BEFORE_EOL;
775     DEBUG_STUDYDATA("commit: ",data,0);
776 }
777
778 /* These macros set, clear and test whether the synthetic start class ('ssc',
779  * given by the parameter) matches an empty string (EOS).  This uses the
780  * 'next_off' field in the node, to save a bit in the flags field.  The ssc
781  * stands alone, so there is never a next_off, so this field is otherwise
782  * unused.  The EOS information is used only for compilation, but theoretically
783  * it could be passed on to the execution code.  This could be used to store
784  * more than one bit of information, but only this one is currently used. */
785 #define SET_SSC_EOS(node)   STMT_START { (node)->next_off = TRUE; } STMT_END
786 #define CLEAR_SSC_EOS(node) STMT_START { (node)->next_off = FALSE; } STMT_END
787 #define TEST_SSC_EOS(node)  cBOOL((node)->next_off)
788
789 /* Can match anything (initialization) */
790 STATIC void
791 S_cl_anything(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl)
792 {
793     PERL_ARGS_ASSERT_CL_ANYTHING;
794
795     ANYOF_BITMAP_SETALL(cl);
796     cl->flags = ANYOF_UNICODE_ALL;
797     SET_SSC_EOS(cl);
798
799     /* If any portion of the regex is to operate under locale rules,
800      * initialization includes it.  The reason this isn't done for all regexes
801      * is that the optimizer was written under the assumption that locale was
802      * all-or-nothing.  Given the complexity and lack of documentation in the
803      * optimizer, and that there are inadequate test cases for locale, so many
804      * parts of it may not work properly, it is safest to avoid locale unless
805      * necessary. */
806     if (RExC_contains_locale) {
807         ANYOF_CLASS_SETALL(cl);     /* /l uses class */
808         cl->flags |= ANYOF_LOCALE|ANYOF_CLASS|ANYOF_LOC_FOLD;
809     }
810     else {
811         ANYOF_CLASS_ZERO(cl);       /* Only /l uses class now */
812     }
813 }
814
815 /* Can match anything (initialization) */
816 STATIC int
817 S_cl_is_anything(const struct regnode_charclass_class *cl)
818 {
819     int value;
820
821     PERL_ARGS_ASSERT_CL_IS_ANYTHING;
822
823     for (value = 0; value < ANYOF_MAX; value += 2)
824         if (ANYOF_CLASS_TEST(cl, value) && ANYOF_CLASS_TEST(cl, value + 1))
825             return 1;
826     if (!(cl->flags & ANYOF_UNICODE_ALL))
827         return 0;
828     if (!ANYOF_BITMAP_TESTALLSET((const void*)cl))
829         return 0;
830     return 1;
831 }
832
833 /* Can match anything (initialization) */
834 STATIC void
835 S_cl_init(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl)
836 {
837     PERL_ARGS_ASSERT_CL_INIT;
838
839     Zero(cl, 1, struct regnode_charclass_class);
840     cl->type = ANYOF;
841     cl_anything(pRExC_state, cl);
842     ARG_SET(cl, ANYOF_NONBITMAP_EMPTY);
843 }
844
845 /* These two functions currently do the exact same thing */
846 #define cl_init_zero            S_cl_init
847
848 /* 'AND' a given class with another one.  Can create false positives.  'cl'
849  * should not be inverted.  'and_with->flags & ANYOF_CLASS' should be 0 if
850  * 'and_with' is a regnode_charclass instead of a regnode_charclass_class. */
851 STATIC void
852 S_cl_and(struct regnode_charclass_class *cl,
853         const struct regnode_charclass_class *and_with)
854 {
855     PERL_ARGS_ASSERT_CL_AND;
856
857     assert(PL_regkind[and_with->type] == ANYOF);
858
859     /* I (khw) am not sure all these restrictions are necessary XXX */
860     if (!(ANYOF_CLASS_TEST_ANY_SET(and_with))
861         && !(ANYOF_CLASS_TEST_ANY_SET(cl))
862         && (and_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
863         && !(and_with->flags & ANYOF_LOC_FOLD)
864         && !(cl->flags & ANYOF_LOC_FOLD)) {
865         int i;
866
867         if (and_with->flags & ANYOF_INVERT)
868             for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
869                 cl->bitmap[i] &= ~and_with->bitmap[i];
870         else
871             for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
872                 cl->bitmap[i] &= and_with->bitmap[i];
873     } /* XXXX: logic is complicated otherwise, leave it along for a moment. */
874
875     if (and_with->flags & ANYOF_INVERT) {
876
877         /* Here, the and'ed node is inverted.  Get the AND of the flags that
878          * aren't affected by the inversion.  Those that are affected are
879          * handled individually below */
880         U8 affected_flags = cl->flags & ~INVERSION_UNAFFECTED_FLAGS;
881         cl->flags &= (and_with->flags & INVERSION_UNAFFECTED_FLAGS);
882         cl->flags |= affected_flags;
883
884         /* We currently don't know how to deal with things that aren't in the
885          * bitmap, but we know that the intersection is no greater than what
886          * is already in cl, so let there be false positives that get sorted
887          * out after the synthetic start class succeeds, and the node is
888          * matched for real. */
889
890         /* The inversion of these two flags indicate that the resulting
891          * intersection doesn't have them */
892         if (and_with->flags & ANYOF_UNICODE_ALL) {
893             cl->flags &= ~ANYOF_UNICODE_ALL;
894         }
895         if (and_with->flags & ANYOF_NON_UTF8_LATIN1_ALL) {
896             cl->flags &= ~ANYOF_NON_UTF8_LATIN1_ALL;
897         }
898     }
899     else {   /* and'd node is not inverted */
900         U8 outside_bitmap_but_not_utf8; /* Temp variable */
901
902         if (! ANYOF_NONBITMAP(and_with)) {
903
904             /* Here 'and_with' doesn't match anything outside the bitmap
905              * (except possibly ANYOF_UNICODE_ALL), which means the
906              * intersection can't either, except for ANYOF_UNICODE_ALL, in
907              * which case we don't know what the intersection is, but it's no
908              * greater than what cl already has, so can just leave it alone,
909              * with possible false positives */
910             if (! (and_with->flags & ANYOF_UNICODE_ALL)) {
911                 ARG_SET(cl, ANYOF_NONBITMAP_EMPTY);
912                 cl->flags &= ~ANYOF_NONBITMAP_NON_UTF8;
913             }
914         }
915         else if (! ANYOF_NONBITMAP(cl)) {
916
917             /* Here, 'and_with' does match something outside the bitmap, and cl
918              * doesn't have a list of things to match outside the bitmap.  If
919              * cl can match all code points above 255, the intersection will
920              * be those above-255 code points that 'and_with' matches.  If cl
921              * can't match all Unicode code points, it means that it can't
922              * match anything outside the bitmap (since the 'if' that got us
923              * into this block tested for that), so we leave the bitmap empty.
924              */
925             if (cl->flags & ANYOF_UNICODE_ALL) {
926                 ARG_SET(cl, ARG(and_with));
927
928                 /* and_with's ARG may match things that don't require UTF8.
929                  * And now cl's will too, in spite of this being an 'and'.  See
930                  * the comments below about the kludge */
931                 cl->flags |= and_with->flags & ANYOF_NONBITMAP_NON_UTF8;
932             }
933         }
934         else {
935             /* Here, both 'and_with' and cl match something outside the
936              * bitmap.  Currently we do not do the intersection, so just match
937              * whatever cl had at the beginning.  */
938         }
939
940
941         /* Take the intersection of the two sets of flags.  However, the
942          * ANYOF_NONBITMAP_NON_UTF8 flag is treated as an 'or'.  This is a
943          * kludge around the fact that this flag is not treated like the others
944          * which are initialized in cl_anything().  The way the optimizer works
945          * is that the synthetic start class (SSC) is initialized to match
946          * anything, and then the first time a real node is encountered, its
947          * values are AND'd with the SSC's with the result being the values of
948          * the real node.  However, there are paths through the optimizer where
949          * the AND never gets called, so those initialized bits are set
950          * inappropriately, which is not usually a big deal, as they just cause
951          * false positives in the SSC, which will just mean a probably
952          * imperceptible slow down in execution.  However this bit has a
953          * higher false positive consequence in that it can cause utf8.pm,
954          * utf8_heavy.pl ... to be loaded when not necessary, which is a much
955          * bigger slowdown and also causes significant extra memory to be used.
956          * In order to prevent this, the code now takes a different tack.  The
957          * bit isn't set unless some part of the regular expression needs it,
958          * but once set it won't get cleared.  This means that these extra
959          * modules won't get loaded unless there was some path through the
960          * pattern that would have required them anyway, and  so any false
961          * positives that occur by not ANDing them out when they could be
962          * aren't as severe as they would be if we treated this bit like all
963          * the others */
964         outside_bitmap_but_not_utf8 = (cl->flags | and_with->flags)
965                                       & ANYOF_NONBITMAP_NON_UTF8;
966         cl->flags &= and_with->flags;
967         cl->flags |= outside_bitmap_but_not_utf8;
968     }
969 }
970
971 /* 'OR' a given class with another one.  Can create false positives.  'cl'
972  * should not be inverted.  'or_with->flags & ANYOF_CLASS' should be 0 if
973  * 'or_with' is a regnode_charclass instead of a regnode_charclass_class. */
974 STATIC void
975 S_cl_or(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl, const struct regnode_charclass_class *or_with)
976 {
977     PERL_ARGS_ASSERT_CL_OR;
978
979     if (or_with->flags & ANYOF_INVERT) {
980
981         /* Here, the or'd node is to be inverted.  This means we take the
982          * complement of everything not in the bitmap, but currently we don't
983          * know what that is, so give up and match anything */
984         if (ANYOF_NONBITMAP(or_with)) {
985             cl_anything(pRExC_state, cl);
986         }
987         /* We do not use
988          * (B1 | CL1) | (!B2 & !CL2) = (B1 | !B2 & !CL2) | (CL1 | (!B2 & !CL2))
989          *   <= (B1 | !B2) | (CL1 | !CL2)
990          * which is wasteful if CL2 is small, but we ignore CL2:
991          *   (B1 | CL1) | (!B2 & !CL2) <= (B1 | CL1) | !B2 = (B1 | !B2) | CL1
992          * XXXX Can we handle case-fold?  Unclear:
993          *   (OK1(i) | OK1(i')) | !(OK1(i) | OK1(i')) =
994          *   (OK1(i) | OK1(i')) | (!OK1(i) & !OK1(i'))
995          */
996         else if ( (or_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
997              && !(or_with->flags & ANYOF_LOC_FOLD)
998              && !(cl->flags & ANYOF_LOC_FOLD) ) {
999             int i;
1000
1001             for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
1002                 cl->bitmap[i] |= ~or_with->bitmap[i];
1003         } /* XXXX: logic is complicated otherwise */
1004         else {
1005             cl_anything(pRExC_state, cl);
1006         }
1007
1008         /* And, we can just take the union of the flags that aren't affected
1009          * by the inversion */
1010         cl->flags |= or_with->flags & INVERSION_UNAFFECTED_FLAGS;
1011
1012         /* For the remaining flags:
1013             ANYOF_UNICODE_ALL and inverted means to not match anything above
1014                     255, which means that the union with cl should just be
1015                     what cl has in it, so can ignore this flag
1016             ANYOF_NON_UTF8_LATIN1_ALL and inverted means if not utf8 and ord
1017                     is 127-255 to match them, but then invert that, so the
1018                     union with cl should just be what cl has in it, so can
1019                     ignore this flag
1020          */
1021     } else {    /* 'or_with' is not inverted */
1022         /* (B1 | CL1) | (B2 | CL2) = (B1 | B2) | (CL1 | CL2)) */
1023         if ( (or_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
1024              && (!(or_with->flags & ANYOF_LOC_FOLD)
1025                  || (cl->flags & ANYOF_LOC_FOLD)) ) {
1026             int i;
1027
1028             /* OR char bitmap and class bitmap separately */
1029             for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
1030                 cl->bitmap[i] |= or_with->bitmap[i];
1031             ANYOF_CLASS_OR(or_with, cl);
1032         }
1033         else { /* XXXX: logic is complicated, leave it along for a moment. */
1034             cl_anything(pRExC_state, cl);
1035         }
1036
1037         if (ANYOF_NONBITMAP(or_with)) {
1038
1039             /* Use the added node's outside-the-bit-map match if there isn't a
1040              * conflict.  If there is a conflict (both nodes match something
1041              * outside the bitmap, but what they match outside is not the same
1042              * pointer, and hence not easily compared until XXX we extend
1043              * inversion lists this far), give up and allow the start class to
1044              * match everything outside the bitmap.  If that stuff is all above
1045              * 255, can just set UNICODE_ALL, otherwise caould be anything. */
1046             if (! ANYOF_NONBITMAP(cl)) {
1047                 ARG_SET(cl, ARG(or_with));
1048             }
1049             else if (ARG(cl) != ARG(or_with)) {
1050
1051                 if ((or_with->flags & ANYOF_NONBITMAP_NON_UTF8)) {
1052                     cl_anything(pRExC_state, cl);
1053                 }
1054                 else {
1055                     cl->flags |= ANYOF_UNICODE_ALL;
1056                 }
1057             }
1058         }
1059
1060         /* Take the union */
1061         cl->flags |= or_with->flags;
1062     }
1063 }
1064
1065 #define TRIE_LIST_ITEM(state,idx) (trie->states[state].trans.list)[ idx ]
1066 #define TRIE_LIST_CUR(state)  ( TRIE_LIST_ITEM( state, 0 ).forid )
1067 #define TRIE_LIST_LEN(state) ( TRIE_LIST_ITEM( state, 0 ).newstate )
1068 #define TRIE_LIST_USED(idx)  ( trie->states[state].trans.list ? (TRIE_LIST_CUR( idx ) - 1) : 0 )
1069
1070
1071 #ifdef DEBUGGING
1072 /*
1073    dump_trie(trie,widecharmap,revcharmap)
1074    dump_trie_interim_list(trie,widecharmap,revcharmap,next_alloc)
1075    dump_trie_interim_table(trie,widecharmap,revcharmap,next_alloc)
1076
1077    These routines dump out a trie in a somewhat readable format.
1078    The _interim_ variants are used for debugging the interim
1079    tables that are used to generate the final compressed
1080    representation which is what dump_trie expects.
1081
1082    Part of the reason for their existence is to provide a form
1083    of documentation as to how the different representations function.
1084
1085 */
1086
1087 /*
1088   Dumps the final compressed table form of the trie to Perl_debug_log.
1089   Used for debugging make_trie().
1090 */
1091
1092 STATIC void
1093 S_dump_trie(pTHX_ const struct _reg_trie_data *trie, HV *widecharmap,
1094             AV *revcharmap, U32 depth)
1095 {
1096     U32 state;
1097     SV *sv=sv_newmortal();
1098     int colwidth= widecharmap ? 6 : 4;
1099     U16 word;
1100     GET_RE_DEBUG_FLAGS_DECL;
1101
1102     PERL_ARGS_ASSERT_DUMP_TRIE;
1103
1104     PerlIO_printf( Perl_debug_log, "%*sChar : %-6s%-6s%-4s ",
1105         (int)depth * 2 + 2,"",
1106         "Match","Base","Ofs" );
1107
1108     for( state = 0 ; state < trie->uniquecharcount ; state++ ) {
1109         SV ** const tmp = av_fetch( revcharmap, state, 0);
1110         if ( tmp ) {
1111             PerlIO_printf( Perl_debug_log, "%*s", 
1112                 colwidth,
1113                 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth, 
1114                             PL_colors[0], PL_colors[1],
1115                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1116                             PERL_PV_ESCAPE_FIRSTCHAR 
1117                 ) 
1118             );
1119         }
1120     }
1121     PerlIO_printf( Perl_debug_log, "\n%*sState|-----------------------",
1122         (int)depth * 2 + 2,"");
1123
1124     for( state = 0 ; state < trie->uniquecharcount ; state++ )
1125         PerlIO_printf( Perl_debug_log, "%.*s", colwidth, "--------");
1126     PerlIO_printf( Perl_debug_log, "\n");
1127
1128     for( state = 1 ; state < trie->statecount ; state++ ) {
1129         const U32 base = trie->states[ state ].trans.base;
1130
1131         PerlIO_printf( Perl_debug_log, "%*s#%4"UVXf"|", (int)depth * 2 + 2,"", (UV)state);
1132
1133         if ( trie->states[ state ].wordnum ) {
1134             PerlIO_printf( Perl_debug_log, " W%4X", trie->states[ state ].wordnum );
1135         } else {
1136             PerlIO_printf( Perl_debug_log, "%6s", "" );
1137         }
1138
1139         PerlIO_printf( Perl_debug_log, " @%4"UVXf" ", (UV)base );
1140
1141         if ( base ) {
1142             U32 ofs = 0;
1143
1144             while( ( base + ofs  < trie->uniquecharcount ) ||
1145                    ( base + ofs - trie->uniquecharcount < trie->lasttrans
1146                      && trie->trans[ base + ofs - trie->uniquecharcount ].check != state))
1147                     ofs++;
1148
1149             PerlIO_printf( Perl_debug_log, "+%2"UVXf"[ ", (UV)ofs);
1150
1151             for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
1152                 if ( ( base + ofs >= trie->uniquecharcount ) &&
1153                      ( base + ofs - trie->uniquecharcount < trie->lasttrans ) &&
1154                      trie->trans[ base + ofs - trie->uniquecharcount ].check == state )
1155                 {
1156                    PerlIO_printf( Perl_debug_log, "%*"UVXf,
1157                     colwidth,
1158                     (UV)trie->trans[ base + ofs - trie->uniquecharcount ].next );
1159                 } else {
1160                     PerlIO_printf( Perl_debug_log, "%*s",colwidth,"   ." );
1161                 }
1162             }
1163
1164             PerlIO_printf( Perl_debug_log, "]");
1165
1166         }
1167         PerlIO_printf( Perl_debug_log, "\n" );
1168     }
1169     PerlIO_printf(Perl_debug_log, "%*sword_info N:(prev,len)=", (int)depth*2, "");
1170     for (word=1; word <= trie->wordcount; word++) {
1171         PerlIO_printf(Perl_debug_log, " %d:(%d,%d)",
1172             (int)word, (int)(trie->wordinfo[word].prev),
1173             (int)(trie->wordinfo[word].len));
1174     }
1175     PerlIO_printf(Perl_debug_log, "\n" );
1176 }    
1177 /*
1178   Dumps a fully constructed but uncompressed trie in list form.
1179   List tries normally only are used for construction when the number of 
1180   possible chars (trie->uniquecharcount) is very high.
1181   Used for debugging make_trie().
1182 */
1183 STATIC void
1184 S_dump_trie_interim_list(pTHX_ const struct _reg_trie_data *trie,
1185                          HV *widecharmap, AV *revcharmap, U32 next_alloc,
1186                          U32 depth)
1187 {
1188     U32 state;
1189     SV *sv=sv_newmortal();
1190     int colwidth= widecharmap ? 6 : 4;
1191     GET_RE_DEBUG_FLAGS_DECL;
1192
1193     PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_LIST;
1194
1195     /* print out the table precompression.  */
1196     PerlIO_printf( Perl_debug_log, "%*sState :Word | Transition Data\n%*s%s",
1197         (int)depth * 2 + 2,"", (int)depth * 2 + 2,"",
1198         "------:-----+-----------------\n" );
1199     
1200     for( state=1 ; state < next_alloc ; state ++ ) {
1201         U16 charid;
1202     
1203         PerlIO_printf( Perl_debug_log, "%*s %4"UVXf" :",
1204             (int)depth * 2 + 2,"", (UV)state  );
1205         if ( ! trie->states[ state ].wordnum ) {
1206             PerlIO_printf( Perl_debug_log, "%5s| ","");
1207         } else {
1208             PerlIO_printf( Perl_debug_log, "W%4x| ",
1209                 trie->states[ state ].wordnum
1210             );
1211         }
1212         for( charid = 1 ; charid <= TRIE_LIST_USED( state ) ; charid++ ) {
1213             SV ** const tmp = av_fetch( revcharmap, TRIE_LIST_ITEM(state,charid).forid, 0);
1214             if ( tmp ) {
1215                 PerlIO_printf( Perl_debug_log, "%*s:%3X=%4"UVXf" | ",
1216                     colwidth,
1217                     pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth, 
1218                             PL_colors[0], PL_colors[1],
1219                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1220                             PERL_PV_ESCAPE_FIRSTCHAR 
1221                     ) ,
1222                     TRIE_LIST_ITEM(state,charid).forid,
1223                     (UV)TRIE_LIST_ITEM(state,charid).newstate
1224                 );
1225                 if (!(charid % 10)) 
1226                     PerlIO_printf(Perl_debug_log, "\n%*s| ",
1227                         (int)((depth * 2) + 14), "");
1228             }
1229         }
1230         PerlIO_printf( Perl_debug_log, "\n");
1231     }
1232 }    
1233
1234 /*
1235   Dumps a fully constructed but uncompressed trie in table form.
1236   This is the normal DFA style state transition table, with a few 
1237   twists to facilitate compression later. 
1238   Used for debugging make_trie().
1239 */
1240 STATIC void
1241 S_dump_trie_interim_table(pTHX_ const struct _reg_trie_data *trie,
1242                           HV *widecharmap, AV *revcharmap, U32 next_alloc,
1243                           U32 depth)
1244 {
1245     U32 state;
1246     U16 charid;
1247     SV *sv=sv_newmortal();
1248     int colwidth= widecharmap ? 6 : 4;
1249     GET_RE_DEBUG_FLAGS_DECL;
1250
1251     PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_TABLE;
1252     
1253     /*
1254        print out the table precompression so that we can do a visual check
1255        that they are identical.
1256      */
1257     
1258     PerlIO_printf( Perl_debug_log, "%*sChar : ",(int)depth * 2 + 2,"" );
1259
1260     for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
1261         SV ** const tmp = av_fetch( revcharmap, charid, 0);
1262         if ( tmp ) {
1263             PerlIO_printf( Perl_debug_log, "%*s", 
1264                 colwidth,
1265                 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth, 
1266                             PL_colors[0], PL_colors[1],
1267                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1268                             PERL_PV_ESCAPE_FIRSTCHAR 
1269                 ) 
1270             );
1271         }
1272     }
1273
1274     PerlIO_printf( Perl_debug_log, "\n%*sState+-",(int)depth * 2 + 2,"" );
1275
1276     for( charid=0 ; charid < trie->uniquecharcount ; charid++ ) {
1277         PerlIO_printf( Perl_debug_log, "%.*s", colwidth,"--------");
1278     }
1279
1280     PerlIO_printf( Perl_debug_log, "\n" );
1281
1282     for( state=1 ; state < next_alloc ; state += trie->uniquecharcount ) {
1283
1284         PerlIO_printf( Perl_debug_log, "%*s%4"UVXf" : ", 
1285             (int)depth * 2 + 2,"",
1286             (UV)TRIE_NODENUM( state ) );
1287
1288         for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
1289             UV v=(UV)SAFE_TRIE_NODENUM( trie->trans[ state + charid ].next );
1290             if (v)
1291                 PerlIO_printf( Perl_debug_log, "%*"UVXf, colwidth, v );
1292             else
1293                 PerlIO_printf( Perl_debug_log, "%*s", colwidth, "." );
1294         }
1295         if ( ! trie->states[ TRIE_NODENUM( state ) ].wordnum ) {
1296             PerlIO_printf( Perl_debug_log, " (%4"UVXf")\n", (UV)trie->trans[ state ].check );
1297         } else {
1298             PerlIO_printf( Perl_debug_log, " (%4"UVXf") W%4X\n", (UV)trie->trans[ state ].check,
1299             trie->states[ TRIE_NODENUM( state ) ].wordnum );
1300         }
1301     }
1302 }
1303
1304 #endif
1305
1306
1307 /* make_trie(startbranch,first,last,tail,word_count,flags,depth)
1308   startbranch: the first branch in the whole branch sequence
1309   first      : start branch of sequence of branch-exact nodes.
1310                May be the same as startbranch
1311   last       : Thing following the last branch.
1312                May be the same as tail.
1313   tail       : item following the branch sequence
1314   count      : words in the sequence
1315   flags      : currently the OP() type we will be building one of /EXACT(|F|Fl)/
1316   depth      : indent depth
1317
1318 Inplace optimizes a sequence of 2 or more Branch-Exact nodes into a TRIE node.
1319
1320 A trie is an N'ary tree where the branches are determined by digital
1321 decomposition of the key. IE, at the root node you look up the 1st character and
1322 follow that branch repeat until you find the end of the branches. Nodes can be
1323 marked as "accepting" meaning they represent a complete word. Eg:
1324
1325   /he|she|his|hers/
1326
1327 would convert into the following structure. Numbers represent states, letters
1328 following numbers represent valid transitions on the letter from that state, if
1329 the number is in square brackets it represents an accepting state, otherwise it
1330 will be in parenthesis.
1331
1332       +-h->+-e->[3]-+-r->(8)-+-s->[9]
1333       |    |
1334       |   (2)
1335       |    |
1336      (1)   +-i->(6)-+-s->[7]
1337       |
1338       +-s->(3)-+-h->(4)-+-e->[5]
1339
1340       Accept Word Mapping: 3=>1 (he),5=>2 (she), 7=>3 (his), 9=>4 (hers)
1341
1342 This shows that when matching against the string 'hers' we will begin at state 1
1343 read 'h' and move to state 2, read 'e' and move to state 3 which is accepting,
1344 then read 'r' and go to state 8 followed by 's' which takes us to state 9 which
1345 is also accepting. Thus we know that we can match both 'he' and 'hers' with a
1346 single traverse. We store a mapping from accepting to state to which word was
1347 matched, and then when we have multiple possibilities we try to complete the
1348 rest of the regex in the order in which they occured in the alternation.
1349
1350 The only prior NFA like behaviour that would be changed by the TRIE support is
1351 the silent ignoring of duplicate alternations which are of the form:
1352
1353  / (DUPE|DUPE) X? (?{ ... }) Y /x
1354
1355 Thus EVAL blocks following a trie may be called a different number of times with
1356 and without the optimisation. With the optimisations dupes will be silently
1357 ignored. This inconsistent behaviour of EVAL type nodes is well established as
1358 the following demonstrates:
1359
1360  'words'=~/(word|word|word)(?{ print $1 })[xyz]/
1361
1362 which prints out 'word' three times, but
1363
1364  'words'=~/(word|word|word)(?{ print $1 })S/
1365
1366 which doesnt print it out at all. This is due to other optimisations kicking in.
1367
1368 Example of what happens on a structural level:
1369
1370 The regexp /(ac|ad|ab)+/ will produce the following debug output:
1371
1372    1: CURLYM[1] {1,32767}(18)
1373    5:   BRANCH(8)
1374    6:     EXACT <ac>(16)
1375    8:   BRANCH(11)
1376    9:     EXACT <ad>(16)
1377   11:   BRANCH(14)
1378   12:     EXACT <ab>(16)
1379   16:   SUCCEED(0)
1380   17:   NOTHING(18)
1381   18: END(0)
1382
1383 This would be optimizable with startbranch=5, first=5, last=16, tail=16
1384 and should turn into:
1385
1386    1: CURLYM[1] {1,32767}(18)
1387    5:   TRIE(16)
1388         [Words:3 Chars Stored:6 Unique Chars:4 States:5 NCP:1]
1389           <ac>
1390           <ad>
1391           <ab>
1392   16:   SUCCEED(0)
1393   17:   NOTHING(18)
1394   18: END(0)
1395
1396 Cases where tail != last would be like /(?foo|bar)baz/:
1397
1398    1: BRANCH(4)
1399    2:   EXACT <foo>(8)
1400    4: BRANCH(7)
1401    5:   EXACT <bar>(8)
1402    7: TAIL(8)
1403    8: EXACT <baz>(10)
1404   10: END(0)
1405
1406 which would be optimizable with startbranch=1, first=1, last=7, tail=8
1407 and would end up looking like:
1408
1409     1: TRIE(8)
1410       [Words:2 Chars Stored:6 Unique Chars:5 States:7 NCP:1]
1411         <foo>
1412         <bar>
1413    7: TAIL(8)
1414    8: EXACT <baz>(10)
1415   10: END(0)
1416
1417     d = uvuni_to_utf8_flags(d, uv, 0);
1418
1419 is the recommended Unicode-aware way of saying
1420
1421     *(d++) = uv;
1422 */
1423
1424 #define TRIE_STORE_REVCHAR(val)                                            \
1425     STMT_START {                                                           \
1426         if (UTF) {                                                         \
1427             SV *zlopp = newSV(7); /* XXX: optimize me */                   \
1428             unsigned char *flrbbbbb = (unsigned char *) SvPVX(zlopp);      \
1429             unsigned const char *const kapow = uvuni_to_utf8(flrbbbbb, val); \
1430             SvCUR_set(zlopp, kapow - flrbbbbb);                            \
1431             SvPOK_on(zlopp);                                               \
1432             SvUTF8_on(zlopp);                                              \
1433             av_push(revcharmap, zlopp);                                    \
1434         } else {                                                           \
1435             char ooooff = (char)val;                                           \
1436             av_push(revcharmap, newSVpvn(&ooooff, 1));                     \
1437         }                                                                  \
1438         } STMT_END
1439
1440 #define TRIE_READ_CHAR STMT_START {                                                     \
1441     wordlen++;                                                                          \
1442     if ( UTF ) {                                                                        \
1443         /* if it is UTF then it is either already folded, or does not need folding */   \
1444         uvc = utf8n_to_uvuni( (const U8*) uc, UTF8_MAXLEN, &len, uniflags);             \
1445     }                                                                                   \
1446     else if (folder == PL_fold_latin1) {                                                \
1447         /* if we use this folder we have to obey unicode rules on latin-1 data */       \
1448         if ( foldlen > 0 ) {                                                            \
1449            uvc = utf8n_to_uvuni( (const U8*) scan, UTF8_MAXLEN, &len, uniflags );       \
1450            foldlen -= len;                                                              \
1451            scan += len;                                                                 \
1452            len = 0;                                                                     \
1453         } else {                                                                        \
1454             len = 1;                                                                    \
1455             uvc = _to_fold_latin1( (U8) *uc, foldbuf, &foldlen, 1);                     \
1456             skiplen = UNISKIP(uvc);                                                     \
1457             foldlen -= skiplen;                                                         \
1458             scan = foldbuf + skiplen;                                                   \
1459         }                                                                               \
1460     } else {                                                                            \
1461         /* raw data, will be folded later if needed */                                  \
1462         uvc = (U32)*uc;                                                                 \
1463         len = 1;                                                                        \
1464     }                                                                                   \
1465 } STMT_END
1466
1467
1468
1469 #define TRIE_LIST_PUSH(state,fid,ns) STMT_START {               \
1470     if ( TRIE_LIST_CUR( state ) >=TRIE_LIST_LEN( state ) ) {    \
1471         U32 ging = TRIE_LIST_LEN( state ) *= 2;                 \
1472         Renew( trie->states[ state ].trans.list, ging, reg_trie_trans_le ); \
1473     }                                                           \
1474     TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).forid = fid;     \
1475     TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).newstate = ns;   \
1476     TRIE_LIST_CUR( state )++;                                   \
1477 } STMT_END
1478
1479 #define TRIE_LIST_NEW(state) STMT_START {                       \
1480     Newxz( trie->states[ state ].trans.list,               \
1481         4, reg_trie_trans_le );                                 \
1482      TRIE_LIST_CUR( state ) = 1;                                \
1483      TRIE_LIST_LEN( state ) = 4;                                \
1484 } STMT_END
1485
1486 #define TRIE_HANDLE_WORD(state) STMT_START {                    \
1487     U16 dupe= trie->states[ state ].wordnum;                    \
1488     regnode * const noper_next = regnext( noper );              \
1489                                                                 \
1490     DEBUG_r({                                                   \
1491         /* store the word for dumping */                        \
1492         SV* tmp;                                                \
1493         if (OP(noper) != NOTHING)                               \
1494             tmp = newSVpvn_utf8(STRING(noper), STR_LEN(noper), UTF);    \
1495         else                                                    \
1496             tmp = newSVpvn_utf8( "", 0, UTF );                  \
1497         av_push( trie_words, tmp );                             \
1498     });                                                         \
1499                                                                 \
1500     curword++;                                                  \
1501     trie->wordinfo[curword].prev   = 0;                         \
1502     trie->wordinfo[curword].len    = wordlen;                   \
1503     trie->wordinfo[curword].accept = state;                     \
1504                                                                 \
1505     if ( noper_next < tail ) {                                  \
1506         if (!trie->jump)                                        \
1507             trie->jump = (U16 *) PerlMemShared_calloc( word_count + 1, sizeof(U16) ); \
1508         trie->jump[curword] = (U16)(noper_next - convert);      \
1509         if (!jumper)                                            \
1510             jumper = noper_next;                                \
1511         if (!nextbranch)                                        \
1512             nextbranch= regnext(cur);                           \
1513     }                                                           \
1514                                                                 \
1515     if ( dupe ) {                                               \
1516         /* It's a dupe. Pre-insert into the wordinfo[].prev   */\
1517         /* chain, so that when the bits of chain are later    */\
1518         /* linked together, the dups appear in the chain      */\
1519         trie->wordinfo[curword].prev = trie->wordinfo[dupe].prev; \
1520         trie->wordinfo[dupe].prev = curword;                    \
1521     } else {                                                    \
1522         /* we haven't inserted this word yet.                */ \
1523         trie->states[ state ].wordnum = curword;                \
1524     }                                                           \
1525 } STMT_END
1526
1527
1528 #define TRIE_TRANS_STATE(state,base,ucharcount,charid,special)          \
1529      ( ( base + charid >=  ucharcount                                   \
1530          && base + charid < ubound                                      \
1531          && state == trie->trans[ base - ucharcount + charid ].check    \
1532          && trie->trans[ base - ucharcount + charid ].next )            \
1533            ? trie->trans[ base - ucharcount + charid ].next             \
1534            : ( state==1 ? special : 0 )                                 \
1535       )
1536
1537 #define MADE_TRIE       1
1538 #define MADE_JUMP_TRIE  2
1539 #define MADE_EXACT_TRIE 4
1540
1541 STATIC I32
1542 S_make_trie(pTHX_ RExC_state_t *pRExC_state, regnode *startbranch, regnode *first, regnode *last, regnode *tail, U32 word_count, U32 flags, U32 depth)
1543 {
1544     dVAR;
1545     /* first pass, loop through and scan words */
1546     reg_trie_data *trie;
1547     HV *widecharmap = NULL;
1548     AV *revcharmap = newAV();
1549     regnode *cur;
1550     const U32 uniflags = UTF8_ALLOW_DEFAULT;
1551     STRLEN len = 0;
1552     UV uvc = 0;
1553     U16 curword = 0;
1554     U32 next_alloc = 0;
1555     regnode *jumper = NULL;
1556     regnode *nextbranch = NULL;
1557     regnode *convert = NULL;
1558     U32 *prev_states; /* temp array mapping each state to previous one */
1559     /* we just use folder as a flag in utf8 */
1560     const U8 * folder = NULL;
1561
1562 #ifdef DEBUGGING
1563     const U32 data_slot = add_data( pRExC_state, 4, "tuuu" );
1564     AV *trie_words = NULL;
1565     /* along with revcharmap, this only used during construction but both are
1566      * useful during debugging so we store them in the struct when debugging.
1567      */
1568 #else
1569     const U32 data_slot = add_data( pRExC_state, 2, "tu" );
1570     STRLEN trie_charcount=0;
1571 #endif
1572     SV *re_trie_maxbuff;
1573     GET_RE_DEBUG_FLAGS_DECL;
1574
1575     PERL_ARGS_ASSERT_MAKE_TRIE;
1576 #ifndef DEBUGGING
1577     PERL_UNUSED_ARG(depth);
1578 #endif
1579
1580     switch (flags) {
1581         case EXACT: break;
1582         case EXACTFA:
1583         case EXACTFU_SS:
1584         case EXACTFU_TRICKYFOLD:
1585         case EXACTFU: folder = PL_fold_latin1; break;
1586         case EXACTF:  folder = PL_fold; break;
1587         case EXACTFL: folder = PL_fold_locale; break;
1588         default: Perl_croak( aTHX_ "panic! In trie construction, unknown node type %u %s", (unsigned) flags, PL_reg_name[flags] );
1589     }
1590
1591     trie = (reg_trie_data *) PerlMemShared_calloc( 1, sizeof(reg_trie_data) );
1592     trie->refcount = 1;
1593     trie->startstate = 1;
1594     trie->wordcount = word_count;
1595     RExC_rxi->data->data[ data_slot ] = (void*)trie;
1596     trie->charmap = (U16 *) PerlMemShared_calloc( 256, sizeof(U16) );
1597     if (flags == EXACT)
1598         trie->bitmap = (char *) PerlMemShared_calloc( ANYOF_BITMAP_SIZE, 1 );
1599     trie->wordinfo = (reg_trie_wordinfo *) PerlMemShared_calloc(
1600                        trie->wordcount+1, sizeof(reg_trie_wordinfo));
1601
1602     DEBUG_r({
1603         trie_words = newAV();
1604     });
1605
1606     re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
1607     if (!SvIOK(re_trie_maxbuff)) {
1608         sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
1609     }
1610     DEBUG_TRIE_COMPILE_r({
1611                 PerlIO_printf( Perl_debug_log,
1612                   "%*smake_trie start==%d, first==%d, last==%d, tail==%d depth=%d\n",
1613                   (int)depth * 2 + 2, "", 
1614                   REG_NODE_NUM(startbranch),REG_NODE_NUM(first), 
1615                   REG_NODE_NUM(last), REG_NODE_NUM(tail),
1616                   (int)depth);
1617     });
1618    
1619    /* Find the node we are going to overwrite */
1620     if ( first == startbranch && OP( last ) != BRANCH ) {
1621         /* whole branch chain */
1622         convert = first;
1623     } else {
1624         /* branch sub-chain */
1625         convert = NEXTOPER( first );
1626     }
1627         
1628     /*  -- First loop and Setup --
1629
1630        We first traverse the branches and scan each word to determine if it
1631        contains widechars, and how many unique chars there are, this is
1632        important as we have to build a table with at least as many columns as we
1633        have unique chars.
1634
1635        We use an array of integers to represent the character codes 0..255
1636        (trie->charmap) and we use a an HV* to store Unicode characters. We use the
1637        native representation of the character value as the key and IV's for the
1638        coded index.
1639
1640        *TODO* If we keep track of how many times each character is used we can
1641        remap the columns so that the table compression later on is more
1642        efficient in terms of memory by ensuring the most common value is in the
1643        middle and the least common are on the outside.  IMO this would be better
1644        than a most to least common mapping as theres a decent chance the most
1645        common letter will share a node with the least common, meaning the node
1646        will not be compressible. With a middle is most common approach the worst
1647        case is when we have the least common nodes twice.
1648
1649      */
1650
1651     for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
1652         regnode *noper = NEXTOPER( cur );
1653         const U8 *uc = (U8*)STRING( noper );
1654         const U8 *e  = uc + STR_LEN( noper );
1655         STRLEN foldlen = 0;
1656         U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
1657         STRLEN skiplen = 0;
1658         const U8 *scan = (U8*)NULL;
1659         U32 wordlen      = 0;         /* required init */
1660         STRLEN chars = 0;
1661         bool set_bit = trie->bitmap ? 1 : 0; /*store the first char in the bitmap?*/
1662
1663         if (OP(noper) == NOTHING) {
1664             regnode *noper_next= regnext(noper);
1665             if (noper_next != tail && OP(noper_next) == flags) {
1666                 noper = noper_next;
1667                 uc= (U8*)STRING(noper);
1668                 e= uc + STR_LEN(noper);
1669                 trie->minlen= STR_LEN(noper);
1670             } else {
1671                 trie->minlen= 0;
1672                 continue;
1673             }
1674         }
1675
1676         if ( set_bit ) { /* bitmap only alloced when !(UTF&&Folding) */
1677             TRIE_BITMAP_SET(trie,*uc); /* store the raw first byte
1678                                           regardless of encoding */
1679             if (OP( noper ) == EXACTFU_SS) {
1680                 /* false positives are ok, so just set this */
1681                 TRIE_BITMAP_SET(trie,0xDF);
1682             }
1683         }
1684         for ( ; uc < e ; uc += len ) {
1685             TRIE_CHARCOUNT(trie)++;
1686             TRIE_READ_CHAR;
1687             chars++;
1688             if ( uvc < 256 ) {
1689                 if ( folder ) {
1690                     U8 folded= folder[ (U8) uvc ];
1691                     if ( !trie->charmap[ folded ] ) {
1692                         trie->charmap[ folded ]=( ++trie->uniquecharcount );
1693                         TRIE_STORE_REVCHAR( folded );
1694                     }
1695                 }
1696                 if ( !trie->charmap[ uvc ] ) {
1697                     trie->charmap[ uvc ]=( ++trie->uniquecharcount );
1698                     TRIE_STORE_REVCHAR( uvc );
1699                 }
1700                 if ( set_bit ) {
1701                     /* store the codepoint in the bitmap, and its folded
1702                      * equivalent. */
1703                     TRIE_BITMAP_SET(trie, uvc);
1704
1705                     /* store the folded codepoint */
1706                     if ( folder ) TRIE_BITMAP_SET(trie, folder[(U8) uvc ]);
1707
1708                     if ( !UTF ) {
1709                         /* store first byte of utf8 representation of
1710                            variant codepoints */
1711                         if (! UNI_IS_INVARIANT(uvc)) {
1712                             TRIE_BITMAP_SET(trie, UTF8_TWO_BYTE_HI(uvc));
1713                         }
1714                     }
1715                     set_bit = 0; /* We've done our bit :-) */
1716                 }
1717             } else {
1718                 SV** svpp;
1719                 if ( !widecharmap )
1720                     widecharmap = newHV();
1721
1722                 svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 1 );
1723
1724                 if ( !svpp )
1725                     Perl_croak( aTHX_ "error creating/fetching widecharmap entry for 0x%"UVXf, uvc );
1726
1727                 if ( !SvTRUE( *svpp ) ) {
1728                     sv_setiv( *svpp, ++trie->uniquecharcount );
1729                     TRIE_STORE_REVCHAR(uvc);
1730                 }
1731             }
1732         }
1733         if( cur == first ) {
1734             trie->minlen = chars;
1735             trie->maxlen = chars;
1736         } else if (chars < trie->minlen) {
1737             trie->minlen = chars;
1738         } else if (chars > trie->maxlen) {
1739             trie->maxlen = chars;
1740         }
1741         if (OP( noper ) == EXACTFU_SS) {
1742             /* XXX: workaround - 'ss' could match "\x{DF}" so minlen could be 1 and not 2*/
1743             if (trie->minlen > 1)
1744                 trie->minlen= 1;
1745         }
1746         if (OP( noper ) == EXACTFU_TRICKYFOLD) {
1747             /* XXX: workround - things like "\x{1FBE}\x{0308}\x{0301}" can match "\x{0390}" 
1748              *                - We assume that any such sequence might match a 2 byte string */
1749             if (trie->minlen > 2 )
1750                 trie->minlen= 2;
1751         }
1752
1753     } /* end first pass */
1754     DEBUG_TRIE_COMPILE_r(
1755         PerlIO_printf( Perl_debug_log, "%*sTRIE(%s): W:%d C:%d Uq:%d Min:%d Max:%d\n",
1756                 (int)depth * 2 + 2,"",
1757                 ( widecharmap ? "UTF8" : "NATIVE" ), (int)word_count,
1758                 (int)TRIE_CHARCOUNT(trie), trie->uniquecharcount,
1759                 (int)trie->minlen, (int)trie->maxlen )
1760     );
1761
1762     /*
1763         We now know what we are dealing with in terms of unique chars and
1764         string sizes so we can calculate how much memory a naive
1765         representation using a flat table  will take. If it's over a reasonable
1766         limit (as specified by ${^RE_TRIE_MAXBUF}) we use a more memory
1767         conservative but potentially much slower representation using an array
1768         of lists.
1769
1770         At the end we convert both representations into the same compressed
1771         form that will be used in regexec.c for matching with. The latter
1772         is a form that cannot be used to construct with but has memory
1773         properties similar to the list form and access properties similar
1774         to the table form making it both suitable for fast searches and
1775         small enough that its feasable to store for the duration of a program.
1776
1777         See the comment in the code where the compressed table is produced
1778         inplace from the flat tabe representation for an explanation of how
1779         the compression works.
1780
1781     */
1782
1783
1784     Newx(prev_states, TRIE_CHARCOUNT(trie) + 2, U32);
1785     prev_states[1] = 0;
1786
1787     if ( (IV)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1) > SvIV(re_trie_maxbuff) ) {
1788         /*
1789             Second Pass -- Array Of Lists Representation
1790
1791             Each state will be represented by a list of charid:state records
1792             (reg_trie_trans_le) the first such element holds the CUR and LEN
1793             points of the allocated array. (See defines above).
1794
1795             We build the initial structure using the lists, and then convert
1796             it into the compressed table form which allows faster lookups
1797             (but cant be modified once converted).
1798         */
1799
1800         STRLEN transcount = 1;
1801
1802         DEBUG_TRIE_COMPILE_MORE_r( PerlIO_printf( Perl_debug_log, 
1803             "%*sCompiling trie using list compiler\n",
1804             (int)depth * 2 + 2, ""));
1805
1806         trie->states = (reg_trie_state *)
1807             PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
1808                                   sizeof(reg_trie_state) );
1809         TRIE_LIST_NEW(1);
1810         next_alloc = 2;
1811
1812         for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
1813
1814             regnode *noper   = NEXTOPER( cur );
1815             U8 *uc           = (U8*)STRING( noper );
1816             const U8 *e      = uc + STR_LEN( noper );
1817             U32 state        = 1;         /* required init */
1818             U16 charid       = 0;         /* sanity init */
1819             U8 *scan         = (U8*)NULL; /* sanity init */
1820             STRLEN foldlen   = 0;         /* required init */
1821             U32 wordlen      = 0;         /* required init */
1822             U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
1823             STRLEN skiplen   = 0;
1824
1825             if (OP(noper) == NOTHING) {
1826                 regnode *noper_next= regnext(noper);
1827                 if (noper_next != tail && OP(noper_next) == flags) {
1828                     noper = noper_next;
1829                     uc= (U8*)STRING(noper);
1830                     e= uc + STR_LEN(noper);
1831                 }
1832             }
1833
1834             if (OP(noper) != NOTHING) {
1835                 for ( ; uc < e ; uc += len ) {
1836
1837                     TRIE_READ_CHAR;
1838
1839                     if ( uvc < 256 ) {
1840                         charid = trie->charmap[ uvc ];
1841                     } else {
1842                         SV** const svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 0);
1843                         if ( !svpp ) {
1844                             charid = 0;
1845                         } else {
1846                             charid=(U16)SvIV( *svpp );
1847                         }
1848                     }
1849                     /* charid is now 0 if we dont know the char read, or nonzero if we do */
1850                     if ( charid ) {
1851
1852                         U16 check;
1853                         U32 newstate = 0;
1854
1855                         charid--;
1856                         if ( !trie->states[ state ].trans.list ) {
1857                             TRIE_LIST_NEW( state );
1858                         }
1859                         for ( check = 1; check <= TRIE_LIST_USED( state ); check++ ) {
1860                             if ( TRIE_LIST_ITEM( state, check ).forid == charid ) {
1861                                 newstate = TRIE_LIST_ITEM( state, check ).newstate;
1862                                 break;
1863                             }
1864                         }
1865                         if ( ! newstate ) {
1866                             newstate = next_alloc++;
1867                             prev_states[newstate] = state;
1868                             TRIE_LIST_PUSH( state, charid, newstate );
1869                             transcount++;
1870                         }
1871                         state = newstate;
1872                     } else {
1873                         Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %"IVdf, uvc );
1874                     }
1875                 }
1876             }
1877             TRIE_HANDLE_WORD(state);
1878
1879         } /* end second pass */
1880
1881         /* next alloc is the NEXT state to be allocated */
1882         trie->statecount = next_alloc; 
1883         trie->states = (reg_trie_state *)
1884             PerlMemShared_realloc( trie->states,
1885                                    next_alloc
1886                                    * sizeof(reg_trie_state) );
1887
1888         /* and now dump it out before we compress it */
1889         DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_list(trie, widecharmap,
1890                                                          revcharmap, next_alloc,
1891                                                          depth+1)
1892         );
1893
1894         trie->trans = (reg_trie_trans *)
1895             PerlMemShared_calloc( transcount, sizeof(reg_trie_trans) );
1896         {
1897             U32 state;
1898             U32 tp = 0;
1899             U32 zp = 0;
1900
1901
1902             for( state=1 ; state < next_alloc ; state ++ ) {
1903                 U32 base=0;
1904
1905                 /*
1906                 DEBUG_TRIE_COMPILE_MORE_r(
1907                     PerlIO_printf( Perl_debug_log, "tp: %d zp: %d ",tp,zp)
1908                 );
1909                 */
1910
1911                 if (trie->states[state].trans.list) {
1912                     U16 minid=TRIE_LIST_ITEM( state, 1).forid;
1913                     U16 maxid=minid;
1914                     U16 idx;
1915
1916                     for( idx = 2 ; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
1917                         const U16 forid = TRIE_LIST_ITEM( state, idx).forid;
1918                         if ( forid < minid ) {
1919                             minid=forid;
1920                         } else if ( forid > maxid ) {
1921                             maxid=forid;
1922                         }
1923                     }
1924                     if ( transcount < tp + maxid - minid + 1) {
1925                         transcount *= 2;
1926                         trie->trans = (reg_trie_trans *)
1927                             PerlMemShared_realloc( trie->trans,
1928                                                      transcount
1929                                                      * sizeof(reg_trie_trans) );
1930                         Zero( trie->trans + (transcount / 2), transcount / 2 , reg_trie_trans );
1931                     }
1932                     base = trie->uniquecharcount + tp - minid;
1933                     if ( maxid == minid ) {
1934                         U32 set = 0;
1935                         for ( ; zp < tp ; zp++ ) {
1936                             if ( ! trie->trans[ zp ].next ) {
1937                                 base = trie->uniquecharcount + zp - minid;
1938                                 trie->trans[ zp ].next = TRIE_LIST_ITEM( state, 1).newstate;
1939                                 trie->trans[ zp ].check = state;
1940                                 set = 1;
1941                                 break;
1942                             }
1943                         }
1944                         if ( !set ) {
1945                             trie->trans[ tp ].next = TRIE_LIST_ITEM( state, 1).newstate;
1946                             trie->trans[ tp ].check = state;
1947                             tp++;
1948                             zp = tp;
1949                         }
1950                     } else {
1951                         for ( idx=1; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
1952                             const U32 tid = base -  trie->uniquecharcount + TRIE_LIST_ITEM( state, idx ).forid;
1953                             trie->trans[ tid ].next = TRIE_LIST_ITEM( state, idx ).newstate;
1954                             trie->trans[ tid ].check = state;
1955                         }
1956                         tp += ( maxid - minid + 1 );
1957                     }
1958                     Safefree(trie->states[ state ].trans.list);
1959                 }
1960                 /*
1961                 DEBUG_TRIE_COMPILE_MORE_r(
1962                     PerlIO_printf( Perl_debug_log, " base: %d\n",base);
1963                 );
1964                 */
1965                 trie->states[ state ].trans.base=base;
1966             }
1967             trie->lasttrans = tp + 1;
1968         }
1969     } else {
1970         /*
1971            Second Pass -- Flat Table Representation.
1972
1973            we dont use the 0 slot of either trans[] or states[] so we add 1 to each.
1974            We know that we will need Charcount+1 trans at most to store the data
1975            (one row per char at worst case) So we preallocate both structures
1976            assuming worst case.
1977
1978            We then construct the trie using only the .next slots of the entry
1979            structs.
1980
1981            We use the .check field of the first entry of the node temporarily to
1982            make compression both faster and easier by keeping track of how many non
1983            zero fields are in the node.
1984
1985            Since trans are numbered from 1 any 0 pointer in the table is a FAIL
1986            transition.
1987
1988            There are two terms at use here: state as a TRIE_NODEIDX() which is a
1989            number representing the first entry of the node, and state as a
1990            TRIE_NODENUM() which is the trans number. state 1 is TRIE_NODEIDX(1) and
1991            TRIE_NODENUM(1), state 2 is TRIE_NODEIDX(2) and TRIE_NODENUM(3) if there
1992            are 2 entrys per node. eg:
1993
1994              A B       A B
1995           1. 2 4    1. 3 7
1996           2. 0 3    3. 0 5
1997           3. 0 0    5. 0 0
1998           4. 0 0    7. 0 0
1999
2000            The table is internally in the right hand, idx form. However as we also
2001            have to deal with the states array which is indexed by nodenum we have to
2002            use TRIE_NODENUM() to convert.
2003
2004         */
2005         DEBUG_TRIE_COMPILE_MORE_r( PerlIO_printf( Perl_debug_log, 
2006             "%*sCompiling trie using table compiler\n",
2007             (int)depth * 2 + 2, ""));
2008
2009         trie->trans = (reg_trie_trans *)
2010             PerlMemShared_calloc( ( TRIE_CHARCOUNT(trie) + 1 )
2011                                   * trie->uniquecharcount + 1,
2012                                   sizeof(reg_trie_trans) );
2013         trie->states = (reg_trie_state *)
2014             PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
2015                                   sizeof(reg_trie_state) );
2016         next_alloc = trie->uniquecharcount + 1;
2017
2018
2019         for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
2020
2021             regnode *noper   = NEXTOPER( cur );
2022             const U8 *uc     = (U8*)STRING( noper );
2023             const U8 *e      = uc + STR_LEN( noper );
2024
2025             U32 state        = 1;         /* required init */
2026
2027             U16 charid       = 0;         /* sanity init */
2028             U32 accept_state = 0;         /* sanity init */
2029             U8 *scan         = (U8*)NULL; /* sanity init */
2030
2031             STRLEN foldlen   = 0;         /* required init */
2032             U32 wordlen      = 0;         /* required init */
2033             STRLEN skiplen   = 0;
2034             U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
2035
2036             if (OP(noper) == NOTHING) {
2037                 regnode *noper_next= regnext(noper);
2038                 if (noper_next != tail && OP(noper_next) == flags) {
2039                     noper = noper_next;
2040                     uc= (U8*)STRING(noper);
2041                     e= uc + STR_LEN(noper);
2042                 }
2043             }
2044
2045             if ( OP(noper) != NOTHING ) {
2046                 for ( ; uc < e ; uc += len ) {
2047
2048                     TRIE_READ_CHAR;
2049
2050                     if ( uvc < 256 ) {
2051                         charid = trie->charmap[ uvc ];
2052                     } else {
2053                         SV* const * const svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 0);
2054                         charid = svpp ? (U16)SvIV(*svpp) : 0;
2055                     }
2056                     if ( charid ) {
2057                         charid--;
2058                         if ( !trie->trans[ state + charid ].next ) {
2059                             trie->trans[ state + charid ].next = next_alloc;
2060                             trie->trans[ state ].check++;
2061                             prev_states[TRIE_NODENUM(next_alloc)]
2062                                     = TRIE_NODENUM(state);
2063                             next_alloc += trie->uniquecharcount;
2064                         }
2065                         state = trie->trans[ state + charid ].next;
2066                     } else {
2067                         Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %"IVdf, uvc );
2068                     }
2069                     /* charid is now 0 if we dont know the char read, or nonzero if we do */
2070                 }
2071             }
2072             accept_state = TRIE_NODENUM( state );
2073             TRIE_HANDLE_WORD(accept_state);
2074
2075         } /* end second pass */
2076
2077         /* and now dump it out before we compress it */
2078         DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_table(trie, widecharmap,
2079                                                           revcharmap,
2080                                                           next_alloc, depth+1));
2081
2082         {
2083         /*
2084            * Inplace compress the table.*
2085
2086            For sparse data sets the table constructed by the trie algorithm will
2087            be mostly 0/FAIL transitions or to put it another way mostly empty.
2088            (Note that leaf nodes will not contain any transitions.)
2089
2090            This algorithm compresses the tables by eliminating most such
2091            transitions, at the cost of a modest bit of extra work during lookup:
2092
2093            - Each states[] entry contains a .base field which indicates the
2094            index in the state[] array wheres its transition data is stored.
2095
2096            - If .base is 0 there are no valid transitions from that node.
2097
2098            - If .base is nonzero then charid is added to it to find an entry in
2099            the trans array.
2100
2101            -If trans[states[state].base+charid].check!=state then the
2102            transition is taken to be a 0/Fail transition. Thus if there are fail
2103            transitions at the front of the node then the .base offset will point
2104            somewhere inside the previous nodes data (or maybe even into a node
2105            even earlier), but the .check field determines if the transition is
2106            valid.
2107
2108            XXX - wrong maybe?
2109            The following process inplace converts the table to the compressed
2110            table: We first do not compress the root node 1,and mark all its
2111            .check pointers as 1 and set its .base pointer as 1 as well. This
2112            allows us to do a DFA construction from the compressed table later,
2113            and ensures that any .base pointers we calculate later are greater
2114            than 0.
2115
2116            - We set 'pos' to indicate the first entry of the second node.
2117
2118            - We then iterate over the columns of the node, finding the first and
2119            last used entry at l and m. We then copy l..m into pos..(pos+m-l),
2120            and set the .check pointers accordingly, and advance pos
2121            appropriately and repreat for the next node. Note that when we copy
2122            the next pointers we have to convert them from the original
2123            NODEIDX form to NODENUM form as the former is not valid post
2124            compression.
2125
2126            - If a node has no transitions used we mark its base as 0 and do not
2127            advance the pos pointer.
2128
2129            - If a node only has one transition we use a second pointer into the
2130            structure to fill in allocated fail transitions from other states.
2131            This pointer is independent of the main pointer and scans forward
2132            looking for null transitions that are allocated to a state. When it
2133            finds one it writes the single transition into the "hole".  If the
2134            pointer doesnt find one the single transition is appended as normal.
2135
2136            - Once compressed we can Renew/realloc the structures to release the
2137            excess space.
2138
2139            See "Table-Compression Methods" in sec 3.9 of the Red Dragon,
2140            specifically Fig 3.47 and the associated pseudocode.
2141
2142            demq
2143         */
2144         const U32 laststate = TRIE_NODENUM( next_alloc );
2145         U32 state, charid;
2146         U32 pos = 0, zp=0;
2147         trie->statecount = laststate;
2148
2149         for ( state = 1 ; state < laststate ; state++ ) {
2150             U8 flag = 0;
2151             const U32 stateidx = TRIE_NODEIDX( state );
2152             const U32 o_used = trie->trans[ stateidx ].check;
2153             U32 used = trie->trans[ stateidx ].check;
2154             trie->trans[ stateidx ].check = 0;
2155
2156             for ( charid = 0 ; used && charid < trie->uniquecharcount ; charid++ ) {
2157                 if ( flag || trie->trans[ stateidx + charid ].next ) {
2158                     if ( trie->trans[ stateidx + charid ].next ) {
2159                         if (o_used == 1) {
2160                             for ( ; zp < pos ; zp++ ) {
2161                                 if ( ! trie->trans[ zp ].next ) {
2162                                     break;
2163                                 }
2164                             }
2165                             trie->states[ state ].trans.base = zp + trie->uniquecharcount - charid ;
2166                             trie->trans[ zp ].next = SAFE_TRIE_NODENUM( trie->trans[ stateidx + charid ].next );
2167                             trie->trans[ zp ].check = state;
2168                             if ( ++zp > pos ) pos = zp;
2169                             break;
2170                         }
2171                         used--;
2172                     }
2173                     if ( !flag ) {
2174                         flag = 1;
2175                         trie->states[ state ].trans.base = pos + trie->uniquecharcount - charid ;
2176                     }
2177                     trie->trans[ pos ].next = SAFE_TRIE_NODENUM( trie->trans[ stateidx + charid ].next );
2178                     trie->trans[ pos ].check = state;
2179                     pos++;
2180                 }
2181             }
2182         }
2183         trie->lasttrans = pos + 1;
2184         trie->states = (reg_trie_state *)
2185             PerlMemShared_realloc( trie->states, laststate
2186                                    * sizeof(reg_trie_state) );
2187         DEBUG_TRIE_COMPILE_MORE_r(
2188                 PerlIO_printf( Perl_debug_log,
2189                     "%*sAlloc: %d Orig: %"IVdf" elements, Final:%"IVdf". Savings of %%%5.2f\n",
2190                     (int)depth * 2 + 2,"",
2191                     (int)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1 ),
2192                     (IV)next_alloc,
2193                     (IV)pos,
2194                     ( ( next_alloc - pos ) * 100 ) / (double)next_alloc );
2195             );
2196
2197         } /* end table compress */
2198     }
2199     DEBUG_TRIE_COMPILE_MORE_r(
2200             PerlIO_printf(Perl_debug_log, "%*sStatecount:%"UVxf" Lasttrans:%"UVxf"\n",
2201                 (int)depth * 2 + 2, "",
2202                 (UV)trie->statecount,
2203                 (UV)trie->lasttrans)
2204     );
2205     /* resize the trans array to remove unused space */
2206     trie->trans = (reg_trie_trans *)
2207         PerlMemShared_realloc( trie->trans, trie->lasttrans
2208                                * sizeof(reg_trie_trans) );
2209
2210     {   /* Modify the program and insert the new TRIE node */ 
2211         U8 nodetype =(U8)(flags & 0xFF);
2212         char *str=NULL;
2213         
2214 #ifdef DEBUGGING
2215         regnode *optimize = NULL;
2216 #ifdef RE_TRACK_PATTERN_OFFSETS
2217
2218         U32 mjd_offset = 0;
2219         U32 mjd_nodelen = 0;
2220 #endif /* RE_TRACK_PATTERN_OFFSETS */
2221 #endif /* DEBUGGING */
2222         /*
2223            This means we convert either the first branch or the first Exact,
2224            depending on whether the thing following (in 'last') is a branch
2225            or not and whther first is the startbranch (ie is it a sub part of
2226            the alternation or is it the whole thing.)
2227            Assuming its a sub part we convert the EXACT otherwise we convert
2228            the whole branch sequence, including the first.
2229          */
2230         /* Find the node we are going to overwrite */
2231         if ( first != startbranch || OP( last ) == BRANCH ) {
2232             /* branch sub-chain */
2233             NEXT_OFF( first ) = (U16)(last - first);
2234 #ifdef RE_TRACK_PATTERN_OFFSETS
2235             DEBUG_r({
2236                 mjd_offset= Node_Offset((convert));
2237                 mjd_nodelen= Node_Length((convert));
2238             });
2239 #endif
2240             /* whole branch chain */
2241         }
2242 #ifdef RE_TRACK_PATTERN_OFFSETS
2243         else {
2244             DEBUG_r({
2245                 const  regnode *nop = NEXTOPER( convert );
2246                 mjd_offset= Node_Offset((nop));
2247                 mjd_nodelen= Node_Length((nop));
2248             });
2249         }
2250         DEBUG_OPTIMISE_r(
2251             PerlIO_printf(Perl_debug_log, "%*sMJD offset:%"UVuf" MJD length:%"UVuf"\n",
2252                 (int)depth * 2 + 2, "",
2253                 (UV)mjd_offset, (UV)mjd_nodelen)
2254         );
2255 #endif
2256         /* But first we check to see if there is a common prefix we can 
2257            split out as an EXACT and put in front of the TRIE node.  */
2258         trie->startstate= 1;
2259         if ( trie->bitmap && !widecharmap && !trie->jump  ) {
2260             U32 state;
2261             for ( state = 1 ; state < trie->statecount-1 ; state++ ) {
2262                 U32 ofs = 0;
2263                 I32 idx = -1;
2264                 U32 count = 0;
2265                 const U32 base = trie->states[ state ].trans.base;
2266
2267                 if ( trie->states[state].wordnum )
2268                         count = 1;
2269
2270                 for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
2271                     if ( ( base + ofs >= trie->uniquecharcount ) &&
2272                          ( base + ofs - trie->uniquecharcount < trie->lasttrans ) &&
2273                          trie->trans[ base + ofs - trie->uniquecharcount ].check == state )
2274                     {
2275                         if ( ++count > 1 ) {
2276                             SV **tmp = av_fetch( revcharmap, ofs, 0);
2277                             const U8 *ch = (U8*)SvPV_nolen_const( *tmp );
2278                             if ( state == 1 ) break;
2279                             if ( count == 2 ) {
2280                                 Zero(trie->bitmap, ANYOF_BITMAP_SIZE, char);
2281                                 DEBUG_OPTIMISE_r(
2282                                     PerlIO_printf(Perl_debug_log,
2283                                         "%*sNew Start State=%"UVuf" Class: [",
2284                                         (int)depth * 2 + 2, "",
2285                                         (UV)state));
2286                                 if (idx >= 0) {
2287                                     SV ** const tmp = av_fetch( revcharmap, idx, 0);
2288                                     const U8 * const ch = (U8*)SvPV_nolen_const( *tmp );
2289
2290                                     TRIE_BITMAP_SET(trie,*ch);
2291                                     if ( folder )
2292                                         TRIE_BITMAP_SET(trie, folder[ *ch ]);
2293                                     DEBUG_OPTIMISE_r(
2294                                         PerlIO_printf(Perl_debug_log, "%s", (char*)ch)
2295                                     );
2296                                 }
2297                             }
2298                             TRIE_BITMAP_SET(trie,*ch);
2299                             if ( folder )
2300                                 TRIE_BITMAP_SET(trie,folder[ *ch ]);
2301                             DEBUG_OPTIMISE_r(PerlIO_printf( Perl_debug_log,"%s", ch));
2302                         }
2303                         idx = ofs;
2304                     }
2305                 }
2306                 if ( count == 1 ) {
2307                     SV **tmp = av_fetch( revcharmap, idx, 0);
2308                     STRLEN len;
2309                     char *ch = SvPV( *tmp, len );
2310                     DEBUG_OPTIMISE_r({
2311                         SV *sv=sv_newmortal();
2312                         PerlIO_printf( Perl_debug_log,
2313                             "%*sPrefix State: %"UVuf" Idx:%"UVuf" Char='%s'\n",
2314                             (int)depth * 2 + 2, "",
2315                             (UV)state, (UV)idx, 
2316                             pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), 6, 
2317                                 PL_colors[0], PL_colors[1],
2318                                 (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
2319                                 PERL_PV_ESCAPE_FIRSTCHAR 
2320                             )
2321                         );
2322                     });
2323                     if ( state==1 ) {
2324                         OP( convert ) = nodetype;
2325                         str=STRING(convert);
2326                         STR_LEN(convert)=0;
2327                     }
2328                     STR_LEN(convert) += len;
2329                     while (len--)
2330                         *str++ = *ch++;
2331                 } else {
2332 #ifdef DEBUGGING            
2333                     if (state>1)
2334                         DEBUG_OPTIMISE_r(PerlIO_printf( Perl_debug_log,"]\n"));
2335 #endif
2336                     break;
2337                 }
2338             }
2339             trie->prefixlen = (state-1);
2340             if (str) {
2341                 regnode *n = convert+NODE_SZ_STR(convert);
2342                 NEXT_OFF(convert) = NODE_SZ_STR(convert);
2343                 trie->startstate = state;
2344                 trie->minlen -= (state - 1);
2345                 trie->maxlen -= (state - 1);
2346 #ifdef DEBUGGING
2347                /* At least the UNICOS C compiler choked on this
2348                 * being argument to DEBUG_r(), so let's just have
2349                 * it right here. */
2350                if (
2351 #ifdef PERL_EXT_RE_BUILD
2352                    1
2353 #else
2354                    DEBUG_r_TEST
2355 #endif
2356                    ) {
2357                    regnode *fix = convert;
2358                    U32 word = trie->wordcount;
2359                    mjd_nodelen++;
2360                    Set_Node_Offset_Length(convert, mjd_offset, state - 1);
2361                    while( ++fix < n ) {
2362                        Set_Node_Offset_Length(fix, 0, 0);
2363                    }
2364                    while (word--) {
2365                        SV ** const tmp = av_fetch( trie_words, word, 0 );
2366                        if (tmp) {
2367                            if ( STR_LEN(convert) <= SvCUR(*tmp) )
2368                                sv_chop(*tmp, SvPV_nolen(*tmp) + STR_LEN(convert));
2369                            else
2370                                sv_chop(*tmp, SvPV_nolen(*tmp) + SvCUR(*tmp));
2371                        }
2372                    }
2373                }
2374 #endif
2375                 if (trie->maxlen) {
2376                     convert = n;
2377                 } else {
2378                     NEXT_OFF(convert) = (U16)(tail - convert);
2379                     DEBUG_r(optimize= n);
2380                 }
2381             }
2382         }
2383         if (!jumper) 
2384             jumper = last; 
2385         if ( trie->maxlen ) {
2386             NEXT_OFF( convert ) = (U16)(tail - convert);
2387             ARG_SET( convert, data_slot );
2388             /* Store the offset to the first unabsorbed branch in 
2389                jump[0], which is otherwise unused by the jump logic. 
2390                We use this when dumping a trie and during optimisation. */
2391             if (trie->jump) 
2392                 trie->jump[0] = (U16)(nextbranch - convert);
2393             
2394             /* If the start state is not accepting (meaning there is no empty string/NOTHING)
2395              *   and there is a bitmap
2396              *   and the first "jump target" node we found leaves enough room
2397              * then convert the TRIE node into a TRIEC node, with the bitmap
2398              * embedded inline in the opcode - this is hypothetically faster.
2399              */
2400             if ( !trie->states[trie->startstate].wordnum
2401                  && trie->bitmap
2402                  && ( (char *)jumper - (char *)convert) >= (int)sizeof(struct regnode_charclass) )
2403             {
2404                 OP( convert ) = TRIEC;
2405                 Copy(trie->bitmap, ((struct regnode_charclass *)convert)->bitmap, ANYOF_BITMAP_SIZE, char);
2406                 PerlMemShared_free(trie->bitmap);
2407                 trie->bitmap= NULL;
2408             } else 
2409                 OP( convert ) = TRIE;
2410
2411             /* store the type in the flags */
2412             convert->flags = nodetype;
2413             DEBUG_r({
2414             optimize = convert 
2415                       + NODE_STEP_REGNODE 
2416                       + regarglen[ OP( convert ) ];
2417             });
2418             /* XXX We really should free up the resource in trie now, 
2419                    as we won't use them - (which resources?) dmq */
2420         }
2421         /* needed for dumping*/
2422         DEBUG_r(if (optimize) {
2423             regnode *opt = convert;
2424
2425             while ( ++opt < optimize) {
2426                 Set_Node_Offset_Length(opt,0,0);
2427             }
2428             /* 
2429                 Try to clean up some of the debris left after the 
2430                 optimisation.
2431              */
2432             while( optimize < jumper ) {
2433                 mjd_nodelen += Node_Length((optimize));
2434                 OP( optimize ) = OPTIMIZED;
2435                 Set_Node_Offset_Length(optimize,0,0);
2436                 optimize++;
2437             }
2438             Set_Node_Offset_Length(convert,mjd_offset,mjd_nodelen);
2439         });
2440     } /* end node insert */
2441     REH_CALL_COMP_NODE_HOOK(pRExC_state->rx, convert);
2442
2443     /*  Finish populating the prev field of the wordinfo array.  Walk back
2444      *  from each accept state until we find another accept state, and if
2445      *  so, point the first word's .prev field at the second word. If the
2446      *  second already has a .prev field set, stop now. This will be the
2447      *  case either if we've already processed that word's accept state,
2448      *  or that state had multiple words, and the overspill words were
2449      *  already linked up earlier.
2450      */
2451     {
2452         U16 word;
2453         U32 state;
2454         U16 prev;
2455
2456         for (word=1; word <= trie->wordcount; word++) {
2457             prev = 0;
2458             if (trie->wordinfo[word].prev)
2459                 continue;
2460             state = trie->wordinfo[word].accept;
2461             while (state) {
2462                 state = prev_states[state];
2463                 if (!state)
2464                     break;
2465                 prev = trie->states[state].wordnum;
2466                 if (prev)
2467                     break;
2468             }
2469             trie->wordinfo[word].prev = prev;
2470         }
2471         Safefree(prev_states);
2472     }
2473
2474
2475     /* and now dump out the compressed format */
2476     DEBUG_TRIE_COMPILE_r(dump_trie(trie, widecharmap, revcharmap, depth+1));
2477
2478     RExC_rxi->data->data[ data_slot + 1 ] = (void*)widecharmap;
2479 #ifdef DEBUGGING
2480     RExC_rxi->data->data[ data_slot + TRIE_WORDS_OFFSET ] = (void*)trie_words;
2481     RExC_rxi->data->data[ data_slot + 3 ] = (void*)revcharmap;
2482 #else
2483     SvREFCNT_dec_NN(revcharmap);
2484 #endif
2485     return trie->jump 
2486            ? MADE_JUMP_TRIE 
2487            : trie->startstate>1 
2488              ? MADE_EXACT_TRIE 
2489              : MADE_TRIE;
2490 }
2491
2492 STATIC void
2493 S_make_trie_failtable(pTHX_ RExC_state_t *pRExC_state, regnode *source,  regnode *stclass, U32 depth)
2494 {
2495 /* The Trie is constructed and compressed now so we can build a fail array if it's needed
2496
2497    This is basically the Aho-Corasick algorithm. Its from exercise 3.31 and 3.32 in the
2498    "Red Dragon" -- Compilers, principles, techniques, and tools. Aho, Sethi, Ullman 1985/88
2499    ISBN 0-201-10088-6
2500
2501    We find the fail state for each state in the trie, this state is the longest proper
2502    suffix of the current state's 'word' that is also a proper prefix of another word in our
2503    trie. State 1 represents the word '' and is thus the default fail state. This allows
2504    the DFA not to have to restart after its tried and failed a word at a given point, it
2505    simply continues as though it had been matching the other word in the first place.
2506    Consider
2507       'abcdgu'=~/abcdefg|cdgu/
2508    When we get to 'd' we are still matching the first word, we would encounter 'g' which would
2509    fail, which would bring us to the state representing 'd' in the second word where we would
2510    try 'g' and succeed, proceeding to match 'cdgu'.
2511  */
2512  /* add a fail transition */
2513     const U32 trie_offset = ARG(source);
2514     reg_trie_data *trie=(reg_trie_data *)RExC_rxi->data->data[trie_offset];
2515     U32 *q;
2516     const U32 ucharcount = trie->uniquecharcount;
2517     const U32 numstates = trie->statecount;
2518     const U32 ubound = trie->lasttrans + ucharcount;
2519     U32 q_read = 0;
2520     U32 q_write = 0;
2521     U32 charid;
2522     U32 base = trie->states[ 1 ].trans.base;
2523     U32 *fail;
2524     reg_ac_data *aho;
2525     const U32 data_slot = add_data( pRExC_state, 1, "T" );
2526     GET_RE_DEBUG_FLAGS_DECL;
2527
2528     PERL_ARGS_ASSERT_MAKE_TRIE_FAILTABLE;
2529 #ifndef DEBUGGING
2530     PERL_UNUSED_ARG(depth);
2531 #endif
2532
2533
2534     ARG_SET( stclass, data_slot );
2535     aho = (reg_ac_data *) PerlMemShared_calloc( 1, sizeof(reg_ac_data) );
2536     RExC_rxi->data->data[ data_slot ] = (void*)aho;
2537     aho->trie=trie_offset;
2538     aho->states=(reg_trie_state *)PerlMemShared_malloc( numstates * sizeof(reg_trie_state) );
2539     Copy( trie->states, aho->states, numstates, reg_trie_state );
2540     Newxz( q, numstates, U32);
2541     aho->fail = (U32 *) PerlMemShared_calloc( numstates, sizeof(U32) );
2542     aho->refcount = 1;
2543     fail = aho->fail;
2544     /* initialize fail[0..1] to be 1 so that we always have
2545        a valid final fail state */
2546     fail[ 0 ] = fail[ 1 ] = 1;
2547
2548     for ( charid = 0; charid < ucharcount ; charid++ ) {
2549         const U32 newstate = TRIE_TRANS_STATE( 1, base, ucharcount, charid, 0 );
2550         if ( newstate ) {
2551             q[ q_write ] = newstate;
2552             /* set to point at the root */
2553             fail[ q[ q_write++ ] ]=1;
2554         }
2555     }
2556     while ( q_read < q_write) {
2557         const U32 cur = q[ q_read++ % numstates ];
2558         base = trie->states[ cur ].trans.base;
2559
2560         for ( charid = 0 ; charid < ucharcount ; charid++ ) {
2561             const U32 ch_state = TRIE_TRANS_STATE( cur, base, ucharcount, charid, 1 );
2562             if (ch_state) {
2563                 U32 fail_state = cur;
2564                 U32 fail_base;
2565                 do {
2566                     fail_state = fail[ fail_state ];
2567                     fail_base = aho->states[ fail_state ].trans.base;
2568                 } while ( !TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 ) );
2569
2570                 fail_state = TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 );
2571                 fail[ ch_state ] = fail_state;
2572                 if ( !aho->states[ ch_state ].wordnum && aho->states[ fail_state ].wordnum )
2573                 {
2574                         aho->states[ ch_state ].wordnum =  aho->states[ fail_state ].wordnum;
2575                 }
2576                 q[ q_write++ % numstates] = ch_state;
2577             }
2578         }
2579     }
2580     /* restore fail[0..1] to 0 so that we "fall out" of the AC loop
2581        when we fail in state 1, this allows us to use the
2582        charclass scan to find a valid start char. This is based on the principle
2583        that theres a good chance the string being searched contains lots of stuff
2584        that cant be a start char.
2585      */
2586     fail[ 0 ] = fail[ 1 ] = 0;
2587     DEBUG_TRIE_COMPILE_r({
2588         PerlIO_printf(Perl_debug_log,
2589                       "%*sStclass Failtable (%"UVuf" states): 0", 
2590                       (int)(depth * 2), "", (UV)numstates
2591         );
2592         for( q_read=1; q_read<numstates; q_read++ ) {
2593             PerlIO_printf(Perl_debug_log, ", %"UVuf, (UV)fail[q_read]);
2594         }
2595         PerlIO_printf(Perl_debug_log, "\n");
2596     });
2597     Safefree(q);
2598     /*RExC_seen |= REG_SEEN_TRIEDFA;*/
2599 }
2600
2601
2602 /*
2603  * There are strange code-generation bugs caused on sparc64 by gcc-2.95.2.
2604  * These need to be revisited when a newer toolchain becomes available.
2605  */
2606 #if defined(__sparc64__) && defined(__GNUC__)
2607 #   if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 96)
2608 #       undef  SPARC64_GCC_WORKAROUND
2609 #       define SPARC64_GCC_WORKAROUND 1
2610 #   endif
2611 #endif
2612
2613 #define DEBUG_PEEP(str,scan,depth) \
2614     DEBUG_OPTIMISE_r({if (scan){ \
2615        SV * const mysv=sv_newmortal(); \
2616        regnode *Next = regnext(scan); \
2617        regprop(RExC_rx, mysv, scan); \
2618        PerlIO_printf(Perl_debug_log, "%*s" str ">%3d: %s (%d)\n", \
2619        (int)depth*2, "", REG_NODE_NUM(scan), SvPV_nolen_const(mysv),\
2620        Next ? (REG_NODE_NUM(Next)) : 0 ); \
2621    }});
2622
2623
2624 /* The below joins as many adjacent EXACTish nodes as possible into a single
2625  * one.  The regop may be changed if the node(s) contain certain sequences that
2626  * require special handling.  The joining is only done if:
2627  * 1) there is room in the current conglomerated node to entirely contain the
2628  *    next one.
2629  * 2) they are the exact same node type
2630  *
2631  * The adjacent nodes actually may be separated by NOTHING-kind nodes, and
2632  * these get optimized out
2633  *
2634  * If a node is to match under /i (folded), the number of characters it matches
2635  * can be different than its character length if it contains a multi-character
2636  * fold.  *min_subtract is set to the total delta of the input nodes.
2637  *
2638  * And *has_exactf_sharp_s is set to indicate whether or not the node is EXACTF
2639  * and contains LATIN SMALL LETTER SHARP S
2640  *
2641  * This is as good a place as any to discuss the design of handling these
2642  * multi-character fold sequences.  It's been wrong in Perl for a very long
2643  * time.  There are three code points in Unicode whose multi-character folds
2644  * were long ago discovered to mess things up.  The previous designs for
2645  * dealing with these involved assigning a special node for them.  This
2646  * approach doesn't work, as evidenced by this example:
2647  *      "\xDFs" =~ /s\xDF/ui    # Used to fail before these patches
2648  * Both these fold to "sss", but if the pattern is parsed to create a node that
2649  * would match just the \xDF, it won't be able to handle the case where a
2650  * successful match would have to cross the node's boundary.  The new approach
2651  * that hopefully generally solves the problem generates an EXACTFU_SS node
2652  * that is "sss".
2653  *
2654  * It turns out that there are problems with all multi-character folds, and not
2655  * just these three.  Now the code is general, for all such cases, but the
2656  * three still have some special handling.  The approach taken is:
2657  * 1)   This routine examines each EXACTFish node that could contain multi-
2658  *      character fold sequences.  It returns in *min_subtract how much to
2659  *      subtract from the the actual length of the string to get a real minimum
2660  *      match length; it is 0 if there are no multi-char folds.  This delta is
2661  *      used by the caller to adjust the min length of the match, and the delta
2662  *      between min and max, so that the optimizer doesn't reject these
2663  *      possibilities based on size constraints.
2664  * 2)   Certain of these sequences require special handling by the trie code,
2665  *      so, if found, this code changes the joined node type to special ops:
2666  *      EXACTFU_TRICKYFOLD and EXACTFU_SS.
2667  * 3)   For the sequence involving the Sharp s (\xDF), the node type EXACTFU_SS
2668  *      is used for an EXACTFU node that contains at least one "ss" sequence in
2669  *      it.  For non-UTF-8 patterns and strings, this is the only case where
2670  *      there is a possible fold length change.  That means that a regular
2671  *      EXACTFU node without UTF-8 involvement doesn't have to concern itself
2672  *      with length changes, and so can be processed faster.  regexec.c takes
2673  *      advantage of this.  Generally, an EXACTFish node that is in UTF-8 is
2674  *      pre-folded by regcomp.c.  This saves effort in regex matching.
2675  *      However, the pre-folding isn't done for non-UTF8 patterns because the
2676  *      fold of the MICRO SIGN requires UTF-8, and we don't want to slow things
2677  *      down by forcing the pattern into UTF8 unless necessary.  Also what
2678  *      EXACTF and EXACTFL nodes fold to isn't known until runtime.  The fold
2679  *      possibilities for the non-UTF8 patterns are quite simple, except for
2680  *      the sharp s.  All the ones that don't involve a UTF-8 target string are
2681  *      members of a fold-pair, and arrays are set up for all of them so that
2682  *      the other member of the pair can be found quickly.  Code elsewhere in
2683  *      this file makes sure that in EXACTFU nodes, the sharp s gets folded to
2684  *      'ss', even if the pattern isn't UTF-8.  This avoids the issues
2685  *      described in the next item.
2686  * 4)   A problem remains for the sharp s in EXACTF nodes.  Whether it matches
2687  *      'ss' or not is not knowable at compile time.  It will match iff the
2688  *      target string is in UTF-8, unlike the EXACTFU nodes, where it always
2689  *      matches; and the EXACTFL and EXACTFA nodes where it never does.  Thus
2690  *      it can't be folded to "ss" at compile time, unlike EXACTFU does (as
2691  *      described in item 3).  An assumption that the optimizer part of
2692  *      regexec.c (probably unwittingly) makes is that a character in the
2693  *      pattern corresponds to at most a single character in the target string.
2694  *      (And I do mean character, and not byte here, unlike other parts of the
2695  *      documentation that have never been updated to account for multibyte
2696  *      Unicode.)  This assumption is wrong only in this case, as all other
2697  *      cases are either 1-1 folds when no UTF-8 is involved; or is true by
2698  *      virtue of having this file pre-fold UTF-8 patterns.   I'm
2699  *      reluctant to try to change this assumption, so instead the code punts.
2700  *      This routine examines EXACTF nodes for the sharp s, and returns a
2701  *      boolean indicating whether or not the node is an EXACTF node that
2702  *      contains a sharp s.  When it is true, the caller sets a flag that later
2703  *      causes the optimizer in this file to not set values for the floating
2704  *      and fixed string lengths, and thus avoids the optimizer code in
2705  *      regexec.c that makes the invalid assumption.  Thus, there is no
2706  *      optimization based on string lengths for EXACTF nodes that contain the
2707  *      sharp s.  This only happens for /id rules (which means the pattern
2708  *      isn't in UTF-8).
2709  */
2710
2711 #define JOIN_EXACT(scan,min_subtract,has_exactf_sharp_s, flags) \
2712     if (PL_regkind[OP(scan)] == EXACT) \
2713         join_exact(pRExC_state,(scan),(min_subtract),has_exactf_sharp_s, (flags),NULL,depth+1)
2714
2715 STATIC U32
2716 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) {
2717     /* Merge several consecutive EXACTish nodes into one. */
2718     regnode *n = regnext(scan);
2719     U32 stringok = 1;
2720     regnode *next = scan + NODE_SZ_STR(scan);
2721     U32 merged = 0;
2722     U32 stopnow = 0;
2723 #ifdef DEBUGGING
2724     regnode *stop = scan;
2725     GET_RE_DEBUG_FLAGS_DECL;
2726 #else
2727     PERL_UNUSED_ARG(depth);
2728 #endif
2729
2730     PERL_ARGS_ASSERT_JOIN_EXACT;
2731 #ifndef EXPERIMENTAL_INPLACESCAN
2732     PERL_UNUSED_ARG(flags);
2733     PERL_UNUSED_ARG(val);
2734 #endif
2735     DEBUG_PEEP("join",scan,depth);
2736
2737     /* Look through the subsequent nodes in the chain.  Skip NOTHING, merge
2738      * EXACT ones that are mergeable to the current one. */
2739     while (n
2740            && (PL_regkind[OP(n)] == NOTHING
2741                || (stringok && OP(n) == OP(scan)))
2742            && NEXT_OFF(n)
2743            && NEXT_OFF(scan) + NEXT_OFF(n) < I16_MAX)
2744     {
2745         
2746         if (OP(n) == TAIL || n > next)
2747             stringok = 0;
2748         if (PL_regkind[OP(n)] == NOTHING) {
2749             DEBUG_PEEP("skip:",n,depth);
2750             NEXT_OFF(scan) += NEXT_OFF(n);
2751             next = n + NODE_STEP_REGNODE;
2752 #ifdef DEBUGGING
2753             if (stringok)
2754                 stop = n;
2755 #endif
2756             n = regnext(n);
2757         }
2758         else if (stringok) {
2759             const unsigned int oldl = STR_LEN(scan);
2760             regnode * const nnext = regnext(n);
2761
2762             /* XXX I (khw) kind of doubt that this works on platforms where
2763              * U8_MAX is above 255 because of lots of other assumptions */
2764             /* Don't join if the sum can't fit into a single node */
2765             if (oldl + STR_LEN(n) > U8_MAX)
2766                 break;
2767             
2768             DEBUG_PEEP("merg",n,depth);
2769             merged++;
2770
2771             NEXT_OFF(scan) += NEXT_OFF(n);
2772             STR_LEN(scan) += STR_LEN(n);
2773             next = n + NODE_SZ_STR(n);
2774             /* Now we can overwrite *n : */
2775             Move(STRING(n), STRING(scan) + oldl, STR_LEN(n), char);
2776 #ifdef DEBUGGING
2777             stop = next - 1;
2778 #endif
2779             n = nnext;
2780             if (stopnow) break;
2781         }
2782
2783 #ifdef EXPERIMENTAL_INPLACESCAN
2784         if (flags && !NEXT_OFF(n)) {
2785             DEBUG_PEEP("atch", val, depth);
2786             if (reg_off_by_arg[OP(n)]) {
2787                 ARG_SET(n, val - n);
2788             }
2789             else {
2790                 NEXT_OFF(n) = val - n;
2791             }
2792             stopnow = 1;
2793         }
2794 #endif
2795     }
2796
2797     *min_subtract = 0;
2798     *has_exactf_sharp_s = FALSE;
2799
2800     /* Here, all the adjacent mergeable EXACTish nodes have been merged.  We
2801      * can now analyze for sequences of problematic code points.  (Prior to
2802      * this final joining, sequences could have been split over boundaries, and
2803      * hence missed).  The sequences only happen in folding, hence for any
2804      * non-EXACT EXACTish node */
2805     if (OP(scan) != EXACT) {
2806         const U8 * const s0 = (U8*) STRING(scan);
2807         const U8 * s = s0;
2808         const U8 * const s_end = s0 + STR_LEN(scan);
2809
2810         /* One pass is made over the node's string looking for all the
2811          * possibilities.  to avoid some tests in the loop, there are two main
2812          * cases, for UTF-8 patterns (which can't have EXACTF nodes) and
2813          * non-UTF-8 */
2814         if (UTF) {
2815
2816             /* Examine the string for a multi-character fold sequence.  UTF-8
2817              * patterns have all characters pre-folded by the time this code is
2818              * executed */
2819             while (s < s_end - 1) /* Can stop 1 before the end, as minimum
2820                                      length sequence we are looking for is 2 */
2821             {
2822                 int count = 0;
2823                 int len = is_MULTI_CHAR_FOLD_utf8_safe(s, s_end);
2824                 if (! len) {    /* Not a multi-char fold: get next char */
2825                     s += UTF8SKIP(s);
2826                     continue;
2827                 }
2828
2829                 /* Nodes with 'ss' require special handling, except for EXACTFL
2830                  * and EXACTFA for which there is no multi-char fold to this */
2831                 if (len == 2 && *s == 's' && *(s+1) == 's'
2832                     && OP(scan) != EXACTFL && OP(scan) != EXACTFA)
2833                 {
2834                     count = 2;
2835                     OP(scan) = EXACTFU_SS;
2836                     s += 2;
2837                 }
2838                 else if (len == 6   /* len is the same in both ASCII and EBCDIC for these */
2839                          && (memEQ(s, GREEK_SMALL_LETTER_IOTA_UTF8
2840                                       COMBINING_DIAERESIS_UTF8
2841                                       COMBINING_ACUTE_ACCENT_UTF8,
2842                                    6)
2843                              || memEQ(s, GREEK_SMALL_LETTER_UPSILON_UTF8
2844                                          COMBINING_DIAERESIS_UTF8
2845                                          COMBINING_ACUTE_ACCENT_UTF8,
2846                                      6)))
2847                 {
2848                     count = 3;
2849
2850                     /* These two folds require special handling by trie's, so
2851                      * change the node type to indicate this.  If EXACTFA and
2852                      * EXACTFL were ever to be handled by trie's, this would
2853                      * have to be changed.  If this node has already been
2854                      * changed to EXACTFU_SS in this loop, leave it as is.  (I
2855                      * (khw) think it doesn't matter in regexec.c for UTF
2856                      * patterns, but no need to change it */
2857                     if (OP(scan) == EXACTFU) {
2858                         OP(scan) = EXACTFU_TRICKYFOLD;
2859                     }
2860                     s += 6;
2861                 }
2862                 else { /* Here is a generic multi-char fold. */
2863                     const U8* multi_end  = s + len;
2864
2865                     /* Count how many characters in it.  In the case of /l and
2866                      * /aa, no folds which contain ASCII code points are
2867                      * allowed, so check for those, and skip if found.  (In
2868                      * EXACTFL, no folds are allowed to any Latin1 code point,
2869                      * not just ASCII.  But there aren't any of these
2870                      * currently, nor ever likely, so don't take the time to
2871                      * test for them.  The code that generates the
2872                      * is_MULTI_foo() macros croaks should one actually get put
2873                      * into Unicode .) */
2874                     if (OP(scan) != EXACTFL && OP(scan) != EXACTFA) {
2875                         count = utf8_length(s, multi_end);
2876                         s = multi_end;
2877                     }
2878                     else {
2879                         while (s < multi_end) {
2880                             if (isASCII(*s)) {
2881                                 s++;
2882                                 goto next_iteration;
2883                             }
2884                             else {
2885                                 s += UTF8SKIP(s);
2886                             }
2887                             count++;
2888                         }
2889                     }
2890                 }
2891
2892                 /* The delta is how long the sequence is minus 1 (1 is how long
2893                  * the character that folds to the sequence is) */
2894                 *min_subtract += count - 1;
2895             next_iteration: ;
2896             }
2897         }
2898         else if (OP(scan) != EXACTFL && OP(scan) != EXACTFA) {
2899
2900             /* Here, the pattern is not UTF-8.  Look for the multi-char folds
2901              * that are all ASCII.  As in the above case, EXACTFL and EXACTFA
2902              * nodes can't have multi-char folds to this range (and there are
2903              * no existing ones in the upper latin1 range).  In the EXACTF
2904              * case we look also for the sharp s, which can be in the final
2905              * position.  Otherwise we can stop looking 1 byte earlier because
2906              * have to find at least two characters for a multi-fold */
2907             const U8* upper = (OP(scan) == EXACTF) ? s_end : s_end -1;
2908
2909             /* The below is perhaps overboard, but this allows us to save a
2910              * test each time through the loop at the expense of a mask.  This
2911              * is because on both EBCDIC and ASCII machines, 'S' and 's' differ
2912              * by a single bit.  On ASCII they are 32 apart; on EBCDIC, they
2913              * are 64.  This uses an exclusive 'or' to find that bit and then
2914              * inverts it to form a mask, with just a single 0, in the bit
2915              * position where 'S' and 's' differ. */
2916             const U8 S_or_s_mask = (U8) ~ ('S' ^ 's');
2917             const U8 s_masked = 's' & S_or_s_mask;
2918
2919             while (s < upper) {
2920                 int len = is_MULTI_CHAR_FOLD_latin1_safe(s, s_end);
2921                 if (! len) {    /* Not a multi-char fold. */
2922                     if (*s == LATIN_SMALL_LETTER_SHARP_S && OP(scan) == EXACTF)
2923                     {
2924                         *has_exactf_sharp_s = TRUE;
2925                     }
2926                     s++;
2927                     continue;
2928                 }
2929
2930                 if (len == 2
2931                     && ((*s & S_or_s_mask) == s_masked)
2932                     && ((*(s+1) & S_or_s_mask) == s_masked))
2933                 {
2934
2935                     /* EXACTF nodes need to know that the minimum length
2936                      * changed so that a sharp s in the string can match this
2937                      * ss in the pattern, but they remain EXACTF nodes, as they
2938                      * won't match this unless the target string is is UTF-8,
2939                      * which we don't know until runtime */
2940                     if (OP(scan) != EXACTF) {
2941                         OP(scan) = EXACTFU_SS;
2942                     }
2943                 }
2944
2945                 *min_subtract += len - 1;
2946                 s += len;
2947             }
2948         }
2949     }
2950
2951 #ifdef DEBUGGING
2952     /* Allow dumping but overwriting the collection of skipped
2953      * ops and/or strings with fake optimized ops */
2954     n = scan + NODE_SZ_STR(scan);
2955     while (n <= stop) {
2956         OP(n) = OPTIMIZED;
2957         FLAGS(n) = 0;
2958         NEXT_OFF(n) = 0;
2959         n++;
2960     }
2961 #endif
2962     DEBUG_OPTIMISE_r(if (merged){DEBUG_PEEP("finl",scan,depth)});
2963     return stopnow;
2964 }
2965
2966 /* REx optimizer.  Converts nodes into quicker variants "in place".
2967    Finds fixed substrings.  */
2968
2969 /* Stops at toplevel WHILEM as well as at "last". At end *scanp is set
2970    to the position after last scanned or to NULL. */
2971
2972 #define INIT_AND_WITHP \
2973     assert(!and_withp); \
2974     Newx(and_withp,1,struct regnode_charclass_class); \
2975     SAVEFREEPV(and_withp)
2976
2977 /* this is a chain of data about sub patterns we are processing that
2978    need to be handled separately/specially in study_chunk. Its so
2979    we can simulate recursion without losing state.  */
2980 struct scan_frame;
2981 typedef struct scan_frame {
2982     regnode *last;  /* last node to process in this frame */
2983     regnode *next;  /* next node to process when last is reached */
2984     struct scan_frame *prev; /*previous frame*/
2985     I32 stop; /* what stopparen do we use */
2986 } scan_frame;
2987
2988
2989 #define SCAN_COMMIT(s, data, m) scan_commit(s, data, m, is_inf)
2990
2991 STATIC I32
2992 S_study_chunk(pTHX_ RExC_state_t *pRExC_state, regnode **scanp,
2993                         I32 *minlenp, I32 *deltap,
2994                         regnode *last,
2995                         scan_data_t *data,
2996                         I32 stopparen,
2997                         U8* recursed,
2998                         struct regnode_charclass_class *and_withp,
2999                         U32 flags, U32 depth)
3000                         /* scanp: Start here (read-write). */
3001                         /* deltap: Write maxlen-minlen here. */
3002                         /* last: Stop before this one. */
3003                         /* data: string data about the pattern */
3004                         /* stopparen: treat close N as END */
3005                         /* recursed: which subroutines have we recursed into */
3006                         /* and_withp: Valid if flags & SCF_DO_STCLASS_OR */
3007 {
3008     dVAR;
3009     I32 min = 0;    /* There must be at least this number of characters to match */
3010     I32 pars = 0, code;
3011     regnode *scan = *scanp, *next;
3012     I32 delta = 0;
3013     int is_inf = (flags & SCF_DO_SUBSTR) && (data->flags & SF_IS_INF);
3014     int is_inf_internal = 0;            /* The studied chunk is infinite */
3015     I32 is_par = OP(scan) == OPEN ? ARG(scan) : 0;
3016     scan_data_t data_fake;
3017     SV *re_trie_maxbuff = NULL;
3018     regnode *first_non_open = scan;
3019     I32 stopmin = I32_MAX;
3020     scan_frame *frame = NULL;
3021     GET_RE_DEBUG_FLAGS_DECL;
3022
3023     PERL_ARGS_ASSERT_STUDY_CHUNK;
3024
3025 #ifdef DEBUGGING
3026     StructCopy(&zero_scan_data, &data_fake, scan_data_t);
3027 #endif
3028
3029     if ( depth == 0 ) {
3030         while (first_non_open && OP(first_non_open) == OPEN)
3031             first_non_open=regnext(first_non_open);
3032     }
3033
3034
3035   fake_study_recurse:
3036     while ( scan && OP(scan) != END && scan < last ){
3037         UV min_subtract = 0;    /* How mmany chars to subtract from the minimum
3038                                    node length to get a real minimum (because
3039                                    the folded version may be shorter) */
3040         bool has_exactf_sharp_s = FALSE;
3041         /* Peephole optimizer: */
3042         DEBUG_STUDYDATA("Peep:", data,depth);
3043         DEBUG_PEEP("Peep",scan,depth);
3044
3045         /* Its not clear to khw or hv why this is done here, and not in the
3046          * clauses that deal with EXACT nodes.  khw's guess is that it's
3047          * because of a previous design */
3048         JOIN_EXACT(scan,&min_subtract, &has_exactf_sharp_s, 0);
3049
3050         /* Follow the next-chain of the current node and optimize
3051            away all the NOTHINGs from it.  */
3052         if (OP(scan) != CURLYX) {
3053             const int max = (reg_off_by_arg[OP(scan)]
3054                        ? I32_MAX
3055                        /* I32 may be smaller than U16 on CRAYs! */
3056                        : (I32_MAX < U16_MAX ? I32_MAX : U16_MAX));
3057             int off = (reg_off_by_arg[OP(scan)] ? ARG(scan) : NEXT_OFF(scan));
3058             int noff;
3059             regnode *n = scan;
3060
3061             /* Skip NOTHING and LONGJMP. */
3062             while ((n = regnext(n))
3063                    && ((PL_regkind[OP(n)] == NOTHING && (noff = NEXT_OFF(n)))
3064                        || ((OP(n) == LONGJMP) && (noff = ARG(n))))
3065                    && off + noff < max)
3066                 off += noff;
3067             if (reg_off_by_arg[OP(scan)])
3068                 ARG(scan) = off;
3069             else
3070                 NEXT_OFF(scan) = off;
3071         }
3072
3073
3074
3075         /* The principal pseudo-switch.  Cannot be a switch, since we
3076            look into several different things.  */
3077         if (OP(scan) == BRANCH || OP(scan) == BRANCHJ
3078                    || OP(scan) == IFTHEN) {
3079             next = regnext(scan);
3080             code = OP(scan);
3081             /* demq: the op(next)==code check is to see if we have "branch-branch" AFAICT */
3082
3083             if (OP(next) == code || code == IFTHEN) {
3084                 /* NOTE - There is similar code to this block below for handling
3085                    TRIE nodes on a re-study.  If you change stuff here check there
3086                    too. */
3087                 I32 max1 = 0, min1 = I32_MAX, num = 0;
3088                 struct regnode_charclass_class accum;
3089                 regnode * const startbranch=scan;
3090
3091                 if (flags & SCF_DO_SUBSTR)
3092                     SCAN_COMMIT(pRExC_state, data, minlenp); /* Cannot merge strings after this. */
3093                 if (flags & SCF_DO_STCLASS)
3094                     cl_init_zero(pRExC_state, &accum);
3095
3096                 while (OP(scan) == code) {
3097                     I32 deltanext, minnext, f = 0, fake;
3098                     struct regnode_charclass_class this_class;
3099
3100                     num++;
3101                     data_fake.flags = 0;
3102                     if (data) {
3103                         data_fake.whilem_c = data->whilem_c;
3104                         data_fake.last_closep = data->last_closep;
3105                     }
3106                     else
3107                         data_fake.last_closep = &fake;
3108
3109                     data_fake.pos_delta = delta;
3110                     next = regnext(scan);
3111                     scan = NEXTOPER(scan);
3112                     if (code != BRANCH)
3113                         scan = NEXTOPER(scan);
3114                     if (flags & SCF_DO_STCLASS) {
3115                         cl_init(pRExC_state, &this_class);
3116                         data_fake.start_class = &this_class;
3117                         f = SCF_DO_STCLASS_AND;
3118                     }
3119                     if (flags & SCF_WHILEM_VISITED_POS)
3120                         f |= SCF_WHILEM_VISITED_POS;
3121
3122                     /* we suppose the run is continuous, last=next...*/
3123                     minnext = study_chunk(pRExC_state, &scan, minlenp, &deltanext,
3124                                           next, &data_fake,
3125                                           stopparen, recursed, NULL, f,depth+1);
3126                     if (min1 > minnext)
3127                         min1 = minnext;
3128                     if (max1 < minnext + deltanext)
3129                         max1 = minnext + deltanext;
3130                     if (deltanext == I32_MAX)
3131                         is_inf = is_inf_internal = 1;
3132                     scan = next;
3133                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
3134                         pars++;
3135                     if (data_fake.flags & SCF_SEEN_ACCEPT) {
3136                         if ( stopmin > minnext) 
3137                             stopmin = min + min1;
3138                         flags &= ~SCF_DO_SUBSTR;
3139                         if (data)
3140                             data->flags |= SCF_SEEN_ACCEPT;
3141                     }
3142                     if (data) {
3143                         if (data_fake.flags & SF_HAS_EVAL)
3144                             data->flags |= SF_HAS_EVAL;
3145                         data->whilem_c = data_fake.whilem_c;
3146                     }
3147                     if (flags & SCF_DO_STCLASS)
3148                         cl_or(pRExC_state, &accum, &this_class);
3149                 }
3150                 if (code == IFTHEN && num < 2) /* Empty ELSE branch */
3151                     min1 = 0;
3152                 if (flags & SCF_DO_SUBSTR) {
3153                     data->pos_min += min1;
3154                     data->pos_delta += max1 - min1;
3155                     if (max1 != min1 || is_inf)
3156                         data->longest = &(data->longest_float);
3157                 }
3158                 min += min1;
3159                 delta += max1 - min1;
3160                 if (flags & SCF_DO_STCLASS_OR) {
3161                     cl_or(pRExC_state, data->start_class, &accum);
3162                     if (min1) {
3163                         cl_and(data->start_class, and_withp);
3164                         flags &= ~SCF_DO_STCLASS;
3165                     }
3166                 }
3167                 else if (flags & SCF_DO_STCLASS_AND) {
3168                     if (min1) {
3169                         cl_and(data->start_class, &accum);
3170                         flags &= ~SCF_DO_STCLASS;
3171                     }
3172                     else {
3173                         /* Switch to OR mode: cache the old value of
3174                          * data->start_class */
3175                         INIT_AND_WITHP;
3176                         StructCopy(data->start_class, and_withp,
3177                                    struct regnode_charclass_class);
3178                         flags &= ~SCF_DO_STCLASS_AND;
3179                         StructCopy(&accum, data->start_class,
3180                                    struct regnode_charclass_class);
3181                         flags |= SCF_DO_STCLASS_OR;
3182                         SET_SSC_EOS(data->start_class);
3183                     }
3184                 }
3185
3186                 if (PERL_ENABLE_TRIE_OPTIMISATION && OP( startbranch ) == BRANCH ) {
3187                 /* demq.
3188
3189                    Assuming this was/is a branch we are dealing with: 'scan' now
3190                    points at the item that follows the branch sequence, whatever
3191                    it is. We now start at the beginning of the sequence and look
3192                    for subsequences of
3193
3194                    BRANCH->EXACT=>x1
3195                    BRANCH->EXACT=>x2
3196                    tail
3197
3198                    which would be constructed from a pattern like /A|LIST|OF|WORDS/
3199
3200                    If we can find such a subsequence we need to turn the first
3201                    element into a trie and then add the subsequent branch exact
3202                    strings to the trie.
3203
3204                    We have two cases
3205
3206                      1. patterns where the whole set of branches can be converted. 
3207
3208                      2. patterns where only a subset can be converted.
3209
3210                    In case 1 we can replace the whole set with a single regop
3211                    for the trie. In case 2 we need to keep the start and end
3212                    branches so
3213
3214                      'BRANCH EXACT; BRANCH EXACT; BRANCH X'
3215                      becomes BRANCH TRIE; BRANCH X;
3216
3217                   There is an additional case, that being where there is a 
3218                   common prefix, which gets split out into an EXACT like node
3219                   preceding the TRIE node.
3220
3221                   If x(1..n)==tail then we can do a simple trie, if not we make
3222                   a "jump" trie, such that when we match the appropriate word
3223                   we "jump" to the appropriate tail node. Essentially we turn
3224                   a nested if into a case structure of sorts.
3225
3226                 */
3227
3228                     int made=0;
3229                     if (!re_trie_maxbuff) {
3230                         re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
3231                         if (!SvIOK(re_trie_maxbuff))
3232                             sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
3233                     }
3234                     if ( SvIV(re_trie_maxbuff)>=0  ) {
3235                         regnode *cur;
3236                         regnode *first = (regnode *)NULL;
3237                         regnode *last = (regnode *)NULL;
3238                         regnode *tail = scan;
3239                         U8 trietype = 0;
3240                         U32 count=0;
3241
3242 #ifdef DEBUGGING
3243                         SV * const mysv = sv_newmortal();       /* for dumping */
3244 #endif
3245                         /* var tail is used because there may be a TAIL
3246                            regop in the way. Ie, the exacts will point to the
3247                            thing following the TAIL, but the last branch will
3248                            point at the TAIL. So we advance tail. If we
3249                            have nested (?:) we may have to move through several
3250                            tails.
3251                          */
3252
3253                         while ( OP( tail ) == TAIL ) {
3254                             /* this is the TAIL generated by (?:) */
3255                             tail = regnext( tail );
3256                         }
3257
3258                         
3259                         DEBUG_TRIE_COMPILE_r({
3260                             regprop(RExC_rx, mysv, tail );
3261                             PerlIO_printf( Perl_debug_log, "%*s%s%s\n",
3262                                 (int)depth * 2 + 2, "", 
3263                                 "Looking for TRIE'able sequences. Tail node is: ", 
3264                                 SvPV_nolen_const( mysv )
3265                             );
3266                         });
3267                         
3268                         /*
3269
3270                             Step through the branches
3271                                 cur represents each branch,
3272                                 noper is the first thing to be matched as part of that branch
3273                                 noper_next is the regnext() of that node.
3274
3275                             We normally handle a case like this /FOO[xyz]|BAR[pqr]/
3276                             via a "jump trie" but we also support building with NOJUMPTRIE,
3277                             which restricts the trie logic to structures like /FOO|BAR/.
3278
3279                             If noper is a trieable nodetype then the branch is a possible optimization
3280                             target. If we are building under NOJUMPTRIE then we require that noper_next
3281                             is the same as scan (our current position in the regex program).
3282
3283                             Once we have two or more consecutive such branches we can create a
3284                             trie of the EXACT's contents and stitch it in place into the program.
3285
3286                             If the sequence represents all of the branches in the alternation we
3287                             replace the entire thing with a single TRIE node.
3288
3289                             Otherwise when it is a subsequence we need to stitch it in place and
3290                             replace only the relevant branches. This means the first branch has
3291                             to remain as it is used by the alternation logic, and its next pointer,
3292                             and needs to be repointed at the item on the branch chain following
3293                             the last branch we have optimized away.
3294
3295                             This could be either a BRANCH, in which case the subsequence is internal,
3296                             or it could be the item following the branch sequence in which case the
3297                             subsequence is at the end (which does not necessarily mean the first node
3298                             is the start of the alternation).
3299
3300                             TRIE_TYPE(X) is a define which maps the optype to a trietype.
3301
3302                                 optype          |  trietype
3303                                 ----------------+-----------
3304                                 NOTHING         | NOTHING
3305                                 EXACT           | EXACT
3306                                 EXACTFU         | EXACTFU
3307                                 EXACTFU_SS      | EXACTFU
3308                                 EXACTFU_TRICKYFOLD | EXACTFU
3309                                 EXACTFA         | 0
3310
3311
3312                         */
3313 #define TRIE_TYPE(X) ( ( NOTHING == (X) ) ? NOTHING :   \
3314                        ( EXACT == (X) )   ? EXACT :        \
3315                        ( EXACTFU == (X) || EXACTFU_SS == (X) || EXACTFU_TRICKYFOLD == (X) ) ? EXACTFU :        \
3316                        0 )
3317
3318                         /* dont use tail as the end marker for this traverse */
3319                         for ( cur = startbranch ; cur != scan ; cur = regnext( cur ) ) {
3320                             regnode * const noper = NEXTOPER( cur );
3321                             U8 noper_type = OP( noper );
3322                             U8 noper_trietype = TRIE_TYPE( noper_type );
3323 #if defined(DEBUGGING) || defined(NOJUMPTRIE)
3324                             regnode * const noper_next = regnext( noper );
3325                             U8 noper_next_type = (noper_next && noper_next != tail) ? OP(noper_next) : 0;
3326                             U8 noper_next_trietype = (noper_next && noper_next != tail) ? TRIE_TYPE( noper_next_type ) :0;
3327 #endif
3328
3329                             DEBUG_TRIE_COMPILE_r({
3330                                 regprop(RExC_rx, mysv, cur);
3331                                 PerlIO_printf( Perl_debug_log, "%*s- %s (%d)",
3332                                    (int)depth * 2 + 2,"", SvPV_nolen_const( mysv ), REG_NODE_NUM(cur) );
3333
3334                                 regprop(RExC_rx, mysv, noper);
3335                                 PerlIO_printf( Perl_debug_log, " -> %s",
3336                                     SvPV_nolen_const(mysv));
3337
3338                                 if ( noper_next ) {
3339                                   regprop(RExC_rx, mysv, noper_next );
3340                                   PerlIO_printf( Perl_debug_log,"\t=> %s\t",
3341                                     SvPV_nolen_const(mysv));
3342                                 }
3343                                 PerlIO_printf( Perl_debug_log, "(First==%d,Last==%d,Cur==%d,tt==%s,nt==%s,nnt==%s)\n",
3344                                    REG_NODE_NUM(first), REG_NODE_NUM(last), REG_NODE_NUM(cur),
3345                                    PL_reg_name[trietype], PL_reg_name[noper_trietype], PL_reg_name[noper_next_trietype] 
3346                                 );
3347                             });
3348
3349                             /* Is noper a trieable nodetype that can be merged with the
3350                              * current trie (if there is one)? */
3351                             if ( noper_trietype
3352                                   &&
3353                                   (
3354                                         ( noper_trietype == NOTHING)
3355                                         || ( trietype == NOTHING )
3356                                         || ( trietype == noper_trietype )
3357                                   )
3358 #ifdef NOJUMPTRIE
3359                                   && noper_next == tail
3360 #endif
3361                                   && count < U16_MAX)
3362                             {
3363                                 /* Handle mergable triable node
3364                                  * Either we are the first node in a new trieable sequence,
3365                                  * in which case we do some bookkeeping, otherwise we update
3366                                  * the end pointer. */
3367                                 if ( !first ) {
3368                                     first = cur;
3369                                     if ( noper_trietype == NOTHING ) {
3370 #if !defined(DEBUGGING) && !defined(NOJUMPTRIE)
3371                                         regnode * const noper_next = regnext( noper );
3372                                         U8 noper_next_type = (noper_next && noper_next!=tail) ? OP(noper_next) : 0;
3373                                         U8 noper_next_trietype = noper_next_type ? TRIE_TYPE( noper_next_type ) :0;
3374 #endif
3375
3376                                         if ( noper_next_trietype ) {
3377                                             trietype = noper_next_trietype;
3378                                         } else if (noper_next_type)  {
3379                                             /* a NOTHING regop is 1 regop wide. We need at least two
3380                                              * for a trie so we can't merge this in */
3381                                             first = NULL;
3382                                         }
3383                                     } else {
3384                                         trietype = noper_trietype;
3385                                     }
3386                                 } else {
3387                                     if ( trietype == NOTHING )
3388                                         trietype = noper_trietype;
3389                                     last = cur;
3390                                 }
3391                                 if (first)
3392                                     count++;
3393                             } /* end handle mergable triable node */
3394                             else {
3395                                 /* handle unmergable node -
3396                                  * noper may either be a triable node which can not be tried
3397                                  * together with the current trie, or a non triable node */
3398                                 if ( last ) {
3399                                     /* If last is set and trietype is not NOTHING then we have found
3400                                      * at least two triable branch sequences in a row of a similar
3401                                      * trietype so we can turn them into a trie. If/when we
3402                                      * allow NOTHING to start a trie sequence this condition will be
3403                                      * required, and it isn't expensive so we leave it in for now. */
3404                                     if ( trietype && trietype != NOTHING )
3405                                         make_trie( pRExC_state,
3406                                                 startbranch, first, cur, tail, count,
3407                                                 trietype, depth+1 );
3408                                     last = NULL; /* note: we clear/update first, trietype etc below, so we dont do it here */
3409                                 }
3410                                 if ( noper_trietype
3411 #ifdef NOJUMPTRIE
3412                                      && noper_next == tail
3413 #endif
3414                                 ){
3415                                     /* noper is triable, so we can start a new trie sequence */
3416                                     count = 1;
3417                                     first = cur;
3418                                     trietype = noper_trietype;
3419                                 } else if (first) {
3420                                     /* if we already saw a first but the current node is not triable then we have
3421                                      * to reset the first information. */
3422                                     count = 0;
3423                                     first = NULL;
3424                                     trietype = 0;
3425                                 }
3426                             } /* end handle unmergable node */
3427                         } /* loop over branches */
3428                         DEBUG_TRIE_COMPILE_r({
3429                             regprop(RExC_rx, mysv, cur);
3430                             PerlIO_printf( Perl_debug_log,
3431                               "%*s- %s (%d) <SCAN FINISHED>\n", (int)depth * 2 + 2,
3432                               "", SvPV_nolen_const( mysv ),REG_NODE_NUM(cur));
3433
3434                         });
3435                         if ( last && trietype ) {
3436                             if ( trietype != NOTHING ) {
3437                                 /* the last branch of the sequence was part of a trie,
3438                                  * so we have to construct it here outside of the loop
3439                                  */
3440                                 made= make_trie( pRExC_state, startbranch, first, scan, tail, count, trietype, depth+1 );
3441 #ifdef TRIE_STUDY_OPT
3442                                 if ( ((made == MADE_EXACT_TRIE &&
3443                                      startbranch == first)
3444                                      || ( first_non_open == first )) &&
3445                                      depth==0 ) {
3446                                     flags |= SCF_TRIE_RESTUDY;
3447                                     if ( startbranch == first
3448                                          && scan == tail )
3449                                     {
3450                                         RExC_seen &=~REG_TOP_LEVEL_BRANCHES;
3451                                     }
3452                                 }
3453 #endif
3454                             } else {
3455                                 /* at this point we know whatever we have is a NOTHING sequence/branch
3456                                  * AND if 'startbranch' is 'first' then we can turn the whole thing into a NOTHING
3457                                  */
3458                                 if ( startbranch == first ) {
3459                                     regnode *opt;
3460                                     /* the entire thing is a NOTHING sequence, something like this:
3461                                      * (?:|) So we can turn it into a plain NOTHING op. */
3462                                     DEBUG_TRIE_COMPILE_r({
3463                                         regprop(RExC_rx, mysv, cur);
3464                                         PerlIO_printf( Perl_debug_log,
3465                                           "%*s- %s (%d) <NOTHING BRANCH SEQUENCE>\n", (int)depth * 2 + 2,
3466                                           "", SvPV_nolen_const( mysv ),REG_NODE_NUM(cur));
3467
3468                                     });
3469                                     OP(startbranch)= NOTHING;
3470                                     NEXT_OFF(startbranch)= tail - startbranch;
3471                                     for ( opt= startbranch + 1; opt < tail ; opt++ )
3472                                         OP(opt)= OPTIMIZED;
3473                                 }
3474                             }
3475                         } /* end if ( last) */
3476                     } /* TRIE_MAXBUF is non zero */
3477                     
3478                 } /* do trie */
3479                 
3480             }
3481             else if ( code == BRANCHJ ) {  /* single branch is optimized. */
3482                 scan = NEXTOPER(NEXTOPER(scan));
3483             } else                      /* single branch is optimized. */
3484                 scan = NEXTOPER(scan);
3485             continue;
3486         } else if (OP(scan) == SUSPEND || OP(scan) == GOSUB || OP(scan) == GOSTART) {
3487             scan_frame *newframe = NULL;
3488             I32 paren;
3489             regnode *start;
3490             regnode *end;
3491
3492             if (OP(scan) != SUSPEND) {
3493             /* set the pointer */
3494                 if (OP(scan) == GOSUB) {
3495                     paren = ARG(scan);
3496                     RExC_recurse[ARG2L(scan)] = scan;
3497                     start = RExC_open_parens[paren-1];
3498                     end   = RExC_close_parens[paren-1];
3499                 } else {
3500                     paren = 0;
3501                     start = RExC_rxi->program + 1;
3502                     end   = RExC_opend;
3503                 }
3504                 if (!recursed) {
3505                     Newxz(recursed, (((RExC_npar)>>3) +1), U8);
3506                     SAVEFREEPV(recursed);
3507                 }
3508                 if (!PAREN_TEST(recursed,paren+1)) {
3509                     PAREN_SET(recursed,paren+1);
3510                     Newx(newframe,1,scan_frame);
3511                 } else {
3512                     if (flags & SCF_DO_SUBSTR) {
3513                         SCAN_COMMIT(pRExC_state,data,minlenp);
3514                         data->longest = &(data->longest_float);
3515                     }
3516                     is_inf = is_inf_internal = 1;
3517                     if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
3518                         cl_anything(pRExC_state, data->start_class);
3519                     flags &= ~SCF_DO_STCLASS;
3520                 }
3521             } else {
3522                 Newx(newframe,1,scan_frame);
3523                 paren = stopparen;
3524                 start = scan+2;
3525                 end = regnext(scan);
3526             }
3527             if (newframe) {
3528                 assert(start);
3529                 assert(end);
3530                 SAVEFREEPV(newframe);
3531                 newframe->next = regnext(scan);
3532                 newframe->last = last;
3533                 newframe->stop = stopparen;
3534                 newframe->prev = frame;
3535
3536                 frame = newframe;
3537                 scan =  start;
3538                 stopparen = paren;
3539                 last = end;
3540
3541                 continue;
3542             }
3543         }
3544         else if (OP(scan) == EXACT) {
3545             I32 l = STR_LEN(scan);
3546             UV uc;
3547             if (UTF) {
3548                 const U8 * const s = (U8*)STRING(scan);
3549                 uc = utf8_to_uvchr_buf(s, s + l, NULL);
3550                 l = utf8_length(s, s + l);
3551             } else {
3552                 uc = *((U8*)STRING(scan));
3553             }
3554             min += l;
3555             if (flags & SCF_DO_SUBSTR) { /* Update longest substr. */
3556                 /* The code below prefers earlier match for fixed
3557                    offset, later match for variable offset.  */
3558                 if (data->last_end == -1) { /* Update the start info. */
3559                     data->last_start_min = data->pos_min;
3560                     data->last_start_max = is_inf
3561                         ? I32_MAX : data->pos_min + data->pos_delta;
3562                 }
3563                 sv_catpvn(data->last_found, STRING(scan), STR_LEN(scan));
3564                 if (UTF)
3565                     SvUTF8_on(data->last_found);
3566                 {
3567                     SV * const sv = data->last_found;
3568                     MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
3569                         mg_find(sv, PERL_MAGIC_utf8) : NULL;
3570                     if (mg && mg->mg_len >= 0)
3571                         mg->mg_len += utf8_length((U8*)STRING(scan),
3572                                                   (U8*)STRING(scan)+STR_LEN(scan));
3573                 }
3574                 data->last_end = data->pos_min + l;
3575                 data->pos_min += l; /* As in the first entry. */
3576                 data->flags &= ~SF_BEFORE_EOL;
3577             }
3578             if (flags & SCF_DO_STCLASS_AND) {
3579                 /* Check whether it is compatible with what we know already! */
3580                 int compat = 1;
3581
3582
3583                 /* If compatible, we or it in below.  It is compatible if is
3584                  * in the bitmp and either 1) its bit or its fold is set, or 2)
3585                  * it's for a locale.  Even if there isn't unicode semantics
3586                  * here, at runtime there may be because of matching against a
3587                  * utf8 string, so accept a possible false positive for
3588                  * latin1-range folds */
3589                 if (uc >= 0x100 ||
3590                     (!(data->start_class->flags & ANYOF_LOCALE)
3591                     && !ANYOF_BITMAP_TEST(data->start_class, uc)
3592                     && (!(data->start_class->flags & ANYOF_LOC_FOLD)
3593                         || !ANYOF_BITMAP_TEST(data->start_class, PL_fold_latin1[uc])))
3594                     )
3595                 {
3596                     compat = 0;
3597                 }
3598                 ANYOF_CLASS_ZERO(data->start_class);
3599                 ANYOF_BITMAP_ZERO(data->start_class);
3600                 if (compat)
3601                     ANYOF_BITMAP_SET(data->start_class, uc);
3602                 else if (uc >= 0x100) {
3603                     int i;
3604
3605                     /* Some Unicode code points fold to the Latin1 range; as
3606                      * XXX temporary code, instead of figuring out if this is
3607                      * one, just assume it is and set all the start class bits
3608                      * that could be some such above 255 code point's fold
3609                      * which will generate fals positives.  As the code
3610                      * elsewhere that does compute the fold settles down, it
3611                      * can be extracted out and re-used here */
3612                     for (i = 0; i < 256; i++){
3613                         if (HAS_NONLATIN1_FOLD_CLOSURE(i)) {
3614                             ANYOF_BITMAP_SET(data->start_class, i);
3615                         }
3616                     }
3617                 }
3618                 CLEAR_SSC_EOS(data->start_class);
3619                 if (uc < 0x100)
3620                   data->start_class->flags &= ~ANYOF_UNICODE_ALL;
3621             }
3622             else if (flags & SCF_DO_STCLASS_OR) {
3623                 /* false positive possible if the class is case-folded */
3624                 if (uc < 0x100)
3625                     ANYOF_BITMAP_SET(data->start_class, uc);
3626                 else
3627                     data->start_class->flags |= ANYOF_UNICODE_ALL;
3628                 CLEAR_SSC_EOS(data->start_class);
3629                 cl_and(data->start_class, and_withp);
3630             }
3631             flags &= ~SCF_DO_STCLASS;
3632         }
3633         else if (PL_regkind[OP(scan)] == EXACT) { /* But OP != EXACT! */
3634             I32 l = STR_LEN(scan);
3635             UV uc = *((U8*)STRING(scan));
3636
3637             /* Search for fixed substrings supports EXACT only. */
3638             if (flags & SCF_DO_SUBSTR) {
3639                 assert(data);
3640                 SCAN_COMMIT(pRExC_state, data, minlenp);
3641             }
3642             if (UTF) {
3643                 const U8 * const s = (U8 *)STRING(scan);
3644                 uc = utf8_to_uvchr_buf(s, s + l, NULL);
3645                 l = utf8_length(s, s + l);
3646             }
3647             if (has_exactf_sharp_s) {
3648                 RExC_seen |= REG_SEEN_EXACTF_SHARP_S;
3649             }
3650             min += l - min_subtract;
3651             assert (min >= 0);
3652             delta += min_subtract;
3653             if (flags & SCF_DO_SUBSTR) {
3654                 data->pos_min += l - min_subtract;
3655                 if (data->pos_min < 0) {
3656                     data->pos_min = 0;
3657                 }
3658                 data->pos_delta += min_subtract;
3659                 if (min_subtract) {
3660                     data->longest = &(data->longest_float);
3661                 }
3662             }
3663             if (flags & SCF_DO_STCLASS_AND) {
3664                 /* Check whether it is compatible with what we know already! */
3665                 int compat = 1;
3666                 if (uc >= 0x100 ||
3667                  (!(data->start_class->flags & ANYOF_LOCALE)
3668                   && !ANYOF_BITMAP_TEST(data->start_class, uc)
3669                   && !ANYOF_BITMAP_TEST(data->start_class, PL_fold_latin1[uc])))
3670                 {
3671                     compat = 0;
3672                 }
3673                 ANYOF_CLASS_ZERO(data->start_class);
3674                 ANYOF_BITMAP_ZERO(data->start_class);
3675                 if (compat) {
3676                     ANYOF_BITMAP_SET(data->start_class, uc);
3677                     CLEAR_SSC_EOS(data->start_class);
3678                     if (OP(scan) == EXACTFL) {
3679                         /* XXX This set is probably no longer necessary, and
3680                          * probably wrong as LOCALE now is on in the initial
3681                          * state */
3682                         data->start_class->flags |= ANYOF_LOCALE|ANYOF_LOC_FOLD;
3683                     }
3684                     else {
3685
3686                         /* Also set the other member of the fold pair.  In case
3687                          * that unicode semantics is called for at runtime, use
3688                          * the full latin1 fold.  (Can't do this for locale,
3689                          * because not known until runtime) */
3690                         ANYOF_BITMAP_SET(data->start_class, PL_fold_latin1[uc]);
3691
3692                         /* All other (EXACTFL handled above) folds except under
3693                          * /iaa that include s, S, and sharp_s also may include
3694                          * the others */
3695                         if (OP(scan) != EXACTFA) {
3696                             if (uc == 's' || uc == 'S') {
3697                                 ANYOF_BITMAP_SET(data->start_class,
3698                                                  LATIN_SMALL_LETTER_SHARP_S);
3699                             }
3700                             else if (uc == LATIN_SMALL_LETTER_SHARP_S) {
3701                                 ANYOF_BITMAP_SET(data->start_class, 's');
3702                                 ANYOF_BITMAP_SET(data->start_class, 'S');
3703                             }
3704                         }
3705                     }
3706                 }
3707                 else if (uc >= 0x100) {
3708                     int i;
3709                     for (i = 0; i < 256; i++){
3710                         if (_HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(i)) {
3711                             ANYOF_BITMAP_SET(data->start_class, i);
3712                         }
3713                     }
3714                 }
3715             }
3716             else if (flags & SCF_DO_STCLASS_OR) {
3717                 if (data->start_class->flags & ANYOF_LOC_FOLD) {
3718                     /* false positive possible if the class is case-folded.
3719                        Assume that the locale settings are the same... */
3720                     if (uc < 0x100) {
3721                         ANYOF_BITMAP_SET(data->start_class, uc);
3722                         if (OP(scan) != EXACTFL) {
3723
3724                             /* And set the other member of the fold pair, but
3725                              * can't do that in locale because not known until
3726                              * run-time */
3727                             ANYOF_BITMAP_SET(data->start_class,
3728                                              PL_fold_latin1[uc]);
3729
3730                             /* All folds except under /iaa that include s, S,
3731                              * and sharp_s also may include the others */
3732                             if (OP(scan) != EXACTFA) {
3733                                 if (uc == 's' || uc == 'S') {
3734                                     ANYOF_BITMAP_SET(data->start_class,
3735                                                    LATIN_SMALL_LETTER_SHARP_S);
3736                                 }
3737                                 else if (uc == LATIN_SMALL_LETTER_SHARP_S) {
3738                                     ANYOF_BITMAP_SET(data->start_class, 's');
3739                                     ANYOF_BITMAP_SET(data->start_class, 'S');
3740                                 }
3741                             }
3742                         }
3743                     }
3744                     CLEAR_SSC_EOS(data->start_class);
3745                 }
3746                 cl_and(data->start_class, and_withp);
3747             }
3748             flags &= ~SCF_DO_STCLASS;
3749         }
3750         else if (REGNODE_VARIES(OP(scan))) {
3751             I32 mincount, maxcount, minnext, deltanext, fl = 0;
3752             I32 f = flags, pos_before = 0;
3753             regnode * const oscan = scan;
3754             struct regnode_charclass_class this_class;
3755             struct regnode_charclass_class *oclass = NULL;
3756             I32 next_is_eval = 0;
3757
3758             switch (PL_regkind[OP(scan)]) {
3759             case WHILEM:                /* End of (?:...)* . */
3760                 scan = NEXTOPER(scan);
3761                 goto finish;
3762             case PLUS:
3763                 if (flags & (SCF_DO_SUBSTR | SCF_DO_STCLASS)) {
3764                     next = NEXTOPER(scan);
3765                     if (OP(next) == EXACT || (flags & SCF_DO_STCLASS)) {
3766                         mincount = 1;
3767                         maxcount = REG_INFTY;
3768                         next = regnext(scan);
3769                         scan = NEXTOPER(scan);
3770                         goto do_curly;
3771                     }
3772                 }
3773                 if (flags & SCF_DO_SUBSTR)
3774                     data->pos_min++;
3775                 min++;
3776                 /* Fall through. */
3777             case STAR:
3778                 if (flags & SCF_DO_STCLASS) {
3779                     mincount = 0;
3780                     maxcount = REG_INFTY;
3781                     next = regnext(scan);
3782                     scan = NEXTOPER(scan);
3783                     goto do_curly;
3784                 }
3785                 is_inf = is_inf_internal = 1;
3786                 scan = regnext(scan);
3787                 if (flags & SCF_DO_SUBSTR) {
3788                     SCAN_COMMIT(pRExC_state, data, minlenp); /* Cannot extend fixed substrings */
3789                     data->longest = &(data->longest_float);
3790                 }
3791                 goto optimize_curly_tail;
3792             case CURLY:
3793                 if (stopparen>0 && (OP(scan)==CURLYN || OP(scan)==CURLYM)
3794                     && (scan->flags == stopparen))
3795                 {
3796                     mincount = 1;
3797                     maxcount = 1;
3798                 } else {
3799                     mincount = ARG1(scan);
3800                     maxcount = ARG2(scan);
3801                 }
3802                 next = regnext(scan);
3803                 if (OP(scan) == CURLYX) {
3804                     I32 lp = (data ? *(data->last_closep) : 0);
3805                     scan->flags = ((lp <= (I32)U8_MAX) ? (U8)lp : U8_MAX);
3806                 }
3807                 scan = NEXTOPER(scan) + EXTRA_STEP_2ARGS;
3808                 next_is_eval = (OP(scan) == EVAL);
3809               do_curly:
3810                 if (flags & SCF_DO_SUBSTR) {
3811                     if (mincount == 0) SCAN_COMMIT(pRExC_state,data,minlenp); /* Cannot extend fixed substrings */
3812                     pos_before = data->pos_min;
3813                 }
3814                 if (data) {
3815                     fl = data->flags;
3816                     data->flags &= ~(SF_HAS_PAR|SF_IN_PAR|SF_HAS_EVAL);
3817                     if (is_inf)
3818                         data->flags |= SF_IS_INF;
3819                 }
3820                 if (flags & SCF_DO_STCLASS) {
3821                     cl_init(pRExC_state, &this_class);
3822                     oclass = data->start_class;
3823                     data->start_class = &this_class;
3824                     f |= SCF_DO_STCLASS_AND;
3825                     f &= ~SCF_DO_STCLASS_OR;
3826                 }
3827                 /* Exclude from super-linear cache processing any {n,m}
3828                    regops for which the combination of input pos and regex
3829                    pos is not enough information to determine if a match
3830                    will be possible.
3831
3832                    For example, in the regex /foo(bar\s*){4,8}baz/ with the
3833                    regex pos at the \s*, the prospects for a match depend not
3834                    only on the input position but also on how many (bar\s*)
3835                    repeats into the {4,8} we are. */
3836                if ((mincount > 1) || (maxcount > 1 && maxcount != REG_INFTY))
3837                     f &= ~SCF_WHILEM_VISITED_POS;
3838
3839                 /* This will finish on WHILEM, setting scan, or on NULL: */
3840                 minnext = study_chunk(pRExC_state, &scan, minlenp, &deltanext, 
3841                                       last, data, stopparen, recursed, NULL,
3842                                       (mincount == 0
3843                                         ? (f & ~SCF_DO_SUBSTR) : f),depth+1);
3844
3845                 if (flags & SCF_DO_STCLASS)
3846                     data->start_class = oclass;
3847                 if (mincount == 0 || minnext == 0) {
3848                     if (flags & SCF_DO_STCLASS_OR) {
3849                         cl_or(pRExC_state, data->start_class, &this_class);
3850                     }
3851                     else if (flags & SCF_DO_STCLASS_AND) {
3852                         /* Switch to OR mode: cache the old value of
3853                          * data->start_class */
3854                         INIT_AND_WITHP;
3855                         StructCopy(data->start_class, and_withp,
3856                                    struct regnode_charclass_class);
3857                         flags &= ~SCF_DO_STCLASS_AND;
3858                         StructCopy(&this_class, data->start_class,
3859                                    struct regnode_charclass_class);
3860                         flags |= SCF_DO_STCLASS_OR;
3861                         SET_SSC_EOS(data->start_class);
3862                     }
3863                 } else {                /* Non-zero len */
3864                     if (flags & SCF_DO_STCLASS_OR) {
3865                         cl_or(pRExC_state, data->start_class, &this_class);
3866                         cl_and(data->start_class, and_withp);
3867                     }
3868                     else if (flags & SCF_DO_STCLASS_AND)
3869                         cl_and(data->start_class, &this_class);
3870                     flags &= ~SCF_DO_STCLASS;
3871                 }
3872                 if (!scan)              /* It was not CURLYX, but CURLY. */
3873                     scan = next;
3874                 if ( /* ? quantifier ok, except for (?{ ... }) */
3875                     (next_is_eval || !(mincount == 0 && maxcount == 1))
3876                     && (minnext == 0) && (deltanext == 0)
3877                     && data && !(data->flags & (SF_HAS_PAR|SF_IN_PAR))
3878                     && maxcount <= REG_INFTY/3) /* Complement check for big count */
3879                 {
3880                     /* Fatal warnings may leak the regexp without this: */
3881                     SAVEFREESV(RExC_rx_sv);
3882                     ckWARNreg(RExC_parse,
3883                               "Quantifier unexpected on zero-length expression");
3884                     (void)ReREFCNT_inc(RExC_rx_sv);
3885                 }
3886
3887                 min += minnext * mincount;
3888                 is_inf_internal |= ((maxcount == REG_INFTY
3889                                      && (minnext + deltanext) > 0)
3890                                     || deltanext == I32_MAX);
3891                 is_inf |= is_inf_internal;
3892                 delta += (minnext + deltanext) * maxcount - minnext * mincount;
3893
3894                 /* Try powerful optimization CURLYX => CURLYN. */
3895                 if (  OP(oscan) == CURLYX && data
3896                       && data->flags & SF_IN_PAR
3897                       && !(data->flags & SF_HAS_EVAL)
3898                       && !deltanext && minnext == 1 ) {
3899                     /* Try to optimize to CURLYN.  */
3900                     regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS;
3901                     regnode * const nxt1 = nxt;
3902 #ifdef DEBUGGING
3903                     regnode *nxt2;
3904 #endif
3905
3906                     /* Skip open. */
3907                     nxt = regnext(nxt);
3908                     if (!REGNODE_SIMPLE(OP(nxt))
3909                         && !(PL_regkind[OP(nxt)] == EXACT
3910                              && STR_LEN(nxt) == 1))
3911                         goto nogo;
3912 #ifdef DEBUGGING
3913                     nxt2 = nxt;
3914 #endif
3915                     nxt = regnext(nxt);
3916                     if (OP(nxt) != CLOSE)
3917                         goto nogo;
3918                     if (RExC_open_parens) {
3919                         RExC_open_parens[ARG(nxt1)-1]=oscan; /*open->CURLYM*/
3920                         RExC_close_parens[ARG(nxt1)-1]=nxt+2; /*close->while*/
3921                     }
3922                     /* Now we know that nxt2 is the only contents: */
3923                     oscan->flags = (U8)ARG(nxt);
3924                     OP(oscan) = CURLYN;
3925                     OP(nxt1) = NOTHING; /* was OPEN. */
3926
3927 #ifdef DEBUGGING
3928                     OP(nxt1 + 1) = OPTIMIZED; /* was count. */
3929                     NEXT_OFF(nxt1+ 1) = 0; /* just for consistency. */
3930                     NEXT_OFF(nxt2) = 0; /* just for consistency with CURLY. */
3931                     OP(nxt) = OPTIMIZED;        /* was CLOSE. */
3932                     OP(nxt + 1) = OPTIMIZED; /* was count. */
3933                     NEXT_OFF(nxt+ 1) = 0; /* just for consistency. */
3934 #endif
3935                 }
3936               nogo:
3937
3938                 /* Try optimization CURLYX => CURLYM. */
3939                 if (  OP(oscan) == CURLYX && data
3940                       && !(data->flags & SF_HAS_PAR)
3941                       && !(data->flags & SF_HAS_EVAL)
3942                       && !deltanext     /* atom is fixed width */
3943                       && minnext != 0   /* CURLYM can't handle zero width */
3944                       && ! (RExC_seen & REG_SEEN_EXACTF_SHARP_S) /* Nor \xDF */
3945                 ) {
3946                     /* XXXX How to optimize if data == 0? */
3947                     /* Optimize to a simpler form.  */
3948                     regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN */
3949                     regnode *nxt2;
3950
3951                     OP(oscan) = CURLYM;
3952                     while ( (nxt2 = regnext(nxt)) /* skip over embedded stuff*/
3953                             && (OP(nxt2) != WHILEM))
3954                         nxt = nxt2;
3955                     OP(nxt2)  = SUCCEED; /* Whas WHILEM */
3956                     /* Need to optimize away parenths. */
3957                     if ((data->flags & SF_IN_PAR) && OP(nxt) == CLOSE) {
3958                         /* Set the parenth number.  */
3959                         regnode *nxt1 = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN*/
3960
3961                         oscan->flags = (U8)ARG(nxt);
3962                         if (RExC_open_parens) {
3963                             RExC_open_parens[ARG(nxt1)-1]=oscan; /*open->CURLYM*/
3964                             RExC_close_parens[ARG(nxt1)-1]=nxt2+1; /*close->NOTHING*/
3965                         }
3966                         OP(nxt1) = OPTIMIZED;   /* was OPEN. */
3967                         OP(nxt) = OPTIMIZED;    /* was CLOSE. */
3968
3969 #ifdef DEBUGGING
3970                         OP(nxt1 + 1) = OPTIMIZED; /* was count. */
3971                         OP(nxt + 1) = OPTIMIZED; /* was count. */
3972                         NEXT_OFF(nxt1 + 1) = 0; /* just for consistency. */
3973                         NEXT_OFF(nxt + 1) = 0; /* just for consistency. */
3974 #endif
3975 #if 0
3976                         while ( nxt1 && (OP(nxt1) != WHILEM)) {
3977                             regnode *nnxt = regnext(nxt1);
3978                             if (nnxt == nxt) {
3979                                 if (reg_off_by_arg[OP(nxt1)])
3980                                     ARG_SET(nxt1, nxt2 - nxt1);
3981                                 else if (nxt2 - nxt1 < U16_MAX)
3982                                     NEXT_OFF(nxt1) = nxt2 - nxt1;
3983                                 else
3984                                     OP(nxt) = NOTHING;  /* Cannot beautify */
3985                             }
3986                             nxt1 = nnxt;
3987                         }
3988 #endif
3989                         /* Optimize again: */
3990                         study_chunk(pRExC_state, &nxt1, minlenp, &deltanext, nxt,
3991                                     NULL, stopparen, recursed, NULL, 0,depth+1);
3992                     }
3993                     else
3994                         oscan->flags = 0;
3995                 }
3996                 else if ((OP(oscan) == CURLYX)
3997                          && (flags & SCF_WHILEM_VISITED_POS)
3998                          /* See the comment on a similar expression above.
3999                             However, this time it's not a subexpression
4000                             we care about, but the expression itself. */
4001                          && (maxcount == REG_INFTY)
4002                          && data && ++data->whilem_c < 16) {
4003                     /* This stays as CURLYX, we can put the count/of pair. */
4004                     /* Find WHILEM (as in regexec.c) */
4005                     regnode *nxt = oscan + NEXT_OFF(oscan);
4006
4007                     if (OP(PREVOPER(nxt)) == NOTHING) /* LONGJMP */
4008                         nxt += ARG(nxt);
4009                     PREVOPER(nxt)->flags = (U8)(data->whilem_c
4010                         | (RExC_whilem_seen << 4)); /* On WHILEM */
4011                 }
4012                 if (data && fl & (SF_HAS_PAR|SF_IN_PAR))
4013                     pars++;
4014                 if (flags & SCF_DO_SUBSTR) {
4015                     SV *last_str = NULL;
4016                     int counted = mincount != 0;
4017
4018                     if (data->last_end > 0 && mincount != 0) { /* Ends with a string. */
4019 #if defined(SPARC64_GCC_WORKAROUND)
4020                         I32 b = 0;
4021                         STRLEN l = 0;
4022                         const char *s = NULL;
4023                         I32 old = 0;
4024
4025                         if (pos_before >= data->last_start_min)
4026                             b = pos_before;
4027                         else
4028                             b = data->last_start_min;
4029
4030                         l = 0;
4031                         s = SvPV_const(data->last_found, l);
4032                         old = b - data->last_start_min;
4033
4034 #else
4035                         I32 b = pos_before >= data->last_start_min
4036                             ? pos_before : data->last_start_min;
4037                         STRLEN l;
4038                         const char * const s = SvPV_const(data->last_found, l);
4039                         I32 old = b - data->last_start_min;
4040 #endif
4041
4042                         if (UTF)
4043                             old = utf8_hop((U8*)s, old) - (U8*)s;
4044                         l -= old;
4045                         /* Get the added string: */
4046                         last_str = newSVpvn_utf8(s  + old, l, UTF);
4047                         if (deltanext == 0 && pos_before == b) {
4048                             /* What was added is a constant string */
4049                             if (mincount > 1) {
4050                                 SvGROW(last_str, (mincount * l) + 1);
4051                                 repeatcpy(SvPVX(last_str) + l,
4052                                           SvPVX_const(last_str), l, mincount - 1);
4053                                 SvCUR_set(last_str, SvCUR(last_str) * mincount);
4054                                 /* Add additional parts. */
4055                                 SvCUR_set(data->last_found,
4056                                           SvCUR(data->last_found) - l);
4057                                 sv_catsv(data->last_found, last_str);
4058                                 {
4059                                     SV * sv = data->last_found;
4060                                     MAGIC *mg =
4061                                         SvUTF8(sv) && SvMAGICAL(sv) ?
4062                                         mg_find(sv, PERL_MAGIC_utf8) : NULL;
4063                                     if (mg && mg->mg_len >= 0)
4064                                         mg->mg_len += CHR_SVLEN(last_str) - l;
4065                                 }
4066                                 data->last_end += l * (mincount - 1);
4067                             }
4068                         } else {
4069                             /* start offset must point into the last copy */
4070                             data->last_start_min += minnext * (mincount - 1);
4071                             data->last_start_max += is_inf ? I32_MAX
4072                                 : (maxcount - 1) * (minnext + data->pos_delta);
4073                         }
4074                     }
4075                     /* It is counted once already... */
4076                     data->pos_min += minnext * (mincount - counted);
4077                     data->pos_delta += - counted * deltanext +
4078                         (minnext + deltanext) * maxcount - minnext * mincount;
4079                     if (mincount != maxcount) {
4080                          /* Cannot extend fixed substrings found inside
4081                             the group.  */
4082                         SCAN_COMMIT(pRExC_state,data,minlenp);
4083                         if (mincount && last_str) {
4084                             SV * const sv = data->last_found;
4085                             MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
4086                                 mg_find(sv, PERL_MAGIC_utf8) : NULL;
4087
4088                             if (mg)
4089                                 mg->mg_len = -1;
4090                             sv_setsv(sv, last_str);
4091                             data->last_end = data->pos_min;
4092                             data->last_start_min =
4093                                 data->pos_min - CHR_SVLEN(last_str);
4094                             data->last_start_max = is_inf
4095                                 ? I32_MAX
4096                                 : data->pos_min + data->pos_delta
4097                                 - CHR_SVLEN(last_str);
4098                         }
4099                         data->longest = &(data->longest_float);
4100                     }
4101                     SvREFCNT_dec(last_str);
4102                 }
4103                 if (data && (fl & SF_HAS_EVAL))
4104                     data->flags |= SF_HAS_EVAL;
4105               optimize_curly_tail:
4106                 if (OP(oscan) != CURLYX) {
4107                     while (PL_regkind[OP(next = regnext(oscan))] == NOTHING
4108                            && NEXT_OFF(next))
4109                         NEXT_OFF(oscan) += NEXT_OFF(next);
4110                 }
4111                 continue;
4112             default:                    /* REF, ANYOFV, and CLUMP only? */
4113                 if (flags & SCF_DO_SUBSTR) {
4114                     SCAN_COMMIT(pRExC_state,data,minlenp);      /* Cannot expect anything... */
4115                     data->longest = &(data->longest_float);
4116                 }
4117                 is_inf = is_inf_internal = 1;
4118                 if (flags & SCF_DO_STCLASS_OR)
4119                     cl_anything(pRExC_state, data->start_class);
4120                 flags &= ~SCF_DO_STCLASS;
4121                 break;
4122             }
4123         }
4124         else if (OP(scan) == LNBREAK) {
4125             if (flags & SCF_DO_STCLASS) {
4126                 int value = 0;
4127                 CLEAR_SSC_EOS(data->start_class); /* No match on empty */
4128                 if (flags & SCF_DO_STCLASS_AND) {
4129                     for (value = 0; value < 256; value++)
4130                         if (!is_VERTWS_cp(value))
4131                             ANYOF_BITMAP_CLEAR(data->start_class, value);
4132                 }
4133                 else {
4134                     for (value = 0; value < 256; value++)
4135                         if (is_VERTWS_cp(value))
4136                             ANYOF_BITMAP_SET(data->start_class, value);
4137                 }
4138                 if (flags & SCF_DO_STCLASS_OR)
4139                     cl_and(data->start_class, and_withp);
4140                 flags &= ~SCF_DO_STCLASS;
4141             }
4142             min++;
4143             delta++;    /* Because of the 2 char string cr-lf */
4144             if (flags & SCF_DO_SUBSTR) {
4145                 SCAN_COMMIT(pRExC_state,data,minlenp);  /* Cannot expect anything... */
4146                 data->pos_min += 1;
4147                 data->pos_delta += 1;
4148                 data->longest = &(data->longest_float);
4149             }
4150         }
4151         else if (REGNODE_SIMPLE(OP(scan))) {
4152             int value = 0;
4153
4154             if (flags & SCF_DO_SUBSTR) {
4155                 SCAN_COMMIT(pRExC_state,data,minlenp);
4156                 data->pos_min++;
4157             }
4158             min++;
4159             if (flags & SCF_DO_STCLASS) {
4160                 int loop_max = 256;
4161                 CLEAR_SSC_EOS(data->start_class); /* No match on empty */
4162
4163                 /* Some of the logic below assumes that switching
4164                    locale on will only add false positives. */
4165                 switch (PL_regkind[OP(scan)]) {
4166                     U8 classnum;
4167
4168                 case SANY:
4169                 default:
4170 #ifdef DEBUGGING
4171                    Perl_croak(aTHX_ "panic: unexpected simple REx opcode %d", OP(scan));
4172 #endif
4173                  do_default:
4174                     if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
4175                         cl_anything(pRExC_state, data->start_class);
4176                     break;
4177                 case REG_ANY:
4178                     if (OP(scan) == SANY)
4179                         goto do_default;
4180                     if (flags & SCF_DO_STCLASS_OR) { /* Everything but \n */
4181                         value = (ANYOF_BITMAP_TEST(data->start_class,'\n')
4182                                 || ANYOF_CLASS_TEST_ANY_SET(data->start_class));
4183                         cl_anything(pRExC_state, data->start_class);
4184                     }
4185                     if (flags & SCF_DO_STCLASS_AND || !value)
4186                         ANYOF_BITMAP_CLEAR(data->start_class,'\n');
4187                     break;
4188                 case ANYOF:
4189                     if (flags & SCF_DO_STCLASS_AND)
4190                         cl_and(data->start_class,
4191                                (struct regnode_charclass_class*)scan);
4192                     else
4193                         cl_or(pRExC_state, data->start_class,
4194                               (struct regnode_charclass_class*)scan);
4195                     break;
4196                 case POSIXA:
4197                     loop_max = 128;
4198                     /* FALL THROUGH */
4199                 case POSIXL:
4200                 case POSIXD:
4201                 case POSIXU:
4202                     classnum = FLAGS(scan);
4203                     if (flags & SCF_DO_STCLASS_AND) {
4204                         if (!(data->start_class->flags & ANYOF_LOCALE)) {
4205                             ANYOF_CLASS_CLEAR(data->start_class, classnum_to_namedclass(classnum) + 1);
4206                             for (value = 0; value < loop_max; value++) {
4207                                 if (! _generic_isCC(UNI_TO_NATIVE(value), classnum)) {
4208                                     ANYOF_BITMAP_CLEAR(data->start_class, UNI_TO_NATIVE(value));
4209                                 }
4210                             }
4211                         }
4212                     }
4213                     else {
4214                         if (data->start_class->flags & ANYOF_LOCALE) {
4215                             ANYOF_CLASS_SET(data->start_class, classnum_to_namedclass(classnum));
4216                         }
4217                         else {
4218
4219                         /* Even if under locale, set the bits for non-locale
4220                          * in case it isn't a true locale-node.  This will
4221                          * create false positives if it truly is locale */
4222                         for (value = 0; value < loop_max; value++) {
4223                             if (_generic_isCC(UNI_TO_NATIVE(value), classnum)) {
4224                                 ANYOF_BITMAP_SET(data->start_class, UNI_TO_NATIVE(value));
4225                             }
4226                         }
4227                         }
4228                     }
4229                     break;
4230                 case NPOSIXA:
4231                     loop_max = 128;
4232                     /* FALL THROUGH */
4233                 case NPOSIXL:
4234                 case NPOSIXU:
4235                 case NPOSIXD:
4236                     classnum = FLAGS(scan);
4237                     if (flags & SCF_DO_STCLASS_AND) {
4238                         if (!(data->start_class->flags & ANYOF_LOCALE)) {
4239                             ANYOF_CLASS_CLEAR(data->start_class, classnum_to_namedclass(classnum));
4240                             for (value = 0; value < loop_max; value++) {
4241                                 if (_generic_isCC(UNI_TO_NATIVE(value), classnum)) {
4242                                     ANYOF_BITMAP_CLEAR(data->start_class, UNI_TO_NATIVE(value));
4243                                 }
4244                             }
4245                         }
4246                     }
4247                     else {
4248                         if (data->start_class->flags & ANYOF_LOCALE) {
4249                             ANYOF_CLASS_SET(data->start_class, classnum_to_namedclass(classnum) + 1);
4250                         }
4251                         else {
4252
4253                         /* Even if under locale, set the bits for non-locale in
4254                          * case it isn't a true locale-node.  This will create
4255                          * false positives if it truly is locale */
4256                         for (value = 0; value < loop_max; value++) {
4257                             if (! _generic_isCC(UNI_TO_NATIVE(value), classnum)) {
4258                                 ANYOF_BITMAP_SET(data->start_class, UNI_TO_NATIVE(value));
4259                             }
4260                         }
4261                         if (PL_regkind[OP(scan)] == NPOSIXD) {
4262                             data->start_class->flags |= ANYOF_NON_UTF8_LATIN1_ALL;
4263                         }
4264                         }
4265                     }
4266                     break;
4267                 }
4268                 if (flags & SCF_DO_STCLASS_OR)
4269                     cl_and(data->start_class, and_withp);
4270                 flags &= ~SCF_DO_STCLASS;
4271             }
4272         }
4273         else if (PL_regkind[OP(scan)] == EOL && flags & SCF_DO_SUBSTR) {
4274             data->flags |= (OP(scan) == MEOL
4275                             ? SF_BEFORE_MEOL
4276                             : SF_BEFORE_SEOL);
4277             SCAN_COMMIT(pRExC_state, data, minlenp);
4278
4279         }
4280         else if (  PL_regkind[OP(scan)] == BRANCHJ
4281                  /* Lookbehind, or need to calculate parens/evals/stclass: */
4282                    && (scan->flags || data || (flags & SCF_DO_STCLASS))
4283                    && (OP(scan) == IFMATCH || OP(scan) == UNLESSM)) {
4284             if ( OP(scan) == UNLESSM &&
4285                  scan->flags == 0 &&
4286                  OP(NEXTOPER(NEXTOPER(scan))) == NOTHING &&
4287                  OP(regnext(NEXTOPER(NEXTOPER(scan)))) == SUCCEED
4288             ) {
4289                 regnode *opt;
4290                 regnode *upto= regnext(scan);
4291                 DEBUG_PARSE_r({
4292                     SV * const mysv_val=sv_newmortal();
4293                     DEBUG_STUDYDATA("OPFAIL",data,depth);
4294
4295                     /*DEBUG_PARSE_MSG("opfail");*/
4296                     regprop(RExC_rx, mysv_val, upto);
4297                     PerlIO_printf(Perl_debug_log, "~ replace with OPFAIL pointed at %s (%"IVdf") offset %"IVdf"\n",
4298                                   SvPV_nolen_const(mysv_val),
4299                                   (IV)REG_NODE_NUM(upto),
4300                                   (IV)(upto - scan)
4301                     );
4302                 });
4303                 OP(scan) = OPFAIL;
4304                 NEXT_OFF(scan) = upto - scan;
4305                 for (opt= scan + 1; opt < upto ; opt++)
4306                     OP(opt) = OPTIMIZED;
4307                 scan= upto;
4308                 continue;
4309             }
4310             if ( !PERL_ENABLE_POSITIVE_ASSERTION_STUDY 
4311                 || OP(scan) == UNLESSM )
4312             {
4313                 /* Negative Lookahead/lookbehind
4314                    In this case we can't do fixed string optimisation.
4315                 */
4316
4317                 I32 deltanext, minnext, fake = 0;
4318                 regnode *nscan;
4319                 struct regnode_charclass_class intrnl;
4320                 int f = 0;
4321
4322                 data_fake.flags = 0;
4323                 if (data) {
4324                     data_fake.whilem_c = data->whilem_c;
4325                     data_fake.last_closep = data->last_closep;
4326                 }
4327                 else
4328                     data_fake.last_closep = &fake;
4329                 data_fake.pos_delta = delta;
4330                 if ( flags & SCF_DO_STCLASS && !scan->flags
4331                      && OP(scan) == IFMATCH ) { /* Lookahead */
4332                     cl_init(pRExC_state, &intrnl);
4333                     data_fake.start_class = &intrnl;
4334                     f |= SCF_DO_STCLASS_AND;
4335                 }
4336                 if (flags & SCF_WHILEM_VISITED_POS)
4337                     f |= SCF_WHILEM_VISITED_POS;
4338                 next = regnext(scan);
4339                 nscan = NEXTOPER(NEXTOPER(scan));
4340                 minnext = study_chunk(pRExC_state, &nscan, minlenp, &deltanext, 
4341                     last, &data_fake, stopparen, recursed, NULL, f, depth+1);
4342                 if (scan->flags) {
4343                     if (deltanext) {
4344                         FAIL("Variable length lookbehind not implemented");
4345                     }
4346                     else if (minnext > (I32)U8_MAX) {
4347                         FAIL2("Lookbehind longer than %"UVuf" not implemented", (UV)U8_MAX);
4348                     }
4349                     scan->flags = (U8)minnext;
4350                 }
4351                 if (data) {
4352                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4353                         pars++;
4354                     if (data_fake.flags & SF_HAS_EVAL)
4355                         data->flags |= SF_HAS_EVAL;
4356                     data->whilem_c = data_fake.whilem_c;
4357                 }
4358                 if (f & SCF_DO_STCLASS_AND) {
4359                     if (flags & SCF_DO_STCLASS_OR) {
4360                         /* OR before, AND after: ideally we would recurse with
4361                          * data_fake to get the AND applied by study of the
4362                          * remainder of the pattern, and then derecurse;
4363                          * *** HACK *** for now just treat as "no information".
4364                          * See [perl #56690].
4365                          */
4366                         cl_init(pRExC_state, data->start_class);
4367                     }  else {
4368                         /* AND before and after: combine and continue */
4369                         const int was = TEST_SSC_EOS(data->start_class);
4370
4371                         cl_and(data->start_class, &intrnl);
4372                         if (was)
4373                             SET_SSC_EOS(data->start_class);
4374                     }
4375                 }
4376             }
4377 #if PERL_ENABLE_POSITIVE_ASSERTION_STUDY
4378             else {
4379                 /* Positive Lookahead/lookbehind
4380                    In this case we can do fixed string optimisation,
4381                    but we must be careful about it. Note in the case of
4382                    lookbehind the positions will be offset by the minimum
4383                    length of the pattern, something we won't know about
4384                    until after the recurse.
4385                 */
4386                 I32 deltanext, fake = 0;
4387                 regnode *nscan;
4388                 struct regnode_charclass_class intrnl;
4389                 int f = 0;
4390                 /* We use SAVEFREEPV so that when the full compile 
4391                     is finished perl will clean up the allocated 
4392                     minlens when it's all done. This way we don't
4393                     have to worry about freeing them when we know
4394                     they wont be used, which would be a pain.
4395                  */
4396                 I32 *minnextp;
4397                 Newx( minnextp, 1, I32 );
4398                 SAVEFREEPV(minnextp);
4399
4400                 if (data) {
4401                     StructCopy(data, &data_fake, scan_data_t);
4402                     if ((flags & SCF_DO_SUBSTR) && data->last_found) {
4403                         f |= SCF_DO_SUBSTR;
4404                         if (scan->flags) 
4405                             SCAN_COMMIT(pRExC_state, &data_fake,minlenp);
4406                         data_fake.last_found=newSVsv(data->last_found);
4407                     }
4408                 }
4409                 else
4410                     data_fake.last_closep = &fake;
4411                 data_fake.flags = 0;
4412                 data_fake.pos_delta = delta;
4413                 if (is_inf)
4414                     data_fake.flags |= SF_IS_INF;
4415                 if ( flags & SCF_DO_STCLASS && !scan->flags
4416                      && OP(scan) == IFMATCH ) { /* Lookahead */
4417                     cl_init(pRExC_state, &intrnl);
4418                     data_fake.start_class = &intrnl;
4419                     f |= SCF_DO_STCLASS_AND;
4420                 }
4421                 if (flags & SCF_WHILEM_VISITED_POS)
4422                     f |= SCF_WHILEM_VISITED_POS;
4423                 next = regnext(scan);
4424                 nscan = NEXTOPER(NEXTOPER(scan));
4425
4426                 *minnextp = study_chunk(pRExC_state, &nscan, minnextp, &deltanext, 
4427                     last, &data_fake, stopparen, recursed, NULL, f,depth+1);
4428                 if (scan->flags) {
4429                     if (deltanext) {
4430                         FAIL("Variable length lookbehind not implemented");
4431                     }
4432                     else if (*minnextp > (I32)U8_MAX) {
4433                         FAIL2("Lookbehind longer than %"UVuf" not implemented", (UV)U8_MAX);
4434                     }
4435                     scan->flags = (U8)*minnextp;
4436                 }
4437
4438                 *minnextp += min;
4439
4440                 if (f & SCF_DO_STCLASS_AND) {
4441                     const int was = TEST_SSC_EOS(data.start_class);
4442
4443                     cl_and(data->start_class, &intrnl);
4444                     if (was)
4445                         SET_SSC_EOS(data->start_class);
4446                 }
4447                 if (data) {
4448                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4449                         pars++;
4450                     if (data_fake.flags & SF_HAS_EVAL)
4451                         data->flags |= SF_HAS_EVAL;
4452                     data->whilem_c = data_fake.whilem_c;
4453                     if ((flags & SCF_DO_SUBSTR) && data_fake.last_found) {
4454                         if (RExC_rx->minlen<*minnextp)
4455                             RExC_rx->minlen=*minnextp;
4456                         SCAN_COMMIT(pRExC_state, &data_fake, minnextp);
4457                         SvREFCNT_dec_NN(data_fake.last_found);
4458                         
4459                         if ( data_fake.minlen_fixed != minlenp ) 
4460                         {
4461                             data->offset_fixed= data_fake.offset_fixed;
4462                             data->minlen_fixed= data_fake.minlen_fixed;
4463                             data->lookbehind_fixed+= scan->flags;
4464                         }
4465                         if ( data_fake.minlen_float != minlenp )
4466                         {
4467                             data->minlen_float= data_fake.minlen_float;
4468                             data->offset_float_min=data_fake.offset_float_min;
4469                             data->offset_float_max=data_fake.offset_float_max;
4470                             data->lookbehind_float+= scan->flags;
4471                         }
4472                     }
4473                 }
4474             }
4475 #endif
4476         }
4477         else if (OP(scan) == OPEN) {
4478             if (stopparen != (I32)ARG(scan))
4479                 pars++;
4480         }
4481         else if (OP(scan) == CLOSE) {
4482             if (stopparen == (I32)ARG(scan)) {
4483                 break;
4484             }
4485             if ((I32)ARG(scan) == is_par) {
4486                 next = regnext(scan);
4487
4488                 if ( next && (OP(next) != WHILEM) && next < last)
4489                     is_par = 0;         /* Disable optimization */
4490             }
4491             if (data)
4492                 *(data->last_closep) = ARG(scan);
4493         }
4494         else if (OP(scan) == EVAL) {
4495                 if (data)
4496                     data->flags |= SF_HAS_EVAL;
4497         }
4498         else if ( PL_regkind[OP(scan)] == ENDLIKE ) {
4499             if (flags & SCF_DO_SUBSTR) {
4500                 SCAN_COMMIT(pRExC_state,data,minlenp);
4501                 flags &= ~SCF_DO_SUBSTR;
4502             }
4503             if (data && OP(scan)==ACCEPT) {
4504                 data->flags |= SCF_SEEN_ACCEPT;
4505                 if (stopmin > min)
4506                     stopmin = min;
4507             }
4508         }
4509         else if (OP(scan) == LOGICAL && scan->flags == 2) /* Embedded follows */
4510         {
4511                 if (flags & SCF_DO_SUBSTR) {
4512                     SCAN_COMMIT(pRExC_state,data,minlenp);
4513                     data->longest = &(data->longest_float);
4514                 }
4515                 is_inf = is_inf_internal = 1;
4516                 if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
4517                     cl_anything(pRExC_state, data->start_class);
4518                 flags &= ~SCF_DO_STCLASS;
4519         }
4520         else if (OP(scan) == GPOS) {
4521             if (!(RExC_rx->extflags & RXf_GPOS_FLOAT) &&
4522                 !(delta || is_inf || (data && data->pos_delta))) 
4523             {
4524                 if (!(RExC_rx->extflags & RXf_ANCH) && (flags & SCF_DO_SUBSTR))
4525                     RExC_rx->extflags |= RXf_ANCH_GPOS;
4526                 if (RExC_rx->gofs < (U32)min)
4527                     RExC_rx->gofs = min;
4528             } else {
4529                 RExC_rx->extflags |= RXf_GPOS_FLOAT;
4530                 RExC_rx->gofs = 0;
4531             }       
4532         }
4533 #ifdef TRIE_STUDY_OPT
4534 #ifdef FULL_TRIE_STUDY
4535         else if (PL_regkind[OP(scan)] == TRIE) {
4536             /* NOTE - There is similar code to this block above for handling
4537                BRANCH nodes on the initial study.  If you change stuff here
4538                check there too. */
4539             regnode *trie_node= scan;
4540             regnode *tail= regnext(scan);
4541             reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
4542             I32 max1 = 0, min1 = I32_MAX;
4543             struct regnode_charclass_class accum;
4544
4545             if (flags & SCF_DO_SUBSTR) /* XXXX Add !SUSPEND? */
4546                 SCAN_COMMIT(pRExC_state, data,minlenp); /* Cannot merge strings after this. */
4547             if (flags & SCF_DO_STCLASS)
4548                 cl_init_zero(pRExC_state, &accum);
4549                 
4550             if (!trie->jump) {
4551                 min1= trie->minlen;
4552                 max1= trie->maxlen;
4553             } else {
4554                 const regnode *nextbranch= NULL;
4555                 U32 word;
4556                 
4557                 for ( word=1 ; word <= trie->wordcount ; word++) 
4558                 {
4559                     I32 deltanext=0, minnext=0, f = 0, fake;
4560                     struct regnode_charclass_class this_class;
4561                     
4562                     data_fake.flags = 0;
4563                     if (data) {
4564                         data_fake.whilem_c = data->whilem_c;
4565                         data_fake.last_closep = data->last_closep;
4566                     }
4567                     else
4568                         data_fake.last_closep = &fake;
4569                     data_fake.pos_delta = delta;
4570                     if (flags & SCF_DO_STCLASS) {
4571                         cl_init(pRExC_state, &this_class);
4572                         data_fake.start_class = &this_class;
4573                         f = SCF_DO_STCLASS_AND;
4574                     }
4575                     if (flags & SCF_WHILEM_VISITED_POS)
4576                         f |= SCF_WHILEM_VISITED_POS;
4577     
4578                     if (trie->jump[word]) {
4579                         if (!nextbranch)
4580                             nextbranch = trie_node + trie->jump[0];
4581                         scan= trie_node + trie->jump[word];
4582                         /* We go from the jump point to the branch that follows
4583                            it. Note this means we need the vestigal unused branches
4584                            even though they arent otherwise used.
4585                          */
4586                         minnext = study_chunk(pRExC_state, &scan, minlenp, 
4587                             &deltanext, (regnode *)nextbranch, &data_fake, 
4588                             stopparen, recursed, NULL, f,depth+1);
4589                     }
4590                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
4591                         nextbranch= regnext((regnode*)nextbranch);
4592                     
4593                     if (min1 > (I32)(minnext + trie->minlen))
4594                         min1 = minnext + trie->minlen;
4595                     if (max1 < (I32)(minnext + deltanext + trie->maxlen))
4596                         max1 = minnext + deltanext + trie->maxlen;
4597                     if (deltanext == I32_MAX)
4598                         is_inf = is_inf_internal = 1;
4599                     
4600                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4601                         pars++;
4602                     if (data_fake.flags & SCF_SEEN_ACCEPT) {
4603                         if ( stopmin > min + min1) 
4604                             stopmin = min + min1;
4605                         flags &= ~SCF_DO_SUBSTR;
4606                         if (data)
4607                             data->flags |= SCF_SEEN_ACCEPT;
4608                     }
4609                     if (data) {
4610                         if (data_fake.flags & SF_HAS_EVAL)
4611                             data->flags |= SF_HAS_EVAL;
4612                         data->whilem_c = data_fake.whilem_c;
4613                     }
4614                     if (flags & SCF_DO_STCLASS)
4615                         cl_or(pRExC_state, &accum, &this_class);
4616                 }
4617             }
4618             if (flags & SCF_DO_SUBSTR) {
4619                 data->pos_min += min1;
4620                 data->pos_delta += max1 - min1;
4621                 if (max1 != min1 || is_inf)
4622                     data->longest = &(data->longest_float);
4623             }
4624             min += min1;
4625             delta += max1 - min1;
4626             if (flags & SCF_DO_STCLASS_OR) {
4627                 cl_or(pRExC_state, data->start_class, &accum);
4628                 if (min1) {
4629                     cl_and(data->start_class, and_withp);
4630                     flags &= ~SCF_DO_STCLASS;
4631                 }
4632             }
4633             else if (flags & SCF_DO_STCLASS_AND) {
4634                 if (min1) {
4635                     cl_and(data->start_class, &accum);
4636                     flags &= ~SCF_DO_STCLASS;
4637                 }
4638                 else {
4639                     /* Switch to OR mode: cache the old value of
4640                      * data->start_class */
4641                     INIT_AND_WITHP;
4642                     StructCopy(data->start_class, and_withp,
4643                                struct regnode_charclass_class);
4644                     flags &= ~SCF_DO_STCLASS_AND;
4645                     StructCopy(&accum, data->start_class,
4646                                struct regnode_charclass_class);
4647                     flags |= SCF_DO_STCLASS_OR;
4648                     SET_SSC_EOS(data->start_class);
4649                 }
4650             }
4651             scan= tail;
4652             continue;
4653         }
4654 #else
4655         else if (PL_regkind[OP(scan)] == TRIE) {
4656             reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
4657             U8*bang=NULL;
4658             
4659             min += trie->minlen;
4660             delta += (trie->maxlen - trie->minlen);
4661             flags &= ~SCF_DO_STCLASS; /* xxx */
4662             if (flags & SCF_DO_SUBSTR) {
4663                 SCAN_COMMIT(pRExC_state,data,minlenp);  /* Cannot expect anything... */
4664                 data->pos_min += trie->minlen;
4665                 data->pos_delta += (trie->maxlen - trie->minlen);
4666                 if (trie->maxlen != trie->minlen)
4667                     data->longest = &(data->longest_float);
4668             }
4669             if (trie->jump) /* no more substrings -- for now /grr*/
4670                 flags &= ~SCF_DO_SUBSTR; 
4671         }
4672 #endif /* old or new */
4673 #endif /* TRIE_STUDY_OPT */
4674
4675         /* Else: zero-length, ignore. */
4676         scan = regnext(scan);
4677     }
4678     if (frame) {
4679         last = frame->last;
4680         scan = frame->next;
4681         stopparen = frame->stop;
4682         frame = frame->prev;
4683         goto fake_study_recurse;
4684     }
4685
4686   finish:
4687     assert(!frame);
4688     DEBUG_STUDYDATA("pre-fin:",data,depth);
4689
4690     *scanp = scan;
4691     *deltap = is_inf_internal ? I32_MAX : delta;
4692     if (flags & SCF_DO_SUBSTR && is_inf)
4693         data->pos_delta = I32_MAX - data->pos_min;
4694     if (is_par > (I32)U8_MAX)
4695         is_par = 0;
4696     if (is_par && pars==1 && data) {
4697         data->flags |= SF_IN_PAR;
4698         data->flags &= ~SF_HAS_PAR;
4699     }
4700     else if (pars && data) {
4701         data->flags |= SF_HAS_PAR;
4702         data->flags &= ~SF_IN_PAR;
4703     }
4704     if (flags & SCF_DO_STCLASS_OR)
4705         cl_and(data->start_class, and_withp);
4706     if (flags & SCF_TRIE_RESTUDY)
4707         data->flags |=  SCF_TRIE_RESTUDY;
4708     
4709     DEBUG_STUDYDATA("post-fin:",data,depth);
4710     
4711     return min < stopmin ? min : stopmin;
4712 }
4713
4714 STATIC U32
4715 S_add_data(RExC_state_t *pRExC_state, U32 n, const char *s)
4716 {
4717     U32 count = RExC_rxi->data ? RExC_rxi->data->count : 0;
4718
4719     PERL_ARGS_ASSERT_ADD_DATA;
4720
4721     Renewc(RExC_rxi->data,
4722            sizeof(*RExC_rxi->data) + sizeof(void*) * (count + n - 1),
4723            char, struct reg_data);
4724     if(count)
4725         Renew(RExC_rxi->data->what, count + n, U8);
4726     else
4727         Newx(RExC_rxi->data->what, n, U8);
4728     RExC_rxi->data->count = count + n;
4729     Copy(s, RExC_rxi->data->what + count, n, U8);
4730     return count;
4731 }
4732
4733 /*XXX: todo make this not included in a non debugging perl */
4734 #ifndef PERL_IN_XSUB_RE
4735 void
4736 Perl_reginitcolors(pTHX)
4737 {
4738     dVAR;
4739     const char * const s = PerlEnv_getenv("PERL_RE_COLORS");
4740     if (s) {
4741         char *t = savepv(s);
4742         int i = 0;
4743         PL_colors[0] = t;
4744         while (++i < 6) {
4745             t = strchr(t, '\t');
4746             if (t) {
4747                 *t = '\0';
4748                 PL_colors[i] = ++t;
4749             }
4750             else
4751                 PL_colors[i] = t = (char *)"";
4752         }
4753     } else {
4754         int i = 0;
4755         while (i < 6)
4756             PL_colors[i++] = (char *)"";
4757     }
4758     PL_colorset = 1;
4759 }
4760 #endif
4761
4762
4763 #ifdef TRIE_STUDY_OPT
4764 #define CHECK_RESTUDY_GOTO_butfirst(dOsomething)            \
4765     STMT_START {                                            \
4766         if (                                                \
4767               (data.flags & SCF_TRIE_RESTUDY)               \
4768               && ! restudied++                              \
4769         ) {                                                 \
4770             dOsomething;                                    \
4771             goto reStudy;                                   \
4772         }                                                   \
4773     } STMT_END
4774 #else
4775 #define CHECK_RESTUDY_GOTO_butfirst
4776 #endif        
4777
4778 /*
4779  * pregcomp - compile a regular expression into internal code
4780  *
4781  * Decides which engine's compiler to call based on the hint currently in
4782  * scope
4783  */
4784
4785 #ifndef PERL_IN_XSUB_RE 
4786
4787 /* return the currently in-scope regex engine (or the default if none)  */
4788
4789 regexp_engine const *
4790 Perl_current_re_engine(pTHX)
4791 {
4792     dVAR;
4793
4794     if (IN_PERL_COMPILETIME) {
4795         HV * const table = GvHV(PL_hintgv);
4796         SV **ptr;
4797
4798         if (!table)
4799             return &reh_regexp_engine;
4800         ptr = hv_fetchs(table, "regcomp", FALSE);
4801         if ( !(ptr && SvIOK(*ptr) && SvIV(*ptr)))
4802             return &reh_regexp_engine;
4803         return INT2PTR(regexp_engine*,SvIV(*ptr));
4804     }
4805     else {
4806         SV *ptr;
4807         if (!PL_curcop->cop_hints_hash)
4808             return &reh_regexp_engine;
4809         ptr = cop_hints_fetch_pvs(PL_curcop, "regcomp", 0);
4810         if ( !(ptr && SvIOK(ptr) && SvIV(ptr)))
4811             return &reh_regexp_engine;
4812         return INT2PTR(regexp_engine*,SvIV(ptr));
4813     }
4814 }
4815
4816
4817 REGEXP *
4818 Perl_pregcomp(pTHX_ SV * const pattern, const U32 flags)
4819 {
4820     dVAR;
4821     regexp_engine const *eng = current_re_engine();
4822     GET_RE_DEBUG_FLAGS_DECL;
4823
4824     PERL_ARGS_ASSERT_PREGCOMP;
4825
4826     /* Dispatch a request to compile a regexp to correct regexp engine. */
4827     DEBUG_COMPILE_r({
4828         PerlIO_printf(Perl_debug_log, "Using engine %"UVxf"\n",
4829                         PTR2UV(eng));
4830     });
4831     return CALLREGCOMP_ENG(eng, pattern, flags);
4832 }
4833 #endif
4834
4835 /* public(ish) entry point for the perl core's own regex compiling code.
4836  * It's actually a wrapper for Perl_re_op_compile that only takes an SV
4837  * pattern rather than a list of OPs, and uses the internal engine rather
4838  * than the current one */
4839
4840 REGEXP *
4841 Perl_re_compile(pTHX_ SV * const pattern, U32 rx_flags)
4842 {
4843     SV *pat = pattern; /* defeat constness! */
4844     PERL_ARGS_ASSERT_RE_COMPILE;
4845     return Perl_re_op_compile(aTHX_ &pat, 1, NULL,
4846 #ifdef PERL_IN_XSUB_RE
4847                                 &my_reg_engine,
4848 #else
4849                                 &reh_regexp_engine,
4850 #endif
4851                                 NULL, NULL, rx_flags, 0);
4852 }
4853
4854 /* see if there are any run-time code blocks in the pattern.
4855  * False positives are allowed */
4856
4857 static bool
4858 S_has_runtime_code(pTHX_ RExC_state_t * const pRExC_state, OP *expr,
4859                     U32 pm_flags, char *pat, STRLEN plen)
4860 {
4861     int n = 0;
4862     STRLEN s;
4863
4864     /* avoid infinitely recursing when we recompile the pattern parcelled up
4865      * as qr'...'. A single constant qr// string can't have have any
4866      * run-time component in it, and thus, no runtime code. (A non-qr
4867      * string, however, can, e.g. $x =~ '(?{})') */
4868     if  ((pm_flags & PMf_IS_QR) && expr && expr->op_type == OP_CONST)
4869         return 0;
4870
4871     for (s = 0; s < plen; s++) {
4872         if (n < pRExC_state->num_code_blocks
4873             && s == pRExC_state->code_blocks[n].start)
4874         {
4875             s = pRExC_state->code_blocks[n].end;
4876             n++;
4877             continue;
4878         }
4879         /* TODO ideally should handle [..], (#..), /#.../x to reduce false
4880          * positives here */
4881         if (pat[s] == '(' && s+2 <= plen && pat[s+1] == '?' &&
4882             (pat[s+2] == '{'
4883                 || (s + 2 <= plen && pat[s+2] == '?' && pat[s+3] == '{'))
4884         )
4885             return 1;
4886     }
4887     return 0;
4888 }
4889
4890 /* Handle run-time code blocks. We will already have compiled any direct
4891  * or indirect literal code blocks. Now, take the pattern 'pat' and make a
4892  * copy of it, but with any literal code blocks blanked out and
4893  * appropriate chars escaped; then feed it into
4894  *
4895  *    eval "qr'modified_pattern'"
4896  *
4897  * For example,
4898  *
4899  *       a\bc(?{"this was literal"})def'ghi\\jkl(?{"this is runtime"})mno
4900  *
4901  * becomes
4902  *
4903  *    qr'a\\bc_______________________def\'ghi\\\\jkl(?{"this is runtime"})mno'
4904  *
4905  * After eval_sv()-ing that, grab any new code blocks from the returned qr
4906  * and merge them with any code blocks of the original regexp.
4907  *
4908  * If the pat is non-UTF8, while the evalled qr is UTF8, don't merge;
4909  * instead, just save the qr and return FALSE; this tells our caller that
4910  * the original pattern needs upgrading to utf8.
4911  */
4912
4913 static bool
4914 S_compile_runtime_code(pTHX_ RExC_state_t * const pRExC_state,
4915     char *pat, STRLEN plen)
4916 {
4917     SV *qr;
4918
4919     GET_RE_DEBUG_FLAGS_DECL;
4920
4921     if (pRExC_state->runtime_code_qr) {
4922         /* this is the second time we've been called; this should
4923          * only happen if the main pattern got upgraded to utf8
4924          * during compilation; re-use the qr we compiled first time
4925          * round (which should be utf8 too)
4926          */
4927         qr = pRExC_state->runtime_code_qr;
4928         pRExC_state->runtime_code_qr = NULL;
4929         assert(RExC_utf8 && SvUTF8(qr));
4930     }
4931     else {
4932         int n = 0;
4933         STRLEN s;
4934         char *p, *newpat;
4935         int newlen = plen + 6; /* allow for "qr''x\0" extra chars */
4936         SV *sv, *qr_ref;
4937         dSP;
4938
4939         /* determine how many extra chars we need for ' and \ escaping */
4940         for (s = 0; s < plen; s++) {
4941             if (pat[s] == '\'' || pat[s] == '\\')
4942                 newlen++;
4943         }
4944
4945         Newx(newpat, newlen, char);
4946         p = newpat;
4947         *p++ = 'q'; *p++ = 'r'; *p++ = '\'';
4948
4949         for (s = 0; s < plen; s++) {
4950             if (n < pRExC_state->num_code_blocks
4951                 && s == pRExC_state->code_blocks[n].start)
4952             {
4953                 /* blank out literal code block */
4954                 assert(pat[s] == '(');
4955                 while (s <= pRExC_state->code_blocks[n].end) {
4956                     *p++ = '_';
4957                     s++;
4958                 }
4959                 s--;
4960                 n++;
4961                 continue;
4962             }
4963             if (pat[s] == '\'' || pat[s] == '\\')
4964                 *p++ = '\\';
4965             *p++ = pat[s];
4966         }
4967         *p++ = '\'';
4968         if (pRExC_state->pm_flags & RXf_PMf_EXTENDED)
4969             *p++ = 'x';
4970         *p++ = '\0';
4971         DEBUG_COMPILE_r({
4972             PerlIO_printf(Perl_debug_log,
4973                 "%sre-parsing pattern for runtime code:%s %s\n",
4974                 PL_colors[4],PL_colors[5],newpat);
4975         });
4976
4977         sv = newSVpvn_flags(newpat, p-newpat-1, RExC_utf8 ? SVf_UTF8 : 0);
4978         Safefree(newpat);
4979
4980         ENTER;
4981         SAVETMPS;
4982         save_re_context();
4983         PUSHSTACKi(PERLSI_REQUIRE);
4984         /* this causes the toker to collapse \\ into \ when parsing
4985          * qr''; normally only q'' does this. It also alters hints
4986          * handling */
4987         PL_reg_state.re_reparsing = TRUE;
4988         eval_sv(sv, G_SCALAR);
4989         SvREFCNT_dec_NN(sv);
4990         SPAGAIN;
4991         qr_ref = POPs;
4992         PUTBACK;
4993         {
4994             SV * const errsv = ERRSV;
4995             if (SvTRUE_NN(errsv))
4996             {
4997                 Safefree(pRExC_state->code_blocks);
4998                 /* use croak_sv ? */
4999                 Perl_croak_nocontext("%s", SvPV_nolen_const(errsv));
5000             }
5001         }
5002         assert(SvROK(qr_ref));
5003         qr = SvRV(qr_ref);
5004         assert(SvTYPE(qr) == SVt_REGEXP && RX_ENGINE((REGEXP*)qr)->op_comp);
5005         /* the leaving below frees the tmp qr_ref.
5006          * Give qr a life of its own */
5007         SvREFCNT_inc(qr);
5008         POPSTACK;
5009         FREETMPS;
5010         LEAVE;
5011
5012     }
5013
5014     if (!RExC_utf8 && SvUTF8(qr)) {
5015         /* first time through; the pattern got upgraded; save the
5016          * qr for the next time through */
5017         assert(!pRExC_state->runtime_code_qr);
5018         pRExC_state->runtime_code_qr = qr;
5019         return 0;
5020     }
5021
5022
5023     /* extract any code blocks within the returned qr//  */
5024
5025
5026     /* merge the main (r1) and run-time (r2) code blocks into one */
5027     {
5028         RXi_GET_DECL(ReANY((REGEXP *)qr), r2);
5029         struct reg_code_block *new_block, *dst;
5030         RExC_state_t * const r1 = pRExC_state; /* convenient alias */
5031         int i1 = 0, i2 = 0;
5032
5033         if (!r2->num_code_blocks) /* we guessed wrong */
5034         {
5035             SvREFCNT_dec_NN(qr);
5036             return 1;
5037         }
5038
5039         Newx(new_block,
5040             r1->num_code_blocks + r2->num_code_blocks,
5041             struct reg_code_block);
5042         dst = new_block;
5043
5044         while (    i1 < r1->num_code_blocks
5045                 || i2 < r2->num_code_blocks)
5046         {
5047             struct reg_code_block *src;
5048             bool is_qr = 0;
5049
5050             if (i1 == r1->num_code_blocks) {
5051                 src = &r2->code_blocks[i2++];
5052                 is_qr = 1;
5053             }
5054             else if (i2 == r2->num_code_blocks)
5055                 src = &r1->code_blocks[i1++];
5056             else if (  r1->code_blocks[i1].start
5057                      < r2->code_blocks[i2].start)
5058             {
5059                 src = &r1->code_blocks[i1++];
5060                 assert(src->end < r2->code_blocks[i2].start);
5061             }
5062             else {
5063                 assert(  r1->code_blocks[i1].start
5064                        > r2->code_blocks[i2].start);
5065                 src = &r2->code_blocks[i2++];
5066                 is_qr = 1;
5067                 assert(src->end < r1->code_blocks[i1].start);
5068             }
5069
5070             assert(pat[src->start] == '(');
5071             assert(pat[src->end]   == ')');
5072             dst->start      = src->start;
5073             dst->end        = src->end;
5074             dst->block      = src->block;
5075             dst->src_regex  = is_qr ? (REGEXP*) SvREFCNT_inc( (SV*) qr)
5076                                     : src->src_regex;
5077             dst++;
5078         }
5079         r1->num_code_blocks += r2->num_code_blocks;
5080         Safefree(r1->code_blocks);
5081         r1->code_blocks = new_block;
5082     }
5083
5084     SvREFCNT_dec_NN(qr);
5085     return 1;
5086 }
5087
5088
5089 STATIC bool
5090 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)
5091 {
5092     /* This is the common code for setting up the floating and fixed length
5093      * string data extracted from Perlre_op_compile() below.  Returns a boolean
5094      * as to whether succeeded or not */
5095
5096     I32 t,ml;
5097
5098     if (! (longest_length
5099            || (eol /* Can't have SEOL and MULTI */
5100                && (! meol || (RExC_flags & RXf_PMf_MULTILINE)))
5101           )
5102             /* See comments for join_exact for why REG_SEEN_EXACTF_SHARP_S */
5103         || (RExC_seen & REG_SEEN_EXACTF_SHARP_S))
5104     {
5105         return FALSE;
5106     }
5107
5108     /* copy the information about the longest from the reg_scan_data
5109         over to the program. */
5110     if (SvUTF8(sv_longest)) {
5111         *rx_utf8 = sv_longest;
5112         *rx_substr = NULL;
5113     } else {
5114         *rx_substr = sv_longest;
5115         *rx_utf8 = NULL;
5116     }
5117     /* end_shift is how many chars that must be matched that
5118         follow this item. We calculate it ahead of time as once the
5119         lookbehind offset is added in we lose the ability to correctly
5120         calculate it.*/
5121     ml = minlen ? *(minlen) : (I32)longest_length;
5122     *rx_end_shift = ml - offset
5123         - longest_length + (SvTAIL(sv_longest) != 0)
5124         + lookbehind;
5125
5126     t = (eol/* Can't have SEOL and MULTI */
5127          && (! meol || (RExC_flags & RXf_PMf_MULTILINE)));
5128     fbm_compile(sv_longest, t ? FBMcf_TAIL : 0);
5129
5130     return TRUE;
5131 }
5132
5133 /*
5134  * Perl_re_op_compile - the perl internal RE engine's function to compile a
5135  * regular expression into internal code.
5136  * The pattern may be passed either as:
5137  *    a list of SVs (patternp plus pat_count)
5138  *    a list of OPs (expr)
5139  * If both are passed, the SV list is used, but the OP list indicates
5140  * which SVs are actually pre-compiled code blocks
5141  *
5142  * The SVs in the list have magic and qr overloading applied to them (and
5143  * the list may be modified in-place with replacement SVs in the latter
5144  * case).
5145  *
5146  * If the pattern hasn't changed from old_re, then old_re will be
5147  * returned.
5148  *
5149  * eng is the current engine. If that engine has an op_comp method, then
5150  * handle directly (i.e. we assume that op_comp was us); otherwise, just
5151  * do the initial concatenation of arguments and pass on to the external
5152  * engine.
5153  *
5154  * If is_bare_re is not null, set it to a boolean indicating whether the
5155  * arg list reduced (after overloading) to a single bare regex which has
5156  * been returned (i.e. /$qr/).
5157  *
5158  * orig_rx_flags contains RXf_* flags. See perlreapi.pod for more details.
5159  *
5160  * pm_flags contains the PMf_* flags, typically based on those from the
5161  * pm_flags field of the related PMOP. Currently we're only interested in
5162  * PMf_HAS_CV, PMf_IS_QR, PMf_USE_RE_EVAL.
5163  *
5164  * We can't allocate space until we know how big the compiled form will be,
5165  * but we can't compile it (and thus know how big it is) until we've got a
5166  * place to put the code.  So we cheat:  we compile it twice, once with code
5167  * generation turned off and size counting turned on, and once "for real".
5168  * This also means that we don't allocate space until we are sure that the
5169  * thing really will compile successfully, and we never have to move the
5170  * code and thus invalidate pointers into it.  (Note that it has to be in
5171  * one piece because free() must be able to free it all.) [NB: not true in perl]
5172  *
5173  * Beware that the optimization-preparation code in here knows about some
5174  * of the structure of the compiled regexp.  [I'll say.]
5175  */
5176
5177 REGEXP *
5178 Perl_re_op_compile(pTHX_ SV ** const patternp, int pat_count,
5179                     OP *expr, const regexp_engine* eng, REGEXP *VOL old_re,
5180                      bool *is_bare_re, U32 orig_rx_flags, U32 pm_flags)
5181 {
5182     dVAR;
5183     REGEXP *rx;
5184     struct regexp *r;
5185     regexp_internal *ri;
5186     STRLEN plen;
5187     char  * VOL exp;
5188     char* xend;
5189     regnode *scan;
5190     I32 flags;
5191     I32 minlen = 0;
5192     U32 rx_flags;
5193     SV * VOL pat;
5194     SV * VOL code_blocksv = NULL;
5195
5196     /* these are all flags - maybe they should be turned
5197      * into a single int with different bit masks */
5198     I32 sawlookahead = 0;
5199     I32 sawplus = 0;
5200     I32 sawopen = 0;
5201     bool used_setjump = FALSE;
5202     regex_charset initial_charset = get_regex_charset(orig_rx_flags);
5203     bool code_is_utf8 = 0;
5204     bool VOL recompile = 0;
5205     bool runtime_code = 0;
5206     U8 jump_ret = 0;
5207     dJMPENV;
5208     scan_data_t data;
5209     RExC_state_t RExC_state;
5210     RExC_state_t * const pRExC_state = &RExC_state;
5211 #ifdef TRIE_STUDY_OPT    
5212     int restudied;
5213     RExC_state_t copyRExC_state;
5214 #endif    
5215     GET_RE_DEBUG_FLAGS_DECL;
5216
5217     PERL_ARGS_ASSERT_RE_OP_COMPILE;
5218
5219     DEBUG_r(if (!PL_colorset) reginitcolors());
5220
5221 #ifndef PERL_IN_XSUB_RE
5222     /* Initialize these here instead of as-needed, as is quick and avoids
5223      * having to test them each time otherwise */
5224     if (! PL_AboveLatin1) {
5225         PL_AboveLatin1 = _new_invlist_C_array(AboveLatin1_invlist);
5226         PL_ASCII = _new_invlist_C_array(ASCII_invlist);
5227         PL_Latin1 = _new_invlist_C_array(Latin1_invlist);
5228
5229         PL_L1Posix_ptrs[_CC_ALPHANUMERIC]
5230                                 = _new_invlist_C_array(L1PosixAlnum_invlist);
5231         PL_Posix_ptrs[_CC_ALPHANUMERIC]
5232                                 = _new_invlist_C_array(PosixAlnum_invlist);
5233
5234         PL_L1Posix_ptrs[_CC_ALPHA]
5235                                 = _new_invlist_C_array(L1PosixAlpha_invlist);
5236         PL_Posix_ptrs[_CC_ALPHA] = _new_invlist_C_array(PosixAlpha_invlist);
5237
5238         PL_Posix_ptrs[_CC_BLANK] = _new_invlist_C_array(PosixBlank_invlist);
5239         PL_XPosix_ptrs[_CC_BLANK] = _new_invlist_C_array(XPosixBlank_invlist);
5240
5241         /* Cased is the same as Alpha in the ASCII range */
5242         PL_L1Posix_ptrs[_CC_CASED] =  _new_invlist_C_array(L1Cased_invlist);
5243         PL_Posix_ptrs[_CC_CASED] =  _new_invlist_C_array(PosixAlpha_invlist);
5244
5245         PL_Posix_ptrs[_CC_CNTRL] = _new_invlist_C_array(PosixCntrl_invlist);
5246         PL_XPosix_ptrs[_CC_CNTRL] = _new_invlist_C_array(XPosixCntrl_invlist);
5247
5248         PL_Posix_ptrs[_CC_DIGIT] = _new_invlist_C_array(PosixDigit_invlist);
5249         PL_L1Posix_ptrs[_CC_DIGIT] = _new_invlist_C_array(PosixDigit_invlist);
5250
5251         PL_L1Posix_ptrs[_CC_GRAPH] = _new_invlist_C_array(L1PosixGraph_invlist);
5252         PL_Posix_ptrs[_CC_GRAPH] = _new_invlist_C_array(PosixGraph_invlist);
5253
5254         PL_L1Posix_ptrs[_CC_LOWER] = _new_invlist_C_array(L1PosixLower_invlist);
5255         PL_Posix_ptrs[_CC_LOWER] = _new_invlist_C_array(PosixLower_invlist);
5256
5257         PL_L1Posix_ptrs[_CC_PRINT] = _new_invlist_C_array(L1PosixPrint_invlist);
5258         PL_Posix_ptrs[_CC_PRINT] = _new_invlist_C_array(PosixPrint_invlist);
5259
5260         PL_L1Posix_ptrs[_CC_PUNCT] = _new_invlist_C_array(L1PosixPunct_invlist);
5261         PL_Posix_ptrs[_CC_PUNCT] = _new_invlist_C_array(PosixPunct_invlist);
5262
5263         PL_Posix_ptrs[_CC_SPACE] = _new_invlist_C_array(PerlSpace_invlist);
5264         PL_XPosix_ptrs[_CC_SPACE] = _new_invlist_C_array(XPerlSpace_invlist);
5265         PL_Posix_ptrs[_CC_PSXSPC] = _new_invlist_C_array(PosixSpace_invlist);
5266         PL_XPosix_ptrs[_CC_PSXSPC] = _new_invlist_C_array(XPosixSpace_invlist);
5267
5268         PL_L1Posix_ptrs[_CC_UPPER] = _new_invlist_C_array(L1PosixUpper_invlist);
5269         PL_Posix_ptrs[_CC_UPPER] = _new_invlist_C_array(PosixUpper_invlist);
5270
5271         PL_XPosix_ptrs[_CC_VERTSPACE] = _new_invlist_C_array(VertSpace_invlist);
5272
5273         PL_Posix_ptrs[_CC_WORDCHAR] = _new_invlist_C_array(PosixWord_invlist);
5274         PL_L1Posix_ptrs[_CC_WORDCHAR]
5275                                 = _new_invlist_C_array(L1PosixWord_invlist);
5276
5277         PL_Posix_ptrs[_CC_XDIGIT] = _new_invlist_C_array(PosixXDigit_invlist);
5278         PL_XPosix_ptrs[_CC_XDIGIT] = _new_invlist_C_array(XPosixXDigit_invlist);
5279
5280         PL_HasMultiCharFold = _new_invlist_C_array(_Perl_Multi_Char_Folds_invlist);
5281     }
5282 #endif
5283
5284     pRExC_state->code_blocks = NULL;
5285     pRExC_state->num_code_blocks = 0;
5286
5287     if (is_bare_re)
5288         *is_bare_re = FALSE;
5289
5290     if (expr && (expr->op_type == OP_LIST ||
5291                 (expr->op_type == OP_NULL && expr->op_targ == OP_LIST))) {
5292
5293         /* is the source UTF8, and how many code blocks are there? */
5294         OP *o;
5295         int ncode = 0;
5296
5297         for (o = cLISTOPx(expr)->op_first; o; o = o->op_sibling) {
5298             if (o->op_type == OP_CONST && SvUTF8(cSVOPo_sv))
5299                 code_is_utf8 = 1;
5300             else if (o->op_type == OP_NULL && (o->op_flags & OPf_SPECIAL))
5301                 /* count of DO blocks */
5302                 ncode++;
5303         }
5304         if (ncode) {
5305             pRExC_state->num_code_blocks = ncode;
5306             Newx(pRExC_state->code_blocks, ncode, struct reg_code_block);
5307         }
5308     }
5309
5310     if (pat_count) {
5311         /* handle a list of SVs */
5312
5313         SV **svp;
5314
5315         /* apply magic and RE overloading to each arg */
5316         for (svp = patternp; svp < patternp + pat_count; svp++) {
5317             SV *rx = *svp;
5318             SvGETMAGIC(rx);
5319             if (SvROK(rx) && SvAMAGIC(rx)) {
5320                 SV *sv = AMG_CALLunary(rx, regexp_amg);
5321                 if (sv) {
5322                     if (SvROK(sv))
5323                         sv = SvRV(sv);
5324                     if (SvTYPE(sv) != SVt_REGEXP)
5325                         Perl_croak(aTHX_ "Overloaded qr did not return a REGEXP");
5326                     *svp = sv;
5327                 }
5328             }
5329         }
5330
5331         if (pat_count > 1) {
5332             /* concat multiple args and find any code block indexes */
5333
5334             OP *o = NULL;
5335             int n = 0;
5336             bool utf8 = 0;
5337             STRLEN orig_patlen = 0;
5338
5339             if (pRExC_state->num_code_blocks) {
5340                 o = cLISTOPx(expr)->op_first;
5341                 assert(   o->op_type == OP_PUSHMARK
5342                        || (o->op_type == OP_NULL && o->op_targ == OP_PUSHMARK)
5343                        || o->op_type == OP_PADRANGE);
5344                 o = o->op_sibling;
5345             }
5346
5347             pat = newSVpvn("", 0);
5348             SAVEFREESV(pat);
5349
5350             /* determine if the pattern is going to be utf8 (needed
5351              * in advance to align code block indices correctly).
5352              * XXX This could fail to be detected for an arg with
5353              * overloading but not concat overloading; but the main effect
5354              * in this obscure case is to need a 'use re eval' for a
5355              * literal code block */
5356             for (svp = patternp; svp < patternp + pat_count; svp++) {
5357                 if (SvUTF8(*svp))
5358                     utf8 = 1;
5359             }
5360             if (utf8)
5361                 SvUTF8_on(pat);
5362
5363             for (svp = patternp; svp < patternp + pat_count; svp++) {
5364                 SV *sv, *msv = *svp;
5365                 SV *rx;
5366                 bool code = 0;
5367                 /* we make the assumption here that each op in the list of
5368                  * op_siblings maps to one SV pushed onto the stack,
5369                  * except for code blocks, with have both an OP_NULL and
5370                  * and OP_CONST.
5371                  * This allows us to match up the list of SVs against the
5372                  * list of OPs to find the next code block.
5373                  *
5374                  * Note that       PUSHMARK PADSV PADSV ..
5375                  * is optimised to
5376                  *                 PADRANGE NULL  NULL  ..
5377                  * so the alignment still works. */
5378                 if (o) {
5379                     if (o->op_type == OP_NULL && (o->op_flags & OPf_SPECIAL)) {
5380                         assert(n < pRExC_state->num_code_blocks);
5381                         pRExC_state->code_blocks[n].start = SvCUR(pat);
5382                         pRExC_state->code_blocks[n].block = o;
5383                         pRExC_state->code_blocks[n].src_regex = NULL;
5384                         n++;
5385                         code = 1;
5386                         o = o->op_sibling; /* skip CONST */
5387                         assert(o);
5388                     }
5389                     o = o->op_sibling;;
5390                 }
5391
5392                 if ((SvAMAGIC(pat) || SvAMAGIC(msv)) &&
5393                         (sv = amagic_call(pat, msv, concat_amg, AMGf_assign)))
5394                 {
5395                     sv_setsv(pat, sv);
5396                     /* overloading involved: all bets are off over literal
5397                      * code. Pretend we haven't seen it */
5398                     pRExC_state->num_code_blocks -= n;
5399                     n = 0;
5400                     rx = NULL;
5401
5402                 }
5403                 else  {
5404                     while (SvAMAGIC(msv)
5405                             && (sv = AMG_CALLunary(msv, string_amg))
5406                             && sv != msv
5407                             &&  !(   SvROK(msv)
5408                                   && SvROK(sv)
5409                                   && SvRV(msv) == SvRV(sv))
5410                     ) {
5411                         msv = sv;
5412                         SvGETMAGIC(msv);
5413                     }
5414                     if (SvROK(msv) && SvTYPE(SvRV(msv)) == SVt_REGEXP)
5415                         msv = SvRV(msv);
5416                     orig_patlen = SvCUR(pat);
5417                     sv_catsv_nomg(pat, msv);
5418                     rx = msv;
5419                     if (code)
5420                         pRExC_state->code_blocks[n-1].end = SvCUR(pat)-1;
5421                 }
5422
5423                 /* extract any code blocks within any embedded qr//'s */
5424                 if (rx && SvTYPE(rx) == SVt_REGEXP
5425                     && RX_ENGINE((REGEXP*)rx)->op_comp)
5426                 {
5427
5428                     RXi_GET_DECL(ReANY((REGEXP *)rx), ri);
5429                     if (ri->num_code_blocks) {
5430                         int i;
5431                         /* the presence of an embedded qr// with code means
5432                          * we should always recompile: the text of the
5433                          * qr// may not have changed, but it may be a
5434                          * different closure than last time */
5435                         recompile = 1;
5436                         Renew(pRExC_state->code_blocks,
5437                             pRExC_state->num_code_blocks + ri->num_code_blocks,
5438                             struct reg_code_block);
5439                         pRExC_state->num_code_blocks += ri->num_code_blocks;
5440                         for (i=0; i < ri->num_code_blocks; i++) {
5441                             struct reg_code_block *src, *dst;
5442                             STRLEN offset =  orig_patlen
5443                                 + ReANY((REGEXP *)rx)->pre_prefix;
5444                             assert(n < pRExC_state->num_code_blocks);
5445                             src = &ri->code_blocks[i];
5446                             dst = &pRExC_state->code_blocks[n];
5447                             dst->start      = src->start + offset;
5448                             dst->end        = src->end   + offset;
5449                             dst->block      = src->block;
5450                             dst->src_regex  = (REGEXP*) SvREFCNT_inc( (SV*)
5451                                                     src->src_regex
5452                                                         ? src->src_regex
5453                                                         : (REGEXP*)rx);
5454                             n++;
5455                         }
5456                     }
5457                 }
5458             }
5459             SvSETMAGIC(pat);
5460         }
5461         else {
5462             SV *sv;
5463             pat = *patternp;
5464             while (SvAMAGIC(pat)
5465                     && (sv = AMG_CALLunary(pat, string_amg))
5466                     && sv != pat)
5467             {
5468                 pat = sv;
5469                 SvGETMAGIC(pat);
5470             }
5471         }
5472
5473         /* handle bare regex: foo =~ $re */
5474         {
5475             SV *re = pat;
5476             if (SvROK(re))
5477                 re = SvRV(re);
5478             if (SvTYPE(re) == SVt_REGEXP) {
5479                 if (is_bare_re)
5480                     *is_bare_re = TRUE;
5481                 SvREFCNT_inc(re);
5482                 Safefree(pRExC_state->code_blocks);
5483                 return (REGEXP*)re;
5484             }
5485         }
5486     }
5487     else {
5488         /* not a list of SVs, so must be a list of OPs */
5489         assert(expr);
5490         if (expr->op_type == OP_LIST) {
5491             int i = -1;
5492             bool is_code = 0;
5493             OP *o;
5494
5495             pat = newSVpvn("", 0);
5496             SAVEFREESV(pat);
5497             if (code_is_utf8)
5498                 SvUTF8_on(pat);
5499
5500             /* given a list of CONSTs and DO blocks in expr, append all
5501              * the CONSTs to pat, and record the start and end of each
5502              * code block in code_blocks[] (each DO{} op is followed by an
5503              * OP_CONST containing the corresponding literal '(?{...})
5504              * text)
5505              */
5506             for (o = cLISTOPx(expr)->op_first; o; o = o->op_sibling) {
5507                 if (o->op_type == OP_CONST) {
5508                     sv_catsv(pat, cSVOPo_sv);
5509                     if (is_code) {
5510                         pRExC_state->code_blocks[i].end = SvCUR(pat)-1;
5511                         is_code = 0;
5512                     }
5513                 }
5514                 else if (o->op_type == OP_NULL && (o->op_flags & OPf_SPECIAL)) {
5515                     assert(i+1 < pRExC_state->num_code_blocks);
5516                     pRExC_state->code_blocks[++i].start = SvCUR(pat);
5517                     pRExC_state->code_blocks[i].block = o;
5518                     pRExC_state->code_blocks[i].src_regex = NULL;
5519                     is_code = 1;
5520                 }
5521             }
5522         }
5523         else {
5524             assert(expr->op_type == OP_CONST);
5525             pat = cSVOPx_sv(expr);
5526         }
5527     }
5528
5529     exp = SvPV_nomg(pat, plen);
5530
5531     if (!eng->op_comp) {
5532         if ((SvUTF8(pat) && IN_BYTES)
5533                 || SvGMAGICAL(pat) || SvAMAGIC(pat))
5534         {
5535             /* make a temporary copy; either to convert to bytes,
5536              * or to avoid repeating get-magic / overloaded stringify */
5537             pat = newSVpvn_flags(exp, plen, SVs_TEMP |
5538                                         (IN_BYTES ? 0 : SvUTF8(pat)));
5539         }
5540         Safefree(pRExC_state->code_blocks);
5541         return CALLREGCOMP_ENG(eng, pat, orig_rx_flags);
5542     }
5543
5544     /* ignore the utf8ness if the pattern is 0 length */
5545     RExC_utf8 = RExC_orig_utf8 = (plen == 0 || IN_BYTES) ? 0 : SvUTF8(pat);
5546     RExC_uni_semantics = 0;
5547     RExC_contains_locale = 0;
5548     pRExC_state->runtime_code_qr = NULL;
5549
5550     /****************** LONG JUMP TARGET HERE***********************/
5551     /* Longjmp back to here if have to switch in midstream to utf8 */
5552     if (! RExC_orig_utf8) {
5553         JMPENV_PUSH(jump_ret);
5554         used_setjump = TRUE;
5555     }
5556
5557     if (jump_ret == 0) {    /* First time through */
5558         xend = exp + plen;
5559
5560         DEBUG_COMPILE_r({
5561             SV *dsv= sv_newmortal();
5562             RE_PV_QUOTED_DECL(s, RExC_utf8,
5563                 dsv, exp, plen, 60);
5564             PerlIO_printf(Perl_debug_log, "%sCompiling REx%s %s\n",
5565                            PL_colors[4],PL_colors[5],s);
5566         });
5567     }
5568     else {  /* longjumped back */
5569         U8 *src, *dst;
5570         int n=0;
5571         STRLEN s = 0, d = 0;
5572         bool do_end = 0;
5573
5574         /* If the cause for the longjmp was other than changing to utf8, pop
5575          * our own setjmp, and longjmp to the correct handler */
5576         if (jump_ret != UTF8_LONGJMP) {
5577             JMPENV_POP;
5578             JMPENV_JUMP(jump_ret);
5579         }
5580
5581         GET_RE_DEBUG_FLAGS;
5582
5583         /* It's possible to write a regexp in ascii that represents Unicode
5584         codepoints outside of the byte range, such as via \x{100}. If we
5585         detect such a sequence we have to convert the entire pattern to utf8
5586         and then recompile, as our sizing calculation will have been based
5587         on 1 byte == 1 character, but we will need to use utf8 to encode
5588         at least some part of the pattern, and therefore must convert the whole
5589         thing.
5590         -- dmq */
5591         DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log,
5592             "UTF8 mismatch! Converting to utf8 for resizing and compile\n"));
5593
5594         /* upgrade pattern to UTF8, and if there are code blocks,
5595          * recalculate the indices.
5596          * This is essentially an unrolled Perl_bytes_to_utf8() */
5597
5598         src = (U8*)SvPV_nomg(pat, plen);
5599         Newx(dst, plen * 2 + 1, U8);
5600
5601         while (s < plen) {
5602             const UV uv = NATIVE_TO_ASCII(src[s]);
5603             if (UNI_IS_INVARIANT(uv))
5604                 dst[d]   = (U8)UTF_TO_NATIVE(uv);
5605             else {
5606                 dst[d++] = (U8)UTF8_EIGHT_BIT_HI(uv);
5607                 dst[d]   = (U8)UTF8_EIGHT_BIT_LO(uv);
5608             }
5609             if (n < pRExC_state->num_code_blocks) {
5610                 if (!do_end && pRExC_state->code_blocks[n].start == s) {
5611                     pRExC_state->code_blocks[n].start = d;
5612                     assert(dst[d] == '(');
5613                     do_end = 1;
5614                 }
5615                 else if (do_end && pRExC_state->code_blocks[n].end == s) {
5616                     pRExC_state->code_blocks[n].end = d;
5617                     assert(dst[d] == ')');
5618                     do_end = 0;
5619                     n++;
5620                 }
5621             }
5622             s++;
5623             d++;
5624         }
5625         dst[d] = '\0';
5626         plen = d;
5627         exp = (char*) dst;
5628         xend = exp + plen;
5629         SAVEFREEPV(exp);
5630         RExC_orig_utf8 = RExC_utf8 = 1;
5631     }
5632
5633     /* return old regex if pattern hasn't changed */
5634
5635     if (   old_re
5636         && !recompile
5637         && !!RX_UTF8(old_re) == !!RExC_utf8
5638         && RX_PRECOMP(old_re)
5639         && RX_PRELEN(old_re) == plen
5640         && memEQ(RX_PRECOMP(old_re), exp, plen))
5641     {
5642         /* with runtime code, always recompile */
5643         runtime_code = S_has_runtime_code(aTHX_ pRExC_state, expr, pm_flags,
5644                                             exp, plen);
5645         if (!runtime_code) {
5646             if (used_setjump) {
5647                 JMPENV_POP;
5648             }
5649             Safefree(pRExC_state->code_blocks);
5650             return old_re;
5651         }
5652     }
5653     else if ((pm_flags & PMf_USE_RE_EVAL)
5654                 /* this second condition covers the non-regex literal case,
5655                  * i.e.  $foo =~ '(?{})'. */
5656                 || ( !PL_reg_state.re_reparsing && IN_PERL_COMPILETIME
5657                     && (PL_hints & HINT_RE_EVAL))
5658     )
5659         runtime_code = S_has_runtime_code(aTHX_ pRExC_state, expr, pm_flags,
5660                             exp, plen);
5661
5662 #ifdef TRIE_STUDY_OPT
5663     restudied = 0;
5664 #endif
5665
5666     rx_flags = orig_rx_flags;
5667
5668     if (initial_charset == REGEX_LOCALE_CHARSET) {
5669         RExC_contains_locale = 1;
5670     }
5671     else if (RExC_utf8 && initial_charset == REGEX_DEPENDS_CHARSET) {
5672
5673         /* Set to use unicode semantics if the pattern is in utf8 and has the
5674          * 'depends' charset specified, as it means unicode when utf8  */
5675         set_regex_charset(&rx_flags, REGEX_UNICODE_CHARSET);
5676     }
5677
5678     RExC_precomp = exp;
5679     RExC_flags = rx_flags;
5680     RExC_pm_flags = pm_flags;
5681
5682     if (runtime_code) {
5683         if (TAINTING_get && TAINT_get)
5684             Perl_croak(aTHX_ "Eval-group in insecure regular expression");
5685
5686         if (!S_compile_runtime_code(aTHX_ pRExC_state, exp, plen)) {
5687             /* whoops, we have a non-utf8 pattern, whilst run-time code
5688              * got compiled as utf8. Try again with a utf8 pattern */
5689              JMPENV_JUMP(UTF8_LONGJMP);
5690         }
5691     }
5692     assert(!pRExC_state->runtime_code_qr);
5693
5694     RExC_sawback = 0;
5695
5696     RExC_seen = 0;
5697     RExC_in_lookbehind = 0;
5698     RExC_seen_zerolen = *exp == '^' ? -1 : 0;
5699     RExC_extralen = 0;
5700     RExC_override_recoding = 0;
5701     RExC_in_multi_char_class = 0;
5702
5703     /* First pass: determine size, legality. */
5704     RExC_parse = exp;
5705     RExC_start = exp;
5706     RExC_end = xend;
5707     RExC_naughty = 0;
5708     RExC_npar = 1;
5709     RExC_nestroot = 0;
5710     RExC_size = 0L;
5711     RExC_emit = &PL_regdummy;
5712     RExC_whilem_seen = 0;
5713     RExC_open_parens = NULL;
5714     RExC_close_parens = NULL;
5715     RExC_opend = NULL;
5716     RExC_paren_names = NULL;
5717 #ifdef DEBUGGING
5718     RExC_paren_name_list = NULL;
5719 #endif
5720     RExC_recurse = NULL;
5721     RExC_recurse_count = 0;
5722     pRExC_state->code_index = 0;
5723
5724 #if 0 /* REGC() is (currently) a NOP at the first pass.
5725        * Clever compilers notice this and complain. --jhi */
5726     REGC((U8)REG_MAGIC, (char*)RExC_emit);
5727 #endif
5728     DEBUG_PARSE_r(
5729         PerlIO_printf(Perl_debug_log, "Starting first pass (sizing)\n");
5730         RExC_lastnum=0;
5731         RExC_lastparse=NULL;
5732     );
5733     /* reg may croak on us, not giving us a chance to free
5734        pRExC_state->code_blocks.  We cannot SAVEFREEPV it now, as we may
5735        need it to survive as long as the regexp (qr/(?{})/).
5736        We must check that code_blocksv is not already set, because we may
5737        have longjmped back. */
5738     if (pRExC_state->code_blocks && !code_blocksv) {
5739         code_blocksv = newSV_type(SVt_PV);
5740         SAVEFREESV(code_blocksv);
5741         SvPV_set(code_blocksv, (char *)pRExC_state->code_blocks);
5742         SvLEN_set(code_blocksv, 1); /*sufficient to make sv_clear free it*/
5743     }
5744     if (reg(pRExC_state, 0, &flags,1) == NULL) {
5745         RExC_precomp = NULL;
5746         return(NULL);
5747     }
5748     if (code_blocksv)
5749         SvLEN_set(code_blocksv,0); /* no you can't have it, sv_clear */
5750
5751     /* Here, finished first pass.  Get rid of any added setjmp */
5752     if (used_setjump) {
5753         JMPENV_POP;
5754     }
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     if (pm_flags & PMf_IS_QR) {
5803         ri->code_blocks = pRExC_state->code_blocks;
5804         ri->num_code_blocks = pRExC_state->num_code_blocks;
5805     }
5806     else
5807     {
5808         int n;
5809         for (n = 0; n < pRExC_state->num_code_blocks; n++)
5810             if (pRExC_state->code_blocks[n].src_regex)
5811                 SAVEFREESV(pRExC_state->code_blocks[n].src_regex);
5812         SAVEFREEPV(pRExC_state->code_blocks);
5813     }
5814
5815     {
5816         bool has_p     = ((r->extflags & RXf_PMf_KEEPCOPY) == RXf_PMf_KEEPCOPY);
5817         bool has_charset = (get_regex_charset(r->extflags) != REGEX_DEPENDS_CHARSET);
5818
5819         /* The caret is output if there are any defaults: if not all the STD
5820          * flags are set, or if no character set specifier is needed */
5821         bool has_default =
5822                     (((r->extflags & RXf_PMf_STD_PMMOD) != RXf_PMf_STD_PMMOD)
5823                     || ! has_charset);
5824         bool has_runon = ((RExC_seen & REG_SEEN_RUN_ON_COMMENT)==REG_SEEN_RUN_ON_COMMENT);
5825         U16 reganch = (U16)((r->extflags & RXf_PMf_STD_PMMOD)
5826                             >> RXf_PMf_STD_PMMOD_SHIFT);
5827         const char *fptr = STD_PAT_MODS;        /*"msix"*/
5828         char *p;
5829         /* Allocate for the worst case, which is all the std flags are turned
5830          * on.  If more precision is desired, we could do a population count of
5831          * the flags set.  This could be done with a small lookup table, or by
5832          * shifting, masking and adding, or even, when available, assembly
5833          * language for a machine-language population count.
5834          * We never output a minus, as all those are defaults, so are
5835          * covered by the caret */
5836         const STRLEN wraplen = plen + has_p + has_runon
5837             + has_default       /* If needs a caret */
5838
5839                 /* If needs a character set specifier */
5840             + ((has_charset) ? MAX_CHARSET_NAME_LENGTH : 0)
5841             + (sizeof(STD_PAT_MODS) - 1)
5842             + (sizeof("(?:)") - 1);
5843
5844         Newx(p, wraplen + 1, char); /* +1 for the ending NUL */
5845         r->xpv_len_u.xpvlenu_pv = p;
5846         if (RExC_utf8)
5847             SvFLAGS(rx) |= SVf_UTF8;
5848         *p++='('; *p++='?';
5849
5850         /* If a default, cover it using the caret */
5851         if (has_default) {
5852             *p++= DEFAULT_PAT_MOD;
5853         }
5854         if (has_charset) {
5855             STRLEN len;
5856             const char* const name = get_regex_charset_name(r->extflags, &len);
5857             Copy(name, p, len, char);
5858             p += len;
5859         }
5860         if (has_p)
5861             *p++ = KEEPCOPY_PAT_MOD; /*'p'*/
5862         {
5863             char ch;
5864             while((ch = *fptr++)) {
5865                 if(reganch & 1)
5866                     *p++ = ch;
5867                 reganch >>= 1;
5868             }
5869         }
5870
5871         *p++ = ':';
5872         Copy(RExC_precomp, p, plen, char);
5873         assert ((RX_WRAPPED(rx) - p) < 16);
5874         r->pre_prefix = p - RX_WRAPPED(rx);
5875         p += plen;
5876         if (has_runon)
5877             *p++ = '\n';
5878         *p++ = ')';
5879         *p = 0;
5880         SvCUR_set(rx, p - RX_WRAPPED(rx));
5881     }
5882
5883     r->intflags = 0;
5884     r->nparens = RExC_npar - 1; /* set early to validate backrefs */
5885     
5886     if (RExC_seen & REG_SEEN_RECURSE) {
5887         Newxz(RExC_open_parens, RExC_npar,regnode *);
5888         SAVEFREEPV(RExC_open_parens);
5889         Newxz(RExC_close_parens,RExC_npar,regnode *);
5890         SAVEFREEPV(RExC_close_parens);
5891     }
5892
5893     /* Useful during FAIL. */
5894 #ifdef RE_TRACK_PATTERN_OFFSETS
5895     Newxz(ri->u.offsets, 2*RExC_size+1, U32); /* MJD 20001228 */
5896     DEBUG_OFFSETS_r(PerlIO_printf(Perl_debug_log,
5897                           "%s %"UVuf" bytes for offset annotations.\n",
5898                           ri->u.offsets ? "Got" : "Couldn't get",
5899                           (UV)((2*RExC_size+1) * sizeof(U32))));
5900 #endif
5901     SetProgLen(ri,RExC_size);
5902     RExC_rx_sv = rx;
5903     RExC_rx = r;
5904     RExC_rxi = ri;
5905     REH_CALL_COMP_BEGIN_HOOK(pRExC_state->rx);
5906
5907     /* Second pass: emit code. */
5908     RExC_flags = rx_flags;      /* don't let top level (?i) bleed */
5909     RExC_pm_flags = pm_flags;
5910     RExC_parse = exp;
5911     RExC_end = xend;
5912     RExC_naughty = 0;
5913     RExC_npar = 1;
5914     RExC_emit_start = ri->program;
5915     RExC_emit = ri->program;
5916     RExC_emit_bound = ri->program + RExC_size + 1;
5917     pRExC_state->code_index = 0;
5918
5919     REGC((U8)REG_MAGIC, (char*) RExC_emit++);
5920     if (reg(pRExC_state, 0, &flags,1) == NULL) {
5921         ReREFCNT_dec(rx);   
5922         return(NULL);
5923     }
5924     /* XXXX To minimize changes to RE engine we always allocate
5925        3-units-long substrs field. */
5926     Newx(r->substrs, 1, struct reg_substr_data);
5927     if (RExC_recurse_count) {
5928         Newxz(RExC_recurse,RExC_recurse_count,regnode *);
5929         SAVEFREEPV(RExC_recurse);
5930     }
5931
5932 reStudy:
5933     r->minlen = minlen = sawlookahead = sawplus = sawopen = 0;
5934     Zero(r->substrs, 1, struct reg_substr_data);
5935
5936 #ifdef TRIE_STUDY_OPT
5937     if (!restudied) {
5938         StructCopy(&zero_scan_data, &data, scan_data_t);
5939         copyRExC_state = RExC_state;
5940     } else {
5941         U32 seen=RExC_seen;
5942         DEBUG_OPTIMISE_r(PerlIO_printf(Perl_debug_log,"Restudying\n"));
5943         
5944         RExC_state = copyRExC_state;
5945         if (seen & REG_TOP_LEVEL_BRANCHES) 
5946             RExC_seen |= REG_TOP_LEVEL_BRANCHES;
5947         else
5948             RExC_seen &= ~REG_TOP_LEVEL_BRANCHES;
5949         StructCopy(&zero_scan_data, &data, scan_data_t);
5950     }
5951 #else
5952     StructCopy(&zero_scan_data, &data, scan_data_t);
5953 #endif    
5954
5955     /* Dig out information for optimizations. */
5956     r->extflags = RExC_flags; /* was pm_op */
5957     /*dmq: removed as part of de-PMOP: pm->op_pmflags = RExC_flags; */
5958  
5959     if (UTF)
5960         SvUTF8_on(rx);  /* Unicode in it? */
5961     ri->regstclass = NULL;
5962     if (RExC_naughty >= 10)     /* Probably an expensive pattern. */
5963         r->intflags |= PREGf_NAUGHTY;
5964     scan = ri->program + 1;             /* First BRANCH. */
5965
5966     /* testing for BRANCH here tells us whether there is "must appear"
5967        data in the pattern. If there is then we can use it for optimisations */
5968     if (!(RExC_seen & REG_TOP_LEVEL_BRANCHES)) { /*  Only one top-level choice. */
5969         I32 fake;
5970         STRLEN longest_float_length, longest_fixed_length;
5971         struct regnode_charclass_class ch_class; /* pointed to by data */
5972         int stclass_flag;
5973         I32 last_close = 0; /* pointed to by data */
5974         regnode *first= scan;
5975         regnode *first_next= regnext(first);
5976         /*
5977          * Skip introductions and multiplicators >= 1
5978          * so that we can extract the 'meat' of the pattern that must 
5979          * match in the large if() sequence following.
5980          * NOTE that EXACT is NOT covered here, as it is normally
5981          * picked up by the optimiser separately. 
5982          *
5983          * This is unfortunate as the optimiser isnt handling lookahead
5984          * properly currently.
5985          *
5986          */
5987         while ((OP(first) == OPEN && (sawopen = 1)) ||
5988                /* An OR of *one* alternative - should not happen now. */
5989             (OP(first) == BRANCH && OP(first_next) != BRANCH) ||
5990             /* for now we can't handle lookbehind IFMATCH*/
5991             (OP(first) == IFMATCH && !first->flags && (sawlookahead = 1)) ||
5992             (OP(first) == PLUS) ||
5993             (OP(first) == MINMOD) ||
5994                /* An {n,m} with n>0 */
5995             (PL_regkind[OP(first)] == CURLY && ARG1(first) > 0) ||
5996             (OP(first) == NOTHING && PL_regkind[OP(first_next)] != END ))
5997         {
5998                 /* 
5999                  * the only op that could be a regnode is PLUS, all the rest
6000                  * will be regnode_1 or regnode_2.
6001                  *
6002                  */
6003                 if (OP(first) == PLUS)
6004                     sawplus = 1;
6005                 else
6006                     first += regarglen[OP(first)];
6007
6008                 first = NEXTOPER(first);
6009                 first_next= regnext(first);
6010         }
6011
6012         /* Starting-point info. */
6013       again:
6014         DEBUG_PEEP("first:",first,0);
6015         /* Ignore EXACT as we deal with it later. */
6016         if (PL_regkind[OP(first)] == EXACT) {
6017             if (OP(first) == EXACT)
6018                 NOOP;   /* Empty, get anchored substr later. */
6019             else
6020                 ri->regstclass = first;
6021         }
6022 #ifdef TRIE_STCLASS
6023         else if (PL_regkind[OP(first)] == TRIE &&
6024                 ((reg_trie_data *)ri->data->data[ ARG(first) ])->minlen>0) 
6025         {
6026             regnode *trie_op;
6027             /* this can happen only on restudy */
6028             if ( OP(first) == TRIE ) {
6029                 struct regnode_1 *trieop = (struct regnode_1 *)
6030                     PerlMemShared_calloc(1, sizeof(struct regnode_1));
6031                 StructCopy(first,trieop,struct regnode_1);
6032                 trie_op=(regnode *)trieop;
6033             } else {
6034                 struct regnode_charclass *trieop = (struct regnode_charclass *)
6035                     PerlMemShared_calloc(1, sizeof(struct regnode_charclass));
6036                 StructCopy(first,trieop,struct regnode_charclass);
6037                 trie_op=(regnode *)trieop;
6038             }
6039             OP(trie_op)+=2;
6040             make_trie_failtable(pRExC_state, (regnode *)first, trie_op, 0);
6041             ri->regstclass = trie_op;
6042         }
6043 #endif
6044         else if (REGNODE_SIMPLE(OP(first)))
6045             ri->regstclass = first;
6046         else if (PL_regkind[OP(first)] == BOUND ||
6047                  PL_regkind[OP(first)] == NBOUND)
6048             ri->regstclass = first;
6049         else if (PL_regkind[OP(first)] == BOL) {
6050             r->extflags |= (OP(first) == MBOL
6051                            ? RXf_ANCH_MBOL
6052                            : (OP(first) == SBOL
6053                               ? RXf_ANCH_SBOL
6054                               : RXf_ANCH_BOL));
6055             first = NEXTOPER(first);
6056             goto again;
6057         }
6058         else if (OP(first) == GPOS) {
6059             r->extflags |= RXf_ANCH_GPOS;
6060             first = NEXTOPER(first);
6061             goto again;
6062         }
6063         else if ((!sawopen || !RExC_sawback) &&
6064             (OP(first) == STAR &&
6065             PL_regkind[OP(NEXTOPER(first))] == REG_ANY) &&
6066             !(r->extflags & RXf_ANCH) && !pRExC_state->num_code_blocks)
6067         {
6068             /* turn .* into ^.* with an implied $*=1 */
6069             const int type =
6070                 (OP(NEXTOPER(first)) == REG_ANY)
6071                     ? RXf_ANCH_MBOL
6072                     : RXf_ANCH_SBOL;
6073             r->extflags |= type;
6074             r->intflags |= PREGf_IMPLICIT;
6075             first = NEXTOPER(first);
6076             goto again;
6077         }
6078         if (sawplus && !sawlookahead && (!sawopen || !RExC_sawback)
6079             && !pRExC_state->num_code_blocks) /* May examine pos and $& */
6080             /* x+ must match at the 1st pos of run of x's */
6081             r->intflags |= PREGf_SKIP;
6082
6083         /* Scan is after the zeroth branch, first is atomic matcher. */
6084 #ifdef TRIE_STUDY_OPT
6085         DEBUG_PARSE_r(
6086             if (!restudied)
6087                 PerlIO_printf(Perl_debug_log, "first at %"IVdf"\n",
6088                               (IV)(first - scan + 1))
6089         );
6090 #else
6091         DEBUG_PARSE_r(
6092             PerlIO_printf(Perl_debug_log, "first at %"IVdf"\n",
6093                 (IV)(first - scan + 1))
6094         );
6095 #endif
6096
6097
6098         /*
6099         * If there's something expensive in the r.e., find the
6100         * longest literal string that must appear and make it the
6101         * regmust.  Resolve ties in favor of later strings, since
6102         * the regstart check works with the beginning of the r.e.
6103         * and avoiding duplication strengthens checking.  Not a
6104         * strong reason, but sufficient in the absence of others.
6105         * [Now we resolve ties in favor of the earlier string if
6106         * it happens that c_offset_min has been invalidated, since the
6107         * earlier string may buy us something the later one won't.]
6108         */
6109
6110         data.longest_fixed = newSVpvs("");
6111         data.longest_float = newSVpvs("");
6112         data.last_found = newSVpvs("");
6113         data.longest = &(data.longest_fixed);
6114         ENTER_with_name("study_chunk");
6115         SAVEFREESV(data.longest_fixed);
6116         SAVEFREESV(data.longest_float);
6117         SAVEFREESV(data.last_found);
6118         first = scan;
6119         if (!ri->regstclass) {
6120             cl_init(pRExC_state, &ch_class);
6121             data.start_class = &ch_class;
6122             stclass_flag = SCF_DO_STCLASS_AND;
6123         } else                          /* XXXX Check for BOUND? */
6124             stclass_flag = 0;
6125         data.last_closep = &last_close;
6126         
6127         minlen = study_chunk(pRExC_state, &first, &minlen, &fake, scan + RExC_size, /* Up to end */
6128             &data, -1, NULL, NULL,
6129             SCF_DO_SUBSTR | SCF_WHILEM_VISITED_POS | stclass_flag,0);
6130
6131
6132         CHECK_RESTUDY_GOTO_butfirst(LEAVE_with_name("study_chunk"));
6133
6134
6135         if ( RExC_npar == 1 && data.longest == &(data.longest_fixed)
6136              && data.last_start_min == 0 && data.last_end > 0
6137              && !RExC_seen_zerolen
6138              && !(RExC_seen & REG_SEEN_VERBARG)
6139              && (!(RExC_seen & REG_SEEN_GPOS) || (r->extflags & RXf_ANCH_GPOS)))
6140             r->extflags |= RXf_CHECK_ALL;
6141         scan_commit(pRExC_state, &data,&minlen,0);
6142
6143         longest_float_length = CHR_SVLEN(data.longest_float);
6144
6145         if (! ((SvCUR(data.longest_fixed)  /* ok to leave SvCUR */
6146                    && data.offset_fixed == data.offset_float_min
6147                    && SvCUR(data.longest_fixed) == SvCUR(data.longest_float)))
6148             && S_setup_longest (aTHX_ pRExC_state,
6149                                     data.longest_float,
6150                                     &(r->float_utf8),
6151                                     &(r->float_substr),
6152                                     &(r->float_end_shift),
6153                                     data.lookbehind_float,
6154                                     data.offset_float_min,
6155                                     data.minlen_float,
6156                                     longest_float_length,
6157                                     cBOOL(data.flags & SF_FL_BEFORE_EOL),
6158                                     cBOOL(data.flags & SF_FL_BEFORE_MEOL)))
6159         {
6160             r->float_min_offset = data.offset_float_min - data.lookbehind_float;
6161             r->float_max_offset = data.offset_float_max;
6162             if (data.offset_float_max < I32_MAX) /* Don't offset infinity */
6163                 r->float_max_offset -= data.lookbehind_float;
6164             SvREFCNT_inc_simple_void_NN(data.longest_float);
6165         }
6166         else {
6167             r->float_substr = r->float_utf8 = NULL;
6168             longest_float_length = 0;
6169         }
6170
6171         longest_fixed_length = CHR_SVLEN(data.longest_fixed);
6172
6173         if (S_setup_longest (aTHX_ pRExC_state,
6174                                 data.longest_fixed,
6175                                 &(r->anchored_utf8),
6176                                 &(r->anchored_substr),
6177                                 &(r->anchored_end_shift),
6178                                 data.lookbehind_fixed,
6179                                 data.offset_fixed,
6180                                 data.minlen_fixed,
6181                                 longest_fixed_length,
6182                                 cBOOL(data.flags & SF_FIX_BEFORE_EOL),
6183                                 cBOOL(data.flags & SF_FIX_BEFORE_MEOL)))
6184         {
6185             r->anchored_offset = data.offset_fixed - data.lookbehind_fixed;
6186             SvREFCNT_inc_simple_void_NN(data.longest_fixed);
6187         }
6188         else {
6189             r->anchored_substr = r->anchored_utf8 = NULL;
6190             longest_fixed_length = 0;
6191         }
6192         LEAVE_with_name("study_chunk");
6193
6194         if (ri->regstclass
6195             && (OP(ri->regstclass) == REG_ANY || OP(ri->regstclass) == SANY))
6196             ri->regstclass = NULL;
6197
6198         if ((!(r->anchored_substr || r->anchored_utf8) || r->anchored_offset)
6199             && stclass_flag
6200             && ! TEST_SSC_EOS(data.start_class)
6201             && !cl_is_anything(data.start_class))
6202         {
6203             const U32 n = add_data(pRExC_state, 1, "f");
6204             OP(data.start_class) = ANYOF_SYNTHETIC;
6205
6206             Newx(RExC_rxi->data->data[n], 1,
6207                 struct regnode_charclass_class);
6208             StructCopy(data.start_class,
6209                        (struct regnode_charclass_class*)RExC_rxi->data->data[n],
6210                        struct regnode_charclass_class);
6211             ri->regstclass = (regnode*)RExC_rxi->data->data[n];
6212             r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
6213             DEBUG_COMPILE_r({ SV *sv = sv_newmortal();
6214                       regprop(r, sv, (regnode*)data.start_class);
6215                       PerlIO_printf(Perl_debug_log,
6216                                     "synthetic stclass \"%s\".\n",
6217                                     SvPVX_const(sv));});
6218         }
6219
6220         /* A temporary algorithm prefers floated substr to fixed one to dig more info. */
6221         if (longest_fixed_length > longest_float_length) {
6222             r->check_end_shift = r->anchored_end_shift;
6223             r->check_substr = r->anchored_substr;
6224             r->check_utf8 = r->anchored_utf8;
6225             r->check_offset_min = r->check_offset_max = r->anchored_offset;
6226             if (r->extflags & RXf_ANCH_SINGLE)
6227                 r->extflags |= RXf_NOSCAN;
6228         }
6229         else {
6230             r->check_end_shift = r->float_end_shift;
6231             r->check_substr = r->float_substr;
6232             r->check_utf8 = r->float_utf8;
6233             r->check_offset_min = r->float_min_offset;
6234             r->check_offset_max = r->float_max_offset;
6235         }
6236         /* XXXX Currently intuiting is not compatible with ANCH_GPOS.
6237            This should be changed ASAP!  */
6238         if ((r->check_substr || r->check_utf8) && !(r->extflags & RXf_ANCH_GPOS)) {
6239             r->extflags |= RXf_USE_INTUIT;
6240             if (SvTAIL(r->check_substr ? r->check_substr : r->check_utf8))
6241                 r->extflags |= RXf_INTUIT_TAIL;
6242         }
6243         /* XXX Unneeded? dmq (shouldn't as this is handled elsewhere)
6244         if ( (STRLEN)minlen < longest_float_length )
6245             minlen= longest_float_length;
6246         if ( (STRLEN)minlen < longest_fixed_length )
6247             minlen= longest_fixed_length;     
6248         */
6249     }
6250     else {
6251         /* Several toplevels. Best we can is to set minlen. */
6252         I32 fake;
6253         struct regnode_charclass_class ch_class;
6254         I32 last_close = 0;
6255
6256         DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log, "\nMulti Top Level\n"));
6257
6258         scan = ri->program + 1;
6259         cl_init(pRExC_state, &ch_class);
6260         data.start_class = &ch_class;
6261         data.last_closep = &last_close;
6262
6263         
6264         minlen = study_chunk(pRExC_state, &scan, &minlen, &fake, scan + RExC_size,
6265             &data, -1, NULL, NULL, SCF_DO_STCLASS_AND|SCF_WHILEM_VISITED_POS,0);
6266         
6267         CHECK_RESTUDY_GOTO_butfirst(NOOP);
6268
6269         r->check_substr = r->check_utf8 = r->anchored_substr = r->anchored_utf8
6270                 = r->float_substr = r->float_utf8 = NULL;
6271
6272         if (! TEST_SSC_EOS(data.start_class)
6273             && !cl_is_anything(data.start_class))
6274         {
6275             const U32 n = add_data(pRExC_state, 1, "f");
6276             OP(data.start_class) = ANYOF_SYNTHETIC;
6277
6278             Newx(RExC_rxi->data->data[n], 1,
6279                 struct regnode_charclass_class);
6280             StructCopy(data.start_class,
6281                        (struct regnode_charclass_class*)RExC_rxi->data->data[n],
6282                        struct regnode_charclass_class);
6283             ri->regstclass = (regnode*)RExC_rxi->data->data[n];
6284             r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
6285             DEBUG_COMPILE_r({ SV* sv = sv_newmortal();
6286                       regprop(r, sv, (regnode*)data.start_class);
6287                       PerlIO_printf(Perl_debug_log,
6288                                     "synthetic stclass \"%s\".\n",
6289                                     SvPVX_const(sv));});
6290         }
6291     }
6292
6293     /* Guard against an embedded (?=) or (?<=) with a longer minlen than
6294        the "real" pattern. */
6295     DEBUG_OPTIMISE_r({
6296         PerlIO_printf(Perl_debug_log,"minlen: %"IVdf" r->minlen:%"IVdf"\n",
6297                       (IV)minlen, (IV)r->minlen);
6298     });
6299     r->minlenret = minlen;
6300     if (r->minlen < minlen) 
6301         r->minlen = minlen;
6302     
6303     if (RExC_seen & REG_SEEN_GPOS)
6304         r->extflags |= RXf_GPOS_SEEN;
6305     if (RExC_seen & REG_SEEN_LOOKBEHIND)
6306         r->extflags |= RXf_LOOKBEHIND_SEEN;
6307     if (pRExC_state->num_code_blocks)
6308         r->extflags |= RXf_EVAL_SEEN;
6309     if (RExC_seen & REG_SEEN_CANY)
6310         r->extflags |= RXf_CANY_SEEN;
6311     if (RExC_seen & REG_SEEN_VERBARG)
6312     {
6313         r->intflags |= PREGf_VERBARG_SEEN;
6314         r->extflags |= RXf_MODIFIES_VARS;
6315     }
6316     if (RExC_seen & REG_SEEN_CUTGROUP)
6317         r->intflags |= PREGf_CUTGROUP_SEEN;
6318     if (pm_flags & PMf_USE_RE_EVAL)
6319         r->intflags |= PREGf_USE_RE_EVAL;
6320     if (RExC_paren_names)
6321         RXp_PAREN_NAMES(r) = MUTABLE_HV(SvREFCNT_inc(RExC_paren_names));
6322     else
6323         RXp_PAREN_NAMES(r) = NULL;
6324
6325 #ifdef STUPID_PATTERN_CHECKS            
6326     if (RX_PRELEN(rx) == 0)
6327         r->extflags |= RXf_NULL;
6328     if (RX_PRELEN(rx) == 3 && memEQ("\\s+", RX_PRECOMP(rx), 3))
6329         r->extflags |= RXf_WHITE;
6330     else if (RX_PRELEN(rx) == 1 && RXp_PRECOMP(rx)[0] == '^')
6331         r->extflags |= RXf_START_ONLY;
6332 #else
6333     {
6334         regnode *first = ri->program + 1;
6335         U8 fop = OP(first);
6336
6337         if (PL_regkind[fop] == NOTHING && OP(NEXTOPER(first)) == END)
6338             r->extflags |= RXf_NULL;
6339         else if (PL_regkind[fop] == BOL && OP(NEXTOPER(first)) == END)
6340             r->extflags |= RXf_START_ONLY;
6341         else if (fop == PLUS && PL_regkind[OP(NEXTOPER(first))] == POSIXD && FLAGS(NEXTOPER(first)) == _CC_SPACE
6342                              && OP(regnext(first)) == END)
6343             r->extflags |= RXf_WHITE;    
6344     }
6345 #endif
6346 #ifdef DEBUGGING
6347     if (RExC_paren_names) {
6348         ri->name_list_idx = add_data( pRExC_state, 1, "a" );
6349         ri->data->data[ri->name_list_idx] = (void*)SvREFCNT_inc(RExC_paren_name_list);
6350     } else
6351 #endif
6352         ri->name_list_idx = 0;
6353
6354     if (RExC_recurse_count) {
6355         for ( ; RExC_recurse_count ; RExC_recurse_count-- ) {
6356             const regnode *scan = RExC_recurse[RExC_recurse_count-1];
6357             ARG2L_SET( scan, RExC_open_parens[ARG(scan)-1] - scan );
6358         }
6359     }
6360     Newxz(r->offs, RExC_npar, regexp_paren_pair);
6361     /* assume we don't need to swap parens around before we match */
6362
6363     DEBUG_DUMP_r({
6364         PerlIO_printf(Perl_debug_log,"Final program:\n");
6365         regdump(r);
6366     });
6367 #ifdef RE_TRACK_PATTERN_OFFSETS
6368     DEBUG_OFFSETS_r(if (ri->u.offsets) {
6369         const U32 len = ri->u.offsets[0];
6370         U32 i;
6371         GET_RE_DEBUG_FLAGS_DECL;
6372         PerlIO_printf(Perl_debug_log, "Offsets: [%"UVuf"]\n\t", (UV)ri->u.offsets[0]);
6373         for (i = 1; i <= len; i++) {
6374             if (ri->u.offsets[i*2-1] || ri->u.offsets[i*2])
6375                 PerlIO_printf(Perl_debug_log, "%"UVuf":%"UVuf"[%"UVuf"] ",
6376                 (UV)i, (UV)ri->u.offsets[i*2-1], (UV)ri->u.offsets[i*2]);
6377             }
6378         PerlIO_printf(Perl_debug_log, "\n");
6379     });
6380 #endif
6381
6382 #ifdef USE_ITHREADS
6383     /* under ithreads the ?pat? PMf_USED flag on the pmop is simulated
6384      * by setting the regexp SV to readonly-only instead. If the
6385      * pattern's been recompiled, the USEDness should remain. */
6386     if (old_re && SvREADONLY(old_re))
6387         SvREADONLY_on(rx);
6388 #endif
6389     return rx;
6390 }
6391
6392
6393 SV*
6394 Perl_reg_named_buff(pTHX_ REGEXP * const rx, SV * const key, SV * const value,
6395                     const U32 flags)
6396 {
6397     PERL_ARGS_ASSERT_REG_NAMED_BUFF;
6398
6399     PERL_UNUSED_ARG(value);
6400
6401     if (flags & RXapif_FETCH) {
6402         return reg_named_buff_fetch(rx, key, flags);
6403     } else if (flags & (RXapif_STORE | RXapif_DELETE | RXapif_CLEAR)) {
6404         Perl_croak_no_modify();
6405         return NULL;
6406     } else if (flags & RXapif_EXISTS) {
6407         return reg_named_buff_exists(rx, key, flags)
6408             ? &PL_sv_yes
6409             : &PL_sv_no;
6410     } else if (flags & RXapif_REGNAMES) {
6411         return reg_named_buff_all(rx, flags);
6412     } else if (flags & (RXapif_SCALAR | RXapif_REGNAMES_COUNT)) {
6413         return reg_named_buff_scalar(rx, flags);
6414     } else {
6415         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff", (int)flags);
6416         return NULL;
6417     }
6418 }
6419
6420 SV*
6421 Perl_reg_named_buff_iter(pTHX_ REGEXP * const rx, const SV * const lastkey,
6422                          const U32 flags)
6423 {
6424     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ITER;
6425     PERL_UNUSED_ARG(lastkey);
6426
6427     if (flags & RXapif_FIRSTKEY)
6428         return reg_named_buff_firstkey(rx, flags);
6429     else if (flags & RXapif_NEXTKEY)
6430         return reg_named_buff_nextkey(rx, flags);
6431     else {
6432         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_iter", (int)flags);
6433         return NULL;
6434     }
6435 }
6436
6437 SV*
6438 Perl_reg_named_buff_fetch(pTHX_ REGEXP * const r, SV * const namesv,
6439                           const U32 flags)
6440 {
6441     AV *retarray = NULL;
6442     SV *ret;
6443     struct regexp *const rx = ReANY(r);
6444
6445     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FETCH;
6446
6447     if (flags & RXapif_ALL)
6448         retarray=newAV();
6449
6450     if (rx && RXp_PAREN_NAMES(rx)) {
6451         HE *he_str = hv_fetch_ent( RXp_PAREN_NAMES(rx), namesv, 0, 0 );
6452         if (he_str) {
6453             IV i;
6454             SV* sv_dat=HeVAL(he_str);
6455             I32 *nums=(I32*)SvPVX(sv_dat);
6456             for ( i=0; i<SvIVX(sv_dat); i++ ) {
6457                 if ((I32)(rx->nparens) >= nums[i]
6458                     && rx->offs[nums[i]].start != -1
6459                     && rx->offs[nums[i]].end != -1)
6460                 {
6461                     ret = newSVpvs("");
6462                     CALLREG_NUMBUF_FETCH(r,nums[i],ret);
6463                     if (!retarray)
6464                         return ret;
6465                 } else {
6466                     if (retarray)
6467                         ret = newSVsv(&PL_sv_undef);
6468                 }
6469                 if (retarray)
6470                     av_push(retarray, ret);
6471             }
6472             if (retarray)
6473                 return newRV_noinc(MUTABLE_SV(retarray));
6474         }
6475     }
6476     return NULL;
6477 }
6478
6479 bool
6480 Perl_reg_named_buff_exists(pTHX_ REGEXP * const r, SV * const key,
6481                            const U32 flags)
6482 {
6483     struct regexp *const rx = ReANY(r);
6484
6485     PERL_ARGS_ASSERT_REG_NAMED_BUFF_EXISTS;
6486
6487     if (rx && RXp_PAREN_NAMES(rx)) {
6488         if (flags & RXapif_ALL) {
6489             return hv_exists_ent(RXp_PAREN_NAMES(rx), key, 0);
6490         } else {
6491             SV *sv = CALLREG_NAMED_BUFF_FETCH(r, key, flags);
6492             if (sv) {
6493                 SvREFCNT_dec_NN(sv);
6494                 return TRUE;
6495             } else {
6496                 return FALSE;
6497             }
6498         }
6499     } else {
6500         return FALSE;
6501     }
6502 }
6503
6504 SV*
6505 Perl_reg_named_buff_firstkey(pTHX_ REGEXP * const r, const U32 flags)
6506 {
6507     struct regexp *const rx = ReANY(r);
6508
6509     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FIRSTKEY;
6510
6511     if ( rx && RXp_PAREN_NAMES(rx) ) {
6512         (void)hv_iterinit(RXp_PAREN_NAMES(rx));
6513
6514         return CALLREG_NAMED_BUFF_NEXTKEY(r, NULL, flags & ~RXapif_FIRSTKEY);
6515     } else {
6516         return FALSE;
6517     }
6518 }
6519
6520 SV*
6521 Perl_reg_named_buff_nextkey(pTHX_ REGEXP * const r, const U32 flags)
6522 {
6523     struct regexp *const rx = ReANY(r);
6524     GET_RE_DEBUG_FLAGS_DECL;
6525
6526     PERL_ARGS_ASSERT_REG_NAMED_BUFF_NEXTKEY;
6527
6528     if (rx && RXp_PAREN_NAMES(rx)) {
6529         HV *hv = RXp_PAREN_NAMES(rx);
6530         HE *temphe;
6531         while ( (temphe = hv_iternext_flags(hv,0)) ) {
6532             IV i;
6533             IV parno = 0;
6534             SV* sv_dat = HeVAL(temphe);
6535             I32 *nums = (I32*)SvPVX(sv_dat);
6536             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
6537                 if ((I32)(rx->lastparen) >= nums[i] &&
6538                     rx->offs[nums[i]].start != -1 &&
6539                     rx->offs[nums[i]].end != -1)
6540                 {
6541                     parno = nums[i];
6542                     break;
6543                 }
6544             }
6545             if (parno || flags & RXapif_ALL) {
6546                 return newSVhek(HeKEY_hek(temphe));
6547             }
6548         }
6549     }
6550     return NULL;
6551 }
6552
6553 SV*
6554 Perl_reg_named_buff_scalar(pTHX_ REGEXP * const r, const U32 flags)
6555 {
6556     SV *ret;
6557     AV *av;
6558     I32 length;
6559     struct regexp *const rx = ReANY(r);
6560
6561     PERL_ARGS_ASSERT_REG_NAMED_BUFF_SCALAR;
6562
6563     if (rx && RXp_PAREN_NAMES(rx)) {
6564         if (flags & (RXapif_ALL | RXapif_REGNAMES_COUNT)) {
6565             return newSViv(HvTOTALKEYS(RXp_PAREN_NAMES(rx)));
6566         } else if (flags & RXapif_ONE) {
6567             ret = CALLREG_NAMED_BUFF_ALL(r, (flags | RXapif_REGNAMES));
6568             av = MUTABLE_AV(SvRV(ret));
6569             length = av_len(av);
6570             SvREFCNT_dec_NN(ret);
6571             return newSViv(length + 1);
6572         } else {
6573             Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_scalar", (int)flags);
6574             return NULL;
6575         }
6576     }
6577     return &PL_sv_undef;
6578 }
6579
6580 SV*
6581 Perl_reg_named_buff_all(pTHX_ REGEXP * const r, const U32 flags)
6582 {
6583     struct regexp *const rx = ReANY(r);
6584     AV *av = newAV();
6585
6586     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ALL;
6587
6588     if (rx && RXp_PAREN_NAMES(rx)) {
6589         HV *hv= RXp_PAREN_NAMES(rx);
6590         HE *temphe;
6591         (void)hv_iterinit(hv);
6592         while ( (temphe = hv_iternext_flags(hv,0)) ) {
6593             IV i;
6594             IV parno = 0;
6595             SV* sv_dat = HeVAL(temphe);
6596             I32 *nums = (I32*)SvPVX(sv_dat);
6597             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
6598                 if ((I32)(rx->lastparen) >= nums[i] &&
6599                     rx->offs[nums[i]].start != -1 &&
6600                     rx->offs[nums[i]].end != -1)
6601                 {
6602                     parno = nums[i];
6603                     break;
6604                 }
6605             }
6606             if (parno || flags & RXapif_ALL) {
6607                 av_push(av, newSVhek(HeKEY_hek(temphe)));
6608             }
6609         }
6610     }
6611
6612     return newRV_noinc(MUTABLE_SV(av));
6613 }
6614
6615 void
6616 Perl_reg_numbered_buff_fetch(pTHX_ REGEXP * const r, const I32 paren,
6617                              SV * const sv)
6618 {
6619     struct regexp *const rx = ReANY(r);
6620     char *s = NULL;
6621     I32 i = 0;
6622     I32 s1, t1;
6623     I32 n = paren;
6624
6625     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_FETCH;
6626         
6627     if ( (    n == RX_BUFF_IDX_CARET_PREMATCH
6628            || n == RX_BUFF_IDX_CARET_FULLMATCH
6629            || n == RX_BUFF_IDX_CARET_POSTMATCH
6630          )
6631          && !(rx->extflags & RXf_PMf_KEEPCOPY)
6632     )
6633         goto ret_undef;
6634
6635     if (!rx->subbeg)
6636         goto ret_undef;
6637
6638     if (n == RX_BUFF_IDX_CARET_FULLMATCH)
6639         /* no need to distinguish between them any more */
6640         n = RX_BUFF_IDX_FULLMATCH;
6641
6642     if ((n == RX_BUFF_IDX_PREMATCH || n == RX_BUFF_IDX_CARET_PREMATCH)
6643         && rx->offs[0].start != -1)
6644     {
6645         /* $`, ${^PREMATCH} */
6646         i = rx->offs[0].start;
6647         s = rx->subbeg;
6648     }
6649     else 
6650     if ((n == RX_BUFF_IDX_POSTMATCH || n == RX_BUFF_IDX_CARET_POSTMATCH)
6651         && rx->offs[0].end != -1)
6652     {
6653         /* $', ${^POSTMATCH} */
6654         s = rx->subbeg - rx->suboffset + rx->offs[0].end;
6655         i = rx->sublen + rx->suboffset - rx->offs[0].end;
6656     } 
6657     else
6658     if ( 0 <= n && n <= (I32)rx->nparens &&
6659         (s1 = rx->offs[n].start) != -1 &&
6660         (t1 = rx->offs[n].end) != -1)
6661     {
6662         /* $&, ${^MATCH},  $1 ... */
6663         i = t1 - s1;
6664         s = rx->subbeg + s1 - rx->suboffset;
6665     } else {
6666         goto ret_undef;
6667     }          
6668
6669     assert(s >= rx->subbeg);
6670     assert(rx->sublen >= (s - rx->subbeg) + i );
6671     if (i >= 0) {
6672 #if NO_TAINT_SUPPORT
6673         sv_setpvn(sv, s, i);
6674 #else
6675         const int oldtainted = TAINT_get;
6676         TAINT_NOT;
6677         sv_setpvn(sv, s, i);
6678         TAINT_set(oldtainted);
6679 #endif
6680         if ( (rx->extflags & RXf_CANY_SEEN)
6681             ? (RXp_MATCH_UTF8(rx)
6682                         && (!i || is_utf8_string((U8*)s, i)))
6683             : (RXp_MATCH_UTF8(rx)) )
6684         {
6685             SvUTF8_on(sv);
6686         }
6687         else
6688             SvUTF8_off(sv);
6689         if (TAINTING_get) {
6690             if (RXp_MATCH_TAINTED(rx)) {
6691                 if (SvTYPE(sv) >= SVt_PVMG) {
6692                     MAGIC* const mg = SvMAGIC(sv);
6693                     MAGIC* mgt;
6694                     TAINT;
6695                     SvMAGIC_set(sv, mg->mg_moremagic);
6696                     SvTAINT(sv);
6697                     if ((mgt = SvMAGIC(sv))) {
6698                         mg->mg_moremagic = mgt;
6699                         SvMAGIC_set(sv, mg);
6700                     }
6701                 } else {
6702                     TAINT;
6703                     SvTAINT(sv);
6704                 }
6705             } else 
6706                 SvTAINTED_off(sv);
6707         }
6708     } else {
6709       ret_undef:
6710         sv_setsv(sv,&PL_sv_undef);
6711         return;
6712     }
6713 }
6714
6715 void
6716 Perl_reg_numbered_buff_store(pTHX_ REGEXP * const rx, const I32 paren,
6717                                                          SV const * const value)
6718 {
6719     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_STORE;
6720
6721     PERL_UNUSED_ARG(rx);
6722     PERL_UNUSED_ARG(paren);
6723     PERL_UNUSED_ARG(value);
6724
6725     if (!PL_localizing)
6726         Perl_croak_no_modify();
6727 }
6728
6729 I32
6730 Perl_reg_numbered_buff_length(pTHX_ REGEXP * const r, const SV * const sv,
6731                               const I32 paren)
6732 {
6733     struct regexp *const rx = ReANY(r);
6734     I32 i;
6735     I32 s1, t1;
6736
6737     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_LENGTH;
6738
6739     /* Some of this code was originally in C<Perl_magic_len> in F<mg.c> */
6740     switch (paren) {
6741       case RX_BUFF_IDX_CARET_PREMATCH: /* ${^PREMATCH} */
6742          if (!(rx->extflags & RXf_PMf_KEEPCOPY))
6743             goto warn_undef;
6744         /*FALLTHROUGH*/
6745
6746       case RX_BUFF_IDX_PREMATCH:       /* $` */
6747         if (rx->offs[0].start != -1) {
6748                         i = rx->offs[0].start;
6749                         if (i > 0) {
6750                                 s1 = 0;
6751                                 t1 = i;
6752                                 goto getlen;
6753                         }
6754             }
6755         return 0;
6756
6757       case RX_BUFF_IDX_CARET_POSTMATCH: /* ${^POSTMATCH} */
6758          if (!(rx->extflags & RXf_PMf_KEEPCOPY))
6759             goto warn_undef;
6760       case RX_BUFF_IDX_POSTMATCH:       /* $' */
6761             if (rx->offs[0].end != -1) {
6762                         i = rx->sublen - rx->offs[0].end;
6763                         if (i > 0) {
6764                                 s1 = rx->offs[0].end;
6765                                 t1 = rx->sublen;
6766                                 goto getlen;
6767                         }
6768             }
6769         return 0;
6770
6771       case RX_BUFF_IDX_CARET_FULLMATCH: /* ${^MATCH} */
6772          if (!(rx->extflags & RXf_PMf_KEEPCOPY))
6773             goto warn_undef;
6774         /*FALLTHROUGH*/
6775
6776       /* $& / ${^MATCH}, $1, $2, ... */
6777       default:
6778             if (paren <= (I32)rx->nparens &&
6779             (s1 = rx->offs[paren].start) != -1 &&
6780             (t1 = rx->offs[paren].end) != -1)
6781             {
6782             i = t1 - s1;
6783             goto getlen;
6784         } else {
6785           warn_undef:
6786             if (ckWARN(WARN_UNINITIALIZED))
6787                 report_uninit((const SV *)sv);
6788             return 0;
6789         }
6790     }
6791   getlen:
6792     if (i > 0 && RXp_MATCH_UTF8(rx)) {
6793         const char * const s = rx->subbeg - rx->suboffset + s1;
6794         const U8 *ep;
6795         STRLEN el;
6796
6797         i = t1 - s1;
6798         if (is_utf8_string_loclen((U8*)s, i, &ep, &el))
6799                         i = el;
6800     }
6801     return i;
6802 }
6803
6804 SV*
6805 Perl_reg_qr_package(pTHX_ REGEXP * const rx)
6806 {
6807     PERL_ARGS_ASSERT_REG_QR_PACKAGE;
6808         PERL_UNUSED_ARG(rx);
6809         if (0)
6810             return NULL;
6811         else
6812             return newSVpvs("Regexp");
6813 }
6814
6815 /* Scans the name of a named buffer from the pattern.
6816  * If flags is REG_RSN_RETURN_NULL returns null.
6817  * If flags is REG_RSN_RETURN_NAME returns an SV* containing the name
6818  * If flags is REG_RSN_RETURN_DATA returns the data SV* corresponding
6819  * to the parsed name as looked up in the RExC_paren_names hash.
6820  * If there is an error throws a vFAIL().. type exception.
6821  */
6822
6823 #define REG_RSN_RETURN_NULL    0
6824 #define REG_RSN_RETURN_NAME    1
6825 #define REG_RSN_RETURN_DATA    2
6826
6827 STATIC SV*
6828 S_reg_scan_name(pTHX_ RExC_state_t *pRExC_state, U32 flags)
6829 {
6830     char *name_start = RExC_parse;
6831
6832     PERL_ARGS_ASSERT_REG_SCAN_NAME;
6833
6834     if (isIDFIRST_lazy_if(RExC_parse, UTF)) {
6835          /* skip IDFIRST by using do...while */
6836         if (UTF)
6837             do {
6838                 RExC_parse += UTF8SKIP(RExC_parse);
6839             } while (isWORDCHAR_utf8((U8*)RExC_parse));
6840         else
6841             do {
6842                 RExC_parse++;
6843             } while (isWORDCHAR(*RExC_parse));
6844     } else {
6845         RExC_parse++; /* so the <- from the vFAIL is after the offending character */
6846         vFAIL("Group name must start with a non-digit word character");
6847     }
6848     if ( flags ) {
6849         SV* sv_name
6850             = newSVpvn_flags(name_start, (int)(RExC_parse - name_start),
6851                              SVs_TEMP | (UTF ? SVf_UTF8 : 0));
6852         if ( flags == REG_RSN_RETURN_NAME)
6853             return sv_name;
6854         else if (flags==REG_RSN_RETURN_DATA) {
6855             HE *he_str = NULL;
6856             SV *sv_dat = NULL;
6857             if ( ! sv_name )      /* should not happen*/
6858                 Perl_croak(aTHX_ "panic: no svname in reg_scan_name");
6859             if (RExC_paren_names)
6860                 he_str = hv_fetch_ent( RExC_paren_names, sv_name, 0, 0 );
6861             if ( he_str )
6862                 sv_dat = HeVAL(he_str);
6863             if ( ! sv_dat )
6864                 vFAIL("Reference to nonexistent named group");
6865             return sv_dat;
6866         }
6867         else {
6868             Perl_croak(aTHX_ "panic: bad flag %lx in reg_scan_name",
6869                        (unsigned long) flags);
6870         }
6871         assert(0); /* NOT REACHED */
6872     }
6873     return NULL;
6874 }
6875
6876 #define DEBUG_PARSE_MSG(funcname)     DEBUG_PARSE_r({           \
6877     int rem=(int)(RExC_end - RExC_parse);                       \
6878     int cut;                                                    \
6879     int num;                                                    \
6880     int iscut=0;                                                \
6881     if (rem>10) {                                               \
6882         rem=10;                                                 \
6883         iscut=1;                                                \
6884     }                                                           \
6885     cut=10-rem;                                                 \
6886     if (RExC_lastparse!=RExC_parse)                             \
6887         PerlIO_printf(Perl_debug_log," >%.*s%-*s",              \
6888             rem, RExC_parse,                                    \
6889             cut + 4,                                            \
6890             iscut ? "..." : "<"                                 \
6891         );                                                      \
6892     else                                                        \
6893         PerlIO_printf(Perl_debug_log,"%16s","");                \
6894                                                                 \
6895     if (SIZE_ONLY)                                              \
6896        num = RExC_size + 1;                                     \
6897     else                                                        \
6898        num=REG_NODE_NUM(RExC_emit);                             \
6899     if (RExC_lastnum!=num)                                      \
6900        PerlIO_printf(Perl_debug_log,"|%4d",num);                \
6901     else                                                        \
6902        PerlIO_printf(Perl_debug_log,"|%4s","");                 \
6903     PerlIO_printf(Perl_debug_log,"|%*s%-4s",                    \
6904         (int)((depth*2)), "",                                   \
6905         (funcname)                                              \
6906     );                                                          \
6907     RExC_lastnum=num;                                           \
6908     RExC_lastparse=RExC_parse;                                  \
6909 })
6910
6911
6912
6913 #define DEBUG_PARSE(funcname)     DEBUG_PARSE_r({           \
6914     DEBUG_PARSE_MSG((funcname));                            \
6915     PerlIO_printf(Perl_debug_log,"%4s","\n");               \
6916 })
6917 #define DEBUG_PARSE_FMT(funcname,fmt,args)     DEBUG_PARSE_r({           \
6918     DEBUG_PARSE_MSG((funcname));                            \
6919     PerlIO_printf(Perl_debug_log,fmt "\n",args);               \
6920 })
6921
6922 /* This section of code defines the inversion list object and its methods.  The
6923  * interfaces are highly subject to change, so as much as possible is static to
6924  * this file.  An inversion list is here implemented as a malloc'd C UV array
6925  * with some added info that is placed as UVs at the beginning in a header
6926  * portion.  An inversion list for Unicode is an array of code points, sorted
6927  * by ordinal number.  The zeroth element is the first code point in the list.
6928  * The 1th element is the first element beyond that not in the list.  In other
6929  * words, the first range is
6930  *  invlist[0]..(invlist[1]-1)
6931  * The other ranges follow.  Thus every element whose index is divisible by two
6932  * marks the beginning of a range that is in the list, and every element not
6933  * divisible by two marks the beginning of a range not in the list.  A single
6934  * element inversion list that contains the single code point N generally
6935  * consists of two elements
6936  *  invlist[0] == N
6937  *  invlist[1] == N+1
6938  * (The exception is when N is the highest representable value on the
6939  * machine, in which case the list containing just it would be a single
6940  * element, itself.  By extension, if the last range in the list extends to
6941  * infinity, then the first element of that range will be in the inversion list
6942  * at a position that is divisible by two, and is the final element in the
6943  * list.)
6944  * Taking the complement (inverting) an inversion list is quite simple, if the
6945  * first element is 0, remove it; otherwise add a 0 element at the beginning.
6946  * This implementation reserves an element at the beginning of each inversion
6947  * list to contain 0 when the list contains 0, and contains 1 otherwise.  The
6948  * actual beginning of the list is either that element if 0, or the next one if
6949  * 1.
6950  *
6951  * More about inversion lists can be found in "Unicode Demystified"
6952  * Chapter 13 by Richard Gillam, published by Addison-Wesley.
6953  * More will be coming when functionality is added later.
6954  *
6955  * The inversion list data structure is currently implemented as an SV pointing
6956  * to an array of UVs that the SV thinks are bytes.  This allows us to have an
6957  * array of UV whose memory management is automatically handled by the existing
6958  * facilities for SV's.
6959  *
6960  * Some of the methods should always be private to the implementation, and some
6961  * should eventually be made public */
6962
6963 /* The header definitions are in F<inline_invlist.c> */
6964 #define TO_INTERNAL_SIZE(x) (((x) + HEADER_LENGTH) * sizeof(UV))
6965 #define FROM_INTERNAL_SIZE(x) (((x)/ sizeof(UV)) - HEADER_LENGTH)
6966
6967 #define INVLIST_INITIAL_LEN 10
6968
6969 PERL_STATIC_INLINE UV*
6970 S__invlist_array_init(pTHX_ SV* const invlist, const bool will_have_0)
6971 {
6972     /* Returns a pointer to the first element in the inversion list's array.
6973      * This is called upon initialization of an inversion list.  Where the
6974      * array begins depends on whether the list has the code point U+0000
6975      * in it or not.  The other parameter tells it whether the code that
6976      * follows this call is about to put a 0 in the inversion list or not.
6977      * The first element is either the element with 0, if 0, or the next one,
6978      * if 1 */
6979
6980     UV* zero = get_invlist_zero_addr(invlist);
6981
6982     PERL_ARGS_ASSERT__INVLIST_ARRAY_INIT;
6983
6984     /* Must be empty */
6985     assert(! *_get_invlist_len_addr(invlist));
6986
6987     /* 1^1 = 0; 1^0 = 1 */
6988     *zero = 1 ^ will_have_0;
6989     return zero + *zero;
6990 }
6991
6992 PERL_STATIC_INLINE UV*
6993 S_invlist_array(pTHX_ SV* const invlist)
6994 {
6995     /* Returns the pointer to the inversion list's array.  Every time the
6996      * length changes, this needs to be called in case malloc or realloc moved
6997      * it */
6998
6999     PERL_ARGS_ASSERT_INVLIST_ARRAY;
7000
7001     /* Must not be empty.  If these fail, you probably didn't check for <len>
7002      * being non-zero before trying to get the array */
7003     assert(*_get_invlist_len_addr(invlist));
7004     assert(*get_invlist_zero_addr(invlist) == 0
7005            || *get_invlist_zero_addr(invlist) == 1);
7006
7007     /* The array begins either at the element reserved for zero if the
7008      * list contains 0 (that element will be set to 0), or otherwise the next
7009      * element (in which case the reserved element will be set to 1). */
7010     return (UV *) (get_invlist_zero_addr(invlist)
7011                    + *get_invlist_zero_addr(invlist));
7012 }
7013
7014 PERL_STATIC_INLINE void
7015 S_invlist_set_len(pTHX_ SV* const invlist, const UV len)
7016 {
7017     /* Sets the current number of elements stored in the inversion list */
7018
7019     PERL_ARGS_ASSERT_INVLIST_SET_LEN;
7020
7021     *_get_invlist_len_addr(invlist) = len;
7022
7023     assert(len <= SvLEN(invlist));
7024
7025     SvCUR_set(invlist, TO_INTERNAL_SIZE(len));
7026     /* If the list contains U+0000, that element is part of the header,
7027      * and should not be counted as part of the array.  It will contain
7028      * 0 in that case, and 1 otherwise.  So we could flop 0=>1, 1=>0 and
7029      * subtract:
7030      *  SvCUR_set(invlist,
7031      *            TO_INTERNAL_SIZE(len
7032      *                             - (*get_invlist_zero_addr(inv_list) ^ 1)));
7033      * But, this is only valid if len is not 0.  The consequences of not doing
7034      * this is that the memory allocation code may think that 1 more UV is
7035      * being used than actually is, and so might do an unnecessary grow.  That
7036      * seems worth not bothering to make this the precise amount.
7037      *
7038      * Note that when inverting, SvCUR shouldn't change */
7039 }
7040
7041 PERL_STATIC_INLINE IV*
7042 S_get_invlist_previous_index_addr(pTHX_ SV* invlist)
7043 {
7044     /* Return the address of the UV that is reserved to hold the cached index
7045      * */
7046
7047     PERL_ARGS_ASSERT_GET_INVLIST_PREVIOUS_INDEX_ADDR;
7048
7049     return (IV *) (SvPVX(invlist) + (INVLIST_PREVIOUS_INDEX_OFFSET * sizeof (UV)));
7050 }
7051
7052 PERL_STATIC_INLINE IV
7053 S_invlist_previous_index(pTHX_ SV* const invlist)
7054 {
7055     /* Returns cached index of previous search */
7056
7057     PERL_ARGS_ASSERT_INVLIST_PREVIOUS_INDEX;
7058
7059     return *get_invlist_previous_index_addr(invlist);
7060 }
7061
7062 PERL_STATIC_INLINE void
7063 S_invlist_set_previous_index(pTHX_ SV* const invlist, const IV index)
7064 {
7065     /* Caches <index> for later retrieval */
7066
7067     PERL_ARGS_ASSERT_INVLIST_SET_PREVIOUS_INDEX;
7068
7069     assert(index == 0 || index < (int) _invlist_len(invlist));
7070
7071     *get_invlist_previous_index_addr(invlist) = index;
7072 }
7073
7074 PERL_STATIC_INLINE UV
7075 S_invlist_max(pTHX_ SV* const invlist)
7076 {
7077     /* Returns the maximum number of elements storable in the inversion list's
7078      * array, without having to realloc() */
7079
7080     PERL_ARGS_ASSERT_INVLIST_MAX;
7081
7082     return SvLEN(invlist) == 0  /* This happens under _new_invlist_C_array */
7083            ? _invlist_len(invlist)
7084            : FROM_INTERNAL_SIZE(SvLEN(invlist));
7085 }
7086
7087 PERL_STATIC_INLINE UV*
7088 S_get_invlist_zero_addr(pTHX_ SV* invlist)
7089 {
7090     /* Return the address of the UV that is reserved to hold 0 if the inversion
7091      * list contains 0.  This has to be the last element of the heading, as the
7092      * list proper starts with either it if 0, or the next element if not.
7093      * (But we force it to contain either 0 or 1) */
7094
7095     PERL_ARGS_ASSERT_GET_INVLIST_ZERO_ADDR;
7096
7097     return (UV *) (SvPVX(invlist) + (INVLIST_ZERO_OFFSET * sizeof (UV)));
7098 }
7099
7100 #ifndef PERL_IN_XSUB_RE
7101 SV*
7102 Perl__new_invlist(pTHX_ IV initial_size)
7103 {
7104
7105     /* Return a pointer to a newly constructed inversion list, with enough
7106      * space to store 'initial_size' elements.  If that number is negative, a
7107      * system default is used instead */
7108
7109     SV* new_list;
7110
7111     if (initial_size < 0) {
7112         initial_size = INVLIST_INITIAL_LEN;
7113     }
7114
7115     /* Allocate the initial space */
7116     new_list = newSV(TO_INTERNAL_SIZE(initial_size));
7117     invlist_set_len(new_list, 0);
7118
7119     /* Force iterinit() to be used to get iteration to work */
7120     *get_invlist_iter_addr(new_list) = UV_MAX;
7121
7122     /* This should force a segfault if a method doesn't initialize this
7123      * properly */
7124     *get_invlist_zero_addr(new_list) = UV_MAX;
7125
7126     *get_invlist_previous_index_addr(new_list) = 0;
7127     *get_invlist_version_id_addr(new_list) = INVLIST_VERSION_ID;
7128 #if HEADER_LENGTH != 5
7129 #   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
7130 #endif
7131
7132     return new_list;
7133 }
7134 #endif
7135
7136 STATIC SV*
7137 S__new_invlist_C_array(pTHX_ UV* list)
7138 {
7139     /* Return a pointer to a newly constructed inversion list, initialized to
7140      * point to <list>, which has to be in the exact correct inversion list
7141      * form, including internal fields.  Thus this is a dangerous routine that
7142      * should not be used in the wrong hands */
7143
7144     SV* invlist = newSV_type(SVt_PV);
7145
7146     PERL_ARGS_ASSERT__NEW_INVLIST_C_ARRAY;
7147
7148     SvPV_set(invlist, (char *) list);
7149     SvLEN_set(invlist, 0);  /* Means we own the contents, and the system
7150                                shouldn't touch it */
7151     SvCUR_set(invlist, TO_INTERNAL_SIZE(_invlist_len(invlist)));
7152
7153     if (*get_invlist_version_id_addr(invlist) != INVLIST_VERSION_ID) {
7154         Perl_croak(aTHX_ "panic: Incorrect version for previously generated inversion list");
7155     }
7156
7157     /* Initialize the iteration pointer.
7158      * XXX This could be done at compile time in charclass_invlists.h, but I
7159      * (khw) am not confident that the suffixes for specifying the C constant
7160      * UV_MAX are portable, e.g.  'ull' on a 32 bit machine that is configured
7161      * to use 64 bits; might need a Configure probe */
7162     invlist_iterfinish(invlist);
7163
7164     return invlist;
7165 }
7166
7167 STATIC void
7168 S_invlist_extend(pTHX_ SV* const invlist, const UV new_max)
7169 {
7170     /* Grow the maximum size of an inversion list */
7171
7172     PERL_ARGS_ASSERT_INVLIST_EXTEND;
7173
7174     SvGROW((SV *)invlist, TO_INTERNAL_SIZE(new_max));
7175 }
7176
7177 PERL_STATIC_INLINE void
7178 S_invlist_trim(pTHX_ SV* const invlist)
7179 {
7180     PERL_ARGS_ASSERT_INVLIST_TRIM;
7181
7182     /* Change the length of the inversion list to how many entries it currently
7183      * has */
7184
7185     SvPV_shrink_to_cur((SV *) invlist);
7186 }
7187
7188 #define _invlist_union_complement_2nd(a, b, output) _invlist_union_maybe_complement_2nd(a, b, TRUE, output)
7189
7190 STATIC void
7191 S__append_range_to_invlist(pTHX_ SV* const invlist, const UV start, const UV end)
7192 {
7193    /* Subject to change or removal.  Append the range from 'start' to 'end' at
7194     * the end of the inversion list.  The range must be above any existing
7195     * ones. */
7196
7197     UV* array;
7198     UV max = invlist_max(invlist);
7199     UV len = _invlist_len(invlist);
7200
7201     PERL_ARGS_ASSERT__APPEND_RANGE_TO_INVLIST;
7202
7203     if (len == 0) { /* Empty lists must be initialized */
7204         array = _invlist_array_init(invlist, start == 0);
7205     }
7206     else {
7207         /* Here, the existing list is non-empty. The current max entry in the
7208          * list is generally the first value not in the set, except when the
7209          * set extends to the end of permissible values, in which case it is
7210          * the first entry in that final set, and so this call is an attempt to
7211          * append out-of-order */
7212
7213         UV final_element = len - 1;
7214         array = invlist_array(invlist);
7215         if (array[final_element] > start
7216             || ELEMENT_RANGE_MATCHES_INVLIST(final_element))
7217         {
7218             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",
7219                        array[final_element], start,
7220                        ELEMENT_RANGE_MATCHES_INVLIST(final_element) ? 't' : 'f');
7221         }
7222
7223         /* Here, it is a legal append.  If the new range begins with the first
7224          * value not in the set, it is extending the set, so the new first
7225          * value not in the set is one greater than the newly extended range.
7226          * */
7227         if (array[final_element] == start) {
7228             if (end != UV_MAX) {
7229                 array[final_element] = end + 1;
7230             }
7231             else {
7232                 /* But if the end is the maximum representable on the machine,
7233                  * just let the range that this would extend to have no end */
7234                 invlist_set_len(invlist, len - 1);
7235             }
7236             return;
7237         }
7238     }
7239
7240     /* Here the new range doesn't extend any existing set.  Add it */
7241
7242     len += 2;   /* Includes an element each for the start and end of range */
7243
7244     /* If overflows the existing space, extend, which may cause the array to be
7245      * moved */
7246     if (max < len) {
7247         invlist_extend(invlist, len);
7248         invlist_set_len(invlist, len);  /* Have to set len here to avoid assert
7249                                            failure in invlist_array() */
7250         array = invlist_array(invlist);
7251     }
7252     else {
7253         invlist_set_len(invlist, len);
7254     }
7255
7256     /* The next item on the list starts the range, the one after that is
7257      * one past the new range.  */
7258     array[len - 2] = start;
7259     if (end != UV_MAX) {
7260         array[len - 1] = end + 1;
7261     }
7262     else {
7263         /* But if the end is the maximum representable on the machine, just let
7264          * the range have no end */
7265         invlist_set_len(invlist, len - 1);
7266     }
7267 }
7268
7269 #ifndef PERL_IN_XSUB_RE
7270
7271 IV
7272 Perl__invlist_search(pTHX_ SV* const invlist, const UV cp)
7273 {
7274     /* Searches the inversion list for the entry that contains the input code
7275      * point <cp>.  If <cp> is not in the list, -1 is returned.  Otherwise, the
7276      * return value is the index into the list's array of the range that
7277      * contains <cp> */
7278
7279     IV low = 0;
7280     IV mid;
7281     IV high = _invlist_len(invlist);
7282     const IV highest_element = high - 1;
7283     const UV* array;
7284
7285     PERL_ARGS_ASSERT__INVLIST_SEARCH;
7286
7287     /* If list is empty, return failure. */
7288     if (high == 0) {
7289         return -1;
7290     }
7291
7292     /* (We can't get the array unless we know the list is non-empty) */
7293     array = invlist_array(invlist);
7294
7295     mid = invlist_previous_index(invlist);
7296     assert(mid >=0 && mid <= highest_element);
7297
7298     /* <mid> contains the cache of the result of the previous call to this
7299      * function (0 the first time).  See if this call is for the same result,
7300      * or if it is for mid-1.  This is under the theory that calls to this
7301      * function will often be for related code points that are near each other.
7302      * And benchmarks show that caching gives better results.  We also test
7303      * here if the code point is within the bounds of the list.  These tests
7304      * replace others that would have had to be made anyway to make sure that
7305      * the array bounds were not exceeded, and these give us extra information
7306      * at the same time */
7307     if (cp >= array[mid]) {
7308         if (cp >= array[highest_element]) {
7309             return highest_element;
7310         }
7311
7312         /* Here, array[mid] <= cp < array[highest_element].  This means that
7313          * the final element is not the answer, so can exclude it; it also
7314          * means that <mid> is not the final element, so can refer to 'mid + 1'
7315          * safely */
7316         if (cp < array[mid + 1]) {
7317             return mid;
7318         }
7319         high--;
7320         low = mid + 1;
7321     }
7322     else { /* cp < aray[mid] */
7323         if (cp < array[0]) { /* Fail if outside the array */
7324             return -1;
7325         }
7326         high = mid;
7327         if (cp >= array[mid - 1]) {
7328             goto found_entry;
7329         }
7330     }
7331
7332     /* Binary search.  What we are looking for is <i> such that
7333      *  array[i] <= cp < array[i+1]
7334      * The loop below converges on the i+1.  Note that there may not be an
7335      * (i+1)th element in the array, and things work nonetheless */
7336     while (low < high) {
7337         mid = (low + high) / 2;
7338         assert(mid <= highest_element);
7339         if (array[mid] <= cp) { /* cp >= array[mid] */
7340             low = mid + 1;
7341
7342             /* We could do this extra test to exit the loop early.
7343             if (cp < array[low]) {
7344                 return mid;
7345             }
7346             */
7347         }
7348         else { /* cp < array[mid] */
7349             high = mid;
7350         }
7351     }
7352
7353   found_entry:
7354     high--;
7355     invlist_set_previous_index(invlist, high);
7356     return high;
7357 }
7358
7359 void
7360 Perl__invlist_populate_swatch(pTHX_ SV* const invlist, const UV start, const UV end, U8* swatch)
7361 {
7362     /* populates a swatch of a swash the same way swatch_get() does in utf8.c,
7363      * but is used when the swash has an inversion list.  This makes this much
7364      * faster, as it uses a binary search instead of a linear one.  This is
7365      * intimately tied to that function, and perhaps should be in utf8.c,
7366      * except it is intimately tied to inversion lists as well.  It assumes
7367      * that <swatch> is all 0's on input */
7368
7369     UV current = start;
7370     const IV len = _invlist_len(invlist);
7371     IV i;
7372     const UV * array;
7373
7374     PERL_ARGS_ASSERT__INVLIST_POPULATE_SWATCH;
7375
7376     if (len == 0) { /* Empty inversion list */
7377         return;
7378     }
7379
7380     array = invlist_array(invlist);
7381
7382     /* Find which element it is */
7383     i = _invlist_search(invlist, start);
7384
7385     /* We populate from <start> to <end> */
7386     while (current < end) {
7387         UV upper;
7388
7389         /* The inversion list gives the results for every possible code point
7390          * after the first one in the list.  Only those ranges whose index is
7391          * even are ones that the inversion list matches.  For the odd ones,
7392          * and if the initial code point is not in the list, we have to skip
7393          * forward to the next element */
7394         if (i == -1 || ! ELEMENT_RANGE_MATCHES_INVLIST(i)) {
7395             i++;
7396             if (i >= len) { /* Finished if beyond the end of the array */
7397                 return;
7398             }
7399             current = array[i];
7400             if (current >= end) {   /* Finished if beyond the end of what we
7401                                        are populating */
7402                 if (LIKELY(end < UV_MAX)) {
7403                     return;
7404                 }
7405
7406                 /* We get here when the upper bound is the maximum
7407                  * representable on the machine, and we are looking for just
7408                  * that code point.  Have to special case it */
7409                 i = len;
7410                 goto join_end_of_list;
7411             }
7412         }
7413         assert(current >= start);
7414
7415         /* The current range ends one below the next one, except don't go past
7416          * <end> */
7417         i++;
7418         upper = (i < len && array[i] < end) ? array[i] : end;
7419
7420         /* Here we are in a range that matches.  Populate a bit in the 3-bit U8
7421          * for each code point in it */
7422         for (; current < upper; current++) {
7423             const STRLEN offset = (STRLEN)(current - start);
7424             swatch[offset >> 3] |= 1 << (offset & 7);
7425         }
7426
7427     join_end_of_list:
7428
7429         /* Quit if at the end of the list */
7430         if (i >= len) {
7431
7432             /* But first, have to deal with the highest possible code point on
7433              * the platform.  The previous code assumes that <end> is one
7434              * beyond where we want to populate, but that is impossible at the
7435              * platform's infinity, so have to handle it specially */
7436             if (UNLIKELY(end == UV_MAX && ELEMENT_RANGE_MATCHES_INVLIST(len-1)))
7437             {
7438                 const STRLEN offset = (STRLEN)(end - start);
7439                 swatch[offset >> 3] |= 1 << (offset & 7);
7440             }
7441             return;
7442         }
7443
7444         /* Advance to the next range, which will be for code points not in the
7445          * inversion list */
7446         current = array[i];
7447     }
7448
7449     return;
7450 }
7451
7452 void
7453 Perl__invlist_union_maybe_complement_2nd(pTHX_ SV* const a, SV* const b, bool complement_b, SV** output)
7454 {
7455     /* Take the union of two inversion lists and point <output> to it.  *output
7456      * SHOULD BE DEFINED upon input, and if it points to one of the two lists,
7457      * the reference count to that list will be decremented.  The first list,
7458      * <a>, may be NULL, in which case a copy of the second list is returned.
7459      * If <complement_b> is TRUE, the union is taken of the complement
7460      * (inversion) of <b> instead of b itself.
7461      *
7462      * The basis for this comes from "Unicode Demystified" Chapter 13 by
7463      * Richard Gillam, published by Addison-Wesley, and explained at some
7464      * length there.  The preface says to incorporate its examples into your
7465      * code at your own risk.
7466      *
7467      * The algorithm is like a merge sort.
7468      *
7469      * XXX A potential performance improvement is to keep track as we go along
7470      * if only one of the inputs contributes to the result, meaning the other
7471      * is a subset of that one.  In that case, we can skip the final copy and
7472      * return the larger of the input lists, but then outside code might need
7473      * to keep track of whether to free the input list or not */
7474
7475     UV* array_a;    /* a's array */
7476     UV* array_b;
7477     UV len_a;       /* length of a's array */
7478     UV len_b;
7479
7480     SV* u;                      /* the resulting union */
7481     UV* array_u;
7482     UV len_u;
7483
7484     UV i_a = 0;             /* current index into a's array */
7485     UV i_b = 0;
7486     UV i_u = 0;
7487
7488     /* running count, as explained in the algorithm source book; items are
7489      * stopped accumulating and are output when the count changes to/from 0.
7490      * The count is incremented when we start a range that's in the set, and
7491      * decremented when we start a range that's not in the set.  So its range
7492      * is 0 to 2.  Only when the count is zero is something not in the set.
7493      */
7494     UV count = 0;
7495
7496     PERL_ARGS_ASSERT__INVLIST_UNION_MAYBE_COMPLEMENT_2ND;
7497     assert(a != b);
7498
7499     /* If either one is empty, the union is the other one */
7500     if (a == NULL || ((len_a = _invlist_len(a)) == 0)) {
7501         if (*output == a) {
7502             if (a != NULL) {
7503                 SvREFCNT_dec_NN(a);
7504             }
7505         }
7506         if (*output != b) {
7507             *output = invlist_clone(b);
7508             if (complement_b) {
7509                 _invlist_invert(*output);
7510             }
7511         } /* else *output already = b; */
7512         return;
7513     }
7514     else if ((len_b = _invlist_len(b)) == 0) {
7515         if (*output == b) {
7516             SvREFCNT_dec_NN(b);
7517         }
7518
7519         /* The complement of an empty list is a list that has everything in it,
7520          * so the union with <a> includes everything too */
7521         if (complement_b) {
7522             if (a == *output) {
7523                 SvREFCNT_dec_NN(a);
7524             }
7525             *output = _new_invlist(1);
7526             _append_range_to_invlist(*output, 0, UV_MAX);
7527         }
7528         else if (*output != a) {
7529             *output = invlist_clone(a);
7530         }
7531         /* else *output already = a; */
7532         return;
7533     }
7534
7535     /* Here both lists exist and are non-empty */
7536     array_a = invlist_array(a);
7537     array_b = invlist_array(b);
7538
7539     /* If are to take the union of 'a' with the complement of b, set it
7540      * up so are looking at b's complement. */
7541     if (complement_b) {
7542
7543         /* To complement, we invert: if the first element is 0, remove it.  To
7544          * do this, we just pretend the array starts one later, and clear the
7545          * flag as we don't have to do anything else later */
7546         if (array_b[0] == 0) {
7547             array_b++;
7548             len_b--;
7549             complement_b = FALSE;
7550         }
7551         else {
7552
7553             /* But if the first element is not zero, we unshift a 0 before the
7554              * array.  The data structure reserves a space for that 0 (which
7555              * should be a '1' right now), so physical shifting is unneeded,
7556              * but temporarily change that element to 0.  Before exiting the
7557              * routine, we must restore the element to '1' */
7558             array_b--;
7559             len_b++;
7560             array_b[0] = 0;
7561         }
7562     }
7563
7564     /* Size the union for the worst case: that the sets are completely
7565      * disjoint */
7566     u = _new_invlist(len_a + len_b);
7567
7568     /* Will contain U+0000 if either component does */
7569     array_u = _invlist_array_init(u, (len_a > 0 && array_a[0] == 0)
7570                                       || (len_b > 0 && array_b[0] == 0));
7571
7572     /* Go through each list item by item, stopping when exhausted one of
7573      * them */
7574     while (i_a < len_a && i_b < len_b) {
7575         UV cp;      /* The element to potentially add to the union's array */
7576         bool cp_in_set;   /* is it in the the input list's set or not */
7577
7578         /* We need to take one or the other of the two inputs for the union.
7579          * Since we are merging two sorted lists, we take the smaller of the
7580          * next items.  In case of a tie, we take the one that is in its set
7581          * first.  If we took one not in the set first, it would decrement the
7582          * count, possibly to 0 which would cause it to be output as ending the
7583          * range, and the next time through we would take the same number, and
7584          * output it again as beginning the next range.  By doing it the
7585          * opposite way, there is no possibility that the count will be
7586          * momentarily decremented to 0, and thus the two adjoining ranges will
7587          * be seamlessly merged.  (In a tie and both are in the set or both not
7588          * in the set, it doesn't matter which we take first.) */
7589         if (array_a[i_a] < array_b[i_b]
7590             || (array_a[i_a] == array_b[i_b]
7591                 && ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
7592         {
7593             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
7594             cp= array_a[i_a++];
7595         }
7596         else {
7597             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
7598             cp = array_b[i_b++];
7599         }
7600
7601         /* Here, have chosen which of the two inputs to look at.  Only output
7602          * if the running count changes to/from 0, which marks the
7603          * beginning/end of a range in that's in the set */
7604         if (cp_in_set) {
7605             if (count == 0) {
7606                 array_u[i_u++] = cp;
7607             }
7608             count++;
7609         }
7610         else {
7611             count--;
7612             if (count == 0) {
7613                 array_u[i_u++] = cp;
7614             }
7615         }
7616     }
7617
7618     /* Here, we are finished going through at least one of the lists, which
7619      * means there is something remaining in at most one.  We check if the list
7620      * that hasn't been exhausted is positioned such that we are in the middle
7621      * of a range in its set or not.  (i_a and i_b point to the element beyond
7622      * the one we care about.) If in the set, we decrement 'count'; if 0, there
7623      * is potentially more to output.
7624      * There are four cases:
7625      *  1) Both weren't in their sets, count is 0, and remains 0.  What's left
7626      *     in the union is entirely from the non-exhausted set.
7627      *  2) Both were in their sets, count is 2.  Nothing further should
7628      *     be output, as everything that remains will be in the exhausted
7629      *     list's set, hence in the union; decrementing to 1 but not 0 insures
7630      *     that
7631      *  3) the exhausted was in its set, non-exhausted isn't, count is 1.
7632      *     Nothing further should be output because the union includes
7633      *     everything from the exhausted set.  Not decrementing ensures that.
7634      *  4) the exhausted wasn't in its set, non-exhausted is, count is 1;
7635      *     decrementing to 0 insures that we look at the remainder of the
7636      *     non-exhausted set */
7637     if ((i_a != len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
7638         || (i_b != len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
7639     {
7640         count--;
7641     }
7642
7643     /* The final length is what we've output so far, plus what else is about to
7644      * be output.  (If 'count' is non-zero, then the input list we exhausted
7645      * has everything remaining up to the machine's limit in its set, and hence
7646      * in the union, so there will be no further output. */
7647     len_u = i_u;
7648     if (count == 0) {
7649         /* At most one of the subexpressions will be non-zero */
7650         len_u += (len_a - i_a) + (len_b - i_b);
7651     }
7652
7653     /* Set result to final length, which can change the pointer to array_u, so
7654      * re-find it */
7655     if (len_u != _invlist_len(u)) {
7656         invlist_set_len(u, len_u);
7657         invlist_trim(u);
7658         array_u = invlist_array(u);
7659     }
7660
7661     /* When 'count' is 0, the list that was exhausted (if one was shorter than
7662      * the other) ended with everything above it not in its set.  That means
7663      * that the remaining part of the union is precisely the same as the
7664      * non-exhausted list, so can just copy it unchanged.  (If both list were
7665      * exhausted at the same time, then the operations below will be both 0.)
7666      */
7667     if (count == 0) {
7668         IV copy_count; /* At most one will have a non-zero copy count */
7669         if ((copy_count = len_a - i_a) > 0) {
7670             Copy(array_a + i_a, array_u + i_u, copy_count, UV);
7671         }
7672         else if ((copy_count = len_b - i_b) > 0) {
7673             Copy(array_b + i_b, array_u + i_u, copy_count, UV);
7674         }
7675     }
7676
7677     /* If we've changed b, restore it */
7678     if (complement_b) {
7679         array_b[0] = 1;
7680     }
7681
7682     /*  We may be removing a reference to one of the inputs */
7683     if (a == *output || b == *output) {
7684         assert(! invlist_is_iterating(*output));
7685         SvREFCNT_dec_NN(*output);
7686     }
7687
7688     *output = u;
7689     return;
7690 }
7691
7692 void
7693 Perl__invlist_intersection_maybe_complement_2nd(pTHX_ SV* const a, SV* const b, bool complement_b, SV** i)
7694 {
7695     /* Take the intersection of two inversion lists and point <i> to it.  *i
7696      * SHOULD BE DEFINED upon input, and if it points to one of the two lists,
7697      * the reference count to that list will be decremented.
7698      * If <complement_b> is TRUE, the result will be the intersection of <a>
7699      * and the complement (or inversion) of <b> instead of <b> directly.
7700      *
7701      * The basis for this comes from "Unicode Demystified" Chapter 13 by
7702      * Richard Gillam, published by Addison-Wesley, and explained at some
7703      * length there.  The preface says to incorporate its examples into your
7704      * code at your own risk.  In fact, it had bugs
7705      *
7706      * The algorithm is like a merge sort, and is essentially the same as the
7707      * union above
7708      */
7709
7710     UV* array_a;                /* a's array */
7711     UV* array_b;
7712     UV len_a;   /* length of a's array */
7713     UV len_b;
7714
7715     SV* r;                   /* the resulting intersection */
7716     UV* array_r;
7717     UV len_r;
7718
7719     UV i_a = 0;             /* current index into a's array */
7720     UV i_b = 0;
7721     UV i_r = 0;
7722
7723     /* running count, as explained in the algorithm source book; items are
7724      * stopped accumulating and are output when the count changes to/from 2.
7725      * The count is incremented when we start a range that's in the set, and
7726      * decremented when we start a range that's not in the set.  So its range
7727      * is 0 to 2.  Only when the count is 2 is something in the intersection.
7728      */
7729     UV count = 0;
7730
7731     PERL_ARGS_ASSERT__INVLIST_INTERSECTION_MAYBE_COMPLEMENT_2ND;
7732     assert(a != b);
7733
7734     /* Special case if either one is empty */
7735     len_a = _invlist_len(a);
7736     if ((len_a == 0) || ((len_b = _invlist_len(b)) == 0)) {
7737
7738         if (len_a != 0 && complement_b) {
7739
7740             /* Here, 'a' is not empty, therefore from the above 'if', 'b' must
7741              * be empty.  Here, also we are using 'b's complement, which hence
7742              * must be every possible code point.  Thus the intersection is
7743              * simply 'a'. */
7744             if (*i != a) {
7745                 *i = invlist_clone(a);
7746
7747                 if (*i == b) {
7748                     SvREFCNT_dec_NN(b);
7749                 }
7750             }
7751             /* else *i is already 'a' */
7752             return;
7753         }
7754
7755         /* Here, 'a' or 'b' is empty and not using the complement of 'b'.  The
7756          * intersection must be empty */
7757         if (*i == a) {
7758             SvREFCNT_dec_NN(a);
7759         }
7760         else if (*i == b) {
7761             SvREFCNT_dec_NN(b);
7762         }
7763         *i = _new_invlist(0);
7764         return;
7765     }
7766
7767     /* Here both lists exist and are non-empty */
7768     array_a = invlist_array(a);
7769     array_b = invlist_array(b);
7770
7771     /* If are to take the intersection of 'a' with the complement of b, set it
7772      * up so are looking at b's complement. */
7773     if (complement_b) {
7774
7775         /* To complement, we invert: if the first element is 0, remove it.  To
7776          * do this, we just pretend the array starts one later, and clear the
7777          * flag as we don't have to do anything else later */
7778         if (array_b[0] == 0) {
7779             array_b++;
7780             len_b--;
7781             complement_b = FALSE;
7782         }
7783         else {
7784
7785             /* But if the first element is not zero, we unshift a 0 before the
7786              * array.  The data structure reserves a space for that 0 (which
7787              * should be a '1' right now), so physical shifting is unneeded,
7788              * but temporarily change that element to 0.  Before exiting the
7789              * routine, we must restore the element to '1' */
7790             array_b--;
7791             len_b++;
7792             array_b[0] = 0;
7793         }
7794     }
7795
7796     /* Size the intersection for the worst case: that the intersection ends up
7797      * fragmenting everything to be completely disjoint */
7798     r= _new_invlist(len_a + len_b);
7799
7800     /* Will contain U+0000 iff both components do */
7801     array_r = _invlist_array_init(r, len_a > 0 && array_a[0] == 0
7802                                      && len_b > 0 && array_b[0] == 0);
7803
7804     /* Go through each list item by item, stopping when exhausted one of
7805      * them */
7806     while (i_a < len_a && i_b < len_b) {
7807         UV cp;      /* The element to potentially add to the intersection's
7808                        array */
7809         bool cp_in_set; /* Is it in the input list's set or not */
7810
7811         /* We need to take one or the other of the two inputs for the
7812          * intersection.  Since we are merging two sorted lists, we take the
7813          * smaller of the next items.  In case of a tie, we take the one that
7814          * is not in its set first (a difference from the union algorithm).  If
7815          * we took one in the set first, it would increment the count, possibly
7816          * to 2 which would cause it to be output as starting a range in the
7817          * intersection, and the next time through we would take that same
7818          * number, and output it again as ending the set.  By doing it the
7819          * opposite of this, there is no possibility that the count will be
7820          * momentarily incremented to 2.  (In a tie and both are in the set or
7821          * both not in the set, it doesn't matter which we take first.) */
7822         if (array_a[i_a] < array_b[i_b]
7823             || (array_a[i_a] == array_b[i_b]
7824                 && ! ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
7825         {
7826             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
7827             cp= array_a[i_a++];
7828         }
7829         else {
7830             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
7831             cp= array_b[i_b++];
7832         }
7833
7834         /* Here, have chosen which of the two inputs to look at.  Only output
7835          * if the running count changes to/from 2, which marks the
7836          * beginning/end of a range that's in the intersection */
7837         if (cp_in_set) {
7838             count++;
7839             if (count == 2) {
7840                 array_r[i_r++] = cp;
7841             }
7842         }
7843         else {
7844             if (count == 2) {
7845                 array_r[i_r++] = cp;
7846             }
7847             count--;
7848         }
7849     }
7850
7851     /* Here, we are finished going through at least one of the lists, which
7852      * means there is something remaining in at most one.  We check if the list
7853      * that has been exhausted is positioned such that we are in the middle
7854      * of a range in its set or not.  (i_a and i_b point to elements 1 beyond
7855      * the ones we care about.)  There are four cases:
7856      *  1) Both weren't in their sets, count is 0, and remains 0.  There's
7857      *     nothing left in the intersection.
7858      *  2) Both were in their sets, count is 2 and perhaps is incremented to
7859      *     above 2.  What should be output is exactly that which is in the
7860      *     non-exhausted set, as everything it has is also in the intersection
7861      *     set, and everything it doesn't have can't be in the intersection
7862      *  3) The exhausted was in its set, non-exhausted isn't, count is 1, and
7863      *     gets incremented to 2.  Like the previous case, the intersection is
7864      *     everything that remains in the non-exhausted set.
7865      *  4) the exhausted wasn't in its set, non-exhausted is, count is 1, and
7866      *     remains 1.  And the intersection has nothing more. */
7867     if ((i_a == len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
7868         || (i_b == len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
7869     {
7870         count++;
7871     }
7872
7873     /* The final length is what we've output so far plus what else is in the
7874      * intersection.  At most one of the subexpressions below will be non-zero */
7875     len_r = i_r;
7876     if (count >= 2) {
7877         len_r += (len_a - i_a) + (len_b - i_b);
7878     }
7879
7880     /* Set result to final length, which can change the pointer to array_r, so
7881      * re-find it */
7882     if (len_r != _invlist_len(r)) {
7883         invlist_set_len(r, len_r);
7884         invlist_trim(r);
7885         array_r = invlist_array(r);
7886     }
7887
7888     /* Finish outputting any remaining */
7889     if (count >= 2) { /* At most one will have a non-zero copy count */
7890         IV copy_count;
7891         if ((copy_count = len_a - i_a) > 0) {
7892             Copy(array_a + i_a, array_r + i_r, copy_count, UV);
7893         }
7894         else if ((copy_count = len_b - i_b) > 0) {
7895             Copy(array_b + i_b, array_r + i_r, copy_count, UV);
7896         }
7897     }
7898
7899     /* If we've changed b, restore it */
7900     if (complement_b) {
7901         array_b[0] = 1;
7902     }
7903
7904     /*  We may be removing a reference to one of the inputs */
7905     if (a == *i || b == *i) {
7906         assert(! invlist_is_iterating(*i));
7907         SvREFCNT_dec_NN(*i);
7908     }
7909
7910     *i = r;
7911     return;
7912 }
7913
7914 SV*
7915 Perl__add_range_to_invlist(pTHX_ SV* invlist, const UV start, const UV end)
7916 {
7917     /* Add the range from 'start' to 'end' inclusive to the inversion list's
7918      * set.  A pointer to the inversion list is returned.  This may actually be
7919      * a new list, in which case the passed in one has been destroyed.  The
7920      * passed in inversion list can be NULL, in which case a new one is created
7921      * with just the one range in it */
7922
7923     SV* range_invlist;
7924     UV len;
7925
7926     if (invlist == NULL) {
7927         invlist = _new_invlist(2);
7928         len = 0;
7929     }
7930     else {
7931         len = _invlist_len(invlist);
7932     }
7933
7934     /* If comes after the final entry actually in the list, can just append it
7935      * to the end, */
7936     if (len == 0
7937         || (! ELEMENT_RANGE_MATCHES_INVLIST(len - 1)
7938             && start >= invlist_array(invlist)[len - 1]))
7939     {
7940         _append_range_to_invlist(invlist, start, end);
7941         return invlist;
7942     }
7943
7944     /* Here, can't just append things, create and return a new inversion list
7945      * which is the union of this range and the existing inversion list */
7946     range_invlist = _new_invlist(2);
7947     _append_range_to_invlist(range_invlist, start, end);
7948
7949     _invlist_union(invlist, range_invlist, &invlist);
7950
7951     /* The temporary can be freed */
7952     SvREFCNT_dec_NN(range_invlist);
7953
7954     return invlist;
7955 }
7956
7957 #endif
7958
7959 PERL_STATIC_INLINE SV*
7960 S_add_cp_to_invlist(pTHX_ SV* invlist, const UV cp) {
7961     return _add_range_to_invlist(invlist, cp, cp);
7962 }
7963
7964 #ifndef PERL_IN_XSUB_RE
7965 void
7966 Perl__invlist_invert(pTHX_ SV* const invlist)
7967 {
7968     /* Complement the input inversion list.  This adds a 0 if the list didn't
7969      * have a zero; removes it otherwise.  As described above, the data
7970      * structure is set up so that this is very efficient */
7971
7972     UV* len_pos = _get_invlist_len_addr(invlist);
7973
7974     PERL_ARGS_ASSERT__INVLIST_INVERT;
7975
7976     assert(! invlist_is_iterating(invlist));
7977
7978     /* The inverse of matching nothing is matching everything */
7979     if (*len_pos == 0) {
7980         _append_range_to_invlist(invlist, 0, UV_MAX);
7981         return;
7982     }
7983
7984     /* The exclusive or complents 0 to 1; and 1 to 0.  If the result is 1, the
7985      * zero element was a 0, so it is being removed, so the length decrements
7986      * by 1; and vice-versa.  SvCUR is unaffected */
7987     if (*get_invlist_zero_addr(invlist) ^= 1) {
7988         (*len_pos)--;
7989     }
7990     else {
7991         (*len_pos)++;
7992     }
7993 }
7994
7995 void
7996 Perl__invlist_invert_prop(pTHX_ SV* const invlist)
7997 {
7998     /* Complement the input inversion list (which must be a Unicode property,
7999      * all of which don't match above the Unicode maximum code point.)  And
8000      * Perl has chosen to not have the inversion match above that either.  This
8001      * adds a 0x110000 if the list didn't end with it, and removes it if it did
8002      */
8003
8004     UV len;
8005     UV* array;
8006
8007     PERL_ARGS_ASSERT__INVLIST_INVERT_PROP;
8008
8009     _invlist_invert(invlist);
8010
8011     len = _invlist_len(invlist);
8012
8013     if (len != 0) { /* If empty do nothing */
8014         array = invlist_array(invlist);
8015         if (array[len - 1] != PERL_UNICODE_MAX + 1) {
8016             /* Add 0x110000.  First, grow if necessary */
8017             len++;
8018             if (invlist_max(invlist) < len) {
8019                 invlist_extend(invlist, len);
8020                 array = invlist_array(invlist);
8021             }
8022             invlist_set_len(invlist, len);
8023             array[len - 1] = PERL_UNICODE_MAX + 1;
8024         }
8025         else {  /* Remove the 0x110000 */
8026             invlist_set_len(invlist, len - 1);
8027         }
8028     }
8029
8030     return;
8031 }
8032 #endif
8033
8034 PERL_STATIC_INLINE SV*
8035 S_invlist_clone(pTHX_ SV* const invlist)
8036 {
8037
8038     /* Return a new inversion list that is a copy of the input one, which is
8039      * unchanged */
8040
8041     /* Need to allocate extra space to accommodate Perl's addition of a
8042      * trailing NUL to SvPV's, since it thinks they are always strings */
8043     SV* new_invlist = _new_invlist(_invlist_len(invlist) + 1);
8044     STRLEN length = SvCUR(invlist);
8045
8046     PERL_ARGS_ASSERT_INVLIST_CLONE;
8047
8048     SvCUR_set(new_invlist, length); /* This isn't done automatically */
8049     Copy(SvPVX(invlist), SvPVX(new_invlist), length, char);
8050
8051     return new_invlist;
8052 }
8053
8054 PERL_STATIC_INLINE UV*
8055 S_get_invlist_iter_addr(pTHX_ SV* invlist)
8056 {
8057     /* Return the address of the UV that contains the current iteration
8058      * position */
8059
8060     PERL_ARGS_ASSERT_GET_INVLIST_ITER_ADDR;
8061
8062     return (UV *) (SvPVX(invlist) + (INVLIST_ITER_OFFSET * sizeof (UV)));
8063 }
8064
8065 PERL_STATIC_INLINE UV*
8066 S_get_invlist_version_id_addr(pTHX_ SV* invlist)
8067 {
8068     /* Return the address of the UV that contains the version id. */
8069
8070     PERL_ARGS_ASSERT_GET_INVLIST_VERSION_ID_ADDR;
8071
8072     return (UV *) (SvPVX(invlist) + (INVLIST_VERSION_ID_OFFSET * sizeof (UV)));
8073 }
8074
8075 PERL_STATIC_INLINE void
8076 S_invlist_iterinit(pTHX_ SV* invlist)   /* Initialize iterator for invlist */
8077 {
8078     PERL_ARGS_ASSERT_INVLIST_ITERINIT;
8079
8080     *get_invlist_iter_addr(invlist) = 0;
8081 }
8082
8083 PERL_STATIC_INLINE void
8084 S_invlist_iterfinish(pTHX_ SV* invlist)
8085 {
8086     /* Terminate iterator for invlist.  This is to catch development errors.
8087      * Any iteration that is interrupted before completed should call this
8088      * function.  Functions that add code points anywhere else but to the end
8089      * of an inversion list assert that they are not in the middle of an
8090      * iteration.  If they were, the addition would make the iteration
8091      * problematical: if the iteration hadn't reached the place where things
8092      * were being added, it would be ok */
8093
8094     PERL_ARGS_ASSERT_INVLIST_ITERFINISH;
8095
8096     *get_invlist_iter_addr(invlist) = UV_MAX;
8097 }
8098
8099 STATIC bool
8100 S_invlist_iternext(pTHX_ SV* invlist, UV* start, UV* end)
8101 {
8102     /* An C<invlist_iterinit> call on <invlist> must be used to set this up.
8103      * This call sets in <*start> and <*end>, the next range in <invlist>.
8104      * Returns <TRUE> if successful and the next call will return the next
8105      * range; <FALSE> if was already at the end of the list.  If the latter,
8106      * <*start> and <*end> are unchanged, and the next call to this function
8107      * will start over at the beginning of the list */
8108
8109     UV* pos = get_invlist_iter_addr(invlist);
8110     UV len = _invlist_len(invlist);
8111     UV *array;
8112
8113     PERL_ARGS_ASSERT_INVLIST_ITERNEXT;
8114
8115     if (*pos >= len) {
8116         *pos = UV_MAX;  /* Force iterinit() to be required next time */
8117         return FALSE;
8118     }
8119
8120     array = invlist_array(invlist);
8121
8122     *start = array[(*pos)++];
8123
8124     if (*pos >= len) {
8125         *end = UV_MAX;
8126     }
8127     else {
8128         *end = array[(*pos)++] - 1;
8129     }
8130
8131     return TRUE;
8132 }
8133
8134 PERL_STATIC_INLINE bool
8135 S_invlist_is_iterating(pTHX_ SV* const invlist)
8136 {
8137     PERL_ARGS_ASSERT_INVLIST_IS_ITERATING;
8138
8139     return *(get_invlist_iter_addr(invlist)) < UV_MAX;
8140 }
8141
8142 PERL_STATIC_INLINE UV
8143 S_invlist_highest(pTHX_ SV* const invlist)
8144 {
8145     /* Returns the highest code point that matches an inversion list.  This API
8146      * has an ambiguity, as it returns 0 under either the highest is actually
8147      * 0, or if the list is empty.  If this distinction matters to you, check
8148      * for emptiness before calling this function */
8149
8150     UV len = _invlist_len(invlist);
8151     UV *array;
8152
8153     PERL_ARGS_ASSERT_INVLIST_HIGHEST;
8154
8155     if (len == 0) {
8156         return 0;
8157     }
8158
8159     array = invlist_array(invlist);
8160
8161     /* The last element in the array in the inversion list always starts a
8162      * range that goes to infinity.  That range may be for code points that are
8163      * matched in the inversion list, or it may be for ones that aren't
8164      * matched.  In the latter case, the highest code point in the set is one
8165      * less than the beginning of this range; otherwise it is the final element
8166      * of this range: infinity */
8167     return (ELEMENT_RANGE_MATCHES_INVLIST(len - 1))
8168            ? UV_MAX
8169            : array[len - 1] - 1;
8170 }
8171
8172 #ifndef PERL_IN_XSUB_RE
8173 SV *
8174 Perl__invlist_contents(pTHX_ SV* const invlist)
8175 {
8176     /* Get the contents of an inversion list into a string SV so that they can
8177      * be printed out.  It uses the format traditionally done for debug tracing
8178      */
8179
8180     UV start, end;
8181     SV* output = newSVpvs("\n");
8182
8183     PERL_ARGS_ASSERT__INVLIST_CONTENTS;
8184
8185     assert(! invlist_is_iterating(invlist));
8186
8187     invlist_iterinit(invlist);
8188     while (invlist_iternext(invlist, &start, &end)) {
8189         if (end == UV_MAX) {
8190             Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\tINFINITY\n", start);
8191         }
8192         else if (end != start) {
8193             Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\t%04"UVXf"\n",
8194                     start,       end);
8195         }
8196         else {
8197             Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\n", start);
8198         }
8199     }
8200
8201     return output;
8202 }
8203 #endif
8204
8205 #ifdef PERL_ARGS_ASSERT__INVLIST_DUMP
8206 void
8207 Perl__invlist_dump(pTHX_ SV* const invlist, const char * const header)
8208 {
8209     /* Dumps out the ranges in an inversion list.  The string 'header'
8210      * if present is output on a line before the first range */
8211
8212     UV start, end;
8213
8214     PERL_ARGS_ASSERT__INVLIST_DUMP;
8215
8216     if (header && strlen(header)) {
8217         PerlIO_printf(Perl_debug_log, "%s\n", header);
8218     }
8219     if (invlist_is_iterating(invlist)) {
8220         PerlIO_printf(Perl_debug_log, "Can't dump because is in middle of iterating\n");
8221         return;
8222     }
8223
8224     invlist_iterinit(invlist);
8225     while (invlist_iternext(invlist, &start, &end)) {
8226         if (end == UV_MAX) {
8227             PerlIO_printf(Perl_debug_log, "0x%04"UVXf" .. INFINITY\n", start);
8228         }
8229         else if (end != start) {
8230             PerlIO_printf(Perl_debug_log, "0x%04"UVXf" .. 0x%04"UVXf"\n",
8231                                                  start,         end);
8232         }
8233         else {
8234             PerlIO_printf(Perl_debug_log, "0x%04"UVXf"\n", start);
8235         }
8236     }
8237 }
8238 #endif
8239
8240 #if 0
8241 bool
8242 S__invlistEQ(pTHX_ SV* const a, SV* const b, bool complement_b)
8243 {
8244     /* Return a boolean as to if the two passed in inversion lists are
8245      * identical.  The final argument, if TRUE, says to take the complement of
8246      * the second inversion list before doing the comparison */
8247
8248     UV* array_a = invlist_array(a);
8249     UV* array_b = invlist_array(b);
8250     UV len_a = _invlist_len(a);
8251     UV len_b = _invlist_len(b);
8252
8253     UV i = 0;               /* current index into the arrays */
8254     bool retval = TRUE;     /* Assume are identical until proven otherwise */
8255
8256     PERL_ARGS_ASSERT__INVLISTEQ;
8257
8258     /* If are to compare 'a' with the complement of b, set it
8259      * up so are looking at b's complement. */
8260     if (complement_b) {
8261
8262         /* The complement of nothing is everything, so <a> would have to have
8263          * just one element, starting at zero (ending at infinity) */
8264         if (len_b == 0) {
8265             return (len_a == 1 && array_a[0] == 0);
8266         }
8267         else if (array_b[0] == 0) {
8268
8269             /* Otherwise, to complement, we invert.  Here, the first element is
8270              * 0, just remove it.  To do this, we just pretend the array starts
8271              * one later, and clear the flag as we don't have to do anything
8272              * else later */
8273
8274             array_b++;
8275             len_b--;
8276             complement_b = FALSE;
8277         }
8278         else {
8279
8280             /* But if the first element is not zero, we unshift a 0 before the
8281              * array.  The data structure reserves a space for that 0 (which
8282              * should be a '1' right now), so physical shifting is unneeded,
8283              * but temporarily change that element to 0.  Before exiting the
8284              * routine, we must restore the element to '1' */
8285             array_b--;
8286             len_b++;
8287             array_b[0] = 0;
8288         }
8289     }
8290
8291     /* Make sure that the lengths are the same, as well as the final element
8292      * before looping through the remainder.  (Thus we test the length, final,
8293      * and first elements right off the bat) */
8294     if (len_a != len_b || array_a[len_a-1] != array_b[len_a-1]) {
8295         retval = FALSE;
8296     }
8297     else for (i = 0; i < len_a - 1; i++) {
8298         if (array_a[i] != array_b[i]) {
8299             retval = FALSE;
8300             break;
8301         }
8302     }
8303
8304     if (complement_b) {
8305         array_b[0] = 1;
8306     }
8307     return retval;
8308 }
8309 #endif
8310
8311 #undef HEADER_LENGTH
8312 #undef INVLIST_INITIAL_LENGTH
8313 #undef TO_INTERNAL_SIZE
8314 #undef FROM_INTERNAL_SIZE
8315 #undef INVLIST_LEN_OFFSET
8316 #undef INVLIST_ZERO_OFFSET
8317 #undef INVLIST_ITER_OFFSET
8318 #undef INVLIST_VERSION_ID
8319 #undef INVLIST_PREVIOUS_INDEX_OFFSET
8320
8321 /* End of inversion list object */
8322
8323 STATIC void
8324 S_parse_lparen_question_flags(pTHX_ struct RExC_state_t *pRExC_state)
8325 {
8326     /* This parses the flags that are in either the '(?foo)' or '(?foo:bar)'
8327      * constructs, and updates RExC_flags with them.  On input, RExC_parse
8328      * should point to the first flag; it is updated on output to point to the
8329      * final ')' or ':'.  There needs to be at least one flag, or this will
8330      * abort */
8331
8332     /* for (?g), (?gc), and (?o) warnings; warning
8333        about (?c) will warn about (?g) -- japhy    */
8334
8335 #define WASTED_O  0x01
8336 #define WASTED_G  0x02
8337 #define WASTED_C  0x04
8338 #define WASTED_GC (0x02|0x04)
8339     I32 wastedflags = 0x00;
8340     U32 posflags = 0, negflags = 0;
8341     U32 *flagsp = &posflags;
8342     char has_charset_modifier = '\0';
8343     regex_charset cs;
8344     bool has_use_defaults = FALSE;
8345     const char* const seqstart = RExC_parse - 1; /* Point to the '?' */
8346
8347     PERL_ARGS_ASSERT_PARSE_LPAREN_QUESTION_FLAGS;
8348
8349     /* '^' as an initial flag sets certain defaults */
8350     if (UCHARAT(RExC_parse) == '^') {
8351         RExC_parse++;
8352         has_use_defaults = TRUE;
8353         STD_PMMOD_FLAGS_CLEAR(&RExC_flags);
8354         set_regex_charset(&RExC_flags, (RExC_utf8 || RExC_uni_semantics)
8355                                         ? REGEX_UNICODE_CHARSET
8356                                         : REGEX_DEPENDS_CHARSET);
8357     }
8358
8359     cs = get_regex_charset(RExC_flags);
8360     if (cs == REGEX_DEPENDS_CHARSET
8361         && (RExC_utf8 || RExC_uni_semantics))
8362     {
8363         cs = REGEX_UNICODE_CHARSET;
8364     }
8365
8366     while (*RExC_parse) {
8367         /* && strchr("iogcmsx", *RExC_parse) */
8368         /* (?g), (?gc) and (?o) are useless here
8369            and must be globally applied -- japhy */
8370         switch (*RExC_parse) {
8371
8372             /* Code for the imsx flags */
8373             CASE_STD_PMMOD_FLAGS_PARSE_SET(flagsp);
8374
8375             case LOCALE_PAT_MOD:
8376                 if (has_charset_modifier) {
8377                     goto excess_modifier;
8378                 }
8379                 else if (flagsp == &negflags) {
8380                     goto neg_modifier;
8381                 }
8382                 cs = REGEX_LOCALE_CHARSET;
8383                 has_charset_modifier = LOCALE_PAT_MOD;
8384                 RExC_contains_locale = 1;
8385                 break;
8386             case UNICODE_PAT_MOD:
8387                 if (has_charset_modifier) {
8388                     goto excess_modifier;
8389                 }
8390                 else if (flagsp == &negflags) {
8391                     goto neg_modifier;
8392                 }
8393                 cs = REGEX_UNICODE_CHARSET;
8394                 has_charset_modifier = UNICODE_PAT_MOD;
8395                 break;
8396             case ASCII_RESTRICT_PAT_MOD:
8397                 if (flagsp == &negflags) {
8398                     goto neg_modifier;
8399                 }
8400                 if (has_charset_modifier) {
8401                     if (cs != REGEX_ASCII_RESTRICTED_CHARSET) {
8402                         goto excess_modifier;
8403                     }
8404                     /* Doubled modifier implies more restricted */
8405                     cs = REGEX_ASCII_MORE_RESTRICTED_CHARSET;
8406                 }
8407                 else {
8408                     cs = REGEX_ASCII_RESTRICTED_CHARSET;
8409                 }
8410                 has_charset_modifier = ASCII_RESTRICT_PAT_MOD;
8411                 break;
8412             case DEPENDS_PAT_MOD:
8413                 if (has_use_defaults) {
8414                     goto fail_modifiers;
8415                 }
8416                 else if (flagsp == &negflags) {
8417                     goto neg_modifier;
8418                 }
8419                 else if (has_charset_modifier) {
8420                     goto excess_modifier;
8421                 }
8422
8423                 /* The dual charset means unicode semantics if the
8424                  * pattern (or target, not known until runtime) are
8425                  * utf8, or something in the pattern indicates unicode
8426                  * semantics */
8427                 cs = (RExC_utf8 || RExC_uni_semantics)
8428                      ? REGEX_UNICODE_CHARSET
8429                      : REGEX_DEPENDS_CHARSET;
8430                 has_charset_modifier = DEPENDS_PAT_MOD;
8431                 break;
8432             excess_modifier:
8433                 RExC_parse++;
8434                 if (has_charset_modifier == ASCII_RESTRICT_PAT_MOD) {
8435                     vFAIL2("Regexp modifier \"%c\" may appear a maximum of twice", ASCII_RESTRICT_PAT_MOD);
8436                 }
8437                 else if (has_charset_modifier == *(RExC_parse - 1)) {
8438                     vFAIL2("Regexp modifier \"%c\" may not appear twice", *(RExC_parse - 1));
8439                 }
8440                 else {
8441                     vFAIL3("Regexp modifiers \"%c\" and \"%c\" are mutually exclusive", has_charset_modifier, *(RExC_parse - 1));
8442                 }
8443                 /*NOTREACHED*/
8444             neg_modifier:
8445                 RExC_parse++;
8446                 vFAIL2("Regexp modifier \"%c\" may not appear after the \"-\"", *(RExC_parse - 1));
8447                 /*NOTREACHED*/
8448             case ONCE_PAT_MOD: /* 'o' */
8449             case GLOBAL_PAT_MOD: /* 'g' */
8450                 if (SIZE_ONLY && ckWARN(WARN_REGEXP)) {
8451                     const I32 wflagbit = *RExC_parse == 'o' ? WASTED_O : WASTED_G;
8452                     if (! (wastedflags & wflagbit) ) {
8453                         wastedflags |= wflagbit;
8454                         vWARN5(
8455                             RExC_parse + 1,
8456                             "Useless (%s%c) - %suse /%c modifier",
8457                             flagsp == &negflags ? "?-" : "?",
8458                             *RExC_parse,
8459                             flagsp == &negflags ? "don't " : "",
8460                             *RExC_parse
8461                         );
8462                     }
8463                 }
8464                 break;
8465
8466             case CONTINUE_PAT_MOD: /* 'c' */
8467                 if (SIZE_ONLY && ckWARN(WARN_REGEXP)) {
8468                     if (! (wastedflags & WASTED_C) ) {
8469                         wastedflags |= WASTED_GC;
8470                         vWARN3(
8471                             RExC_parse + 1,
8472                             "Useless (%sc) - %suse /gc modifier",
8473                             flagsp == &negflags ? "?-" : "?",
8474                             flagsp == &negflags ? "don't " : ""
8475                         );
8476                     }
8477                 }
8478                 break;
8479             case KEEPCOPY_PAT_MOD: /* 'p' */
8480                 if (flagsp == &negflags) {
8481                     if (SIZE_ONLY)
8482                         ckWARNreg(RExC_parse + 1,"Useless use of (?-p)");
8483                 } else {
8484                     *flagsp |= RXf_PMf_KEEPCOPY;
8485                 }
8486                 break;
8487             case '-':
8488                 /* A flag is a default iff it is following a minus, so
8489                  * if there is a minus, it means will be trying to
8490                  * re-specify a default which is an error */
8491                 if (has_use_defaults || flagsp == &negflags) {
8492                     goto fail_modifiers;
8493                 }
8494                 flagsp = &negflags;
8495                 wastedflags = 0;  /* reset so (?g-c) warns twice */
8496                 break;
8497             case ':':
8498             case ')':
8499                 RExC_flags |= posflags;
8500                 RExC_flags &= ~negflags;
8501                 set_regex_charset(&RExC_flags, cs);
8502                 return;
8503                 /*NOTREACHED*/
8504             default:
8505             fail_modifiers:
8506                 RExC_parse++;
8507                 vFAIL3("Sequence (%.*s...) not recognized",
8508                        RExC_parse-seqstart, seqstart);
8509                 /*NOTREACHED*/
8510         }
8511
8512         ++RExC_parse;
8513     }
8514 }
8515
8516 /*
8517  - reg - regular expression, i.e. main body or parenthesized thing
8518  *
8519  * Caller must absorb opening parenthesis.
8520  *
8521  * Combining parenthesis handling with the base level of regular expression
8522  * is a trifle forced, but the need to tie the tails of the branches to what
8523  * follows makes it hard to avoid.
8524  */
8525 #define REGTAIL(x,y,z) regtail((x),(y),(z),depth+1)
8526 #ifdef DEBUGGING
8527 #define REGTAIL_STUDY(x,y,z) regtail_study((x),(y),(z),depth+1)
8528 #else
8529 #define REGTAIL_STUDY(x,y,z) regtail((x),(y),(z),depth+1)
8530 #endif
8531
8532 STATIC regnode *
8533 S_reg(pTHX_ RExC_state_t *pRExC_state, I32 paren, I32 *flagp,U32 depth)
8534     /* paren: Parenthesized? 0=top, 1=(, inside: changed to letter. */
8535 {
8536     dVAR;
8537     regnode *ret;               /* Will be the head of the group. */
8538     regnode *br;
8539     regnode *lastbr;
8540     regnode *ender = NULL;
8541     I32 parno = 0;
8542     I32 flags;
8543     U32 oregflags = RExC_flags;
8544     bool have_branch = 0;
8545     bool is_open = 0;
8546     I32 freeze_paren = 0;
8547     I32 after_freeze = 0;
8548
8549     char * parse_start = RExC_parse; /* MJD */
8550     char * const oregcomp_parse = RExC_parse;
8551
8552     GET_RE_DEBUG_FLAGS_DECL;
8553
8554     PERL_ARGS_ASSERT_REG;
8555     DEBUG_PARSE("reg ");
8556
8557     *flagp = 0;                         /* Tentatively. */
8558
8559
8560     /* Make an OPEN node, if parenthesized. */
8561     if (paren) {
8562         if ( *RExC_parse == '*') { /* (*VERB:ARG) */
8563             char *start_verb = RExC_parse;
8564             STRLEN verb_len = 0;
8565             char *start_arg = NULL;
8566             unsigned char op = 0;
8567             int argok = 1;
8568             int internal_argval = 0; /* internal_argval is only useful if !argok */
8569             while ( *RExC_parse && *RExC_parse != ')' ) {
8570                 if ( *RExC_parse == ':' ) {
8571                     start_arg = RExC_parse + 1;
8572                     break;
8573                 }
8574                 RExC_parse++;
8575             }
8576             ++start_verb;
8577             verb_len = RExC_parse - start_verb;
8578             if ( start_arg ) {
8579                 RExC_parse++;
8580                 while ( *RExC_parse && *RExC_parse != ')' ) 
8581                     RExC_parse++;
8582                 if ( *RExC_parse != ')' ) 
8583                     vFAIL("Unterminated verb pattern argument");
8584                 if ( RExC_parse == start_arg )
8585                     start_arg = NULL;
8586             } else {
8587                 if ( *RExC_parse != ')' )
8588                     vFAIL("Unterminated verb pattern");
8589             }
8590             
8591             switch ( *start_verb ) {
8592             case 'A':  /* (*ACCEPT) */
8593                 if ( memEQs(start_verb,verb_len,"ACCEPT") ) {
8594                     op = ACCEPT;
8595                     internal_argval = RExC_nestroot;
8596                 }
8597                 break;
8598             case 'C':  /* (*COMMIT) */
8599                 if ( memEQs(start_verb,verb_len,"COMMIT") )
8600                     op = COMMIT;
8601                 break;
8602             case 'F':  /* (*FAIL) */
8603                 if ( verb_len==1 || memEQs(start_verb,verb_len,"FAIL") ) {
8604                     op = OPFAIL;
8605                     argok = 0;
8606                 }
8607                 break;
8608             case ':':  /* (*:NAME) */
8609             case 'M':  /* (*MARK:NAME) */
8610                 if ( verb_len==0 || memEQs(start_verb,verb_len,"MARK") ) {
8611                     op = MARKPOINT;
8612                     argok = -1;
8613                 }
8614                 break;
8615             case 'P':  /* (*PRUNE) */
8616                 if ( memEQs(start_verb,verb_len,"PRUNE") )
8617                     op = PRUNE;
8618                 break;
8619             case 'S':   /* (*SKIP) */  
8620                 if ( memEQs(start_verb,verb_len,"SKIP") ) 
8621                     op = SKIP;
8622                 break;
8623             case 'T':  /* (*THEN) */
8624                 /* [19:06] <TimToady> :: is then */
8625                 if ( memEQs(start_verb,verb_len,"THEN") ) {
8626                     op = CUTGROUP;
8627                     RExC_seen |= REG_SEEN_CUTGROUP;
8628                 }
8629                 break;
8630             }
8631             if ( ! op ) {
8632                 RExC_parse++;
8633                 vFAIL3("Unknown verb pattern '%.*s'",
8634                     verb_len, start_verb);
8635             }
8636             if ( argok ) {
8637                 if ( start_arg && internal_argval ) {
8638                     vFAIL3("Verb pattern '%.*s' may not have an argument",
8639                         verb_len, start_verb); 
8640                 } else if ( argok < 0 && !start_arg ) {
8641                     vFAIL3("Verb pattern '%.*s' has a mandatory argument",
8642                         verb_len, start_verb);    
8643                 } else {
8644                     ret = reganode(pRExC_state, op, internal_argval);
8645                     if ( ! internal_argval && ! SIZE_ONLY ) {
8646                         if (start_arg) {
8647                             SV *sv = newSVpvn( start_arg, RExC_parse - start_arg);
8648                             ARG(ret) = add_data( pRExC_state, 1, "S" );
8649                             RExC_rxi->data->data[ARG(ret)]=(void*)sv;
8650                             ret->flags = 0;
8651                         } else {
8652                             ret->flags = 1; 
8653                         }
8654                     }               
8655                 }
8656                 if (!internal_argval)
8657                     RExC_seen |= REG_SEEN_VERBARG;
8658             } else if ( start_arg ) {
8659                 vFAIL3("Verb pattern '%.*s' may not have an argument",
8660                         verb_len, start_verb);    
8661             } else {
8662                 ret = reg_node(pRExC_state, op);
8663             }
8664             nextchar(pRExC_state);
8665             return ret;
8666         } else 
8667         if (*RExC_parse == '?') { /* (?...) */
8668             bool is_logical = 0;
8669             const char * const seqstart = RExC_parse;
8670
8671             RExC_parse++;
8672             paren = *RExC_parse++;
8673             ret = NULL;                 /* For look-ahead/behind. */
8674             switch (paren) {
8675
8676             case 'P':   /* (?P...) variants for those used to PCRE/Python */
8677                 paren = *RExC_parse++;
8678                 if ( paren == '<')         /* (?P<...>) named capture */
8679                     goto named_capture;
8680                 else if (paren == '>') {   /* (?P>name) named recursion */
8681                     goto named_recursion;
8682                 }
8683                 else if (paren == '=') {   /* (?P=...)  named backref */
8684                     /* this pretty much dupes the code for \k<NAME> in regatom(), if
8685                        you change this make sure you change that */
8686                     char* name_start = RExC_parse;
8687                     U32 num = 0;
8688                     SV *sv_dat = reg_scan_name(pRExC_state,
8689                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
8690                     if (RExC_parse == name_start || *RExC_parse != ')')
8691                         vFAIL2("Sequence %.3s... not terminated",parse_start);
8692
8693                     if (!SIZE_ONLY) {
8694                         num = add_data( pRExC_state, 1, "S" );
8695                         RExC_rxi->data->data[num]=(void*)sv_dat;
8696                         SvREFCNT_inc_simple_void(sv_dat);
8697                     }
8698                     RExC_sawback = 1;
8699                     ret = reganode(pRExC_state,
8700                                    ((! FOLD)
8701                                      ? NREF
8702                                      : (ASCII_FOLD_RESTRICTED)
8703                                        ? NREFFA
8704                                        : (AT_LEAST_UNI_SEMANTICS)
8705                                          ? NREFFU
8706                                          : (LOC)
8707                                            ? NREFFL
8708                                            : NREFF),
8709                                     num);
8710                     *flagp |= HASWIDTH;
8711
8712                     Set_Node_Offset(ret, parse_start+1);
8713                     Set_Node_Cur_Length(ret); /* MJD */
8714
8715                     nextchar(pRExC_state);
8716                     return ret;
8717                 }
8718                 RExC_parse++;
8719                 vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
8720                 /*NOTREACHED*/
8721             case '<':           /* (?<...) */
8722                 if (*RExC_parse == '!')
8723                     paren = ',';
8724                 else if (*RExC_parse != '=') 
8725               named_capture:
8726                 {               /* (?<...>) */
8727                     char *name_start;
8728                     SV *svname;
8729                     paren= '>';
8730             case '\'':          /* (?'...') */
8731                     name_start= RExC_parse;
8732                     svname = reg_scan_name(pRExC_state,
8733                         SIZE_ONLY ?  /* reverse test from the others */
8734                         REG_RSN_RETURN_NAME : 
8735                         REG_RSN_RETURN_NULL);
8736                     if (RExC_parse == name_start) {
8737                         RExC_parse++;
8738                         vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
8739                         /*NOTREACHED*/
8740                     }
8741                     if (*RExC_parse != paren)
8742                         vFAIL2("Sequence (?%c... not terminated",
8743                             paren=='>' ? '<' : paren);
8744                     if (SIZE_ONLY) {
8745                         HE *he_str;
8746                         SV *sv_dat = NULL;
8747                         if (!svname) /* shouldn't happen */
8748                             Perl_croak(aTHX_
8749                                 "panic: reg_scan_name returned NULL");
8750                         if (!RExC_paren_names) {
8751                             RExC_paren_names= newHV();
8752                             sv_2mortal(MUTABLE_SV(RExC_paren_names));
8753 #ifdef DEBUGGING
8754                             RExC_paren_name_list= newAV();
8755                             sv_2mortal(MUTABLE_SV(RExC_paren_name_list));
8756 #endif
8757                         }
8758                         he_str = hv_fetch_ent( RExC_paren_names, svname, 1, 0 );
8759                         if ( he_str )
8760                             sv_dat = HeVAL(he_str);
8761                         if ( ! sv_dat ) {
8762                             /* croak baby croak */
8763                             Perl_croak(aTHX_
8764                                 "panic: paren_name hash element allocation failed");
8765                         } else if ( SvPOK(sv_dat) ) {
8766                             /* (?|...) can mean we have dupes so scan to check
8767                                its already been stored. Maybe a flag indicating
8768                                we are inside such a construct would be useful,
8769                                but the arrays are likely to be quite small, so
8770                                for now we punt -- dmq */
8771                             IV count = SvIV(sv_dat);
8772                             I32 *pv = (I32*)SvPVX(sv_dat);
8773                             IV i;
8774                             for ( i = 0 ; i < count ; i++ ) {
8775                                 if ( pv[i] == RExC_npar ) {
8776                                     count = 0;
8777                                     break;
8778                                 }
8779                             }
8780                             if ( count ) {
8781                                 pv = (I32*)SvGROW(sv_dat, SvCUR(sv_dat) + sizeof(I32)+1);
8782                                 SvCUR_set(sv_dat, SvCUR(sv_dat) + sizeof(I32));
8783                                 pv[count] = RExC_npar;
8784                                 SvIV_set(sv_dat, SvIVX(sv_dat) + 1);
8785                             }
8786                         } else {
8787                             (void)SvUPGRADE(sv_dat,SVt_PVNV);
8788                             sv_setpvn(sv_dat, (char *)&(RExC_npar), sizeof(I32));
8789                             SvIOK_on(sv_dat);
8790                             SvIV_set(sv_dat, 1);
8791                         }
8792 #ifdef DEBUGGING
8793                         /* Yes this does cause a memory leak in debugging Perls */
8794                         if (!av_store(RExC_paren_name_list, RExC_npar, SvREFCNT_inc(svname)))
8795                             SvREFCNT_dec_NN(svname);
8796 #endif
8797
8798                         /*sv_dump(sv_dat);*/
8799                     }
8800                     nextchar(pRExC_state);
8801                     paren = 1;
8802                     goto capturing_parens;
8803                 }
8804                 RExC_seen |= REG_SEEN_LOOKBEHIND;
8805                 RExC_in_lookbehind++;
8806                 RExC_parse++;
8807             case '=':           /* (?=...) */
8808                 RExC_seen_zerolen++;
8809                 break;
8810             case '!':           /* (?!...) */
8811                 RExC_seen_zerolen++;
8812                 if (*RExC_parse == ')') {
8813                     ret=reg_node(pRExC_state, OPFAIL);
8814                     nextchar(pRExC_state);
8815                     return ret;
8816                 }
8817                 break;
8818             case '|':           /* (?|...) */
8819                 /* branch reset, behave like a (?:...) except that
8820                    buffers in alternations share the same numbers */
8821                 paren = ':'; 
8822                 after_freeze = freeze_paren = RExC_npar;
8823                 break;
8824             case ':':           /* (?:...) */
8825             case '>':           /* (?>...) */
8826                 break;
8827             case '$':           /* (?$...) */
8828             case '@':           /* (?@...) */
8829                 vFAIL2("Sequence (?%c...) not implemented", (int)paren);
8830                 break;
8831             case '#':           /* (?#...) */
8832                 while (*RExC_parse && *RExC_parse != ')')
8833                     RExC_parse++;
8834                 if (*RExC_parse != ')')
8835                     FAIL("Sequence (?#... not terminated");
8836                 nextchar(pRExC_state);
8837                 *flagp = TRYAGAIN;
8838                 return NULL;
8839             case '0' :           /* (?0) */
8840             case 'R' :           /* (?R) */
8841                 if (*RExC_parse != ')')
8842                     FAIL("Sequence (?R) not terminated");
8843                 ret = reg_node(pRExC_state, GOSTART);
8844                 *flagp |= POSTPONED;
8845                 nextchar(pRExC_state);
8846                 return ret;
8847                 /*notreached*/
8848             { /* named and numeric backreferences */
8849                 I32 num;
8850             case '&':            /* (?&NAME) */
8851                 parse_start = RExC_parse - 1;
8852               named_recursion:
8853                 {
8854                     SV *sv_dat = reg_scan_name(pRExC_state,
8855                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
8856                      num = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
8857                 }
8858                 goto gen_recurse_regop;
8859                 assert(0); /* NOT REACHED */
8860             case '+':
8861                 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
8862                     RExC_parse++;
8863                     vFAIL("Illegal pattern");
8864                 }
8865                 goto parse_recursion;
8866                 /* NOT REACHED*/
8867             case '-': /* (?-1) */
8868                 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
8869                     RExC_parse--; /* rewind to let it be handled later */
8870                     goto parse_flags;
8871                 } 
8872                 /*FALLTHROUGH */
8873             case '1': case '2': case '3': case '4': /* (?1) */
8874             case '5': case '6': case '7': case '8': case '9':
8875                 RExC_parse--;
8876               parse_recursion:
8877                 num = atoi(RExC_parse);
8878                 parse_start = RExC_parse - 1; /* MJD */
8879                 if (*RExC_parse == '-')
8880                     RExC_parse++;
8881                 while (isDIGIT(*RExC_parse))
8882                         RExC_parse++;
8883                 if (*RExC_parse!=')') 
8884                     vFAIL("Expecting close bracket");
8885
8886               gen_recurse_regop:
8887                 if ( paren == '-' ) {
8888                     /*
8889                     Diagram of capture buffer numbering.
8890                     Top line is the normal capture buffer numbers
8891                     Bottom line is the negative indexing as from
8892                     the X (the (?-2))
8893
8894                     +   1 2    3 4 5 X          6 7
8895                        /(a(x)y)(a(b(c(?-2)d)e)f)(g(h))/
8896                     -   5 4    3 2 1 X          x x
8897
8898                     */
8899                     num = RExC_npar + num;
8900                     if (num < 1)  {
8901                         RExC_parse++;
8902                         vFAIL("Reference to nonexistent group");
8903                     }
8904                 } else if ( paren == '+' ) {
8905                     num = RExC_npar + num - 1;
8906                 }
8907
8908                 ret = reganode(pRExC_state, GOSUB, num);
8909                 if (!SIZE_ONLY) {
8910                     if (num > (I32)RExC_rx->nparens) {
8911                         RExC_parse++;
8912                         vFAIL("Reference to nonexistent group");
8913                     }
8914                     ARG2L_SET( ret, RExC_recurse_count++);
8915                     RExC_emit++;
8916                     DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
8917                         "Recurse #%"UVuf" to %"IVdf"\n", (UV)ARG(ret), (IV)ARG2L(ret)));
8918                 } else {
8919                     RExC_size++;
8920                 }
8921                 RExC_seen |= REG_SEEN_RECURSE;
8922                 Set_Node_Length(ret, 1 + regarglen[OP(ret)]); /* MJD */
8923                 Set_Node_Offset(ret, parse_start); /* MJD */
8924
8925                 *flagp |= POSTPONED;
8926                 nextchar(pRExC_state);
8927                 return ret;
8928             } /* named and numeric backreferences */
8929             assert(0); /* NOT REACHED */
8930
8931             case '?':           /* (??...) */
8932                 is_logical = 1;
8933                 if (*RExC_parse != '{') {
8934                     RExC_parse++;
8935                     vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
8936                     /*NOTREACHED*/
8937                 }
8938                 *flagp |= POSTPONED;
8939                 paren = *RExC_parse++;
8940                 /* FALL THROUGH */
8941             case '{':           /* (?{...}) */
8942             {
8943                 U32 n = 0;
8944                 struct reg_code_block *cb;
8945
8946                 RExC_seen_zerolen++;
8947
8948                 if (   !pRExC_state->num_code_blocks
8949                     || pRExC_state->code_index >= pRExC_state->num_code_blocks
8950                     || pRExC_state->code_blocks[pRExC_state->code_index].start
8951                         != (STRLEN)((RExC_parse -3 - (is_logical ? 1 : 0))
8952                             - RExC_start)
8953                 ) {
8954                     if (RExC_pm_flags & PMf_USE_RE_EVAL)
8955                         FAIL("panic: Sequence (?{...}): no code block found\n");
8956                     FAIL("Eval-group not allowed at runtime, use re 'eval'");
8957                 }
8958                 /* this is a pre-compiled code block (?{...}) */
8959                 cb = &pRExC_state->code_blocks[pRExC_state->code_index];
8960                 RExC_parse = RExC_start + cb->end;
8961                 if (!SIZE_ONLY) {
8962                     OP *o = cb->block;
8963                     if (cb->src_regex) {
8964                         n = add_data(pRExC_state, 2, "rl");
8965                         RExC_rxi->data->data[n] =
8966                             (void*)SvREFCNT_inc((SV*)cb->src_regex);
8967                         RExC_rxi->data->data[n+1] = (void*)o;
8968                     }
8969                     else {
8970                         n = add_data(pRExC_state, 1,
8971                                (RExC_pm_flags & PMf_HAS_CV) ? "L" : "l");
8972                         RExC_rxi->data->data[n] = (void*)o;
8973                     }
8974                 }
8975                 pRExC_state->code_index++;
8976                 nextchar(pRExC_state);
8977
8978                 if (is_logical) {
8979                     regnode *eval;
8980                     ret = reg_node(pRExC_state, LOGICAL);
8981                     eval = reganode(pRExC_state, EVAL, n);
8982                     if (!SIZE_ONLY) {
8983                         ret->flags = 2;
8984                         /* for later propagation into (??{}) return value */
8985                         eval->flags = (U8) (RExC_flags & RXf_PMf_COMPILETIME);
8986                     }
8987                     REGTAIL(pRExC_state, ret, eval);
8988                     /* deal with the length of this later - MJD */
8989                     return ret;
8990                 }
8991                 ret = reganode(pRExC_state, EVAL, n);
8992                 Set_Node_Length(ret, RExC_parse - parse_start + 1);
8993                 Set_Node_Offset(ret, parse_start);
8994                 return ret;
8995             }
8996             case '(':           /* (?(?{...})...) and (?(?=...)...) */
8997             {
8998                 int is_define= 0;
8999                 if (RExC_parse[0] == '?') {        /* (?(?...)) */
9000                     if (RExC_parse[1] == '=' || RExC_parse[1] == '!'
9001                         || RExC_parse[1] == '<'
9002                         || RExC_parse[1] == '{') { /* Lookahead or eval. */
9003                         I32 flag;
9004
9005                         ret = reg_node(pRExC_state, LOGICAL);
9006                         if (!SIZE_ONLY)
9007                             ret->flags = 1;
9008                         REGTAIL(pRExC_state, ret, reg(pRExC_state, 1, &flag,depth+1));
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                         br = reganode(pRExC_state, LONGJMP, 0);
9078                     else
9079                         REGTAIL(pRExC_state, br, reganode(pRExC_state, LONGJMP, 0));
9080                     c = *nextchar(pRExC_state);
9081                     if (flags&HASWIDTH)
9082                         *flagp |= HASWIDTH;
9083                     if (c == '|') {
9084                         if (is_define) 
9085                             vFAIL("(?(DEFINE)....) does not allow branches");
9086                         lastbr = reganode(pRExC_state, IFTHEN, 0); /* Fake one for optimizer. */
9087                         regbranch(pRExC_state, &flags, 1,depth+1);
9088                         REGTAIL(pRExC_state, ret, lastbr);
9089                         if (flags&HASWIDTH)
9090                             *flagp |= HASWIDTH;
9091                         c = *nextchar(pRExC_state);
9092                     }
9093                     else
9094                         lastbr = NULL;
9095                     if (c != ')')
9096                         vFAIL("Switch (?(condition)... contains too many branches");
9097                     ender = reg_node(pRExC_state, TAIL);
9098                     REGTAIL(pRExC_state, br, ender);
9099                     if (lastbr) {
9100                         REGTAIL(pRExC_state, lastbr, ender);
9101                         REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender);
9102                     }
9103                     else
9104                         REGTAIL(pRExC_state, ret, ender);
9105                     RExC_size++; /* XXX WHY do we need this?!!
9106                                     For large programs it seems to be required
9107                                     but I can't figure out why. -- dmq*/
9108                     return ret;
9109                 }
9110                 else {
9111                     vFAIL2("Unknown switch condition (?(%.2s", RExC_parse);
9112                 }
9113             }
9114             case '[':           /* (?[ ... ]) */
9115                 return handle_regex_sets(pRExC_state, NULL, flagp, depth,
9116                                          oregcomp_parse);
9117             case 0:
9118                 RExC_parse--; /* for vFAIL to print correctly */
9119                 vFAIL("Sequence (? incomplete");
9120                 break;
9121             default: /* e.g., (?i) */
9122                 --RExC_parse;
9123               parse_flags:
9124                 parse_lparen_question_flags(pRExC_state);
9125                 if (UCHARAT(RExC_parse) != ':') {
9126                     nextchar(pRExC_state);
9127                     *flagp = TRYAGAIN;
9128                     return NULL;
9129                 }
9130                 paren = ':';
9131                 nextchar(pRExC_state);
9132                 ret = NULL;
9133                 goto parse_rest;
9134             } /* end switch */
9135         }
9136         else {                  /* (...) */
9137           capturing_parens:
9138             parno = RExC_npar;
9139             RExC_npar++;
9140             
9141             ret = reganode(pRExC_state, OPEN, parno);
9142             if (!SIZE_ONLY ){
9143                 if (!RExC_nestroot) 
9144                     RExC_nestroot = parno;
9145                 if (RExC_seen & REG_SEEN_RECURSE
9146                     && !RExC_open_parens[parno-1])
9147                 {
9148                     DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
9149                         "Setting open paren #%"IVdf" to %d\n", 
9150                         (IV)parno, REG_NODE_NUM(ret)));
9151                     RExC_open_parens[parno-1]= ret;
9152                 }
9153             }
9154             Set_Node_Length(ret, 1); /* MJD */
9155             Set_Node_Offset(ret, RExC_parse); /* MJD */
9156             is_open = 1;
9157         }
9158     }
9159     else                        /* ! paren */
9160         ret = NULL;
9161    
9162    parse_rest:
9163     /* Pick up the branches, linking them together. */
9164     parse_start = RExC_parse;   /* MJD */
9165     br = regbranch(pRExC_state, &flags, 1,depth+1);
9166
9167     /*     branch_len = (paren != 0); */
9168
9169     if (br == NULL)
9170         return(NULL);
9171     if (*RExC_parse == '|') {
9172         if (!SIZE_ONLY && RExC_extralen) {
9173             reginsert(pRExC_state, BRANCHJ, br, depth+1);
9174         }
9175         else {                  /* MJD */
9176             reginsert(pRExC_state, BRANCH, br, depth+1);
9177             Set_Node_Length(br, paren != 0);
9178             Set_Node_Offset_To_R(br-RExC_emit_start, parse_start-RExC_start);
9179         }
9180         have_branch = 1;
9181         if (SIZE_ONLY)
9182             RExC_extralen += 1;         /* For BRANCHJ-BRANCH. */
9183     }
9184     else if (paren == ':') {
9185         *flagp |= flags&SIMPLE;
9186     }
9187     if (is_open) {                              /* Starts with OPEN. */
9188         REGTAIL(pRExC_state, ret, br);          /* OPEN -> first. */
9189     }
9190     else if (paren != '?')              /* Not Conditional */
9191         ret = br;
9192     *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
9193     lastbr = br;
9194     while (*RExC_parse == '|') {
9195         if (!SIZE_ONLY && RExC_extralen) {
9196             ender = reganode(pRExC_state, LONGJMP,0);
9197             REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender); /* Append to the previous. */
9198         }
9199         if (SIZE_ONLY)
9200             RExC_extralen += 2;         /* Account for LONGJMP. */
9201         nextchar(pRExC_state);
9202         if (freeze_paren) {
9203             if (RExC_npar > after_freeze)
9204                 after_freeze = RExC_npar;
9205             RExC_npar = freeze_paren;       
9206         }
9207         br = regbranch(pRExC_state, &flags, 0, depth+1);
9208
9209         if (br == NULL)
9210             return(NULL);
9211         REGTAIL(pRExC_state, lastbr, br);               /* BRANCH -> BRANCH. */
9212         lastbr = br;
9213         *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
9214     }
9215
9216     if (have_branch || paren != ':') {
9217         /* Make a closing node, and hook it on the end. */
9218         switch (paren) {
9219         case ':':
9220             ender = reg_node(pRExC_state, TAIL);
9221             break;
9222         case 1:
9223             ender = reganode(pRExC_state, CLOSE, parno);
9224             if (!SIZE_ONLY && RExC_seen & REG_SEEN_RECURSE) {
9225                 DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
9226                         "Setting close paren #%"IVdf" to %d\n", 
9227                         (IV)parno, REG_NODE_NUM(ender)));
9228                 RExC_close_parens[parno-1]= ender;
9229                 if (RExC_nestroot == parno) 
9230                     RExC_nestroot = 0;
9231             }       
9232             Set_Node_Offset(ender,RExC_parse+1); /* MJD */
9233             Set_Node_Length(ender,1); /* MJD */
9234             break;
9235         case '<':
9236         case ',':
9237         case '=':
9238         case '!':
9239             *flagp &= ~HASWIDTH;
9240             /* FALL THROUGH */
9241         case '>':
9242             ender = reg_node(pRExC_state, SUCCEED);
9243             break;
9244         case 0:
9245             ender = reg_node(pRExC_state, END);
9246             if (!SIZE_ONLY) {
9247                 assert(!RExC_opend); /* there can only be one! */
9248                 RExC_opend = ender;
9249             }
9250             break;
9251         }
9252         DEBUG_PARSE_r(if (!SIZE_ONLY) {
9253             SV * const mysv_val1=sv_newmortal();
9254             SV * const mysv_val2=sv_newmortal();
9255             DEBUG_PARSE_MSG("lsbr");
9256             regprop(RExC_rx, mysv_val1, lastbr);
9257             regprop(RExC_rx, mysv_val2, ender);
9258             PerlIO_printf(Perl_debug_log, "~ tying lastbr %s (%"IVdf") to ender %s (%"IVdf") offset %"IVdf"\n",
9259                           SvPV_nolen_const(mysv_val1),
9260                           (IV)REG_NODE_NUM(lastbr),
9261                           SvPV_nolen_const(mysv_val2),
9262                           (IV)REG_NODE_NUM(ender),
9263                           (IV)(ender - lastbr)
9264             );
9265         });
9266         REGTAIL(pRExC_state, lastbr, ender);
9267
9268         if (have_branch && !SIZE_ONLY) {
9269             char is_nothing= 1;
9270             if (depth==1)
9271                 RExC_seen |= REG_TOP_LEVEL_BRANCHES;
9272
9273             /* Hook the tails of the branches to the closing node. */
9274             for (br = ret; br; br = regnext(br)) {
9275                 const U8 op = PL_regkind[OP(br)];
9276                 if (op == BRANCH) {
9277                     REGTAIL_STUDY(pRExC_state, NEXTOPER(br), ender);
9278                     if (OP(NEXTOPER(br)) != NOTHING || regnext(NEXTOPER(br)) != ender)
9279                         is_nothing= 0;
9280                 }
9281                 else if (op == BRANCHJ) {
9282                     REGTAIL_STUDY(pRExC_state, NEXTOPER(NEXTOPER(br)), ender);
9283                     /* for now we always disable this optimisation * /
9284                     if (OP(NEXTOPER(NEXTOPER(br))) != NOTHING || regnext(NEXTOPER(NEXTOPER(br))) != ender)
9285                     */
9286                         is_nothing= 0;
9287                 }
9288             }
9289             if (is_nothing) {
9290                 br= PL_regkind[OP(ret)] != BRANCH ? regnext(ret) : ret;
9291                 DEBUG_PARSE_r(if (!SIZE_ONLY) {
9292                     SV * const mysv_val1=sv_newmortal();
9293                     SV * const mysv_val2=sv_newmortal();
9294                     DEBUG_PARSE_MSG("NADA");
9295                     regprop(RExC_rx, mysv_val1, ret);
9296                     regprop(RExC_rx, mysv_val2, ender);
9297                     PerlIO_printf(Perl_debug_log, "~ converting ret %s (%"IVdf") to ender %s (%"IVdf") offset %"IVdf"\n",
9298                                   SvPV_nolen_const(mysv_val1),
9299                                   (IV)REG_NODE_NUM(ret),
9300                                   SvPV_nolen_const(mysv_val2),
9301                                   (IV)REG_NODE_NUM(ender),
9302                                   (IV)(ender - ret)
9303                     );
9304                 });
9305                 OP(br)= NOTHING;
9306                 if (OP(ender) == TAIL) {
9307                     NEXT_OFF(br)= 0;
9308                     RExC_emit= br + 1;
9309                 } else {
9310                     regnode *opt;
9311                     for ( opt= br + 1; opt < ender ; opt++ )
9312                         OP(opt)= OPTIMIZED;
9313                     NEXT_OFF(br)= ender - br;
9314                 }
9315             }
9316         }
9317     }
9318
9319     {
9320         const char *p;
9321         static const char parens[] = "=!<,>";
9322
9323         if (paren && (p = strchr(parens, paren))) {
9324             U8 node = ((p - parens) % 2) ? UNLESSM : IFMATCH;
9325             int flag = (p - parens) > 1;
9326
9327             if (paren == '>')
9328                 node = SUSPEND, flag = 0;
9329             reginsert(pRExC_state, node,ret, depth+1);
9330             Set_Node_Cur_Length(ret);
9331             Set_Node_Offset(ret, parse_start + 1);
9332             ret->flags = flag;
9333             REGTAIL_STUDY(pRExC_state, ret, reg_node(pRExC_state, TAIL));
9334         }
9335     }
9336
9337     /* Check for proper termination. */
9338     if (paren) {
9339         RExC_flags = oregflags;
9340         if (RExC_parse >= RExC_end || *nextchar(pRExC_state) != ')') {
9341             RExC_parse = oregcomp_parse;
9342             vFAIL("Unmatched (");
9343         }
9344     }
9345     else if (!paren && RExC_parse < RExC_end) {
9346         if (*RExC_parse == ')') {
9347             RExC_parse++;
9348             vFAIL("Unmatched )");
9349         }
9350         else
9351             FAIL("Junk on end of regexp");      /* "Can't happen". */
9352         assert(0); /* NOTREACHED */
9353     }
9354
9355     if (RExC_in_lookbehind) {
9356         RExC_in_lookbehind--;
9357     }
9358     if (after_freeze > RExC_npar)
9359         RExC_npar = after_freeze;
9360     return(ret);
9361 }
9362
9363 /*
9364  - regbranch - one alternative of an | operator
9365  *
9366  * Implements the concatenation operator.
9367  */
9368 STATIC regnode *
9369 S_regbranch(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, I32 first, U32 depth)
9370 {
9371     dVAR;
9372     regnode *ret;
9373     regnode *chain = NULL;
9374     regnode *latest;
9375     I32 flags = 0, c = 0;
9376     GET_RE_DEBUG_FLAGS_DECL;
9377
9378     PERL_ARGS_ASSERT_REGBRANCH;
9379
9380     DEBUG_PARSE("brnc");
9381
9382     if (first)
9383         ret = NULL;
9384     else {
9385         if (!SIZE_ONLY && RExC_extralen)
9386             ret = reganode(pRExC_state, BRANCHJ,0);
9387         else {
9388             ret = reg_node(pRExC_state, BRANCH);
9389             Set_Node_Length(ret, 1);
9390         }
9391     }
9392
9393     if (!first && SIZE_ONLY)
9394         RExC_extralen += 1;                     /* BRANCHJ */
9395
9396     *flagp = WORST;                     /* Tentatively. */
9397
9398     RExC_parse--;
9399     nextchar(pRExC_state);
9400     while (RExC_parse < RExC_end && *RExC_parse != '|' && *RExC_parse != ')') {
9401         flags &= ~TRYAGAIN;
9402         latest = regpiece(pRExC_state, &flags,depth+1);
9403         if (latest == NULL) {
9404             if (flags & TRYAGAIN)
9405                 continue;
9406             return(NULL);
9407         }
9408         else if (ret == NULL)
9409             ret = latest;
9410         *flagp |= flags&(HASWIDTH|POSTPONED);
9411         if (chain == NULL)      /* First piece. */
9412             *flagp |= flags&SPSTART;
9413         else {
9414             RExC_naughty++;
9415             REGTAIL(pRExC_state, chain, latest);
9416         }
9417         chain = latest;
9418         c++;
9419     }
9420     if (chain == NULL) {        /* Loop ran zero times. */
9421         chain = reg_node(pRExC_state, NOTHING);
9422         if (ret == NULL)
9423             ret = chain;
9424     }
9425     if (c == 1) {
9426         *flagp |= flags&SIMPLE;
9427     }
9428
9429     return ret;
9430 }
9431
9432 /*
9433  - regpiece - something followed by possible [*+?]
9434  *
9435  * Note that the branching code sequences used for ? and the general cases
9436  * of * and + are somewhat optimized:  they use the same NOTHING node as
9437  * both the endmarker for their branch list and the body of the last branch.
9438  * It might seem that this node could be dispensed with entirely, but the
9439  * endmarker role is not redundant.
9440  */
9441 STATIC regnode *
9442 S_regpiece(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
9443 {
9444     dVAR;
9445     regnode *ret;
9446     char op;
9447     char *next;
9448     I32 flags;
9449     const char * const origparse = RExC_parse;
9450     I32 min;
9451     I32 max = REG_INFTY;
9452 #ifdef RE_TRACK_PATTERN_OFFSETS
9453     char *parse_start;
9454 #endif
9455     const char *maxpos = NULL;
9456
9457     /* Save the original in case we change the emitted regop to a FAIL. */
9458     regnode * const orig_emit = RExC_emit;
9459
9460     GET_RE_DEBUG_FLAGS_DECL;
9461
9462     PERL_ARGS_ASSERT_REGPIECE;
9463
9464     DEBUG_PARSE("piec");
9465
9466     ret = regatom(pRExC_state, &flags,depth+1);
9467     if (ret == NULL) {
9468         if (flags & TRYAGAIN)
9469             *flagp |= TRYAGAIN;
9470         return(NULL);
9471     }
9472
9473     op = *RExC_parse;
9474
9475     if (op == '{' && regcurly(RExC_parse, FALSE)) {
9476         maxpos = NULL;
9477 #ifdef RE_TRACK_PATTERN_OFFSETS
9478         parse_start = RExC_parse; /* MJD */
9479 #endif
9480         next = RExC_parse + 1;
9481         while (isDIGIT(*next) || *next == ',') {
9482             if (*next == ',') {
9483                 if (maxpos)
9484                     break;
9485                 else
9486                     maxpos = next;
9487             }
9488             next++;
9489         }
9490         if (*next == '}') {             /* got one */
9491             if (!maxpos)
9492                 maxpos = next;
9493             RExC_parse++;
9494             min = atoi(RExC_parse);
9495             if (*maxpos == ',')
9496                 maxpos++;
9497             else
9498                 maxpos = RExC_parse;
9499             max = atoi(maxpos);
9500             if (!max && *maxpos != '0')
9501                 max = REG_INFTY;                /* meaning "infinity" */
9502             else if (max >= REG_INFTY)
9503                 vFAIL2("Quantifier in {,} bigger than %d", REG_INFTY - 1);
9504             RExC_parse = next;
9505             nextchar(pRExC_state);
9506             if (max < min) {    /* If can't match, warn and optimize to fail
9507                                    unconditionally */
9508                 if (SIZE_ONLY) {
9509                     ckWARNreg(RExC_parse, "Quantifier {n,m} with n > m can't match");
9510
9511                     /* We can't back off the size because we have to reserve
9512                      * enough space for all the things we are about to throw
9513                      * away, but we can shrink it by the ammount we are about
9514                      * to re-use here */
9515                     RExC_size = PREVOPER(RExC_size) - regarglen[(U8)OPFAIL];
9516                 }
9517                 else {
9518                     RExC_emit = orig_emit;
9519                 }
9520                 ret = reg_node(pRExC_state, OPFAIL);
9521                 return ret;
9522             }
9523             else if (max == 0) {    /* replace {0} with a nothing node */
9524                 if (SIZE_ONLY) {
9525                     RExC_size = PREVOPER(RExC_size) - regarglen[(U8)NOTHING];
9526                 }
9527                 else {
9528                     RExC_emit = orig_emit;
9529                 }
9530                 ret = reg_node(pRExC_state, NOTHING);
9531                 return ret;
9532             }
9533
9534         do_curly:
9535             if ((flags&SIMPLE)) {
9536                 RExC_naughty += 2 + RExC_naughty / 2;
9537                 reginsert(pRExC_state, CURLY, ret, depth+1);
9538                 Set_Node_Offset(ret, parse_start+1); /* MJD */
9539                 Set_Node_Cur_Length(ret);
9540             }
9541             else {
9542                 regnode * const w = reg_node(pRExC_state, WHILEM);
9543
9544                 w->flags = 0;
9545                 REGTAIL(pRExC_state, ret, w);
9546                 if (!SIZE_ONLY && RExC_extralen) {
9547                     reginsert(pRExC_state, LONGJMP,ret, depth+1);
9548                     reginsert(pRExC_state, NOTHING,ret, depth+1);
9549                     NEXT_OFF(ret) = 3;  /* Go over LONGJMP. */
9550                 }
9551                 reginsert(pRExC_state, CURLYX,ret, depth+1);
9552                                 /* MJD hk */
9553                 Set_Node_Offset(ret, parse_start+1);
9554                 Set_Node_Length(ret,
9555                                 op == '{' ? (RExC_parse - parse_start) : 1);
9556
9557                 if (!SIZE_ONLY && RExC_extralen)
9558                     NEXT_OFF(ret) = 3;  /* Go over NOTHING to LONGJMP. */
9559                 REGTAIL(pRExC_state, ret, reg_node(pRExC_state, NOTHING));
9560                 if (SIZE_ONLY)
9561                     RExC_whilem_seen++, RExC_extralen += 3;
9562                 RExC_naughty += 4 + RExC_naughty;       /* compound interest */
9563             }
9564             ret->flags = 0;
9565
9566             if (min > 0)
9567                 *flagp = WORST;
9568             if (max > 0)
9569                 *flagp |= HASWIDTH;
9570             if (!SIZE_ONLY) {
9571                 ARG1_SET(ret, (U16)min);
9572                 ARG2_SET(ret, (U16)max);
9573             }
9574
9575             goto nest_check;
9576         }
9577     }
9578
9579     if (!ISMULT1(op)) {
9580         *flagp = flags;
9581         return(ret);
9582     }
9583
9584 #if 0                           /* Now runtime fix should be reliable. */
9585
9586     /* if this is reinstated, don't forget to put this back into perldiag:
9587
9588             =item Regexp *+ operand could be empty at {#} in regex m/%s/
9589
9590            (F) The part of the regexp subject to either the * or + quantifier
9591            could match an empty string. The {#} shows in the regular
9592            expression about where the problem was discovered.
9593
9594     */
9595
9596     if (!(flags&HASWIDTH) && op != '?')
9597       vFAIL("Regexp *+ operand could be empty");
9598 #endif
9599
9600 #ifdef RE_TRACK_PATTERN_OFFSETS
9601     parse_start = RExC_parse;
9602 #endif
9603     nextchar(pRExC_state);
9604
9605     *flagp = (op != '+') ? (WORST|SPSTART|HASWIDTH) : (WORST|HASWIDTH);
9606
9607     if (op == '*' && (flags&SIMPLE)) {
9608         reginsert(pRExC_state, STAR, ret, depth+1);
9609         ret->flags = 0;
9610         RExC_naughty += 4;
9611     }
9612     else if (op == '*') {
9613         min = 0;
9614         goto do_curly;
9615     }
9616     else if (op == '+' && (flags&SIMPLE)) {
9617         reginsert(pRExC_state, PLUS, ret, depth+1);
9618         ret->flags = 0;
9619         RExC_naughty += 3;
9620     }
9621     else if (op == '+') {
9622         min = 1;
9623         goto do_curly;
9624     }
9625     else if (op == '?') {
9626         min = 0; max = 1;
9627         goto do_curly;
9628     }
9629   nest_check:
9630     if (!SIZE_ONLY && !(flags&(HASWIDTH|POSTPONED)) && max > REG_INFTY/3) {
9631         SAVEFREESV(RExC_rx_sv); /* in case of fatal warnings */
9632         ckWARN3reg(RExC_parse,
9633                    "%.*s matches null string many times",
9634                    (int)(RExC_parse >= origparse ? RExC_parse - origparse : 0),
9635                    origparse);
9636         (void)ReREFCNT_inc(RExC_rx_sv);
9637     }
9638
9639     if (RExC_parse < RExC_end && *RExC_parse == '?') {
9640         nextchar(pRExC_state);
9641         reginsert(pRExC_state, MINMOD, ret, depth+1);
9642         REGTAIL(pRExC_state, ret, ret + NODE_STEP_REGNODE);
9643     }
9644 #ifndef REG_ALLOW_MINMOD_SUSPEND
9645     else
9646 #endif
9647     if (RExC_parse < RExC_end && *RExC_parse == '+') {
9648         regnode *ender;
9649         nextchar(pRExC_state);
9650         ender = reg_node(pRExC_state, SUCCEED);
9651         REGTAIL(pRExC_state, ret, ender);
9652         reginsert(pRExC_state, SUSPEND, ret, depth+1);
9653         ret->flags = 0;
9654         ender = reg_node(pRExC_state, TAIL);
9655         REGTAIL(pRExC_state, ret, ender);
9656         /*ret= ender;*/
9657     }
9658
9659     if (RExC_parse < RExC_end && ISMULT2(RExC_parse)) {
9660         RExC_parse++;
9661         vFAIL("Nested quantifiers");
9662     }
9663
9664     return(ret);
9665 }
9666
9667 STATIC bool
9668 S_grok_bslash_N(pTHX_ RExC_state_t *pRExC_state, regnode** node_p, UV *valuep, I32 *flagp, U32 depth, bool in_char_class,
9669         const bool strict   /* Apply stricter parsing rules? */
9670     )
9671 {
9672    
9673  /* This is expected to be called by a parser routine that has recognized '\N'
9674    and needs to handle the rest. RExC_parse is expected to point at the first
9675    char following the N at the time of the call.  On successful return,
9676    RExC_parse has been updated to point to just after the sequence identified
9677    by this routine, and <*flagp> has been updated.
9678
9679    The \N may be inside (indicated by the boolean <in_char_class>) or outside a
9680    character class.
9681
9682    \N may begin either a named sequence, or if outside a character class, mean
9683    to match a non-newline.  For non single-quoted regexes, the tokenizer has
9684    attempted to decide which, and in the case of a named sequence, converted it
9685    into one of the forms: \N{} (if the sequence is null), or \N{U+c1.c2...},
9686    where c1... are the characters in the sequence.  For single-quoted regexes,
9687    the tokenizer passes the \N sequence through unchanged; this code will not
9688    attempt to determine this nor expand those, instead raising a syntax error.
9689    The net effect is that if the beginning of the passed-in pattern isn't '{U+'
9690    or there is no '}', it signals that this \N occurrence means to match a
9691    non-newline.
9692
9693    Only the \N{U+...} form should occur in a character class, for the same
9694    reason that '.' inside a character class means to just match a period: it
9695    just doesn't make sense.
9696
9697    The function raises an error (via vFAIL), and doesn't return for various
9698    syntax errors.  Otherwise it returns TRUE and sets <node_p> or <valuep> on
9699    success; it returns FALSE otherwise.
9700
9701    If <valuep> is non-null, it means the caller can accept an input sequence
9702    consisting of a just a single code point; <*valuep> is set to that value
9703    if the input is such.
9704
9705    If <node_p> is non-null it signifies that the caller can accept any other
9706    legal sequence (i.e., one that isn't just a single code point).  <*node_p>
9707    is set as follows:
9708     1) \N means not-a-NL: points to a newly created REG_ANY node;
9709     2) \N{}:              points to a new NOTHING node;
9710     3) otherwise:         points to a new EXACT node containing the resolved
9711                           string.
9712    Note that FALSE is returned for single code point sequences if <valuep> is
9713    null.
9714  */
9715
9716     char * endbrace;    /* '}' following the name */
9717     char* p;
9718     char *endchar;      /* Points to '.' or '}' ending cur char in the input
9719                            stream */
9720     bool has_multiple_chars; /* true if the input stream contains a sequence of
9721                                 more than one character */
9722
9723     GET_RE_DEBUG_FLAGS_DECL;
9724  
9725     PERL_ARGS_ASSERT_GROK_BSLASH_N;
9726
9727     GET_RE_DEBUG_FLAGS;
9728
9729     assert(cBOOL(node_p) ^ cBOOL(valuep));  /* Exactly one should be set */
9730
9731     /* The [^\n] meaning of \N ignores spaces and comments under the /x
9732      * modifier.  The other meaning does not */
9733     p = (RExC_flags & RXf_PMf_EXTENDED)
9734         ? regwhite( pRExC_state, RExC_parse )
9735         : RExC_parse;
9736
9737     /* Disambiguate between \N meaning a named character versus \N meaning
9738      * [^\n].  The former is assumed when it can't be the latter. */
9739     if (*p != '{' || regcurly(p, FALSE)) {
9740         RExC_parse = p;
9741         if (! node_p) {
9742             /* no bare \N in a charclass */
9743             if (in_char_class) {
9744                 vFAIL("\\N in a character class must be a named character: \\N{...}");
9745             }
9746             return FALSE;
9747         }
9748         nextchar(pRExC_state);
9749         *node_p = reg_node(pRExC_state, REG_ANY);
9750         *flagp |= HASWIDTH|SIMPLE;
9751         RExC_naughty++;
9752         RExC_parse--;
9753         Set_Node_Length(*node_p, 1); /* MJD */
9754         return TRUE;
9755     }
9756
9757     /* Here, we have decided it should be a named character or sequence */
9758
9759     /* The test above made sure that the next real character is a '{', but
9760      * under the /x modifier, it could be separated by space (or a comment and
9761      * \n) and this is not allowed (for consistency with \x{...} and the
9762      * tokenizer handling of \N{NAME}). */
9763     if (*RExC_parse != '{') {
9764         vFAIL("Missing braces on \\N{}");
9765     }
9766
9767     RExC_parse++;       /* Skip past the '{' */
9768
9769     if (! (endbrace = strchr(RExC_parse, '}')) /* no trailing brace */
9770         || ! (endbrace == RExC_parse            /* nothing between the {} */
9771               || (endbrace - RExC_parse >= 2    /* U+ (bad hex is checked below */
9772                   && strnEQ(RExC_parse, "U+", 2)))) /* for a better error msg) */
9773     {
9774         if (endbrace) RExC_parse = endbrace;    /* position msg's '<--HERE' */
9775         vFAIL("\\N{NAME} must be resolved by the lexer");
9776     }
9777
9778     if (endbrace == RExC_parse) {   /* empty: \N{} */
9779         bool ret = TRUE;
9780         if (node_p) {
9781             *node_p = reg_node(pRExC_state,NOTHING);
9782         }
9783         else if (in_char_class) {
9784             if (SIZE_ONLY && in_char_class) {
9785                 if (strict) {
9786                     RExC_parse++;   /* Position after the "}" */
9787                     vFAIL("Zero length \\N{}");
9788                 }
9789                 else {
9790                     ckWARNreg(RExC_parse,
9791                               "Ignoring zero length \\N{} in character class");
9792                 }
9793             }
9794             ret = FALSE;
9795         }
9796         else {
9797             return FALSE;
9798         }
9799         nextchar(pRExC_state);
9800         return ret;
9801     }
9802
9803     RExC_uni_semantics = 1; /* Unicode named chars imply Unicode semantics */
9804     RExC_parse += 2;    /* Skip past the 'U+' */
9805
9806     endchar = RExC_parse + strcspn(RExC_parse, ".}");
9807
9808     /* Code points are separated by dots.  If none, there is only one code
9809      * point, and is terminated by the brace */
9810     has_multiple_chars = (endchar < endbrace);
9811
9812     if (valuep && (! has_multiple_chars || in_char_class)) {
9813         /* We only pay attention to the first char of
9814         multichar strings being returned in char classes. I kinda wonder
9815         if this makes sense as it does change the behaviour
9816         from earlier versions, OTOH that behaviour was broken
9817         as well. XXX Solution is to recharacterize as
9818         [rest-of-class]|multi1|multi2... */
9819
9820         STRLEN length_of_hex = (STRLEN)(endchar - RExC_parse);
9821         I32 grok_hex_flags = PERL_SCAN_ALLOW_UNDERSCORES
9822             | PERL_SCAN_DISALLOW_PREFIX
9823             | (SIZE_ONLY ? PERL_SCAN_SILENT_ILLDIGIT : 0);
9824
9825         *valuep = grok_hex(RExC_parse, &length_of_hex, &grok_hex_flags, NULL);
9826
9827         /* The tokenizer should have guaranteed validity, but it's possible to
9828          * bypass it by using single quoting, so check */
9829         if (length_of_hex == 0
9830             || length_of_hex != (STRLEN)(endchar - RExC_parse) )
9831         {
9832             RExC_parse += length_of_hex;        /* Includes all the valid */
9833             RExC_parse += (RExC_orig_utf8)      /* point to after 1st invalid */
9834                             ? UTF8SKIP(RExC_parse)
9835                             : 1;
9836             /* Guard against malformed utf8 */
9837             if (RExC_parse >= endchar) {
9838                 RExC_parse = endchar;
9839             }
9840             vFAIL("Invalid hexadecimal number in \\N{U+...}");
9841         }
9842
9843         if (in_char_class && has_multiple_chars) {
9844             if (strict) {
9845                 RExC_parse = endbrace;
9846                 vFAIL("\\N{} in character class restricted to one character");
9847             }
9848             else {
9849                 ckWARNreg(endchar, "Using just the first character returned by \\N{} in character class");
9850             }
9851         }
9852
9853         RExC_parse = endbrace + 1;
9854     }
9855     else if (! node_p || ! has_multiple_chars) {
9856
9857         /* Here, the input is legal, but not according to the caller's
9858          * options.  We fail without advancing the parse, so that the
9859          * caller can try again */
9860         RExC_parse = p;
9861         return FALSE;
9862     }
9863     else {
9864
9865         /* What is done here is to convert this to a sub-pattern of the form
9866          * (?:\x{char1}\x{char2}...)
9867          * and then call reg recursively.  That way, it retains its atomicness,
9868          * while not having to worry about special handling that some code
9869          * points may have.  toke.c has converted the original Unicode values
9870          * to native, so that we can just pass on the hex values unchanged.  We
9871          * do have to set a flag to keep recoding from happening in the
9872          * recursion */
9873
9874         SV * substitute_parse = newSVpvn_flags("?:", 2, SVf_UTF8|SVs_TEMP);
9875         STRLEN len;
9876         char *orig_end = RExC_end;
9877         I32 flags;
9878
9879         while (RExC_parse < endbrace) {
9880
9881             /* Convert to notation the rest of the code understands */
9882             sv_catpv(substitute_parse, "\\x{");
9883             sv_catpvn(substitute_parse, RExC_parse, endchar - RExC_parse);
9884             sv_catpv(substitute_parse, "}");
9885
9886             /* Point to the beginning of the next character in the sequence. */
9887             RExC_parse = endchar + 1;
9888             endchar = RExC_parse + strcspn(RExC_parse, ".}");
9889         }
9890         sv_catpv(substitute_parse, ")");
9891
9892         RExC_parse = SvPV(substitute_parse, len);
9893
9894         /* Don't allow empty number */
9895         if (len < 8) {
9896             vFAIL("Invalid hexadecimal number in \\N{U+...}");
9897         }
9898         RExC_end = RExC_parse + len;
9899
9900         /* The values are Unicode, and therefore not subject to recoding */
9901         RExC_override_recoding = 1;
9902
9903         *node_p = reg(pRExC_state, 1, &flags, depth+1);
9904         *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
9905
9906         RExC_parse = endbrace;
9907         RExC_end = orig_end;
9908         RExC_override_recoding = 0;
9909
9910         nextchar(pRExC_state);
9911     }
9912
9913     return TRUE;
9914 }
9915
9916
9917 /*
9918  * reg_recode
9919  *
9920  * It returns the code point in utf8 for the value in *encp.
9921  *    value: a code value in the source encoding
9922  *    encp:  a pointer to an Encode object
9923  *
9924  * If the result from Encode is not a single character,
9925  * it returns U+FFFD (Replacement character) and sets *encp to NULL.
9926  */
9927 STATIC UV
9928 S_reg_recode(pTHX_ const char value, SV **encp)
9929 {
9930     STRLEN numlen = 1;
9931     SV * const sv = newSVpvn_flags(&value, numlen, SVs_TEMP);
9932     const char * const s = *encp ? sv_recode_to_utf8(sv, *encp) : SvPVX(sv);
9933     const STRLEN newlen = SvCUR(sv);
9934     UV uv = UNICODE_REPLACEMENT;
9935
9936     PERL_ARGS_ASSERT_REG_RECODE;
9937
9938     if (newlen)
9939         uv = SvUTF8(sv)
9940              ? utf8n_to_uvchr((U8*)s, newlen, &numlen, UTF8_ALLOW_DEFAULT)
9941              : *(U8*)s;
9942
9943     if (!newlen || numlen != newlen) {
9944         uv = UNICODE_REPLACEMENT;
9945         *encp = NULL;
9946     }
9947     return uv;
9948 }
9949
9950 PERL_STATIC_INLINE U8
9951 S_compute_EXACTish(pTHX_ RExC_state_t *pRExC_state)
9952 {
9953     U8 op;
9954
9955     PERL_ARGS_ASSERT_COMPUTE_EXACTISH;
9956
9957     if (! FOLD) {
9958         return EXACT;
9959     }
9960
9961     op = get_regex_charset(RExC_flags);
9962     if (op >= REGEX_ASCII_RESTRICTED_CHARSET) {
9963         op--; /* /a is same as /u, and map /aa's offset to what /a's would have
9964                  been, so there is no hole */
9965     }
9966
9967     return op + EXACTF;
9968 }
9969
9970 PERL_STATIC_INLINE void
9971 S_alloc_maybe_populate_EXACT(pTHX_ RExC_state_t *pRExC_state, regnode *node, I32* flagp, STRLEN len, UV code_point)
9972 {
9973     /* This knows the details about sizing an EXACTish node, setting flags for
9974      * it (by setting <*flagp>, and potentially populating it with a single
9975      * character.
9976      *
9977      * If <len> (the length in bytes) is non-zero, this function assumes that
9978      * the node has already been populated, and just does the sizing.  In this
9979      * case <code_point> should be the final code point that has already been
9980      * placed into the node.  This value will be ignored except that under some
9981      * circumstances <*flagp> is set based on it.
9982      *
9983      * If <len> is zero, the function assumes that the node is to contain only
9984      * the single character given by <code_point> and calculates what <len>
9985      * should be.  In pass 1, it sizes the node appropriately.  In pass 2, it
9986      * additionally will populate the node's STRING with <code_point>, if <len>
9987      * is 0.  In both cases <*flagp> is appropriately set
9988      *
9989      * It knows that under FOLD, UTF characters and the Latin Sharp S must be
9990      * folded (the latter only when the rules indicate it can match 'ss') */
9991
9992     bool len_passed_in = cBOOL(len != 0);
9993     U8 character[UTF8_MAXBYTES_CASE+1];
9994
9995     PERL_ARGS_ASSERT_ALLOC_MAYBE_POPULATE_EXACT;
9996
9997     if (! len_passed_in) {
9998         if (UTF) {
9999             if (FOLD) {
10000                 to_uni_fold(NATIVE_TO_UNI(code_point), character, &len);
10001             }
10002             else {
10003                 uvchr_to_utf8( character, code_point);
10004                 len = UTF8SKIP(character);
10005             }
10006         }
10007         else if (! FOLD
10008                  || code_point != LATIN_SMALL_LETTER_SHARP_S
10009                  || ASCII_FOLD_RESTRICTED
10010                  || ! AT_LEAST_UNI_SEMANTICS)
10011         {
10012             *character = (U8) code_point;
10013             len = 1;
10014         }
10015         else {
10016             *character = 's';
10017             *(character + 1) = 's';
10018             len = 2;
10019         }
10020     }
10021
10022     if (SIZE_ONLY) {
10023         RExC_size += STR_SZ(len);
10024     }
10025     else {
10026         RExC_emit += STR_SZ(len);
10027         STR_LEN(node) = len;
10028         if (! len_passed_in) {
10029             Copy((char *) character, STRING(node), len, char);
10030         }
10031     }
10032
10033     *flagp |= HASWIDTH;
10034
10035     /* A single character node is SIMPLE, except for the special-cased SHARP S
10036      * under /di. */
10037     if ((len == 1 || (UTF && len == UNISKIP(code_point)))
10038         && (code_point != LATIN_SMALL_LETTER_SHARP_S
10039             || ! FOLD || ! DEPENDS_SEMANTICS))
10040     {
10041         *flagp |= SIMPLE;
10042     }
10043 }
10044
10045 /*
10046  - regatom - the lowest level
10047
10048    Try to identify anything special at the start of the pattern. If there
10049    is, then handle it as required. This may involve generating a single regop,
10050    such as for an assertion; or it may involve recursing, such as to
10051    handle a () structure.
10052
10053    If the string doesn't start with something special then we gobble up
10054    as much literal text as we can.
10055
10056    Once we have been able to handle whatever type of thing started the
10057    sequence, we return.
10058
10059    Note: we have to be careful with escapes, as they can be both literal
10060    and special, and in the case of \10 and friends, context determines which.
10061
10062    A summary of the code structure is:
10063
10064    switch (first_byte) {
10065         cases for each special:
10066             handle this special;
10067             break;
10068         case '\\':
10069             switch (2nd byte) {
10070                 cases for each unambiguous special:
10071                     handle this special;
10072                     break;
10073                 cases for each ambigous special/literal:
10074                     disambiguate;
10075                     if (special)  handle here
10076                     else goto defchar;
10077                 default: // unambiguously literal:
10078                     goto defchar;
10079             }
10080         default:  // is a literal char
10081             // FALL THROUGH
10082         defchar:
10083             create EXACTish node for literal;
10084             while (more input and node isn't full) {
10085                 switch (input_byte) {
10086                    cases for each special;
10087                        make sure parse pointer is set so that the next call to
10088                            regatom will see this special first
10089                        goto loopdone; // EXACTish node terminated by prev. char
10090                    default:
10091                        append char to EXACTISH node;
10092                 }
10093                 get next input byte;
10094             }
10095         loopdone:
10096    }
10097    return the generated node;
10098
10099    Specifically there are two separate switches for handling
10100    escape sequences, with the one for handling literal escapes requiring
10101    a dummy entry for all of the special escapes that are actually handled
10102    by the other.
10103 */
10104
10105 STATIC regnode *
10106 S_regatom(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
10107 {
10108     dVAR;
10109     regnode *ret = NULL;
10110     I32 flags = 0;
10111     char *parse_start = RExC_parse;
10112     U8 op;
10113     int invert = 0;
10114
10115     GET_RE_DEBUG_FLAGS_DECL;
10116
10117     *flagp = WORST;             /* Tentatively. */
10118
10119     DEBUG_PARSE("atom");
10120
10121     PERL_ARGS_ASSERT_REGATOM;
10122
10123 tryagain:
10124     switch ((U8)*RExC_parse) {
10125     case '^':
10126         RExC_seen_zerolen++;
10127         nextchar(pRExC_state);
10128         if (RExC_flags & RXf_PMf_MULTILINE)
10129             ret = reg_node(pRExC_state, MBOL);
10130         else if (RExC_flags & RXf_PMf_SINGLELINE)
10131             ret = reg_node(pRExC_state, SBOL);
10132         else
10133             ret = reg_node(pRExC_state, BOL);
10134         Set_Node_Length(ret, 1); /* MJD */
10135         break;
10136     case '$':
10137         nextchar(pRExC_state);
10138         if (*RExC_parse)
10139             RExC_seen_zerolen++;
10140         if (RExC_flags & RXf_PMf_MULTILINE)
10141             ret = reg_node(pRExC_state, MEOL);
10142         else if (RExC_flags & RXf_PMf_SINGLELINE)
10143             ret = reg_node(pRExC_state, SEOL);
10144         else
10145             ret = reg_node(pRExC_state, EOL);
10146         Set_Node_Length(ret, 1); /* MJD */
10147         break;
10148     case '.':
10149         nextchar(pRExC_state);
10150         if (RExC_flags & RXf_PMf_SINGLELINE)
10151             ret = reg_node(pRExC_state, SANY);
10152         else
10153             ret = reg_node(pRExC_state, REG_ANY);
10154         *flagp |= HASWIDTH|SIMPLE;
10155         RExC_naughty++;
10156         Set_Node_Length(ret, 1); /* MJD */
10157         break;
10158     case '[':
10159     {
10160         char * const oregcomp_parse = ++RExC_parse;
10161         ret = regclass(pRExC_state, flagp,depth+1,
10162                        FALSE, /* means parse the whole char class */
10163                        TRUE, /* allow multi-char folds */
10164                        FALSE, /* don't silence non-portable warnings. */
10165                        NULL);
10166         if (*RExC_parse != ']') {
10167             RExC_parse = oregcomp_parse;
10168             vFAIL("Unmatched [");
10169         }
10170         nextchar(pRExC_state);
10171         Set_Node_Length(ret, RExC_parse - oregcomp_parse + 1); /* MJD */
10172         break;
10173     }
10174     case '(':
10175         nextchar(pRExC_state);
10176         ret = reg(pRExC_state, 1, &flags,depth+1);
10177         if (ret == NULL) {
10178                 if (flags & TRYAGAIN) {
10179                     if (RExC_parse == RExC_end) {
10180                          /* Make parent create an empty node if needed. */
10181                         *flagp |= TRYAGAIN;
10182                         return(NULL);
10183                     }
10184                     goto tryagain;
10185                 }
10186                 return(NULL);
10187         }
10188         *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
10189         break;
10190     case '|':
10191     case ')':
10192         if (flags & TRYAGAIN) {
10193             *flagp |= TRYAGAIN;
10194             return NULL;
10195         }
10196         vFAIL("Internal urp");
10197                                 /* Supposed to be caught earlier. */
10198         break;
10199     case '{':
10200         if (!regcurly(RExC_parse, FALSE)) {
10201             RExC_parse++;
10202             goto defchar;
10203         }
10204         /* FALL THROUGH */
10205     case '?':
10206     case '+':
10207     case '*':
10208         RExC_parse++;
10209         vFAIL("Quantifier follows nothing");
10210         break;
10211     case '\\':
10212         /* Special Escapes
10213
10214            This switch handles escape sequences that resolve to some kind
10215            of special regop and not to literal text. Escape sequnces that
10216            resolve to literal text are handled below in the switch marked
10217            "Literal Escapes".
10218
10219            Every entry in this switch *must* have a corresponding entry
10220            in the literal escape switch. However, the opposite is not
10221            required, as the default for this switch is to jump to the
10222            literal text handling code.
10223         */
10224         switch ((U8)*++RExC_parse) {
10225             U8 arg;
10226         /* Special Escapes */
10227         case 'A':
10228             RExC_seen_zerolen++;
10229             ret = reg_node(pRExC_state, SBOL);
10230             *flagp |= SIMPLE;
10231             goto finish_meta_pat;
10232         case 'G':
10233             ret = reg_node(pRExC_state, GPOS);
10234             RExC_seen |= REG_SEEN_GPOS;
10235             *flagp |= SIMPLE;
10236             goto finish_meta_pat;
10237         case 'K':
10238             RExC_seen_zerolen++;
10239             ret = reg_node(pRExC_state, KEEPS);
10240             *flagp |= SIMPLE;
10241             /* XXX:dmq : disabling in-place substitution seems to
10242              * be necessary here to avoid cases of memory corruption, as
10243              * with: C<$_="x" x 80; s/x\K/y/> -- rgs
10244              */
10245             RExC_seen |= REG_SEEN_LOOKBEHIND;
10246             goto finish_meta_pat;
10247         case 'Z':
10248             ret = reg_node(pRExC_state, SEOL);
10249             *flagp |= SIMPLE;
10250             RExC_seen_zerolen++;                /* Do not optimize RE away */
10251             goto finish_meta_pat;
10252         case 'z':
10253             ret = reg_node(pRExC_state, EOS);
10254             *flagp |= SIMPLE;
10255             RExC_seen_zerolen++;                /* Do not optimize RE away */
10256             goto finish_meta_pat;
10257         case 'C':
10258             ret = reg_node(pRExC_state, CANY);
10259             RExC_seen |= REG_SEEN_CANY;
10260             *flagp |= HASWIDTH|SIMPLE;
10261             goto finish_meta_pat;
10262         case 'X':
10263             ret = reg_node(pRExC_state, CLUMP);
10264             *flagp |= HASWIDTH;
10265             goto finish_meta_pat;
10266
10267         case 'W':
10268             invert = 1;
10269             /* FALLTHROUGH */
10270         case 'w':
10271             arg = ANYOF_WORDCHAR;
10272             goto join_posix;
10273
10274         case 'b':
10275             RExC_seen_zerolen++;
10276             RExC_seen |= REG_SEEN_LOOKBEHIND;
10277             op = BOUND + get_regex_charset(RExC_flags);
10278             if (op > BOUNDA) {  /* /aa is same as /a */
10279                 op = BOUNDA;
10280             }
10281             ret = reg_node(pRExC_state, op);
10282             FLAGS(ret) = get_regex_charset(RExC_flags);
10283             *flagp |= SIMPLE;
10284             if (! SIZE_ONLY && (U8) *(RExC_parse + 1) == '{') {
10285                 ckWARNdep(RExC_parse, "\"\\b{\" is deprecated; use \"\\b\\{\" or \"\\b[{]\" instead");
10286             }
10287             goto finish_meta_pat;
10288         case 'B':
10289             RExC_seen_zerolen++;
10290             RExC_seen |= REG_SEEN_LOOKBEHIND;
10291             op = NBOUND + get_regex_charset(RExC_flags);
10292             if (op > NBOUNDA) { /* /aa is same as /a */
10293                 op = NBOUNDA;
10294             }
10295             ret = reg_node(pRExC_state, op);
10296             FLAGS(ret) = get_regex_charset(RExC_flags);
10297             *flagp |= SIMPLE;
10298             if (! SIZE_ONLY && (U8) *(RExC_parse + 1) == '{') {
10299                 ckWARNdep(RExC_parse, "\"\\B{\" is deprecated; use \"\\B\\{\" or \"\\B[{]\" instead");
10300             }
10301             goto finish_meta_pat;
10302
10303         case 'D':
10304             invert = 1;
10305             /* FALLTHROUGH */
10306         case 'd':
10307             arg = ANYOF_DIGIT;
10308             goto join_posix;
10309
10310         case 'R':
10311             ret = reg_node(pRExC_state, LNBREAK);
10312             *flagp |= HASWIDTH|SIMPLE;
10313             goto finish_meta_pat;
10314
10315         case 'H':
10316             invert = 1;
10317             /* FALLTHROUGH */
10318         case 'h':
10319             arg = ANYOF_BLANK;
10320             op = POSIXU;
10321             goto join_posix_op_known;
10322
10323         case 'V':
10324             invert = 1;
10325             /* FALLTHROUGH */
10326         case 'v':
10327             arg = ANYOF_VERTWS;
10328             op = POSIXU;
10329             goto join_posix_op_known;
10330
10331         case 'S':
10332             invert = 1;
10333             /* FALLTHROUGH */
10334         case 's':
10335             arg = ANYOF_SPACE;
10336
10337         join_posix:
10338
10339             op = POSIXD + get_regex_charset(RExC_flags);
10340             if (op > POSIXA) {  /* /aa is same as /a */
10341                 op = POSIXA;
10342             }
10343
10344         join_posix_op_known:
10345
10346             if (invert) {
10347                 op += NPOSIXD - POSIXD;
10348             }
10349
10350             ret = reg_node(pRExC_state, op);
10351             if (! SIZE_ONLY) {
10352                 FLAGS(ret) = namedclass_to_classnum(arg);
10353             }
10354
10355             *flagp |= HASWIDTH|SIMPLE;
10356             /* FALL THROUGH */
10357
10358          finish_meta_pat:           
10359             nextchar(pRExC_state);
10360             Set_Node_Length(ret, 2); /* MJD */
10361             break;          
10362         case 'p':
10363         case 'P':
10364             {
10365 #ifdef DEBUGGING
10366                 char* parse_start = RExC_parse - 2;
10367 #endif
10368
10369                 RExC_parse--;
10370
10371                 ret = regclass(pRExC_state, flagp,depth+1,
10372                                TRUE, /* means just parse this element */
10373                                FALSE, /* don't allow multi-char folds */
10374                                FALSE, /* don't silence non-portable warnings.
10375                                          It would be a bug if these returned
10376                                          non-portables */
10377                                NULL);
10378
10379                 RExC_parse--;
10380
10381                 Set_Node_Offset(ret, parse_start + 2);
10382                 Set_Node_Cur_Length(ret);
10383                 nextchar(pRExC_state);
10384             }
10385             break;
10386         case 'N': 
10387             /* Handle \N and \N{NAME} with multiple code points here and not
10388              * below because it can be multicharacter. join_exact() will join
10389              * them up later on.  Also this makes sure that things like
10390              * /\N{BLAH}+/ and \N{BLAH} being multi char Just Happen. dmq.
10391              * The options to the grok function call causes it to fail if the
10392              * sequence is just a single code point.  We then go treat it as
10393              * just another character in the current EXACT node, and hence it
10394              * gets uniform treatment with all the other characters.  The
10395              * special treatment for quantifiers is not needed for such single
10396              * character sequences */
10397             ++RExC_parse;
10398             if (! grok_bslash_N(pRExC_state, &ret, NULL, flagp, depth, FALSE,
10399                                 FALSE /* not strict */ )) {
10400                 RExC_parse--;
10401                 goto defchar;
10402             }
10403             break;
10404         case 'k':    /* Handle \k<NAME> and \k'NAME' */
10405         parse_named_seq:
10406         {   
10407             char ch= RExC_parse[1];         
10408             if (ch != '<' && ch != '\'' && ch != '{') {
10409                 RExC_parse++;
10410                 vFAIL2("Sequence %.2s... not terminated",parse_start);
10411             } else {
10412                 /* this pretty much dupes the code for (?P=...) in reg(), if
10413                    you change this make sure you change that */
10414                 char* name_start = (RExC_parse += 2);
10415                 U32 num = 0;
10416                 SV *sv_dat = reg_scan_name(pRExC_state,
10417                     SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
10418                 ch= (ch == '<') ? '>' : (ch == '{') ? '}' : '\'';
10419                 if (RExC_parse == name_start || *RExC_parse != ch)
10420                     vFAIL2("Sequence %.3s... not terminated",parse_start);
10421
10422                 if (!SIZE_ONLY) {
10423                     num = add_data( pRExC_state, 1, "S" );
10424                     RExC_rxi->data->data[num]=(void*)sv_dat;
10425                     SvREFCNT_inc_simple_void(sv_dat);
10426                 }
10427
10428                 RExC_sawback = 1;
10429                 ret = reganode(pRExC_state,
10430                                ((! FOLD)
10431                                  ? NREF
10432                                  : (ASCII_FOLD_RESTRICTED)
10433                                    ? NREFFA
10434                                    : (AT_LEAST_UNI_SEMANTICS)
10435                                      ? NREFFU
10436                                      : (LOC)
10437                                        ? NREFFL
10438                                        : NREFF),
10439                                 num);
10440                 *flagp |= HASWIDTH;
10441
10442                 /* override incorrect value set in reganode MJD */
10443                 Set_Node_Offset(ret, parse_start+1);
10444                 Set_Node_Cur_Length(ret); /* MJD */
10445                 nextchar(pRExC_state);
10446
10447             }
10448             break;
10449         }
10450         case 'g': 
10451         case '1': case '2': case '3': case '4':
10452         case '5': case '6': case '7': case '8': case '9':
10453             {
10454                 I32 num;
10455                 bool isg = *RExC_parse == 'g';
10456                 bool isrel = 0; 
10457                 bool hasbrace = 0;
10458                 if (isg) {
10459                     RExC_parse++;
10460                     if (*RExC_parse == '{') {
10461                         RExC_parse++;
10462                         hasbrace = 1;
10463                     }
10464                     if (*RExC_parse == '-') {
10465                         RExC_parse++;
10466                         isrel = 1;
10467                     }
10468                     if (hasbrace && !isDIGIT(*RExC_parse)) {
10469                         if (isrel) RExC_parse--;
10470                         RExC_parse -= 2;                            
10471                         goto parse_named_seq;
10472                 }   }
10473                 num = atoi(RExC_parse);
10474                 if (isg && num == 0)
10475                     vFAIL("Reference to invalid group 0");
10476                 if (isrel) {
10477                     num = RExC_npar - num;
10478                     if (num < 1)
10479                         vFAIL("Reference to nonexistent or unclosed group");
10480                 }
10481                 if (!isg && num > 9 && num >= RExC_npar)
10482                     /* Probably a character specified in octal, e.g. \35 */
10483                     goto defchar;
10484                 else {
10485                     char * const parse_start = RExC_parse - 1; /* MJD */
10486                     while (isDIGIT(*RExC_parse))
10487                         RExC_parse++;
10488                     if (parse_start == RExC_parse - 1) 
10489                         vFAIL("Unterminated \\g... pattern");
10490                     if (hasbrace) {
10491                         if (*RExC_parse != '}') 
10492                             vFAIL("Unterminated \\g{...} pattern");
10493                         RExC_parse++;
10494                     }    
10495                     if (!SIZE_ONLY) {
10496                         if (num > (I32)RExC_rx->nparens)
10497                             vFAIL("Reference to nonexistent group");
10498                     }
10499                     RExC_sawback = 1;
10500                     ret = reganode(pRExC_state,
10501                                    ((! FOLD)
10502                                      ? REF
10503                                      : (ASCII_FOLD_RESTRICTED)
10504                                        ? REFFA
10505                                        : (AT_LEAST_UNI_SEMANTICS)
10506                                          ? REFFU
10507                                          : (LOC)
10508                                            ? REFFL
10509                                            : REFF),
10510                                     num);
10511                     *flagp |= HASWIDTH;
10512
10513                     /* override incorrect value set in reganode MJD */
10514                     Set_Node_Offset(ret, parse_start+1);
10515                     Set_Node_Cur_Length(ret); /* MJD */
10516                     RExC_parse--;
10517                     nextchar(pRExC_state);
10518                 }
10519             }
10520             break;
10521         case '\0':
10522             if (RExC_parse >= RExC_end)
10523                 FAIL("Trailing \\");
10524             /* FALL THROUGH */
10525         default:
10526             /* Do not generate "unrecognized" warnings here, we fall
10527                back into the quick-grab loop below */
10528             parse_start--;
10529             goto defchar;
10530         }
10531         break;
10532
10533     case '#':
10534         if (RExC_flags & RXf_PMf_EXTENDED) {
10535             if ( reg_skipcomment( pRExC_state ) )
10536                 goto tryagain;
10537         }
10538         /* FALL THROUGH */
10539
10540     default:
10541
10542             parse_start = RExC_parse - 1;
10543
10544             RExC_parse++;
10545
10546         defchar: {
10547             STRLEN len = 0;
10548             UV ender;
10549             char *p;
10550             char *s;
10551 #define MAX_NODE_STRING_SIZE 127
10552             char foldbuf[MAX_NODE_STRING_SIZE+UTF8_MAXBYTES_CASE];
10553             char *s0;
10554             U8 upper_parse = MAX_NODE_STRING_SIZE;
10555             STRLEN foldlen;
10556             U8 node_type;
10557             bool next_is_quantifier;
10558             char * oldp = NULL;
10559
10560             /* If a folding node contains only code points that don't
10561              * participate in folds, it can be changed into an EXACT node,
10562              * which allows the optimizer more things to look for */
10563             bool maybe_exact;
10564
10565             ender = 0;
10566             node_type = compute_EXACTish(pRExC_state);
10567             ret = reg_node(pRExC_state, node_type);
10568
10569             /* In pass1, folded, we use a temporary buffer instead of the
10570              * actual node, as the node doesn't exist yet */
10571             s = (SIZE_ONLY && FOLD) ? foldbuf : STRING(ret);
10572
10573             s0 = s;
10574
10575         reparse:
10576
10577             /* We do the EXACTFish to EXACT node only if folding, and not if in
10578              * locale, as whether a character folds or not isn't known until
10579              * runtime */
10580             maybe_exact = FOLD && ! LOC;
10581
10582             /* XXX The node can hold up to 255 bytes, yet this only goes to
10583              * 127.  I (khw) do not know why.  Keeping it somewhat less than
10584              * 255 allows us to not have to worry about overflow due to
10585              * converting to utf8 and fold expansion, but that value is
10586              * 255-UTF8_MAXBYTES_CASE.  join_exact() may join adjacent nodes
10587              * split up by this limit into a single one using the real max of
10588              * 255.  Even at 127, this breaks under rare circumstances.  If
10589              * folding, we do not want to split a node at a character that is a
10590              * non-final in a multi-char fold, as an input string could just
10591              * happen to want to match across the node boundary.  The join
10592              * would solve that problem if the join actually happens.  But a
10593              * series of more than two nodes in a row each of 127 would cause
10594              * the first join to succeed to get to 254, but then there wouldn't
10595              * be room for the next one, which could at be one of those split
10596              * multi-char folds.  I don't know of any fool-proof solution.  One
10597              * could back off to end with only a code point that isn't such a
10598              * non-final, but it is possible for there not to be any in the
10599              * entire node. */
10600             for (p = RExC_parse - 1;
10601                  len < upper_parse && p < RExC_end;
10602                  len++)
10603             {
10604                 oldp = p;
10605
10606                 if (RExC_flags & RXf_PMf_EXTENDED)
10607                     p = regwhite( pRExC_state, p );
10608                 switch ((U8)*p) {
10609                 case '^':
10610                 case '$':
10611                 case '.':
10612                 case '[':
10613                 case '(':
10614                 case ')':
10615                 case '|':
10616                     goto loopdone;
10617                 case '\\':
10618                     /* Literal Escapes Switch
10619
10620                        This switch is meant to handle escape sequences that
10621                        resolve to a literal character.
10622
10623                        Every escape sequence that represents something
10624                        else, like an assertion or a char class, is handled
10625                        in the switch marked 'Special Escapes' above in this
10626                        routine, but also has an entry here as anything that
10627                        isn't explicitly mentioned here will be treated as
10628                        an unescaped equivalent literal.
10629                     */
10630
10631                     switch ((U8)*++p) {
10632                     /* These are all the special escapes. */
10633                     case 'A':             /* Start assertion */
10634                     case 'b': case 'B':   /* Word-boundary assertion*/
10635                     case 'C':             /* Single char !DANGEROUS! */
10636                     case 'd': case 'D':   /* digit class */
10637                     case 'g': case 'G':   /* generic-backref, pos assertion */
10638                     case 'h': case 'H':   /* HORIZWS */
10639                     case 'k': case 'K':   /* named backref, keep marker */
10640                     case 'p': case 'P':   /* Unicode property */
10641                               case 'R':   /* LNBREAK */
10642                     case 's': case 'S':   /* space class */
10643                     case 'v': case 'V':   /* VERTWS */
10644                     case 'w': case 'W':   /* word class */
10645                     case 'X':             /* eXtended Unicode "combining character sequence" */
10646                     case 'z': case 'Z':   /* End of line/string assertion */
10647                         --p;
10648                         goto loopdone;
10649
10650                     /* Anything after here is an escape that resolves to a
10651                        literal. (Except digits, which may or may not)
10652                      */
10653                     case 'n':
10654                         ender = '\n';
10655                         p++;
10656                         break;
10657                     case 'N': /* Handle a single-code point named character. */
10658                         /* The options cause it to fail if a multiple code
10659                          * point sequence.  Handle those in the switch() above
10660                          * */
10661                         RExC_parse = p + 1;
10662                         if (! grok_bslash_N(pRExC_state, NULL, &ender,
10663                                             flagp, depth, FALSE,
10664                                             FALSE /* not strict */ ))
10665                         {
10666                             RExC_parse = p = oldp;
10667                             goto loopdone;
10668                         }
10669                         p = RExC_parse;
10670                         if (ender > 0xff) {
10671                             REQUIRE_UTF8;
10672                         }
10673                         break;
10674                     case 'r':
10675                         ender = '\r';
10676                         p++;
10677                         break;
10678                     case 't':
10679                         ender = '\t';
10680                         p++;
10681                         break;
10682                     case 'f':
10683                         ender = '\f';
10684                         p++;
10685                         break;
10686                     case 'e':
10687                           ender = ASCII_TO_NATIVE('\033');
10688                         p++;
10689                         break;
10690                     case 'a':
10691                           ender = ASCII_TO_NATIVE('\007');
10692                         p++;
10693                         break;
10694                     case 'o':
10695                         {
10696                             UV result;
10697                             const char* error_msg;
10698
10699                             bool valid = grok_bslash_o(&p,
10700                                                        &result,
10701                                                        &error_msg,
10702                                                        TRUE, /* out warnings */
10703                                                        FALSE, /* not strict */
10704                                                        TRUE, /* Output warnings
10705                                                                 for non-
10706                                                                 portables */
10707                                                        UTF);
10708                             if (! valid) {
10709                                 RExC_parse = p; /* going to die anyway; point
10710                                                    to exact spot of failure */
10711                                 vFAIL(error_msg);
10712                             }
10713                             ender = result;
10714                             if (PL_encoding && ender < 0x100) {
10715                                 goto recode_encoding;
10716                             }
10717                             if (ender > 0xff) {
10718                                 REQUIRE_UTF8;
10719                             }
10720                             break;
10721                         }
10722                     case 'x':
10723                         {
10724                             UV result = UV_MAX; /* initialize to erroneous
10725                                                    value */
10726                             const char* error_msg;
10727
10728                             bool valid = grok_bslash_x(&p,
10729                                                        &result,
10730                                                        &error_msg,
10731                                                        TRUE, /* out warnings */
10732                                                        FALSE, /* not strict */
10733                                                        TRUE, /* Output warnings
10734                                                                 for non-
10735                                                                 portables */
10736                                                        UTF);
10737                             if (! valid) {
10738                                 RExC_parse = p; /* going to die anyway; point
10739                                                    to exact spot of failure */
10740                                 vFAIL(error_msg);
10741                             }
10742                             ender = result;
10743
10744                             if (PL_encoding && ender < 0x100) {
10745                                 goto recode_encoding;
10746                             }
10747                             if (ender > 0xff) {
10748                                 REQUIRE_UTF8;
10749                             }
10750                             break;
10751                         }
10752                     case 'c':
10753                         p++;
10754                         ender = grok_bslash_c(*p++, UTF, SIZE_ONLY);
10755                         break;
10756                     case '0': case '1': case '2': case '3':case '4':
10757                     case '5': case '6': case '7':
10758                         if (*p == '0' ||
10759                             (isDIGIT(p[1]) && atoi(p) >= RExC_npar))
10760                         {
10761                             I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
10762                             STRLEN numlen = 3;
10763                             ender = grok_oct(p, &numlen, &flags, NULL);
10764                             if (ender > 0xff) {
10765                                 REQUIRE_UTF8;
10766                             }
10767                             p += numlen;
10768                             if (SIZE_ONLY   /* like \08, \178 */
10769                                 && numlen < 3
10770                                 && p < RExC_end
10771                                 && isDIGIT(*p) && ckWARN(WARN_REGEXP))
10772                             {
10773                                 reg_warn_non_literal_string(
10774                                          p + 1,
10775                                          form_short_octal_warning(p, numlen));
10776                             }
10777                         }
10778                         else {  /* Not to be treated as an octal constant, go
10779                                    find backref */
10780                             --p;
10781                             goto loopdone;
10782                         }
10783                         if (PL_encoding && ender < 0x100)
10784                             goto recode_encoding;
10785                         break;
10786                     recode_encoding:
10787                         if (! RExC_override_recoding) {
10788                             SV* enc = PL_encoding;
10789                             ender = reg_recode((const char)(U8)ender, &enc);
10790                             if (!enc && SIZE_ONLY)
10791                                 ckWARNreg(p, "Invalid escape in the specified encoding");
10792                             REQUIRE_UTF8;
10793                         }
10794                         break;
10795                     case '\0':
10796                         if (p >= RExC_end)
10797                             FAIL("Trailing \\");
10798                         /* FALL THROUGH */
10799                     default:
10800                         if (!SIZE_ONLY&& isALPHANUMERIC(*p)) {
10801                             /* Include any { following the alpha to emphasize
10802                              * that it could be part of an escape at some point
10803                              * in the future */
10804                             int len = (isALPHA(*p) && *(p + 1) == '{') ? 2 : 1;
10805                             ckWARN3reg(p + len, "Unrecognized escape \\%.*s passed through", len, p);
10806                         }
10807                         goto normal_default;
10808                     } /* End of switch on '\' */
10809                     break;
10810                 default:    /* A literal character */
10811
10812                     if (! SIZE_ONLY
10813                         && RExC_flags & RXf_PMf_EXTENDED
10814                         && ckWARN(WARN_DEPRECATED)
10815                         && is_PATWS_non_low(p, UTF))
10816                     {
10817                         vWARN_dep(p + ((UTF) ? UTF8SKIP(p) : 1),
10818                                 "Escape literal pattern white space under /x");
10819                     }
10820
10821                   normal_default:
10822                     if (UTF8_IS_START(*p) && UTF) {
10823                         STRLEN numlen;
10824                         ender = utf8n_to_uvchr((U8*)p, RExC_end - p,
10825                                                &numlen, UTF8_ALLOW_DEFAULT);
10826                         p += numlen;
10827                     }
10828                     else
10829                         ender = (U8) *p++;
10830                     break;
10831                 } /* End of switch on the literal */
10832
10833                 /* Here, have looked at the literal character and <ender>
10834                  * contains its ordinal, <p> points to the character after it
10835                  */
10836
10837                 if ( RExC_flags & RXf_PMf_EXTENDED)
10838                     p = regwhite( pRExC_state, p );
10839
10840                 /* If the next thing is a quantifier, it applies to this
10841                  * character only, which means that this character has to be in
10842                  * its own node and can't just be appended to the string in an
10843                  * existing node, so if there are already other characters in
10844                  * the node, close the node with just them, and set up to do
10845                  * this character again next time through, when it will be the
10846                  * only thing in its new node */
10847                 if ((next_is_quantifier = (p < RExC_end && ISMULT2(p))) && len)
10848                 {
10849                     p = oldp;
10850                     goto loopdone;
10851                 }
10852
10853                 if (FOLD) {
10854                     if (UTF
10855                             /* See comments for join_exact() as to why we fold
10856                              * this non-UTF at compile time */
10857                         || (node_type == EXACTFU
10858                             && ender == LATIN_SMALL_LETTER_SHARP_S))
10859                     {
10860
10861
10862                         /* Prime the casefolded buffer.  Locale rules, which
10863                          * apply only to code points < 256, aren't known until
10864                          * execution, so for them, just output the original
10865                          * character using utf8.  If we start to fold non-UTF
10866                          * patterns, be sure to update join_exact() */
10867                         if (LOC && ender < 256) {
10868                             if (UNI_IS_INVARIANT(ender)) {
10869                                 *s = (U8) ender;
10870                                 foldlen = 1;
10871                             } else {
10872                                 *s = UTF8_TWO_BYTE_HI(ender);
10873                                 *(s + 1) = UTF8_TWO_BYTE_LO(ender);
10874                                 foldlen = 2;
10875                             }
10876                         }
10877                         else {
10878                             UV folded = _to_uni_fold_flags(
10879                                            ender,
10880                                            (U8 *) s,
10881                                            &foldlen,
10882                                            FOLD_FLAGS_FULL
10883                                            | ((LOC) ?  FOLD_FLAGS_LOCALE
10884                                                     : (ASCII_FOLD_RESTRICTED)
10885                                                       ? FOLD_FLAGS_NOMIX_ASCII
10886                                                       : 0)
10887                                             );
10888
10889                             /* If this node only contains non-folding code
10890                              * points so far, see if this new one is also
10891                              * non-folding */
10892                             if (maybe_exact) {
10893                                 if (folded != ender) {
10894                                     maybe_exact = FALSE;
10895                                 }
10896                                 else {
10897                                     /* Here the fold is the original; we have
10898                                      * to check further to see if anything
10899                                      * folds to it */
10900                                     if (! PL_utf8_foldable) {
10901                                         SV* swash = swash_init("utf8",
10902                                                            "_Perl_Any_Folds",
10903                                                            &PL_sv_undef, 1, 0);
10904                                         PL_utf8_foldable =
10905                                                     _get_swash_invlist(swash);
10906                                         SvREFCNT_dec_NN(swash);
10907                                     }
10908                                     if (_invlist_contains_cp(PL_utf8_foldable,
10909                                                              ender))
10910                                     {
10911                                         maybe_exact = FALSE;
10912                                     }
10913                                 }
10914                             }
10915                             ender = folded;
10916                         }
10917                         s += foldlen;
10918
10919                         /* The loop increments <len> each time, as all but this
10920                          * path (and the one just below for UTF) through it add
10921                          * a single byte to the EXACTish node.  But this one
10922                          * has changed len to be the correct final value, so
10923                          * subtract one to cancel out the increment that
10924                          * follows */
10925                         len += foldlen - 1;
10926                     }
10927                     else {
10928                         *(s++) = (char) ender;
10929                         maybe_exact &= ! IS_IN_SOME_FOLD_L1(ender);
10930                     }
10931                 }
10932                 else if (UTF) {
10933                     const STRLEN unilen = reguni(pRExC_state, ender, s);
10934                     if (unilen > 0) {
10935                        s   += unilen;
10936                        len += unilen;
10937                     }
10938
10939                     /* See comment just above for - 1 */
10940                     len--;
10941                 }
10942                 else {
10943                     REGC((char)ender, s++);
10944                 }
10945
10946                 if (next_is_quantifier) {
10947
10948                     /* Here, the next input is a quantifier, and to get here,
10949                      * the current character is the only one in the node.
10950                      * Also, here <len> doesn't include the final byte for this
10951                      * character */
10952                     len++;
10953                     goto loopdone;
10954                 }
10955
10956             } /* End of loop through literal characters */
10957
10958             /* Here we have either exhausted the input or ran out of room in
10959              * the node.  (If we encountered a character that can't be in the
10960              * node, transfer is made directly to <loopdone>, and so we
10961              * wouldn't have fallen off the end of the loop.)  In the latter
10962              * case, we artificially have to split the node into two, because
10963              * we just don't have enough space to hold everything.  This
10964              * creates a problem if the final character participates in a
10965              * multi-character fold in the non-final position, as a match that
10966              * should have occurred won't, due to the way nodes are matched,
10967              * and our artificial boundary.  So back off until we find a non-
10968              * problematic character -- one that isn't at the beginning or
10969              * middle of such a fold.  (Either it doesn't participate in any
10970              * folds, or appears only in the final position of all the folds it
10971              * does participate in.)  A better solution with far fewer false
10972              * positives, and that would fill the nodes more completely, would
10973              * be to actually have available all the multi-character folds to
10974              * test against, and to back-off only far enough to be sure that
10975              * this node isn't ending with a partial one.  <upper_parse> is set
10976              * further below (if we need to reparse the node) to include just
10977              * up through that final non-problematic character that this code
10978              * identifies, so when it is set to less than the full node, we can
10979              * skip the rest of this */
10980             if (FOLD && p < RExC_end && upper_parse == MAX_NODE_STRING_SIZE) {
10981
10982                 const STRLEN full_len = len;
10983
10984                 assert(len >= MAX_NODE_STRING_SIZE);
10985
10986                 /* Here, <s> points to the final byte of the final character.
10987                  * Look backwards through the string until find a non-
10988                  * problematic character */
10989
10990                 if (! UTF) {
10991
10992                     /* These two have no multi-char folds to non-UTF characters
10993                      */
10994                     if (ASCII_FOLD_RESTRICTED || LOC) {
10995                         goto loopdone;
10996                     }
10997
10998                     while (--s >= s0 && IS_NON_FINAL_FOLD(*s)) { }
10999                     len = s - s0 + 1;
11000                 }
11001                 else {
11002                     if (!  PL_NonL1NonFinalFold) {
11003                         PL_NonL1NonFinalFold = _new_invlist_C_array(
11004                                         NonL1_Perl_Non_Final_Folds_invlist);
11005                     }
11006
11007                     /* Point to the first byte of the final character */
11008                     s = (char *) utf8_hop((U8 *) s, -1);
11009
11010                     while (s >= s0) {   /* Search backwards until find
11011                                            non-problematic char */
11012                         if (UTF8_IS_INVARIANT(*s)) {
11013
11014                             /* There are no ascii characters that participate
11015                              * in multi-char folds under /aa.  In EBCDIC, the
11016                              * non-ascii invariants are all control characters,
11017                              * so don't ever participate in any folds. */
11018                             if (ASCII_FOLD_RESTRICTED
11019                                 || ! IS_NON_FINAL_FOLD(*s))
11020                             {
11021                                 break;
11022                             }
11023                         }
11024                         else if (UTF8_IS_DOWNGRADEABLE_START(*s)) {
11025
11026                             /* No Latin1 characters participate in multi-char
11027                              * folds under /l */
11028                             if (LOC
11029                                 || ! IS_NON_FINAL_FOLD(TWO_BYTE_UTF8_TO_UNI(
11030                                                                 *s, *(s+1))))
11031                             {
11032                                 break;
11033                             }
11034                         }
11035                         else if (! _invlist_contains_cp(
11036                                         PL_NonL1NonFinalFold,
11037                                         valid_utf8_to_uvchr((U8 *) s, NULL)))
11038                         {
11039                             break;
11040                         }
11041
11042                         /* Here, the current character is problematic in that
11043                          * it does occur in the non-final position of some
11044                          * fold, so try the character before it, but have to
11045                          * special case the very first byte in the string, so
11046                          * we don't read outside the string */
11047                         s = (s == s0) ? s -1 : (char *) utf8_hop((U8 *) s, -1);
11048                     } /* End of loop backwards through the string */
11049
11050                     /* If there were only problematic characters in the string,
11051                      * <s> will point to before s0, in which case the length
11052                      * should be 0, otherwise include the length of the
11053                      * non-problematic character just found */
11054                     len = (s < s0) ? 0 : s - s0 + UTF8SKIP(s);
11055                 }
11056
11057                 /* Here, have found the final character, if any, that is
11058                  * non-problematic as far as ending the node without splitting
11059                  * it across a potential multi-char fold.  <len> contains the
11060                  * number of bytes in the node up-to and including that
11061                  * character, or is 0 if there is no such character, meaning
11062                  * the whole node contains only problematic characters.  In
11063                  * this case, give up and just take the node as-is.  We can't
11064                  * do any better */
11065                 if (len == 0) {
11066                     len = full_len;
11067                 } else {
11068
11069                     /* Here, the node does contain some characters that aren't
11070                      * problematic.  If one such is the final character in the
11071                      * node, we are done */
11072                     if (len == full_len) {
11073                         goto loopdone;
11074                     }
11075                     else if (len + ((UTF) ? UTF8SKIP(s) : 1) == full_len) {
11076
11077                         /* If the final character is problematic, but the
11078                          * penultimate is not, back-off that last character to
11079                          * later start a new node with it */
11080                         p = oldp;
11081                         goto loopdone;
11082                     }
11083
11084                     /* Here, the final non-problematic character is earlier
11085                      * in the input than the penultimate character.  What we do
11086                      * is reparse from the beginning, going up only as far as
11087                      * this final ok one, thus guaranteeing that the node ends
11088                      * in an acceptable character.  The reason we reparse is
11089                      * that we know how far in the character is, but we don't
11090                      * know how to correlate its position with the input parse.
11091                      * An alternate implementation would be to build that
11092                      * correlation as we go along during the original parse,
11093                      * but that would entail extra work for every node, whereas
11094                      * this code gets executed only when the string is too
11095                      * large for the node, and the final two characters are
11096                      * problematic, an infrequent occurrence.  Yet another
11097                      * possible strategy would be to save the tail of the
11098                      * string, and the next time regatom is called, initialize
11099                      * with that.  The problem with this is that unless you
11100                      * back off one more character, you won't be guaranteed
11101                      * regatom will get called again, unless regbranch,
11102                      * regpiece ... are also changed.  If you do back off that
11103                      * extra character, so that there is input guaranteed to
11104                      * force calling regatom, you can't handle the case where
11105                      * just the first character in the node is acceptable.  I
11106                      * (khw) decided to try this method which doesn't have that
11107                      * pitfall; if performance issues are found, we can do a
11108                      * combination of the current approach plus that one */
11109                     upper_parse = len;
11110                     len = 0;
11111                     s = s0;
11112                     goto reparse;
11113                 }
11114             }   /* End of verifying node ends with an appropriate char */
11115
11116         loopdone:   /* Jumped to when encounters something that shouldn't be in
11117                        the node */
11118
11119             /* If 'maybe_exact' is still set here, means there are no
11120              * code points in the node that participate in folds */
11121             if (FOLD && maybe_exact) {
11122                 OP(ret) = EXACT;
11123             }
11124
11125             /* I (khw) don't know if you can get here with zero length, but the
11126              * old code handled this situation by creating a zero-length EXACT
11127              * node.  Might as well be NOTHING instead */
11128             if (len == 0) {
11129                 OP(ret) = NOTHING;
11130             }
11131             else{
11132                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, len, ender);
11133             }
11134
11135             RExC_parse = p - 1;
11136             Set_Node_Cur_Length(ret); /* MJD */
11137             nextchar(pRExC_state);
11138             {
11139                 /* len is STRLEN which is unsigned, need to copy to signed */
11140                 IV iv = len;
11141                 if (iv < 0)
11142                     vFAIL("Internal disaster");
11143             }
11144
11145         } /* End of label 'defchar:' */
11146         break;
11147     } /* End of giant switch on input character */
11148
11149     return(ret);
11150 }
11151
11152 STATIC char *
11153 S_regwhite( RExC_state_t *pRExC_state, char *p )
11154 {
11155     const char *e = RExC_end;
11156
11157     PERL_ARGS_ASSERT_REGWHITE;
11158
11159     while (p < e) {
11160         if (isSPACE(*p))
11161             ++p;
11162         else if (*p == '#') {
11163             bool ended = 0;
11164             do {
11165                 if (*p++ == '\n') {
11166                     ended = 1;
11167                     break;
11168                 }
11169             } while (p < e);
11170             if (!ended)
11171                 RExC_seen |= REG_SEEN_RUN_ON_COMMENT;
11172         }
11173         else
11174             break;
11175     }
11176     return p;
11177 }
11178
11179 STATIC char *
11180 S_regpatws( RExC_state_t *pRExC_state, char *p , const bool recognize_comment )
11181 {
11182     /* Returns the next non-pattern-white space, non-comment character (the
11183      * latter only if 'recognize_comment is true) in the string p, which is
11184      * ended by RExC_end.  If there is no line break ending a comment,
11185      * RExC_seen has added the REG_SEEN_RUN_ON_COMMENT flag; */
11186     const char *e = RExC_end;
11187
11188     PERL_ARGS_ASSERT_REGPATWS;
11189
11190     while (p < e) {
11191         STRLEN len;
11192         if ((len = is_PATWS_safe(p, e, UTF))) {
11193             p += len;
11194         }
11195         else if (recognize_comment && *p == '#') {
11196             bool ended = 0;
11197             do {
11198                 p++;
11199                 if (is_LNBREAK_safe(p, e, UTF)) {
11200                     ended = 1;
11201                     break;
11202                 }
11203             } while (p < e);
11204             if (!ended)
11205                 RExC_seen |= REG_SEEN_RUN_ON_COMMENT;
11206         }
11207         else
11208             break;
11209     }
11210     return p;
11211 }
11212
11213 /* Parse POSIX character classes: [[:foo:]], [[=foo=]], [[.foo.]].
11214    Character classes ([:foo:]) can also be negated ([:^foo:]).
11215    Returns a named class id (ANYOF_XXX) if successful, -1 otherwise.
11216    Equivalence classes ([=foo=]) and composites ([.foo.]) are parsed,
11217    but trigger failures because they are currently unimplemented. */
11218
11219 #define POSIXCC_DONE(c)   ((c) == ':')
11220 #define POSIXCC_NOTYET(c) ((c) == '=' || (c) == '.')
11221 #define POSIXCC(c) (POSIXCC_DONE(c) || POSIXCC_NOTYET(c))
11222
11223 PERL_STATIC_INLINE I32
11224 S_regpposixcc(pTHX_ RExC_state_t *pRExC_state, I32 value, SV *free_me,
11225                     const bool strict)
11226 {
11227     dVAR;
11228     I32 namedclass = OOB_NAMEDCLASS;
11229
11230     PERL_ARGS_ASSERT_REGPPOSIXCC;
11231
11232     if (value == '[' && RExC_parse + 1 < RExC_end &&
11233         /* I smell either [: or [= or [. -- POSIX has been here, right? */
11234         POSIXCC(UCHARAT(RExC_parse)))
11235     {
11236         const char c = UCHARAT(RExC_parse);
11237         char* const s = RExC_parse++;
11238
11239         while (RExC_parse < RExC_end && UCHARAT(RExC_parse) != c)
11240             RExC_parse++;
11241         if (RExC_parse == RExC_end) {
11242             if (strict) {
11243
11244                 /* Try to give a better location for the error (than the end of
11245                  * the string) by looking for the matching ']' */
11246                 RExC_parse = s;
11247                 while (RExC_parse < RExC_end && UCHARAT(RExC_parse) != ']') {
11248                     RExC_parse++;
11249                 }
11250                 vFAIL2("Unmatched '%c' in POSIX class", c);
11251             }
11252             /* Grandfather lone [:, [=, [. */
11253             RExC_parse = s;
11254         }
11255         else {
11256             const char* const t = RExC_parse++; /* skip over the c */
11257             assert(*t == c);
11258
11259             if (UCHARAT(RExC_parse) == ']') {
11260                 const char *posixcc = s + 1;
11261                 RExC_parse++; /* skip over the ending ] */
11262
11263                 if (*s == ':') {
11264                     const I32 complement = *posixcc == '^' ? *posixcc++ : 0;
11265                     const I32 skip = t - posixcc;
11266
11267                     /* Initially switch on the length of the name.  */
11268                     switch (skip) {
11269                     case 4:
11270                         if (memEQ(posixcc, "word", 4)) /* this is not POSIX,
11271                                                           this is the Perl \w
11272                                                         */
11273                             namedclass = ANYOF_WORDCHAR;
11274                         break;
11275                     case 5:
11276                         /* Names all of length 5.  */
11277                         /* alnum alpha ascii blank cntrl digit graph lower
11278                            print punct space upper  */
11279                         /* Offset 4 gives the best switch position.  */
11280                         switch (posixcc[4]) {
11281                         case 'a':
11282                             if (memEQ(posixcc, "alph", 4)) /* alpha */
11283                                 namedclass = ANYOF_ALPHA;
11284                             break;
11285                         case 'e':
11286                             if (memEQ(posixcc, "spac", 4)) /* space */
11287                                 namedclass = ANYOF_PSXSPC;
11288                             break;
11289                         case 'h':
11290                             if (memEQ(posixcc, "grap", 4)) /* graph */
11291                                 namedclass = ANYOF_GRAPH;
11292                             break;
11293                         case 'i':
11294                             if (memEQ(posixcc, "asci", 4)) /* ascii */
11295                                 namedclass = ANYOF_ASCII;
11296                             break;
11297                         case 'k':
11298                             if (memEQ(posixcc, "blan", 4)) /* blank */
11299                                 namedclass = ANYOF_BLANK;
11300                             break;
11301                         case 'l':
11302                             if (memEQ(posixcc, "cntr", 4)) /* cntrl */
11303                                 namedclass = ANYOF_CNTRL;
11304                             break;
11305                         case 'm':
11306                             if (memEQ(posixcc, "alnu", 4)) /* alnum */
11307                                 namedclass = ANYOF_ALPHANUMERIC;
11308                             break;
11309                         case 'r':
11310                             if (memEQ(posixcc, "lowe", 4)) /* lower */
11311                                 namedclass = (FOLD) ? ANYOF_CASED : ANYOF_LOWER;
11312                             else if (memEQ(posixcc, "uppe", 4)) /* upper */
11313                                 namedclass = (FOLD) ? ANYOF_CASED : ANYOF_UPPER;
11314                             break;
11315                         case 't':
11316                             if (memEQ(posixcc, "digi", 4)) /* digit */
11317                                 namedclass = ANYOF_DIGIT;
11318                             else if (memEQ(posixcc, "prin", 4)) /* print */
11319                                 namedclass = ANYOF_PRINT;
11320                             else if (memEQ(posixcc, "punc", 4)) /* punct */
11321                                 namedclass = ANYOF_PUNCT;
11322                             break;
11323                         }
11324                         break;
11325                     case 6:
11326                         if (memEQ(posixcc, "xdigit", 6))
11327                             namedclass = ANYOF_XDIGIT;
11328                         break;
11329                     }
11330
11331                     if (namedclass == OOB_NAMEDCLASS)
11332                         Simple_vFAIL3("POSIX class [:%.*s:] unknown",
11333                                       t - s - 1, s + 1);
11334
11335                     /* The #defines are structured so each complement is +1 to
11336                      * the normal one */
11337                     if (complement) {
11338                         namedclass++;
11339                     }
11340                     assert (posixcc[skip] == ':');
11341                     assert (posixcc[skip+1] == ']');
11342                 } else if (!SIZE_ONLY) {
11343                     /* [[=foo=]] and [[.foo.]] are still future. */
11344
11345                     /* adjust RExC_parse so the warning shows after
11346                        the class closes */
11347                     while (UCHARAT(RExC_parse) && UCHARAT(RExC_parse) != ']')
11348                         RExC_parse++;
11349                     SvREFCNT_dec(free_me);
11350                     vFAIL3("POSIX syntax [%c %c] is reserved for future extensions", c, c);
11351                 }
11352             } else {
11353                 /* Maternal grandfather:
11354                  * "[:" ending in ":" but not in ":]" */
11355                 if (strict) {
11356                     vFAIL("Unmatched '[' in POSIX class");
11357                 }
11358
11359                 /* Grandfather lone [:, [=, [. */
11360                 RExC_parse = s;
11361             }
11362         }
11363     }
11364
11365     return namedclass;
11366 }
11367
11368 STATIC bool
11369 S_could_it_be_a_POSIX_class(pTHX_ RExC_state_t *pRExC_state)
11370 {
11371     /* This applies some heuristics at the current parse position (which should
11372      * be at a '[') to see if what follows might be intended to be a [:posix:]
11373      * class.  It returns true if it really is a posix class, of course, but it
11374      * also can return true if it thinks that what was intended was a posix
11375      * class that didn't quite make it.
11376      *
11377      * It will return true for
11378      *      [:alphanumerics:
11379      *      [:alphanumerics]  (as long as the ] isn't followed immediately by a
11380      *                         ')' indicating the end of the (?[
11381      *      [:any garbage including %^&$ punctuation:]
11382      *
11383      * This is designed to be called only from S_handle_regex_sets; it could be
11384      * easily adapted to be called from the spot at the beginning of regclass()
11385      * that checks to see in a normal bracketed class if the surrounding []
11386      * have been omitted ([:word:] instead of [[:word:]]).  But doing so would
11387      * change long-standing behavior, so I (khw) didn't do that */
11388     char* p = RExC_parse + 1;
11389     char first_char = *p;
11390
11391     PERL_ARGS_ASSERT_COULD_IT_BE_A_POSIX_CLASS;
11392
11393     assert(*(p - 1) == '[');
11394
11395     if (! POSIXCC(first_char)) {
11396         return FALSE;
11397     }
11398
11399     p++;
11400     while (p < RExC_end && isWORDCHAR(*p)) p++;
11401
11402     if (p >= RExC_end) {
11403         return FALSE;
11404     }
11405
11406     if (p - RExC_parse > 2    /* Got at least 1 word character */
11407         && (*p == first_char
11408             || (*p == ']' && p + 1 < RExC_end && *(p + 1) != ')')))
11409     {
11410         return TRUE;
11411     }
11412
11413     p = (char *) memchr(RExC_parse, ']', RExC_end - RExC_parse);
11414
11415     return (p
11416             && p - RExC_parse > 2 /* [:] evaluates to colon;
11417                                       [::] is a bad posix class. */
11418             && first_char == *(p - 1));
11419 }
11420
11421 STATIC regnode *
11422 S_handle_regex_sets(pTHX_ RExC_state_t *pRExC_state, SV** return_invlist, I32 *flagp, U32 depth,
11423                    char * const oregcomp_parse)
11424 {
11425     /* Handle the (?[...]) construct to do set operations */
11426
11427     U8 curchar;
11428     UV start, end;      /* End points of code point ranges */
11429     SV* result_string;
11430     char *save_end, *save_parse;
11431     SV* final;
11432     STRLEN len;
11433     regnode* node;
11434     AV* stack;
11435     const bool save_fold = FOLD;
11436
11437     GET_RE_DEBUG_FLAGS_DECL;
11438
11439     PERL_ARGS_ASSERT_HANDLE_REGEX_SETS;
11440
11441     if (LOC) {
11442         vFAIL("(?[...]) not valid in locale");
11443     }
11444     RExC_uni_semantics = 1;
11445
11446     /* This will return only an ANYOF regnode, or (unlikely) something smaller
11447      * (such as EXACT).  Thus we can skip most everything if just sizing.  We
11448      * call regclass to handle '[]' so as to not have to reinvent its parsing
11449      * rules here (throwing away the size it computes each time).  And, we exit
11450      * upon an unescaped ']' that isn't one ending a regclass.  To do both
11451      * these things, we need to realize that something preceded by a backslash
11452      * is escaped, so we have to keep track of backslashes */
11453     if (SIZE_ONLY) {
11454
11455         Perl_ck_warner_d(aTHX_
11456             packWARN(WARN_EXPERIMENTAL__REGEX_SETS),
11457             "The regex_sets feature is experimental" REPORT_LOCATION,
11458             (int) (RExC_parse - RExC_precomp) , RExC_precomp, RExC_parse);
11459
11460         while (RExC_parse < RExC_end) {
11461             SV* current = NULL;
11462             RExC_parse = regpatws(pRExC_state, RExC_parse,
11463                                 TRUE); /* means recognize comments */
11464             switch (*RExC_parse) {
11465                 default:
11466                     break;
11467                 case '\\':
11468                     /* Skip the next byte (which could cause us to end up in
11469                      * the middle of a UTF-8 character, but since none of those
11470                      * are confusable with anything we currently handle in this
11471                      * switch (invariants all), it's safe.  We'll just hit the
11472                      * default: case next time and keep on incrementing until
11473                      * we find one of the invariants we do handle. */
11474                     RExC_parse++;
11475                     break;
11476                 case '[':
11477                 {
11478                     /* If this looks like it is a [:posix:] class, leave the
11479                      * parse pointer at the '[' to fool regclass() into
11480                      * thinking it is part of a '[[:posix:]]'.  That function
11481                      * will use strict checking to force a syntax error if it
11482                      * doesn't work out to a legitimate class */
11483                     bool is_posix_class
11484                                     = could_it_be_a_POSIX_class(pRExC_state);
11485                     if (! is_posix_class) {
11486                         RExC_parse++;
11487                     }
11488
11489                     (void) regclass(pRExC_state, flagp,depth+1,
11490                                     is_posix_class, /* parse the whole char
11491                                                        class only if not a
11492                                                        posix class */
11493                                     FALSE, /* don't allow multi-char folds */
11494                                     TRUE, /* silence non-portable warnings. */
11495                                     &current);
11496                     /* function call leaves parse pointing to the ']', except
11497                      * if we faked it */
11498                     if (is_posix_class) {
11499                         RExC_parse--;
11500                     }
11501
11502                     SvREFCNT_dec(current);   /* In case it returned something */
11503                     break;
11504                 }
11505
11506                 case ']':
11507                     RExC_parse++;
11508                     if (RExC_parse < RExC_end
11509                         && *RExC_parse == ')')
11510                     {
11511                         node = reganode(pRExC_state, ANYOF, 0);
11512                         RExC_size += ANYOF_SKIP;
11513                         nextchar(pRExC_state);
11514                         Set_Node_Length(node,
11515                                 RExC_parse - oregcomp_parse + 1); /* MJD */
11516                         return node;
11517                     }
11518                     goto no_close;
11519             }
11520             RExC_parse++;
11521         }
11522
11523         no_close:
11524         FAIL("Syntax error in (?[...])");
11525     }
11526
11527     /* Pass 2 only after this.  Everything in this construct is a
11528      * metacharacter.  Operands begin with either a '\' (for an escape
11529      * sequence), or a '[' for a bracketed character class.  Any other
11530      * character should be an operator, or parenthesis for grouping.  Both
11531      * types of operands are handled by calling regclass() to parse them.  It
11532      * is called with a parameter to indicate to return the computed inversion
11533      * list.  The parsing here is implemented via a stack.  Each entry on the
11534      * stack is a single character representing one of the operators, or the
11535      * '('; or else a pointer to an operand inversion list. */
11536
11537 #define IS_OPERAND(a)  (! SvIOK(a))
11538
11539     /* The stack starts empty.  It is a syntax error if the first thing parsed
11540      * is a binary operator; everything else is pushed on the stack.  When an
11541      * operand is parsed, the top of the stack is examined.  If it is a binary
11542      * operator, the item before it should be an operand, and both are replaced
11543      * by the result of doing that operation on the new operand and the one on
11544      * the stack.   Thus a sequence of binary operands is reduced to a single
11545      * one before the next one is parsed.
11546      *
11547      * A unary operator may immediately follow a binary in the input, for
11548      * example
11549      *      [a] + ! [b]
11550      * When an operand is parsed and the top of the stack is a unary operator,
11551      * the operation is performed, and then the stack is rechecked to see if
11552      * this new operand is part of a binary operation; if so, it is handled as
11553      * above.
11554      *
11555      * A '(' is simply pushed on the stack; it is valid only if the stack is
11556      * empty, or the top element of the stack is an operator or another '('
11557      * (for which the parenthesized expression will become an operand).  By the
11558      * time the corresponding ')' is parsed everything in between should have
11559      * been parsed and evaluated to a single operand (or else is a syntax
11560      * error), and is handled as a regular operand */
11561
11562     stack = newAV();
11563
11564     while (RExC_parse < RExC_end) {
11565         I32 top_index = av_tindex(stack);
11566         SV** top_ptr;
11567         SV* current = NULL;
11568
11569         /* Skip white space */
11570         RExC_parse = regpatws(pRExC_state, RExC_parse,
11571                                 TRUE); /* means recognize comments */
11572         if (RExC_parse >= RExC_end) {
11573             Perl_croak(aTHX_ "panic: Read past end of '(?[ ])'");
11574         }
11575         if ((curchar = UCHARAT(RExC_parse)) == ']') {
11576             break;
11577         }
11578
11579         switch (curchar) {
11580
11581             case '?':
11582                 if (av_tindex(stack) >= 0   /* This makes sure that we can
11583                                                safely subtract 1 from
11584                                                RExC_parse in the next clause.
11585                                                If we have something on the
11586                                                stack, we have parsed something
11587                                              */
11588                     && UCHARAT(RExC_parse - 1) == '('
11589                     && RExC_parse < RExC_end)
11590                 {
11591                     /* If is a '(?', could be an embedded '(?flags:(?[...])'.
11592                      * This happens when we have some thing like
11593                      *
11594                      *   my $thai_or_lao = qr/(?[ \p{Thai} + \p{Lao} ])/;
11595                      *   ...
11596                      *   qr/(?[ \p{Digit} & $thai_or_lao ])/;
11597                      *
11598                      * Here we would be handling the interpolated
11599                      * '$thai_or_lao'.  We handle this by a recursive call to
11600                      * ourselves which returns the inversion list the
11601                      * interpolated expression evaluates to.  We use the flags
11602                      * from the interpolated pattern. */
11603                     U32 save_flags = RExC_flags;
11604                     const char * const save_parse = ++RExC_parse;
11605
11606                     parse_lparen_question_flags(pRExC_state);
11607
11608                     if (RExC_parse == save_parse  /* Makes sure there was at
11609                                                      least one flag (or this
11610                                                      embedding wasn't compiled)
11611                                                    */
11612                         || RExC_parse >= RExC_end - 4
11613                         || UCHARAT(RExC_parse) != ':'
11614                         || UCHARAT(++RExC_parse) != '('
11615                         || UCHARAT(++RExC_parse) != '?'
11616                         || UCHARAT(++RExC_parse) != '[')
11617                     {
11618
11619                         /* In combination with the above, this moves the
11620                          * pointer to the point just after the first erroneous
11621                          * character (or if there are no flags, to where they
11622                          * should have been) */
11623                         if (RExC_parse >= RExC_end - 4) {
11624                             RExC_parse = RExC_end;
11625                         }
11626                         else if (RExC_parse != save_parse) {
11627                             RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
11628                         }
11629                         vFAIL("Expecting '(?flags:(?[...'");
11630                     }
11631                     RExC_parse++;
11632                     (void) handle_regex_sets(pRExC_state, &current, flagp,
11633                                                     depth+1, oregcomp_parse);
11634
11635                     /* Here, 'current' contains the embedded expression's
11636                      * inversion list, and RExC_parse points to the trailing
11637                      * ']'; the next character should be the ')' which will be
11638                      * paired with the '(' that has been put on the stack, so
11639                      * the whole embedded expression reduces to '(operand)' */
11640                     RExC_parse++;
11641
11642                     RExC_flags = save_flags;
11643                     goto handle_operand;
11644                 }
11645                 /* FALL THROUGH */
11646
11647             default:
11648                 RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
11649                 vFAIL("Unexpected character");
11650
11651             case '\\':
11652                 (void) regclass(pRExC_state, flagp,depth+1,
11653                                 TRUE, /* means parse just the next thing */
11654                                 FALSE, /* don't allow multi-char folds */
11655                                 FALSE, /* don't silence non-portable warnings.
11656                                         */
11657                                 &current);
11658                 /* regclass() will return with parsing just the \ sequence,
11659                  * leaving the parse pointer at the next thing to parse */
11660                 RExC_parse--;
11661                 goto handle_operand;
11662
11663             case '[':   /* Is a bracketed character class */
11664             {
11665                 bool is_posix_class = could_it_be_a_POSIX_class(pRExC_state);
11666
11667                 if (! is_posix_class) {
11668                     RExC_parse++;
11669                 }
11670
11671                 (void) regclass(pRExC_state, flagp,depth+1,
11672                                 is_posix_class, /* parse the whole char class
11673                                                    only if not a posix class */
11674                                 FALSE, /* don't allow multi-char folds */
11675                                 FALSE, /* don't silence non-portable warnings.
11676                                         */
11677                                 &current);
11678                 /* function call leaves parse pointing to the ']', except if we
11679                  * faked it */
11680                 if (is_posix_class) {
11681                     RExC_parse--;
11682                 }
11683
11684                 goto handle_operand;
11685             }
11686
11687             case '&':
11688             case '|':
11689             case '+':
11690             case '-':
11691             case '^':
11692                 if (top_index < 0
11693                     || ( ! (top_ptr = av_fetch(stack, top_index, FALSE)))
11694                     || ! IS_OPERAND(*top_ptr))
11695                 {
11696                     RExC_parse++;
11697                     vFAIL2("Unexpected binary operator '%c' with no preceding operand", curchar);
11698                 }
11699                 av_push(stack, newSVuv(curchar));
11700                 break;
11701
11702             case '!':
11703                 av_push(stack, newSVuv(curchar));
11704                 break;
11705
11706             case '(':
11707                 if (top_index >= 0) {
11708                     top_ptr = av_fetch(stack, top_index, FALSE);
11709                     assert(top_ptr);
11710                     if (IS_OPERAND(*top_ptr)) {
11711                         RExC_parse++;
11712                         vFAIL("Unexpected '(' with no preceding operator");
11713                     }
11714                 }
11715                 av_push(stack, newSVuv(curchar));
11716                 break;
11717
11718             case ')':
11719             {
11720                 SV* lparen;
11721                 if (top_index < 1
11722                     || ! (current = av_pop(stack))
11723                     || ! IS_OPERAND(current)
11724                     || ! (lparen = av_pop(stack))
11725                     || IS_OPERAND(lparen)
11726                     || SvUV(lparen) != '(')
11727                 {
11728                     RExC_parse++;
11729                     vFAIL("Unexpected ')'");
11730                 }
11731                 top_index -= 2;
11732                 SvREFCNT_dec_NN(lparen);
11733
11734                 /* FALL THROUGH */
11735             }
11736
11737               handle_operand:
11738
11739                 /* Here, we have an operand to process, in 'current' */
11740
11741                 if (top_index < 0) {    /* Just push if stack is empty */
11742                     av_push(stack, current);
11743                 }
11744                 else {
11745                     SV* top = av_pop(stack);
11746                     char current_operator;
11747
11748                     if (IS_OPERAND(top)) {
11749                         vFAIL("Operand with no preceding operator");
11750                     }
11751                     current_operator = (char) SvUV(top);
11752                     switch (current_operator) {
11753                         case '(':   /* Push the '(' back on followed by the new
11754                                        operand */
11755                             av_push(stack, top);
11756                             av_push(stack, current);
11757                             SvREFCNT_inc(top);  /* Counters the '_dec' done
11758                                                    just after the 'break', so
11759                                                    it doesn't get wrongly freed
11760                                                  */
11761                             break;
11762
11763                         case '!':
11764                             _invlist_invert(current);
11765
11766                             /* Unlike binary operators, the top of the stack,
11767                              * now that this unary one has been popped off, may
11768                              * legally be an operator, and we now have operand
11769                              * for it. */
11770                             top_index--;
11771                             SvREFCNT_dec_NN(top);
11772                             goto handle_operand;
11773
11774                         case '&':
11775                             _invlist_intersection(av_pop(stack),
11776                                                    current,
11777                                                    &current);
11778                             av_push(stack, current);
11779                             break;
11780
11781                         case '|':
11782                         case '+':
11783                             _invlist_union(av_pop(stack), current, &current);
11784                             av_push(stack, current);
11785                             break;
11786
11787                         case '-':
11788                             _invlist_subtract(av_pop(stack), current, &current);
11789                             av_push(stack, current);
11790                             break;
11791
11792                         case '^':   /* The union minus the intersection */
11793                         {
11794                             SV* i = NULL;
11795                             SV* u = NULL;
11796                             SV* element;
11797
11798                             element = av_pop(stack);
11799                             _invlist_union(element, current, &u);
11800                             _invlist_intersection(element, current, &i);
11801                             _invlist_subtract(u, i, &current);
11802                             av_push(stack, current);
11803                             SvREFCNT_dec_NN(i);
11804                             SvREFCNT_dec_NN(u);
11805                             SvREFCNT_dec_NN(element);
11806                             break;
11807                         }
11808
11809                         default:
11810                             Perl_croak(aTHX_ "panic: Unexpected item on '(?[ ])' stack");
11811                 }
11812                 SvREFCNT_dec_NN(top);
11813             }
11814         }
11815
11816         RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
11817     }
11818
11819     if (av_tindex(stack) < 0   /* Was empty */
11820         || ((final = av_pop(stack)) == NULL)
11821         || ! IS_OPERAND(final)
11822         || av_tindex(stack) >= 0)  /* More left on stack */
11823     {
11824         vFAIL("Incomplete expression within '(?[ ])'");
11825     }
11826
11827     /* Here, 'final' is the resultant inversion list from evaluating the
11828      * expression.  Return it if so requested */
11829     if (return_invlist) {
11830         *return_invlist = final;
11831         return END;
11832     }
11833
11834     /* Otherwise generate a resultant node, based on 'final'.  regclass() is
11835      * expecting a string of ranges and individual code points */
11836     invlist_iterinit(final);
11837     result_string = newSVpvs("");
11838     while (invlist_iternext(final, &start, &end)) {
11839         if (start == end) {
11840             Perl_sv_catpvf(aTHX_ result_string, "\\x{%"UVXf"}", start);
11841         }
11842         else {
11843             Perl_sv_catpvf(aTHX_ result_string, "\\x{%"UVXf"}-\\x{%"UVXf"}",
11844                                                      start,          end);
11845         }
11846     }
11847
11848     save_parse = RExC_parse;
11849     RExC_parse = SvPV(result_string, len);
11850     save_end = RExC_end;
11851     RExC_end = RExC_parse + len;
11852
11853     /* We turn off folding around the call, as the class we have constructed
11854      * already has all folding taken into consideration, and we don't want
11855      * regclass() to add to that */
11856     RExC_flags &= ~RXf_PMf_FOLD;
11857     node = regclass(pRExC_state, flagp,depth+1,
11858                     FALSE, /* means parse the whole char class */
11859                     FALSE, /* don't allow multi-char folds */
11860                     TRUE, /* silence non-portable warnings.  The above may very
11861                              well have generated non-portable code points, but
11862                              they're valid on this machine */
11863                     NULL);
11864     if (save_fold) {
11865         RExC_flags |= RXf_PMf_FOLD;
11866     }
11867     RExC_parse = save_parse + 1;
11868     RExC_end = save_end;
11869     SvREFCNT_dec_NN(final);
11870     SvREFCNT_dec_NN(result_string);
11871     SvREFCNT_dec_NN(stack);
11872
11873     nextchar(pRExC_state);
11874     Set_Node_Length(node, RExC_parse - oregcomp_parse + 1); /* MJD */
11875     return node;
11876 }
11877 #undef IS_OPERAND
11878
11879 /* The names of properties whose definitions are not known at compile time are
11880  * stored in this SV, after a constant heading.  So if the length has been
11881  * changed since initialization, then there is a run-time definition. */
11882 #define HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION (SvCUR(listsv) != initial_listsv_len)
11883
11884 STATIC regnode *
11885 S_regclass(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth,
11886                  const bool stop_at_1,  /* Just parse the next thing, don't
11887                                            look for a full character class */
11888                  bool allow_multi_folds,
11889                  const bool silence_non_portable,   /* Don't output warnings
11890                                                        about too large
11891                                                        characters */
11892                  SV** ret_invlist)  /* Return an inversion list, not a node */
11893 {
11894     /* parse a bracketed class specification.  Most of these will produce an
11895      * ANYOF node; but something like [a] will produce an EXACT node; [aA], an
11896      * EXACTFish node; [[:ascii:]], a POSIXA node; etc.  It is more complex
11897      * under /i with multi-character folds: it will be rewritten following the
11898      * paradigm of this example, where the <multi-fold>s are characters which
11899      * fold to multiple character sequences:
11900      *      /[abc\x{multi-fold1}def\x{multi-fold2}ghi]/i
11901      * gets effectively rewritten as:
11902      *      /(?:\x{multi-fold1}|\x{multi-fold2}|[abcdefghi]/i
11903      * reg() gets called (recursively) on the rewritten version, and this
11904      * function will return what it constructs.  (Actually the <multi-fold>s
11905      * aren't physically removed from the [abcdefghi], it's just that they are
11906      * ignored in the recursion by means of a flag:
11907      * <RExC_in_multi_char_class>.)
11908      *
11909      * ANYOF nodes contain a bit map for the first 256 characters, with the
11910      * corresponding bit set if that character is in the list.  For characters
11911      * above 255, a range list or swash is used.  There are extra bits for \w,
11912      * etc. in locale ANYOFs, as what these match is not determinable at
11913      * compile time */
11914
11915     dVAR;
11916     UV prevvalue = OOB_UNICODE, save_prevvalue = OOB_UNICODE;
11917     IV range = 0;
11918     UV value = OOB_UNICODE, save_value = OOB_UNICODE;
11919     regnode *ret;
11920     STRLEN numlen;
11921     IV namedclass = OOB_NAMEDCLASS;
11922     char *rangebegin = NULL;
11923     bool need_class = 0;
11924     SV *listsv = NULL;
11925     STRLEN initial_listsv_len = 0; /* Kind of a kludge to see if it is more
11926                                       than just initialized.  */
11927     SV* properties = NULL;    /* Code points that match \p{} \P{} */
11928     SV* posixes = NULL;     /* Code points that match classes like, [:word:],
11929                                extended beyond the Latin1 range */
11930     UV element_count = 0;   /* Number of distinct elements in the class.
11931                                Optimizations may be possible if this is tiny */
11932     AV * multi_char_matches = NULL; /* Code points that fold to more than one
11933                                        character; used under /i */
11934     UV n;
11935     char * stop_ptr = RExC_end;    /* where to stop parsing */
11936     const bool skip_white = cBOOL(ret_invlist); /* ignore unescaped white
11937                                                    space? */
11938     const bool strict = cBOOL(ret_invlist); /* Apply strict parsing rules? */
11939
11940     /* Unicode properties are stored in a swash; this holds the current one
11941      * being parsed.  If this swash is the only above-latin1 component of the
11942      * character class, an optimization is to pass it directly on to the
11943      * execution engine.  Otherwise, it is set to NULL to indicate that there
11944      * are other things in the class that have to be dealt with at execution
11945      * time */
11946     SV* swash = NULL;           /* Code points that match \p{} \P{} */
11947
11948     /* Set if a component of this character class is user-defined; just passed
11949      * on to the engine */
11950     bool has_user_defined_property = FALSE;
11951
11952     /* inversion list of code points this node matches only when the target
11953      * string is in UTF-8.  (Because is under /d) */
11954     SV* depends_list = NULL;
11955
11956     /* inversion list of code points this node matches.  For much of the
11957      * function, it includes only those that match regardless of the utf8ness
11958      * of the target string */
11959     SV* cp_list = NULL;
11960
11961 #ifdef EBCDIC
11962     /* In a range, counts how many 0-2 of the ends of it came from literals,
11963      * not escapes.  Thus we can tell if 'A' was input vs \x{C1} */
11964     UV literal_endpoint = 0;
11965 #endif
11966     bool invert = FALSE;    /* Is this class to be complemented */
11967
11968     /* Is there any thing like \W or [:^digit:] that matches above the legal
11969      * Unicode range? */
11970     bool runtime_posix_matches_above_Unicode = FALSE;
11971
11972     regnode * const orig_emit = RExC_emit; /* Save the original RExC_emit in
11973         case we need to change the emitted regop to an EXACT. */
11974     const char * orig_parse = RExC_parse;
11975     const I32 orig_size = RExC_size;
11976     GET_RE_DEBUG_FLAGS_DECL;
11977
11978     PERL_ARGS_ASSERT_REGCLASS;
11979 #ifndef DEBUGGING
11980     PERL_UNUSED_ARG(depth);
11981 #endif
11982
11983     DEBUG_PARSE("clas");
11984
11985     /* Assume we are going to generate an ANYOF node. */
11986     ret = reganode(pRExC_state, ANYOF, 0);
11987
11988     if (SIZE_ONLY) {
11989         RExC_size += ANYOF_SKIP;
11990         listsv = &PL_sv_undef; /* For code scanners: listsv always non-NULL. */
11991     }
11992     else {
11993         ANYOF_FLAGS(ret) = 0;
11994
11995         RExC_emit += ANYOF_SKIP;
11996         if (LOC) {
11997             ANYOF_FLAGS(ret) |= ANYOF_LOCALE;
11998         }
11999         listsv = newSVpvs("# comment\n");
12000         initial_listsv_len = SvCUR(listsv);
12001     }
12002
12003     if (skip_white) {
12004         RExC_parse = regpatws(pRExC_state, RExC_parse,
12005                               FALSE /* means don't recognize comments */);
12006     }
12007
12008     if (UCHARAT(RExC_parse) == '^') {   /* Complement of range. */
12009         RExC_parse++;
12010         invert = TRUE;
12011         allow_multi_folds = FALSE;
12012         RExC_naughty++;
12013         if (skip_white) {
12014             RExC_parse = regpatws(pRExC_state, RExC_parse,
12015                                   FALSE /* means don't recognize comments */);
12016         }
12017     }
12018
12019     /* Check that they didn't say [:posix:] instead of [[:posix:]] */
12020     if (!SIZE_ONLY && RExC_parse < RExC_end && POSIXCC(UCHARAT(RExC_parse))) {
12021         const char *s = RExC_parse;
12022         const char  c = *s++;
12023
12024         while (isWORDCHAR(*s))
12025             s++;
12026         if (*s && c == *s && s[1] == ']') {
12027             SAVEFREESV(RExC_rx_sv);
12028             SAVEFREESV(listsv);
12029             ckWARN3reg(s+2,
12030                        "POSIX syntax [%c %c] belongs inside character classes",
12031                        c, c);
12032             (void)ReREFCNT_inc(RExC_rx_sv);
12033             SvREFCNT_inc_simple_void_NN(listsv);
12034         }
12035     }
12036
12037     /* If the caller wants us to just parse a single element, accomplish this
12038      * by faking the loop ending condition */
12039     if (stop_at_1 && RExC_end > RExC_parse) {
12040         stop_ptr = RExC_parse + 1;
12041     }
12042
12043     /* allow 1st char to be ']' (allowing it to be '-' is dealt with later) */
12044     if (UCHARAT(RExC_parse) == ']')
12045         goto charclassloop;
12046
12047 parseit:
12048     while (1) {
12049         if  (RExC_parse >= stop_ptr) {
12050             break;
12051         }
12052
12053         if (skip_white) {
12054             RExC_parse = regpatws(pRExC_state, RExC_parse,
12055                                   FALSE /* means don't recognize comments */);
12056         }
12057
12058         if  (UCHARAT(RExC_parse) == ']') {
12059             break;
12060         }
12061
12062     charclassloop:
12063
12064         namedclass = OOB_NAMEDCLASS; /* initialize as illegal */
12065         save_value = value;
12066         save_prevvalue = prevvalue;
12067
12068         if (!range) {
12069             rangebegin = RExC_parse;
12070             element_count++;
12071         }
12072         if (UTF) {
12073             value = utf8n_to_uvchr((U8*)RExC_parse,
12074                                    RExC_end - RExC_parse,
12075                                    &numlen, UTF8_ALLOW_DEFAULT);
12076             RExC_parse += numlen;
12077         }
12078         else
12079             value = UCHARAT(RExC_parse++);
12080
12081         if (value == '['
12082             && RExC_parse < RExC_end
12083             && POSIXCC(UCHARAT(RExC_parse)))
12084         {
12085             namedclass = regpposixcc(pRExC_state, value, listsv, strict);
12086         }
12087         else if (value == '\\') {
12088             if (UTF) {
12089                 value = utf8n_to_uvchr((U8*)RExC_parse,
12090                                    RExC_end - RExC_parse,
12091                                    &numlen, UTF8_ALLOW_DEFAULT);
12092                 RExC_parse += numlen;
12093             }
12094             else
12095                 value = UCHARAT(RExC_parse++);
12096
12097             /* Some compilers cannot handle switching on 64-bit integer
12098              * values, therefore value cannot be an UV.  Yes, this will
12099              * be a problem later if we want switch on Unicode.
12100              * A similar issue a little bit later when switching on
12101              * namedclass. --jhi */
12102
12103             /* If the \ is escaping white space when white space is being
12104              * skipped, it means that that white space is wanted literally, and
12105              * is already in 'value'.  Otherwise, need to translate the escape
12106              * into what it signifies. */
12107             if (! skip_white || ! is_PATWS_cp(value)) switch ((I32)value) {
12108
12109             case 'w':   namedclass = ANYOF_WORDCHAR;    break;
12110             case 'W':   namedclass = ANYOF_NWORDCHAR;   break;
12111             case 's':   namedclass = ANYOF_SPACE;       break;
12112             case 'S':   namedclass = ANYOF_NSPACE;      break;
12113             case 'd':   namedclass = ANYOF_DIGIT;       break;
12114             case 'D':   namedclass = ANYOF_NDIGIT;      break;
12115             case 'v':   namedclass = ANYOF_VERTWS;      break;
12116             case 'V':   namedclass = ANYOF_NVERTWS;     break;
12117             case 'h':   namedclass = ANYOF_HORIZWS;     break;
12118             case 'H':   namedclass = ANYOF_NHORIZWS;    break;
12119             case 'N':  /* Handle \N{NAME} in class */
12120                 {
12121                     /* We only pay attention to the first char of 
12122                     multichar strings being returned. I kinda wonder
12123                     if this makes sense as it does change the behaviour
12124                     from earlier versions, OTOH that behaviour was broken
12125                     as well. */
12126                     if (! grok_bslash_N(pRExC_state, NULL, &value, flagp, depth,
12127                                       TRUE, /* => charclass */
12128                                       strict))
12129                     {
12130                         goto parseit;
12131                     }
12132                 }
12133                 break;
12134             case 'p':
12135             case 'P':
12136                 {
12137                 char *e;
12138
12139                 /* We will handle any undefined properties ourselves */
12140                 U8 swash_init_flags = _CORE_SWASH_INIT_RETURN_IF_UNDEF;
12141
12142                 if (RExC_parse >= RExC_end)
12143                     vFAIL2("Empty \\%c{}", (U8)value);
12144                 if (*RExC_parse == '{') {
12145                     const U8 c = (U8)value;
12146                     e = strchr(RExC_parse++, '}');
12147                     if (!e)
12148                         vFAIL2("Missing right brace on \\%c{}", c);
12149                     while (isSPACE(UCHARAT(RExC_parse)))
12150                         RExC_parse++;
12151                     if (e == RExC_parse)
12152                         vFAIL2("Empty \\%c{}", c);
12153                     n = e - RExC_parse;
12154                     while (isSPACE(UCHARAT(RExC_parse + n - 1)))
12155                         n--;
12156                 }
12157                 else {
12158                     e = RExC_parse;
12159                     n = 1;
12160                 }
12161                 if (!SIZE_ONLY) {
12162                     SV* invlist;
12163                     char* name;
12164
12165                     if (UCHARAT(RExC_parse) == '^') {
12166                          RExC_parse++;
12167                          n--;
12168                          /* toggle.  (The rhs xor gets the single bit that
12169                           * differs between P and p; the other xor inverts just
12170                           * that bit) */
12171                          value ^= 'P' ^ 'p';
12172
12173                          while (isSPACE(UCHARAT(RExC_parse))) {
12174                               RExC_parse++;
12175                               n--;
12176                          }
12177                     }
12178                     /* Try to get the definition of the property into
12179                      * <invlist>.  If /i is in effect, the effective property
12180                      * will have its name be <__NAME_i>.  The design is
12181                      * discussed in commit
12182                      * 2f833f5208e26b208886e51e09e2c072b5eabb46 */
12183                     Newx(name, n + sizeof("_i__\n"), char);
12184
12185                     sprintf(name, "%s%.*s%s\n",
12186                                     (FOLD) ? "__" : "",
12187                                     (int)n,
12188                                     RExC_parse,
12189                                     (FOLD) ? "_i" : ""
12190                     );
12191
12192                     /* Look up the property name, and get its swash and
12193                      * inversion list, if the property is found  */
12194                     if (swash) {
12195                         SvREFCNT_dec_NN(swash);
12196                     }
12197                     swash = _core_swash_init("utf8", name, &PL_sv_undef,
12198                                              1, /* binary */
12199                                              0, /* not tr/// */
12200                                              NULL, /* No inversion list */
12201                                              &swash_init_flags
12202                                             );
12203                     if (! swash || ! (invlist = _get_swash_invlist(swash))) {
12204                         if (swash) {
12205                             SvREFCNT_dec_NN(swash);
12206                             swash = NULL;
12207                         }
12208
12209                         /* Here didn't find it.  It could be a user-defined
12210                          * property that will be available at run-time.  If we
12211                          * accept only compile-time properties, is an error;
12212                          * otherwise add it to the list for run-time look up */
12213                         if (ret_invlist) {
12214                             RExC_parse = e + 1;
12215                             vFAIL3("Property '%.*s' is unknown", (int) n, name);
12216                         }
12217                         Perl_sv_catpvf(aTHX_ listsv, "%cutf8::%s\n",
12218                                         (value == 'p' ? '+' : '!'),
12219                                         name);
12220                         has_user_defined_property = TRUE;
12221
12222                         /* We don't know yet, so have to assume that the
12223                          * property could match something in the Latin1 range,
12224                          * hence something that isn't utf8.  Note that this
12225                          * would cause things in <depends_list> to match
12226                          * inappropriately, except that any \p{}, including
12227                          * this one forces Unicode semantics, which means there
12228                          * is <no depends_list> */
12229                         ANYOF_FLAGS(ret) |= ANYOF_NONBITMAP_NON_UTF8;
12230                     }
12231                     else {
12232
12233                         /* Here, did get the swash and its inversion list.  If
12234                          * the swash is from a user-defined property, then this
12235                          * whole character class should be regarded as such */
12236                         has_user_defined_property =
12237                                     (swash_init_flags
12238                                      & _CORE_SWASH_INIT_USER_DEFINED_PROPERTY);
12239
12240                         /* Invert if asking for the complement */
12241                         if (value == 'P') {
12242                             _invlist_union_complement_2nd(properties,
12243                                                           invlist,
12244                                                           &properties);
12245
12246                             /* The swash can't be used as-is, because we've
12247                              * inverted things; delay removing it to here after
12248                              * have copied its invlist above */
12249                             SvREFCNT_dec_NN(swash);
12250                             swash = NULL;
12251                         }
12252                         else {
12253                             _invlist_union(properties, invlist, &properties);
12254                         }
12255                     }
12256                     Safefree(name);
12257                 }
12258                 RExC_parse = e + 1;
12259                 namedclass = ANYOF_UNIPROP;  /* no official name, but it's
12260                                                 named */
12261
12262                 /* \p means they want Unicode semantics */
12263                 RExC_uni_semantics = 1;
12264                 }
12265                 break;
12266             case 'n':   value = '\n';                   break;
12267             case 'r':   value = '\r';                   break;
12268             case 't':   value = '\t';                   break;
12269             case 'f':   value = '\f';                   break;
12270             case 'b':   value = '\b';                   break;
12271             case 'e':   value = ASCII_TO_NATIVE('\033');break;
12272             case 'a':   value = ASCII_TO_NATIVE('\007');break;
12273             case 'o':
12274                 RExC_parse--;   /* function expects to be pointed at the 'o' */
12275                 {
12276                     const char* error_msg;
12277                     bool valid = grok_bslash_o(&RExC_parse,
12278                                                &value,
12279                                                &error_msg,
12280                                                SIZE_ONLY,   /* warnings in pass
12281                                                                1 only */
12282                                                strict,
12283                                                silence_non_portable,
12284                                                UTF);
12285                     if (! valid) {
12286                         vFAIL(error_msg);
12287                     }
12288                 }
12289                 if (PL_encoding && value < 0x100) {
12290                     goto recode_encoding;
12291                 }
12292                 break;
12293             case 'x':
12294                 RExC_parse--;   /* function expects to be pointed at the 'x' */
12295                 {
12296                     const char* error_msg;
12297                     bool valid = grok_bslash_x(&RExC_parse,
12298                                                &value,
12299                                                &error_msg,
12300                                                TRUE, /* Output warnings */
12301                                                strict,
12302                                                silence_non_portable,
12303                                                UTF);
12304                     if (! valid) {
12305                         vFAIL(error_msg);
12306                     }
12307                 }
12308                 if (PL_encoding && value < 0x100)
12309                     goto recode_encoding;
12310                 break;
12311             case 'c':
12312                 value = grok_bslash_c(*RExC_parse++, UTF, SIZE_ONLY);
12313                 break;
12314             case '0': case '1': case '2': case '3': case '4':
12315             case '5': case '6': case '7':
12316                 {
12317                     /* Take 1-3 octal digits */
12318                     I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
12319                     numlen = (strict) ? 4 : 3;
12320                     value = grok_oct(--RExC_parse, &numlen, &flags, NULL);
12321                     RExC_parse += numlen;
12322                     if (numlen != 3) {
12323                         SAVEFREESV(listsv); /* In case warnings are fatalized */
12324                         if (strict) {
12325                             RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
12326                             vFAIL("Need exactly 3 octal digits");
12327                         }
12328                         else if (! SIZE_ONLY /* like \08, \178 */
12329                                  && numlen < 3
12330                                  && RExC_parse < RExC_end
12331                                  && isDIGIT(*RExC_parse)
12332                                  && ckWARN(WARN_REGEXP))
12333                         {
12334                             SAVEFREESV(RExC_rx_sv);
12335                             reg_warn_non_literal_string(
12336                                  RExC_parse + 1,
12337                                  form_short_octal_warning(RExC_parse, numlen));
12338                             (void)ReREFCNT_inc(RExC_rx_sv);
12339                         }
12340                         SvREFCNT_inc_simple_void_NN(listsv);
12341                     }
12342                     if (PL_encoding && value < 0x100)
12343                         goto recode_encoding;
12344                     break;
12345                 }
12346             recode_encoding:
12347                 if (! RExC_override_recoding) {
12348                     SV* enc = PL_encoding;
12349                     value = reg_recode((const char)(U8)value, &enc);
12350                     if (!enc) {
12351                         if (strict) {
12352                             vFAIL("Invalid escape in the specified encoding");
12353                         }
12354                         else if (SIZE_ONLY) {
12355                             ckWARNreg(RExC_parse,
12356                                   "Invalid escape in the specified encoding");
12357                         }
12358                     }
12359                     break;
12360                 }
12361             default:
12362                 /* Allow \_ to not give an error */
12363                 if (!SIZE_ONLY && isWORDCHAR(value) && value != '_') {
12364                     SAVEFREESV(listsv);
12365                     if (strict) {
12366                         vFAIL2("Unrecognized escape \\%c in character class",
12367                                (int)value);
12368                     }
12369                     else {
12370                         SAVEFREESV(RExC_rx_sv);
12371                         ckWARN2reg(RExC_parse,
12372                             "Unrecognized escape \\%c in character class passed through",
12373                             (int)value);
12374                         (void)ReREFCNT_inc(RExC_rx_sv);
12375                     }
12376                     SvREFCNT_inc_simple_void_NN(listsv);
12377                 }
12378                 break;
12379             }   /* End of switch on char following backslash */
12380         } /* end of handling backslash escape sequences */
12381 #ifdef EBCDIC
12382         else
12383             literal_endpoint++;
12384 #endif
12385
12386         /* Here, we have the current token in 'value' */
12387
12388         /* What matches in a locale is not known until runtime.  This includes
12389          * what the Posix classes (like \w, [:space:]) match.  Room must be
12390          * reserved (one time per class) to store such classes, either if Perl
12391          * is compiled so that locale nodes always should have this space, or
12392          * if there is such class info to be stored.  The space will contain a
12393          * bit for each named class that is to be matched against.  This isn't
12394          * needed for \p{} and pseudo-classes, as they are not affected by
12395          * locale, and hence are dealt with separately */
12396         if (LOC
12397             && ! need_class
12398             && (ANYOF_LOCALE == ANYOF_CLASS
12399                 || (namedclass > OOB_NAMEDCLASS && namedclass < ANYOF_MAX)))
12400         {
12401             need_class = 1;
12402             if (SIZE_ONLY) {
12403                 RExC_size += ANYOF_CLASS_SKIP - ANYOF_SKIP;
12404             }
12405             else {
12406                 RExC_emit += ANYOF_CLASS_SKIP - ANYOF_SKIP;
12407                 ANYOF_CLASS_ZERO(ret);
12408             }
12409             ANYOF_FLAGS(ret) |= ANYOF_CLASS;
12410         }
12411
12412         if (namedclass > OOB_NAMEDCLASS) { /* this is a named class \blah */
12413
12414             /* a bad range like a-\d, a-[:digit:].  The '-' is taken as a
12415              * literal, as is the character that began the false range, i.e.
12416              * the 'a' in the examples */
12417             if (range) {
12418                 if (!SIZE_ONLY) {
12419                     const int w = (RExC_parse >= rangebegin)
12420                                   ? RExC_parse - rangebegin
12421                                   : 0;
12422                     SAVEFREESV(listsv); /* in case of fatal warnings */
12423                     if (strict) {
12424                         vFAIL4("False [] range \"%*.*s\"", w, w, rangebegin);
12425                     }
12426                     else {
12427                         SAVEFREESV(RExC_rx_sv); /* in case of fatal warnings */
12428                         ckWARN4reg(RExC_parse,
12429                                 "False [] range \"%*.*s\"",
12430                                 w, w, rangebegin);
12431                         (void)ReREFCNT_inc(RExC_rx_sv);
12432                         cp_list = add_cp_to_invlist(cp_list, '-');
12433                         cp_list = add_cp_to_invlist(cp_list, prevvalue);
12434                     }
12435                     SvREFCNT_inc_simple_void_NN(listsv);
12436                 }
12437
12438                 range = 0; /* this was not a true range */
12439                 element_count += 2; /* So counts for three values */
12440             }
12441
12442             if (! SIZE_ONLY) {
12443                 U8 classnum = namedclass_to_classnum(namedclass);
12444                 if (namedclass >= ANYOF_MAX) {  /* If a special class */
12445                     if (namedclass != ANYOF_UNIPROP) { /* UNIPROP = \p and \P */
12446
12447                         /* Here, should be \h, \H, \v, or \V.  Neither /d nor
12448                          * /l make a difference in what these match.  There
12449                          * would be problems if these characters had folds
12450                          * other than themselves, as cp_list is subject to
12451                          * folding. */
12452                         if (classnum != _CC_VERTSPACE) {
12453                             assert(   namedclass == ANYOF_HORIZWS
12454                                    || namedclass == ANYOF_NHORIZWS);
12455
12456                             /* It turns out that \h is just a synonym for
12457                              * XPosixBlank */
12458                             classnum = _CC_BLANK;
12459                         }
12460
12461                         _invlist_union_maybe_complement_2nd(
12462                                 cp_list,
12463                                 PL_XPosix_ptrs[classnum],
12464                                 cBOOL(namedclass % 2), /* Complement if odd
12465                                                           (NHORIZWS, NVERTWS)
12466                                                         */
12467                                 &cp_list);
12468                     }
12469                 }
12470                 else if (classnum == _CC_ASCII) {
12471 #ifdef HAS_ISASCII
12472                     if (LOC) {
12473                         ANYOF_CLASS_SET(ret, namedclass);
12474                     }
12475                     else
12476 #endif  /* Not isascii(); just use the hard-coded definition for it */
12477                         _invlist_union_maybe_complement_2nd(
12478                                 posixes,
12479                                 PL_ASCII,
12480                                 cBOOL(namedclass % 2), /* Complement if odd
12481                                                           (NASCII) */
12482                                 &posixes);
12483                 }
12484                 else {  /* Garden variety class */
12485
12486                     /* The ascii range inversion list */
12487                     SV* ascii_source = PL_Posix_ptrs[classnum];
12488
12489                     /* The full Latin1 range inversion list */
12490                     SV* l1_source = PL_L1Posix_ptrs[classnum];
12491
12492                     /* This code is structured into two major clauses.  The
12493                      * first is for classes whose complete definitions may not
12494                      * already be known.  It not, the Latin1 definition
12495                      * (guaranteed to already known) is used plus code is
12496                      * generated to load the rest at run-time (only if needed).
12497                      * If the complete definition is known, it drops down to
12498                      * the second clause, where the complete definition is
12499                      * known */
12500
12501                     if (classnum < _FIRST_NON_SWASH_CC) {
12502
12503                         /* Here, the class has a swash, which may or not
12504                          * already be loaded */
12505
12506                         /* The name of the property to use to match the full
12507                          * eXtended Unicode range swash for this character
12508                          * class */
12509                         const char *Xname = swash_property_names[classnum];
12510
12511                         /* If returning the inversion list, we can't defer
12512                          * getting this until runtime */
12513                         if (ret_invlist && !  PL_utf8_swash_ptrs[classnum]) {
12514                             PL_utf8_swash_ptrs[classnum] =
12515                                 _core_swash_init("utf8", Xname, &PL_sv_undef,
12516                                              1, /* binary */
12517                                              0, /* not tr/// */
12518                                              NULL, /* No inversion list */
12519                                              NULL  /* No flags */
12520                                             );
12521                             assert(PL_utf8_swash_ptrs[classnum]);
12522                         }
12523                         if ( !  PL_utf8_swash_ptrs[classnum]) {
12524                             if (namedclass % 2 == 0) { /* A non-complemented
12525                                                           class */
12526                                 /* If not /a matching, there are code points we
12527                                  * don't know at compile time.  Arrange for the
12528                                  * unknown matches to be loaded at run-time, if
12529                                  * needed */
12530                                 if (! AT_LEAST_ASCII_RESTRICTED) {
12531                                     Perl_sv_catpvf(aTHX_ listsv, "+utf8::%s\n",
12532                                                                  Xname);
12533                                 }
12534                                 if (LOC) {  /* Under locale, set run-time
12535                                                lookup */
12536                                     ANYOF_CLASS_SET(ret, namedclass);
12537                                 }
12538                                 else {
12539                                     /* Add the current class's code points to
12540                                      * the running total */
12541                                     _invlist_union(posixes,
12542                                                    (AT_LEAST_ASCII_RESTRICTED)
12543                                                         ? ascii_source
12544                                                         : l1_source,
12545                                                    &posixes);
12546                                 }
12547                             }
12548                             else {  /* A complemented class */
12549                                 if (AT_LEAST_ASCII_RESTRICTED) {
12550                                     /* Under /a should match everything above
12551                                      * ASCII, plus the complement of the set's
12552                                      * ASCII matches */
12553                                     _invlist_union_complement_2nd(posixes,
12554                                                                   ascii_source,
12555                                                                   &posixes);
12556                                 }
12557                                 else {
12558                                     /* Arrange for the unknown matches to be
12559                                      * loaded at run-time, if needed */
12560                                     Perl_sv_catpvf(aTHX_ listsv, "!utf8::%s\n",
12561                                                                  Xname);
12562                                     runtime_posix_matches_above_Unicode = TRUE;
12563                                     if (LOC) {
12564                                         ANYOF_CLASS_SET(ret, namedclass);
12565                                     }
12566                                     else {
12567
12568                                         /* We want to match everything in
12569                                          * Latin1, except those things that
12570                                          * l1_source matches */
12571                                         SV* scratch_list = NULL;
12572                                         _invlist_subtract(PL_Latin1, l1_source,
12573                                                           &scratch_list);
12574
12575                                         /* Add the list from this class to the
12576                                          * running total */
12577                                         if (! posixes) {
12578                                             posixes = scratch_list;
12579                                         }
12580                                         else {
12581                                             _invlist_union(posixes,
12582                                                            scratch_list,
12583                                                            &posixes);
12584                                             SvREFCNT_dec_NN(scratch_list);
12585                                         }
12586                                         if (DEPENDS_SEMANTICS) {
12587                                             ANYOF_FLAGS(ret)
12588                                                   |= ANYOF_NON_UTF8_LATIN1_ALL;
12589                                         }
12590                                     }
12591                                 }
12592                             }
12593                             goto namedclass_done;
12594                         }
12595
12596                         /* Here, there is a swash loaded for the class.  If no
12597                          * inversion list for it yet, get it */
12598                         if (! PL_XPosix_ptrs[classnum]) {
12599                             PL_XPosix_ptrs[classnum]
12600                              = _swash_to_invlist(PL_utf8_swash_ptrs[classnum]);
12601                         }
12602                     }
12603
12604                     /* Here there is an inversion list already loaded for the
12605                      * entire class */
12606
12607                     if (namedclass % 2 == 0) {  /* A non-complemented class,
12608                                                    like ANYOF_PUNCT */
12609                         if (! LOC) {
12610                             /* For non-locale, just add it to any existing list
12611                              * */
12612                             _invlist_union(posixes,
12613                                            (AT_LEAST_ASCII_RESTRICTED)
12614                                                ? ascii_source
12615                                                : PL_XPosix_ptrs[classnum],
12616                                            &posixes);
12617                         }
12618                         else {  /* Locale */
12619                             SV* scratch_list = NULL;
12620
12621                             /* For above Latin1 code points, we use the full
12622                              * Unicode range */
12623                             _invlist_intersection(PL_AboveLatin1,
12624                                                   PL_XPosix_ptrs[classnum],
12625                                                   &scratch_list);
12626                             /* And set the output to it, adding instead if
12627                              * there already is an output.  Checking if
12628                              * 'posixes' is NULL first saves an extra clone.
12629                              * Its reference count will be decremented at the
12630                              * next union, etc, or if this is the only
12631                              * instance, at the end of the routine */
12632                             if (! posixes) {
12633                                 posixes = scratch_list;
12634                             }
12635                             else {
12636                                 _invlist_union(posixes, scratch_list, &posixes);
12637                                 SvREFCNT_dec_NN(scratch_list);
12638                             }
12639
12640 #ifndef HAS_ISBLANK
12641                             if (namedclass != ANYOF_BLANK) {
12642 #endif
12643                                 /* Set this class in the node for runtime
12644                                  * matching */
12645                                 ANYOF_CLASS_SET(ret, namedclass);
12646 #ifndef HAS_ISBLANK
12647                             }
12648                             else {
12649                                 /* No isblank(), use the hard-coded ASCII-range
12650                                  * blanks, adding them to the running total. */
12651
12652                                 _invlist_union(posixes, ascii_source, &posixes);
12653                             }
12654 #endif
12655                         }
12656                     }
12657                     else {  /* A complemented class, like ANYOF_NPUNCT */
12658                         if (! LOC) {
12659                             _invlist_union_complement_2nd(
12660                                                 posixes,
12661                                                 (AT_LEAST_ASCII_RESTRICTED)
12662                                                     ? ascii_source
12663                                                     : PL_XPosix_ptrs[classnum],
12664                                                 &posixes);
12665                             /* Under /d, everything in the upper half of the
12666                              * Latin1 range matches this complement */
12667                             if (DEPENDS_SEMANTICS) {
12668                                 ANYOF_FLAGS(ret) |= ANYOF_NON_UTF8_LATIN1_ALL;
12669                             }
12670                         }
12671                         else {  /* Locale */
12672                             SV* scratch_list = NULL;
12673                             _invlist_subtract(PL_AboveLatin1,
12674                                               PL_XPosix_ptrs[classnum],
12675                                               &scratch_list);
12676                             if (! posixes) {
12677                                 posixes = scratch_list;
12678                             }
12679                             else {
12680                                 _invlist_union(posixes, scratch_list, &posixes);
12681                                 SvREFCNT_dec_NN(scratch_list);
12682                             }
12683 #ifndef HAS_ISBLANK
12684                             if (namedclass != ANYOF_NBLANK) {
12685 #endif
12686                                 ANYOF_CLASS_SET(ret, namedclass);
12687 #ifndef HAS_ISBLANK
12688                             }
12689                             else {
12690                                 /* Get the list of all code points in Latin1
12691                                  * that are not ASCII blanks, and add them to
12692                                  * the running total */
12693                                 _invlist_subtract(PL_Latin1, ascii_source,
12694                                                   &scratch_list);
12695                                 _invlist_union(posixes, scratch_list, &posixes);
12696                                 SvREFCNT_dec_NN(scratch_list);
12697                             }
12698 #endif
12699                         }
12700                     }
12701                 }
12702               namedclass_done:
12703                 continue;   /* Go get next character */
12704             }
12705         } /* end of namedclass \blah */
12706
12707         /* Here, we have a single value.  If 'range' is set, it is the ending
12708          * of a range--check its validity.  Later, we will handle each
12709          * individual code point in the range.  If 'range' isn't set, this
12710          * could be the beginning of a range, so check for that by looking
12711          * ahead to see if the next real character to be processed is the range
12712          * indicator--the minus sign */
12713
12714         if (skip_white) {
12715             RExC_parse = regpatws(pRExC_state, RExC_parse,
12716                                 FALSE /* means don't recognize comments */);
12717         }
12718
12719         if (range) {
12720             if (prevvalue > value) /* b-a */ {
12721                 const int w = RExC_parse - rangebegin;
12722                 Simple_vFAIL4("Invalid [] range \"%*.*s\"", w, w, rangebegin);
12723                 range = 0; /* not a valid range */
12724             }
12725         }
12726         else {
12727             prevvalue = value; /* save the beginning of the potential range */
12728             if (! stop_at_1     /* Can't be a range if parsing just one thing */
12729                 && *RExC_parse == '-')
12730             {
12731                 char* next_char_ptr = RExC_parse + 1;
12732                 if (skip_white) {   /* Get the next real char after the '-' */
12733                     next_char_ptr = regpatws(pRExC_state,
12734                                              RExC_parse + 1,
12735                                              FALSE); /* means don't recognize
12736                                                         comments */
12737                 }
12738
12739                 /* If the '-' is at the end of the class (just before the ']',
12740                  * it is a literal minus; otherwise it is a range */
12741                 if (next_char_ptr < RExC_end && *next_char_ptr != ']') {
12742                     RExC_parse = next_char_ptr;
12743
12744                     /* a bad range like \w-, [:word:]- ? */
12745                     if (namedclass > OOB_NAMEDCLASS) {
12746                         if (strict || ckWARN(WARN_REGEXP)) {
12747                             const int w =
12748                                 RExC_parse >= rangebegin ?
12749                                 RExC_parse - rangebegin : 0;
12750                             if (strict) {
12751                                 vFAIL4("False [] range \"%*.*s\"",
12752                                     w, w, rangebegin);
12753                             }
12754                             else {
12755                                 vWARN4(RExC_parse,
12756                                     "False [] range \"%*.*s\"",
12757                                     w, w, rangebegin);
12758                             }
12759                         }
12760                         if (!SIZE_ONLY) {
12761                             cp_list = add_cp_to_invlist(cp_list, '-');
12762                         }
12763                         element_count++;
12764                     } else
12765                         range = 1;      /* yeah, it's a range! */
12766                     continue;   /* but do it the next time */
12767                 }
12768             }
12769         }
12770
12771         /* Here, <prevvalue> is the beginning of the range, if any; or <value>
12772          * if not */
12773
12774         /* non-Latin1 code point implies unicode semantics.  Must be set in
12775          * pass1 so is there for the whole of pass 2 */
12776         if (value > 255) {
12777             RExC_uni_semantics = 1;
12778         }
12779
12780         /* Ready to process either the single value, or the completed range.
12781          * For single-valued non-inverted ranges, we consider the possibility
12782          * of multi-char folds.  (We made a conscious decision to not do this
12783          * for the other cases because it can often lead to non-intuitive
12784          * results.  For example, you have the peculiar case that:
12785          *  "s s" =~ /^[^\xDF]+$/i => Y
12786          *  "ss"  =~ /^[^\xDF]+$/i => N
12787          *
12788          * See [perl #89750] */
12789         if (FOLD && allow_multi_folds && value == prevvalue) {
12790             if (value == LATIN_SMALL_LETTER_SHARP_S
12791                 || (value > 255 && _invlist_contains_cp(PL_HasMultiCharFold,
12792                                                         value)))
12793             {
12794                 /* Here <value> is indeed a multi-char fold.  Get what it is */
12795
12796                 U8 foldbuf[UTF8_MAXBYTES_CASE];
12797                 STRLEN foldlen;
12798
12799                 UV folded = _to_uni_fold_flags(
12800                                 value,
12801                                 foldbuf,
12802                                 &foldlen,
12803                                 FOLD_FLAGS_FULL
12804                                 | ((LOC) ?  FOLD_FLAGS_LOCALE
12805                                             : (ASCII_FOLD_RESTRICTED)
12806                                               ? FOLD_FLAGS_NOMIX_ASCII
12807                                               : 0)
12808                                 );
12809
12810                 /* Here, <folded> should be the first character of the
12811                  * multi-char fold of <value>, with <foldbuf> containing the
12812                  * whole thing.  But, if this fold is not allowed (because of
12813                  * the flags), <fold> will be the same as <value>, and should
12814                  * be processed like any other character, so skip the special
12815                  * handling */
12816                 if (folded != value) {
12817
12818                     /* Skip if we are recursed, currently parsing the class
12819                      * again.  Otherwise add this character to the list of
12820                      * multi-char folds. */
12821                     if (! RExC_in_multi_char_class) {
12822                         AV** this_array_ptr;
12823                         AV* this_array;
12824                         STRLEN cp_count = utf8_length(foldbuf,
12825                                                       foldbuf + foldlen);
12826                         SV* multi_fold = sv_2mortal(newSVpvn("", 0));
12827
12828                         Perl_sv_catpvf(aTHX_ multi_fold, "\\x{%"UVXf"}", value);
12829
12830
12831                         if (! multi_char_matches) {
12832                             multi_char_matches = newAV();
12833                         }
12834
12835                         /* <multi_char_matches> is actually an array of arrays.
12836                          * There will be one or two top-level elements: [2],
12837                          * and/or [3].  The [2] element is an array, each
12838                          * element thereof is a character which folds to two
12839                          * characters; likewise for [3].  (Unicode guarantees a
12840                          * maximum of 3 characters in any fold.)  When we
12841                          * rewrite the character class below, we will do so
12842                          * such that the longest folds are written first, so
12843                          * that it prefers the longest matching strings first.
12844                          * This is done even if it turns out that any
12845                          * quantifier is non-greedy, out of programmer
12846                          * laziness.  Tom Christiansen has agreed that this is
12847                          * ok.  This makes the test for the ligature 'ffi' come
12848                          * before the test for 'ff' */
12849                         if (av_exists(multi_char_matches, cp_count)) {
12850                             this_array_ptr = (AV**) av_fetch(multi_char_matches,
12851                                                              cp_count, FALSE);
12852                             this_array = *this_array_ptr;
12853                         }
12854                         else {
12855                             this_array = newAV();
12856                             av_store(multi_char_matches, cp_count,
12857                                      (SV*) this_array);
12858                         }
12859                         av_push(this_array, multi_fold);
12860                     }
12861
12862                     /* This element should not be processed further in this
12863                      * class */
12864                     element_count--;
12865                     value = save_value;
12866                     prevvalue = save_prevvalue;
12867                     continue;
12868                 }
12869             }
12870         }
12871
12872         /* Deal with this element of the class */
12873         if (! SIZE_ONLY) {
12874 #ifndef EBCDIC
12875             cp_list = _add_range_to_invlist(cp_list, prevvalue, value);
12876 #else
12877             UV* this_range = _new_invlist(1);
12878             _append_range_to_invlist(this_range, prevvalue, value);
12879
12880             /* In EBCDIC, the ranges 'A-Z' and 'a-z' are each not contiguous.
12881              * If this range was specified using something like 'i-j', we want
12882              * to include only the 'i' and the 'j', and not anything in
12883              * between, so exclude non-ASCII, non-alphabetics from it.
12884              * However, if the range was specified with something like
12885              * [\x89-\x91] or [\x89-j], all code points within it should be
12886              * included.  literal_endpoint==2 means both ends of the range used
12887              * a literal character, not \x{foo} */
12888             if (literal_endpoint == 2
12889                 && (prevvalue >= 'a' && value <= 'z')
12890                     || (prevvalue >= 'A' && value <= 'Z'))
12891             {
12892                 _invlist_intersection(this_range, PL_ASCII, &this_range, );
12893                 _invlist_intersection(this_range, PL_Alpha, &this_range, );
12894             }
12895             _invlist_union(cp_list, this_range, &cp_list);
12896             literal_endpoint = 0;
12897 #endif
12898         }
12899
12900         range = 0; /* this range (if it was one) is done now */
12901     } /* End of loop through all the text within the brackets */
12902
12903     /* If anything in the class expands to more than one character, we have to
12904      * deal with them by building up a substitute parse string, and recursively
12905      * calling reg() on it, instead of proceeding */
12906     if (multi_char_matches) {
12907         SV * substitute_parse = newSVpvn_flags("?:", 2, SVs_TEMP);
12908         I32 cp_count;
12909         STRLEN len;
12910         char *save_end = RExC_end;
12911         char *save_parse = RExC_parse;
12912         bool first_time = TRUE;     /* First multi-char occurrence doesn't get
12913                                        a "|" */
12914         I32 reg_flags;
12915
12916         assert(! invert);
12917 #if 0   /* Have decided not to deal with multi-char folds in inverted classes,
12918            because too confusing */
12919         if (invert) {
12920             sv_catpv(substitute_parse, "(?:");
12921         }
12922 #endif
12923
12924         /* Look at the longest folds first */
12925         for (cp_count = av_len(multi_char_matches); cp_count > 0; cp_count--) {
12926
12927             if (av_exists(multi_char_matches, cp_count)) {
12928                 AV** this_array_ptr;
12929                 SV* this_sequence;
12930
12931                 this_array_ptr = (AV**) av_fetch(multi_char_matches,
12932                                                  cp_count, FALSE);
12933                 while ((this_sequence = av_pop(*this_array_ptr)) !=
12934                                                                 &PL_sv_undef)
12935                 {
12936                     if (! first_time) {
12937                         sv_catpv(substitute_parse, "|");
12938                     }
12939                     first_time = FALSE;
12940
12941                     sv_catpv(substitute_parse, SvPVX(this_sequence));
12942                 }
12943             }
12944         }
12945
12946         /* If the character class contains anything else besides these
12947          * multi-character folds, have to include it in recursive parsing */
12948         if (element_count) {
12949             sv_catpv(substitute_parse, "|[");
12950             sv_catpvn(substitute_parse, orig_parse, RExC_parse - orig_parse);
12951             sv_catpv(substitute_parse, "]");
12952         }
12953
12954         sv_catpv(substitute_parse, ")");
12955 #if 0
12956         if (invert) {
12957             /* This is a way to get the parse to skip forward a whole named
12958              * sequence instead of matching the 2nd character when it fails the
12959              * first */
12960             sv_catpv(substitute_parse, "(*THEN)(*SKIP)(*FAIL)|.)");
12961         }
12962 #endif
12963
12964         RExC_parse = SvPV(substitute_parse, len);
12965         RExC_end = RExC_parse + len;
12966         RExC_in_multi_char_class = 1;
12967         RExC_emit = (regnode *)orig_emit;
12968
12969         ret = reg(pRExC_state, 1, &reg_flags, depth+1);
12970
12971         *flagp |= reg_flags&(HASWIDTH|SIMPLE|SPSTART|POSTPONED);
12972
12973         RExC_parse = save_parse;
12974         RExC_end = save_end;
12975         RExC_in_multi_char_class = 0;
12976         SvREFCNT_dec_NN(multi_char_matches);
12977         SvREFCNT_dec_NN(listsv);
12978         return ret;
12979     }
12980
12981     /* If the character class contains only a single element, it may be
12982      * optimizable into another node type which is smaller and runs faster.
12983      * Check if this is the case for this class */
12984     if (element_count == 1 && ! ret_invlist) {
12985         U8 op = END;
12986         U8 arg = 0;
12987
12988         if (namedclass > OOB_NAMEDCLASS) { /* this is a named class, like \w or
12989                                               [:digit:] or \p{foo} */
12990
12991             /* All named classes are mapped into POSIXish nodes, with its FLAG
12992              * argument giving which class it is */
12993             switch ((I32)namedclass) {
12994                 case ANYOF_UNIPROP:
12995                     break;
12996
12997                 /* These don't depend on the charset modifiers.  They always
12998                  * match under /u rules */
12999                 case ANYOF_NHORIZWS:
13000                 case ANYOF_HORIZWS:
13001                     namedclass = ANYOF_BLANK + namedclass - ANYOF_HORIZWS;
13002                     /* FALLTHROUGH */
13003
13004                 case ANYOF_NVERTWS:
13005                 case ANYOF_VERTWS:
13006                     op = POSIXU;
13007                     goto join_posix;
13008
13009                 /* The actual POSIXish node for all the rest depends on the
13010                  * charset modifier.  The ones in the first set depend only on
13011                  * ASCII or, if available on this platform, locale */
13012                 case ANYOF_ASCII:
13013                 case ANYOF_NASCII:
13014 #ifdef HAS_ISASCII
13015                     op = (LOC) ? POSIXL : POSIXA;
13016 #else
13017                     op = POSIXA;
13018 #endif
13019                     goto join_posix;
13020
13021                 case ANYOF_NCASED:
13022                 case ANYOF_LOWER:
13023                 case ANYOF_NLOWER:
13024                 case ANYOF_UPPER:
13025                 case ANYOF_NUPPER:
13026                     /* under /a could be alpha */
13027                     if (FOLD) {
13028                         if (ASCII_RESTRICTED) {
13029                             namedclass = ANYOF_ALPHA + (namedclass % 2);
13030                         }
13031                         else if (! LOC) {
13032                             break;
13033                         }
13034                     }
13035                     /* FALLTHROUGH */
13036
13037                 /* The rest have more possibilities depending on the charset.
13038                  * We take advantage of the enum ordering of the charset
13039                  * modifiers to get the exact node type, */
13040                 default:
13041                     op = POSIXD + get_regex_charset(RExC_flags);
13042                     if (op > POSIXA) { /* /aa is same as /a */
13043                         op = POSIXA;
13044                     }
13045 #ifndef HAS_ISBLANK
13046                     if (op == POSIXL
13047                         && (namedclass == ANYOF_BLANK
13048                             || namedclass == ANYOF_NBLANK))
13049                     {
13050                         op = POSIXA;
13051                     }
13052 #endif
13053
13054                 join_posix:
13055                     /* The odd numbered ones are the complements of the
13056                      * next-lower even number one */
13057                     if (namedclass % 2 == 1) {
13058                         invert = ! invert;
13059                         namedclass--;
13060                     }
13061                     arg = namedclass_to_classnum(namedclass);
13062                     break;
13063             }
13064         }
13065         else if (value == prevvalue) {
13066
13067             /* Here, the class consists of just a single code point */
13068
13069             if (invert) {
13070                 if (! LOC && value == '\n') {
13071                     op = REG_ANY; /* Optimize [^\n] */
13072                     *flagp |= HASWIDTH|SIMPLE;
13073                     RExC_naughty++;
13074                 }
13075             }
13076             else if (value < 256 || UTF) {
13077
13078                 /* Optimize a single value into an EXACTish node, but not if it
13079                  * would require converting the pattern to UTF-8. */
13080                 op = compute_EXACTish(pRExC_state);
13081             }
13082         } /* Otherwise is a range */
13083         else if (! LOC) {   /* locale could vary these */
13084             if (prevvalue == '0') {
13085                 if (value == '9') {
13086                     arg = _CC_DIGIT;
13087                     op = POSIXA;
13088                 }
13089             }
13090         }
13091
13092         /* Here, we have changed <op> away from its initial value iff we found
13093          * an optimization */
13094         if (op != END) {
13095
13096             /* Throw away this ANYOF regnode, and emit the calculated one,
13097              * which should correspond to the beginning, not current, state of
13098              * the parse */
13099             const char * cur_parse = RExC_parse;
13100             RExC_parse = (char *)orig_parse;
13101             if ( SIZE_ONLY) {
13102                 if (! LOC) {
13103
13104                     /* To get locale nodes to not use the full ANYOF size would
13105                      * require moving the code above that writes the portions
13106                      * of it that aren't in other nodes to after this point.
13107                      * e.g.  ANYOF_CLASS_SET */
13108                     RExC_size = orig_size;
13109                 }
13110             }
13111             else {
13112                 RExC_emit = (regnode *)orig_emit;
13113                 if (PL_regkind[op] == POSIXD) {
13114                     if (invert) {
13115                         op += NPOSIXD - POSIXD;
13116                     }
13117                 }
13118             }
13119
13120             ret = reg_node(pRExC_state, op);
13121
13122             if (PL_regkind[op] == POSIXD || PL_regkind[op] == NPOSIXD) {
13123                 if (! SIZE_ONLY) {
13124                     FLAGS(ret) = arg;
13125                 }
13126                 *flagp |= HASWIDTH|SIMPLE;
13127             }
13128             else if (PL_regkind[op] == EXACT) {
13129                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, 0, value);
13130             }
13131
13132             RExC_parse = (char *) cur_parse;
13133
13134             SvREFCNT_dec(posixes);
13135             SvREFCNT_dec_NN(listsv);
13136             SvREFCNT_dec(cp_list);
13137             return ret;
13138         }
13139     }
13140
13141     if (SIZE_ONLY)
13142         return ret;
13143     /****** !SIZE_ONLY (Pass 2) AFTER HERE *********/
13144
13145     /* If folding, we calculate all characters that could fold to or from the
13146      * ones already on the list */
13147     if (FOLD && cp_list) {
13148         UV start, end;  /* End points of code point ranges */
13149
13150         SV* fold_intersection = NULL;
13151
13152         /* If the highest code point is within Latin1, we can use the
13153          * compiled-in Alphas list, and not have to go out to disk.  This
13154          * yields two false positives, the masculine and feminine ordinal
13155          * indicators, which are weeded out below using the
13156          * IS_IN_SOME_FOLD_L1() macro */
13157         if (invlist_highest(cp_list) < 256) {
13158             _invlist_intersection(PL_L1Posix_ptrs[_CC_ALPHA], cp_list,
13159                                                            &fold_intersection);
13160         }
13161         else {
13162
13163             /* Here, there are non-Latin1 code points, so we will have to go
13164              * fetch the list of all the characters that participate in folds
13165              */
13166             if (! PL_utf8_foldable) {
13167                 SV* swash = swash_init("utf8", "_Perl_Any_Folds",
13168                                        &PL_sv_undef, 1, 0);
13169                 PL_utf8_foldable = _get_swash_invlist(swash);
13170                 SvREFCNT_dec_NN(swash);
13171             }
13172
13173             /* This is a hash that for a particular fold gives all characters
13174              * that are involved in it */
13175             if (! PL_utf8_foldclosures) {
13176
13177                 /* If we were unable to find any folds, then we likely won't be
13178                  * able to find the closures.  So just create an empty list.
13179                  * Folding will effectively be restricted to the non-Unicode
13180                  * rules hard-coded into Perl.  (This case happens legitimately
13181                  * during compilation of Perl itself before the Unicode tables
13182                  * are generated) */
13183                 if (_invlist_len(PL_utf8_foldable) == 0) {
13184                     PL_utf8_foldclosures = newHV();
13185                 }
13186                 else {
13187                     /* If the folds haven't been read in, call a fold function
13188                      * to force that */
13189                     if (! PL_utf8_tofold) {
13190                         U8 dummy[UTF8_MAXBYTES+1];
13191
13192                         /* This string is just a short named one above \xff */
13193                         to_utf8_fold((U8*) HYPHEN_UTF8, dummy, NULL);
13194                         assert(PL_utf8_tofold); /* Verify that worked */
13195                     }
13196                     PL_utf8_foldclosures =
13197                                     _swash_inversion_hash(PL_utf8_tofold);
13198                 }
13199             }
13200
13201             /* Only the characters in this class that participate in folds need
13202              * be checked.  Get the intersection of this class and all the
13203              * possible characters that are foldable.  This can quickly narrow
13204              * down a large class */
13205             _invlist_intersection(PL_utf8_foldable, cp_list,
13206                                   &fold_intersection);
13207         }
13208
13209         /* Now look at the foldable characters in this class individually */
13210         invlist_iterinit(fold_intersection);
13211         while (invlist_iternext(fold_intersection, &start, &end)) {
13212             UV j;
13213
13214             /* Locale folding for Latin1 characters is deferred until runtime */
13215             if (LOC && start < 256) {
13216                 start = 256;
13217             }
13218
13219             /* Look at every character in the range */
13220             for (j = start; j <= end; j++) {
13221
13222                 U8 foldbuf[UTF8_MAXBYTES_CASE+1];
13223                 STRLEN foldlen;
13224                 SV** listp;
13225
13226                 if (j < 256) {
13227
13228                     /* We have the latin1 folding rules hard-coded here so that
13229                      * an innocent-looking character class, like /[ks]/i won't
13230                      * have to go out to disk to find the possible matches.
13231                      * XXX It would be better to generate these via regen, in
13232                      * case a new version of the Unicode standard adds new
13233                      * mappings, though that is not really likely, and may be
13234                      * caught by the default: case of the switch below. */
13235
13236                     if (IS_IN_SOME_FOLD_L1(j)) {
13237
13238                         /* ASCII is always matched; non-ASCII is matched only
13239                          * under Unicode rules */
13240                         if (isASCII(j) || AT_LEAST_UNI_SEMANTICS) {
13241                             cp_list =
13242                                 add_cp_to_invlist(cp_list, PL_fold_latin1[j]);
13243                         }
13244                         else {
13245                             depends_list =
13246                              add_cp_to_invlist(depends_list, PL_fold_latin1[j]);
13247                         }
13248                     }
13249
13250                     if (HAS_NONLATIN1_FOLD_CLOSURE(j)
13251                         && (! isASCII(j) || ! ASCII_FOLD_RESTRICTED))
13252                     {
13253                         /* Certain Latin1 characters have matches outside
13254                          * Latin1.  To get here, <j> is one of those
13255                          * characters.   None of these matches is valid for
13256                          * ASCII characters under /aa, which is why the 'if'
13257                          * just above excludes those.  These matches only
13258                          * happen when the target string is utf8.  The code
13259                          * below adds the single fold closures for <j> to the
13260                          * inversion list. */
13261                         switch (j) {
13262                             case 'k':
13263                             case 'K':
13264                                 cp_list =
13265                                     add_cp_to_invlist(cp_list, KELVIN_SIGN);
13266                                 break;
13267                             case 's':
13268                             case 'S':
13269                                 cp_list = add_cp_to_invlist(cp_list,
13270                                                     LATIN_SMALL_LETTER_LONG_S);
13271                                 break;
13272                             case MICRO_SIGN:
13273                                 cp_list = add_cp_to_invlist(cp_list,
13274                                                     GREEK_CAPITAL_LETTER_MU);
13275                                 cp_list = add_cp_to_invlist(cp_list,
13276                                                     GREEK_SMALL_LETTER_MU);
13277                                 break;
13278                             case LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE:
13279                             case LATIN_SMALL_LETTER_A_WITH_RING_ABOVE:
13280                                 cp_list =
13281                                     add_cp_to_invlist(cp_list, ANGSTROM_SIGN);
13282                                 break;
13283                             case LATIN_SMALL_LETTER_Y_WITH_DIAERESIS:
13284                                 cp_list = add_cp_to_invlist(cp_list,
13285                                         LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS);
13286                                 break;
13287                             case LATIN_SMALL_LETTER_SHARP_S:
13288                                 cp_list = add_cp_to_invlist(cp_list,
13289                                                 LATIN_CAPITAL_LETTER_SHARP_S);
13290                                 break;
13291                             case 'F': case 'f':
13292                             case 'I': case 'i':
13293                             case 'L': case 'l':
13294                             case 'T': case 't':
13295                             case 'A': case 'a':
13296                             case 'H': case 'h':
13297                             case 'J': case 'j':
13298                             case 'N': case 'n':
13299                             case 'W': case 'w':
13300                             case 'Y': case 'y':
13301                                 /* These all are targets of multi-character
13302                                  * folds from code points that require UTF8 to
13303                                  * express, so they can't match unless the
13304                                  * target string is in UTF-8, so no action here
13305                                  * is necessary, as regexec.c properly handles
13306                                  * the general case for UTF-8 matching and
13307                                  * multi-char folds */
13308                                 break;
13309                             default:
13310                                 /* Use deprecated warning to increase the
13311                                  * chances of this being output */
13312                                 ckWARN2regdep(RExC_parse, "Perl folding rules are not up-to-date for 0x%"UVXf"; please use the perlbug utility to report;", j);
13313                                 break;
13314                         }
13315                     }
13316                     continue;
13317                 }
13318
13319                 /* Here is an above Latin1 character.  We don't have the rules
13320                  * hard-coded for it.  First, get its fold.  This is the simple
13321                  * fold, as the multi-character folds have been handled earlier
13322                  * and separated out */
13323                 _to_uni_fold_flags(j, foldbuf, &foldlen,
13324                                                ((LOC)
13325                                                ? FOLD_FLAGS_LOCALE
13326                                                : (ASCII_FOLD_RESTRICTED)
13327                                                   ? FOLD_FLAGS_NOMIX_ASCII
13328                                                   : 0));
13329
13330                 /* Single character fold of above Latin1.  Add everything in
13331                  * its fold closure to the list that this node should match.
13332                  * The fold closures data structure is a hash with the keys
13333                  * being the UTF-8 of every character that is folded to, like
13334                  * 'k', and the values each an array of all code points that
13335                  * fold to its key.  e.g. [ 'k', 'K', KELVIN_SIGN ].
13336                  * Multi-character folds are not included */
13337                 if ((listp = hv_fetch(PL_utf8_foldclosures,
13338                                       (char *) foldbuf, foldlen, FALSE)))
13339                 {
13340                     AV* list = (AV*) *listp;
13341                     IV k;
13342                     for (k = 0; k <= av_len(list); k++) {
13343                         SV** c_p = av_fetch(list, k, FALSE);
13344                         UV c;
13345                         if (c_p == NULL) {
13346                             Perl_croak(aTHX_ "panic: invalid PL_utf8_foldclosures structure");
13347                         }
13348                         c = SvUV(*c_p);
13349
13350                         /* /aa doesn't allow folds between ASCII and non-; /l
13351                          * doesn't allow them between above and below 256 */
13352                         if ((ASCII_FOLD_RESTRICTED
13353                                   && (isASCII(c) != isASCII(j)))
13354                             || (LOC && ((c < 256) != (j < 256))))
13355                         {
13356                             continue;
13357                         }
13358
13359                         /* Folds involving non-ascii Latin1 characters
13360                          * under /d are added to a separate list */
13361                         if (isASCII(c) || c > 255 || AT_LEAST_UNI_SEMANTICS)
13362                         {
13363                             cp_list = add_cp_to_invlist(cp_list, c);
13364                         }
13365                         else {
13366                           depends_list = add_cp_to_invlist(depends_list, c);
13367                         }
13368                     }
13369                 }
13370             }
13371         }
13372         SvREFCNT_dec_NN(fold_intersection);
13373     }
13374
13375     /* And combine the result (if any) with any inversion list from posix
13376      * classes.  The lists are kept separate up to now because we don't want to
13377      * fold the classes (folding of those is automatically handled by the swash
13378      * fetching code) */
13379     if (posixes) {
13380         if (! DEPENDS_SEMANTICS) {
13381             if (cp_list) {
13382                 _invlist_union(cp_list, posixes, &cp_list);
13383                 SvREFCNT_dec_NN(posixes);
13384             }
13385             else {
13386                 cp_list = posixes;
13387             }
13388         }
13389         else {
13390             /* Under /d, we put into a separate list the Latin1 things that
13391              * match only when the target string is utf8 */
13392             SV* nonascii_but_latin1_properties = NULL;
13393             _invlist_intersection(posixes, PL_Latin1,
13394                                   &nonascii_but_latin1_properties);
13395             _invlist_subtract(nonascii_but_latin1_properties, PL_ASCII,
13396                               &nonascii_but_latin1_properties);
13397             _invlist_subtract(posixes, nonascii_but_latin1_properties,
13398                               &posixes);
13399             if (cp_list) {
13400                 _invlist_union(cp_list, posixes, &cp_list);
13401                 SvREFCNT_dec_NN(posixes);
13402             }
13403             else {
13404                 cp_list = posixes;
13405             }
13406
13407             if (depends_list) {
13408                 _invlist_union(depends_list, nonascii_but_latin1_properties,
13409                                &depends_list);
13410                 SvREFCNT_dec_NN(nonascii_but_latin1_properties);
13411             }
13412             else {
13413                 depends_list = nonascii_but_latin1_properties;
13414             }
13415         }
13416     }
13417
13418     /* And combine the result (if any) with any inversion list from properties.
13419      * The lists are kept separate up to now so that we can distinguish the two
13420      * in regards to matching above-Unicode.  A run-time warning is generated
13421      * if a Unicode property is matched against a non-Unicode code point. But,
13422      * we allow user-defined properties to match anything, without any warning,
13423      * and we also suppress the warning if there is a portion of the character
13424      * class that isn't a Unicode property, and which matches above Unicode, \W
13425      * or [\x{110000}] for example.
13426      * (Note that in this case, unlike the Posix one above, there is no
13427      * <depends_list>, because having a Unicode property forces Unicode
13428      * semantics */
13429     if (properties) {
13430         bool warn_super = ! has_user_defined_property;
13431         if (cp_list) {
13432
13433             /* If it matters to the final outcome, see if a non-property
13434              * component of the class matches above Unicode.  If so, the
13435              * warning gets suppressed.  This is true even if just a single
13436              * such code point is specified, as though not strictly correct if
13437              * another such code point is matched against, the fact that they
13438              * are using above-Unicode code points indicates they should know
13439              * the issues involved */
13440             if (warn_super) {
13441                 bool non_prop_matches_above_Unicode =
13442                             runtime_posix_matches_above_Unicode
13443                             | (invlist_highest(cp_list) > PERL_UNICODE_MAX);
13444                 if (invert) {
13445                     non_prop_matches_above_Unicode =
13446                                             !  non_prop_matches_above_Unicode;
13447                 }
13448                 warn_super = ! non_prop_matches_above_Unicode;
13449             }
13450
13451             _invlist_union(properties, cp_list, &cp_list);
13452             SvREFCNT_dec_NN(properties);
13453         }
13454         else {
13455             cp_list = properties;
13456         }
13457
13458         if (warn_super) {
13459             OP(ret) = ANYOF_WARN_SUPER;
13460         }
13461     }
13462
13463     /* Here, we have calculated what code points should be in the character
13464      * class.
13465      *
13466      * Now we can see about various optimizations.  Fold calculation (which we
13467      * did above) needs to take place before inversion.  Otherwise /[^k]/i
13468      * would invert to include K, which under /i would match k, which it
13469      * shouldn't.  Therefore we can't invert folded locale now, as it won't be
13470      * folded until runtime */
13471
13472     /* Optimize inverted simple patterns (e.g. [^a-z]) when everything is known
13473      * at compile time.  Besides not inverting folded locale now, we can't
13474      * invert if there are things such as \w, which aren't known until runtime
13475      * */
13476     if (invert
13477         && ! (LOC && (FOLD || (ANYOF_FLAGS(ret) & ANYOF_CLASS)))
13478         && ! depends_list
13479         && ! HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
13480     {
13481         _invlist_invert(cp_list);
13482
13483         /* Any swash can't be used as-is, because we've inverted things */
13484         if (swash) {
13485             SvREFCNT_dec_NN(swash);
13486             swash = NULL;
13487         }
13488
13489         /* Clear the invert flag since have just done it here */
13490         invert = FALSE;
13491     }
13492
13493     if (ret_invlist) {
13494         *ret_invlist = cp_list;
13495
13496         /* Discard the generated node */
13497         if (SIZE_ONLY) {
13498             RExC_size = orig_size;
13499         }
13500         else {
13501             RExC_emit = orig_emit;
13502         }
13503         return END;
13504     }
13505
13506     /* If we didn't do folding, it's because some information isn't available
13507      * until runtime; set the run-time fold flag for these.  (We don't have to
13508      * worry about properties folding, as that is taken care of by the swash
13509      * fetching) */
13510     if (FOLD && LOC)
13511     {
13512        ANYOF_FLAGS(ret) |= ANYOF_LOC_FOLD;
13513     }
13514
13515     /* Some character classes are equivalent to other nodes.  Such nodes take
13516      * up less room and generally fewer operations to execute than ANYOF nodes.
13517      * Above, we checked for and optimized into some such equivalents for
13518      * certain common classes that are easy to test.  Getting to this point in
13519      * the code means that the class didn't get optimized there.  Since this
13520      * code is only executed in Pass 2, it is too late to save space--it has
13521      * been allocated in Pass 1, and currently isn't given back.  But turning
13522      * things into an EXACTish node can allow the optimizer to join it to any
13523      * adjacent such nodes.  And if the class is equivalent to things like /./,
13524      * expensive run-time swashes can be avoided.  Now that we have more
13525      * complete information, we can find things necessarily missed by the
13526      * earlier code.  I (khw) am not sure how much to look for here.  It would
13527      * be easy, but perhaps too slow, to check any candidates against all the
13528      * node types they could possibly match using _invlistEQ(). */
13529
13530     if (cp_list
13531         && ! invert
13532         && ! depends_list
13533         && ! (ANYOF_FLAGS(ret) & ANYOF_CLASS)
13534         && ! HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
13535     {
13536         UV start, end;
13537         U8 op = END;  /* The optimzation node-type */
13538         const char * cur_parse= RExC_parse;
13539
13540         invlist_iterinit(cp_list);
13541         if (! invlist_iternext(cp_list, &start, &end)) {
13542
13543             /* Here, the list is empty.  This happens, for example, when a
13544              * Unicode property is the only thing in the character class, and
13545              * it doesn't match anything.  (perluniprops.pod notes such
13546              * properties) */
13547             op = OPFAIL;
13548             *flagp |= HASWIDTH|SIMPLE;
13549         }
13550         else if (start == end) {    /* The range is a single code point */
13551             if (! invlist_iternext(cp_list, &start, &end)
13552
13553                     /* Don't do this optimization if it would require changing
13554                      * the pattern to UTF-8 */
13555                 && (start < 256 || UTF))
13556             {
13557                 /* Here, the list contains a single code point.  Can optimize
13558                  * into an EXACT node */
13559
13560                 value = start;
13561
13562                 if (! FOLD) {
13563                     op = EXACT;
13564                 }
13565                 else if (LOC) {
13566
13567                     /* A locale node under folding with one code point can be
13568                      * an EXACTFL, as its fold won't be calculated until
13569                      * runtime */
13570                     op = EXACTFL;
13571                 }
13572                 else {
13573
13574                     /* Here, we are generally folding, but there is only one
13575                      * code point to match.  If we have to, we use an EXACT
13576                      * node, but it would be better for joining with adjacent
13577                      * nodes in the optimization pass if we used the same
13578                      * EXACTFish node that any such are likely to be.  We can
13579                      * do this iff the code point doesn't participate in any
13580                      * folds.  For example, an EXACTF of a colon is the same as
13581                      * an EXACT one, since nothing folds to or from a colon. */
13582                     if (value < 256) {
13583                         if (IS_IN_SOME_FOLD_L1(value)) {
13584                             op = EXACT;
13585                         }
13586                     }
13587                     else {
13588                         if (! PL_utf8_foldable) {
13589                             SV* swash = swash_init("utf8", "_Perl_Any_Folds",
13590                                                 &PL_sv_undef, 1, 0);
13591                             PL_utf8_foldable = _get_swash_invlist(swash);
13592                             SvREFCNT_dec_NN(swash);
13593                         }
13594                         if (_invlist_contains_cp(PL_utf8_foldable, value)) {
13595                             op = EXACT;
13596                         }
13597                     }
13598
13599                     /* If we haven't found the node type, above, it means we
13600                      * can use the prevailing one */
13601                     if (op == END) {
13602                         op = compute_EXACTish(pRExC_state);
13603                     }
13604                 }
13605             }
13606         }
13607         else if (start == 0) {
13608             if (end == UV_MAX) {
13609                 op = SANY;
13610                 *flagp |= HASWIDTH|SIMPLE;
13611                 RExC_naughty++;
13612             }
13613             else if (end == '\n' - 1
13614                     && invlist_iternext(cp_list, &start, &end)
13615                     && start == '\n' + 1 && end == UV_MAX)
13616             {
13617                 op = REG_ANY;
13618                 *flagp |= HASWIDTH|SIMPLE;
13619                 RExC_naughty++;
13620             }
13621         }
13622         invlist_iterfinish(cp_list);
13623
13624         if (op != END) {
13625             RExC_parse = (char *)orig_parse;
13626             RExC_emit = (regnode *)orig_emit;
13627
13628             ret = reg_node(pRExC_state, op);
13629
13630             RExC_parse = (char *)cur_parse;
13631
13632             if (PL_regkind[op] == EXACT) {
13633                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, 0, value);
13634             }
13635
13636             SvREFCNT_dec_NN(cp_list);
13637             SvREFCNT_dec_NN(listsv);
13638             return ret;
13639         }
13640     }
13641
13642     /* Here, <cp_list> contains all the code points we can determine at
13643      * compile time that match under all conditions.  Go through it, and
13644      * for things that belong in the bitmap, put them there, and delete from
13645      * <cp_list>.  While we are at it, see if everything above 255 is in the
13646      * list, and if so, set a flag to speed up execution */
13647     ANYOF_BITMAP_ZERO(ret);
13648     if (cp_list) {
13649
13650         /* This gets set if we actually need to modify things */
13651         bool change_invlist = FALSE;
13652
13653         UV start, end;
13654
13655         /* Start looking through <cp_list> */
13656         invlist_iterinit(cp_list);
13657         while (invlist_iternext(cp_list, &start, &end)) {
13658             UV high;
13659             int i;
13660
13661             if (end == UV_MAX && start <= 256) {
13662                 ANYOF_FLAGS(ret) |= ANYOF_UNICODE_ALL;
13663             }
13664
13665             /* Quit if are above what we should change */
13666             if (start > 255) {
13667                 break;
13668             }
13669
13670             change_invlist = TRUE;
13671
13672             /* Set all the bits in the range, up to the max that we are doing */
13673             high = (end < 255) ? end : 255;
13674             for (i = start; i <= (int) high; i++) {
13675                 if (! ANYOF_BITMAP_TEST(ret, i)) {
13676                     ANYOF_BITMAP_SET(ret, i);
13677                     prevvalue = value;
13678                     value = i;
13679                 }
13680             }
13681         }
13682         invlist_iterfinish(cp_list);
13683
13684         /* Done with loop; remove any code points that are in the bitmap from
13685          * <cp_list> */
13686         if (change_invlist) {
13687             _invlist_subtract(cp_list, PL_Latin1, &cp_list);
13688         }
13689
13690         /* If have completely emptied it, remove it completely */
13691         if (_invlist_len(cp_list) == 0) {
13692             SvREFCNT_dec_NN(cp_list);
13693             cp_list = NULL;
13694         }
13695     }
13696
13697     if (invert) {
13698         ANYOF_FLAGS(ret) |= ANYOF_INVERT;
13699     }
13700
13701     /* Here, the bitmap has been populated with all the Latin1 code points that
13702      * always match.  Can now add to the overall list those that match only
13703      * when the target string is UTF-8 (<depends_list>). */
13704     if (depends_list) {
13705         if (cp_list) {
13706             _invlist_union(cp_list, depends_list, &cp_list);
13707             SvREFCNT_dec_NN(depends_list);
13708         }
13709         else {
13710             cp_list = depends_list;
13711         }
13712     }
13713
13714     /* If there is a swash and more than one element, we can't use the swash in
13715      * the optimization below. */
13716     if (swash && element_count > 1) {
13717         SvREFCNT_dec_NN(swash);
13718         swash = NULL;
13719     }
13720
13721     if (! cp_list
13722         && ! HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
13723     {
13724         ARG_SET(ret, ANYOF_NONBITMAP_EMPTY);
13725         SvREFCNT_dec_NN(listsv);
13726     }
13727     else {
13728         /* av[0] stores the character class description in its textual form:
13729          *       used later (regexec.c:Perl_regclass_swash()) to initialize the
13730          *       appropriate swash, and is also useful for dumping the regnode.
13731          * av[1] if NULL, is a placeholder to later contain the swash computed
13732          *       from av[0].  But if no further computation need be done, the
13733          *       swash is stored there now.
13734          * av[2] stores the cp_list inversion list for use in addition or
13735          *       instead of av[0]; used only if av[1] is NULL
13736          * av[3] is set if any component of the class is from a user-defined
13737          *       property; used only if av[1] is NULL */
13738         AV * const av = newAV();
13739         SV *rv;
13740
13741         av_store(av, 0, (HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
13742                         ? listsv
13743                         : (SvREFCNT_dec_NN(listsv), &PL_sv_undef));
13744         if (swash) {
13745             av_store(av, 1, swash);
13746             SvREFCNT_dec_NN(cp_list);
13747         }
13748         else {
13749             av_store(av, 1, NULL);
13750             if (cp_list) {
13751                 av_store(av, 2, cp_list);
13752                 av_store(av, 3, newSVuv(has_user_defined_property));
13753             }
13754         }
13755
13756         rv = newRV_noinc(MUTABLE_SV(av));
13757         n = add_data(pRExC_state, 1, "s");
13758         RExC_rxi->data->data[n] = (void*)rv;
13759         ARG_SET(ret, n);
13760     }
13761
13762     *flagp |= HASWIDTH|SIMPLE;
13763     return ret;
13764 }
13765 #undef HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION
13766
13767
13768 /* reg_skipcomment()
13769
13770    Absorbs an /x style # comments from the input stream.
13771    Returns true if there is more text remaining in the stream.
13772    Will set the REG_SEEN_RUN_ON_COMMENT flag if the comment
13773    terminates the pattern without including a newline.
13774
13775    Note its the callers responsibility to ensure that we are
13776    actually in /x mode
13777
13778 */
13779
13780 STATIC bool
13781 S_reg_skipcomment(pTHX_ RExC_state_t *pRExC_state)
13782 {
13783     bool ended = 0;
13784
13785     PERL_ARGS_ASSERT_REG_SKIPCOMMENT;
13786
13787     while (RExC_parse < RExC_end)
13788         if (*RExC_parse++ == '\n') {
13789             ended = 1;
13790             break;
13791         }
13792     if (!ended) {
13793         /* we ran off the end of the pattern without ending
13794            the comment, so we have to add an \n when wrapping */
13795         RExC_seen |= REG_SEEN_RUN_ON_COMMENT;
13796         return 0;
13797     } else
13798         return 1;
13799 }
13800
13801 /* nextchar()
13802
13803    Advances the parse position, and optionally absorbs
13804    "whitespace" from the inputstream.
13805
13806    Without /x "whitespace" means (?#...) style comments only,
13807    with /x this means (?#...) and # comments and whitespace proper.
13808
13809    Returns the RExC_parse point from BEFORE the scan occurs.
13810
13811    This is the /x friendly way of saying RExC_parse++.
13812 */
13813
13814 STATIC char*
13815 S_nextchar(pTHX_ RExC_state_t *pRExC_state)
13816 {
13817     char* const retval = RExC_parse++;
13818
13819     PERL_ARGS_ASSERT_NEXTCHAR;
13820
13821     for (;;) {
13822         if (RExC_end - RExC_parse >= 3
13823             && *RExC_parse == '('
13824             && RExC_parse[1] == '?'
13825             && RExC_parse[2] == '#')
13826         {
13827             while (*RExC_parse != ')') {
13828                 if (RExC_parse == RExC_end)
13829                     FAIL("Sequence (?#... not terminated");
13830                 RExC_parse++;
13831             }
13832             RExC_parse++;
13833             continue;
13834         }
13835         if (RExC_flags & RXf_PMf_EXTENDED) {
13836             if (isSPACE(*RExC_parse)) {
13837                 RExC_parse++;
13838                 continue;
13839             }
13840             else if (*RExC_parse == '#') {
13841                 if ( reg_skipcomment( pRExC_state ) )
13842                     continue;
13843             }
13844         }
13845         return retval;
13846     }
13847 }
13848
13849 /*
13850 - reg_node - emit a node
13851 */
13852 STATIC regnode *                        /* Location. */
13853 S_reg_node(pTHX_ RExC_state_t *pRExC_state, U8 op)
13854 {
13855     dVAR;
13856     regnode *ptr;
13857     regnode * const ret = RExC_emit;
13858     GET_RE_DEBUG_FLAGS_DECL;
13859
13860     PERL_ARGS_ASSERT_REG_NODE;
13861
13862     if (SIZE_ONLY) {
13863         SIZE_ALIGN(RExC_size);
13864         RExC_size += 1;
13865         return(ret);
13866     }
13867     if (RExC_emit >= RExC_emit_bound)
13868         Perl_croak(aTHX_ "panic: reg_node overrun trying to emit %d, %p>=%p",
13869                    op, RExC_emit, RExC_emit_bound);
13870
13871     NODE_ALIGN_FILL(ret);
13872     ptr = ret;
13873     FILL_ADVANCE_NODE(ptr, op);
13874     REH_CALL_COMP_NODE_HOOK(pRExC_state->rx, (ptr) - 1);
13875 #ifdef RE_TRACK_PATTERN_OFFSETS
13876     if (RExC_offsets) {         /* MJD */
13877         MJD_OFFSET_DEBUG(("%s:%d: (op %s) %s %"UVuf" (len %"UVuf") (max %"UVuf").\n", 
13878               "reg_node", __LINE__, 
13879               PL_reg_name[op],
13880               (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0] 
13881                 ? "Overwriting end of array!\n" : "OK",
13882               (UV)(RExC_emit - RExC_emit_start),
13883               (UV)(RExC_parse - RExC_start),
13884               (UV)RExC_offsets[0])); 
13885         Set_Node_Offset(RExC_emit, RExC_parse + (op == END));
13886     }
13887 #endif
13888     RExC_emit = ptr;
13889     return(ret);
13890 }
13891
13892 /*
13893 - reganode - emit a node with an argument
13894 */
13895 STATIC regnode *                        /* Location. */
13896 S_reganode(pTHX_ RExC_state_t *pRExC_state, U8 op, U32 arg)
13897 {
13898     dVAR;
13899     regnode *ptr;
13900     regnode * const ret = RExC_emit;
13901     GET_RE_DEBUG_FLAGS_DECL;
13902
13903     PERL_ARGS_ASSERT_REGANODE;
13904
13905     if (SIZE_ONLY) {
13906         SIZE_ALIGN(RExC_size);
13907         RExC_size += 2;
13908         /* 
13909            We can't do this:
13910            
13911            assert(2==regarglen[op]+1); 
13912
13913            Anything larger than this has to allocate the extra amount.
13914            If we changed this to be:
13915            
13916            RExC_size += (1 + regarglen[op]);
13917            
13918            then it wouldn't matter. Its not clear what side effect
13919            might come from that so its not done so far.
13920            -- dmq
13921         */
13922         return(ret);
13923     }
13924     if (RExC_emit >= RExC_emit_bound)
13925         Perl_croak(aTHX_ "panic: reg_node overrun trying to emit %d, %p>=%p",
13926                    op, RExC_emit, RExC_emit_bound);
13927
13928     NODE_ALIGN_FILL(ret);
13929     ptr = ret;
13930     FILL_ADVANCE_NODE_ARG(ptr, op, arg);
13931     REH_CALL_COMP_NODE_HOOK(pRExC_state->rx, (ptr) - 2);
13932 #ifdef RE_TRACK_PATTERN_OFFSETS
13933     if (RExC_offsets) {         /* MJD */
13934         MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s %"UVuf" <- %"UVuf" (max %"UVuf").\n", 
13935               "reganode",
13936               __LINE__,
13937               PL_reg_name[op],
13938               (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0] ? 
13939               "Overwriting end of array!\n" : "OK",
13940               (UV)(RExC_emit - RExC_emit_start),
13941               (UV)(RExC_parse - RExC_start),
13942               (UV)RExC_offsets[0])); 
13943         Set_Cur_Node_Offset;
13944     }
13945 #endif            
13946     RExC_emit = ptr;
13947     return(ret);
13948 }
13949
13950 /*
13951 - reguni - emit (if appropriate) a Unicode character
13952 */
13953 STATIC STRLEN
13954 S_reguni(pTHX_ const RExC_state_t *pRExC_state, UV uv, char* s)
13955 {
13956     dVAR;
13957
13958     PERL_ARGS_ASSERT_REGUNI;
13959
13960     return SIZE_ONLY ? UNISKIP(uv) : (uvchr_to_utf8((U8*)s, uv) - (U8*)s);
13961 }
13962
13963 /*
13964 - reginsert - insert an operator in front of already-emitted operand
13965 *
13966 * Means relocating the operand.
13967 */
13968 STATIC void
13969 S_reginsert(pTHX_ RExC_state_t *pRExC_state, U8 op, regnode *opnd, U32 depth)
13970 {
13971     dVAR;
13972     regnode *src;
13973     regnode *dst;
13974     regnode *place;
13975     const int offset = regarglen[(U8)op];
13976     const int size = NODE_STEP_REGNODE + offset;
13977     GET_RE_DEBUG_FLAGS_DECL;
13978
13979     PERL_ARGS_ASSERT_REGINSERT;
13980     PERL_UNUSED_ARG(depth);
13981 /* (PL_regkind[(U8)op] == CURLY ? EXTRA_STEP_2ARGS : 0); */
13982     DEBUG_PARSE_FMT("inst"," - %s",PL_reg_name[op]);
13983     if (SIZE_ONLY) {
13984         RExC_size += size;
13985         return;
13986     }
13987
13988     src = RExC_emit;
13989     RExC_emit += size;
13990     dst = RExC_emit;
13991     if (RExC_open_parens) {
13992         int paren;
13993         /*DEBUG_PARSE_FMT("inst"," - %"IVdf, (IV)RExC_npar);*/
13994         for ( paren=0 ; paren < RExC_npar ; paren++ ) {
13995             if ( RExC_open_parens[paren] >= opnd ) {
13996                 /*DEBUG_PARSE_FMT("open"," - %d",size);*/
13997                 RExC_open_parens[paren] += size;
13998             } else {
13999                 /*DEBUG_PARSE_FMT("open"," - %s","ok");*/
14000             }
14001             if ( RExC_close_parens[paren] >= opnd ) {
14002                 /*DEBUG_PARSE_FMT("close"," - %d",size);*/
14003                 RExC_close_parens[paren] += size;
14004             } else {
14005                 /*DEBUG_PARSE_FMT("close"," - %s","ok");*/
14006             }
14007         }
14008     }
14009
14010     while (src > opnd) {
14011         StructCopy(--src, --dst, regnode);
14012 #ifdef RE_TRACK_PATTERN_OFFSETS
14013         if (RExC_offsets) {     /* MJD 20010112 */
14014             MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s copy %"UVuf" -> %"UVuf" (max %"UVuf").\n",
14015                   "reg_insert",
14016                   __LINE__,
14017                   PL_reg_name[op],
14018                   (UV)(dst - RExC_emit_start) > RExC_offsets[0] 
14019                     ? "Overwriting end of array!\n" : "OK",
14020                   (UV)(src - RExC_emit_start),
14021                   (UV)(dst - RExC_emit_start),
14022                   (UV)RExC_offsets[0])); 
14023             Set_Node_Offset_To_R(dst-RExC_emit_start, Node_Offset(src));
14024             Set_Node_Length_To_R(dst-RExC_emit_start, Node_Length(src));
14025         }
14026 #endif
14027     }
14028     
14029
14030     place = opnd;               /* Op node, where operand used to be. */
14031 #ifdef RE_TRACK_PATTERN_OFFSETS
14032     if (RExC_offsets) {         /* MJD */
14033         MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s %"UVuf" <- %"UVuf" (max %"UVuf").\n", 
14034               "reginsert",
14035               __LINE__,
14036               PL_reg_name[op],
14037               (UV)(place - RExC_emit_start) > RExC_offsets[0] 
14038               ? "Overwriting end of array!\n" : "OK",
14039               (UV)(place - RExC_emit_start),
14040               (UV)(RExC_parse - RExC_start),
14041               (UV)RExC_offsets[0]));
14042         Set_Node_Offset(place, RExC_parse);
14043         Set_Node_Length(place, 1);
14044     }
14045 #endif    
14046     src = NEXTOPER(place);
14047     FILL_ADVANCE_NODE(place, op);
14048     REH_CALL_COMP_NODE_HOOK(pRExC_state->rx, (place) - 1);
14049     Zero(src, offset, regnode);
14050 }
14051
14052 /*
14053 - regtail - set the next-pointer at the end of a node chain of p to val.
14054 - SEE ALSO: regtail_study
14055 */
14056 /* TODO: All three parms should be const */
14057 STATIC void
14058 S_regtail(pTHX_ RExC_state_t *pRExC_state, regnode *p, const regnode *val,U32 depth)
14059 {
14060     dVAR;
14061     regnode *scan;
14062     GET_RE_DEBUG_FLAGS_DECL;
14063
14064     PERL_ARGS_ASSERT_REGTAIL;
14065 #ifndef DEBUGGING
14066     PERL_UNUSED_ARG(depth);
14067 #endif
14068
14069     if (SIZE_ONLY)
14070         return;
14071
14072     /* Find last node. */
14073     scan = p;
14074     for (;;) {
14075         regnode * const temp = regnext(scan);
14076         DEBUG_PARSE_r({
14077             SV * const mysv=sv_newmortal();
14078             DEBUG_PARSE_MSG((scan==p ? "tail" : ""));
14079             regprop(RExC_rx, mysv, scan);
14080             PerlIO_printf(Perl_debug_log, "~ %s (%d) %s %s\n",
14081                 SvPV_nolen_const(mysv), REG_NODE_NUM(scan),
14082                     (temp == NULL ? "->" : ""),
14083                     (temp == NULL ? PL_reg_name[OP(val)] : "")
14084             );
14085         });
14086         if (temp == NULL)
14087             break;
14088         scan = temp;
14089     }
14090
14091     if (reg_off_by_arg[OP(scan)]) {
14092         ARG_SET(scan, val - scan);
14093     }
14094     else {
14095         NEXT_OFF(scan) = val - scan;
14096     }
14097 }
14098
14099 #ifdef DEBUGGING
14100 /*
14101 - regtail_study - set the next-pointer at the end of a node chain of p to val.
14102 - Look for optimizable sequences at the same time.
14103 - currently only looks for EXACT chains.
14104
14105 This is experimental code. The idea is to use this routine to perform 
14106 in place optimizations on branches and groups as they are constructed,
14107 with the long term intention of removing optimization from study_chunk so
14108 that it is purely analytical.
14109
14110 Currently only used when in DEBUG mode. The macro REGTAIL_STUDY() is used
14111 to control which is which.
14112
14113 */
14114 /* TODO: All four parms should be const */
14115
14116 STATIC U8
14117 S_regtail_study(pTHX_ RExC_state_t *pRExC_state, regnode *p, const regnode *val,U32 depth)
14118 {
14119     dVAR;
14120     regnode *scan;
14121     U8 exact = PSEUDO;
14122 #ifdef EXPERIMENTAL_INPLACESCAN
14123     I32 min = 0;
14124 #endif
14125     GET_RE_DEBUG_FLAGS_DECL;
14126
14127     PERL_ARGS_ASSERT_REGTAIL_STUDY;
14128
14129
14130     if (SIZE_ONLY)
14131         return exact;
14132
14133     /* Find last node. */
14134
14135     scan = p;
14136     for (;;) {
14137         regnode * const temp = regnext(scan);
14138 #ifdef EXPERIMENTAL_INPLACESCAN
14139         if (PL_regkind[OP(scan)] == EXACT) {
14140             bool has_exactf_sharp_s;    /* Unexamined in this routine */
14141             if (join_exact(pRExC_state,scan,&min, &has_exactf_sharp_s, 1,val,depth+1))
14142                 return EXACT;
14143         }
14144 #endif
14145         if ( exact ) {
14146             switch (OP(scan)) {
14147                 case EXACT:
14148                 case EXACTF:
14149                 case EXACTFA:
14150                 case EXACTFU:
14151                 case EXACTFU_SS:
14152                 case EXACTFU_TRICKYFOLD:
14153                 case EXACTFL:
14154                         if( exact == PSEUDO )
14155                             exact= OP(scan);
14156                         else if ( exact != OP(scan) )
14157                             exact= 0;
14158                 case NOTHING:
14159                     break;
14160                 default:
14161                     exact= 0;
14162             }
14163         }
14164         DEBUG_PARSE_r({
14165             SV * const mysv=sv_newmortal();
14166             DEBUG_PARSE_MSG((scan==p ? "tsdy" : ""));
14167             regprop(RExC_rx, mysv, scan);
14168             PerlIO_printf(Perl_debug_log, "~ %s (%d) -> %s\n",
14169                 SvPV_nolen_const(mysv),
14170                 REG_NODE_NUM(scan),
14171                 PL_reg_name[exact]);
14172         });
14173         if (temp == NULL)
14174             break;
14175         scan = temp;
14176     }
14177     DEBUG_PARSE_r({
14178         SV * const mysv_val=sv_newmortal();
14179         DEBUG_PARSE_MSG("");
14180         regprop(RExC_rx, mysv_val, val);
14181         PerlIO_printf(Perl_debug_log, "~ attach to %s (%"IVdf") offset to %"IVdf"\n",
14182                       SvPV_nolen_const(mysv_val),
14183                       (IV)REG_NODE_NUM(val),
14184                       (IV)(val - scan)
14185         );
14186     });
14187     if (reg_off_by_arg[OP(scan)]) {
14188         ARG_SET(scan, val - scan);
14189     }
14190     else {
14191         NEXT_OFF(scan) = val - scan;
14192     }
14193
14194     return exact;
14195 }
14196 #endif
14197
14198 /*
14199  - regdump - dump a regexp onto Perl_debug_log in vaguely comprehensible form
14200  */
14201 #ifdef DEBUGGING
14202 static void 
14203 S_regdump_extflags(pTHX_ const char *lead, const U32 flags)
14204 {
14205     int bit;
14206     int set=0;
14207     regex_charset cs;
14208
14209     for (bit=0; bit<32; bit++) {
14210         if (flags & (1<<bit)) {
14211             if ((1<<bit) & RXf_PMf_CHARSET) {   /* Output separately, below */
14212                 continue;
14213             }
14214             if (!set++ && lead) 
14215                 PerlIO_printf(Perl_debug_log, "%s",lead);
14216             PerlIO_printf(Perl_debug_log, "%s ",PL_reg_extflags_name[bit]);
14217         }               
14218     }      
14219     if ((cs = get_regex_charset(flags)) != REGEX_DEPENDS_CHARSET) {
14220             if (!set++ && lead) {
14221                 PerlIO_printf(Perl_debug_log, "%s",lead);
14222             }
14223             switch (cs) {
14224                 case REGEX_UNICODE_CHARSET:
14225                     PerlIO_printf(Perl_debug_log, "UNICODE");
14226                     break;
14227                 case REGEX_LOCALE_CHARSET:
14228                     PerlIO_printf(Perl_debug_log, "LOCALE");
14229                     break;
14230                 case REGEX_ASCII_RESTRICTED_CHARSET:
14231                     PerlIO_printf(Perl_debug_log, "ASCII-RESTRICTED");
14232                     break;
14233                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
14234                     PerlIO_printf(Perl_debug_log, "ASCII-MORE_RESTRICTED");
14235                     break;
14236                 default:
14237                     PerlIO_printf(Perl_debug_log, "UNKNOWN CHARACTER SET");
14238                     break;
14239             }
14240     }
14241     if (lead)  {
14242         if (set) 
14243             PerlIO_printf(Perl_debug_log, "\n");
14244         else 
14245             PerlIO_printf(Perl_debug_log, "%s[none-set]\n",lead);
14246     }            
14247 }   
14248 #endif
14249
14250 void
14251 Perl_regdump(pTHX_ const regexp *r)
14252 {
14253 #ifdef DEBUGGING
14254     dVAR;
14255     SV * const sv = sv_newmortal();
14256     SV *dsv= sv_newmortal();
14257     RXi_GET_DECL(r,ri);
14258     GET_RE_DEBUG_FLAGS_DECL;
14259
14260     PERL_ARGS_ASSERT_REGDUMP;
14261
14262     (void)dumpuntil(r, ri->program, ri->program + 1, NULL, NULL, sv, 0, 0);
14263
14264     /* Header fields of interest. */
14265     if (r->anchored_substr) {
14266         RE_PV_QUOTED_DECL(s, 0, dsv, SvPVX_const(r->anchored_substr), 
14267             RE_SV_DUMPLEN(r->anchored_substr), 30);
14268         PerlIO_printf(Perl_debug_log,
14269                       "anchored %s%s at %"IVdf" ",
14270                       s, RE_SV_TAIL(r->anchored_substr),
14271                       (IV)r->anchored_offset);
14272     } else if (r->anchored_utf8) {
14273         RE_PV_QUOTED_DECL(s, 1, dsv, SvPVX_const(r->anchored_utf8), 
14274             RE_SV_DUMPLEN(r->anchored_utf8), 30);
14275         PerlIO_printf(Perl_debug_log,
14276                       "anchored utf8 %s%s at %"IVdf" ",
14277                       s, RE_SV_TAIL(r->anchored_utf8),
14278                       (IV)r->anchored_offset);
14279     }                 
14280     if (r->float_substr) {
14281         RE_PV_QUOTED_DECL(s, 0, dsv, SvPVX_const(r->float_substr), 
14282             RE_SV_DUMPLEN(r->float_substr), 30);
14283         PerlIO_printf(Perl_debug_log,
14284                       "floating %s%s at %"IVdf"..%"UVuf" ",
14285                       s, RE_SV_TAIL(r->float_substr),
14286                       (IV)r->float_min_offset, (UV)r->float_max_offset);
14287     } else if (r->float_utf8) {
14288         RE_PV_QUOTED_DECL(s, 1, dsv, SvPVX_const(r->float_utf8), 
14289             RE_SV_DUMPLEN(r->float_utf8), 30);
14290         PerlIO_printf(Perl_debug_log,
14291                       "floating utf8 %s%s at %"IVdf"..%"UVuf" ",
14292                       s, RE_SV_TAIL(r->float_utf8),
14293                       (IV)r->float_min_offset, (UV)r->float_max_offset);
14294     }
14295     if (r->check_substr || r->check_utf8)
14296         PerlIO_printf(Perl_debug_log,
14297                       (const char *)
14298                       (r->check_substr == r->float_substr
14299                        && r->check_utf8 == r->float_utf8
14300                        ? "(checking floating" : "(checking anchored"));
14301     if (r->extflags & RXf_NOSCAN)
14302         PerlIO_printf(Perl_debug_log, " noscan");
14303     if (r->extflags & RXf_CHECK_ALL)
14304         PerlIO_printf(Perl_debug_log, " isall");
14305     if (r->check_substr || r->check_utf8)
14306         PerlIO_printf(Perl_debug_log, ") ");
14307
14308     if (ri->regstclass) {
14309         regprop(r, sv, ri->regstclass);
14310         PerlIO_printf(Perl_debug_log, "stclass %s ", SvPVX_const(sv));
14311     }
14312     if (r->extflags & RXf_ANCH) {
14313         PerlIO_printf(Perl_debug_log, "anchored");
14314         if (r->extflags & RXf_ANCH_BOL)
14315             PerlIO_printf(Perl_debug_log, "(BOL)");
14316         if (r->extflags & RXf_ANCH_MBOL)
14317             PerlIO_printf(Perl_debug_log, "(MBOL)");
14318         if (r->extflags & RXf_ANCH_SBOL)
14319             PerlIO_printf(Perl_debug_log, "(SBOL)");
14320         if (r->extflags & RXf_ANCH_GPOS)
14321             PerlIO_printf(Perl_debug_log, "(GPOS)");
14322         PerlIO_putc(Perl_debug_log, ' ');
14323     }
14324     if (r->extflags & RXf_GPOS_SEEN)
14325         PerlIO_printf(Perl_debug_log, "GPOS:%"UVuf" ", (UV)r->gofs);
14326     if (r->intflags & PREGf_SKIP)
14327         PerlIO_printf(Perl_debug_log, "plus ");
14328     if (r->intflags & PREGf_IMPLICIT)
14329         PerlIO_printf(Perl_debug_log, "implicit ");
14330     PerlIO_printf(Perl_debug_log, "minlen %"IVdf" ", (IV)r->minlen);
14331     if (r->extflags & RXf_EVAL_SEEN)
14332         PerlIO_printf(Perl_debug_log, "with eval ");
14333     PerlIO_printf(Perl_debug_log, "\n");
14334     DEBUG_FLAGS_r(regdump_extflags("r->extflags: ",r->extflags));            
14335 #else
14336     PERL_ARGS_ASSERT_REGDUMP;
14337     PERL_UNUSED_CONTEXT;
14338     PERL_UNUSED_ARG(r);
14339 #endif  /* DEBUGGING */
14340 }
14341
14342 /*
14343 - regprop - printable representation of opcode
14344 */
14345 #define EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags) \
14346 STMT_START { \
14347         if (do_sep) {                           \
14348             Perl_sv_catpvf(aTHX_ sv,"%s][%s",PL_colors[1],PL_colors[0]); \
14349             if (flags & ANYOF_INVERT)           \
14350                 /*make sure the invert info is in each */ \
14351                 sv_catpvs(sv, "^");             \
14352             do_sep = 0;                         \
14353         }                                       \
14354 } STMT_END
14355
14356 void
14357 Perl_regprop(pTHX_ const regexp *prog, SV *sv, const regnode *o)
14358 {
14359 #ifdef DEBUGGING
14360     dVAR;
14361     int k;
14362
14363     /* Should be synchronized with * ANYOF_ #xdefines in regcomp.h */
14364     static const char * const anyofs[] = {
14365 #if _CC_WORDCHAR != 0 || _CC_DIGIT != 1 || _CC_ALPHA != 2 || _CC_LOWER != 3 \
14366     || _CC_UPPER != 4 || _CC_PUNCT != 5 || _CC_PRINT != 6                   \
14367     || _CC_ALPHANUMERIC != 7 || _CC_GRAPH != 8 || _CC_CASED != 9            \
14368     || _CC_SPACE != 10 || _CC_BLANK != 11 || _CC_XDIGIT != 12               \
14369     || _CC_PSXSPC != 13 || _CC_CNTRL != 14 || _CC_ASCII != 15               \
14370     || _CC_VERTSPACE != 16
14371   #error Need to adjust order of anyofs[]
14372 #endif
14373         "[\\w]",
14374         "[\\W]",
14375         "[\\d]",
14376         "[\\D]",
14377         "[:alpha:]",
14378         "[:^alpha:]",
14379         "[:lower:]",
14380         "[:^lower:]",
14381         "[:upper:]",
14382         "[:^upper:]",
14383         "[:punct:]",
14384         "[:^punct:]",
14385         "[:print:]",
14386         "[:^print:]",
14387         "[:alnum:]",
14388         "[:^alnum:]",
14389         "[:graph:]",
14390         "[:^graph:]",
14391         "[:cased:]",
14392         "[:^cased:]",
14393         "[\\s]",
14394         "[\\S]",
14395         "[:blank:]",
14396         "[:^blank:]",
14397         "[:xdigit:]",
14398         "[:^xdigit:]",
14399         "[:space:]",
14400         "[:^space:]",
14401         "[:cntrl:]",
14402         "[:^cntrl:]",
14403         "[:ascii:]",
14404         "[:^ascii:]",
14405         "[\\v]",
14406         "[\\V]"
14407     };
14408     RXi_GET_DECL(prog,progi);
14409     GET_RE_DEBUG_FLAGS_DECL;
14410     
14411     PERL_ARGS_ASSERT_REGPROP;
14412
14413     sv_setpvs(sv, "");
14414
14415     if (OP(o) > REGNODE_MAX)            /* regnode.type is unsigned */
14416         /* It would be nice to FAIL() here, but this may be called from
14417            regexec.c, and it would be hard to supply pRExC_state. */
14418         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d", (int)OP(o), (int)REGNODE_MAX);
14419     sv_catpv(sv, PL_reg_name[OP(o)]); /* Take off const! */
14420
14421     k = PL_regkind[OP(o)];
14422
14423     if (k == EXACT) {
14424         sv_catpvs(sv, " ");
14425         /* Using is_utf8_string() (via PERL_PV_UNI_DETECT) 
14426          * is a crude hack but it may be the best for now since 
14427          * we have no flag "this EXACTish node was UTF-8" 
14428          * --jhi */
14429         pv_pretty(sv, STRING(o), STR_LEN(o), 60, PL_colors[0], PL_colors[1],
14430                   PERL_PV_ESCAPE_UNI_DETECT |
14431                   PERL_PV_ESCAPE_NONASCII   |
14432                   PERL_PV_PRETTY_ELLIPSES   |
14433                   PERL_PV_PRETTY_LTGT       |
14434                   PERL_PV_PRETTY_NOCLEAR
14435                   );
14436     } else if (k == TRIE) {
14437         /* print the details of the trie in dumpuntil instead, as
14438          * progi->data isn't available here */
14439         const char op = OP(o);
14440         const U32 n = ARG(o);
14441         const reg_ac_data * const ac = IS_TRIE_AC(op) ?
14442                (reg_ac_data *)progi->data->data[n] :
14443                NULL;
14444         const reg_trie_data * const trie
14445             = (reg_trie_data*)progi->data->data[!IS_TRIE_AC(op) ? n : ac->trie];
14446         
14447         Perl_sv_catpvf(aTHX_ sv, "-%s",PL_reg_name[o->flags]);
14448         DEBUG_TRIE_COMPILE_r(
14449             Perl_sv_catpvf(aTHX_ sv,
14450                 "<S:%"UVuf"/%"IVdf" W:%"UVuf" L:%"UVuf"/%"UVuf" C:%"UVuf"/%"UVuf">",
14451                 (UV)trie->startstate,
14452                 (IV)trie->statecount-1, /* -1 because of the unused 0 element */
14453                 (UV)trie->wordcount,
14454                 (UV)trie->minlen,
14455                 (UV)trie->maxlen,
14456                 (UV)TRIE_CHARCOUNT(trie),
14457                 (UV)trie->uniquecharcount
14458             )
14459         );
14460         if ( IS_ANYOF_TRIE(op) || trie->bitmap ) {
14461             int i;
14462             int rangestart = -1;
14463             U8* bitmap = IS_ANYOF_TRIE(op) ? (U8*)ANYOF_BITMAP(o) : (U8*)TRIE_BITMAP(trie);
14464             sv_catpvs(sv, "[");
14465             for (i = 0; i <= 256; i++) {
14466                 if (i < 256 && BITMAP_TEST(bitmap,i)) {
14467                     if (rangestart == -1)
14468                         rangestart = i;
14469                 } else if (rangestart != -1) {
14470                     if (i <= rangestart + 3)
14471                         for (; rangestart < i; rangestart++)
14472                             put_byte(sv, rangestart);
14473                     else {
14474                         put_byte(sv, rangestart);
14475                         sv_catpvs(sv, "-");
14476                         put_byte(sv, i - 1);
14477                     }
14478                     rangestart = -1;
14479                 }
14480             }
14481             sv_catpvs(sv, "]");
14482         } 
14483          
14484     } else if (k == CURLY) {
14485         if (OP(o) == CURLYM || OP(o) == CURLYN || OP(o) == CURLYX)
14486             Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags); /* Parenth number */
14487         Perl_sv_catpvf(aTHX_ sv, " {%d,%d}", ARG1(o), ARG2(o));
14488     }
14489     else if (k == WHILEM && o->flags)                   /* Ordinal/of */
14490         Perl_sv_catpvf(aTHX_ sv, "[%d/%d]", o->flags & 0xf, o->flags>>4);
14491     else if (k == REF || k == OPEN || k == CLOSE || k == GROUPP || OP(o)==ACCEPT) {
14492         Perl_sv_catpvf(aTHX_ sv, "%d", (int)ARG(o));    /* Parenth number */
14493         if ( RXp_PAREN_NAMES(prog) ) {
14494             if ( k != REF || (OP(o) < NREF)) {
14495                 AV *list= MUTABLE_AV(progi->data->data[progi->name_list_idx]);
14496                 SV **name= av_fetch(list, ARG(o), 0 );
14497                 if (name)
14498                     Perl_sv_catpvf(aTHX_ sv, " '%"SVf"'", SVfARG(*name));
14499             }       
14500             else {
14501                 AV *list= MUTABLE_AV(progi->data->data[ progi->name_list_idx ]);
14502                 SV *sv_dat= MUTABLE_SV(progi->data->data[ ARG( o ) ]);
14503                 I32 *nums=(I32*)SvPVX(sv_dat);
14504                 SV **name= av_fetch(list, nums[0], 0 );
14505                 I32 n;
14506                 if (name) {
14507                     for ( n=0; n<SvIVX(sv_dat); n++ ) {
14508                         Perl_sv_catpvf(aTHX_ sv, "%s%"IVdf,
14509                                     (n ? "," : ""), (IV)nums[n]);
14510                     }
14511                     Perl_sv_catpvf(aTHX_ sv, " '%"SVf"'", SVfARG(*name));
14512                 }
14513             }
14514         }            
14515     } else if (k == GOSUB) 
14516         Perl_sv_catpvf(aTHX_ sv, "%d[%+d]", (int)ARG(o),(int)ARG2L(o)); /* Paren and offset */
14517     else if (k == VERB) {
14518         if (!o->flags) 
14519             Perl_sv_catpvf(aTHX_ sv, ":%"SVf, 
14520                            SVfARG((MUTABLE_SV(progi->data->data[ ARG( o ) ]))));
14521     } else if (k == LOGICAL)
14522         Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags);     /* 2: embedded, otherwise 1 */
14523     else if (k == ANYOF) {
14524         int i, rangestart = -1;
14525         const U8 flags = ANYOF_FLAGS(o);
14526         int do_sep = 0;
14527
14528
14529         if (flags & ANYOF_LOCALE)
14530             sv_catpvs(sv, "{loc}");
14531         if (flags & ANYOF_LOC_FOLD)
14532             sv_catpvs(sv, "{i}");
14533         Perl_sv_catpvf(aTHX_ sv, "[%s", PL_colors[0]);
14534         if (flags & ANYOF_INVERT)
14535             sv_catpvs(sv, "^");
14536
14537         /* output what the standard cp 0-255 bitmap matches */
14538         for (i = 0; i <= 256; i++) {
14539             if (i < 256 && ANYOF_BITMAP_TEST(o,i)) {
14540                 if (rangestart == -1)
14541                     rangestart = i;
14542             } else if (rangestart != -1) {
14543                 if (i <= rangestart + 3)
14544                     for (; rangestart < i; rangestart++)
14545                         put_byte(sv, rangestart);
14546                 else {
14547                     put_byte(sv, rangestart);
14548                     sv_catpvs(sv, "-");
14549                     put_byte(sv, i - 1);
14550                 }
14551                 do_sep = 1;
14552                 rangestart = -1;
14553             }
14554         }
14555         
14556         EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags);
14557         /* output any special charclass tests (used entirely under use locale) */
14558         if (ANYOF_CLASS_TEST_ANY_SET(o))
14559             for (i = 0; i < (int)(sizeof(anyofs)/sizeof(char*)); i++)
14560                 if (ANYOF_CLASS_TEST(o,i)) {
14561                     sv_catpv(sv, anyofs[i]);
14562                     do_sep = 1;
14563                 }
14564         
14565         EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags);
14566         
14567         if (flags & ANYOF_NON_UTF8_LATIN1_ALL) {
14568             sv_catpvs(sv, "{non-utf8-latin1-all}");
14569         }
14570
14571         /* output information about the unicode matching */
14572         if (flags & ANYOF_UNICODE_ALL)
14573             sv_catpvs(sv, "{unicode_all}");
14574         else if (ANYOF_NONBITMAP(o))
14575             sv_catpvs(sv, "{unicode}");
14576         if (flags & ANYOF_NONBITMAP_NON_UTF8)
14577             sv_catpvs(sv, "{outside bitmap}");
14578
14579         if (ANYOF_NONBITMAP(o)) {
14580             SV *lv; /* Set if there is something outside the bit map */
14581             SV * const sw = regclass_swash(prog, o, FALSE, &lv, NULL);
14582             bool byte_output = FALSE;   /* If something in the bitmap has been
14583                                            output */
14584
14585             if (lv && lv != &PL_sv_undef) {
14586                 if (sw) {
14587                     U8 s[UTF8_MAXBYTES_CASE+1];
14588
14589                     for (i = 0; i <= 256; i++) { /* Look at chars in bitmap */
14590                         uvchr_to_utf8(s, i);
14591
14592                         if (i < 256
14593                             && ! ANYOF_BITMAP_TEST(o, i)    /* Don't duplicate
14594                                                                things already
14595                                                                output as part
14596                                                                of the bitmap */
14597                             && swash_fetch(sw, s, TRUE))
14598                         {
14599                             if (rangestart == -1)
14600                                 rangestart = i;
14601                         } else if (rangestart != -1) {
14602                             byte_output = TRUE;
14603                             if (i <= rangestart + 3)
14604                                 for (; rangestart < i; rangestart++) {
14605                                     put_byte(sv, rangestart);
14606                                 }
14607                             else {
14608                                 put_byte(sv, rangestart);
14609                                 sv_catpvs(sv, "-");
14610                                 put_byte(sv, i-1);
14611                             }
14612                             rangestart = -1;
14613                         }
14614                     }
14615                 }
14616
14617                 {
14618                     char *s = savesvpv(lv);
14619                     char * const origs = s;
14620
14621                     while (*s && *s != '\n')
14622                         s++;
14623
14624                     if (*s == '\n') {
14625                         const char * const t = ++s;
14626
14627                         if (byte_output) {
14628                             sv_catpvs(sv, " ");
14629                         }
14630
14631                         while (*s) {
14632                             if (*s == '\n') {
14633
14634                                 /* Truncate very long output */
14635                                 if (s - origs > 256) {
14636                                     Perl_sv_catpvf(aTHX_ sv,
14637                                                    "%.*s...",
14638                                                    (int) (s - origs - 1),
14639                                                    t);
14640                                     goto out_dump;
14641                                 }
14642                                 *s = ' ';
14643                             }
14644                             else if (*s == '\t') {
14645                                 *s = '-';
14646                             }
14647                             s++;
14648                         }
14649                         if (s[-1] == ' ')
14650                             s[-1] = 0;
14651
14652                         sv_catpv(sv, t);
14653                     }
14654
14655                 out_dump:
14656
14657                     Safefree(origs);
14658                 }
14659                 SvREFCNT_dec_NN(lv);
14660             }
14661         }
14662
14663         Perl_sv_catpvf(aTHX_ sv, "%s]", PL_colors[1]);
14664     }
14665     else if (k == POSIXD || k == NPOSIXD) {
14666         U8 index = FLAGS(o) * 2;
14667         if (index > (sizeof(anyofs) / sizeof(anyofs[0]))) {
14668             Perl_sv_catpvf(aTHX_ sv, "[illegal type=%d])", index);
14669         }
14670         else {
14671             sv_catpv(sv, anyofs[index]);
14672         }
14673     }
14674     else if (k == BRANCHJ && (OP(o) == UNLESSM || OP(o) == IFMATCH))
14675         Perl_sv_catpvf(aTHX_ sv, "[%d]", -(o->flags));
14676 #else
14677     PERL_UNUSED_CONTEXT;
14678     PERL_UNUSED_ARG(sv);
14679     PERL_UNUSED_ARG(o);
14680     PERL_UNUSED_ARG(prog);
14681 #endif  /* DEBUGGING */
14682 }
14683
14684 SV *
14685 Perl_re_intuit_string(pTHX_ REGEXP * const r)
14686 {                               /* Assume that RE_INTUIT is set */
14687     dVAR;
14688     struct regexp *const prog = ReANY(r);
14689     GET_RE_DEBUG_FLAGS_DECL;
14690
14691     PERL_ARGS_ASSERT_RE_INTUIT_STRING;
14692     PERL_UNUSED_CONTEXT;
14693
14694     DEBUG_COMPILE_r(
14695         {
14696             const char * const s = SvPV_nolen_const(prog->check_substr
14697                       ? prog->check_substr : prog->check_utf8);
14698
14699             if (!PL_colorset) reginitcolors();
14700             PerlIO_printf(Perl_debug_log,
14701                       "%sUsing REx %ssubstr:%s \"%s%.60s%s%s\"\n",
14702                       PL_colors[4],
14703                       prog->check_substr ? "" : "utf8 ",
14704                       PL_colors[5],PL_colors[0],
14705                       s,
14706                       PL_colors[1],
14707                       (strlen(s) > 60 ? "..." : ""));
14708         } );
14709
14710     return prog->check_substr ? prog->check_substr : prog->check_utf8;
14711 }
14712
14713 /* 
14714    pregfree() 
14715    
14716    handles refcounting and freeing the perl core regexp structure. When 
14717    it is necessary to actually free the structure the first thing it 
14718    does is call the 'free' method of the regexp_engine associated to
14719    the regexp, allowing the handling of the void *pprivate; member 
14720    first. (This routine is not overridable by extensions, which is why 
14721    the extensions free is called first.)
14722    
14723    See regdupe and regdupe_internal if you change anything here. 
14724 */
14725 #ifndef PERL_IN_XSUB_RE
14726 void
14727 Perl_pregfree(pTHX_ REGEXP *r)
14728 {
14729     SvREFCNT_dec(r);
14730 }
14731
14732 void
14733 Perl_pregfree2(pTHX_ REGEXP *rx)
14734 {
14735     dVAR;
14736     struct regexp *const r = ReANY(rx);
14737     GET_RE_DEBUG_FLAGS_DECL;
14738
14739     PERL_ARGS_ASSERT_PREGFREE2;
14740
14741     if (r->mother_re) {
14742         ReREFCNT_dec(r->mother_re);
14743     } else {
14744         CALLREGFREE_PVT(rx); /* free the private data */
14745         SvREFCNT_dec(RXp_PAREN_NAMES(r));
14746         Safefree(r->xpv_len_u.xpvlenu_pv);
14747     }        
14748     if (r->substrs) {
14749         SvREFCNT_dec(r->anchored_substr);
14750         SvREFCNT_dec(r->anchored_utf8);
14751         SvREFCNT_dec(r->float_substr);
14752         SvREFCNT_dec(r->float_utf8);
14753         Safefree(r->substrs);
14754     }
14755     RX_MATCH_COPY_FREE(rx);
14756 #ifdef PERL_ANY_COW
14757     SvREFCNT_dec(r->saved_copy);
14758 #endif
14759     Safefree(r->offs);
14760     SvREFCNT_dec(r->qr_anoncv);
14761     rx->sv_u.svu_rx = 0;
14762 }
14763
14764 /*  reg_temp_copy()
14765     
14766     This is a hacky workaround to the structural issue of match results
14767     being stored in the regexp structure which is in turn stored in
14768     PL_curpm/PL_reg_curpm. The problem is that due to qr// the pattern
14769     could be PL_curpm in multiple contexts, and could require multiple
14770     result sets being associated with the pattern simultaneously, such
14771     as when doing a recursive match with (??{$qr})
14772     
14773     The solution is to make a lightweight copy of the regexp structure 
14774     when a qr// is returned from the code executed by (??{$qr}) this
14775     lightweight copy doesn't actually own any of its data except for
14776     the starp/end and the actual regexp structure itself. 
14777     
14778 */    
14779     
14780     
14781 REGEXP *
14782 Perl_reg_temp_copy (pTHX_ REGEXP *ret_x, REGEXP *rx)
14783 {
14784     struct regexp *ret;
14785     struct regexp *const r = ReANY(rx);
14786     const bool islv = ret_x && SvTYPE(ret_x) == SVt_PVLV;
14787
14788     PERL_ARGS_ASSERT_REG_TEMP_COPY;
14789
14790     if (!ret_x)
14791         ret_x = (REGEXP*) newSV_type(SVt_REGEXP);
14792     else {
14793         SvOK_off((SV *)ret_x);
14794         if (islv) {
14795             /* For PVLVs, SvANY points to the xpvlv body while sv_u points
14796                to the regexp.  (For SVt_REGEXPs, sv_upgrade has already
14797                made both spots point to the same regexp body.) */
14798             REGEXP *temp = (REGEXP *)newSV_type(SVt_REGEXP);
14799             assert(!SvPVX(ret_x));
14800             ret_x->sv_u.svu_rx = temp->sv_any;
14801             temp->sv_any = NULL;
14802             SvFLAGS(temp) = (SvFLAGS(temp) & ~SVTYPEMASK) | SVt_NULL;
14803             SvREFCNT_dec_NN(temp);
14804             /* SvCUR still resides in the xpvlv struct, so the regexp copy-
14805                ing below will not set it. */
14806             SvCUR_set(ret_x, SvCUR(rx));
14807         }
14808     }
14809     /* This ensures that SvTHINKFIRST(sv) is true, and hence that
14810        sv_force_normal(sv) is called.  */
14811     SvFAKE_on(ret_x);
14812     ret = ReANY(ret_x);
14813     
14814     SvFLAGS(ret_x) |= SvUTF8(rx);
14815     /* We share the same string buffer as the original regexp, on which we
14816        hold a reference count, incremented when mother_re is set below.
14817        The string pointer is copied here, being part of the regexp struct.
14818      */
14819     memcpy(&(ret->xpv_cur), &(r->xpv_cur),
14820            sizeof(regexp) - STRUCT_OFFSET(regexp, xpv_cur));
14821     if (r->offs) {
14822         const I32 npar = r->nparens+1;
14823         Newx(ret->offs, npar, regexp_paren_pair);
14824         Copy(r->offs, ret->offs, npar, regexp_paren_pair);
14825     }
14826     if (r->substrs) {
14827         Newx(ret->substrs, 1, struct reg_substr_data);
14828         StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
14829
14830         SvREFCNT_inc_void(ret->anchored_substr);
14831         SvREFCNT_inc_void(ret->anchored_utf8);
14832         SvREFCNT_inc_void(ret->float_substr);
14833         SvREFCNT_inc_void(ret->float_utf8);
14834
14835         /* check_substr and check_utf8, if non-NULL, point to either their
14836            anchored or float namesakes, and don't hold a second reference.  */
14837     }
14838     RX_MATCH_COPIED_off(ret_x);
14839 #ifdef PERL_ANY_COW
14840     ret->saved_copy = NULL;
14841 #endif
14842     ret->mother_re = ReREFCNT_inc(r->mother_re ? r->mother_re : rx);
14843     SvREFCNT_inc_void(ret->qr_anoncv);
14844     
14845     return ret_x;
14846 }
14847 #endif
14848
14849 /* regfree_internal() 
14850
14851    Free the private data in a regexp. This is overloadable by 
14852    extensions. Perl takes care of the regexp structure in pregfree(), 
14853    this covers the *pprivate pointer which technically perl doesn't 
14854    know about, however of course we have to handle the 
14855    regexp_internal structure when no extension is in use. 
14856    
14857    Note this is called before freeing anything in the regexp 
14858    structure. 
14859  */
14860  
14861 void
14862 Perl_regfree_internal(pTHX_ REGEXP * const rx)
14863 {
14864     dVAR;
14865     struct regexp *const r = ReANY(rx);
14866     RXi_GET_DECL(r,ri);
14867     GET_RE_DEBUG_FLAGS_DECL;
14868
14869     PERL_ARGS_ASSERT_REGFREE_INTERNAL;
14870
14871     DEBUG_COMPILE_r({
14872         if (!PL_colorset)
14873             reginitcolors();
14874         {
14875             SV *dsv= sv_newmortal();
14876             RE_PV_QUOTED_DECL(s, RX_UTF8(rx),
14877                 dsv, RX_PRECOMP(rx), RX_PRELEN(rx), 60);
14878             PerlIO_printf(Perl_debug_log,"%sFreeing REx:%s %s\n", 
14879                 PL_colors[4],PL_colors[5],s);
14880         }
14881     });
14882 #ifdef RE_TRACK_PATTERN_OFFSETS
14883     if (ri->u.offsets)
14884         Safefree(ri->u.offsets);             /* 20010421 MJD */
14885 #endif
14886     if (ri->code_blocks) {
14887         int n;
14888         for (n = 0; n < ri->num_code_blocks; n++)
14889             SvREFCNT_dec(ri->code_blocks[n].src_regex);
14890         Safefree(ri->code_blocks);
14891     }
14892
14893     if (ri->data) {
14894         int n = ri->data->count;
14895
14896         while (--n >= 0) {
14897           /* If you add a ->what type here, update the comment in regcomp.h */
14898             switch (ri->data->what[n]) {
14899             case 'a':
14900             case 'r':
14901             case 's':
14902             case 'S':
14903             case 'u':
14904                 SvREFCNT_dec(MUTABLE_SV(ri->data->data[n]));
14905                 break;
14906             case 'f':
14907                 Safefree(ri->data->data[n]);
14908                 break;
14909             case 'l':
14910             case 'L':
14911                 break;
14912             case 'T':           
14913                 { /* Aho Corasick add-on structure for a trie node.
14914                      Used in stclass optimization only */
14915                     U32 refcount;
14916                     reg_ac_data *aho=(reg_ac_data*)ri->data->data[n];
14917                     OP_REFCNT_LOCK;
14918                     refcount = --aho->refcount;
14919                     OP_REFCNT_UNLOCK;
14920                     if ( !refcount ) {
14921                         PerlMemShared_free(aho->states);
14922                         PerlMemShared_free(aho->fail);
14923                          /* do this last!!!! */
14924                         PerlMemShared_free(ri->data->data[n]);
14925                         PerlMemShared_free(ri->regstclass);
14926                     }
14927                 }
14928                 break;
14929             case 't':
14930                 {
14931                     /* trie structure. */
14932                     U32 refcount;
14933                     reg_trie_data *trie=(reg_trie_data*)ri->data->data[n];
14934                     OP_REFCNT_LOCK;
14935                     refcount = --trie->refcount;
14936                     OP_REFCNT_UNLOCK;
14937                     if ( !refcount ) {
14938                         PerlMemShared_free(trie->charmap);
14939                         PerlMemShared_free(trie->states);
14940                         PerlMemShared_free(trie->trans);
14941                         if (trie->bitmap)
14942                             PerlMemShared_free(trie->bitmap);
14943                         if (trie->jump)
14944                             PerlMemShared_free(trie->jump);
14945                         PerlMemShared_free(trie->wordinfo);
14946                         /* do this last!!!! */
14947                         PerlMemShared_free(ri->data->data[n]);
14948                     }
14949                 }
14950                 break;
14951             default:
14952                 Perl_croak(aTHX_ "panic: regfree data code '%c'", ri->data->what[n]);
14953             }
14954         }
14955         Safefree(ri->data->what);
14956         Safefree(ri->data);
14957     }
14958
14959     Safefree(ri);
14960 }
14961
14962 #define av_dup_inc(s,t) MUTABLE_AV(sv_dup_inc((const SV *)s,t))
14963 #define hv_dup_inc(s,t) MUTABLE_HV(sv_dup_inc((const SV *)s,t))
14964 #define SAVEPVN(p,n)    ((p) ? savepvn(p,n) : NULL)
14965
14966 /* 
14967    re_dup - duplicate a regexp. 
14968    
14969    This routine is expected to clone a given regexp structure. It is only
14970    compiled under USE_ITHREADS.
14971
14972    After all of the core data stored in struct regexp is duplicated
14973    the regexp_engine.dupe method is used to copy any private data
14974    stored in the *pprivate pointer. This allows extensions to handle
14975    any duplication it needs to do.
14976
14977    See pregfree() and regfree_internal() if you change anything here. 
14978 */
14979 #if defined(USE_ITHREADS)
14980 #ifndef PERL_IN_XSUB_RE
14981 void
14982 Perl_re_dup_guts(pTHX_ const REGEXP *sstr, REGEXP *dstr, CLONE_PARAMS *param)
14983 {
14984     dVAR;
14985     I32 npar;
14986     const struct regexp *r = ReANY(sstr);
14987     struct regexp *ret = ReANY(dstr);
14988     
14989     PERL_ARGS_ASSERT_RE_DUP_GUTS;
14990
14991     npar = r->nparens+1;
14992     Newx(ret->offs, npar, regexp_paren_pair);
14993     Copy(r->offs, ret->offs, npar, regexp_paren_pair);
14994
14995     if (ret->substrs) {
14996         /* Do it this way to avoid reading from *r after the StructCopy().
14997            That way, if any of the sv_dup_inc()s dislodge *r from the L1
14998            cache, it doesn't matter.  */
14999         const bool anchored = r->check_substr
15000             ? r->check_substr == r->anchored_substr
15001             : r->check_utf8 == r->anchored_utf8;
15002         Newx(ret->substrs, 1, struct reg_substr_data);
15003         StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
15004
15005         ret->anchored_substr = sv_dup_inc(ret->anchored_substr, param);
15006         ret->anchored_utf8 = sv_dup_inc(ret->anchored_utf8, param);
15007         ret->float_substr = sv_dup_inc(ret->float_substr, param);
15008         ret->float_utf8 = sv_dup_inc(ret->float_utf8, param);
15009
15010         /* check_substr and check_utf8, if non-NULL, point to either their
15011            anchored or float namesakes, and don't hold a second reference.  */
15012
15013         if (ret->check_substr) {
15014             if (anchored) {
15015                 assert(r->check_utf8 == r->anchored_utf8);
15016                 ret->check_substr = ret->anchored_substr;
15017                 ret->check_utf8 = ret->anchored_utf8;
15018             } else {
15019                 assert(r->check_substr == r->float_substr);
15020                 assert(r->check_utf8 == r->float_utf8);
15021                 ret->check_substr = ret->float_substr;
15022                 ret->check_utf8 = ret->float_utf8;
15023             }
15024         } else if (ret->check_utf8) {
15025             if (anchored) {
15026                 ret->check_utf8 = ret->anchored_utf8;
15027             } else {
15028                 ret->check_utf8 = ret->float_utf8;
15029             }
15030         }
15031     }
15032
15033     RXp_PAREN_NAMES(ret) = hv_dup_inc(RXp_PAREN_NAMES(ret), param);
15034     ret->qr_anoncv = MUTABLE_CV(sv_dup_inc((const SV *)ret->qr_anoncv, param));
15035
15036     if (ret->pprivate)
15037         RXi_SET(ret,CALLREGDUPE_PVT(dstr,param));
15038
15039     if (RX_MATCH_COPIED(dstr))
15040         ret->subbeg  = SAVEPVN(ret->subbeg, ret->sublen);
15041     else
15042         ret->subbeg = NULL;
15043 #ifdef PERL_ANY_COW
15044     ret->saved_copy = NULL;
15045 #endif
15046
15047     /* Whether mother_re be set or no, we need to copy the string.  We
15048        cannot refrain from copying it when the storage points directly to
15049        our mother regexp, because that's
15050                1: a buffer in a different thread
15051                2: something we no longer hold a reference on
15052                so we need to copy it locally.  */
15053     RX_WRAPPED(dstr) = SAVEPVN(RX_WRAPPED(sstr), SvCUR(sstr)+1);
15054     ret->mother_re   = NULL;
15055     ret->gofs = 0;
15056 }
15057 #endif /* PERL_IN_XSUB_RE */
15058
15059 /*
15060    regdupe_internal()
15061    
15062    This is the internal complement to regdupe() which is used to copy
15063    the structure pointed to by the *pprivate pointer in the regexp.
15064    This is the core version of the extension overridable cloning hook.
15065    The regexp structure being duplicated will be copied by perl prior
15066    to this and will be provided as the regexp *r argument, however 
15067    with the /old/ structures pprivate pointer value. Thus this routine
15068    may override any copying normally done by perl.
15069    
15070    It returns a pointer to the new regexp_internal structure.
15071 */
15072
15073 void *
15074 Perl_regdupe_internal(pTHX_ REGEXP * const rx, CLONE_PARAMS *param)
15075 {
15076     dVAR;
15077     struct regexp *const r = ReANY(rx);
15078     regexp_internal *reti;
15079     int len;
15080     RXi_GET_DECL(r,ri);
15081
15082     PERL_ARGS_ASSERT_REGDUPE_INTERNAL;
15083     
15084     len = ProgLen(ri);
15085     
15086     Newxc(reti, sizeof(regexp_internal) + len*sizeof(regnode), char, regexp_internal);
15087     Copy(ri->program, reti->program, len+1, regnode);
15088
15089     reti->num_code_blocks = ri->num_code_blocks;
15090     if (ri->code_blocks) {
15091         int n;
15092         Newxc(reti->code_blocks, ri->num_code_blocks, struct reg_code_block,
15093                 struct reg_code_block);
15094         Copy(ri->code_blocks, reti->code_blocks, ri->num_code_blocks,
15095                 struct reg_code_block);
15096         for (n = 0; n < ri->num_code_blocks; n++)
15097              reti->code_blocks[n].src_regex = (REGEXP*)
15098                     sv_dup_inc((SV*)(ri->code_blocks[n].src_regex), param);
15099     }
15100     else
15101         reti->code_blocks = NULL;
15102
15103     reti->regstclass = NULL;
15104
15105     if (ri->data) {
15106         struct reg_data *d;
15107         const int count = ri->data->count;
15108         int i;
15109
15110         Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
15111                 char, struct reg_data);
15112         Newx(d->what, count, U8);
15113
15114         d->count = count;
15115         for (i = 0; i < count; i++) {
15116             d->what[i] = ri->data->what[i];
15117             switch (d->what[i]) {
15118                 /* see also regcomp.h and regfree_internal() */
15119             case 'a': /* actually an AV, but the dup function is identical.  */
15120             case 'r':
15121             case 's':
15122             case 'S':
15123             case 'u': /* actually an HV, but the dup function is identical.  */
15124                 d->data[i] = sv_dup_inc((const SV *)ri->data->data[i], param);
15125                 break;
15126             case 'f':
15127                 /* This is cheating. */
15128                 Newx(d->data[i], 1, struct regnode_charclass_class);
15129                 StructCopy(ri->data->data[i], d->data[i],
15130                             struct regnode_charclass_class);
15131                 reti->regstclass = (regnode*)d->data[i];
15132                 break;
15133             case 'T':
15134                 /* Trie stclasses are readonly and can thus be shared
15135                  * without duplication. We free the stclass in pregfree
15136                  * when the corresponding reg_ac_data struct is freed.
15137                  */
15138                 reti->regstclass= ri->regstclass;
15139                 /* Fall through */
15140             case 't':
15141                 OP_REFCNT_LOCK;
15142                 ((reg_trie_data*)ri->data->data[i])->refcount++;
15143                 OP_REFCNT_UNLOCK;
15144                 /* Fall through */
15145             case 'l':
15146             case 'L':
15147                 d->data[i] = ri->data->data[i];
15148                 break;
15149             default:
15150                 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", ri->data->what[i]);
15151             }
15152         }
15153
15154         reti->data = d;
15155     }
15156     else
15157         reti->data = NULL;
15158
15159     reti->name_list_idx = ri->name_list_idx;
15160
15161 #ifdef RE_TRACK_PATTERN_OFFSETS
15162     if (ri->u.offsets) {
15163         Newx(reti->u.offsets, 2*len+1, U32);
15164         Copy(ri->u.offsets, reti->u.offsets, 2*len+1, U32);
15165     }
15166 #else
15167     SetProgLen(reti,len);
15168 #endif
15169
15170     return (void*)reti;
15171 }
15172
15173 #endif    /* USE_ITHREADS */
15174
15175 #ifndef PERL_IN_XSUB_RE
15176
15177 /*
15178  - regnext - dig the "next" pointer out of a node
15179  */
15180 regnode *
15181 Perl_regnext(pTHX_ regnode *p)
15182 {
15183     dVAR;
15184     I32 offset;
15185
15186     if (!p)
15187         return(NULL);
15188
15189     if (OP(p) > REGNODE_MAX) {          /* regnode.type is unsigned */
15190         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d", (int)OP(p), (int)REGNODE_MAX);
15191     }
15192
15193     offset = (reg_off_by_arg[OP(p)] ? ARG(p) : NEXT_OFF(p));
15194     if (offset == 0)
15195         return(NULL);
15196
15197     return(p+offset);
15198 }
15199 #endif
15200
15201 STATIC void
15202 S_re_croak2(pTHX_ const char* pat1,const char* pat2,...)
15203 {
15204     va_list args;
15205     STRLEN l1 = strlen(pat1);
15206     STRLEN l2 = strlen(pat2);
15207     char buf[512];
15208     SV *msv;
15209     const char *message;
15210
15211     PERL_ARGS_ASSERT_RE_CROAK2;
15212
15213     if (l1 > 510)
15214         l1 = 510;
15215     if (l1 + l2 > 510)
15216         l2 = 510 - l1;
15217     Copy(pat1, buf, l1 , char);
15218     Copy(pat2, buf + l1, l2 , char);
15219     buf[l1 + l2] = '\n';
15220     buf[l1 + l2 + 1] = '\0';
15221 #ifdef I_STDARG
15222     /* ANSI variant takes additional second argument */
15223     va_start(args, pat2);
15224 #else
15225     va_start(args);
15226 #endif
15227     msv = vmess(buf, &args);
15228     va_end(args);
15229     message = SvPV_const(msv,l1);
15230     if (l1 > 512)
15231         l1 = 512;
15232     Copy(message, buf, l1 , char);
15233     buf[l1-1] = '\0';                   /* Overwrite \n */
15234     Perl_croak(aTHX_ "%s", buf);
15235 }
15236
15237 /* XXX Here's a total kludge.  But we need to re-enter for swash routines. */
15238
15239 #ifndef PERL_IN_XSUB_RE
15240 void
15241 Perl_save_re_context(pTHX)
15242 {
15243     dVAR;
15244
15245     struct re_save_state *state;
15246
15247     SAVEVPTR(PL_curcop);
15248     SSGROW(SAVESTACK_ALLOC_FOR_RE_SAVE_STATE + 1);
15249
15250     state = (struct re_save_state *)(PL_savestack + PL_savestack_ix);
15251     PL_savestack_ix += SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
15252     SSPUSHUV(SAVEt_RE_STATE);
15253
15254     Copy(&PL_reg_state, state, 1, struct re_save_state);
15255
15256     PL_reg_oldsaved = NULL;
15257     PL_reg_oldsavedlen = 0;
15258     PL_reg_oldsavedoffset = 0;
15259     PL_reg_oldsavedcoffset = 0;
15260     PL_reg_maxiter = 0;
15261     PL_reg_leftiter = 0;
15262     PL_reg_poscache = NULL;
15263     PL_reg_poscache_size = 0;
15264 #ifdef PERL_ANY_COW
15265     PL_nrs = NULL;
15266 #endif
15267
15268     /* Save $1..$n (#18107: UTF-8 s/(\w+)/uc($1)/e); AMS 20021106. */
15269     if (PL_curpm) {
15270         const REGEXP * const rx = PM_GETRE(PL_curpm);
15271         if (rx) {
15272             U32 i;
15273             for (i = 1; i <= RX_NPARENS(rx); i++) {
15274                 char digits[TYPE_CHARS(long)];
15275                 const STRLEN len = my_snprintf(digits, sizeof(digits), "%lu", (long)i);
15276                 GV *const *const gvp
15277                     = (GV**)hv_fetch(PL_defstash, digits, len, 0);
15278
15279                 if (gvp) {
15280                     GV * const gv = *gvp;
15281                     if (SvTYPE(gv) == SVt_PVGV && GvSV(gv))
15282                         save_scalar(gv);
15283                 }
15284             }
15285         }
15286     }
15287 }
15288 #endif
15289
15290 #ifdef DEBUGGING
15291
15292 STATIC void
15293 S_put_byte(pTHX_ SV *sv, int c)
15294 {
15295     PERL_ARGS_ASSERT_PUT_BYTE;
15296
15297     /* Our definition of isPRINT() ignores locales, so only bytes that are
15298        not part of UTF-8 are considered printable. I assume that the same
15299        holds for UTF-EBCDIC.
15300        Also, code point 255 is not printable in either (it's E0 in EBCDIC,
15301        which Wikipedia says:
15302
15303        EO, or Eight Ones, is an 8-bit EBCDIC character code represented as all
15304        ones (binary 1111 1111, hexadecimal FF). It is similar, but not
15305        identical, to the ASCII delete (DEL) or rubout control character.
15306        ) So the old condition can be simplified to !isPRINT(c)  */
15307     if (!isPRINT(c)) {
15308         if (c < 256) {
15309             Perl_sv_catpvf(aTHX_ sv, "\\x%02x", c);
15310         }
15311         else {
15312             Perl_sv_catpvf(aTHX_ sv, "\\x{%x}", c);
15313         }
15314     }
15315     else {
15316         const char string = c;
15317         if (c == '-' || c == ']' || c == '\\' || c == '^')
15318             sv_catpvs(sv, "\\");
15319         sv_catpvn(sv, &string, 1);
15320     }
15321 }
15322
15323
15324 #define CLEAR_OPTSTART \
15325     if (optstart) STMT_START { \
15326             DEBUG_OPTIMISE_r(PerlIO_printf(Perl_debug_log, " (%"IVdf" nodes)\n", (IV)(node - optstart))); \
15327             optstart=NULL; \
15328     } STMT_END
15329
15330 #define DUMPUNTIL(b,e) CLEAR_OPTSTART; node=dumpuntil(r,start,(b),(e),last,sv,indent+1,depth+1);
15331
15332 STATIC const regnode *
15333 S_dumpuntil(pTHX_ const regexp *r, const regnode *start, const regnode *node,
15334             const regnode *last, const regnode *plast, 
15335             SV* sv, I32 indent, U32 depth)
15336 {
15337     dVAR;
15338     U8 op = PSEUDO;     /* Arbitrary non-END op. */
15339     const regnode *next;
15340     const regnode *optstart= NULL;
15341     
15342     RXi_GET_DECL(r,ri);
15343     GET_RE_DEBUG_FLAGS_DECL;
15344
15345     PERL_ARGS_ASSERT_DUMPUNTIL;
15346
15347 #ifdef DEBUG_DUMPUNTIL
15348     PerlIO_printf(Perl_debug_log, "--- %d : %d - %d - %d\n",indent,node-start,
15349         last ? last-start : 0,plast ? plast-start : 0);
15350 #endif
15351             
15352     if (plast && plast < last) 
15353         last= plast;
15354
15355     while (PL_regkind[op] != END && (!last || node < last)) {
15356         /* While that wasn't END last time... */
15357         NODE_ALIGN(node);
15358         op = OP(node);
15359         if (op == CLOSE || op == WHILEM)
15360             indent--;
15361         next = regnext((regnode *)node);
15362
15363         /* Where, what. */
15364         if (OP(node) == OPTIMIZED) {
15365             if (!optstart && RE_DEBUG_FLAG(RE_DEBUG_COMPILE_OPTIMISE))
15366                 optstart = node;
15367             else
15368                 goto after_print;
15369         } else
15370             CLEAR_OPTSTART;
15371
15372         regprop(r, sv, node);
15373         PerlIO_printf(Perl_debug_log, "%4"IVdf":%*s%s", (IV)(node - start),
15374                       (int)(2*indent + 1), "", SvPVX_const(sv));
15375         
15376         if (OP(node) != OPTIMIZED) {                  
15377             if (next == NULL)           /* Next ptr. */
15378                 PerlIO_printf(Perl_debug_log, " (0)");
15379             else if (PL_regkind[(U8)op] == BRANCH && PL_regkind[OP(next)] != BRANCH )
15380                 PerlIO_printf(Perl_debug_log, " (FAIL)");
15381             else 
15382                 PerlIO_printf(Perl_debug_log, " (%"IVdf")", (IV)(next - start));
15383             (void)PerlIO_putc(Perl_debug_log, '\n'); 
15384         }
15385         
15386       after_print:
15387         if (PL_regkind[(U8)op] == BRANCHJ) {
15388             assert(next);
15389             {
15390                 const regnode *nnode = (OP(next) == LONGJMP
15391                                        ? regnext((regnode *)next)
15392                                        : next);
15393                 if (last && nnode > last)
15394                     nnode = last;
15395                 DUMPUNTIL(NEXTOPER(NEXTOPER(node)), nnode);
15396             }
15397         }
15398         else if (PL_regkind[(U8)op] == BRANCH) {
15399             assert(next);
15400             DUMPUNTIL(NEXTOPER(node), next);
15401         }
15402         else if ( PL_regkind[(U8)op]  == TRIE ) {
15403             const regnode *this_trie = node;
15404             const char op = OP(node);
15405             const U32 n = ARG(node);
15406             const reg_ac_data * const ac = op>=AHOCORASICK ?
15407                (reg_ac_data *)ri->data->data[n] :
15408                NULL;
15409             const reg_trie_data * const trie =
15410                 (reg_trie_data*)ri->data->data[op<AHOCORASICK ? n : ac->trie];
15411 #ifdef DEBUGGING
15412             AV *const trie_words = MUTABLE_AV(ri->data->data[n + TRIE_WORDS_OFFSET]);
15413 #endif
15414             const regnode *nextbranch= NULL;
15415             I32 word_idx;
15416             sv_setpvs(sv, "");
15417             for (word_idx= 0; word_idx < (I32)trie->wordcount; word_idx++) {
15418                 SV ** const elem_ptr = av_fetch(trie_words,word_idx,0);
15419
15420                 PerlIO_printf(Perl_debug_log, "%*s%s ",
15421                    (int)(2*(indent+3)), "",
15422                     elem_ptr ? pv_pretty(sv, SvPV_nolen_const(*elem_ptr), SvCUR(*elem_ptr), 60,
15423                             PL_colors[0], PL_colors[1],
15424                             (SvUTF8(*elem_ptr) ? PERL_PV_ESCAPE_UNI : 0) |
15425                             PERL_PV_PRETTY_ELLIPSES    |
15426                             PERL_PV_PRETTY_LTGT
15427                             )
15428                             : "???"
15429                 );
15430                 if (trie->jump) {
15431                     U16 dist= trie->jump[word_idx+1];
15432                     PerlIO_printf(Perl_debug_log, "(%"UVuf")\n",
15433                                   (UV)((dist ? this_trie + dist : next) - start));
15434                     if (dist) {
15435                         if (!nextbranch)
15436                             nextbranch= this_trie + trie->jump[0];    
15437                         DUMPUNTIL(this_trie + dist, nextbranch);
15438                     }
15439                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
15440                         nextbranch= regnext((regnode *)nextbranch);
15441                 } else {
15442                     PerlIO_printf(Perl_debug_log, "\n");
15443                 }
15444             }
15445             if (last && next > last)
15446                 node= last;
15447             else
15448                 node= next;
15449         }
15450         else if ( op == CURLY ) {   /* "next" might be very big: optimizer */
15451             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS,
15452                     NEXTOPER(node) + EXTRA_STEP_2ARGS + 1);
15453         }
15454         else if (PL_regkind[(U8)op] == CURLY && op != CURLYX) {
15455             assert(next);
15456             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS, next);
15457         }
15458         else if ( op == PLUS || op == STAR) {
15459             DUMPUNTIL(NEXTOPER(node), NEXTOPER(node) + 1);
15460         }
15461         else if (PL_regkind[(U8)op] == ANYOF) {
15462             /* arglen 1 + class block */
15463             node += 1 + ((ANYOF_FLAGS(node) & ANYOF_CLASS)
15464                     ? ANYOF_CLASS_SKIP : ANYOF_SKIP);
15465             node = NEXTOPER(node);
15466         }
15467         else if (PL_regkind[(U8)op] == EXACT) {
15468             /* Literal string, where present. */
15469             node += NODE_SZ_STR(node) - 1;
15470             node = NEXTOPER(node);
15471         }
15472         else {
15473             node = NEXTOPER(node);
15474             node += regarglen[(U8)op];
15475         }
15476         if (op == CURLYX || op == OPEN)
15477             indent++;
15478     }
15479     CLEAR_OPTSTART;
15480 #ifdef DEBUG_DUMPUNTIL    
15481     PerlIO_printf(Perl_debug_log, "--- %d\n", (int)indent);
15482 #endif
15483     return node;
15484 }
15485
15486 #endif  /* DEBUGGING */
15487
15488 /*
15489  * Local variables:
15490  * c-indentation-style: bsd
15491  * c-basic-offset: 4
15492  * indent-tabs-mode: nil
15493  * End:
15494  *
15495  * ex: set ts=8 sts=4 sw=4 et:
15496  */