This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta b3893bfa90e8810497e2f81458a5a46db611cadf
[perl5.git] / regcomp.c
1 /*    regcomp.c
2  */
3
4 /*
5  * 'A fair jaw-cracker dwarf-language must be.'            --Samwise Gamgee
6  *
7  *     [p.285 of _The Lord of the Rings_, II/iii: "The Ring Goes South"]
8  */
9
10 /* This file contains functions for compiling a regular expression.  See
11  * also regexec.c which funnily enough, contains functions for executing
12  * a regular expression.
13  *
14  * This file is also copied at build time to ext/re/re_comp.c, where
15  * it's built with -DPERL_EXT_RE_BUILD -DPERL_EXT_RE_DEBUG -DPERL_EXT.
16  * This causes the main functions to be compiled under new names and with
17  * debugging support added, which makes "use re 'debug'" work.
18  */
19
20 /* NOTE: this is derived from Henry Spencer's regexp code, and should not
21  * confused with the original package (see point 3 below).  Thanks, Henry!
22  */
23
24 /* Additional note: this code is very heavily munged from Henry's version
25  * in places.  In some spots I've traded clarity for efficiency, so don't
26  * blame Henry for some of the lack of readability.
27  */
28
29 /* The names of the functions have been changed from regcomp and
30  * regexec to pregcomp and pregexec in order to avoid conflicts
31  * with the POSIX routines of the same names.
32 */
33
34 #ifdef PERL_EXT_RE_BUILD
35 #include "re_top.h"
36 #endif
37
38 /*
39  * pregcomp and pregexec -- regsub and regerror are not used in perl
40  *
41  *      Copyright (c) 1986 by University of Toronto.
42  *      Written by Henry Spencer.  Not derived from licensed software.
43  *
44  *      Permission is granted to anyone to use this software for any
45  *      purpose on any computer system, and to redistribute it freely,
46  *      subject to the following restrictions:
47  *
48  *      1. The author is not responsible for the consequences of use of
49  *              this software, no matter how awful, even if they arise
50  *              from defects in it.
51  *
52  *      2. The origin of this software must not be misrepresented, either
53  *              by explicit claim or by omission.
54  *
55  *      3. Altered versions must be plainly marked as such, and must not
56  *              be misrepresented as being the original software.
57  *
58  *
59  ****    Alterations to Henry's code are...
60  ****
61  ****    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
62  ****    2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
63  ****    by Larry Wall and others
64  ****
65  ****    You may distribute under the terms of either the GNU General Public
66  ****    License or the Artistic License, as specified in the README file.
67
68  *
69  * Beware that some of this code is subtly aware of the way operator
70  * precedence is structured in regular expressions.  Serious changes in
71  * regular-expression syntax might require a total rethink.
72  */
73 #include "EXTERN.h"
74 #define PERL_IN_REGCOMP_C
75 #include "perl.h"
76
77 #ifndef PERL_IN_XSUB_RE
78 #  include "INTERN.h"
79 #endif
80
81 #define REG_COMP_C
82 #ifdef PERL_IN_XSUB_RE
83 #  include "re_comp.h"
84 EXTERN_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 /* this is a chain of data about sub patterns we are processing that
105    need to be handled separately/specially in study_chunk. Its so
106    we can simulate recursion without losing state.  */
107 struct scan_frame;
108 typedef struct scan_frame {
109     regnode *last_regnode;      /* last node to process in this frame */
110     regnode *next_regnode;      /* next node to process when last is reached */
111     U32 prev_recursed_depth;
112     I32 stopparen;              /* what stopparen do we use */
113
114     struct scan_frame *this_prev_frame; /* this previous frame */
115     struct scan_frame *prev_frame;      /* previous frame */
116     struct scan_frame *next_frame;      /* next frame */
117 } scan_frame;
118
119 /* Certain characters are output as a sequence with the first being a
120  * backslash. */
121 #define isBACKSLASHED_PUNCT(c)  strchr("-[]\\^", c)
122
123
124 struct RExC_state_t {
125     U32         flags;                  /* RXf_* are we folding, multilining? */
126     U32         pm_flags;               /* PMf_* stuff from the calling PMOP */
127     char        *precomp;               /* uncompiled string. */
128     char        *precomp_end;           /* pointer to end of uncompiled string. */
129     REGEXP      *rx_sv;                 /* The SV that is the regexp. */
130     regexp      *rx;                    /* perl core regexp structure */
131     regexp_internal     *rxi;           /* internal data for regexp object
132                                            pprivate field */
133     char        *start;                 /* Start of input for compile */
134     char        *end;                   /* End of input for compile */
135     char        *parse;                 /* Input-scan pointer. */
136     char        *adjusted_start;        /* 'start', adjusted.  See code use */
137     STRLEN      precomp_adj;            /* an offset beyond precomp.  See code use */
138     SSize_t     whilem_seen;            /* number of WHILEM in this expr */
139     regnode     *emit_start;            /* Start of emitted-code area */
140     regnode     *emit_bound;            /* First regnode outside of the
141                                            allocated space */
142     regnode     *emit;                  /* Code-emit pointer; if = &emit_dummy,
143                                            implies compiling, so don't emit */
144     regnode_ssc emit_dummy;             /* placeholder for emit to point to;
145                                            large enough for the largest
146                                            non-EXACTish node, so can use it as
147                                            scratch in pass1 */
148     I32         naughty;                /* How bad is this pattern? */
149     I32         sawback;                /* Did we see \1, ...? */
150     U32         seen;
151     SSize_t     size;                   /* Code size. */
152     I32                npar;            /* Capture buffer count, (OPEN) plus
153                                            one. ("par" 0 is the whole
154                                            pattern)*/
155     I32         nestroot;               /* root parens we are in - used by
156                                            accept */
157     I32         extralen;
158     I32         seen_zerolen;
159     regnode     **open_parens;          /* pointers to open parens */
160     regnode     **close_parens;         /* pointers to close parens */
161     regnode     *end_op;                /* END node in program */
162     I32         utf8;           /* whether the pattern is utf8 or not */
163     I32         orig_utf8;      /* whether the pattern was originally in utf8 */
164                                 /* XXX use this for future optimisation of case
165                                  * where pattern must be upgraded to utf8. */
166     I32         uni_semantics;  /* If a d charset modifier should use unicode
167                                    rules, even if the pattern is not in
168                                    utf8 */
169     HV          *paren_names;           /* Paren names */
170
171     regnode     **recurse;              /* Recurse regops */
172     I32                recurse_count;                /* Number of recurse regops we have generated */
173     U8          *study_chunk_recursed;  /* bitmap of which subs we have moved
174                                            through */
175     U32         study_chunk_recursed_bytes;  /* bytes in bitmap */
176     I32         in_lookbehind;
177     I32         contains_locale;
178     I32         override_recoding;
179 #ifdef EBCDIC
180     I32         recode_x_to_native;
181 #endif
182     I32         in_multi_char_class;
183     struct reg_code_blocks *code_blocks;/* positions of literal (?{})
184                                             within pattern */
185     int         code_index;             /* next code_blocks[] slot */
186     SSize_t     maxlen;                        /* mininum possible number of chars in string to match */
187     scan_frame *frame_head;
188     scan_frame *frame_last;
189     U32         frame_count;
190     AV         *warn_text;
191 #ifdef ADD_TO_REGEXEC
192     char        *starttry;              /* -Dr: where regtry was called. */
193 #define RExC_starttry   (pRExC_state->starttry)
194 #endif
195     SV          *runtime_code_qr;       /* qr with the runtime code blocks */
196 #ifdef DEBUGGING
197     const char  *lastparse;
198     I32         lastnum;
199     AV          *paren_name_list;       /* idx -> name */
200     U32         study_chunk_recursed_count;
201     SV          *mysv1;
202     SV          *mysv2;
203 #define RExC_lastparse  (pRExC_state->lastparse)
204 #define RExC_lastnum    (pRExC_state->lastnum)
205 #define RExC_paren_name_list    (pRExC_state->paren_name_list)
206 #define RExC_study_chunk_recursed_count    (pRExC_state->study_chunk_recursed_count)
207 #define RExC_mysv       (pRExC_state->mysv1)
208 #define RExC_mysv1      (pRExC_state->mysv1)
209 #define RExC_mysv2      (pRExC_state->mysv2)
210
211 #endif
212     bool        seen_unfolded_sharp_s;
213     bool        strict;
214     bool        study_started;
215 };
216
217 #define RExC_flags      (pRExC_state->flags)
218 #define RExC_pm_flags   (pRExC_state->pm_flags)
219 #define RExC_precomp    (pRExC_state->precomp)
220 #define RExC_precomp_adj (pRExC_state->precomp_adj)
221 #define RExC_adjusted_start  (pRExC_state->adjusted_start)
222 #define RExC_precomp_end (pRExC_state->precomp_end)
223 #define RExC_rx_sv      (pRExC_state->rx_sv)
224 #define RExC_rx         (pRExC_state->rx)
225 #define RExC_rxi        (pRExC_state->rxi)
226 #define RExC_start      (pRExC_state->start)
227 #define RExC_end        (pRExC_state->end)
228 #define RExC_parse      (pRExC_state->parse)
229 #define RExC_whilem_seen        (pRExC_state->whilem_seen)
230
231 /* Set during the sizing pass when there is a LATIN SMALL LETTER SHARP S in any
232  * EXACTF node, hence was parsed under /di rules.  If later in the parse,
233  * something forces the pattern into using /ui rules, the sharp s should be
234  * folded into the sequence 'ss', which takes up more space than previously
235  * calculated.  This means that the sizing pass needs to be restarted.  (The
236  * node also becomes an EXACTFU_SS.)  For all other characters, an EXACTF node
237  * that gets converted to /ui (and EXACTFU) occupies the same amount of space,
238  * so there is no need to resize [perl #125990]. */
239 #define RExC_seen_unfolded_sharp_s (pRExC_state->seen_unfolded_sharp_s)
240
241 #ifdef RE_TRACK_PATTERN_OFFSETS
242 #define RExC_offsets    (pRExC_state->rxi->u.offsets) /* I am not like the
243                                                          others */
244 #endif
245 #define RExC_emit       (pRExC_state->emit)
246 #define RExC_emit_dummy (pRExC_state->emit_dummy)
247 #define RExC_emit_start (pRExC_state->emit_start)
248 #define RExC_emit_bound (pRExC_state->emit_bound)
249 #define RExC_sawback    (pRExC_state->sawback)
250 #define RExC_seen       (pRExC_state->seen)
251 #define RExC_size       (pRExC_state->size)
252 #define RExC_maxlen        (pRExC_state->maxlen)
253 #define RExC_npar       (pRExC_state->npar)
254 #define RExC_nestroot   (pRExC_state->nestroot)
255 #define RExC_extralen   (pRExC_state->extralen)
256 #define RExC_seen_zerolen       (pRExC_state->seen_zerolen)
257 #define RExC_utf8       (pRExC_state->utf8)
258 #define RExC_uni_semantics      (pRExC_state->uni_semantics)
259 #define RExC_orig_utf8  (pRExC_state->orig_utf8)
260 #define RExC_open_parens        (pRExC_state->open_parens)
261 #define RExC_close_parens       (pRExC_state->close_parens)
262 #define RExC_end_op     (pRExC_state->end_op)
263 #define RExC_paren_names        (pRExC_state->paren_names)
264 #define RExC_recurse    (pRExC_state->recurse)
265 #define RExC_recurse_count      (pRExC_state->recurse_count)
266 #define RExC_study_chunk_recursed        (pRExC_state->study_chunk_recursed)
267 #define RExC_study_chunk_recursed_bytes  \
268                                    (pRExC_state->study_chunk_recursed_bytes)
269 #define RExC_in_lookbehind      (pRExC_state->in_lookbehind)
270 #define RExC_contains_locale    (pRExC_state->contains_locale)
271 #ifdef EBCDIC
272 #   define RExC_recode_x_to_native (pRExC_state->recode_x_to_native)
273 #endif
274 #define RExC_in_multi_char_class (pRExC_state->in_multi_char_class)
275 #define RExC_frame_head (pRExC_state->frame_head)
276 #define RExC_frame_last (pRExC_state->frame_last)
277 #define RExC_frame_count (pRExC_state->frame_count)
278 #define RExC_strict (pRExC_state->strict)
279 #define RExC_study_started      (pRExC_state->study_started)
280 #define RExC_warn_text (pRExC_state->warn_text)
281
282 /* Heuristic check on the complexity of the pattern: if TOO_NAUGHTY, we set
283  * a flag to disable back-off on the fixed/floating substrings - if it's
284  * a high complexity pattern we assume the benefit of avoiding a full match
285  * is worth the cost of checking for the substrings even if they rarely help.
286  */
287 #define RExC_naughty    (pRExC_state->naughty)
288 #define TOO_NAUGHTY (10)
289 #define MARK_NAUGHTY(add) \
290     if (RExC_naughty < TOO_NAUGHTY) \
291         RExC_naughty += (add)
292 #define MARK_NAUGHTY_EXP(exp, add) \
293     if (RExC_naughty < TOO_NAUGHTY) \
294         RExC_naughty += RExC_naughty / (exp) + (add)
295
296 #define ISMULT1(c)      ((c) == '*' || (c) == '+' || (c) == '?')
297 #define ISMULT2(s)      ((*s) == '*' || (*s) == '+' || (*s) == '?' || \
298         ((*s) == '{' && regcurly(s)))
299
300 /*
301  * Flags to be passed up and down.
302  */
303 #define WORST           0       /* Worst case. */
304 #define HASWIDTH        0x01    /* Known to match non-null strings. */
305
306 /* Simple enough to be STAR/PLUS operand; in an EXACTish node must be a single
307  * character.  (There needs to be a case: in the switch statement in regexec.c
308  * for any node marked SIMPLE.)  Note that this is not the same thing as
309  * REGNODE_SIMPLE */
310 #define SIMPLE          0x02
311 #define SPSTART         0x04    /* Starts with * or + */
312 #define POSTPONED       0x08    /* (?1),(?&name), (??{...}) or similar */
313 #define TRYAGAIN        0x10    /* Weeded out a declaration. */
314 #define RESTART_PASS1   0x20    /* Need to restart sizing pass */
315 #define NEED_UTF8       0x40    /* In conjunction with RESTART_PASS1, need to
316                                    calcuate sizes as UTF-8 */
317
318 #define REG_NODE_NUM(x) ((x) ? (int)((x)-RExC_emit_start) : -1)
319
320 /* whether trie related optimizations are enabled */
321 #if PERL_ENABLE_EXTENDED_TRIE_OPTIMISATION
322 #define TRIE_STUDY_OPT
323 #define FULL_TRIE_STUDY
324 #define TRIE_STCLASS
325 #endif
326
327
328
329 #define PBYTE(u8str,paren) ((U8*)(u8str))[(paren) >> 3]
330 #define PBITVAL(paren) (1 << ((paren) & 7))
331 #define PAREN_TEST(u8str,paren) ( PBYTE(u8str,paren) & PBITVAL(paren))
332 #define PAREN_SET(u8str,paren) PBYTE(u8str,paren) |= PBITVAL(paren)
333 #define PAREN_UNSET(u8str,paren) PBYTE(u8str,paren) &= (~PBITVAL(paren))
334
335 #define REQUIRE_UTF8(flagp) STMT_START {                                   \
336                                      if (!UTF) {                           \
337                                          assert(PASS1);                    \
338                                          *flagp = RESTART_PASS1|NEED_UTF8; \
339                                          return NULL;                      \
340                                      }                                     \
341                              } STMT_END
342
343 /* Change from /d into /u rules, and restart the parse if we've already seen
344  * something whose size would increase as a result, by setting *flagp and
345  * returning 'restart_retval'.  RExC_uni_semantics is a flag that indicates
346  * we've change to /u during the parse.  */
347 #define REQUIRE_UNI_RULES(flagp, restart_retval)                            \
348     STMT_START {                                                            \
349             if (DEPENDS_SEMANTICS) {                                        \
350                 assert(PASS1);                                              \
351                 set_regex_charset(&RExC_flags, REGEX_UNICODE_CHARSET);      \
352                 RExC_uni_semantics = 1;                                     \
353                 if (RExC_seen_unfolded_sharp_s) {                           \
354                     *flagp |= RESTART_PASS1;                                \
355                     return restart_retval;                                  \
356                 }                                                           \
357             }                                                               \
358     } STMT_END
359
360 /* This converts the named class defined in regcomp.h to its equivalent class
361  * number defined in handy.h. */
362 #define namedclass_to_classnum(class)  ((int) ((class) / 2))
363 #define classnum_to_namedclass(classnum)  ((classnum) * 2)
364
365 #define _invlist_union_complement_2nd(a, b, output) \
366                         _invlist_union_maybe_complement_2nd(a, b, TRUE, output)
367 #define _invlist_intersection_complement_2nd(a, b, output) \
368                  _invlist_intersection_maybe_complement_2nd(a, b, TRUE, output)
369
370 /* About scan_data_t.
371
372   During optimisation we recurse through the regexp program performing
373   various inplace (keyhole style) optimisations. In addition study_chunk
374   and scan_commit populate this data structure with information about
375   what strings MUST appear in the pattern. We look for the longest
376   string that must appear at a fixed location, and we look for the
377   longest string that may appear at a floating location. So for instance
378   in the pattern:
379
380     /FOO[xX]A.*B[xX]BAR/
381
382   Both 'FOO' and 'A' are fixed strings. Both 'B' and 'BAR' are floating
383   strings (because they follow a .* construct). study_chunk will identify
384   both FOO and BAR as being the longest fixed and floating strings respectively.
385
386   The strings can be composites, for instance
387
388      /(f)(o)(o)/
389
390   will result in a composite fixed substring 'foo'.
391
392   For each string some basic information is maintained:
393
394   - min_offset
395     This is the position the string must appear at, or not before.
396     It also implicitly (when combined with minlenp) tells us how many
397     characters must match before the string we are searching for.
398     Likewise when combined with minlenp and the length of the string it
399     tells us how many characters must appear after the string we have
400     found.
401
402   - max_offset
403     Only used for floating strings. This is the rightmost point that
404     the string can appear at. If set to SSize_t_MAX it indicates that the
405     string can occur infinitely far to the right.
406     For fixed strings, it is equal to min_offset.
407
408   - minlenp
409     A pointer to the minimum number of characters of the pattern that the
410     string was found inside. This is important as in the case of positive
411     lookahead or positive lookbehind we can have multiple patterns
412     involved. Consider
413
414     /(?=FOO).*F/
415
416     The minimum length of the pattern overall is 3, the minimum length
417     of the lookahead part is 3, but the minimum length of the part that
418     will actually match is 1. So 'FOO's minimum length is 3, but the
419     minimum length for the F is 1. This is important as the minimum length
420     is used to determine offsets in front of and behind the string being
421     looked for.  Since strings can be composites this is the length of the
422     pattern at the time it was committed with a scan_commit. Note that
423     the length is calculated by study_chunk, so that the minimum lengths
424     are not known until the full pattern has been compiled, thus the
425     pointer to the value.
426
427   - lookbehind
428
429     In the case of lookbehind the string being searched for can be
430     offset past the start point of the final matching string.
431     If this value was just blithely removed from the min_offset it would
432     invalidate some of the calculations for how many chars must match
433     before or after (as they are derived from min_offset and minlen and
434     the length of the string being searched for).
435     When the final pattern is compiled and the data is moved from the
436     scan_data_t structure into the regexp structure the information
437     about lookbehind is factored in, with the information that would
438     have been lost precalculated in the end_shift field for the
439     associated string.
440
441   The fields pos_min and pos_delta are used to store the minimum offset
442   and the delta to the maximum offset at the current point in the pattern.
443
444 */
445
446 struct scan_data_substrs {
447     SV      *str;       /* longest substring found in pattern */
448     SSize_t min_offset; /* earliest point in string it can appear */
449     SSize_t max_offset; /* latest point in string it can appear */
450     SSize_t *minlenp;   /* pointer to the minlen relevant to the string */
451     SSize_t lookbehind; /* is the pos of the string modified by LB */
452     I32 flags;          /* per substring SF_* and SCF_* flags */
453 };
454
455 typedef struct scan_data_t {
456     /*I32 len_min;      unused */
457     /*I32 len_delta;    unused */
458     SSize_t pos_min;
459     SSize_t pos_delta;
460     SV *last_found;
461     SSize_t last_end;       /* min value, <0 unless valid. */
462     SSize_t last_start_min;
463     SSize_t last_start_max;
464     U8      cur_is_floating; /* whether the last_* values should be set as
465                               * the next fixed (0) or floating (1)
466                               * substring */
467
468     /* [0] is longest fixed substring so far, [1] is longest float so far */
469     struct scan_data_substrs  substrs[2];
470
471     I32 flags;             /* common SF_* and SCF_* flags */
472     I32 whilem_c;
473     SSize_t *last_closep;
474     regnode_ssc *start_class;
475 } scan_data_t;
476
477 /*
478  * Forward declarations for pregcomp()'s friends.
479  */
480
481 static const scan_data_t zero_scan_data = {
482     0, 0, NULL, 0, 0, 0, 0,
483     {
484         { NULL, 0, 0, 0, 0, 0 },
485         { NULL, 0, 0, 0, 0, 0 },
486     },
487     0, 0, NULL, NULL
488 };
489
490 /* study flags */
491
492 #define SF_BEFORE_SEOL          0x0001
493 #define SF_BEFORE_MEOL          0x0002
494 #define SF_BEFORE_EOL           (SF_BEFORE_SEOL|SF_BEFORE_MEOL)
495
496 #define SF_IS_INF               0x0040
497 #define SF_HAS_PAR              0x0080
498 #define SF_IN_PAR               0x0100
499 #define SF_HAS_EVAL             0x0200
500
501
502 /* SCF_DO_SUBSTR is the flag that tells the regexp analyzer to track the
503  * longest substring in the pattern. When it is not set the optimiser keeps
504  * track of position, but does not keep track of the actual strings seen,
505  *
506  * So for instance /foo/ will be parsed with SCF_DO_SUBSTR being true, but
507  * /foo/i will not.
508  *
509  * Similarly, /foo.*(blah|erm|huh).*fnorble/ will have "foo" and "fnorble"
510  * parsed with SCF_DO_SUBSTR on, but while processing the (...) it will be
511  * turned off because of the alternation (BRANCH). */
512 #define SCF_DO_SUBSTR           0x0400
513
514 #define SCF_DO_STCLASS_AND      0x0800
515 #define SCF_DO_STCLASS_OR       0x1000
516 #define SCF_DO_STCLASS          (SCF_DO_STCLASS_AND|SCF_DO_STCLASS_OR)
517 #define SCF_WHILEM_VISITED_POS  0x2000
518
519 #define SCF_TRIE_RESTUDY        0x4000 /* Do restudy? */
520 #define SCF_SEEN_ACCEPT         0x8000
521 #define SCF_TRIE_DOING_RESTUDY 0x10000
522 #define SCF_IN_DEFINE          0x20000
523
524
525
526
527 #define UTF cBOOL(RExC_utf8)
528
529 /* The enums for all these are ordered so things work out correctly */
530 #define LOC (get_regex_charset(RExC_flags) == REGEX_LOCALE_CHARSET)
531 #define DEPENDS_SEMANTICS (get_regex_charset(RExC_flags)                    \
532                                                      == REGEX_DEPENDS_CHARSET)
533 #define UNI_SEMANTICS (get_regex_charset(RExC_flags) == REGEX_UNICODE_CHARSET)
534 #define AT_LEAST_UNI_SEMANTICS (get_regex_charset(RExC_flags)                \
535                                                      >= REGEX_UNICODE_CHARSET)
536 #define ASCII_RESTRICTED (get_regex_charset(RExC_flags)                      \
537                                             == REGEX_ASCII_RESTRICTED_CHARSET)
538 #define AT_LEAST_ASCII_RESTRICTED (get_regex_charset(RExC_flags)             \
539                                             >= REGEX_ASCII_RESTRICTED_CHARSET)
540 #define ASCII_FOLD_RESTRICTED (get_regex_charset(RExC_flags)                 \
541                                         == REGEX_ASCII_MORE_RESTRICTED_CHARSET)
542
543 #define FOLD cBOOL(RExC_flags & RXf_PMf_FOLD)
544
545 /* For programs that want to be strictly Unicode compatible by dying if any
546  * attempt is made to match a non-Unicode code point against a Unicode
547  * property.  */
548 #define ALWAYS_WARN_SUPER  ckDEAD(packWARN(WARN_NON_UNICODE))
549
550 #define OOB_NAMEDCLASS          -1
551
552 /* There is no code point that is out-of-bounds, so this is problematic.  But
553  * its only current use is to initialize a variable that is always set before
554  * looked at. */
555 #define OOB_UNICODE             0xDEADBEEF
556
557 #define CHR_SVLEN(sv) (UTF ? sv_len_utf8(sv) : SvCUR(sv))
558
559
560 /* length of regex to show in messages that don't mark a position within */
561 #define RegexLengthToShowInErrorMessages 127
562
563 /*
564  * If MARKER[12] are adjusted, be sure to adjust the constants at the top
565  * of t/op/regmesg.t, the tests in t/op/re_tests, and those in
566  * op/pragma/warn/regcomp.
567  */
568 #define MARKER1 "<-- HERE"    /* marker as it appears in the description */
569 #define MARKER2 " <-- HERE "  /* marker as it appears within the regex */
570
571 #define REPORT_LOCATION " in regex; marked by " MARKER1    \
572                         " in m/%" UTF8f MARKER2 "%" UTF8f "/"
573
574 /* The code in this file in places uses one level of recursion with parsing
575  * rebased to an alternate string constructed by us in memory.  This can take
576  * the form of something that is completely different from the input, or
577  * something that uses the input as part of the alternate.  In the first case,
578  * there should be no possibility of an error, as we are in complete control of
579  * the alternate string.  But in the second case we don't control the input
580  * portion, so there may be errors in that.  Here's an example:
581  *      /[abc\x{DF}def]/ui
582  * is handled specially because \x{df} folds to a sequence of more than one
583  * character, 'ss'.  What is done is to create and parse an alternate string,
584  * which looks like this:
585  *      /(?:\x{DF}|[abc\x{DF}def])/ui
586  * where it uses the input unchanged in the middle of something it constructs,
587  * which is a branch for the DF outside the character class, and clustering
588  * parens around the whole thing. (It knows enough to skip the DF inside the
589  * class while in this substitute parse.) 'abc' and 'def' may have errors that
590  * need to be reported.  The general situation looks like this:
591  *
592  *              sI                       tI               xI       eI
593  * Input:       ----------------------------------------------------
594  * Constructed:         ---------------------------------------------------
595  *                      sC               tC               xC       eC     EC
596  *
597  * The input string sI..eI is the input pattern.  The string sC..EC is the
598  * constructed substitute parse string.  The portions sC..tC and eC..EC are
599  * constructed by us.  The portion tC..eC is an exact duplicate of the input
600  * pattern tI..eI.  In the diagram, these are vertically aligned.  Suppose that
601  * while parsing, we find an error at xC.  We want to display a message showing
602  * the real input string.  Thus we need to find the point xI in it which
603  * corresponds to xC.  xC >= tC, since the portion of the string sC..tC has
604  * been constructed by us, and so shouldn't have errors.  We get:
605  *
606  *      xI = sI + (tI - sI) + (xC - tC)
607  *
608  * and, the offset into sI is:
609  *
610  *      (xI - sI) = (tI - sI) + (xC - tC)
611  *
612  * When the substitute is constructed, we save (tI -sI) as RExC_precomp_adj,
613  * and we save tC as RExC_adjusted_start.
614  *
615  * During normal processing of the input pattern, everything points to that,
616  * with RExC_precomp_adj set to 0, and RExC_adjusted_start set to sI.
617  */
618
619 #define tI_sI           RExC_precomp_adj
620 #define tC              RExC_adjusted_start
621 #define sC              RExC_precomp
622 #define xI_offset(xC)   ((IV) (tI_sI + (xC - tC)))
623 #define xI(xC)          (sC + xI_offset(xC))
624 #define eC              RExC_precomp_end
625
626 #define REPORT_LOCATION_ARGS(xC)                                            \
627     UTF8fARG(UTF,                                                           \
628              (xI(xC) > eC) /* Don't run off end */                          \
629               ? eC - sC   /* Length before the <--HERE */                   \
630               : ( __ASSERT_(xI_offset(xC) >= 0) xI_offset(xC) ),            \
631              sC),         /* The input pattern printed up to the <--HERE */ \
632     UTF8fARG(UTF,                                                           \
633              (xI(xC) > eC) ? 0 : eC - xI(xC), /* Length after <--HERE */    \
634              (xI(xC) > eC) ? eC : xI(xC))     /* pattern after <--HERE */
635
636 /* Used to point after bad bytes for an error message, but avoid skipping
637  * past a nul byte. */
638 #define SKIP_IF_CHAR(s) (!*(s) ? 0 : UTF ? UTF8SKIP(s) : 1)
639
640 /*
641  * Calls SAVEDESTRUCTOR_X if needed, then calls Perl_croak with the given
642  * arg. Show regex, up to a maximum length. If it's too long, chop and add
643  * "...".
644  */
645 #define _FAIL(code) STMT_START {                                        \
646     const char *ellipses = "";                                          \
647     IV len = RExC_precomp_end - RExC_precomp;                                   \
648                                                                         \
649     if (!SIZE_ONLY)                                                     \
650         SAVEFREESV(RExC_rx_sv);                                         \
651     if (len > RegexLengthToShowInErrorMessages) {                       \
652         /* chop 10 shorter than the max, to ensure meaning of "..." */  \
653         len = RegexLengthToShowInErrorMessages - 10;                    \
654         ellipses = "...";                                               \
655     }                                                                   \
656     code;                                                               \
657 } STMT_END
658
659 #define FAIL(msg) _FAIL(                            \
660     Perl_croak(aTHX_ "%s in regex m/%" UTF8f "%s/",         \
661             msg, UTF8fARG(UTF, len, RExC_precomp), ellipses))
662
663 #define FAIL2(msg,arg) _FAIL(                       \
664     Perl_croak(aTHX_ msg " in regex m/%" UTF8f "%s/",       \
665             arg, UTF8fARG(UTF, len, RExC_precomp), ellipses))
666
667 /*
668  * Simple_vFAIL -- like FAIL, but marks the current location in the scan
669  */
670 #define Simple_vFAIL(m) STMT_START {                                    \
671     Perl_croak(aTHX_ "%s" REPORT_LOCATION,                              \
672             m, REPORT_LOCATION_ARGS(RExC_parse));                       \
673 } STMT_END
674
675 /*
676  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL()
677  */
678 #define vFAIL(m) STMT_START {                           \
679     if (!SIZE_ONLY)                                     \
680         SAVEFREESV(RExC_rx_sv);                         \
681     Simple_vFAIL(m);                                    \
682 } STMT_END
683
684 /*
685  * Like Simple_vFAIL(), but accepts two arguments.
686  */
687 #define Simple_vFAIL2(m,a1) STMT_START {                        \
688     S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1,              \
689                       REPORT_LOCATION_ARGS(RExC_parse));        \
690 } STMT_END
691
692 /*
693  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL2().
694  */
695 #define vFAIL2(m,a1) STMT_START {                       \
696     if (!SIZE_ONLY)                                     \
697         SAVEFREESV(RExC_rx_sv);                         \
698     Simple_vFAIL2(m, a1);                               \
699 } STMT_END
700
701
702 /*
703  * Like Simple_vFAIL(), but accepts three arguments.
704  */
705 #define Simple_vFAIL3(m, a1, a2) STMT_START {                   \
706     S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1, a2,          \
707             REPORT_LOCATION_ARGS(RExC_parse));                  \
708 } STMT_END
709
710 /*
711  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL3().
712  */
713 #define vFAIL3(m,a1,a2) STMT_START {                    \
714     if (!SIZE_ONLY)                                     \
715         SAVEFREESV(RExC_rx_sv);                         \
716     Simple_vFAIL3(m, a1, a2);                           \
717 } STMT_END
718
719 /*
720  * Like Simple_vFAIL(), but accepts four arguments.
721  */
722 #define Simple_vFAIL4(m, a1, a2, a3) STMT_START {               \
723     S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1, a2, a3,      \
724             REPORT_LOCATION_ARGS(RExC_parse));                  \
725 } STMT_END
726
727 #define vFAIL4(m,a1,a2,a3) STMT_START {                 \
728     if (!SIZE_ONLY)                                     \
729         SAVEFREESV(RExC_rx_sv);                         \
730     Simple_vFAIL4(m, a1, a2, a3);                       \
731 } STMT_END
732
733 /* A specialized version of vFAIL2 that works with UTF8f */
734 #define vFAIL2utf8f(m, a1) STMT_START {             \
735     if (!SIZE_ONLY)                                 \
736         SAVEFREESV(RExC_rx_sv);                     \
737     S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1,  \
738             REPORT_LOCATION_ARGS(RExC_parse));      \
739 } STMT_END
740
741 #define vFAIL3utf8f(m, a1, a2) STMT_START {             \
742     if (!SIZE_ONLY)                                     \
743         SAVEFREESV(RExC_rx_sv);                         \
744     S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1, a2,  \
745             REPORT_LOCATION_ARGS(RExC_parse));          \
746 } STMT_END
747
748 /* These have asserts in them because of [perl #122671] Many warnings in
749  * regcomp.c can occur twice.  If they get output in pass1 and later in that
750  * pass, the pattern has to be converted to UTF-8 and the pass restarted, they
751  * would get output again.  So they should be output in pass2, and these
752  * asserts make sure new warnings follow that paradigm. */
753
754 /* m is not necessarily a "literal string", in this macro */
755 #define reg_warn_non_literal_string(loc, m) STMT_START {                \
756     __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_REGEXP),           \
757                                        "%s" REPORT_LOCATION,            \
758                                   m, REPORT_LOCATION_ARGS(loc));        \
759 } STMT_END
760
761 #define ckWARNreg(loc,m) STMT_START {                                   \
762     __ASSERT_(PASS2) Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),        \
763                                           m REPORT_LOCATION,            \
764                                           REPORT_LOCATION_ARGS(loc));   \
765 } STMT_END
766
767 #define vWARN(loc, m) STMT_START {                                      \
768     __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_REGEXP),           \
769                                        m REPORT_LOCATION,               \
770                                        REPORT_LOCATION_ARGS(loc));      \
771 } STMT_END
772
773 #define vWARN_dep(loc, m) STMT_START {                                  \
774     __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_DEPRECATED),       \
775                                        m REPORT_LOCATION,               \
776                                        REPORT_LOCATION_ARGS(loc));      \
777 } STMT_END
778
779 #define ckWARNdep(loc,m) STMT_START {                                   \
780     __ASSERT_(PASS2) Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED),  \
781                                             m REPORT_LOCATION,          \
782                                             REPORT_LOCATION_ARGS(loc)); \
783 } STMT_END
784
785 #define ckWARNregdep(loc,m) STMT_START {                                    \
786     __ASSERT_(PASS2) Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED,      \
787                                                       WARN_REGEXP),         \
788                                              m REPORT_LOCATION,             \
789                                              REPORT_LOCATION_ARGS(loc));    \
790 } STMT_END
791
792 #define ckWARN2reg_d(loc,m, a1) STMT_START {                                \
793     __ASSERT_(PASS2) Perl_ck_warner_d(aTHX_ packWARN(WARN_REGEXP),          \
794                                             m REPORT_LOCATION,              \
795                                             a1, REPORT_LOCATION_ARGS(loc)); \
796 } STMT_END
797
798 #define ckWARN2reg(loc, m, a1) STMT_START {                                 \
799     __ASSERT_(PASS2) Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),            \
800                                           m REPORT_LOCATION,                \
801                                           a1, REPORT_LOCATION_ARGS(loc));   \
802 } STMT_END
803
804 #define vWARN3(loc, m, a1, a2) STMT_START {                                 \
805     __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_REGEXP),               \
806                                        m REPORT_LOCATION,                   \
807                                        a1, a2, REPORT_LOCATION_ARGS(loc));  \
808 } STMT_END
809
810 #define ckWARN3reg(loc, m, a1, a2) STMT_START {                             \
811     __ASSERT_(PASS2) Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),            \
812                                           m REPORT_LOCATION,                \
813                                           a1, a2,                           \
814                                           REPORT_LOCATION_ARGS(loc));       \
815 } STMT_END
816
817 #define vWARN4(loc, m, a1, a2, a3) STMT_START {                         \
818     __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_REGEXP),           \
819                                        m REPORT_LOCATION,               \
820                                        a1, a2, a3,                      \
821                                        REPORT_LOCATION_ARGS(loc));      \
822 } STMT_END
823
824 #define ckWARN4reg(loc, m, a1, a2, a3) STMT_START {                     \
825     __ASSERT_(PASS2) Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),        \
826                                           m REPORT_LOCATION,            \
827                                           a1, a2, a3,                   \
828                                           REPORT_LOCATION_ARGS(loc));   \
829 } STMT_END
830
831 #define vWARN5(loc, m, a1, a2, a3, a4) STMT_START {                     \
832     __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_REGEXP),           \
833                                        m REPORT_LOCATION,               \
834                                        a1, a2, a3, a4,                  \
835                                        REPORT_LOCATION_ARGS(loc));      \
836 } STMT_END
837
838 /* Macros for recording node offsets.   20001227 mjd@plover.com
839  * Nodes are numbered 1, 2, 3, 4.  Node #n's position is recorded in
840  * element 2*n-1 of the array.  Element #2n holds the byte length node #n.
841  * Element 0 holds the number n.
842  * Position is 1 indexed.
843  */
844 #ifndef RE_TRACK_PATTERN_OFFSETS
845 #define Set_Node_Offset_To_R(node,byte)
846 #define Set_Node_Offset(node,byte)
847 #define Set_Cur_Node_Offset
848 #define Set_Node_Length_To_R(node,len)
849 #define Set_Node_Length(node,len)
850 #define Set_Node_Cur_Length(node,start)
851 #define Node_Offset(n)
852 #define Node_Length(n)
853 #define Set_Node_Offset_Length(node,offset,len)
854 #define ProgLen(ri) ri->u.proglen
855 #define SetProgLen(ri,x) ri->u.proglen = x
856 #else
857 #define ProgLen(ri) ri->u.offsets[0]
858 #define SetProgLen(ri,x) ri->u.offsets[0] = x
859 #define Set_Node_Offset_To_R(node,byte) STMT_START {                    \
860     if (! SIZE_ONLY) {                                                  \
861         MJD_OFFSET_DEBUG(("** (%d) offset of node %d is %d.\n",         \
862                     __LINE__, (int)(node), (int)(byte)));               \
863         if((node) < 0) {                                                \
864             Perl_croak(aTHX_ "value of node is %d in Offset macro",     \
865                                          (int)(node));                  \
866         } else {                                                        \
867             RExC_offsets[2*(node)-1] = (byte);                          \
868         }                                                               \
869     }                                                                   \
870 } STMT_END
871
872 #define Set_Node_Offset(node,byte) \
873     Set_Node_Offset_To_R((node)-RExC_emit_start, (byte)-RExC_start)
874 #define Set_Cur_Node_Offset Set_Node_Offset(RExC_emit, RExC_parse)
875
876 #define Set_Node_Length_To_R(node,len) STMT_START {                     \
877     if (! SIZE_ONLY) {                                                  \
878         MJD_OFFSET_DEBUG(("** (%d) size of node %d is %d.\n",           \
879                 __LINE__, (int)(node), (int)(len)));                    \
880         if((node) < 0) {                                                \
881             Perl_croak(aTHX_ "value of node is %d in Length macro",     \
882                                          (int)(node));                  \
883         } else {                                                        \
884             RExC_offsets[2*(node)] = (len);                             \
885         }                                                               \
886     }                                                                   \
887 } STMT_END
888
889 #define Set_Node_Length(node,len) \
890     Set_Node_Length_To_R((node)-RExC_emit_start, len)
891 #define Set_Node_Cur_Length(node, start)                \
892     Set_Node_Length(node, RExC_parse - start)
893
894 /* Get offsets and lengths */
895 #define Node_Offset(n) (RExC_offsets[2*((n)-RExC_emit_start)-1])
896 #define Node_Length(n) (RExC_offsets[2*((n)-RExC_emit_start)])
897
898 #define Set_Node_Offset_Length(node,offset,len) STMT_START {    \
899     Set_Node_Offset_To_R((node)-RExC_emit_start, (offset));     \
900     Set_Node_Length_To_R((node)-RExC_emit_start, (len));        \
901 } STMT_END
902 #endif
903
904 #if PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS
905 #define EXPERIMENTAL_INPLACESCAN
906 #endif /*PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS*/
907
908 #ifdef DEBUGGING
909 int
910 Perl_re_printf(pTHX_ const char *fmt, ...)
911 {
912     va_list ap;
913     int result;
914     PerlIO *f= Perl_debug_log;
915     PERL_ARGS_ASSERT_RE_PRINTF;
916     va_start(ap, fmt);
917     result = PerlIO_vprintf(f, fmt, ap);
918     va_end(ap);
919     return result;
920 }
921
922 int
923 Perl_re_indentf(pTHX_ const char *fmt, U32 depth, ...)
924 {
925     va_list ap;
926     int result;
927     PerlIO *f= Perl_debug_log;
928     PERL_ARGS_ASSERT_RE_INDENTF;
929     va_start(ap, depth);
930     PerlIO_printf(f, "%*s", ( (int)depth % 20 ) * 2, "");
931     result = PerlIO_vprintf(f, fmt, ap);
932     va_end(ap);
933     return result;
934 }
935 #endif /* DEBUGGING */
936
937 #define DEBUG_RExC_seen()                                                   \
938         DEBUG_OPTIMISE_MORE_r({                                             \
939             Perl_re_printf( aTHX_ "RExC_seen: ");                                       \
940                                                                             \
941             if (RExC_seen & REG_ZERO_LEN_SEEN)                              \
942                 Perl_re_printf( aTHX_ "REG_ZERO_LEN_SEEN ");                            \
943                                                                             \
944             if (RExC_seen & REG_LOOKBEHIND_SEEN)                            \
945                 Perl_re_printf( aTHX_ "REG_LOOKBEHIND_SEEN ");                          \
946                                                                             \
947             if (RExC_seen & REG_GPOS_SEEN)                                  \
948                 Perl_re_printf( aTHX_ "REG_GPOS_SEEN ");                                \
949                                                                             \
950             if (RExC_seen & REG_RECURSE_SEEN)                               \
951                 Perl_re_printf( aTHX_ "REG_RECURSE_SEEN ");                             \
952                                                                             \
953             if (RExC_seen & REG_TOP_LEVEL_BRANCHES_SEEN)                    \
954                 Perl_re_printf( aTHX_ "REG_TOP_LEVEL_BRANCHES_SEEN ");                  \
955                                                                             \
956             if (RExC_seen & REG_VERBARG_SEEN)                               \
957                 Perl_re_printf( aTHX_ "REG_VERBARG_SEEN ");                             \
958                                                                             \
959             if (RExC_seen & REG_CUTGROUP_SEEN)                              \
960                 Perl_re_printf( aTHX_ "REG_CUTGROUP_SEEN ");                            \
961                                                                             \
962             if (RExC_seen & REG_RUN_ON_COMMENT_SEEN)                        \
963                 Perl_re_printf( aTHX_ "REG_RUN_ON_COMMENT_SEEN ");                      \
964                                                                             \
965             if (RExC_seen & REG_UNFOLDED_MULTI_SEEN)                        \
966                 Perl_re_printf( aTHX_ "REG_UNFOLDED_MULTI_SEEN ");                      \
967                                                                             \
968             if (RExC_seen & REG_UNBOUNDED_QUANTIFIER_SEEN)                  \
969                 Perl_re_printf( aTHX_ "REG_UNBOUNDED_QUANTIFIER_SEEN ");                \
970                                                                             \
971             Perl_re_printf( aTHX_ "\n");                                                \
972         });
973
974 #define DEBUG_SHOW_STUDY_FLAG(flags,flag) \
975   if ((flags) & flag) Perl_re_printf( aTHX_  "%s ", #flag)
976
977
978 #ifdef DEBUGGING
979 static void
980 S_debug_show_study_flags(pTHX_ U32 flags, const char *open_str,
981                                     const char *close_str)
982 {
983     if (!flags)
984         return;
985
986     Perl_re_printf( aTHX_  "%s", open_str);
987     DEBUG_SHOW_STUDY_FLAG(flags, SF_BEFORE_SEOL);
988     DEBUG_SHOW_STUDY_FLAG(flags, SF_BEFORE_MEOL);
989     DEBUG_SHOW_STUDY_FLAG(flags, SF_IS_INF);
990     DEBUG_SHOW_STUDY_FLAG(flags, SF_HAS_PAR);
991     DEBUG_SHOW_STUDY_FLAG(flags, SF_IN_PAR);
992     DEBUG_SHOW_STUDY_FLAG(flags, SF_HAS_EVAL);
993     DEBUG_SHOW_STUDY_FLAG(flags, SCF_DO_SUBSTR);
994     DEBUG_SHOW_STUDY_FLAG(flags, SCF_DO_STCLASS_AND);
995     DEBUG_SHOW_STUDY_FLAG(flags, SCF_DO_STCLASS_OR);
996     DEBUG_SHOW_STUDY_FLAG(flags, SCF_DO_STCLASS);
997     DEBUG_SHOW_STUDY_FLAG(flags, SCF_WHILEM_VISITED_POS);
998     DEBUG_SHOW_STUDY_FLAG(flags, SCF_TRIE_RESTUDY);
999     DEBUG_SHOW_STUDY_FLAG(flags, SCF_SEEN_ACCEPT);
1000     DEBUG_SHOW_STUDY_FLAG(flags, SCF_TRIE_DOING_RESTUDY);
1001     DEBUG_SHOW_STUDY_FLAG(flags, SCF_IN_DEFINE);
1002     Perl_re_printf( aTHX_  "%s", close_str);
1003 }
1004
1005
1006 static void
1007 S_debug_studydata(pTHX_ const char *where, scan_data_t *data,
1008                     U32 depth, int is_inf)
1009 {
1010     GET_RE_DEBUG_FLAGS_DECL;
1011
1012     DEBUG_OPTIMISE_MORE_r({
1013         if (!data)
1014             return;
1015         Perl_re_indentf(aTHX_  "%s: Pos:%" IVdf "/%" IVdf " Flags: 0x%" UVXf,
1016             depth,
1017             where,
1018             (IV)data->pos_min,
1019             (IV)data->pos_delta,
1020             (UV)data->flags
1021         );
1022
1023         S_debug_show_study_flags(aTHX_ data->flags," [","]");
1024
1025         Perl_re_printf( aTHX_
1026             " Whilem_c: %" IVdf " Lcp: %" IVdf " %s",
1027             (IV)data->whilem_c,
1028             (IV)(data->last_closep ? *((data)->last_closep) : -1),
1029             is_inf ? "INF " : ""
1030         );
1031
1032         if (data->last_found) {
1033             int i;
1034             Perl_re_printf(aTHX_
1035                 "Last:'%s' %" IVdf ":%" IVdf "/%" IVdf,
1036                     SvPVX_const(data->last_found),
1037                     (IV)data->last_end,
1038                     (IV)data->last_start_min,
1039                     (IV)data->last_start_max
1040             );
1041
1042             for (i = 0; i < 2; i++) {
1043                 Perl_re_printf(aTHX_
1044                     " %s%s: '%s' @ %" IVdf "/%" IVdf,
1045                     data->cur_is_floating == i ? "*" : "",
1046                     i ? "Float" : "Fixed",
1047                     SvPVX_const(data->substrs[i].str),
1048                     (IV)data->substrs[i].min_offset,
1049                     (IV)data->substrs[i].max_offset
1050                 );
1051                 S_debug_show_study_flags(aTHX_ data->substrs[i].flags," [","]");
1052             }
1053         }
1054
1055         Perl_re_printf( aTHX_ "\n");
1056     });
1057 }
1058
1059
1060 static void
1061 S_debug_peep(pTHX_ const char *str, const RExC_state_t *pRExC_state,
1062                 regnode *scan, U32 depth, U32 flags)
1063 {
1064     GET_RE_DEBUG_FLAGS_DECL;
1065
1066     DEBUG_OPTIMISE_r({
1067         regnode *Next;
1068
1069         if (!scan)
1070             return;
1071         Next = regnext(scan);
1072         regprop(RExC_rx, RExC_mysv, scan, NULL, pRExC_state);
1073         Perl_re_indentf( aTHX_   "%s>%3d: %s (%d)",
1074             depth,
1075             str,
1076             REG_NODE_NUM(scan), SvPV_nolen_const(RExC_mysv),
1077             Next ? (REG_NODE_NUM(Next)) : 0 );
1078         S_debug_show_study_flags(aTHX_ flags," [ ","]");
1079         Perl_re_printf( aTHX_  "\n");
1080    });
1081 }
1082
1083
1084 #  define DEBUG_STUDYDATA(where, data, depth, is_inf) \
1085                     S_debug_studydata(aTHX_ where, data, depth, is_inf)
1086
1087 #  define DEBUG_PEEP(str, scan, depth, flags)   \
1088                     S_debug_peep(aTHX_ str, pRExC_state, scan, depth, flags)
1089
1090 #else
1091 #  define DEBUG_STUDYDATA(where, data, depth, is_inf) NOOP
1092 #  define DEBUG_PEEP(str, scan, depth, flags)         NOOP
1093 #endif
1094
1095
1096 /* =========================================================
1097  * BEGIN edit_distance stuff.
1098  *
1099  * This calculates how many single character changes of any type are needed to
1100  * transform a string into another one.  It is taken from version 3.1 of
1101  *
1102  * https://metacpan.org/pod/Text::Levenshtein::Damerau::XS
1103  */
1104
1105 /* Our unsorted dictionary linked list.   */
1106 /* Note we use UVs, not chars. */
1107
1108 struct dictionary{
1109   UV key;
1110   UV value;
1111   struct dictionary* next;
1112 };
1113 typedef struct dictionary item;
1114
1115
1116 PERL_STATIC_INLINE item*
1117 push(UV key,item* curr)
1118 {
1119     item* head;
1120     Newx(head, 1, item);
1121     head->key = key;
1122     head->value = 0;
1123     head->next = curr;
1124     return head;
1125 }
1126
1127
1128 PERL_STATIC_INLINE item*
1129 find(item* head, UV key)
1130 {
1131     item* iterator = head;
1132     while (iterator){
1133         if (iterator->key == key){
1134             return iterator;
1135         }
1136         iterator = iterator->next;
1137     }
1138
1139     return NULL;
1140 }
1141
1142 PERL_STATIC_INLINE item*
1143 uniquePush(item* head,UV key)
1144 {
1145     item* iterator = head;
1146
1147     while (iterator){
1148         if (iterator->key == key) {
1149             return head;
1150         }
1151         iterator = iterator->next;
1152     }
1153
1154     return push(key,head);
1155 }
1156
1157 PERL_STATIC_INLINE void
1158 dict_free(item* head)
1159 {
1160     item* iterator = head;
1161
1162     while (iterator) {
1163         item* temp = iterator;
1164         iterator = iterator->next;
1165         Safefree(temp);
1166     }
1167
1168     head = NULL;
1169 }
1170
1171 /* End of Dictionary Stuff */
1172
1173 /* All calculations/work are done here */
1174 STATIC int
1175 S_edit_distance(const UV* src,
1176                 const UV* tgt,
1177                 const STRLEN x,             /* length of src[] */
1178                 const STRLEN y,             /* length of tgt[] */
1179                 const SSize_t maxDistance
1180 )
1181 {
1182     item *head = NULL;
1183     UV swapCount,swapScore,targetCharCount,i,j;
1184     UV *scores;
1185     UV score_ceil = x + y;
1186
1187     PERL_ARGS_ASSERT_EDIT_DISTANCE;
1188
1189     /* intialize matrix start values */
1190     Newx(scores, ( (x + 2) * (y + 2)), UV);
1191     scores[0] = score_ceil;
1192     scores[1 * (y + 2) + 0] = score_ceil;
1193     scores[0 * (y + 2) + 1] = score_ceil;
1194     scores[1 * (y + 2) + 1] = 0;
1195     head = uniquePush(uniquePush(head,src[0]),tgt[0]);
1196
1197     /* work loops    */
1198     /* i = src index */
1199     /* j = tgt index */
1200     for (i=1;i<=x;i++) {
1201         if (i < x)
1202             head = uniquePush(head,src[i]);
1203         scores[(i+1) * (y + 2) + 1] = i;
1204         scores[(i+1) * (y + 2) + 0] = score_ceil;
1205         swapCount = 0;
1206
1207         for (j=1;j<=y;j++) {
1208             if (i == 1) {
1209                 if(j < y)
1210                 head = uniquePush(head,tgt[j]);
1211                 scores[1 * (y + 2) + (j + 1)] = j;
1212                 scores[0 * (y + 2) + (j + 1)] = score_ceil;
1213             }
1214
1215             targetCharCount = find(head,tgt[j-1])->value;
1216             swapScore = scores[targetCharCount * (y + 2) + swapCount] + i - targetCharCount - 1 + j - swapCount;
1217
1218             if (src[i-1] != tgt[j-1]){
1219                 scores[(i+1) * (y + 2) + (j + 1)] = MIN(swapScore,(MIN(scores[i * (y + 2) + j], MIN(scores[(i+1) * (y + 2) + j], scores[i * (y + 2) + (j + 1)])) + 1));
1220             }
1221             else {
1222                 swapCount = j;
1223                 scores[(i+1) * (y + 2) + (j + 1)] = MIN(scores[i * (y + 2) + j], swapScore);
1224             }
1225         }
1226
1227         find(head,src[i-1])->value = i;
1228     }
1229
1230     {
1231         IV score = scores[(x+1) * (y + 2) + (y + 1)];
1232         dict_free(head);
1233         Safefree(scores);
1234         return (maxDistance != 0 && maxDistance < score)?(-1):score;
1235     }
1236 }
1237
1238 /* END of edit_distance() stuff
1239  * ========================================================= */
1240
1241 /* is c a control character for which we have a mnemonic? */
1242 #define isMNEMONIC_CNTRL(c) _IS_MNEMONIC_CNTRL_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c)
1243
1244 STATIC const char *
1245 S_cntrl_to_mnemonic(const U8 c)
1246 {
1247     /* Returns the mnemonic string that represents character 'c', if one
1248      * exists; NULL otherwise.  The only ones that exist for the purposes of
1249      * this routine are a few control characters */
1250
1251     switch (c) {
1252         case '\a':       return "\\a";
1253         case '\b':       return "\\b";
1254         case ESC_NATIVE: return "\\e";
1255         case '\f':       return "\\f";
1256         case '\n':       return "\\n";
1257         case '\r':       return "\\r";
1258         case '\t':       return "\\t";
1259     }
1260
1261     return NULL;
1262 }
1263
1264 /* Mark that we cannot extend a found fixed substring at this point.
1265    Update the longest found anchored substring or the longest found
1266    floating substrings if needed. */
1267
1268 STATIC void
1269 S_scan_commit(pTHX_ const RExC_state_t *pRExC_state, scan_data_t *data,
1270                     SSize_t *minlenp, int is_inf)
1271 {
1272     const STRLEN l = CHR_SVLEN(data->last_found);
1273     SV * const longest_sv = data->substrs[data->cur_is_floating].str;
1274     const STRLEN old_l = CHR_SVLEN(longest_sv);
1275     GET_RE_DEBUG_FLAGS_DECL;
1276
1277     PERL_ARGS_ASSERT_SCAN_COMMIT;
1278
1279     if ((l >= old_l) && ((l > old_l) || (data->flags & SF_BEFORE_EOL))) {
1280         const U8 i = data->cur_is_floating;
1281         SvSetMagicSV(longest_sv, data->last_found);
1282         data->substrs[i].min_offset = l ? data->last_start_min : data->pos_min;
1283
1284         if (!i) /* fixed */
1285             data->substrs[0].max_offset = data->substrs[0].min_offset;
1286         else { /* float */
1287             data->substrs[1].max_offset = (l
1288                           ? data->last_start_max
1289                           : (data->pos_delta > SSize_t_MAX - data->pos_min
1290                                          ? SSize_t_MAX
1291                                          : data->pos_min + data->pos_delta));
1292             if (is_inf
1293                  || (STRLEN)data->substrs[1].max_offset > (STRLEN)SSize_t_MAX)
1294                 data->substrs[1].max_offset = SSize_t_MAX;
1295         }
1296
1297         if (data->flags & SF_BEFORE_EOL)
1298             data->substrs[i].flags |= (data->flags & SF_BEFORE_EOL);
1299         else
1300             data->substrs[i].flags &= ~SF_BEFORE_EOL;
1301         data->substrs[i].minlenp = minlenp;
1302         data->substrs[i].lookbehind = 0;
1303     }
1304
1305     SvCUR_set(data->last_found, 0);
1306     {
1307         SV * const sv = data->last_found;
1308         if (SvUTF8(sv) && SvMAGICAL(sv)) {
1309             MAGIC * const mg = mg_find(sv, PERL_MAGIC_utf8);
1310             if (mg)
1311                 mg->mg_len = 0;
1312         }
1313     }
1314     data->last_end = -1;
1315     data->flags &= ~SF_BEFORE_EOL;
1316     DEBUG_STUDYDATA("commit", data, 0, is_inf);
1317 }
1318
1319 /* An SSC is just a regnode_charclass_posix with an extra field: the inversion
1320  * list that describes which code points it matches */
1321
1322 STATIC void
1323 S_ssc_anything(pTHX_ regnode_ssc *ssc)
1324 {
1325     /* Set the SSC 'ssc' to match an empty string or any code point */
1326
1327     PERL_ARGS_ASSERT_SSC_ANYTHING;
1328
1329     assert(is_ANYOF_SYNTHETIC(ssc));
1330
1331     /* mortalize so won't leak */
1332     ssc->invlist = sv_2mortal(_add_range_to_invlist(NULL, 0, UV_MAX));
1333     ANYOF_FLAGS(ssc) |= SSC_MATCHES_EMPTY_STRING;  /* Plus matches empty */
1334 }
1335
1336 STATIC int
1337 S_ssc_is_anything(const regnode_ssc *ssc)
1338 {
1339     /* Returns TRUE if the SSC 'ssc' can match the empty string and any code
1340      * point; FALSE otherwise.  Thus, this is used to see if using 'ssc' buys
1341      * us anything: if the function returns TRUE, 'ssc' hasn't been restricted
1342      * in any way, so there's no point in using it */
1343
1344     UV start, end;
1345     bool ret;
1346
1347     PERL_ARGS_ASSERT_SSC_IS_ANYTHING;
1348
1349     assert(is_ANYOF_SYNTHETIC(ssc));
1350
1351     if (! (ANYOF_FLAGS(ssc) & SSC_MATCHES_EMPTY_STRING)) {
1352         return FALSE;
1353     }
1354
1355     /* See if the list consists solely of the range 0 - Infinity */
1356     invlist_iterinit(ssc->invlist);
1357     ret = invlist_iternext(ssc->invlist, &start, &end)
1358           && start == 0
1359           && end == UV_MAX;
1360
1361     invlist_iterfinish(ssc->invlist);
1362
1363     if (ret) {
1364         return TRUE;
1365     }
1366
1367     /* If e.g., both \w and \W are set, matches everything */
1368     if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
1369         int i;
1370         for (i = 0; i < ANYOF_POSIXL_MAX; i += 2) {
1371             if (ANYOF_POSIXL_TEST(ssc, i) && ANYOF_POSIXL_TEST(ssc, i+1)) {
1372                 return TRUE;
1373             }
1374         }
1375     }
1376
1377     return FALSE;
1378 }
1379
1380 STATIC void
1381 S_ssc_init(pTHX_ const RExC_state_t *pRExC_state, regnode_ssc *ssc)
1382 {
1383     /* Initializes the SSC 'ssc'.  This includes setting it to match an empty
1384      * string, any code point, or any posix class under locale */
1385
1386     PERL_ARGS_ASSERT_SSC_INIT;
1387
1388     Zero(ssc, 1, regnode_ssc);
1389     set_ANYOF_SYNTHETIC(ssc);
1390     ARG_SET(ssc, ANYOF_ONLY_HAS_BITMAP);
1391     ssc_anything(ssc);
1392
1393     /* If any portion of the regex is to operate under locale rules that aren't
1394      * fully known at compile time, initialization includes it.  The reason
1395      * this isn't done for all regexes is that the optimizer was written under
1396      * the assumption that locale was all-or-nothing.  Given the complexity and
1397      * lack of documentation in the optimizer, and that there are inadequate
1398      * test cases for locale, many parts of it may not work properly, it is
1399      * safest to avoid locale unless necessary. */
1400     if (RExC_contains_locale) {
1401         ANYOF_POSIXL_SETALL(ssc);
1402     }
1403     else {
1404         ANYOF_POSIXL_ZERO(ssc);
1405     }
1406 }
1407
1408 STATIC int
1409 S_ssc_is_cp_posixl_init(const RExC_state_t *pRExC_state,
1410                         const regnode_ssc *ssc)
1411 {
1412     /* Returns TRUE if the SSC 'ssc' is in its initial state with regard only
1413      * to the list of code points matched, and locale posix classes; hence does
1414      * not check its flags) */
1415
1416     UV start, end;
1417     bool ret;
1418
1419     PERL_ARGS_ASSERT_SSC_IS_CP_POSIXL_INIT;
1420
1421     assert(is_ANYOF_SYNTHETIC(ssc));
1422
1423     invlist_iterinit(ssc->invlist);
1424     ret = invlist_iternext(ssc->invlist, &start, &end)
1425           && start == 0
1426           && end == UV_MAX;
1427
1428     invlist_iterfinish(ssc->invlist);
1429
1430     if (! ret) {
1431         return FALSE;
1432     }
1433
1434     if (RExC_contains_locale && ! ANYOF_POSIXL_SSC_TEST_ALL_SET(ssc)) {
1435         return FALSE;
1436     }
1437
1438     return TRUE;
1439 }
1440
1441 STATIC SV*
1442 S_get_ANYOF_cp_list_for_ssc(pTHX_ const RExC_state_t *pRExC_state,
1443                                const regnode_charclass* const node)
1444 {
1445     /* Returns a mortal inversion list defining which code points are matched
1446      * by 'node', which is of type ANYOF.  Handles complementing the result if
1447      * appropriate.  If some code points aren't knowable at this time, the
1448      * returned list must, and will, contain every code point that is a
1449      * possibility. */
1450
1451     SV* invlist = NULL;
1452     SV* only_utf8_locale_invlist = NULL;
1453     unsigned int i;
1454     const U32 n = ARG(node);
1455     bool new_node_has_latin1 = FALSE;
1456
1457     PERL_ARGS_ASSERT_GET_ANYOF_CP_LIST_FOR_SSC;
1458
1459     /* Look at the data structure created by S_set_ANYOF_arg() */
1460     if (n != ANYOF_ONLY_HAS_BITMAP) {
1461         SV * const rv = MUTABLE_SV(RExC_rxi->data->data[n]);
1462         AV * const av = MUTABLE_AV(SvRV(rv));
1463         SV **const ary = AvARRAY(av);
1464         assert(RExC_rxi->data->what[n] == 's');
1465
1466         if (ary[1] && ary[1] != &PL_sv_undef) { /* Has compile-time swash */
1467             invlist = sv_2mortal(invlist_clone(_get_swash_invlist(ary[1])));
1468         }
1469         else if (ary[0] && ary[0] != &PL_sv_undef) {
1470
1471             /* Here, no compile-time swash, and there are things that won't be
1472              * known until runtime -- we have to assume it could be anything */
1473             invlist = sv_2mortal(_new_invlist(1));
1474             return _add_range_to_invlist(invlist, 0, UV_MAX);
1475         }
1476         else if (ary[3] && ary[3] != &PL_sv_undef) {
1477
1478             /* Here no compile-time swash, and no run-time only data.  Use the
1479              * node's inversion list */
1480             invlist = sv_2mortal(invlist_clone(ary[3]));
1481         }
1482
1483         /* Get the code points valid only under UTF-8 locales */
1484         if ((ANYOF_FLAGS(node) & ANYOFL_FOLD)
1485             && ary[2] && ary[2] != &PL_sv_undef)
1486         {
1487             only_utf8_locale_invlist = ary[2];
1488         }
1489     }
1490
1491     if (! invlist) {
1492         invlist = sv_2mortal(_new_invlist(0));
1493     }
1494
1495     /* An ANYOF node contains a bitmap for the first NUM_ANYOF_CODE_POINTS
1496      * code points, and an inversion list for the others, but if there are code
1497      * points that should match only conditionally on the target string being
1498      * UTF-8, those are placed in the inversion list, and not the bitmap.
1499      * Since there are circumstances under which they could match, they are
1500      * included in the SSC.  But if the ANYOF node is to be inverted, we have
1501      * to exclude them here, so that when we invert below, the end result
1502      * actually does include them.  (Think about "\xe0" =~ /[^\xc0]/di;).  We
1503      * have to do this here before we add the unconditionally matched code
1504      * points */
1505     if (ANYOF_FLAGS(node) & ANYOF_INVERT) {
1506         _invlist_intersection_complement_2nd(invlist,
1507                                              PL_UpperLatin1,
1508                                              &invlist);
1509     }
1510
1511     /* Add in the points from the bit map */
1512     for (i = 0; i < NUM_ANYOF_CODE_POINTS; i++) {
1513         if (ANYOF_BITMAP_TEST(node, i)) {
1514             unsigned int start = i++;
1515
1516             for (; i < NUM_ANYOF_CODE_POINTS && ANYOF_BITMAP_TEST(node, i); ++i) {
1517                 /* empty */
1518             }
1519             invlist = _add_range_to_invlist(invlist, start, i-1);
1520             new_node_has_latin1 = TRUE;
1521         }
1522     }
1523
1524     /* If this can match all upper Latin1 code points, have to add them
1525      * as well.  But don't add them if inverting, as when that gets done below,
1526      * it would exclude all these characters, including the ones it shouldn't
1527      * that were added just above */
1528     if (! (ANYOF_FLAGS(node) & ANYOF_INVERT) && OP(node) == ANYOFD
1529         && (ANYOF_FLAGS(node) & ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER))
1530     {
1531         _invlist_union(invlist, PL_UpperLatin1, &invlist);
1532     }
1533
1534     /* Similarly for these */
1535     if (ANYOF_FLAGS(node) & ANYOF_MATCHES_ALL_ABOVE_BITMAP) {
1536         _invlist_union_complement_2nd(invlist, PL_InBitmap, &invlist);
1537     }
1538
1539     if (ANYOF_FLAGS(node) & ANYOF_INVERT) {
1540         _invlist_invert(invlist);
1541     }
1542     else if (new_node_has_latin1 && ANYOF_FLAGS(node) & ANYOFL_FOLD) {
1543
1544         /* Under /li, any 0-255 could fold to any other 0-255, depending on the
1545          * locale.  We can skip this if there are no 0-255 at all. */
1546         _invlist_union(invlist, PL_Latin1, &invlist);
1547     }
1548
1549     /* Similarly add the UTF-8 locale possible matches.  These have to be
1550      * deferred until after the non-UTF-8 locale ones are taken care of just
1551      * above, or it leads to wrong results under ANYOF_INVERT */
1552     if (only_utf8_locale_invlist) {
1553         _invlist_union_maybe_complement_2nd(invlist,
1554                                             only_utf8_locale_invlist,
1555                                             ANYOF_FLAGS(node) & ANYOF_INVERT,
1556                                             &invlist);
1557     }
1558
1559     return invlist;
1560 }
1561
1562 /* These two functions currently do the exact same thing */
1563 #define ssc_init_zero           ssc_init
1564
1565 #define ssc_add_cp(ssc, cp)   ssc_add_range((ssc), (cp), (cp))
1566 #define ssc_match_all_cp(ssc) ssc_add_range(ssc, 0, UV_MAX)
1567
1568 /* 'AND' a given class with another one.  Can create false positives.  'ssc'
1569  * should not be inverted.  'and_with->flags & ANYOF_MATCHES_POSIXL' should be
1570  * 0 if 'and_with' is a regnode_charclass instead of a regnode_ssc. */
1571
1572 STATIC void
1573 S_ssc_and(pTHX_ const RExC_state_t *pRExC_state, regnode_ssc *ssc,
1574                 const regnode_charclass *and_with)
1575 {
1576     /* Accumulate into SSC 'ssc' its 'AND' with 'and_with', which is either
1577      * another SSC or a regular ANYOF class.  Can create false positives. */
1578
1579     SV* anded_cp_list;
1580     U8  anded_flags;
1581
1582     PERL_ARGS_ASSERT_SSC_AND;
1583
1584     assert(is_ANYOF_SYNTHETIC(ssc));
1585
1586     /* 'and_with' is used as-is if it too is an SSC; otherwise have to extract
1587      * the code point inversion list and just the relevant flags */
1588     if (is_ANYOF_SYNTHETIC(and_with)) {
1589         anded_cp_list = ((regnode_ssc *)and_with)->invlist;
1590         anded_flags = ANYOF_FLAGS(and_with);
1591
1592         /* XXX This is a kludge around what appears to be deficiencies in the
1593          * optimizer.  If we make S_ssc_anything() add in the WARN_SUPER flag,
1594          * there are paths through the optimizer where it doesn't get weeded
1595          * out when it should.  And if we don't make some extra provision for
1596          * it like the code just below, it doesn't get added when it should.
1597          * This solution is to add it only when AND'ing, which is here, and
1598          * only when what is being AND'ed is the pristine, original node
1599          * matching anything.  Thus it is like adding it to ssc_anything() but
1600          * only when the result is to be AND'ed.  Probably the same solution
1601          * could be adopted for the same problem we have with /l matching,
1602          * which is solved differently in S_ssc_init(), and that would lead to
1603          * fewer false positives than that solution has.  But if this solution
1604          * creates bugs, the consequences are only that a warning isn't raised
1605          * that should be; while the consequences for having /l bugs is
1606          * incorrect matches */
1607         if (ssc_is_anything((regnode_ssc *)and_with)) {
1608             anded_flags |= ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER;
1609         }
1610     }
1611     else {
1612         anded_cp_list = get_ANYOF_cp_list_for_ssc(pRExC_state, and_with);
1613         if (OP(and_with) == ANYOFD) {
1614             anded_flags = ANYOF_FLAGS(and_with) & ANYOF_COMMON_FLAGS;
1615         }
1616         else {
1617             anded_flags = ANYOF_FLAGS(and_with)
1618             &( ANYOF_COMMON_FLAGS
1619               |ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER
1620               |ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP);
1621             if (ANYOFL_UTF8_LOCALE_REQD(ANYOF_FLAGS(and_with))) {
1622                 anded_flags &=
1623                     ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD;
1624             }
1625         }
1626     }
1627
1628     ANYOF_FLAGS(ssc) &= anded_flags;
1629
1630     /* Below, C1 is the list of code points in 'ssc'; P1, its posix classes.
1631      * C2 is the list of code points in 'and-with'; P2, its posix classes.
1632      * 'and_with' may be inverted.  When not inverted, we have the situation of
1633      * computing:
1634      *  (C1 | P1) & (C2 | P2)
1635      *                     =  (C1 & (C2 | P2)) | (P1 & (C2 | P2))
1636      *                     =  ((C1 & C2) | (C1 & P2)) | ((P1 & C2) | (P1 & P2))
1637      *                    <=  ((C1 & C2) |       P2)) | ( P1       | (P1 & P2))
1638      *                    <=  ((C1 & C2) | P1 | P2)
1639      * Alternatively, the last few steps could be:
1640      *                     =  ((C1 & C2) | (C1 & P2)) | ((P1 & C2) | (P1 & P2))
1641      *                    <=  ((C1 & C2) |  C1      ) | (      C2  | (P1 & P2))
1642      *                    <=  (C1 | C2 | (P1 & P2))
1643      * We favor the second approach if either P1 or P2 is non-empty.  This is
1644      * because these components are a barrier to doing optimizations, as what
1645      * they match cannot be known until the moment of matching as they are
1646      * dependent on the current locale, 'AND"ing them likely will reduce or
1647      * eliminate them.
1648      * But we can do better if we know that C1,P1 are in their initial state (a
1649      * frequent occurrence), each matching everything:
1650      *  (<everything>) & (C2 | P2) =  C2 | P2
1651      * Similarly, if C2,P2 are in their initial state (again a frequent
1652      * occurrence), the result is a no-op
1653      *  (C1 | P1) & (<everything>) =  C1 | P1
1654      *
1655      * Inverted, we have
1656      *  (C1 | P1) & ~(C2 | P2)  =  (C1 | P1) & (~C2 & ~P2)
1657      *                          =  (C1 & (~C2 & ~P2)) | (P1 & (~C2 & ~P2))
1658      *                         <=  (C1 & ~C2) | (P1 & ~P2)
1659      * */
1660
1661     if ((ANYOF_FLAGS(and_with) & ANYOF_INVERT)
1662         && ! is_ANYOF_SYNTHETIC(and_with))
1663     {
1664         unsigned int i;
1665
1666         ssc_intersection(ssc,
1667                          anded_cp_list,
1668                          FALSE /* Has already been inverted */
1669                          );
1670
1671         /* If either P1 or P2 is empty, the intersection will be also; can skip
1672          * the loop */
1673         if (! (ANYOF_FLAGS(and_with) & ANYOF_MATCHES_POSIXL)) {
1674             ANYOF_POSIXL_ZERO(ssc);
1675         }
1676         else if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
1677
1678             /* Note that the Posix class component P from 'and_with' actually
1679              * looks like:
1680              *      P = Pa | Pb | ... | Pn
1681              * where each component is one posix class, such as in [\w\s].
1682              * Thus
1683              *      ~P = ~(Pa | Pb | ... | Pn)
1684              *         = ~Pa & ~Pb & ... & ~Pn
1685              *        <= ~Pa | ~Pb | ... | ~Pn
1686              * The last is something we can easily calculate, but unfortunately
1687              * is likely to have many false positives.  We could do better
1688              * in some (but certainly not all) instances if two classes in
1689              * P have known relationships.  For example
1690              *      :lower: <= :alpha: <= :alnum: <= \w <= :graph: <= :print:
1691              * So
1692              *      :lower: & :print: = :lower:
1693              * And similarly for classes that must be disjoint.  For example,
1694              * since \s and \w can have no elements in common based on rules in
1695              * the POSIX standard,
1696              *      \w & ^\S = nothing
1697              * Unfortunately, some vendor locales do not meet the Posix
1698              * standard, in particular almost everything by Microsoft.
1699              * The loop below just changes e.g., \w into \W and vice versa */
1700
1701             regnode_charclass_posixl temp;
1702             int add = 1;    /* To calculate the index of the complement */
1703
1704             Zero(&temp, 1, regnode_charclass_posixl);
1705             ANYOF_POSIXL_ZERO(&temp);
1706             for (i = 0; i < ANYOF_MAX; i++) {
1707                 assert(i % 2 != 0
1708                        || ! ANYOF_POSIXL_TEST((regnode_charclass_posixl*) and_with, i)
1709                        || ! ANYOF_POSIXL_TEST((regnode_charclass_posixl*) and_with, i + 1));
1710
1711                 if (ANYOF_POSIXL_TEST((regnode_charclass_posixl*) and_with, i)) {
1712                     ANYOF_POSIXL_SET(&temp, i + add);
1713                 }
1714                 add = 0 - add; /* 1 goes to -1; -1 goes to 1 */
1715             }
1716             ANYOF_POSIXL_AND(&temp, ssc);
1717
1718         } /* else ssc already has no posixes */
1719     } /* else: Not inverted.  This routine is a no-op if 'and_with' is an SSC
1720          in its initial state */
1721     else if (! is_ANYOF_SYNTHETIC(and_with)
1722              || ! ssc_is_cp_posixl_init(pRExC_state, (regnode_ssc *)and_with))
1723     {
1724         /* But if 'ssc' is in its initial state, the result is just 'and_with';
1725          * copy it over 'ssc' */
1726         if (ssc_is_cp_posixl_init(pRExC_state, ssc)) {
1727             if (is_ANYOF_SYNTHETIC(and_with)) {
1728                 StructCopy(and_with, ssc, regnode_ssc);
1729             }
1730             else {
1731                 ssc->invlist = anded_cp_list;
1732                 ANYOF_POSIXL_ZERO(ssc);
1733                 if (ANYOF_FLAGS(and_with) & ANYOF_MATCHES_POSIXL) {
1734                     ANYOF_POSIXL_OR((regnode_charclass_posixl*) and_with, ssc);
1735                 }
1736             }
1737         }
1738         else if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)
1739                  || (ANYOF_FLAGS(and_with) & ANYOF_MATCHES_POSIXL))
1740         {
1741             /* One or the other of P1, P2 is non-empty. */
1742             if (ANYOF_FLAGS(and_with) & ANYOF_MATCHES_POSIXL) {
1743                 ANYOF_POSIXL_AND((regnode_charclass_posixl*) and_with, ssc);
1744             }
1745             ssc_union(ssc, anded_cp_list, FALSE);
1746         }
1747         else { /* P1 = P2 = empty */
1748             ssc_intersection(ssc, anded_cp_list, FALSE);
1749         }
1750     }
1751 }
1752
1753 STATIC void
1754 S_ssc_or(pTHX_ const RExC_state_t *pRExC_state, regnode_ssc *ssc,
1755                const regnode_charclass *or_with)
1756 {
1757     /* Accumulate into SSC 'ssc' its 'OR' with 'or_with', which is either
1758      * another SSC or a regular ANYOF class.  Can create false positives if
1759      * 'or_with' is to be inverted. */
1760
1761     SV* ored_cp_list;
1762     U8 ored_flags;
1763
1764     PERL_ARGS_ASSERT_SSC_OR;
1765
1766     assert(is_ANYOF_SYNTHETIC(ssc));
1767
1768     /* 'or_with' is used as-is if it too is an SSC; otherwise have to extract
1769      * the code point inversion list and just the relevant flags */
1770     if (is_ANYOF_SYNTHETIC(or_with)) {
1771         ored_cp_list = ((regnode_ssc*) or_with)->invlist;
1772         ored_flags = ANYOF_FLAGS(or_with);
1773     }
1774     else {
1775         ored_cp_list = get_ANYOF_cp_list_for_ssc(pRExC_state, or_with);
1776         ored_flags = ANYOF_FLAGS(or_with) & ANYOF_COMMON_FLAGS;
1777         if (OP(or_with) != ANYOFD) {
1778             ored_flags
1779             |= ANYOF_FLAGS(or_with)
1780              & ( ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER
1781                 |ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP);
1782             if (ANYOFL_UTF8_LOCALE_REQD(ANYOF_FLAGS(or_with))) {
1783                 ored_flags |=
1784                     ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD;
1785             }
1786         }
1787     }
1788
1789     ANYOF_FLAGS(ssc) |= ored_flags;
1790
1791     /* Below, C1 is the list of code points in 'ssc'; P1, its posix classes.
1792      * C2 is the list of code points in 'or-with'; P2, its posix classes.
1793      * 'or_with' may be inverted.  When not inverted, we have the simple
1794      * situation of computing:
1795      *  (C1 | P1) | (C2 | P2)  =  (C1 | C2) | (P1 | P2)
1796      * If P1|P2 yields a situation with both a class and its complement are
1797      * set, like having both \w and \W, this matches all code points, and we
1798      * can delete these from the P component of the ssc going forward.  XXX We
1799      * might be able to delete all the P components, but I (khw) am not certain
1800      * about this, and it is better to be safe.
1801      *
1802      * Inverted, we have
1803      *  (C1 | P1) | ~(C2 | P2)  =  (C1 | P1) | (~C2 & ~P2)
1804      *                         <=  (C1 | P1) | ~C2
1805      *                         <=  (C1 | ~C2) | P1
1806      * (which results in actually simpler code than the non-inverted case)
1807      * */
1808
1809     if ((ANYOF_FLAGS(or_with) & ANYOF_INVERT)
1810         && ! is_ANYOF_SYNTHETIC(or_with))
1811     {
1812         /* We ignore P2, leaving P1 going forward */
1813     }   /* else  Not inverted */
1814     else if (ANYOF_FLAGS(or_with) & ANYOF_MATCHES_POSIXL) {
1815         ANYOF_POSIXL_OR((regnode_charclass_posixl*)or_with, ssc);
1816         if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
1817             unsigned int i;
1818             for (i = 0; i < ANYOF_MAX; i += 2) {
1819                 if (ANYOF_POSIXL_TEST(ssc, i) && ANYOF_POSIXL_TEST(ssc, i + 1))
1820                 {
1821                     ssc_match_all_cp(ssc);
1822                     ANYOF_POSIXL_CLEAR(ssc, i);
1823                     ANYOF_POSIXL_CLEAR(ssc, i+1);
1824                 }
1825             }
1826         }
1827     }
1828
1829     ssc_union(ssc,
1830               ored_cp_list,
1831               FALSE /* Already has been inverted */
1832               );
1833 }
1834
1835 PERL_STATIC_INLINE void
1836 S_ssc_union(pTHX_ regnode_ssc *ssc, SV* const invlist, const bool invert2nd)
1837 {
1838     PERL_ARGS_ASSERT_SSC_UNION;
1839
1840     assert(is_ANYOF_SYNTHETIC(ssc));
1841
1842     _invlist_union_maybe_complement_2nd(ssc->invlist,
1843                                         invlist,
1844                                         invert2nd,
1845                                         &ssc->invlist);
1846 }
1847
1848 PERL_STATIC_INLINE void
1849 S_ssc_intersection(pTHX_ regnode_ssc *ssc,
1850                          SV* const invlist,
1851                          const bool invert2nd)
1852 {
1853     PERL_ARGS_ASSERT_SSC_INTERSECTION;
1854
1855     assert(is_ANYOF_SYNTHETIC(ssc));
1856
1857     _invlist_intersection_maybe_complement_2nd(ssc->invlist,
1858                                                invlist,
1859                                                invert2nd,
1860                                                &ssc->invlist);
1861 }
1862
1863 PERL_STATIC_INLINE void
1864 S_ssc_add_range(pTHX_ regnode_ssc *ssc, const UV start, const UV end)
1865 {
1866     PERL_ARGS_ASSERT_SSC_ADD_RANGE;
1867
1868     assert(is_ANYOF_SYNTHETIC(ssc));
1869
1870     ssc->invlist = _add_range_to_invlist(ssc->invlist, start, end);
1871 }
1872
1873 PERL_STATIC_INLINE void
1874 S_ssc_cp_and(pTHX_ regnode_ssc *ssc, const UV cp)
1875 {
1876     /* AND just the single code point 'cp' into the SSC 'ssc' */
1877
1878     SV* cp_list = _new_invlist(2);
1879
1880     PERL_ARGS_ASSERT_SSC_CP_AND;
1881
1882     assert(is_ANYOF_SYNTHETIC(ssc));
1883
1884     cp_list = add_cp_to_invlist(cp_list, cp);
1885     ssc_intersection(ssc, cp_list,
1886                      FALSE /* Not inverted */
1887                      );
1888     SvREFCNT_dec_NN(cp_list);
1889 }
1890
1891 PERL_STATIC_INLINE void
1892 S_ssc_clear_locale(regnode_ssc *ssc)
1893 {
1894     /* Set the SSC 'ssc' to not match any locale things */
1895     PERL_ARGS_ASSERT_SSC_CLEAR_LOCALE;
1896
1897     assert(is_ANYOF_SYNTHETIC(ssc));
1898
1899     ANYOF_POSIXL_ZERO(ssc);
1900     ANYOF_FLAGS(ssc) &= ~ANYOF_LOCALE_FLAGS;
1901 }
1902
1903 #define NON_OTHER_COUNT   NON_OTHER_COUNT_FOR_USE_ONLY_BY_REGCOMP_DOT_C
1904
1905 STATIC bool
1906 S_is_ssc_worth_it(const RExC_state_t * pRExC_state, const regnode_ssc * ssc)
1907 {
1908     /* The synthetic start class is used to hopefully quickly winnow down
1909      * places where a pattern could start a match in the target string.  If it
1910      * doesn't really narrow things down that much, there isn't much point to
1911      * having the overhead of using it.  This function uses some very crude
1912      * heuristics to decide if to use the ssc or not.
1913      *
1914      * It returns TRUE if 'ssc' rules out more than half what it considers to
1915      * be the "likely" possible matches, but of course it doesn't know what the
1916      * actual things being matched are going to be; these are only guesses
1917      *
1918      * For /l matches, it assumes that the only likely matches are going to be
1919      *      in the 0-255 range, uniformly distributed, so half of that is 127
1920      * For /a and /d matches, it assumes that the likely matches will be just
1921      *      the ASCII range, so half of that is 63
1922      * For /u and there isn't anything matching above the Latin1 range, it
1923      *      assumes that that is the only range likely to be matched, and uses
1924      *      half that as the cut-off: 127.  If anything matches above Latin1,
1925      *      it assumes that all of Unicode could match (uniformly), except for
1926      *      non-Unicode code points and things in the General Category "Other"
1927      *      (unassigned, private use, surrogates, controls and formats).  This
1928      *      is a much large number. */
1929
1930     U32 count = 0;      /* Running total of number of code points matched by
1931                            'ssc' */
1932     UV start, end;      /* Start and end points of current range in inversion
1933                            list */
1934     const U32 max_code_points = (LOC)
1935                                 ?  256
1936                                 : ((   ! UNI_SEMANTICS
1937                                      || invlist_highest(ssc->invlist) < 256)
1938                                   ? 128
1939                                   : NON_OTHER_COUNT);
1940     const U32 max_match = max_code_points / 2;
1941
1942     PERL_ARGS_ASSERT_IS_SSC_WORTH_IT;
1943
1944     invlist_iterinit(ssc->invlist);
1945     while (invlist_iternext(ssc->invlist, &start, &end)) {
1946         if (start >= max_code_points) {
1947             break;
1948         }
1949         end = MIN(end, max_code_points - 1);
1950         count += end - start + 1;
1951         if (count >= max_match) {
1952             invlist_iterfinish(ssc->invlist);
1953             return FALSE;
1954         }
1955     }
1956
1957     return TRUE;
1958 }
1959
1960
1961 STATIC void
1962 S_ssc_finalize(pTHX_ RExC_state_t *pRExC_state, regnode_ssc *ssc)
1963 {
1964     /* The inversion list in the SSC is marked mortal; now we need a more
1965      * permanent copy, which is stored the same way that is done in a regular
1966      * ANYOF node, with the first NUM_ANYOF_CODE_POINTS code points in a bit
1967      * map */
1968
1969     SV* invlist = invlist_clone(ssc->invlist);
1970
1971     PERL_ARGS_ASSERT_SSC_FINALIZE;
1972
1973     assert(is_ANYOF_SYNTHETIC(ssc));
1974
1975     /* The code in this file assumes that all but these flags aren't relevant
1976      * to the SSC, except SSC_MATCHES_EMPTY_STRING, which should be cleared
1977      * by the time we reach here */
1978     assert(! (ANYOF_FLAGS(ssc)
1979         & ~( ANYOF_COMMON_FLAGS
1980             |ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER
1981             |ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP)));
1982
1983     populate_ANYOF_from_invlist( (regnode *) ssc, &invlist);
1984
1985     set_ANYOF_arg(pRExC_state, (regnode *) ssc, invlist,
1986                                 NULL, NULL, NULL, FALSE);
1987
1988     /* Make sure is clone-safe */
1989     ssc->invlist = NULL;
1990
1991     if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
1992         ANYOF_FLAGS(ssc) |= ANYOF_MATCHES_POSIXL;
1993     }
1994
1995     if (RExC_contains_locale) {
1996         OP(ssc) = ANYOFL;
1997     }
1998
1999     assert(! (ANYOF_FLAGS(ssc) & ANYOF_LOCALE_FLAGS) || RExC_contains_locale);
2000 }
2001
2002 #define TRIE_LIST_ITEM(state,idx) (trie->states[state].trans.list)[ idx ]
2003 #define TRIE_LIST_CUR(state)  ( TRIE_LIST_ITEM( state, 0 ).forid )
2004 #define TRIE_LIST_LEN(state) ( TRIE_LIST_ITEM( state, 0 ).newstate )
2005 #define TRIE_LIST_USED(idx)  ( trie->states[state].trans.list         \
2006                                ? (TRIE_LIST_CUR( idx ) - 1)           \
2007                                : 0 )
2008
2009
2010 #ifdef DEBUGGING
2011 /*
2012    dump_trie(trie,widecharmap,revcharmap)
2013    dump_trie_interim_list(trie,widecharmap,revcharmap,next_alloc)
2014    dump_trie_interim_table(trie,widecharmap,revcharmap,next_alloc)
2015
2016    These routines dump out a trie in a somewhat readable format.
2017    The _interim_ variants are used for debugging the interim
2018    tables that are used to generate the final compressed
2019    representation which is what dump_trie expects.
2020
2021    Part of the reason for their existence is to provide a form
2022    of documentation as to how the different representations function.
2023
2024 */
2025
2026 /*
2027   Dumps the final compressed table form of the trie to Perl_debug_log.
2028   Used for debugging make_trie().
2029 */
2030
2031 STATIC void
2032 S_dump_trie(pTHX_ const struct _reg_trie_data *trie, HV *widecharmap,
2033             AV *revcharmap, U32 depth)
2034 {
2035     U32 state;
2036     SV *sv=sv_newmortal();
2037     int colwidth= widecharmap ? 6 : 4;
2038     U16 word;
2039     GET_RE_DEBUG_FLAGS_DECL;
2040
2041     PERL_ARGS_ASSERT_DUMP_TRIE;
2042
2043     Perl_re_indentf( aTHX_  "Char : %-6s%-6s%-4s ",
2044         depth+1, "Match","Base","Ofs" );
2045
2046     for( state = 0 ; state < trie->uniquecharcount ; state++ ) {
2047         SV ** const tmp = av_fetch( revcharmap, state, 0);
2048         if ( tmp ) {
2049             Perl_re_printf( aTHX_  "%*s",
2050                 colwidth,
2051                 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth,
2052                             PL_colors[0], PL_colors[1],
2053                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
2054                             PERL_PV_ESCAPE_FIRSTCHAR
2055                 )
2056             );
2057         }
2058     }
2059     Perl_re_printf( aTHX_  "\n");
2060     Perl_re_indentf( aTHX_ "State|-----------------------", depth+1);
2061
2062     for( state = 0 ; state < trie->uniquecharcount ; state++ )
2063         Perl_re_printf( aTHX_  "%.*s", colwidth, "--------");
2064     Perl_re_printf( aTHX_  "\n");
2065
2066     for( state = 1 ; state < trie->statecount ; state++ ) {
2067         const U32 base = trie->states[ state ].trans.base;
2068
2069         Perl_re_indentf( aTHX_  "#%4" UVXf "|", depth+1, (UV)state);
2070
2071         if ( trie->states[ state ].wordnum ) {
2072             Perl_re_printf( aTHX_  " W%4X", trie->states[ state ].wordnum );
2073         } else {
2074             Perl_re_printf( aTHX_  "%6s", "" );
2075         }
2076
2077         Perl_re_printf( aTHX_  " @%4" UVXf " ", (UV)base );
2078
2079         if ( base ) {
2080             U32 ofs = 0;
2081
2082             while( ( base + ofs  < trie->uniquecharcount ) ||
2083                    ( base + ofs - trie->uniquecharcount < trie->lasttrans
2084                      && trie->trans[ base + ofs - trie->uniquecharcount ].check
2085                                                                     != state))
2086                     ofs++;
2087
2088             Perl_re_printf( aTHX_  "+%2" UVXf "[ ", (UV)ofs);
2089
2090             for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
2091                 if ( ( base + ofs >= trie->uniquecharcount )
2092                         && ( base + ofs - trie->uniquecharcount
2093                                                         < trie->lasttrans )
2094                         && trie->trans[ base + ofs
2095                                     - trie->uniquecharcount ].check == state )
2096                 {
2097                    Perl_re_printf( aTHX_  "%*" UVXf, colwidth,
2098                     (UV)trie->trans[ base + ofs - trie->uniquecharcount ].next
2099                    );
2100                 } else {
2101                     Perl_re_printf( aTHX_  "%*s",colwidth,"   ." );
2102                 }
2103             }
2104
2105             Perl_re_printf( aTHX_  "]");
2106
2107         }
2108         Perl_re_printf( aTHX_  "\n" );
2109     }
2110     Perl_re_indentf( aTHX_  "word_info N:(prev,len)=",
2111                                 depth);
2112     for (word=1; word <= trie->wordcount; word++) {
2113         Perl_re_printf( aTHX_  " %d:(%d,%d)",
2114             (int)word, (int)(trie->wordinfo[word].prev),
2115             (int)(trie->wordinfo[word].len));
2116     }
2117     Perl_re_printf( aTHX_  "\n" );
2118 }
2119 /*
2120   Dumps a fully constructed but uncompressed trie in list form.
2121   List tries normally only are used for construction when the number of
2122   possible chars (trie->uniquecharcount) is very high.
2123   Used for debugging make_trie().
2124 */
2125 STATIC void
2126 S_dump_trie_interim_list(pTHX_ const struct _reg_trie_data *trie,
2127                          HV *widecharmap, AV *revcharmap, U32 next_alloc,
2128                          U32 depth)
2129 {
2130     U32 state;
2131     SV *sv=sv_newmortal();
2132     int colwidth= widecharmap ? 6 : 4;
2133     GET_RE_DEBUG_FLAGS_DECL;
2134
2135     PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_LIST;
2136
2137     /* print out the table precompression.  */
2138     Perl_re_indentf( aTHX_  "State :Word | Transition Data\n",
2139             depth+1 );
2140     Perl_re_indentf( aTHX_  "%s",
2141             depth+1, "------:-----+-----------------\n" );
2142
2143     for( state=1 ; state < next_alloc ; state ++ ) {
2144         U16 charid;
2145
2146         Perl_re_indentf( aTHX_  " %4" UVXf " :",
2147             depth+1, (UV)state  );
2148         if ( ! trie->states[ state ].wordnum ) {
2149             Perl_re_printf( aTHX_  "%5s| ","");
2150         } else {
2151             Perl_re_printf( aTHX_  "W%4x| ",
2152                 trie->states[ state ].wordnum
2153             );
2154         }
2155         for( charid = 1 ; charid <= TRIE_LIST_USED( state ) ; charid++ ) {
2156             SV ** const tmp = av_fetch( revcharmap,
2157                                         TRIE_LIST_ITEM(state,charid).forid, 0);
2158             if ( tmp ) {
2159                 Perl_re_printf( aTHX_  "%*s:%3X=%4" UVXf " | ",
2160                     colwidth,
2161                     pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp),
2162                               colwidth,
2163                               PL_colors[0], PL_colors[1],
2164                               (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0)
2165                               | PERL_PV_ESCAPE_FIRSTCHAR
2166                     ) ,
2167                     TRIE_LIST_ITEM(state,charid).forid,
2168                     (UV)TRIE_LIST_ITEM(state,charid).newstate
2169                 );
2170                 if (!(charid % 10))
2171                     Perl_re_printf( aTHX_  "\n%*s| ",
2172                         (int)((depth * 2) + 14), "");
2173             }
2174         }
2175         Perl_re_printf( aTHX_  "\n");
2176     }
2177 }
2178
2179 /*
2180   Dumps a fully constructed but uncompressed trie in table form.
2181   This is the normal DFA style state transition table, with a few
2182   twists to facilitate compression later.
2183   Used for debugging make_trie().
2184 */
2185 STATIC void
2186 S_dump_trie_interim_table(pTHX_ const struct _reg_trie_data *trie,
2187                           HV *widecharmap, AV *revcharmap, U32 next_alloc,
2188                           U32 depth)
2189 {
2190     U32 state;
2191     U16 charid;
2192     SV *sv=sv_newmortal();
2193     int colwidth= widecharmap ? 6 : 4;
2194     GET_RE_DEBUG_FLAGS_DECL;
2195
2196     PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_TABLE;
2197
2198     /*
2199        print out the table precompression so that we can do a visual check
2200        that they are identical.
2201      */
2202
2203     Perl_re_indentf( aTHX_  "Char : ", depth+1 );
2204
2205     for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
2206         SV ** const tmp = av_fetch( revcharmap, charid, 0);
2207         if ( tmp ) {
2208             Perl_re_printf( aTHX_  "%*s",
2209                 colwidth,
2210                 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth,
2211                             PL_colors[0], PL_colors[1],
2212                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
2213                             PERL_PV_ESCAPE_FIRSTCHAR
2214                 )
2215             );
2216         }
2217     }
2218
2219     Perl_re_printf( aTHX_ "\n");
2220     Perl_re_indentf( aTHX_  "State+-", depth+1 );
2221
2222     for( charid=0 ; charid < trie->uniquecharcount ; charid++ ) {
2223         Perl_re_printf( aTHX_  "%.*s", colwidth,"--------");
2224     }
2225
2226     Perl_re_printf( aTHX_  "\n" );
2227
2228     for( state=1 ; state < next_alloc ; state += trie->uniquecharcount ) {
2229
2230         Perl_re_indentf( aTHX_  "%4" UVXf " : ",
2231             depth+1,
2232             (UV)TRIE_NODENUM( state ) );
2233
2234         for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
2235             UV v=(UV)SAFE_TRIE_NODENUM( trie->trans[ state + charid ].next );
2236             if (v)
2237                 Perl_re_printf( aTHX_  "%*" UVXf, colwidth, v );
2238             else
2239                 Perl_re_printf( aTHX_  "%*s", colwidth, "." );
2240         }
2241         if ( ! trie->states[ TRIE_NODENUM( state ) ].wordnum ) {
2242             Perl_re_printf( aTHX_  " (%4" UVXf ")\n",
2243                                             (UV)trie->trans[ state ].check );
2244         } else {
2245             Perl_re_printf( aTHX_  " (%4" UVXf ") W%4X\n",
2246                                             (UV)trie->trans[ state ].check,
2247             trie->states[ TRIE_NODENUM( state ) ].wordnum );
2248         }
2249     }
2250 }
2251
2252 #endif
2253
2254
2255 /* make_trie(startbranch,first,last,tail,word_count,flags,depth)
2256   startbranch: the first branch in the whole branch sequence
2257   first      : start branch of sequence of branch-exact nodes.
2258                May be the same as startbranch
2259   last       : Thing following the last branch.
2260                May be the same as tail.
2261   tail       : item following the branch sequence
2262   count      : words in the sequence
2263   flags      : currently the OP() type we will be building one of /EXACT(|F|FA|FU|FU_SS|L|FLU8)/
2264   depth      : indent depth
2265
2266 Inplace optimizes a sequence of 2 or more Branch-Exact nodes into a TRIE node.
2267
2268 A trie is an N'ary tree where the branches are determined by digital
2269 decomposition of the key. IE, at the root node you look up the 1st character and
2270 follow that branch repeat until you find the end of the branches. Nodes can be
2271 marked as "accepting" meaning they represent a complete word. Eg:
2272
2273   /he|she|his|hers/
2274
2275 would convert into the following structure. Numbers represent states, letters
2276 following numbers represent valid transitions on the letter from that state, if
2277 the number is in square brackets it represents an accepting state, otherwise it
2278 will be in parenthesis.
2279
2280       +-h->+-e->[3]-+-r->(8)-+-s->[9]
2281       |    |
2282       |   (2)
2283       |    |
2284      (1)   +-i->(6)-+-s->[7]
2285       |
2286       +-s->(3)-+-h->(4)-+-e->[5]
2287
2288       Accept Word Mapping: 3=>1 (he),5=>2 (she), 7=>3 (his), 9=>4 (hers)
2289
2290 This shows that when matching against the string 'hers' we will begin at state 1
2291 read 'h' and move to state 2, read 'e' and move to state 3 which is accepting,
2292 then read 'r' and go to state 8 followed by 's' which takes us to state 9 which
2293 is also accepting. Thus we know that we can match both 'he' and 'hers' with a
2294 single traverse. We store a mapping from accepting to state to which word was
2295 matched, and then when we have multiple possibilities we try to complete the
2296 rest of the regex in the order in which they occurred in the alternation.
2297
2298 The only prior NFA like behaviour that would be changed by the TRIE support is
2299 the silent ignoring of duplicate alternations which are of the form:
2300
2301  / (DUPE|DUPE) X? (?{ ... }) Y /x
2302
2303 Thus EVAL blocks following a trie may be called a different number of times with
2304 and without the optimisation. With the optimisations dupes will be silently
2305 ignored. This inconsistent behaviour of EVAL type nodes is well established as
2306 the following demonstrates:
2307
2308  'words'=~/(word|word|word)(?{ print $1 })[xyz]/
2309
2310 which prints out 'word' three times, but
2311
2312  'words'=~/(word|word|word)(?{ print $1 })S/
2313
2314 which doesnt print it out at all. This is due to other optimisations kicking in.
2315
2316 Example of what happens on a structural level:
2317
2318 The regexp /(ac|ad|ab)+/ will produce the following debug output:
2319
2320    1: CURLYM[1] {1,32767}(18)
2321    5:   BRANCH(8)
2322    6:     EXACT <ac>(16)
2323    8:   BRANCH(11)
2324    9:     EXACT <ad>(16)
2325   11:   BRANCH(14)
2326   12:     EXACT <ab>(16)
2327   16:   SUCCEED(0)
2328   17:   NOTHING(18)
2329   18: END(0)
2330
2331 This would be optimizable with startbranch=5, first=5, last=16, tail=16
2332 and should turn into:
2333
2334    1: CURLYM[1] {1,32767}(18)
2335    5:   TRIE(16)
2336         [Words:3 Chars Stored:6 Unique Chars:4 States:5 NCP:1]
2337           <ac>
2338           <ad>
2339           <ab>
2340   16:   SUCCEED(0)
2341   17:   NOTHING(18)
2342   18: END(0)
2343
2344 Cases where tail != last would be like /(?foo|bar)baz/:
2345
2346    1: BRANCH(4)
2347    2:   EXACT <foo>(8)
2348    4: BRANCH(7)
2349    5:   EXACT <bar>(8)
2350    7: TAIL(8)
2351    8: EXACT <baz>(10)
2352   10: END(0)
2353
2354 which would be optimizable with startbranch=1, first=1, last=7, tail=8
2355 and would end up looking like:
2356
2357     1: TRIE(8)
2358       [Words:2 Chars Stored:6 Unique Chars:5 States:7 NCP:1]
2359         <foo>
2360         <bar>
2361    7: TAIL(8)
2362    8: EXACT <baz>(10)
2363   10: END(0)
2364
2365     d = uvchr_to_utf8_flags(d, uv, 0);
2366
2367 is the recommended Unicode-aware way of saying
2368
2369     *(d++) = uv;
2370 */
2371
2372 #define TRIE_STORE_REVCHAR(val)                                            \
2373     STMT_START {                                                           \
2374         if (UTF) {                                                         \
2375             SV *zlopp = newSV(UTF8_MAXBYTES);                              \
2376             unsigned char *flrbbbbb = (unsigned char *) SvPVX(zlopp);      \
2377             unsigned const char *const kapow = uvchr_to_utf8(flrbbbbb, val); \
2378             SvCUR_set(zlopp, kapow - flrbbbbb);                            \
2379             SvPOK_on(zlopp);                                               \
2380             SvUTF8_on(zlopp);                                              \
2381             av_push(revcharmap, zlopp);                                    \
2382         } else {                                                           \
2383             char ooooff = (char)val;                                           \
2384             av_push(revcharmap, newSVpvn(&ooooff, 1));                     \
2385         }                                                                  \
2386         } STMT_END
2387
2388 /* This gets the next character from the input, folding it if not already
2389  * folded. */
2390 #define TRIE_READ_CHAR STMT_START {                                           \
2391     wordlen++;                                                                \
2392     if ( UTF ) {                                                              \
2393         /* if it is UTF then it is either already folded, or does not need    \
2394          * folding */                                                         \
2395         uvc = valid_utf8_to_uvchr( (const U8*) uc, &len);                     \
2396     }                                                                         \
2397     else if (folder == PL_fold_latin1) {                                      \
2398         /* This folder implies Unicode rules, which in the range expressible  \
2399          *  by not UTF is the lower case, with the two exceptions, one of     \
2400          *  which should have been taken care of before calling this */       \
2401         assert(*uc != LATIN_SMALL_LETTER_SHARP_S);                            \
2402         uvc = toLOWER_L1(*uc);                                                \
2403         if (UNLIKELY(uvc == MICRO_SIGN)) uvc = GREEK_SMALL_LETTER_MU;         \
2404         len = 1;                                                              \
2405     } else {                                                                  \
2406         /* raw data, will be folded later if needed */                        \
2407         uvc = (U32)*uc;                                                       \
2408         len = 1;                                                              \
2409     }                                                                         \
2410 } STMT_END
2411
2412
2413
2414 #define TRIE_LIST_PUSH(state,fid,ns) STMT_START {               \
2415     if ( TRIE_LIST_CUR( state ) >=TRIE_LIST_LEN( state ) ) {    \
2416         U32 ging = TRIE_LIST_LEN( state ) * 2;                  \
2417         Renew( trie->states[ state ].trans.list, ging, reg_trie_trans_le ); \
2418         TRIE_LIST_LEN( state ) = ging;                          \
2419     }                                                           \
2420     TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).forid = fid;     \
2421     TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).newstate = ns;   \
2422     TRIE_LIST_CUR( state )++;                                   \
2423 } STMT_END
2424
2425 #define TRIE_LIST_NEW(state) STMT_START {                       \
2426     Newx( trie->states[ state ].trans.list,                     \
2427         4, reg_trie_trans_le );                                 \
2428      TRIE_LIST_CUR( state ) = 1;                                \
2429      TRIE_LIST_LEN( state ) = 4;                                \
2430 } STMT_END
2431
2432 #define TRIE_HANDLE_WORD(state) STMT_START {                    \
2433     U16 dupe= trie->states[ state ].wordnum;                    \
2434     regnode * const noper_next = regnext( noper );              \
2435                                                                 \
2436     DEBUG_r({                                                   \
2437         /* store the word for dumping */                        \
2438         SV* tmp;                                                \
2439         if (OP(noper) != NOTHING)                               \
2440             tmp = newSVpvn_utf8(STRING(noper), STR_LEN(noper), UTF);    \
2441         else                                                    \
2442             tmp = newSVpvn_utf8( "", 0, UTF );                  \
2443         av_push( trie_words, tmp );                             \
2444     });                                                         \
2445                                                                 \
2446     curword++;                                                  \
2447     trie->wordinfo[curword].prev   = 0;                         \
2448     trie->wordinfo[curword].len    = wordlen;                   \
2449     trie->wordinfo[curword].accept = state;                     \
2450                                                                 \
2451     if ( noper_next < tail ) {                                  \
2452         if (!trie->jump)                                        \
2453             trie->jump = (U16 *) PerlMemShared_calloc( word_count + 1, \
2454                                                  sizeof(U16) ); \
2455         trie->jump[curword] = (U16)(noper_next - convert);      \
2456         if (!jumper)                                            \
2457             jumper = noper_next;                                \
2458         if (!nextbranch)                                        \
2459             nextbranch= regnext(cur);                           \
2460     }                                                           \
2461                                                                 \
2462     if ( dupe ) {                                               \
2463         /* It's a dupe. Pre-insert into the wordinfo[].prev   */\
2464         /* chain, so that when the bits of chain are later    */\
2465         /* linked together, the dups appear in the chain      */\
2466         trie->wordinfo[curword].prev = trie->wordinfo[dupe].prev; \
2467         trie->wordinfo[dupe].prev = curword;                    \
2468     } else {                                                    \
2469         /* we haven't inserted this word yet.                */ \
2470         trie->states[ state ].wordnum = curword;                \
2471     }                                                           \
2472 } STMT_END
2473
2474
2475 #define TRIE_TRANS_STATE(state,base,ucharcount,charid,special)          \
2476      ( ( base + charid >=  ucharcount                                   \
2477          && base + charid < ubound                                      \
2478          && state == trie->trans[ base - ucharcount + charid ].check    \
2479          && trie->trans[ base - ucharcount + charid ].next )            \
2480            ? trie->trans[ base - ucharcount + charid ].next             \
2481            : ( state==1 ? special : 0 )                                 \
2482       )
2483
2484 #define TRIE_BITMAP_SET_FOLDED(trie, uvc, folder)           \
2485 STMT_START {                                                \
2486     TRIE_BITMAP_SET(trie, uvc);                             \
2487     /* store the folded codepoint */                        \
2488     if ( folder )                                           \
2489         TRIE_BITMAP_SET(trie, folder[(U8) uvc ]);           \
2490                                                             \
2491     if ( !UTF ) {                                           \
2492         /* store first byte of utf8 representation of */    \
2493         /* variant codepoints */                            \
2494         if (! UVCHR_IS_INVARIANT(uvc)) {                    \
2495             TRIE_BITMAP_SET(trie, UTF8_TWO_BYTE_HI(uvc));   \
2496         }                                                   \
2497     }                                                       \
2498 } STMT_END
2499 #define MADE_TRIE       1
2500 #define MADE_JUMP_TRIE  2
2501 #define MADE_EXACT_TRIE 4
2502
2503 STATIC I32
2504 S_make_trie(pTHX_ RExC_state_t *pRExC_state, regnode *startbranch,
2505                   regnode *first, regnode *last, regnode *tail,
2506                   U32 word_count, U32 flags, U32 depth)
2507 {
2508     /* first pass, loop through and scan words */
2509     reg_trie_data *trie;
2510     HV *widecharmap = NULL;
2511     AV *revcharmap = newAV();
2512     regnode *cur;
2513     STRLEN len = 0;
2514     UV uvc = 0;
2515     U16 curword = 0;
2516     U32 next_alloc = 0;
2517     regnode *jumper = NULL;
2518     regnode *nextbranch = NULL;
2519     regnode *convert = NULL;
2520     U32 *prev_states; /* temp array mapping each state to previous one */
2521     /* we just use folder as a flag in utf8 */
2522     const U8 * folder = NULL;
2523
2524     /* in the below add_data call we are storing either 'tu' or 'tuaa'
2525      * which stands for one trie structure, one hash, optionally followed
2526      * by two arrays */
2527 #ifdef DEBUGGING
2528     const U32 data_slot = add_data( pRExC_state, STR_WITH_LEN("tuaa"));
2529     AV *trie_words = NULL;
2530     /* along with revcharmap, this only used during construction but both are
2531      * useful during debugging so we store them in the struct when debugging.
2532      */
2533 #else
2534     const U32 data_slot = add_data( pRExC_state, STR_WITH_LEN("tu"));
2535     STRLEN trie_charcount=0;
2536 #endif
2537     SV *re_trie_maxbuff;
2538     GET_RE_DEBUG_FLAGS_DECL;
2539
2540     PERL_ARGS_ASSERT_MAKE_TRIE;
2541 #ifndef DEBUGGING
2542     PERL_UNUSED_ARG(depth);
2543 #endif
2544
2545     switch (flags) {
2546         case EXACT: case EXACTL: break;
2547         case EXACTFA:
2548         case EXACTFU_SS:
2549         case EXACTFU:
2550         case EXACTFLU8: folder = PL_fold_latin1; break;
2551         case EXACTF:  folder = PL_fold; break;
2552         default: Perl_croak( aTHX_ "panic! In trie construction, unknown node type %u %s", (unsigned) flags, PL_reg_name[flags] );
2553     }
2554
2555     trie = (reg_trie_data *) PerlMemShared_calloc( 1, sizeof(reg_trie_data) );
2556     trie->refcount = 1;
2557     trie->startstate = 1;
2558     trie->wordcount = word_count;
2559     RExC_rxi->data->data[ data_slot ] = (void*)trie;
2560     trie->charmap = (U16 *) PerlMemShared_calloc( 256, sizeof(U16) );
2561     if (flags == EXACT || flags == EXACTL)
2562         trie->bitmap = (char *) PerlMemShared_calloc( ANYOF_BITMAP_SIZE, 1 );
2563     trie->wordinfo = (reg_trie_wordinfo *) PerlMemShared_calloc(
2564                        trie->wordcount+1, sizeof(reg_trie_wordinfo));
2565
2566     DEBUG_r({
2567         trie_words = newAV();
2568     });
2569
2570     re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
2571     assert(re_trie_maxbuff);
2572     if (!SvIOK(re_trie_maxbuff)) {
2573         sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
2574     }
2575     DEBUG_TRIE_COMPILE_r({
2576         Perl_re_indentf( aTHX_
2577           "make_trie start==%d, first==%d, last==%d, tail==%d depth=%d\n",
2578           depth+1,
2579           REG_NODE_NUM(startbranch),REG_NODE_NUM(first),
2580           REG_NODE_NUM(last), REG_NODE_NUM(tail), (int)depth);
2581     });
2582
2583    /* Find the node we are going to overwrite */
2584     if ( first == startbranch && OP( last ) != BRANCH ) {
2585         /* whole branch chain */
2586         convert = first;
2587     } else {
2588         /* branch sub-chain */
2589         convert = NEXTOPER( first );
2590     }
2591
2592     /*  -- First loop and Setup --
2593
2594        We first traverse the branches and scan each word to determine if it
2595        contains widechars, and how many unique chars there are, this is
2596        important as we have to build a table with at least as many columns as we
2597        have unique chars.
2598
2599        We use an array of integers to represent the character codes 0..255
2600        (trie->charmap) and we use a an HV* to store Unicode characters. We use
2601        the native representation of the character value as the key and IV's for
2602        the coded index.
2603
2604        *TODO* If we keep track of how many times each character is used we can
2605        remap the columns so that the table compression later on is more
2606        efficient in terms of memory by ensuring the most common value is in the
2607        middle and the least common are on the outside.  IMO this would be better
2608        than a most to least common mapping as theres a decent chance the most
2609        common letter will share a node with the least common, meaning the node
2610        will not be compressible. With a middle is most common approach the worst
2611        case is when we have the least common nodes twice.
2612
2613      */
2614
2615     for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
2616         regnode *noper = NEXTOPER( cur );
2617         const U8 *uc;
2618         const U8 *e;
2619         int foldlen = 0;
2620         U32 wordlen      = 0;         /* required init */
2621         STRLEN minchars = 0;
2622         STRLEN maxchars = 0;
2623         bool set_bit = trie->bitmap ? 1 : 0; /*store the first char in the
2624                                                bitmap?*/
2625
2626         if (OP(noper) == NOTHING) {
2627             /* skip past a NOTHING at the start of an alternation
2628              * eg, /(?:)a|(?:b)/ should be the same as /a|b/
2629              */
2630             regnode *noper_next= regnext(noper);
2631             if (noper_next < tail)
2632                 noper= noper_next;
2633         }
2634
2635         if ( noper < tail &&
2636                 (
2637                     OP(noper) == flags ||
2638                     (
2639                         flags == EXACTFU &&
2640                         OP(noper) == EXACTFU_SS
2641                     )
2642                 )
2643         ) {
2644             uc= (U8*)STRING(noper);
2645             e= uc + STR_LEN(noper);
2646         } else {
2647             trie->minlen= 0;
2648             continue;
2649         }
2650
2651
2652         if ( set_bit ) { /* bitmap only alloced when !(UTF&&Folding) */
2653             TRIE_BITMAP_SET(trie,*uc); /* store the raw first byte
2654                                           regardless of encoding */
2655             if (OP( noper ) == EXACTFU_SS) {
2656                 /* false positives are ok, so just set this */
2657                 TRIE_BITMAP_SET(trie, LATIN_SMALL_LETTER_SHARP_S);
2658             }
2659         }
2660
2661         for ( ; uc < e ; uc += len ) {  /* Look at each char in the current
2662                                            branch */
2663             TRIE_CHARCOUNT(trie)++;
2664             TRIE_READ_CHAR;
2665
2666             /* TRIE_READ_CHAR returns the current character, or its fold if /i
2667              * is in effect.  Under /i, this character can match itself, or
2668              * anything that folds to it.  If not under /i, it can match just
2669              * itself.  Most folds are 1-1, for example k, K, and KELVIN SIGN
2670              * all fold to k, and all are single characters.   But some folds
2671              * expand to more than one character, so for example LATIN SMALL
2672              * LIGATURE FFI folds to the three character sequence 'ffi'.  If
2673              * the string beginning at 'uc' is 'ffi', it could be matched by
2674              * three characters, or just by the one ligature character. (It
2675              * could also be matched by two characters: LATIN SMALL LIGATURE FF
2676              * followed by 'i', or by 'f' followed by LATIN SMALL LIGATURE FI).
2677              * (Of course 'I' and/or 'F' instead of 'i' and 'f' can also
2678              * match.)  The trie needs to know the minimum and maximum number
2679              * of characters that could match so that it can use size alone to
2680              * quickly reject many match attempts.  The max is simple: it is
2681              * the number of folded characters in this branch (since a fold is
2682              * never shorter than what folds to it. */
2683
2684             maxchars++;
2685
2686             /* And the min is equal to the max if not under /i (indicated by
2687              * 'folder' being NULL), or there are no multi-character folds.  If
2688              * there is a multi-character fold, the min is incremented just
2689              * once, for the character that folds to the sequence.  Each
2690              * character in the sequence needs to be added to the list below of
2691              * characters in the trie, but we count only the first towards the
2692              * min number of characters needed.  This is done through the
2693              * variable 'foldlen', which is returned by the macros that look
2694              * for these sequences as the number of bytes the sequence
2695              * occupies.  Each time through the loop, we decrement 'foldlen' by
2696              * how many bytes the current char occupies.  Only when it reaches
2697              * 0 do we increment 'minchars' or look for another multi-character
2698              * sequence. */
2699             if (folder == NULL) {
2700                 minchars++;
2701             }
2702             else if (foldlen > 0) {
2703                 foldlen -= (UTF) ? UTF8SKIP(uc) : 1;
2704             }
2705             else {
2706                 minchars++;
2707
2708                 /* See if *uc is the beginning of a multi-character fold.  If
2709                  * so, we decrement the length remaining to look at, to account
2710                  * for the current character this iteration.  (We can use 'uc'
2711                  * instead of the fold returned by TRIE_READ_CHAR because for
2712                  * non-UTF, the latin1_safe macro is smart enough to account
2713                  * for all the unfolded characters, and because for UTF, the
2714                  * string will already have been folded earlier in the
2715                  * compilation process */
2716                 if (UTF) {
2717                     if ((foldlen = is_MULTI_CHAR_FOLD_utf8_safe(uc, e))) {
2718                         foldlen -= UTF8SKIP(uc);
2719                     }
2720                 }
2721                 else if ((foldlen = is_MULTI_CHAR_FOLD_latin1_safe(uc, e))) {
2722                     foldlen--;
2723                 }
2724             }
2725
2726             /* The current character (and any potential folds) should be added
2727              * to the possible matching characters for this position in this
2728              * branch */
2729             if ( uvc < 256 ) {
2730                 if ( folder ) {
2731                     U8 folded= folder[ (U8) uvc ];
2732                     if ( !trie->charmap[ folded ] ) {
2733                         trie->charmap[ folded ]=( ++trie->uniquecharcount );
2734                         TRIE_STORE_REVCHAR( folded );
2735                     }
2736                 }
2737                 if ( !trie->charmap[ uvc ] ) {
2738                     trie->charmap[ uvc ]=( ++trie->uniquecharcount );
2739                     TRIE_STORE_REVCHAR( uvc );
2740                 }
2741                 if ( set_bit ) {
2742                     /* store the codepoint in the bitmap, and its folded
2743                      * equivalent. */
2744                     TRIE_BITMAP_SET_FOLDED(trie, uvc, folder);
2745                     set_bit = 0; /* We've done our bit :-) */
2746                 }
2747             } else {
2748
2749                 /* XXX We could come up with the list of code points that fold
2750                  * to this using PL_utf8_foldclosures, except not for
2751                  * multi-char folds, as there may be multiple combinations
2752                  * there that could work, which needs to wait until runtime to
2753                  * resolve (The comment about LIGATURE FFI above is such an
2754                  * example */
2755
2756                 SV** svpp;
2757                 if ( !widecharmap )
2758                     widecharmap = newHV();
2759
2760                 svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 1 );
2761
2762                 if ( !svpp )
2763                     Perl_croak( aTHX_ "error creating/fetching widecharmap entry for 0x%" UVXf, uvc );
2764
2765                 if ( !SvTRUE( *svpp ) ) {
2766                     sv_setiv( *svpp, ++trie->uniquecharcount );
2767                     TRIE_STORE_REVCHAR(uvc);
2768                 }
2769             }
2770         } /* end loop through characters in this branch of the trie */
2771
2772         /* We take the min and max for this branch and combine to find the min
2773          * and max for all branches processed so far */
2774         if( cur == first ) {
2775             trie->minlen = minchars;
2776             trie->maxlen = maxchars;
2777         } else if (minchars < trie->minlen) {
2778             trie->minlen = minchars;
2779         } else if (maxchars > trie->maxlen) {
2780             trie->maxlen = maxchars;
2781         }
2782     } /* end first pass */
2783     DEBUG_TRIE_COMPILE_r(
2784         Perl_re_indentf( aTHX_
2785                 "TRIE(%s): W:%d C:%d Uq:%d Min:%d Max:%d\n",
2786                 depth+1,
2787                 ( widecharmap ? "UTF8" : "NATIVE" ), (int)word_count,
2788                 (int)TRIE_CHARCOUNT(trie), trie->uniquecharcount,
2789                 (int)trie->minlen, (int)trie->maxlen )
2790     );
2791
2792     /*
2793         We now know what we are dealing with in terms of unique chars and
2794         string sizes so we can calculate how much memory a naive
2795         representation using a flat table  will take. If it's over a reasonable
2796         limit (as specified by ${^RE_TRIE_MAXBUF}) we use a more memory
2797         conservative but potentially much slower representation using an array
2798         of lists.
2799
2800         At the end we convert both representations into the same compressed
2801         form that will be used in regexec.c for matching with. The latter
2802         is a form that cannot be used to construct with but has memory
2803         properties similar to the list form and access properties similar
2804         to the table form making it both suitable for fast searches and
2805         small enough that its feasable to store for the duration of a program.
2806
2807         See the comment in the code where the compressed table is produced
2808         inplace from the flat tabe representation for an explanation of how
2809         the compression works.
2810
2811     */
2812
2813
2814     Newx(prev_states, TRIE_CHARCOUNT(trie) + 2, U32);
2815     prev_states[1] = 0;
2816
2817     if ( (IV)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1)
2818                                                     > SvIV(re_trie_maxbuff) )
2819     {
2820         /*
2821             Second Pass -- Array Of Lists Representation
2822
2823             Each state will be represented by a list of charid:state records
2824             (reg_trie_trans_le) the first such element holds the CUR and LEN
2825             points of the allocated array. (See defines above).
2826
2827             We build the initial structure using the lists, and then convert
2828             it into the compressed table form which allows faster lookups
2829             (but cant be modified once converted).
2830         */
2831
2832         STRLEN transcount = 1;
2833
2834         DEBUG_TRIE_COMPILE_MORE_r( Perl_re_indentf( aTHX_  "Compiling trie using list compiler\n",
2835             depth+1));
2836
2837         trie->states = (reg_trie_state *)
2838             PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
2839                                   sizeof(reg_trie_state) );
2840         TRIE_LIST_NEW(1);
2841         next_alloc = 2;
2842
2843         for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
2844
2845             regnode *noper   = NEXTOPER( cur );
2846             U32 state        = 1;         /* required init */
2847             U16 charid       = 0;         /* sanity init */
2848             U32 wordlen      = 0;         /* required init */
2849
2850             if (OP(noper) == NOTHING) {
2851                 regnode *noper_next= regnext(noper);
2852                 if (noper_next < tail)
2853                     noper= noper_next;
2854             }
2855
2856             if ( noper < tail && ( OP(noper) == flags || ( flags == EXACTFU && OP(noper) == EXACTFU_SS ) ) ) {
2857                 const U8 *uc= (U8*)STRING(noper);
2858                 const U8 *e= uc + STR_LEN(noper);
2859
2860                 for ( ; uc < e ; uc += len ) {
2861
2862                     TRIE_READ_CHAR;
2863
2864                     if ( uvc < 256 ) {
2865                         charid = trie->charmap[ uvc ];
2866                     } else {
2867                         SV** const svpp = hv_fetch( widecharmap,
2868                                                     (char*)&uvc,
2869                                                     sizeof( UV ),
2870                                                     0);
2871                         if ( !svpp ) {
2872                             charid = 0;
2873                         } else {
2874                             charid=(U16)SvIV( *svpp );
2875                         }
2876                     }
2877                     /* charid is now 0 if we dont know the char read, or
2878                      * nonzero if we do */
2879                     if ( charid ) {
2880
2881                         U16 check;
2882                         U32 newstate = 0;
2883
2884                         charid--;
2885                         if ( !trie->states[ state ].trans.list ) {
2886                             TRIE_LIST_NEW( state );
2887                         }
2888                         for ( check = 1;
2889                               check <= TRIE_LIST_USED( state );
2890                               check++ )
2891                         {
2892                             if ( TRIE_LIST_ITEM( state, check ).forid
2893                                                                     == charid )
2894                             {
2895                                 newstate = TRIE_LIST_ITEM( state, check ).newstate;
2896                                 break;
2897                             }
2898                         }
2899                         if ( ! newstate ) {
2900                             newstate = next_alloc++;
2901                             prev_states[newstate] = state;
2902                             TRIE_LIST_PUSH( state, charid, newstate );
2903                             transcount++;
2904                         }
2905                         state = newstate;
2906                     } else {
2907                         Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %" IVdf, uvc );
2908                     }
2909                 }
2910             }
2911             TRIE_HANDLE_WORD(state);
2912
2913         } /* end second pass */
2914
2915         /* next alloc is the NEXT state to be allocated */
2916         trie->statecount = next_alloc;
2917         trie->states = (reg_trie_state *)
2918             PerlMemShared_realloc( trie->states,
2919                                    next_alloc
2920                                    * sizeof(reg_trie_state) );
2921
2922         /* and now dump it out before we compress it */
2923         DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_list(trie, widecharmap,
2924                                                          revcharmap, next_alloc,
2925                                                          depth+1)
2926         );
2927
2928         trie->trans = (reg_trie_trans *)
2929             PerlMemShared_calloc( transcount, sizeof(reg_trie_trans) );
2930         {
2931             U32 state;
2932             U32 tp = 0;
2933             U32 zp = 0;
2934
2935
2936             for( state=1 ; state < next_alloc ; state ++ ) {
2937                 U32 base=0;
2938
2939                 /*
2940                 DEBUG_TRIE_COMPILE_MORE_r(
2941                     Perl_re_printf( aTHX_  "tp: %d zp: %d ",tp,zp)
2942                 );
2943                 */
2944
2945                 if (trie->states[state].trans.list) {
2946                     U16 minid=TRIE_LIST_ITEM( state, 1).forid;
2947                     U16 maxid=minid;
2948                     U16 idx;
2949
2950                     for( idx = 2 ; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
2951                         const U16 forid = TRIE_LIST_ITEM( state, idx).forid;
2952                         if ( forid < minid ) {
2953                             minid=forid;
2954                         } else if ( forid > maxid ) {
2955                             maxid=forid;
2956                         }
2957                     }
2958                     if ( transcount < tp + maxid - minid + 1) {
2959                         transcount *= 2;
2960                         trie->trans = (reg_trie_trans *)
2961                             PerlMemShared_realloc( trie->trans,
2962                                                      transcount
2963                                                      * sizeof(reg_trie_trans) );
2964                         Zero( trie->trans + (transcount / 2),
2965                               transcount / 2,
2966                               reg_trie_trans );
2967                     }
2968                     base = trie->uniquecharcount + tp - minid;
2969                     if ( maxid == minid ) {
2970                         U32 set = 0;
2971                         for ( ; zp < tp ; zp++ ) {
2972                             if ( ! trie->trans[ zp ].next ) {
2973                                 base = trie->uniquecharcount + zp - minid;
2974                                 trie->trans[ zp ].next = TRIE_LIST_ITEM( state,
2975                                                                    1).newstate;
2976                                 trie->trans[ zp ].check = state;
2977                                 set = 1;
2978                                 break;
2979                             }
2980                         }
2981                         if ( !set ) {
2982                             trie->trans[ tp ].next = TRIE_LIST_ITEM( state,
2983                                                                    1).newstate;
2984                             trie->trans[ tp ].check = state;
2985                             tp++;
2986                             zp = tp;
2987                         }
2988                     } else {
2989                         for ( idx=1; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
2990                             const U32 tid = base
2991                                            - trie->uniquecharcount
2992                                            + TRIE_LIST_ITEM( state, idx ).forid;
2993                             trie->trans[ tid ].next = TRIE_LIST_ITEM( state,
2994                                                                 idx ).newstate;
2995                             trie->trans[ tid ].check = state;
2996                         }
2997                         tp += ( maxid - minid + 1 );
2998                     }
2999                     Safefree(trie->states[ state ].trans.list);
3000                 }
3001                 /*
3002                 DEBUG_TRIE_COMPILE_MORE_r(
3003                     Perl_re_printf( aTHX_  " base: %d\n",base);
3004                 );
3005                 */
3006                 trie->states[ state ].trans.base=base;
3007             }
3008             trie->lasttrans = tp + 1;
3009         }
3010     } else {
3011         /*
3012            Second Pass -- Flat Table Representation.
3013
3014            we dont use the 0 slot of either trans[] or states[] so we add 1 to
3015            each.  We know that we will need Charcount+1 trans at most to store
3016            the data (one row per char at worst case) So we preallocate both
3017            structures assuming worst case.
3018
3019            We then construct the trie using only the .next slots of the entry
3020            structs.
3021
3022            We use the .check field of the first entry of the node temporarily
3023            to make compression both faster and easier by keeping track of how
3024            many non zero fields are in the node.
3025
3026            Since trans are numbered from 1 any 0 pointer in the table is a FAIL
3027            transition.
3028
3029            There are two terms at use here: state as a TRIE_NODEIDX() which is
3030            a number representing the first entry of the node, and state as a
3031            TRIE_NODENUM() which is the trans number. state 1 is TRIE_NODEIDX(1)
3032            and TRIE_NODENUM(1), state 2 is TRIE_NODEIDX(2) and TRIE_NODENUM(3)
3033            if there are 2 entrys per node. eg:
3034
3035              A B       A B
3036           1. 2 4    1. 3 7
3037           2. 0 3    3. 0 5
3038           3. 0 0    5. 0 0
3039           4. 0 0    7. 0 0
3040
3041            The table is internally in the right hand, idx form. However as we
3042            also have to deal with the states array which is indexed by nodenum
3043            we have to use TRIE_NODENUM() to convert.
3044
3045         */
3046         DEBUG_TRIE_COMPILE_MORE_r( Perl_re_indentf( aTHX_  "Compiling trie using table compiler\n",
3047             depth+1));
3048
3049         trie->trans = (reg_trie_trans *)
3050             PerlMemShared_calloc( ( TRIE_CHARCOUNT(trie) + 1 )
3051                                   * trie->uniquecharcount + 1,
3052                                   sizeof(reg_trie_trans) );
3053         trie->states = (reg_trie_state *)
3054             PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
3055                                   sizeof(reg_trie_state) );
3056         next_alloc = trie->uniquecharcount + 1;
3057
3058
3059         for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
3060
3061             regnode *noper   = NEXTOPER( cur );
3062
3063             U32 state        = 1;         /* required init */
3064
3065             U16 charid       = 0;         /* sanity init */
3066             U32 accept_state = 0;         /* sanity init */
3067
3068             U32 wordlen      = 0;         /* required init */
3069
3070             if (OP(noper) == NOTHING) {
3071                 regnode *noper_next= regnext(noper);
3072                 if (noper_next < tail)
3073                     noper= noper_next;
3074             }
3075
3076             if ( noper < tail && ( OP(noper) == flags || ( flags == EXACTFU && OP(noper) == EXACTFU_SS ) ) ) {
3077                 const U8 *uc= (U8*)STRING(noper);
3078                 const U8 *e= uc + STR_LEN(noper);
3079
3080                 for ( ; uc < e ; uc += len ) {
3081
3082                     TRIE_READ_CHAR;
3083
3084                     if ( uvc < 256 ) {
3085                         charid = trie->charmap[ uvc ];
3086                     } else {
3087                         SV* const * const svpp = hv_fetch( widecharmap,
3088                                                            (char*)&uvc,
3089                                                            sizeof( UV ),
3090                                                            0);
3091                         charid = svpp ? (U16)SvIV(*svpp) : 0;
3092                     }
3093                     if ( charid ) {
3094                         charid--;
3095                         if ( !trie->trans[ state + charid ].next ) {
3096                             trie->trans[ state + charid ].next = next_alloc;
3097                             trie->trans[ state ].check++;
3098                             prev_states[TRIE_NODENUM(next_alloc)]
3099                                     = TRIE_NODENUM(state);
3100                             next_alloc += trie->uniquecharcount;
3101                         }
3102                         state = trie->trans[ state + charid ].next;
3103                     } else {
3104                         Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %" IVdf, uvc );
3105                     }
3106                     /* charid is now 0 if we dont know the char read, or
3107                      * nonzero if we do */
3108                 }
3109             }
3110             accept_state = TRIE_NODENUM( state );
3111             TRIE_HANDLE_WORD(accept_state);
3112
3113         } /* end second pass */
3114
3115         /* and now dump it out before we compress it */
3116         DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_table(trie, widecharmap,
3117                                                           revcharmap,
3118                                                           next_alloc, depth+1));
3119
3120         {
3121         /*
3122            * Inplace compress the table.*
3123
3124            For sparse data sets the table constructed by the trie algorithm will
3125            be mostly 0/FAIL transitions or to put it another way mostly empty.
3126            (Note that leaf nodes will not contain any transitions.)
3127
3128            This algorithm compresses the tables by eliminating most such
3129            transitions, at the cost of a modest bit of extra work during lookup:
3130
3131            - Each states[] entry contains a .base field which indicates the
3132            index in the state[] array wheres its transition data is stored.
3133
3134            - If .base is 0 there are no valid transitions from that node.
3135
3136            - If .base is nonzero then charid is added to it to find an entry in
3137            the trans array.
3138
3139            -If trans[states[state].base+charid].check!=state then the
3140            transition is taken to be a 0/Fail transition. Thus if there are fail
3141            transitions at the front of the node then the .base offset will point
3142            somewhere inside the previous nodes data (or maybe even into a node
3143            even earlier), but the .check field determines if the transition is
3144            valid.
3145
3146            XXX - wrong maybe?
3147            The following process inplace converts the table to the compressed
3148            table: We first do not compress the root node 1,and mark all its
3149            .check pointers as 1 and set its .base pointer as 1 as well. This
3150            allows us to do a DFA construction from the compressed table later,
3151            and ensures that any .base pointers we calculate later are greater
3152            than 0.
3153
3154            - We set 'pos' to indicate the first entry of the second node.
3155
3156            - We then iterate over the columns of the node, finding the first and
3157            last used entry at l and m. We then copy l..m into pos..(pos+m-l),
3158            and set the .check pointers accordingly, and advance pos
3159            appropriately and repreat for the next node. Note that when we copy
3160            the next pointers we have to convert them from the original
3161            NODEIDX form to NODENUM form as the former is not valid post
3162            compression.
3163
3164            - If a node has no transitions used we mark its base as 0 and do not
3165            advance the pos pointer.
3166
3167            - If a node only has one transition we use a second pointer into the
3168            structure to fill in allocated fail transitions from other states.
3169            This pointer is independent of the main pointer and scans forward
3170            looking for null transitions that are allocated to a state. When it
3171            finds one it writes the single transition into the "hole".  If the
3172            pointer doesnt find one the single transition is appended as normal.
3173
3174            - Once compressed we can Renew/realloc the structures to release the
3175            excess space.
3176
3177            See "Table-Compression Methods" in sec 3.9 of the Red Dragon,
3178            specifically Fig 3.47 and the associated pseudocode.
3179
3180            demq
3181         */
3182         const U32 laststate = TRIE_NODENUM( next_alloc );
3183         U32 state, charid;
3184         U32 pos = 0, zp=0;
3185         trie->statecount = laststate;
3186
3187         for ( state = 1 ; state < laststate ; state++ ) {
3188             U8 flag = 0;
3189             const U32 stateidx = TRIE_NODEIDX( state );
3190             const U32 o_used = trie->trans[ stateidx ].check;
3191             U32 used = trie->trans[ stateidx ].check;
3192             trie->trans[ stateidx ].check = 0;
3193
3194             for ( charid = 0;
3195                   used && charid < trie->uniquecharcount;
3196                   charid++ )
3197             {
3198                 if ( flag || trie->trans[ stateidx + charid ].next ) {
3199                     if ( trie->trans[ stateidx + charid ].next ) {
3200                         if (o_used == 1) {
3201                             for ( ; zp < pos ; zp++ ) {
3202                                 if ( ! trie->trans[ zp ].next ) {
3203                                     break;
3204                                 }
3205                             }
3206                             trie->states[ state ].trans.base
3207                                                     = zp
3208                                                       + trie->uniquecharcount
3209                                                       - charid ;
3210                             trie->trans[ zp ].next
3211                                 = SAFE_TRIE_NODENUM( trie->trans[ stateidx
3212                                                              + charid ].next );
3213                             trie->trans[ zp ].check = state;
3214                             if ( ++zp > pos ) pos = zp;
3215                             break;
3216                         }
3217                         used--;
3218                     }
3219                     if ( !flag ) {
3220                         flag = 1;
3221                         trie->states[ state ].trans.base
3222                                        = pos + trie->uniquecharcount - charid ;
3223                     }
3224                     trie->trans[ pos ].next
3225                         = SAFE_TRIE_NODENUM(
3226                                        trie->trans[ stateidx + charid ].next );
3227                     trie->trans[ pos ].check = state;
3228                     pos++;
3229                 }
3230             }
3231         }
3232         trie->lasttrans = pos + 1;
3233         trie->states = (reg_trie_state *)
3234             PerlMemShared_realloc( trie->states, laststate
3235                                    * sizeof(reg_trie_state) );
3236         DEBUG_TRIE_COMPILE_MORE_r(
3237             Perl_re_indentf( aTHX_  "Alloc: %d Orig: %" IVdf " elements, Final:%" IVdf ". Savings of %%%5.2f\n",
3238                 depth+1,
3239                 (int)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount
3240                        + 1 ),
3241                 (IV)next_alloc,
3242                 (IV)pos,
3243                 ( ( next_alloc - pos ) * 100 ) / (double)next_alloc );
3244             );
3245
3246         } /* end table compress */
3247     }
3248     DEBUG_TRIE_COMPILE_MORE_r(
3249             Perl_re_indentf( aTHX_  "Statecount:%" UVxf " Lasttrans:%" UVxf "\n",
3250                 depth+1,
3251                 (UV)trie->statecount,
3252                 (UV)trie->lasttrans)
3253     );
3254     /* resize the trans array to remove unused space */
3255     trie->trans = (reg_trie_trans *)
3256         PerlMemShared_realloc( trie->trans, trie->lasttrans
3257                                * sizeof(reg_trie_trans) );
3258
3259     {   /* Modify the program and insert the new TRIE node */
3260         U8 nodetype =(U8)(flags & 0xFF);
3261         char *str=NULL;
3262
3263 #ifdef DEBUGGING
3264         regnode *optimize = NULL;
3265 #ifdef RE_TRACK_PATTERN_OFFSETS
3266
3267         U32 mjd_offset = 0;
3268         U32 mjd_nodelen = 0;
3269 #endif /* RE_TRACK_PATTERN_OFFSETS */
3270 #endif /* DEBUGGING */
3271         /*
3272            This means we convert either the first branch or the first Exact,
3273            depending on whether the thing following (in 'last') is a branch
3274            or not and whther first is the startbranch (ie is it a sub part of
3275            the alternation or is it the whole thing.)
3276            Assuming its a sub part we convert the EXACT otherwise we convert
3277            the whole branch sequence, including the first.
3278          */
3279         /* Find the node we are going to overwrite */
3280         if ( first != startbranch || OP( last ) == BRANCH ) {
3281             /* branch sub-chain */
3282             NEXT_OFF( first ) = (U16)(last - first);
3283 #ifdef RE_TRACK_PATTERN_OFFSETS
3284             DEBUG_r({
3285                 mjd_offset= Node_Offset((convert));
3286                 mjd_nodelen= Node_Length((convert));
3287             });
3288 #endif
3289             /* whole branch chain */
3290         }
3291 #ifdef RE_TRACK_PATTERN_OFFSETS
3292         else {
3293             DEBUG_r({
3294                 const  regnode *nop = NEXTOPER( convert );
3295                 mjd_offset= Node_Offset((nop));
3296                 mjd_nodelen= Node_Length((nop));
3297             });
3298         }
3299         DEBUG_OPTIMISE_r(
3300             Perl_re_indentf( aTHX_  "MJD offset:%" UVuf " MJD length:%" UVuf "\n",
3301                 depth+1,
3302                 (UV)mjd_offset, (UV)mjd_nodelen)
3303         );
3304 #endif
3305         /* But first we check to see if there is a common prefix we can
3306            split out as an EXACT and put in front of the TRIE node.  */
3307         trie->startstate= 1;
3308         if ( trie->bitmap && !widecharmap && !trie->jump  ) {
3309             /* we want to find the first state that has more than
3310              * one transition, if that state is not the first state
3311              * then we have a common prefix which we can remove.
3312              */
3313             U32 state;
3314             for ( state = 1 ; state < trie->statecount-1 ; state++ ) {
3315                 U32 ofs = 0;
3316                 I32 first_ofs = -1; /* keeps track of the ofs of the first
3317                                        transition, -1 means none */
3318                 U32 count = 0;
3319                 const U32 base = trie->states[ state ].trans.base;
3320
3321                 /* does this state terminate an alternation? */
3322                 if ( trie->states[state].wordnum )
3323                         count = 1;
3324
3325                 for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
3326                     if ( ( base + ofs >= trie->uniquecharcount ) &&
3327                          ( base + ofs - trie->uniquecharcount < trie->lasttrans ) &&
3328                          trie->trans[ base + ofs - trie->uniquecharcount ].check == state )
3329                     {
3330                         if ( ++count > 1 ) {
3331                             /* we have more than one transition */
3332                             SV **tmp;
3333                             U8 *ch;
3334                             /* if this is the first state there is no common prefix
3335                              * to extract, so we can exit */
3336                             if ( state == 1 ) break;
3337                             tmp = av_fetch( revcharmap, ofs, 0);
3338                             ch = (U8*)SvPV_nolen_const( *tmp );
3339
3340                             /* if we are on count 2 then we need to initialize the
3341                              * bitmap, and store the previous char if there was one
3342                              * in it*/
3343                             if ( count == 2 ) {
3344                                 /* clear the bitmap */
3345                                 Zero(trie->bitmap, ANYOF_BITMAP_SIZE, char);
3346                                 DEBUG_OPTIMISE_r(
3347                                     Perl_re_indentf( aTHX_  "New Start State=%" UVuf " Class: [",
3348                                         depth+1,
3349                                         (UV)state));
3350                                 if (first_ofs >= 0) {
3351                                     SV ** const tmp = av_fetch( revcharmap, first_ofs, 0);
3352                                     const U8 * const ch = (U8*)SvPV_nolen_const( *tmp );
3353
3354                                     TRIE_BITMAP_SET_FOLDED(trie,*ch,folder);
3355                                     DEBUG_OPTIMISE_r(
3356                                         Perl_re_printf( aTHX_  "%s", (char*)ch)
3357                                     );
3358                                 }
3359                             }
3360                             /* store the current firstchar in the bitmap */
3361                             TRIE_BITMAP_SET_FOLDED(trie,*ch,folder);
3362                             DEBUG_OPTIMISE_r(Perl_re_printf( aTHX_ "%s", ch));
3363                         }
3364                         first_ofs = ofs;
3365                     }
3366                 }
3367                 if ( count == 1 ) {
3368                     /* This state has only one transition, its transition is part
3369                      * of a common prefix - we need to concatenate the char it
3370                      * represents to what we have so far. */
3371                     SV **tmp = av_fetch( revcharmap, first_ofs, 0);
3372                     STRLEN len;
3373                     char *ch = SvPV( *tmp, len );
3374                     DEBUG_OPTIMISE_r({
3375                         SV *sv=sv_newmortal();
3376                         Perl_re_indentf( aTHX_  "Prefix State: %" UVuf " Ofs:%" UVuf " Char='%s'\n",
3377                             depth+1,
3378                             (UV)state, (UV)first_ofs,
3379                             pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), 6,
3380                                 PL_colors[0], PL_colors[1],
3381                                 (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
3382                                 PERL_PV_ESCAPE_FIRSTCHAR
3383                             )
3384                         );
3385                     });
3386                     if ( state==1 ) {
3387                         OP( convert ) = nodetype;
3388                         str=STRING(convert);
3389                         STR_LEN(convert)=0;
3390                     }
3391                     STR_LEN(convert) += len;
3392                     while (len--)
3393                         *str++ = *ch++;
3394                 } else {
3395 #ifdef DEBUGGING
3396                     if (state>1)
3397                         DEBUG_OPTIMISE_r(Perl_re_printf( aTHX_ "]\n"));
3398 #endif
3399                     break;
3400                 }
3401             }
3402             trie->prefixlen = (state-1);
3403             if (str) {
3404                 regnode *n = convert+NODE_SZ_STR(convert);
3405                 NEXT_OFF(convert) = NODE_SZ_STR(convert);
3406                 trie->startstate = state;
3407                 trie->minlen -= (state - 1);
3408                 trie->maxlen -= (state - 1);
3409 #ifdef DEBUGGING
3410                /* At least the UNICOS C compiler choked on this
3411                 * being argument to DEBUG_r(), so let's just have
3412                 * it right here. */
3413                if (
3414 #ifdef PERL_EXT_RE_BUILD
3415                    1
3416 #else
3417                    DEBUG_r_TEST
3418 #endif
3419                    ) {
3420                    regnode *fix = convert;
3421                    U32 word = trie->wordcount;
3422                    mjd_nodelen++;
3423                    Set_Node_Offset_Length(convert, mjd_offset, state - 1);
3424                    while( ++fix < n ) {
3425                        Set_Node_Offset_Length(fix, 0, 0);
3426                    }
3427                    while (word--) {
3428                        SV ** const tmp = av_fetch( trie_words, word, 0 );
3429                        if (tmp) {
3430                            if ( STR_LEN(convert) <= SvCUR(*tmp) )
3431                                sv_chop(*tmp, SvPV_nolen(*tmp) + STR_LEN(convert));
3432                            else
3433                                sv_chop(*tmp, SvPV_nolen(*tmp) + SvCUR(*tmp));
3434                        }
3435                    }
3436                }
3437 #endif
3438                 if (trie->maxlen) {
3439                     convert = n;
3440                 } else {
3441                     NEXT_OFF(convert) = (U16)(tail - convert);
3442                     DEBUG_r(optimize= n);
3443                 }
3444             }
3445         }
3446         if (!jumper)
3447             jumper = last;
3448         if ( trie->maxlen ) {
3449             NEXT_OFF( convert ) = (U16)(tail - convert);
3450             ARG_SET( convert, data_slot );
3451             /* Store the offset to the first unabsorbed branch in
3452                jump[0], which is otherwise unused by the jump logic.
3453                We use this when dumping a trie and during optimisation. */
3454             if (trie->jump)
3455                 trie->jump[0] = (U16)(nextbranch - convert);
3456
3457             /* If the start state is not accepting (meaning there is no empty string/NOTHING)
3458              *   and there is a bitmap
3459              *   and the first "jump target" node we found leaves enough room
3460              * then convert the TRIE node into a TRIEC node, with the bitmap
3461              * embedded inline in the opcode - this is hypothetically faster.
3462              */
3463             if ( !trie->states[trie->startstate].wordnum
3464                  && trie->bitmap
3465                  && ( (char *)jumper - (char *)convert) >= (int)sizeof(struct regnode_charclass) )
3466             {
3467                 OP( convert ) = TRIEC;
3468                 Copy(trie->bitmap, ((struct regnode_charclass *)convert)->bitmap, ANYOF_BITMAP_SIZE, char);
3469                 PerlMemShared_free(trie->bitmap);
3470                 trie->bitmap= NULL;
3471             } else
3472                 OP( convert ) = TRIE;
3473
3474             /* store the type in the flags */
3475             convert->flags = nodetype;
3476             DEBUG_r({
3477             optimize = convert
3478                       + NODE_STEP_REGNODE
3479                       + regarglen[ OP( convert ) ];
3480             });
3481             /* XXX We really should free up the resource in trie now,
3482                    as we won't use them - (which resources?) dmq */
3483         }
3484         /* needed for dumping*/
3485         DEBUG_r(if (optimize) {
3486             regnode *opt = convert;
3487
3488             while ( ++opt < optimize) {
3489                 Set_Node_Offset_Length(opt,0,0);
3490             }
3491             /*
3492                 Try to clean up some of the debris left after the
3493                 optimisation.
3494              */
3495             while( optimize < jumper ) {
3496                 mjd_nodelen += Node_Length((optimize));
3497                 OP( optimize ) = OPTIMIZED;
3498                 Set_Node_Offset_Length(optimize,0,0);
3499                 optimize++;
3500             }
3501             Set_Node_Offset_Length(convert,mjd_offset,mjd_nodelen);
3502         });
3503     } /* end node insert */
3504
3505     /*  Finish populating the prev field of the wordinfo array.  Walk back
3506      *  from each accept state until we find another accept state, and if
3507      *  so, point the first word's .prev field at the second word. If the
3508      *  second already has a .prev field set, stop now. This will be the
3509      *  case either if we've already processed that word's accept state,
3510      *  or that state had multiple words, and the overspill words were
3511      *  already linked up earlier.
3512      */
3513     {
3514         U16 word;
3515         U32 state;
3516         U16 prev;
3517
3518         for (word=1; word <= trie->wordcount; word++) {
3519             prev = 0;
3520             if (trie->wordinfo[word].prev)
3521                 continue;
3522             state = trie->wordinfo[word].accept;
3523             while (state) {
3524                 state = prev_states[state];
3525                 if (!state)
3526                     break;
3527                 prev = trie->states[state].wordnum;
3528                 if (prev)
3529                     break;
3530             }
3531             trie->wordinfo[word].prev = prev;
3532         }
3533         Safefree(prev_states);
3534     }
3535
3536
3537     /* and now dump out the compressed format */
3538     DEBUG_TRIE_COMPILE_r(dump_trie(trie, widecharmap, revcharmap, depth+1));
3539
3540     RExC_rxi->data->data[ data_slot + 1 ] = (void*)widecharmap;
3541 #ifdef DEBUGGING
3542     RExC_rxi->data->data[ data_slot + TRIE_WORDS_OFFSET ] = (void*)trie_words;
3543     RExC_rxi->data->data[ data_slot + 3 ] = (void*)revcharmap;
3544 #else
3545     SvREFCNT_dec_NN(revcharmap);
3546 #endif
3547     return trie->jump
3548            ? MADE_JUMP_TRIE
3549            : trie->startstate>1
3550              ? MADE_EXACT_TRIE
3551              : MADE_TRIE;
3552 }
3553
3554 STATIC regnode *
3555 S_construct_ahocorasick_from_trie(pTHX_ RExC_state_t *pRExC_state, regnode *source, U32 depth)
3556 {
3557 /* The Trie is constructed and compressed now so we can build a fail array if
3558  * it's needed
3559
3560    This is basically the Aho-Corasick algorithm. Its from exercise 3.31 and
3561    3.32 in the
3562    "Red Dragon" -- Compilers, principles, techniques, and tools. Aho, Sethi,
3563    Ullman 1985/88
3564    ISBN 0-201-10088-6
3565
3566    We find the fail state for each state in the trie, this state is the longest
3567    proper suffix of the current state's 'word' that is also a proper prefix of
3568    another word in our trie. State 1 represents the word '' and is thus the
3569    default fail state. This allows the DFA not to have to restart after its
3570    tried and failed a word at a given point, it simply continues as though it
3571    had been matching the other word in the first place.
3572    Consider
3573       'abcdgu'=~/abcdefg|cdgu/
3574    When we get to 'd' we are still matching the first word, we would encounter
3575    'g' which would fail, which would bring us to the state representing 'd' in
3576    the second word where we would try 'g' and succeed, proceeding to match
3577    'cdgu'.
3578  */
3579  /* add a fail transition */
3580     const U32 trie_offset = ARG(source);
3581     reg_trie_data *trie=(reg_trie_data *)RExC_rxi->data->data[trie_offset];
3582     U32 *q;
3583     const U32 ucharcount = trie->uniquecharcount;
3584     const U32 numstates = trie->statecount;
3585     const U32 ubound = trie->lasttrans + ucharcount;
3586     U32 q_read = 0;
3587     U32 q_write = 0;
3588     U32 charid;
3589     U32 base = trie->states[ 1 ].trans.base;
3590     U32 *fail;
3591     reg_ac_data *aho;
3592     const U32 data_slot = add_data( pRExC_state, STR_WITH_LEN("T"));
3593     regnode *stclass;
3594     GET_RE_DEBUG_FLAGS_DECL;
3595
3596     PERL_ARGS_ASSERT_CONSTRUCT_AHOCORASICK_FROM_TRIE;
3597     PERL_UNUSED_CONTEXT;
3598 #ifndef DEBUGGING
3599     PERL_UNUSED_ARG(depth);
3600 #endif
3601
3602     if ( OP(source) == TRIE ) {
3603         struct regnode_1 *op = (struct regnode_1 *)
3604             PerlMemShared_calloc(1, sizeof(struct regnode_1));
3605         StructCopy(source,op,struct regnode_1);
3606         stclass = (regnode *)op;
3607     } else {
3608         struct regnode_charclass *op = (struct regnode_charclass *)
3609             PerlMemShared_calloc(1, sizeof(struct regnode_charclass));
3610         StructCopy(source,op,struct regnode_charclass);
3611         stclass = (regnode *)op;
3612     }
3613     OP(stclass)+=2; /* convert the TRIE type to its AHO-CORASICK equivalent */
3614
3615     ARG_SET( stclass, data_slot );
3616     aho = (reg_ac_data *) PerlMemShared_calloc( 1, sizeof(reg_ac_data) );
3617     RExC_rxi->data->data[ data_slot ] = (void*)aho;
3618     aho->trie=trie_offset;
3619     aho->states=(reg_trie_state *)PerlMemShared_malloc( numstates * sizeof(reg_trie_state) );
3620     Copy( trie->states, aho->states, numstates, reg_trie_state );
3621     Newx( q, numstates, U32);
3622     aho->fail = (U32 *) PerlMemShared_calloc( numstates, sizeof(U32) );
3623     aho->refcount = 1;
3624     fail = aho->fail;
3625     /* initialize fail[0..1] to be 1 so that we always have
3626        a valid final fail state */
3627     fail[ 0 ] = fail[ 1 ] = 1;
3628
3629     for ( charid = 0; charid < ucharcount ; charid++ ) {
3630         const U32 newstate = TRIE_TRANS_STATE( 1, base, ucharcount, charid, 0 );
3631         if ( newstate ) {
3632             q[ q_write ] = newstate;
3633             /* set to point at the root */
3634             fail[ q[ q_write++ ] ]=1;
3635         }
3636     }
3637     while ( q_read < q_write) {
3638         const U32 cur = q[ q_read++ % numstates ];
3639         base = trie->states[ cur ].trans.base;
3640
3641         for ( charid = 0 ; charid < ucharcount ; charid++ ) {
3642             const U32 ch_state = TRIE_TRANS_STATE( cur, base, ucharcount, charid, 1 );
3643             if (ch_state) {
3644                 U32 fail_state = cur;
3645                 U32 fail_base;
3646                 do {
3647                     fail_state = fail[ fail_state ];
3648                     fail_base = aho->states[ fail_state ].trans.base;
3649                 } while ( !TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 ) );
3650
3651                 fail_state = TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 );
3652                 fail[ ch_state ] = fail_state;
3653                 if ( !aho->states[ ch_state ].wordnum && aho->states[ fail_state ].wordnum )
3654                 {
3655                         aho->states[ ch_state ].wordnum =  aho->states[ fail_state ].wordnum;
3656                 }
3657                 q[ q_write++ % numstates] = ch_state;
3658             }
3659         }
3660     }
3661     /* restore fail[0..1] to 0 so that we "fall out" of the AC loop
3662        when we fail in state 1, this allows us to use the
3663        charclass scan to find a valid start char. This is based on the principle
3664        that theres a good chance the string being searched contains lots of stuff
3665        that cant be a start char.
3666      */
3667     fail[ 0 ] = fail[ 1 ] = 0;
3668     DEBUG_TRIE_COMPILE_r({
3669         Perl_re_indentf( aTHX_  "Stclass Failtable (%" UVuf " states): 0",
3670                       depth, (UV)numstates
3671         );
3672         for( q_read=1; q_read<numstates; q_read++ ) {
3673             Perl_re_printf( aTHX_  ", %" UVuf, (UV)fail[q_read]);
3674         }
3675         Perl_re_printf( aTHX_  "\n");
3676     });
3677     Safefree(q);
3678     /*RExC_seen |= REG_TRIEDFA_SEEN;*/
3679     return stclass;
3680 }
3681
3682
3683 /* The below joins as many adjacent EXACTish nodes as possible into a single
3684  * one.  The regop may be changed if the node(s) contain certain sequences that
3685  * require special handling.  The joining is only done if:
3686  * 1) there is room in the current conglomerated node to entirely contain the
3687  *    next one.
3688  * 2) they are the exact same node type
3689  *
3690  * The adjacent nodes actually may be separated by NOTHING-kind nodes, and
3691  * these get optimized out
3692  *
3693  * XXX khw thinks this should be enhanced to fill EXACT (at least) nodes as full
3694  * as possible, even if that means splitting an existing node so that its first
3695  * part is moved to the preceeding node.  This would maximise the efficiency of
3696  * memEQ during matching.  Elsewhere in this file, khw proposes splitting
3697  * EXACTFish nodes into portions that don't change under folding vs those that
3698  * do.  Those portions that don't change may be the only things in the pattern that
3699  * could be used to find fixed and floating strings.
3700  *
3701  * If a node is to match under /i (folded), the number of characters it matches
3702  * can be different than its character length if it contains a multi-character
3703  * fold.  *min_subtract is set to the total delta number of characters of the
3704  * input nodes.
3705  *
3706  * And *unfolded_multi_char is set to indicate whether or not the node contains
3707  * an unfolded multi-char fold.  This happens when whether the fold is valid or
3708  * not won't be known until runtime; namely for EXACTF nodes that contain LATIN
3709  * SMALL LETTER SHARP S, as only if the target string being matched against
3710  * turns out to be UTF-8 is that fold valid; and also for EXACTFL nodes whose
3711  * folding rules depend on the locale in force at runtime.  (Multi-char folds
3712  * whose components are all above the Latin1 range are not run-time locale
3713  * dependent, and have already been folded by the time this function is
3714  * called.)
3715  *
3716  * This is as good a place as any to discuss the design of handling these
3717  * multi-character fold sequences.  It's been wrong in Perl for a very long
3718  * time.  There are three code points in Unicode whose multi-character folds
3719  * were long ago discovered to mess things up.  The previous designs for
3720  * dealing with these involved assigning a special node for them.  This
3721  * approach doesn't always work, as evidenced by this example:
3722  *      "\xDFs" =~ /s\xDF/ui    # Used to fail before these patches
3723  * Both sides fold to "sss", but if the pattern is parsed to create a node that
3724  * would match just the \xDF, it won't be able to handle the case where a
3725  * successful match would have to cross the node's boundary.  The new approach
3726  * that hopefully generally solves the problem generates an EXACTFU_SS node
3727  * that is "sss" in this case.
3728  *
3729  * It turns out that there are problems with all multi-character folds, and not
3730  * just these three.  Now the code is general, for all such cases.  The
3731  * approach taken is:
3732  * 1)   This routine examines each EXACTFish node that could contain multi-
3733  *      character folded sequences.  Since a single character can fold into
3734  *      such a sequence, the minimum match length for this node is less than
3735  *      the number of characters in the node.  This routine returns in
3736  *      *min_subtract how many characters to subtract from the the actual
3737  *      length of the string to get a real minimum match length; it is 0 if
3738  *      there are no multi-char foldeds.  This delta is used by the caller to
3739  *      adjust the min length of the match, and the delta between min and max,
3740  *      so that the optimizer doesn't reject these possibilities based on size
3741  *      constraints.
3742  * 2)   For the sequence involving the Sharp s (\xDF), the node type EXACTFU_SS
3743  *      is used for an EXACTFU node that contains at least one "ss" sequence in
3744  *      it.  For non-UTF-8 patterns and strings, this is the only case where
3745  *      there is a possible fold length change.  That means that a regular
3746  *      EXACTFU node without UTF-8 involvement doesn't have to concern itself
3747  *      with length changes, and so can be processed faster.  regexec.c takes
3748  *      advantage of this.  Generally, an EXACTFish node that is in UTF-8 is
3749  *      pre-folded by regcomp.c (except EXACTFL, some of whose folds aren't
3750  *      known until runtime).  This saves effort in regex matching.  However,
3751  *      the pre-folding isn't done for non-UTF8 patterns because the fold of
3752  *      the MICRO SIGN requires UTF-8, and we don't want to slow things down by
3753  *      forcing the pattern into UTF8 unless necessary.  Also what EXACTF (and,
3754  *      again, EXACTFL) nodes fold to isn't known until runtime.  The fold
3755  *      possibilities for the non-UTF8 patterns are quite simple, except for
3756  *      the sharp s.  All the ones that don't involve a UTF-8 target string are
3757  *      members of a fold-pair, and arrays are set up for all of them so that
3758  *      the other member of the pair can be found quickly.  Code elsewhere in
3759  *      this file makes sure that in EXACTFU nodes, the sharp s gets folded to
3760  *      'ss', even if the pattern isn't UTF-8.  This avoids the issues
3761  *      described in the next item.
3762  * 3)   A problem remains for unfolded multi-char folds. (These occur when the
3763  *      validity of the fold won't be known until runtime, and so must remain
3764  *      unfolded for now.  This happens for the sharp s in EXACTF and EXACTFA
3765  *      nodes when the pattern isn't in UTF-8.  (Note, BTW, that there cannot
3766  *      be an EXACTF node with a UTF-8 pattern.)  They also occur for various
3767  *      folds in EXACTFL nodes, regardless of the UTF-ness of the pattern.)
3768  *      The reason this is a problem is that the optimizer part of regexec.c
3769  *      (probably unwittingly, in Perl_regexec_flags()) makes an assumption
3770  *      that a character in the pattern corresponds to at most a single
3771  *      character in the target string.  (And I do mean character, and not byte
3772  *      here, unlike other parts of the documentation that have never been
3773  *      updated to account for multibyte Unicode.)  sharp s in EXACTF and
3774  *      EXACTFL nodes can match the two character string 'ss'; in EXACTFA nodes
3775  *      it can match "\x{17F}\x{17F}".  These, along with other ones in EXACTFL
3776  *      nodes, violate the assumption, and they are the only instances where it
3777  *      is violated.  I'm reluctant to try to change the assumption, as the
3778  *      code involved is impenetrable to me (khw), so instead the code here
3779  *      punts.  This routine examines EXACTFL nodes, and (when the pattern
3780  *      isn't UTF-8) EXACTF and EXACTFA for such unfolded folds, and returns a
3781  *      boolean indicating whether or not the node contains such a fold.  When
3782  *      it is true, the caller sets a flag that later causes the optimizer in
3783  *      this file to not set values for the floating and fixed string lengths,
3784  *      and thus avoids the optimizer code in regexec.c that makes the invalid
3785  *      assumption.  Thus, there is no optimization based on string lengths for
3786  *      EXACTFL nodes that contain these few folds, nor for non-UTF8-pattern
3787  *      EXACTF and EXACTFA nodes that contain the sharp s.  (The reason the
3788  *      assumption is wrong only in these cases is that all other non-UTF-8
3789  *      folds are 1-1; and, for UTF-8 patterns, we pre-fold all other folds to
3790  *      their expanded versions.  (Again, we can't prefold sharp s to 'ss' in
3791  *      EXACTF nodes because we don't know at compile time if it actually
3792  *      matches 'ss' or not.  For EXACTF nodes it will match iff the target
3793  *      string is in UTF-8.  This is in contrast to EXACTFU nodes, where it
3794  *      always matches; and EXACTFA where it never does.  In an EXACTFA node in
3795  *      a UTF-8 pattern, sharp s is folded to "\x{17F}\x{17F}, avoiding the
3796  *      problem; but in a non-UTF8 pattern, folding it to that above-Latin1
3797  *      string would require the pattern to be forced into UTF-8, the overhead
3798  *      of which we want to avoid.  Similarly the unfolded multi-char folds in
3799  *      EXACTFL nodes will match iff the locale at the time of match is a UTF-8
3800  *      locale.)
3801  *
3802  *      Similarly, the code that generates tries doesn't currently handle
3803  *      not-already-folded multi-char folds, and it looks like a pain to change
3804  *      that.  Therefore, trie generation of EXACTFA nodes with the sharp s
3805  *      doesn't work.  Instead, such an EXACTFA is turned into a new regnode,
3806  *      EXACTFA_NO_TRIE, which the trie code knows not to handle.  Most people
3807  *      using /iaa matching will be doing so almost entirely with ASCII
3808  *      strings, so this should rarely be encountered in practice */
3809
3810 #define JOIN_EXACT(scan,min_subtract,unfolded_multi_char, flags) \
3811     if (PL_regkind[OP(scan)] == EXACT) \
3812         join_exact(pRExC_state,(scan),(min_subtract),unfolded_multi_char, (flags),NULL,depth+1)
3813
3814 STATIC U32
3815 S_join_exact(pTHX_ RExC_state_t *pRExC_state, regnode *scan,
3816                    UV *min_subtract, bool *unfolded_multi_char,
3817                    U32 flags,regnode *val, U32 depth)
3818 {
3819     /* Merge several consecutive EXACTish nodes into one. */
3820     regnode *n = regnext(scan);
3821     U32 stringok = 1;
3822     regnode *next = scan + NODE_SZ_STR(scan);
3823     U32 merged = 0;
3824     U32 stopnow = 0;
3825 #ifdef DEBUGGING
3826     regnode *stop = scan;
3827     GET_RE_DEBUG_FLAGS_DECL;
3828 #else
3829     PERL_UNUSED_ARG(depth);
3830 #endif
3831
3832     PERL_ARGS_ASSERT_JOIN_EXACT;
3833 #ifndef EXPERIMENTAL_INPLACESCAN
3834     PERL_UNUSED_ARG(flags);
3835     PERL_UNUSED_ARG(val);
3836 #endif
3837     DEBUG_PEEP("join", scan, depth, 0);
3838
3839     /* Look through the subsequent nodes in the chain.  Skip NOTHING, merge
3840      * EXACT ones that are mergeable to the current one. */
3841     while (n
3842            && (PL_regkind[OP(n)] == NOTHING
3843                || (stringok && OP(n) == OP(scan)))
3844            && NEXT_OFF(n)
3845            && NEXT_OFF(scan) + NEXT_OFF(n) < I16_MAX)
3846     {
3847
3848         if (OP(n) == TAIL || n > next)
3849             stringok = 0;
3850         if (PL_regkind[OP(n)] == NOTHING) {
3851             DEBUG_PEEP("skip:", n, depth, 0);
3852             NEXT_OFF(scan) += NEXT_OFF(n);
3853             next = n + NODE_STEP_REGNODE;
3854 #ifdef DEBUGGING
3855             if (stringok)
3856                 stop = n;
3857 #endif
3858             n = regnext(n);
3859         }
3860         else if (stringok) {
3861             const unsigned int oldl = STR_LEN(scan);
3862             regnode * const nnext = regnext(n);
3863
3864             /* XXX I (khw) kind of doubt that this works on platforms (should
3865              * Perl ever run on one) where U8_MAX is above 255 because of lots
3866              * of other assumptions */
3867             /* Don't join if the sum can't fit into a single node */
3868             if (oldl + STR_LEN(n) > U8_MAX)
3869                 break;
3870
3871             DEBUG_PEEP("merg", n, depth, 0);
3872             merged++;
3873
3874             NEXT_OFF(scan) += NEXT_OFF(n);
3875             STR_LEN(scan) += STR_LEN(n);
3876             next = n + NODE_SZ_STR(n);
3877             /* Now we can overwrite *n : */
3878             Move(STRING(n), STRING(scan) + oldl, STR_LEN(n), char);
3879 #ifdef DEBUGGING
3880             stop = next - 1;
3881 #endif
3882             n = nnext;
3883             if (stopnow) break;
3884         }
3885
3886 #ifdef EXPERIMENTAL_INPLACESCAN
3887         if (flags && !NEXT_OFF(n)) {
3888             DEBUG_PEEP("atch", val, depth, 0);
3889             if (reg_off_by_arg[OP(n)]) {
3890                 ARG_SET(n, val - n);
3891             }
3892             else {
3893                 NEXT_OFF(n) = val - n;
3894             }
3895             stopnow = 1;
3896         }
3897 #endif
3898     }
3899
3900     *min_subtract = 0;
3901     *unfolded_multi_char = FALSE;
3902
3903     /* Here, all the adjacent mergeable EXACTish nodes have been merged.  We
3904      * can now analyze for sequences of problematic code points.  (Prior to
3905      * this final joining, sequences could have been split over boundaries, and
3906      * hence missed).  The sequences only happen in folding, hence for any
3907      * non-EXACT EXACTish node */
3908     if (OP(scan) != EXACT && OP(scan) != EXACTL) {
3909         U8* s0 = (U8*) STRING(scan);
3910         U8* s = s0;
3911         U8* s_end = s0 + STR_LEN(scan);
3912
3913         int total_count_delta = 0;  /* Total delta number of characters that
3914                                        multi-char folds expand to */
3915
3916         /* One pass is made over the node's string looking for all the
3917          * possibilities.  To avoid some tests in the loop, there are two main
3918          * cases, for UTF-8 patterns (which can't have EXACTF nodes) and
3919          * non-UTF-8 */
3920         if (UTF) {
3921             U8* folded = NULL;
3922
3923             if (OP(scan) == EXACTFL) {
3924                 U8 *d;
3925
3926                 /* An EXACTFL node would already have been changed to another
3927                  * node type unless there is at least one character in it that
3928                  * is problematic; likely a character whose fold definition
3929                  * won't be known until runtime, and so has yet to be folded.
3930                  * For all but the UTF-8 locale, folds are 1-1 in length, but
3931                  * to handle the UTF-8 case, we need to create a temporary
3932                  * folded copy using UTF-8 locale rules in order to analyze it.
3933                  * This is because our macros that look to see if a sequence is
3934                  * a multi-char fold assume everything is folded (otherwise the
3935                  * tests in those macros would be too complicated and slow).
3936                  * Note that here, the non-problematic folds will have already
3937                  * been done, so we can just copy such characters.  We actually
3938                  * don't completely fold the EXACTFL string.  We skip the
3939                  * unfolded multi-char folds, as that would just create work
3940                  * below to figure out the size they already are */
3941
3942                 Newx(folded, UTF8_MAX_FOLD_CHAR_EXPAND * STR_LEN(scan) + 1, U8);
3943                 d = folded;
3944                 while (s < s_end) {
3945                     STRLEN s_len = UTF8SKIP(s);
3946                     if (! is_PROBLEMATIC_LOCALE_FOLD_utf8(s)) {
3947                         Copy(s, d, s_len, U8);
3948                         d += s_len;
3949                     }
3950                     else if (is_FOLDS_TO_MULTI_utf8(s)) {
3951                         *unfolded_multi_char = TRUE;
3952                         Copy(s, d, s_len, U8);
3953                         d += s_len;
3954                     }
3955                     else if (isASCII(*s)) {
3956                         *(d++) = toFOLD(*s);
3957                     }
3958                     else {
3959                         STRLEN len;
3960                         _toFOLD_utf8_flags(s, s_end, d, &len, FOLD_FLAGS_FULL);
3961                         d += len;
3962                     }
3963                     s += s_len;
3964                 }
3965
3966                 /* Point the remainder of the routine to look at our temporary
3967                  * folded copy */
3968                 s = folded;
3969                 s_end = d;
3970             } /* End of creating folded copy of EXACTFL string */
3971
3972             /* Examine the string for a multi-character fold sequence.  UTF-8
3973              * patterns have all characters pre-folded by the time this code is
3974              * executed */
3975             while (s < s_end - 1) /* Can stop 1 before the end, as minimum
3976                                      length sequence we are looking for is 2 */
3977             {
3978                 int count = 0;  /* How many characters in a multi-char fold */
3979                 int len = is_MULTI_CHAR_FOLD_utf8_safe(s, s_end);
3980                 if (! len) {    /* Not a multi-char fold: get next char */
3981                     s += UTF8SKIP(s);
3982                     continue;
3983                 }
3984
3985                 /* Nodes with 'ss' require special handling, except for
3986                  * EXACTFA-ish for which there is no multi-char fold to this */
3987                 if (len == 2 && *s == 's' && *(s+1) == 's'
3988                     && OP(scan) != EXACTFA
3989                     && OP(scan) != EXACTFA_NO_TRIE)
3990                 {
3991                     count = 2;
3992                     if (OP(scan) != EXACTFL) {
3993                         OP(scan) = EXACTFU_SS;
3994                     }
3995                     s += 2;
3996                 }
3997                 else { /* Here is a generic multi-char fold. */
3998                     U8* multi_end  = s + len;
3999
4000                     /* Count how many characters are in it.  In the case of
4001                      * /aa, no folds which contain ASCII code points are
4002                      * allowed, so check for those, and skip if found. */
4003                     if (OP(scan) != EXACTFA && OP(scan) != EXACTFA_NO_TRIE) {
4004                         count = utf8_length(s, multi_end);
4005                         s = multi_end;
4006                     }
4007                     else {
4008                         while (s < multi_end) {
4009                             if (isASCII(*s)) {
4010                                 s++;
4011                                 goto next_iteration;
4012                             }
4013                             else {
4014                                 s += UTF8SKIP(s);
4015                             }
4016                             count++;
4017                         }
4018                     }
4019                 }
4020
4021                 /* The delta is how long the sequence is minus 1 (1 is how long
4022                  * the character that folds to the sequence is) */
4023                 total_count_delta += count - 1;
4024               next_iteration: ;
4025             }
4026
4027             /* We created a temporary folded copy of the string in EXACTFL
4028              * nodes.  Therefore we need to be sure it doesn't go below zero,
4029              * as the real string could be shorter */
4030             if (OP(scan) == EXACTFL) {
4031                 int total_chars = utf8_length((U8*) STRING(scan),
4032                                            (U8*) STRING(scan) + STR_LEN(scan));
4033                 if (total_count_delta > total_chars) {
4034                     total_count_delta = total_chars;
4035                 }
4036             }
4037
4038             *min_subtract += total_count_delta;
4039             Safefree(folded);
4040         }
4041         else if (OP(scan) == EXACTFA) {
4042
4043             /* Non-UTF-8 pattern, EXACTFA node.  There can't be a multi-char
4044              * fold to the ASCII range (and there are no existing ones in the
4045              * upper latin1 range).  But, as outlined in the comments preceding
4046              * this function, we need to flag any occurrences of the sharp s.
4047              * This character forbids trie formation (because of added
4048              * complexity) */
4049 #if    UNICODE_MAJOR_VERSION > 3 /* no multifolds in early Unicode */   \
4050    || (UNICODE_MAJOR_VERSION == 3 && (   UNICODE_DOT_VERSION > 0)       \
4051                                       || UNICODE_DOT_DOT_VERSION > 0)
4052             while (s < s_end) {
4053                 if (*s == LATIN_SMALL_LETTER_SHARP_S) {
4054                     OP(scan) = EXACTFA_NO_TRIE;
4055                     *unfolded_multi_char = TRUE;
4056                     break;
4057                 }
4058                 s++;
4059             }
4060         }
4061         else {
4062
4063             /* Non-UTF-8 pattern, not EXACTFA node.  Look for the multi-char
4064              * folds that are all Latin1.  As explained in the comments
4065              * preceding this function, we look also for the sharp s in EXACTF
4066              * and EXACTFL nodes; it can be in the final position.  Otherwise
4067              * we can stop looking 1 byte earlier because have to find at least
4068              * two characters for a multi-fold */
4069             const U8* upper = (OP(scan) == EXACTF || OP(scan) == EXACTFL)
4070                               ? s_end
4071                               : s_end -1;
4072
4073             while (s < upper) {
4074                 int len = is_MULTI_CHAR_FOLD_latin1_safe(s, s_end);
4075                 if (! len) {    /* Not a multi-char fold. */
4076                     if (*s == LATIN_SMALL_LETTER_SHARP_S
4077                         && (OP(scan) == EXACTF || OP(scan) == EXACTFL))
4078                     {
4079                         *unfolded_multi_char = TRUE;
4080                     }
4081                     s++;
4082                     continue;
4083                 }
4084
4085                 if (len == 2
4086                     && isALPHA_FOLD_EQ(*s, 's')
4087                     && isALPHA_FOLD_EQ(*(s+1), 's'))
4088                 {
4089
4090                     /* EXACTF nodes need to know that the minimum length
4091                      * changed so that a sharp s in the string can match this
4092                      * ss in the pattern, but they remain EXACTF nodes, as they
4093                      * won't match this unless the target string is is UTF-8,
4094                      * which we don't know until runtime.  EXACTFL nodes can't
4095                      * transform into EXACTFU nodes */
4096                     if (OP(scan) != EXACTF && OP(scan) != EXACTFL) {
4097                         OP(scan) = EXACTFU_SS;
4098                     }
4099                 }
4100
4101                 *min_subtract += len - 1;
4102                 s += len;
4103             }
4104 #endif
4105         }
4106     }
4107
4108 #ifdef DEBUGGING
4109     /* Allow dumping but overwriting the collection of skipped
4110      * ops and/or strings with fake optimized ops */
4111     n = scan + NODE_SZ_STR(scan);
4112     while (n <= stop) {
4113         OP(n) = OPTIMIZED;
4114         FLAGS(n) = 0;
4115         NEXT_OFF(n) = 0;
4116         n++;
4117     }
4118 #endif
4119     DEBUG_OPTIMISE_r(if (merged){DEBUG_PEEP("finl", scan, depth, 0);});
4120     return stopnow;
4121 }
4122
4123 /* REx optimizer.  Converts nodes into quicker variants "in place".
4124    Finds fixed substrings.  */
4125
4126 /* Stops at toplevel WHILEM as well as at "last". At end *scanp is set
4127    to the position after last scanned or to NULL. */
4128
4129 #define INIT_AND_WITHP \
4130     assert(!and_withp); \
4131     Newx(and_withp,1, regnode_ssc); \
4132     SAVEFREEPV(and_withp)
4133
4134
4135 static void
4136 S_unwind_scan_frames(pTHX_ const void *p)
4137 {
4138     scan_frame *f= (scan_frame *)p;
4139     do {
4140         scan_frame *n= f->next_frame;
4141         Safefree(f);
4142         f= n;
4143     } while (f);
4144 }
4145
4146 /* the return from this sub is the minimum length that could possibly match */
4147 STATIC SSize_t
4148 S_study_chunk(pTHX_ RExC_state_t *pRExC_state, regnode **scanp,
4149                         SSize_t *minlenp, SSize_t *deltap,
4150                         regnode *last,
4151                         scan_data_t *data,
4152                         I32 stopparen,
4153                         U32 recursed_depth,
4154                         regnode_ssc *and_withp,
4155                         U32 flags, U32 depth)
4156                         /* scanp: Start here (read-write). */
4157                         /* deltap: Write maxlen-minlen here. */
4158                         /* last: Stop before this one. */
4159                         /* data: string data about the pattern */
4160                         /* stopparen: treat close N as END */
4161                         /* recursed: which subroutines have we recursed into */
4162                         /* and_withp: Valid if flags & SCF_DO_STCLASS_OR */
4163 {
4164     /* There must be at least this number of characters to match */
4165     SSize_t min = 0;
4166     I32 pars = 0, code;
4167     regnode *scan = *scanp, *next;
4168     SSize_t delta = 0;
4169     int is_inf = (flags & SCF_DO_SUBSTR) && (data->flags & SF_IS_INF);
4170     int is_inf_internal = 0;            /* The studied chunk is infinite */
4171     I32 is_par = OP(scan) == OPEN ? ARG(scan) : 0;
4172     scan_data_t data_fake;
4173     SV *re_trie_maxbuff = NULL;
4174     regnode *first_non_open = scan;
4175     SSize_t stopmin = SSize_t_MAX;
4176     scan_frame *frame = NULL;
4177     GET_RE_DEBUG_FLAGS_DECL;
4178
4179     PERL_ARGS_ASSERT_STUDY_CHUNK;
4180     RExC_study_started= 1;
4181
4182     Zero(&data_fake, 1, scan_data_t);
4183
4184     if ( depth == 0 ) {
4185         while (first_non_open && OP(first_non_open) == OPEN)
4186             first_non_open=regnext(first_non_open);
4187     }
4188
4189
4190   fake_study_recurse:
4191     DEBUG_r(
4192         RExC_study_chunk_recursed_count++;
4193     );
4194     DEBUG_OPTIMISE_MORE_r(
4195     {
4196         Perl_re_indentf( aTHX_  "study_chunk stopparen=%ld recursed_count=%lu depth=%lu recursed_depth=%lu scan=%p last=%p",
4197             depth, (long)stopparen,
4198             (unsigned long)RExC_study_chunk_recursed_count,
4199             (unsigned long)depth, (unsigned long)recursed_depth,
4200             scan,
4201             last);
4202         if (recursed_depth) {
4203             U32 i;
4204             U32 j;
4205             for ( j = 0 ; j < recursed_depth ; j++ ) {
4206                 for ( i = 0 ; i < (U32)RExC_npar ; i++ ) {
4207                     if (
4208                         PAREN_TEST(RExC_study_chunk_recursed +
4209                                    ( j * RExC_study_chunk_recursed_bytes), i )
4210                         && (
4211                             !j ||
4212                             !PAREN_TEST(RExC_study_chunk_recursed +
4213                                    (( j - 1 ) * RExC_study_chunk_recursed_bytes), i)
4214                         )
4215                     ) {
4216                         Perl_re_printf( aTHX_ " %d",(int)i);
4217                         break;
4218                     }
4219                 }
4220                 if ( j + 1 < recursed_depth ) {
4221                     Perl_re_printf( aTHX_  ",");
4222                 }
4223             }
4224         }
4225         Perl_re_printf( aTHX_ "\n");
4226     }
4227     );
4228     while ( scan && OP(scan) != END && scan < last ){
4229         UV min_subtract = 0;    /* How mmany chars to subtract from the minimum
4230                                    node length to get a real minimum (because
4231                                    the folded version may be shorter) */
4232         bool unfolded_multi_char = FALSE;
4233         /* Peephole optimizer: */
4234         DEBUG_STUDYDATA("Peep", data, depth, is_inf);
4235         DEBUG_PEEP("Peep", scan, depth, flags);
4236
4237
4238         /* The reason we do this here is that we need to deal with things like
4239          * /(?:f)(?:o)(?:o)/ which cant be dealt with by the normal EXACT
4240          * parsing code, as each (?:..) is handled by a different invocation of
4241          * reg() -- Yves
4242          */
4243         JOIN_EXACT(scan,&min_subtract, &unfolded_multi_char, 0);
4244
4245         /* Follow the next-chain of the current node and optimize
4246            away all the NOTHINGs from it.  */
4247         if (OP(scan) != CURLYX) {
4248             const int max = (reg_off_by_arg[OP(scan)]
4249                        ? I32_MAX
4250                        /* I32 may be smaller than U16 on CRAYs! */
4251                        : (I32_MAX < U16_MAX ? I32_MAX : U16_MAX));
4252             int off = (reg_off_by_arg[OP(scan)] ? ARG(scan) : NEXT_OFF(scan));
4253             int noff;
4254             regnode *n = scan;
4255
4256             /* Skip NOTHING and LONGJMP. */
4257             while ((n = regnext(n))
4258                    && ((PL_regkind[OP(n)] == NOTHING && (noff = NEXT_OFF(n)))
4259                        || ((OP(n) == LONGJMP) && (noff = ARG(n))))
4260                    && off + noff < max)
4261                 off += noff;
4262             if (reg_off_by_arg[OP(scan)])
4263                 ARG(scan) = off;
4264             else
4265                 NEXT_OFF(scan) = off;
4266         }
4267
4268         /* The principal pseudo-switch.  Cannot be a switch, since we
4269            look into several different things.  */
4270         if ( OP(scan) == DEFINEP ) {
4271             SSize_t minlen = 0;
4272             SSize_t deltanext = 0;
4273             SSize_t fake_last_close = 0;
4274             I32 f = SCF_IN_DEFINE;
4275
4276             StructCopy(&zero_scan_data, &data_fake, scan_data_t);
4277             scan = regnext(scan);
4278             assert( OP(scan) == IFTHEN );
4279             DEBUG_PEEP("expect IFTHEN", scan, depth, flags);
4280
4281             data_fake.last_closep= &fake_last_close;
4282             minlen = *minlenp;
4283             next = regnext(scan);
4284             scan = NEXTOPER(NEXTOPER(scan));
4285             DEBUG_PEEP("scan", scan, depth, flags);
4286             DEBUG_PEEP("next", next, depth, flags);
4287
4288             /* we suppose the run is continuous, last=next...
4289              * NOTE we dont use the return here! */
4290             /* DEFINEP study_chunk() recursion */
4291             (void)study_chunk(pRExC_state, &scan, &minlen,
4292                               &deltanext, next, &data_fake, stopparen,
4293                               recursed_depth, NULL, f, depth+1);
4294
4295             scan = next;
4296         } else
4297         if (
4298             OP(scan) == BRANCH  ||
4299             OP(scan) == BRANCHJ ||
4300             OP(scan) == IFTHEN
4301         ) {
4302             next = regnext(scan);
4303             code = OP(scan);
4304
4305             /* The op(next)==code check below is to see if we
4306              * have "BRANCH-BRANCH", "BRANCHJ-BRANCHJ", "IFTHEN-IFTHEN"
4307              * IFTHEN is special as it might not appear in pairs.
4308              * Not sure whether BRANCH-BRANCHJ is possible, regardless
4309              * we dont handle it cleanly. */
4310             if (OP(next) == code || code == IFTHEN) {
4311                 /* NOTE - There is similar code to this block below for
4312                  * handling TRIE nodes on a re-study.  If you change stuff here
4313                  * check there too. */
4314                 SSize_t max1 = 0, min1 = SSize_t_MAX, num = 0;
4315                 regnode_ssc accum;
4316                 regnode * const startbranch=scan;
4317
4318                 if (flags & SCF_DO_SUBSTR) {
4319                     /* Cannot merge strings after this. */
4320                     scan_commit(pRExC_state, data, minlenp, is_inf);
4321                 }
4322
4323                 if (flags & SCF_DO_STCLASS)
4324                     ssc_init_zero(pRExC_state, &accum);
4325
4326                 while (OP(scan) == code) {
4327                     SSize_t deltanext, minnext, fake;
4328                     I32 f = 0;
4329                     regnode_ssc this_class;
4330
4331                     DEBUG_PEEP("Branch", scan, depth, flags);
4332
4333                     num++;
4334                     StructCopy(&zero_scan_data, &data_fake, scan_data_t);
4335                     if (data) {
4336                         data_fake.whilem_c = data->whilem_c;
4337                         data_fake.last_closep = data->last_closep;
4338                     }
4339                     else
4340                         data_fake.last_closep = &fake;
4341
4342                     data_fake.pos_delta = delta;
4343                     next = regnext(scan);
4344
4345                     scan = NEXTOPER(scan); /* everything */
4346                     if (code != BRANCH)    /* everything but BRANCH */
4347                         scan = NEXTOPER(scan);
4348
4349                     if (flags & SCF_DO_STCLASS) {
4350                         ssc_init(pRExC_state, &this_class);
4351                         data_fake.start_class = &this_class;
4352                         f = SCF_DO_STCLASS_AND;
4353                     }
4354                     if (flags & SCF_WHILEM_VISITED_POS)
4355                         f |= SCF_WHILEM_VISITED_POS;
4356
4357                     /* we suppose the run is continuous, last=next...*/
4358                     /* recurse study_chunk() for each BRANCH in an alternation */
4359                     minnext = study_chunk(pRExC_state, &scan, minlenp,
4360                                       &deltanext, next, &data_fake, stopparen,
4361                                       recursed_depth, NULL, f,depth+1);
4362
4363                     if (min1 > minnext)
4364                         min1 = minnext;
4365                     if (deltanext == SSize_t_MAX) {
4366                         is_inf = is_inf_internal = 1;
4367                         max1 = SSize_t_MAX;
4368                     } else if (max1 < minnext + deltanext)
4369                         max1 = minnext + deltanext;
4370                     scan = next;
4371                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4372                         pars++;
4373                     if (data_fake.flags & SCF_SEEN_ACCEPT) {
4374                         if ( stopmin > minnext)
4375                             stopmin = min + min1;
4376                         flags &= ~SCF_DO_SUBSTR;
4377                         if (data)
4378                             data->flags |= SCF_SEEN_ACCEPT;
4379                     }
4380                     if (data) {
4381                         if (data_fake.flags & SF_HAS_EVAL)
4382                             data->flags |= SF_HAS_EVAL;
4383                         data->whilem_c = data_fake.whilem_c;
4384                     }
4385                     if (flags & SCF_DO_STCLASS)
4386                         ssc_or(pRExC_state, &accum, (regnode_charclass*)&this_class);
4387                 }
4388                 if (code == IFTHEN && num < 2) /* Empty ELSE branch */
4389                     min1 = 0;
4390                 if (flags & SCF_DO_SUBSTR) {
4391                     data->pos_min += min1;
4392                     if (data->pos_delta >= SSize_t_MAX - (max1 - min1))
4393                         data->pos_delta = SSize_t_MAX;
4394                     else
4395                         data->pos_delta += max1 - min1;
4396                     if (max1 != min1 || is_inf)
4397                         data->cur_is_floating = 1;
4398                 }
4399                 min += min1;
4400                 if (delta == SSize_t_MAX
4401                  || SSize_t_MAX - delta - (max1 - min1) < 0)
4402                     delta = SSize_t_MAX;
4403                 else
4404                     delta += max1 - min1;
4405                 if (flags & SCF_DO_STCLASS_OR) {
4406                     ssc_or(pRExC_state, data->start_class, (regnode_charclass*) &accum);
4407                     if (min1) {
4408                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
4409                         flags &= ~SCF_DO_STCLASS;
4410                     }
4411                 }
4412                 else if (flags & SCF_DO_STCLASS_AND) {
4413                     if (min1) {
4414                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &accum);
4415                         flags &= ~SCF_DO_STCLASS;
4416                     }
4417                     else {
4418                         /* Switch to OR mode: cache the old value of
4419                          * data->start_class */
4420                         INIT_AND_WITHP;
4421                         StructCopy(data->start_class, and_withp, regnode_ssc);
4422                         flags &= ~SCF_DO_STCLASS_AND;
4423                         StructCopy(&accum, data->start_class, regnode_ssc);
4424                         flags |= SCF_DO_STCLASS_OR;
4425                     }
4426                 }
4427
4428                 if (PERL_ENABLE_TRIE_OPTIMISATION &&
4429                         OP( startbranch ) == BRANCH )
4430                 {
4431                 /* demq.
4432
4433                    Assuming this was/is a branch we are dealing with: 'scan'
4434                    now points at the item that follows the branch sequence,
4435                    whatever it is. We now start at the beginning of the
4436                    sequence and look for subsequences of
4437
4438                    BRANCH->EXACT=>x1
4439                    BRANCH->EXACT=>x2
4440                    tail
4441
4442                    which would be constructed from a pattern like
4443                    /A|LIST|OF|WORDS/
4444
4445                    If we can find such a subsequence we need to turn the first
4446                    element into a trie and then add the subsequent branch exact
4447                    strings to the trie.
4448
4449                    We have two cases
4450
4451                      1. patterns where the whole set of branches can be
4452                         converted.
4453
4454                      2. patterns where only a subset can be converted.
4455
4456                    In case 1 we can replace the whole set with a single regop
4457                    for the trie. In case 2 we need to keep the start and end
4458                    branches so
4459
4460                      'BRANCH EXACT; BRANCH EXACT; BRANCH X'
4461                      becomes BRANCH TRIE; BRANCH X;
4462
4463                   There is an additional case, that being where there is a
4464                   common prefix, which gets split out into an EXACT like node
4465                   preceding the TRIE node.
4466
4467                   If x(1..n)==tail then we can do a simple trie, if not we make
4468                   a "jump" trie, such that when we match the appropriate word
4469                   we "jump" to the appropriate tail node. Essentially we turn
4470                   a nested if into a case structure of sorts.
4471
4472                 */
4473
4474                     int made=0;
4475                     if (!re_trie_maxbuff) {
4476                         re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
4477                         if (!SvIOK(re_trie_maxbuff))
4478                             sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
4479                     }
4480                     if ( SvIV(re_trie_maxbuff)>=0  ) {
4481                         regnode *cur;
4482                         regnode *first = (regnode *)NULL;
4483                         regnode *last = (regnode *)NULL;
4484                         regnode *tail = scan;
4485                         U8 trietype = 0;
4486                         U32 count=0;
4487
4488                         /* var tail is used because there may be a TAIL
4489                            regop in the way. Ie, the exacts will point to the
4490                            thing following the TAIL, but the last branch will
4491                            point at the TAIL. So we advance tail. If we
4492                            have nested (?:) we may have to move through several
4493                            tails.
4494                          */
4495
4496                         while ( OP( tail ) == TAIL ) {
4497                             /* this is the TAIL generated by (?:) */
4498                             tail = regnext( tail );
4499                         }
4500
4501
4502                         DEBUG_TRIE_COMPILE_r({
4503                             regprop(RExC_rx, RExC_mysv, tail, NULL, pRExC_state);
4504                             Perl_re_indentf( aTHX_  "%s %" UVuf ":%s\n",
4505                               depth+1,
4506                               "Looking for TRIE'able sequences. Tail node is ",
4507                               (UV)(tail - RExC_emit_start),
4508                               SvPV_nolen_const( RExC_mysv )
4509                             );
4510                         });
4511
4512                         /*
4513
4514                             Step through the branches
4515                                 cur represents each branch,
4516                                 noper is the first thing to be matched as part
4517                                       of that branch
4518                                 noper_next is the regnext() of that node.
4519
4520                             We normally handle a case like this
4521                             /FOO[xyz]|BAR[pqr]/ via a "jump trie" but we also
4522                             support building with NOJUMPTRIE, which restricts
4523                             the trie logic to structures like /FOO|BAR/.
4524
4525                             If noper is a trieable nodetype then the branch is
4526                             a possible optimization target. If we are building
4527                             under NOJUMPTRIE then we require that noper_next is
4528                             the same as scan (our current position in the regex
4529                             program).
4530
4531                             Once we have two or more consecutive such branches
4532                             we can create a trie of the EXACT's contents and
4533                             stitch it in place into the program.
4534
4535                             If the sequence represents all of the branches in
4536                             the alternation we replace the entire thing with a
4537                             single TRIE node.
4538
4539                             Otherwise when it is a subsequence we need to
4540                             stitch it in place and replace only the relevant
4541                             branches. This means the first branch has to remain
4542                             as it is used by the alternation logic, and its
4543                             next pointer, and needs to be repointed at the item
4544                             on the branch chain following the last branch we
4545                             have optimized away.
4546
4547                             This could be either a BRANCH, in which case the
4548                             subsequence is internal, or it could be the item
4549                             following the branch sequence in which case the
4550                             subsequence is at the end (which does not
4551                             necessarily mean the first node is the start of the
4552                             alternation).
4553
4554                             TRIE_TYPE(X) is a define which maps the optype to a
4555                             trietype.
4556
4557                                 optype          |  trietype
4558                                 ----------------+-----------
4559                                 NOTHING         | NOTHING
4560                                 EXACT           | EXACT
4561                                 EXACTFU         | EXACTFU
4562                                 EXACTFU_SS      | EXACTFU
4563                                 EXACTFA         | EXACTFA
4564                                 EXACTL          | EXACTL
4565                                 EXACTFLU8       | EXACTFLU8
4566
4567
4568                         */
4569 #define TRIE_TYPE(X) ( ( NOTHING == (X) )                                   \
4570                        ? NOTHING                                            \
4571                        : ( EXACT == (X) )                                   \
4572                          ? EXACT                                            \
4573                          : ( EXACTFU == (X) || EXACTFU_SS == (X) )          \
4574                            ? EXACTFU                                        \
4575                            : ( EXACTFA == (X) )                             \
4576                              ? EXACTFA                                      \
4577                              : ( EXACTL == (X) )                            \
4578                                ? EXACTL                                     \
4579                                : ( EXACTFLU8 == (X) )                        \
4580                                  ? EXACTFLU8                                 \
4581                                  : 0 )
4582
4583                         /* dont use tail as the end marker for this traverse */
4584                         for ( cur = startbranch ; cur != scan ; cur = regnext( cur ) ) {
4585                             regnode * const noper = NEXTOPER( cur );
4586                             U8 noper_type = OP( noper );
4587                             U8 noper_trietype = TRIE_TYPE( noper_type );
4588 #if defined(DEBUGGING) || defined(NOJUMPTRIE)
4589                             regnode * const noper_next = regnext( noper );
4590                             U8 noper_next_type = (noper_next && noper_next < tail) ? OP(noper_next) : 0;
4591                             U8 noper_next_trietype = (noper_next && noper_next < tail) ? TRIE_TYPE( noper_next_type ) :0;
4592 #endif
4593
4594                             DEBUG_TRIE_COMPILE_r({
4595                                 regprop(RExC_rx, RExC_mysv, cur, NULL, pRExC_state);
4596                                 Perl_re_indentf( aTHX_  "- %d:%s (%d)",
4597                                    depth+1,
4598                                    REG_NODE_NUM(cur), SvPV_nolen_const( RExC_mysv ), REG_NODE_NUM(cur) );
4599
4600                                 regprop(RExC_rx, RExC_mysv, noper, NULL, pRExC_state);
4601                                 Perl_re_printf( aTHX_  " -> %d:%s",
4602                                     REG_NODE_NUM(noper), SvPV_nolen_const(RExC_mysv));
4603
4604                                 if ( noper_next ) {
4605                                   regprop(RExC_rx, RExC_mysv, noper_next, NULL, pRExC_state);
4606                                   Perl_re_printf( aTHX_ "\t=> %d:%s\t",
4607                                     REG_NODE_NUM(noper_next), SvPV_nolen_const(RExC_mysv));
4608                                 }
4609                                 Perl_re_printf( aTHX_  "(First==%d,Last==%d,Cur==%d,tt==%s,ntt==%s,nntt==%s)\n",
4610                                    REG_NODE_NUM(first), REG_NODE_NUM(last), REG_NODE_NUM(cur),
4611                                    PL_reg_name[trietype], PL_reg_name[noper_trietype], PL_reg_name[noper_next_trietype]
4612                                 );
4613                             });
4614
4615                             /* Is noper a trieable nodetype that can be merged
4616                              * with the current trie (if there is one)? */
4617                             if ( noper_trietype
4618                                   &&
4619                                   (
4620                                         ( noper_trietype == NOTHING )
4621                                         || ( trietype == NOTHING )
4622                                         || ( trietype == noper_trietype )
4623                                   )
4624 #ifdef NOJUMPTRIE
4625                                   && noper_next >= tail
4626 #endif
4627                                   && count < U16_MAX)
4628                             {
4629                                 /* Handle mergable triable node Either we are
4630                                  * the first node in a new trieable sequence,
4631                                  * in which case we do some bookkeeping,
4632                                  * otherwise we update the end pointer. */
4633                                 if ( !first ) {
4634                                     first = cur;
4635                                     if ( noper_trietype == NOTHING ) {
4636 #if !defined(DEBUGGING) && !defined(NOJUMPTRIE)
4637                                         regnode * const noper_next = regnext( noper );
4638                                         U8 noper_next_type = (noper_next && noper_next < tail) ? OP(noper_next) : 0;
4639                                         U8 noper_next_trietype = noper_next_type ? TRIE_TYPE( noper_next_type ) :0;
4640 #endif
4641
4642                                         if ( noper_next_trietype ) {
4643                                             trietype = noper_next_trietype;
4644                                         } else if (noper_next_type)  {
4645                                             /* a NOTHING regop is 1 regop wide.
4646                                              * We need at least two for a trie
4647                                              * so we can't merge this in */
4648                                             first = NULL;
4649                                         }
4650                                     } else {
4651                                         trietype = noper_trietype;
4652                                     }
4653                                 } else {
4654                                     if ( trietype == NOTHING )
4655                                         trietype = noper_trietype;
4656                                     last = cur;
4657                                 }
4658                                 if (first)
4659                                     count++;
4660                             } /* end handle mergable triable node */
4661                             else {
4662                                 /* handle unmergable node -
4663                                  * noper may either be a triable node which can
4664                                  * not be tried together with the current trie,
4665                                  * or a non triable node */
4666                                 if ( last ) {
4667                                     /* If last is set and trietype is not
4668                                      * NOTHING then we have found at least two
4669                                      * triable branch sequences in a row of a
4670                                      * similar trietype so we can turn them
4671                                      * into a trie. If/when we allow NOTHING to
4672                                      * start a trie sequence this condition
4673                                      * will be required, and it isn't expensive
4674                                      * so we leave it in for now. */
4675                                     if ( trietype && trietype != NOTHING )
4676                                         make_trie( pRExC_state,
4677                                                 startbranch, first, cur, tail,
4678                                                 count, trietype, depth+1 );
4679                                     last = NULL; /* note: we clear/update
4680                                                     first, trietype etc below,
4681                                                     so we dont do it here */
4682                                 }
4683                                 if ( noper_trietype
4684 #ifdef NOJUMPTRIE
4685                                      && noper_next >= tail
4686 #endif
4687                                 ){
4688                                     /* noper is triable, so we can start a new
4689                                      * trie sequence */
4690                                     count = 1;
4691                                     first = cur;
4692                                     trietype = noper_trietype;
4693                                 } else if (first) {
4694                                     /* if we already saw a first but the
4695                                      * current node is not triable then we have
4696                                      * to reset the first information. */
4697                                     count = 0;
4698                                     first = NULL;
4699                                     trietype = 0;
4700                                 }
4701                             } /* end handle unmergable node */
4702                         } /* loop over branches */
4703                         DEBUG_TRIE_COMPILE_r({
4704                             regprop(RExC_rx, RExC_mysv, cur, NULL, pRExC_state);
4705                             Perl_re_indentf( aTHX_  "- %s (%d) <SCAN FINISHED> ",
4706                               depth+1, SvPV_nolen_const( RExC_mysv ),REG_NODE_NUM(cur));
4707                             Perl_re_printf( aTHX_  "(First==%d, Last==%d, Cur==%d, tt==%s)\n",
4708                                REG_NODE_NUM(first), REG_NODE_NUM(last), REG_NODE_NUM(cur),
4709                                PL_reg_name[trietype]
4710                             );
4711
4712                         });
4713                         if ( last && trietype ) {
4714                             if ( trietype != NOTHING ) {
4715                                 /* the last branch of the sequence was part of
4716                                  * a trie, so we have to construct it here
4717                                  * outside of the loop */
4718                                 made= make_trie( pRExC_state, startbranch,
4719                                                  first, scan, tail, count,
4720                                                  trietype, depth+1 );
4721 #ifdef TRIE_STUDY_OPT
4722                                 if ( ((made == MADE_EXACT_TRIE &&
4723                                      startbranch == first)
4724                                      || ( first_non_open == first )) &&
4725                                      depth==0 ) {
4726                                     flags |= SCF_TRIE_RESTUDY;
4727                                     if ( startbranch == first
4728                                          && scan >= tail )
4729                                     {
4730                                         RExC_seen &=~REG_TOP_LEVEL_BRANCHES_SEEN;
4731                                     }
4732                                 }
4733 #endif
4734                             } else {
4735                                 /* at this point we know whatever we have is a
4736                                  * NOTHING sequence/branch AND if 'startbranch'
4737                                  * is 'first' then we can turn the whole thing
4738                                  * into a NOTHING
4739                                  */
4740                                 if ( startbranch == first ) {
4741                                     regnode *opt;
4742                                     /* the entire thing is a NOTHING sequence,
4743                                      * something like this: (?:|) So we can
4744                                      * turn it into a plain NOTHING op. */
4745                                     DEBUG_TRIE_COMPILE_r({
4746                                         regprop(RExC_rx, RExC_mysv, cur, NULL, pRExC_state);
4747                                         Perl_re_indentf( aTHX_  "- %s (%d) <NOTHING BRANCH SEQUENCE>\n",
4748                                           depth+1,
4749                                           SvPV_nolen_const( RExC_mysv ),REG_NODE_NUM(cur));
4750
4751                                     });
4752                                     OP(startbranch)= NOTHING;
4753                                     NEXT_OFF(startbranch)= tail - startbranch;
4754                                     for ( opt= startbranch + 1; opt < tail ; opt++ )
4755                                         OP(opt)= OPTIMIZED;
4756                                 }
4757                             }
4758                         } /* end if ( last) */
4759                     } /* TRIE_MAXBUF is non zero */
4760
4761                 } /* do trie */
4762
4763             }
4764             else if ( code == BRANCHJ ) {  /* single branch is optimized. */
4765                 scan = NEXTOPER(NEXTOPER(scan));
4766             } else                      /* single branch is optimized. */
4767                 scan = NEXTOPER(scan);
4768             continue;
4769         } else if (OP(scan) == SUSPEND || OP(scan) == GOSUB) {
4770             I32 paren = 0;
4771             regnode *start = NULL;
4772             regnode *end = NULL;
4773             U32 my_recursed_depth= recursed_depth;
4774
4775             if (OP(scan) != SUSPEND) { /* GOSUB */
4776                 /* Do setup, note this code has side effects beyond
4777                  * the rest of this block. Specifically setting
4778                  * RExC_recurse[] must happen at least once during
4779                  * study_chunk(). */
4780                 paren = ARG(scan);
4781                 RExC_recurse[ARG2L(scan)] = scan;
4782                 start = RExC_open_parens[paren];
4783                 end   = RExC_close_parens[paren];
4784
4785                 /* NOTE we MUST always execute the above code, even
4786                  * if we do nothing with a GOSUB */
4787                 if (
4788                     ( flags & SCF_IN_DEFINE )
4789                     ||
4790                     (
4791                         (is_inf_internal || is_inf || (data && data->flags & SF_IS_INF))
4792                         &&
4793                         ( (flags & (SCF_DO_STCLASS | SCF_DO_SUBSTR)) == 0 )
4794                     )
4795                 ) {
4796                     /* no need to do anything here if we are in a define. */
4797                     /* or we are after some kind of infinite construct
4798                      * so we can skip recursing into this item.
4799                      * Since it is infinite we will not change the maxlen
4800                      * or delta, and if we miss something that might raise
4801                      * the minlen it will merely pessimise a little.
4802                      *
4803                      * Iow /(?(DEFINE)(?<foo>foo|food))a+(?&foo)/
4804                      * might result in a minlen of 1 and not of 4,
4805                      * but this doesn't make us mismatch, just try a bit
4806                      * harder than we should.
4807                      * */
4808                     scan= regnext(scan);
4809                     continue;
4810                 }
4811
4812                 if (
4813                     !recursed_depth
4814                     ||
4815                     !PAREN_TEST(RExC_study_chunk_recursed + ((recursed_depth-1) * RExC_study_chunk_recursed_bytes), paren)
4816                 ) {
4817                     /* it is quite possible that there are more efficient ways
4818                      * to do this. We maintain a bitmap per level of recursion
4819                      * of which patterns we have entered so we can detect if a
4820                      * pattern creates a possible infinite loop. When we
4821                      * recurse down a level we copy the previous levels bitmap
4822                      * down. When we are at recursion level 0 we zero the top
4823                      * level bitmap. It would be nice to implement a different
4824                      * more efficient way of doing this. In particular the top
4825                      * level bitmap may be unnecessary.
4826                      */
4827                     if (!recursed_depth) {
4828                         Zero(RExC_study_chunk_recursed, RExC_study_chunk_recursed_bytes, U8);
4829                     } else {
4830                         Copy(RExC_study_chunk_recursed + ((recursed_depth-1) * RExC_study_chunk_recursed_bytes),
4831                              RExC_study_chunk_recursed + (recursed_depth * RExC_study_chunk_recursed_bytes),
4832                              RExC_study_chunk_recursed_bytes, U8);
4833                     }
4834                     /* we havent recursed into this paren yet, so recurse into it */
4835                     DEBUG_STUDYDATA("gosub-set", data, depth, is_inf);
4836                     PAREN_SET(RExC_study_chunk_recursed + (recursed_depth * RExC_study_chunk_recursed_bytes), paren);
4837                     my_recursed_depth= recursed_depth + 1;
4838                 } else {
4839                     DEBUG_STUDYDATA("gosub-inf", data, depth, is_inf);
4840                     /* some form of infinite recursion, assume infinite length
4841                      * */
4842                     if (flags & SCF_DO_SUBSTR) {
4843                         scan_commit(pRExC_state, data, minlenp, is_inf);
4844                         data->cur_is_floating = 1;
4845                     }
4846                     is_inf = is_inf_internal = 1;
4847                     if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
4848                         ssc_anything(data->start_class);
4849                     flags &= ~SCF_DO_STCLASS;
4850
4851                     start= NULL; /* reset start so we dont recurse later on. */
4852                 }
4853             } else {
4854                 paren = stopparen;
4855                 start = scan + 2;
4856                 end = regnext(scan);
4857             }
4858             if (start) {
4859                 scan_frame *newframe;
4860                 assert(end);
4861                 if (!RExC_frame_last) {
4862                     Newxz(newframe, 1, scan_frame);
4863                     SAVEDESTRUCTOR_X(S_unwind_scan_frames, newframe);
4864                     RExC_frame_head= newframe;
4865                     RExC_frame_count++;
4866                 } else if (!RExC_frame_last->next_frame) {
4867                     Newxz(newframe,1,scan_frame);
4868                     RExC_frame_last->next_frame= newframe;
4869                     newframe->prev_frame= RExC_frame_last;
4870                     RExC_frame_count++;
4871                 } else {
4872                     newframe= RExC_frame_last->next_frame;
4873                 }
4874                 RExC_frame_last= newframe;
4875
4876                 newframe->next_regnode = regnext(scan);
4877                 newframe->last_regnode = last;
4878                 newframe->stopparen = stopparen;
4879                 newframe->prev_recursed_depth = recursed_depth;
4880                 newframe->this_prev_frame= frame;
4881
4882                 DEBUG_STUDYDATA("frame-new", data, depth, is_inf);
4883                 DEBUG_PEEP("fnew", scan, depth, flags);
4884
4885                 frame = newframe;
4886                 scan =  start;
4887                 stopparen = paren;
4888                 last = end;
4889                 depth = depth + 1;
4890                 recursed_depth= my_recursed_depth;
4891
4892                 continue;
4893             }
4894         }
4895         else if (OP(scan) == EXACT || OP(scan) == EXACTL) {
4896             SSize_t l = STR_LEN(scan);
4897             UV uc;
4898             assert(l);
4899             if (UTF) {
4900                 const U8 * const s = (U8*)STRING(scan);
4901                 uc = utf8_to_uvchr_buf(s, s + l, NULL);
4902                 l = utf8_length(s, s + l);
4903             } else {
4904                 uc = *((U8*)STRING(scan));
4905             }
4906             min += l;
4907             if (flags & SCF_DO_SUBSTR) { /* Update longest substr. */
4908                 /* The code below prefers earlier match for fixed
4909                    offset, later match for variable offset.  */
4910                 if (data->last_end == -1) { /* Update the start info. */
4911                     data->last_start_min = data->pos_min;
4912                     data->last_start_max = is_inf
4913                         ? SSize_t_MAX : data->pos_min + data->pos_delta;
4914                 }
4915                 sv_catpvn(data->last_found, STRING(scan), STR_LEN(scan));
4916                 if (UTF)
4917                     SvUTF8_on(data->last_found);
4918                 {
4919                     SV * const sv = data->last_found;
4920                     MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
4921                         mg_find(sv, PERL_MAGIC_utf8) : NULL;
4922                     if (mg && mg->mg_len >= 0)
4923                         mg->mg_len += utf8_length((U8*)STRING(scan),
4924                                               (U8*)STRING(scan)+STR_LEN(scan));
4925                 }
4926                 data->last_end = data->pos_min + l;
4927                 data->pos_min += l; /* As in the first entry. */
4928                 data->flags &= ~SF_BEFORE_EOL;
4929             }
4930
4931             /* ANDing the code point leaves at most it, and not in locale, and
4932              * can't match null string */
4933             if (flags & SCF_DO_STCLASS_AND) {
4934                 ssc_cp_and(data->start_class, uc);
4935                 ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
4936                 ssc_clear_locale(data->start_class);
4937             }
4938             else if (flags & SCF_DO_STCLASS_OR) {
4939                 ssc_add_cp(data->start_class, uc);
4940                 ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
4941
4942                 /* See commit msg 749e076fceedeb708a624933726e7989f2302f6a */
4943                 ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
4944             }
4945             flags &= ~SCF_DO_STCLASS;
4946         }
4947         else if (PL_regkind[OP(scan)] == EXACT) {
4948             /* But OP != EXACT!, so is EXACTFish */
4949             SSize_t l = STR_LEN(scan);
4950             const U8 * s = (U8*)STRING(scan);
4951
4952             /* Search for fixed substrings supports EXACT only. */
4953             if (flags & SCF_DO_SUBSTR) {
4954                 assert(data);
4955                 scan_commit(pRExC_state, data, minlenp, is_inf);
4956             }
4957             if (UTF) {
4958                 l = utf8_length(s, s + l);
4959             }
4960             if (unfolded_multi_char) {
4961                 RExC_seen |= REG_UNFOLDED_MULTI_SEEN;
4962             }
4963             min += l - min_subtract;
4964             assert (min >= 0);
4965             delta += min_subtract;
4966             if (flags & SCF_DO_SUBSTR) {
4967                 data->pos_min += l - min_subtract;
4968                 if (data->pos_min < 0) {
4969                     data->pos_min = 0;
4970                 }
4971                 data->pos_delta += min_subtract;
4972                 if (min_subtract) {
4973                     data->cur_is_floating = 1; /* float */
4974                 }
4975             }
4976
4977             if (flags & SCF_DO_STCLASS) {
4978                 SV* EXACTF_invlist = _make_exactf_invlist(pRExC_state, scan);
4979
4980                 assert(EXACTF_invlist);
4981                 if (flags & SCF_DO_STCLASS_AND) {
4982                     if (OP(scan) != EXACTFL)
4983                         ssc_clear_locale(data->start_class);
4984                     ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
4985                     ANYOF_POSIXL_ZERO(data->start_class);
4986                     ssc_intersection(data->start_class, EXACTF_invlist, FALSE);
4987                 }
4988                 else {  /* SCF_DO_STCLASS_OR */
4989                     ssc_union(data->start_class, EXACTF_invlist, FALSE);
4990                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
4991
4992                     /* See commit msg 749e076fceedeb708a624933726e7989f2302f6a */
4993                     ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
4994                 }
4995                 flags &= ~SCF_DO_STCLASS;
4996                 SvREFCNT_dec(EXACTF_invlist);
4997             }
4998         }
4999         else if (REGNODE_VARIES(OP(scan))) {
5000             SSize_t mincount, maxcount, minnext, deltanext, pos_before = 0;
5001             I32 fl = 0, f = flags;
5002             regnode * const oscan = scan;
5003             regnode_ssc this_class;
5004             regnode_ssc *oclass = NULL;
5005             I32 next_is_eval = 0;
5006
5007             switch (PL_regkind[OP(scan)]) {
5008             case WHILEM:                /* End of (?:...)* . */
5009                 scan = NEXTOPER(scan);
5010                 goto finish;
5011             case PLUS:
5012                 if (flags & (SCF_DO_SUBSTR | SCF_DO_STCLASS)) {
5013                     next = NEXTOPER(scan);
5014                     if (OP(next) == EXACT
5015                         || OP(next) == EXACTL
5016                         || (flags & SCF_DO_STCLASS))
5017                     {
5018                         mincount = 1;
5019                         maxcount = REG_INFTY;
5020                         next = regnext(scan);
5021                         scan = NEXTOPER(scan);
5022                         goto do_curly;
5023                     }
5024                 }
5025                 if (flags & SCF_DO_SUBSTR)
5026                     data->pos_min++;
5027                 min++;
5028                 /* FALLTHROUGH */
5029             case STAR:
5030                 if (flags & SCF_DO_STCLASS) {
5031                     mincount = 0;
5032                     maxcount = REG_INFTY;
5033                     next = regnext(scan);
5034                     scan = NEXTOPER(scan);
5035                     goto do_curly;
5036                 }
5037                 if (flags & SCF_DO_SUBSTR) {
5038                     scan_commit(pRExC_state, data, minlenp, is_inf);
5039                     /* Cannot extend fixed substrings */
5040                     data->cur_is_floating = 1; /* float */
5041                 }
5042                 is_inf = is_inf_internal = 1;
5043                 scan = regnext(scan);
5044                 goto optimize_curly_tail;
5045             case CURLY:
5046                 if (stopparen>0 && (OP(scan)==CURLYN || OP(scan)==CURLYM)
5047                     && (scan->flags == stopparen))
5048                 {
5049                     mincount = 1;
5050                     maxcount = 1;
5051                 } else {
5052                     mincount = ARG1(scan);
5053                     maxcount = ARG2(scan);
5054                 }
5055                 next = regnext(scan);
5056                 if (OP(scan) == CURLYX) {
5057                     I32 lp = (data ? *(data->last_closep) : 0);
5058                     scan->flags = ((lp <= (I32)U8_MAX) ? (U8)lp : U8_MAX);
5059                 }
5060                 scan = NEXTOPER(scan) + EXTRA_STEP_2ARGS;
5061                 next_is_eval = (OP(scan) == EVAL);
5062               do_curly:
5063                 if (flags & SCF_DO_SUBSTR) {
5064                     if (mincount == 0)
5065                         scan_commit(pRExC_state, data, minlenp, is_inf);
5066                     /* Cannot extend fixed substrings */
5067                     pos_before = data->pos_min;
5068                 }
5069                 if (data) {
5070                     fl = data->flags;
5071                     data->flags &= ~(SF_HAS_PAR|SF_IN_PAR|SF_HAS_EVAL);
5072                     if (is_inf)
5073                         data->flags |= SF_IS_INF;
5074                 }
5075                 if (flags & SCF_DO_STCLASS) {
5076                     ssc_init(pRExC_state, &this_class);
5077                     oclass = data->start_class;
5078                     data->start_class = &this_class;
5079                     f |= SCF_DO_STCLASS_AND;
5080                     f &= ~SCF_DO_STCLASS_OR;
5081                 }
5082                 /* Exclude from super-linear cache processing any {n,m}
5083                    regops for which the combination of input pos and regex
5084                    pos is not enough information to determine if a match
5085                    will be possible.
5086
5087                    For example, in the regex /foo(bar\s*){4,8}baz/ with the
5088                    regex pos at the \s*, the prospects for a match depend not
5089                    only on the input position but also on how many (bar\s*)
5090                    repeats into the {4,8} we are. */
5091                if ((mincount > 1) || (maxcount > 1 && maxcount != REG_INFTY))
5092                     f &= ~SCF_WHILEM_VISITED_POS;
5093
5094                 /* This will finish on WHILEM, setting scan, or on NULL: */
5095                 /* recurse study_chunk() on loop bodies */
5096                 minnext = study_chunk(pRExC_state, &scan, minlenp, &deltanext,
5097                                   last, data, stopparen, recursed_depth, NULL,
5098                                   (mincount == 0
5099                                    ? (f & ~SCF_DO_SUBSTR)
5100                                    : f)
5101                                   ,depth+1);
5102
5103                 if (flags & SCF_DO_STCLASS)
5104                     data->start_class = oclass;
5105                 if (mincount == 0 || minnext == 0) {
5106                     if (flags & SCF_DO_STCLASS_OR) {
5107                         ssc_or(pRExC_state, data->start_class, (regnode_charclass *) &this_class);
5108                     }
5109                     else if (flags & SCF_DO_STCLASS_AND) {
5110                         /* Switch to OR mode: cache the old value of
5111                          * data->start_class */
5112                         INIT_AND_WITHP;
5113                         StructCopy(data->start_class, and_withp, regnode_ssc);
5114                         flags &= ~SCF_DO_STCLASS_AND;
5115                         StructCopy(&this_class, data->start_class, regnode_ssc);
5116                         flags |= SCF_DO_STCLASS_OR;
5117                         ANYOF_FLAGS(data->start_class)
5118                                                 |= SSC_MATCHES_EMPTY_STRING;
5119                     }
5120                 } else {                /* Non-zero len */
5121                     if (flags & SCF_DO_STCLASS_OR) {
5122                         ssc_or(pRExC_state, data->start_class, (regnode_charclass *) &this_class);
5123                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5124                     }
5125                     else if (flags & SCF_DO_STCLASS_AND)
5126                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &this_class);
5127                     flags &= ~SCF_DO_STCLASS;
5128                 }
5129                 if (!scan)              /* It was not CURLYX, but CURLY. */
5130                     scan = next;
5131                 if (((flags & (SCF_TRIE_DOING_RESTUDY|SCF_DO_SUBSTR))==SCF_DO_SUBSTR)
5132                     /* ? quantifier ok, except for (?{ ... }) */
5133                     && (next_is_eval || !(mincount == 0 && maxcount == 1))
5134                     && (minnext == 0) && (deltanext == 0)
5135                     && data && !(data->flags & (SF_HAS_PAR|SF_IN_PAR))
5136                     && maxcount <= REG_INFTY/3) /* Complement check for big
5137                                                    count */
5138                 {
5139                     /* Fatal warnings may leak the regexp without this: */
5140                     SAVEFREESV(RExC_rx_sv);
5141                     Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),
5142                         "Quantifier unexpected on zero-length expression "
5143                         "in regex m/%" UTF8f "/",
5144                          UTF8fARG(UTF, RExC_precomp_end - RExC_precomp,
5145                                   RExC_precomp));
5146                     (void)ReREFCNT_inc(RExC_rx_sv);
5147                 }
5148
5149                 min += minnext * mincount;
5150                 is_inf_internal |= deltanext == SSize_t_MAX
5151                          || (maxcount == REG_INFTY && minnext + deltanext > 0);
5152                 is_inf |= is_inf_internal;
5153                 if (is_inf) {
5154                     delta = SSize_t_MAX;
5155                 } else {
5156                     delta += (minnext + deltanext) * maxcount
5157                              - minnext * mincount;
5158                 }
5159                 /* Try powerful optimization CURLYX => CURLYN. */
5160                 if (  OP(oscan) == CURLYX && data
5161                       && data->flags & SF_IN_PAR
5162                       && !(data->flags & SF_HAS_EVAL)
5163                       && !deltanext && minnext == 1 ) {
5164                     /* Try to optimize to CURLYN.  */
5165                     regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS;
5166                     regnode * const nxt1 = nxt;
5167 #ifdef DEBUGGING
5168                     regnode *nxt2;
5169 #endif
5170
5171                     /* Skip open. */
5172                     nxt = regnext(nxt);
5173                     if (!REGNODE_SIMPLE(OP(nxt))
5174                         && !(PL_regkind[OP(nxt)] == EXACT
5175                              && STR_LEN(nxt) == 1))
5176                         goto nogo;
5177 #ifdef DEBUGGING
5178                     nxt2 = nxt;
5179 #endif
5180                     nxt = regnext(nxt);
5181                     if (OP(nxt) != CLOSE)
5182                         goto nogo;
5183                     if (RExC_open_parens) {
5184                         RExC_open_parens[ARG(nxt1)]=oscan; /*open->CURLYM*/
5185                         RExC_close_parens[ARG(nxt1)]=nxt+2; /*close->while*/
5186                     }
5187                     /* Now we know that nxt2 is the only contents: */
5188                     oscan->flags = (U8)ARG(nxt);
5189                     OP(oscan) = CURLYN;
5190                     OP(nxt1) = NOTHING; /* was OPEN. */
5191
5192 #ifdef DEBUGGING
5193                     OP(nxt1 + 1) = OPTIMIZED; /* was count. */
5194                     NEXT_OFF(nxt1+ 1) = 0; /* just for consistency. */
5195                     NEXT_OFF(nxt2) = 0; /* just for consistency with CURLY. */
5196                     OP(nxt) = OPTIMIZED;        /* was CLOSE. */
5197                     OP(nxt + 1) = OPTIMIZED; /* was count. */
5198                     NEXT_OFF(nxt+ 1) = 0; /* just for consistency. */
5199 #endif
5200                 }
5201               nogo:
5202
5203                 /* Try optimization CURLYX => CURLYM. */
5204                 if (  OP(oscan) == CURLYX && data
5205                       && !(data->flags & SF_HAS_PAR)
5206                       && !(data->flags & SF_HAS_EVAL)
5207                       && !deltanext     /* atom is fixed width */
5208                       && minnext != 0   /* CURLYM can't handle zero width */
5209
5210                          /* Nor characters whose fold at run-time may be
5211                           * multi-character */
5212                       && ! (RExC_seen & REG_UNFOLDED_MULTI_SEEN)
5213                 ) {
5214                     /* XXXX How to optimize if data == 0? */
5215                     /* Optimize to a simpler form.  */
5216                     regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN */
5217                     regnode *nxt2;
5218
5219                     OP(oscan) = CURLYM;
5220                     while ( (nxt2 = regnext(nxt)) /* skip over embedded stuff*/
5221                             && (OP(nxt2) != WHILEM))
5222                         nxt = nxt2;
5223                     OP(nxt2)  = SUCCEED; /* Whas WHILEM */
5224                     /* Need to optimize away parenths. */
5225                     if ((data->flags & SF_IN_PAR) && OP(nxt) == CLOSE) {
5226                         /* Set the parenth number.  */
5227                         regnode *nxt1 = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN*/
5228
5229                         oscan->flags = (U8)ARG(nxt);
5230                         if (RExC_open_parens) {
5231                             RExC_open_parens[ARG(nxt1)]=oscan; /*open->CURLYM*/
5232                             RExC_close_parens[ARG(nxt1)]=nxt2+1; /*close->NOTHING*/
5233                         }
5234                         OP(nxt1) = OPTIMIZED;   /* was OPEN. */
5235                         OP(nxt) = OPTIMIZED;    /* was CLOSE. */
5236
5237 #ifdef DEBUGGING
5238                         OP(nxt1 + 1) = OPTIMIZED; /* was count. */
5239                         OP(nxt + 1) = OPTIMIZED; /* was count. */
5240                         NEXT_OFF(nxt1 + 1) = 0; /* just for consistency. */
5241                         NEXT_OFF(nxt + 1) = 0; /* just for consistency. */
5242 #endif
5243 #if 0
5244                         while ( nxt1 && (OP(nxt1) != WHILEM)) {
5245                             regnode *nnxt = regnext(nxt1);
5246                             if (nnxt == nxt) {
5247                                 if (reg_off_by_arg[OP(nxt1)])
5248                                     ARG_SET(nxt1, nxt2 - nxt1);
5249                                 else if (nxt2 - nxt1 < U16_MAX)
5250                                     NEXT_OFF(nxt1) = nxt2 - nxt1;
5251                                 else
5252                                     OP(nxt) = NOTHING;  /* Cannot beautify */
5253                             }
5254                             nxt1 = nnxt;
5255                         }
5256 #endif
5257                         /* Optimize again: */
5258                         /* recurse study_chunk() on optimised CURLYX => CURLYM */
5259                         study_chunk(pRExC_state, &nxt1, minlenp, &deltanext, nxt,
5260                                     NULL, stopparen, recursed_depth, NULL, 0,depth+1);
5261                     }
5262                     else
5263                         oscan->flags = 0;
5264                 }
5265                 else if ((OP(oscan) == CURLYX)
5266                          && (flags & SCF_WHILEM_VISITED_POS)
5267                          /* See the comment on a similar expression above.
5268                             However, this time it's not a subexpression
5269                             we care about, but the expression itself. */
5270                          && (maxcount == REG_INFTY)
5271                          && data) {
5272                     /* This stays as CURLYX, we can put the count/of pair. */
5273                     /* Find WHILEM (as in regexec.c) */
5274                     regnode *nxt = oscan + NEXT_OFF(oscan);
5275
5276                     if (OP(PREVOPER(nxt)) == NOTHING) /* LONGJMP */
5277                         nxt += ARG(nxt);
5278                     nxt = PREVOPER(nxt);
5279                     if (nxt->flags & 0xf) {
5280                         /* we've already set whilem count on this node */
5281                     } else if (++data->whilem_c < 16) {
5282                         assert(data->whilem_c <= RExC_whilem_seen);
5283                         nxt->flags = (U8)(data->whilem_c
5284                             | (RExC_whilem_seen << 4)); /* On WHILEM */
5285                     }
5286                 }
5287                 if (data && fl & (SF_HAS_PAR|SF_IN_PAR))
5288                     pars++;
5289                 if (flags & SCF_DO_SUBSTR) {
5290                     SV *last_str = NULL;
5291                     STRLEN last_chrs = 0;
5292                     int counted = mincount != 0;
5293
5294                     if (data->last_end > 0 && mincount != 0) { /* Ends with a
5295                                                                   string. */
5296                         SSize_t b = pos_before >= data->last_start_min
5297                             ? pos_before : data->last_start_min;
5298                         STRLEN l;
5299                         const char * const s = SvPV_const(data->last_found, l);
5300                         SSize_t old = b - data->last_start_min;
5301
5302                         if (UTF)
5303                             old = utf8_hop((U8*)s, old) - (U8*)s;
5304                         l -= old;
5305                         /* Get the added string: */
5306                         last_str = newSVpvn_utf8(s  + old, l, UTF);
5307                         last_chrs = UTF ? utf8_length((U8*)(s + old),
5308                                             (U8*)(s + old + l)) : l;
5309                         if (deltanext == 0 && pos_before == b) {
5310                             /* What was added is a constant string */
5311                             if (mincount > 1) {
5312
5313                                 SvGROW(last_str, (mincount * l) + 1);
5314                                 repeatcpy(SvPVX(last_str) + l,
5315                                           SvPVX_const(last_str), l,
5316                                           mincount - 1);
5317                                 SvCUR_set(last_str, SvCUR(last_str) * mincount);
5318                                 /* Add additional parts. */
5319                                 SvCUR_set(data->last_found,
5320                                           SvCUR(data->last_found) - l);
5321                                 sv_catsv(data->last_found, last_str);
5322                                 {
5323                                     SV * sv = data->last_found;
5324                                     MAGIC *mg =
5325                                         SvUTF8(sv) && SvMAGICAL(sv) ?
5326                                         mg_find(sv, PERL_MAGIC_utf8) : NULL;
5327                                     if (mg && mg->mg_len >= 0)
5328                                         mg->mg_len += last_chrs * (mincount-1);
5329                                 }
5330                                 last_chrs *= mincount;
5331                                 data->last_end += l * (mincount - 1);
5332                             }
5333                         } else {
5334                             /* start offset must point into the last copy */
5335                             data->last_start_min += minnext * (mincount - 1);
5336                             data->last_start_max =
5337                               is_inf
5338                                ? SSize_t_MAX
5339                                : data->last_start_max +
5340                                  (maxcount - 1) * (minnext + data->pos_delta);
5341                         }
5342                     }
5343                     /* It is counted once already... */
5344                     data->pos_min += minnext * (mincount - counted);
5345 #if 0
5346 Perl_re_printf( aTHX_  "counted=%" UVuf " deltanext=%" UVuf
5347                               " SSize_t_MAX=%" UVuf " minnext=%" UVuf
5348                               " maxcount=%" UVuf " mincount=%" UVuf "\n",
5349     (UV)counted, (UV)deltanext, (UV)SSize_t_MAX, (UV)minnext, (UV)maxcount,
5350     (UV)mincount);
5351 if (deltanext != SSize_t_MAX)
5352 Perl_re_printf( aTHX_  "LHS=%" UVuf " RHS=%" UVuf "\n",
5353     (UV)(-counted * deltanext + (minnext + deltanext) * maxcount
5354           - minnext * mincount), (UV)(SSize_t_MAX - data->pos_delta));
5355 #endif
5356                     if (deltanext == SSize_t_MAX
5357                         || -counted * deltanext + (minnext + deltanext) * maxcount - minnext * mincount >= SSize_t_MAX - data->pos_delta)
5358                         data->pos_delta = SSize_t_MAX;
5359                     else
5360                         data->pos_delta += - counted * deltanext +
5361                         (minnext + deltanext) * maxcount - minnext * mincount;
5362                     if (mincount != maxcount) {
5363                          /* Cannot extend fixed substrings found inside
5364                             the group.  */
5365                         scan_commit(pRExC_state, data, minlenp, is_inf);
5366                         if (mincount && last_str) {
5367                             SV * const sv = data->last_found;
5368                             MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
5369                                 mg_find(sv, PERL_MAGIC_utf8) : NULL;
5370
5371                             if (mg)
5372                                 mg->mg_len = -1;
5373                             sv_setsv(sv, last_str);
5374                             data->last_end = data->pos_min;
5375                             data->last_start_min = data->pos_min - last_chrs;
5376                             data->last_start_max = is_inf
5377                                 ? SSize_t_MAX
5378                                 : data->pos_min + data->pos_delta - last_chrs;
5379                         }
5380                         data->cur_is_floating = 1; /* float */
5381                     }
5382                     SvREFCNT_dec(last_str);
5383                 }
5384                 if (data && (fl & SF_HAS_EVAL))
5385                     data->flags |= SF_HAS_EVAL;
5386               optimize_curly_tail:
5387                 if (OP(oscan) != CURLYX) {
5388                     while (PL_regkind[OP(next = regnext(oscan))] == NOTHING
5389                            && NEXT_OFF(next))
5390                         NEXT_OFF(oscan) += NEXT_OFF(next);
5391                 }
5392                 continue;
5393
5394             default:
5395 #ifdef DEBUGGING
5396                 Perl_croak(aTHX_ "panic: unexpected varying REx opcode %d",
5397                                                                     OP(scan));
5398 #endif
5399             case REF:
5400             case CLUMP:
5401                 if (flags & SCF_DO_SUBSTR) {
5402                     /* Cannot expect anything... */
5403                     scan_commit(pRExC_state, data, minlenp, is_inf);
5404                     data->cur_is_floating = 1; /* float */
5405                 }
5406                 is_inf = is_inf_internal = 1;
5407                 if (flags & SCF_DO_STCLASS_OR) {
5408                     if (OP(scan) == CLUMP) {
5409                         /* Actually is any start char, but very few code points
5410                          * aren't start characters */
5411                         ssc_match_all_cp(data->start_class);
5412                     }
5413                     else {
5414                         ssc_anything(data->start_class);
5415                     }
5416                 }
5417                 flags &= ~SCF_DO_STCLASS;
5418                 break;
5419             }
5420         }
5421         else if (OP(scan) == LNBREAK) {
5422             if (flags & SCF_DO_STCLASS) {
5423                 if (flags & SCF_DO_STCLASS_AND) {
5424                     ssc_intersection(data->start_class,
5425                                     PL_XPosix_ptrs[_CC_VERTSPACE], FALSE);
5426                     ssc_clear_locale(data->start_class);
5427                     ANYOF_FLAGS(data->start_class)
5428                                                 &= ~SSC_MATCHES_EMPTY_STRING;
5429                 }
5430                 else if (flags & SCF_DO_STCLASS_OR) {
5431                     ssc_union(data->start_class,
5432                               PL_XPosix_ptrs[_CC_VERTSPACE],
5433                               FALSE);
5434                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5435
5436                     /* See commit msg for
5437                      * 749e076fceedeb708a624933726e7989f2302f6a */
5438                     ANYOF_FLAGS(data->start_class)
5439                                                 &= ~SSC_MATCHES_EMPTY_STRING;
5440                 }
5441                 flags &= ~SCF_DO_STCLASS;
5442             }
5443             min++;
5444             if (delta != SSize_t_MAX)
5445                 delta++;    /* Because of the 2 char string cr-lf */
5446             if (flags & SCF_DO_SUBSTR) {
5447                 /* Cannot expect anything... */
5448                 scan_commit(pRExC_state, data, minlenp, is_inf);
5449                 data->pos_min += 1;
5450                 data->pos_delta += 1;
5451                 data->cur_is_floating = 1; /* float */
5452             }
5453         }
5454         else if (REGNODE_SIMPLE(OP(scan))) {
5455
5456             if (flags & SCF_DO_SUBSTR) {
5457                 scan_commit(pRExC_state, data, minlenp, is_inf);
5458                 data->pos_min++;
5459             }
5460             min++;
5461             if (flags & SCF_DO_STCLASS) {
5462                 bool invert = 0;
5463                 SV* my_invlist = NULL;
5464                 U8 namedclass;
5465
5466                 /* See commit msg 749e076fceedeb708a624933726e7989f2302f6a */
5467                 ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
5468
5469                 /* Some of the logic below assumes that switching
5470                    locale on will only add false positives. */
5471                 switch (OP(scan)) {
5472
5473                 default:
5474 #ifdef DEBUGGING
5475                    Perl_croak(aTHX_ "panic: unexpected simple REx opcode %d",
5476                                                                      OP(scan));
5477 #endif
5478                 case SANY:
5479                     if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
5480                         ssc_match_all_cp(data->start_class);
5481                     break;
5482
5483                 case REG_ANY:
5484                     {
5485                         SV* REG_ANY_invlist = _new_invlist(2);
5486                         REG_ANY_invlist = add_cp_to_invlist(REG_ANY_invlist,
5487                                                             '\n');
5488                         if (flags & SCF_DO_STCLASS_OR) {
5489                             ssc_union(data->start_class,
5490                                       REG_ANY_invlist,
5491                                       TRUE /* TRUE => invert, hence all but \n
5492                                             */
5493                                       );
5494                         }
5495                         else if (flags & SCF_DO_STCLASS_AND) {
5496                             ssc_intersection(data->start_class,
5497                                              REG_ANY_invlist,
5498                                              TRUE  /* TRUE => invert */
5499                                              );
5500                             ssc_clear_locale(data->start_class);
5501                         }
5502                         SvREFCNT_dec_NN(REG_ANY_invlist);
5503                     }
5504                     break;
5505
5506                 case ANYOFD:
5507                 case ANYOFL:
5508                 case ANYOF:
5509                     if (flags & SCF_DO_STCLASS_AND)
5510                         ssc_and(pRExC_state, data->start_class,
5511                                 (regnode_charclass *) scan);
5512                     else
5513                         ssc_or(pRExC_state, data->start_class,
5514                                                           (regnode_charclass *) scan);
5515                     break;
5516
5517                 case NPOSIXL:
5518                     invert = 1;
5519                     /* FALLTHROUGH */
5520
5521                 case POSIXL:
5522                     namedclass = classnum_to_namedclass(FLAGS(scan)) + invert;
5523                     if (flags & SCF_DO_STCLASS_AND) {
5524                         bool was_there = cBOOL(
5525                                           ANYOF_POSIXL_TEST(data->start_class,
5526                                                                  namedclass));
5527                         ANYOF_POSIXL_ZERO(data->start_class);
5528                         if (was_there) {    /* Do an AND */
5529                             ANYOF_POSIXL_SET(data->start_class, namedclass);
5530                         }
5531                         /* No individual code points can now match */
5532                         data->start_class->invlist
5533                                                 = sv_2mortal(_new_invlist(0));
5534                     }
5535                     else {
5536                         int complement = namedclass + ((invert) ? -1 : 1);
5537
5538                         assert(flags & SCF_DO_STCLASS_OR);
5539
5540                         /* If the complement of this class was already there,
5541                          * the result is that they match all code points,
5542                          * (\d + \D == everything).  Remove the classes from
5543                          * future consideration.  Locale is not relevant in
5544                          * this case */
5545                         if (ANYOF_POSIXL_TEST(data->start_class, complement)) {
5546                             ssc_match_all_cp(data->start_class);
5547                             ANYOF_POSIXL_CLEAR(data->start_class, namedclass);
5548                             ANYOF_POSIXL_CLEAR(data->start_class, complement);
5549                         }
5550                         else {  /* The usual case; just add this class to the
5551                                    existing set */
5552                             ANYOF_POSIXL_SET(data->start_class, namedclass);
5553                         }
5554                     }
5555                     break;
5556
5557                 case NPOSIXA:   /* For these, we always know the exact set of
5558                                    what's matched */
5559                     invert = 1;
5560                     /* FALLTHROUGH */
5561                 case POSIXA:
5562                     if (FLAGS(scan) == _CC_ASCII) {
5563                         my_invlist = invlist_clone(PL_XPosix_ptrs[_CC_ASCII]);
5564                     }
5565                     else {
5566                         _invlist_intersection(PL_XPosix_ptrs[FLAGS(scan)],
5567                                               PL_XPosix_ptrs[_CC_ASCII],
5568                                               &my_invlist);
5569                     }
5570                     goto join_posix;
5571
5572                 case NPOSIXD:
5573                 case NPOSIXU:
5574                     invert = 1;
5575                     /* FALLTHROUGH */
5576                 case POSIXD:
5577                 case POSIXU:
5578                     my_invlist = invlist_clone(PL_XPosix_ptrs[FLAGS(scan)]);
5579
5580                     /* NPOSIXD matches all upper Latin1 code points unless the
5581                      * target string being matched is UTF-8, which is
5582                      * unknowable until match time.  Since we are going to
5583                      * invert, we want to get rid of all of them so that the
5584                      * inversion will match all */
5585                     if (OP(scan) == NPOSIXD) {
5586                         _invlist_subtract(my_invlist, PL_UpperLatin1,
5587                                           &my_invlist);
5588                     }
5589
5590                   join_posix:
5591
5592                     if (flags & SCF_DO_STCLASS_AND) {
5593                         ssc_intersection(data->start_class, my_invlist, invert);
5594                         ssc_clear_locale(data->start_class);
5595                     }
5596                     else {
5597                         assert(flags & SCF_DO_STCLASS_OR);
5598                         ssc_union(data->start_class, my_invlist, invert);
5599                     }
5600                     SvREFCNT_dec(my_invlist);
5601                 }
5602                 if (flags & SCF_DO_STCLASS_OR)
5603                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5604                 flags &= ~SCF_DO_STCLASS;
5605             }
5606         }
5607         else if (PL_regkind[OP(scan)] == EOL && flags & SCF_DO_SUBSTR) {
5608             data->flags |= (OP(scan) == MEOL
5609                             ? SF_BEFORE_MEOL
5610                             : SF_BEFORE_SEOL);
5611             scan_commit(pRExC_state, data, minlenp, is_inf);
5612
5613         }
5614         else if (  PL_regkind[OP(scan)] == BRANCHJ
5615                  /* Lookbehind, or need to calculate parens/evals/stclass: */
5616                    && (scan->flags || data || (flags & SCF_DO_STCLASS))
5617                    && (OP(scan) == IFMATCH || OP(scan) == UNLESSM))
5618         {
5619             if ( !PERL_ENABLE_POSITIVE_ASSERTION_STUDY
5620                 || OP(scan) == UNLESSM )
5621             {
5622                 /* Negative Lookahead/lookbehind
5623                    In this case we can't do fixed string optimisation.
5624                 */
5625
5626                 SSize_t deltanext, minnext, fake = 0;
5627                 regnode *nscan;
5628                 regnode_ssc intrnl;
5629                 int f = 0;
5630
5631                 StructCopy(&zero_scan_data, &data_fake, scan_data_t);
5632                 if (data) {
5633                     data_fake.whilem_c = data->whilem_c;
5634                     data_fake.last_closep = data->last_closep;
5635                 }
5636                 else
5637                     data_fake.last_closep = &fake;
5638                 data_fake.pos_delta = delta;
5639                 if ( flags & SCF_DO_STCLASS && !scan->flags
5640                      && OP(scan) == IFMATCH ) { /* Lookahead */
5641                     ssc_init(pRExC_state, &intrnl);
5642                     data_fake.start_class = &intrnl;
5643                     f |= SCF_DO_STCLASS_AND;
5644                 }
5645                 if (flags & SCF_WHILEM_VISITED_POS)
5646                     f |= SCF_WHILEM_VISITED_POS;
5647                 next = regnext(scan);
5648                 nscan = NEXTOPER(NEXTOPER(scan));
5649
5650                 /* recurse study_chunk() for lookahead body */
5651                 minnext = study_chunk(pRExC_state, &nscan, minlenp, &deltanext,
5652                                       last, &data_fake, stopparen,
5653                                       recursed_depth, NULL, f, depth+1);
5654                 if (scan->flags) {
5655                     if (deltanext) {
5656                         FAIL("Variable length lookbehind not implemented");
5657                     }
5658                     else if (minnext > (I32)U8_MAX) {
5659                         FAIL2("Lookbehind longer than %" UVuf " not implemented",
5660                               (UV)U8_MAX);
5661                     }
5662                     scan->flags = (U8)minnext;
5663                 }
5664                 if (data) {
5665                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
5666                         pars++;
5667                     if (data_fake.flags & SF_HAS_EVAL)
5668                         data->flags |= SF_HAS_EVAL;
5669                     data->whilem_c = data_fake.whilem_c;
5670                 }
5671                 if (f & SCF_DO_STCLASS_AND) {
5672                     if (flags & SCF_DO_STCLASS_OR) {
5673                         /* OR before, AND after: ideally we would recurse with
5674                          * data_fake to get the AND applied by study of the
5675                          * remainder of the pattern, and then derecurse;
5676                          * *** HACK *** for now just treat as "no information".
5677                          * See [perl #56690].
5678                          */
5679                         ssc_init(pRExC_state, data->start_class);
5680                     }  else {
5681                         /* AND before and after: combine and continue.  These
5682                          * assertions are zero-length, so can match an EMPTY
5683                          * string */
5684                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &intrnl);
5685                         ANYOF_FLAGS(data->start_class)
5686                                                    |= SSC_MATCHES_EMPTY_STRING;
5687                     }
5688                 }
5689             }
5690 #if PERL_ENABLE_POSITIVE_ASSERTION_STUDY
5691             else {
5692                 /* Positive Lookahead/lookbehind
5693                    In this case we can do fixed string optimisation,
5694                    but we must be careful about it. Note in the case of
5695                    lookbehind the positions will be offset by the minimum
5696                    length of the pattern, something we won't know about
5697                    until after the recurse.
5698                 */
5699                 SSize_t deltanext, fake = 0;
5700                 regnode *nscan;
5701                 regnode_ssc intrnl;
5702                 int f = 0;
5703                 /* We use SAVEFREEPV so that when the full compile
5704                     is finished perl will clean up the allocated
5705                     minlens when it's all done. This way we don't
5706                     have to worry about freeing them when we know
5707                     they wont be used, which would be a pain.
5708                  */
5709                 SSize_t *minnextp;
5710                 Newx( minnextp, 1, SSize_t );
5711                 SAVEFREEPV(minnextp);
5712
5713                 if (data) {
5714                     StructCopy(data, &data_fake, scan_data_t);
5715                     if ((flags & SCF_DO_SUBSTR) && data->last_found) {
5716                         f |= SCF_DO_SUBSTR;
5717                         if (scan->flags)
5718                             scan_commit(pRExC_state, &data_fake, minlenp, is_inf);
5719                         data_fake.last_found=newSVsv(data->last_found);
5720                     }
5721                 }
5722                 else
5723                     data_fake.last_closep = &fake;
5724                 data_fake.flags = 0;
5725                 data_fake.substrs[0].flags = 0;
5726                 data_fake.substrs[1].flags = 0;
5727                 data_fake.pos_delta = delta;
5728                 if (is_inf)
5729                     data_fake.flags |= SF_IS_INF;
5730                 if ( flags & SCF_DO_STCLASS && !scan->flags
5731                      && OP(scan) == IFMATCH ) { /* Lookahead */
5732                     ssc_init(pRExC_state, &intrnl);
5733                     data_fake.start_class = &intrnl;
5734                     f |= SCF_DO_STCLASS_AND;
5735                 }
5736                 if (flags & SCF_WHILEM_VISITED_POS)
5737                     f |= SCF_WHILEM_VISITED_POS;
5738                 next = regnext(scan);
5739                 nscan = NEXTOPER(NEXTOPER(scan));
5740
5741                 /* positive lookahead study_chunk() recursion */
5742                 *minnextp = study_chunk(pRExC_state, &nscan, minnextp,
5743                                         &deltanext, last, &data_fake,
5744                                         stopparen, recursed_depth, NULL,
5745                                         f,depth+1);
5746                 if (scan->flags) {
5747                     if (deltanext) {
5748                         FAIL("Variable length lookbehind not implemented");
5749                     }
5750                     else if (*minnextp > (I32)U8_MAX) {
5751                         FAIL2("Lookbehind longer than %" UVuf " not implemented",
5752                               (UV)U8_MAX);
5753                     }
5754                     scan->flags = (U8)*minnextp;
5755                 }
5756
5757                 *minnextp += min;
5758
5759                 if (f & SCF_DO_STCLASS_AND) {
5760                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &intrnl);
5761                     ANYOF_FLAGS(data->start_class) |= SSC_MATCHES_EMPTY_STRING;
5762                 }
5763                 if (data) {
5764                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
5765                         pars++;
5766                     if (data_fake.flags & SF_HAS_EVAL)
5767                         data->flags |= SF_HAS_EVAL;
5768                     data->whilem_c = data_fake.whilem_c;
5769                     if ((flags & SCF_DO_SUBSTR) && data_fake.last_found) {
5770                         int i;
5771                         if (RExC_rx->minlen<*minnextp)
5772                             RExC_rx->minlen=*minnextp;
5773                         scan_commit(pRExC_state, &data_fake, minnextp, is_inf);
5774                         SvREFCNT_dec_NN(data_fake.last_found);
5775
5776                         for (i = 0; i < 2; i++) {
5777                             if (data_fake.substrs[i].minlenp != minlenp) {
5778                                 data->substrs[i].min_offset =
5779                                             data_fake.substrs[i].min_offset;
5780                                 data->substrs[i].max_offset =
5781                                             data_fake.substrs[i].max_offset;
5782                                 data->substrs[i].minlenp =
5783                                             data_fake.substrs[i].minlenp;
5784                                 data->substrs[i].lookbehind += scan->flags;
5785                             }
5786                         }
5787                     }
5788                 }
5789             }
5790 #endif
5791         }
5792
5793         else if (OP(scan) == OPEN) {
5794             if (stopparen != (I32)ARG(scan))
5795                 pars++;
5796         }
5797         else if (OP(scan) == CLOSE) {
5798             if (stopparen == (I32)ARG(scan)) {
5799                 break;
5800             }
5801             if ((I32)ARG(scan) == is_par) {
5802                 next = regnext(scan);
5803
5804                 if ( next && (OP(next) != WHILEM) && next < last)
5805                     is_par = 0;         /* Disable optimization */
5806             }
5807             if (data)
5808                 *(data->last_closep) = ARG(scan);
5809         }
5810         else if (OP(scan) == EVAL) {
5811                 if (data)
5812                     data->flags |= SF_HAS_EVAL;
5813         }
5814         else if ( PL_regkind[OP(scan)] == ENDLIKE ) {
5815             if (flags & SCF_DO_SUBSTR) {
5816                 scan_commit(pRExC_state, data, minlenp, is_inf);
5817                 flags &= ~SCF_DO_SUBSTR;
5818             }
5819             if (data && OP(scan)==ACCEPT) {
5820                 data->flags |= SCF_SEEN_ACCEPT;
5821                 if (stopmin > min)
5822                     stopmin = min;
5823             }
5824         }
5825         else if (OP(scan) == LOGICAL && scan->flags == 2) /* Embedded follows */
5826         {
5827                 if (flags & SCF_DO_SUBSTR) {
5828                     scan_commit(pRExC_state, data, minlenp, is_inf);
5829                     data->cur_is_floating = 1; /* float */
5830                 }
5831                 is_inf = is_inf_internal = 1;
5832                 if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
5833                     ssc_anything(data->start_class);
5834                 flags &= ~SCF_DO_STCLASS;
5835         }
5836         else if (OP(scan) == GPOS) {
5837             if (!(RExC_rx->intflags & PREGf_GPOS_FLOAT) &&
5838                 !(delta || is_inf || (data && data->pos_delta)))
5839             {
5840                 if (!(RExC_rx->intflags & PREGf_ANCH) && (flags & SCF_DO_SUBSTR))
5841                     RExC_rx->intflags |= PREGf_ANCH_GPOS;
5842                 if (RExC_rx->gofs < (STRLEN)min)
5843                     RExC_rx->gofs = min;
5844             } else {
5845                 RExC_rx->intflags |= PREGf_GPOS_FLOAT;
5846                 RExC_rx->gofs = 0;
5847             }
5848         }
5849 #ifdef TRIE_STUDY_OPT
5850 #ifdef FULL_TRIE_STUDY
5851         else if (PL_regkind[OP(scan)] == TRIE) {
5852             /* NOTE - There is similar code to this block above for handling
5853                BRANCH nodes on the initial study.  If you change stuff here
5854                check there too. */
5855             regnode *trie_node= scan;
5856             regnode *tail= regnext(scan);
5857             reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
5858             SSize_t max1 = 0, min1 = SSize_t_MAX;
5859             regnode_ssc accum;
5860
5861             if (flags & SCF_DO_SUBSTR) { /* XXXX Add !SUSPEND? */
5862                 /* Cannot merge strings after this. */
5863                 scan_commit(pRExC_state, data, minlenp, is_inf);
5864             }
5865             if (flags & SCF_DO_STCLASS)
5866                 ssc_init_zero(pRExC_state, &accum);
5867
5868             if (!trie->jump) {
5869                 min1= trie->minlen;
5870                 max1= trie->maxlen;
5871             } else {
5872                 const regnode *nextbranch= NULL;
5873                 U32 word;
5874
5875                 for ( word=1 ; word <= trie->wordcount ; word++)
5876                 {
5877                     SSize_t deltanext=0, minnext=0, f = 0, fake;
5878                     regnode_ssc this_class;
5879
5880                     StructCopy(&zero_scan_data, &data_fake, scan_data_t);
5881                     if (data) {
5882                         data_fake.whilem_c = data->whilem_c;
5883                         data_fake.last_closep = data->last_closep;
5884                     }
5885                     else
5886                         data_fake.last_closep = &fake;
5887                     data_fake.pos_delta = delta;
5888                     if (flags & SCF_DO_STCLASS) {
5889                         ssc_init(pRExC_state, &this_class);
5890                         data_fake.start_class = &this_class;
5891                         f = SCF_DO_STCLASS_AND;
5892                     }
5893                     if (flags & SCF_WHILEM_VISITED_POS)
5894                         f |= SCF_WHILEM_VISITED_POS;
5895
5896                     if (trie->jump[word]) {
5897                         if (!nextbranch)
5898                             nextbranch = trie_node + trie->jump[0];
5899                         scan= trie_node + trie->jump[word];
5900                         /* We go from the jump point to the branch that follows
5901                            it. Note this means we need the vestigal unused
5902                            branches even though they arent otherwise used. */
5903                         /* optimise study_chunk() for TRIE */
5904                         minnext = study_chunk(pRExC_state, &scan, minlenp,
5905                             &deltanext, (regnode *)nextbranch, &data_fake,
5906                             stopparen, recursed_depth, NULL, f,depth+1);
5907                     }
5908                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
5909                         nextbranch= regnext((regnode*)nextbranch);
5910
5911                     if (min1 > (SSize_t)(minnext + trie->minlen))
5912                         min1 = minnext + trie->minlen;
5913                     if (deltanext == SSize_t_MAX) {
5914                         is_inf = is_inf_internal = 1;
5915                         max1 = SSize_t_MAX;
5916                     } else if (max1 < (SSize_t)(minnext + deltanext + trie->maxlen))
5917                         max1 = minnext + deltanext + trie->maxlen;
5918
5919                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
5920                         pars++;
5921                     if (data_fake.flags & SCF_SEEN_ACCEPT) {
5922                         if ( stopmin > min + min1)
5923                             stopmin = min + min1;
5924                         flags &= ~SCF_DO_SUBSTR;
5925                         if (data)
5926                             data->flags |= SCF_SEEN_ACCEPT;
5927                     }
5928                     if (data) {
5929                         if (data_fake.flags & SF_HAS_EVAL)
5930                             data->flags |= SF_HAS_EVAL;
5931                         data->whilem_c = data_fake.whilem_c;
5932                     }
5933                     if (flags & SCF_DO_STCLASS)
5934                         ssc_or(pRExC_state, &accum, (regnode_charclass *) &this_class);
5935                 }
5936             }
5937             if (flags & SCF_DO_SUBSTR) {
5938                 data->pos_min += min1;
5939                 data->pos_delta += max1 - min1;
5940                 if (max1 != min1 || is_inf)
5941                     data->cur_is_floating = 1; /* float */
5942             }
5943             min += min1;
5944             if (delta != SSize_t_MAX) {
5945                 if (SSize_t_MAX - (max1 - min1) >= delta)
5946                     delta += max1 - min1;
5947                 else
5948                     delta = SSize_t_MAX;
5949             }
5950             if (flags & SCF_DO_STCLASS_OR) {
5951                 ssc_or(pRExC_state, data->start_class, (regnode_charclass *) &accum);
5952                 if (min1) {
5953                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5954                     flags &= ~SCF_DO_STCLASS;
5955                 }
5956             }
5957             else if (flags & SCF_DO_STCLASS_AND) {
5958                 if (min1) {
5959                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &accum);
5960                     flags &= ~SCF_DO_STCLASS;
5961                 }
5962                 else {
5963                     /* Switch to OR mode: cache the old value of
5964                      * data->start_class */
5965                     INIT_AND_WITHP;
5966                     StructCopy(data->start_class, and_withp, regnode_ssc);
5967                     flags &= ~SCF_DO_STCLASS_AND;
5968                     StructCopy(&accum, data->start_class, regnode_ssc);
5969                     flags |= SCF_DO_STCLASS_OR;
5970                 }
5971             }
5972             scan= tail;
5973             continue;
5974         }
5975 #else
5976         else if (PL_regkind[OP(scan)] == TRIE) {
5977             reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
5978             U8*bang=NULL;
5979
5980             min += trie->minlen;
5981             delta += (trie->maxlen - trie->minlen);
5982             flags &= ~SCF_DO_STCLASS; /* xxx */
5983             if (flags & SCF_DO_SUBSTR) {
5984                 /* Cannot expect anything... */
5985                 scan_commit(pRExC_state, data, minlenp, is_inf);
5986                 data->pos_min += trie->minlen;
5987                 data->pos_delta += (trie->maxlen - trie->minlen);
5988                 if (trie->maxlen != trie->minlen)
5989                     data->cur_is_floating = 1; /* float */
5990             }
5991             if (trie->jump) /* no more substrings -- for now /grr*/
5992                flags &= ~SCF_DO_SUBSTR;
5993         }
5994 #endif /* old or new */
5995 #endif /* TRIE_STUDY_OPT */
5996
5997         /* Else: zero-length, ignore. */
5998         scan = regnext(scan);
5999     }
6000
6001   finish:
6002     if (frame) {
6003         /* we need to unwind recursion. */
6004         depth = depth - 1;
6005
6006         DEBUG_STUDYDATA("frame-end", data, depth, is_inf);
6007         DEBUG_PEEP("fend", scan, depth, flags);
6008
6009         /* restore previous context */
6010         last = frame->last_regnode;
6011         scan = frame->next_regnode;
6012         stopparen = frame->stopparen;
6013         recursed_depth = frame->prev_recursed_depth;
6014
6015         RExC_frame_last = frame->prev_frame;
6016         frame = frame->this_prev_frame;
6017         goto fake_study_recurse;
6018     }
6019
6020     assert(!frame);
6021     DEBUG_STUDYDATA("pre-fin", data, depth, is_inf);
6022
6023     *scanp = scan;
6024     *deltap = is_inf_internal ? SSize_t_MAX : delta;
6025
6026     if (flags & SCF_DO_SUBSTR && is_inf)
6027         data->pos_delta = SSize_t_MAX - data->pos_min;
6028     if (is_par > (I32)U8_MAX)
6029         is_par = 0;
6030     if (is_par && pars==1 && data) {
6031         data->flags |= SF_IN_PAR;
6032         data->flags &= ~SF_HAS_PAR;
6033     }
6034     else if (pars && data) {
6035         data->flags |= SF_HAS_PAR;
6036         data->flags &= ~SF_IN_PAR;
6037     }
6038     if (flags & SCF_DO_STCLASS_OR)
6039         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
6040     if (flags & SCF_TRIE_RESTUDY)
6041         data->flags |=  SCF_TRIE_RESTUDY;
6042
6043     DEBUG_STUDYDATA("post-fin", data, depth, is_inf);
6044
6045     {
6046         SSize_t final_minlen= min < stopmin ? min : stopmin;
6047
6048         if (!(RExC_seen & REG_UNBOUNDED_QUANTIFIER_SEEN)) {
6049             if (final_minlen > SSize_t_MAX - delta)
6050                 RExC_maxlen = SSize_t_MAX;
6051             else if (RExC_maxlen < final_minlen + delta)
6052                 RExC_maxlen = final_minlen + delta;
6053         }
6054         return final_minlen;
6055     }
6056     NOT_REACHED; /* NOTREACHED */
6057 }
6058
6059 STATIC U32
6060 S_add_data(RExC_state_t* const pRExC_state, const char* const s, const U32 n)
6061 {
6062     U32 count = RExC_rxi->data ? RExC_rxi->data->count : 0;
6063
6064     PERL_ARGS_ASSERT_ADD_DATA;
6065
6066     Renewc(RExC_rxi->data,
6067            sizeof(*RExC_rxi->data) + sizeof(void*) * (count + n - 1),
6068            char, struct reg_data);
6069     if(count)
6070         Renew(RExC_rxi->data->what, count + n, U8);
6071     else
6072         Newx(RExC_rxi->data->what, n, U8);
6073     RExC_rxi->data->count = count + n;
6074     Copy(s, RExC_rxi->data->what + count, n, U8);
6075     return count;
6076 }
6077
6078 /*XXX: todo make this not included in a non debugging perl, but appears to be
6079  * used anyway there, in 'use re' */
6080 #ifndef PERL_IN_XSUB_RE
6081 void
6082 Perl_reginitcolors(pTHX)
6083 {
6084     const char * const s = PerlEnv_getenv("PERL_RE_COLORS");
6085     if (s) {
6086         char *t = savepv(s);
6087         int i = 0;
6088         PL_colors[0] = t;
6089         while (++i < 6) {
6090             t = strchr(t, '\t');
6091             if (t) {
6092                 *t = '\0';
6093                 PL_colors[i] = ++t;
6094             }
6095             else
6096                 PL_colors[i] = t = (char *)"";
6097         }
6098     } else {
6099         int i = 0;
6100         while (i < 6)
6101             PL_colors[i++] = (char *)"";
6102     }
6103     PL_colorset = 1;
6104 }
6105 #endif
6106
6107
6108 #ifdef TRIE_STUDY_OPT
6109 #define CHECK_RESTUDY_GOTO_butfirst(dOsomething)            \
6110     STMT_START {                                            \
6111         if (                                                \
6112               (data.flags & SCF_TRIE_RESTUDY)               \
6113               && ! restudied++                              \
6114         ) {                                                 \
6115             dOsomething;                                    \
6116             goto reStudy;                                   \
6117         }                                                   \
6118     } STMT_END
6119 #else
6120 #define CHECK_RESTUDY_GOTO_butfirst
6121 #endif
6122
6123 /*
6124  * pregcomp - compile a regular expression into internal code
6125  *
6126  * Decides which engine's compiler to call based on the hint currently in
6127  * scope
6128  */
6129
6130 #ifndef PERL_IN_XSUB_RE
6131
6132 /* return the currently in-scope regex engine (or the default if none)  */
6133
6134 regexp_engine const *
6135 Perl_current_re_engine(pTHX)
6136 {
6137     if (IN_PERL_COMPILETIME) {
6138         HV * const table = GvHV(PL_hintgv);
6139         SV **ptr;
6140
6141         if (!table || !(PL_hints & HINT_LOCALIZE_HH))
6142             return &PL_core_reg_engine;
6143         ptr = hv_fetchs(table, "regcomp", FALSE);
6144         if ( !(ptr && SvIOK(*ptr) && SvIV(*ptr)))
6145             return &PL_core_reg_engine;
6146         return INT2PTR(regexp_engine*,SvIV(*ptr));
6147     }
6148     else {
6149         SV *ptr;
6150         if (!PL_curcop->cop_hints_hash)
6151             return &PL_core_reg_engine;
6152         ptr = cop_hints_fetch_pvs(PL_curcop, "regcomp", 0);
6153         if ( !(ptr && SvIOK(ptr) && SvIV(ptr)))
6154             return &PL_core_reg_engine;
6155         return INT2PTR(regexp_engine*,SvIV(ptr));
6156     }
6157 }
6158
6159
6160 REGEXP *
6161 Perl_pregcomp(pTHX_ SV * const pattern, const U32 flags)
6162 {
6163     regexp_engine const *eng = current_re_engine();
6164     GET_RE_DEBUG_FLAGS_DECL;
6165
6166     PERL_ARGS_ASSERT_PREGCOMP;
6167
6168     /* Dispatch a request to compile a regexp to correct regexp engine. */
6169     DEBUG_COMPILE_r({
6170         Perl_re_printf( aTHX_  "Using engine %" UVxf "\n",
6171                         PTR2UV(eng));
6172     });
6173     return CALLREGCOMP_ENG(eng, pattern, flags);
6174 }
6175 #endif
6176
6177 /* public(ish) entry point for the perl core's own regex compiling code.
6178  * It's actually a wrapper for Perl_re_op_compile that only takes an SV
6179  * pattern rather than a list of OPs, and uses the internal engine rather
6180  * than the current one */
6181
6182 REGEXP *
6183 Perl_re_compile(pTHX_ SV * const pattern, U32 rx_flags)
6184 {
6185     SV *pat = pattern; /* defeat constness! */
6186     PERL_ARGS_ASSERT_RE_COMPILE;
6187     return Perl_re_op_compile(aTHX_ &pat, 1, NULL,
6188 #ifdef PERL_IN_XSUB_RE
6189                                 &my_reg_engine,
6190 #else
6191                                 &PL_core_reg_engine,
6192 #endif
6193                                 NULL, NULL, rx_flags, 0);
6194 }
6195
6196
6197 static void
6198 S_free_codeblocks(pTHX_ struct reg_code_blocks *cbs)
6199 {
6200     int n;
6201
6202     if (--cbs->refcnt > 0)
6203         return;
6204     for (n = 0; n < cbs->count; n++) {
6205         REGEXP *rx = cbs->cb[n].src_regex;
6206         cbs->cb[n].src_regex = NULL;
6207         SvREFCNT_dec(rx);
6208     }
6209     Safefree(cbs->cb);
6210     Safefree(cbs);
6211 }
6212
6213
6214 static struct reg_code_blocks *
6215 S_alloc_code_blocks(pTHX_  int ncode)
6216 {
6217      struct reg_code_blocks *cbs;
6218     Newx(cbs, 1, struct reg_code_blocks);
6219     cbs->count = ncode;
6220     cbs->refcnt = 1;
6221     SAVEDESTRUCTOR_X(S_free_codeblocks, cbs);
6222     if (ncode)
6223         Newx(cbs->cb, ncode, struct reg_code_block);
6224     else
6225         cbs->cb = NULL;
6226     return cbs;
6227 }
6228
6229
6230 /* upgrade pattern pat_p of length plen_p to UTF8, and if there are code
6231  * blocks, recalculate the indices. Update pat_p and plen_p in-place to
6232  * point to the realloced string and length.
6233  *
6234  * This is essentially a copy of Perl_bytes_to_utf8() with the code index
6235  * stuff added */
6236
6237 static void
6238 S_pat_upgrade_to_utf8(pTHX_ RExC_state_t * const pRExC_state,
6239                     char **pat_p, STRLEN *plen_p, int num_code_blocks)
6240 {
6241     U8 *const src = (U8*)*pat_p;
6242     U8 *dst, *d;
6243     int n=0;
6244     STRLEN s = 0;
6245     bool do_end = 0;
6246     GET_RE_DEBUG_FLAGS_DECL;
6247
6248     DEBUG_PARSE_r(Perl_re_printf( aTHX_
6249         "UTF8 mismatch! Converting to utf8 for resizing and compile\n"));
6250
6251     Newx(dst, *plen_p * 2 + 1, U8);
6252     d = dst;
6253
6254     while (s < *plen_p) {
6255         append_utf8_from_native_byte(src[s], &d);
6256
6257         if (n < num_code_blocks) {
6258             assert(pRExC_state->code_blocks);
6259             if (!do_end && pRExC_state->code_blocks->cb[n].start == s) {
6260                 pRExC_state->code_blocks->cb[n].start = d - dst - 1;
6261                 assert(*(d - 1) == '(');
6262                 do_end = 1;
6263             }
6264             else if (do_end && pRExC_state->code_blocks->cb[n].end == s) {
6265                 pRExC_state->code_blocks->cb[n].end = d - dst - 1;
6266                 assert(*(d - 1) == ')');
6267                 do_end = 0;
6268                 n++;
6269             }
6270         }
6271         s++;
6272     }
6273     *d = '\0';
6274     *plen_p = d - dst;
6275     *pat_p = (char*) dst;
6276     SAVEFREEPV(*pat_p);
6277     RExC_orig_utf8 = RExC_utf8 = 1;
6278 }
6279
6280
6281
6282 /* S_concat_pat(): concatenate a list of args to the pattern string pat,
6283  * while recording any code block indices, and handling overloading,
6284  * nested qr// objects etc.  If pat is null, it will allocate a new
6285  * string, or just return the first arg, if there's only one.
6286  *
6287  * Returns the malloced/updated pat.
6288  * patternp and pat_count is the array of SVs to be concatted;
6289  * oplist is the optional list of ops that generated the SVs;
6290  * recompile_p is a pointer to a boolean that will be set if
6291  *   the regex will need to be recompiled.
6292  * delim, if non-null is an SV that will be inserted between each element
6293  */
6294
6295 static SV*
6296 S_concat_pat(pTHX_ RExC_state_t * const pRExC_state,
6297                 SV *pat, SV ** const patternp, int pat_count,
6298                 OP *oplist, bool *recompile_p, SV *delim)
6299 {
6300     SV **svp;
6301     int n = 0;
6302     bool use_delim = FALSE;
6303     bool alloced = FALSE;
6304
6305     /* if we know we have at least two args, create an empty string,
6306      * then concatenate args to that. For no args, return an empty string */
6307     if (!pat && pat_count != 1) {
6308         pat = newSVpvs("");
6309         SAVEFREESV(pat);
6310         alloced = TRUE;
6311     }
6312
6313     for (svp = patternp; svp < patternp + pat_count; svp++) {
6314         SV *sv;
6315         SV *rx  = NULL;
6316         STRLEN orig_patlen = 0;
6317         bool code = 0;
6318         SV *msv = use_delim ? delim : *svp;
6319         if (!msv) msv = &PL_sv_undef;
6320
6321         /* if we've got a delimiter, we go round the loop twice for each
6322          * svp slot (except the last), using the delimiter the second
6323          * time round */
6324         if (use_delim) {
6325             svp--;
6326             use_delim = FALSE;
6327         }
6328         else if (delim)
6329             use_delim = TRUE;
6330
6331         if (SvTYPE(msv) == SVt_PVAV) {
6332             /* we've encountered an interpolated array within
6333              * the pattern, e.g. /...@a..../. Expand the list of elements,
6334              * then recursively append elements.
6335              * The code in this block is based on S_pushav() */
6336
6337             AV *const av = (AV*)msv;
6338             const SSize_t maxarg = AvFILL(av) + 1;
6339             SV **array;
6340
6341             if (oplist) {
6342                 assert(oplist->op_type == OP_PADAV
6343                     || oplist->op_type == OP_RV2AV);
6344                 oplist = OpSIBLING(oplist);
6345             }
6346
6347             if (SvRMAGICAL(av)) {
6348                 SSize_t i;
6349
6350                 Newx(array, maxarg, SV*);
6351                 SAVEFREEPV(array);
6352                 for (i=0; i < maxarg; i++) {
6353                     SV ** const svp = av_fetch(av, i, FALSE);
6354                     array[i] = svp ? *svp : &PL_sv_undef;
6355                 }
6356             }
6357             else
6358                 array = AvARRAY(av);
6359
6360             pat = S_concat_pat(aTHX_ pRExC_state, pat,
6361                                 array, maxarg, NULL, recompile_p,
6362                                 /* $" */
6363                                 GvSV((gv_fetchpvs("\"", GV_ADDMULTI, SVt_PV))));
6364
6365             continue;
6366         }
6367
6368
6369         /* we make the assumption here that each op in the list of
6370          * op_siblings maps to one SV pushed onto the stack,
6371          * except for code blocks, with have both an OP_NULL and
6372          * and OP_CONST.
6373          * This allows us to match up the list of SVs against the
6374          * list of OPs to find the next code block.
6375          *
6376          * Note that       PUSHMARK PADSV PADSV ..
6377          * is optimised to
6378          *                 PADRANGE PADSV  PADSV  ..
6379          * so the alignment still works. */
6380
6381         if (oplist) {
6382             if (oplist->op_type == OP_NULL
6383                 && (oplist->op_flags & OPf_SPECIAL))
6384             {
6385                 assert(n < pRExC_state->code_blocks->count);
6386                 pRExC_state->code_blocks->cb[n].start = pat ? SvCUR(pat) : 0;
6387                 pRExC_state->code_blocks->cb[n].block = oplist;
6388                 pRExC_state->code_blocks->cb[n].src_regex = NULL;
6389                 n++;
6390                 code = 1;
6391                 oplist = OpSIBLING(oplist); /* skip CONST */
6392                 assert(oplist);
6393             }
6394             oplist = OpSIBLING(oplist);;
6395         }
6396
6397         /* apply magic and QR overloading to arg */
6398
6399         SvGETMAGIC(msv);
6400         if (SvROK(msv) && SvAMAGIC(msv)) {
6401             SV *sv = AMG_CALLunary(msv, regexp_amg);
6402             if (sv) {
6403                 if (SvROK(sv))
6404                     sv = SvRV(sv);
6405                 if (SvTYPE(sv) != SVt_REGEXP)
6406                     Perl_croak(aTHX_ "Overloaded qr did not return a REGEXP");
6407                 msv = sv;
6408             }
6409         }
6410
6411         /* try concatenation overload ... */
6412         if (pat && (SvAMAGIC(pat) || SvAMAGIC(msv)) &&
6413                 (sv = amagic_call(pat, msv, concat_amg, AMGf_assign)))
6414         {
6415             sv_setsv(pat, sv);
6416             /* overloading involved: all bets are off over literal
6417              * code. Pretend we haven't seen it */
6418             if (n)
6419                 pRExC_state->code_blocks->count -= n;
6420             n = 0;
6421         }
6422         else  {
6423             /* ... or failing that, try "" overload */
6424             while (SvAMAGIC(msv)
6425                     && (sv = AMG_CALLunary(msv, string_amg))
6426                     && sv != msv
6427                     &&  !(   SvROK(msv)
6428                           && SvROK(sv)
6429                           && SvRV(msv) == SvRV(sv))
6430             ) {
6431                 msv = sv;
6432                 SvGETMAGIC(msv);
6433             }
6434             if (SvROK(msv) && SvTYPE(SvRV(msv)) == SVt_REGEXP)
6435                 msv = SvRV(msv);
6436
6437             if (pat) {
6438                 /* this is a partially unrolled
6439                  *     sv_catsv_nomg(pat, msv);
6440                  * that allows us to adjust code block indices if
6441                  * needed */
6442                 STRLEN dlen;
6443                 char *dst = SvPV_force_nomg(pat, dlen);
6444                 orig_patlen = dlen;
6445                 if (SvUTF8(msv) && !SvUTF8(pat)) {
6446                     S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &dst, &dlen, n);
6447                     sv_setpvn(pat, dst, dlen);
6448                     SvUTF8_on(pat);
6449                 }
6450                 sv_catsv_nomg(pat, msv);
6451                 rx = msv;
6452             }
6453             else {
6454                 /* We have only one SV to process, but we need to verify
6455                  * it is properly null terminated or we will fail asserts
6456                  * later. In theory we probably shouldn't get such SV's,
6457                  * but if we do we should handle it gracefully. */
6458                 if ( SvTYPE(msv) != SVt_PV || (SvLEN(msv) > SvCUR(msv) && *(SvEND(msv)) == 0) ) {
6459                     /* not a string, or a string with a trailing null */
6460                     pat = msv;
6461                 } else {
6462                     /* a string with no trailing null, we need to copy it
6463                      * so it we have a trailing null */
6464                     pat = newSVsv(msv);
6465                 }
6466             }
6467
6468             if (code)
6469                 pRExC_state->code_blocks->cb[n-1].end = SvCUR(pat)-1;
6470         }
6471
6472         /* extract any code blocks within any embedded qr//'s */
6473         if (rx && SvTYPE(rx) == SVt_REGEXP
6474             && RX_ENGINE((REGEXP*)rx)->op_comp)
6475         {
6476
6477             RXi_GET_DECL(ReANY((REGEXP *)rx), ri);
6478             if (ri->code_blocks && ri->code_blocks->count) {
6479                 int i;
6480                 /* the presence of an embedded qr// with code means
6481                  * we should always recompile: the text of the
6482                  * qr// may not have changed, but it may be a
6483                  * different closure than last time */
6484                 *recompile_p = 1;
6485                 if (pRExC_state->code_blocks) {
6486                     int new_count = pRExC_state->code_blocks->count
6487                             + ri->code_blocks->count;
6488                     Renew(pRExC_state->code_blocks->cb,
6489                             new_count, struct reg_code_block);
6490                     pRExC_state->code_blocks->count = new_count;
6491                 }
6492                 else
6493                     pRExC_state->code_blocks = S_alloc_code_blocks(aTHX_
6494                                                     ri->code_blocks->count);
6495
6496                 for (i=0; i < ri->code_blocks->count; i++) {
6497                     struct reg_code_block *src, *dst;
6498                     STRLEN offset =  orig_patlen
6499                         + ReANY((REGEXP *)rx)->pre_prefix;
6500                     assert(n < pRExC_state->code_blocks->count);
6501                     src = &ri->code_blocks->cb[i];
6502                     dst = &pRExC_state->code_blocks->cb[n];
6503                     dst->start      = src->start + offset;
6504                     dst->end        = src->end   + offset;
6505                     dst->block      = src->block;
6506                     dst->src_regex  = (REGEXP*) SvREFCNT_inc( (SV*)
6507                                             src->src_regex
6508                                                 ? src->src_regex
6509                                                 : (REGEXP*)rx);
6510                     n++;
6511                 }
6512             }
6513         }
6514     }
6515     /* avoid calling magic multiple times on a single element e.g. =~ $qr */
6516     if (alloced)
6517         SvSETMAGIC(pat);
6518
6519     return pat;
6520 }
6521
6522
6523
6524 /* see if there are any run-time code blocks in the pattern.
6525  * False positives are allowed */
6526
6527 static bool
6528 S_has_runtime_code(pTHX_ RExC_state_t * const pRExC_state,
6529                     char *pat, STRLEN plen)
6530 {
6531     int n = 0;
6532     STRLEN s;
6533     
6534     PERL_UNUSED_CONTEXT;
6535
6536     for (s = 0; s < plen; s++) {
6537         if (   pRExC_state->code_blocks
6538             && n < pRExC_state->code_blocks->count
6539             && s == pRExC_state->code_blocks->cb[n].start)
6540         {
6541             s = pRExC_state->code_blocks->cb[n].end;
6542             n++;
6543             continue;
6544         }
6545         /* TODO ideally should handle [..], (#..), /#.../x to reduce false
6546          * positives here */
6547         if (pat[s] == '(' && s+2 <= plen && pat[s+1] == '?' &&
6548             (pat[s+2] == '{'
6549                 || (s + 2 <= plen && pat[s+2] == '?' && pat[s+3] == '{'))
6550         )
6551             return 1;
6552     }
6553     return 0;
6554 }
6555
6556 /* Handle run-time code blocks. We will already have compiled any direct
6557  * or indirect literal code blocks. Now, take the pattern 'pat' and make a
6558  * copy of it, but with any literal code blocks blanked out and
6559  * appropriate chars escaped; then feed it into
6560  *
6561  *    eval "qr'modified_pattern'"
6562  *
6563  * For example,
6564  *
6565  *       a\bc(?{"this was literal"})def'ghi\\jkl(?{"this is runtime"})mno
6566  *
6567  * becomes
6568  *
6569  *    qr'a\\bc_______________________def\'ghi\\\\jkl(?{"this is runtime"})mno'
6570  *
6571  * After eval_sv()-ing that, grab any new code blocks from the returned qr
6572  * and merge them with any code blocks of the original regexp.
6573  *
6574  * If the pat is non-UTF8, while the evalled qr is UTF8, don't merge;
6575  * instead, just save the qr and return FALSE; this tells our caller that
6576  * the original pattern needs upgrading to utf8.
6577  */
6578
6579 static bool
6580 S_compile_runtime_code(pTHX_ RExC_state_t * const pRExC_state,
6581     char *pat, STRLEN plen)
6582 {
6583     SV *qr;
6584
6585     GET_RE_DEBUG_FLAGS_DECL;
6586
6587     if (pRExC_state->runtime_code_qr) {
6588         /* this is the second time we've been called; this should
6589          * only happen if the main pattern got upgraded to utf8
6590          * during compilation; re-use the qr we compiled first time
6591          * round (which should be utf8 too)
6592          */
6593         qr = pRExC_state->runtime_code_qr;
6594         pRExC_state->runtime_code_qr = NULL;
6595         assert(RExC_utf8 && SvUTF8(qr));
6596     }
6597     else {
6598         int n = 0;
6599         STRLEN s;
6600         char *p, *newpat;
6601         int newlen = plen + 7; /* allow for "qr''xx\0" extra chars */
6602         SV *sv, *qr_ref;
6603         dSP;
6604
6605         /* determine how many extra chars we need for ' and \ escaping */
6606         for (s = 0; s < plen; s++) {
6607             if (pat[s] == '\'' || pat[s] == '\\')
6608                 newlen++;
6609         }
6610
6611         Newx(newpat, newlen, char);
6612         p = newpat;
6613         *p++ = 'q'; *p++ = 'r'; *p++ = '\'';
6614
6615         for (s = 0; s < plen; s++) {
6616             if (   pRExC_state->code_blocks
6617                 && n < pRExC_state->code_blocks->count
6618                 && s == pRExC_state->code_blocks->cb[n].start)
6619             {
6620                 /* blank out literal code block */
6621                 assert(pat[s] == '(');
6622                 while (s <= pRExC_state->code_blocks->cb[n].end) {
6623                     *p++ = '_';
6624                     s++;
6625                 }
6626                 s--;
6627                 n++;
6628                 continue;
6629             }
6630             if (pat[s] == '\'' || pat[s] == '\\')
6631                 *p++ = '\\';
6632             *p++ = pat[s];
6633         }
6634         *p++ = '\'';
6635         if (pRExC_state->pm_flags & RXf_PMf_EXTENDED) {
6636             *p++ = 'x';
6637             if (pRExC_state->pm_flags & RXf_PMf_EXTENDED_MORE) {
6638                 *p++ = 'x';
6639             }
6640         }
6641         *p++ = '\0';
6642         DEBUG_COMPILE_r({
6643             Perl_re_printf( aTHX_
6644                 "%sre-parsing pattern for runtime code:%s %s\n",
6645                 PL_colors[4],PL_colors[5],newpat);
6646         });
6647
6648         sv = newSVpvn_flags(newpat, p-newpat-1, RExC_utf8 ? SVf_UTF8 : 0);
6649         Safefree(newpat);
6650
6651         ENTER;
6652         SAVETMPS;
6653         save_re_context();
6654         PUSHSTACKi(PERLSI_REQUIRE);
6655         /* G_RE_REPARSING causes the toker to collapse \\ into \ when
6656          * parsing qr''; normally only q'' does this. It also alters
6657          * hints handling */
6658         eval_sv(sv, G_SCALAR|G_RE_REPARSING);
6659         SvREFCNT_dec_NN(sv);
6660         SPAGAIN;
6661         qr_ref = POPs;
6662         PUTBACK;
6663         {
6664             SV * const errsv = ERRSV;
6665             if (SvTRUE_NN(errsv))
6666                 /* use croak_sv ? */
6667                 Perl_croak_nocontext("%" SVf, SVfARG(errsv));
6668         }
6669         assert(SvROK(qr_ref));
6670         qr = SvRV(qr_ref);
6671         assert(SvTYPE(qr) == SVt_REGEXP && RX_ENGINE((REGEXP*)qr)->op_comp);
6672         /* the leaving below frees the tmp qr_ref.
6673          * Give qr a life of its own */
6674         SvREFCNT_inc(qr);
6675         POPSTACK;
6676         FREETMPS;
6677         LEAVE;
6678
6679     }
6680
6681     if (!RExC_utf8 && SvUTF8(qr)) {
6682         /* first time through; the pattern got upgraded; save the
6683          * qr for the next time through */
6684         assert(!pRExC_state->runtime_code_qr);
6685         pRExC_state->runtime_code_qr = qr;
6686         return 0;
6687     }
6688
6689
6690     /* extract any code blocks within the returned qr//  */
6691
6692
6693     /* merge the main (r1) and run-time (r2) code blocks into one */
6694     {
6695         RXi_GET_DECL(ReANY((REGEXP *)qr), r2);
6696         struct reg_code_block *new_block, *dst;
6697         RExC_state_t * const r1 = pRExC_state; /* convenient alias */
6698         int i1 = 0, i2 = 0;
6699         int r1c, r2c;
6700
6701         if (!r2->code_blocks || !r2->code_blocks->count) /* we guessed wrong */
6702         {
6703             SvREFCNT_dec_NN(qr);
6704             return 1;
6705         }
6706
6707         if (!r1->code_blocks)
6708             r1->code_blocks = S_alloc_code_blocks(aTHX_ 0);
6709
6710         r1c = r1->code_blocks->count;
6711         r2c = r2->code_blocks->count;
6712
6713         Newx(new_block, r1c + r2c, struct reg_code_block);
6714
6715         dst = new_block;
6716
6717         while (i1 < r1c || i2 < r2c) {
6718             struct reg_code_block *src;
6719             bool is_qr = 0;
6720
6721             if (i1 == r1c) {
6722                 src = &r2->code_blocks->cb[i2++];
6723                 is_qr = 1;
6724             }
6725             else if (i2 == r2c)
6726                 src = &r1->code_blocks->cb[i1++];
6727             else if (  r1->code_blocks->cb[i1].start
6728                      < r2->code_blocks->cb[i2].start)
6729             {
6730                 src = &r1->code_blocks->cb[i1++];
6731                 assert(src->end < r2->code_blocks->cb[i2].start);
6732             }
6733             else {
6734                 assert(  r1->code_blocks->cb[i1].start
6735                        > r2->code_blocks->cb[i2].start);
6736                 src = &r2->code_blocks->cb[i2++];
6737                 is_qr = 1;
6738                 assert(src->end < r1->code_blocks->cb[i1].start);
6739             }
6740
6741             assert(pat[src->start] == '(');
6742             assert(pat[src->end]   == ')');
6743             dst->start      = src->start;
6744             dst->end        = src->end;
6745             dst->block      = src->block;
6746             dst->src_regex  = is_qr ? (REGEXP*) SvREFCNT_inc( (SV*) qr)
6747                                     : src->src_regex;
6748             dst++;
6749         }
6750         r1->code_blocks->count += r2c;
6751         Safefree(r1->code_blocks->cb);
6752         r1->code_blocks->cb = new_block;
6753     }
6754
6755     SvREFCNT_dec_NN(qr);
6756     return 1;
6757 }
6758
6759
6760 STATIC bool
6761 S_setup_longest(pTHX_ RExC_state_t *pRExC_state,
6762                       struct reg_substr_datum  *rsd,
6763                       struct scan_data_substrs *sub,
6764                       STRLEN longest_length)
6765 {
6766     /* This is the common code for setting up the floating and fixed length
6767      * string data extracted from Perl_re_op_compile() below.  Returns a boolean
6768      * as to whether succeeded or not */
6769
6770     I32 t;
6771     SSize_t ml;
6772     bool eol  = cBOOL(sub->flags & SF_BEFORE_EOL);
6773     bool meol = cBOOL(sub->flags & SF_BEFORE_MEOL);
6774
6775     if (! (longest_length
6776            || (eol /* Can't have SEOL and MULTI */
6777                && (! meol || (RExC_flags & RXf_PMf_MULTILINE)))
6778           )
6779             /* See comments for join_exact for why REG_UNFOLDED_MULTI_SEEN */
6780         || (RExC_seen & REG_UNFOLDED_MULTI_SEEN))
6781     {
6782         return FALSE;
6783     }
6784
6785     /* copy the information about the longest from the reg_scan_data
6786         over to the program. */
6787     if (SvUTF8(sub->str)) {
6788         rsd->substr      = NULL;
6789         rsd->utf8_substr = sub->str;
6790     } else {
6791         rsd->substr      = sub->str;
6792         rsd->utf8_substr = NULL;
6793     }
6794     /* end_shift is how many chars that must be matched that
6795         follow this item. We calculate it ahead of time as once the
6796         lookbehind offset is added in we lose the ability to correctly
6797         calculate it.*/
6798     ml = sub->minlenp ? *(sub->minlenp) : (SSize_t)longest_length;
6799     rsd->end_shift = ml - sub->min_offset
6800         - longest_length
6801             /* XXX SvTAIL is always false here - did you mean FBMcf_TAIL
6802              * intead? - DAPM
6803             + (SvTAIL(sub->str) != 0)
6804             */
6805         + sub->lookbehind;
6806
6807     t = (eol/* Can't have SEOL and MULTI */
6808          && (! meol || (RExC_flags & RXf_PMf_MULTILINE)));
6809     fbm_compile(sub->str, t ? FBMcf_TAIL : 0);
6810
6811     return TRUE;
6812 }
6813
6814 /*
6815  * Perl_re_op_compile - the perl internal RE engine's function to compile a
6816  * regular expression into internal code.
6817  * The pattern may be passed either as:
6818  *    a list of SVs (patternp plus pat_count)
6819  *    a list of OPs (expr)
6820  * If both are passed, the SV list is used, but the OP list indicates
6821  * which SVs are actually pre-compiled code blocks
6822  *
6823  * The SVs in the list have magic and qr overloading applied to them (and
6824  * the list may be modified in-place with replacement SVs in the latter
6825  * case).
6826  *
6827  * If the pattern hasn't changed from old_re, then old_re will be
6828  * returned.
6829  *
6830  * eng is the current engine. If that engine has an op_comp method, then
6831  * handle directly (i.e. we assume that op_comp was us); otherwise, just
6832  * do the initial concatenation of arguments and pass on to the external
6833  * engine.
6834  *
6835  * If is_bare_re is not null, set it to a boolean indicating whether the
6836  * arg list reduced (after overloading) to a single bare regex which has
6837  * been returned (i.e. /$qr/).
6838  *
6839  * orig_rx_flags contains RXf_* flags. See perlreapi.pod for more details.
6840  *
6841  * pm_flags contains the PMf_* flags, typically based on those from the
6842  * pm_flags field of the related PMOP. Currently we're only interested in
6843  * PMf_HAS_CV, PMf_IS_QR, PMf_USE_RE_EVAL.
6844  *
6845  * We can't allocate space until we know how big the compiled form will be,
6846  * but we can't compile it (and thus know how big it is) until we've got a
6847  * place to put the code.  So we cheat:  we compile it twice, once with code
6848  * generation turned off and size counting turned on, and once "for real".
6849  * This also means that we don't allocate space until we are sure that the
6850  * thing really will compile successfully, and we never have to move the
6851  * code and thus invalidate pointers into it.  (Note that it has to be in
6852  * one piece because free() must be able to free it all.) [NB: not true in perl]
6853  *
6854  * Beware that the optimization-preparation code in here knows about some
6855  * of the structure of the compiled regexp.  [I'll say.]
6856  */
6857
6858 REGEXP *
6859 Perl_re_op_compile(pTHX_ SV ** const patternp, int pat_count,
6860                     OP *expr, const regexp_engine* eng, REGEXP *old_re,
6861                      bool *is_bare_re, U32 orig_rx_flags, U32 pm_flags)
6862 {
6863     REGEXP *rx;
6864     struct regexp *r;
6865     regexp_internal *ri;
6866     STRLEN plen;
6867     char *exp;
6868     regnode *scan;
6869     I32 flags;
6870     SSize_t minlen = 0;
6871     U32 rx_flags;
6872     SV *pat;
6873     SV** new_patternp = patternp;
6874
6875     /* these are all flags - maybe they should be turned
6876      * into a single int with different bit masks */
6877     I32 sawlookahead = 0;
6878     I32 sawplus = 0;
6879     I32 sawopen = 0;
6880     I32 sawminmod = 0;
6881
6882     regex_charset initial_charset = get_regex_charset(orig_rx_flags);
6883     bool recompile = 0;
6884     bool runtime_code = 0;
6885     scan_data_t data;
6886     RExC_state_t RExC_state;
6887     RExC_state_t * const pRExC_state = &RExC_state;
6888 #ifdef TRIE_STUDY_OPT
6889     int restudied = 0;
6890     RExC_state_t copyRExC_state;
6891 #endif
6892     GET_RE_DEBUG_FLAGS_DECL;
6893
6894     PERL_ARGS_ASSERT_RE_OP_COMPILE;
6895
6896     DEBUG_r(if (!PL_colorset) reginitcolors());
6897
6898     /* Initialize these here instead of as-needed, as is quick and avoids
6899      * having to test them each time otherwise */
6900     if (! PL_AboveLatin1) {
6901 #ifdef DEBUGGING
6902         char * dump_len_string;
6903 #endif
6904
6905         PL_AboveLatin1 = _new_invlist_C_array(AboveLatin1_invlist);
6906         PL_Latin1 = _new_invlist_C_array(Latin1_invlist);
6907         PL_UpperLatin1 = _new_invlist_C_array(UpperLatin1_invlist);
6908         PL_utf8_foldable = _new_invlist_C_array(_Perl_Any_Folds_invlist);
6909         PL_HasMultiCharFold =
6910                        _new_invlist_C_array(_Perl_Folds_To_Multi_Char_invlist);
6911
6912         /* This is calculated here, because the Perl program that generates the
6913          * static global ones doesn't currently have access to
6914          * NUM_ANYOF_CODE_POINTS */
6915         PL_InBitmap = _new_invlist(2);
6916         PL_InBitmap = _add_range_to_invlist(PL_InBitmap, 0,
6917                                                     NUM_ANYOF_CODE_POINTS - 1);
6918 #ifdef DEBUGGING
6919         dump_len_string = PerlEnv_getenv("PERL_DUMP_RE_MAX_LEN");
6920         if (   ! dump_len_string
6921             || ! grok_atoUV(dump_len_string, (UV *)&PL_dump_re_max_len, NULL))
6922         {
6923             PL_dump_re_max_len = 60;    /* A reasonable default */
6924         }
6925 #endif
6926     }
6927
6928     pRExC_state->warn_text = NULL;
6929     pRExC_state->code_blocks = NULL;
6930
6931     if (is_bare_re)
6932         *is_bare_re = FALSE;
6933
6934     if (expr && (expr->op_type == OP_LIST ||
6935                 (expr->op_type == OP_NULL && expr->op_targ == OP_LIST))) {
6936         /* allocate code_blocks if needed */
6937         OP *o;
6938         int ncode = 0;
6939
6940         for (o = cLISTOPx(expr)->op_first; o; o = OpSIBLING(o))
6941             if (o->op_type == OP_NULL && (o->op_flags & OPf_SPECIAL))
6942                 ncode++; /* count of DO blocks */
6943
6944         if (ncode)
6945             pRExC_state->code_blocks = S_alloc_code_blocks(aTHX_ ncode);
6946     }
6947
6948     if (!pat_count) {
6949         /* compile-time pattern with just OP_CONSTs and DO blocks */
6950
6951         int n;
6952         OP *o;
6953
6954         /* find how many CONSTs there are */
6955         assert(expr);
6956         n = 0;
6957         if (expr->op_type == OP_CONST)
6958             n = 1;
6959         else
6960             for (o = cLISTOPx(expr)->op_first; o; o = OpSIBLING(o)) {
6961                 if (o->op_type == OP_CONST)
6962                     n++;
6963             }
6964
6965         /* fake up an SV array */
6966
6967         assert(!new_patternp);
6968         Newx(new_patternp, n, SV*);
6969         SAVEFREEPV(new_patternp);
6970         pat_count = n;
6971
6972         n = 0;
6973         if (expr->op_type == OP_CONST)
6974             new_patternp[n] = cSVOPx_sv(expr);
6975         else
6976             for (o = cLISTOPx(expr)->op_first; o; o = OpSIBLING(o)) {
6977                 if (o->op_type == OP_CONST)
6978                     new_patternp[n++] = cSVOPo_sv;
6979             }
6980
6981     }
6982
6983     DEBUG_PARSE_r(Perl_re_printf( aTHX_
6984         "Assembling pattern from %d elements%s\n", pat_count,
6985             orig_rx_flags & RXf_SPLIT ? " for split" : ""));
6986
6987     /* set expr to the first arg op */
6988
6989     if (pRExC_state->code_blocks && pRExC_state->code_blocks->count
6990          && expr->op_type != OP_CONST)
6991     {
6992             expr = cLISTOPx(expr)->op_first;
6993             assert(   expr->op_type == OP_PUSHMARK
6994                    || (expr->op_type == OP_NULL && expr->op_targ == OP_PUSHMARK)
6995                    || expr->op_type == OP_PADRANGE);
6996             expr = OpSIBLING(expr);
6997     }
6998
6999     pat = S_concat_pat(aTHX_ pRExC_state, NULL, new_patternp, pat_count,
7000                         expr, &recompile, NULL);
7001
7002     /* handle bare (possibly after overloading) regex: foo =~ $re */
7003     {
7004         SV *re = pat;
7005         if (SvROK(re))
7006             re = SvRV(re);
7007         if (SvTYPE(re) == SVt_REGEXP) {
7008             if (is_bare_re)
7009                 *is_bare_re = TRUE;
7010             SvREFCNT_inc(re);
7011             DEBUG_PARSE_r(Perl_re_printf( aTHX_
7012                 "Precompiled pattern%s\n",
7013                     orig_rx_flags & RXf_SPLIT ? " for split" : ""));
7014
7015             return (REGEXP*)re;
7016         }
7017     }
7018
7019     exp = SvPV_nomg(pat, plen);
7020
7021     if (!eng->op_comp) {
7022         if ((SvUTF8(pat) && IN_BYTES)
7023                 || SvGMAGICAL(pat) || SvAMAGIC(pat))
7024         {
7025             /* make a temporary copy; either to convert to bytes,
7026              * or to avoid repeating get-magic / overloaded stringify */
7027             pat = newSVpvn_flags(exp, plen, SVs_TEMP |
7028                                         (IN_BYTES ? 0 : SvUTF8(pat)));
7029         }
7030         return CALLREGCOMP_ENG(eng, pat, orig_rx_flags);
7031     }
7032
7033     /* ignore the utf8ness if the pattern is 0 length */
7034     RExC_utf8 = RExC_orig_utf8 = (plen == 0 || IN_BYTES) ? 0 : SvUTF8(pat);
7035
7036     RExC_uni_semantics = 0;
7037     RExC_seen_unfolded_sharp_s = 0;
7038     RExC_contains_locale = 0;
7039     RExC_strict = cBOOL(pm_flags & RXf_PMf_STRICT);
7040     RExC_study_started = 0;
7041     pRExC_state->runtime_code_qr = NULL;
7042     RExC_frame_head= NULL;
7043     RExC_frame_last= NULL;
7044     RExC_frame_count= 0;
7045
7046     DEBUG_r({
7047         RExC_mysv1= sv_newmortal();
7048         RExC_mysv2= sv_newmortal();
7049     });
7050     DEBUG_COMPILE_r({
7051             SV *dsv= sv_newmortal();
7052             RE_PV_QUOTED_DECL(s, RExC_utf8, dsv, exp, plen, PL_dump_re_max_len);
7053             Perl_re_printf( aTHX_  "%sCompiling REx%s %s\n",
7054                           PL_colors[4],PL_colors[5],s);
7055         });
7056
7057   redo_first_pass:
7058     /* we jump here if we have to recompile, e.g., from upgrading the pattern
7059      * to utf8 */
7060
7061     if ((pm_flags & PMf_USE_RE_EVAL)
7062                 /* this second condition covers the non-regex literal case,
7063                  * i.e.  $foo =~ '(?{})'. */
7064                 || (IN_PERL_COMPILETIME && (PL_hints & HINT_RE_EVAL))
7065     )
7066         runtime_code = S_has_runtime_code(aTHX_ pRExC_state, exp, plen);
7067
7068     /* return old regex if pattern hasn't changed */
7069     /* XXX: note in the below we have to check the flags as well as the
7070      * pattern.
7071      *
7072      * Things get a touch tricky as we have to compare the utf8 flag
7073      * independently from the compile flags.  */
7074
7075     if (   old_re
7076         && !recompile
7077         && !!RX_UTF8(old_re) == !!RExC_utf8
7078         && ( RX_COMPFLAGS(old_re) == ( orig_rx_flags & RXf_PMf_FLAGCOPYMASK ) )
7079         && RX_PRECOMP(old_re)
7080         && RX_PRELEN(old_re) == plen
7081         && memEQ(RX_PRECOMP(old_re), exp, plen)
7082         && !runtime_code /* with runtime code, always recompile */ )
7083     {
7084         return old_re;
7085     }
7086
7087     rx_flags = orig_rx_flags;
7088
7089     if (   initial_charset == REGEX_DEPENDS_CHARSET
7090         && (RExC_utf8 ||RExC_uni_semantics))
7091     {
7092
7093         /* Set to use unicode semantics if the pattern is in utf8 and has the
7094          * 'depends' charset specified, as it means unicode when utf8  */
7095         set_regex_charset(&rx_flags, REGEX_UNICODE_CHARSET);
7096     }
7097
7098     RExC_precomp = exp;
7099     RExC_precomp_adj = 0;
7100     RExC_flags = rx_flags;
7101     RExC_pm_flags = pm_flags;
7102
7103     if (runtime_code) {
7104         assert(TAINTING_get || !TAINT_get);
7105         if (TAINT_get)
7106             Perl_croak(aTHX_ "Eval-group in insecure regular expression");
7107
7108         if (!S_compile_runtime_code(aTHX_ pRExC_state, exp, plen)) {
7109             /* whoops, we have a non-utf8 pattern, whilst run-time code
7110              * got compiled as utf8. Try again with a utf8 pattern */
7111             S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &exp, &plen,
7112                 pRExC_state->code_blocks ? pRExC_state->code_blocks->count : 0);
7113             goto redo_first_pass;
7114         }
7115     }
7116     assert(!pRExC_state->runtime_code_qr);
7117
7118     RExC_sawback = 0;
7119
7120     RExC_seen = 0;
7121     RExC_maxlen = 0;
7122     RExC_in_lookbehind = 0;
7123     RExC_seen_zerolen = *exp == '^' ? -1 : 0;
7124     RExC_extralen = 0;
7125 #ifdef EBCDIC
7126     RExC_recode_x_to_native = 0;
7127 #endif
7128     RExC_in_multi_char_class = 0;
7129
7130     /* First pass: determine size, legality. */
7131     RExC_parse = exp;
7132     RExC_start = RExC_adjusted_start = exp;
7133     RExC_end = exp + plen;
7134     RExC_precomp_end = RExC_end;
7135     RExC_naughty = 0;
7136     RExC_npar = 1;
7137     RExC_nestroot = 0;
7138     RExC_size = 0L;
7139     RExC_emit = (regnode *) &RExC_emit_dummy;
7140     RExC_whilem_seen = 0;
7141     RExC_open_parens = NULL;
7142     RExC_close_parens = NULL;
7143     RExC_end_op = NULL;
7144     RExC_paren_names = NULL;
7145 #ifdef DEBUGGING
7146     RExC_paren_name_list = NULL;
7147 #endif
7148     RExC_recurse = NULL;
7149     RExC_study_chunk_recursed = NULL;
7150     RExC_study_chunk_recursed_bytes= 0;
7151     RExC_recurse_count = 0;
7152     pRExC_state->code_index = 0;
7153
7154     /* This NUL is guaranteed because the pattern comes from an SV*, and the sv
7155      * code makes sure the final byte is an uncounted NUL.  But should this
7156      * ever not be the case, lots of things could read beyond the end of the
7157      * buffer: loops like
7158      *      while(isFOO(*RExC_parse)) RExC_parse++;
7159      *      strchr(RExC_parse, "foo");
7160      * etc.  So it is worth noting. */
7161     assert(*RExC_end == '\0');
7162
7163     DEBUG_PARSE_r(
7164         Perl_re_printf( aTHX_  "Starting first pass (sizing)\n");
7165         RExC_lastnum=0;
7166         RExC_lastparse=NULL;
7167     );
7168
7169     if (reg(pRExC_state, 0, &flags,1) == NULL) {
7170         /* It's possible to write a regexp in ascii that represents Unicode
7171         codepoints outside of the byte range, such as via \x{100}. If we
7172         detect such a sequence we have to convert the entire pattern to utf8
7173         and then recompile, as our sizing calculation will have been based
7174         on 1 byte == 1 character, but we will need to use utf8 to encode
7175         at least some part of the pattern, and therefore must convert the whole
7176         thing.
7177         -- dmq */
7178         if (flags & RESTART_PASS1) {
7179             if (flags & NEED_UTF8) {
7180                 S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &exp, &plen,
7181                 pRExC_state->code_blocks ? pRExC_state->code_blocks->count : 0);
7182             }
7183             else {
7184                 DEBUG_PARSE_r(Perl_re_printf( aTHX_
7185                 "Need to redo pass 1\n"));
7186             }
7187
7188             goto redo_first_pass;
7189         }
7190         Perl_croak(aTHX_ "panic: reg returned NULL to re_op_compile for sizing pass, flags=%#" UVxf, (UV) flags);
7191     }
7192
7193     DEBUG_PARSE_r({
7194         Perl_re_printf( aTHX_
7195             "Required size %" IVdf " nodes\n"
7196             "Starting second pass (creation)\n",
7197             (IV)RExC_size);
7198         RExC_lastnum=0;
7199         RExC_lastparse=NULL;
7200     });
7201
7202     /* The first pass could have found things that force Unicode semantics */
7203     if ((RExC_utf8 || RExC_uni_semantics)
7204          && get_regex_charset(rx_flags) == REGEX_DEPENDS_CHARSET)
7205     {
7206         set_regex_charset(&rx_flags, REGEX_UNICODE_CHARSET);
7207     }
7208
7209     /* Small enough for pointer-storage convention?
7210        If extralen==0, this means that we will not need long jumps. */
7211     if (RExC_size >= 0x10000L && RExC_extralen)
7212         RExC_size += RExC_extralen;
7213     else
7214         RExC_extralen = 0;
7215     if (RExC_whilem_seen > 15)
7216         RExC_whilem_seen = 15;
7217
7218     /* Allocate space and zero-initialize. Note, the two step process
7219        of zeroing when in debug mode, thus anything assigned has to
7220        happen after that */
7221     rx = (REGEXP*) newSV_type(SVt_REGEXP);
7222     r = ReANY(rx);
7223     Newxc(ri, sizeof(regexp_internal) + (unsigned)RExC_size * sizeof(regnode),
7224          char, regexp_internal);
7225     if ( r == NULL || ri == NULL )
7226         FAIL("Regexp out of space");
7227 #ifdef DEBUGGING
7228     /* avoid reading uninitialized memory in DEBUGGING code in study_chunk() */
7229     Zero(ri, sizeof(regexp_internal) + (unsigned)RExC_size * sizeof(regnode),
7230          char);
7231 #else
7232     /* bulk initialize base fields with 0. */
7233     Zero(ri, sizeof(regexp_internal), char);
7234 #endif
7235
7236     /* non-zero initialization begins here */
7237     RXi_SET( r, ri );
7238     r->engine= eng;
7239     r->extflags = rx_flags;
7240     RXp_COMPFLAGS(r) = orig_rx_flags & RXf_PMf_FLAGCOPYMASK;
7241
7242     if (pm_flags & PMf_IS_QR) {
7243         ri->code_blocks = pRExC_state->code_blocks;
7244         if (ri->code_blocks)
7245             ri->code_blocks->refcnt++;
7246     }
7247
7248     {
7249         bool has_p     = ((r->extflags & RXf_PMf_KEEPCOPY) == RXf_PMf_KEEPCOPY);
7250         bool has_charset = (get_regex_charset(r->extflags)
7251                                                     != REGEX_DEPENDS_CHARSET);
7252
7253         /* The caret is output if there are any defaults: if not all the STD
7254          * flags are set, or if no character set specifier is needed */
7255         bool has_default =
7256                     (((r->extflags & RXf_PMf_STD_PMMOD) != RXf_PMf_STD_PMMOD)
7257                     || ! has_charset);
7258         bool has_runon = ((RExC_seen & REG_RUN_ON_COMMENT_SEEN)
7259                                                    == REG_RUN_ON_COMMENT_SEEN);
7260         U8 reganch = (U8)((r->extflags & RXf_PMf_STD_PMMOD)
7261                             >> RXf_PMf_STD_PMMOD_SHIFT);
7262         const char *fptr = STD_PAT_MODS;        /*"msixxn"*/
7263         char *p;
7264
7265         /* We output all the necessary flags; we never output a minus, as all
7266          * those are defaults, so are
7267          * covered by the caret */
7268         const STRLEN wraplen = plen + has_p + has_runon
7269             + has_default       /* If needs a caret */
7270             + PL_bitcount[reganch] /* 1 char for each set standard flag */
7271
7272                 /* If needs a character set specifier */
7273             + ((has_charset) ? MAX_CHARSET_NAME_LENGTH : 0)
7274             + (sizeof("(?:)") - 1);
7275
7276         /* make sure PL_bitcount bounds not exceeded */
7277         assert(sizeof(STD_PAT_MODS) <= 8);
7278
7279         p = sv_grow(MUTABLE_SV(rx), wraplen + 1); /* +1 for the ending NUL */
7280         SvPOK_on(rx);
7281         if (RExC_utf8)
7282             SvFLAGS(rx) |= SVf_UTF8;
7283         *p++='('; *p++='?';
7284
7285         /* If a default, cover it using the caret */
7286         if (has_default) {
7287             *p++= DEFAULT_PAT_MOD;
7288         }
7289         if (has_charset) {
7290             STRLEN len;
7291             const char* const name = get_regex_charset_name(r->extflags, &len);
7292             Copy(name, p, len, char);
7293             p += len;
7294         }
7295         if (has_p)
7296             *p++ = KEEPCOPY_PAT_MOD; /*'p'*/
7297         {
7298             char ch;
7299             while((ch = *fptr++)) {
7300                 if(reganch & 1)
7301                     *p++ = ch;
7302                 reganch >>= 1;
7303             }
7304         }
7305
7306         *p++ = ':';
7307         Copy(RExC_precomp, p, plen, char);
7308         assert ((RX_WRAPPED(rx) - p) < 16);
7309         r->pre_prefix = p - RX_WRAPPED(rx);
7310         p += plen;
7311         if (has_runon)
7312             *p++ = '\n';
7313         *p++ = ')';
7314         *p = 0;
7315         SvCUR_set(rx, p - RX_WRAPPED(rx));
7316     }
7317
7318     r->intflags = 0;
7319     r->nparens = RExC_npar - 1; /* set early to validate backrefs */
7320
7321     /* Useful during FAIL. */
7322 #ifdef RE_TRACK_PATTERN_OFFSETS
7323     Newxz(ri->u.offsets, 2*RExC_size+1, U32); /* MJD 20001228 */
7324     DEBUG_OFFSETS_r(Perl_re_printf( aTHX_
7325                           "%s %" UVuf " bytes for offset annotations.\n",
7326                           ri->u.offsets ? "Got" : "Couldn't get",
7327                           (UV)((2*RExC_size+1) * sizeof(U32))));
7328 #endif
7329     SetProgLen(ri,RExC_size);
7330     RExC_rx_sv = rx;
7331     RExC_rx = r;
7332     RExC_rxi = ri;
7333
7334     /* Second pass: emit code. */
7335     RExC_flags = rx_flags;      /* don't let top level (?i) bleed */
7336     RExC_pm_flags = pm_flags;
7337     RExC_parse = exp;
7338     RExC_end = exp + plen;
7339     RExC_naughty = 0;
7340     RExC_emit_start = ri->program;
7341     RExC_emit = ri->program;
7342     RExC_emit_bound = ri->program + RExC_size + 1;
7343     pRExC_state->code_index = 0;
7344
7345     *((char*) RExC_emit++) = (char) REG_MAGIC;
7346     /* setup various meta data about recursion, this all requires
7347      * RExC_npar to be correctly set, and a bit later on we clear it */
7348     if (RExC_seen & REG_RECURSE_SEEN) {
7349         DEBUG_OPTIMISE_MORE_r(Perl_re_printf( aTHX_
7350             "%*s%*s Setting up open/close parens\n",
7351                   22, "|    |", (int)(0 * 2 + 1), ""));
7352
7353         /* setup RExC_open_parens, which holds the address of each
7354          * OPEN tag, and to make things simpler for the 0 index
7355          * the start of the program - this is used later for offsets */
7356         Newxz(RExC_open_parens, RExC_npar,regnode *);
7357         SAVEFREEPV(RExC_open_parens);
7358         RExC_open_parens[0] = RExC_emit;
7359
7360         /* setup RExC_close_parens, which holds the address of each
7361          * CLOSE tag, and to make things simpler for the 0 index
7362          * the end of the program - this is used later for offsets */
7363         Newxz(RExC_close_parens, RExC_npar,regnode *);
7364         SAVEFREEPV(RExC_close_parens);
7365         /* we dont know where end op starts yet, so we dont
7366          * need to set RExC_close_parens[0] like we do RExC_open_parens[0] above */
7367
7368         /* Note, RExC_npar is 1 + the number of parens in a pattern.
7369          * So its 1 if there are no parens. */
7370         RExC_study_chunk_recursed_bytes= (RExC_npar >> 3) +
7371                                          ((RExC_npar & 0x07) != 0);
7372         Newx(RExC_study_chunk_recursed,
7373              RExC_study_chunk_recursed_bytes * RExC_npar, U8);
7374         SAVEFREEPV(RExC_study_chunk_recursed);
7375     }
7376     RExC_npar = 1;
7377     if (reg(pRExC_state, 0, &flags,1) == NULL) {
7378         ReREFCNT_dec(rx);
7379         Perl_croak(aTHX_ "panic: reg returned NULL to re_op_compile for generation pass, flags=%#" UVxf, (UV) flags);
7380     }
7381     DEBUG_OPTIMISE_r(
7382         Perl_re_printf( aTHX_  "Starting post parse optimization\n");
7383     );
7384
7385     /* XXXX To minimize changes to RE engine we always allocate
7386        3-units-long substrs field. */
7387     Newx(r->substrs, 1, struct reg_substr_data);
7388     if (RExC_recurse_count) {
7389         Newx(RExC_recurse,RExC_recurse_count,regnode *);
7390         SAVEFREEPV(RExC_recurse);
7391     }
7392
7393   reStudy:
7394     r->minlen = minlen = sawlookahead = sawplus = sawopen = sawminmod = 0;
7395     DEBUG_r(
7396         RExC_study_chunk_recursed_count= 0;
7397     );
7398     Zero(r->substrs, 1, struct reg_substr_data);
7399     if (RExC_study_chunk_recursed) {
7400         Zero(RExC_study_chunk_recursed,
7401              RExC_study_chunk_recursed_bytes * RExC_npar, U8);
7402     }
7403
7404
7405 #ifdef TRIE_STUDY_OPT
7406     if (!restudied) {
7407         StructCopy(&zero_scan_data, &data, scan_data_t);
7408         copyRExC_state = RExC_state;
7409     } else {
7410         U32 seen=RExC_seen;
7411         DEBUG_OPTIMISE_r(Perl_re_printf( aTHX_ "Restudying\n"));
7412
7413         RExC_state = copyRExC_state;
7414         if (seen & REG_TOP_LEVEL_BRANCHES_SEEN)
7415             RExC_seen |= REG_TOP_LEVEL_BRANCHES_SEEN;
7416         else
7417             RExC_seen &= ~REG_TOP_LEVEL_BRANCHES_SEEN;
7418         StructCopy(&zero_scan_data, &data, scan_data_t);
7419     }
7420 #else
7421     StructCopy(&zero_scan_data, &data, scan_data_t);
7422 #endif
7423
7424     /* Dig out information for optimizations. */
7425     r->extflags = RExC_flags; /* was pm_op */
7426     /*dmq: removed as part of de-PMOP: pm->op_pmflags = RExC_flags; */
7427
7428     if (UTF)
7429         SvUTF8_on(rx);  /* Unicode in it? */
7430     ri->regstclass = NULL;
7431     if (RExC_naughty >= TOO_NAUGHTY)    /* Probably an expensive pattern. */
7432         r->intflags |= PREGf_NAUGHTY;
7433     scan = ri->program + 1;             /* First BRANCH. */
7434
7435     /* testing for BRANCH here tells us whether there is "must appear"
7436        data in the pattern. If there is then we can use it for optimisations */
7437     if (!(RExC_seen & REG_TOP_LEVEL_BRANCHES_SEEN)) { /*  Only one top-level choice.
7438                                                   */
7439         SSize_t fake;
7440         STRLEN longest_length[2];
7441         regnode_ssc ch_class; /* pointed to by data */
7442         int stclass_flag;
7443         SSize_t last_close = 0; /* pointed to by data */
7444         regnode *first= scan;
7445         regnode *first_next= regnext(first);
7446         int i;
7447
7448         /*
7449          * Skip introductions and multiplicators >= 1
7450          * so that we can extract the 'meat' of the pattern that must
7451          * match in the large if() sequence following.
7452          * NOTE that EXACT is NOT covered here, as it is normally
7453          * picked up by the optimiser separately.
7454          *
7455          * This is unfortunate as the optimiser isnt handling lookahead
7456          * properly currently.
7457          *
7458          */
7459         while ((OP(first) == OPEN && (sawopen = 1)) ||
7460                /* An OR of *one* alternative - should not happen now. */
7461             (OP(first) == BRANCH && OP(first_next) != BRANCH) ||
7462             /* for now we can't handle lookbehind IFMATCH*/
7463             (OP(first) == IFMATCH && !first->flags && (sawlookahead = 1)) ||
7464             (OP(first) == PLUS) ||
7465             (OP(first) == MINMOD) ||
7466                /* An {n,m} with n>0 */
7467             (PL_regkind[OP(first)] == CURLY && ARG1(first) > 0) ||
7468             (OP(first) == NOTHING && PL_regkind[OP(first_next)] != END ))
7469         {
7470                 /*
7471                  * the only op that could be a regnode is PLUS, all the rest
7472                  * will be regnode_1 or regnode_2.
7473                  *
7474                  * (yves doesn't think this is true)
7475                  */
7476                 if (OP(first) == PLUS)
7477                     sawplus = 1;
7478                 else {
7479                     if (OP(first) == MINMOD)
7480                         sawminmod = 1;
7481                     first += regarglen[OP(first)];
7482                 }
7483                 first = NEXTOPER(first);
7484                 first_next= regnext(first);
7485         }
7486
7487         /* Starting-point info. */
7488       again:
7489         DEBUG_PEEP("first:", first, 0, 0);
7490         /* Ignore EXACT as we deal with it later. */
7491         if (PL_regkind[OP(first)] == EXACT) {
7492             if (OP(first) == EXACT || OP(first) == EXACTL)
7493                 NOOP;   /* Empty, get anchored substr later. */
7494             else
7495                 ri->regstclass = first;
7496         }
7497 #ifdef TRIE_STCLASS
7498         else if (PL_regkind[OP(first)] == TRIE &&
7499                 ((reg_trie_data *)ri->data->data[ ARG(first) ])->minlen>0)
7500         {
7501             /* this can happen only on restudy */
7502             ri->regstclass = construct_ahocorasick_from_trie(pRExC_state, (regnode *)first, 0);
7503         }
7504 #endif
7505         else if (REGNODE_SIMPLE(OP(first)))
7506             ri->regstclass = first;
7507         else if (PL_regkind[OP(first)] == BOUND ||
7508                  PL_regkind[OP(first)] == NBOUND)
7509             ri->regstclass = first;
7510         else if (PL_regkind[OP(first)] == BOL) {
7511             r->intflags |= (OP(first) == MBOL
7512                            ? PREGf_ANCH_MBOL
7513                            : PREGf_ANCH_SBOL);
7514             first = NEXTOPER(first);
7515             goto again;
7516         }
7517         else if (OP(first) == GPOS) {
7518             r->intflags |= PREGf_ANCH_GPOS;
7519             first = NEXTOPER(first);
7520             goto again;
7521         }
7522         else if ((!sawopen || !RExC_sawback) &&
7523             !sawlookahead &&
7524             (OP(first) == STAR &&
7525             PL_regkind[OP(NEXTOPER(first))] == REG_ANY) &&
7526             !(r->intflags & PREGf_ANCH) && !pRExC_state->code_blocks)
7527         {
7528             /* turn .* into ^.* with an implied $*=1 */
7529             const int type =
7530                 (OP(NEXTOPER(first)) == REG_ANY)
7531                     ? PREGf_ANCH_MBOL
7532                     : PREGf_ANCH_SBOL;
7533             r->intflags |= (type | PREGf_IMPLICIT);
7534             first = NEXTOPER(first);
7535             goto again;
7536         }
7537         if (sawplus && !sawminmod && !sawlookahead
7538             && (!sawopen || !RExC_sawback)
7539             && !pRExC_state->code_blocks) /* May examine pos and $& */
7540             /* x+ must match at the 1st pos of run of x's */
7541             r->intflags |= PREGf_SKIP;
7542
7543         /* Scan is after the zeroth branch, first is atomic matcher. */
7544 #ifdef TRIE_STUDY_OPT
7545         DEBUG_PARSE_r(
7546             if (!restudied)
7547                 Perl_re_printf( aTHX_  "first at %" IVdf "\n",
7548                               (IV)(first - scan + 1))
7549         );
7550 #else
7551         DEBUG_PARSE_r(
7552             Perl_re_printf( aTHX_  "first at %" IVdf "\n",
7553                 (IV)(first - scan + 1))
7554         );
7555 #endif
7556
7557
7558         /*
7559         * If there's something expensive in the r.e., find the
7560         * longest literal string that must appear and make it the
7561         * regmust.  Resolve ties in favor of later strings, since
7562         * the regstart check works with the beginning of the r.e.
7563         * and avoiding duplication strengthens checking.  Not a
7564         * strong reason, but sufficient in the absence of others.
7565         * [Now we resolve ties in favor of the earlier string if
7566         * it happens that c_offset_min has been invalidated, since the
7567         * earlier string may buy us something the later one won't.]
7568         */
7569
7570         data.substrs[0].str = newSVpvs("");
7571         data.substrs[1].str = newSVpvs("");
7572         data.last_found = newSVpvs("");
7573         data.cur_is_floating = 0; /* initially any found substring is fixed */
7574         ENTER_with_name("study_chunk");
7575         SAVEFREESV(data.substrs[0].str);
7576         SAVEFREESV(data.substrs[1].str);
7577         SAVEFREESV(data.last_found);
7578         first = scan;
7579         if (!ri->regstclass) {
7580             ssc_init(pRExC_state, &ch_class);
7581             data.start_class = &ch_class;
7582             stclass_flag = SCF_DO_STCLASS_AND;
7583         } else                          /* XXXX Check for BOUND? */
7584             stclass_flag = 0;
7585         data.last_closep = &last_close;
7586
7587         DEBUG_RExC_seen();
7588         /*
7589          * MAIN ENTRY FOR study_chunk() FOR m/PATTERN/
7590          * (NO top level branches)
7591          */
7592         minlen = study_chunk(pRExC_state, &first, &minlen, &fake,
7593                              scan + RExC_size, /* Up to end */
7594             &data, -1, 0, NULL,
7595             SCF_DO_SUBSTR | SCF_WHILEM_VISITED_POS | stclass_flag
7596                           | (restudied ? SCF_TRIE_DOING_RESTUDY : 0),
7597             0);
7598
7599
7600         CHECK_RESTUDY_GOTO_butfirst(LEAVE_with_name("study_chunk"));
7601
7602
7603         if ( RExC_npar == 1 && !data.cur_is_floating
7604              && data.last_start_min == 0 && data.last_end > 0
7605              && !RExC_seen_zerolen
7606              && !(RExC_seen & REG_VERBARG_SEEN)
7607              && !(RExC_seen & REG_GPOS_SEEN)
7608         ){
7609             r->extflags |= RXf_CHECK_ALL;
7610         }
7611         scan_commit(pRExC_state, &data,&minlen,0);
7612
7613
7614         /* XXX this is done in reverse order because that's the way the
7615          * code was before it was parameterised. Don't know whether it
7616          * actually needs doing in reverse order. DAPM */
7617         for (i = 1; i >= 0; i--) {
7618             longest_length[i] = CHR_SVLEN(data.substrs[i].str);
7619
7620             if (   !(   i
7621                      && SvCUR(data.substrs[0].str)  /* ok to leave SvCUR */
7622                      &&    data.substrs[0].min_offset
7623                         == data.substrs[1].min_offset
7624                      &&    SvCUR(data.substrs[0].str)
7625                         == SvCUR(data.substrs[1].str)
7626                     )
7627                 && S_setup_longest (aTHX_ pRExC_state,
7628                                         &(r->substrs->data[i]),
7629                                         &(data.substrs[i]),
7630                                         longest_length[i]))
7631             {
7632                 r->substrs->data[i].min_offset =
7633                         data.substrs[i].min_offset - data.substrs[i].lookbehind;
7634
7635                 r->substrs->data[i].max_offset = data.substrs[i].max_offset;
7636                 /* Don't offset infinity */
7637                 if (data.substrs[i].max_offset < SSize_t_MAX)
7638                     r->substrs->data[i].max_offset -= data.substrs[i].lookbehind;
7639                 SvREFCNT_inc_simple_void_NN(data.substrs[i].str);
7640             }
7641             else {
7642                 r->substrs->data[i].substr      = NULL;
7643                 r->substrs->data[i].utf8_substr = NULL;
7644                 longest_length[i] = 0;
7645             }
7646         }
7647
7648         LEAVE_with_name("study_chunk");
7649
7650         if (ri->regstclass
7651             && (OP(ri->regstclass) == REG_ANY || OP(ri->regstclass) == SANY))
7652             ri->regstclass = NULL;
7653
7654         if ((!(r->substrs->data[0].substr || r->substrs->data[0].utf8_substr)
7655               || r->substrs->data[0].min_offset)
7656             && stclass_flag
7657             && ! (ANYOF_FLAGS(data.start_class) & SSC_MATCHES_EMPTY_STRING)
7658             && is_ssc_worth_it(pRExC_state, data.start_class))
7659         {
7660             const U32 n = add_data(pRExC_state, STR_WITH_LEN("f"));
7661
7662             ssc_finalize(pRExC_state, data.start_class);
7663
7664             Newx(RExC_rxi->data->data[n], 1, regnode_ssc);
7665             StructCopy(data.start_class,
7666                        (regnode_ssc*)RExC_rxi->data->data[n],
7667                        regnode_ssc);
7668             ri->regstclass = (regnode*)RExC_rxi->data->data[n];
7669             r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
7670             DEBUG_COMPILE_r({ SV *sv = sv_newmortal();
7671                       regprop(r, sv, (regnode*)data.start_class, NULL, pRExC_state);
7672                       Perl_re_printf( aTHX_
7673                                     "synthetic stclass \"%s\".\n",
7674                                     SvPVX_const(sv));});
7675             data.start_class = NULL;
7676         }
7677
7678         /* A temporary algorithm prefers floated substr to fixed one of
7679          * same length to dig more info. */
7680         i = (longest_length[0] <= longest_length[1]);
7681         r->substrs->check_ix = i;
7682         r->check_end_shift  = r->substrs->data[i].end_shift;
7683         r->check_substr     = r->substrs->data[i].substr;
7684         r->check_utf8       = r->substrs->data[i].utf8_substr;
7685         r->check_offset_min = r->substrs->data[i].min_offset;
7686         r->check_offset_max = r->substrs->data[i].max_offset;
7687         if (!i && (r->intflags & (PREGf_ANCH_SBOL|PREGf_ANCH_GPOS)))
7688             r->intflags |= PREGf_NOSCAN;
7689
7690         if ((r->check_substr || r->check_utf8) ) {
7691             r->extflags |= RXf_USE_INTUIT;
7692             if (SvTAIL(r->check_substr ? r->check_substr : r->check_utf8))
7693                 r->extflags |= RXf_INTUIT_TAIL;
7694         }
7695
7696         /* XXX Unneeded? dmq (shouldn't as this is handled elsewhere)
7697         if ( (STRLEN)minlen < longest_length[1] )
7698             minlen= longest_length[1];
7699         if ( (STRLEN)minlen < longest_length[0] )
7700             minlen= longest_length[0];
7701         */
7702     }
7703     else {
7704         /* Several toplevels. Best we can is to set minlen. */
7705         SSize_t fake;
7706         regnode_ssc ch_class;
7707         SSize_t last_close = 0;
7708
7709         DEBUG_PARSE_r(Perl_re_printf( aTHX_  "\nMulti Top Level\n"));
7710
7711         scan = ri->program + 1;
7712         ssc_init(pRExC_state, &ch_class);
7713         data.start_class = &ch_class;
7714         data.last_closep = &last_close;
7715
7716         DEBUG_RExC_seen();
7717         /*
7718          * MAIN ENTRY FOR study_chunk() FOR m/P1|P2|.../
7719          * (patterns WITH top level branches)
7720          */
7721         minlen = study_chunk(pRExC_state,
7722             &scan, &minlen, &fake, scan + RExC_size, &data, -1, 0, NULL,
7723             SCF_DO_STCLASS_AND|SCF_WHILEM_VISITED_POS|(restudied
7724                                                       ? SCF_TRIE_DOING_RESTUDY
7725                                                       : 0),
7726             0);
7727
7728         CHECK_RESTUDY_GOTO_butfirst(NOOP);
7729
7730         r->check_substr = NULL;
7731         r->check_utf8 = NULL;
7732         r->substrs->data[0].substr      = NULL;
7733         r->substrs->data[0].utf8_substr = NULL;
7734         r->substrs->data[1].substr      = NULL;
7735         r->substrs->data[1].utf8_substr = NULL;
7736
7737         if (! (ANYOF_FLAGS(data.start_class) & SSC_MATCHES_EMPTY_STRING)
7738             && is_ssc_worth_it(pRExC_state, data.start_class))
7739         {
7740             const U32 n = add_data(pRExC_state, STR_WITH_LEN("f"));
7741
7742             ssc_finalize(pRExC_state, data.start_class);
7743
7744             Newx(RExC_rxi->data->data[n], 1, regnode_ssc);
7745             StructCopy(data.start_class,
7746                        (regnode_ssc*)RExC_rxi->data->data[n],
7747                        regnode_ssc);
7748             ri->regstclass = (regnode*)RExC_rxi->data->data[n];
7749             r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
7750             DEBUG_COMPILE_r({ SV* sv = sv_newmortal();
7751                       regprop(r, sv, (regnode*)data.start_class, NULL, pRExC_state);
7752                       Perl_re_printf( aTHX_
7753                                     "synthetic stclass \"%s\".\n",
7754                                     SvPVX_const(sv));});
7755             data.start_class = NULL;
7756         }
7757     }
7758
7759     if (RExC_seen & REG_UNBOUNDED_QUANTIFIER_SEEN) {
7760         r->extflags |= RXf_UNBOUNDED_QUANTIFIER_SEEN;
7761         r->maxlen = REG_INFTY;
7762     }
7763     else {
7764         r->maxlen = RExC_maxlen;
7765     }
7766
7767     /* Guard against an embedded (?=) or (?<=) with a longer minlen than
7768        the "real" pattern. */
7769     DEBUG_OPTIMISE_r({
7770         Perl_re_printf( aTHX_ "minlen: %" IVdf " r->minlen:%" IVdf " maxlen:%" IVdf "\n",
7771                       (IV)minlen, (IV)r->minlen, (IV)RExC_maxlen);
7772     });
7773     r->minlenret = minlen;
7774     if (r->minlen < minlen)
7775         r->minlen = minlen;
7776
7777     if (RExC_seen & REG_RECURSE_SEEN ) {
7778         r->intflags |= PREGf_RECURSE_SEEN;
7779         Newx(r->recurse_locinput, r->nparens + 1, char *);
7780     }
7781     if (RExC_seen & REG_GPOS_SEEN)
7782         r->intflags |= PREGf_GPOS_SEEN;
7783     if (RExC_seen & REG_LOOKBEHIND_SEEN)
7784         r->extflags |= RXf_NO_INPLACE_SUBST; /* inplace might break the
7785                                                 lookbehind */
7786     if (pRExC_state->code_blocks)
7787         r->extflags |= RXf_EVAL_SEEN;
7788     if (RExC_seen & REG_VERBARG_SEEN)
7789     {
7790         r->intflags |= PREGf_VERBARG_SEEN;
7791         r->extflags |= RXf_NO_INPLACE_SUBST; /* don't understand this! Yves */
7792     }
7793     if (RExC_seen & REG_CUTGROUP_SEEN)
7794         r->intflags |= PREGf_CUTGROUP_SEEN;
7795     if (pm_flags & PMf_USE_RE_EVAL)
7796         r->intflags |= PREGf_USE_RE_EVAL;
7797     if (RExC_paren_names)
7798         RXp_PAREN_NAMES(r) = MUTABLE_HV(SvREFCNT_inc(RExC_paren_names));
7799     else
7800         RXp_PAREN_NAMES(r) = NULL;
7801
7802     /* If we have seen an anchor in our pattern then we set the extflag RXf_IS_ANCHORED
7803      * so it can be used in pp.c */
7804     if (r->intflags & PREGf_ANCH)
7805         r->extflags |= RXf_IS_ANCHORED;
7806
7807
7808     {
7809         /* this is used to identify "special" patterns that might result
7810          * in Perl NOT calling the regex engine and instead doing the match "itself",
7811          * particularly special cases in split//. By having the regex compiler
7812          * do this pattern matching at a regop level (instead of by inspecting the pattern)
7813          * we avoid weird issues with equivalent patterns resulting in different behavior,
7814          * AND we allow non Perl engines to get the same optimizations by the setting the
7815          * flags appropriately - Yves */
7816         regnode *first = ri->program + 1;
7817         U8 fop = OP(first);
7818         regnode *next = regnext(first);
7819         U8 nop = OP(next);
7820
7821         if (PL_regkind[fop] == NOTHING && nop == END)
7822             r->extflags |= RXf_NULL;
7823         else if ((fop == MBOL || (fop == SBOL && !first->flags)) && nop == END)
7824             /* when fop is SBOL first->flags will be true only when it was
7825              * produced by parsing /\A/, and not when parsing /^/. This is
7826              * very important for the split code as there we want to
7827              * treat /^/ as /^/m, but we do not want to treat /\A/ as /^/m.
7828              * See rt #122761 for more details. -- Yves */
7829             r->extflags |= RXf_START_ONLY;
7830         else if (fop == PLUS
7831                  && PL_regkind[nop] == POSIXD && FLAGS(next) == _CC_SPACE
7832                  && nop == END)
7833             r->extflags |= RXf_WHITE;
7834         else if ( r->extflags & RXf_SPLIT
7835                   && (fop == EXACT || fop == EXACTL)
7836                   && STR_LEN(first) == 1
7837                   && *(STRING(first)) == ' '
7838                   && nop == END )
7839             r->extflags |= (RXf_SKIPWHITE|RXf_WHITE);
7840
7841     }
7842
7843     if (RExC_contains_locale) {
7844         RXp_EXTFLAGS(r) |= RXf_TAINTED;
7845     }
7846
7847 #ifdef DEBUGGING
7848     if (RExC_paren_names) {
7849         ri->name_list_idx = add_data( pRExC_state, STR_WITH_LEN("a"));
7850         ri->data->data[ri->name_list_idx]
7851                                    = (void*)SvREFCNT_inc(RExC_paren_name_list);
7852     } else
7853 #endif
7854     ri->name_list_idx = 0;
7855
7856     while ( RExC_recurse_count > 0 ) {
7857         const regnode *scan = RExC_recurse[ --RExC_recurse_count ];
7858         /*
7859          * This data structure is set up in study_chunk() and is used
7860          * to calculate the distance between a GOSUB regopcode and
7861          * the OPEN/CURLYM (CURLYM's are special and can act like OPEN's)
7862          * it refers to.
7863          *
7864          * If for some reason someone writes code that optimises
7865          * away a GOSUB opcode then the assert should be changed to
7866          * an if(scan) to guard the ARG2L_SET() - Yves
7867          *
7868          */
7869         assert(scan && OP(scan) == GOSUB);
7870         ARG2L_SET( scan, RExC_open_parens[ARG(scan)] - scan );
7871     }
7872
7873     Newxz(r->offs, RExC_npar, regexp_paren_pair);
7874     /* assume we don't need to swap parens around before we match */
7875     DEBUG_TEST_r({
7876         Perl_re_printf( aTHX_ "study_chunk_recursed_count: %lu\n",
7877             (unsigned long)RExC_study_chunk_recursed_count);
7878     });
7879     DEBUG_DUMP_r({
7880         DEBUG_RExC_seen();
7881         Perl_re_printf( aTHX_ "Final program:\n");
7882         regdump(r);
7883     });
7884 #ifdef RE_TRACK_PATTERN_OFFSETS
7885     DEBUG_OFFSETS_r(if (ri->u.offsets) {
7886         const STRLEN len = ri->u.offsets[0];
7887         STRLEN i;
7888         GET_RE_DEBUG_FLAGS_DECL;
7889         Perl_re_printf( aTHX_
7890                       "Offsets: [%" UVuf "]\n\t", (UV)ri->u.offsets[0]);
7891         for (i = 1; i <= len; i++) {
7892             if (ri->u.offsets[i*2-1] || ri->u.offsets[i*2])
7893                 Perl_re_printf( aTHX_  "%" UVuf ":%" UVuf "[%" UVuf "] ",
7894                 (UV)i, (UV)ri->u.offsets[i*2-1], (UV)ri->u.offsets[i*2]);
7895             }
7896         Perl_re_printf( aTHX_  "\n");
7897     });
7898 #endif
7899
7900 #ifdef USE_ITHREADS
7901     /* under ithreads the ?pat? PMf_USED flag on the pmop is simulated
7902      * by setting the regexp SV to readonly-only instead. If the
7903      * pattern's been recompiled, the USEDness should remain. */
7904     if (old_re && SvREADONLY(old_re))
7905         SvREADONLY_on(rx);
7906 #endif
7907     return rx;
7908 }
7909
7910
7911 SV*
7912 Perl_reg_named_buff(pTHX_ REGEXP * const rx, SV * const key, SV * const value,
7913                     const U32 flags)
7914 {
7915     PERL_ARGS_ASSERT_REG_NAMED_BUFF;
7916
7917     PERL_UNUSED_ARG(value);
7918
7919     if (flags & RXapif_FETCH) {
7920         return reg_named_buff_fetch(rx, key, flags);
7921     } else if (flags & (RXapif_STORE | RXapif_DELETE | RXapif_CLEAR)) {
7922         Perl_croak_no_modify();
7923         return NULL;
7924     } else if (flags & RXapif_EXISTS) {
7925         return reg_named_buff_exists(rx, key, flags)
7926             ? &PL_sv_yes
7927             : &PL_sv_no;
7928     } else if (flags & RXapif_REGNAMES) {
7929         return reg_named_buff_all(rx, flags);
7930     } else if (flags & (RXapif_SCALAR | RXapif_REGNAMES_COUNT)) {
7931         return reg_named_buff_scalar(rx, flags);
7932     } else {
7933         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff", (int)flags);
7934         return NULL;
7935     }
7936 }
7937
7938 SV*
7939 Perl_reg_named_buff_iter(pTHX_ REGEXP * const rx, const SV * const lastkey,
7940                          const U32 flags)
7941 {
7942     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ITER;
7943     PERL_UNUSED_ARG(lastkey);
7944
7945     if (flags & RXapif_FIRSTKEY)
7946         return reg_named_buff_firstkey(rx, flags);
7947     else if (flags & RXapif_NEXTKEY)
7948         return reg_named_buff_nextkey(rx, flags);
7949     else {
7950         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_iter",
7951                                             (int)flags);
7952         return NULL;
7953     }
7954 }
7955
7956 SV*
7957 Perl_reg_named_buff_fetch(pTHX_ REGEXP * const r, SV * const namesv,
7958                           const U32 flags)
7959 {
7960     SV *ret;
7961     struct regexp *const rx = ReANY(r);
7962
7963     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FETCH;
7964
7965     if (rx && RXp_PAREN_NAMES(rx)) {
7966         HE *he_str = hv_fetch_ent( RXp_PAREN_NAMES(rx), namesv, 0, 0 );
7967         if (he_str) {
7968             IV i;
7969             SV* sv_dat=HeVAL(he_str);
7970             I32 *nums=(I32*)SvPVX(sv_dat);
7971             AV * const retarray = (flags & RXapif_ALL) ? newAV() : NULL;
7972             for ( i=0; i<SvIVX(sv_dat); i++ ) {
7973                 if ((I32)(rx->nparens) >= nums[i]
7974                     && rx->offs[nums[i]].start != -1
7975                     && rx->offs[nums[i]].end != -1)
7976                 {
7977                     ret = newSVpvs("");
7978                     CALLREG_NUMBUF_FETCH(r,nums[i],ret);
7979                     if (!retarray)
7980                         return ret;
7981                 } else {
7982                     if (retarray)
7983                         ret = newSVsv(&PL_sv_undef);
7984                 }
7985                 if (retarray)
7986                     av_push(retarray, ret);
7987             }
7988             if (retarray)
7989                 return newRV_noinc(MUTABLE_SV(retarray));
7990         }
7991     }
7992     return NULL;
7993 }
7994
7995 bool
7996 Perl_reg_named_buff_exists(pTHX_ REGEXP * const r, SV * const key,
7997                            const U32 flags)
7998 {
7999     struct regexp *const rx = ReANY(r);
8000
8001     PERL_ARGS_ASSERT_REG_NAMED_BUFF_EXISTS;
8002
8003     if (rx && RXp_PAREN_NAMES(rx)) {
8004         if (flags & RXapif_ALL) {
8005             return hv_exists_ent(RXp_PAREN_NAMES(rx), key, 0);
8006         } else {
8007             SV *sv = CALLREG_NAMED_BUFF_FETCH(r, key, flags);
8008             if (sv) {
8009                 SvREFCNT_dec_NN(sv);
8010                 return TRUE;
8011             } else {
8012                 return FALSE;
8013             }
8014         }
8015     } else {
8016         return FALSE;
8017     }
8018 }
8019
8020 SV*
8021 Perl_reg_named_buff_firstkey(pTHX_ REGEXP * const r, const U32 flags)
8022 {
8023     struct regexp *const rx = ReANY(r);
8024
8025     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FIRSTKEY;
8026
8027     if ( rx && RXp_PAREN_NAMES(rx) ) {
8028         (void)hv_iterinit(RXp_PAREN_NAMES(rx));
8029
8030         return CALLREG_NAMED_BUFF_NEXTKEY(r, NULL, flags & ~RXapif_FIRSTKEY);
8031     } else {
8032         return FALSE;
8033     }
8034 }
8035
8036 SV*
8037 Perl_reg_named_buff_nextkey(pTHX_ REGEXP * const r, const U32 flags)
8038 {
8039     struct regexp *const rx = ReANY(r);
8040     GET_RE_DEBUG_FLAGS_DECL;
8041
8042     PERL_ARGS_ASSERT_REG_NAMED_BUFF_NEXTKEY;
8043
8044     if (rx && RXp_PAREN_NAMES(rx)) {
8045         HV *hv = RXp_PAREN_NAMES(rx);
8046         HE *temphe;
8047         while ( (temphe = hv_iternext_flags(hv,0)) ) {
8048             IV i;
8049             IV parno = 0;
8050             SV* sv_dat = HeVAL(temphe);
8051             I32 *nums = (I32*)SvPVX(sv_dat);
8052             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
8053                 if ((I32)(rx->lastparen) >= nums[i] &&
8054                     rx->offs[nums[i]].start != -1 &&
8055                     rx->offs[nums[i]].end != -1)
8056                 {
8057                     parno = nums[i];
8058                     break;
8059                 }
8060             }
8061             if (parno || flags & RXapif_ALL) {
8062                 return newSVhek(HeKEY_hek(temphe));
8063             }
8064         }
8065     }
8066     return NULL;
8067 }
8068
8069 SV*
8070 Perl_reg_named_buff_scalar(pTHX_ REGEXP * const r, const U32 flags)
8071 {
8072     SV *ret;
8073     AV *av;
8074     SSize_t length;
8075     struct regexp *const rx = ReANY(r);
8076
8077     PERL_ARGS_ASSERT_REG_NAMED_BUFF_SCALAR;
8078
8079     if (rx && RXp_PAREN_NAMES(rx)) {
8080         if (flags & (RXapif_ALL | RXapif_REGNAMES_COUNT)) {
8081             return newSViv(HvTOTALKEYS(RXp_PAREN_NAMES(rx)));
8082         } else if (flags & RXapif_ONE) {
8083             ret = CALLREG_NAMED_BUFF_ALL(r, (flags | RXapif_REGNAMES));
8084             av = MUTABLE_AV(SvRV(ret));
8085             length = av_tindex(av);
8086             SvREFCNT_dec_NN(ret);
8087             return newSViv(length + 1);
8088         } else {
8089             Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_scalar",
8090                                                 (int)flags);
8091             return NULL;
8092         }
8093     }
8094     return &PL_sv_undef;
8095 }
8096
8097 SV*
8098 Perl_reg_named_buff_all(pTHX_ REGEXP * const r, const U32 flags)
8099 {
8100     struct regexp *const rx = ReANY(r);
8101     AV *av = newAV();
8102
8103     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ALL;
8104
8105     if (rx && RXp_PAREN_NAMES(rx)) {
8106         HV *hv= RXp_PAREN_NAMES(rx);
8107         HE *temphe;
8108         (void)hv_iterinit(hv);
8109         while ( (temphe = hv_iternext_flags(hv,0)) ) {
8110             IV i;
8111             IV parno = 0;
8112             SV* sv_dat = HeVAL(temphe);
8113             I32 *nums = (I32*)SvPVX(sv_dat);
8114             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
8115                 if ((I32)(rx->lastparen) >= nums[i] &&
8116                     rx->offs[nums[i]].start != -1 &&
8117                     rx->offs[nums[i]].end != -1)
8118                 {
8119                     parno = nums[i];
8120                     break;
8121                 }
8122             }
8123             if (parno || flags & RXapif_ALL) {
8124                 av_push(av, newSVhek(HeKEY_hek(temphe)));
8125             }
8126         }
8127     }
8128
8129     return newRV_noinc(MUTABLE_SV(av));
8130 }
8131
8132 void
8133 Perl_reg_numbered_buff_fetch(pTHX_ REGEXP * const r, const I32 paren,
8134                              SV * const sv)
8135 {
8136     struct regexp *const rx = ReANY(r);
8137     char *s = NULL;
8138     SSize_t i = 0;
8139     SSize_t s1, t1;
8140     I32 n = paren;
8141
8142     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_FETCH;
8143
8144     if (      n == RX_BUFF_IDX_CARET_PREMATCH
8145            || n == RX_BUFF_IDX_CARET_FULLMATCH
8146            || n == RX_BUFF_IDX_CARET_POSTMATCH
8147        )
8148     {
8149         bool keepcopy = cBOOL(rx->extflags & RXf_PMf_KEEPCOPY);
8150         if (!keepcopy) {
8151             /* on something like
8152              *    $r = qr/.../;
8153              *    /$qr/p;
8154              * the KEEPCOPY is set on the PMOP rather than the regex */
8155             if (PL_curpm && r == PM_GETRE(PL_curpm))
8156                  keepcopy = cBOOL(PL_curpm->op_pmflags & PMf_KEEPCOPY);
8157         }
8158         if (!keepcopy)
8159             goto ret_undef;
8160     }
8161
8162     if (!rx->subbeg)
8163         goto ret_undef;
8164
8165     if (n == RX_BUFF_IDX_CARET_FULLMATCH)
8166         /* no need to distinguish between them any more */
8167         n = RX_BUFF_IDX_FULLMATCH;
8168
8169     if ((n == RX_BUFF_IDX_PREMATCH || n == RX_BUFF_IDX_CARET_PREMATCH)
8170         && rx->offs[0].start != -1)
8171     {
8172         /* $`, ${^PREMATCH} */
8173         i = rx->offs[0].start;
8174         s = rx->subbeg;
8175     }
8176     else
8177     if ((n == RX_BUFF_IDX_POSTMATCH || n == RX_BUFF_IDX_CARET_POSTMATCH)
8178         && rx->offs[0].end != -1)
8179     {
8180         /* $', ${^POSTMATCH} */
8181         s = rx->subbeg - rx->suboffset + rx->offs[0].end;
8182         i = rx->sublen + rx->suboffset - rx->offs[0].end;
8183     }
8184     else
8185     if ( 0 <= n && n <= (I32)rx->nparens &&
8186         (s1 = rx->offs[n].start) != -1 &&
8187         (t1 = rx->offs[n].end) != -1)
8188     {
8189         /* $&, ${^MATCH},  $1 ... */
8190         i = t1 - s1;
8191         s = rx->subbeg + s1 - rx->suboffset;
8192     } else {
8193         goto ret_undef;
8194     }
8195
8196     assert(s >= rx->subbeg);
8197     assert((STRLEN)rx->sublen >= (STRLEN)((s - rx->subbeg) + i) );
8198     if (i >= 0) {
8199 #ifdef NO_TAINT_SUPPORT
8200         sv_setpvn(sv, s, i);
8201 #else
8202         const int oldtainted = TAINT_get;
8203         TAINT_NOT;
8204         sv_setpvn(sv, s, i);
8205         TAINT_set(oldtainted);
8206 #endif
8207         if (RXp_MATCH_UTF8(rx))
8208             SvUTF8_on(sv);
8209         else
8210             SvUTF8_off(sv);
8211         if (TAINTING_get) {
8212             if (RXp_MATCH_TAINTED(rx)) {
8213                 if (SvTYPE(sv) >= SVt_PVMG) {
8214                     MAGIC* const mg = SvMAGIC(sv);
8215                     MAGIC* mgt;
8216                     TAINT;
8217                     SvMAGIC_set(sv, mg->mg_moremagic);
8218                     SvTAINT(sv);
8219                     if ((mgt = SvMAGIC(sv))) {
8220                         mg->mg_moremagic = mgt;
8221                         SvMAGIC_set(sv, mg);
8222                     }
8223                 } else {
8224                     TAINT;
8225                     SvTAINT(sv);
8226                 }
8227             } else
8228                 SvTAINTED_off(sv);
8229         }
8230     } else {
8231       ret_undef:
8232         sv_set_undef(sv);
8233         return;
8234     }
8235 }
8236
8237 void
8238 Perl_reg_numbered_buff_store(pTHX_ REGEXP * const rx, const I32 paren,
8239                                                          SV const * const value)
8240 {
8241     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_STORE;
8242
8243     PERL_UNUSED_ARG(rx);
8244     PERL_UNUSED_ARG(paren);
8245     PERL_UNUSED_ARG(value);
8246
8247     if (!PL_localizing)
8248         Perl_croak_no_modify();
8249 }
8250
8251 I32
8252 Perl_reg_numbered_buff_length(pTHX_ REGEXP * const r, const SV * const sv,
8253                               const I32 paren)
8254 {
8255     struct regexp *const rx = ReANY(r);
8256     I32 i;
8257     I32 s1, t1;
8258
8259     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_LENGTH;
8260
8261     if (   paren == RX_BUFF_IDX_CARET_PREMATCH
8262         || paren == RX_BUFF_IDX_CARET_FULLMATCH
8263         || paren == RX_BUFF_IDX_CARET_POSTMATCH
8264     )
8265     {
8266         bool keepcopy = cBOOL(rx->extflags & RXf_PMf_KEEPCOPY);
8267         if (!keepcopy) {
8268             /* on something like
8269              *    $r = qr/.../;
8270              *    /$qr/p;
8271              * the KEEPCOPY is set on the PMOP rather than the regex */
8272             if (PL_curpm && r == PM_GETRE(PL_curpm))
8273                  keepcopy = cBOOL(PL_curpm->op_pmflags & PMf_KEEPCOPY);
8274         }
8275         if (!keepcopy)
8276             goto warn_undef;
8277     }
8278
8279     /* Some of this code was originally in C<Perl_magic_len> in F<mg.c> */
8280     switch (paren) {
8281       case RX_BUFF_IDX_CARET_PREMATCH: /* ${^PREMATCH} */
8282       case RX_BUFF_IDX_PREMATCH:       /* $` */
8283         if (rx->offs[0].start != -1) {
8284                         i = rx->offs[0].start;
8285                         if (i > 0) {
8286                                 s1 = 0;
8287                                 t1 = i;
8288                                 goto getlen;
8289                         }
8290             }
8291         return 0;
8292
8293       case RX_BUFF_IDX_CARET_POSTMATCH: /* ${^POSTMATCH} */
8294       case RX_BUFF_IDX_POSTMATCH:       /* $' */
8295             if (rx->offs[0].end != -1) {
8296                         i = rx->sublen - rx->offs[0].end;
8297                         if (i > 0) {
8298                                 s1 = rx->offs[0].end;
8299                                 t1 = rx->sublen;
8300                                 goto getlen;
8301                         }
8302             }
8303         return 0;
8304
8305       default: /* $& / ${^MATCH}, $1, $2, ... */
8306             if (paren <= (I32)rx->nparens &&
8307             (s1 = rx->offs[paren].start) != -1 &&
8308             (t1 = rx->offs[paren].end) != -1)
8309             {
8310             i = t1 - s1;
8311             goto getlen;
8312         } else {
8313           warn_undef:
8314             if (ckWARN(WARN_UNINITIALIZED))
8315                 report_uninit((const SV *)sv);
8316             return 0;
8317         }
8318     }
8319   getlen:
8320     if (i > 0 && RXp_MATCH_UTF8(rx)) {
8321         const char * const s = rx->subbeg - rx->suboffset + s1;
8322         const U8 *ep;
8323         STRLEN el;
8324
8325         i = t1 - s1;
8326         if (is_utf8_string_loclen((U8*)s, i, &ep, &el))
8327                         i = el;
8328     }
8329     return i;
8330 }
8331
8332 SV*
8333 Perl_reg_qr_package(pTHX_ REGEXP * const rx)
8334 {
8335     PERL_ARGS_ASSERT_REG_QR_PACKAGE;
8336         PERL_UNUSED_ARG(rx);
8337         if (0)
8338             return NULL;
8339         else
8340             return newSVpvs("Regexp");
8341 }
8342
8343 /* Scans the name of a named buffer from the pattern.
8344  * If flags is REG_RSN_RETURN_NULL returns null.
8345  * If flags is REG_RSN_RETURN_NAME returns an SV* containing the name
8346  * If flags is REG_RSN_RETURN_DATA returns the data SV* corresponding
8347  * to the parsed name as looked up in the RExC_paren_names hash.
8348  * If there is an error throws a vFAIL().. type exception.
8349  */
8350
8351 #define REG_RSN_RETURN_NULL    0
8352 #define REG_RSN_RETURN_NAME    1
8353 #define REG_RSN_RETURN_DATA    2
8354
8355 STATIC SV*
8356 S_reg_scan_name(pTHX_ RExC_state_t *pRExC_state, U32 flags)
8357 {
8358     char *name_start = RExC_parse;
8359
8360     PERL_ARGS_ASSERT_REG_SCAN_NAME;
8361
8362     assert (RExC_parse <= RExC_end);
8363     if (RExC_parse == RExC_end) NOOP;
8364     else if (isIDFIRST_lazy_if_safe(RExC_parse, RExC_end, UTF)) {
8365          /* Note that the code here assumes well-formed UTF-8.  Skip IDFIRST by
8366           * using do...while */
8367         if (UTF)
8368             do {
8369                 RExC_parse += UTF8SKIP(RExC_parse);
8370             } while (   RExC_parse < RExC_end
8371                      && isWORDCHAR_utf8_safe((U8*)RExC_parse, (U8*) RExC_end));
8372         else
8373             do {
8374                 RExC_parse++;
8375             } while (RExC_parse < RExC_end && isWORDCHAR(*RExC_parse));
8376     } else {
8377         RExC_parse++; /* so the <- from the vFAIL is after the offending
8378                          character */
8379         vFAIL("Group name must start with a non-digit word character");
8380     }
8381     if ( flags ) {
8382         SV* sv_name
8383             = newSVpvn_flags(name_start, (int)(RExC_parse - name_start),
8384                              SVs_TEMP | (UTF ? SVf_UTF8 : 0));
8385         if ( flags == REG_RSN_RETURN_NAME)
8386             return sv_name;
8387         else if (flags==REG_RSN_RETURN_DATA) {
8388             HE *he_str = NULL;
8389             SV *sv_dat = NULL;
8390             if ( ! sv_name )      /* should not happen*/
8391                 Perl_croak(aTHX_ "panic: no svname in reg_scan_name");
8392             if (RExC_paren_names)
8393                 he_str = hv_fetch_ent( RExC_paren_names, sv_name, 0, 0 );
8394             if ( he_str )
8395                 sv_dat = HeVAL(he_str);
8396             if ( ! sv_dat )
8397                 vFAIL("Reference to nonexistent named group");
8398             return sv_dat;
8399         }
8400         else {
8401             Perl_croak(aTHX_ "panic: bad flag %lx in reg_scan_name",
8402                        (unsigned long) flags);
8403         }
8404         NOT_REACHED; /* NOTREACHED */
8405     }
8406     return NULL;
8407 }
8408
8409 #define DEBUG_PARSE_MSG(funcname)     DEBUG_PARSE_r({           \
8410     int num;                                                    \
8411     if (RExC_lastparse!=RExC_parse) {                           \
8412         Perl_re_printf( aTHX_  "%s",                                        \
8413             Perl_pv_pretty(aTHX_ RExC_mysv1, RExC_parse,        \
8414                 RExC_end - RExC_parse, 16,                      \
8415                 "", "",                                         \
8416                 PERL_PV_ESCAPE_UNI_DETECT |                     \
8417                 PERL_PV_PRETTY_ELLIPSES   |                     \
8418                 PERL_PV_PRETTY_LTGT       |                     \
8419                 PERL_PV_ESCAPE_RE         |                     \
8420                 PERL_PV_PRETTY_EXACTSIZE                        \
8421             )                                                   \
8422         );                                                      \
8423     } else                                                      \
8424         Perl_re_printf( aTHX_ "%16s","");                                   \
8425                                                                 \
8426     if (SIZE_ONLY)                                              \
8427        num = RExC_size + 1;                                     \
8428     else                                                        \
8429        num=REG_NODE_NUM(RExC_emit);                             \
8430     if (RExC_lastnum!=num)                                      \
8431        Perl_re_printf( aTHX_ "|%4d",num);                                   \
8432     else                                                        \
8433        Perl_re_printf( aTHX_ "|%4s","");                                    \
8434     Perl_re_printf( aTHX_ "|%*s%-4s",                                       \
8435         (int)((depth*2)), "",                                   \
8436         (funcname)                                              \
8437     );                                                          \
8438     RExC_lastnum=num;                                           \
8439     RExC_lastparse=RExC_parse;                                  \
8440 })
8441
8442
8443
8444 #define DEBUG_PARSE(funcname)     DEBUG_PARSE_r({           \
8445     DEBUG_PARSE_MSG((funcname));                            \
8446     Perl_re_printf( aTHX_ "%4s","\n");                                  \
8447 })
8448 #define DEBUG_PARSE_FMT(funcname,fmt,args)     DEBUG_PARSE_r({\
8449     DEBUG_PARSE_MSG((funcname));                            \
8450     Perl_re_printf( aTHX_ fmt "\n",args);                               \
8451 })
8452
8453 /* This section of code defines the inversion list object and its methods.  The
8454  * interfaces are highly subject to change, so as much as possible is static to
8455  * this file.  An inversion list is here implemented as a malloc'd C UV array
8456  * as an SVt_INVLIST scalar.
8457  *
8458  * An inversion list for Unicode is an array of code points, sorted by ordinal
8459  * number.  Each element gives the code point that begins a range that extends
8460  * up-to but not including the code point given by the next element.  The final
8461  * element gives the first code point of a range that extends to the platform's
8462  * infinity.  The even-numbered elements (invlist[0], invlist[2], invlist[4],
8463  * ...) give ranges whose code points are all in the inversion list.  We say
8464  * that those ranges are in the set.  The odd-numbered elements give ranges
8465  * whose code points are not in the inversion list, and hence not in the set.
8466  * Thus, element [0] is the first code point in the list.  Element [1]
8467  * is the first code point beyond that not in the list; and element [2] is the
8468  * first code point beyond that that is in the list.  In other words, the first
8469  * range is invlist[0]..(invlist[1]-1), and all code points in that range are
8470  * in the inversion list.  The second range is invlist[1]..(invlist[2]-1), and
8471  * all code points in that range are not in the inversion list.  The third
8472  * range invlist[2]..(invlist[3]-1) gives code points that are in the inversion
8473  * list, and so forth.  Thus every element whose index is divisible by two
8474  * gives the beginning of a range that is in the list, and every element whose
8475  * index is not divisible by two gives the beginning of a range not in the
8476  * list.  If the final element's index is divisible by two, the inversion list
8477  * extends to the platform's infinity; otherwise the highest code point in the
8478  * inversion list is the contents of that element minus 1.
8479  *
8480  * A range that contains just a single code point N will look like
8481  *  invlist[i]   == N
8482  *  invlist[i+1] == N+1
8483  *
8484  * If N is UV_MAX (the highest representable code point on the machine), N+1 is
8485  * impossible to represent, so element [i+1] is omitted.  The single element
8486  * inversion list
8487  *  invlist[0] == UV_MAX
8488  * contains just UV_MAX, but is interpreted as matching to infinity.
8489  *
8490  * Taking the complement (inverting) an inversion list is quite simple, if the
8491  * first element is 0, remove it; otherwise add a 0 element at the beginning.
8492  * This implementation reserves an element at the beginning of each inversion
8493  * list to always contain 0; there is an additional flag in the header which
8494  * indicates if the list begins at the 0, or is offset to begin at the next
8495  * element.  This means that the inversion list can be inverted without any
8496  * copying; just flip the flag.
8497  *
8498  * More about inversion lists can be found in "Unicode Demystified"
8499  * Chapter 13 by Richard Gillam, published by Addison-Wesley.
8500  *
8501  * The inversion list data structure is currently implemented as an SV pointing
8502  * to an array of UVs that the SV thinks are bytes.  This allows us to have an
8503  * array of UV whose memory management is automatically handled by the existing
8504  * facilities for SV's.
8505  *
8506  * Some of the methods should always be private to the implementation, and some
8507  * should eventually be made public */
8508
8509 /* The header definitions are in F<invlist_inline.h> */
8510
8511 #ifndef PERL_IN_XSUB_RE
8512
8513 PERL_STATIC_INLINE UV*
8514 S__invlist_array_init(SV* const invlist, const bool will_have_0)
8515 {
8516     /* Returns a pointer to the first element in the inversion list's array.
8517      * This is called upon initialization of an inversion list.  Where the
8518      * array begins depends on whether the list has the code point U+0000 in it
8519      * or not.  The other parameter tells it whether the code that follows this
8520      * call is about to put a 0 in the inversion list or not.  The first
8521      * element is either the element reserved for 0, if TRUE, or the element
8522      * after it, if FALSE */
8523
8524     bool* offset = get_invlist_offset_addr(invlist);
8525     UV* zero_addr = (UV *) SvPVX(invlist);
8526
8527     PERL_ARGS_ASSERT__INVLIST_ARRAY_INIT;
8528
8529     /* Must be empty */
8530     assert(! _invlist_len(invlist));
8531
8532     *zero_addr = 0;
8533
8534     /* 1^1 = 0; 1^0 = 1 */
8535     *offset = 1 ^ will_have_0;
8536     return zero_addr + *offset;
8537 }
8538
8539 #endif
8540
8541 PERL_STATIC_INLINE void
8542 S_invlist_set_len(pTHX_ SV* const invlist, const UV len, const bool offset)
8543 {
8544     /* Sets the current number of elements stored in the inversion list.
8545      * Updates SvCUR correspondingly */
8546     PERL_UNUSED_CONTEXT;
8547     PERL_ARGS_ASSERT_INVLIST_SET_LEN;
8548
8549     assert(SvTYPE(invlist) == SVt_INVLIST);
8550
8551     SvCUR_set(invlist,
8552               (len == 0)
8553                ? 0
8554                : TO_INTERNAL_SIZE(len + offset));
8555     assert(SvLEN(invlist) == 0 || SvCUR(invlist) <= SvLEN(invlist));
8556 }
8557
8558 #ifndef PERL_IN_XSUB_RE
8559
8560 STATIC void
8561 S_invlist_replace_list_destroys_src(pTHX_ SV * dest, SV * src)
8562 {
8563     /* Replaces the inversion list in 'dest' with the one from 'src'.  It
8564      * steals the list from 'src', so 'src' is made to have a NULL list.  This
8565      * is similar to what SvSetMagicSV() would do, if it were implemented on
8566      * inversion lists, though this routine avoids a copy */
8567
8568     const UV src_len          = _invlist_len(src);
8569     const bool src_offset     = *get_invlist_offset_addr(src);
8570     const STRLEN src_byte_len = SvLEN(src);
8571     char * array              = SvPVX(src);
8572
8573     const int oldtainted = TAINT_get;
8574
8575     PERL_ARGS_ASSERT_INVLIST_REPLACE_LIST_DESTROYS_SRC;
8576
8577     assert(SvTYPE(src) == SVt_INVLIST);
8578     assert(SvTYPE(dest) == SVt_INVLIST);
8579     assert(! invlist_is_iterating(src));
8580     assert(SvCUR(src) == 0 || SvCUR(src) < SvLEN(src));
8581
8582     /* Make sure it ends in the right place with a NUL, as our inversion list
8583      * manipulations aren't careful to keep this true, but sv_usepvn_flags()
8584      * asserts it */
8585     array[src_byte_len - 1] = '\0';
8586
8587     TAINT_NOT;      /* Otherwise it breaks */
8588     sv_usepvn_flags(dest,
8589                     (char *) array,
8590                     src_byte_len - 1,
8591
8592                     /* This flag is documented to cause a copy to be avoided */
8593                     SV_HAS_TRAILING_NUL);
8594     TAINT_set(oldtainted);
8595     SvPV_set(src, 0);
8596     SvLEN_set(src, 0);
8597     SvCUR_set(src, 0);
8598
8599     /* Finish up copying over the other fields in an inversion list */
8600     *get_invlist_offset_addr(dest) = src_offset;
8601     invlist_set_len(dest, src_len, src_offset);
8602     *get_invlist_previous_index_addr(dest) = 0;
8603     invlist_iterfinish(dest);
8604 }
8605
8606 PERL_STATIC_INLINE IV*
8607 S_get_invlist_previous_index_addr(SV* invlist)
8608 {
8609     /* Return the address of the IV that is reserved to hold the cached index
8610      * */
8611     PERL_ARGS_ASSERT_GET_INVLIST_PREVIOUS_INDEX_ADDR;
8612
8613     assert(SvTYPE(invlist) == SVt_INVLIST);
8614
8615     return &(((XINVLIST*) SvANY(invlist))->prev_index);
8616 }
8617
8618 PERL_STATIC_INLINE IV
8619 S_invlist_previous_index(SV* const invlist)
8620 {
8621     /* Returns cached index of previous search */
8622
8623     PERL_ARGS_ASSERT_INVLIST_PREVIOUS_INDEX;
8624
8625     return *get_invlist_previous_index_addr(invlist);
8626 }
8627
8628 PERL_STATIC_INLINE void
8629 S_invlist_set_previous_index(SV* const invlist, const IV index)
8630 {
8631     /* Caches <index> for later retrieval */
8632
8633     PERL_ARGS_ASSERT_INVLIST_SET_PREVIOUS_INDEX;
8634
8635     assert(index == 0 || index < (int) _invlist_len(invlist));
8636
8637     *get_invlist_previous_index_addr(invlist) = index;
8638 }
8639
8640 PERL_STATIC_INLINE void
8641 S_invlist_trim(SV* invlist)
8642 {
8643     /* Free the not currently-being-used space in an inversion list */
8644
8645     /* But don't free up the space needed for the 0 UV that is always at the
8646      * beginning of the list, nor the trailing NUL */
8647     const UV min_size = TO_INTERNAL_SIZE(1) + 1;
8648
8649     PERL_ARGS_ASSERT_INVLIST_TRIM;
8650
8651     assert(SvTYPE(invlist) == SVt_INVLIST);
8652
8653     SvPV_renew(invlist, MAX(min_size, SvCUR(invlist) + 1));
8654 }
8655
8656 PERL_STATIC_INLINE void
8657 S_invlist_clear(pTHX_ SV* invlist)    /* Empty the inversion list */
8658 {
8659     PERL_ARGS_ASSERT_INVLIST_CLEAR;
8660
8661     assert(SvTYPE(invlist) == SVt_INVLIST);
8662
8663     invlist_set_len(invlist, 0, 0);
8664     invlist_trim(invlist);
8665 }
8666
8667 #endif /* ifndef PERL_IN_XSUB_RE */
8668
8669 PERL_STATIC_INLINE bool
8670 S_invlist_is_iterating(SV* const invlist)
8671 {
8672     PERL_ARGS_ASSERT_INVLIST_IS_ITERATING;
8673
8674     return *(get_invlist_iter_addr(invlist)) < (STRLEN) UV_MAX;
8675 }
8676
8677 #ifndef PERL_IN_XSUB_RE
8678
8679 PERL_STATIC_INLINE UV
8680 S_invlist_max(SV* const invlist)
8681 {
8682     /* Returns the maximum number of elements storable in the inversion list's
8683      * array, without having to realloc() */
8684
8685     PERL_ARGS_ASSERT_INVLIST_MAX;
8686
8687     assert(SvTYPE(invlist) == SVt_INVLIST);
8688
8689     /* Assumes worst case, in which the 0 element is not counted in the
8690      * inversion list, so subtracts 1 for that */
8691     return SvLEN(invlist) == 0  /* This happens under _new_invlist_C_array */
8692            ? FROM_INTERNAL_SIZE(SvCUR(invlist)) - 1
8693            : FROM_INTERNAL_SIZE(SvLEN(invlist)) - 1;
8694 }
8695 SV*
8696 Perl__new_invlist(pTHX_ IV initial_size)
8697 {
8698
8699     /* Return a pointer to a newly constructed inversion list, with enough
8700      * space to store 'initial_size' elements.  If that number is negative, a
8701      * system default is used instead */
8702
8703     SV* new_list;
8704
8705     if (initial_size < 0) {
8706         initial_size = 10;
8707     }
8708
8709     /* Allocate the initial space */
8710     new_list = newSV_type(SVt_INVLIST);
8711
8712     /* First 1 is in case the zero element isn't in the list; second 1 is for
8713      * trailing NUL */
8714     SvGROW(new_list, TO_INTERNAL_SIZE(initial_size + 1) + 1);
8715     invlist_set_len(new_list, 0, 0);
8716
8717     /* Force iterinit() to be used to get iteration to work */
8718     *get_invlist_iter_addr(new_list) = (STRLEN) UV_MAX;
8719
8720     *get_invlist_previous_index_addr(new_list) = 0;
8721
8722     return new_list;
8723 }
8724
8725 SV*
8726 Perl__new_invlist_C_array(pTHX_ const UV* const list)
8727 {
8728     /* Return a pointer to a newly constructed inversion list, initialized to
8729      * point to <list>, which has to be in the exact correct inversion list
8730      * form, including internal fields.  Thus this is a dangerous routine that
8731      * should not be used in the wrong hands.  The passed in 'list' contains
8732      * several header fields at the beginning that are not part of the
8733      * inversion list body proper */
8734
8735     const STRLEN length = (STRLEN) list[0];
8736     const UV version_id =          list[1];
8737     const bool offset   =    cBOOL(list[2]);
8738 #define HEADER_LENGTH 3
8739     /* If any of the above changes in any way, you must change HEADER_LENGTH
8740      * (if appropriate) and regenerate INVLIST_VERSION_ID by running
8741      *      perl -E 'say int(rand 2**31-1)'
8742      */
8743 #define INVLIST_VERSION_ID 148565664 /* This is a combination of a version and
8744                                         data structure type, so that one being
8745                                         passed in can be validated to be an
8746                                         inversion list of the correct vintage.
8747                                        */
8748
8749     SV* invlist = newSV_type(SVt_INVLIST);
8750
8751     PERL_ARGS_ASSERT__NEW_INVLIST_C_ARRAY;
8752
8753     if (version_id != INVLIST_VERSION_ID) {
8754         Perl_croak(aTHX_ "panic: Incorrect version for previously generated inversion list");
8755     }
8756
8757     /* The generated array passed in includes header elements that aren't part
8758      * of the list proper, so start it just after them */
8759     SvPV_set(invlist, (char *) (list + HEADER_LENGTH));
8760
8761     SvLEN_set(invlist, 0);  /* Means we own the contents, and the system
8762                                shouldn't touch it */
8763
8764     *(get_invlist_offset_addr(invlist)) = offset;
8765
8766     /* The 'length' passed to us is the physical number of elements in the
8767      * inversion list.  But if there is an offset the logical number is one
8768      * less than that */
8769     invlist_set_len(invlist, length  - offset, offset);
8770
8771     invlist_set_previous_index(invlist, 0);
8772
8773     /* Initialize the iteration pointer. */
8774     invlist_iterfinish(invlist);
8775
8776     SvREADONLY_on(invlist);
8777
8778     return invlist;
8779 }
8780
8781 STATIC void
8782 S_invlist_extend(pTHX_ SV* const invlist, const UV new_max)
8783 {
8784     /* Grow the maximum size of an inversion list */
8785
8786     PERL_ARGS_ASSERT_INVLIST_EXTEND;
8787
8788     assert(SvTYPE(invlist) == SVt_INVLIST);
8789
8790     /* Add one to account for the zero element at the beginning which may not
8791      * be counted by the calling parameters */
8792     SvGROW((SV *)invlist, TO_INTERNAL_SIZE(new_max + 1));
8793 }
8794
8795 STATIC void
8796 S__append_range_to_invlist(pTHX_ SV* const invlist,
8797                                  const UV start, const UV end)
8798 {
8799    /* Subject to change or removal.  Append the range from 'start' to 'end' at
8800     * the end of the inversion list.  The range must be above any existing
8801     * ones. */
8802
8803     UV* array;
8804     UV max = invlist_max(invlist);
8805     UV len = _invlist_len(invlist);
8806     bool offset;
8807
8808     PERL_ARGS_ASSERT__APPEND_RANGE_TO_INVLIST;
8809
8810     if (len == 0) { /* Empty lists must be initialized */
8811         offset = start != 0;
8812         array = _invlist_array_init(invlist, ! offset);
8813     }
8814     else {
8815         /* Here, the existing list is non-empty. The current max entry in the
8816          * list is generally the first value not in the set, except when the
8817          * set extends to the end of permissible values, in which case it is
8818          * the first entry in that final set, and so this call is an attempt to
8819          * append out-of-order */
8820
8821         UV final_element = len - 1;
8822         array = invlist_array(invlist);
8823         if (   array[final_element] > start
8824             || ELEMENT_RANGE_MATCHES_INVLIST(final_element))
8825         {
8826             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",
8827                      array[final_element], start,
8828                      ELEMENT_RANGE_MATCHES_INVLIST(final_element) ? 't' : 'f');
8829         }
8830
8831         /* Here, it is a legal append.  If the new range begins 1 above the end
8832          * of the range below it, it is extending the range below it, so the
8833          * new first value not in the set is one greater than the newly
8834          * extended range.  */
8835         offset = *get_invlist_offset_addr(invlist);
8836         if (array[final_element] == start) {
8837             if (end != UV_MAX) {
8838                 array[final_element] = end + 1;
8839             }
8840             else {
8841                 /* But if the end is the maximum representable on the machine,
8842                  * assume that infinity was actually what was meant.  Just let
8843                  * the range that this would extend to have no end */
8844                 invlist_set_len(invlist, len - 1, offset);
8845             }
8846             return;
8847         }
8848     }
8849
8850     /* Here the new range doesn't extend any existing set.  Add it */
8851
8852     len += 2;   /* Includes an element each for the start and end of range */
8853
8854     /* If wll overflow the existing space, extend, which may cause the array to
8855      * be moved */
8856     if (max < len) {
8857         invlist_extend(invlist, len);
8858
8859         /* Have to set len here to avoid assert failure in invlist_array() */
8860         invlist_set_len(invlist, len, offset);
8861
8862         array = invlist_array(invlist);
8863     }
8864     else {
8865         invlist_set_len(invlist, len, offset);
8866     }
8867
8868     /* The next item on the list starts the range, the one after that is
8869      * one past the new range.  */
8870     array[len - 2] = start;
8871     if (end != UV_MAX) {
8872         array[len - 1] = end + 1;
8873     }
8874     else {
8875         /* But if the end is the maximum representable on the machine, just let
8876          * the range have no end */
8877         invlist_set_len(invlist, len - 1, offset);
8878     }
8879 }
8880
8881 SSize_t
8882 Perl__invlist_search(SV* const invlist, const UV cp)
8883 {
8884     /* Searches the inversion list for the entry that contains the input code
8885      * point <cp>.  If <cp> is not in the list, -1 is returned.  Otherwise, the
8886      * return value is the index into the list's array of the range that
8887      * contains <cp>, that is, 'i' such that
8888      *  array[i] <= cp < array[i+1]
8889      */
8890
8891     IV low = 0;
8892     IV mid;
8893     IV high = _invlist_len(invlist);
8894     const IV highest_element = high - 1;
8895     const UV* array;
8896
8897     PERL_ARGS_ASSERT__INVLIST_SEARCH;
8898
8899     /* If list is empty, return failure. */
8900     if (high == 0) {
8901         return -1;
8902     }
8903
8904     /* (We can't get the array unless we know the list is non-empty) */
8905     array = invlist_array(invlist);
8906
8907     mid = invlist_previous_index(invlist);
8908     assert(mid >=0);
8909     if (mid > highest_element) {
8910         mid = highest_element;
8911     }
8912
8913     /* <mid> contains the cache of the result of the previous call to this
8914      * function (0 the first time).  See if this call is for the same result,
8915      * or if it is for mid-1.  This is under the theory that calls to this
8916      * function will often be for related code points that are near each other.
8917      * And benchmarks show that caching gives better results.  We also test
8918      * here if the code point is within the bounds of the list.  These tests
8919      * replace others that would have had to be made anyway to make sure that
8920      * the array bounds were not exceeded, and these give us extra information
8921      * at the same time */
8922     if (cp >= array[mid]) {
8923         if (cp >= array[highest_element]) {
8924             return highest_element;
8925         }
8926
8927         /* Here, array[mid] <= cp < array[highest_element].  This means that
8928          * the final element is not the answer, so can exclude it; it also
8929          * means that <mid> is not the final element, so can refer to 'mid + 1'
8930          * safely */
8931         if (cp < array[mid + 1]) {
8932             return mid;
8933         }
8934         high--;
8935         low = mid + 1;
8936     }
8937     else { /* cp < aray[mid] */
8938         if (cp < array[0]) { /* Fail if outside the array */
8939             return -1;
8940         }
8941         high = mid;
8942         if (cp >= array[mid - 1]) {
8943             goto found_entry;
8944         }
8945     }
8946
8947     /* Binary search.  What we are looking for is <i> such that
8948      *  array[i] <= cp < array[i+1]
8949      * The loop below converges on the i+1.  Note that there may not be an
8950      * (i+1)th element in the array, and things work nonetheless */
8951     while (low < high) {
8952         mid = (low + high) / 2;
8953         assert(mid <= highest_element);
8954         if (array[mid] <= cp) { /* cp >= array[mid] */
8955             low = mid + 1;
8956
8957             /* We could do this extra test to exit the loop early.
8958             if (cp < array[low]) {
8959                 return mid;
8960             }
8961             */
8962         }
8963         else { /* cp < array[mid] */
8964             high = mid;
8965         }
8966     }
8967
8968   found_entry:
8969     high--;
8970     invlist_set_previous_index(invlist, high);
8971     return high;
8972 }
8973
8974 void
8975 Perl__invlist_populate_swatch(SV* const invlist,
8976                               const UV start, const UV end, U8* swatch)
8977 {
8978     /* populates a swatch of a swash the same way swatch_get() does in utf8.c,
8979      * but is used when the swash has an inversion list.  This makes this much
8980      * faster, as it uses a binary search instead of a linear one.  This is
8981      * intimately tied to that function, and perhaps should be in utf8.c,
8982      * except it is intimately tied to inversion lists as well.  It assumes
8983      * that <swatch> is all 0's on input */
8984
8985     UV current = start;
8986     const IV len = _invlist_len(invlist);
8987     IV i;
8988     const UV * array;
8989
8990     PERL_ARGS_ASSERT__INVLIST_POPULATE_SWATCH;
8991
8992     if (len == 0) { /* Empty inversion list */
8993         return;
8994     }
8995
8996     array = invlist_array(invlist);
8997
8998     /* Find which element it is */
8999     i = _invlist_search(invlist, start);
9000
9001     /* We populate from <start> to <end> */
9002     while (current < end) {
9003         UV upper;
9004
9005         /* The inversion list gives the results for every possible code point
9006          * after the first one in the list.  Only those ranges whose index is
9007          * even are ones that the inversion list matches.  For the odd ones,
9008          * and if the initial code point is not in the list, we have to skip
9009          * forward to the next element */
9010         if (i == -1 || ! ELEMENT_RANGE_MATCHES_INVLIST(i)) {
9011             i++;
9012             if (i >= len) { /* Finished if beyond the end of the array */
9013                 return;
9014             }
9015             current = array[i];
9016             if (current >= end) {   /* Finished if beyond the end of what we
9017                                        are populating */
9018                 if (LIKELY(end < UV_MAX)) {
9019                     return;
9020                 }
9021
9022                 /* We get here when the upper bound is the maximum
9023                  * representable on the machine, and we are looking for just
9024                  * that code point.  Have to special case it */
9025                 i = len;
9026                 goto join_end_of_list;
9027             }
9028         }
9029         assert(current >= start);
9030
9031         /* The current range ends one below the next one, except don't go past
9032          * <end> */
9033         i++;
9034         upper = (i < len && array[i] < end) ? array[i] : end;
9035
9036         /* Here we are in a range that matches.  Populate a bit in the 3-bit U8
9037          * for each code point in it */
9038         for (; current < upper; current++) {
9039             const STRLEN offset = (STRLEN)(current - start);
9040             swatch[offset >> 3] |= 1 << (offset & 7);
9041         }
9042
9043       join_end_of_list:
9044
9045         /* Quit if at the end of the list */
9046         if (i >= len) {
9047
9048             /* But first, have to deal with the highest possible code point on
9049              * the platform.  The previous code assumes that <end> is one
9050              * beyond where we want to populate, but that is impossible at the
9051              * platform's infinity, so have to handle it specially */
9052             if (UNLIKELY(end == UV_MAX && ELEMENT_RANGE_MATCHES_INVLIST(len-1)))
9053             {
9054                 const STRLEN offset = (STRLEN)(end - start);
9055                 swatch[offset >> 3] |= 1 << (offset & 7);
9056             }
9057             return;
9058         }
9059
9060         /* Advance to the next range, which will be for code points not in the
9061          * inversion list */
9062         current = array[i];
9063     }
9064
9065     return;
9066 }
9067
9068 void
9069 Perl__invlist_union_maybe_complement_2nd(pTHX_ SV* const a, SV* const b,
9070                                          const bool complement_b, SV** output)
9071 {
9072     /* Take the union of two inversion lists and point '*output' to it.  On
9073      * input, '*output' MUST POINT TO NULL OR TO AN SV* INVERSION LIST (possibly
9074      * even 'a' or 'b').  If to an inversion list, the contents of the original
9075      * list will be replaced by the union.  The first list, 'a', may be
9076      * NULL, in which case a copy of the second list is placed in '*output'.
9077      * If 'complement_b' is TRUE, the union is taken of the complement
9078      * (inversion) of 'b' instead of b itself.
9079      *
9080      * The basis for this comes from "Unicode Demystified" Chapter 13 by
9081      * Richard Gillam, published by Addison-Wesley, and explained at some
9082      * length there.  The preface says to incorporate its examples into your
9083      * code at your own risk.
9084      *
9085      * The algorithm is like a merge sort. */
9086
9087     const UV* array_a;    /* a's array */
9088     const UV* array_b;
9089     UV len_a;       /* length of a's array */
9090     UV len_b;
9091
9092     SV* u;                      /* the resulting union */
9093     UV* array_u;
9094     UV len_u = 0;
9095
9096     UV i_a = 0;             /* current index into a's array */
9097     UV i_b = 0;
9098     UV i_u = 0;
9099
9100     /* running count, as explained in the algorithm source book; items are
9101      * stopped accumulating and are output when the count changes to/from 0.
9102      * The count is incremented when we start a range that's in an input's set,
9103      * and decremented when we start a range that's not in a set.  So this
9104      * variable can be 0, 1, or 2.  When it is 0 neither input is in their set,
9105      * and hence nothing goes into the union; 1, just one of the inputs is in
9106      * its set (and its current range gets added to the union); and 2 when both
9107      * inputs are in their sets.  */
9108     UV count = 0;
9109
9110     PERL_ARGS_ASSERT__INVLIST_UNION_MAYBE_COMPLEMENT_2ND;
9111     assert(a != b);
9112     assert(*output == NULL || SvTYPE(*output) == SVt_INVLIST);
9113
9114     len_b = _invlist_len(b);
9115     if (len_b == 0) {
9116
9117         /* Here, 'b' is empty, hence it's complement is all possible code
9118          * points.  So if the union includes the complement of 'b', it includes
9119          * everything, and we need not even look at 'a'.  It's easiest to
9120          * create a new inversion list that matches everything.  */
9121         if (complement_b) {
9122             SV* everything = _add_range_to_invlist(NULL, 0, UV_MAX);
9123
9124             if (*output == NULL) { /* If the output didn't exist, just point it
9125                                       at the new list */
9126                 *output = everything;
9127             }
9128             else { /* Otherwise, replace its contents with the new list */
9129                 invlist_replace_list_destroys_src(*output, everything);
9130                 SvREFCNT_dec_NN(everything);
9131             }
9132
9133             return;
9134         }
9135
9136         /* Here, we don't want the complement of 'b', and since 'b' is empty,
9137          * the union will come entirely from 'a'.  If 'a' is NULL or empty, the
9138          * output will be empty */
9139
9140         if (a == NULL || _invlist_len(a) == 0) {
9141             if (*output == NULL) {
9142                 *output = _new_invlist(0);
9143             }
9144             else {
9145                 invlist_clear(*output);
9146             }
9147             return;
9148         }
9149
9150         /* Here, 'a' is not empty, but 'b' is, so 'a' entirely determines the
9151          * union.  We can just return a copy of 'a' if '*output' doesn't point
9152          * to an existing list */
9153         if (*output == NULL) {
9154             *output = invlist_clone(a);
9155             return;
9156         }
9157
9158         /* If the output is to overwrite 'a', we have a no-op, as it's
9159          * already in 'a' */
9160         if (*output == a) {
9161             return;
9162         }
9163
9164         /* Here, '*output' is to be overwritten by 'a' */
9165         u = invlist_clone(a);
9166         invlist_replace_list_destroys_src(*output, u);
9167         SvREFCNT_dec_NN(u);
9168
9169         return;
9170     }
9171
9172     /* Here 'b' is not empty.  See about 'a' */
9173
9174     if (a == NULL || ((len_a = _invlist_len(a)) == 0)) {
9175
9176         /* Here, 'a' is empty (and b is not).  That means the union will come
9177          * entirely from 'b'.  If '*output' is NULL, we can directly return a
9178          * clone of 'b'.  Otherwise, we replace the contents of '*output' with
9179          * the clone */
9180
9181         SV ** dest = (*output == NULL) ? output : &u;
9182         *dest = invlist_clone(b);
9183         if (complement_b) {
9184             _invlist_invert(*dest);
9185         }
9186
9187         if (dest == &u) {
9188             invlist_replace_list_destroys_src(*output, u);
9189             SvREFCNT_dec_NN(u);
9190         }
9191
9192         return;
9193     }
9194
9195     /* Here both lists exist and are non-empty */
9196     array_a = invlist_array(a);
9197     array_b = invlist_array(b);
9198
9199     /* If are to take the union of 'a' with the complement of b, set it
9200      * up so are looking at b's complement. */
9201     if (complement_b) {
9202
9203         /* To complement, we invert: if the first element is 0, remove it.  To
9204          * do this, we just pretend the array starts one later */
9205         if (array_b[0] == 0) {
9206             array_b++;
9207             len_b--;
9208         }
9209         else {
9210
9211             /* But if the first element is not zero, we pretend the list starts
9212              * at the 0 that is always stored immediately before the array. */
9213             array_b--;
9214             len_b++;
9215         }
9216     }
9217
9218     /* Size the union for the worst case: that the sets are completely
9219      * disjoint */
9220     u = _new_invlist(len_a + len_b);
9221
9222     /* Will contain U+0000 if either component does */
9223     array_u = _invlist_array_init(u, (    len_a > 0 && array_a[0] == 0)
9224                                       || (len_b > 0 && array_b[0] == 0));
9225
9226     /* Go through each input list item by item, stopping when have exhausted
9227      * one of them */
9228     while (i_a < len_a && i_b < len_b) {
9229         UV cp;      /* The element to potentially add to the union's array */
9230         bool cp_in_set;   /* is it in the the input list's set or not */
9231
9232         /* We need to take one or the other of the two inputs for the union.
9233          * Since we are merging two sorted lists, we take the smaller of the
9234          * next items.  In case of a tie, we take first the one that is in its
9235          * set.  If we first took the one not in its set, it would decrement
9236          * the count, possibly to 0 which would cause it to be output as ending
9237          * the range, and the next time through we would take the same number,
9238          * and output it again as beginning the next range.  By doing it the
9239          * opposite way, there is no possibility that the count will be
9240          * momentarily decremented to 0, and thus the two adjoining ranges will
9241          * be seamlessly merged.  (In a tie and both are in the set or both not
9242          * in the set, it doesn't matter which we take first.) */
9243         if (       array_a[i_a] < array_b[i_b]
9244             || (   array_a[i_a] == array_b[i_b]
9245                 && ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
9246         {
9247             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
9248             cp = array_a[i_a++];
9249         }
9250         else {
9251             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
9252             cp = array_b[i_b++];
9253         }
9254
9255         /* Here, have chosen which of the two inputs to look at.  Only output
9256          * if the running count changes to/from 0, which marks the
9257          * beginning/end of a range that's in the set */
9258         if (cp_in_set) {
9259             if (count == 0) {
9260                 array_u[i_u++] = cp;
9261             }
9262             count++;
9263         }
9264         else {
9265             count--;
9266             if (count == 0) {
9267                 array_u[i_u++] = cp;
9268             }
9269         }
9270     }
9271
9272
9273     /* The loop above increments the index into exactly one of the input lists
9274      * each iteration, and ends when either index gets to its list end.  That
9275      * means the other index is lower than its end, and so something is
9276      * remaining in that one.  We decrement 'count', as explained below, if
9277      * that list is in its set.  (i_a and i_b each currently index the element
9278      * beyond the one we care about.) */
9279     if (   (i_a != len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
9280         || (i_b != len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
9281     {
9282         count--;
9283     }
9284
9285     /* Above we decremented 'count' if the list that had unexamined elements in
9286      * it was in its set.  This has made it so that 'count' being non-zero
9287      * means there isn't anything left to output; and 'count' equal to 0 means
9288      * that what is left to output is precisely that which is left in the
9289      * non-exhausted input list.
9290      *
9291      * To see why, note first that the exhausted input obviously has nothing
9292      * left to add to the union.  If it was in its set at its end, that means
9293      * the set extends from here to the platform's infinity, and hence so does
9294      * the union and the non-exhausted set is irrelevant.  The exhausted set
9295      * also contributed 1 to 'count'.  If 'count' was 2, it got decremented to
9296      * 1, but if it was 1, the non-exhausted set wasn't in its set, and so
9297      * 'count' remains at 1.  This is consistent with the decremented 'count'
9298      * != 0 meaning there's nothing left to add to the union.
9299      *
9300      * But if the exhausted input wasn't in its set, it contributed 0 to
9301      * 'count', and the rest of the union will be whatever the other input is.
9302      * If 'count' was 0, neither list was in its set, and 'count' remains 0;
9303      * otherwise it gets decremented to 0.  This is consistent with 'count'
9304      * == 0 meaning the remainder of the union is whatever is left in the
9305      * non-exhausted list. */
9306     if (count != 0) {
9307         len_u = i_u;
9308     }
9309     else {
9310         IV copy_count = len_a - i_a;
9311         if (copy_count > 0) {   /* The non-exhausted input is 'a' */
9312             Copy(array_a + i_a, array_u + i_u, copy_count, UV);
9313         }
9314         else { /* The non-exhausted input is b */
9315             copy_count = len_b - i_b;
9316             Copy(array_b + i_b, array_u + i_u, copy_count, UV);
9317         }
9318         len_u = i_u + copy_count;
9319     }
9320
9321     /* Set the result to the final length, which can change the pointer to
9322      * array_u, so re-find it.  (Note that it is unlikely that this will
9323      * change, as we are shrinking the space, not enlarging it) */
9324     if (len_u != _invlist_len(u)) {
9325         invlist_set_len(u, len_u, *get_invlist_offset_addr(u));
9326         invlist_trim(u);
9327         array_u = invlist_array(u);
9328     }
9329
9330     if (*output == NULL) {  /* Simply return the new inversion list */
9331         *output = u;
9332     }
9333     else {
9334         /* Otherwise, overwrite the inversion list that was in '*output'.  We
9335          * could instead free '*output', and then set it to 'u', but experience
9336          * has shown [perl #127392] that if the input is a mortal, we can get a
9337          * huge build-up of these during regex compilation before they get
9338          * freed. */
9339         invlist_replace_list_destroys_src(*output, u);
9340         SvREFCNT_dec_NN(u);
9341     }
9342
9343     return;
9344 }
9345
9346 void
9347 Perl__invlist_intersection_maybe_complement_2nd(pTHX_ SV* const a, SV* const b,
9348                                                const bool complement_b, SV** i)
9349 {
9350     /* Take the intersection of two inversion lists and point '*i' to it.  On
9351      * input, '*i' MUST POINT TO NULL OR TO AN SV* INVERSION LIST (possibly
9352      * even 'a' or 'b').  If to an inversion list, the contents of the original
9353      * list will be replaced by the intersection.  The first list, 'a', may be
9354      * NULL, in which case '*i' will be an empty list.  If 'complement_b' is
9355      * TRUE, the result will be the intersection of 'a' and the complement (or
9356      * inversion) of 'b' instead of 'b' directly.
9357      *
9358      * The basis for this comes from "Unicode Demystified" Chapter 13 by
9359      * Richard Gillam, published by Addison-Wesley, and explained at some
9360      * length there.  The preface says to incorporate its examples into your
9361      * code at your own risk.  In fact, it had bugs
9362      *
9363      * The algorithm is like a merge sort, and is essentially the same as the
9364      * union above
9365      */
9366
9367     const UV* array_a;          /* a's array */
9368     const UV* array_b;
9369     UV len_a;   /* length of a's array */
9370     UV len_b;
9371
9372     SV* r;                   /* the resulting intersection */
9373     UV* array_r;
9374     UV len_r = 0;
9375
9376     UV i_a = 0;             /* current index into a's array */
9377     UV i_b = 0;
9378     UV i_r = 0;
9379
9380     /* running count of how many of the two inputs are postitioned at ranges
9381      * that are in their sets.  As explained in the algorithm source book,
9382      * items are stopped accumulating and are output when the count changes
9383      * to/from 2.  The count is incremented when we start a range that's in an
9384      * input's set, and decremented when we start a range that's not in a set.
9385      * Only when it is 2 are we in the intersection. */
9386     UV count = 0;
9387
9388     PERL_ARGS_ASSERT__INVLIST_INTERSECTION_MAYBE_COMPLEMENT_2ND;
9389     assert(a != b);
9390     assert(*i == NULL || SvTYPE(*i) == SVt_INVLIST);
9391
9392     /* Special case if either one is empty */
9393     len_a = (a == NULL) ? 0 : _invlist_len(a);
9394     if ((len_a == 0) || ((len_b = _invlist_len(b)) == 0)) {
9395         if (len_a != 0 && complement_b) {
9396
9397             /* Here, 'a' is not empty, therefore from the enclosing 'if', 'b'
9398              * must be empty.  Here, also we are using 'b's complement, which
9399              * hence must be every possible code point.  Thus the intersection
9400              * is simply 'a'. */
9401
9402             if (*i == a) {  /* No-op */
9403                 return;
9404             }
9405
9406             if (*i == NULL) {
9407                 *i = invlist_clone(a);
9408                 return;
9409             }
9410
9411             r = invlist_clone(a);
9412             invlist_replace_list_destroys_src(*i, r);
9413             SvREFCNT_dec_NN(r);
9414             return;
9415         }
9416
9417         /* Here, 'a' or 'b' is empty and not using the complement of 'b'.  The
9418          * intersection must be empty */
9419         if (*i == NULL) {
9420             *i = _new_invlist(0);
9421             return;
9422         }
9423
9424         invlist_clear(*i);
9425         return;
9426     }
9427
9428     /* Here both lists exist and are non-empty */
9429     array_a = invlist_array(a);
9430     array_b = invlist_array(b);
9431
9432     /* If are to take the intersection of 'a' with the complement of b, set it
9433      * up so are looking at b's complement. */
9434     if (complement_b) {
9435
9436         /* To complement, we invert: if the first element is 0, remove it.  To
9437          * do this, we just pretend the array starts one later */
9438         if (array_b[0] == 0) {
9439             array_b++;
9440             len_b--;
9441         }
9442         else {
9443
9444             /* But if the first element is not zero, we pretend the list starts
9445              * at the 0 that is always stored immediately before the array. */
9446             array_b--;
9447             len_b++;
9448         }
9449     }
9450
9451     /* Size the intersection for the worst case: that the intersection ends up
9452      * fragmenting everything to be completely disjoint */
9453     r= _new_invlist(len_a + len_b);
9454
9455     /* Will contain U+0000 iff both components do */
9456     array_r = _invlist_array_init(r,    len_a > 0 && array_a[0] == 0
9457                                      && len_b > 0 && array_b[0] == 0);
9458
9459     /* Go through each list item by item, stopping when have exhausted one of
9460      * them */
9461     while (i_a < len_a && i_b < len_b) {
9462         UV cp;      /* The element to potentially add to the intersection's
9463                        array */
9464         bool cp_in_set; /* Is it in the input list's set or not */
9465
9466         /* We need to take one or the other of the two inputs for the
9467          * intersection.  Since we are merging two sorted lists, we take the
9468          * smaller of the next items.  In case of a tie, we take first the one
9469          * that is not in its set (a difference from the union algorithm).  If
9470          * we first took the one in its set, it would increment the count,
9471          * possibly to 2 which would cause it to be output as starting a range
9472          * in the intersection, and the next time through we would take that
9473          * same number, and output it again as ending the set.  By doing the
9474          * opposite of this, there is no possibility that the count will be
9475          * momentarily incremented to 2.  (In a tie and both are in the set or
9476          * both not in the set, it doesn't matter which we take first.) */
9477         if (       array_a[i_a] < array_b[i_b]
9478             || (   array_a[i_a] == array_b[i_b]
9479                 && ! ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
9480         {
9481             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
9482             cp = array_a[i_a++];
9483         }
9484         else {
9485             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
9486             cp= array_b[i_b++];
9487         }
9488
9489         /* Here, have chosen which of the two inputs to look at.  Only output
9490          * if the running count changes to/from 2, which marks the
9491          * beginning/end of a range that's in the intersection */
9492         if (cp_in_set) {
9493             count++;
9494             if (count == 2) {
9495                 array_r[i_r++] = cp;
9496             }
9497         }
9498         else {
9499             if (count == 2) {
9500                 array_r[i_r++] = cp;
9501             }
9502             count--;
9503         }
9504
9505     }
9506
9507     /* The loop above increments the index into exactly one of the input lists
9508      * each iteration, and ends when either index gets to its list end.  That
9509      * means the other index is lower than its end, and so something is
9510      * remaining in that one.  We increment 'count', as explained below, if the
9511      * exhausted list was in its set.  (i_a and i_b each currently index the
9512      * element beyond the one we care about.) */
9513     if (   (i_a == len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
9514         || (i_b == len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
9515     {
9516         count++;
9517     }
9518
9519     /* Above we incremented 'count' if the exhausted list was in its set.  This
9520      * has made it so that 'count' being below 2 means there is nothing left to
9521      * output; otheriwse what's left to add to the intersection is precisely
9522      * that which is left in the non-exhausted input list.
9523      *
9524      * To see why, note first that the exhausted input obviously has nothing
9525      * left to affect the intersection.  If it was in its set at its end, that
9526      * means the set extends from here to the platform's infinity, and hence
9527      * anything in the non-exhausted's list will be in the intersection, and
9528      * anything not in it won't be.  Hence, the rest of the intersection is
9529      * precisely what's in the non-exhausted list  The exhausted set also
9530      * contributed 1 to 'count', meaning 'count' was at least 1.  Incrementing
9531      * it means 'count' is now at least 2.  This is consistent with the
9532      * incremented 'count' being >= 2 means to add the non-exhausted list to
9533      * the intersection.
9534      *
9535      * But if the exhausted input wasn't in its set, it contributed 0 to
9536      * 'count', and the intersection can't include anything further; the
9537      * non-exhausted set is irrelevant.  'count' was at most 1, and doesn't get
9538      * incremented.  This is consistent with 'count' being < 2 meaning nothing
9539      * further to add to the intersection. */
9540     if (count < 2) { /* Nothing left to put in the intersection. */
9541         len_r = i_r;
9542     }
9543     else { /* copy the non-exhausted list, unchanged. */
9544         IV copy_count = len_a - i_a;
9545         if (copy_count > 0) {   /* a is the one with stuff left */
9546             Copy(array_a + i_a, array_r + i_r, copy_count, UV);
9547         }
9548         else {  /* b is the one with stuff left */
9549             copy_count = len_b - i_b;
9550             Copy(array_b + i_b, array_r + i_r, copy_count, UV);
9551         }
9552         len_r = i_r + copy_count;
9553     }
9554
9555     /* Set the result to the final length, which can change the pointer to
9556      * array_r, so re-find it.  (Note that it is unlikely that this will
9557      * change, as we are shrinking the space, not enlarging it) */
9558     if (len_r != _invlist_len(r)) {
9559         invlist_set_len(r, len_r, *get_invlist_offset_addr(r));
9560         invlist_trim(r);
9561         array_r = invlist_array(r);
9562     }
9563
9564     if (*i == NULL) { /* Simply return the calculated intersection */
9565         *i = r;
9566     }
9567     else { /* Otherwise, replace the existing inversion list in '*i'.  We could
9568               instead free '*i', and then set it to 'r', but experience has
9569               shown [perl #127392] that if the input is a mortal, we can get a
9570               huge build-up of these during regex compilation before they get
9571               freed. */
9572         if (len_r) {
9573             invlist_replace_list_destroys_src(*i, r);
9574         }
9575         else {
9576             invlist_clear(*i);
9577         }
9578         SvREFCNT_dec_NN(r);
9579     }
9580
9581     return;
9582 }
9583
9584 SV*
9585 Perl__add_range_to_invlist(pTHX_ SV* invlist, UV start, UV end)
9586 {
9587     /* Add the range from 'start' to 'end' inclusive to the inversion list's
9588      * set.  A pointer to the inversion list is returned.  This may actually be
9589      * a new list, in which case the passed in one has been destroyed.  The
9590      * passed-in inversion list can be NULL, in which case a new one is created
9591      * with just the one range in it.  The new list is not necessarily
9592      * NUL-terminated.  Space is not freed if the inversion list shrinks as a
9593      * result of this function.  The gain would not be large, and in many
9594      * cases, this is called multiple times on a single inversion list, so
9595      * anything freed may almost immediately be needed again.
9596      *
9597      * This used to mostly call the 'union' routine, but that is much more
9598      * heavyweight than really needed for a single range addition */
9599
9600     UV* array;              /* The array implementing the inversion list */
9601     UV len;                 /* How many elements in 'array' */
9602     SSize_t i_s;            /* index into the invlist array where 'start'
9603                                should go */
9604     SSize_t i_e = 0;        /* And the index where 'end' should go */
9605     UV cur_highest;         /* The highest code point in the inversion list
9606                                upon entry to this function */
9607
9608     /* This range becomes the whole inversion list if none already existed */
9609     if (invlist == NULL) {
9610         invlist = _new_invlist(2);
9611         _append_range_to_invlist(invlist, start, end);
9612         return invlist;
9613     }
9614
9615     /* Likewise, if the inversion list is currently empty */
9616     len = _invlist_len(invlist);
9617     if (len == 0) {
9618         _append_range_to_invlist(invlist, start, end);
9619         return invlist;
9620     }
9621
9622     /* Starting here, we have to know the internals of the list */
9623     array = invlist_array(invlist);
9624
9625     /* If the new range ends higher than the current highest ... */
9626     cur_highest = invlist_highest(invlist);
9627     if (end > cur_highest) {
9628
9629         /* If the whole range is higher, we can just append it */
9630         if (start > cur_highest) {
9631             _append_range_to_invlist(invlist, start, end);
9632             return invlist;
9633         }
9634
9635         /* Otherwise, add the portion that is higher ... */
9636         _append_range_to_invlist(invlist, cur_highest + 1, end);
9637
9638         /* ... and continue on below to handle the rest.  As a result of the
9639          * above append, we know that the index of the end of the range is the
9640          * final even numbered one of the array.  Recall that the final element
9641          * always starts a range that extends to infinity.  If that range is in
9642          * the set (meaning the set goes from here to infinity), it will be an
9643          * even index, but if it isn't in the set, it's odd, and the final
9644          * range in the set is one less, which is even. */
9645         if (end == UV_MAX) {
9646             i_e = len;
9647         }
9648         else {
9649             i_e = len - 2;
9650         }
9651     }
9652
9653     /* We have dealt with appending, now see about prepending.  If the new
9654      * range starts lower than the current lowest ... */
9655     if (start < array[0]) {
9656
9657         /* Adding something which has 0 in it is somewhat tricky, and uncommon.
9658          * Let the union code handle it, rather than having to know the
9659          * trickiness in two code places.  */
9660         if (UNLIKELY(start == 0)) {
9661             SV* range_invlist;
9662
9663             range_invlist = _new_invlist(2);
9664             _append_range_to_invlist(range_invlist, start, end);
9665
9666             _invlist_union(invlist, range_invlist, &invlist);
9667
9668             SvREFCNT_dec_NN(range_invlist);
9669
9670             return invlist;
9671         }
9672
9673         /* If the whole new range comes before the first entry, and doesn't
9674          * extend it, we have to insert it as an additional range */
9675         if (end < array[0] - 1) {
9676             i_s = i_e = -1;
9677             goto splice_in_new_range;
9678         }
9679
9680         /* Here the new range adjoins the existing first range, extending it
9681          * downwards. */
9682         array[0] = start;
9683
9684         /* And continue on below to handle the rest.  We know that the index of
9685          * the beginning of the range is the first one of the array */
9686         i_s = 0;
9687     }
9688     else { /* Not prepending any part of the new range to the existing list.
9689             * Find where in the list it should go.  This finds i_s, such that:
9690             *     invlist[i_s] <= start < array[i_s+1]
9691             */
9692         i_s = _invlist_search(invlist, start);
9693     }
9694
9695     /* At this point, any extending before the beginning of the inversion list
9696      * and/or after the end has been done.  This has made it so that, in the
9697      * code below, each endpoint of the new range is either in a range that is
9698      * in the set, or is in a gap between two ranges that are.  This means we
9699      * don't have to worry about exceeding the array bounds.
9700      *
9701      * Find where in the list the new range ends (but we can skip this if we
9702      * have already determined what it is, or if it will be the same as i_s,
9703      * which we already have computed) */
9704     if (i_e == 0) {
9705         i_e = (start == end)
9706               ? i_s
9707               : _invlist_search(invlist, end);
9708     }
9709
9710     /* Here generally invlist[i_e] <= end < array[i_e+1].  But if invlist[i_e]
9711      * is a range that goes to infinity there is no element at invlist[i_e+1],
9712      * so only the first relation holds. */
9713
9714     if ( ! ELEMENT_RANGE_MATCHES_INVLIST(i_s)) {
9715
9716         /* Here, the ranges on either side of the beginning of the new range
9717          * are in the set, and this range starts in the gap between them.
9718          *
9719          * The new range extends the range above it downwards if the new range
9720          * ends at or above that range's start */
9721         const bool extends_the_range_above = (   end == UV_MAX
9722                                               || end + 1 >= array[i_s+1]);
9723
9724         /* The new range extends the range below it upwards if it begins just
9725          * after where that range ends */
9726         if (start == array[i_s]) {
9727
9728             /* If the new range fills the entire gap between the other ranges,
9729              * they will get merged together.  Other ranges may also get
9730              * merged, depending on how many of them the new range spans.  In
9731              * the general case, we do the merge later, just once, after we
9732              * figure out how many to merge.  But in the case where the new
9733              * range exactly spans just this one gap (possibly extending into
9734              * the one above), we do the merge here, and an early exit.  This
9735              * is done here to avoid having to special case later. */
9736             if (i_e - i_s <= 1) {
9737
9738                 /* If i_e - i_s == 1, it means that the new range terminates
9739                  * within the range above, and hence 'extends_the_range_above'
9740                  * must be true.  (If the range above it extends to infinity,
9741                  * 'i_s+2' will be above the array's limit, but 'len-i_s-2'
9742                  * will be 0, so no harm done.) */
9743                 if (extends_the_range_above) {
9744                     Move(array + i_s + 2, array + i_s, len - i_s - 2, UV);
9745                     invlist_set_len(invlist,
9746                                     len - 2,
9747                                     *(get_invlist_offset_addr(invlist)));
9748                     return invlist;
9749                 }
9750
9751                 /* Here, i_e must == i_s.  We keep them in sync, as they apply
9752                  * to the same range, and below we are about to decrement i_s
9753                  * */
9754                 i_e--;
9755             }
9756
9757             /* Here, the new range is adjacent to the one below.  (It may also
9758              * span beyond the range above, but that will get resolved later.)
9759              * Extend the range below to include this one. */
9760             array[i_s] = (end == UV_MAX) ? UV_MAX : end + 1;
9761             i_s--;
9762             start = array[i_s];
9763         }
9764         else if (extends_the_range_above) {
9765
9766             /* Here the new range only extends the range above it, but not the
9767              * one below.  It merges with the one above.  Again, we keep i_e
9768              * and i_s in sync if they point to the same range */
9769             if (i_e == i_s) {
9770                 i_e++;
9771             }
9772             i_s++;
9773             array[i_s] = start;
9774         }
9775     }
9776
9777     /* Here, we've dealt with the new range start extending any adjoining
9778      * existing ranges.
9779      *
9780      * If the new range extends to infinity, it is now the final one,
9781      * regardless of what was there before */
9782     if (UNLIKELY(end == UV_MAX)) {
9783         invlist_set_len(invlist, i_s + 1, *(get_invlist_offset_addr(invlist)));
9784         return invlist;
9785     }
9786
9787     /* If i_e started as == i_s, it has also been dealt with,
9788      * and been updated to the new i_s, which will fail the following if */
9789     if (! ELEMENT_RANGE_MATCHES_INVLIST(i_e)) {
9790
9791         /* Here, the ranges on either side of the end of the new range are in
9792          * the set, and this range ends in the gap between them.
9793          *
9794          * If this range is adjacent to (hence extends) the range above it, it
9795          * becomes part of that range; likewise if it extends the range below,
9796          * it becomes part of that range */
9797         if (end + 1 == array[i_e+1]) {
9798             i_e++;
9799             array[i_e] = start;
9800         }
9801         else if (start <= array[i_e]) {
9802             array[i_e] = end + 1;
9803             i_e--;
9804         }
9805     }
9806
9807     if (i_s == i_e) {
9808
9809         /* If the range fits entirely in an existing range (as possibly already
9810          * extended above), it doesn't add anything new */
9811         if (ELEMENT_RANGE_MATCHES_INVLIST(i_s)) {
9812             return invlist;
9813         }
9814
9815         /* Here, no part of the range is in the list.  Must add it.  It will
9816          * occupy 2 more slots */
9817       splice_in_new_range:
9818
9819         invlist_extend(invlist, len + 2);
9820         array = invlist_array(invlist);
9821         /* Move the rest of the array down two slots. Don't include any
9822          * trailing NUL */
9823         Move(array + i_e + 1, array + i_e + 3, len - i_e - 1, UV);
9824
9825         /* Do the actual splice */
9826         array[i_e+1] = start;
9827         array[i_e+2] = end + 1;
9828         invlist_set_len(invlist, len + 2, *(get_invlist_offset_addr(invlist)));
9829         return invlist;
9830     }
9831
9832     /* Here the new range crossed the boundaries of a pre-existing range.  The
9833      * code above has adjusted things so that both ends are in ranges that are
9834      * in the set.  This means everything in between must also be in the set.
9835      * Just squash things together */
9836     Move(array + i_e + 1, array + i_s + 1, len - i_e - 1, UV);
9837     invlist_set_len(invlist,
9838                     len - i_e + i_s,
9839                     *(get_invlist_offset_addr(invlist)));
9840
9841     return invlist;
9842 }
9843
9844 SV*
9845 Perl__setup_canned_invlist(pTHX_ const STRLEN size, const UV element0,
9846                                  UV** other_elements_ptr)
9847 {
9848     /* Create and return an inversion list whose contents are to be populated
9849      * by the caller.  The caller gives the number of elements (in 'size') and
9850      * the very first element ('element0').  This function will set
9851      * '*other_elements_ptr' to an array of UVs, where the remaining elements
9852      * are to be placed.
9853      *
9854      * Obviously there is some trust involved that the caller will properly
9855      * fill in the other elements of the array.
9856      *
9857      * (The first element needs to be passed in, as the underlying code does
9858      * things differently depending on whether it is zero or non-zero) */
9859
9860     SV* invlist = _new_invlist(size);
9861     bool offset;
9862
9863     PERL_ARGS_ASSERT__SETUP_CANNED_INVLIST;
9864
9865     invlist = add_cp_to_invlist(invlist, element0);
9866     offset = *get_invlist_offset_addr(invlist);
9867
9868     invlist_set_len(invlist, size, offset);
9869     *other_elements_ptr = invlist_array(invlist) + 1;
9870     return invlist;
9871 }
9872
9873 #endif
9874
9875 PERL_STATIC_INLINE SV*
9876 S_add_cp_to_invlist(pTHX_ SV* invlist, const UV cp) {
9877     return _add_range_to_invlist(invlist, cp, cp);
9878 }
9879
9880 #ifndef PERL_IN_XSUB_RE
9881 void
9882 Perl__invlist_invert(pTHX_ SV* const invlist)
9883 {
9884     /* Complement the input inversion list.  This adds a 0 if the list didn't
9885      * have a zero; removes it otherwise.  As described above, the data
9886      * structure is set up so that this is very efficient */
9887
9888     PERL_ARGS_ASSERT__INVLIST_INVERT;
9889
9890     assert(! invlist_is_iterating(invlist));
9891
9892     /* The inverse of matching nothing is matching everything */
9893     if (_invlist_len(invlist) == 0) {
9894         _append_range_to_invlist(invlist, 0, UV_MAX);
9895         return;
9896     }
9897
9898     *get_invlist_offset_addr(invlist) = ! *get_invlist_offset_addr(invlist);
9899 }
9900
9901 #endif
9902
9903 PERL_STATIC_INLINE SV*
9904 S_invlist_clone(pTHX_ SV* const invlist)
9905 {
9906
9907     /* Return a new inversion list that is a copy of the input one, which is
9908      * unchanged.  The new list will not be mortal even if the old one was. */
9909
9910     /* Need to allocate extra space to accommodate Perl's addition of a
9911      * trailing NUL to SvPV's, since it thinks they are always strings */
9912     SV* new_invlist = _new_invlist(_invlist_len(invlist) + 1);
9913     STRLEN physical_length = SvCUR(invlist);
9914     bool offset = *(get_invlist_offset_addr(invlist));
9915
9916     PERL_ARGS_ASSERT_INVLIST_CLONE;
9917
9918     *(get_invlist_offset_addr(new_invlist)) = offset;
9919     invlist_set_len(new_invlist, _invlist_len(invlist), offset);
9920     Copy(SvPVX(invlist), SvPVX(new_invlist), physical_length, char);
9921
9922     return new_invlist;
9923 }
9924
9925 PERL_STATIC_INLINE STRLEN*
9926 S_get_invlist_iter_addr(SV* invlist)
9927 {
9928     /* Return the address of the UV that contains the current iteration
9929      * position */
9930
9931     PERL_ARGS_ASSERT_GET_INVLIST_ITER_ADDR;
9932
9933     assert(SvTYPE(invlist) == SVt_INVLIST);
9934
9935     return &(((XINVLIST*) SvANY(invlist))->iterator);
9936 }
9937
9938 PERL_STATIC_INLINE void
9939 S_invlist_iterinit(SV* invlist) /* Initialize iterator for invlist */
9940 {
9941     PERL_ARGS_ASSERT_INVLIST_ITERINIT;
9942
9943     *get_invlist_iter_addr(invlist) = 0;
9944 }
9945
9946 PERL_STATIC_INLINE void
9947 S_invlist_iterfinish(SV* invlist)
9948 {
9949     /* Terminate iterator for invlist.  This is to catch development errors.
9950      * Any iteration that is interrupted before completed should call this
9951      * function.  Functions that add code points anywhere else but to the end
9952      * of an inversion list assert that they are not in the middle of an
9953      * iteration.  If they were, the addition would make the iteration
9954      * problematical: if the iteration hadn't reached the place where things
9955      * were being added, it would be ok */
9956
9957     PERL_ARGS_ASSERT_INVLIST_ITERFINISH;
9958
9959     *get_invlist_iter_addr(invlist) = (STRLEN) UV_MAX;
9960 }
9961
9962 STATIC bool
9963 S_invlist_iternext(SV* invlist, UV* start, UV* end)
9964 {
9965     /* An C<invlist_iterinit> call on <invlist> must be used to set this up.
9966      * This call sets in <*start> and <*end>, the next range in <invlist>.
9967      * Returns <TRUE> if successful and the next call will return the next
9968      * range; <FALSE> if was already at the end of the list.  If the latter,
9969      * <*start> and <*end> are unchanged, and the next call to this function
9970      * will start over at the beginning of the list */
9971
9972     STRLEN* pos = get_invlist_iter_addr(invlist);
9973     UV len = _invlist_len(invlist);
9974     UV *array;
9975
9976     PERL_ARGS_ASSERT_INVLIST_ITERNEXT;
9977
9978     if (*pos >= len) {
9979         *pos = (STRLEN) UV_MAX; /* Force iterinit() to be required next time */
9980         return FALSE;
9981     }
9982
9983     array = invlist_array(invlist);
9984
9985     *start = array[(*pos)++];
9986
9987     if (*pos >= len) {
9988         *end = UV_MAX;
9989     }
9990     else {
9991         *end = array[(*pos)++] - 1;
9992     }
9993
9994     return TRUE;
9995 }
9996
9997 PERL_STATIC_INLINE UV
9998 S_invlist_highest(SV* const invlist)
9999 {
10000     /* Returns the highest code point that matches an inversion list.  This API
10001      * has an ambiguity, as it returns 0 under either the highest is actually
10002      * 0, or if the list is empty.  If this distinction matters to you, check
10003      * for emptiness before calling this function */
10004
10005     UV len = _invlist_len(invlist);
10006     UV *array;
10007
10008     PERL_ARGS_ASSERT_INVLIST_HIGHEST;
10009
10010     if (len == 0) {
10011         return 0;
10012     }
10013
10014     array = invlist_array(invlist);
10015
10016     /* The last element in the array in the inversion list always starts a
10017      * range that goes to infinity.  That range may be for code points that are
10018      * matched in the inversion list, or it may be for ones that aren't
10019      * matched.  In the latter case, the highest code point in the set is one
10020      * less than the beginning of this range; otherwise it is the final element
10021      * of this range: infinity */
10022     return (ELEMENT_RANGE_MATCHES_INVLIST(len - 1))
10023            ? UV_MAX
10024            : array[len - 1] - 1;
10025 }
10026
10027 STATIC SV *
10028 S_invlist_contents(pTHX_ SV* const invlist, const bool traditional_style)
10029 {
10030     /* Get the contents of an inversion list into a string SV so that they can
10031      * be printed out.  If 'traditional_style' is TRUE, it uses the format
10032      * traditionally done for debug tracing; otherwise it uses a format
10033      * suitable for just copying to the output, with blanks between ranges and
10034      * a dash between range components */
10035
10036     UV start, end;
10037     SV* output;
10038     const char intra_range_delimiter = (traditional_style ? '\t' : '-');
10039     const char inter_range_delimiter = (traditional_style ? '\n' : ' ');
10040
10041     if (traditional_style) {
10042         output = newSVpvs("\n");
10043     }
10044     else {
10045         output = newSVpvs("");
10046     }
10047
10048     PERL_ARGS_ASSERT_INVLIST_CONTENTS;
10049
10050     assert(! invlist_is_iterating(invlist));
10051
10052     invlist_iterinit(invlist);
10053     while (invlist_iternext(invlist, &start, &end)) {
10054         if (end == UV_MAX) {
10055             Perl_sv_catpvf(aTHX_ output, "%04" UVXf "%cINFINITY%c",
10056                                           start, intra_range_delimiter,
10057                                                  inter_range_delimiter);
10058         }
10059         else if (end != start) {
10060             Perl_sv_catpvf(aTHX_ output, "%04" UVXf "%c%04" UVXf "%c",
10061                                           start,
10062                                                    intra_range_delimiter,
10063                                                   end, inter_range_delimiter);
10064         }
10065         else {
10066             Perl_sv_catpvf(aTHX_ output, "%04" UVXf "%c",
10067                                           start, inter_range_delimiter);
10068         }
10069     }
10070
10071     if (SvCUR(output) && ! traditional_style) {/* Get rid of trailing blank */
10072         SvCUR_set(output, SvCUR(output) - 1);
10073     }
10074
10075     return output;
10076 }
10077
10078 #ifndef PERL_IN_XSUB_RE
10079 void
10080 Perl__invlist_dump(pTHX_ PerlIO *file, I32 level,
10081                          const char * const indent, SV* const invlist)
10082 {
10083     /* Designed to be called only by do_sv_dump().  Dumps out the ranges of the
10084      * inversion list 'invlist' to 'file' at 'level'  Each line is prefixed by
10085      * the string 'indent'.  The output looks like this:
10086          [0] 0x000A .. 0x000D
10087          [2] 0x0085
10088          [4] 0x2028 .. 0x2029
10089          [6] 0x3104 .. INFINITY
10090      * This means that the first range of code points matched by the list are
10091      * 0xA through 0xD; the second range contains only the single code point
10092      * 0x85, etc.  An inversion list is an array of UVs.  Two array elements
10093      * are used to define each range (except if the final range extends to
10094      * infinity, only a single element is needed).  The array index of the
10095      * first element for the corresponding range is given in brackets. */
10096
10097     UV start, end;
10098     STRLEN count = 0;
10099
10100     PERL_ARGS_ASSERT__INVLIST_DUMP;
10101
10102     if (invlist_is_iterating(invlist)) {
10103         Perl_dump_indent(aTHX_ level, file,
10104              "%sCan't dump inversion list because is in middle of iterating\n",
10105              indent);
10106         return;
10107     }
10108
10109     invlist_iterinit(invlist);
10110     while (invlist_iternext(invlist, &start, &end)) {
10111         if (end == UV_MAX) {
10112             Perl_dump_indent(aTHX_ level, file,
10113                                        "%s[%" UVuf "] 0x%04" UVXf " .. INFINITY\n",
10114                                    indent, (UV)count, start);
10115         }
10116         else if (end != start) {
10117             Perl_dump_indent(aTHX_ level, file,
10118                                     "%s[%" UVuf "] 0x%04" UVXf " .. 0x%04" UVXf "\n",
10119                                 indent, (UV)count, start,         end);
10120         }
10121         else {
10122             Perl_dump_indent(aTHX_ level, file, "%s[%" UVuf "] 0x%04" UVXf "\n",
10123                                             indent, (UV)count, start);
10124         }
10125         count += 2;
10126     }
10127 }
10128
10129 void
10130 Perl__load_PL_utf8_foldclosures (pTHX)
10131 {
10132     assert(! PL_utf8_foldclosures);
10133
10134     /* If the folds haven't been read in, call a fold function
10135      * to force that */
10136     if (! PL_utf8_tofold) {
10137         U8 dummy[UTF8_MAXBYTES_CASE+1];
10138         const U8 hyphen[] = HYPHEN_UTF8;
10139
10140         /* This string is just a short named one above \xff */
10141         toFOLD_utf8_safe(hyphen, hyphen + sizeof(hyphen) - 1, dummy, NULL);
10142         assert(PL_utf8_tofold); /* Verify that worked */
10143     }
10144     PL_utf8_foldclosures = _swash_inversion_hash(PL_utf8_tofold);
10145 }
10146 #endif
10147
10148 #if defined(PERL_ARGS_ASSERT__INVLISTEQ) && !defined(PERL_IN_XSUB_RE)
10149 bool
10150 Perl__invlistEQ(pTHX_ SV* const a, SV* const b, const bool complement_b)
10151 {
10152     /* Return a boolean as to if the two passed in inversion lists are
10153      * identical.  The final argument, if TRUE, says to take the complement of
10154      * the second inversion list before doing the comparison */
10155
10156     const UV* array_a = invlist_array(a);
10157     const UV* array_b = invlist_array(b);
10158     UV len_a = _invlist_len(a);
10159     UV len_b = _invlist_len(b);
10160
10161     PERL_ARGS_ASSERT__INVLISTEQ;
10162
10163     /* If are to compare 'a' with the complement of b, set it
10164      * up so are looking at b's complement. */
10165     if (complement_b) {
10166
10167         /* The complement of nothing is everything, so <a> would have to have
10168          * just one element, starting at zero (ending at infinity) */
10169         if (len_b == 0) {
10170             return (len_a == 1 && array_a[0] == 0);
10171         }
10172         else if (array_b[0] == 0) {
10173
10174             /* Otherwise, to complement, we invert.  Here, the first element is
10175              * 0, just remove it.  To do this, we just pretend the array starts
10176              * one later */
10177
10178             array_b++;
10179             len_b--;
10180         }
10181         else {
10182
10183             /* But if the first element is not zero, we pretend the list starts
10184              * at the 0 that is always stored immediately before the array. */
10185             array_b--;
10186             len_b++;
10187         }
10188     }
10189
10190     return    len_a == len_b
10191            && memEQ(array_a, array_b, len_a * sizeof(array_a[0]));
10192
10193 }
10194 #endif
10195
10196 /*
10197  * As best we can, determine the characters that can match the start of
10198  * the given EXACTF-ish node.
10199  *
10200  * Returns the invlist as a new SV*; it is the caller's responsibility to
10201  * call SvREFCNT_dec() when done with it.
10202  */
10203 STATIC SV*
10204 S__make_exactf_invlist(pTHX_ RExC_state_t *pRExC_state, regnode *node)
10205 {
10206     const U8 * s = (U8*)STRING(node);
10207     SSize_t bytelen = STR_LEN(node);
10208     UV uc;
10209     /* Start out big enough for 2 separate code points */
10210     SV* invlist = _new_invlist(4);
10211
10212     PERL_ARGS_ASSERT__MAKE_EXACTF_INVLIST;
10213
10214     if (! UTF) {
10215         uc = *s;
10216
10217         /* We punt and assume can match anything if the node begins
10218          * with a multi-character fold.  Things are complicated.  For
10219          * example, /ffi/i could match any of:
10220          *  "\N{LATIN SMALL LIGATURE FFI}"
10221          *  "\N{LATIN SMALL LIGATURE FF}I"
10222          *  "F\N{LATIN SMALL LIGATURE FI}"
10223          *  plus several other things; and making sure we have all the
10224          *  possibilities is hard. */
10225         if (is_MULTI_CHAR_FOLD_latin1_safe(s, s + bytelen)) {
10226             invlist = _add_range_to_invlist(invlist, 0, UV_MAX);
10227         }
10228         else {
10229             /* Any Latin1 range character can potentially match any
10230              * other depending on the locale */
10231             if (OP(node) == EXACTFL) {
10232                 _invlist_union(invlist, PL_Latin1, &invlist);
10233             }
10234             else {
10235                 /* But otherwise, it matches at least itself.  We can
10236                  * quickly tell if it has a distinct fold, and if so,
10237                  * it matches that as well */
10238                 invlist = add_cp_to_invlist(invlist, uc);
10239                 if (IS_IN_SOME_FOLD_L1(uc))
10240                     invlist = add_cp_to_invlist(invlist, PL_fold_latin1[uc]);
10241             }
10242
10243             /* Some characters match above-Latin1 ones under /i.  This
10244              * is true of EXACTFL ones when the locale is UTF-8 */
10245             if (HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(uc)
10246                 && (! isASCII(uc) || (OP(node) != EXACTFA
10247                                     && OP(node) != EXACTFA_NO_TRIE)))
10248             {
10249                 add_above_Latin1_folds(pRExC_state, (U8) uc, &invlist);
10250             }
10251         }
10252     }
10253     else {  /* Pattern is UTF-8 */
10254         U8 folded[UTF8_MAX_FOLD_CHAR_EXPAND * UTF8_MAXBYTES_CASE + 1] = { '\0' };
10255         STRLEN foldlen = UTF8SKIP(s);
10256         const U8* e = s + bytelen;
10257         SV** listp;
10258
10259         uc = utf8_to_uvchr_buf(s, s + bytelen, NULL);
10260
10261         /* The only code points that aren't folded in a UTF EXACTFish
10262          * node are are the problematic ones in EXACTFL nodes */
10263         if (OP(node) == EXACTFL && is_PROBLEMATIC_LOCALE_FOLDEDS_START_cp(uc)) {
10264             /* We need to check for the possibility that this EXACTFL
10265              * node begins with a multi-char fold.  Therefore we fold
10266              * the first few characters of it so that we can make that
10267              * check */
10268             U8 *d = folded;
10269             int i;
10270
10271             for (i = 0; i < UTF8_MAX_FOLD_CHAR_EXPAND && s < e; i++) {
10272                 if (isASCII(*s)) {
10273                     *(d++) = (U8) toFOLD(*s);
10274                     s++;
10275                 }
10276                 else {
10277                     STRLEN len;
10278                     toFOLD_utf8_safe(s, e, d, &len);
10279                     d += len;
10280                     s += UTF8SKIP(s);
10281                 }
10282             }
10283
10284             /* And set up so the code below that looks in this folded
10285              * buffer instead of the node's string */
10286             e = d;
10287             foldlen = UTF8SKIP(folded);
10288             s = folded;
10289         }
10290
10291         /* When we reach here 's' points to the fold of the first
10292          * character(s) of the node; and 'e' points to far enough along
10293          * the folded string to be just past any possible multi-char
10294          * fold. 'foldlen' is the length in bytes of the first
10295          * character in 's'
10296          *
10297          * Unlike the non-UTF-8 case, the macro for determining if a
10298          * string is a multi-char fold requires all the characters to
10299          * already be folded.  This is because of all the complications
10300          * if not.  Note that they are folded anyway, except in EXACTFL
10301          * nodes.  Like the non-UTF case above, we punt if the node
10302          * begins with a multi-char fold  */
10303
10304         if (is_MULTI_CHAR_FOLD_utf8_safe(s, e)) {
10305             invlist = _add_range_to_invlist(invlist, 0, UV_MAX);
10306         }
10307         else {  /* Single char fold */
10308
10309             /* It matches all the things that fold to it, which are
10310              * found in PL_utf8_foldclosures (including itself) */
10311             invlist = add_cp_to_invlist(invlist, uc);
10312             if (! PL_utf8_foldclosures)
10313                 _load_PL_utf8_foldclosures();
10314             if ((listp = hv_fetch(PL_utf8_foldclosures,
10315                                 (char *) s, foldlen, FALSE)))
10316             {
10317                 AV* list = (AV*) *listp;
10318                 IV k;
10319                 for (k = 0; k <= av_tindex_skip_len_mg(list); k++) {
10320                     SV** c_p = av_fetch(list, k, FALSE);
10321                     UV c;
10322                     assert(c_p);
10323
10324                     c = SvUV(*c_p);
10325
10326                     /* /aa doesn't allow folds between ASCII and non- */
10327                     if ((OP(node) == EXACTFA || OP(node) == EXACTFA_NO_TRIE)
10328                         && isASCII(c) != isASCII(uc))
10329                     {
10330                         continue;
10331                     }
10332
10333                     invlist = add_cp_to_invlist(invlist, c);
10334                 }
10335             }
10336         }
10337     }
10338
10339     return invlist;
10340 }
10341
10342 #undef HEADER_LENGTH
10343 #undef TO_INTERNAL_SIZE
10344 #undef FROM_INTERNAL_SIZE
10345 #undef INVLIST_VERSION_ID
10346
10347 /* End of inversion list object */
10348
10349 STATIC void
10350 S_parse_lparen_question_flags(pTHX_ RExC_state_t *pRExC_state)
10351 {
10352     /* This parses the flags that are in either the '(?foo)' or '(?foo:bar)'
10353      * constructs, and updates RExC_flags with them.  On input, RExC_parse
10354      * should point to the first flag; it is updated on output to point to the
10355      * final ')' or ':'.  There needs to be at least one flag, or this will
10356      * abort */
10357
10358     /* for (?g), (?gc), and (?o) warnings; warning
10359        about (?c) will warn about (?g) -- japhy    */
10360
10361 #define WASTED_O  0x01
10362 #define WASTED_G  0x02
10363 #define WASTED_C  0x04
10364 #define WASTED_GC (WASTED_G|WASTED_C)
10365     I32 wastedflags = 0x00;
10366     U32 posflags = 0, negflags = 0;
10367     U32 *flagsp = &posflags;
10368     char has_charset_modifier = '\0';
10369     regex_charset cs;
10370     bool has_use_defaults = FALSE;
10371     const char* const seqstart = RExC_parse - 1; /* Point to the '?' */
10372     int x_mod_count = 0;
10373
10374     PERL_ARGS_ASSERT_PARSE_LPAREN_QUESTION_FLAGS;
10375
10376     /* '^' as an initial flag sets certain defaults */
10377     if (UCHARAT(RExC_parse) == '^') {
10378         RExC_parse++;
10379         has_use_defaults = TRUE;
10380         STD_PMMOD_FLAGS_CLEAR(&RExC_flags);
10381         set_regex_charset(&RExC_flags, (RExC_utf8 || RExC_uni_semantics)
10382                                         ? REGEX_UNICODE_CHARSET
10383                                         : REGEX_DEPENDS_CHARSET);
10384     }
10385
10386     cs = get_regex_charset(RExC_flags);
10387     if (cs == REGEX_DEPENDS_CHARSET
10388         && (RExC_utf8 || RExC_uni_semantics))
10389     {
10390         cs = REGEX_UNICODE_CHARSET;
10391     }
10392
10393     while (RExC_parse < RExC_end) {
10394         /* && strchr("iogcmsx", *RExC_parse) */
10395         /* (?g), (?gc) and (?o) are useless here
10396            and must be globally applied -- japhy */
10397         switch (*RExC_parse) {
10398
10399             /* Code for the imsxn flags */
10400             CASE_STD_PMMOD_FLAGS_PARSE_SET(flagsp, x_mod_count);
10401
10402             case LOCALE_PAT_MOD:
10403                 if (has_charset_modifier) {
10404                     goto excess_modifier;
10405                 }
10406                 else if (flagsp == &negflags) {
10407                     goto neg_modifier;
10408                 }
10409                 cs = REGEX_LOCALE_CHARSET;
10410                 has_charset_modifier = LOCALE_PAT_MOD;
10411                 break;
10412             case UNICODE_PAT_MOD:
10413                 if (has_charset_modifier) {
10414                     goto excess_modifier;
10415                 }
10416                 else if (flagsp == &negflags) {
10417                     goto neg_modifier;
10418                 }
10419                 cs = REGEX_UNICODE_CHARSET;
10420                 has_charset_modifier = UNICODE_PAT_MOD;
10421                 break;
10422             case ASCII_RESTRICT_PAT_MOD:
10423                 if (flagsp == &negflags) {
10424                     goto neg_modifier;
10425                 }
10426                 if (has_charset_modifier) {
10427                     if (cs != REGEX_ASCII_RESTRICTED_CHARSET) {
10428                         goto excess_modifier;
10429                     }
10430                     /* Doubled modifier implies more restricted */
10431                     cs = REGEX_ASCII_MORE_RESTRICTED_CHARSET;
10432                 }
10433                 else {
10434                     cs = REGEX_ASCII_RESTRICTED_CHARSET;
10435                 }
10436                 has_charset_modifier = ASCII_RESTRICT_PAT_MOD;
10437                 break;
10438             case DEPENDS_PAT_MOD:
10439                 if (has_use_defaults) {
10440                     goto fail_modifiers;
10441                 }
10442                 else if (flagsp == &negflags) {
10443                     goto neg_modifier;
10444                 }
10445                 else if (has_charset_modifier) {
10446                     goto excess_modifier;
10447                 }
10448
10449                 /* The dual charset means unicode semantics if the
10450                  * pattern (or target, not known until runtime) are
10451                  * utf8, or something in the pattern indicates unicode
10452                  * semantics */
10453                 cs = (RExC_utf8 || RExC_uni_semantics)
10454                      ? REGEX_UNICODE_CHARSET
10455                      : REGEX_DEPENDS_CHARSET;
10456                 has_charset_modifier = DEPENDS_PAT_MOD;
10457                 break;
10458               excess_modifier:
10459                 RExC_parse++;
10460                 if (has_charset_modifier == ASCII_RESTRICT_PAT_MOD) {
10461                     vFAIL2("Regexp modifier \"%c\" may appear a maximum of twice", ASCII_RESTRICT_PAT_MOD);
10462                 }
10463                 else if (has_charset_modifier == *(RExC_parse - 1)) {
10464                     vFAIL2("Regexp modifier \"%c\" may not appear twice",
10465                                         *(RExC_parse - 1));
10466                 }
10467                 else {
10468                     vFAIL3("Regexp modifiers \"%c\" and \"%c\" are mutually exclusive", has_charset_modifier, *(RExC_parse - 1));
10469                 }
10470                 NOT_REACHED; /*NOTREACHED*/
10471               neg_modifier:
10472                 RExC_parse++;
10473                 vFAIL2("Regexp modifier \"%c\" may not appear after the \"-\"",
10474                                     *(RExC_parse - 1));
10475                 NOT_REACHED; /*NOTREACHED*/
10476             case ONCE_PAT_MOD: /* 'o' */
10477             case GLOBAL_PAT_MOD: /* 'g' */
10478                 if (PASS2 && ckWARN(WARN_REGEXP)) {
10479                     const I32 wflagbit = *RExC_parse == 'o'
10480                                          ? WASTED_O
10481                                          : WASTED_G;
10482                     if (! (wastedflags & wflagbit) ) {
10483                         wastedflags |= wflagbit;
10484                         /* diag_listed_as: Useless (?-%s) - don't use /%s modifier in regex; marked by <-- HERE in m/%s/ */
10485                         vWARN5(
10486                             RExC_parse + 1,
10487                             "Useless (%s%c) - %suse /%c modifier",
10488                             flagsp == &negflags ? "?-" : "?",
10489                             *RExC_parse,
10490                             flagsp == &negflags ? "don't " : "",
10491                             *RExC_parse
10492                         );
10493                     }
10494                 }
10495                 break;
10496
10497             case CONTINUE_PAT_MOD: /* 'c' */
10498                 if (PASS2 && ckWARN(WARN_REGEXP)) {
10499                     if (! (wastedflags & WASTED_C) ) {
10500                         wastedflags |= WASTED_GC;
10501                         /* diag_listed_as: Useless (?-%s) - don't use /%s modifier in regex; marked by <-- HERE in m/%s/ */
10502                         vWARN3(
10503                             RExC_parse + 1,
10504                             "Useless (%sc) - %suse /gc modifier",
10505                             flagsp == &negflags ? "?-" : "?",
10506                             flagsp == &negflags ? "don't " : ""
10507                         );
10508                     }
10509                 }
10510                 break;
10511             case KEEPCOPY_PAT_MOD: /* 'p' */
10512                 if (flagsp == &negflags) {
10513                     if (PASS2)
10514                         ckWARNreg(RExC_parse + 1,"Useless use of (?-p)");
10515                 } else {
10516                     *flagsp |= RXf_PMf_KEEPCOPY;
10517                 }
10518                 break;
10519             case '-':
10520                 /* A flag is a default iff it is following a minus, so
10521                  * if there is a minus, it means will be trying to
10522                  * re-specify a default which is an error */
10523                 if (has_use_defaults || flagsp == &negflags) {
10524                     goto fail_modifiers;
10525                 }
10526                 flagsp = &negflags;
10527                 wastedflags = 0;  /* reset so (?g-c) warns twice */
10528                 x_mod_count = 0;
10529                 break;
10530             case ':':
10531             case ')':
10532
10533                 if ((posflags & (RXf_PMf_EXTENDED|RXf_PMf_EXTENDED_MORE)) == RXf_PMf_EXTENDED) {
10534                     negflags |= RXf_PMf_EXTENDED_MORE;
10535                 }
10536                 RExC_flags |= posflags;
10537
10538                 if (negflags & RXf_PMf_EXTENDED) {
10539                     negflags |= RXf_PMf_EXTENDED_MORE;
10540                 }
10541                 RExC_flags &= ~negflags;
10542                 set_regex_charset(&RExC_flags, cs);
10543
10544                 return;
10545             default:
10546               fail_modifiers:
10547                 RExC_parse += SKIP_IF_CHAR(RExC_parse);
10548                 /* diag_listed_as: Sequence (?%s...) not recognized in regex; marked by <-- HERE in m/%s/ */
10549                 vFAIL2utf8f("Sequence (%" UTF8f "...) not recognized",
10550                       UTF8fARG(UTF, RExC_parse-seqstart, seqstart));
10551                 NOT_REACHED; /*NOTREACHED*/
10552         }
10553
10554         RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
10555     }
10556
10557     vFAIL("Sequence (?... not terminated");
10558 }
10559
10560 /*
10561  - reg - regular expression, i.e. main body or parenthesized thing
10562  *
10563  * Caller must absorb opening parenthesis.
10564  *
10565  * Combining parenthesis handling with the base level of regular expression
10566  * is a trifle forced, but the need to tie the tails of the branches to what
10567  * follows makes it hard to avoid.
10568  */
10569 #define REGTAIL(x,y,z) regtail((x),(y),(z),depth+1)
10570 #ifdef DEBUGGING
10571 #define REGTAIL_STUDY(x,y,z) regtail_study((x),(y),(z),depth+1)
10572 #else
10573 #define REGTAIL_STUDY(x,y,z) regtail((x),(y),(z),depth+1)
10574 #endif
10575
10576 PERL_STATIC_INLINE regnode *
10577 S_handle_named_backref(pTHX_ RExC_state_t *pRExC_state,
10578                              I32 *flagp,
10579                              char * parse_start,
10580                              char ch
10581                       )
10582 {
10583     regnode *ret;
10584     char* name_start = RExC_parse;
10585     U32 num = 0;
10586     SV *sv_dat = reg_scan_name(pRExC_state, SIZE_ONLY
10587                                             ? REG_RSN_RETURN_NULL
10588                                             : REG_RSN_RETURN_DATA);
10589     GET_RE_DEBUG_FLAGS_DECL;
10590
10591     PERL_ARGS_ASSERT_HANDLE_NAMED_BACKREF;
10592
10593     if (RExC_parse == name_start || *RExC_parse != ch) {
10594         /* diag_listed_as: Sequence \%s... not terminated in regex; marked by <-- HERE in m/%s/ */
10595         vFAIL2("Sequence %.3s... not terminated",parse_start);
10596     }
10597
10598     if (!SIZE_ONLY) {
10599         num = add_data( pRExC_state, STR_WITH_LEN("S"));
10600         RExC_rxi->data->data[num]=(void*)sv_dat;
10601         SvREFCNT_inc_simple_void(sv_dat);
10602     }
10603     RExC_sawback = 1;
10604     ret = reganode(pRExC_state,
10605                    ((! FOLD)
10606                      ? NREF
10607                      : (ASCII_FOLD_RESTRICTED)
10608                        ? NREFFA
10609                        : (AT_LEAST_UNI_SEMANTICS)
10610                          ? NREFFU
10611                          : (LOC)
10612                            ? NREFFL
10613                            : NREFF),
10614                     num);
10615     *flagp |= HASWIDTH;
10616
10617     Set_Node_Offset(ret, parse_start+1);
10618     Set_Node_Cur_Length(ret, parse_start);
10619
10620     nextchar(pRExC_state);
10621     return ret;
10622 }
10623
10624 /* Returns NULL, setting *flagp to TRYAGAIN at the end of (?) that only sets
10625    flags. Returns NULL, setting *flagp to RESTART_PASS1 if the sizing scan
10626    needs to be restarted, or'd with NEED_UTF8 if the pattern needs to be
10627    upgraded to UTF-8.  Otherwise would only return NULL if regbranch() returns
10628    NULL, which cannot happen.  */
10629 STATIC regnode *
10630 S_reg(pTHX_ RExC_state_t *pRExC_state, I32 paren, I32 *flagp,U32 depth)
10631     /* paren: Parenthesized? 0=top; 1,2=inside '(': changed to letter.
10632      * 2 is like 1, but indicates that nextchar() has been called to advance
10633      * RExC_parse beyond the '('.  Things like '(?' are indivisible tokens, and
10634      * this flag alerts us to the need to check for that */
10635 {
10636     regnode *ret;               /* Will be the head of the group. */
10637     regnode *br;
10638     regnode *lastbr;
10639     regnode *ender = NULL;
10640     I32 parno = 0;
10641     I32 flags;
10642     U32 oregflags = RExC_flags;
10643     bool have_branch = 0;
10644     bool is_open = 0;
10645     I32 freeze_paren = 0;
10646     I32 after_freeze = 0;
10647     I32 num; /* numeric backreferences */
10648
10649     char * parse_start = RExC_parse; /* MJD */
10650     char * const oregcomp_parse = RExC_parse;
10651
10652     GET_RE_DEBUG_FLAGS_DECL;
10653
10654     PERL_ARGS_ASSERT_REG;
10655     DEBUG_PARSE("reg ");
10656
10657     *flagp = 0;                         /* Tentatively. */
10658
10659     /* Having this true makes it feasible to have a lot fewer tests for the
10660      * parse pointer being in scope.  For example, we can write
10661      *      while(isFOO(*RExC_parse)) RExC_parse++;
10662      * instead of
10663      *      while(RExC_parse < RExC_end && isFOO(*RExC_parse)) RExC_parse++;
10664      */
10665     assert(*RExC_end == '\0');
10666
10667     /* Make an OPEN node, if parenthesized. */
10668     if (paren) {
10669
10670         /* Under /x, space and comments can be gobbled up between the '(' and
10671          * here (if paren ==2).  The forms '(*VERB' and '(?...' disallow such
10672          * intervening space, as the sequence is a token, and a token should be
10673          * indivisible */
10674         bool has_intervening_patws = paren == 2 && *(RExC_parse - 1) != '(';
10675
10676         if (RExC_parse >= RExC_end) {
10677             vFAIL("Unmatched (");
10678         }
10679
10680         if ( *RExC_parse == '*') { /* (*VERB:ARG) */
10681             char *start_verb = RExC_parse + 1;
10682             STRLEN verb_len;
10683             char *start_arg = NULL;
10684             unsigned char op = 0;
10685             int arg_required = 0;
10686             int internal_argval = -1; /* if >-1 we are not allowed an argument*/
10687
10688             if (has_intervening_patws) {
10689                 RExC_parse++;   /* past the '*' */
10690                 vFAIL("In '(*VERB...)', the '(' and '*' must be adjacent");
10691             }
10692             while (RExC_parse < RExC_end && *RExC_parse != ')' ) {
10693                 if ( *RExC_parse == ':' ) {
10694                     start_arg = RExC_parse + 1;
10695                     break;
10696                 }
10697                 RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
10698             }
10699             verb_len = RExC_parse - start_verb;
10700             if ( start_arg ) {
10701                 if (RExC_parse >= RExC_end) {
10702                     goto unterminated_verb_pattern;
10703                 }
10704                 RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
10705                 while ( RExC_parse < RExC_end && *RExC_parse != ')' )
10706                     RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
10707                 if ( RExC_parse >= RExC_end || *RExC_parse != ')' )
10708                   unterminated_verb_pattern:
10709                     vFAIL("Unterminated verb pattern argument");
10710                 if ( RExC_parse == start_arg )
10711                     start_arg = NULL;
10712             } else {
10713                 if ( RExC_parse >= RExC_end || *RExC_parse != ')' )
10714                     vFAIL("Unterminated verb pattern");
10715             }
10716
10717             /* Here, we know that RExC_parse < RExC_end */
10718
10719             switch ( *start_verb ) {
10720             case 'A':  /* (*ACCEPT) */
10721                 if ( memEQs(start_verb,verb_len,"ACCEPT") ) {
10722                     op = ACCEPT;
10723                     internal_argval = RExC_nestroot;
10724                 }
10725                 break;
10726             case 'C':  /* (*COMMIT) */
10727                 if ( memEQs(start_verb,verb_len,"COMMIT") )
10728                     op = COMMIT;
10729                 break;
10730             case 'F':  /* (*FAIL) */
10731                 if ( verb_len==1 || memEQs(start_verb,verb_len,"FAIL") ) {
10732                     op = OPFAIL;
10733                 }
10734                 break;
10735             case ':':  /* (*:NAME) */
10736             case 'M':  /* (*MARK:NAME) */
10737                 if ( verb_len==0 || memEQs(start_verb,verb_len,"MARK") ) {
10738                     op = MARKPOINT;
10739                     arg_required = 1;
10740                 }
10741                 break;
10742             case 'P':  /* (*PRUNE) */
10743                 if ( memEQs(start_verb,verb_len,"PRUNE") )
10744                     op = PRUNE;
10745                 break;
10746             case 'S':   /* (*SKIP) */
10747                 if ( memEQs(start_verb,verb_len,"SKIP") )
10748                     op = SKIP;
10749                 break;
10750             case 'T':  /* (*THEN) */
10751                 /* [19:06] <TimToady> :: is then */
10752                 if ( memEQs(start_verb,verb_len,"THEN") ) {
10753                     op = CUTGROUP;
10754                     RExC_seen |= REG_CUTGROUP_SEEN;
10755                 }
10756                 break;
10757             }
10758             if ( ! op ) {
10759                 RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
10760                 vFAIL2utf8f(
10761                     "Unknown verb pattern '%" UTF8f "'",
10762                     UTF8fARG(UTF, verb_len, start_verb));
10763             }
10764             if ( arg_required && !start_arg ) {
10765                 vFAIL3("Verb pattern '%.*s' has a mandatory argument",
10766                     verb_len, start_verb);
10767             }
10768             if (internal_argval == -1) {
10769                 ret = reganode(pRExC_state, op, 0);
10770             } else {
10771                 ret = reg2Lanode(pRExC_state, op, 0, internal_argval);
10772             }
10773             RExC_seen |= REG_VERBARG_SEEN;
10774             if ( ! SIZE_ONLY ) {
10775                 if (start_arg) {
10776                     SV *sv = newSVpvn( start_arg,
10777                                        RExC_parse - start_arg);
10778                     ARG(ret) = add_data( pRExC_state,
10779                                          STR_WITH_LEN("S"));
10780                     RExC_rxi->data->data[ARG(ret)]=(void*)sv;
10781                     ret->flags = 1;
10782                 } else {
10783                     ret->flags = 0;
10784                 }
10785                 if ( internal_argval != -1 )
10786                     ARG2L_SET(ret, internal_argval);
10787             }
10788             nextchar(pRExC_state);
10789             return ret;
10790         }
10791         else if (*RExC_parse == '?') { /* (?...) */
10792             bool is_logical = 0;
10793             const char * const seqstart = RExC_parse;
10794             const char * endptr;
10795             if (has_intervening_patws) {
10796                 RExC_parse++;
10797                 vFAIL("In '(?...)', the '(' and '?' must be adjacent");
10798             }
10799
10800             RExC_parse++;           /* past the '?' */
10801             paren = *RExC_parse;    /* might be a trailing NUL, if not
10802                                        well-formed */
10803             RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
10804             if (RExC_parse > RExC_end) {
10805                 paren = '\0';
10806             }
10807             ret = NULL;                 /* For look-ahead/behind. */
10808             switch (paren) {
10809
10810             case 'P':   /* (?P...) variants for those used to PCRE/Python */
10811                 paren = *RExC_parse;
10812                 if ( paren == '<') {    /* (?P<...>) named capture */
10813                     RExC_parse++;
10814                     if (RExC_parse >= RExC_end) {
10815                         vFAIL("Sequence (?P<... not terminated");
10816                     }
10817                     goto named_capture;
10818                 }
10819                 else if (paren == '>') {   /* (?P>name) named recursion */
10820                     RExC_parse++;
10821                     if (RExC_parse >= RExC_end) {
10822                         vFAIL("Sequence (?P>... not terminated");
10823                     }
10824                     goto named_recursion;
10825                 }
10826                 else if (paren == '=') {   /* (?P=...)  named backref */
10827                     RExC_parse++;
10828                     return handle_named_backref(pRExC_state, flagp,
10829                                                 parse_start, ')');
10830                 }
10831                 RExC_parse += SKIP_IF_CHAR(RExC_parse);
10832                 /* diag_listed_as: Sequence (?%s...) not recognized in regex; marked by <-- HERE in m/%s/ */
10833                 vFAIL3("Sequence (%.*s...) not recognized",
10834                                 RExC_parse-seqstart, seqstart);
10835                 NOT_REACHED; /*NOTREACHED*/
10836             case '<':           /* (?<...) */
10837                 if (*RExC_parse == '!')
10838                     paren = ',';
10839                 else if (*RExC_parse != '=')
10840               named_capture:
10841                 {               /* (?<...>) */
10842                     char *name_start;
10843                     SV *svname;
10844                     paren= '>';
10845                 /* FALLTHROUGH */
10846             case '\'':          /* (?'...') */
10847                     name_start = RExC_parse;
10848                     svname = reg_scan_name(pRExC_state,
10849                         SIZE_ONLY    /* reverse test from the others */
10850                         ? REG_RSN_RETURN_NAME
10851                         : REG_RSN_RETURN_NULL);
10852                     if (   RExC_parse == name_start
10853                         || RExC_parse >= RExC_end
10854                         || *RExC_parse != paren)
10855                     {
10856                         vFAIL2("Sequence (?%c... not terminated",
10857                             paren=='>' ? '<' : paren);
10858                     }
10859                     if (SIZE_ONLY) {
10860                         HE *he_str;
10861                         SV *sv_dat = NULL;
10862                         if (!svname) /* shouldn't happen */
10863                             Perl_croak(aTHX_
10864                                 "panic: reg_scan_name returned NULL");
10865                         if (!RExC_paren_names) {
10866                             RExC_paren_names= newHV();
10867                             sv_2mortal(MUTABLE_SV(RExC_paren_names));
10868 #ifdef DEBUGGING
10869                             RExC_paren_name_list= newAV();
10870                             sv_2mortal(MUTABLE_SV(RExC_paren_name_list));
10871 #endif
10872                         }
10873                         he_str = hv_fetch_ent( RExC_paren_names, svname, 1, 0 );
10874                         if ( he_str )
10875                             sv_dat = HeVAL(he_str);
10876                         if ( ! sv_dat ) {
10877                             /* croak baby croak */
10878                             Perl_croak(aTHX_
10879                                 "panic: paren_name hash element allocation failed");
10880                         } else if ( SvPOK(sv_dat) ) {
10881                             /* (?|...) can mean we have dupes so scan to check
10882                                its already been stored. Maybe a flag indicating
10883                                we are inside such a construct would be useful,
10884                                but the arrays are likely to be quite small, so
10885                                for now we punt -- dmq */
10886                             IV count = SvIV(sv_dat);
10887                             I32 *pv = (I32*)SvPVX(sv_dat);
10888                             IV i;
10889                             for ( i = 0 ; i < count ; i++ ) {
10890                                 if ( pv[i] == RExC_npar ) {
10891                                     count = 0;
10892                                     break;
10893                                 }
10894                             }
10895                             if ( count ) {
10896                                 pv = (I32*)SvGROW(sv_dat,
10897                                                 SvCUR(sv_dat) + sizeof(I32)+1);
10898                                 SvCUR_set(sv_dat, SvCUR(sv_dat) + sizeof(I32));
10899                                 pv[count] = RExC_npar;
10900                                 SvIV_set(sv_dat, SvIVX(sv_dat) + 1);
10901                             }
10902                         } else {
10903                             (void)SvUPGRADE(sv_dat,SVt_PVNV);
10904                             sv_setpvn(sv_dat, (char *)&(RExC_npar),
10905                                                                 sizeof(I32));
10906                             SvIOK_on(sv_dat);
10907                             SvIV_set(sv_dat, 1);
10908                         }
10909 #ifdef DEBUGGING
10910                         /* Yes this does cause a memory leak in debugging Perls
10911                          * */
10912                         if (!av_store(RExC_paren_name_list,
10913                                       RExC_npar, SvREFCNT_inc(svname)))
10914                             SvREFCNT_dec_NN(svname);
10915 #endif
10916
10917                         /*sv_dump(sv_dat);*/
10918                     }
10919                     nextchar(pRExC_state);
10920                     paren = 1;
10921                     goto capturing_parens;
10922                 }
10923                 RExC_seen |= REG_LOOKBEHIND_SEEN;
10924                 RExC_in_lookbehind++;
10925                 RExC_parse++;
10926                 if (RExC_parse >= RExC_end) {
10927                     vFAIL("Sequence (?... not terminated");
10928                 }
10929
10930                 /* FALLTHROUGH */
10931             case '=':           /* (?=...) */
10932                 RExC_seen_zerolen++;
10933                 break;
10934             case '!':           /* (?!...) */
10935                 RExC_seen_zerolen++;
10936                 /* check if we're really just a "FAIL" assertion */
10937                 skip_to_be_ignored_text(pRExC_state, &RExC_parse,
10938                                         FALSE /* Don't force to /x */ );
10939                 if (*RExC_parse == ')') {
10940                     ret=reganode(pRExC_state, OPFAIL, 0);
10941                     nextchar(pRExC_state);
10942                     return ret;
10943                 }
10944                 break;
10945             case '|':           /* (?|...) */
10946                 /* branch reset, behave like a (?:...) except that
10947                    buffers in alternations share the same numbers */
10948                 paren = ':';
10949                 after_freeze = freeze_paren = RExC_npar;
10950                 break;
10951             case ':':           /* (?:...) */
10952             case '>':           /* (?>...) */
10953                 break;
10954             case '$':           /* (?$...) */
10955             case '@':           /* (?@...) */
10956                 vFAIL2("Sequence (?%c...) not implemented", (int)paren);
10957                 break;
10958             case '0' :           /* (?0) */
10959             case 'R' :           /* (?R) */
10960                 if (RExC_parse == RExC_end || *RExC_parse != ')')
10961                     FAIL("Sequence (?R) not terminated");
10962                 num = 0;
10963                 RExC_seen |= REG_RECURSE_SEEN;
10964                 *flagp |= POSTPONED;
10965                 goto gen_recurse_regop;
10966                 /*notreached*/
10967             /* named and numeric backreferences */
10968             case '&':            /* (?&NAME) */
10969                 parse_start = RExC_parse - 1;
10970               named_recursion:
10971                 {
10972                     SV *sv_dat = reg_scan_name(pRExC_state,
10973                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
10974                      num = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
10975                 }
10976                 if (RExC_parse >= RExC_end || *RExC_parse != ')')
10977                     vFAIL("Sequence (?&... not terminated");
10978                 goto gen_recurse_regop;
10979                 /* NOTREACHED */
10980             case '+':
10981                 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
10982                     RExC_parse++;
10983                     vFAIL("Illegal pattern");
10984                 }
10985                 goto parse_recursion;
10986                 /* NOTREACHED*/
10987             case '-': /* (?-1) */
10988                 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
10989                     RExC_parse--; /* rewind to let it be handled later */
10990                     goto parse_flags;
10991                 }
10992                 /* FALLTHROUGH */
10993             case '1': case '2': case '3': case '4': /* (?1) */
10994             case '5': case '6': case '7': case '8': case '9':
10995                 RExC_parse = (char *) seqstart + 1;  /* Point to the digit */
10996               parse_recursion:
10997                 {
10998                     bool is_neg = FALSE;
10999                     UV unum;
11000                     parse_start = RExC_parse - 1; /* MJD */
11001                     if (*RExC_parse == '-') {
11002                         RExC_parse++;
11003                         is_neg = TRUE;
11004                     }
11005                     if (grok_atoUV(RExC_parse, &unum, &endptr)
11006                         && unum <= I32_MAX
11007                     ) {
11008                         num = (I32)unum;
11009                         RExC_parse = (char*)endptr;
11010                     } else
11011                         num = I32_MAX;
11012                     if (is_neg) {
11013                         /* Some limit for num? */
11014                         num = -num;
11015                     }
11016                 }
11017                 if (*RExC_parse!=')')
11018                     vFAIL("Expecting close bracket");
11019
11020               gen_recurse_regop:
11021                 if ( paren == '-' ) {
11022                     /*
11023                     Diagram of capture buffer numbering.
11024                     Top line is the normal capture buffer numbers
11025                     Bottom line is the negative indexing as from
11026                     the X (the (?-2))
11027
11028                     +   1 2    3 4 5 X          6 7
11029                        /(a(x)y)(a(b(c(?-2)d)e)f)(g(h))/
11030                     -   5 4    3 2 1 X          x x
11031
11032                     */
11033                     num = RExC_npar + num;
11034                     if (num < 1)  {
11035                         RExC_parse++;
11036                         vFAIL("Reference to nonexistent group");
11037                     }
11038                 } else if ( paren == '+' ) {
11039                     num = RExC_npar + num - 1;
11040                 }
11041                 /* We keep track how many GOSUB items we have produced.
11042                    To start off the ARG2L() of the GOSUB holds its "id",
11043                    which is used later in conjunction with RExC_recurse
11044                    to calculate the offset we need to jump for the GOSUB,
11045                    which it will store in the final representation.
11046                    We have to defer the actual calculation until much later
11047                    as the regop may move.
11048                  */
11049
11050                 ret = reg2Lanode(pRExC_state, GOSUB, num, RExC_recurse_count);
11051                 if (!SIZE_ONLY) {
11052                     if (num > (I32)RExC_rx->nparens) {
11053                         RExC_parse++;
11054                         vFAIL("Reference to nonexistent group");
11055                     }
11056                     RExC_recurse_count++;
11057                     DEBUG_OPTIMISE_MORE_r(Perl_re_printf( aTHX_
11058                         "%*s%*s Recurse #%" UVuf " to %" IVdf "\n",
11059                               22, "|    |", (int)(depth * 2 + 1), "",
11060                               (UV)ARG(ret), (IV)ARG2L(ret)));
11061                 }
11062                 RExC_seen |= REG_RECURSE_SEEN;
11063
11064                 Set_Node_Length(ret, 1 + regarglen[OP(ret)]); /* MJD */
11065                 Set_Node_Offset(ret, parse_start); /* MJD */
11066
11067                 *flagp |= POSTPONED;
11068                 assert(*RExC_parse == ')');
11069                 nextchar(pRExC_state);
11070                 return ret;
11071
11072             /* NOTREACHED */
11073
11074             case '?':           /* (??...) */
11075                 is_logical = 1;
11076                 if (*RExC_parse != '{') {
11077                     RExC_parse += SKIP_IF_CHAR(RExC_parse);
11078                     /* diag_listed_as: Sequence (?%s...) not recognized in regex; marked by <-- HERE in m/%s/ */
11079                     vFAIL2utf8f(
11080                         "Sequence (%" UTF8f "...) not recognized",
11081                         UTF8fARG(UTF, RExC_parse-seqstart, seqstart));
11082                     NOT_REACHED; /*NOTREACHED*/
11083                 }
11084                 *flagp |= POSTPONED;
11085                 paren = '{';
11086                 RExC_parse++;
11087                 /* FALLTHROUGH */
11088             case '{':           /* (?{...}) */
11089             {
11090                 U32 n = 0;
11091                 struct reg_code_block *cb;
11092
11093                 RExC_seen_zerolen++;
11094
11095                 if (   !pRExC_state->code_blocks
11096                     || pRExC_state->code_index
11097                                         >= pRExC_state->code_blocks->count
11098                     || pRExC_state->code_blocks->cb[pRExC_state->code_index].start
11099                         != (STRLEN)((RExC_parse -3 - (is_logical ? 1 : 0))
11100                             - RExC_start)
11101                 ) {
11102                     if (RExC_pm_flags & PMf_USE_RE_EVAL)
11103                         FAIL("panic: Sequence (?{...}): no code block found\n");
11104                     FAIL("Eval-group not allowed at runtime, use re 'eval'");
11105                 }
11106                 /* this is a pre-compiled code block (?{...}) */
11107                 cb = &pRExC_state->code_blocks->cb[pRExC_state->code_index];
11108                 RExC_parse = RExC_start + cb->end;
11109                 if (!SIZE_ONLY) {
11110                     OP *o = cb->block;
11111                     if (cb->src_regex) {
11112                         n = add_data(pRExC_state, STR_WITH_LEN("rl"));
11113                         RExC_rxi->data->data[n] =
11114                             (void*)SvREFCNT_inc((SV*)cb->src_regex);
11115                         RExC_rxi->data->data[n+1] = (void*)o;
11116                     }
11117                     else {
11118                         n = add_data(pRExC_state,
11119                                (RExC_pm_flags & PMf_HAS_CV) ? "L" : "l", 1);
11120                         RExC_rxi->data->data[n] = (void*)o;
11121                     }
11122                 }
11123                 pRExC_state->code_index++;
11124                 nextchar(pRExC_state);
11125
11126                 if (is_logical) {
11127                     regnode *eval;
11128                     ret = reg_node(pRExC_state, LOGICAL);
11129
11130                     eval = reg2Lanode(pRExC_state, EVAL,
11131                                        n,
11132
11133                                        /* for later propagation into (??{})
11134                                         * return value */
11135                                        RExC_flags & RXf_PMf_COMPILETIME
11136                                       );
11137                     if (!SIZE_ONLY) {
11138                         ret->flags = 2;
11139                     }
11140                     REGTAIL(pRExC_state, ret, eval);
11141                     /* deal with the length of this later - MJD */
11142                     return ret;
11143                 }
11144                 ret = reg2Lanode(pRExC_state, EVAL, n, 0);
11145                 Set_Node_Length(ret, RExC_parse - parse_start + 1);
11146                 Set_Node_Offset(ret, parse_start);
11147                 return ret;
11148             }
11149             case '(':           /* (?(?{...})...) and (?(?=...)...) */
11150             {
11151                 int is_define= 0;
11152                 const int DEFINE_len = sizeof("DEFINE") - 1;
11153                 if (RExC_parse[0] == '?') {        /* (?(?...)) */
11154                     if (   RExC_parse < RExC_end - 1
11155                         && (   RExC_parse[1] == '='
11156                             || RExC_parse[1] == '!'
11157                             || RExC_parse[1] == '<'
11158                             || RExC_parse[1] == '{')
11159                     ) { /* Lookahead or eval. */
11160                         I32 flag;
11161                         regnode *tail;
11162
11163                         ret = reg_node(pRExC_state, LOGICAL);
11164                         if (!SIZE_ONLY)
11165                             ret->flags = 1;
11166
11167                         tail = reg(pRExC_state, 1, &flag, depth+1);
11168                         if (flag & (RESTART_PASS1|NEED_UTF8)) {
11169                             *flagp = flag & (RESTART_PASS1|NEED_UTF8);
11170                             return NULL;
11171                         }
11172                         REGTAIL(pRExC_state, ret, tail);
11173                         goto insert_if;
11174                     }
11175                     /* Fall through to ‘Unknown switch condition’ at the
11176                        end of the if/else chain. */
11177                 }
11178                 else if ( RExC_parse[0] == '<'     /* (?(<NAME>)...) */
11179                          || RExC_parse[0] == '\'' ) /* (?('NAME')...) */
11180                 {
11181                     char ch = RExC_parse[0] == '<' ? '>' : '\'';
11182                     char *name_start= RExC_parse++;
11183                     U32 num = 0;
11184                     SV *sv_dat=reg_scan_name(pRExC_state,
11185                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
11186                     if (   RExC_parse == name_start
11187                         || RExC_parse >= RExC_end
11188                         || *RExC_parse != ch)
11189                     {
11190                         vFAIL2("Sequence (?(%c... not terminated",
11191                             (ch == '>' ? '<' : ch));
11192                     }
11193                     RExC_parse++;
11194                     if (!SIZE_ONLY) {
11195                         num = add_data( pRExC_state, STR_WITH_LEN("S"));
11196                         RExC_rxi->data->data[num]=(void*)sv_dat;
11197                         SvREFCNT_inc_simple_void(sv_dat);
11198                     }
11199                     ret = reganode(pRExC_state,NGROUPP,num);
11200                     goto insert_if_check_paren;
11201                 }
11202                 else if (memBEGINs(RExC_parse,
11203                                    (STRLEN) (RExC_end - RExC_parse),
11204                                    "DEFINE"))
11205                 {
11206                     ret = reganode(pRExC_state,DEFINEP,0);
11207                     RExC_parse += DEFINE_len;
11208                     is_define = 1;
11209                     goto insert_if_check_paren;
11210                 }
11211                 else if (RExC_parse[0] == 'R') {
11212                     RExC_parse++;
11213                     /* parno == 0 => /(?(R)YES|NO)/  "in any form of recursion OR eval"
11214                      * parno == 1 => /(?(R0)YES|NO)/ "in GOSUB (?0) / (?R)"
11215                      * parno == 2 => /(?(R1)YES|NO)/ "in GOSUB (?1) (parno-1)"
11216                      */
11217                     parno = 0;
11218                     if (RExC_parse[0] == '0') {
11219                         parno = 1;
11220                         RExC_parse++;
11221                     }
11222                     else if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
11223                         UV uv;
11224                         if (grok_atoUV(RExC_parse, &uv, &endptr)
11225                             && uv <= I32_MAX
11226                         ) {
11227                             parno = (I32)uv + 1;
11228                             RExC_parse = (char*)endptr;
11229                         }
11230                         /* else "Switch condition not recognized" below */
11231                     } else if (RExC_parse[0] == '&') {
11232                         SV *sv_dat;
11233                         RExC_parse++;
11234                         sv_dat = reg_scan_name(pRExC_state,
11235                             SIZE_ONLY
11236                             ? REG_RSN_RETURN_NULL
11237                             : REG_RSN_RETURN_DATA);
11238
11239                         /* we should only have a false sv_dat when
11240                          * SIZE_ONLY is true, and we always have false
11241                          * sv_dat when SIZE_ONLY is true.
11242                          * reg_scan_name() will VFAIL() if the name is
11243                          * unknown when SIZE_ONLY is false, and otherwise
11244                          * will return something, and when SIZE_ONLY is
11245                          * true, reg_scan_name() just parses the string,
11246                          * and doesnt return anything. (in theory) */
11247                         assert(SIZE_ONLY ? !sv_dat : !!sv_dat);
11248
11249                         if (sv_dat)
11250                             parno = 1 + *((I32 *)SvPVX(sv_dat));
11251                     }
11252                     ret = reganode(pRExC_state,INSUBP,parno);
11253                     goto insert_if_check_paren;
11254                 }
11255                 else if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
11256                     /* (?(1)...) */
11257                     char c;
11258                     UV uv;
11259                     if (grok_atoUV(RExC_parse, &uv, &endptr)
11260                         && uv <= I32_MAX
11261                     ) {
11262                         parno = (I32)uv;
11263                         RExC_parse = (char*)endptr;
11264                     }
11265                     else {
11266                         vFAIL("panic: grok_atoUV returned FALSE");
11267                     }
11268                     ret = reganode(pRExC_state, GROUPP, parno);
11269
11270                  insert_if_check_paren:
11271                     if (UCHARAT(RExC_parse) != ')') {
11272                         RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
11273                         vFAIL("Switch condition not recognized");
11274                     }
11275                     nextchar(pRExC_state);
11276                   insert_if:
11277                     REGTAIL(pRExC_state, ret, reganode(pRExC_state, IFTHEN, 0));
11278                     br = regbranch(pRExC_state, &flags, 1,depth+1);
11279                     if (br == NULL) {
11280                         if (flags & (RESTART_PASS1|NEED_UTF8)) {
11281                             *flagp = flags & (RESTART_PASS1|NEED_UTF8);
11282                             return NULL;
11283                         }
11284                         FAIL2("panic: regbranch returned NULL, flags=%#" UVxf,
11285                               (UV) flags);
11286                     } else
11287                         REGTAIL(pRExC_state, br, reganode(pRExC_state,
11288                                                           LONGJMP, 0));
11289                     c = UCHARAT(RExC_parse);
11290                     nextchar(pRExC_state);
11291                     if (flags&HASWIDTH)
11292                         *flagp |= HASWIDTH;
11293                     if (c == '|') {
11294                         if (is_define)
11295                             vFAIL("(?(DEFINE)....) does not allow branches");
11296
11297                         /* Fake one for optimizer.  */
11298                         lastbr = reganode(pRExC_state, IFTHEN, 0);
11299
11300                         if (!regbranch(pRExC_state, &flags, 1,depth+1)) {
11301                             if (flags & (RESTART_PASS1|NEED_UTF8)) {
11302                                 *flagp = flags & (RESTART_PASS1|NEED_UTF8);
11303                                 return NULL;
11304                             }
11305                             FAIL2("panic: regbranch returned NULL, flags=%#" UVxf,
11306                                   (UV) flags);
11307                         }
11308                         REGTAIL(pRExC_state, ret, lastbr);
11309                         if (flags&HASWIDTH)
11310                             *flagp |= HASWIDTH;
11311                         c = UCHARAT(RExC_parse);
11312                         nextchar(pRExC_state);
11313                     }
11314                     else
11315                         lastbr = NULL;
11316                     if (c != ')') {
11317                         if (RExC_parse >= RExC_end)
11318                             vFAIL("Switch (?(condition)... not terminated");
11319                         else
11320                             vFAIL("Switch (?(condition)... contains too many branches");
11321                     }
11322                     ender = reg_node(pRExC_state, TAIL);
11323                     REGTAIL(pRExC_state, br, ender);
11324                     if (lastbr) {
11325                         REGTAIL(pRExC_state, lastbr, ender);
11326                         REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender);
11327                     }
11328                     else
11329                         REGTAIL(pRExC_state, ret, ender);
11330                     RExC_size++; /* XXX WHY do we need this?!!
11331                                     For large programs it seems to be required
11332                                     but I can't figure out why. -- dmq*/
11333                     return ret;
11334                 }
11335                 RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
11336                 vFAIL("Unknown switch condition (?(...))");
11337             }
11338             case '[':           /* (?[ ... ]) */
11339                 return handle_regex_sets(pRExC_state, NULL, flagp, depth+1,
11340                                          oregcomp_parse);
11341             case 0: /* A NUL */
11342                 RExC_parse--; /* for vFAIL to print correctly */
11343                 vFAIL("Sequence (? incomplete");
11344                 break;
11345             default: /* e.g., (?i) */
11346                 RExC_parse = (char *) seqstart + 1;
11347               parse_flags:
11348                 parse_lparen_question_flags(pRExC_state);
11349                 if (UCHARAT(RExC_parse) != ':') {
11350                     if (RExC_parse < RExC_end)
11351                         nextchar(pRExC_state);
11352                     *flagp = TRYAGAIN;
11353                     return NULL;
11354                 }
11355                 paren = ':';
11356                 nextchar(pRExC_state);
11357                 ret = NULL;
11358                 goto parse_rest;
11359             } /* end switch */
11360         }
11361         else if (!(RExC_flags & RXf_PMf_NOCAPTURE)) {   /* (...) */
11362           capturing_parens:
11363             parno = RExC_npar;
11364             RExC_npar++;
11365
11366             ret = reganode(pRExC_state, OPEN, parno);
11367             if (!SIZE_ONLY ){
11368                 if (!RExC_nestroot)
11369                     RExC_nestroot = parno;
11370                 if (RExC_open_parens && !RExC_open_parens[parno])
11371                 {
11372                     DEBUG_OPTIMISE_MORE_r(Perl_re_printf( aTHX_
11373                         "%*s%*s Setting open paren #%" IVdf " to %d\n",
11374                         22, "|    |", (int)(depth * 2 + 1), "",
11375                         (IV)parno, REG_NODE_NUM(ret)));
11376                     RExC_open_parens[parno]= ret;
11377                 }
11378             }
11379             Set_Node_Length(ret, 1); /* MJD */
11380             Set_Node_Offset(ret, RExC_parse); /* MJD */
11381             is_open = 1;
11382         } else {
11383             /* with RXf_PMf_NOCAPTURE treat (...) as (?:...) */
11384             paren = ':';
11385             ret = NULL;
11386         }
11387     }
11388     else                        /* ! paren */
11389         ret = NULL;
11390
11391    parse_rest:
11392     /* Pick up the branches, linking them together. */
11393     parse_start = RExC_parse;   /* MJD */
11394     br = regbranch(pRExC_state, &flags, 1,depth+1);
11395
11396     /*     branch_len = (paren != 0); */
11397
11398     if (br == NULL) {
11399         if (flags & (RESTART_PASS1|NEED_UTF8)) {
11400             *flagp = flags & (RESTART_PASS1|NEED_UTF8);
11401             return NULL;
11402         }
11403         FAIL2("panic: regbranch returned NULL, flags=%#" UVxf, (UV) flags);
11404     }
11405     if (*RExC_parse == '|') {
11406         if (!SIZE_ONLY && RExC_extralen) {
11407             reginsert(pRExC_state, BRANCHJ, br, depth+1);
11408         }
11409         else {                  /* MJD */
11410             reginsert(pRExC_state, BRANCH, br, depth+1);
11411             Set_Node_Length(br, paren != 0);
11412             Set_Node_Offset_To_R(br-RExC_emit_start, parse_start-RExC_start);
11413         }
11414         have_branch = 1;
11415         if (SIZE_ONLY)
11416             RExC_extralen += 1;         /* For BRANCHJ-BRANCH. */
11417     }
11418     else if (paren == ':') {
11419         *flagp |= flags&SIMPLE;
11420     }
11421     if (is_open) {                              /* Starts with OPEN. */
11422         REGTAIL(pRExC_state, ret, br);          /* OPEN -> first. */
11423     }
11424     else if (paren != '?')              /* Not Conditional */
11425         ret = br;
11426     *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
11427     lastbr = br;
11428     while (*RExC_parse == '|') {
11429         if (!SIZE_ONLY && RExC_extralen) {
11430             ender = reganode(pRExC_state, LONGJMP,0);
11431
11432             /* Append to the previous. */
11433             REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender);
11434         }
11435         if (SIZE_ONLY)
11436             RExC_extralen += 2;         /* Account for LONGJMP. */
11437         nextchar(pRExC_state);
11438         if (freeze_paren) {
11439             if (RExC_npar > after_freeze)
11440                 after_freeze = RExC_npar;
11441             RExC_npar = freeze_paren;
11442         }
11443         br = regbranch(pRExC_state, &flags, 0, depth+1);
11444
11445         if (br == NULL) {
11446             if (flags & (RESTART_PASS1|NEED_UTF8)) {
11447                 *flagp = flags & (RESTART_PASS1|NEED_UTF8);
11448                 return NULL;
11449             }
11450             FAIL2("panic: regbranch returned NULL, flags=%#" UVxf, (UV) flags);
11451         }
11452         REGTAIL(pRExC_state, lastbr, br);               /* BRANCH -> BRANCH. */
11453         lastbr = br;
11454         *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
11455     }
11456
11457     if (have_branch || paren != ':') {
11458         /* Make a closing node, and hook it on the end. */
11459         switch (paren) {
11460         case ':':
11461             ender = reg_node(pRExC_state, TAIL);
11462             break;
11463         case 1: case 2:
11464             ender = reganode(pRExC_state, CLOSE, parno);
11465             if ( RExC_close_parens ) {
11466                 DEBUG_OPTIMISE_MORE_r(Perl_re_printf( aTHX_
11467                         "%*s%*s Setting close paren #%" IVdf " to %d\n",
11468                         22, "|    |", (int)(depth * 2 + 1), "", (IV)parno, REG_NODE_NUM(ender)));
11469                 RExC_close_parens[parno]= ender;
11470                 if (RExC_nestroot == parno)
11471                     RExC_nestroot = 0;
11472             }
11473             Set_Node_Offset(ender,RExC_parse+1); /* MJD */
11474             Set_Node_Length(ender,1); /* MJD */
11475             break;
11476         case '<':
11477         case ',':
11478         case '=':
11479         case '!':
11480             *flagp &= ~HASWIDTH;
11481             /* FALLTHROUGH */
11482         case '>':
11483             ender = reg_node(pRExC_state, SUCCEED);
11484             break;
11485         case 0:
11486             ender = reg_node(pRExC_state, END);
11487             if (!SIZE_ONLY) {
11488                 assert(!RExC_end_op); /* there can only be one! */
11489                 RExC_end_op = ender;
11490                 if (RExC_close_parens) {
11491                     DEBUG_OPTIMISE_MORE_r(Perl_re_printf( aTHX_
11492                         "%*s%*s Setting close paren #0 (END) to %d\n",
11493                         22, "|    |", (int)(depth * 2 + 1), "", REG_NODE_NUM(ender)));
11494
11495                     RExC_close_parens[0]= ender;
11496                 }
11497             }
11498             break;
11499         }
11500         DEBUG_PARSE_r(if (!SIZE_ONLY) {
11501             DEBUG_PARSE_MSG("lsbr");
11502             regprop(RExC_rx, RExC_mysv1, lastbr, NULL, pRExC_state);
11503             regprop(RExC_rx, RExC_mysv2, ender, NULL, pRExC_state);
11504             Perl_re_printf( aTHX_  "~ tying lastbr %s (%" IVdf ") to ender %s (%" IVdf ") offset %" IVdf "\n",
11505                           SvPV_nolen_const(RExC_mysv1),
11506                           (IV)REG_NODE_NUM(lastbr),
11507                           SvPV_nolen_const(RExC_mysv2),
11508                           (IV)REG_NODE_NUM(ender),
11509                           (IV)(ender - lastbr)
11510             );
11511         });
11512         REGTAIL(pRExC_state, lastbr, ender);
11513
11514         if (have_branch && !SIZE_ONLY) {
11515             char is_nothing= 1;
11516             if (depth==1)
11517                 RExC_seen |= REG_TOP_LEVEL_BRANCHES_SEEN;
11518
11519             /* Hook the tails of the branches to the closing node. */
11520             for (br = ret; br; br = regnext(br)) {
11521                 const U8 op = PL_regkind[OP(br)];
11522                 if (op == BRANCH) {
11523                     REGTAIL_STUDY(pRExC_state, NEXTOPER(br), ender);
11524                     if ( OP(NEXTOPER(br)) != NOTHING
11525                          || regnext(NEXTOPER(br)) != ender)
11526                         is_nothing= 0;
11527                 }
11528                 else if (op == BRANCHJ) {
11529                     REGTAIL_STUDY(pRExC_state, NEXTOPER(NEXTOPER(br)), ender);
11530                     /* for now we always disable this optimisation * /
11531                     if ( OP(NEXTOPER(NEXTOPER(br))) != NOTHING
11532                          || regnext(NEXTOPER(NEXTOPER(br))) != ender)
11533                     */
11534                         is_nothing= 0;
11535                 }
11536             }
11537             if (is_nothing) {
11538                 br= PL_regkind[OP(ret)] != BRANCH ? regnext(ret) : ret;
11539                 DEBUG_PARSE_r(if (!SIZE_ONLY) {
11540                     DEBUG_PARSE_MSG("NADA");
11541                     regprop(RExC_rx, RExC_mysv1, ret, NULL, pRExC_state);
11542                     regprop(RExC_rx, RExC_mysv2, ender, NULL, pRExC_state);
11543                     Perl_re_printf( aTHX_  "~ converting ret %s (%" IVdf ") to ender %s (%" IVdf ") offset %" IVdf "\n",
11544                                   SvPV_nolen_const(RExC_mysv1),
11545                                   (IV)REG_NODE_NUM(ret),
11546                                   SvPV_nolen_const(RExC_mysv2),
11547                                   (IV)REG_NODE_NUM(ender),
11548                                   (IV)(ender - ret)
11549                     );
11550                 });
11551                 OP(br)= NOTHING;
11552                 if (OP(ender) == TAIL) {
11553                     NEXT_OFF(br)= 0;
11554                     RExC_emit= br + 1;
11555                 } else {
11556                     regnode *opt;
11557                     for ( opt= br + 1; opt < ender ; opt++ )
11558                         OP(opt)= OPTIMIZED;
11559                     NEXT_OFF(br)= ender - br;
11560                 }
11561             }
11562         }
11563     }
11564
11565     {
11566         const char *p;
11567         static const char parens[] = "=!<,>";
11568
11569         if (paren && (p = strchr(parens, paren))) {
11570             U8 node = ((p - parens) % 2) ? UNLESSM : IFMATCH;
11571             int flag = (p - parens) > 1;
11572
11573             if (paren == '>')
11574                 node = SUSPEND, flag = 0;
11575             reginsert(pRExC_state, node,ret, depth+1);
11576             Set_Node_Cur_Length(ret, parse_start);
11577             Set_Node_Offset(ret, parse_start + 1);
11578             ret->flags = flag;
11579             REGTAIL_STUDY(pRExC_state, ret, reg_node(pRExC_state, TAIL));
11580         }
11581     }
11582
11583     /* Check for proper termination. */
11584     if (paren) {
11585         /* restore original flags, but keep (?p) and, if we've changed from /d
11586          * rules to /u, keep the /u */
11587         RExC_flags = oregflags | (RExC_flags & RXf_PMf_KEEPCOPY);
11588         if (DEPENDS_SEMANTICS && RExC_uni_semantics) {
11589             set_regex_charset(&RExC_flags, REGEX_UNICODE_CHARSET);
11590         }
11591         if (RExC_parse >= RExC_end || UCHARAT(RExC_parse) != ')') {
11592             RExC_parse = oregcomp_parse;
11593             vFAIL("Unmatched (");
11594         }
11595         nextchar(pRExC_state);
11596     }
11597     else if (!paren && RExC_parse < RExC_end) {
11598         if (*RExC_parse == ')') {
11599             RExC_parse++;
11600             vFAIL("Unmatched )");
11601         }
11602         else
11603             FAIL("Junk on end of regexp");      /* "Can't happen". */
11604         NOT_REACHED; /* NOTREACHED */
11605     }
11606
11607     if (RExC_in_lookbehind) {
11608         RExC_in_lookbehind--;
11609     }
11610     if (after_freeze > RExC_npar)
11611         RExC_npar = after_freeze;
11612     return(ret);
11613 }
11614
11615 /*
11616  - regbranch - one alternative of an | operator
11617  *
11618  * Implements the concatenation operator.
11619  *
11620  * Returns NULL, setting *flagp to RESTART_PASS1 if the sizing scan needs to be
11621  * restarted, or'd with NEED_UTF8 if the pattern needs to be upgraded to UTF-8
11622  */
11623 STATIC regnode *
11624 S_regbranch(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, I32 first, U32 depth)
11625 {
11626     regnode *ret;
11627     regnode *chain = NULL;
11628     regnode *latest;
11629     I32 flags = 0, c = 0;
11630     GET_RE_DEBUG_FLAGS_DECL;
11631
11632     PERL_ARGS_ASSERT_REGBRANCH;
11633
11634     DEBUG_PARSE("brnc");
11635
11636     if (first)
11637         ret = NULL;
11638     else {
11639         if (!SIZE_ONLY && RExC_extralen)
11640             ret = reganode(pRExC_state, BRANCHJ,0);
11641         else {
11642             ret = reg_node(pRExC_state, BRANCH);
11643             Set_Node_Length(ret, 1);
11644         }
11645     }
11646
11647     if (!first && SIZE_ONLY)
11648         RExC_extralen += 1;                     /* BRANCHJ */
11649
11650     *flagp = WORST;                     /* Tentatively. */
11651
11652     skip_to_be_ignored_text(pRExC_state, &RExC_parse,
11653                             FALSE /* Don't force to /x */ );
11654     while (RExC_parse < RExC_end && *RExC_parse != '|' && *RExC_parse != ')') {
11655         flags &= ~TRYAGAIN;
11656         latest = regpiece(pRExC_state, &flags,depth+1);
11657         if (latest == NULL) {
11658             if (flags & TRYAGAIN)
11659                 continue;
11660             if (flags & (RESTART_PASS1|NEED_UTF8)) {
11661                 *flagp = flags & (RESTART_PASS1|NEED_UTF8);
11662                 return NULL;
11663             }
11664             FAIL2("panic: regpiece returned NULL, flags=%#" UVxf, (UV) flags);
11665         }
11666         else if (ret == NULL)
11667             ret = latest;
11668         *flagp |= flags&(HASWIDTH|POSTPONED);
11669         if (chain == NULL)      /* First piece. */
11670             *flagp |= flags&SPSTART;
11671         else {
11672             /* FIXME adding one for every branch after the first is probably
11673              * excessive now we have TRIE support. (hv) */
11674             MARK_NAUGHTY(1);
11675             REGTAIL(pRExC_state, chain, latest);
11676         }
11677         chain = latest;
11678         c++;
11679     }
11680     if (chain == NULL) {        /* Loop ran zero times. */
11681         chain = reg_node(pRExC_state, NOTHING);
11682         if (ret == NULL)
11683             ret = chain;
11684     }
11685     if (c == 1) {
11686         *flagp |= flags&SIMPLE;
11687     }
11688
11689     return ret;
11690 }
11691
11692 /*
11693  - regpiece - something followed by possible quantifier * + ? {n,m}
11694  *
11695  * Note that the branching code sequences used for ? and the general cases
11696  * of * and + are somewhat optimized:  they use the same NOTHING node as
11697  * both the endmarker for their branch list and the body of the last branch.
11698  * It might seem that this node could be dispensed with entirely, but the
11699  * endmarker role is not redundant.
11700  *
11701  * Returns NULL, setting *flagp to TRYAGAIN if regatom() returns NULL with
11702  * TRYAGAIN.
11703  * Returns NULL, setting *flagp to RESTART_PASS1 if the sizing scan needs to be
11704  * restarted, or'd with NEED_UTF8 if the pattern needs to be upgraded to UTF-8
11705  */
11706 STATIC regnode *
11707 S_regpiece(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
11708 {
11709     regnode *ret;
11710     char op;
11711     char *next;
11712     I32 flags;
11713     const char * const origparse = RExC_parse;
11714     I32 min;
11715     I32 max = REG_INFTY;
11716 #ifdef RE_TRACK_PATTERN_OFFSETS
11717     char *parse_start;
11718 #endif
11719     const char *maxpos = NULL;
11720     UV uv;
11721
11722     /* Save the original in case we change the emitted regop to a FAIL. */
11723     regnode * const orig_emit = RExC_emit;
11724
11725     GET_RE_DEBUG_FLAGS_DECL;
11726
11727     PERL_ARGS_ASSERT_REGPIECE;
11728
11729     DEBUG_PARSE("piec");
11730
11731     ret = regatom(pRExC_state, &flags,depth+1);
11732     if (ret == NULL) {
11733         if (flags & (TRYAGAIN|RESTART_PASS1|NEED_UTF8))
11734             *flagp |= flags & (TRYAGAIN|RESTART_PASS1|NEED_UTF8);
11735         else
11736             FAIL2("panic: regatom returned NULL, flags=%#" UVxf, (UV) flags);
11737         return(NULL);
11738     }
11739
11740     op = *RExC_parse;
11741
11742     if (op == '{' && regcurly(RExC_parse)) {
11743         maxpos = NULL;
11744 #ifdef RE_TRACK_PATTERN_OFFSETS
11745         parse_start = RExC_parse; /* MJD */
11746 #endif
11747         next = RExC_parse + 1;
11748         while (isDIGIT(*next) || *next == ',') {
11749             if (*next == ',') {
11750                 if (maxpos)
11751                     break;
11752                 else
11753                     maxpos = next;
11754             }
11755             next++;
11756         }
11757         if (*next == '}') {             /* got one */
11758             const char* endptr;
11759             if (!maxpos)
11760                 maxpos = next;
11761             RExC_parse++;
11762             if (isDIGIT(*RExC_parse)) {
11763                 if (!grok_atoUV(RExC_parse, &uv, &endptr))
11764                     vFAIL("Invalid quantifier in {,}");
11765                 if (uv >= REG_INFTY)
11766                     vFAIL2("Quantifier in {,} bigger than %d", REG_INFTY - 1);
11767                 min = (I32)uv;
11768             } else {
11769                 min = 0;
11770             }
11771             if (*maxpos == ',')
11772                 maxpos++;
11773             else
11774                 maxpos = RExC_parse;
11775             if (isDIGIT(*maxpos)) {
11776                 if (!grok_atoUV(maxpos, &uv, &endptr))
11777                     vFAIL("Invalid quantifier in {,}");
11778                 if (uv >= REG_INFTY)
11779                     vFAIL2("Quantifier in {,} bigger than %d", REG_INFTY - 1);
11780                 max = (I32)uv;
11781             } else {
11782                 max = REG_INFTY;                /* meaning "infinity" */
11783             }
11784             RExC_parse = next;
11785             nextchar(pRExC_state);
11786             if (max < min) {    /* If can't match, warn and optimize to fail
11787                                    unconditionally */
11788                 reginsert(pRExC_state, OPFAIL, orig_emit, depth+1);
11789                 if (PASS2) {
11790                     ckWARNreg(RExC_parse, "Quantifier {n,m} with n > m can't match");
11791                     NEXT_OFF(orig_emit)= regarglen[OPFAIL] + NODE_STEP_REGNODE;
11792                 }
11793                 return ret;
11794             }
11795             else if (min == max && *RExC_parse == '?')
11796             {
11797                 if (PASS2) {
11798                     ckWARN2reg(RExC_parse + 1,
11799                                "Useless use of greediness modifier '%c'",
11800                                *RExC_parse);
11801                 }
11802             }
11803
11804           do_curly:
11805             if ((flags&SIMPLE)) {
11806                 if (min == 0 && max == REG_INFTY) {
11807                     reginsert(pRExC_state, STAR, ret, depth+1);
11808                     MARK_NAUGHTY(4);
11809                     RExC_seen |= REG_UNBOUNDED_QUANTIFIER_SEEN;
11810                     goto nest_check;
11811                 }
11812                 if (min == 1 && max == REG_INFTY) {
11813                     reginsert(pRExC_state, PLUS, ret, depth+1);
11814                     MARK_NAUGHTY(3);
11815                     RExC_seen |= REG_UNBOUNDED_QUANTIFIER_SEEN;
11816                     goto nest_check;
11817                 }
11818                 MARK_NAUGHTY_EXP(2, 2);
11819                 reginsert(pRExC_state, CURLY, ret, depth+1);
11820                 Set_Node_Offset(ret, parse_start+1); /* MJD */
11821                 Set_Node_Cur_Length(ret, parse_start);
11822             }
11823             else {
11824                 regnode * const w = reg_node(pRExC_state, WHILEM);
11825
11826                 w->flags = 0;
11827                 REGTAIL(pRExC_state, ret, w);
11828                 if (!SIZE_ONLY && RExC_extralen) {
11829                     reginsert(pRExC_state, LONGJMP,ret, depth+1);
11830                     reginsert(pRExC_state, NOTHING,ret, depth+1);
11831                     NEXT_OFF(ret) = 3;  /* Go over LONGJMP. */
11832                 }
11833                 reginsert(pRExC_state, CURLYX,ret, depth+1);
11834                                 /* MJD hk */
11835                 Set_Node_Offset(ret, parse_start+1);
11836                 Set_Node_Length(ret,
11837                                 op == '{' ? (RExC_parse - parse_start) : 1);
11838
11839                 if (!SIZE_ONLY && RExC_extralen)
11840                     NEXT_OFF(ret) = 3;  /* Go over NOTHING to LONGJMP. */
11841                 REGTAIL(pRExC_state, ret, reg_node(pRExC_state, NOTHING));
11842                 if (SIZE_ONLY)
11843                     RExC_whilem_seen++, RExC_extralen += 3;
11844                 MARK_NAUGHTY_EXP(1, 4);     /* compound interest */
11845             }
11846             ret->flags = 0;
11847
11848             if (min > 0)
11849                 *flagp = WORST;
11850             if (max > 0)
11851                 *flagp |= HASWIDTH;
11852             if (!SIZE_ONLY) {
11853                 ARG1_SET(ret, (U16)min);
11854                 ARG2_SET(ret, (U16)max);
11855             }
11856             if (max == REG_INFTY)
11857                 RExC_seen |= REG_UNBOUNDED_QUANTIFIER_SEEN;
11858
11859             goto nest_check;
11860         }
11861     }
11862
11863     if (!ISMULT1(op)) {
11864         *flagp = flags;
11865         return(ret);
11866     }
11867
11868 #if 0                           /* Now runtime fix should be reliable. */
11869
11870     /* if this is reinstated, don't forget to put this back into perldiag:
11871
11872             =item Regexp *+ operand could be empty at {#} in regex m/%s/
11873
11874            (F) The part of the regexp subject to either the * or + quantifier
11875            could match an empty string. The {#} shows in the regular
11876            expression about where the problem was discovered.
11877
11878     */
11879
11880     if (!(flags&HASWIDTH) && op != '?')
11881       vFAIL("Regexp *+ operand could be empty");
11882 #endif
11883
11884 #ifdef RE_TRACK_PATTERN_OFFSETS
11885     parse_start = RExC_parse;
11886 #endif
11887     nextchar(pRExC_state);
11888
11889     *flagp = (op != '+') ? (WORST|SPSTART|HASWIDTH) : (WORST|HASWIDTH);
11890
11891     if (op == '*') {
11892         min = 0;
11893         goto do_curly;
11894     }
11895     else if (op == '+') {
11896         min = 1;
11897         goto do_curly;
11898     }
11899     else if (op == '?') {
11900         min = 0; max = 1;
11901         goto do_curly;
11902     }
11903   nest_check:
11904     if (!SIZE_ONLY && !(flags&(HASWIDTH|POSTPONED)) && max > REG_INFTY/3) {
11905         SAVEFREESV(RExC_rx_sv); /* in case of fatal warnings */
11906         ckWARN2reg(RExC_parse,
11907                    "%" UTF8f " matches null string many times",
11908                    UTF8fARG(UTF, (RExC_parse >= origparse
11909                                  ? RExC_parse - origparse
11910                                  : 0),
11911                    origparse));
11912         (void)ReREFCNT_inc(RExC_rx_sv);
11913     }
11914
11915     if (*RExC_parse == '?') {
11916         nextchar(pRExC_state);
11917         reginsert(pRExC_state, MINMOD, ret, depth+1);
11918         REGTAIL(pRExC_state, ret, ret + NODE_STEP_REGNODE);
11919     }
11920     else if (*RExC_parse == '+') {
11921         regnode *ender;
11922         nextchar(pRExC_state);
11923         ender = reg_node(pRExC_state, SUCCEED);
11924         REGTAIL(pRExC_state, ret, ender);
11925         reginsert(pRExC_state, SUSPEND, ret, depth+1);
11926         ender = reg_node(pRExC_state, TAIL);
11927         REGTAIL(pRExC_state, ret, ender);
11928     }
11929
11930     if (ISMULT2(RExC_parse)) {
11931         RExC_parse++;
11932         vFAIL("Nested quantifiers");
11933     }
11934
11935     return(ret);
11936 }
11937
11938 STATIC bool
11939 S_grok_bslash_N(pTHX_ RExC_state_t *pRExC_state,
11940                 regnode ** node_p,
11941                 UV * code_point_p,
11942                 int * cp_count,
11943                 I32 * flagp,
11944                 const bool strict,
11945                 const U32 depth
11946     )
11947 {
11948  /* This routine teases apart the various meanings of \N and returns
11949   * accordingly.  The input parameters constrain which meaning(s) is/are valid
11950   * in the current context.
11951   *
11952   * Exactly one of <node_p> and <code_point_p> must be non-NULL.
11953   *
11954   * If <code_point_p> is not NULL, the context is expecting the result to be a
11955   * single code point.  If this \N instance turns out to a single code point,
11956   * the function returns TRUE and sets *code_point_p to that code point.
11957   *
11958   * If <node_p> is not NULL, the context is expecting the result to be one of
11959   * the things representable by a regnode.  If this \N instance turns out to be
11960   * one such, the function generates the regnode, returns TRUE and sets *node_p
11961   * to point to that regnode.
11962   *
11963   * If this instance of \N isn't legal in any context, this function will
11964   * generate a fatal error and not return.
11965   *
11966   * On input, RExC_parse should point to the first char following the \N at the
11967   * time of the call.  On successful return, RExC_parse will have been updated
11968   * to point to just after the sequence identified by this routine.  Also
11969   * *flagp has been updated as needed.
11970   *
11971   * When there is some problem with the current context and this \N instance,
11972   * the function returns FALSE, without advancing RExC_parse, nor setting
11973   * *node_p, nor *code_point_p, nor *flagp.
11974   *
11975   * If <cp_count> is not NULL, the caller wants to know the length (in code
11976   * points) that this \N sequence matches.  This is set even if the function
11977   * returns FALSE, as detailed below.
11978   *
11979   * There are 5 possibilities here, as detailed in the next 5 paragraphs.
11980   *
11981   * Probably the most common case is for the \N to specify a single code point.
11982   * *cp_count will be set to 1, and *code_point_p will be set to that code
11983   * point.
11984   *
11985   * Another possibility is for the input to be an empty \N{}, which for
11986   * backwards compatibility we accept.  *cp_count will be set to 0. *node_p
11987   * will be set to a generated NOTHING node.
11988   *
11989   * Still another possibility is for the \N to mean [^\n]. *cp_count will be
11990   * set to 0. *node_p will be set to a generated REG_ANY node.
11991   *
11992   * The fourth possibility is that \N resolves to a sequence of more than one
11993   * code points.  *cp_count will be set to the number of code points in the
11994   * sequence. *node_p * will be set to a generated node returned by this
11995   * function calling S_reg().
11996   *
11997   * The final possibility is that it is premature to be calling this function;
11998   * that pass1 needs to be restarted.  This can happen when this changes from
11999   * /d to /u rules, or when the pattern needs to be upgraded to UTF-8.  The
12000   * latter occurs only when the fourth possibility would otherwise be in
12001   * effect, and is because one of those code points requires the pattern to be
12002   * recompiled as UTF-8.  The function returns FALSE, and sets the
12003   * RESTART_PASS1 and NEED_UTF8 flags in *flagp, as appropriate.  When this
12004   * happens, the caller needs to desist from continuing parsing, and return
12005   * this information to its caller.  This is not set for when there is only one
12006   * code point, as this can be called as part of an ANYOF node, and they can
12007   * store above-Latin1 code points without the pattern having to be in UTF-8.
12008   *
12009   * For non-single-quoted regexes, the tokenizer has resolved character and
12010   * sequence names inside \N{...} into their Unicode values, normalizing the
12011   * result into what we should see here: '\N{U+c1.c2...}', where c1... are the
12012   * hex-represented code points in the sequence.  This is done there because
12013   * the names can vary based on what charnames pragma is in scope at the time,
12014   * so we need a way to take a snapshot of what they resolve to at the time of
12015   * the original parse. [perl #56444].
12016   *
12017   * That parsing is skipped for single-quoted regexes, so we may here get
12018   * '\N{NAME}'.  This is a fatal error.  These names have to be resolved by the
12019   * parser.  But if the single-quoted regex is something like '\N{U+41}', that
12020   * is legal and handled here.  The code point is Unicode, and has to be
12021   * translated into the native character set for non-ASCII platforms.
12022   */
12023
12024     char * endbrace;    /* points to '}' following the name */
12025     char *endchar;      /* Points to '.' or '}' ending cur char in the input
12026                            stream */
12027     char* p = RExC_parse; /* Temporary */
12028
12029     GET_RE_DEBUG_FLAGS_DECL;
12030
12031     PERL_ARGS_ASSERT_GROK_BSLASH_N;
12032
12033     GET_RE_DEBUG_FLAGS;
12034
12035     assert(cBOOL(node_p) ^ cBOOL(code_point_p));  /* Exactly one should be set */
12036     assert(! (node_p && cp_count));               /* At most 1 should be set */
12037
12038     if (cp_count) {     /* Initialize return for the most common case */
12039         *cp_count = 1;
12040     }
12041
12042     /* The [^\n] meaning of \N ignores spaces and comments under the /x
12043      * modifier.  The other meanings do not, so use a temporary until we find
12044      * out which we are being called with */
12045     skip_to_be_ignored_text(pRExC_state, &p,
12046                             FALSE /* Don't force to /x */ );
12047
12048     /* Disambiguate between \N meaning a named character versus \N meaning
12049      * [^\n].  The latter is assumed when the {...} following the \N is a legal
12050      * quantifier, or there is no '{' at all */
12051     if (*p != '{' || regcurly(p)) {
12052         RExC_parse = p;
12053         if (cp_count) {
12054             *cp_count = -1;
12055         }
12056
12057         if (! node_p) {
12058             return FALSE;
12059         }
12060
12061         *node_p = reg_node(pRExC_state, REG_ANY);
12062         *flagp |= HASWIDTH|SIMPLE;
12063         MARK_NAUGHTY(1);
12064         Set_Node_Length(*node_p, 1); /* MJD */
12065         return TRUE;
12066     }
12067
12068     /* Here, we have decided it should be a named character or sequence */
12069
12070     /* The test above made sure that the next real character is a '{', but
12071      * under the /x modifier, it could be separated by space (or a comment and
12072      * \n) and this is not allowed (for consistency with \x{...} and the
12073      * tokenizer handling of \N{NAME}). */
12074     if (*RExC_parse != '{') {
12075         vFAIL("Missing braces on \\N{}");
12076     }
12077
12078     RExC_parse++;       /* Skip past the '{' */
12079
12080     endbrace = (char *) memchr(RExC_parse, '}', RExC_end - RExC_parse);
12081     if (! endbrace) { /* no trailing brace */
12082         vFAIL2("Missing right brace on \\%c{}", 'N');
12083     }
12084     else if (!(   endbrace == RExC_parse        /* nothing between the {} */
12085                || memBEGINs(RExC_parse,   /* U+ (bad hex is checked below
12086                                                    for a  better error msg) */
12087                                   (STRLEN) (RExC_end - RExC_parse),
12088                                  "U+")))
12089     {
12090         RExC_parse = endbrace;  /* position msg's '<--HERE' */
12091         vFAIL("\\N{NAME} must be resolved by the lexer");
12092     }
12093
12094     REQUIRE_UNI_RULES(flagp, FALSE); /* Unicode named chars imply Unicode
12095                                         semantics */
12096
12097     if (endbrace == RExC_parse) {   /* empty: \N{} */
12098         if (strict) {
12099             RExC_parse++;   /* Position after the "}" */
12100             vFAIL("Zero length \\N{}");
12101         }
12102         if (cp_count) {
12103             *cp_count = 0;
12104         }
12105         nextchar(pRExC_state);
12106         if (! node_p) {
12107             return FALSE;
12108         }
12109
12110         *node_p = reg_node(pRExC_state,NOTHING);
12111         return TRUE;
12112     }
12113
12114     RExC_parse += 2;    /* Skip past the 'U+' */
12115
12116     /* Because toke.c has generated a special construct for us guaranteed not
12117      * to have NULs, we can use a str function */
12118     endchar = RExC_parse + strcspn(RExC_parse, ".}");
12119
12120     /* Code points are separated by dots.  If none, there is only one code
12121      * point, and is terminated by the brace */
12122
12123     if (endchar >= endbrace) {
12124         STRLEN length_of_hex;
12125         I32 grok_hex_flags;
12126
12127         /* Here, exactly one code point.  If that isn't what is wanted, fail */
12128         if (! code_point_p) {
12129             RExC_parse = p;
12130             return FALSE;
12131         }
12132
12133         /* Convert code point from hex */
12134         length_of_hex = (STRLEN)(endchar - RExC_parse);
12135         grok_hex_flags = PERL_SCAN_ALLOW_UNDERSCORES
12136                        | PERL_SCAN_DISALLOW_PREFIX
12137
12138                            /* No errors in the first pass (See [perl
12139                             * #122671].)  We let the code below find the
12140                             * errors when there are multiple chars. */
12141                        | ((SIZE_ONLY)
12142                           ? PERL_SCAN_SILENT_ILLDIGIT
12143                           : 0);
12144
12145         /* This routine is the one place where both single- and double-quotish
12146          * \N{U+xxxx} are evaluated.  The value is a Unicode code point which
12147          * must be converted to native. */
12148         *code_point_p = UNI_TO_NATIVE(grok_hex(RExC_parse,
12149                                                &length_of_hex,
12150                                                &grok_hex_flags,
12151                                                NULL));
12152
12153         /* The tokenizer should have guaranteed validity, but it's possible to
12154          * bypass it by using single quoting, so check.  Don't do the check
12155          * here when there are multiple chars; we do it below anyway. */
12156         if (length_of_hex == 0
12157             || length_of_hex != (STRLEN)(endchar - RExC_parse) )
12158         {
12159             RExC_parse += length_of_hex;        /* Includes all the valid */
12160             RExC_parse += (RExC_orig_utf8)      /* point to after 1st invalid */
12161                             ? UTF8SKIP(RExC_parse)
12162                             : 1;
12163             /* Guard against malformed utf8 */
12164             if (RExC_parse >= endchar) {
12165                 RExC_parse = endchar;
12166             }
12167             vFAIL("Invalid hexadecimal number in \\N{U+...}");
12168         }
12169
12170         RExC_parse = endbrace + 1;
12171         return TRUE;
12172     }
12173     else {  /* Is a multiple character sequence */
12174         SV * substitute_parse;
12175         STRLEN len;
12176         char *orig_end = RExC_end;
12177         char *save_start = RExC_start;
12178         I32 flags;
12179
12180         /* Count the code points, if desired, in the sequence */
12181         if (cp_count) {
12182             *cp_count = 0;
12183             while (RExC_parse < endbrace) {
12184                 /* Point to the beginning of the next character in the sequence. */
12185                 RExC_parse = endchar + 1;
12186                 endchar = RExC_parse + strcspn(RExC_parse, ".}");
12187                 (*cp_count)++;
12188             }
12189         }
12190
12191         /* Fail if caller doesn't want to handle a multi-code-point sequence.
12192          * But don't backup up the pointer if the caller wants to know how many
12193          * code points there are (they can then handle things) */
12194         if (! node_p) {
12195             if (! cp_count) {
12196                 RExC_parse = p;
12197             }
12198             return FALSE;
12199         }
12200
12201         /* What is done here is to convert this to a sub-pattern of the form
12202          * \x{char1}\x{char2}...  and then call reg recursively to parse it
12203          * (enclosing in "(?: ... )" ).  That way, it retains its atomicness,
12204          * while not having to worry about special handling that some code
12205          * points may have. */
12206
12207         substitute_parse = newSVpvs("?:");
12208
12209         while (RExC_parse < endbrace) {
12210
12211             /* Convert to notation the rest of the code understands */
12212             sv_catpv(substitute_parse, "\\x{");
12213             sv_catpvn(substitute_parse, RExC_parse, endchar - RExC_parse);
12214             sv_catpv(substitute_parse, "}");
12215
12216             /* Point to the beginning of the next character in the sequence. */
12217             RExC_parse = endchar + 1;
12218             endchar = RExC_parse + strcspn(RExC_parse, ".}");
12219
12220         }
12221         sv_catpv(substitute_parse, ")");
12222
12223         len = SvCUR(substitute_parse);
12224
12225         /* Don't allow empty number */
12226         if (len < (STRLEN) 8) {
12227             RExC_parse = endbrace;
12228             vFAIL("Invalid hexadecimal number in \\N{U+...}");
12229         }
12230
12231         RExC_parse = RExC_start = RExC_adjusted_start
12232                                               = SvPV_nolen(substitute_parse);
12233         RExC_end = RExC_parse + len;
12234
12235         /* The values are Unicode, and therefore not subject to recoding, but
12236          * have to be converted to native on a non-Unicode (meaning non-ASCII)
12237          * platform. */
12238 #ifdef EBCDIC
12239         RExC_recode_x_to_native = 1;
12240 #endif
12241
12242         *node_p = reg(pRExC_state, 1, &flags, depth+1);
12243
12244         /* Restore the saved values */
12245         RExC_start = RExC_adjusted_start = save_start;
12246         RExC_parse = endbrace;
12247         RExC_end = orig_end;
12248 #ifdef EBCDIC
12249         RExC_recode_x_to_native = 0;
12250 #endif
12251         SvREFCNT_dec_NN(substitute_parse);
12252
12253         if (! *node_p) {
12254             if (flags & (RESTART_PASS1|NEED_UTF8)) {
12255                 *flagp = flags & (RESTART_PASS1|NEED_UTF8);
12256                 return FALSE;
12257             }
12258             FAIL2("panic: reg returned NULL to grok_bslash_N, flags=%#" UVxf,
12259                 (UV) flags);
12260         }
12261         *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
12262
12263         nextchar(pRExC_state);
12264
12265         return TRUE;
12266     }
12267 }
12268
12269
12270 PERL_STATIC_INLINE U8
12271 S_compute_EXACTish(RExC_state_t *pRExC_state)
12272 {
12273     U8 op;
12274
12275     PERL_ARGS_ASSERT_COMPUTE_EXACTISH;
12276
12277     if (! FOLD) {
12278         return (LOC)
12279                 ? EXACTL
12280                 : EXACT;
12281     }
12282
12283     op = get_regex_charset(RExC_flags);
12284     if (op >= REGEX_ASCII_RESTRICTED_CHARSET) {
12285         op--; /* /a is same as /u, and map /aa's offset to what /a's would have
12286                  been, so there is no hole */
12287     }
12288
12289     return op + EXACTF;
12290 }
12291
12292 PERL_STATIC_INLINE void
12293 S_alloc_maybe_populate_EXACT(pTHX_ RExC_state_t *pRExC_state,
12294                          regnode *node, I32* flagp, STRLEN len, UV code_point,
12295                          bool downgradable)
12296 {
12297     /* This knows the details about sizing an EXACTish node, setting flags for
12298      * it (by setting <*flagp>, and potentially populating it with a single
12299      * character.
12300      *
12301      * If <len> (the length in bytes) is non-zero, this function assumes that
12302      * the node has already been populated, and just does the sizing.  In this
12303      * case <code_point> should be the final code point that has already been
12304      * placed into the node.  This value will be ignored except that under some
12305      * circumstances <*flagp> is set based on it.
12306      *
12307      * If <len> is zero, the function assumes that the node is to contain only
12308      * the single character given by <code_point> and calculates what <len>
12309      * should be.  In pass 1, it sizes the node appropriately.  In pass 2, it
12310      * additionally will populate the node's STRING with <code_point> or its
12311      * fold if folding.
12312      *
12313      * In both cases <*flagp> is appropriately set
12314      *
12315      * It knows that under FOLD, the Latin Sharp S and UTF characters above
12316      * 255, must be folded (the former only when the rules indicate it can
12317      * match 'ss')
12318      *
12319      * When it does the populating, it looks at the flag 'downgradable'.  If
12320      * true with a node that folds, it checks if the single code point
12321      * participates in a fold, and if not downgrades the node to an EXACT.
12322      * This helps the optimizer */
12323
12324     bool len_passed_in = cBOOL(len != 0);
12325     U8 character[UTF8_MAXBYTES_CASE+1];
12326
12327     PERL_ARGS_ASSERT_ALLOC_MAYBE_POPULATE_EXACT;
12328
12329     /* Don't bother to check for downgrading in PASS1, as it doesn't make any
12330      * sizing difference, and is extra work that is thrown away */
12331     if (downgradable && ! PASS2) {
12332         downgradable = FALSE;
12333     }
12334
12335     if (! len_passed_in) {
12336         if (UTF) {
12337             if (UVCHR_IS_INVARIANT(code_point)) {
12338                 if (LOC || ! FOLD) {    /* /l defers folding until runtime */
12339                     *character = (U8) code_point;
12340                 }
12341                 else { /* Here is /i and not /l. (toFOLD() is defined on just
12342                           ASCII, which isn't the same thing as INVARIANT on
12343                           EBCDIC, but it works there, as the extra invariants
12344                           fold to themselves) */
12345                     *character = toFOLD((U8) code_point);
12346
12347                     /* We can downgrade to an EXACT node if this character
12348                      * isn't a folding one.  Note that this assumes that
12349                      * nothing above Latin1 folds to some other invariant than
12350                      * one of these alphabetics; otherwise we would also have
12351                      * to check:
12352                      *  && (! HAS_NONLATIN1_FOLD_CLOSURE(code_point)
12353                      *      || ASCII_FOLD_RESTRICTED))
12354                      */
12355                     if (downgradable && PL_fold[code_point] == code_point) {
12356                         OP(node) = EXACT;
12357                     }
12358                 }
12359                 len = 1;
12360             }
12361             else if (FOLD && (! LOC
12362                               || ! is_PROBLEMATIC_LOCALE_FOLD_cp(code_point)))
12363             {   /* Folding, and ok to do so now */
12364                 UV folded = _to_uni_fold_flags(
12365                                    code_point,
12366                                    character,
12367                                    &len,
12368                                    FOLD_FLAGS_FULL | ((ASCII_FOLD_RESTRICTED)
12369                                                       ? FOLD_FLAGS_NOMIX_ASCII
12370                                                       : 0));
12371                 if (downgradable
12372                     && folded == code_point /* This quickly rules out many
12373                                                cases, avoiding the
12374                                                _invlist_contains_cp() overhead
12375                                                for those.  */
12376                     && ! _invlist_contains_cp(PL_utf8_foldable, code_point))
12377                 {
12378                     OP(node) = (LOC)
12379                                ? EXACTL
12380                                : EXACT;
12381                 }
12382             }
12383             else if (code_point <= MAX_UTF8_TWO_BYTE) {
12384
12385                 /* Not folding this cp, and can output it directly */
12386                 *character = UTF8_TWO_BYTE_HI(code_point);
12387                 *(character + 1) = UTF8_TWO_BYTE_LO(code_point);
12388                 len = 2;
12389             }
12390             else {
12391                 uvchr_to_utf8( character, code_point);
12392                 len = UTF8SKIP(character);
12393             }
12394         } /* Else pattern isn't UTF8.  */
12395         else if (! FOLD) {
12396             *character = (U8) code_point;
12397             len = 1;
12398         } /* Else is folded non-UTF8 */
12399 #if    UNICODE_MAJOR_VERSION > 3 /* no multifolds in early Unicode */   \
12400    || (UNICODE_MAJOR_VERSION == 3 && (   UNICODE_DOT_VERSION > 0)       \
12401                                       || UNICODE_DOT_DOT_VERSION > 0)
12402         else if (LIKELY(code_point != LATIN_SMALL_LETTER_SHARP_S)) {
12403 #else
12404         else if (1) {
12405 #endif
12406             /* We don't fold any non-UTF8 except possibly the Sharp s  (see
12407              * comments at join_exact()); */
12408             *character = (U8) code_point;
12409             len = 1;
12410
12411             /* Can turn into an EXACT node if we know the fold at compile time,
12412              * and it folds to itself and doesn't particpate in other folds */
12413             if (downgradable
12414                 && ! LOC
12415                 && PL_fold_latin1[code_point] == code_point
12416                 && (! HAS_NONLATIN1_FOLD_CLOSURE(code_point)
12417                     || (isASCII(code_point) && ASCII_FOLD_RESTRICTED)))
12418             {
12419                 OP(node) = EXACT;
12420             }
12421         } /* else is Sharp s.  May need to fold it */
12422         else if (AT_LEAST_UNI_SEMANTICS && ! ASCII_FOLD_RESTRICTED) {
12423             *character = 's';
12424             *(character + 1) = 's';
12425             len = 2;
12426         }
12427         else {
12428             *character = LATIN_SMALL_LETTER_SHARP_S;
12429             len = 1;
12430         }
12431     }
12432
12433     if (SIZE_ONLY) {
12434         RExC_size += STR_SZ(len);
12435     }
12436     else {
12437         RExC_emit += STR_SZ(len);
12438         STR_LEN(node) = len;
12439         if (! len_passed_in) {
12440             Copy((char *) character, STRING(node), len, char);
12441         }
12442     }
12443
12444     *flagp |= HASWIDTH;
12445
12446     /* A single character node is SIMPLE, except for the special-cased SHARP S
12447      * under /di. */
12448     if ((len == 1 || (UTF && len == UVCHR_SKIP(code_point)))
12449 #if    UNICODE_MAJOR_VERSION > 3 /* no multifolds in early Unicode */   \
12450    || (UNICODE_MAJOR_VERSION == 3 && (   UNICODE_DOT_VERSION > 0)       \
12451                                       || UNICODE_DOT_DOT_VERSION > 0)
12452         && ( code_point != LATIN_SMALL_LETTER_SHARP_S
12453             || ! FOLD || ! DEPENDS_SEMANTICS)
12454 #endif
12455     ) {
12456         *flagp |= SIMPLE;
12457     }
12458
12459     /* The OP may not be well defined in PASS1 */
12460     if (PASS2 && OP(node) == EXACTFL) {
12461         RExC_contains_locale = 1;
12462     }
12463 }
12464
12465 STATIC bool
12466 S_new_regcurly(const char *s, const char *e)
12467 {
12468     /* This is a temporary function designed to match the most lenient form of
12469      * a {m,n} quantifier we ever envision, with either number omitted, and
12470      * spaces anywhere between/before/after them.
12471      *
12472      * If this function fails, then the string it matches is very unlikely to
12473      * ever be considered a valid quantifier, so we can allow the '{' that
12474      * begins it to be considered as a literal */
12475
12476     bool has_min = FALSE;
12477     bool has_max = FALSE;
12478
12479     PERL_ARGS_ASSERT_NEW_REGCURLY;
12480
12481     if (s >= e || *s++ != '{')
12482         return FALSE;
12483
12484     while (s < e && isSPACE(*s)) {
12485         s++;
12486     }
12487     while (s < e && isDIGIT(*s)) {
12488         has_min = TRUE;
12489         s++;
12490     }
12491     while (s < e && isSPACE(*s)) {
12492         s++;
12493     }
12494
12495     if (*s == ',') {
12496         s++;
12497         while (s < e && isSPACE(*s)) {
12498             s++;
12499         }
12500         while (s < e && isDIGIT(*s)) {
12501             has_max = TRUE;
12502             s++;
12503         }
12504         while (s < e && isSPACE(*s)) {
12505             s++;
12506         }
12507     }
12508
12509     return s < e && *s == '}' && (has_min || has_max);
12510 }
12511
12512 /* Parse backref decimal value, unless it's too big to sensibly be a backref,
12513  * in which case return I32_MAX (rather than possibly 32-bit wrapping) */
12514
12515 static I32
12516 S_backref_value(char *p)
12517 {
12518     const char* endptr;
12519     UV val;
12520     if (grok_atoUV(p, &val, &endptr) && val <= I32_MAX)
12521         return (I32)val;
12522     return I32_MAX;
12523 }
12524
12525
12526 /*
12527  - regatom - the lowest level
12528
12529    Try to identify anything special at the start of the current parse position.
12530    If there is, then handle it as required. This may involve generating a
12531    single regop, such as for an assertion; or it may involve recursing, such as
12532    to handle a () structure.
12533
12534    If the string doesn't start with something special then we gobble up
12535    as much literal text as we can.  If we encounter a quantifier, we have to
12536    back off the final literal character, as that quantifier applies to just it
12537    and not to the whole string of literals.
12538
12539    Once we have been able to handle whatever type of thing started the
12540    sequence, we return.
12541
12542    Note: we have to be careful with escapes, as they can be both literal
12543    and special, and in the case of \10 and friends, context determines which.
12544
12545    A summary of the code structure is:
12546
12547    switch (first_byte) {
12548         cases for each special:
12549             handle this special;
12550             break;
12551         case '\\':
12552             switch (2nd byte) {
12553                 cases for each unambiguous special:
12554                     handle this special;
12555                     break;
12556                 cases for each ambigous special/literal:
12557                     disambiguate;
12558                     if (special)  handle here
12559                     else goto defchar;
12560                 default: // unambiguously literal:
12561                     goto defchar;
12562             }
12563         default:  // is a literal char
12564             // FALL THROUGH
12565         defchar:
12566             create EXACTish node for literal;
12567             while (more input and node isn't full) {
12568                 switch (input_byte) {
12569                    cases for each special;
12570                        make sure parse pointer is set so that the next call to
12571                            regatom will see this special first
12572                        goto loopdone; // EXACTish node terminated by prev. char
12573                    default:
12574                        append char to EXACTISH node;
12575                 }
12576                 get next input byte;
12577             }
12578         loopdone:
12579    }
12580    return the generated node;
12581
12582    Specifically there are two separate switches for handling
12583    escape sequences, with the one for handling literal escapes requiring
12584    a dummy entry for all of the special escapes that are actually handled
12585    by the other.
12586
12587    Returns NULL, setting *flagp to TRYAGAIN if reg() returns NULL with
12588    TRYAGAIN.
12589    Returns NULL, setting *flagp to RESTART_PASS1 if the sizing scan needs to be
12590    restarted, or'd with NEED_UTF8 if the pattern needs to be upgraded to UTF-8
12591    Otherwise does not return NULL.
12592 */
12593
12594 STATIC regnode *
12595 S_regatom(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
12596 {
12597     regnode *ret = NULL;
12598     I32 flags = 0;
12599     char *parse_start;
12600     U8 op;
12601     int invert = 0;
12602     U8 arg;
12603
12604     GET_RE_DEBUG_FLAGS_DECL;
12605
12606     *flagp = WORST;             /* Tentatively. */
12607
12608     DEBUG_PARSE("atom");
12609
12610     PERL_ARGS_ASSERT_REGATOM;
12611
12612   tryagain:
12613     parse_start = RExC_parse;
12614     assert(RExC_parse < RExC_end);
12615     switch ((U8)*RExC_parse) {
12616     case '^':
12617         RExC_seen_zerolen++;
12618         nextchar(pRExC_state);
12619         if (RExC_flags & RXf_PMf_MULTILINE)
12620             ret = reg_node(pRExC_state, MBOL);
12621         else
12622             ret = reg_node(pRExC_state, SBOL);
12623         Set_Node_Length(ret, 1); /* MJD */
12624         break;
12625     case '$':
12626         nextchar(pRExC_state);
12627         if (*RExC_parse)
12628             RExC_seen_zerolen++;
12629         if (RExC_flags & RXf_PMf_MULTILINE)
12630             ret = reg_node(pRExC_state, MEOL);
12631         else
12632             ret = reg_node(pRExC_state, SEOL);
12633         Set_Node_Length(ret, 1); /* MJD */
12634         break;
12635     case '.':
12636         nextchar(pRExC_state);
12637         if (RExC_flags & RXf_PMf_SINGLELINE)
12638             ret = reg_node(pRExC_state, SANY);
12639         else
12640             ret = reg_node(pRExC_state, REG_ANY);
12641         *flagp |= HASWIDTH|SIMPLE;
12642         MARK_NAUGHTY(1);
12643         Set_Node_Length(ret, 1); /* MJD */
12644         break;
12645     case '[':
12646     {
12647         char * const oregcomp_parse = ++RExC_parse;
12648         ret = regclass(pRExC_state, flagp,depth+1,
12649                        FALSE, /* means parse the whole char class */
12650                        TRUE, /* allow multi-char folds */
12651                        FALSE, /* don't silence non-portable warnings. */
12652                        (bool) RExC_strict,
12653                        TRUE, /* Allow an optimized regnode result */
12654                        NULL,
12655                        NULL);
12656         if (ret == NULL) {
12657             if (*flagp & (RESTART_PASS1|NEED_UTF8))
12658                 return NULL;
12659             FAIL2("panic: regclass returned NULL to regatom, flags=%#" UVxf,
12660                   (UV) *flagp);
12661         }
12662         if (*RExC_parse != ']') {
12663             RExC_parse = oregcomp_parse;
12664             vFAIL("Unmatched [");
12665         }
12666         nextchar(pRExC_state);
12667         Set_Node_Length(ret, RExC_parse - oregcomp_parse + 1); /* MJD */
12668         break;
12669     }
12670     case '(':
12671         nextchar(pRExC_state);
12672         ret = reg(pRExC_state, 2, &flags,depth+1);
12673         if (ret == NULL) {
12674                 if (flags & TRYAGAIN) {
12675                     if (RExC_parse >= RExC_end) {
12676                          /* Make parent create an empty node if needed. */
12677                         *flagp |= TRYAGAIN;
12678                         return(NULL);
12679                     }
12680                     goto tryagain;
12681                 }
12682                 if (flags & (RESTART_PASS1|NEED_UTF8)) {
12683                     *flagp = flags & (RESTART_PASS1|NEED_UTF8);
12684                     return NULL;
12685                 }
12686                 FAIL2("panic: reg returned NULL to regatom, flags=%#" UVxf,
12687                                                                  (UV) flags);
12688         }
12689         *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
12690         break;
12691     case '|':
12692     case ')':
12693         if (flags & TRYAGAIN) {
12694             *flagp |= TRYAGAIN;
12695             return NULL;
12696         }
12697         vFAIL("Internal urp");
12698                                 /* Supposed to be caught earlier. */
12699         break;
12700     case '?':
12701     case '+':
12702     case '*':
12703         RExC_parse++;
12704         vFAIL("Quantifier follows nothing");
12705         break;
12706     case '\\':
12707         /* Special Escapes
12708
12709            This switch handles escape sequences that resolve to some kind
12710            of special regop and not to literal text. Escape sequnces that
12711            resolve to literal text are handled below in the switch marked
12712            "Literal Escapes".
12713
12714            Every entry in this switch *must* have a corresponding entry
12715            in the literal escape switch. However, the opposite is not
12716            required, as the default for this switch is to jump to the
12717            literal text handling code.
12718         */
12719         RExC_parse++;
12720         switch ((U8)*RExC_parse) {
12721         /* Special Escapes */
12722         case 'A':
12723             RExC_seen_zerolen++;
12724             ret = reg_node(pRExC_state, SBOL);
12725             /* SBOL is shared with /^/ so we set the flags so we can tell
12726              * /\A/ from /^/ in split. We check ret because first pass we
12727              * have no regop struct to set the flags on. */
12728             if (PASS2)
12729                 ret->flags = 1;
12730             *flagp |= SIMPLE;
12731             goto finish_meta_pat;
12732         case 'G':
12733             ret = reg_node(pRExC_state, GPOS);
12734             RExC_seen |= REG_GPOS_SEEN;
12735             *flagp |= SIMPLE;
12736             goto finish_meta_pat;
12737         case 'K':
12738             RExC_seen_zerolen++;
12739             ret = reg_node(pRExC_state, KEEPS);
12740             *flagp |= SIMPLE;
12741             /* XXX:dmq : disabling in-place substitution seems to
12742              * be necessary here to avoid cases of memory corruption, as
12743              * with: C<$_="x" x 80; s/x\K/y/> -- rgs
12744              */
12745             RExC_seen |= REG_LOOKBEHIND_SEEN;
12746             goto finish_meta_pat;
12747         case 'Z':
12748             ret = reg_node(pRExC_state, SEOL);
12749             *flagp |= SIMPLE;
12750             RExC_seen_zerolen++;                /* Do not optimize RE away */
12751             goto finish_meta_pat;
12752         case 'z':
12753             ret = reg_node(pRExC_state, EOS);
12754             *flagp |= SIMPLE;
12755             RExC_seen_zerolen++;                /* Do not optimize RE away */
12756             goto finish_meta_pat;
12757         case 'C':
12758             vFAIL("\\C no longer supported");
12759         case 'X':
12760             ret = reg_node(pRExC_state, CLUMP);
12761             *flagp |= HASWIDTH;
12762             goto finish_meta_pat;
12763
12764         case 'W':
12765             invert = 1;
12766             /* FALLTHROUGH */
12767         case 'w':
12768             arg = ANYOF_WORDCHAR;
12769             goto join_posix;
12770
12771         case 'B':
12772             invert = 1;
12773             /* FALLTHROUGH */
12774         case 'b':
12775           {
12776             regex_charset charset = get_regex_charset(RExC_flags);
12777
12778             RExC_seen_zerolen++;
12779             RExC_seen |= REG_LOOKBEHIND_SEEN;
12780             op = BOUND + charset;
12781
12782             if (op == BOUNDL) {
12783                 RExC_contains_locale = 1;
12784             }
12785
12786             ret = reg_node(pRExC_state, op);
12787             *flagp |= SIMPLE;
12788             if (RExC_parse >= RExC_end || *(RExC_parse + 1) != '{') {
12789                 FLAGS(ret) = TRADITIONAL_BOUND;
12790                 if (PASS2 && op > BOUNDA) {  /* /aa is same as /a */
12791                     OP(ret) = BOUNDA;
12792                 }
12793             }
12794             else {
12795                 STRLEN length;
12796                 char name = *RExC_parse;
12797                 char * endbrace = NULL;
12798                 RExC_parse += 2;
12799                 if (RExC_parse < RExC_end) {
12800                     endbrace = (char *) memchr(RExC_parse, '}', RExC_end - RExC_parse);
12801                 }
12802
12803                 if (! endbrace) {
12804                     vFAIL2("Missing right brace on \\%c{}", name);
12805                 }
12806                 /* XXX Need to decide whether to take spaces or not.  Should be
12807                  * consistent with \p{}, but that currently is SPACE, which
12808                  * means vertical too, which seems wrong
12809                  * while (isBLANK(*RExC_parse)) {
12810                     RExC_parse++;
12811                 }*/
12812                 if (endbrace == RExC_parse) {
12813                     RExC_parse++;  /* After the '}' */
12814                     vFAIL2("Empty \\%c{}", name);
12815                 }
12816                 length = endbrace - RExC_parse;
12817                 /*while (isBLANK(*(RExC_parse + length - 1))) {
12818                     length--;
12819                 }*/
12820                 switch (*RExC_parse) {
12821                     case 'g':
12822                         if (    length != 1
12823                             && (memNEs(RExC_parse + 1, length - 1, "cb")))
12824                         {
12825                             goto bad_bound_type;
12826                         }
12827                         FLAGS(ret) = GCB_BOUND;
12828                         break;
12829                     case 'l':
12830                         if (length != 2 || *(RExC_parse + 1) != 'b') {
12831                             goto bad_bound_type;
12832                         }
12833                         FLAGS(ret) = LB_BOUND;
12834                         break;
12835                     case 's':
12836                         if (length != 2 || *(RExC_parse + 1) != 'b') {
12837                             goto bad_bound_type;
12838                         }
12839                         FLAGS(ret) = SB_BOUND;
12840                         break;
12841                     case 'w':
12842                         if (length != 2 || *(RExC_parse + 1) != 'b') {
12843                             goto bad_bound_type;
12844                         }
12845                         FLAGS(ret) = WB_BOUND;
12846                         break;
12847                     default:
12848                       bad_bound_type:
12849                         RExC_parse = endbrace;
12850                         vFAIL2utf8f(
12851                             "'%" UTF8f "' is an unknown bound type",
12852                             UTF8fARG(UTF, length, endbrace - length));
12853                         NOT_REACHED; /*NOTREACHED*/
12854                 }
12855                 RExC_parse = endbrace;
12856                 REQUIRE_UNI_RULES(flagp, NULL);
12857
12858                 if (PASS2 && op >= BOUNDA) {  /* /aa is same as /a */
12859                     OP(ret) = BOUNDU;
12860                     length += 4;
12861
12862                     /* Don't have to worry about UTF-8, in this message because
12863                      * to get here the contents of the \b must be ASCII */
12864                     ckWARN4reg(RExC_parse + 1,  /* Include the '}' in msg */
12865                               "Using /u for '%.*s' instead of /%s",
12866                               (unsigned) length,
12867                               endbrace - length + 1,
12868                               (charset == REGEX_ASCII_RESTRICTED_CHARSET)
12869                               ? ASCII_RESTRICT_PAT_MODS
12870                               : ASCII_MORE_RESTRICT_PAT_MODS);
12871                 }
12872             }
12873
12874             if (PASS2 && invert) {
12875                 OP(ret) += NBOUND - BOUND;
12876             }
12877             goto finish_meta_pat;
12878           }
12879
12880         case 'D':
12881             invert = 1;
12882             /* FALLTHROUGH */
12883         case 'd':
12884             arg = ANYOF_DIGIT;
12885             if (! DEPENDS_SEMANTICS) {
12886                 goto join_posix;
12887             }
12888
12889             /* \d doesn't have any matches in the upper Latin1 range, hence /d
12890              * is equivalent to /u.  Changing to /u saves some branches at
12891              * runtime */
12892             op = POSIXU;
12893             goto join_posix_op_known;
12894
12895         case 'R':
12896             ret = reg_node(pRExC_state, LNBREAK);
12897             *flagp |= HASWIDTH|SIMPLE;
12898             goto finish_meta_pat;
12899
12900         case 'H':
12901             invert = 1;
12902             /* FALLTHROUGH */
12903         case 'h':
12904             arg = ANYOF_BLANK;
12905             op = POSIXU;
12906             goto join_posix_op_known;
12907
12908         case 'V':
12909             invert = 1;
12910             /* FALLTHROUGH */
12911         case 'v':
12912             arg = ANYOF_VERTWS;
12913             op = POSIXU;
12914             goto join_posix_op_known;
12915
12916         case 'S':
12917             invert = 1;
12918             /* FALLTHROUGH */
12919         case 's':
12920             arg = ANYOF_SPACE;
12921
12922           join_posix:
12923
12924             op = POSIXD + get_regex_charset(RExC_flags);
12925             if (op > POSIXA) {  /* /aa is same as /a */
12926                 op = POSIXA;
12927             }
12928             else if (op == POSIXL) {
12929                 RExC_contains_locale = 1;
12930             }
12931
12932           join_posix_op_known:
12933
12934             if (invert) {
12935                 op += NPOSIXD - POSIXD;
12936             }
12937
12938             ret = reg_node(pRExC_state, op);
12939             if (! SIZE_ONLY) {
12940                 FLAGS(ret) = namedclass_to_classnum(arg);
12941             }
12942
12943             *flagp |= HASWIDTH|SIMPLE;
12944             /* FALLTHROUGH */
12945
12946           finish_meta_pat:
12947             if (   UCHARAT(RExC_parse + 1) == '{'
12948                 && UNLIKELY(! new_regcurly(RExC_parse + 1, RExC_end)))
12949             {
12950                 RExC_parse += 2;
12951                 vFAIL("Unescaped left brace in regex is illegal here");
12952             }
12953             nextchar(pRExC_state);
12954             Set_Node_Length(ret, 2); /* MJD */
12955             break;
12956         case 'p':
12957         case 'P':
12958             RExC_parse--;
12959
12960             ret = regclass(pRExC_state, flagp,depth+1,
12961                            TRUE, /* means just parse this element */
12962                            FALSE, /* don't allow multi-char folds */
12963                            FALSE, /* don't silence non-portable warnings.  It
12964                                      would be a bug if these returned
12965                                      non-portables */
12966                            (bool) RExC_strict,
12967                            TRUE, /* Allow an optimized regnode result */
12968                            NULL,
12969                            NULL);
12970             if (*flagp & RESTART_PASS1)
12971                 return NULL;
12972             /* regclass() can only return RESTART_PASS1 and NEED_UTF8 if
12973              * multi-char folds are allowed.  */
12974             if (!ret)
12975                 FAIL2("panic: regclass returned NULL to regatom, flags=%#" UVxf,
12976                       (UV) *flagp);
12977
12978             RExC_parse--;
12979
12980             Set_Node_Offset(ret, parse_start);
12981             Set_Node_Cur_Length(ret, parse_start - 2);
12982             nextchar(pRExC_state);
12983             break;
12984         case 'N':
12985             /* Handle \N, \N{} and \N{NAMED SEQUENCE} (the latter meaning the
12986              * \N{...} evaluates to a sequence of more than one code points).
12987              * The function call below returns a regnode, which is our result.
12988              * The parameters cause it to fail if the \N{} evaluates to a
12989              * single code point; we handle those like any other literal.  The
12990              * reason that the multicharacter case is handled here and not as
12991              * part of the EXACtish code is because of quantifiers.  In
12992              * /\N{BLAH}+/, the '+' applies to the whole thing, and doing it
12993              * this way makes that Just Happen. dmq.
12994              * join_exact() will join this up with adjacent EXACTish nodes
12995              * later on, if appropriate. */
12996             ++RExC_parse;
12997             if (grok_bslash_N(pRExC_state,
12998                               &ret,     /* Want a regnode returned */
12999                               NULL,     /* Fail if evaluates to a single code
13000                                            point */
13001                               NULL,     /* Don't need a count of how many code
13002                                            points */
13003                               flagp,
13004                               RExC_strict,
13005                               depth)
13006             ) {
13007                 break;
13008             }
13009
13010             if (*flagp & RESTART_PASS1)
13011                 return NULL;
13012
13013             /* Here, evaluates to a single code point.  Go get that */
13014             RExC_parse = parse_start;
13015             goto defchar;
13016
13017         case 'k':    /* Handle \k<NAME> and \k'NAME' */
13018       parse_named_seq:
13019         {
13020             char ch;
13021             if (   RExC_parse >= RExC_end - 1
13022                 || ((   ch = RExC_parse[1]) != '<'
13023                                       && ch != '\''
13024                                       && ch != '{'))
13025             {
13026                 RExC_parse++;
13027                 /* diag_listed_as: Sequence \%s... not terminated in regex; marked by <-- HERE in m/%s/ */
13028                 vFAIL2("Sequence %.2s... not terminated",parse_start);
13029             } else {
13030                 RExC_parse += 2;
13031                 ret = handle_named_backref(pRExC_state,
13032                                            flagp,
13033                                            parse_start,
13034                                            (ch == '<')
13035                                            ? '>'
13036                                            : (ch == '{')
13037                                              ? '}'
13038                                              : '\'');
13039             }
13040             break;
13041         }
13042         case 'g':
13043         case '1': case '2': case '3': case '4':
13044         case '5': case '6': case '7': case '8': case '9':
13045             {
13046                 I32 num;
13047                 bool hasbrace = 0;
13048
13049                 if (*RExC_parse == 'g') {
13050                     bool isrel = 0;
13051
13052                     RExC_parse++;
13053                     if (*RExC_parse == '{') {
13054                         RExC_parse++;
13055                         hasbrace = 1;
13056                     }
13057                     if (*RExC_parse == '-') {
13058                         RExC_parse++;
13059                         isrel = 1;
13060                     }
13061                     if (hasbrace && !isDIGIT(*RExC_parse)) {
13062                         if (isrel) RExC_parse--;
13063                         RExC_parse -= 2;
13064                         goto parse_named_seq;
13065                     }
13066
13067                     if (RExC_parse >= RExC_end) {
13068                         goto unterminated_g;
13069                     }
13070                     num = S_backref_value(RExC_parse);
13071                     if (num == 0)
13072                         vFAIL("Reference to invalid group 0");
13073                     else if (num == I32_MAX) {
13074                          if (isDIGIT(*RExC_parse))
13075                             vFAIL("Reference to nonexistent group");
13076                         else
13077                           unterminated_g:
13078                             vFAIL("Unterminated \\g... pattern");
13079                     }
13080
13081                     if (isrel) {
13082                         num = RExC_npar - num;
13083                         if (num < 1)
13084                             vFAIL("Reference to nonexistent or unclosed group");
13085                     }
13086                 }
13087                 else {
13088                     num = S_backref_value(RExC_parse);
13089                     /* bare \NNN might be backref or octal - if it is larger
13090                      * than or equal RExC_npar then it is assumed to be an
13091                      * octal escape. Note RExC_npar is +1 from the actual
13092                      * number of parens. */
13093                     /* Note we do NOT check if num == I32_MAX here, as that is
13094                      * handled by the RExC_npar check */
13095
13096                     if (
13097                         /* any numeric escape < 10 is always a backref */
13098                         num > 9
13099                         /* any numeric escape < RExC_npar is a backref */
13100                         && num >= RExC_npar
13101                         /* cannot be an octal escape if it starts with 8 */
13102                         && *RExC_parse != '8'
13103                         /* cannot be an octal escape it it starts with 9 */
13104                         && *RExC_parse != '9'
13105                     )
13106                     {
13107                         /* Probably not a backref, instead likely to be an
13108                          * octal character escape, e.g. \35 or \777.
13109                          * The above logic should make it obvious why using
13110                          * octal escapes in patterns is problematic. - Yves */
13111                         RExC_parse = parse_start;
13112                         goto defchar;
13113                     }
13114                 }
13115
13116                 /* At this point RExC_parse points at a numeric escape like
13117                  * \12 or \88 or something similar, which we should NOT treat
13118                  * as an octal escape. It may or may not be a valid backref
13119                  * escape. For instance \88888888 is unlikely to be a valid
13120                  * backref. */
13121                 while (isDIGIT(*RExC_parse))
13122                     RExC_parse++;
13123                 if (hasbrace) {
13124                     if (*RExC_parse != '}')
13125                         vFAIL("Unterminated \\g{...} pattern");
13126                     RExC_parse++;
13127                 }
13128                 if (!SIZE_ONLY) {
13129                     if (num > (I32)RExC_rx->nparens)
13130                         vFAIL("Reference to nonexistent group");
13131                 }
13132                 RExC_sawback = 1;
13133                 ret = reganode(pRExC_state,
13134                                ((! FOLD)
13135                                  ? REF
13136                                  : (ASCII_FOLD_RESTRICTED)
13137                                    ? REFFA
13138                                    : (AT_LEAST_UNI_SEMANTICS)
13139                                      ? REFFU
13140                                      : (LOC)
13141                                        ? REFFL
13142                                        : REFF),
13143                                 num);
13144                 *flagp |= HASWIDTH;
13145
13146                 /* override incorrect value set in reganode MJD */
13147                 Set_Node_Offset(ret, parse_start);
13148                 Set_Node_Cur_Length(ret, parse_start-1);
13149                 skip_to_be_ignored_text(pRExC_state, &RExC_parse,
13150                                         FALSE /* Don't force to /x */ );
13151             }
13152             break;
13153         case '\0':
13154             if (RExC_parse >= RExC_end)
13155                 FAIL("Trailing \\");
13156             /* FALLTHROUGH */
13157         default:
13158             /* Do not generate "unrecognized" warnings here, we fall
13159                back into the quick-grab loop below */
13160             RExC_parse = parse_start;
13161             goto defchar;
13162         } /* end of switch on a \foo sequence */
13163         break;
13164
13165     case '#':
13166
13167         /* '#' comments should have been spaced over before this function was
13168          * called */
13169         assert((RExC_flags & RXf_PMf_EXTENDED) == 0);
13170         /*
13171         if (RExC_flags & RXf_PMf_EXTENDED) {
13172             RExC_parse = reg_skipcomment( pRExC_state, RExC_parse );
13173             if (RExC_parse < RExC_end)
13174                 goto tryagain;
13175         }
13176         */
13177
13178         /* FALLTHROUGH */
13179
13180     default:
13181           defchar: {
13182
13183             /* Here, we have determined that the next thing is probably a
13184              * literal character.  RExC_parse points to the first byte of its
13185              * definition.  (It still may be an escape sequence that evaluates
13186              * to a single character) */
13187
13188             STRLEN len = 0;
13189             UV ender = 0;
13190             char *p;
13191             char *s;
13192 #define MAX_NODE_STRING_SIZE 127
13193             char foldbuf[MAX_NODE_STRING_SIZE+UTF8_MAXBYTES_CASE];
13194             char *s0;
13195             U8 upper_parse = MAX_NODE_STRING_SIZE;
13196             U8 node_type = compute_EXACTish(pRExC_state);
13197             bool next_is_quantifier;
13198             char * oldp = NULL;
13199
13200             /* We can convert EXACTF nodes to EXACTFU if they contain only
13201              * characters that match identically regardless of the target
13202              * string's UTF8ness.  The reason to do this is that EXACTF is not
13203              * trie-able, EXACTFU is.
13204              *
13205              * Similarly, we can convert EXACTFL nodes to EXACTFLU8 if they
13206              * contain only above-Latin1 characters (hence must be in UTF8),
13207              * which don't participate in folds with Latin1-range characters,
13208              * as the latter's folds aren't known until runtime.  (We don't
13209              * need to figure this out until pass 2) */
13210             bool maybe_exactfu = PASS2
13211                                && (node_type == EXACTF || node_type == EXACTFL);
13212
13213             /* If a folding node contains only code points that don't
13214              * participate in folds, it can be changed into an EXACT node,
13215              * which allows the optimizer more things to look for */
13216             bool maybe_exact;
13217
13218             ret = reg_node(pRExC_state, node_type);
13219
13220             /* In pass1, folded, we use a temporary buffer instead of the
13221              * actual node, as the node doesn't exist yet */
13222             s = (SIZE_ONLY && FOLD) ? foldbuf : STRING(ret);
13223
13224             s0 = s;
13225
13226           reparse:
13227
13228             /* We look for the EXACTFish to EXACT node optimizaton only if
13229              * folding.  (And we don't need to figure this out until pass 2).
13230              * XXX It might actually make sense to split the node into portions
13231              * that are exact and ones that aren't, so that we could later use
13232              * the exact ones to find the longest fixed and floating strings.
13233              * One would want to join them back into a larger node.  One could
13234              * use a pseudo regnode like 'EXACT_ORIG_FOLD' */
13235             maybe_exact = FOLD && PASS2;
13236
13237             /* XXX The node can hold up to 255 bytes, yet this only goes to
13238              * 127.  I (khw) do not know why.  Keeping it somewhat less than
13239              * 255 allows us to not have to worry about overflow due to
13240              * converting to utf8 and fold expansion, but that value is
13241              * 255-UTF8_MAXBYTES_CASE.  join_exact() may join adjacent nodes
13242              * split up by this limit into a single one using the real max of
13243              * 255.  Even at 127, this breaks under rare circumstances.  If
13244              * folding, we do not want to split a node at a character that is a
13245              * non-final in a multi-char fold, as an input string could just
13246              * happen to want to match across the node boundary.  The join
13247              * would solve that problem if the join actually happens.  But a
13248              * series of more than two nodes in a row each of 127 would cause
13249              * the first join to succeed to get to 254, but then there wouldn't
13250              * be room for the next one, which could at be one of those split
13251              * multi-char folds.  I don't know of any fool-proof solution.  One
13252              * could back off to end with only a code point that isn't such a
13253              * non-final, but it is possible for there not to be any in the
13254              * entire node. */
13255
13256             assert(   ! UTF     /* Is at the beginning of a character */
13257                    || UTF8_IS_INVARIANT(UCHARAT(RExC_parse))
13258                    || UTF8_IS_START(UCHARAT(RExC_parse)));
13259
13260             /* Here, we have a literal character.  Find the maximal string of
13261              * them in the input that we can fit into a single EXACTish node.
13262              * We quit at the first non-literal or when the node gets full */
13263             for (p = RExC_parse;
13264                  len < upper_parse && p < RExC_end;
13265                  len++)
13266             {
13267                 oldp = p;
13268
13269                 /* White space has already been ignored */
13270                 assert(   (RExC_flags & RXf_PMf_EXTENDED) == 0
13271                        || ! is_PATWS_safe((p), RExC_end, UTF));
13272
13273                 switch ((U8)*p) {
13274                 case '^':
13275                 case '$':
13276                 case '.':
13277                 case '[':
13278                 case '(':
13279                 case ')':
13280                 case '|':
13281                     goto loopdone;
13282                 case '\\':
13283                     /* Literal Escapes Switch
13284
13285                        This switch is meant to handle escape sequences that
13286                        resolve to a literal character.
13287
13288                        Every escape sequence that represents something
13289                        else, like an assertion or a char class, is handled
13290                        in the switch marked 'Special Escapes' above in this
13291                        routine, but also has an entry here as anything that
13292                        isn't explicitly mentioned here will be treated as
13293                        an unescaped equivalent literal.
13294                     */
13295
13296                     switch ((U8)*++p) {
13297                     /* These are all the special escapes. */
13298                     case 'A':             /* Start assertion */
13299                     case 'b': case 'B':   /* Word-boundary assertion*/
13300                     case 'C':             /* Single char !DANGEROUS! */
13301                     case 'd': case 'D':   /* digit class */
13302                     case 'g': case 'G':   /* generic-backref, pos assertion */
13303                     case 'h': case 'H':   /* HORIZWS */
13304                     case 'k': case 'K':   /* named backref, keep marker */
13305                     case 'p': case 'P':   /* Unicode property */
13306                               case 'R':   /* LNBREAK */
13307                     case 's': case 'S':   /* space class */
13308                     case 'v': case 'V':   /* VERTWS */
13309                     case 'w': case 'W':   /* word class */
13310                     case 'X':             /* eXtended Unicode "combining
13311                                              character sequence" */
13312                     case 'z': case 'Z':   /* End of line/string assertion */
13313                         --p;
13314                         goto loopdone;
13315
13316                     /* Anything after here is an escape that resolves to a
13317                        literal. (Except digits, which may or may not)
13318                      */
13319                     case 'n':
13320                         ender = '\n';
13321                         p++;
13322                         break;
13323                     case 'N': /* Handle a single-code point named character. */
13324                         RExC_parse = p + 1;
13325                         if (! grok_bslash_N(pRExC_state,
13326                                             NULL,   /* Fail if evaluates to
13327                                                        anything other than a
13328                                                        single code point */
13329                                             &ender, /* The returned single code
13330                                                        point */
13331                                             NULL,   /* Don't need a count of
13332                                                        how many code points */
13333                                             flagp,
13334                                             RExC_strict,
13335                                             depth)
13336                         ) {
13337                             if (*flagp & NEED_UTF8)
13338                                 FAIL("panic: grok_bslash_N set NEED_UTF8");
13339                             if (*flagp & RESTART_PASS1)
13340                                 return NULL;
13341
13342                             /* Here, it wasn't a single code point.  Go close
13343                              * up this EXACTish node.  The switch() prior to
13344                              * this switch handles the other cases */
13345                             RExC_parse = p = oldp;
13346                             goto loopdone;
13347                         }
13348                         p = RExC_parse;
13349                         RExC_parse = parse_start;
13350                         if (ender > 0xff) {
13351                             REQUIRE_UTF8(flagp);
13352                         }
13353                         break;
13354                     case 'r':
13355                         ender = '\r';
13356                         p++;
13357                         break;
13358                     case 't':
13359                         ender = '\t';
13360                         p++;
13361                         break;
13362                     case 'f':
13363                         ender = '\f';
13364                         p++;
13365                         break;
13366                     case 'e':
13367                         ender = ESC_NATIVE;
13368                         p++;
13369                         break;
13370                     case 'a':
13371                         ender = '\a';
13372                         p++;
13373                         break;
13374                     case 'o':
13375                         {
13376                             UV result;
13377                             const char* error_msg;
13378
13379                             bool valid = grok_bslash_o(&p,
13380                                                        RExC_end,
13381                                                        &result,
13382                                                        &error_msg,
13383                                                        PASS2, /* out warnings */
13384                                                        (bool) RExC_strict,
13385                                                        TRUE, /* Output warnings
13386                                                                 for non-
13387                                                                 portables */
13388                                                        UTF);
13389                             if (! valid) {
13390                                 RExC_parse = p; /* going to die anyway; point
13391                                                    to exact spot of failure */
13392                                 vFAIL(error_msg);
13393                             }
13394                             ender = result;
13395                             if (ender > 0xff) {
13396                                 REQUIRE_UTF8(flagp);
13397                             }
13398                             break;
13399                         }
13400                     case 'x':
13401                         {
13402                             UV result = UV_MAX; /* initialize to erroneous
13403                                                    value */
13404                             const char* error_msg;
13405
13406                             bool valid = grok_bslash_x(&p,
13407                                                        RExC_end,
13408                                                        &result,
13409                                                        &error_msg,
13410                                                        PASS2, /* out warnings */
13411                                                        (bool) RExC_strict,
13412                                                        TRUE, /* Silence warnings
13413                                                                 for non-
13414                                                                 portables */
13415                                                        UTF);
13416                             if (! valid) {
13417                                 RExC_parse = p; /* going to die anyway; point
13418                                                    to exact spot of failure */
13419                                 vFAIL(error_msg);
13420                             }
13421                             ender = result;
13422
13423                             if (ender < 0x100) {
13424 #ifdef EBCDIC
13425                                 if (RExC_recode_x_to_native) {
13426                                     ender = LATIN1_TO_NATIVE(ender);
13427                                 }
13428 #endif
13429                             }
13430                             else {
13431                                 REQUIRE_UTF8(flagp);
13432                             }
13433                             break;
13434                         }
13435                     case 'c':
13436                         p++;
13437                         ender = grok_bslash_c(*p++, PASS2);
13438                         break;
13439                     case '8': case '9': /* must be a backreference */
13440                         --p;
13441                         /* we have an escape like \8 which cannot be an octal escape
13442                          * so we exit the loop, and let the outer loop handle this
13443                          * escape which may or may not be a legitimate backref. */
13444                         goto loopdone;
13445                     case '1': case '2': case '3':case '4':
13446                     case '5': case '6': case '7':
13447                         /* When we parse backslash escapes there is ambiguity
13448                          * between backreferences and octal escapes. Any escape
13449                          * from \1 - \9 is a backreference, any multi-digit
13450                          * escape which does not start with 0 and which when
13451                          * evaluated as decimal could refer to an already
13452                          * parsed capture buffer is a back reference. Anything
13453                          * else is octal.
13454                          *
13455                          * Note this implies that \118 could be interpreted as
13456                          * 118 OR as "\11" . "8" depending on whether there
13457                          * were 118 capture buffers defined already in the
13458                          * pattern.  */
13459
13460                         /* NOTE, RExC_npar is 1 more than the actual number of
13461                          * parens we have seen so far, hence the < RExC_npar below. */
13462
13463                         if ( !isDIGIT(p[1]) || S_backref_value(p) < RExC_npar)
13464                         {  /* Not to be treated as an octal constant, go
13465                                    find backref */
13466                             --p;
13467                             goto loopdone;
13468                         }
13469                         /* FALLTHROUGH */
13470                     case '0':
13471                         {
13472                             I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
13473                             STRLEN numlen = 3;
13474                             ender = grok_oct(p, &numlen, &flags, NULL);
13475                             if (ender > 0xff) {
13476                                 REQUIRE_UTF8(flagp);
13477                             }
13478                             p += numlen;
13479                             if (PASS2   /* like \08, \178 */
13480                                 && numlen < 3
13481                                 && isDIGIT(*p) && ckWARN(WARN_REGEXP))
13482                             {
13483                                 reg_warn_non_literal_string(
13484                                          p + 1,
13485                                          form_short_octal_warning(p, numlen));
13486                             }
13487                         }
13488                         break;
13489                     case '\0':
13490                         if (p >= RExC_end)
13491                             FAIL("Trailing \\");
13492                         /* FALLTHROUGH */
13493                     default:
13494                         if (!SIZE_ONLY&& isALPHANUMERIC(*p)) {
13495                             /* Include any left brace following the alpha to emphasize
13496                              * that it could be part of an escape at some point
13497                              * in the future */
13498                             int len = (isALPHA(*p) && *(p + 1) == '{') ? 2 : 1;
13499                             ckWARN3reg(p + len, "Unrecognized escape \\%.*s passed through", len, p);
13500                         }
13501                         goto normal_default;
13502                     } /* End of switch on '\' */
13503                     break;
13504                 case '{':
13505                     /* Currently we allow an lbrace at the start of a construct
13506                      * without raising a warning.  This is because we think we
13507                      * will never want such a brace to be meant to be other
13508                      * than taken literally. */
13509                     if (len || (p > RExC_start && isALPHA_A(*(p - 1)))) {
13510
13511                         /* But, we raise a fatal warning otherwise, as the
13512                          * deprecation cycle has come and gone.  Except that it
13513                          * turns out that some heavily-relied on upstream
13514                          * software, notably GNU Autoconf, have failed to fix
13515                          * their uses.  For these, don't make it fatal unless
13516                          * we anticipate using the '{' for something else.
13517                          * This happens after any alpha, and for a looser {m,n}
13518                          * quantifier specification */
13519                         if (      RExC_strict
13520                             || (  p > parse_start + 1
13521                                 && isALPHA_A(*(p - 1))
13522                                 && *(p - 2) == '\\')
13523                             || new_regcurly(p, RExC_end))
13524                         {
13525                             RExC_parse = p + 1;
13526                             vFAIL("Unescaped left brace in regex is "
13527                                   "illegal here");
13528                         }
13529                         if (PASS2) {
13530                             ckWARNregdep(p + 1,
13531                                         "Unescaped left brace in regex is "
13532                                         "deprecated here (and will be fatal "
13533                                         "in Perl 5.30), passed through");
13534                         }
13535                     }
13536                     goto normal_default;
13537                 case '}':
13538                 case ']':
13539                     if (PASS2 && p > RExC_parse && RExC_strict) {
13540                         ckWARN2reg(p + 1, "Unescaped literal '%c'", *p);
13541                     }
13542                     /*FALLTHROUGH*/
13543                 default:    /* A literal character */
13544                   normal_default:
13545                     if (! UTF8_IS_INVARIANT(*p) && UTF) {
13546                         STRLEN numlen;
13547                         ender = utf8n_to_uvchr((U8*)p, RExC_end - p,
13548                                                &numlen, UTF8_ALLOW_DEFAULT);
13549                         p += numlen;
13550                     }
13551                     else
13552                         ender = (U8) *p++;
13553                     break;
13554                 } /* End of switch on the literal */
13555
13556                 /* Here, have looked at the literal character and <ender>
13557                  * contains its ordinal, <p> points to the character after it.
13558                  * We need to check if the next non-ignored thing is a
13559                  * quantifier.  Move <p> to after anything that should be
13560                  * ignored, which, as a side effect, positions <p> for the next
13561                  * loop iteration */
13562                 skip_to_be_ignored_text(pRExC_state, &p,
13563                                         FALSE /* Don't force to /x */ );
13564
13565                 /* If the next thing is a quantifier, it applies to this
13566                  * character only, which means that this character has to be in
13567                  * its own node and can't just be appended to the string in an
13568                  * existing node, so if there are already other characters in
13569                  * the node, close the node with just them, and set up to do
13570                  * this character again next time through, when it will be the
13571                  * only thing in its new node */
13572
13573                 next_is_quantifier =    LIKELY(p < RExC_end)
13574                                      && UNLIKELY(ISMULT2(p));
13575
13576                 if (next_is_quantifier && LIKELY(len)) {
13577                     p = oldp;
13578                     goto loopdone;
13579                 }
13580
13581                 /* Ready to add 'ender' to the node */
13582
13583                 if (! FOLD) {  /* The simple case, just append the literal */
13584
13585                     /* In the sizing pass, we need only the size of the
13586                      * character we are appending, hence we can delay getting
13587                      * its representation until PASS2. */
13588                     if (SIZE_ONLY) {
13589                         if (UTF && ! UVCHR_IS_INVARIANT(ender)) {
13590                             const STRLEN unilen = UVCHR_SKIP(ender);
13591                             s += unilen;
13592
13593                             /* We have to subtract 1 just below (and again in
13594                              * the corresponding PASS2 code) because the loop
13595                              * increments <len> each time, as all but this path
13596                              * (and one other) through it add a single byte to
13597                              * the EXACTish node.  But these paths would change
13598                              * len to be the correct final value, so cancel out
13599                              * the increment that follows */
13600                             len += unilen - 1;
13601                         }
13602                         else {
13603                             s++;
13604                         }
13605                     } else { /* PASS2 */
13606                       not_fold_common:
13607                         if (UTF && ! UVCHR_IS_INVARIANT(ender)) {
13608                             U8 * new_s = uvchr_to_utf8((U8*)s, ender);
13609                             len += (char *) new_s - s - 1;
13610                             s = (char *) new_s;
13611                         }
13612                         else {
13613                             *(s++) = (char) ender;
13614                         }
13615                     }
13616                 }
13617                 else if (LOC && is_PROBLEMATIC_LOCALE_FOLD_cp(ender)) {
13618
13619                     /* Here are folding under /l, and the code point is
13620                      * problematic.  First, we know we can't simplify things */
13621                     maybe_exact = FALSE;
13622                     maybe_exactfu = FALSE;
13623
13624                     /* A problematic code point in this context means that its
13625                      * fold isn't known until runtime, so we can't fold it now.
13626                      * (The non-problematic code points are the above-Latin1
13627                      * ones that fold to also all above-Latin1.  Their folds
13628                      * don't vary no matter what the locale is.) But here we
13629                      * have characters whose fold depends on the locale.
13630                      * Unlike the non-folding case above, we have to keep track
13631                      * of these in the sizing pass, so that we can make sure we
13632                      * don't split too-long nodes in the middle of a potential
13633                      * multi-char fold.  And unlike the regular fold case
13634                      * handled in the else clauses below, we don't actually
13635                      * fold and don't have special cases to consider.  What we
13636                      * do for both passes is the PASS2 code for non-folding */
13637                     goto not_fold_common;
13638                 }
13639                 else /* A regular FOLD code point */
13640                     if (! (   UTF
13641 #if    UNICODE_MAJOR_VERSION > 3 /* no multifolds in early Unicode */   \
13642    || (UNICODE_MAJOR_VERSION == 3 && (   UNICODE_DOT_VERSION > 0)       \
13643                                       || UNICODE_DOT_DOT_VERSION > 0)
13644                             /* See comments for join_exact() as to why we fold
13645                              * this non-UTF at compile time */
13646                             || (   node_type == EXACTFU
13647                                 && ender == LATIN_SMALL_LETTER_SHARP_S)
13648 #endif
13649                 )) {
13650                     /* Here, are folding and are not UTF-8 encoded; therefore
13651                      * the character must be in the range 0-255, and is not /l
13652                      * (Not /l because we already handled these under /l in
13653                      * is_PROBLEMATIC_LOCALE_FOLD_cp) */
13654                     if (IS_IN_SOME_FOLD_L1(ender)) {
13655                         maybe_exact = FALSE;
13656
13657                         /* See if the character's fold differs between /d and
13658                          * /u.  This includes the multi-char fold SHARP S to
13659                          * 'ss' */
13660                         if (UNLIKELY(ender == LATIN_SMALL_LETTER_SHARP_S)) {
13661                             RExC_seen_unfolded_sharp_s = 1;
13662                             maybe_exactfu = FALSE;
13663                         }
13664                         else if (maybe_exactfu
13665                             && (PL_fold[ender] != PL_fold_latin1[ender]
13666 #if    UNICODE_MAJOR_VERSION > 3 /* no multifolds in early Unicode */   \
13667    || (UNICODE_MAJOR_VERSION == 3 && (   UNICODE_DOT_VERSION > 0)       \
13668                                       || UNICODE_DOT_DOT_VERSION > 0)
13669                                 || (   len > 0
13670                                     && isALPHA_FOLD_EQ(ender, 's')
13671                                     && isALPHA_FOLD_EQ(*(s-1), 's'))
13672 #endif
13673                         )) {
13674                             maybe_exactfu = FALSE;
13675                         }
13676                     }
13677
13678                     /* Even when folding, we store just the input character, as
13679                      * we have an array that finds its fold quickly */
13680                     *(s++) = (char) ender;
13681                 }
13682                 else {  /* FOLD, and UTF (or sharp s) */
13683                     /* Unlike the non-fold case, we do actually have to
13684                      * calculate the results here in pass 1.  This is for two
13685                      * reasons, the folded length may be longer than the
13686                      * unfolded, and we have to calculate how many EXACTish
13687                      * nodes it will take; and we may run out of room in a node
13688                      * in the middle of a potential multi-char fold, and have
13689                      * to back off accordingly.  */
13690
13691                     UV folded;
13692                     if (isASCII_uni(ender)) {
13693                         folded = toFOLD(ender);
13694                         *(s)++ = (U8) folded;
13695                     }
13696                     else {
13697                         STRLEN foldlen;
13698
13699                         folded = _to_uni_fold_flags(
13700                                      ender,
13701                                      (U8 *) s,
13702                                      &foldlen,
13703                                      FOLD_FLAGS_FULL | ((ASCII_FOLD_RESTRICTED)
13704                                                         ? FOLD_FLAGS_NOMIX_ASCII
13705                                                         : 0));
13706                         s += foldlen;
13707
13708                         /* The loop increments <len> each time, as all but this
13709                          * path (and one other) through it add a single byte to
13710                          * the EXACTish node.  But this one has changed len to
13711                          * be the correct final value, so subtract one to
13712                          * cancel out the increment that follows */
13713                         len += foldlen - 1;
13714                     }
13715                     /* If this node only contains non-folding code points so
13716                      * far, see if this new one is also non-folding */
13717                     if (maybe_exact) {
13718                         if (folded != ender) {
13719                             maybe_exact = FALSE;
13720                         }
13721                         else {
13722                             /* Here the fold is the original; we have to check
13723                              * further to see if anything folds to it */
13724                             if (_invlist_contains_cp(PL_utf8_foldable,
13725                                                         ender))
13726                             {
13727                                 maybe_exact = FALSE;
13728                             }
13729                         }
13730                     }
13731                     ender = folded;
13732                 }
13733
13734                 if (next_is_quantifier) {
13735
13736                     /* Here, the next input is a quantifier, and to get here,
13737                      * the current character is the only one in the node.
13738                      * Also, here <len> doesn't include the final byte for this
13739                      * character */
13740                     len++;
13741                     goto loopdone;
13742                 }
13743
13744             } /* End of loop through literal characters */
13745
13746             /* Here we have either exhausted the input or ran out of room in
13747              * the node.  (If we encountered a character that can't be in the
13748              * node, transfer is made directly to <loopdone>, and so we
13749              * wouldn't have fallen off the end of the loop.)  In the latter
13750              * case, we artificially have to split the node into two, because
13751              * we just don't have enough space to hold everything.  This
13752              * creates a problem if the final character participates in a
13753              * multi-character fold in the non-final position, as a match that
13754              * should have occurred won't, due to the way nodes are matched,
13755              * and our artificial boundary.  So back off until we find a non-
13756              * problematic character -- one that isn't at the beginning or
13757              * middle of such a fold.  (Either it doesn't participate in any
13758              * folds, or appears only in the final position of all the folds it
13759              * does participate in.)  A better solution with far fewer false
13760              * positives, and that would fill the nodes more completely, would
13761              * be to actually have available all the multi-character folds to
13762              * test against, and to back-off only far enough to be sure that
13763              * this node isn't ending with a partial one.  <upper_parse> is set
13764              * further below (if we need to reparse the node) to include just
13765              * up through that final non-problematic character that this code
13766              * identifies, so when it is set to less than the full node, we can
13767              * skip the rest of this */
13768             if (FOLD && p < RExC_end && upper_parse == MAX_NODE_STRING_SIZE) {
13769
13770                 const STRLEN full_len = len;
13771
13772                 assert(len >= MAX_NODE_STRING_SIZE);
13773
13774                 /* Here, <s> points to the final byte of the final character.
13775                  * Look backwards through the string until find a non-
13776                  * problematic character */
13777
13778                 if (! UTF) {
13779
13780                     /* This has no multi-char folds to non-UTF characters */
13781                     if (ASCII_FOLD_RESTRICTED) {
13782                         goto loopdone;
13783                     }
13784
13785                     while (--s >= s0 && IS_NON_FINAL_FOLD(*s)) { }
13786                     len = s - s0 + 1;
13787                 }
13788                 else {
13789                     if (!  PL_NonL1NonFinalFold) {
13790                         PL_NonL1NonFinalFold = _new_invlist_C_array(
13791                                         NonL1_Perl_Non_Final_Folds_invlist);
13792                     }
13793
13794                     /* Point to the first byte of the final character */
13795                     s = (char *) utf8_hop((U8 *) s, -1);
13796
13797                     while (s >= s0) {   /* Search backwards until find
13798                                            non-problematic char */
13799                         if (UTF8_IS_INVARIANT(*s)) {
13800
13801                             /* There are no ascii characters that participate
13802                              * in multi-char folds under /aa.  In EBCDIC, the
13803                              * non-ascii invariants are all control characters,
13804                              * so don't ever participate in any folds. */
13805                             if (ASCII_FOLD_RESTRICTED
13806                                 || ! IS_NON_FINAL_FOLD(*s))
13807                             {
13808                                 break;
13809                             }
13810                         }
13811                         else if (UTF8_IS_DOWNGRADEABLE_START(*s)) {
13812                             if (! IS_NON_FINAL_FOLD(EIGHT_BIT_UTF8_TO_NATIVE(
13813                                                                   *s, *(s+1))))
13814                             {
13815                                 break;
13816                             }
13817                         }
13818                         else if (! _invlist_contains_cp(
13819                                         PL_NonL1NonFinalFold,
13820                                         valid_utf8_to_uvchr((U8 *) s, NULL)))
13821                         {
13822                             break;
13823                         }
13824
13825                         /* Here, the current character is problematic in that
13826                          * it does occur in the non-final position of some
13827                          * fold, so try the character before it, but have to
13828                          * special case the very first byte in the string, so
13829                          * we don't read outside the string */
13830                         s = (s == s0) ? s -1 : (char *) utf8_hop((U8 *) s, -1);
13831                     } /* End of loop backwards through the string */
13832
13833                     /* If there were only problematic characters in the string,
13834                      * <s> will point to before s0, in which case the length
13835                      * should be 0, otherwise include the length of the
13836                      * non-problematic character just found */
13837                     len = (s < s0) ? 0 : s - s0 + UTF8SKIP(s);
13838                 }
13839
13840                 /* Here, have found the final character, if any, that is
13841                  * non-problematic as far as ending the node without splitting
13842                  * it across a potential multi-char fold.  <len> contains the
13843                  * number of bytes in the node up-to and including that
13844                  * character, or is 0 if there is no such character, meaning
13845                  * the whole node contains only problematic characters.  In
13846                  * this case, give up and just take the node as-is.  We can't
13847                  * do any better */
13848                 if (len == 0) {
13849                     len = full_len;
13850
13851                     /* If the node ends in an 's' we make sure it stays EXACTF,
13852                      * as if it turns into an EXACTFU, it could later get
13853                      * joined with another 's' that would then wrongly match
13854                      * the sharp s */
13855                     if (maybe_exactfu && isALPHA_FOLD_EQ(ender, 's'))
13856                     {
13857                         maybe_exactfu = FALSE;
13858                     }
13859                 } else {
13860
13861                     /* Here, the node does contain some characters that aren't
13862                      * problematic.  If one such is the final character in the
13863                      * node, we are done */
13864                     if (len == full_len) {
13865                         goto loopdone;
13866                     }
13867                     else if (len + ((UTF) ? UTF8SKIP(s) : 1) == full_len) {
13868
13869                         /* If the final character is problematic, but the
13870                          * penultimate is not, back-off that last character to
13871                          * later start a new node with it */
13872                         p = oldp;
13873                         goto loopdone;
13874                     }
13875
13876                     /* Here, the final non-problematic character is earlier
13877                      * in the input than the penultimate character.  What we do
13878                      * is reparse from the beginning, going up only as far as
13879                      * this final ok one, thus guaranteeing that the node ends
13880                      * in an acceptable character.  The reason we reparse is
13881                      * that we know how far in the character is, but we don't
13882                      * know how to correlate its position with the input parse.
13883                      * An alternate implementation would be to build that
13884                      * correlation as we go along during the original parse,
13885                      * but that would entail extra work for every node, whereas
13886                      * this code gets executed only when the string is too
13887                      * large for the node, and the final two characters are
13888                      * problematic, an infrequent occurrence.  Yet another
13889                      * possible strategy would be to save the tail of the
13890                      * string, and the next time regatom is called, initialize
13891                      * with that.  The problem with this is that unless you
13892                      * back off one more character, you won't be guaranteed
13893                      * regatom will get called again, unless regbranch,
13894                      * regpiece ... are also changed.  If you do back off that
13895                      * extra character, so that there is input guaranteed to
13896                      * force calling regatom, you can't handle the case where
13897                      * just the first character in the node is acceptable.  I
13898                      * (khw) decided to try this method which doesn't have that
13899                      * pitfall; if performance issues are found, we can do a
13900                      * combination of the current approach plus that one */
13901                     upper_parse = len;
13902                     len = 0;
13903                     s = s0;
13904                     goto reparse;
13905                 }
13906             }   /* End of verifying node ends with an appropriate char */
13907
13908           loopdone:   /* Jumped to when encounters something that shouldn't be
13909                          in the node */
13910
13911             /* I (khw) don't know if you can get here with zero length, but the
13912              * old code handled this situation by creating a zero-length EXACT
13913              * node.  Might as well be NOTHING instead */
13914             if (len == 0) {
13915                 OP(ret) = NOTHING;
13916             }
13917             else {
13918                 if (FOLD) {
13919                     /* If 'maybe_exact' is still set here, means there are no
13920                      * code points in the node that participate in folds;
13921                      * similarly for 'maybe_exactfu' and code points that match
13922                      * differently depending on UTF8ness of the target string
13923                      * (for /u), or depending on locale for /l */
13924                     if (maybe_exact) {
13925                         OP(ret) = (LOC)
13926                                   ? EXACTL
13927                                   : EXACT;
13928                     }
13929                     else if (maybe_exactfu) {
13930                         OP(ret) = (LOC)
13931                                   ? EXACTFLU8
13932                                   : EXACTFU;
13933                     }
13934                 }
13935                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, len, ender,
13936                                            FALSE /* Don't look to see if could
13937                                                     be turned into an EXACT
13938                                                     node, as we have already
13939                                                     computed that */
13940                                           );
13941             }
13942
13943             RExC_parse = p - 1;
13944             Set_Node_Cur_Length(ret, parse_start);
13945             RExC_parse = p;
13946             {
13947                 /* len is STRLEN which is unsigned, need to copy to signed */
13948                 IV iv = len;
13949                 if (iv < 0)
13950                     vFAIL("Internal disaster");
13951             }
13952
13953         } /* End of label 'defchar:' */
13954         break;
13955     } /* End of giant switch on input character */
13956
13957     /* Position parse to next real character */
13958     skip_to_be_ignored_text(pRExC_state, &RExC_parse,
13959                                             FALSE /* Don't force to /x */ );
13960     if (PASS2 && *RExC_parse == '{' && OP(ret) != SBOL && ! regcurly(RExC_parse)) {
13961         ckWARNregdep(RExC_parse + 1, "Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.30), passed through");
13962     }
13963
13964     return(ret);
13965 }
13966
13967
13968 STATIC void
13969 S_populate_ANYOF_from_invlist(pTHX_ regnode *node, SV** invlist_ptr)
13970 {
13971     /* Uses the inversion list '*invlist_ptr' to populate the ANYOF 'node'.  It
13972      * sets up the bitmap and any flags, removing those code points from the
13973      * inversion list, setting it to NULL should it become completely empty */
13974
13975     PERL_ARGS_ASSERT_POPULATE_ANYOF_FROM_INVLIST;
13976     assert(PL_regkind[OP(node)] == ANYOF);
13977
13978     ANYOF_BITMAP_ZERO(node);
13979     if (*invlist_ptr) {
13980
13981         /* This gets set if we actually need to modify things */
13982         bool change_invlist = FALSE;
13983
13984         UV start, end;
13985
13986         /* Start looking through *invlist_ptr */
13987         invlist_iterinit(*invlist_ptr);
13988         while (invlist_iternext(*invlist_ptr, &start, &end)) {
13989             UV high;
13990             int i;
13991
13992             if (end == UV_MAX && start <= NUM_ANYOF_CODE_POINTS) {
13993                 ANYOF_FLAGS(node) |= ANYOF_MATCHES_ALL_ABOVE_BITMAP;
13994             }
13995
13996             /* Quit if are above what we should change */
13997             if (start >= NUM_ANYOF_CODE_POINTS) {
13998                 break;
13999             }
14000
14001             change_invlist = TRUE;
14002
14003             /* Set all the bits in the range, up to the max that we are doing */
14004             high = (end < NUM_ANYOF_CODE_POINTS - 1)
14005                    ? end
14006                    : NUM_ANYOF_CODE_POINTS - 1;
14007             for (i = start; i <= (int) high; i++) {
14008                 if (! ANYOF_BITMAP_TEST(node, i)) {
14009                     ANYOF_BITMAP_SET(node, i);
14010                 }
14011             }
14012         }
14013         invlist_iterfinish(*invlist_ptr);
14014
14015         /* Done with loop; remove any code points that are in the bitmap from
14016          * *invlist_ptr; similarly for code points above the bitmap if we have
14017          * a flag to match all of them anyways */
14018         if (change_invlist) {
14019             _invlist_subtract(*invlist_ptr, PL_InBitmap, invlist_ptr);
14020         }
14021         if (ANYOF_FLAGS(node) & ANYOF_MATCHES_ALL_ABOVE_BITMAP) {
14022             _invlist_intersection(*invlist_ptr, PL_InBitmap, invlist_ptr);
14023         }
14024
14025         /* If have completely emptied it, remove it completely */
14026         if (_invlist_len(*invlist_ptr) == 0) {
14027             SvREFCNT_dec_NN(*invlist_ptr);
14028             *invlist_ptr = NULL;
14029         }
14030     }
14031 }
14032
14033 /* Parse POSIX character classes: [[:foo:]], [[=foo=]], [[.foo.]].
14034    Character classes ([:foo:]) can also be negated ([:^foo:]).
14035    Returns a named class id (ANYOF_XXX) if successful, -1 otherwise.
14036    Equivalence classes ([=foo=]) and composites ([.foo.]) are parsed,
14037    but trigger failures because they are currently unimplemented. */
14038
14039 #define POSIXCC_DONE(c)   ((c) == ':')
14040 #define POSIXCC_NOTYET(c) ((c) == '=' || (c) == '.')
14041 #define POSIXCC(c) (POSIXCC_DONE(c) || POSIXCC_NOTYET(c))
14042 #define MAYBE_POSIXCC(c) (POSIXCC(c) || (c) == '^' || (c) == ';')
14043
14044 #define WARNING_PREFIX              "Assuming NOT a POSIX class since "
14045 #define NO_BLANKS_POSIX_WARNING     "no blanks are allowed in one"
14046 #define SEMI_COLON_POSIX_WARNING    "a semi-colon was found instead of a colon"
14047
14048 #define NOT_MEANT_TO_BE_A_POSIX_CLASS (OOB_NAMEDCLASS - 1)
14049
14050 /* 'posix_warnings' and 'warn_text' are names of variables in the following
14051  * routine. q.v. */
14052 #define ADD_POSIX_WARNING(p, text)  STMT_START {                            \
14053         if (posix_warnings) {                                               \
14054             if (! RExC_warn_text ) RExC_warn_text = (AV *) sv_2mortal((SV *) newAV()); \
14055             av_push(RExC_warn_text, Perl_newSVpvf(aTHX_                          \
14056                                              WARNING_PREFIX                 \
14057                                              text                           \
14058                                              REPORT_LOCATION,               \
14059                                              REPORT_LOCATION_ARGS(p)));     \
14060         }                                                                   \
14061     } STMT_END
14062 #define CLEAR_POSIX_WARNINGS()                                              \
14063     STMT_START {                                                            \
14064         if (posix_warnings && RExC_warn_text)                               \
14065             av_clear(RExC_warn_text);                                       \
14066     } STMT_END
14067
14068 #define CLEAR_POSIX_WARNINGS_AND_RETURN(ret)                                \
14069     STMT_START {                                                            \
14070         CLEAR_POSIX_WARNINGS();                                             \
14071         return ret;                                                         \
14072     } STMT_END
14073
14074 STATIC int
14075 S_handle_possible_posix(pTHX_ RExC_state_t *pRExC_state,
14076
14077     const char * const s,      /* Where the putative posix class begins.
14078                                   Normally, this is one past the '['.  This
14079                                   parameter exists so it can be somewhere
14080                                   besides RExC_parse. */
14081     char ** updated_parse_ptr, /* Where to set the updated parse pointer, or
14082                                   NULL */
14083     AV ** posix_warnings,      /* Where to place any generated warnings, or
14084                                   NULL */
14085     const bool check_only      /* Don't die if error */
14086 )
14087 {
14088     /* This parses what the caller thinks may be one of the three POSIX
14089      * constructs:
14090      *  1) a character class, like [:blank:]
14091      *  2) a collating symbol, like [. .]
14092      *  3) an equivalence class, like [= =]
14093      * In the latter two cases, it croaks if it finds a syntactically legal
14094      * one, as these are not handled by Perl.
14095      *
14096      * The main purpose is to look for a POSIX character class.  It returns:
14097      *  a) the class number
14098      *      if it is a completely syntactically and semantically legal class.
14099      *      'updated_parse_ptr', if not NULL, is set to point to just after the
14100      *      closing ']' of the class
14101      *  b) OOB_NAMEDCLASS
14102      *      if it appears that one of the three POSIX constructs was meant, but
14103      *      its specification was somehow defective.  'updated_parse_ptr', if
14104      *      not NULL, is set to point to the character just after the end
14105      *      character of the class.  See below for handling of warnings.
14106      *  c) NOT_MEANT_TO_BE_A_POSIX_CLASS
14107      *      if it  doesn't appear that a POSIX construct was intended.
14108      *      'updated_parse_ptr' is not changed.  No warnings nor errors are
14109      *      raised.
14110      *
14111      * In b) there may be errors or warnings generated.  If 'check_only' is
14112      * TRUE, then any errors are discarded.  Warnings are returned to the
14113      * caller via an AV* created into '*posix_warnings' if it is not NULL.  If
14114      * instead it is NULL, warnings are suppressed.  This is done in all
14115      * passes.  The reason for this is that the rest of the parsing is heavily
14116      * dependent on whether this routine found a valid posix class or not.  If
14117      * it did, the closing ']' is absorbed as part of the class.  If no class,
14118      * or an invalid one is found, any ']' will be considered the terminator of
14119      * the outer bracketed character class, leading to very different results.
14120      * In particular, a '(?[ ])' construct will likely have a syntax error if
14121      * the class is parsed other than intended, and this will happen in pass1,
14122      * before the warnings would normally be output.  This mechanism allows the
14123      * caller to output those warnings in pass1 just before dieing, giving a
14124      * much better clue as to what is wrong.
14125      *
14126      * The reason for this function, and its complexity is that a bracketed
14127      * character class can contain just about anything.  But it's easy to
14128      * mistype the very specific posix class syntax but yielding a valid
14129      * regular bracketed class, so it silently gets compiled into something
14130      * quite unintended.
14131      *
14132      * The solution adopted here maintains backward compatibility except that
14133      * it adds a warning if it looks like a posix class was intended but
14134      * improperly specified.  The warning is not raised unless what is input
14135      * very closely resembles one of the 14 legal posix classes.  To do this,
14136      * it uses fuzzy parsing.  It calculates how many single-character edits it
14137      * would take to transform what was input into a legal posix class.  Only
14138      * if that number is quite small does it think that the intention was a
14139      * posix class.  Obviously these are heuristics, and there will be cases
14140      * where it errs on one side or another, and they can be tweaked as
14141      * experience informs.
14142      *
14143      * The syntax for a legal posix class is:
14144      *
14145      * qr/(?xa: \[ : \^? [[:lower:]]{4,6} : \] )/
14146      *
14147      * What this routine considers syntactically to be an intended posix class
14148      * is this (the comments indicate some restrictions that the pattern
14149      * doesn't show):
14150      *
14151      *  qr/(?x: \[?                         # The left bracket, possibly
14152      *                                      # omitted
14153      *          \h*                         # possibly followed by blanks
14154      *          (?: \^ \h* )?               # possibly a misplaced caret
14155      *          [:;]?                       # The opening class character,
14156      *                                      # possibly omitted.  A typo
14157      *                                      # semi-colon can also be used.
14158      *          \h*
14159      *          \^?                         # possibly a correctly placed
14160      *                                      # caret, but not if there was also
14161      *                                      # a misplaced one
14162      *          \h*
14163      *          .{3,15}                     # The class name.  If there are
14164      *                                      # deviations from the legal syntax,
14165      *                                      # its edit distance must be close
14166      *                                      # to a real class name in order
14167      *                                      # for it to be considered to be
14168      *                                      # an intended posix class.
14169      *          \h*
14170      *          [[:punct:]]?                # The closing class character,
14171      *                                      # possibly omitted.  If not a colon
14172      *                                      # nor semi colon, the class name
14173      *                                      # must be even closer to a valid
14174      *                                      # one
14175      *          \h*
14176      *          \]?                         # The right bracket, possibly
14177      *                                      # omitted.
14178      *     )/
14179      *
14180      * In the above, \h must be ASCII-only.
14181      *
14182      * These are heuristics, and can be tweaked as field experience dictates.
14183      * There will be cases when someone didn't intend to specify a posix class
14184      * that this warns as being so.  The goal is to minimize these, while
14185      * maximizing the catching of things intended to be a posix class that
14186      * aren't parsed as such.
14187      */
14188
14189     const char* p             = s;
14190     const char * const e      = RExC_end;
14191     unsigned complement       = 0;      /* If to complement the class */
14192     bool found_problem        = FALSE;  /* Assume OK until proven otherwise */
14193     bool has_opening_bracket  = FALSE;
14194     bool has_opening_colon    = FALSE;
14195     int class_number          = OOB_NAMEDCLASS; /* Out-of-bounds until find
14196                                                    valid class */
14197     const char * possible_end = NULL;   /* used for a 2nd parse pass */
14198     const char* name_start;             /* ptr to class name first char */
14199
14200     /* If the number of single-character typos the input name is away from a
14201      * legal name is no more than this number, it is considered to have meant
14202      * the legal name */
14203     int max_distance          = 2;
14204
14205     /* to store the name.  The size determines the maximum length before we
14206      * decide that no posix class was intended.  Should be at least
14207      * sizeof("alphanumeric") */
14208     UV input_text[15];
14209     STATIC_ASSERT_DECL(C_ARRAY_LENGTH(input_text) >= sizeof "alphanumeric");
14210
14211     PERL_ARGS_ASSERT_HANDLE_POSSIBLE_POSIX;
14212
14213     CLEAR_POSIX_WARNINGS();
14214
14215     if (p >= e) {
14216         return NOT_MEANT_TO_BE_A_POSIX_CLASS;
14217     }
14218
14219     if (*(p - 1) != '[') {
14220         ADD_POSIX_WARNING(p, "it doesn't start with a '['");
14221         found_problem = TRUE;
14222     }
14223     else {
14224         has_opening_bracket = TRUE;
14225     }
14226
14227     /* They could be confused and think you can put spaces between the
14228      * components */
14229     if (isBLANK(*p)) {
14230         found_problem = TRUE;
14231
14232         do {
14233             p++;
14234         } while (p < e && isBLANK(*p));
14235
14236         ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
14237     }
14238
14239     /* For [. .] and [= =].  These are quite different internally from [: :],
14240      * so they are handled separately.  */
14241     if (POSIXCC_NOTYET(*p) && p < e - 3) /* 1 for the close, and 1 for the ']'
14242                                             and 1 for at least one char in it
14243                                           */
14244     {
14245         const char open_char  = *p;
14246         const char * temp_ptr = p + 1;
14247
14248         /* These two constructs are not handled by perl, and if we find a
14249          * syntactically valid one, we croak.  khw, who wrote this code, finds
14250          * this explanation of them very unclear:
14251          * http://pubs.opengroup.org/onlinepubs/009696899/basedefs/xbd_chap09.html
14252          * And searching the rest of the internet wasn't very helpful either.
14253          * It looks like just about any byte can be in these constructs,
14254          * depending on the locale.  But unless the pattern is being compiled
14255          * under /l, which is very rare, Perl runs under the C or POSIX locale.
14256          * In that case, it looks like [= =] isn't allowed at all, and that
14257          * [. .] could be any single code point, but for longer strings the
14258          * constituent characters would have to be the ASCII alphabetics plus
14259          * the minus-hyphen.  Any sensible locale definition would limit itself
14260          * to these.  And any portable one definitely should.  Trying to parse
14261          * the general case is a nightmare (see [perl #127604]).  So, this code
14262          * looks only for interiors of these constructs that match:
14263          *      qr/.|[-\w]{2,}/
14264          * Using \w relaxes the apparent rules a little, without adding much
14265          * danger of mistaking something else for one of these constructs.
14266          *
14267          * [. .] in some implementations described on the internet is usable to
14268          * escape a character that otherwise is special in bracketed character
14269          * classes.  For example [.].] means a literal right bracket instead of
14270          * the ending of the class
14271          *
14272          * [= =] can legitimately contain a [. .] construct, but we don't
14273          * handle this case, as that [. .] construct will later get parsed
14274          * itself and croak then.  And [= =] is checked for even when not under
14275          * /l, as Perl has long done so.
14276          *
14277          * The code below relies on there being a trailing NUL, so it doesn't
14278          * have to keep checking if the parse ptr < e.
14279          */
14280         if (temp_ptr[1] == open_char) {
14281             temp_ptr++;
14282         }
14283         else while (    temp_ptr < e
14284                     && (isWORDCHAR(*temp_ptr) || *temp_ptr == '-'))
14285         {
14286             temp_ptr++;
14287         }
14288
14289         if (*temp_ptr == open_char) {
14290             temp_ptr++;
14291             if (*temp_ptr == ']') {
14292                 temp_ptr++;
14293                 if (! found_problem && ! check_only) {
14294                     RExC_parse = (char *) temp_ptr;
14295                     vFAIL3("POSIX syntax [%c %c] is reserved for future "
14296                             "extensions", open_char, open_char);
14297                 }
14298
14299                 /* Here, the syntax wasn't completely valid, or else the call
14300                  * is to check-only */
14301                 if (updated_parse_ptr) {
14302                     *updated_parse_ptr = (char *) temp_ptr;
14303                 }
14304
14305                 CLEAR_POSIX_WARNINGS_AND_RETURN(OOB_NAMEDCLASS);
14306             }
14307         }
14308
14309         /* If we find something that started out to look like one of these
14310          * constructs, but isn't, we continue below so that it can be checked
14311          * for being a class name with a typo of '.' or '=' instead of a colon.
14312          * */
14313     }
14314
14315     /* Here, we think there is a possibility that a [: :] class was meant, and
14316      * we have the first real character.  It could be they think the '^' comes
14317      * first */
14318     if (*p == '^') {
14319         found_problem = TRUE;
14320         ADD_POSIX_WARNING(p + 1, "the '^' must come after the colon");
14321         complement = 1;
14322         p++;
14323
14324         if (isBLANK(*p)) {
14325             found_problem = TRUE;
14326
14327             do {
14328                 p++;
14329             } while (p < e && isBLANK(*p));
14330
14331             ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
14332         }
14333     }
14334
14335     /* But the first character should be a colon, which they could have easily
14336      * mistyped on a qwerty keyboard as a semi-colon (and which may be hard to
14337      * distinguish from a colon, so treat that as a colon).  */
14338     if (*p == ':') {
14339         p++;
14340         has_opening_colon = TRUE;
14341     }
14342     else if (*p == ';') {
14343         found_problem = TRUE;
14344         p++;
14345         ADD_POSIX_WARNING(p, SEMI_COLON_POSIX_WARNING);
14346         has_opening_colon = TRUE;
14347     }
14348     else {
14349         found_problem = TRUE;
14350         ADD_POSIX_WARNING(p, "there must be a starting ':'");
14351
14352         /* Consider an initial punctuation (not one of the recognized ones) to
14353          * be a left terminator */
14354         if (*p != '^' && *p != ']' && isPUNCT(*p)) {
14355             p++;
14356         }
14357     }
14358
14359     /* They may think that you can put spaces between the components */
14360     if (isBLANK(*p)) {
14361         found_problem = TRUE;
14362
14363         do {
14364             p++;
14365         } while (p < e && isBLANK(*p));
14366
14367         ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
14368     }
14369
14370     if (*p == '^') {
14371
14372         /* We consider something like [^:^alnum:]] to not have been intended to
14373          * be a posix class, but XXX maybe we should */
14374         if (complement) {
14375             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
14376         }
14377
14378         complement = 1;
14379         p++;
14380     }
14381
14382     /* Again, they may think that you can put spaces between the components */
14383     if (isBLANK(*p)) {
14384         found_problem = TRUE;
14385
14386         do {
14387             p++;
14388         } while (p < e && isBLANK(*p));
14389
14390         ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
14391     }
14392
14393     if (*p == ']') {
14394
14395         /* XXX This ']' may be a typo, and something else was meant.  But
14396          * treating it as such creates enough complications, that that
14397          * possibility isn't currently considered here.  So we assume that the
14398          * ']' is what is intended, and if we've already found an initial '[',
14399          * this leaves this construct looking like [:] or [:^], which almost
14400          * certainly weren't intended to be posix classes */
14401         if (has_opening_bracket) {
14402             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
14403         }
14404
14405         /* But this function can be called when we parse the colon for
14406          * something like qr/[alpha:]]/, so we back up to look for the
14407          * beginning */
14408         p--;
14409
14410         if (*p == ';') {
14411             found_problem = TRUE;
14412             ADD_POSIX_WARNING(p, SEMI_COLON_POSIX_WARNING);
14413         }
14414         else if (*p != ':') {
14415
14416             /* XXX We are currently very restrictive here, so this code doesn't
14417              * consider the possibility that, say, /[alpha.]]/ was intended to
14418              * be a posix class. */
14419             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
14420         }
14421
14422         /* Here we have something like 'foo:]'.  There was no initial colon,
14423          * and we back up over 'foo.  XXX Unlike the going forward case, we
14424          * don't handle typos of non-word chars in the middle */
14425         has_opening_colon = FALSE;
14426         p--;
14427
14428         while (p > RExC_start && isWORDCHAR(*p)) {
14429             p--;
14430         }
14431         p++;
14432
14433         /* Here, we have positioned ourselves to where we think the first
14434          * character in the potential class is */
14435     }
14436
14437     /* Now the interior really starts.  There are certain key characters that
14438      * can end the interior, or these could just be typos.  To catch both
14439      * cases, we may have to do two passes.  In the first pass, we keep on
14440      * going unless we come to a sequence that matches
14441      *      qr/ [[:punct:]] [[:blank:]]* \] /xa
14442      * This means it takes a sequence to end the pass, so two typos in a row if
14443      * that wasn't what was intended.  If the class is perfectly formed, just
14444      * this one pass is needed.  We also stop if there are too many characters
14445      * being accumulated, but this number is deliberately set higher than any
14446      * real class.  It is set high enough so that someone who thinks that
14447      * 'alphanumeric' is a correct name would get warned that it wasn't.
14448      * While doing the pass, we keep track of where the key characters were in
14449      * it.  If we don't find an end to the class, and one of the key characters
14450      * was found, we redo the pass, but stop when we get to that character.
14451      * Thus the key character was considered a typo in the first pass, but a
14452      * terminator in the second.  If two key characters are found, we stop at
14453      * the second one in the first pass.  Again this can miss two typos, but
14454      * catches a single one
14455      *
14456      * In the first pass, 'possible_end' starts as NULL, and then gets set to
14457      * point to the first key character.  For the second pass, it starts as -1.
14458      * */
14459
14460     name_start = p;
14461   parse_name:
14462     {
14463         bool has_blank               = FALSE;
14464         bool has_upper               = FALSE;
14465         bool has_terminating_colon   = FALSE;
14466         bool has_terminating_bracket = FALSE;
14467         bool has_semi_colon          = FALSE;
14468         unsigned int name_len        = 0;
14469         int punct_count              = 0;
14470
14471         while (p < e) {
14472
14473             /* Squeeze out blanks when looking up the class name below */
14474             if (isBLANK(*p) ) {
14475                 has_blank = TRUE;
14476                 found_problem = TRUE;
14477                 p++;
14478                 continue;
14479             }
14480
14481             /* The name will end with a punctuation */
14482             if (isPUNCT(*p)) {
14483                 const char * peek = p + 1;
14484
14485                 /* Treat any non-']' punctuation followed by a ']' (possibly
14486                  * with intervening blanks) as trying to terminate the class.
14487                  * ']]' is very likely to mean a class was intended (but
14488                  * missing the colon), but the warning message that gets
14489                  * generated shows the error position better if we exit the
14490                  * loop at the bottom (eventually), so skip it here. */
14491                 if (*p != ']') {
14492                     if (peek < e && isBLANK(*peek)) {
14493                         has_blank = TRUE;
14494                         found_problem = TRUE;
14495                         do {
14496                             peek++;
14497                         } while (peek < e && isBLANK(*peek));
14498                     }
14499
14500                     if (peek < e && *peek == ']') {
14501                         has_terminating_bracket = TRUE;
14502                         if (*p == ':') {
14503                             has_terminating_colon = TRUE;
14504                         }
14505                         else if (*p == ';') {
14506                             has_semi_colon = TRUE;
14507                             has_terminating_colon = TRUE;
14508                         }
14509                         else {
14510                             found_problem = TRUE;
14511                         }
14512                         p = peek + 1;
14513                         goto try_posix;
14514                     }
14515                 }
14516
14517                 /* Here we have punctuation we thought didn't end the class.
14518                  * Keep track of the position of the key characters that are
14519                  * more likely to have been class-enders */
14520                 if (*p == ']' || *p == '[' || *p == ':' || *p == ';') {
14521
14522                     /* Allow just one such possible class-ender not actually
14523                      * ending the class. */
14524                     if (possible_end) {
14525                         break;
14526                     }
14527                     possible_end = p;
14528                 }
14529
14530                 /* If we have too many punctuation characters, no use in
14531                  * keeping going */
14532                 if (++punct_count > max_distance) {
14533                     break;
14534                 }
14535
14536                 /* Treat the punctuation as a typo. */
14537                 input_text[name_len++] = *p;
14538                 p++;
14539             }
14540             else if (isUPPER(*p)) { /* Use lowercase for lookup */
14541                 input_text[name_len++] = toLOWER(*p);
14542                 has_upper = TRUE;
14543                 found_problem = TRUE;
14544                 p++;
14545             } else if (! UTF || UTF8_IS_INVARIANT(*p)) {
14546                 input_text[name_len++] = *p;
14547                 p++;
14548             }
14549             else {
14550                 input_text[name_len++] = utf8_to_uvchr_buf((U8 *) p, e, NULL);
14551                 p+= UTF8SKIP(p);
14552             }
14553
14554             /* The declaration of 'input_text' is how long we allow a potential
14555              * class name to be, before saying they didn't mean a class name at
14556              * all */
14557             if (name_len >= C_ARRAY_LENGTH(input_text)) {
14558                 break;
14559             }
14560         }
14561
14562         /* We get to here when the possible class name hasn't been properly
14563          * terminated before:
14564          *   1) we ran off the end of the pattern; or
14565          *   2) found two characters, each of which might have been intended to
14566          *      be the name's terminator
14567          *   3) found so many punctuation characters in the purported name,
14568          *      that the edit distance to a valid one is exceeded
14569          *   4) we decided it was more characters than anyone could have
14570          *      intended to be one. */
14571
14572         found_problem = TRUE;
14573
14574         /* In the final two cases, we know that looking up what we've
14575          * accumulated won't lead to a match, even a fuzzy one. */
14576         if (   name_len >= C_ARRAY_LENGTH(input_text)
14577             || punct_count > max_distance)
14578         {
14579             /* If there was an intermediate key character that could have been
14580              * an intended end, redo the parse, but stop there */
14581             if (possible_end && possible_end != (char *) -1) {
14582                 possible_end = (char *) -1; /* Special signal value to say
14583                                                we've done a first pass */
14584                 p = name_start;
14585                 goto parse_name;
14586             }
14587
14588             /* Otherwise, it can't have meant to have been a class */
14589             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
14590         }
14591
14592         /* If we ran off the end, and the final character was a punctuation
14593          * one, back up one, to look at that final one just below.  Later, we
14594          * will restore the parse pointer if appropriate */
14595         if (name_len && p == e && isPUNCT(*(p-1))) {
14596             p--;
14597             name_len--;
14598         }
14599
14600         if (p < e && isPUNCT(*p)) {
14601             if (*p == ']') {
14602                 has_terminating_bracket = TRUE;
14603
14604                 /* If this is a 2nd ']', and the first one is just below this
14605                  * one, consider that to be the real terminator.  This gives a
14606                  * uniform and better positioning for the warning message  */
14607                 if (   possible_end
14608                     && possible_end != (char *) -1
14609                     && *possible_end == ']'
14610                     && name_len && input_text[name_len - 1] == ']')
14611                 {
14612                     name_len--;
14613                     p = possible_end;
14614
14615                     /* And this is actually equivalent to having done the 2nd
14616                      * pass now, so set it to not try again */
14617                     possible_end = (char *) -1;
14618                 }
14619             }
14620             else {
14621                 if (*p == ':') {
14622                     has_terminating_colon = TRUE;
14623                 }
14624                 else if (*p == ';') {
14625                     has_semi_colon = TRUE;
14626                     has_terminating_colon = TRUE;
14627                 }
14628                 p++;
14629             }
14630         }
14631
14632     try_posix:
14633
14634         /* Here, we have a class name to look up.  We can short circuit the
14635          * stuff below for short names that can't possibly be meant to be a
14636          * class name.  (We can do this on the first pass, as any second pass
14637          * will yield an even shorter name) */
14638         if (name_len < 3) {
14639             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
14640         }
14641
14642         /* Find which class it is.  Initially switch on the length of the name.
14643          * */
14644         switch (name_len) {
14645             case 4:
14646                 if (memEQs(name_start, 4, "word")) {
14647                     /* this is not POSIX, this is the Perl \w */
14648                     class_number = ANYOF_WORDCHAR;
14649                 }
14650                 break;
14651             case 5:
14652                 /* Names all of length 5: alnum alpha ascii blank cntrl digit
14653                  *                        graph lower print punct space upper
14654                  * Offset 4 gives the best switch position.  */
14655                 switch (name_start[4]) {
14656                     case 'a':
14657                         if (memBEGINs(name_start, 5, "alph")) /* alpha */
14658                             class_number = ANYOF_ALPHA;
14659                         break;
14660                     case 'e':
14661                         if (memBEGINs(name_start, 5, "spac")) /* space */
14662                             class_number = ANYOF_SPACE;
14663                         break;
14664                     case 'h':
14665                         if (memBEGINs(name_start, 5, "grap")) /* graph */
14666                             class_number = ANYOF_GRAPH;
14667                         break;
14668                     case 'i':
14669                         if (memBEGINs(name_start, 5, "asci")) /* ascii */
14670                             class_number = ANYOF_ASCII;
14671                         break;
14672                     case 'k':
14673                         if (memBEGINs(name_start, 5, "blan")) /* blank */
14674                             class_number = ANYOF_BLANK;
14675                         break;
14676                     case 'l':
14677                         if (memBEGINs(name_start, 5, "cntr")) /* cntrl */
14678                             class_number = ANYOF_CNTRL;
14679                         break;
14680                     case 'm':
14681                         if (memBEGINs(name_start, 5, "alnu")) /* alnum */
14682                             class_number = ANYOF_ALPHANUMERIC;
14683                         break;
14684                     case 'r':
14685                         if (memBEGINs(name_start, 5, "lowe")) /* lower */
14686                             class_number = (FOLD) ? ANYOF_CASED : ANYOF_LOWER;
14687                         else if (memBEGINs(name_start, 5, "uppe")) /* upper */
14688                             class_number = (FOLD) ? ANYOF_CASED : ANYOF_UPPER;
14689                         break;
14690                     case 't':
14691                         if (memBEGINs(name_start, 5, "digi")) /* digit */
14692                             class_number = ANYOF_DIGIT;
14693                         else if (memBEGINs(name_start, 5, "prin")) /* print */
14694                             class_number = ANYOF_PRINT;
14695                         else if (memBEGINs(name_start, 5, "punc")) /* punct */
14696                             class_number = ANYOF_PUNCT;
14697                         break;
14698                 }
14699                 break;
14700             case 6:
14701                 if (memEQs(name_start, 6, "xdigit"))
14702                     class_number = ANYOF_XDIGIT;
14703                 break;
14704         }
14705
14706         /* If the name exactly matches a posix class name the class number will
14707          * here be set to it, and the input almost certainly was meant to be a
14708          * posix class, so we can skip further checking.  If instead the syntax
14709          * is exactly correct, but the name isn't one of the legal ones, we
14710          * will return that as an error below.  But if neither of these apply,
14711          * it could be that no posix class was intended at all, or that one
14712          * was, but there was a typo.  We tease these apart by doing fuzzy
14713          * matching on the name */
14714         if (class_number == OOB_NAMEDCLASS && found_problem) {
14715             const UV posix_names[][6] = {
14716                                                 { 'a', 'l', 'n', 'u', 'm' },
14717                                                 { 'a', 'l', 'p', 'h', 'a' },
14718                                                 { 'a', 's', 'c', 'i', 'i' },
14719                                                 { 'b', 'l', 'a', 'n', 'k' },
14720                                                 { 'c', 'n', 't', 'r', 'l' },
14721                                                 { 'd', 'i', 'g', 'i', 't' },
14722                                                 { 'g', 'r', 'a', 'p', 'h' },
14723                                                 { 'l', 'o', 'w', 'e', 'r' },
14724                                                 { 'p', 'r', 'i', 'n', 't' },
14725                                                 { 'p', 'u', 'n', 'c', 't' },
14726                                                 { 's', 'p', 'a', 'c', 'e' },
14727                                                 { 'u', 'p', 'p', 'e', 'r' },
14728                                                 { 'w', 'o', 'r', 'd' },
14729                                                 { 'x', 'd', 'i', 'g', 'i', 't' }
14730                                             };
14731             /* The names of the above all have added NULs to make them the same
14732              * size, so we need to also have the real lengths */
14733             const UV posix_name_lengths[] = {
14734                                                 sizeof("alnum") - 1,
14735                                                 sizeof("alpha") - 1,
14736                                                 sizeof("ascii") - 1,
14737                                                 sizeof("blank") - 1,
14738                                                 sizeof("cntrl") - 1,
14739                                                 sizeof("digit") - 1,
14740                                                 sizeof("graph") - 1,
14741                                                 sizeof("lower") - 1,
14742                                                 sizeof("print") - 1,
14743                                                 sizeof("punct") - 1,
14744                                                 sizeof("space") - 1,
14745                                                 sizeof("upper") - 1,
14746                                                 sizeof("word")  - 1,
14747                                                 sizeof("xdigit")- 1
14748                                             };
14749             unsigned int i;
14750             int temp_max = max_distance;    /* Use a temporary, so if we
14751                                                reparse, we haven't changed the
14752                                                outer one */
14753
14754             /* Use a smaller max edit distance if we are missing one of the
14755              * delimiters */
14756             if (   has_opening_bracket + has_opening_colon < 2
14757                 || has_terminating_bracket + has_terminating_colon < 2)
14758             {
14759                 temp_max--;
14760             }
14761
14762             /* See if the input name is close to a legal one */
14763             for (i = 0; i < C_ARRAY_LENGTH(posix_names); i++) {
14764
14765                 /* Short circuit call if the lengths are too far apart to be
14766                  * able to match */
14767                 if (abs( (int) (name_len - posix_name_lengths[i]))
14768                     > temp_max)
14769                 {
14770                     continue;
14771                 }
14772
14773                 if (edit_distance(input_text,
14774                                   posix_names[i],
14775                                   name_len,
14776                                   posix_name_lengths[i],
14777                                   temp_max
14778                                  )
14779                     > -1)
14780                 { /* If it is close, it probably was intended to be a class */
14781                     goto probably_meant_to_be;
14782                 }
14783             }
14784
14785             /* Here the input name is not close enough to a valid class name
14786              * for us to consider it to be intended to be a posix class.  If
14787              * we haven't already done so, and the parse found a character that
14788              * could have been terminators for the name, but which we absorbed
14789              * as typos during the first pass, repeat the parse, signalling it
14790              * to stop at that character */
14791             if (possible_end && possible_end != (char *) -1) {
14792                 possible_end = (char *) -1;
14793                 p = name_start;
14794                 goto parse_name;
14795             }
14796
14797             /* Here neither pass found a close-enough class name */
14798             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
14799         }
14800
14801     probably_meant_to_be:
14802
14803         /* Here we think that a posix specification was intended.  Update any
14804          * parse pointer */
14805         if (updated_parse_ptr) {
14806             *updated_parse_ptr = (char *) p;
14807         }
14808
14809         /* If a posix class name was intended but incorrectly specified, we
14810          * output or return the warnings */
14811         if (found_problem) {
14812
14813             /* We set flags for these issues in the parse loop above instead of
14814              * adding them to the list of warnings, because we can parse it
14815              * twice, and we only want one warning instance */
14816             if (has_upper) {
14817                 ADD_POSIX_WARNING(p, "the name must be all lowercase letters");
14818             }
14819             if (has_blank) {
14820                 ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
14821             }
14822             if (has_semi_colon) {
14823                 ADD_POSIX_WARNING(p, SEMI_COLON_POSIX_WARNING);
14824             }
14825             else if (! has_terminating_colon) {
14826                 ADD_POSIX_WARNING(p, "there is no terminating ':'");
14827             }
14828             if (! has_terminating_bracket) {
14829                 ADD_POSIX_WARNING(p, "there is no terminating ']'");
14830             }
14831
14832             if (posix_warnings && RExC_warn_text && av_top_index(RExC_warn_text) > -1) {
14833                 *posix_warnings = RExC_warn_text;
14834             }
14835         }
14836         else if (class_number != OOB_NAMEDCLASS) {
14837             /* If it is a known class, return the class.  The class number
14838              * #defines are structured so each complement is +1 to the normal
14839              * one */
14840             CLEAR_POSIX_WARNINGS_AND_RETURN(class_number + complement);
14841         }
14842         else if (! check_only) {
14843
14844             /* Here, it is an unrecognized class.  This is an error (unless the
14845             * call is to check only, which we've already handled above) */
14846             const char * const complement_string = (complement)
14847                                                    ? "^"
14848                                                    : "";
14849             RExC_parse = (char *) p;
14850             vFAIL3utf8f("POSIX class [:%s%" UTF8f ":] unknown",
14851                         complement_string,
14852                         UTF8fARG(UTF, RExC_parse - name_start - 2, name_start));
14853         }
14854     }
14855
14856     return OOB_NAMEDCLASS;
14857 }
14858 #undef ADD_POSIX_WARNING
14859
14860 STATIC unsigned  int
14861 S_regex_set_precedence(const U8 my_operator) {
14862
14863     /* Returns the precedence in the (?[...]) construct of the input operator,
14864      * specified by its character representation.  The precedence follows
14865      * general Perl rules, but it extends this so that ')' and ']' have (low)
14866      * precedence even though they aren't really operators */
14867
14868     switch (my_operator) {
14869         case '!':
14870             return 5;
14871         case '&':
14872             return 4;
14873         case '^':
14874         case '|':
14875         case '+':
14876         case '-':
14877             return 3;
14878         case ')':
14879             return 2;
14880         case ']':
14881             return 1;
14882     }
14883
14884     NOT_REACHED; /* NOTREACHED */
14885     return 0;   /* Silence compiler warning */
14886 }
14887
14888 STATIC regnode *
14889 S_handle_regex_sets(pTHX_ RExC_state_t *pRExC_state, SV** return_invlist,
14890                     I32 *flagp, U32 depth,
14891                     char * const oregcomp_parse)
14892 {
14893     /* Handle the (?[...]) construct to do set operations */
14894
14895     U8 curchar;                     /* Current character being parsed */
14896     UV start, end;                  /* End points of code point ranges */
14897     SV* final = NULL;               /* The end result inversion list */
14898     SV* result_string;              /* 'final' stringified */
14899     AV* stack;                      /* stack of operators and operands not yet
14900                                        resolved */
14901     AV* fence_stack = NULL;         /* A stack containing the positions in
14902                                        'stack' of where the undealt-with left
14903                                        parens would be if they were actually
14904                                        put there */
14905     /* The 'volatile' is a workaround for an optimiser bug
14906      * in Solaris Studio 12.3. See RT #127455 */
14907     volatile IV fence = 0;          /* Position of where most recent undealt-
14908                                        with left paren in stack is; -1 if none.
14909                                      */
14910     STRLEN len;                     /* Temporary */
14911     regnode* node;                  /* Temporary, and final regnode returned by
14912                                        this function */
14913     const bool save_fold = FOLD;    /* Temporary */
14914     char *save_end, *save_parse;    /* Temporaries */
14915     const bool in_locale = LOC;     /* we turn off /l during processing */
14916     AV* posix_warnings = NULL;
14917
14918     GET_RE_DEBUG_FLAGS_DECL;
14919
14920     PERL_ARGS_ASSERT_HANDLE_REGEX_SETS;
14921
14922     DEBUG_PARSE("xcls");
14923
14924     if (in_locale) {
14925         set_regex_charset(&RExC_flags, REGEX_UNICODE_CHARSET);
14926     }
14927
14928     REQUIRE_UNI_RULES(flagp, NULL);   /* The use of this operator implies /u.
14929                                          This is required so that the compile
14930                                          time values are valid in all runtime
14931                                          cases */
14932
14933     /* This will return only an ANYOF regnode, or (unlikely) something smaller
14934      * (such as EXACT).  Thus we can skip most everything if just sizing.  We
14935      * call regclass to handle '[]' so as to not have to reinvent its parsing
14936      * rules here (throwing away the size it computes each time).  And, we exit
14937      * upon an unescaped ']' that isn't one ending a regclass.  To do both
14938      * these things, we need to realize that something preceded by a backslash
14939      * is escaped, so we have to keep track of backslashes */
14940     if (SIZE_ONLY) {
14941         UV nest_depth = 0; /* how many nested (?[...]) constructs */
14942
14943         while (RExC_parse < RExC_end) {
14944             SV* current = NULL;
14945
14946             skip_to_be_ignored_text(pRExC_state, &RExC_parse,
14947                                     TRUE /* Force /x */ );
14948
14949             switch (*RExC_parse) {
14950                 case '(':
14951                     if (RExC_parse[1] == '?' && RExC_parse[2] == '[')
14952                         nest_depth++, RExC_parse+=2;
14953                     /* FALLTHROUGH */
14954                 default:
14955                     break;
14956                 case '\\':
14957                     /* Skip past this, so the next character gets skipped, after
14958                      * the switch */
14959                     RExC_parse++;
14960                     if (*RExC_parse == 'c') {
14961                             /* Skip the \cX notation for control characters */
14962                             RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
14963                     }
14964                     break;
14965
14966                 case '[':
14967                 {
14968                     /* See if this is a [:posix:] class. */
14969                     bool is_posix_class = (OOB_NAMEDCLASS
14970                             < handle_possible_posix(pRExC_state,
14971                                                 RExC_parse + 1,
14972                                                 NULL,
14973                                                 NULL,
14974                                                 TRUE /* checking only */));
14975                     /* If it is a posix class, leave the parse pointer at the
14976                      * '[' to fool regclass() into thinking it is part of a
14977                      * '[[:posix:]]'. */
14978                     if (! is_posix_class) {
14979                         RExC_parse++;
14980                     }
14981
14982                     /* regclass() can only return RESTART_PASS1 and NEED_UTF8
14983                      * if multi-char folds are allowed.  */
14984                     if (!regclass(pRExC_state, flagp,depth+1,
14985                                   is_posix_class, /* parse the whole char
14986                                                      class only if not a
14987                                                      posix class */
14988                                   FALSE, /* don't allow multi-char folds */
14989                                   TRUE, /* silence non-portable warnings. */
14990                                   TRUE, /* strict */
14991                                   FALSE, /* Require return to be an ANYOF */
14992                                   &current,
14993                                   &posix_warnings
14994                                  ))
14995                         FAIL2("panic: regclass returned NULL to handle_sets, "
14996                               "flags=%#" UVxf, (UV) *flagp);
14997
14998                     /* function call leaves parse pointing to the ']', except
14999                      * if we faked it */
15000                     if (is_posix_class) {
15001                         RExC_parse--;
15002                     }
15003
15004                     SvREFCNT_dec(current);   /* In case it returned something */
15005                     break;
15006                 }
15007
15008                 case ']':
15009                     if (RExC_parse[1] == ')') {
15010                         RExC_parse++;
15011                         if (nest_depth--) break;
15012                         node = reganode(pRExC_state, ANYOF, 0);
15013                         RExC_size += ANYOF_SKIP;
15014                         nextchar(pRExC_state);
15015                         Set_Node_Length(node,
15016                                 RExC_parse - oregcomp_parse + 1); /* MJD */
15017                         if (in_locale) {
15018                             set_regex_charset(&RExC_flags, REGEX_LOCALE_CHARSET);
15019                         }
15020
15021                         return node;
15022                     }
15023                     /* We output the messages even if warnings are off, because we'll fail
15024                      * the very next thing, and these give a likely diagnosis for that */
15025                     if (posix_warnings && av_tindex_skip_len_mg(posix_warnings) >= 0) {
15026                         output_or_return_posix_warnings(pRExC_state, posix_warnings, NULL);
15027                     }
15028                     RExC_parse++;
15029                     vFAIL("Unexpected ']' with no following ')' in (?[...");
15030             }
15031
15032             RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
15033         }
15034
15035         /* We output the messages even if warnings are off, because we'll fail
15036          * the very next thing, and these give a likely diagnosis for that */
15037         if (posix_warnings && av_tindex_skip_len_mg(posix_warnings) >= 0) {
15038             output_or_return_posix_warnings(pRExC_state, posix_warnings, NULL);
15039         }
15040
15041         vFAIL("Syntax error in (?[...])");
15042     }
15043
15044     /* Pass 2 only after this. */
15045     Perl_ck_warner_d(aTHX_
15046         packWARN(WARN_EXPERIMENTAL__REGEX_SETS),
15047         "The regex_sets feature is experimental" REPORT_LOCATION,
15048         REPORT_LOCATION_ARGS(RExC_parse));
15049
15050     /* Everything in this construct is a metacharacter.  Operands begin with
15051      * either a '\' (for an escape sequence), or a '[' for a bracketed
15052      * character class.  Any other character should be an operator, or
15053      * parenthesis for grouping.  Both types of operands are handled by calling
15054      * regclass() to parse them.  It is called with a parameter to indicate to
15055      * return the computed inversion list.  The parsing here is implemented via
15056      * a stack.  Each entry on the stack is a single character representing one
15057      * of the operators; or else a pointer to an operand inversion list. */
15058
15059 #define IS_OPERATOR(a) SvIOK(a)
15060 #define IS_OPERAND(a)  (! IS_OPERATOR(a))
15061
15062     /* The stack is kept in Łukasiewicz order.  (That's pronounced similar
15063      * to luke-a-shave-itch (or -itz), but people who didn't want to bother
15064      * with pronouncing it called it Reverse Polish instead, but now that YOU
15065      * know how to pronounce it you can use the correct term, thus giving due
15066      * credit to the person who invented it, and impressing your geek friends.
15067      * Wikipedia says that the pronounciation of "Ł" has been changing so that
15068      * it is now more like an English initial W (as in wonk) than an L.)
15069      *
15070      * This means that, for example, 'a | b & c' is stored on the stack as
15071      *
15072      * c  [4]
15073      * b  [3]
15074      * &  [2]
15075      * a  [1]
15076      * |  [0]
15077      *
15078      * where the numbers in brackets give the stack [array] element number.
15079      * In this implementation, parentheses are not stored on the stack.
15080      * Instead a '(' creates a "fence" so that the part of the stack below the
15081      * fence is invisible except to the corresponding ')' (this allows us to
15082      * replace testing for parens, by using instead subtraction of the fence
15083      * position).  As new operands are processed they are pushed onto the stack
15084      * (except as noted in the next paragraph).  New operators of higher
15085      * precedence than the current final one are inserted on the stack before
15086      * the lhs operand (so that when the rhs is pushed next, everything will be
15087      * in the correct positions shown above.  When an operator of equal or
15088      * lower precedence is encountered in parsing, all the stacked operations
15089      * of equal or higher precedence are evaluated, leaving the result as the
15090      * top entry on the stack.  This makes higher precedence operations
15091      * evaluate before lower precedence ones, and causes operations of equal
15092      * precedence to left associate.
15093      *
15094      * The only unary operator '!' is immediately pushed onto the stack when
15095      * encountered.  When an operand is encountered, if the top of the stack is
15096      * a '!", the complement is immediately performed, and the '!' popped.  The
15097      * resulting value is treated as a new operand, and the logic in the
15098      * previous paragraph is executed.  Thus in the expression
15099      *      [a] + ! [b]
15100      * the stack looks like
15101      *
15102      * !
15103      * a
15104      * +
15105      *
15106      * as 'b' gets parsed, the latter gets evaluated to '!b', and the stack
15107      * becomes
15108      *
15109      * !b
15110      * a
15111      * +
15112      *
15113      * A ')' is treated as an operator with lower precedence than all the
15114      * aforementioned ones, which causes all operations on the stack above the
15115      * corresponding '(' to be evaluated down to a single resultant operand.
15116      * Then the fence for the '(' is removed, and the operand goes through the
15117      * algorithm above, without the fence.
15118      *
15119      * A separate stack is kept of the fence positions, so that the position of
15120      * the latest so-far unbalanced '(' is at the top of it.
15121      *
15122      * The ']' ending the construct is treated as the lowest operator of all,
15123      * so that everything gets evaluated down to a single operand, which is the
15124      * result */
15125
15126     sv_2mortal((SV *)(stack = newAV()));
15127     sv_2mortal((SV *)(fence_stack = newAV()));
15128
15129     while (RExC_parse < RExC_end) {
15130         I32 top_index;              /* Index of top-most element in 'stack' */
15131         SV** top_ptr;               /* Pointer to top 'stack' element */
15132         SV* current = NULL;         /* To contain the current inversion list
15133                                        operand */
15134         SV* only_to_avoid_leaks;
15135
15136         skip_to_be_ignored_text(pRExC_state, &RExC_parse,
15137                                 TRUE /* Force /x */ );
15138         if (RExC_parse >= RExC_end) {
15139             Perl_croak(aTHX_ "panic: Read past end of '(?[ ])'");
15140         }
15141
15142         curchar = UCHARAT(RExC_parse);
15143
15144 redo_curchar:
15145
15146 #ifdef ENABLE_REGEX_SETS_DEBUGGING
15147                     /* Enable with -Accflags=-DENABLE_REGEX_SETS_DEBUGGING */
15148         DEBUG_U(dump_regex_sets_structures(pRExC_state,
15149                                            stack, fence, fence_stack));
15150 #endif
15151
15152         top_index = av_tindex_skip_len_mg(stack);
15153
15154         switch (curchar) {
15155             SV** stacked_ptr;       /* Ptr to something already on 'stack' */
15156             char stacked_operator;  /* The topmost operator on the 'stack'. */
15157             SV* lhs;                /* Operand to the left of the operator */
15158             SV* rhs;                /* Operand to the right of the operator */
15159             SV* fence_ptr;          /* Pointer to top element of the fence
15160                                        stack */
15161
15162             case '(':
15163
15164                 if (   RExC_parse < RExC_end - 1
15165                     && (UCHARAT(RExC_parse + 1) == '?'))
15166                 {
15167                     /* If is a '(?', could be an embedded '(?flags:(?[...])'.
15168                      * This happens when we have some thing like
15169                      *
15170                      *   my $thai_or_lao = qr/(?[ \p{Thai} + \p{Lao} ])/;
15171                      *   ...
15172                      *   qr/(?[ \p{Digit} & $thai_or_lao ])/;
15173                      *
15174                      * Here we would be handling the interpolated
15175                      * '$thai_or_lao'.  We handle this by a recursive call to
15176                      * ourselves which returns the inversion list the
15177                      * interpolated expression evaluates to.  We use the flags
15178                      * from the interpolated pattern. */
15179                     U32 save_flags = RExC_flags;
15180                     const char * save_parse;
15181
15182                     RExC_parse += 2;        /* Skip past the '(?' */
15183                     save_parse = RExC_parse;
15184
15185                     /* Parse any flags for the '(?' */
15186                     parse_lparen_question_flags(pRExC_state);
15187
15188                     if (RExC_parse == save_parse  /* Makes sure there was at
15189                                                      least one flag (or else
15190                                                      this embedding wasn't
15191                                                      compiled) */
15192                         || RExC_parse >= RExC_end - 4
15193                         || UCHARAT(RExC_parse) != ':'
15194                         || UCHARAT(++RExC_parse) != '('
15195                         || UCHARAT(++RExC_parse) != '?'
15196                         || UCHARAT(++RExC_parse) != '[')
15197                     {
15198
15199                         /* In combination with the above, this moves the
15200                          * pointer to the point just after the first erroneous
15201                          * character (or if there are no flags, to where they
15202                          * should have been) */
15203                         if (RExC_parse >= RExC_end - 4) {
15204                             RExC_parse = RExC_end;
15205                         }
15206                         else if (RExC_parse != save_parse) {
15207                             RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
15208                         }
15209                         vFAIL("Expecting '(?flags:(?[...'");
15210                     }
15211
15212                     /* Recurse, with the meat of the embedded expression */
15213                     RExC_parse++;
15214                     (void) handle_regex_sets(pRExC_state, &current, flagp,
15215                                                     depth+1, oregcomp_parse);
15216
15217                     /* Here, 'current' contains the embedded expression's
15218                      * inversion list, and RExC_parse points to the trailing
15219                      * ']'; the next character should be the ')' */
15220                     RExC_parse++;
15221                     if (UCHARAT(RExC_parse) != ')')
15222                         vFAIL("Expecting close paren for nested extended charclass");
15223
15224                     /* Then the ')' matching the original '(' handled by this
15225                      * case: statement */
15226                     RExC_parse++;
15227                     if (UCHARAT(RExC_parse) != ')')
15228                         vFAIL("Expecting close paren for wrapper for nested extended charclass");
15229
15230                     RExC_parse++;
15231                     RExC_flags = save_flags;
15232                     goto handle_operand;
15233                 }
15234
15235                 /* A regular '('.  Look behind for illegal syntax */
15236                 if (top_index - fence >= 0) {
15237                     /* If the top entry on the stack is an operator, it had
15238                      * better be a '!', otherwise the entry below the top
15239                      * operand should be an operator */
15240                     if (   ! (top_ptr = av_fetch(stack, top_index, FALSE))
15241                         || (IS_OPERATOR(*top_ptr) && SvUV(*top_ptr) != '!')
15242                         || (   IS_OPERAND(*top_ptr)
15243                             && (   top_index - fence < 1
15244                                 || ! (stacked_ptr = av_fetch(stack,
15245                                                              top_index - 1,
15246                                                              FALSE))
15247                                 || ! IS_OPERATOR(*stacked_ptr))))
15248                     {
15249                         RExC_parse++;
15250                         vFAIL("Unexpected '(' with no preceding operator");
15251                     }
15252                 }
15253
15254                 /* Stack the position of this undealt-with left paren */
15255                 av_push(fence_stack, newSViv(fence));
15256                 fence = top_index + 1;
15257                 break;
15258
15259             case '\\':
15260                 /* regclass() can only return RESTART_PASS1 and NEED_UTF8 if
15261                  * multi-char folds are allowed.  */
15262                 if (!regclass(pRExC_state, flagp,depth+1,
15263                               TRUE, /* means parse just the next thing */
15264                               FALSE, /* don't allow multi-char folds */
15265                               FALSE, /* don't silence non-portable warnings.  */
15266                               TRUE,  /* strict */
15267                               FALSE, /* Require return to be an ANYOF */
15268                               &current,
15269                               NULL))
15270                 {
15271                     FAIL2("panic: regclass returned NULL to handle_sets, "
15272                           "flags=%#" UVxf, (UV) *flagp);
15273                 }
15274
15275                 /* regclass() will return with parsing just the \ sequence,
15276                  * leaving the parse pointer at the next thing to parse */
15277                 RExC_parse--;
15278                 goto handle_operand;
15279
15280             case '[':   /* Is a bracketed character class */
15281             {
15282                 /* See if this is a [:posix:] class. */
15283                 bool is_posix_class = (OOB_NAMEDCLASS
15284                             < handle_possible_posix(pRExC_state,
15285                                                 RExC_parse + 1,
15286                                                 NULL,
15287                                                 NULL,
15288                                                 TRUE /* checking only */));
15289                 /* If it is a posix class, leave the parse pointer at the '['
15290                  * to fool regclass() into thinking it is part of a
15291                  * '[[:posix:]]'. */
15292                 if (! is_posix_class) {
15293                     RExC_parse++;
15294                 }
15295
15296                 /* regclass() can only return RESTART_PASS1 and NEED_UTF8 if
15297                  * multi-char folds are allowed.  */
15298                 if (!regclass(pRExC_state, flagp,depth+1,
15299                                 is_posix_class, /* parse the whole char
15300                                                     class only if not a
15301                                                     posix class */
15302                                 FALSE, /* don't allow multi-char folds */
15303                                 TRUE, /* silence non-portable warnings. */
15304                                 TRUE, /* strict */
15305                                 FALSE, /* Require return to be an ANYOF */
15306                                 &current,
15307                                 NULL
15308                                 ))
15309                 {
15310                     FAIL2("panic: regclass returned NULL to handle_sets, "
15311                           "flags=%#" UVxf, (UV) *flagp);
15312                 }
15313
15314                 /* function call leaves parse pointing to the ']', except if we
15315                  * faked it */
15316                 if (is_posix_class) {
15317                     RExC_parse--;
15318                 }
15319
15320                 goto handle_operand;
15321             }
15322
15323             case ']':
15324                 if (top_index >= 1) {
15325                     goto join_operators;
15326                 }
15327
15328                 /* Only a single operand on the stack: are done */
15329                 goto done;
15330
15331             case ')':
15332                 if (av_tindex_skip_len_mg(fence_stack) < 0) {
15333                     RExC_parse++;
15334                     vFAIL("Unexpected ')'");
15335                 }
15336
15337                 /* If nothing after the fence, is missing an operand */
15338                 if (top_index - fence < 0) {
15339                     RExC_parse++;
15340                     goto bad_syntax;
15341                 }
15342                 /* If at least two things on the stack, treat this as an
15343                   * operator */
15344                 if (top_index - fence >= 1) {
15345                     goto join_operators;
15346                 }
15347
15348                 /* Here only a single thing on the fenced stack, and there is a
15349                  * fence.  Get rid of it */
15350                 fence_ptr = av_pop(fence_stack);
15351                 assert(fence_ptr);
15352                 fence = SvIV(fence_ptr) - 1;
15353                 SvREFCNT_dec_NN(fence_ptr);
15354                 fence_ptr = NULL;
15355
15356                 if (fence < 0) {
15357                     fence = 0;
15358                 }
15359
15360                 /* Having gotten rid of the fence, we pop the operand at the
15361                  * stack top and process it as a newly encountered operand */
15362                 current = av_pop(stack);
15363                 if (IS_OPERAND(current)) {
15364                     goto handle_operand;
15365                 }
15366
15367                 RExC_parse++;
15368                 goto bad_syntax;
15369
15370             case '&':
15371             case '|':
15372             case '+':
15373             case '-':
15374             case '^':
15375
15376                 /* These binary operators should have a left operand already
15377                  * parsed */
15378                 if (   top_index - fence < 0
15379                     || top_index - fence == 1
15380                     || ( ! (top_ptr = av_fetch(stack, top_index, FALSE)))
15381                     || ! IS_OPERAND(*top_ptr))
15382                 {
15383                     goto unexpected_binary;
15384                 }
15385
15386                 /* If only the one operand is on the part of the stack visible
15387                  * to us, we just place this operator in the proper position */
15388                 if (top_index - fence < 2) {
15389
15390                     /* Place the operator before the operand */
15391
15392                     SV* lhs = av_pop(stack);
15393                     av_push(stack, newSVuv(curchar));
15394                     av_push(stack, lhs);
15395                     break;
15396                 }
15397
15398                 /* But if there is something else on the stack, we need to
15399                  * process it before this new operator if and only if the
15400                  * stacked operation has equal or higher precedence than the
15401                  * new one */
15402
15403              join_operators:
15404
15405                 /* The operator on the stack is supposed to be below both its
15406                  * operands */
15407                 if (   ! (stacked_ptr = av_fetch(stack, top_index - 2, FALSE))
15408                     || IS_OPERAND(*stacked_ptr))
15409                 {
15410                     /* But if not, it's legal and indicates we are completely
15411                      * done if and only if we're currently processing a ']',
15412                      * which should be the final thing in the expression */
15413                     if (curchar == ']') {
15414                         goto done;
15415                     }
15416
15417                   unexpected_binary:
15418                     RExC_parse++;
15419                     vFAIL2("Unexpected binary operator '%c' with no "
15420                            "preceding operand", curchar);
15421                 }
15422                 stacked_operator = (char) SvUV(*stacked_ptr);
15423
15424                 if (regex_set_precedence(curchar)
15425                     > regex_set_precedence(stacked_operator))
15426                 {
15427                     /* Here, the new operator has higher precedence than the
15428                      * stacked one.  This means we need to add the new one to
15429                      * the stack to await its rhs operand (and maybe more
15430                      * stuff).  We put it before the lhs operand, leaving
15431                      * untouched the stacked operator and everything below it
15432                      * */
15433                     lhs = av_pop(stack);
15434                     assert(IS_OPERAND(lhs));
15435
15436                     av_push(stack, newSVuv(curchar));
15437                     av_push(stack, lhs);
15438                     break;
15439                 }
15440
15441                 /* Here, the new operator has equal or lower precedence than
15442                  * what's already there.  This means the operation already
15443                  * there should be performed now, before the new one. */
15444
15445                 rhs = av_pop(stack);
15446                 if (! IS_OPERAND(rhs)) {
15447
15448                     /* This can happen when a ! is not followed by an operand,
15449                      * like in /(?[\t &!])/ */
15450                     goto bad_syntax;
15451                 }
15452
15453                 lhs = av_pop(stack);
15454
15455                 if (! IS_OPERAND(lhs)) {
15456
15457                     /* This can happen when there is an empty (), like in
15458                      * /(?[[0]+()+])/ */
15459                     goto bad_syntax;
15460                 }
15461
15462                 switch (stacked_operator) {
15463                     case '&':
15464                         _invlist_intersection(lhs, rhs, &rhs);
15465                         break;
15466
15467                     case '|':
15468                     case '+':
15469                         _invlist_union(lhs, rhs, &rhs);
15470                         break;
15471
15472                     case '-':
15473                         _invlist_subtract(lhs, rhs, &rhs);
15474                         break;
15475
15476                     case '^':   /* The union minus the intersection */
15477                     {
15478                         SV* i = NULL;
15479                         SV* u = NULL;
15480
15481                         _invlist_union(lhs, rhs, &u);
15482                         _invlist_intersection(lhs, rhs, &i);
15483                         _invlist_subtract(u, i, &rhs);
15484                         SvREFCNT_dec_NN(i);
15485                         SvREFCNT_dec_NN(u);
15486                         break;
15487                     }
15488                 }
15489                 SvREFCNT_dec(lhs);
15490
15491                 /* Here, the higher precedence operation has been done, and the
15492                  * result is in 'rhs'.  We overwrite the stacked operator with
15493                  * the result.  Then we redo this code to either push the new
15494                  * operator onto the stack or perform any higher precedence
15495                  * stacked operation */
15496                 only_to_avoid_leaks = av_pop(stack);
15497                 SvREFCNT_dec(only_to_avoid_leaks);
15498                 av_push(stack, rhs);
15499                 goto redo_curchar;
15500
15501             case '!':   /* Highest priority, right associative */
15502
15503                 /* If what's already at the top of the stack is another '!",
15504                  * they just cancel each other out */
15505                 if (   (top_ptr = av_fetch(stack, top_index, FALSE))
15506                     && (IS_OPERATOR(*top_ptr) && SvUV(*top_ptr) == '!'))
15507                 {
15508                     only_to_avoid_leaks = av_pop(stack);
15509                     SvREFCNT_dec(only_to_avoid_leaks);
15510                 }
15511                 else { /* Otherwise, since it's right associative, just push
15512                           onto the stack */
15513                     av_push(stack, newSVuv(curchar));
15514                 }
15515                 break;
15516
15517             default:
15518                 RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
15519                 vFAIL("Unexpected character");
15520
15521           handle_operand:
15522
15523             /* Here 'current' is the operand.  If something is already on the
15524              * stack, we have to check if it is a !.  But first, the code above
15525              * may have altered the stack in the time since we earlier set
15526              * 'top_index'.  */
15527
15528             top_index = av_tindex_skip_len_mg(stack);
15529             if (top_index - fence >= 0) {
15530                 /* If the top entry on the stack is an operator, it had better
15531                  * be a '!', otherwise the entry below the top operand should
15532                  * be an operator */
15533                 top_ptr = av_fetch(stack, top_index, FALSE);
15534                 assert(top_ptr);
15535                 if (IS_OPERATOR(*top_ptr)) {
15536
15537                     /* The only permissible operator at the top of the stack is
15538                      * '!', which is applied immediately to this operand. */
15539                     curchar = (char) SvUV(*top_ptr);
15540                     if (curchar != '!') {
15541                         SvREFCNT_dec(current);
15542                         vFAIL2("Unexpected binary operator '%c' with no "
15543                                 "preceding operand", curchar);
15544                     }
15545
15546                     _invlist_invert(current);
15547
15548                     only_to_avoid_leaks = av_pop(stack);
15549                     SvREFCNT_dec(only_to_avoid_leaks);
15550
15551                     /* And we redo with the inverted operand.  This allows
15552                      * handling multiple ! in a row */
15553                     goto handle_operand;
15554                 }
15555                           /* Single operand is ok only for the non-binary ')'
15556                            * operator */
15557                 else if ((top_index - fence == 0 && curchar != ')')
15558                          || (top_index - fence > 0
15559                              && (! (stacked_ptr = av_fetch(stack,
15560                                                            top_index - 1,
15561                                                            FALSE))
15562                                  || IS_OPERAND(*stacked_ptr))))
15563                 {
15564                     SvREFCNT_dec(current);
15565                     vFAIL("Operand with no preceding operator");
15566                 }
15567             }
15568
15569             /* Here there was nothing on the stack or the top element was
15570              * another operand.  Just add this new one */
15571             av_push(stack, current);
15572
15573         } /* End of switch on next parse token */
15574
15575         RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
15576     } /* End of loop parsing through the construct */
15577
15578   done:
15579     if (av_tindex_skip_len_mg(fence_stack) >= 0) {
15580         vFAIL("Unmatched (");
15581     }
15582
15583     if (av_tindex_skip_len_mg(stack) < 0   /* Was empty */
15584         || ((final = av_pop(stack)) == NULL)
15585         || ! IS_OPERAND(final)
15586         || SvTYPE(final) != SVt_INVLIST
15587         || av_tindex_skip_len_mg(stack) >= 0)  /* More left on stack */
15588     {
15589       bad_syntax:
15590         SvREFCNT_dec(final);
15591         vFAIL("Incomplete expression within '(?[ ])'");
15592     }
15593
15594     /* Here, 'final' is the resultant inversion list from evaluating the
15595      * expression.  Return it if so requested */
15596     if (return_invlist) {
15597         *return_invlist = final;
15598         return END;
15599     }
15600
15601     /* Otherwise generate a resultant node, based on 'final'.  regclass() is
15602      * expecting a string of ranges and individual code points */
15603     invlist_iterinit(final);
15604     result_string = newSVpvs("");
15605     while (invlist_iternext(final, &start, &end)) {
15606         if (start == end) {
15607             Perl_sv_catpvf(aTHX_ result_string, "\\x{%" UVXf "}", start);
15608         }
15609         else {
15610             Perl_sv_catpvf(aTHX_ result_string, "\\x{%" UVXf "}-\\x{%" UVXf "}",
15611                                                      start,          end);
15612         }
15613     }
15614
15615     /* About to generate an ANYOF (or similar) node from the inversion list we
15616      * have calculated */
15617     save_parse = RExC_parse;
15618     RExC_parse = SvPV(result_string, len);
15619     save_end = RExC_end;
15620     RExC_end = RExC_parse + len;
15621
15622     /* We turn off folding around the call, as the class we have constructed
15623      * already has all folding taken into consideration, and we don't want
15624      * regclass() to add to that */
15625     RExC_flags &= ~RXf_PMf_FOLD;
15626     /* regclass() can only return RESTART_PASS1 and NEED_UTF8 if multi-char
15627      * folds are allowed.  */
15628     node = regclass(pRExC_state, flagp,depth+1,
15629                     FALSE, /* means parse the whole char class */
15630                     FALSE, /* don't allow multi-char folds */
15631                     TRUE, /* silence non-portable warnings.  The above may very
15632                              well have generated non-portable code points, but
15633                              they're valid on this machine */
15634                     FALSE, /* similarly, no need for strict */
15635                     FALSE, /* Require return to be an ANYOF */
15636                     NULL,
15637                     NULL
15638                 );
15639     if (!node)
15640         FAIL2("panic: regclass returned NULL to handle_sets, flags=%#" UVxf,
15641                     PTR2UV(flagp));
15642
15643     /* Fix up the node type if we are in locale.  (We have pretended we are
15644      * under /u for the purposes of regclass(), as this construct will only
15645      * work under UTF-8 locales.  But now we change the opcode to be ANYOFL (so
15646      * as to cause any warnings about bad locales to be output in regexec.c),
15647      * and add the flag that indicates to check if not in a UTF-8 locale.  The
15648      * reason we above forbid optimization into something other than an ANYOF
15649      * node is simply to minimize the number of code changes in regexec.c.
15650      * Otherwise we would have to create new EXACTish node types and deal with
15651      * them.  This decision could be revisited should this construct become
15652      * popular.
15653      *
15654      * (One might think we could look at the resulting ANYOF node and suppress
15655      * the flag if everything is above 255, as those would be UTF-8 only,
15656      * but this isn't true, as the components that led to that result could
15657      * have been locale-affected, and just happen to cancel each other out
15658      * under UTF-8 locales.) */
15659     if (in_locale) {
15660         set_regex_charset(&RExC_flags, REGEX_LOCALE_CHARSET);
15661
15662         assert(OP(node) == ANYOF);
15663
15664         OP(node) = ANYOFL;
15665         ANYOF_FLAGS(node)
15666                 |= ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD;
15667     }
15668
15669     if (save_fold) {
15670         RExC_flags |= RXf_PMf_FOLD;
15671     }
15672
15673     RExC_parse = save_parse + 1;
15674     RExC_end = save_end;
15675     SvREFCNT_dec_NN(final);
15676     SvREFCNT_dec_NN(result_string);
15677
15678     nextchar(pRExC_state);
15679     Set_Node_Length(node, RExC_parse - oregcomp_parse + 1); /* MJD */
15680     return node;
15681 }
15682
15683 #ifdef ENABLE_REGEX_SETS_DEBUGGING
15684
15685 STATIC void
15686 S_dump_regex_sets_structures(pTHX_ RExC_state_t *pRExC_state,
15687                              AV * stack, const IV fence, AV * fence_stack)
15688 {   /* Dumps the stacks in handle_regex_sets() */
15689
15690     const SSize_t stack_top = av_tindex_skip_len_mg(stack);
15691     const SSize_t fence_stack_top = av_tindex_skip_len_mg(fence_stack);
15692     SSize_t i;
15693
15694     PERL_ARGS_ASSERT_DUMP_REGEX_SETS_STRUCTURES;
15695
15696     PerlIO_printf(Perl_debug_log, "\nParse position is:%s\n", RExC_parse);
15697
15698     if (stack_top < 0) {
15699         PerlIO_printf(Perl_debug_log, "Nothing on stack\n");
15700     }
15701     else {
15702         PerlIO_printf(Perl_debug_log, "Stack: (fence=%d)\n", (int) fence);
15703         for (i = stack_top; i >= 0; i--) {
15704             SV ** element_ptr = av_fetch(stack, i, FALSE);
15705             if (! element_ptr) {
15706             }
15707
15708             if (IS_OPERATOR(*element_ptr)) {
15709                 PerlIO_printf(Perl_debug_log, "[%d]: %c\n",
15710                                             (int) i, (int) SvIV(*element_ptr));
15711             }
15712             else {
15713                 PerlIO_printf(Perl_debug_log, "[%d] ", (int) i);
15714                 sv_dump(*element_ptr);
15715             }
15716         }
15717     }
15718
15719     if (fence_stack_top < 0) {
15720         PerlIO_printf(Perl_debug_log, "Nothing on fence_stack\n");
15721     }
15722     else {
15723         PerlIO_printf(Perl_debug_log, "Fence_stack: \n");
15724         for (i = fence_stack_top; i >= 0; i--) {
15725             SV ** element_ptr = av_fetch(fence_stack, i, FALSE);
15726             if (! element_ptr) {
15727             }
15728
15729             PerlIO_printf(Perl_debug_log, "[%d]: %d\n",
15730                                             (int) i, (int) SvIV(*element_ptr));
15731         }
15732     }
15733 }
15734
15735 #endif
15736
15737 #undef IS_OPERATOR
15738 #undef IS_OPERAND
15739
15740 STATIC void
15741 S_add_above_Latin1_folds(pTHX_ RExC_state_t *pRExC_state, const U8 cp, SV** invlist)
15742 {
15743     /* This hard-codes the Latin1/above-Latin1 folding rules, so that an
15744      * innocent-looking character class, like /[ks]/i won't have to go out to
15745      * disk to find the possible matches.
15746      *
15747      * This should be called only for a Latin1-range code points, cp, which is
15748      * known to be involved in a simple fold with other code points above
15749      * Latin1.  It would give false results if /aa has been specified.
15750      * Multi-char folds are outside the scope of this, and must be handled
15751      * specially.
15752      *
15753      * XXX It would be better to generate these via regen, in case a new
15754      * version of the Unicode standard adds new mappings, though that is not
15755      * really likely, and may be caught by the default: case of the switch
15756      * below. */
15757
15758     PERL_ARGS_ASSERT_ADD_ABOVE_LATIN1_FOLDS;
15759
15760     assert(HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(cp));
15761
15762     switch (cp) {
15763         case 'k':
15764         case 'K':
15765           *invlist =
15766              add_cp_to_invlist(*invlist, KELVIN_SIGN);
15767             break;
15768         case 's':
15769         case 'S':
15770           *invlist = add_cp_to_invlist(*invlist, LATIN_SMALL_LETTER_LONG_S);
15771             break;
15772         case MICRO_SIGN:
15773           *invlist = add_cp_to_invlist(*invlist, GREEK_CAPITAL_LETTER_MU);
15774           *invlist = add_cp_to_invlist(*invlist, GREEK_SMALL_LETTER_MU);
15775             break;
15776         case LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE:
15777         case LATIN_SMALL_LETTER_A_WITH_RING_ABOVE:
15778           *invlist = add_cp_to_invlist(*invlist, ANGSTROM_SIGN);
15779             break;
15780         case LATIN_SMALL_LETTER_Y_WITH_DIAERESIS:
15781           *invlist = add_cp_to_invlist(*invlist,
15782                                         LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS);
15783             break;
15784
15785 #ifdef LATIN_CAPITAL_LETTER_SHARP_S /* not defined in early Unicode releases */
15786
15787         case LATIN_SMALL_LETTER_SHARP_S:
15788           *invlist = add_cp_to_invlist(*invlist, LATIN_CAPITAL_LETTER_SHARP_S);
15789             break;
15790
15791 #endif
15792
15793 #if    UNICODE_MAJOR_VERSION < 3                                        \
15794    || (UNICODE_MAJOR_VERSION == 3 && UNICODE_DOT_VERSION == 0)
15795
15796         /* In 3.0 and earlier, U+0130 folded simply to 'i'; and in 3.0.1 so did
15797          * U+0131.  */
15798         case 'i':
15799         case 'I':
15800           *invlist =
15801              add_cp_to_invlist(*invlist, LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE);
15802 #   if UNICODE_DOT_DOT_VERSION == 1
15803           *invlist = add_cp_to_invlist(*invlist, LATIN_SMALL_LETTER_DOTLESS_I);
15804 #   endif
15805             break;
15806 #endif
15807
15808         default:
15809             /* Use deprecated warning to increase the chances of this being
15810              * output */
15811             if (PASS2) {
15812                 ckWARN2reg_d(RExC_parse, "Perl folding rules are not up-to-date for 0x%02X; please use the perlbug utility to report;", cp);
15813             }
15814             break;
15815     }
15816 }
15817
15818 STATIC void
15819 S_output_or_return_posix_warnings(pTHX_ RExC_state_t *pRExC_state, AV* posix_warnings, AV** return_posix_warnings)
15820 {
15821     /* If the final parameter is NULL, output the elements of the array given
15822      * by '*posix_warnings' as REGEXP warnings.  Otherwise, the elements are
15823      * pushed onto it, (creating if necessary) */
15824
15825     SV * msg;
15826     const bool first_is_fatal =  ! return_posix_warnings
15827                                 && ckDEAD(packWARN(WARN_REGEXP));
15828
15829     PERL_ARGS_ASSERT_OUTPUT_OR_RETURN_POSIX_WARNINGS;
15830
15831     while ((msg = av_shift(posix_warnings)) != &PL_sv_undef) {
15832         if (return_posix_warnings) {
15833             if (! *return_posix_warnings) { /* mortalize to not leak if
15834                                                warnings are fatal */
15835                 *return_posix_warnings = (AV *) sv_2mortal((SV *) newAV());
15836             }
15837             av_push(*return_posix_warnings, msg);
15838         }
15839         else {
15840             if (first_is_fatal) {           /* Avoid leaking this */
15841                 av_undef(posix_warnings);   /* This isn't necessary if the
15842                                                array is mortal, but is a
15843                                                fail-safe */
15844                 (void) sv_2mortal(msg);
15845                 if (PASS2) {
15846                     SAVEFREESV(RExC_rx_sv);
15847                 }
15848             }
15849             Perl_warner(aTHX_ packWARN(WARN_REGEXP), "%s", SvPVX(msg));
15850             SvREFCNT_dec_NN(msg);
15851         }
15852     }
15853 }
15854
15855 STATIC AV *
15856 S_add_multi_match(pTHX_ AV* multi_char_matches, SV* multi_string, const STRLEN cp_count)
15857 {
15858     /* This adds the string scalar <multi_string> to the array
15859      * <multi_char_matches>.  <multi_string> is known to have exactly
15860      * <cp_count> code points in it.  This is used when constructing a
15861      * bracketed character class and we find something that needs to match more
15862      * than a single character.
15863      *
15864      * <multi_char_matches> is actually an array of arrays.  Each top-level
15865      * element is an array that contains all the strings known so far that are
15866      * the same length.  And that length (in number of code points) is the same
15867      * as the index of the top-level array.  Hence, the [2] element is an
15868      * array, each element thereof is a string containing TWO code points;
15869      * while element [3] is for strings of THREE characters, and so on.  Since
15870      * this is for multi-char strings there can never be a [0] nor [1] element.
15871      *
15872      * When we rewrite the character class below, we will do so such that the
15873      * longest strings are written first, so that it prefers the longest
15874      * matching strings first.  This is done even if it turns out that any
15875      * quantifier is non-greedy, out of this programmer's (khw) laziness.  Tom
15876      * Christiansen has agreed that this is ok.  This makes the test for the
15877      * ligature 'ffi' come before the test for 'ff', for example */
15878
15879     AV* this_array;
15880     AV** this_array_ptr;
15881
15882     PERL_ARGS_ASSERT_ADD_MULTI_MATCH;
15883
15884     if (! multi_char_matches) {
15885         multi_char_matches = newAV();
15886     }
15887
15888     if (av_exists(multi_char_matches, cp_count)) {
15889         this_array_ptr = (AV**) av_fetch(multi_char_matches, cp_count, FALSE);
15890         this_array = *this_array_ptr;
15891     }
15892     else {
15893         this_array = newAV();
15894         av_store(multi_char_matches, cp_count,
15895                  (SV*) this_array);
15896     }
15897     av_push(this_array, multi_string);
15898
15899     return multi_char_matches;
15900 }
15901
15902 /* The names of properties whose definitions are not known at compile time are
15903  * stored in this SV, after a constant heading.  So if the length has been
15904  * changed since initialization, then there is a run-time definition. */
15905 #define HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION                            \
15906                                         (SvCUR(listsv) != initial_listsv_len)
15907
15908 /* There is a restricted set of white space characters that are legal when
15909  * ignoring white space in a bracketed character class.  This generates the
15910  * code to skip them.
15911  *
15912  * There is a line below that uses the same white space criteria but is outside
15913  * this macro.  Both here and there must use the same definition */
15914 #define SKIP_BRACKETED_WHITE_SPACE(do_skip, p)                          \
15915     STMT_START {                                                        \
15916         if (do_skip) {                                                  \
15917             while (isBLANK_A(UCHARAT(p)))                               \
15918             {                                                           \
15919                 p++;                                                    \
15920             }                                                           \
15921         }                                                               \
15922     } STMT_END
15923
15924 STATIC regnode *
15925 S_regclass(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth,
15926                  const bool stop_at_1,  /* Just parse the next thing, don't
15927                                            look for a full character class */
15928                  bool allow_multi_folds,
15929                  const bool silence_non_portable,   /* Don't output warnings
15930                                                        about too large
15931                                                        characters */
15932                  const bool strict,
15933                  bool optimizable,                  /* ? Allow a non-ANYOF return
15934                                                        node */
15935                  SV** ret_invlist, /* Return an inversion list, not a node */
15936                  AV** return_posix_warnings
15937           )
15938 {
15939     /* parse a bracketed class specification.  Most of these will produce an
15940      * ANYOF node; but something like [a] will produce an EXACT node; [aA], an
15941      * EXACTFish node; [[:ascii:]], a POSIXA node; etc.  It is more complex
15942      * under /i with multi-character folds: it will be rewritten following the
15943      * paradigm of this example, where the <multi-fold>s are characters which
15944      * fold to multiple character sequences:
15945      *      /[abc\x{multi-fold1}def\x{multi-fold2}ghi]/i
15946      * gets effectively rewritten as:
15947      *      /(?:\x{multi-fold1}|\x{multi-fold2}|[abcdefghi]/i
15948      * reg() gets called (recursively) on the rewritten version, and this
15949      * function will return what it constructs.  (Actually the <multi-fold>s
15950      * aren't physically removed from the [abcdefghi], it's just that they are
15951      * ignored in the recursion by means of a flag:
15952      * <RExC_in_multi_char_class>.)
15953      *
15954      * ANYOF nodes contain a bit map for the first NUM_ANYOF_CODE_POINTS
15955      * characters, with the corresponding bit set if that character is in the
15956      * list.  For characters above this, a range list or swash is used.  There
15957      * are extra bits for \w, etc. in locale ANYOFs, as what these match is not
15958      * determinable at compile time
15959      *
15960      * Returns NULL, setting *flagp to RESTART_PASS1 if the sizing scan needs
15961      * to be restarted, or'd with NEED_UTF8 if the pattern needs to be upgraded
15962      * to UTF-8.  This can only happen if ret_invlist is non-NULL.
15963      */
15964
15965     UV prevvalue = OOB_UNICODE, save_prevvalue = OOB_UNICODE;
15966     IV range = 0;
15967     UV value = OOB_UNICODE, save_value = OOB_UNICODE;
15968     regnode *ret;
15969     STRLEN numlen;
15970     int namedclass = OOB_NAMEDCLASS;
15971     char *rangebegin = NULL;
15972     bool need_class = 0;
15973     SV *listsv = NULL;
15974     STRLEN initial_listsv_len = 0; /* Kind of a kludge to see if it is more
15975                                       than just initialized.  */
15976     SV* properties = NULL;    /* Code points that match \p{} \P{} */
15977     SV* posixes = NULL;     /* Code points that match classes like [:word:],
15978                                extended beyond the Latin1 range.  These have to
15979                                be kept separate from other code points for much
15980                                of this function because their handling  is
15981                                different under /i, and for most classes under
15982                                /d as well */
15983     SV* nposixes = NULL;    /* Similarly for [:^word:].  These are kept
15984                                separate for a while from the non-complemented
15985                                versions because of complications with /d
15986                                matching */
15987     SV* simple_posixes = NULL; /* But under some conditions, the classes can be
15988                                   treated more simply than the general case,
15989                                   leading to less compilation and execution
15990                                   work */
15991     UV element_count = 0;   /* Number of distinct elements in the class.
15992                                Optimizations may be possible if this is tiny */
15993     AV * multi_char_matches = NULL; /* Code points that fold to more than one
15994                                        character; used under /i */
15995     UV n;
15996     char * stop_ptr = RExC_end;    /* where to stop parsing */
15997
15998     /* ignore unescaped whitespace? */
15999     const bool skip_white = cBOOL(   ret_invlist
16000                                   || (RExC_flags & RXf_PMf_EXTENDED_MORE));
16001
16002     /* Unicode properties are stored in a swash; this holds the current one
16003      * being parsed.  If this swash is the only above-latin1 component of the
16004      * character class, an optimization is to pass it directly on to the
16005      * execution engine.  Otherwise, it is set to NULL to indicate that there
16006      * are other things in the class that have to be dealt with at execution
16007      * time */
16008     SV* swash = NULL;           /* Code points that match \p{} \P{} */
16009
16010     /* Set if a component of this character class is user-defined; just passed
16011      * on to the engine */
16012     bool has_user_defined_property = FALSE;
16013
16014     /* inversion list of code points this node matches only when the target
16015      * string is in UTF-8.  These are all non-ASCII, < 256.  (Because is under
16016      * /d) */
16017     SV* has_upper_latin1_only_utf8_matches = NULL;
16018
16019     /* Inversion list of code points this node matches regardless of things
16020      * like locale, folding, utf8ness of the target string */
16021     SV* cp_list = NULL;
16022
16023     /* Like cp_list, but code points on this list need to be checked for things
16024      * that fold to/from them under /i */
16025     SV* cp_foldable_list = NULL;
16026
16027     /* Like cp_list, but code points on this list are valid only when the
16028      * runtime locale is UTF-8 */
16029     SV* only_utf8_locale_list = NULL;
16030
16031     /* In a range, if one of the endpoints is non-character-set portable,
16032      * meaning that it hard-codes a code point that may mean a different
16033      * charactger in ASCII vs. EBCDIC, as opposed to, say, a literal 'A' or a
16034      * mnemonic '\t' which each mean the same character no matter which
16035      * character set the platform is on. */
16036     unsigned int non_portable_endpoint = 0;
16037
16038     /* Is the range unicode? which means on a platform that isn't 1-1 native
16039      * to Unicode (i.e. non-ASCII), each code point in it should be considered
16040      * to be a Unicode value.  */
16041     bool unicode_range = FALSE;
16042     bool invert = FALSE;    /* Is this class to be complemented */
16043
16044     bool warn_super = ALWAYS_WARN_SUPER;
16045
16046     regnode * const orig_emit = RExC_emit; /* Save the original RExC_emit in
16047         case we need to change the emitted regop to an EXACT. */
16048     const char * orig_parse = RExC_parse;
16049     const SSize_t orig_size = RExC_size;
16050     bool posixl_matches_all = FALSE; /* Does /l class have both e.g. \W,\w ? */
16051
16052     /* This variable is used to mark where the end in the input is of something
16053      * that looks like a POSIX construct but isn't.  During the parse, when
16054      * something looks like it could be such a construct is encountered, it is
16055      * checked for being one, but not if we've already checked this area of the
16056      * input.  Only after this position is reached do we check again */
16057     char *not_posix_region_end = RExC_parse - 1;
16058
16059     AV* posix_warnings = NULL;
16060     const bool do_posix_warnings =     return_posix_warnings
16061                                    || (PASS2 && ckWARN(WARN_REGEXP));
16062
16063     GET_RE_DEBUG_FLAGS_DECL;
16064
16065     PERL_ARGS_ASSERT_REGCLASS;
16066 #ifndef DEBUGGING
16067     PERL_UNUSED_ARG(depth);
16068 #endif
16069
16070     DEBUG_PARSE("clas");
16071
16072 #if UNICODE_MAJOR_VERSION < 3 /* no multifolds in early Unicode */      \
16073     || (UNICODE_MAJOR_VERSION == 3 && UNICODE_DOT_VERSION == 0          \
16074                                    && UNICODE_DOT_DOT_VERSION == 0)
16075     allow_multi_folds = FALSE;
16076 #endif
16077
16078     /* Assume we are going to generate an ANYOF node. */
16079     ret = reganode(pRExC_state,
16080                    (LOC)
16081                     ? ANYOFL
16082                     : ANYOF,
16083                    0);
16084
16085     if (SIZE_ONLY) {
16086         RExC_size += ANYOF_SKIP;
16087         listsv = &PL_sv_undef; /* For code scanners: listsv always non-NULL. */
16088     }
16089     else {
16090         ANYOF_FLAGS(ret) = 0;
16091
16092         RExC_emit += ANYOF_SKIP;
16093         listsv = newSVpvs_flags("# comment\n", SVs_TEMP);
16094         initial_listsv_len = SvCUR(listsv);
16095         SvTEMP_off(listsv); /* Grr, TEMPs and mortals are conflated.  */
16096     }
16097
16098     SKIP_BRACKETED_WHITE_SPACE(skip_white, RExC_parse);
16099
16100     assert(RExC_parse <= RExC_end);
16101
16102     if (UCHARAT(RExC_parse) == '^') {   /* Complement the class */
16103         RExC_parse++;
16104         invert = TRUE;
16105         allow_multi_folds = FALSE;
16106         MARK_NAUGHTY(1);
16107         SKIP_BRACKETED_WHITE_SPACE(skip_white, RExC_parse);
16108     }
16109
16110     /* Check that they didn't say [:posix:] instead of [[:posix:]] */
16111     if (! ret_invlist && MAYBE_POSIXCC(UCHARAT(RExC_parse))) {
16112         int maybe_class = handle_possible_posix(pRExC_state,
16113                                                 RExC_parse,
16114                                                 &not_posix_region_end,
16115                                                 NULL,
16116                                                 TRUE /* checking only */);
16117         if (PASS2 && maybe_class >= OOB_NAMEDCLASS && do_posix_warnings) {
16118             SAVEFREESV(RExC_rx_sv);
16119             ckWARN4reg(not_posix_region_end,
16120                     "POSIX syntax [%c %c] belongs inside character classes%s",
16121                     *RExC_parse, *RExC_parse,
16122                     (maybe_class == OOB_NAMEDCLASS)
16123                     ? ((POSIXCC_NOTYET(*RExC_parse))
16124                         ? " (but this one isn't implemented)"
16125                         : " (but this one isn't fully valid)")
16126                     : ""
16127                     );
16128             (void)ReREFCNT_inc(RExC_rx_sv);
16129         }
16130     }
16131
16132     /* If the caller wants us to just parse a single element, accomplish this
16133      * by faking the loop ending condition */
16134     if (stop_at_1 && RExC_end > RExC_parse) {
16135         stop_ptr = RExC_parse + 1;
16136     }
16137
16138     /* allow 1st char to be ']' (allowing it to be '-' is dealt with later) */
16139     if (UCHARAT(RExC_parse) == ']')
16140         goto charclassloop;
16141
16142     while (1) {
16143
16144         if (   posix_warnings
16145             && av_tindex_skip_len_mg(posix_warnings) >= 0
16146             && RExC_parse > not_posix_region_end)
16147         {
16148             /* Warnings about posix class issues are considered tentative until
16149              * we are far enough along in the parse that we can no longer
16150              * change our mind, at which point we either output them or add
16151              * them, if it has so specified, to what gets returned to the
16152              * caller.  This is done each time through the loop so that a later
16153              * class won't zap them before they have been dealt with. */
16154             output_or_return_posix_warnings(pRExC_state, posix_warnings,
16155                                             return_posix_warnings);
16156         }
16157
16158         if  (RExC_parse >= stop_ptr) {
16159             break;
16160         }
16161
16162         SKIP_BRACKETED_WHITE_SPACE(skip_white, RExC_parse);
16163
16164         if  (UCHARAT(RExC_parse) == ']') {
16165             break;
16166         }
16167
16168       charclassloop:
16169
16170         namedclass = OOB_NAMEDCLASS; /* initialize as illegal */
16171         save_value = value;
16172         save_prevvalue = prevvalue;
16173
16174         if (!range) {
16175             rangebegin = RExC_parse;
16176             element_count++;
16177             non_portable_endpoint = 0;
16178         }
16179         if (UTF && ! UTF8_IS_INVARIANT(* RExC_parse)) {
16180             value = utf8n_to_uvchr((U8*)RExC_parse,
16181                                    RExC_end - RExC_parse,
16182                                    &numlen, UTF8_ALLOW_DEFAULT);
16183             RExC_parse += numlen;
16184         }
16185         else
16186             value = UCHARAT(RExC_parse++);
16187
16188         if (value == '[') {
16189             char * posix_class_end;
16190             namedclass = handle_possible_posix(pRExC_state,
16191                                                RExC_parse,
16192                                                &posix_class_end,
16193                                                do_posix_warnings ? &posix_warnings : NULL,
16194                                                FALSE    /* die if error */);
16195             if (namedclass > OOB_NAMEDCLASS) {
16196
16197                 /* If there was an earlier attempt to parse this particular
16198                  * posix class, and it failed, it was a false alarm, as this
16199                  * successful one proves */
16200                 if (   posix_warnings
16201                     && av_tindex_skip_len_mg(posix_warnings) >= 0
16202                     && not_posix_region_end >= RExC_parse
16203                     && not_posix_region_end <= posix_class_end)
16204                 {
16205                     av_undef(posix_warnings);
16206                 }
16207
16208                 RExC_parse = posix_class_end;
16209             }
16210             else if (namedclass == OOB_NAMEDCLASS) {
16211                 not_posix_region_end = posix_class_end;
16212             }
16213             else {
16214                 namedclass = OOB_NAMEDCLASS;
16215             }
16216         }
16217         else if (   RExC_parse - 1 > not_posix_region_end
16218                  && MAYBE_POSIXCC(value))
16219         {
16220             (void) handle_possible_posix(
16221                         pRExC_state,
16222                         RExC_parse - 1,  /* -1 because parse has already been
16223                                             advanced */
16224                         &not_posix_region_end,
16225                         do_posix_warnings ? &posix_warnings : NULL,
16226                         TRUE /* checking only */);
16227         }
16228         else if (value == '\\') {
16229             /* Is a backslash; get the code point of the char after it */
16230
16231             if (RExC_parse >= RExC_end) {
16232                 vFAIL("Unmatched [");
16233             }
16234
16235             if (UTF && ! UTF8_IS_INVARIANT(UCHARAT(RExC_parse))) {
16236                 value = utf8n_to_uvchr((U8*)RExC_parse,
16237                                    RExC_end - RExC_parse,
16238                                    &numlen, UTF8_ALLOW_DEFAULT);
16239                 RExC_parse += numlen;
16240             }
16241             else
16242                 value = UCHARAT(RExC_parse++);
16243
16244             /* Some compilers cannot handle switching on 64-bit integer
16245              * values, therefore value cannot be an UV.  Yes, this will
16246              * be a problem later if we want switch on Unicode.
16247              * A similar issue a little bit later when switching on
16248              * namedclass. --jhi */
16249
16250             /* If the \ is escaping white space when white space is being
16251              * skipped, it means that that white space is wanted literally, and
16252              * is already in 'value'.  Otherwise, need to translate the escape
16253              * into what it signifies. */
16254             if (! skip_white || ! isBLANK_A(value)) switch ((I32)value) {
16255
16256             case 'w':   namedclass = ANYOF_WORDCHAR;    break;
16257             case 'W':   namedclass = ANYOF_NWORDCHAR;   break;
16258             case 's':   namedclass = ANYOF_SPACE;       break;
16259             case 'S':   namedclass = ANYOF_NSPACE;      break;
16260             case 'd':   namedclass = ANYOF_DIGIT;       break;
16261             case 'D':   namedclass = ANYOF_NDIGIT;      break;
16262             case 'v':   namedclass = ANYOF_VERTWS;      break;
16263             case 'V':   namedclass = ANYOF_NVERTWS;     break;
16264             case 'h':   namedclass = ANYOF_HORIZWS;     break;
16265             case 'H':   namedclass = ANYOF_NHORIZWS;    break;
16266             case 'N':  /* Handle \N{NAME} in class */
16267                 {
16268                     const char * const backslash_N_beg = RExC_parse - 2;
16269                     int cp_count;
16270
16271                     if (! grok_bslash_N(pRExC_state,
16272                                         NULL,      /* No regnode */
16273                                         &value,    /* Yes single value */
16274                                         &cp_count, /* Multiple code pt count */
16275                                         flagp,
16276                                         strict,
16277                                         depth)
16278                     ) {
16279
16280                         if (*flagp & NEED_UTF8)
16281                             FAIL("panic: grok_bslash_N set NEED_UTF8");
16282                         if (*flagp & RESTART_PASS1)
16283                             return NULL;
16284
16285                         if (cp_count < 0) {
16286                             vFAIL("\\N in a character class must be a named character: \\N{...}");
16287                         }
16288                         else if (cp_count == 0) {
16289                             if (PASS2) {
16290                                 ckWARNreg(RExC_parse,
16291                                         "Ignoring zero length \\N{} in character class");
16292                             }
16293                         }
16294                         else { /* cp_count > 1 */
16295                             if (! RExC_in_multi_char_class) {
16296                                 if (invert || range || *RExC_parse == '-') {
16297                                     if (strict) {
16298                                         RExC_parse--;
16299                                         vFAIL("\\N{} in inverted character class or as a range end-point is restricted to one character");
16300                                     }
16301                                     else if (PASS2) {
16302                                         ckWARNreg(RExC_parse, "Using just the first character returned by \\N{} in character class");
16303                                     }
16304                                     break; /* <value> contains the first code
16305                                               point. Drop out of the switch to
16306                                               process it */
16307                                 }
16308                                 else {
16309                                     SV * multi_char_N = newSVpvn(backslash_N_beg,
16310                                                  RExC_parse - backslash_N_beg);
16311                                     multi_char_matches
16312                                         = add_multi_match(multi_char_matches,
16313                                                           multi_char_N,
16314                                                           cp_count);
16315                                 }
16316                             }
16317                         } /* End of cp_count != 1 */
16318
16319                         /* This element should not be processed further in this
16320                          * class */
16321                         element_count--;
16322                         value = save_value;
16323                         prevvalue = save_prevvalue;
16324                         continue;   /* Back to top of loop to get next char */
16325                     }
16326
16327                     /* Here, is a single code point, and <value> contains it */
16328                     unicode_range = TRUE;   /* \N{} are Unicode */
16329                 }
16330                 break;
16331             case 'p':
16332             case 'P':
16333                 {
16334                 char *e;
16335
16336                 /* We will handle any undefined properties ourselves */
16337                 U8 swash_init_flags = _CORE_SWASH_INIT_RETURN_IF_UNDEF
16338                                        /* And we actually would prefer to get
16339                                         * the straight inversion list of the
16340                                         * swash, since we will be accessing it
16341                                         * anyway, to save a little time */
16342                                       |_CORE_SWASH_INIT_ACCEPT_INVLIST;
16343
16344                 if (RExC_parse >= RExC_end)
16345                     vFAIL2("Empty \\%c", (U8)value);
16346                 if (*RExC_parse == '{') {
16347                     const U8 c = (U8)value;
16348                     e = (char *) memchr(RExC_parse, '}', RExC_end - RExC_parse);
16349                     if (!e) {
16350                         RExC_parse++;
16351                         vFAIL2("Missing right brace on \\%c{}", c);
16352                     }
16353
16354                     RExC_parse++;
16355                     while (isSPACE(*RExC_parse)) {
16356                          RExC_parse++;
16357                     }
16358
16359                     if (UCHARAT(RExC_parse) == '^') {
16360
16361                         /* toggle.  (The rhs xor gets the single bit that
16362                          * differs between P and p; the other xor inverts just
16363                          * that bit) */
16364                         value ^= 'P' ^ 'p';
16365
16366                         RExC_parse++;
16367                         while (isSPACE(*RExC_parse)) {
16368                             RExC_parse++;
16369                         }
16370                     }
16371
16372                     if (e == RExC_parse)
16373                         vFAIL2("Empty \\%c{}", c);
16374
16375                     n = e - RExC_parse;
16376                     while (isSPACE(*(RExC_parse + n - 1)))
16377                         n--;
16378                 }   /* The \p isn't immediately followed by a '{' */
16379                 else if (! isALPHA(*RExC_parse)) {
16380                     RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
16381                     vFAIL2("Character following \\%c must be '{' or a "
16382                            "single-character Unicode property name",
16383                            (U8) value);
16384                 }
16385                 else {
16386                     e = RExC_parse;
16387                     n = 1;
16388                 }
16389                 if (!SIZE_ONLY) {
16390                     SV* invlist;
16391                     char* name;
16392                     char* base_name;    /* name after any packages are stripped */
16393                     char* lookup_name = NULL;
16394                     const char * const colon_colon = "::";
16395
16396                     /* Try to get the definition of the property into
16397                      * <invlist>.  If /i is in effect, the effective property
16398                      * will have its name be <__NAME_i>.  The design is
16399                      * discussed in commit
16400                      * 2f833f5208e26b208886e51e09e2c072b5eabb46 */
16401                     name = savepv(Perl_form(aTHX_ "%.*s", (int)n, RExC_parse));
16402                     SAVEFREEPV(name);
16403                     if (FOLD) {
16404                         lookup_name = savepv(Perl_form(aTHX_ "__%s_i", name));
16405
16406                         /* The function call just below that uses this can fail
16407                          * to return, leaking memory if we don't do this */
16408                         SAVEFREEPV(lookup_name);
16409                     }
16410
16411                     /* Look up the property name, and get its swash and
16412                      * inversion list, if the property is found  */
16413                     SvREFCNT_dec(swash); /* Free any left-overs */
16414                     swash = _core_swash_init("utf8",
16415                                              (lookup_name)
16416                                               ? lookup_name
16417                                               : name,
16418                                              &PL_sv_undef,
16419                                              1, /* binary */
16420                                              0, /* not tr/// */
16421                                              NULL, /* No inversion list */
16422                                              &swash_init_flags
16423                                             );
16424                     if (! swash || ! (invlist = _get_swash_invlist(swash))) {
16425                         HV* curpkg = (IN_PERL_COMPILETIME)
16426                                       ? PL_curstash
16427                                       : CopSTASH(PL_curcop);
16428                         UV final_n = n;
16429                         bool has_pkg;
16430
16431                         if (swash) {    /* Got a swash but no inversion list.
16432                                            Something is likely wrong that will
16433                                            be sorted-out later */
16434                             SvREFCNT_dec_NN(swash);
16435                             swash = NULL;
16436                         }
16437
16438                         /* Here didn't find it.  It could be a an error (like a
16439                          * typo) in specifying a Unicode property, or it could
16440                          * be a user-defined property that will be available at
16441                          * run-time.  The names of these must begin with 'In'
16442                          * or 'Is' (after any packages are stripped off).  So
16443                          * if not one of those, or if we accept only
16444                          * compile-time properties, is an error; otherwise add
16445                          * it to the list for run-time look up. */
16446                         if ((base_name = rninstr(name, name + n,
16447                                                  colon_colon, colon_colon + 2)))
16448                         { /* Has ::.  We know this must be a user-defined
16449                              property */
16450                             base_name += 2;
16451                             final_n -= base_name - name;
16452                             has_pkg = TRUE;
16453                         }
16454                         else {
16455                             base_name = name;
16456                             has_pkg = FALSE;
16457                         }
16458
16459                         if (   final_n < 3
16460                             || base_name[0] != 'I'
16461                             || (base_name[1] != 's' && base_name[1] != 'n')
16462                             || ret_invlist)
16463                         {
16464                             const char * const msg
16465                                 = (has_pkg)
16466                                   ? "Illegal user-defined property name"
16467                                   : "Can't find Unicode property definition";
16468                             RExC_parse = e + 1;
16469
16470                             /* diag_listed_as: Can't find Unicode property definition "%s" */
16471                             vFAIL3utf8f("%s \"%" UTF8f "\"",
16472                                 msg, UTF8fARG(UTF, n, name));
16473                         }
16474
16475                         /* If the property name doesn't already have a package
16476                          * name, add the current one to it so that it can be
16477                          * referred to outside it. [perl #121777] */
16478                         if (! has_pkg && curpkg) {
16479                             char* pkgname = HvNAME(curpkg);
16480                             if (memNEs(pkgname, HvNAMELEN(curpkg), "main")) {
16481                                 char* full_name = Perl_form(aTHX_
16482                                                             "%s::%s",
16483                                                             pkgname,
16484                                                             name);
16485                                 n = strlen(full_name);
16486                                 name = savepvn(full_name, n);
16487                                 SAVEFREEPV(name);
16488                             }
16489                         }
16490                         Perl_sv_catpvf(aTHX_ listsv, "%cutf8::%s%" UTF8f "%s\n",
16491                                         (value == 'p' ? '+' : '!'),
16492                                         (FOLD) ? "__" : "",
16493                                         UTF8fARG(UTF, n, name),
16494                                         (FOLD) ? "_i" : "");
16495                         has_user_defined_property = TRUE;
16496                         optimizable = FALSE;    /* Will have to leave this an
16497                                                    ANYOF node */
16498
16499                         /* We don't know yet what this matches, so have to flag
16500                          * it */
16501                         ANYOF_FLAGS(ret) |= ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP;
16502                     }
16503                     else {
16504
16505                         /* Here, did get the swash and its inversion list.  If
16506                          * the swash is from a user-defined property, then this
16507                          * whole character class should be regarded as such */
16508                         if (swash_init_flags
16509                             & _CORE_SWASH_INIT_USER_DEFINED_PROPERTY)
16510                         {
16511                             has_user_defined_property = TRUE;
16512                         }
16513                         else if
16514                             /* We warn on matching an above-Unicode code point
16515                              * if the match would return true, except don't
16516                              * warn for \p{All}, which has exactly one element
16517                              * = 0 */
16518                             (_invlist_contains_cp(invlist, 0x110000)
16519                                 && (! (_invlist_len(invlist) == 1
16520                                        && *invlist_array(invlist) == 0)))
16521                         {
16522                             warn_super = TRUE;
16523                         }
16524
16525
16526                         /* Invert if asking for the complement */
16527                         if (value == 'P') {
16528                             _invlist_union_complement_2nd(properties,
16529                                                           invlist,
16530                                                           &properties);
16531
16532                             /* The swash can't be used as-is, because we've
16533                              * inverted things; delay removing it to here after
16534                              * have copied its invlist above */
16535                             SvREFCNT_dec_NN(swash);
16536                             swash = NULL;
16537                         }
16538                         else {
16539                             _invlist_union(properties, invlist, &properties);
16540                         }
16541                     }
16542                 }
16543                 RExC_parse = e + 1;
16544                 namedclass = ANYOF_UNIPROP;  /* no official name, but it's
16545                                                 named */
16546
16547                 /* \p means they want Unicode semantics */
16548                 REQUIRE_UNI_RULES(flagp, NULL);
16549                 }
16550                 break;
16551             case 'n':   value = '\n';                   break;
16552             case 'r':   value = '\r';                   break;
16553             case 't':   value = '\t';                   break;
16554             case 'f':   value = '\f';                   break;
16555             case 'b':   value = '\b';                   break;
16556             case 'e':   value = ESC_NATIVE;             break;
16557             case 'a':   value = '\a';                   break;
16558             case 'o':
16559                 RExC_parse--;   /* function expects to be pointed at the 'o' */
16560                 {
16561                     const char* error_msg;
16562                     bool valid = grok_bslash_o(&RExC_parse,
16563                                                RExC_end,
16564                                                &value,
16565                                                &error_msg,
16566                                                PASS2,   /* warnings only in
16567                                                            pass 2 */
16568                                                strict,
16569                                                silence_non_portable,
16570                                                UTF);
16571                     if (! valid) {
16572                         vFAIL(error_msg);
16573                     }
16574                 }
16575                 non_portable_endpoint++;
16576                 break;
16577             case 'x':
16578                 RExC_parse--;   /* function expects to be pointed at the 'x' */
16579                 {
16580                     const char* error_msg;
16581                     bool valid = grok_bslash_x(&RExC_parse,
16582                                                RExC_end,
16583                                                &value,
16584                                                &error_msg,
16585                                                PASS2, /* Output warnings */
16586                                                strict,
16587                                                silence_non_portable,
16588                                                UTF);
16589                     if (! valid) {
16590                         vFAIL(error_msg);
16591                     }
16592                 }
16593                 non_portable_endpoint++;
16594                 break;
16595             case 'c':
16596                 value = grok_bslash_c(*RExC_parse++, PASS2);
16597                 non_portable_endpoint++;
16598                 break;
16599             case '0': case '1': case '2': case '3': case '4':
16600             case '5': case '6': case '7':
16601                 {
16602                     /* Take 1-3 octal digits */
16603                     I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
16604                     numlen = (strict) ? 4 : 3;
16605                     value = grok_oct(--RExC_parse, &numlen, &flags, NULL);
16606                     RExC_parse += numlen;
16607                     if (numlen != 3) {
16608                         if (strict) {
16609                             RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
16610                             vFAIL("Need exactly 3 octal digits");
16611                         }
16612                         else if (! SIZE_ONLY /* like \08, \178 */
16613                                  && numlen < 3
16614                                  && RExC_parse < RExC_end
16615                                  && isDIGIT(*RExC_parse)
16616                                  && ckWARN(WARN_REGEXP))
16617                         {
16618                             SAVEFREESV(RExC_rx_sv);
16619                             reg_warn_non_literal_string(
16620                                  RExC_parse + 1,
16621                                  form_short_octal_warning(RExC_parse, numlen));
16622                             (void)ReREFCNT_inc(RExC_rx_sv);
16623                         }
16624                     }
16625                     non_portable_endpoint++;
16626                     break;
16627                 }
16628             default:
16629                 /* Allow \_ to not give an error */
16630                 if (!SIZE_ONLY && isWORDCHAR(value) && value != '_') {
16631                     if (strict) {
16632                         vFAIL2("Unrecognized escape \\%c in character class",
16633                                (int)value);
16634                     }
16635                     else {
16636                         SAVEFREESV(RExC_rx_sv);
16637                         ckWARN2reg(RExC_parse,
16638                             "Unrecognized escape \\%c in character class passed through",
16639                             (int)value);
16640                         (void)ReREFCNT_inc(RExC_rx_sv);
16641                     }
16642                 }
16643                 break;
16644             }   /* End of switch on char following backslash */
16645         } /* end of handling backslash escape sequences */
16646
16647         /* Here, we have the current token in 'value' */
16648
16649         if (namedclass > OOB_NAMEDCLASS) { /* this is a named class \blah */
16650             U8 classnum;
16651
16652             /* a bad range like a-\d, a-[:digit:].  The '-' is taken as a
16653              * literal, as is the character that began the false range, i.e.
16654              * the 'a' in the examples */
16655             if (range) {
16656                 if (!SIZE_ONLY) {
16657                     const int w = (RExC_parse >= rangebegin)
16658                                   ? RExC_parse - rangebegin
16659                                   : 0;
16660                     if (strict) {
16661                         vFAIL2utf8f(
16662                             "False [] range \"%" UTF8f "\"",
16663                             UTF8fARG(UTF, w, rangebegin));
16664                     }
16665                     else {
16666                         SAVEFREESV(RExC_rx_sv); /* in case of fatal warnings */
16667                         ckWARN2reg(RExC_parse,
16668                             "False [] range \"%" UTF8f "\"",
16669                             UTF8fARG(UTF, w, rangebegin));
16670                         (void)ReREFCNT_inc(RExC_rx_sv);
16671                         cp_list = add_cp_to_invlist(cp_list, '-');
16672                         cp_foldable_list = add_cp_to_invlist(cp_foldable_list,
16673                                                              prevvalue);
16674                     }
16675                 }
16676
16677                 range = 0; /* this was not a true range */
16678                 element_count += 2; /* So counts for three values */
16679             }
16680
16681             classnum = namedclass_to_classnum(namedclass);
16682
16683             if (LOC && namedclass < ANYOF_POSIXL_MAX
16684 #ifndef HAS_ISASCII
16685                 && classnum != _CC_ASCII
16686 #endif
16687             ) {
16688                 /* What the Posix classes (like \w, [:space:]) match in locale
16689                  * isn't knowable under locale until actual match time.  Room
16690                  * must be reserved (one time per outer bracketed class) to
16691                  * store such classes.  The space will contain a bit for each
16692                  * named class that is to be matched against.  This isn't
16693                  * needed for \p{} and pseudo-classes, as they are not affected
16694                  * by locale, and hence are dealt with separately */
16695                 if (! need_class) {
16696                     need_class = 1;
16697                     if (SIZE_ONLY) {
16698                         RExC_size += ANYOF_POSIXL_SKIP - ANYOF_SKIP;
16699                     }
16700                     else {
16701                         RExC_emit += ANYOF_POSIXL_SKIP - ANYOF_SKIP;
16702                     }
16703                     ANYOF_FLAGS(ret) |= ANYOF_MATCHES_POSIXL;
16704                     ANYOF_POSIXL_ZERO(ret);
16705
16706                     /* We can't change this into some other type of node
16707                      * (unless this is the only element, in which case there
16708                      * are nodes that mean exactly this) as has runtime
16709                      * dependencies */
16710                     optimizable = FALSE;
16711                 }
16712
16713                 /* Coverity thinks it is possible for this to be negative; both
16714                  * jhi and khw think it's not, but be safer */
16715                 assert(! (ANYOF_FLAGS(ret) & ANYOF_MATCHES_POSIXL)
16716                        || (namedclass + ((namedclass % 2) ? -1 : 1)) >= 0);
16717
16718                 /* See if it already matches the complement of this POSIX
16719                  * class */
16720                 if ((ANYOF_FLAGS(ret) & ANYOF_MATCHES_POSIXL)
16721                     && ANYOF_POSIXL_TEST(ret, namedclass + ((namedclass % 2)
16722                                                             ? -1
16723                                                             : 1)))
16724                 {
16725                     posixl_matches_all = TRUE;
16726                     break;  /* No need to continue.  Since it matches both
16727                                e.g., \w and \W, it matches everything, and the
16728                                bracketed class can be optimized into qr/./s */
16729                 }
16730
16731                 /* Add this class to those that should be checked at runtime */
16732                 ANYOF_POSIXL_SET(ret, namedclass);
16733
16734                 /* The above-Latin1 characters are not subject to locale rules.
16735                  * Just add them, in the second pass, to the
16736                  * unconditionally-matched list */
16737                 if (! SIZE_ONLY) {
16738                     SV* scratch_list = NULL;
16739
16740                     /* Get the list of the above-Latin1 code points this
16741                      * matches */
16742                     _invlist_intersection_maybe_complement_2nd(PL_AboveLatin1,
16743                                           PL_XPosix_ptrs[classnum],
16744
16745                                           /* Odd numbers are complements, like
16746                                            * NDIGIT, NASCII, ... */
16747                                           namedclass % 2 != 0,
16748                                           &scratch_list);
16749                     /* Checking if 'cp_list' is NULL first saves an extra
16750                      * clone.  Its reference count will be decremented at the
16751                      * next union, etc, or if this is the only instance, at the
16752                      * end of the routine */
16753                     if (! cp_list) {
16754                         cp_list = scratch_list;
16755                     }
16756                     else {
16757                         _invlist_union(cp_list, scratch_list, &cp_list);
16758                         SvREFCNT_dec_NN(scratch_list);
16759                     }
16760                     continue;   /* Go get next character */
16761                 }
16762             }
16763             else if (! SIZE_ONLY) {
16764
16765                 /* Here, not in pass1 (in that pass we skip calculating the
16766                  * contents of this class), and is not /l, or is a POSIX class
16767                  * for which /l doesn't matter (or is a Unicode property, which
16768                  * is skipped here). */
16769                 if (namedclass >= ANYOF_POSIXL_MAX) {  /* If a special class */
16770                     if (namedclass != ANYOF_UNIPROP) { /* UNIPROP = \p and \P */
16771
16772                         /* Here, should be \h, \H, \v, or \V.  None of /d, /i
16773                          * nor /l make a difference in what these match,
16774                          * therefore we just add what they match to cp_list. */
16775                         if (classnum != _CC_VERTSPACE) {
16776                             assert(   namedclass == ANYOF_HORIZWS
16777                                    || namedclass == ANYOF_NHORIZWS);
16778
16779                             /* It turns out that \h is just a synonym for
16780                              * XPosixBlank */
16781                             classnum = _CC_BLANK;
16782                         }
16783
16784                         _invlist_union_maybe_complement_2nd(
16785                                 cp_list,
16786                                 PL_XPosix_ptrs[classnum],
16787                                 namedclass % 2 != 0,    /* Complement if odd
16788                                                           (NHORIZWS, NVERTWS)
16789                                                         */
16790                                 &cp_list);
16791                     }
16792                 }
16793                 else if (  UNI_SEMANTICS
16794                         || classnum == _CC_ASCII
16795                         || (DEPENDS_SEMANTICS && (   classnum == _CC_DIGIT
16796                                                   || classnum == _CC_XDIGIT)))
16797                 {
16798                     /* We usually have to worry about /d and /a affecting what
16799                      * POSIX classes match, with special code needed for /d
16800                      * because we won't know until runtime what all matches.
16801                      * But there is no extra work needed under /u, and
16802                      * [:ascii:] is unaffected by /a and /d; and :digit: and
16803                      * :xdigit: don't have runtime differences under /d.  So we
16804                      * can special case these, and avoid some extra work below,
16805                      * and at runtime. */
16806                     _invlist_union_maybe_complement_2nd(
16807                                                      simple_posixes,
16808                                                      PL_XPosix_ptrs[classnum],
16809                                                      namedclass % 2 != 0,
16810                                                      &simple_posixes);
16811                 }
16812                 else {  /* Garden variety class.  If is NUPPER, NALPHA, ...
16813                            complement and use nposixes */
16814                     SV** posixes_ptr = namedclass % 2 == 0
16815                                        ? &posixes
16816                                        : &nposixes;
16817                     _invlist_union_maybe_complement_2nd(
16818                                                      *posixes_ptr,
16819                                                      PL_XPosix_ptrs[classnum],
16820                                                      namedclass % 2 != 0,
16821                                                      posixes_ptr);
16822                 }
16823             }
16824         } /* end of namedclass \blah */
16825
16826         SKIP_BRACKETED_WHITE_SPACE(skip_white, RExC_parse);
16827
16828         /* If 'range' is set, 'value' is the ending of a range--check its
16829          * validity.  (If value isn't a single code point in the case of a
16830          * range, we should have figured that out above in the code that
16831          * catches false ranges).  Later, we will handle each individual code
16832          * point in the range.  If 'range' isn't set, this could be the
16833          * beginning of a range, so check for that by looking ahead to see if
16834          * the next real character to be processed is the range indicator--the
16835          * minus sign */
16836
16837         if (range) {
16838 #ifdef EBCDIC
16839             /* For unicode ranges, we have to test that the Unicode as opposed
16840              * to the native values are not decreasing.  (Above 255, there is
16841              * no difference between native and Unicode) */
16842             if (unicode_range && prevvalue < 255 && value < 255) {
16843                 if (NATIVE_TO_LATIN1(prevvalue) > NATIVE_TO_LATIN1(value)) {
16844                     goto backwards_range;
16845                 }
16846             }
16847             else
16848 #endif
16849             if (prevvalue > value) /* b-a */ {
16850                 int w;
16851 #ifdef EBCDIC
16852               backwards_range:
16853 #endif
16854                 w = RExC_parse - rangebegin;
16855                 vFAIL2utf8f(
16856                     "Invalid [] range \"%" UTF8f "\"",
16857                     UTF8fARG(UTF, w, rangebegin));
16858                 NOT_REACHED; /* NOTREACHED */
16859             }
16860         }
16861         else {
16862             prevvalue = value; /* save the beginning of the potential range */
16863             if (! stop_at_1     /* Can't be a range if parsing just one thing */
16864                 && *RExC_parse == '-')
16865             {
16866                 char* next_char_ptr = RExC_parse + 1;
16867
16868                 /* Get the next real char after the '-' */
16869                 SKIP_BRACKETED_WHITE_SPACE(skip_white, next_char_ptr);
16870
16871                 /* If the '-' is at the end of the class (just before the ']',
16872                  * it is a literal minus; otherwise it is a range */
16873                 if (next_char_ptr < RExC_end && *next_char_ptr != ']') {
16874                     RExC_parse = next_char_ptr;
16875
16876                     /* a bad range like \w-, [:word:]- ? */
16877                     if (namedclass > OOB_NAMEDCLASS) {
16878                         if (strict || (PASS2 && ckWARN(WARN_REGEXP))) {
16879                             const int w = RExC_parse >= rangebegin
16880                                           ?  RExC_parse - rangebegin
16881                                           : 0;
16882                             if (strict) {
16883                                 vFAIL4("False [] range \"%*.*s\"",
16884                                     w, w, rangebegin);
16885                             }
16886                             else if (PASS2) {
16887                                 vWARN4(RExC_parse,
16888                                     "False [] range \"%*.*s\"",
16889                                     w, w, rangebegin);
16890                             }
16891                         }
16892                         if (!SIZE_ONLY) {
16893                             cp_list = add_cp_to_invlist(cp_list, '-');
16894                         }
16895                         element_count++;
16896                     } else
16897                         range = 1;      /* yeah, it's a range! */
16898                     continue;   /* but do it the next time */
16899                 }
16900             }
16901         }
16902
16903         if (namedclass > OOB_NAMEDCLASS) {
16904             continue;
16905         }
16906
16907         /* Here, we have a single value this time through the loop, and
16908          * <prevvalue> is the beginning of the range, if any; or <value> if
16909          * not. */
16910
16911         /* non-Latin1 code point implies unicode semantics.  Must be set in
16912          * pass1 so is there for the whole of pass 2 */
16913         if (value > 255) {
16914             REQUIRE_UNI_RULES(flagp, NULL);
16915         }
16916
16917         /* Ready to process either the single value, or the completed range.
16918          * For single-valued non-inverted ranges, we consider the possibility
16919          * of multi-char folds.  (We made a conscious decision to not do this
16920          * for the other cases because it can often lead to non-intuitive
16921          * results.  For example, you have the peculiar case that:
16922          *  "s s" =~ /^[^\xDF]+$/i => Y
16923          *  "ss"  =~ /^[^\xDF]+$/i => N
16924          *
16925          * See [perl #89750] */
16926         if (FOLD && allow_multi_folds && value == prevvalue) {
16927             if (value == LATIN_SMALL_LETTER_SHARP_S
16928                 || (value > 255 && _invlist_contains_cp(PL_HasMultiCharFold,
16929                                                         value)))
16930             {
16931                 /* Here <value> is indeed a multi-char fold.  Get what it is */
16932
16933                 U8 foldbuf[UTF8_MAXBYTES_CASE];
16934                 STRLEN foldlen;
16935
16936                 UV folded = _to_uni_fold_flags(
16937                                 value,
16938                                 foldbuf,
16939                                 &foldlen,
16940                                 FOLD_FLAGS_FULL | (ASCII_FOLD_RESTRICTED
16941                                                    ? FOLD_FLAGS_NOMIX_ASCII
16942                                                    : 0)
16943                                 );
16944
16945                 /* Here, <folded> should be the first character of the
16946                  * multi-char fold of <value>, with <foldbuf> containing the
16947                  * whole thing.  But, if this fold is not allowed (because of
16948                  * the flags), <fold> will be the same as <value>, and should
16949                  * be processed like any other character, so skip the special
16950                  * handling */
16951                 if (folded != value) {
16952
16953                     /* Skip if we are recursed, currently parsing the class
16954                      * again.  Otherwise add this character to the list of
16955                      * multi-char folds. */
16956                     if (! RExC_in_multi_char_class) {
16957                         STRLEN cp_count = utf8_length(foldbuf,
16958                                                       foldbuf + foldlen);
16959                         SV* multi_fold = sv_2mortal(newSVpvs(""));
16960
16961                         Perl_sv_catpvf(aTHX_ multi_fold, "\\x{%" UVXf "}", value);
16962
16963                         multi_char_matches
16964                                         = add_multi_match(multi_char_matches,
16965                                                           multi_fold,
16966                                                           cp_count);
16967
16968                     }
16969
16970                     /* This element should not be processed further in this
16971                      * class */
16972                     element_count--;
16973                     value = save_value;
16974                     prevvalue = save_prevvalue;
16975                     continue;
16976                 }
16977             }
16978         }
16979
16980         if (strict && PASS2 && ckWARN(WARN_REGEXP)) {
16981             if (range) {
16982
16983                 /* If the range starts above 255, everything is portable and
16984                  * likely to be so for any forseeable character set, so don't
16985                  * warn. */
16986                 if (unicode_range && non_portable_endpoint && prevvalue < 256) {
16987                     vWARN(RExC_parse, "Both or neither range ends should be Unicode");
16988                 }
16989                 else if (prevvalue != value) {
16990
16991                     /* Under strict, ranges that stop and/or end in an ASCII
16992                      * printable should have each end point be a portable value
16993                      * for it (preferably like 'A', but we don't warn if it is
16994                      * a (portable) Unicode name or code point), and the range
16995                      * must be be all digits or all letters of the same case.
16996                      * Otherwise, the range is non-portable and unclear as to
16997                      * what it contains */
16998                     if (             (isPRINT_A(prevvalue) || isPRINT_A(value))
16999                         && (          non_portable_endpoint
17000                             || ! (   (isDIGIT_A(prevvalue) && isDIGIT_A(value))
17001                                   || (isLOWER_A(prevvalue) && isLOWER_A(value))
17002                                   || (isUPPER_A(prevvalue) && isUPPER_A(value))
17003                     ))) {
17004                         vWARN(RExC_parse, "Ranges of ASCII printables should"
17005                                           " be some subset of \"0-9\","
17006                                           " \"A-Z\", or \"a-z\"");
17007                     }
17008                     else if (prevvalue >= 0x660) { /* ARABIC_INDIC_DIGIT_ZERO */
17009                         SSize_t index_start;
17010                         SSize_t index_final;
17011
17012                         /* But the nature of Unicode and languages mean we
17013                          * can't do the same checks for above-ASCII ranges,
17014                          * except in the case of digit ones.  These should
17015                          * contain only digits from the same group of 10.  The
17016                          * ASCII case is handled just above.  0x660 is the
17017                          * first digit character beyond ASCII.  Hence here, the
17018                          * range could be a range of digits.  First some
17019                          * unlikely special cases.  Grandfather in that a range
17020                          * ending in 19DA (NEW TAI LUE THAM DIGIT ONE) is bad
17021                          * if its starting value is one of the 10 digits prior
17022                          * to it.  This is because it is an alternate way of
17023                          * writing 19D1, and some people may expect it to be in
17024                          * that group.  But it is bad, because it won't give
17025                          * the expected results.  In Unicode 5.2 it was
17026                          * considered to be in that group (of 11, hence), but
17027                          * this was fixed in the next version */
17028
17029                         if (UNLIKELY(value == 0x19DA && prevvalue >= 0x19D0)) {
17030                             goto warn_bad_digit_range;
17031                         }
17032                         else if (UNLIKELY(   prevvalue >= 0x1D7CE
17033                                           &&     value <= 0x1D7FF))
17034                         {
17035                             /* This is the only other case currently in Unicode
17036                              * where the algorithm below fails.  The code
17037                              * points just above are the end points of a single
17038                              * range containing only decimal digits.  It is 5
17039                              * different series of 0-9.  All other ranges of
17040                              * digits currently in Unicode are just a single
17041                              * series.  (And mktables will notify us if a later
17042                              * Unicode version breaks this.)
17043                              *
17044                              * If the range being checked is at most 9 long,
17045                              * and the digit values represented are in
17046                              * numerical order, they are from the same series.
17047                              * */
17048                             if (         value - prevvalue > 9
17049                                 ||    (((    value - 0x1D7CE) % 10)
17050                                      <= (prevvalue - 0x1D7CE) % 10))
17051                             {
17052                                 goto warn_bad_digit_range;
17053                             }
17054                         }
17055                         else {
17056
17057                             /* For all other ranges of digits in Unicode, the
17058                              * algorithm is just to check if both end points
17059                              * are in the same series, which is the same range.
17060                              * */
17061                             index_start = _invlist_search(
17062                                                     PL_XPosix_ptrs[_CC_DIGIT],
17063                                                     prevvalue);
17064
17065                             /* Warn if the range starts and ends with a digit,
17066                              * and they are not in the same group of 10. */
17067                             if (   index_start >= 0
17068                                 && ELEMENT_RANGE_MATCHES_INVLIST(index_start)
17069                                 && (index_final =
17070                                     _invlist_search(PL_XPosix_ptrs[_CC_DIGIT],
17071                                                     value)) != index_start
17072                                 && index_final >= 0
17073                                 && ELEMENT_RANGE_MATCHES_INVLIST(index_final))
17074                             {
17075                               warn_bad_digit_range:
17076                                 vWARN(RExC_parse, "Ranges of digits should be"
17077                                                   " from the same group of"
17078                                                   " 10");
17079                             }
17080                         }
17081                     }
17082                 }
17083             }
17084             if ((! range || prevvalue == value) && non_portable_endpoint) {
17085                 if (isPRINT_A(value)) {
17086                     char literal[3];
17087                     unsigned d = 0;
17088                     if (isBACKSLASHED_PUNCT(value)) {
17089                         literal[d++] = '\\';
17090                     }
17091                     literal[d++] = (char) value;
17092                     literal[d++] = '\0';
17093
17094                     vWARN4(RExC_parse,
17095                            "\"%.*s\" is more clearly written simply as \"%s\"",
17096                            (int) (RExC_parse - rangebegin),
17097                            rangebegin,
17098                            literal
17099                         );
17100                 }
17101                 else if isMNEMONIC_CNTRL(value) {
17102                     vWARN4(RExC_parse,
17103                            "\"%.*s\" is more clearly written simply as \"%s\"",
17104                            (int) (RExC_parse - rangebegin),
17105                            rangebegin,
17106                            cntrl_to_mnemonic((U8) value)
17107                         );
17108                 }
17109             }
17110         }
17111
17112         /* Deal with this element of the class */
17113         if (! SIZE_ONLY) {
17114
17115 #ifndef EBCDIC
17116             cp_foldable_list = _add_range_to_invlist(cp_foldable_list,
17117                                                      prevvalue, value);
17118 #else
17119             /* On non-ASCII platforms, for ranges that span all of 0..255, and
17120              * ones that don't require special handling, we can just add the
17121              * range like we do for ASCII platforms */
17122             if ((UNLIKELY(prevvalue == 0) && value >= 255)
17123                 || ! (prevvalue < 256
17124                       && (unicode_range
17125                           || (! non_portable_endpoint
17126                               && ((isLOWER_A(prevvalue) && isLOWER_A(value))
17127                                   || (isUPPER_A(prevvalue)
17128                                       && isUPPER_A(value)))))))
17129             {
17130                 cp_foldable_list = _add_range_to_invlist(cp_foldable_list,
17131                                                          prevvalue, value);
17132             }
17133             else {
17134                 /* Here, requires special handling.  This can be because it is
17135                  * a range whose code points are considered to be Unicode, and
17136                  * so must be individually translated into native, or because
17137                  * its a subrange of 'A-Z' or 'a-z' which each aren't
17138                  * contiguous in EBCDIC, but we have defined them to include
17139                  * only the "expected" upper or lower case ASCII alphabetics.
17140                  * Subranges above 255 are the same in native and Unicode, so
17141                  * can be added as a range */
17142                 U8 start = NATIVE_TO_LATIN1(prevvalue);
17143                 unsigned j;
17144                 U8 end = (value < 256) ? NATIVE_TO_LATIN1(value) : 255;
17145                 for (j = start; j <= end; j++) {
17146                     cp_foldable_list = add_cp_to_invlist(cp_foldable_list, LATIN1_TO_NATIVE(j));
17147                 }
17148                 if (value > 255) {
17149                     cp_foldable_list = _add_range_to_invlist(cp_foldable_list,
17150                                                              256, value);
17151                 }
17152             }
17153 #endif
17154         }
17155
17156         range = 0; /* this range (if it was one) is done now */
17157     } /* End of loop through all the text within the brackets */
17158
17159
17160     if (   posix_warnings && av_tindex_skip_len_mg(posix_warnings) >= 0) {
17161         output_or_return_posix_warnings(pRExC_state, posix_warnings,
17162                                         return_posix_warnings);
17163     }
17164
17165     /* If anything in the class expands to more than one character, we have to
17166      * deal with them by building up a substitute parse string, and recursively
17167      * calling reg() on it, instead of proceeding */
17168     if (multi_char_matches) {
17169         SV * substitute_parse = newSVpvn_flags("?:", 2, SVs_TEMP);
17170         I32 cp_count;
17171         STRLEN len;
17172         char *save_end = RExC_end;
17173         char *save_parse = RExC_parse;
17174         char *save_start = RExC_start;
17175         STRLEN prefix_end = 0;      /* We copy the character class after a
17176                                        prefix supplied here.  This is the size
17177                                        + 1 of that prefix */
17178         bool first_time = TRUE;     /* First multi-char occurrence doesn't get
17179                                        a "|" */
17180         I32 reg_flags;
17181
17182         assert(! invert);
17183         assert(RExC_precomp_adj == 0); /* Only one level of recursion allowed */
17184
17185 #if 0   /* Have decided not to deal with multi-char folds in inverted classes,
17186            because too confusing */
17187         if (invert) {
17188             sv_catpv(substitute_parse, "(?:");
17189         }
17190 #endif
17191
17192         /* Look at the longest folds first */
17193         for (cp_count = av_tindex_skip_len_mg(multi_char_matches);
17194                         cp_count > 0;
17195                         cp_count--)
17196         {
17197
17198             if (av_exists(multi_char_matches, cp_count)) {
17199                 AV** this_array_ptr;
17200                 SV* this_sequence;
17201
17202                 this_array_ptr = (AV**) av_fetch(multi_char_matches,
17203                                                  cp_count, FALSE);
17204                 while ((this_sequence = av_pop(*this_array_ptr)) !=
17205                                                                 &PL_sv_undef)
17206                 {
17207                     if (! first_time) {
17208                         sv_catpv(substitute_parse, "|");
17209                     }
17210                     first_time = FALSE;
17211
17212                     sv_catpv(substitute_parse, SvPVX(this_sequence));
17213                 }
17214             }
17215         }
17216
17217         /* If the character class contains anything else besides these
17218          * multi-character folds, have to include it in recursive parsing */
17219         if (element_count) {
17220             sv_catpv(substitute_parse, "|[");
17221             prefix_end = SvCUR(substitute_parse);
17222             sv_catpvn(substitute_parse, orig_parse, RExC_parse - orig_parse);
17223
17224             /* Put in a closing ']' only if not going off the end, as otherwise
17225              * we are adding something that really isn't there */
17226             if (RExC_parse < RExC_end) {
17227                 sv_catpv(substitute_parse, "]");
17228             }
17229         }
17230
17231         sv_catpv(substitute_parse, ")");
17232 #if 0
17233         if (invert) {
17234             /* This is a way to get the parse to skip forward a whole named
17235              * sequence instead of matching the 2nd character when it fails the
17236              * first */
17237             sv_catpv(substitute_parse, "(*THEN)(*SKIP)(*FAIL)|.)");
17238         }
17239 #endif
17240
17241         /* Set up the data structure so that any errors will be properly
17242          * reported.  See the comments at the definition of
17243          * REPORT_LOCATION_ARGS for details */
17244         RExC_precomp_adj = orig_parse - RExC_precomp;
17245         RExC_start =  RExC_parse = SvPV(substitute_parse, len);
17246         RExC_adjusted_start = RExC_start + prefix_end;
17247         RExC_end = RExC_parse + len;
17248         RExC_in_multi_char_class = 1;
17249         RExC_emit = (regnode *)orig_emit;
17250
17251         ret = reg(pRExC_state, 1, &reg_flags, depth+1);
17252
17253         *flagp |= reg_flags&(HASWIDTH|SIMPLE|SPSTART|POSTPONED|RESTART_PASS1|NEED_UTF8);
17254
17255         /* And restore so can parse the rest of the pattern */
17256         RExC_parse = save_parse;
17257         RExC_start = RExC_adjusted_start = save_start;
17258         RExC_precomp_adj = 0;
17259         RExC_end = save_end;
17260         RExC_in_multi_char_class = 0;
17261         SvREFCNT_dec_NN(multi_char_matches);
17262         return ret;
17263     }
17264
17265     /* Here, we've gone through the entire class and dealt with multi-char
17266      * folds.  We are now in a position that we can do some checks to see if we
17267      * can optimize this ANYOF node into a simpler one, even in Pass 1.
17268      * Currently we only do two checks:
17269      * 1) is in the unlikely event that the user has specified both, eg. \w and
17270      *    \W under /l, then the class matches everything.  (This optimization
17271      *    is done only to make the optimizer code run later work.)
17272      * 2) if the character class contains only a single element (including a
17273      *    single range), we see if there is an equivalent node for it.
17274      * Other checks are possible */
17275     if (   optimizable
17276         && ! ret_invlist   /* Can't optimize if returning the constructed
17277                               inversion list */
17278         && (UNLIKELY(posixl_matches_all) || element_count == 1))
17279     {
17280         U8 op = END;
17281         U8 arg = 0;
17282
17283         if (UNLIKELY(posixl_matches_all)) {
17284             op = SANY;
17285         }
17286         else if (namedclass > OOB_NAMEDCLASS) { /* this is a single named
17287                                                    class, like \w or [:digit:]
17288                                                    or \p{foo} */
17289
17290             /* All named classes are mapped into POSIXish nodes, with its FLAG
17291              * argument giving which class it is */
17292             switch ((I32)namedclass) {
17293                 case ANYOF_UNIPROP:
17294                     break;
17295
17296                 /* These don't depend on the charset modifiers.  They always
17297                  * match under /u rules */
17298                 case ANYOF_NHORIZWS:
17299                 case ANYOF_HORIZWS:
17300                     namedclass = ANYOF_BLANK + namedclass - ANYOF_HORIZWS;
17301                     /* FALLTHROUGH */
17302
17303                 case ANYOF_NVERTWS:
17304                 case ANYOF_VERTWS:
17305                     op = POSIXU;
17306                     goto join_posix;
17307
17308                 /* The actual POSIXish node for all the rest depends on the
17309                  * charset modifier.  The ones in the first set depend only on
17310                  * ASCII or, if available on this platform, also locale */
17311                 case ANYOF_ASCII:
17312                 case ANYOF_NASCII:
17313 #ifdef HAS_ISASCII
17314                     op = (LOC) ? POSIXL : POSIXA;
17315 #else
17316                     op = POSIXA;
17317 #endif
17318                     goto join_posix;
17319
17320                 /* The following don't have any matches in the upper Latin1
17321                  * range, hence /d is equivalent to /u for them.  Making it /u
17322                  * saves some branches at runtime */
17323                 case ANYOF_DIGIT:
17324                 case ANYOF_NDIGIT:
17325                 case ANYOF_XDIGIT:
17326                 case ANYOF_NXDIGIT:
17327                     if (! DEPENDS_SEMANTICS) {
17328                         goto treat_as_default;
17329                     }
17330
17331                     op = POSIXU;
17332                     goto join_posix;
17333
17334                 /* The following change to CASED under /i */
17335                 case ANYOF_LOWER:
17336                 case ANYOF_NLOWER:
17337                 case ANYOF_UPPER:
17338                 case ANYOF_NUPPER:
17339                     if (FOLD) {
17340                         namedclass = ANYOF_CASED + (namedclass % 2);
17341                     }
17342                     /* FALLTHROUGH */
17343
17344                 /* The rest have more possibilities depending on the charset.
17345                  * We take advantage of the enum ordering of the charset
17346                  * modifiers to get the exact node type, */
17347                 default:
17348                   treat_as_default:
17349                     op = POSIXD + get_regex_charset(RExC_flags);
17350                     if (op > POSIXA) { /* /aa is same as /a */
17351                         op = POSIXA;
17352                     }
17353
17354                   join_posix:
17355                     /* The odd numbered ones are the complements of the
17356                      * next-lower even number one */
17357                     if (namedclass % 2 == 1) {
17358                         invert = ! invert;
17359                         namedclass--;
17360                     }
17361                     arg = namedclass_to_classnum(namedclass);
17362                     break;
17363             }
17364         }
17365         else if (value == prevvalue) {
17366
17367             /* Here, the class consists of just a single code point */
17368
17369             if (invert) {
17370                 if (! LOC && value == '\n') {
17371                     op = REG_ANY; /* Optimize [^\n] */
17372                     *flagp |= HASWIDTH|SIMPLE;
17373                     MARK_NAUGHTY(1);
17374                 }
17375             }
17376             else if (value < 256 || UTF) {
17377
17378                 /* Optimize a single value into an EXACTish node, but not if it
17379                  * would require converting the pattern to UTF-8. */
17380                 op = compute_EXACTish(pRExC_state);
17381             }
17382         } /* Otherwise is a range */
17383         else if (! LOC) {   /* locale could vary these */
17384             if (prevvalue == '0') {
17385                 if (value == '9') {
17386                     arg = _CC_DIGIT;
17387                     op = POSIXA;
17388                 }
17389             }
17390             else if (! FOLD || ASCII_FOLD_RESTRICTED) {
17391                 /* We can optimize A-Z or a-z, but not if they could match
17392                  * something like the KELVIN SIGN under /i. */
17393                 if (prevvalue == 'A') {
17394                     if (value == 'Z'
17395 #ifdef EBCDIC
17396                         && ! non_portable_endpoint
17397 #endif
17398                     ) {
17399                         arg = (FOLD) ? _CC_ALPHA : _CC_UPPER;
17400                         op = POSIXA;
17401                     }
17402                 }
17403                 else if (prevvalue == 'a') {
17404                     if (value == 'z'
17405 #ifdef EBCDIC
17406                         && ! non_portable_endpoint
17407 #endif
17408                     ) {
17409                         arg = (FOLD) ? _CC_ALPHA : _CC_LOWER;
17410                         op = POSIXA;
17411                     }
17412                 }
17413             }
17414         }
17415
17416         /* Here, we have changed <op> away from its initial value iff we found
17417          * an optimization */
17418         if (op != END) {
17419
17420             /* Throw away this ANYOF regnode, and emit the calculated one,
17421              * which should correspond to the beginning, not current, state of
17422              * the parse */
17423             const char * cur_parse = RExC_parse;
17424             RExC_parse = (char *)orig_parse;
17425             if ( SIZE_ONLY) {
17426                 if (! LOC) {
17427
17428                     /* To get locale nodes to not use the full ANYOF size would
17429                      * require moving the code above that writes the portions
17430                      * of it that aren't in other nodes to after this point.
17431                      * e.g.  ANYOF_POSIXL_SET */
17432                     RExC_size = orig_size;
17433                 }
17434             }
17435             else {
17436                 RExC_emit = (regnode *)orig_emit;
17437                 if (PL_regkind[op] == POSIXD) {
17438                     if (op == POSIXL) {
17439                         RExC_contains_locale = 1;
17440                     }
17441                     if (invert) {
17442                         op += NPOSIXD - POSIXD;
17443                     }
17444                 }
17445             }
17446
17447             ret = reg_node(pRExC_state, op);
17448
17449             if (PL_regkind[op] == POSIXD || PL_regkind[op] == NPOSIXD) {
17450                 if (! SIZE_ONLY) {
17451                     FLAGS(ret) = arg;
17452                 }
17453                 *flagp |= HASWIDTH|SIMPLE;
17454             }
17455             else if (PL_regkind[op] == EXACT) {
17456                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, 0, value,
17457                                            TRUE /* downgradable to EXACT */
17458                                            );
17459             }
17460
17461             RExC_parse = (char *) cur_parse;
17462
17463             SvREFCNT_dec(posixes);
17464             SvREFCNT_dec(nposixes);
17465             SvREFCNT_dec(simple_posixes);
17466             SvREFCNT_dec(cp_list);
17467             SvREFCNT_dec(cp_foldable_list);
17468             return ret;
17469         }
17470     }
17471
17472     if (SIZE_ONLY)
17473         return ret;
17474     /****** !SIZE_ONLY (Pass 2) AFTER HERE *********/
17475
17476     /* If folding, we calculate all characters that could fold to or from the
17477      * ones already on the list */
17478     if (cp_foldable_list) {
17479         if (FOLD) {
17480             UV start, end;      /* End points of code point ranges */
17481
17482             SV* fold_intersection = NULL;
17483             SV** use_list;
17484
17485             /* Our calculated list will be for Unicode rules.  For locale
17486              * matching, we have to keep a separate list that is consulted at
17487              * runtime only when the locale indicates Unicode rules.  For
17488              * non-locale, we just use the general list */
17489             if (LOC) {
17490                 use_list = &only_utf8_locale_list;
17491             }
17492             else {
17493                 use_list = &cp_list;
17494             }
17495
17496             /* Only the characters in this class that participate in folds need
17497              * be checked.  Get the intersection of this class and all the
17498              * possible characters that are foldable.  This can quickly narrow
17499              * down a large class */
17500             _invlist_intersection(PL_utf8_foldable, cp_foldable_list,
17501                                   &fold_intersection);
17502
17503             /* The folds for all the Latin1 characters are hard-coded into this
17504              * program, but we have to go out to disk to get the others. */
17505             if (invlist_highest(cp_foldable_list) >= 256) {
17506
17507                 /* This is a hash that for a particular fold gives all
17508                  * characters that are involved in it */
17509                 if (! PL_utf8_foldclosures) {
17510                     _load_PL_utf8_foldclosures();
17511                 }
17512             }
17513
17514             /* Now look at the foldable characters in this class individually */
17515             invlist_iterinit(fold_intersection);
17516             while (invlist_iternext(fold_intersection, &start, &end)) {
17517                 UV j;
17518
17519                 /* Look at every character in the range */
17520                 for (j = start; j <= end; j++) {
17521                     U8 foldbuf[UTF8_MAXBYTES_CASE+1];
17522                     STRLEN foldlen;
17523                     SV** listp;
17524
17525                     if (j < 256) {
17526
17527                         if (IS_IN_SOME_FOLD_L1(j)) {
17528
17529                             /* ASCII is always matched; non-ASCII is matched
17530                              * only under Unicode rules (which could happen
17531                              * under /l if the locale is a UTF-8 one */
17532                             if (isASCII(j) || ! DEPENDS_SEMANTICS) {
17533                                 *use_list = add_cp_to_invlist(*use_list,
17534                                                             PL_fold_latin1[j]);
17535                             }
17536                             else {
17537                                 has_upper_latin1_only_utf8_matches
17538                                     = add_cp_to_invlist(
17539                                             has_upper_latin1_only_utf8_matches,
17540                                             PL_fold_latin1[j]);
17541                             }
17542                         }
17543
17544                         if (HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(j)
17545                             && (! isASCII(j) || ! ASCII_FOLD_RESTRICTED))
17546                         {
17547                             add_above_Latin1_folds(pRExC_state,
17548                                                    (U8) j,
17549                                                    use_list);
17550                         }
17551                         continue;
17552                     }
17553
17554                     /* Here is an above Latin1 character.  We don't have the
17555                      * rules hard-coded for it.  First, get its fold.  This is
17556                      * the simple fold, as the multi-character folds have been
17557                      * handled earlier and separated out */
17558                     _to_uni_fold_flags(j, foldbuf, &foldlen,
17559                                                         (ASCII_FOLD_RESTRICTED)
17560                                                         ? FOLD_FLAGS_NOMIX_ASCII
17561                                                         : 0);
17562
17563                     /* Single character fold of above Latin1.  Add everything in
17564                     * its fold closure to the list that this node should match.
17565                     * The fold closures data structure is a hash with the keys
17566                     * being the UTF-8 of every character that is folded to, like
17567                     * 'k', and the values each an array of all code points that
17568                     * fold to its key.  e.g. [ 'k', 'K', KELVIN_SIGN ].
17569                     * Multi-character folds are not included */
17570                     if ((listp = hv_fetch(PL_utf8_foldclosures,
17571                                         (char *) foldbuf, foldlen, FALSE)))
17572                     {
17573                         AV* list = (AV*) *listp;
17574                         IV k;
17575                         for (k = 0; k <= av_tindex_skip_len_mg(list); k++) {
17576                             SV** c_p = av_fetch(list, k, FALSE);
17577                             UV c;
17578                             assert(c_p);
17579
17580                             c = SvUV(*c_p);
17581
17582                             /* /aa doesn't allow folds between ASCII and non- */
17583                             if ((ASCII_FOLD_RESTRICTED
17584                                 && (isASCII(c) != isASCII(j))))
17585                             {
17586                                 continue;
17587                             }
17588
17589                             /* Folds under /l which cross the 255/256 boundary
17590                              * are added to a separate list.  (These are valid
17591                              * only when the locale is UTF-8.) */
17592                             if (c < 256 && LOC) {
17593                                 *use_list = add_cp_to_invlist(*use_list, c);
17594                                 continue;
17595                             }
17596
17597                             if (isASCII(c) || c > 255 || AT_LEAST_UNI_SEMANTICS)
17598                             {
17599                                 cp_list = add_cp_to_invlist(cp_list, c);
17600                             }
17601                             else {
17602                                 /* Similarly folds involving non-ascii Latin1
17603                                 * characters under /d are added to their list */
17604                                 has_upper_latin1_only_utf8_matches
17605                                         = add_cp_to_invlist(
17606                                            has_upper_latin1_only_utf8_matches,
17607                                            c);
17608                             }
17609                         }
17610                     }
17611                 }
17612             }
17613             SvREFCNT_dec_NN(fold_intersection);
17614         }
17615
17616         /* Now that we have finished adding all the folds, there is no reason
17617          * to keep the foldable list separate */
17618         _invlist_union(cp_list, cp_foldable_list, &cp_list);
17619         SvREFCNT_dec_NN(cp_foldable_list);
17620     }
17621
17622     /* And combine the result (if any) with any inversion lists from posix
17623      * classes.  The lists are kept separate up to now because we don't want to
17624      * fold the classes (folding of those is automatically handled by the swash
17625      * fetching code) */
17626     if (simple_posixes) {   /* These are the classes known to be unaffected by
17627                                /a, /aa, and /d */
17628         if (cp_list) {
17629             _invlist_union(cp_list, simple_posixes, &cp_list);
17630             SvREFCNT_dec_NN(simple_posixes);
17631         }
17632         else {
17633             cp_list = simple_posixes;
17634         }
17635     }
17636     if (posixes || nposixes) {
17637
17638         /* We have to adjust /a and /aa */
17639         if (AT_LEAST_ASCII_RESTRICTED) {
17640
17641             /* Under /a and /aa, nothing above ASCII matches these */
17642             if (posixes) {
17643                 _invlist_intersection(posixes,
17644                                     PL_XPosix_ptrs[_CC_ASCII],
17645                                     &posixes);
17646             }
17647
17648             /* Under /a and /aa, everything above ASCII matches these
17649              * complements */
17650             if (nposixes) {
17651                 _invlist_union_complement_2nd(nposixes,
17652                                               PL_XPosix_ptrs[_CC_ASCII],
17653                                               &nposixes);
17654             }
17655         }
17656
17657         if (! DEPENDS_SEMANTICS) {
17658
17659             /* For everything but /d, we can just add the current 'posixes' and
17660              * 'nposixes' to the main list */
17661             if (posixes) {
17662                 if (cp_list) {
17663                     _invlist_union(cp_list, posixes, &cp_list);
17664                     SvREFCNT_dec_NN(posixes);
17665                 }
17666                 else {
17667                     cp_list = posixes;
17668                 }
17669             }
17670             if (nposixes) {
17671                 if (cp_list) {
17672                     _invlist_union(cp_list, nposixes, &cp_list);
17673                     SvREFCNT_dec_NN(nposixes);
17674                 }
17675                 else {
17676                     cp_list = nposixes;
17677                 }
17678             }
17679         }
17680         else {
17681             /* Under /d, things like \w match upper Latin1 characters only if
17682              * the target string is in UTF-8.  But things like \W match all the
17683              * upper Latin1 characters if the target string is not in UTF-8.
17684              *
17685              * Handle the case where there something like \W separately */
17686             if (nposixes) {
17687                 SV* only_non_utf8_list = invlist_clone(PL_UpperLatin1);
17688
17689                 /* A complemented posix class matches all upper Latin1
17690                  * characters if not in UTF-8.  And it matches just certain
17691                  * ones when in UTF-8.  That means those certain ones are
17692                  * matched regardless, so can just be added to the
17693                  * unconditional list */
17694                 if (cp_list) {
17695                     _invlist_union(cp_list, nposixes, &cp_list);
17696                     SvREFCNT_dec_NN(nposixes);
17697                     nposixes = NULL;
17698                 }
17699                 else {
17700                     cp_list = nposixes;
17701                 }
17702
17703                 /* Likewise for 'posixes' */
17704                 _invlist_union(posixes, cp_list, &cp_list);
17705
17706                 /* Likewise for anything else in the range that matched only
17707                  * under UTF-8 */
17708                 if (has_upper_latin1_only_utf8_matches) {
17709                     _invlist_union(cp_list,
17710                                    has_upper_latin1_only_utf8_matches,
17711                                    &cp_list);
17712                     SvREFCNT_dec_NN(has_upper_latin1_only_utf8_matches);
17713                     has_upper_latin1_only_utf8_matches = NULL;
17714                 }
17715
17716                 /* If we don't match all the upper Latin1 characters regardless
17717                  * of UTF-8ness, we have to set a flag to match the rest when
17718                  * not in UTF-8 */
17719                 _invlist_subtract(only_non_utf8_list, cp_list,
17720                                   &only_non_utf8_list);
17721                 if (_invlist_len(only_non_utf8_list) != 0) {
17722                     ANYOF_FLAGS(ret) |= ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER;
17723                 }
17724                 SvREFCNT_dec_NN(only_non_utf8_list);
17725             }
17726             else {
17727                 /* Here there were no complemented posix classes.  That means
17728                  * the upper Latin1 characters in 'posixes' match only when the
17729                  * target string is in UTF-8.  So we have to add them to the
17730                  * list of those types of code points, while adding the
17731                  * remainder to the unconditional list.
17732                  *
17733                  * First calculate what they are */
17734                 SV* nonascii_but_latin1_properties = NULL;
17735                 _invlist_intersection(posixes, PL_UpperLatin1,
17736                                       &nonascii_but_latin1_properties);
17737
17738                 /* And add them to the final list of such characters. */
17739                 _invlist_union(has_upper_latin1_only_utf8_matches,
17740                                nonascii_but_latin1_properties,
17741                                &has_upper_latin1_only_utf8_matches);
17742
17743                 /* Remove them from what now becomes the unconditional list */
17744                 _invlist_subtract(posixes, nonascii_but_latin1_properties,
17745                                   &posixes);
17746
17747                 /* And add those unconditional ones to the final list */
17748                 if (cp_list) {
17749                     _invlist_union(cp_list, posixes, &cp_list);
17750                     SvREFCNT_dec_NN(posixes);
17751                     posixes = NULL;
17752                 }
17753                 else {
17754                     cp_list = posixes;
17755                 }
17756
17757                 SvREFCNT_dec(nonascii_but_latin1_properties);
17758
17759                 /* Get rid of any characters that we now know are matched
17760                  * unconditionally from the conditional list, which may make
17761                  * that list empty */
17762                 _invlist_subtract(has_upper_latin1_only_utf8_matches,
17763                                   cp_list,
17764                                   &has_upper_latin1_only_utf8_matches);
17765                 if (_invlist_len(has_upper_latin1_only_utf8_matches) == 0) {
17766                     SvREFCNT_dec_NN(has_upper_latin1_only_utf8_matches);
17767                     has_upper_latin1_only_utf8_matches = NULL;
17768                 }
17769             }
17770         }
17771     }
17772
17773     /* And combine the result (if any) with any inversion list from properties.
17774      * The lists are kept separate up to now so that we can distinguish the two
17775      * in regards to matching above-Unicode.  A run-time warning is generated
17776      * if a Unicode property is matched against a non-Unicode code point. But,
17777      * we allow user-defined properties to match anything, without any warning,
17778      * and we also suppress the warning if there is a portion of the character
17779      * class that isn't a Unicode property, and which matches above Unicode, \W
17780      * or [\x{110000}] for example.
17781      * (Note that in this case, unlike the Posix one above, there is no
17782      * <has_upper_latin1_only_utf8_matches>, because having a Unicode property
17783      * forces Unicode semantics */
17784     if (properties) {
17785         if (cp_list) {
17786
17787             /* If it matters to the final outcome, see if a non-property
17788              * component of the class matches above Unicode.  If so, the
17789              * warning gets suppressed.  This is true even if just a single
17790              * such code point is specified, as, though not strictly correct if
17791              * another such code point is matched against, the fact that they
17792              * are using above-Unicode code points indicates they should know
17793              * the issues involved */
17794             if (warn_super) {
17795                 warn_super = ! (invert
17796                                ^ (invlist_highest(cp_list) > PERL_UNICODE_MAX));
17797             }
17798
17799             _invlist_union(properties, cp_list, &cp_list);
17800             SvREFCNT_dec_NN(properties);
17801         }
17802         else {
17803             cp_list = properties;
17804         }
17805
17806         if (warn_super) {
17807             ANYOF_FLAGS(ret)
17808              |= ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER;
17809
17810             /* Because an ANYOF node is the only one that warns, this node
17811              * can't be optimized into something else */
17812             optimizable = FALSE;
17813         }
17814     }
17815
17816     /* Here, we have calculated what code points should be in the character
17817      * class.
17818      *
17819      * Now we can see about various optimizations.  Fold calculation (which we
17820      * did above) needs to take place before inversion.  Otherwise /[^k]/i
17821      * would invert to include K, which under /i would match k, which it
17822      * shouldn't.  Therefore we can't invert folded locale now, as it won't be
17823      * folded until runtime */
17824
17825     /* If we didn't do folding, it's because some information isn't available
17826      * until runtime; set the run-time fold flag for these.  (We don't have to
17827      * worry about properties folding, as that is taken care of by the swash
17828      * fetching).  We know to set the flag if we have a non-NULL list for UTF-8
17829      * locales, or the class matches at least one 0-255 range code point */
17830     if (LOC && FOLD) {
17831
17832         /* Some things on the list might be unconditionally included because of
17833          * other components.  Remove them, and clean up the list if it goes to
17834          * 0 elements */
17835         if (only_utf8_locale_list && cp_list) {
17836             _invlist_subtract(only_utf8_locale_list, cp_list,
17837                               &only_utf8_locale_list);
17838
17839             if (_invlist_len(only_utf8_locale_list) == 0) {
17840                 SvREFCNT_dec_NN(only_utf8_locale_list);
17841                 only_utf8_locale_list = NULL;
17842             }
17843         }
17844         if (only_utf8_locale_list) {
17845             ANYOF_FLAGS(ret)
17846                  |=  ANYOFL_FOLD
17847                     |ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD;
17848         }
17849         else if (cp_list) { /* Look to see if a 0-255 code point is in list */
17850             UV start, end;
17851             invlist_iterinit(cp_list);
17852             if (invlist_iternext(cp_list, &start, &end) && start < 256) {
17853                 ANYOF_FLAGS(ret) |= ANYOFL_FOLD;
17854             }
17855             invlist_iterfinish(cp_list);
17856         }
17857     }
17858     else if (   DEPENDS_SEMANTICS
17859              && (    has_upper_latin1_only_utf8_matches
17860                  || (ANYOF_FLAGS(ret) & ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER)))
17861     {
17862         OP(ret) = ANYOFD;
17863         optimizable = FALSE;
17864     }
17865
17866
17867     /* Optimize inverted simple patterns (e.g. [^a-z]) when everything is known
17868      * at compile time.  Besides not inverting folded locale now, we can't
17869      * invert if there are things such as \w, which aren't known until runtime
17870      * */
17871     if (cp_list
17872         && invert
17873         && OP(ret) != ANYOFD
17874         && ! (ANYOF_FLAGS(ret) & (ANYOF_LOCALE_FLAGS))
17875         && ! HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
17876     {
17877         _invlist_invert(cp_list);
17878
17879         /* Any swash can't be used as-is, because we've inverted things */
17880         if (swash) {
17881             SvREFCNT_dec_NN(swash);
17882             swash = NULL;
17883         }
17884
17885         /* Clear the invert flag since have just done it here */
17886         invert = FALSE;
17887     }
17888
17889     if (ret_invlist) {
17890         assert(cp_list);
17891
17892         *ret_invlist = cp_list;
17893         SvREFCNT_dec(swash);
17894
17895         /* Discard the generated node */
17896         if (SIZE_ONLY) {
17897             RExC_size = orig_size;
17898         }
17899         else {
17900             RExC_emit = orig_emit;
17901         }
17902         return orig_emit;
17903     }
17904
17905     /* Some character classes are equivalent to other nodes.  Such nodes take
17906      * up less room and generally fewer operations to execute than ANYOF nodes.
17907      * Above, we checked for and optimized into some such equivalents for
17908      * certain common classes that are easy to test.  Getting to this point in
17909      * the code means that the class didn't get optimized there.  Since this
17910      * code is only executed in Pass 2, it is too late to save space--it has
17911      * been allocated in Pass 1, and currently isn't given back.  But turning
17912      * things into an EXACTish node can allow the optimizer to join it to any
17913      * adjacent such nodes.  And if the class is equivalent to things like /./,
17914      * expensive run-time swashes can be avoided.  Now that we have more
17915      * complete information, we can find things necessarily missed by the
17916      * earlier code.  Another possible "optimization" that isn't done is that
17917      * something like [Ee] could be changed into an EXACTFU.  khw tried this
17918      * and found that the ANYOF is faster, including for code points not in the
17919      * bitmap.  This still might make sense to do, provided it got joined with
17920      * an adjacent node(s) to create a longer EXACTFU one.  This could be
17921      * accomplished by creating a pseudo ANYOF_EXACTFU node type that the join
17922      * routine would know is joinable.  If that didn't happen, the node type
17923      * could then be made a straight ANYOF */
17924
17925     if (optimizable && cp_list && ! invert) {
17926         UV start, end;
17927         U8 op = END;  /* The optimzation node-type */
17928         int posix_class = -1;   /* Illegal value */
17929         const char * cur_parse= RExC_parse;
17930
17931         invlist_iterinit(cp_list);
17932         if (! invlist_iternext(cp_list, &start, &end)) {
17933
17934             /* Here, the list is empty.  This happens, for example, when a
17935              * Unicode property that doesn't match anything is the only element
17936              * in the character class (perluniprops.pod notes such properties).
17937              * */
17938             op = OPFAIL;
17939             *flagp |= HASWIDTH|SIMPLE;
17940         }
17941         else if (start == end) {    /* The range is a single code point */
17942             if (! invlist_iternext(cp_list, &start, &end)
17943
17944                     /* Don't do this optimization if it would require changing
17945                      * the pattern to UTF-8 */
17946                 && (start < 256 || UTF))
17947             {
17948                 /* Here, the list contains a single code point.  Can optimize
17949                  * into an EXACTish node */
17950
17951                 value = start;
17952
17953                 if (! FOLD) {
17954                     op = (LOC)
17955                          ? EXACTL
17956                          : EXACT;
17957                 }
17958                 else if (LOC) {
17959
17960                     /* A locale node under folding with one code point can be
17961                      * an EXACTFL, as its fold won't be calculated until
17962                      * runtime */
17963                     op = EXACTFL;
17964                 }
17965                 else {
17966
17967                     /* Here, we are generally folding, but there is only one
17968                      * code point to match.  If we have to, we use an EXACT
17969                      * node, but it would be better for joining with adjacent
17970                      * nodes in the optimization pass if we used the same
17971                      * EXACTFish node that any such are likely to be.  We can
17972                      * do this iff the code point doesn't participate in any
17973                      * folds.  For example, an EXACTF of a colon is the same as
17974                      * an EXACT one, since nothing folds to or from a colon. */
17975                     if (value < 256) {
17976                         if (IS_IN_SOME_FOLD_L1(value)) {
17977                             op = EXACT;
17978                         }
17979                     }
17980                     else {
17981                         if (_invlist_contains_cp(PL_utf8_foldable, value)) {
17982                             op = EXACT;
17983                         }
17984                     }
17985
17986                     /* If we haven't found the node type, above, it means we
17987                      * can use the prevailing one */
17988                     if (op == END) {
17989                         op = compute_EXACTish(pRExC_state);
17990                     }
17991                 }
17992             }
17993         }   /* End of first range contains just a single code point */
17994         else if (start == 0) {
17995             if (end == UV_MAX) {
17996                 op = SANY;
17997                 *flagp |= HASWIDTH|SIMPLE;
17998                 MARK_NAUGHTY(1);
17999             }
18000             else if (end == '\n' - 1
18001                     && invlist_iternext(cp_list, &start, &end)
18002                     && start == '\n' + 1 && end == UV_MAX)
18003             {
18004                 op = REG_ANY;
18005                 *flagp |= HASWIDTH|SIMPLE;
18006                 MARK_NAUGHTY(1);
18007             }
18008         }
18009         invlist_iterfinish(cp_list);
18010
18011         if (op == END) {
18012             const UV cp_list_len = _invlist_len(cp_list);
18013             const UV* cp_list_array = invlist_array(cp_list);
18014
18015             /* Here, didn't find an optimization.  See if this matches any of
18016              * the POSIX classes.  These run slightly faster for above-Unicode
18017              * code points, so don't bother with POSIXA ones nor the 2 that
18018              * have no above-Unicode matches.  We can avoid these checks unless
18019              * the ANYOF matches at least as high as the lowest POSIX one
18020              * (which was manually found to be \v.  The actual code point may
18021              * increase in later Unicode releases, if a higher code point is
18022              * assigned to be \v, but this code will never break.  It would
18023              * just mean we could execute the checks for posix optimizations
18024              * unnecessarily) */
18025
18026             if (cp_list_array[cp_list_len-1] > 0x2029) {
18027                 for (posix_class = 0;
18028                      posix_class <= _HIGHEST_REGCOMP_DOT_H_SYNC;
18029                      posix_class++)
18030                 {
18031                     int try_inverted;
18032                     if (posix_class == _CC_ASCII || posix_class == _CC_CNTRL) {
18033                         continue;
18034                     }
18035                     for (try_inverted = 0; try_inverted < 2; try_inverted++) {
18036
18037                         /* Check if matches normal or inverted */
18038                         if (_invlistEQ(cp_list,
18039                                        PL_XPosix_ptrs[posix_class],
18040                                        try_inverted))
18041                         {
18042                             op = (try_inverted)
18043                                  ? NPOSIXU
18044                                  : POSIXU;
18045                             *flagp |= HASWIDTH|SIMPLE;
18046                             goto found_posix;
18047                         }
18048                     }
18049                 }
18050               found_posix: ;
18051             }
18052         }
18053
18054         if (op != END) {
18055             RExC_parse = (char *)orig_parse;
18056             RExC_emit = (regnode *)orig_emit;
18057
18058             if (regarglen[op]) {
18059                 ret = reganode(pRExC_state, op, 0);
18060             } else {
18061                 ret = reg_node(pRExC_state, op);
18062             }
18063
18064             RExC_parse = (char *)cur_parse;
18065
18066             if (PL_regkind[op] == EXACT) {
18067                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, 0, value,
18068                                            TRUE /* downgradable to EXACT */
18069                                           );
18070             }
18071             else if (PL_regkind[op] == POSIXD || PL_regkind[op] == NPOSIXD) {
18072                 FLAGS(ret) = posix_class;
18073             }
18074
18075             SvREFCNT_dec_NN(cp_list);
18076             return ret;
18077         }
18078     }
18079
18080     /* Here, <cp_list> contains all the code points we can determine at
18081      * compile time that match under all conditions.  Go through it, and
18082      * for things that belong in the bitmap, put them there, and delete from
18083      * <cp_list>.  While we are at it, see if everything above 255 is in the
18084      * list, and if so, set a flag to speed up execution */
18085
18086     populate_ANYOF_from_invlist(ret, &cp_list);
18087
18088     if (invert) {
18089         ANYOF_FLAGS(ret) |= ANYOF_INVERT;
18090     }
18091
18092     /* Here, the bitmap has been populated with all the Latin1 code points that
18093      * always match.  Can now add to the overall list those that match only
18094      * when the target string is UTF-8 (<has_upper_latin1_only_utf8_matches>).
18095      * */
18096     if (has_upper_latin1_only_utf8_matches) {
18097         if (cp_list) {
18098             _invlist_union(cp_list,
18099                            has_upper_latin1_only_utf8_matches,
18100                            &cp_list);
18101             SvREFCNT_dec_NN(has_upper_latin1_only_utf8_matches);
18102         }
18103         else {
18104             cp_list = has_upper_latin1_only_utf8_matches;
18105         }
18106         ANYOF_FLAGS(ret) |= ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP;
18107     }
18108
18109     /* If there is a swash and more than one element, we can't use the swash in
18110      * the optimization below. */
18111     if (swash && element_count > 1) {
18112         SvREFCNT_dec_NN(swash);
18113         swash = NULL;
18114     }
18115
18116     /* Note that the optimization of using 'swash' if it is the only thing in
18117      * the class doesn't have us change swash at all, so it can include things
18118      * that are also in the bitmap; otherwise we have purposely deleted that
18119      * duplicate information */
18120     set_ANYOF_arg(pRExC_state, ret, cp_list,
18121                   (HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
18122                    ? listsv : NULL,
18123                   only_utf8_locale_list,
18124                   swash, has_user_defined_property);
18125
18126     *flagp |= HASWIDTH|SIMPLE;
18127
18128     if (ANYOF_FLAGS(ret) & ANYOF_LOCALE_FLAGS) {
18129         RExC_contains_locale = 1;
18130     }
18131
18132     return ret;
18133 }
18134
18135 #undef HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION
18136
18137 STATIC void
18138 S_set_ANYOF_arg(pTHX_ RExC_state_t* const pRExC_state,
18139                 regnode* const node,
18140                 SV* const cp_list,
18141                 SV* const runtime_defns,
18142                 SV* const only_utf8_locale_list,
18143                 SV* const swash,
18144                 const bool has_user_defined_property)
18145 {
18146     /* Sets the arg field of an ANYOF-type node 'node', using information about
18147      * the node passed-in.  If there is nothing outside the node's bitmap, the
18148      * arg is set to ANYOF_ONLY_HAS_BITMAP.  Otherwise, it sets the argument to
18149      * the count returned by add_data(), having allocated and stored an array,
18150      * av, that that count references, as follows:
18151      *  av[0] stores the character class description in its textual form.
18152      *        This is used later (regexec.c:Perl_regclass_swash()) to
18153      *        initialize the appropriate swash, and is also useful for dumping
18154      *        the regnode.  This is set to &PL_sv_undef if the textual
18155      *        description is not needed at run-time (as happens if the other
18156      *        elements completely define the class)
18157      *  av[1] if &PL_sv_undef, is a placeholder to later contain the swash
18158      *        computed from av[0].  But if no further computation need be done,
18159      *        the swash is stored here now (and av[0] is &PL_sv_undef).
18160      *  av[2] stores the inversion list of code points that match only if the
18161      *        current locale is UTF-8
18162      *  av[3] stores the cp_list inversion list for use in addition or instead
18163      *        of av[0]; used only if cp_list exists and av[1] is &PL_sv_undef.
18164      *        (Otherwise everything needed is already in av[0] and av[1])
18165      *  av[4] is set if any component of the class is from a user-defined
18166      *        property; used only if av[3] exists */
18167
18168     UV n;
18169
18170     PERL_ARGS_ASSERT_SET_ANYOF_ARG;
18171
18172     if (! cp_list && ! runtime_defns && ! only_utf8_locale_list) {
18173         assert(! (ANYOF_FLAGS(node)
18174                 & ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP));
18175         ARG_SET(node, ANYOF_ONLY_HAS_BITMAP);
18176     }
18177     else {
18178         AV * const av = newAV();
18179         SV *rv;
18180
18181         av_store(av, 0, (runtime_defns)
18182                         ? SvREFCNT_inc(runtime_defns) : &PL_sv_undef);
18183         if (swash) {
18184             assert(cp_list);
18185             av_store(av, 1, swash);
18186             SvREFCNT_dec_NN(cp_list);
18187         }
18188         else {
18189             av_store(av, 1, &PL_sv_undef);
18190             if (cp_list) {
18191                 av_store(av, 3, cp_list);
18192                 av_store(av, 4, newSVuv(has_user_defined_property));
18193             }
18194         }
18195
18196         if (only_utf8_locale_list) {
18197             av_store(av, 2, only_utf8_locale_list);
18198         }
18199         else {
18200             av_store(av, 2, &PL_sv_undef);
18201         }
18202
18203         rv = newRV_noinc(MUTABLE_SV(av));
18204         n = add_data(pRExC_state, STR_WITH_LEN("s"));
18205         RExC_rxi->data->data[n] = (void*)rv;
18206         ARG_SET(node, n);
18207     }
18208 }
18209
18210 #if !defined(PERL_IN_XSUB_RE) || defined(PLUGGABLE_RE_EXTENSION)
18211 SV *
18212 Perl__get_regclass_nonbitmap_data(pTHX_ const regexp *prog,
18213                                         const regnode* node,
18214                                         bool doinit,
18215                                         SV** listsvp,
18216                                         SV** only_utf8_locale_ptr,
18217                                         SV** output_invlist)
18218
18219 {
18220     /* For internal core use only.
18221      * Returns the swash for the input 'node' in the regex 'prog'.
18222      * If <doinit> is 'true', will attempt to create the swash if not already
18223      *    done.
18224      * If <listsvp> is non-null, will return the printable contents of the
18225      *    swash.  This can be used to get debugging information even before the
18226      *    swash exists, by calling this function with 'doinit' set to false, in
18227      *    which case the components that will be used to eventually create the
18228      *    swash are returned  (in a printable form).
18229      * If <only_utf8_locale_ptr> is not NULL, it is where this routine is to
18230      *    store an inversion list of code points that should match only if the
18231      *    execution-time locale is a UTF-8 one.
18232      * If <output_invlist> is not NULL, it is where this routine is to store an
18233      *    inversion list of the code points that would be instead returned in
18234      *    <listsvp> if this were NULL.  Thus, what gets output in <listsvp>
18235      *    when this parameter is used, is just the non-code point data that
18236      *    will go into creating the swash.  This currently should be just
18237      *    user-defined properties whose definitions were not known at compile
18238      *    time.  Using this parameter allows for easier manipulation of the
18239      *    swash's data by the caller.  It is illegal to call this function with
18240      *    this parameter set, but not <listsvp>
18241      *
18242      * Tied intimately to how S_set_ANYOF_arg sets up the data structure.  Note
18243      * that, in spite of this function's name, the swash it returns may include
18244      * the bitmap data as well */
18245
18246     SV *sw  = NULL;
18247     SV *si  = NULL;         /* Input swash initialization string */
18248     SV* invlist = NULL;
18249
18250     RXi_GET_DECL(prog,progi);
18251     const struct reg_data * const data = prog ? progi->data : NULL;
18252
18253     PERL_ARGS_ASSERT__GET_REGCLASS_NONBITMAP_DATA;
18254     assert(! output_invlist || listsvp);
18255
18256     if (data && data->count) {
18257         const U32 n = ARG(node);
18258
18259         if (data->what[n] == 's') {
18260             SV * const rv = MUTABLE_SV(data->data[n]);
18261             AV * const av = MUTABLE_AV(SvRV(rv));
18262             SV **const ary = AvARRAY(av);
18263             U8 swash_init_flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;
18264
18265             si = *ary;  /* ary[0] = the string to initialize the swash with */
18266
18267             if (av_tindex_skip_len_mg(av) >= 2) {
18268                 if (only_utf8_locale_ptr
18269                     && ary[2]
18270                     && ary[2] != &PL_sv_undef)
18271                 {
18272                     *only_utf8_locale_ptr = ary[2];
18273                 }
18274                 else {
18275                     assert(only_utf8_locale_ptr);
18276                     *only_utf8_locale_ptr = NULL;
18277                 }
18278
18279                 /* Elements 3 and 4 are either both present or both absent. [3]
18280                  * is any inversion list generated at compile time; [4]
18281                  * indicates if that inversion list has any user-defined
18282                  * properties in it. */
18283                 if (av_tindex_skip_len_mg(av) >= 3) {
18284                     invlist = ary[3];
18285                     if (SvUV(ary[4])) {
18286                         swash_init_flags |= _CORE_SWASH_INIT_USER_DEFINED_PROPERTY;
18287                     }
18288                 }
18289                 else {
18290                     invlist = NULL;
18291                 }
18292             }
18293
18294             /* Element [1] is reserved for the set-up swash.  If already there,
18295              * return it; if not, create it and store it there */
18296             if (ary[1] && SvROK(ary[1])) {
18297                 sw = ary[1];
18298             }
18299             else if (doinit && ((si && si != &PL_sv_undef)
18300                                  || (invlist && invlist != &PL_sv_undef))) {
18301                 assert(si);
18302                 sw = _core_swash_init("utf8", /* the utf8 package */
18303                                       "", /* nameless */
18304                                       si,
18305                                       1, /* binary */
18306                                       0, /* not from tr/// */
18307                                       invlist,
18308                                       &swash_init_flags);
18309                 (void)av_store(av, 1, sw);
18310             }
18311         }
18312     }
18313
18314     /* If requested, return a printable version of what this swash matches */
18315     if (listsvp) {
18316         SV* matches_string = NULL;
18317
18318         /* The swash should be used, if possible, to get the data, as it
18319          * contains the resolved data.  But this function can be called at
18320          * compile-time, before everything gets resolved, in which case we
18321          * return the currently best available information, which is the string
18322          * that will eventually be used to do that resolving, 'si' */
18323         if ((! sw || (invlist = _get_swash_invlist(sw)) == NULL)
18324             && (si && si != &PL_sv_undef))
18325         {
18326             /* Here, we only have 'si' (and possibly some passed-in data in
18327              * 'invlist', which is handled below)  If the caller only wants
18328              * 'si', use that.  */
18329             if (! output_invlist) {
18330                 matches_string = newSVsv(si);
18331             }
18332             else {
18333                 /* But if the caller wants an inversion list of the node, we
18334                  * need to parse 'si' and place as much as possible in the
18335                  * desired output inversion list, making 'matches_string' only
18336                  * contain the currently unresolvable things */
18337                 const char *si_string = SvPVX(si);
18338                 STRLEN remaining = SvCUR(si);
18339                 UV prev_cp = 0;
18340                 U8 count = 0;
18341
18342                 /* Ignore everything before the first new-line */
18343                 while (*si_string != '\n' && remaining > 0) {
18344                     si_string++;
18345                     remaining--;
18346                 }
18347                 assert(remaining > 0);
18348
18349                 si_string++;
18350                 remaining--;
18351
18352                 while (remaining > 0) {
18353
18354                     /* The data consists of just strings defining user-defined
18355                      * property names, but in prior incarnations, and perhaps
18356                      * somehow from pluggable regex engines, it could still
18357                      * hold hex code point definitions.  Each component of a
18358                      * range would be separated by a tab, and each range by a
18359                      * new-line.  If these are found, instead add them to the
18360                      * inversion list */
18361                     I32 grok_flags =  PERL_SCAN_SILENT_ILLDIGIT
18362                                      |PERL_SCAN_SILENT_NON_PORTABLE;
18363                     STRLEN len = remaining;
18364                     UV cp = grok_hex(si_string, &len, &grok_flags, NULL);
18365
18366                     /* If the hex decode routine found something, it should go
18367                      * up to the next \n */
18368                     if (   *(si_string + len) == '\n') {
18369                         if (count) {    /* 2nd code point on line */
18370                             *output_invlist = _add_range_to_invlist(*output_invlist, prev_cp, cp);
18371                         }
18372                         else {
18373                             *output_invlist = add_cp_to_invlist(*output_invlist, cp);
18374                         }
18375                         count = 0;
18376                         goto prepare_for_next_iteration;
18377                     }
18378
18379                     /* If the hex decode was instead for the lower range limit,
18380                      * save it, and go parse the upper range limit */
18381                     if (*(si_string + len) == '\t') {
18382                         assert(count == 0);
18383
18384                         prev_cp = cp;
18385                         count = 1;
18386                       prepare_for_next_iteration:
18387                         si_string += len + 1;
18388                         remaining -= len + 1;
18389                         continue;
18390                     }
18391
18392                     /* Here, didn't find a legal hex number.  Just add it from
18393                      * here to the next \n */
18394
18395                     remaining -= len;
18396                     while (*(si_string + len) != '\n' && remaining > 0) {
18397                         remaining--;
18398                         len++;
18399                     }
18400                     if (*(si_string + len) == '\n') {
18401                         len++;
18402                         remaining--;
18403                     }
18404                     if (matches_string) {
18405                         sv_catpvn(matches_string, si_string, len - 1);
18406                     }
18407                     else {
18408                         matches_string = newSVpvn(si_string, len - 1);
18409                     }
18410                     si_string += len;
18411                     sv_catpvs(matches_string, " ");
18412                 } /* end of loop through the text */
18413
18414                 assert(matches_string);
18415                 if (SvCUR(matches_string)) {  /* Get rid of trailing blank */
18416                     SvCUR_set(matches_string, SvCUR(matches_string) - 1);
18417                 }
18418             } /* end of has an 'si' but no swash */
18419         }
18420
18421         /* If we have a swash in place, its equivalent inversion list was above
18422          * placed into 'invlist'.  If not, this variable may contain a stored
18423          * inversion list which is information beyond what is in 'si' */
18424         if (invlist) {
18425
18426             /* Again, if the caller doesn't want the output inversion list, put
18427              * everything in 'matches-string' */
18428             if (! output_invlist) {
18429                 if ( ! matches_string) {
18430                     matches_string = newSVpvs("\n");
18431                 }
18432                 sv_catsv(matches_string, invlist_contents(invlist,
18433                                                   TRUE /* traditional style */
18434                                                   ));
18435             }
18436             else if (! *output_invlist) {
18437                 *output_invlist = invlist_clone(invlist);
18438             }
18439             else {
18440                 _invlist_union(*output_invlist, invlist, output_invlist);
18441             }
18442         }
18443
18444         *listsvp = matches_string;
18445     }
18446
18447     return sw;
18448 }
18449 #endif /* !defined(PERL_IN_XSUB_RE) || defined(PLUGGABLE_RE_EXTENSION) */
18450
18451 /* reg_skipcomment()
18452
18453    Absorbs an /x style # comment from the input stream,
18454    returning a pointer to the first character beyond the comment, or if the
18455    comment terminates the pattern without anything following it, this returns
18456    one past the final character of the pattern (in other words, RExC_end) and
18457    sets the REG_RUN_ON_COMMENT_SEEN flag.
18458
18459    Note it's the callers responsibility to ensure that we are
18460    actually in /x mode
18461
18462 */
18463
18464 PERL_STATIC_INLINE char*
18465 S_reg_skipcomment(RExC_state_t *pRExC_state, char* p)
18466 {
18467     PERL_ARGS_ASSERT_REG_SKIPCOMMENT;
18468
18469     assert(*p == '#');
18470
18471     while (p < RExC_end) {
18472         if (*(++p) == '\n') {
18473             return p+1;
18474         }
18475     }
18476
18477     /* we ran off the end of the pattern without ending the comment, so we have
18478      * to add an \n when wrapping */
18479     RExC_seen |= REG_RUN_ON_COMMENT_SEEN;
18480     return p;
18481 }
18482
18483 STATIC void
18484 S_skip_to_be_ignored_text(pTHX_ RExC_state_t *pRExC_state,
18485                                 char ** p,
18486                                 const bool force_to_xmod
18487                          )
18488 {
18489     /* If the text at the current parse position '*p' is a '(?#...)' comment,
18490      * or if we are under /x or 'force_to_xmod' is TRUE, and the text at '*p'
18491      * is /x whitespace, advance '*p' so that on exit it points to the first
18492      * byte past all such white space and comments */
18493
18494     const bool use_xmod = force_to_xmod || (RExC_flags & RXf_PMf_EXTENDED);
18495
18496     PERL_ARGS_ASSERT_SKIP_TO_BE_IGNORED_TEXT;
18497
18498     assert( ! UTF || UTF8_IS_INVARIANT(**p) || UTF8_IS_START(**p));
18499
18500     for (;;) {
18501         if (RExC_end - (*p) >= 3
18502             && *(*p)     == '('
18503             && *(*p + 1) == '?'
18504             && *(*p + 2) == '#')
18505         {
18506             while (*(*p) != ')') {
18507                 if ((*p) == RExC_end)
18508                     FAIL("Sequence (?#... not terminated");
18509                 (*p)++;
18510             }
18511             (*p)++;
18512             continue;
18513         }
18514
18515         if (use_xmod) {
18516             const char * save_p = *p;
18517             while ((*p) < RExC_end) {
18518                 STRLEN len;
18519                 if ((len = is_PATWS_safe((*p), RExC_end, UTF))) {
18520                     (*p) += len;
18521                 }
18522                 else if (*(*p) == '#') {
18523                     (*p) = reg_skipcomment(pRExC_state, (*p));
18524                 }
18525                 else {
18526                     break;
18527                 }
18528             }
18529             if (*p != save_p) {
18530                 continue;
18531             }
18532         }
18533
18534         break;
18535     }
18536
18537     return;
18538 }
18539
18540 /* nextchar()
18541
18542    Advances the parse position by one byte, unless that byte is the beginning
18543    of a '(?#...)' style comment, or is /x whitespace and /x is in effect.  In
18544    those two cases, the parse position is advanced beyond all such comments and
18545    white space.
18546
18547    This is the UTF, (?#...), and /x friendly way of saying RExC_parse++.
18548 */
18549
18550 STATIC void
18551 S_nextchar(pTHX_ RExC_state_t *pRExC_state)
18552 {
18553     PERL_ARGS_ASSERT_NEXTCHAR;
18554
18555     if (RExC_parse < RExC_end) {
18556         assert(   ! UTF
18557                || UTF8_IS_INVARIANT(*RExC_parse)
18558                || UTF8_IS_START(*RExC_parse));
18559
18560         RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
18561
18562         skip_to_be_ignored_text(pRExC_state, &RExC_parse,
18563                                 FALSE /* Don't force /x */ );
18564     }
18565 }
18566
18567 STATIC regnode *
18568 S_regnode_guts(pTHX_ RExC_state_t *pRExC_state, const U8 op, const STRLEN extra_size, const char* const name)
18569 {
18570     /* Allocate a regnode for 'op' and returns it, with 'extra_size' extra
18571      * space.  In pass1, it aligns and increments RExC_size; in pass2,
18572      * RExC_emit */
18573
18574     regnode * const ret = RExC_emit;
18575     GET_RE_DEBUG_FLAGS_DECL;
18576
18577     PERL_ARGS_ASSERT_REGNODE_GUTS;
18578
18579     assert(extra_size >= regarglen[op]);
18580
18581     if (SIZE_ONLY) {
18582         SIZE_ALIGN(RExC_size);
18583         RExC_size += 1 + extra_size;
18584         return(ret);
18585     }
18586     if (RExC_emit >= RExC_emit_bound)
18587         Perl_croak(aTHX_ "panic: reg_node overrun trying to emit %d, %p>=%p",
18588                    op, (void*)RExC_emit, (void*)RExC_emit_bound);
18589
18590     NODE_ALIGN_FILL(ret);
18591 #ifndef RE_TRACK_PATTERN_OFFSETS
18592     PERL_UNUSED_ARG(name);
18593 #else
18594     if (RExC_offsets) {         /* MJD */
18595         MJD_OFFSET_DEBUG(
18596               ("%s:%d: (op %s) %s %" UVuf " (len %" UVuf ") (max %" UVuf ").\n",
18597               name, __LINE__,
18598               PL_reg_name[op],
18599               (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0]
18600                 ? "Overwriting end of array!\n" : "OK",
18601               (UV)(RExC_emit - RExC_emit_start),
18602               (UV)(RExC_parse - RExC_start),
18603               (UV)RExC_offsets[0]));
18604         Set_Node_Offset(RExC_emit, RExC_parse + (op == END));
18605     }
18606 #endif
18607     return(ret);
18608 }
18609
18610 /*
18611 - reg_node - emit a node
18612 */
18613 STATIC regnode *                        /* Location. */
18614 S_reg_node(pTHX_ RExC_state_t *pRExC_state, U8 op)
18615 {
18616     regnode * const ret = regnode_guts(pRExC_state, op, regarglen[op], "reg_node");
18617
18618     PERL_ARGS_ASSERT_REG_NODE;
18619
18620     assert(regarglen[op] == 0);
18621
18622     if (PASS2) {
18623         regnode *ptr = ret;
18624         FILL_ADVANCE_NODE(ptr, op);
18625         RExC_emit = ptr;
18626     }
18627     return(ret);
18628 }
18629
18630 /*
18631 - reganode - emit a node with an argument
18632 */
18633 STATIC regnode *                        /* Location. */
18634 S_reganode(pTHX_ RExC_state_t *pRExC_state, U8 op, U32 arg)
18635 {
18636     regnode * const ret = regnode_guts(pRExC_state, op, regarglen[op], "reganode");
18637
18638     PERL_ARGS_ASSERT_REGANODE;
18639
18640     assert(regarglen[op] == 1);
18641
18642     if (PASS2) {
18643         regnode *ptr = ret;
18644         FILL_ADVANCE_NODE_ARG(ptr, op, arg);
18645         RExC_emit = ptr;
18646     }
18647     return(ret);
18648 }
18649
18650 STATIC regnode *
18651 S_reg2Lanode(pTHX_ RExC_state_t *pRExC_state, const U8 op, const U32 arg1, const I32 arg2)
18652 {
18653     /* emit a node with U32 and I32 arguments */
18654
18655     regnode * const ret = regnode_guts(pRExC_state, op, regarglen[op], "reg2Lanode");
18656
18657     PERL_ARGS_ASSERT_REG2LANODE;
18658
18659     assert(regarglen[op] == 2);
18660
18661     if (PASS2) {
18662         regnode *ptr = ret;
18663         FILL_ADVANCE_NODE_2L_ARG(ptr, op, arg1, arg2);
18664         RExC_emit = ptr;
18665     }
18666     return(ret);
18667 }
18668
18669 /*
18670 - reginsert - insert an operator in front of already-emitted operand
18671 *
18672 * Means relocating the operand.
18673 *
18674 * IMPORTANT NOTE - it is the *callers* responsibility to correctly
18675 * set up NEXT_OFF() of the inserted node if needed. Something like this:
18676 *
18677 * reginsert(pRExC, OPFAIL, orig_emit, depth+1);
18678 * if (PASS2)
18679 *     NEXT_OFF(orig_emit) = regarglen[OPFAIL] + NODE_STEP_REGNODE;
18680 *
18681 * ALSO NOTE - operand->flags will be set to 0 as well.
18682 */
18683 STATIC void
18684 S_reginsert(pTHX_ RExC_state_t *pRExC_state, U8 op, regnode *operand, U32 depth)
18685 {
18686     regnode *src;
18687     regnode *dst;
18688     regnode *place;
18689     const int offset = regarglen[(U8)op];
18690     const int size = NODE_STEP_REGNODE + offset;
18691     GET_RE_DEBUG_FLAGS_DECL;
18692
18693     PERL_ARGS_ASSERT_REGINSERT;
18694     PERL_UNUSED_CONTEXT;
18695     PERL_UNUSED_ARG(depth);
18696 /* (PL_regkind[(U8)op] == CURLY ? EXTRA_STEP_2ARGS : 0); */
18697     DEBUG_PARSE_FMT("inst"," - %s",PL_reg_name[op]);
18698     if (SIZE_ONLY) {
18699         RExC_size += size;
18700         return;
18701     }
18702     assert(!RExC_study_started); /* I believe we should never use reginsert once we have started
18703                                     studying. If this is wrong then we need to adjust RExC_recurse
18704                                     below like we do with RExC_open_parens/RExC_close_parens. */
18705     src = RExC_emit;
18706     RExC_emit += size;
18707     dst = RExC_emit;
18708     if (RExC_open_parens) {
18709         int paren;
18710         /*DEBUG_PARSE_FMT("inst"," - %" IVdf, (IV)RExC_npar);*/
18711         /* remember that RExC_npar is rex->nparens + 1,
18712          * iow it is 1 more than the number of parens seen in
18713          * the pattern so far. */
18714         for ( paren=0 ; paren < RExC_npar ; paren++ ) {
18715             /* note, RExC_open_parens[0] is the start of the
18716              * regex, it can't move. RExC_close_parens[0] is the end
18717              * of the regex, it *can* move. */
18718             if ( paren && RExC_open_parens[paren] >= operand ) {
18719                 /*DEBUG_PARSE_FMT("open"," - %d",size);*/
18720                 RExC_open_parens[paren] += size;
18721             } else {
18722                 /*DEBUG_PARSE_FMT("open"," - %s","ok");*/
18723             }
18724             if ( RExC_close_parens[paren] >= operand ) {
18725                 /*DEBUG_PARSE_FMT("close"," - %d",size);*/
18726                 RExC_close_parens[paren] += size;
18727             } else {
18728                 /*DEBUG_PARSE_FMT("close"," - %s","ok");*/
18729             }
18730         }
18731     }
18732     if (RExC_end_op)
18733         RExC_end_op += size;
18734
18735     while (src > operand) {
18736         StructCopy(--src, --dst, regnode);
18737 #ifdef RE_TRACK_PATTERN_OFFSETS
18738         if (RExC_offsets) {     /* MJD 20010112 */
18739             MJD_OFFSET_DEBUG(
18740                  ("%s(%d): (op %s) %s copy %" UVuf " -> %" UVuf " (max %" UVuf ").\n",
18741                   "reg_insert",
18742                   __LINE__,
18743                   PL_reg_name[op],
18744                   (UV)(dst - RExC_emit_start) > RExC_offsets[0]
18745                     ? "Overwriting end of array!\n" : "OK",
18746                   (UV)(src - RExC_emit_start),
18747                   (UV)(dst - RExC_emit_start),
18748                   (UV)RExC_offsets[0]));
18749             Set_Node_Offset_To_R(dst-RExC_emit_start, Node_Offset(src));
18750             Set_Node_Length_To_R(dst-RExC_emit_start, Node_Length(src));
18751         }
18752 #endif
18753     }
18754
18755     place = operand;            /* Op node, where operand used to be. */
18756 #ifdef RE_TRACK_PATTERN_OFFSETS
18757     if (RExC_offsets) {         /* MJD */
18758         MJD_OFFSET_DEBUG(
18759               ("%s(%d): (op %s) %s %" UVuf " <- %" UVuf " (max %" UVuf ").\n",
18760               "reginsert",
18761               __LINE__,
18762               PL_reg_name[op],
18763               (UV)(place - RExC_emit_start) > RExC_offsets[0]
18764               ? "Overwriting end of array!\n" : "OK",
18765               (UV)(place - RExC_emit_start),
18766               (UV)(RExC_parse - RExC_start),
18767               (UV)RExC_offsets[0]));
18768         Set_Node_Offset(place, RExC_parse);
18769         Set_Node_Length(place, 1);
18770     }
18771 #endif
18772     src = NEXTOPER(place);
18773     place->flags = 0;
18774     FILL_ADVANCE_NODE(place, op);
18775     Zero(src, offset, regnode);
18776 }
18777
18778 /*
18779 - regtail - set the next-pointer at the end of a node chain of p to val.
18780 - SEE ALSO: regtail_study
18781 */
18782 STATIC void
18783 S_regtail(pTHX_ RExC_state_t * pRExC_state,
18784                 const regnode * const p,
18785                 const regnode * const val,
18786                 const U32 depth)
18787 {
18788     regnode *scan;
18789     GET_RE_DEBUG_FLAGS_DECL;
18790
18791     PERL_ARGS_ASSERT_REGTAIL;
18792 #ifndef DEBUGGING
18793     PERL_UNUSED_ARG(depth);
18794 #endif
18795
18796     if (SIZE_ONLY)
18797         return;
18798
18799     /* Find last node. */
18800     scan = (regnode *) p;
18801     for (;;) {
18802         regnode * const temp = regnext(scan);
18803         DEBUG_PARSE_r({
18804             DEBUG_PARSE_MSG((scan==p ? "tail" : ""));
18805             regprop(RExC_rx, RExC_mysv, scan, NULL, pRExC_state);
18806             Perl_re_printf( aTHX_  "~ %s (%d) %s %s\n",
18807                 SvPV_nolen_const(RExC_mysv), REG_NODE_NUM(scan),
18808                     (temp == NULL ? "->" : ""),
18809                     (temp == NULL ? PL_reg_name[OP(val)] : "")
18810             );
18811         });
18812         if (temp == NULL)
18813             break;
18814         scan = temp;
18815     }
18816
18817     if (reg_off_by_arg[OP(scan)]) {
18818         ARG_SET(scan, val - scan);
18819     }
18820     else {
18821         NEXT_OFF(scan) = val - scan;
18822     }
18823 }
18824
18825 #ifdef DEBUGGING
18826 /*
18827 - regtail_study - set the next-pointer at the end of a node chain of p to val.
18828 - Look for optimizable sequences at the same time.
18829 - currently only looks for EXACT chains.
18830
18831 This is experimental code. The idea is to use this routine to perform
18832 in place optimizations on branches and groups as they are constructed,
18833 with the long term intention of removing optimization from study_chunk so
18834 that it is purely analytical.
18835
18836 Currently only used when in DEBUG mode. The macro REGTAIL_STUDY() is used
18837 to control which is which.
18838
18839 */
18840 /* TODO: All four parms should be const */
18841
18842 STATIC U8
18843 S_regtail_study(pTHX_ RExC_state_t *pRExC_state, regnode *p,
18844                       const regnode *val,U32 depth)
18845 {
18846     regnode *scan;
18847     U8 exact = PSEUDO;
18848 #ifdef EXPERIMENTAL_INPLACESCAN
18849     I32 min = 0;
18850 #endif
18851     GET_RE_DEBUG_FLAGS_DECL;
18852
18853     PERL_ARGS_ASSERT_REGTAIL_STUDY;
18854
18855
18856     if (SIZE_ONLY)
18857         return exact;
18858
18859     /* Find last node. */
18860
18861     scan = p;
18862     for (;;) {
18863         regnode * const temp = regnext(scan);
18864 #ifdef EXPERIMENTAL_INPLACESCAN
18865         if (PL_regkind[OP(scan)] == EXACT) {
18866             bool unfolded_multi_char;   /* Unexamined in this routine */
18867             if (join_exact(pRExC_state, scan, &min,
18868                            &unfolded_multi_char, 1, val, depth+1))
18869                 return EXACT;
18870         }
18871 #endif
18872         if ( exact ) {
18873             switch (OP(scan)) {
18874                 case EXACT:
18875                 case EXACTL:
18876                 case EXACTF:
18877                 case EXACTFA_NO_TRIE:
18878                 case EXACTFA:
18879                 case EXACTFU:
18880                 case EXACTFLU8:
18881                 case EXACTFU_SS:
18882                 case EXACTFL:
18883                         if( exact == PSEUDO )
18884                             exact= OP(scan);
18885                         else if ( exact != OP(scan) )
18886                             exact= 0;
18887                 case NOTHING:
18888                     break;
18889                 default:
18890                     exact= 0;
18891             }
18892         }
18893         DEBUG_PARSE_r({
18894             DEBUG_PARSE_MSG((scan==p ? "tsdy" : ""));
18895             regprop(RExC_rx, RExC_mysv, scan, NULL, pRExC_state);
18896             Perl_re_printf( aTHX_  "~ %s (%d) -> %s\n",
18897                 SvPV_nolen_const(RExC_mysv),
18898                 REG_NODE_NUM(scan),
18899                 PL_reg_name[exact]);
18900         });
18901         if (temp == NULL)
18902             break;
18903         scan = temp;
18904     }
18905     DEBUG_PARSE_r({
18906         DEBUG_PARSE_MSG("");
18907         regprop(RExC_rx, RExC_mysv, val, NULL, pRExC_state);
18908         Perl_re_printf( aTHX_
18909                       "~ attach to %s (%" IVdf ") offset to %" IVdf "\n",
18910                       SvPV_nolen_const(RExC_mysv),
18911                       (IV)REG_NODE_NUM(val),
18912                       (IV)(val - scan)
18913         );
18914     });
18915     if (reg_off_by_arg[OP(scan)]) {
18916         ARG_SET(scan, val - scan);
18917     }
18918     else {
18919         NEXT_OFF(scan) = val - scan;
18920     }
18921
18922     return exact;
18923 }
18924 #endif
18925
18926 /*
18927  - regdump - dump a regexp onto Perl_debug_log in vaguely comprehensible form
18928  */
18929 #ifdef DEBUGGING
18930
18931 static void
18932 S_regdump_intflags(pTHX_ const char *lead, const U32 flags)
18933 {
18934     int bit;
18935     int set=0;
18936
18937     ASSUME(REG_INTFLAGS_NAME_SIZE <= sizeof(flags)*8);
18938
18939     for (bit=0; bit<REG_INTFLAGS_NAME_SIZE; bit++) {
18940         if (flags & (1<<bit)) {
18941             if (!set++ && lead)
18942                 Perl_re_printf( aTHX_  "%s",lead);
18943             Perl_re_printf( aTHX_  "%s ",PL_reg_intflags_name[bit]);
18944         }
18945     }
18946     if (lead)  {
18947         if (set)
18948             Perl_re_printf( aTHX_  "\n");
18949         else
18950             Perl_re_printf( aTHX_  "%s[none-set]\n",lead);
18951     }
18952 }
18953
18954 static void
18955 S_regdump_extflags(pTHX_ const char *lead, const U32 flags)
18956 {
18957     int bit;
18958     int set=0;
18959     regex_charset cs;
18960
18961     ASSUME(REG_EXTFLAGS_NAME_SIZE <= sizeof(flags)*8);
18962
18963     for (bit=0; bit<REG_EXTFLAGS_NAME_SIZE; bit++) {
18964         if (flags & (1<<bit)) {
18965             if ((1<<bit) & RXf_PMf_CHARSET) {   /* Output separately, below */
18966                 continue;
18967             }
18968             if (!set++ && lead)
18969                 Perl_re_printf( aTHX_  "%s",lead);
18970             Perl_re_printf( aTHX_  "%s ",PL_reg_extflags_name[bit]);
18971         }
18972     }
18973     if ((cs = get_regex_charset(flags)) != REGEX_DEPENDS_CHARSET) {
18974             if (!set++ && lead) {
18975                 Perl_re_printf( aTHX_  "%s",lead);
18976             }
18977             switch (cs) {
18978                 case REGEX_UNICODE_CHARSET:
18979                     Perl_re_printf( aTHX_  "UNICODE");
18980                     break;
18981                 case REGEX_LOCALE_CHARSET:
18982                     Perl_re_printf( aTHX_  "LOCALE");
18983                     break;
18984                 case REGEX_ASCII_RESTRICTED_CHARSET:
18985                     Perl_re_printf( aTHX_  "ASCII-RESTRICTED");
18986                     break;
18987                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
18988                     Perl_re_printf( aTHX_  "ASCII-MORE_RESTRICTED");
18989                     break;
18990                 default:
18991                     Perl_re_printf( aTHX_  "UNKNOWN CHARACTER SET");
18992                     break;
18993             }
18994     }
18995     if (lead)  {
18996         if (set)
18997             Perl_re_printf( aTHX_  "\n");
18998         else
18999             Perl_re_printf( aTHX_  "%s[none-set]\n",lead);
19000     }
19001 }
19002 #endif
19003
19004 void
19005 Perl_regdump(pTHX_ const regexp *r)
19006 {
19007 #ifdef DEBUGGING
19008     int i;
19009     SV * const sv = sv_newmortal();
19010     SV *dsv= sv_newmortal();
19011     RXi_GET_DECL(r,ri);
19012     GET_RE_DEBUG_FLAGS_DECL;
19013
19014     PERL_ARGS_ASSERT_REGDUMP;
19015
19016     (void)dumpuntil(r, ri->program, ri->program + 1, NULL, NULL, sv, 0, 0);
19017
19018     /* Header fields of interest. */
19019     for (i = 0; i < 2; i++) {
19020         if (r->substrs->data[i].substr) {
19021             RE_PV_QUOTED_DECL(s, 0, dsv,
19022                             SvPVX_const(r->substrs->data[i].substr),
19023                             RE_SV_DUMPLEN(r->substrs->data[i].substr),
19024                             PL_dump_re_max_len);
19025             Perl_re_printf( aTHX_
19026                           "%s %s%s at %" IVdf "..%" UVuf " ",
19027                           i ? "floating" : "anchored",
19028                           s,
19029                           RE_SV_TAIL(r->substrs->data[i].substr),
19030                           (IV)r->substrs->data[i].min_offset,
19031                           (UV)r->substrs->data[i].max_offset);
19032         }
19033         else if (r->substrs->data[i].utf8_substr) {
19034             RE_PV_QUOTED_DECL(s, 1, dsv,
19035                             SvPVX_const(r->substrs->data[i].utf8_substr),
19036                             RE_SV_DUMPLEN(r->substrs->data[i].utf8_substr),
19037                             30);
19038             Perl_re_printf( aTHX_
19039                           "%s utf8 %s%s at %" IVdf "..%" UVuf " ",
19040                           i ? "floating" : "anchored",
19041                           s,
19042                           RE_SV_TAIL(r->substrs->data[i].utf8_substr),
19043                           (IV)r->substrs->data[i].min_offset,
19044                           (UV)r->substrs->data[i].max_offset);
19045         }
19046     }
19047
19048     if (r->check_substr || r->check_utf8)
19049         Perl_re_printf( aTHX_
19050                       (const char *)
19051                       (   r->check_substr == r->substrs->data[1].substr
19052                        && r->check_utf8   == r->substrs->data[1].utf8_substr
19053                        ? "(checking floating" : "(checking anchored"));
19054     if (r->intflags & PREGf_NOSCAN)
19055         Perl_re_printf( aTHX_  " noscan");
19056     if (r->extflags & RXf_CHECK_ALL)
19057         Perl_re_printf( aTHX_  " isall");
19058     if (r->check_substr || r->check_utf8)
19059         Perl_re_printf( aTHX_  ") ");
19060
19061     if (ri->regstclass) {
19062         regprop(r, sv, ri->regstclass, NULL, NULL);
19063         Perl_re_printf( aTHX_  "stclass %s ", SvPVX_const(sv));
19064     }
19065     if (r->intflags & PREGf_ANCH) {
19066         Perl_re_printf( aTHX_  "anchored");
19067         if (r->intflags & PREGf_ANCH_MBOL)
19068             Perl_re_printf( aTHX_  "(MBOL)");
19069         if (r->intflags & PREGf_ANCH_SBOL)
19070             Perl_re_printf( aTHX_  "(SBOL)");
19071         if (r->intflags & PREGf_ANCH_GPOS)
19072             Perl_re_printf( aTHX_  "(GPOS)");
19073         Perl_re_printf( aTHX_ " ");
19074     }
19075     if (r->intflags & PREGf_GPOS_SEEN)
19076         Perl_re_printf( aTHX_  "GPOS:%" UVuf " ", (UV)r->gofs);
19077     if (r->intflags & PREGf_SKIP)
19078         Perl_re_printf( aTHX_  "plus ");
19079     if (r->intflags & PREGf_IMPLICIT)
19080         Perl_re_printf( aTHX_  "implicit ");
19081     Perl_re_printf( aTHX_  "minlen %" IVdf " ", (IV)r->minlen);
19082     if (r->extflags & RXf_EVAL_SEEN)
19083         Perl_re_printf( aTHX_  "with eval ");
19084     Perl_re_printf( aTHX_  "\n");
19085     DEBUG_FLAGS_r({
19086         regdump_extflags("r->extflags: ",r->extflags);
19087         regdump_intflags("r->intflags: ",r->intflags);
19088     });
19089 #else
19090     PERL_ARGS_ASSERT_REGDUMP;
19091     PERL_UNUSED_CONTEXT;
19092     PERL_UNUSED_ARG(r);
19093 #endif  /* DEBUGGING */
19094 }
19095
19096 /* Should be synchronized with ANYOF_ #defines in regcomp.h */
19097 #ifdef DEBUGGING
19098
19099 #  if   _CC_WORDCHAR != 0 || _CC_DIGIT != 1        || _CC_ALPHA != 2    \
19100      || _CC_LOWER != 3    || _CC_UPPER != 4        || _CC_PUNCT != 5    \
19101      || _CC_PRINT != 6    || _CC_ALPHANUMERIC != 7 || _CC_GRAPH != 8    \
19102      || _CC_CASED != 9    || _CC_SPACE != 10       || _CC_BLANK != 11   \
19103      || _CC_XDIGIT != 12  || _CC_CNTRL != 13       || _CC_ASCII != 14   \
19104      || _CC_VERTSPACE != 15
19105 #   error Need to adjust order of anyofs[]
19106 #  endif
19107 static const char * const anyofs[] = {
19108     "\\w",
19109     "\\W",
19110     "\\d",
19111     "\\D",
19112     "[:alpha:]",
19113     "[:^alpha:]",
19114     "[:lower:]",
19115     "[:^lower:]",
19116     "[:upper:]",
19117     "[:^upper:]",
19118     "[:punct:]",
19119     "[:^punct:]",
19120     "[:print:]",
19121     "[:^print:]",
19122     "[:alnum:]",
19123     "[:^alnum:]",
19124     "[:graph:]",
19125     "[:^graph:]",
19126     "[:cased:]",
19127     "[:^cased:]",
19128     "\\s",
19129     "\\S",
19130     "[:blank:]",
19131     "[:^blank:]",
19132     "[:xdigit:]",
19133     "[:^xdigit:]",
19134     "[:cntrl:]",
19135     "[:^cntrl:]",
19136     "[:ascii:]",
19137     "[:^ascii:]",
19138     "\\v",
19139     "\\V"
19140 };
19141 #endif
19142
19143 /*
19144 - regprop - printable representation of opcode, with run time support
19145 */
19146
19147 void
19148 Perl_regprop(pTHX_ const regexp *prog, SV *sv, const regnode *o, const regmatch_info *reginfo, const RExC_state_t *pRExC_state)
19149 {
19150 #ifdef DEBUGGING
19151     int k;
19152     RXi_GET_DECL(prog,progi);
19153     GET_RE_DEBUG_FLAGS_DECL;
19154
19155     PERL_ARGS_ASSERT_REGPROP;
19156
19157     SvPVCLEAR(sv);
19158
19159     if (OP(o) > REGNODE_MAX)            /* regnode.type is unsigned */
19160         /* It would be nice to FAIL() here, but this may be called from
19161            regexec.c, and it would be hard to supply pRExC_state. */
19162         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d",
19163                                               (int)OP(o), (int)REGNODE_MAX);
19164     sv_catpv(sv, PL_reg_name[OP(o)]); /* Take off const! */
19165
19166     k = PL_regkind[OP(o)];
19167
19168     if (k == EXACT) {
19169         sv_catpvs(sv, " ");
19170         /* Using is_utf8_string() (via PERL_PV_UNI_DETECT)
19171          * is a crude hack but it may be the best for now since
19172          * we have no flag "this EXACTish node was UTF-8"
19173          * --jhi */
19174         pv_pretty(sv, STRING(o), STR_LEN(o), PL_dump_re_max_len,
19175                   PL_colors[0], PL_colors[1],
19176                   PERL_PV_ESCAPE_UNI_DETECT |
19177                   PERL_PV_ESCAPE_NONASCII   |
19178                   PERL_PV_PRETTY_ELLIPSES   |
19179                   PERL_PV_PRETTY_LTGT       |
19180                   PERL_PV_PRETTY_NOCLEAR
19181                   );
19182     } else if (k == TRIE) {
19183         /* print the details of the trie in dumpuntil instead, as
19184          * progi->data isn't available here */
19185         const char op = OP(o);
19186         const U32 n = ARG(o);
19187         const reg_ac_data * const ac = IS_TRIE_AC(op) ?
19188                (reg_ac_data *)progi->data->data[n] :
19189                NULL;
19190         const reg_trie_data * const trie
19191             = (reg_trie_data*)progi->data->data[!IS_TRIE_AC(op) ? n : ac->trie];
19192
19193         Perl_sv_catpvf(aTHX_ sv, "-%s",PL_reg_name[o->flags]);
19194         DEBUG_TRIE_COMPILE_r({
19195           if (trie->jump)
19196             sv_catpvs(sv, "(JUMP)");
19197           Perl_sv_catpvf(aTHX_ sv,
19198             "<S:%" UVuf "/%" IVdf " W:%" UVuf " L:%" UVuf "/%" UVuf " C:%" UVuf "/%" UVuf ">",
19199             (UV)trie->startstate,
19200             (IV)trie->statecount-1, /* -1 because of the unused 0 element */
19201             (UV)trie->wordcount,
19202             (UV)trie->minlen,
19203             (UV)trie->maxlen,
19204             (UV)TRIE_CHARCOUNT(trie),
19205             (UV)trie->uniquecharcount
19206           );
19207         });
19208         if ( IS_ANYOF_TRIE(op) || trie->bitmap ) {
19209             sv_catpvs(sv, "[");
19210             (void) put_charclass_bitmap_innards(sv,
19211                                                 ((IS_ANYOF_TRIE(op))
19212                                                  ? ANYOF_BITMAP(o)
19213                                                  : TRIE_BITMAP(trie)),
19214                                                 NULL,
19215                                                 NULL,
19216                                                 NULL,
19217                                                 FALSE
19218                                                );
19219             sv_catpvs(sv, "]");
19220         }
19221     } else if (k == CURLY) {
19222         U32 lo = ARG1(o), hi = ARG2(o);
19223         if (OP(o) == CURLYM || OP(o) == CURLYN || OP(o) == CURLYX)
19224             Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags); /* Parenth number */
19225         Perl_sv_catpvf(aTHX_ sv, "{%u,", (unsigned) lo);
19226         if (hi == REG_INFTY)
19227             sv_catpvs(sv, "INFTY");
19228         else
19229             Perl_sv_catpvf(aTHX_ sv, "%u", (unsigned) hi);
19230         sv_catpvs(sv, "}");
19231     }
19232     else if (k == WHILEM && o->flags)                   /* Ordinal/of */
19233         Perl_sv_catpvf(aTHX_ sv, "[%d/%d]", o->flags & 0xf, o->flags>>4);
19234     else if (k == REF || k == OPEN || k == CLOSE
19235              || k == GROUPP || OP(o)==ACCEPT)
19236     {
19237         AV *name_list= NULL;
19238         U32 parno= OP(o) == ACCEPT ? (U32)ARG2L(o) : ARG(o);
19239         Perl_sv_catpvf(aTHX_ sv, "%" UVuf, (UV)parno);        /* Parenth number */
19240         if ( RXp_PAREN_NAMES(prog) ) {
19241             name_list= MUTABLE_AV(progi->data->data[progi->name_list_idx]);
19242         } else if ( pRExC_state ) {
19243             name_list= RExC_paren_name_list;
19244         }
19245         if (name_list) {
19246             if ( k != REF || (OP(o) < NREF)) {
19247                 SV **name= av_fetch(name_list, parno, 0 );
19248                 if (name)
19249                     Perl_sv_catpvf(aTHX_ sv, " '%" SVf "'", SVfARG(*name));
19250             }
19251             else {
19252                 SV *sv_dat= MUTABLE_SV(progi->data->data[ parno ]);
19253                 I32 *nums=(I32*)SvPVX(sv_dat);
19254                 SV **name= av_fetch(name_list, nums[0], 0 );
19255                 I32 n;
19256                 if (name) {
19257                     for ( n=0; n<SvIVX(sv_dat); n++ ) {
19258                         Perl_sv_catpvf(aTHX_ sv, "%s%" IVdf,
19259                                     (n ? "," : ""), (IV)nums[n]);
19260                     }
19261                     Perl_sv_catpvf(aTHX_ sv, " '%" SVf "'", SVfARG(*name));
19262                 }
19263             }
19264         }
19265         if ( k == REF && reginfo) {
19266             U32 n = ARG(o);  /* which paren pair */
19267             I32 ln = prog->offs[n].start;
19268             if (prog->lastparen < n || ln == -1)
19269                 Perl_sv_catpvf(aTHX_ sv, ": FAIL");
19270             else if (ln == prog->offs[n].end)
19271                 Perl_sv_catpvf(aTHX_ sv, ": ACCEPT - EMPTY STRING");
19272             else {
19273                 const char *s = reginfo->strbeg + ln;
19274                 Perl_sv_catpvf(aTHX_ sv, ": ");
19275                 Perl_pv_pretty( aTHX_ sv, s, prog->offs[n].end - prog->offs[n].start, 32, 0, 0,
19276                     PERL_PV_ESCAPE_UNI_DETECT|PERL_PV_PRETTY_NOCLEAR|PERL_PV_PRETTY_ELLIPSES|PERL_PV_PRETTY_QUOTE );
19277             }
19278         }
19279     } else if (k == GOSUB) {
19280         AV *name_list= NULL;
19281         if ( RXp_PAREN_NAMES(prog) ) {
19282             name_list= MUTABLE_AV(progi->data->data[progi->name_list_idx]);
19283         } else if ( pRExC_state ) {
19284             name_list= RExC_paren_name_list;
19285         }
19286
19287         /* Paren and offset */
19288         Perl_sv_catpvf(aTHX_ sv, "%d[%+d:%d]", (int)ARG(o),(int)ARG2L(o),
19289                 (int)((o + (int)ARG2L(o)) - progi->program) );
19290         if (name_list) {
19291             SV **name= av_fetch(name_list, ARG(o), 0 );
19292             if (name)
19293                 Perl_sv_catpvf(aTHX_ sv, " '%" SVf "'", SVfARG(*name));
19294         }
19295     }
19296     else if (k == LOGICAL)
19297         /* 2: embedded, otherwise 1 */
19298         Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags);
19299     else if (k == ANYOF) {
19300         const U8 flags = ANYOF_FLAGS(o);
19301         bool do_sep = FALSE;    /* Do we need to separate various components of
19302                                    the output? */
19303         /* Set if there is still an unresolved user-defined property */
19304         SV *unresolved                = NULL;
19305
19306         /* Things that are ignored except when the runtime locale is UTF-8 */
19307         SV *only_utf8_locale_invlist = NULL;
19308
19309         /* Code points that don't fit in the bitmap */
19310         SV *nonbitmap_invlist = NULL;
19311
19312         /* And things that aren't in the bitmap, but are small enough to be */
19313         SV* bitmap_range_not_in_bitmap = NULL;
19314
19315         const bool inverted = flags & ANYOF_INVERT;
19316
19317         if (OP(o) == ANYOFL) {
19318             if (ANYOFL_UTF8_LOCALE_REQD(flags)) {
19319                 sv_catpvs(sv, "{utf8-locale-reqd}");
19320             }
19321             if (flags & ANYOFL_FOLD) {
19322                 sv_catpvs(sv, "{i}");
19323             }
19324         }
19325
19326         /* If there is stuff outside the bitmap, get it */
19327         if (ARG(o) != ANYOF_ONLY_HAS_BITMAP) {
19328             (void) _get_regclass_nonbitmap_data(prog, o, FALSE,
19329                                                 &unresolved,
19330                                                 &only_utf8_locale_invlist,
19331                                                 &nonbitmap_invlist);
19332             /* The non-bitmap data may contain stuff that could fit in the
19333              * bitmap.  This could come from a user-defined property being
19334              * finally resolved when this call was done; or much more likely
19335              * because there are matches that require UTF-8 to be valid, and so
19336              * aren't in the bitmap.  This is teased apart later */
19337             _invlist_intersection(nonbitmap_invlist,
19338                                   PL_InBitmap,
19339                                   &bitmap_range_not_in_bitmap);
19340             /* Leave just the things that don't fit into the bitmap */
19341             _invlist_subtract(nonbitmap_invlist,
19342                               PL_InBitmap,
19343                               &nonbitmap_invlist);
19344         }
19345
19346         /* Obey this flag to add all above-the-bitmap code points */
19347         if (flags & ANYOF_MATCHES_ALL_ABOVE_BITMAP) {
19348             nonbitmap_invlist = _add_range_to_invlist(nonbitmap_invlist,
19349                                                       NUM_ANYOF_CODE_POINTS,
19350                                                       UV_MAX);
19351         }
19352
19353         /* Ready to start outputting.  First, the initial left bracket */
19354         Perl_sv_catpvf(aTHX_ sv, "[%s", PL_colors[0]);
19355
19356         /* Then all the things that could fit in the bitmap */
19357         do_sep = put_charclass_bitmap_innards(sv,
19358                                               ANYOF_BITMAP(o),
19359                                               bitmap_range_not_in_bitmap,
19360                                               only_utf8_locale_invlist,
19361                                               o,
19362
19363                                               /* Can't try inverting for a
19364                                                * better display if there are
19365                                                * things that haven't been
19366                                                * resolved */
19367                                               unresolved != NULL);
19368         SvREFCNT_dec(bitmap_range_not_in_bitmap);
19369
19370         /* If there are user-defined properties which haven't been defined yet,
19371          * output them.  If the result is not to be inverted, it is clearest to
19372          * output them in a separate [] from the bitmap range stuff.  If the
19373          * result is to be complemented, we have to show everything in one [],
19374          * as the inversion applies to the whole thing.  Use {braces} to
19375          * separate them from anything in the bitmap and anything above the
19376          * bitmap. */
19377         if (unresolved) {
19378             if (inverted) {
19379                 if (! do_sep) { /* If didn't output anything in the bitmap */
19380                     sv_catpvs(sv, "^");
19381                 }
19382                 sv_catpvs(sv, "{");
19383             }
19384             else if (do_sep) {
19385                 Perl_sv_catpvf(aTHX_ sv,"%s][%s",PL_colors[1],PL_colors[0]);
19386             }
19387             sv_catsv(sv, unresolved);
19388             if (inverted) {
19389                 sv_catpvs(sv, "}");
19390             }
19391             do_sep = ! inverted;
19392         }
19393
19394         /* And, finally, add the above-the-bitmap stuff */
19395         if (nonbitmap_invlist && _invlist_len(nonbitmap_invlist)) {
19396             SV* contents;
19397
19398             /* See if truncation size is overridden */
19399             const STRLEN dump_len = (PL_dump_re_max_len > 256)
19400                                     ? PL_dump_re_max_len
19401                                     : 256;
19402
19403             /* This is output in a separate [] */
19404             if (do_sep) {
19405                 Perl_sv_catpvf(aTHX_ sv,"%s][%s",PL_colors[1],PL_colors[0]);
19406             }
19407
19408             /* And, for easy of understanding, it is shown in the
19409              * uncomplemented form if possible.  The one exception being if
19410              * there are unresolved items, where the inversion has to be
19411              * delayed until runtime */
19412             if (inverted && ! unresolved) {
19413                 _invlist_invert(nonbitmap_invlist);
19414                 _invlist_subtract(nonbitmap_invlist, PL_InBitmap, &nonbitmap_invlist);
19415             }
19416
19417             contents = invlist_contents(nonbitmap_invlist,
19418                                         FALSE /* output suitable for catsv */
19419                                        );
19420
19421             /* If the output is shorter than the permissible maximum, just do it. */
19422             if (SvCUR(contents) <= dump_len) {
19423                 sv_catsv(sv, contents);
19424             }
19425             else {
19426                 const char * contents_string = SvPVX(contents);
19427                 STRLEN i = dump_len;
19428
19429                 /* Otherwise, start at the permissible max and work back to the
19430                  * first break possibility */
19431                 while (i > 0 && contents_string[i] != ' ') {
19432                     i--;
19433                 }
19434                 if (i == 0) {       /* Fail-safe.  Use the max if we couldn't
19435                                        find a legal break */
19436                     i = dump_len;
19437                 }
19438
19439                 sv_catpvn(sv, contents_string, i);
19440                 sv_catpvs(sv, "...");
19441             }
19442
19443             SvREFCNT_dec_NN(contents);
19444             SvREFCNT_dec_NN(nonbitmap_invlist);
19445         }
19446
19447         /* And finally the matching, closing ']' */
19448         Perl_sv_catpvf(aTHX_ sv, "%s]", PL_colors[1]);
19449
19450         SvREFCNT_dec(unresolved);
19451     }
19452     else if (k == POSIXD || k == NPOSIXD) {
19453         U8 index = FLAGS(o) * 2;
19454         if (index < C_ARRAY_LENGTH(anyofs)) {
19455             if (*anyofs[index] != '[')  {
19456                 sv_catpv(sv, "[");
19457             }
19458             sv_catpv(sv, anyofs[index]);
19459             if (*anyofs[index] != '[')  {
19460                 sv_catpv(sv, "]");
19461             }
19462         }
19463         else {
19464             Perl_sv_catpvf(aTHX_ sv, "[illegal type=%d])", index);
19465         }
19466     }
19467     else if (k == BOUND || k == NBOUND) {
19468         /* Must be synced with order of 'bound_type' in regcomp.h */
19469         const char * const bounds[] = {
19470             "",      /* Traditional */
19471             "{gcb}",
19472             "{lb}",
19473             "{sb}",
19474             "{wb}"
19475         };
19476         assert(FLAGS(o) < C_ARRAY_LENGTH(bounds));
19477         sv_catpv(sv, bounds[FLAGS(o)]);
19478     }
19479     else if (k == BRANCHJ && (OP(o) == UNLESSM || OP(o) == IFMATCH))
19480         Perl_sv_catpvf(aTHX_ sv, "[%d]", -(o->flags));
19481     else if (OP(o) == SBOL)
19482         Perl_sv_catpvf(aTHX_ sv, " /%s/", o->flags ? "\\A" : "^");
19483
19484     /* add on the verb argument if there is one */
19485     if ( ( k == VERB || OP(o) == ACCEPT || OP(o) == OPFAIL ) && o->flags) {
19486         if ( ARG(o) )
19487             Perl_sv_catpvf(aTHX_ sv, ":%" SVf,
19488                        SVfARG((MUTABLE_SV(progi->data->data[ ARG( o ) ]))));
19489         else
19490             sv_catpvs(sv, ":NULL");
19491     }
19492 #else
19493     PERL_UNUSED_CONTEXT;
19494     PERL_UNUSED_ARG(sv);
19495     PERL_UNUSED_ARG(o);
19496     PERL_UNUSED_ARG(prog);
19497     PERL_UNUSED_ARG(reginfo);
19498     PERL_UNUSED_ARG(pRExC_state);
19499 #endif  /* DEBUGGING */
19500 }
19501
19502
19503
19504 SV *
19505 Perl_re_intuit_string(pTHX_ REGEXP * const r)
19506 {                               /* Assume that RE_INTUIT is set */
19507     struct regexp *const prog = ReANY(r);
19508     GET_RE_DEBUG_FLAGS_DECL;
19509
19510     PERL_ARGS_ASSERT_RE_INTUIT_STRING;
19511     PERL_UNUSED_CONTEXT;
19512
19513     DEBUG_COMPILE_r(
19514         {
19515             const char * const s = SvPV_nolen_const(RX_UTF8(r)
19516                       ? prog->check_utf8 : prog->check_substr);
19517
19518             if (!PL_colorset) reginitcolors();
19519             Perl_re_printf( aTHX_
19520                       "%sUsing REx %ssubstr:%s \"%s%.60s%s%s\"\n",
19521                       PL_colors[4],
19522                       RX_UTF8(r) ? "utf8 " : "",
19523                       PL_colors[5],PL_colors[0],
19524                       s,
19525                       PL_colors[1],
19526                       (strlen(s) > PL_dump_re_max_len ? "..." : ""));
19527         } );
19528
19529     /* use UTF8 check substring if regexp pattern itself is in UTF8 */
19530     return RX_UTF8(r) ? prog->check_utf8 : prog->check_substr;
19531 }
19532
19533 /*
19534    pregfree()
19535
19536    handles refcounting and freeing the perl core regexp structure. When
19537    it is necessary to actually free the structure the first thing it
19538    does is call the 'free' method of the regexp_engine associated to
19539    the regexp, allowing the handling of the void *pprivate; member
19540    first. (This routine is not overridable by extensions, which is why
19541    the extensions free is called first.)
19542
19543    See regdupe and regdupe_internal if you change anything here.
19544 */
19545 #ifndef PERL_IN_XSUB_RE
19546 void
19547 Perl_pregfree(pTHX_ REGEXP *r)
19548 {
19549     SvREFCNT_dec(r);
19550 }
19551
19552 void
19553 Perl_pregfree2(pTHX_ REGEXP *rx)
19554 {
19555     struct regexp *const r = ReANY(rx);
19556     GET_RE_DEBUG_FLAGS_DECL;
19557
19558     PERL_ARGS_ASSERT_PREGFREE2;
19559
19560     if (r->mother_re) {
19561         ReREFCNT_dec(r->mother_re);
19562     } else {
19563         CALLREGFREE_PVT(rx); /* free the private data */
19564         SvREFCNT_dec(RXp_PAREN_NAMES(r));
19565     }
19566     if (r->substrs) {
19567         int i;
19568         for (i = 0; i < 2; i++) {
19569             SvREFCNT_dec(r->substrs->data[i].substr);
19570             SvREFCNT_dec(r->substrs->data[i].utf8_substr);
19571         }
19572         Safefree(r->substrs);
19573     }
19574     RX_MATCH_COPY_FREE(rx);
19575 #ifdef PERL_ANY_COW
19576     SvREFCNT_dec(r->saved_copy);
19577 #endif
19578     Safefree(r->offs);
19579     SvREFCNT_dec(r->qr_anoncv);
19580     if (r->recurse_locinput)
19581         Safefree(r->recurse_locinput);
19582 }
19583
19584
19585 /*  reg_temp_copy()
19586
19587     Copy ssv to dsv, both of which should of type SVt_REGEXP or SVt_PVLV,
19588     except that dsv will be created if NULL.
19589
19590     This function is used in two main ways. First to implement
19591         $r = qr/....; $s = $$r;
19592
19593     Secondly, it is used as a hacky workaround to the structural issue of
19594     match results
19595     being stored in the regexp structure which is in turn stored in
19596     PL_curpm/PL_reg_curpm. The problem is that due to qr// the pattern
19597     could be PL_curpm in multiple contexts, and could require multiple
19598     result sets being associated with the pattern simultaneously, such
19599     as when doing a recursive match with (??{$qr})
19600
19601     The solution is to make a lightweight copy of the regexp structure
19602     when a qr// is returned from the code executed by (??{$qr}) this
19603     lightweight copy doesn't actually own any of its data except for
19604     the starp/end and the actual regexp structure itself.
19605
19606 */
19607
19608
19609 REGEXP *
19610 Perl_reg_temp_copy(pTHX_ REGEXP *dsv, REGEXP *ssv)
19611 {
19612     struct regexp *drx;
19613     struct regexp *const srx = ReANY(ssv);
19614     const bool islv = dsv && SvTYPE(dsv) == SVt_PVLV;
19615
19616     PERL_ARGS_ASSERT_REG_TEMP_COPY;
19617
19618     if (!dsv)
19619         dsv = (REGEXP*) newSV_type(SVt_REGEXP);
19620     else {
19621         SvOK_off((SV *)dsv);
19622         if (islv) {
19623             /* For PVLVs, the head (sv_any) points to an XPVLV, while
19624              * the LV's xpvlenu_rx will point to a regexp body, which
19625              * we allocate here */
19626             REGEXP *temp = (REGEXP *)newSV_type(SVt_REGEXP);
19627             assert(!SvPVX(dsv));
19628             ((XPV*)SvANY(dsv))->xpv_len_u.xpvlenu_rx = temp->sv_any;
19629             temp->sv_any = NULL;
19630             SvFLAGS(temp) = (SvFLAGS(temp) & ~SVTYPEMASK) | SVt_NULL;
19631             SvREFCNT_dec_NN(temp);
19632             /* SvCUR still resides in the xpvlv struct, so the regexp copy-
19633                ing below will not set it. */
19634             SvCUR_set(dsv, SvCUR(ssv));
19635         }
19636     }
19637     /* This ensures that SvTHINKFIRST(sv) is true, and hence that
19638        sv_force_normal(sv) is called.  */
19639     SvFAKE_on(dsv);
19640     drx = ReANY(dsv);
19641
19642     SvFLAGS(dsv) |= SvFLAGS(ssv) & (SVf_POK|SVp_POK|SVf_UTF8);
19643     SvPV_set(dsv, RX_WRAPPED(ssv));
19644     /* We share the same string buffer as the original regexp, on which we
19645        hold a reference count, incremented when mother_re is set below.
19646        The string pointer is copied here, being part of the regexp struct.
19647      */
19648     memcpy(&(drx->xpv_cur), &(srx->xpv_cur),
19649            sizeof(regexp) - STRUCT_OFFSET(regexp, xpv_cur));
19650     if (!islv)
19651         SvLEN_set(dsv, 0);
19652     if (srx->offs) {
19653         const I32 npar = srx->nparens+1;
19654         Newx(drx->offs, npar, regexp_paren_pair);
19655         Copy(srx->offs, drx->offs, npar, regexp_paren_pair);
19656     }
19657     if (srx->substrs) {
19658         int i;
19659         Newx(drx->substrs, 1, struct reg_substr_data);
19660         StructCopy(srx->substrs, drx->substrs, struct reg_substr_data);
19661
19662         for (i = 0; i < 2; i++) {
19663             SvREFCNT_inc_void(drx->substrs->data[i].substr);
19664             SvREFCNT_inc_void(drx->substrs->data[i].utf8_substr);
19665         }
19666
19667         /* check_substr and check_utf8, if non-NULL, point to either their
19668            anchored or float namesakes, and don't hold a second reference.  */
19669     }
19670     RX_MATCH_COPIED_off(dsv);
19671 #ifdef PERL_ANY_COW
19672     drx->saved_copy = NULL;
19673 #endif
19674     drx->mother_re = ReREFCNT_inc(srx->mother_re ? srx->mother_re : ssv);
19675     SvREFCNT_inc_void(drx->qr_anoncv);
19676     if (srx->recurse_locinput)
19677         Newx(drx->recurse_locinput,srx->nparens + 1,char *);
19678
19679     return dsv;
19680 }
19681 #endif
19682
19683
19684 /* regfree_internal()
19685
19686    Free the private data in a regexp. This is overloadable by
19687    extensions. Perl takes care of the regexp structure in pregfree(),
19688    this covers the *pprivate pointer which technically perl doesn't
19689    know about, however of course we have to handle the
19690    regexp_internal structure when no extension is in use.
19691
19692    Note this is called before freeing anything in the regexp
19693    structure.
19694  */
19695
19696 void
19697 Perl_regfree_internal(pTHX_ REGEXP * const rx)
19698 {
19699     struct regexp *const r = ReANY(rx);
19700     RXi_GET_DECL(r,ri);
19701     GET_RE_DEBUG_FLAGS_DECL;
19702
19703     PERL_ARGS_ASSERT_REGFREE_INTERNAL;
19704
19705     DEBUG_COMPILE_r({
19706         if (!PL_colorset)
19707             reginitcolors();
19708         {
19709             SV *dsv= sv_newmortal();
19710             RE_PV_QUOTED_DECL(s, RX_UTF8(rx),
19711                 dsv, RX_PRECOMP(rx), RX_PRELEN(rx), PL_dump_re_max_len);
19712             Perl_re_printf( aTHX_ "%sFreeing REx:%s %s\n",
19713                 PL_colors[4],PL_colors[5],s);
19714         }
19715     });
19716 #ifdef RE_TRACK_PATTERN_OFFSETS
19717     if (ri->u.offsets)
19718         Safefree(ri->u.offsets);             /* 20010421 MJD */
19719 #endif
19720     if (ri->code_blocks)
19721         S_free_codeblocks(aTHX_ ri->code_blocks);
19722
19723     if (ri->data) {
19724         int n = ri->data->count;
19725
19726         while (--n >= 0) {
19727           /* If you add a ->what type here, update the comment in regcomp.h */
19728             switch (ri->data->what[n]) {
19729             case 'a':
19730             case 'r':
19731             case 's':
19732             case 'S':
19733             case 'u':
19734                 SvREFCNT_dec(MUTABLE_SV(ri->data->data[n]));
19735                 break;
19736             case 'f':
19737                 Safefree(ri->data->data[n]);
19738                 break;
19739             case 'l':
19740             case 'L':
19741                 break;
19742             case 'T':
19743                 { /* Aho Corasick add-on structure for a trie node.
19744                      Used in stclass optimization only */
19745                     U32 refcount;
19746                     reg_ac_data *aho=(reg_ac_data*)ri->data->data[n];
19747 #ifdef USE_ITHREADS
19748                     dVAR;
19749 #endif
19750                     OP_REFCNT_LOCK;
19751                     refcount = --aho->refcount;
19752                     OP_REFCNT_UNLOCK;
19753                     if ( !refcount ) {
19754                         PerlMemShared_free(aho->states);
19755                         PerlMemShared_free(aho->fail);
19756                          /* do this last!!!! */
19757                         PerlMemShared_free(ri->data->data[n]);
19758                         /* we should only ever get called once, so
19759                          * assert as much, and also guard the free
19760                          * which /might/ happen twice. At the least
19761                          * it will make code anlyzers happy and it
19762                          * doesn't cost much. - Yves */
19763                         assert(ri->regstclass);
19764                         if (ri->regstclass) {
19765                             PerlMemShared_free(ri->regstclass);
19766                             ri->regstclass = 0;
19767                         }
19768                     }
19769                 }
19770                 break;
19771             case 't':
19772                 {
19773                     /* trie structure. */
19774                     U32 refcount;
19775                     reg_trie_data *trie=(reg_trie_data*)ri->data->data[n];
19776 #ifdef USE_ITHREADS
19777                     dVAR;
19778 #endif
19779                     OP_REFCNT_LOCK;
19780                     refcount = --trie->refcount;
19781                     OP_REFCNT_UNLOCK;
19782                     if ( !refcount ) {
19783                         PerlMemShared_free(trie->charmap);
19784                         PerlMemShared_free(trie->states);
19785                         PerlMemShared_free(trie->trans);
19786                         if (trie->bitmap)
19787                             PerlMemShared_free(trie->bitmap);
19788                         if (trie->jump)
19789                             PerlMemShared_free(trie->jump);
19790                         PerlMemShared_free(trie->wordinfo);
19791                         /* do this last!!!! */
19792                         PerlMemShared_free(ri->data->data[n]);
19793                     }
19794                 }
19795                 break;
19796             default:
19797                 Perl_croak(aTHX_ "panic: regfree data code '%c'",
19798                                                     ri->data->what[n]);
19799             }
19800         }
19801         Safefree(ri->data->what);
19802         Safefree(ri->data);
19803     }
19804
19805     Safefree(ri);
19806 }
19807
19808 #define av_dup_inc(s,t) MUTABLE_AV(sv_dup_inc((const SV *)s,t))
19809 #define hv_dup_inc(s,t) MUTABLE_HV(sv_dup_inc((const SV *)s,t))
19810 #define SAVEPVN(p,n)    ((p) ? savepvn(p,n) : NULL)
19811
19812 /*
19813    re_dup_guts - duplicate a regexp.
19814
19815    This routine is expected to clone a given regexp structure. It is only
19816    compiled under USE_ITHREADS.
19817
19818    After all of the core data stored in struct regexp is duplicated
19819    the regexp_engine.dupe method is used to copy any private data
19820    stored in the *pprivate pointer. This allows extensions to handle
19821    any duplication it needs to do.
19822
19823    See pregfree() and regfree_internal() if you change anything here.
19824 */
19825 #if defined(USE_ITHREADS)
19826 #ifndef PERL_IN_XSUB_RE
19827 void
19828 Perl_re_dup_guts(pTHX_ const REGEXP *sstr, REGEXP *dstr, CLONE_PARAMS *param)
19829 {
19830     dVAR;
19831     I32 npar;
19832     const struct regexp *r = ReANY(sstr);
19833     struct regexp *ret = ReANY(dstr);
19834
19835     PERL_ARGS_ASSERT_RE_DUP_GUTS;
19836
19837     npar = r->nparens+1;
19838     Newx(ret->offs, npar, regexp_paren_pair);
19839     Copy(r->offs, ret->offs, npar, regexp_paren_pair);
19840
19841     if (ret->substrs) {
19842         /* Do it this way to avoid reading from *r after the StructCopy().
19843            That way, if any of the sv_dup_inc()s dislodge *r from the L1
19844            cache, it doesn't matter.  */
19845         int i;
19846         const bool anchored = r->check_substr
19847             ? r->check_substr == r->substrs->data[0].substr
19848             : r->check_utf8   == r->substrs->data[0].utf8_substr;
19849         Newx(ret->substrs, 1, struct reg_substr_data);
19850         StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
19851
19852         for (i = 0; i < 2; i++) {
19853             ret->substrs->data[i].substr =
19854                         sv_dup_inc(ret->substrs->data[i].substr, param);
19855             ret->substrs->data[i].utf8_substr =
19856                         sv_dup_inc(ret->substrs->data[i].utf8_substr, param);
19857         }
19858
19859         /* check_substr and check_utf8, if non-NULL, point to either their
19860            anchored or float namesakes, and don't hold a second reference.  */
19861
19862         if (ret->check_substr) {
19863             if (anchored) {
19864                 assert(r->check_utf8 == r->substrs->data[0].utf8_substr);
19865
19866                 ret->check_substr = ret->substrs->data[0].substr;
19867                 ret->check_utf8   = ret->substrs->data[0].utf8_substr;
19868             } else {
19869                 assert(r->check_substr == r->substrs->data[1].substr);
19870                 assert(r->check_utf8   == r->substrs->data[1].utf8_substr);
19871
19872                 ret->check_substr = ret->substrs->data[1].substr;
19873                 ret->check_utf8   = ret->substrs->data[1].utf8_substr;
19874             }
19875         } else if (ret->check_utf8) {
19876             if (anchored) {
19877                 ret->check_utf8 = ret->substrs->data[0].utf8_substr;
19878             } else {
19879                 ret->check_utf8 = ret->substrs->data[1].utf8_substr;
19880             }
19881         }
19882     }
19883
19884     RXp_PAREN_NAMES(ret) = hv_dup_inc(RXp_PAREN_NAMES(ret), param);
19885     ret->qr_anoncv = MUTABLE_CV(sv_dup_inc((const SV *)ret->qr_anoncv, param));
19886     if (r->recurse_locinput)
19887         Newx(ret->recurse_locinput,r->nparens + 1,char *);
19888
19889     if (ret->pprivate)
19890         RXi_SET(ret,CALLREGDUPE_PVT(dstr,param));
19891
19892     if (RX_MATCH_COPIED(dstr))
19893         ret->subbeg  = SAVEPVN(ret->subbeg, ret->sublen);
19894     else
19895         ret->subbeg = NULL;
19896 #ifdef PERL_ANY_COW
19897     ret->saved_copy = NULL;
19898 #endif
19899
19900     /* Whether mother_re be set or no, we need to copy the string.  We
19901        cannot refrain from copying it when the storage points directly to
19902        our mother regexp, because that's
19903                1: a buffer in a different thread
19904                2: something we no longer hold a reference on
19905                so we need to copy it locally.  */
19906     RX_WRAPPED(dstr) = SAVEPVN(RX_WRAPPED_const(sstr), SvCUR(sstr)+1);
19907     ret->mother_re   = NULL;
19908 }
19909 #endif /* PERL_IN_XSUB_RE */
19910
19911 /*
19912    regdupe_internal()
19913
19914    This is the internal complement to regdupe() which is used to copy
19915    the structure pointed to by the *pprivate pointer in the regexp.
19916    This is the core version of the extension overridable cloning hook.
19917    The regexp structure being duplicated will be copied by perl prior
19918    to this and will be provided as the regexp *r argument, however
19919    with the /old/ structures pprivate pointer value. Thus this routine
19920    may override any copying normally done by perl.
19921
19922    It returns a pointer to the new regexp_internal structure.
19923 */
19924
19925 void *
19926 Perl_regdupe_internal(pTHX_ REGEXP * const rx, CLONE_PARAMS *param)
19927 {
19928     dVAR;
19929     struct regexp *const r = ReANY(rx);
19930     regexp_internal *reti;
19931     int len;
19932     RXi_GET_DECL(r,ri);
19933
19934     PERL_ARGS_ASSERT_REGDUPE_INTERNAL;
19935
19936     len = ProgLen(ri);
19937
19938     Newxc(reti, sizeof(regexp_internal) + len*sizeof(regnode),
19939           char, regexp_internal);
19940     Copy(ri->program, reti->program, len+1, regnode);
19941
19942
19943     if (ri->code_blocks) {
19944         int n;
19945         Newx(reti->code_blocks, 1, struct reg_code_blocks);
19946         Newx(reti->code_blocks->cb, ri->code_blocks->count,
19947                     struct reg_code_block);
19948         Copy(ri->code_blocks->cb, reti->code_blocks->cb,
19949              ri->code_blocks->count, struct reg_code_block);
19950         for (n = 0; n < ri->code_blocks->count; n++)
19951              reti->code_blocks->cb[n].src_regex = (REGEXP*)
19952                     sv_dup_inc((SV*)(ri->code_blocks->cb[n].src_regex), param);
19953         reti->code_blocks->count = ri->code_blocks->count;
19954         reti->code_blocks->refcnt = 1;
19955     }
19956     else
19957         reti->code_blocks = NULL;
19958
19959     reti->regstclass = NULL;
19960
19961     if (ri->data) {
19962         struct reg_data *d;
19963         const int count = ri->data->count;
19964         int i;
19965
19966         Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
19967                 char, struct reg_data);
19968         Newx(d->what, count, U8);
19969
19970         d->count = count;
19971         for (i = 0; i < count; i++) {
19972             d->what[i] = ri->data->what[i];
19973             switch (d->what[i]) {
19974                 /* see also regcomp.h and regfree_internal() */
19975             case 'a': /* actually an AV, but the dup function is identical.
19976                          values seem to be "plain sv's" generally. */
19977             case 'r': /* a compiled regex (but still just another SV) */
19978             case 's': /* an RV (currently only used for an RV to an AV by the ANYOF code)
19979                          this use case should go away, the code could have used
19980                          'a' instead - see S_set_ANYOF_arg() for array contents. */
19981             case 'S': /* actually an SV, but the dup function is identical.  */
19982             case 'u': /* actually an HV, but the dup function is identical.
19983                          values are "plain sv's" */
19984                 d->data[i] = sv_dup_inc((const SV *)ri->data->data[i], param);
19985                 break;
19986             case 'f':
19987                 /* Synthetic Start Class - "Fake" charclass we generate to optimize
19988                  * patterns which could start with several different things. Pre-TRIE
19989                  * this was more important than it is now, however this still helps
19990                  * in some places, for instance /x?a+/ might produce a SSC equivalent
19991                  * to [xa]. This is used by Perl_re_intuit_start() and S_find_byclass()
19992                  * in regexec.c
19993                  */
19994                 /* This is cheating. */
19995                 Newx(d->data[i], 1, regnode_ssc);
19996                 StructCopy(ri->data->data[i], d->data[i], regnode_ssc);
19997                 reti->regstclass = (regnode*)d->data[i];
19998                 break;
19999             case 'T':
20000                 /* AHO-CORASICK fail table */
20001                 /* Trie stclasses are readonly and can thus be shared
20002                  * without duplication. We free the stclass in pregfree
20003                  * when the corresponding reg_ac_data struct is freed.
20004                  */
20005                 reti->regstclass= ri->regstclass;
20006                 /* FALLTHROUGH */
20007             case 't':
20008                 /* TRIE transition table */
20009                 OP_REFCNT_LOCK;
20010                 ((reg_trie_data*)ri->data->data[i])->refcount++;
20011                 OP_REFCNT_UNLOCK;
20012                 /* FALLTHROUGH */
20013             case 'l': /* (?{...}) or (??{ ... }) code (cb->block) */
20014             case 'L': /* same when RExC_pm_flags & PMf_HAS_CV and code
20015                          is not from another regexp */
20016                 d->data[i] = ri->data->data[i];
20017                 break;
20018             default:
20019                 Perl_croak(aTHX_ "panic: re_dup_guts unknown data code '%c'",
20020                                                            ri->data->what[i]);
20021             }
20022         }
20023
20024         reti->data = d;
20025     }
20026     else
20027         reti->data = NULL;
20028
20029     reti->name_list_idx = ri->name_list_idx;
20030
20031 #ifdef RE_TRACK_PATTERN_OFFSETS
20032     if (ri->u.offsets) {
20033         Newx(reti->u.offsets, 2*len+1, U32);
20034         Copy(ri->u.offsets, reti->u.offsets, 2*len+1, U32);
20035     }
20036 #else
20037     SetProgLen(reti,len);
20038 #endif
20039
20040     return (void*)reti;
20041 }
20042
20043 #endif    /* USE_ITHREADS */
20044
20045 #ifndef PERL_IN_XSUB_RE
20046
20047 /*
20048  - regnext - dig the "next" pointer out of a node
20049  */
20050 regnode *
20051 Perl_regnext(pTHX_ regnode *p)
20052 {
20053     I32 offset;
20054
20055     if (!p)
20056         return(NULL);
20057
20058     if (OP(p) > REGNODE_MAX) {          /* regnode.type is unsigned */
20059         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d",
20060                                                 (int)OP(p), (int)REGNODE_MAX);
20061     }
20062
20063     offset = (reg_off_by_arg[OP(p)] ? ARG(p) : NEXT_OFF(p));
20064     if (offset == 0)
20065         return(NULL);
20066
20067     return(p+offset);
20068 }
20069 #endif
20070
20071 STATIC void
20072 S_re_croak2(pTHX_ bool utf8, const char* pat1,const char* pat2,...)
20073 {
20074     va_list args;
20075     STRLEN l1 = strlen(pat1);
20076     STRLEN l2 = strlen(pat2);
20077     char buf[512];
20078     SV *msv;
20079     const char *message;
20080
20081     PERL_ARGS_ASSERT_RE_CROAK2;
20082
20083     if (l1 > 510)
20084         l1 = 510;
20085     if (l1 + l2 > 510)
20086         l2 = 510 - l1;
20087     Copy(pat1, buf, l1 , char);
20088     Copy(pat2, buf + l1, l2 , char);
20089     buf[l1 + l2] = '\n';
20090     buf[l1 + l2 + 1] = '\0';
20091     va_start(args, pat2);
20092     msv = vmess(buf, &args);
20093     va_end(args);
20094     message = SvPV_const(msv,l1);
20095     if (l1 > 512)
20096         l1 = 512;
20097     Copy(message, buf, l1 , char);
20098     /* l1-1 to avoid \n */
20099     Perl_croak(aTHX_ "%" UTF8f, UTF8fARG(utf8, l1-1, buf));
20100 }
20101
20102 /* XXX Here's a total kludge.  But we need to re-enter for swash routines. */
20103
20104 #ifndef PERL_IN_XSUB_RE
20105 void
20106 Perl_save_re_context(pTHX)
20107 {
20108     I32 nparens = -1;
20109     I32 i;
20110
20111     /* Save $1..$n (#18107: UTF-8 s/(\w+)/uc($1)/e); AMS 20021106. */
20112
20113     if (PL_curpm) {
20114         const REGEXP * const rx = PM_GETRE(PL_curpm);
20115         if (rx)
20116             nparens = RX_NPARENS(rx);
20117     }
20118
20119     /* RT #124109. This is a complete hack; in the SWASHNEW case we know
20120      * that PL_curpm will be null, but that utf8.pm and the modules it
20121      * loads will only use $1..$3.
20122      * The t/porting/re_context.t test file checks this assumption.
20123      */
20124     if (nparens == -1)
20125         nparens = 3;
20126
20127     for (i = 1; i <= nparens; i++) {
20128         char digits[TYPE_CHARS(long)];
20129         const STRLEN len = my_snprintf(digits, sizeof(digits),
20130                                        "%lu", (long)i);
20131         GV *const *const gvp
20132             = (GV**)hv_fetch(PL_defstash, digits, len, 0);
20133
20134         if (gvp) {
20135             GV * const gv = *gvp;
20136             if (SvTYPE(gv) == SVt_PVGV && GvSV(gv))
20137                 save_scalar(gv);
20138         }
20139     }
20140 }
20141 #endif
20142
20143 #ifdef DEBUGGING
20144
20145 STATIC void
20146 S_put_code_point(pTHX_ SV *sv, UV c)
20147 {
20148     PERL_ARGS_ASSERT_PUT_CODE_POINT;
20149
20150     if (c > 255) {
20151         Perl_sv_catpvf(aTHX_ sv, "\\x{%04" UVXf "}", c);
20152     }
20153     else if (isPRINT(c)) {
20154         const char string = (char) c;
20155
20156         /* We use {phrase} as metanotation in the class, so also escape literal
20157          * braces */
20158         if (isBACKSLASHED_PUNCT(c) || c == '{' || c == '}')
20159             sv_catpvs(sv, "\\");
20160         sv_catpvn(sv, &string, 1);
20161     }
20162     else if (isMNEMONIC_CNTRL(c)) {
20163         Perl_sv_catpvf(aTHX_ sv, "%s", cntrl_to_mnemonic((U8) c));
20164     }
20165     else {
20166         Perl_sv_catpvf(aTHX_ sv, "\\x%02X", (U8) c);
20167     }
20168 }
20169
20170 #define MAX_PRINT_A MAX_PRINT_A_FOR_USE_ONLY_BY_REGCOMP_DOT_C
20171
20172 STATIC void
20173 S_put_range(pTHX_ SV *sv, UV start, const UV end, const bool allow_literals)
20174 {
20175     /* Appends to 'sv' a displayable version of the range of code points from
20176      * 'start' to 'end'.  Mnemonics (like '\r') are used for the few controls
20177      * that have them, when they occur at the beginning or end of the range.
20178      * It uses hex to output the remaining code points, unless 'allow_literals'
20179      * is true, in which case the printable ASCII ones are output as-is (though
20180      * some of these will be escaped by put_code_point()).
20181      *
20182      * NOTE:  This is designed only for printing ranges of code points that fit
20183      *        inside an ANYOF bitmap.  Higher code points are simply suppressed
20184      */
20185
20186     const unsigned int min_range_count = 3;
20187
20188     assert(start <= end);
20189
20190     PERL_ARGS_ASSERT_PUT_RANGE;
20191
20192     while (start <= end) {
20193         UV this_end;
20194         const char * format;
20195
20196         if (end - start < min_range_count) {
20197
20198             /* Output chars individually when they occur in short ranges */
20199             for (; start <= end; start++) {
20200                 put_code_point(sv, start);
20201             }
20202             break;
20203         }
20204
20205         /* If permitted by the input options, and there is a possibility that
20206          * this range contains a printable literal, look to see if there is
20207          * one. */
20208         if (allow_literals && start <= MAX_PRINT_A) {
20209
20210             /* If the character at the beginning of the range isn't an ASCII
20211              * printable, effectively split the range into two parts:
20212              *  1) the portion before the first such printable,
20213              *  2) the rest
20214              * and output them separately. */
20215             if (! isPRINT_A(start)) {
20216                 UV temp_end = start + 1;
20217
20218                 /* There is no point looking beyond the final possible
20219                  * printable, in MAX_PRINT_A */
20220                 UV max = MIN(end, MAX_PRINT_A);
20221
20222                 while (temp_end <= max && ! isPRINT_A(temp_end)) {
20223                     temp_end++;
20224                 }
20225
20226                 /* Here, temp_end points to one beyond the first printable if
20227                  * found, or to one beyond 'max' if not.  If none found, make
20228                  * sure that we use the entire range */
20229                 if (temp_end > MAX_PRINT_A) {
20230                     temp_end = end + 1;
20231                 }
20232
20233                 /* Output the first part of the split range: the part that
20234                  * doesn't have printables, with the parameter set to not look
20235                  * for literals (otherwise we would infinitely recurse) */
20236                 put_range(sv, start, temp_end - 1, FALSE);
20237
20238                 /* The 2nd part of the range (if any) starts here. */
20239                 start = temp_end;
20240
20241                 /* We do a continue, instead of dropping down, because even if
20242                  * the 2nd part is non-empty, it could be so short that we want
20243                  * to output it as individual characters, as tested for at the
20244                  * top of this loop.  */
20245                 continue;
20246             }
20247
20248             /* Here, 'start' is a printable ASCII.  If it is an alphanumeric,
20249              * output a sub-range of just the digits or letters, then process
20250              * the remaining portion as usual. */
20251             if (isALPHANUMERIC_A(start)) {
20252                 UV mask = (isDIGIT_A(start))
20253                            ? _CC_DIGIT
20254                              : isUPPER_A(start)
20255                                ? _CC_UPPER
20256                                : _CC_LOWER;
20257                 UV temp_end = start + 1;
20258
20259                 /* Find the end of the sub-range that includes just the
20260                  * characters in the same class as the first character in it */
20261                 while (temp_end <= end && _generic_isCC_A(temp_end, mask)) {
20262                     temp_end++;
20263                 }
20264                 temp_end--;
20265
20266                 /* For short ranges, don't duplicate the code above to output
20267                  * them; just call recursively */
20268                 if (temp_end - start < min_range_count) {
20269                     put_range(sv, start, temp_end, FALSE);
20270                 }
20271                 else {  /* Output as a range */
20272                     put_code_point(sv, start);
20273                     sv_catpvs(sv, "-");
20274                     put_code_point(sv, temp_end);
20275                 }
20276                 start = temp_end + 1;
20277                 continue;
20278             }
20279
20280             /* We output any other printables as individual characters */
20281             if (isPUNCT_A(start) || isSPACE_A(start)) {
20282                 while (start <= end && (isPUNCT_A(start)
20283                                         || isSPACE_A(start)))
20284                 {
20285                     put_code_point(sv, start);
20286                     start++;
20287                 }
20288                 continue;
20289             }
20290         } /* End of looking for literals */
20291
20292         /* Here is not to output as a literal.  Some control characters have
20293          * mnemonic names.  Split off any of those at the beginning and end of
20294          * the range to print mnemonically.  It isn't possible for many of
20295          * these to be in a row, so this won't overwhelm with output */
20296         if (   start <= end
20297             && (isMNEMONIC_CNTRL(start) || isMNEMONIC_CNTRL(end)))
20298         {
20299             while (isMNEMONIC_CNTRL(start) && start <= end) {
20300                 put_code_point(sv, start);
20301                 start++;
20302             }
20303
20304             /* If this didn't take care of the whole range ... */
20305             if (start <= end) {
20306
20307                 /* Look backwards from the end to find the final non-mnemonic
20308                  * */
20309                 UV temp_end = end;
20310                 while (isMNEMONIC_CNTRL(temp_end)) {
20311                     temp_end--;
20312                 }
20313
20314                 /* And separately output the interior range that doesn't start
20315                  * or end with mnemonics */
20316                 put_range(sv, start, temp_end, FALSE);
20317
20318                 /* Then output the mnemonic trailing controls */
20319                 start = temp_end + 1;
20320                 while (start <= end) {
20321                     put_code_point(sv, start);
20322                     start++;
20323                 }
20324                 break;
20325             }
20326         }
20327
20328         /* As a final resort, output the range or subrange as hex. */
20329
20330         this_end = (end < NUM_ANYOF_CODE_POINTS)
20331                     ? end
20332                     : NUM_ANYOF_CODE_POINTS - 1;
20333 #if NUM_ANYOF_CODE_POINTS > 256
20334         format = (this_end < 256)
20335                  ? "\\x%02" UVXf "-\\x%02" UVXf
20336                  : "\\x{%04" UVXf "}-\\x{%04" UVXf "}";
20337 #else
20338         format = "\\x%02" UVXf "-\\x%02" UVXf;
20339 #endif
20340         GCC_DIAG_IGNORE(-Wformat-nonliteral);
20341         Perl_sv_catpvf(aTHX_ sv, format, start, this_end);
20342         GCC_DIAG_RESTORE;
20343         break;
20344     }
20345 }
20346
20347 STATIC void
20348 S_put_charclass_bitmap_innards_invlist(pTHX_ SV *sv, SV* invlist)
20349 {
20350     /* Concatenate onto the PV in 'sv' a displayable form of the inversion list
20351      * 'invlist' */
20352
20353     UV start, end;
20354     bool allow_literals = TRUE;
20355
20356     PERL_ARGS_ASSERT_PUT_CHARCLASS_BITMAP_INNARDS_INVLIST;
20357
20358     /* Generally, it is more readable if printable characters are output as
20359      * literals, but if a range (nearly) spans all of them, it's best to output
20360      * it as a single range.  This code will use a single range if all but 2
20361      * ASCII printables are in it */
20362     invlist_iterinit(invlist);
20363     while (invlist_iternext(invlist, &start, &end)) {
20364
20365         /* If the range starts beyond the final printable, it doesn't have any
20366          * in it */
20367         if (start > MAX_PRINT_A) {
20368             break;
20369         }
20370
20371         /* In both ASCII and EBCDIC, a SPACE is the lowest printable.  To span
20372          * all but two, the range must start and end no later than 2 from
20373          * either end */
20374         if (start < ' ' + 2 && end > MAX_PRINT_A - 2) {
20375             if (end > MAX_PRINT_A) {
20376                 end = MAX_PRINT_A;
20377             }
20378             if (start < ' ') {
20379                 start = ' ';
20380             }
20381             if (end - start >= MAX_PRINT_A - ' ' - 2) {
20382                 allow_literals = FALSE;
20383             }
20384             break;
20385         }
20386     }
20387     invlist_iterfinish(invlist);
20388
20389     /* Here we have figured things out.  Output each range */
20390     invlist_iterinit(invlist);
20391     while (invlist_iternext(invlist, &start, &end)) {
20392         if (start >= NUM_ANYOF_CODE_POINTS) {
20393             break;
20394         }
20395         put_range(sv, start, end, allow_literals);
20396     }
20397     invlist_iterfinish(invlist);
20398
20399     return;
20400 }
20401
20402 STATIC SV*
20403 S_put_charclass_bitmap_innards_common(pTHX_
20404         SV* invlist,            /* The bitmap */
20405         SV* posixes,            /* Under /l, things like [:word:], \S */
20406         SV* only_utf8,          /* Under /d, matches iff the target is UTF-8 */
20407         SV* not_utf8,           /* /d, matches iff the target isn't UTF-8 */
20408         SV* only_utf8_locale,   /* Under /l, matches if the locale is UTF-8 */
20409         const bool invert       /* Is the result to be inverted? */
20410 )
20411 {
20412     /* Create and return an SV containing a displayable version of the bitmap
20413      * and associated information determined by the input parameters.  If the
20414      * output would have been only the inversion indicator '^', NULL is instead
20415      * returned. */
20416
20417     SV * output;
20418
20419     PERL_ARGS_ASSERT_PUT_CHARCLASS_BITMAP_INNARDS_COMMON;
20420
20421     if (invert) {
20422         output = newSVpvs("^");
20423     }
20424     else {
20425         output = newSVpvs("");
20426     }
20427
20428     /* First, the code points in the bitmap that are unconditionally there */
20429     put_charclass_bitmap_innards_invlist(output, invlist);
20430
20431     /* Traditionally, these have been placed after the main code points */
20432     if (posixes) {
20433         sv_catsv(output, posixes);
20434     }
20435
20436     if (only_utf8 && _invlist_len(only_utf8)) {
20437         Perl_sv_catpvf(aTHX_ output, "%s{utf8}%s", PL_colors[1], PL_colors[0]);
20438         put_charclass_bitmap_innards_invlist(output, only_utf8);
20439     }
20440
20441     if (not_utf8 && _invlist_len(not_utf8)) {
20442         Perl_sv_catpvf(aTHX_ output, "%s{not utf8}%s", PL_colors[1], PL_colors[0]);
20443         put_charclass_bitmap_innards_invlist(output, not_utf8);
20444     }
20445
20446     if (only_utf8_locale && _invlist_len(only_utf8_locale)) {
20447         Perl_sv_catpvf(aTHX_ output, "%s{utf8 locale}%s", PL_colors[1], PL_colors[0]);
20448         put_charclass_bitmap_innards_invlist(output, only_utf8_locale);
20449
20450         /* This is the only list in this routine that can legally contain code
20451          * points outside the bitmap range.  The call just above to
20452          * 'put_charclass_bitmap_innards_invlist' will simply suppress them, so
20453          * output them here.  There's about a half-dozen possible, and none in
20454          * contiguous ranges longer than 2 */
20455         if (invlist_highest(only_utf8_locale) >= NUM_ANYOF_CODE_POINTS) {
20456             UV start, end;
20457             SV* above_bitmap = NULL;
20458
20459             _invlist_subtract(only_utf8_locale, PL_InBitmap, &above_bitmap);
20460
20461             invlist_iterinit(above_bitmap);
20462             while (invlist_iternext(above_bitmap, &start, &end)) {
20463                 UV i;
20464
20465                 for (i = start; i <= end; i++) {
20466                     put_code_point(output, i);
20467                 }
20468             }
20469             invlist_iterfinish(above_bitmap);
20470             SvREFCNT_dec_NN(above_bitmap);
20471         }
20472     }
20473
20474     if (invert && SvCUR(output) == 1) {
20475         return NULL;
20476     }
20477
20478     return output;
20479 }
20480
20481 STATIC bool
20482 S_put_charclass_bitmap_innards(pTHX_ SV *sv,
20483                                      char *bitmap,
20484                                      SV *nonbitmap_invlist,
20485                                      SV *only_utf8_locale_invlist,
20486                                      const regnode * const node,
20487                                      const bool force_as_is_display)
20488 {
20489     /* Appends to 'sv' a displayable version of the innards of the bracketed
20490      * character class defined by the other arguments:
20491      *  'bitmap' points to the bitmap.
20492      *  'nonbitmap_invlist' is an inversion list of the code points that are in
20493      *      the bitmap range, but for some reason aren't in the bitmap; NULL if
20494      *      none.  The reasons for this could be that they require some
20495      *      condition such as the target string being or not being in UTF-8
20496      *      (under /d), or because they came from a user-defined property that
20497      *      was not resolved at the time of the regex compilation (under /u)
20498      *  'only_utf8_locale_invlist' is an inversion list of the code points that
20499      *      are valid only if the runtime locale is a UTF-8 one; NULL if none
20500      *  'node' is the regex pattern node.  It is needed only when the above two
20501      *      parameters are not null, and is passed so that this routine can
20502      *      tease apart the various reasons for them.
20503      *  'force_as_is_display' is TRUE if this routine should definitely NOT try
20504      *      to invert things to see if that leads to a cleaner display.  If
20505      *      FALSE, this routine is free to use its judgment about doing this.
20506      *
20507      * It returns TRUE if there was actually something output.  (It may be that
20508      * the bitmap, etc is empty.)
20509      *
20510      * When called for outputting the bitmap of a non-ANYOF node, just pass the
20511      * bitmap, with the succeeding parameters set to NULL, and the final one to
20512      * FALSE.
20513      */
20514
20515     /* In general, it tries to display the 'cleanest' representation of the
20516      * innards, choosing whether to display them inverted or not, regardless of
20517      * whether the class itself is to be inverted.  However,  there are some
20518      * cases where it can't try inverting, as what actually matches isn't known
20519      * until runtime, and hence the inversion isn't either. */
20520     bool inverting_allowed = ! force_as_is_display;
20521
20522     int i;
20523     STRLEN orig_sv_cur = SvCUR(sv);
20524
20525     SV* invlist;            /* Inversion list we accumulate of code points that
20526                                are unconditionally matched */
20527     SV* only_utf8 = NULL;   /* Under /d, list of matches iff the target is
20528                                UTF-8 */
20529     SV* not_utf8 =  NULL;   /* /d, list of matches iff the target isn't UTF-8
20530                              */
20531     SV* posixes = NULL;     /* Under /l, string of things like [:word:], \D */
20532     SV* only_utf8_locale = NULL;    /* Under /l, list of matches if the locale
20533                                        is UTF-8 */
20534
20535     SV* as_is_display;      /* The output string when we take the inputs
20536                                literally */
20537     SV* inverted_display;   /* The output string when we invert the inputs */
20538
20539     U8 flags = (node) ? ANYOF_FLAGS(node) : 0;
20540
20541     bool invert = cBOOL(flags & ANYOF_INVERT);  /* Is the input to be inverted
20542                                                    to match? */
20543     /* We are biased in favor of displaying things without them being inverted,
20544      * as that is generally easier to understand */
20545     const int bias = 5;
20546
20547     PERL_ARGS_ASSERT_PUT_CHARCLASS_BITMAP_INNARDS;
20548
20549     /* Start off with whatever code points are passed in.  (We clone, so we
20550      * don't change the caller's list) */
20551     if (nonbitmap_invlist) {
20552         assert(invlist_highest(nonbitmap_invlist) < NUM_ANYOF_CODE_POINTS);
20553         invlist = invlist_clone(nonbitmap_invlist);
20554     }
20555     else {  /* Worst case size is every other code point is matched */
20556         invlist = _new_invlist(NUM_ANYOF_CODE_POINTS / 2);
20557     }
20558
20559     if (flags) {
20560         if (OP(node) == ANYOFD) {
20561
20562             /* This flag indicates that the code points below 0x100 in the
20563              * nonbitmap list are precisely the ones that match only when the
20564              * target is UTF-8 (they should all be non-ASCII). */
20565             if (flags & ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP)
20566             {
20567                 _invlist_intersection(invlist, PL_UpperLatin1, &only_utf8);
20568                 _invlist_subtract(invlist, only_utf8, &invlist);
20569             }
20570
20571             /* And this flag for matching all non-ASCII 0xFF and below */
20572             if (flags & ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER)
20573             {
20574                 not_utf8 = invlist_clone(PL_UpperLatin1);
20575             }
20576         }
20577         else if (OP(node) == ANYOFL) {
20578
20579             /* If either of these flags are set, what matches isn't
20580              * determinable except during execution, so don't know enough here
20581              * to invert */
20582             if (flags & (ANYOFL_FOLD|ANYOF_MATCHES_POSIXL)) {
20583                 inverting_allowed = FALSE;
20584             }
20585
20586             /* What the posix classes match also varies at runtime, so these
20587              * will be output symbolically. */
20588             if (ANYOF_POSIXL_TEST_ANY_SET(node)) {
20589                 int i;
20590
20591                 posixes = newSVpvs("");
20592                 for (i = 0; i < ANYOF_POSIXL_MAX; i++) {
20593                     if (ANYOF_POSIXL_TEST(node,i)) {
20594                         sv_catpv(posixes, anyofs[i]);
20595                     }
20596                 }
20597             }
20598         }
20599     }
20600
20601     /* Accumulate the bit map into the unconditional match list */
20602     for (i = 0; i < NUM_ANYOF_CODE_POINTS; i++) {
20603         if (BITMAP_TEST(bitmap, i)) {
20604             int start = i++;
20605             for (; i < NUM_ANYOF_CODE_POINTS && BITMAP_TEST(bitmap, i); i++) {
20606                 /* empty */
20607             }
20608             invlist = _add_range_to_invlist(invlist, start, i-1);
20609         }
20610     }
20611
20612     /* Make sure that the conditional match lists don't have anything in them
20613      * that match unconditionally; otherwise the output is quite confusing.
20614      * This could happen if the code that populates these misses some
20615      * duplication. */
20616     if (only_utf8) {
20617         _invlist_subtract(only_utf8, invlist, &only_utf8);
20618     }
20619     if (not_utf8) {
20620         _invlist_subtract(not_utf8, invlist, &not_utf8);
20621     }
20622
20623     if (only_utf8_locale_invlist) {
20624
20625         /* Since this list is passed in, we have to make a copy before
20626          * modifying it */
20627         only_utf8_locale = invlist_clone(only_utf8_locale_invlist);
20628
20629         _invlist_subtract(only_utf8_locale, invlist, &only_utf8_locale);
20630
20631         /* And, it can get really weird for us to try outputting an inverted
20632          * form of this list when it has things above the bitmap, so don't even
20633          * try */
20634         if (invlist_highest(only_utf8_locale) >= NUM_ANYOF_CODE_POINTS) {
20635             inverting_allowed = FALSE;
20636         }
20637     }
20638
20639     /* Calculate what the output would be if we take the input as-is */
20640     as_is_display = put_charclass_bitmap_innards_common(invlist,
20641                                                     posixes,
20642                                                     only_utf8,
20643                                                     not_utf8,
20644                                                     only_utf8_locale,
20645                                                     invert);
20646
20647     /* If have to take the output as-is, just do that */
20648     if (! inverting_allowed) {
20649         if (as_is_display) {
20650             sv_catsv(sv, as_is_display);
20651             SvREFCNT_dec_NN(as_is_display);
20652         }
20653     }
20654     else { /* But otherwise, create the output again on the inverted input, and
20655               use whichever version is shorter */
20656
20657         int inverted_bias, as_is_bias;
20658
20659         /* We will apply our bias to whichever of the the results doesn't have
20660          * the '^' */
20661         if (invert) {
20662             invert = FALSE;
20663             as_is_bias = bias;
20664             inverted_bias = 0;
20665         }
20666         else {
20667             invert = TRUE;
20668             as_is_bias = 0;
20669             inverted_bias = bias;
20670         }
20671
20672         /* Now invert each of the lists that contribute to the output,
20673          * excluding from the result things outside the possible range */
20674
20675         /* For the unconditional inversion list, we have to add in all the
20676          * conditional code points, so that when inverted, they will be gone
20677          * from it */
20678         _invlist_union(only_utf8, invlist, &invlist);
20679         _invlist_union(not_utf8, invlist, &invlist);
20680         _invlist_union(only_utf8_locale, invlist, &invlist);
20681         _invlist_invert(invlist);
20682         _invlist_intersection(invlist, PL_InBitmap, &invlist);
20683
20684         if (only_utf8) {
20685             _invlist_invert(only_utf8);
20686             _invlist_intersection(only_utf8, PL_UpperLatin1, &only_utf8);
20687         }
20688         else if (not_utf8) {
20689
20690             /* If a code point matches iff the target string is not in UTF-8,
20691              * then complementing the result has it not match iff not in UTF-8,
20692              * which is the same thing as matching iff it is UTF-8. */
20693             only_utf8 = not_utf8;
20694             not_utf8 = NULL;
20695         }
20696
20697         if (only_utf8_locale) {
20698             _invlist_invert(only_utf8_locale);
20699             _invlist_intersection(only_utf8_locale,
20700                                   PL_InBitmap,
20701                                   &only_utf8_locale);
20702         }
20703
20704         inverted_display = put_charclass_bitmap_innards_common(
20705                                             invlist,
20706                                             posixes,
20707                                             only_utf8,
20708                                             not_utf8,
20709                                             only_utf8_locale, invert);
20710
20711         /* Use the shortest representation, taking into account our bias
20712          * against showing it inverted */
20713         if (   inverted_display
20714             && (   ! as_is_display
20715                 || (  SvCUR(inverted_display) + inverted_bias
20716                     < SvCUR(as_is_display)    + as_is_bias)))
20717         {
20718             sv_catsv(sv, inverted_display);
20719         }
20720         else if (as_is_display) {
20721             sv_catsv(sv, as_is_display);
20722         }
20723
20724         SvREFCNT_dec(as_is_display);
20725         SvREFCNT_dec(inverted_display);
20726     }
20727
20728     SvREFCNT_dec_NN(invlist);
20729     SvREFCNT_dec(only_utf8);
20730     SvREFCNT_dec(not_utf8);
20731     SvREFCNT_dec(posixes);
20732     SvREFCNT_dec(only_utf8_locale);
20733
20734     return SvCUR(sv) > orig_sv_cur;
20735 }
20736
20737 #define CLEAR_OPTSTART                                                       \
20738     if (optstart) STMT_START {                                               \
20739         DEBUG_OPTIMISE_r(Perl_re_printf( aTHX_                                           \
20740                               " (%" IVdf " nodes)\n", (IV)(node - optstart))); \
20741         optstart=NULL;                                                       \
20742     } STMT_END
20743
20744 #define DUMPUNTIL(b,e)                                                       \
20745                     CLEAR_OPTSTART;                                          \
20746                     node=dumpuntil(r,start,(b),(e),last,sv,indent+1,depth+1);
20747
20748 STATIC const regnode *
20749 S_dumpuntil(pTHX_ const regexp *r, const regnode *start, const regnode *node,
20750             const regnode *last, const regnode *plast,
20751             SV* sv, I32 indent, U32 depth)
20752 {
20753     U8 op = PSEUDO;     /* Arbitrary non-END op. */
20754     const regnode *next;
20755     const regnode *optstart= NULL;
20756
20757     RXi_GET_DECL(r,ri);
20758     GET_RE_DEBUG_FLAGS_DECL;
20759
20760     PERL_ARGS_ASSERT_DUMPUNTIL;
20761
20762 #ifdef DEBUG_DUMPUNTIL
20763     Perl_re_printf( aTHX_  "--- %d : %d - %d - %d\n",indent,node-start,
20764         last ? last-start : 0,plast ? plast-start : 0);
20765 #endif
20766
20767     if (plast && plast < last)
20768         last= plast;
20769
20770     while (PL_regkind[op] != END && (!last || node < last)) {
20771         assert(node);
20772         /* While that wasn't END last time... */
20773         NODE_ALIGN(node);
20774         op = OP(node);
20775         if (op == CLOSE || op == WHILEM)
20776             indent--;
20777         next = regnext((regnode *)node);
20778
20779         /* Where, what. */
20780         if (OP(node) == OPTIMIZED) {
20781             if (!optstart && RE_DEBUG_FLAG(RE_DEBUG_COMPILE_OPTIMISE))
20782                 optstart = node;
20783             else
20784                 goto after_print;
20785         } else
20786             CLEAR_OPTSTART;
20787
20788         regprop(r, sv, node, NULL, NULL);
20789         Perl_re_printf( aTHX_  "%4" IVdf ":%*s%s", (IV)(node - start),
20790                       (int)(2*indent + 1), "", SvPVX_const(sv));
20791
20792         if (OP(node) != OPTIMIZED) {
20793             if (next == NULL)           /* Next ptr. */
20794                 Perl_re_printf( aTHX_  " (0)");
20795             else if (PL_regkind[(U8)op] == BRANCH
20796                      && PL_regkind[OP(next)] != BRANCH )
20797                 Perl_re_printf( aTHX_  " (FAIL)");
20798             else
20799                 Perl_re_printf( aTHX_  " (%" IVdf ")", (IV)(next - start));
20800             Perl_re_printf( aTHX_ "\n");
20801         }
20802
20803       after_print:
20804         if (PL_regkind[(U8)op] == BRANCHJ) {
20805             assert(next);
20806             {
20807                 const regnode *nnode = (OP(next) == LONGJMP
20808                                        ? regnext((regnode *)next)
20809                                        : next);
20810                 if (last && nnode > last)
20811                     nnode = last;
20812                 DUMPUNTIL(NEXTOPER(NEXTOPER(node)), nnode);
20813             }
20814         }
20815         else if (PL_regkind[(U8)op] == BRANCH) {
20816             assert(next);
20817             DUMPUNTIL(NEXTOPER(node), next);
20818         }
20819         else if ( PL_regkind[(U8)op]  == TRIE ) {
20820             const regnode *this_trie = node;
20821             const char op = OP(node);
20822             const U32 n = ARG(node);
20823             const reg_ac_data * const ac = op>=AHOCORASICK ?
20824                (reg_ac_data *)ri->data->data[n] :
20825                NULL;
20826             const reg_trie_data * const trie =
20827                 (reg_trie_data*)ri->data->data[op<AHOCORASICK ? n : ac->trie];
20828 #ifdef DEBUGGING
20829             AV *const trie_words
20830                            = MUTABLE_AV(ri->data->data[n + TRIE_WORDS_OFFSET]);
20831 #endif
20832             const regnode *nextbranch= NULL;
20833             I32 word_idx;
20834             SvPVCLEAR(sv);
20835             for (word_idx= 0; word_idx < (I32)trie->wordcount; word_idx++) {
20836                 SV ** const elem_ptr = av_fetch(trie_words,word_idx,0);
20837
20838                 Perl_re_indentf( aTHX_  "%s ",
20839                     indent+3,
20840                     elem_ptr
20841                     ? pv_pretty(sv, SvPV_nolen_const(*elem_ptr),
20842                                 SvCUR(*elem_ptr), PL_dump_re_max_len,
20843                                 PL_colors[0], PL_colors[1],
20844                                 (SvUTF8(*elem_ptr)
20845                                  ? PERL_PV_ESCAPE_UNI
20846                                  : 0)
20847                                 | PERL_PV_PRETTY_ELLIPSES
20848                                 | PERL_PV_PRETTY_LTGT
20849                             )
20850                     : "???"
20851                 );
20852                 if (trie->jump) {
20853                     U16 dist= trie->jump[word_idx+1];
20854                     Perl_re_printf( aTHX_  "(%" UVuf ")\n",
20855                                (UV)((dist ? this_trie + dist : next) - start));
20856                     if (dist) {
20857                         if (!nextbranch)
20858                             nextbranch= this_trie + trie->jump[0];
20859                         DUMPUNTIL(this_trie + dist, nextbranch);
20860                     }
20861                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
20862                         nextbranch= regnext((regnode *)nextbranch);
20863                 } else {
20864                     Perl_re_printf( aTHX_  "\n");
20865                 }
20866             }
20867             if (last && next > last)
20868                 node= last;
20869             else
20870                 node= next;
20871         }
20872         else if ( op == CURLY ) {   /* "next" might be very big: optimizer */
20873             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS,
20874                     NEXTOPER(node) + EXTRA_STEP_2ARGS + 1);
20875         }
20876         else if (PL_regkind[(U8)op] == CURLY && op != CURLYX) {
20877             assert(next);
20878             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS, next);
20879         }
20880         else if ( op == PLUS || op == STAR) {
20881             DUMPUNTIL(NEXTOPER(node), NEXTOPER(node) + 1);
20882         }
20883         else if (PL_regkind[(U8)op] == ANYOF) {
20884             /* arglen 1 + class block */
20885             node += 1 + ((ANYOF_FLAGS(node) & ANYOF_MATCHES_POSIXL)
20886                           ? ANYOF_POSIXL_SKIP
20887                           : ANYOF_SKIP);
20888             node = NEXTOPER(node);
20889         }
20890         else if (PL_regkind[(U8)op] == EXACT) {
20891             /* Literal string, where present. */
20892             node += NODE_SZ_STR(node) - 1;
20893             node = NEXTOPER(node);
20894         }
20895         else {
20896             node = NEXTOPER(node);
20897             node += regarglen[(U8)op];
20898         }
20899         if (op == CURLYX || op == OPEN)
20900             indent++;
20901     }
20902     CLEAR_OPTSTART;
20903 #ifdef DEBUG_DUMPUNTIL
20904     Perl_re_printf( aTHX_  "--- %d\n", (int)indent);
20905 #endif
20906     return node;
20907 }
20908
20909 #endif  /* DEBUGGING */
20910
20911 /*
20912  * ex: set ts=8 sts=4 sw=4 et:
20913  */