4719d12c75af48227f4b8eeb55aaadcc3c0744da
[platform/upstream/perl.git] / regcomp.c
1 /*    regcomp.c
2  */
3
4 /*
5  * 'A fair jaw-cracker dwarf-language must be.'            --Samwise Gamgee
6  *
7  *     [p.285 of _The Lord of the Rings_, II/iii: "The Ring Goes South"]
8  */
9
10 /* This file contains functions for compiling a regular expression.  See
11  * also regexec.c which funnily enough, contains functions for executing
12  * a regular expression.
13  *
14  * This file is also copied at build time to ext/re/re_comp.c, where
15  * it's built with -DPERL_EXT_RE_BUILD -DPERL_EXT_RE_DEBUG -DPERL_EXT.
16  * This causes the main functions to be compiled under new names and with
17  * debugging support added, which makes "use re 'debug'" work.
18  */
19
20 /* NOTE: this is derived from Henry Spencer's regexp code, and should not
21  * confused with the original package (see point 3 below).  Thanks, Henry!
22  */
23
24 /* Additional note: this code is very heavily munged from Henry's version
25  * in places.  In some spots I've traded clarity for efficiency, so don't
26  * blame Henry for some of the lack of readability.
27  */
28
29 /* The names of the functions have been changed from regcomp and
30  * regexec to pregcomp and pregexec in order to avoid conflicts
31  * with the POSIX routines of the same names.
32 */
33
34 #ifdef PERL_EXT_RE_BUILD
35 #include "re_top.h"
36 #endif
37
38 /*
39  * pregcomp and pregexec -- regsub and regerror are not used in perl
40  *
41  *      Copyright (c) 1986 by University of Toronto.
42  *      Written by Henry Spencer.  Not derived from licensed software.
43  *
44  *      Permission is granted to anyone to use this software for any
45  *      purpose on any computer system, and to redistribute it freely,
46  *      subject to the following restrictions:
47  *
48  *      1. The author is not responsible for the consequences of use of
49  *              this software, no matter how awful, even if they arise
50  *              from defects in it.
51  *
52  *      2. The origin of this software must not be misrepresented, either
53  *              by explicit claim or by omission.
54  *
55  *      3. Altered versions must be plainly marked as such, and must not
56  *              be misrepresented as being the original software.
57  *
58  *
59  ****    Alterations to Henry's code are...
60  ****
61  ****    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
62  ****    2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
63  ****    by Larry Wall and others
64  ****
65  ****    You may distribute under the terms of either the GNU General Public
66  ****    License or the Artistic License, as specified in the README file.
67
68  *
69  * Beware that some of this code is subtly aware of the way operator
70  * precedence is structured in regular expressions.  Serious changes in
71  * regular-expression syntax might require a total rethink.
72  */
73 #include "EXTERN.h"
74 #define PERL_IN_REGCOMP_C
75 #include "perl.h"
76
77 #ifndef PERL_IN_XSUB_RE
78 #  include "INTERN.h"
79 #endif
80
81 #define REG_COMP_C
82 #ifdef PERL_IN_XSUB_RE
83 #  include "re_comp.h"
84 EXTERN_C const struct regexp_engine my_reg_engine;
85 #else
86 #  include "regcomp.h"
87 #endif
88
89 #include "dquote_inline.h"
90 #include "invlist_inline.h"
91 #include "unicode_constants.h"
92
93 #define HAS_NONLATIN1_FOLD_CLOSURE(i) \
94  _HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(i)
95 #define HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(i) \
96  _HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(i)
97 #define IS_NON_FINAL_FOLD(c) _IS_NON_FINAL_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c)
98 #define IS_IN_SOME_FOLD_L1(c) _IS_IN_SOME_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c)
99
100 #ifndef STATIC
101 #define STATIC  static
102 #endif
103
104 #ifndef MIN
105 #define MIN(a,b) ((a) < (b) ? (a) : (b))
106 #endif
107
108 /* this is a chain of data about sub patterns we are processing that
109    need to be handled separately/specially in study_chunk. Its so
110    we can simulate recursion without losing state.  */
111 struct scan_frame;
112 typedef struct scan_frame {
113     regnode *last_regnode;      /* last node to process in this frame */
114     regnode *next_regnode;      /* next node to process when last is reached */
115     U32 prev_recursed_depth;
116     I32 stopparen;              /* what stopparen do we use */
117     U32 is_top_frame;           /* what flags do we use? */
118
119     struct scan_frame *this_prev_frame; /* this previous frame */
120     struct scan_frame *prev_frame;      /* previous frame */
121     struct scan_frame *next_frame;      /* next frame */
122 } scan_frame;
123
124 /* Certain characters are output as a sequence with the first being a
125  * backslash. */
126 #define isBACKSLASHED_PUNCT(c)                                              \
127                     ((c) == '-' || (c) == ']' || (c) == '\\' || (c) == '^')
128
129
130 struct RExC_state_t {
131     U32         flags;                  /* RXf_* are we folding, multilining? */
132     U32         pm_flags;               /* PMf_* stuff from the calling PMOP */
133     char        *precomp;               /* uncompiled string. */
134     REGEXP      *rx_sv;                 /* The SV that is the regexp. */
135     regexp      *rx;                    /* perl core regexp structure */
136     regexp_internal     *rxi;           /* internal data for regexp object
137                                            pprivate field */
138     char        *start;                 /* Start of input for compile */
139     char        *end;                   /* End of input for compile */
140     char        *parse;                 /* Input-scan pointer. */
141     SSize_t     whilem_seen;            /* number of WHILEM in this expr */
142     regnode     *emit_start;            /* Start of emitted-code area */
143     regnode     *emit_bound;            /* First regnode outside of the
144                                            allocated space */
145     regnode     *emit;                  /* Code-emit pointer; if = &emit_dummy,
146                                            implies compiling, so don't emit */
147     regnode_ssc emit_dummy;             /* placeholder for emit to point to;
148                                            large enough for the largest
149                                            non-EXACTish node, so can use it as
150                                            scratch in pass1 */
151     I32         naughty;                /* How bad is this pattern? */
152     I32         sawback;                /* Did we see \1, ...? */
153     U32         seen;
154     SSize_t     size;                   /* Code size. */
155     I32                npar;            /* Capture buffer count, (OPEN) plus
156                                            one. ("par" 0 is the whole
157                                            pattern)*/
158     I32         nestroot;               /* root parens we are in - used by
159                                            accept */
160     I32         extralen;
161     I32         seen_zerolen;
162     regnode     **open_parens;          /* pointers to open parens */
163     regnode     **close_parens;         /* pointers to close parens */
164     regnode     *opend;                 /* END node in program */
165     I32         utf8;           /* whether the pattern is utf8 or not */
166     I32         orig_utf8;      /* whether the pattern was originally in utf8 */
167                                 /* XXX use this for future optimisation of case
168                                  * where pattern must be upgraded to utf8. */
169     I32         uni_semantics;  /* If a d charset modifier should use unicode
170                                    rules, even if the pattern is not in
171                                    utf8 */
172     HV          *paren_names;           /* Paren names */
173
174     regnode     **recurse;              /* Recurse regops */
175     I32         recurse_count;          /* Number of recurse regops */
176     U8          *study_chunk_recursed;  /* bitmap of which subs we have moved
177                                            through */
178     U32         study_chunk_recursed_bytes;  /* bytes in bitmap */
179     I32         in_lookbehind;
180     I32         contains_locale;
181     I32         contains_i;
182     I32         override_recoding;
183 #ifdef EBCDIC
184     I32         recode_x_to_native;
185 #endif
186     I32         in_multi_char_class;
187     struct reg_code_block *code_blocks; /* positions of literal (?{})
188                                             within pattern */
189     int         num_code_blocks;        /* size of code_blocks[] */
190     int         code_index;             /* next code_blocks[] slot */
191     SSize_t     maxlen;                        /* mininum possible number of chars in string to match */
192     scan_frame *frame_head;
193     scan_frame *frame_last;
194     U32         frame_count;
195     U32         strict;
196 #ifdef ADD_TO_REGEXEC
197     char        *starttry;              /* -Dr: where regtry was called. */
198 #define RExC_starttry   (pRExC_state->starttry)
199 #endif
200     SV          *runtime_code_qr;       /* qr with the runtime code blocks */
201 #ifdef DEBUGGING
202     const char  *lastparse;
203     I32         lastnum;
204     AV          *paren_name_list;       /* idx -> name */
205     U32         study_chunk_recursed_count;
206     SV          *mysv1;
207     SV          *mysv2;
208 #define RExC_lastparse  (pRExC_state->lastparse)
209 #define RExC_lastnum    (pRExC_state->lastnum)
210 #define RExC_paren_name_list    (pRExC_state->paren_name_list)
211 #define RExC_study_chunk_recursed_count    (pRExC_state->study_chunk_recursed_count)
212 #define RExC_mysv       (pRExC_state->mysv1)
213 #define RExC_mysv1      (pRExC_state->mysv1)
214 #define RExC_mysv2      (pRExC_state->mysv2)
215
216 #endif
217 };
218
219 #define RExC_flags      (pRExC_state->flags)
220 #define RExC_pm_flags   (pRExC_state->pm_flags)
221 #define RExC_precomp    (pRExC_state->precomp)
222 #define RExC_rx_sv      (pRExC_state->rx_sv)
223 #define RExC_rx         (pRExC_state->rx)
224 #define RExC_rxi        (pRExC_state->rxi)
225 #define RExC_start      (pRExC_state->start)
226 #define RExC_end        (pRExC_state->end)
227 #define RExC_parse      (pRExC_state->parse)
228 #define RExC_whilem_seen        (pRExC_state->whilem_seen)
229 #ifdef RE_TRACK_PATTERN_OFFSETS
230 #define RExC_offsets    (pRExC_state->rxi->u.offsets) /* I am not like the
231                                                          others */
232 #endif
233 #define RExC_emit       (pRExC_state->emit)
234 #define RExC_emit_dummy (pRExC_state->emit_dummy)
235 #define RExC_emit_start (pRExC_state->emit_start)
236 #define RExC_emit_bound (pRExC_state->emit_bound)
237 #define RExC_sawback    (pRExC_state->sawback)
238 #define RExC_seen       (pRExC_state->seen)
239 #define RExC_size       (pRExC_state->size)
240 #define RExC_maxlen        (pRExC_state->maxlen)
241 #define RExC_npar       (pRExC_state->npar)
242 #define RExC_nestroot   (pRExC_state->nestroot)
243 #define RExC_extralen   (pRExC_state->extralen)
244 #define RExC_seen_zerolen       (pRExC_state->seen_zerolen)
245 #define RExC_utf8       (pRExC_state->utf8)
246 #define RExC_uni_semantics      (pRExC_state->uni_semantics)
247 #define RExC_orig_utf8  (pRExC_state->orig_utf8)
248 #define RExC_open_parens        (pRExC_state->open_parens)
249 #define RExC_close_parens       (pRExC_state->close_parens)
250 #define RExC_opend      (pRExC_state->opend)
251 #define RExC_paren_names        (pRExC_state->paren_names)
252 #define RExC_recurse    (pRExC_state->recurse)
253 #define RExC_recurse_count      (pRExC_state->recurse_count)
254 #define RExC_study_chunk_recursed        (pRExC_state->study_chunk_recursed)
255 #define RExC_study_chunk_recursed_bytes  \
256                                    (pRExC_state->study_chunk_recursed_bytes)
257 #define RExC_in_lookbehind      (pRExC_state->in_lookbehind)
258 #define RExC_contains_locale    (pRExC_state->contains_locale)
259 #define RExC_contains_i (pRExC_state->contains_i)
260 #define RExC_override_recoding (pRExC_state->override_recoding)
261 #ifdef EBCDIC
262 #   define RExC_recode_x_to_native (pRExC_state->recode_x_to_native)
263 #endif
264 #define RExC_in_multi_char_class (pRExC_state->in_multi_char_class)
265 #define RExC_frame_head (pRExC_state->frame_head)
266 #define RExC_frame_last (pRExC_state->frame_last)
267 #define RExC_frame_count (pRExC_state->frame_count)
268 #define RExC_strict (pRExC_state->strict)
269
270 /* Heuristic check on the complexity of the pattern: if TOO_NAUGHTY, we set
271  * a flag to disable back-off on the fixed/floating substrings - if it's
272  * a high complexity pattern we assume the benefit of avoiding a full match
273  * is worth the cost of checking for the substrings even if they rarely help.
274  */
275 #define RExC_naughty    (pRExC_state->naughty)
276 #define TOO_NAUGHTY (10)
277 #define MARK_NAUGHTY(add) \
278     if (RExC_naughty < TOO_NAUGHTY) \
279         RExC_naughty += (add)
280 #define MARK_NAUGHTY_EXP(exp, add) \
281     if (RExC_naughty < TOO_NAUGHTY) \
282         RExC_naughty += RExC_naughty / (exp) + (add)
283
284 #define ISMULT1(c)      ((c) == '*' || (c) == '+' || (c) == '?')
285 #define ISMULT2(s)      ((*s) == '*' || (*s) == '+' || (*s) == '?' || \
286         ((*s) == '{' && regcurly(s)))
287
288 /*
289  * Flags to be passed up and down.
290  */
291 #define WORST           0       /* Worst case. */
292 #define HASWIDTH        0x01    /* Known to match non-null strings. */
293
294 /* Simple enough to be STAR/PLUS operand; in an EXACTish node must be a single
295  * character.  (There needs to be a case: in the switch statement in regexec.c
296  * for any node marked SIMPLE.)  Note that this is not the same thing as
297  * REGNODE_SIMPLE */
298 #define SIMPLE          0x02
299 #define SPSTART         0x04    /* Starts with * or + */
300 #define POSTPONED       0x08    /* (?1),(?&name), (??{...}) or similar */
301 #define TRYAGAIN        0x10    /* Weeded out a declaration. */
302 #define RESTART_UTF8    0x20    /* Restart, need to calcuate sizes as UTF-8 */
303
304 #define REG_NODE_NUM(x) ((x) ? (int)((x)-RExC_emit_start) : -1)
305
306 /* whether trie related optimizations are enabled */
307 #if PERL_ENABLE_EXTENDED_TRIE_OPTIMISATION
308 #define TRIE_STUDY_OPT
309 #define FULL_TRIE_STUDY
310 #define TRIE_STCLASS
311 #endif
312
313
314
315 #define PBYTE(u8str,paren) ((U8*)(u8str))[(paren) >> 3]
316 #define PBITVAL(paren) (1 << ((paren) & 7))
317 #define PAREN_TEST(u8str,paren) ( PBYTE(u8str,paren) & PBITVAL(paren))
318 #define PAREN_SET(u8str,paren) PBYTE(u8str,paren) |= PBITVAL(paren)
319 #define PAREN_UNSET(u8str,paren) PBYTE(u8str,paren) &= (~PBITVAL(paren))
320
321 #define REQUIRE_UTF8    STMT_START {                                       \
322                                      if (!UTF) {                           \
323                                          *flagp = RESTART_UTF8;            \
324                                          return NULL;                      \
325                                      }                                     \
326                         } STMT_END
327
328 /* This converts the named class defined in regcomp.h to its equivalent class
329  * number defined in handy.h. */
330 #define namedclass_to_classnum(class)  ((int) ((class) / 2))
331 #define classnum_to_namedclass(classnum)  ((classnum) * 2)
332
333 #define _invlist_union_complement_2nd(a, b, output) \
334                         _invlist_union_maybe_complement_2nd(a, b, TRUE, output)
335 #define _invlist_intersection_complement_2nd(a, b, output) \
336                  _invlist_intersection_maybe_complement_2nd(a, b, TRUE, output)
337
338 /* About scan_data_t.
339
340   During optimisation we recurse through the regexp program performing
341   various inplace (keyhole style) optimisations. In addition study_chunk
342   and scan_commit populate this data structure with information about
343   what strings MUST appear in the pattern. We look for the longest
344   string that must appear at a fixed location, and we look for the
345   longest string that may appear at a floating location. So for instance
346   in the pattern:
347
348     /FOO[xX]A.*B[xX]BAR/
349
350   Both 'FOO' and 'A' are fixed strings. Both 'B' and 'BAR' are floating
351   strings (because they follow a .* construct). study_chunk will identify
352   both FOO and BAR as being the longest fixed and floating strings respectively.
353
354   The strings can be composites, for instance
355
356      /(f)(o)(o)/
357
358   will result in a composite fixed substring 'foo'.
359
360   For each string some basic information is maintained:
361
362   - offset or min_offset
363     This is the position the string must appear at, or not before.
364     It also implicitly (when combined with minlenp) tells us how many
365     characters must match before the string we are searching for.
366     Likewise when combined with minlenp and the length of the string it
367     tells us how many characters must appear after the string we have
368     found.
369
370   - max_offset
371     Only used for floating strings. This is the rightmost point that
372     the string can appear at. If set to SSize_t_MAX it indicates that the
373     string can occur infinitely far to the right.
374
375   - minlenp
376     A pointer to the minimum number of characters of the pattern that the
377     string was found inside. This is important as in the case of positive
378     lookahead or positive lookbehind we can have multiple patterns
379     involved. Consider
380
381     /(?=FOO).*F/
382
383     The minimum length of the pattern overall is 3, the minimum length
384     of the lookahead part is 3, but the minimum length of the part that
385     will actually match is 1. So 'FOO's minimum length is 3, but the
386     minimum length for the F is 1. This is important as the minimum length
387     is used to determine offsets in front of and behind the string being
388     looked for.  Since strings can be composites this is the length of the
389     pattern at the time it was committed with a scan_commit. Note that
390     the length is calculated by study_chunk, so that the minimum lengths
391     are not known until the full pattern has been compiled, thus the
392     pointer to the value.
393
394   - lookbehind
395
396     In the case of lookbehind the string being searched for can be
397     offset past the start point of the final matching string.
398     If this value was just blithely removed from the min_offset it would
399     invalidate some of the calculations for how many chars must match
400     before or after (as they are derived from min_offset and minlen and
401     the length of the string being searched for).
402     When the final pattern is compiled and the data is moved from the
403     scan_data_t structure into the regexp structure the information
404     about lookbehind is factored in, with the information that would
405     have been lost precalculated in the end_shift field for the
406     associated string.
407
408   The fields pos_min and pos_delta are used to store the minimum offset
409   and the delta to the maximum offset at the current point in the pattern.
410
411 */
412
413 typedef struct scan_data_t {
414     /*I32 len_min;      unused */
415     /*I32 len_delta;    unused */
416     SSize_t pos_min;
417     SSize_t pos_delta;
418     SV *last_found;
419     SSize_t last_end;       /* min value, <0 unless valid. */
420     SSize_t last_start_min;
421     SSize_t last_start_max;
422     SV **longest;           /* Either &l_fixed, or &l_float. */
423     SV *longest_fixed;      /* longest fixed string found in pattern */
424     SSize_t offset_fixed;   /* offset where it starts */
425     SSize_t *minlen_fixed;  /* pointer to the minlen relevant to the string */
426     I32 lookbehind_fixed;   /* is the position of the string modfied by LB */
427     SV *longest_float;      /* longest floating string found in pattern */
428     SSize_t offset_float_min; /* earliest point in string it can appear */
429     SSize_t offset_float_max; /* latest point in string it can appear */
430     SSize_t *minlen_float;  /* pointer to the minlen relevant to the string */
431     SSize_t lookbehind_float; /* is the pos of the string modified by LB */
432     I32 flags;
433     I32 whilem_c;
434     SSize_t *last_closep;
435     regnode_ssc *start_class;
436 } scan_data_t;
437
438 /*
439  * Forward declarations for pregcomp()'s friends.
440  */
441
442 static const scan_data_t zero_scan_data =
443   { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ,0};
444
445 #define SF_BEFORE_EOL           (SF_BEFORE_SEOL|SF_BEFORE_MEOL)
446 #define SF_BEFORE_SEOL          0x0001
447 #define SF_BEFORE_MEOL          0x0002
448 #define SF_FIX_BEFORE_EOL       (SF_FIX_BEFORE_SEOL|SF_FIX_BEFORE_MEOL)
449 #define SF_FL_BEFORE_EOL        (SF_FL_BEFORE_SEOL|SF_FL_BEFORE_MEOL)
450
451 #define SF_FIX_SHIFT_EOL        (+2)
452 #define SF_FL_SHIFT_EOL         (+4)
453
454 #define SF_FIX_BEFORE_SEOL      (SF_BEFORE_SEOL << SF_FIX_SHIFT_EOL)
455 #define SF_FIX_BEFORE_MEOL      (SF_BEFORE_MEOL << SF_FIX_SHIFT_EOL)
456
457 #define SF_FL_BEFORE_SEOL       (SF_BEFORE_SEOL << SF_FL_SHIFT_EOL)
458 #define SF_FL_BEFORE_MEOL       (SF_BEFORE_MEOL << SF_FL_SHIFT_EOL) /* 0x20 */
459 #define SF_IS_INF               0x0040
460 #define SF_HAS_PAR              0x0080
461 #define SF_IN_PAR               0x0100
462 #define SF_HAS_EVAL             0x0200
463 #define SCF_DO_SUBSTR           0x0400
464 #define SCF_DO_STCLASS_AND      0x0800
465 #define SCF_DO_STCLASS_OR       0x1000
466 #define SCF_DO_STCLASS          (SCF_DO_STCLASS_AND|SCF_DO_STCLASS_OR)
467 #define SCF_WHILEM_VISITED_POS  0x2000
468
469 #define SCF_TRIE_RESTUDY        0x4000 /* Do restudy? */
470 #define SCF_SEEN_ACCEPT         0x8000
471 #define SCF_TRIE_DOING_RESTUDY 0x10000
472 #define SCF_IN_DEFINE          0x20000
473
474
475
476
477 #define UTF cBOOL(RExC_utf8)
478
479 /* The enums for all these are ordered so things work out correctly */
480 #define LOC (get_regex_charset(RExC_flags) == REGEX_LOCALE_CHARSET)
481 #define DEPENDS_SEMANTICS (get_regex_charset(RExC_flags)                    \
482                                                      == REGEX_DEPENDS_CHARSET)
483 #define UNI_SEMANTICS (get_regex_charset(RExC_flags) == REGEX_UNICODE_CHARSET)
484 #define AT_LEAST_UNI_SEMANTICS (get_regex_charset(RExC_flags)                \
485                                                      >= REGEX_UNICODE_CHARSET)
486 #define ASCII_RESTRICTED (get_regex_charset(RExC_flags)                      \
487                                             == REGEX_ASCII_RESTRICTED_CHARSET)
488 #define AT_LEAST_ASCII_RESTRICTED (get_regex_charset(RExC_flags)             \
489                                             >= REGEX_ASCII_RESTRICTED_CHARSET)
490 #define ASCII_FOLD_RESTRICTED (get_regex_charset(RExC_flags)                 \
491                                         == REGEX_ASCII_MORE_RESTRICTED_CHARSET)
492
493 #define FOLD cBOOL(RExC_flags & RXf_PMf_FOLD)
494
495 /* For programs that want to be strictly Unicode compatible by dying if any
496  * attempt is made to match a non-Unicode code point against a Unicode
497  * property.  */
498 #define ALWAYS_WARN_SUPER  ckDEAD(packWARN(WARN_NON_UNICODE))
499
500 #define OOB_NAMEDCLASS          -1
501
502 /* There is no code point that is out-of-bounds, so this is problematic.  But
503  * its only current use is to initialize a variable that is always set before
504  * looked at. */
505 #define OOB_UNICODE             0xDEADBEEF
506
507 #define CHR_SVLEN(sv) (UTF ? sv_len_utf8(sv) : SvCUR(sv))
508 #define CHR_DIST(a,b) (UTF ? utf8_distance(a,b) : a - b)
509
510
511 /* length of regex to show in messages that don't mark a position within */
512 #define RegexLengthToShowInErrorMessages 127
513
514 /*
515  * If MARKER[12] are adjusted, be sure to adjust the constants at the top
516  * of t/op/regmesg.t, the tests in t/op/re_tests, and those in
517  * op/pragma/warn/regcomp.
518  */
519 #define MARKER1 "<-- HERE"    /* marker as it appears in the description */
520 #define MARKER2 " <-- HERE "  /* marker as it appears within the regex */
521
522 #define REPORT_LOCATION " in regex; marked by " MARKER1    \
523                         " in m/%"UTF8f MARKER2 "%"UTF8f"/"
524
525 #define REPORT_LOCATION_ARGS(offset)            \
526                 UTF8fARG(UTF, offset, RExC_precomp), \
527                 UTF8fARG(UTF, RExC_end - RExC_precomp - offset, RExC_precomp + offset)
528
529 /* Used to point after bad bytes for an error message, but avoid skipping
530  * past a nul byte. */
531 #define SKIP_IF_CHAR(s) (!*(s) ? 0 : UTF ? UTF8SKIP(s) : 1)
532
533 /*
534  * Calls SAVEDESTRUCTOR_X if needed, then calls Perl_croak with the given
535  * arg. Show regex, up to a maximum length. If it's too long, chop and add
536  * "...".
537  */
538 #define _FAIL(code) STMT_START {                                        \
539     const char *ellipses = "";                                          \
540     IV len = RExC_end - RExC_precomp;                                   \
541                                                                         \
542     if (!SIZE_ONLY)                                                     \
543         SAVEFREESV(RExC_rx_sv);                                         \
544     if (len > RegexLengthToShowInErrorMessages) {                       \
545         /* chop 10 shorter than the max, to ensure meaning of "..." */  \
546         len = RegexLengthToShowInErrorMessages - 10;                    \
547         ellipses = "...";                                               \
548     }                                                                   \
549     code;                                                               \
550 } STMT_END
551
552 #define FAIL(msg) _FAIL(                            \
553     Perl_croak(aTHX_ "%s in regex m/%"UTF8f"%s/",           \
554             msg, UTF8fARG(UTF, len, RExC_precomp), ellipses))
555
556 #define FAIL2(msg,arg) _FAIL(                       \
557     Perl_croak(aTHX_ msg " in regex m/%"UTF8f"%s/",         \
558             arg, UTF8fARG(UTF, len, RExC_precomp), ellipses))
559
560 /*
561  * Simple_vFAIL -- like FAIL, but marks the current location in the scan
562  */
563 #define Simple_vFAIL(m) STMT_START {                                    \
564     const IV offset =                                                   \
565         (RExC_parse > RExC_end ? RExC_end : RExC_parse) - RExC_precomp; \
566     Perl_croak(aTHX_ "%s" REPORT_LOCATION,                              \
567             m, REPORT_LOCATION_ARGS(offset));   \
568 } STMT_END
569
570 /*
571  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL()
572  */
573 #define vFAIL(m) STMT_START {                           \
574     if (!SIZE_ONLY)                                     \
575         SAVEFREESV(RExC_rx_sv);                         \
576     Simple_vFAIL(m);                                    \
577 } STMT_END
578
579 /*
580  * Like Simple_vFAIL(), but accepts two arguments.
581  */
582 #define Simple_vFAIL2(m,a1) STMT_START {                        \
583     const IV offset = RExC_parse - RExC_precomp;                        \
584     S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1,                      \
585                       REPORT_LOCATION_ARGS(offset));    \
586 } STMT_END
587
588 /*
589  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL2().
590  */
591 #define vFAIL2(m,a1) STMT_START {                       \
592     if (!SIZE_ONLY)                                     \
593         SAVEFREESV(RExC_rx_sv);                         \
594     Simple_vFAIL2(m, a1);                               \
595 } STMT_END
596
597
598 /*
599  * Like Simple_vFAIL(), but accepts three arguments.
600  */
601 #define Simple_vFAIL3(m, a1, a2) STMT_START {                   \
602     const IV offset = RExC_parse - RExC_precomp;                \
603     S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1, a2,          \
604             REPORT_LOCATION_ARGS(offset));      \
605 } STMT_END
606
607 /*
608  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL3().
609  */
610 #define vFAIL3(m,a1,a2) STMT_START {                    \
611     if (!SIZE_ONLY)                                     \
612         SAVEFREESV(RExC_rx_sv);                         \
613     Simple_vFAIL3(m, a1, a2);                           \
614 } STMT_END
615
616 /*
617  * Like Simple_vFAIL(), but accepts four arguments.
618  */
619 #define Simple_vFAIL4(m, a1, a2, a3) STMT_START {               \
620     const IV offset = RExC_parse - RExC_precomp;                \
621     S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1, a2, a3,              \
622             REPORT_LOCATION_ARGS(offset));      \
623 } STMT_END
624
625 #define vFAIL4(m,a1,a2,a3) STMT_START {                 \
626     if (!SIZE_ONLY)                                     \
627         SAVEFREESV(RExC_rx_sv);                         \
628     Simple_vFAIL4(m, a1, a2, a3);                       \
629 } STMT_END
630
631 /* A specialized version of vFAIL2 that works with UTF8f */
632 #define vFAIL2utf8f(m, a1) STMT_START { \
633     const IV offset = RExC_parse - RExC_precomp;   \
634     if (!SIZE_ONLY)                                \
635         SAVEFREESV(RExC_rx_sv);                    \
636     S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1, \
637             REPORT_LOCATION_ARGS(offset));         \
638 } STMT_END
639
640 /* These have asserts in them because of [perl #122671] Many warnings in
641  * regcomp.c can occur twice.  If they get output in pass1 and later in that
642  * pass, the pattern has to be converted to UTF-8 and the pass restarted, they
643  * would get output again.  So they should be output in pass2, and these
644  * asserts make sure new warnings follow that paradigm. */
645
646 /* m is not necessarily a "literal string", in this macro */
647 #define reg_warn_non_literal_string(loc, m) STMT_START {                \
648     const IV offset = loc - RExC_precomp;                               \
649     __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_REGEXP), "%s" REPORT_LOCATION,      \
650             m, REPORT_LOCATION_ARGS(offset));       \
651 } STMT_END
652
653 #define ckWARNreg(loc,m) STMT_START {                                   \
654     const IV offset = loc - RExC_precomp;                               \
655     __ASSERT_(PASS2) Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,     \
656             REPORT_LOCATION_ARGS(offset));              \
657 } STMT_END
658
659 #define vWARN(loc, m) STMT_START {                                      \
660     const IV offset = loc - RExC_precomp;                               \
661     __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,        \
662             REPORT_LOCATION_ARGS(offset));              \
663 } STMT_END
664
665 #define vWARN_dep(loc, m) STMT_START {                                  \
666     const IV offset = loc - RExC_precomp;                               \
667     __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_DEPRECATED), m REPORT_LOCATION,    \
668             REPORT_LOCATION_ARGS(offset));              \
669 } STMT_END
670
671 #define ckWARNdep(loc,m) STMT_START {                                   \
672     const IV offset = loc - RExC_precomp;                               \
673     __ASSERT_(PASS2) Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED),                  \
674             m REPORT_LOCATION,                                          \
675             REPORT_LOCATION_ARGS(offset));              \
676 } STMT_END
677
678 #define ckWARNregdep(loc,m) STMT_START {                                \
679     const IV offset = loc - RExC_precomp;                               \
680     __ASSERT_(PASS2) Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_REGEXP),    \
681             m REPORT_LOCATION,                                          \
682             REPORT_LOCATION_ARGS(offset));              \
683 } STMT_END
684
685 #define ckWARN2reg_d(loc,m, a1) STMT_START {                            \
686     const IV offset = loc - RExC_precomp;                               \
687     __ASSERT_(PASS2) Perl_ck_warner_d(aTHX_ packWARN(WARN_REGEXP),                      \
688             m REPORT_LOCATION,                                          \
689             a1, REPORT_LOCATION_ARGS(offset));  \
690 } STMT_END
691
692 #define ckWARN2reg(loc, m, a1) STMT_START {                             \
693     const IV offset = loc - RExC_precomp;                               \
694     __ASSERT_(PASS2) Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,     \
695             a1, REPORT_LOCATION_ARGS(offset));  \
696 } STMT_END
697
698 #define vWARN3(loc, m, a1, a2) STMT_START {                             \
699     const IV offset = loc - RExC_precomp;                               \
700     __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,                \
701             a1, a2, REPORT_LOCATION_ARGS(offset));      \
702 } STMT_END
703
704 #define ckWARN3reg(loc, m, a1, a2) STMT_START {                         \
705     const IV offset = loc - RExC_precomp;                               \
706     __ASSERT_(PASS2) Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,     \
707             a1, a2, REPORT_LOCATION_ARGS(offset));      \
708 } STMT_END
709
710 #define vWARN4(loc, m, a1, a2, a3) STMT_START {                         \
711     const IV offset = loc - RExC_precomp;                               \
712     __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,                \
713             a1, a2, a3, REPORT_LOCATION_ARGS(offset)); \
714 } STMT_END
715
716 #define ckWARN4reg(loc, m, a1, a2, a3) STMT_START {                     \
717     const IV offset = loc - RExC_precomp;                               \
718     __ASSERT_(PASS2) Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,     \
719             a1, a2, a3, REPORT_LOCATION_ARGS(offset)); \
720 } STMT_END
721
722 #define vWARN5(loc, m, a1, a2, a3, a4) STMT_START {                     \
723     const IV offset = loc - RExC_precomp;                               \
724     __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,                \
725             a1, a2, a3, a4, REPORT_LOCATION_ARGS(offset)); \
726 } STMT_END
727
728 /* Macros for recording node offsets.   20001227 mjd@plover.com
729  * Nodes are numbered 1, 2, 3, 4.  Node #n's position is recorded in
730  * element 2*n-1 of the array.  Element #2n holds the byte length node #n.
731  * Element 0 holds the number n.
732  * Position is 1 indexed.
733  */
734 #ifndef RE_TRACK_PATTERN_OFFSETS
735 #define Set_Node_Offset_To_R(node,byte)
736 #define Set_Node_Offset(node,byte)
737 #define Set_Cur_Node_Offset
738 #define Set_Node_Length_To_R(node,len)
739 #define Set_Node_Length(node,len)
740 #define Set_Node_Cur_Length(node,start)
741 #define Node_Offset(n)
742 #define Node_Length(n)
743 #define Set_Node_Offset_Length(node,offset,len)
744 #define ProgLen(ri) ri->u.proglen
745 #define SetProgLen(ri,x) ri->u.proglen = x
746 #else
747 #define ProgLen(ri) ri->u.offsets[0]
748 #define SetProgLen(ri,x) ri->u.offsets[0] = x
749 #define Set_Node_Offset_To_R(node,byte) STMT_START {                    \
750     if (! SIZE_ONLY) {                                                  \
751         MJD_OFFSET_DEBUG(("** (%d) offset of node %d is %d.\n",         \
752                     __LINE__, (int)(node), (int)(byte)));               \
753         if((node) < 0) {                                                \
754             Perl_croak(aTHX_ "value of node is %d in Offset macro",     \
755                                          (int)(node));                  \
756         } else {                                                        \
757             RExC_offsets[2*(node)-1] = (byte);                          \
758         }                                                               \
759     }                                                                   \
760 } STMT_END
761
762 #define Set_Node_Offset(node,byte) \
763     Set_Node_Offset_To_R((node)-RExC_emit_start, (byte)-RExC_start)
764 #define Set_Cur_Node_Offset Set_Node_Offset(RExC_emit, RExC_parse)
765
766 #define Set_Node_Length_To_R(node,len) STMT_START {                     \
767     if (! SIZE_ONLY) {                                                  \
768         MJD_OFFSET_DEBUG(("** (%d) size of node %d is %d.\n",           \
769                 __LINE__, (int)(node), (int)(len)));                    \
770         if((node) < 0) {                                                \
771             Perl_croak(aTHX_ "value of node is %d in Length macro",     \
772                                          (int)(node));                  \
773         } else {                                                        \
774             RExC_offsets[2*(node)] = (len);                             \
775         }                                                               \
776     }                                                                   \
777 } STMT_END
778
779 #define Set_Node_Length(node,len) \
780     Set_Node_Length_To_R((node)-RExC_emit_start, len)
781 #define Set_Node_Cur_Length(node, start)                \
782     Set_Node_Length(node, RExC_parse - start)
783
784 /* Get offsets and lengths */
785 #define Node_Offset(n) (RExC_offsets[2*((n)-RExC_emit_start)-1])
786 #define Node_Length(n) (RExC_offsets[2*((n)-RExC_emit_start)])
787
788 #define Set_Node_Offset_Length(node,offset,len) STMT_START {    \
789     Set_Node_Offset_To_R((node)-RExC_emit_start, (offset));     \
790     Set_Node_Length_To_R((node)-RExC_emit_start, (len));        \
791 } STMT_END
792 #endif
793
794 #if PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS
795 #define EXPERIMENTAL_INPLACESCAN
796 #endif /*PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS*/
797
798 #define DEBUG_RExC_seen() \
799         DEBUG_OPTIMISE_MORE_r({                                             \
800             PerlIO_printf(Perl_debug_log,"RExC_seen: ");                    \
801                                                                             \
802             if (RExC_seen & REG_ZERO_LEN_SEEN)                              \
803                 PerlIO_printf(Perl_debug_log,"REG_ZERO_LEN_SEEN ");         \
804                                                                             \
805             if (RExC_seen & REG_LOOKBEHIND_SEEN)                            \
806                 PerlIO_printf(Perl_debug_log,"REG_LOOKBEHIND_SEEN ");       \
807                                                                             \
808             if (RExC_seen & REG_GPOS_SEEN)                                  \
809                 PerlIO_printf(Perl_debug_log,"REG_GPOS_SEEN ");             \
810                                                                             \
811             if (RExC_seen & REG_RECURSE_SEEN)                               \
812                 PerlIO_printf(Perl_debug_log,"REG_RECURSE_SEEN ");          \
813                                                                             \
814             if (RExC_seen & REG_TOP_LEVEL_BRANCHES_SEEN)                         \
815                 PerlIO_printf(Perl_debug_log,"REG_TOP_LEVEL_BRANCHES_SEEN ");    \
816                                                                             \
817             if (RExC_seen & REG_VERBARG_SEEN)                               \
818                 PerlIO_printf(Perl_debug_log,"REG_VERBARG_SEEN ");          \
819                                                                             \
820             if (RExC_seen & REG_CUTGROUP_SEEN)                              \
821                 PerlIO_printf(Perl_debug_log,"REG_CUTGROUP_SEEN ");         \
822                                                                             \
823             if (RExC_seen & REG_RUN_ON_COMMENT_SEEN)                        \
824                 PerlIO_printf(Perl_debug_log,"REG_RUN_ON_COMMENT_SEEN ");   \
825                                                                             \
826             if (RExC_seen & REG_UNFOLDED_MULTI_SEEN)                        \
827                 PerlIO_printf(Perl_debug_log,"REG_UNFOLDED_MULTI_SEEN ");   \
828                                                                             \
829             if (RExC_seen & REG_GOSTART_SEEN)                               \
830                 PerlIO_printf(Perl_debug_log,"REG_GOSTART_SEEN ");          \
831                                                                             \
832             if (RExC_seen & REG_UNBOUNDED_QUANTIFIER_SEEN)                               \
833                 PerlIO_printf(Perl_debug_log,"REG_UNBOUNDED_QUANTIFIER_SEEN ");          \
834                                                                             \
835             PerlIO_printf(Perl_debug_log,"\n");                             \
836         });
837
838 #define DEBUG_SHOW_STUDY_FLAG(flags,flag) \
839   if ((flags) & flag) PerlIO_printf(Perl_debug_log, "%s ", #flag)
840
841 #define DEBUG_SHOW_STUDY_FLAGS(flags,open_str,close_str)                    \
842     if ( ( flags ) ) {                                                      \
843         PerlIO_printf(Perl_debug_log, "%s", open_str);                      \
844         DEBUG_SHOW_STUDY_FLAG(flags,SF_FL_BEFORE_SEOL);                     \
845         DEBUG_SHOW_STUDY_FLAG(flags,SF_FL_BEFORE_MEOL);                     \
846         DEBUG_SHOW_STUDY_FLAG(flags,SF_IS_INF);                             \
847         DEBUG_SHOW_STUDY_FLAG(flags,SF_HAS_PAR);                            \
848         DEBUG_SHOW_STUDY_FLAG(flags,SF_IN_PAR);                             \
849         DEBUG_SHOW_STUDY_FLAG(flags,SF_HAS_EVAL);                           \
850         DEBUG_SHOW_STUDY_FLAG(flags,SCF_DO_SUBSTR);                         \
851         DEBUG_SHOW_STUDY_FLAG(flags,SCF_DO_STCLASS_AND);                    \
852         DEBUG_SHOW_STUDY_FLAG(flags,SCF_DO_STCLASS_OR);                     \
853         DEBUG_SHOW_STUDY_FLAG(flags,SCF_DO_STCLASS);                        \
854         DEBUG_SHOW_STUDY_FLAG(flags,SCF_WHILEM_VISITED_POS);                \
855         DEBUG_SHOW_STUDY_FLAG(flags,SCF_TRIE_RESTUDY);                      \
856         DEBUG_SHOW_STUDY_FLAG(flags,SCF_SEEN_ACCEPT);                       \
857         DEBUG_SHOW_STUDY_FLAG(flags,SCF_TRIE_DOING_RESTUDY);                \
858         DEBUG_SHOW_STUDY_FLAG(flags,SCF_IN_DEFINE);                         \
859         PerlIO_printf(Perl_debug_log, "%s", close_str);                     \
860     }
861
862
863 #define DEBUG_STUDYDATA(str,data,depth)                              \
864 DEBUG_OPTIMISE_MORE_r(if(data){                                      \
865     PerlIO_printf(Perl_debug_log,                                    \
866         "%*s" str "Pos:%"IVdf"/%"IVdf                                \
867         " Flags: 0x%"UVXf,                                           \
868         (int)(depth)*2, "",                                          \
869         (IV)((data)->pos_min),                                       \
870         (IV)((data)->pos_delta),                                     \
871         (UV)((data)->flags)                                          \
872     );                                                               \
873     DEBUG_SHOW_STUDY_FLAGS((data)->flags," [ ","]");                 \
874     PerlIO_printf(Perl_debug_log,                                    \
875         " Whilem_c: %"IVdf" Lcp: %"IVdf" %s",                        \
876         (IV)((data)->whilem_c),                                      \
877         (IV)((data)->last_closep ? *((data)->last_closep) : -1),     \
878         is_inf ? "INF " : ""                                         \
879     );                                                               \
880     if ((data)->last_found)                                          \
881         PerlIO_printf(Perl_debug_log,                                \
882             "Last:'%s' %"IVdf":%"IVdf"/%"IVdf" %sFixed:'%s' @ %"IVdf \
883             " %sFloat: '%s' @ %"IVdf"/%"IVdf"",                      \
884             SvPVX_const((data)->last_found),                         \
885             (IV)((data)->last_end),                                  \
886             (IV)((data)->last_start_min),                            \
887             (IV)((data)->last_start_max),                            \
888             ((data)->longest &&                                      \
889              (data)->longest==&((data)->longest_fixed)) ? "*" : "",  \
890             SvPVX_const((data)->longest_fixed),                      \
891             (IV)((data)->offset_fixed),                              \
892             ((data)->longest &&                                      \
893              (data)->longest==&((data)->longest_float)) ? "*" : "",  \
894             SvPVX_const((data)->longest_float),                      \
895             (IV)((data)->offset_float_min),                          \
896             (IV)((data)->offset_float_max)                           \
897         );                                                           \
898     PerlIO_printf(Perl_debug_log,"\n");                              \
899 });
900
901 /* is c a control character for which we have a mnemonic? */
902 #define isMNEMONIC_CNTRL(c) _IS_MNEMONIC_CNTRL_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c)
903
904 STATIC const char *
905 S_cntrl_to_mnemonic(const U8 c)
906 {
907     /* Returns the mnemonic string that represents character 'c', if one
908      * exists; NULL otherwise.  The only ones that exist for the purposes of
909      * this routine are a few control characters */
910
911     switch (c) {
912         case '\a':       return "\\a";
913         case '\b':       return "\\b";
914         case ESC_NATIVE: return "\\e";
915         case '\f':       return "\\f";
916         case '\n':       return "\\n";
917         case '\r':       return "\\r";
918         case '\t':       return "\\t";
919     }
920
921     return NULL;
922 }
923
924 /* Mark that we cannot extend a found fixed substring at this point.
925    Update the longest found anchored substring and the longest found
926    floating substrings if needed. */
927
928 STATIC void
929 S_scan_commit(pTHX_ const RExC_state_t *pRExC_state, scan_data_t *data,
930                     SSize_t *minlenp, int is_inf)
931 {
932     const STRLEN l = CHR_SVLEN(data->last_found);
933     const STRLEN old_l = CHR_SVLEN(*data->longest);
934     GET_RE_DEBUG_FLAGS_DECL;
935
936     PERL_ARGS_ASSERT_SCAN_COMMIT;
937
938     if ((l >= old_l) && ((l > old_l) || (data->flags & SF_BEFORE_EOL))) {
939         SvSetMagicSV(*data->longest, data->last_found);
940         if (*data->longest == data->longest_fixed) {
941             data->offset_fixed = l ? data->last_start_min : data->pos_min;
942             if (data->flags & SF_BEFORE_EOL)
943                 data->flags
944                     |= ((data->flags & SF_BEFORE_EOL) << SF_FIX_SHIFT_EOL);
945             else
946                 data->flags &= ~SF_FIX_BEFORE_EOL;
947             data->minlen_fixed=minlenp;
948             data->lookbehind_fixed=0;
949         }
950         else { /* *data->longest == data->longest_float */
951             data->offset_float_min = l ? data->last_start_min : data->pos_min;
952             data->offset_float_max = (l
953                           ? data->last_start_max
954                           : (data->pos_delta > SSize_t_MAX - data->pos_min
955                                          ? SSize_t_MAX
956                                          : data->pos_min + data->pos_delta));
957             if (is_inf
958                  || (STRLEN)data->offset_float_max > (STRLEN)SSize_t_MAX)
959                 data->offset_float_max = SSize_t_MAX;
960             if (data->flags & SF_BEFORE_EOL)
961                 data->flags
962                     |= ((data->flags & SF_BEFORE_EOL) << SF_FL_SHIFT_EOL);
963             else
964                 data->flags &= ~SF_FL_BEFORE_EOL;
965             data->minlen_float=minlenp;
966             data->lookbehind_float=0;
967         }
968     }
969     SvCUR_set(data->last_found, 0);
970     {
971         SV * const sv = data->last_found;
972         if (SvUTF8(sv) && SvMAGICAL(sv)) {
973             MAGIC * const mg = mg_find(sv, PERL_MAGIC_utf8);
974             if (mg)
975                 mg->mg_len = 0;
976         }
977     }
978     data->last_end = -1;
979     data->flags &= ~SF_BEFORE_EOL;
980     DEBUG_STUDYDATA("commit: ",data,0);
981 }
982
983 /* An SSC is just a regnode_charclass_posix with an extra field: the inversion
984  * list that describes which code points it matches */
985
986 STATIC void
987 S_ssc_anything(pTHX_ regnode_ssc *ssc)
988 {
989     /* Set the SSC 'ssc' to match an empty string or any code point */
990
991     PERL_ARGS_ASSERT_SSC_ANYTHING;
992
993     assert(is_ANYOF_SYNTHETIC(ssc));
994
995     ssc->invlist = sv_2mortal(_new_invlist(2)); /* mortalize so won't leak */
996     _append_range_to_invlist(ssc->invlist, 0, UV_MAX);
997     ANYOF_FLAGS(ssc) |= SSC_MATCHES_EMPTY_STRING;  /* Plus matches empty */
998 }
999
1000 STATIC int
1001 S_ssc_is_anything(const regnode_ssc *ssc)
1002 {
1003     /* Returns TRUE if the SSC 'ssc' can match the empty string and any code
1004      * point; FALSE otherwise.  Thus, this is used to see if using 'ssc' buys
1005      * us anything: if the function returns TRUE, 'ssc' hasn't been restricted
1006      * in any way, so there's no point in using it */
1007
1008     UV start, end;
1009     bool ret;
1010
1011     PERL_ARGS_ASSERT_SSC_IS_ANYTHING;
1012
1013     assert(is_ANYOF_SYNTHETIC(ssc));
1014
1015     if (! (ANYOF_FLAGS(ssc) & SSC_MATCHES_EMPTY_STRING)) {
1016         return FALSE;
1017     }
1018
1019     /* See if the list consists solely of the range 0 - Infinity */
1020     invlist_iterinit(ssc->invlist);
1021     ret = invlist_iternext(ssc->invlist, &start, &end)
1022           && start == 0
1023           && end == UV_MAX;
1024
1025     invlist_iterfinish(ssc->invlist);
1026
1027     if (ret) {
1028         return TRUE;
1029     }
1030
1031     /* If e.g., both \w and \W are set, matches everything */
1032     if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
1033         int i;
1034         for (i = 0; i < ANYOF_POSIXL_MAX; i += 2) {
1035             if (ANYOF_POSIXL_TEST(ssc, i) && ANYOF_POSIXL_TEST(ssc, i+1)) {
1036                 return TRUE;
1037             }
1038         }
1039     }
1040
1041     return FALSE;
1042 }
1043
1044 STATIC void
1045 S_ssc_init(pTHX_ const RExC_state_t *pRExC_state, regnode_ssc *ssc)
1046 {
1047     /* Initializes the SSC 'ssc'.  This includes setting it to match an empty
1048      * string, any code point, or any posix class under locale */
1049
1050     PERL_ARGS_ASSERT_SSC_INIT;
1051
1052     Zero(ssc, 1, regnode_ssc);
1053     set_ANYOF_SYNTHETIC(ssc);
1054     ARG_SET(ssc, ANYOF_ONLY_HAS_BITMAP);
1055     ssc_anything(ssc);
1056
1057     /* If any portion of the regex is to operate under locale rules that aren't
1058      * fully known at compile time, initialization includes it.  The reason
1059      * this isn't done for all regexes is that the optimizer was written under
1060      * the assumption that locale was all-or-nothing.  Given the complexity and
1061      * lack of documentation in the optimizer, and that there are inadequate
1062      * test cases for locale, many parts of it may not work properly, it is
1063      * safest to avoid locale unless necessary. */
1064     if (RExC_contains_locale) {
1065         ANYOF_POSIXL_SETALL(ssc);
1066     }
1067     else {
1068         ANYOF_POSIXL_ZERO(ssc);
1069     }
1070 }
1071
1072 STATIC int
1073 S_ssc_is_cp_posixl_init(const RExC_state_t *pRExC_state,
1074                         const regnode_ssc *ssc)
1075 {
1076     /* Returns TRUE if the SSC 'ssc' is in its initial state with regard only
1077      * to the list of code points matched, and locale posix classes; hence does
1078      * not check its flags) */
1079
1080     UV start, end;
1081     bool ret;
1082
1083     PERL_ARGS_ASSERT_SSC_IS_CP_POSIXL_INIT;
1084
1085     assert(is_ANYOF_SYNTHETIC(ssc));
1086
1087     invlist_iterinit(ssc->invlist);
1088     ret = invlist_iternext(ssc->invlist, &start, &end)
1089           && start == 0
1090           && end == UV_MAX;
1091
1092     invlist_iterfinish(ssc->invlist);
1093
1094     if (! ret) {
1095         return FALSE;
1096     }
1097
1098     if (RExC_contains_locale && ! ANYOF_POSIXL_SSC_TEST_ALL_SET(ssc)) {
1099         return FALSE;
1100     }
1101
1102     return TRUE;
1103 }
1104
1105 STATIC SV*
1106 S_get_ANYOF_cp_list_for_ssc(pTHX_ const RExC_state_t *pRExC_state,
1107                                const regnode_charclass* const node)
1108 {
1109     /* Returns a mortal inversion list defining which code points are matched
1110      * by 'node', which is of type ANYOF.  Handles complementing the result if
1111      * appropriate.  If some code points aren't knowable at this time, the
1112      * returned list must, and will, contain every code point that is a
1113      * possibility. */
1114
1115     SV* invlist = sv_2mortal(_new_invlist(0));
1116     SV* only_utf8_locale_invlist = NULL;
1117     unsigned int i;
1118     const U32 n = ARG(node);
1119     bool new_node_has_latin1 = FALSE;
1120
1121     PERL_ARGS_ASSERT_GET_ANYOF_CP_LIST_FOR_SSC;
1122
1123     /* Look at the data structure created by S_set_ANYOF_arg() */
1124     if (n != ANYOF_ONLY_HAS_BITMAP) {
1125         SV * const rv = MUTABLE_SV(RExC_rxi->data->data[n]);
1126         AV * const av = MUTABLE_AV(SvRV(rv));
1127         SV **const ary = AvARRAY(av);
1128         assert(RExC_rxi->data->what[n] == 's');
1129
1130         if (ary[1] && ary[1] != &PL_sv_undef) { /* Has compile-time swash */
1131             invlist = sv_2mortal(invlist_clone(_get_swash_invlist(ary[1])));
1132         }
1133         else if (ary[0] && ary[0] != &PL_sv_undef) {
1134
1135             /* Here, no compile-time swash, and there are things that won't be
1136              * known until runtime -- we have to assume it could be anything */
1137             return _add_range_to_invlist(invlist, 0, UV_MAX);
1138         }
1139         else if (ary[3] && ary[3] != &PL_sv_undef) {
1140
1141             /* Here no compile-time swash, and no run-time only data.  Use the
1142              * node's inversion list */
1143             invlist = sv_2mortal(invlist_clone(ary[3]));
1144         }
1145
1146         /* Get the code points valid only under UTF-8 locales */
1147         if ((ANYOF_FLAGS(node) & ANYOF_LOC_FOLD)
1148             && ary[2] && ary[2] != &PL_sv_undef)
1149         {
1150             only_utf8_locale_invlist = ary[2];
1151         }
1152     }
1153
1154     /* An ANYOF node contains a bitmap for the first NUM_ANYOF_CODE_POINTS
1155      * code points, and an inversion list for the others, but if there are code
1156      * points that should match only conditionally on the target string being
1157      * UTF-8, those are placed in the inversion list, and not the bitmap.
1158      * Since there are circumstances under which they could match, they are
1159      * included in the SSC.  But if the ANYOF node is to be inverted, we have
1160      * to exclude them here, so that when we invert below, the end result
1161      * actually does include them.  (Think about "\xe0" =~ /[^\xc0]/di;).  We
1162      * have to do this here before we add the unconditionally matched code
1163      * points */
1164     if (ANYOF_FLAGS(node) & ANYOF_INVERT) {
1165         _invlist_intersection_complement_2nd(invlist,
1166                                              PL_UpperLatin1,
1167                                              &invlist);
1168     }
1169
1170     /* Add in the points from the bit map */
1171     for (i = 0; i < NUM_ANYOF_CODE_POINTS; i++) {
1172         if (ANYOF_BITMAP_TEST(node, i)) {
1173             invlist = add_cp_to_invlist(invlist, i);
1174             new_node_has_latin1 = TRUE;
1175         }
1176     }
1177
1178     /* If this can match all upper Latin1 code points, have to add them
1179      * as well */
1180     if (ANYOF_FLAGS(node) & ANYOF_MATCHES_ALL_NON_UTF8_NON_ASCII) {
1181         _invlist_union(invlist, PL_UpperLatin1, &invlist);
1182     }
1183
1184     /* Similarly for these */
1185     if (ANYOF_FLAGS(node) & ANYOF_MATCHES_ALL_ABOVE_BITMAP) {
1186         _invlist_union_complement_2nd(invlist, PL_InBitmap, &invlist);
1187     }
1188
1189     if (ANYOF_FLAGS(node) & ANYOF_INVERT) {
1190         _invlist_invert(invlist);
1191     }
1192     else if (new_node_has_latin1 && ANYOF_FLAGS(node) & ANYOF_LOC_FOLD) {
1193
1194         /* Under /li, any 0-255 could fold to any other 0-255, depending on the
1195          * locale.  We can skip this if there are no 0-255 at all. */
1196         _invlist_union(invlist, PL_Latin1, &invlist);
1197     }
1198
1199     /* Similarly add the UTF-8 locale possible matches.  These have to be
1200      * deferred until after the non-UTF-8 locale ones are taken care of just
1201      * above, or it leads to wrong results under ANYOF_INVERT */
1202     if (only_utf8_locale_invlist) {
1203         _invlist_union_maybe_complement_2nd(invlist,
1204                                             only_utf8_locale_invlist,
1205                                             ANYOF_FLAGS(node) & ANYOF_INVERT,
1206                                             &invlist);
1207     }
1208
1209     return invlist;
1210 }
1211
1212 /* These two functions currently do the exact same thing */
1213 #define ssc_init_zero           ssc_init
1214
1215 #define ssc_add_cp(ssc, cp)   ssc_add_range((ssc), (cp), (cp))
1216 #define ssc_match_all_cp(ssc) ssc_add_range(ssc, 0, UV_MAX)
1217
1218 /* 'AND' a given class with another one.  Can create false positives.  'ssc'
1219  * should not be inverted.  'and_with->flags & ANYOF_MATCHES_POSIXL' should be
1220  * 0 if 'and_with' is a regnode_charclass instead of a regnode_ssc. */
1221
1222 STATIC void
1223 S_ssc_and(pTHX_ const RExC_state_t *pRExC_state, regnode_ssc *ssc,
1224                 const regnode_charclass *and_with)
1225 {
1226     /* Accumulate into SSC 'ssc' its 'AND' with 'and_with', which is either
1227      * another SSC or a regular ANYOF class.  Can create false positives. */
1228
1229     SV* anded_cp_list;
1230     U8  anded_flags;
1231
1232     PERL_ARGS_ASSERT_SSC_AND;
1233
1234     assert(is_ANYOF_SYNTHETIC(ssc));
1235
1236     /* 'and_with' is used as-is if it too is an SSC; otherwise have to extract
1237      * the code point inversion list and just the relevant flags */
1238     if (is_ANYOF_SYNTHETIC(and_with)) {
1239         anded_cp_list = ((regnode_ssc *)and_with)->invlist;
1240         anded_flags = ANYOF_FLAGS(and_with);
1241
1242         /* XXX This is a kludge around what appears to be deficiencies in the
1243          * optimizer.  If we make S_ssc_anything() add in the WARN_SUPER flag,
1244          * there are paths through the optimizer where it doesn't get weeded
1245          * out when it should.  And if we don't make some extra provision for
1246          * it like the code just below, it doesn't get added when it should.
1247          * This solution is to add it only when AND'ing, which is here, and
1248          * only when what is being AND'ed is the pristine, original node
1249          * matching anything.  Thus it is like adding it to ssc_anything() but
1250          * only when the result is to be AND'ed.  Probably the same solution
1251          * could be adopted for the same problem we have with /l matching,
1252          * which is solved differently in S_ssc_init(), and that would lead to
1253          * fewer false positives than that solution has.  But if this solution
1254          * creates bugs, the consequences are only that a warning isn't raised
1255          * that should be; while the consequences for having /l bugs is
1256          * incorrect matches */
1257         if (ssc_is_anything((regnode_ssc *)and_with)) {
1258             anded_flags |= ANYOF_WARN_SUPER;
1259         }
1260     }
1261     else {
1262         anded_cp_list = get_ANYOF_cp_list_for_ssc(pRExC_state, and_with);
1263         anded_flags = ANYOF_FLAGS(and_with) & ANYOF_COMMON_FLAGS;
1264     }
1265
1266     ANYOF_FLAGS(ssc) &= anded_flags;
1267
1268     /* Below, C1 is the list of code points in 'ssc'; P1, its posix classes.
1269      * C2 is the list of code points in 'and-with'; P2, its posix classes.
1270      * 'and_with' may be inverted.  When not inverted, we have the situation of
1271      * computing:
1272      *  (C1 | P1) & (C2 | P2)
1273      *                     =  (C1 & (C2 | P2)) | (P1 & (C2 | P2))
1274      *                     =  ((C1 & C2) | (C1 & P2)) | ((P1 & C2) | (P1 & P2))
1275      *                    <=  ((C1 & C2) |       P2)) | ( P1       | (P1 & P2))
1276      *                    <=  ((C1 & C2) | P1 | P2)
1277      * Alternatively, the last few steps could be:
1278      *                     =  ((C1 & C2) | (C1 & P2)) | ((P1 & C2) | (P1 & P2))
1279      *                    <=  ((C1 & C2) |  C1      ) | (      C2  | (P1 & P2))
1280      *                    <=  (C1 | C2 | (P1 & P2))
1281      * We favor the second approach if either P1 or P2 is non-empty.  This is
1282      * because these components are a barrier to doing optimizations, as what
1283      * they match cannot be known until the moment of matching as they are
1284      * dependent on the current locale, 'AND"ing them likely will reduce or
1285      * eliminate them.
1286      * But we can do better if we know that C1,P1 are in their initial state (a
1287      * frequent occurrence), each matching everything:
1288      *  (<everything>) & (C2 | P2) =  C2 | P2
1289      * Similarly, if C2,P2 are in their initial state (again a frequent
1290      * occurrence), the result is a no-op
1291      *  (C1 | P1) & (<everything>) =  C1 | P1
1292      *
1293      * Inverted, we have
1294      *  (C1 | P1) & ~(C2 | P2)  =  (C1 | P1) & (~C2 & ~P2)
1295      *                          =  (C1 & (~C2 & ~P2)) | (P1 & (~C2 & ~P2))
1296      *                         <=  (C1 & ~C2) | (P1 & ~P2)
1297      * */
1298
1299     if ((ANYOF_FLAGS(and_with) & ANYOF_INVERT)
1300         && ! is_ANYOF_SYNTHETIC(and_with))
1301     {
1302         unsigned int i;
1303
1304         ssc_intersection(ssc,
1305                          anded_cp_list,
1306                          FALSE /* Has already been inverted */
1307                          );
1308
1309         /* If either P1 or P2 is empty, the intersection will be also; can skip
1310          * the loop */
1311         if (! (ANYOF_FLAGS(and_with) & ANYOF_MATCHES_POSIXL)) {
1312             ANYOF_POSIXL_ZERO(ssc);
1313         }
1314         else if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
1315
1316             /* Note that the Posix class component P from 'and_with' actually
1317              * looks like:
1318              *      P = Pa | Pb | ... | Pn
1319              * where each component is one posix class, such as in [\w\s].
1320              * Thus
1321              *      ~P = ~(Pa | Pb | ... | Pn)
1322              *         = ~Pa & ~Pb & ... & ~Pn
1323              *        <= ~Pa | ~Pb | ... | ~Pn
1324              * The last is something we can easily calculate, but unfortunately
1325              * is likely to have many false positives.  We could do better
1326              * in some (but certainly not all) instances if two classes in
1327              * P have known relationships.  For example
1328              *      :lower: <= :alpha: <= :alnum: <= \w <= :graph: <= :print:
1329              * So
1330              *      :lower: & :print: = :lower:
1331              * And similarly for classes that must be disjoint.  For example,
1332              * since \s and \w can have no elements in common based on rules in
1333              * the POSIX standard,
1334              *      \w & ^\S = nothing
1335              * Unfortunately, some vendor locales do not meet the Posix
1336              * standard, in particular almost everything by Microsoft.
1337              * The loop below just changes e.g., \w into \W and vice versa */
1338
1339             regnode_charclass_posixl temp;
1340             int add = 1;    /* To calculate the index of the complement */
1341
1342             ANYOF_POSIXL_ZERO(&temp);
1343             for (i = 0; i < ANYOF_MAX; i++) {
1344                 assert(i % 2 != 0
1345                        || ! ANYOF_POSIXL_TEST((regnode_charclass_posixl*) and_with, i)
1346                        || ! ANYOF_POSIXL_TEST((regnode_charclass_posixl*) and_with, i + 1));
1347
1348                 if (ANYOF_POSIXL_TEST((regnode_charclass_posixl*) and_with, i)) {
1349                     ANYOF_POSIXL_SET(&temp, i + add);
1350                 }
1351                 add = 0 - add; /* 1 goes to -1; -1 goes to 1 */
1352             }
1353             ANYOF_POSIXL_AND(&temp, ssc);
1354
1355         } /* else ssc already has no posixes */
1356     } /* else: Not inverted.  This routine is a no-op if 'and_with' is an SSC
1357          in its initial state */
1358     else if (! is_ANYOF_SYNTHETIC(and_with)
1359              || ! ssc_is_cp_posixl_init(pRExC_state, (regnode_ssc *)and_with))
1360     {
1361         /* But if 'ssc' is in its initial state, the result is just 'and_with';
1362          * copy it over 'ssc' */
1363         if (ssc_is_cp_posixl_init(pRExC_state, ssc)) {
1364             if (is_ANYOF_SYNTHETIC(and_with)) {
1365                 StructCopy(and_with, ssc, regnode_ssc);
1366             }
1367             else {
1368                 ssc->invlist = anded_cp_list;
1369                 ANYOF_POSIXL_ZERO(ssc);
1370                 if (ANYOF_FLAGS(and_with) & ANYOF_MATCHES_POSIXL) {
1371                     ANYOF_POSIXL_OR((regnode_charclass_posixl*) and_with, ssc);
1372                 }
1373             }
1374         }
1375         else if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)
1376                  || (ANYOF_FLAGS(and_with) & ANYOF_MATCHES_POSIXL))
1377         {
1378             /* One or the other of P1, P2 is non-empty. */
1379             if (ANYOF_FLAGS(and_with) & ANYOF_MATCHES_POSIXL) {
1380                 ANYOF_POSIXL_AND((regnode_charclass_posixl*) and_with, ssc);
1381             }
1382             ssc_union(ssc, anded_cp_list, FALSE);
1383         }
1384         else { /* P1 = P2 = empty */
1385             ssc_intersection(ssc, anded_cp_list, FALSE);
1386         }
1387     }
1388 }
1389
1390 STATIC void
1391 S_ssc_or(pTHX_ const RExC_state_t *pRExC_state, regnode_ssc *ssc,
1392                const regnode_charclass *or_with)
1393 {
1394     /* Accumulate into SSC 'ssc' its 'OR' with 'or_with', which is either
1395      * another SSC or a regular ANYOF class.  Can create false positives if
1396      * 'or_with' is to be inverted. */
1397
1398     SV* ored_cp_list;
1399     U8 ored_flags;
1400
1401     PERL_ARGS_ASSERT_SSC_OR;
1402
1403     assert(is_ANYOF_SYNTHETIC(ssc));
1404
1405     /* 'or_with' is used as-is if it too is an SSC; otherwise have to extract
1406      * the code point inversion list and just the relevant flags */
1407     if (is_ANYOF_SYNTHETIC(or_with)) {
1408         ored_cp_list = ((regnode_ssc*) or_with)->invlist;
1409         ored_flags = ANYOF_FLAGS(or_with);
1410     }
1411     else {
1412         ored_cp_list = get_ANYOF_cp_list_for_ssc(pRExC_state, or_with);
1413         ored_flags = ANYOF_FLAGS(or_with) & ANYOF_COMMON_FLAGS;
1414     }
1415
1416     ANYOF_FLAGS(ssc) |= ored_flags;
1417
1418     /* Below, C1 is the list of code points in 'ssc'; P1, its posix classes.
1419      * C2 is the list of code points in 'or-with'; P2, its posix classes.
1420      * 'or_with' may be inverted.  When not inverted, we have the simple
1421      * situation of computing:
1422      *  (C1 | P1) | (C2 | P2)  =  (C1 | C2) | (P1 | P2)
1423      * If P1|P2 yields a situation with both a class and its complement are
1424      * set, like having both \w and \W, this matches all code points, and we
1425      * can delete these from the P component of the ssc going forward.  XXX We
1426      * might be able to delete all the P components, but I (khw) am not certain
1427      * about this, and it is better to be safe.
1428      *
1429      * Inverted, we have
1430      *  (C1 | P1) | ~(C2 | P2)  =  (C1 | P1) | (~C2 & ~P2)
1431      *                         <=  (C1 | P1) | ~C2
1432      *                         <=  (C1 | ~C2) | P1
1433      * (which results in actually simpler code than the non-inverted case)
1434      * */
1435
1436     if ((ANYOF_FLAGS(or_with) & ANYOF_INVERT)
1437         && ! is_ANYOF_SYNTHETIC(or_with))
1438     {
1439         /* We ignore P2, leaving P1 going forward */
1440     }   /* else  Not inverted */
1441     else if (ANYOF_FLAGS(or_with) & ANYOF_MATCHES_POSIXL) {
1442         ANYOF_POSIXL_OR((regnode_charclass_posixl*)or_with, ssc);
1443         if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
1444             unsigned int i;
1445             for (i = 0; i < ANYOF_MAX; i += 2) {
1446                 if (ANYOF_POSIXL_TEST(ssc, i) && ANYOF_POSIXL_TEST(ssc, i + 1))
1447                 {
1448                     ssc_match_all_cp(ssc);
1449                     ANYOF_POSIXL_CLEAR(ssc, i);
1450                     ANYOF_POSIXL_CLEAR(ssc, i+1);
1451                 }
1452             }
1453         }
1454     }
1455
1456     ssc_union(ssc,
1457               ored_cp_list,
1458               FALSE /* Already has been inverted */
1459               );
1460 }
1461
1462 PERL_STATIC_INLINE void
1463 S_ssc_union(pTHX_ regnode_ssc *ssc, SV* const invlist, const bool invert2nd)
1464 {
1465     PERL_ARGS_ASSERT_SSC_UNION;
1466
1467     assert(is_ANYOF_SYNTHETIC(ssc));
1468
1469     _invlist_union_maybe_complement_2nd(ssc->invlist,
1470                                         invlist,
1471                                         invert2nd,
1472                                         &ssc->invlist);
1473 }
1474
1475 PERL_STATIC_INLINE void
1476 S_ssc_intersection(pTHX_ regnode_ssc *ssc,
1477                          SV* const invlist,
1478                          const bool invert2nd)
1479 {
1480     PERL_ARGS_ASSERT_SSC_INTERSECTION;
1481
1482     assert(is_ANYOF_SYNTHETIC(ssc));
1483
1484     _invlist_intersection_maybe_complement_2nd(ssc->invlist,
1485                                                invlist,
1486                                                invert2nd,
1487                                                &ssc->invlist);
1488 }
1489
1490 PERL_STATIC_INLINE void
1491 S_ssc_add_range(pTHX_ regnode_ssc *ssc, const UV start, const UV end)
1492 {
1493     PERL_ARGS_ASSERT_SSC_ADD_RANGE;
1494
1495     assert(is_ANYOF_SYNTHETIC(ssc));
1496
1497     ssc->invlist = _add_range_to_invlist(ssc->invlist, start, end);
1498 }
1499
1500 PERL_STATIC_INLINE void
1501 S_ssc_cp_and(pTHX_ regnode_ssc *ssc, const UV cp)
1502 {
1503     /* AND just the single code point 'cp' into the SSC 'ssc' */
1504
1505     SV* cp_list = _new_invlist(2);
1506
1507     PERL_ARGS_ASSERT_SSC_CP_AND;
1508
1509     assert(is_ANYOF_SYNTHETIC(ssc));
1510
1511     cp_list = add_cp_to_invlist(cp_list, cp);
1512     ssc_intersection(ssc, cp_list,
1513                      FALSE /* Not inverted */
1514                      );
1515     SvREFCNT_dec_NN(cp_list);
1516 }
1517
1518 PERL_STATIC_INLINE void
1519 S_ssc_clear_locale(regnode_ssc *ssc)
1520 {
1521     /* Set the SSC 'ssc' to not match any locale things */
1522     PERL_ARGS_ASSERT_SSC_CLEAR_LOCALE;
1523
1524     assert(is_ANYOF_SYNTHETIC(ssc));
1525
1526     ANYOF_POSIXL_ZERO(ssc);
1527     ANYOF_FLAGS(ssc) &= ~ANYOF_LOCALE_FLAGS;
1528 }
1529
1530 #define NON_OTHER_COUNT   NON_OTHER_COUNT_FOR_USE_ONLY_BY_REGCOMP_DOT_C
1531
1532 STATIC bool
1533 S_is_ssc_worth_it(const RExC_state_t * pRExC_state, const regnode_ssc * ssc)
1534 {
1535     /* The synthetic start class is used to hopefully quickly winnow down
1536      * places where a pattern could start a match in the target string.  If it
1537      * doesn't really narrow things down that much, there isn't much point to
1538      * having the overhead of using it.  This function uses some very crude
1539      * heuristics to decide if to use the ssc or not.
1540      *
1541      * It returns TRUE if 'ssc' rules out more than half what it considers to
1542      * be the "likely" possible matches, but of course it doesn't know what the
1543      * actual things being matched are going to be; these are only guesses
1544      *
1545      * For /l matches, it assumes that the only likely matches are going to be
1546      *      in the 0-255 range, uniformly distributed, so half of that is 127
1547      * For /a and /d matches, it assumes that the likely matches will be just
1548      *      the ASCII range, so half of that is 63
1549      * For /u and there isn't anything matching above the Latin1 range, it
1550      *      assumes that that is the only range likely to be matched, and uses
1551      *      half that as the cut-off: 127.  If anything matches above Latin1,
1552      *      it assumes that all of Unicode could match (uniformly), except for
1553      *      non-Unicode code points and things in the General Category "Other"
1554      *      (unassigned, private use, surrogates, controls and formats).  This
1555      *      is a much large number. */
1556
1557     const U32 max_match = (LOC)
1558                           ? 127
1559                           : (! UNI_SEMANTICS)
1560                             ? 63
1561                             : (invlist_highest(ssc->invlist) < 256)
1562                               ? 127
1563                               : ((NON_OTHER_COUNT + 1) / 2) - 1;
1564     U32 count = 0;      /* Running total of number of code points matched by
1565                            'ssc' */
1566     UV start, end;      /* Start and end points of current range in inversion
1567                            list */
1568
1569     PERL_ARGS_ASSERT_IS_SSC_WORTH_IT;
1570
1571     invlist_iterinit(ssc->invlist);
1572     while (invlist_iternext(ssc->invlist, &start, &end)) {
1573
1574         /* /u is the only thing that we expect to match above 255; so if not /u
1575          * and even if there are matches above 255, ignore them.  This catches
1576          * things like \d under /d which does match the digits above 255, but
1577          * since the pattern is /d, it is not likely to be expecting them */
1578         if (! UNI_SEMANTICS) {
1579             if (start > 255) {
1580                 break;
1581             }
1582             end = MIN(end, 255);
1583         }
1584         count += end - start + 1;
1585         if (count > max_match) {
1586             invlist_iterfinish(ssc->invlist);
1587             return FALSE;
1588         }
1589     }
1590
1591     return TRUE;
1592 }
1593
1594
1595 STATIC void
1596 S_ssc_finalize(pTHX_ RExC_state_t *pRExC_state, regnode_ssc *ssc)
1597 {
1598     /* The inversion list in the SSC is marked mortal; now we need a more
1599      * permanent copy, which is stored the same way that is done in a regular
1600      * ANYOF node, with the first NUM_ANYOF_CODE_POINTS code points in a bit
1601      * map */
1602
1603     SV* invlist = invlist_clone(ssc->invlist);
1604
1605     PERL_ARGS_ASSERT_SSC_FINALIZE;
1606
1607     assert(is_ANYOF_SYNTHETIC(ssc));
1608
1609     /* The code in this file assumes that all but these flags aren't relevant
1610      * to the SSC, except SSC_MATCHES_EMPTY_STRING, which should be cleared
1611      * by the time we reach here */
1612     assert(! (ANYOF_FLAGS(ssc) & ~ANYOF_COMMON_FLAGS));
1613
1614     populate_ANYOF_from_invlist( (regnode *) ssc, &invlist);
1615
1616     set_ANYOF_arg(pRExC_state, (regnode *) ssc, invlist,
1617                                 NULL, NULL, NULL, FALSE);
1618
1619     /* Make sure is clone-safe */
1620     ssc->invlist = NULL;
1621
1622     if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
1623         ANYOF_FLAGS(ssc) |= ANYOF_MATCHES_POSIXL;
1624     }
1625
1626     assert(! (ANYOF_FLAGS(ssc) & ANYOF_LOCALE_FLAGS) || RExC_contains_locale);
1627 }
1628
1629 #define TRIE_LIST_ITEM(state,idx) (trie->states[state].trans.list)[ idx ]
1630 #define TRIE_LIST_CUR(state)  ( TRIE_LIST_ITEM( state, 0 ).forid )
1631 #define TRIE_LIST_LEN(state) ( TRIE_LIST_ITEM( state, 0 ).newstate )
1632 #define TRIE_LIST_USED(idx)  ( trie->states[state].trans.list         \
1633                                ? (TRIE_LIST_CUR( idx ) - 1)           \
1634                                : 0 )
1635
1636
1637 #ifdef DEBUGGING
1638 /*
1639    dump_trie(trie,widecharmap,revcharmap)
1640    dump_trie_interim_list(trie,widecharmap,revcharmap,next_alloc)
1641    dump_trie_interim_table(trie,widecharmap,revcharmap,next_alloc)
1642
1643    These routines dump out a trie in a somewhat readable format.
1644    The _interim_ variants are used for debugging the interim
1645    tables that are used to generate the final compressed
1646    representation which is what dump_trie expects.
1647
1648    Part of the reason for their existence is to provide a form
1649    of documentation as to how the different representations function.
1650
1651 */
1652
1653 /*
1654   Dumps the final compressed table form of the trie to Perl_debug_log.
1655   Used for debugging make_trie().
1656 */
1657
1658 STATIC void
1659 S_dump_trie(pTHX_ const struct _reg_trie_data *trie, HV *widecharmap,
1660             AV *revcharmap, U32 depth)
1661 {
1662     U32 state;
1663     SV *sv=sv_newmortal();
1664     int colwidth= widecharmap ? 6 : 4;
1665     U16 word;
1666     GET_RE_DEBUG_FLAGS_DECL;
1667
1668     PERL_ARGS_ASSERT_DUMP_TRIE;
1669
1670     PerlIO_printf( Perl_debug_log, "%*sChar : %-6s%-6s%-4s ",
1671         (int)depth * 2 + 2,"",
1672         "Match","Base","Ofs" );
1673
1674     for( state = 0 ; state < trie->uniquecharcount ; state++ ) {
1675         SV ** const tmp = av_fetch( revcharmap, state, 0);
1676         if ( tmp ) {
1677             PerlIO_printf( Perl_debug_log, "%*s",
1678                 colwidth,
1679                 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth,
1680                             PL_colors[0], PL_colors[1],
1681                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1682                             PERL_PV_ESCAPE_FIRSTCHAR
1683                 )
1684             );
1685         }
1686     }
1687     PerlIO_printf( Perl_debug_log, "\n%*sState|-----------------------",
1688         (int)depth * 2 + 2,"");
1689
1690     for( state = 0 ; state < trie->uniquecharcount ; state++ )
1691         PerlIO_printf( Perl_debug_log, "%.*s", colwidth, "--------");
1692     PerlIO_printf( Perl_debug_log, "\n");
1693
1694     for( state = 1 ; state < trie->statecount ; state++ ) {
1695         const U32 base = trie->states[ state ].trans.base;
1696
1697         PerlIO_printf( Perl_debug_log, "%*s#%4"UVXf"|",
1698                                        (int)depth * 2 + 2,"", (UV)state);
1699
1700         if ( trie->states[ state ].wordnum ) {
1701             PerlIO_printf( Perl_debug_log, " W%4X",
1702                                            trie->states[ state ].wordnum );
1703         } else {
1704             PerlIO_printf( Perl_debug_log, "%6s", "" );
1705         }
1706
1707         PerlIO_printf( Perl_debug_log, " @%4"UVXf" ", (UV)base );
1708
1709         if ( base ) {
1710             U32 ofs = 0;
1711
1712             while( ( base + ofs  < trie->uniquecharcount ) ||
1713                    ( base + ofs - trie->uniquecharcount < trie->lasttrans
1714                      && trie->trans[ base + ofs - trie->uniquecharcount ].check
1715                                                                     != state))
1716                     ofs++;
1717
1718             PerlIO_printf( Perl_debug_log, "+%2"UVXf"[ ", (UV)ofs);
1719
1720             for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
1721                 if ( ( base + ofs >= trie->uniquecharcount )
1722                         && ( base + ofs - trie->uniquecharcount
1723                                                         < trie->lasttrans )
1724                         && trie->trans[ base + ofs
1725                                     - trie->uniquecharcount ].check == state )
1726                 {
1727                    PerlIO_printf( Perl_debug_log, "%*"UVXf,
1728                     colwidth,
1729                     (UV)trie->trans[ base + ofs
1730                                              - trie->uniquecharcount ].next );
1731                 } else {
1732                     PerlIO_printf( Perl_debug_log, "%*s",colwidth,"   ." );
1733                 }
1734             }
1735
1736             PerlIO_printf( Perl_debug_log, "]");
1737
1738         }
1739         PerlIO_printf( Perl_debug_log, "\n" );
1740     }
1741     PerlIO_printf(Perl_debug_log, "%*sword_info N:(prev,len)=",
1742                                 (int)depth*2, "");
1743     for (word=1; word <= trie->wordcount; word++) {
1744         PerlIO_printf(Perl_debug_log, " %d:(%d,%d)",
1745             (int)word, (int)(trie->wordinfo[word].prev),
1746             (int)(trie->wordinfo[word].len));
1747     }
1748     PerlIO_printf(Perl_debug_log, "\n" );
1749 }
1750 /*
1751   Dumps a fully constructed but uncompressed trie in list form.
1752   List tries normally only are used for construction when the number of
1753   possible chars (trie->uniquecharcount) is very high.
1754   Used for debugging make_trie().
1755 */
1756 STATIC void
1757 S_dump_trie_interim_list(pTHX_ const struct _reg_trie_data *trie,
1758                          HV *widecharmap, AV *revcharmap, U32 next_alloc,
1759                          U32 depth)
1760 {
1761     U32 state;
1762     SV *sv=sv_newmortal();
1763     int colwidth= widecharmap ? 6 : 4;
1764     GET_RE_DEBUG_FLAGS_DECL;
1765
1766     PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_LIST;
1767
1768     /* print out the table precompression.  */
1769     PerlIO_printf( Perl_debug_log, "%*sState :Word | Transition Data\n%*s%s",
1770         (int)depth * 2 + 2,"", (int)depth * 2 + 2,"",
1771         "------:-----+-----------------\n" );
1772
1773     for( state=1 ; state < next_alloc ; state ++ ) {
1774         U16 charid;
1775
1776         PerlIO_printf( Perl_debug_log, "%*s %4"UVXf" :",
1777             (int)depth * 2 + 2,"", (UV)state  );
1778         if ( ! trie->states[ state ].wordnum ) {
1779             PerlIO_printf( Perl_debug_log, "%5s| ","");
1780         } else {
1781             PerlIO_printf( Perl_debug_log, "W%4x| ",
1782                 trie->states[ state ].wordnum
1783             );
1784         }
1785         for( charid = 1 ; charid <= TRIE_LIST_USED( state ) ; charid++ ) {
1786             SV ** const tmp = av_fetch( revcharmap,
1787                                         TRIE_LIST_ITEM(state,charid).forid, 0);
1788             if ( tmp ) {
1789                 PerlIO_printf( Perl_debug_log, "%*s:%3X=%4"UVXf" | ",
1790                     colwidth,
1791                     pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp),
1792                               colwidth,
1793                               PL_colors[0], PL_colors[1],
1794                               (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0)
1795                               | PERL_PV_ESCAPE_FIRSTCHAR
1796                     ) ,
1797                     TRIE_LIST_ITEM(state,charid).forid,
1798                     (UV)TRIE_LIST_ITEM(state,charid).newstate
1799                 );
1800                 if (!(charid % 10))
1801                     PerlIO_printf(Perl_debug_log, "\n%*s| ",
1802                         (int)((depth * 2) + 14), "");
1803             }
1804         }
1805         PerlIO_printf( Perl_debug_log, "\n");
1806     }
1807 }
1808
1809 /*
1810   Dumps a fully constructed but uncompressed trie in table form.
1811   This is the normal DFA style state transition table, with a few
1812   twists to facilitate compression later.
1813   Used for debugging make_trie().
1814 */
1815 STATIC void
1816 S_dump_trie_interim_table(pTHX_ const struct _reg_trie_data *trie,
1817                           HV *widecharmap, AV *revcharmap, U32 next_alloc,
1818                           U32 depth)
1819 {
1820     U32 state;
1821     U16 charid;
1822     SV *sv=sv_newmortal();
1823     int colwidth= widecharmap ? 6 : 4;
1824     GET_RE_DEBUG_FLAGS_DECL;
1825
1826     PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_TABLE;
1827
1828     /*
1829        print out the table precompression so that we can do a visual check
1830        that they are identical.
1831      */
1832
1833     PerlIO_printf( Perl_debug_log, "%*sChar : ",(int)depth * 2 + 2,"" );
1834
1835     for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
1836         SV ** const tmp = av_fetch( revcharmap, charid, 0);
1837         if ( tmp ) {
1838             PerlIO_printf( Perl_debug_log, "%*s",
1839                 colwidth,
1840                 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth,
1841                             PL_colors[0], PL_colors[1],
1842                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1843                             PERL_PV_ESCAPE_FIRSTCHAR
1844                 )
1845             );
1846         }
1847     }
1848
1849     PerlIO_printf( Perl_debug_log, "\n%*sState+-",(int)depth * 2 + 2,"" );
1850
1851     for( charid=0 ; charid < trie->uniquecharcount ; charid++ ) {
1852         PerlIO_printf( Perl_debug_log, "%.*s", colwidth,"--------");
1853     }
1854
1855     PerlIO_printf( Perl_debug_log, "\n" );
1856
1857     for( state=1 ; state < next_alloc ; state += trie->uniquecharcount ) {
1858
1859         PerlIO_printf( Perl_debug_log, "%*s%4"UVXf" : ",
1860             (int)depth * 2 + 2,"",
1861             (UV)TRIE_NODENUM( state ) );
1862
1863         for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
1864             UV v=(UV)SAFE_TRIE_NODENUM( trie->trans[ state + charid ].next );
1865             if (v)
1866                 PerlIO_printf( Perl_debug_log, "%*"UVXf, colwidth, v );
1867             else
1868                 PerlIO_printf( Perl_debug_log, "%*s", colwidth, "." );
1869         }
1870         if ( ! trie->states[ TRIE_NODENUM( state ) ].wordnum ) {
1871             PerlIO_printf( Perl_debug_log, " (%4"UVXf")\n",
1872                                             (UV)trie->trans[ state ].check );
1873         } else {
1874             PerlIO_printf( Perl_debug_log, " (%4"UVXf") W%4X\n",
1875                                             (UV)trie->trans[ state ].check,
1876             trie->states[ TRIE_NODENUM( state ) ].wordnum );
1877         }
1878     }
1879 }
1880
1881 #endif
1882
1883
1884 /* make_trie(startbranch,first,last,tail,word_count,flags,depth)
1885   startbranch: the first branch in the whole branch sequence
1886   first      : start branch of sequence of branch-exact nodes.
1887                May be the same as startbranch
1888   last       : Thing following the last branch.
1889                May be the same as tail.
1890   tail       : item following the branch sequence
1891   count      : words in the sequence
1892   flags      : currently the OP() type we will be building one of /EXACT(|F|FA|FU|FU_SS|L|FLU8)/
1893   depth      : indent depth
1894
1895 Inplace optimizes a sequence of 2 or more Branch-Exact nodes into a TRIE node.
1896
1897 A trie is an N'ary tree where the branches are determined by digital
1898 decomposition of the key. IE, at the root node you look up the 1st character and
1899 follow that branch repeat until you find the end of the branches. Nodes can be
1900 marked as "accepting" meaning they represent a complete word. Eg:
1901
1902   /he|she|his|hers/
1903
1904 would convert into the following structure. Numbers represent states, letters
1905 following numbers represent valid transitions on the letter from that state, if
1906 the number is in square brackets it represents an accepting state, otherwise it
1907 will be in parenthesis.
1908
1909       +-h->+-e->[3]-+-r->(8)-+-s->[9]
1910       |    |
1911       |   (2)
1912       |    |
1913      (1)   +-i->(6)-+-s->[7]
1914       |
1915       +-s->(3)-+-h->(4)-+-e->[5]
1916
1917       Accept Word Mapping: 3=>1 (he),5=>2 (she), 7=>3 (his), 9=>4 (hers)
1918
1919 This shows that when matching against the string 'hers' we will begin at state 1
1920 read 'h' and move to state 2, read 'e' and move to state 3 which is accepting,
1921 then read 'r' and go to state 8 followed by 's' which takes us to state 9 which
1922 is also accepting. Thus we know that we can match both 'he' and 'hers' with a
1923 single traverse. We store a mapping from accepting to state to which word was
1924 matched, and then when we have multiple possibilities we try to complete the
1925 rest of the regex in the order in which they occurred in the alternation.
1926
1927 The only prior NFA like behaviour that would be changed by the TRIE support is
1928 the silent ignoring of duplicate alternations which are of the form:
1929
1930  / (DUPE|DUPE) X? (?{ ... }) Y /x
1931
1932 Thus EVAL blocks following a trie may be called a different number of times with
1933 and without the optimisation. With the optimisations dupes will be silently
1934 ignored. This inconsistent behaviour of EVAL type nodes is well established as
1935 the following demonstrates:
1936
1937  'words'=~/(word|word|word)(?{ print $1 })[xyz]/
1938
1939 which prints out 'word' three times, but
1940
1941  'words'=~/(word|word|word)(?{ print $1 })S/
1942
1943 which doesnt print it out at all. This is due to other optimisations kicking in.
1944
1945 Example of what happens on a structural level:
1946
1947 The regexp /(ac|ad|ab)+/ will produce the following debug output:
1948
1949    1: CURLYM[1] {1,32767}(18)
1950    5:   BRANCH(8)
1951    6:     EXACT <ac>(16)
1952    8:   BRANCH(11)
1953    9:     EXACT <ad>(16)
1954   11:   BRANCH(14)
1955   12:     EXACT <ab>(16)
1956   16:   SUCCEED(0)
1957   17:   NOTHING(18)
1958   18: END(0)
1959
1960 This would be optimizable with startbranch=5, first=5, last=16, tail=16
1961 and should turn into:
1962
1963    1: CURLYM[1] {1,32767}(18)
1964    5:   TRIE(16)
1965         [Words:3 Chars Stored:6 Unique Chars:4 States:5 NCP:1]
1966           <ac>
1967           <ad>
1968           <ab>
1969   16:   SUCCEED(0)
1970   17:   NOTHING(18)
1971   18: END(0)
1972
1973 Cases where tail != last would be like /(?foo|bar)baz/:
1974
1975    1: BRANCH(4)
1976    2:   EXACT <foo>(8)
1977    4: BRANCH(7)
1978    5:   EXACT <bar>(8)
1979    7: TAIL(8)
1980    8: EXACT <baz>(10)
1981   10: END(0)
1982
1983 which would be optimizable with startbranch=1, first=1, last=7, tail=8
1984 and would end up looking like:
1985
1986     1: TRIE(8)
1987       [Words:2 Chars Stored:6 Unique Chars:5 States:7 NCP:1]
1988         <foo>
1989         <bar>
1990    7: TAIL(8)
1991    8: EXACT <baz>(10)
1992   10: END(0)
1993
1994     d = uvchr_to_utf8_flags(d, uv, 0);
1995
1996 is the recommended Unicode-aware way of saying
1997
1998     *(d++) = uv;
1999 */
2000
2001 #define TRIE_STORE_REVCHAR(val)                                            \
2002     STMT_START {                                                           \
2003         if (UTF) {                                                         \
2004             SV *zlopp = newSV(UTF8_MAXBYTES);                              \
2005             unsigned char *flrbbbbb = (unsigned char *) SvPVX(zlopp);      \
2006             unsigned const char *const kapow = uvchr_to_utf8(flrbbbbb, val); \
2007             SvCUR_set(zlopp, kapow - flrbbbbb);                            \
2008             SvPOK_on(zlopp);                                               \
2009             SvUTF8_on(zlopp);                                              \
2010             av_push(revcharmap, zlopp);                                    \
2011         } else {                                                           \
2012             char ooooff = (char)val;                                           \
2013             av_push(revcharmap, newSVpvn(&ooooff, 1));                     \
2014         }                                                                  \
2015         } STMT_END
2016
2017 /* This gets the next character from the input, folding it if not already
2018  * folded. */
2019 #define TRIE_READ_CHAR STMT_START {                                           \
2020     wordlen++;                                                                \
2021     if ( UTF ) {                                                              \
2022         /* if it is UTF then it is either already folded, or does not need    \
2023          * folding */                                                         \
2024         uvc = valid_utf8_to_uvchr( (const U8*) uc, &len);                     \
2025     }                                                                         \
2026     else if (folder == PL_fold_latin1) {                                      \
2027         /* This folder implies Unicode rules, which in the range expressible  \
2028          *  by not UTF is the lower case, with the two exceptions, one of     \
2029          *  which should have been taken care of before calling this */       \
2030         assert(*uc != LATIN_SMALL_LETTER_SHARP_S);                            \
2031         uvc = toLOWER_L1(*uc);                                                \
2032         if (UNLIKELY(uvc == MICRO_SIGN)) uvc = GREEK_SMALL_LETTER_MU;         \
2033         len = 1;                                                              \
2034     } else {                                                                  \
2035         /* raw data, will be folded later if needed */                        \
2036         uvc = (U32)*uc;                                                       \
2037         len = 1;                                                              \
2038     }                                                                         \
2039 } STMT_END
2040
2041
2042
2043 #define TRIE_LIST_PUSH(state,fid,ns) STMT_START {               \
2044     if ( TRIE_LIST_CUR( state ) >=TRIE_LIST_LEN( state ) ) {    \
2045         U32 ging = TRIE_LIST_LEN( state ) *= 2;                 \
2046         Renew( trie->states[ state ].trans.list, ging, reg_trie_trans_le ); \
2047     }                                                           \
2048     TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).forid = fid;     \
2049     TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).newstate = ns;   \
2050     TRIE_LIST_CUR( state )++;                                   \
2051 } STMT_END
2052
2053 #define TRIE_LIST_NEW(state) STMT_START {                       \
2054     Newxz( trie->states[ state ].trans.list,               \
2055         4, reg_trie_trans_le );                                 \
2056      TRIE_LIST_CUR( state ) = 1;                                \
2057      TRIE_LIST_LEN( state ) = 4;                                \
2058 } STMT_END
2059
2060 #define TRIE_HANDLE_WORD(state) STMT_START {                    \
2061     U16 dupe= trie->states[ state ].wordnum;                    \
2062     regnode * const noper_next = regnext( noper );              \
2063                                                                 \
2064     DEBUG_r({                                                   \
2065         /* store the word for dumping */                        \
2066         SV* tmp;                                                \
2067         if (OP(noper) != NOTHING)                               \
2068             tmp = newSVpvn_utf8(STRING(noper), STR_LEN(noper), UTF);    \
2069         else                                                    \
2070             tmp = newSVpvn_utf8( "", 0, UTF );                  \
2071         av_push( trie_words, tmp );                             \
2072     });                                                         \
2073                                                                 \
2074     curword++;                                                  \
2075     trie->wordinfo[curword].prev   = 0;                         \
2076     trie->wordinfo[curword].len    = wordlen;                   \
2077     trie->wordinfo[curword].accept = state;                     \
2078                                                                 \
2079     if ( noper_next < tail ) {                                  \
2080         if (!trie->jump)                                        \
2081             trie->jump = (U16 *) PerlMemShared_calloc( word_count + 1, \
2082                                                  sizeof(U16) ); \
2083         trie->jump[curword] = (U16)(noper_next - convert);      \
2084         if (!jumper)                                            \
2085             jumper = noper_next;                                \
2086         if (!nextbranch)                                        \
2087             nextbranch= regnext(cur);                           \
2088     }                                                           \
2089                                                                 \
2090     if ( dupe ) {                                               \
2091         /* It's a dupe. Pre-insert into the wordinfo[].prev   */\
2092         /* chain, so that when the bits of chain are later    */\
2093         /* linked together, the dups appear in the chain      */\
2094         trie->wordinfo[curword].prev = trie->wordinfo[dupe].prev; \
2095         trie->wordinfo[dupe].prev = curword;                    \
2096     } else {                                                    \
2097         /* we haven't inserted this word yet.                */ \
2098         trie->states[ state ].wordnum = curword;                \
2099     }                                                           \
2100 } STMT_END
2101
2102
2103 #define TRIE_TRANS_STATE(state,base,ucharcount,charid,special)          \
2104      ( ( base + charid >=  ucharcount                                   \
2105          && base + charid < ubound                                      \
2106          && state == trie->trans[ base - ucharcount + charid ].check    \
2107          && trie->trans[ base - ucharcount + charid ].next )            \
2108            ? trie->trans[ base - ucharcount + charid ].next             \
2109            : ( state==1 ? special : 0 )                                 \
2110       )
2111
2112 #define MADE_TRIE       1
2113 #define MADE_JUMP_TRIE  2
2114 #define MADE_EXACT_TRIE 4
2115
2116 STATIC I32
2117 S_make_trie(pTHX_ RExC_state_t *pRExC_state, regnode *startbranch,
2118                   regnode *first, regnode *last, regnode *tail,
2119                   U32 word_count, U32 flags, U32 depth)
2120 {
2121     /* first pass, loop through and scan words */
2122     reg_trie_data *trie;
2123     HV *widecharmap = NULL;
2124     AV *revcharmap = newAV();
2125     regnode *cur;
2126     STRLEN len = 0;
2127     UV uvc = 0;
2128     U16 curword = 0;
2129     U32 next_alloc = 0;
2130     regnode *jumper = NULL;
2131     regnode *nextbranch = NULL;
2132     regnode *convert = NULL;
2133     U32 *prev_states; /* temp array mapping each state to previous one */
2134     /* we just use folder as a flag in utf8 */
2135     const U8 * folder = NULL;
2136
2137 #ifdef DEBUGGING
2138     const U32 data_slot = add_data( pRExC_state, STR_WITH_LEN("tuuu"));
2139     AV *trie_words = NULL;
2140     /* along with revcharmap, this only used during construction but both are
2141      * useful during debugging so we store them in the struct when debugging.
2142      */
2143 #else
2144     const U32 data_slot = add_data( pRExC_state, STR_WITH_LEN("tu"));
2145     STRLEN trie_charcount=0;
2146 #endif
2147     SV *re_trie_maxbuff;
2148     GET_RE_DEBUG_FLAGS_DECL;
2149
2150     PERL_ARGS_ASSERT_MAKE_TRIE;
2151 #ifndef DEBUGGING
2152     PERL_UNUSED_ARG(depth);
2153 #endif
2154
2155     switch (flags) {
2156         case EXACT: case EXACTL: break;
2157         case EXACTFA:
2158         case EXACTFU_SS:
2159         case EXACTFU:
2160         case EXACTFLU8: folder = PL_fold_latin1; break;
2161         case EXACTF:  folder = PL_fold; break;
2162         default: Perl_croak( aTHX_ "panic! In trie construction, unknown node type %u %s", (unsigned) flags, PL_reg_name[flags] );
2163     }
2164
2165     trie = (reg_trie_data *) PerlMemShared_calloc( 1, sizeof(reg_trie_data) );
2166     trie->refcount = 1;
2167     trie->startstate = 1;
2168     trie->wordcount = word_count;
2169     RExC_rxi->data->data[ data_slot ] = (void*)trie;
2170     trie->charmap = (U16 *) PerlMemShared_calloc( 256, sizeof(U16) );
2171     if (flags == EXACT || flags == EXACTL)
2172         trie->bitmap = (char *) PerlMemShared_calloc( ANYOF_BITMAP_SIZE, 1 );
2173     trie->wordinfo = (reg_trie_wordinfo *) PerlMemShared_calloc(
2174                        trie->wordcount+1, sizeof(reg_trie_wordinfo));
2175
2176     DEBUG_r({
2177         trie_words = newAV();
2178     });
2179
2180     re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
2181     assert(re_trie_maxbuff);
2182     if (!SvIOK(re_trie_maxbuff)) {
2183         sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
2184     }
2185     DEBUG_TRIE_COMPILE_r({
2186         PerlIO_printf( Perl_debug_log,
2187           "%*smake_trie start==%d, first==%d, last==%d, tail==%d depth=%d\n",
2188           (int)depth * 2 + 2, "",
2189           REG_NODE_NUM(startbranch),REG_NODE_NUM(first),
2190           REG_NODE_NUM(last), REG_NODE_NUM(tail), (int)depth);
2191     });
2192
2193    /* Find the node we are going to overwrite */
2194     if ( first == startbranch && OP( last ) != BRANCH ) {
2195         /* whole branch chain */
2196         convert = first;
2197     } else {
2198         /* branch sub-chain */
2199         convert = NEXTOPER( first );
2200     }
2201
2202     /*  -- First loop and Setup --
2203
2204        We first traverse the branches and scan each word to determine if it
2205        contains widechars, and how many unique chars there are, this is
2206        important as we have to build a table with at least as many columns as we
2207        have unique chars.
2208
2209        We use an array of integers to represent the character codes 0..255
2210        (trie->charmap) and we use a an HV* to store Unicode characters. We use
2211        the native representation of the character value as the key and IV's for
2212        the coded index.
2213
2214        *TODO* If we keep track of how many times each character is used we can
2215        remap the columns so that the table compression later on is more
2216        efficient in terms of memory by ensuring the most common value is in the
2217        middle and the least common are on the outside.  IMO this would be better
2218        than a most to least common mapping as theres a decent chance the most
2219        common letter will share a node with the least common, meaning the node
2220        will not be compressible. With a middle is most common approach the worst
2221        case is when we have the least common nodes twice.
2222
2223      */
2224
2225     for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
2226         regnode *noper = NEXTOPER( cur );
2227         const U8 *uc = (U8*)STRING( noper );
2228         const U8 *e  = uc + STR_LEN( noper );
2229         int foldlen = 0;
2230         U32 wordlen      = 0;         /* required init */
2231         STRLEN minchars = 0;
2232         STRLEN maxchars = 0;
2233         bool set_bit = trie->bitmap ? 1 : 0; /*store the first char in the
2234                                                bitmap?*/
2235
2236         if (OP(noper) == NOTHING) {
2237             regnode *noper_next= regnext(noper);
2238             if (noper_next != tail && OP(noper_next) == flags) {
2239                 noper = noper_next;
2240                 uc= (U8*)STRING(noper);
2241                 e= uc + STR_LEN(noper);
2242                 trie->minlen= STR_LEN(noper);
2243             } else {
2244                 trie->minlen= 0;
2245                 continue;
2246             }
2247         }
2248
2249         if ( set_bit ) { /* bitmap only alloced when !(UTF&&Folding) */
2250             TRIE_BITMAP_SET(trie,*uc); /* store the raw first byte
2251                                           regardless of encoding */
2252             if (OP( noper ) == EXACTFU_SS) {
2253                 /* false positives are ok, so just set this */
2254                 TRIE_BITMAP_SET(trie, LATIN_SMALL_LETTER_SHARP_S);
2255             }
2256         }
2257         for ( ; uc < e ; uc += len ) {  /* Look at each char in the current
2258                                            branch */
2259             TRIE_CHARCOUNT(trie)++;
2260             TRIE_READ_CHAR;
2261
2262             /* TRIE_READ_CHAR returns the current character, or its fold if /i
2263              * is in effect.  Under /i, this character can match itself, or
2264              * anything that folds to it.  If not under /i, it can match just
2265              * itself.  Most folds are 1-1, for example k, K, and KELVIN SIGN
2266              * all fold to k, and all are single characters.   But some folds
2267              * expand to more than one character, so for example LATIN SMALL
2268              * LIGATURE FFI folds to the three character sequence 'ffi'.  If
2269              * the string beginning at 'uc' is 'ffi', it could be matched by
2270              * three characters, or just by the one ligature character. (It
2271              * could also be matched by two characters: LATIN SMALL LIGATURE FF
2272              * followed by 'i', or by 'f' followed by LATIN SMALL LIGATURE FI).
2273              * (Of course 'I' and/or 'F' instead of 'i' and 'f' can also
2274              * match.)  The trie needs to know the minimum and maximum number
2275              * of characters that could match so that it can use size alone to
2276              * quickly reject many match attempts.  The max is simple: it is
2277              * the number of folded characters in this branch (since a fold is
2278              * never shorter than what folds to it. */
2279
2280             maxchars++;
2281
2282             /* And the min is equal to the max if not under /i (indicated by
2283              * 'folder' being NULL), or there are no multi-character folds.  If
2284              * there is a multi-character fold, the min is incremented just
2285              * once, for the character that folds to the sequence.  Each
2286              * character in the sequence needs to be added to the list below of
2287              * characters in the trie, but we count only the first towards the
2288              * min number of characters needed.  This is done through the
2289              * variable 'foldlen', which is returned by the macros that look
2290              * for these sequences as the number of bytes the sequence
2291              * occupies.  Each time through the loop, we decrement 'foldlen' by
2292              * how many bytes the current char occupies.  Only when it reaches
2293              * 0 do we increment 'minchars' or look for another multi-character
2294              * sequence. */
2295             if (folder == NULL) {
2296                 minchars++;
2297             }
2298             else if (foldlen > 0) {
2299                 foldlen -= (UTF) ? UTF8SKIP(uc) : 1;
2300             }
2301             else {
2302                 minchars++;
2303
2304                 /* See if *uc is the beginning of a multi-character fold.  If
2305                  * so, we decrement the length remaining to look at, to account
2306                  * for the current character this iteration.  (We can use 'uc'
2307                  * instead of the fold returned by TRIE_READ_CHAR because for
2308                  * non-UTF, the latin1_safe macro is smart enough to account
2309                  * for all the unfolded characters, and because for UTF, the
2310                  * string will already have been folded earlier in the
2311                  * compilation process */
2312                 if (UTF) {
2313                     if ((foldlen = is_MULTI_CHAR_FOLD_utf8_safe(uc, e))) {
2314                         foldlen -= UTF8SKIP(uc);
2315                     }
2316                 }
2317                 else if ((foldlen = is_MULTI_CHAR_FOLD_latin1_safe(uc, e))) {
2318                     foldlen--;
2319                 }
2320             }
2321
2322             /* The current character (and any potential folds) should be added
2323              * to the possible matching characters for this position in this
2324              * branch */
2325             if ( uvc < 256 ) {
2326                 if ( folder ) {
2327                     U8 folded= folder[ (U8) uvc ];
2328                     if ( !trie->charmap[ folded ] ) {
2329                         trie->charmap[ folded ]=( ++trie->uniquecharcount );
2330                         TRIE_STORE_REVCHAR( folded );
2331                     }
2332                 }
2333                 if ( !trie->charmap[ uvc ] ) {
2334                     trie->charmap[ uvc ]=( ++trie->uniquecharcount );
2335                     TRIE_STORE_REVCHAR( uvc );
2336                 }
2337                 if ( set_bit ) {
2338                     /* store the codepoint in the bitmap, and its folded
2339                      * equivalent. */
2340                     TRIE_BITMAP_SET(trie, uvc);
2341
2342                     /* store the folded codepoint */
2343                     if ( folder ) TRIE_BITMAP_SET(trie, folder[(U8) uvc ]);
2344
2345                     if ( !UTF ) {
2346                         /* store first byte of utf8 representation of
2347                            variant codepoints */
2348                         if (! UVCHR_IS_INVARIANT(uvc)) {
2349                             TRIE_BITMAP_SET(trie, UTF8_TWO_BYTE_HI(uvc));
2350                         }
2351                     }
2352                     set_bit = 0; /* We've done our bit :-) */
2353                 }
2354             } else {
2355
2356                 /* XXX We could come up with the list of code points that fold
2357                  * to this using PL_utf8_foldclosures, except not for
2358                  * multi-char folds, as there may be multiple combinations
2359                  * there that could work, which needs to wait until runtime to
2360                  * resolve (The comment about LIGATURE FFI above is such an
2361                  * example */
2362
2363                 SV** svpp;
2364                 if ( !widecharmap )
2365                     widecharmap = newHV();
2366
2367                 svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 1 );
2368
2369                 if ( !svpp )
2370                     Perl_croak( aTHX_ "error creating/fetching widecharmap entry for 0x%"UVXf, uvc );
2371
2372                 if ( !SvTRUE( *svpp ) ) {
2373                     sv_setiv( *svpp, ++trie->uniquecharcount );
2374                     TRIE_STORE_REVCHAR(uvc);
2375                 }
2376             }
2377         } /* end loop through characters in this branch of the trie */
2378
2379         /* We take the min and max for this branch and combine to find the min
2380          * and max for all branches processed so far */
2381         if( cur == first ) {
2382             trie->minlen = minchars;
2383             trie->maxlen = maxchars;
2384         } else if (minchars < trie->minlen) {
2385             trie->minlen = minchars;
2386         } else if (maxchars > trie->maxlen) {
2387             trie->maxlen = maxchars;
2388         }
2389     } /* end first pass */
2390     DEBUG_TRIE_COMPILE_r(
2391         PerlIO_printf( Perl_debug_log,
2392                 "%*sTRIE(%s): W:%d C:%d Uq:%d Min:%d Max:%d\n",
2393                 (int)depth * 2 + 2,"",
2394                 ( widecharmap ? "UTF8" : "NATIVE" ), (int)word_count,
2395                 (int)TRIE_CHARCOUNT(trie), trie->uniquecharcount,
2396                 (int)trie->minlen, (int)trie->maxlen )
2397     );
2398
2399     /*
2400         We now know what we are dealing with in terms of unique chars and
2401         string sizes so we can calculate how much memory a naive
2402         representation using a flat table  will take. If it's over a reasonable
2403         limit (as specified by ${^RE_TRIE_MAXBUF}) we use a more memory
2404         conservative but potentially much slower representation using an array
2405         of lists.
2406
2407         At the end we convert both representations into the same compressed
2408         form that will be used in regexec.c for matching with. The latter
2409         is a form that cannot be used to construct with but has memory
2410         properties similar to the list form and access properties similar
2411         to the table form making it both suitable for fast searches and
2412         small enough that its feasable to store for the duration of a program.
2413
2414         See the comment in the code where the compressed table is produced
2415         inplace from the flat tabe representation for an explanation of how
2416         the compression works.
2417
2418     */
2419
2420
2421     Newx(prev_states, TRIE_CHARCOUNT(trie) + 2, U32);
2422     prev_states[1] = 0;
2423
2424     if ( (IV)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1)
2425                                                     > SvIV(re_trie_maxbuff) )
2426     {
2427         /*
2428             Second Pass -- Array Of Lists Representation
2429
2430             Each state will be represented by a list of charid:state records
2431             (reg_trie_trans_le) the first such element holds the CUR and LEN
2432             points of the allocated array. (See defines above).
2433
2434             We build the initial structure using the lists, and then convert
2435             it into the compressed table form which allows faster lookups
2436             (but cant be modified once converted).
2437         */
2438
2439         STRLEN transcount = 1;
2440
2441         DEBUG_TRIE_COMPILE_MORE_r( PerlIO_printf( Perl_debug_log,
2442             "%*sCompiling trie using list compiler\n",
2443             (int)depth * 2 + 2, ""));
2444
2445         trie->states = (reg_trie_state *)
2446             PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
2447                                   sizeof(reg_trie_state) );
2448         TRIE_LIST_NEW(1);
2449         next_alloc = 2;
2450
2451         for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
2452
2453             regnode *noper   = NEXTOPER( cur );
2454             U8 *uc           = (U8*)STRING( noper );
2455             const U8 *e      = uc + STR_LEN( noper );
2456             U32 state        = 1;         /* required init */
2457             U16 charid       = 0;         /* sanity init */
2458             U32 wordlen      = 0;         /* required init */
2459
2460             if (OP(noper) == NOTHING) {
2461                 regnode *noper_next= regnext(noper);
2462                 if (noper_next != tail && OP(noper_next) == flags) {
2463                     noper = noper_next;
2464                     uc= (U8*)STRING(noper);
2465                     e= uc + STR_LEN(noper);
2466                 }
2467             }
2468
2469             if (OP(noper) != NOTHING) {
2470                 for ( ; uc < e ; uc += len ) {
2471
2472                     TRIE_READ_CHAR;
2473
2474                     if ( uvc < 256 ) {
2475                         charid = trie->charmap[ uvc ];
2476                     } else {
2477                         SV** const svpp = hv_fetch( widecharmap,
2478                                                     (char*)&uvc,
2479                                                     sizeof( UV ),
2480                                                     0);
2481                         if ( !svpp ) {
2482                             charid = 0;
2483                         } else {
2484                             charid=(U16)SvIV( *svpp );
2485                         }
2486                     }
2487                     /* charid is now 0 if we dont know the char read, or
2488                      * nonzero if we do */
2489                     if ( charid ) {
2490
2491                         U16 check;
2492                         U32 newstate = 0;
2493
2494                         charid--;
2495                         if ( !trie->states[ state ].trans.list ) {
2496                             TRIE_LIST_NEW( state );
2497                         }
2498                         for ( check = 1;
2499                               check <= TRIE_LIST_USED( state );
2500                               check++ )
2501                         {
2502                             if ( TRIE_LIST_ITEM( state, check ).forid
2503                                                                     == charid )
2504                             {
2505                                 newstate = TRIE_LIST_ITEM( state, check ).newstate;
2506                                 break;
2507                             }
2508                         }
2509                         if ( ! newstate ) {
2510                             newstate = next_alloc++;
2511                             prev_states[newstate] = state;
2512                             TRIE_LIST_PUSH( state, charid, newstate );
2513                             transcount++;
2514                         }
2515                         state = newstate;
2516                     } else {
2517                         Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %"IVdf, uvc );
2518                     }
2519                 }
2520             }
2521             TRIE_HANDLE_WORD(state);
2522
2523         } /* end second pass */
2524
2525         /* next alloc is the NEXT state to be allocated */
2526         trie->statecount = next_alloc;
2527         trie->states = (reg_trie_state *)
2528             PerlMemShared_realloc( trie->states,
2529                                    next_alloc
2530                                    * sizeof(reg_trie_state) );
2531
2532         /* and now dump it out before we compress it */
2533         DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_list(trie, widecharmap,
2534                                                          revcharmap, next_alloc,
2535                                                          depth+1)
2536         );
2537
2538         trie->trans = (reg_trie_trans *)
2539             PerlMemShared_calloc( transcount, sizeof(reg_trie_trans) );
2540         {
2541             U32 state;
2542             U32 tp = 0;
2543             U32 zp = 0;
2544
2545
2546             for( state=1 ; state < next_alloc ; state ++ ) {
2547                 U32 base=0;
2548
2549                 /*
2550                 DEBUG_TRIE_COMPILE_MORE_r(
2551                     PerlIO_printf( Perl_debug_log, "tp: %d zp: %d ",tp,zp)
2552                 );
2553                 */
2554
2555                 if (trie->states[state].trans.list) {
2556                     U16 minid=TRIE_LIST_ITEM( state, 1).forid;
2557                     U16 maxid=minid;
2558                     U16 idx;
2559
2560                     for( idx = 2 ; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
2561                         const U16 forid = TRIE_LIST_ITEM( state, idx).forid;
2562                         if ( forid < minid ) {
2563                             minid=forid;
2564                         } else if ( forid > maxid ) {
2565                             maxid=forid;
2566                         }
2567                     }
2568                     if ( transcount < tp + maxid - minid + 1) {
2569                         transcount *= 2;
2570                         trie->trans = (reg_trie_trans *)
2571                             PerlMemShared_realloc( trie->trans,
2572                                                      transcount
2573                                                      * sizeof(reg_trie_trans) );
2574                         Zero( trie->trans + (transcount / 2),
2575                               transcount / 2,
2576                               reg_trie_trans );
2577                     }
2578                     base = trie->uniquecharcount + tp - minid;
2579                     if ( maxid == minid ) {
2580                         U32 set = 0;
2581                         for ( ; zp < tp ; zp++ ) {
2582                             if ( ! trie->trans[ zp ].next ) {
2583                                 base = trie->uniquecharcount + zp - minid;
2584                                 trie->trans[ zp ].next = TRIE_LIST_ITEM( state,
2585                                                                    1).newstate;
2586                                 trie->trans[ zp ].check = state;
2587                                 set = 1;
2588                                 break;
2589                             }
2590                         }
2591                         if ( !set ) {
2592                             trie->trans[ tp ].next = TRIE_LIST_ITEM( state,
2593                                                                    1).newstate;
2594                             trie->trans[ tp ].check = state;
2595                             tp++;
2596                             zp = tp;
2597                         }
2598                     } else {
2599                         for ( idx=1; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
2600                             const U32 tid = base
2601                                            - trie->uniquecharcount
2602                                            + TRIE_LIST_ITEM( state, idx ).forid;
2603                             trie->trans[ tid ].next = TRIE_LIST_ITEM( state,
2604                                                                 idx ).newstate;
2605                             trie->trans[ tid ].check = state;
2606                         }
2607                         tp += ( maxid - minid + 1 );
2608                     }
2609                     Safefree(trie->states[ state ].trans.list);
2610                 }
2611                 /*
2612                 DEBUG_TRIE_COMPILE_MORE_r(
2613                     PerlIO_printf( Perl_debug_log, " base: %d\n",base);
2614                 );
2615                 */
2616                 trie->states[ state ].trans.base=base;
2617             }
2618             trie->lasttrans = tp + 1;
2619         }
2620     } else {
2621         /*
2622            Second Pass -- Flat Table Representation.
2623
2624            we dont use the 0 slot of either trans[] or states[] so we add 1 to
2625            each.  We know that we will need Charcount+1 trans at most to store
2626            the data (one row per char at worst case) So we preallocate both
2627            structures assuming worst case.
2628
2629            We then construct the trie using only the .next slots of the entry
2630            structs.
2631
2632            We use the .check field of the first entry of the node temporarily
2633            to make compression both faster and easier by keeping track of how
2634            many non zero fields are in the node.
2635
2636            Since trans are numbered from 1 any 0 pointer in the table is a FAIL
2637            transition.
2638
2639            There are two terms at use here: state as a TRIE_NODEIDX() which is
2640            a number representing the first entry of the node, and state as a
2641            TRIE_NODENUM() which is the trans number. state 1 is TRIE_NODEIDX(1)
2642            and TRIE_NODENUM(1), state 2 is TRIE_NODEIDX(2) and TRIE_NODENUM(3)
2643            if there are 2 entrys per node. eg:
2644
2645              A B       A B
2646           1. 2 4    1. 3 7
2647           2. 0 3    3. 0 5
2648           3. 0 0    5. 0 0
2649           4. 0 0    7. 0 0
2650
2651            The table is internally in the right hand, idx form. However as we
2652            also have to deal with the states array which is indexed by nodenum
2653            we have to use TRIE_NODENUM() to convert.
2654
2655         */
2656         DEBUG_TRIE_COMPILE_MORE_r( PerlIO_printf( Perl_debug_log,
2657             "%*sCompiling trie using table compiler\n",
2658             (int)depth * 2 + 2, ""));
2659
2660         trie->trans = (reg_trie_trans *)
2661             PerlMemShared_calloc( ( TRIE_CHARCOUNT(trie) + 1 )
2662                                   * trie->uniquecharcount + 1,
2663                                   sizeof(reg_trie_trans) );
2664         trie->states = (reg_trie_state *)
2665             PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
2666                                   sizeof(reg_trie_state) );
2667         next_alloc = trie->uniquecharcount + 1;
2668
2669
2670         for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
2671
2672             regnode *noper   = NEXTOPER( cur );
2673             const U8 *uc     = (U8*)STRING( noper );
2674             const U8 *e      = uc + STR_LEN( noper );
2675
2676             U32 state        = 1;         /* required init */
2677
2678             U16 charid       = 0;         /* sanity init */
2679             U32 accept_state = 0;         /* sanity init */
2680
2681             U32 wordlen      = 0;         /* required init */
2682
2683             if (OP(noper) == NOTHING) {
2684                 regnode *noper_next= regnext(noper);
2685                 if (noper_next != tail && OP(noper_next) == flags) {
2686                     noper = noper_next;
2687                     uc= (U8*)STRING(noper);
2688                     e= uc + STR_LEN(noper);
2689                 }
2690             }
2691
2692             if ( OP(noper) != NOTHING ) {
2693                 for ( ; uc < e ; uc += len ) {
2694
2695                     TRIE_READ_CHAR;
2696
2697                     if ( uvc < 256 ) {
2698                         charid = trie->charmap[ uvc ];
2699                     } else {
2700                         SV* const * const svpp = hv_fetch( widecharmap,
2701                                                            (char*)&uvc,
2702                                                            sizeof( UV ),
2703                                                            0);
2704                         charid = svpp ? (U16)SvIV(*svpp) : 0;
2705                     }
2706                     if ( charid ) {
2707                         charid--;
2708                         if ( !trie->trans[ state + charid ].next ) {
2709                             trie->trans[ state + charid ].next = next_alloc;
2710                             trie->trans[ state ].check++;
2711                             prev_states[TRIE_NODENUM(next_alloc)]
2712                                     = TRIE_NODENUM(state);
2713                             next_alloc += trie->uniquecharcount;
2714                         }
2715                         state = trie->trans[ state + charid ].next;
2716                     } else {
2717                         Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %"IVdf, uvc );
2718                     }
2719                     /* charid is now 0 if we dont know the char read, or
2720                      * nonzero if we do */
2721                 }
2722             }
2723             accept_state = TRIE_NODENUM( state );
2724             TRIE_HANDLE_WORD(accept_state);
2725
2726         } /* end second pass */
2727
2728         /* and now dump it out before we compress it */
2729         DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_table(trie, widecharmap,
2730                                                           revcharmap,
2731                                                           next_alloc, depth+1));
2732
2733         {
2734         /*
2735            * Inplace compress the table.*
2736
2737            For sparse data sets the table constructed by the trie algorithm will
2738            be mostly 0/FAIL transitions or to put it another way mostly empty.
2739            (Note that leaf nodes will not contain any transitions.)
2740
2741            This algorithm compresses the tables by eliminating most such
2742            transitions, at the cost of a modest bit of extra work during lookup:
2743
2744            - Each states[] entry contains a .base field which indicates the
2745            index in the state[] array wheres its transition data is stored.
2746
2747            - If .base is 0 there are no valid transitions from that node.
2748
2749            - If .base is nonzero then charid is added to it to find an entry in
2750            the trans array.
2751
2752            -If trans[states[state].base+charid].check!=state then the
2753            transition is taken to be a 0/Fail transition. Thus if there are fail
2754            transitions at the front of the node then the .base offset will point
2755            somewhere inside the previous nodes data (or maybe even into a node
2756            even earlier), but the .check field determines if the transition is
2757            valid.
2758
2759            XXX - wrong maybe?
2760            The following process inplace converts the table to the compressed
2761            table: We first do not compress the root node 1,and mark all its
2762            .check pointers as 1 and set its .base pointer as 1 as well. This
2763            allows us to do a DFA construction from the compressed table later,
2764            and ensures that any .base pointers we calculate later are greater
2765            than 0.
2766
2767            - We set 'pos' to indicate the first entry of the second node.
2768
2769            - We then iterate over the columns of the node, finding the first and
2770            last used entry at l and m. We then copy l..m into pos..(pos+m-l),
2771            and set the .check pointers accordingly, and advance pos
2772            appropriately and repreat for the next node. Note that when we copy
2773            the next pointers we have to convert them from the original
2774            NODEIDX form to NODENUM form as the former is not valid post
2775            compression.
2776
2777            - If a node has no transitions used we mark its base as 0 and do not
2778            advance the pos pointer.
2779
2780            - If a node only has one transition we use a second pointer into the
2781            structure to fill in allocated fail transitions from other states.
2782            This pointer is independent of the main pointer and scans forward
2783            looking for null transitions that are allocated to a state. When it
2784            finds one it writes the single transition into the "hole".  If the
2785            pointer doesnt find one the single transition is appended as normal.
2786
2787            - Once compressed we can Renew/realloc the structures to release the
2788            excess space.
2789
2790            See "Table-Compression Methods" in sec 3.9 of the Red Dragon,
2791            specifically Fig 3.47 and the associated pseudocode.
2792
2793            demq
2794         */
2795         const U32 laststate = TRIE_NODENUM( next_alloc );
2796         U32 state, charid;
2797         U32 pos = 0, zp=0;
2798         trie->statecount = laststate;
2799
2800         for ( state = 1 ; state < laststate ; state++ ) {
2801             U8 flag = 0;
2802             const U32 stateidx = TRIE_NODEIDX( state );
2803             const U32 o_used = trie->trans[ stateidx ].check;
2804             U32 used = trie->trans[ stateidx ].check;
2805             trie->trans[ stateidx ].check = 0;
2806
2807             for ( charid = 0;
2808                   used && charid < trie->uniquecharcount;
2809                   charid++ )
2810             {
2811                 if ( flag || trie->trans[ stateidx + charid ].next ) {
2812                     if ( trie->trans[ stateidx + charid ].next ) {
2813                         if (o_used == 1) {
2814                             for ( ; zp < pos ; zp++ ) {
2815                                 if ( ! trie->trans[ zp ].next ) {
2816                                     break;
2817                                 }
2818                             }
2819                             trie->states[ state ].trans.base
2820                                                     = zp
2821                                                       + trie->uniquecharcount
2822                                                       - charid ;
2823                             trie->trans[ zp ].next
2824                                 = SAFE_TRIE_NODENUM( trie->trans[ stateidx
2825                                                              + charid ].next );
2826                             trie->trans[ zp ].check = state;
2827                             if ( ++zp > pos ) pos = zp;
2828                             break;
2829                         }
2830                         used--;
2831                     }
2832                     if ( !flag ) {
2833                         flag = 1;
2834                         trie->states[ state ].trans.base
2835                                        = pos + trie->uniquecharcount - charid ;
2836                     }
2837                     trie->trans[ pos ].next
2838                         = SAFE_TRIE_NODENUM(
2839                                        trie->trans[ stateidx + charid ].next );
2840                     trie->trans[ pos ].check = state;
2841                     pos++;
2842                 }
2843             }
2844         }
2845         trie->lasttrans = pos + 1;
2846         trie->states = (reg_trie_state *)
2847             PerlMemShared_realloc( trie->states, laststate
2848                                    * sizeof(reg_trie_state) );
2849         DEBUG_TRIE_COMPILE_MORE_r(
2850             PerlIO_printf( Perl_debug_log,
2851                 "%*sAlloc: %d Orig: %"IVdf" elements, Final:%"IVdf". Savings of %%%5.2f\n",
2852                 (int)depth * 2 + 2,"",
2853                 (int)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount
2854                        + 1 ),
2855                 (IV)next_alloc,
2856                 (IV)pos,
2857                 ( ( next_alloc - pos ) * 100 ) / (double)next_alloc );
2858             );
2859
2860         } /* end table compress */
2861     }
2862     DEBUG_TRIE_COMPILE_MORE_r(
2863             PerlIO_printf(Perl_debug_log,
2864                 "%*sStatecount:%"UVxf" Lasttrans:%"UVxf"\n",
2865                 (int)depth * 2 + 2, "",
2866                 (UV)trie->statecount,
2867                 (UV)trie->lasttrans)
2868     );
2869     /* resize the trans array to remove unused space */
2870     trie->trans = (reg_trie_trans *)
2871         PerlMemShared_realloc( trie->trans, trie->lasttrans
2872                                * sizeof(reg_trie_trans) );
2873
2874     {   /* Modify the program and insert the new TRIE node */
2875         U8 nodetype =(U8)(flags & 0xFF);
2876         char *str=NULL;
2877
2878 #ifdef DEBUGGING
2879         regnode *optimize = NULL;
2880 #ifdef RE_TRACK_PATTERN_OFFSETS
2881
2882         U32 mjd_offset = 0;
2883         U32 mjd_nodelen = 0;
2884 #endif /* RE_TRACK_PATTERN_OFFSETS */
2885 #endif /* DEBUGGING */
2886         /*
2887            This means we convert either the first branch or the first Exact,
2888            depending on whether the thing following (in 'last') is a branch
2889            or not and whther first is the startbranch (ie is it a sub part of
2890            the alternation or is it the whole thing.)
2891            Assuming its a sub part we convert the EXACT otherwise we convert
2892            the whole branch sequence, including the first.
2893          */
2894         /* Find the node we are going to overwrite */
2895         if ( first != startbranch || OP( last ) == BRANCH ) {
2896             /* branch sub-chain */
2897             NEXT_OFF( first ) = (U16)(last - first);
2898 #ifdef RE_TRACK_PATTERN_OFFSETS
2899             DEBUG_r({
2900                 mjd_offset= Node_Offset((convert));
2901                 mjd_nodelen= Node_Length((convert));
2902             });
2903 #endif
2904             /* whole branch chain */
2905         }
2906 #ifdef RE_TRACK_PATTERN_OFFSETS
2907         else {
2908             DEBUG_r({
2909                 const  regnode *nop = NEXTOPER( convert );
2910                 mjd_offset= Node_Offset((nop));
2911                 mjd_nodelen= Node_Length((nop));
2912             });
2913         }
2914         DEBUG_OPTIMISE_r(
2915             PerlIO_printf(Perl_debug_log,
2916                 "%*sMJD offset:%"UVuf" MJD length:%"UVuf"\n",
2917                 (int)depth * 2 + 2, "",
2918                 (UV)mjd_offset, (UV)mjd_nodelen)
2919         );
2920 #endif
2921         /* But first we check to see if there is a common prefix we can
2922            split out as an EXACT and put in front of the TRIE node.  */
2923         trie->startstate= 1;
2924         if ( trie->bitmap && !widecharmap && !trie->jump  ) {
2925             U32 state;
2926             for ( state = 1 ; state < trie->statecount-1 ; state++ ) {
2927                 U32 ofs = 0;
2928                 I32 idx = -1;
2929                 U32 count = 0;
2930                 const U32 base = trie->states[ state ].trans.base;
2931
2932                 if ( trie->states[state].wordnum )
2933                         count = 1;
2934
2935                 for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
2936                     if ( ( base + ofs >= trie->uniquecharcount ) &&
2937                          ( base + ofs - trie->uniquecharcount < trie->lasttrans ) &&
2938                          trie->trans[ base + ofs - trie->uniquecharcount ].check == state )
2939                     {
2940                         if ( ++count > 1 ) {
2941                             SV **tmp = av_fetch( revcharmap, ofs, 0);
2942                             const U8 *ch = (U8*)SvPV_nolen_const( *tmp );
2943                             if ( state == 1 ) break;
2944                             if ( count == 2 ) {
2945                                 Zero(trie->bitmap, ANYOF_BITMAP_SIZE, char);
2946                                 DEBUG_OPTIMISE_r(
2947                                     PerlIO_printf(Perl_debug_log,
2948                                         "%*sNew Start State=%"UVuf" Class: [",
2949                                         (int)depth * 2 + 2, "",
2950                                         (UV)state));
2951                                 if (idx >= 0) {
2952                                     SV ** const tmp = av_fetch( revcharmap, idx, 0);
2953                                     const U8 * const ch = (U8*)SvPV_nolen_const( *tmp );
2954
2955                                     TRIE_BITMAP_SET(trie,*ch);
2956                                     if ( folder )
2957                                         TRIE_BITMAP_SET(trie, folder[ *ch ]);
2958                                     DEBUG_OPTIMISE_r(
2959                                         PerlIO_printf(Perl_debug_log, "%s", (char*)ch)
2960                                     );
2961                                 }
2962                             }
2963                             TRIE_BITMAP_SET(trie,*ch);
2964                             if ( folder )
2965                                 TRIE_BITMAP_SET(trie,folder[ *ch ]);
2966                             DEBUG_OPTIMISE_r(PerlIO_printf( Perl_debug_log,"%s", ch));
2967                         }
2968                         idx = ofs;
2969                     }
2970                 }
2971                 if ( count == 1 ) {
2972                     SV **tmp = av_fetch( revcharmap, idx, 0);
2973                     STRLEN len;
2974                     char *ch = SvPV( *tmp, len );
2975                     DEBUG_OPTIMISE_r({
2976                         SV *sv=sv_newmortal();
2977                         PerlIO_printf( Perl_debug_log,
2978                             "%*sPrefix State: %"UVuf" Idx:%"UVuf" Char='%s'\n",
2979                             (int)depth * 2 + 2, "",
2980                             (UV)state, (UV)idx,
2981                             pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), 6,
2982                                 PL_colors[0], PL_colors[1],
2983                                 (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
2984                                 PERL_PV_ESCAPE_FIRSTCHAR
2985                             )
2986                         );
2987                     });
2988                     if ( state==1 ) {
2989                         OP( convert ) = nodetype;
2990                         str=STRING(convert);
2991                         STR_LEN(convert)=0;
2992                     }
2993                     STR_LEN(convert) += len;
2994                     while (len--)
2995                         *str++ = *ch++;
2996                 } else {
2997 #ifdef DEBUGGING
2998                     if (state>1)
2999                         DEBUG_OPTIMISE_r(PerlIO_printf( Perl_debug_log,"]\n"));
3000 #endif
3001                     break;
3002                 }
3003             }
3004             trie->prefixlen = (state-1);
3005             if (str) {
3006                 regnode *n = convert+NODE_SZ_STR(convert);
3007                 NEXT_OFF(convert) = NODE_SZ_STR(convert);
3008                 trie->startstate = state;
3009                 trie->minlen -= (state - 1);
3010                 trie->maxlen -= (state - 1);
3011 #ifdef DEBUGGING
3012                /* At least the UNICOS C compiler choked on this
3013                 * being argument to DEBUG_r(), so let's just have
3014                 * it right here. */
3015                if (
3016 #ifdef PERL_EXT_RE_BUILD
3017                    1
3018 #else
3019                    DEBUG_r_TEST
3020 #endif
3021                    ) {
3022                    regnode *fix = convert;
3023                    U32 word = trie->wordcount;
3024                    mjd_nodelen++;
3025                    Set_Node_Offset_Length(convert, mjd_offset, state - 1);
3026                    while( ++fix < n ) {
3027                        Set_Node_Offset_Length(fix, 0, 0);
3028                    }
3029                    while (word--) {
3030                        SV ** const tmp = av_fetch( trie_words, word, 0 );
3031                        if (tmp) {
3032                            if ( STR_LEN(convert) <= SvCUR(*tmp) )
3033                                sv_chop(*tmp, SvPV_nolen(*tmp) + STR_LEN(convert));
3034                            else
3035                                sv_chop(*tmp, SvPV_nolen(*tmp) + SvCUR(*tmp));
3036                        }
3037                    }
3038                }
3039 #endif
3040                 if (trie->maxlen) {
3041                     convert = n;
3042                 } else {
3043                     NEXT_OFF(convert) = (U16)(tail - convert);
3044                     DEBUG_r(optimize= n);
3045                 }
3046             }
3047         }
3048         if (!jumper)
3049             jumper = last;
3050         if ( trie->maxlen ) {
3051             NEXT_OFF( convert ) = (U16)(tail - convert);
3052             ARG_SET( convert, data_slot );
3053             /* Store the offset to the first unabsorbed branch in
3054                jump[0], which is otherwise unused by the jump logic.
3055                We use this when dumping a trie and during optimisation. */
3056             if (trie->jump)
3057                 trie->jump[0] = (U16)(nextbranch - convert);
3058
3059             /* If the start state is not accepting (meaning there is no empty string/NOTHING)
3060              *   and there is a bitmap
3061              *   and the first "jump target" node we found leaves enough room
3062              * then convert the TRIE node into a TRIEC node, with the bitmap
3063              * embedded inline in the opcode - this is hypothetically faster.
3064              */
3065             if ( !trie->states[trie->startstate].wordnum
3066                  && trie->bitmap
3067                  && ( (char *)jumper - (char *)convert) >= (int)sizeof(struct regnode_charclass) )
3068             {
3069                 OP( convert ) = TRIEC;
3070                 Copy(trie->bitmap, ((struct regnode_charclass *)convert)->bitmap, ANYOF_BITMAP_SIZE, char);
3071                 PerlMemShared_free(trie->bitmap);
3072                 trie->bitmap= NULL;
3073             } else
3074                 OP( convert ) = TRIE;
3075
3076             /* store the type in the flags */
3077             convert->flags = nodetype;
3078             DEBUG_r({
3079             optimize = convert
3080                       + NODE_STEP_REGNODE
3081                       + regarglen[ OP( convert ) ];
3082             });
3083             /* XXX We really should free up the resource in trie now,
3084                    as we won't use them - (which resources?) dmq */
3085         }
3086         /* needed for dumping*/
3087         DEBUG_r(if (optimize) {
3088             regnode *opt = convert;
3089
3090             while ( ++opt < optimize) {
3091                 Set_Node_Offset_Length(opt,0,0);
3092             }
3093             /*
3094                 Try to clean up some of the debris left after the
3095                 optimisation.
3096              */
3097             while( optimize < jumper ) {
3098                 mjd_nodelen += Node_Length((optimize));
3099                 OP( optimize ) = OPTIMIZED;
3100                 Set_Node_Offset_Length(optimize,0,0);
3101                 optimize++;
3102             }
3103             Set_Node_Offset_Length(convert,mjd_offset,mjd_nodelen);
3104         });
3105     } /* end node insert */
3106
3107     /*  Finish populating the prev field of the wordinfo array.  Walk back
3108      *  from each accept state until we find another accept state, and if
3109      *  so, point the first word's .prev field at the second word. If the
3110      *  second already has a .prev field set, stop now. This will be the
3111      *  case either if we've already processed that word's accept state,
3112      *  or that state had multiple words, and the overspill words were
3113      *  already linked up earlier.
3114      */
3115     {
3116         U16 word;
3117         U32 state;
3118         U16 prev;
3119
3120         for (word=1; word <= trie->wordcount; word++) {
3121             prev = 0;
3122             if (trie->wordinfo[word].prev)
3123                 continue;
3124             state = trie->wordinfo[word].accept;
3125             while (state) {
3126                 state = prev_states[state];
3127                 if (!state)
3128                     break;
3129                 prev = trie->states[state].wordnum;
3130                 if (prev)
3131                     break;
3132             }
3133             trie->wordinfo[word].prev = prev;
3134         }
3135         Safefree(prev_states);
3136     }
3137
3138
3139     /* and now dump out the compressed format */
3140     DEBUG_TRIE_COMPILE_r(dump_trie(trie, widecharmap, revcharmap, depth+1));
3141
3142     RExC_rxi->data->data[ data_slot + 1 ] = (void*)widecharmap;
3143 #ifdef DEBUGGING
3144     RExC_rxi->data->data[ data_slot + TRIE_WORDS_OFFSET ] = (void*)trie_words;
3145     RExC_rxi->data->data[ data_slot + 3 ] = (void*)revcharmap;
3146 #else
3147     SvREFCNT_dec_NN(revcharmap);
3148 #endif
3149     return trie->jump
3150            ? MADE_JUMP_TRIE
3151            : trie->startstate>1
3152              ? MADE_EXACT_TRIE
3153              : MADE_TRIE;
3154 }
3155
3156 STATIC regnode *
3157 S_construct_ahocorasick_from_trie(pTHX_ RExC_state_t *pRExC_state, regnode *source, U32 depth)
3158 {
3159 /* The Trie is constructed and compressed now so we can build a fail array if
3160  * it's needed
3161
3162    This is basically the Aho-Corasick algorithm. Its from exercise 3.31 and
3163    3.32 in the
3164    "Red Dragon" -- Compilers, principles, techniques, and tools. Aho, Sethi,
3165    Ullman 1985/88
3166    ISBN 0-201-10088-6
3167
3168    We find the fail state for each state in the trie, this state is the longest
3169    proper suffix of the current state's 'word' that is also a proper prefix of
3170    another word in our trie. State 1 represents the word '' and is thus the
3171    default fail state. This allows the DFA not to have to restart after its
3172    tried and failed a word at a given point, it simply continues as though it
3173    had been matching the other word in the first place.
3174    Consider
3175       'abcdgu'=~/abcdefg|cdgu/
3176    When we get to 'd' we are still matching the first word, we would encounter
3177    'g' which would fail, which would bring us to the state representing 'd' in
3178    the second word where we would try 'g' and succeed, proceeding to match
3179    'cdgu'.
3180  */
3181  /* add a fail transition */
3182     const U32 trie_offset = ARG(source);
3183     reg_trie_data *trie=(reg_trie_data *)RExC_rxi->data->data[trie_offset];
3184     U32 *q;
3185     const U32 ucharcount = trie->uniquecharcount;
3186     const U32 numstates = trie->statecount;
3187     const U32 ubound = trie->lasttrans + ucharcount;
3188     U32 q_read = 0;
3189     U32 q_write = 0;
3190     U32 charid;
3191     U32 base = trie->states[ 1 ].trans.base;
3192     U32 *fail;
3193     reg_ac_data *aho;
3194     const U32 data_slot = add_data( pRExC_state, STR_WITH_LEN("T"));
3195     regnode *stclass;
3196     GET_RE_DEBUG_FLAGS_DECL;
3197
3198     PERL_ARGS_ASSERT_CONSTRUCT_AHOCORASICK_FROM_TRIE;
3199     PERL_UNUSED_CONTEXT;
3200 #ifndef DEBUGGING
3201     PERL_UNUSED_ARG(depth);
3202 #endif
3203
3204     if ( OP(source) == TRIE ) {
3205         struct regnode_1 *op = (struct regnode_1 *)
3206             PerlMemShared_calloc(1, sizeof(struct regnode_1));
3207         StructCopy(source,op,struct regnode_1);
3208         stclass = (regnode *)op;
3209     } else {
3210         struct regnode_charclass *op = (struct regnode_charclass *)
3211             PerlMemShared_calloc(1, sizeof(struct regnode_charclass));
3212         StructCopy(source,op,struct regnode_charclass);
3213         stclass = (regnode *)op;
3214     }
3215     OP(stclass)+=2; /* convert the TRIE type to its AHO-CORASICK equivalent */
3216
3217     ARG_SET( stclass, data_slot );
3218     aho = (reg_ac_data *) PerlMemShared_calloc( 1, sizeof(reg_ac_data) );
3219     RExC_rxi->data->data[ data_slot ] = (void*)aho;
3220     aho->trie=trie_offset;
3221     aho->states=(reg_trie_state *)PerlMemShared_malloc( numstates * sizeof(reg_trie_state) );
3222     Copy( trie->states, aho->states, numstates, reg_trie_state );
3223     Newxz( q, numstates, U32);
3224     aho->fail = (U32 *) PerlMemShared_calloc( numstates, sizeof(U32) );
3225     aho->refcount = 1;
3226     fail = aho->fail;
3227     /* initialize fail[0..1] to be 1 so that we always have
3228        a valid final fail state */
3229     fail[ 0 ] = fail[ 1 ] = 1;
3230
3231     for ( charid = 0; charid < ucharcount ; charid++ ) {
3232         const U32 newstate = TRIE_TRANS_STATE( 1, base, ucharcount, charid, 0 );
3233         if ( newstate ) {
3234             q[ q_write ] = newstate;
3235             /* set to point at the root */
3236             fail[ q[ q_write++ ] ]=1;
3237         }
3238     }
3239     while ( q_read < q_write) {
3240         const U32 cur = q[ q_read++ % numstates ];
3241         base = trie->states[ cur ].trans.base;
3242
3243         for ( charid = 0 ; charid < ucharcount ; charid++ ) {
3244             const U32 ch_state = TRIE_TRANS_STATE( cur, base, ucharcount, charid, 1 );
3245             if (ch_state) {
3246                 U32 fail_state = cur;
3247                 U32 fail_base;
3248                 do {
3249                     fail_state = fail[ fail_state ];
3250                     fail_base = aho->states[ fail_state ].trans.base;
3251                 } while ( !TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 ) );
3252
3253                 fail_state = TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 );
3254                 fail[ ch_state ] = fail_state;
3255                 if ( !aho->states[ ch_state ].wordnum && aho->states[ fail_state ].wordnum )
3256                 {
3257                         aho->states[ ch_state ].wordnum =  aho->states[ fail_state ].wordnum;
3258                 }
3259                 q[ q_write++ % numstates] = ch_state;
3260             }
3261         }
3262     }
3263     /* restore fail[0..1] to 0 so that we "fall out" of the AC loop
3264        when we fail in state 1, this allows us to use the
3265        charclass scan to find a valid start char. This is based on the principle
3266        that theres a good chance the string being searched contains lots of stuff
3267        that cant be a start char.
3268      */
3269     fail[ 0 ] = fail[ 1 ] = 0;
3270     DEBUG_TRIE_COMPILE_r({
3271         PerlIO_printf(Perl_debug_log,
3272                       "%*sStclass Failtable (%"UVuf" states): 0",
3273                       (int)(depth * 2), "", (UV)numstates
3274         );
3275         for( q_read=1; q_read<numstates; q_read++ ) {
3276             PerlIO_printf(Perl_debug_log, ", %"UVuf, (UV)fail[q_read]);
3277         }
3278         PerlIO_printf(Perl_debug_log, "\n");
3279     });
3280     Safefree(q);
3281     /*RExC_seen |= REG_TRIEDFA_SEEN;*/
3282     return stclass;
3283 }
3284
3285
3286 #define DEBUG_PEEP(str,scan,depth) \
3287     DEBUG_OPTIMISE_r({if (scan){ \
3288        regnode *Next = regnext(scan); \
3289        regprop(RExC_rx, RExC_mysv, scan, NULL, pRExC_state); \
3290        PerlIO_printf(Perl_debug_log, "%*s" str ">%3d: %s (%d)", \
3291            (int)depth*2, "", REG_NODE_NUM(scan), SvPV_nolen_const(RExC_mysv),\
3292            Next ? (REG_NODE_NUM(Next)) : 0 ); \
3293        DEBUG_SHOW_STUDY_FLAGS(flags," [ ","]");\
3294        PerlIO_printf(Perl_debug_log, "\n"); \
3295    }});
3296
3297 /* The below joins as many adjacent EXACTish nodes as possible into a single
3298  * one.  The regop may be changed if the node(s) contain certain sequences that
3299  * require special handling.  The joining is only done if:
3300  * 1) there is room in the current conglomerated node to entirely contain the
3301  *    next one.
3302  * 2) they are the exact same node type
3303  *
3304  * The adjacent nodes actually may be separated by NOTHING-kind nodes, and
3305  * these get optimized out
3306  *
3307  * If a node is to match under /i (folded), the number of characters it matches
3308  * can be different than its character length if it contains a multi-character
3309  * fold.  *min_subtract is set to the total delta number of characters of the
3310  * input nodes.
3311  *
3312  * And *unfolded_multi_char is set to indicate whether or not the node contains
3313  * an unfolded multi-char fold.  This happens when whether the fold is valid or
3314  * not won't be known until runtime; namely for EXACTF nodes that contain LATIN
3315  * SMALL LETTER SHARP S, as only if the target string being matched against
3316  * turns out to be UTF-8 is that fold valid; and also for EXACTFL nodes whose
3317  * folding rules depend on the locale in force at runtime.  (Multi-char folds
3318  * whose components are all above the Latin1 range are not run-time locale
3319  * dependent, and have already been folded by the time this function is
3320  * called.)
3321  *
3322  * This is as good a place as any to discuss the design of handling these
3323  * multi-character fold sequences.  It's been wrong in Perl for a very long
3324  * time.  There are three code points in Unicode whose multi-character folds
3325  * were long ago discovered to mess things up.  The previous designs for
3326  * dealing with these involved assigning a special node for them.  This
3327  * approach doesn't always work, as evidenced by this example:
3328  *      "\xDFs" =~ /s\xDF/ui    # Used to fail before these patches
3329  * Both sides fold to "sss", but if the pattern is parsed to create a node that
3330  * would match just the \xDF, it won't be able to handle the case where a
3331  * successful match would have to cross the node's boundary.  The new approach
3332  * that hopefully generally solves the problem generates an EXACTFU_SS node
3333  * that is "sss" in this case.
3334  *
3335  * It turns out that there are problems with all multi-character folds, and not
3336  * just these three.  Now the code is general, for all such cases.  The
3337  * approach taken is:
3338  * 1)   This routine examines each EXACTFish node that could contain multi-
3339  *      character folded sequences.  Since a single character can fold into
3340  *      such a sequence, the minimum match length for this node is less than
3341  *      the number of characters in the node.  This routine returns in
3342  *      *min_subtract how many characters to subtract from the the actual
3343  *      length of the string to get a real minimum match length; it is 0 if
3344  *      there are no multi-char foldeds.  This delta is used by the caller to
3345  *      adjust the min length of the match, and the delta between min and max,
3346  *      so that the optimizer doesn't reject these possibilities based on size
3347  *      constraints.
3348  * 2)   For the sequence involving the Sharp s (\xDF), the node type EXACTFU_SS
3349  *      is used for an EXACTFU node that contains at least one "ss" sequence in
3350  *      it.  For non-UTF-8 patterns and strings, this is the only case where
3351  *      there is a possible fold length change.  That means that a regular
3352  *      EXACTFU node without UTF-8 involvement doesn't have to concern itself
3353  *      with length changes, and so can be processed faster.  regexec.c takes
3354  *      advantage of this.  Generally, an EXACTFish node that is in UTF-8 is
3355  *      pre-folded by regcomp.c (except EXACTFL, some of whose folds aren't
3356  *      known until runtime).  This saves effort in regex matching.  However,
3357  *      the pre-folding isn't done for non-UTF8 patterns because the fold of
3358  *      the MICRO SIGN requires UTF-8, and we don't want to slow things down by
3359  *      forcing the pattern into UTF8 unless necessary.  Also what EXACTF (and,
3360  *      again, EXACTFL) nodes fold to isn't known until runtime.  The fold
3361  *      possibilities for the non-UTF8 patterns are quite simple, except for
3362  *      the sharp s.  All the ones that don't involve a UTF-8 target string are
3363  *      members of a fold-pair, and arrays are set up for all of them so that
3364  *      the other member of the pair can be found quickly.  Code elsewhere in
3365  *      this file makes sure that in EXACTFU nodes, the sharp s gets folded to
3366  *      'ss', even if the pattern isn't UTF-8.  This avoids the issues
3367  *      described in the next item.
3368  * 3)   A problem remains for unfolded multi-char folds. (These occur when the
3369  *      validity of the fold won't be known until runtime, and so must remain
3370  *      unfolded for now.  This happens for the sharp s in EXACTF and EXACTFA
3371  *      nodes when the pattern isn't in UTF-8.  (Note, BTW, that there cannot
3372  *      be an EXACTF node with a UTF-8 pattern.)  They also occur for various
3373  *      folds in EXACTFL nodes, regardless of the UTF-ness of the pattern.)
3374  *      The reason this is a problem is that the optimizer part of regexec.c
3375  *      (probably unwittingly, in Perl_regexec_flags()) makes an assumption
3376  *      that a character in the pattern corresponds to at most a single
3377  *      character in the target string.  (And I do mean character, and not byte
3378  *      here, unlike other parts of the documentation that have never been
3379  *      updated to account for multibyte Unicode.)  sharp s in EXACTF and
3380  *      EXACTFL nodes can match the two character string 'ss'; in EXACTFA nodes
3381  *      it can match "\x{17F}\x{17F}".  These, along with other ones in EXACTFL
3382  *      nodes, violate the assumption, and they are the only instances where it
3383  *      is violated.  I'm reluctant to try to change the assumption, as the
3384  *      code involved is impenetrable to me (khw), so instead the code here
3385  *      punts.  This routine examines EXACTFL nodes, and (when the pattern
3386  *      isn't UTF-8) EXACTF and EXACTFA for such unfolded folds, and returns a
3387  *      boolean indicating whether or not the node contains such a fold.  When
3388  *      it is true, the caller sets a flag that later causes the optimizer in
3389  *      this file to not set values for the floating and fixed string lengths,
3390  *      and thus avoids the optimizer code in regexec.c that makes the invalid
3391  *      assumption.  Thus, there is no optimization based on string lengths for
3392  *      EXACTFL nodes that contain these few folds, nor for non-UTF8-pattern
3393  *      EXACTF and EXACTFA nodes that contain the sharp s.  (The reason the
3394  *      assumption is wrong only in these cases is that all other non-UTF-8
3395  *      folds are 1-1; and, for UTF-8 patterns, we pre-fold all other folds to
3396  *      their expanded versions.  (Again, we can't prefold sharp s to 'ss' in
3397  *      EXACTF nodes because we don't know at compile time if it actually
3398  *      matches 'ss' or not.  For EXACTF nodes it will match iff the target
3399  *      string is in UTF-8.  This is in contrast to EXACTFU nodes, where it
3400  *      always matches; and EXACTFA where it never does.  In an EXACTFA node in
3401  *      a UTF-8 pattern, sharp s is folded to "\x{17F}\x{17F}, avoiding the
3402  *      problem; but in a non-UTF8 pattern, folding it to that above-Latin1
3403  *      string would require the pattern to be forced into UTF-8, the overhead
3404  *      of which we want to avoid.  Similarly the unfolded multi-char folds in
3405  *      EXACTFL nodes will match iff the locale at the time of match is a UTF-8
3406  *      locale.)
3407  *
3408  *      Similarly, the code that generates tries doesn't currently handle
3409  *      not-already-folded multi-char folds, and it looks like a pain to change
3410  *      that.  Therefore, trie generation of EXACTFA nodes with the sharp s
3411  *      doesn't work.  Instead, such an EXACTFA is turned into a new regnode,
3412  *      EXACTFA_NO_TRIE, which the trie code knows not to handle.  Most people
3413  *      using /iaa matching will be doing so almost entirely with ASCII
3414  *      strings, so this should rarely be encountered in practice */
3415
3416 #define JOIN_EXACT(scan,min_subtract,unfolded_multi_char, flags) \
3417     if (PL_regkind[OP(scan)] == EXACT) \
3418         join_exact(pRExC_state,(scan),(min_subtract),unfolded_multi_char, (flags),NULL,depth+1)
3419
3420 STATIC U32
3421 S_join_exact(pTHX_ RExC_state_t *pRExC_state, regnode *scan,
3422                    UV *min_subtract, bool *unfolded_multi_char,
3423                    U32 flags,regnode *val, U32 depth)
3424 {
3425     /* Merge several consecutive EXACTish nodes into one. */
3426     regnode *n = regnext(scan);
3427     U32 stringok = 1;
3428     regnode *next = scan + NODE_SZ_STR(scan);
3429     U32 merged = 0;
3430     U32 stopnow = 0;
3431 #ifdef DEBUGGING
3432     regnode *stop = scan;
3433     GET_RE_DEBUG_FLAGS_DECL;
3434 #else
3435     PERL_UNUSED_ARG(depth);
3436 #endif
3437
3438     PERL_ARGS_ASSERT_JOIN_EXACT;
3439 #ifndef EXPERIMENTAL_INPLACESCAN
3440     PERL_UNUSED_ARG(flags);
3441     PERL_UNUSED_ARG(val);
3442 #endif
3443     DEBUG_PEEP("join",scan,depth);
3444
3445     /* Look through the subsequent nodes in the chain.  Skip NOTHING, merge
3446      * EXACT ones that are mergeable to the current one. */
3447     while (n
3448            && (PL_regkind[OP(n)] == NOTHING
3449                || (stringok && OP(n) == OP(scan)))
3450            && NEXT_OFF(n)
3451            && NEXT_OFF(scan) + NEXT_OFF(n) < I16_MAX)
3452     {
3453
3454         if (OP(n) == TAIL || n > next)
3455             stringok = 0;
3456         if (PL_regkind[OP(n)] == NOTHING) {
3457             DEBUG_PEEP("skip:",n,depth);
3458             NEXT_OFF(scan) += NEXT_OFF(n);
3459             next = n + NODE_STEP_REGNODE;
3460 #ifdef DEBUGGING
3461             if (stringok)
3462                 stop = n;
3463 #endif
3464             n = regnext(n);
3465         }
3466         else if (stringok) {
3467             const unsigned int oldl = STR_LEN(scan);
3468             regnode * const nnext = regnext(n);
3469
3470             /* XXX I (khw) kind of doubt that this works on platforms (should
3471              * Perl ever run on one) where U8_MAX is above 255 because of lots
3472              * of other assumptions */
3473             /* Don't join if the sum can't fit into a single node */
3474             if (oldl + STR_LEN(n) > U8_MAX)
3475                 break;
3476
3477             DEBUG_PEEP("merg",n,depth);
3478             merged++;
3479
3480             NEXT_OFF(scan) += NEXT_OFF(n);
3481             STR_LEN(scan) += STR_LEN(n);
3482             next = n + NODE_SZ_STR(n);
3483             /* Now we can overwrite *n : */
3484             Move(STRING(n), STRING(scan) + oldl, STR_LEN(n), char);
3485 #ifdef DEBUGGING
3486             stop = next - 1;
3487 #endif
3488             n = nnext;
3489             if (stopnow) break;
3490         }
3491
3492 #ifdef EXPERIMENTAL_INPLACESCAN
3493         if (flags && !NEXT_OFF(n)) {
3494             DEBUG_PEEP("atch", val, depth);
3495             if (reg_off_by_arg[OP(n)]) {
3496                 ARG_SET(n, val - n);
3497             }
3498             else {
3499                 NEXT_OFF(n) = val - n;
3500             }
3501             stopnow = 1;
3502         }
3503 #endif
3504     }
3505
3506     *min_subtract = 0;
3507     *unfolded_multi_char = FALSE;
3508
3509     /* Here, all the adjacent mergeable EXACTish nodes have been merged.  We
3510      * can now analyze for sequences of problematic code points.  (Prior to
3511      * this final joining, sequences could have been split over boundaries, and
3512      * hence missed).  The sequences only happen in folding, hence for any
3513      * non-EXACT EXACTish node */
3514     if (OP(scan) != EXACT && OP(scan) != EXACTL) {
3515         U8* s0 = (U8*) STRING(scan);
3516         U8* s = s0;
3517         U8* s_end = s0 + STR_LEN(scan);
3518
3519         int total_count_delta = 0;  /* Total delta number of characters that
3520                                        multi-char folds expand to */
3521
3522         /* One pass is made over the node's string looking for all the
3523          * possibilities.  To avoid some tests in the loop, there are two main
3524          * cases, for UTF-8 patterns (which can't have EXACTF nodes) and
3525          * non-UTF-8 */
3526         if (UTF) {
3527             U8* folded = NULL;
3528
3529             if (OP(scan) == EXACTFL) {
3530                 U8 *d;
3531
3532                 /* An EXACTFL node would already have been changed to another
3533                  * node type unless there is at least one character in it that
3534                  * is problematic; likely a character whose fold definition
3535                  * won't be known until runtime, and so has yet to be folded.
3536                  * For all but the UTF-8 locale, folds are 1-1 in length, but
3537                  * to handle the UTF-8 case, we need to create a temporary
3538                  * folded copy using UTF-8 locale rules in order to analyze it.
3539                  * This is because our macros that look to see if a sequence is
3540                  * a multi-char fold assume everything is folded (otherwise the
3541                  * tests in those macros would be too complicated and slow).
3542                  * Note that here, the non-problematic folds will have already
3543                  * been done, so we can just copy such characters.  We actually
3544                  * don't completely fold the EXACTFL string.  We skip the
3545                  * unfolded multi-char folds, as that would just create work
3546                  * below to figure out the size they already are */
3547
3548                 Newx(folded, UTF8_MAX_FOLD_CHAR_EXPAND * STR_LEN(scan) + 1, U8);
3549                 d = folded;
3550                 while (s < s_end) {
3551                     STRLEN s_len = UTF8SKIP(s);
3552                     if (! is_PROBLEMATIC_LOCALE_FOLD_utf8(s)) {
3553                         Copy(s, d, s_len, U8);
3554                         d += s_len;
3555                     }
3556                     else if (is_FOLDS_TO_MULTI_utf8(s)) {
3557                         *unfolded_multi_char = TRUE;
3558                         Copy(s, d, s_len, U8);
3559                         d += s_len;
3560                     }
3561                     else if (isASCII(*s)) {
3562                         *(d++) = toFOLD(*s);
3563                     }
3564                     else {
3565                         STRLEN len;
3566                         _to_utf8_fold_flags(s, d, &len, FOLD_FLAGS_FULL);
3567                         d += len;
3568                     }
3569                     s += s_len;
3570                 }
3571
3572                 /* Point the remainder of the routine to look at our temporary
3573                  * folded copy */
3574                 s = folded;
3575                 s_end = d;
3576             } /* End of creating folded copy of EXACTFL string */
3577
3578             /* Examine the string for a multi-character fold sequence.  UTF-8
3579              * patterns have all characters pre-folded by the time this code is
3580              * executed */
3581             while (s < s_end - 1) /* Can stop 1 before the end, as minimum
3582                                      length sequence we are looking for is 2 */
3583             {
3584                 int count = 0;  /* How many characters in a multi-char fold */
3585                 int len = is_MULTI_CHAR_FOLD_utf8_safe(s, s_end);
3586                 if (! len) {    /* Not a multi-char fold: get next char */
3587                     s += UTF8SKIP(s);
3588                     continue;
3589                 }
3590
3591                 /* Nodes with 'ss' require special handling, except for
3592                  * EXACTFA-ish for which there is no multi-char fold to this */
3593                 if (len == 2 && *s == 's' && *(s+1) == 's'
3594                     && OP(scan) != EXACTFA
3595                     && OP(scan) != EXACTFA_NO_TRIE)
3596                 {
3597                     count = 2;
3598                     if (OP(scan) != EXACTFL) {
3599                         OP(scan) = EXACTFU_SS;
3600                     }
3601                     s += 2;
3602                 }
3603                 else { /* Here is a generic multi-char fold. */
3604                     U8* multi_end  = s + len;
3605
3606                     /* Count how many characters are in it.  In the case of
3607                      * /aa, no folds which contain ASCII code points are
3608                      * allowed, so check for those, and skip if found. */
3609                     if (OP(scan) != EXACTFA && OP(scan) != EXACTFA_NO_TRIE) {
3610                         count = utf8_length(s, multi_end);
3611                         s = multi_end;
3612                     }
3613                     else {
3614                         while (s < multi_end) {
3615                             if (isASCII(*s)) {
3616                                 s++;
3617                                 goto next_iteration;
3618                             }
3619                             else {
3620                                 s += UTF8SKIP(s);
3621                             }
3622                             count++;
3623                         }
3624                     }
3625                 }
3626
3627                 /* The delta is how long the sequence is minus 1 (1 is how long
3628                  * the character that folds to the sequence is) */
3629                 total_count_delta += count - 1;
3630               next_iteration: ;
3631             }
3632
3633             /* We created a temporary folded copy of the string in EXACTFL
3634              * nodes.  Therefore we need to be sure it doesn't go below zero,
3635              * as the real string could be shorter */
3636             if (OP(scan) == EXACTFL) {
3637                 int total_chars = utf8_length((U8*) STRING(scan),
3638                                            (U8*) STRING(scan) + STR_LEN(scan));
3639                 if (total_count_delta > total_chars) {
3640                     total_count_delta = total_chars;
3641                 }
3642             }
3643
3644             *min_subtract += total_count_delta;
3645             Safefree(folded);
3646         }
3647         else if (OP(scan) == EXACTFA) {
3648
3649             /* Non-UTF-8 pattern, EXACTFA node.  There can't be a multi-char
3650              * fold to the ASCII range (and there are no existing ones in the
3651              * upper latin1 range).  But, as outlined in the comments preceding
3652              * this function, we need to flag any occurrences of the sharp s.
3653              * This character forbids trie formation (because of added
3654              * complexity) */
3655 #if    UNICODE_MAJOR_VERSION > 3 /* no multifolds in early Unicode */   \
3656    || (UNICODE_MAJOR_VERSION == 3 && (   UNICODE_DOT_VERSION > 0)       \
3657                                       || UNICODE_DOT_DOT_VERSION > 0)
3658             while (s < s_end) {
3659                 if (*s == LATIN_SMALL_LETTER_SHARP_S) {
3660                     OP(scan) = EXACTFA_NO_TRIE;
3661                     *unfolded_multi_char = TRUE;
3662                     break;
3663                 }
3664                 s++;
3665             }
3666         }
3667         else {
3668
3669             /* Non-UTF-8 pattern, not EXACTFA node.  Look for the multi-char
3670              * folds that are all Latin1.  As explained in the comments
3671              * preceding this function, we look also for the sharp s in EXACTF
3672              * and EXACTFL nodes; it can be in the final position.  Otherwise
3673              * we can stop looking 1 byte earlier because have to find at least
3674              * two characters for a multi-fold */
3675             const U8* upper = (OP(scan) == EXACTF || OP(scan) == EXACTFL)
3676                               ? s_end
3677                               : s_end -1;
3678
3679             while (s < upper) {
3680                 int len = is_MULTI_CHAR_FOLD_latin1_safe(s, s_end);
3681                 if (! len) {    /* Not a multi-char fold. */
3682                     if (*s == LATIN_SMALL_LETTER_SHARP_S
3683                         && (OP(scan) == EXACTF || OP(scan) == EXACTFL))
3684                     {
3685                         *unfolded_multi_char = TRUE;
3686                     }
3687                     s++;
3688                     continue;
3689                 }
3690
3691                 if (len == 2
3692                     && isALPHA_FOLD_EQ(*s, 's')
3693                     && isALPHA_FOLD_EQ(*(s+1), 's'))
3694                 {
3695
3696                     /* EXACTF nodes need to know that the minimum length
3697                      * changed so that a sharp s in the string can match this
3698                      * ss in the pattern, but they remain EXACTF nodes, as they
3699                      * won't match this unless the target string is is UTF-8,
3700                      * which we don't know until runtime.  EXACTFL nodes can't
3701                      * transform into EXACTFU nodes */
3702                     if (OP(scan) != EXACTF && OP(scan) != EXACTFL) {
3703                         OP(scan) = EXACTFU_SS;
3704                     }
3705                 }
3706
3707                 *min_subtract += len - 1;
3708                 s += len;
3709             }
3710 #endif
3711         }
3712     }
3713
3714 #ifdef DEBUGGING
3715     /* Allow dumping but overwriting the collection of skipped
3716      * ops and/or strings with fake optimized ops */
3717     n = scan + NODE_SZ_STR(scan);
3718     while (n <= stop) {
3719         OP(n) = OPTIMIZED;
3720         FLAGS(n) = 0;
3721         NEXT_OFF(n) = 0;
3722         n++;
3723     }
3724 #endif
3725     DEBUG_OPTIMISE_r(if (merged){DEBUG_PEEP("finl",scan,depth)});
3726     return stopnow;
3727 }
3728
3729 /* REx optimizer.  Converts nodes into quicker variants "in place".
3730    Finds fixed substrings.  */
3731
3732 /* Stops at toplevel WHILEM as well as at "last". At end *scanp is set
3733    to the position after last scanned or to NULL. */
3734
3735 #define INIT_AND_WITHP \
3736     assert(!and_withp); \
3737     Newx(and_withp,1, regnode_ssc); \
3738     SAVEFREEPV(and_withp)
3739
3740
3741 static void
3742 S_unwind_scan_frames(pTHX_ const void *p)
3743 {
3744     scan_frame *f= (scan_frame *)p;
3745     do {
3746         scan_frame *n= f->next_frame;
3747         Safefree(f);
3748         f= n;
3749     } while (f);
3750 }
3751
3752
3753 STATIC SSize_t
3754 S_study_chunk(pTHX_ RExC_state_t *pRExC_state, regnode **scanp,
3755                         SSize_t *minlenp, SSize_t *deltap,
3756                         regnode *last,
3757                         scan_data_t *data,
3758                         I32 stopparen,
3759                         U32 recursed_depth,
3760                         regnode_ssc *and_withp,
3761                         U32 flags, U32 depth)
3762                         /* scanp: Start here (read-write). */
3763                         /* deltap: Write maxlen-minlen here. */
3764                         /* last: Stop before this one. */
3765                         /* data: string data about the pattern */
3766                         /* stopparen: treat close N as END */
3767                         /* recursed: which subroutines have we recursed into */
3768                         /* and_withp: Valid if flags & SCF_DO_STCLASS_OR */
3769 {
3770     /* There must be at least this number of characters to match */
3771     SSize_t min = 0;
3772     I32 pars = 0, code;
3773     regnode *scan = *scanp, *next;
3774     SSize_t delta = 0;
3775     int is_inf = (flags & SCF_DO_SUBSTR) && (data->flags & SF_IS_INF);
3776     int is_inf_internal = 0;            /* The studied chunk is infinite */
3777     I32 is_par = OP(scan) == OPEN ? ARG(scan) : 0;
3778     scan_data_t data_fake;
3779     SV *re_trie_maxbuff = NULL;
3780     regnode *first_non_open = scan;
3781     SSize_t stopmin = SSize_t_MAX;
3782     scan_frame *frame = NULL;
3783     GET_RE_DEBUG_FLAGS_DECL;
3784
3785     PERL_ARGS_ASSERT_STUDY_CHUNK;
3786
3787
3788     if ( depth == 0 ) {
3789         while (first_non_open && OP(first_non_open) == OPEN)
3790             first_non_open=regnext(first_non_open);
3791     }
3792
3793
3794   fake_study_recurse:
3795     DEBUG_r(
3796         RExC_study_chunk_recursed_count++;
3797     );
3798     DEBUG_OPTIMISE_MORE_r(
3799     {
3800         PerlIO_printf(Perl_debug_log,
3801             "%*sstudy_chunk stopparen=%ld recursed_count=%lu depth=%lu recursed_depth=%lu scan=%p last=%p",
3802             (int)(depth*2), "", (long)stopparen,
3803             (unsigned long)RExC_study_chunk_recursed_count,
3804             (unsigned long)depth, (unsigned long)recursed_depth,
3805             scan,
3806             last);
3807         if (recursed_depth) {
3808             U32 i;
3809             U32 j;
3810             for ( j = 0 ; j < recursed_depth ; j++ ) {
3811                 for ( i = 0 ; i < (U32)RExC_npar ; i++ ) {
3812                     if (
3813                         PAREN_TEST(RExC_study_chunk_recursed +
3814                                    ( j * RExC_study_chunk_recursed_bytes), i )
3815                         && (
3816                             !j ||
3817                             !PAREN_TEST(RExC_study_chunk_recursed +
3818                                    (( j - 1 ) * RExC_study_chunk_recursed_bytes), i)
3819                         )
3820                     ) {
3821                         PerlIO_printf(Perl_debug_log," %d",(int)i);
3822                         break;
3823                     }
3824                 }
3825                 if ( j + 1 < recursed_depth ) {
3826                     PerlIO_printf(Perl_debug_log, ",");
3827                 }
3828             }
3829         }
3830         PerlIO_printf(Perl_debug_log,"\n");
3831     }
3832     );
3833     while ( scan && OP(scan) != END && scan < last ){
3834         UV min_subtract = 0;    /* How mmany chars to subtract from the minimum
3835                                    node length to get a real minimum (because
3836                                    the folded version may be shorter) */
3837         bool unfolded_multi_char = FALSE;
3838         /* Peephole optimizer: */
3839         DEBUG_STUDYDATA("Peep:", data, depth);
3840         DEBUG_PEEP("Peep", scan, depth);
3841
3842
3843         /* The reason we do this here we need to deal with things like /(?:f)(?:o)(?:o)/
3844          * which cant be dealt with by the normal EXACT parsing code, as each (?:..) is handled
3845          * by a different invocation of reg() -- Yves
3846          */
3847         JOIN_EXACT(scan,&min_subtract, &unfolded_multi_char, 0);
3848
3849         /* Follow the next-chain of the current node and optimize
3850            away all the NOTHINGs from it.  */
3851         if (OP(scan) != CURLYX) {
3852             const int max = (reg_off_by_arg[OP(scan)]
3853                        ? I32_MAX
3854                        /* I32 may be smaller than U16 on CRAYs! */
3855                        : (I32_MAX < U16_MAX ? I32_MAX : U16_MAX));
3856             int off = (reg_off_by_arg[OP(scan)] ? ARG(scan) : NEXT_OFF(scan));
3857             int noff;
3858             regnode *n = scan;
3859
3860             /* Skip NOTHING and LONGJMP. */
3861             while ((n = regnext(n))
3862                    && ((PL_regkind[OP(n)] == NOTHING && (noff = NEXT_OFF(n)))
3863                        || ((OP(n) == LONGJMP) && (noff = ARG(n))))
3864                    && off + noff < max)
3865                 off += noff;
3866             if (reg_off_by_arg[OP(scan)])
3867                 ARG(scan) = off;
3868             else
3869                 NEXT_OFF(scan) = off;
3870         }
3871
3872         /* The principal pseudo-switch.  Cannot be a switch, since we
3873            look into several different things.  */
3874         if ( OP(scan) == DEFINEP ) {
3875             SSize_t minlen = 0;
3876             SSize_t deltanext = 0;
3877             SSize_t fake_last_close = 0;
3878             I32 f = SCF_IN_DEFINE;
3879
3880             StructCopy(&zero_scan_data, &data_fake, scan_data_t);
3881             scan = regnext(scan);
3882             assert( OP(scan) == IFTHEN );
3883             DEBUG_PEEP("expect IFTHEN", scan, depth);
3884
3885             data_fake.last_closep= &fake_last_close;
3886             minlen = *minlenp;
3887             next = regnext(scan);
3888             scan = NEXTOPER(NEXTOPER(scan));
3889             DEBUG_PEEP("scan", scan, depth);
3890             DEBUG_PEEP("next", next, depth);
3891
3892             /* we suppose the run is continuous, last=next...
3893              * NOTE we dont use the return here! */
3894             (void)study_chunk(pRExC_state, &scan, &minlen,
3895                               &deltanext, next, &data_fake, stopparen,
3896                               recursed_depth, NULL, f, depth+1);
3897
3898             scan = next;
3899         } else
3900         if (
3901             OP(scan) == BRANCH  ||
3902             OP(scan) == BRANCHJ ||
3903             OP(scan) == IFTHEN
3904         ) {
3905             next = regnext(scan);
3906             code = OP(scan);
3907
3908             /* The op(next)==code check below is to see if we
3909              * have "BRANCH-BRANCH", "BRANCHJ-BRANCHJ", "IFTHEN-IFTHEN"
3910              * IFTHEN is special as it might not appear in pairs.
3911              * Not sure whether BRANCH-BRANCHJ is possible, regardless
3912              * we dont handle it cleanly. */
3913             if (OP(next) == code || code == IFTHEN) {
3914                 /* NOTE - There is similar code to this block below for
3915                  * handling TRIE nodes on a re-study.  If you change stuff here
3916                  * check there too. */
3917                 SSize_t max1 = 0, min1 = SSize_t_MAX, num = 0;
3918                 regnode_ssc accum;
3919                 regnode * const startbranch=scan;
3920
3921                 if (flags & SCF_DO_SUBSTR) {
3922                     /* Cannot merge strings after this. */
3923                     scan_commit(pRExC_state, data, minlenp, is_inf);
3924                 }
3925
3926                 if (flags & SCF_DO_STCLASS)
3927                     ssc_init_zero(pRExC_state, &accum);
3928
3929                 while (OP(scan) == code) {
3930                     SSize_t deltanext, minnext, fake;
3931                     I32 f = 0;
3932                     regnode_ssc this_class;
3933
3934                     DEBUG_PEEP("Branch", scan, depth);
3935
3936                     num++;
3937                     StructCopy(&zero_scan_data, &data_fake, scan_data_t);
3938                     if (data) {
3939                         data_fake.whilem_c = data->whilem_c;
3940                         data_fake.last_closep = data->last_closep;
3941                     }
3942                     else
3943                         data_fake.last_closep = &fake;
3944
3945                     data_fake.pos_delta = delta;
3946                     next = regnext(scan);
3947
3948                     scan = NEXTOPER(scan); /* everything */
3949                     if (code != BRANCH)    /* everything but BRANCH */
3950                         scan = NEXTOPER(scan);
3951
3952                     if (flags & SCF_DO_STCLASS) {
3953                         ssc_init(pRExC_state, &this_class);
3954                         data_fake.start_class = &this_class;
3955                         f = SCF_DO_STCLASS_AND;
3956                     }
3957                     if (flags & SCF_WHILEM_VISITED_POS)
3958                         f |= SCF_WHILEM_VISITED_POS;
3959
3960                     /* we suppose the run is continuous, last=next...*/
3961                     minnext = study_chunk(pRExC_state, &scan, minlenp,
3962                                       &deltanext, next, &data_fake, stopparen,
3963                                       recursed_depth, NULL, f,depth+1);
3964
3965                     if (min1 > minnext)
3966                         min1 = minnext;
3967                     if (deltanext == SSize_t_MAX) {
3968                         is_inf = is_inf_internal = 1;
3969                         max1 = SSize_t_MAX;
3970                     } else if (max1 < minnext + deltanext)
3971                         max1 = minnext + deltanext;
3972                     scan = next;
3973                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
3974                         pars++;
3975                     if (data_fake.flags & SCF_SEEN_ACCEPT) {
3976                         if ( stopmin > minnext)
3977                             stopmin = min + min1;
3978                         flags &= ~SCF_DO_SUBSTR;
3979                         if (data)
3980                             data->flags |= SCF_SEEN_ACCEPT;
3981                     }
3982                     if (data) {
3983                         if (data_fake.flags & SF_HAS_EVAL)
3984                             data->flags |= SF_HAS_EVAL;
3985                         data->whilem_c = data_fake.whilem_c;
3986                     }
3987                     if (flags & SCF_DO_STCLASS)
3988                         ssc_or(pRExC_state, &accum, (regnode_charclass*)&this_class);
3989                 }
3990                 if (code == IFTHEN && num < 2) /* Empty ELSE branch */
3991                     min1 = 0;
3992                 if (flags & SCF_DO_SUBSTR) {
3993                     data->pos_min += min1;
3994                     if (data->pos_delta >= SSize_t_MAX - (max1 - min1))
3995                         data->pos_delta = SSize_t_MAX;
3996                     else
3997                         data->pos_delta += max1 - min1;
3998                     if (max1 != min1 || is_inf)
3999                         data->longest = &(data->longest_float);
4000                 }
4001                 min += min1;
4002                 if (delta == SSize_t_MAX
4003                  || SSize_t_MAX - delta - (max1 - min1) < 0)
4004                     delta = SSize_t_MAX;
4005                 else
4006                     delta += max1 - min1;
4007                 if (flags & SCF_DO_STCLASS_OR) {
4008                     ssc_or(pRExC_state, data->start_class, (regnode_charclass*) &accum);
4009                     if (min1) {
4010                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
4011                         flags &= ~SCF_DO_STCLASS;
4012                     }
4013                 }
4014                 else if (flags & SCF_DO_STCLASS_AND) {
4015                     if (min1) {
4016                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &accum);
4017                         flags &= ~SCF_DO_STCLASS;
4018                     }
4019                     else {
4020                         /* Switch to OR mode: cache the old value of
4021                          * data->start_class */
4022                         INIT_AND_WITHP;
4023                         StructCopy(data->start_class, and_withp, regnode_ssc);
4024                         flags &= ~SCF_DO_STCLASS_AND;
4025                         StructCopy(&accum, data->start_class, regnode_ssc);
4026                         flags |= SCF_DO_STCLASS_OR;
4027                     }
4028                 }
4029
4030                 if (PERL_ENABLE_TRIE_OPTIMISATION &&
4031                         OP( startbranch ) == BRANCH )
4032                 {
4033                 /* demq.
4034
4035                    Assuming this was/is a branch we are dealing with: 'scan'
4036                    now points at the item that follows the branch sequence,
4037                    whatever it is. We now start at the beginning of the
4038                    sequence and look for subsequences of
4039
4040                    BRANCH->EXACT=>x1
4041                    BRANCH->EXACT=>x2
4042                    tail
4043
4044                    which would be constructed from a pattern like
4045                    /A|LIST|OF|WORDS/
4046
4047                    If we can find such a subsequence we need to turn the first
4048                    element into a trie and then add the subsequent branch exact
4049                    strings to the trie.
4050
4051                    We have two cases
4052
4053                      1. patterns where the whole set of branches can be
4054                         converted.
4055
4056                      2. patterns where only a subset can be converted.
4057
4058                    In case 1 we can replace the whole set with a single regop
4059                    for the trie. In case 2 we need to keep the start and end
4060                    branches so
4061
4062                      'BRANCH EXACT; BRANCH EXACT; BRANCH X'
4063                      becomes BRANCH TRIE; BRANCH X;
4064
4065                   There is an additional case, that being where there is a
4066                   common prefix, which gets split out into an EXACT like node
4067                   preceding the TRIE node.
4068
4069                   If x(1..n)==tail then we can do a simple trie, if not we make
4070                   a "jump" trie, such that when we match the appropriate word
4071                   we "jump" to the appropriate tail node. Essentially we turn
4072                   a nested if into a case structure of sorts.
4073
4074                 */
4075
4076                     int made=0;
4077                     if (!re_trie_maxbuff) {
4078                         re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
4079                         if (!SvIOK(re_trie_maxbuff))
4080                             sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
4081                     }
4082                     if ( SvIV(re_trie_maxbuff)>=0  ) {
4083                         regnode *cur;
4084                         regnode *first = (regnode *)NULL;
4085                         regnode *last = (regnode *)NULL;
4086                         regnode *tail = scan;
4087                         U8 trietype = 0;
4088                         U32 count=0;
4089
4090                         /* var tail is used because there may be a TAIL
4091                            regop in the way. Ie, the exacts will point to the
4092                            thing following the TAIL, but the last branch will
4093                            point at the TAIL. So we advance tail. If we
4094                            have nested (?:) we may have to move through several
4095                            tails.
4096                          */
4097
4098                         while ( OP( tail ) == TAIL ) {
4099                             /* this is the TAIL generated by (?:) */
4100                             tail = regnext( tail );
4101                         }
4102
4103
4104                         DEBUG_TRIE_COMPILE_r({
4105                             regprop(RExC_rx, RExC_mysv, tail, NULL, pRExC_state);
4106                             PerlIO_printf( Perl_debug_log, "%*s%s%s\n",
4107                               (int)depth * 2 + 2, "",
4108                               "Looking for TRIE'able sequences. Tail node is: ",
4109                               SvPV_nolen_const( RExC_mysv )
4110                             );
4111                         });
4112
4113                         /*
4114
4115                             Step through the branches
4116                                 cur represents each branch,
4117                                 noper is the first thing to be matched as part
4118                                       of that branch
4119                                 noper_next is the regnext() of that node.
4120
4121                             We normally handle a case like this
4122                             /FOO[xyz]|BAR[pqr]/ via a "jump trie" but we also
4123                             support building with NOJUMPTRIE, which restricts
4124                             the trie logic to structures like /FOO|BAR/.
4125
4126                             If noper is a trieable nodetype then the branch is
4127                             a possible optimization target. If we are building
4128                             under NOJUMPTRIE then we require that noper_next is
4129                             the same as scan (our current position in the regex
4130                             program).
4131
4132                             Once we have two or more consecutive such branches
4133                             we can create a trie of the EXACT's contents and
4134                             stitch it in place into the program.
4135
4136                             If the sequence represents all of the branches in
4137                             the alternation we replace the entire thing with a
4138                             single TRIE node.
4139
4140                             Otherwise when it is a subsequence we need to
4141                             stitch it in place and replace only the relevant
4142                             branches. This means the first branch has to remain
4143                             as it is used by the alternation logic, and its
4144                             next pointer, and needs to be repointed at the item
4145                             on the branch chain following the last branch we
4146                             have optimized away.
4147
4148                             This could be either a BRANCH, in which case the
4149                             subsequence is internal, or it could be the item
4150                             following the branch sequence in which case the
4151                             subsequence is at the end (which does not
4152                             necessarily mean the first node is the start of the
4153                             alternation).
4154
4155                             TRIE_TYPE(X) is a define which maps the optype to a
4156                             trietype.
4157
4158                                 optype          |  trietype
4159                                 ----------------+-----------
4160                                 NOTHING         | NOTHING
4161                                 EXACT           | EXACT
4162                                 EXACTFU         | EXACTFU
4163                                 EXACTFU_SS      | EXACTFU
4164                                 EXACTFA         | EXACTFA
4165                                 EXACTL          | EXACTL
4166                                 EXACTFLU8       | EXACTFLU8
4167
4168
4169                         */
4170 #define TRIE_TYPE(X) ( ( NOTHING == (X) )                                   \
4171                        ? NOTHING                                            \
4172                        : ( EXACT == (X) )                                   \
4173                          ? EXACT                                            \
4174                          : ( EXACTFU == (X) || EXACTFU_SS == (X) )          \
4175                            ? EXACTFU                                        \
4176                            : ( EXACTFA == (X) )                             \
4177                              ? EXACTFA                                      \
4178                              : ( EXACTL == (X) )                            \
4179                                ? EXACTL                                     \
4180                                : ( EXACTFLU8 == (X) )                        \
4181                                  ? EXACTFLU8                                 \
4182                                  : 0 )
4183
4184                         /* dont use tail as the end marker for this traverse */
4185                         for ( cur = startbranch ; cur != scan ; cur = regnext( cur ) ) {
4186                             regnode * const noper = NEXTOPER( cur );
4187                             U8 noper_type = OP( noper );
4188                             U8 noper_trietype = TRIE_TYPE( noper_type );
4189 #if defined(DEBUGGING) || defined(NOJUMPTRIE)
4190                             regnode * const noper_next = regnext( noper );
4191                             U8 noper_next_type = (noper_next && noper_next != tail) ? OP(noper_next) : 0;
4192                             U8 noper_next_trietype = (noper_next && noper_next != tail) ? TRIE_TYPE( noper_next_type ) :0;
4193 #endif
4194
4195                             DEBUG_TRIE_COMPILE_r({
4196                                 regprop(RExC_rx, RExC_mysv, cur, NULL, pRExC_state);
4197                                 PerlIO_printf( Perl_debug_log, "%*s- %s (%d)",
4198                                    (int)depth * 2 + 2,"", SvPV_nolen_const( RExC_mysv ), REG_NODE_NUM(cur) );
4199
4200                                 regprop(RExC_rx, RExC_mysv, noper, NULL, pRExC_state);
4201                                 PerlIO_printf( Perl_debug_log, " -> %s",
4202                                     SvPV_nolen_const(RExC_mysv));
4203
4204                                 if ( noper_next ) {
4205                                   regprop(RExC_rx, RExC_mysv, noper_next, NULL, pRExC_state);
4206                                   PerlIO_printf( Perl_debug_log,"\t=> %s\t",
4207                                     SvPV_nolen_const(RExC_mysv));
4208                                 }
4209                                 PerlIO_printf( Perl_debug_log, "(First==%d,Last==%d,Cur==%d,tt==%s,nt==%s,nnt==%s)\n",
4210                                    REG_NODE_NUM(first), REG_NODE_NUM(last), REG_NODE_NUM(cur),
4211                                    PL_reg_name[trietype], PL_reg_name[noper_trietype], PL_reg_name[noper_next_trietype]
4212                                 );
4213                             });
4214
4215                             /* Is noper a trieable nodetype that can be merged
4216                              * with the current trie (if there is one)? */
4217                             if ( noper_trietype
4218                                   &&
4219                                   (
4220                                         ( noper_trietype == NOTHING)
4221                                         || ( trietype == NOTHING )
4222                                         || ( trietype == noper_trietype )
4223                                   )
4224 #ifdef NOJUMPTRIE
4225                                   && noper_next == tail
4226 #endif
4227                                   && count < U16_MAX)
4228                             {
4229                                 /* Handle mergable triable node Either we are
4230                                  * the first node in a new trieable sequence,
4231                                  * in which case we do some bookkeeping,
4232                                  * otherwise we update the end pointer. */
4233                                 if ( !first ) {
4234                                     first = cur;
4235                                     if ( noper_trietype == NOTHING ) {
4236 #if !defined(DEBUGGING) && !defined(NOJUMPTRIE)
4237                                         regnode * const noper_next = regnext( noper );
4238                                         U8 noper_next_type = (noper_next && noper_next!=tail) ? OP(noper_next) : 0;
4239                                         U8 noper_next_trietype = noper_next_type ? TRIE_TYPE( noper_next_type ) :0;
4240 #endif
4241
4242                                         if ( noper_next_trietype ) {
4243                                             trietype = noper_next_trietype;
4244                                         } else if (noper_next_type)  {
4245                                             /* a NOTHING regop is 1 regop wide.
4246                                              * We need at least two for a trie
4247                                              * so we can't merge this in */
4248                                             first = NULL;
4249                                         }
4250                                     } else {
4251                                         trietype = noper_trietype;
4252                                     }
4253                                 } else {
4254                                     if ( trietype == NOTHING )
4255                                         trietype = noper_trietype;
4256                                     last = cur;
4257                                 }
4258                                 if (first)
4259                                     count++;
4260                             } /* end handle mergable triable node */
4261                             else {
4262                                 /* handle unmergable node -
4263                                  * noper may either be a triable node which can
4264                                  * not be tried together with the current trie,
4265                                  * or a non triable node */
4266                                 if ( last ) {
4267                                     /* If last is set and trietype is not
4268                                      * NOTHING then we have found at least two
4269                                      * triable branch sequences in a row of a
4270                                      * similar trietype so we can turn them
4271                                      * into a trie. If/when we allow NOTHING to
4272                                      * start a trie sequence this condition
4273                                      * will be required, and it isn't expensive
4274                                      * so we leave it in for now. */
4275                                     if ( trietype && trietype != NOTHING )
4276                                         make_trie( pRExC_state,
4277                                                 startbranch, first, cur, tail,
4278                                                 count, trietype, depth+1 );
4279                                     last = NULL; /* note: we clear/update
4280                                                     first, trietype etc below,
4281                                                     so we dont do it here */
4282                                 }
4283                                 if ( noper_trietype
4284 #ifdef NOJUMPTRIE
4285                                      && noper_next == tail
4286 #endif
4287                                 ){
4288                                     /* noper is triable, so we can start a new
4289                                      * trie sequence */
4290                                     count = 1;
4291                                     first = cur;
4292                                     trietype = noper_trietype;
4293                                 } else if (first) {
4294                                     /* if we already saw a first but the
4295                                      * current node is not triable then we have
4296                                      * to reset the first information. */
4297                                     count = 0;
4298                                     first = NULL;
4299                                     trietype = 0;
4300                                 }
4301                             } /* end handle unmergable node */
4302                         } /* loop over branches */
4303                         DEBUG_TRIE_COMPILE_r({
4304                             regprop(RExC_rx, RExC_mysv, cur, NULL, pRExC_state);
4305                             PerlIO_printf( Perl_debug_log,
4306                               "%*s- %s (%d) <SCAN FINISHED>\n",
4307                               (int)depth * 2 + 2,
4308                               "", SvPV_nolen_const( RExC_mysv ),REG_NODE_NUM(cur));
4309
4310                         });
4311                         if ( last && trietype ) {
4312                             if ( trietype != NOTHING ) {
4313                                 /* the last branch of the sequence was part of
4314                                  * a trie, so we have to construct it here
4315                                  * outside of the loop */
4316                                 made= make_trie( pRExC_state, startbranch,
4317                                                  first, scan, tail, count,
4318                                                  trietype, depth+1 );
4319 #ifdef TRIE_STUDY_OPT
4320                                 if ( ((made == MADE_EXACT_TRIE &&
4321                                      startbranch == first)
4322                                      || ( first_non_open == first )) &&
4323                                      depth==0 ) {
4324                                     flags |= SCF_TRIE_RESTUDY;
4325                                     if ( startbranch == first
4326                                          && scan == tail )
4327                                     {
4328                                         RExC_seen &=~REG_TOP_LEVEL_BRANCHES_SEEN;
4329                                     }
4330                                 }
4331 #endif
4332                             } else {
4333                                 /* at this point we know whatever we have is a
4334                                  * NOTHING sequence/branch AND if 'startbranch'
4335                                  * is 'first' then we can turn the whole thing
4336                                  * into a NOTHING
4337                                  */
4338                                 if ( startbranch == first ) {
4339                                     regnode *opt;
4340                                     /* the entire thing is a NOTHING sequence,
4341                                      * something like this: (?:|) So we can
4342                                      * turn it into a plain NOTHING op. */
4343                                     DEBUG_TRIE_COMPILE_r({
4344                                         regprop(RExC_rx, RExC_mysv, cur, NULL, pRExC_state);
4345                                         PerlIO_printf( Perl_debug_log,
4346                                           "%*s- %s (%d) <NOTHING BRANCH SEQUENCE>\n", (int)depth * 2 + 2,
4347                                           "", SvPV_nolen_const( RExC_mysv ),REG_NODE_NUM(cur));
4348
4349                                     });
4350                                     OP(startbranch)= NOTHING;
4351                                     NEXT_OFF(startbranch)= tail - startbranch;
4352                                     for ( opt= startbranch + 1; opt < tail ; opt++ )
4353                                         OP(opt)= OPTIMIZED;
4354                                 }
4355                             }
4356                         } /* end if ( last) */
4357                     } /* TRIE_MAXBUF is non zero */
4358
4359                 } /* do trie */
4360
4361             }
4362             else if ( code == BRANCHJ ) {  /* single branch is optimized. */
4363                 scan = NEXTOPER(NEXTOPER(scan));
4364             } else                      /* single branch is optimized. */
4365                 scan = NEXTOPER(scan);
4366             continue;
4367         } else if (OP(scan) == SUSPEND || OP(scan) == GOSUB || OP(scan) == GOSTART) {
4368             I32 paren = 0;
4369             regnode *start = NULL;
4370             regnode *end = NULL;
4371             U32 my_recursed_depth= recursed_depth;
4372
4373
4374             if (OP(scan) != SUSPEND) { /* GOSUB/GOSTART */
4375                 /* Do setup, note this code has side effects beyond
4376                  * the rest of this block. Specifically setting
4377                  * RExC_recurse[] must happen at least once during
4378                  * study_chunk(). */
4379                 if (OP(scan) == GOSUB) {
4380                     paren = ARG(scan);
4381                     RExC_recurse[ARG2L(scan)] = scan;
4382                     start = RExC_open_parens[paren-1];
4383                     end   = RExC_close_parens[paren-1];
4384                 } else {
4385                     start = RExC_rxi->program + 1;
4386                     end   = RExC_opend;
4387                 }
4388                 /* NOTE we MUST always execute the above code, even
4389                  * if we do nothing with a GOSUB/GOSTART */
4390                 if (
4391                     ( flags & SCF_IN_DEFINE )
4392                     ||
4393                     (
4394                         (is_inf_internal || is_inf || (data && data->flags & SF_IS_INF))
4395                         &&
4396                         ( (flags & (SCF_DO_STCLASS | SCF_DO_SUBSTR)) == 0 )
4397                     )
4398                 ) {
4399                     /* no need to do anything here if we are in a define. */
4400                     /* or we are after some kind of infinite construct
4401                      * so we can skip recursing into this item.
4402                      * Since it is infinite we will not change the maxlen
4403                      * or delta, and if we miss something that might raise
4404                      * the minlen it will merely pessimise a little.
4405                      *
4406                      * Iow /(?(DEFINE)(?<foo>foo|food))a+(?&foo)/
4407                      * might result in a minlen of 1 and not of 4,
4408                      * but this doesn't make us mismatch, just try a bit
4409                      * harder than we should.
4410                      * */
4411                     scan= regnext(scan);
4412                     continue;
4413                 }
4414
4415                 if (
4416                     !recursed_depth
4417                     ||
4418                     !PAREN_TEST(RExC_study_chunk_recursed + ((recursed_depth-1) * RExC_study_chunk_recursed_bytes), paren)
4419                 ) {
4420                     /* it is quite possible that there are more efficient ways
4421                      * to do this. We maintain a bitmap per level of recursion
4422                      * of which patterns we have entered so we can detect if a
4423                      * pattern creates a possible infinite loop. When we
4424                      * recurse down a level we copy the previous levels bitmap
4425                      * down. When we are at recursion level 0 we zero the top
4426                      * level bitmap. It would be nice to implement a different
4427                      * more efficient way of doing this. In particular the top
4428                      * level bitmap may be unnecessary.
4429                      */
4430                     if (!recursed_depth) {
4431                         Zero(RExC_study_chunk_recursed, RExC_study_chunk_recursed_bytes, U8);
4432                     } else {
4433                         Copy(RExC_study_chunk_recursed + ((recursed_depth-1) * RExC_study_chunk_recursed_bytes),
4434                              RExC_study_chunk_recursed + (recursed_depth * RExC_study_chunk_recursed_bytes),
4435                              RExC_study_chunk_recursed_bytes, U8);
4436                     }
4437                     /* we havent recursed into this paren yet, so recurse into it */
4438                     DEBUG_STUDYDATA("set:", data,depth);
4439                     PAREN_SET(RExC_study_chunk_recursed + (recursed_depth * RExC_study_chunk_recursed_bytes), paren);
4440                     my_recursed_depth= recursed_depth + 1;
4441                 } else {
4442                     DEBUG_STUDYDATA("inf:", data,depth);
4443                     /* some form of infinite recursion, assume infinite length
4444                      * */
4445                     if (flags & SCF_DO_SUBSTR) {
4446                         scan_commit(pRExC_state, data, minlenp, is_inf);
4447                         data->longest = &(data->longest_float);
4448                     }
4449                     is_inf = is_inf_internal = 1;
4450                     if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
4451                         ssc_anything(data->start_class);
4452                     flags &= ~SCF_DO_STCLASS;
4453
4454                     start= NULL; /* reset start so we dont recurse later on. */
4455                 }
4456             } else {
4457                 paren = stopparen;
4458                 start = scan + 2;
4459                 end = regnext(scan);
4460             }
4461             if (start) {
4462                 scan_frame *newframe;
4463                 assert(end);
4464                 if (!RExC_frame_last) {
4465                     Newxz(newframe, 1, scan_frame);
4466                     SAVEDESTRUCTOR_X(S_unwind_scan_frames, newframe);
4467                     RExC_frame_head= newframe;
4468                     RExC_frame_count++;
4469                 } else if (!RExC_frame_last->next_frame) {
4470                     Newxz(newframe,1,scan_frame);
4471                     RExC_frame_last->next_frame= newframe;
4472                     newframe->prev_frame= RExC_frame_last;
4473                     RExC_frame_count++;
4474                 } else {
4475                     newframe= RExC_frame_last->next_frame;
4476                 }
4477                 RExC_frame_last= newframe;
4478
4479                 newframe->next_regnode = regnext(scan);
4480                 newframe->last_regnode = last;
4481                 newframe->stopparen = stopparen;
4482                 newframe->prev_recursed_depth = recursed_depth;
4483                 newframe->this_prev_frame= frame;
4484
4485                 DEBUG_STUDYDATA("frame-new:",data,depth);
4486                 DEBUG_PEEP("fnew", scan, depth);
4487
4488                 frame = newframe;
4489                 scan =  start;
4490                 stopparen = paren;
4491                 last = end;
4492                 depth = depth + 1;
4493                 recursed_depth= my_recursed_depth;
4494
4495                 continue;
4496             }
4497         }
4498         else if (OP(scan) == EXACT || OP(scan) == EXACTL) {
4499             SSize_t l = STR_LEN(scan);
4500             UV uc;
4501             if (UTF) {
4502                 const U8 * const s = (U8*)STRING(scan);
4503                 uc = utf8_to_uvchr_buf(s, s + l, NULL);
4504                 l = utf8_length(s, s + l);
4505             } else {
4506                 uc = *((U8*)STRING(scan));
4507             }
4508             min += l;
4509             if (flags & SCF_DO_SUBSTR) { /* Update longest substr. */
4510                 /* The code below prefers earlier match for fixed
4511                    offset, later match for variable offset.  */
4512                 if (data->last_end == -1) { /* Update the start info. */
4513                     data->last_start_min = data->pos_min;
4514                     data->last_start_max = is_inf
4515                         ? SSize_t_MAX : data->pos_min + data->pos_delta;
4516                 }
4517                 sv_catpvn(data->last_found, STRING(scan), STR_LEN(scan));
4518                 if (UTF)
4519                     SvUTF8_on(data->last_found);
4520                 {
4521                     SV * const sv = data->last_found;
4522                     MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
4523                         mg_find(sv, PERL_MAGIC_utf8) : NULL;
4524                     if (mg && mg->mg_len >= 0)
4525                         mg->mg_len += utf8_length((U8*)STRING(scan),
4526                                               (U8*)STRING(scan)+STR_LEN(scan));
4527                 }
4528                 data->last_end = data->pos_min + l;
4529                 data->pos_min += l; /* As in the first entry. */
4530                 data->flags &= ~SF_BEFORE_EOL;
4531             }
4532
4533             /* ANDing the code point leaves at most it, and not in locale, and
4534              * can't match null string */
4535             if (flags & SCF_DO_STCLASS_AND) {
4536                 ssc_cp_and(data->start_class, uc);
4537                 ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
4538                 ssc_clear_locale(data->start_class);
4539             }
4540             else if (flags & SCF_DO_STCLASS_OR) {
4541                 ssc_add_cp(data->start_class, uc);
4542                 ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
4543
4544                 /* See commit msg 749e076fceedeb708a624933726e7989f2302f6a */
4545                 ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
4546             }
4547             flags &= ~SCF_DO_STCLASS;
4548         }
4549         else if (PL_regkind[OP(scan)] == EXACT) {
4550             /* But OP != EXACT!, so is EXACTFish */
4551             SSize_t l = STR_LEN(scan);
4552             const U8 * s = (U8*)STRING(scan);
4553
4554             /* Search for fixed substrings supports EXACT only. */
4555             if (flags & SCF_DO_SUBSTR) {
4556                 assert(data);
4557                 scan_commit(pRExC_state, data, minlenp, is_inf);
4558             }
4559             if (UTF) {
4560                 l = utf8_length(s, s + l);
4561             }
4562             if (unfolded_multi_char) {
4563                 RExC_seen |= REG_UNFOLDED_MULTI_SEEN;
4564             }
4565             min += l - min_subtract;
4566             assert (min >= 0);
4567             delta += min_subtract;
4568             if (flags & SCF_DO_SUBSTR) {
4569                 data->pos_min += l - min_subtract;
4570                 if (data->pos_min < 0) {
4571                     data->pos_min = 0;
4572                 }
4573                 data->pos_delta += min_subtract;
4574                 if (min_subtract) {
4575                     data->longest = &(data->longest_float);
4576                 }
4577             }
4578
4579             if (flags & SCF_DO_STCLASS) {
4580                 SV* EXACTF_invlist = _make_exactf_invlist(pRExC_state, scan);
4581
4582                 assert(EXACTF_invlist);
4583                 if (flags & SCF_DO_STCLASS_AND) {
4584                     if (OP(scan) != EXACTFL)
4585                         ssc_clear_locale(data->start_class);
4586                     ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
4587                     ANYOF_POSIXL_ZERO(data->start_class);
4588                     ssc_intersection(data->start_class, EXACTF_invlist, FALSE);
4589                 }
4590                 else {  /* SCF_DO_STCLASS_OR */
4591                     ssc_union(data->start_class, EXACTF_invlist, FALSE);
4592                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
4593
4594                     /* See commit msg 749e076fceedeb708a624933726e7989f2302f6a */
4595                     ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
4596                 }
4597                 flags &= ~SCF_DO_STCLASS;
4598                 SvREFCNT_dec(EXACTF_invlist);
4599             }
4600         }
4601         else if (REGNODE_VARIES(OP(scan))) {
4602             SSize_t mincount, maxcount, minnext, deltanext, pos_before = 0;
4603             I32 fl = 0, f = flags;
4604             regnode * const oscan = scan;
4605             regnode_ssc this_class;
4606             regnode_ssc *oclass = NULL;
4607             I32 next_is_eval = 0;
4608
4609             switch (PL_regkind[OP(scan)]) {
4610             case WHILEM:                /* End of (?:...)* . */
4611                 scan = NEXTOPER(scan);
4612                 goto finish;
4613             case PLUS:
4614                 if (flags & (SCF_DO_SUBSTR | SCF_DO_STCLASS)) {
4615                     next = NEXTOPER(scan);
4616                     if (OP(next) == EXACT
4617                         || OP(next) == EXACTL
4618                         || (flags & SCF_DO_STCLASS))
4619                     {
4620                         mincount = 1;
4621                         maxcount = REG_INFTY;
4622                         next = regnext(scan);
4623                         scan = NEXTOPER(scan);
4624                         goto do_curly;
4625                     }
4626                 }
4627                 if (flags & SCF_DO_SUBSTR)
4628                     data->pos_min++;
4629                 min++;
4630                 /* FALLTHROUGH */
4631             case STAR:
4632                 if (flags & SCF_DO_STCLASS) {
4633                     mincount = 0;
4634                     maxcount = REG_INFTY;
4635                     next = regnext(scan);
4636                     scan = NEXTOPER(scan);
4637                     goto do_curly;
4638                 }
4639                 if (flags & SCF_DO_SUBSTR) {
4640                     scan_commit(pRExC_state, data, minlenp, is_inf);
4641                     /* Cannot extend fixed substrings */
4642                     data->longest = &(data->longest_float);
4643                 }
4644                 is_inf = is_inf_internal = 1;
4645                 scan = regnext(scan);
4646                 goto optimize_curly_tail;
4647             case CURLY:
4648                 if (stopparen>0 && (OP(scan)==CURLYN || OP(scan)==CURLYM)
4649                     && (scan->flags == stopparen))
4650                 {
4651                     mincount = 1;
4652                     maxcount = 1;
4653                 } else {
4654                     mincount = ARG1(scan);
4655                     maxcount = ARG2(scan);
4656                 }
4657                 next = regnext(scan);
4658                 if (OP(scan) == CURLYX) {
4659                     I32 lp = (data ? *(data->last_closep) : 0);
4660                     scan->flags = ((lp <= (I32)U8_MAX) ? (U8)lp : U8_MAX);
4661                 }
4662                 scan = NEXTOPER(scan) + EXTRA_STEP_2ARGS;
4663                 next_is_eval = (OP(scan) == EVAL);
4664               do_curly:
4665                 if (flags & SCF_DO_SUBSTR) {
4666                     if (mincount == 0)
4667                         scan_commit(pRExC_state, data, minlenp, is_inf);
4668                     /* Cannot extend fixed substrings */
4669                     pos_before = data->pos_min;
4670                 }
4671                 if (data) {
4672                     fl = data->flags;
4673                     data->flags &= ~(SF_HAS_PAR|SF_IN_PAR|SF_HAS_EVAL);
4674                     if (is_inf)
4675                         data->flags |= SF_IS_INF;
4676                 }
4677                 if (flags & SCF_DO_STCLASS) {
4678                     ssc_init(pRExC_state, &this_class);
4679                     oclass = data->start_class;
4680                     data->start_class = &this_class;
4681                     f |= SCF_DO_STCLASS_AND;
4682                     f &= ~SCF_DO_STCLASS_OR;
4683                 }
4684                 /* Exclude from super-linear cache processing any {n,m}
4685                    regops for which the combination of input pos and regex
4686                    pos is not enough information to determine if a match
4687                    will be possible.
4688
4689                    For example, in the regex /foo(bar\s*){4,8}baz/ with the
4690                    regex pos at the \s*, the prospects for a match depend not
4691                    only on the input position but also on how many (bar\s*)
4692                    repeats into the {4,8} we are. */
4693                if ((mincount > 1) || (maxcount > 1 && maxcount != REG_INFTY))
4694                     f &= ~SCF_WHILEM_VISITED_POS;
4695
4696                 /* This will finish on WHILEM, setting scan, or on NULL: */
4697                 minnext = study_chunk(pRExC_state, &scan, minlenp, &deltanext,
4698                                   last, data, stopparen, recursed_depth, NULL,
4699                                   (mincount == 0
4700                                    ? (f & ~SCF_DO_SUBSTR)
4701                                    : f)
4702                                   ,depth+1);
4703
4704                 if (flags & SCF_DO_STCLASS)
4705                     data->start_class = oclass;
4706                 if (mincount == 0 || minnext == 0) {
4707                     if (flags & SCF_DO_STCLASS_OR) {
4708                         ssc_or(pRExC_state, data->start_class, (regnode_charclass *) &this_class);
4709                     }
4710                     else if (flags & SCF_DO_STCLASS_AND) {
4711                         /* Switch to OR mode: cache the old value of
4712                          * data->start_class */
4713                         INIT_AND_WITHP;
4714                         StructCopy(data->start_class, and_withp, regnode_ssc);
4715                         flags &= ~SCF_DO_STCLASS_AND;
4716                         StructCopy(&this_class, data->start_class, regnode_ssc);
4717                         flags |= SCF_DO_STCLASS_OR;
4718                         ANYOF_FLAGS(data->start_class)
4719                                                 |= SSC_MATCHES_EMPTY_STRING;
4720                     }
4721                 } else {                /* Non-zero len */
4722                     if (flags & SCF_DO_STCLASS_OR) {
4723                         ssc_or(pRExC_state, data->start_class, (regnode_charclass *) &this_class);
4724                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
4725                     }
4726                     else if (flags & SCF_DO_STCLASS_AND)
4727                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &this_class);
4728                     flags &= ~SCF_DO_STCLASS;
4729                 }
4730                 if (!scan)              /* It was not CURLYX, but CURLY. */
4731                     scan = next;
4732                 if (!(flags & SCF_TRIE_DOING_RESTUDY)
4733                     /* ? quantifier ok, except for (?{ ... }) */
4734                     && (next_is_eval || !(mincount == 0 && maxcount == 1))
4735                     && (minnext == 0) && (deltanext == 0)
4736                     && data && !(data->flags & (SF_HAS_PAR|SF_IN_PAR))
4737                     && maxcount <= REG_INFTY/3) /* Complement check for big
4738                                                    count */
4739                 {
4740                     /* Fatal warnings may leak the regexp without this: */
4741                     SAVEFREESV(RExC_rx_sv);
4742                     Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),
4743                         "Quantifier unexpected on zero-length expression "
4744                         "in regex m/%"UTF8f"/",
4745                          UTF8fARG(UTF, RExC_end - RExC_precomp,
4746                                   RExC_precomp));
4747                     (void)ReREFCNT_inc(RExC_rx_sv);
4748                 }
4749
4750                 min += minnext * mincount;
4751                 is_inf_internal |= deltanext == SSize_t_MAX
4752                          || (maxcount == REG_INFTY && minnext + deltanext > 0);
4753                 is_inf |= is_inf_internal;
4754                 if (is_inf) {
4755                     delta = SSize_t_MAX;
4756                 } else {
4757                     delta += (minnext + deltanext) * maxcount
4758                              - minnext * mincount;
4759                 }
4760                 /* Try powerful optimization CURLYX => CURLYN. */
4761                 if (  OP(oscan) == CURLYX && data
4762                       && data->flags & SF_IN_PAR
4763                       && !(data->flags & SF_HAS_EVAL)
4764                       && !deltanext && minnext == 1 ) {
4765                     /* Try to optimize to CURLYN.  */
4766                     regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS;
4767                     regnode * const nxt1 = nxt;
4768 #ifdef DEBUGGING
4769                     regnode *nxt2;
4770 #endif
4771
4772                     /* Skip open. */
4773                     nxt = regnext(nxt);
4774                     if (!REGNODE_SIMPLE(OP(nxt))
4775                         && !(PL_regkind[OP(nxt)] == EXACT
4776                              && STR_LEN(nxt) == 1))
4777                         goto nogo;
4778 #ifdef DEBUGGING
4779                     nxt2 = nxt;
4780 #endif
4781                     nxt = regnext(nxt);
4782                     if (OP(nxt) != CLOSE)
4783                         goto nogo;
4784                     if (RExC_open_parens) {
4785                         RExC_open_parens[ARG(nxt1)-1]=oscan; /*open->CURLYM*/
4786                         RExC_close_parens[ARG(nxt1)-1]=nxt+2; /*close->while*/
4787                     }
4788                     /* Now we know that nxt2 is the only contents: */
4789                     oscan->flags = (U8)ARG(nxt);
4790                     OP(oscan) = CURLYN;
4791                     OP(nxt1) = NOTHING; /* was OPEN. */
4792
4793 #ifdef DEBUGGING
4794                     OP(nxt1 + 1) = OPTIMIZED; /* was count. */
4795                     NEXT_OFF(nxt1+ 1) = 0; /* just for consistency. */
4796                     NEXT_OFF(nxt2) = 0; /* just for consistency with CURLY. */
4797                     OP(nxt) = OPTIMIZED;        /* was CLOSE. */
4798                     OP(nxt + 1) = OPTIMIZED; /* was count. */
4799                     NEXT_OFF(nxt+ 1) = 0; /* just for consistency. */
4800 #endif
4801                 }
4802               nogo:
4803
4804                 /* Try optimization CURLYX => CURLYM. */
4805                 if (  OP(oscan) == CURLYX && data
4806                       && !(data->flags & SF_HAS_PAR)
4807                       && !(data->flags & SF_HAS_EVAL)
4808                       && !deltanext     /* atom is fixed width */
4809                       && minnext != 0   /* CURLYM can't handle zero width */
4810
4811                          /* Nor characters whose fold at run-time may be
4812                           * multi-character */
4813                       && ! (RExC_seen & REG_UNFOLDED_MULTI_SEEN)
4814                 ) {
4815                     /* XXXX How to optimize if data == 0? */
4816                     /* Optimize to a simpler form.  */
4817                     regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN */
4818                     regnode *nxt2;
4819
4820                     OP(oscan) = CURLYM;
4821                     while ( (nxt2 = regnext(nxt)) /* skip over embedded stuff*/
4822                             && (OP(nxt2) != WHILEM))
4823                         nxt = nxt2;
4824                     OP(nxt2)  = SUCCEED; /* Whas WHILEM */
4825                     /* Need to optimize away parenths. */
4826                     if ((data->flags & SF_IN_PAR) && OP(nxt) == CLOSE) {
4827                         /* Set the parenth number.  */
4828                         regnode *nxt1 = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN*/
4829
4830                         oscan->flags = (U8)ARG(nxt);
4831                         if (RExC_open_parens) {
4832                             RExC_open_parens[ARG(nxt1)-1]=oscan; /*open->CURLYM*/
4833                             RExC_close_parens[ARG(nxt1)-1]=nxt2+1; /*close->NOTHING*/
4834                         }
4835                         OP(nxt1) = OPTIMIZED;   /* was OPEN. */
4836                         OP(nxt) = OPTIMIZED;    /* was CLOSE. */
4837
4838 #ifdef DEBUGGING
4839                         OP(nxt1 + 1) = OPTIMIZED; /* was count. */
4840                         OP(nxt + 1) = OPTIMIZED; /* was count. */
4841                         NEXT_OFF(nxt1 + 1) = 0; /* just for consistency. */
4842                         NEXT_OFF(nxt + 1) = 0; /* just for consistency. */
4843 #endif
4844 #if 0
4845                         while ( nxt1 && (OP(nxt1) != WHILEM)) {
4846                             regnode *nnxt = regnext(nxt1);
4847                             if (nnxt == nxt) {
4848                                 if (reg_off_by_arg[OP(nxt1)])
4849                                     ARG_SET(nxt1, nxt2 - nxt1);
4850                                 else if (nxt2 - nxt1 < U16_MAX)
4851                                     NEXT_OFF(nxt1) = nxt2 - nxt1;
4852                                 else
4853                                     OP(nxt) = NOTHING;  /* Cannot beautify */
4854                             }
4855                             nxt1 = nnxt;
4856                         }
4857 #endif
4858                         /* Optimize again: */
4859                         study_chunk(pRExC_state, &nxt1, minlenp, &deltanext, nxt,
4860                                     NULL, stopparen, recursed_depth, NULL, 0,depth+1);
4861                     }
4862                     else
4863                         oscan->flags = 0;
4864                 }
4865                 else if ((OP(oscan) == CURLYX)
4866                          && (flags & SCF_WHILEM_VISITED_POS)
4867                          /* See the comment on a similar expression above.
4868                             However, this time it's not a subexpression
4869                             we care about, but the expression itself. */
4870                          && (maxcount == REG_INFTY)
4871                          && data && ++data->whilem_c < 16) {
4872                     /* This stays as CURLYX, we can put the count/of pair. */
4873                     /* Find WHILEM (as in regexec.c) */
4874                     regnode *nxt = oscan + NEXT_OFF(oscan);
4875
4876                     if (OP(PREVOPER(nxt)) == NOTHING) /* LONGJMP */
4877                         nxt += ARG(nxt);
4878                     PREVOPER(nxt)->flags = (U8)(data->whilem_c
4879                         | (RExC_whilem_seen << 4)); /* On WHILEM */
4880                 }
4881                 if (data && fl & (SF_HAS_PAR|SF_IN_PAR))
4882                     pars++;
4883                 if (flags & SCF_DO_SUBSTR) {
4884                     SV *last_str = NULL;
4885                     STRLEN last_chrs = 0;
4886                     int counted = mincount != 0;
4887
4888                     if (data->last_end > 0 && mincount != 0) { /* Ends with a
4889                                                                   string. */
4890                         SSize_t b = pos_before >= data->last_start_min
4891                             ? pos_before : data->last_start_min;
4892                         STRLEN l;
4893                         const char * const s = SvPV_const(data->last_found, l);
4894                         SSize_t old = b - data->last_start_min;
4895
4896                         if (UTF)
4897                             old = utf8_hop((U8*)s, old) - (U8*)s;
4898                         l -= old;
4899                         /* Get the added string: */
4900                         last_str = newSVpvn_utf8(s  + old, l, UTF);
4901                         last_chrs = UTF ? utf8_length((U8*)(s + old),
4902                                             (U8*)(s + old + l)) : l;
4903                         if (deltanext == 0 && pos_before == b) {
4904                             /* What was added is a constant string */
4905                             if (mincount > 1) {
4906
4907                                 SvGROW(last_str, (mincount * l) + 1);
4908                                 repeatcpy(SvPVX(last_str) + l,
4909                                           SvPVX_const(last_str), l,
4910                                           mincount - 1);
4911                                 SvCUR_set(last_str, SvCUR(last_str) * mincount);
4912                                 /* Add additional parts. */
4913                                 SvCUR_set(data->last_found,
4914                                           SvCUR(data->last_found) - l);
4915                                 sv_catsv(data->last_found, last_str);
4916                                 {
4917                                     SV * sv = data->last_found;
4918                                     MAGIC *mg =
4919                                         SvUTF8(sv) && SvMAGICAL(sv) ?
4920                                         mg_find(sv, PERL_MAGIC_utf8) : NULL;
4921                                     if (mg && mg->mg_len >= 0)
4922                                         mg->mg_len += last_chrs * (mincount-1);
4923                                 }
4924                                 last_chrs *= mincount;
4925                                 data->last_end += l * (mincount - 1);
4926                             }
4927                         } else {
4928                             /* start offset must point into the last copy */
4929                             data->last_start_min += minnext * (mincount - 1);
4930                             data->last_start_max =
4931                               is_inf
4932                                ? SSize_t_MAX
4933                                : data->last_start_max +
4934                                  (maxcount - 1) * (minnext + data->pos_delta);
4935                         }
4936                     }
4937                     /* It is counted once already... */
4938                     data->pos_min += minnext * (mincount - counted);
4939 #if 0
4940 PerlIO_printf(Perl_debug_log, "counted=%"UVuf" deltanext=%"UVuf
4941                               " SSize_t_MAX=%"UVuf" minnext=%"UVuf
4942                               " maxcount=%"UVuf" mincount=%"UVuf"\n",
4943     (UV)counted, (UV)deltanext, (UV)SSize_t_MAX, (UV)minnext, (UV)maxcount,
4944     (UV)mincount);
4945 if (deltanext != SSize_t_MAX)
4946 PerlIO_printf(Perl_debug_log, "LHS=%"UVuf" RHS=%"UVuf"\n",
4947     (UV)(-counted * deltanext + (minnext + deltanext) * maxcount
4948           - minnext * mincount), (UV)(SSize_t_MAX - data->pos_delta));
4949 #endif
4950                     if (deltanext == SSize_t_MAX
4951                         || -counted * deltanext + (minnext + deltanext) * maxcount - minnext * mincount >= SSize_t_MAX - data->pos_delta)
4952                         data->pos_delta = SSize_t_MAX;
4953                     else
4954                         data->pos_delta += - counted * deltanext +
4955                         (minnext + deltanext) * maxcount - minnext * mincount;
4956                     if (mincount != maxcount) {
4957                          /* Cannot extend fixed substrings found inside
4958                             the group.  */
4959                         scan_commit(pRExC_state, data, minlenp, is_inf);
4960                         if (mincount && last_str) {
4961                             SV * const sv = data->last_found;
4962                             MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
4963                                 mg_find(sv, PERL_MAGIC_utf8) : NULL;
4964
4965                             if (mg)
4966                                 mg->mg_len = -1;
4967                             sv_setsv(sv, last_str);
4968                             data->last_end = data->pos_min;
4969                             data->last_start_min = data->pos_min - last_chrs;
4970                             data->last_start_max = is_inf
4971                                 ? SSize_t_MAX
4972                                 : data->pos_min + data->pos_delta - last_chrs;
4973                         }
4974                         data->longest = &(data->longest_float);
4975                     }
4976                     SvREFCNT_dec(last_str);
4977                 }
4978                 if (data && (fl & SF_HAS_EVAL))
4979                     data->flags |= SF_HAS_EVAL;
4980               optimize_curly_tail:
4981                 if (OP(oscan) != CURLYX) {
4982                     while (PL_regkind[OP(next = regnext(oscan))] == NOTHING
4983                            && NEXT_OFF(next))
4984                         NEXT_OFF(oscan) += NEXT_OFF(next);
4985                 }
4986                 continue;
4987
4988             default:
4989 #ifdef DEBUGGING
4990                 Perl_croak(aTHX_ "panic: unexpected varying REx opcode %d",
4991                                                                     OP(scan));
4992 #endif
4993             case REF:
4994             case CLUMP:
4995                 if (flags & SCF_DO_SUBSTR) {
4996                     /* Cannot expect anything... */
4997                     scan_commit(pRExC_state, data, minlenp, is_inf);
4998                     data->longest = &(data->longest_float);
4999                 }
5000                 is_inf = is_inf_internal = 1;
5001                 if (flags & SCF_DO_STCLASS_OR) {
5002                     if (OP(scan) == CLUMP) {
5003                         /* Actually is any start char, but very few code points
5004                          * aren't start characters */
5005                         ssc_match_all_cp(data->start_class);
5006                     }
5007                     else {
5008                         ssc_anything(data->start_class);
5009                     }
5010                 }
5011                 flags &= ~SCF_DO_STCLASS;
5012                 break;
5013             }
5014         }
5015         else if (OP(scan) == LNBREAK) {
5016             if (flags & SCF_DO_STCLASS) {
5017                 if (flags & SCF_DO_STCLASS_AND) {
5018                     ssc_intersection(data->start_class,
5019                                     PL_XPosix_ptrs[_CC_VERTSPACE], FALSE);
5020                     ssc_clear_locale(data->start_class);
5021                     ANYOF_FLAGS(data->start_class)
5022                                                 &= ~SSC_MATCHES_EMPTY_STRING;
5023                 }
5024                 else if (flags & SCF_DO_STCLASS_OR) {
5025                     ssc_union(data->start_class,
5026                               PL_XPosix_ptrs[_CC_VERTSPACE],
5027                               FALSE);
5028                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5029
5030                     /* See commit msg for
5031                      * 749e076fceedeb708a624933726e7989f2302f6a */
5032                     ANYOF_FLAGS(data->start_class)
5033                                                 &= ~SSC_MATCHES_EMPTY_STRING;
5034                 }
5035                 flags &= ~SCF_DO_STCLASS;
5036             }
5037             min++;
5038             if (delta != SSize_t_MAX)
5039                 delta++;    /* Because of the 2 char string cr-lf */
5040             if (flags & SCF_DO_SUBSTR) {
5041                 /* Cannot expect anything... */
5042                 scan_commit(pRExC_state, data, minlenp, is_inf);
5043                 data->pos_min += 1;
5044                 data->pos_delta += 1;
5045                 data->longest = &(data->longest_float);
5046             }
5047         }
5048         else if (REGNODE_SIMPLE(OP(scan))) {
5049
5050             if (flags & SCF_DO_SUBSTR) {
5051                 scan_commit(pRExC_state, data, minlenp, is_inf);
5052                 data->pos_min++;
5053             }
5054             min++;
5055             if (flags & SCF_DO_STCLASS) {
5056                 bool invert = 0;
5057                 SV* my_invlist = NULL;
5058                 U8 namedclass;
5059
5060                 /* See commit msg 749e076fceedeb708a624933726e7989f2302f6a */
5061                 ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
5062
5063                 /* Some of the logic below assumes that switching
5064                    locale on will only add false positives. */
5065                 switch (OP(scan)) {
5066
5067                 default:
5068 #ifdef DEBUGGING
5069                    Perl_croak(aTHX_ "panic: unexpected simple REx opcode %d",
5070                                                                      OP(scan));
5071 #endif
5072                 case SANY:
5073                     if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
5074                         ssc_match_all_cp(data->start_class);
5075                     break;
5076
5077                 case REG_ANY:
5078                     {
5079                         SV* REG_ANY_invlist = _new_invlist(2);
5080                         REG_ANY_invlist = add_cp_to_invlist(REG_ANY_invlist,
5081                                                             '\n');
5082                         if (flags & SCF_DO_STCLASS_OR) {
5083                             ssc_union(data->start_class,
5084                                       REG_ANY_invlist,
5085                                       TRUE /* TRUE => invert, hence all but \n
5086                                             */
5087                                       );
5088                         }
5089                         else if (flags & SCF_DO_STCLASS_AND) {
5090                             ssc_intersection(data->start_class,
5091                                              REG_ANY_invlist,
5092                                              TRUE  /* TRUE => invert */
5093                                              );
5094                             ssc_clear_locale(data->start_class);
5095                         }
5096                         SvREFCNT_dec_NN(REG_ANY_invlist);
5097                     }
5098                     break;
5099
5100                 case ANYOFL:
5101                 case ANYOF:
5102                     if (flags & SCF_DO_STCLASS_AND)
5103                         ssc_and(pRExC_state, data->start_class,
5104                                 (regnode_charclass *) scan);
5105                     else
5106                         ssc_or(pRExC_state, data->start_class,
5107                                                           (regnode_charclass *) scan);
5108                     break;
5109
5110                 case NPOSIXL:
5111                     invert = 1;
5112                     /* FALLTHROUGH */
5113
5114                 case POSIXL:
5115                     namedclass = classnum_to_namedclass(FLAGS(scan)) + invert;
5116                     if (flags & SCF_DO_STCLASS_AND) {
5117                         bool was_there = cBOOL(
5118                                           ANYOF_POSIXL_TEST(data->start_class,
5119                                                                  namedclass));
5120                         ANYOF_POSIXL_ZERO(data->start_class);
5121                         if (was_there) {    /* Do an AND */
5122                             ANYOF_POSIXL_SET(data->start_class, namedclass);
5123                         }
5124                         /* No individual code points can now match */
5125                         data->start_class->invlist
5126                                                 = sv_2mortal(_new_invlist(0));
5127                     }
5128                     else {
5129                         int complement = namedclass + ((invert) ? -1 : 1);
5130
5131                         assert(flags & SCF_DO_STCLASS_OR);
5132
5133                         /* If the complement of this class was already there,
5134                          * the result is that they match all code points,
5135                          * (\d + \D == everything).  Remove the classes from
5136                          * future consideration.  Locale is not relevant in
5137                          * this case */
5138                         if (ANYOF_POSIXL_TEST(data->start_class, complement)) {
5139                             ssc_match_all_cp(data->start_class);
5140                             ANYOF_POSIXL_CLEAR(data->start_class, namedclass);
5141                             ANYOF_POSIXL_CLEAR(data->start_class, complement);
5142                         }
5143                         else {  /* The usual case; just add this class to the
5144                                    existing set */
5145                             ANYOF_POSIXL_SET(data->start_class, namedclass);
5146                         }
5147                     }
5148                     break;
5149
5150                 case NPOSIXA:   /* For these, we always know the exact set of
5151                                    what's matched */
5152                     invert = 1;
5153                     /* FALLTHROUGH */
5154                 case POSIXA:
5155                     if (FLAGS(scan) == _CC_ASCII) {
5156                         my_invlist = invlist_clone(PL_XPosix_ptrs[_CC_ASCII]);
5157                     }
5158                     else {
5159                         _invlist_intersection(PL_XPosix_ptrs[FLAGS(scan)],
5160                                               PL_XPosix_ptrs[_CC_ASCII],
5161                                               &my_invlist);
5162                     }
5163                     goto join_posix;
5164
5165                 case NPOSIXD:
5166                 case NPOSIXU:
5167                     invert = 1;
5168                     /* FALLTHROUGH */
5169                 case POSIXD:
5170                 case POSIXU:
5171                     my_invlist = invlist_clone(PL_XPosix_ptrs[FLAGS(scan)]);
5172
5173                     /* NPOSIXD matches all upper Latin1 code points unless the
5174                      * target string being matched is UTF-8, which is
5175                      * unknowable until match time.  Since we are going to
5176                      * invert, we want to get rid of all of them so that the
5177                      * inversion will match all */
5178                     if (OP(scan) == NPOSIXD) {
5179                         _invlist_subtract(my_invlist, PL_UpperLatin1,
5180                                           &my_invlist);
5181                     }
5182
5183                   join_posix:
5184
5185                     if (flags & SCF_DO_STCLASS_AND) {
5186                         ssc_intersection(data->start_class, my_invlist, invert);
5187                         ssc_clear_locale(data->start_class);
5188                     }
5189                     else {
5190                         assert(flags & SCF_DO_STCLASS_OR);
5191                         ssc_union(data->start_class, my_invlist, invert);
5192                     }
5193                     SvREFCNT_dec(my_invlist);
5194                 }
5195                 if (flags & SCF_DO_STCLASS_OR)
5196                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5197                 flags &= ~SCF_DO_STCLASS;
5198             }
5199         }
5200         else if (PL_regkind[OP(scan)] == EOL && flags & SCF_DO_SUBSTR) {
5201             data->flags |= (OP(scan) == MEOL
5202                             ? SF_BEFORE_MEOL
5203                             : SF_BEFORE_SEOL);
5204             scan_commit(pRExC_state, data, minlenp, is_inf);
5205
5206         }
5207         else if (  PL_regkind[OP(scan)] == BRANCHJ
5208                  /* Lookbehind, or need to calculate parens/evals/stclass: */
5209                    && (scan->flags || data || (flags & SCF_DO_STCLASS))
5210                    && (OP(scan) == IFMATCH || OP(scan) == UNLESSM))
5211         {
5212             if ( !PERL_ENABLE_POSITIVE_ASSERTION_STUDY
5213                 || OP(scan) == UNLESSM )
5214             {
5215                 /* Negative Lookahead/lookbehind
5216                    In this case we can't do fixed string optimisation.
5217                 */
5218
5219                 SSize_t deltanext, minnext, fake = 0;
5220                 regnode *nscan;
5221                 regnode_ssc intrnl;
5222                 int f = 0;
5223
5224                 StructCopy(&zero_scan_data, &data_fake, scan_data_t);
5225                 if (data) {
5226                     data_fake.whilem_c = data->whilem_c;
5227                     data_fake.last_closep = data->last_closep;
5228                 }
5229                 else
5230                     data_fake.last_closep = &fake;
5231                 data_fake.pos_delta = delta;
5232                 if ( flags & SCF_DO_STCLASS && !scan->flags
5233                      && OP(scan) == IFMATCH ) { /* Lookahead */
5234                     ssc_init(pRExC_state, &intrnl);
5235                     data_fake.start_class = &intrnl;
5236                     f |= SCF_DO_STCLASS_AND;
5237                 }
5238                 if (flags & SCF_WHILEM_VISITED_POS)
5239                     f |= SCF_WHILEM_VISITED_POS;
5240                 next = regnext(scan);
5241                 nscan = NEXTOPER(NEXTOPER(scan));
5242                 minnext = study_chunk(pRExC_state, &nscan, minlenp, &deltanext,
5243                                       last, &data_fake, stopparen,
5244                                       recursed_depth, NULL, f, depth+1);
5245                 if (scan->flags) {
5246                     if (deltanext) {
5247                         FAIL("Variable length lookbehind not implemented");
5248                     }
5249                     else if (minnext > (I32)U8_MAX) {
5250                         FAIL2("Lookbehind longer than %"UVuf" not implemented",
5251                               (UV)U8_MAX);
5252                     }
5253                     scan->flags = (U8)minnext;
5254                 }
5255                 if (data) {
5256                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
5257                         pars++;
5258                     if (data_fake.flags & SF_HAS_EVAL)
5259                         data->flags |= SF_HAS_EVAL;
5260                     data->whilem_c = data_fake.whilem_c;
5261                 }
5262                 if (f & SCF_DO_STCLASS_AND) {
5263                     if (flags & SCF_DO_STCLASS_OR) {
5264                         /* OR before, AND after: ideally we would recurse with
5265                          * data_fake to get the AND applied by study of the
5266                          * remainder of the pattern, and then derecurse;
5267                          * *** HACK *** for now just treat as "no information".
5268                          * See [perl #56690].
5269                          */
5270                         ssc_init(pRExC_state, data->start_class);
5271                     }  else {
5272                         /* AND before and after: combine and continue.  These
5273                          * assertions are zero-length, so can match an EMPTY
5274                          * string */
5275                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &intrnl);
5276                         ANYOF_FLAGS(data->start_class)
5277                                                    |= SSC_MATCHES_EMPTY_STRING;
5278                     }
5279                 }
5280             }
5281 #if PERL_ENABLE_POSITIVE_ASSERTION_STUDY
5282             else {
5283                 /* Positive Lookahead/lookbehind
5284                    In this case we can do fixed string optimisation,
5285                    but we must be careful about it. Note in the case of
5286                    lookbehind the positions will be offset by the minimum
5287                    length of the pattern, something we won't know about
5288                    until after the recurse.
5289                 */
5290                 SSize_t deltanext, fake = 0;
5291                 regnode *nscan;
5292                 regnode_ssc intrnl;
5293                 int f = 0;
5294                 /* We use SAVEFREEPV so that when the full compile
5295                     is finished perl will clean up the allocated
5296                     minlens when it's all done. This way we don't
5297                     have to worry about freeing them when we know
5298                     they wont be used, which would be a pain.
5299                  */
5300                 SSize_t *minnextp;
5301                 Newx( minnextp, 1, SSize_t );
5302                 SAVEFREEPV(minnextp);
5303
5304                 if (data) {
5305                     StructCopy(data, &data_fake, scan_data_t);
5306                     if ((flags & SCF_DO_SUBSTR) && data->last_found) {
5307                         f |= SCF_DO_SUBSTR;
5308                         if (scan->flags)
5309                             scan_commit(pRExC_state, &data_fake, minlenp, is_inf);
5310                         data_fake.last_found=newSVsv(data->last_found);
5311                     }
5312                 }
5313                 else
5314                     data_fake.last_closep = &fake;
5315                 data_fake.flags = 0;
5316                 data_fake.pos_delta = delta;
5317                 if (is_inf)
5318                     data_fake.flags |= SF_IS_INF;
5319                 if ( flags & SCF_DO_STCLASS && !scan->flags
5320                      && OP(scan) == IFMATCH ) { /* Lookahead */
5321                     ssc_init(pRExC_state, &intrnl);
5322                     data_fake.start_class = &intrnl;
5323                     f |= SCF_DO_STCLASS_AND;
5324                 }
5325                 if (flags & SCF_WHILEM_VISITED_POS)
5326                     f |= SCF_WHILEM_VISITED_POS;
5327                 next = regnext(scan);
5328                 nscan = NEXTOPER(NEXTOPER(scan));
5329
5330                 *minnextp = study_chunk(pRExC_state, &nscan, minnextp,
5331                                         &deltanext, last, &data_fake,
5332                                         stopparen, recursed_depth, NULL,
5333                                         f,depth+1);
5334                 if (scan->flags) {
5335                     if (deltanext) {
5336                         FAIL("Variable length lookbehind not implemented");
5337                     }
5338                     else if (*minnextp > (I32)U8_MAX) {
5339                         FAIL2("Lookbehind longer than %"UVuf" not implemented",
5340                               (UV)U8_MAX);
5341                     }
5342                     scan->flags = (U8)*minnextp;
5343                 }
5344
5345                 *minnextp += min;
5346
5347                 if (f & SCF_DO_STCLASS_AND) {
5348                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &intrnl);
5349                     ANYOF_FLAGS(data->start_class) |= SSC_MATCHES_EMPTY_STRING;
5350                 }
5351                 if (data) {
5352                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
5353                         pars++;
5354                     if (data_fake.flags & SF_HAS_EVAL)
5355                         data->flags |= SF_HAS_EVAL;
5356                     data->whilem_c = data_fake.whilem_c;
5357                     if ((flags & SCF_DO_SUBSTR) && data_fake.last_found) {
5358                         if (RExC_rx->minlen<*minnextp)
5359                             RExC_rx->minlen=*minnextp;
5360                         scan_commit(pRExC_state, &data_fake, minnextp, is_inf);
5361                         SvREFCNT_dec_NN(data_fake.last_found);
5362
5363                         if ( data_fake.minlen_fixed != minlenp )
5364                         {
5365                             data->offset_fixed= data_fake.offset_fixed;
5366                             data->minlen_fixed= data_fake.minlen_fixed;
5367                             data->lookbehind_fixed+= scan->flags;
5368                         }
5369                         if ( data_fake.minlen_float != minlenp )
5370                         {
5371                             data->minlen_float= data_fake.minlen_float;
5372                             data->offset_float_min=data_fake.offset_float_min;
5373                             data->offset_float_max=data_fake.offset_float_max;
5374                             data->lookbehind_float+= scan->flags;
5375                         }
5376                     }
5377                 }
5378             }
5379 #endif
5380         }
5381         else if (OP(scan) == OPEN) {
5382             if (stopparen != (I32)ARG(scan))
5383                 pars++;
5384         }
5385         else if (OP(scan) == CLOSE) {
5386             if (stopparen == (I32)ARG(scan)) {
5387                 break;
5388             }
5389             if ((I32)ARG(scan) == is_par) {
5390                 next = regnext(scan);
5391
5392                 if ( next && (OP(next) != WHILEM) && next < last)
5393                     is_par = 0;         /* Disable optimization */
5394             }
5395             if (data)
5396                 *(data->last_closep) = ARG(scan);
5397         }
5398         else if (OP(scan) == EVAL) {
5399                 if (data)
5400                     data->flags |= SF_HAS_EVAL;
5401         }
5402         else if ( PL_regkind[OP(scan)] == ENDLIKE ) {
5403             if (flags & SCF_DO_SUBSTR) {
5404                 scan_commit(pRExC_state, data, minlenp, is_inf);
5405                 flags &= ~SCF_DO_SUBSTR;
5406             }
5407             if (data && OP(scan)==ACCEPT) {
5408                 data->flags |= SCF_SEEN_ACCEPT;
5409                 if (stopmin > min)
5410                     stopmin = min;
5411             }
5412         }
5413         else if (OP(scan) == LOGICAL && scan->flags == 2) /* Embedded follows */
5414         {
5415                 if (flags & SCF_DO_SUBSTR) {
5416                     scan_commit(pRExC_state, data, minlenp, is_inf);
5417                     data->longest = &(data->longest_float);
5418                 }
5419                 is_inf = is_inf_internal = 1;
5420                 if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
5421                     ssc_anything(data->start_class);
5422                 flags &= ~SCF_DO_STCLASS;
5423         }
5424         else if (OP(scan) == GPOS) {
5425             if (!(RExC_rx->intflags & PREGf_GPOS_FLOAT) &&
5426                 !(delta || is_inf || (data && data->pos_delta)))
5427             {
5428                 if (!(RExC_rx->intflags & PREGf_ANCH) && (flags & SCF_DO_SUBSTR))
5429                     RExC_rx->intflags |= PREGf_ANCH_GPOS;
5430                 if (RExC_rx->gofs < (STRLEN)min)
5431                     RExC_rx->gofs = min;
5432             } else {
5433                 RExC_rx->intflags |= PREGf_GPOS_FLOAT;
5434                 RExC_rx->gofs = 0;
5435             }
5436         }
5437 #ifdef TRIE_STUDY_OPT
5438 #ifdef FULL_TRIE_STUDY
5439         else if (PL_regkind[OP(scan)] == TRIE) {
5440             /* NOTE - There is similar code to this block above for handling
5441                BRANCH nodes on the initial study.  If you change stuff here
5442                check there too. */
5443             regnode *trie_node= scan;
5444             regnode *tail= regnext(scan);
5445             reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
5446             SSize_t max1 = 0, min1 = SSize_t_MAX;
5447             regnode_ssc accum;
5448
5449             if (flags & SCF_DO_SUBSTR) { /* XXXX Add !SUSPEND? */
5450                 /* Cannot merge strings after this. */
5451                 scan_commit(pRExC_state, data, minlenp, is_inf);
5452             }
5453             if (flags & SCF_DO_STCLASS)
5454                 ssc_init_zero(pRExC_state, &accum);
5455
5456             if (!trie->jump) {
5457                 min1= trie->minlen;
5458                 max1= trie->maxlen;
5459             } else {
5460                 const regnode *nextbranch= NULL;
5461                 U32 word;
5462
5463                 for ( word=1 ; word <= trie->wordcount ; word++)
5464                 {
5465                     SSize_t deltanext=0, minnext=0, f = 0, fake;
5466                     regnode_ssc this_class;
5467
5468                     StructCopy(&zero_scan_data, &data_fake, scan_data_t);
5469                     if (data) {
5470                         data_fake.whilem_c = data->whilem_c;
5471                         data_fake.last_closep = data->last_closep;
5472                     }
5473                     else
5474                         data_fake.last_closep = &fake;
5475                     data_fake.pos_delta = delta;
5476                     if (flags & SCF_DO_STCLASS) {
5477                         ssc_init(pRExC_state, &this_class);
5478                         data_fake.start_class = &this_class;
5479                         f = SCF_DO_STCLASS_AND;
5480                     }
5481                     if (flags & SCF_WHILEM_VISITED_POS)
5482                         f |= SCF_WHILEM_VISITED_POS;
5483
5484                     if (trie->jump[word]) {
5485                         if (!nextbranch)
5486                             nextbranch = trie_node + trie->jump[0];
5487                         scan= trie_node + trie->jump[word];
5488                         /* We go from the jump point to the branch that follows
5489                            it. Note this means we need the vestigal unused
5490                            branches even though they arent otherwise used. */
5491                         minnext = study_chunk(pRExC_state, &scan, minlenp,
5492                             &deltanext, (regnode *)nextbranch, &data_fake,
5493                             stopparen, recursed_depth, NULL, f,depth+1);
5494                     }
5495                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
5496                         nextbranch= regnext((regnode*)nextbranch);
5497
5498                     if (min1 > (SSize_t)(minnext + trie->minlen))
5499                         min1 = minnext + trie->minlen;
5500                     if (deltanext == SSize_t_MAX) {
5501                         is_inf = is_inf_internal = 1;
5502                         max1 = SSize_t_MAX;
5503                     } else if (max1 < (SSize_t)(minnext + deltanext + trie->maxlen))
5504                         max1 = minnext + deltanext + trie->maxlen;
5505
5506                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
5507                         pars++;
5508                     if (data_fake.flags & SCF_SEEN_ACCEPT) {
5509                         if ( stopmin > min + min1)
5510                             stopmin = min + min1;
5511                         flags &= ~SCF_DO_SUBSTR;
5512                         if (data)
5513                             data->flags |= SCF_SEEN_ACCEPT;
5514                     }
5515                     if (data) {
5516                         if (data_fake.flags & SF_HAS_EVAL)
5517                             data->flags |= SF_HAS_EVAL;
5518                         data->whilem_c = data_fake.whilem_c;
5519                     }
5520                     if (flags & SCF_DO_STCLASS)
5521                         ssc_or(pRExC_state, &accum, (regnode_charclass *) &this_class);
5522                 }
5523             }
5524             if (flags & SCF_DO_SUBSTR) {
5525                 data->pos_min += min1;
5526                 data->pos_delta += max1 - min1;
5527                 if (max1 != min1 || is_inf)
5528                     data->longest = &(data->longest_float);
5529             }
5530             min += min1;
5531             if (delta != SSize_t_MAX)
5532                 delta += max1 - min1;
5533             if (flags & SCF_DO_STCLASS_OR) {
5534                 ssc_or(pRExC_state, data->start_class, (regnode_charclass *) &accum);
5535                 if (min1) {
5536                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5537                     flags &= ~SCF_DO_STCLASS;
5538                 }
5539             }
5540             else if (flags & SCF_DO_STCLASS_AND) {
5541                 if (min1) {
5542                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &accum);
5543                     flags &= ~SCF_DO_STCLASS;
5544                 }
5545                 else {
5546                     /* Switch to OR mode: cache the old value of
5547                      * data->start_class */
5548                     INIT_AND_WITHP;
5549                     StructCopy(data->start_class, and_withp, regnode_ssc);
5550                     flags &= ~SCF_DO_STCLASS_AND;
5551                     StructCopy(&accum, data->start_class, regnode_ssc);
5552                     flags |= SCF_DO_STCLASS_OR;
5553                 }
5554             }
5555             scan= tail;
5556             continue;
5557         }
5558 #else
5559         else if (PL_regkind[OP(scan)] == TRIE) {
5560             reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
5561             U8*bang=NULL;
5562
5563             min += trie->minlen;
5564             delta += (trie->maxlen - trie->minlen);
5565             flags &= ~SCF_DO_STCLASS; /* xxx */
5566             if (flags & SCF_DO_SUBSTR) {
5567                 /* Cannot expect anything... */
5568                 scan_commit(pRExC_state, data, minlenp, is_inf);
5569                 data->pos_min += trie->minlen;
5570                 data->pos_delta += (trie->maxlen - trie->minlen);
5571                 if (trie->maxlen != trie->minlen)
5572                     data->longest = &(data->longest_float);
5573             }
5574             if (trie->jump) /* no more substrings -- for now /grr*/
5575                flags &= ~SCF_DO_SUBSTR;
5576         }
5577 #endif /* old or new */
5578 #endif /* TRIE_STUDY_OPT */
5579
5580         /* Else: zero-length, ignore. */
5581         scan = regnext(scan);
5582     }
5583     /* If we are exiting a recursion we can unset its recursed bit
5584      * and allow ourselves to enter it again - no danger of an
5585      * infinite loop there.
5586     if (stopparen > -1 && recursed) {
5587         DEBUG_STUDYDATA("unset:", data,depth);
5588         PAREN_UNSET( recursed, stopparen);
5589     }
5590     */
5591     if (frame) {
5592         depth = depth - 1;
5593
5594         DEBUG_STUDYDATA("frame-end:",data,depth);
5595         DEBUG_PEEP("fend", scan, depth);
5596
5597         /* restore previous context */
5598         last = frame->last_regnode;
5599         scan = frame->next_regnode;
5600         stopparen = frame->stopparen;
5601         recursed_depth = frame->prev_recursed_depth;
5602
5603         RExC_frame_last = frame->prev_frame;
5604         frame = frame->this_prev_frame;
5605         goto fake_study_recurse;
5606     }
5607
5608   finish:
5609     assert(!frame);
5610     DEBUG_STUDYDATA("pre-fin:",data,depth);
5611
5612     *scanp = scan;
5613     *deltap = is_inf_internal ? SSize_t_MAX : delta;
5614
5615     if (flags & SCF_DO_SUBSTR && is_inf)
5616         data->pos_delta = SSize_t_MAX - data->pos_min;
5617     if (is_par > (I32)U8_MAX)
5618         is_par = 0;
5619     if (is_par && pars==1 && data) {
5620         data->flags |= SF_IN_PAR;
5621         data->flags &= ~SF_HAS_PAR;
5622     }
5623     else if (pars && data) {
5624         data->flags |= SF_HAS_PAR;
5625         data->flags &= ~SF_IN_PAR;
5626     }
5627     if (flags & SCF_DO_STCLASS_OR)
5628         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5629     if (flags & SCF_TRIE_RESTUDY)
5630         data->flags |=  SCF_TRIE_RESTUDY;
5631
5632     DEBUG_STUDYDATA("post-fin:",data,depth);
5633
5634     {
5635         SSize_t final_minlen= min < stopmin ? min : stopmin;
5636
5637         if (!(RExC_seen & REG_UNBOUNDED_QUANTIFIER_SEEN)) {
5638             if (final_minlen > SSize_t_MAX - delta)
5639                 RExC_maxlen = SSize_t_MAX;
5640             else if (RExC_maxlen < final_minlen + delta)
5641                 RExC_maxlen = final_minlen + delta;
5642         }
5643         return final_minlen;
5644     }
5645     NOT_REACHED; /* NOTREACHED */
5646 }
5647
5648 STATIC U32
5649 S_add_data(RExC_state_t* const pRExC_state, const char* const s, const U32 n)
5650 {
5651     U32 count = RExC_rxi->data ? RExC_rxi->data->count : 0;
5652
5653     PERL_ARGS_ASSERT_ADD_DATA;
5654
5655     Renewc(RExC_rxi->data,
5656            sizeof(*RExC_rxi->data) + sizeof(void*) * (count + n - 1),
5657            char, struct reg_data);
5658     if(count)
5659         Renew(RExC_rxi->data->what, count + n, U8);
5660     else
5661         Newx(RExC_rxi->data->what, n, U8);
5662     RExC_rxi->data->count = count + n;
5663     Copy(s, RExC_rxi->data->what + count, n, U8);
5664     return count;
5665 }
5666
5667 /*XXX: todo make this not included in a non debugging perl, but appears to be
5668  * used anyway there, in 'use re' */
5669 #ifndef PERL_IN_XSUB_RE
5670 void
5671 Perl_reginitcolors(pTHX)
5672 {
5673     const char * const s = PerlEnv_getenv("PERL_RE_COLORS");
5674     if (s) {
5675         char *t = savepv(s);
5676         int i = 0;
5677         PL_colors[0] = t;
5678         while (++i < 6) {
5679             t = strchr(t, '\t');
5680             if (t) {
5681                 *t = '\0';
5682                 PL_colors[i] = ++t;
5683             }
5684             else
5685                 PL_colors[i] = t = (char *)"";
5686         }
5687     } else {
5688         int i = 0;
5689         while (i < 6)
5690             PL_colors[i++] = (char *)"";
5691     }
5692     PL_colorset = 1;
5693 }
5694 #endif
5695
5696
5697 #ifdef TRIE_STUDY_OPT
5698 #define CHECK_RESTUDY_GOTO_butfirst(dOsomething)            \
5699     STMT_START {                                            \
5700         if (                                                \
5701               (data.flags & SCF_TRIE_RESTUDY)               \
5702               && ! restudied++                              \
5703         ) {                                                 \
5704             dOsomething;                                    \
5705             goto reStudy;                                   \
5706         }                                                   \
5707     } STMT_END
5708 #else
5709 #define CHECK_RESTUDY_GOTO_butfirst
5710 #endif
5711
5712 /*
5713  * pregcomp - compile a regular expression into internal code
5714  *
5715  * Decides which engine's compiler to call based on the hint currently in
5716  * scope
5717  */
5718
5719 #ifndef PERL_IN_XSUB_RE
5720
5721 /* return the currently in-scope regex engine (or the default if none)  */
5722
5723 regexp_engine const *
5724 Perl_current_re_engine(pTHX)
5725 {
5726     if (IN_PERL_COMPILETIME) {
5727         HV * const table = GvHV(PL_hintgv);
5728         SV **ptr;
5729
5730         if (!table || !(PL_hints & HINT_LOCALIZE_HH))
5731             return &PL_core_reg_engine;
5732         ptr = hv_fetchs(table, "regcomp", FALSE);
5733         if ( !(ptr && SvIOK(*ptr) && SvIV(*ptr)))
5734             return &PL_core_reg_engine;
5735         return INT2PTR(regexp_engine*,SvIV(*ptr));
5736     }
5737     else {
5738         SV *ptr;
5739         if (!PL_curcop->cop_hints_hash)
5740             return &PL_core_reg_engine;
5741         ptr = cop_hints_fetch_pvs(PL_curcop, "regcomp", 0);
5742         if ( !(ptr && SvIOK(ptr) && SvIV(ptr)))
5743             return &PL_core_reg_engine;
5744         return INT2PTR(regexp_engine*,SvIV(ptr));
5745     }
5746 }
5747
5748
5749 REGEXP *
5750 Perl_pregcomp(pTHX_ SV * const pattern, const U32 flags)
5751 {
5752     regexp_engine const *eng = current_re_engine();
5753     GET_RE_DEBUG_FLAGS_DECL;
5754
5755     PERL_ARGS_ASSERT_PREGCOMP;
5756
5757     /* Dispatch a request to compile a regexp to correct regexp engine. */
5758     DEBUG_COMPILE_r({
5759         PerlIO_printf(Perl_debug_log, "Using engine %"UVxf"\n",
5760                         PTR2UV(eng));
5761     });
5762     return CALLREGCOMP_ENG(eng, pattern, flags);
5763 }
5764 #endif
5765
5766 /* public(ish) entry point for the perl core's own regex compiling code.
5767  * It's actually a wrapper for Perl_re_op_compile that only takes an SV
5768  * pattern rather than a list of OPs, and uses the internal engine rather
5769  * than the current one */
5770
5771 REGEXP *
5772 Perl_re_compile(pTHX_ SV * const pattern, U32 rx_flags)
5773 {
5774     SV *pat = pattern; /* defeat constness! */
5775     PERL_ARGS_ASSERT_RE_COMPILE;
5776     return Perl_re_op_compile(aTHX_ &pat, 1, NULL,
5777 #ifdef PERL_IN_XSUB_RE
5778                                 &my_reg_engine,
5779 #else
5780                                 &PL_core_reg_engine,
5781 #endif
5782                                 NULL, NULL, rx_flags, 0);
5783 }
5784
5785
5786 /* upgrade pattern pat_p of length plen_p to UTF8, and if there are code
5787  * blocks, recalculate the indices. Update pat_p and plen_p in-place to
5788  * point to the realloced string and length.
5789  *
5790  * This is essentially a copy of Perl_bytes_to_utf8() with the code index
5791  * stuff added */
5792
5793 static void
5794 S_pat_upgrade_to_utf8(pTHX_ RExC_state_t * const pRExC_state,
5795                     char **pat_p, STRLEN *plen_p, int num_code_blocks)
5796 {
5797     U8 *const src = (U8*)*pat_p;
5798     U8 *dst, *d;
5799     int n=0;
5800     STRLEN s = 0;
5801     bool do_end = 0;
5802     GET_RE_DEBUG_FLAGS_DECL;
5803
5804     DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log,
5805         "UTF8 mismatch! Converting to utf8 for resizing and compile\n"));
5806
5807     Newx(dst, *plen_p * 2 + 1, U8);
5808     d = dst;
5809
5810     while (s < *plen_p) {
5811         append_utf8_from_native_byte(src[s], &d);
5812         if (n < num_code_blocks) {
5813             if (!do_end && pRExC_state->code_blocks[n].start == s) {
5814                 pRExC_state->code_blocks[n].start = d - dst - 1;
5815                 assert(*(d - 1) == '(');
5816                 do_end = 1;
5817             }
5818             else if (do_end && pRExC_state->code_blocks[n].end == s) {
5819                 pRExC_state->code_blocks[n].end = d - dst - 1;
5820                 assert(*(d - 1) == ')');
5821                 do_end = 0;
5822                 n++;
5823             }
5824         }
5825         s++;
5826     }
5827     *d = '\0';
5828     *plen_p = d - dst;
5829     *pat_p = (char*) dst;
5830     SAVEFREEPV(*pat_p);
5831     RExC_orig_utf8 = RExC_utf8 = 1;
5832 }
5833
5834
5835
5836 /* S_concat_pat(): concatenate a list of args to the pattern string pat,
5837  * while recording any code block indices, and handling overloading,
5838  * nested qr// objects etc.  If pat is null, it will allocate a new
5839  * string, or just return the first arg, if there's only one.
5840  *
5841  * Returns the malloced/updated pat.
5842  * patternp and pat_count is the array of SVs to be concatted;
5843  * oplist is the optional list of ops that generated the SVs;
5844  * recompile_p is a pointer to a boolean that will be set if
5845  *   the regex will need to be recompiled.
5846  * delim, if non-null is an SV that will be inserted between each element
5847  */
5848
5849 static SV*
5850 S_concat_pat(pTHX_ RExC_state_t * const pRExC_state,
5851                 SV *pat, SV ** const patternp, int pat_count,
5852                 OP *oplist, bool *recompile_p, SV *delim)
5853 {
5854     SV **svp;
5855     int n = 0;
5856     bool use_delim = FALSE;
5857     bool alloced = FALSE;
5858
5859     /* if we know we have at least two args, create an empty string,
5860      * then concatenate args to that. For no args, return an empty string */
5861     if (!pat && pat_count != 1) {
5862         pat = newSVpvs("");
5863         SAVEFREESV(pat);
5864         alloced = TRUE;
5865     }
5866
5867     for (svp = patternp; svp < patternp + pat_count; svp++) {
5868         SV *sv;
5869         SV *rx  = NULL;
5870         STRLEN orig_patlen = 0;
5871         bool code = 0;
5872         SV *msv = use_delim ? delim : *svp;
5873         if (!msv) msv = &PL_sv_undef;
5874
5875         /* if we've got a delimiter, we go round the loop twice for each
5876          * svp slot (except the last), using the delimiter the second
5877          * time round */
5878         if (use_delim) {
5879             svp--;
5880             use_delim = FALSE;
5881         }
5882         else if (delim)
5883             use_delim = TRUE;
5884
5885         if (SvTYPE(msv) == SVt_PVAV) {
5886             /* we've encountered an interpolated array within
5887              * the pattern, e.g. /...@a..../. Expand the list of elements,
5888              * then recursively append elements.
5889              * The code in this block is based on S_pushav() */
5890
5891             AV *const av = (AV*)msv;
5892             const SSize_t maxarg = AvFILL(av) + 1;
5893             SV **array;
5894
5895             if (oplist) {
5896                 assert(oplist->op_type == OP_PADAV
5897                     || oplist->op_type == OP_RV2AV);
5898                 oplist = OpSIBLING(oplist);
5899             }
5900
5901             if (SvRMAGICAL(av)) {
5902                 SSize_t i;
5903
5904                 Newx(array, maxarg, SV*);
5905                 SAVEFREEPV(array);
5906                 for (i=0; i < maxarg; i++) {
5907                     SV ** const svp = av_fetch(av, i, FALSE);
5908                     array[i] = svp ? *svp : &PL_sv_undef;
5909                 }
5910             }
5911             else
5912                 array = AvARRAY(av);
5913
5914             pat = S_concat_pat(aTHX_ pRExC_state, pat,
5915                                 array, maxarg, NULL, recompile_p,
5916                                 /* $" */
5917                                 GvSV((gv_fetchpvs("\"", GV_ADDMULTI, SVt_PV))));
5918
5919             continue;
5920         }
5921
5922
5923         /* we make the assumption here that each op in the list of
5924          * op_siblings maps to one SV pushed onto the stack,
5925          * except for code blocks, with have both an OP_NULL and
5926          * and OP_CONST.
5927          * This allows us to match up the list of SVs against the
5928          * list of OPs to find the next code block.
5929          *
5930          * Note that       PUSHMARK PADSV PADSV ..
5931          * is optimised to
5932          *                 PADRANGE PADSV  PADSV  ..
5933          * so the alignment still works. */
5934
5935         if (oplist) {
5936             if (oplist->op_type == OP_NULL
5937                 && (oplist->op_flags & OPf_SPECIAL))
5938             {
5939                 assert(n < pRExC_state->num_code_blocks);
5940                 pRExC_state->code_blocks[n].start = pat ? SvCUR(pat) : 0;
5941                 pRExC_state->code_blocks[n].block = oplist;
5942                 pRExC_state->code_blocks[n].src_regex = NULL;
5943                 n++;
5944                 code = 1;
5945                 oplist = OpSIBLING(oplist); /* skip CONST */
5946                 assert(oplist);
5947             }
5948             oplist = OpSIBLING(oplist);;
5949         }
5950
5951         /* apply magic and QR overloading to arg */
5952
5953         SvGETMAGIC(msv);
5954         if (SvROK(msv) && SvAMAGIC(msv)) {
5955             SV *sv = AMG_CALLunary(msv, regexp_amg);
5956             if (sv) {
5957                 if (SvROK(sv))
5958                     sv = SvRV(sv);
5959                 if (SvTYPE(sv) != SVt_REGEXP)
5960                     Perl_croak(aTHX_ "Overloaded qr did not return a REGEXP");
5961                 msv = sv;
5962             }
5963         }
5964
5965         /* try concatenation overload ... */
5966         if (pat && (SvAMAGIC(pat) || SvAMAGIC(msv)) &&
5967                 (sv = amagic_call(pat, msv, concat_amg, AMGf_assign)))
5968         {
5969             sv_setsv(pat, sv);
5970             /* overloading involved: all bets are off over literal
5971              * code. Pretend we haven't seen it */
5972             pRExC_state->num_code_blocks -= n;
5973             n = 0;
5974         }
5975         else  {
5976             /* ... or failing that, try "" overload */
5977             while (SvAMAGIC(msv)
5978                     && (sv = AMG_CALLunary(msv, string_amg))
5979                     && sv != msv
5980                     &&  !(   SvROK(msv)
5981                           && SvROK(sv)
5982                           && SvRV(msv) == SvRV(sv))
5983             ) {
5984                 msv = sv;
5985                 SvGETMAGIC(msv);
5986             }
5987             if (SvROK(msv) && SvTYPE(SvRV(msv)) == SVt_REGEXP)
5988                 msv = SvRV(msv);
5989
5990             if (pat) {
5991                 /* this is a partially unrolled
5992                  *     sv_catsv_nomg(pat, msv);
5993                  * that allows us to adjust code block indices if
5994                  * needed */
5995                 STRLEN dlen;
5996                 char *dst = SvPV_force_nomg(pat, dlen);
5997                 orig_patlen = dlen;
5998                 if (SvUTF8(msv) && !SvUTF8(pat)) {
5999                     S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &dst, &dlen, n);
6000                     sv_setpvn(pat, dst, dlen);
6001                     SvUTF8_on(pat);
6002                 }
6003                 sv_catsv_nomg(pat, msv);
6004                 rx = msv;
6005             }
6006             else
6007                 pat = msv;
6008
6009             if (code)
6010                 pRExC_state->code_blocks[n-1].end = SvCUR(pat)-1;
6011         }
6012
6013         /* extract any code blocks within any embedded qr//'s */
6014         if (rx && SvTYPE(rx) == SVt_REGEXP
6015             && RX_ENGINE((REGEXP*)rx)->op_comp)
6016         {
6017
6018             RXi_GET_DECL(ReANY((REGEXP *)rx), ri);
6019             if (ri->num_code_blocks) {
6020                 int i;
6021                 /* the presence of an embedded qr// with code means
6022                  * we should always recompile: the text of the
6023                  * qr// may not have changed, but it may be a
6024                  * different closure than last time */
6025                 *recompile_p = 1;
6026                 Renew(pRExC_state->code_blocks,
6027                     pRExC_state->num_code_blocks + ri->num_code_blocks,
6028                     struct reg_code_block);
6029                 pRExC_state->num_code_blocks += ri->num_code_blocks;
6030
6031                 for (i=0; i < ri->num_code_blocks; i++) {
6032                     struct reg_code_block *src, *dst;
6033                     STRLEN offset =  orig_patlen
6034                         + ReANY((REGEXP *)rx)->pre_prefix;
6035                     assert(n < pRExC_state->num_code_blocks);
6036                     src = &ri->code_blocks[i];
6037                     dst = &pRExC_state->code_blocks[n];
6038                     dst->start      = src->start + offset;
6039                     dst->end        = src->end   + offset;
6040                     dst->block      = src->block;
6041                     dst->src_regex  = (REGEXP*) SvREFCNT_inc( (SV*)
6042                                             src->src_regex
6043                                                 ? src->src_regex
6044                                                 : (REGEXP*)rx);
6045                     n++;
6046                 }
6047             }
6048         }
6049     }
6050     /* avoid calling magic multiple times on a single element e.g. =~ $qr */
6051     if (alloced)
6052         SvSETMAGIC(pat);
6053
6054     return pat;
6055 }
6056
6057
6058
6059 /* see if there are any run-time code blocks in the pattern.
6060  * False positives are allowed */
6061
6062 static bool
6063 S_has_runtime_code(pTHX_ RExC_state_t * const pRExC_state,
6064                     char *pat, STRLEN plen)
6065 {
6066     int n = 0;
6067     STRLEN s;
6068     
6069     PERL_UNUSED_CONTEXT;
6070
6071     for (s = 0; s < plen; s++) {
6072         if (n < pRExC_state->num_code_blocks
6073             && s == pRExC_state->code_blocks[n].start)
6074         {
6075             s = pRExC_state->code_blocks[n].end;
6076             n++;
6077             continue;
6078         }
6079         /* TODO ideally should handle [..], (#..), /#.../x to reduce false
6080          * positives here */
6081         if (pat[s] == '(' && s+2 <= plen && pat[s+1] == '?' &&
6082             (pat[s+2] == '{'
6083                 || (s + 2 <= plen && pat[s+2] == '?' && pat[s+3] == '{'))
6084         )
6085             return 1;
6086     }
6087     return 0;
6088 }
6089
6090 /* Handle run-time code blocks. We will already have compiled any direct
6091  * or indirect literal code blocks. Now, take the pattern 'pat' and make a
6092  * copy of it, but with any literal code blocks blanked out and
6093  * appropriate chars escaped; then feed it into
6094  *
6095  *    eval "qr'modified_pattern'"
6096  *
6097  * For example,
6098  *
6099  *       a\bc(?{"this was literal"})def'ghi\\jkl(?{"this is runtime"})mno
6100  *
6101  * becomes
6102  *
6103  *    qr'a\\bc_______________________def\'ghi\\\\jkl(?{"this is runtime"})mno'
6104  *
6105  * After eval_sv()-ing that, grab any new code blocks from the returned qr
6106  * and merge them with any code blocks of the original regexp.
6107  *
6108  * If the pat is non-UTF8, while the evalled qr is UTF8, don't merge;
6109  * instead, just save the qr and return FALSE; this tells our caller that
6110  * the original pattern needs upgrading to utf8.
6111  */
6112
6113 static bool
6114 S_compile_runtime_code(pTHX_ RExC_state_t * const pRExC_state,
6115     char *pat, STRLEN plen)
6116 {
6117     SV *qr;
6118
6119     GET_RE_DEBUG_FLAGS_DECL;
6120
6121     if (pRExC_state->runtime_code_qr) {
6122         /* this is the second time we've been called; this should
6123          * only happen if the main pattern got upgraded to utf8
6124          * during compilation; re-use the qr we compiled first time
6125          * round (which should be utf8 too)
6126          */
6127         qr = pRExC_state->runtime_code_qr;
6128         pRExC_state->runtime_code_qr = NULL;
6129         assert(RExC_utf8 && SvUTF8(qr));
6130     }
6131     else {
6132         int n = 0;
6133         STRLEN s;
6134         char *p, *newpat;
6135         int newlen = plen + 6; /* allow for "qr''x\0" extra chars */
6136         SV *sv, *qr_ref;
6137         dSP;
6138
6139         /* determine how many extra chars we need for ' and \ escaping */
6140         for (s = 0; s < plen; s++) {
6141             if (pat[s] == '\'' || pat[s] == '\\')
6142                 newlen++;
6143         }
6144
6145         Newx(newpat, newlen, char);
6146         p = newpat;
6147         *p++ = 'q'; *p++ = 'r'; *p++ = '\'';
6148
6149         for (s = 0; s < plen; s++) {
6150             if (n < pRExC_state->num_code_blocks
6151                 && s == pRExC_state->code_blocks[n].start)
6152             {
6153                 /* blank out literal code block */
6154                 assert(pat[s] == '(');
6155                 while (s <= pRExC_state->code_blocks[n].end) {
6156                     *p++ = '_';
6157                     s++;
6158                 }
6159                 s--;
6160                 n++;
6161                 continue;
6162             }
6163             if (pat[s] == '\'' || pat[s] == '\\')
6164                 *p++ = '\\';
6165             *p++ = pat[s];
6166         }
6167         *p++ = '\'';
6168         if (pRExC_state->pm_flags & RXf_PMf_EXTENDED)
6169             *p++ = 'x';
6170         *p++ = '\0';
6171         DEBUG_COMPILE_r({
6172             PerlIO_printf(Perl_debug_log,
6173                 "%sre-parsing pattern for runtime code:%s %s\n",
6174                 PL_colors[4],PL_colors[5],newpat);
6175         });
6176
6177         sv = newSVpvn_flags(newpat, p-newpat-1, RExC_utf8 ? SVf_UTF8 : 0);
6178         Safefree(newpat);
6179
6180         ENTER;
6181         SAVETMPS;
6182         save_re_context();
6183         PUSHSTACKi(PERLSI_REQUIRE);
6184         /* G_RE_REPARSING causes the toker to collapse \\ into \ when
6185          * parsing qr''; normally only q'' does this. It also alters
6186          * hints handling */
6187         eval_sv(sv, G_SCALAR|G_RE_REPARSING);
6188         SvREFCNT_dec_NN(sv);
6189         SPAGAIN;
6190         qr_ref = POPs;
6191         PUTBACK;
6192         {
6193             SV * const errsv = ERRSV;
6194             if (SvTRUE_NN(errsv))
6195             {
6196                 Safefree(pRExC_state->code_blocks);
6197                 /* use croak_sv ? */
6198                 Perl_croak_nocontext("%"SVf, SVfARG(errsv));
6199             }
6200         }
6201         assert(SvROK(qr_ref));
6202         qr = SvRV(qr_ref);
6203         assert(SvTYPE(qr) == SVt_REGEXP && RX_ENGINE((REGEXP*)qr)->op_comp);
6204         /* the leaving below frees the tmp qr_ref.
6205          * Give qr a life of its own */
6206         SvREFCNT_inc(qr);
6207         POPSTACK;
6208         FREETMPS;
6209         LEAVE;
6210
6211     }
6212
6213     if (!RExC_utf8 && SvUTF8(qr)) {
6214         /* first time through; the pattern got upgraded; save the
6215          * qr for the next time through */
6216         assert(!pRExC_state->runtime_code_qr);
6217         pRExC_state->runtime_code_qr = qr;
6218         return 0;
6219     }
6220
6221
6222     /* extract any code blocks within the returned qr//  */
6223
6224
6225     /* merge the main (r1) and run-time (r2) code blocks into one */
6226     {
6227         RXi_GET_DECL(ReANY((REGEXP *)qr), r2);
6228         struct reg_code_block *new_block, *dst;
6229         RExC_state_t * const r1 = pRExC_state; /* convenient alias */
6230         int i1 = 0, i2 = 0;
6231
6232         if (!r2->num_code_blocks) /* we guessed wrong */
6233         {
6234             SvREFCNT_dec_NN(qr);
6235             return 1;
6236         }
6237
6238         Newx(new_block,
6239             r1->num_code_blocks + r2->num_code_blocks,
6240             struct reg_code_block);
6241         dst = new_block;
6242
6243         while (    i1 < r1->num_code_blocks
6244                 || i2 < r2->num_code_blocks)
6245         {
6246             struct reg_code_block *src;
6247             bool is_qr = 0;
6248
6249             if (i1 == r1->num_code_blocks) {
6250                 src = &r2->code_blocks[i2++];
6251                 is_qr = 1;
6252             }
6253             else if (i2 == r2->num_code_blocks)
6254                 src = &r1->code_blocks[i1++];
6255             else if (  r1->code_blocks[i1].start
6256                      < r2->code_blocks[i2].start)
6257             {
6258                 src = &r1->code_blocks[i1++];
6259                 assert(src->end < r2->code_blocks[i2].start);
6260             }
6261             else {
6262                 assert(  r1->code_blocks[i1].start
6263                        > r2->code_blocks[i2].start);
6264                 src = &r2->code_blocks[i2++];
6265                 is_qr = 1;
6266                 assert(src->end < r1->code_blocks[i1].start);
6267             }
6268
6269             assert(pat[src->start] == '(');
6270             assert(pat[src->end]   == ')');
6271             dst->start      = src->start;
6272             dst->end        = src->end;
6273             dst->block      = src->block;
6274             dst->src_regex  = is_qr ? (REGEXP*) SvREFCNT_inc( (SV*) qr)
6275                                     : src->src_regex;
6276             dst++;
6277         }
6278         r1->num_code_blocks += r2->num_code_blocks;
6279         Safefree(r1->code_blocks);
6280         r1->code_blocks = new_block;
6281     }
6282
6283     SvREFCNT_dec_NN(qr);
6284     return 1;
6285 }
6286
6287
6288 STATIC bool
6289 S_setup_longest(pTHX_ RExC_state_t *pRExC_state, SV* sv_longest,
6290                       SV** rx_utf8, SV** rx_substr, SSize_t* rx_end_shift,
6291                       SSize_t lookbehind, SSize_t offset, SSize_t *minlen,
6292                       STRLEN longest_length, bool eol, bool meol)
6293 {
6294     /* This is the common code for setting up the floating and fixed length
6295      * string data extracted from Perl_re_op_compile() below.  Returns a boolean
6296      * as to whether succeeded or not */
6297
6298     I32 t;
6299     SSize_t ml;
6300
6301     if (! (longest_length
6302            || (eol /* Can't have SEOL and MULTI */
6303                && (! meol || (RExC_flags & RXf_PMf_MULTILINE)))
6304           )
6305             /* See comments for join_exact for why REG_UNFOLDED_MULTI_SEEN */
6306         || (RExC_seen & REG_UNFOLDED_MULTI_SEEN))
6307     {
6308         return FALSE;
6309     }
6310
6311     /* copy the information about the longest from the reg_scan_data
6312         over to the program. */
6313     if (SvUTF8(sv_longest)) {
6314         *rx_utf8 = sv_longest;
6315         *rx_substr = NULL;
6316     } else {
6317         *rx_substr = sv_longest;
6318         *rx_utf8 = NULL;
6319     }
6320     /* end_shift is how many chars that must be matched that
6321         follow this item. We calculate it ahead of time as once the
6322         lookbehind offset is added in we lose the ability to correctly
6323         calculate it.*/
6324     ml = minlen ? *(minlen) : (SSize_t)longest_length;
6325     *rx_end_shift = ml - offset
6326         - longest_length + (SvTAIL(sv_longest) != 0)
6327         + lookbehind;
6328
6329     t = (eol/* Can't have SEOL and MULTI */
6330          && (! meol || (RExC_flags & RXf_PMf_MULTILINE)));
6331     fbm_compile(sv_longest, t ? FBMcf_TAIL : 0);
6332
6333     return TRUE;
6334 }
6335
6336 /*
6337  * Perl_re_op_compile - the perl internal RE engine's function to compile a
6338  * regular expression into internal code.
6339  * The pattern may be passed either as:
6340  *    a list of SVs (patternp plus pat_count)
6341  *    a list of OPs (expr)
6342  * If both are passed, the SV list is used, but the OP list indicates
6343  * which SVs are actually pre-compiled code blocks
6344  *
6345  * The SVs in the list have magic and qr overloading applied to them (and
6346  * the list may be modified in-place with replacement SVs in the latter
6347  * case).
6348  *
6349  * If the pattern hasn't changed from old_re, then old_re will be
6350  * returned.
6351  *
6352  * eng is the current engine. If that engine has an op_comp method, then
6353  * handle directly (i.e. we assume that op_comp was us); otherwise, just
6354  * do the initial concatenation of arguments and pass on to the external
6355  * engine.
6356  *
6357  * If is_bare_re is not null, set it to a boolean indicating whether the
6358  * arg list reduced (after overloading) to a single bare regex which has
6359  * been returned (i.e. /$qr/).
6360  *
6361  * orig_rx_flags contains RXf_* flags. See perlreapi.pod for more details.
6362  *
6363  * pm_flags contains the PMf_* flags, typically based on those from the
6364  * pm_flags field of the related PMOP. Currently we're only interested in
6365  * PMf_HAS_CV, PMf_IS_QR, PMf_USE_RE_EVAL.
6366  *
6367  * We can't allocate space until we know how big the compiled form will be,
6368  * but we can't compile it (and thus know how big it is) until we've got a
6369  * place to put the code.  So we cheat:  we compile it twice, once with code
6370  * generation turned off and size counting turned on, and once "for real".
6371  * This also means that we don't allocate space until we are sure that the
6372  * thing really will compile successfully, and we never have to move the
6373  * code and thus invalidate pointers into it.  (Note that it has to be in
6374  * one piece because free() must be able to free it all.) [NB: not true in perl]
6375  *
6376  * Beware that the optimization-preparation code in here knows about some
6377  * of the structure of the compiled regexp.  [I'll say.]
6378  */
6379
6380 REGEXP *
6381 Perl_re_op_compile(pTHX_ SV ** const patternp, int pat_count,
6382                     OP *expr, const regexp_engine* eng, REGEXP *old_re,
6383                      bool *is_bare_re, U32 orig_rx_flags, U32 pm_flags)
6384 {
6385     REGEXP *rx;
6386     struct regexp *r;
6387     regexp_internal *ri;
6388     STRLEN plen;
6389     char *exp;
6390     regnode *scan;
6391     I32 flags;
6392     SSize_t minlen = 0;
6393     U32 rx_flags;
6394     SV *pat;
6395     SV *code_blocksv = NULL;
6396     SV** new_patternp = patternp;
6397
6398     /* these are all flags - maybe they should be turned
6399      * into a single int with different bit masks */
6400     I32 sawlookahead = 0;
6401     I32 sawplus = 0;
6402     I32 sawopen = 0;
6403     I32 sawminmod = 0;
6404
6405     regex_charset initial_charset = get_regex_charset(orig_rx_flags);
6406     bool recompile = 0;
6407     bool runtime_code = 0;
6408     scan_data_t data;
6409     RExC_state_t RExC_state;
6410     RExC_state_t * const pRExC_state = &RExC_state;
6411 #ifdef TRIE_STUDY_OPT
6412     int restudied = 0;
6413     RExC_state_t copyRExC_state;
6414 #endif
6415     GET_RE_DEBUG_FLAGS_DECL;
6416
6417     PERL_ARGS_ASSERT_RE_OP_COMPILE;
6418
6419     DEBUG_r(if (!PL_colorset) reginitcolors());
6420
6421     /* Initialize these here instead of as-needed, as is quick and avoids
6422      * having to test them each time otherwise */
6423     if (! PL_AboveLatin1) {
6424         PL_AboveLatin1 = _new_invlist_C_array(AboveLatin1_invlist);
6425         PL_Latin1 = _new_invlist_C_array(Latin1_invlist);
6426         PL_UpperLatin1 = _new_invlist_C_array(UpperLatin1_invlist);
6427         PL_utf8_foldable = _new_invlist_C_array(_Perl_Any_Folds_invlist);
6428         PL_HasMultiCharFold =
6429                        _new_invlist_C_array(_Perl_Folds_To_Multi_Char_invlist);
6430
6431         /* This is calculated here, because the Perl program that generates the
6432          * static global ones doesn't currently have access to
6433          * NUM_ANYOF_CODE_POINTS */
6434         PL_InBitmap = _new_invlist(2);
6435         PL_InBitmap = _add_range_to_invlist(PL_InBitmap, 0,
6436                                                     NUM_ANYOF_CODE_POINTS - 1);
6437     }
6438
6439     pRExC_state->code_blocks = NULL;
6440     pRExC_state->num_code_blocks = 0;
6441
6442     if (is_bare_re)
6443         *is_bare_re = FALSE;
6444
6445     if (expr && (expr->op_type == OP_LIST ||
6446                 (expr->op_type == OP_NULL && expr->op_targ == OP_LIST))) {
6447         /* allocate code_blocks if needed */
6448         OP *o;
6449         int ncode = 0;
6450
6451         for (o = cLISTOPx(expr)->op_first; o; o = OpSIBLING(o))
6452             if (o->op_type == OP_NULL && (o->op_flags & OPf_SPECIAL))
6453                 ncode++; /* count of DO blocks */
6454         if (ncode) {
6455             pRExC_state->num_code_blocks = ncode;
6456             Newx(pRExC_state->code_blocks, ncode, struct reg_code_block);
6457         }
6458     }
6459
6460     if (!pat_count) {
6461         /* compile-time pattern with just OP_CONSTs and DO blocks */
6462
6463         int n;
6464         OP *o;
6465
6466         /* find how many CONSTs there are */
6467         assert(expr);
6468         n = 0;
6469         if (expr->op_type == OP_CONST)
6470             n = 1;
6471         else
6472             for (o = cLISTOPx(expr)->op_first; o; o = OpSIBLING(o)) {
6473                 if (o->op_type == OP_CONST)
6474                     n++;
6475             }
6476
6477         /* fake up an SV array */
6478
6479         assert(!new_patternp);
6480         Newx(new_patternp, n, SV*);
6481         SAVEFREEPV(new_patternp);
6482         pat_count = n;
6483
6484         n = 0;
6485         if (expr->op_type == OP_CONST)
6486             new_patternp[n] = cSVOPx_sv(expr);
6487         else
6488             for (o = cLISTOPx(expr)->op_first; o; o = OpSIBLING(o)) {
6489                 if (o->op_type == OP_CONST)
6490                     new_patternp[n++] = cSVOPo_sv;
6491             }
6492
6493     }
6494
6495     DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log,
6496         "Assembling pattern from %d elements%s\n", pat_count,
6497             orig_rx_flags & RXf_SPLIT ? " for split" : ""));
6498
6499     /* set expr to the first arg op */
6500
6501     if (pRExC_state->num_code_blocks
6502          && expr->op_type != OP_CONST)
6503     {
6504             expr = cLISTOPx(expr)->op_first;
6505             assert(   expr->op_type == OP_PUSHMARK
6506                    || (expr->op_type == OP_NULL && expr->op_targ == OP_PUSHMARK)
6507                    || expr->op_type == OP_PADRANGE);
6508             expr = OpSIBLING(expr);
6509     }
6510
6511     pat = S_concat_pat(aTHX_ pRExC_state, NULL, new_patternp, pat_count,
6512                         expr, &recompile, NULL);
6513
6514     /* handle bare (possibly after overloading) regex: foo =~ $re */
6515     {
6516         SV *re = pat;
6517         if (SvROK(re))
6518             re = SvRV(re);
6519         if (SvTYPE(re) == SVt_REGEXP) {
6520             if (is_bare_re)
6521                 *is_bare_re = TRUE;
6522             SvREFCNT_inc(re);
6523             Safefree(pRExC_state->code_blocks);
6524             DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log,
6525                 "Precompiled pattern%s\n",
6526                     orig_rx_flags & RXf_SPLIT ? " for split" : ""));
6527
6528             return (REGEXP*)re;
6529         }
6530     }
6531
6532     exp = SvPV_nomg(pat, plen);
6533
6534     if (!eng->op_comp) {
6535         if ((SvUTF8(pat) && IN_BYTES)
6536                 || SvGMAGICAL(pat) || SvAMAGIC(pat))
6537         {
6538             /* make a temporary copy; either to convert to bytes,
6539              * or to avoid repeating get-magic / overloaded stringify */
6540             pat = newSVpvn_flags(exp, plen, SVs_TEMP |
6541                                         (IN_BYTES ? 0 : SvUTF8(pat)));
6542         }
6543         Safefree(pRExC_state->code_blocks);
6544         return CALLREGCOMP_ENG(eng, pat, orig_rx_flags);
6545     }
6546
6547     /* ignore the utf8ness if the pattern is 0 length */
6548     RExC_utf8 = RExC_orig_utf8 = (plen == 0 || IN_BYTES) ? 0 : SvUTF8(pat);
6549     RExC_uni_semantics = 0;
6550     RExC_contains_locale = 0;
6551     RExC_contains_i = 0;
6552     RExC_strict = cBOOL(pm_flags & RXf_PMf_STRICT);
6553     pRExC_state->runtime_code_qr = NULL;
6554     RExC_frame_head= NULL;
6555     RExC_frame_last= NULL;
6556     RExC_frame_count= 0;
6557
6558     DEBUG_r({
6559         RExC_mysv1= sv_newmortal();
6560         RExC_mysv2= sv_newmortal();
6561     });
6562     DEBUG_COMPILE_r({
6563             SV *dsv= sv_newmortal();
6564             RE_PV_QUOTED_DECL(s, RExC_utf8, dsv, exp, plen, 60);
6565             PerlIO_printf(Perl_debug_log, "%sCompiling REx%s %s\n",
6566                           PL_colors[4],PL_colors[5],s);
6567         });
6568
6569   redo_first_pass:
6570     /* we jump here if we upgrade the pattern to utf8 and have to
6571      * recompile */
6572
6573     if ((pm_flags & PMf_USE_RE_EVAL)
6574                 /* this second condition covers the non-regex literal case,
6575                  * i.e.  $foo =~ '(?{})'. */
6576                 || (IN_PERL_COMPILETIME && (PL_hints & HINT_RE_EVAL))
6577     )
6578         runtime_code = S_has_runtime_code(aTHX_ pRExC_state, exp, plen);
6579
6580     /* return old regex if pattern hasn't changed */
6581     /* XXX: note in the below we have to check the flags as well as the
6582      * pattern.
6583      *
6584      * Things get a touch tricky as we have to compare the utf8 flag
6585      * independently from the compile flags.  */
6586
6587     if (   old_re
6588         && !recompile
6589         && !!RX_UTF8(old_re) == !!RExC_utf8
6590         && ( RX_COMPFLAGS(old_re) == ( orig_rx_flags & RXf_PMf_FLAGCOPYMASK ) )
6591         && RX_PRECOMP(old_re)
6592         && RX_PRELEN(old_re) == plen
6593         && memEQ(RX_PRECOMP(old_re), exp, plen)
6594         && !runtime_code /* with runtime code, always recompile */ )
6595     {
6596         Safefree(pRExC_state->code_blocks);
6597         return old_re;
6598     }
6599
6600     rx_flags = orig_rx_flags;
6601
6602     if (rx_flags & PMf_FOLD) {
6603         RExC_contains_i = 1;
6604     }
6605     if (RExC_utf8 && initial_charset == REGEX_DEPENDS_CHARSET) {
6606
6607         /* Set to use unicode semantics if the pattern is in utf8 and has the
6608          * 'depends' charset specified, as it means unicode when utf8  */
6609         set_regex_charset(&rx_flags, REGEX_UNICODE_CHARSET);
6610     }
6611
6612     RExC_precomp = exp;
6613     RExC_flags = rx_flags;
6614     RExC_pm_flags = pm_flags;
6615
6616     if (runtime_code) {
6617         if (TAINTING_get && TAINT_get)
6618             Perl_croak(aTHX_ "Eval-group in insecure regular expression");
6619
6620         if (!S_compile_runtime_code(aTHX_ pRExC_state, exp, plen)) {
6621             /* whoops, we have a non-utf8 pattern, whilst run-time code
6622              * got compiled as utf8. Try again with a utf8 pattern */
6623             S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &exp, &plen,
6624                                     pRExC_state->num_code_blocks);
6625             goto redo_first_pass;
6626         }
6627     }
6628     assert(!pRExC_state->runtime_code_qr);
6629
6630     RExC_sawback = 0;
6631
6632     RExC_seen = 0;
6633     RExC_maxlen = 0;
6634     RExC_in_lookbehind = 0;
6635     RExC_seen_zerolen = *exp == '^' ? -1 : 0;
6636     RExC_extralen = 0;
6637     RExC_override_recoding = 0;
6638 #ifdef EBCDIC
6639     RExC_recode_x_to_native = 0;
6640 #endif
6641     RExC_in_multi_char_class = 0;
6642
6643     /* First pass: determine size, legality. */
6644     RExC_parse = exp;
6645     RExC_start = exp;
6646     RExC_end = exp + plen;
6647     RExC_naughty = 0;
6648     RExC_npar = 1;
6649     RExC_nestroot = 0;
6650     RExC_size = 0L;
6651     RExC_emit = (regnode *) &RExC_emit_dummy;
6652     RExC_whilem_seen = 0;
6653     RExC_open_parens = NULL;
6654     RExC_close_parens = NULL;
6655     RExC_opend = NULL;
6656     RExC_paren_names = NULL;
6657 #ifdef DEBUGGING
6658     RExC_paren_name_list = NULL;
6659 #endif
6660     RExC_recurse = NULL;
6661     RExC_study_chunk_recursed = NULL;
6662     RExC_study_chunk_recursed_bytes= 0;
6663     RExC_recurse_count = 0;
6664     pRExC_state->code_index = 0;
6665
6666     DEBUG_PARSE_r(
6667         PerlIO_printf(Perl_debug_log, "Starting first pass (sizing)\n");
6668         RExC_lastnum=0;
6669         RExC_lastparse=NULL;
6670     );
6671     /* reg may croak on us, not giving us a chance to free
6672        pRExC_state->code_blocks.  We cannot SAVEFREEPV it now, as we may
6673        need it to survive as long as the regexp (qr/(?{})/).
6674        We must check that code_blocksv is not already set, because we may
6675        have jumped back to restart the sizing pass. */
6676     if (pRExC_state->code_blocks && !code_blocksv) {
6677         code_blocksv = newSV_type(SVt_PV);
6678         SAVEFREESV(code_blocksv);
6679         SvPV_set(code_blocksv, (char *)pRExC_state->code_blocks);
6680         SvLEN_set(code_blocksv, 1); /*sufficient to make sv_clear free it*/
6681     }
6682     if (reg(pRExC_state, 0, &flags,1) == NULL) {
6683         /* It's possible to write a regexp in ascii that represents Unicode
6684         codepoints outside of the byte range, such as via \x{100}. If we
6685         detect such a sequence we have to convert the entire pattern to utf8
6686         and then recompile, as our sizing calculation will have been based
6687         on 1 byte == 1 character, but we will need to use utf8 to encode
6688         at least some part of the pattern, and therefore must convert the whole
6689         thing.
6690         -- dmq */
6691         if (flags & RESTART_UTF8) {
6692             S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &exp, &plen,
6693                                     pRExC_state->num_code_blocks);
6694             goto redo_first_pass;
6695         }
6696         Perl_croak(aTHX_ "panic: reg returned NULL to re_op_compile for sizing pass, flags=%#"UVxf"", (UV) flags);
6697     }
6698     if (code_blocksv)
6699         SvLEN_set(code_blocksv,0); /* no you can't have it, sv_clear */
6700
6701     DEBUG_PARSE_r({
6702         PerlIO_printf(Perl_debug_log,
6703             "Required size %"IVdf" nodes\n"
6704             "Starting second pass (creation)\n",
6705             (IV)RExC_size);
6706         RExC_lastnum=0;
6707         RExC_lastparse=NULL;
6708     });
6709
6710     /* The first pass could have found things that force Unicode semantics */
6711     if ((RExC_utf8 || RExC_uni_semantics)
6712          && get_regex_charset(rx_flags) == REGEX_DEPENDS_CHARSET)
6713     {
6714         set_regex_charset(&rx_flags, REGEX_UNICODE_CHARSET);
6715     }
6716
6717     /* Small enough for pointer-storage convention?
6718        If extralen==0, this means that we will not need long jumps. */
6719     if (RExC_size >= 0x10000L && RExC_extralen)
6720         RExC_size += RExC_extralen;
6721     else
6722         RExC_extralen = 0;
6723     if (RExC_whilem_seen > 15)
6724         RExC_whilem_seen = 15;
6725
6726     /* Allocate space and zero-initialize. Note, the two step process
6727        of zeroing when in debug mode, thus anything assigned has to
6728        happen after that */
6729     rx = (REGEXP*) newSV_type(SVt_REGEXP);
6730     r = ReANY(rx);
6731     Newxc(ri, sizeof(regexp_internal) + (unsigned)RExC_size * sizeof(regnode),
6732          char, regexp_internal);
6733     if ( r == NULL || ri == NULL )
6734         FAIL("Regexp out of space");
6735 #ifdef DEBUGGING
6736     /* avoid reading uninitialized memory in DEBUGGING code in study_chunk() */
6737     Zero(ri, sizeof(regexp_internal) + (unsigned)RExC_size * sizeof(regnode),
6738          char);
6739 #else
6740     /* bulk initialize base fields with 0. */
6741     Zero(ri, sizeof(regexp_internal), char);
6742 #endif
6743
6744     /* non-zero initialization begins here */
6745     RXi_SET( r, ri );
6746     r->engine= eng;
6747     r->extflags = rx_flags;
6748     RXp_COMPFLAGS(r) = orig_rx_flags & RXf_PMf_FLAGCOPYMASK;
6749
6750     if (pm_flags & PMf_IS_QR) {
6751         ri->code_blocks = pRExC_state->code_blocks;
6752         ri->num_code_blocks = pRExC_state->num_code_blocks;
6753     }
6754     else
6755     {
6756         int n;
6757         for (n = 0; n < pRExC_state->num_code_blocks; n++)
6758             if (pRExC_state->code_blocks[n].src_regex)
6759                 SAVEFREESV(pRExC_state->code_blocks[n].src_regex);
6760         if(pRExC_state->code_blocks)
6761             SAVEFREEPV(pRExC_state->code_blocks); /* often null */
6762     }
6763
6764     {
6765         bool has_p     = ((r->extflags & RXf_PMf_KEEPCOPY) == RXf_PMf_KEEPCOPY);
6766         bool has_charset = (get_regex_charset(r->extflags)
6767                                                     != REGEX_DEPENDS_CHARSET);
6768
6769         /* The caret is output if there are any defaults: if not all the STD
6770          * flags are set, or if no character set specifier is needed */
6771         bool has_default =
6772                     (((r->extflags & RXf_PMf_STD_PMMOD) != RXf_PMf_STD_PMMOD)
6773                     || ! has_charset);
6774         bool has_runon = ((RExC_seen & REG_RUN_ON_COMMENT_SEEN)
6775                                                    == REG_RUN_ON_COMMENT_SEEN);
6776         U16 reganch = (U16)((r->extflags & RXf_PMf_STD_PMMOD)
6777                             >> RXf_PMf_STD_PMMOD_SHIFT);
6778         const char *fptr = STD_PAT_MODS;        /*"msixn"*/
6779         char *p;
6780         /* Allocate for the worst case, which is all the std flags are turned
6781          * on.  If more precision is desired, we could do a population count of
6782          * the flags set.  This could be done with a small lookup table, or by
6783          * shifting, masking and adding, or even, when available, assembly
6784          * language for a machine-language population count.
6785          * We never output a minus, as all those are defaults, so are
6786          * covered by the caret */
6787         const STRLEN wraplen = plen + has_p + has_runon
6788             + has_default       /* If needs a caret */
6789
6790                 /* If needs a character set specifier */
6791             + ((has_charset) ? MAX_CHARSET_NAME_LENGTH : 0)
6792             + (sizeof(STD_PAT_MODS) - 1)
6793             + (sizeof("(?:)") - 1);
6794
6795         Newx(p, wraplen + 1, char); /* +1 for the ending NUL */
6796         r->xpv_len_u.xpvlenu_pv = p;
6797         if (RExC_utf8)
6798             SvFLAGS(rx) |= SVf_UTF8;
6799         *p++='('; *p++='?';
6800
6801         /* If a default, cover it using the caret */
6802         if (has_default) {
6803             *p++= DEFAULT_PAT_MOD;
6804         }
6805         if (has_charset) {
6806             STRLEN len;
6807             const char* const name = get_regex_charset_name(r->extflags, &len);
6808             Copy(name, p, len, char);
6809             p += len;
6810         }
6811         if (has_p)
6812             *p++ = KEEPCOPY_PAT_MOD; /*'p'*/
6813         {
6814             char ch;
6815             while((ch = *fptr++)) {
6816                 if(reganch & 1)
6817                     *p++ = ch;
6818                 reganch >>= 1;
6819             }
6820         }
6821
6822         *p++ = ':';
6823         Copy(RExC_precomp, p, plen, char);
6824         assert ((RX_WRAPPED(rx) - p) < 16);
6825         r->pre_prefix = p - RX_WRAPPED(rx);
6826         p += plen;
6827         if (has_runon)
6828             *p++ = '\n';
6829         *p++ = ')';
6830         *p = 0;
6831         SvCUR_set(rx, p - RX_WRAPPED(rx));
6832     }
6833
6834     r->intflags = 0;
6835     r->nparens = RExC_npar - 1; /* set early to validate backrefs */
6836
6837     /* setup various meta data about recursion, this all requires
6838      * RExC_npar to be correctly set, and a bit later on we clear it */
6839     if (RExC_seen & REG_RECURSE_SEEN) {
6840         Newxz(RExC_open_parens, RExC_npar,regnode *);
6841         SAVEFREEPV(RExC_open_parens);
6842         Newxz(RExC_close_parens,RExC_npar,regnode *);
6843         SAVEFREEPV(RExC_close_parens);
6844     }
6845     if (RExC_seen & (REG_RECURSE_SEEN | REG_GOSTART_SEEN)) {
6846         /* Note, RExC_npar is 1 + the number of parens in a pattern.
6847          * So its 1 if there are no parens. */
6848         RExC_study_chunk_recursed_bytes= (RExC_npar >> 3) +
6849                                          ((RExC_npar & 0x07) != 0);
6850         Newx(RExC_study_chunk_recursed,
6851              RExC_study_chunk_recursed_bytes * RExC_npar, U8);
6852         SAVEFREEPV(RExC_study_chunk_recursed);
6853     }
6854
6855     /* Useful during FAIL. */
6856 #ifdef RE_TRACK_PATTERN_OFFSETS
6857     Newxz(ri->u.offsets, 2*RExC_size+1, U32); /* MJD 20001228 */
6858     DEBUG_OFFSETS_r(PerlIO_printf(Perl_debug_log,
6859                           "%s %"UVuf" bytes for offset annotations.\n",
6860                           ri->u.offsets ? "Got" : "Couldn't get",
6861                           (UV)((2*RExC_size+1) * sizeof(U32))));
6862 #endif
6863     SetProgLen(ri,RExC_size);
6864     RExC_rx_sv = rx;
6865     RExC_rx = r;
6866     RExC_rxi = ri;
6867
6868     /* Second pass: emit code. */
6869     RExC_flags = rx_flags;      /* don't let top level (?i) bleed */
6870     RExC_pm_flags = pm_flags;
6871     RExC_parse = exp;
6872     RExC_end = exp + plen;
6873     RExC_naughty = 0;
6874     RExC_npar = 1;
6875     RExC_emit_start = ri->program;
6876     RExC_emit = ri->program;
6877     RExC_emit_bound = ri->program + RExC_size + 1;
6878     pRExC_state->code_index = 0;
6879
6880     *((char*) RExC_emit++) = (char) REG_MAGIC;
6881     if (reg(pRExC_state, 0, &flags,1) == NULL) {
6882         ReREFCNT_dec(rx);
6883         Perl_croak(aTHX_ "panic: reg returned NULL to re_op_compile for generation pass, flags=%#"UVxf"", (UV) flags);
6884     }
6885     /* XXXX To minimize changes to RE engine we always allocate
6886        3-units-long substrs field. */
6887     Newx(r->substrs, 1, struct reg_substr_data);
6888     if (RExC_recurse_count) {
6889         Newxz(RExC_recurse,RExC_recurse_count,regnode *);
6890         SAVEFREEPV(RExC_recurse);
6891     }
6892
6893   reStudy:
6894     r->minlen = minlen = sawlookahead = sawplus = sawopen = sawminmod = 0;
6895     DEBUG_r(
6896         RExC_study_chunk_recursed_count= 0;
6897     );
6898     Zero(r->substrs, 1, struct reg_substr_data);
6899     if (RExC_study_chunk_recursed) {
6900         Zero(RExC_study_chunk_recursed,
6901              RExC_study_chunk_recursed_bytes * RExC_npar, U8);
6902     }
6903
6904
6905 #ifdef TRIE_STUDY_OPT
6906     if (!restudied) {
6907         StructCopy(&zero_scan_data, &data, scan_data_t);
6908         copyRExC_state = RExC_state;
6909     } else {
6910         U32 seen=RExC_seen;
6911         DEBUG_OPTIMISE_r(PerlIO_printf(Perl_debug_log,"Restudying\n"));
6912
6913         RExC_state = copyRExC_state;
6914         if (seen & REG_TOP_LEVEL_BRANCHES_SEEN)
6915             RExC_seen |= REG_TOP_LEVEL_BRANCHES_SEEN;
6916         else
6917             RExC_seen &= ~REG_TOP_LEVEL_BRANCHES_SEEN;
6918         StructCopy(&zero_scan_data, &data, scan_data_t);
6919     }
6920 #else
6921     StructCopy(&zero_scan_data, &data, scan_data_t);
6922 #endif
6923
6924     /* Dig out information for optimizations. */
6925     r->extflags = RExC_flags; /* was pm_op */
6926     /*dmq: removed as part of de-PMOP: pm->op_pmflags = RExC_flags; */
6927
6928     if (UTF)
6929         SvUTF8_on(rx);  /* Unicode in it? */
6930     ri->regstclass = NULL;
6931     if (RExC_naughty >= TOO_NAUGHTY)    /* Probably an expensive pattern. */
6932         r->intflags |= PREGf_NAUGHTY;
6933     scan = ri->program + 1;             /* First BRANCH. */
6934
6935     /* testing for BRANCH here tells us whether there is "must appear"
6936        data in the pattern. If there is then we can use it for optimisations */
6937     if (!(RExC_seen & REG_TOP_LEVEL_BRANCHES_SEEN)) { /*  Only one top-level choice.
6938                                                   */
6939         SSize_t fake;
6940         STRLEN longest_float_length, longest_fixed_length;
6941         regnode_ssc ch_class; /* pointed to by data */
6942         int stclass_flag;
6943         SSize_t last_close = 0; /* pointed to by data */
6944         regnode *first= scan;
6945         regnode *first_next= regnext(first);
6946         /*
6947          * Skip introductions and multiplicators >= 1
6948          * so that we can extract the 'meat' of the pattern that must
6949          * match in the large if() sequence following.
6950          * NOTE that EXACT is NOT covered here, as it is normally
6951          * picked up by the optimiser separately.
6952          *
6953          * This is unfortunate as the optimiser isnt handling lookahead
6954          * properly currently.
6955          *
6956          */
6957         while ((OP(first) == OPEN && (sawopen = 1)) ||
6958                /* An OR of *one* alternative - should not happen now. */
6959             (OP(first) == BRANCH && OP(first_next) != BRANCH) ||
6960             /* for now we can't handle lookbehind IFMATCH*/
6961             (OP(first) == IFMATCH && !first->flags && (sawlookahead = 1)) ||
6962             (OP(first) == PLUS) ||
6963             (OP(first) == MINMOD) ||
6964                /* An {n,m} with n>0 */
6965             (PL_regkind[OP(first)] == CURLY && ARG1(first) > 0) ||
6966             (OP(first) == NOTHING && PL_regkind[OP(first_next)] != END ))
6967         {
6968                 /*
6969                  * the only op that could be a regnode is PLUS, all the rest
6970                  * will be regnode_1 or regnode_2.
6971                  *
6972                  * (yves doesn't think this is true)
6973                  */
6974                 if (OP(first) == PLUS)
6975                     sawplus = 1;
6976                 else {
6977                     if (OP(first) == MINMOD)
6978                         sawminmod = 1;
6979                     first += regarglen[OP(first)];
6980                 }
6981                 first = NEXTOPER(first);
6982                 first_next= regnext(first);
6983         }
6984
6985         /* Starting-point info. */
6986       again:
6987         DEBUG_PEEP("first:",first,0);
6988         /* Ignore EXACT as we deal with it later. */
6989         if (PL_regkind[OP(first)] == EXACT) {
6990             if (OP(first) == EXACT || OP(first) == EXACTL)
6991                 NOOP;   /* Empty, get anchored substr later. */
6992             else
6993                 ri->regstclass = first;
6994         }
6995 #ifdef TRIE_STCLASS
6996         else if (PL_regkind[OP(first)] == TRIE &&
6997                 ((reg_trie_data *)ri->data->data[ ARG(first) ])->minlen>0)
6998         {
6999             /* this can happen only on restudy */
7000             ri->regstclass = construct_ahocorasick_from_trie(pRExC_state, (regnode *)first, 0);
7001         }
7002 #endif
7003         else if (REGNODE_SIMPLE(OP(first)))
7004             ri->regstclass = first;
7005         else if (PL_regkind[OP(first)] == BOUND ||
7006                  PL_regkind[OP(first)] == NBOUND)
7007             ri->regstclass = first;
7008         else if (PL_regkind[OP(first)] == BOL) {
7009             r->intflags |= (OP(first) == MBOL
7010                            ? PREGf_ANCH_MBOL
7011                            : PREGf_ANCH_SBOL);
7012             first = NEXTOPER(first);
7013             goto again;
7014         }
7015         else if (OP(first) == GPOS) {
7016             r->intflags |= PREGf_ANCH_GPOS;
7017             first = NEXTOPER(first);
7018             goto again;
7019         }
7020         else if ((!sawopen || !RExC_sawback) &&
7021             !sawlookahead &&
7022             (OP(first) == STAR &&
7023             PL_regkind[OP(NEXTOPER(first))] == REG_ANY) &&
7024             !(r->intflags & PREGf_ANCH) && !pRExC_state->num_code_blocks)
7025         {
7026             /* turn .* into ^.* with an implied $*=1 */
7027             const int type =
7028                 (OP(NEXTOPER(first)) == REG_ANY)
7029                     ? PREGf_ANCH_MBOL
7030                     : PREGf_ANCH_SBOL;
7031             r->intflags |= (type | PREGf_IMPLICIT);
7032             first = NEXTOPER(first);
7033             goto again;
7034         }
7035         if (sawplus && !sawminmod && !sawlookahead
7036             && (!sawopen || !RExC_sawback)
7037             && !pRExC_state->num_code_blocks) /* May examine pos and $& */
7038             /* x+ must match at the 1st pos of run of x's */
7039             r->intflags |= PREGf_SKIP;
7040
7041         /* Scan is after the zeroth branch, first is atomic matcher. */
7042 #ifdef TRIE_STUDY_OPT
7043         DEBUG_PARSE_r(
7044             if (!restudied)
7045                 PerlIO_printf(Perl_debug_log, "first at %"IVdf"\n",
7046                               (IV)(first - scan + 1))
7047         );
7048 #else
7049         DEBUG_PARSE_r(
7050             PerlIO_printf(Perl_debug_log, "first at %"IVdf"\n",
7051                 (IV)(first - scan + 1))
7052         );
7053 #endif
7054
7055
7056         /*
7057         * If there's something expensive in the r.e., find the
7058         * longest literal string that must appear and make it the
7059         * regmust.  Resolve ties in favor of later strings, since
7060         * the regstart check works with the beginning of the r.e.
7061         * and avoiding duplication strengthens checking.  Not a
7062         * strong reason, but sufficient in the absence of others.
7063         * [Now we resolve ties in favor of the earlier string if
7064         * it happens that c_offset_min has been invalidated, since the
7065         * earlier string may buy us something the later one won't.]
7066         */
7067
7068         data.longest_fixed = newSVpvs("");
7069         data.longest_float = newSVpvs("");
7070         data.last_found = newSVpvs("");
7071         data.longest = &(data.longest_fixed);
7072         ENTER_with_name("study_chunk");
7073         SAVEFREESV(data.longest_fixed);
7074         SAVEFREESV(data.longest_float);
7075         SAVEFREESV(data.last_found);
7076         first = scan;
7077         if (!ri->regstclass) {
7078             ssc_init(pRExC_state, &ch_class);
7079             data.start_class = &ch_class;
7080             stclass_flag = SCF_DO_STCLASS_AND;
7081         } else                          /* XXXX Check for BOUND? */
7082             stclass_flag = 0;
7083         data.last_closep = &last_close;
7084
7085         DEBUG_RExC_seen();
7086         minlen = study_chunk(pRExC_state, &first, &minlen, &fake,
7087                              scan + RExC_size, /* Up to end */
7088             &data, -1, 0, NULL,
7089             SCF_DO_SUBSTR | SCF_WHILEM_VISITED_POS | stclass_flag
7090                           | (restudied ? SCF_TRIE_DOING_RESTUDY : 0),
7091             0);
7092
7093
7094         CHECK_RESTUDY_GOTO_butfirst(LEAVE_with_name("study_chunk"));
7095
7096
7097         if ( RExC_npar == 1 && data.longest == &(data.longest_fixed)
7098              && data.last_start_min == 0 && data.last_end > 0
7099              && !RExC_seen_zerolen
7100              && !(RExC_seen & REG_VERBARG_SEEN)
7101              && !(RExC_seen & REG_GPOS_SEEN)
7102         ){
7103             r->extflags |= RXf_CHECK_ALL;
7104         }
7105         scan_commit(pRExC_state, &data,&minlen,0);
7106
7107         longest_float_length = CHR_SVLEN(data.longest_float);
7108
7109         if (! ((SvCUR(data.longest_fixed)  /* ok to leave SvCUR */
7110                    && data.offset_fixed == data.offset_float_min
7111                    && SvCUR(data.longest_fixed) == SvCUR(data.longest_float)))
7112             && S_setup_longest (aTHX_ pRExC_state,
7113                                     data.longest_float,
7114                                     &(r->float_utf8),
7115                                     &(r->float_substr),
7116                                     &(r->float_end_shift),
7117                                     data.lookbehind_float,
7118                                     data.offset_float_min,
7119                                     data.minlen_float,
7120                                     longest_float_length,
7121                                     cBOOL(data.flags & SF_FL_BEFORE_EOL),
7122                                     cBOOL(data.flags & SF_FL_BEFORE_MEOL)))
7123         {
7124             r->float_min_offset = data.offset_float_min - data.lookbehind_float;
7125             r->float_max_offset = data.offset_float_max;
7126             if (data.offset_float_max < SSize_t_MAX) /* Don't offset infinity */
7127                 r->float_max_offset -= data.lookbehind_float;
7128             SvREFCNT_inc_simple_void_NN(data.longest_float);
7129         }
7130         else {
7131             r->float_substr = r->float_utf8 = NULL;
7132             longest_float_length = 0;
7133         }
7134
7135         longest_fixed_length = CHR_SVLEN(data.longest_fixed);
7136
7137         if (S_setup_longest (aTHX_ pRExC_state,
7138                                 data.longest_fixed,
7139                                 &(r->anchored_utf8),
7140                                 &(r->anchored_substr),
7141                                 &(r->anchored_end_shift),
7142                                 data.lookbehind_fixed,
7143                                 data.offset_fixed,
7144                                 data.minlen_fixed,
7145                                 longest_fixed_length,
7146                                 cBOOL(data.flags & SF_FIX_BEFORE_EOL),
7147                                 cBOOL(data.flags & SF_FIX_BEFORE_MEOL)))
7148         {
7149             r->anchored_offset = data.offset_fixed - data.lookbehind_fixed;
7150             SvREFCNT_inc_simple_void_NN(data.longest_fixed);
7151         }
7152         else {
7153             r->anchored_substr = r->anchored_utf8 = NULL;
7154             longest_fixed_length = 0;
7155         }
7156         LEAVE_with_name("study_chunk");
7157
7158         if (ri->regstclass
7159             && (OP(ri->regstclass) == REG_ANY || OP(ri->regstclass) == SANY))
7160             ri->regstclass = NULL;
7161
7162         if ((!(r->anchored_substr || r->anchored_utf8) || r->anchored_offset)
7163             && stclass_flag
7164             && ! (ANYOF_FLAGS(data.start_class) & SSC_MATCHES_EMPTY_STRING)
7165             && is_ssc_worth_it(pRExC_state, data.start_class))
7166         {
7167             const U32 n = add_data(pRExC_state, STR_WITH_LEN("f"));
7168
7169             ssc_finalize(pRExC_state, data.start_class);
7170
7171             Newx(RExC_rxi->data->data[n], 1, regnode_ssc);
7172             StructCopy(data.start_class,
7173                        (regnode_ssc*)RExC_rxi->data->data[n],
7174                        regnode_ssc);
7175             ri->regstclass = (regnode*)RExC_rxi->data->data[n];
7176             r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
7177             DEBUG_COMPILE_r({ SV *sv = sv_newmortal();
7178                       regprop(r, sv, (regnode*)data.start_class, NULL, pRExC_state);
7179                       PerlIO_printf(Perl_debug_log,
7180                                     "synthetic stclass \"%s\".\n",
7181                                     SvPVX_const(sv));});
7182             data.start_class = NULL;
7183         }
7184
7185         /* A temporary algorithm prefers floated substr to fixed one to dig
7186          * more info. */
7187         if (longest_fixed_length > longest_float_length) {
7188             r->substrs->check_ix = 0;
7189             r->check_end_shift = r->anchored_end_shift;
7190             r->check_substr = r->anchored_substr;
7191             r->check_utf8 = r->anchored_utf8;
7192             r->check_offset_min = r->check_offset_max = r->anchored_offset;
7193             if (r->intflags & (PREGf_ANCH_SBOL|PREGf_ANCH_GPOS))
7194                 r->intflags |= PREGf_NOSCAN;
7195         }
7196         else {
7197             r->substrs->check_ix = 1;
7198             r->check_end_shift = r->float_end_shift;
7199             r->check_substr = r->float_substr;
7200             r->check_utf8 = r->float_utf8;
7201             r->check_offset_min = r->float_min_offset;
7202             r->check_offset_max = r->float_max_offset;
7203         }
7204         if ((r->check_substr || r->check_utf8) ) {
7205             r->extflags |= RXf_USE_INTUIT;
7206             if (SvTAIL(r->check_substr ? r->check_substr : r->check_utf8))
7207                 r->extflags |= RXf_INTUIT_TAIL;
7208         }
7209         r->substrs->data[0].max_offset = r->substrs->data[0].min_offset;
7210
7211         /* XXX Unneeded? dmq (shouldn't as this is handled elsewhere)
7212         if ( (STRLEN)minlen < longest_float_length )
7213             minlen= longest_float_length;
7214         if ( (STRLEN)minlen < longest_fixed_length )
7215             minlen= longest_fixed_length;
7216         */
7217     }
7218     else {
7219         /* Several toplevels. Best we can is to set minlen. */
7220         SSize_t fake;
7221         regnode_ssc ch_class;
7222         SSize_t last_close = 0;
7223
7224         DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log, "\nMulti Top Level\n"));
7225
7226         scan = ri->program + 1;
7227         ssc_init(pRExC_state, &ch_class);
7228         data.start_class = &ch_class;
7229         data.last_closep = &last_close;
7230
7231         DEBUG_RExC_seen();
7232         minlen = study_chunk(pRExC_state,
7233             &scan, &minlen, &fake, scan + RExC_size, &data, -1, 0, NULL,
7234             SCF_DO_STCLASS_AND|SCF_WHILEM_VISITED_POS|(restudied
7235                                                       ? SCF_TRIE_DOING_RESTUDY
7236                                                       : 0),
7237             0);
7238
7239         CHECK_RESTUDY_GOTO_butfirst(NOOP);
7240
7241         r->check_substr = r->check_utf8 = r->anchored_substr = r->anchored_utf8
7242                 = r->float_substr = r->float_utf8 = NULL;
7243
7244         if (! (ANYOF_FLAGS(data.start_class) & SSC_MATCHES_EMPTY_STRING)
7245             && is_ssc_worth_it(pRExC_state, data.start_class))
7246         {
7247             const U32 n = add_data(pRExC_state, STR_WITH_LEN("f"));
7248
7249             ssc_finalize(pRExC_state, data.start_class);
7250
7251             Newx(RExC_rxi->data->data[n], 1, regnode_ssc);
7252             StructCopy(data.start_class,
7253                        (regnode_ssc*)RExC_rxi->data->data[n],
7254                        regnode_ssc);
7255             ri->regstclass = (regnode*)RExC_rxi->data->data[n];
7256             r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
7257             DEBUG_COMPILE_r({ SV* sv = sv_newmortal();
7258                       regprop(r, sv, (regnode*)data.start_class, NULL, pRExC_state);
7259                       PerlIO_printf(Perl_debug_log,
7260                                     "synthetic stclass \"%s\".\n",
7261                                     SvPVX_const(sv));});
7262             data.start_class = NULL;
7263         }
7264     }
7265
7266     if (RExC_seen & REG_UNBOUNDED_QUANTIFIER_SEEN) {
7267         r->extflags |= RXf_UNBOUNDED_QUANTIFIER_SEEN;
7268         r->maxlen = REG_INFTY;
7269     }
7270     else {
7271         r->maxlen = RExC_maxlen;
7272     }
7273
7274     /* Guard against an embedded (?=) or (?<=) with a longer minlen than
7275        the "real" pattern. */
7276     DEBUG_OPTIMISE_r({
7277         PerlIO_printf(Perl_debug_log,"minlen: %"IVdf" r->minlen:%"IVdf" maxlen:%"IVdf"\n",
7278                       (IV)minlen, (IV)r->minlen, (IV)RExC_maxlen);
7279     });
7280     r->minlenret = minlen;
7281     if (r->minlen < minlen)
7282         r->minlen = minlen;
7283
7284     if (RExC_seen & REG_GPOS_SEEN)
7285         r->intflags |= PREGf_GPOS_SEEN;
7286     if (RExC_seen & REG_LOOKBEHIND_SEEN)
7287         r->extflags |= RXf_NO_INPLACE_SUBST; /* inplace might break the
7288                                                 lookbehind */
7289     if (pRExC_state->num_code_blocks)
7290         r->extflags |= RXf_EVAL_SEEN;
7291     if (RExC_seen & REG_VERBARG_SEEN)
7292     {
7293         r->intflags |= PREGf_VERBARG_SEEN;
7294         r->extflags |= RXf_NO_INPLACE_SUBST; /* don't understand this! Yves */
7295     }
7296     if (RExC_seen & REG_CUTGROUP_SEEN)
7297         r->intflags |= PREGf_CUTGROUP_SEEN;
7298     if (pm_flags & PMf_USE_RE_EVAL)
7299         r->intflags |= PREGf_USE_RE_EVAL;
7300     if (RExC_paren_names)
7301         RXp_PAREN_NAMES(r) = MUTABLE_HV(SvREFCNT_inc(RExC_paren_names));
7302     else
7303         RXp_PAREN_NAMES(r) = NULL;
7304
7305     /* If we have seen an anchor in our pattern then we set the extflag RXf_IS_ANCHORED
7306      * so it can be used in pp.c */
7307     if (r->intflags & PREGf_ANCH)
7308         r->extflags |= RXf_IS_ANCHORED;
7309
7310
7311     {
7312         /* this is used to identify "special" patterns that might result
7313          * in Perl NOT calling the regex engine and instead doing the match "itself",
7314          * particularly special cases in split//. By having the regex compiler
7315          * do this pattern matching at a regop level (instead of by inspecting the pattern)
7316          * we avoid weird issues with equivalent patterns resulting in different behavior,
7317          * AND we allow non Perl engines to get the same optimizations by the setting the
7318          * flags appropriately - Yves */
7319         regnode *first = ri->program + 1;
7320         U8 fop = OP(first);
7321         regnode *next = regnext(first);
7322         U8 nop = OP(next);
7323
7324         if (PL_regkind[fop] == NOTHING && nop == END)
7325             r->extflags |= RXf_NULL;
7326         else if ((fop == MBOL || (fop == SBOL && !first->flags)) && nop == END)
7327             /* when fop is SBOL first->flags will be true only when it was
7328              * produced by parsing /\A/, and not when parsing /^/. This is
7329              * very important for the split code as there we want to
7330              * treat /^/ as /^/m, but we do not want to treat /\A/ as /^/m.
7331              * See rt #122761 for more details. -- Yves */
7332             r->extflags |= RXf_START_ONLY;
7333         else if (fop == PLUS
7334                  && PL_regkind[nop] == POSIXD && FLAGS(next) == _CC_SPACE
7335                  && nop == END)
7336             r->extflags |= RXf_WHITE;
7337         else if ( r->extflags & RXf_SPLIT
7338                   && (fop == EXACT || fop == EXACTL)
7339                   && STR_LEN(first) == 1
7340                   && *(STRING(first)) == ' '
7341                   && nop == END )
7342             r->extflags |= (RXf_SKIPWHITE|RXf_WHITE);
7343
7344     }
7345
7346     if (RExC_contains_locale) {
7347         RXp_EXTFLAGS(r) |= RXf_TAINTED;
7348     }
7349
7350 #ifdef DEBUGGING
7351     if (RExC_paren_names) {
7352         ri->name_list_idx = add_data( pRExC_state, STR_WITH_LEN("a"));
7353         ri->data->data[ri->name_list_idx]
7354                                    = (void*)SvREFCNT_inc(RExC_paren_name_list);
7355     } else
7356 #endif
7357         ri->name_list_idx = 0;
7358
7359     if (RExC_recurse_count) {
7360         for ( ; RExC_recurse_count ; RExC_recurse_count-- ) {
7361             const regnode *scan = RExC_recurse[RExC_recurse_count-1];
7362             ARG2L_SET( scan, RExC_open_parens[ARG(scan)-1] - scan );
7363         }
7364     }
7365     Newxz(r->offs, RExC_npar, regexp_paren_pair);
7366     /* assume we don't need to swap parens around before we match */
7367     DEBUG_TEST_r({
7368         PerlIO_printf(Perl_debug_log,"study_chunk_recursed_count: %lu\n",
7369             (unsigned long)RExC_study_chunk_recursed_count);
7370     });
7371     DEBUG_DUMP_r({
7372         DEBUG_RExC_seen();
7373         PerlIO_printf(Perl_debug_log,"Final program:\n");
7374         regdump(r);
7375     });
7376 #ifdef RE_TRACK_PATTERN_OFFSETS
7377     DEBUG_OFFSETS_r(if (ri->u.offsets) {
7378         const STRLEN len = ri->u.offsets[0];
7379         STRLEN i;
7380         GET_RE_DEBUG_FLAGS_DECL;
7381         PerlIO_printf(Perl_debug_log,
7382                       "Offsets: [%"UVuf"]\n\t", (UV)ri->u.offsets[0]);
7383         for (i = 1; i <= len; i++) {
7384             if (ri->u.offsets[i*2-1] || ri->u.offsets[i*2])
7385                 PerlIO_printf(Perl_debug_log, "%"UVuf":%"UVuf"[%"UVuf"] ",
7386                 (UV)i, (UV)ri->u.offsets[i*2-1], (UV)ri->u.offsets[i*2]);
7387             }
7388         PerlIO_printf(Perl_debug_log, "\n");
7389     });
7390 #endif
7391
7392 #ifdef USE_ITHREADS
7393     /* under ithreads the ?pat? PMf_USED flag on the pmop is simulated
7394      * by setting the regexp SV to readonly-only instead. If the
7395      * pattern's been recompiled, the USEDness should remain. */
7396     if (old_re && SvREADONLY(old_re))
7397         SvREADONLY_on(rx);
7398 #endif
7399     return rx;
7400 }
7401
7402
7403 SV*
7404 Perl_reg_named_buff(pTHX_ REGEXP * const rx, SV * const key, SV * const value,
7405                     const U32 flags)
7406 {
7407     PERL_ARGS_ASSERT_REG_NAMED_BUFF;
7408
7409     PERL_UNUSED_ARG(value);
7410
7411     if (flags & RXapif_FETCH) {
7412         return reg_named_buff_fetch(rx, key, flags);
7413     } else if (flags & (RXapif_STORE | RXapif_DELETE | RXapif_CLEAR)) {
7414         Perl_croak_no_modify();
7415         return NULL;
7416     } else if (flags & RXapif_EXISTS) {
7417         return reg_named_buff_exists(rx, key, flags)
7418             ? &PL_sv_yes
7419             : &PL_sv_no;
7420     } else if (flags & RXapif_REGNAMES) {
7421         return reg_named_buff_all(rx, flags);
7422     } else if (flags & (RXapif_SCALAR | RXapif_REGNAMES_COUNT)) {
7423         return reg_named_buff_scalar(rx, flags);
7424     } else {
7425         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff", (int)flags);
7426         return NULL;
7427     }
7428 }
7429
7430 SV*
7431 Perl_reg_named_buff_iter(pTHX_ REGEXP * const rx, const SV * const lastkey,
7432                          const U32 flags)
7433 {
7434     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ITER;
7435     PERL_UNUSED_ARG(lastkey);
7436
7437     if (flags & RXapif_FIRSTKEY)
7438         return reg_named_buff_firstkey(rx, flags);
7439     else if (flags & RXapif_NEXTKEY)
7440         return reg_named_buff_nextkey(rx, flags);
7441     else {
7442         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_iter",
7443                                             (int)flags);
7444         return NULL;
7445     }
7446 }
7447
7448 SV*
7449 Perl_reg_named_buff_fetch(pTHX_ REGEXP * const r, SV * const namesv,
7450                           const U32 flags)
7451 {
7452     AV *retarray = NULL;
7453     SV *ret;
7454     struct regexp *const rx = ReANY(r);
7455
7456     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FETCH;
7457
7458     if (flags & RXapif_ALL)
7459         retarray=newAV();
7460
7461     if (rx && RXp_PAREN_NAMES(rx)) {
7462         HE *he_str = hv_fetch_ent( RXp_PAREN_NAMES(rx), namesv, 0, 0 );
7463         if (he_str) {
7464             IV i;
7465             SV* sv_dat=HeVAL(he_str);
7466             I32 *nums=(I32*)SvPVX(sv_dat);
7467             for ( i=0; i<SvIVX(sv_dat); i++ ) {
7468                 if ((I32)(rx->nparens) >= nums[i]
7469                     && rx->offs[nums[i]].start != -1
7470                     && rx->offs[nums[i]].end != -1)
7471                 {
7472                     ret = newSVpvs("");
7473                     CALLREG_NUMBUF_FETCH(r,nums[i],ret);
7474                     if (!retarray)
7475                         return ret;
7476                 } else {
7477                     if (retarray)
7478                         ret = newSVsv(&PL_sv_undef);
7479                 }
7480                 if (retarray)
7481                     av_push(retarray, ret);
7482             }
7483             if (retarray)
7484                 return newRV_noinc(MUTABLE_SV(retarray));
7485         }
7486     }
7487     return NULL;
7488 }
7489
7490 bool
7491 Perl_reg_named_buff_exists(pTHX_ REGEXP * const r, SV * const key,
7492                            const U32 flags)
7493 {
7494     struct regexp *const rx = ReANY(r);
7495
7496     PERL_ARGS_ASSERT_REG_NAMED_BUFF_EXISTS;
7497
7498     if (rx && RXp_PAREN_NAMES(rx)) {
7499         if (flags & RXapif_ALL) {
7500             return hv_exists_ent(RXp_PAREN_NAMES(rx), key, 0);
7501         } else {
7502             SV *sv = CALLREG_NAMED_BUFF_FETCH(r, key, flags);
7503             if (sv) {
7504                 SvREFCNT_dec_NN(sv);
7505                 return TRUE;
7506             } else {
7507                 return FALSE;
7508             }
7509         }
7510     } else {
7511         return FALSE;
7512     }
7513 }
7514
7515 SV*
7516 Perl_reg_named_buff_firstkey(pTHX_ REGEXP * const r, const U32 flags)
7517 {
7518     struct regexp *const rx = ReANY(r);
7519
7520     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FIRSTKEY;
7521
7522     if ( rx && RXp_PAREN_NAMES(rx) ) {
7523         (void)hv_iterinit(RXp_PAREN_NAMES(rx));
7524
7525         return CALLREG_NAMED_BUFF_NEXTKEY(r, NULL, flags & ~RXapif_FIRSTKEY);
7526     } else {
7527         return FALSE;
7528     }
7529 }
7530
7531 SV*
7532 Perl_reg_named_buff_nextkey(pTHX_ REGEXP * const r, const U32 flags)
7533 {
7534     struct regexp *const rx = ReANY(r);
7535     GET_RE_DEBUG_FLAGS_DECL;
7536
7537     PERL_ARGS_ASSERT_REG_NAMED_BUFF_NEXTKEY;
7538
7539     if (rx && RXp_PAREN_NAMES(rx)) {
7540         HV *hv = RXp_PAREN_NAMES(rx);
7541         HE *temphe;
7542         while ( (temphe = hv_iternext_flags(hv,0)) ) {
7543             IV i;
7544             IV parno = 0;
7545             SV* sv_dat = HeVAL(temphe);
7546             I32 *nums = (I32*)SvPVX(sv_dat);
7547             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
7548                 if ((I32)(rx->lastparen) >= nums[i] &&
7549                     rx->offs[nums[i]].start != -1 &&
7550                     rx->offs[nums[i]].end != -1)
7551                 {
7552                     parno = nums[i];
7553                     break;
7554                 }
7555             }
7556             if (parno || flags & RXapif_ALL) {
7557                 return newSVhek(HeKEY_hek(temphe));
7558             }
7559         }
7560     }
7561     return NULL;
7562 }
7563
7564 SV*
7565 Perl_reg_named_buff_scalar(pTHX_ REGEXP * const r, const U32 flags)
7566 {
7567     SV *ret;
7568     AV *av;
7569     SSize_t length;
7570     struct regexp *const rx = ReANY(r);
7571
7572     PERL_ARGS_ASSERT_REG_NAMED_BUFF_SCALAR;
7573
7574     if (rx && RXp_PAREN_NAMES(rx)) {
7575         if (flags & (RXapif_ALL | RXapif_REGNAMES_COUNT)) {
7576             return newSViv(HvTOTALKEYS(RXp_PAREN_NAMES(rx)));
7577         } else if (flags & RXapif_ONE) {
7578             ret = CALLREG_NAMED_BUFF_ALL(r, (flags | RXapif_REGNAMES));
7579             av = MUTABLE_AV(SvRV(ret));
7580             length = av_tindex(av);
7581             SvREFCNT_dec_NN(ret);
7582             return newSViv(length + 1);
7583         } else {
7584             Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_scalar",
7585                                                 (int)flags);
7586             return NULL;
7587         }
7588     }
7589     return &PL_sv_undef;
7590 }
7591
7592 SV*
7593 Perl_reg_named_buff_all(pTHX_ REGEXP * const r, const U32 flags)
7594 {
7595     struct regexp *const rx = ReANY(r);
7596     AV *av = newAV();
7597
7598     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ALL;
7599
7600     if (rx && RXp_PAREN_NAMES(rx)) {
7601         HV *hv= RXp_PAREN_NAMES(rx);
7602         HE *temphe;
7603         (void)hv_iterinit(hv);
7604         while ( (temphe = hv_iternext_flags(hv,0)) ) {
7605             IV i;
7606             IV parno = 0;
7607             SV* sv_dat = HeVAL(temphe);
7608             I32 *nums = (I32*)SvPVX(sv_dat);
7609             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
7610                 if ((I32)(rx->lastparen) >= nums[i] &&
7611                     rx->offs[nums[i]].start != -1 &&
7612                     rx->offs[nums[i]].end != -1)
7613                 {
7614                     parno = nums[i];
7615                     break;
7616                 }
7617             }
7618             if (parno || flags & RXapif_ALL) {
7619                 av_push(av, newSVhek(HeKEY_hek(temphe)));
7620             }
7621         }
7622     }
7623
7624     return newRV_noinc(MUTABLE_SV(av));
7625 }
7626
7627 void
7628 Perl_reg_numbered_buff_fetch(pTHX_ REGEXP * const r, const I32 paren,
7629                              SV * const sv)
7630 {
7631     struct regexp *const rx = ReANY(r);
7632     char *s = NULL;
7633     SSize_t i = 0;
7634     SSize_t s1, t1;
7635     I32 n = paren;
7636
7637     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_FETCH;
7638
7639     if (      n == RX_BUFF_IDX_CARET_PREMATCH
7640            || n == RX_BUFF_IDX_CARET_FULLMATCH
7641            || n == RX_BUFF_IDX_CARET_POSTMATCH
7642        )
7643     {
7644         bool keepcopy = cBOOL(rx->extflags & RXf_PMf_KEEPCOPY);
7645         if (!keepcopy) {
7646             /* on something like
7647              *    $r = qr/.../;
7648              *    /$qr/p;
7649              * the KEEPCOPY is set on the PMOP rather than the regex */
7650             if (PL_curpm && r == PM_GETRE(PL_curpm))
7651                  keepcopy = cBOOL(PL_curpm->op_pmflags & PMf_KEEPCOPY);
7652         }
7653         if (!keepcopy)
7654             goto ret_undef;
7655     }
7656
7657     if (!rx->subbeg)
7658         goto ret_undef;
7659
7660     if (n == RX_BUFF_IDX_CARET_FULLMATCH)
7661         /* no need to distinguish between them any more */
7662         n = RX_BUFF_IDX_FULLMATCH;
7663
7664     if ((n == RX_BUFF_IDX_PREMATCH || n == RX_BUFF_IDX_CARET_PREMATCH)
7665         && rx->offs[0].start != -1)
7666     {
7667         /* $`, ${^PREMATCH} */
7668         i = rx->offs[0].start;
7669         s = rx->subbeg;
7670     }
7671     else
7672     if ((n == RX_BUFF_IDX_POSTMATCH || n == RX_BUFF_IDX_CARET_POSTMATCH)
7673         && rx->offs[0].end != -1)
7674     {
7675         /* $', ${^POSTMATCH} */
7676         s = rx->subbeg - rx->suboffset + rx->offs[0].end;
7677         i = rx->sublen + rx->suboffset - rx->offs[0].end;
7678     }
7679     else
7680     if ( 0 <= n && n <= (I32)rx->nparens &&
7681         (s1 = rx->offs[n].start) != -1 &&
7682         (t1 = rx->offs[n].end) != -1)
7683     {
7684         /* $&, ${^MATCH},  $1 ... */
7685         i = t1 - s1;
7686         s = rx->subbeg + s1 - rx->suboffset;
7687     } else {
7688         goto ret_undef;
7689     }
7690
7691     assert(s >= rx->subbeg);
7692     assert((STRLEN)rx->sublen >= (STRLEN)((s - rx->subbeg) + i) );
7693     if (i >= 0) {
7694 #ifdef NO_TAINT_SUPPORT
7695         sv_setpvn(sv, s, i);
7696 #else
7697         const int oldtainted = TAINT_get;
7698         TAINT_NOT;
7699         sv_setpvn(sv, s, i);
7700         TAINT_set(oldtainted);
7701 #endif
7702         if (RXp_MATCH_UTF8(rx))
7703             SvUTF8_on(sv);
7704         else
7705             SvUTF8_off(sv);
7706         if (TAINTING_get) {
7707             if (RXp_MATCH_TAINTED(rx)) {
7708                 if (SvTYPE(sv) >= SVt_PVMG) {
7709                     MAGIC* const mg = SvMAGIC(sv);
7710                     MAGIC* mgt;
7711                     TAINT;
7712                     SvMAGIC_set(sv, mg->mg_moremagic);
7713                     SvTAINT(sv);
7714                     if ((mgt = SvMAGIC(sv))) {
7715                         mg->mg_moremagic = mgt;
7716                         SvMAGIC_set(sv, mg);
7717                     }
7718                 } else {
7719                     TAINT;
7720                     SvTAINT(sv);
7721                 }
7722             } else
7723                 SvTAINTED_off(sv);
7724         }
7725     } else {
7726       ret_undef:
7727         sv_setsv(sv,&PL_sv_undef);
7728         return;
7729     }
7730 }
7731
7732 void
7733 Perl_reg_numbered_buff_store(pTHX_ REGEXP * const rx, const I32 paren,
7734                                                          SV const * const value)
7735 {
7736     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_STORE;
7737
7738     PERL_UNUSED_ARG(rx);
7739     PERL_UNUSED_ARG(paren);
7740     PERL_UNUSED_ARG(value);
7741
7742     if (!PL_localizing)
7743         Perl_croak_no_modify();
7744 }
7745
7746 I32
7747 Perl_reg_numbered_buff_length(pTHX_ REGEXP * const r, const SV * const sv,
7748                               const I32 paren)
7749 {
7750     struct regexp *const rx = ReANY(r);
7751     I32 i;
7752     I32 s1, t1;
7753
7754     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_LENGTH;
7755
7756     if (   paren == RX_BUFF_IDX_CARET_PREMATCH
7757         || paren == RX_BUFF_IDX_CARET_FULLMATCH
7758         || paren == RX_BUFF_IDX_CARET_POSTMATCH
7759     )
7760     {
7761         bool keepcopy = cBOOL(rx->extflags & RXf_PMf_KEEPCOPY);
7762         if (!keepcopy) {
7763             /* on something like
7764              *    $r = qr/.../;
7765              *    /$qr/p;
7766              * the KEEPCOPY is set on the PMOP rather than the regex */
7767             if (PL_curpm && r == PM_GETRE(PL_curpm))
7768                  keepcopy = cBOOL(PL_curpm->op_pmflags & PMf_KEEPCOPY);
7769         }
7770         if (!keepcopy)
7771             goto warn_undef;
7772     }
7773
7774     /* Some of this code was originally in C<Perl_magic_len> in F<mg.c> */
7775     switch (paren) {
7776       case RX_BUFF_IDX_CARET_PREMATCH: /* ${^PREMATCH} */
7777       case RX_BUFF_IDX_PREMATCH:       /* $` */
7778         if (rx->offs[0].start != -1) {
7779                         i = rx->offs[0].start;
7780                         if (i > 0) {
7781                                 s1 = 0;
7782                                 t1 = i;
7783                                 goto getlen;
7784                         }
7785             }
7786         return 0;
7787
7788       case RX_BUFF_IDX_CARET_POSTMATCH: /* ${^POSTMATCH} */
7789       case RX_BUFF_IDX_POSTMATCH:       /* $' */
7790             if (rx->offs[0].end != -1) {
7791                         i = rx->sublen - rx->offs[0].end;
7792                         if (i > 0) {
7793                                 s1 = rx->offs[0].end;
7794                                 t1 = rx->sublen;
7795                                 goto getlen;
7796                         }
7797             }
7798         return 0;
7799
7800       default: /* $& / ${^MATCH}, $1, $2, ... */
7801             if (paren <= (I32)rx->nparens &&
7802             (s1 = rx->offs[paren].start) != -1 &&
7803             (t1 = rx->offs[paren].end) != -1)
7804             {
7805             i = t1 - s1;
7806             goto getlen;
7807         } else {
7808           warn_undef:
7809             if (ckWARN(WARN_UNINITIALIZED))
7810                 report_uninit((const SV *)sv);
7811             return 0;
7812         }
7813     }
7814   getlen:
7815     if (i > 0 && RXp_MATCH_UTF8(rx)) {
7816         const char * const s = rx->subbeg - rx->suboffset + s1;
7817         const U8 *ep;
7818         STRLEN el;
7819
7820         i = t1 - s1;
7821         if (is_utf8_string_loclen((U8*)s, i, &ep, &el))
7822                         i = el;
7823     }
7824     return i;
7825 }
7826
7827 SV*
7828 Perl_reg_qr_package(pTHX_ REGEXP * const rx)
7829 {
7830     PERL_ARGS_ASSERT_REG_QR_PACKAGE;
7831         PERL_UNUSED_ARG(rx);
7832         if (0)
7833             return NULL;
7834         else
7835             return newSVpvs("Regexp");
7836 }
7837
7838 /* Scans the name of a named buffer from the pattern.
7839  * If flags is REG_RSN_RETURN_NULL returns null.
7840  * If flags is REG_RSN_RETURN_NAME returns an SV* containing the name
7841  * If flags is REG_RSN_RETURN_DATA returns the data SV* corresponding
7842  * to the parsed name as looked up in the RExC_paren_names hash.
7843  * If there is an error throws a vFAIL().. type exception.
7844  */
7845
7846 #define REG_RSN_RETURN_NULL    0
7847 #define REG_RSN_RETURN_NAME    1
7848 #define REG_RSN_RETURN_DATA    2
7849
7850 STATIC SV*
7851 S_reg_scan_name(pTHX_ RExC_state_t *pRExC_state, U32 flags)
7852 {
7853     char *name_start = RExC_parse;
7854
7855     PERL_ARGS_ASSERT_REG_SCAN_NAME;
7856
7857     assert (RExC_parse <= RExC_end);
7858     if (RExC_parse == RExC_end) NOOP;
7859     else if (isIDFIRST_lazy_if(RExC_parse, UTF)) {
7860          /* skip IDFIRST by using do...while */
7861         if (UTF)
7862             do {
7863                 RExC_parse += UTF8SKIP(RExC_parse);
7864             } while (isWORDCHAR_utf8((U8*)RExC_parse));
7865         else
7866             do {
7867                 RExC_parse++;
7868             } while (isWORDCHAR(*RExC_parse));
7869     } else {
7870         RExC_parse++; /* so the <- from the vFAIL is after the offending
7871                          character */
7872         vFAIL("Group name must start with a non-digit word character");
7873     }
7874     if ( flags ) {
7875         SV* sv_name
7876             = newSVpvn_flags(name_start, (int)(RExC_parse - name_start),
7877                              SVs_TEMP | (UTF ? SVf_UTF8 : 0));
7878         if ( flags == REG_RSN_RETURN_NAME)
7879             return sv_name;
7880         else if (flags==REG_RSN_RETURN_DATA) {
7881             HE *he_str = NULL;
7882             SV *sv_dat = NULL;
7883             if ( ! sv_name )      /* should not happen*/
7884                 Perl_croak(aTHX_ "panic: no svname in reg_scan_name");
7885             if (RExC_paren_names)
7886                 he_str = hv_fetch_ent( RExC_paren_names, sv_name, 0, 0 );
7887             if ( he_str )
7888                 sv_dat = HeVAL(he_str);
7889             if ( ! sv_dat )
7890                 vFAIL("Reference to nonexistent named group");
7891             return sv_dat;
7892         }
7893         else {
7894             Perl_croak(aTHX_ "panic: bad flag %lx in reg_scan_name",
7895                        (unsigned long) flags);
7896         }
7897         NOT_REACHED; /* NOTREACHED */
7898     }
7899     return NULL;
7900 }
7901
7902 #define DEBUG_PARSE_MSG(funcname)     DEBUG_PARSE_r({           \
7903     int num;                                                    \
7904     if (RExC_lastparse!=RExC_parse) {                           \
7905         PerlIO_printf(Perl_debug_log, "%s",                     \
7906             Perl_pv_pretty(aTHX_ RExC_mysv1, RExC_parse,        \
7907                 RExC_end - RExC_parse, 16,                      \
7908                 "", "",                                         \
7909                 PERL_PV_ESCAPE_UNI_DETECT |                     \
7910                 PERL_PV_PRETTY_ELLIPSES   |                     \
7911                 PERL_PV_PRETTY_LTGT       |                     \
7912                 PERL_PV_ESCAPE_RE         |                     \
7913                 PERL_PV_PRETTY_EXACTSIZE                        \
7914             )                                                   \
7915         );                                                      \
7916     } else                                                      \
7917         PerlIO_printf(Perl_debug_log,"%16s","");                \
7918                                                                 \
7919     if (SIZE_ONLY)                                              \
7920        num = RExC_size + 1;                                     \
7921     else                                                        \
7922        num=REG_NODE_NUM(RExC_emit);                             \
7923     if (RExC_lastnum!=num)                                      \
7924        PerlIO_printf(Perl_debug_log,"|%4d",num);                \
7925     else                                                        \
7926        PerlIO_printf(Perl_debug_log,"|%4s","");                 \
7927     PerlIO_printf(Perl_debug_log,"|%*s%-4s",                    \
7928         (int)((depth*2)), "",                                   \
7929         (funcname)                                              \
7930     );                                                          \
7931     RExC_lastnum=num;                                           \
7932     RExC_lastparse=RExC_parse;                                  \
7933 })
7934
7935
7936
7937 #define DEBUG_PARSE(funcname)     DEBUG_PARSE_r({           \
7938     DEBUG_PARSE_MSG((funcname));                            \
7939     PerlIO_printf(Perl_debug_log,"%4s","\n");               \
7940 })
7941 #define DEBUG_PARSE_FMT(funcname,fmt,args)     DEBUG_PARSE_r({           \
7942     DEBUG_PARSE_MSG((funcname));                            \
7943     PerlIO_printf(Perl_debug_log,fmt "\n",args);               \
7944 })
7945
7946 /* This section of code defines the inversion list object and its methods.  The
7947  * interfaces are highly subject to change, so as much as possible is static to
7948  * this file.  An inversion list is here implemented as a malloc'd C UV array
7949  * as an SVt_INVLIST scalar.
7950  *
7951  * An inversion list for Unicode is an array of code points, sorted by ordinal
7952  * number.  The zeroth element is the first code point in the list.  The 1th
7953  * element is the first element beyond that not in the list.  In other words,
7954  * the first range is
7955  *  invlist[0]..(invlist[1]-1)
7956  * The other ranges follow.  Thus every element whose index is divisible by two
7957  * marks the beginning of a range that is in the list, and every element not
7958  * divisible by two marks the beginning of a range not in the list.  A single
7959  * element inversion list that contains the single code point N generally
7960  * consists of two elements
7961  *  invlist[0] == N
7962  *  invlist[1] == N+1
7963  * (The exception is when N is the highest representable value on the
7964  * machine, in which case the list containing just it would be a single
7965  * element, itself.  By extension, if the last range in the list extends to
7966  * infinity, then the first element of that range will be in the inversion list
7967  * at a position that is divisible by two, and is the final element in the
7968  * list.)
7969  * Taking the complement (inverting) an inversion list is quite simple, if the
7970  * first element is 0, remove it; otherwise add a 0 element at the beginning.
7971  * This implementation reserves an element at the beginning of each inversion
7972  * list to always contain 0; there is an additional flag in the header which
7973  * indicates if the list begins at the 0, or is offset to begin at the next
7974  * element.
7975  *
7976  * More about inversion lists can be found in "Unicode Demystified"
7977  * Chapter 13 by Richard Gillam, published by Addison-Wesley.
7978  * More will be coming when functionality is added later.
7979  *
7980  * The inversion list data structure is currently implemented as an SV pointing
7981  * to an array of UVs that the SV thinks are bytes.  This allows us to have an
7982  * array of UV whose memory management is automatically handled by the existing
7983  * facilities for SV's.
7984  *
7985  * Some of the methods should always be private to the implementation, and some
7986  * should eventually be made public */
7987
7988 /* The header definitions are in F<invlist_inline.h> */
7989
7990 PERL_STATIC_INLINE UV*
7991 S__invlist_array_init(SV* const invlist, const bool will_have_0)
7992 {
7993     /* Returns a pointer to the first element in the inversion list's array.
7994      * This is called upon initialization of an inversion list.  Where the
7995      * array begins depends on whether the list has the code point U+0000 in it
7996      * or not.  The other parameter tells it whether the code that follows this
7997      * call is about to put a 0 in the inversion list or not.  The first
7998      * element is either the element reserved for 0, if TRUE, or the element
7999      * after it, if FALSE */
8000
8001     bool* offset = get_invlist_offset_addr(invlist);
8002     UV* zero_addr = (UV *) SvPVX(invlist);
8003
8004     PERL_ARGS_ASSERT__INVLIST_ARRAY_INIT;
8005
8006     /* Must be empty */
8007     assert(! _invlist_len(invlist));
8008
8009     *zero_addr = 0;
8010
8011     /* 1^1 = 0; 1^0 = 1 */
8012     *offset = 1 ^ will_have_0;
8013     return zero_addr + *offset;
8014 }
8015
8016 PERL_STATIC_INLINE void
8017 S_invlist_set_len(pTHX_ SV* const invlist, const UV len, const bool offset)
8018 {
8019     /* Sets the current number of elements stored in the inversion list.
8020      * Updates SvCUR correspondingly */
8021     PERL_UNUSED_CONTEXT;
8022     PERL_ARGS_ASSERT_INVLIST_SET_LEN;
8023
8024     assert(SvTYPE(invlist) == SVt_INVLIST);
8025
8026     SvCUR_set(invlist,
8027               (len == 0)
8028                ? 0
8029                : TO_INTERNAL_SIZE(len + offset));
8030     assert(SvLEN(invlist) == 0 || SvCUR(invlist) <= SvLEN(invlist));
8031 }
8032
8033 #ifndef PERL_IN_XSUB_RE
8034
8035 PERL_STATIC_INLINE IV*
8036 S_get_invlist_previous_index_addr(SV* invlist)
8037 {
8038     /* Return the address of the IV that is reserved to hold the cached index
8039      * */
8040     PERL_ARGS_ASSERT_GET_INVLIST_PREVIOUS_INDEX_ADDR;
8041
8042     assert(SvTYPE(invlist) == SVt_INVLIST);
8043
8044     return &(((XINVLIST*) SvANY(invlist))->prev_index);
8045 }
8046
8047 PERL_STATIC_INLINE IV
8048 S_invlist_previous_index(SV* const invlist)
8049 {
8050     /* Returns cached index of previous search */
8051
8052     PERL_ARGS_ASSERT_INVLIST_PREVIOUS_INDEX;
8053
8054     return *get_invlist_previous_index_addr(invlist);
8055 }
8056
8057 PERL_STATIC_INLINE void
8058 S_invlist_set_previous_index(SV* const invlist, const IV index)
8059 {
8060     /* Caches <index> for later retrieval */
8061
8062     PERL_ARGS_ASSERT_INVLIST_SET_PREVIOUS_INDEX;
8063
8064     assert(index == 0 || index < (int) _invlist_len(invlist));
8065
8066     *get_invlist_previous_index_addr(invlist) = index;
8067 }
8068
8069 PERL_STATIC_INLINE void
8070 S_invlist_trim(SV* const invlist)
8071 {
8072     PERL_ARGS_ASSERT_INVLIST_TRIM;
8073
8074     assert(SvTYPE(invlist) == SVt_INVLIST);
8075
8076     /* Change the length of the inversion list to how many entries it currently
8077      * has */
8078     SvPV_shrink_to_cur((SV *) invlist);
8079 }
8080
8081 PERL_STATIC_INLINE bool
8082 S_invlist_is_iterating(SV* const invlist)
8083 {
8084     PERL_ARGS_ASSERT_INVLIST_IS_ITERATING;
8085
8086     return *(get_invlist_iter_addr(invlist)) < (STRLEN) UV_MAX;
8087 }
8088
8089 #endif /* ifndef PERL_IN_XSUB_RE */
8090
8091 PERL_STATIC_INLINE UV
8092 S_invlist_max(SV* const invlist)
8093 {
8094     /* Returns the maximum number of elements storable in the inversion list's
8095      * array, without having to realloc() */
8096
8097     PERL_ARGS_ASSERT_INVLIST_MAX;
8098
8099     assert(SvTYPE(invlist) == SVt_INVLIST);
8100
8101     /* Assumes worst case, in which the 0 element is not counted in the
8102      * inversion list, so subtracts 1 for that */
8103     return SvLEN(invlist) == 0  /* This happens under _new_invlist_C_array */
8104            ? FROM_INTERNAL_SIZE(SvCUR(invlist)) - 1
8105            : FROM_INTERNAL_SIZE(SvLEN(invlist)) - 1;
8106 }
8107
8108 #ifndef PERL_IN_XSUB_RE
8109 SV*
8110 Perl__new_invlist(pTHX_ IV initial_size)
8111 {
8112
8113     /* Return a pointer to a newly constructed inversion list, with enough
8114      * space to store 'initial_size' elements.  If that number is negative, a
8115      * system default is used instead */
8116
8117     SV* new_list;
8118
8119     if (initial_size < 0) {
8120         initial_size = 10;
8121     }
8122
8123     /* Allocate the initial space */
8124     new_list = newSV_type(SVt_INVLIST);
8125
8126     /* First 1 is in case the zero element isn't in the list; second 1 is for
8127      * trailing NUL */
8128     SvGROW(new_list, TO_INTERNAL_SIZE(initial_size + 1) + 1);
8129     invlist_set_len(new_list, 0, 0);
8130
8131     /* Force iterinit() to be used to get iteration to work */
8132     *get_invlist_iter_addr(new_list) = (STRLEN) UV_MAX;
8133
8134     *get_invlist_previous_index_addr(new_list) = 0;
8135
8136     return new_list;
8137 }
8138
8139 SV*
8140 Perl__new_invlist_C_array(pTHX_ const UV* const list)
8141 {
8142     /* Return a pointer to a newly constructed inversion list, initialized to
8143      * point to <list>, which has to be in the exact correct inversion list
8144      * form, including internal fields.  Thus this is a dangerous routine that
8145      * should not be used in the wrong hands.  The passed in 'list' contains
8146      * several header fields at the beginning that are not part of the
8147      * inversion list body proper */
8148
8149     const STRLEN length = (STRLEN) list[0];
8150     const UV version_id =          list[1];
8151     const bool offset   =    cBOOL(list[2]);
8152 #define HEADER_LENGTH 3
8153     /* If any of the above changes in any way, you must change HEADER_LENGTH
8154      * (if appropriate) and regenerate INVLIST_VERSION_ID by running
8155      *      perl -E 'say int(rand 2**31-1)'
8156      */
8157 #define INVLIST_VERSION_ID 148565664 /* This is a combination of a version and
8158                                         data structure type, so that one being
8159                                         passed in can be validated to be an
8160                                         inversion list of the correct vintage.
8161                                        */
8162
8163     SV* invlist = newSV_type(SVt_INVLIST);
8164
8165     PERL_ARGS_ASSERT__NEW_INVLIST_C_ARRAY;
8166
8167     if (version_id != INVLIST_VERSION_ID) {
8168         Perl_croak(aTHX_ "panic: Incorrect version for previously generated inversion list");
8169     }
8170
8171     /* The generated array passed in includes header elements that aren't part
8172      * of the list proper, so start it just after them */
8173     SvPV_set(invlist, (char *) (list + HEADER_LENGTH));
8174
8175     SvLEN_set(invlist, 0);  /* Means we own the contents, and the system
8176                                shouldn't touch it */
8177
8178     *(get_invlist_offset_addr(invlist)) = offset;
8179
8180     /* The 'length' passed to us is the physical number of elements in the
8181      * inversion list.  But if there is an offset the logical number is one
8182      * less than that */
8183     invlist_set_len(invlist, length  - offset, offset);
8184
8185     invlist_set_previous_index(invlist, 0);
8186
8187     /* Initialize the iteration pointer. */
8188     invlist_iterfinish(invlist);
8189
8190     SvREADONLY_on(invlist);
8191
8192     return invlist;
8193 }
8194 #endif /* ifndef PERL_IN_XSUB_RE */
8195
8196 STATIC void
8197 S_invlist_extend(pTHX_ SV* const invlist, const UV new_max)
8198 {
8199     /* Grow the maximum size of an inversion list */
8200
8201     PERL_ARGS_ASSERT_INVLIST_EXTEND;
8202
8203     assert(SvTYPE(invlist) == SVt_INVLIST);
8204
8205     /* Add one to account for the zero element at the beginning which may not
8206      * be counted by the calling parameters */
8207     SvGROW((SV *)invlist, TO_INTERNAL_SIZE(new_max + 1));
8208 }
8209
8210 STATIC void
8211 S__append_range_to_invlist(pTHX_ SV* const invlist,
8212                                  const UV start, const UV end)
8213 {
8214    /* Subject to change or removal.  Append the range from 'start' to 'end' at
8215     * the end of the inversion list.  The range must be above any existing
8216     * ones. */
8217
8218     UV* array;
8219     UV max = invlist_max(invlist);
8220     UV len = _invlist_len(invlist);
8221     bool offset;
8222
8223     PERL_ARGS_ASSERT__APPEND_RANGE_TO_INVLIST;
8224
8225     if (len == 0) { /* Empty lists must be initialized */
8226         offset = start != 0;
8227         array = _invlist_array_init(invlist, ! offset);
8228     }
8229     else {
8230         /* Here, the existing list is non-empty. The current max entry in the
8231          * list is generally the first value not in the set, except when the
8232          * set extends to the end of permissible values, in which case it is
8233          * the first entry in that final set, and so this call is an attempt to
8234          * append out-of-order */
8235
8236         UV final_element = len - 1;
8237         array = invlist_array(invlist);
8238         if (array[final_element] > start
8239             || ELEMENT_RANGE_MATCHES_INVLIST(final_element))
8240         {
8241             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",
8242                      array[final_element], start,
8243                      ELEMENT_RANGE_MATCHES_INVLIST(final_element) ? 't' : 'f');
8244         }
8245
8246         /* Here, it is a legal append.  If the new range begins with the first
8247          * value not in the set, it is extending the set, so the new first
8248          * value not in the set is one greater than the newly extended range.
8249          * */
8250         offset = *get_invlist_offset_addr(invlist);
8251         if (array[final_element] == start) {
8252             if (end != UV_MAX) {
8253                 array[final_element] = end + 1;
8254             }
8255             else {
8256                 /* But if the end is the maximum representable on the machine,
8257                  * just let the range that this would extend to have no end */
8258                 invlist_set_len(invlist, len - 1, offset);
8259             }
8260             return;
8261         }
8262     }
8263
8264     /* Here the new range doesn't extend any existing set.  Add it */
8265
8266     len += 2;   /* Includes an element each for the start and end of range */
8267
8268     /* If wll overflow the existing space, extend, which may cause the array to
8269      * be moved */
8270     if (max < len) {
8271         invlist_extend(invlist, len);
8272
8273         /* Have to set len here to avoid assert failure in invlist_array() */
8274         invlist_set_len(invlist, len, offset);
8275
8276         array = invlist_array(invlist);
8277     }
8278     else {
8279         invlist_set_len(invlist, len, offset);
8280     }
8281
8282     /* The next item on the list starts the range, the one after that is
8283      * one past the new range.  */
8284     array[len - 2] = start;
8285     if (end != UV_MAX) {
8286         array[len - 1] = end + 1;
8287     }
8288     else {
8289         /* But if the end is the maximum representable on the machine, just let
8290          * the range have no end */
8291         invlist_set_len(invlist, len - 1, offset);
8292     }
8293 }
8294
8295 #ifndef PERL_IN_XSUB_RE
8296
8297 IV
8298 Perl__invlist_search(SV* const invlist, const UV cp)
8299 {
8300     /* Searches the inversion list for the entry that contains the input code
8301      * point <cp>.  If <cp> is not in the list, -1 is returned.  Otherwise, the
8302      * return value is the index into the list's array of the range that
8303      * contains <cp> */
8304
8305     IV low = 0;
8306     IV mid;
8307     IV high = _invlist_len(invlist);
8308     const IV highest_element = high - 1;
8309     const UV* array;
8310
8311     PERL_ARGS_ASSERT__INVLIST_SEARCH;
8312
8313     /* If list is empty, return failure. */
8314     if (high == 0) {
8315         return -1;
8316     }
8317
8318     /* (We can't get the array unless we know the list is non-empty) */
8319     array = invlist_array(invlist);
8320
8321     mid = invlist_previous_index(invlist);
8322     assert(mid >=0 && mid <= highest_element);
8323
8324     /* <mid> contains the cache of the result of the previous call to this
8325      * function (0 the first time).  See if this call is for the same result,
8326      * or if it is for mid-1.  This is under the theory that calls to this
8327      * function will often be for related code points that are near each other.
8328      * And benchmarks show that caching gives better results.  We also test
8329      * here if the code point is within the bounds of the list.  These tests
8330      * replace others that would have had to be made anyway to make sure that
8331      * the array bounds were not exceeded, and these give us extra information
8332      * at the same time */
8333     if (cp >= array[mid]) {
8334         if (cp >= array[highest_element]) {
8335             return highest_element;
8336         }
8337
8338         /* Here, array[mid] <= cp < array[highest_element].  This means that
8339          * the final element is not the answer, so can exclude it; it also
8340          * means that <mid> is not the final element, so can refer to 'mid + 1'
8341          * safely */
8342         if (cp < array[mid + 1]) {
8343             return mid;
8344         }
8345         high--;
8346         low = mid + 1;
8347     }
8348     else { /* cp < aray[mid] */
8349         if (cp < array[0]) { /* Fail if outside the array */
8350             return -1;
8351         }
8352         high = mid;
8353         if (cp >= array[mid - 1]) {
8354             goto found_entry;
8355         }
8356     }
8357
8358     /* Binary search.  What we are looking for is <i> such that
8359      *  array[i] <= cp < array[i+1]
8360      * The loop below converges on the i+1.  Note that there may not be an
8361      * (i+1)th element in the array, and things work nonetheless */
8362     while (low < high) {
8363         mid = (low + high) / 2;
8364         assert(mid <= highest_element);
8365         if (array[mid] <= cp) { /* cp >= array[mid] */
8366             low = mid + 1;
8367
8368             /* We could do this extra test to exit the loop early.
8369             if (cp < array[low]) {
8370                 return mid;
8371             }
8372             */
8373         }
8374         else { /* cp < array[mid] */
8375             high = mid;
8376         }
8377     }
8378
8379   found_entry:
8380     high--;
8381     invlist_set_previous_index(invlist, high);
8382     return high;
8383 }
8384
8385 void
8386 Perl__invlist_populate_swatch(SV* const invlist,
8387                               const UV start, const UV end, U8* swatch)
8388 {
8389     /* populates a swatch of a swash the same way swatch_get() does in utf8.c,
8390      * but is used when the swash has an inversion list.  This makes this much
8391      * faster, as it uses a binary search instead of a linear one.  This is
8392      * intimately tied to that function, and perhaps should be in utf8.c,
8393      * except it is intimately tied to inversion lists as well.  It assumes
8394      * that <swatch> is all 0's on input */
8395
8396     UV current = start;
8397     const IV len = _invlist_len(invlist);
8398     IV i;
8399     const UV * array;
8400
8401     PERL_ARGS_ASSERT__INVLIST_POPULATE_SWATCH;
8402
8403     if (len == 0) { /* Empty inversion list */
8404         return;
8405     }
8406
8407     array = invlist_array(invlist);
8408
8409     /* Find which element it is */
8410     i = _invlist_search(invlist, start);
8411
8412     /* We populate from <start> to <end> */
8413     while (current < end) {
8414         UV upper;
8415
8416         /* The inversion list gives the results for every possible code point
8417          * after the first one in the list.  Only those ranges whose index is
8418          * even are ones that the inversion list matches.  For the odd ones,
8419          * and if the initial code point is not in the list, we have to skip
8420          * forward to the next element */
8421         if (i == -1 || ! ELEMENT_RANGE_MATCHES_INVLIST(i)) {
8422             i++;
8423             if (i >= len) { /* Finished if beyond the end of the array */
8424                 return;
8425             }
8426             current = array[i];
8427             if (current >= end) {   /* Finished if beyond the end of what we
8428                                        are populating */
8429                 if (LIKELY(end < UV_MAX)) {
8430                     return;
8431                 }
8432
8433                 /* We get here when the upper bound is the maximum
8434                  * representable on the machine, and we are looking for just
8435                  * that code point.  Have to special case it */
8436                 i = len;
8437                 goto join_end_of_list;
8438             }
8439         }
8440         assert(current >= start);
8441
8442         /* The current range ends one below the next one, except don't go past
8443          * <end> */
8444         i++;
8445         upper = (i < len && array[i] < end) ? array[i] : end;
8446
8447         /* Here we are in a range that matches.  Populate a bit in the 3-bit U8
8448          * for each code point in it */
8449         for (; current < upper; current++) {
8450             const STRLEN offset = (STRLEN)(current - start);
8451             swatch[offset >> 3] |= 1 << (offset & 7);
8452         }
8453
8454       join_end_of_list:
8455
8456         /* Quit if at the end of the list */
8457         if (i >= len) {
8458
8459             /* But first, have to deal with the highest possible code point on
8460              * the platform.  The previous code assumes that <end> is one
8461              * beyond where we want to populate, but that is impossible at the
8462              * platform's infinity, so have to handle it specially */
8463             if (UNLIKELY(end == UV_MAX && ELEMENT_RANGE_MATCHES_INVLIST(len-1)))
8464             {
8465                 const STRLEN offset = (STRLEN)(end - start);
8466                 swatch[offset >> 3] |= 1 << (offset & 7);
8467             }
8468             return;
8469         }
8470
8471         /* Advance to the next range, which will be for code points not in the
8472          * inversion list */
8473         current = array[i];
8474     }
8475
8476     return;
8477 }
8478
8479 void
8480 Perl__invlist_union_maybe_complement_2nd(pTHX_ SV* const a, SV* const b,
8481                                          const bool complement_b, SV** output)
8482 {
8483     /* Take the union of two inversion lists and point <output> to it.  *output
8484      * SHOULD BE DEFINED upon input, and if it points to one of the two lists,
8485      * the reference count to that list will be decremented if not already a
8486      * temporary (mortal); otherwise *output will be made correspondingly
8487      * mortal.  The first list, <a>, may be NULL, in which case a copy of the
8488      * second list is returned.  If <complement_b> is TRUE, the union is taken
8489      * of the complement (inversion) of <b> instead of b itself.
8490      *
8491      * The basis for this comes from "Unicode Demystified" Chapter 13 by
8492      * Richard Gillam, published by Addison-Wesley, and explained at some
8493      * length there.  The preface says to incorporate its examples into your
8494      * code at your own risk.
8495      *
8496      * The algorithm is like a merge sort.
8497      *
8498      * XXX A potential performance improvement is to keep track as we go along
8499      * if only one of the inputs contributes to the result, meaning the other
8500      * is a subset of that one.  In that case, we can skip the final copy and
8501      * return the larger of the input lists, but then outside code might need
8502      * to keep track of whether to free the input list or not */
8503
8504     const UV* array_a;    /* a's array */
8505     const UV* array_b;
8506     UV len_a;       /* length of a's array */
8507     UV len_b;
8508
8509     SV* u;                      /* the resulting union */
8510     UV* array_u;
8511     UV len_u;
8512
8513     UV i_a = 0;             /* current index into a's array */
8514     UV i_b = 0;
8515     UV i_u = 0;
8516
8517     /* running count, as explained in the algorithm source book; items are
8518      * stopped accumulating and are output when the count changes to/from 0.
8519      * The count is incremented when we start a range that's in the set, and
8520      * decremented when we start a range that's not in the set.  So its range
8521      * is 0 to 2.  Only when the count is zero is something not in the set.
8522      */
8523     UV count = 0;
8524
8525     PERL_ARGS_ASSERT__INVLIST_UNION_MAYBE_COMPLEMENT_2ND;
8526     assert(a != b);
8527
8528     /* If either one is empty, the union is the other one */
8529     if (a == NULL || ((len_a = _invlist_len(a)) == 0)) {
8530         bool make_temp = FALSE; /* Should we mortalize the result? */
8531
8532         if (*output == a) {
8533             if (a != NULL) {
8534                 if (! (make_temp = cBOOL(SvTEMP(a)))) {
8535                     SvREFCNT_dec_NN(a);
8536                 }
8537             }
8538         }
8539         if (*output != b) {
8540             *output = invlist_clone(b);
8541             if (complement_b) {
8542                 _invlist_invert(*output);
8543             }
8544         } /* else *output already = b; */
8545
8546         if (make_temp) {
8547             sv_2mortal(*output);
8548         }
8549         return;
8550     }
8551     else if ((len_b = _invlist_len(b)) == 0) {
8552         bool make_temp = FALSE;
8553         if (*output == b) {
8554             if (! (make_temp = cBOOL(SvTEMP(b)))) {
8555                 SvREFCNT_dec_NN(b);
8556             }
8557         }
8558
8559         /* The complement of an empty list is a list that has everything in it,
8560          * so the union with <a> includes everything too */
8561         if (complement_b) {
8562             if (a == *output) {
8563                 if (! (make_temp = cBOOL(SvTEMP(a)))) {
8564                     SvREFCNT_dec_NN(a);
8565                 }
8566             }
8567             *output = _new_invlist(1);
8568             _append_range_to_invlist(*output, 0, UV_MAX);
8569         }
8570         else if (*output != a) {
8571             *output = invlist_clone(a);
8572         }
8573         /* else *output already = a; */
8574
8575         if (make_temp) {
8576             sv_2mortal(*output);
8577         }
8578         return;
8579     }
8580
8581     /* Here both lists exist and are non-empty */
8582     array_a = invlist_array(a);
8583     array_b = invlist_array(b);
8584
8585     /* If are to take the union of 'a' with the complement of b, set it
8586      * up so are looking at b's complement. */
8587     if (complement_b) {
8588
8589         /* To complement, we invert: if the first element is 0, remove it.  To
8590          * do this, we just pretend the array starts one later */
8591         if (array_b[0] == 0) {
8592             array_b++;
8593             len_b--;
8594         }
8595         else {
8596
8597             /* But if the first element is not zero, we pretend the list starts
8598              * at the 0 that is always stored immediately before the array. */
8599             array_b--;
8600             len_b++;
8601         }
8602     }
8603
8604     /* Size the union for the worst case: that the sets are completely
8605      * disjoint */
8606     u = _new_invlist(len_a + len_b);
8607
8608     /* Will contain U+0000 if either component does */
8609     array_u = _invlist_array_init(u, (len_a > 0 && array_a[0] == 0)
8610                                       || (len_b > 0 && array_b[0] == 0));
8611
8612     /* Go through each list item by item, stopping when exhausted one of
8613      * them */
8614     while (i_a < len_a && i_b < len_b) {
8615         UV cp;      /* The element to potentially add to the union's array */
8616         bool cp_in_set;   /* is it in the the input list's set or not */
8617
8618         /* We need to take one or the other of the two inputs for the union.
8619          * Since we are merging two sorted lists, we take the smaller of the
8620          * next items.  In case of a tie, we take the one that is in its set
8621          * first.  If we took one not in the set first, it would decrement the
8622          * count, possibly to 0 which would cause it to be output as ending the
8623          * range, and the next time through we would take the same number, and
8624          * output it again as beginning the next range.  By doing it the
8625          * opposite way, there is no possibility that the count will be
8626          * momentarily decremented to 0, and thus the two adjoining ranges will
8627          * be seamlessly merged.  (In a tie and both are in the set or both not
8628          * in the set, it doesn't matter which we take first.) */
8629         if (array_a[i_a] < array_b[i_b]
8630             || (array_a[i_a] == array_b[i_b]
8631                 && ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
8632         {
8633             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
8634             cp= array_a[i_a++];
8635         }
8636         else {
8637             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
8638             cp = array_b[i_b++];
8639         }
8640
8641         /* Here, have chosen which of the two inputs to look at.  Only output
8642          * if the running count changes to/from 0, which marks the
8643          * beginning/end of a range in that's in the set */
8644         if (cp_in_set) {
8645             if (count == 0) {
8646                 array_u[i_u++] = cp;
8647             }
8648             count++;
8649         }
8650         else {
8651             count--;
8652             if (count == 0) {
8653                 array_u[i_u++] = cp;
8654             }
8655         }
8656     }
8657
8658     /* Here, we are finished going through at least one of the lists, which
8659      * means there is something remaining in at most one.  We check if the list
8660      * that hasn't been exhausted is positioned such that we are in the middle
8661      * of a range in its set or not.  (i_a and i_b point to the element beyond
8662      * the one we care about.) If in the set, we decrement 'count'; if 0, there
8663      * is potentially more to output.
8664      * There are four cases:
8665      *  1) Both weren't in their sets, count is 0, and remains 0.  What's left
8666      *     in the union is entirely from the non-exhausted set.
8667      *  2) Both were in their sets, count is 2.  Nothing further should
8668      *     be output, as everything that remains will be in the exhausted
8669      *     list's set, hence in the union; decrementing to 1 but not 0 insures
8670      *     that
8671      *  3) the exhausted was in its set, non-exhausted isn't, count is 1.
8672      *     Nothing further should be output because the union includes
8673      *     everything from the exhausted set.  Not decrementing ensures that.
8674      *  4) the exhausted wasn't in its set, non-exhausted is, count is 1;
8675      *     decrementing to 0 insures that we look at the remainder of the
8676      *     non-exhausted set */
8677     if ((i_a != len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
8678         || (i_b != len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
8679     {
8680         count--;
8681     }
8682
8683     /* The final length is what we've output so far, plus what else is about to
8684      * be output.  (If 'count' is non-zero, then the input list we exhausted
8685      * has everything remaining up to the machine's limit in its set, and hence
8686      * in the union, so there will be no further output. */
8687     len_u = i_u;
8688     if (count == 0) {
8689         /* At most one of the subexpressions will be non-zero */
8690         len_u += (len_a - i_a) + (len_b - i_b);
8691     }
8692
8693     /* Set result to final length, which can change the pointer to array_u, so
8694      * re-find it */
8695     if (len_u != _invlist_len(u)) {
8696         invlist_set_len(u, len_u, *get_invlist_offset_addr(u));
8697         invlist_trim(u);
8698         array_u = invlist_array(u);
8699     }
8700
8701     /* When 'count' is 0, the list that was exhausted (if one was shorter than
8702      * the other) ended with everything above it not in its set.  That means
8703      * that the remaining part of the union is precisely the same as the
8704      * non-exhausted list, so can just copy it unchanged.  (If both list were
8705      * exhausted at the same time, then the operations below will be both 0.)
8706      */
8707     if (count == 0) {
8708         IV copy_count; /* At most one will have a non-zero copy count */
8709         if ((copy_count = len_a - i_a) > 0) {
8710             Copy(array_a + i_a, array_u + i_u, copy_count, UV);
8711         }
8712         else if ((copy_count = len_b - i_b) > 0) {
8713             Copy(array_b + i_b, array_u + i_u, copy_count, UV);
8714         }
8715     }
8716
8717     /*  We may be removing a reference to one of the inputs.  If so, the output
8718      *  is made mortal if the input was.  (Mortal SVs shouldn't have their ref
8719      *  count decremented) */
8720     if (a == *output || b == *output) {
8721         assert(! invlist_is_iterating(*output));
8722         if ((SvTEMP(*output))) {
8723             sv_2mortal(u);
8724         }
8725         else {
8726             SvREFCNT_dec_NN(*output);
8727         }
8728     }
8729
8730     *output = u;
8731
8732     return;
8733 }
8734
8735 void
8736 Perl__invlist_intersection_maybe_complement_2nd(pTHX_ SV* const a, SV* const b,
8737                                                const bool complement_b, SV** i)
8738 {
8739     /* Take the intersection of two inversion lists and point <i> to it.  *i
8740      * SHOULD BE DEFINED upon input, and if it points to one of the two lists,
8741      * the reference count to that list will be decremented if not already a
8742      * temporary (mortal); otherwise *i will be made correspondingly mortal.
8743      * The first list, <a>, may be NULL, in which case an empty list is
8744      * returned.  If <complement_b> is TRUE, the result will be the
8745      * intersection of <a> and the complement (or inversion) of <b> instead of
8746      * <b> directly.
8747      *
8748      * The basis for this comes from "Unicode Demystified" Chapter 13 by
8749      * Richard Gillam, published by Addison-Wesley, and explained at some
8750      * length there.  The preface says to incorporate its examples into your
8751      * code at your own risk.  In fact, it had bugs
8752      *
8753      * The algorithm is like a merge sort, and is essentially the same as the
8754      * union above
8755      */
8756
8757     const UV* array_a;          /* a's array */
8758     const UV* array_b;
8759     UV len_a;   /* length of a's array */
8760     UV len_b;
8761
8762     SV* r;                   /* the resulting intersection */
8763     UV* array_r;
8764     UV len_r;
8765
8766     UV i_a = 0;             /* current index into a's array */
8767     UV i_b = 0;
8768     UV i_r = 0;
8769
8770     /* running count, as explained in the algorithm source book; items are
8771      * stopped accumulating and are output when the count changes to/from 2.
8772      * The count is incremented when we start a range that's in the set, and
8773      * decremented when we start a range that's not in the set.  So its range
8774      * is 0 to 2.  Only when the count is 2 is something in the intersection.
8775      */
8776     UV count = 0;
8777
8778     PERL_ARGS_ASSERT__INVLIST_INTERSECTION_MAYBE_COMPLEMENT_2ND;
8779     assert(a != b);
8780
8781     /* Special case if either one is empty */
8782     len_a = (a == NULL) ? 0 : _invlist_len(a);
8783     if ((len_a == 0) || ((len_b = _invlist_len(b)) == 0)) {
8784         bool make_temp = FALSE;
8785
8786         if (len_a != 0 && complement_b) {
8787
8788             /* Here, 'a' is not empty, therefore from the above 'if', 'b' must
8789              * be empty.  Here, also we are using 'b's complement, which hence
8790              * must be every possible code point.  Thus the intersection is
8791              * simply 'a'. */
8792             if (*i != a) {
8793                 if (*i == b) {
8794                     if (! (make_temp = cBOOL(SvTEMP(b)))) {
8795                         SvREFCNT_dec_NN(b);
8796                     }
8797                 }
8798
8799                 *i = invlist_clone(a);
8800             }
8801             /* else *i is already 'a' */
8802
8803             if (make_temp) {
8804                 sv_2mortal(*i);
8805             }
8806             return;
8807         }
8808
8809         /* Here, 'a' or 'b' is empty and not using the complement of 'b'.  The
8810          * intersection must be empty */
8811         if (*i == a) {
8812             if (! (make_temp = cBOOL(SvTEMP(a)))) {
8813                 SvREFCNT_dec_NN(a);
8814             }
8815         }
8816         else if (*i == b) {
8817             if (! (make_temp = cBOOL(SvTEMP(b)))) {
8818                 SvREFCNT_dec_NN(b);
8819             }
8820         }
8821         *i = _new_invlist(0);
8822         if (make_temp) {
8823             sv_2mortal(*i);
8824         }
8825
8826         return;
8827     }
8828
8829     /* Here both lists exist and are non-empty */
8830     array_a = invlist_array(a);
8831     array_b = invlist_array(b);
8832
8833     /* If are to take the intersection of 'a' with the complement of b, set it
8834      * up so are looking at b's complement. */
8835     if (complement_b) {
8836
8837         /* To complement, we invert: if the first element is 0, remove it.  To
8838          * do this, we just pretend the array starts one later */
8839         if (array_b[0] == 0) {
8840             array_b++;
8841             len_b--;
8842         }
8843         else {
8844
8845             /* But if the first element is not zero, we pretend the list starts
8846              * at the 0 that is always stored immediately before the array. */
8847             array_b--;
8848             len_b++;
8849         }
8850     }
8851
8852     /* Size the intersection for the worst case: that the intersection ends up
8853      * fragmenting everything to be completely disjoint */
8854     r= _new_invlist(len_a + len_b);
8855
8856     /* Will contain U+0000 iff both components do */
8857     array_r = _invlist_array_init(r, len_a > 0 && array_a[0] == 0
8858                                      && len_b > 0 && array_b[0] == 0);
8859
8860     /* Go through each list item by item, stopping when exhausted one of
8861      * them */
8862     while (i_a < len_a && i_b < len_b) {
8863         UV cp;      /* The element to potentially add to the intersection's
8864                        array */
8865         bool cp_in_set; /* Is it in the input list's set or not */
8866
8867         /* We need to take one or the other of the two inputs for the
8868          * intersection.  Since we are merging two sorted lists, we take the
8869          * smaller of the next items.  In case of a tie, we take the one that
8870          * is not in its set first (a difference from the union algorithm).  If
8871          * we took one in the set first, it would increment the count, possibly
8872          * to 2 which would cause it to be output as starting a range in the
8873          * intersection, and the next time through we would take that same
8874          * number, and output it again as ending the set.  By doing it the
8875          * opposite of this, there is no possibility that the count will be
8876          * momentarily incremented to 2.  (In a tie and both are in the set or
8877          * both not in the set, it doesn't matter which we take first.) */
8878         if (array_a[i_a] < array_b[i_b]
8879             || (array_a[i_a] == array_b[i_b]
8880                 && ! ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
8881         {
8882             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
8883             cp= array_a[i_a++];
8884         }
8885         else {
8886             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
8887             cp= array_b[i_b++];
8888         }
8889
8890         /* Here, have chosen which of the two inputs to look at.  Only output
8891          * if the running count changes to/from 2, which marks the
8892          * beginning/end of a range that's in the intersection */
8893         if (cp_in_set) {
8894             count++;
8895             if (count == 2) {
8896                 array_r[i_r++] = cp;
8897             }
8898         }
8899         else {
8900             if (count == 2) {
8901                 array_r[i_r++] = cp;
8902             }
8903             count--;
8904         }
8905     }
8906
8907     /* Here, we are finished going through at least one of the lists, which
8908      * means there is something remaining in at most one.  We check if the list
8909      * that has been exhausted is positioned such that we are in the middle
8910      * of a range in its set or not.  (i_a and i_b point to elements 1 beyond
8911      * the ones we care about.)  There are four cases:
8912      *  1) Both weren't in their sets, count is 0, and remains 0.  There's
8913      *     nothing left in the intersection.
8914      *  2) Both were in their sets, count is 2 and perhaps is incremented to
8915      *     above 2.  What should be output is exactly that which is in the
8916      *     non-exhausted set, as everything it has is also in the intersection
8917      *     set, and everything it doesn't have can't be in the intersection
8918      *  3) The exhausted was in its set, non-exhausted isn't, count is 1, and
8919      *     gets incremented to 2.  Like the previous case, the intersection is
8920      *     everything that remains in the non-exhausted set.
8921      *  4) the exhausted wasn't in its set, non-exhausted is, count is 1, and
8922      *     remains 1.  And the intersection has nothing more. */
8923     if ((i_a == len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
8924         || (i_b == len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
8925     {
8926         count++;
8927     }
8928
8929     /* The final length is what we've output so far plus what else is in the
8930      * intersection.  At most one of the subexpressions below will be non-zero
8931      * */
8932     len_r = i_r;
8933     if (count >= 2) {
8934         len_r += (len_a - i_a) + (len_b - i_b);
8935     }
8936
8937     /* Set result to final length, which can change the pointer to array_r, so
8938      * re-find it */
8939     if (len_r != _invlist_len(r)) {
8940         invlist_set_len(r, len_r, *get_invlist_offset_addr(r));
8941         invlist_trim(r);
8942         array_r = invlist_array(r);
8943     }
8944
8945     /* Finish outputting any remaining */
8946     if (count >= 2) { /* At most one will have a non-zero copy count */
8947         IV copy_count;
8948         if ((copy_count = len_a - i_a) > 0) {
8949             Copy(array_a + i_a, array_r + i_r, copy_count, UV);
8950         }
8951         else if ((copy_count = len_b - i_b) > 0) {
8952             Copy(array_b + i_b, array_r + i_r, copy_count, UV);
8953         }
8954     }
8955
8956     /*  We may be removing a reference to one of the inputs.  If so, the output
8957      *  is made mortal if the input was.  (Mortal SVs shouldn't have their ref
8958      *  count decremented) */
8959     if (a == *i || b == *i) {
8960         assert(! invlist_is_iterating(*i));
8961         if (SvTEMP(*i)) {
8962             sv_2mortal(r);
8963         }
8964         else {
8965             SvREFCNT_dec_NN(*i);
8966         }
8967     }
8968
8969     *i = r;
8970
8971     return;
8972 }
8973
8974 SV*
8975 Perl__add_range_to_invlist(pTHX_ SV* invlist, const UV start, const UV end)
8976 {
8977     /* Add the range from 'start' to 'end' inclusive to the inversion list's
8978      * set.  A pointer to the inversion list is returned.  This may actually be
8979      * a new list, in which case the passed in one has been destroyed.  The
8980      * passed-in inversion list can be NULL, in which case a new one is created
8981      * with just the one range in it */
8982
8983     SV* range_invlist;
8984     UV len;
8985
8986     if (invlist == NULL) {
8987         invlist = _new_invlist(2);
8988         len = 0;
8989     }
8990     else {
8991         len = _invlist_len(invlist);
8992     }
8993
8994     /* If comes after the final entry actually in the list, can just append it
8995      * to the end, */
8996     if (len == 0
8997         || (! ELEMENT_RANGE_MATCHES_INVLIST(len - 1)
8998             && start >= invlist_array(invlist)[len - 1]))
8999     {
9000         _append_range_to_invlist(invlist, start, end);
9001         return invlist;
9002     }
9003
9004     /* Here, can't just append things, create and return a new inversion list
9005      * which is the union of this range and the existing inversion list.  (If
9006      * the new range is well-behaved wrt to the old one, we could just insert
9007      * it, doing a Move() down on the tail of the old one (potentially growing
9008      * it first).  But to determine that means we would have the extra
9009      * (possibly throw-away) work of first finding where the new one goes and
9010      * whether it disrupts (splits) an existing range, so it doesn't appear to
9011      * me (khw) that it's worth it) */
9012     range_invlist = _new_invlist(2);
9013     _append_range_to_invlist(range_invlist, start, end);
9014
9015     _invlist_union(invlist, range_invlist, &invlist);
9016
9017     /* The temporary can be freed */
9018     SvREFCNT_dec_NN(range_invlist);
9019
9020     return invlist;
9021 }
9022
9023 SV*
9024 Perl__setup_canned_invlist(pTHX_ const STRLEN size, const UV element0,
9025                                  UV** other_elements_ptr)
9026 {
9027     /* Create and return an inversion list whose contents are to be populated
9028      * by the caller.  The caller gives the number of elements (in 'size') and
9029      * the very first element ('element0').  This function will set
9030      * '*other_elements_ptr' to an array of UVs, where the remaining elements
9031      * are to be placed.
9032      *
9033      * Obviously there is some trust involved that the caller will properly
9034      * fill in the other elements of the array.
9035      *
9036      * (The first element needs to be passed in, as the underlying code does
9037      * things differently depending on whether it is zero or non-zero) */
9038
9039     SV* invlist = _new_invlist(size);
9040     bool offset;
9041
9042     PERL_ARGS_ASSERT__SETUP_CANNED_INVLIST;
9043
9044     _append_range_to_invlist(invlist, element0, element0);
9045     offset = *get_invlist_offset_addr(invlist);
9046
9047     invlist_set_len(invlist, size, offset);
9048     *other_elements_ptr = invlist_array(invlist) + 1;
9049     return invlist;
9050 }
9051
9052 #endif
9053
9054 PERL_STATIC_INLINE SV*
9055 S_add_cp_to_invlist(pTHX_ SV* invlist, const UV cp) {
9056     return _add_range_to_invlist(invlist, cp, cp);
9057 }
9058
9059 #ifndef PERL_IN_XSUB_RE
9060 void
9061 Perl__invlist_invert(pTHX_ SV* const invlist)
9062 {
9063     /* Complement the input inversion list.  This adds a 0 if the list didn't
9064      * have a zero; removes it otherwise.  As described above, the data
9065      * structure is set up so that this is very efficient */
9066
9067     PERL_ARGS_ASSERT__INVLIST_INVERT;
9068
9069     assert(! invlist_is_iterating(invlist));
9070
9071     /* The inverse of matching nothing is matching everything */
9072     if (_invlist_len(invlist) == 0) {
9073         _append_range_to_invlist(invlist, 0, UV_MAX);
9074         return;
9075     }
9076
9077     *get_invlist_offset_addr(invlist) = ! *get_invlist_offset_addr(invlist);
9078 }
9079
9080 #endif
9081
9082 PERL_STATIC_INLINE SV*
9083 S_invlist_clone(pTHX_ SV* const invlist)
9084 {
9085
9086     /* Return a new inversion list that is a copy of the input one, which is
9087      * unchanged.  The new list will not be mortal even if the old one was. */
9088
9089     /* Need to allocate extra space to accommodate Perl's addition of a
9090      * trailing NUL to SvPV's, since it thinks they are always strings */
9091     SV* new_invlist = _new_invlist(_invlist_len(invlist) + 1);
9092     STRLEN physical_length = SvCUR(invlist);
9093     bool offset = *(get_invlist_offset_addr(invlist));
9094
9095     PERL_ARGS_ASSERT_INVLIST_CLONE;
9096
9097     *(get_invlist_offset_addr(new_invlist)) = offset;
9098     invlist_set_len(new_invlist, _invlist_len(invlist), offset);
9099     Copy(SvPVX(invlist), SvPVX(new_invlist), physical_length, char);
9100
9101     return new_invlist;
9102 }
9103
9104 PERL_STATIC_INLINE STRLEN*
9105 S_get_invlist_iter_addr(SV* invlist)
9106 {
9107     /* Return the address of the UV that contains the current iteration
9108      * position */
9109
9110     PERL_ARGS_ASSERT_GET_INVLIST_ITER_ADDR;
9111
9112     assert(SvTYPE(invlist) == SVt_INVLIST);
9113
9114     return &(((XINVLIST*) SvANY(invlist))->iterator);
9115 }
9116
9117 PERL_STATIC_INLINE void
9118 S_invlist_iterinit(SV* invlist) /* Initialize iterator for invlist */
9119 {
9120     PERL_ARGS_ASSERT_INVLIST_ITERINIT;
9121
9122     *get_invlist_iter_addr(invlist) = 0;
9123 }
9124
9125 PERL_STATIC_INLINE void
9126 S_invlist_iterfinish(SV* invlist)
9127 {
9128     /* Terminate iterator for invlist.  This is to catch development errors.
9129      * Any iteration that is interrupted before completed should call this
9130      * function.  Functions that add code points anywhere else but to the end
9131      * of an inversion list assert that they are not in the middle of an
9132      * iteration.  If they were, the addition would make the iteration
9133      * problematical: if the iteration hadn't reached the place where things
9134      * were being added, it would be ok */
9135
9136     PERL_ARGS_ASSERT_INVLIST_ITERFINISH;
9137
9138     *get_invlist_iter_addr(invlist) = (STRLEN) UV_MAX;
9139 }
9140
9141 STATIC bool
9142 S_invlist_iternext(SV* invlist, UV* start, UV* end)
9143 {
9144     /* An C<invlist_iterinit> call on <invlist> must be used to set this up.
9145      * This call sets in <*start> and <*end>, the next range in <invlist>.
9146      * Returns <TRUE> if successful and the next call will return the next
9147      * range; <FALSE> if was already at the end of the list.  If the latter,
9148      * <*start> and <*end> are unchanged, and the next call to this function
9149      * will start over at the beginning of the list */
9150
9151     STRLEN* pos = get_invlist_iter_addr(invlist);
9152     UV len = _invlist_len(invlist);
9153     UV *array;
9154
9155     PERL_ARGS_ASSERT_INVLIST_ITERNEXT;
9156
9157     if (*pos >= len) {
9158         *pos = (STRLEN) UV_MAX; /* Force iterinit() to be required next time */
9159         return FALSE;
9160     }
9161
9162     array = invlist_array(invlist);
9163
9164     *start = array[(*pos)++];
9165
9166     if (*pos >= len) {
9167         *end = UV_MAX;
9168     }
9169     else {
9170         *end = array[(*pos)++] - 1;
9171     }
9172
9173     return TRUE;
9174 }
9175
9176 PERL_STATIC_INLINE UV
9177 S_invlist_highest(SV* const invlist)
9178 {
9179     /* Returns the highest code point that matches an inversion list.  This API
9180      * has an ambiguity, as it returns 0 under either the highest is actually
9181      * 0, or if the list is empty.  If this distinction matters to you, check
9182      * for emptiness before calling this function */
9183
9184     UV len = _invlist_len(invlist);
9185     UV *array;
9186
9187     PERL_ARGS_ASSERT_INVLIST_HIGHEST;
9188
9189     if (len == 0) {
9190         return 0;
9191     }
9192
9193     array = invlist_array(invlist);
9194
9195     /* The last element in the array in the inversion list always starts a
9196      * range that goes to infinity.  That range may be for code points that are
9197      * matched in the inversion list, or it may be for ones that aren't
9198      * matched.  In the latter case, the highest code point in the set is one
9199      * less than the beginning of this range; otherwise it is the final element
9200      * of this range: infinity */
9201     return (ELEMENT_RANGE_MATCHES_INVLIST(len - 1))
9202            ? UV_MAX
9203            : array[len - 1] - 1;
9204 }
9205
9206 #ifndef PERL_IN_XSUB_RE
9207 SV *
9208 Perl__invlist_contents(pTHX_ SV* const invlist)
9209 {
9210     /* Get the contents of an inversion list into a string SV so that they can
9211      * be printed out.  It uses the format traditionally done for debug tracing
9212      */
9213
9214     UV start, end;
9215     SV* output = newSVpvs("\n");
9216
9217     PERL_ARGS_ASSERT__INVLIST_CONTENTS;
9218
9219     assert(! invlist_is_iterating(invlist));
9220
9221     invlist_iterinit(invlist);
9222     while (invlist_iternext(invlist, &start, &end)) {
9223         if (end == UV_MAX) {
9224             Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\tINFINITY\n", start);
9225         }
9226         else if (end != start) {
9227             Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\t%04"UVXf"\n",
9228                     start,       end);
9229         }
9230         else {
9231             Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\n", start);
9232         }
9233     }
9234
9235     return output;
9236 }
9237 #endif
9238
9239 #ifndef PERL_IN_XSUB_RE
9240 void
9241 Perl__invlist_dump(pTHX_ PerlIO *file, I32 level,
9242                          const char * const indent, SV* const invlist)
9243 {
9244     /* Designed to be called only by do_sv_dump().  Dumps out the ranges of the
9245      * inversion list 'invlist' to 'file' at 'level'  Each line is prefixed by
9246      * the string 'indent'.  The output looks like this:
9247          [0] 0x000A .. 0x000D
9248          [2] 0x0085
9249          [4] 0x2028 .. 0x2029
9250          [6] 0x3104 .. INFINITY
9251      * This means that the first range of code points matched by the list are
9252      * 0xA through 0xD; the second range contains only the single code point
9253      * 0x85, etc.  An inversion list is an array of UVs.  Two array elements
9254      * are used to define each range (except if the final range extends to
9255      * infinity, only a single element is needed).  The array index of the
9256      * first element for the corresponding range is given in brackets. */
9257
9258     UV start, end;
9259     STRLEN count = 0;
9260
9261     PERL_ARGS_ASSERT__INVLIST_DUMP;
9262
9263     if (invlist_is_iterating(invlist)) {
9264         Perl_dump_indent(aTHX_ level, file,
9265              "%sCan't dump inversion list because is in middle of iterating\n",
9266              indent);
9267         return;
9268     }
9269
9270     invlist_iterinit(invlist);
9271     while (invlist_iternext(invlist, &start, &end)) {
9272         if (end == UV_MAX) {
9273             Perl_dump_indent(aTHX_ level, file,
9274                                        "%s[%"UVuf"] 0x%04"UVXf" .. INFINITY\n",
9275                                    indent, (UV)count, start);
9276         }
9277         else if (end != start) {
9278             Perl_dump_indent(aTHX_ level, file,
9279                                     "%s[%"UVuf"] 0x%04"UVXf" .. 0x%04"UVXf"\n",
9280                                 indent, (UV)count, start,         end);
9281         }
9282         else {
9283             Perl_dump_indent(aTHX_ level, file, "%s[%"UVuf"] 0x%04"UVXf"\n",
9284                                             indent, (UV)count, start);
9285         }
9286         count += 2;
9287     }
9288 }
9289
9290 void
9291 Perl__load_PL_utf8_foldclosures (pTHX)
9292 {
9293     assert(! PL_utf8_foldclosures);
9294
9295     /* If the folds haven't been read in, call a fold function
9296      * to force that */
9297     if (! PL_utf8_tofold) {
9298         U8 dummy[UTF8_MAXBYTES_CASE+1];
9299
9300         /* This string is just a short named one above \xff */
9301         to_utf8_fold((U8*) HYPHEN_UTF8, dummy, NULL);
9302         assert(PL_utf8_tofold); /* Verify that worked */
9303     }
9304     PL_utf8_foldclosures = _swash_inversion_hash(PL_utf8_tofold);
9305 }
9306 #endif
9307
9308 #ifdef PERL_ARGS_ASSERT__INVLISTEQ
9309 bool
9310 S__invlistEQ(pTHX_ SV* const a, SV* const b, const bool complement_b)
9311 {
9312     /* Return a boolean as to if the two passed in inversion lists are
9313      * identical.  The final argument, if TRUE, says to take the complement of
9314      * the second inversion list before doing the comparison */
9315
9316     const UV* array_a = invlist_array(a);
9317     const UV* array_b = invlist_array(b);
9318     UV len_a = _invlist_len(a);
9319     UV len_b = _invlist_len(b);
9320
9321     UV i = 0;               /* current index into the arrays */
9322     bool retval = TRUE;     /* Assume are identical until proven otherwise */
9323
9324     PERL_ARGS_ASSERT__INVLISTEQ;
9325
9326     /* If are to compare 'a' with the complement of b, set it
9327      * up so are looking at b's complement. */
9328     if (complement_b) {
9329
9330         /* The complement of nothing is everything, so <a> would have to have
9331          * just one element, starting at zero (ending at infinity) */
9332         if (len_b == 0) {
9333             return (len_a == 1 && array_a[0] == 0);
9334         }
9335         else if (array_b[0] == 0) {
9336
9337             /* Otherwise, to complement, we invert.  Here, the first element is
9338              * 0, just remove it.  To do this, we just pretend the array starts
9339              * one later */
9340
9341             array_b++;
9342             len_b--;
9343         }
9344         else {
9345
9346             /* But if the first element is not zero, we pretend the list starts
9347              * at the 0 that is always stored immediately before the array. */
9348             array_b--;
9349             len_b++;
9350         }
9351     }
9352
9353     /* Make sure that the lengths are the same, as well as the final element
9354      * before looping through the remainder.  (Thus we test the length, final,
9355      * and first elements right off the bat) */
9356     if (len_a != len_b || array_a[len_a-1] != array_b[len_a-1]) {
9357         retval = FALSE;
9358     }
9359     else for (i = 0; i < len_a - 1; i++) {
9360         if (array_a[i] != array_b[i]) {
9361             retval = FALSE;
9362             break;
9363         }
9364     }
9365
9366     return retval;
9367 }
9368 #endif
9369
9370 /*
9371  * As best we can, determine the characters that can match the start of
9372  * the given EXACTF-ish node.
9373  *
9374  * Returns the invlist as a new SV*; it is the caller's responsibility to
9375  * call SvREFCNT_dec() when done with it.
9376  */
9377 STATIC SV*
9378 S__make_exactf_invlist(pTHX_ RExC_state_t *pRExC_state, regnode *node)
9379 {
9380     const U8 * s = (U8*)STRING(node);
9381     SSize_t bytelen = STR_LEN(node);
9382     UV uc;
9383     /* Start out big enough for 2 separate code points */
9384     SV* invlist = _new_invlist(4);
9385
9386     PERL_ARGS_ASSERT__MAKE_EXACTF_INVLIST;
9387
9388     if (! UTF) {
9389         uc = *s;
9390
9391         /* We punt and assume can match anything if the node begins
9392          * with a multi-character fold.  Things are complicated.  For
9393          * example, /ffi/i could match any of:
9394          *  "\N{LATIN SMALL LIGATURE FFI}"
9395          *  "\N{LATIN SMALL LIGATURE FF}I"
9396          *  "F\N{LATIN SMALL LIGATURE FI}"
9397          *  plus several other things; and making sure we have all the
9398          *  possibilities is hard. */
9399         if (is_MULTI_CHAR_FOLD_latin1_safe(s, s + bytelen)) {
9400             invlist = _add_range_to_invlist(invlist, 0, UV_MAX);
9401         }
9402         else {
9403             /* Any Latin1 range character can potentially match any
9404              * other depending on the locale */
9405             if (OP(node) == EXACTFL) {
9406                 _invlist_union(invlist, PL_Latin1, &invlist);
9407             }
9408             else {
9409                 /* But otherwise, it matches at least itself.  We can
9410                  * quickly tell if it has a distinct fold, and if so,
9411                  * it matches that as well */
9412                 invlist = add_cp_to_invlist(invlist, uc);
9413                 if (IS_IN_SOME_FOLD_L1(uc))
9414                     invlist = add_cp_to_invlist(invlist, PL_fold_latin1[uc]);
9415             }
9416
9417             /* Some characters match above-Latin1 ones under /i.  This
9418              * is true of EXACTFL ones when the locale is UTF-8 */
9419             if (HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(uc)
9420                 && (! isASCII(uc) || (OP(node) != EXACTFA
9421                                     && OP(node) != EXACTFA_NO_TRIE)))
9422             {
9423                 add_above_Latin1_folds(pRExC_state, (U8) uc, &invlist);
9424             }
9425         }
9426     }
9427     else {  /* Pattern is UTF-8 */
9428         U8 folded[UTF8_MAX_FOLD_CHAR_EXPAND * UTF8_MAXBYTES_CASE + 1] = { '\0' };
9429         STRLEN foldlen = UTF8SKIP(s);
9430         const U8* e = s + bytelen;
9431         SV** listp;
9432
9433         uc = utf8_to_uvchr_buf(s, s + bytelen, NULL);
9434
9435         /* The only code points that aren't folded in a UTF EXACTFish
9436          * node are are the problematic ones in EXACTFL nodes */
9437         if (OP(node) == EXACTFL && is_PROBLEMATIC_LOCALE_FOLDEDS_START_cp(uc)) {
9438             /* We need to check for the possibility that this EXACTFL
9439              * node begins with a multi-char fold.  Therefore we fold
9440              * the first few characters of it so that we can make that
9441              * check */
9442             U8 *d = folded;
9443             int i;
9444
9445             for (i = 0; i < UTF8_MAX_FOLD_CHAR_EXPAND && s < e; i++) {
9446                 if (isASCII(*s)) {
9447                     *(d++) = (U8) toFOLD(*s);
9448                     s++;
9449                 }
9450                 else {
9451                     STRLEN len;
9452                     to_utf8_fold(s, d, &len);
9453                     d += len;
9454                     s += UTF8SKIP(s);
9455                 }
9456             }
9457
9458             /* And set up so the code below that looks in this folded
9459              * buffer instead of the node's string */
9460             e = d;
9461             foldlen = UTF8SKIP(folded);
9462             s = folded;
9463         }
9464
9465         /* When we reach here 's' points to the fold of the first
9466          * character(s) of the node; and 'e' points to far enough along
9467          * the folded string to be just past any possible multi-char
9468          * fold. 'foldlen' is the length in bytes of the first
9469          * character in 's'
9470          *
9471          * Unlike the non-UTF-8 case, the macro for determining if a
9472          * string is a multi-char fold requires all the characters to
9473          * already be folded.  This is because of all the complications
9474          * if not.  Note that they are folded anyway, except in EXACTFL
9475          * nodes.  Like the non-UTF case above, we punt if the node
9476          * begins with a multi-char fold  */
9477
9478         if (is_MULTI_CHAR_FOLD_utf8_safe(s, e)) {
9479             invlist = _add_range_to_invlist(invlist, 0, UV_MAX);
9480         }
9481         else {  /* Single char fold */
9482
9483             /* It matches all the things that fold to it, which are
9484              * found in PL_utf8_foldclosures (including itself) */
9485             invlist = add_cp_to_invlist(invlist, uc);
9486             if (! PL_utf8_foldclosures)
9487                 _load_PL_utf8_foldclosures();
9488             if ((listp = hv_fetch(PL_utf8_foldclosures,
9489                                 (char *) s, foldlen, FALSE)))
9490             {
9491                 AV* list = (AV*) *listp;
9492                 IV k;
9493                 for (k = 0; k <= av_tindex(list); k++) {
9494                     SV** c_p = av_fetch(list, k, FALSE);
9495                     UV c;
9496                     assert(c_p);
9497
9498                     c = SvUV(*c_p);
9499
9500                     /* /aa doesn't allow folds between ASCII and non- */
9501                     if ((OP(node) == EXACTFA || OP(node) == EXACTFA_NO_TRIE)
9502                         && isASCII(c) != isASCII(uc))
9503                     {
9504                         continue;
9505                     }
9506
9507                     invlist = add_cp_to_invlist(invlist, c);
9508                 }
9509             }
9510         }
9511     }
9512
9513     return invlist;
9514 }
9515
9516 #undef HEADER_LENGTH
9517 #undef TO_INTERNAL_SIZE
9518 #undef FROM_INTERNAL_SIZE
9519 #undef INVLIST_VERSION_ID
9520
9521 /* End of inversion list object */
9522
9523 STATIC void
9524 S_parse_lparen_question_flags(pTHX_ RExC_state_t *pRExC_state)
9525 {
9526     /* This parses the flags that are in either the '(?foo)' or '(?foo:bar)'
9527      * constructs, and updates RExC_flags with them.  On input, RExC_parse
9528      * should point to the first flag; it is updated on output to point to the
9529      * final ')' or ':'.  There needs to be at least one flag, or this will
9530      * abort */
9531
9532     /* for (?g), (?gc), and (?o) warnings; warning
9533        about (?c) will warn about (?g) -- japhy    */
9534
9535 #define WASTED_O  0x01
9536 #define WASTED_G  0x02
9537 #define WASTED_C  0x04
9538 #define WASTED_GC (WASTED_G|WASTED_C)
9539     I32 wastedflags = 0x00;
9540     U32 posflags = 0, negflags = 0;
9541     U32 *flagsp = &posflags;
9542     char has_charset_modifier = '\0';
9543     regex_charset cs;
9544     bool has_use_defaults = FALSE;
9545     const char* const seqstart = RExC_parse - 1; /* Point to the '?' */
9546     int x_mod_count = 0;
9547
9548     PERL_ARGS_ASSERT_PARSE_LPAREN_QUESTION_FLAGS;
9549
9550     /* '^' as an initial flag sets certain defaults */
9551     if (UCHARAT(RExC_parse) == '^') {
9552         RExC_parse++;
9553         has_use_defaults = TRUE;
9554         STD_PMMOD_FLAGS_CLEAR(&RExC_flags);
9555         set_regex_charset(&RExC_flags, (RExC_utf8 || RExC_uni_semantics)
9556                                         ? REGEX_UNICODE_CHARSET
9557                                         : REGEX_DEPENDS_CHARSET);
9558     }
9559
9560     cs = get_regex_charset(RExC_flags);
9561     if (cs == REGEX_DEPENDS_CHARSET
9562         && (RExC_utf8 || RExC_uni_semantics))
9563     {
9564         cs = REGEX_UNICODE_CHARSET;
9565     }
9566
9567     while (*RExC_parse) {
9568         /* && strchr("iogcmsx", *RExC_parse) */
9569         /* (?g), (?gc) and (?o) are useless here
9570            and must be globally applied -- japhy */
9571         switch (*RExC_parse) {
9572
9573             /* Code for the imsxn flags */
9574             CASE_STD_PMMOD_FLAGS_PARSE_SET(flagsp, x_mod_count);
9575
9576             case LOCALE_PAT_MOD:
9577                 if (has_charset_modifier) {
9578                     goto excess_modifier;
9579                 }
9580                 else if (flagsp == &negflags) {
9581                     goto neg_modifier;
9582                 }
9583                 cs = REGEX_LOCALE_CHARSET;
9584                 has_charset_modifier = LOCALE_PAT_MOD;
9585                 break;
9586             case UNICODE_PAT_MOD:
9587                 if (has_charset_modifier) {
9588                     goto excess_modifier;
9589                 }
9590                 else if (flagsp == &negflags) {
9591                     goto neg_modifier;
9592                 }
9593                 cs = REGEX_UNICODE_CHARSET;
9594                 has_charset_modifier = UNICODE_PAT_MOD;
9595                 break;
9596             case ASCII_RESTRICT_PAT_MOD:
9597                 if (flagsp == &negflags) {
9598                     goto neg_modifier;
9599                 }
9600                 if (has_charset_modifier) {
9601                     if (cs != REGEX_ASCII_RESTRICTED_CHARSET) {
9602                         goto excess_modifier;
9603                     }
9604                     /* Doubled modifier implies more restricted */
9605                     cs = REGEX_ASCII_MORE_RESTRICTED_CHARSET;
9606                 }
9607                 else {
9608                     cs = REGEX_ASCII_RESTRICTED_CHARSET;
9609                 }
9610                 has_charset_modifier = ASCII_RESTRICT_PAT_MOD;
9611                 break;
9612             case DEPENDS_PAT_MOD:
9613                 if (has_use_defaults) {
9614                     goto fail_modifiers;
9615                 }
9616                 else if (flagsp == &negflags) {
9617                     goto neg_modifier;
9618                 }
9619                 else if (has_charset_modifier) {
9620                     goto excess_modifier;
9621                 }
9622
9623                 /* The dual charset means unicode semantics if the
9624                  * pattern (or target, not known until runtime) are
9625                  * utf8, or something in the pattern indicates unicode
9626                  * semantics */
9627                 cs = (RExC_utf8 || RExC_uni_semantics)
9628                      ? REGEX_UNICODE_CHARSET
9629                      : REGEX_DEPENDS_CHARSET;
9630                 has_charset_modifier = DEPENDS_PAT_MOD;
9631                 break;
9632               excess_modifier:
9633                 RExC_parse++;
9634                 if (has_charset_modifier == ASCII_RESTRICT_PAT_MOD) {
9635                     vFAIL2("Regexp modifier \"%c\" may appear a maximum of twice", ASCII_RESTRICT_PAT_MOD);
9636                 }
9637                 else if (has_charset_modifier == *(RExC_parse - 1)) {
9638                     vFAIL2("Regexp modifier \"%c\" may not appear twice",
9639                                         *(RExC_parse - 1));
9640                 }
9641                 else {
9642                     vFAIL3("Regexp modifiers \"%c\" and \"%c\" are mutually exclusive", has_charset_modifier, *(RExC_parse - 1));
9643                 }
9644                 NOT_REACHED; /*NOTREACHED*/
9645               neg_modifier:
9646                 RExC_parse++;
9647                 vFAIL2("Regexp modifier \"%c\" may not appear after the \"-\"",
9648                                     *(RExC_parse - 1));
9649                 NOT_REACHED; /*NOTREACHED*/
9650             case ONCE_PAT_MOD: /* 'o' */
9651             case GLOBAL_PAT_MOD: /* 'g' */
9652                 if (PASS2 && ckWARN(WARN_REGEXP)) {
9653                     const I32 wflagbit = *RExC_parse == 'o'
9654                                          ? WASTED_O
9655                                          : WASTED_G;
9656                     if (! (wastedflags & wflagbit) ) {
9657                         wastedflags |= wflagbit;
9658                         /* diag_listed_as: Useless (?-%s) - don't use /%s modifier in regex; marked by <-- HERE in m/%s/ */
9659                         vWARN5(
9660                             RExC_parse + 1,
9661                             "Useless (%s%c) - %suse /%c modifier",
9662                             flagsp == &negflags ? "?-" : "?",
9663                             *RExC_parse,
9664                             flagsp == &negflags ? "don't " : "",
9665                             *RExC_parse
9666                         );
9667                     }
9668                 }
9669                 break;
9670
9671             case CONTINUE_PAT_MOD: /* 'c' */
9672                 if (PASS2 && ckWARN(WARN_REGEXP)) {
9673                     if (! (wastedflags & WASTED_C) ) {
9674                         wastedflags |= WASTED_GC;
9675                         /* diag_listed_as: Useless (?-%s) - don't use /%s modifier in regex; marked by <-- HERE in m/%s/ */
9676                         vWARN3(
9677                             RExC_parse + 1,
9678                             "Useless (%sc) - %suse /gc modifier",
9679                             flagsp == &negflags ? "?-" : "?",
9680                             flagsp == &negflags ? "don't " : ""
9681                         );
9682                     }
9683                 }
9684                 break;
9685             case KEEPCOPY_PAT_MOD: /* 'p' */
9686                 if (flagsp == &negflags) {
9687                     if (PASS2)
9688                         ckWARNreg(RExC_parse + 1,"Useless use of (?-p)");
9689                 } else {
9690                     *flagsp |= RXf_PMf_KEEPCOPY;
9691                 }
9692                 break;
9693             case '-':
9694                 /* A flag is a default iff it is following a minus, so
9695                  * if there is a minus, it means will be trying to
9696                  * re-specify a default which is an error */
9697                 if (has_use_defaults || flagsp == &negflags) {
9698                     goto fail_modifiers;
9699                 }
9700                 flagsp = &negflags;
9701                 wastedflags = 0;  /* reset so (?g-c) warns twice */
9702                 break;
9703             case ':':
9704             case ')':
9705                 RExC_flags |= posflags;
9706                 RExC_flags &= ~negflags;
9707                 set_regex_charset(&RExC_flags, cs);
9708                 if (RExC_flags & RXf_PMf_FOLD) {
9709                     RExC_contains_i = 1;
9710                 }
9711                 if (PASS2) {
9712                     STD_PMMOD_FLAGS_PARSE_X_WARN(x_mod_count);
9713                 }
9714                 return;
9715                 /*NOTREACHED*/
9716             default:
9717               fail_modifiers:
9718                 RExC_parse += SKIP_IF_CHAR(RExC_parse);
9719                 /* diag_listed_as: Sequence (?%s...) not recognized in regex; marked by <-- HERE in m/%s/ */
9720                 vFAIL2utf8f("Sequence (%"UTF8f"...) not recognized",
9721                       UTF8fARG(UTF, RExC_parse-seqstart, seqstart));
9722                 NOT_REACHED; /*NOTREACHED*/
9723         }
9724
9725         ++RExC_parse;
9726     }
9727
9728     if (PASS2) {
9729         STD_PMMOD_FLAGS_PARSE_X_WARN(x_mod_count);
9730     }
9731 }
9732
9733 /*
9734  - reg - regular expression, i.e. main body or parenthesized thing
9735  *
9736  * Caller must absorb opening parenthesis.
9737  *
9738  * Combining parenthesis handling with the base level of regular expression
9739  * is a trifle forced, but the need to tie the tails of the branches to what
9740  * follows makes it hard to avoid.
9741  */
9742 #define REGTAIL(x,y,z) regtail((x),(y),(z),depth+1)
9743 #ifdef DEBUGGING
9744 #define REGTAIL_STUDY(x,y,z) regtail_study((x),(y),(z),depth+1)
9745 #else
9746 #define REGTAIL_STUDY(x,y,z) regtail((x),(y),(z),depth+1)
9747 #endif
9748
9749 /* Returns NULL, setting *flagp to TRYAGAIN at the end of (?) that only sets
9750    flags. Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan
9751    needs to be restarted.
9752    Otherwise would only return NULL if regbranch() returns NULL, which
9753    cannot happen.  */
9754 STATIC regnode *
9755 S_reg(pTHX_ RExC_state_t *pRExC_state, I32 paren, I32 *flagp,U32 depth)
9756     /* paren: Parenthesized? 0=top; 1,2=inside '(': changed to letter.
9757      * 2 is like 1, but indicates that nextchar() has been called to advance
9758      * RExC_parse beyond the '('.  Things like '(?' are indivisible tokens, and
9759      * this flag alerts us to the need to check for that */
9760 {
9761     regnode *ret;               /* Will be the head of the group. */
9762     regnode *br;
9763     regnode *lastbr;
9764     regnode *ender = NULL;
9765     I32 parno = 0;
9766     I32 flags;
9767     U32 oregflags = RExC_flags;
9768     bool have_branch = 0;
9769     bool is_open = 0;
9770     I32 freeze_paren = 0;
9771     I32 after_freeze = 0;
9772     I32 num; /* numeric backreferences */
9773
9774     char * parse_start = RExC_parse; /* MJD */
9775     char * const oregcomp_parse = RExC_parse;
9776
9777     GET_RE_DEBUG_FLAGS_DECL;
9778
9779     PERL_ARGS_ASSERT_REG;
9780     DEBUG_PARSE("reg ");
9781
9782     *flagp = 0;                         /* Tentatively. */
9783
9784
9785     /* Make an OPEN node, if parenthesized. */
9786     if (paren) {
9787
9788         /* Under /x, space and comments can be gobbled up between the '(' and
9789          * here (if paren ==2).  The forms '(*VERB' and '(?...' disallow such
9790          * intervening space, as the sequence is a token, and a token should be
9791          * indivisible */
9792         bool has_intervening_patws = paren == 2 && *(RExC_parse - 1) != '(';
9793
9794         if ( *RExC_parse == '*') { /* (*VERB:ARG) */
9795             char *start_verb = RExC_parse;
9796             STRLEN verb_len = 0;
9797             char *start_arg = NULL;
9798             unsigned char op = 0;
9799             int argok = 1;
9800             int internal_argval = 0; /* internal_argval is only useful if
9801                                         !argok */
9802
9803             if (has_intervening_patws) {
9804                 RExC_parse++;
9805                 vFAIL("In '(*VERB...)', the '(' and '*' must be adjacent");
9806             }
9807             while ( *RExC_parse && *RExC_parse != ')' ) {
9808                 if ( *RExC_parse == ':' ) {
9809                     start_arg = RExC_parse + 1;
9810                     break;
9811                 }
9812                 RExC_parse++;
9813             }
9814             ++start_verb;
9815             verb_len = RExC_parse - start_verb;
9816             if ( start_arg ) {
9817                 RExC_parse++;
9818                 while ( *RExC_parse && *RExC_parse != ')' )
9819                     RExC_parse++;
9820                 if ( *RExC_parse != ')' )
9821                     vFAIL("Unterminated verb pattern argument");
9822                 if ( RExC_parse == start_arg )
9823                     start_arg = NULL;
9824             } else {
9825                 if ( *RExC_parse != ')' )
9826                     vFAIL("Unterminated verb pattern");
9827             }
9828
9829             switch ( *start_verb ) {
9830             case 'A':  /* (*ACCEPT) */
9831                 if ( memEQs(start_verb,verb_len,"ACCEPT") ) {
9832                     op = ACCEPT;
9833                     internal_argval = RExC_nestroot;
9834                 }
9835                 break;
9836             case 'C':  /* (*COMMIT) */
9837                 if ( memEQs(start_verb,verb_len,"COMMIT") )
9838                     op = COMMIT;
9839                 break;
9840             case 'F':  /* (*FAIL) */
9841                 if ( verb_len==1 || memEQs(start_verb,verb_len,"FAIL") ) {
9842                     op = OPFAIL;
9843                     argok = 0;
9844                 }
9845                 break;
9846             case ':':  /* (*:NAME) */
9847             case 'M':  /* (*MARK:NAME) */
9848                 if ( verb_len==0 || memEQs(start_verb,verb_len,"MARK") ) {
9849                     op = MARKPOINT;
9850                     argok = -1;
9851                 }
9852                 break;
9853             case 'P':  /* (*PRUNE) */
9854                 if ( memEQs(start_verb,verb_len,"PRUNE") )
9855                     op = PRUNE;
9856                 break;
9857             case 'S':   /* (*SKIP) */
9858                 if ( memEQs(start_verb,verb_len,"SKIP") )
9859                     op = SKIP;
9860                 break;
9861             case 'T':  /* (*THEN) */
9862                 /* [19:06] <TimToady> :: is then */
9863                 if ( memEQs(start_verb,verb_len,"THEN") ) {
9864                     op = CUTGROUP;
9865                     RExC_seen |= REG_CUTGROUP_SEEN;
9866                 }
9867                 break;
9868             }
9869             if ( ! op ) {
9870                 RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
9871                 vFAIL2utf8f(
9872                     "Unknown verb pattern '%"UTF8f"'",
9873                     UTF8fARG(UTF, verb_len, start_verb));
9874             }
9875             if ( argok ) {
9876                 if ( start_arg && internal_argval ) {
9877                     vFAIL3("Verb pattern '%.*s' may not have an argument",
9878                         verb_len, start_verb);
9879                 } else if ( argok < 0 && !start_arg ) {
9880                     vFAIL3("Verb pattern '%.*s' has a mandatory argument",
9881                         verb_len, start_verb);
9882                 } else {
9883                     ret = reganode(pRExC_state, op, internal_argval);
9884                     if ( ! internal_argval && ! SIZE_ONLY ) {
9885                         if (start_arg) {
9886                             SV *sv = newSVpvn( start_arg,
9887                                                RExC_parse - start_arg);
9888                             ARG(ret) = add_data( pRExC_state,
9889                                                  STR_WITH_LEN("S"));
9890                             RExC_rxi->data->data[ARG(ret)]=(void*)sv;
9891                             ret->flags = 0;
9892                         } else {
9893                             ret->flags = 1;
9894                         }
9895                     }
9896                 }
9897                 if (!internal_argval)
9898                     RExC_seen |= REG_VERBARG_SEEN;
9899             } else if ( start_arg ) {
9900                 vFAIL3("Verb pattern '%.*s' may not have an argument",
9901                         verb_len, start_verb);
9902             } else {
9903                 ret = reg_node(pRExC_state, op);
9904             }
9905             nextchar(pRExC_state);
9906             return ret;
9907         }
9908         else if (*RExC_parse == '?') { /* (?...) */
9909             bool is_logical = 0;
9910             const char * const seqstart = RExC_parse;
9911             const char * endptr;
9912             if (has_intervening_patws) {
9913                 RExC_parse++;
9914                 vFAIL("In '(?...)', the '(' and '?' must be adjacent");
9915             }
9916
9917             RExC_parse++;
9918             paren = *RExC_parse++;
9919             ret = NULL;                 /* For look-ahead/behind. */
9920             switch (paren) {
9921
9922             case 'P':   /* (?P...) variants for those used to PCRE/Python */
9923                 paren = *RExC_parse++;
9924                 if ( paren == '<')         /* (?P<...>) named capture */
9925                     goto named_capture;
9926                 else if (paren == '>') {   /* (?P>name) named recursion */
9927                     goto named_recursion;
9928                 }
9929                 else if (paren == '=') {   /* (?P=...)  named backref */
9930                     /* this pretty much dupes the code for \k<NAME> in
9931                      * regatom(), if you change this make sure you change that
9932                      * */
9933                     char* name_start = RExC_parse;
9934                     U32 num = 0;
9935                     SV *sv_dat = reg_scan_name(pRExC_state,
9936                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
9937                     if (RExC_parse == name_start || *RExC_parse != ')')
9938                         /* diag_listed_as: Sequence ?P=... not terminated in regex; marked by <-- HERE in m/%s/ */
9939                         vFAIL2("Sequence %.3s... not terminated",parse_start);
9940
9941                     if (!SIZE_ONLY) {
9942                         num = add_data( pRExC_state, STR_WITH_LEN("S"));
9943                         RExC_rxi->data->data[num]=(void*)sv_dat;
9944                         SvREFCNT_inc_simple_void(sv_dat);
9945                     }
9946                     RExC_sawback = 1;
9947                     ret = reganode(pRExC_state,
9948                                    ((! FOLD)
9949                                      ? NREF
9950                                      : (ASCII_FOLD_RESTRICTED)
9951                                        ? NREFFA
9952                                        : (AT_LEAST_UNI_SEMANTICS)
9953                                          ? NREFFU
9954                                          : (LOC)
9955                                            ? NREFFL
9956                                            : NREFF),
9957                                     num);
9958                     *flagp |= HASWIDTH;
9959
9960                     Set_Node_Offset(ret, parse_start+1);
9961                     Set_Node_Cur_Length(ret, parse_start);
9962
9963                     nextchar(pRExC_state);
9964                     return ret;
9965                 }
9966                 --RExC_parse;
9967                 RExC_parse += SKIP_IF_CHAR(RExC_parse);
9968                 /* diag_listed_as: Sequence (?%s...) not recognized in regex; marked by <-- HERE in m/%s/ */
9969                 vFAIL3("Sequence (%.*s...) not recognized",
9970                                 RExC_parse-seqstart, seqstart);
9971                 NOT_REACHED; /*NOTREACHED*/
9972             case '<':           /* (?<...) */
9973                 if (*RExC_parse == '!')
9974                     paren = ',';
9975                 else if (*RExC_parse != '=')
9976               named_capture:
9977                 {               /* (?<...>) */
9978                     char *name_start;
9979                     SV *svname;
9980                     paren= '>';
9981             case '\'':          /* (?'...') */
9982                     name_start= RExC_parse;
9983                     svname = reg_scan_name(pRExC_state,
9984                         SIZE_ONLY    /* reverse test from the others */
9985                         ? REG_RSN_RETURN_NAME
9986                         : REG_RSN_RETURN_NULL);
9987                     if (RExC_parse == name_start || *RExC_parse != paren)
9988                         vFAIL2("Sequence (?%c... not terminated",
9989                             paren=='>' ? '<' : paren);
9990                     if (SIZE_ONLY) {
9991                         HE *he_str;
9992                         SV *sv_dat = NULL;
9993                         if (!svname) /* shouldn't happen */
9994                             Perl_croak(aTHX_
9995                                 "panic: reg_scan_name returned NULL");
9996                         if (!RExC_paren_names) {
9997                             RExC_paren_names= newHV();
9998                             sv_2mortal(MUTABLE_SV(RExC_paren_names));
9999 #ifdef DEBUGGING
10000                             RExC_paren_name_list= newAV();
10001                             sv_2mortal(MUTABLE_SV(RExC_paren_name_list));
10002 #endif
10003                         }
10004                         he_str = hv_fetch_ent( RExC_paren_names, svname, 1, 0 );
10005                         if ( he_str )
10006                             sv_dat = HeVAL(he_str);
10007                         if ( ! sv_dat ) {
10008                             /* croak baby croak */
10009                             Perl_croak(aTHX_
10010                                 "panic: paren_name hash element allocation failed");
10011                         } else if ( SvPOK(sv_dat) ) {
10012                             /* (?|...) can mean we have dupes so scan to check
10013                                its already been stored. Maybe a flag indicating
10014                                we are inside such a construct would be useful,
10015                                but the arrays are likely to be quite small, so
10016                                for now we punt -- dmq */
10017                             IV count = SvIV(sv_dat);
10018                             I32 *pv = (I32*)SvPVX(sv_dat);
10019                             IV i;
10020                             for ( i = 0 ; i < count ; i++ ) {
10021                                 if ( pv[i] == RExC_npar ) {
10022                                     count = 0;
10023                                     break;
10024                                 }
10025                             }
10026                             if ( count ) {
10027                                 pv = (I32*)SvGROW(sv_dat,
10028                                                 SvCUR(sv_dat) + sizeof(I32)+1);
10029                                 SvCUR_set(sv_dat, SvCUR(sv_dat) + sizeof(I32));
10030                                 pv[count] = RExC_npar;
10031                                 SvIV_set(sv_dat, SvIVX(sv_dat) + 1);
10032                             }
10033                         } else {
10034                             (void)SvUPGRADE(sv_dat,SVt_PVNV);
10035                             sv_setpvn(sv_dat, (char *)&(RExC_npar),
10036                                                                 sizeof(I32));
10037                             SvIOK_on(sv_dat);
10038                             SvIV_set(sv_dat, 1);
10039                         }
10040 #ifdef DEBUGGING
10041                         /* Yes this does cause a memory leak in debugging Perls
10042                          * */
10043                         if (!av_store(RExC_paren_name_list,
10044                                       RExC_npar, SvREFCNT_inc(svname)))
10045                             SvREFCNT_dec_NN(svname);
10046 #endif
10047
10048                         /*sv_dump(sv_dat);*/
10049                     }
10050                     nextchar(pRExC_state);
10051                     paren = 1;
10052                     goto capturing_parens;
10053                 }
10054                 RExC_seen |= REG_LOOKBEHIND_SEEN;
10055                 RExC_in_lookbehind++;
10056                 RExC_parse++;
10057                 /* FALLTHROUGH */
10058             case '=':           /* (?=...) */
10059                 RExC_seen_zerolen++;
10060                 break;
10061             case '!':           /* (?!...) */
10062                 RExC_seen_zerolen++;
10063                 /* check if we're really just a "FAIL" assertion */
10064                 --RExC_parse;
10065                 nextchar(pRExC_state);
10066                 if (*RExC_parse == ')') {
10067                     ret=reg_node(pRExC_state, OPFAIL);
10068                     nextchar(pRExC_state);
10069                     return ret;
10070                 }
10071                 break;
10072             case '|':           /* (?|...) */
10073                 /* branch reset, behave like a (?:...) except that
10074                    buffers in alternations share the same numbers */
10075                 paren = ':';
10076                 after_freeze = freeze_paren = RExC_npar;
10077                 break;
10078             case ':':           /* (?:...) */
10079             case '>':           /* (?>...) */
10080                 break;
10081             case '$':           /* (?$...) */
10082             case '@':           /* (?@...) */
10083                 vFAIL2("Sequence (?%c...) not implemented", (int)paren);
10084                 break;
10085             case '0' :           /* (?0) */
10086             case 'R' :           /* (?R) */
10087                 if (*RExC_parse != ')')
10088                     FAIL("Sequence (?R) not terminated");
10089                 ret = reg_node(pRExC_state, GOSTART);
10090                     RExC_seen |= REG_GOSTART_SEEN;
10091                 *flagp |= POSTPONED;
10092                 nextchar(pRExC_state);
10093                 return ret;
10094                 /*notreached*/
10095             /* named and numeric backreferences */
10096             case '&':            /* (?&NAME) */
10097                 parse_start = RExC_parse - 1;
10098               named_recursion:
10099                 {
10100                     SV *sv_dat = reg_scan_name(pRExC_state,
10101                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
10102                      num = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
10103                 }
10104                 if (RExC_parse == RExC_end || *RExC_parse != ')')
10105                     vFAIL("Sequence (?&... not terminated");
10106                 goto gen_recurse_regop;
10107                 /* NOTREACHED */
10108             case '+':
10109                 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
10110                     RExC_parse++;
10111                     vFAIL("Illegal pattern");
10112                 }
10113                 goto parse_recursion;
10114                 /* NOTREACHED*/
10115             case '-': /* (?-1) */
10116                 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
10117                     RExC_parse--; /* rewind to let it be handled later */
10118                     goto parse_flags;
10119                 }
10120                 /* FALLTHROUGH */
10121             case '1': case '2': case '3': case '4': /* (?1) */
10122             case '5': case '6': case '7': case '8': case '9':
10123                 RExC_parse--;
10124               parse_recursion:
10125                 {
10126                     bool is_neg = FALSE;
10127                     UV unum;
10128                     parse_start = RExC_parse - 1; /* MJD */
10129                     if (*RExC_parse == '-') {
10130                         RExC_parse++;
10131                         is_neg = TRUE;
10132                     }
10133                     if (grok_atoUV(RExC_parse, &unum, &endptr)
10134                         && unum <= I32_MAX
10135                     ) {
10136                         num = (I32)unum;
10137                         RExC_parse = (char*)endptr;
10138                     } else
10139                         num = I32_MAX;
10140                     if (is_neg) {
10141                         /* Some limit for num? */
10142                         num = -num;
10143                     }
10144                 }
10145                 if (*RExC_parse!=')')
10146                     vFAIL("Expecting close bracket");
10147
10148               gen_recurse_regop:
10149                 if ( paren == '-' ) {
10150                     /*
10151                     Diagram of capture buffer numbering.
10152                     Top line is the normal capture buffer numbers
10153                     Bottom line is the negative indexing as from
10154                     the X (the (?-2))
10155
10156                     +   1 2    3 4 5 X          6 7
10157                        /(a(x)y)(a(b(c(?-2)d)e)f)(g(h))/
10158                     -   5 4    3 2 1 X          x x
10159
10160                     */
10161                     num = RExC_npar + num;
10162                     if (num < 1)  {
10163                         RExC_parse++;
10164                         vFAIL("Reference to nonexistent group");
10165                     }
10166                 } else if ( paren == '+' ) {
10167                     num = RExC_npar + num - 1;
10168                 }
10169
10170                 ret = reg2Lanode(pRExC_state, GOSUB, num, RExC_recurse_count);
10171                 if (!SIZE_ONLY) {
10172                     if (num > (I32)RExC_rx->nparens) {
10173                         RExC_parse++;
10174                         vFAIL("Reference to nonexistent group");
10175                     }
10176                     RExC_recurse_count++;
10177                     DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
10178                         "%*s%*s Recurse #%"UVuf" to %"IVdf"\n",
10179                               22, "|    |", (int)(depth * 2 + 1), "",
10180                               (UV)ARG(ret), (IV)ARG2L(ret)));
10181                 }
10182                 RExC_seen |= REG_RECURSE_SEEN;
10183                 Set_Node_Length(ret, 1 + regarglen[OP(ret)]); /* MJD */
10184                 Set_Node_Offset(ret, parse_start); /* MJD */
10185
10186                 *flagp |= POSTPONED;
10187                 nextchar(pRExC_state);
10188                 return ret;
10189
10190             /* NOTREACHED */
10191
10192             case '?':           /* (??...) */
10193                 is_logical = 1;
10194                 if (*RExC_parse != '{') {
10195                     RExC_parse += SKIP_IF_CHAR(RExC_parse);
10196                     /* diag_listed_as: Sequence (?%s...) not recognized in regex; marked by <-- HERE in m/%s/ */
10197                     vFAIL2utf8f(
10198                         "Sequence (%"UTF8f"...) not recognized",
10199                         UTF8fARG(UTF, RExC_parse-seqstart, seqstart));
10200                     NOT_REACHED; /*NOTREACHED*/
10201                 }
10202                 *flagp |= POSTPONED;
10203                 paren = *RExC_parse++;
10204                 /* FALLTHROUGH */
10205             case '{':           /* (?{...}) */
10206             {
10207                 U32 n = 0;
10208                 struct reg_code_block *cb;
10209
10210                 RExC_seen_zerolen++;
10211
10212                 if (   !pRExC_state->num_code_blocks
10213                     || pRExC_state->code_index >= pRExC_state->num_code_blocks
10214                     || pRExC_state->code_blocks[pRExC_state->code_index].start
10215                         != (STRLEN)((RExC_parse -3 - (is_logical ? 1 : 0))
10216                             - RExC_start)
10217                 ) {
10218                     if (RExC_pm_flags & PMf_USE_RE_EVAL)
10219                         FAIL("panic: Sequence (?{...}): no code block found\n");
10220                     FAIL("Eval-group not allowed at runtime, use re 'eval'");
10221                 }
10222                 /* this is a pre-compiled code block (?{...}) */
10223                 cb = &pRExC_state->code_blocks[pRExC_state->code_index];
10224                 RExC_parse = RExC_start + cb->end;
10225                 if (!SIZE_ONLY) {
10226                     OP *o = cb->block;
10227                     if (cb->src_regex) {
10228                         n = add_data(pRExC_state, STR_WITH_LEN("rl"));
10229                         RExC_rxi->data->data[n] =
10230                             (void*)SvREFCNT_inc((SV*)cb->src_regex);
10231                         RExC_rxi->data->data[n+1] = (void*)o;
10232                     }
10233                     else {
10234                         n = add_data(pRExC_state,
10235                                (RExC_pm_flags & PMf_HAS_CV) ? "L" : "l", 1);
10236                         RExC_rxi->data->data[n] = (void*)o;
10237                     }
10238                 }
10239                 pRExC_state->code_index++;
10240                 nextchar(pRExC_state);
10241
10242                 if (is_logical) {
10243                     regnode *eval;
10244                     ret = reg_node(pRExC_state, LOGICAL);
10245
10246                     eval = reg2Lanode(pRExC_state, EVAL,
10247                                        n,
10248
10249                                        /* for later propagation into (??{})
10250                                         * return value */
10251                                        RExC_flags & RXf_PMf_COMPILETIME
10252                                       );
10253                     if (!SIZE_ONLY) {
10254                         ret->flags = 2;
10255                     }
10256                     REGTAIL(pRExC_state, ret, eval);
10257                     /* deal with the length of this later - MJD */
10258                     return ret;
10259                 }
10260                 ret = reg2Lanode(pRExC_state, EVAL, n, 0);
10261                 Set_Node_Length(ret, RExC_parse - parse_start + 1);
10262                 Set_Node_Offset(ret, parse_start);
10263                 return ret;
10264             }
10265             case '(':           /* (?(?{...})...) and (?(?=...)...) */
10266             {
10267                 int is_define= 0;
10268                 const int DEFINE_len = sizeof("DEFINE") - 1;
10269                 if (RExC_parse[0] == '?') {        /* (?(?...)) */
10270                     if (RExC_parse[1] == '=' || RExC_parse[1] == '!'
10271                         || RExC_parse[1] == '<'
10272                         || RExC_parse[1] == '{') { /* Lookahead or eval. */
10273                         I32 flag;
10274                         regnode *tail;
10275
10276                         ret = reg_node(pRExC_state, LOGICAL);
10277                         if (!SIZE_ONLY)
10278                             ret->flags = 1;
10279
10280                         tail = reg(pRExC_state, 1, &flag, depth+1);
10281                         if (flag & RESTART_UTF8) {
10282                             *flagp = RESTART_UTF8;
10283                             return NULL;
10284                         }
10285                         REGTAIL(pRExC_state, ret, tail);
10286                         goto insert_if;
10287                     }
10288                     /* Fall through to ‘Unknown switch condition’ at the
10289                        end of the if/else chain. */
10290                 }
10291                 else if ( RExC_parse[0] == '<'     /* (?(<NAME>)...) */
10292                          || RExC_parse[0] == '\'' ) /* (?('NAME')...) */
10293                 {
10294                     char ch = RExC_parse[0] == '<' ? '>' : '\'';
10295                     char *name_start= RExC_parse++;
10296                     U32 num = 0;
10297                     SV *sv_dat=reg_scan_name(pRExC_state,
10298                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
10299                     if (RExC_parse == name_start || *RExC_parse != ch)
10300                         vFAIL2("Sequence (?(%c... not terminated",
10301                             (ch == '>' ? '<' : ch));
10302                     RExC_parse++;
10303                     if (!SIZE_ONLY) {
10304                         num = add_data( pRExC_state, STR_WITH_LEN("S"));
10305                         RExC_rxi->data->data[num]=(void*)sv_dat;
10306                         SvREFCNT_inc_simple_void(sv_dat);
10307                     }
10308                     ret = reganode(pRExC_state,NGROUPP,num);
10309                     goto insert_if_check_paren;
10310                 }
10311                 else if (RExC_end - RExC_parse >= DEFINE_len
10312                         && strnEQ(RExC_parse, "DEFINE", DEFINE_len))
10313                 {
10314                     ret = reganode(pRExC_state,DEFINEP,0);
10315                     RExC_parse += DEFINE_len;
10316                     is_define = 1;
10317                     goto insert_if_check_paren;
10318                 }
10319                 else if (RExC_parse[0] == 'R') {
10320                     RExC_parse++;
10321                     parno = 0;
10322                     if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
10323                         UV uv;
10324                         if (grok_atoUV(RExC_parse, &uv, &endptr)
10325                             && uv <= I32_MAX
10326                         ) {
10327                             parno = (I32)uv;
10328                             RExC_parse = (char*)endptr;
10329                         }
10330                         /* else "Switch condition not recognized" below */
10331                     } else if (RExC_parse[0] == '&') {
10332                         SV *sv_dat;
10333                         RExC_parse++;
10334                         sv_dat = reg_scan_name(pRExC_state,
10335                             SIZE_ONLY
10336                             ? REG_RSN_RETURN_NULL
10337                             : REG_RSN_RETURN_DATA);
10338                         parno = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
10339                     }
10340                     ret = reganode(pRExC_state,INSUBP,parno);
10341                     goto insert_if_check_paren;
10342                 }
10343                 else if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
10344                     /* (?(1)...) */
10345                     char c;
10346                     char *tmp;
10347                     UV uv;
10348                     if (grok_atoUV(RExC_parse, &uv, &endptr)
10349                         && uv <= I32_MAX
10350                     ) {
10351                         parno = (I32)uv;
10352                         RExC_parse = (char*)endptr;
10353                     }
10354                     /* XXX else what? */
10355                     ret = reganode(pRExC_state, GROUPP, parno);
10356
10357                  insert_if_check_paren:
10358                     if (*(tmp = nextchar(pRExC_state)) != ')') {
10359                         /* nextchar also skips comments, so undo its work
10360                          * and skip over the the next character.
10361                          */
10362                         RExC_parse = tmp;
10363                         RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
10364                         vFAIL("Switch condition not recognized");
10365                     }
10366                   insert_if:
10367                     REGTAIL(pRExC_state, ret, reganode(pRExC_state, IFTHEN, 0));
10368                     br = regbranch(pRExC_state, &flags, 1,depth+1);
10369                     if (br == NULL) {
10370                         if (flags & RESTART_UTF8) {
10371                             *flagp = RESTART_UTF8;
10372                             return NULL;
10373                         }
10374                         FAIL2("panic: regbranch returned NULL, flags=%#"UVxf"",
10375                               (UV) flags);
10376                     } else
10377                         REGTAIL(pRExC_state, br, reganode(pRExC_state,
10378                                                           LONGJMP, 0));
10379                     c = *nextchar(pRExC_state);
10380                     if (flags&HASWIDTH)
10381                         *flagp |= HASWIDTH;
10382                     if (c == '|') {
10383                         if (is_define)
10384                             vFAIL("(?(DEFINE)....) does not allow branches");
10385
10386                         /* Fake one for optimizer.  */
10387                         lastbr = reganode(pRExC_state, IFTHEN, 0);
10388
10389                         if (!regbranch(pRExC_state, &flags, 1,depth+1)) {
10390                             if (flags & RESTART_UTF8) {
10391                                 *flagp = RESTART_UTF8;
10392                                 return NULL;
10393                             }
10394                             FAIL2("panic: regbranch returned NULL, flags=%#"UVxf"",
10395                                   (UV) flags);
10396                         }
10397                         REGTAIL(pRExC_state, ret, lastbr);
10398                         if (flags&HASWIDTH)
10399                             *flagp |= HASWIDTH;
10400                         c = *nextchar(pRExC_state);
10401                     }
10402                     else
10403                         lastbr = NULL;
10404                     if (c != ')') {
10405                         if (RExC_parse>RExC_end)
10406                             vFAIL("Switch (?(condition)... not terminated");
10407                         else
10408                             vFAIL("Switch (?(condition)... contains too many branches");
10409                     }
10410                     ender = reg_node(pRExC_state, TAIL);
10411                     REGTAIL(pRExC_state, br, ender);
10412                     if (lastbr) {
10413                         REGTAIL(pRExC_state, lastbr, ender);
10414                         REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender);
10415                     }
10416                     else
10417                         REGTAIL(pRExC_state, ret, ender);
10418                     RExC_size++; /* XXX WHY do we need this?!!
10419                                     For large programs it seems to be required
10420                                     but I can't figure out why. -- dmq*/
10421                     return ret;
10422                 }
10423                 RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
10424                 vFAIL("Unknown switch condition (?(...))");
10425             }
10426             case '[':           /* (?[ ... ]) */
10427                 return handle_regex_sets(pRExC_state, NULL, flagp, depth,
10428                                          oregcomp_parse);
10429             case 0:
10430                 RExC_parse--; /* for vFAIL to print correctly */
10431                 vFAIL("Sequence (? incomplete");
10432                 break;
10433             default: /* e.g., (?i) */
10434                 --RExC_parse;
10435               parse_flags:
10436                 parse_lparen_question_flags(pRExC_state);
10437                 if (UCHARAT(RExC_parse) != ':') {
10438                     if (*RExC_parse)
10439                         nextchar(pRExC_state);
10440                     *flagp = TRYAGAIN;
10441                     return NULL;
10442                 }
10443                 paren = ':';
10444                 nextchar(pRExC_state);
10445                 ret = NULL;
10446                 goto parse_rest;
10447             } /* end switch */
10448         }
10449         else if (!(RExC_flags & RXf_PMf_NOCAPTURE)) {   /* (...) */
10450           capturing_parens:
10451             parno = RExC_npar;
10452             RExC_npar++;
10453
10454             ret = reganode(pRExC_state, OPEN, parno);
10455             if (!SIZE_ONLY ){
10456                 if (!RExC_nestroot)
10457                     RExC_nestroot = parno;
10458                 if (RExC_seen & REG_RECURSE_SEEN
10459                     && !RExC_open_parens[parno-1])
10460                 {
10461                     DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
10462                         "%*s%*s Setting open paren #%"IVdf" to %d\n",
10463                         22, "|    |", (int)(depth * 2 + 1), "",
10464                         (IV)parno, REG_NODE_NUM(ret)));
10465                     RExC_open_parens[parno-1]= ret;
10466                 }
10467             }
10468             Set_Node_Length(ret, 1); /* MJD */
10469             Set_Node_Offset(ret, RExC_parse); /* MJD */
10470             is_open = 1;
10471         } else {
10472             /* with RXf_PMf_NOCAPTURE treat (...) as (?:...) */
10473             paren = ':';
10474             ret = NULL;
10475         }
10476     }
10477     else                        /* ! paren */
10478         ret = NULL;
10479
10480    parse_rest:
10481     /* Pick up the branches, linking them together. */
10482     parse_start = RExC_parse;   /* MJD */
10483     br = regbranch(pRExC_state, &flags, 1,depth+1);
10484
10485     /*     branch_len = (paren != 0); */
10486
10487     if (br == NULL) {
10488         if (flags & RESTART_UTF8) {
10489             *flagp = RESTART_UTF8;
10490             return NULL;
10491         }
10492         FAIL2("panic: regbranch returned NULL, flags=%#"UVxf"", (UV) flags);
10493     }
10494     if (*RExC_parse == '|') {
10495         if (!SIZE_ONLY && RExC_extralen) {
10496             reginsert(pRExC_state, BRANCHJ, br, depth+1);
10497         }
10498         else {                  /* MJD */
10499             reginsert(pRExC_state, BRANCH, br, depth+1);
10500             Set_Node_Length(br, paren != 0);
10501             Set_Node_Offset_To_R(br-RExC_emit_start, parse_start-RExC_start);
10502         }
10503         have_branch = 1;
10504         if (SIZE_ONLY)
10505             RExC_extralen += 1;         /* For BRANCHJ-BRANCH. */
10506     }
10507     else if (paren == ':') {
10508         *flagp |= flags&SIMPLE;
10509     }
10510     if (is_open) {                              /* Starts with OPEN. */
10511         REGTAIL(pRExC_state, ret, br);          /* OPEN -> first. */
10512     }
10513     else if (paren != '?')              /* Not Conditional */
10514         ret = br;
10515     *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
10516     lastbr = br;
10517     while (*RExC_parse == '|') {
10518         if (!SIZE_ONLY && RExC_extralen) {
10519             ender = reganode(pRExC_state, LONGJMP,0);
10520
10521             /* Append to the previous. */
10522             REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender);
10523         }
10524         if (SIZE_ONLY)
10525             RExC_extralen += 2;         /* Account for LONGJMP. */
10526         nextchar(pRExC_state);
10527         if (freeze_paren) {
10528             if (RExC_npar > after_freeze)
10529                 after_freeze = RExC_npar;
10530             RExC_npar = freeze_paren;
10531         }
10532         br = regbranch(pRExC_state, &flags, 0, depth+1);
10533
10534         if (br == NULL) {
10535             if (flags & RESTART_UTF8) {
10536                 *flagp = RESTART_UTF8;
10537                 return NULL;
10538             }
10539             FAIL2("panic: regbranch returned NULL, flags=%#"UVxf"", (UV) flags);
10540         }
10541         REGTAIL(pRExC_state, lastbr, br);               /* BRANCH -> BRANCH. */
10542         lastbr = br;
10543         *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
10544     }
10545
10546     if (have_branch || paren != ':') {
10547         /* Make a closing node, and hook it on the end. */
10548         switch (paren) {
10549         case ':':
10550             ender = reg_node(pRExC_state, TAIL);
10551             break;
10552         case 1: case 2:
10553             ender = reganode(pRExC_state, CLOSE, parno);
10554             if (!SIZE_ONLY && RExC_seen & REG_RECURSE_SEEN) {
10555                 DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
10556                         "%*s%*s Setting close paren #%"IVdf" to %d\n",
10557                         22, "|    |", (int)(depth * 2 + 1), "", (IV)parno, REG_NODE_NUM(ender)));
10558                 RExC_close_parens[parno-1]= ender;
10559                 if (RExC_nestroot == parno)
10560                     RExC_nestroot = 0;
10561             }
10562             Set_Node_Offset(ender,RExC_parse+1); /* MJD */
10563             Set_Node_Length(ender,1); /* MJD */
10564             break;
10565         case '<':
10566         case ',':
10567         case '=':
10568         case '!':
10569             *flagp &= ~HASWIDTH;
10570             /* FALLTHROUGH */
10571         case '>':
10572             ender = reg_node(pRExC_state, SUCCEED);
10573             break;
10574         case 0:
10575             ender = reg_node(pRExC_state, END);
10576             if (!SIZE_ONLY) {
10577                 assert(!RExC_opend); /* there can only be one! */
10578                 RExC_opend = ender;
10579             }
10580             break;
10581         }
10582         DEBUG_PARSE_r(if (!SIZE_ONLY) {
10583             DEBUG_PARSE_MSG("lsbr");
10584             regprop(RExC_rx, RExC_mysv1, lastbr, NULL, pRExC_state);
10585             regprop(RExC_rx, RExC_mysv2, ender, NULL, pRExC_state);
10586             PerlIO_printf(Perl_debug_log, "~ tying lastbr %s (%"IVdf") to ender %s (%"IVdf") offset %"IVdf"\n",
10587                           SvPV_nolen_const(RExC_mysv1),
10588                           (IV)REG_NODE_NUM(lastbr),
10589                           SvPV_nolen_const(RExC_mysv2),
10590                           (IV)REG_NODE_NUM(ender),
10591                           (IV)(ender - lastbr)
10592             );
10593         });
10594         REGTAIL(pRExC_state, lastbr, ender);
10595
10596         if (have_branch && !SIZE_ONLY) {
10597             char is_nothing= 1;
10598             if (depth==1)
10599                 RExC_seen |= REG_TOP_LEVEL_BRANCHES_SEEN;
10600
10601             /* Hook the tails of the branches to the closing node. */
10602             for (br = ret; br; br = regnext(br)) {
10603                 const U8 op = PL_regkind[OP(br)];
10604                 if (op == BRANCH) {
10605                     REGTAIL_STUDY(pRExC_state, NEXTOPER(br), ender);
10606                     if ( OP(NEXTOPER(br)) != NOTHING
10607                          || regnext(NEXTOPER(br)) != ender)
10608                         is_nothing= 0;
10609                 }
10610                 else if (op == BRANCHJ) {
10611                     REGTAIL_STUDY(pRExC_state, NEXTOPER(NEXTOPER(br)), ender);
10612                     /* for now we always disable this optimisation * /
10613                     if ( OP(NEXTOPER(NEXTOPER(br))) != NOTHING
10614                          || regnext(NEXTOPER(NEXTOPER(br))) != ender)
10615                     */
10616                         is_nothing= 0;
10617                 }
10618             }
10619             if (is_nothing) {
10620                 br= PL_regkind[OP(ret)] != BRANCH ? regnext(ret) : ret;
10621                 DEBUG_PARSE_r(if (!SIZE_ONLY) {
10622                     DEBUG_PARSE_MSG("NADA");
10623                     regprop(RExC_rx, RExC_mysv1, ret, NULL, pRExC_state);
10624                     regprop(RExC_rx, RExC_mysv2, ender, NULL, pRExC_state);
10625                     PerlIO_printf(Perl_debug_log, "~ converting ret %s (%"IVdf") to ender %s (%"IVdf") offset %"IVdf"\n",
10626                                   SvPV_nolen_const(RExC_mysv1),
10627                                   (IV)REG_NODE_NUM(ret),
10628                                   SvPV_nolen_const(RExC_mysv2),
10629                                   (IV)REG_NODE_NUM(ender),
10630                                   (IV)(ender - ret)
10631                     );
10632                 });
10633                 OP(br)= NOTHING;
10634                 if (OP(ender) == TAIL) {
10635                     NEXT_OFF(br)= 0;
10636                     RExC_emit= br + 1;
10637                 } else {
10638                     regnode *opt;
10639                     for ( opt= br + 1; opt < ender ; opt++ )
10640                         OP(opt)= OPTIMIZED;
10641                     NEXT_OFF(br)= ender - br;
10642                 }
10643             }
10644         }
10645     }
10646
10647     {
10648         const char *p;
10649         static const char parens[] = "=!<,>";
10650
10651         if (paren && (p = strchr(parens, paren))) {
10652             U8 node = ((p - parens) % 2) ? UNLESSM : IFMATCH;
10653             int flag = (p - parens) > 1;
10654
10655             if (paren == '>')
10656                 node = SUSPEND, flag = 0;
10657             reginsert(pRExC_state, node,ret, depth+1);
10658             Set_Node_Cur_Length(ret, parse_start);
10659             Set_Node_Offset(ret, parse_start + 1);
10660             ret->flags = flag;
10661             REGTAIL_STUDY(pRExC_state, ret, reg_node(pRExC_state, TAIL));
10662         }
10663     }
10664
10665     /* Check for proper termination. */
10666     if (paren) {
10667         /* restore original flags, but keep (?p) */
10668         RExC_flags = oregflags | (RExC_flags & RXf_PMf_KEEPCOPY);
10669         if (RExC_parse >= RExC_end || *nextchar(pRExC_state) != ')') {
10670             RExC_parse = oregcomp_parse;
10671             vFAIL("Unmatched (");
10672         }
10673     }
10674     else if (!paren && RExC_parse < RExC_end) {
10675         if (*RExC_parse == ')') {
10676             RExC_parse++;
10677             vFAIL("Unmatched )");
10678         }
10679         else
10680             FAIL("Junk on end of regexp");      /* "Can't happen". */
10681         NOT_REACHED; /* NOTREACHED */
10682     }
10683
10684     if (RExC_in_lookbehind) {
10685         RExC_in_lookbehind--;
10686     }
10687     if (after_freeze > RExC_npar)
10688         RExC_npar = after_freeze;
10689     return(ret);
10690 }
10691
10692 /*
10693  - regbranch - one alternative of an | operator
10694  *
10695  * Implements the concatenation operator.
10696  *
10697  * Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan needs to be
10698  * restarted.
10699  */
10700 STATIC regnode *
10701 S_regbranch(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, I32 first, U32 depth)
10702 {
10703     regnode *ret;
10704     regnode *chain = NULL;
10705     regnode *latest;
10706     I32 flags = 0, c = 0;
10707     GET_RE_DEBUG_FLAGS_DECL;
10708
10709     PERL_ARGS_ASSERT_REGBRANCH;
10710
10711     DEBUG_PARSE("brnc");
10712
10713     if (first)
10714         ret = NULL;
10715     else {
10716         if (!SIZE_ONLY && RExC_extralen)
10717             ret = reganode(pRExC_state, BRANCHJ,0);
10718         else {
10719             ret = reg_node(pRExC_state, BRANCH);
10720             Set_Node_Length(ret, 1);
10721         }
10722     }
10723
10724     if (!first && SIZE_ONLY)
10725         RExC_extralen += 1;                     /* BRANCHJ */
10726
10727     *flagp = WORST;                     /* Tentatively. */
10728
10729     RExC_parse--;
10730     nextchar(pRExC_state);
10731     while (RExC_parse < RExC_end && *RExC_parse != '|' && *RExC_parse != ')') {
10732         flags &= ~TRYAGAIN;
10733         latest = regpiece(pRExC_state, &flags,depth+1);
10734         if (latest == NULL) {
10735             if (flags & TRYAGAIN)
10736                 continue;
10737             if (flags & RESTART_UTF8) {
10738                 *flagp = RESTART_UTF8;
10739                 return NULL;
10740             }
10741             FAIL2("panic: regpiece returned NULL, flags=%#"UVxf"", (UV) flags);
10742         }
10743         else if (ret == NULL)
10744             ret = latest;
10745         *flagp |= flags&(HASWIDTH|POSTPONED);
10746         if (chain == NULL)      /* First piece. */
10747             *flagp |= flags&SPSTART;
10748         else {
10749             /* FIXME adding one for every branch after the first is probably
10750              * excessive now we have TRIE support. (hv) */
10751             MARK_NAUGHTY(1);
10752             REGTAIL(pRExC_state, chain, latest);
10753         }
10754         chain = latest;
10755         c++;
10756     }
10757     if (chain == NULL) {        /* Loop ran zero times. */
10758         chain = reg_node(pRExC_state, NOTHING);
10759         if (ret == NULL)
10760             ret = chain;
10761     }
10762     if (c == 1) {
10763         *flagp |= flags&SIMPLE;
10764     }
10765
10766     return ret;
10767 }
10768
10769 /*
10770  - regpiece - something followed by possible [*+?]
10771  *
10772  * Note that the branching code sequences used for ? and the general cases
10773  * of * and + are somewhat optimized:  they use the same NOTHING node as
10774  * both the endmarker for their branch list and the body of the last branch.
10775  * It might seem that this node could be dispensed with entirely, but the
10776  * endmarker role is not redundant.
10777  *
10778  * Returns NULL, setting *flagp to TRYAGAIN if regatom() returns NULL with
10779  * TRYAGAIN.
10780  * Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan needs to be
10781  * restarted.
10782  */
10783 STATIC regnode *
10784 S_regpiece(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
10785 {
10786     regnode *ret;
10787     char op;
10788     char *next;
10789     I32 flags;
10790     const char * const origparse = RExC_parse;
10791     I32 min;
10792     I32 max = REG_INFTY;
10793 #ifdef RE_TRACK_PATTERN_OFFSETS
10794     char *parse_start;
10795 #endif
10796     const char *maxpos = NULL;
10797     UV uv;
10798
10799     /* Save the original in case we change the emitted regop to a FAIL. */
10800     regnode * const orig_emit = RExC_emit;
10801
10802     GET_RE_DEBUG_FLAGS_DECL;
10803
10804     PERL_ARGS_ASSERT_REGPIECE;
10805
10806     DEBUG_PARSE("piec");
10807
10808     ret = regatom(pRExC_state, &flags,depth+1);
10809     if (ret == NULL) {
10810         if (flags & (TRYAGAIN|RESTART_UTF8))
10811             *flagp |= flags & (TRYAGAIN|RESTART_UTF8);
10812         else
10813             FAIL2("panic: regatom returned NULL, flags=%#"UVxf"", (UV) flags);
10814         return(NULL);
10815     }
10816
10817     op = *RExC_parse;
10818
10819     if (op == '{' && regcurly(RExC_parse)) {
10820         maxpos = NULL;
10821 #ifdef RE_TRACK_PATTERN_OFFSETS
10822         parse_start = RExC_parse; /* MJD */
10823 #endif
10824         next = RExC_parse + 1;
10825         while (isDIGIT(*next) || *next == ',') {
10826             if (*next == ',') {
10827                 if (maxpos)
10828                     break;
10829                 else
10830                     maxpos = next;
10831             }
10832             next++;
10833         }
10834         if (*next == '}') {             /* got one */
10835             const char* endptr;
10836             if (!maxpos)
10837                 maxpos = next;
10838             RExC_parse++;
10839             if (isDIGIT(*RExC_parse)) {
10840                 if (!grok_atoUV(RExC_parse, &uv, &endptr))
10841                     vFAIL("Invalid quantifier in {,}");
10842                 if (uv >= REG_INFTY)
10843                     vFAIL2("Quantifier in {,} bigger than %d", REG_INFTY - 1);
10844                 min = (I32)uv;
10845             } else {
10846                 min = 0;
10847             }
10848             if (*maxpos == ',')
10849                 maxpos++;
10850             else
10851                 maxpos = RExC_parse;
10852             if (isDIGIT(*maxpos)) {
10853                 if (!grok_atoUV(maxpos, &uv, &endptr))
10854                     vFAIL("Invalid quantifier in {,}");
10855                 if (uv >= REG_INFTY)
10856                     vFAIL2("Quantifier in {,} bigger than %d", REG_INFTY - 1);
10857                 max = (I32)uv;
10858             } else {
10859                 max = REG_INFTY;                /* meaning "infinity" */
10860             }
10861             RExC_parse = next;
10862             nextchar(pRExC_state);
10863             if (max < min) {    /* If can't match, warn and optimize to fail
10864                                    unconditionally */
10865                 if (SIZE_ONLY) {
10866
10867                     /* We can't back off the size because we have to reserve
10868                      * enough space for all the things we are about to throw
10869                      * away, but we can shrink it by the ammount we are about
10870                      * to re-use here */
10871                     RExC_size = PREVOPER(RExC_size) - regarglen[(U8)OPFAIL];
10872                 }
10873                 else {
10874                     ckWARNreg(RExC_parse, "Quantifier {n,m} with n > m can't match");
10875                     RExC_emit = orig_emit;
10876                 }
10877                 ret = reg_node(pRExC_state, OPFAIL);
10878                 return ret;
10879             }
10880             else if (min == max
10881                      && RExC_parse < RExC_end
10882                      && (*RExC_parse == '?' || *RExC_parse == '+'))
10883             {
10884                 if (PASS2) {
10885                     ckWARN2reg(RExC_parse + 1,
10886                                "Useless use of greediness modifier '%c'",
10887                                *RExC_parse);
10888                 }
10889                 /* Absorb the modifier, so later code doesn't see nor use
10890                     * it */
10891                 nextchar(pRExC_state);
10892             }
10893
10894           do_curly:
10895             if ((flags&SIMPLE)) {
10896                 MARK_NAUGHTY_EXP(2, 2);
10897                 reginsert(pRExC_state, CURLY, ret, depth+1);
10898                 Set_Node_Offset(ret, parse_start+1); /* MJD */
10899                 Set_Node_Cur_Length(ret, parse_start);
10900             }
10901             else {
10902                 regnode * const w = reg_node(pRExC_state, WHILEM);
10903
10904                 w->flags = 0;
10905                 REGTAIL(pRExC_state, ret, w);
10906                 if (!SIZE_ONLY && RExC_extralen) {
10907                     reginsert(pRExC_state, LONGJMP,ret, depth+1);
10908                     reginsert(pRExC_state, NOTHING,ret, depth+1);
10909                     NEXT_OFF(ret) = 3;  /* Go over LONGJMP. */
10910                 }
10911                 reginsert(pRExC_state, CURLYX,ret, depth+1);
10912                                 /* MJD hk */
10913                 Set_Node_Offset(ret, parse_start+1);
10914                 Set_Node_Length(ret,
10915                                 op == '{' ? (RExC_parse - parse_start) : 1);
10916
10917                 if (!SIZE_ONLY && RExC_extralen)
10918                     NEXT_OFF(ret) = 3;  /* Go over NOTHING to LONGJMP. */
10919                 REGTAIL(pRExC_state, ret, reg_node(pRExC_state, NOTHING));
10920                 if (SIZE_ONLY)
10921                     RExC_whilem_seen++, RExC_extralen += 3;
10922                 MARK_NAUGHTY_EXP(1, 4);     /* compound interest */
10923             }
10924             ret->flags = 0;
10925
10926             if (min > 0)
10927                 *flagp = WORST;
10928             if (max > 0)
10929                 *flagp |= HASWIDTH;
10930             if (!SIZE_ONLY) {
10931                 ARG1_SET(ret, (U16)min);
10932                 ARG2_SET(ret, (U16)max);
10933             }
10934             if (max == REG_INFTY)
10935                 RExC_seen |= REG_UNBOUNDED_QUANTIFIER_SEEN;
10936
10937             goto nest_check;
10938         }
10939     }
10940
10941     if (!ISMULT1(op)) {
10942         *flagp = flags;
10943         return(ret);
10944     }
10945
10946 #if 0                           /* Now runtime fix should be reliable. */
10947
10948     /* if this is reinstated, don't forget to put this back into perldiag:
10949
10950             =item Regexp *+ operand could be empty at {#} in regex m/%s/
10951
10952            (F) The part of the regexp subject to either the * or + quantifier
10953            could match an empty string. The {#} shows in the regular
10954            expression about where the problem was discovered.
10955
10956     */
10957
10958     if (!(flags&HASWIDTH) && op != '?')
10959       vFAIL("Regexp *+ operand could be empty");
10960 #endif
10961
10962 #ifdef RE_TRACK_PATTERN_OFFSETS
10963     parse_start = RExC_parse;
10964 #endif
10965     nextchar(pRExC_state);
10966
10967     *flagp = (op != '+') ? (WORST|SPSTART|HASWIDTH) : (WORST|HASWIDTH);
10968
10969     if (op == '*' && (flags&SIMPLE)) {
10970         reginsert(pRExC_state, STAR, ret, depth+1);
10971         ret->flags = 0;
10972         MARK_NAUGHTY(4);
10973         RExC_seen |= REG_UNBOUNDED_QUANTIFIER_SEEN;
10974     }
10975     else if (op == '*') {
10976         min = 0;
10977         goto do_curly;
10978     }
10979     else if (op == '+' && (flags&SIMPLE)) {
10980         reginsert(pRExC_state, PLUS, ret, depth+1);
10981         ret->flags = 0;
10982         MARK_NAUGHTY(3);
10983         RExC_seen |= REG_UNBOUNDED_QUANTIFIER_SEEN;
10984     }
10985     else if (op == '+') {
10986         min = 1;
10987         goto do_curly;
10988     }
10989     else if (op == '?') {
10990         min = 0; max = 1;
10991         goto do_curly;
10992     }
10993   nest_check:
10994     if (!SIZE_ONLY && !(flags&(HASWIDTH|POSTPONED)) && max > REG_INFTY/3) {
10995         SAVEFREESV(RExC_rx_sv); /* in case of fatal warnings */
10996         ckWARN2reg(RExC_parse,
10997                    "%"UTF8f" matches null string many times",
10998                    UTF8fARG(UTF, (RExC_parse >= origparse
10999                                  ? RExC_parse - origparse
11000                                  : 0),
11001                    origparse));
11002         (void)ReREFCNT_inc(RExC_rx_sv);
11003     }
11004
11005     if (RExC_parse < RExC_end && *RExC_parse == '?') {
11006         nextchar(pRExC_state);
11007         reginsert(pRExC_state, MINMOD, ret, depth+1);
11008         REGTAIL(pRExC_state, ret, ret + NODE_STEP_REGNODE);
11009     }
11010     else
11011     if (RExC_parse < RExC_end && *RExC_parse == '+') {
11012         regnode *ender;
11013         nextchar(pRExC_state);
11014         ender = reg_node(pRExC_state, SUCCEED);
11015         REGTAIL(pRExC_state, ret, ender);
11016         reginsert(pRExC_state, SUSPEND, ret, depth+1);
11017         ret->flags = 0;
11018         ender = reg_node(pRExC_state, TAIL);
11019         REGTAIL(pRExC_state, ret, ender);
11020     }
11021
11022     if (RExC_parse < RExC_end && ISMULT2(RExC_parse)) {
11023         RExC_parse++;
11024         vFAIL("Nested quantifiers");
11025     }
11026
11027     return(ret);
11028 }
11029
11030 STATIC bool
11031 S_grok_bslash_N(pTHX_ RExC_state_t *pRExC_state,
11032                 regnode ** node_p,
11033                 UV * code_point_p,
11034                 int * cp_count,
11035                 I32 * flagp,
11036                 const U32 depth
11037     )
11038 {
11039  /* This routine teases apart the various meanings of \N and returns
11040   * accordingly.  The input parameters constrain which meaning(s) is/are valid
11041   * in the current context.
11042   *
11043   * Exactly one of <node_p> and <code_point_p> must be non-NULL.
11044   *
11045   * If <code_point_p> is not NULL, the context is expecting the result to be a
11046   * single code point.  If this \N instance turns out to a single code point,
11047   * the function returns TRUE and sets *code_point_p to that code point.
11048   *
11049   * If <node_p> is not NULL, the context is expecting the result to be one of
11050   * the things representable by a regnode.  If this \N instance turns out to be
11051   * one such, the function generates the regnode, returns TRUE and sets *node_p
11052   * to point to that regnode.
11053   *
11054   * If this instance of \N isn't legal in any context, this function will
11055   * generate a fatal error and not return.
11056   *
11057   * On input, RExC_parse should point to the first char following the \N at the
11058   * time of the call.  On successful return, RExC_parse will have been updated
11059   * to point to just after the sequence identified by this routine.  Also
11060   * *flagp has been updated as needed.
11061   *
11062   * When there is some problem with the current context and this \N instance,
11063   * the function returns FALSE, without advancing RExC_parse, nor setting
11064   * *node_p, nor *code_point_p, nor *flagp.
11065   *
11066   * If <cp_count> is not NULL, the caller wants to know the length (in code
11067   * points) that this \N sequence matches.  This is set even if the function
11068   * returns FALSE, as detailed below.
11069   *
11070   * There are 5 possibilities here, as detailed in the next 5 paragraphs.
11071   *
11072   * Probably the most common case is for the \N to specify a single code point.
11073   * *cp_count will be set to 1, and *code_point_p will be set to that code
11074   * point.
11075   *
11076   * Another possibility is for the input to be an empty \N{}, which for
11077   * backwards compatibility we accept.  *cp_count will be set to 0. *node_p
11078   * will be set to a generated NOTHING node.
11079   *
11080   * Still another possibility is for the \N to mean [^\n]. *cp_count will be
11081   * set to 0. *node_p will be set to a generated REG_ANY node.
11082   *
11083   * The fourth possibility is that \N resolves to a sequence of more than one
11084   * code points.  *cp_count will be set to the number of code points in the
11085   * sequence. *node_p * will be set to a generated node returned by this
11086   * function calling S_reg().
11087   *
11088   * The final possibility, which happens only when the fourth one would
11089   * otherwise be in effect, is that one of those code points requires the
11090   * pattern to be recompiled as UTF-8.  The function returns FALSE, and sets
11091   * the RESTART_UTF8 flag in *flagp.  When this happens, the caller needs to
11092   * desist from continuing parsing, and return this information to its caller.
11093   * This is not set for when there is only one code point, as this can be
11094   * called as part of an ANYOF node, and they can store above-Latin1 code
11095   * points without the pattern having to be in UTF-8.
11096   *
11097   * For non-single-quoted regexes, the tokenizer has resolved character and
11098   * sequence names inside \N{...} into their Unicode values, normalizing the
11099   * result into what we should see here: '\N{U+c1.c2...}', where c1... are the
11100   * hex-represented code points in the sequence.  This is done there because
11101   * the names can vary based on what charnames pragma is in scope at the time,
11102   * so we need a way to take a snapshot of what they resolve to at the time of
11103   * the original parse. [perl #56444].
11104   *
11105   * That parsing is skipped for single-quoted regexes, so we may here get
11106   * '\N{NAME}'.  This is a fatal error.  These names have to be resolved by the
11107   * parser.  But if the single-quoted regex is something like '\N{U+41}', that
11108   * is legal and handled here.  The code point is Unicode, and has to be
11109   * translated into the native character set for non-ASCII platforms.
11110   * the tokenizer passes the \N sequence through unchanged; this code will not
11111   * attempt to determine this nor expand those, instead raising a syntax error.
11112   */
11113
11114     char * endbrace;    /* points to '}' following the name */
11115     char *endchar;      /* Points to '.' or '}' ending cur char in the input
11116                            stream */
11117     char* p;            /* Temporary */
11118
11119     GET_RE_DEBUG_FLAGS_DECL;
11120
11121     PERL_ARGS_ASSERT_GROK_BSLASH_N;
11122
11123     GET_RE_DEBUG_FLAGS;
11124
11125     assert(cBOOL(node_p) ^ cBOOL(code_point_p));  /* Exactly one should be set */
11126     assert(! (node_p && cp_count));               /* At most 1 should be set */
11127
11128     if (cp_count) {     /* Initialize return for the most common case */
11129         *cp_count = 1;
11130     }
11131
11132     /* The [^\n] meaning of \N ignores spaces and comments under the /x
11133      * modifier.  The other meanings do not, so use a temporary until we find
11134      * out which we are being called with */
11135     p = (RExC_flags & RXf_PMf_EXTENDED)
11136         ? regpatws(pRExC_state, RExC_parse,
11137                                 TRUE) /* means recognize comments */
11138         : RExC_parse;
11139
11140     /* Disambiguate between \N meaning a named character versus \N meaning
11141      * [^\n].  The latter is assumed when the {...} following the \N is a legal
11142      * quantifier, or there is no a '{' at all */
11143     if (*p != '{' || regcurly(p)) {
11144         RExC_parse = p;
11145         if (cp_count) {
11146             *cp_count = -1;
11147         }
11148
11149         if (! node_p) {
11150             return FALSE;
11151         }
11152         RExC_parse--;   /* Need to back off so nextchar() doesn't skip the
11153                            current char */
11154         nextchar(pRExC_state);
11155         *node_p = reg_node(pRExC_state, REG_ANY);
11156         *flagp |= HASWIDTH|SIMPLE;
11157         MARK_NAUGHTY(1);
11158         Set_Node_Length(*node_p, 1); /* MJD */
11159         return TRUE;
11160     }
11161
11162     /* Here, we have decided it should be a named character or sequence */
11163
11164     /* The test above made sure that the next real character is a '{', but
11165      * under the /x modifier, it could be separated by space (or a comment and
11166      * \n) and this is not allowed (for consistency with \x{...} and the
11167      * tokenizer handling of \N{NAME}). */
11168     if (*RExC_parse != '{') {
11169         vFAIL("Missing braces on \\N{}");
11170     }
11171
11172     RExC_parse++;       /* Skip past the '{' */
11173
11174     if (! (endbrace = strchr(RExC_parse, '}'))  /* no trailing brace */
11175         || ! (endbrace == RExC_parse            /* nothing between the {} */
11176               || (endbrace - RExC_parse >= 2    /* U+ (bad hex is checked... */
11177                   && strnEQ(RExC_parse, "U+", 2)))) /* ... below for a better
11178                                                        error msg) */
11179     {
11180         if (endbrace) RExC_parse = endbrace;    /* position msg's '<--HERE' */
11181         vFAIL("\\N{NAME} must be resolved by the lexer");
11182     }
11183
11184     RExC_uni_semantics = 1; /* Unicode named chars imply Unicode semantics */
11185
11186     if (endbrace == RExC_parse) {   /* empty: \N{} */
11187         if (cp_count) {
11188             *cp_count = 0;
11189         }
11190         nextchar(pRExC_state);
11191         if (! node_p) {
11192             return FALSE;
11193         }
11194
11195         *node_p = reg_node(pRExC_state,NOTHING);
11196         return TRUE;
11197     }
11198
11199     RExC_parse += 2;    /* Skip past the 'U+' */
11200
11201     endchar = RExC_parse + strcspn(RExC_parse, ".}");
11202
11203     /* Code points are separated by dots.  If none, there is only one code
11204      * point, and is terminated by the brace */
11205
11206     if (endchar >= endbrace) {
11207         STRLEN length_of_hex;
11208         I32 grok_hex_flags;
11209
11210         /* Here, exactly one code point.  If that isn't what is wanted, fail */
11211         if (! code_point_p) {
11212             RExC_parse = p;
11213             return FALSE;
11214         }
11215
11216         /* Convert code point from hex */
11217         length_of_hex = (STRLEN)(endchar - RExC_parse);
11218         grok_hex_flags = PERL_SCAN_ALLOW_UNDERSCORES
11219                            | PERL_SCAN_DISALLOW_PREFIX
11220
11221                              /* No errors in the first pass (See [perl
11222                               * #122671].)  We let the code below find the
11223                               * errors when there are multiple chars. */
11224                            | ((SIZE_ONLY)
11225                               ? PERL_SCAN_SILENT_ILLDIGIT
11226                               : 0);
11227
11228         /* This routine is the one place where both single- and double-quotish
11229          * \N{U+xxxx} are evaluated.  The value is a Unicode code point which
11230          * must be converted to native. */
11231         *code_point_p = UNI_TO_NATIVE(grok_hex(RExC_parse,
11232                                          &length_of_hex,
11233                                          &grok_hex_flags,
11234                                          NULL));
11235
11236         /* The tokenizer should have guaranteed validity, but it's possible to
11237          * bypass it by using single quoting, so check.  Don't do the check
11238          * here when there are multiple chars; we do it below anyway. */
11239         if (length_of_hex == 0
11240             || length_of_hex != (STRLEN)(endchar - RExC_parse) )
11241         {
11242             RExC_parse += length_of_hex;        /* Includes all the valid */
11243             RExC_parse += (RExC_orig_utf8)      /* point to after 1st invalid */
11244                             ? UTF8SKIP(RExC_parse)
11245                             : 1;
11246             /* Guard against malformed utf8 */
11247             if (RExC_parse >= endchar) {
11248                 RExC_parse = endchar;
11249             }
11250             vFAIL("Invalid hexadecimal number in \\N{U+...}");
11251         }
11252
11253         RExC_parse = endbrace + 1;
11254         return TRUE;
11255     }
11256     else {  /* Is a multiple character sequence */
11257         SV * substitute_parse;
11258         STRLEN len;
11259         char *orig_end = RExC_end;
11260         I32 flags;
11261
11262         /* Count the code points, if desired, in the sequence */
11263         if (cp_count) {
11264             *cp_count = 0;
11265             while (RExC_parse < endbrace) {
11266                 /* Point to the beginning of the next character in the sequence. */
11267                 RExC_parse = endchar + 1;
11268                 endchar = RExC_parse + strcspn(RExC_parse, ".}");
11269                 (*cp_count)++;
11270             }
11271         }
11272
11273         /* Fail if caller doesn't want to handle a multi-code-point sequence.
11274          * But don't backup up the pointer if the caller want to know how many
11275          * code points there are (they can then handle things) */
11276         if (! node_p) {
11277             if (! cp_count) {
11278                 RExC_parse = p;
11279             }
11280             return FALSE;
11281         }
11282
11283         /* What is done here is to convert this to a sub-pattern of the form
11284          * \x{char1}\x{char2}...  and then call reg recursively to parse it
11285          * (enclosing in "(?: ... )" ).  That way, it retains its atomicness,
11286          * while not having to worry about special handling that some code
11287          * points may have. */
11288
11289         substitute_parse = newSVpvs("?:");
11290
11291         while (RExC_parse < endbrace) {
11292
11293             /* Convert to notation the rest of the code understands */
11294             sv_catpv(substitute_parse, "\\x{");
11295             sv_catpvn(substitute_parse, RExC_parse, endchar - RExC_parse);
11296             sv_catpv(substitute_parse, "}");
11297
11298             /* Point to the beginning of the next character in the sequence. */
11299             RExC_parse = endchar + 1;
11300             endchar = RExC_parse + strcspn(RExC_parse, ".}");
11301
11302         }
11303         sv_catpv(substitute_parse, ")");
11304
11305         RExC_parse = SvPV(substitute_parse, len);
11306
11307         /* Don't allow empty number */
11308         if (len < (STRLEN) 8) {
11309             RExC_parse = endbrace;
11310             vFAIL("Invalid hexadecimal number in \\N{U+...}");
11311         }
11312         RExC_end = RExC_parse + len;
11313
11314         /* The values are Unicode, and therefore not subject to recoding, but
11315          * have to be converted to native on a non-Unicode (meaning non-ASCII)
11316          * platform. */
11317         RExC_override_recoding = 1;
11318 #ifdef EBCDIC
11319         RExC_recode_x_to_native = 1;
11320 #endif
11321
11322         if (node_p) {
11323             if (!(*node_p = reg(pRExC_state, 1, &flags, depth+1))) {
11324                 if (flags & RESTART_UTF8) {
11325                     *flagp = RESTART_UTF8;
11326                     return FALSE;
11327                 }
11328                 FAIL2("panic: reg returned NULL to grok_bslash_N, flags=%#"UVxf"",
11329                     (UV) flags);
11330             }
11331             *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
11332         }
11333
11334         /* Restore the saved values */
11335         RExC_parse = endbrace;
11336         RExC_end = orig_end;
11337         RExC_override_recoding = 0;
11338 #ifdef EBCDIC
11339         RExC_recode_x_to_native = 0;
11340 #endif
11341
11342         SvREFCNT_dec_NN(substitute_parse);
11343         nextchar(pRExC_state);
11344
11345         return TRUE;
11346     }
11347 }
11348
11349
11350 /*
11351  * reg_recode
11352  *
11353  * It returns the code point in utf8 for the value in *encp.
11354  *    value: a code value in the source encoding
11355  *    encp:  a pointer to an Encode object
11356  *
11357  * If the result from Encode is not a single character,
11358  * it returns U+FFFD (Replacement character) and sets *encp to NULL.
11359  */
11360 STATIC UV
11361 S_reg_recode(pTHX_ const char value, SV **encp)
11362 {
11363     STRLEN numlen = 1;
11364     SV * const sv = newSVpvn_flags(&value, numlen, SVs_TEMP);
11365     const char * const s = *encp ? sv_recode_to_utf8(sv, *encp) : SvPVX(sv);
11366     const STRLEN newlen = SvCUR(sv);
11367     UV uv = UNICODE_REPLACEMENT;
11368
11369     PERL_ARGS_ASSERT_REG_RECODE;
11370
11371     if (newlen)
11372         uv = SvUTF8(sv)
11373              ? utf8n_to_uvchr((U8*)s, newlen, &numlen, UTF8_ALLOW_DEFAULT)
11374              : *(U8*)s;
11375
11376     if (!newlen || numlen != newlen) {
11377         uv = UNICODE_REPLACEMENT;
11378         *encp = NULL;
11379     }
11380     return uv;
11381 }
11382
11383 PERL_STATIC_INLINE U8
11384 S_compute_EXACTish(RExC_state_t *pRExC_state)
11385 {
11386     U8 op;
11387
11388     PERL_ARGS_ASSERT_COMPUTE_EXACTISH;
11389
11390     if (! FOLD) {
11391         return (LOC)
11392                 ? EXACTL
11393                 : EXACT;
11394     }
11395
11396     op = get_regex_charset(RExC_flags);
11397     if (op >= REGEX_ASCII_RESTRICTED_CHARSET) {
11398         op--; /* /a is same as /u, and map /aa's offset to what /a's would have
11399                  been, so there is no hole */
11400     }
11401
11402     return op + EXACTF;
11403 }
11404
11405 PERL_STATIC_INLINE void
11406 S_alloc_maybe_populate_EXACT(pTHX_ RExC_state_t *pRExC_state,
11407                          regnode *node, I32* flagp, STRLEN len, UV code_point,
11408                          bool downgradable)
11409 {
11410     /* This knows the details about sizing an EXACTish node, setting flags for
11411      * it (by setting <*flagp>, and potentially populating it with a single
11412      * character.
11413      *
11414      * If <len> (the length in bytes) is non-zero, this function assumes that
11415      * the node has already been populated, and just does the sizing.  In this
11416      * case <code_point> should be the final code point that has already been
11417      * placed into the node.  This value will be ignored except that under some
11418      * circumstances <*flagp> is set based on it.
11419      *
11420      * If <len> is zero, the function assumes that the node is to contain only
11421      * the single character given by <code_point> and calculates what <len>
11422      * should be.  In pass 1, it sizes the node appropriately.  In pass 2, it
11423      * additionally will populate the node's STRING with <code_point> or its
11424      * fold if folding.
11425      *
11426      * In both cases <*flagp> is appropriately set
11427      *
11428      * It knows that under FOLD, the Latin Sharp S and UTF characters above
11429      * 255, must be folded (the former only when the rules indicate it can
11430      * match 'ss')
11431      *
11432      * When it does the populating, it looks at the flag 'downgradable'.  If
11433      * true with a node that folds, it checks if the single code point
11434      * participates in a fold, and if not downgrades the node to an EXACT.
11435      * This helps the optimizer */
11436
11437     bool len_passed_in = cBOOL(len != 0);
11438     U8 character[UTF8_MAXBYTES_CASE+1];
11439
11440     PERL_ARGS_ASSERT_ALLOC_MAYBE_POPULATE_EXACT;
11441
11442     /* Don't bother to check for downgrading in PASS1, as it doesn't make any
11443      * sizing difference, and is extra work that is thrown away */
11444     if (downgradable && ! PASS2) {
11445         downgradable = FALSE;
11446     }
11447
11448     if (! len_passed_in) {
11449         if (UTF) {
11450             if (UVCHR_IS_INVARIANT(code_point)) {
11451                 if (LOC || ! FOLD) {    /* /l defers folding until runtime */
11452                     *character = (U8) code_point;
11453                 }
11454                 else { /* Here is /i and not /l. (toFOLD() is defined on just
11455                           ASCII, which isn't the same thing as INVARIANT on
11456                           EBCDIC, but it works there, as the extra invariants
11457                           fold to themselves) */
11458                     *character = toFOLD((U8) code_point);
11459
11460                     /* We can downgrade to an EXACT node if this character
11461                      * isn't a folding one.  Note that this assumes that
11462                      * nothing above Latin1 folds to some other invariant than
11463                      * one of these alphabetics; otherwise we would also have
11464                      * to check:
11465                      *  && (! HAS_NONLATIN1_FOLD_CLOSURE(code_point)
11466                      *      || ASCII_FOLD_RESTRICTED))
11467                      */
11468                     if (downgradable && PL_fold[code_point] == code_point) {
11469                         OP(node) = EXACT;
11470                     }
11471                 }
11472                 len = 1;
11473             }
11474             else if (FOLD && (! LOC
11475                               || ! is_PROBLEMATIC_LOCALE_FOLD_cp(code_point)))
11476             {   /* Folding, and ok to do so now */
11477                 UV folded = _to_uni_fold_flags(
11478                                    code_point,
11479                                    character,
11480                                    &len,
11481                                    FOLD_FLAGS_FULL | ((ASCII_FOLD_RESTRICTED)
11482                                                       ? FOLD_FLAGS_NOMIX_ASCII
11483                                                       : 0));
11484                 if (downgradable
11485                     && folded == code_point /* This quickly rules out many
11486                                                cases, avoiding the
11487                                                _invlist_contains_cp() overhead
11488                                                for those.  */
11489                     && ! _invlist_contains_cp(PL_utf8_foldable, code_point))
11490                 {
11491                     OP(node) = (LOC)
11492                                ? EXACTL
11493                                : EXACT;
11494                 }
11495             }
11496             else if (code_point <= MAX_UTF8_TWO_BYTE) {
11497
11498                 /* Not folding this cp, and can output it directly */
11499                 *character = UTF8_TWO_BYTE_HI(code_point);
11500                 *(character + 1) = UTF8_TWO_BYTE_LO(code_point);
11501                 len = 2;
11502             }
11503             else {
11504                 uvchr_to_utf8( character, code_point);
11505                 len = UTF8SKIP(character);
11506             }
11507         } /* Else pattern isn't UTF8.  */
11508         else if (! FOLD) {
11509             *character = (U8) code_point;
11510             len = 1;
11511         } /* Else is folded non-UTF8 */
11512 #if    UNICODE_MAJOR_VERSION > 3 /* no multifolds in early Unicode */   \
11513    || (UNICODE_MAJOR_VERSION == 3 && (   UNICODE_DOT_VERSION > 0)       \
11514                                       || UNICODE_DOT_DOT_VERSION > 0)
11515         else if (LIKELY(code_point != LATIN_SMALL_LETTER_SHARP_S)) {
11516 #else
11517         else if (1) {
11518 #endif
11519             /* We don't fold any non-UTF8 except possibly the Sharp s  (see
11520              * comments at join_exact()); */
11521             *character = (U8) code_point;
11522             len = 1;
11523
11524             /* Can turn into an EXACT node if we know the fold at compile time,
11525              * and it folds to itself and doesn't particpate in other folds */
11526             if (downgradable
11527                 && ! LOC
11528                 && PL_fold_latin1[code_point] == code_point
11529                 && (! HAS_NONLATIN1_FOLD_CLOSURE(code_point)
11530                     || (isASCII(code_point) && ASCII_FOLD_RESTRICTED)))
11531             {
11532                 OP(node) = EXACT;
11533             }
11534         } /* else is Sharp s.  May need to fold it */
11535         else if (AT_LEAST_UNI_SEMANTICS && ! ASCII_FOLD_RESTRICTED) {
11536             *character = 's';
11537             *(character + 1) = 's';
11538             len = 2;
11539         }
11540         else {
11541             *character = LATIN_SMALL_LETTER_SHARP_S;
11542             len = 1;
11543         }
11544     }
11545
11546     if (SIZE_ONLY) {
11547         RExC_size += STR_SZ(len);
11548     }
11549     else {
11550         RExC_emit += STR_SZ(len);
11551         STR_LEN(node) = len;
11552         if (! len_passed_in) {
11553             Copy((char *) character, STRING(node), len, char);
11554         }
11555     }
11556
11557     *flagp |= HASWIDTH;
11558
11559     /* A single character node is SIMPLE, except for the special-cased SHARP S
11560      * under /di. */
11561     if ((len == 1 || (UTF && len == UNISKIP(code_point)))
11562 #if    UNICODE_MAJOR_VERSION > 3 /* no multifolds in early Unicode */   \
11563    || (UNICODE_MAJOR_VERSION == 3 && (   UNICODE_DOT_VERSION > 0)       \
11564                                       || UNICODE_DOT_DOT_VERSION > 0)
11565         && ( code_point != LATIN_SMALL_LETTER_SHARP_S
11566             || ! FOLD || ! DEPENDS_SEMANTICS)
11567 #endif
11568     ) {
11569         *flagp |= SIMPLE;
11570     }
11571
11572     /* The OP may not be well defined in PASS1 */
11573     if (PASS2 && OP(node) == EXACTFL) {
11574         RExC_contains_locale = 1;
11575     }
11576 }
11577
11578
11579 /* Parse backref decimal value, unless it's too big to sensibly be a backref,
11580  * in which case return I32_MAX (rather than possibly 32-bit wrapping) */
11581
11582 static I32
11583 S_backref_value(char *p)
11584 {
11585     const char* endptr;
11586     UV val;
11587     if (grok_atoUV(p, &val, &endptr) && val <= I32_MAX)
11588         return (I32)val;
11589     return I32_MAX;
11590 }
11591
11592
11593 /*
11594  - regatom - the lowest level
11595
11596    Try to identify anything special at the start of the pattern. If there
11597    is, then handle it as required. This may involve generating a single regop,
11598    such as for an assertion; or it may involve recursing, such as to
11599    handle a () structure.
11600
11601    If the string doesn't start with something special then we gobble up
11602    as much literal text as we can.
11603
11604    Once we have been able to handle whatever type of thing started the
11605    sequence, we return.
11606
11607    Note: we have to be careful with escapes, as they can be both literal
11608    and special, and in the case of \10 and friends, context determines which.
11609
11610    A summary of the code structure is:
11611
11612    switch (first_byte) {
11613         cases for each special:
11614             handle this special;
11615             break;
11616         case '\\':
11617             switch (2nd byte) {
11618                 cases for each unambiguous special:
11619                     handle this special;
11620                     break;
11621                 cases for each ambigous special/literal:
11622                     disambiguate;
11623                     if (special)  handle here
11624                     else goto defchar;
11625                 default: // unambiguously literal:
11626                     goto defchar;
11627             }
11628         default:  // is a literal char
11629             // FALL THROUGH
11630         defchar:
11631             create EXACTish node for literal;
11632             while (more input and node isn't full) {
11633                 switch (input_byte) {
11634                    cases for each special;
11635                        make sure parse pointer is set so that the next call to
11636                            regatom will see this special first
11637                        goto loopdone; // EXACTish node terminated by prev. char
11638                    default:
11639                        append char to EXACTISH node;
11640                 }
11641                 get next input byte;
11642             }
11643         loopdone:
11644    }
11645    return the generated node;
11646
11647    Specifically there are two separate switches for handling
11648    escape sequences, with the one for handling literal escapes requiring
11649    a dummy entry for all of the special escapes that are actually handled
11650    by the other.
11651
11652    Returns NULL, setting *flagp to TRYAGAIN if reg() returns NULL with
11653    TRYAGAIN.
11654    Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan needs to be
11655    restarted.
11656    Otherwise does not return NULL.
11657 */
11658
11659 STATIC regnode *
11660 S_regatom(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
11661 {
11662     regnode *ret = NULL;
11663     I32 flags = 0;
11664     char *parse_start = RExC_parse;
11665     U8 op;
11666     int invert = 0;
11667     U8 arg;
11668
11669     GET_RE_DEBUG_FLAGS_DECL;
11670
11671     *flagp = WORST;             /* Tentatively. */
11672
11673     DEBUG_PARSE("atom");
11674
11675     PERL_ARGS_ASSERT_REGATOM;
11676
11677   tryagain:
11678     switch ((U8)*RExC_parse) {
11679     case '^':
11680         RExC_seen_zerolen++;
11681         nextchar(pRExC_state);
11682         if (RExC_flags & RXf_PMf_MULTILINE)
11683             ret = reg_node(pRExC_state, MBOL);
11684         else
11685             ret = reg_node(pRExC_state, SBOL);
11686         Set_Node_Length(ret, 1); /* MJD */
11687         break;
11688     case '$':
11689         nextchar(pRExC_state);
11690         if (*RExC_parse)
11691             RExC_seen_zerolen++;
11692         if (RExC_flags & RXf_PMf_MULTILINE)
11693             ret = reg_node(pRExC_state, MEOL);
11694         else
11695             ret = reg_node(pRExC_state, SEOL);
11696         Set_Node_Length(ret, 1); /* MJD */
11697         break;
11698     case '.':
11699         nextchar(pRExC_state);
11700         if (RExC_flags & RXf_PMf_SINGLELINE)
11701             ret = reg_node(pRExC_state, SANY);
11702         else
11703             ret = reg_node(pRExC_state, REG_ANY);
11704         *flagp |= HASWIDTH|SIMPLE;
11705         MARK_NAUGHTY(1);
11706         Set_Node_Length(ret, 1); /* MJD */
11707         break;
11708     case '[':
11709     {
11710         char * const oregcomp_parse = ++RExC_parse;
11711         ret = regclass(pRExC_state, flagp,depth+1,
11712                        FALSE, /* means parse the whole char class */
11713                        TRUE, /* allow multi-char folds */
11714                        FALSE, /* don't silence non-portable warnings. */
11715                        (bool) RExC_strict,
11716                        NULL);
11717         if (*RExC_parse != ']') {
11718             RExC_parse = oregcomp_parse;
11719             vFAIL("Unmatched [");
11720         }
11721         if (ret == NULL) {
11722             if (*flagp & RESTART_UTF8)
11723                 return NULL;
11724             FAIL2("panic: regclass returned NULL to regatom, flags=%#"UVxf"",
11725                   (UV) *flagp);
11726         }
11727         nextchar(pRExC_state);
11728         Set_Node_Length(ret, RExC_parse - oregcomp_parse + 1); /* MJD */
11729         break;
11730     }
11731     case '(':
11732         nextchar(pRExC_state);
11733         ret = reg(pRExC_state, 2, &flags,depth+1);
11734         if (ret == NULL) {
11735                 if (flags & TRYAGAIN) {
11736                     if (RExC_parse == RExC_end) {
11737                          /* Make parent create an empty node if needed. */
11738                         *flagp |= TRYAGAIN;
11739                         return(NULL);
11740                     }
11741                     goto tryagain;
11742                 }
11743                 if (flags & RESTART_UTF8) {
11744                     *flagp = RESTART_UTF8;
11745                     return NULL;
11746                 }
11747                 FAIL2("panic: reg returned NULL to regatom, flags=%#"UVxf"",
11748                                                                  (UV) flags);
11749         }
11750         *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
11751         break;
11752     case '|':
11753     case ')':
11754         if (flags & TRYAGAIN) {
11755             *flagp |= TRYAGAIN;
11756             return NULL;
11757         }
11758         vFAIL("Internal urp");
11759                                 /* Supposed to be caught earlier. */
11760         break;
11761     case '?':
11762     case '+':
11763     case '*':
11764         RExC_parse++;
11765         vFAIL("Quantifier follows nothing");
11766         break;
11767     case '\\':
11768         /* Special Escapes
11769
11770            This switch handles escape sequences that resolve to some kind
11771            of special regop and not to literal text. Escape sequnces that
11772            resolve to literal text are handled below in the switch marked
11773            "Literal Escapes".
11774
11775            Every entry in this switch *must* have a corresponding entry
11776            in the literal escape switch. However, the opposite is not
11777            required, as the default for this switch is to jump to the
11778            literal text handling code.
11779         */
11780         switch ((U8)*++RExC_parse) {
11781         /* Special Escapes */
11782         case 'A':
11783             RExC_seen_zerolen++;
11784             ret = reg_node(pRExC_state, SBOL);
11785             /* SBOL is shared with /^/ so we set the flags so we can tell
11786              * /\A/ from /^/ in split. We check ret because first pass we
11787              * have no regop struct to set the flags on. */
11788             if (PASS2)
11789                 ret->flags = 1;
11790             *flagp |= SIMPLE;
11791             goto finish_meta_pat;
11792         case 'G':
11793             ret = reg_node(pRExC_state, GPOS);
11794             RExC_seen |= REG_GPOS_SEEN;
11795             *flagp |= SIMPLE;
11796             goto finish_meta_pat;
11797         case 'K':
11798             RExC_seen_zerolen++;
11799             ret = reg_node(pRExC_state, KEEPS);
11800             *flagp |= SIMPLE;
11801             /* XXX:dmq : disabling in-place substitution seems to
11802              * be necessary here to avoid cases of memory corruption, as
11803              * with: C<$_="x" x 80; s/x\K/y/> -- rgs
11804              */
11805             RExC_seen |= REG_LOOKBEHIND_SEEN;
11806             goto finish_meta_pat;
11807         case 'Z':
11808             ret = reg_node(pRExC_state, SEOL);
11809             *flagp |= SIMPLE;
11810             RExC_seen_zerolen++;                /* Do not optimize RE away */
11811             goto finish_meta_pat;
11812         case 'z':
11813             ret = reg_node(pRExC_state, EOS);
11814             *flagp |= SIMPLE;
11815             RExC_seen_zerolen++;                /* Do not optimize RE away */
11816             goto finish_meta_pat;
11817         case 'C':
11818             vFAIL("\\C no longer supported");
11819         case 'X':
11820             ret = reg_node(pRExC_state, CLUMP);
11821             *flagp |= HASWIDTH;
11822             goto finish_meta_pat;
11823
11824         case 'W':
11825             invert = 1;
11826             /* FALLTHROUGH */
11827         case 'w':
11828             arg = ANYOF_WORDCHAR;
11829             goto join_posix;
11830
11831         case 'B':
11832             invert = 1;
11833             /* FALLTHROUGH */
11834         case 'b':
11835           {
11836             regex_charset charset = get_regex_charset(RExC_flags);
11837
11838             RExC_seen_zerolen++;
11839             RExC_seen |= REG_LOOKBEHIND_SEEN;
11840             op = BOUND + charset;
11841
11842             if (op == BOUNDL) {
11843                 RExC_contains_locale = 1;
11844             }
11845
11846             ret = reg_node(pRExC_state, op);
11847             *flagp |= SIMPLE;
11848             if (*(RExC_parse + 1) != '{') {
11849                 FLAGS(ret) = TRADITIONAL_BOUND;
11850                 if (PASS2 && op > BOUNDA) {  /* /aa is same as /a */
11851                     OP(ret) = BOUNDA;
11852                 }
11853             }
11854             else {
11855                 STRLEN length;
11856                 char name = *RExC_parse;
11857                 char * endbrace;
11858                 RExC_parse += 2;
11859                 endbrace = strchr(RExC_parse, '}');
11860
11861                 if (! endbrace) {
11862                     vFAIL2("Missing right brace on \\%c{}", name);
11863                 }
11864                 /* XXX Need to decide whether to take spaces or not.  Should be
11865                  * consistent with \p{}, but that currently is SPACE, which
11866                  * means vertical too, which seems wrong
11867                  * while (isBLANK(*RExC_parse)) {
11868                     RExC_parse++;
11869                 }*/
11870                 if (endbrace == RExC_parse) {
11871                     RExC_parse++;  /* After the '}' */
11872                     vFAIL2("Empty \\%c{}", name);
11873                 }
11874                 length = endbrace - RExC_parse;
11875                 /*while (isBLANK(*(RExC_parse + length - 1))) {
11876                     length--;
11877                 }*/
11878                 switch (*RExC_parse) {
11879                     case 'g':
11880                         if (length != 1
11881                             && (length != 3 || strnNE(RExC_parse + 1, "cb", 2)))
11882                         {
11883                             goto bad_bound_type;
11884                         }
11885                         FLAGS(ret) = GCB_BOUND;
11886                         break;
11887                     case 's':
11888                         if (length != 2 || *(RExC_parse + 1) != 'b') {
11889                             goto bad_bound_type;
11890                         }
11891                         FLAGS(ret) = SB_BOUND;
11892                         break;
11893                     case 'w':
11894                         if (length != 2 || *(RExC_parse + 1) != 'b') {
11895                             goto bad_bound_type;
11896                         }
11897                         FLAGS(ret) = WB_BOUND;
11898                         break;
11899                     default:
11900                       bad_bound_type:
11901                         RExC_parse = endbrace;
11902                         vFAIL2utf8f(
11903                             "'%"UTF8f"' is an unknown bound type",
11904                             UTF8fARG(UTF, length, endbrace - length));
11905                         NOT_REACHED; /*NOTREACHED*/
11906                 }
11907                 RExC_parse = endbrace;
11908                 RExC_uni_semantics = 1;
11909
11910                 if (PASS2 && op >= BOUNDA) {  /* /aa is same as /a */
11911                     OP(ret) = BOUNDU;
11912                     length += 4;
11913
11914                     /* Don't have to worry about UTF-8, in this message because
11915                      * to get here the contents of the \b must be ASCII */
11916                     ckWARN4reg(RExC_parse + 1,  /* Include the '}' in msg */
11917                               "Using /u for '%.*s' instead of /%s",
11918                               (unsigned) length,
11919                               endbrace - length + 1,
11920                               (charset == REGEX_ASCII_RESTRICTED_CHARSET)
11921                               ? ASCII_RESTRICT_PAT_MODS
11922                               : ASCII_MORE_RESTRICT_PAT_MODS);
11923                 }
11924             }
11925
11926             if (PASS2 && invert) {
11927                 OP(ret) += NBOUND - BOUND;
11928             }
11929             goto finish_meta_pat;
11930           }
11931
11932         case 'D':
11933             invert = 1;
11934             /* FALLTHROUGH */
11935         case 'd':
11936             arg = ANYOF_DIGIT;
11937             if (! DEPENDS_SEMANTICS) {
11938                 goto join_posix;
11939             }
11940
11941             /* \d doesn't have any matches in the upper Latin1 range, hence /d
11942              * is equivalent to /u.  Changing to /u saves some branches at
11943              * runtime */
11944             op = POSIXU;
11945             goto join_posix_op_known;
11946
11947         case 'R':
11948             ret = reg_node(pRExC_state, LNBREAK);
11949             *flagp |= HASWIDTH|SIMPLE;
11950             goto finish_meta_pat;
11951
11952         case 'H':
11953             invert = 1;
11954             /* FALLTHROUGH */
11955         case 'h':
11956             arg = ANYOF_BLANK;
11957             op = POSIXU;
11958             goto join_posix_op_known;
11959
11960         case 'V':
11961             invert = 1;
11962             /* FALLTHROUGH */
11963         case 'v':
11964             arg = ANYOF_VERTWS;
11965             op = POSIXU;
11966             goto join_posix_op_known;
11967
11968         case 'S':
11969             invert = 1;
11970             /* FALLTHROUGH */
11971         case 's':
11972             arg = ANYOF_SPACE;
11973
11974           join_posix:
11975
11976             op = POSIXD + get_regex_charset(RExC_flags);
11977             if (op > POSIXA) {  /* /aa is same as /a */
11978                 op = POSIXA;
11979             }
11980             else if (op == POSIXL) {
11981                 RExC_contains_locale = 1;
11982             }
11983
11984           join_posix_op_known:
11985
11986             if (invert) {
11987                 op += NPOSIXD - POSIXD;
11988             }
11989
11990             ret = reg_node(pRExC_state, op);
11991             if (! SIZE_ONLY) {
11992                 FLAGS(ret) = namedclass_to_classnum(arg);
11993             }
11994
11995             *flagp |= HASWIDTH|SIMPLE;
11996             /* FALLTHROUGH */
11997
11998           finish_meta_pat:
11999             nextchar(pRExC_state);
12000             Set_Node_Length(ret, 2); /* MJD */
12001             break;
12002         case 'p':
12003         case 'P':
12004             {
12005 #ifdef DEBUGGING
12006                 char* parse_start = RExC_parse - 2;
12007 #endif
12008
12009                 RExC_parse--;
12010
12011                 ret = regclass(pRExC_state, flagp,depth+1,
12012                                TRUE, /* means just parse this element */
12013                                FALSE, /* don't allow multi-char folds */
12014                                FALSE, /* don't silence non-portable warnings.
12015                                          It would be a bug if these returned
12016                                          non-portables */
12017                                (bool) RExC_strict,
12018                                NULL);
12019                 /* regclass() can only return RESTART_UTF8 if multi-char folds
12020                    are allowed.  */
12021                 if (!ret)
12022                     FAIL2("panic: regclass returned NULL to regatom, flags=%#"UVxf"",
12023                           (UV) *flagp);
12024
12025                 RExC_parse--;
12026
12027                 Set_Node_Offset(ret, parse_start + 2);
12028                 Set_Node_Cur_Length(ret, parse_start);
12029                 nextchar(pRExC_state);
12030             }
12031             break;
12032         case 'N':
12033             /* Handle \N, \N{} and \N{NAMED SEQUENCE} (the latter meaning the
12034              * \N{...} evaluates to a sequence of more than one code points).
12035              * The function call below returns a regnode, which is our result.
12036              * The parameters cause it to fail if the \N{} evaluates to a
12037              * single code point; we handle those like any other literal.  The
12038              * reason that the multicharacter case is handled here and not as
12039              * part of the EXACtish code is because of quantifiers.  In
12040              * /\N{BLAH}+/, the '+' applies to the whole thing, and doing it
12041              * this way makes that Just Happen. dmq.
12042              * join_exact() will join this up with adjacent EXACTish nodes
12043              * later on, if appropriate. */
12044             ++RExC_parse;
12045             if (grok_bslash_N(pRExC_state,
12046                               &ret,     /* Want a regnode returned */
12047                               NULL,     /* Fail if evaluates to a single code
12048                                            point */
12049                               NULL,     /* Don't need a count of how many code
12050                                            points */
12051                               flagp,
12052                               depth)
12053             ) {
12054                 break;
12055             }
12056
12057             if (*flagp & RESTART_UTF8)
12058                 return NULL;
12059             RExC_parse--;
12060             goto defchar;
12061
12062         case 'k':    /* Handle \k<NAME> and \k'NAME' */
12063       parse_named_seq:
12064         {
12065             char ch= RExC_parse[1];
12066             if (ch != '<' && ch != '\'' && ch != '{') {
12067                 RExC_parse++;
12068                 /* diag_listed_as: Sequence \%s... not terminated in regex; marked by <-- HERE in m/%s/ */
12069                 vFAIL2("Sequence %.2s... not terminated",parse_start);
12070             } else {
12071                 /* this pretty much dupes the code for (?P=...) in reg(), if
12072                    you change this make sure you change that */
12073                 char* name_start = (RExC_parse += 2);
12074                 U32 num = 0;
12075                 SV *sv_dat = reg_scan_name(pRExC_state,
12076                     SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
12077                 ch= (ch == '<') ? '>' : (ch == '{') ? '}' : '\'';
12078                 if (RExC_parse == name_start || *RExC_parse != ch)
12079                     /* diag_listed_as: Sequence \%s... not terminated in regex; marked by <-- HERE in m/%s/ */
12080                     vFAIL2("Sequence %.3s... not terminated",parse_start);
12081
12082                 if (!SIZE_ONLY) {
12083                     num = add_data( pRExC_state, STR_WITH_LEN("S"));
12084                     RExC_rxi->data->data[num]=(void*)sv_dat;
12085                     SvREFCNT_inc_simple_void(sv_dat);
12086                 }
12087
12088                 RExC_sawback = 1;
12089                 ret = reganode(pRExC_state,
12090                                ((! FOLD)
12091                                  ? NREF
12092                                  : (ASCII_FOLD_RESTRICTED)
12093                                    ? NREFFA
12094                                    : (AT_LEAST_UNI_SEMANTICS)
12095                                      ? NREFFU
12096                                      : (LOC)
12097                                        ? NREFFL
12098                                        : NREFF),
12099                                 num);
12100                 *flagp |= HASWIDTH;
12101
12102                 /* override incorrect value set in reganode MJD */
12103                 Set_Node_Offset(ret, parse_start+1);
12104                 Set_Node_Cur_Length(ret, parse_start);
12105                 nextchar(pRExC_state);
12106
12107             }
12108             break;
12109         }
12110         case 'g':
12111         case '1': case '2': case '3': case '4':
12112         case '5': case '6': case '7': case '8': case '9':
12113             {
12114                 I32 num;
12115                 bool hasbrace = 0;
12116
12117                 if (*RExC_parse == 'g') {
12118                     bool isrel = 0;
12119
12120                     RExC_parse++;
12121                     if (*RExC_parse == '{') {
12122                         RExC_parse++;
12123                         hasbrace = 1;
12124                     }
12125                     if (*RExC_parse == '-') {
12126                         RExC_parse++;
12127                         isrel = 1;
12128                     }
12129                     if (hasbrace && !isDIGIT(*RExC_parse)) {
12130                         if (isrel) RExC_parse--;
12131                         RExC_parse -= 2;
12132                         goto parse_named_seq;
12133                     }
12134
12135                     num = S_backref_value(RExC_parse);
12136                     if (num == 0)
12137                         vFAIL("Reference to invalid group 0");
12138                     else if (num == I32_MAX) {
12139                          if (isDIGIT(*RExC_parse))
12140                             vFAIL("Reference to nonexistent group");
12141                         else
12142                             vFAIL("Unterminated \\g... pattern");
12143                     }
12144
12145                     if (isrel) {
12146                         num = RExC_npar - num;
12147                         if (num < 1)
12148                             vFAIL("Reference to nonexistent or unclosed group");
12149                     }
12150                 }
12151                 else {
12152                     num = S_backref_value(RExC_parse);
12153                     /* bare \NNN might be backref or octal - if it is larger
12154                      * than or equal RExC_npar then it is assumed to be an
12155                      * octal escape. Note RExC_npar is +1 from the actual
12156                      * number of parens. */
12157                     /* Note we do NOT check if num == I32_MAX here, as that is
12158                      * handled by the RExC_npar check */
12159
12160                     if (
12161                         /* any numeric escape < 10 is always a backref */
12162                         num > 9
12163                         /* any numeric escape < RExC_npar is a backref */
12164                         && num >= RExC_npar
12165                         /* cannot be an octal escape if it starts with 8 */
12166                         && *RExC_parse != '8'
12167                         /* cannot be an octal escape it it starts with 9 */
12168                         && *RExC_parse != '9'
12169                     )
12170                     {
12171                         /* Probably not a backref, instead likely to be an
12172                          * octal character escape, e.g. \35 or \777.
12173                          * The above logic should make it obvious why using
12174                          * octal escapes in patterns is problematic. - Yves */
12175                         goto defchar;
12176                     }
12177                 }
12178
12179                 /* At this point RExC_parse points at a numeric escape like
12180                  * \12 or \88 or something similar, which we should NOT treat
12181                  * as an octal escape. It may or may not be a valid backref
12182                  * escape. For instance \88888888 is unlikely to be a valid
12183                  * backref. */
12184                 {
12185 #ifdef RE_TRACK_PATTERN_OFFSETS
12186                     char * const parse_start = RExC_parse - 1; /* MJD */
12187 #endif
12188                     while (isDIGIT(*RExC_parse))
12189                         RExC_parse++;
12190                     if (hasbrace) {
12191                         if (*RExC_parse != '}')
12192                             vFAIL("Unterminated \\g{...} pattern");
12193                         RExC_parse++;
12194                     }
12195                     if (!SIZE_ONLY) {
12196                         if (num > (I32)RExC_rx->nparens)
12197                             vFAIL("Reference to nonexistent group");
12198                     }
12199                     RExC_sawback = 1;
12200                     ret = reganode(pRExC_state,
12201                                    ((! FOLD)
12202                                      ? REF
12203                                      : (ASCII_FOLD_RESTRICTED)
12204                                        ? REFFA
12205                                        : (AT_LEAST_UNI_SEMANTICS)
12206                                          ? REFFU
12207                                          : (LOC)
12208                                            ? REFFL
12209                                            : REFF),
12210                                     num);
12211                     *flagp |= HASWIDTH;
12212
12213                     /* override incorrect value set in reganode MJD */
12214                     Set_Node_Offset(ret, parse_start+1);
12215                     Set_Node_Cur_Length(ret, parse_start);
12216                     RExC_parse--;
12217                     nextchar(pRExC_state);
12218                 }
12219             }
12220             break;
12221         case '\0':
12222             if (RExC_parse >= RExC_end)
12223                 FAIL("Trailing \\");
12224             /* FALLTHROUGH */
12225         default:
12226             /* Do not generate "unrecognized" warnings here, we fall
12227                back into the quick-grab loop below */
12228             parse_start--;
12229             goto defchar;
12230         }
12231         break;
12232
12233     case '#':
12234         if (RExC_flags & RXf_PMf_EXTENDED) {
12235             RExC_parse = reg_skipcomment( pRExC_state, RExC_parse );
12236             if (RExC_parse < RExC_end)
12237                 goto tryagain;
12238         }
12239         /* FALLTHROUGH */
12240
12241     default:
12242
12243             parse_start = RExC_parse - 1;
12244
12245             RExC_parse++;
12246
12247           defchar: {
12248             STRLEN len = 0;
12249             UV ender = 0;
12250             char *p;
12251             char *s;
12252 #define MAX_NODE_STRING_SIZE 127
12253             char foldbuf[MAX_NODE_STRING_SIZE+UTF8_MAXBYTES_CASE];
12254             char *s0;
12255             U8 upper_parse = MAX_NODE_STRING_SIZE;
12256             U8 node_type = compute_EXACTish(pRExC_state);
12257             bool next_is_quantifier;
12258             char * oldp = NULL;
12259
12260             /* We can convert EXACTF nodes to EXACTFU if they contain only
12261              * characters that match identically regardless of the target
12262              * string's UTF8ness.  The reason to do this is that EXACTF is not
12263              * trie-able, EXACTFU is.
12264              *
12265              * Similarly, we can convert EXACTFL nodes to EXACTFU if they
12266              * contain only above-Latin1 characters (hence must be in UTF8),
12267              * which don't participate in folds with Latin1-range characters,
12268              * as the latter's folds aren't known until runtime.  (We don't
12269              * need to figure this out until pass 2) */
12270             bool maybe_exactfu = PASS2
12271                                && (node_type == EXACTF || node_type == EXACTFL);
12272
12273             /* If a folding node contains only code points that don't
12274              * participate in folds, it can be changed into an EXACT node,
12275              * which allows the optimizer more things to look for */
12276             bool maybe_exact;
12277
12278             ret = reg_node(pRExC_state, node_type);
12279
12280             /* In pass1, folded, we use a temporary buffer instead of the
12281              * actual node, as the node doesn't exist yet */
12282             s = (SIZE_ONLY && FOLD) ? foldbuf : STRING(ret);
12283
12284             s0 = s;
12285
12286           reparse:
12287
12288             /* We do the EXACTFish to EXACT node only if folding.  (And we
12289              * don't need to figure this out until pass 2) */
12290             maybe_exact = FOLD && PASS2;
12291
12292             /* XXX The node can hold up to 255 bytes, yet this only goes to
12293              * 127.  I (khw) do not know why.  Keeping it somewhat less than
12294              * 255 allows us to not have to worry about overflow due to
12295              * converting to utf8 and fold expansion, but that value is
12296              * 255-UTF8_MAXBYTES_CASE.  join_exact() may join adjacent nodes
12297              * split up by this limit into a single one using the real max of
12298              * 255.  Even at 127, this breaks under rare circumstances.  If
12299              * folding, we do not want to split a node at a character that is a
12300              * non-final in a multi-char fold, as an input string could just
12301              * happen to want to match across the node boundary.  The join
12302              * would solve that problem if the join actually happens.  But a
12303              * series of more than two nodes in a row each of 127 would cause
12304              * the first join to succeed to get to 254, but then there wouldn't
12305              * be room for the next one, which could at be one of those split
12306              * multi-char folds.  I don't know of any fool-proof solution.  One
12307              * could back off to end with only a code point that isn't such a
12308              * non-final, but it is possible for there not to be any in the
12309              * entire node. */
12310             for (p = RExC_parse - 1;
12311                  len < upper_parse && p < RExC_end;
12312                  len++)
12313             {
12314                 oldp = p;
12315
12316                 if (RExC_flags & RXf_PMf_EXTENDED)
12317                     p = regpatws(pRExC_state, p,
12318                                           TRUE); /* means recognize comments */
12319                 switch ((U8)*p) {
12320                 case '^':
12321                 case '$':
12322                 case '.':
12323                 case '[':
12324                 case '(':
12325                 case ')':
12326                 case '|':
12327                     goto loopdone;
12328                 case '\\':
12329                     /* Literal Escapes Switch
12330
12331                        This switch is meant to handle escape sequences that
12332                        resolve to a literal character.
12333
12334                        Every escape sequence that represents something
12335                        else, like an assertion or a char class, is handled
12336                        in the switch marked 'Special Escapes' above in this
12337                        routine, but also has an entry here as anything that
12338                        isn't explicitly mentioned here will be treated as
12339                        an unescaped equivalent literal.
12340                     */
12341
12342                     switch ((U8)*++p) {
12343                     /* These are all the special escapes. */
12344                     case 'A':             /* Start assertion */
12345                     case 'b': case 'B':   /* Word-boundary assertion*/
12346                     case 'C':             /* Single char !DANGEROUS! */
12347                     case 'd': case 'D':   /* digit class */
12348                     case 'g': case 'G':   /* generic-backref, pos assertion */
12349                     case 'h': case 'H':   /* HORIZWS */
12350                     case 'k': case 'K':   /* named backref, keep marker */
12351                     case 'p': case 'P':   /* Unicode property */
12352                               case 'R':   /* LNBREAK */
12353                     case 's': case 'S':   /* space class */
12354                     case 'v': case 'V':   /* VERTWS */
12355                     case 'w': case 'W':   /* word class */
12356                     case 'X':             /* eXtended Unicode "combining
12357                                              character sequence" */
12358                     case 'z': case 'Z':   /* End of line/string assertion */
12359                         --p;
12360                         goto loopdone;
12361
12362                     /* Anything after here is an escape that resolves to a
12363                        literal. (Except digits, which may or may not)
12364                      */
12365                     case 'n':
12366                         ender = '\n';
12367                         p++;
12368                         break;
12369                     case 'N': /* Handle a single-code point named character. */
12370                         RExC_parse = p + 1;
12371                         if (! grok_bslash_N(pRExC_state,
12372                                             NULL,   /* Fail if evaluates to
12373                                                        anything other than a
12374                                                        single code point */
12375                                             &ender, /* The returned single code
12376                                                        point */
12377                                             NULL,   /* Don't need a count of
12378                                                        how many code points */
12379                                             flagp,
12380                                             depth)
12381                         ) {
12382                             if (*flagp & RESTART_UTF8)
12383                                 FAIL("panic: grok_bslash_N set RESTART_UTF8");
12384
12385                             /* Here, it wasn't a single code point.  Go close
12386                              * up this EXACTish node.  The switch() prior to
12387                              * this switch handles the other cases */
12388                             RExC_parse = p = oldp;
12389                             goto loopdone;
12390                         }
12391                         p = RExC_parse;
12392                         if (ender > 0xff) {
12393                             REQUIRE_UTF8;
12394                         }
12395                         break;
12396                     case 'r':
12397                         ender = '\r';
12398                         p++;
12399                         break;
12400                     case 't':
12401                         ender = '\t';
12402                         p++;
12403                         break;
12404                     case 'f':
12405                         ender = '\f';
12406                         p++;
12407                         break;
12408                     case 'e':
12409                         ender = ESC_NATIVE;
12410                         p++;
12411                         break;
12412                     case 'a':
12413                         ender = '\a';
12414                         p++;
12415                         break;
12416                     case 'o':
12417                         {
12418                             UV result;
12419                             const char* error_msg;
12420
12421                             bool valid = grok_bslash_o(&p,
12422                                                        &result,
12423                                                        &error_msg,
12424                                                        PASS2, /* out warnings */
12425                                                        (bool) RExC_strict,
12426                                                        TRUE, /* Output warnings
12427                                                                 for non-
12428                                                                 portables */
12429                                                        UTF);
12430                             if (! valid) {
12431                                 RExC_parse = p; /* going to die anyway; point
12432                                                    to exact spot of failure */
12433                                 vFAIL(error_msg);
12434                             }
12435                             ender = result;
12436                             if (IN_ENCODING && ender < 0x100) {
12437                                 goto recode_encoding;
12438                             }
12439                             if (ender > 0xff) {
12440                                 REQUIRE_UTF8;
12441                             }
12442                             break;
12443                         }
12444                     case 'x':
12445                         {
12446                             UV result = UV_MAX; /* initialize to erroneous
12447                                                    value */
12448                             const char* error_msg;
12449
12450                             bool valid = grok_bslash_x(&p,
12451                                                        &result,
12452                                                        &error_msg,
12453                                                        PASS2, /* out warnings */
12454                                                        (bool) RExC_strict,
12455                                                        TRUE, /* Silence warnings
12456                                                                 for non-
12457                                                                 portables */
12458                                                        UTF);
12459                             if (! valid) {
12460                                 RExC_parse = p; /* going to die anyway; point
12461                                                    to exact spot of failure */
12462                                 vFAIL(error_msg);
12463                             }
12464                             ender = result;
12465
12466                             if (ender < 0x100) {
12467 #ifdef EBCDIC
12468                                 if (RExC_recode_x_to_native) {
12469                                     ender = LATIN1_TO_NATIVE(ender);
12470                                 }
12471                                 else
12472 #endif
12473                                 if (IN_ENCODING) {
12474                                     goto recode_encoding;
12475                                 }
12476                             }
12477                             else {
12478                                 REQUIRE_UTF8;
12479                             }
12480                             break;
12481                         }
12482                     case 'c':
12483                         p++;
12484                         ender = grok_bslash_c(*p++, PASS2);
12485                         break;
12486                     case '8': case '9': /* must be a backreference */
12487                         --p;
12488                         /* we have an escape like \8 which cannot be an octal escape
12489                          * so we exit the loop, and let the outer loop handle this
12490                          * escape which may or may not be a legitimate backref. */
12491                         goto loopdone;
12492                     case '1': case '2': case '3':case '4':
12493                     case '5': case '6': case '7':
12494                         /* When we parse backslash escapes there is ambiguity
12495                          * between backreferences and octal escapes. Any escape
12496                          * from \1 - \9 is a backreference, any multi-digit
12497                          * escape which does not start with 0 and which when
12498                          * evaluated as decimal could refer to an already
12499                          * parsed capture buffer is a back reference. Anything
12500                          * else is octal.
12501                          *
12502                          * Note this implies that \118 could be interpreted as
12503                          * 118 OR as "\11" . "8" depending on whether there
12504                          * were 118 capture buffers defined already in the
12505                          * pattern.  */
12506
12507                         /* NOTE, RExC_npar is 1 more than the actual number of
12508                          * parens we have seen so far, hence the < RExC_npar below. */
12509
12510                         if ( !isDIGIT(p[1]) || S_backref_value(p) < RExC_npar)
12511                         {  /* Not to be treated as an octal constant, go
12512                                    find backref */
12513                             --p;
12514                             goto loopdone;
12515                         }
12516                         /* FALLTHROUGH */
12517                     case '0':
12518                         {
12519                             I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
12520                             STRLEN numlen = 3;
12521                             ender = grok_oct(p, &numlen, &flags, NULL);
12522                             if (ender > 0xff) {
12523                                 REQUIRE_UTF8;
12524                             }
12525                             p += numlen;
12526                             if (PASS2   /* like \08, \178 */
12527                                 && numlen < 3
12528                                 && p < RExC_end
12529                                 && isDIGIT(*p) && ckWARN(WARN_REGEXP))
12530                             {
12531                                 reg_warn_non_literal_string(
12532                                          p + 1,
12533                                          form_short_octal_warning(p, numlen));
12534                             }
12535                         }
12536                         if (IN_ENCODING && ender < 0x100)
12537                             goto recode_encoding;
12538                         break;
12539                       recode_encoding:
12540                         if (! RExC_override_recoding) {
12541                             SV* enc = _get_encoding();
12542                             ender = reg_recode((const char)(U8)ender, &enc);
12543                             if (!enc && PASS2)
12544                                 ckWARNreg(p, "Invalid escape in the specified encoding");
12545                             REQUIRE_UTF8;
12546                         }
12547                         break;
12548                     case '\0':
12549                         if (p >= RExC_end)
12550                             FAIL("Trailing \\");
12551                         /* FALLTHROUGH */
12552                     default:
12553                         if (!SIZE_ONLY&& isALPHANUMERIC(*p)) {
12554                             /* Include any { following the alpha to emphasize
12555                              * that it could be part of an escape at some point
12556                              * in the future */
12557                             int len = (isALPHA(*p) && *(p + 1) == '{') ? 2 : 1;
12558                             ckWARN3reg(p + len, "Unrecognized escape \\%.*s passed through", len, p);
12559                         }
12560                         goto normal_default;
12561                     } /* End of switch on '\' */
12562                     break;
12563                 case '{':
12564                     /* Currently we don't warn when the lbrace is at the start
12565                      * of a construct.  This catches it in the middle of a
12566                      * literal string, or when its the first thing after
12567                      * something like "\b" */
12568                     if (! SIZE_ONLY
12569                         && (len || (p > RExC_start && isALPHA_A(*(p -1)))))
12570                     {
12571                         ckWARNregdep(p + 1, "Unescaped left brace in regex is deprecated, passed through");
12572                     }
12573                     /*FALLTHROUGH*/
12574                 default:    /* A literal character */
12575                   normal_default:
12576                     if (UTF8_IS_START(*p) && UTF) {
12577                         STRLEN numlen;
12578                         ender = utf8n_to_uvchr((U8*)p, RExC_end - p,
12579                                                &numlen, UTF8_ALLOW_DEFAULT);
12580                         p += numlen;
12581                     }
12582                     else
12583                         ender = (U8) *p++;
12584                     break;
12585                 } /* End of switch on the literal */
12586
12587                 /* Here, have looked at the literal character and <ender>
12588                  * contains its ordinal, <p> points to the character after it
12589                  */
12590
12591                 if ( RExC_flags & RXf_PMf_EXTENDED)
12592                     p = regpatws(pRExC_state, p,
12593                                           TRUE); /* means recognize comments */
12594
12595                 /* If the next thing is a quantifier, it applies to this
12596                  * character only, which means that this character has to be in
12597                  * its own node and can't just be appended to the string in an
12598                  * existing node, so if there are already other characters in
12599                  * the node, close the node with just them, and set up to do
12600                  * this character again next time through, when it will be the
12601                  * only thing in its new node */
12602                 if ((next_is_quantifier = (p < RExC_end && ISMULT2(p))) && len)
12603                 {
12604                     p = oldp;
12605                     goto loopdone;
12606                 }
12607
12608                 if (! FOLD) {  /* The simple case, just append the literal */
12609
12610                     /* In the sizing pass, we need only the size of the
12611                      * character we are appending, hence we can delay getting
12612                      * its representation until PASS2. */
12613                     if (SIZE_ONLY) {
12614                         if (UTF) {
12615                             const STRLEN unilen = UNISKIP(ender);
12616                             s += unilen;
12617
12618                             /* We have to subtract 1 just below (and again in
12619                              * the corresponding PASS2 code) because the loop
12620                              * increments <len> each time, as all but this path
12621                              * (and one other) through it add a single byte to
12622                              * the EXACTish node.  But these paths would change
12623                              * len to be the correct final value, so cancel out
12624                              * the increment that follows */
12625                             len += unilen - 1;
12626                         }
12627                         else {
12628                             s++;
12629                         }
12630                     } else { /* PASS2 */
12631                       not_fold_common:
12632                         if (UTF) {
12633                             U8 * new_s = uvchr_to_utf8((U8*)s, ender);
12634                             len += (char *) new_s - s - 1;
12635                             s = (char *) new_s;
12636                         }
12637                         else {
12638                             *(s++) = (char) ender;
12639                         }
12640                     }
12641                 }
12642                 else if (LOC && is_PROBLEMATIC_LOCALE_FOLD_cp(ender)) {
12643
12644                     /* Here are folding under /l, and the code point is
12645                      * problematic.  First, we know we can't simplify things */
12646                     maybe_exact = FALSE;
12647                     maybe_exactfu = FALSE;
12648
12649                     /* A problematic code point in this context means that its
12650                      * fold isn't known until runtime, so we can't fold it now.
12651                      * (The non-problematic code points are the above-Latin1
12652                      * ones that fold to also all above-Latin1.  Their folds
12653                      * don't vary no matter what the locale is.) But here we
12654                      * have characters whose fold depends on the locale.
12655                      * Unlike the non-folding case above, we have to keep track
12656                      * of these in the sizing pass, so that we can make sure we
12657                      * don't split too-long nodes in the middle of a potential
12658                      * multi-char fold.  And unlike the regular fold case
12659                      * handled in the else clauses below, we don't actually
12660                      * fold and don't have special cases to consider.  What we
12661                      * do for both passes is the PASS2 code for non-folding */
12662                     goto not_fold_common;
12663                 }
12664                 else /* A regular FOLD code point */
12665                     if (! ( UTF
12666 #if    UNICODE_MAJOR_VERSION > 3 /* no multifolds in early Unicode */   \
12667    || (UNICODE_MAJOR_VERSION == 3 && (   UNICODE_DOT_VERSION > 0)       \
12668                                       || UNICODE_DOT_DOT_VERSION > 0)
12669                         /* See comments for join_exact() as to why we fold this
12670                          * non-UTF at compile time */
12671                         || (node_type == EXACTFU
12672                             && ender == LATIN_SMALL_LETTER_SHARP_S)
12673 #endif
12674                 )) {
12675                     /* Here, are folding and are not UTF-8 encoded; therefore
12676                      * the character must be in the range 0-255, and is not /l
12677                      * (Not /l because we already handled these under /l in
12678                      * is_PROBLEMATIC_LOCALE_FOLD_cp) */
12679                     if (IS_IN_SOME_FOLD_L1(ender)) {
12680                         maybe_exact = FALSE;
12681
12682                         /* See if the character's fold differs between /d and
12683                          * /u.  This includes the multi-char fold SHARP S to
12684                          * 'ss' */
12685                         if (maybe_exactfu
12686                             && (PL_fold[ender] != PL_fold_latin1[ender]
12687 #if    UNICODE_MAJOR_VERSION > 3 /* no multifolds in early Unicode */   \
12688    || (UNICODE_MAJOR_VERSION == 3 && (   UNICODE_DOT_VERSION > 0)       \
12689                                       || UNICODE_DOT_DOT_VERSION > 0)
12690                                 || ender == LATIN_SMALL_LETTER_SHARP_S
12691                                 || (len > 0
12692                                    && isALPHA_FOLD_EQ(ender, 's')
12693                                    && isALPHA_FOLD_EQ(*(s-1), 's'))
12694 #endif
12695                         )) {
12696                             maybe_exactfu = FALSE;
12697                         }
12698                     }
12699
12700                     /* Even when folding, we store just the input character, as
12701                      * we have an array that finds its fold quickly */
12702                     *(s++) = (char) ender;
12703                 }
12704                 else {  /* FOLD and UTF */
12705                     /* Unlike the non-fold case, we do actually have to
12706                      * calculate the results here in pass 1.  This is for two
12707                      * reasons, the folded length may be longer than the
12708                      * unfolded, and we have to calculate how many EXACTish
12709                      * nodes it will take; and we may run out of room in a node
12710                      * in the middle of a potential multi-char fold, and have
12711                      * to back off accordingly.  */
12712
12713                     UV folded;
12714                     if (isASCII_uni(ender)) {
12715                         folded = toFOLD(ender);
12716                         *(s)++ = (U8) folded;
12717                     }
12718                     else {
12719                         STRLEN foldlen;
12720
12721                         folded = _to_uni_fold_flags(
12722                                      ender,
12723                                      (U8 *) s,
12724                                      &foldlen,
12725                                      FOLD_FLAGS_FULL | ((ASCII_FOLD_RESTRICTED)
12726                                                         ? FOLD_FLAGS_NOMIX_ASCII
12727                                                         : 0));
12728                         s += foldlen;
12729
12730                         /* The loop increments <len> each time, as all but this
12731                          * path (and one other) through it add a single byte to
12732                          * the EXACTish node.  But this one has changed len to
12733                          * be the correct final value, so subtract one to
12734                          * cancel out the increment that follows */
12735                         len += foldlen - 1;
12736                     }
12737                     /* If this node only contains non-folding code points so
12738                      * far, see if this new one is also non-folding */
12739                     if (maybe_exact) {
12740                         if (folded != ender) {
12741                             maybe_exact = FALSE;
12742                         }
12743                         else {
12744                             /* Here the fold is the original; we have to check
12745                              * further to see if anything folds to it */
12746                             if (_invlist_contains_cp(PL_utf8_foldable,
12747                                                         ender))
12748                             {
12749                                 maybe_exact = FALSE;
12750                             }
12751                         }
12752                     }
12753                     ender = folded;
12754                 }
12755
12756                 if (next_is_quantifier) {
12757
12758                     /* Here, the next input is a quantifier, and to get here,
12759                      * the current character is the only one in the node.
12760                      * Also, here <len> doesn't include the final byte for this
12761                      * character */
12762                     len++;
12763                     goto loopdone;
12764                 }
12765
12766             } /* End of loop through literal characters */
12767
12768             /* Here we have either exhausted the input or ran out of room in
12769              * the node.  (If we encountered a character that can't be in the
12770              * node, transfer is made directly to <loopdone>, and so we
12771              * wouldn't have fallen off the end of the loop.)  In the latter
12772              * case, we artificially have to split the node into two, because
12773              * we just don't have enough space to hold everything.  This
12774              * creates a problem if the final character participates in a
12775              * multi-character fold in the non-final position, as a match that
12776              * should have occurred won't, due to the way nodes are matched,
12777              * and our artificial boundary.  So back off until we find a non-
12778              * problematic character -- one that isn't at the beginning or
12779              * middle of such a fold.  (Either it doesn't participate in any
12780              * folds, or appears only in the final position of all the folds it
12781              * does participate in.)  A better solution with far fewer false
12782              * positives, and that would fill the nodes more completely, would
12783              * be to actually have available all the multi-character folds to
12784              * test against, and to back-off only far enough to be sure that
12785              * this node isn't ending with a partial one.  <upper_parse> is set
12786              * further below (if we need to reparse the node) to include just
12787              * up through that final non-problematic character that this code
12788              * identifies, so when it is set to less than the full node, we can
12789              * skip the rest of this */
12790             if (FOLD && p < RExC_end && upper_parse == MAX_NODE_STRING_SIZE) {
12791
12792                 const STRLEN full_len = len;
12793
12794                 assert(len >= MAX_NODE_STRING_SIZE);
12795
12796                 /* Here, <s> points to the final byte of the final character.
12797                  * Look backwards through the string until find a non-
12798                  * problematic character */
12799
12800                 if (! UTF) {
12801
12802                     /* This has no multi-char folds to non-UTF characters */
12803                     if (ASCII_FOLD_RESTRICTED) {
12804                         goto loopdone;
12805                     }
12806
12807                     while (--s >= s0 && IS_NON_FINAL_FOLD(*s)) { }
12808                     len = s - s0 + 1;
12809                 }
12810                 else {
12811                     if (!  PL_NonL1NonFinalFold) {
12812                         PL_NonL1NonFinalFold = _new_invlist_C_array(
12813                                         NonL1_Perl_Non_Final_Folds_invlist);
12814                     }
12815
12816                     /* Point to the first byte of the final character */
12817                     s = (char *) utf8_hop((U8 *) s, -1);
12818
12819                     while (s >= s0) {   /* Search backwards until find
12820                                            non-problematic char */
12821                         if (UTF8_IS_INVARIANT(*s)) {
12822
12823                             /* There are no ascii characters that participate
12824                              * in multi-char folds under /aa.  In EBCDIC, the
12825                              * non-ascii invariants are all control characters,
12826                              * so don't ever participate in any folds. */
12827                             if (ASCII_FOLD_RESTRICTED
12828                                 || ! IS_NON_FINAL_FOLD(*s))
12829                             {
12830                                 break;
12831                             }
12832                         }
12833                         else if (UTF8_IS_DOWNGRADEABLE_START(*s)) {
12834                             if (! IS_NON_FINAL_FOLD(TWO_BYTE_UTF8_TO_NATIVE(
12835                                                                   *s, *(s+1))))
12836                             {
12837                                 break;
12838                             }
12839                         }
12840                         else if (! _invlist_contains_cp(
12841                                         PL_NonL1NonFinalFold,
12842                                         valid_utf8_to_uvchr((U8 *) s, NULL)))
12843                         {
12844                             break;
12845                         }
12846
12847                         /* Here, the current character is problematic in that
12848                          * it does occur in the non-final position of some
12849                          * fold, so try the character before it, but have to
12850                          * special case the very first byte in the string, so
12851                          * we don't read outside the string */
12852                         s = (s == s0) ? s -1 : (char *) utf8_hop((U8 *) s, -1);
12853                     } /* End of loop backwards through the string */
12854
12855                     /* If there were only problematic characters in the string,
12856                      * <s> will point to before s0, in which case the length
12857                      * should be 0, otherwise include the length of the
12858                      * non-problematic character just found */
12859                     len = (s < s0) ? 0 : s - s0 + UTF8SKIP(s);
12860                 }
12861
12862                 /* Here, have found the final character, if any, that is
12863                  * non-problematic as far as ending the node without splitting
12864                  * it across a potential multi-char fold.  <len> contains the
12865                  * number of bytes in the node up-to and including that
12866                  * character, or is 0 if there is no such character, meaning
12867                  * the whole node contains only problematic characters.  In
12868                  * this case, give up and just take the node as-is.  We can't
12869                  * do any better */
12870                 if (len == 0) {
12871                     len = full_len;
12872
12873                     /* If the node ends in an 's' we make sure it stays EXACTF,
12874                      * as if it turns into an EXACTFU, it could later get
12875                      * joined with another 's' that would then wrongly match
12876                      * the sharp s */
12877                     if (maybe_exactfu && isALPHA_FOLD_EQ(ender, 's'))
12878                     {
12879                         maybe_exactfu = FALSE;
12880                     }
12881                 } else {
12882
12883                     /* Here, the node does contain some characters that aren't
12884                      * problematic.  If one such is the final character in the
12885                      * node, we are done */
12886                     if (len == full_len) {
12887                         goto loopdone;
12888                     }
12889                     else if (len + ((UTF) ? UTF8SKIP(s) : 1) == full_len) {
12890
12891                         /* If the final character is problematic, but the
12892                          * penultimate is not, back-off that last character to
12893                          * later start a new node with it */
12894                         p = oldp;
12895                         goto loopdone;
12896                     }
12897
12898                     /* Here, the final non-problematic character is earlier
12899                      * in the input than the penultimate character.  What we do
12900                      * is reparse from the beginning, going up only as far as
12901                      * this final ok one, thus guaranteeing that the node ends
12902                      * in an acceptable character.  The reason we reparse is
12903                      * that we know how far in the character is, but we don't
12904                      * know how to correlate its position with the input parse.
12905                      * An alternate implementation would be to build that
12906                      * correlation as we go along during the original parse,
12907                      * but that would entail extra work for every node, whereas
12908                      * this code gets executed only when the string is too
12909                      * large for the node, and the final two characters are
12910                      * problematic, an infrequent occurrence.  Yet another
12911                      * possible strategy would be to save the tail of the
12912                      * string, and the next time regatom is called, initialize
12913                      * with that.  The problem with this is that unless you
12914                      * back off one more character, you won't be guaranteed
12915                      * regatom will get called again, unless regbranch,
12916                      * regpiece ... are also changed.  If you do back off that
12917                      * extra character, so that there is input guaranteed to
12918                      * force calling regatom, you can't handle the case where
12919                      * just the first character in the node is acceptable.  I
12920                      * (khw) decided to try this method which doesn't have that
12921                      * pitfall; if performance issues are found, we can do a
12922                      * combination of the current approach plus that one */
12923                     upper_parse = len;
12924                     len = 0;
12925                     s = s0;
12926                     goto reparse;
12927                 }
12928             }   /* End of verifying node ends with an appropriate char */
12929
12930           loopdone:   /* Jumped to when encounters something that shouldn't be
12931                          in the node */
12932
12933             /* I (khw) don't know if you can get here with zero length, but the
12934              * old code handled this situation by creating a zero-length EXACT
12935              * node.  Might as well be NOTHING instead */
12936             if (len == 0) {
12937                 OP(ret) = NOTHING;
12938             }
12939             else {
12940                 if (FOLD) {
12941                     /* If 'maybe_exact' is still set here, means there are no
12942                      * code points in the node that participate in folds;
12943                      * similarly for 'maybe_exactfu' and code points that match
12944                      * differently depending on UTF8ness of the target string
12945                      * (for /u), or depending on locale for /l */
12946                     if (maybe_exact) {
12947                         OP(ret) = (LOC)
12948                                   ? EXACTL
12949                                   : EXACT;
12950                     }
12951                     else if (maybe_exactfu) {
12952                         OP(ret) = (LOC)
12953                                   ? EXACTFLU8
12954                                   : EXACTFU;
12955                     }
12956                 }
12957                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, len, ender,
12958                                            FALSE /* Don't look to see if could
12959                                                     be turned into an EXACT
12960                                                     node, as we have already
12961                                                     computed that */
12962                                           );
12963             }
12964
12965             RExC_parse = p - 1;
12966             Set_Node_Cur_Length(ret, parse_start);
12967             nextchar(pRExC_state);
12968             {
12969                 /* len is STRLEN which is unsigned, need to copy to signed */
12970                 IV iv = len;
12971                 if (iv < 0)
12972                     vFAIL("Internal disaster");
12973             }
12974
12975         } /* End of label 'defchar:' */
12976         break;
12977     } /* End of giant switch on input character */
12978
12979     return(ret);
12980 }
12981
12982 STATIC char *
12983 S_regpatws(RExC_state_t *pRExC_state, char *p , const bool recognize_comment )
12984 {
12985     /* Returns the next non-pattern-white space, non-comment character (the
12986      * latter only if 'recognize_comment is true) in the string p, which is
12987      * ended by RExC_end.  See also reg_skipcomment */
12988     const char *e = RExC_end;
12989
12990     PERL_ARGS_ASSERT_REGPATWS;
12991
12992     while (p < e) {
12993         STRLEN len;
12994         if ((len = is_PATWS_safe(p, e, UTF))) {
12995             p += len;
12996         }
12997         else if (recognize_comment && *p == '#') {
12998             p = reg_skipcomment(pRExC_state, p);
12999         }
13000         else
13001             break;
13002     }
13003     return p;
13004 }
13005
13006 STATIC void
13007 S_populate_ANYOF_from_invlist(pTHX_ regnode *node, SV** invlist_ptr)
13008 {
13009     /* Uses the inversion list '*invlist_ptr' to populate the ANYOF 'node'.  It
13010      * sets up the bitmap and any flags, removing those code points from the
13011      * inversion list, setting it to NULL should it become completely empty */
13012
13013     PERL_ARGS_ASSERT_POPULATE_ANYOF_FROM_INVLIST;
13014     assert(PL_regkind[OP(node)] == ANYOF);
13015
13016     ANYOF_BITMAP_ZERO(node);
13017     if (*invlist_ptr) {
13018
13019         /* This gets set if we actually need to modify things */
13020         bool change_invlist = FALSE;
13021
13022         UV start, end;
13023
13024         /* Start looking through *invlist_ptr */
13025         invlist_iterinit(*invlist_ptr);
13026         while (invlist_iternext(*invlist_ptr, &start, &end)) {
13027             UV high;
13028             int i;
13029
13030             if (end == UV_MAX && start <= NUM_ANYOF_CODE_POINTS) {
13031                 ANYOF_FLAGS(node) |= ANYOF_MATCHES_ALL_ABOVE_BITMAP;
13032             }
13033             else if (end >= NUM_ANYOF_CODE_POINTS) {
13034                 ANYOF_FLAGS(node) |= ANYOF_HAS_UTF8_NONBITMAP_MATCHES;
13035             }
13036
13037             /* Quit if are above what we should change */
13038             if (start >= NUM_ANYOF_CODE_POINTS) {
13039                 break;
13040             }
13041
13042             change_invlist = TRUE;
13043
13044             /* Set all the bits in the range, up to the max that we are doing */
13045             high = (end < NUM_ANYOF_CODE_POINTS - 1)
13046                    ? end
13047                    : NUM_ANYOF_CODE_POINTS - 1;
13048             for (i = start; i <= (int) high; i++) {
13049                 if (! ANYOF_BITMAP_TEST(node, i)) {
13050                     ANYOF_BITMAP_SET(node, i);
13051                 }
13052             }
13053         }
13054         invlist_iterfinish(*invlist_ptr);
13055
13056         /* Done with loop; remove any code points that are in the bitmap from
13057          * *invlist_ptr; similarly for code points above the bitmap if we have
13058          * a flag to match all of them anyways */
13059         if (change_invlist) {
13060             _invlist_subtract(*invlist_ptr, PL_InBitmap, invlist_ptr);
13061         }
13062         if (ANYOF_FLAGS(node) & ANYOF_MATCHES_ALL_ABOVE_BITMAP) {
13063             _invlist_intersection(*invlist_ptr, PL_InBitmap, invlist_ptr);
13064         }
13065
13066         /* If have completely emptied it, remove it completely */
13067         if (_invlist_len(*invlist_ptr) == 0) {
13068             SvREFCNT_dec_NN(*invlist_ptr);
13069             *invlist_ptr = NULL;
13070         }
13071     }
13072 }
13073
13074 /* Parse POSIX character classes: [[:foo:]], [[=foo=]], [[.foo.]].
13075    Character classes ([:foo:]) can also be negated ([:^foo:]).
13076    Returns a named class id (ANYOF_XXX) if successful, -1 otherwise.
13077    Equivalence classes ([=foo=]) and composites ([.foo.]) are parsed,
13078    but trigger failures because they are currently unimplemented. */
13079
13080 #define POSIXCC_DONE(c)   ((c) == ':')
13081 #define POSIXCC_NOTYET(c) ((c) == '=' || (c) == '.')
13082 #define POSIXCC(c) (POSIXCC_DONE(c) || POSIXCC_NOTYET(c))
13083
13084 PERL_STATIC_INLINE I32
13085 S_regpposixcc(pTHX_ RExC_state_t *pRExC_state, I32 value, const bool strict)
13086 {
13087     I32 namedclass = OOB_NAMEDCLASS;
13088
13089     PERL_ARGS_ASSERT_REGPPOSIXCC;
13090
13091     if (value == '[' && RExC_parse + 1 < RExC_end &&
13092         /* I smell either [: or [= or [. -- POSIX has been here, right? */
13093         POSIXCC(UCHARAT(RExC_parse)))
13094     {
13095         const char c = UCHARAT(RExC_parse);
13096         char* const s = RExC_parse++;
13097
13098         while (RExC_parse < RExC_end && UCHARAT(RExC_parse) != c)
13099             RExC_parse++;
13100         if (RExC_parse == RExC_end) {
13101             if (strict) {
13102
13103                 /* Try to give a better location for the error (than the end of
13104                  * the string) by looking for the matching ']' */
13105                 RExC_parse = s;
13106                 while (RExC_parse < RExC_end && UCHARAT(RExC_parse) != ']') {
13107                     RExC_parse++;
13108                 }
13109                 vFAIL2("Unmatched '%c' in POSIX class", c);
13110             }
13111             /* Grandfather lone [:, [=, [. */
13112             RExC_parse = s;
13113         }
13114         else {
13115             const char* const t = RExC_parse++; /* skip over the c */
13116             assert(*t == c);
13117
13118             if (UCHARAT(RExC_parse) == ']') {
13119                 const char *posixcc = s + 1;
13120                 RExC_parse++; /* skip over the ending ] */
13121
13122                 if (*s == ':') {
13123                     const I32 complement = *posixcc == '^' ? *posixcc++ : 0;
13124                     const I32 skip = t - posixcc;
13125
13126                     /* Initially switch on the length of the name.  */
13127                     switch (skip) {
13128                     case 4:
13129                         if (memEQ(posixcc, "word", 4)) /* this is not POSIX,
13130                                                           this is the Perl \w
13131                                                         */
13132                             namedclass = ANYOF_WORDCHAR;
13133                         break;
13134                     case 5:
13135                         /* Names all of length 5.  */
13136                         /* alnum alpha ascii blank cntrl digit graph lower
13137                            print punct space upper  */
13138                         /* Offset 4 gives the best switch position.  */
13139                         switch (posixcc[4]) {
13140                         case 'a':
13141                             if (memEQ(posixcc, "alph", 4)) /* alpha */
13142                                 namedclass = ANYOF_ALPHA;
13143                             break;
13144                         case 'e':
13145                             if (memEQ(posixcc, "spac", 4)) /* space */
13146                                 namedclass = ANYOF_SPACE;
13147                             break;
13148                         case 'h':
13149                             if (memEQ(posixcc, "grap", 4)) /* graph */
13150                                 namedclass = ANYOF_GRAPH;
13151                             break;
13152                         case 'i':
13153                             if (memEQ(posixcc, "asci", 4)) /* ascii */
13154                                 namedclass = ANYOF_ASCII;
13155                             break;
13156                         case 'k':
13157                             if (memEQ(posixcc, "blan", 4)) /* blank */
13158                                 namedclass = ANYOF_BLANK;
13159                             break;
13160                         case 'l':
13161                             if (memEQ(posixcc, "cntr", 4)) /* cntrl */
13162                                 namedclass = ANYOF_CNTRL;
13163                             break;
13164                         case 'm':
13165                             if (memEQ(posixcc, "alnu", 4)) /* alnum */
13166                                 namedclass = ANYOF_ALPHANUMERIC;
13167                             break;
13168                         case 'r':
13169                             if (memEQ(posixcc, "lowe", 4)) /* lower */
13170                                 namedclass = (FOLD) ? ANYOF_CASED : ANYOF_LOWER;
13171                             else if (memEQ(posixcc, "uppe", 4)) /* upper */
13172                                 namedclass = (FOLD) ? ANYOF_CASED : ANYOF_UPPER;
13173                             break;
13174                         case 't':
13175                             if (memEQ(posixcc, "digi", 4)) /* digit */
13176                                 namedclass = ANYOF_DIGIT;
13177                             else if (memEQ(posixcc, "prin", 4)) /* print */
13178                                 namedclass = ANYOF_PRINT;
13179                             else if (memEQ(posixcc, "punc", 4)) /* punct */
13180                                 namedclass = ANYOF_PUNCT;
13181                             break;
13182                         }
13183                         break;
13184                     case 6:
13185                         if (memEQ(posixcc, "xdigit", 6))
13186                             namedclass = ANYOF_XDIGIT;
13187                         break;
13188                     }
13189
13190                     if (namedclass == OOB_NAMEDCLASS)
13191                         vFAIL2utf8f(
13192                             "POSIX class [:%"UTF8f":] unknown",
13193                             UTF8fARG(UTF, t - s - 1, s + 1));
13194
13195                     /* The #defines are structured so each complement is +1 to
13196                      * the normal one */
13197                     if (complement) {
13198                         namedclass++;
13199                     }
13200                     assert (posixcc[skip] == ':');
13201                     assert (posixcc[skip+1] == ']');
13202                 } else if (!SIZE_ONLY) {
13203                     /* [[=foo=]] and [[.foo.]] are still future. */
13204
13205                     /* adjust RExC_parse so the warning shows after
13206                        the class closes */
13207                     while (UCHARAT(RExC_parse) && UCHARAT(RExC_parse) != ']')
13208                         RExC_parse++;
13209                     vFAIL3("POSIX syntax [%c %c] is reserved for future extensions", c, c);
13210                 }
13211             } else {
13212                 /* Maternal grandfather:
13213                  * "[:" ending in ":" but not in ":]" */
13214                 if (strict) {
13215                     vFAIL("Unmatched '[' in POSIX class");
13216                 }
13217
13218                 /* Grandfather lone [:, [=, [. */
13219                 RExC_parse = s;
13220             }
13221         }
13222     }
13223
13224     return namedclass;
13225 }
13226
13227 STATIC bool
13228 S_could_it_be_a_POSIX_class(RExC_state_t *pRExC_state)
13229 {
13230     /* This applies some heuristics at the current parse position (which should
13231      * be at a '[') to see if what follows might be intended to be a [:posix:]
13232      * class.  It returns true if it really is a posix class, of course, but it
13233      * also can return true if it thinks that what was intended was a posix
13234      * class that didn't quite make it.
13235      *
13236      * It will return true for
13237      *      [:alphanumerics:
13238      *      [:alphanumerics]  (as long as the ] isn't followed immediately by a
13239      *                         ')' indicating the end of the (?[
13240      *      [:any garbage including %^&$ punctuation:]
13241      *
13242      * This is designed to be called only from S_handle_regex_sets; it could be
13243      * easily adapted to be called from the spot at the beginning of regclass()
13244      * that checks to see in a normal bracketed class if the surrounding []
13245      * have been omitted ([:word:] instead of [[:word:]]).  But doing so would
13246      * change long-standing behavior, so I (khw) didn't do that */
13247     char* p = RExC_parse + 1;
13248     char first_char = *p;
13249
13250     PERL_ARGS_ASSERT_COULD_IT_BE_A_POSIX_CLASS;
13251
13252     assert(*(p - 1) == '[');
13253
13254     if (! POSIXCC(first_char)) {
13255         return FALSE;
13256     }
13257
13258     p++;
13259     while (p < RExC_end && isWORDCHAR(*p)) p++;
13260
13261     if (p >= RExC_end) {
13262         return FALSE;
13263     }
13264
13265     if (p - RExC_parse > 2    /* Got at least 1 word character */
13266         && (*p == first_char
13267             || (*p == ']' && p + 1 < RExC_end && *(p + 1) != ')')))
13268     {
13269         return TRUE;
13270     }
13271
13272     p = (char *) memchr(RExC_parse, ']', RExC_end - RExC_parse);
13273
13274     return (p
13275             && p - RExC_parse > 2 /* [:] evaluates to colon;
13276                                       [::] is a bad posix class. */
13277             && first_char == *(p - 1));
13278 }
13279
13280 STATIC unsigned  int
13281 S_regex_set_precedence(const U8 my_operator) {
13282
13283     /* Returns the precedence in the (?[...]) construct of the input operator,
13284      * specified by its character representation.  The precedence follows
13285      * general Perl rules, but it extends this so that ')' and ']' have (low)
13286      * precedence even though they aren't really operators */
13287
13288     switch (my_operator) {
13289         case '!':
13290             return 5;
13291         case '&':
13292             return 4;
13293         case '^':
13294         case '|':
13295         case '+':
13296         case '-':
13297             return 3;
13298         case ')':
13299             return 2;
13300         case ']':
13301             return 1;
13302     }
13303
13304     NOT_REACHED; /* NOTREACHED */
13305     return 0;   /* Silence compiler warning */
13306 }
13307
13308 STATIC regnode *
13309 S_handle_regex_sets(pTHX_ RExC_state_t *pRExC_state, SV** return_invlist,
13310                     I32 *flagp, U32 depth,
13311                     char * const oregcomp_parse)
13312 {
13313     /* Handle the (?[...]) construct to do set operations */
13314
13315     U8 curchar;                     /* Current character being parsed */
13316     UV start, end;                  /* End points of code point ranges */
13317     SV* final = NULL;               /* The end result inversion list */
13318     SV* result_string;              /* 'final' stringified */
13319     AV* stack;                      /* stack of operators and operands not yet
13320                                        resolved */
13321     AV* fence_stack = NULL;         /* A stack containing the positions in
13322                                        'stack' of where the undealt-with left
13323                                        parens would be if they were actually
13324                                        put there */
13325     IV fence = 0;                   /* Position of where most recent undealt-
13326                                        with left paren in stack is; -1 if none.
13327                                      */
13328     STRLEN len;                     /* Temporary */
13329     regnode* node;                  /* Temporary, and final regnode returned by
13330                                        this function */
13331     const bool save_fold = FOLD;    /* Temporary */
13332     char *save_end, *save_parse;    /* Temporaries */
13333
13334     GET_RE_DEBUG_FLAGS_DECL;
13335
13336     PERL_ARGS_ASSERT_HANDLE_REGEX_SETS;
13337
13338     if (LOC) {  /* XXX could make valid in UTF-8 locales */
13339         vFAIL("(?[...]) not valid in locale");
13340     }
13341     RExC_uni_semantics = 1;     /* The use of this operator implies /u.  This
13342                                    is required so that the compile time values
13343                                    are valid in all runtime cases */
13344
13345     /* This will return only an ANYOF regnode, or (unlikely) something smaller
13346      * (such as EXACT).  Thus we can skip most everything if just sizing.  We
13347      * call regclass to handle '[]' so as to not have to reinvent its parsing
13348      * rules here (throwing away the size it computes each time).  And, we exit
13349      * upon an unescaped ']' that isn't one ending a regclass.  To do both
13350      * these things, we need to realize that something preceded by a backslash
13351      * is escaped, so we have to keep track of backslashes */
13352     if (SIZE_ONLY) {
13353         UV depth = 0; /* how many nested (?[...]) constructs */
13354
13355         while (RExC_parse < RExC_end) {
13356             SV* current = NULL;
13357             RExC_parse = regpatws(pRExC_state, RExC_parse,
13358                                           TRUE); /* means recognize comments */
13359             switch (*RExC_parse) {
13360                 case '?':
13361                     if (RExC_parse[1] == '[') depth++, RExC_parse++;
13362                     /* FALLTHROUGH */
13363                 default:
13364                     break;
13365                 case '\\':
13366                     /* Skip the next byte (which could cause us to end up in
13367                      * the middle of a UTF-8 character, but since none of those
13368                      * are confusable with anything we currently handle in this
13369                      * switch (invariants all), it's safe.  We'll just hit the
13370                      * default: case next time and keep on incrementing until
13371                      * we find one of the invariants we do handle. */
13372                     RExC_parse++;
13373                     break;
13374                 case '[':
13375                 {
13376                     /* If this looks like it is a [:posix:] class, leave the
13377                      * parse pointer at the '[' to fool regclass() into
13378                      * thinking it is part of a '[[:posix:]]'.  That function
13379                      * will use strict checking to force a syntax error if it
13380                      * doesn't work out to a legitimate class */
13381                     bool is_posix_class
13382                                     = could_it_be_a_POSIX_class(pRExC_state);
13383                     if (! is_posix_class) {
13384                         RExC_parse++;
13385                     }
13386
13387                     /* regclass() can only return RESTART_UTF8 if multi-char
13388                        folds are allowed.  */
13389                     if (!regclass(pRExC_state, flagp,depth+1,
13390                                   is_posix_class, /* parse the whole char
13391                                                      class only if not a
13392                                                      posix class */
13393                                   FALSE, /* don't allow multi-char folds */
13394                                   TRUE, /* silence non-portable warnings. */
13395                                   TRUE, /* strict */
13396                                   &current
13397                                  ))
13398                         FAIL2("panic: regclass returned NULL to handle_sets, "
13399                               "flags=%#"UVxf"", (UV) *flagp);
13400
13401                     /* function call leaves parse pointing to the ']', except
13402                      * if we faked it */
13403                     if (is_posix_class) {
13404                         RExC_parse--;
13405                     }
13406
13407                     SvREFCNT_dec(current);   /* In case it returned something */
13408                     break;
13409                 }
13410
13411                 case ']':
13412                     if (depth--) break;
13413                     RExC_parse++;
13414                     if (RExC_parse < RExC_end
13415                         && *RExC_parse == ')')
13416                     {
13417                         node = reganode(pRExC_state, ANYOF, 0);
13418                         RExC_size += ANYOF_SKIP;
13419                         nextchar(pRExC_state);
13420                         Set_Node_Length(node,
13421                                 RExC_parse - oregcomp_parse + 1); /* MJD */
13422                         return node;
13423                     }
13424                     goto no_close;
13425             }
13426             RExC_parse++;
13427         }
13428
13429       no_close:
13430         FAIL("Syntax error in (?[...])");
13431     }
13432
13433     /* Pass 2 only after this. */
13434     Perl_ck_warner_d(aTHX_
13435         packWARN(WARN_EXPERIMENTAL__REGEX_SETS),
13436         "The regex_sets feature is experimental" REPORT_LOCATION,
13437             UTF8fARG(UTF, (RExC_parse - RExC_precomp), RExC_precomp),
13438             UTF8fARG(UTF,
13439                      RExC_end - RExC_start - (RExC_parse - RExC_precomp),
13440                      RExC_precomp + (RExC_parse - RExC_precomp)));
13441
13442     /* Everything in this construct is a metacharacter.  Operands begin with
13443      * either a '\' (for an escape sequence), or a '[' for a bracketed
13444      * character class.  Any other character should be an operator, or
13445      * parenthesis for grouping.  Both types of operands are handled by calling
13446      * regclass() to parse them.  It is called with a parameter to indicate to
13447      * return the computed inversion list.  The parsing here is implemented via
13448      * a stack.  Each entry on the stack is a single character representing one
13449      * of the operators; or else a pointer to an operand inversion list. */
13450
13451 #define IS_OPERAND(a)  (! SvIOK(a))
13452
13453     /* The stack is kept in Łukasiewicz order.  (That's pronounced similar
13454      * to luke-a-shave-itch (or -itz), but people who didn't want to bother
13455      * with prounouncing it called it Reverse Polish instead, but now that YOU
13456      * know how to prounounce it you can use the correct term, thus giving due
13457      * credit to the person who invented it, and impressing your geek friends.
13458      * Wikipedia says that the pronounciation of "Ł" has been changing so that
13459      * it is now more like an English initial W (as in wonk) than an L.)
13460      *
13461      * This means that, for example, 'a | b & c' is stored on the stack as
13462      *
13463      * c  [4]
13464      * b  [3]
13465      * &  [2]
13466      * a  [1]
13467      * |  [0]
13468      *
13469      * where the numbers in brackets give the stack [array] element number.
13470      * In this implementation, parentheses are not stored on the stack.
13471      * Instead a '(' creates a "fence" so that the part of the stack below the
13472      * fence is invisible except to the corresponding ')' (this allows us to
13473      * replace testing for parens, by using instead subtraction of the fence
13474      * position).  As new operands are processed they are pushed onto the stack
13475      * (except as noted in the next paragraph).  New operators of higher
13476      * precedence than the current final one are inserted on the stack before
13477      * the lhs operand (so that when the rhs is pushed next, everything will be
13478      * in the correct positions shown above.  When an operator of equal or
13479      * lower precedence is encountered in parsing, all the stacked operations
13480      * of equal or higher precedence are evaluated, leaving the result as the
13481      * top entry on the stack.  This makes higher precedence operations
13482      * evaluate before lower precedence ones, and causes operations of equal
13483      * precedence to left associate.
13484      *
13485      * The only unary operator '!' is immediately pushed onto the stack when
13486      * encountered.  When an operand is encountered, if the top of the stack is
13487      * a '!", the complement is immediately performed, and the '!' popped.  The
13488      * resulting value is treated as a new operand, and the logic in the
13489      * previous paragraph is executed.  Thus in the expression
13490      *      [a] + ! [b]
13491      * the stack looks like
13492      *
13493      * !
13494      * a
13495      * +
13496      *
13497      * as 'b' gets parsed, the latter gets evaluated to '!b', and the stack
13498      * becomes
13499      *
13500      * !b
13501      * a
13502      * +
13503      *
13504      * A ')' is treated as an operator with lower precedence than all the
13505      * aforementioned ones, which causes all operations on the stack above the
13506      * corresponding '(' to be evaluated down to a single resultant operand.
13507      * Then the fence for the '(' is removed, and the operand goes through the
13508      * algorithm above, without the fence.
13509      *
13510      * A separate stack is kept of the fence positions, so that the position of
13511      * the latest so-far unbalanced '(' is at the top of it.
13512      *
13513      * The ']' ending the construct is treated as the lowest operator of all,
13514      * so that everything gets evaluated down to a single operand, which is the
13515      * result */
13516
13517     sv_2mortal((SV *)(stack = newAV()));
13518     sv_2mortal((SV *)(fence_stack = newAV()));
13519
13520     while (RExC_parse < RExC_end) {
13521         I32 top_index;              /* Index of top-most element in 'stack' */
13522         SV** top_ptr;               /* Pointer to top 'stack' element */
13523         SV* current = NULL;         /* To contain the current inversion list
13524                                        operand */
13525         SV* only_to_avoid_leaks;
13526
13527         /* Skip white space */
13528         RExC_parse = regpatws(pRExC_state, RExC_parse,
13529                 TRUE /* means recognize comments */ );
13530         if (RExC_parse >= RExC_end) {
13531             Perl_croak(aTHX_ "panic: Read past end of '(?[ ])'");
13532         }
13533
13534         curchar = UCHARAT(RExC_parse);
13535
13536 redo_curchar:
13537
13538         top_index = av_tindex(stack);
13539
13540         switch (curchar) {
13541             SV** stacked_ptr;       /* Ptr to something already on 'stack' */
13542             char stacked_operator;  /* The topmost operator on the 'stack'. */
13543             SV* lhs;                /* Operand to the left of the operator */
13544             SV* rhs;                /* Operand to the right of the operator */
13545             SV* fence_ptr;          /* Pointer to top element of the fence
13546                                        stack */
13547
13548             case '(':
13549
13550                 if (RExC_parse < RExC_end && (UCHARAT(RExC_parse + 1) == '?'))
13551                 {
13552                     /* If is a '(?', could be an embedded '(?flags:(?[...])'.
13553                      * This happens when we have some thing like
13554                      *
13555                      *   my $thai_or_lao = qr/(?[ \p{Thai} + \p{Lao} ])/;
13556                      *   ...
13557                      *   qr/(?[ \p{Digit} & $thai_or_lao ])/;
13558                      *
13559                      * Here we would be handling the interpolated
13560                      * '$thai_or_lao'.  We handle this by a recursive call to
13561                      * ourselves which returns the inversion list the
13562                      * interpolated expression evaluates to.  We use the flags
13563                      * from the interpolated pattern. */
13564                     U32 save_flags = RExC_flags;
13565                     const char * save_parse;
13566
13567                     RExC_parse += 2;        /* Skip past the '(?' */
13568                     save_parse = RExC_parse;
13569
13570                     /* Parse any flags for the '(?' */
13571                     parse_lparen_question_flags(pRExC_state);
13572
13573                     if (RExC_parse == save_parse  /* Makes sure there was at
13574                                                      least one flag (or else
13575                                                      this embedding wasn't
13576                                                      compiled) */
13577                         || RExC_parse >= RExC_end - 4
13578                         || UCHARAT(RExC_parse) != ':'
13579                         || UCHARAT(++RExC_parse) != '('
13580                         || UCHARAT(++RExC_parse) != '?'
13581                         || UCHARAT(++RExC_parse) != '[')
13582                     {
13583
13584                         /* In combination with the above, this moves the
13585                          * pointer to the point just after the first erroneous
13586                          * character (or if there are no flags, to where they
13587                          * should have been) */
13588                         if (RExC_parse >= RExC_end - 4) {
13589                             RExC_parse = RExC_end;
13590                         }
13591                         else if (RExC_parse != save_parse) {
13592                             RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
13593                         }
13594                         vFAIL("Expecting '(?flags:(?[...'");
13595                     }
13596
13597                     /* Recurse, with the meat of the embedded expression */
13598                     RExC_parse++;
13599                     (void) handle_regex_sets(pRExC_state, &current, flagp,
13600                                                     depth+1, oregcomp_parse);
13601
13602                     /* Here, 'current' contains the embedded expression's
13603                      * inversion list, and RExC_parse points to the trailing
13604                      * ']'; the next character should be the ')' */
13605                     RExC_parse++;
13606                     assert(RExC_parse < RExC_end && UCHARAT(RExC_parse) == ')');
13607
13608                     /* Then the ')' matching the original '(' handled by this
13609                      * case: statement */
13610                     RExC_parse++;
13611                     assert(RExC_parse < RExC_end && UCHARAT(RExC_parse) == ')');
13612
13613                     RExC_parse++;
13614                     RExC_flags = save_flags;
13615                     goto handle_operand;
13616                 }
13617
13618                 /* A regular '('.  Look behind for illegal syntax */
13619                 if (top_index - fence >= 0) {
13620                     /* If the top entry on the stack is an operator, it had
13621                      * better be a '!', otherwise the entry below the top
13622                      * operand should be an operator */
13623                     if ( ! (top_ptr = av_fetch(stack, top_index, FALSE))
13624                         || (! IS_OPERAND(*top_ptr) && SvUV(*top_ptr) != '!')
13625                         || top_index - fence < 1
13626                         || ! (stacked_ptr = av_fetch(stack,
13627                                                      top_index - 1,
13628                                                      FALSE))
13629                         || IS_OPERAND(*stacked_ptr))
13630                     {
13631                         RExC_parse++;
13632                         vFAIL("Unexpected '(' with no preceding operator");
13633                     }
13634                 }
13635
13636                 /* Stack the position of this undealt-with left paren */
13637                 fence = top_index + 1;
13638                 av_push(fence_stack, newSViv(fence));
13639                 break;
13640
13641             case '\\':
13642                 /* regclass() can only return RESTART_UTF8 if multi-char
13643                    folds are allowed.  */
13644                 if (!regclass(pRExC_state, flagp,depth+1,
13645                               TRUE, /* means parse just the next thing */
13646                               FALSE, /* don't allow multi-char folds */
13647                               FALSE, /* don't silence non-portable warnings.  */
13648                               TRUE,  /* strict */
13649                               &current))
13650                 {
13651                     FAIL2("panic: regclass returned NULL to handle_sets, "
13652                           "flags=%#"UVxf"", (UV) *flagp);
13653                 }
13654
13655                 /* regclass() will return with parsing just the \ sequence,
13656                  * leaving the parse pointer at the next thing to parse */
13657                 RExC_parse--;
13658                 goto handle_operand;
13659
13660             case '[':   /* Is a bracketed character class */
13661             {
13662                 bool is_posix_class = could_it_be_a_POSIX_class(pRExC_state);
13663
13664                 if (! is_posix_class) {
13665                     RExC_parse++;
13666                 }
13667
13668                 /* regclass() can only return RESTART_UTF8 if multi-char
13669                    folds are allowed.  */
13670                 if(!regclass(pRExC_state, flagp,depth+1,
13671                              is_posix_class, /* parse the whole char class
13672                                                 only if not a posix class */
13673                              FALSE, /* don't allow multi-char folds */
13674                              FALSE, /* don't silence non-portable warnings.  */
13675                              TRUE,   /* strict */
13676                              &current
13677                             ))
13678                 {
13679                     FAIL2("panic: regclass returned NULL to handle_sets, "
13680                           "flags=%#"UVxf"", (UV) *flagp);
13681                 }
13682
13683                 /* function call leaves parse pointing to the ']', except if we
13684                  * faked it */
13685                 if (is_posix_class) {
13686                     RExC_parse--;
13687                 }
13688
13689                 goto handle_operand;
13690             }
13691
13692             case ']':
13693                 if (top_index >= 1) {
13694                     goto join_operators;
13695                 }
13696
13697                 /* Only a single operand on the stack: are done */
13698                 goto done;
13699
13700             case ')':
13701                 if (av_tindex(fence_stack) < 0) {
13702                     RExC_parse++;
13703                     vFAIL("Unexpected ')'");
13704                 }
13705
13706                  /* If at least two thing on the stack, treat this as an
13707                   * operator */
13708                 if (top_index - fence >= 1) {
13709                     goto join_operators;
13710                 }
13711
13712                 /* Here only a single thing on the fenced stack, and there is a
13713                  * fence.  Get rid of it */
13714                 fence_ptr = av_pop(fence_stack);
13715                 assert(fence_ptr);
13716                 fence = SvIV(fence_ptr) - 1;
13717                 SvREFCNT_dec_NN(fence_ptr);
13718                 fence_ptr = NULL;
13719
13720                 if (fence < 0) {
13721                     fence = 0;
13722                 }
13723
13724                 /* Having gotten rid of the fence, we pop the operand at the
13725                  * stack top and process it as a newly encountered operand */
13726                 current = av_pop(stack);
13727                 assert(IS_OPERAND(current));
13728                 goto handle_operand;
13729
13730             case '&':
13731             case '|':
13732             case '+':
13733             case '-':
13734             case '^':
13735
13736                 /* These binary operators should have a left operand already
13737                  * parsed */
13738                 if (   top_index - fence < 0
13739                     || top_index - fence == 1
13740                     || ( ! (top_ptr = av_fetch(stack, top_index, FALSE)))
13741                     || ! IS_OPERAND(*top_ptr))
13742                 {
13743                     goto unexpected_binary;
13744                 }
13745
13746                 /* If only the one operand is on the part of the stack visible
13747                  * to us, we just place this operator in the proper position */
13748                 if (top_index - fence < 2) {
13749
13750                     /* Place the operator before the operand */
13751
13752                     SV* lhs = av_pop(stack);
13753                     av_push(stack, newSVuv(curchar));
13754                     av_push(stack, lhs);
13755                     break;
13756                 }
13757
13758                 /* But if there is something else on the stack, we need to
13759                  * process it before this new operator if and only if the
13760                  * stacked operation has equal or higher precedence than the
13761                  * new one */
13762
13763              join_operators:
13764
13765                 /* The operator on the stack is supposed to be below both its
13766                  * operands */
13767                 if (   ! (stacked_ptr = av_fetch(stack, top_index - 2, FALSE))
13768                     || IS_OPERAND(*stacked_ptr))
13769                 {
13770                     /* But if not, it's legal and indicates we are completely
13771                      * done if and only if we're currently processing a ']',
13772                      * which should be the final thing in the expression */
13773                     if (curchar == ']') {
13774                         goto done;
13775                     }
13776
13777                   unexpected_binary:
13778                     RExC_parse++;
13779                     vFAIL2("Unexpected binary operator '%c' with no "
13780                            "preceding operand", curchar);
13781                 }
13782                 stacked_operator = (char) SvUV(*stacked_ptr);
13783
13784                 if (regex_set_precedence(curchar)
13785                     > regex_set_precedence(stacked_operator))
13786                 {
13787                     /* Here, the new operator has higher precedence than the
13788                      * stacked one.  This means we need to add the new one to
13789                      * the stack to await its rhs operand (and maybe more
13790                      * stuff).  We put it before the lhs operand, leaving
13791                      * untouched the stacked operator and everything below it
13792                      * */
13793                     lhs = av_pop(stack);
13794                     assert(IS_OPERAND(lhs));
13795
13796                     av_push(stack, newSVuv(curchar));
13797                     av_push(stack, lhs);
13798                     break;
13799                 }
13800
13801                 /* Here, the new operator has equal or lower precedence than
13802                  * what's already there.  This means the operation already
13803                  * there should be performed now, before the new one. */
13804                 rhs = av_pop(stack);
13805                 lhs = av_pop(stack);
13806
13807                 assert(IS_OPERAND(rhs));
13808                 assert(IS_OPERAND(lhs));
13809
13810                 switch (stacked_operator) {
13811                     case '&':
13812                         _invlist_intersection(lhs, rhs, &rhs);
13813                         break;
13814
13815                     case '|':
13816                     case '+':
13817                         _invlist_union(lhs, rhs, &rhs);
13818                         break;
13819
13820                     case '-':
13821                         _invlist_subtract(lhs, rhs, &rhs);
13822                         break;
13823
13824                     case '^':   /* The union minus the intersection */
13825                     {
13826                         SV* i = NULL;
13827                         SV* u = NULL;
13828                         SV* element;
13829
13830                         _invlist_union(lhs, rhs, &u);
13831                         _invlist_intersection(lhs, rhs, &i);
13832                         /* _invlist_subtract will overwrite rhs
13833                             without freeing what it already contains */
13834                         element = rhs;
13835                         _invlist_subtract(u, i, &rhs);
13836                         SvREFCNT_dec_NN(i);
13837                         SvREFCNT_dec_NN(u);
13838                         SvREFCNT_dec_NN(element);
13839                         break;
13840                     }
13841                 }
13842                 SvREFCNT_dec(lhs);
13843
13844                 /* Here, the higher precedence operation has been done, and the
13845                  * result is in 'rhs'.  We overwrite the stacked operator with
13846                  * the result.  Then we redo this code to either push the new
13847                  * operator onto the stack or perform any higher precedence
13848                  * stacked operation */
13849                 only_to_avoid_leaks = av_pop(stack);
13850                 SvREFCNT_dec(only_to_avoid_leaks);
13851                 av_push(stack, rhs);
13852                 goto redo_curchar;
13853
13854             case '!':   /* Highest priority, right associative, so just push
13855                            onto stack */
13856                 av_push(stack, newSVuv(curchar));
13857                 break;
13858
13859             default:
13860                 RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
13861                 vFAIL("Unexpected character");
13862
13863           handle_operand:
13864
13865             /* Here 'current' is the operand.  If something is already on the
13866              * stack, we have to check if it is a !. */
13867             top_index = av_tindex(stack);   /* Code above may have altered the
13868                                              * stack in the time since we
13869                                              * earlier set 'top_index'. */
13870             if (top_index - fence >= 0) {
13871                 /* If the top entry on the stack is an operator, it had better
13872                  * be a '!', otherwise the entry below the top operand should
13873                  * be an operator */
13874                 top_ptr = av_fetch(stack, top_index, FALSE);
13875                 assert(top_ptr);
13876                 if (! IS_OPERAND(*top_ptr)) {
13877
13878                     /* The only permissible operator at the top of the stack is
13879                      * '!', which is applied immediately to this operand. */
13880                     curchar = (char) SvUV(*top_ptr);
13881                     if (curchar != '!') {
13882                         SvREFCNT_dec(current);
13883                         vFAIL2("Unexpected binary operator '%c' with no "
13884                                 "preceding operand", curchar);
13885                     }
13886
13887                     _invlist_invert(current);
13888
13889                     only_to_avoid_leaks = av_pop(stack);
13890                     SvREFCNT_dec(only_to_avoid_leaks);
13891                     top_index = av_tindex(stack);
13892
13893                     /* And we redo with the inverted operand.  This allows
13894                      * handling multiple ! in a row */
13895                     goto handle_operand;
13896                 }
13897                           /* Single operand is ok only for the non-binary ')'
13898                            * operator */
13899                 else if ((top_index - fence == 0 && curchar != ')')
13900                          || (top_index - fence > 0
13901                              && (! (stacked_ptr = av_fetch(stack,
13902                                                            top_index - 1,
13903                                                            FALSE))
13904                                  || IS_OPERAND(*stacked_ptr))))
13905                 {
13906                     SvREFCNT_dec(current);
13907                     vFAIL("Operand with no preceding operator");
13908                 }
13909             }
13910
13911             /* Here there was nothing on the stack or the top element was
13912              * another operand.  Just add this new one */
13913             av_push(stack, current);
13914
13915         } /* End of switch on next parse token */
13916
13917         RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
13918     } /* End of loop parsing through the construct */
13919
13920   done:
13921     if (av_tindex(fence_stack) >= 0) {
13922         vFAIL("Unmatched (");
13923     }
13924
13925     if (av_tindex(stack) < 0   /* Was empty */
13926         || ((final = av_pop(stack)) == NULL)
13927         || ! IS_OPERAND(final)
13928         || av_tindex(stack) >= 0)  /* More left on stack */
13929     {
13930         SvREFCNT_dec(final);
13931         vFAIL("Incomplete expression within '(?[ ])'");
13932     }
13933
13934     /* Here, 'final' is the resultant inversion list from evaluating the
13935      * expression.  Return it if so requested */
13936     if (return_invlist) {
13937         *return_invlist = final;
13938         return END;
13939     }
13940
13941     /* Otherwise generate a resultant node, based on 'final'.  regclass() is
13942      * expecting a string of ranges and individual code points */
13943     invlist_iterinit(final);
13944     result_string = newSVpvs("");
13945     while (invlist_iternext(final, &start, &end)) {
13946         if (start == end) {
13947             Perl_sv_catpvf(aTHX_ result_string, "\\x{%"UVXf"}", start);
13948         }
13949         else {
13950             Perl_sv_catpvf(aTHX_ result_string, "\\x{%"UVXf"}-\\x{%"UVXf"}",
13951                                                      start,          end);
13952         }
13953     }
13954
13955     /* About to generate an ANYOF (or similar) node from the inversion list we
13956      * have calculated */
13957     save_parse = RExC_parse;
13958     RExC_parse = SvPV(result_string, len);
13959     save_end = RExC_end;
13960     RExC_end = RExC_parse + len;
13961
13962     /* We turn off folding around the call, as the class we have constructed
13963      * already has all folding taken into consideration, and we don't want
13964      * regclass() to add to that */
13965     RExC_flags &= ~RXf_PMf_FOLD;
13966     /* regclass() can only return RESTART_UTF8 if multi-char folds are allowed.
13967      */
13968     node = regclass(pRExC_state, flagp,depth+1,
13969                     FALSE, /* means parse the whole char class */
13970                     FALSE, /* don't allow multi-char folds */
13971                     TRUE, /* silence non-portable warnings.  The above may very
13972                              well have generated non-portable code points, but
13973                              they're valid on this machine */
13974                     FALSE, /* similarly, no need for strict */
13975                     NULL
13976                 );
13977     if (!node)
13978         FAIL2("panic: regclass returned NULL to handle_sets, flags=%#"UVxf,
13979                     PTR2UV(flagp));
13980     if (save_fold) {
13981         RExC_flags |= RXf_PMf_FOLD;
13982     }
13983     RExC_parse = save_parse + 1;
13984     RExC_end = save_end;
13985     SvREFCNT_dec_NN(final);
13986     SvREFCNT_dec_NN(result_string);
13987
13988     nextchar(pRExC_state);
13989     Set_Node_Length(node, RExC_parse - oregcomp_parse + 1); /* MJD */
13990     return node;
13991 }
13992 #undef IS_OPERAND
13993
13994 STATIC void
13995 S_add_above_Latin1_folds(pTHX_ RExC_state_t *pRExC_state, const U8 cp, SV** invlist)
13996 {
13997     /* This hard-codes the Latin1/above-Latin1 folding rules, so that an
13998      * innocent-looking character class, like /[ks]/i won't have to go out to
13999      * disk to find the possible matches.
14000      *
14001      * This should be called only for a Latin1-range code points, cp, which is
14002      * known to be involved in a simple fold with other code points above
14003      * Latin1.  It would give false results if /aa has been specified.
14004      * Multi-char folds are outside the scope of this, and must be handled
14005      * specially.
14006      *
14007      * XXX It would be better to generate these via regen, in case a new
14008      * version of the Unicode standard adds new mappings, though that is not
14009      * really likely, and may be caught by the default: case of the switch
14010      * below. */
14011
14012     PERL_ARGS_ASSERT_ADD_ABOVE_LATIN1_FOLDS;
14013
14014     assert(HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(cp));
14015
14016     switch (cp) {
14017         case 'k':
14018         case 'K':
14019           *invlist =
14020              add_cp_to_invlist(*invlist, KELVIN_SIGN);
14021             break;
14022         case 's':
14023         case 'S':
14024           *invlist = add_cp_to_invlist(*invlist, LATIN_SMALL_LETTER_LONG_S);
14025             break;
14026         case MICRO_SIGN:
14027           *invlist = add_cp_to_invlist(*invlist, GREEK_CAPITAL_LETTER_MU);
14028           *invlist = add_cp_to_invlist(*invlist, GREEK_SMALL_LETTER_MU);
14029             break;
14030         case LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE:
14031         case LATIN_SMALL_LETTER_A_WITH_RING_ABOVE:
14032           *invlist = add_cp_to_invlist(*invlist, ANGSTROM_SIGN);
14033             break;
14034         case LATIN_SMALL_LETTER_Y_WITH_DIAERESIS:
14035           *invlist = add_cp_to_invlist(*invlist,
14036                                         LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS);
14037             break;
14038
14039 #ifdef LATIN_CAPITAL_LETTER_SHARP_S /* not defined in early Unicode releases */
14040
14041         case LATIN_SMALL_LETTER_SHARP_S:
14042           *invlist = add_cp_to_invlist(*invlist, LATIN_CAPITAL_LETTER_SHARP_S);
14043             break;
14044
14045 #endif
14046
14047 #if    UNICODE_MAJOR_VERSION < 3                                        \
14048    || (UNICODE_MAJOR_VERSION == 3 && UNICODE_DOT_VERSION == 0)
14049
14050         /* In 3.0 and earlier, U+0130 folded simply to 'i'; and in 3.0.1 so did
14051          * U+0131.  */
14052         case 'i':
14053         case 'I':
14054           *invlist =
14055              add_cp_to_invlist(*invlist, LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE);
14056 #   if UNICODE_DOT_DOT_VERSION == 1
14057           *invlist = add_cp_to_invlist(*invlist, LATIN_SMALL_LETTER_DOTLESS_I);
14058 #   endif
14059             break;
14060 #endif
14061
14062         default:
14063             /* Use deprecated warning to increase the chances of this being
14064              * output */
14065             if (PASS2) {
14066                 ckWARN2reg_d(RExC_parse, "Perl folding rules are not up-to-date for 0x%02X; please use the perlbug utility to report;", cp);
14067             }
14068             break;
14069     }
14070 }
14071
14072 STATIC AV *
14073 S_add_multi_match(pTHX_ AV* multi_char_matches, SV* multi_string, const STRLEN cp_count)
14074 {
14075     /* This adds the string scalar <multi_string> to the array
14076      * <multi_char_matches>.  <multi_string> is known to have exactly
14077      * <cp_count> code points in it.  This is used when constructing a
14078      * bracketed character class and we find something that needs to match more
14079      * than a single character.
14080      *
14081      * <multi_char_matches> is actually an array of arrays.  Each top-level
14082      * element is an array that contains all the strings known so far that are
14083      * the same length.  And that length (in number of code points) is the same
14084      * as the index of the top-level array.  Hence, the [2] element is an
14085      * array, each element thereof is a string containing TWO code points;
14086      * while element [3] is for strings of THREE characters, and so on.  Since
14087      * this is for multi-char strings there can never be a [0] nor [1] element.
14088      *
14089      * When we rewrite the character class below, we will do so such that the
14090      * longest strings are written first, so that it prefers the longest
14091      * matching strings first.  This is done even if it turns out that any
14092      * quantifier is non-greedy, out of this programmer's (khw) laziness.  Tom
14093      * Christiansen has agreed that this is ok.  This makes the test for the
14094      * ligature 'ffi' come before the test for 'ff', for example */
14095
14096     AV* this_array;
14097     AV** this_array_ptr;
14098
14099     PERL_ARGS_ASSERT_ADD_MULTI_MATCH;
14100
14101     if (! multi_char_matches) {
14102         multi_char_matches = newAV();
14103     }
14104
14105     if (av_exists(multi_char_matches, cp_count)) {
14106         this_array_ptr = (AV**) av_fetch(multi_char_matches, cp_count, FALSE);
14107         this_array = *this_array_ptr;
14108     }
14109     else {
14110         this_array = newAV();
14111         av_store(multi_char_matches, cp_count,
14112                  (SV*) this_array);
14113     }
14114     av_push(this_array, multi_string);
14115
14116     return multi_char_matches;
14117 }
14118
14119 /* The names of properties whose definitions are not known at compile time are
14120  * stored in this SV, after a constant heading.  So if the length has been
14121  * changed since initialization, then there is a run-time definition. */
14122 #define HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION                            \
14123                                         (SvCUR(listsv) != initial_listsv_len)
14124
14125 STATIC regnode *
14126 S_regclass(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth,
14127                  const bool stop_at_1,  /* Just parse the next thing, don't
14128                                            look for a full character class */
14129                  bool allow_multi_folds,
14130                  const bool silence_non_portable,   /* Don't output warnings
14131                                                        about too large
14132                                                        characters */
14133                  const bool strict,
14134                  SV** ret_invlist  /* Return an inversion list, not a node */
14135           )
14136 {
14137     /* parse a bracketed class specification.  Most of these will produce an
14138      * ANYOF node; but something like [a] will produce an EXACT node; [aA], an
14139      * EXACTFish node; [[:ascii:]], a POSIXA node; etc.  It is more complex
14140      * under /i with multi-character folds: it will be rewritten following the
14141      * paradigm of this example, where the <multi-fold>s are characters which
14142      * fold to multiple character sequences:
14143      *      /[abc\x{multi-fold1}def\x{multi-fold2}ghi]/i
14144      * gets effectively rewritten as:
14145      *      /(?:\x{multi-fold1}|\x{multi-fold2}|[abcdefghi]/i
14146      * reg() gets called (recursively) on the rewritten version, and this
14147      * function will return what it constructs.  (Actually the <multi-fold>s
14148      * aren't physically removed from the [abcdefghi], it's just that they are
14149      * ignored in the recursion by means of a flag:
14150      * <RExC_in_multi_char_class>.)
14151      *
14152      * ANYOF nodes contain a bit map for the first NUM_ANYOF_CODE_POINTS
14153      * characters, with the corresponding bit set if that character is in the
14154      * list.  For characters above this, a range list or swash is used.  There
14155      * are extra bits for \w, etc. in locale ANYOFs, as what these match is not
14156      * determinable at compile time
14157      *
14158      * Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan needs
14159      * to be restarted.  This can only happen if ret_invlist is non-NULL.
14160      */
14161
14162     UV prevvalue = OOB_UNICODE, save_prevvalue = OOB_UNICODE;
14163     IV range = 0;
14164     UV value = OOB_UNICODE, save_value = OOB_UNICODE;
14165     regnode *ret;
14166     STRLEN numlen;
14167     IV namedclass = OOB_NAMEDCLASS;
14168     char *rangebegin = NULL;
14169     bool need_class = 0;
14170     SV *listsv = NULL;
14171     STRLEN initial_listsv_len = 0; /* Kind of a kludge to see if it is more
14172                                       than just initialized.  */
14173     SV* properties = NULL;    /* Code points that match \p{} \P{} */
14174     SV* posixes = NULL;     /* Code points that match classes like [:word:],
14175                                extended beyond the Latin1 range.  These have to
14176                                be kept separate from other code points for much
14177                                of this function because their handling  is
14178                                different under /i, and for most classes under
14179                                /d as well */
14180     SV* nposixes = NULL;    /* Similarly for [:^word:].  These are kept
14181                                separate for a while from the non-complemented
14182                                versions because of complications with /d
14183                                matching */
14184     SV* simple_posixes = NULL; /* But under some conditions, the classes can be
14185                                   treated more simply than the general case,
14186                                   leading to less compilation and execution
14187                                   work */
14188     UV element_count = 0;   /* Number of distinct elements in the class.
14189                                Optimizations may be possible if this is tiny */
14190     AV * multi_char_matches = NULL; /* Code points that fold to more than one
14191                                        character; used under /i */
14192     UV n;
14193     char * stop_ptr = RExC_end;    /* where to stop parsing */
14194     const bool skip_white = cBOOL(ret_invlist); /* ignore unescaped white
14195                                                    space? */
14196
14197     /* Unicode properties are stored in a swash; this holds the current one
14198      * being parsed.  If this swash is the only above-latin1 component of the
14199      * character class, an optimization is to pass it directly on to the
14200      * execution engine.  Otherwise, it is set to NULL to indicate that there
14201      * are other things in the class that have to be dealt with at execution
14202      * time */
14203     SV* swash = NULL;           /* Code points that match \p{} \P{} */
14204
14205     /* Set if a component of this character class is user-defined; just passed
14206      * on to the engine */
14207     bool has_user_defined_property = FALSE;
14208
14209     /* inversion list of code points this node matches only when the target
14210      * string is in UTF-8.  (Because is under /d) */
14211     SV* depends_list = NULL;
14212
14213     /* Inversion list of code points this node matches regardless of things
14214      * like locale, folding, utf8ness of the target string */
14215     SV* cp_list = NULL;
14216
14217     /* Like cp_list, but code points on this list need to be checked for things
14218      * that fold to/from them under /i */
14219     SV* cp_foldable_list = NULL;
14220
14221     /* Like cp_list, but code points on this list are valid only when the
14222      * runtime locale is UTF-8 */
14223     SV* only_utf8_locale_list = NULL;
14224
14225     /* In a range, if one of the endpoints is non-character-set portable,
14226      * meaning that it hard-codes a code point that may mean a different
14227      * charactger in ASCII vs. EBCDIC, as opposed to, say, a literal 'A' or a
14228      * mnemonic '\t' which each mean the same character no matter which
14229      * character set the platform is on. */
14230     unsigned int non_portable_endpoint = 0;
14231
14232     /* Is the range unicode? which means on a platform that isn't 1-1 native
14233      * to Unicode (i.e. non-ASCII), each code point in it should be considered
14234      * to be a Unicode value.  */
14235     bool unicode_range = FALSE;
14236     bool invert = FALSE;    /* Is this class to be complemented */
14237
14238     bool warn_super = ALWAYS_WARN_SUPER;
14239
14240     regnode * const orig_emit = RExC_emit; /* Save the original RExC_emit in
14241         case we need to change the emitted regop to an EXACT. */
14242     const char * orig_parse = RExC_parse;
14243     const SSize_t orig_size = RExC_size;
14244     bool posixl_matches_all = FALSE; /* Does /l class have both e.g. \W,\w ? */
14245     GET_RE_DEBUG_FLAGS_DECL;
14246
14247     PERL_ARGS_ASSERT_REGCLASS;
14248 #ifndef DEBUGGING
14249     PERL_UNUSED_ARG(depth);
14250 #endif
14251
14252     DEBUG_PARSE("clas");
14253
14254 #if UNICODE_MAJOR_VERSION < 3 /* no multifolds in early Unicode */      \
14255     || (UNICODE_MAJOR_VERSION == 3 && UNICODE_DOT_VERSION == 0          \
14256                                    && UNICODE_DOT_DOT_VERSION == 0)
14257     allow_multi_folds = FALSE;
14258 #endif
14259
14260     /* Assume we are going to generate an ANYOF node. */
14261     ret = reganode(pRExC_state,
14262                    (LOC)
14263                     ? ANYOFL
14264                     : ANYOF,
14265                    0);
14266
14267     if (SIZE_ONLY) {
14268         RExC_size += ANYOF_SKIP;
14269         listsv = &PL_sv_undef; /* For code scanners: listsv always non-NULL. */
14270     }
14271     else {
14272         ANYOF_FLAGS(ret) = 0;
14273
14274         RExC_emit += ANYOF_SKIP;
14275         listsv = newSVpvs_flags("# comment\n", SVs_TEMP);
14276         initial_listsv_len = SvCUR(listsv);
14277         SvTEMP_off(listsv); /* Grr, TEMPs and mortals are conflated.  */
14278     }
14279
14280     if (skip_white) {
14281         RExC_parse = regpatws(pRExC_state, RExC_parse,
14282                               FALSE /* means don't recognize comments */ );
14283     }
14284
14285     if (UCHARAT(RExC_parse) == '^') {   /* Complement of range. */
14286         RExC_parse++;
14287         invert = TRUE;
14288         allow_multi_folds = FALSE;
14289         MARK_NAUGHTY(1);
14290         if (skip_white) {
14291             RExC_parse = regpatws(pRExC_state, RExC_parse,
14292                                   FALSE /* means don't recognize comments */ );
14293         }
14294     }
14295
14296     /* Check that they didn't say [:posix:] instead of [[:posix:]] */
14297     if (!SIZE_ONLY && RExC_parse < RExC_end && POSIXCC(UCHARAT(RExC_parse))) {
14298         const char *s = RExC_parse;
14299         const char  c = *s++;
14300
14301         if (*s == '^') {
14302             s++;
14303         }
14304         while (isWORDCHAR(*s))
14305             s++;
14306         if (*s && c == *s && s[1] == ']') {
14307             SAVEFREESV(RExC_rx_sv);
14308             ckWARN3reg(s+2,
14309                        "POSIX syntax [%c %c] belongs inside character classes",
14310                        c, c);
14311             (void)ReREFCNT_inc(RExC_rx_sv);
14312         }
14313     }
14314
14315     /* If the caller wants us to just parse a single element, accomplish this
14316      * by faking the loop ending condition */
14317     if (stop_at_1 && RExC_end > RExC_parse) {
14318         stop_ptr = RExC_parse + 1;
14319     }
14320
14321     /* allow 1st char to be ']' (allowing it to be '-' is dealt with later) */
14322     if (UCHARAT(RExC_parse) == ']')
14323         goto charclassloop;
14324
14325     while (1) {
14326         if  (RExC_parse >= stop_ptr) {
14327             break;
14328         }
14329
14330         if (skip_white) {
14331             RExC_parse = regpatws(pRExC_state, RExC_parse,
14332                                   FALSE /* means don't recognize comments */ );
14333         }
14334
14335         if  (UCHARAT(RExC_parse) == ']') {
14336             break;
14337         }
14338
14339       charclassloop:
14340
14341         namedclass = OOB_NAMEDCLASS; /* initialize as illegal */
14342         save_value = value;
14343         save_prevvalue = prevvalue;
14344
14345         if (!range) {
14346             rangebegin = RExC_parse;
14347             element_count++;
14348             non_portable_endpoint = 0;
14349         }
14350         if (UTF) {
14351             value = utf8n_to_uvchr((U8*)RExC_parse,
14352                                    RExC_end - RExC_parse,
14353                                    &numlen, UTF8_ALLOW_DEFAULT);
14354             RExC_parse += numlen;
14355         }
14356         else
14357             value = UCHARAT(RExC_parse++);
14358
14359         if (value == '['
14360             && RExC_parse < RExC_end
14361             && POSIXCC(UCHARAT(RExC_parse)))
14362         {
14363             namedclass = regpposixcc(pRExC_state, value, strict);
14364         }
14365         else if (value == '\\') {
14366             /* Is a backslash; get the code point of the char after it */
14367             if (UTF && ! UTF8_IS_INVARIANT(UCHARAT(RExC_parse))) {
14368                 value = utf8n_to_uvchr((U8*)RExC_parse,
14369                                    RExC_end - RExC_parse,
14370                                    &numlen, UTF8_ALLOW_DEFAULT);
14371                 RExC_parse += numlen;
14372             }
14373             else
14374                 value = UCHARAT(RExC_parse++);
14375
14376             /* Some compilers cannot handle switching on 64-bit integer
14377              * values, therefore value cannot be an UV.  Yes, this will
14378              * be a problem later if we want switch on Unicode.
14379              * A similar issue a little bit later when switching on
14380              * namedclass. --jhi */
14381
14382             /* If the \ is escaping white space when white space is being
14383              * skipped, it means that that white space is wanted literally, and
14384              * is already in 'value'.  Otherwise, need to translate the escape
14385              * into what it signifies. */
14386             if (! skip_white || ! is_PATWS_cp(value)) switch ((I32)value) {
14387
14388             case 'w':   namedclass = ANYOF_WORDCHAR;    break;
14389             case 'W':   namedclass = ANYOF_NWORDCHAR;   break;
14390             case 's':   namedclass = ANYOF_SPACE;       break;
14391             case 'S':   namedclass = ANYOF_NSPACE;      break;
14392             case 'd':   namedclass = ANYOF_DIGIT;       break;
14393             case 'D':   namedclass = ANYOF_NDIGIT;      break;
14394             case 'v':   namedclass = ANYOF_VERTWS;      break;
14395             case 'V':   namedclass = ANYOF_NVERTWS;     break;
14396             case 'h':   namedclass = ANYOF_HORIZWS;     break;
14397             case 'H':   namedclass = ANYOF_NHORIZWS;    break;
14398             case 'N':  /* Handle \N{NAME} in class */
14399                 {
14400                     const char * const backslash_N_beg = RExC_parse - 2;
14401                     int cp_count;
14402
14403                     if (! grok_bslash_N(pRExC_state,
14404                                         NULL,      /* No regnode */
14405                                         &value,    /* Yes single value */
14406                                         &cp_count, /* Multiple code pt count */
14407                                         flagp,
14408                                         depth)
14409                     ) {
14410
14411                         if (*flagp & RESTART_UTF8)
14412                             FAIL("panic: grok_bslash_N set RESTART_UTF8");
14413
14414                         if (cp_count < 0) {
14415                             vFAIL("\\N in a character class must be a named character: \\N{...}");
14416                         }
14417                         else if (cp_count == 0) {
14418                             if (strict) {
14419                                 RExC_parse++;   /* Position after the "}" */
14420                                 vFAIL("Zero length \\N{}");
14421                             }
14422                             else if (PASS2) {
14423                                 ckWARNreg(RExC_parse,
14424                                         "Ignoring zero length \\N{} in character class");
14425                             }
14426                         }
14427                         else { /* cp_count > 1 */
14428                             if (! RExC_in_multi_char_class) {
14429                                 if (invert || range || *RExC_parse == '-') {
14430                                     if (strict) {
14431                                         RExC_parse--;
14432                                         vFAIL("\\N{} in inverted character class or as a range end-point is restricted to one character");
14433                                     }
14434                                     else if (PASS2) {
14435                                         ckWARNreg(RExC_parse, "Using just the first character returned by \\N{} in character class");
14436                                     }
14437                                     break; /* <value> contains the first code
14438                                               point. Drop out of the switch to
14439                                               process it */
14440                                 }
14441                                 else {
14442                                     SV * multi_char_N = newSVpvn(backslash_N_beg,
14443                                                  RExC_parse - backslash_N_beg);
14444                                     multi_char_matches
14445                                         = add_multi_match(multi_char_matches,
14446                                                           multi_char_N,
14447                                                           cp_count);
14448                                 }
14449                             }
14450                         } /* End of cp_count != 1 */
14451
14452                         /* This element should not be processed further in this
14453                          * class */
14454                         element_count--;
14455                         value = save_value;
14456                         prevvalue = save_prevvalue;
14457                         continue;   /* Back to top of loop to get next char */
14458                     }
14459
14460                     /* Here, is a single code point, and <value> contains it */
14461                     unicode_range = TRUE;   /* \N{} are Unicode */
14462                 }
14463                 break;
14464             case 'p':
14465             case 'P':
14466                 {
14467                 char *e;
14468
14469                 /* We will handle any undefined properties ourselves */
14470                 U8 swash_init_flags = _CORE_SWASH_INIT_RETURN_IF_UNDEF
14471                                        /* And we actually would prefer to get
14472                                         * the straight inversion list of the
14473                                         * swash, since we will be accessing it
14474                                         * anyway, to save a little time */
14475                                       |_CORE_SWASH_INIT_ACCEPT_INVLIST;
14476
14477                 if (RExC_parse >= RExC_end)
14478                     vFAIL2("Empty \\%c{}", (U8)value);
14479                 if (*RExC_parse == '{') {
14480                     const U8 c = (U8)value;
14481                     e = strchr(RExC_parse++, '}');
14482                     if (!e)
14483                         vFAIL2("Missing right brace on \\%c{}", c);
14484                     while (isSPACE(*RExC_parse))
14485                         RExC_parse++;
14486                     if (e == RExC_parse)
14487                         vFAIL2("Empty \\%c{}", c);
14488                     n = e - RExC_parse;
14489                     while (isSPACE(*(RExC_parse + n - 1)))
14490                         n--;
14491                 }
14492                 else {
14493                     e = RExC_parse;
14494                     n = 1;
14495                 }
14496                 if (!SIZE_ONLY) {
14497                     SV* invlist;
14498                     char* name;
14499
14500                     if (UCHARAT(RExC_parse) == '^') {
14501                          RExC_parse++;
14502                          n--;
14503                          /* toggle.  (The rhs xor gets the single bit that
14504                           * differs between P and p; the other xor inverts just
14505                           * that bit) */
14506                          value ^= 'P' ^ 'p';
14507
14508                          while (isSPACE(*RExC_parse)) {
14509                               RExC_parse++;
14510                               n--;
14511                          }
14512                     }
14513                     /* Try to get the definition of the property into
14514                      * <invlist>.  If /i is in effect, the effective property
14515                      * will have its name be <__NAME_i>.  The design is
14516                      * discussed in commit
14517                      * 2f833f5208e26b208886e51e09e2c072b5eabb46 */
14518                     name = savepv(Perl_form(aTHX_
14519                                           "%s%.*s%s\n",
14520                                           (FOLD) ? "__" : "",
14521                                           (int)n,
14522                                           RExC_parse,
14523                                           (FOLD) ? "_i" : ""
14524                                 ));
14525
14526                     /* Look up the property name, and get its swash and
14527                      * inversion list, if the property is found  */
14528                     if (swash) {
14529                         SvREFCNT_dec_NN(swash);
14530                     }
14531                     swash = _core_swash_init("utf8", name, &PL_sv_undef,
14532                                              1, /* binary */
14533                                              0, /* not tr/// */
14534                                              NULL, /* No inversion list */
14535                                              &swash_init_flags
14536                                             );
14537                     if (! swash || ! (invlist = _get_swash_invlist(swash))) {
14538                         HV* curpkg = (IN_PERL_COMPILETIME)
14539                                       ? PL_curstash
14540                                       : CopSTASH(PL_curcop);
14541                         if (swash) {
14542                             SvREFCNT_dec_NN(swash);
14543                             swash = NULL;
14544                         }
14545
14546                         /* Here didn't find it.  It could be a user-defined
14547                          * property that will be available at run-time.  If we
14548                          * accept only compile-time properties, is an error;
14549                          * otherwise add it to the list for run-time look up */
14550                         if (ret_invlist) {
14551                             RExC_parse = e + 1;
14552                             vFAIL2utf8f(
14553                                 "Property '%"UTF8f"' is unknown",
14554                                 UTF8fARG(UTF, n, name));
14555                         }
14556
14557                         /* If the property name doesn't already have a package
14558                          * name, add the current one to it so that it can be
14559                          * referred to outside it. [perl #121777] */
14560                         if (curpkg && ! instr(name, "::")) {
14561                             char* pkgname = HvNAME(curpkg);
14562                             if (strNE(pkgname, "main")) {
14563                                 char* full_name = Perl_form(aTHX_
14564                                                             "%s::%s",
14565                                                             pkgname,
14566                                                             name);
14567                                 n = strlen(full_name);
14568                                 Safefree(name);
14569                                 name = savepvn(full_name, n);
14570                             }
14571                         }
14572                         Perl_sv_catpvf(aTHX_ listsv, "%cutf8::%"UTF8f"\n",
14573                                         (value == 'p' ? '+' : '!'),
14574                                         UTF8fARG(UTF, n, name));
14575                         has_user_defined_property = TRUE;
14576
14577                         /* We don't know yet, so have to assume that the
14578                          * property could match something in the Latin1 range,
14579                          * hence something that isn't utf8.  Note that this
14580                          * would cause things in <depends_list> to match
14581                          * inappropriately, except that any \p{}, including
14582                          * this one forces Unicode semantics, which means there
14583                          * is no <depends_list> */
14584                         ANYOF_FLAGS(ret)
14585                                       |= ANYOF_HAS_NONBITMAP_NON_UTF8_MATCHES;
14586                     }
14587                     else {
14588
14589                         /* Here, did get the swash and its inversion list.  If
14590                          * the swash is from a user-defined property, then this
14591                          * whole character class should be regarded as such */
14592                         if (swash_init_flags
14593                             & _CORE_SWASH_INIT_USER_DEFINED_PROPERTY)
14594                         {
14595                             has_user_defined_property = TRUE;
14596                         }
14597                         else if
14598                             /* We warn on matching an above-Unicode code point
14599                              * if the match would return true, except don't
14600                              * warn for \p{All}, which has exactly one element
14601                              * = 0 */
14602                             (_invlist_contains_cp(invlist, 0x110000)
14603                                 && (! (_invlist_len(invlist) == 1
14604                                        && *invlist_array(invlist) == 0)))
14605                         {
14606                             warn_super = TRUE;
14607                         }
14608
14609
14610                         /* Invert if asking for the complement */
14611                         if (value == 'P') {
14612                             _invlist_union_complement_2nd(properties,
14613                                                           invlist,
14614                                                           &properties);
14615
14616                             /* The swash can't be used as-is, because we've
14617                              * inverted things; delay removing it to here after
14618                              * have copied its invlist above */
14619                             SvREFCNT_dec_NN(swash);
14620                             swash = NULL;
14621                         }
14622                         else {
14623                             _invlist_union(properties, invlist, &properties);
14624                         }
14625                     }
14626                     Safefree(name);
14627                 }
14628                 RExC_parse = e + 1;
14629                 namedclass = ANYOF_UNIPROP;  /* no official name, but it's
14630                                                 named */
14631
14632                 /* \p means they want Unicode semantics */
14633                 RExC_uni_semantics = 1;
14634                 }
14635                 break;
14636             case 'n':   value = '\n';                   break;
14637             case 'r':   value = '\r';                   break;
14638             case 't':   value = '\t';                   break;
14639             case 'f':   value = '\f';                   break;
14640             case 'b':   value = '\b';                   break;
14641             case 'e':   value = ESC_NATIVE;             break;
14642             case 'a':   value = '\a';                   break;
14643             case 'o':
14644                 RExC_parse--;   /* function expects to be pointed at the 'o' */
14645                 {
14646                     const char* error_msg;
14647                     bool valid = grok_bslash_o(&RExC_parse,
14648                                                &value,
14649                                                &error_msg,
14650                                                PASS2,   /* warnings only in
14651                                                            pass 2 */
14652                                                strict,
14653                                                silence_non_portable,
14654                                                UTF);
14655                     if (! valid) {
14656                         vFAIL(error_msg);
14657                     }
14658                 }
14659                 non_portable_endpoint++;
14660                 if (IN_ENCODING && value < 0x100) {
14661                     goto recode_encoding;
14662                 }
14663                 break;
14664             case 'x':
14665                 RExC_parse--;   /* function expects to be pointed at the 'x' */
14666                 {
14667                     const char* error_msg;
14668                     bool valid = grok_bslash_x(&RExC_parse,
14669                                                &value,
14670                                                &error_msg,
14671                                                PASS2, /* Output warnings */
14672                                                strict,
14673                                                silence_non_portable,
14674                                                UTF);
14675                     if (! valid) {
14676                         vFAIL(error_msg);
14677                     }
14678                 }
14679                 non_portable_endpoint++;
14680                 if (IN_ENCODING && value < 0x100)
14681                     goto recode_encoding;
14682                 break;
14683             case 'c':
14684                 value = grok_bslash_c(*RExC_parse++, PASS2);
14685                 non_portable_endpoint++;
14686                 break;
14687             case '0': case '1': case '2': case '3': case '4':
14688             case '5': case '6': case '7':
14689                 {
14690                     /* Take 1-3 octal digits */
14691                     I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
14692                     numlen = (strict) ? 4 : 3;
14693                     value = grok_oct(--RExC_parse, &numlen, &flags, NULL);
14694                     RExC_parse += numlen;
14695                     if (numlen != 3) {
14696                         if (strict) {
14697                             RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
14698                             vFAIL("Need exactly 3 octal digits");
14699                         }
14700                         else if (! SIZE_ONLY /* like \08, \178 */
14701                                  && numlen < 3
14702                                  && RExC_parse < RExC_end
14703                                  && isDIGIT(*RExC_parse)
14704                                  && ckWARN(WARN_REGEXP))
14705                         {
14706                             SAVEFREESV(RExC_rx_sv);
14707                             reg_warn_non_literal_string(
14708                                  RExC_parse + 1,
14709                                  form_short_octal_warning(RExC_parse, numlen));
14710                             (void)ReREFCNT_inc(RExC_rx_sv);
14711                         }
14712                     }
14713                     non_portable_endpoint++;
14714                     if (IN_ENCODING && value < 0x100)
14715                         goto recode_encoding;
14716                     break;
14717                 }
14718               recode_encoding:
14719                 if (! RExC_override_recoding) {
14720                     SV* enc = _get_encoding();
14721                     value = reg_recode((const char)(U8)value, &enc);
14722                     if (!enc) {
14723                         if (strict) {
14724                             vFAIL("Invalid escape in the specified encoding");
14725                         }
14726                         else if (PASS2) {
14727                             ckWARNreg(RExC_parse,
14728                                   "Invalid escape in the specified encoding");
14729                         }
14730                     }
14731                     break;
14732                 }
14733             default:
14734                 /* Allow \_ to not give an error */
14735                 if (!SIZE_ONLY && isWORDCHAR(value) && value != '_') {
14736                     if (strict) {
14737                         vFAIL2("Unrecognized escape \\%c in character class",
14738                                (int)value);
14739                     }
14740                     else {
14741                         SAVEFREESV(RExC_rx_sv);
14742                         ckWARN2reg(RExC_parse,
14743                             "Unrecognized escape \\%c in character class passed through",
14744                             (int)value);
14745                         (void)ReREFCNT_inc(RExC_rx_sv);
14746                     }
14747                 }
14748                 break;
14749             }   /* End of switch on char following backslash */
14750         } /* end of handling backslash escape sequences */
14751
14752         /* Here, we have the current token in 'value' */
14753
14754         if (namedclass > OOB_NAMEDCLASS) { /* this is a named class \blah */
14755             U8 classnum;
14756
14757             /* a bad range like a-\d, a-[:digit:].  The '-' is taken as a
14758              * literal, as is the character that began the false range, i.e.
14759              * the 'a' in the examples */
14760             if (range) {
14761                 if (!SIZE_ONLY) {
14762                     const int w = (RExC_parse >= rangebegin)
14763                                   ? RExC_parse - rangebegin
14764                                   : 0;
14765                     if (strict) {
14766                         vFAIL2utf8f(
14767                             "False [] range \"%"UTF8f"\"",
14768                             UTF8fARG(UTF, w, rangebegin));
14769                     }
14770                     else {
14771                         SAVEFREESV(RExC_rx_sv); /* in case of fatal warnings */
14772                         ckWARN2reg(RExC_parse,
14773                             "False [] range \"%"UTF8f"\"",
14774                             UTF8fARG(UTF, w, rangebegin));
14775                         (void)ReREFCNT_inc(RExC_rx_sv);
14776                         cp_list = add_cp_to_invlist(cp_list, '-');
14777                         cp_foldable_list = add_cp_to_invlist(cp_foldable_list,
14778                                                              prevvalue);
14779                     }
14780                 }
14781
14782                 range = 0; /* this was not a true range */
14783                 element_count += 2; /* So counts for three values */
14784             }
14785
14786             classnum = namedclass_to_classnum(namedclass);
14787
14788             if (LOC && namedclass < ANYOF_POSIXL_MAX
14789 #ifndef HAS_ISASCII
14790                 && classnum != _CC_ASCII
14791 #endif
14792             ) {
14793                 /* What the Posix classes (like \w, [:space:]) match in locale
14794                  * isn't knowable under locale until actual match time.  Room
14795                  * must be reserved (one time per outer bracketed class) to
14796                  * store such classes.  The space will contain a bit for each
14797                  * named class that is to be matched against.  This isn't
14798                  * needed for \p{} and pseudo-classes, as they are not affected
14799                  * by locale, and hence are dealt with separately */
14800                 if (! need_class) {
14801                     need_class = 1;
14802                     if (SIZE_ONLY) {
14803                         RExC_size += ANYOF_POSIXL_SKIP - ANYOF_SKIP;
14804                     }
14805                     else {
14806                         RExC_emit += ANYOF_POSIXL_SKIP - ANYOF_SKIP;
14807                     }
14808                     ANYOF_FLAGS(ret) |= ANYOF_MATCHES_POSIXL;
14809                     ANYOF_POSIXL_ZERO(ret);
14810                 }
14811
14812                 /* Coverity thinks it is possible for this to be negative; both
14813                  * jhi and khw think it's not, but be safer */
14814                 assert(! (ANYOF_FLAGS(ret) & ANYOF_MATCHES_POSIXL)
14815                        || (namedclass + ((namedclass % 2) ? -1 : 1)) >= 0);
14816
14817                 /* See if it already matches the complement of this POSIX
14818                  * class */
14819                 if ((ANYOF_FLAGS(ret) & ANYOF_MATCHES_POSIXL)
14820                     && ANYOF_POSIXL_TEST(ret, namedclass + ((namedclass % 2)
14821                                                             ? -1
14822                                                             : 1)))
14823                 {
14824                     posixl_matches_all = TRUE;
14825                     break;  /* No need to continue.  Since it matches both
14826                                e.g., \w and \W, it matches everything, and the
14827                                bracketed class can be optimized into qr/./s */
14828                 }
14829
14830                 /* Add this class to those that should be checked at runtime */
14831                 ANYOF_POSIXL_SET(ret, namedclass);
14832
14833                 /* The above-Latin1 characters are not subject to locale rules.
14834                  * Just add them, in the second pass, to the
14835                  * unconditionally-matched list */
14836                 if (! SIZE_ONLY) {
14837                     SV* scratch_list = NULL;
14838
14839                     /* Get the list of the above-Latin1 code points this
14840                      * matches */
14841                     _invlist_intersection_maybe_complement_2nd(PL_AboveLatin1,
14842                                           PL_XPosix_ptrs[classnum],
14843
14844                                           /* Odd numbers are complements, like
14845                                            * NDIGIT, NASCII, ... */
14846                                           namedclass % 2 != 0,
14847                                           &scratch_list);
14848                     /* Checking if 'cp_list' is NULL first saves an extra
14849                      * clone.  Its reference count will be decremented at the
14850                      * next union, etc, or if this is the only instance, at the
14851                      * end of the routine */
14852                     if (! cp_list) {
14853                         cp_list = scratch_list;
14854                     }
14855                     else {
14856                         _invlist_union(cp_list, scratch_list, &cp_list);
14857                         SvREFCNT_dec_NN(scratch_list);
14858                     }
14859                     continue;   /* Go get next character */
14860                 }
14861             }
14862             else if (! SIZE_ONLY) {
14863
14864                 /* Here, not in pass1 (in that pass we skip calculating the
14865                  * contents of this class), and is /l, or is a POSIX class for
14866                  * which /l doesn't matter (or is a Unicode property, which is
14867                  * skipped here). */
14868                 if (namedclass >= ANYOF_POSIXL_MAX) {  /* If a special class */
14869                     if (namedclass != ANYOF_UNIPROP) { /* UNIPROP = \p and \P */
14870
14871                         /* Here, should be \h, \H, \v, or \V.  None of /d, /i
14872                          * nor /l make a difference in what these match,
14873                          * therefore we just add what they match to cp_list. */
14874                         if (classnum != _CC_VERTSPACE) {
14875                             assert(   namedclass == ANYOF_HORIZWS
14876                                    || namedclass == ANYOF_NHORIZWS);
14877
14878                             /* It turns out that \h is just a synonym for
14879                              * XPosixBlank */
14880                             classnum = _CC_BLANK;
14881                         }
14882
14883                         _invlist_union_maybe_complement_2nd(
14884                                 cp_list,
14885                                 PL_XPosix_ptrs[classnum],
14886                                 namedclass % 2 != 0,    /* Complement if odd
14887                                                           (NHORIZWS, NVERTWS)
14888                                                         */
14889                                 &cp_list);
14890                     }
14891                 }
14892                 else if (UNI_SEMANTICS
14893                         || classnum == _CC_ASCII
14894                         || (DEPENDS_SEMANTICS && (classnum == _CC_DIGIT
14895                                                   || classnum == _CC_XDIGIT)))
14896                 {
14897                     /* We usually have to worry about /d and /a affecting what
14898                      * POSIX classes match, with special code needed for /d
14899                      * because we won't know until runtime what all matches.
14900                      * But there is no extra work needed under /u, and
14901                      * [:ascii:] is unaffected by /a and /d; and :digit: and
14902                      * :xdigit: don't have runtime differences under /d.  So we
14903                      * can special case these, and avoid some extra work below,
14904                      * and at runtime. */
14905                     _invlist_union_maybe_complement_2nd(
14906                                                      simple_posixes,
14907                                                      PL_XPosix_ptrs[classnum],
14908                                                      namedclass % 2 != 0,
14909                                                      &simple_posixes);
14910                 }
14911                 else {  /* Garden variety class.  If is NUPPER, NALPHA, ...
14912                            complement and use nposixes */
14913                     SV** posixes_ptr = namedclass % 2 == 0
14914                                        ? &posixes
14915                                        : &nposixes;
14916                     _invlist_union_maybe_complement_2nd(
14917                                                      *posixes_ptr,
14918                                                      PL_XPosix_ptrs[classnum],
14919                                                      namedclass % 2 != 0,
14920                                                      posixes_ptr);
14921                 }
14922             }
14923         } /* end of namedclass \blah */
14924
14925         if (skip_white) {
14926             RExC_parse = regpatws(pRExC_state, RExC_parse,
14927                                 FALSE /* means don't recognize comments */ );
14928         }
14929
14930         /* If 'range' is set, 'value' is the ending of a range--check its
14931          * validity.  (If value isn't a single code point in the case of a
14932          * range, we should have figured that out above in the code that
14933          * catches false ranges).  Later, we will handle each individual code
14934          * point in the range.  If 'range' isn't set, this could be the
14935          * beginning of a range, so check for that by looking ahead to see if
14936          * the next real character to be processed is the range indicator--the
14937          * minus sign */
14938
14939         if (range) {
14940 #ifdef EBCDIC
14941             /* For unicode ranges, we have to test that the Unicode as opposed
14942              * to the native values are not decreasing.  (Above 255, there is
14943              * no difference between native and Unicode) */
14944             if (unicode_range && prevvalue < 255 && value < 255) {
14945                 if (NATIVE_TO_LATIN1(prevvalue) > NATIVE_TO_LATIN1(value)) {
14946                     goto backwards_range;
14947                 }
14948             }
14949             else
14950 #endif
14951             if (prevvalue > value) /* b-a */ {
14952                 int w;
14953 #ifdef EBCDIC
14954               backwards_range:
14955 #endif
14956                 w = RExC_parse - rangebegin;
14957                 vFAIL2utf8f(
14958                     "Invalid [] range \"%"UTF8f"\"",
14959                     UTF8fARG(UTF, w, rangebegin));
14960                 NOT_REACHED; /* NOTREACHED */
14961             }
14962         }
14963         else {
14964             prevvalue = value; /* save the beginning of the potential range */
14965             if (! stop_at_1     /* Can't be a range if parsing just one thing */
14966                 && *RExC_parse == '-')
14967             {
14968                 char* next_char_ptr = RExC_parse + 1;
14969                 if (skip_white) {   /* Get the next real char after the '-' */
14970                     next_char_ptr = regpatws(pRExC_state,
14971                                              RExC_parse + 1,
14972                                              FALSE); /* means don't recognize
14973                                                         comments */
14974                 }
14975
14976                 /* If the '-' is at the end of the class (just before the ']',
14977                  * it is a literal minus; otherwise it is a range */
14978                 if (next_char_ptr < RExC_end && *next_char_ptr != ']') {
14979                     RExC_parse = next_char_ptr;
14980
14981                     /* a bad range like \w-, [:word:]- ? */
14982                     if (namedclass > OOB_NAMEDCLASS) {
14983                         if (strict || (PASS2 && ckWARN(WARN_REGEXP))) {
14984                             const int w = RExC_parse >= rangebegin
14985                                           ?  RExC_parse - rangebegin
14986                                           : 0;
14987                             if (strict) {
14988                                 vFAIL4("False [] range \"%*.*s\"",
14989                                     w, w, rangebegin);
14990                             }
14991                             else if (PASS2) {
14992                                 vWARN4(RExC_parse,
14993                                     "False [] range \"%*.*s\"",
14994                                     w, w, rangebegin);
14995                             }
14996                         }
14997                         if (!SIZE_ONLY) {
14998                             cp_list = add_cp_to_invlist(cp_list, '-');
14999                         }
15000                         element_count++;
15001                     } else
15002                         range = 1;      /* yeah, it's a range! */
15003                     continue;   /* but do it the next time */
15004                 }
15005             }
15006         }
15007
15008         if (namedclass > OOB_NAMEDCLASS) {
15009             continue;
15010         }
15011
15012         /* Here, we have a single value this time through the loop, and
15013          * <prevvalue> is the beginning of the range, if any; or <value> if
15014          * not. */
15015
15016         /* non-Latin1 code point implies unicode semantics.  Must be set in
15017          * pass1 so is there for the whole of pass 2 */
15018         if (value > 255) {
15019             RExC_uni_semantics = 1;
15020         }
15021
15022         /* Ready to process either the single value, or the completed range.
15023          * For single-valued non-inverted ranges, we consider the possibility
15024          * of multi-char folds.  (We made a conscious decision to not do this
15025          * for the other cases because it can often lead to non-intuitive
15026          * results.  For example, you have the peculiar case that:
15027          *  "s s" =~ /^[^\xDF]+$/i => Y
15028          *  "ss"  =~ /^[^\xDF]+$/i => N
15029          *
15030          * See [perl #89750] */
15031         if (FOLD && allow_multi_folds && value == prevvalue) {
15032             if (value == LATIN_SMALL_LETTER_SHARP_S
15033                 || (value > 255 && _invlist_contains_cp(PL_HasMultiCharFold,
15034                                                         value)))
15035             {
15036                 /* Here <value> is indeed a multi-char fold.  Get what it is */
15037
15038                 U8 foldbuf[UTF8_MAXBYTES_CASE];
15039                 STRLEN foldlen;
15040
15041                 UV folded = _to_uni_fold_flags(
15042                                 value,
15043                                 foldbuf,
15044                                 &foldlen,
15045                                 FOLD_FLAGS_FULL | (ASCII_FOLD_RESTRICTED
15046                                                    ? FOLD_FLAGS_NOMIX_ASCII
15047                                                    : 0)
15048                                 );
15049
15050                 /* Here, <folded> should be the first character of the
15051                  * multi-char fold of <value>, with <foldbuf> containing the
15052                  * whole thing.  But, if this fold is not allowed (because of
15053                  * the flags), <fold> will be the same as <value>, and should
15054                  * be processed like any other character, so skip the special
15055                  * handling */
15056                 if (folded != value) {
15057
15058                     /* Skip if we are recursed, currently parsing the class
15059                      * again.  Otherwise add this character to the list of
15060                      * multi-char folds. */
15061                     if (! RExC_in_multi_char_class) {
15062                         STRLEN cp_count = utf8_length(foldbuf,
15063                                                       foldbuf + foldlen);
15064                         SV* multi_fold = sv_2mortal(newSVpvs(""));
15065
15066                         Perl_sv_catpvf(aTHX_ multi_fold, "\\x{%"UVXf"}", value);
15067
15068                         multi_char_matches
15069                                         = add_multi_match(multi_char_matches,
15070                                                           multi_fold,
15071                                                           cp_count);
15072
15073                     }
15074
15075                     /* This element should not be processed further in this
15076                      * class */
15077                     element_count--;
15078                     value = save_value;
15079                     prevvalue = save_prevvalue;
15080                     continue;
15081                 }
15082             }
15083         }
15084
15085         if (strict && PASS2 && ckWARN(WARN_REGEXP)) {
15086             if (range) {
15087
15088                 /* If the range starts above 255, everything is portable and
15089                  * likely to be so for any forseeable character set, so don't
15090                  * warn. */
15091                 if (unicode_range && non_portable_endpoint && prevvalue < 256) {
15092                     vWARN(RExC_parse, "Both or neither range ends should be Unicode");
15093                 }
15094                 else if (prevvalue != value) {
15095
15096                     /* Under strict, ranges that stop and/or end in an ASCII
15097                      * printable should have each end point be a portable value
15098                      * for it (preferably like 'A', but we don't warn if it is
15099                      * a (portable) Unicode name or code point), and the range
15100                      * must be be all digits or all letters of the same case.
15101                      * Otherwise, the range is non-portable and unclear as to
15102                      * what it contains */
15103                     if ((isPRINT_A(prevvalue) || isPRINT_A(value))
15104                         && (non_portable_endpoint
15105                             || ! ((isDIGIT_A(prevvalue) && isDIGIT_A(value))
15106                                    || (isLOWER_A(prevvalue) && isLOWER_A(value))
15107                                    || (isUPPER_A(prevvalue) && isUPPER_A(value)))))
15108                     {
15109                         vWARN(RExC_parse, "Ranges of ASCII printables should be some subset of \"0-9\", \"A-Z\", or \"a-z\"");
15110                     }
15111                     else if (prevvalue >= 0x660) { /* ARABIC_INDIC_DIGIT_ZERO */
15112
15113                         /* But the nature of Unicode and languages mean we
15114                          * can't do the same checks for above-ASCII ranges,
15115                          * except in the case of digit ones.  These should
15116                          * contain only digits from the same group of 10.  The
15117                          * ASCII case is handled just above.  0x660 is the
15118                          * first digit character beyond ASCII.  Hence here, the
15119                          * range could be a range of digits.  Find out.  */
15120                         IV index_start = _invlist_search(PL_XPosix_ptrs[_CC_DIGIT],
15121                                                          prevvalue);
15122                         IV index_final = _invlist_search(PL_XPosix_ptrs[_CC_DIGIT],
15123                                                          value);
15124
15125                         /* If the range start and final points are in the same
15126                          * inversion list element, it means that either both
15127                          * are not digits, or both are digits in a consecutive
15128                          * sequence of digits.  (So far, Unicode has kept all
15129                          * such sequences as distinct groups of 10, but assert
15130                          * to make sure).  If the end points are not in the
15131                          * same element, neither should be a digit. */
15132                         if (index_start == index_final) {
15133                             assert(! ELEMENT_RANGE_MATCHES_INVLIST(index_start)
15134                             || (invlist_array(PL_XPosix_ptrs[_CC_DIGIT])[index_start+1]
15135                                - invlist_array(PL_XPosix_ptrs[_CC_DIGIT])[index_start]
15136                                == 10)
15137                                /* But actually Unicode did have one group of 11
15138                                 * 'digits' in 5.2, so in case we are operating
15139                                 * on that version, let that pass */
15140                             || (invlist_array(PL_XPosix_ptrs[_CC_DIGIT])[index_start+1]
15141                                - invlist_array(PL_XPosix_ptrs[_CC_DIGIT])[index_start]
15142                                 == 11
15143                                && invlist_array(PL_XPosix_ptrs[_CC_DIGIT])[index_start]
15144                                 == 0x19D0)
15145                             );
15146                         }
15147                         else if ((index_start >= 0
15148                                   && ELEMENT_RANGE_MATCHES_INVLIST(index_start))
15149                                  || (index_final >= 0
15150                                      && ELEMENT_RANGE_MATCHES_INVLIST(index_final)))
15151                         {
15152                             vWARN(RExC_parse, "Ranges of digits should be from the same group of 10");
15153                         }
15154                     }
15155                 }
15156             }
15157             if ((! range || prevvalue == value) && non_portable_endpoint) {
15158                 if (isPRINT_A(value)) {
15159                     char literal[3];
15160                     unsigned d = 0;
15161                     if (isBACKSLASHED_PUNCT(value)) {
15162                         literal[d++] = '\\';
15163                     }
15164                     literal[d++] = (char) value;
15165                     literal[d++] = '\0';
15166
15167                     vWARN4(RExC_parse,
15168                            "\"%.*s\" is more clearly written simply as \"%s\"",
15169                            (int) (RExC_parse - rangebegin),
15170                            rangebegin,
15171                            literal
15172                         );
15173                 }
15174                 else if isMNEMONIC_CNTRL(value) {
15175                     vWARN4(RExC_parse,
15176                            "\"%.*s\" is more clearly written simply as \"%s\"",
15177                            (int) (RExC_parse - rangebegin),
15178                            rangebegin,
15179                            cntrl_to_mnemonic((char) value)
15180                         );
15181                 }
15182             }
15183         }
15184
15185         /* Deal with this element of the class */
15186         if (! SIZE_ONLY) {
15187
15188 #ifndef EBCDIC
15189             cp_foldable_list = _add_range_to_invlist(cp_foldable_list,
15190                                                      prevvalue, value);
15191 #else
15192             /* On non-ASCII platforms, for ranges that span all of 0..255, and
15193              * ones that don't require special handling, we can just add the
15194              * range like we do for ASCII platforms */
15195             if ((UNLIKELY(prevvalue == 0) && value >= 255)
15196                 || ! (prevvalue < 256
15197                       && (unicode_range
15198                           || (! non_portable_endpoint
15199                               && ((isLOWER_A(prevvalue) && isLOWER_A(value))
15200                                   || (isUPPER_A(prevvalue)
15201                                       && isUPPER_A(value)))))))
15202             {
15203                 cp_foldable_list = _add_range_to_invlist(cp_foldable_list,
15204                                                          prevvalue, value);
15205             }
15206             else {
15207                 /* Here, requires special handling.  This can be because it is
15208                  * a range whose code points are considered to be Unicode, and
15209                  * so must be individually translated into native, or because
15210                  * its a subrange of 'A-Z' or 'a-z' which each aren't
15211                  * contiguous in EBCDIC, but we have defined them to include
15212                  * only the "expected" upper or lower case ASCII alphabetics.
15213                  * Subranges above 255 are the same in native and Unicode, so
15214                  * can be added as a range */
15215                 U8 start = NATIVE_TO_LATIN1(prevvalue);
15216                 unsigned j;
15217                 U8 end = (value < 256) ? NATIVE_TO_LATIN1(value) : 255;
15218                 for (j = start; j <= end; j++) {
15219                     cp_foldable_list = add_cp_to_invlist(cp_foldable_list, LATIN1_TO_NATIVE(j));
15220                 }
15221                 if (value > 255) {
15222                     cp_foldable_list = _add_range_to_invlist(cp_foldable_list,
15223                                                              256, value);
15224                 }
15225             }
15226 #endif
15227         }
15228
15229         range = 0; /* this range (if it was one) is done now */
15230     } /* End of loop through all the text within the brackets */
15231
15232     /* If anything in the class expands to more than one character, we have to
15233      * deal with them by building up a substitute parse string, and recursively
15234      * calling reg() on it, instead of proceeding */
15235     if (multi_char_matches) {
15236         SV * substitute_parse = newSVpvn_flags("?:", 2, SVs_TEMP);
15237         I32 cp_count;
15238         STRLEN len;
15239         char *save_end = RExC_end;
15240         char *save_parse = RExC_parse;
15241         bool first_time = TRUE;     /* First multi-char occurrence doesn't get
15242                                        a "|" */
15243         I32 reg_flags;
15244
15245         assert(! invert);
15246 #if 0   /* Have decided not to deal with multi-char folds in inverted classes,
15247            because too confusing */
15248         if (invert) {
15249             sv_catpv(substitute_parse, "(?:");
15250         }
15251 #endif
15252
15253         /* Look at the longest folds first */
15254         for (cp_count = av_tindex(multi_char_matches); cp_count > 0; cp_count--) {
15255
15256             if (av_exists(multi_char_matches, cp_count)) {
15257                 AV** this_array_ptr;
15258                 SV* this_sequence;
15259
15260                 this_array_ptr = (AV**) av_fetch(multi_char_matches,
15261                                                  cp_count, FALSE);
15262                 while ((this_sequence = av_pop(*this_array_ptr)) !=
15263                                                                 &PL_sv_undef)
15264                 {
15265                     if (! first_time) {
15266                         sv_catpv(substitute_parse, "|");
15267                     }
15268                     first_time = FALSE;
15269
15270                     sv_catpv(substitute_parse, SvPVX(this_sequence));
15271                 }
15272             }
15273         }
15274
15275         /* If the character class contains anything else besides these
15276          * multi-character folds, have to include it in recursive parsing */
15277         if (element_count) {
15278             sv_catpv(substitute_parse, "|[");
15279             sv_catpvn(substitute_parse, orig_parse, RExC_parse - orig_parse);
15280             sv_catpv(substitute_parse, "]");
15281         }
15282
15283         sv_catpv(substitute_parse, ")");
15284 #if 0
15285         if (invert) {
15286             /* This is a way to get the parse to skip forward a whole named
15287              * sequence instead of matching the 2nd character when it fails the
15288              * first */
15289             sv_catpv(substitute_parse, "(*THEN)(*SKIP)(*FAIL)|.)");
15290         }
15291 #endif
15292
15293         RExC_parse = SvPV(substitute_parse, len);
15294         RExC_end = RExC_parse + len;
15295         RExC_in_multi_char_class = 1;
15296         RExC_override_recoding = 1;
15297         RExC_emit = (regnode *)orig_emit;
15298
15299         ret = reg(pRExC_state, 1, &reg_flags, depth+1);
15300
15301         *flagp |= reg_flags&(HASWIDTH|SIMPLE|SPSTART|POSTPONED|RESTART_UTF8);
15302
15303         RExC_parse = save_parse;
15304         RExC_end = save_end;
15305         RExC_in_multi_char_class = 0;
15306         RExC_override_recoding = 0;
15307         SvREFCNT_dec_NN(multi_char_matches);
15308         return ret;
15309     }
15310
15311     /* Here, we've gone through the entire class and dealt with multi-char
15312      * folds.  We are now in a position that we can do some checks to see if we
15313      * can optimize this ANYOF node into a simpler one, even in Pass 1.
15314      * Currently we only do two checks:
15315      * 1) is in the unlikely event that the user has specified both, eg. \w and
15316      *    \W under /l, then the class matches everything.  (This optimization
15317      *    is done only to make the optimizer code run later work.)
15318      * 2) if the character class contains only a single element (including a
15319      *    single range), we see if there is an equivalent node for it.
15320      * Other checks are possible */
15321     if (! ret_invlist   /* Can't optimize if returning the constructed
15322                            inversion list */
15323         && (UNLIKELY(posixl_matches_all) || element_count == 1))
15324     {
15325         U8 op = END;
15326         U8 arg = 0;
15327
15328         if (UNLIKELY(posixl_matches_all)) {
15329             op = SANY;
15330         }
15331         else if (namedclass > OOB_NAMEDCLASS) { /* this is a named class, like
15332                                                    \w or [:digit:] or \p{foo}
15333                                                  */
15334
15335             /* All named classes are mapped into POSIXish nodes, with its FLAG
15336              * argument giving which class it is */
15337             switch ((I32)namedclass) {
15338                 case ANYOF_UNIPROP:
15339                     break;
15340
15341                 /* These don't depend on the charset modifiers.  They always
15342                  * match under /u rules */
15343                 case ANYOF_NHORIZWS:
15344                 case ANYOF_HORIZWS:
15345                     namedclass = ANYOF_BLANK + namedclass - ANYOF_HORIZWS;
15346                     /* FALLTHROUGH */
15347
15348                 case ANYOF_NVERTWS:
15349                 case ANYOF_VERTWS:
15350                     op = POSIXU;
15351                     goto join_posix;
15352
15353                 /* The actual POSIXish node for all the rest depends on the
15354                  * charset modifier.  The ones in the first set depend only on
15355                  * ASCII or, if available on this platform, also locale */
15356                 case ANYOF_ASCII:
15357                 case ANYOF_NASCII:
15358 #ifdef HAS_ISASCII
15359                     op = (LOC) ? POSIXL : POSIXA;
15360 #else
15361                     op = POSIXA;
15362 #endif
15363                     goto join_posix;
15364
15365                 /* The following don't have any matches in the upper Latin1
15366                  * range, hence /d is equivalent to /u for them.  Making it /u
15367                  * saves some branches at runtime */
15368                 case ANYOF_DIGIT:
15369                 case ANYOF_NDIGIT:
15370                 case ANYOF_XDIGIT:
15371                 case ANYOF_NXDIGIT:
15372                     if (! DEPENDS_SEMANTICS) {
15373                         goto treat_as_default;
15374                     }
15375
15376                     op = POSIXU;
15377                     goto join_posix;
15378
15379                 /* The following change to CASED under /i */
15380                 case ANYOF_LOWER:
15381                 case ANYOF_NLOWER:
15382                 case ANYOF_UPPER:
15383                 case ANYOF_NUPPER:
15384                     if (FOLD) {
15385                         namedclass = ANYOF_CASED + (namedclass % 2);
15386                     }
15387                     /* FALLTHROUGH */
15388
15389                 /* The rest have more possibilities depending on the charset.
15390                  * We take advantage of the enum ordering of the charset
15391                  * modifiers to get the exact node type, */
15392                 default:
15393                   treat_as_default:
15394                     op = POSIXD + get_regex_charset(RExC_flags);
15395                     if (op > POSIXA) { /* /aa is same as /a */
15396                         op = POSIXA;
15397                     }
15398
15399                   join_posix:
15400                     /* The odd numbered ones are the complements of the
15401                      * next-lower even number one */
15402                     if (namedclass % 2 == 1) {
15403                         invert = ! invert;
15404                         namedclass--;
15405                     }
15406                     arg = namedclass_to_classnum(namedclass);
15407                     break;
15408             }
15409         }
15410         else if (value == prevvalue) {
15411
15412             /* Here, the class consists of just a single code point */
15413
15414             if (invert) {
15415                 if (! LOC && value == '\n') {
15416                     op = REG_ANY; /* Optimize [^\n] */
15417                     *flagp |= HASWIDTH|SIMPLE;
15418                     MARK_NAUGHTY(1);
15419                 }
15420             }
15421             else if (value < 256 || UTF) {
15422
15423                 /* Optimize a single value into an EXACTish node, but not if it
15424                  * would require converting the pattern to UTF-8. */
15425                 op = compute_EXACTish(pRExC_state);
15426             }
15427         } /* Otherwise is a range */
15428         else if (! LOC) {   /* locale could vary these */
15429             if (prevvalue == '0') {
15430                 if (value == '9') {
15431                     arg = _CC_DIGIT;
15432                     op = POSIXA;
15433                 }
15434             }
15435             else if (! FOLD || ASCII_FOLD_RESTRICTED) {
15436                 /* We can optimize A-Z or a-z, but not if they could match
15437                  * something like the KELVIN SIGN under /i. */
15438                 if (prevvalue == 'A') {
15439                     if (value == 'Z'
15440 #ifdef EBCDIC
15441                         && ! non_portable_endpoint
15442 #endif
15443                     ) {
15444                         arg = (FOLD) ? _CC_ALPHA : _CC_UPPER;
15445                         op = POSIXA;
15446                     }
15447                 }
15448                 else if (prevvalue == 'a') {
15449                     if (value == 'z'
15450 #ifdef EBCDIC
15451                         && ! non_portable_endpoint
15452 #endif
15453                     ) {
15454                         arg = (FOLD) ? _CC_ALPHA : _CC_LOWER;
15455                         op = POSIXA;
15456                     }
15457                 }
15458             }
15459         }
15460
15461         /* Here, we have changed <op> away from its initial value iff we found
15462          * an optimization */
15463         if (op != END) {
15464
15465             /* Throw away this ANYOF regnode, and emit the calculated one,
15466              * which should correspond to the beginning, not current, state of
15467              * the parse */
15468             const char * cur_parse = RExC_parse;
15469             RExC_parse = (char *)orig_parse;
15470             if ( SIZE_ONLY) {
15471                 if (! LOC) {
15472
15473                     /* To get locale nodes to not use the full ANYOF size would
15474                      * require moving the code above that writes the portions
15475                      * of it that aren't in other nodes to after this point.
15476                      * e.g.  ANYOF_POSIXL_SET */
15477                     RExC_size = orig_size;
15478                 }
15479             }
15480             else {
15481                 RExC_emit = (regnode *)orig_emit;
15482                 if (PL_regkind[op] == POSIXD) {
15483                     if (op == POSIXL) {
15484                         RExC_contains_locale = 1;
15485                     }
15486                     if (invert) {
15487                         op += NPOSIXD - POSIXD;
15488                     }
15489                 }
15490             }
15491
15492             ret = reg_node(pRExC_state, op);
15493
15494             if (PL_regkind[op] == POSIXD || PL_regkind[op] == NPOSIXD) {
15495                 if (! SIZE_ONLY) {
15496                     FLAGS(ret) = arg;
15497                 }
15498                 *flagp |= HASWIDTH|SIMPLE;
15499             }
15500             else if (PL_regkind[op] == EXACT) {
15501                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, 0, value,
15502                                            TRUE /* downgradable to EXACT */
15503                                            );
15504             }
15505
15506             RExC_parse = (char *) cur_parse;
15507
15508             SvREFCNT_dec(posixes);
15509             SvREFCNT_dec(nposixes);
15510             SvREFCNT_dec(simple_posixes);
15511             SvREFCNT_dec(cp_list);
15512             SvREFCNT_dec(cp_foldable_list);
15513             return ret;
15514         }
15515     }
15516
15517     if (SIZE_ONLY)
15518         return ret;
15519     /****** !SIZE_ONLY (Pass 2) AFTER HERE *********/
15520
15521     /* If folding, we calculate all characters that could fold to or from the
15522      * ones already on the list */
15523     if (cp_foldable_list) {
15524         if (FOLD) {
15525             UV start, end;      /* End points of code point ranges */
15526
15527             SV* fold_intersection = NULL;
15528             SV** use_list;
15529
15530             /* Our calculated list will be for Unicode rules.  For locale
15531              * matching, we have to keep a separate list that is consulted at
15532              * runtime only when the locale indicates Unicode rules.  For
15533              * non-locale, we just use to the general list */
15534             if (LOC) {
15535                 use_list = &only_utf8_locale_list;
15536             }
15537             else {
15538                 use_list = &cp_list;
15539             }
15540
15541             /* Only the characters in this class that participate in folds need
15542              * be checked.  Get the intersection of this class and all the
15543              * possible characters that are foldable.  This can quickly narrow
15544              * down a large class */
15545             _invlist_intersection(PL_utf8_foldable, cp_foldable_list,
15546                                   &fold_intersection);
15547
15548             /* The folds for all the Latin1 characters are hard-coded into this
15549              * program, but we have to go out to disk to get the others. */
15550             if (invlist_highest(cp_foldable_list) >= 256) {
15551
15552                 /* This is a hash that for a particular fold gives all
15553                  * characters that are involved in it */
15554                 if (! PL_utf8_foldclosures) {
15555                     _load_PL_utf8_foldclosures();
15556                 }
15557             }
15558
15559             /* Now look at the foldable characters in this class individually */
15560             invlist_iterinit(fold_intersection);
15561             while (invlist_iternext(fold_intersection, &start, &end)) {
15562                 UV j;
15563
15564                 /* Look at every character in the range */
15565                 for (j = start; j <= end; j++) {
15566                     U8 foldbuf[UTF8_MAXBYTES_CASE+1];
15567                     STRLEN foldlen;
15568                     SV** listp;
15569
15570                     if (j < 256) {
15571
15572                         if (IS_IN_SOME_FOLD_L1(j)) {
15573
15574                             /* ASCII is always matched; non-ASCII is matched
15575                              * only under Unicode rules (which could happen
15576                              * under /l if the locale is a UTF-8 one */
15577                             if (isASCII(j) || ! DEPENDS_SEMANTICS) {
15578                                 *use_list = add_cp_to_invlist(*use_list,
15579                                                             PL_fold_latin1[j]);
15580                             }
15581                             else {
15582                                 depends_list =
15583                                  add_cp_to_invlist(depends_list,
15584                                                    PL_fold_latin1[j]);
15585                             }
15586                         }
15587
15588                         if (HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(j)
15589                             && (! isASCII(j) || ! ASCII_FOLD_RESTRICTED))
15590                         {
15591                             add_above_Latin1_folds(pRExC_state,
15592                                                    (U8) j,
15593                                                    use_list);
15594                         }
15595                         continue;
15596                     }
15597
15598                     /* Here is an above Latin1 character.  We don't have the
15599                      * rules hard-coded for it.  First, get its fold.  This is
15600                      * the simple fold, as the multi-character folds have been
15601                      * handled earlier and separated out */
15602                     _to_uni_fold_flags(j, foldbuf, &foldlen,
15603                                                         (ASCII_FOLD_RESTRICTED)
15604                                                         ? FOLD_FLAGS_NOMIX_ASCII
15605                                                         : 0);
15606
15607                     /* Single character fold of above Latin1.  Add everything in
15608                     * its fold closure to the list that this node should match.
15609                     * The fold closures data structure is a hash with the keys
15610                     * being the UTF-8 of every character that is folded to, like
15611                     * 'k', and the values each an array of all code points that
15612                     * fold to its key.  e.g. [ 'k', 'K', KELVIN_SIGN ].
15613                     * Multi-character folds are not included */
15614                     if ((listp = hv_fetch(PL_utf8_foldclosures,
15615                                         (char *) foldbuf, foldlen, FALSE)))
15616                     {
15617                         AV* list = (AV*) *listp;
15618                         IV k;
15619                         for (k = 0; k <= av_tindex(list); k++) {
15620                             SV** c_p = av_fetch(list, k, FALSE);
15621                             UV c;
15622                             assert(c_p);
15623
15624                             c = SvUV(*c_p);
15625
15626                             /* /aa doesn't allow folds between ASCII and non- */
15627                             if ((ASCII_FOLD_RESTRICTED
15628                                 && (isASCII(c) != isASCII(j))))
15629                             {
15630                                 continue;
15631                             }
15632
15633                             /* Folds under /l which cross the 255/256 boundary
15634                              * are added to a separate list.  (These are valid
15635                              * only when the locale is UTF-8.) */
15636                             if (c < 256 && LOC) {
15637                                 *use_list = add_cp_to_invlist(*use_list, c);
15638                                 continue;
15639                             }
15640
15641                             if (isASCII(c) || c > 255 || AT_LEAST_UNI_SEMANTICS)
15642                             {
15643                                 cp_list = add_cp_to_invlist(cp_list, c);
15644                             }
15645                             else {
15646                                 /* Similarly folds involving non-ascii Latin1
15647                                 * characters under /d are added to their list */
15648                                 depends_list = add_cp_to_invlist(depends_list,
15649                                                                  c);
15650                             }
15651                         }
15652                     }
15653                 }
15654             }
15655             SvREFCNT_dec_NN(fold_intersection);
15656         }
15657
15658         /* Now that we have finished adding all the folds, there is no reason
15659          * to keep the foldable list separate */
15660         _invlist_union(cp_list, cp_foldable_list, &cp_list);
15661         SvREFCNT_dec_NN(cp_foldable_list);
15662     }
15663
15664     /* And combine the result (if any) with any inversion list from posix
15665      * classes.  The lists are kept separate up to now because we don't want to
15666      * fold the classes (folding of those is automatically handled by the swash
15667      * fetching code) */
15668     if (simple_posixes) {
15669         _invlist_union(cp_list, simple_posixes, &cp_list);
15670         SvREFCNT_dec_NN(simple_posixes);
15671     }
15672     if (posixes || nposixes) {
15673         if (posixes && AT_LEAST_ASCII_RESTRICTED) {
15674             /* Under /a and /aa, nothing above ASCII matches these */
15675             _invlist_intersection(posixes,
15676                                   PL_XPosix_ptrs[_CC_ASCII],
15677                                   &posixes);
15678         }
15679         if (nposixes) {
15680             if (DEPENDS_SEMANTICS) {
15681                 /* Under /d, everything in the upper half of the Latin1 range
15682                  * matches these complements */
15683                 ANYOF_FLAGS(ret) |= ANYOF_MATCHES_ALL_NON_UTF8_NON_ASCII;
15684             }
15685             else if (AT_LEAST_ASCII_RESTRICTED) {
15686                 /* Under /a and /aa, everything above ASCII matches these
15687                  * complements */
15688                 _invlist_union_complement_2nd(nposixes,
15689                                               PL_XPosix_ptrs[_CC_ASCII],
15690                                               &nposixes);
15691             }
15692             if (posixes) {
15693                 _invlist_union(posixes, nposixes, &posixes);
15694                 SvREFCNT_dec_NN(nposixes);
15695             }
15696             else {
15697                 posixes = nposixes;
15698             }
15699         }
15700         if (! DEPENDS_SEMANTICS) {
15701             if (cp_list) {
15702                 _invlist_union(cp_list, posixes, &cp_list);
15703                 SvREFCNT_dec_NN(posixes);
15704             }
15705             else {
15706                 cp_list = posixes;
15707             }
15708         }
15709         else {
15710             /* Under /d, we put into a separate list the Latin1 things that
15711              * match only when the target string is utf8 */
15712             SV* nonascii_but_latin1_properties = NULL;
15713             _invlist_intersection(posixes, PL_UpperLatin1,
15714                                   &nonascii_but_latin1_properties);
15715             _invlist_subtract(posixes, nonascii_but_latin1_properties,
15716                               &posixes);
15717             if (cp_list) {
15718                 _invlist_union(cp_list, posixes, &cp_list);
15719                 SvREFCNT_dec_NN(posixes);
15720             }
15721             else {
15722                 cp_list = posixes;
15723             }
15724
15725             if (depends_list) {
15726                 _invlist_union(depends_list, nonascii_but_latin1_properties,
15727                                &depends_list);
15728                 SvREFCNT_dec_NN(nonascii_but_latin1_properties);
15729             }
15730             else {
15731                 depends_list = nonascii_but_latin1_properties;
15732             }
15733         }
15734     }
15735
15736     /* And combine the result (if any) with any inversion list from properties.
15737      * The lists are kept separate up to now so that we can distinguish the two
15738      * in regards to matching above-Unicode.  A run-time warning is generated
15739      * if a Unicode property is matched against a non-Unicode code point. But,
15740      * we allow user-defined properties to match anything, without any warning,
15741      * and we also suppress the warning if there is a portion of the character
15742      * class that isn't a Unicode property, and which matches above Unicode, \W
15743      * or [\x{110000}] for example.
15744      * (Note that in this case, unlike the Posix one above, there is no
15745      * <depends_list>, because having a Unicode property forces Unicode
15746      * semantics */
15747     if (properties) {
15748         if (cp_list) {
15749
15750             /* If it matters to the final outcome, see if a non-property
15751              * component of the class matches above Unicode.  If so, the
15752              * warning gets suppressed.  This is true even if just a single
15753              * such code point is specified, as though not strictly correct if
15754              * another such code point is matched against, the fact that they
15755              * are using above-Unicode code points indicates they should know
15756              * the issues involved */
15757             if (warn_super) {
15758                 warn_super = ! (invert
15759                                ^ (invlist_highest(cp_list) > PERL_UNICODE_MAX));
15760             }
15761
15762             _invlist_union(properties, cp_list, &cp_list);
15763             SvREFCNT_dec_NN(properties);
15764         }
15765         else {
15766             cp_list = properties;
15767         }
15768
15769         if (warn_super) {
15770             ANYOF_FLAGS(ret) |= ANYOF_WARN_SUPER;
15771         }
15772     }
15773
15774     /* Here, we have calculated what code points should be in the character
15775      * class.
15776      *
15777      * Now we can see about various optimizations.  Fold calculation (which we
15778      * did above) needs to take place before inversion.  Otherwise /[^k]/i
15779      * would invert to include K, which under /i would match k, which it
15780      * shouldn't.  Therefore we can't invert folded locale now, as it won't be
15781      * folded until runtime */
15782
15783     /* If we didn't do folding, it's because some information isn't available
15784      * until runtime; set the run-time fold flag for these.  (We don't have to
15785      * worry about properties folding, as that is taken care of by the swash
15786      * fetching).  We know to set the flag if we have a non-NULL list for UTF-8
15787      * locales, or the class matches at least one 0-255 range code point */
15788     if (LOC && FOLD) {
15789         if (only_utf8_locale_list) {
15790             ANYOF_FLAGS(ret) |= ANYOF_LOC_FOLD;
15791         }
15792         else if (cp_list) { /* Look to see if there a 0-255 code point is in
15793                                the list */
15794             UV start, end;
15795             invlist_iterinit(cp_list);
15796             if (invlist_iternext(cp_list, &start, &end) && start < 256) {
15797                 ANYOF_FLAGS(ret) |= ANYOF_LOC_FOLD;
15798             }
15799             invlist_iterfinish(cp_list);
15800         }
15801     }
15802
15803     /* Optimize inverted simple patterns (e.g. [^a-z]) when everything is known
15804      * at compile time.  Besides not inverting folded locale now, we can't
15805      * invert if there are things such as \w, which aren't known until runtime
15806      * */
15807     if (cp_list
15808         && invert
15809         && ! (ANYOF_FLAGS(ret) & (ANYOF_LOCALE_FLAGS))
15810         && ! depends_list
15811         && ! HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
15812     {
15813         _invlist_invert(cp_list);
15814
15815         /* Any swash can't be used as-is, because we've inverted things */
15816         if (swash) {
15817             SvREFCNT_dec_NN(swash);
15818             swash = NULL;
15819         }
15820
15821         /* Clear the invert flag since have just done it here */
15822         invert = FALSE;
15823     }
15824
15825     if (ret_invlist) {
15826         assert(cp_list);
15827
15828         *ret_invlist = cp_list;
15829         SvREFCNT_dec(swash);
15830
15831         /* Discard the generated node */
15832         if (SIZE_ONLY) {
15833             RExC_size = orig_size;
15834         }
15835         else {
15836             RExC_emit = orig_emit;
15837         }
15838         return orig_emit;
15839     }
15840
15841     /* Some character classes are equivalent to other nodes.  Such nodes take
15842      * up less room and generally fewer operations to execute than ANYOF nodes.
15843      * Above, we checked for and optimized into some such equivalents for
15844      * certain common classes that are easy to test.  Getting to this point in
15845      * the code means that the class didn't get optimized there.  Since this
15846      * code is only executed in Pass 2, it is too late to save space--it has
15847      * been allocated in Pass 1, and currently isn't given back.  But turning
15848      * things into an EXACTish node can allow the optimizer to join it to any
15849      * adjacent such nodes.  And if the class is equivalent to things like /./,
15850      * expensive run-time swashes can be avoided.  Now that we have more
15851      * complete information, we can find things necessarily missed by the
15852      * earlier code.  I (khw) am not sure how much to look for here.  It would
15853      * be easy, but perhaps too slow, to check any candidates against all the
15854      * node types they could possibly match using _invlistEQ(). */
15855
15856     if (cp_list
15857         && ! invert
15858         && ! depends_list
15859         && ! (ANYOF_FLAGS(ret) & (ANYOF_LOCALE_FLAGS))
15860         && ! HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION
15861
15862            /* We don't optimize if we are supposed to make sure all non-Unicode
15863             * code points raise a warning, as only ANYOF nodes have this check.
15864             * */
15865         && ! ((ANYOF_FLAGS(ret) & ANYOF_WARN_SUPER) && ALWAYS_WARN_SUPER))
15866     {
15867         UV start, end;
15868         U8 op = END;  /* The optimzation node-type */
15869         const char * cur_parse= RExC_parse;
15870
15871         invlist_iterinit(cp_list);
15872         if (! invlist_iternext(cp_list, &start, &end)) {
15873
15874             /* Here, the list is empty.  This happens, for example, when a
15875              * Unicode property is the only thing in the character class, and
15876              * it doesn't match anything.  (perluniprops.pod notes such
15877              * properties) */
15878             op = OPFAIL;
15879             *flagp |= HASWIDTH|SIMPLE;
15880         }
15881         else if (start == end) {    /* The range is a single code point */
15882             if (! invlist_iternext(cp_list, &start, &end)
15883
15884                     /* Don't do this optimization if it would require changing
15885                      * the pattern to UTF-8 */
15886                 && (start < 256 || UTF))
15887             {
15888                 /* Here, the list contains a single code point.  Can optimize
15889                  * into an EXACTish node */
15890
15891                 value = start;
15892
15893                 if (! FOLD) {
15894                     op = (LOC)
15895                          ? EXACTL
15896                          : EXACT;
15897                 }
15898                 else if (LOC) {
15899
15900                     /* A locale node under folding with one code point can be
15901                      * an EXACTFL, as its fold won't be calculated until
15902                      * runtime */
15903                     op = EXACTFL;
15904                 }
15905                 else {
15906
15907                     /* Here, we are generally folding, but there is only one
15908                      * code point to match.  If we have to, we use an EXACT
15909                      * node, but it would be better for joining with adjacent
15910                      * nodes in the optimization pass if we used the same
15911                      * EXACTFish node that any such are likely to be.  We can
15912                      * do this iff the code point doesn't participate in any
15913                      * folds.  For example, an EXACTF of a colon is the same as
15914                      * an EXACT one, since nothing folds to or from a colon. */
15915                     if (value < 256) {
15916                         if (IS_IN_SOME_FOLD_L1(value)) {
15917                             op = EXACT;
15918                         }
15919                     }
15920                     else {
15921                         if (_invlist_contains_cp(PL_utf8_foldable, value)) {
15922                             op = EXACT;
15923                         }
15924                     }
15925
15926                     /* If we haven't found the node type, above, it means we
15927                      * can use the prevailing one */
15928                     if (op == END) {
15929                         op = compute_EXACTish(pRExC_state);
15930                     }
15931                 }
15932             }
15933         }
15934         else if (start == 0) {
15935             if (end == UV_MAX) {
15936                 op = SANY;
15937                 *flagp |= HASWIDTH|SIMPLE;
15938                 MARK_NAUGHTY(1);
15939             }
15940             else if (end == '\n' - 1
15941                     && invlist_iternext(cp_list, &start, &end)
15942                     && start == '\n' + 1 && end == UV_MAX)
15943             {
15944                 op = REG_ANY;
15945                 *flagp |= HASWIDTH|SIMPLE;
15946                 MARK_NAUGHTY(1);
15947             }
15948         }
15949         invlist_iterfinish(cp_list);
15950
15951         if (op != END) {
15952             RExC_parse = (char *)orig_parse;
15953             RExC_emit = (regnode *)orig_emit;
15954
15955             ret = reg_node(pRExC_state, op);
15956
15957             RExC_parse = (char *)cur_parse;
15958
15959             if (PL_regkind[op] == EXACT) {
15960                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, 0, value,
15961                                            TRUE /* downgradable to EXACT */
15962                                           );
15963             }
15964
15965             SvREFCNT_dec_NN(cp_list);
15966             return ret;
15967         }
15968     }
15969
15970     /* Here, <cp_list> contains all the code points we can determine at
15971      * compile time that match under all conditions.  Go through it, and
15972      * for things that belong in the bitmap, put them there, and delete from
15973      * <cp_list>.  While we are at it, see if everything above 255 is in the
15974      * list, and if so, set a flag to speed up execution */
15975
15976     populate_ANYOF_from_invlist(ret, &cp_list);
15977
15978     if (invert) {
15979         ANYOF_FLAGS(ret) |= ANYOF_INVERT;
15980     }
15981
15982     /* Here, the bitmap has been populated with all the Latin1 code points that
15983      * always match.  Can now add to the overall list those that match only
15984      * when the target string is UTF-8 (<depends_list>). */
15985     if (depends_list) {
15986         if (cp_list) {
15987             _invlist_union(cp_list, depends_list, &cp_list);
15988             SvREFCNT_dec_NN(depends_list);
15989         }
15990         else {
15991             cp_list = depends_list;
15992         }
15993         ANYOF_FLAGS(ret) |= ANYOF_HAS_UTF8_NONBITMAP_MATCHES;
15994     }
15995
15996     /* If there is a swash and more than one element, we can't use the swash in
15997      * the optimization below. */
15998     if (swash && element_count > 1) {
15999         SvREFCNT_dec_NN(swash);
16000         swash = NULL;
16001     }
16002
16003     /* Note that the optimization of using 'swash' if it is the only thing in
16004      * the class doesn't have us change swash at all, so it can include things
16005      * that are also in the bitmap; otherwise we have purposely deleted that
16006      * duplicate information */
16007     set_ANYOF_arg(pRExC_state, ret, cp_list,
16008                   (HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
16009                    ? listsv : NULL,
16010                   only_utf8_locale_list,
16011                   swash, has_user_defined_property);
16012
16013     *flagp |= HASWIDTH|SIMPLE;
16014
16015     if (ANYOF_FLAGS(ret) & ANYOF_LOCALE_FLAGS) {
16016         RExC_contains_locale = 1;
16017     }
16018
16019     return ret;
16020 }
16021
16022 #undef HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION
16023
16024 STATIC void
16025 S_set_ANYOF_arg(pTHX_ RExC_state_t* const pRExC_state,
16026                 regnode* const node,
16027                 SV* const cp_list,
16028                 SV* const runtime_defns,
16029                 SV* const only_utf8_locale_list,
16030                 SV* const swash,
16031                 const bool has_user_defined_property)
16032 {
16033     /* Sets the arg field of an ANYOF-type node 'node', using information about
16034      * the node passed-in.  If there is nothing outside the node's bitmap, the
16035      * arg is set to ANYOF_ONLY_HAS_BITMAP.  Otherwise, it sets the argument to
16036      * the count returned by add_data(), having allocated and stored an array,
16037      * av, that that count references, as follows:
16038      *  av[0] stores the character class description in its textual form.
16039      *        This is used later (regexec.c:Perl_regclass_swash()) to
16040      *        initialize the appropriate swash, and is also useful for dumping
16041      *        the regnode.  This is set to &PL_sv_undef if the textual
16042      *        description is not needed at run-time (as happens if the other
16043      *        elements completely define the class)
16044      *  av[1] if &PL_sv_undef, is a placeholder to later contain the swash
16045      *        computed from av[0].  But if no further computation need be done,
16046      *        the swash is stored here now (and av[0] is &PL_sv_undef).
16047      *  av[2] stores the inversion list of code points that match only if the
16048      *        current locale is UTF-8
16049      *  av[3] stores the cp_list inversion list for use in addition or instead
16050      *        of av[0]; used only if cp_list exists and av[1] is &PL_sv_undef.
16051      *        (Otherwise everything needed is already in av[0] and av[1])
16052      *  av[4] is set if any component of the class is from a user-defined
16053      *        property; used only if av[3] exists */
16054
16055     UV n;
16056
16057     PERL_ARGS_ASSERT_SET_ANYOF_ARG;
16058
16059     if (! cp_list && ! runtime_defns && ! only_utf8_locale_list) {
16060         assert(! (ANYOF_FLAGS(node)
16061                   & (ANYOF_HAS_UTF8_NONBITMAP_MATCHES
16062                      |ANYOF_HAS_NONBITMAP_NON_UTF8_MATCHES)));
16063         ARG_SET(node, ANYOF_ONLY_HAS_BITMAP);
16064     }
16065     else {
16066         AV * const av = newAV();
16067         SV *rv;
16068
16069         assert(ANYOF_FLAGS(node)
16070                & (ANYOF_HAS_UTF8_NONBITMAP_MATCHES
16071                   |ANYOF_HAS_NONBITMAP_NON_UTF8_MATCHES|ANYOF_LOC_FOLD));
16072
16073         av_store(av, 0, (runtime_defns)
16074                         ? SvREFCNT_inc(runtime_defns) : &PL_sv_undef);
16075         if (swash) {
16076             assert(cp_list);
16077             av_store(av, 1, swash);
16078             SvREFCNT_dec_NN(cp_list);
16079         }
16080         else {
16081             av_store(av, 1, &PL_sv_undef);
16082             if (cp_list) {
16083                 av_store(av, 3, cp_list);
16084                 av_store(av, 4, newSVuv(has_user_defined_property));
16085             }
16086         }
16087
16088         if (only_utf8_locale_list) {
16089             av_store(av, 2, only_utf8_locale_list);
16090         }
16091         else {
16092             av_store(av, 2, &PL_sv_undef);
16093         }
16094
16095         rv = newRV_noinc(MUTABLE_SV(av));
16096         n = add_data(pRExC_state, STR_WITH_LEN("s"));
16097         RExC_rxi->data->data[n] = (void*)rv;
16098         ARG_SET(node, n);
16099     }
16100 }
16101
16102 #if !defined(PERL_IN_XSUB_RE) || defined(PLUGGABLE_RE_EXTENSION)
16103 SV *
16104 Perl__get_regclass_nonbitmap_data(pTHX_ const regexp *prog,
16105                                         const regnode* node,
16106                                         bool doinit,
16107                                         SV** listsvp,
16108                                         SV** only_utf8_locale_ptr,
16109                                         SV*  exclude_list)
16110
16111 {
16112     /* For internal core use only.
16113      * Returns the swash for the input 'node' in the regex 'prog'.
16114      * If <doinit> is 'true', will attempt to create the swash if not already
16115      *    done.
16116      * If <listsvp> is non-null, will return the printable contents of the
16117      *    swash.  This can be used to get debugging information even before the
16118      *    swash exists, by calling this function with 'doinit' set to false, in
16119      *    which case the components that will be used to eventually create the
16120      *    swash are returned  (in a printable form).
16121      * If <exclude_list> is not NULL, it is an inversion list of things to
16122      *    exclude from what's returned in <listsvp>.
16123      * Tied intimately to how S_set_ANYOF_arg sets up the data structure.  Note
16124      * that, in spite of this function's name, the swash it returns may include
16125      * the bitmap data as well */
16126
16127     SV *sw  = NULL;
16128     SV *si  = NULL;         /* Input swash initialization string */
16129     SV*  invlist = NULL;
16130
16131     RXi_GET_DECL(prog,progi);
16132     const struct reg_data * const data = prog ? progi->data : NULL;
16133
16134     PERL_ARGS_ASSERT__GET_REGCLASS_NONBITMAP_DATA;
16135
16136     assert(ANYOF_FLAGS(node)
16137         & (ANYOF_HAS_UTF8_NONBITMAP_MATCHES
16138            |ANYOF_HAS_NONBITMAP_NON_UTF8_MATCHES|ANYOF_LOC_FOLD));
16139
16140     if (data && data->count) {
16141         const U32 n = ARG(node);
16142
16143         if (data->what[n] == 's') {
16144             SV * const rv = MUTABLE_SV(data->data[n]);
16145             AV * const av = MUTABLE_AV(SvRV(rv));
16146             SV **const ary = AvARRAY(av);
16147             U8 swash_init_flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;
16148
16149             si = *ary;  /* ary[0] = the string to initialize the swash with */
16150
16151             /* Elements 3 and 4 are either both present or both absent. [3] is
16152              * any inversion list generated at compile time; [4] indicates if
16153              * that inversion list has any user-defined properties in it. */
16154             if (av_tindex(av) >= 2) {
16155                 if (only_utf8_locale_ptr
16156                     && ary[2]
16157                     && ary[2] != &PL_sv_undef)
16158                 {
16159                     *only_utf8_locale_ptr = ary[2];
16160                 }
16161                 else {
16162                     assert(only_utf8_locale_ptr);
16163                     *only_utf8_locale_ptr = NULL;
16164                 }
16165
16166                 if (av_tindex(av) >= 3) {
16167                     invlist = ary[3];
16168                     if (SvUV(ary[4])) {
16169                         swash_init_flags |= _CORE_SWASH_INIT_USER_DEFINED_PROPERTY;
16170                     }
16171                 }
16172                 else {
16173                     invlist = NULL;
16174                 }
16175             }
16176
16177             /* Element [1] is reserved for the set-up swash.  If already there,
16178              * return it; if not, create it and store it there */
16179             if (ary[1] && SvROK(ary[1])) {
16180                 sw = ary[1];
16181             }
16182             else if (doinit && ((si && si != &PL_sv_undef)
16183                                  || (invlist && invlist != &PL_sv_undef))) {
16184                 assert(si);
16185                 sw = _core_swash_init("utf8", /* the utf8 package */
16186                                       "", /* nameless */
16187                                       si,
16188                                       1, /* binary */
16189                                       0, /* not from tr/// */
16190                                       invlist,
16191                                       &swash_init_flags);
16192                 (void)av_store(av, 1, sw);
16193             }
16194         }
16195     }
16196
16197     /* If requested, return a printable version of what this swash matches */
16198     if (listsvp) {
16199         SV* matches_string = newSVpvs("");
16200
16201         /* The swash should be used, if possible, to get the data, as it
16202          * contains the resolved data.  But this function can be called at
16203          * compile-time, before everything gets resolved, in which case we
16204          * return the currently best available information, which is the string
16205          * that will eventually be used to do that resolving, 'si' */
16206         if ((! sw || (invlist = _get_swash_invlist(sw)) == NULL)
16207             && (si && si != &PL_sv_undef))
16208         {
16209             sv_catsv(matches_string, si);
16210         }
16211
16212         /* Add the inversion list to whatever we have.  This may have come from
16213          * the swash, or from an input parameter */
16214         if (invlist) {
16215             if (exclude_list) {
16216                 SV* clone = invlist_clone(invlist);
16217                 _invlist_subtract(clone, exclude_list, &clone);
16218                 sv_catsv(matches_string, _invlist_contents(clone));
16219                 SvREFCNT_dec_NN(clone);
16220             }
16221             else {
16222                 sv_catsv(matches_string, _invlist_contents(invlist));
16223             }
16224         }
16225         *listsvp = matches_string;
16226     }
16227
16228     return sw;
16229 }
16230 #endif /* !defined(PERL_IN_XSUB_RE) || defined(PLUGGABLE_RE_EXTENSION) */
16231
16232 /* reg_skipcomment()
16233
16234    Absorbs an /x style # comment from the input stream,
16235    returning a pointer to the first character beyond the comment, or if the
16236    comment terminates the pattern without anything following it, this returns
16237    one past the final character of the pattern (in other words, RExC_end) and
16238    sets the REG_RUN_ON_COMMENT_SEEN flag.
16239
16240    Note it's the callers responsibility to ensure that we are
16241    actually in /x mode
16242
16243 */
16244
16245 PERL_STATIC_INLINE char*
16246 S_reg_skipcomment(RExC_state_t *pRExC_state, char* p)
16247 {
16248     PERL_ARGS_ASSERT_REG_SKIPCOMMENT;
16249
16250     assert(*p == '#');
16251
16252     while (p < RExC_end) {
16253         if (*(++p) == '\n') {
16254             return p+1;
16255         }
16256     }
16257
16258     /* we ran off the end of the pattern without ending the comment, so we have
16259      * to add an \n when wrapping */
16260     RExC_seen |= REG_RUN_ON_COMMENT_SEEN;
16261     return p;
16262 }
16263
16264 /* nextchar()
16265
16266    Advances the parse position, and optionally absorbs
16267    "whitespace" from the inputstream.
16268
16269    Without /x "whitespace" means (?#...) style comments only,
16270    with /x this means (?#...) and # comments and whitespace proper.
16271
16272    Returns the RExC_parse point from BEFORE the scan occurs.
16273
16274    This is the /x friendly way of saying RExC_parse++.
16275 */
16276
16277 STATIC char*
16278 S_nextchar(pTHX_ RExC_state_t *pRExC_state)
16279 {
16280     char* const retval = RExC_parse++;
16281
16282     PERL_ARGS_ASSERT_NEXTCHAR;
16283
16284     for (;;) {
16285         if (RExC_end - RExC_parse >= 3
16286             && *RExC_parse == '('
16287             && RExC_parse[1] == '?'
16288             && RExC_parse[2] == '#')
16289         {
16290             while (*RExC_parse != ')') {
16291                 if (RExC_parse == RExC_end)
16292                     FAIL("Sequence (?#... not terminated");
16293                 RExC_parse++;
16294             }
16295             RExC_parse++;
16296             continue;
16297         }
16298         if (RExC_flags & RXf_PMf_EXTENDED) {
16299             char * p = regpatws(pRExC_state, RExC_parse,
16300                                           TRUE); /* means recognize comments */
16301             if (p != RExC_parse) {
16302                 RExC_parse = p;
16303                 continue;
16304             }
16305         }
16306         return retval;
16307     }
16308 }
16309
16310 STATIC regnode *
16311 S_regnode_guts(pTHX_ RExC_state_t *pRExC_state, const U8 op, const STRLEN extra_size, const char* const name)
16312 {
16313     /* Allocate a regnode for 'op' and returns it, with 'extra_size' extra
16314      * space.  In pass1, it aligns and increments RExC_size; in pass2,
16315      * RExC_emit */
16316
16317     regnode * const ret = RExC_emit;
16318     GET_RE_DEBUG_FLAGS_DECL;
16319
16320     PERL_ARGS_ASSERT_REGNODE_GUTS;
16321
16322     assert(extra_size >= regarglen[op]);
16323
16324     if (SIZE_ONLY) {
16325         SIZE_ALIGN(RExC_size);
16326         RExC_size += 1 + extra_size;
16327         return(ret);
16328     }
16329     if (RExC_emit >= RExC_emit_bound)
16330         Perl_croak(aTHX_ "panic: reg_node overrun trying to emit %d, %p>=%p",
16331                    op, (void*)RExC_emit, (void*)RExC_emit_bound);
16332
16333     NODE_ALIGN_FILL(ret);
16334 #ifndef RE_TRACK_PATTERN_OFFSETS
16335     PERL_UNUSED_ARG(name);
16336 #else
16337     if (RExC_offsets) {         /* MJD */
16338         MJD_OFFSET_DEBUG(
16339               ("%s:%d: (op %s) %s %"UVuf" (len %"UVuf") (max %"UVuf").\n",
16340               name, __LINE__,
16341               PL_reg_name[op],
16342               (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0]
16343                 ? "Overwriting end of array!\n" : "OK",
16344               (UV)(RExC_emit - RExC_emit_start),
16345               (UV)(RExC_parse - RExC_start),
16346               (UV)RExC_offsets[0]));
16347         Set_Node_Offset(RExC_emit, RExC_parse + (op == END));
16348     }
16349 #endif
16350     return(ret);
16351 }
16352
16353 /*
16354 - reg_node - emit a node
16355 */
16356 STATIC regnode *                        /* Location. */
16357 S_reg_node(pTHX_ RExC_state_t *pRExC_state, U8 op)
16358 {
16359     regnode * const ret = regnode_guts(pRExC_state, op, regarglen[op], "reg_node");
16360
16361     PERL_ARGS_ASSERT_REG_NODE;
16362
16363     assert(regarglen[op] == 0);
16364
16365     if (PASS2) {
16366         regnode *ptr = ret;
16367         FILL_ADVANCE_NODE(ptr, op);
16368         RExC_emit = ptr;
16369     }
16370     return(ret);
16371 }
16372
16373 /*
16374 - reganode - emit a node with an argument
16375 */
16376 STATIC regnode *                        /* Location. */
16377 S_reganode(pTHX_ RExC_state_t *pRExC_state, U8 op, U32 arg)
16378 {
16379     regnode * const ret = regnode_guts(pRExC_state, op, regarglen[op], "reganode");
16380
16381     PERL_ARGS_ASSERT_REGANODE;
16382
16383     assert(regarglen[op] == 1);
16384
16385     if (PASS2) {
16386         regnode *ptr = ret;
16387         FILL_ADVANCE_NODE_ARG(ptr, op, arg);
16388         RExC_emit = ptr;
16389     }
16390     return(ret);
16391 }
16392
16393 STATIC regnode *
16394 S_reg2Lanode(pTHX_ RExC_state_t *pRExC_state, const U8 op, const U32 arg1, const I32 arg2)
16395 {
16396     /* emit a node with U32 and I32 arguments */
16397
16398     regnode * const ret = regnode_guts(pRExC_state, op, regarglen[op], "reg2Lanode");
16399
16400     PERL_ARGS_ASSERT_REG2LANODE;
16401
16402     assert(regarglen[op] == 2);
16403
16404     if (PASS2) {
16405         regnode *ptr = ret;
16406         FILL_ADVANCE_NODE_2L_ARG(ptr, op, arg1, arg2);
16407         RExC_emit = ptr;
16408     }
16409     return(ret);
16410 }
16411
16412 /*
16413 - reginsert - insert an operator in front of already-emitted operand
16414 *
16415 * Means relocating the operand.
16416 */
16417 STATIC void
16418 S_reginsert(pTHX_ RExC_state_t *pRExC_state, U8 op, regnode *opnd, U32 depth)
16419 {
16420     regnode *src;
16421     regnode *dst;
16422     regnode *place;
16423     const int offset = regarglen[(U8)op];
16424     const int size = NODE_STEP_REGNODE + offset;
16425     GET_RE_DEBUG_FLAGS_DECL;
16426
16427     PERL_ARGS_ASSERT_REGINSERT;
16428     PERL_UNUSED_CONTEXT;
16429     PERL_UNUSED_ARG(depth);
16430 /* (PL_regkind[(U8)op] == CURLY ? EXTRA_STEP_2ARGS : 0); */
16431     DEBUG_PARSE_FMT("inst"," - %s",PL_reg_name[op]);
16432     if (SIZE_ONLY) {
16433         RExC_size += size;
16434         return;
16435     }
16436
16437     src = RExC_emit;
16438     RExC_emit += size;
16439     dst = RExC_emit;
16440     if (RExC_open_parens) {
16441         int paren;
16442         /*DEBUG_PARSE_FMT("inst"," - %"IVdf, (IV)RExC_npar);*/
16443         for ( paren=0 ; paren < RExC_npar ; paren++ ) {
16444             if ( RExC_open_parens[paren] >= opnd ) {
16445                 /*DEBUG_PARSE_FMT("open"," - %d",size);*/
16446                 RExC_open_parens[paren] += size;
16447             } else {
16448                 /*DEBUG_PARSE_FMT("open"," - %s","ok");*/
16449             }
16450             if ( RExC_close_parens[paren] >= opnd ) {
16451                 /*DEBUG_PARSE_FMT("close"," - %d",size);*/
16452                 RExC_close_parens[paren] += size;
16453             } else {
16454                 /*DEBUG_PARSE_FMT("close"," - %s","ok");*/
16455             }
16456         }
16457     }
16458
16459     while (src > opnd) {
16460         StructCopy(--src, --dst, regnode);
16461 #ifdef RE_TRACK_PATTERN_OFFSETS
16462         if (RExC_offsets) {     /* MJD 20010112 */
16463             MJD_OFFSET_DEBUG(
16464                  ("%s(%d): (op %s) %s copy %"UVuf" -> %"UVuf" (max %"UVuf").\n",
16465                   "reg_insert",
16466                   __LINE__,
16467                   PL_reg_name[op],
16468                   (UV)(dst - RExC_emit_start) > RExC_offsets[0]
16469                     ? "Overwriting end of array!\n" : "OK",
16470                   (UV)(src - RExC_emit_start),
16471                   (UV)(dst - RExC_emit_start),
16472                   (UV)RExC_offsets[0]));
16473             Set_Node_Offset_To_R(dst-RExC_emit_start, Node_Offset(src));
16474             Set_Node_Length_To_R(dst-RExC_emit_start, Node_Length(src));
16475         }
16476 #endif
16477     }
16478
16479
16480     place = opnd;               /* Op node, where operand used to be. */
16481 #ifdef RE_TRACK_PATTERN_OFFSETS
16482     if (RExC_offsets) {         /* MJD */
16483         MJD_OFFSET_DEBUG(
16484               ("%s(%d): (op %s) %s %"UVuf" <- %"UVuf" (max %"UVuf").\n",
16485               "reginsert",
16486               __LINE__,
16487               PL_reg_name[op],
16488               (UV)(place - RExC_emit_start) > RExC_offsets[0]
16489               ? "Overwriting end of array!\n" : "OK",
16490               (UV)(place - RExC_emit_start),
16491               (UV)(RExC_parse - RExC_start),
16492               (UV)RExC_offsets[0]));
16493         Set_Node_Offset(place, RExC_parse);
16494         Set_Node_Length(place, 1);
16495     }
16496 #endif
16497     src = NEXTOPER(place);
16498     FILL_ADVANCE_NODE(place, op);
16499     Zero(src, offset, regnode);
16500 }
16501
16502 /*
16503 - regtail - set the next-pointer at the end of a node chain of p to val.
16504 - SEE ALSO: regtail_study
16505 */
16506 /* TODO: All three parms should be const */
16507 STATIC void
16508 S_regtail(pTHX_ RExC_state_t *pRExC_state, regnode *p,
16509                 const regnode *val,U32 depth)
16510 {
16511     regnode *scan;
16512     GET_RE_DEBUG_FLAGS_DECL;
16513
16514     PERL_ARGS_ASSERT_REGTAIL;
16515 #ifndef DEBUGGING
16516     PERL_UNUSED_ARG(depth);
16517 #endif
16518
16519     if (SIZE_ONLY)
16520         return;
16521
16522     /* Find last node. */
16523     scan = p;
16524     for (;;) {
16525         regnode * const temp = regnext(scan);
16526         DEBUG_PARSE_r({
16527             DEBUG_PARSE_MSG((scan==p ? "tail" : ""));
16528             regprop(RExC_rx, RExC_mysv, scan, NULL, pRExC_state);
16529             PerlIO_printf(Perl_debug_log, "~ %s (%d) %s %s\n",
16530                 SvPV_nolen_const(RExC_mysv), REG_NODE_NUM(scan),
16531                     (temp == NULL ? "->" : ""),
16532                     (temp == NULL ? PL_reg_name[OP(val)] : "")
16533             );
16534         });
16535         if (temp == NULL)
16536             break;
16537         scan = temp;
16538     }
16539
16540     if (reg_off_by_arg[OP(scan)]) {
16541         ARG_SET(scan, val - scan);
16542     }
16543     else {
16544         NEXT_OFF(scan) = val - scan;
16545     }
16546 }
16547
16548 #ifdef DEBUGGING
16549 /*
16550 - regtail_study - set the next-pointer at the end of a node chain of p to val.
16551 - Look for optimizable sequences at the same time.
16552 - currently only looks for EXACT chains.
16553
16554 This is experimental code. The idea is to use this routine to perform
16555 in place optimizations on branches and groups as they are constructed,
16556 with the long term intention of removing optimization from study_chunk so
16557 that it is purely analytical.
16558
16559 Currently only used when in DEBUG mode. The macro REGTAIL_STUDY() is used
16560 to control which is which.
16561
16562 */
16563 /* TODO: All four parms should be const */
16564
16565 STATIC U8
16566 S_regtail_study(pTHX_ RExC_state_t *pRExC_state, regnode *p,
16567                       const regnode *val,U32 depth)
16568 {
16569     regnode *scan;
16570     U8 exact = PSEUDO;
16571 #ifdef EXPERIMENTAL_INPLACESCAN
16572     I32 min = 0;
16573 #endif
16574     GET_RE_DEBUG_FLAGS_DECL;
16575
16576     PERL_ARGS_ASSERT_REGTAIL_STUDY;
16577
16578
16579     if (SIZE_ONLY)
16580         return exact;
16581
16582     /* Find last node. */
16583
16584     scan = p;
16585     for (;;) {
16586         regnode * const temp = regnext(scan);
16587 #ifdef EXPERIMENTAL_INPLACESCAN
16588         if (PL_regkind[OP(scan)] == EXACT) {
16589             bool unfolded_multi_char;   /* Unexamined in this routine */
16590             if (join_exact(pRExC_state, scan, &min,
16591                            &unfolded_multi_char, 1, val, depth+1))
16592                 return EXACT;
16593         }
16594 #endif
16595         if ( exact ) {
16596             switch (OP(scan)) {
16597                 case EXACT:
16598                 case EXACTL:
16599                 case EXACTF:
16600                 case EXACTFA_NO_TRIE:
16601                 case EXACTFA:
16602                 case EXACTFU:
16603                 case EXACTFLU8:
16604                 case EXACTFU_SS:
16605                 case EXACTFL:
16606                         if( exact == PSEUDO )
16607                             exact= OP(scan);
16608                         else if ( exact != OP(scan) )
16609                             exact= 0;
16610                 case NOTHING:
16611                     break;
16612                 default:
16613                     exact= 0;
16614             }
16615         }
16616         DEBUG_PARSE_r({
16617             DEBUG_PARSE_MSG((scan==p ? "tsdy" : ""));
16618             regprop(RExC_rx, RExC_mysv, scan, NULL, pRExC_state);
16619             PerlIO_printf(Perl_debug_log, "~ %s (%d) -> %s\n",
16620                 SvPV_nolen_const(RExC_mysv),
16621                 REG_NODE_NUM(scan),
16622                 PL_reg_name[exact]);
16623         });
16624         if (temp == NULL)
16625             break;
16626         scan = temp;
16627     }
16628     DEBUG_PARSE_r({
16629         DEBUG_PARSE_MSG("");
16630         regprop(RExC_rx, RExC_mysv, val, NULL, pRExC_state);
16631         PerlIO_printf(Perl_debug_log,
16632                       "~ attach to %s (%"IVdf") offset to %"IVdf"\n",
16633                       SvPV_nolen_const(RExC_mysv),
16634                       (IV)REG_NODE_NUM(val),
16635                       (IV)(val - scan)
16636         );
16637     });
16638     if (reg_off_by_arg[OP(scan)]) {
16639         ARG_SET(scan, val - scan);
16640     }
16641     else {
16642         NEXT_OFF(scan) = val - scan;
16643     }
16644
16645     return exact;
16646 }
16647 #endif
16648
16649 /*
16650  - regdump - dump a regexp onto Perl_debug_log in vaguely comprehensible form
16651  */
16652 #ifdef DEBUGGING
16653
16654 static void
16655 S_regdump_intflags(pTHX_ const char *lead, const U32 flags)
16656 {
16657     int bit;
16658     int set=0;
16659
16660     ASSUME(REG_INTFLAGS_NAME_SIZE <= sizeof(flags)*8);
16661
16662     for (bit=0; bit<REG_INTFLAGS_NAME_SIZE; bit++) {
16663         if (flags & (1<<bit)) {
16664             if (!set++ && lead)
16665                 PerlIO_printf(Perl_debug_log, "%s",lead);
16666             PerlIO_printf(Perl_debug_log, "%s ",PL_reg_intflags_name[bit]);
16667         }
16668     }
16669     if (lead)  {
16670         if (set)
16671             PerlIO_printf(Perl_debug_log, "\n");
16672         else
16673             PerlIO_printf(Perl_debug_log, "%s[none-set]\n",lead);
16674     }
16675 }
16676
16677 static void
16678 S_regdump_extflags(pTHX_ const char *lead, const U32 flags)
16679 {
16680     int bit;
16681     int set=0;
16682     regex_charset cs;
16683
16684     ASSUME(REG_EXTFLAGS_NAME_SIZE <= sizeof(flags)*8);
16685
16686     for (bit=0; bit<REG_EXTFLAGS_NAME_SIZE; bit++) {
16687         if (flags & (1<<bit)) {
16688             if ((1<<bit) & RXf_PMf_CHARSET) {   /* Output separately, below */
16689                 continue;
16690             }
16691             if (!set++ && lead)
16692                 PerlIO_printf(Perl_debug_log, "%s",lead);
16693             PerlIO_printf(Perl_debug_log, "%s ",PL_reg_extflags_name[bit]);
16694         }
16695     }
16696     if ((cs = get_regex_charset(flags)) != REGEX_DEPENDS_CHARSET) {
16697             if (!set++ && lead) {
16698                 PerlIO_printf(Perl_debug_log, "%s",lead);
16699             }
16700             switch (cs) {
16701                 case REGEX_UNICODE_CHARSET:
16702                     PerlIO_printf(Perl_debug_log, "UNICODE");
16703                     break;
16704                 case REGEX_LOCALE_CHARSET:
16705                     PerlIO_printf(Perl_debug_log, "LOCALE");
16706                     break;
16707                 case REGEX_ASCII_RESTRICTED_CHARSET:
16708                     PerlIO_printf(Perl_debug_log, "ASCII-RESTRICTED");
16709                     break;
16710                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
16711                     PerlIO_printf(Perl_debug_log, "ASCII-MORE_RESTRICTED");
16712                     break;
16713                 default:
16714                     PerlIO_printf(Perl_debug_log, "UNKNOWN CHARACTER SET");
16715                     break;
16716             }
16717     }
16718     if (lead)  {
16719         if (set)
16720             PerlIO_printf(Perl_debug_log, "\n");
16721         else
16722             PerlIO_printf(Perl_debug_log, "%s[none-set]\n",lead);
16723     }
16724 }
16725 #endif
16726
16727 void
16728 Perl_regdump(pTHX_ const regexp *r)
16729 {
16730 #ifdef DEBUGGING
16731     SV * const sv = sv_newmortal();
16732     SV *dsv= sv_newmortal();
16733     RXi_GET_DECL(r,ri);
16734     GET_RE_DEBUG_FLAGS_DECL;
16735
16736     PERL_ARGS_ASSERT_REGDUMP;
16737
16738     (void)dumpuntil(r, ri->program, ri->program + 1, NULL, NULL, sv, 0, 0);
16739
16740     /* Header fields of interest. */
16741     if (r->anchored_substr) {
16742         RE_PV_QUOTED_DECL(s, 0, dsv, SvPVX_const(r->anchored_substr),
16743             RE_SV_DUMPLEN(r->anchored_substr), 30);
16744         PerlIO_printf(Perl_debug_log,
16745                       "anchored %s%s at %"IVdf" ",
16746                       s, RE_SV_TAIL(r->anchored_substr),
16747                       (IV)r->anchored_offset);
16748     } else if (r->anchored_utf8) {
16749         RE_PV_QUOTED_DECL(s, 1, dsv, SvPVX_const(r->anchored_utf8),
16750             RE_SV_DUMPLEN(r->anchored_utf8), 30);
16751         PerlIO_printf(Perl_debug_log,
16752                       "anchored utf8 %s%s at %"IVdf" ",
16753                       s, RE_SV_TAIL(r->anchored_utf8),
16754                       (IV)r->anchored_offset);
16755     }
16756     if (r->float_substr) {
16757         RE_PV_QUOTED_DECL(s, 0, dsv, SvPVX_const(r->float_substr),
16758             RE_SV_DUMPLEN(r->float_substr), 30);
16759         PerlIO_printf(Perl_debug_log,
16760                       "floating %s%s at %"IVdf"..%"UVuf" ",
16761                       s, RE_SV_TAIL(r->float_substr),
16762                       (IV)r->float_min_offset, (UV)r->float_max_offset);
16763     } else if (r->float_utf8) {
16764         RE_PV_QUOTED_DECL(s, 1, dsv, SvPVX_const(r->float_utf8),
16765             RE_SV_DUMPLEN(r->float_utf8), 30);
16766         PerlIO_printf(Perl_debug_log,
16767                       "floating utf8 %s%s at %"IVdf"..%"UVuf" ",
16768                       s, RE_SV_TAIL(r->float_utf8),
16769                       (IV)r->float_min_offset, (UV)r->float_max_offset);
16770     }
16771     if (r->check_substr || r->check_utf8)
16772         PerlIO_printf(Perl_debug_log,
16773                       (const char *)
16774                       (r->check_substr == r->float_substr
16775                        && r->check_utf8 == r->float_utf8
16776                        ? "(checking floating" : "(checking anchored"));
16777     if (r->intflags & PREGf_NOSCAN)
16778         PerlIO_printf(Perl_debug_log, " noscan");
16779     if (r->extflags & RXf_CHECK_ALL)
16780         PerlIO_printf(Perl_debug_log, " isall");
16781     if (r->check_substr || r->check_utf8)
16782         PerlIO_printf(Perl_debug_log, ") ");
16783
16784     if (ri->regstclass) {
16785         regprop(r, sv, ri->regstclass, NULL, NULL);
16786         PerlIO_printf(Perl_debug_log, "stclass %s ", SvPVX_const(sv));
16787     }
16788     if (r->intflags & PREGf_ANCH) {
16789         PerlIO_printf(Perl_debug_log, "anchored");
16790         if (r->intflags & PREGf_ANCH_MBOL)
16791             PerlIO_printf(Perl_debug_log, "(MBOL)");
16792         if (r->intflags & PREGf_ANCH_SBOL)
16793             PerlIO_printf(Perl_debug_log, "(SBOL)");
16794         if (r->intflags & PREGf_ANCH_GPOS)
16795             PerlIO_printf(Perl_debug_log, "(GPOS)");
16796         (void)PerlIO_putc(Perl_debug_log, ' ');
16797     }
16798     if (r->intflags & PREGf_GPOS_SEEN)
16799         PerlIO_printf(Perl_debug_log, "GPOS:%"UVuf" ", (UV)r->gofs);
16800     if (r->intflags & PREGf_SKIP)
16801         PerlIO_printf(Perl_debug_log, "plus ");
16802     if (r->intflags & PREGf_IMPLICIT)
16803         PerlIO_printf(Perl_debug_log, "implicit ");
16804     PerlIO_printf(Perl_debug_log, "minlen %"IVdf" ", (IV)r->minlen);
16805     if (r->extflags & RXf_EVAL_SEEN)
16806         PerlIO_printf(Perl_debug_log, "with eval ");
16807     PerlIO_printf(Perl_debug_log, "\n");
16808     DEBUG_FLAGS_r({
16809         regdump_extflags("r->extflags: ",r->extflags);
16810         regdump_intflags("r->intflags: ",r->intflags);
16811     });
16812 #else
16813     PERL_ARGS_ASSERT_REGDUMP;
16814     PERL_UNUSED_CONTEXT;
16815     PERL_UNUSED_ARG(r);
16816 #endif  /* DEBUGGING */
16817 }
16818
16819 /*
16820 - regprop - printable representation of opcode, with run time support
16821 */
16822
16823 void
16824 Perl_regprop(pTHX_ const regexp *prog, SV *sv, const regnode *o, const regmatch_info *reginfo, const RExC_state_t *pRExC_state)
16825 {
16826 #ifdef DEBUGGING
16827     int k;
16828
16829     /* Should be synchronized with * ANYOF_ #xdefines in regcomp.h */
16830     static const char * const anyofs[] = {
16831 #if _CC_WORDCHAR != 0 || _CC_DIGIT != 1 || _CC_ALPHA != 2 || _CC_LOWER != 3 \
16832     || _CC_UPPER != 4 || _CC_PUNCT != 5 || _CC_PRINT != 6                   \
16833     || _CC_ALPHANUMERIC != 7 || _CC_GRAPH != 8 || _CC_CASED != 9            \
16834     || _CC_SPACE != 10 || _CC_BLANK != 11 || _CC_XDIGIT != 12               \
16835     || _CC_CNTRL != 13 || _CC_ASCII != 14 || _CC_VERTSPACE != 15
16836   #error Need to adjust order of anyofs[]
16837 #endif
16838         "\\w",
16839         "\\W",
16840         "\\d",
16841         "\\D",
16842         "[:alpha:]",
16843         "[:^alpha:]",
16844         "[:lower:]",
16845         "[:^lower:]",
16846         "[:upper:]",
16847         "[:^upper:]",
16848         "[:punct:]",
16849         "[:^punct:]",
16850         "[:print:]",
16851         "[:^print:]",
16852         "[:alnum:]",
16853         "[:^alnum:]",
16854         "[:graph:]",
16855         "[:^graph:]",
16856         "[:cased:]",
16857         "[:^cased:]",
16858         "\\s",
16859         "\\S",
16860         "[:blank:]",
16861         "[:^blank:]",
16862         "[:xdigit:]",
16863         "[:^xdigit:]",
16864         "[:cntrl:]",
16865         "[:^cntrl:]",
16866         "[:ascii:]",
16867         "[:^ascii:]",
16868         "\\v",
16869         "\\V"
16870     };
16871     RXi_GET_DECL(prog,progi);
16872     GET_RE_DEBUG_FLAGS_DECL;
16873
16874     PERL_ARGS_ASSERT_REGPROP;
16875
16876     sv_setpvn(sv, "", 0);
16877
16878     if (OP(o) > REGNODE_MAX)            /* regnode.type is unsigned */
16879         /* It would be nice to FAIL() here, but this may be called from
16880            regexec.c, and it would be hard to supply pRExC_state. */
16881         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d",
16882                                               (int)OP(o), (int)REGNODE_MAX);
16883     sv_catpv(sv, PL_reg_name[OP(o)]); /* Take off const! */
16884
16885     k = PL_regkind[OP(o)];
16886
16887     if (k == EXACT) {
16888         sv_catpvs(sv, " ");
16889         /* Using is_utf8_string() (via PERL_PV_UNI_DETECT)
16890          * is a crude hack but it may be the best for now since
16891          * we have no flag "this EXACTish node was UTF-8"
16892          * --jhi */
16893         pv_pretty(sv, STRING(o), STR_LEN(o), 60, PL_colors[0], PL_colors[1],
16894                   PERL_PV_ESCAPE_UNI_DETECT |
16895                   PERL_PV_ESCAPE_NONASCII   |
16896                   PERL_PV_PRETTY_ELLIPSES   |
16897                   PERL_PV_PRETTY_LTGT       |
16898                   PERL_PV_PRETTY_NOCLEAR
16899                   );
16900     } else if (k == TRIE) {
16901         /* print the details of the trie in dumpuntil instead, as
16902          * progi->data isn't available here */
16903         const char op = OP(o);
16904         const U32 n = ARG(o);
16905         const reg_ac_data * const ac = IS_TRIE_AC(op) ?
16906                (reg_ac_data *)progi->data->data[n] :
16907                NULL;
16908         const reg_trie_data * const trie
16909             = (reg_trie_data*)progi->data->data[!IS_TRIE_AC(op) ? n : ac->trie];
16910
16911         Perl_sv_catpvf(aTHX_ sv, "-%s",PL_reg_name[o->flags]);
16912         DEBUG_TRIE_COMPILE_r(
16913           Perl_sv_catpvf(aTHX_ sv,
16914             "<S:%"UVuf"/%"IVdf" W:%"UVuf" L:%"UVuf"/%"UVuf" C:%"UVuf"/%"UVuf">",
16915             (UV)trie->startstate,
16916             (IV)trie->statecount-1, /* -1 because of the unused 0 element */
16917             (UV)trie->wordcount,
16918             (UV)trie->minlen,
16919             (UV)trie->maxlen,
16920             (UV)TRIE_CHARCOUNT(trie),
16921             (UV)trie->uniquecharcount
16922           );
16923         );
16924         if ( IS_ANYOF_TRIE(op) || trie->bitmap ) {
16925             sv_catpvs(sv, "[");
16926             (void) put_charclass_bitmap_innards(sv,
16927                                                 (IS_ANYOF_TRIE(op))
16928                                                  ? ANYOF_BITMAP(o)
16929                                                  : TRIE_BITMAP(trie),
16930                                                 NULL);
16931             sv_catpvs(sv, "]");
16932         }
16933
16934     } else if (k == CURLY) {
16935         if (OP(o) == CURLYM || OP(o) == CURLYN || OP(o) == CURLYX)
16936             Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags); /* Parenth number */
16937         Perl_sv_catpvf(aTHX_ sv, " {%d,%d}", ARG1(o), ARG2(o));
16938     }
16939     else if (k == WHILEM && o->flags)                   /* Ordinal/of */
16940         Perl_sv_catpvf(aTHX_ sv, "[%d/%d]", o->flags & 0xf, o->flags>>4);
16941     else if (k == REF || k == OPEN || k == CLOSE
16942              || k == GROUPP || OP(o)==ACCEPT)
16943     {
16944         AV *name_list= NULL;
16945         Perl_sv_catpvf(aTHX_ sv, "%d", (int)ARG(o));    /* Parenth number */
16946         if ( RXp_PAREN_NAMES(prog) ) {
16947             name_list= MUTABLE_AV(progi->data->data[progi->name_list_idx]);
16948         } else if ( pRExC_state ) {
16949             name_list= RExC_paren_name_list;
16950         }
16951         if (name_list) {
16952             if ( k != REF || (OP(o) < NREF)) {
16953                 SV **name= av_fetch(name_list, ARG(o), 0 );
16954                 if (name)
16955                     Perl_sv_catpvf(aTHX_ sv, " '%"SVf"'", SVfARG(*name));
16956             }
16957             else {
16958                 SV *sv_dat= MUTABLE_SV(progi->data->data[ ARG( o ) ]);
16959                 I32 *nums=(I32*)SvPVX(sv_dat);
16960                 SV **name= av_fetch(name_list, nums[0], 0 );
16961                 I32 n;
16962                 if (name) {
16963                     for ( n=0; n<SvIVX(sv_dat); n++ ) {
16964                         Perl_sv_catpvf(aTHX_ sv, "%s%"IVdf,
16965                                     (n ? "," : ""), (IV)nums[n]);
16966                     }
16967                     Perl_sv_catpvf(aTHX_ sv, " '%"SVf"'", SVfARG(*name));
16968                 }
16969             }
16970         }
16971         if ( k == REF && reginfo) {
16972             U32 n = ARG(o);  /* which paren pair */
16973             I32 ln = prog->offs[n].start;
16974             if (prog->lastparen < n || ln == -1)
16975                 Perl_sv_catpvf(aTHX_ sv, ": FAIL");
16976             else if (ln == prog->offs[n].end)
16977                 Perl_sv_catpvf(aTHX_ sv, ": ACCEPT - EMPTY STRING");
16978             else {
16979                 const char *s = reginfo->strbeg + ln;
16980                 Perl_sv_catpvf(aTHX_ sv, ": ");
16981                 Perl_pv_pretty( aTHX_ sv, s, prog->offs[n].end - prog->offs[n].start, 32, 0, 0,
16982                     PERL_PV_ESCAPE_UNI_DETECT|PERL_PV_PRETTY_NOCLEAR|PERL_PV_PRETTY_ELLIPSES|PERL_PV_PRETTY_QUOTE );
16983             }
16984         }
16985     } else if (k == GOSUB) {
16986         AV *name_list= NULL;
16987         if ( RXp_PAREN_NAMES(prog) ) {
16988             name_list= MUTABLE_AV(progi->data->data[progi->name_list_idx]);
16989         } else if ( pRExC_state ) {
16990             name_list= RExC_paren_name_list;
16991         }
16992
16993         /* Paren and offset */
16994         Perl_sv_catpvf(aTHX_ sv, "%d[%+d]", (int)ARG(o),(int)ARG2L(o));
16995         if (name_list) {
16996             SV **name= av_fetch(name_list, ARG(o), 0 );
16997             if (name)
16998                 Perl_sv_catpvf(aTHX_ sv, " '%"SVf"'", SVfARG(*name));
16999         }
17000     }
17001     else if (k == VERB) {
17002         if (!o->flags)
17003             Perl_sv_catpvf(aTHX_ sv, ":%"SVf,
17004                            SVfARG((MUTABLE_SV(progi->data->data[ ARG( o ) ]))));
17005     } else if (k == LOGICAL)
17006         /* 2: embedded, otherwise 1 */
17007         Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags);
17008     else if (k == ANYOF) {
17009         const U8 flags = ANYOF_FLAGS(o);
17010         int do_sep = 0;
17011         SV* bitmap_invlist;  /* Will hold what the bit map contains */
17012
17013
17014         if (OP(o) == ANYOFL)
17015             sv_catpvs(sv, "{loc}");
17016         if (flags & ANYOF_LOC_FOLD)
17017             sv_catpvs(sv, "{i}");
17018         Perl_sv_catpvf(aTHX_ sv, "[%s", PL_colors[0]);
17019         if (flags & ANYOF_INVERT)
17020             sv_catpvs(sv, "^");
17021
17022         /* output what the standard cp 0-NUM_ANYOF_CODE_POINTS-1 bitmap matches
17023          * */
17024         do_sep = put_charclass_bitmap_innards(sv, ANYOF_BITMAP(o),
17025                                                             &bitmap_invlist);
17026
17027         /* output any special charclass tests (used entirely under use
17028          * locale) * */
17029         if (ANYOF_POSIXL_TEST_ANY_SET(o)) {
17030             int i;
17031             for (i = 0; i < ANYOF_POSIXL_MAX; i++) {
17032                 if (ANYOF_POSIXL_TEST(o,i)) {
17033                     sv_catpv(sv, anyofs[i]);
17034                     do_sep = 1;
17035                 }
17036             }
17037         }
17038
17039         if ((flags & (ANYOF_MATCHES_ALL_ABOVE_BITMAP
17040                       |ANYOF_HAS_UTF8_NONBITMAP_MATCHES
17041                       |ANYOF_HAS_NONBITMAP_NON_UTF8_MATCHES
17042                       |ANYOF_LOC_FOLD)))
17043         {
17044             if (do_sep) {
17045                 Perl_sv_catpvf(aTHX_ sv,"%s][%s",PL_colors[1],PL_colors[0]);
17046                 if (flags & ANYOF_INVERT)
17047                     /*make sure the invert info is in each */
17048                     sv_catpvs(sv, "^");
17049             }
17050
17051             if (flags & ANYOF_MATCHES_ALL_NON_UTF8_NON_ASCII) {
17052                 sv_catpvs(sv, "{non-utf8-latin1-all}");
17053             }
17054
17055             if (flags & ANYOF_MATCHES_ALL_ABOVE_BITMAP)
17056                 sv_catpvs(sv, "{above_bitmap_all}");
17057
17058             if (ARG(o) != ANYOF_ONLY_HAS_BITMAP) {
17059                 SV *lv; /* Set if there is something outside the bit map. */
17060                 bool byte_output = FALSE;   /* If something has been output */
17061                 SV *only_utf8_locale;
17062
17063                 /* Get the stuff that wasn't in the bitmap.  'bitmap_invlist'
17064                  * is used to guarantee that nothing in the bitmap gets
17065                  * returned */
17066                 (void) _get_regclass_nonbitmap_data(prog, o, FALSE,
17067                                                     &lv, &only_utf8_locale,
17068                                                     bitmap_invlist);
17069                 if (lv && lv != &PL_sv_undef) {
17070                     char *s = savesvpv(lv);
17071                     char * const origs = s;
17072
17073                     while (*s && *s != '\n')
17074                         s++;
17075
17076                     if (*s == '\n') {
17077                         const char * const t = ++s;
17078
17079                         if (flags & ANYOF_HAS_NONBITMAP_NON_UTF8_MATCHES) {
17080                             sv_catpvs(sv, "{outside bitmap}");
17081                         }
17082                         else {
17083                             sv_catpvs(sv, "{utf8}");
17084                         }
17085
17086                         if (byte_output) {
17087                             sv_catpvs(sv, " ");
17088                         }
17089
17090                         while (*s) {
17091                             if (*s == '\n') {
17092
17093                                 /* Truncate very long output */
17094                                 if (s - origs > 256) {
17095                                     Perl_sv_catpvf(aTHX_ sv,
17096                                                 "%.*s...",
17097                                                 (int) (s - origs - 1),
17098                                                 t);
17099                                     goto out_dump;
17100                                 }
17101                                 *s = ' ';
17102                             }
17103                             else if (*s == '\t') {
17104                                 *s = '-';
17105                             }
17106                             s++;
17107                         }
17108                         if (s[-1] == ' ')
17109                             s[-1] = 0;
17110
17111                         sv_catpv(sv, t);
17112                     }
17113
17114                   out_dump:
17115
17116                     Safefree(origs);
17117                     SvREFCNT_dec_NN(lv);
17118                 }
17119
17120                 if ((flags & ANYOF_LOC_FOLD)
17121                      && only_utf8_locale
17122                      && only_utf8_locale != &PL_sv_undef)
17123                 {
17124                     UV start, end;
17125                     int max_entries = 256;
17126
17127                     sv_catpvs(sv, "{utf8 locale}");
17128                     invlist_iterinit(only_utf8_locale);
17129                     while (invlist_iternext(only_utf8_locale,
17130                                             &start, &end)) {
17131                         put_range(sv, start, end, FALSE);
17132                         max_entries --;
17133                         if (max_entries < 0) {
17134                             sv_catpvs(sv, "...");
17135                             break;
17136                         }
17137                     }
17138                     invlist_iterfinish(only_utf8_locale);
17139                 }
17140             }
17141         }
17142         SvREFCNT_dec(bitmap_invlist);
17143
17144
17145         Perl_sv_catpvf(aTHX_ sv, "%s]", PL_colors[1]);
17146     }
17147     else if (k == POSIXD || k == NPOSIXD) {
17148         U8 index = FLAGS(o) * 2;
17149         if (index < C_ARRAY_LENGTH(anyofs)) {
17150             if (*anyofs[index] != '[')  {
17151                 sv_catpv(sv, "[");
17152             }
17153             sv_catpv(sv, anyofs[index]);
17154             if (*anyofs[index] != '[')  {
17155                 sv_catpv(sv, "]");
17156             }
17157         }
17158         else {
17159             Perl_sv_catpvf(aTHX_ sv, "[illegal type=%d])", index);
17160         }
17161     }
17162     else if (k == BOUND || k == NBOUND) {
17163         /* Must be synced with order of 'bound_type' in regcomp.h */
17164         const char * const bounds[] = {
17165             "",      /* Traditional */
17166             "{gcb}",
17167             "{sb}",
17168             "{wb}"
17169         };
17170         sv_catpv(sv, bounds[FLAGS(o)]);
17171     }
17172     else if (k == BRANCHJ && (OP(o) == UNLESSM || OP(o) == IFMATCH))
17173         Perl_sv_catpvf(aTHX_ sv, "[%d]", -(o->flags));
17174     else if (OP(o) == SBOL)
17175         Perl_sv_catpvf(aTHX_ sv, " /%s/", o->flags ? "\\A" : "^");
17176 #else
17177     PERL_UNUSED_CONTEXT;
17178     PERL_UNUSED_ARG(sv);
17179     PERL_UNUSED_ARG(o);
17180     PERL_UNUSED_ARG(prog);
17181     PERL_UNUSED_ARG(reginfo);
17182     PERL_UNUSED_ARG(pRExC_state);
17183 #endif  /* DEBUGGING */
17184 }
17185
17186
17187
17188 SV *
17189 Perl_re_intuit_string(pTHX_ REGEXP * const r)
17190 {                               /* Assume that RE_INTUIT is set */
17191     struct regexp *const prog = ReANY(r);
17192     GET_RE_DEBUG_FLAGS_DECL;
17193
17194     PERL_ARGS_ASSERT_RE_INTUIT_STRING;
17195     PERL_UNUSED_CONTEXT;
17196
17197     DEBUG_COMPILE_r(
17198         {
17199             const char * const s = SvPV_nolen_const(RX_UTF8(r)
17200                       ? prog->check_utf8 : prog->check_substr);
17201
17202             if (!PL_colorset) reginitcolors();
17203             PerlIO_printf(Perl_debug_log,
17204                       "%sUsing REx %ssubstr:%s \"%s%.60s%s%s\"\n",
17205                       PL_colors[4],
17206                       RX_UTF8(r) ? "utf8 " : "",
17207                       PL_colors[5],PL_colors[0],
17208                       s,
17209                       PL_colors[1],
17210                       (strlen(s) > 60 ? "..." : ""));
17211         } );
17212
17213     /* use UTF8 check substring if regexp pattern itself is in UTF8 */
17214     return RX_UTF8(r) ? prog->check_utf8 : prog->check_substr;
17215 }
17216
17217 /*
17218    pregfree()
17219
17220    handles refcounting and freeing the perl core regexp structure. When
17221    it is necessary to actually free the structure the first thing it
17222    does is call the 'free' method of the regexp_engine associated to
17223    the regexp, allowing the handling of the void *pprivate; member
17224    first. (This routine is not overridable by extensions, which is why
17225    the extensions free is called first.)
17226
17227    See regdupe and regdupe_internal if you change anything here.
17228 */
17229 #ifndef PERL_IN_XSUB_RE
17230 void
17231 Perl_pregfree(pTHX_ REGEXP *r)
17232 {
17233     SvREFCNT_dec(r);
17234 }
17235
17236 void
17237 Perl_pregfree2(pTHX_ REGEXP *rx)
17238 {
17239     struct regexp *const r = ReANY(rx);
17240     GET_RE_DEBUG_FLAGS_DECL;
17241
17242     PERL_ARGS_ASSERT_PREGFREE2;
17243
17244     if (r->mother_re) {
17245         ReREFCNT_dec(r->mother_re);
17246     } else {
17247         CALLREGFREE_PVT(rx); /* free the private data */
17248         SvREFCNT_dec(RXp_PAREN_NAMES(r));
17249         Safefree(r->xpv_len_u.xpvlenu_pv);
17250     }
17251     if (r->substrs) {
17252         SvREFCNT_dec(r->anchored_substr);
17253         SvREFCNT_dec(r->anchored_utf8);
17254         SvREFCNT_dec(r->float_substr);
17255         SvREFCNT_dec(r->float_utf8);
17256         Safefree(r->substrs);
17257     }
17258     RX_MATCH_COPY_FREE(rx);
17259 #ifdef PERL_ANY_COW
17260     SvREFCNT_dec(r->saved_copy);
17261 #endif
17262     Safefree(r->offs);
17263     SvREFCNT_dec(r->qr_anoncv);
17264     rx->sv_u.svu_rx = 0;
17265 }
17266
17267 /*  reg_temp_copy()
17268
17269     This is a hacky workaround to the structural issue of match results
17270     being stored in the regexp structure which is in turn stored in
17271     PL_curpm/PL_reg_curpm. The problem is that due to qr// the pattern
17272     could be PL_curpm in multiple contexts, and could require multiple
17273     result sets being associated with the pattern simultaneously, such
17274     as when doing a recursive match with (??{$qr})
17275
17276     The solution is to make a lightweight copy of the regexp structure
17277     when a qr// is returned from the code executed by (??{$qr}) this
17278     lightweight copy doesn't actually own any of its data except for
17279     the starp/end and the actual regexp structure itself.
17280
17281 */
17282
17283
17284 REGEXP *
17285 Perl_reg_temp_copy (pTHX_ REGEXP *ret_x, REGEXP *rx)
17286 {
17287     struct regexp *ret;
17288     struct regexp *const r = ReANY(rx);
17289     const bool islv = ret_x && SvTYPE(ret_x) == SVt_PVLV;
17290
17291     PERL_ARGS_ASSERT_REG_TEMP_COPY;
17292
17293     if (!ret_x)
17294         ret_x = (REGEXP*) newSV_type(SVt_REGEXP);
17295     else {
17296         SvOK_off((SV *)ret_x);
17297         if (islv) {
17298             /* For PVLVs, SvANY points to the xpvlv body while sv_u points
17299                to the regexp.  (For SVt_REGEXPs, sv_upgrade has already
17300                made both spots point to the same regexp body.) */
17301             REGEXP *temp = (REGEXP *)newSV_type(SVt_REGEXP);
17302             assert(!SvPVX(ret_x));
17303             ret_x->sv_u.svu_rx = temp->sv_any;
17304             temp->sv_any = NULL;
17305             SvFLAGS(temp) = (SvFLAGS(temp) & ~SVTYPEMASK) | SVt_NULL;
17306             SvREFCNT_dec_NN(temp);
17307             /* SvCUR still resides in the xpvlv struct, so the regexp copy-
17308                ing below will not set it. */
17309             SvCUR_set(ret_x, SvCUR(rx));
17310         }
17311     }
17312     /* This ensures that SvTHINKFIRST(sv) is true, and hence that
17313        sv_force_normal(sv) is called.  */
17314     SvFAKE_on(ret_x);
17315     ret = ReANY(ret_x);
17316
17317     SvFLAGS(ret_x) |= SvUTF8(rx);
17318     /* We share the same string buffer as the original regexp, on which we
17319        hold a reference count, incremented when mother_re is set below.
17320        The string pointer is copied here, being part of the regexp struct.
17321      */
17322     memcpy(&(ret->xpv_cur), &(r->xpv_cur),
17323            sizeof(regexp) - STRUCT_OFFSET(regexp, xpv_cur));
17324     if (r->offs) {
17325         const I32 npar = r->nparens+1;
17326         Newx(ret->offs, npar, regexp_paren_pair);
17327         Copy(r->offs, ret->offs, npar, regexp_paren_pair);
17328     }
17329     if (r->substrs) {
17330         Newx(ret->substrs, 1, struct reg_substr_data);
17331         StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
17332
17333         SvREFCNT_inc_void(ret->anchored_substr);
17334         SvREFCNT_inc_void(ret->anchored_utf8);
17335         SvREFCNT_inc_void(ret->float_substr);
17336         SvREFCNT_inc_void(ret->float_utf8);
17337
17338         /* check_substr and check_utf8, if non-NULL, point to either their
17339            anchored or float namesakes, and don't hold a second reference.  */
17340     }
17341     RX_MATCH_COPIED_off(ret_x);
17342 #ifdef PERL_ANY_COW
17343     ret->saved_copy = NULL;
17344 #endif
17345     ret->mother_re = ReREFCNT_inc(r->mother_re ? r->mother_re : rx);
17346     SvREFCNT_inc_void(ret->qr_anoncv);
17347
17348     return ret_x;
17349 }
17350 #endif
17351
17352 /* regfree_internal()
17353
17354    Free the private data in a regexp. This is overloadable by
17355    extensions. Perl takes care of the regexp structure in pregfree(),
17356    this covers the *pprivate pointer which technically perl doesn't
17357    know about, however of course we have to handle the
17358    regexp_internal structure when no extension is in use.
17359
17360    Note this is called before freeing anything in the regexp
17361    structure.
17362  */
17363
17364 void
17365 Perl_regfree_internal(pTHX_ REGEXP * const rx)
17366 {
17367     struct regexp *const r = ReANY(rx);
17368     RXi_GET_DECL(r,ri);
17369     GET_RE_DEBUG_FLAGS_DECL;
17370
17371     PERL_ARGS_ASSERT_REGFREE_INTERNAL;
17372
17373     DEBUG_COMPILE_r({
17374         if (!PL_colorset)
17375             reginitcolors();
17376         {
17377             SV *dsv= sv_newmortal();
17378             RE_PV_QUOTED_DECL(s, RX_UTF8(rx),
17379                 dsv, RX_PRECOMP(rx), RX_PRELEN(rx), 60);
17380             PerlIO_printf(Perl_debug_log,"%sFreeing REx:%s %s\n",
17381                 PL_colors[4],PL_colors[5],s);
17382         }
17383     });
17384 #ifdef RE_TRACK_PATTERN_OFFSETS
17385     if (ri->u.offsets)
17386         Safefree(ri->u.offsets);             /* 20010421 MJD */
17387 #endif
17388     if (ri->code_blocks) {
17389         int n;
17390         for (n = 0; n < ri->num_code_blocks; n++)
17391             SvREFCNT_dec(ri->code_blocks[n].src_regex);
17392         Safefree(ri->code_blocks);
17393     }
17394
17395     if (ri->data) {
17396         int n = ri->data->count;
17397
17398         while (--n >= 0) {
17399           /* If you add a ->what type here, update the comment in regcomp.h */
17400             switch (ri->data->what[n]) {
17401             case 'a':
17402             case 'r':
17403             case 's':
17404             case 'S':
17405             case 'u':
17406                 SvREFCNT_dec(MUTABLE_SV(ri->data->data[n]));
17407                 break;
17408             case 'f':
17409                 Safefree(ri->data->data[n]);
17410                 break;
17411             case 'l':
17412             case 'L':
17413                 break;
17414             case 'T':
17415                 { /* Aho Corasick add-on structure for a trie node.
17416                      Used in stclass optimization only */
17417                     U32 refcount;
17418                     reg_ac_data *aho=(reg_ac_data*)ri->data->data[n];
17419 #ifdef USE_ITHREADS
17420                     dVAR;
17421 #endif
17422                     OP_REFCNT_LOCK;
17423                     refcount = --aho->refcount;
17424                     OP_REFCNT_UNLOCK;
17425                     if ( !refcount ) {
17426                         PerlMemShared_free(aho->states);
17427                         PerlMemShared_free(aho->fail);
17428                          /* do this last!!!! */
17429                         PerlMemShared_free(ri->data->data[n]);
17430                         /* we should only ever get called once, so
17431                          * assert as much, and also guard the free
17432                          * which /might/ happen twice. At the least
17433                          * it will make code anlyzers happy and it
17434                          * doesn't cost much. - Yves */
17435                         assert(ri->regstclass);
17436                         if (ri->regstclass) {
17437                             PerlMemShared_free(ri->regstclass);
17438                             ri->regstclass = 0;
17439                         }
17440                     }
17441                 }
17442                 break;
17443             case 't':
17444                 {
17445                     /* trie structure. */
17446                     U32 refcount;
17447                     reg_trie_data *trie=(reg_trie_data*)ri->data->data[n];
17448 #ifdef USE_ITHREADS
17449                     dVAR;
17450 #endif
17451                     OP_REFCNT_LOCK;
17452                     refcount = --trie->refcount;
17453                     OP_REFCNT_UNLOCK;
17454                     if ( !refcount ) {
17455                         PerlMemShared_free(trie->charmap);
17456                         PerlMemShared_free(trie->states);
17457                         PerlMemShared_free(trie->trans);
17458                         if (trie->bitmap)
17459                             PerlMemShared_free(trie->bitmap);
17460                         if (trie->jump)
17461                             PerlMemShared_free(trie->jump);
17462                         PerlMemShared_free(trie->wordinfo);
17463                         /* do this last!!!! */
17464                         PerlMemShared_free(ri->data->data[n]);
17465                     }
17466                 }
17467                 break;
17468             default:
17469                 Perl_croak(aTHX_ "panic: regfree data code '%c'",
17470                                                     ri->data->what[n]);
17471             }
17472         }
17473         Safefree(ri->data->what);
17474         Safefree(ri->data);
17475     }
17476
17477     Safefree(ri);
17478 }
17479
17480 #define av_dup_inc(s,t) MUTABLE_AV(sv_dup_inc((const SV *)s,t))
17481 #define hv_dup_inc(s,t) MUTABLE_HV(sv_dup_inc((const SV *)s,t))
17482 #define SAVEPVN(p,n)    ((p) ? savepvn(p,n) : NULL)
17483
17484 /*
17485    re_dup - duplicate a regexp.
17486
17487    This routine is expected to clone a given regexp structure. It is only
17488    compiled under USE_ITHREADS.
17489
17490    After all of the core data stored in struct regexp is duplicated
17491    the regexp_engine.dupe method is used to copy any private data
17492    stored in the *pprivate pointer. This allows extensions to handle
17493    any duplication it needs to do.
17494
17495    See pregfree() and regfree_internal() if you change anything here.
17496 */
17497 #if defined(USE_ITHREADS)
17498 #ifndef PERL_IN_XSUB_RE
17499 void
17500 Perl_re_dup_guts(pTHX_ const REGEXP *sstr, REGEXP *dstr, CLONE_PARAMS *param)
17501 {
17502     dVAR;
17503     I32 npar;
17504     const struct regexp *r = ReANY(sstr);
17505     struct regexp *ret = ReANY(dstr);
17506
17507     PERL_ARGS_ASSERT_RE_DUP_GUTS;
17508
17509     npar = r->nparens+1;
17510     Newx(ret->offs, npar, regexp_paren_pair);
17511     Copy(r->offs, ret->offs, npar, regexp_paren_pair);
17512
17513     if (ret->substrs) {
17514         /* Do it this way to avoid reading from *r after the StructCopy().
17515            That way, if any of the sv_dup_inc()s dislodge *r from the L1
17516            cache, it doesn't matter.  */
17517         const bool anchored = r->check_substr
17518             ? r->check_substr == r->anchored_substr
17519             : r->check_utf8 == r->anchored_utf8;
17520         Newx(ret->substrs, 1, struct reg_substr_data);
17521         StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
17522
17523         ret->anchored_substr = sv_dup_inc(ret->anchored_substr, param);
17524         ret->anchored_utf8 = sv_dup_inc(ret->anchored_utf8, param);
17525         ret->float_substr = sv_dup_inc(ret->float_substr, param);
17526         ret->float_utf8 = sv_dup_inc(ret->float_utf8, param);
17527
17528         /* check_substr and check_utf8, if non-NULL, point to either their
17529            anchored or float namesakes, and don't hold a second reference.  */
17530
17531         if (ret->check_substr) {
17532             if (anchored) {
17533                 assert(r->check_utf8 == r->anchored_utf8);
17534                 ret->check_substr = ret->anchored_substr;
17535                 ret->check_utf8 = ret->anchored_utf8;
17536             } else {
17537                 assert(r->check_substr == r->float_substr);
17538                 assert(r->check_utf8 == r->float_utf8);
17539                 ret->check_substr = ret->float_substr;
17540                 ret->check_utf8 = ret->float_utf8;
17541             }
17542         } else if (ret->check_utf8) {
17543             if (anchored) {
17544                 ret->check_utf8 = ret->anchored_utf8;
17545             } else {
17546                 ret->check_utf8 = ret->float_utf8;
17547             }
17548         }
17549     }
17550
17551     RXp_PAREN_NAMES(ret) = hv_dup_inc(RXp_PAREN_NAMES(ret), param);
17552     ret->qr_anoncv = MUTABLE_CV(sv_dup_inc((const SV *)ret->qr_anoncv, param));
17553
17554     if (ret->pprivate)
17555         RXi_SET(ret,CALLREGDUPE_PVT(dstr,param));
17556
17557     if (RX_MATCH_COPIED(dstr))
17558         ret->subbeg  = SAVEPVN(ret->subbeg, ret->sublen);
17559     else
17560         ret->subbeg = NULL;
17561 #ifdef PERL_ANY_COW
17562     ret->saved_copy = NULL;
17563 #endif
17564
17565     /* Whether mother_re be set or no, we need to copy the string.  We
17566        cannot refrain from copying it when the storage points directly to
17567        our mother regexp, because that's
17568                1: a buffer in a different thread
17569                2: something we no longer hold a reference on
17570                so we need to copy it locally.  */
17571     RX_WRAPPED(dstr) = SAVEPVN(RX_WRAPPED(sstr), SvCUR(sstr)+1);
17572     ret->mother_re   = NULL;
17573 }
17574 #endif /* PERL_IN_XSUB_RE */
17575
17576 /*
17577    regdupe_internal()
17578
17579    This is the internal complement to regdupe() which is used to copy
17580    the structure pointed to by the *pprivate pointer in the regexp.
17581    This is the core version of the extension overridable cloning hook.
17582    The regexp structure being duplicated will be copied by perl prior
17583    to this and will be provided as the regexp *r argument, however
17584    with the /old/ structures pprivate pointer value. Thus this routine
17585    may override any copying normally done by perl.
17586
17587    It returns a pointer to the new regexp_internal structure.
17588 */
17589
17590 void *
17591 Perl_regdupe_internal(pTHX_ REGEXP * const rx, CLONE_PARAMS *param)
17592 {
17593     dVAR;
17594     struct regexp *const r = ReANY(rx);
17595     regexp_internal *reti;
17596     int len;
17597     RXi_GET_DECL(r,ri);
17598
17599     PERL_ARGS_ASSERT_REGDUPE_INTERNAL;
17600
17601     len = ProgLen(ri);
17602
17603     Newxc(reti, sizeof(regexp_internal) + len*sizeof(regnode),
17604           char, regexp_internal);
17605     Copy(ri->program, reti->program, len+1, regnode);
17606
17607     reti->num_code_blocks = ri->num_code_blocks;
17608     if (ri->code_blocks) {
17609         int n;
17610         Newxc(reti->code_blocks, ri->num_code_blocks, struct reg_code_block,
17611                 struct reg_code_block);
17612         Copy(ri->code_blocks, reti->code_blocks, ri->num_code_blocks,
17613                 struct reg_code_block);
17614         for (n = 0; n < ri->num_code_blocks; n++)
17615              reti->code_blocks[n].src_regex = (REGEXP*)
17616                     sv_dup_inc((SV*)(ri->code_blocks[n].src_regex), param);
17617     }
17618     else
17619         reti->code_blocks = NULL;
17620
17621     reti->regstclass = NULL;
17622
17623     if (ri->data) {
17624         struct reg_data *d;
17625         const int count = ri->data->count;
17626         int i;
17627
17628         Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
17629                 char, struct reg_data);
17630         Newx(d->what, count, U8);
17631
17632         d->count = count;
17633         for (i = 0; i < count; i++) {
17634             d->what[i] = ri->data->what[i];
17635             switch (d->what[i]) {
17636                 /* see also regcomp.h and regfree_internal() */
17637             case 'a': /* actually an AV, but the dup function is identical.  */
17638             case 'r':
17639             case 's':
17640             case 'S':
17641             case 'u': /* actually an HV, but the dup function is identical.  */
17642                 d->data[i] = sv_dup_inc((const SV *)ri->data->data[i], param);
17643                 break;
17644             case 'f':
17645                 /* This is cheating. */
17646                 Newx(d->data[i], 1, regnode_ssc);
17647                 StructCopy(ri->data->data[i], d->data[i], regnode_ssc);
17648                 reti->regstclass = (regnode*)d->data[i];
17649                 break;
17650             case 'T':
17651                 /* Trie stclasses are readonly and can thus be shared
17652                  * without duplication. We free the stclass in pregfree
17653                  * when the corresponding reg_ac_data struct is freed.
17654                  */
17655                 reti->regstclass= ri->regstclass;
17656                 /* FALLTHROUGH */
17657             case 't':
17658                 OP_REFCNT_LOCK;
17659                 ((reg_trie_data*)ri->data->data[i])->refcount++;
17660                 OP_REFCNT_UNLOCK;
17661                 /* FALLTHROUGH */
17662             case 'l':
17663             case 'L':
17664                 d->data[i] = ri->data->data[i];
17665                 break;
17666             default:
17667                 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'",
17668                                                            ri->data->what[i]);
17669             }
17670         }
17671
17672         reti->data = d;
17673     }
17674     else
17675         reti->data = NULL;
17676
17677     reti->name_list_idx = ri->name_list_idx;
17678
17679 #ifdef RE_TRACK_PATTERN_OFFSETS
17680     if (ri->u.offsets) {
17681         Newx(reti->u.offsets, 2*len+1, U32);
17682         Copy(ri->u.offsets, reti->u.offsets, 2*len+1, U32);
17683     }
17684 #else
17685     SetProgLen(reti,len);
17686 #endif
17687
17688     return (void*)reti;
17689 }
17690
17691 #endif    /* USE_ITHREADS */
17692
17693 #ifndef PERL_IN_XSUB_RE
17694
17695 /*
17696  - regnext - dig the "next" pointer out of a node
17697  */
17698 regnode *
17699 Perl_regnext(pTHX_ regnode *p)
17700 {
17701     I32 offset;
17702
17703     if (!p)
17704         return(NULL);
17705
17706     if (OP(p) > REGNODE_MAX) {          /* regnode.type is unsigned */
17707         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d",
17708                                                 (int)OP(p), (int)REGNODE_MAX);
17709     }
17710
17711     offset = (reg_off_by_arg[OP(p)] ? ARG(p) : NEXT_OFF(p));
17712     if (offset == 0)
17713         return(NULL);
17714
17715     return(p+offset);
17716 }
17717 #endif
17718
17719 STATIC void
17720 S_re_croak2(pTHX_ bool utf8, const char* pat1,const char* pat2,...)
17721 {
17722     va_list args;
17723     STRLEN l1 = strlen(pat1);
17724     STRLEN l2 = strlen(pat2);
17725     char buf[512];
17726     SV *msv;
17727     const char *message;
17728
17729     PERL_ARGS_ASSERT_RE_CROAK2;
17730
17731     if (l1 > 510)
17732         l1 = 510;
17733     if (l1 + l2 > 510)
17734         l2 = 510 - l1;
17735     Copy(pat1, buf, l1 , char);
17736     Copy(pat2, buf + l1, l2 , char);
17737     buf[l1 + l2] = '\n';
17738     buf[l1 + l2 + 1] = '\0';
17739     va_start(args, pat2);
17740     msv = vmess(buf, &args);
17741     va_end(args);
17742     message = SvPV_const(msv,l1);
17743     if (l1 > 512)
17744         l1 = 512;
17745     Copy(message, buf, l1 , char);
17746     /* l1-1 to avoid \n */
17747     Perl_croak(aTHX_ "%"UTF8f, UTF8fARG(utf8, l1-1, buf));
17748 }
17749
17750 /* XXX Here's a total kludge.  But we need to re-enter for swash routines. */
17751
17752 #ifndef PERL_IN_XSUB_RE
17753 void
17754 Perl_save_re_context(pTHX)
17755 {
17756     I32 nparens = -1;
17757     I32 i;
17758
17759     /* Save $1..$n (#18107: UTF-8 s/(\w+)/uc($1)/e); AMS 20021106. */
17760
17761     if (PL_curpm) {
17762         const REGEXP * const rx = PM_GETRE(PL_curpm);
17763         if (rx)
17764             nparens = RX_NPARENS(rx);
17765     }
17766
17767     /* RT #124109. This is a complete hack; in the SWASHNEW case we know
17768      * that PL_curpm will be null, but that utf8.pm and the modules it
17769      * loads will only use $1..$3.
17770      * The t/porting/re_context.t test file checks this assumption.
17771      */
17772     if (nparens == -1)
17773         nparens = 3;
17774
17775     for (i = 1; i <= nparens; i++) {
17776         char digits[TYPE_CHARS(long)];
17777         const STRLEN len = my_snprintf(digits, sizeof(digits),
17778                                        "%lu", (long)i);
17779         GV *const *const gvp
17780             = (GV**)hv_fetch(PL_defstash, digits, len, 0);
17781
17782         if (gvp) {
17783             GV * const gv = *gvp;
17784             if (SvTYPE(gv) == SVt_PVGV && GvSV(gv))
17785                 save_scalar(gv);
17786         }
17787     }
17788 }
17789 #endif
17790
17791 #ifdef DEBUGGING
17792
17793 STATIC void
17794 S_put_code_point(pTHX_ SV *sv, UV c)
17795 {
17796     PERL_ARGS_ASSERT_PUT_CODE_POINT;
17797
17798     if (c > 255) {
17799         Perl_sv_catpvf(aTHX_ sv, "\\x{%04"UVXf"}", c);
17800     }
17801     else if (isPRINT(c)) {
17802         const char string = (char) c;
17803         if (isBACKSLASHED_PUNCT(c))
17804             sv_catpvs(sv, "\\");
17805         sv_catpvn(sv, &string, 1);
17806     }
17807     else {
17808         const char * const mnemonic = cntrl_to_mnemonic((char) c);
17809         if (mnemonic) {
17810             Perl_sv_catpvf(aTHX_ sv, "%s", mnemonic);
17811         }
17812         else {
17813             Perl_sv_catpvf(aTHX_ sv, "\\x{%02X}", (U8) c);
17814         }
17815     }
17816 }
17817
17818 #define MAX_PRINT_A MAX_PRINT_A_FOR_USE_ONLY_BY_REGCOMP_DOT_C
17819
17820 STATIC void
17821 S_put_range(pTHX_ SV *sv, UV start, const UV end, const bool allow_literals)
17822 {
17823     /* Appends to 'sv' a displayable version of the range of code points from
17824      * 'start' to 'end'.  It assumes that only ASCII printables are displayable
17825      * as-is (though some of these will be escaped by put_code_point()). */
17826
17827     const unsigned int min_range_count = 3;
17828
17829     assert(start <= end);
17830
17831     PERL_ARGS_ASSERT_PUT_RANGE;
17832
17833     while (start <= end) {
17834         UV this_end;
17835         const char * format;
17836
17837         if (end - start < min_range_count) {
17838
17839             /* Individual chars in short ranges */
17840             for (; start <= end; start++) {
17841                 put_code_point(sv, start);
17842             }
17843             break;
17844         }
17845
17846         /* If permitted by the input options, and there is a possibility that
17847          * this range contains a printable literal, look to see if there is
17848          * one.  */
17849         if (allow_literals && start <= MAX_PRINT_A) {
17850
17851             /* If the range begin isn't an ASCII printable, effectively split
17852              * the range into two parts:
17853              *  1) the portion before the first such printable,
17854              *  2) the rest
17855              * and output them separately. */
17856             if (! isPRINT_A(start)) {
17857                 UV temp_end = start + 1;
17858
17859                 /* There is no point looking beyond the final possible
17860                  * printable, in MAX_PRINT_A */
17861                 UV max = MIN(end, MAX_PRINT_A);
17862
17863                 while (temp_end <= max && ! isPRINT_A(temp_end)) {
17864                     temp_end++;
17865                 }
17866
17867                 /* Here, temp_end points to one beyond the first printable if
17868                  * found, or to one beyond 'max' if not.  If none found, make
17869                  * sure that we use the entire range */
17870                 if (temp_end > MAX_PRINT_A) {
17871                     temp_end = end + 1;
17872                 }
17873
17874                 /* Output the first part of the split range, the part that
17875                  * doesn't have printables, with no looking for literals
17876                  * (otherwise we would infinitely recurse) */
17877                 put_range(sv, start, temp_end - 1, FALSE);
17878
17879                 /* The 2nd part of the range (if any) starts here. */
17880                 start = temp_end;
17881
17882                 /* We continue instead of dropping down because even if the 2nd
17883                  * part is non-empty, it could be so short that we want to
17884                  * output it specially, as tested for at the top of this loop.
17885                  * */
17886                 continue;
17887             }
17888
17889             /* Here, 'start' is a printable ASCII.  If it is an alphanumeric,
17890              * output a sub-range of just the digits or letters, then process
17891              * the remaining portion as usual. */
17892             if (isALPHANUMERIC_A(start)) {
17893                 UV mask = (isDIGIT_A(start))
17894                            ? _CC_DIGIT
17895                              : isUPPER_A(start)
17896                                ? _CC_UPPER
17897                                : _CC_LOWER;
17898                 UV temp_end = start + 1;
17899
17900                 /* Find the end of the sub-range that includes just the
17901                  * characters in the same class as the first character in it */
17902                 while (temp_end <= end && _generic_isCC_A(temp_end, mask)) {
17903                     temp_end++;
17904                 }
17905                 temp_end--;
17906
17907                 /* For short ranges, don't duplicate the code above to output
17908                  * them; just call recursively */
17909                 if (temp_end - start < min_range_count) {
17910                     put_range(sv, start, temp_end, FALSE);
17911                 }
17912                 else {  /* Output as a range */
17913                     put_code_point(sv, start);
17914                     sv_catpvs(sv, "-");
17915                     put_code_point(sv, temp_end);
17916                 }
17917                 start = temp_end + 1;
17918                 continue;
17919             }
17920
17921             /* We output any other printables as individual characters */
17922             if (isPUNCT_A(start) || isSPACE_A(start)) {
17923                 while (start <= end && (isPUNCT_A(start)
17924                                         || isSPACE_A(start)))
17925                 {
17926                     put_code_point(sv, start);
17927                     start++;
17928                 }
17929                 continue;
17930             }
17931         } /* End of looking for literals */
17932
17933         /* Here is not to output as a literal.  Some control characters have
17934          * mnemonic names.  Split off any of those at the beginning and end of
17935          * the range to print mnemonically.  It isn't possible for many of
17936          * these to be in a row, so this won't overwhelm with output */
17937         while (isMNEMONIC_CNTRL(start) && start <= end) {
17938             put_code_point(sv, start);
17939             start++;
17940         }
17941         if (start < end && isMNEMONIC_CNTRL(end)) {
17942
17943             /* Here, the final character in the range has a mnemonic name.
17944              * Work backwards from the end to find the final non-mnemonic */
17945             UV temp_end = end - 1;
17946             while (isMNEMONIC_CNTRL(temp_end)) {
17947                 temp_end--;
17948             }
17949
17950             /* And separately output the range that doesn't have mnemonics */
17951             put_range(sv, start, temp_end, FALSE);
17952
17953             /* Then output the mnemonic trailing controls */
17954             start = temp_end + 1;
17955             while (start <= end) {
17956                 put_code_point(sv, start);
17957                 start++;
17958             }
17959             break;
17960         }
17961
17962         /* As a final resort, output the range or subrange as hex. */
17963
17964         this_end = (end < NUM_ANYOF_CODE_POINTS)
17965                     ? end
17966                     : NUM_ANYOF_CODE_POINTS - 1;
17967         format = (this_end < 256)
17968                  ? "\\x{%02"UVXf"}-\\x{%02"UVXf"}"
17969                  : "\\x{%04"UVXf"}-\\x{%04"UVXf"}";
17970         GCC_DIAG_IGNORE(-Wformat-nonliteral);
17971         Perl_sv_catpvf(aTHX_ sv, format, start, this_end);
17972         GCC_DIAG_RESTORE;
17973         break;
17974     }
17975 }
17976
17977 STATIC bool
17978 S_put_charclass_bitmap_innards(pTHX_ SV *sv, char *bitmap, SV** bitmap_invlist)
17979 {
17980     /* Appends to 'sv' a displayable version of the innards of the bracketed
17981      * character class whose bitmap is 'bitmap';  Returns 'TRUE' if it actually
17982      * output anything, and bitmap_invlist, if not NULL, will point to an
17983      * inversion list of what is in the bit map */
17984
17985     int i;
17986     UV start, end;
17987     unsigned int punct_count = 0;
17988     SV* invlist = NULL;
17989     SV** invlist_ptr;   /* Temporary, in case bitmap_invlist is NULL */
17990     bool allow_literals = TRUE;
17991
17992     PERL_ARGS_ASSERT_PUT_CHARCLASS_BITMAP_INNARDS;
17993
17994     invlist_ptr = (bitmap_invlist) ? bitmap_invlist : &invlist;
17995
17996     /* Worst case is exactly every-other code point is in the list */
17997     *invlist_ptr = _new_invlist(NUM_ANYOF_CODE_POINTS / 2);
17998
17999     /* Convert the bit map to an inversion list, keeping track of how many
18000      * ASCII puncts are set, including an extra amount for the backslashed
18001      * ones.  */
18002     for (i = 0; i < NUM_ANYOF_CODE_POINTS; i++) {
18003         if (BITMAP_TEST(bitmap, i)) {
18004             *invlist_ptr = add_cp_to_invlist(*invlist_ptr, i);
18005             if (isPUNCT_A(i)) {
18006                 punct_count++;
18007                 if isBACKSLASHED_PUNCT(i) {
18008                     punct_count++;
18009                 }
18010             }
18011         }
18012     }
18013
18014     /* Nothing to output */
18015     if (_invlist_len(*invlist_ptr) == 0) {
18016         SvREFCNT_dec(invlist);
18017         return FALSE;
18018     }
18019
18020     /* Generally, it is more readable if printable characters are output as
18021      * literals, but if a range (nearly) spans all of them, it's best to output
18022      * it as a single range.  This code will use a single range if all but 2
18023      * printables are in it */
18024     invlist_iterinit(*invlist_ptr);
18025     while (invlist_iternext(*invlist_ptr, &start, &end)) {
18026
18027         /* If range starts beyond final printable, it doesn't have any in it */
18028         if (start > MAX_PRINT_A) {
18029             break;
18030         }
18031
18032         /* In both ASCII and EBCDIC, a SPACE is the lowest printable.  To span
18033          * all but two, the range must start and end no later than 2 from
18034          * either end */
18035         if (start < ' ' + 2 && end > MAX_PRINT_A - 2) {
18036             if (end > MAX_PRINT_A) {
18037                 end = MAX_PRINT_A;
18038             }
18039             if (start < ' ') {
18040                 start = ' ';
18041             }
18042             if (end - start >= MAX_PRINT_A - ' ' - 2) {
18043                 allow_literals = FALSE;
18044             }
18045             break;
18046         }
18047     }
18048     invlist_iterfinish(*invlist_ptr);
18049
18050     /* The legibility of the output depends mostly on how many punctuation
18051      * characters are output.  There are 32 possible ASCII ones, and some have
18052      * an additional backslash, bringing it to currently 36, so if any more
18053      * than 18 are to be output, we can instead output it as its complement,
18054      * yielding fewer puncts, and making it more legible.  But give some weight
18055      * to the fact that outputting it as a complement is less legible than a
18056      * straight output, so don't complement unless we are somewhat over the 18
18057      * mark */
18058     if (allow_literals && punct_count > 22) {
18059         sv_catpvs(sv, "^");
18060
18061         /* Add everything remaining to the list, so when we invert it just
18062          * below, it will be excluded */
18063         _invlist_union_complement_2nd(*invlist_ptr, PL_InBitmap, invlist_ptr);
18064         _invlist_invert(*invlist_ptr);
18065     }
18066
18067     /* Here we have figured things out.  Output each range */
18068     invlist_iterinit(*invlist_ptr);
18069     while (invlist_iternext(*invlist_ptr, &start, &end)) {
18070         if (start >= NUM_ANYOF_CODE_POINTS) {
18071             break;
18072         }
18073         put_range(sv, start, end, allow_literals);
18074     }
18075     invlist_iterfinish(*invlist_ptr);
18076
18077     return TRUE;
18078 }
18079
18080 #define CLEAR_OPTSTART \
18081     if (optstart) STMT_START {                                               \
18082         DEBUG_OPTIMISE_r(PerlIO_printf(Perl_debug_log,                       \
18083                               " (%"IVdf" nodes)\n", (IV)(node - optstart))); \
18084         optstart=NULL;                                                       \
18085     } STMT_END
18086
18087 #define DUMPUNTIL(b,e)                                                       \
18088                     CLEAR_OPTSTART;                                          \
18089                     node=dumpuntil(r,start,(b),(e),last,sv,indent+1,depth+1);
18090
18091 STATIC const regnode *
18092 S_dumpuntil(pTHX_ const regexp *r, const regnode *start, const regnode *node,
18093             const regnode *last, const regnode *plast,
18094             SV* sv, I32 indent, U32 depth)
18095 {
18096     U8 op = PSEUDO;     /* Arbitrary non-END op. */
18097     const regnode *next;
18098     const regnode *optstart= NULL;
18099
18100     RXi_GET_DECL(r,ri);
18101     GET_RE_DEBUG_FLAGS_DECL;
18102
18103     PERL_ARGS_ASSERT_DUMPUNTIL;
18104
18105 #ifdef DEBUG_DUMPUNTIL
18106     PerlIO_printf(Perl_debug_log, "--- %d : %d - %d - %d\n",indent,node-start,
18107         last ? last-start : 0,plast ? plast-start : 0);
18108 #endif
18109
18110     if (plast && plast < last)
18111         last= plast;
18112
18113     while (PL_regkind[op] != END && (!last || node < last)) {
18114         assert(node);
18115         /* While that wasn't END last time... */
18116         NODE_ALIGN(node);
18117         op = OP(node);
18118         if (op == CLOSE || op == WHILEM)
18119             indent--;
18120         next = regnext((regnode *)node);
18121
18122         /* Where, what. */
18123         if (OP(node) == OPTIMIZED) {
18124             if (!optstart && RE_DEBUG_FLAG(RE_DEBUG_COMPILE_OPTIMISE))
18125                 optstart = node;
18126             else
18127                 goto after_print;
18128         } else
18129             CLEAR_OPTSTART;
18130
18131         regprop(r, sv, node, NULL, NULL);
18132         PerlIO_printf(Perl_debug_log, "%4"IVdf":%*s%s", (IV)(node - start),
18133                       (int)(2*indent + 1), "", SvPVX_const(sv));
18134
18135         if (OP(node) != OPTIMIZED) {
18136             if (next == NULL)           /* Next ptr. */
18137                 PerlIO_printf(Perl_debug_log, " (0)");
18138             else if (PL_regkind[(U8)op] == BRANCH
18139                      && PL_regkind[OP(next)] != BRANCH )
18140                 PerlIO_printf(Perl_debug_log, " (FAIL)");
18141             else
18142                 PerlIO_printf(Perl_debug_log, " (%"IVdf")", (IV)(next - start));
18143             (void)PerlIO_putc(Perl_debug_log, '\n');
18144         }
18145
18146       after_print:
18147         if (PL_regkind[(U8)op] == BRANCHJ) {
18148             assert(next);
18149             {
18150                 const regnode *nnode = (OP(next) == LONGJMP
18151                                        ? regnext((regnode *)next)
18152                                        : next);
18153                 if (last && nnode > last)
18154                     nnode = last;
18155                 DUMPUNTIL(NEXTOPER(NEXTOPER(node)), nnode);
18156             }
18157         }
18158         else if (PL_regkind[(U8)op] == BRANCH) {
18159             assert(next);
18160             DUMPUNTIL(NEXTOPER(node), next);
18161         }
18162         else if ( PL_regkind[(U8)op]  == TRIE ) {
18163             const regnode *this_trie = node;
18164             const char op = OP(node);
18165             const U32 n = ARG(node);
18166             const reg_ac_data * const ac = op>=AHOCORASICK ?
18167                (reg_ac_data *)ri->data->data[n] :
18168                NULL;
18169             const reg_trie_data * const trie =
18170                 (reg_trie_data*)ri->data->data[op<AHOCORASICK ? n : ac->trie];
18171 #ifdef DEBUGGING
18172             AV *const trie_words
18173                            = MUTABLE_AV(ri->data->data[n + TRIE_WORDS_OFFSET]);
18174 #endif
18175             const regnode *nextbranch= NULL;
18176             I32 word_idx;
18177             sv_setpvs(sv, "");
18178             for (word_idx= 0; word_idx < (I32)trie->wordcount; word_idx++) {
18179                 SV ** const elem_ptr = av_fetch(trie_words,word_idx,0);
18180
18181                 PerlIO_printf(Perl_debug_log, "%*s%s ",
18182                    (int)(2*(indent+3)), "",
18183                     elem_ptr
18184                     ? pv_pretty(sv, SvPV_nolen_const(*elem_ptr),
18185                                 SvCUR(*elem_ptr), 60,
18186                                 PL_colors[0], PL_colors[1],
18187                                 (SvUTF8(*elem_ptr)
18188                                  ? PERL_PV_ESCAPE_UNI
18189                                  : 0)
18190                                 | PERL_PV_PRETTY_ELLIPSES
18191                                 | PERL_PV_PRETTY_LTGT
18192                             )
18193                     : "???"
18194                 );
18195                 if (trie->jump) {
18196                     U16 dist= trie->jump[word_idx+1];
18197                     PerlIO_printf(Perl_debug_log, "(%"UVuf")\n",
18198                                (UV)((dist ? this_trie + dist : next) - start));
18199                     if (dist) {
18200                         if (!nextbranch)
18201                             nextbranch= this_trie + trie->jump[0];
18202                         DUMPUNTIL(this_trie + dist, nextbranch);
18203                     }
18204                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
18205                         nextbranch= regnext((regnode *)nextbranch);
18206                 } else {
18207                     PerlIO_printf(Perl_debug_log, "\n");
18208                 }
18209             }
18210             if (last && next > last)
18211                 node= last;
18212             else
18213                 node= next;
18214         }
18215         else if ( op == CURLY ) {   /* "next" might be very big: optimizer */
18216             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS,
18217                     NEXTOPER(node) + EXTRA_STEP_2ARGS + 1);
18218         }
18219         else if (PL_regkind[(U8)op] == CURLY && op != CURLYX) {
18220             assert(next);
18221             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS, next);
18222         }
18223         else if ( op == PLUS || op == STAR) {
18224             DUMPUNTIL(NEXTOPER(node), NEXTOPER(node) + 1);
18225         }
18226         else if (PL_regkind[(U8)op] == ANYOF) {
18227             /* arglen 1 + class block */
18228             node += 1 + ((ANYOF_FLAGS(node) & ANYOF_MATCHES_POSIXL)
18229                           ? ANYOF_POSIXL_SKIP
18230                           : ANYOF_SKIP);
18231             node = NEXTOPER(node);
18232         }
18233         else if (PL_regkind[(U8)op] == EXACT) {
18234             /* Literal string, where present. */
18235             node += NODE_SZ_STR(node) - 1;
18236             node = NEXTOPER(node);
18237         }
18238         else {
18239             node = NEXTOPER(node);
18240             node += regarglen[(U8)op];
18241         }
18242         if (op == CURLYX || op == OPEN)
18243             indent++;
18244     }
18245     CLEAR_OPTSTART;
18246 #ifdef DEBUG_DUMPUNTIL
18247     PerlIO_printf(Perl_debug_log, "--- %d\n", (int)indent);
18248 #endif
18249     return node;
18250 }
18251
18252 #endif  /* DEBUGGING */
18253
18254 /*
18255  * ex: set ts=8 sts=4 sw=4 et:
18256  */