This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
embed.fnc: Change fcn from A to X
[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     U32 is_top_frame;           /* what flags do we use? */
114
115     struct scan_frame *this_prev_frame; /* this previous frame */
116     struct scan_frame *prev_frame;      /* previous frame */
117     struct scan_frame *next_frame;      /* next frame */
118 } scan_frame;
119
120 /* Certain characters are output as a sequence with the first being a
121  * backslash. */
122 #define isBACKSLASHED_PUNCT(c)  strchr("-[]\\^", c)
123
124
125 struct RExC_state_t {
126     U32         flags;                  /* RXf_* are we folding, multilining? */
127     U32         pm_flags;               /* PMf_* stuff from the calling PMOP */
128     char        *precomp;               /* uncompiled string. */
129     char        *precomp_end;           /* pointer to end of uncompiled string. */
130     REGEXP      *rx_sv;                 /* The SV that is the regexp. */
131     regexp      *rx;                    /* perl core regexp structure */
132     regexp_internal     *rxi;           /* internal data for regexp object
133                                            pprivate field */
134     char        *start;                 /* Start of input for compile */
135     char        *end;                   /* End of input for compile */
136     char        *parse;                 /* Input-scan pointer. */
137     char        *adjusted_start;        /* 'start', adjusted.  See code use */
138     STRLEN      precomp_adj;            /* an offset beyond precomp.  See code use */
139     SSize_t     whilem_seen;            /* number of WHILEM in this expr */
140     regnode     *emit_start;            /* Start of emitted-code area */
141     regnode     *emit_bound;            /* First regnode outside of the
142                                            allocated space */
143     regnode     *emit;                  /* Code-emit pointer; if = &emit_dummy,
144                                            implies compiling, so don't emit */
145     regnode_ssc emit_dummy;             /* placeholder for emit to point to;
146                                            large enough for the largest
147                                            non-EXACTish node, so can use it as
148                                            scratch in pass1 */
149     I32         naughty;                /* How bad is this pattern? */
150     I32         sawback;                /* Did we see \1, ...? */
151     U32         seen;
152     SSize_t     size;                   /* Code size. */
153     I32                npar;            /* Capture buffer count, (OPEN) plus
154                                            one. ("par" 0 is the whole
155                                            pattern)*/
156     I32         nestroot;               /* root parens we are in - used by
157                                            accept */
158     I32         extralen;
159     I32         seen_zerolen;
160     regnode     **open_parens;          /* pointers to open parens */
161     regnode     **close_parens;         /* pointers to close parens */
162     regnode     *end_op;                /* END node in program */
163     I32         utf8;           /* whether the pattern is utf8 or not */
164     I32         orig_utf8;      /* whether the pattern was originally in utf8 */
165                                 /* XXX use this for future optimisation of case
166                                  * where pattern must be upgraded to utf8. */
167     I32         uni_semantics;  /* If a d charset modifier should use unicode
168                                    rules, even if the pattern is not in
169                                    utf8 */
170     HV          *paren_names;           /* Paren names */
171
172     regnode     **recurse;              /* Recurse regops */
173     I32                recurse_count;                /* Number of recurse regops we have generated */
174     U8          *study_chunk_recursed;  /* bitmap of which subs we have moved
175                                            through */
176     U32         study_chunk_recursed_bytes;  /* bytes in bitmap */
177     I32         in_lookbehind;
178     I32         contains_locale;
179     I32         override_recoding;
180 #ifdef EBCDIC
181     I32         recode_x_to_native;
182 #endif
183     I32         in_multi_char_class;
184     struct reg_code_blocks *code_blocks;/* positions of literal (?{})
185                                             within pattern */
186     int         code_index;             /* next code_blocks[] slot */
187     SSize_t     maxlen;                        /* mininum possible number of chars in string to match */
188     scan_frame *frame_head;
189     scan_frame *frame_last;
190     U32         frame_count;
191     AV         *warn_text;
192 #ifdef ADD_TO_REGEXEC
193     char        *starttry;              /* -Dr: where regtry was called. */
194 #define RExC_starttry   (pRExC_state->starttry)
195 #endif
196     SV          *runtime_code_qr;       /* qr with the runtime code blocks */
197 #ifdef DEBUGGING
198     const char  *lastparse;
199     I32         lastnum;
200     AV          *paren_name_list;       /* idx -> name */
201     U32         study_chunk_recursed_count;
202     SV          *mysv1;
203     SV          *mysv2;
204 #define RExC_lastparse  (pRExC_state->lastparse)
205 #define RExC_lastnum    (pRExC_state->lastnum)
206 #define RExC_paren_name_list    (pRExC_state->paren_name_list)
207 #define RExC_study_chunk_recursed_count    (pRExC_state->study_chunk_recursed_count)
208 #define RExC_mysv       (pRExC_state->mysv1)
209 #define RExC_mysv1      (pRExC_state->mysv1)
210 #define RExC_mysv2      (pRExC_state->mysv2)
211
212 #endif
213     bool        seen_unfolded_sharp_s;
214     bool        strict;
215     bool        study_started;
216 };
217
218 #define RExC_flags      (pRExC_state->flags)
219 #define RExC_pm_flags   (pRExC_state->pm_flags)
220 #define RExC_precomp    (pRExC_state->precomp)
221 #define RExC_precomp_adj (pRExC_state->precomp_adj)
222 #define RExC_adjusted_start  (pRExC_state->adjusted_start)
223 #define RExC_precomp_end (pRExC_state->precomp_end)
224 #define RExC_rx_sv      (pRExC_state->rx_sv)
225 #define RExC_rx         (pRExC_state->rx)
226 #define RExC_rxi        (pRExC_state->rxi)
227 #define RExC_start      (pRExC_state->start)
228 #define RExC_end        (pRExC_state->end)
229 #define RExC_parse      (pRExC_state->parse)
230 #define RExC_whilem_seen        (pRExC_state->whilem_seen)
231
232 /* Set during the sizing pass when there is a LATIN SMALL LETTER SHARP S in any
233  * EXACTF node, hence was parsed under /di rules.  If later in the parse,
234  * something forces the pattern into using /ui rules, the sharp s should be
235  * folded into the sequence 'ss', which takes up more space than previously
236  * calculated.  This means that the sizing pass needs to be restarted.  (The
237  * node also becomes an EXACTFU_SS.)  For all other characters, an EXACTF node
238  * that gets converted to /ui (and EXACTFU) occupies the same amount of space,
239  * so there is no need to resize [perl #125990]. */
240 #define RExC_seen_unfolded_sharp_s (pRExC_state->seen_unfolded_sharp_s)
241
242 #ifdef RE_TRACK_PATTERN_OFFSETS
243 #define RExC_offsets    (pRExC_state->rxi->u.offsets) /* I am not like the
244                                                          others */
245 #endif
246 #define RExC_emit       (pRExC_state->emit)
247 #define RExC_emit_dummy (pRExC_state->emit_dummy)
248 #define RExC_emit_start (pRExC_state->emit_start)
249 #define RExC_emit_bound (pRExC_state->emit_bound)
250 #define RExC_sawback    (pRExC_state->sawback)
251 #define RExC_seen       (pRExC_state->seen)
252 #define RExC_size       (pRExC_state->size)
253 #define RExC_maxlen        (pRExC_state->maxlen)
254 #define RExC_npar       (pRExC_state->npar)
255 #define RExC_nestroot   (pRExC_state->nestroot)
256 #define RExC_extralen   (pRExC_state->extralen)
257 #define RExC_seen_zerolen       (pRExC_state->seen_zerolen)
258 #define RExC_utf8       (pRExC_state->utf8)
259 #define RExC_uni_semantics      (pRExC_state->uni_semantics)
260 #define RExC_orig_utf8  (pRExC_state->orig_utf8)
261 #define RExC_open_parens        (pRExC_state->open_parens)
262 #define RExC_close_parens       (pRExC_state->close_parens)
263 #define RExC_end_op     (pRExC_state->end_op)
264 #define RExC_paren_names        (pRExC_state->paren_names)
265 #define RExC_recurse    (pRExC_state->recurse)
266 #define RExC_recurse_count      (pRExC_state->recurse_count)
267 #define RExC_study_chunk_recursed        (pRExC_state->study_chunk_recursed)
268 #define RExC_study_chunk_recursed_bytes  \
269                                    (pRExC_state->study_chunk_recursed_bytes)
270 #define RExC_in_lookbehind      (pRExC_state->in_lookbehind)
271 #define RExC_contains_locale    (pRExC_state->contains_locale)
272 #ifdef EBCDIC
273 #   define RExC_recode_x_to_native (pRExC_state->recode_x_to_native)
274 #endif
275 #define RExC_in_multi_char_class (pRExC_state->in_multi_char_class)
276 #define RExC_frame_head (pRExC_state->frame_head)
277 #define RExC_frame_last (pRExC_state->frame_last)
278 #define RExC_frame_count (pRExC_state->frame_count)
279 #define RExC_strict (pRExC_state->strict)
280 #define RExC_study_started      (pRExC_state->study_started)
281 #define RExC_warn_text (pRExC_state->warn_text)
282
283 /* Heuristic check on the complexity of the pattern: if TOO_NAUGHTY, we set
284  * a flag to disable back-off on the fixed/floating substrings - if it's
285  * a high complexity pattern we assume the benefit of avoiding a full match
286  * is worth the cost of checking for the substrings even if they rarely help.
287  */
288 #define RExC_naughty    (pRExC_state->naughty)
289 #define TOO_NAUGHTY (10)
290 #define MARK_NAUGHTY(add) \
291     if (RExC_naughty < TOO_NAUGHTY) \
292         RExC_naughty += (add)
293 #define MARK_NAUGHTY_EXP(exp, add) \
294     if (RExC_naughty < TOO_NAUGHTY) \
295         RExC_naughty += RExC_naughty / (exp) + (add)
296
297 #define ISMULT1(c)      ((c) == '*' || (c) == '+' || (c) == '?')
298 #define ISMULT2(s)      ((*s) == '*' || (*s) == '+' || (*s) == '?' || \
299         ((*s) == '{' && regcurly(s)))
300
301 /*
302  * Flags to be passed up and down.
303  */
304 #define WORST           0       /* Worst case. */
305 #define HASWIDTH        0x01    /* Known to match non-null strings. */
306
307 /* Simple enough to be STAR/PLUS operand; in an EXACTish node must be a single
308  * character.  (There needs to be a case: in the switch statement in regexec.c
309  * for any node marked SIMPLE.)  Note that this is not the same thing as
310  * REGNODE_SIMPLE */
311 #define SIMPLE          0x02
312 #define SPSTART         0x04    /* Starts with * or + */
313 #define POSTPONED       0x08    /* (?1),(?&name), (??{...}) or similar */
314 #define TRYAGAIN        0x10    /* Weeded out a declaration. */
315 #define RESTART_PASS1   0x20    /* Need to restart sizing pass */
316 #define NEED_UTF8       0x40    /* In conjunction with RESTART_PASS1, need to
317                                    calcuate sizes as UTF-8 */
318
319 #define REG_NODE_NUM(x) ((x) ? (int)((x)-RExC_emit_start) : -1)
320
321 /* whether trie related optimizations are enabled */
322 #if PERL_ENABLE_EXTENDED_TRIE_OPTIMISATION
323 #define TRIE_STUDY_OPT
324 #define FULL_TRIE_STUDY
325 #define TRIE_STCLASS
326 #endif
327
328
329
330 #define PBYTE(u8str,paren) ((U8*)(u8str))[(paren) >> 3]
331 #define PBITVAL(paren) (1 << ((paren) & 7))
332 #define PAREN_TEST(u8str,paren) ( PBYTE(u8str,paren) & PBITVAL(paren))
333 #define PAREN_SET(u8str,paren) PBYTE(u8str,paren) |= PBITVAL(paren)
334 #define PAREN_UNSET(u8str,paren) PBYTE(u8str,paren) &= (~PBITVAL(paren))
335
336 #define REQUIRE_UTF8(flagp) STMT_START {                                   \
337                                      if (!UTF) {                           \
338                                          assert(PASS1);                    \
339                                          *flagp = RESTART_PASS1|NEED_UTF8; \
340                                          return NULL;                      \
341                                      }                                     \
342                              } STMT_END
343
344 /* Change from /d into /u rules, and restart the parse if we've already seen
345  * something whose size would increase as a result, by setting *flagp and
346  * returning 'restart_retval'.  RExC_uni_semantics is a flag that indicates
347  * we've change to /u during the parse.  */
348 #define REQUIRE_UNI_RULES(flagp, restart_retval)                            \
349     STMT_START {                                                            \
350             if (DEPENDS_SEMANTICS) {                                        \
351                 assert(PASS1);                                              \
352                 set_regex_charset(&RExC_flags, REGEX_UNICODE_CHARSET);      \
353                 RExC_uni_semantics = 1;                                     \
354                 if (RExC_seen_unfolded_sharp_s) {                           \
355                     *flagp |= RESTART_PASS1;                                \
356                     return restart_retval;                                  \
357                 }                                                           \
358             }                                                               \
359     } STMT_END
360
361 /* This converts the named class defined in regcomp.h to its equivalent class
362  * number defined in handy.h. */
363 #define namedclass_to_classnum(class)  ((int) ((class) / 2))
364 #define classnum_to_namedclass(classnum)  ((classnum) * 2)
365
366 #define _invlist_union_complement_2nd(a, b, output) \
367                         _invlist_union_maybe_complement_2nd(a, b, TRUE, output)
368 #define _invlist_intersection_complement_2nd(a, b, output) \
369                  _invlist_intersection_maybe_complement_2nd(a, b, TRUE, output)
370
371 /* About scan_data_t.
372
373   During optimisation we recurse through the regexp program performing
374   various inplace (keyhole style) optimisations. In addition study_chunk
375   and scan_commit populate this data structure with information about
376   what strings MUST appear in the pattern. We look for the longest
377   string that must appear at a fixed location, and we look for the
378   longest string that may appear at a floating location. So for instance
379   in the pattern:
380
381     /FOO[xX]A.*B[xX]BAR/
382
383   Both 'FOO' and 'A' are fixed strings. Both 'B' and 'BAR' are floating
384   strings (because they follow a .* construct). study_chunk will identify
385   both FOO and BAR as being the longest fixed and floating strings respectively.
386
387   The strings can be composites, for instance
388
389      /(f)(o)(o)/
390
391   will result in a composite fixed substring 'foo'.
392
393   For each string some basic information is maintained:
394
395   - min_offset
396     This is the position the string must appear at, or not before.
397     It also implicitly (when combined with minlenp) tells us how many
398     characters must match before the string we are searching for.
399     Likewise when combined with minlenp and the length of the string it
400     tells us how many characters must appear after the string we have
401     found.
402
403   - max_offset
404     Only used for floating strings. This is the rightmost point that
405     the string can appear at. If set to SSize_t_MAX it indicates that the
406     string can occur infinitely far to the right.
407     For fixed strings, it is equal to min_offset.
408
409   - minlenp
410     A pointer to the minimum number of characters of the pattern that the
411     string was found inside. This is important as in the case of positive
412     lookahead or positive lookbehind we can have multiple patterns
413     involved. Consider
414
415     /(?=FOO).*F/
416
417     The minimum length of the pattern overall is 3, the minimum length
418     of the lookahead part is 3, but the minimum length of the part that
419     will actually match is 1. So 'FOO's minimum length is 3, but the
420     minimum length for the F is 1. This is important as the minimum length
421     is used to determine offsets in front of and behind the string being
422     looked for.  Since strings can be composites this is the length of the
423     pattern at the time it was committed with a scan_commit. Note that
424     the length is calculated by study_chunk, so that the minimum lengths
425     are not known until the full pattern has been compiled, thus the
426     pointer to the value.
427
428   - lookbehind
429
430     In the case of lookbehind the string being searched for can be
431     offset past the start point of the final matching string.
432     If this value was just blithely removed from the min_offset it would
433     invalidate some of the calculations for how many chars must match
434     before or after (as they are derived from min_offset and minlen and
435     the length of the string being searched for).
436     When the final pattern is compiled and the data is moved from the
437     scan_data_t structure into the regexp structure the information
438     about lookbehind is factored in, with the information that would
439     have been lost precalculated in the end_shift field for the
440     associated string.
441
442   The fields pos_min and pos_delta are used to store the minimum offset
443   and the delta to the maximum offset at the current point in the pattern.
444
445 */
446
447 struct scan_data_substrs {
448     SV      *str;       /* longest substring found in pattern */
449     SSize_t min_offset; /* earliest point in string it can appear */
450     SSize_t max_offset; /* latest point in string it can appear */
451     SSize_t *minlenp;   /* pointer to the minlen relevant to the string */
452     SSize_t lookbehind; /* is the pos of the string modified by LB */
453     I32 flags;          /* per substring SF_* and SCF_* flags */
454 };
455
456 typedef struct scan_data_t {
457     /*I32 len_min;      unused */
458     /*I32 len_delta;    unused */
459     SSize_t pos_min;
460     SSize_t pos_delta;
461     SV *last_found;
462     SSize_t last_end;       /* min value, <0 unless valid. */
463     SSize_t last_start_min;
464     SSize_t last_start_max;
465     U8      cur_is_floating; /* whether the last_* values should be set as
466                               * the next fixed (0) or floating (1)
467                               * substring */
468
469     /* [0] is longest fixed substring so far, [1] is longest float so far */
470     struct scan_data_substrs  substrs[2];
471
472     I32 flags;             /* common SF_* and SCF_* flags */
473     I32 whilem_c;
474     SSize_t *last_closep;
475     regnode_ssc *start_class;
476 } scan_data_t;
477
478 /*
479  * Forward declarations for pregcomp()'s friends.
480  */
481
482 static const scan_data_t zero_scan_data = {
483     0, 0, NULL, 0, 0, 0, 0,
484     {
485         { NULL, 0, 0, 0, 0, 0 },
486         { NULL, 0, 0, 0, 0, 0 },
487     },
488     0, 0, NULL, NULL
489 };
490
491 /* study flags */
492
493 #define SF_BEFORE_SEOL          0x0001
494 #define SF_BEFORE_MEOL          0x0002
495 #define SF_BEFORE_EOL           (SF_BEFORE_SEOL|SF_BEFORE_MEOL)
496
497 #define SF_IS_INF               0x0040
498 #define SF_HAS_PAR              0x0080
499 #define SF_IN_PAR               0x0100
500 #define SF_HAS_EVAL             0x0200
501
502
503 /* SCF_DO_SUBSTR is the flag that tells the regexp analyzer to track the
504  * longest substring in the pattern. When it is not set the optimiser keeps
505  * track of position, but does not keep track of the actual strings seen,
506  *
507  * So for instance /foo/ will be parsed with SCF_DO_SUBSTR being true, but
508  * /foo/i will not.
509  *
510  * Similarly, /foo.*(blah|erm|huh).*fnorble/ will have "foo" and "fnorble"
511  * parsed with SCF_DO_SUBSTR on, but while processing the (...) it will be
512  * turned off because of the alternation (BRANCH). */
513 #define SCF_DO_SUBSTR           0x0400
514
515 #define SCF_DO_STCLASS_AND      0x0800
516 #define SCF_DO_STCLASS_OR       0x1000
517 #define SCF_DO_STCLASS          (SCF_DO_STCLASS_AND|SCF_DO_STCLASS_OR)
518 #define SCF_WHILEM_VISITED_POS  0x2000
519
520 #define SCF_TRIE_RESTUDY        0x4000 /* Do restudy? */
521 #define SCF_SEEN_ACCEPT         0x8000
522 #define SCF_TRIE_DOING_RESTUDY 0x10000
523 #define SCF_IN_DEFINE          0x20000
524
525
526
527
528 #define UTF cBOOL(RExC_utf8)
529
530 /* The enums for all these are ordered so things work out correctly */
531 #define LOC (get_regex_charset(RExC_flags) == REGEX_LOCALE_CHARSET)
532 #define DEPENDS_SEMANTICS (get_regex_charset(RExC_flags)                    \
533                                                      == REGEX_DEPENDS_CHARSET)
534 #define UNI_SEMANTICS (get_regex_charset(RExC_flags) == REGEX_UNICODE_CHARSET)
535 #define AT_LEAST_UNI_SEMANTICS (get_regex_charset(RExC_flags)                \
536                                                      >= REGEX_UNICODE_CHARSET)
537 #define ASCII_RESTRICTED (get_regex_charset(RExC_flags)                      \
538                                             == REGEX_ASCII_RESTRICTED_CHARSET)
539 #define AT_LEAST_ASCII_RESTRICTED (get_regex_charset(RExC_flags)             \
540                                             >= REGEX_ASCII_RESTRICTED_CHARSET)
541 #define ASCII_FOLD_RESTRICTED (get_regex_charset(RExC_flags)                 \
542                                         == REGEX_ASCII_MORE_RESTRICTED_CHARSET)
543
544 #define FOLD cBOOL(RExC_flags & RXf_PMf_FOLD)
545
546 /* For programs that want to be strictly Unicode compatible by dying if any
547  * attempt is made to match a non-Unicode code point against a Unicode
548  * property.  */
549 #define ALWAYS_WARN_SUPER  ckDEAD(packWARN(WARN_NON_UNICODE))
550
551 #define OOB_NAMEDCLASS          -1
552
553 /* There is no code point that is out-of-bounds, so this is problematic.  But
554  * its only current use is to initialize a variable that is always set before
555  * looked at. */
556 #define OOB_UNICODE             0xDEADBEEF
557
558 #define CHR_SVLEN(sv) (UTF ? sv_len_utf8(sv) : SvCUR(sv))
559
560
561 /* length of regex to show in messages that don't mark a position within */
562 #define RegexLengthToShowInErrorMessages 127
563
564 /*
565  * If MARKER[12] are adjusted, be sure to adjust the constants at the top
566  * of t/op/regmesg.t, the tests in t/op/re_tests, and those in
567  * op/pragma/warn/regcomp.
568  */
569 #define MARKER1 "<-- HERE"    /* marker as it appears in the description */
570 #define MARKER2 " <-- HERE "  /* marker as it appears within the regex */
571
572 #define REPORT_LOCATION " in regex; marked by " MARKER1    \
573                         " in m/%" UTF8f MARKER2 "%" UTF8f "/"
574
575 /* The code in this file in places uses one level of recursion with parsing
576  * rebased to an alternate string constructed by us in memory.  This can take
577  * the form of something that is completely different from the input, or
578  * something that uses the input as part of the alternate.  In the first case,
579  * there should be no possibility of an error, as we are in complete control of
580  * the alternate string.  But in the second case we don't control the input
581  * portion, so there may be errors in that.  Here's an example:
582  *      /[abc\x{DF}def]/ui
583  * is handled specially because \x{df} folds to a sequence of more than one
584  * character, 'ss'.  What is done is to create and parse an alternate string,
585  * which looks like this:
586  *      /(?:\x{DF}|[abc\x{DF}def])/ui
587  * where it uses the input unchanged in the middle of something it constructs,
588  * which is a branch for the DF outside the character class, and clustering
589  * parens around the whole thing. (It knows enough to skip the DF inside the
590  * class while in this substitute parse.) 'abc' and 'def' may have errors that
591  * need to be reported.  The general situation looks like this:
592  *
593  *              sI                       tI               xI       eI
594  * Input:       ----------------------------------------------------
595  * Constructed:         ---------------------------------------------------
596  *                      sC               tC               xC       eC     EC
597  *
598  * The input string sI..eI is the input pattern.  The string sC..EC is the
599  * constructed substitute parse string.  The portions sC..tC and eC..EC are
600  * constructed by us.  The portion tC..eC is an exact duplicate of the input
601  * pattern tI..eI.  In the diagram, these are vertically aligned.  Suppose that
602  * while parsing, we find an error at xC.  We want to display a message showing
603  * the real input string.  Thus we need to find the point xI in it which
604  * corresponds to xC.  xC >= tC, since the portion of the string sC..tC has
605  * been constructed by us, and so shouldn't have errors.  We get:
606  *
607  *      xI = sI + (tI - sI) + (xC - tC)
608  *
609  * and, the offset into sI is:
610  *
611  *      (xI - sI) = (tI - sI) + (xC - tC)
612  *
613  * When the substitute is constructed, we save (tI -sI) as RExC_precomp_adj,
614  * and we save tC as RExC_adjusted_start.
615  *
616  * During normal processing of the input pattern, everything points to that,
617  * with RExC_precomp_adj set to 0, and RExC_adjusted_start set to sI.
618  */
619
620 #define tI_sI           RExC_precomp_adj
621 #define tC              RExC_adjusted_start
622 #define sC              RExC_precomp
623 #define xI_offset(xC)   ((IV) (tI_sI + (xC - tC)))
624 #define xI(xC)          (sC + xI_offset(xC))
625 #define eC              RExC_precomp_end
626
627 #define REPORT_LOCATION_ARGS(xC)                                            \
628     UTF8fARG(UTF,                                                           \
629              (xI(xC) > eC) /* Don't run off end */                          \
630               ? eC - sC   /* Length before the <--HERE */                   \
631               : ( __ASSERT_(xI_offset(xC) >= 0) xI_offset(xC) ),            \
632              sC),         /* The input pattern printed up to the <--HERE */ \
633     UTF8fARG(UTF,                                                           \
634              (xI(xC) > eC) ? 0 : eC - xI(xC), /* Length after <--HERE */    \
635              (xI(xC) > eC) ? eC : xI(xC))     /* pattern after <--HERE */
636
637 /* Used to point after bad bytes for an error message, but avoid skipping
638  * past a nul byte. */
639 #define SKIP_IF_CHAR(s) (!*(s) ? 0 : UTF ? UTF8SKIP(s) : 1)
640
641 /*
642  * Calls SAVEDESTRUCTOR_X if needed, then calls Perl_croak with the given
643  * arg. Show regex, up to a maximum length. If it's too long, chop and add
644  * "...".
645  */
646 #define _FAIL(code) STMT_START {                                        \
647     const char *ellipses = "";                                          \
648     IV len = RExC_precomp_end - RExC_precomp;                                   \
649                                                                         \
650     if (!SIZE_ONLY)                                                     \
651         SAVEFREESV(RExC_rx_sv);                                         \
652     if (len > RegexLengthToShowInErrorMessages) {                       \
653         /* chop 10 shorter than the max, to ensure meaning of "..." */  \
654         len = RegexLengthToShowInErrorMessages - 10;                    \
655         ellipses = "...";                                               \
656     }                                                                   \
657     code;                                                               \
658 } STMT_END
659
660 #define FAIL(msg) _FAIL(                            \
661     Perl_croak(aTHX_ "%s in regex m/%" UTF8f "%s/",         \
662             msg, UTF8fARG(UTF, len, RExC_precomp), ellipses))
663
664 #define FAIL2(msg,arg) _FAIL(                       \
665     Perl_croak(aTHX_ msg " in regex m/%" UTF8f "%s/",       \
666             arg, UTF8fARG(UTF, len, RExC_precomp), ellipses))
667
668 /*
669  * Simple_vFAIL -- like FAIL, but marks the current location in the scan
670  */
671 #define Simple_vFAIL(m) STMT_START {                                    \
672     Perl_croak(aTHX_ "%s" REPORT_LOCATION,                              \
673             m, REPORT_LOCATION_ARGS(RExC_parse));                       \
674 } STMT_END
675
676 /*
677  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL()
678  */
679 #define vFAIL(m) STMT_START {                           \
680     if (!SIZE_ONLY)                                     \
681         SAVEFREESV(RExC_rx_sv);                         \
682     Simple_vFAIL(m);                                    \
683 } STMT_END
684
685 /*
686  * Like Simple_vFAIL(), but accepts two arguments.
687  */
688 #define Simple_vFAIL2(m,a1) STMT_START {                        \
689     S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1,              \
690                       REPORT_LOCATION_ARGS(RExC_parse));        \
691 } STMT_END
692
693 /*
694  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL2().
695  */
696 #define vFAIL2(m,a1) STMT_START {                       \
697     if (!SIZE_ONLY)                                     \
698         SAVEFREESV(RExC_rx_sv);                         \
699     Simple_vFAIL2(m, a1);                               \
700 } STMT_END
701
702
703 /*
704  * Like Simple_vFAIL(), but accepts three arguments.
705  */
706 #define Simple_vFAIL3(m, a1, a2) STMT_START {                   \
707     S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1, a2,          \
708             REPORT_LOCATION_ARGS(RExC_parse));                  \
709 } STMT_END
710
711 /*
712  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL3().
713  */
714 #define vFAIL3(m,a1,a2) STMT_START {                    \
715     if (!SIZE_ONLY)                                     \
716         SAVEFREESV(RExC_rx_sv);                         \
717     Simple_vFAIL3(m, a1, a2);                           \
718 } STMT_END
719
720 /*
721  * Like Simple_vFAIL(), but accepts four arguments.
722  */
723 #define Simple_vFAIL4(m, a1, a2, a3) STMT_START {               \
724     S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1, a2, a3,      \
725             REPORT_LOCATION_ARGS(RExC_parse));                  \
726 } STMT_END
727
728 #define vFAIL4(m,a1,a2,a3) STMT_START {                 \
729     if (!SIZE_ONLY)                                     \
730         SAVEFREESV(RExC_rx_sv);                         \
731     Simple_vFAIL4(m, a1, a2, a3);                       \
732 } STMT_END
733
734 /* A specialized version of vFAIL2 that works with UTF8f */
735 #define vFAIL2utf8f(m, a1) STMT_START {             \
736     if (!SIZE_ONLY)                                 \
737         SAVEFREESV(RExC_rx_sv);                     \
738     S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1,  \
739             REPORT_LOCATION_ARGS(RExC_parse));      \
740 } STMT_END
741
742 #define vFAIL3utf8f(m, a1, a2) STMT_START {             \
743     if (!SIZE_ONLY)                                     \
744         SAVEFREESV(RExC_rx_sv);                         \
745     S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1, a2,  \
746             REPORT_LOCATION_ARGS(RExC_parse));          \
747 } STMT_END
748
749 /* These have asserts in them because of [perl #122671] Many warnings in
750  * regcomp.c can occur twice.  If they get output in pass1 and later in that
751  * pass, the pattern has to be converted to UTF-8 and the pass restarted, they
752  * would get output again.  So they should be output in pass2, and these
753  * asserts make sure new warnings follow that paradigm. */
754
755 /* m is not necessarily a "literal string", in this macro */
756 #define reg_warn_non_literal_string(loc, m) STMT_START {                \
757     __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_REGEXP),           \
758                                        "%s" REPORT_LOCATION,            \
759                                   m, REPORT_LOCATION_ARGS(loc));        \
760 } STMT_END
761
762 #define ckWARNreg(loc,m) STMT_START {                                   \
763     __ASSERT_(PASS2) Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),        \
764                                           m REPORT_LOCATION,            \
765                                           REPORT_LOCATION_ARGS(loc));   \
766 } STMT_END
767
768 #define vWARN(loc, m) STMT_START {                                      \
769     __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_REGEXP),           \
770                                        m REPORT_LOCATION,               \
771                                        REPORT_LOCATION_ARGS(loc));      \
772 } STMT_END
773
774 #define vWARN_dep(loc, m) STMT_START {                                  \
775     __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_DEPRECATED),       \
776                                        m REPORT_LOCATION,               \
777                                        REPORT_LOCATION_ARGS(loc));      \
778 } STMT_END
779
780 #define ckWARNdep(loc,m) STMT_START {                                   \
781     __ASSERT_(PASS2) Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED),  \
782                                             m REPORT_LOCATION,          \
783                                             REPORT_LOCATION_ARGS(loc)); \
784 } STMT_END
785
786 #define ckWARNregdep(loc,m) STMT_START {                                    \
787     __ASSERT_(PASS2) Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED,      \
788                                                       WARN_REGEXP),         \
789                                              m REPORT_LOCATION,             \
790                                              REPORT_LOCATION_ARGS(loc));    \
791 } STMT_END
792
793 #define ckWARN2reg_d(loc,m, a1) STMT_START {                                \
794     __ASSERT_(PASS2) Perl_ck_warner_d(aTHX_ packWARN(WARN_REGEXP),          \
795                                             m REPORT_LOCATION,              \
796                                             a1, REPORT_LOCATION_ARGS(loc)); \
797 } STMT_END
798
799 #define ckWARN2reg(loc, m, a1) STMT_START {                                 \
800     __ASSERT_(PASS2) Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),            \
801                                           m REPORT_LOCATION,                \
802                                           a1, REPORT_LOCATION_ARGS(loc));   \
803 } STMT_END
804
805 #define vWARN3(loc, m, a1, a2) STMT_START {                                 \
806     __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_REGEXP),               \
807                                        m REPORT_LOCATION,                   \
808                                        a1, a2, REPORT_LOCATION_ARGS(loc));  \
809 } STMT_END
810
811 #define ckWARN3reg(loc, m, a1, a2) STMT_START {                             \
812     __ASSERT_(PASS2) Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),            \
813                                           m REPORT_LOCATION,                \
814                                           a1, a2,                           \
815                                           REPORT_LOCATION_ARGS(loc));       \
816 } STMT_END
817
818 #define vWARN4(loc, m, a1, a2, a3) STMT_START {                         \
819     __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_REGEXP),           \
820                                        m REPORT_LOCATION,               \
821                                        a1, a2, a3,                      \
822                                        REPORT_LOCATION_ARGS(loc));      \
823 } STMT_END
824
825 #define ckWARN4reg(loc, m, a1, a2, a3) STMT_START {                     \
826     __ASSERT_(PASS2) Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),        \
827                                           m REPORT_LOCATION,            \
828                                           a1, a2, a3,                   \
829                                           REPORT_LOCATION_ARGS(loc));   \
830 } STMT_END
831
832 #define vWARN5(loc, m, a1, a2, a3, a4) STMT_START {                     \
833     __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_REGEXP),           \
834                                        m REPORT_LOCATION,               \
835                                        a1, a2, a3, a4,                  \
836                                        REPORT_LOCATION_ARGS(loc));      \
837 } STMT_END
838
839 /* Macros for recording node offsets.   20001227 mjd@plover.com
840  * Nodes are numbered 1, 2, 3, 4.  Node #n's position is recorded in
841  * element 2*n-1 of the array.  Element #2n holds the byte length node #n.
842  * Element 0 holds the number n.
843  * Position is 1 indexed.
844  */
845 #ifndef RE_TRACK_PATTERN_OFFSETS
846 #define Set_Node_Offset_To_R(node,byte)
847 #define Set_Node_Offset(node,byte)
848 #define Set_Cur_Node_Offset
849 #define Set_Node_Length_To_R(node,len)
850 #define Set_Node_Length(node,len)
851 #define Set_Node_Cur_Length(node,start)
852 #define Node_Offset(n)
853 #define Node_Length(n)
854 #define Set_Node_Offset_Length(node,offset,len)
855 #define ProgLen(ri) ri->u.proglen
856 #define SetProgLen(ri,x) ri->u.proglen = x
857 #else
858 #define ProgLen(ri) ri->u.offsets[0]
859 #define SetProgLen(ri,x) ri->u.offsets[0] = x
860 #define Set_Node_Offset_To_R(node,byte) STMT_START {                    \
861     if (! SIZE_ONLY) {                                                  \
862         MJD_OFFSET_DEBUG(("** (%d) offset of node %d is %d.\n",         \
863                     __LINE__, (int)(node), (int)(byte)));               \
864         if((node) < 0) {                                                \
865             Perl_croak(aTHX_ "value of node is %d in Offset macro",     \
866                                          (int)(node));                  \
867         } else {                                                        \
868             RExC_offsets[2*(node)-1] = (byte);                          \
869         }                                                               \
870     }                                                                   \
871 } STMT_END
872
873 #define Set_Node_Offset(node,byte) \
874     Set_Node_Offset_To_R((node)-RExC_emit_start, (byte)-RExC_start)
875 #define Set_Cur_Node_Offset Set_Node_Offset(RExC_emit, RExC_parse)
876
877 #define Set_Node_Length_To_R(node,len) STMT_START {                     \
878     if (! SIZE_ONLY) {                                                  \
879         MJD_OFFSET_DEBUG(("** (%d) size of node %d is %d.\n",           \
880                 __LINE__, (int)(node), (int)(len)));                    \
881         if((node) < 0) {                                                \
882             Perl_croak(aTHX_ "value of node is %d in Length macro",     \
883                                          (int)(node));                  \
884         } else {                                                        \
885             RExC_offsets[2*(node)] = (len);                             \
886         }                                                               \
887     }                                                                   \
888 } STMT_END
889
890 #define Set_Node_Length(node,len) \
891     Set_Node_Length_To_R((node)-RExC_emit_start, len)
892 #define Set_Node_Cur_Length(node, start)                \
893     Set_Node_Length(node, RExC_parse - start)
894
895 /* Get offsets and lengths */
896 #define Node_Offset(n) (RExC_offsets[2*((n)-RExC_emit_start)-1])
897 #define Node_Length(n) (RExC_offsets[2*((n)-RExC_emit_start)])
898
899 #define Set_Node_Offset_Length(node,offset,len) STMT_START {    \
900     Set_Node_Offset_To_R((node)-RExC_emit_start, (offset));     \
901     Set_Node_Length_To_R((node)-RExC_emit_start, (len));        \
902 } STMT_END
903 #endif
904
905 #if PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS
906 #define EXPERIMENTAL_INPLACESCAN
907 #endif /*PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS*/
908
909 #ifdef DEBUGGING
910 int
911 Perl_re_printf(pTHX_ const char *fmt, ...)
912 {
913     va_list ap;
914     int result;
915     PerlIO *f= Perl_debug_log;
916     PERL_ARGS_ASSERT_RE_PRINTF;
917     va_start(ap, fmt);
918     result = PerlIO_vprintf(f, fmt, ap);
919     va_end(ap);
920     return result;
921 }
922
923 int
924 Perl_re_indentf(pTHX_ const char *fmt, U32 depth, ...)
925 {
926     va_list ap;
927     int result;
928     PerlIO *f= Perl_debug_log;
929     PERL_ARGS_ASSERT_RE_INDENTF;
930     va_start(ap, depth);
931     PerlIO_printf(f, "%*s", ( (int)depth % 20 ) * 2, "");
932     result = PerlIO_vprintf(f, fmt, ap);
933     va_end(ap);
934     return result;
935 }
936 #endif /* DEBUGGING */
937
938 #define DEBUG_RExC_seen()                                                   \
939         DEBUG_OPTIMISE_MORE_r({                                             \
940             Perl_re_printf( aTHX_ "RExC_seen: ");                                       \
941                                                                             \
942             if (RExC_seen & REG_ZERO_LEN_SEEN)                              \
943                 Perl_re_printf( aTHX_ "REG_ZERO_LEN_SEEN ");                            \
944                                                                             \
945             if (RExC_seen & REG_LOOKBEHIND_SEEN)                            \
946                 Perl_re_printf( aTHX_ "REG_LOOKBEHIND_SEEN ");                          \
947                                                                             \
948             if (RExC_seen & REG_GPOS_SEEN)                                  \
949                 Perl_re_printf( aTHX_ "REG_GPOS_SEEN ");                                \
950                                                                             \
951             if (RExC_seen & REG_RECURSE_SEEN)                               \
952                 Perl_re_printf( aTHX_ "REG_RECURSE_SEEN ");                             \
953                                                                             \
954             if (RExC_seen & REG_TOP_LEVEL_BRANCHES_SEEN)                    \
955                 Perl_re_printf( aTHX_ "REG_TOP_LEVEL_BRANCHES_SEEN ");                  \
956                                                                             \
957             if (RExC_seen & REG_VERBARG_SEEN)                               \
958                 Perl_re_printf( aTHX_ "REG_VERBARG_SEEN ");                             \
959                                                                             \
960             if (RExC_seen & REG_CUTGROUP_SEEN)                              \
961                 Perl_re_printf( aTHX_ "REG_CUTGROUP_SEEN ");                            \
962                                                                             \
963             if (RExC_seen & REG_RUN_ON_COMMENT_SEEN)                        \
964                 Perl_re_printf( aTHX_ "REG_RUN_ON_COMMENT_SEEN ");                      \
965                                                                             \
966             if (RExC_seen & REG_UNFOLDED_MULTI_SEEN)                        \
967                 Perl_re_printf( aTHX_ "REG_UNFOLDED_MULTI_SEEN ");                      \
968                                                                             \
969             if (RExC_seen & REG_UNBOUNDED_QUANTIFIER_SEEN)                  \
970                 Perl_re_printf( aTHX_ "REG_UNBOUNDED_QUANTIFIER_SEEN ");                \
971                                                                             \
972             Perl_re_printf( aTHX_ "\n");                                                \
973         });
974
975 #define DEBUG_SHOW_STUDY_FLAG(flags,flag) \
976   if ((flags) & flag) Perl_re_printf( aTHX_  "%s ", #flag)
977
978
979 #ifdef DEBUGGING
980 static void
981 S_debug_show_study_flags(pTHX_ U32 flags, const char *open_str,
982                                     const char *close_str)
983 {
984     if (!flags)
985         return;
986
987     Perl_re_printf( aTHX_  "%s", open_str);
988     DEBUG_SHOW_STUDY_FLAG(flags, SF_BEFORE_SEOL);
989     DEBUG_SHOW_STUDY_FLAG(flags, SF_BEFORE_MEOL);
990     DEBUG_SHOW_STUDY_FLAG(flags, SF_IS_INF);
991     DEBUG_SHOW_STUDY_FLAG(flags, SF_HAS_PAR);
992     DEBUG_SHOW_STUDY_FLAG(flags, SF_IN_PAR);
993     DEBUG_SHOW_STUDY_FLAG(flags, SF_HAS_EVAL);
994     DEBUG_SHOW_STUDY_FLAG(flags, SCF_DO_SUBSTR);
995     DEBUG_SHOW_STUDY_FLAG(flags, SCF_DO_STCLASS_AND);
996     DEBUG_SHOW_STUDY_FLAG(flags, SCF_DO_STCLASS_OR);
997     DEBUG_SHOW_STUDY_FLAG(flags, SCF_DO_STCLASS);
998     DEBUG_SHOW_STUDY_FLAG(flags, SCF_WHILEM_VISITED_POS);
999     DEBUG_SHOW_STUDY_FLAG(flags, SCF_TRIE_RESTUDY);
1000     DEBUG_SHOW_STUDY_FLAG(flags, SCF_SEEN_ACCEPT);
1001     DEBUG_SHOW_STUDY_FLAG(flags, SCF_TRIE_DOING_RESTUDY);
1002     DEBUG_SHOW_STUDY_FLAG(flags, SCF_IN_DEFINE);
1003     Perl_re_printf( aTHX_  "%s", close_str);
1004 }
1005
1006
1007 static void
1008 S_debug_studydata(pTHX_ const char *where, scan_data_t *data,
1009                     U32 depth, int is_inf)
1010 {
1011     GET_RE_DEBUG_FLAGS_DECL;
1012
1013     DEBUG_OPTIMISE_MORE_r({
1014         if (!data)
1015             return;
1016         Perl_re_indentf(aTHX_  "%s: Pos:%" IVdf "/%" IVdf " Flags: 0x%" UVXf,
1017             depth,
1018             where,
1019             (IV)data->pos_min,
1020             (IV)data->pos_delta,
1021             (UV)data->flags
1022         );
1023
1024         S_debug_show_study_flags(aTHX_ data->flags," [","]");
1025
1026         Perl_re_printf( aTHX_
1027             " Whilem_c: %" IVdf " Lcp: %" IVdf " %s",
1028             (IV)data->whilem_c,
1029             (IV)(data->last_closep ? *((data)->last_closep) : -1),
1030             is_inf ? "INF " : ""
1031         );
1032
1033         if (data->last_found) {
1034             int i;
1035             Perl_re_printf(aTHX_
1036                 "Last:'%s' %" IVdf ":%" IVdf "/%" IVdf,
1037                     SvPVX_const(data->last_found),
1038                     (IV)data->last_end,
1039                     (IV)data->last_start_min,
1040                     (IV)data->last_start_max
1041             );
1042
1043             for (i = 0; i < 2; i++) {
1044                 Perl_re_printf(aTHX_
1045                     " %s%s: '%s' @ %" IVdf "/%" IVdf,
1046                     data->cur_is_floating == i ? "*" : "",
1047                     i ? "Float" : "Fixed",
1048                     SvPVX_const(data->substrs[i].str),
1049                     (IV)data->substrs[i].min_offset,
1050                     (IV)data->substrs[i].max_offset
1051                 );
1052                 S_debug_show_study_flags(aTHX_ data->substrs[i].flags," [","]");
1053             }
1054         }
1055
1056         Perl_re_printf( aTHX_ "\n");
1057     });
1058 }
1059
1060
1061 static void
1062 S_debug_peep(pTHX_ const char *str, const RExC_state_t *pRExC_state,
1063                 regnode *scan, U32 depth, U32 flags)
1064 {
1065     GET_RE_DEBUG_FLAGS_DECL;
1066
1067     DEBUG_OPTIMISE_r({
1068         regnode *Next;
1069
1070         if (!scan)
1071             return;
1072         Next = regnext(scan);
1073         regprop(RExC_rx, RExC_mysv, scan, NULL, pRExC_state);
1074         Perl_re_indentf( aTHX_   "%s>%3d: %s (%d)",
1075             depth,
1076             str,
1077             REG_NODE_NUM(scan), SvPV_nolen_const(RExC_mysv),
1078             Next ? (REG_NODE_NUM(Next)) : 0 );
1079         S_debug_show_study_flags(aTHX_ flags," [ ","]");
1080         Perl_re_printf( aTHX_  "\n");
1081    });
1082 }
1083
1084
1085 #  define DEBUG_STUDYDATA(where, data, depth, is_inf) \
1086                     S_debug_studydata(aTHX_ where, data, depth, is_inf)
1087
1088 #  define DEBUG_PEEP(str, scan, depth, flags)   \
1089                     S_debug_peep(aTHX_ str, pRExC_state, scan, depth, flags)
1090
1091 #else
1092 #  define DEBUG_STUDYDATA(where, data, depth, is_inf) NOOP
1093 #  define DEBUG_PEEP(str, scan, depth, flags)         NOOP
1094 #endif
1095
1096
1097 /* =========================================================
1098  * BEGIN edit_distance stuff.
1099  *
1100  * This calculates how many single character changes of any type are needed to
1101  * transform a string into another one.  It is taken from version 3.1 of
1102  *
1103  * https://metacpan.org/pod/Text::Levenshtein::Damerau::XS
1104  */
1105
1106 /* Our unsorted dictionary linked list.   */
1107 /* Note we use UVs, not chars. */
1108
1109 struct dictionary{
1110   UV key;
1111   UV value;
1112   struct dictionary* next;
1113 };
1114 typedef struct dictionary item;
1115
1116
1117 PERL_STATIC_INLINE item*
1118 push(UV key,item* curr)
1119 {
1120     item* head;
1121     Newxz(head, 1, item);
1122     head->key = key;
1123     head->value = 0;
1124     head->next = curr;
1125     return head;
1126 }
1127
1128
1129 PERL_STATIC_INLINE item*
1130 find(item* head, UV key)
1131 {
1132     item* iterator = head;
1133     while (iterator){
1134         if (iterator->key == key){
1135             return iterator;
1136         }
1137         iterator = iterator->next;
1138     }
1139
1140     return NULL;
1141 }
1142
1143 PERL_STATIC_INLINE item*
1144 uniquePush(item* head,UV key)
1145 {
1146     item* iterator = head;
1147
1148     while (iterator){
1149         if (iterator->key == key) {
1150             return head;
1151         }
1152         iterator = iterator->next;
1153     }
1154
1155     return push(key,head);
1156 }
1157
1158 PERL_STATIC_INLINE void
1159 dict_free(item* head)
1160 {
1161     item* iterator = head;
1162
1163     while (iterator) {
1164         item* temp = iterator;
1165         iterator = iterator->next;
1166         Safefree(temp);
1167     }
1168
1169     head = NULL;
1170 }
1171
1172 /* End of Dictionary Stuff */
1173
1174 /* All calculations/work are done here */
1175 STATIC int
1176 S_edit_distance(const UV* src,
1177                 const UV* tgt,
1178                 const STRLEN x,             /* length of src[] */
1179                 const STRLEN y,             /* length of tgt[] */
1180                 const SSize_t maxDistance
1181 )
1182 {
1183     item *head = NULL;
1184     UV swapCount,swapScore,targetCharCount,i,j;
1185     UV *scores;
1186     UV score_ceil = x + y;
1187
1188     PERL_ARGS_ASSERT_EDIT_DISTANCE;
1189
1190     /* intialize matrix start values */
1191     Newxz(scores, ( (x + 2) * (y + 2)), UV);
1192     scores[0] = score_ceil;
1193     scores[1 * (y + 2) + 0] = score_ceil;
1194     scores[0 * (y + 2) + 1] = score_ceil;
1195     scores[1 * (y + 2) + 1] = 0;
1196     head = uniquePush(uniquePush(head,src[0]),tgt[0]);
1197
1198     /* work loops    */
1199     /* i = src index */
1200     /* j = tgt index */
1201     for (i=1;i<=x;i++) {
1202         if (i < x)
1203             head = uniquePush(head,src[i]);
1204         scores[(i+1) * (y + 2) + 1] = i;
1205         scores[(i+1) * (y + 2) + 0] = score_ceil;
1206         swapCount = 0;
1207
1208         for (j=1;j<=y;j++) {
1209             if (i == 1) {
1210                 if(j < y)
1211                 head = uniquePush(head,tgt[j]);
1212                 scores[1 * (y + 2) + (j + 1)] = j;
1213                 scores[0 * (y + 2) + (j + 1)] = score_ceil;
1214             }
1215
1216             targetCharCount = find(head,tgt[j-1])->value;
1217             swapScore = scores[targetCharCount * (y + 2) + swapCount] + i - targetCharCount - 1 + j - swapCount;
1218
1219             if (src[i-1] != tgt[j-1]){
1220                 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));
1221             }
1222             else {
1223                 swapCount = j;
1224                 scores[(i+1) * (y + 2) + (j + 1)] = MIN(scores[i * (y + 2) + j], swapScore);
1225             }
1226         }
1227
1228         find(head,src[i-1])->value = i;
1229     }
1230
1231     {
1232         IV score = scores[(x+1) * (y + 2) + (y + 1)];
1233         dict_free(head);
1234         Safefree(scores);
1235         return (maxDistance != 0 && maxDistance < score)?(-1):score;
1236     }
1237 }
1238
1239 /* END of edit_distance() stuff
1240  * ========================================================= */
1241
1242 /* is c a control character for which we have a mnemonic? */
1243 #define isMNEMONIC_CNTRL(c) _IS_MNEMONIC_CNTRL_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c)
1244
1245 STATIC const char *
1246 S_cntrl_to_mnemonic(const U8 c)
1247 {
1248     /* Returns the mnemonic string that represents character 'c', if one
1249      * exists; NULL otherwise.  The only ones that exist for the purposes of
1250      * this routine are a few control characters */
1251
1252     switch (c) {
1253         case '\a':       return "\\a";
1254         case '\b':       return "\\b";
1255         case ESC_NATIVE: return "\\e";
1256         case '\f':       return "\\f";
1257         case '\n':       return "\\n";
1258         case '\r':       return "\\r";
1259         case '\t':       return "\\t";
1260     }
1261
1262     return NULL;
1263 }
1264
1265 /* Mark that we cannot extend a found fixed substring at this point.
1266    Update the longest found anchored substring or the longest found
1267    floating substrings if needed. */
1268
1269 STATIC void
1270 S_scan_commit(pTHX_ const RExC_state_t *pRExC_state, scan_data_t *data,
1271                     SSize_t *minlenp, int is_inf)
1272 {
1273     const STRLEN l = CHR_SVLEN(data->last_found);
1274     SV * const longest_sv = data->substrs[data->cur_is_floating].str;
1275     const STRLEN old_l = CHR_SVLEN(longest_sv);
1276     GET_RE_DEBUG_FLAGS_DECL;
1277
1278     PERL_ARGS_ASSERT_SCAN_COMMIT;
1279
1280     if ((l >= old_l) && ((l > old_l) || (data->flags & SF_BEFORE_EOL))) {
1281         const U8 i = data->cur_is_floating;
1282         SvSetMagicSV(longest_sv, data->last_found);
1283         data->substrs[i].min_offset = l ? data->last_start_min : data->pos_min;
1284
1285         if (!i) /* fixed */
1286             data->substrs[0].max_offset = data->substrs[0].min_offset;
1287         else { /* float */
1288             data->substrs[1].max_offset = (l
1289                           ? data->last_start_max
1290                           : (data->pos_delta > SSize_t_MAX - data->pos_min
1291                                          ? SSize_t_MAX
1292                                          : data->pos_min + data->pos_delta));
1293             if (is_inf
1294                  || (STRLEN)data->substrs[1].max_offset > (STRLEN)SSize_t_MAX)
1295                 data->substrs[1].max_offset = SSize_t_MAX;
1296         }
1297
1298         if (data->flags & SF_BEFORE_EOL)
1299             data->substrs[i].flags |= (data->flags & SF_BEFORE_EOL);
1300         else
1301             data->substrs[i].flags &= ~SF_BEFORE_EOL;
1302         data->substrs[i].minlenp = minlenp;
1303         data->substrs[i].lookbehind = 0;
1304     }
1305
1306     SvCUR_set(data->last_found, 0);
1307     {
1308         SV * const sv = data->last_found;
1309         if (SvUTF8(sv) && SvMAGICAL(sv)) {
1310             MAGIC * const mg = mg_find(sv, PERL_MAGIC_utf8);
1311             if (mg)
1312                 mg->mg_len = 0;
1313         }
1314     }
1315     data->last_end = -1;
1316     data->flags &= ~SF_BEFORE_EOL;
1317     DEBUG_STUDYDATA("commit", data, 0, is_inf);
1318 }
1319
1320 /* An SSC is just a regnode_charclass_posix with an extra field: the inversion
1321  * list that describes which code points it matches */
1322
1323 STATIC void
1324 S_ssc_anything(pTHX_ regnode_ssc *ssc)
1325 {
1326     /* Set the SSC 'ssc' to match an empty string or any code point */
1327
1328     PERL_ARGS_ASSERT_SSC_ANYTHING;
1329
1330     assert(is_ANYOF_SYNTHETIC(ssc));
1331
1332     /* mortalize so won't leak */
1333     ssc->invlist = sv_2mortal(_add_range_to_invlist(NULL, 0, UV_MAX));
1334     ANYOF_FLAGS(ssc) |= SSC_MATCHES_EMPTY_STRING;  /* Plus matches empty */
1335 }
1336
1337 STATIC int
1338 S_ssc_is_anything(const regnode_ssc *ssc)
1339 {
1340     /* Returns TRUE if the SSC 'ssc' can match the empty string and any code
1341      * point; FALSE otherwise.  Thus, this is used to see if using 'ssc' buys
1342      * us anything: if the function returns TRUE, 'ssc' hasn't been restricted
1343      * in any way, so there's no point in using it */
1344
1345     UV start, end;
1346     bool ret;
1347
1348     PERL_ARGS_ASSERT_SSC_IS_ANYTHING;
1349
1350     assert(is_ANYOF_SYNTHETIC(ssc));
1351
1352     if (! (ANYOF_FLAGS(ssc) & SSC_MATCHES_EMPTY_STRING)) {
1353         return FALSE;
1354     }
1355
1356     /* See if the list consists solely of the range 0 - Infinity */
1357     invlist_iterinit(ssc->invlist);
1358     ret = invlist_iternext(ssc->invlist, &start, &end)
1359           && start == 0
1360           && end == UV_MAX;
1361
1362     invlist_iterfinish(ssc->invlist);
1363
1364     if (ret) {
1365         return TRUE;
1366     }
1367
1368     /* If e.g., both \w and \W are set, matches everything */
1369     if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
1370         int i;
1371         for (i = 0; i < ANYOF_POSIXL_MAX; i += 2) {
1372             if (ANYOF_POSIXL_TEST(ssc, i) && ANYOF_POSIXL_TEST(ssc, i+1)) {
1373                 return TRUE;
1374             }
1375         }
1376     }
1377
1378     return FALSE;
1379 }
1380
1381 STATIC void
1382 S_ssc_init(pTHX_ const RExC_state_t *pRExC_state, regnode_ssc *ssc)
1383 {
1384     /* Initializes the SSC 'ssc'.  This includes setting it to match an empty
1385      * string, any code point, or any posix class under locale */
1386
1387     PERL_ARGS_ASSERT_SSC_INIT;
1388
1389     Zero(ssc, 1, regnode_ssc);
1390     set_ANYOF_SYNTHETIC(ssc);
1391     ARG_SET(ssc, ANYOF_ONLY_HAS_BITMAP);
1392     ssc_anything(ssc);
1393
1394     /* If any portion of the regex is to operate under locale rules that aren't
1395      * fully known at compile time, initialization includes it.  The reason
1396      * this isn't done for all regexes is that the optimizer was written under
1397      * the assumption that locale was all-or-nothing.  Given the complexity and
1398      * lack of documentation in the optimizer, and that there are inadequate
1399      * test cases for locale, many parts of it may not work properly, it is
1400      * safest to avoid locale unless necessary. */
1401     if (RExC_contains_locale) {
1402         ANYOF_POSIXL_SETALL(ssc);
1403     }
1404     else {
1405         ANYOF_POSIXL_ZERO(ssc);
1406     }
1407 }
1408
1409 STATIC int
1410 S_ssc_is_cp_posixl_init(const RExC_state_t *pRExC_state,
1411                         const regnode_ssc *ssc)
1412 {
1413     /* Returns TRUE if the SSC 'ssc' is in its initial state with regard only
1414      * to the list of code points matched, and locale posix classes; hence does
1415      * not check its flags) */
1416
1417     UV start, end;
1418     bool ret;
1419
1420     PERL_ARGS_ASSERT_SSC_IS_CP_POSIXL_INIT;
1421
1422     assert(is_ANYOF_SYNTHETIC(ssc));
1423
1424     invlist_iterinit(ssc->invlist);
1425     ret = invlist_iternext(ssc->invlist, &start, &end)
1426           && start == 0
1427           && end == UV_MAX;
1428
1429     invlist_iterfinish(ssc->invlist);
1430
1431     if (! ret) {
1432         return FALSE;
1433     }
1434
1435     if (RExC_contains_locale && ! ANYOF_POSIXL_SSC_TEST_ALL_SET(ssc)) {
1436         return FALSE;
1437     }
1438
1439     return TRUE;
1440 }
1441
1442 STATIC SV*
1443 S_get_ANYOF_cp_list_for_ssc(pTHX_ const RExC_state_t *pRExC_state,
1444                                const regnode_charclass* const node)
1445 {
1446     /* Returns a mortal inversion list defining which code points are matched
1447      * by 'node', which is of type ANYOF.  Handles complementing the result if
1448      * appropriate.  If some code points aren't knowable at this time, the
1449      * returned list must, and will, contain every code point that is a
1450      * possibility. */
1451
1452     SV* invlist = NULL;
1453     SV* only_utf8_locale_invlist = NULL;
1454     unsigned int i;
1455     const U32 n = ARG(node);
1456     bool new_node_has_latin1 = FALSE;
1457
1458     PERL_ARGS_ASSERT_GET_ANYOF_CP_LIST_FOR_SSC;
1459
1460     /* Look at the data structure created by S_set_ANYOF_arg() */
1461     if (n != ANYOF_ONLY_HAS_BITMAP) {
1462         SV * const rv = MUTABLE_SV(RExC_rxi->data->data[n]);
1463         AV * const av = MUTABLE_AV(SvRV(rv));
1464         SV **const ary = AvARRAY(av);
1465         assert(RExC_rxi->data->what[n] == 's');
1466
1467         if (ary[1] && ary[1] != &PL_sv_undef) { /* Has compile-time swash */
1468             invlist = sv_2mortal(invlist_clone(_get_swash_invlist(ary[1])));
1469         }
1470         else if (ary[0] && ary[0] != &PL_sv_undef) {
1471
1472             /* Here, no compile-time swash, and there are things that won't be
1473              * known until runtime -- we have to assume it could be anything */
1474             invlist = sv_2mortal(_new_invlist(1));
1475             return _add_range_to_invlist(invlist, 0, UV_MAX);
1476         }
1477         else if (ary[3] && ary[3] != &PL_sv_undef) {
1478
1479             /* Here no compile-time swash, and no run-time only data.  Use the
1480              * node's inversion list */
1481             invlist = sv_2mortal(invlist_clone(ary[3]));
1482         }
1483
1484         /* Get the code points valid only under UTF-8 locales */
1485         if ((ANYOF_FLAGS(node) & ANYOFL_FOLD)
1486             && ary[2] && ary[2] != &PL_sv_undef)
1487         {
1488             only_utf8_locale_invlist = ary[2];
1489         }
1490     }
1491
1492     if (! invlist) {
1493         invlist = sv_2mortal(_new_invlist(0));
1494     }
1495
1496     /* An ANYOF node contains a bitmap for the first NUM_ANYOF_CODE_POINTS
1497      * code points, and an inversion list for the others, but if there are code
1498      * points that should match only conditionally on the target string being
1499      * UTF-8, those are placed in the inversion list, and not the bitmap.
1500      * Since there are circumstances under which they could match, they are
1501      * included in the SSC.  But if the ANYOF node is to be inverted, we have
1502      * to exclude them here, so that when we invert below, the end result
1503      * actually does include them.  (Think about "\xe0" =~ /[^\xc0]/di;).  We
1504      * have to do this here before we add the unconditionally matched code
1505      * points */
1506     if (ANYOF_FLAGS(node) & ANYOF_INVERT) {
1507         _invlist_intersection_complement_2nd(invlist,
1508                                              PL_UpperLatin1,
1509                                              &invlist);
1510     }
1511
1512     /* Add in the points from the bit map */
1513     for (i = 0; i < NUM_ANYOF_CODE_POINTS; i++) {
1514         if (ANYOF_BITMAP_TEST(node, i)) {
1515             unsigned int start = i++;
1516
1517             for (; i < NUM_ANYOF_CODE_POINTS && ANYOF_BITMAP_TEST(node, i); ++i) {
1518                 /* empty */
1519             }
1520             invlist = _add_range_to_invlist(invlist, start, i-1);
1521             new_node_has_latin1 = TRUE;
1522         }
1523     }
1524
1525     /* If this can match all upper Latin1 code points, have to add them
1526      * as well.  But don't add them if inverting, as when that gets done below,
1527      * it would exclude all these characters, including the ones it shouldn't
1528      * that were added just above */
1529     if (! (ANYOF_FLAGS(node) & ANYOF_INVERT) && OP(node) == ANYOFD
1530         && (ANYOF_FLAGS(node) & ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER))
1531     {
1532         _invlist_union(invlist, PL_UpperLatin1, &invlist);
1533     }
1534
1535     /* Similarly for these */
1536     if (ANYOF_FLAGS(node) & ANYOF_MATCHES_ALL_ABOVE_BITMAP) {
1537         _invlist_union_complement_2nd(invlist, PL_InBitmap, &invlist);
1538     }
1539
1540     if (ANYOF_FLAGS(node) & ANYOF_INVERT) {
1541         _invlist_invert(invlist);
1542     }
1543     else if (new_node_has_latin1 && ANYOF_FLAGS(node) & ANYOFL_FOLD) {
1544
1545         /* Under /li, any 0-255 could fold to any other 0-255, depending on the
1546          * locale.  We can skip this if there are no 0-255 at all. */
1547         _invlist_union(invlist, PL_Latin1, &invlist);
1548     }
1549
1550     /* Similarly add the UTF-8 locale possible matches.  These have to be
1551      * deferred until after the non-UTF-8 locale ones are taken care of just
1552      * above, or it leads to wrong results under ANYOF_INVERT */
1553     if (only_utf8_locale_invlist) {
1554         _invlist_union_maybe_complement_2nd(invlist,
1555                                             only_utf8_locale_invlist,
1556                                             ANYOF_FLAGS(node) & ANYOF_INVERT,
1557                                             &invlist);
1558     }
1559
1560     return invlist;
1561 }
1562
1563 /* These two functions currently do the exact same thing */
1564 #define ssc_init_zero           ssc_init
1565
1566 #define ssc_add_cp(ssc, cp)   ssc_add_range((ssc), (cp), (cp))
1567 #define ssc_match_all_cp(ssc) ssc_add_range(ssc, 0, UV_MAX)
1568
1569 /* 'AND' a given class with another one.  Can create false positives.  'ssc'
1570  * should not be inverted.  'and_with->flags & ANYOF_MATCHES_POSIXL' should be
1571  * 0 if 'and_with' is a regnode_charclass instead of a regnode_ssc. */
1572
1573 STATIC void
1574 S_ssc_and(pTHX_ const RExC_state_t *pRExC_state, regnode_ssc *ssc,
1575                 const regnode_charclass *and_with)
1576 {
1577     /* Accumulate into SSC 'ssc' its 'AND' with 'and_with', which is either
1578      * another SSC or a regular ANYOF class.  Can create false positives. */
1579
1580     SV* anded_cp_list;
1581     U8  anded_flags;
1582
1583     PERL_ARGS_ASSERT_SSC_AND;
1584
1585     assert(is_ANYOF_SYNTHETIC(ssc));
1586
1587     /* 'and_with' is used as-is if it too is an SSC; otherwise have to extract
1588      * the code point inversion list and just the relevant flags */
1589     if (is_ANYOF_SYNTHETIC(and_with)) {
1590         anded_cp_list = ((regnode_ssc *)and_with)->invlist;
1591         anded_flags = ANYOF_FLAGS(and_with);
1592
1593         /* XXX This is a kludge around what appears to be deficiencies in the
1594          * optimizer.  If we make S_ssc_anything() add in the WARN_SUPER flag,
1595          * there are paths through the optimizer where it doesn't get weeded
1596          * out when it should.  And if we don't make some extra provision for
1597          * it like the code just below, it doesn't get added when it should.
1598          * This solution is to add it only when AND'ing, which is here, and
1599          * only when what is being AND'ed is the pristine, original node
1600          * matching anything.  Thus it is like adding it to ssc_anything() but
1601          * only when the result is to be AND'ed.  Probably the same solution
1602          * could be adopted for the same problem we have with /l matching,
1603          * which is solved differently in S_ssc_init(), and that would lead to
1604          * fewer false positives than that solution has.  But if this solution
1605          * creates bugs, the consequences are only that a warning isn't raised
1606          * that should be; while the consequences for having /l bugs is
1607          * incorrect matches */
1608         if (ssc_is_anything((regnode_ssc *)and_with)) {
1609             anded_flags |= ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER;
1610         }
1611     }
1612     else {
1613         anded_cp_list = get_ANYOF_cp_list_for_ssc(pRExC_state, and_with);
1614         if (OP(and_with) == ANYOFD) {
1615             anded_flags = ANYOF_FLAGS(and_with) & ANYOF_COMMON_FLAGS;
1616         }
1617         else {
1618             anded_flags = ANYOF_FLAGS(and_with)
1619             &( ANYOF_COMMON_FLAGS
1620               |ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER
1621               |ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP);
1622             if (ANYOFL_UTF8_LOCALE_REQD(ANYOF_FLAGS(and_with))) {
1623                 anded_flags &=
1624                     ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD;
1625             }
1626         }
1627     }
1628
1629     ANYOF_FLAGS(ssc) &= anded_flags;
1630
1631     /* Below, C1 is the list of code points in 'ssc'; P1, its posix classes.
1632      * C2 is the list of code points in 'and-with'; P2, its posix classes.
1633      * 'and_with' may be inverted.  When not inverted, we have the situation of
1634      * computing:
1635      *  (C1 | P1) & (C2 | P2)
1636      *                     =  (C1 & (C2 | P2)) | (P1 & (C2 | P2))
1637      *                     =  ((C1 & C2) | (C1 & P2)) | ((P1 & C2) | (P1 & P2))
1638      *                    <=  ((C1 & C2) |       P2)) | ( P1       | (P1 & P2))
1639      *                    <=  ((C1 & C2) | P1 | P2)
1640      * Alternatively, the last few steps could be:
1641      *                     =  ((C1 & C2) | (C1 & P2)) | ((P1 & C2) | (P1 & P2))
1642      *                    <=  ((C1 & C2) |  C1      ) | (      C2  | (P1 & P2))
1643      *                    <=  (C1 | C2 | (P1 & P2))
1644      * We favor the second approach if either P1 or P2 is non-empty.  This is
1645      * because these components are a barrier to doing optimizations, as what
1646      * they match cannot be known until the moment of matching as they are
1647      * dependent on the current locale, 'AND"ing them likely will reduce or
1648      * eliminate them.
1649      * But we can do better if we know that C1,P1 are in their initial state (a
1650      * frequent occurrence), each matching everything:
1651      *  (<everything>) & (C2 | P2) =  C2 | P2
1652      * Similarly, if C2,P2 are in their initial state (again a frequent
1653      * occurrence), the result is a no-op
1654      *  (C1 | P1) & (<everything>) =  C1 | P1
1655      *
1656      * Inverted, we have
1657      *  (C1 | P1) & ~(C2 | P2)  =  (C1 | P1) & (~C2 & ~P2)
1658      *                          =  (C1 & (~C2 & ~P2)) | (P1 & (~C2 & ~P2))
1659      *                         <=  (C1 & ~C2) | (P1 & ~P2)
1660      * */
1661
1662     if ((ANYOF_FLAGS(and_with) & ANYOF_INVERT)
1663         && ! is_ANYOF_SYNTHETIC(and_with))
1664     {
1665         unsigned int i;
1666
1667         ssc_intersection(ssc,
1668                          anded_cp_list,
1669                          FALSE /* Has already been inverted */
1670                          );
1671
1672         /* If either P1 or P2 is empty, the intersection will be also; can skip
1673          * the loop */
1674         if (! (ANYOF_FLAGS(and_with) & ANYOF_MATCHES_POSIXL)) {
1675             ANYOF_POSIXL_ZERO(ssc);
1676         }
1677         else if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
1678
1679             /* Note that the Posix class component P from 'and_with' actually
1680              * looks like:
1681              *      P = Pa | Pb | ... | Pn
1682              * where each component is one posix class, such as in [\w\s].
1683              * Thus
1684              *      ~P = ~(Pa | Pb | ... | Pn)
1685              *         = ~Pa & ~Pb & ... & ~Pn
1686              *        <= ~Pa | ~Pb | ... | ~Pn
1687              * The last is something we can easily calculate, but unfortunately
1688              * is likely to have many false positives.  We could do better
1689              * in some (but certainly not all) instances if two classes in
1690              * P have known relationships.  For example
1691              *      :lower: <= :alpha: <= :alnum: <= \w <= :graph: <= :print:
1692              * So
1693              *      :lower: & :print: = :lower:
1694              * And similarly for classes that must be disjoint.  For example,
1695              * since \s and \w can have no elements in common based on rules in
1696              * the POSIX standard,
1697              *      \w & ^\S = nothing
1698              * Unfortunately, some vendor locales do not meet the Posix
1699              * standard, in particular almost everything by Microsoft.
1700              * The loop below just changes e.g., \w into \W and vice versa */
1701
1702             regnode_charclass_posixl temp;
1703             int add = 1;    /* To calculate the index of the complement */
1704
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     Newxz( 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     Newxz( 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
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
4183     if ( depth == 0 ) {
4184         while (first_non_open && OP(first_non_open) == OPEN)
4185             first_non_open=regnext(first_non_open);
4186     }
4187
4188
4189   fake_study_recurse:
4190     DEBUG_r(
4191         RExC_study_chunk_recursed_count++;
4192     );
4193     DEBUG_OPTIMISE_MORE_r(
4194     {
4195         Perl_re_indentf( aTHX_  "study_chunk stopparen=%ld recursed_count=%lu depth=%lu recursed_depth=%lu scan=%p last=%p",
4196             depth, (long)stopparen,
4197             (unsigned long)RExC_study_chunk_recursed_count,
4198             (unsigned long)depth, (unsigned long)recursed_depth,
4199             scan,
4200             last);
4201         if (recursed_depth) {
4202             U32 i;
4203             U32 j;
4204             for ( j = 0 ; j < recursed_depth ; j++ ) {
4205                 for ( i = 0 ; i < (U32)RExC_npar ; i++ ) {
4206                     if (
4207                         PAREN_TEST(RExC_study_chunk_recursed +
4208                                    ( j * RExC_study_chunk_recursed_bytes), i )
4209                         && (
4210                             !j ||
4211                             !PAREN_TEST(RExC_study_chunk_recursed +
4212                                    (( j - 1 ) * RExC_study_chunk_recursed_bytes), i)
4213                         )
4214                     ) {
4215                         Perl_re_printf( aTHX_ " %d",(int)i);
4216                         break;
4217                     }
4218                 }
4219                 if ( j + 1 < recursed_depth ) {
4220                     Perl_re_printf( aTHX_  ",");
4221                 }
4222             }
4223         }
4224         Perl_re_printf( aTHX_ "\n");
4225     }
4226     );
4227     while ( scan && OP(scan) != END && scan < last ){
4228         UV min_subtract = 0;    /* How mmany chars to subtract from the minimum
4229                                    node length to get a real minimum (because
4230                                    the folded version may be shorter) */
4231         bool unfolded_multi_char = FALSE;
4232         /* Peephole optimizer: */
4233         DEBUG_STUDYDATA("Peep", data, depth, is_inf);
4234         DEBUG_PEEP("Peep", scan, depth, flags);
4235
4236
4237         /* The reason we do this here is that we need to deal with things like
4238          * /(?:f)(?:o)(?:o)/ which cant be dealt with by the normal EXACT
4239          * parsing code, as each (?:..) is handled by a different invocation of
4240          * reg() -- Yves
4241          */
4242         JOIN_EXACT(scan,&min_subtract, &unfolded_multi_char, 0);
4243
4244         /* Follow the next-chain of the current node and optimize
4245            away all the NOTHINGs from it.  */
4246         if (OP(scan) != CURLYX) {
4247             const int max = (reg_off_by_arg[OP(scan)]
4248                        ? I32_MAX
4249                        /* I32 may be smaller than U16 on CRAYs! */
4250                        : (I32_MAX < U16_MAX ? I32_MAX : U16_MAX));
4251             int off = (reg_off_by_arg[OP(scan)] ? ARG(scan) : NEXT_OFF(scan));
4252             int noff;
4253             regnode *n = scan;
4254
4255             /* Skip NOTHING and LONGJMP. */
4256             while ((n = regnext(n))
4257                    && ((PL_regkind[OP(n)] == NOTHING && (noff = NEXT_OFF(n)))
4258                        || ((OP(n) == LONGJMP) && (noff = ARG(n))))
4259                    && off + noff < max)
4260                 off += noff;
4261             if (reg_off_by_arg[OP(scan)])
4262                 ARG(scan) = off;
4263             else
4264                 NEXT_OFF(scan) = off;
4265         }
4266
4267         /* The principal pseudo-switch.  Cannot be a switch, since we
4268            look into several different things.  */
4269         if ( OP(scan) == DEFINEP ) {
4270             SSize_t minlen = 0;
4271             SSize_t deltanext = 0;
4272             SSize_t fake_last_close = 0;
4273             I32 f = SCF_IN_DEFINE;
4274
4275             StructCopy(&zero_scan_data, &data_fake, scan_data_t);
4276             scan = regnext(scan);
4277             assert( OP(scan) == IFTHEN );
4278             DEBUG_PEEP("expect IFTHEN", scan, depth, flags);
4279
4280             data_fake.last_closep= &fake_last_close;
4281             minlen = *minlenp;
4282             next = regnext(scan);
4283             scan = NEXTOPER(NEXTOPER(scan));
4284             DEBUG_PEEP("scan", scan, depth, flags);
4285             DEBUG_PEEP("next", next, depth, flags);
4286
4287             /* we suppose the run is continuous, last=next...
4288              * NOTE we dont use the return here! */
4289             (void)study_chunk(pRExC_state, &scan, &minlen,
4290                               &deltanext, next, &data_fake, stopparen,
4291                               recursed_depth, NULL, f, depth+1);
4292
4293             scan = next;
4294         } else
4295         if (
4296             OP(scan) == BRANCH  ||
4297             OP(scan) == BRANCHJ ||
4298             OP(scan) == IFTHEN
4299         ) {
4300             next = regnext(scan);
4301             code = OP(scan);
4302
4303             /* The op(next)==code check below is to see if we
4304              * have "BRANCH-BRANCH", "BRANCHJ-BRANCHJ", "IFTHEN-IFTHEN"
4305              * IFTHEN is special as it might not appear in pairs.
4306              * Not sure whether BRANCH-BRANCHJ is possible, regardless
4307              * we dont handle it cleanly. */
4308             if (OP(next) == code || code == IFTHEN) {
4309                 /* NOTE - There is similar code to this block below for
4310                  * handling TRIE nodes on a re-study.  If you change stuff here
4311                  * check there too. */
4312                 SSize_t max1 = 0, min1 = SSize_t_MAX, num = 0;
4313                 regnode_ssc accum;
4314                 regnode * const startbranch=scan;
4315
4316                 if (flags & SCF_DO_SUBSTR) {
4317                     /* Cannot merge strings after this. */
4318                     scan_commit(pRExC_state, data, minlenp, is_inf);
4319                 }
4320
4321                 if (flags & SCF_DO_STCLASS)
4322                     ssc_init_zero(pRExC_state, &accum);
4323
4324                 while (OP(scan) == code) {
4325                     SSize_t deltanext, minnext, fake;
4326                     I32 f = 0;
4327                     regnode_ssc this_class;
4328
4329                     DEBUG_PEEP("Branch", scan, depth, flags);
4330
4331                     num++;
4332                     StructCopy(&zero_scan_data, &data_fake, scan_data_t);
4333                     if (data) {
4334                         data_fake.whilem_c = data->whilem_c;
4335                         data_fake.last_closep = data->last_closep;
4336                     }
4337                     else
4338                         data_fake.last_closep = &fake;
4339
4340                     data_fake.pos_delta = delta;
4341                     next = regnext(scan);
4342
4343                     scan = NEXTOPER(scan); /* everything */
4344                     if (code != BRANCH)    /* everything but BRANCH */
4345                         scan = NEXTOPER(scan);
4346
4347                     if (flags & SCF_DO_STCLASS) {
4348                         ssc_init(pRExC_state, &this_class);
4349                         data_fake.start_class = &this_class;
4350                         f = SCF_DO_STCLASS_AND;
4351                     }
4352                     if (flags & SCF_WHILEM_VISITED_POS)
4353                         f |= SCF_WHILEM_VISITED_POS;
4354
4355                     /* we suppose the run is continuous, last=next...*/
4356                     minnext = study_chunk(pRExC_state, &scan, minlenp,
4357                                       &deltanext, next, &data_fake, stopparen,
4358                                       recursed_depth, NULL, f,depth+1);
4359
4360                     if (min1 > minnext)
4361                         min1 = minnext;
4362                     if (deltanext == SSize_t_MAX) {
4363                         is_inf = is_inf_internal = 1;
4364                         max1 = SSize_t_MAX;
4365                     } else if (max1 < minnext + deltanext)
4366                         max1 = minnext + deltanext;
4367                     scan = next;
4368                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4369                         pars++;
4370                     if (data_fake.flags & SCF_SEEN_ACCEPT) {
4371                         if ( stopmin > minnext)
4372                             stopmin = min + min1;
4373                         flags &= ~SCF_DO_SUBSTR;
4374                         if (data)
4375                             data->flags |= SCF_SEEN_ACCEPT;
4376                     }
4377                     if (data) {
4378                         if (data_fake.flags & SF_HAS_EVAL)
4379                             data->flags |= SF_HAS_EVAL;
4380                         data->whilem_c = data_fake.whilem_c;
4381                     }
4382                     if (flags & SCF_DO_STCLASS)
4383                         ssc_or(pRExC_state, &accum, (regnode_charclass*)&this_class);
4384                 }
4385                 if (code == IFTHEN && num < 2) /* Empty ELSE branch */
4386                     min1 = 0;
4387                 if (flags & SCF_DO_SUBSTR) {
4388                     data->pos_min += min1;
4389                     if (data->pos_delta >= SSize_t_MAX - (max1 - min1))
4390                         data->pos_delta = SSize_t_MAX;
4391                     else
4392                         data->pos_delta += max1 - min1;
4393                     if (max1 != min1 || is_inf)
4394                         data->cur_is_floating = 1;
4395                 }
4396                 min += min1;
4397                 if (delta == SSize_t_MAX
4398                  || SSize_t_MAX - delta - (max1 - min1) < 0)
4399                     delta = SSize_t_MAX;
4400                 else
4401                     delta += max1 - min1;
4402                 if (flags & SCF_DO_STCLASS_OR) {
4403                     ssc_or(pRExC_state, data->start_class, (regnode_charclass*) &accum);
4404                     if (min1) {
4405                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
4406                         flags &= ~SCF_DO_STCLASS;
4407                     }
4408                 }
4409                 else if (flags & SCF_DO_STCLASS_AND) {
4410                     if (min1) {
4411                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &accum);
4412                         flags &= ~SCF_DO_STCLASS;
4413                     }
4414                     else {
4415                         /* Switch to OR mode: cache the old value of
4416                          * data->start_class */
4417                         INIT_AND_WITHP;
4418                         StructCopy(data->start_class, and_withp, regnode_ssc);
4419                         flags &= ~SCF_DO_STCLASS_AND;
4420                         StructCopy(&accum, data->start_class, regnode_ssc);
4421                         flags |= SCF_DO_STCLASS_OR;
4422                     }
4423                 }
4424
4425                 if (PERL_ENABLE_TRIE_OPTIMISATION &&
4426                         OP( startbranch ) == BRANCH )
4427                 {
4428                 /* demq.
4429
4430                    Assuming this was/is a branch we are dealing with: 'scan'
4431                    now points at the item that follows the branch sequence,
4432                    whatever it is. We now start at the beginning of the
4433                    sequence and look for subsequences of
4434
4435                    BRANCH->EXACT=>x1
4436                    BRANCH->EXACT=>x2
4437                    tail
4438
4439                    which would be constructed from a pattern like
4440                    /A|LIST|OF|WORDS/
4441
4442                    If we can find such a subsequence we need to turn the first
4443                    element into a trie and then add the subsequent branch exact
4444                    strings to the trie.
4445
4446                    We have two cases
4447
4448                      1. patterns where the whole set of branches can be
4449                         converted.
4450
4451                      2. patterns where only a subset can be converted.
4452
4453                    In case 1 we can replace the whole set with a single regop
4454                    for the trie. In case 2 we need to keep the start and end
4455                    branches so
4456
4457                      'BRANCH EXACT; BRANCH EXACT; BRANCH X'
4458                      becomes BRANCH TRIE; BRANCH X;
4459
4460                   There is an additional case, that being where there is a
4461                   common prefix, which gets split out into an EXACT like node
4462                   preceding the TRIE node.
4463
4464                   If x(1..n)==tail then we can do a simple trie, if not we make
4465                   a "jump" trie, such that when we match the appropriate word
4466                   we "jump" to the appropriate tail node. Essentially we turn
4467                   a nested if into a case structure of sorts.
4468
4469                 */
4470
4471                     int made=0;
4472                     if (!re_trie_maxbuff) {
4473                         re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
4474                         if (!SvIOK(re_trie_maxbuff))
4475                             sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
4476                     }
4477                     if ( SvIV(re_trie_maxbuff)>=0  ) {
4478                         regnode *cur;
4479                         regnode *first = (regnode *)NULL;
4480                         regnode *last = (regnode *)NULL;
4481                         regnode *tail = scan;
4482                         U8 trietype = 0;
4483                         U32 count=0;
4484
4485                         /* var tail is used because there may be a TAIL
4486                            regop in the way. Ie, the exacts will point to the
4487                            thing following the TAIL, but the last branch will
4488                            point at the TAIL. So we advance tail. If we
4489                            have nested (?:) we may have to move through several
4490                            tails.
4491                          */
4492
4493                         while ( OP( tail ) == TAIL ) {
4494                             /* this is the TAIL generated by (?:) */
4495                             tail = regnext( tail );
4496                         }
4497
4498
4499                         DEBUG_TRIE_COMPILE_r({
4500                             regprop(RExC_rx, RExC_mysv, tail, NULL, pRExC_state);
4501                             Perl_re_indentf( aTHX_  "%s %" UVuf ":%s\n",
4502                               depth+1,
4503                               "Looking for TRIE'able sequences. Tail node is ",
4504                               (UV)(tail - RExC_emit_start),
4505                               SvPV_nolen_const( RExC_mysv )
4506                             );
4507                         });
4508
4509                         /*
4510
4511                             Step through the branches
4512                                 cur represents each branch,
4513                                 noper is the first thing to be matched as part
4514                                       of that branch
4515                                 noper_next is the regnext() of that node.
4516
4517                             We normally handle a case like this
4518                             /FOO[xyz]|BAR[pqr]/ via a "jump trie" but we also
4519                             support building with NOJUMPTRIE, which restricts
4520                             the trie logic to structures like /FOO|BAR/.
4521
4522                             If noper is a trieable nodetype then the branch is
4523                             a possible optimization target. If we are building
4524                             under NOJUMPTRIE then we require that noper_next is
4525                             the same as scan (our current position in the regex
4526                             program).
4527
4528                             Once we have two or more consecutive such branches
4529                             we can create a trie of the EXACT's contents and
4530                             stitch it in place into the program.
4531
4532                             If the sequence represents all of the branches in
4533                             the alternation we replace the entire thing with a
4534                             single TRIE node.
4535
4536                             Otherwise when it is a subsequence we need to
4537                             stitch it in place and replace only the relevant
4538                             branches. This means the first branch has to remain
4539                             as it is used by the alternation logic, and its
4540                             next pointer, and needs to be repointed at the item
4541                             on the branch chain following the last branch we
4542                             have optimized away.
4543
4544                             This could be either a BRANCH, in which case the
4545                             subsequence is internal, or it could be the item
4546                             following the branch sequence in which case the
4547                             subsequence is at the end (which does not
4548                             necessarily mean the first node is the start of the
4549                             alternation).
4550
4551                             TRIE_TYPE(X) is a define which maps the optype to a
4552                             trietype.
4553
4554                                 optype          |  trietype
4555                                 ----------------+-----------
4556                                 NOTHING         | NOTHING
4557                                 EXACT           | EXACT
4558                                 EXACTFU         | EXACTFU
4559                                 EXACTFU_SS      | EXACTFU
4560                                 EXACTFA         | EXACTFA
4561                                 EXACTL          | EXACTL
4562                                 EXACTFLU8       | EXACTFLU8
4563
4564
4565                         */
4566 #define TRIE_TYPE(X) ( ( NOTHING == (X) )                                   \
4567                        ? NOTHING                                            \
4568                        : ( EXACT == (X) )                                   \
4569                          ? EXACT                                            \
4570                          : ( EXACTFU == (X) || EXACTFU_SS == (X) )          \
4571                            ? EXACTFU                                        \
4572                            : ( EXACTFA == (X) )                             \
4573                              ? EXACTFA                                      \
4574                              : ( EXACTL == (X) )                            \
4575                                ? EXACTL                                     \
4576                                : ( EXACTFLU8 == (X) )                        \
4577                                  ? EXACTFLU8                                 \
4578                                  : 0 )
4579
4580                         /* dont use tail as the end marker for this traverse */
4581                         for ( cur = startbranch ; cur != scan ; cur = regnext( cur ) ) {
4582                             regnode * const noper = NEXTOPER( cur );
4583                             U8 noper_type = OP( noper );
4584                             U8 noper_trietype = TRIE_TYPE( noper_type );
4585 #if defined(DEBUGGING) || defined(NOJUMPTRIE)
4586                             regnode * const noper_next = regnext( noper );
4587                             U8 noper_next_type = (noper_next && noper_next < tail) ? OP(noper_next) : 0;
4588                             U8 noper_next_trietype = (noper_next && noper_next < tail) ? TRIE_TYPE( noper_next_type ) :0;
4589 #endif
4590
4591                             DEBUG_TRIE_COMPILE_r({
4592                                 regprop(RExC_rx, RExC_mysv, cur, NULL, pRExC_state);
4593                                 Perl_re_indentf( aTHX_  "- %d:%s (%d)",
4594                                    depth+1,
4595                                    REG_NODE_NUM(cur), SvPV_nolen_const( RExC_mysv ), REG_NODE_NUM(cur) );
4596
4597                                 regprop(RExC_rx, RExC_mysv, noper, NULL, pRExC_state);
4598                                 Perl_re_printf( aTHX_  " -> %d:%s",
4599                                     REG_NODE_NUM(noper), SvPV_nolen_const(RExC_mysv));
4600
4601                                 if ( noper_next ) {
4602                                   regprop(RExC_rx, RExC_mysv, noper_next, NULL, pRExC_state);
4603                                   Perl_re_printf( aTHX_ "\t=> %d:%s\t",
4604                                     REG_NODE_NUM(noper_next), SvPV_nolen_const(RExC_mysv));
4605                                 }
4606                                 Perl_re_printf( aTHX_  "(First==%d,Last==%d,Cur==%d,tt==%s,ntt==%s,nntt==%s)\n",
4607                                    REG_NODE_NUM(first), REG_NODE_NUM(last), REG_NODE_NUM(cur),
4608                                    PL_reg_name[trietype], PL_reg_name[noper_trietype], PL_reg_name[noper_next_trietype]
4609                                 );
4610                             });
4611
4612                             /* Is noper a trieable nodetype that can be merged
4613                              * with the current trie (if there is one)? */
4614                             if ( noper_trietype
4615                                   &&
4616                                   (
4617                                         ( noper_trietype == NOTHING )
4618                                         || ( trietype == NOTHING )
4619                                         || ( trietype == noper_trietype )
4620                                   )
4621 #ifdef NOJUMPTRIE
4622                                   && noper_next >= tail
4623 #endif
4624                                   && count < U16_MAX)
4625                             {
4626                                 /* Handle mergable triable node Either we are
4627                                  * the first node in a new trieable sequence,
4628                                  * in which case we do some bookkeeping,
4629                                  * otherwise we update the end pointer. */
4630                                 if ( !first ) {
4631                                     first = cur;
4632                                     if ( noper_trietype == NOTHING ) {
4633 #if !defined(DEBUGGING) && !defined(NOJUMPTRIE)
4634                                         regnode * const noper_next = regnext( noper );
4635                                         U8 noper_next_type = (noper_next && noper_next < tail) ? OP(noper_next) : 0;
4636                                         U8 noper_next_trietype = noper_next_type ? TRIE_TYPE( noper_next_type ) :0;
4637 #endif
4638
4639                                         if ( noper_next_trietype ) {
4640                                             trietype = noper_next_trietype;
4641                                         } else if (noper_next_type)  {
4642                                             /* a NOTHING regop is 1 regop wide.
4643                                              * We need at least two for a trie
4644                                              * so we can't merge this in */
4645                                             first = NULL;
4646                                         }
4647                                     } else {
4648                                         trietype = noper_trietype;
4649                                     }
4650                                 } else {
4651                                     if ( trietype == NOTHING )
4652                                         trietype = noper_trietype;
4653                                     last = cur;
4654                                 }
4655                                 if (first)
4656                                     count++;
4657                             } /* end handle mergable triable node */
4658                             else {
4659                                 /* handle unmergable node -
4660                                  * noper may either be a triable node which can
4661                                  * not be tried together with the current trie,
4662                                  * or a non triable node */
4663                                 if ( last ) {
4664                                     /* If last is set and trietype is not
4665                                      * NOTHING then we have found at least two
4666                                      * triable branch sequences in a row of a
4667                                      * similar trietype so we can turn them
4668                                      * into a trie. If/when we allow NOTHING to
4669                                      * start a trie sequence this condition
4670                                      * will be required, and it isn't expensive
4671                                      * so we leave it in for now. */
4672                                     if ( trietype && trietype != NOTHING )
4673                                         make_trie( pRExC_state,
4674                                                 startbranch, first, cur, tail,
4675                                                 count, trietype, depth+1 );
4676                                     last = NULL; /* note: we clear/update
4677                                                     first, trietype etc below,
4678                                                     so we dont do it here */
4679                                 }
4680                                 if ( noper_trietype
4681 #ifdef NOJUMPTRIE
4682                                      && noper_next >= tail
4683 #endif
4684                                 ){
4685                                     /* noper is triable, so we can start a new
4686                                      * trie sequence */
4687                                     count = 1;
4688                                     first = cur;
4689                                     trietype = noper_trietype;
4690                                 } else if (first) {
4691                                     /* if we already saw a first but the
4692                                      * current node is not triable then we have
4693                                      * to reset the first information. */
4694                                     count = 0;
4695                                     first = NULL;
4696                                     trietype = 0;
4697                                 }
4698                             } /* end handle unmergable node */
4699                         } /* loop over branches */
4700                         DEBUG_TRIE_COMPILE_r({
4701                             regprop(RExC_rx, RExC_mysv, cur, NULL, pRExC_state);
4702                             Perl_re_indentf( aTHX_  "- %s (%d) <SCAN FINISHED> ",
4703                               depth+1, SvPV_nolen_const( RExC_mysv ),REG_NODE_NUM(cur));
4704                             Perl_re_printf( aTHX_  "(First==%d, Last==%d, Cur==%d, tt==%s)\n",
4705                                REG_NODE_NUM(first), REG_NODE_NUM(last), REG_NODE_NUM(cur),
4706                                PL_reg_name[trietype]
4707                             );
4708
4709                         });
4710                         if ( last && trietype ) {
4711                             if ( trietype != NOTHING ) {
4712                                 /* the last branch of the sequence was part of
4713                                  * a trie, so we have to construct it here
4714                                  * outside of the loop */
4715                                 made= make_trie( pRExC_state, startbranch,
4716                                                  first, scan, tail, count,
4717                                                  trietype, depth+1 );
4718 #ifdef TRIE_STUDY_OPT
4719                                 if ( ((made == MADE_EXACT_TRIE &&
4720                                      startbranch == first)
4721                                      || ( first_non_open == first )) &&
4722                                      depth==0 ) {
4723                                     flags |= SCF_TRIE_RESTUDY;
4724                                     if ( startbranch == first
4725                                          && scan >= tail )
4726                                     {
4727                                         RExC_seen &=~REG_TOP_LEVEL_BRANCHES_SEEN;
4728                                     }
4729                                 }
4730 #endif
4731                             } else {
4732                                 /* at this point we know whatever we have is a
4733                                  * NOTHING sequence/branch AND if 'startbranch'
4734                                  * is 'first' then we can turn the whole thing
4735                                  * into a NOTHING
4736                                  */
4737                                 if ( startbranch == first ) {
4738                                     regnode *opt;
4739                                     /* the entire thing is a NOTHING sequence,
4740                                      * something like this: (?:|) So we can
4741                                      * turn it into a plain NOTHING op. */
4742                                     DEBUG_TRIE_COMPILE_r({
4743                                         regprop(RExC_rx, RExC_mysv, cur, NULL, pRExC_state);
4744                                         Perl_re_indentf( aTHX_  "- %s (%d) <NOTHING BRANCH SEQUENCE>\n",
4745                                           depth+1,
4746                                           SvPV_nolen_const( RExC_mysv ),REG_NODE_NUM(cur));
4747
4748                                     });
4749                                     OP(startbranch)= NOTHING;
4750                                     NEXT_OFF(startbranch)= tail - startbranch;
4751                                     for ( opt= startbranch + 1; opt < tail ; opt++ )
4752                                         OP(opt)= OPTIMIZED;
4753                                 }
4754                             }
4755                         } /* end if ( last) */
4756                     } /* TRIE_MAXBUF is non zero */
4757
4758                 } /* do trie */
4759
4760             }
4761             else if ( code == BRANCHJ ) {  /* single branch is optimized. */
4762                 scan = NEXTOPER(NEXTOPER(scan));
4763             } else                      /* single branch is optimized. */
4764                 scan = NEXTOPER(scan);
4765             continue;
4766         } else if (OP(scan) == SUSPEND || OP(scan) == GOSUB) {
4767             I32 paren = 0;
4768             regnode *start = NULL;
4769             regnode *end = NULL;
4770             U32 my_recursed_depth= recursed_depth;
4771
4772             if (OP(scan) != SUSPEND) { /* GOSUB */
4773                 /* Do setup, note this code has side effects beyond
4774                  * the rest of this block. Specifically setting
4775                  * RExC_recurse[] must happen at least once during
4776                  * study_chunk(). */
4777                 paren = ARG(scan);
4778                 RExC_recurse[ARG2L(scan)] = scan;
4779                 start = RExC_open_parens[paren];
4780                 end   = RExC_close_parens[paren];
4781
4782                 /* NOTE we MUST always execute the above code, even
4783                  * if we do nothing with a GOSUB */
4784                 if (
4785                     ( flags & SCF_IN_DEFINE )
4786                     ||
4787                     (
4788                         (is_inf_internal || is_inf || (data && data->flags & SF_IS_INF))
4789                         &&
4790                         ( (flags & (SCF_DO_STCLASS | SCF_DO_SUBSTR)) == 0 )
4791                     )
4792                 ) {
4793                     /* no need to do anything here if we are in a define. */
4794                     /* or we are after some kind of infinite construct
4795                      * so we can skip recursing into this item.
4796                      * Since it is infinite we will not change the maxlen
4797                      * or delta, and if we miss something that might raise
4798                      * the minlen it will merely pessimise a little.
4799                      *
4800                      * Iow /(?(DEFINE)(?<foo>foo|food))a+(?&foo)/
4801                      * might result in a minlen of 1 and not of 4,
4802                      * but this doesn't make us mismatch, just try a bit
4803                      * harder than we should.
4804                      * */
4805                     scan= regnext(scan);
4806                     continue;
4807                 }
4808
4809                 if (
4810                     !recursed_depth
4811                     ||
4812                     !PAREN_TEST(RExC_study_chunk_recursed + ((recursed_depth-1) * RExC_study_chunk_recursed_bytes), paren)
4813                 ) {
4814                     /* it is quite possible that there are more efficient ways
4815                      * to do this. We maintain a bitmap per level of recursion
4816                      * of which patterns we have entered so we can detect if a
4817                      * pattern creates a possible infinite loop. When we
4818                      * recurse down a level we copy the previous levels bitmap
4819                      * down. When we are at recursion level 0 we zero the top
4820                      * level bitmap. It would be nice to implement a different
4821                      * more efficient way of doing this. In particular the top
4822                      * level bitmap may be unnecessary.
4823                      */
4824                     if (!recursed_depth) {
4825                         Zero(RExC_study_chunk_recursed, RExC_study_chunk_recursed_bytes, U8);
4826                     } else {
4827                         Copy(RExC_study_chunk_recursed + ((recursed_depth-1) * RExC_study_chunk_recursed_bytes),
4828                              RExC_study_chunk_recursed + (recursed_depth * RExC_study_chunk_recursed_bytes),
4829                              RExC_study_chunk_recursed_bytes, U8);
4830                     }
4831                     /* we havent recursed into this paren yet, so recurse into it */
4832                     DEBUG_STUDYDATA("gosub-set", data, depth, is_inf);
4833                     PAREN_SET(RExC_study_chunk_recursed + (recursed_depth * RExC_study_chunk_recursed_bytes), paren);
4834                     my_recursed_depth= recursed_depth + 1;
4835                 } else {
4836                     DEBUG_STUDYDATA("gosub-inf", data, depth, is_inf);
4837                     /* some form of infinite recursion, assume infinite length
4838                      * */
4839                     if (flags & SCF_DO_SUBSTR) {
4840                         scan_commit(pRExC_state, data, minlenp, is_inf);
4841                         data->cur_is_floating = 1;
4842                     }
4843                     is_inf = is_inf_internal = 1;
4844                     if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
4845                         ssc_anything(data->start_class);
4846                     flags &= ~SCF_DO_STCLASS;
4847
4848                     start= NULL; /* reset start so we dont recurse later on. */
4849                 }
4850             } else {
4851                 paren = stopparen;
4852                 start = scan + 2;
4853                 end = regnext(scan);
4854             }
4855             if (start) {
4856                 scan_frame *newframe;
4857                 assert(end);
4858                 if (!RExC_frame_last) {
4859                     Newxz(newframe, 1, scan_frame);
4860                     SAVEDESTRUCTOR_X(S_unwind_scan_frames, newframe);
4861                     RExC_frame_head= newframe;
4862                     RExC_frame_count++;
4863                 } else if (!RExC_frame_last->next_frame) {
4864                     Newxz(newframe,1,scan_frame);
4865                     RExC_frame_last->next_frame= newframe;
4866                     newframe->prev_frame= RExC_frame_last;
4867                     RExC_frame_count++;
4868                 } else {
4869                     newframe= RExC_frame_last->next_frame;
4870                 }
4871                 RExC_frame_last= newframe;
4872
4873                 newframe->next_regnode = regnext(scan);
4874                 newframe->last_regnode = last;
4875                 newframe->stopparen = stopparen;
4876                 newframe->prev_recursed_depth = recursed_depth;
4877                 newframe->this_prev_frame= frame;
4878
4879                 DEBUG_STUDYDATA("frame-new", data, depth, is_inf);
4880                 DEBUG_PEEP("fnew", scan, depth, flags);
4881
4882                 frame = newframe;
4883                 scan =  start;
4884                 stopparen = paren;
4885                 last = end;
4886                 depth = depth + 1;
4887                 recursed_depth= my_recursed_depth;
4888
4889                 continue;
4890             }
4891         }
4892         else if (OP(scan) == EXACT || OP(scan) == EXACTL) {
4893             SSize_t l = STR_LEN(scan);
4894             UV uc;
4895             assert(l);
4896             if (UTF) {
4897                 const U8 * const s = (U8*)STRING(scan);
4898                 uc = utf8_to_uvchr_buf(s, s + l, NULL);
4899                 l = utf8_length(s, s + l);
4900             } else {
4901                 uc = *((U8*)STRING(scan));
4902             }
4903             min += l;
4904             if (flags & SCF_DO_SUBSTR) { /* Update longest substr. */
4905                 /* The code below prefers earlier match for fixed
4906                    offset, later match for variable offset.  */
4907                 if (data->last_end == -1) { /* Update the start info. */
4908                     data->last_start_min = data->pos_min;
4909                     data->last_start_max = is_inf
4910                         ? SSize_t_MAX : data->pos_min + data->pos_delta;
4911                 }
4912                 sv_catpvn(data->last_found, STRING(scan), STR_LEN(scan));
4913                 if (UTF)
4914                     SvUTF8_on(data->last_found);
4915                 {
4916                     SV * const sv = data->last_found;
4917                     MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
4918                         mg_find(sv, PERL_MAGIC_utf8) : NULL;
4919                     if (mg && mg->mg_len >= 0)
4920                         mg->mg_len += utf8_length((U8*)STRING(scan),
4921                                               (U8*)STRING(scan)+STR_LEN(scan));
4922                 }
4923                 data->last_end = data->pos_min + l;
4924                 data->pos_min += l; /* As in the first entry. */
4925                 data->flags &= ~SF_BEFORE_EOL;
4926             }
4927
4928             /* ANDing the code point leaves at most it, and not in locale, and
4929              * can't match null string */
4930             if (flags & SCF_DO_STCLASS_AND) {
4931                 ssc_cp_and(data->start_class, uc);
4932                 ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
4933                 ssc_clear_locale(data->start_class);
4934             }
4935             else if (flags & SCF_DO_STCLASS_OR) {
4936                 ssc_add_cp(data->start_class, uc);
4937                 ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
4938
4939                 /* See commit msg 749e076fceedeb708a624933726e7989f2302f6a */
4940                 ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
4941             }
4942             flags &= ~SCF_DO_STCLASS;
4943         }
4944         else if (PL_regkind[OP(scan)] == EXACT) {
4945             /* But OP != EXACT!, so is EXACTFish */
4946             SSize_t l = STR_LEN(scan);
4947             const U8 * s = (U8*)STRING(scan);
4948
4949             /* Search for fixed substrings supports EXACT only. */
4950             if (flags & SCF_DO_SUBSTR) {
4951                 assert(data);
4952                 scan_commit(pRExC_state, data, minlenp, is_inf);
4953             }
4954             if (UTF) {
4955                 l = utf8_length(s, s + l);
4956             }
4957             if (unfolded_multi_char) {
4958                 RExC_seen |= REG_UNFOLDED_MULTI_SEEN;
4959             }
4960             min += l - min_subtract;
4961             assert (min >= 0);
4962             delta += min_subtract;
4963             if (flags & SCF_DO_SUBSTR) {
4964                 data->pos_min += l - min_subtract;
4965                 if (data->pos_min < 0) {
4966                     data->pos_min = 0;
4967                 }
4968                 data->pos_delta += min_subtract;
4969                 if (min_subtract) {
4970                     data->cur_is_floating = 1; /* float */
4971                 }
4972             }
4973
4974             if (flags & SCF_DO_STCLASS) {
4975                 SV* EXACTF_invlist = _make_exactf_invlist(pRExC_state, scan);
4976
4977                 assert(EXACTF_invlist);
4978                 if (flags & SCF_DO_STCLASS_AND) {
4979                     if (OP(scan) != EXACTFL)
4980                         ssc_clear_locale(data->start_class);
4981                     ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
4982                     ANYOF_POSIXL_ZERO(data->start_class);
4983                     ssc_intersection(data->start_class, EXACTF_invlist, FALSE);
4984                 }
4985                 else {  /* SCF_DO_STCLASS_OR */
4986                     ssc_union(data->start_class, EXACTF_invlist, FALSE);
4987                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
4988
4989                     /* See commit msg 749e076fceedeb708a624933726e7989f2302f6a */
4990                     ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
4991                 }
4992                 flags &= ~SCF_DO_STCLASS;
4993                 SvREFCNT_dec(EXACTF_invlist);
4994             }
4995         }
4996         else if (REGNODE_VARIES(OP(scan))) {
4997             SSize_t mincount, maxcount, minnext, deltanext, pos_before = 0;
4998             I32 fl = 0, f = flags;
4999             regnode * const oscan = scan;
5000             regnode_ssc this_class;
5001             regnode_ssc *oclass = NULL;
5002             I32 next_is_eval = 0;
5003
5004             switch (PL_regkind[OP(scan)]) {
5005             case WHILEM:                /* End of (?:...)* . */
5006                 scan = NEXTOPER(scan);
5007                 goto finish;
5008             case PLUS:
5009                 if (flags & (SCF_DO_SUBSTR | SCF_DO_STCLASS)) {
5010                     next = NEXTOPER(scan);
5011                     if (OP(next) == EXACT
5012                         || OP(next) == EXACTL
5013                         || (flags & SCF_DO_STCLASS))
5014                     {
5015                         mincount = 1;
5016                         maxcount = REG_INFTY;
5017                         next = regnext(scan);
5018                         scan = NEXTOPER(scan);
5019                         goto do_curly;
5020                     }
5021                 }
5022                 if (flags & SCF_DO_SUBSTR)
5023                     data->pos_min++;
5024                 min++;
5025                 /* FALLTHROUGH */
5026             case STAR:
5027                 if (flags & SCF_DO_STCLASS) {
5028                     mincount = 0;
5029                     maxcount = REG_INFTY;
5030                     next = regnext(scan);
5031                     scan = NEXTOPER(scan);
5032                     goto do_curly;
5033                 }
5034                 if (flags & SCF_DO_SUBSTR) {
5035                     scan_commit(pRExC_state, data, minlenp, is_inf);
5036                     /* Cannot extend fixed substrings */
5037                     data->cur_is_floating = 1; /* float */
5038                 }
5039                 is_inf = is_inf_internal = 1;
5040                 scan = regnext(scan);
5041                 goto optimize_curly_tail;
5042             case CURLY:
5043                 if (stopparen>0 && (OP(scan)==CURLYN || OP(scan)==CURLYM)
5044                     && (scan->flags == stopparen))
5045                 {
5046                     mincount = 1;
5047                     maxcount = 1;
5048                 } else {
5049                     mincount = ARG1(scan);
5050                     maxcount = ARG2(scan);
5051                 }
5052                 next = regnext(scan);
5053                 if (OP(scan) == CURLYX) {
5054                     I32 lp = (data ? *(data->last_closep) : 0);
5055                     scan->flags = ((lp <= (I32)U8_MAX) ? (U8)lp : U8_MAX);
5056                 }
5057                 scan = NEXTOPER(scan) + EXTRA_STEP_2ARGS;
5058                 next_is_eval = (OP(scan) == EVAL);
5059               do_curly:
5060                 if (flags & SCF_DO_SUBSTR) {
5061                     if (mincount == 0)
5062                         scan_commit(pRExC_state, data, minlenp, is_inf);
5063                     /* Cannot extend fixed substrings */
5064                     pos_before = data->pos_min;
5065                 }
5066                 if (data) {
5067                     fl = data->flags;
5068                     data->flags &= ~(SF_HAS_PAR|SF_IN_PAR|SF_HAS_EVAL);
5069                     if (is_inf)
5070                         data->flags |= SF_IS_INF;
5071                 }
5072                 if (flags & SCF_DO_STCLASS) {
5073                     ssc_init(pRExC_state, &this_class);
5074                     oclass = data->start_class;
5075                     data->start_class = &this_class;
5076                     f |= SCF_DO_STCLASS_AND;
5077                     f &= ~SCF_DO_STCLASS_OR;
5078                 }
5079                 /* Exclude from super-linear cache processing any {n,m}
5080                    regops for which the combination of input pos and regex
5081                    pos is not enough information to determine if a match
5082                    will be possible.
5083
5084                    For example, in the regex /foo(bar\s*){4,8}baz/ with the
5085                    regex pos at the \s*, the prospects for a match depend not
5086                    only on the input position but also on how many (bar\s*)
5087                    repeats into the {4,8} we are. */
5088                if ((mincount > 1) || (maxcount > 1 && maxcount != REG_INFTY))
5089                     f &= ~SCF_WHILEM_VISITED_POS;
5090
5091                 /* This will finish on WHILEM, setting scan, or on NULL: */
5092                 minnext = study_chunk(pRExC_state, &scan, minlenp, &deltanext,
5093                                   last, data, stopparen, recursed_depth, NULL,
5094                                   (mincount == 0
5095                                    ? (f & ~SCF_DO_SUBSTR)
5096                                    : f)
5097                                   ,depth+1);
5098
5099                 if (flags & SCF_DO_STCLASS)
5100                     data->start_class = oclass;
5101                 if (mincount == 0 || minnext == 0) {
5102                     if (flags & SCF_DO_STCLASS_OR) {
5103                         ssc_or(pRExC_state, data->start_class, (regnode_charclass *) &this_class);
5104                     }
5105                     else if (flags & SCF_DO_STCLASS_AND) {
5106                         /* Switch to OR mode: cache the old value of
5107                          * data->start_class */
5108                         INIT_AND_WITHP;
5109                         StructCopy(data->start_class, and_withp, regnode_ssc);
5110                         flags &= ~SCF_DO_STCLASS_AND;
5111                         StructCopy(&this_class, data->start_class, regnode_ssc);
5112                         flags |= SCF_DO_STCLASS_OR;
5113                         ANYOF_FLAGS(data->start_class)
5114                                                 |= SSC_MATCHES_EMPTY_STRING;
5115                     }
5116                 } else {                /* Non-zero len */
5117                     if (flags & SCF_DO_STCLASS_OR) {
5118                         ssc_or(pRExC_state, data->start_class, (regnode_charclass *) &this_class);
5119                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5120                     }
5121                     else if (flags & SCF_DO_STCLASS_AND)
5122                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &this_class);
5123                     flags &= ~SCF_DO_STCLASS;
5124                 }
5125                 if (!scan)              /* It was not CURLYX, but CURLY. */
5126                     scan = next;
5127                 if (((flags & (SCF_TRIE_DOING_RESTUDY|SCF_DO_SUBSTR))==SCF_DO_SUBSTR)
5128                     /* ? quantifier ok, except for (?{ ... }) */
5129                     && (next_is_eval || !(mincount == 0 && maxcount == 1))
5130                     && (minnext == 0) && (deltanext == 0)
5131                     && data && !(data->flags & (SF_HAS_PAR|SF_IN_PAR))
5132                     && maxcount <= REG_INFTY/3) /* Complement check for big
5133                                                    count */
5134                 {
5135                     /* Fatal warnings may leak the regexp without this: */
5136                     SAVEFREESV(RExC_rx_sv);
5137                     Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),
5138                         "Quantifier unexpected on zero-length expression "
5139                         "in regex m/%" UTF8f "/",
5140                          UTF8fARG(UTF, RExC_precomp_end - RExC_precomp,
5141                                   RExC_precomp));
5142                     (void)ReREFCNT_inc(RExC_rx_sv);
5143                 }
5144
5145                 min += minnext * mincount;
5146                 is_inf_internal |= deltanext == SSize_t_MAX
5147                          || (maxcount == REG_INFTY && minnext + deltanext > 0);
5148                 is_inf |= is_inf_internal;
5149                 if (is_inf) {
5150                     delta = SSize_t_MAX;
5151                 } else {
5152                     delta += (minnext + deltanext) * maxcount
5153                              - minnext * mincount;
5154                 }
5155                 /* Try powerful optimization CURLYX => CURLYN. */
5156                 if (  OP(oscan) == CURLYX && data
5157                       && data->flags & SF_IN_PAR
5158                       && !(data->flags & SF_HAS_EVAL)
5159                       && !deltanext && minnext == 1 ) {
5160                     /* Try to optimize to CURLYN.  */
5161                     regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS;
5162                     regnode * const nxt1 = nxt;
5163 #ifdef DEBUGGING
5164                     regnode *nxt2;
5165 #endif
5166
5167                     /* Skip open. */
5168                     nxt = regnext(nxt);
5169                     if (!REGNODE_SIMPLE(OP(nxt))
5170                         && !(PL_regkind[OP(nxt)] == EXACT
5171                              && STR_LEN(nxt) == 1))
5172                         goto nogo;
5173 #ifdef DEBUGGING
5174                     nxt2 = nxt;
5175 #endif
5176                     nxt = regnext(nxt);
5177                     if (OP(nxt) != CLOSE)
5178                         goto nogo;
5179                     if (RExC_open_parens) {
5180                         RExC_open_parens[ARG(nxt1)]=oscan; /*open->CURLYM*/
5181                         RExC_close_parens[ARG(nxt1)]=nxt+2; /*close->while*/
5182                     }
5183                     /* Now we know that nxt2 is the only contents: */
5184                     oscan->flags = (U8)ARG(nxt);
5185                     OP(oscan) = CURLYN;
5186                     OP(nxt1) = NOTHING; /* was OPEN. */
5187
5188 #ifdef DEBUGGING
5189                     OP(nxt1 + 1) = OPTIMIZED; /* was count. */
5190                     NEXT_OFF(nxt1+ 1) = 0; /* just for consistency. */
5191                     NEXT_OFF(nxt2) = 0; /* just for consistency with CURLY. */
5192                     OP(nxt) = OPTIMIZED;        /* was CLOSE. */
5193                     OP(nxt + 1) = OPTIMIZED; /* was count. */
5194                     NEXT_OFF(nxt+ 1) = 0; /* just for consistency. */
5195 #endif
5196                 }
5197               nogo:
5198
5199                 /* Try optimization CURLYX => CURLYM. */
5200                 if (  OP(oscan) == CURLYX && data
5201                       && !(data->flags & SF_HAS_PAR)
5202                       && !(data->flags & SF_HAS_EVAL)
5203                       && !deltanext     /* atom is fixed width */
5204                       && minnext != 0   /* CURLYM can't handle zero width */
5205
5206                          /* Nor characters whose fold at run-time may be
5207                           * multi-character */
5208                       && ! (RExC_seen & REG_UNFOLDED_MULTI_SEEN)
5209                 ) {
5210                     /* XXXX How to optimize if data == 0? */
5211                     /* Optimize to a simpler form.  */
5212                     regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN */
5213                     regnode *nxt2;
5214
5215                     OP(oscan) = CURLYM;
5216                     while ( (nxt2 = regnext(nxt)) /* skip over embedded stuff*/
5217                             && (OP(nxt2) != WHILEM))
5218                         nxt = nxt2;
5219                     OP(nxt2)  = SUCCEED; /* Whas WHILEM */
5220                     /* Need to optimize away parenths. */
5221                     if ((data->flags & SF_IN_PAR) && OP(nxt) == CLOSE) {
5222                         /* Set the parenth number.  */
5223                         regnode *nxt1 = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN*/
5224
5225                         oscan->flags = (U8)ARG(nxt);
5226                         if (RExC_open_parens) {
5227                             RExC_open_parens[ARG(nxt1)]=oscan; /*open->CURLYM*/
5228                             RExC_close_parens[ARG(nxt1)]=nxt2+1; /*close->NOTHING*/
5229                         }
5230                         OP(nxt1) = OPTIMIZED;   /* was OPEN. */
5231                         OP(nxt) = OPTIMIZED;    /* was CLOSE. */
5232
5233 #ifdef DEBUGGING
5234                         OP(nxt1 + 1) = OPTIMIZED; /* was count. */
5235                         OP(nxt + 1) = OPTIMIZED; /* was count. */
5236                         NEXT_OFF(nxt1 + 1) = 0; /* just for consistency. */
5237                         NEXT_OFF(nxt + 1) = 0; /* just for consistency. */
5238 #endif
5239 #if 0
5240                         while ( nxt1 && (OP(nxt1) != WHILEM)) {
5241                             regnode *nnxt = regnext(nxt1);
5242                             if (nnxt == nxt) {
5243                                 if (reg_off_by_arg[OP(nxt1)])
5244                                     ARG_SET(nxt1, nxt2 - nxt1);
5245                                 else if (nxt2 - nxt1 < U16_MAX)
5246                                     NEXT_OFF(nxt1) = nxt2 - nxt1;
5247                                 else
5248                                     OP(nxt) = NOTHING;  /* Cannot beautify */
5249                             }
5250                             nxt1 = nnxt;
5251                         }
5252 #endif
5253                         /* Optimize again: */
5254                         study_chunk(pRExC_state, &nxt1, minlenp, &deltanext, nxt,
5255                                     NULL, stopparen, recursed_depth, NULL, 0,depth+1);
5256                     }
5257                     else
5258                         oscan->flags = 0;
5259                 }
5260                 else if ((OP(oscan) == CURLYX)
5261                          && (flags & SCF_WHILEM_VISITED_POS)
5262                          /* See the comment on a similar expression above.
5263                             However, this time it's not a subexpression
5264                             we care about, but the expression itself. */
5265                          && (maxcount == REG_INFTY)
5266                          && data) {
5267                     /* This stays as CURLYX, we can put the count/of pair. */
5268                     /* Find WHILEM (as in regexec.c) */
5269                     regnode *nxt = oscan + NEXT_OFF(oscan);
5270
5271                     if (OP(PREVOPER(nxt)) == NOTHING) /* LONGJMP */
5272                         nxt += ARG(nxt);
5273                     nxt = PREVOPER(nxt);
5274                     if (nxt->flags & 0xf) {
5275                         /* we've already set whilem count on this node */
5276                     } else if (++data->whilem_c < 16) {
5277                         assert(data->whilem_c <= RExC_whilem_seen);
5278                         nxt->flags = (U8)(data->whilem_c
5279                             | (RExC_whilem_seen << 4)); /* On WHILEM */
5280                     }
5281                 }
5282                 if (data && fl & (SF_HAS_PAR|SF_IN_PAR))
5283                     pars++;
5284                 if (flags & SCF_DO_SUBSTR) {
5285                     SV *last_str = NULL;
5286                     STRLEN last_chrs = 0;
5287                     int counted = mincount != 0;
5288
5289                     if (data->last_end > 0 && mincount != 0) { /* Ends with a
5290                                                                   string. */
5291                         SSize_t b = pos_before >= data->last_start_min
5292                             ? pos_before : data->last_start_min;
5293                         STRLEN l;
5294                         const char * const s = SvPV_const(data->last_found, l);
5295                         SSize_t old = b - data->last_start_min;
5296
5297                         if (UTF)
5298                             old = utf8_hop((U8*)s, old) - (U8*)s;
5299                         l -= old;
5300                         /* Get the added string: */
5301                         last_str = newSVpvn_utf8(s  + old, l, UTF);
5302                         last_chrs = UTF ? utf8_length((U8*)(s + old),
5303                                             (U8*)(s + old + l)) : l;
5304                         if (deltanext == 0 && pos_before == b) {
5305                             /* What was added is a constant string */
5306                             if (mincount > 1) {
5307
5308                                 SvGROW(last_str, (mincount * l) + 1);
5309                                 repeatcpy(SvPVX(last_str) + l,
5310                                           SvPVX_const(last_str), l,
5311                                           mincount - 1);
5312                                 SvCUR_set(last_str, SvCUR(last_str) * mincount);
5313                                 /* Add additional parts. */
5314                                 SvCUR_set(data->last_found,
5315                                           SvCUR(data->last_found) - l);
5316                                 sv_catsv(data->last_found, last_str);
5317                                 {
5318                                     SV * sv = data->last_found;
5319                                     MAGIC *mg =
5320                                         SvUTF8(sv) && SvMAGICAL(sv) ?
5321                                         mg_find(sv, PERL_MAGIC_utf8) : NULL;
5322                                     if (mg && mg->mg_len >= 0)
5323                                         mg->mg_len += last_chrs * (mincount-1);
5324                                 }
5325                                 last_chrs *= mincount;
5326                                 data->last_end += l * (mincount - 1);
5327                             }
5328                         } else {
5329                             /* start offset must point into the last copy */
5330                             data->last_start_min += minnext * (mincount - 1);
5331                             data->last_start_max =
5332                               is_inf
5333                                ? SSize_t_MAX
5334                                : data->last_start_max +
5335                                  (maxcount - 1) * (minnext + data->pos_delta);
5336                         }
5337                     }
5338                     /* It is counted once already... */
5339                     data->pos_min += minnext * (mincount - counted);
5340 #if 0
5341 Perl_re_printf( aTHX_  "counted=%" UVuf " deltanext=%" UVuf
5342                               " SSize_t_MAX=%" UVuf " minnext=%" UVuf
5343                               " maxcount=%" UVuf " mincount=%" UVuf "\n",
5344     (UV)counted, (UV)deltanext, (UV)SSize_t_MAX, (UV)minnext, (UV)maxcount,
5345     (UV)mincount);
5346 if (deltanext != SSize_t_MAX)
5347 Perl_re_printf( aTHX_  "LHS=%" UVuf " RHS=%" UVuf "\n",
5348     (UV)(-counted * deltanext + (minnext + deltanext) * maxcount
5349           - minnext * mincount), (UV)(SSize_t_MAX - data->pos_delta));
5350 #endif
5351                     if (deltanext == SSize_t_MAX
5352                         || -counted * deltanext + (minnext + deltanext) * maxcount - minnext * mincount >= SSize_t_MAX - data->pos_delta)
5353                         data->pos_delta = SSize_t_MAX;
5354                     else
5355                         data->pos_delta += - counted * deltanext +
5356                         (minnext + deltanext) * maxcount - minnext * mincount;
5357                     if (mincount != maxcount) {
5358                          /* Cannot extend fixed substrings found inside
5359                             the group.  */
5360                         scan_commit(pRExC_state, data, minlenp, is_inf);
5361                         if (mincount && last_str) {
5362                             SV * const sv = data->last_found;
5363                             MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
5364                                 mg_find(sv, PERL_MAGIC_utf8) : NULL;
5365
5366                             if (mg)
5367                                 mg->mg_len = -1;
5368                             sv_setsv(sv, last_str);
5369                             data->last_end = data->pos_min;
5370                             data->last_start_min = data->pos_min - last_chrs;
5371                             data->last_start_max = is_inf
5372                                 ? SSize_t_MAX
5373                                 : data->pos_min + data->pos_delta - last_chrs;
5374                         }
5375                         data->cur_is_floating = 1; /* float */
5376                     }
5377                     SvREFCNT_dec(last_str);
5378                 }
5379                 if (data && (fl & SF_HAS_EVAL))
5380                     data->flags |= SF_HAS_EVAL;
5381               optimize_curly_tail:
5382                 if (OP(oscan) != CURLYX) {
5383                     while (PL_regkind[OP(next = regnext(oscan))] == NOTHING
5384                            && NEXT_OFF(next))
5385                         NEXT_OFF(oscan) += NEXT_OFF(next);
5386                 }
5387                 continue;
5388
5389             default:
5390 #ifdef DEBUGGING
5391                 Perl_croak(aTHX_ "panic: unexpected varying REx opcode %d",
5392                                                                     OP(scan));
5393 #endif
5394             case REF:
5395             case CLUMP:
5396                 if (flags & SCF_DO_SUBSTR) {
5397                     /* Cannot expect anything... */
5398                     scan_commit(pRExC_state, data, minlenp, is_inf);
5399                     data->cur_is_floating = 1; /* float */
5400                 }
5401                 is_inf = is_inf_internal = 1;
5402                 if (flags & SCF_DO_STCLASS_OR) {
5403                     if (OP(scan) == CLUMP) {
5404                         /* Actually is any start char, but very few code points
5405                          * aren't start characters */
5406                         ssc_match_all_cp(data->start_class);
5407                     }
5408                     else {
5409                         ssc_anything(data->start_class);
5410                     }
5411                 }
5412                 flags &= ~SCF_DO_STCLASS;
5413                 break;
5414             }
5415         }
5416         else if (OP(scan) == LNBREAK) {
5417             if (flags & SCF_DO_STCLASS) {
5418                 if (flags & SCF_DO_STCLASS_AND) {
5419                     ssc_intersection(data->start_class,
5420                                     PL_XPosix_ptrs[_CC_VERTSPACE], FALSE);
5421                     ssc_clear_locale(data->start_class);
5422                     ANYOF_FLAGS(data->start_class)
5423                                                 &= ~SSC_MATCHES_EMPTY_STRING;
5424                 }
5425                 else if (flags & SCF_DO_STCLASS_OR) {
5426                     ssc_union(data->start_class,
5427                               PL_XPosix_ptrs[_CC_VERTSPACE],
5428                               FALSE);
5429                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5430
5431                     /* See commit msg for
5432                      * 749e076fceedeb708a624933726e7989f2302f6a */
5433                     ANYOF_FLAGS(data->start_class)
5434                                                 &= ~SSC_MATCHES_EMPTY_STRING;
5435                 }
5436                 flags &= ~SCF_DO_STCLASS;
5437             }
5438             min++;
5439             if (delta != SSize_t_MAX)
5440                 delta++;    /* Because of the 2 char string cr-lf */
5441             if (flags & SCF_DO_SUBSTR) {
5442                 /* Cannot expect anything... */
5443                 scan_commit(pRExC_state, data, minlenp, is_inf);
5444                 data->pos_min += 1;
5445                 data->pos_delta += 1;
5446                 data->cur_is_floating = 1; /* float */
5447             }
5448         }
5449         else if (REGNODE_SIMPLE(OP(scan))) {
5450
5451             if (flags & SCF_DO_SUBSTR) {
5452                 scan_commit(pRExC_state, data, minlenp, is_inf);
5453                 data->pos_min++;
5454             }
5455             min++;
5456             if (flags & SCF_DO_STCLASS) {
5457                 bool invert = 0;
5458                 SV* my_invlist = NULL;
5459                 U8 namedclass;
5460
5461                 /* See commit msg 749e076fceedeb708a624933726e7989f2302f6a */
5462                 ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
5463
5464                 /* Some of the logic below assumes that switching
5465                    locale on will only add false positives. */
5466                 switch (OP(scan)) {
5467
5468                 default:
5469 #ifdef DEBUGGING
5470                    Perl_croak(aTHX_ "panic: unexpected simple REx opcode %d",
5471                                                                      OP(scan));
5472 #endif
5473                 case SANY:
5474                     if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
5475                         ssc_match_all_cp(data->start_class);
5476                     break;
5477
5478                 case REG_ANY:
5479                     {
5480                         SV* REG_ANY_invlist = _new_invlist(2);
5481                         REG_ANY_invlist = add_cp_to_invlist(REG_ANY_invlist,
5482                                                             '\n');
5483                         if (flags & SCF_DO_STCLASS_OR) {
5484                             ssc_union(data->start_class,
5485                                       REG_ANY_invlist,
5486                                       TRUE /* TRUE => invert, hence all but \n
5487                                             */
5488                                       );
5489                         }
5490                         else if (flags & SCF_DO_STCLASS_AND) {
5491                             ssc_intersection(data->start_class,
5492                                              REG_ANY_invlist,
5493                                              TRUE  /* TRUE => invert */
5494                                              );
5495                             ssc_clear_locale(data->start_class);
5496                         }
5497                         SvREFCNT_dec_NN(REG_ANY_invlist);
5498                     }
5499                     break;
5500
5501                 case ANYOFD:
5502                 case ANYOFL:
5503                 case ANYOF:
5504                     if (flags & SCF_DO_STCLASS_AND)
5505                         ssc_and(pRExC_state, data->start_class,
5506                                 (regnode_charclass *) scan);
5507                     else
5508                         ssc_or(pRExC_state, data->start_class,
5509                                                           (regnode_charclass *) scan);
5510                     break;
5511
5512                 case NPOSIXL:
5513                     invert = 1;
5514                     /* FALLTHROUGH */
5515
5516                 case POSIXL:
5517                     namedclass = classnum_to_namedclass(FLAGS(scan)) + invert;
5518                     if (flags & SCF_DO_STCLASS_AND) {
5519                         bool was_there = cBOOL(
5520                                           ANYOF_POSIXL_TEST(data->start_class,
5521                                                                  namedclass));
5522                         ANYOF_POSIXL_ZERO(data->start_class);
5523                         if (was_there) {    /* Do an AND */
5524                             ANYOF_POSIXL_SET(data->start_class, namedclass);
5525                         }
5526                         /* No individual code points can now match */
5527                         data->start_class->invlist
5528                                                 = sv_2mortal(_new_invlist(0));
5529                     }
5530                     else {
5531                         int complement = namedclass + ((invert) ? -1 : 1);
5532
5533                         assert(flags & SCF_DO_STCLASS_OR);
5534
5535                         /* If the complement of this class was already there,
5536                          * the result is that they match all code points,
5537                          * (\d + \D == everything).  Remove the classes from
5538                          * future consideration.  Locale is not relevant in
5539                          * this case */
5540                         if (ANYOF_POSIXL_TEST(data->start_class, complement)) {
5541                             ssc_match_all_cp(data->start_class);
5542                             ANYOF_POSIXL_CLEAR(data->start_class, namedclass);
5543                             ANYOF_POSIXL_CLEAR(data->start_class, complement);
5544                         }
5545                         else {  /* The usual case; just add this class to the
5546                                    existing set */
5547                             ANYOF_POSIXL_SET(data->start_class, namedclass);
5548                         }
5549                     }
5550                     break;
5551
5552                 case NPOSIXA:   /* For these, we always know the exact set of
5553                                    what's matched */
5554                     invert = 1;
5555                     /* FALLTHROUGH */
5556                 case POSIXA:
5557                     if (FLAGS(scan) == _CC_ASCII) {
5558                         my_invlist = invlist_clone(PL_XPosix_ptrs[_CC_ASCII]);
5559                     }
5560                     else {
5561                         _invlist_intersection(PL_XPosix_ptrs[FLAGS(scan)],
5562                                               PL_XPosix_ptrs[_CC_ASCII],
5563                                               &my_invlist);
5564                     }
5565                     goto join_posix;
5566
5567                 case NPOSIXD:
5568                 case NPOSIXU:
5569                     invert = 1;
5570                     /* FALLTHROUGH */
5571                 case POSIXD:
5572                 case POSIXU:
5573                     my_invlist = invlist_clone(PL_XPosix_ptrs[FLAGS(scan)]);
5574
5575                     /* NPOSIXD matches all upper Latin1 code points unless the
5576                      * target string being matched is UTF-8, which is
5577                      * unknowable until match time.  Since we are going to
5578                      * invert, we want to get rid of all of them so that the
5579                      * inversion will match all */
5580                     if (OP(scan) == NPOSIXD) {
5581                         _invlist_subtract(my_invlist, PL_UpperLatin1,
5582                                           &my_invlist);
5583                     }
5584
5585                   join_posix:
5586
5587                     if (flags & SCF_DO_STCLASS_AND) {
5588                         ssc_intersection(data->start_class, my_invlist, invert);
5589                         ssc_clear_locale(data->start_class);
5590                     }
5591                     else {
5592                         assert(flags & SCF_DO_STCLASS_OR);
5593                         ssc_union(data->start_class, my_invlist, invert);
5594                     }
5595                     SvREFCNT_dec(my_invlist);
5596                 }
5597                 if (flags & SCF_DO_STCLASS_OR)
5598                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5599                 flags &= ~SCF_DO_STCLASS;
5600             }
5601         }
5602         else if (PL_regkind[OP(scan)] == EOL && flags & SCF_DO_SUBSTR) {
5603             data->flags |= (OP(scan) == MEOL
5604                             ? SF_BEFORE_MEOL
5605                             : SF_BEFORE_SEOL);
5606             scan_commit(pRExC_state, data, minlenp, is_inf);
5607
5608         }
5609         else if (  PL_regkind[OP(scan)] == BRANCHJ
5610                  /* Lookbehind, or need to calculate parens/evals/stclass: */
5611                    && (scan->flags || data || (flags & SCF_DO_STCLASS))
5612                    && (OP(scan) == IFMATCH || OP(scan) == UNLESSM))
5613         {
5614             if ( !PERL_ENABLE_POSITIVE_ASSERTION_STUDY
5615                 || OP(scan) == UNLESSM )
5616             {
5617                 /* Negative Lookahead/lookbehind
5618                    In this case we can't do fixed string optimisation.
5619                 */
5620
5621                 SSize_t deltanext, minnext, fake = 0;
5622                 regnode *nscan;
5623                 regnode_ssc intrnl;
5624                 int f = 0;
5625
5626                 StructCopy(&zero_scan_data, &data_fake, scan_data_t);
5627                 if (data) {
5628                     data_fake.whilem_c = data->whilem_c;
5629                     data_fake.last_closep = data->last_closep;
5630                 }
5631                 else
5632                     data_fake.last_closep = &fake;
5633                 data_fake.pos_delta = delta;
5634                 if ( flags & SCF_DO_STCLASS && !scan->flags
5635                      && OP(scan) == IFMATCH ) { /* Lookahead */
5636                     ssc_init(pRExC_state, &intrnl);
5637                     data_fake.start_class = &intrnl;
5638                     f |= SCF_DO_STCLASS_AND;
5639                 }
5640                 if (flags & SCF_WHILEM_VISITED_POS)
5641                     f |= SCF_WHILEM_VISITED_POS;
5642                 next = regnext(scan);
5643                 nscan = NEXTOPER(NEXTOPER(scan));
5644                 minnext = study_chunk(pRExC_state, &nscan, minlenp, &deltanext,
5645                                       last, &data_fake, stopparen,
5646                                       recursed_depth, NULL, f, depth+1);
5647                 if (scan->flags) {
5648                     if (deltanext) {
5649                         FAIL("Variable length lookbehind not implemented");
5650                     }
5651                     else if (minnext > (I32)U8_MAX) {
5652                         FAIL2("Lookbehind longer than %" UVuf " not implemented",
5653                               (UV)U8_MAX);
5654                     }
5655                     scan->flags = (U8)minnext;
5656                 }
5657                 if (data) {
5658                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
5659                         pars++;
5660                     if (data_fake.flags & SF_HAS_EVAL)
5661                         data->flags |= SF_HAS_EVAL;
5662                     data->whilem_c = data_fake.whilem_c;
5663                 }
5664                 if (f & SCF_DO_STCLASS_AND) {
5665                     if (flags & SCF_DO_STCLASS_OR) {
5666                         /* OR before, AND after: ideally we would recurse with
5667                          * data_fake to get the AND applied by study of the
5668                          * remainder of the pattern, and then derecurse;
5669                          * *** HACK *** for now just treat as "no information".
5670                          * See [perl #56690].
5671                          */
5672                         ssc_init(pRExC_state, data->start_class);
5673                     }  else {
5674                         /* AND before and after: combine and continue.  These
5675                          * assertions are zero-length, so can match an EMPTY
5676                          * string */
5677                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &intrnl);
5678                         ANYOF_FLAGS(data->start_class)
5679                                                    |= SSC_MATCHES_EMPTY_STRING;
5680                     }
5681                 }
5682             }
5683 #if PERL_ENABLE_POSITIVE_ASSERTION_STUDY
5684             else {
5685                 /* Positive Lookahead/lookbehind
5686                    In this case we can do fixed string optimisation,
5687                    but we must be careful about it. Note in the case of
5688                    lookbehind the positions will be offset by the minimum
5689                    length of the pattern, something we won't know about
5690                    until after the recurse.
5691                 */
5692                 SSize_t deltanext, fake = 0;
5693                 regnode *nscan;
5694                 regnode_ssc intrnl;
5695                 int f = 0;
5696                 /* We use SAVEFREEPV so that when the full compile
5697                     is finished perl will clean up the allocated
5698                     minlens when it's all done. This way we don't
5699                     have to worry about freeing them when we know
5700                     they wont be used, which would be a pain.
5701                  */
5702                 SSize_t *minnextp;
5703                 Newx( minnextp, 1, SSize_t );
5704                 SAVEFREEPV(minnextp);
5705
5706                 if (data) {
5707                     StructCopy(data, &data_fake, scan_data_t);
5708                     if ((flags & SCF_DO_SUBSTR) && data->last_found) {
5709                         f |= SCF_DO_SUBSTR;
5710                         if (scan->flags)
5711                             scan_commit(pRExC_state, &data_fake, minlenp, is_inf);
5712                         data_fake.last_found=newSVsv(data->last_found);
5713                     }
5714                 }
5715                 else
5716                     data_fake.last_closep = &fake;
5717                 data_fake.flags = 0;
5718                 data_fake.substrs[0].flags = 0;
5719                 data_fake.substrs[1].flags = 0;
5720                 data_fake.pos_delta = delta;
5721                 if (is_inf)
5722                     data_fake.flags |= SF_IS_INF;
5723                 if ( flags & SCF_DO_STCLASS && !scan->flags
5724                      && OP(scan) == IFMATCH ) { /* Lookahead */
5725                     ssc_init(pRExC_state, &intrnl);
5726                     data_fake.start_class = &intrnl;
5727                     f |= SCF_DO_STCLASS_AND;
5728                 }
5729                 if (flags & SCF_WHILEM_VISITED_POS)
5730                     f |= SCF_WHILEM_VISITED_POS;
5731                 next = regnext(scan);
5732                 nscan = NEXTOPER(NEXTOPER(scan));
5733
5734                 *minnextp = study_chunk(pRExC_state, &nscan, minnextp,
5735                                         &deltanext, last, &data_fake,
5736                                         stopparen, recursed_depth, NULL,
5737                                         f,depth+1);
5738                 if (scan->flags) {
5739                     if (deltanext) {
5740                         FAIL("Variable length lookbehind not implemented");
5741                     }
5742                     else if (*minnextp > (I32)U8_MAX) {
5743                         FAIL2("Lookbehind longer than %" UVuf " not implemented",
5744                               (UV)U8_MAX);
5745                     }
5746                     scan->flags = (U8)*minnextp;
5747                 }
5748
5749                 *minnextp += min;
5750
5751                 if (f & SCF_DO_STCLASS_AND) {
5752                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &intrnl);
5753                     ANYOF_FLAGS(data->start_class) |= SSC_MATCHES_EMPTY_STRING;
5754                 }
5755                 if (data) {
5756                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
5757                         pars++;
5758                     if (data_fake.flags & SF_HAS_EVAL)
5759                         data->flags |= SF_HAS_EVAL;
5760                     data->whilem_c = data_fake.whilem_c;
5761                     if ((flags & SCF_DO_SUBSTR) && data_fake.last_found) {
5762                         int i;
5763                         if (RExC_rx->minlen<*minnextp)
5764                             RExC_rx->minlen=*minnextp;
5765                         scan_commit(pRExC_state, &data_fake, minnextp, is_inf);
5766                         SvREFCNT_dec_NN(data_fake.last_found);
5767
5768                         for (i = 0; i < 2; i++) {
5769                             if (data_fake.substrs[i].minlenp != minlenp) {
5770                                 data->substrs[i].min_offset =
5771                                             data_fake.substrs[i].min_offset;
5772                                 data->substrs[i].max_offset =
5773                                             data_fake.substrs[i].max_offset;
5774                                 data->substrs[i].minlenp =
5775                                             data_fake.substrs[i].minlenp;
5776                                 data->substrs[i].lookbehind += scan->flags;
5777                             }
5778                         }
5779                     }
5780                 }
5781             }
5782 #endif
5783         }
5784
5785         else if (OP(scan) == OPEN) {
5786             if (stopparen != (I32)ARG(scan))
5787                 pars++;
5788         }
5789         else if (OP(scan) == CLOSE) {
5790             if (stopparen == (I32)ARG(scan)) {
5791                 break;
5792             }
5793             if ((I32)ARG(scan) == is_par) {
5794                 next = regnext(scan);
5795
5796                 if ( next && (OP(next) != WHILEM) && next < last)
5797                     is_par = 0;         /* Disable optimization */
5798             }
5799             if (data)
5800                 *(data->last_closep) = ARG(scan);
5801         }
5802         else if (OP(scan) == EVAL) {
5803                 if (data)
5804                     data->flags |= SF_HAS_EVAL;
5805         }
5806         else if ( PL_regkind[OP(scan)] == ENDLIKE ) {
5807             if (flags & SCF_DO_SUBSTR) {
5808                 scan_commit(pRExC_state, data, minlenp, is_inf);
5809                 flags &= ~SCF_DO_SUBSTR;
5810             }
5811             if (data && OP(scan)==ACCEPT) {
5812                 data->flags |= SCF_SEEN_ACCEPT;
5813                 if (stopmin > min)
5814                     stopmin = min;
5815             }
5816         }
5817         else if (OP(scan) == LOGICAL && scan->flags == 2) /* Embedded follows */
5818         {
5819                 if (flags & SCF_DO_SUBSTR) {
5820                     scan_commit(pRExC_state, data, minlenp, is_inf);
5821                     data->cur_is_floating = 1; /* float */
5822                 }
5823                 is_inf = is_inf_internal = 1;
5824                 if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
5825                     ssc_anything(data->start_class);
5826                 flags &= ~SCF_DO_STCLASS;
5827         }
5828         else if (OP(scan) == GPOS) {
5829             if (!(RExC_rx->intflags & PREGf_GPOS_FLOAT) &&
5830                 !(delta || is_inf || (data && data->pos_delta)))
5831             {
5832                 if (!(RExC_rx->intflags & PREGf_ANCH) && (flags & SCF_DO_SUBSTR))
5833                     RExC_rx->intflags |= PREGf_ANCH_GPOS;
5834                 if (RExC_rx->gofs < (STRLEN)min)
5835                     RExC_rx->gofs = min;
5836             } else {
5837                 RExC_rx->intflags |= PREGf_GPOS_FLOAT;
5838                 RExC_rx->gofs = 0;
5839             }
5840         }
5841 #ifdef TRIE_STUDY_OPT
5842 #ifdef FULL_TRIE_STUDY
5843         else if (PL_regkind[OP(scan)] == TRIE) {
5844             /* NOTE - There is similar code to this block above for handling
5845                BRANCH nodes on the initial study.  If you change stuff here
5846                check there too. */
5847             regnode *trie_node= scan;
5848             regnode *tail= regnext(scan);
5849             reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
5850             SSize_t max1 = 0, min1 = SSize_t_MAX;
5851             regnode_ssc accum;
5852
5853             if (flags & SCF_DO_SUBSTR) { /* XXXX Add !SUSPEND? */
5854                 /* Cannot merge strings after this. */
5855                 scan_commit(pRExC_state, data, minlenp, is_inf);
5856             }
5857             if (flags & SCF_DO_STCLASS)
5858                 ssc_init_zero(pRExC_state, &accum);
5859
5860             if (!trie->jump) {
5861                 min1= trie->minlen;
5862                 max1= trie->maxlen;
5863             } else {
5864                 const regnode *nextbranch= NULL;
5865                 U32 word;
5866
5867                 for ( word=1 ; word <= trie->wordcount ; word++)
5868                 {
5869                     SSize_t deltanext=0, minnext=0, f = 0, fake;
5870                     regnode_ssc this_class;
5871
5872                     StructCopy(&zero_scan_data, &data_fake, scan_data_t);
5873                     if (data) {
5874                         data_fake.whilem_c = data->whilem_c;
5875                         data_fake.last_closep = data->last_closep;
5876                     }
5877                     else
5878                         data_fake.last_closep = &fake;
5879                     data_fake.pos_delta = delta;
5880                     if (flags & SCF_DO_STCLASS) {
5881                         ssc_init(pRExC_state, &this_class);
5882                         data_fake.start_class = &this_class;
5883                         f = SCF_DO_STCLASS_AND;
5884                     }
5885                     if (flags & SCF_WHILEM_VISITED_POS)
5886                         f |= SCF_WHILEM_VISITED_POS;
5887
5888                     if (trie->jump[word]) {
5889                         if (!nextbranch)
5890                             nextbranch = trie_node + trie->jump[0];
5891                         scan= trie_node + trie->jump[word];
5892                         /* We go from the jump point to the branch that follows
5893                            it. Note this means we need the vestigal unused
5894                            branches even though they arent otherwise used. */
5895                         minnext = study_chunk(pRExC_state, &scan, minlenp,
5896                             &deltanext, (regnode *)nextbranch, &data_fake,
5897                             stopparen, recursed_depth, NULL, f,depth+1);
5898                     }
5899                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
5900                         nextbranch= regnext((regnode*)nextbranch);
5901
5902                     if (min1 > (SSize_t)(minnext + trie->minlen))
5903                         min1 = minnext + trie->minlen;
5904                     if (deltanext == SSize_t_MAX) {
5905                         is_inf = is_inf_internal = 1;
5906                         max1 = SSize_t_MAX;
5907                     } else if (max1 < (SSize_t)(minnext + deltanext + trie->maxlen))
5908                         max1 = minnext + deltanext + trie->maxlen;
5909
5910                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
5911                         pars++;
5912                     if (data_fake.flags & SCF_SEEN_ACCEPT) {
5913                         if ( stopmin > min + min1)
5914                             stopmin = min + min1;
5915                         flags &= ~SCF_DO_SUBSTR;
5916                         if (data)
5917                             data->flags |= SCF_SEEN_ACCEPT;
5918                     }
5919                     if (data) {
5920                         if (data_fake.flags & SF_HAS_EVAL)
5921                             data->flags |= SF_HAS_EVAL;
5922                         data->whilem_c = data_fake.whilem_c;
5923                     }
5924                     if (flags & SCF_DO_STCLASS)
5925                         ssc_or(pRExC_state, &accum, (regnode_charclass *) &this_class);
5926                 }
5927             }
5928             if (flags & SCF_DO_SUBSTR) {
5929                 data->pos_min += min1;
5930                 data->pos_delta += max1 - min1;
5931                 if (max1 != min1 || is_inf)
5932                     data->cur_is_floating = 1; /* float */
5933             }
5934             min += min1;
5935             if (delta != SSize_t_MAX)
5936                 delta += max1 - min1;
5937             if (flags & SCF_DO_STCLASS_OR) {
5938                 ssc_or(pRExC_state, data->start_class, (regnode_charclass *) &accum);
5939                 if (min1) {
5940                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5941                     flags &= ~SCF_DO_STCLASS;
5942                 }
5943             }
5944             else if (flags & SCF_DO_STCLASS_AND) {
5945                 if (min1) {
5946                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &accum);
5947                     flags &= ~SCF_DO_STCLASS;
5948                 }
5949                 else {
5950                     /* Switch to OR mode: cache the old value of
5951                      * data->start_class */
5952                     INIT_AND_WITHP;
5953                     StructCopy(data->start_class, and_withp, regnode_ssc);
5954                     flags &= ~SCF_DO_STCLASS_AND;
5955                     StructCopy(&accum, data->start_class, regnode_ssc);
5956                     flags |= SCF_DO_STCLASS_OR;
5957                 }
5958             }
5959             scan= tail;
5960             continue;
5961         }
5962 #else
5963         else if (PL_regkind[OP(scan)] == TRIE) {
5964             reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
5965             U8*bang=NULL;
5966
5967             min += trie->minlen;
5968             delta += (trie->maxlen - trie->minlen);
5969             flags &= ~SCF_DO_STCLASS; /* xxx */
5970             if (flags & SCF_DO_SUBSTR) {
5971                 /* Cannot expect anything... */
5972                 scan_commit(pRExC_state, data, minlenp, is_inf);
5973                 data->pos_min += trie->minlen;
5974                 data->pos_delta += (trie->maxlen - trie->minlen);
5975                 if (trie->maxlen != trie->minlen)
5976                     data->cur_is_floating = 1; /* float */
5977             }
5978             if (trie->jump) /* no more substrings -- for now /grr*/
5979                flags &= ~SCF_DO_SUBSTR;
5980         }
5981 #endif /* old or new */
5982 #endif /* TRIE_STUDY_OPT */
5983
5984         /* Else: zero-length, ignore. */
5985         scan = regnext(scan);
5986     }
5987
5988   finish:
5989     if (frame) {
5990         /* we need to unwind recursion. */
5991         depth = depth - 1;
5992
5993         DEBUG_STUDYDATA("frame-end", data, depth, is_inf);
5994         DEBUG_PEEP("fend", scan, depth, flags);
5995
5996         /* restore previous context */
5997         last = frame->last_regnode;
5998         scan = frame->next_regnode;
5999         stopparen = frame->stopparen;
6000         recursed_depth = frame->prev_recursed_depth;
6001
6002         RExC_frame_last = frame->prev_frame;
6003         frame = frame->this_prev_frame;
6004         goto fake_study_recurse;
6005     }
6006
6007     assert(!frame);
6008     DEBUG_STUDYDATA("pre-fin", data, depth, is_inf);
6009
6010     *scanp = scan;
6011     *deltap = is_inf_internal ? SSize_t_MAX : delta;
6012
6013     if (flags & SCF_DO_SUBSTR && is_inf)
6014         data->pos_delta = SSize_t_MAX - data->pos_min;
6015     if (is_par > (I32)U8_MAX)
6016         is_par = 0;
6017     if (is_par && pars==1 && data) {
6018         data->flags |= SF_IN_PAR;
6019         data->flags &= ~SF_HAS_PAR;
6020     }
6021     else if (pars && data) {
6022         data->flags |= SF_HAS_PAR;
6023         data->flags &= ~SF_IN_PAR;
6024     }
6025     if (flags & SCF_DO_STCLASS_OR)
6026         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
6027     if (flags & SCF_TRIE_RESTUDY)
6028         data->flags |=  SCF_TRIE_RESTUDY;
6029
6030     DEBUG_STUDYDATA("post-fin", data, depth, is_inf);
6031
6032     {
6033         SSize_t final_minlen= min < stopmin ? min : stopmin;
6034
6035         if (!(RExC_seen & REG_UNBOUNDED_QUANTIFIER_SEEN)) {
6036             if (final_minlen > SSize_t_MAX - delta)
6037                 RExC_maxlen = SSize_t_MAX;
6038             else if (RExC_maxlen < final_minlen + delta)
6039                 RExC_maxlen = final_minlen + delta;
6040         }
6041         return final_minlen;
6042     }
6043     NOT_REACHED; /* NOTREACHED */
6044 }
6045
6046 STATIC U32
6047 S_add_data(RExC_state_t* const pRExC_state, const char* const s, const U32 n)
6048 {
6049     U32 count = RExC_rxi->data ? RExC_rxi->data->count : 0;
6050
6051     PERL_ARGS_ASSERT_ADD_DATA;
6052
6053     Renewc(RExC_rxi->data,
6054            sizeof(*RExC_rxi->data) + sizeof(void*) * (count + n - 1),
6055            char, struct reg_data);
6056     if(count)
6057         Renew(RExC_rxi->data->what, count + n, U8);
6058     else
6059         Newx(RExC_rxi->data->what, n, U8);
6060     RExC_rxi->data->count = count + n;
6061     Copy(s, RExC_rxi->data->what + count, n, U8);
6062     return count;
6063 }
6064
6065 /*XXX: todo make this not included in a non debugging perl, but appears to be
6066  * used anyway there, in 'use re' */
6067 #ifndef PERL_IN_XSUB_RE
6068 void
6069 Perl_reginitcolors(pTHX)
6070 {
6071     const char * const s = PerlEnv_getenv("PERL_RE_COLORS");
6072     if (s) {
6073         char *t = savepv(s);
6074         int i = 0;
6075         PL_colors[0] = t;
6076         while (++i < 6) {
6077             t = strchr(t, '\t');
6078             if (t) {
6079                 *t = '\0';
6080                 PL_colors[i] = ++t;
6081             }
6082             else
6083                 PL_colors[i] = t = (char *)"";
6084         }
6085     } else {
6086         int i = 0;
6087         while (i < 6)
6088             PL_colors[i++] = (char *)"";
6089     }
6090     PL_colorset = 1;
6091 }
6092 #endif
6093
6094
6095 #ifdef TRIE_STUDY_OPT
6096 #define CHECK_RESTUDY_GOTO_butfirst(dOsomething)            \
6097     STMT_START {                                            \
6098         if (                                                \
6099               (data.flags & SCF_TRIE_RESTUDY)               \
6100               && ! restudied++                              \
6101         ) {                                                 \
6102             dOsomething;                                    \
6103             goto reStudy;                                   \
6104         }                                                   \
6105     } STMT_END
6106 #else
6107 #define CHECK_RESTUDY_GOTO_butfirst
6108 #endif
6109
6110 /*
6111  * pregcomp - compile a regular expression into internal code
6112  *
6113  * Decides which engine's compiler to call based on the hint currently in
6114  * scope
6115  */
6116
6117 #ifndef PERL_IN_XSUB_RE
6118
6119 /* return the currently in-scope regex engine (or the default if none)  */
6120
6121 regexp_engine const *
6122 Perl_current_re_engine(pTHX)
6123 {
6124     if (IN_PERL_COMPILETIME) {
6125         HV * const table = GvHV(PL_hintgv);
6126         SV **ptr;
6127
6128         if (!table || !(PL_hints & HINT_LOCALIZE_HH))
6129             return &PL_core_reg_engine;
6130         ptr = hv_fetchs(table, "regcomp", FALSE);
6131         if ( !(ptr && SvIOK(*ptr) && SvIV(*ptr)))
6132             return &PL_core_reg_engine;
6133         return INT2PTR(regexp_engine*,SvIV(*ptr));
6134     }
6135     else {
6136         SV *ptr;
6137         if (!PL_curcop->cop_hints_hash)
6138             return &PL_core_reg_engine;
6139         ptr = cop_hints_fetch_pvs(PL_curcop, "regcomp", 0);
6140         if ( !(ptr && SvIOK(ptr) && SvIV(ptr)))
6141             return &PL_core_reg_engine;
6142         return INT2PTR(regexp_engine*,SvIV(ptr));
6143     }
6144 }
6145
6146
6147 REGEXP *
6148 Perl_pregcomp(pTHX_ SV * const pattern, const U32 flags)
6149 {
6150     regexp_engine const *eng = current_re_engine();
6151     GET_RE_DEBUG_FLAGS_DECL;
6152
6153     PERL_ARGS_ASSERT_PREGCOMP;
6154
6155     /* Dispatch a request to compile a regexp to correct regexp engine. */
6156     DEBUG_COMPILE_r({
6157         Perl_re_printf( aTHX_  "Using engine %" UVxf "\n",
6158                         PTR2UV(eng));
6159     });
6160     return CALLREGCOMP_ENG(eng, pattern, flags);
6161 }
6162 #endif
6163
6164 /* public(ish) entry point for the perl core's own regex compiling code.
6165  * It's actually a wrapper for Perl_re_op_compile that only takes an SV
6166  * pattern rather than a list of OPs, and uses the internal engine rather
6167  * than the current one */
6168
6169 REGEXP *
6170 Perl_re_compile(pTHX_ SV * const pattern, U32 rx_flags)
6171 {
6172     SV *pat = pattern; /* defeat constness! */
6173     PERL_ARGS_ASSERT_RE_COMPILE;
6174     return Perl_re_op_compile(aTHX_ &pat, 1, NULL,
6175 #ifdef PERL_IN_XSUB_RE
6176                                 &my_reg_engine,
6177 #else
6178                                 &PL_core_reg_engine,
6179 #endif
6180                                 NULL, NULL, rx_flags, 0);
6181 }
6182
6183
6184 static void
6185 S_free_codeblocks(pTHX_ struct reg_code_blocks *cbs)
6186 {
6187     int n;
6188
6189     if (--cbs->refcnt > 0)
6190         return;
6191     for (n = 0; n < cbs->count; n++) {
6192         REGEXP *rx = cbs->cb[n].src_regex;
6193         cbs->cb[n].src_regex = NULL;
6194         SvREFCNT_dec(rx);
6195     }
6196     Safefree(cbs->cb);
6197     Safefree(cbs);
6198 }
6199
6200
6201 static struct reg_code_blocks *
6202 S_alloc_code_blocks(pTHX_  int ncode)
6203 {
6204      struct reg_code_blocks *cbs;
6205     Newx(cbs, 1, struct reg_code_blocks);
6206     cbs->count = ncode;
6207     cbs->refcnt = 1;
6208     SAVEDESTRUCTOR_X(S_free_codeblocks, cbs);
6209     if (ncode)
6210         Newx(cbs->cb, ncode, struct reg_code_block);
6211     else
6212         cbs->cb = NULL;
6213     return cbs;
6214 }
6215
6216
6217 /* upgrade pattern pat_p of length plen_p to UTF8, and if there are code
6218  * blocks, recalculate the indices. Update pat_p and plen_p in-place to
6219  * point to the realloced string and length.
6220  *
6221  * This is essentially a copy of Perl_bytes_to_utf8() with the code index
6222  * stuff added */
6223
6224 static void
6225 S_pat_upgrade_to_utf8(pTHX_ RExC_state_t * const pRExC_state,
6226                     char **pat_p, STRLEN *plen_p, int num_code_blocks)
6227 {
6228     U8 *const src = (U8*)*pat_p;
6229     U8 *dst, *d;
6230     int n=0;
6231     STRLEN s = 0;
6232     bool do_end = 0;
6233     GET_RE_DEBUG_FLAGS_DECL;
6234
6235     DEBUG_PARSE_r(Perl_re_printf( aTHX_
6236         "UTF8 mismatch! Converting to utf8 for resizing and compile\n"));
6237
6238     Newx(dst, *plen_p * 2 + 1, U8);
6239     d = dst;
6240
6241     while (s < *plen_p) {
6242         append_utf8_from_native_byte(src[s], &d);
6243
6244         if (n < num_code_blocks) {
6245             assert(pRExC_state->code_blocks);
6246             if (!do_end && pRExC_state->code_blocks->cb[n].start == s) {
6247                 pRExC_state->code_blocks->cb[n].start = d - dst - 1;
6248                 assert(*(d - 1) == '(');
6249                 do_end = 1;
6250             }
6251             else if (do_end && pRExC_state->code_blocks->cb[n].end == s) {
6252                 pRExC_state->code_blocks->cb[n].end = d - dst - 1;
6253                 assert(*(d - 1) == ')');
6254                 do_end = 0;
6255                 n++;
6256             }
6257         }
6258         s++;
6259     }
6260     *d = '\0';
6261     *plen_p = d - dst;
6262     *pat_p = (char*) dst;
6263     SAVEFREEPV(*pat_p);
6264     RExC_orig_utf8 = RExC_utf8 = 1;
6265 }
6266
6267
6268
6269 /* S_concat_pat(): concatenate a list of args to the pattern string pat,
6270  * while recording any code block indices, and handling overloading,
6271  * nested qr// objects etc.  If pat is null, it will allocate a new
6272  * string, or just return the first arg, if there's only one.
6273  *
6274  * Returns the malloced/updated pat.
6275  * patternp and pat_count is the array of SVs to be concatted;
6276  * oplist is the optional list of ops that generated the SVs;
6277  * recompile_p is a pointer to a boolean that will be set if
6278  *   the regex will need to be recompiled.
6279  * delim, if non-null is an SV that will be inserted between each element
6280  */
6281
6282 static SV*
6283 S_concat_pat(pTHX_ RExC_state_t * const pRExC_state,
6284                 SV *pat, SV ** const patternp, int pat_count,
6285                 OP *oplist, bool *recompile_p, SV *delim)
6286 {
6287     SV **svp;
6288     int n = 0;
6289     bool use_delim = FALSE;
6290     bool alloced = FALSE;
6291
6292     /* if we know we have at least two args, create an empty string,
6293      * then concatenate args to that. For no args, return an empty string */
6294     if (!pat && pat_count != 1) {
6295         pat = newSVpvs("");
6296         SAVEFREESV(pat);
6297         alloced = TRUE;
6298     }
6299
6300     for (svp = patternp; svp < patternp + pat_count; svp++) {
6301         SV *sv;
6302         SV *rx  = NULL;
6303         STRLEN orig_patlen = 0;
6304         bool code = 0;
6305         SV *msv = use_delim ? delim : *svp;
6306         if (!msv) msv = &PL_sv_undef;
6307
6308         /* if we've got a delimiter, we go round the loop twice for each
6309          * svp slot (except the last), using the delimiter the second
6310          * time round */
6311         if (use_delim) {
6312             svp--;
6313             use_delim = FALSE;
6314         }
6315         else if (delim)
6316             use_delim = TRUE;
6317
6318         if (SvTYPE(msv) == SVt_PVAV) {
6319             /* we've encountered an interpolated array within
6320              * the pattern, e.g. /...@a..../. Expand the list of elements,
6321              * then recursively append elements.
6322              * The code in this block is based on S_pushav() */
6323
6324             AV *const av = (AV*)msv;
6325             const SSize_t maxarg = AvFILL(av) + 1;
6326             SV **array;
6327
6328             if (oplist) {
6329                 assert(oplist->op_type == OP_PADAV
6330                     || oplist->op_type == OP_RV2AV);
6331                 oplist = OpSIBLING(oplist);
6332             }
6333
6334             if (SvRMAGICAL(av)) {
6335                 SSize_t i;
6336
6337                 Newx(array, maxarg, SV*);
6338                 SAVEFREEPV(array);
6339                 for (i=0; i < maxarg; i++) {
6340                     SV ** const svp = av_fetch(av, i, FALSE);
6341                     array[i] = svp ? *svp : &PL_sv_undef;
6342                 }
6343             }
6344             else
6345                 array = AvARRAY(av);
6346
6347             pat = S_concat_pat(aTHX_ pRExC_state, pat,
6348                                 array, maxarg, NULL, recompile_p,
6349                                 /* $" */
6350                                 GvSV((gv_fetchpvs("\"", GV_ADDMULTI, SVt_PV))));
6351
6352             continue;
6353         }
6354
6355
6356         /* we make the assumption here that each op in the list of
6357          * op_siblings maps to one SV pushed onto the stack,
6358          * except for code blocks, with have both an OP_NULL and
6359          * and OP_CONST.
6360          * This allows us to match up the list of SVs against the
6361          * list of OPs to find the next code block.
6362          *
6363          * Note that       PUSHMARK PADSV PADSV ..
6364          * is optimised to
6365          *                 PADRANGE PADSV  PADSV  ..
6366          * so the alignment still works. */
6367
6368         if (oplist) {
6369             if (oplist->op_type == OP_NULL
6370                 && (oplist->op_flags & OPf_SPECIAL))
6371             {
6372                 assert(n < pRExC_state->code_blocks->count);
6373                 pRExC_state->code_blocks->cb[n].start = pat ? SvCUR(pat) : 0;
6374                 pRExC_state->code_blocks->cb[n].block = oplist;
6375                 pRExC_state->code_blocks->cb[n].src_regex = NULL;
6376                 n++;
6377                 code = 1;
6378                 oplist = OpSIBLING(oplist); /* skip CONST */
6379                 assert(oplist);
6380             }
6381             oplist = OpSIBLING(oplist);;
6382         }
6383
6384         /* apply magic and QR overloading to arg */
6385
6386         SvGETMAGIC(msv);
6387         if (SvROK(msv) && SvAMAGIC(msv)) {
6388             SV *sv = AMG_CALLunary(msv, regexp_amg);
6389             if (sv) {
6390                 if (SvROK(sv))
6391                     sv = SvRV(sv);
6392                 if (SvTYPE(sv) != SVt_REGEXP)
6393                     Perl_croak(aTHX_ "Overloaded qr did not return a REGEXP");
6394                 msv = sv;
6395             }
6396         }
6397
6398         /* try concatenation overload ... */
6399         if (pat && (SvAMAGIC(pat) || SvAMAGIC(msv)) &&
6400                 (sv = amagic_call(pat, msv, concat_amg, AMGf_assign)))
6401         {
6402             sv_setsv(pat, sv);
6403             /* overloading involved: all bets are off over literal
6404              * code. Pretend we haven't seen it */
6405             if (n)
6406                 pRExC_state->code_blocks->count -= n;
6407             n = 0;
6408         }
6409         else  {
6410             /* ... or failing that, try "" overload */
6411             while (SvAMAGIC(msv)
6412                     && (sv = AMG_CALLunary(msv, string_amg))
6413                     && sv != msv
6414                     &&  !(   SvROK(msv)
6415                           && SvROK(sv)
6416                           && SvRV(msv) == SvRV(sv))
6417             ) {
6418                 msv = sv;
6419                 SvGETMAGIC(msv);
6420             }
6421             if (SvROK(msv) && SvTYPE(SvRV(msv)) == SVt_REGEXP)
6422                 msv = SvRV(msv);
6423
6424             if (pat) {
6425                 /* this is a partially unrolled
6426                  *     sv_catsv_nomg(pat, msv);
6427                  * that allows us to adjust code block indices if
6428                  * needed */
6429                 STRLEN dlen;
6430                 char *dst = SvPV_force_nomg(pat, dlen);
6431                 orig_patlen = dlen;
6432                 if (SvUTF8(msv) && !SvUTF8(pat)) {
6433                     S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &dst, &dlen, n);
6434                     sv_setpvn(pat, dst, dlen);
6435                     SvUTF8_on(pat);
6436                 }
6437                 sv_catsv_nomg(pat, msv);
6438                 rx = msv;
6439             }
6440             else {
6441                 /* We have only one SV to process, but we need to verify
6442                  * it is properly null terminated or we will fail asserts
6443                  * later. In theory we probably shouldn't get such SV's,
6444                  * but if we do we should handle it gracefully. */
6445                 if ( SvTYPE(msv) != SVt_PV || (SvLEN(msv) > SvCUR(msv) && *(SvEND(msv)) == 0) ) {
6446                     /* not a string, or a string with a trailing null */
6447                     pat = msv;
6448                 } else {
6449                     /* a string with no trailing null, we need to copy it
6450                      * so it we have a trailing null */
6451                     pat = newSVsv(msv);
6452                 }
6453             }
6454
6455             if (code)
6456                 pRExC_state->code_blocks->cb[n-1].end = SvCUR(pat)-1;
6457         }
6458
6459         /* extract any code blocks within any embedded qr//'s */
6460         if (rx && SvTYPE(rx) == SVt_REGEXP
6461             && RX_ENGINE((REGEXP*)rx)->op_comp)
6462         {
6463
6464             RXi_GET_DECL(ReANY((REGEXP *)rx), ri);
6465             if (ri->code_blocks && ri->code_blocks->count) {
6466                 int i;
6467                 /* the presence of an embedded qr// with code means
6468                  * we should always recompile: the text of the
6469                  * qr// may not have changed, but it may be a
6470                  * different closure than last time */
6471                 *recompile_p = 1;
6472                 if (pRExC_state->code_blocks) {
6473                     int new_count = pRExC_state->code_blocks->count
6474                             + ri->code_blocks->count;
6475                     Renew(pRExC_state->code_blocks->cb,
6476                             new_count, struct reg_code_block);
6477                     pRExC_state->code_blocks->count = new_count;
6478                 }
6479                 else
6480                     pRExC_state->code_blocks = S_alloc_code_blocks(aTHX_
6481                                                     ri->code_blocks->count);
6482
6483                 for (i=0; i < ri->code_blocks->count; i++) {
6484                     struct reg_code_block *src, *dst;
6485                     STRLEN offset =  orig_patlen
6486                         + ReANY((REGEXP *)rx)->pre_prefix;
6487                     assert(n < pRExC_state->code_blocks->count);
6488                     src = &ri->code_blocks->cb[i];
6489                     dst = &pRExC_state->code_blocks->cb[n];
6490                     dst->start      = src->start + offset;
6491                     dst->end        = src->end   + offset;
6492                     dst->block      = src->block;
6493                     dst->src_regex  = (REGEXP*) SvREFCNT_inc( (SV*)
6494                                             src->src_regex
6495                                                 ? src->src_regex
6496                                                 : (REGEXP*)rx);
6497                     n++;
6498                 }
6499             }
6500         }
6501     }
6502     /* avoid calling magic multiple times on a single element e.g. =~ $qr */
6503     if (alloced)
6504         SvSETMAGIC(pat);
6505
6506     return pat;
6507 }
6508
6509
6510
6511 /* see if there are any run-time code blocks in the pattern.
6512  * False positives are allowed */
6513
6514 static bool
6515 S_has_runtime_code(pTHX_ RExC_state_t * const pRExC_state,
6516                     char *pat, STRLEN plen)
6517 {
6518     int n = 0;
6519     STRLEN s;
6520     
6521     PERL_UNUSED_CONTEXT;
6522
6523     for (s = 0; s < plen; s++) {
6524         if (   pRExC_state->code_blocks
6525             && n < pRExC_state->code_blocks->count
6526             && s == pRExC_state->code_blocks->cb[n].start)
6527         {
6528             s = pRExC_state->code_blocks->cb[n].end;
6529             n++;
6530             continue;
6531         }
6532         /* TODO ideally should handle [..], (#..), /#.../x to reduce false
6533          * positives here */
6534         if (pat[s] == '(' && s+2 <= plen && pat[s+1] == '?' &&
6535             (pat[s+2] == '{'
6536                 || (s + 2 <= plen && pat[s+2] == '?' && pat[s+3] == '{'))
6537         )
6538             return 1;
6539     }
6540     return 0;
6541 }
6542
6543 /* Handle run-time code blocks. We will already have compiled any direct
6544  * or indirect literal code blocks. Now, take the pattern 'pat' and make a
6545  * copy of it, but with any literal code blocks blanked out and
6546  * appropriate chars escaped; then feed it into
6547  *
6548  *    eval "qr'modified_pattern'"
6549  *
6550  * For example,
6551  *
6552  *       a\bc(?{"this was literal"})def'ghi\\jkl(?{"this is runtime"})mno
6553  *
6554  * becomes
6555  *
6556  *    qr'a\\bc_______________________def\'ghi\\\\jkl(?{"this is runtime"})mno'
6557  *
6558  * After eval_sv()-ing that, grab any new code blocks from the returned qr
6559  * and merge them with any code blocks of the original regexp.
6560  *
6561  * If the pat is non-UTF8, while the evalled qr is UTF8, don't merge;
6562  * instead, just save the qr and return FALSE; this tells our caller that
6563  * the original pattern needs upgrading to utf8.
6564  */
6565
6566 static bool
6567 S_compile_runtime_code(pTHX_ RExC_state_t * const pRExC_state,
6568     char *pat, STRLEN plen)
6569 {
6570     SV *qr;
6571
6572     GET_RE_DEBUG_FLAGS_DECL;
6573
6574     if (pRExC_state->runtime_code_qr) {
6575         /* this is the second time we've been called; this should
6576          * only happen if the main pattern got upgraded to utf8
6577          * during compilation; re-use the qr we compiled first time
6578          * round (which should be utf8 too)
6579          */
6580         qr = pRExC_state->runtime_code_qr;
6581         pRExC_state->runtime_code_qr = NULL;
6582         assert(RExC_utf8 && SvUTF8(qr));
6583     }
6584     else {
6585         int n = 0;
6586         STRLEN s;
6587         char *p, *newpat;
6588         int newlen = plen + 7; /* allow for "qr''xx\0" extra chars */
6589         SV *sv, *qr_ref;
6590         dSP;
6591
6592         /* determine how many extra chars we need for ' and \ escaping */
6593         for (s = 0; s < plen; s++) {
6594             if (pat[s] == '\'' || pat[s] == '\\')
6595                 newlen++;
6596         }
6597
6598         Newx(newpat, newlen, char);
6599         p = newpat;
6600         *p++ = 'q'; *p++ = 'r'; *p++ = '\'';
6601
6602         for (s = 0; s < plen; s++) {
6603             if (   pRExC_state->code_blocks
6604                 && n < pRExC_state->code_blocks->count
6605                 && s == pRExC_state->code_blocks->cb[n].start)
6606             {
6607                 /* blank out literal code block */
6608                 assert(pat[s] == '(');
6609                 while (s <= pRExC_state->code_blocks->cb[n].end) {
6610                     *p++ = '_';
6611                     s++;
6612                 }
6613                 s--;
6614                 n++;
6615                 continue;
6616             }
6617             if (pat[s] == '\'' || pat[s] == '\\')
6618                 *p++ = '\\';
6619             *p++ = pat[s];
6620         }
6621         *p++ = '\'';
6622         if (pRExC_state->pm_flags & RXf_PMf_EXTENDED) {
6623             *p++ = 'x';
6624             if (pRExC_state->pm_flags & RXf_PMf_EXTENDED_MORE) {
6625                 *p++ = 'x';
6626             }
6627         }
6628         *p++ = '\0';
6629         DEBUG_COMPILE_r({
6630             Perl_re_printf( aTHX_
6631                 "%sre-parsing pattern for runtime code:%s %s\n",
6632                 PL_colors[4],PL_colors[5],newpat);
6633         });
6634
6635         sv = newSVpvn_flags(newpat, p-newpat-1, RExC_utf8 ? SVf_UTF8 : 0);
6636         Safefree(newpat);
6637
6638         ENTER;
6639         SAVETMPS;
6640         save_re_context();
6641         PUSHSTACKi(PERLSI_REQUIRE);
6642         /* G_RE_REPARSING causes the toker to collapse \\ into \ when
6643          * parsing qr''; normally only q'' does this. It also alters
6644          * hints handling */
6645         eval_sv(sv, G_SCALAR|G_RE_REPARSING);
6646         SvREFCNT_dec_NN(sv);
6647         SPAGAIN;
6648         qr_ref = POPs;
6649         PUTBACK;
6650         {
6651             SV * const errsv = ERRSV;
6652             if (SvTRUE_NN(errsv))
6653                 /* use croak_sv ? */
6654                 Perl_croak_nocontext("%" SVf, SVfARG(errsv));
6655         }
6656         assert(SvROK(qr_ref));
6657         qr = SvRV(qr_ref);
6658         assert(SvTYPE(qr) == SVt_REGEXP && RX_ENGINE((REGEXP*)qr)->op_comp);
6659         /* the leaving below frees the tmp qr_ref.
6660          * Give qr a life of its own */
6661         SvREFCNT_inc(qr);
6662         POPSTACK;
6663         FREETMPS;
6664         LEAVE;
6665
6666     }
6667
6668     if (!RExC_utf8 && SvUTF8(qr)) {
6669         /* first time through; the pattern got upgraded; save the
6670          * qr for the next time through */
6671         assert(!pRExC_state->runtime_code_qr);
6672         pRExC_state->runtime_code_qr = qr;
6673         return 0;
6674     }
6675
6676
6677     /* extract any code blocks within the returned qr//  */
6678
6679
6680     /* merge the main (r1) and run-time (r2) code blocks into one */
6681     {
6682         RXi_GET_DECL(ReANY((REGEXP *)qr), r2);
6683         struct reg_code_block *new_block, *dst;
6684         RExC_state_t * const r1 = pRExC_state; /* convenient alias */
6685         int i1 = 0, i2 = 0;
6686         int r1c, r2c;
6687
6688         if (!r2->code_blocks || !r2->code_blocks->count) /* we guessed wrong */
6689         {
6690             SvREFCNT_dec_NN(qr);
6691             return 1;
6692         }
6693
6694         if (!r1->code_blocks)
6695             r1->code_blocks = S_alloc_code_blocks(aTHX_ 0);
6696
6697         r1c = r1->code_blocks->count;
6698         r2c = r2->code_blocks->count;
6699
6700         Newx(new_block, r1c + r2c, struct reg_code_block);
6701
6702         dst = new_block;
6703
6704         while (i1 < r1c || i2 < r2c) {
6705             struct reg_code_block *src;
6706             bool is_qr = 0;
6707
6708             if (i1 == r1c) {
6709                 src = &r2->code_blocks->cb[i2++];
6710                 is_qr = 1;
6711             }
6712             else if (i2 == r2c)
6713                 src = &r1->code_blocks->cb[i1++];
6714             else if (  r1->code_blocks->cb[i1].start
6715                      < r2->code_blocks->cb[i2].start)
6716             {
6717                 src = &r1->code_blocks->cb[i1++];
6718                 assert(src->end < r2->code_blocks->cb[i2].start);
6719             }
6720             else {
6721                 assert(  r1->code_blocks->cb[i1].start
6722                        > r2->code_blocks->cb[i2].start);
6723                 src = &r2->code_blocks->cb[i2++];
6724                 is_qr = 1;
6725                 assert(src->end < r1->code_blocks->cb[i1].start);
6726             }
6727
6728             assert(pat[src->start] == '(');
6729             assert(pat[src->end]   == ')');
6730             dst->start      = src->start;
6731             dst->end        = src->end;
6732             dst->block      = src->block;
6733             dst->src_regex  = is_qr ? (REGEXP*) SvREFCNT_inc( (SV*) qr)
6734                                     : src->src_regex;
6735             dst++;
6736         }
6737         r1->code_blocks->count += r2c;
6738         Safefree(r1->code_blocks->cb);
6739         r1->code_blocks->cb = new_block;
6740     }
6741
6742     SvREFCNT_dec_NN(qr);
6743     return 1;
6744 }
6745
6746
6747 STATIC bool
6748 S_setup_longest(pTHX_ RExC_state_t *pRExC_state,
6749                       struct reg_substr_datum  *rsd,
6750                       struct scan_data_substrs *sub,
6751                       STRLEN longest_length)
6752 {
6753     /* This is the common code for setting up the floating and fixed length
6754      * string data extracted from Perl_re_op_compile() below.  Returns a boolean
6755      * as to whether succeeded or not */
6756
6757     I32 t;
6758     SSize_t ml;
6759     bool eol  = cBOOL(sub->flags & SF_BEFORE_EOL);
6760     bool meol = cBOOL(sub->flags & SF_BEFORE_MEOL);
6761
6762     if (! (longest_length
6763            || (eol /* Can't have SEOL and MULTI */
6764                && (! meol || (RExC_flags & RXf_PMf_MULTILINE)))
6765           )
6766             /* See comments for join_exact for why REG_UNFOLDED_MULTI_SEEN */
6767         || (RExC_seen & REG_UNFOLDED_MULTI_SEEN))
6768     {
6769         return FALSE;
6770     }
6771
6772     /* copy the information about the longest from the reg_scan_data
6773         over to the program. */
6774     if (SvUTF8(sub->str)) {
6775         rsd->substr      = NULL;
6776         rsd->utf8_substr = sub->str;
6777     } else {
6778         rsd->substr      = sub->str;
6779         rsd->utf8_substr = NULL;
6780     }
6781     /* end_shift is how many chars that must be matched that
6782         follow this item. We calculate it ahead of time as once the
6783         lookbehind offset is added in we lose the ability to correctly
6784         calculate it.*/
6785     ml = sub->minlenp ? *(sub->minlenp) : (SSize_t)longest_length;
6786     rsd->end_shift = ml - sub->min_offset
6787         - longest_length
6788             /* XXX SvTAIL is always false here - did you mean FBMcf_TAIL
6789              * intead? - DAPM
6790             + (SvTAIL(sub->str) != 0)
6791             */
6792         + sub->lookbehind;
6793
6794     t = (eol/* Can't have SEOL and MULTI */
6795          && (! meol || (RExC_flags & RXf_PMf_MULTILINE)));
6796     fbm_compile(sub->str, t ? FBMcf_TAIL : 0);
6797
6798     return TRUE;
6799 }
6800
6801 /*
6802  * Perl_re_op_compile - the perl internal RE engine's function to compile a
6803  * regular expression into internal code.
6804  * The pattern may be passed either as:
6805  *    a list of SVs (patternp plus pat_count)
6806  *    a list of OPs (expr)
6807  * If both are passed, the SV list is used, but the OP list indicates
6808  * which SVs are actually pre-compiled code blocks
6809  *
6810  * The SVs in the list have magic and qr overloading applied to them (and
6811  * the list may be modified in-place with replacement SVs in the latter
6812  * case).
6813  *
6814  * If the pattern hasn't changed from old_re, then old_re will be
6815  * returned.
6816  *
6817  * eng is the current engine. If that engine has an op_comp method, then
6818  * handle directly (i.e. we assume that op_comp was us); otherwise, just
6819  * do the initial concatenation of arguments and pass on to the external
6820  * engine.
6821  *
6822  * If is_bare_re is not null, set it to a boolean indicating whether the
6823  * arg list reduced (after overloading) to a single bare regex which has
6824  * been returned (i.e. /$qr/).
6825  *
6826  * orig_rx_flags contains RXf_* flags. See perlreapi.pod for more details.
6827  *
6828  * pm_flags contains the PMf_* flags, typically based on those from the
6829  * pm_flags field of the related PMOP. Currently we're only interested in
6830  * PMf_HAS_CV, PMf_IS_QR, PMf_USE_RE_EVAL.
6831  *
6832  * We can't allocate space until we know how big the compiled form will be,
6833  * but we can't compile it (and thus know how big it is) until we've got a
6834  * place to put the code.  So we cheat:  we compile it twice, once with code
6835  * generation turned off and size counting turned on, and once "for real".
6836  * This also means that we don't allocate space until we are sure that the
6837  * thing really will compile successfully, and we never have to move the
6838  * code and thus invalidate pointers into it.  (Note that it has to be in
6839  * one piece because free() must be able to free it all.) [NB: not true in perl]
6840  *
6841  * Beware that the optimization-preparation code in here knows about some
6842  * of the structure of the compiled regexp.  [I'll say.]
6843  */
6844
6845 REGEXP *
6846 Perl_re_op_compile(pTHX_ SV ** const patternp, int pat_count,
6847                     OP *expr, const regexp_engine* eng, REGEXP *old_re,
6848                      bool *is_bare_re, U32 orig_rx_flags, U32 pm_flags)
6849 {
6850     REGEXP *rx;
6851     struct regexp *r;
6852     regexp_internal *ri;
6853     STRLEN plen;
6854     char *exp;
6855     regnode *scan;
6856     I32 flags;
6857     SSize_t minlen = 0;
6858     U32 rx_flags;
6859     SV *pat;
6860     SV** new_patternp = patternp;
6861
6862     /* these are all flags - maybe they should be turned
6863      * into a single int with different bit masks */
6864     I32 sawlookahead = 0;
6865     I32 sawplus = 0;
6866     I32 sawopen = 0;
6867     I32 sawminmod = 0;
6868
6869     regex_charset initial_charset = get_regex_charset(orig_rx_flags);
6870     bool recompile = 0;
6871     bool runtime_code = 0;
6872     scan_data_t data;
6873     RExC_state_t RExC_state;
6874     RExC_state_t * const pRExC_state = &RExC_state;
6875 #ifdef TRIE_STUDY_OPT
6876     int restudied = 0;
6877     RExC_state_t copyRExC_state;
6878 #endif
6879     GET_RE_DEBUG_FLAGS_DECL;
6880
6881     PERL_ARGS_ASSERT_RE_OP_COMPILE;
6882
6883     DEBUG_r(if (!PL_colorset) reginitcolors());
6884
6885     /* Initialize these here instead of as-needed, as is quick and avoids
6886      * having to test them each time otherwise */
6887     if (! PL_AboveLatin1) {
6888 #ifdef DEBUGGING
6889         char * dump_len_string;
6890 #endif
6891
6892         PL_AboveLatin1 = _new_invlist_C_array(AboveLatin1_invlist);
6893         PL_Latin1 = _new_invlist_C_array(Latin1_invlist);
6894         PL_UpperLatin1 = _new_invlist_C_array(UpperLatin1_invlist);
6895         PL_utf8_foldable = _new_invlist_C_array(_Perl_Any_Folds_invlist);
6896         PL_HasMultiCharFold =
6897                        _new_invlist_C_array(_Perl_Folds_To_Multi_Char_invlist);
6898
6899         /* This is calculated here, because the Perl program that generates the
6900          * static global ones doesn't currently have access to
6901          * NUM_ANYOF_CODE_POINTS */
6902         PL_InBitmap = _new_invlist(2);
6903         PL_InBitmap = _add_range_to_invlist(PL_InBitmap, 0,
6904                                                     NUM_ANYOF_CODE_POINTS - 1);
6905 #ifdef DEBUGGING
6906         dump_len_string = PerlEnv_getenv("PERL_DUMP_RE_MAX_LEN");
6907         if (   ! dump_len_string
6908             || ! grok_atoUV(dump_len_string, (UV *)&PL_dump_re_max_len, NULL))
6909         {
6910             PL_dump_re_max_len = 60;    /* A reasonable default */
6911         }
6912 #endif
6913     }
6914
6915     pRExC_state->warn_text = NULL;
6916     pRExC_state->code_blocks = NULL;
6917
6918     if (is_bare_re)
6919         *is_bare_re = FALSE;
6920
6921     if (expr && (expr->op_type == OP_LIST ||
6922                 (expr->op_type == OP_NULL && expr->op_targ == OP_LIST))) {
6923         /* allocate code_blocks if needed */
6924         OP *o;
6925         int ncode = 0;
6926
6927         for (o = cLISTOPx(expr)->op_first; o; o = OpSIBLING(o))
6928             if (o->op_type == OP_NULL && (o->op_flags & OPf_SPECIAL))
6929                 ncode++; /* count of DO blocks */
6930
6931         if (ncode)
6932             pRExC_state->code_blocks = S_alloc_code_blocks(aTHX_ ncode);
6933     }
6934
6935     if (!pat_count) {
6936         /* compile-time pattern with just OP_CONSTs and DO blocks */
6937
6938         int n;
6939         OP *o;
6940
6941         /* find how many CONSTs there are */
6942         assert(expr);
6943         n = 0;
6944         if (expr->op_type == OP_CONST)
6945             n = 1;
6946         else
6947             for (o = cLISTOPx(expr)->op_first; o; o = OpSIBLING(o)) {
6948                 if (o->op_type == OP_CONST)
6949                     n++;
6950             }
6951
6952         /* fake up an SV array */
6953
6954         assert(!new_patternp);
6955         Newx(new_patternp, n, SV*);
6956         SAVEFREEPV(new_patternp);
6957         pat_count = n;
6958
6959         n = 0;
6960         if (expr->op_type == OP_CONST)
6961             new_patternp[n] = cSVOPx_sv(expr);
6962         else
6963             for (o = cLISTOPx(expr)->op_first; o; o = OpSIBLING(o)) {
6964                 if (o->op_type == OP_CONST)
6965                     new_patternp[n++] = cSVOPo_sv;
6966             }
6967
6968     }
6969
6970     DEBUG_PARSE_r(Perl_re_printf( aTHX_
6971         "Assembling pattern from %d elements%s\n", pat_count,
6972             orig_rx_flags & RXf_SPLIT ? " for split" : ""));
6973
6974     /* set expr to the first arg op */
6975
6976     if (pRExC_state->code_blocks && pRExC_state->code_blocks->count
6977          && expr->op_type != OP_CONST)
6978     {
6979             expr = cLISTOPx(expr)->op_first;
6980             assert(   expr->op_type == OP_PUSHMARK
6981                    || (expr->op_type == OP_NULL && expr->op_targ == OP_PUSHMARK)
6982                    || expr->op_type == OP_PADRANGE);
6983             expr = OpSIBLING(expr);
6984     }
6985
6986     pat = S_concat_pat(aTHX_ pRExC_state, NULL, new_patternp, pat_count,
6987                         expr, &recompile, NULL);
6988
6989     /* handle bare (possibly after overloading) regex: foo =~ $re */
6990     {
6991         SV *re = pat;
6992         if (SvROK(re))
6993             re = SvRV(re);
6994         if (SvTYPE(re) == SVt_REGEXP) {
6995             if (is_bare_re)
6996                 *is_bare_re = TRUE;
6997             SvREFCNT_inc(re);
6998             DEBUG_PARSE_r(Perl_re_printf( aTHX_
6999                 "Precompiled pattern%s\n",
7000                     orig_rx_flags & RXf_SPLIT ? " for split" : ""));
7001
7002             return (REGEXP*)re;
7003         }
7004     }
7005
7006     exp = SvPV_nomg(pat, plen);
7007
7008     if (!eng->op_comp) {
7009         if ((SvUTF8(pat) && IN_BYTES)
7010                 || SvGMAGICAL(pat) || SvAMAGIC(pat))
7011         {
7012             /* make a temporary copy; either to convert to bytes,
7013              * or to avoid repeating get-magic / overloaded stringify */
7014             pat = newSVpvn_flags(exp, plen, SVs_TEMP |
7015                                         (IN_BYTES ? 0 : SvUTF8(pat)));
7016         }
7017         return CALLREGCOMP_ENG(eng, pat, orig_rx_flags);
7018     }
7019
7020     /* ignore the utf8ness if the pattern is 0 length */
7021     RExC_utf8 = RExC_orig_utf8 = (plen == 0 || IN_BYTES) ? 0 : SvUTF8(pat);
7022
7023     RExC_uni_semantics = 0;
7024     RExC_seen_unfolded_sharp_s = 0;
7025     RExC_contains_locale = 0;
7026     RExC_strict = cBOOL(pm_flags & RXf_PMf_STRICT);
7027     RExC_study_started = 0;
7028     pRExC_state->runtime_code_qr = NULL;
7029     RExC_frame_head= NULL;
7030     RExC_frame_last= NULL;
7031     RExC_frame_count= 0;
7032
7033     DEBUG_r({
7034         RExC_mysv1= sv_newmortal();
7035         RExC_mysv2= sv_newmortal();
7036     });
7037     DEBUG_COMPILE_r({
7038             SV *dsv= sv_newmortal();
7039             RE_PV_QUOTED_DECL(s, RExC_utf8, dsv, exp, plen, PL_dump_re_max_len);
7040             Perl_re_printf( aTHX_  "%sCompiling REx%s %s\n",
7041                           PL_colors[4],PL_colors[5],s);
7042         });
7043
7044   redo_first_pass:
7045     /* we jump here if we have to recompile, e.g., from upgrading the pattern
7046      * to utf8 */
7047
7048     if ((pm_flags & PMf_USE_RE_EVAL)
7049                 /* this second condition covers the non-regex literal case,
7050                  * i.e.  $foo =~ '(?{})'. */
7051                 || (IN_PERL_COMPILETIME && (PL_hints & HINT_RE_EVAL))
7052     )
7053         runtime_code = S_has_runtime_code(aTHX_ pRExC_state, exp, plen);
7054
7055     /* return old regex if pattern hasn't changed */
7056     /* XXX: note in the below we have to check the flags as well as the
7057      * pattern.
7058      *
7059      * Things get a touch tricky as we have to compare the utf8 flag
7060      * independently from the compile flags.  */
7061
7062     if (   old_re
7063         && !recompile
7064         && !!RX_UTF8(old_re) == !!RExC_utf8
7065         && ( RX_COMPFLAGS(old_re) == ( orig_rx_flags & RXf_PMf_FLAGCOPYMASK ) )
7066         && RX_PRECOMP(old_re)
7067         && RX_PRELEN(old_re) == plen
7068         && memEQ(RX_PRECOMP(old_re), exp, plen)
7069         && !runtime_code /* with runtime code, always recompile */ )
7070     {
7071         return old_re;
7072     }
7073
7074     rx_flags = orig_rx_flags;
7075
7076     if (   initial_charset == REGEX_DEPENDS_CHARSET
7077         && (RExC_utf8 ||RExC_uni_semantics))
7078     {
7079
7080         /* Set to use unicode semantics if the pattern is in utf8 and has the
7081          * 'depends' charset specified, as it means unicode when utf8  */
7082         set_regex_charset(&rx_flags, REGEX_UNICODE_CHARSET);
7083     }
7084
7085     RExC_precomp = exp;
7086     RExC_precomp_adj = 0;
7087     RExC_flags = rx_flags;
7088     RExC_pm_flags = pm_flags;
7089
7090     if (runtime_code) {
7091         assert(TAINTING_get || !TAINT_get);
7092         if (TAINT_get)
7093             Perl_croak(aTHX_ "Eval-group in insecure regular expression");
7094
7095         if (!S_compile_runtime_code(aTHX_ pRExC_state, exp, plen)) {
7096             /* whoops, we have a non-utf8 pattern, whilst run-time code
7097              * got compiled as utf8. Try again with a utf8 pattern */
7098             S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &exp, &plen,
7099                 pRExC_state->code_blocks ? pRExC_state->code_blocks->count : 0);
7100             goto redo_first_pass;
7101         }
7102     }
7103     assert(!pRExC_state->runtime_code_qr);
7104
7105     RExC_sawback = 0;
7106
7107     RExC_seen = 0;
7108     RExC_maxlen = 0;
7109     RExC_in_lookbehind = 0;
7110     RExC_seen_zerolen = *exp == '^' ? -1 : 0;
7111     RExC_extralen = 0;
7112 #ifdef EBCDIC
7113     RExC_recode_x_to_native = 0;
7114 #endif
7115     RExC_in_multi_char_class = 0;
7116
7117     /* First pass: determine size, legality. */
7118     RExC_parse = exp;
7119     RExC_start = RExC_adjusted_start = exp;
7120     RExC_end = exp + plen;
7121     RExC_precomp_end = RExC_end;
7122     RExC_naughty = 0;
7123     RExC_npar = 1;
7124     RExC_nestroot = 0;
7125     RExC_size = 0L;
7126     RExC_emit = (regnode *) &RExC_emit_dummy;
7127     RExC_whilem_seen = 0;
7128     RExC_open_parens = NULL;
7129     RExC_close_parens = NULL;
7130     RExC_end_op = NULL;
7131     RExC_paren_names = NULL;
7132 #ifdef DEBUGGING
7133     RExC_paren_name_list = NULL;
7134 #endif
7135     RExC_recurse = NULL;
7136     RExC_study_chunk_recursed = NULL;
7137     RExC_study_chunk_recursed_bytes= 0;
7138     RExC_recurse_count = 0;
7139     pRExC_state->code_index = 0;
7140
7141     /* This NUL is guaranteed because the pattern comes from an SV*, and the sv
7142      * code makes sure the final byte is an uncounted NUL.  But should this
7143      * ever not be the case, lots of things could read beyond the end of the
7144      * buffer: loops like
7145      *      while(isFOO(*RExC_parse)) RExC_parse++;
7146      *      strchr(RExC_parse, "foo");
7147      * etc.  So it is worth noting. */
7148     assert(*RExC_end == '\0');
7149
7150     DEBUG_PARSE_r(
7151         Perl_re_printf( aTHX_  "Starting first pass (sizing)\n");
7152         RExC_lastnum=0;
7153         RExC_lastparse=NULL;
7154     );
7155
7156     if (reg(pRExC_state, 0, &flags,1) == NULL) {
7157         /* It's possible to write a regexp in ascii that represents Unicode
7158         codepoints outside of the byte range, such as via \x{100}. If we
7159         detect such a sequence we have to convert the entire pattern to utf8
7160         and then recompile, as our sizing calculation will have been based
7161         on 1 byte == 1 character, but we will need to use utf8 to encode
7162         at least some part of the pattern, and therefore must convert the whole
7163         thing.
7164         -- dmq */
7165         if (flags & RESTART_PASS1) {
7166             if (flags & NEED_UTF8) {
7167                 S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &exp, &plen,
7168                 pRExC_state->code_blocks ? pRExC_state->code_blocks->count : 0);
7169             }
7170             else {
7171                 DEBUG_PARSE_r(Perl_re_printf( aTHX_
7172                 "Need to redo pass 1\n"));
7173             }
7174
7175             goto redo_first_pass;
7176         }
7177         Perl_croak(aTHX_ "panic: reg returned NULL to re_op_compile for sizing pass, flags=%#" UVxf, (UV) flags);
7178     }
7179
7180     DEBUG_PARSE_r({
7181         Perl_re_printf( aTHX_
7182             "Required size %" IVdf " nodes\n"
7183             "Starting second pass (creation)\n",
7184             (IV)RExC_size);
7185         RExC_lastnum=0;
7186         RExC_lastparse=NULL;
7187     });
7188
7189     /* The first pass could have found things that force Unicode semantics */
7190     if ((RExC_utf8 || RExC_uni_semantics)
7191          && get_regex_charset(rx_flags) == REGEX_DEPENDS_CHARSET)
7192     {
7193         set_regex_charset(&rx_flags, REGEX_UNICODE_CHARSET);
7194     }
7195
7196     /* Small enough for pointer-storage convention?
7197        If extralen==0, this means that we will not need long jumps. */
7198     if (RExC_size >= 0x10000L && RExC_extralen)
7199         RExC_size += RExC_extralen;
7200     else
7201         RExC_extralen = 0;
7202     if (RExC_whilem_seen > 15)
7203         RExC_whilem_seen = 15;
7204
7205     /* Allocate space and zero-initialize. Note, the two step process
7206        of zeroing when in debug mode, thus anything assigned has to
7207        happen after that */
7208     rx = (REGEXP*) newSV_type(SVt_REGEXP);
7209     r = ReANY(rx);
7210     Newxc(ri, sizeof(regexp_internal) + (unsigned)RExC_size * sizeof(regnode),
7211          char, regexp_internal);
7212     if ( r == NULL || ri == NULL )
7213         FAIL("Regexp out of space");
7214 #ifdef DEBUGGING
7215     /* avoid reading uninitialized memory in DEBUGGING code in study_chunk() */
7216     Zero(ri, sizeof(regexp_internal) + (unsigned)RExC_size * sizeof(regnode),
7217          char);
7218 #else
7219     /* bulk initialize base fields with 0. */
7220     Zero(ri, sizeof(regexp_internal), char);
7221 #endif
7222
7223     /* non-zero initialization begins here */
7224     RXi_SET( r, ri );
7225     r->engine= eng;
7226     r->extflags = rx_flags;
7227     RXp_COMPFLAGS(r) = orig_rx_flags & RXf_PMf_FLAGCOPYMASK;
7228
7229     if (pm_flags & PMf_IS_QR) {
7230         ri->code_blocks = pRExC_state->code_blocks;
7231         if (ri->code_blocks)
7232             ri->code_blocks->refcnt++;
7233     }
7234
7235     {
7236         bool has_p     = ((r->extflags & RXf_PMf_KEEPCOPY) == RXf_PMf_KEEPCOPY);
7237         bool has_charset = (get_regex_charset(r->extflags)
7238                                                     != REGEX_DEPENDS_CHARSET);
7239
7240         /* The caret is output if there are any defaults: if not all the STD
7241          * flags are set, or if no character set specifier is needed */
7242         bool has_default =
7243                     (((r->extflags & RXf_PMf_STD_PMMOD) != RXf_PMf_STD_PMMOD)
7244                     || ! has_charset);
7245         bool has_runon = ((RExC_seen & REG_RUN_ON_COMMENT_SEEN)
7246                                                    == REG_RUN_ON_COMMENT_SEEN);
7247         U8 reganch = (U8)((r->extflags & RXf_PMf_STD_PMMOD)
7248                             >> RXf_PMf_STD_PMMOD_SHIFT);
7249         const char *fptr = STD_PAT_MODS;        /*"msixxn"*/
7250         char *p;
7251
7252         /* We output all the necessary flags; we never output a minus, as all
7253          * those are defaults, so are
7254          * covered by the caret */
7255         const STRLEN wraplen = plen + has_p + has_runon
7256             + has_default       /* If needs a caret */
7257             + PL_bitcount[reganch] /* 1 char for each set standard flag */
7258
7259                 /* If needs a character set specifier */
7260             + ((has_charset) ? MAX_CHARSET_NAME_LENGTH : 0)
7261             + (sizeof("(?:)") - 1);
7262
7263         /* make sure PL_bitcount bounds not exceeded */
7264         assert(sizeof(STD_PAT_MODS) <= 8);
7265
7266         p = sv_grow(MUTABLE_SV(rx), wraplen + 1); /* +1 for the ending NUL */
7267         SvPOK_on(rx);
7268         if (RExC_utf8)
7269             SvFLAGS(rx) |= SVf_UTF8;
7270         *p++='('; *p++='?';
7271
7272         /* If a default, cover it using the caret */
7273         if (has_default) {
7274             *p++= DEFAULT_PAT_MOD;
7275         }
7276         if (has_charset) {
7277             STRLEN len;
7278             const char* const name = get_regex_charset_name(r->extflags, &len);
7279             Copy(name, p, len, char);
7280             p += len;
7281         }
7282         if (has_p)
7283             *p++ = KEEPCOPY_PAT_MOD; /*'p'*/
7284         {
7285             char ch;
7286             while((ch = *fptr++)) {
7287                 if(reganch & 1)
7288                     *p++ = ch;
7289                 reganch >>= 1;
7290             }
7291         }
7292
7293         *p++ = ':';
7294         Copy(RExC_precomp, p, plen, char);
7295         assert ((RX_WRAPPED(rx) - p) < 16);
7296         r->pre_prefix = p - RX_WRAPPED(rx);
7297         p += plen;
7298         if (has_runon)
7299             *p++ = '\n';
7300         *p++ = ')';
7301         *p = 0;
7302         SvCUR_set(rx, p - RX_WRAPPED(rx));
7303     }
7304
7305     r->intflags = 0;
7306     r->nparens = RExC_npar - 1; /* set early to validate backrefs */
7307
7308     /* Useful during FAIL. */
7309 #ifdef RE_TRACK_PATTERN_OFFSETS
7310     Newxz(ri->u.offsets, 2*RExC_size+1, U32); /* MJD 20001228 */
7311     DEBUG_OFFSETS_r(Perl_re_printf( aTHX_
7312                           "%s %" UVuf " bytes for offset annotations.\n",
7313                           ri->u.offsets ? "Got" : "Couldn't get",
7314                           (UV)((2*RExC_size+1) * sizeof(U32))));
7315 #endif
7316     SetProgLen(ri,RExC_size);
7317     RExC_rx_sv = rx;
7318     RExC_rx = r;
7319     RExC_rxi = ri;
7320
7321     /* Second pass: emit code. */
7322     RExC_flags = rx_flags;      /* don't let top level (?i) bleed */
7323     RExC_pm_flags = pm_flags;
7324     RExC_parse = exp;
7325     RExC_end = exp + plen;
7326     RExC_naughty = 0;
7327     RExC_emit_start = ri->program;
7328     RExC_emit = ri->program;
7329     RExC_emit_bound = ri->program + RExC_size + 1;
7330     pRExC_state->code_index = 0;
7331
7332     *((char*) RExC_emit++) = (char) REG_MAGIC;
7333     /* setup various meta data about recursion, this all requires
7334      * RExC_npar to be correctly set, and a bit later on we clear it */
7335     if (RExC_seen & REG_RECURSE_SEEN) {
7336         DEBUG_OPTIMISE_MORE_r(Perl_re_printf( aTHX_
7337             "%*s%*s Setting up open/close parens\n",
7338                   22, "|    |", (int)(0 * 2 + 1), ""));
7339
7340         /* setup RExC_open_parens, which holds the address of each
7341          * OPEN tag, and to make things simpler for the 0 index
7342          * the start of the program - this is used later for offsets */
7343         Newxz(RExC_open_parens, RExC_npar,regnode *);
7344         SAVEFREEPV(RExC_open_parens);
7345         RExC_open_parens[0] = RExC_emit;
7346
7347         /* setup RExC_close_parens, which holds the address of each
7348          * CLOSE tag, and to make things simpler for the 0 index
7349          * the end of the program - this is used later for offsets */
7350         Newxz(RExC_close_parens, RExC_npar,regnode *);
7351         SAVEFREEPV(RExC_close_parens);
7352         /* we dont know where end op starts yet, so we dont
7353          * need to set RExC_close_parens[0] like we do RExC_open_parens[0] above */
7354
7355         /* Note, RExC_npar is 1 + the number of parens in a pattern.
7356          * So its 1 if there are no parens. */
7357         RExC_study_chunk_recursed_bytes= (RExC_npar >> 3) +
7358                                          ((RExC_npar & 0x07) != 0);
7359         Newx(RExC_study_chunk_recursed,
7360              RExC_study_chunk_recursed_bytes * RExC_npar, U8);
7361         SAVEFREEPV(RExC_study_chunk_recursed);
7362     }
7363     RExC_npar = 1;
7364     if (reg(pRExC_state, 0, &flags,1) == NULL) {
7365         ReREFCNT_dec(rx);
7366         Perl_croak(aTHX_ "panic: reg returned NULL to re_op_compile for generation pass, flags=%#" UVxf, (UV) flags);
7367     }
7368     DEBUG_OPTIMISE_r(
7369         Perl_re_printf( aTHX_  "Starting post parse optimization\n");
7370     );
7371
7372     /* XXXX To minimize changes to RE engine we always allocate
7373        3-units-long substrs field. */
7374     Newx(r->substrs, 1, struct reg_substr_data);
7375     if (RExC_recurse_count) {
7376         Newxz(RExC_recurse,RExC_recurse_count,regnode *);
7377         SAVEFREEPV(RExC_recurse);
7378     }
7379
7380   reStudy:
7381     r->minlen = minlen = sawlookahead = sawplus = sawopen = sawminmod = 0;
7382     DEBUG_r(
7383         RExC_study_chunk_recursed_count= 0;
7384     );
7385     Zero(r->substrs, 1, struct reg_substr_data);
7386     if (RExC_study_chunk_recursed) {
7387         Zero(RExC_study_chunk_recursed,
7388              RExC_study_chunk_recursed_bytes * RExC_npar, U8);
7389     }
7390
7391
7392 #ifdef TRIE_STUDY_OPT
7393     if (!restudied) {
7394         StructCopy(&zero_scan_data, &data, scan_data_t);
7395         copyRExC_state = RExC_state;
7396     } else {
7397         U32 seen=RExC_seen;
7398         DEBUG_OPTIMISE_r(Perl_re_printf( aTHX_ "Restudying\n"));
7399
7400         RExC_state = copyRExC_state;
7401         if (seen & REG_TOP_LEVEL_BRANCHES_SEEN)
7402             RExC_seen |= REG_TOP_LEVEL_BRANCHES_SEEN;
7403         else
7404             RExC_seen &= ~REG_TOP_LEVEL_BRANCHES_SEEN;
7405         StructCopy(&zero_scan_data, &data, scan_data_t);
7406     }
7407 #else
7408     StructCopy(&zero_scan_data, &data, scan_data_t);
7409 #endif
7410
7411     /* Dig out information for optimizations. */
7412     r->extflags = RExC_flags; /* was pm_op */
7413     /*dmq: removed as part of de-PMOP: pm->op_pmflags = RExC_flags; */
7414
7415     if (UTF)
7416         SvUTF8_on(rx);  /* Unicode in it? */
7417     ri->regstclass = NULL;
7418     if (RExC_naughty >= TOO_NAUGHTY)    /* Probably an expensive pattern. */
7419         r->intflags |= PREGf_NAUGHTY;
7420     scan = ri->program + 1;             /* First BRANCH. */
7421
7422     /* testing for BRANCH here tells us whether there is "must appear"
7423        data in the pattern. If there is then we can use it for optimisations */
7424     if (!(RExC_seen & REG_TOP_LEVEL_BRANCHES_SEEN)) { /*  Only one top-level choice.
7425                                                   */
7426         SSize_t fake;
7427         STRLEN longest_length[2];
7428         regnode_ssc ch_class; /* pointed to by data */
7429         int stclass_flag;
7430         SSize_t last_close = 0; /* pointed to by data */
7431         regnode *first= scan;
7432         regnode *first_next= regnext(first);
7433         int i;
7434
7435         /*
7436          * Skip introductions and multiplicators >= 1
7437          * so that we can extract the 'meat' of the pattern that must
7438          * match in the large if() sequence following.
7439          * NOTE that EXACT is NOT covered here, as it is normally
7440          * picked up by the optimiser separately.
7441          *
7442          * This is unfortunate as the optimiser isnt handling lookahead
7443          * properly currently.
7444          *
7445          */
7446         while ((OP(first) == OPEN && (sawopen = 1)) ||
7447                /* An OR of *one* alternative - should not happen now. */
7448             (OP(first) == BRANCH && OP(first_next) != BRANCH) ||
7449             /* for now we can't handle lookbehind IFMATCH*/
7450             (OP(first) == IFMATCH && !first->flags && (sawlookahead = 1)) ||
7451             (OP(first) == PLUS) ||
7452             (OP(first) == MINMOD) ||
7453                /* An {n,m} with n>0 */
7454             (PL_regkind[OP(first)] == CURLY && ARG1(first) > 0) ||
7455             (OP(first) == NOTHING && PL_regkind[OP(first_next)] != END ))
7456         {
7457                 /*
7458                  * the only op that could be a regnode is PLUS, all the rest
7459                  * will be regnode_1 or regnode_2.
7460                  *
7461                  * (yves doesn't think this is true)
7462                  */
7463                 if (OP(first) == PLUS)
7464                     sawplus = 1;
7465                 else {
7466                     if (OP(first) == MINMOD)
7467                         sawminmod = 1;
7468                     first += regarglen[OP(first)];
7469                 }
7470                 first = NEXTOPER(first);
7471                 first_next= regnext(first);
7472         }
7473
7474         /* Starting-point info. */
7475       again:
7476         DEBUG_PEEP("first:", first, 0, 0);
7477         /* Ignore EXACT as we deal with it later. */
7478         if (PL_regkind[OP(first)] == EXACT) {
7479             if (OP(first) == EXACT || OP(first) == EXACTL)
7480                 NOOP;   /* Empty, get anchored substr later. */
7481             else
7482                 ri->regstclass = first;
7483         }
7484 #ifdef TRIE_STCLASS
7485         else if (PL_regkind[OP(first)] == TRIE &&
7486                 ((reg_trie_data *)ri->data->data[ ARG(first) ])->minlen>0)
7487         {
7488             /* this can happen only on restudy */
7489             ri->regstclass = construct_ahocorasick_from_trie(pRExC_state, (regnode *)first, 0);
7490         }
7491 #endif
7492         else if (REGNODE_SIMPLE(OP(first)))
7493             ri->regstclass = first;
7494         else if (PL_regkind[OP(first)] == BOUND ||
7495                  PL_regkind[OP(first)] == NBOUND)
7496             ri->regstclass = first;
7497         else if (PL_regkind[OP(first)] == BOL) {
7498             r->intflags |= (OP(first) == MBOL
7499                            ? PREGf_ANCH_MBOL
7500                            : PREGf_ANCH_SBOL);
7501             first = NEXTOPER(first);
7502             goto again;
7503         }
7504         else if (OP(first) == GPOS) {
7505             r->intflags |= PREGf_ANCH_GPOS;
7506             first = NEXTOPER(first);
7507             goto again;
7508         }
7509         else if ((!sawopen || !RExC_sawback) &&
7510             !sawlookahead &&
7511             (OP(first) == STAR &&
7512             PL_regkind[OP(NEXTOPER(first))] == REG_ANY) &&
7513             !(r->intflags & PREGf_ANCH) && !pRExC_state->code_blocks)
7514         {
7515             /* turn .* into ^.* with an implied $*=1 */
7516             const int type =
7517                 (OP(NEXTOPER(first)) == REG_ANY)
7518                     ? PREGf_ANCH_MBOL
7519                     : PREGf_ANCH_SBOL;
7520             r->intflags |= (type | PREGf_IMPLICIT);
7521             first = NEXTOPER(first);
7522             goto again;
7523         }
7524         if (sawplus && !sawminmod && !sawlookahead
7525             && (!sawopen || !RExC_sawback)
7526             && !pRExC_state->code_blocks) /* May examine pos and $& */
7527             /* x+ must match at the 1st pos of run of x's */
7528             r->intflags |= PREGf_SKIP;
7529
7530         /* Scan is after the zeroth branch, first is atomic matcher. */
7531 #ifdef TRIE_STUDY_OPT
7532         DEBUG_PARSE_r(
7533             if (!restudied)
7534                 Perl_re_printf( aTHX_  "first at %" IVdf "\n",
7535                               (IV)(first - scan + 1))
7536         );
7537 #else
7538         DEBUG_PARSE_r(
7539             Perl_re_printf( aTHX_  "first at %" IVdf "\n",
7540                 (IV)(first - scan + 1))
7541         );
7542 #endif
7543
7544
7545         /*
7546         * If there's something expensive in the r.e., find the
7547         * longest literal string that must appear and make it the
7548         * regmust.  Resolve ties in favor of later strings, since
7549         * the regstart check works with the beginning of the r.e.
7550         * and avoiding duplication strengthens checking.  Not a
7551         * strong reason, but sufficient in the absence of others.
7552         * [Now we resolve ties in favor of the earlier string if
7553         * it happens that c_offset_min has been invalidated, since the
7554         * earlier string may buy us something the later one won't.]
7555         */
7556
7557         data.substrs[0].str = newSVpvs("");
7558         data.substrs[1].str = newSVpvs("");
7559         data.last_found = newSVpvs("");
7560         data.cur_is_floating = 0; /* initially any found substring is fixed */
7561         ENTER_with_name("study_chunk");
7562         SAVEFREESV(data.substrs[0].str);
7563         SAVEFREESV(data.substrs[1].str);
7564         SAVEFREESV(data.last_found);
7565         first = scan;
7566         if (!ri->regstclass) {
7567             ssc_init(pRExC_state, &ch_class);
7568             data.start_class = &ch_class;
7569             stclass_flag = SCF_DO_STCLASS_AND;
7570         } else                          /* XXXX Check for BOUND? */
7571             stclass_flag = 0;
7572         data.last_closep = &last_close;
7573
7574         DEBUG_RExC_seen();
7575         minlen = study_chunk(pRExC_state, &first, &minlen, &fake,
7576                              scan + RExC_size, /* Up to end */
7577             &data, -1, 0, NULL,
7578             SCF_DO_SUBSTR | SCF_WHILEM_VISITED_POS | stclass_flag
7579                           | (restudied ? SCF_TRIE_DOING_RESTUDY : 0),
7580             0);
7581
7582
7583         CHECK_RESTUDY_GOTO_butfirst(LEAVE_with_name("study_chunk"));
7584
7585
7586         if ( RExC_npar == 1 && !data.cur_is_floating
7587              && data.last_start_min == 0 && data.last_end > 0
7588              && !RExC_seen_zerolen
7589              && !(RExC_seen & REG_VERBARG_SEEN)
7590              && !(RExC_seen & REG_GPOS_SEEN)
7591         ){
7592             r->extflags |= RXf_CHECK_ALL;
7593         }
7594         scan_commit(pRExC_state, &data,&minlen,0);
7595
7596
7597         /* XXX this is done in reverse order because that's the way the
7598          * code was before it was parameterised. Don't know whether it
7599          * actually needs doing in reverse order. DAPM */
7600         for (i = 1; i >= 0; i--) {
7601             longest_length[i] = CHR_SVLEN(data.substrs[i].str);
7602
7603             if (   !(   i
7604                      && SvCUR(data.substrs[0].str)  /* ok to leave SvCUR */
7605                      &&    data.substrs[0].min_offset
7606                         == data.substrs[1].min_offset
7607                      &&    SvCUR(data.substrs[0].str)
7608                         == SvCUR(data.substrs[1].str)
7609                     )
7610                 && S_setup_longest (aTHX_ pRExC_state,
7611                                         &(r->substrs->data[i]),
7612                                         &(data.substrs[i]),
7613                                         longest_length[i]))
7614             {
7615                 r->substrs->data[i].min_offset =
7616                         data.substrs[i].min_offset - data.substrs[i].lookbehind;
7617
7618                 r->substrs->data[i].max_offset = data.substrs[i].max_offset;
7619                 /* Don't offset infinity */
7620                 if (data.substrs[i].max_offset < SSize_t_MAX)
7621                     r->substrs->data[i].max_offset -= data.substrs[i].lookbehind;
7622                 SvREFCNT_inc_simple_void_NN(data.substrs[i].str);
7623             }
7624             else {
7625                 r->substrs->data[i].substr      = NULL;
7626                 r->substrs->data[i].utf8_substr = NULL;
7627                 longest_length[i] = 0;
7628             }
7629         }
7630
7631         LEAVE_with_name("study_chunk");
7632
7633         if (ri->regstclass
7634             && (OP(ri->regstclass) == REG_ANY || OP(ri->regstclass) == SANY))
7635             ri->regstclass = NULL;
7636
7637         if ((!(r->substrs->data[0].substr || r->substrs->data[0].utf8_substr)
7638               || r->substrs->data[0].min_offset)
7639             && stclass_flag
7640             && ! (ANYOF_FLAGS(data.start_class) & SSC_MATCHES_EMPTY_STRING)
7641             && is_ssc_worth_it(pRExC_state, data.start_class))
7642         {
7643             const U32 n = add_data(pRExC_state, STR_WITH_LEN("f"));
7644
7645             ssc_finalize(pRExC_state, data.start_class);
7646
7647             Newx(RExC_rxi->data->data[n], 1, regnode_ssc);
7648             StructCopy(data.start_class,
7649                        (regnode_ssc*)RExC_rxi->data->data[n],
7650                        regnode_ssc);
7651             ri->regstclass = (regnode*)RExC_rxi->data->data[n];
7652             r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
7653             DEBUG_COMPILE_r({ SV *sv = sv_newmortal();
7654                       regprop(r, sv, (regnode*)data.start_class, NULL, pRExC_state);
7655                       Perl_re_printf( aTHX_
7656                                     "synthetic stclass \"%s\".\n",
7657                                     SvPVX_const(sv));});
7658             data.start_class = NULL;
7659         }
7660
7661         /* A temporary algorithm prefers floated substr to fixed one of
7662          * same length to dig more info. */
7663         i = (longest_length[0] <= longest_length[1]);
7664         r->substrs->check_ix = i;
7665         r->check_end_shift  = r->substrs->data[i].end_shift;
7666         r->check_substr     = r->substrs->data[i].substr;
7667         r->check_utf8       = r->substrs->data[i].utf8_substr;
7668         r->check_offset_min = r->substrs->data[i].min_offset;
7669         r->check_offset_max = r->substrs->data[i].max_offset;
7670         if (!i && (r->intflags & (PREGf_ANCH_SBOL|PREGf_ANCH_GPOS)))
7671             r->intflags |= PREGf_NOSCAN;
7672
7673         if ((r->check_substr || r->check_utf8) ) {
7674             r->extflags |= RXf_USE_INTUIT;
7675             if (SvTAIL(r->check_substr ? r->check_substr : r->check_utf8))
7676                 r->extflags |= RXf_INTUIT_TAIL;
7677         }
7678
7679         /* XXX Unneeded? dmq (shouldn't as this is handled elsewhere)
7680         if ( (STRLEN)minlen < longest_length[1] )
7681             minlen= longest_length[1];
7682         if ( (STRLEN)minlen < longest_length[0] )
7683             minlen= longest_length[0];
7684         */
7685     }
7686     else {
7687         /* Several toplevels. Best we can is to set minlen. */
7688         SSize_t fake;
7689         regnode_ssc ch_class;
7690         SSize_t last_close = 0;
7691
7692         DEBUG_PARSE_r(Perl_re_printf( aTHX_  "\nMulti Top Level\n"));
7693
7694         scan = ri->program + 1;
7695         ssc_init(pRExC_state, &ch_class);
7696         data.start_class = &ch_class;
7697         data.last_closep = &last_close;
7698
7699         DEBUG_RExC_seen();
7700         minlen = study_chunk(pRExC_state,
7701             &scan, &minlen, &fake, scan + RExC_size, &data, -1, 0, NULL,
7702             SCF_DO_STCLASS_AND|SCF_WHILEM_VISITED_POS|(restudied
7703                                                       ? SCF_TRIE_DOING_RESTUDY
7704                                                       : 0),
7705             0);
7706
7707         CHECK_RESTUDY_GOTO_butfirst(NOOP);
7708
7709         r->check_substr = NULL;
7710         r->check_utf8 = NULL;
7711         r->substrs->data[0].substr      = NULL;
7712         r->substrs->data[0].utf8_substr = NULL;
7713         r->substrs->data[1].substr      = NULL;
7714         r->substrs->data[1].utf8_substr = NULL;
7715
7716         if (! (ANYOF_FLAGS(data.start_class) & SSC_MATCHES_EMPTY_STRING)
7717             && is_ssc_worth_it(pRExC_state, data.start_class))
7718         {
7719             const U32 n = add_data(pRExC_state, STR_WITH_LEN("f"));
7720
7721             ssc_finalize(pRExC_state, data.start_class);
7722
7723             Newx(RExC_rxi->data->data[n], 1, regnode_ssc);
7724             StructCopy(data.start_class,
7725                        (regnode_ssc*)RExC_rxi->data->data[n],
7726                        regnode_ssc);
7727             ri->regstclass = (regnode*)RExC_rxi->data->data[n];
7728             r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
7729             DEBUG_COMPILE_r({ SV* sv = sv_newmortal();
7730                       regprop(r, sv, (regnode*)data.start_class, NULL, pRExC_state);
7731                       Perl_re_printf( aTHX_
7732                                     "synthetic stclass \"%s\".\n",
7733                                     SvPVX_const(sv));});
7734             data.start_class = NULL;
7735         }
7736     }
7737
7738     if (RExC_seen & REG_UNBOUNDED_QUANTIFIER_SEEN) {
7739         r->extflags |= RXf_UNBOUNDED_QUANTIFIER_SEEN;
7740         r->maxlen = REG_INFTY;
7741     }
7742     else {
7743         r->maxlen = RExC_maxlen;
7744     }
7745
7746     /* Guard against an embedded (?=) or (?<=) with a longer minlen than
7747        the "real" pattern. */
7748     DEBUG_OPTIMISE_r({
7749         Perl_re_printf( aTHX_ "minlen: %" IVdf " r->minlen:%" IVdf " maxlen:%" IVdf "\n",
7750                       (IV)minlen, (IV)r->minlen, (IV)RExC_maxlen);
7751     });
7752     r->minlenret = minlen;
7753     if (r->minlen < minlen)
7754         r->minlen = minlen;
7755
7756     if (RExC_seen & REG_RECURSE_SEEN ) {
7757         r->intflags |= PREGf_RECURSE_SEEN;
7758         Newxz(r->recurse_locinput, r->nparens + 1, char *);
7759     }
7760     if (RExC_seen & REG_GPOS_SEEN)
7761         r->intflags |= PREGf_GPOS_SEEN;
7762     if (RExC_seen & REG_LOOKBEHIND_SEEN)
7763         r->extflags |= RXf_NO_INPLACE_SUBST; /* inplace might break the
7764                                                 lookbehind */
7765     if (pRExC_state->code_blocks)
7766         r->extflags |= RXf_EVAL_SEEN;
7767     if (RExC_seen & REG_VERBARG_SEEN)
7768     {
7769         r->intflags |= PREGf_VERBARG_SEEN;
7770         r->extflags |= RXf_NO_INPLACE_SUBST; /* don't understand this! Yves */
7771     }
7772     if (RExC_seen & REG_CUTGROUP_SEEN)
7773         r->intflags |= PREGf_CUTGROUP_SEEN;
7774     if (pm_flags & PMf_USE_RE_EVAL)
7775         r->intflags |= PREGf_USE_RE_EVAL;
7776     if (RExC_paren_names)
7777         RXp_PAREN_NAMES(r) = MUTABLE_HV(SvREFCNT_inc(RExC_paren_names));
7778     else
7779         RXp_PAREN_NAMES(r) = NULL;
7780
7781     /* If we have seen an anchor in our pattern then we set the extflag RXf_IS_ANCHORED
7782      * so it can be used in pp.c */
7783     if (r->intflags & PREGf_ANCH)
7784         r->extflags |= RXf_IS_ANCHORED;
7785
7786
7787     {
7788         /* this is used to identify "special" patterns that might result
7789          * in Perl NOT calling the regex engine and instead doing the match "itself",
7790          * particularly special cases in split//. By having the regex compiler
7791          * do this pattern matching at a regop level (instead of by inspecting the pattern)
7792          * we avoid weird issues with equivalent patterns resulting in different behavior,
7793          * AND we allow non Perl engines to get the same optimizations by the setting the
7794          * flags appropriately - Yves */
7795         regnode *first = ri->program + 1;
7796         U8 fop = OP(first);
7797         regnode *next = regnext(first);
7798         U8 nop = OP(next);
7799
7800         if (PL_regkind[fop] == NOTHING && nop == END)
7801             r->extflags |= RXf_NULL;
7802         else if ((fop == MBOL || (fop == SBOL && !first->flags)) && nop == END)
7803             /* when fop is SBOL first->flags will be true only when it was
7804              * produced by parsing /\A/, and not when parsing /^/. This is
7805              * very important for the split code as there we want to
7806              * treat /^/ as /^/m, but we do not want to treat /\A/ as /^/m.
7807              * See rt #122761 for more details. -- Yves */
7808             r->extflags |= RXf_START_ONLY;
7809         else if (fop == PLUS
7810                  && PL_regkind[nop] == POSIXD && FLAGS(next) == _CC_SPACE
7811                  && nop == END)
7812             r->extflags |= RXf_WHITE;
7813         else if ( r->extflags & RXf_SPLIT
7814                   && (fop == EXACT || fop == EXACTL)
7815                   && STR_LEN(first) == 1
7816                   && *(STRING(first)) == ' '
7817                   && nop == END )
7818             r->extflags |= (RXf_SKIPWHITE|RXf_WHITE);
7819
7820     }
7821
7822     if (RExC_contains_locale) {
7823         RXp_EXTFLAGS(r) |= RXf_TAINTED;
7824     }
7825
7826 #ifdef DEBUGGING
7827     if (RExC_paren_names) {
7828         ri->name_list_idx = add_data( pRExC_state, STR_WITH_LEN("a"));
7829         ri->data->data[ri->name_list_idx]
7830                                    = (void*)SvREFCNT_inc(RExC_paren_name_list);
7831     } else
7832 #endif
7833     ri->name_list_idx = 0;
7834
7835     while ( RExC_recurse_count > 0 ) {
7836         const regnode *scan = RExC_recurse[ --RExC_recurse_count ];
7837         /*
7838          * This data structure is set up in study_chunk() and is used
7839          * to calculate the distance between a GOSUB regopcode and
7840          * the OPEN/CURLYM (CURLYM's are special and can act like OPEN's)
7841          * it refers to.
7842          *
7843          * If for some reason someone writes code that optimises
7844          * away a GOSUB opcode then the assert should be changed to
7845          * an if(scan) to guard the ARG2L_SET() - Yves
7846          *
7847          */
7848         assert(scan && OP(scan) == GOSUB);
7849         ARG2L_SET( scan, RExC_open_parens[ARG(scan)] - scan );
7850     }
7851
7852     Newxz(r->offs, RExC_npar, regexp_paren_pair);
7853     /* assume we don't need to swap parens around before we match */
7854     DEBUG_TEST_r({
7855         Perl_re_printf( aTHX_ "study_chunk_recursed_count: %lu\n",
7856             (unsigned long)RExC_study_chunk_recursed_count);
7857     });
7858     DEBUG_DUMP_r({
7859         DEBUG_RExC_seen();
7860         Perl_re_printf( aTHX_ "Final program:\n");
7861         regdump(r);
7862     });
7863 #ifdef RE_TRACK_PATTERN_OFFSETS
7864     DEBUG_OFFSETS_r(if (ri->u.offsets) {
7865         const STRLEN len = ri->u.offsets[0];
7866         STRLEN i;
7867         GET_RE_DEBUG_FLAGS_DECL;
7868         Perl_re_printf( aTHX_
7869                       "Offsets: [%" UVuf "]\n\t", (UV)ri->u.offsets[0]);
7870         for (i = 1; i <= len; i++) {
7871             if (ri->u.offsets[i*2-1] || ri->u.offsets[i*2])
7872                 Perl_re_printf( aTHX_  "%" UVuf ":%" UVuf "[%" UVuf "] ",
7873                 (UV)i, (UV)ri->u.offsets[i*2-1], (UV)ri->u.offsets[i*2]);
7874             }
7875         Perl_re_printf( aTHX_  "\n");
7876     });
7877 #endif
7878
7879 #ifdef USE_ITHREADS
7880     /* under ithreads the ?pat? PMf_USED flag on the pmop is simulated
7881      * by setting the regexp SV to readonly-only instead. If the
7882      * pattern's been recompiled, the USEDness should remain. */
7883     if (old_re && SvREADONLY(old_re))
7884         SvREADONLY_on(rx);
7885 #endif
7886     return rx;
7887 }
7888
7889
7890 SV*
7891 Perl_reg_named_buff(pTHX_ REGEXP * const rx, SV * const key, SV * const value,
7892                     const U32 flags)
7893 {
7894     PERL_ARGS_ASSERT_REG_NAMED_BUFF;
7895
7896     PERL_UNUSED_ARG(value);
7897
7898     if (flags & RXapif_FETCH) {
7899         return reg_named_buff_fetch(rx, key, flags);
7900     } else if (flags & (RXapif_STORE | RXapif_DELETE | RXapif_CLEAR)) {
7901         Perl_croak_no_modify();
7902         return NULL;
7903     } else if (flags & RXapif_EXISTS) {
7904         return reg_named_buff_exists(rx, key, flags)
7905             ? &PL_sv_yes
7906             : &PL_sv_no;
7907     } else if (flags & RXapif_REGNAMES) {
7908         return reg_named_buff_all(rx, flags);
7909     } else if (flags & (RXapif_SCALAR | RXapif_REGNAMES_COUNT)) {
7910         return reg_named_buff_scalar(rx, flags);
7911     } else {
7912         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff", (int)flags);
7913         return NULL;
7914     }
7915 }
7916
7917 SV*
7918 Perl_reg_named_buff_iter(pTHX_ REGEXP * const rx, const SV * const lastkey,
7919                          const U32 flags)
7920 {
7921     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ITER;
7922     PERL_UNUSED_ARG(lastkey);
7923
7924     if (flags & RXapif_FIRSTKEY)
7925         return reg_named_buff_firstkey(rx, flags);
7926     else if (flags & RXapif_NEXTKEY)
7927         return reg_named_buff_nextkey(rx, flags);
7928     else {
7929         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_iter",
7930                                             (int)flags);
7931         return NULL;
7932     }
7933 }
7934
7935 SV*
7936 Perl_reg_named_buff_fetch(pTHX_ REGEXP * const r, SV * const namesv,
7937                           const U32 flags)
7938 {
7939     SV *ret;
7940     struct regexp *const rx = ReANY(r);
7941
7942     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FETCH;
7943
7944     if (rx && RXp_PAREN_NAMES(rx)) {
7945         HE *he_str = hv_fetch_ent( RXp_PAREN_NAMES(rx), namesv, 0, 0 );
7946         if (he_str) {
7947             IV i;
7948             SV* sv_dat=HeVAL(he_str);
7949             I32 *nums=(I32*)SvPVX(sv_dat);
7950             AV * const retarray = (flags & RXapif_ALL) ? newAV() : NULL;
7951             for ( i=0; i<SvIVX(sv_dat); i++ ) {
7952                 if ((I32)(rx->nparens) >= nums[i]
7953                     && rx->offs[nums[i]].start != -1
7954                     && rx->offs[nums[i]].end != -1)
7955                 {
7956                     ret = newSVpvs("");
7957                     CALLREG_NUMBUF_FETCH(r,nums[i],ret);
7958                     if (!retarray)
7959                         return ret;
7960                 } else {
7961                     if (retarray)
7962                         ret = newSVsv(&PL_sv_undef);
7963                 }
7964                 if (retarray)
7965                     av_push(retarray, ret);
7966             }
7967             if (retarray)
7968                 return newRV_noinc(MUTABLE_SV(retarray));
7969         }
7970     }
7971     return NULL;
7972 }
7973
7974 bool
7975 Perl_reg_named_buff_exists(pTHX_ REGEXP * const r, SV * const key,
7976                            const U32 flags)
7977 {
7978     struct regexp *const rx = ReANY(r);
7979
7980     PERL_ARGS_ASSERT_REG_NAMED_BUFF_EXISTS;
7981
7982     if (rx && RXp_PAREN_NAMES(rx)) {
7983         if (flags & RXapif_ALL) {
7984             return hv_exists_ent(RXp_PAREN_NAMES(rx), key, 0);
7985         } else {
7986             SV *sv = CALLREG_NAMED_BUFF_FETCH(r, key, flags);
7987             if (sv) {
7988                 SvREFCNT_dec_NN(sv);
7989                 return TRUE;
7990             } else {
7991                 return FALSE;
7992             }
7993         }
7994     } else {
7995         return FALSE;
7996     }
7997 }
7998
7999 SV*
8000 Perl_reg_named_buff_firstkey(pTHX_ REGEXP * const r, const U32 flags)
8001 {
8002     struct regexp *const rx = ReANY(r);
8003
8004     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FIRSTKEY;
8005
8006     if ( rx && RXp_PAREN_NAMES(rx) ) {
8007         (void)hv_iterinit(RXp_PAREN_NAMES(rx));
8008
8009         return CALLREG_NAMED_BUFF_NEXTKEY(r, NULL, flags & ~RXapif_FIRSTKEY);
8010     } else {
8011         return FALSE;
8012     }
8013 }
8014
8015 SV*
8016 Perl_reg_named_buff_nextkey(pTHX_ REGEXP * const r, const U32 flags)
8017 {
8018     struct regexp *const rx = ReANY(r);
8019     GET_RE_DEBUG_FLAGS_DECL;
8020
8021     PERL_ARGS_ASSERT_REG_NAMED_BUFF_NEXTKEY;
8022
8023     if (rx && RXp_PAREN_NAMES(rx)) {
8024         HV *hv = RXp_PAREN_NAMES(rx);
8025         HE *temphe;
8026         while ( (temphe = hv_iternext_flags(hv,0)) ) {
8027             IV i;
8028             IV parno = 0;
8029             SV* sv_dat = HeVAL(temphe);
8030             I32 *nums = (I32*)SvPVX(sv_dat);
8031             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
8032                 if ((I32)(rx->lastparen) >= nums[i] &&
8033                     rx->offs[nums[i]].start != -1 &&
8034                     rx->offs[nums[i]].end != -1)
8035                 {
8036                     parno = nums[i];
8037                     break;
8038                 }
8039             }
8040             if (parno || flags & RXapif_ALL) {
8041                 return newSVhek(HeKEY_hek(temphe));
8042             }
8043         }
8044     }
8045     return NULL;
8046 }
8047
8048 SV*
8049 Perl_reg_named_buff_scalar(pTHX_ REGEXP * const r, const U32 flags)
8050 {
8051     SV *ret;
8052     AV *av;
8053     SSize_t length;
8054     struct regexp *const rx = ReANY(r);
8055
8056     PERL_ARGS_ASSERT_REG_NAMED_BUFF_SCALAR;
8057
8058     if (rx && RXp_PAREN_NAMES(rx)) {
8059         if (flags & (RXapif_ALL | RXapif_REGNAMES_COUNT)) {
8060             return newSViv(HvTOTALKEYS(RXp_PAREN_NAMES(rx)));
8061         } else if (flags & RXapif_ONE) {
8062             ret = CALLREG_NAMED_BUFF_ALL(r, (flags | RXapif_REGNAMES));
8063             av = MUTABLE_AV(SvRV(ret));
8064             length = av_tindex(av);
8065             SvREFCNT_dec_NN(ret);
8066             return newSViv(length + 1);
8067         } else {
8068             Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_scalar",
8069                                                 (int)flags);
8070             return NULL;
8071         }
8072     }
8073     return &PL_sv_undef;
8074 }
8075
8076 SV*
8077 Perl_reg_named_buff_all(pTHX_ REGEXP * const r, const U32 flags)
8078 {
8079     struct regexp *const rx = ReANY(r);
8080     AV *av = newAV();
8081
8082     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ALL;
8083
8084     if (rx && RXp_PAREN_NAMES(rx)) {
8085         HV *hv= RXp_PAREN_NAMES(rx);
8086         HE *temphe;
8087         (void)hv_iterinit(hv);
8088         while ( (temphe = hv_iternext_flags(hv,0)) ) {
8089             IV i;
8090             IV parno = 0;
8091             SV* sv_dat = HeVAL(temphe);
8092             I32 *nums = (I32*)SvPVX(sv_dat);
8093             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
8094                 if ((I32)(rx->lastparen) >= nums[i] &&
8095                     rx->offs[nums[i]].start != -1 &&
8096                     rx->offs[nums[i]].end != -1)
8097                 {
8098                     parno = nums[i];
8099                     break;
8100                 }
8101             }
8102             if (parno || flags & RXapif_ALL) {
8103                 av_push(av, newSVhek(HeKEY_hek(temphe)));
8104             }
8105         }
8106     }
8107
8108     return newRV_noinc(MUTABLE_SV(av));
8109 }
8110
8111 void
8112 Perl_reg_numbered_buff_fetch(pTHX_ REGEXP * const r, const I32 paren,
8113                              SV * const sv)
8114 {
8115     struct regexp *const rx = ReANY(r);
8116     char *s = NULL;
8117     SSize_t i = 0;
8118     SSize_t s1, t1;
8119     I32 n = paren;
8120
8121     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_FETCH;
8122
8123     if (      n == RX_BUFF_IDX_CARET_PREMATCH
8124            || n == RX_BUFF_IDX_CARET_FULLMATCH
8125            || n == RX_BUFF_IDX_CARET_POSTMATCH
8126        )
8127     {
8128         bool keepcopy = cBOOL(rx->extflags & RXf_PMf_KEEPCOPY);
8129         if (!keepcopy) {
8130             /* on something like
8131              *    $r = qr/.../;
8132              *    /$qr/p;
8133              * the KEEPCOPY is set on the PMOP rather than the regex */
8134             if (PL_curpm && r == PM_GETRE(PL_curpm))
8135                  keepcopy = cBOOL(PL_curpm->op_pmflags & PMf_KEEPCOPY);
8136         }
8137         if (!keepcopy)
8138             goto ret_undef;
8139     }
8140
8141     if (!rx->subbeg)
8142         goto ret_undef;
8143
8144     if (n == RX_BUFF_IDX_CARET_FULLMATCH)
8145         /* no need to distinguish between them any more */
8146         n = RX_BUFF_IDX_FULLMATCH;
8147
8148     if ((n == RX_BUFF_IDX_PREMATCH || n == RX_BUFF_IDX_CARET_PREMATCH)
8149         && rx->offs[0].start != -1)
8150     {
8151         /* $`, ${^PREMATCH} */
8152         i = rx->offs[0].start;
8153         s = rx->subbeg;
8154     }
8155     else
8156     if ((n == RX_BUFF_IDX_POSTMATCH || n == RX_BUFF_IDX_CARET_POSTMATCH)
8157         && rx->offs[0].end != -1)
8158     {
8159         /* $', ${^POSTMATCH} */
8160         s = rx->subbeg - rx->suboffset + rx->offs[0].end;
8161         i = rx->sublen + rx->suboffset - rx->offs[0].end;
8162     }
8163     else
8164     if ( 0 <= n && n <= (I32)rx->nparens &&
8165         (s1 = rx->offs[n].start) != -1 &&
8166         (t1 = rx->offs[n].end) != -1)
8167     {
8168         /* $&, ${^MATCH},  $1 ... */
8169         i = t1 - s1;
8170         s = rx->subbeg + s1 - rx->suboffset;
8171     } else {
8172         goto ret_undef;
8173     }
8174
8175     assert(s >= rx->subbeg);
8176     assert((STRLEN)rx->sublen >= (STRLEN)((s - rx->subbeg) + i) );
8177     if (i >= 0) {
8178 #ifdef NO_TAINT_SUPPORT
8179         sv_setpvn(sv, s, i);
8180 #else
8181         const int oldtainted = TAINT_get;
8182         TAINT_NOT;
8183         sv_setpvn(sv, s, i);
8184         TAINT_set(oldtainted);
8185 #endif
8186         if (RXp_MATCH_UTF8(rx))
8187             SvUTF8_on(sv);
8188         else
8189             SvUTF8_off(sv);
8190         if (TAINTING_get) {
8191             if (RXp_MATCH_TAINTED(rx)) {
8192                 if (SvTYPE(sv) >= SVt_PVMG) {
8193                     MAGIC* const mg = SvMAGIC(sv);
8194                     MAGIC* mgt;
8195                     TAINT;
8196                     SvMAGIC_set(sv, mg->mg_moremagic);
8197                     SvTAINT(sv);
8198                     if ((mgt = SvMAGIC(sv))) {
8199                         mg->mg_moremagic = mgt;
8200                         SvMAGIC_set(sv, mg);
8201                     }
8202                 } else {
8203                     TAINT;
8204                     SvTAINT(sv);
8205                 }
8206             } else
8207                 SvTAINTED_off(sv);
8208         }
8209     } else {
8210       ret_undef:
8211         sv_set_undef(sv);
8212         return;
8213     }
8214 }
8215
8216 void
8217 Perl_reg_numbered_buff_store(pTHX_ REGEXP * const rx, const I32 paren,
8218                                                          SV const * const value)
8219 {
8220     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_STORE;
8221
8222     PERL_UNUSED_ARG(rx);
8223     PERL_UNUSED_ARG(paren);
8224     PERL_UNUSED_ARG(value);
8225
8226     if (!PL_localizing)
8227         Perl_croak_no_modify();
8228 }
8229
8230 I32
8231 Perl_reg_numbered_buff_length(pTHX_ REGEXP * const r, const SV * const sv,
8232                               const I32 paren)
8233 {
8234     struct regexp *const rx = ReANY(r);
8235     I32 i;
8236     I32 s1, t1;
8237
8238     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_LENGTH;
8239
8240     if (   paren == RX_BUFF_IDX_CARET_PREMATCH
8241         || paren == RX_BUFF_IDX_CARET_FULLMATCH
8242         || paren == RX_BUFF_IDX_CARET_POSTMATCH
8243     )
8244     {
8245         bool keepcopy = cBOOL(rx->extflags & RXf_PMf_KEEPCOPY);
8246         if (!keepcopy) {
8247             /* on something like
8248              *    $r = qr/.../;
8249              *    /$qr/p;
8250              * the KEEPCOPY is set on the PMOP rather than the regex */
8251             if (PL_curpm && r == PM_GETRE(PL_curpm))
8252                  keepcopy = cBOOL(PL_curpm->op_pmflags & PMf_KEEPCOPY);
8253         }
8254         if (!keepcopy)
8255             goto warn_undef;
8256     }
8257
8258     /* Some of this code was originally in C<Perl_magic_len> in F<mg.c> */
8259     switch (paren) {
8260       case RX_BUFF_IDX_CARET_PREMATCH: /* ${^PREMATCH} */
8261       case RX_BUFF_IDX_PREMATCH:       /* $` */
8262         if (rx->offs[0].start != -1) {
8263                         i = rx->offs[0].start;
8264                         if (i > 0) {
8265                                 s1 = 0;
8266                                 t1 = i;
8267                                 goto getlen;
8268                         }
8269             }
8270         return 0;
8271
8272       case RX_BUFF_IDX_CARET_POSTMATCH: /* ${^POSTMATCH} */
8273       case RX_BUFF_IDX_POSTMATCH:       /* $' */
8274             if (rx->offs[0].end != -1) {
8275                         i = rx->sublen - rx->offs[0].end;
8276                         if (i > 0) {
8277                                 s1 = rx->offs[0].end;
8278                                 t1 = rx->sublen;
8279                                 goto getlen;
8280                         }
8281             }
8282         return 0;
8283
8284       default: /* $& / ${^MATCH}, $1, $2, ... */
8285             if (paren <= (I32)rx->nparens &&
8286             (s1 = rx->offs[paren].start) != -1 &&
8287             (t1 = rx->offs[paren].end) != -1)
8288             {
8289             i = t1 - s1;
8290             goto getlen;
8291         } else {
8292           warn_undef:
8293             if (ckWARN(WARN_UNINITIALIZED))
8294                 report_uninit((const SV *)sv);
8295             return 0;
8296         }
8297     }
8298   getlen:
8299     if (i > 0 && RXp_MATCH_UTF8(rx)) {
8300         const char * const s = rx->subbeg - rx->suboffset + s1;
8301         const U8 *ep;
8302         STRLEN el;
8303
8304         i = t1 - s1;
8305         if (is_utf8_string_loclen((U8*)s, i, &ep, &el))
8306                         i = el;
8307     }
8308     return i;
8309 }
8310
8311 SV*
8312 Perl_reg_qr_package(pTHX_ REGEXP * const rx)
8313 {
8314     PERL_ARGS_ASSERT_REG_QR_PACKAGE;
8315         PERL_UNUSED_ARG(rx);
8316         if (0)
8317             return NULL;
8318         else
8319             return newSVpvs("Regexp");
8320 }
8321
8322 /* Scans the name of a named buffer from the pattern.
8323  * If flags is REG_RSN_RETURN_NULL returns null.
8324  * If flags is REG_RSN_RETURN_NAME returns an SV* containing the name
8325  * If flags is REG_RSN_RETURN_DATA returns the data SV* corresponding
8326  * to the parsed name as looked up in the RExC_paren_names hash.
8327  * If there is an error throws a vFAIL().. type exception.
8328  */
8329
8330 #define REG_RSN_RETURN_NULL    0
8331 #define REG_RSN_RETURN_NAME    1
8332 #define REG_RSN_RETURN_DATA    2
8333
8334 STATIC SV*
8335 S_reg_scan_name(pTHX_ RExC_state_t *pRExC_state, U32 flags)
8336 {
8337     char *name_start = RExC_parse;
8338
8339     PERL_ARGS_ASSERT_REG_SCAN_NAME;
8340
8341     assert (RExC_parse <= RExC_end);
8342     if (RExC_parse == RExC_end) NOOP;
8343     else if (isIDFIRST_lazy_if_safe(RExC_parse, RExC_end, UTF)) {
8344          /* Note that the code here assumes well-formed UTF-8.  Skip IDFIRST by
8345           * using do...while */
8346         if (UTF)
8347             do {
8348                 RExC_parse += UTF8SKIP(RExC_parse);
8349             } while (   RExC_parse < RExC_end
8350                      && isWORDCHAR_utf8_safe((U8*)RExC_parse, (U8*) RExC_end));
8351         else
8352             do {
8353                 RExC_parse++;
8354             } while (RExC_parse < RExC_end && isWORDCHAR(*RExC_parse));
8355     } else {
8356         RExC_parse++; /* so the <- from the vFAIL is after the offending
8357                          character */
8358         vFAIL("Group name must start with a non-digit word character");
8359     }
8360     if ( flags ) {
8361         SV* sv_name
8362             = newSVpvn_flags(name_start, (int)(RExC_parse - name_start),
8363                              SVs_TEMP | (UTF ? SVf_UTF8 : 0));
8364         if ( flags == REG_RSN_RETURN_NAME)
8365             return sv_name;
8366         else if (flags==REG_RSN_RETURN_DATA) {
8367             HE *he_str = NULL;
8368             SV *sv_dat = NULL;
8369             if ( ! sv_name )      /* should not happen*/
8370                 Perl_croak(aTHX_ "panic: no svname in reg_scan_name");
8371             if (RExC_paren_names)
8372                 he_str = hv_fetch_ent( RExC_paren_names, sv_name, 0, 0 );
8373             if ( he_str )
8374                 sv_dat = HeVAL(he_str);
8375             if ( ! sv_dat )
8376                 vFAIL("Reference to nonexistent named group");
8377             return sv_dat;
8378         }
8379         else {
8380             Perl_croak(aTHX_ "panic: bad flag %lx in reg_scan_name",
8381                        (unsigned long) flags);
8382         }
8383         NOT_REACHED; /* NOTREACHED */
8384     }
8385     return NULL;
8386 }
8387
8388 #define DEBUG_PARSE_MSG(funcname)     DEBUG_PARSE_r({           \
8389     int num;                                                    \
8390     if (RExC_lastparse!=RExC_parse) {                           \
8391         Perl_re_printf( aTHX_  "%s",                                        \
8392             Perl_pv_pretty(aTHX_ RExC_mysv1, RExC_parse,        \
8393                 RExC_end - RExC_parse, 16,                      \
8394                 "", "",                                         \
8395                 PERL_PV_ESCAPE_UNI_DETECT |                     \
8396                 PERL_PV_PRETTY_ELLIPSES   |                     \
8397                 PERL_PV_PRETTY_LTGT       |                     \
8398                 PERL_PV_ESCAPE_RE         |                     \
8399                 PERL_PV_PRETTY_EXACTSIZE                        \
8400             )                                                   \
8401         );                                                      \
8402     } else                                                      \
8403         Perl_re_printf( aTHX_ "%16s","");                                   \
8404                                                                 \
8405     if (SIZE_ONLY)                                              \
8406        num = RExC_size + 1;                                     \
8407     else                                                        \
8408        num=REG_NODE_NUM(RExC_emit);                             \
8409     if (RExC_lastnum!=num)                                      \
8410        Perl_re_printf( aTHX_ "|%4d",num);                                   \
8411     else                                                        \
8412        Perl_re_printf( aTHX_ "|%4s","");                                    \
8413     Perl_re_printf( aTHX_ "|%*s%-4s",                                       \
8414         (int)((depth*2)), "",                                   \
8415         (funcname)                                              \
8416     );                                                          \
8417     RExC_lastnum=num;                                           \
8418     RExC_lastparse=RExC_parse;                                  \
8419 })
8420
8421
8422
8423 #define DEBUG_PARSE(funcname)     DEBUG_PARSE_r({           \
8424     DEBUG_PARSE_MSG((funcname));                            \
8425     Perl_re_printf( aTHX_ "%4s","\n");                                  \
8426 })
8427 #define DEBUG_PARSE_FMT(funcname,fmt,args)     DEBUG_PARSE_r({\
8428     DEBUG_PARSE_MSG((funcname));                            \
8429     Perl_re_printf( aTHX_ fmt "\n",args);                               \
8430 })
8431
8432 /* This section of code defines the inversion list object and its methods.  The
8433  * interfaces are highly subject to change, so as much as possible is static to
8434  * this file.  An inversion list is here implemented as a malloc'd C UV array
8435  * as an SVt_INVLIST scalar.
8436  *
8437  * An inversion list for Unicode is an array of code points, sorted by ordinal
8438  * number.  Each element gives the code point that begins a range that extends
8439  * up-to but not including the code point given by the next element.  The final
8440  * element gives the first code point of a range that extends to the platform's
8441  * infinity.  The even-numbered elements (invlist[0], invlist[2], invlist[4],
8442  * ...) give ranges whose code points are all in the inversion list.  We say
8443  * that those ranges are in the set.  The odd-numbered elements give ranges
8444  * whose code points are not in the inversion list, and hence not in the set.
8445  * Thus, element [0] is the first code point in the list.  Element [1]
8446  * is the first code point beyond that not in the list; and element [2] is the
8447  * first code point beyond that that is in the list.  In other words, the first
8448  * range is invlist[0]..(invlist[1]-1), and all code points in that range are
8449  * in the inversion list.  The second range is invlist[1]..(invlist[2]-1), and
8450  * all code points in that range are not in the inversion list.  The third
8451  * range invlist[2]..(invlist[3]-1) gives code points that are in the inversion
8452  * list, and so forth.  Thus every element whose index is divisible by two
8453  * gives the beginning of a range that is in the list, and every element whose
8454  * index is not divisible by two gives the beginning of a range not in the
8455  * list.  If the final element's index is divisible by two, the inversion list
8456  * extends to the platform's infinity; otherwise the highest code point in the
8457  * inversion list is the contents of that element minus 1.
8458  *
8459  * A range that contains just a single code point N will look like
8460  *  invlist[i]   == N
8461  *  invlist[i+1] == N+1
8462  *
8463  * If N is UV_MAX (the highest representable code point on the machine), N+1 is
8464  * impossible to represent, so element [i+1] is omitted.  The single element
8465  * inversion list
8466  *  invlist[0] == UV_MAX
8467  * contains just UV_MAX, but is interpreted as matching to infinity.
8468  *
8469  * Taking the complement (inverting) an inversion list is quite simple, if the
8470  * first element is 0, remove it; otherwise add a 0 element at the beginning.
8471  * This implementation reserves an element at the beginning of each inversion
8472  * list to always contain 0; there is an additional flag in the header which
8473  * indicates if the list begins at the 0, or is offset to begin at the next
8474  * element.  This means that the inversion list can be inverted without any
8475  * copying; just flip the flag.
8476  *
8477  * More about inversion lists can be found in "Unicode Demystified"
8478  * Chapter 13 by Richard Gillam, published by Addison-Wesley.
8479  *
8480  * The inversion list data structure is currently implemented as an SV pointing
8481  * to an array of UVs that the SV thinks are bytes.  This allows us to have an
8482  * array of UV whose memory management is automatically handled by the existing
8483  * facilities for SV's.
8484  *
8485  * Some of the methods should always be private to the implementation, and some
8486  * should eventually be made public */
8487
8488 /* The header definitions are in F<invlist_inline.h> */
8489
8490 #ifndef PERL_IN_XSUB_RE
8491
8492 PERL_STATIC_INLINE UV*
8493 S__invlist_array_init(SV* const invlist, const bool will_have_0)
8494 {
8495     /* Returns a pointer to the first element in the inversion list's array.
8496      * This is called upon initialization of an inversion list.  Where the
8497      * array begins depends on whether the list has the code point U+0000 in it
8498      * or not.  The other parameter tells it whether the code that follows this
8499      * call is about to put a 0 in the inversion list or not.  The first
8500      * element is either the element reserved for 0, if TRUE, or the element
8501      * after it, if FALSE */
8502
8503     bool* offset = get_invlist_offset_addr(invlist);
8504     UV* zero_addr = (UV *) SvPVX(invlist);
8505
8506     PERL_ARGS_ASSERT__INVLIST_ARRAY_INIT;
8507
8508     /* Must be empty */
8509     assert(! _invlist_len(invlist));
8510
8511     *zero_addr = 0;
8512
8513     /* 1^1 = 0; 1^0 = 1 */
8514     *offset = 1 ^ will_have_0;
8515     return zero_addr + *offset;
8516 }
8517
8518 #endif
8519
8520 PERL_STATIC_INLINE void
8521 S_invlist_set_len(pTHX_ SV* const invlist, const UV len, const bool offset)
8522 {
8523     /* Sets the current number of elements stored in the inversion list.
8524      * Updates SvCUR correspondingly */
8525     PERL_UNUSED_CONTEXT;
8526     PERL_ARGS_ASSERT_INVLIST_SET_LEN;
8527
8528     assert(SvTYPE(invlist) == SVt_INVLIST);
8529
8530     SvCUR_set(invlist,
8531               (len == 0)
8532                ? 0
8533                : TO_INTERNAL_SIZE(len + offset));
8534     assert(SvLEN(invlist) == 0 || SvCUR(invlist) <= SvLEN(invlist));
8535 }
8536
8537 #ifndef PERL_IN_XSUB_RE
8538
8539 STATIC void
8540 S_invlist_replace_list_destroys_src(pTHX_ SV * dest, SV * src)
8541 {
8542     /* Replaces the inversion list in 'dest' with the one from 'src'.  It
8543      * steals the list from 'src', so 'src' is made to have a NULL list.  This
8544      * is similar to what SvSetMagicSV() would do, if it were implemented on
8545      * inversion lists, though this routine avoids a copy */
8546
8547     const UV src_len          = _invlist_len(src);
8548     const bool src_offset     = *get_invlist_offset_addr(src);
8549     const STRLEN src_byte_len = SvLEN(src);
8550     char * array              = SvPVX(src);
8551
8552     const int oldtainted = TAINT_get;
8553
8554     PERL_ARGS_ASSERT_INVLIST_REPLACE_LIST_DESTROYS_SRC;
8555
8556     assert(SvTYPE(src) == SVt_INVLIST);
8557     assert(SvTYPE(dest) == SVt_INVLIST);
8558     assert(! invlist_is_iterating(src));
8559     assert(SvCUR(src) == 0 || SvCUR(src) < SvLEN(src));
8560
8561     /* Make sure it ends in the right place with a NUL, as our inversion list
8562      * manipulations aren't careful to keep this true, but sv_usepvn_flags()
8563      * asserts it */
8564     array[src_byte_len - 1] = '\0';
8565
8566     TAINT_NOT;      /* Otherwise it breaks */
8567     sv_usepvn_flags(dest,
8568                     (char *) array,
8569                     src_byte_len - 1,
8570
8571                     /* This flag is documented to cause a copy to be avoided */
8572                     SV_HAS_TRAILING_NUL);
8573     TAINT_set(oldtainted);
8574     SvPV_set(src, 0);
8575     SvLEN_set(src, 0);
8576     SvCUR_set(src, 0);
8577
8578     /* Finish up copying over the other fields in an inversion list */
8579     *get_invlist_offset_addr(dest) = src_offset;
8580     invlist_set_len(dest, src_len, src_offset);
8581     *get_invlist_previous_index_addr(dest) = 0;
8582     invlist_iterfinish(dest);
8583 }
8584
8585 PERL_STATIC_INLINE IV*
8586 S_get_invlist_previous_index_addr(SV* invlist)
8587 {
8588     /* Return the address of the IV that is reserved to hold the cached index
8589      * */
8590     PERL_ARGS_ASSERT_GET_INVLIST_PREVIOUS_INDEX_ADDR;
8591
8592     assert(SvTYPE(invlist) == SVt_INVLIST);
8593
8594     return &(((XINVLIST*) SvANY(invlist))->prev_index);
8595 }
8596
8597 PERL_STATIC_INLINE IV
8598 S_invlist_previous_index(SV* const invlist)
8599 {
8600     /* Returns cached index of previous search */
8601
8602     PERL_ARGS_ASSERT_INVLIST_PREVIOUS_INDEX;
8603
8604     return *get_invlist_previous_index_addr(invlist);
8605 }
8606
8607 PERL_STATIC_INLINE void
8608 S_invlist_set_previous_index(SV* const invlist, const IV index)
8609 {
8610     /* Caches <index> for later retrieval */
8611
8612     PERL_ARGS_ASSERT_INVLIST_SET_PREVIOUS_INDEX;
8613
8614     assert(index == 0 || index < (int) _invlist_len(invlist));
8615
8616     *get_invlist_previous_index_addr(invlist) = index;
8617 }
8618
8619 PERL_STATIC_INLINE void
8620 S_invlist_trim(SV* invlist)
8621 {
8622     /* Free the not currently-being-used space in an inversion list */
8623
8624     /* But don't free up the space needed for the 0 UV that is always at the
8625      * beginning of the list, nor the trailing NUL */
8626     const UV min_size = TO_INTERNAL_SIZE(1) + 1;
8627
8628     PERL_ARGS_ASSERT_INVLIST_TRIM;
8629
8630     assert(SvTYPE(invlist) == SVt_INVLIST);
8631
8632     SvPV_renew(invlist, MAX(min_size, SvCUR(invlist) + 1));
8633 }
8634
8635 PERL_STATIC_INLINE void
8636 S_invlist_clear(pTHX_ SV* invlist)    /* Empty the inversion list */
8637 {
8638     PERL_ARGS_ASSERT_INVLIST_CLEAR;
8639
8640     assert(SvTYPE(invlist) == SVt_INVLIST);
8641
8642     invlist_set_len(invlist, 0, 0);
8643     invlist_trim(invlist);
8644 }
8645
8646 #endif /* ifndef PERL_IN_XSUB_RE */
8647
8648 PERL_STATIC_INLINE bool
8649 S_invlist_is_iterating(SV* const invlist)
8650 {
8651     PERL_ARGS_ASSERT_INVLIST_IS_ITERATING;
8652
8653     return *(get_invlist_iter_addr(invlist)) < (STRLEN) UV_MAX;
8654 }
8655
8656 #ifndef PERL_IN_XSUB_RE
8657
8658 PERL_STATIC_INLINE UV
8659 S_invlist_max(SV* const invlist)
8660 {
8661     /* Returns the maximum number of elements storable in the inversion list's
8662      * array, without having to realloc() */
8663
8664     PERL_ARGS_ASSERT_INVLIST_MAX;
8665
8666     assert(SvTYPE(invlist) == SVt_INVLIST);
8667
8668     /* Assumes worst case, in which the 0 element is not counted in the
8669      * inversion list, so subtracts 1 for that */
8670     return SvLEN(invlist) == 0  /* This happens under _new_invlist_C_array */
8671            ? FROM_INTERNAL_SIZE(SvCUR(invlist)) - 1
8672            : FROM_INTERNAL_SIZE(SvLEN(invlist)) - 1;
8673 }
8674 SV*
8675 Perl__new_invlist(pTHX_ IV initial_size)
8676 {
8677
8678     /* Return a pointer to a newly constructed inversion list, with enough
8679      * space to store 'initial_size' elements.  If that number is negative, a
8680      * system default is used instead */
8681
8682     SV* new_list;
8683
8684     if (initial_size < 0) {
8685         initial_size = 10;
8686     }
8687
8688     /* Allocate the initial space */
8689     new_list = newSV_type(SVt_INVLIST);
8690
8691     /* First 1 is in case the zero element isn't in the list; second 1 is for
8692      * trailing NUL */
8693     SvGROW(new_list, TO_INTERNAL_SIZE(initial_size + 1) + 1);
8694     invlist_set_len(new_list, 0, 0);
8695
8696     /* Force iterinit() to be used to get iteration to work */
8697     *get_invlist_iter_addr(new_list) = (STRLEN) UV_MAX;
8698
8699     *get_invlist_previous_index_addr(new_list) = 0;
8700
8701     return new_list;
8702 }
8703
8704 SV*
8705 Perl__new_invlist_C_array(pTHX_ const UV* const list)
8706 {
8707     /* Return a pointer to a newly constructed inversion list, initialized to
8708      * point to <list>, which has to be in the exact correct inversion list
8709      * form, including internal fields.  Thus this is a dangerous routine that
8710      * should not be used in the wrong hands.  The passed in 'list' contains
8711      * several header fields at the beginning that are not part of the
8712      * inversion list body proper */
8713
8714     const STRLEN length = (STRLEN) list[0];
8715     const UV version_id =          list[1];
8716     const bool offset   =    cBOOL(list[2]);
8717 #define HEADER_LENGTH 3
8718     /* If any of the above changes in any way, you must change HEADER_LENGTH
8719      * (if appropriate) and regenerate INVLIST_VERSION_ID by running
8720      *      perl -E 'say int(rand 2**31-1)'
8721      */
8722 #define INVLIST_VERSION_ID 148565664 /* This is a combination of a version and
8723                                         data structure type, so that one being
8724                                         passed in can be validated to be an
8725                                         inversion list of the correct vintage.
8726                                        */
8727
8728     SV* invlist = newSV_type(SVt_INVLIST);
8729
8730     PERL_ARGS_ASSERT__NEW_INVLIST_C_ARRAY;
8731
8732     if (version_id != INVLIST_VERSION_ID) {
8733         Perl_croak(aTHX_ "panic: Incorrect version for previously generated inversion list");
8734     }
8735
8736     /* The generated array passed in includes header elements that aren't part
8737      * of the list proper, so start it just after them */
8738     SvPV_set(invlist, (char *) (list + HEADER_LENGTH));
8739
8740     SvLEN_set(invlist, 0);  /* Means we own the contents, and the system
8741                                shouldn't touch it */
8742
8743     *(get_invlist_offset_addr(invlist)) = offset;
8744
8745     /* The 'length' passed to us is the physical number of elements in the
8746      * inversion list.  But if there is an offset the logical number is one
8747      * less than that */
8748     invlist_set_len(invlist, length  - offset, offset);
8749
8750     invlist_set_previous_index(invlist, 0);
8751
8752     /* Initialize the iteration pointer. */
8753     invlist_iterfinish(invlist);
8754
8755     SvREADONLY_on(invlist);
8756
8757     return invlist;
8758 }
8759
8760 STATIC void
8761 S_invlist_extend(pTHX_ SV* const invlist, const UV new_max)
8762 {
8763     /* Grow the maximum size of an inversion list */
8764
8765     PERL_ARGS_ASSERT_INVLIST_EXTEND;
8766
8767     assert(SvTYPE(invlist) == SVt_INVLIST);
8768
8769     /* Add one to account for the zero element at the beginning which may not
8770      * be counted by the calling parameters */
8771     SvGROW((SV *)invlist, TO_INTERNAL_SIZE(new_max + 1));
8772 }
8773
8774 STATIC void
8775 S__append_range_to_invlist(pTHX_ SV* const invlist,
8776                                  const UV start, const UV end)
8777 {
8778    /* Subject to change or removal.  Append the range from 'start' to 'end' at
8779     * the end of the inversion list.  The range must be above any existing
8780     * ones. */
8781
8782     UV* array;
8783     UV max = invlist_max(invlist);
8784     UV len = _invlist_len(invlist);
8785     bool offset;
8786
8787     PERL_ARGS_ASSERT__APPEND_RANGE_TO_INVLIST;
8788
8789     if (len == 0) { /* Empty lists must be initialized */
8790         offset = start != 0;
8791         array = _invlist_array_init(invlist, ! offset);
8792     }
8793     else {
8794         /* Here, the existing list is non-empty. The current max entry in the
8795          * list is generally the first value not in the set, except when the
8796          * set extends to the end of permissible values, in which case it is
8797          * the first entry in that final set, and so this call is an attempt to
8798          * append out-of-order */
8799
8800         UV final_element = len - 1;
8801         array = invlist_array(invlist);
8802         if (   array[final_element] > start
8803             || ELEMENT_RANGE_MATCHES_INVLIST(final_element))
8804         {
8805             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",
8806                      array[final_element], start,
8807                      ELEMENT_RANGE_MATCHES_INVLIST(final_element) ? 't' : 'f');
8808         }
8809
8810         /* Here, it is a legal append.  If the new range begins 1 above the end
8811          * of the range below it, it is extending the range below it, so the
8812          * new first value not in the set is one greater than the newly
8813          * extended range.  */
8814         offset = *get_invlist_offset_addr(invlist);
8815         if (array[final_element] == start) {
8816             if (end != UV_MAX) {
8817                 array[final_element] = end + 1;
8818             }
8819             else {
8820                 /* But if the end is the maximum representable on the machine,
8821                  * assume that infinity was actually what was meant.  Just let
8822                  * the range that this would extend to have no end */
8823                 invlist_set_len(invlist, len - 1, offset);
8824             }
8825             return;
8826         }
8827     }
8828
8829     /* Here the new range doesn't extend any existing set.  Add it */
8830
8831     len += 2;   /* Includes an element each for the start and end of range */
8832
8833     /* If wll overflow the existing space, extend, which may cause the array to
8834      * be moved */
8835     if (max < len) {
8836         invlist_extend(invlist, len);
8837
8838         /* Have to set len here to avoid assert failure in invlist_array() */
8839         invlist_set_len(invlist, len, offset);
8840
8841         array = invlist_array(invlist);
8842     }
8843     else {
8844         invlist_set_len(invlist, len, offset);
8845     }
8846
8847     /* The next item on the list starts the range, the one after that is
8848      * one past the new range.  */
8849     array[len - 2] = start;
8850     if (end != UV_MAX) {
8851         array[len - 1] = end + 1;
8852     }
8853     else {
8854         /* But if the end is the maximum representable on the machine, just let
8855          * the range have no end */
8856         invlist_set_len(invlist, len - 1, offset);
8857     }
8858 }
8859
8860 SSize_t
8861 Perl__invlist_search(SV* const invlist, const UV cp)
8862 {
8863     /* Searches the inversion list for the entry that contains the input code
8864      * point <cp>.  If <cp> is not in the list, -1 is returned.  Otherwise, the
8865      * return value is the index into the list's array of the range that
8866      * contains <cp>, that is, 'i' such that
8867      *  array[i] <= cp < array[i+1]
8868      */
8869
8870     IV low = 0;
8871     IV mid;
8872     IV high = _invlist_len(invlist);
8873     const IV highest_element = high - 1;
8874     const UV* array;
8875
8876     PERL_ARGS_ASSERT__INVLIST_SEARCH;
8877
8878     /* If list is empty, return failure. */
8879     if (high == 0) {
8880         return -1;
8881     }
8882
8883     /* (We can't get the array unless we know the list is non-empty) */
8884     array = invlist_array(invlist);
8885
8886     mid = invlist_previous_index(invlist);
8887     assert(mid >=0);
8888     if (mid > highest_element) {
8889         mid = highest_element;
8890     }
8891
8892     /* <mid> contains the cache of the result of the previous call to this
8893      * function (0 the first time).  See if this call is for the same result,
8894      * or if it is for mid-1.  This is under the theory that calls to this
8895      * function will often be for related code points that are near each other.
8896      * And benchmarks show that caching gives better results.  We also test
8897      * here if the code point is within the bounds of the list.  These tests
8898      * replace others that would have had to be made anyway to make sure that
8899      * the array bounds were not exceeded, and these give us extra information
8900      * at the same time */
8901     if (cp >= array[mid]) {
8902         if (cp >= array[highest_element]) {
8903             return highest_element;
8904         }
8905
8906         /* Here, array[mid] <= cp < array[highest_element].  This means that
8907          * the final element is not the answer, so can exclude it; it also
8908          * means that <mid> is not the final element, so can refer to 'mid + 1'
8909          * safely */
8910         if (cp < array[mid + 1]) {
8911             return mid;
8912         }
8913         high--;
8914         low = mid + 1;
8915     }
8916     else { /* cp < aray[mid] */
8917         if (cp < array[0]) { /* Fail if outside the array */
8918             return -1;
8919         }
8920         high = mid;
8921         if (cp >= array[mid - 1]) {
8922             goto found_entry;
8923         }
8924     }
8925
8926     /* Binary search.  What we are looking for is <i> such that
8927      *  array[i] <= cp < array[i+1]
8928      * The loop below converges on the i+1.  Note that there may not be an
8929      * (i+1)th element in the array, and things work nonetheless */
8930     while (low < high) {
8931         mid = (low + high) / 2;
8932         assert(mid <= highest_element);
8933         if (array[mid] <= cp) { /* cp >= array[mid] */
8934             low = mid + 1;
8935
8936             /* We could do this extra test to exit the loop early.
8937             if (cp < array[low]) {
8938                 return mid;
8939             }
8940             */
8941         }
8942         else { /* cp < array[mid] */
8943             high = mid;
8944         }
8945     }
8946
8947   found_entry:
8948     high--;
8949     invlist_set_previous_index(invlist, high);
8950     return high;
8951 }
8952
8953 void
8954 Perl__invlist_populate_swatch(SV* const invlist,
8955                               const UV start, const UV end, U8* swatch)
8956 {
8957     /* populates a swatch of a swash the same way swatch_get() does in utf8.c,
8958      * but is used when the swash has an inversion list.  This makes this much
8959      * faster, as it uses a binary search instead of a linear one.  This is
8960      * intimately tied to that function, and perhaps should be in utf8.c,
8961      * except it is intimately tied to inversion lists as well.  It assumes
8962      * that <swatch> is all 0's on input */
8963
8964     UV current = start;
8965     const IV len = _invlist_len(invlist);
8966     IV i;
8967     const UV * array;
8968
8969     PERL_ARGS_ASSERT__INVLIST_POPULATE_SWATCH;
8970
8971     if (len == 0) { /* Empty inversion list */
8972         return;
8973     }
8974
8975     array = invlist_array(invlist);
8976
8977     /* Find which element it is */
8978     i = _invlist_search(invlist, start);
8979
8980     /* We populate from <start> to <end> */
8981     while (current < end) {
8982         UV upper;
8983
8984         /* The inversion list gives the results for every possible code point
8985          * after the first one in the list.  Only those ranges whose index is
8986          * even are ones that the inversion list matches.  For the odd ones,
8987          * and if the initial code point is not in the list, we have to skip
8988          * forward to the next element */
8989         if (i == -1 || ! ELEMENT_RANGE_MATCHES_INVLIST(i)) {
8990             i++;
8991             if (i >= len) { /* Finished if beyond the end of the array */
8992                 return;
8993             }
8994             current = array[i];
8995             if (current >= end) {   /* Finished if beyond the end of what we
8996                                        are populating */
8997                 if (LIKELY(end < UV_MAX)) {
8998                     return;
8999                 }
9000
9001                 /* We get here when the upper bound is the maximum
9002                  * representable on the machine, and we are looking for just
9003                  * that code point.  Have to special case it */
9004                 i = len;
9005                 goto join_end_of_list;
9006             }
9007         }
9008         assert(current >= start);
9009
9010         /* The current range ends one below the next one, except don't go past
9011          * <end> */
9012         i++;
9013         upper = (i < len && array[i] < end) ? array[i] : end;
9014
9015         /* Here we are in a range that matches.  Populate a bit in the 3-bit U8
9016          * for each code point in it */
9017         for (; current < upper; current++) {
9018             const STRLEN offset = (STRLEN)(current - start);
9019             swatch[offset >> 3] |= 1 << (offset & 7);
9020         }
9021
9022       join_end_of_list:
9023
9024         /* Quit if at the end of the list */
9025         if (i >= len) {
9026
9027             /* But first, have to deal with the highest possible code point on
9028              * the platform.  The previous code assumes that <end> is one
9029              * beyond where we want to populate, but that is impossible at the
9030              * platform's infinity, so have to handle it specially */
9031             if (UNLIKELY(end == UV_MAX && ELEMENT_RANGE_MATCHES_INVLIST(len-1)))
9032             {
9033                 const STRLEN offset = (STRLEN)(end - start);
9034                 swatch[offset >> 3] |= 1 << (offset & 7);
9035             }
9036             return;
9037         }
9038
9039         /* Advance to the next range, which will be for code points not in the
9040          * inversion list */
9041         current = array[i];
9042     }
9043
9044     return;
9045 }
9046
9047 void
9048 Perl__invlist_union_maybe_complement_2nd(pTHX_ SV* const a, SV* const b,
9049                                          const bool complement_b, SV** output)
9050 {
9051     /* Take the union of two inversion lists and point '*output' to it.  On
9052      * input, '*output' MUST POINT TO NULL OR TO AN SV* INVERSION LIST (possibly
9053      * even 'a' or 'b').  If to an inversion list, the contents of the original
9054      * list will be replaced by the union.  The first list, 'a', may be
9055      * NULL, in which case a copy of the second list is placed in '*output'.
9056      * If 'complement_b' is TRUE, the union is taken of the complement
9057      * (inversion) of 'b' instead of b itself.
9058      *
9059      * The basis for this comes from "Unicode Demystified" Chapter 13 by
9060      * Richard Gillam, published by Addison-Wesley, and explained at some
9061      * length there.  The preface says to incorporate its examples into your
9062      * code at your own risk.
9063      *
9064      * The algorithm is like a merge sort. */
9065
9066     const UV* array_a;    /* a's array */
9067     const UV* array_b;
9068     UV len_a;       /* length of a's array */
9069     UV len_b;
9070
9071     SV* u;                      /* the resulting union */
9072     UV* array_u;
9073     UV len_u = 0;
9074
9075     UV i_a = 0;             /* current index into a's array */
9076     UV i_b = 0;
9077     UV i_u = 0;
9078
9079     /* running count, as explained in the algorithm source book; items are
9080      * stopped accumulating and are output when the count changes to/from 0.
9081      * The count is incremented when we start a range that's in an input's set,
9082      * and decremented when we start a range that's not in a set.  So this
9083      * variable can be 0, 1, or 2.  When it is 0 neither input is in their set,
9084      * and hence nothing goes into the union; 1, just one of the inputs is in
9085      * its set (and its current range gets added to the union); and 2 when both
9086      * inputs are in their sets.  */
9087     UV count = 0;
9088
9089     PERL_ARGS_ASSERT__INVLIST_UNION_MAYBE_COMPLEMENT_2ND;
9090     assert(a != b);
9091     assert(*output == NULL || SvTYPE(*output) == SVt_INVLIST);
9092
9093     len_b = _invlist_len(b);
9094     if (len_b == 0) {
9095
9096         /* Here, 'b' is empty, hence it's complement is all possible code
9097          * points.  So if the union includes the complement of 'b', it includes
9098          * everything, and we need not even look at 'a'.  It's easiest to
9099          * create a new inversion list that matches everything.  */
9100         if (complement_b) {
9101             SV* everything = _add_range_to_invlist(NULL, 0, UV_MAX);
9102
9103             if (*output == NULL) { /* If the output didn't exist, just point it
9104                                       at the new list */
9105                 *output = everything;
9106             }
9107             else { /* Otherwise, replace its contents with the new list */
9108                 invlist_replace_list_destroys_src(*output, everything);
9109                 SvREFCNT_dec_NN(everything);
9110             }
9111
9112             return;
9113         }
9114
9115         /* Here, we don't want the complement of 'b', and since 'b' is empty,
9116          * the union will come entirely from 'a'.  If 'a' is NULL or empty, the
9117          * output will be empty */
9118
9119         if (a == NULL || _invlist_len(a) == 0) {
9120             if (*output == NULL) {
9121                 *output = _new_invlist(0);
9122             }
9123             else {
9124                 invlist_clear(*output);
9125             }
9126             return;
9127         }
9128
9129         /* Here, 'a' is not empty, but 'b' is, so 'a' entirely determines the
9130          * union.  We can just return a copy of 'a' if '*output' doesn't point
9131          * to an existing list */
9132         if (*output == NULL) {
9133             *output = invlist_clone(a);
9134             return;
9135         }
9136
9137         /* If the output is to overwrite 'a', we have a no-op, as it's
9138          * already in 'a' */
9139         if (*output == a) {
9140             return;
9141         }
9142
9143         /* Here, '*output' is to be overwritten by 'a' */
9144         u = invlist_clone(a);
9145         invlist_replace_list_destroys_src(*output, u);
9146         SvREFCNT_dec_NN(u);
9147
9148         return;
9149     }
9150
9151     /* Here 'b' is not empty.  See about 'a' */
9152
9153     if (a == NULL || ((len_a = _invlist_len(a)) == 0)) {
9154
9155         /* Here, 'a' is empty (and b is not).  That means the union will come
9156          * entirely from 'b'.  If '*output' is NULL, we can directly return a
9157          * clone of 'b'.  Otherwise, we replace the contents of '*output' with
9158          * the clone */
9159
9160         SV ** dest = (*output == NULL) ? output : &u;
9161         *dest = invlist_clone(b);
9162         if (complement_b) {
9163             _invlist_invert(*dest);
9164         }
9165
9166         if (dest == &u) {
9167             invlist_replace_list_destroys_src(*output, u);
9168             SvREFCNT_dec_NN(u);
9169         }
9170
9171         return;
9172     }
9173
9174     /* Here both lists exist and are non-empty */
9175     array_a = invlist_array(a);
9176     array_b = invlist_array(b);
9177
9178     /* If are to take the union of 'a' with the complement of b, set it
9179      * up so are looking at b's complement. */
9180     if (complement_b) {
9181
9182         /* To complement, we invert: if the first element is 0, remove it.  To
9183          * do this, we just pretend the array starts one later */
9184         if (array_b[0] == 0) {
9185             array_b++;
9186             len_b--;
9187         }
9188         else {
9189
9190             /* But if the first element is not zero, we pretend the list starts
9191              * at the 0 that is always stored immediately before the array. */
9192             array_b--;
9193             len_b++;
9194         }
9195     }
9196
9197     /* Size the union for the worst case: that the sets are completely
9198      * disjoint */
9199     u = _new_invlist(len_a + len_b);
9200
9201     /* Will contain U+0000 if either component does */
9202     array_u = _invlist_array_init(u, (    len_a > 0 && array_a[0] == 0)
9203                                       || (len_b > 0 && array_b[0] == 0));
9204
9205     /* Go through each input list item by item, stopping when have exhausted
9206      * one of them */
9207     while (i_a < len_a && i_b < len_b) {
9208         UV cp;      /* The element to potentially add to the union's array */
9209         bool cp_in_set;   /* is it in the the input list's set or not */
9210
9211         /* We need to take one or the other of the two inputs for the union.
9212          * Since we are merging two sorted lists, we take the smaller of the
9213          * next items.  In case of a tie, we take first the one that is in its
9214          * set.  If we first took the one not in its set, it would decrement
9215          * the count, possibly to 0 which would cause it to be output as ending
9216          * the range, and the next time through we would take the same number,
9217          * and output it again as beginning the next range.  By doing it the
9218          * opposite way, there is no possibility that the count will be
9219          * momentarily decremented to 0, and thus the two adjoining ranges will
9220          * be seamlessly merged.  (In a tie and both are in the set or both not
9221          * in the set, it doesn't matter which we take first.) */
9222         if (       array_a[i_a] < array_b[i_b]
9223             || (   array_a[i_a] == array_b[i_b]
9224                 && ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
9225         {
9226             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
9227             cp = array_a[i_a++];
9228         }
9229         else {
9230             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
9231             cp = array_b[i_b++];
9232         }
9233
9234         /* Here, have chosen which of the two inputs to look at.  Only output
9235          * if the running count changes to/from 0, which marks the
9236          * beginning/end of a range that's in the set */
9237         if (cp_in_set) {
9238             if (count == 0) {
9239                 array_u[i_u++] = cp;
9240             }
9241             count++;
9242         }
9243         else {
9244             count--;
9245             if (count == 0) {
9246                 array_u[i_u++] = cp;
9247             }
9248         }
9249     }
9250
9251
9252     /* The loop above increments the index into exactly one of the input lists
9253      * each iteration, and ends when either index gets to its list end.  That
9254      * means the other index is lower than its end, and so something is
9255      * remaining in that one.  We decrement 'count', as explained below, if
9256      * that list is in its set.  (i_a and i_b each currently index the element
9257      * beyond the one we care about.) */
9258     if (   (i_a != len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
9259         || (i_b != len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
9260     {
9261         count--;
9262     }
9263
9264     /* Above we decremented 'count' if the list that had unexamined elements in
9265      * it was in its set.  This has made it so that 'count' being non-zero
9266      * means there isn't anything left to output; and 'count' equal to 0 means
9267      * that what is left to output is precisely that which is left in the
9268      * non-exhausted input list.
9269      *
9270      * To see why, note first that the exhausted input obviously has nothing
9271      * left to add to the union.  If it was in its set at its end, that means
9272      * the set extends from here to the platform's infinity, and hence so does
9273      * the union and the non-exhausted set is irrelevant.  The exhausted set
9274      * also contributed 1 to 'count'.  If 'count' was 2, it got decremented to
9275      * 1, but if it was 1, the non-exhausted set wasn't in its set, and so
9276      * 'count' remains at 1.  This is consistent with the decremented 'count'
9277      * != 0 meaning there's nothing left to add to the union.
9278      *
9279      * But if the exhausted input wasn't in its set, it contributed 0 to
9280      * 'count', and the rest of the union will be whatever the other input is.
9281      * If 'count' was 0, neither list was in its set, and 'count' remains 0;
9282      * otherwise it gets decremented to 0.  This is consistent with 'count'
9283      * == 0 meaning the remainder of the union is whatever is left in the
9284      * non-exhausted list. */
9285     if (count != 0) {
9286         len_u = i_u;
9287     }
9288     else {
9289         IV copy_count = len_a - i_a;
9290         if (copy_count > 0) {   /* The non-exhausted input is 'a' */
9291             Copy(array_a + i_a, array_u + i_u, copy_count, UV);
9292         }
9293         else { /* The non-exhausted input is b */
9294             copy_count = len_b - i_b;
9295             Copy(array_b + i_b, array_u + i_u, copy_count, UV);
9296         }
9297         len_u = i_u + copy_count;
9298     }
9299
9300     /* Set the result to the final length, which can change the pointer to
9301      * array_u, so re-find it.  (Note that it is unlikely that this will
9302      * change, as we are shrinking the space, not enlarging it) */
9303     if (len_u != _invlist_len(u)) {
9304         invlist_set_len(u, len_u, *get_invlist_offset_addr(u));
9305         invlist_trim(u);
9306         array_u = invlist_array(u);
9307     }
9308
9309     if (*output == NULL) {  /* Simply return the new inversion list */
9310         *output = u;
9311     }
9312     else {
9313         /* Otherwise, overwrite the inversion list that was in '*output'.  We
9314          * could instead free '*output', and then set it to 'u', but experience
9315          * has shown [perl #127392] that if the input is a mortal, we can get a
9316          * huge build-up of these during regex compilation before they get
9317          * freed. */
9318         invlist_replace_list_destroys_src(*output, u);
9319         SvREFCNT_dec_NN(u);
9320     }
9321
9322     return;
9323 }
9324
9325 void
9326 Perl__invlist_intersection_maybe_complement_2nd(pTHX_ SV* const a, SV* const b,
9327                                                const bool complement_b, SV** i)
9328 {
9329     /* Take the intersection of two inversion lists and point '*i' to it.  On
9330      * input, '*i' MUST POINT TO NULL OR TO AN SV* INVERSION LIST (possibly
9331      * even 'a' or 'b').  If to an inversion list, the contents of the original
9332      * list will be replaced by the intersection.  The first list, 'a', may be
9333      * NULL, in which case '*i' will be an empty list.  If 'complement_b' is
9334      * TRUE, the result will be the intersection of 'a' and the complement (or
9335      * inversion) of 'b' instead of 'b' directly.
9336      *
9337      * The basis for this comes from "Unicode Demystified" Chapter 13 by
9338      * Richard Gillam, published by Addison-Wesley, and explained at some
9339      * length there.  The preface says to incorporate its examples into your
9340      * code at your own risk.  In fact, it had bugs
9341      *
9342      * The algorithm is like a merge sort, and is essentially the same as the
9343      * union above
9344      */
9345
9346     const UV* array_a;          /* a's array */
9347     const UV* array_b;
9348     UV len_a;   /* length of a's array */
9349     UV len_b;
9350
9351     SV* r;                   /* the resulting intersection */
9352     UV* array_r;
9353     UV len_r = 0;
9354
9355     UV i_a = 0;             /* current index into a's array */
9356     UV i_b = 0;
9357     UV i_r = 0;
9358
9359     /* running count of how many of the two inputs are postitioned at ranges
9360      * that are in their sets.  As explained in the algorithm source book,
9361      * items are stopped accumulating and are output when the count changes
9362      * to/from 2.  The count is incremented when we start a range that's in an
9363      * input's set, and decremented when we start a range that's not in a set.
9364      * Only when it is 2 are we in the intersection. */
9365     UV count = 0;
9366
9367     PERL_ARGS_ASSERT__INVLIST_INTERSECTION_MAYBE_COMPLEMENT_2ND;
9368     assert(a != b);
9369     assert(*i == NULL || SvTYPE(*i) == SVt_INVLIST);
9370
9371     /* Special case if either one is empty */
9372     len_a = (a == NULL) ? 0 : _invlist_len(a);
9373     if ((len_a == 0) || ((len_b = _invlist_len(b)) == 0)) {
9374         if (len_a != 0 && complement_b) {
9375
9376             /* Here, 'a' is not empty, therefore from the enclosing 'if', 'b'
9377              * must be empty.  Here, also we are using 'b's complement, which
9378              * hence must be every possible code point.  Thus the intersection
9379              * is simply 'a'. */
9380
9381             if (*i == a) {  /* No-op */
9382                 return;
9383             }
9384
9385             if (*i == NULL) {
9386                 *i = invlist_clone(a);
9387                 return;
9388             }
9389
9390             r = invlist_clone(a);
9391             invlist_replace_list_destroys_src(*i, r);
9392             SvREFCNT_dec_NN(r);
9393             return;
9394         }
9395
9396         /* Here, 'a' or 'b' is empty and not using the complement of 'b'.  The
9397          * intersection must be empty */
9398         if (*i == NULL) {
9399             *i = _new_invlist(0);
9400             return;
9401         }
9402
9403         invlist_clear(*i);
9404         return;
9405     }
9406
9407     /* Here both lists exist and are non-empty */
9408     array_a = invlist_array(a);
9409     array_b = invlist_array(b);
9410
9411     /* If are to take the intersection of 'a' with the complement of b, set it
9412      * up so are looking at b's complement. */
9413     if (complement_b) {
9414
9415         /* To complement, we invert: if the first element is 0, remove it.  To
9416          * do this, we just pretend the array starts one later */
9417         if (array_b[0] == 0) {
9418             array_b++;
9419             len_b--;
9420         }
9421         else {
9422
9423             /* But if the first element is not zero, we pretend the list starts
9424              * at the 0 that is always stored immediately before the array. */
9425             array_b--;
9426             len_b++;
9427         }
9428     }
9429
9430     /* Size the intersection for the worst case: that the intersection ends up
9431      * fragmenting everything to be completely disjoint */
9432     r= _new_invlist(len_a + len_b);
9433
9434     /* Will contain U+0000 iff both components do */
9435     array_r = _invlist_array_init(r,    len_a > 0 && array_a[0] == 0
9436                                      && len_b > 0 && array_b[0] == 0);
9437
9438     /* Go through each list item by item, stopping when have exhausted one of
9439      * them */
9440     while (i_a < len_a && i_b < len_b) {
9441         UV cp;      /* The element to potentially add to the intersection's
9442                        array */
9443         bool cp_in_set; /* Is it in the input list's set or not */
9444
9445         /* We need to take one or the other of the two inputs for the
9446          * intersection.  Since we are merging two sorted lists, we take the
9447          * smaller of the next items.  In case of a tie, we take first the one
9448          * that is not in its set (a difference from the union algorithm).  If
9449          * we first took the one in its set, it would increment the count,
9450          * possibly to 2 which would cause it to be output as starting a range
9451          * in the intersection, and the next time through we would take that
9452          * same number, and output it again as ending the set.  By doing the
9453          * opposite of this, there is no possibility that the count will be
9454          * momentarily incremented to 2.  (In a tie and both are in the set or
9455          * both not in the set, it doesn't matter which we take first.) */
9456         if (       array_a[i_a] < array_b[i_b]
9457             || (   array_a[i_a] == array_b[i_b]
9458                 && ! ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
9459         {
9460             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
9461             cp = array_a[i_a++];
9462         }
9463         else {
9464             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
9465             cp= array_b[i_b++];
9466         }
9467
9468         /* Here, have chosen which of the two inputs to look at.  Only output
9469          * if the running count changes to/from 2, which marks the
9470          * beginning/end of a range that's in the intersection */
9471         if (cp_in_set) {
9472             count++;
9473             if (count == 2) {
9474                 array_r[i_r++] = cp;
9475             }
9476         }
9477         else {
9478             if (count == 2) {
9479                 array_r[i_r++] = cp;
9480             }
9481             count--;
9482         }
9483
9484     }
9485
9486     /* The loop above increments the index into exactly one of the input lists
9487      * each iteration, and ends when either index gets to its list end.  That
9488      * means the other index is lower than its end, and so something is
9489      * remaining in that one.  We increment 'count', as explained below, if the
9490      * exhausted list was in its set.  (i_a and i_b each currently index the
9491      * element beyond the one we care about.) */
9492     if (   (i_a == len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
9493         || (i_b == len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
9494     {
9495         count++;
9496     }
9497
9498     /* Above we incremented 'count' if the exhausted list was in its set.  This
9499      * has made it so that 'count' being below 2 means there is nothing left to
9500      * output; otheriwse what's left to add to the intersection is precisely
9501      * that which is left in the non-exhausted input list.
9502      *
9503      * To see why, note first that the exhausted input obviously has nothing
9504      * left to affect the intersection.  If it was in its set at its end, that
9505      * means the set extends from here to the platform's infinity, and hence
9506      * anything in the non-exhausted's list will be in the intersection, and
9507      * anything not in it won't be.  Hence, the rest of the intersection is
9508      * precisely what's in the non-exhausted list  The exhausted set also
9509      * contributed 1 to 'count', meaning 'count' was at least 1.  Incrementing
9510      * it means 'count' is now at least 2.  This is consistent with the
9511      * incremented 'count' being >= 2 means to add the non-exhausted list to
9512      * the intersection.
9513      *
9514      * But if the exhausted input wasn't in its set, it contributed 0 to
9515      * 'count', and the intersection can't include anything further; the
9516      * non-exhausted set is irrelevant.  'count' was at most 1, and doesn't get
9517      * incremented.  This is consistent with 'count' being < 2 meaning nothing
9518      * further to add to the intersection. */
9519     if (count < 2) { /* Nothing left to put in the intersection. */
9520         len_r = i_r;
9521     }
9522     else { /* copy the non-exhausted list, unchanged. */
9523         IV copy_count = len_a - i_a;
9524         if (copy_count > 0) {   /* a is the one with stuff left */
9525             Copy(array_a + i_a, array_r + i_r, copy_count, UV);
9526         }
9527         else {  /* b is the one with stuff left */
9528             copy_count = len_b - i_b;
9529             Copy(array_b + i_b, array_r + i_r, copy_count, UV);
9530         }
9531         len_r = i_r + copy_count;
9532     }
9533
9534     /* Set the result to the final length, which can change the pointer to
9535      * array_r, so re-find it.  (Note that it is unlikely that this will
9536      * change, as we are shrinking the space, not enlarging it) */
9537     if (len_r != _invlist_len(r)) {
9538         invlist_set_len(r, len_r, *get_invlist_offset_addr(r));
9539         invlist_trim(r);
9540         array_r = invlist_array(r);
9541     }
9542
9543     if (*i == NULL) { /* Simply return the calculated intersection */
9544         *i = r;
9545     }
9546     else { /* Otherwise, replace the existing inversion list in '*i'.  We could
9547               instead free '*i', and then set it to 'r', but experience has
9548               shown [perl #127392] that if the input is a mortal, we can get a
9549               huge build-up of these during regex compilation before they get
9550               freed. */
9551         if (len_r) {
9552             invlist_replace_list_destroys_src(*i, r);
9553         }
9554         else {
9555             invlist_clear(*i);
9556         }
9557         SvREFCNT_dec_NN(r);
9558     }
9559
9560     return;
9561 }
9562
9563 SV*
9564 Perl__add_range_to_invlist(pTHX_ SV* invlist, UV start, UV end)
9565 {
9566     /* Add the range from 'start' to 'end' inclusive to the inversion list's
9567      * set.  A pointer to the inversion list is returned.  This may actually be
9568      * a new list, in which case the passed in one has been destroyed.  The
9569      * passed-in inversion list can be NULL, in which case a new one is created
9570      * with just the one range in it.  The new list is not necessarily
9571      * NUL-terminated.  Space is not freed if the inversion list shrinks as a
9572      * result of this function.  The gain would not be large, and in many
9573      * cases, this is called multiple times on a single inversion list, so
9574      * anything freed may almost immediately be needed again.
9575      *
9576      * This used to mostly call the 'union' routine, but that is much more
9577      * heavyweight than really needed for a single range addition */
9578
9579     UV* array;              /* The array implementing the inversion list */
9580     UV len;                 /* How many elements in 'array' */
9581     SSize_t i_s;            /* index into the invlist array where 'start'
9582                                should go */
9583     SSize_t i_e = 0;        /* And the index where 'end' should go */
9584     UV cur_highest;         /* The highest code point in the inversion list
9585                                upon entry to this function */
9586
9587     /* This range becomes the whole inversion list if none already existed */
9588     if (invlist == NULL) {
9589         invlist = _new_invlist(2);
9590         _append_range_to_invlist(invlist, start, end);
9591         return invlist;
9592     }
9593
9594     /* Likewise, if the inversion list is currently empty */
9595     len = _invlist_len(invlist);
9596     if (len == 0) {
9597         _append_range_to_invlist(invlist, start, end);
9598         return invlist;
9599     }
9600
9601     /* Starting here, we have to know the internals of the list */
9602     array = invlist_array(invlist);
9603
9604     /* If the new range ends higher than the current highest ... */
9605     cur_highest = invlist_highest(invlist);
9606     if (end > cur_highest) {
9607
9608         /* If the whole range is higher, we can just append it */
9609         if (start > cur_highest) {
9610             _append_range_to_invlist(invlist, start, end);
9611             return invlist;
9612         }
9613
9614         /* Otherwise, add the portion that is higher ... */
9615         _append_range_to_invlist(invlist, cur_highest + 1, end);
9616
9617         /* ... and continue on below to handle the rest.  As a result of the
9618          * above append, we know that the index of the end of the range is the
9619          * final even numbered one of the array.  Recall that the final element
9620          * always starts a range that extends to infinity.  If that range is in
9621          * the set (meaning the set goes from here to infinity), it will be an
9622          * even index, but if it isn't in the set, it's odd, and the final
9623          * range in the set is one less, which is even. */
9624         if (end == UV_MAX) {
9625             i_e = len;
9626         }
9627         else {
9628             i_e = len - 2;
9629         }
9630     }
9631
9632     /* We have dealt with appending, now see about prepending.  If the new
9633      * range starts lower than the current lowest ... */
9634     if (start < array[0]) {
9635
9636         /* Adding something which has 0 in it is somewhat tricky, and uncommon.
9637          * Let the union code handle it, rather than having to know the
9638          * trickiness in two code places.  */
9639         if (UNLIKELY(start == 0)) {
9640             SV* range_invlist;
9641
9642             range_invlist = _new_invlist(2);
9643             _append_range_to_invlist(range_invlist, start, end);
9644
9645             _invlist_union(invlist, range_invlist, &invlist);
9646
9647             SvREFCNT_dec_NN(range_invlist);
9648
9649             return invlist;
9650         }
9651
9652         /* If the whole new range comes before the first entry, and doesn't
9653          * extend it, we have to insert it as an additional range */
9654         if (end < array[0] - 1) {
9655             i_s = i_e = -1;
9656             goto splice_in_new_range;
9657         }
9658
9659         /* Here the new range adjoins the existing first range, extending it
9660          * downwards. */
9661         array[0] = start;
9662
9663         /* And continue on below to handle the rest.  We know that the index of
9664          * the beginning of the range is the first one of the array */
9665         i_s = 0;
9666     }
9667     else { /* Not prepending any part of the new range to the existing list.
9668             * Find where in the list it should go.  This finds i_s, such that:
9669             *     invlist[i_s] <= start < array[i_s+1]
9670             */
9671         i_s = _invlist_search(invlist, start);
9672     }
9673
9674     /* At this point, any extending before the beginning of the inversion list
9675      * and/or after the end has been done.  This has made it so that, in the
9676      * code below, each endpoint of the new range is either in a range that is
9677      * in the set, or is in a gap between two ranges that are.  This means we
9678      * don't have to worry about exceeding the array bounds.
9679      *
9680      * Find where in the list the new range ends (but we can skip this if we
9681      * have already determined what it is, or if it will be the same as i_s,
9682      * which we already have computed) */
9683     if (i_e == 0) {
9684         i_e = (start == end)
9685               ? i_s
9686               : _invlist_search(invlist, end);
9687     }
9688
9689     /* Here generally invlist[i_e] <= end < array[i_e+1].  But if invlist[i_e]
9690      * is a range that goes to infinity there is no element at invlist[i_e+1],
9691      * so only the first relation holds. */
9692
9693     if ( ! ELEMENT_RANGE_MATCHES_INVLIST(i_s)) {
9694
9695         /* Here, the ranges on either side of the beginning of the new range
9696          * are in the set, and this range starts in the gap between them.
9697          *
9698          * The new range extends the range above it downwards if the new range
9699          * ends at or above that range's start */
9700         const bool extends_the_range_above = (   end == UV_MAX
9701                                               || end + 1 >= array[i_s+1]);
9702
9703         /* The new range extends the range below it upwards if it begins just
9704          * after where that range ends */
9705         if (start == array[i_s]) {
9706
9707             /* If the new range fills the entire gap between the other ranges,
9708              * they will get merged together.  Other ranges may also get
9709              * merged, depending on how many of them the new range spans.  In
9710              * the general case, we do the merge later, just once, after we
9711              * figure out how many to merge.  But in the case where the new
9712              * range exactly spans just this one gap (possibly extending into
9713              * the one above), we do the merge here, and an early exit.  This
9714              * is done here to avoid having to special case later. */
9715             if (i_e - i_s <= 1) {
9716
9717                 /* If i_e - i_s == 1, it means that the new range terminates
9718                  * within the range above, and hence 'extends_the_range_above'
9719                  * must be true.  (If the range above it extends to infinity,
9720                  * 'i_s+2' will be above the array's limit, but 'len-i_s-2'
9721                  * will be 0, so no harm done.) */
9722                 if (extends_the_range_above) {
9723                     Move(array + i_s + 2, array + i_s, len - i_s - 2, UV);
9724                     invlist_set_len(invlist,
9725                                     len - 2,
9726                                     *(get_invlist_offset_addr(invlist)));
9727                     return invlist;
9728                 }
9729
9730                 /* Here, i_e must == i_s.  We keep them in sync, as they apply
9731                  * to the same range, and below we are about to decrement i_s
9732                  * */
9733                 i_e--;
9734             }
9735
9736             /* Here, the new range is adjacent to the one below.  (It may also
9737              * span beyond the range above, but that will get resolved later.)
9738              * Extend the range below to include this one. */
9739             array[i_s] = (end == UV_MAX) ? UV_MAX : end + 1;
9740             i_s--;
9741             start = array[i_s];
9742         }
9743         else if (extends_the_range_above) {
9744
9745             /* Here the new range only extends the range above it, but not the
9746              * one below.  It merges with the one above.  Again, we keep i_e
9747              * and i_s in sync if they point to the same range */
9748             if (i_e == i_s) {
9749                 i_e++;
9750             }
9751             i_s++;
9752             array[i_s] = start;
9753         }
9754     }
9755
9756     /* Here, we've dealt with the new range start extending any adjoining
9757      * existing ranges.
9758      *
9759      * If the new range extends to infinity, it is now the final one,
9760      * regardless of what was there before */
9761     if (UNLIKELY(end == UV_MAX)) {
9762         invlist_set_len(invlist, i_s + 1, *(get_invlist_offset_addr(invlist)));
9763         return invlist;
9764     }
9765
9766     /* If i_e started as == i_s, it has also been dealt with,
9767      * and been updated to the new i_s, which will fail the following if */
9768     if (! ELEMENT_RANGE_MATCHES_INVLIST(i_e)) {
9769
9770         /* Here, the ranges on either side of the end of the new range are in
9771          * the set, and this range ends in the gap between them.
9772          *
9773          * If this range is adjacent to (hence extends) the range above it, it
9774          * becomes part of that range; likewise if it extends the range below,
9775          * it becomes part of that range */
9776         if (end + 1 == array[i_e+1]) {
9777             i_e++;
9778             array[i_e] = start;
9779         }
9780         else if (start <= array[i_e]) {
9781             array[i_e] = end + 1;
9782             i_e--;
9783         }
9784     }
9785
9786     if (i_s == i_e) {
9787
9788         /* If the range fits entirely in an existing range (as possibly already
9789          * extended above), it doesn't add anything new */
9790         if (ELEMENT_RANGE_MATCHES_INVLIST(i_s)) {
9791             return invlist;
9792         }
9793
9794         /* Here, no part of the range is in the list.  Must add it.  It will
9795          * occupy 2 more slots */
9796       splice_in_new_range:
9797
9798         invlist_extend(invlist, len + 2);
9799         array = invlist_array(invlist);
9800         /* Move the rest of the array down two slots. Don't include any
9801          * trailing NUL */
9802         Move(array + i_e + 1, array + i_e + 3, len - i_e - 1, UV);
9803
9804         /* Do the actual splice */
9805         array[i_e+1] = start;
9806         array[i_e+2] = end + 1;
9807         invlist_set_len(invlist, len + 2, *(get_invlist_offset_addr(invlist)));
9808         return invlist;
9809     }
9810
9811     /* Here the new range crossed the boundaries of a pre-existing range.  The
9812      * code above has adjusted things so that both ends are in ranges that are
9813      * in the set.  This means everything in between must also be in the set.
9814      * Just squash things together */
9815     Move(array + i_e + 1, array + i_s + 1, len - i_e - 1, UV);
9816     invlist_set_len(invlist,
9817                     len - i_e + i_s,
9818                     *(get_invlist_offset_addr(invlist)));
9819
9820     return invlist;
9821 }
9822
9823 SV*
9824 Perl__setup_canned_invlist(pTHX_ const STRLEN size, const UV element0,
9825                                  UV** other_elements_ptr)
9826 {
9827     /* Create and return an inversion list whose contents are to be populated
9828      * by the caller.  The caller gives the number of elements (in 'size') and
9829      * the very first element ('element0').  This function will set
9830      * '*other_elements_ptr' to an array of UVs, where the remaining elements
9831      * are to be placed.
9832      *
9833      * Obviously there is some trust involved that the caller will properly
9834      * fill in the other elements of the array.
9835      *
9836      * (The first element needs to be passed in, as the underlying code does
9837      * things differently depending on whether it is zero or non-zero) */
9838
9839     SV* invlist = _new_invlist(size);
9840     bool offset;
9841
9842     PERL_ARGS_ASSERT__SETUP_CANNED_INVLIST;
9843
9844     invlist = add_cp_to_invlist(invlist, element0);
9845     offset = *get_invlist_offset_addr(invlist);
9846
9847     invlist_set_len(invlist, size, offset);
9848     *other_elements_ptr = invlist_array(invlist) + 1;
9849     return invlist;
9850 }
9851
9852 #endif
9853
9854 PERL_STATIC_INLINE SV*
9855 S_add_cp_to_invlist(pTHX_ SV* invlist, const UV cp) {
9856     return _add_range_to_invlist(invlist, cp, cp);
9857 }
9858
9859 #ifndef PERL_IN_XSUB_RE
9860 void
9861 Perl__invlist_invert(pTHX_ SV* const invlist)
9862 {
9863     /* Complement the input inversion list.  This adds a 0 if the list didn't
9864      * have a zero; removes it otherwise.  As described above, the data
9865      * structure is set up so that this is very efficient */
9866
9867     PERL_ARGS_ASSERT__INVLIST_INVERT;
9868
9869     assert(! invlist_is_iterating(invlist));
9870
9871     /* The inverse of matching nothing is matching everything */
9872     if (_invlist_len(invlist) == 0) {
9873         _append_range_to_invlist(invlist, 0, UV_MAX);
9874         return;
9875     }
9876
9877     *get_invlist_offset_addr(invlist) = ! *get_invlist_offset_addr(invlist);
9878 }
9879
9880 #endif
9881
9882 PERL_STATIC_INLINE SV*
9883 S_invlist_clone(pTHX_ SV* const invlist)
9884 {
9885
9886     /* Return a new inversion list that is a copy of the input one, which is
9887      * unchanged.  The new list will not be mortal even if the old one was. */
9888
9889     /* Need to allocate extra space to accommodate Perl's addition of a
9890      * trailing NUL to SvPV's, since it thinks they are always strings */
9891     SV* new_invlist = _new_invlist(_invlist_len(invlist) + 1);
9892     STRLEN physical_length = SvCUR(invlist);
9893     bool offset = *(get_invlist_offset_addr(invlist));
9894
9895     PERL_ARGS_ASSERT_INVLIST_CLONE;
9896
9897     *(get_invlist_offset_addr(new_invlist)) = offset;
9898     invlist_set_len(new_invlist, _invlist_len(invlist), offset);
9899     Copy(SvPVX(invlist), SvPVX(new_invlist), physical_length, char);
9900
9901     return new_invlist;
9902 }
9903
9904 PERL_STATIC_INLINE STRLEN*
9905 S_get_invlist_iter_addr(SV* invlist)
9906 {
9907     /* Return the address of the UV that contains the current iteration
9908      * position */
9909
9910     PERL_ARGS_ASSERT_GET_INVLIST_ITER_ADDR;
9911
9912     assert(SvTYPE(invlist) == SVt_INVLIST);
9913
9914     return &(((XINVLIST*) SvANY(invlist))->iterator);
9915 }
9916
9917 PERL_STATIC_INLINE void
9918 S_invlist_iterinit(SV* invlist) /* Initialize iterator for invlist */
9919 {
9920     PERL_ARGS_ASSERT_INVLIST_ITERINIT;
9921
9922     *get_invlist_iter_addr(invlist) = 0;
9923 }
9924
9925 PERL_STATIC_INLINE void
9926 S_invlist_iterfinish(SV* invlist)
9927 {
9928     /* Terminate iterator for invlist.  This is to catch development errors.
9929      * Any iteration that is interrupted before completed should call this
9930      * function.  Functions that add code points anywhere else but to the end
9931      * of an inversion list assert that they are not in the middle of an
9932      * iteration.  If they were, the addition would make the iteration
9933      * problematical: if the iteration hadn't reached the place where things
9934      * were being added, it would be ok */
9935
9936     PERL_ARGS_ASSERT_INVLIST_ITERFINISH;
9937
9938     *get_invlist_iter_addr(invlist) = (STRLEN) UV_MAX;
9939 }
9940
9941 STATIC bool
9942 S_invlist_iternext(SV* invlist, UV* start, UV* end)
9943 {
9944     /* An C<invlist_iterinit> call on <invlist> must be used to set this up.
9945      * This call sets in <*start> and <*end>, the next range in <invlist>.
9946      * Returns <TRUE> if successful and the next call will return the next
9947      * range; <FALSE> if was already at the end of the list.  If the latter,
9948      * <*start> and <*end> are unchanged, and the next call to this function
9949      * will start over at the beginning of the list */
9950
9951     STRLEN* pos = get_invlist_iter_addr(invlist);
9952     UV len = _invlist_len(invlist);
9953     UV *array;
9954
9955     PERL_ARGS_ASSERT_INVLIST_ITERNEXT;
9956
9957     if (*pos >= len) {
9958         *pos = (STRLEN) UV_MAX; /* Force iterinit() to be required next time */
9959         return FALSE;
9960     }
9961
9962     array = invlist_array(invlist);
9963
9964     *start = array[(*pos)++];
9965
9966     if (*pos >= len) {
9967         *end = UV_MAX;
9968     }
9969     else {
9970         *end = array[(*pos)++] - 1;
9971     }
9972
9973     return TRUE;
9974 }
9975
9976 PERL_STATIC_INLINE UV
9977 S_invlist_highest(SV* const invlist)
9978 {
9979     /* Returns the highest code point that matches an inversion list.  This API
9980      * has an ambiguity, as it returns 0 under either the highest is actually
9981      * 0, or if the list is empty.  If this distinction matters to you, check
9982      * for emptiness before calling this function */
9983
9984     UV len = _invlist_len(invlist);
9985     UV *array;
9986
9987     PERL_ARGS_ASSERT_INVLIST_HIGHEST;
9988
9989     if (len == 0) {
9990         return 0;
9991     }
9992
9993     array = invlist_array(invlist);
9994
9995     /* The last element in the array in the inversion list always starts a
9996      * range that goes to infinity.  That range may be for code points that are
9997      * matched in the inversion list, or it may be for ones that aren't
9998      * matched.  In the latter case, the highest code point in the set is one
9999      * less than the beginning of this range; otherwise it is the final element
10000      * of this range: infinity */
10001     return (ELEMENT_RANGE_MATCHES_INVLIST(len - 1))
10002            ? UV_MAX
10003            : array[len - 1] - 1;
10004 }
10005
10006 STATIC SV *
10007 S_invlist_contents(pTHX_ SV* const invlist, const bool traditional_style)
10008 {
10009     /* Get the contents of an inversion list into a string SV so that they can
10010      * be printed out.  If 'traditional_style' is TRUE, it uses the format
10011      * traditionally done for debug tracing; otherwise it uses a format
10012      * suitable for just copying to the output, with blanks between ranges and
10013      * a dash between range components */
10014
10015     UV start, end;
10016     SV* output;
10017     const char intra_range_delimiter = (traditional_style ? '\t' : '-');
10018     const char inter_range_delimiter = (traditional_style ? '\n' : ' ');
10019
10020     if (traditional_style) {
10021         output = newSVpvs("\n");
10022     }
10023     else {
10024         output = newSVpvs("");
10025     }
10026
10027     PERL_ARGS_ASSERT_INVLIST_CONTENTS;
10028
10029     assert(! invlist_is_iterating(invlist));
10030
10031     invlist_iterinit(invlist);
10032     while (invlist_iternext(invlist, &start, &end)) {
10033         if (end == UV_MAX) {
10034             Perl_sv_catpvf(aTHX_ output, "%04" UVXf "%cINFINITY%c",
10035                                           start, intra_range_delimiter,
10036                                                  inter_range_delimiter);
10037         }
10038         else if (end != start) {
10039             Perl_sv_catpvf(aTHX_ output, "%04" UVXf "%c%04" UVXf "%c",
10040                                           start,
10041                                                    intra_range_delimiter,
10042                                                   end, inter_range_delimiter);
10043         }
10044         else {
10045             Perl_sv_catpvf(aTHX_ output, "%04" UVXf "%c",
10046                                           start, inter_range_delimiter);
10047         }
10048     }
10049
10050     if (SvCUR(output) && ! traditional_style) {/* Get rid of trailing blank */
10051         SvCUR_set(output, SvCUR(output) - 1);
10052     }
10053
10054     return output;
10055 }
10056
10057 #ifndef PERL_IN_XSUB_RE
10058 void
10059 Perl__invlist_dump(pTHX_ PerlIO *file, I32 level,
10060                          const char * const indent, SV* const invlist)
10061 {
10062     /* Designed to be called only by do_sv_dump().  Dumps out the ranges of the
10063      * inversion list 'invlist' to 'file' at 'level'  Each line is prefixed by
10064      * the string 'indent'.  The output looks like this:
10065          [0] 0x000A .. 0x000D
10066          [2] 0x0085
10067          [4] 0x2028 .. 0x2029
10068          [6] 0x3104 .. INFINITY
10069      * This means that the first range of code points matched by the list are
10070      * 0xA through 0xD; the second range contains only the single code point
10071      * 0x85, etc.  An inversion list is an array of UVs.  Two array elements
10072      * are used to define each range (except if the final range extends to
10073      * infinity, only a single element is needed).  The array index of the
10074      * first element for the corresponding range is given in brackets. */
10075
10076     UV start, end;
10077     STRLEN count = 0;
10078
10079     PERL_ARGS_ASSERT__INVLIST_DUMP;
10080
10081     if (invlist_is_iterating(invlist)) {
10082         Perl_dump_indent(aTHX_ level, file,
10083              "%sCan't dump inversion list because is in middle of iterating\n",
10084              indent);
10085         return;
10086     }
10087
10088     invlist_iterinit(invlist);
10089     while (invlist_iternext(invlist, &start, &end)) {
10090         if (end == UV_MAX) {
10091             Perl_dump_indent(aTHX_ level, file,
10092                                        "%s[%" UVuf "] 0x%04" UVXf " .. INFINITY\n",
10093                                    indent, (UV)count, start);
10094         }
10095         else if (end != start) {
10096             Perl_dump_indent(aTHX_ level, file,
10097                                     "%s[%" UVuf "] 0x%04" UVXf " .. 0x%04" UVXf "\n",
10098                                 indent, (UV)count, start,         end);
10099         }
10100         else {
10101             Perl_dump_indent(aTHX_ level, file, "%s[%" UVuf "] 0x%04" UVXf "\n",
10102                                             indent, (UV)count, start);
10103         }
10104         count += 2;
10105     }
10106 }
10107
10108 void
10109 Perl__load_PL_utf8_foldclosures (pTHX)
10110 {
10111     assert(! PL_utf8_foldclosures);
10112
10113     /* If the folds haven't been read in, call a fold function
10114      * to force that */
10115     if (! PL_utf8_tofold) {
10116         U8 dummy[UTF8_MAXBYTES_CASE+1];
10117         const U8 hyphen[] = HYPHEN_UTF8;
10118
10119         /* This string is just a short named one above \xff */
10120         toFOLD_utf8_safe(hyphen, hyphen + sizeof(hyphen) - 1, dummy, NULL);
10121         assert(PL_utf8_tofold); /* Verify that worked */
10122     }
10123     PL_utf8_foldclosures = _swash_inversion_hash(PL_utf8_tofold);
10124 }
10125 #endif
10126
10127 #if defined(PERL_ARGS_ASSERT__INVLISTEQ) && !defined(PERL_IN_XSUB_RE)
10128 bool
10129 Perl__invlistEQ(pTHX_ SV* const a, SV* const b, const bool complement_b)
10130 {
10131     /* Return a boolean as to if the two passed in inversion lists are
10132      * identical.  The final argument, if TRUE, says to take the complement of
10133      * the second inversion list before doing the comparison */
10134
10135     const UV* array_a = invlist_array(a);
10136     const UV* array_b = invlist_array(b);
10137     UV len_a = _invlist_len(a);
10138     UV len_b = _invlist_len(b);
10139
10140     PERL_ARGS_ASSERT__INVLISTEQ;
10141
10142     /* If are to compare 'a' with the complement of b, set it
10143      * up so are looking at b's complement. */
10144     if (complement_b) {
10145
10146         /* The complement of nothing is everything, so <a> would have to have
10147          * just one element, starting at zero (ending at infinity) */
10148         if (len_b == 0) {
10149             return (len_a == 1 && array_a[0] == 0);
10150         }
10151         else if (array_b[0] == 0) {
10152
10153             /* Otherwise, to complement, we invert.  Here, the first element is
10154              * 0, just remove it.  To do this, we just pretend the array starts
10155              * one later */
10156
10157             array_b++;
10158             len_b--;
10159         }
10160         else {
10161
10162             /* But if the first element is not zero, we pretend the list starts
10163              * at the 0 that is always stored immediately before the array. */
10164             array_b--;
10165             len_b++;
10166         }
10167     }
10168
10169     return    len_a == len_b
10170            && memEQ(array_a, array_b, len_a * sizeof(array_a[0]));
10171
10172 }
10173 #endif
10174
10175 /*
10176  * As best we can, determine the characters that can match the start of
10177  * the given EXACTF-ish node.
10178  *
10179  * Returns the invlist as a new SV*; it is the caller's responsibility to
10180  * call SvREFCNT_dec() when done with it.
10181  */
10182 STATIC SV*
10183 S__make_exactf_invlist(pTHX_ RExC_state_t *pRExC_state, regnode *node)
10184 {
10185     const U8 * s = (U8*)STRING(node);
10186     SSize_t bytelen = STR_LEN(node);
10187     UV uc;
10188     /* Start out big enough for 2 separate code points */
10189     SV* invlist = _new_invlist(4);
10190
10191     PERL_ARGS_ASSERT__MAKE_EXACTF_INVLIST;
10192
10193     if (! UTF) {
10194         uc = *s;
10195
10196         /* We punt and assume can match anything if the node begins
10197          * with a multi-character fold.  Things are complicated.  For
10198          * example, /ffi/i could match any of:
10199          *  "\N{LATIN SMALL LIGATURE FFI}"
10200          *  "\N{LATIN SMALL LIGATURE FF}I"
10201          *  "F\N{LATIN SMALL LIGATURE FI}"
10202          *  plus several other things; and making sure we have all the
10203          *  possibilities is hard. */
10204         if (is_MULTI_CHAR_FOLD_latin1_safe(s, s + bytelen)) {
10205             invlist = _add_range_to_invlist(invlist, 0, UV_MAX);
10206         }
10207         else {
10208             /* Any Latin1 range character can potentially match any
10209              * other depending on the locale */
10210             if (OP(node) == EXACTFL) {
10211                 _invlist_union(invlist, PL_Latin1, &invlist);
10212             }
10213             else {
10214                 /* But otherwise, it matches at least itself.  We can
10215                  * quickly tell if it has a distinct fold, and if so,
10216                  * it matches that as well */
10217                 invlist = add_cp_to_invlist(invlist, uc);
10218                 if (IS_IN_SOME_FOLD_L1(uc))
10219                     invlist = add_cp_to_invlist(invlist, PL_fold_latin1[uc]);
10220             }
10221
10222             /* Some characters match above-Latin1 ones under /i.  This
10223              * is true of EXACTFL ones when the locale is UTF-8 */
10224             if (HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(uc)
10225                 && (! isASCII(uc) || (OP(node) != EXACTFA
10226                                     && OP(node) != EXACTFA_NO_TRIE)))
10227             {
10228                 add_above_Latin1_folds(pRExC_state, (U8) uc, &invlist);
10229             }
10230         }
10231     }
10232     else {  /* Pattern is UTF-8 */
10233         U8 folded[UTF8_MAX_FOLD_CHAR_EXPAND * UTF8_MAXBYTES_CASE + 1] = { '\0' };
10234         STRLEN foldlen = UTF8SKIP(s);
10235         const U8* e = s + bytelen;
10236         SV** listp;
10237
10238         uc = utf8_to_uvchr_buf(s, s + bytelen, NULL);
10239
10240         /* The only code points that aren't folded in a UTF EXACTFish
10241          * node are are the problematic ones in EXACTFL nodes */
10242         if (OP(node) == EXACTFL && is_PROBLEMATIC_LOCALE_FOLDEDS_START_cp(uc)) {
10243             /* We need to check for the possibility that this EXACTFL
10244              * node begins with a multi-char fold.  Therefore we fold
10245              * the first few characters of it so that we can make that
10246              * check */
10247             U8 *d = folded;
10248             int i;
10249
10250             for (i = 0; i < UTF8_MAX_FOLD_CHAR_EXPAND && s < e; i++) {
10251                 if (isASCII(*s)) {
10252                     *(d++) = (U8) toFOLD(*s);
10253                     s++;
10254                 }
10255                 else {
10256                     STRLEN len;
10257                     toFOLD_utf8_safe(s, e, d, &len);
10258                     d += len;
10259                     s += UTF8SKIP(s);
10260                 }
10261             }
10262
10263             /* And set up so the code below that looks in this folded
10264              * buffer instead of the node's string */
10265             e = d;
10266             foldlen = UTF8SKIP(folded);
10267             s = folded;
10268         }
10269
10270         /* When we reach here 's' points to the fold of the first
10271          * character(s) of the node; and 'e' points to far enough along
10272          * the folded string to be just past any possible multi-char
10273          * fold. 'foldlen' is the length in bytes of the first
10274          * character in 's'
10275          *
10276          * Unlike the non-UTF-8 case, the macro for determining if a
10277          * string is a multi-char fold requires all the characters to
10278          * already be folded.  This is because of all the complications
10279          * if not.  Note that they are folded anyway, except in EXACTFL
10280          * nodes.  Like the non-UTF case above, we punt if the node
10281          * begins with a multi-char fold  */
10282
10283         if (is_MULTI_CHAR_FOLD_utf8_safe(s, e)) {
10284             invlist = _add_range_to_invlist(invlist, 0, UV_MAX);
10285         }
10286         else {  /* Single char fold */
10287
10288             /* It matches all the things that fold to it, which are
10289              * found in PL_utf8_foldclosures (including itself) */
10290             invlist = add_cp_to_invlist(invlist, uc);
10291             if (! PL_utf8_foldclosures)
10292                 _load_PL_utf8_foldclosures();
10293             if ((listp = hv_fetch(PL_utf8_foldclosures,
10294                                 (char *) s, foldlen, FALSE)))
10295             {
10296                 AV* list = (AV*) *listp;
10297                 IV k;
10298                 for (k = 0; k <= av_tindex_skip_len_mg(list); k++) {
10299                     SV** c_p = av_fetch(list, k, FALSE);
10300                     UV c;
10301                     assert(c_p);
10302
10303                     c = SvUV(*c_p);
10304
10305                     /* /aa doesn't allow folds between ASCII and non- */
10306                     if ((OP(node) == EXACTFA || OP(node) == EXACTFA_NO_TRIE)
10307                         && isASCII(c) != isASCII(uc))
10308                     {
10309                         continue;
10310                     }
10311
10312                     invlist = add_cp_to_invlist(invlist, c);
10313                 }
10314             }
10315         }
10316     }
10317
10318     return invlist;
10319 }
10320
10321 #undef HEADER_LENGTH
10322 #undef TO_INTERNAL_SIZE
10323 #undef FROM_INTERNAL_SIZE
10324 #undef INVLIST_VERSION_ID
10325
10326 /* End of inversion list object */
10327
10328 STATIC void
10329 S_parse_lparen_question_flags(pTHX_ RExC_state_t *pRExC_state)
10330 {
10331     /* This parses the flags that are in either the '(?foo)' or '(?foo:bar)'
10332      * constructs, and updates RExC_flags with them.  On input, RExC_parse
10333      * should point to the first flag; it is updated on output to point to the
10334      * final ')' or ':'.  There needs to be at least one flag, or this will
10335      * abort */
10336
10337     /* for (?g), (?gc), and (?o) warnings; warning
10338        about (?c) will warn about (?g) -- japhy    */
10339
10340 #define WASTED_O  0x01
10341 #define WASTED_G  0x02
10342 #define WASTED_C  0x04
10343 #define WASTED_GC (WASTED_G|WASTED_C)
10344     I32 wastedflags = 0x00;
10345     U32 posflags = 0, negflags = 0;
10346     U32 *flagsp = &posflags;
10347     char has_charset_modifier = '\0';
10348     regex_charset cs;
10349     bool has_use_defaults = FALSE;
10350     const char* const seqstart = RExC_parse - 1; /* Point to the '?' */
10351     int x_mod_count = 0;
10352
10353     PERL_ARGS_ASSERT_PARSE_LPAREN_QUESTION_FLAGS;
10354
10355     /* '^' as an initial flag sets certain defaults */
10356     if (UCHARAT(RExC_parse) == '^') {
10357         RExC_parse++;
10358         has_use_defaults = TRUE;
10359         STD_PMMOD_FLAGS_CLEAR(&RExC_flags);
10360         set_regex_charset(&RExC_flags, (RExC_utf8 || RExC_uni_semantics)
10361                                         ? REGEX_UNICODE_CHARSET
10362                                         : REGEX_DEPENDS_CHARSET);
10363     }
10364
10365     cs = get_regex_charset(RExC_flags);
10366     if (cs == REGEX_DEPENDS_CHARSET
10367         && (RExC_utf8 || RExC_uni_semantics))
10368     {
10369         cs = REGEX_UNICODE_CHARSET;
10370     }
10371
10372     while (RExC_parse < RExC_end) {
10373         /* && strchr("iogcmsx", *RExC_parse) */
10374         /* (?g), (?gc) and (?o) are useless here
10375            and must be globally applied -- japhy */
10376         switch (*RExC_parse) {
10377
10378             /* Code for the imsxn flags */
10379             CASE_STD_PMMOD_FLAGS_PARSE_SET(flagsp, x_mod_count);
10380
10381             case LOCALE_PAT_MOD:
10382                 if (has_charset_modifier) {
10383                     goto excess_modifier;
10384                 }
10385                 else if (flagsp == &negflags) {
10386                     goto neg_modifier;
10387                 }
10388                 cs = REGEX_LOCALE_CHARSET;
10389                 has_charset_modifier = LOCALE_PAT_MOD;
10390                 break;
10391             case UNICODE_PAT_MOD:
10392                 if (has_charset_modifier) {
10393                     goto excess_modifier;
10394                 }
10395                 else if (flagsp == &negflags) {
10396                     goto neg_modifier;
10397                 }
10398                 cs = REGEX_UNICODE_CHARSET;
10399                 has_charset_modifier = UNICODE_PAT_MOD;
10400                 break;
10401             case ASCII_RESTRICT_PAT_MOD:
10402                 if (flagsp == &negflags) {
10403                     goto neg_modifier;
10404                 }
10405                 if (has_charset_modifier) {
10406                     if (cs != REGEX_ASCII_RESTRICTED_CHARSET) {
10407                         goto excess_modifier;
10408                     }
10409                     /* Doubled modifier implies more restricted */
10410                     cs = REGEX_ASCII_MORE_RESTRICTED_CHARSET;
10411                 }
10412                 else {
10413                     cs = REGEX_ASCII_RESTRICTED_CHARSET;
10414                 }
10415                 has_charset_modifier = ASCII_RESTRICT_PAT_MOD;
10416                 break;
10417             case DEPENDS_PAT_MOD:
10418                 if (has_use_defaults) {
10419                     goto fail_modifiers;
10420                 }
10421                 else if (flagsp == &negflags) {
10422                     goto neg_modifier;
10423                 }
10424                 else if (has_charset_modifier) {
10425                     goto excess_modifier;
10426                 }
10427
10428                 /* The dual charset means unicode semantics if the
10429                  * pattern (or target, not known until runtime) are
10430                  * utf8, or something in the pattern indicates unicode
10431                  * semantics */
10432                 cs = (RExC_utf8 || RExC_uni_semantics)
10433                      ? REGEX_UNICODE_CHARSET
10434                      : REGEX_DEPENDS_CHARSET;
10435                 has_charset_modifier = DEPENDS_PAT_MOD;
10436                 break;
10437               excess_modifier:
10438                 RExC_parse++;
10439                 if (has_charset_modifier == ASCII_RESTRICT_PAT_MOD) {
10440                     vFAIL2("Regexp modifier \"%c\" may appear a maximum of twice", ASCII_RESTRICT_PAT_MOD);
10441                 }
10442                 else if (has_charset_modifier == *(RExC_parse - 1)) {
10443                     vFAIL2("Regexp modifier \"%c\" may not appear twice",
10444                                         *(RExC_parse - 1));
10445                 }
10446                 else {
10447                     vFAIL3("Regexp modifiers \"%c\" and \"%c\" are mutually exclusive", has_charset_modifier, *(RExC_parse - 1));
10448                 }
10449                 NOT_REACHED; /*NOTREACHED*/
10450               neg_modifier:
10451                 RExC_parse++;
10452                 vFAIL2("Regexp modifier \"%c\" may not appear after the \"-\"",
10453                                     *(RExC_parse - 1));
10454                 NOT_REACHED; /*NOTREACHED*/
10455             case ONCE_PAT_MOD: /* 'o' */
10456             case GLOBAL_PAT_MOD: /* 'g' */
10457                 if (PASS2 && ckWARN(WARN_REGEXP)) {
10458                     const I32 wflagbit = *RExC_parse == 'o'
10459                                          ? WASTED_O
10460                                          : WASTED_G;
10461                     if (! (wastedflags & wflagbit) ) {
10462                         wastedflags |= wflagbit;
10463                         /* diag_listed_as: Useless (?-%s) - don't use /%s modifier in regex; marked by <-- HERE in m/%s/ */
10464                         vWARN5(
10465                             RExC_parse + 1,
10466                             "Useless (%s%c) - %suse /%c modifier",
10467                             flagsp == &negflags ? "?-" : "?",
10468                             *RExC_parse,
10469                             flagsp == &negflags ? "don't " : "",
10470                             *RExC_parse
10471                         );
10472                     }
10473                 }
10474                 break;
10475
10476             case CONTINUE_PAT_MOD: /* 'c' */
10477                 if (PASS2 && ckWARN(WARN_REGEXP)) {
10478                     if (! (wastedflags & WASTED_C) ) {
10479                         wastedflags |= WASTED_GC;
10480                         /* diag_listed_as: Useless (?-%s) - don't use /%s modifier in regex; marked by <-- HERE in m/%s/ */
10481                         vWARN3(
10482                             RExC_parse + 1,
10483                             "Useless (%sc) - %suse /gc modifier",
10484                             flagsp == &negflags ? "?-" : "?",
10485                             flagsp == &negflags ? "don't " : ""
10486                         );
10487                     }
10488                 }
10489                 break;
10490             case KEEPCOPY_PAT_MOD: /* 'p' */
10491                 if (flagsp == &negflags) {
10492                     if (PASS2)
10493                         ckWARNreg(RExC_parse + 1,"Useless use of (?-p)");
10494                 } else {
10495                     *flagsp |= RXf_PMf_KEEPCOPY;
10496                 }
10497                 break;
10498             case '-':
10499                 /* A flag is a default iff it is following a minus, so
10500                  * if there is a minus, it means will be trying to
10501                  * re-specify a default which is an error */
10502                 if (has_use_defaults || flagsp == &negflags) {
10503                     goto fail_modifiers;
10504                 }
10505                 flagsp = &negflags;
10506                 wastedflags = 0;  /* reset so (?g-c) warns twice */
10507                 x_mod_count = 0;
10508                 break;
10509             case ':':
10510             case ')':
10511
10512                 if ((posflags & (RXf_PMf_EXTENDED|RXf_PMf_EXTENDED_MORE)) == RXf_PMf_EXTENDED) {
10513                     negflags |= RXf_PMf_EXTENDED_MORE;
10514                 }
10515                 RExC_flags |= posflags;
10516
10517                 if (negflags & RXf_PMf_EXTENDED) {
10518                     negflags |= RXf_PMf_EXTENDED_MORE;
10519                 }
10520                 RExC_flags &= ~negflags;
10521                 set_regex_charset(&RExC_flags, cs);
10522
10523                 return;
10524             default:
10525               fail_modifiers:
10526                 RExC_parse += SKIP_IF_CHAR(RExC_parse);
10527                 /* diag_listed_as: Sequence (?%s...) not recognized in regex; marked by <-- HERE in m/%s/ */
10528                 vFAIL2utf8f("Sequence (%" UTF8f "...) not recognized",
10529                       UTF8fARG(UTF, RExC_parse-seqstart, seqstart));
10530                 NOT_REACHED; /*NOTREACHED*/
10531         }
10532
10533         RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
10534     }
10535
10536     vFAIL("Sequence (?... not terminated");
10537 }
10538
10539 /*
10540  - reg - regular expression, i.e. main body or parenthesized thing
10541  *
10542  * Caller must absorb opening parenthesis.
10543  *
10544  * Combining parenthesis handling with the base level of regular expression
10545  * is a trifle forced, but the need to tie the tails of the branches to what
10546  * follows makes it hard to avoid.
10547  */
10548 #define REGTAIL(x,y,z) regtail((x),(y),(z),depth+1)
10549 #ifdef DEBUGGING
10550 #define REGTAIL_STUDY(x,y,z) regtail_study((x),(y),(z),depth+1)
10551 #else
10552 #define REGTAIL_STUDY(x,y,z) regtail((x),(y),(z),depth+1)
10553 #endif
10554
10555 PERL_STATIC_INLINE regnode *
10556 S_handle_named_backref(pTHX_ RExC_state_t *pRExC_state,
10557                              I32 *flagp,
10558                              char * parse_start,
10559                              char ch
10560                       )
10561 {
10562     regnode *ret;
10563     char* name_start = RExC_parse;
10564     U32 num = 0;
10565     SV *sv_dat = reg_scan_name(pRExC_state, SIZE_ONLY
10566                                             ? REG_RSN_RETURN_NULL
10567                                             : REG_RSN_RETURN_DATA);
10568     GET_RE_DEBUG_FLAGS_DECL;
10569
10570     PERL_ARGS_ASSERT_HANDLE_NAMED_BACKREF;
10571
10572     if (RExC_parse == name_start || *RExC_parse != ch) {
10573         /* diag_listed_as: Sequence \%s... not terminated in regex; marked by <-- HERE in m/%s/ */
10574         vFAIL2("Sequence %.3s... not terminated",parse_start);
10575     }
10576
10577     if (!SIZE_ONLY) {
10578         num = add_data( pRExC_state, STR_WITH_LEN("S"));
10579         RExC_rxi->data->data[num]=(void*)sv_dat;
10580         SvREFCNT_inc_simple_void(sv_dat);
10581     }
10582     RExC_sawback = 1;
10583     ret = reganode(pRExC_state,
10584                    ((! FOLD)
10585                      ? NREF
10586                      : (ASCII_FOLD_RESTRICTED)
10587                        ? NREFFA
10588                        : (AT_LEAST_UNI_SEMANTICS)
10589                          ? NREFFU
10590                          : (LOC)
10591                            ? NREFFL
10592                            : NREFF),
10593                     num);
10594     *flagp |= HASWIDTH;
10595
10596     Set_Node_Offset(ret, parse_start+1);
10597     Set_Node_Cur_Length(ret, parse_start);
10598
10599     nextchar(pRExC_state);
10600     return ret;
10601 }
10602
10603 /* Returns NULL, setting *flagp to TRYAGAIN at the end of (?) that only sets
10604    flags. Returns NULL, setting *flagp to RESTART_PASS1 if the sizing scan
10605    needs to be restarted, or'd with NEED_UTF8 if the pattern needs to be
10606    upgraded to UTF-8.  Otherwise would only return NULL if regbranch() returns
10607    NULL, which cannot happen.  */
10608 STATIC regnode *
10609 S_reg(pTHX_ RExC_state_t *pRExC_state, I32 paren, I32 *flagp,U32 depth)
10610     /* paren: Parenthesized? 0=top; 1,2=inside '(': changed to letter.
10611      * 2 is like 1, but indicates that nextchar() has been called to advance
10612      * RExC_parse beyond the '('.  Things like '(?' are indivisible tokens, and
10613      * this flag alerts us to the need to check for that */
10614 {
10615     regnode *ret;               /* Will be the head of the group. */
10616     regnode *br;
10617     regnode *lastbr;
10618     regnode *ender = NULL;
10619     I32 parno = 0;
10620     I32 flags;
10621     U32 oregflags = RExC_flags;
10622     bool have_branch = 0;
10623     bool is_open = 0;
10624     I32 freeze_paren = 0;
10625     I32 after_freeze = 0;
10626     I32 num; /* numeric backreferences */
10627
10628     char * parse_start = RExC_parse; /* MJD */
10629     char * const oregcomp_parse = RExC_parse;
10630
10631     GET_RE_DEBUG_FLAGS_DECL;
10632
10633     PERL_ARGS_ASSERT_REG;
10634     DEBUG_PARSE("reg ");
10635
10636     *flagp = 0;                         /* Tentatively. */
10637
10638     /* Having this true makes it feasible to have a lot fewer tests for the
10639      * parse pointer being in scope.  For example, we can write
10640      *      while(isFOO(*RExC_parse)) RExC_parse++;
10641      * instead of
10642      *      while(RExC_parse < RExC_end && isFOO(*RExC_parse)) RExC_parse++;
10643      */
10644     assert(*RExC_end == '\0');
10645
10646     /* Make an OPEN node, if parenthesized. */
10647     if (paren) {
10648
10649         /* Under /x, space and comments can be gobbled up between the '(' and
10650          * here (if paren ==2).  The forms '(*VERB' and '(?...' disallow such
10651          * intervening space, as the sequence is a token, and a token should be
10652          * indivisible */
10653         bool has_intervening_patws = paren == 2 && *(RExC_parse - 1) != '(';
10654
10655         if (RExC_parse >= RExC_end) {
10656             vFAIL("Unmatched (");
10657         }
10658
10659         if ( *RExC_parse == '*') { /* (*VERB:ARG) */
10660             char *start_verb = RExC_parse + 1;
10661             STRLEN verb_len;
10662             char *start_arg = NULL;
10663             unsigned char op = 0;
10664             int arg_required = 0;
10665             int internal_argval = -1; /* if >-1 we are not allowed an argument*/
10666
10667             if (has_intervening_patws) {
10668                 RExC_parse++;   /* past the '*' */
10669                 vFAIL("In '(*VERB...)', the '(' and '*' must be adjacent");
10670             }
10671             while (RExC_parse < RExC_end && *RExC_parse != ')' ) {
10672                 if ( *RExC_parse == ':' ) {
10673                     start_arg = RExC_parse + 1;
10674                     break;
10675                 }
10676                 RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
10677             }
10678             verb_len = RExC_parse - start_verb;
10679             if ( start_arg ) {
10680                 if (RExC_parse >= RExC_end) {
10681                     goto unterminated_verb_pattern;
10682                 }
10683                 RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
10684                 while ( RExC_parse < RExC_end && *RExC_parse != ')' )
10685                     RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
10686                 if ( RExC_parse >= RExC_end || *RExC_parse != ')' )
10687                   unterminated_verb_pattern:
10688                     vFAIL("Unterminated verb pattern argument");
10689                 if ( RExC_parse == start_arg )
10690                     start_arg = NULL;
10691             } else {
10692                 if ( RExC_parse >= RExC_end || *RExC_parse != ')' )
10693                     vFAIL("Unterminated verb pattern");
10694             }
10695
10696             /* Here, we know that RExC_parse < RExC_end */
10697
10698             switch ( *start_verb ) {
10699             case 'A':  /* (*ACCEPT) */
10700                 if ( memEQs(start_verb,verb_len,"ACCEPT") ) {
10701                     op = ACCEPT;
10702                     internal_argval = RExC_nestroot;
10703                 }
10704                 break;
10705             case 'C':  /* (*COMMIT) */
10706                 if ( memEQs(start_verb,verb_len,"COMMIT") )
10707                     op = COMMIT;
10708                 break;
10709             case 'F':  /* (*FAIL) */
10710                 if ( verb_len==1 || memEQs(start_verb,verb_len,"FAIL") ) {
10711                     op = OPFAIL;
10712                 }
10713                 break;
10714             case ':':  /* (*:NAME) */
10715             case 'M':  /* (*MARK:NAME) */
10716                 if ( verb_len==0 || memEQs(start_verb,verb_len,"MARK") ) {
10717                     op = MARKPOINT;
10718                     arg_required = 1;
10719                 }
10720                 break;
10721             case 'P':  /* (*PRUNE) */
10722                 if ( memEQs(start_verb,verb_len,"PRUNE") )
10723                     op = PRUNE;
10724                 break;
10725             case 'S':   /* (*SKIP) */
10726                 if ( memEQs(start_verb,verb_len,"SKIP") )
10727                     op = SKIP;
10728                 break;
10729             case 'T':  /* (*THEN) */
10730                 /* [19:06] <TimToady> :: is then */
10731                 if ( memEQs(start_verb,verb_len,"THEN") ) {
10732                     op = CUTGROUP;
10733                     RExC_seen |= REG_CUTGROUP_SEEN;
10734                 }
10735                 break;
10736             }
10737             if ( ! op ) {
10738                 RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
10739                 vFAIL2utf8f(
10740                     "Unknown verb pattern '%" UTF8f "'",
10741                     UTF8fARG(UTF, verb_len, start_verb));
10742             }
10743             if ( arg_required && !start_arg ) {
10744                 vFAIL3("Verb pattern '%.*s' has a mandatory argument",
10745                     verb_len, start_verb);
10746             }
10747             if (internal_argval == -1) {
10748                 ret = reganode(pRExC_state, op, 0);
10749             } else {
10750                 ret = reg2Lanode(pRExC_state, op, 0, internal_argval);
10751             }
10752             RExC_seen |= REG_VERBARG_SEEN;
10753             if ( ! SIZE_ONLY ) {
10754                 if (start_arg) {
10755                     SV *sv = newSVpvn( start_arg,
10756                                        RExC_parse - start_arg);
10757                     ARG(ret) = add_data( pRExC_state,
10758                                          STR_WITH_LEN("S"));
10759                     RExC_rxi->data->data[ARG(ret)]=(void*)sv;
10760                     ret->flags = 1;
10761                 } else {
10762                     ret->flags = 0;
10763                 }
10764                 if ( internal_argval != -1 )
10765                     ARG2L_SET(ret, internal_argval);
10766             }
10767             nextchar(pRExC_state);
10768             return ret;
10769         }
10770         else if (*RExC_parse == '?') { /* (?...) */
10771             bool is_logical = 0;
10772             const char * const seqstart = RExC_parse;
10773             const char * endptr;
10774             if (has_intervening_patws) {
10775                 RExC_parse++;
10776                 vFAIL("In '(?...)', the '(' and '?' must be adjacent");
10777             }
10778
10779             RExC_parse++;           /* past the '?' */
10780             paren = *RExC_parse;    /* might be a trailing NUL, if not
10781                                        well-formed */
10782             RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
10783             if (RExC_parse > RExC_end) {
10784                 paren = '\0';
10785             }
10786             ret = NULL;                 /* For look-ahead/behind. */
10787             switch (paren) {
10788
10789             case 'P':   /* (?P...) variants for those used to PCRE/Python */
10790                 paren = *RExC_parse;
10791                 if ( paren == '<') {    /* (?P<...>) named capture */
10792                     RExC_parse++;
10793                     if (RExC_parse >= RExC_end) {
10794                         vFAIL("Sequence (?P<... not terminated");
10795                     }
10796                     goto named_capture;
10797                 }
10798                 else if (paren == '>') {   /* (?P>name) named recursion */
10799                     RExC_parse++;
10800                     if (RExC_parse >= RExC_end) {
10801                         vFAIL("Sequence (?P>... not terminated");
10802                     }
10803                     goto named_recursion;
10804                 }
10805                 else if (paren == '=') {   /* (?P=...)  named backref */
10806                     RExC_parse++;
10807                     return handle_named_backref(pRExC_state, flagp,
10808                                                 parse_start, ')');
10809                 }
10810                 RExC_parse += SKIP_IF_CHAR(RExC_parse);
10811                 /* diag_listed_as: Sequence (?%s...) not recognized in regex; marked by <-- HERE in m/%s/ */
10812                 vFAIL3("Sequence (%.*s...) not recognized",
10813                                 RExC_parse-seqstart, seqstart);
10814                 NOT_REACHED; /*NOTREACHED*/
10815             case '<':           /* (?<...) */
10816                 if (*RExC_parse == '!')
10817                     paren = ',';
10818                 else if (*RExC_parse != '=')
10819               named_capture:
10820                 {               /* (?<...>) */
10821                     char *name_start;
10822                     SV *svname;
10823                     paren= '>';
10824                 /* FALLTHROUGH */
10825             case '\'':          /* (?'...') */
10826                     name_start = RExC_parse;
10827                     svname = reg_scan_name(pRExC_state,
10828                         SIZE_ONLY    /* reverse test from the others */
10829                         ? REG_RSN_RETURN_NAME
10830                         : REG_RSN_RETURN_NULL);
10831                     if (   RExC_parse == name_start
10832                         || RExC_parse >= RExC_end
10833                         || *RExC_parse != paren)
10834                     {
10835                         vFAIL2("Sequence (?%c... not terminated",
10836                             paren=='>' ? '<' : paren);
10837                     }
10838                     if (SIZE_ONLY) {
10839                         HE *he_str;
10840                         SV *sv_dat = NULL;
10841                         if (!svname) /* shouldn't happen */
10842                             Perl_croak(aTHX_
10843                                 "panic: reg_scan_name returned NULL");
10844                         if (!RExC_paren_names) {
10845                             RExC_paren_names= newHV();
10846                             sv_2mortal(MUTABLE_SV(RExC_paren_names));
10847 #ifdef DEBUGGING
10848                             RExC_paren_name_list= newAV();
10849                             sv_2mortal(MUTABLE_SV(RExC_paren_name_list));
10850 #endif
10851                         }
10852                         he_str = hv_fetch_ent( RExC_paren_names, svname, 1, 0 );
10853                         if ( he_str )
10854                             sv_dat = HeVAL(he_str);
10855                         if ( ! sv_dat ) {
10856                             /* croak baby croak */
10857                             Perl_croak(aTHX_
10858                                 "panic: paren_name hash element allocation failed");
10859                         } else if ( SvPOK(sv_dat) ) {
10860                             /* (?|...) can mean we have dupes so scan to check
10861                                its already been stored. Maybe a flag indicating
10862                                we are inside such a construct would be useful,
10863                                but the arrays are likely to be quite small, so
10864                                for now we punt -- dmq */
10865                             IV count = SvIV(sv_dat);
10866                             I32 *pv = (I32*)SvPVX(sv_dat);
10867                             IV i;
10868                             for ( i = 0 ; i < count ; i++ ) {
10869                                 if ( pv[i] == RExC_npar ) {
10870                                     count = 0;
10871                                     break;
10872                                 }
10873                             }
10874                             if ( count ) {
10875                                 pv = (I32*)SvGROW(sv_dat,
10876                                                 SvCUR(sv_dat) + sizeof(I32)+1);
10877                                 SvCUR_set(sv_dat, SvCUR(sv_dat) + sizeof(I32));
10878                                 pv[count] = RExC_npar;
10879                                 SvIV_set(sv_dat, SvIVX(sv_dat) + 1);
10880                             }
10881                         } else {
10882                             (void)SvUPGRADE(sv_dat,SVt_PVNV);
10883                             sv_setpvn(sv_dat, (char *)&(RExC_npar),
10884                                                                 sizeof(I32));
10885                             SvIOK_on(sv_dat);
10886                             SvIV_set(sv_dat, 1);
10887                         }
10888 #ifdef DEBUGGING
10889                         /* Yes this does cause a memory leak in debugging Perls
10890                          * */
10891                         if (!av_store(RExC_paren_name_list,
10892                                       RExC_npar, SvREFCNT_inc(svname)))
10893                             SvREFCNT_dec_NN(svname);
10894 #endif
10895
10896                         /*sv_dump(sv_dat);*/
10897                     }
10898                     nextchar(pRExC_state);
10899                     paren = 1;
10900                     goto capturing_parens;
10901                 }
10902                 RExC_seen |= REG_LOOKBEHIND_SEEN;
10903                 RExC_in_lookbehind++;
10904                 RExC_parse++;
10905                 if (RExC_parse >= RExC_end) {
10906                     vFAIL("Sequence (?... not terminated");
10907                 }
10908
10909                 /* FALLTHROUGH */
10910             case '=':           /* (?=...) */
10911                 RExC_seen_zerolen++;
10912                 break;
10913             case '!':           /* (?!...) */
10914                 RExC_seen_zerolen++;
10915                 /* check if we're really just a "FAIL" assertion */
10916                 skip_to_be_ignored_text(pRExC_state, &RExC_parse,
10917                                         FALSE /* Don't force to /x */ );
10918                 if (*RExC_parse == ')') {
10919                     ret=reganode(pRExC_state, OPFAIL, 0);
10920                     nextchar(pRExC_state);
10921                     return ret;
10922                 }
10923                 break;
10924             case '|':           /* (?|...) */
10925                 /* branch reset, behave like a (?:...) except that
10926                    buffers in alternations share the same numbers */
10927                 paren = ':';
10928                 after_freeze = freeze_paren = RExC_npar;
10929                 break;
10930             case ':':           /* (?:...) */
10931             case '>':           /* (?>...) */
10932                 break;
10933             case '$':           /* (?$...) */
10934             case '@':           /* (?@...) */
10935                 vFAIL2("Sequence (?%c...) not implemented", (int)paren);
10936                 break;
10937             case '0' :           /* (?0) */
10938             case 'R' :           /* (?R) */
10939                 if (RExC_parse == RExC_end || *RExC_parse != ')')
10940                     FAIL("Sequence (?R) not terminated");
10941                 num = 0;
10942                 RExC_seen |= REG_RECURSE_SEEN;
10943                 *flagp |= POSTPONED;
10944                 goto gen_recurse_regop;
10945                 /*notreached*/
10946             /* named and numeric backreferences */
10947             case '&':            /* (?&NAME) */
10948                 parse_start = RExC_parse - 1;
10949               named_recursion:
10950                 {
10951                     SV *sv_dat = reg_scan_name(pRExC_state,
10952                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
10953                      num = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
10954                 }
10955                 if (RExC_parse >= RExC_end || *RExC_parse != ')')
10956                     vFAIL("Sequence (?&... not terminated");
10957                 goto gen_recurse_regop;
10958                 /* NOTREACHED */
10959             case '+':
10960                 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
10961                     RExC_parse++;
10962                     vFAIL("Illegal pattern");
10963                 }
10964                 goto parse_recursion;
10965                 /* NOTREACHED*/
10966             case '-': /* (?-1) */
10967                 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
10968                     RExC_parse--; /* rewind to let it be handled later */
10969                     goto parse_flags;
10970                 }
10971                 /* FALLTHROUGH */
10972             case '1': case '2': case '3': case '4': /* (?1) */
10973             case '5': case '6': case '7': case '8': case '9':
10974                 RExC_parse = (char *) seqstart + 1;  /* Point to the digit */
10975               parse_recursion:
10976                 {
10977                     bool is_neg = FALSE;
10978                     UV unum;
10979                     parse_start = RExC_parse - 1; /* MJD */
10980                     if (*RExC_parse == '-') {
10981                         RExC_parse++;
10982                         is_neg = TRUE;
10983                     }
10984                     if (grok_atoUV(RExC_parse, &unum, &endptr)
10985                         && unum <= I32_MAX
10986                     ) {
10987                         num = (I32)unum;
10988                         RExC_parse = (char*)endptr;
10989                     } else
10990                         num = I32_MAX;
10991                     if (is_neg) {
10992                         /* Some limit for num? */
10993                         num = -num;
10994                     }
10995                 }
10996                 if (*RExC_parse!=')')
10997                     vFAIL("Expecting close bracket");
10998
10999               gen_recurse_regop:
11000                 if ( paren == '-' ) {
11001                     /*
11002                     Diagram of capture buffer numbering.
11003                     Top line is the normal capture buffer numbers
11004                     Bottom line is the negative indexing as from
11005                     the X (the (?-2))
11006
11007                     +   1 2    3 4 5 X          6 7
11008                        /(a(x)y)(a(b(c(?-2)d)e)f)(g(h))/
11009                     -   5 4    3 2 1 X          x x
11010
11011                     */
11012                     num = RExC_npar + num;
11013                     if (num < 1)  {
11014                         RExC_parse++;
11015                         vFAIL("Reference to nonexistent group");
11016                     }
11017                 } else if ( paren == '+' ) {
11018                     num = RExC_npar + num - 1;
11019                 }
11020                 /* We keep track how many GOSUB items we have produced.
11021                    To start off the ARG2L() of the GOSUB holds its "id",
11022                    which is used later in conjunction with RExC_recurse
11023                    to calculate the offset we need to jump for the GOSUB,
11024                    which it will store in the final representation.
11025                    We have to defer the actual calculation until much later
11026                    as the regop may move.
11027                  */
11028
11029                 ret = reg2Lanode(pRExC_state, GOSUB, num, RExC_recurse_count);
11030                 if (!SIZE_ONLY) {
11031                     if (num > (I32)RExC_rx->nparens) {
11032                         RExC_parse++;
11033                         vFAIL("Reference to nonexistent group");
11034                     }
11035                     RExC_recurse_count++;
11036                     DEBUG_OPTIMISE_MORE_r(Perl_re_printf( aTHX_
11037                         "%*s%*s Recurse #%" UVuf " to %" IVdf "\n",
11038                               22, "|    |", (int)(depth * 2 + 1), "",
11039                               (UV)ARG(ret), (IV)ARG2L(ret)));
11040                 }
11041                 RExC_seen |= REG_RECURSE_SEEN;
11042
11043                 Set_Node_Length(ret, 1 + regarglen[OP(ret)]); /* MJD */
11044                 Set_Node_Offset(ret, parse_start); /* MJD */
11045
11046                 *flagp |= POSTPONED;
11047                 assert(*RExC_parse == ')');
11048                 nextchar(pRExC_state);
11049                 return ret;
11050
11051             /* NOTREACHED */
11052
11053             case '?':           /* (??...) */
11054                 is_logical = 1;
11055                 if (*RExC_parse != '{') {
11056                     RExC_parse += SKIP_IF_CHAR(RExC_parse);
11057                     /* diag_listed_as: Sequence (?%s...) not recognized in regex; marked by <-- HERE in m/%s/ */
11058                     vFAIL2utf8f(
11059                         "Sequence (%" UTF8f "...) not recognized",
11060                         UTF8fARG(UTF, RExC_parse-seqstart, seqstart));
11061                     NOT_REACHED; /*NOTREACHED*/
11062                 }
11063                 *flagp |= POSTPONED;
11064                 paren = '{';
11065                 RExC_parse++;
11066                 /* FALLTHROUGH */
11067             case '{':           /* (?{...}) */
11068             {
11069                 U32 n = 0;
11070                 struct reg_code_block *cb;
11071
11072                 RExC_seen_zerolen++;
11073
11074                 if (   !pRExC_state->code_blocks
11075                     || pRExC_state->code_index
11076                                         >= pRExC_state->code_blocks->count
11077                     || pRExC_state->code_blocks->cb[pRExC_state->code_index].start
11078                         != (STRLEN)((RExC_parse -3 - (is_logical ? 1 : 0))
11079                             - RExC_start)
11080                 ) {
11081                     if (RExC_pm_flags & PMf_USE_RE_EVAL)
11082                         FAIL("panic: Sequence (?{...}): no code block found\n");
11083                     FAIL("Eval-group not allowed at runtime, use re 'eval'");
11084                 }
11085                 /* this is a pre-compiled code block (?{...}) */
11086                 cb = &pRExC_state->code_blocks->cb[pRExC_state->code_index];
11087                 RExC_parse = RExC_start + cb->end;
11088                 if (!SIZE_ONLY) {
11089                     OP *o = cb->block;
11090                     if (cb->src_regex) {
11091                         n = add_data(pRExC_state, STR_WITH_LEN("rl"));
11092                         RExC_rxi->data->data[n] =
11093                             (void*)SvREFCNT_inc((SV*)cb->src_regex);
11094                         RExC_rxi->data->data[n+1] = (void*)o;
11095                     }
11096                     else {
11097                         n = add_data(pRExC_state,
11098                                (RExC_pm_flags & PMf_HAS_CV) ? "L" : "l", 1);
11099                         RExC_rxi->data->data[n] = (void*)o;
11100                     }
11101                 }
11102                 pRExC_state->code_index++;
11103                 nextchar(pRExC_state);
11104
11105                 if (is_logical) {
11106                     regnode *eval;
11107                     ret = reg_node(pRExC_state, LOGICAL);
11108
11109                     eval = reg2Lanode(pRExC_state, EVAL,
11110                                        n,
11111
11112                                        /* for later propagation into (??{})
11113                                         * return value */
11114                                        RExC_flags & RXf_PMf_COMPILETIME
11115                                       );
11116                     if (!SIZE_ONLY) {
11117                         ret->flags = 2;
11118                     }
11119                     REGTAIL(pRExC_state, ret, eval);
11120                     /* deal with the length of this later - MJD */
11121                     return ret;
11122                 }
11123                 ret = reg2Lanode(pRExC_state, EVAL, n, 0);
11124                 Set_Node_Length(ret, RExC_parse - parse_start + 1);
11125                 Set_Node_Offset(ret, parse_start);
11126                 return ret;
11127             }
11128             case '(':           /* (?(?{...})...) and (?(?=...)...) */
11129             {
11130                 int is_define= 0;
11131                 const int DEFINE_len = sizeof("DEFINE") - 1;
11132                 if (RExC_parse[0] == '?') {        /* (?(?...)) */
11133                     if (   RExC_parse < RExC_end - 1
11134                         && (   RExC_parse[1] == '='
11135                             || RExC_parse[1] == '!'
11136                             || RExC_parse[1] == '<'
11137                             || RExC_parse[1] == '{')
11138                     ) { /* Lookahead or eval. */
11139                         I32 flag;
11140                         regnode *tail;
11141
11142                         ret = reg_node(pRExC_state, LOGICAL);
11143                         if (!SIZE_ONLY)
11144                             ret->flags = 1;
11145
11146                         tail = reg(pRExC_state, 1, &flag, depth+1);
11147                         if (flag & (RESTART_PASS1|NEED_UTF8)) {
11148                             *flagp = flag & (RESTART_PASS1|NEED_UTF8);
11149                             return NULL;
11150                         }
11151                         REGTAIL(pRExC_state, ret, tail);
11152                         goto insert_if;
11153                     }
11154                     /* Fall through to ‘Unknown switch condition’ at the
11155                        end of the if/else chain. */
11156                 }
11157                 else if ( RExC_parse[0] == '<'     /* (?(<NAME>)...) */
11158                          || RExC_parse[0] == '\'' ) /* (?('NAME')...) */
11159                 {
11160                     char ch = RExC_parse[0] == '<' ? '>' : '\'';
11161                     char *name_start= RExC_parse++;
11162                     U32 num = 0;
11163                     SV *sv_dat=reg_scan_name(pRExC_state,
11164                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
11165                     if (   RExC_parse == name_start
11166                         || RExC_parse >= RExC_end
11167                         || *RExC_parse != ch)
11168                     {
11169                         vFAIL2("Sequence (?(%c... not terminated",
11170                             (ch == '>' ? '<' : ch));
11171                     }
11172                     RExC_parse++;
11173                     if (!SIZE_ONLY) {
11174                         num = add_data( pRExC_state, STR_WITH_LEN("S"));
11175                         RExC_rxi->data->data[num]=(void*)sv_dat;
11176                         SvREFCNT_inc_simple_void(sv_dat);
11177                     }
11178                     ret = reganode(pRExC_state,NGROUPP,num);
11179                     goto insert_if_check_paren;
11180                 }
11181                 else if (memBEGINs(RExC_parse,
11182                                    (STRLEN) (RExC_end - RExC_parse),
11183                                    "DEFINE"))
11184                 {
11185                     ret = reganode(pRExC_state,DEFINEP,0);
11186                     RExC_parse += DEFINE_len;
11187                     is_define = 1;
11188                     goto insert_if_check_paren;
11189                 }
11190                 else if (RExC_parse[0] == 'R') {
11191                     RExC_parse++;
11192                     /* parno == 0 => /(?(R)YES|NO)/  "in any form of recursion OR eval"
11193                      * parno == 1 => /(?(R0)YES|NO)/ "in GOSUB (?0) / (?R)"
11194                      * parno == 2 => /(?(R1)YES|NO)/ "in GOSUB (?1) (parno-1)"
11195                      */
11196                     parno = 0;
11197                     if (RExC_parse[0] == '0') {
11198                         parno = 1;
11199                         RExC_parse++;
11200                     }
11201                     else if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
11202                         UV uv;
11203                         if (grok_atoUV(RExC_parse, &uv, &endptr)
11204                             && uv <= I32_MAX
11205                         ) {
11206                             parno = (I32)uv + 1;
11207                             RExC_parse = (char*)endptr;
11208                         }
11209                         /* else "Switch condition not recognized" below */
11210                     } else if (RExC_parse[0] == '&') {
11211                         SV *sv_dat;
11212                         RExC_parse++;
11213                         sv_dat = reg_scan_name(pRExC_state,
11214                             SIZE_ONLY
11215                             ? REG_RSN_RETURN_NULL
11216                             : REG_RSN_RETURN_DATA);
11217
11218                         /* we should only have a false sv_dat when
11219                          * SIZE_ONLY is true, and we always have false
11220                          * sv_dat when SIZE_ONLY is true.
11221                          * reg_scan_name() will VFAIL() if the name is
11222                          * unknown when SIZE_ONLY is false, and otherwise
11223                          * will return something, and when SIZE_ONLY is
11224                          * true, reg_scan_name() just parses the string,
11225                          * and doesnt return anything. (in theory) */
11226                         assert(SIZE_ONLY ? !sv_dat : !!sv_dat);
11227
11228                         if (sv_dat)
11229                             parno = 1 + *((I32 *)SvPVX(sv_dat));
11230                     }
11231                     ret = reganode(pRExC_state,INSUBP,parno);
11232                     goto insert_if_check_paren;
11233                 }
11234                 else if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
11235                     /* (?(1)...) */
11236                     char c;
11237                     UV uv;
11238                     if (grok_atoUV(RExC_parse, &uv, &endptr)
11239                         && uv <= I32_MAX
11240                     ) {
11241                         parno = (I32)uv;
11242                         RExC_parse = (char*)endptr;
11243                     }
11244                     else {
11245                         vFAIL("panic: grok_atoUV returned FALSE");
11246                     }
11247                     ret = reganode(pRExC_state, GROUPP, parno);
11248
11249                  insert_if_check_paren:
11250                     if (UCHARAT(RExC_parse) != ')') {
11251                         RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
11252                         vFAIL("Switch condition not recognized");
11253                     }
11254                     nextchar(pRExC_state);
11255                   insert_if:
11256                     REGTAIL(pRExC_state, ret, reganode(pRExC_state, IFTHEN, 0));
11257                     br = regbranch(pRExC_state, &flags, 1,depth+1);
11258                     if (br == NULL) {
11259                         if (flags & (RESTART_PASS1|NEED_UTF8)) {
11260                             *flagp = flags & (RESTART_PASS1|NEED_UTF8);
11261                             return NULL;
11262                         }
11263                         FAIL2("panic: regbranch returned NULL, flags=%#" UVxf,
11264                               (UV) flags);
11265                     } else
11266                         REGTAIL(pRExC_state, br, reganode(pRExC_state,
11267                                                           LONGJMP, 0));
11268                     c = UCHARAT(RExC_parse);
11269                     nextchar(pRExC_state);
11270                     if (flags&HASWIDTH)
11271                         *flagp |= HASWIDTH;
11272                     if (c == '|') {
11273                         if (is_define)
11274                             vFAIL("(?(DEFINE)....) does not allow branches");
11275
11276                         /* Fake one for optimizer.  */
11277                         lastbr = reganode(pRExC_state, IFTHEN, 0);
11278
11279                         if (!regbranch(pRExC_state, &flags, 1,depth+1)) {
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                         }
11287                         REGTAIL(pRExC_state, ret, lastbr);
11288                         if (flags&HASWIDTH)
11289                             *flagp |= HASWIDTH;
11290                         c = UCHARAT(RExC_parse);
11291                         nextchar(pRExC_state);
11292                     }
11293                     else
11294                         lastbr = NULL;
11295                     if (c != ')') {
11296                         if (RExC_parse >= RExC_end)
11297                             vFAIL("Switch (?(condition)... not terminated");
11298                         else
11299                             vFAIL("Switch (?(condition)... contains too many branches");
11300                     }
11301                     ender = reg_node(pRExC_state, TAIL);
11302                     REGTAIL(pRExC_state, br, ender);
11303                     if (lastbr) {
11304                         REGTAIL(pRExC_state, lastbr, ender);
11305                         REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender);
11306                     }
11307                     else
11308                         REGTAIL(pRExC_state, ret, ender);
11309                     RExC_size++; /* XXX WHY do we need this?!!
11310                                     For large programs it seems to be required
11311                                     but I can't figure out why. -- dmq*/
11312                     return ret;
11313                 }
11314                 RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
11315                 vFAIL("Unknown switch condition (?(...))");
11316             }
11317             case '[':           /* (?[ ... ]) */
11318                 return handle_regex_sets(pRExC_state, NULL, flagp, depth,
11319                                          oregcomp_parse);
11320             case 0: /* A NUL */
11321                 RExC_parse--; /* for vFAIL to print correctly */
11322                 vFAIL("Sequence (? incomplete");
11323                 break;
11324             default: /* e.g., (?i) */
11325                 RExC_parse = (char *) seqstart + 1;
11326               parse_flags:
11327                 parse_lparen_question_flags(pRExC_state);
11328                 if (UCHARAT(RExC_parse) != ':') {
11329                     if (RExC_parse < RExC_end)
11330                         nextchar(pRExC_state);
11331                     *flagp = TRYAGAIN;
11332                     return NULL;
11333                 }
11334                 paren = ':';
11335                 nextchar(pRExC_state);
11336                 ret = NULL;
11337                 goto parse_rest;
11338             } /* end switch */
11339         }
11340         else if (!(RExC_flags & RXf_PMf_NOCAPTURE)) {   /* (...) */
11341           capturing_parens:
11342             parno = RExC_npar;
11343             RExC_npar++;
11344
11345             ret = reganode(pRExC_state, OPEN, parno);
11346             if (!SIZE_ONLY ){
11347                 if (!RExC_nestroot)
11348                     RExC_nestroot = parno;
11349                 if (RExC_open_parens && !RExC_open_parens[parno])
11350                 {
11351                     DEBUG_OPTIMISE_MORE_r(Perl_re_printf( aTHX_
11352                         "%*s%*s Setting open paren #%" IVdf " to %d\n",
11353                         22, "|    |", (int)(depth * 2 + 1), "",
11354                         (IV)parno, REG_NODE_NUM(ret)));
11355                     RExC_open_parens[parno]= ret;
11356                 }
11357             }
11358             Set_Node_Length(ret, 1); /* MJD */
11359             Set_Node_Offset(ret, RExC_parse); /* MJD */
11360             is_open = 1;
11361         } else {
11362             /* with RXf_PMf_NOCAPTURE treat (...) as (?:...) */
11363             paren = ':';
11364             ret = NULL;
11365         }
11366     }
11367     else                        /* ! paren */
11368         ret = NULL;
11369
11370    parse_rest:
11371     /* Pick up the branches, linking them together. */
11372     parse_start = RExC_parse;   /* MJD */
11373     br = regbranch(pRExC_state, &flags, 1,depth+1);
11374
11375     /*     branch_len = (paren != 0); */
11376
11377     if (br == NULL) {
11378         if (flags & (RESTART_PASS1|NEED_UTF8)) {
11379             *flagp = flags & (RESTART_PASS1|NEED_UTF8);
11380             return NULL;
11381         }
11382         FAIL2("panic: regbranch returned NULL, flags=%#" UVxf, (UV) flags);
11383     }
11384     if (*RExC_parse == '|') {
11385         if (!SIZE_ONLY && RExC_extralen) {
11386             reginsert(pRExC_state, BRANCHJ, br, depth+1);
11387         }
11388         else {                  /* MJD */
11389             reginsert(pRExC_state, BRANCH, br, depth+1);
11390             Set_Node_Length(br, paren != 0);
11391             Set_Node_Offset_To_R(br-RExC_emit_start, parse_start-RExC_start);
11392         }
11393         have_branch = 1;
11394         if (SIZE_ONLY)
11395             RExC_extralen += 1;         /* For BRANCHJ-BRANCH. */
11396     }
11397     else if (paren == ':') {
11398         *flagp |= flags&SIMPLE;
11399     }
11400     if (is_open) {                              /* Starts with OPEN. */
11401         REGTAIL(pRExC_state, ret, br);          /* OPEN -> first. */
11402     }
11403     else if (paren != '?')              /* Not Conditional */
11404         ret = br;
11405     *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
11406     lastbr = br;
11407     while (*RExC_parse == '|') {
11408         if (!SIZE_ONLY && RExC_extralen) {
11409             ender = reganode(pRExC_state, LONGJMP,0);
11410
11411             /* Append to the previous. */
11412             REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender);
11413         }
11414         if (SIZE_ONLY)
11415             RExC_extralen += 2;         /* Account for LONGJMP. */
11416         nextchar(pRExC_state);
11417         if (freeze_paren) {
11418             if (RExC_npar > after_freeze)
11419                 after_freeze = RExC_npar;
11420             RExC_npar = freeze_paren;
11421         }
11422         br = regbranch(pRExC_state, &flags, 0, depth+1);
11423
11424         if (br == NULL) {
11425             if (flags & (RESTART_PASS1|NEED_UTF8)) {
11426                 *flagp = flags & (RESTART_PASS1|NEED_UTF8);
11427                 return NULL;
11428             }
11429             FAIL2("panic: regbranch returned NULL, flags=%#" UVxf, (UV) flags);
11430         }
11431         REGTAIL(pRExC_state, lastbr, br);               /* BRANCH -> BRANCH. */
11432         lastbr = br;
11433         *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
11434     }
11435
11436     if (have_branch || paren != ':') {
11437         /* Make a closing node, and hook it on the end. */
11438         switch (paren) {
11439         case ':':
11440             ender = reg_node(pRExC_state, TAIL);
11441             break;
11442         case 1: case 2:
11443             ender = reganode(pRExC_state, CLOSE, parno);
11444             if ( RExC_close_parens ) {
11445                 DEBUG_OPTIMISE_MORE_r(Perl_re_printf( aTHX_
11446                         "%*s%*s Setting close paren #%" IVdf " to %d\n",
11447                         22, "|    |", (int)(depth * 2 + 1), "", (IV)parno, REG_NODE_NUM(ender)));
11448                 RExC_close_parens[parno]= ender;
11449                 if (RExC_nestroot == parno)
11450                     RExC_nestroot = 0;
11451             }
11452             Set_Node_Offset(ender,RExC_parse+1); /* MJD */
11453             Set_Node_Length(ender,1); /* MJD */
11454             break;
11455         case '<':
11456         case ',':
11457         case '=':
11458         case '!':
11459             *flagp &= ~HASWIDTH;
11460             /* FALLTHROUGH */
11461         case '>':
11462             ender = reg_node(pRExC_state, SUCCEED);
11463             break;
11464         case 0:
11465             ender = reg_node(pRExC_state, END);
11466             if (!SIZE_ONLY) {
11467                 assert(!RExC_end_op); /* there can only be one! */
11468                 RExC_end_op = ender;
11469                 if (RExC_close_parens) {
11470                     DEBUG_OPTIMISE_MORE_r(Perl_re_printf( aTHX_
11471                         "%*s%*s Setting close paren #0 (END) to %d\n",
11472                         22, "|    |", (int)(depth * 2 + 1), "", REG_NODE_NUM(ender)));
11473
11474                     RExC_close_parens[0]= ender;
11475                 }
11476             }
11477             break;
11478         }
11479         DEBUG_PARSE_r(if (!SIZE_ONLY) {
11480             DEBUG_PARSE_MSG("lsbr");
11481             regprop(RExC_rx, RExC_mysv1, lastbr, NULL, pRExC_state);
11482             regprop(RExC_rx, RExC_mysv2, ender, NULL, pRExC_state);
11483             Perl_re_printf( aTHX_  "~ tying lastbr %s (%" IVdf ") to ender %s (%" IVdf ") offset %" IVdf "\n",
11484                           SvPV_nolen_const(RExC_mysv1),
11485                           (IV)REG_NODE_NUM(lastbr),
11486                           SvPV_nolen_const(RExC_mysv2),
11487                           (IV)REG_NODE_NUM(ender),
11488                           (IV)(ender - lastbr)
11489             );
11490         });
11491         REGTAIL(pRExC_state, lastbr, ender);
11492
11493         if (have_branch && !SIZE_ONLY) {
11494             char is_nothing= 1;
11495             if (depth==1)
11496                 RExC_seen |= REG_TOP_LEVEL_BRANCHES_SEEN;
11497
11498             /* Hook the tails of the branches to the closing node. */
11499             for (br = ret; br; br = regnext(br)) {
11500                 const U8 op = PL_regkind[OP(br)];
11501                 if (op == BRANCH) {
11502                     REGTAIL_STUDY(pRExC_state, NEXTOPER(br), ender);
11503                     if ( OP(NEXTOPER(br)) != NOTHING
11504                          || regnext(NEXTOPER(br)) != ender)
11505                         is_nothing= 0;
11506                 }
11507                 else if (op == BRANCHJ) {
11508                     REGTAIL_STUDY(pRExC_state, NEXTOPER(NEXTOPER(br)), ender);
11509                     /* for now we always disable this optimisation * /
11510                     if ( OP(NEXTOPER(NEXTOPER(br))) != NOTHING
11511                          || regnext(NEXTOPER(NEXTOPER(br))) != ender)
11512                     */
11513                         is_nothing= 0;
11514                 }
11515             }
11516             if (is_nothing) {
11517                 br= PL_regkind[OP(ret)] != BRANCH ? regnext(ret) : ret;
11518                 DEBUG_PARSE_r(if (!SIZE_ONLY) {
11519                     DEBUG_PARSE_MSG("NADA");
11520                     regprop(RExC_rx, RExC_mysv1, ret, NULL, pRExC_state);
11521                     regprop(RExC_rx, RExC_mysv2, ender, NULL, pRExC_state);
11522                     Perl_re_printf( aTHX_  "~ converting ret %s (%" IVdf ") to ender %s (%" IVdf ") offset %" IVdf "\n",
11523                                   SvPV_nolen_const(RExC_mysv1),
11524                                   (IV)REG_NODE_NUM(ret),
11525                                   SvPV_nolen_const(RExC_mysv2),
11526                                   (IV)REG_NODE_NUM(ender),
11527                                   (IV)(ender - ret)
11528                     );
11529                 });
11530                 OP(br)= NOTHING;
11531                 if (OP(ender) == TAIL) {
11532                     NEXT_OFF(br)= 0;
11533                     RExC_emit= br + 1;
11534                 } else {
11535                     regnode *opt;
11536                     for ( opt= br + 1; opt < ender ; opt++ )
11537                         OP(opt)= OPTIMIZED;
11538                     NEXT_OFF(br)= ender - br;
11539                 }
11540             }
11541         }
11542     }
11543
11544     {
11545         const char *p;
11546         static const char parens[] = "=!<,>";
11547
11548         if (paren && (p = strchr(parens, paren))) {
11549             U8 node = ((p - parens) % 2) ? UNLESSM : IFMATCH;
11550             int flag = (p - parens) > 1;
11551
11552             if (paren == '>')
11553                 node = SUSPEND, flag = 0;
11554             reginsert(pRExC_state, node,ret, depth+1);
11555             Set_Node_Cur_Length(ret, parse_start);
11556             Set_Node_Offset(ret, parse_start + 1);
11557             ret->flags = flag;
11558             REGTAIL_STUDY(pRExC_state, ret, reg_node(pRExC_state, TAIL));
11559         }
11560     }
11561
11562     /* Check for proper termination. */
11563     if (paren) {
11564         /* restore original flags, but keep (?p) and, if we've changed from /d
11565          * rules to /u, keep the /u */
11566         RExC_flags = oregflags | (RExC_flags & RXf_PMf_KEEPCOPY);
11567         if (DEPENDS_SEMANTICS && RExC_uni_semantics) {
11568             set_regex_charset(&RExC_flags, REGEX_UNICODE_CHARSET);
11569         }
11570         if (RExC_parse >= RExC_end || UCHARAT(RExC_parse) != ')') {
11571             RExC_parse = oregcomp_parse;
11572             vFAIL("Unmatched (");
11573         }
11574         nextchar(pRExC_state);
11575     }
11576     else if (!paren && RExC_parse < RExC_end) {
11577         if (*RExC_parse == ')') {
11578             RExC_parse++;
11579             vFAIL("Unmatched )");
11580         }
11581         else
11582             FAIL("Junk on end of regexp");      /* "Can't happen". */
11583         NOT_REACHED; /* NOTREACHED */
11584     }
11585
11586     if (RExC_in_lookbehind) {
11587         RExC_in_lookbehind--;
11588     }
11589     if (after_freeze > RExC_npar)
11590         RExC_npar = after_freeze;
11591     return(ret);
11592 }
11593
11594 /*
11595  - regbranch - one alternative of an | operator
11596  *
11597  * Implements the concatenation operator.
11598  *
11599  * Returns NULL, setting *flagp to RESTART_PASS1 if the sizing scan needs to be
11600  * restarted, or'd with NEED_UTF8 if the pattern needs to be upgraded to UTF-8
11601  */
11602 STATIC regnode *
11603 S_regbranch(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, I32 first, U32 depth)
11604 {
11605     regnode *ret;
11606     regnode *chain = NULL;
11607     regnode *latest;
11608     I32 flags = 0, c = 0;
11609     GET_RE_DEBUG_FLAGS_DECL;
11610
11611     PERL_ARGS_ASSERT_REGBRANCH;
11612
11613     DEBUG_PARSE("brnc");
11614
11615     if (first)
11616         ret = NULL;
11617     else {
11618         if (!SIZE_ONLY && RExC_extralen)
11619             ret = reganode(pRExC_state, BRANCHJ,0);
11620         else {
11621             ret = reg_node(pRExC_state, BRANCH);
11622             Set_Node_Length(ret, 1);
11623         }
11624     }
11625
11626     if (!first && SIZE_ONLY)
11627         RExC_extralen += 1;                     /* BRANCHJ */
11628
11629     *flagp = WORST;                     /* Tentatively. */
11630
11631     skip_to_be_ignored_text(pRExC_state, &RExC_parse,
11632                             FALSE /* Don't force to /x */ );
11633     while (RExC_parse < RExC_end && *RExC_parse != '|' && *RExC_parse != ')') {
11634         flags &= ~TRYAGAIN;
11635         latest = regpiece(pRExC_state, &flags,depth+1);
11636         if (latest == NULL) {
11637             if (flags & TRYAGAIN)
11638                 continue;
11639             if (flags & (RESTART_PASS1|NEED_UTF8)) {
11640                 *flagp = flags & (RESTART_PASS1|NEED_UTF8);
11641                 return NULL;
11642             }
11643             FAIL2("panic: regpiece returned NULL, flags=%#" UVxf, (UV) flags);
11644         }
11645         else if (ret == NULL)
11646             ret = latest;
11647         *flagp |= flags&(HASWIDTH|POSTPONED);
11648         if (chain == NULL)      /* First piece. */
11649             *flagp |= flags&SPSTART;
11650         else {
11651             /* FIXME adding one for every branch after the first is probably
11652              * excessive now we have TRIE support. (hv) */
11653             MARK_NAUGHTY(1);
11654             REGTAIL(pRExC_state, chain, latest);
11655         }
11656         chain = latest;
11657         c++;
11658     }
11659     if (chain == NULL) {        /* Loop ran zero times. */
11660         chain = reg_node(pRExC_state, NOTHING);
11661         if (ret == NULL)
11662             ret = chain;
11663     }
11664     if (c == 1) {
11665         *flagp |= flags&SIMPLE;
11666     }
11667
11668     return ret;
11669 }
11670
11671 /*
11672  - regpiece - something followed by possible quantifier * + ? {n,m}
11673  *
11674  * Note that the branching code sequences used for ? and the general cases
11675  * of * and + are somewhat optimized:  they use the same NOTHING node as
11676  * both the endmarker for their branch list and the body of the last branch.
11677  * It might seem that this node could be dispensed with entirely, but the
11678  * endmarker role is not redundant.
11679  *
11680  * Returns NULL, setting *flagp to TRYAGAIN if regatom() returns NULL with
11681  * TRYAGAIN.
11682  * Returns NULL, setting *flagp to RESTART_PASS1 if the sizing scan needs to be
11683  * restarted, or'd with NEED_UTF8 if the pattern needs to be upgraded to UTF-8
11684  */
11685 STATIC regnode *
11686 S_regpiece(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
11687 {
11688     regnode *ret;
11689     char op;
11690     char *next;
11691     I32 flags;
11692     const char * const origparse = RExC_parse;
11693     I32 min;
11694     I32 max = REG_INFTY;
11695 #ifdef RE_TRACK_PATTERN_OFFSETS
11696     char *parse_start;
11697 #endif
11698     const char *maxpos = NULL;
11699     UV uv;
11700
11701     /* Save the original in case we change the emitted regop to a FAIL. */
11702     regnode * const orig_emit = RExC_emit;
11703
11704     GET_RE_DEBUG_FLAGS_DECL;
11705
11706     PERL_ARGS_ASSERT_REGPIECE;
11707
11708     DEBUG_PARSE("piec");
11709
11710     ret = regatom(pRExC_state, &flags,depth+1);
11711     if (ret == NULL) {
11712         if (flags & (TRYAGAIN|RESTART_PASS1|NEED_UTF8))
11713             *flagp |= flags & (TRYAGAIN|RESTART_PASS1|NEED_UTF8);
11714         else
11715             FAIL2("panic: regatom returned NULL, flags=%#" UVxf, (UV) flags);
11716         return(NULL);
11717     }
11718
11719     op = *RExC_parse;
11720
11721     if (op == '{' && regcurly(RExC_parse)) {
11722         maxpos = NULL;
11723 #ifdef RE_TRACK_PATTERN_OFFSETS
11724         parse_start = RExC_parse; /* MJD */
11725 #endif
11726         next = RExC_parse + 1;
11727         while (isDIGIT(*next) || *next == ',') {
11728             if (*next == ',') {
11729                 if (maxpos)
11730                     break;
11731                 else
11732                     maxpos = next;
11733             }
11734             next++;
11735         }
11736         if (*next == '}') {             /* got one */
11737             const char* endptr;
11738             if (!maxpos)
11739                 maxpos = next;
11740             RExC_parse++;
11741             if (isDIGIT(*RExC_parse)) {
11742                 if (!grok_atoUV(RExC_parse, &uv, &endptr))
11743                     vFAIL("Invalid quantifier in {,}");
11744                 if (uv >= REG_INFTY)
11745                     vFAIL2("Quantifier in {,} bigger than %d", REG_INFTY - 1);
11746                 min = (I32)uv;
11747             } else {
11748                 min = 0;
11749             }
11750             if (*maxpos == ',')
11751                 maxpos++;
11752             else
11753                 maxpos = RExC_parse;
11754             if (isDIGIT(*maxpos)) {
11755                 if (!grok_atoUV(maxpos, &uv, &endptr))
11756                     vFAIL("Invalid quantifier in {,}");
11757                 if (uv >= REG_INFTY)
11758                     vFAIL2("Quantifier in {,} bigger than %d", REG_INFTY - 1);
11759                 max = (I32)uv;
11760             } else {
11761                 max = REG_INFTY;                /* meaning "infinity" */
11762             }
11763             RExC_parse = next;
11764             nextchar(pRExC_state);
11765             if (max < min) {    /* If can't match, warn and optimize to fail
11766                                    unconditionally */
11767                 reginsert(pRExC_state, OPFAIL, orig_emit, depth+1);
11768                 if (PASS2) {
11769                     ckWARNreg(RExC_parse, "Quantifier {n,m} with n > m can't match");
11770                     NEXT_OFF(orig_emit)= regarglen[OPFAIL] + NODE_STEP_REGNODE;
11771                 }
11772                 return ret;
11773             }
11774             else if (min == max && *RExC_parse == '?')
11775             {
11776                 if (PASS2) {
11777                     ckWARN2reg(RExC_parse + 1,
11778                                "Useless use of greediness modifier '%c'",
11779                                *RExC_parse);
11780                 }
11781             }
11782
11783           do_curly:
11784             if ((flags&SIMPLE)) {
11785                 if (min == 0 && max == REG_INFTY) {
11786                     reginsert(pRExC_state, STAR, ret, depth+1);
11787                     MARK_NAUGHTY(4);
11788                     RExC_seen |= REG_UNBOUNDED_QUANTIFIER_SEEN;
11789                     goto nest_check;
11790                 }
11791                 if (min == 1 && max == REG_INFTY) {
11792                     reginsert(pRExC_state, PLUS, ret, depth+1);
11793                     MARK_NAUGHTY(3);
11794                     RExC_seen |= REG_UNBOUNDED_QUANTIFIER_SEEN;
11795                     goto nest_check;
11796                 }
11797                 MARK_NAUGHTY_EXP(2, 2);
11798                 reginsert(pRExC_state, CURLY, ret, depth+1);
11799                 Set_Node_Offset(ret, parse_start+1); /* MJD */
11800                 Set_Node_Cur_Length(ret, parse_start);
11801             }
11802             else {
11803                 regnode * const w = reg_node(pRExC_state, WHILEM);
11804
11805                 w->flags = 0;
11806                 REGTAIL(pRExC_state, ret, w);
11807                 if (!SIZE_ONLY && RExC_extralen) {
11808                     reginsert(pRExC_state, LONGJMP,ret, depth+1);
11809                     reginsert(pRExC_state, NOTHING,ret, depth+1);
11810                     NEXT_OFF(ret) = 3;  /* Go over LONGJMP. */
11811                 }
11812                 reginsert(pRExC_state, CURLYX,ret, depth+1);
11813                                 /* MJD hk */
11814                 Set_Node_Offset(ret, parse_start+1);
11815                 Set_Node_Length(ret,
11816                                 op == '{' ? (RExC_parse - parse_start) : 1);
11817
11818                 if (!SIZE_ONLY && RExC_extralen)
11819                     NEXT_OFF(ret) = 3;  /* Go over NOTHING to LONGJMP. */
11820                 REGTAIL(pRExC_state, ret, reg_node(pRExC_state, NOTHING));
11821                 if (SIZE_ONLY)
11822                     RExC_whilem_seen++, RExC_extralen += 3;
11823                 MARK_NAUGHTY_EXP(1, 4);     /* compound interest */
11824             }
11825             ret->flags = 0;
11826
11827             if (min > 0)
11828                 *flagp = WORST;
11829             if (max > 0)
11830                 *flagp |= HASWIDTH;
11831             if (!SIZE_ONLY) {
11832                 ARG1_SET(ret, (U16)min);
11833                 ARG2_SET(ret, (U16)max);
11834             }
11835             if (max == REG_INFTY)
11836                 RExC_seen |= REG_UNBOUNDED_QUANTIFIER_SEEN;
11837
11838             goto nest_check;
11839         }
11840     }
11841
11842     if (!ISMULT1(op)) {
11843         *flagp = flags;
11844         return(ret);
11845     }
11846
11847 #if 0                           /* Now runtime fix should be reliable. */
11848
11849     /* if this is reinstated, don't forget to put this back into perldiag:
11850
11851             =item Regexp *+ operand could be empty at {#} in regex m/%s/
11852
11853            (F) The part of the regexp subject to either the * or + quantifier
11854            could match an empty string. The {#} shows in the regular
11855            expression about where the problem was discovered.
11856
11857     */
11858
11859     if (!(flags&HASWIDTH) && op != '?')
11860       vFAIL("Regexp *+ operand could be empty");
11861 #endif
11862
11863 #ifdef RE_TRACK_PATTERN_OFFSETS
11864     parse_start = RExC_parse;
11865 #endif
11866     nextchar(pRExC_state);
11867
11868     *flagp = (op != '+') ? (WORST|SPSTART|HASWIDTH) : (WORST|HASWIDTH);
11869
11870     if (op == '*') {
11871         min = 0;
11872         goto do_curly;
11873     }
11874     else if (op == '+') {
11875         min = 1;
11876         goto do_curly;
11877     }
11878     else if (op == '?') {
11879         min = 0; max = 1;
11880         goto do_curly;
11881     }
11882   nest_check:
11883     if (!SIZE_ONLY && !(flags&(HASWIDTH|POSTPONED)) && max > REG_INFTY/3) {
11884         SAVEFREESV(RExC_rx_sv); /* in case of fatal warnings */
11885         ckWARN2reg(RExC_parse,
11886                    "%" UTF8f " matches null string many times",
11887                    UTF8fARG(UTF, (RExC_parse >= origparse
11888                                  ? RExC_parse - origparse
11889                                  : 0),
11890                    origparse));
11891         (void)ReREFCNT_inc(RExC_rx_sv);
11892     }
11893
11894     if (*RExC_parse == '?') {
11895         nextchar(pRExC_state);
11896         reginsert(pRExC_state, MINMOD, ret, depth+1);
11897         REGTAIL(pRExC_state, ret, ret + NODE_STEP_REGNODE);
11898     }
11899     else if (*RExC_parse == '+') {
11900         regnode *ender;
11901         nextchar(pRExC_state);
11902         ender = reg_node(pRExC_state, SUCCEED);
11903         REGTAIL(pRExC_state, ret, ender);
11904         reginsert(pRExC_state, SUSPEND, ret, depth+1);
11905         ender = reg_node(pRExC_state, TAIL);
11906         REGTAIL(pRExC_state, ret, ender);
11907     }
11908
11909     if (ISMULT2(RExC_parse)) {
11910         RExC_parse++;
11911         vFAIL("Nested quantifiers");
11912     }
11913
11914     return(ret);
11915 }
11916
11917 STATIC bool
11918 S_grok_bslash_N(pTHX_ RExC_state_t *pRExC_state,
11919                 regnode ** node_p,
11920                 UV * code_point_p,
11921                 int * cp_count,
11922                 I32 * flagp,
11923                 const bool strict,
11924                 const U32 depth
11925     )
11926 {
11927  /* This routine teases apart the various meanings of \N and returns
11928   * accordingly.  The input parameters constrain which meaning(s) is/are valid
11929   * in the current context.
11930   *
11931   * Exactly one of <node_p> and <code_point_p> must be non-NULL.
11932   *
11933   * If <code_point_p> is not NULL, the context is expecting the result to be a
11934   * single code point.  If this \N instance turns out to a single code point,
11935   * the function returns TRUE and sets *code_point_p to that code point.
11936   *
11937   * If <node_p> is not NULL, the context is expecting the result to be one of
11938   * the things representable by a regnode.  If this \N instance turns out to be
11939   * one such, the function generates the regnode, returns TRUE and sets *node_p
11940   * to point to that regnode.
11941   *
11942   * If this instance of \N isn't legal in any context, this function will
11943   * generate a fatal error and not return.
11944   *
11945   * On input, RExC_parse should point to the first char following the \N at the
11946   * time of the call.  On successful return, RExC_parse will have been updated
11947   * to point to just after the sequence identified by this routine.  Also
11948   * *flagp has been updated as needed.
11949   *
11950   * When there is some problem with the current context and this \N instance,
11951   * the function returns FALSE, without advancing RExC_parse, nor setting
11952   * *node_p, nor *code_point_p, nor *flagp.
11953   *
11954   * If <cp_count> is not NULL, the caller wants to know the length (in code
11955   * points) that this \N sequence matches.  This is set even if the function
11956   * returns FALSE, as detailed below.
11957   *
11958   * There are 5 possibilities here, as detailed in the next 5 paragraphs.
11959   *
11960   * Probably the most common case is for the \N to specify a single code point.
11961   * *cp_count will be set to 1, and *code_point_p will be set to that code
11962   * point.
11963   *
11964   * Another possibility is for the input to be an empty \N{}, which for
11965   * backwards compatibility we accept.  *cp_count will be set to 0. *node_p
11966   * will be set to a generated NOTHING node.
11967   *
11968   * Still another possibility is for the \N to mean [^\n]. *cp_count will be
11969   * set to 0. *node_p will be set to a generated REG_ANY node.
11970   *
11971   * The fourth possibility is that \N resolves to a sequence of more than one
11972   * code points.  *cp_count will be set to the number of code points in the
11973   * sequence. *node_p * will be set to a generated node returned by this
11974   * function calling S_reg().
11975   *
11976   * The final possibility is that it is premature to be calling this function;
11977   * that pass1 needs to be restarted.  This can happen when this changes from
11978   * /d to /u rules, or when the pattern needs to be upgraded to UTF-8.  The
11979   * latter occurs only when the fourth possibility would otherwise be in
11980   * effect, and is because one of those code points requires the pattern to be
11981   * recompiled as UTF-8.  The function returns FALSE, and sets the
11982   * RESTART_PASS1 and NEED_UTF8 flags in *flagp, as appropriate.  When this
11983   * happens, the caller needs to desist from continuing parsing, and return
11984   * this information to its caller.  This is not set for when there is only one
11985   * code point, as this can be called as part of an ANYOF node, and they can
11986   * store above-Latin1 code points without the pattern having to be in UTF-8.
11987   *
11988   * For non-single-quoted regexes, the tokenizer has resolved character and
11989   * sequence names inside \N{...} into their Unicode values, normalizing the
11990   * result into what we should see here: '\N{U+c1.c2...}', where c1... are the
11991   * hex-represented code points in the sequence.  This is done there because
11992   * the names can vary based on what charnames pragma is in scope at the time,
11993   * so we need a way to take a snapshot of what they resolve to at the time of
11994   * the original parse. [perl #56444].
11995   *
11996   * That parsing is skipped for single-quoted regexes, so we may here get
11997   * '\N{NAME}'.  This is a fatal error.  These names have to be resolved by the
11998   * parser.  But if the single-quoted regex is something like '\N{U+41}', that
11999   * is legal and handled here.  The code point is Unicode, and has to be
12000   * translated into the native character set for non-ASCII platforms.
12001   */
12002
12003     char * endbrace;    /* points to '}' following the name */
12004     char *endchar;      /* Points to '.' or '}' ending cur char in the input
12005                            stream */
12006     char* p = RExC_parse; /* Temporary */
12007
12008     GET_RE_DEBUG_FLAGS_DECL;
12009
12010     PERL_ARGS_ASSERT_GROK_BSLASH_N;
12011
12012     GET_RE_DEBUG_FLAGS;
12013
12014     assert(cBOOL(node_p) ^ cBOOL(code_point_p));  /* Exactly one should be set */
12015     assert(! (node_p && cp_count));               /* At most 1 should be set */
12016
12017     if (cp_count) {     /* Initialize return for the most common case */
12018         *cp_count = 1;
12019     }
12020
12021     /* The [^\n] meaning of \N ignores spaces and comments under the /x
12022      * modifier.  The other meanings do not, so use a temporary until we find
12023      * out which we are being called with */
12024     skip_to_be_ignored_text(pRExC_state, &p,
12025                             FALSE /* Don't force to /x */ );
12026
12027     /* Disambiguate between \N meaning a named character versus \N meaning
12028      * [^\n].  The latter is assumed when the {...} following the \N is a legal
12029      * quantifier, or there is no '{' at all */
12030     if (*p != '{' || regcurly(p)) {
12031         RExC_parse = p;
12032         if (cp_count) {
12033             *cp_count = -1;
12034         }
12035
12036         if (! node_p) {
12037             return FALSE;
12038         }
12039
12040         *node_p = reg_node(pRExC_state, REG_ANY);
12041         *flagp |= HASWIDTH|SIMPLE;
12042         MARK_NAUGHTY(1);
12043         Set_Node_Length(*node_p, 1); /* MJD */
12044         return TRUE;
12045     }
12046
12047     /* Here, we have decided it should be a named character or sequence */
12048
12049     /* The test above made sure that the next real character is a '{', but
12050      * under the /x modifier, it could be separated by space (or a comment and
12051      * \n) and this is not allowed (for consistency with \x{...} and the
12052      * tokenizer handling of \N{NAME}). */
12053     if (*RExC_parse != '{') {
12054         vFAIL("Missing braces on \\N{}");
12055     }
12056
12057     RExC_parse++;       /* Skip past the '{' */
12058
12059     endbrace = (char *) memchr(RExC_parse, '}', RExC_end - RExC_parse);
12060     if (! endbrace) { /* no trailing brace */
12061         vFAIL2("Missing right brace on \\%c{}", 'N');
12062     }
12063     else if (!(   endbrace == RExC_parse        /* nothing between the {} */
12064                || memBEGINs(RExC_parse,   /* U+ (bad hex is checked below
12065                                                    for a  better error msg) */
12066                                   (STRLEN) (RExC_end - RExC_parse),
12067                                  "U+")))
12068     {
12069         RExC_parse = endbrace;  /* position msg's '<--HERE' */
12070         vFAIL("\\N{NAME} must be resolved by the lexer");
12071     }
12072
12073     REQUIRE_UNI_RULES(flagp, FALSE); /* Unicode named chars imply Unicode
12074                                         semantics */
12075
12076     if (endbrace == RExC_parse) {   /* empty: \N{} */
12077         if (strict) {
12078             RExC_parse++;   /* Position after the "}" */
12079             vFAIL("Zero length \\N{}");
12080         }
12081         if (cp_count) {
12082             *cp_count = 0;
12083         }
12084         nextchar(pRExC_state);
12085         if (! node_p) {
12086             return FALSE;
12087         }
12088
12089         *node_p = reg_node(pRExC_state,NOTHING);
12090         return TRUE;
12091     }
12092
12093     RExC_parse += 2;    /* Skip past the 'U+' */
12094
12095     /* Because toke.c has generated a special construct for us guaranteed not
12096      * to have NULs, we can use a str function */
12097     endchar = RExC_parse + strcspn(RExC_parse, ".}");
12098
12099     /* Code points are separated by dots.  If none, there is only one code
12100      * point, and is terminated by the brace */
12101
12102     if (endchar >= endbrace) {
12103         STRLEN length_of_hex;
12104         I32 grok_hex_flags;
12105
12106         /* Here, exactly one code point.  If that isn't what is wanted, fail */
12107         if (! code_point_p) {
12108             RExC_parse = p;
12109             return FALSE;
12110         }
12111
12112         /* Convert code point from hex */
12113         length_of_hex = (STRLEN)(endchar - RExC_parse);
12114         grok_hex_flags = PERL_SCAN_ALLOW_UNDERSCORES
12115                        | PERL_SCAN_DISALLOW_PREFIX
12116
12117                            /* No errors in the first pass (See [perl
12118                             * #122671].)  We let the code below find the
12119                             * errors when there are multiple chars. */
12120                        | ((SIZE_ONLY)
12121                           ? PERL_SCAN_SILENT_ILLDIGIT
12122                           : 0);
12123
12124         /* This routine is the one place where both single- and double-quotish
12125          * \N{U+xxxx} are evaluated.  The value is a Unicode code point which
12126          * must be converted to native. */
12127         *code_point_p = UNI_TO_NATIVE(grok_hex(RExC_parse,
12128                                                &length_of_hex,
12129                                                &grok_hex_flags,
12130                                                NULL));
12131
12132         /* The tokenizer should have guaranteed validity, but it's possible to
12133          * bypass it by using single quoting, so check.  Don't do the check
12134          * here when there are multiple chars; we do it below anyway. */
12135         if (length_of_hex == 0
12136             || length_of_hex != (STRLEN)(endchar - RExC_parse) )
12137         {
12138             RExC_parse += length_of_hex;        /* Includes all the valid */
12139             RExC_parse += (RExC_orig_utf8)      /* point to after 1st invalid */
12140                             ? UTF8SKIP(RExC_parse)
12141                             : 1;
12142             /* Guard against malformed utf8 */
12143             if (RExC_parse >= endchar) {
12144                 RExC_parse = endchar;
12145             }
12146             vFAIL("Invalid hexadecimal number in \\N{U+...}");
12147         }
12148
12149         RExC_parse = endbrace + 1;
12150         return TRUE;
12151     }
12152     else {  /* Is a multiple character sequence */
12153         SV * substitute_parse;
12154         STRLEN len;
12155         char *orig_end = RExC_end;
12156         char *save_start = RExC_start;
12157         I32 flags;
12158
12159         /* Count the code points, if desired, in the sequence */
12160         if (cp_count) {
12161             *cp_count = 0;
12162             while (RExC_parse < endbrace) {
12163                 /* Point to the beginning of the next character in the sequence. */
12164                 RExC_parse = endchar + 1;
12165                 endchar = RExC_parse + strcspn(RExC_parse, ".}");
12166                 (*cp_count)++;
12167             }
12168         }
12169
12170         /* Fail if caller doesn't want to handle a multi-code-point sequence.
12171          * But don't backup up the pointer if the caller wants to know how many
12172          * code points there are (they can then handle things) */
12173         if (! node_p) {
12174             if (! cp_count) {
12175                 RExC_parse = p;
12176             }
12177             return FALSE;
12178         }
12179
12180         /* What is done here is to convert this to a sub-pattern of the form
12181          * \x{char1}\x{char2}...  and then call reg recursively to parse it
12182          * (enclosing in "(?: ... )" ).  That way, it retains its atomicness,
12183          * while not having to worry about special handling that some code
12184          * points may have. */
12185
12186         substitute_parse = newSVpvs("?:");
12187
12188         while (RExC_parse < endbrace) {
12189
12190             /* Convert to notation the rest of the code understands */
12191             sv_catpv(substitute_parse, "\\x{");
12192             sv_catpvn(substitute_parse, RExC_parse, endchar - RExC_parse);
12193             sv_catpv(substitute_parse, "}");
12194
12195             /* Point to the beginning of the next character in the sequence. */
12196             RExC_parse = endchar + 1;
12197             endchar = RExC_parse + strcspn(RExC_parse, ".}");
12198
12199         }
12200         sv_catpv(substitute_parse, ")");
12201
12202         len = SvCUR(substitute_parse);
12203
12204         /* Don't allow empty number */
12205         if (len < (STRLEN) 8) {
12206             RExC_parse = endbrace;
12207             vFAIL("Invalid hexadecimal number in \\N{U+...}");
12208         }
12209
12210         RExC_parse = RExC_start = RExC_adjusted_start
12211                                               = SvPV_nolen(substitute_parse);
12212         RExC_end = RExC_parse + len;
12213
12214         /* The values are Unicode, and therefore not subject to recoding, but
12215          * have to be converted to native on a non-Unicode (meaning non-ASCII)
12216          * platform. */
12217 #ifdef EBCDIC
12218         RExC_recode_x_to_native = 1;
12219 #endif
12220
12221         *node_p = reg(pRExC_state, 1, &flags, depth+1);
12222
12223         /* Restore the saved values */
12224         RExC_start = RExC_adjusted_start = save_start;
12225         RExC_parse = endbrace;
12226         RExC_end = orig_end;
12227 #ifdef EBCDIC
12228         RExC_recode_x_to_native = 0;
12229 #endif
12230         SvREFCNT_dec_NN(substitute_parse);
12231
12232         if (! *node_p) {
12233             if (flags & (RESTART_PASS1|NEED_UTF8)) {
12234                 *flagp = flags & (RESTART_PASS1|NEED_UTF8);
12235                 return FALSE;
12236             }
12237             FAIL2("panic: reg returned NULL to grok_bslash_N, flags=%#" UVxf,
12238                 (UV) flags);
12239         }
12240         *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
12241
12242         nextchar(pRExC_state);
12243
12244         return TRUE;
12245     }
12246 }
12247
12248
12249 PERL_STATIC_INLINE U8
12250 S_compute_EXACTish(RExC_state_t *pRExC_state)
12251 {
12252     U8 op;
12253
12254     PERL_ARGS_ASSERT_COMPUTE_EXACTISH;
12255
12256     if (! FOLD) {
12257         return (LOC)
12258                 ? EXACTL
12259                 : EXACT;
12260     }
12261
12262     op = get_regex_charset(RExC_flags);
12263     if (op >= REGEX_ASCII_RESTRICTED_CHARSET) {
12264         op--; /* /a is same as /u, and map /aa's offset to what /a's would have
12265                  been, so there is no hole */
12266     }
12267
12268     return op + EXACTF;
12269 }
12270
12271 PERL_STATIC_INLINE void
12272 S_alloc_maybe_populate_EXACT(pTHX_ RExC_state_t *pRExC_state,
12273                          regnode *node, I32* flagp, STRLEN len, UV code_point,
12274                          bool downgradable)
12275 {
12276     /* This knows the details about sizing an EXACTish node, setting flags for
12277      * it (by setting <*flagp>, and potentially populating it with a single
12278      * character.
12279      *
12280      * If <len> (the length in bytes) is non-zero, this function assumes that
12281      * the node has already been populated, and just does the sizing.  In this
12282      * case <code_point> should be the final code point that has already been
12283      * placed into the node.  This value will be ignored except that under some
12284      * circumstances <*flagp> is set based on it.
12285      *
12286      * If <len> is zero, the function assumes that the node is to contain only
12287      * the single character given by <code_point> and calculates what <len>
12288      * should be.  In pass 1, it sizes the node appropriately.  In pass 2, it
12289      * additionally will populate the node's STRING with <code_point> or its
12290      * fold if folding.
12291      *
12292      * In both cases <*flagp> is appropriately set
12293      *
12294      * It knows that under FOLD, the Latin Sharp S and UTF characters above
12295      * 255, must be folded (the former only when the rules indicate it can
12296      * match 'ss')
12297      *
12298      * When it does the populating, it looks at the flag 'downgradable'.  If
12299      * true with a node that folds, it checks if the single code point
12300      * participates in a fold, and if not downgrades the node to an EXACT.
12301      * This helps the optimizer */
12302
12303     bool len_passed_in = cBOOL(len != 0);
12304     U8 character[UTF8_MAXBYTES_CASE+1];
12305
12306     PERL_ARGS_ASSERT_ALLOC_MAYBE_POPULATE_EXACT;
12307
12308     /* Don't bother to check for downgrading in PASS1, as it doesn't make any
12309      * sizing difference, and is extra work that is thrown away */
12310     if (downgradable && ! PASS2) {
12311         downgradable = FALSE;
12312     }
12313
12314     if (! len_passed_in) {
12315         if (UTF) {
12316             if (UVCHR_IS_INVARIANT(code_point)) {
12317                 if (LOC || ! FOLD) {    /* /l defers folding until runtime */
12318                     *character = (U8) code_point;
12319                 }
12320                 else { /* Here is /i and not /l. (toFOLD() is defined on just
12321                           ASCII, which isn't the same thing as INVARIANT on
12322                           EBCDIC, but it works there, as the extra invariants
12323                           fold to themselves) */
12324                     *character = toFOLD((U8) code_point);
12325
12326                     /* We can downgrade to an EXACT node if this character
12327                      * isn't a folding one.  Note that this assumes that
12328                      * nothing above Latin1 folds to some other invariant than
12329                      * one of these alphabetics; otherwise we would also have
12330                      * to check:
12331                      *  && (! HAS_NONLATIN1_FOLD_CLOSURE(code_point)
12332                      *      || ASCII_FOLD_RESTRICTED))
12333                      */
12334                     if (downgradable && PL_fold[code_point] == code_point) {
12335                         OP(node) = EXACT;
12336                     }
12337                 }
12338                 len = 1;
12339             }
12340             else if (FOLD && (! LOC
12341                               || ! is_PROBLEMATIC_LOCALE_FOLD_cp(code_point)))
12342             {   /* Folding, and ok to do so now */
12343                 UV folded = _to_uni_fold_flags(
12344                                    code_point,
12345                                    character,
12346                                    &len,
12347                                    FOLD_FLAGS_FULL | ((ASCII_FOLD_RESTRICTED)
12348                                                       ? FOLD_FLAGS_NOMIX_ASCII
12349                                                       : 0));
12350                 if (downgradable
12351                     && folded == code_point /* This quickly rules out many
12352                                                cases, avoiding the
12353                                                _invlist_contains_cp() overhead
12354                                                for those.  */
12355                     && ! _invlist_contains_cp(PL_utf8_foldable, code_point))
12356                 {
12357                     OP(node) = (LOC)
12358                                ? EXACTL
12359                                : EXACT;
12360                 }
12361             }
12362             else if (code_point <= MAX_UTF8_TWO_BYTE) {
12363
12364                 /* Not folding this cp, and can output it directly */
12365                 *character = UTF8_TWO_BYTE_HI(code_point);
12366                 *(character + 1) = UTF8_TWO_BYTE_LO(code_point);
12367                 len = 2;
12368             }
12369             else {
12370                 uvchr_to_utf8( character, code_point);
12371                 len = UTF8SKIP(character);
12372             }
12373         } /* Else pattern isn't UTF8.  */
12374         else if (! FOLD) {
12375             *character = (U8) code_point;
12376             len = 1;
12377         } /* Else is folded non-UTF8 */
12378 #if    UNICODE_MAJOR_VERSION > 3 /* no multifolds in early Unicode */   \
12379    || (UNICODE_MAJOR_VERSION == 3 && (   UNICODE_DOT_VERSION > 0)       \
12380                                       || UNICODE_DOT_DOT_VERSION > 0)
12381         else if (LIKELY(code_point != LATIN_SMALL_LETTER_SHARP_S)) {
12382 #else
12383         else if (1) {
12384 #endif
12385             /* We don't fold any non-UTF8 except possibly the Sharp s  (see
12386              * comments at join_exact()); */
12387             *character = (U8) code_point;
12388             len = 1;
12389
12390             /* Can turn into an EXACT node if we know the fold at compile time,
12391              * and it folds to itself and doesn't particpate in other folds */
12392             if (downgradable
12393                 && ! LOC
12394                 && PL_fold_latin1[code_point] == code_point
12395                 && (! HAS_NONLATIN1_FOLD_CLOSURE(code_point)
12396                     || (isASCII(code_point) && ASCII_FOLD_RESTRICTED)))
12397             {
12398                 OP(node) = EXACT;
12399             }
12400         } /* else is Sharp s.  May need to fold it */
12401         else if (AT_LEAST_UNI_SEMANTICS && ! ASCII_FOLD_RESTRICTED) {
12402             *character = 's';
12403             *(character + 1) = 's';
12404             len = 2;
12405         }
12406         else {
12407             *character = LATIN_SMALL_LETTER_SHARP_S;
12408             len = 1;
12409         }
12410     }
12411
12412     if (SIZE_ONLY) {
12413         RExC_size += STR_SZ(len);
12414     }
12415     else {
12416         RExC_emit += STR_SZ(len);
12417         STR_LEN(node) = len;
12418         if (! len_passed_in) {
12419             Copy((char *) character, STRING(node), len, char);
12420         }
12421     }
12422
12423     *flagp |= HASWIDTH;
12424
12425     /* A single character node is SIMPLE, except for the special-cased SHARP S
12426      * under /di. */
12427     if ((len == 1 || (UTF && len == UVCHR_SKIP(code_point)))
12428 #if    UNICODE_MAJOR_VERSION > 3 /* no multifolds in early Unicode */   \
12429    || (UNICODE_MAJOR_VERSION == 3 && (   UNICODE_DOT_VERSION > 0)       \
12430                                       || UNICODE_DOT_DOT_VERSION > 0)
12431         && ( code_point != LATIN_SMALL_LETTER_SHARP_S
12432             || ! FOLD || ! DEPENDS_SEMANTICS)
12433 #endif
12434     ) {
12435         *flagp |= SIMPLE;
12436     }
12437
12438     /* The OP may not be well defined in PASS1 */
12439     if (PASS2 && OP(node) == EXACTFL) {
12440         RExC_contains_locale = 1;
12441     }
12442 }
12443
12444 STATIC bool
12445 S_new_regcurly(const char *s, const char *e)
12446 {
12447     /* This is a temporary function designed to match the most lenient form of
12448      * a {m,n} quantifier we ever envision, with either number omitted, and
12449      * spaces anywhere between/before/after them.
12450      *
12451      * If this function fails, then the string it matches is very unlikely to
12452      * ever be considered a valid quantifier, so we can allow the '{' that
12453      * begins it to be considered as a literal */
12454
12455     bool has_min = FALSE;
12456     bool has_max = FALSE;
12457
12458     PERL_ARGS_ASSERT_NEW_REGCURLY;
12459
12460     if (s >= e || *s++ != '{')
12461         return FALSE;
12462
12463     while (s < e && isSPACE(*s)) {
12464         s++;
12465     }
12466     while (s < e && isDIGIT(*s)) {
12467         has_min = TRUE;
12468         s++;
12469     }
12470     while (s < e && isSPACE(*s)) {
12471         s++;
12472     }
12473
12474     if (*s == ',') {
12475         s++;
12476         while (s < e && isSPACE(*s)) {
12477             s++;
12478         }
12479         while (s < e && isDIGIT(*s)) {
12480             has_max = TRUE;
12481             s++;
12482         }
12483         while (s < e && isSPACE(*s)) {
12484             s++;
12485         }
12486     }
12487
12488     return s < e && *s == '}' && (has_min || has_max);
12489 }
12490
12491 /* Parse backref decimal value, unless it's too big to sensibly be a backref,
12492  * in which case return I32_MAX (rather than possibly 32-bit wrapping) */
12493
12494 static I32
12495 S_backref_value(char *p)
12496 {
12497     const char* endptr;
12498     UV val;
12499     if (grok_atoUV(p, &val, &endptr) && val <= I32_MAX)
12500         return (I32)val;
12501     return I32_MAX;
12502 }
12503
12504
12505 /*
12506  - regatom - the lowest level
12507
12508    Try to identify anything special at the start of the current parse position.
12509    If there is, then handle it as required. This may involve generating a
12510    single regop, such as for an assertion; or it may involve recursing, such as
12511    to handle a () structure.
12512
12513    If the string doesn't start with something special then we gobble up
12514    as much literal text as we can.  If we encounter a quantifier, we have to
12515    back off the final literal character, as that quantifier applies to just it
12516    and not to the whole string of literals.
12517
12518    Once we have been able to handle whatever type of thing started the
12519    sequence, we return.
12520
12521    Note: we have to be careful with escapes, as they can be both literal
12522    and special, and in the case of \10 and friends, context determines which.
12523
12524    A summary of the code structure is:
12525
12526    switch (first_byte) {
12527         cases for each special:
12528             handle this special;
12529             break;
12530         case '\\':
12531             switch (2nd byte) {
12532                 cases for each unambiguous special:
12533                     handle this special;
12534                     break;
12535                 cases for each ambigous special/literal:
12536                     disambiguate;
12537                     if (special)  handle here
12538                     else goto defchar;
12539                 default: // unambiguously literal:
12540                     goto defchar;
12541             }
12542         default:  // is a literal char
12543             // FALL THROUGH
12544         defchar:
12545             create EXACTish node for literal;
12546             while (more input and node isn't full) {
12547                 switch (input_byte) {
12548                    cases for each special;
12549                        make sure parse pointer is set so that the next call to
12550                            regatom will see this special first
12551                        goto loopdone; // EXACTish node terminated by prev. char
12552                    default:
12553                        append char to EXACTISH node;
12554                 }
12555                 get next input byte;
12556             }
12557         loopdone:
12558    }
12559    return the generated node;
12560
12561    Specifically there are two separate switches for handling
12562    escape sequences, with the one for handling literal escapes requiring
12563    a dummy entry for all of the special escapes that are actually handled
12564    by the other.
12565
12566    Returns NULL, setting *flagp to TRYAGAIN if reg() returns NULL with
12567    TRYAGAIN.
12568    Returns NULL, setting *flagp to RESTART_PASS1 if the sizing scan needs to be
12569    restarted, or'd with NEED_UTF8 if the pattern needs to be upgraded to UTF-8
12570    Otherwise does not return NULL.
12571 */
12572
12573 STATIC regnode *
12574 S_regatom(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
12575 {
12576     regnode *ret = NULL;
12577     I32 flags = 0;
12578     char *parse_start;
12579     U8 op;
12580     int invert = 0;
12581     U8 arg;
12582
12583     GET_RE_DEBUG_FLAGS_DECL;
12584
12585     *flagp = WORST;             /* Tentatively. */
12586
12587     DEBUG_PARSE("atom");
12588
12589     PERL_ARGS_ASSERT_REGATOM;
12590
12591   tryagain:
12592     parse_start = RExC_parse;
12593     assert(RExC_parse < RExC_end);
12594     switch ((U8)*RExC_parse) {
12595     case '^':
12596         RExC_seen_zerolen++;
12597         nextchar(pRExC_state);
12598         if (RExC_flags & RXf_PMf_MULTILINE)
12599             ret = reg_node(pRExC_state, MBOL);
12600         else
12601             ret = reg_node(pRExC_state, SBOL);
12602         Set_Node_Length(ret, 1); /* MJD */
12603         break;
12604     case '$':
12605         nextchar(pRExC_state);
12606         if (*RExC_parse)
12607             RExC_seen_zerolen++;
12608         if (RExC_flags & RXf_PMf_MULTILINE)
12609             ret = reg_node(pRExC_state, MEOL);
12610         else
12611             ret = reg_node(pRExC_state, SEOL);
12612         Set_Node_Length(ret, 1); /* MJD */
12613         break;
12614     case '.':
12615         nextchar(pRExC_state);
12616         if (RExC_flags & RXf_PMf_SINGLELINE)
12617             ret = reg_node(pRExC_state, SANY);
12618         else
12619             ret = reg_node(pRExC_state, REG_ANY);
12620         *flagp |= HASWIDTH|SIMPLE;
12621         MARK_NAUGHTY(1);
12622         Set_Node_Length(ret, 1); /* MJD */
12623         break;
12624     case '[':
12625     {
12626         char * const oregcomp_parse = ++RExC_parse;
12627         ret = regclass(pRExC_state, flagp,depth+1,
12628                        FALSE, /* means parse the whole char class */
12629                        TRUE, /* allow multi-char folds */
12630                        FALSE, /* don't silence non-portable warnings. */
12631                        (bool) RExC_strict,
12632                        TRUE, /* Allow an optimized regnode result */
12633                        NULL,
12634                        NULL);
12635         if (ret == NULL) {
12636             if (*flagp & (RESTART_PASS1|NEED_UTF8))
12637                 return NULL;
12638             FAIL2("panic: regclass returned NULL to regatom, flags=%#" UVxf,
12639                   (UV) *flagp);
12640         }
12641         if (*RExC_parse != ']') {
12642             RExC_parse = oregcomp_parse;
12643             vFAIL("Unmatched [");
12644         }
12645         nextchar(pRExC_state);
12646         Set_Node_Length(ret, RExC_parse - oregcomp_parse + 1); /* MJD */
12647         break;
12648     }
12649     case '(':
12650         nextchar(pRExC_state);
12651         ret = reg(pRExC_state, 2, &flags,depth+1);
12652         if (ret == NULL) {
12653                 if (flags & TRYAGAIN) {
12654                     if (RExC_parse >= RExC_end) {
12655                          /* Make parent create an empty node if needed. */
12656                         *flagp |= TRYAGAIN;
12657                         return(NULL);
12658                     }
12659                     goto tryagain;
12660                 }
12661                 if (flags & (RESTART_PASS1|NEED_UTF8)) {
12662                     *flagp = flags & (RESTART_PASS1|NEED_UTF8);
12663                     return NULL;
12664                 }
12665                 FAIL2("panic: reg returned NULL to regatom, flags=%#" UVxf,
12666                                                                  (UV) flags);
12667         }
12668         *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
12669         break;
12670     case '|':
12671     case ')':
12672         if (flags & TRYAGAIN) {
12673             *flagp |= TRYAGAIN;
12674             return NULL;
12675         }
12676         vFAIL("Internal urp");
12677                                 /* Supposed to be caught earlier. */
12678         break;
12679     case '?':
12680     case '+':
12681     case '*':
12682         RExC_parse++;
12683         vFAIL("Quantifier follows nothing");
12684         break;
12685     case '\\':
12686         /* Special Escapes
12687
12688            This switch handles escape sequences that resolve to some kind
12689            of special regop and not to literal text. Escape sequnces that
12690            resolve to literal text are handled below in the switch marked
12691            "Literal Escapes".
12692
12693            Every entry in this switch *must* have a corresponding entry
12694            in the literal escape switch. However, the opposite is not
12695            required, as the default for this switch is to jump to the
12696            literal text handling code.
12697         */
12698         RExC_parse++;
12699         switch ((U8)*RExC_parse) {
12700         /* Special Escapes */
12701         case 'A':
12702             RExC_seen_zerolen++;
12703             ret = reg_node(pRExC_state, SBOL);
12704             /* SBOL is shared with /^/ so we set the flags so we can tell
12705              * /\A/ from /^/ in split. We check ret because first pass we
12706              * have no regop struct to set the flags on. */
12707             if (PASS2)
12708                 ret->flags = 1;
12709             *flagp |= SIMPLE;
12710             goto finish_meta_pat;
12711         case 'G':
12712             ret = reg_node(pRExC_state, GPOS);
12713             RExC_seen |= REG_GPOS_SEEN;
12714             *flagp |= SIMPLE;
12715             goto finish_meta_pat;
12716         case 'K':
12717             RExC_seen_zerolen++;
12718             ret = reg_node(pRExC_state, KEEPS);
12719             *flagp |= SIMPLE;
12720             /* XXX:dmq : disabling in-place substitution seems to
12721              * be necessary here to avoid cases of memory corruption, as
12722              * with: C<$_="x" x 80; s/x\K/y/> -- rgs
12723              */
12724             RExC_seen |= REG_LOOKBEHIND_SEEN;
12725             goto finish_meta_pat;
12726         case 'Z':
12727             ret = reg_node(pRExC_state, SEOL);
12728             *flagp |= SIMPLE;
12729             RExC_seen_zerolen++;                /* Do not optimize RE away */
12730             goto finish_meta_pat;
12731         case 'z':
12732             ret = reg_node(pRExC_state, EOS);
12733             *flagp |= SIMPLE;
12734             RExC_seen_zerolen++;                /* Do not optimize RE away */
12735             goto finish_meta_pat;
12736         case 'C':
12737             vFAIL("\\C no longer supported");
12738         case 'X':
12739             ret = reg_node(pRExC_state, CLUMP);
12740             *flagp |= HASWIDTH;
12741             goto finish_meta_pat;
12742
12743         case 'W':
12744             invert = 1;
12745             /* FALLTHROUGH */
12746         case 'w':
12747             arg = ANYOF_WORDCHAR;
12748             goto join_posix;
12749
12750         case 'B':
12751             invert = 1;
12752             /* FALLTHROUGH */
12753         case 'b':
12754           {
12755             regex_charset charset = get_regex_charset(RExC_flags);
12756
12757             RExC_seen_zerolen++;
12758             RExC_seen |= REG_LOOKBEHIND_SEEN;
12759             op = BOUND + charset;
12760
12761             if (op == BOUNDL) {
12762                 RExC_contains_locale = 1;
12763             }
12764
12765             ret = reg_node(pRExC_state, op);
12766             *flagp |= SIMPLE;
12767             if (RExC_parse >= RExC_end || *(RExC_parse + 1) != '{') {
12768                 FLAGS(ret) = TRADITIONAL_BOUND;
12769                 if (PASS2 && op > BOUNDA) {  /* /aa is same as /a */
12770                     OP(ret) = BOUNDA;
12771                 }
12772             }
12773             else {
12774                 STRLEN length;
12775                 char name = *RExC_parse;
12776                 char * endbrace = NULL;
12777                 RExC_parse += 2;
12778                 if (RExC_parse < RExC_end) {
12779                     endbrace = (char *) memchr(RExC_parse, '}', RExC_end - RExC_parse);
12780                 }
12781
12782                 if (! endbrace) {
12783                     vFAIL2("Missing right brace on \\%c{}", name);
12784                 }
12785                 /* XXX Need to decide whether to take spaces or not.  Should be
12786                  * consistent with \p{}, but that currently is SPACE, which
12787                  * means vertical too, which seems wrong
12788                  * while (isBLANK(*RExC_parse)) {
12789                     RExC_parse++;
12790                 }*/
12791                 if (endbrace == RExC_parse) {
12792                     RExC_parse++;  /* After the '}' */
12793                     vFAIL2("Empty \\%c{}", name);
12794                 }
12795                 length = endbrace - RExC_parse;
12796                 /*while (isBLANK(*(RExC_parse + length - 1))) {
12797                     length--;
12798                 }*/
12799                 switch (*RExC_parse) {
12800                     case 'g':
12801                         if (    length != 1
12802                             && (memNEs(RExC_parse + 1, length - 1, "cb")))
12803                         {
12804                             goto bad_bound_type;
12805                         }
12806                         FLAGS(ret) = GCB_BOUND;
12807                         break;
12808                     case 'l':
12809                         if (length != 2 || *(RExC_parse + 1) != 'b') {
12810                             goto bad_bound_type;
12811                         }
12812                         FLAGS(ret) = LB_BOUND;
12813                         break;
12814                     case 's':
12815                         if (length != 2 || *(RExC_parse + 1) != 'b') {
12816                             goto bad_bound_type;
12817                         }
12818                         FLAGS(ret) = SB_BOUND;
12819                         break;
12820                     case 'w':
12821                         if (length != 2 || *(RExC_parse + 1) != 'b') {
12822                             goto bad_bound_type;
12823                         }
12824                         FLAGS(ret) = WB_BOUND;
12825                         break;
12826                     default:
12827                       bad_bound_type:
12828                         RExC_parse = endbrace;
12829                         vFAIL2utf8f(
12830                             "'%" UTF8f "' is an unknown bound type",
12831                             UTF8fARG(UTF, length, endbrace - length));
12832                         NOT_REACHED; /*NOTREACHED*/
12833                 }
12834                 RExC_parse = endbrace;
12835                 REQUIRE_UNI_RULES(flagp, NULL);
12836
12837                 if (PASS2 && op >= BOUNDA) {  /* /aa is same as /a */
12838                     OP(ret) = BOUNDU;
12839                     length += 4;
12840
12841                     /* Don't have to worry about UTF-8, in this message because
12842                      * to get here the contents of the \b must be ASCII */
12843                     ckWARN4reg(RExC_parse + 1,  /* Include the '}' in msg */
12844                               "Using /u for '%.*s' instead of /%s",
12845                               (unsigned) length,
12846                               endbrace - length + 1,
12847                               (charset == REGEX_ASCII_RESTRICTED_CHARSET)
12848                               ? ASCII_RESTRICT_PAT_MODS
12849                               : ASCII_MORE_RESTRICT_PAT_MODS);
12850                 }
12851             }
12852
12853             if (PASS2 && invert) {
12854                 OP(ret) += NBOUND - BOUND;
12855             }
12856             goto finish_meta_pat;
12857           }
12858
12859         case 'D':
12860             invert = 1;
12861             /* FALLTHROUGH */
12862         case 'd':
12863             arg = ANYOF_DIGIT;
12864             if (! DEPENDS_SEMANTICS) {
12865                 goto join_posix;
12866             }
12867
12868             /* \d doesn't have any matches in the upper Latin1 range, hence /d
12869              * is equivalent to /u.  Changing to /u saves some branches at
12870              * runtime */
12871             op = POSIXU;
12872             goto join_posix_op_known;
12873
12874         case 'R':
12875             ret = reg_node(pRExC_state, LNBREAK);
12876             *flagp |= HASWIDTH|SIMPLE;
12877             goto finish_meta_pat;
12878
12879         case 'H':
12880             invert = 1;
12881             /* FALLTHROUGH */
12882         case 'h':
12883             arg = ANYOF_BLANK;
12884             op = POSIXU;
12885             goto join_posix_op_known;
12886
12887         case 'V':
12888             invert = 1;
12889             /* FALLTHROUGH */
12890         case 'v':
12891             arg = ANYOF_VERTWS;
12892             op = POSIXU;
12893             goto join_posix_op_known;
12894
12895         case 'S':
12896             invert = 1;
12897             /* FALLTHROUGH */
12898         case 's':
12899             arg = ANYOF_SPACE;
12900
12901           join_posix:
12902
12903             op = POSIXD + get_regex_charset(RExC_flags);
12904             if (op > POSIXA) {  /* /aa is same as /a */
12905                 op = POSIXA;
12906             }
12907             else if (op == POSIXL) {
12908                 RExC_contains_locale = 1;
12909             }
12910
12911           join_posix_op_known:
12912
12913             if (invert) {
12914                 op += NPOSIXD - POSIXD;
12915             }
12916
12917             ret = reg_node(pRExC_state, op);
12918             if (! SIZE_ONLY) {
12919                 FLAGS(ret) = namedclass_to_classnum(arg);
12920             }
12921
12922             *flagp |= HASWIDTH|SIMPLE;
12923             /* FALLTHROUGH */
12924
12925           finish_meta_pat:
12926             if (   UCHARAT(RExC_parse + 1) == '{'
12927                 && UNLIKELY(! new_regcurly(RExC_parse + 1, RExC_end)))
12928             {
12929                 RExC_parse += 2;
12930                 vFAIL("Unescaped left brace in regex is illegal here");
12931             }
12932             nextchar(pRExC_state);
12933             Set_Node_Length(ret, 2); /* MJD */
12934             break;
12935         case 'p':
12936         case 'P':
12937             RExC_parse--;
12938
12939             ret = regclass(pRExC_state, flagp,depth+1,
12940                            TRUE, /* means just parse this element */
12941                            FALSE, /* don't allow multi-char folds */
12942                            FALSE, /* don't silence non-portable warnings.  It
12943                                      would be a bug if these returned
12944                                      non-portables */
12945                            (bool) RExC_strict,
12946                            TRUE, /* Allow an optimized regnode result */
12947                            NULL,
12948                            NULL);
12949             if (*flagp & RESTART_PASS1)
12950                 return NULL;
12951             /* regclass() can only return RESTART_PASS1 and NEED_UTF8 if
12952              * multi-char folds are allowed.  */
12953             if (!ret)
12954                 FAIL2("panic: regclass returned NULL to regatom, flags=%#" UVxf,
12955                       (UV) *flagp);
12956
12957             RExC_parse--;
12958
12959             Set_Node_Offset(ret, parse_start);
12960             Set_Node_Cur_Length(ret, parse_start - 2);
12961             nextchar(pRExC_state);
12962             break;
12963         case 'N':
12964             /* Handle \N, \N{} and \N{NAMED SEQUENCE} (the latter meaning the
12965              * \N{...} evaluates to a sequence of more than one code points).
12966              * The function call below returns a regnode, which is our result.
12967              * The parameters cause it to fail if the \N{} evaluates to a
12968              * single code point; we handle those like any other literal.  The
12969              * reason that the multicharacter case is handled here and not as
12970              * part of the EXACtish code is because of quantifiers.  In
12971              * /\N{BLAH}+/, the '+' applies to the whole thing, and doing it
12972              * this way makes that Just Happen. dmq.
12973              * join_exact() will join this up with adjacent EXACTish nodes
12974              * later on, if appropriate. */
12975             ++RExC_parse;
12976             if (grok_bslash_N(pRExC_state,
12977                               &ret,     /* Want a regnode returned */
12978                               NULL,     /* Fail if evaluates to a single code
12979                                            point */
12980                               NULL,     /* Don't need a count of how many code
12981                                            points */
12982                               flagp,
12983                               RExC_strict,
12984                               depth)
12985             ) {
12986                 break;
12987             }
12988
12989             if (*flagp & RESTART_PASS1)
12990                 return NULL;
12991
12992             /* Here, evaluates to a single code point.  Go get that */
12993             RExC_parse = parse_start;
12994             goto defchar;
12995
12996         case 'k':    /* Handle \k<NAME> and \k'NAME' */
12997       parse_named_seq:
12998         {
12999             char ch;
13000             if (   RExC_parse >= RExC_end - 1
13001                 || ((   ch = RExC_parse[1]) != '<'
13002                                       && ch != '\''
13003                                       && ch != '{'))
13004             {
13005                 RExC_parse++;
13006                 /* diag_listed_as: Sequence \%s... not terminated in regex; marked by <-- HERE in m/%s/ */
13007                 vFAIL2("Sequence %.2s... not terminated",parse_start);
13008             } else {
13009                 RExC_parse += 2;
13010                 ret = handle_named_backref(pRExC_state,
13011                                            flagp,
13012                                            parse_start,
13013                                            (ch == '<')
13014                                            ? '>'
13015                                            : (ch == '{')
13016                                              ? '}'
13017                                              : '\'');
13018             }
13019             break;
13020         }
13021         case 'g':
13022         case '1': case '2': case '3': case '4':
13023         case '5': case '6': case '7': case '8': case '9':
13024             {
13025                 I32 num;
13026                 bool hasbrace = 0;
13027
13028                 if (*RExC_parse == 'g') {
13029                     bool isrel = 0;
13030
13031                     RExC_parse++;
13032                     if (*RExC_parse == '{') {
13033                         RExC_parse++;
13034                         hasbrace = 1;
13035                     }
13036                     if (*RExC_parse == '-') {
13037                         RExC_parse++;
13038                         isrel = 1;
13039                     }
13040                     if (hasbrace && !isDIGIT(*RExC_parse)) {
13041                         if (isrel) RExC_parse--;
13042                         RExC_parse -= 2;
13043                         goto parse_named_seq;
13044                     }
13045
13046                     if (RExC_parse >= RExC_end) {
13047                         goto unterminated_g;
13048                     }
13049                     num = S_backref_value(RExC_parse);
13050                     if (num == 0)
13051                         vFAIL("Reference to invalid group 0");
13052                     else if (num == I32_MAX) {
13053                          if (isDIGIT(*RExC_parse))
13054                             vFAIL("Reference to nonexistent group");
13055                         else
13056                           unterminated_g:
13057                             vFAIL("Unterminated \\g... pattern");
13058                     }
13059
13060                     if (isrel) {
13061                         num = RExC_npar - num;
13062                         if (num < 1)
13063                             vFAIL("Reference to nonexistent or unclosed group");
13064                     }
13065                 }
13066                 else {
13067                     num = S_backref_value(RExC_parse);
13068                     /* bare \NNN might be backref or octal - if it is larger
13069                      * than or equal RExC_npar then it is assumed to be an
13070                      * octal escape. Note RExC_npar is +1 from the actual
13071                      * number of parens. */
13072                     /* Note we do NOT check if num == I32_MAX here, as that is
13073                      * handled by the RExC_npar check */
13074
13075                     if (
13076                         /* any numeric escape < 10 is always a backref */
13077                         num > 9
13078                         /* any numeric escape < RExC_npar is a backref */
13079                         && num >= RExC_npar
13080                         /* cannot be an octal escape if it starts with 8 */
13081                         && *RExC_parse != '8'
13082                         /* cannot be an octal escape it it starts with 9 */
13083                         && *RExC_parse != '9'
13084                     )
13085                     {
13086                         /* Probably not a backref, instead likely to be an
13087                          * octal character escape, e.g. \35 or \777.
13088                          * The above logic should make it obvious why using
13089                          * octal escapes in patterns is problematic. - Yves */
13090                         RExC_parse = parse_start;
13091                         goto defchar;
13092                     }
13093                 }
13094
13095                 /* At this point RExC_parse points at a numeric escape like
13096                  * \12 or \88 or something similar, which we should NOT treat
13097                  * as an octal escape. It may or may not be a valid backref
13098                  * escape. For instance \88888888 is unlikely to be a valid
13099                  * backref. */
13100                 while (isDIGIT(*RExC_parse))
13101                     RExC_parse++;
13102                 if (hasbrace) {
13103                     if (*RExC_parse != '}')
13104                         vFAIL("Unterminated \\g{...} pattern");
13105                     RExC_parse++;
13106                 }
13107                 if (!SIZE_ONLY) {
13108                     if (num > (I32)RExC_rx->nparens)
13109                         vFAIL("Reference to nonexistent group");
13110                 }
13111                 RExC_sawback = 1;
13112                 ret = reganode(pRExC_state,
13113                                ((! FOLD)
13114                                  ? REF
13115                                  : (ASCII_FOLD_RESTRICTED)
13116                                    ? REFFA
13117                                    : (AT_LEAST_UNI_SEMANTICS)
13118                                      ? REFFU
13119                                      : (LOC)
13120                                        ? REFFL
13121                                        : REFF),
13122                                 num);
13123                 *flagp |= HASWIDTH;
13124
13125                 /* override incorrect value set in reganode MJD */
13126                 Set_Node_Offset(ret, parse_start);
13127                 Set_Node_Cur_Length(ret, parse_start-1);
13128                 skip_to_be_ignored_text(pRExC_state, &RExC_parse,
13129                                         FALSE /* Don't force to /x */ );
13130             }
13131             break;
13132         case '\0':
13133             if (RExC_parse >= RExC_end)
13134                 FAIL("Trailing \\");
13135             /* FALLTHROUGH */
13136         default:
13137             /* Do not generate "unrecognized" warnings here, we fall
13138                back into the quick-grab loop below */
13139             RExC_parse = parse_start;
13140             goto defchar;
13141         } /* end of switch on a \foo sequence */
13142         break;
13143
13144     case '#':
13145
13146         /* '#' comments should have been spaced over before this function was
13147          * called */
13148         assert((RExC_flags & RXf_PMf_EXTENDED) == 0);
13149         /*
13150         if (RExC_flags & RXf_PMf_EXTENDED) {
13151             RExC_parse = reg_skipcomment( pRExC_state, RExC_parse );
13152             if (RExC_parse < RExC_end)
13153                 goto tryagain;
13154         }
13155         */
13156
13157         /* FALLTHROUGH */
13158
13159     default:
13160           defchar: {
13161
13162             /* Here, we have determined that the next thing is probably a
13163              * literal character.  RExC_parse points to the first byte of its
13164              * definition.  (It still may be an escape sequence that evaluates
13165              * to a single character) */
13166
13167             STRLEN len = 0;
13168             UV ender = 0;
13169             char *p;
13170             char *s;
13171 #define MAX_NODE_STRING_SIZE 127
13172             char foldbuf[MAX_NODE_STRING_SIZE+UTF8_MAXBYTES_CASE];
13173             char *s0;
13174             U8 upper_parse = MAX_NODE_STRING_SIZE;
13175             U8 node_type = compute_EXACTish(pRExC_state);
13176             bool next_is_quantifier;
13177             char * oldp = NULL;
13178
13179             /* We can convert EXACTF nodes to EXACTFU if they contain only
13180              * characters that match identically regardless of the target
13181              * string's UTF8ness.  The reason to do this is that EXACTF is not
13182              * trie-able, EXACTFU is.
13183              *
13184              * Similarly, we can convert EXACTFL nodes to EXACTFLU8 if they
13185              * contain only above-Latin1 characters (hence must be in UTF8),
13186              * which don't participate in folds with Latin1-range characters,
13187              * as the latter's folds aren't known until runtime.  (We don't
13188              * need to figure this out until pass 2) */
13189             bool maybe_exactfu = PASS2
13190                                && (node_type == EXACTF || node_type == EXACTFL);
13191
13192             /* If a folding node contains only code points that don't
13193              * participate in folds, it can be changed into an EXACT node,
13194              * which allows the optimizer more things to look for */
13195             bool maybe_exact;
13196
13197             ret = reg_node(pRExC_state, node_type);
13198
13199             /* In pass1, folded, we use a temporary buffer instead of the
13200              * actual node, as the node doesn't exist yet */
13201             s = (SIZE_ONLY && FOLD) ? foldbuf : STRING(ret);
13202
13203             s0 = s;
13204
13205           reparse:
13206
13207             /* We look for the EXACTFish to EXACT node optimizaton only if
13208              * folding.  (And we don't need to figure this out until pass 2).
13209              * XXX It might actually make sense to split the node into portions
13210              * that are exact and ones that aren't, so that we could later use
13211              * the exact ones to find the longest fixed and floating strings.
13212              * One would want to join them back into a larger node.  One could
13213              * use a pseudo regnode like 'EXACT_ORIG_FOLD' */
13214             maybe_exact = FOLD && PASS2;
13215
13216             /* XXX The node can hold up to 255 bytes, yet this only goes to
13217              * 127.  I (khw) do not know why.  Keeping it somewhat less than
13218              * 255 allows us to not have to worry about overflow due to
13219              * converting to utf8 and fold expansion, but that value is
13220              * 255-UTF8_MAXBYTES_CASE.  join_exact() may join adjacent nodes
13221              * split up by this limit into a single one using the real max of
13222              * 255.  Even at 127, this breaks under rare circumstances.  If
13223              * folding, we do not want to split a node at a character that is a
13224              * non-final in a multi-char fold, as an input string could just
13225              * happen to want to match across the node boundary.  The join
13226              * would solve that problem if the join actually happens.  But a
13227              * series of more than two nodes in a row each of 127 would cause
13228              * the first join to succeed to get to 254, but then there wouldn't
13229              * be room for the next one, which could at be one of those split
13230              * multi-char folds.  I don't know of any fool-proof solution.  One
13231              * could back off to end with only a code point that isn't such a
13232              * non-final, but it is possible for there not to be any in the
13233              * entire node. */
13234
13235             assert(   ! UTF     /* Is at the beginning of a character */
13236                    || UTF8_IS_INVARIANT(UCHARAT(RExC_parse))
13237                    || UTF8_IS_START(UCHARAT(RExC_parse)));
13238
13239             /* Here, we have a literal character.  Find the maximal string of
13240              * them in the input that we can fit into a single EXACTish node.
13241              * We quit at the first non-literal or when the node gets full */
13242             for (p = RExC_parse;
13243                  len < upper_parse && p < RExC_end;
13244                  len++)
13245             {
13246                 oldp = p;
13247
13248                 /* White space has already been ignored */
13249                 assert(   (RExC_flags & RXf_PMf_EXTENDED) == 0
13250                        || ! is_PATWS_safe((p), RExC_end, UTF));
13251
13252                 switch ((U8)*p) {
13253                 case '^':
13254                 case '$':
13255                 case '.':
13256                 case '[':
13257                 case '(':
13258                 case ')':
13259                 case '|':
13260                     goto loopdone;
13261                 case '\\':
13262                     /* Literal Escapes Switch
13263
13264                        This switch is meant to handle escape sequences that
13265                        resolve to a literal character.
13266
13267                        Every escape sequence that represents something
13268                        else, like an assertion or a char class, is handled
13269                        in the switch marked 'Special Escapes' above in this
13270                        routine, but also has an entry here as anything that
13271                        isn't explicitly mentioned here will be treated as
13272                        an unescaped equivalent literal.
13273                     */
13274
13275                     switch ((U8)*++p) {
13276                     /* These are all the special escapes. */
13277                     case 'A':             /* Start assertion */
13278                     case 'b': case 'B':   /* Word-boundary assertion*/
13279                     case 'C':             /* Single char !DANGEROUS! */
13280                     case 'd': case 'D':   /* digit class */
13281                     case 'g': case 'G':   /* generic-backref, pos assertion */
13282                     case 'h': case 'H':   /* HORIZWS */
13283                     case 'k': case 'K':   /* named backref, keep marker */
13284                     case 'p': case 'P':   /* Unicode property */
13285                               case 'R':   /* LNBREAK */
13286                     case 's': case 'S':   /* space class */
13287                     case 'v': case 'V':   /* VERTWS */
13288                     case 'w': case 'W':   /* word class */
13289                     case 'X':             /* eXtended Unicode "combining
13290                                              character sequence" */
13291                     case 'z': case 'Z':   /* End of line/string assertion */
13292                         --p;
13293                         goto loopdone;
13294
13295                     /* Anything after here is an escape that resolves to a
13296                        literal. (Except digits, which may or may not)
13297                      */
13298                     case 'n':
13299                         ender = '\n';
13300                         p++;
13301                         break;
13302                     case 'N': /* Handle a single-code point named character. */
13303                         RExC_parse = p + 1;
13304                         if (! grok_bslash_N(pRExC_state,
13305                                             NULL,   /* Fail if evaluates to
13306                                                        anything other than a
13307                                                        single code point */
13308                                             &ender, /* The returned single code
13309                                                        point */
13310                                             NULL,   /* Don't need a count of
13311                                                        how many code points */
13312                                             flagp,
13313                                             RExC_strict,
13314                                             depth)
13315                         ) {
13316                             if (*flagp & NEED_UTF8)
13317                                 FAIL("panic: grok_bslash_N set NEED_UTF8");
13318                             if (*flagp & RESTART_PASS1)
13319                                 return NULL;
13320
13321                             /* Here, it wasn't a single code point.  Go close
13322                              * up this EXACTish node.  The switch() prior to
13323                              * this switch handles the other cases */
13324                             RExC_parse = p = oldp;
13325                             goto loopdone;
13326                         }
13327                         p = RExC_parse;
13328                         RExC_parse = parse_start;
13329                         if (ender > 0xff) {
13330                             REQUIRE_UTF8(flagp);
13331                         }
13332                         break;
13333                     case 'r':
13334                         ender = '\r';
13335                         p++;
13336                         break;
13337                     case 't':
13338                         ender = '\t';
13339                         p++;
13340                         break;
13341                     case 'f':
13342                         ender = '\f';
13343                         p++;
13344                         break;
13345                     case 'e':
13346                         ender = ESC_NATIVE;
13347                         p++;
13348                         break;
13349                     case 'a':
13350                         ender = '\a';
13351                         p++;
13352                         break;
13353                     case 'o':
13354                         {
13355                             UV result;
13356                             const char* error_msg;
13357
13358                             bool valid = grok_bslash_o(&p,
13359                                                        RExC_end,
13360                                                        &result,
13361                                                        &error_msg,
13362                                                        PASS2, /* out warnings */
13363                                                        (bool) RExC_strict,
13364                                                        TRUE, /* Output warnings
13365                                                                 for non-
13366                                                                 portables */
13367                                                        UTF);
13368                             if (! valid) {
13369                                 RExC_parse = p; /* going to die anyway; point
13370                                                    to exact spot of failure */
13371                                 vFAIL(error_msg);
13372                             }
13373                             ender = result;
13374                             if (ender > 0xff) {
13375                                 REQUIRE_UTF8(flagp);
13376                             }
13377                             break;
13378                         }
13379                     case 'x':
13380                         {
13381                             UV result = UV_MAX; /* initialize to erroneous
13382                                                    value */
13383                             const char* error_msg;
13384
13385                             bool valid = grok_bslash_x(&p,
13386                                                        RExC_end,
13387                                                        &result,
13388                                                        &error_msg,
13389                                                        PASS2, /* out warnings */
13390                                                        (bool) RExC_strict,
13391                                                        TRUE, /* Silence warnings
13392                                                                 for non-
13393                                                                 portables */
13394                                                        UTF);
13395                             if (! valid) {
13396                                 RExC_parse = p; /* going to die anyway; point
13397                                                    to exact spot of failure */
13398                                 vFAIL(error_msg);
13399                             }
13400                             ender = result;
13401
13402                             if (ender < 0x100) {
13403 #ifdef EBCDIC
13404                                 if (RExC_recode_x_to_native) {
13405                                     ender = LATIN1_TO_NATIVE(ender);
13406                                 }
13407 #endif
13408                             }
13409                             else {
13410                                 REQUIRE_UTF8(flagp);
13411                             }
13412                             break;
13413                         }
13414                     case 'c':
13415                         p++;
13416                         ender = grok_bslash_c(*p++, PASS2);
13417                         break;
13418                     case '8': case '9': /* must be a backreference */
13419                         --p;
13420                         /* we have an escape like \8 which cannot be an octal escape
13421                          * so we exit the loop, and let the outer loop handle this
13422                          * escape which may or may not be a legitimate backref. */
13423                         goto loopdone;
13424                     case '1': case '2': case '3':case '4':
13425                     case '5': case '6': case '7':
13426                         /* When we parse backslash escapes there is ambiguity
13427                          * between backreferences and octal escapes. Any escape
13428                          * from \1 - \9 is a backreference, any multi-digit
13429                          * escape which does not start with 0 and which when
13430                          * evaluated as decimal could refer to an already
13431                          * parsed capture buffer is a back reference. Anything
13432                          * else is octal.
13433                          *
13434                          * Note this implies that \118 could be interpreted as
13435                          * 118 OR as "\11" . "8" depending on whether there
13436                          * were 118 capture buffers defined already in the
13437                          * pattern.  */
13438
13439                         /* NOTE, RExC_npar is 1 more than the actual number of
13440                          * parens we have seen so far, hence the < RExC_npar below. */
13441
13442                         if ( !isDIGIT(p[1]) || S_backref_value(p) < RExC_npar)
13443                         {  /* Not to be treated as an octal constant, go
13444                                    find backref */
13445                             --p;
13446                             goto loopdone;
13447                         }
13448                         /* FALLTHROUGH */
13449                     case '0':
13450                         {
13451                             I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
13452                             STRLEN numlen = 3;
13453                             ender = grok_oct(p, &numlen, &flags, NULL);
13454                             if (ender > 0xff) {
13455                                 REQUIRE_UTF8(flagp);
13456                             }
13457                             p += numlen;
13458                             if (PASS2   /* like \08, \178 */
13459                                 && numlen < 3
13460                                 && isDIGIT(*p) && ckWARN(WARN_REGEXP))
13461                             {
13462                                 reg_warn_non_literal_string(
13463                                          p + 1,
13464                                          form_short_octal_warning(p, numlen));
13465                             }
13466                         }
13467                         break;
13468                     case '\0':
13469                         if (p >= RExC_end)
13470                             FAIL("Trailing \\");
13471                         /* FALLTHROUGH */
13472                     default:
13473                         if (!SIZE_ONLY&& isALPHANUMERIC(*p)) {
13474                             /* Include any left brace following the alpha to emphasize
13475                              * that it could be part of an escape at some point
13476                              * in the future */
13477                             int len = (isALPHA(*p) && *(p + 1) == '{') ? 2 : 1;
13478                             ckWARN3reg(p + len, "Unrecognized escape \\%.*s passed through", len, p);
13479                         }
13480                         goto normal_default;
13481                     } /* End of switch on '\' */
13482                     break;
13483                 case '{':
13484                     /* Currently we allow an lbrace at the start of a construct
13485                      * without raising a warning.  This is because we think we
13486                      * will never want such a brace to be meant to be other
13487                      * than taken literally. */
13488                     if (len || (p > RExC_start && isALPHA_A(*(p - 1)))) {
13489
13490                         /* But, we raise a fatal warning otherwise, as the
13491                          * deprecation cycle has come and gone.  Except that it
13492                          * turns out that some heavily-relied on upstream
13493                          * software, notably GNU Autoconf, have failed to fix
13494                          * their uses.  For these, don't make it fatal unless
13495                          * we anticipate using the '{' for something else.
13496                          * This happens after any alpha, and for a looser {m,n}
13497                          * quantifier specification */
13498                         if (      RExC_strict
13499                             || (  p > parse_start + 1
13500                                 && isALPHA_A(*(p - 1))
13501                                 && *(p - 2) == '\\')
13502                             || new_regcurly(p, RExC_end))
13503                         {
13504                             RExC_parse = p + 1;
13505                             vFAIL("Unescaped left brace in regex is "
13506                                   "illegal here");
13507                         }
13508                         if (PASS2) {
13509                             ckWARNregdep(p + 1,
13510                                         "Unescaped left brace in regex is "
13511                                         "deprecated here (and will be fatal "
13512                                         "in Perl 5.30), passed through");
13513                         }
13514                     }
13515                     goto normal_default;
13516                 case '}':
13517                 case ']':
13518                     if (PASS2 && p > RExC_parse && RExC_strict) {
13519                         ckWARN2reg(p + 1, "Unescaped literal '%c'", *p);
13520                     }
13521                     /*FALLTHROUGH*/
13522                 default:    /* A literal character */
13523                   normal_default:
13524                     if (! UTF8_IS_INVARIANT(*p) && UTF) {
13525                         STRLEN numlen;
13526                         ender = utf8n_to_uvchr((U8*)p, RExC_end - p,
13527                                                &numlen, UTF8_ALLOW_DEFAULT);
13528                         p += numlen;
13529                     }
13530                     else
13531                         ender = (U8) *p++;
13532                     break;
13533                 } /* End of switch on the literal */
13534
13535                 /* Here, have looked at the literal character and <ender>
13536                  * contains its ordinal, <p> points to the character after it.
13537                  * We need to check if the next non-ignored thing is a
13538                  * quantifier.  Move <p> to after anything that should be
13539                  * ignored, which, as a side effect, positions <p> for the next
13540                  * loop iteration */
13541                 skip_to_be_ignored_text(pRExC_state, &p,
13542                                         FALSE /* Don't force to /x */ );
13543
13544                 /* If the next thing is a quantifier, it applies to this
13545                  * character only, which means that this character has to be in
13546                  * its own node and can't just be appended to the string in an
13547                  * existing node, so if there are already other characters in
13548                  * the node, close the node with just them, and set up to do
13549                  * this character again next time through, when it will be the
13550                  * only thing in its new node */
13551
13552                 next_is_quantifier =    LIKELY(p < RExC_end)
13553                                      && UNLIKELY(ISMULT2(p));
13554
13555                 if (next_is_quantifier && LIKELY(len)) {
13556                     p = oldp;
13557                     goto loopdone;
13558                 }
13559
13560                 /* Ready to add 'ender' to the node */
13561
13562                 if (! FOLD) {  /* The simple case, just append the literal */
13563
13564                     /* In the sizing pass, we need only the size of the
13565                      * character we are appending, hence we can delay getting
13566                      * its representation until PASS2. */
13567                     if (SIZE_ONLY) {
13568                         if (UTF && ! UVCHR_IS_INVARIANT(ender)) {
13569                             const STRLEN unilen = UVCHR_SKIP(ender);
13570                             s += unilen;
13571
13572                             /* We have to subtract 1 just below (and again in
13573                              * the corresponding PASS2 code) because the loop
13574                              * increments <len> each time, as all but this path
13575                              * (and one other) through it add a single byte to
13576                              * the EXACTish node.  But these paths would change
13577                              * len to be the correct final value, so cancel out
13578                              * the increment that follows */
13579                             len += unilen - 1;
13580                         }
13581                         else {
13582                             s++;
13583                         }
13584                     } else { /* PASS2 */
13585                       not_fold_common:
13586                         if (UTF && ! UVCHR_IS_INVARIANT(ender)) {
13587                             U8 * new_s = uvchr_to_utf8((U8*)s, ender);
13588                             len += (char *) new_s - s - 1;
13589                             s = (char *) new_s;
13590                         }
13591                         else {
13592                             *(s++) = (char) ender;
13593                         }
13594                     }
13595                 }
13596                 else if (LOC && is_PROBLEMATIC_LOCALE_FOLD_cp(ender)) {
13597
13598                     /* Here are folding under /l, and the code point is
13599                      * problematic.  First, we know we can't simplify things */
13600                     maybe_exact = FALSE;
13601                     maybe_exactfu = FALSE;
13602
13603                     /* A problematic code point in this context means that its
13604                      * fold isn't known until runtime, so we can't fold it now.
13605                      * (The non-problematic code points are the above-Latin1
13606                      * ones that fold to also all above-Latin1.  Their folds
13607                      * don't vary no matter what the locale is.) But here we
13608                      * have characters whose fold depends on the locale.
13609                      * Unlike the non-folding case above, we have to keep track
13610                      * of these in the sizing pass, so that we can make sure we
13611                      * don't split too-long nodes in the middle of a potential
13612                      * multi-char fold.  And unlike the regular fold case
13613                      * handled in the else clauses below, we don't actually
13614                      * fold and don't have special cases to consider.  What we
13615                      * do for both passes is the PASS2 code for non-folding */
13616                     goto not_fold_common;
13617                 }
13618                 else /* A regular FOLD code point */
13619                     if (! (   UTF
13620 #if    UNICODE_MAJOR_VERSION > 3 /* no multifolds in early Unicode */   \
13621    || (UNICODE_MAJOR_VERSION == 3 && (   UNICODE_DOT_VERSION > 0)       \
13622                                       || UNICODE_DOT_DOT_VERSION > 0)
13623                             /* See comments for join_exact() as to why we fold
13624                              * this non-UTF at compile time */
13625                             || (   node_type == EXACTFU
13626                                 && ender == LATIN_SMALL_LETTER_SHARP_S)
13627 #endif
13628                 )) {
13629                     /* Here, are folding and are not UTF-8 encoded; therefore
13630                      * the character must be in the range 0-255, and is not /l
13631                      * (Not /l because we already handled these under /l in
13632                      * is_PROBLEMATIC_LOCALE_FOLD_cp) */
13633                     if (IS_IN_SOME_FOLD_L1(ender)) {
13634                         maybe_exact = FALSE;
13635
13636                         /* See if the character's fold differs between /d and
13637                          * /u.  This includes the multi-char fold SHARP S to
13638                          * 'ss' */
13639                         if (UNLIKELY(ender == LATIN_SMALL_LETTER_SHARP_S)) {
13640                             RExC_seen_unfolded_sharp_s = 1;
13641                             maybe_exactfu = FALSE;
13642                         }
13643                         else if (maybe_exactfu
13644                             && (PL_fold[ender] != PL_fold_latin1[ender]
13645 #if    UNICODE_MAJOR_VERSION > 3 /* no multifolds in early Unicode */   \
13646    || (UNICODE_MAJOR_VERSION == 3 && (   UNICODE_DOT_VERSION > 0)       \
13647                                       || UNICODE_DOT_DOT_VERSION > 0)
13648                                 || (   len > 0
13649                                     && isALPHA_FOLD_EQ(ender, 's')
13650                                     && isALPHA_FOLD_EQ(*(s-1), 's'))
13651 #endif
13652                         )) {
13653                             maybe_exactfu = FALSE;
13654                         }
13655                     }
13656
13657                     /* Even when folding, we store just the input character, as
13658                      * we have an array that finds its fold quickly */
13659                     *(s++) = (char) ender;
13660                 }
13661                 else {  /* FOLD, and UTF (or sharp s) */
13662                     /* Unlike the non-fold case, we do actually have to
13663                      * calculate the results here in pass 1.  This is for two
13664                      * reasons, the folded length may be longer than the
13665                      * unfolded, and we have to calculate how many EXACTish
13666                      * nodes it will take; and we may run out of room in a node
13667                      * in the middle of a potential multi-char fold, and have
13668                      * to back off accordingly.  */
13669
13670                     UV folded;
13671                     if (isASCII_uni(ender)) {
13672                         folded = toFOLD(ender);
13673                         *(s)++ = (U8) folded;
13674                     }
13675                     else {
13676                         STRLEN foldlen;
13677
13678                         folded = _to_uni_fold_flags(
13679                                      ender,
13680                                      (U8 *) s,
13681                                      &foldlen,
13682                                      FOLD_FLAGS_FULL | ((ASCII_FOLD_RESTRICTED)
13683                                                         ? FOLD_FLAGS_NOMIX_ASCII
13684                                                         : 0));
13685                         s += foldlen;
13686
13687                         /* The loop increments <len> each time, as all but this
13688                          * path (and one other) through it add a single byte to
13689                          * the EXACTish node.  But this one has changed len to
13690                          * be the correct final value, so subtract one to
13691                          * cancel out the increment that follows */
13692                         len += foldlen - 1;
13693                     }
13694                     /* If this node only contains non-folding code points so
13695                      * far, see if this new one is also non-folding */
13696                     if (maybe_exact) {
13697                         if (folded != ender) {
13698                             maybe_exact = FALSE;
13699                         }
13700                         else {
13701                             /* Here the fold is the original; we have to check
13702                              * further to see if anything folds to it */
13703                             if (_invlist_contains_cp(PL_utf8_foldable,
13704                                                         ender))
13705                             {
13706                                 maybe_exact = FALSE;
13707                             }
13708                         }
13709                     }
13710                     ender = folded;
13711                 }
13712
13713                 if (next_is_quantifier) {
13714
13715                     /* Here, the next input is a quantifier, and to get here,
13716                      * the current character is the only one in the node.
13717                      * Also, here <len> doesn't include the final byte for this
13718                      * character */
13719                     len++;
13720                     goto loopdone;
13721                 }
13722
13723             } /* End of loop through literal characters */
13724
13725             /* Here we have either exhausted the input or ran out of room in
13726              * the node.  (If we encountered a character that can't be in the
13727              * node, transfer is made directly to <loopdone>, and so we
13728              * wouldn't have fallen off the end of the loop.)  In the latter
13729              * case, we artificially have to split the node into two, because
13730              * we just don't have enough space to hold everything.  This
13731              * creates a problem if the final character participates in a
13732              * multi-character fold in the non-final position, as a match that
13733              * should have occurred won't, due to the way nodes are matched,
13734              * and our artificial boundary.  So back off until we find a non-
13735              * problematic character -- one that isn't at the beginning or
13736              * middle of such a fold.  (Either it doesn't participate in any
13737              * folds, or appears only in the final position of all the folds it
13738              * does participate in.)  A better solution with far fewer false
13739              * positives, and that would fill the nodes more completely, would
13740              * be to actually have available all the multi-character folds to
13741              * test against, and to back-off only far enough to be sure that
13742              * this node isn't ending with a partial one.  <upper_parse> is set
13743              * further below (if we need to reparse the node) to include just
13744              * up through that final non-problematic character that this code
13745              * identifies, so when it is set to less than the full node, we can
13746              * skip the rest of this */
13747             if (FOLD && p < RExC_end && upper_parse == MAX_NODE_STRING_SIZE) {
13748
13749                 const STRLEN full_len = len;
13750
13751                 assert(len >= MAX_NODE_STRING_SIZE);
13752
13753                 /* Here, <s> points to the final byte of the final character.
13754                  * Look backwards through the string until find a non-
13755                  * problematic character */
13756
13757                 if (! UTF) {
13758
13759                     /* This has no multi-char folds to non-UTF characters */
13760                     if (ASCII_FOLD_RESTRICTED) {
13761                         goto loopdone;
13762                     }
13763
13764                     while (--s >= s0 && IS_NON_FINAL_FOLD(*s)) { }
13765                     len = s - s0 + 1;
13766                 }
13767                 else {
13768                     if (!  PL_NonL1NonFinalFold) {
13769                         PL_NonL1NonFinalFold = _new_invlist_C_array(
13770                                         NonL1_Perl_Non_Final_Folds_invlist);
13771                     }
13772
13773                     /* Point to the first byte of the final character */
13774                     s = (char *) utf8_hop((U8 *) s, -1);
13775
13776                     while (s >= s0) {   /* Search backwards until find
13777                                            non-problematic char */
13778                         if (UTF8_IS_INVARIANT(*s)) {
13779
13780                             /* There are no ascii characters that participate
13781                              * in multi-char folds under /aa.  In EBCDIC, the
13782                              * non-ascii invariants are all control characters,
13783                              * so don't ever participate in any folds. */
13784                             if (ASCII_FOLD_RESTRICTED
13785                                 || ! IS_NON_FINAL_FOLD(*s))
13786                             {
13787                                 break;
13788                             }
13789                         }
13790                         else if (UTF8_IS_DOWNGRADEABLE_START(*s)) {
13791                             if (! IS_NON_FINAL_FOLD(EIGHT_BIT_UTF8_TO_NATIVE(
13792                                                                   *s, *(s+1))))
13793                             {
13794                                 break;
13795                             }
13796                         }
13797                         else if (! _invlist_contains_cp(
13798                                         PL_NonL1NonFinalFold,
13799                                         valid_utf8_to_uvchr((U8 *) s, NULL)))
13800                         {
13801                             break;
13802                         }
13803
13804                         /* Here, the current character is problematic in that
13805                          * it does occur in the non-final position of some
13806                          * fold, so try the character before it, but have to
13807                          * special case the very first byte in the string, so
13808                          * we don't read outside the string */
13809                         s = (s == s0) ? s -1 : (char *) utf8_hop((U8 *) s, -1);
13810                     } /* End of loop backwards through the string */
13811
13812                     /* If there were only problematic characters in the string,
13813                      * <s> will point to before s0, in which case the length
13814                      * should be 0, otherwise include the length of the
13815                      * non-problematic character just found */
13816                     len = (s < s0) ? 0 : s - s0 + UTF8SKIP(s);
13817                 }
13818
13819                 /* Here, have found the final character, if any, that is
13820                  * non-problematic as far as ending the node without splitting
13821                  * it across a potential multi-char fold.  <len> contains the
13822                  * number of bytes in the node up-to and including that
13823                  * character, or is 0 if there is no such character, meaning
13824                  * the whole node contains only problematic characters.  In
13825                  * this case, give up and just take the node as-is.  We can't
13826                  * do any better */
13827                 if (len == 0) {
13828                     len = full_len;
13829
13830                     /* If the node ends in an 's' we make sure it stays EXACTF,
13831                      * as if it turns into an EXACTFU, it could later get
13832                      * joined with another 's' that would then wrongly match
13833                      * the sharp s */
13834                     if (maybe_exactfu && isALPHA_FOLD_EQ(ender, 's'))
13835                     {
13836                         maybe_exactfu = FALSE;
13837                     }
13838                 } else {
13839
13840                     /* Here, the node does contain some characters that aren't
13841                      * problematic.  If one such is the final character in the
13842                      * node, we are done */
13843                     if (len == full_len) {
13844                         goto loopdone;
13845                     }
13846                     else if (len + ((UTF) ? UTF8SKIP(s) : 1) == full_len) {
13847
13848                         /* If the final character is problematic, but the
13849                          * penultimate is not, back-off that last character to
13850                          * later start a new node with it */
13851                         p = oldp;
13852                         goto loopdone;
13853                     }
13854
13855                     /* Here, the final non-problematic character is earlier
13856                      * in the input than the penultimate character.  What we do
13857                      * is reparse from the beginning, going up only as far as
13858                      * this final ok one, thus guaranteeing that the node ends
13859                      * in an acceptable character.  The reason we reparse is
13860                      * that we know how far in the character is, but we don't
13861                      * know how to correlate its position with the input parse.
13862                      * An alternate implementation would be to build that
13863                      * correlation as we go along during the original parse,
13864                      * but that would entail extra work for every node, whereas
13865                      * this code gets executed only when the string is too
13866                      * large for the node, and the final two characters are
13867                      * problematic, an infrequent occurrence.  Yet another
13868                      * possible strategy would be to save the tail of the
13869                      * string, and the next time regatom is called, initialize
13870                      * with that.  The problem with this is that unless you
13871                      * back off one more character, you won't be guaranteed
13872                      * regatom will get called again, unless regbranch,
13873                      * regpiece ... are also changed.  If you do back off that
13874                      * extra character, so that there is input guaranteed to
13875                      * force calling regatom, you can't handle the case where
13876                      * just the first character in the node is acceptable.  I
13877                      * (khw) decided to try this method which doesn't have that
13878                      * pitfall; if performance issues are found, we can do a
13879                      * combination of the current approach plus that one */
13880                     upper_parse = len;
13881                     len = 0;
13882                     s = s0;
13883                     goto reparse;
13884                 }
13885             }   /* End of verifying node ends with an appropriate char */
13886
13887           loopdone:   /* Jumped to when encounters something that shouldn't be
13888                          in the node */
13889
13890             /* I (khw) don't know if you can get here with zero length, but the
13891              * old code handled this situation by creating a zero-length EXACT
13892              * node.  Might as well be NOTHING instead */
13893             if (len == 0) {
13894                 OP(ret) = NOTHING;
13895             }
13896             else {
13897                 if (FOLD) {
13898                     /* If 'maybe_exact' is still set here, means there are no
13899                      * code points in the node that participate in folds;
13900                      * similarly for 'maybe_exactfu' and code points that match
13901                      * differently depending on UTF8ness of the target string
13902                      * (for /u), or depending on locale for /l */
13903                     if (maybe_exact) {
13904                         OP(ret) = (LOC)
13905                                   ? EXACTL
13906                                   : EXACT;
13907                     }
13908                     else if (maybe_exactfu) {
13909                         OP(ret) = (LOC)
13910                                   ? EXACTFLU8
13911                                   : EXACTFU;
13912                     }
13913                 }
13914                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, len, ender,
13915                                            FALSE /* Don't look to see if could
13916                                                     be turned into an EXACT
13917                                                     node, as we have already
13918                                                     computed that */
13919                                           );
13920             }
13921
13922             RExC_parse = p - 1;
13923             Set_Node_Cur_Length(ret, parse_start);
13924             RExC_parse = p;
13925             {
13926                 /* len is STRLEN which is unsigned, need to copy to signed */
13927                 IV iv = len;
13928                 if (iv < 0)
13929                     vFAIL("Internal disaster");
13930             }
13931
13932         } /* End of label 'defchar:' */
13933         break;
13934     } /* End of giant switch on input character */
13935
13936     /* Position parse to next real character */
13937     skip_to_be_ignored_text(pRExC_state, &RExC_parse,
13938                                             FALSE /* Don't force to /x */ );
13939     if (PASS2 && *RExC_parse == '{' && OP(ret) != SBOL && ! regcurly(RExC_parse)) {
13940         ckWARNregdep(RExC_parse + 1, "Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.30), passed through");
13941     }
13942
13943     return(ret);
13944 }
13945
13946
13947 STATIC void
13948 S_populate_ANYOF_from_invlist(pTHX_ regnode *node, SV** invlist_ptr)
13949 {
13950     /* Uses the inversion list '*invlist_ptr' to populate the ANYOF 'node'.  It
13951      * sets up the bitmap and any flags, removing those code points from the
13952      * inversion list, setting it to NULL should it become completely empty */
13953
13954     PERL_ARGS_ASSERT_POPULATE_ANYOF_FROM_INVLIST;
13955     assert(PL_regkind[OP(node)] == ANYOF);
13956
13957     ANYOF_BITMAP_ZERO(node);
13958     if (*invlist_ptr) {
13959
13960         /* This gets set if we actually need to modify things */
13961         bool change_invlist = FALSE;
13962
13963         UV start, end;
13964
13965         /* Start looking through *invlist_ptr */
13966         invlist_iterinit(*invlist_ptr);
13967         while (invlist_iternext(*invlist_ptr, &start, &end)) {
13968             UV high;
13969             int i;
13970
13971             if (end == UV_MAX && start <= NUM_ANYOF_CODE_POINTS) {
13972                 ANYOF_FLAGS(node) |= ANYOF_MATCHES_ALL_ABOVE_BITMAP;
13973             }
13974
13975             /* Quit if are above what we should change */
13976             if (start >= NUM_ANYOF_CODE_POINTS) {
13977                 break;
13978             }
13979
13980             change_invlist = TRUE;
13981
13982             /* Set all the bits in the range, up to the max that we are doing */
13983             high = (end < NUM_ANYOF_CODE_POINTS - 1)
13984                    ? end
13985                    : NUM_ANYOF_CODE_POINTS - 1;
13986             for (i = start; i <= (int) high; i++) {
13987                 if (! ANYOF_BITMAP_TEST(node, i)) {
13988                     ANYOF_BITMAP_SET(node, i);
13989                 }
13990             }
13991         }
13992         invlist_iterfinish(*invlist_ptr);
13993
13994         /* Done with loop; remove any code points that are in the bitmap from
13995          * *invlist_ptr; similarly for code points above the bitmap if we have
13996          * a flag to match all of them anyways */
13997         if (change_invlist) {
13998             _invlist_subtract(*invlist_ptr, PL_InBitmap, invlist_ptr);
13999         }
14000         if (ANYOF_FLAGS(node) & ANYOF_MATCHES_ALL_ABOVE_BITMAP) {
14001             _invlist_intersection(*invlist_ptr, PL_InBitmap, invlist_ptr);
14002         }
14003
14004         /* If have completely emptied it, remove it completely */
14005         if (_invlist_len(*invlist_ptr) == 0) {
14006             SvREFCNT_dec_NN(*invlist_ptr);
14007             *invlist_ptr = NULL;
14008         }
14009     }
14010 }
14011
14012 /* Parse POSIX character classes: [[:foo:]], [[=foo=]], [[.foo.]].
14013    Character classes ([:foo:]) can also be negated ([:^foo:]).
14014    Returns a named class id (ANYOF_XXX) if successful, -1 otherwise.
14015    Equivalence classes ([=foo=]) and composites ([.foo.]) are parsed,
14016    but trigger failures because they are currently unimplemented. */
14017
14018 #define POSIXCC_DONE(c)   ((c) == ':')
14019 #define POSIXCC_NOTYET(c) ((c) == '=' || (c) == '.')
14020 #define POSIXCC(c) (POSIXCC_DONE(c) || POSIXCC_NOTYET(c))
14021 #define MAYBE_POSIXCC(c) (POSIXCC(c) || (c) == '^' || (c) == ';')
14022
14023 #define WARNING_PREFIX              "Assuming NOT a POSIX class since "
14024 #define NO_BLANKS_POSIX_WARNING     "no blanks are allowed in one"
14025 #define SEMI_COLON_POSIX_WARNING    "a semi-colon was found instead of a colon"
14026
14027 #define NOT_MEANT_TO_BE_A_POSIX_CLASS (OOB_NAMEDCLASS - 1)
14028
14029 /* 'posix_warnings' and 'warn_text' are names of variables in the following
14030  * routine. q.v. */
14031 #define ADD_POSIX_WARNING(p, text)  STMT_START {                            \
14032         if (posix_warnings) {                                               \
14033             if (! RExC_warn_text ) RExC_warn_text = (AV *) sv_2mortal((SV *) newAV()); \
14034             av_push(RExC_warn_text, Perl_newSVpvf(aTHX_                          \
14035                                              WARNING_PREFIX                 \
14036                                              text                           \
14037                                              REPORT_LOCATION,               \
14038                                              REPORT_LOCATION_ARGS(p)));     \
14039         }                                                                   \
14040     } STMT_END
14041 #define CLEAR_POSIX_WARNINGS()                                              \
14042     STMT_START {                                                            \
14043         if (posix_warnings && RExC_warn_text)                               \
14044             av_clear(RExC_warn_text);                                       \
14045     } STMT_END
14046
14047 #define CLEAR_POSIX_WARNINGS_AND_RETURN(ret)                                \
14048     STMT_START {                                                            \
14049         CLEAR_POSIX_WARNINGS();                                             \
14050         return ret;                                                         \
14051     } STMT_END
14052
14053 STATIC int
14054 S_handle_possible_posix(pTHX_ RExC_state_t *pRExC_state,
14055
14056     const char * const s,      /* Where the putative posix class begins.
14057                                   Normally, this is one past the '['.  This
14058                                   parameter exists so it can be somewhere
14059                                   besides RExC_parse. */
14060     char ** updated_parse_ptr, /* Where to set the updated parse pointer, or
14061                                   NULL */
14062     AV ** posix_warnings,      /* Where to place any generated warnings, or
14063                                   NULL */
14064     const bool check_only      /* Don't die if error */
14065 )
14066 {
14067     /* This parses what the caller thinks may be one of the three POSIX
14068      * constructs:
14069      *  1) a character class, like [:blank:]
14070      *  2) a collating symbol, like [. .]
14071      *  3) an equivalence class, like [= =]
14072      * In the latter two cases, it croaks if it finds a syntactically legal
14073      * one, as these are not handled by Perl.
14074      *
14075      * The main purpose is to look for a POSIX character class.  It returns:
14076      *  a) the class number
14077      *      if it is a completely syntactically and semantically legal class.
14078      *      'updated_parse_ptr', if not NULL, is set to point to just after the
14079      *      closing ']' of the class
14080      *  b) OOB_NAMEDCLASS
14081      *      if it appears that one of the three POSIX constructs was meant, but
14082      *      its specification was somehow defective.  'updated_parse_ptr', if
14083      *      not NULL, is set to point to the character just after the end
14084      *      character of the class.  See below for handling of warnings.
14085      *  c) NOT_MEANT_TO_BE_A_POSIX_CLASS
14086      *      if it  doesn't appear that a POSIX construct was intended.
14087      *      'updated_parse_ptr' is not changed.  No warnings nor errors are
14088      *      raised.
14089      *
14090      * In b) there may be errors or warnings generated.  If 'check_only' is
14091      * TRUE, then any errors are discarded.  Warnings are returned to the
14092      * caller via an AV* created into '*posix_warnings' if it is not NULL.  If
14093      * instead it is NULL, warnings are suppressed.  This is done in all
14094      * passes.  The reason for this is that the rest of the parsing is heavily
14095      * dependent on whether this routine found a valid posix class or not.  If
14096      * it did, the closing ']' is absorbed as part of the class.  If no class,
14097      * or an invalid one is found, any ']' will be considered the terminator of
14098      * the outer bracketed character class, leading to very different results.
14099      * In particular, a '(?[ ])' construct will likely have a syntax error if
14100      * the class is parsed other than intended, and this will happen in pass1,
14101      * before the warnings would normally be output.  This mechanism allows the
14102      * caller to output those warnings in pass1 just before dieing, giving a
14103      * much better clue as to what is wrong.
14104      *
14105      * The reason for this function, and its complexity is that a bracketed
14106      * character class can contain just about anything.  But it's easy to
14107      * mistype the very specific posix class syntax but yielding a valid
14108      * regular bracketed class, so it silently gets compiled into something
14109      * quite unintended.
14110      *
14111      * The solution adopted here maintains backward compatibility except that
14112      * it adds a warning if it looks like a posix class was intended but
14113      * improperly specified.  The warning is not raised unless what is input
14114      * very closely resembles one of the 14 legal posix classes.  To do this,
14115      * it uses fuzzy parsing.  It calculates how many single-character edits it
14116      * would take to transform what was input into a legal posix class.  Only
14117      * if that number is quite small does it think that the intention was a
14118      * posix class.  Obviously these are heuristics, and there will be cases
14119      * where it errs on one side or another, and they can be tweaked as
14120      * experience informs.
14121      *
14122      * The syntax for a legal posix class is:
14123      *
14124      * qr/(?xa: \[ : \^? [[:lower:]]{4,6} : \] )/
14125      *
14126      * What this routine considers syntactically to be an intended posix class
14127      * is this (the comments indicate some restrictions that the pattern
14128      * doesn't show):
14129      *
14130      *  qr/(?x: \[?                         # The left bracket, possibly
14131      *                                      # omitted
14132      *          \h*                         # possibly followed by blanks
14133      *          (?: \^ \h* )?               # possibly a misplaced caret
14134      *          [:;]?                       # The opening class character,
14135      *                                      # possibly omitted.  A typo
14136      *                                      # semi-colon can also be used.
14137      *          \h*
14138      *          \^?                         # possibly a correctly placed
14139      *                                      # caret, but not if there was also
14140      *                                      # a misplaced one
14141      *          \h*
14142      *          .{3,15}                     # The class name.  If there are
14143      *                                      # deviations from the legal syntax,
14144      *                                      # its edit distance must be close
14145      *                                      # to a real class name in order
14146      *                                      # for it to be considered to be
14147      *                                      # an intended posix class.
14148      *          \h*
14149      *          [[:punct:]]?                # The closing class character,
14150      *                                      # possibly omitted.  If not a colon
14151      *                                      # nor semi colon, the class name
14152      *                                      # must be even closer to a valid
14153      *                                      # one
14154      *          \h*
14155      *          \]?                         # The right bracket, possibly
14156      *                                      # omitted.
14157      *     )/
14158      *
14159      * In the above, \h must be ASCII-only.
14160      *
14161      * These are heuristics, and can be tweaked as field experience dictates.
14162      * There will be cases when someone didn't intend to specify a posix class
14163      * that this warns as being so.  The goal is to minimize these, while
14164      * maximizing the catching of things intended to be a posix class that
14165      * aren't parsed as such.
14166      */
14167
14168     const char* p             = s;
14169     const char * const e      = RExC_end;
14170     unsigned complement       = 0;      /* If to complement the class */
14171     bool found_problem        = FALSE;  /* Assume OK until proven otherwise */
14172     bool has_opening_bracket  = FALSE;
14173     bool has_opening_colon    = FALSE;
14174     int class_number          = OOB_NAMEDCLASS; /* Out-of-bounds until find
14175                                                    valid class */
14176     const char * possible_end = NULL;   /* used for a 2nd parse pass */
14177     const char* name_start;             /* ptr to class name first char */
14178
14179     /* If the number of single-character typos the input name is away from a
14180      * legal name is no more than this number, it is considered to have meant
14181      * the legal name */
14182     int max_distance          = 2;
14183
14184     /* to store the name.  The size determines the maximum length before we
14185      * decide that no posix class was intended.  Should be at least
14186      * sizeof("alphanumeric") */
14187     UV input_text[15];
14188     STATIC_ASSERT_DECL(C_ARRAY_LENGTH(input_text) >= sizeof "alphanumeric");
14189
14190     PERL_ARGS_ASSERT_HANDLE_POSSIBLE_POSIX;
14191
14192     CLEAR_POSIX_WARNINGS();
14193
14194     if (p >= e) {
14195         return NOT_MEANT_TO_BE_A_POSIX_CLASS;
14196     }
14197
14198     if (*(p - 1) != '[') {
14199         ADD_POSIX_WARNING(p, "it doesn't start with a '['");
14200         found_problem = TRUE;
14201     }
14202     else {
14203         has_opening_bracket = TRUE;
14204     }
14205
14206     /* They could be confused and think you can put spaces between the
14207      * components */
14208     if (isBLANK(*p)) {
14209         found_problem = TRUE;
14210
14211         do {
14212             p++;
14213         } while (p < e && isBLANK(*p));
14214
14215         ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
14216     }
14217
14218     /* For [. .] and [= =].  These are quite different internally from [: :],
14219      * so they are handled separately.  */
14220     if (POSIXCC_NOTYET(*p) && p < e - 3) /* 1 for the close, and 1 for the ']'
14221                                             and 1 for at least one char in it
14222                                           */
14223     {
14224         const char open_char  = *p;
14225         const char * temp_ptr = p + 1;
14226
14227         /* These two constructs are not handled by perl, and if we find a
14228          * syntactically valid one, we croak.  khw, who wrote this code, finds
14229          * this explanation of them very unclear:
14230          * http://pubs.opengroup.org/onlinepubs/009696899/basedefs/xbd_chap09.html
14231          * And searching the rest of the internet wasn't very helpful either.
14232          * It looks like just about any byte can be in these constructs,
14233          * depending on the locale.  But unless the pattern is being compiled
14234          * under /l, which is very rare, Perl runs under the C or POSIX locale.
14235          * In that case, it looks like [= =] isn't allowed at all, and that
14236          * [. .] could be any single code point, but for longer strings the
14237          * constituent characters would have to be the ASCII alphabetics plus
14238          * the minus-hyphen.  Any sensible locale definition would limit itself
14239          * to these.  And any portable one definitely should.  Trying to parse
14240          * the general case is a nightmare (see [perl #127604]).  So, this code
14241          * looks only for interiors of these constructs that match:
14242          *      qr/.|[-\w]{2,}/
14243          * Using \w relaxes the apparent rules a little, without adding much
14244          * danger of mistaking something else for one of these constructs.
14245          *
14246          * [. .] in some implementations described on the internet is usable to
14247          * escape a character that otherwise is special in bracketed character
14248          * classes.  For example [.].] means a literal right bracket instead of
14249          * the ending of the class
14250          *
14251          * [= =] can legitimately contain a [. .] construct, but we don't
14252          * handle this case, as that [. .] construct will later get parsed
14253          * itself and croak then.  And [= =] is checked for even when not under
14254          * /l, as Perl has long done so.
14255          *
14256          * The code below relies on there being a trailing NUL, so it doesn't
14257          * have to keep checking if the parse ptr < e.
14258          */
14259         if (temp_ptr[1] == open_char) {
14260             temp_ptr++;
14261         }
14262         else while (    temp_ptr < e
14263                     && (isWORDCHAR(*temp_ptr) || *temp_ptr == '-'))
14264         {
14265             temp_ptr++;
14266         }
14267
14268         if (*temp_ptr == open_char) {
14269             temp_ptr++;
14270             if (*temp_ptr == ']') {
14271                 temp_ptr++;
14272                 if (! found_problem && ! check_only) {
14273                     RExC_parse = (char *) temp_ptr;
14274                     vFAIL3("POSIX syntax [%c %c] is reserved for future "
14275                             "extensions", open_char, open_char);
14276                 }
14277
14278                 /* Here, the syntax wasn't completely valid, or else the call
14279                  * is to check-only */
14280                 if (updated_parse_ptr) {
14281                     *updated_parse_ptr = (char *) temp_ptr;
14282                 }
14283
14284                 CLEAR_POSIX_WARNINGS_AND_RETURN(OOB_NAMEDCLASS);
14285             }
14286         }
14287
14288         /* If we find something that started out to look like one of these
14289          * constructs, but isn't, we continue below so that it can be checked
14290          * for being a class name with a typo of '.' or '=' instead of a colon.
14291          * */
14292     }
14293
14294     /* Here, we think there is a possibility that a [: :] class was meant, and
14295      * we have the first real character.  It could be they think the '^' comes
14296      * first */
14297     if (*p == '^') {
14298         found_problem = TRUE;
14299         ADD_POSIX_WARNING(p + 1, "the '^' must come after the colon");
14300         complement = 1;
14301         p++;
14302
14303         if (isBLANK(*p)) {
14304             found_problem = TRUE;
14305
14306             do {
14307                 p++;
14308             } while (p < e && isBLANK(*p));
14309
14310             ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
14311         }
14312     }
14313
14314     /* But the first character should be a colon, which they could have easily
14315      * mistyped on a qwerty keyboard as a semi-colon (and which may be hard to
14316      * distinguish from a colon, so treat that as a colon).  */
14317     if (*p == ':') {
14318         p++;
14319         has_opening_colon = TRUE;
14320     }
14321     else if (*p == ';') {
14322         found_problem = TRUE;
14323         p++;
14324         ADD_POSIX_WARNING(p, SEMI_COLON_POSIX_WARNING);
14325         has_opening_colon = TRUE;
14326     }
14327     else {
14328         found_problem = TRUE;
14329         ADD_POSIX_WARNING(p, "there must be a starting ':'");
14330
14331         /* Consider an initial punctuation (not one of the recognized ones) to
14332          * be a left terminator */
14333         if (*p != '^' && *p != ']' && isPUNCT(*p)) {
14334             p++;
14335         }
14336     }
14337
14338     /* They may think that you can put spaces between the components */
14339     if (isBLANK(*p)) {
14340         found_problem = TRUE;
14341
14342         do {
14343             p++;
14344         } while (p < e && isBLANK(*p));
14345
14346         ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
14347     }
14348
14349     if (*p == '^') {
14350
14351         /* We consider something like [^:^alnum:]] to not have been intended to
14352          * be a posix class, but XXX maybe we should */
14353         if (complement) {
14354             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
14355         }
14356
14357         complement = 1;
14358         p++;
14359     }
14360
14361     /* Again, they may think that you can put spaces between the components */
14362     if (isBLANK(*p)) {
14363         found_problem = TRUE;
14364
14365         do {
14366             p++;
14367         } while (p < e && isBLANK(*p));
14368
14369         ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
14370     }
14371
14372     if (*p == ']') {
14373
14374         /* XXX This ']' may be a typo, and something else was meant.  But
14375          * treating it as such creates enough complications, that that
14376          * possibility isn't currently considered here.  So we assume that the
14377          * ']' is what is intended, and if we've already found an initial '[',
14378          * this leaves this construct looking like [:] or [:^], which almost
14379          * certainly weren't intended to be posix classes */
14380         if (has_opening_bracket) {
14381             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
14382         }
14383
14384         /* But this function can be called when we parse the colon for
14385          * something like qr/[alpha:]]/, so we back up to look for the
14386          * beginning */
14387         p--;
14388
14389         if (*p == ';') {
14390             found_problem = TRUE;
14391             ADD_POSIX_WARNING(p, SEMI_COLON_POSIX_WARNING);
14392         }
14393         else if (*p != ':') {
14394
14395             /* XXX We are currently very restrictive here, so this code doesn't
14396              * consider the possibility that, say, /[alpha.]]/ was intended to
14397              * be a posix class. */
14398             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
14399         }
14400
14401         /* Here we have something like 'foo:]'.  There was no initial colon,
14402          * and we back up over 'foo.  XXX Unlike the going forward case, we
14403          * don't handle typos of non-word chars in the middle */
14404         has_opening_colon = FALSE;
14405         p--;
14406
14407         while (p > RExC_start && isWORDCHAR(*p)) {
14408             p--;
14409         }
14410         p++;
14411
14412         /* Here, we have positioned ourselves to where we think the first
14413          * character in the potential class is */
14414     }
14415
14416     /* Now the interior really starts.  There are certain key characters that
14417      * can end the interior, or these could just be typos.  To catch both
14418      * cases, we may have to do two passes.  In the first pass, we keep on
14419      * going unless we come to a sequence that matches
14420      *      qr/ [[:punct:]] [[:blank:]]* \] /xa
14421      * This means it takes a sequence to end the pass, so two typos in a row if
14422      * that wasn't what was intended.  If the class is perfectly formed, just
14423      * this one pass is needed.  We also stop if there are too many characters
14424      * being accumulated, but this number is deliberately set higher than any
14425      * real class.  It is set high enough so that someone who thinks that
14426      * 'alphanumeric' is a correct name would get warned that it wasn't.
14427      * While doing the pass, we keep track of where the key characters were in
14428      * it.  If we don't find an end to the class, and one of the key characters
14429      * was found, we redo the pass, but stop when we get to that character.
14430      * Thus the key character was considered a typo in the first pass, but a
14431      * terminator in the second.  If two key characters are found, we stop at
14432      * the second one in the first pass.  Again this can miss two typos, but
14433      * catches a single one
14434      *
14435      * In the first pass, 'possible_end' starts as NULL, and then gets set to
14436      * point to the first key character.  For the second pass, it starts as -1.
14437      * */
14438
14439     name_start = p;
14440   parse_name:
14441     {
14442         bool has_blank               = FALSE;
14443         bool has_upper               = FALSE;
14444         bool has_terminating_colon   = FALSE;
14445         bool has_terminating_bracket = FALSE;
14446         bool has_semi_colon          = FALSE;
14447         unsigned int name_len        = 0;
14448         int punct_count              = 0;
14449
14450         while (p < e) {
14451
14452             /* Squeeze out blanks when looking up the class name below */
14453             if (isBLANK(*p) ) {
14454                 has_blank = TRUE;
14455                 found_problem = TRUE;
14456                 p++;
14457                 continue;
14458             }
14459
14460             /* The name will end with a punctuation */
14461             if (isPUNCT(*p)) {
14462                 const char * peek = p + 1;
14463
14464                 /* Treat any non-']' punctuation followed by a ']' (possibly
14465                  * with intervening blanks) as trying to terminate the class.
14466                  * ']]' is very likely to mean a class was intended (but
14467                  * missing the colon), but the warning message that gets
14468                  * generated shows the error position better if we exit the
14469                  * loop at the bottom (eventually), so skip it here. */
14470                 if (*p != ']') {
14471                     if (peek < e && isBLANK(*peek)) {
14472                         has_blank = TRUE;
14473                         found_problem = TRUE;
14474                         do {
14475                             peek++;
14476                         } while (peek < e && isBLANK(*peek));
14477                     }
14478
14479                     if (peek < e && *peek == ']') {
14480                         has_terminating_bracket = TRUE;
14481                         if (*p == ':') {
14482                             has_terminating_colon = TRUE;
14483                         }
14484                         else if (*p == ';') {
14485                             has_semi_colon = TRUE;
14486                             has_terminating_colon = TRUE;
14487                         }
14488                         else {
14489                             found_problem = TRUE;
14490                         }
14491                         p = peek + 1;
14492                         goto try_posix;
14493                     }
14494                 }
14495
14496                 /* Here we have punctuation we thought didn't end the class.
14497                  * Keep track of the position of the key characters that are
14498                  * more likely to have been class-enders */
14499                 if (*p == ']' || *p == '[' || *p == ':' || *p == ';') {
14500
14501                     /* Allow just one such possible class-ender not actually
14502                      * ending the class. */
14503                     if (possible_end) {
14504                         break;
14505                     }
14506                     possible_end = p;
14507                 }
14508
14509                 /* If we have too many punctuation characters, no use in
14510                  * keeping going */
14511                 if (++punct_count > max_distance) {
14512                     break;
14513                 }
14514
14515                 /* Treat the punctuation as a typo. */
14516                 input_text[name_len++] = *p;
14517                 p++;
14518             }
14519             else if (isUPPER(*p)) { /* Use lowercase for lookup */
14520                 input_text[name_len++] = toLOWER(*p);
14521                 has_upper = TRUE;
14522                 found_problem = TRUE;
14523                 p++;
14524             } else if (! UTF || UTF8_IS_INVARIANT(*p)) {
14525                 input_text[name_len++] = *p;
14526                 p++;
14527             }
14528             else {
14529                 input_text[name_len++] = utf8_to_uvchr_buf((U8 *) p, e, NULL);
14530                 p+= UTF8SKIP(p);
14531             }
14532
14533             /* The declaration of 'input_text' is how long we allow a potential
14534              * class name to be, before saying they didn't mean a class name at
14535              * all */
14536             if (name_len >= C_ARRAY_LENGTH(input_text)) {
14537                 break;
14538             }
14539         }
14540
14541         /* We get to here when the possible class name hasn't been properly
14542          * terminated before:
14543          *   1) we ran off the end of the pattern; or
14544          *   2) found two characters, each of which might have been intended to
14545          *      be the name's terminator
14546          *   3) found so many punctuation characters in the purported name,
14547          *      that the edit distance to a valid one is exceeded
14548          *   4) we decided it was more characters than anyone could have
14549          *      intended to be one. */
14550
14551         found_problem = TRUE;
14552
14553         /* In the final two cases, we know that looking up what we've
14554          * accumulated won't lead to a match, even a fuzzy one. */
14555         if (   name_len >= C_ARRAY_LENGTH(input_text)
14556             || punct_count > max_distance)
14557         {
14558             /* If there was an intermediate key character that could have been
14559              * an intended end, redo the parse, but stop there */
14560             if (possible_end && possible_end != (char *) -1) {
14561                 possible_end = (char *) -1; /* Special signal value to say
14562                                                we've done a first pass */
14563                 p = name_start;
14564                 goto parse_name;
14565             }
14566
14567             /* Otherwise, it can't have meant to have been a class */
14568             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
14569         }
14570
14571         /* If we ran off the end, and the final character was a punctuation
14572          * one, back up one, to look at that final one just below.  Later, we
14573          * will restore the parse pointer if appropriate */
14574         if (name_len && p == e && isPUNCT(*(p-1))) {
14575             p--;
14576             name_len--;
14577         }
14578
14579         if (p < e && isPUNCT(*p)) {
14580             if (*p == ']') {
14581                 has_terminating_bracket = TRUE;
14582
14583                 /* If this is a 2nd ']', and the first one is just below this
14584                  * one, consider that to be the real terminator.  This gives a
14585                  * uniform and better positioning for the warning message  */
14586                 if (   possible_end
14587                     && possible_end != (char *) -1
14588                     && *possible_end == ']'
14589                     && name_len && input_text[name_len - 1] == ']')
14590                 {
14591                     name_len--;
14592                     p = possible_end;
14593
14594                     /* And this is actually equivalent to having done the 2nd
14595                      * pass now, so set it to not try again */
14596                     possible_end = (char *) -1;
14597                 }
14598             }
14599             else {
14600                 if (*p == ':') {
14601                     has_terminating_colon = TRUE;
14602                 }
14603                 else if (*p == ';') {
14604                     has_semi_colon = TRUE;
14605                     has_terminating_colon = TRUE;
14606                 }
14607                 p++;
14608             }
14609         }
14610
14611     try_posix:
14612
14613         /* Here, we have a class name to look up.  We can short circuit the
14614          * stuff below for short names that can't possibly be meant to be a
14615          * class name.  (We can do this on the first pass, as any second pass
14616          * will yield an even shorter name) */
14617         if (name_len < 3) {
14618             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
14619         }
14620
14621         /* Find which class it is.  Initially switch on the length of the name.
14622          * */
14623         switch (name_len) {
14624             case 4:
14625                 if (memEQs(name_start, 4, "word")) {
14626                     /* this is not POSIX, this is the Perl \w */
14627                     class_number = ANYOF_WORDCHAR;
14628                 }
14629                 break;
14630             case 5:
14631                 /* Names all of length 5: alnum alpha ascii blank cntrl digit
14632                  *                        graph lower print punct space upper
14633                  * Offset 4 gives the best switch position.  */
14634                 switch (name_start[4]) {
14635                     case 'a':
14636                         if (memBEGINs(name_start, 5, "alph")) /* alpha */
14637                             class_number = ANYOF_ALPHA;
14638                         break;
14639                     case 'e':
14640                         if (memBEGINs(name_start, 5, "spac")) /* space */
14641                             class_number = ANYOF_SPACE;
14642                         break;
14643                     case 'h':
14644                         if (memBEGINs(name_start, 5, "grap")) /* graph */
14645                             class_number = ANYOF_GRAPH;
14646                         break;
14647                     case 'i':
14648                         if (memBEGINs(name_start, 5, "asci")) /* ascii */
14649                             class_number = ANYOF_ASCII;
14650                         break;
14651                     case 'k':
14652                         if (memBEGINs(name_start, 5, "blan")) /* blank */
14653                             class_number = ANYOF_BLANK;
14654                         break;
14655                     case 'l':
14656                         if (memBEGINs(name_start, 5, "cntr")) /* cntrl */
14657                             class_number = ANYOF_CNTRL;
14658                         break;
14659                     case 'm':
14660                         if (memBEGINs(name_start, 5, "alnu")) /* alnum */
14661                             class_number = ANYOF_ALPHANUMERIC;
14662                         break;
14663                     case 'r':
14664                         if (memBEGINs(name_start, 5, "lowe")) /* lower */
14665                             class_number = (FOLD) ? ANYOF_CASED : ANYOF_LOWER;
14666                         else if (memBEGINs(name_start, 5, "uppe")) /* upper */
14667                             class_number = (FOLD) ? ANYOF_CASED : ANYOF_UPPER;
14668                         break;
14669                     case 't':
14670                         if (memBEGINs(name_start, 5, "digi")) /* digit */
14671                             class_number = ANYOF_DIGIT;
14672                         else if (memBEGINs(name_start, 5, "prin")) /* print */
14673                             class_number = ANYOF_PRINT;
14674                         else if (memBEGINs(name_start, 5, "punc")) /* punct */
14675                             class_number = ANYOF_PUNCT;
14676                         break;
14677                 }
14678                 break;
14679             case 6:
14680                 if (memEQs(name_start, 6, "xdigit"))
14681                     class_number = ANYOF_XDIGIT;
14682                 break;
14683         }
14684
14685         /* If the name exactly matches a posix class name the class number will
14686          * here be set to it, and the input almost certainly was meant to be a
14687          * posix class, so we can skip further checking.  If instead the syntax
14688          * is exactly correct, but the name isn't one of the legal ones, we
14689          * will return that as an error below.  But if neither of these apply,
14690          * it could be that no posix class was intended at all, or that one
14691          * was, but there was a typo.  We tease these apart by doing fuzzy
14692          * matching on the name */
14693         if (class_number == OOB_NAMEDCLASS && found_problem) {
14694             const UV posix_names[][6] = {
14695                                                 { 'a', 'l', 'n', 'u', 'm' },
14696                                                 { 'a', 'l', 'p', 'h', 'a' },
14697                                                 { 'a', 's', 'c', 'i', 'i' },
14698                                                 { 'b', 'l', 'a', 'n', 'k' },
14699                                                 { 'c', 'n', 't', 'r', 'l' },
14700                                                 { 'd', 'i', 'g', 'i', 't' },
14701                                                 { 'g', 'r', 'a', 'p', 'h' },
14702                                                 { 'l', 'o', 'w', 'e', 'r' },
14703                                                 { 'p', 'r', 'i', 'n', 't' },
14704                                                 { 'p', 'u', 'n', 'c', 't' },
14705                                                 { 's', 'p', 'a', 'c', 'e' },
14706                                                 { 'u', 'p', 'p', 'e', 'r' },
14707                                                 { 'w', 'o', 'r', 'd' },
14708                                                 { 'x', 'd', 'i', 'g', 'i', 't' }
14709                                             };
14710             /* The names of the above all have added NULs to make them the same
14711              * size, so we need to also have the real lengths */
14712             const UV posix_name_lengths[] = {
14713                                                 sizeof("alnum") - 1,
14714                                                 sizeof("alpha") - 1,
14715                                                 sizeof("ascii") - 1,
14716                                                 sizeof("blank") - 1,
14717                                                 sizeof("cntrl") - 1,
14718                                                 sizeof("digit") - 1,
14719                                                 sizeof("graph") - 1,
14720                                                 sizeof("lower") - 1,
14721                                                 sizeof("print") - 1,
14722                                                 sizeof("punct") - 1,
14723                                                 sizeof("space") - 1,
14724                                                 sizeof("upper") - 1,
14725                                                 sizeof("word")  - 1,
14726                                                 sizeof("xdigit")- 1
14727                                             };
14728             unsigned int i;
14729             int temp_max = max_distance;    /* Use a temporary, so if we
14730                                                reparse, we haven't changed the
14731                                                outer one */
14732
14733             /* Use a smaller max edit distance if we are missing one of the
14734              * delimiters */
14735             if (   has_opening_bracket + has_opening_colon < 2
14736                 || has_terminating_bracket + has_terminating_colon < 2)
14737             {
14738                 temp_max--;
14739             }
14740
14741             /* See if the input name is close to a legal one */
14742             for (i = 0; i < C_ARRAY_LENGTH(posix_names); i++) {
14743
14744                 /* Short circuit call if the lengths are too far apart to be
14745                  * able to match */
14746                 if (abs( (int) (name_len - posix_name_lengths[i]))
14747                     > temp_max)
14748                 {
14749                     continue;
14750                 }
14751
14752                 if (edit_distance(input_text,
14753                                   posix_names[i],
14754                                   name_len,
14755                                   posix_name_lengths[i],
14756                                   temp_max
14757                                  )
14758                     > -1)
14759                 { /* If it is close, it probably was intended to be a class */
14760                     goto probably_meant_to_be;
14761                 }
14762             }
14763
14764             /* Here the input name is not close enough to a valid class name
14765              * for us to consider it to be intended to be a posix class.  If
14766              * we haven't already done so, and the parse found a character that
14767              * could have been terminators for the name, but which we absorbed
14768              * as typos during the first pass, repeat the parse, signalling it
14769              * to stop at that character */
14770             if (possible_end && possible_end != (char *) -1) {
14771                 possible_end = (char *) -1;
14772                 p = name_start;
14773                 goto parse_name;
14774             }
14775
14776             /* Here neither pass found a close-enough class name */
14777             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
14778         }
14779
14780     probably_meant_to_be:
14781
14782         /* Here we think that a posix specification was intended.  Update any
14783          * parse pointer */
14784         if (updated_parse_ptr) {
14785             *updated_parse_ptr = (char *) p;
14786         }
14787
14788         /* If a posix class name was intended but incorrectly specified, we
14789          * output or return the warnings */
14790         if (found_problem) {
14791
14792             /* We set flags for these issues in the parse loop above instead of
14793              * adding them to the list of warnings, because we can parse it
14794              * twice, and we only want one warning instance */
14795             if (has_upper) {
14796                 ADD_POSIX_WARNING(p, "the name must be all lowercase letters");
14797             }
14798             if (has_blank) {
14799                 ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
14800             }
14801             if (has_semi_colon) {
14802                 ADD_POSIX_WARNING(p, SEMI_COLON_POSIX_WARNING);
14803             }
14804             else if (! has_terminating_colon) {
14805                 ADD_POSIX_WARNING(p, "there is no terminating ':'");
14806             }
14807             if (! has_terminating_bracket) {
14808                 ADD_POSIX_WARNING(p, "there is no terminating ']'");
14809             }
14810
14811             if (posix_warnings && RExC_warn_text && av_top_index(RExC_warn_text) > -1) {
14812                 *posix_warnings = RExC_warn_text;
14813             }
14814         }
14815         else if (class_number != OOB_NAMEDCLASS) {
14816             /* If it is a known class, return the class.  The class number
14817              * #defines are structured so each complement is +1 to the normal
14818              * one */
14819             CLEAR_POSIX_WARNINGS_AND_RETURN(class_number + complement);
14820         }
14821         else if (! check_only) {
14822
14823             /* Here, it is an unrecognized class.  This is an error (unless the
14824             * call is to check only, which we've already handled above) */
14825             const char * const complement_string = (complement)
14826                                                    ? "^"
14827                                                    : "";
14828             RExC_parse = (char *) p;
14829             vFAIL3utf8f("POSIX class [:%s%" UTF8f ":] unknown",
14830                         complement_string,
14831                         UTF8fARG(UTF, RExC_parse - name_start - 2, name_start));
14832         }
14833     }
14834
14835     return OOB_NAMEDCLASS;
14836 }
14837 #undef ADD_POSIX_WARNING
14838
14839 STATIC unsigned  int
14840 S_regex_set_precedence(const U8 my_operator) {
14841
14842     /* Returns the precedence in the (?[...]) construct of the input operator,
14843      * specified by its character representation.  The precedence follows
14844      * general Perl rules, but it extends this so that ')' and ']' have (low)
14845      * precedence even though they aren't really operators */
14846
14847     switch (my_operator) {
14848         case '!':
14849             return 5;
14850         case '&':
14851             return 4;
14852         case '^':
14853         case '|':
14854         case '+':
14855         case '-':
14856             return 3;
14857         case ')':
14858             return 2;
14859         case ']':
14860             return 1;
14861     }
14862
14863     NOT_REACHED; /* NOTREACHED */
14864     return 0;   /* Silence compiler warning */
14865 }
14866
14867 STATIC regnode *
14868 S_handle_regex_sets(pTHX_ RExC_state_t *pRExC_state, SV** return_invlist,
14869                     I32 *flagp, U32 depth,
14870                     char * const oregcomp_parse)
14871 {
14872     /* Handle the (?[...]) construct to do set operations */
14873
14874     U8 curchar;                     /* Current character being parsed */
14875     UV start, end;                  /* End points of code point ranges */
14876     SV* final = NULL;               /* The end result inversion list */
14877     SV* result_string;              /* 'final' stringified */
14878     AV* stack;                      /* stack of operators and operands not yet
14879                                        resolved */
14880     AV* fence_stack = NULL;         /* A stack containing the positions in
14881                                        'stack' of where the undealt-with left
14882                                        parens would be if they were actually
14883                                        put there */
14884     /* The 'volatile' is a workaround for an optimiser bug
14885      * in Solaris Studio 12.3. See RT #127455 */
14886     volatile IV fence = 0;          /* Position of where most recent undealt-
14887                                        with left paren in stack is; -1 if none.
14888                                      */
14889     STRLEN len;                     /* Temporary */
14890     regnode* node;                  /* Temporary, and final regnode returned by
14891                                        this function */
14892     const bool save_fold = FOLD;    /* Temporary */
14893     char *save_end, *save_parse;    /* Temporaries */
14894     const bool in_locale = LOC;     /* we turn off /l during processing */
14895     AV* posix_warnings = NULL;
14896
14897     GET_RE_DEBUG_FLAGS_DECL;
14898
14899     PERL_ARGS_ASSERT_HANDLE_REGEX_SETS;
14900
14901     if (in_locale) {
14902         set_regex_charset(&RExC_flags, REGEX_UNICODE_CHARSET);
14903     }
14904
14905     REQUIRE_UNI_RULES(flagp, NULL);   /* The use of this operator implies /u.
14906                                          This is required so that the compile
14907                                          time values are valid in all runtime
14908                                          cases */
14909
14910     /* This will return only an ANYOF regnode, or (unlikely) something smaller
14911      * (such as EXACT).  Thus we can skip most everything if just sizing.  We
14912      * call regclass to handle '[]' so as to not have to reinvent its parsing
14913      * rules here (throwing away the size it computes each time).  And, we exit
14914      * upon an unescaped ']' that isn't one ending a regclass.  To do both
14915      * these things, we need to realize that something preceded by a backslash
14916      * is escaped, so we have to keep track of backslashes */
14917     if (SIZE_ONLY) {
14918         UV depth = 0; /* how many nested (?[...]) constructs */
14919
14920         while (RExC_parse < RExC_end) {
14921             SV* current = NULL;
14922
14923             skip_to_be_ignored_text(pRExC_state, &RExC_parse,
14924                                     TRUE /* Force /x */ );
14925
14926             switch (*RExC_parse) {
14927                 case '?':
14928                     if (RExC_parse[1] == '[') depth++, RExC_parse++;
14929                     /* FALLTHROUGH */
14930                 default:
14931                     break;
14932                 case '\\':
14933                     /* Skip past this, so the next character gets skipped, after
14934                      * the switch */
14935                     RExC_parse++;
14936                     if (*RExC_parse == 'c') {
14937                             /* Skip the \cX notation for control characters */
14938                             RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
14939                     }
14940                     break;
14941
14942                 case '[':
14943                 {
14944                     /* See if this is a [:posix:] class. */
14945                     bool is_posix_class = (OOB_NAMEDCLASS
14946                             < handle_possible_posix(pRExC_state,
14947                                                 RExC_parse + 1,
14948                                                 NULL,
14949                                                 NULL,
14950                                                 TRUE /* checking only */));
14951                     /* If it is a posix class, leave the parse pointer at the
14952                      * '[' to fool regclass() into thinking it is part of a
14953                      * '[[:posix:]]'. */
14954                     if (! is_posix_class) {
14955                         RExC_parse++;
14956                     }
14957
14958                     /* regclass() can only return RESTART_PASS1 and NEED_UTF8
14959                      * if multi-char folds are allowed.  */
14960                     if (!regclass(pRExC_state, flagp,depth+1,
14961                                   is_posix_class, /* parse the whole char
14962                                                      class only if not a
14963                                                      posix class */
14964                                   FALSE, /* don't allow multi-char folds */
14965                                   TRUE, /* silence non-portable warnings. */
14966                                   TRUE, /* strict */
14967                                   FALSE, /* Require return to be an ANYOF */
14968                                   &current,
14969                                   &posix_warnings
14970                                  ))
14971                         FAIL2("panic: regclass returned NULL to handle_sets, "
14972                               "flags=%#" UVxf, (UV) *flagp);
14973
14974                     /* function call leaves parse pointing to the ']', except
14975                      * if we faked it */
14976                     if (is_posix_class) {
14977                         RExC_parse--;
14978                     }
14979
14980                     SvREFCNT_dec(current);   /* In case it returned something */
14981                     break;
14982                 }
14983
14984                 case ']':
14985                     if (depth--) break;
14986                     RExC_parse++;
14987                     if (*RExC_parse == ')') {
14988                         node = reganode(pRExC_state, ANYOF, 0);
14989                         RExC_size += ANYOF_SKIP;
14990                         nextchar(pRExC_state);
14991                         Set_Node_Length(node,
14992                                 RExC_parse - oregcomp_parse + 1); /* MJD */
14993                         if (in_locale) {
14994                             set_regex_charset(&RExC_flags, REGEX_LOCALE_CHARSET);
14995                         }
14996
14997                         return node;
14998                     }
14999                     goto no_close;
15000             }
15001
15002             RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
15003         }
15004
15005       no_close:
15006         /* We output the messages even if warnings are off, because we'll fail
15007          * the very next thing, and these give a likely diagnosis for that */
15008         if (posix_warnings && av_tindex_skip_len_mg(posix_warnings) >= 0) {
15009             output_or_return_posix_warnings(pRExC_state, posix_warnings, NULL);
15010         }
15011
15012         FAIL("Syntax error in (?[...])");
15013     }
15014
15015     /* Pass 2 only after this. */
15016     Perl_ck_warner_d(aTHX_
15017         packWARN(WARN_EXPERIMENTAL__REGEX_SETS),
15018         "The regex_sets feature is experimental" REPORT_LOCATION,
15019         REPORT_LOCATION_ARGS(RExC_parse));
15020
15021     /* Everything in this construct is a metacharacter.  Operands begin with
15022      * either a '\' (for an escape sequence), or a '[' for a bracketed
15023      * character class.  Any other character should be an operator, or
15024      * parenthesis for grouping.  Both types of operands are handled by calling
15025      * regclass() to parse them.  It is called with a parameter to indicate to
15026      * return the computed inversion list.  The parsing here is implemented via
15027      * a stack.  Each entry on the stack is a single character representing one
15028      * of the operators; or else a pointer to an operand inversion list. */
15029
15030 #define IS_OPERATOR(a) SvIOK(a)
15031 #define IS_OPERAND(a)  (! IS_OPERATOR(a))
15032
15033     /* The stack is kept in Łukasiewicz order.  (That's pronounced similar
15034      * to luke-a-shave-itch (or -itz), but people who didn't want to bother
15035      * with pronouncing it called it Reverse Polish instead, but now that YOU
15036      * know how to pronounce it you can use the correct term, thus giving due
15037      * credit to the person who invented it, and impressing your geek friends.
15038      * Wikipedia says that the pronounciation of "Ł" has been changing so that
15039      * it is now more like an English initial W (as in wonk) than an L.)
15040      *
15041      * This means that, for example, 'a | b & c' is stored on the stack as
15042      *
15043      * c  [4]
15044      * b  [3]
15045      * &  [2]
15046      * a  [1]
15047      * |  [0]
15048      *
15049      * where the numbers in brackets give the stack [array] element number.
15050      * In this implementation, parentheses are not stored on the stack.
15051      * Instead a '(' creates a "fence" so that the part of the stack below the
15052      * fence is invisible except to the corresponding ')' (this allows us to
15053      * replace testing for parens, by using instead subtraction of the fence
15054      * position).  As new operands are processed they are pushed onto the stack
15055      * (except as noted in the next paragraph).  New operators of higher
15056      * precedence than the current final one are inserted on the stack before
15057      * the lhs operand (so that when the rhs is pushed next, everything will be
15058      * in the correct positions shown above.  When an operator of equal or
15059      * lower precedence is encountered in parsing, all the stacked operations
15060      * of equal or higher precedence are evaluated, leaving the result as the
15061      * top entry on the stack.  This makes higher precedence operations
15062      * evaluate before lower precedence ones, and causes operations of equal
15063      * precedence to left associate.
15064      *
15065      * The only unary operator '!' is immediately pushed onto the stack when
15066      * encountered.  When an operand is encountered, if the top of the stack is
15067      * a '!", the complement is immediately performed, and the '!' popped.  The
15068      * resulting value is treated as a new operand, and the logic in the
15069      * previous paragraph is executed.  Thus in the expression
15070      *      [a] + ! [b]
15071      * the stack looks like
15072      *
15073      * !
15074      * a
15075      * +
15076      *
15077      * as 'b' gets parsed, the latter gets evaluated to '!b', and the stack
15078      * becomes
15079      *
15080      * !b
15081      * a
15082      * +
15083      *
15084      * A ')' is treated as an operator with lower precedence than all the
15085      * aforementioned ones, which causes all operations on the stack above the
15086      * corresponding '(' to be evaluated down to a single resultant operand.
15087      * Then the fence for the '(' is removed, and the operand goes through the
15088      * algorithm above, without the fence.
15089      *
15090      * A separate stack is kept of the fence positions, so that the position of
15091      * the latest so-far unbalanced '(' is at the top of it.
15092      *
15093      * The ']' ending the construct is treated as the lowest operator of all,
15094      * so that everything gets evaluated down to a single operand, which is the
15095      * result */
15096
15097     sv_2mortal((SV *)(stack = newAV()));
15098     sv_2mortal((SV *)(fence_stack = newAV()));
15099
15100     while (RExC_parse < RExC_end) {
15101         I32 top_index;              /* Index of top-most element in 'stack' */
15102         SV** top_ptr;               /* Pointer to top 'stack' element */
15103         SV* current = NULL;         /* To contain the current inversion list
15104                                        operand */
15105         SV* only_to_avoid_leaks;
15106
15107         skip_to_be_ignored_text(pRExC_state, &RExC_parse,
15108                                 TRUE /* Force /x */ );
15109         if (RExC_parse >= RExC_end) {
15110             Perl_croak(aTHX_ "panic: Read past end of '(?[ ])'");
15111         }
15112
15113         curchar = UCHARAT(RExC_parse);
15114
15115 redo_curchar:
15116
15117 #ifdef ENABLE_REGEX_SETS_DEBUGGING
15118                     /* Enable with -Accflags=-DENABLE_REGEX_SETS_DEBUGGING */
15119         DEBUG_U(dump_regex_sets_structures(pRExC_state,
15120                                            stack, fence, fence_stack));
15121 #endif
15122
15123         top_index = av_tindex_skip_len_mg(stack);
15124
15125         switch (curchar) {
15126             SV** stacked_ptr;       /* Ptr to something already on 'stack' */
15127             char stacked_operator;  /* The topmost operator on the 'stack'. */
15128             SV* lhs;                /* Operand to the left of the operator */
15129             SV* rhs;                /* Operand to the right of the operator */
15130             SV* fence_ptr;          /* Pointer to top element of the fence
15131                                        stack */
15132
15133             case '(':
15134
15135                 if (   RExC_parse < RExC_end - 1
15136                     && (UCHARAT(RExC_parse + 1) == '?'))
15137                 {
15138                     /* If is a '(?', could be an embedded '(?flags:(?[...])'.
15139                      * This happens when we have some thing like
15140                      *
15141                      *   my $thai_or_lao = qr/(?[ \p{Thai} + \p{Lao} ])/;
15142                      *   ...
15143                      *   qr/(?[ \p{Digit} & $thai_or_lao ])/;
15144                      *
15145                      * Here we would be handling the interpolated
15146                      * '$thai_or_lao'.  We handle this by a recursive call to
15147                      * ourselves which returns the inversion list the
15148                      * interpolated expression evaluates to.  We use the flags
15149                      * from the interpolated pattern. */
15150                     U32 save_flags = RExC_flags;
15151                     const char * save_parse;
15152
15153                     RExC_parse += 2;        /* Skip past the '(?' */
15154                     save_parse = RExC_parse;
15155
15156                     /* Parse any flags for the '(?' */
15157                     parse_lparen_question_flags(pRExC_state);
15158
15159                     if (RExC_parse == save_parse  /* Makes sure there was at
15160                                                      least one flag (or else
15161                                                      this embedding wasn't
15162                                                      compiled) */
15163                         || RExC_parse >= RExC_end - 4
15164                         || UCHARAT(RExC_parse) != ':'
15165                         || UCHARAT(++RExC_parse) != '('
15166                         || UCHARAT(++RExC_parse) != '?'
15167                         || UCHARAT(++RExC_parse) != '[')
15168                     {
15169
15170                         /* In combination with the above, this moves the
15171                          * pointer to the point just after the first erroneous
15172                          * character (or if there are no flags, to where they
15173                          * should have been) */
15174                         if (RExC_parse >= RExC_end - 4) {
15175                             RExC_parse = RExC_end;
15176                         }
15177                         else if (RExC_parse != save_parse) {
15178                             RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
15179                         }
15180                         vFAIL("Expecting '(?flags:(?[...'");
15181                     }
15182
15183                     /* Recurse, with the meat of the embedded expression */
15184                     RExC_parse++;
15185                     (void) handle_regex_sets(pRExC_state, &current, flagp,
15186                                                     depth+1, oregcomp_parse);
15187
15188                     /* Here, 'current' contains the embedded expression's
15189                      * inversion list, and RExC_parse points to the trailing
15190                      * ']'; the next character should be the ')' */
15191                     RExC_parse++;
15192                     assert(UCHARAT(RExC_parse) == ')');
15193
15194                     /* Then the ')' matching the original '(' handled by this
15195                      * case: statement */
15196                     RExC_parse++;
15197                     assert(UCHARAT(RExC_parse) == ')');
15198
15199                     RExC_parse++;
15200                     RExC_flags = save_flags;
15201                     goto handle_operand;
15202                 }
15203
15204                 /* A regular '('.  Look behind for illegal syntax */
15205                 if (top_index - fence >= 0) {
15206                     /* If the top entry on the stack is an operator, it had
15207                      * better be a '!', otherwise the entry below the top
15208                      * operand should be an operator */
15209                     if (   ! (top_ptr = av_fetch(stack, top_index, FALSE))
15210                         || (IS_OPERATOR(*top_ptr) && SvUV(*top_ptr) != '!')
15211                         || (   IS_OPERAND(*top_ptr)
15212                             && (   top_index - fence < 1
15213                                 || ! (stacked_ptr = av_fetch(stack,
15214                                                              top_index - 1,
15215                                                              FALSE))
15216                                 || ! IS_OPERATOR(*stacked_ptr))))
15217                     {
15218                         RExC_parse++;
15219                         vFAIL("Unexpected '(' with no preceding operator");
15220                     }
15221                 }
15222
15223                 /* Stack the position of this undealt-with left paren */
15224                 av_push(fence_stack, newSViv(fence));
15225                 fence = top_index + 1;
15226                 break;
15227
15228             case '\\':
15229                 /* regclass() can only return RESTART_PASS1 and NEED_UTF8 if
15230                  * multi-char folds are allowed.  */
15231                 if (!regclass(pRExC_state, flagp,depth+1,
15232                               TRUE, /* means parse just the next thing */
15233                               FALSE, /* don't allow multi-char folds */
15234                               FALSE, /* don't silence non-portable warnings.  */
15235                               TRUE,  /* strict */
15236                               FALSE, /* Require return to be an ANYOF */
15237                               &current,
15238                               NULL))
15239                 {
15240                     FAIL2("panic: regclass returned NULL to handle_sets, "
15241                           "flags=%#" UVxf, (UV) *flagp);
15242                 }
15243
15244                 /* regclass() will return with parsing just the \ sequence,
15245                  * leaving the parse pointer at the next thing to parse */
15246                 RExC_parse--;
15247                 goto handle_operand;
15248
15249             case '[':   /* Is a bracketed character class */
15250             {
15251                 /* See if this is a [:posix:] class. */
15252                 bool is_posix_class = (OOB_NAMEDCLASS
15253                             < handle_possible_posix(pRExC_state,
15254                                                 RExC_parse + 1,
15255                                                 NULL,
15256                                                 NULL,
15257                                                 TRUE /* checking only */));
15258                 /* If it is a posix class, leave the parse pointer at the '['
15259                  * to fool regclass() into thinking it is part of a
15260                  * '[[:posix:]]'. */
15261                 if (! is_posix_class) {
15262                     RExC_parse++;
15263                 }
15264
15265                 /* regclass() can only return RESTART_PASS1 and NEED_UTF8 if
15266                  * multi-char folds are allowed.  */
15267                 if (!regclass(pRExC_state, flagp,depth+1,
15268                                 is_posix_class, /* parse the whole char
15269                                                     class only if not a
15270                                                     posix class */
15271                                 FALSE, /* don't allow multi-char folds */
15272                                 TRUE, /* silence non-portable warnings. */
15273                                 TRUE, /* strict */
15274                                 FALSE, /* Require return to be an ANYOF */
15275                                 &current,
15276                                 NULL
15277                                 ))
15278                 {
15279                     FAIL2("panic: regclass returned NULL to handle_sets, "
15280                           "flags=%#" UVxf, (UV) *flagp);
15281                 }
15282
15283                 /* function call leaves parse pointing to the ']', except if we
15284                  * faked it */
15285                 if (is_posix_class) {
15286                     RExC_parse--;
15287                 }
15288
15289                 goto handle_operand;
15290             }
15291
15292             case ']':
15293                 if (top_index >= 1) {
15294                     goto join_operators;
15295                 }
15296
15297                 /* Only a single operand on the stack: are done */
15298                 goto done;
15299
15300             case ')':
15301                 if (av_tindex_skip_len_mg(fence_stack) < 0) {
15302                     RExC_parse++;
15303                     vFAIL("Unexpected ')'");
15304                 }
15305
15306                 /* If nothing after the fence, is missing an operand */
15307                 if (top_index - fence < 0) {
15308                     RExC_parse++;
15309                     goto bad_syntax;
15310                 }
15311                 /* If at least two things on the stack, treat this as an
15312                   * operator */
15313                 if (top_index - fence >= 1) {
15314                     goto join_operators;
15315                 }
15316
15317                 /* Here only a single thing on the fenced stack, and there is a
15318                  * fence.  Get rid of it */
15319                 fence_ptr = av_pop(fence_stack);
15320                 assert(fence_ptr);
15321                 fence = SvIV(fence_ptr) - 1;
15322                 SvREFCNT_dec_NN(fence_ptr);
15323                 fence_ptr = NULL;
15324
15325                 if (fence < 0) {
15326                     fence = 0;
15327                 }
15328
15329                 /* Having gotten rid of the fence, we pop the operand at the
15330                  * stack top and process it as a newly encountered operand */
15331                 current = av_pop(stack);
15332                 if (IS_OPERAND(current)) {
15333                     goto handle_operand;
15334                 }
15335
15336                 RExC_parse++;
15337                 goto bad_syntax;
15338
15339             case '&':
15340             case '|':
15341             case '+':
15342             case '-':
15343             case '^':
15344
15345                 /* These binary operators should have a left operand already
15346                  * parsed */
15347                 if (   top_index - fence < 0
15348                     || top_index - fence == 1
15349                     || ( ! (top_ptr = av_fetch(stack, top_index, FALSE)))
15350                     || ! IS_OPERAND(*top_ptr))
15351                 {
15352                     goto unexpected_binary;
15353                 }
15354
15355                 /* If only the one operand is on the part of the stack visible
15356                  * to us, we just place this operator in the proper position */
15357                 if (top_index - fence < 2) {
15358
15359                     /* Place the operator before the operand */
15360
15361                     SV* lhs = av_pop(stack);
15362                     av_push(stack, newSVuv(curchar));
15363                     av_push(stack, lhs);
15364                     break;
15365                 }
15366
15367                 /* But if there is something else on the stack, we need to
15368                  * process it before this new operator if and only if the
15369                  * stacked operation has equal or higher precedence than the
15370                  * new one */
15371
15372              join_operators:
15373
15374                 /* The operator on the stack is supposed to be below both its
15375                  * operands */
15376                 if (   ! (stacked_ptr = av_fetch(stack, top_index - 2, FALSE))
15377                     || IS_OPERAND(*stacked_ptr))
15378                 {
15379                     /* But if not, it's legal and indicates we are completely
15380                      * done if and only if we're currently processing a ']',
15381                      * which should be the final thing in the expression */
15382                     if (curchar == ']') {
15383                         goto done;
15384                     }
15385
15386                   unexpected_binary:
15387                     RExC_parse++;
15388                     vFAIL2("Unexpected binary operator '%c' with no "
15389                            "preceding operand", curchar);
15390                 }
15391                 stacked_operator = (char) SvUV(*stacked_ptr);
15392
15393                 if (regex_set_precedence(curchar)
15394                     > regex_set_precedence(stacked_operator))
15395                 {
15396                     /* Here, the new operator has higher precedence than the
15397                      * stacked one.  This means we need to add the new one to
15398                      * the stack to await its rhs operand (and maybe more
15399                      * stuff).  We put it before the lhs operand, leaving
15400                      * untouched the stacked operator and everything below it
15401                      * */
15402                     lhs = av_pop(stack);
15403                     assert(IS_OPERAND(lhs));
15404
15405                     av_push(stack, newSVuv(curchar));
15406                     av_push(stack, lhs);
15407                     break;
15408                 }
15409
15410                 /* Here, the new operator has equal or lower precedence than
15411                  * what's already there.  This means the operation already
15412                  * there should be performed now, before the new one. */
15413
15414                 rhs = av_pop(stack);
15415                 if (! IS_OPERAND(rhs)) {
15416
15417                     /* This can happen when a ! is not followed by an operand,
15418                      * like in /(?[\t &!])/ */
15419                     goto bad_syntax;
15420                 }
15421
15422                 lhs = av_pop(stack);
15423
15424                 if (! IS_OPERAND(lhs)) {
15425
15426                     /* This can happen when there is an empty (), like in
15427                      * /(?[[0]+()+])/ */
15428                     goto bad_syntax;
15429                 }
15430
15431                 switch (stacked_operator) {
15432                     case '&':
15433                         _invlist_intersection(lhs, rhs, &rhs);
15434                         break;
15435
15436                     case '|':
15437                     case '+':
15438                         _invlist_union(lhs, rhs, &rhs);
15439                         break;
15440
15441                     case '-':
15442                         _invlist_subtract(lhs, rhs, &rhs);
15443                         break;
15444
15445                     case '^':   /* The union minus the intersection */
15446                     {
15447                         SV* i = NULL;
15448                         SV* u = NULL;
15449
15450                         _invlist_union(lhs, rhs, &u);
15451                         _invlist_intersection(lhs, rhs, &i);
15452                         _invlist_subtract(u, i, &rhs);
15453                         SvREFCNT_dec_NN(i);
15454                         SvREFCNT_dec_NN(u);
15455                         break;
15456                     }
15457                 }
15458                 SvREFCNT_dec(lhs);
15459
15460                 /* Here, the higher precedence operation has been done, and the
15461                  * result is in 'rhs'.  We overwrite the stacked operator with
15462                  * the result.  Then we redo this code to either push the new
15463                  * operator onto the stack or perform any higher precedence
15464                  * stacked operation */
15465                 only_to_avoid_leaks = av_pop(stack);
15466                 SvREFCNT_dec(only_to_avoid_leaks);
15467                 av_push(stack, rhs);
15468                 goto redo_curchar;
15469
15470             case '!':   /* Highest priority, right associative */
15471
15472                 /* If what's already at the top of the stack is another '!",
15473                  * they just cancel each other out */
15474                 if (   (top_ptr = av_fetch(stack, top_index, FALSE))
15475                     && (IS_OPERATOR(*top_ptr) && SvUV(*top_ptr) == '!'))
15476                 {
15477                     only_to_avoid_leaks = av_pop(stack);
15478                     SvREFCNT_dec(only_to_avoid_leaks);
15479                 }
15480                 else { /* Otherwise, since it's right associative, just push
15481                           onto the stack */
15482                     av_push(stack, newSVuv(curchar));
15483                 }
15484                 break;
15485
15486             default:
15487                 RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
15488                 vFAIL("Unexpected character");
15489
15490           handle_operand:
15491
15492             /* Here 'current' is the operand.  If something is already on the
15493              * stack, we have to check if it is a !.  But first, the code above
15494              * may have altered the stack in the time since we earlier set
15495              * 'top_index'.  */
15496
15497             top_index = av_tindex_skip_len_mg(stack);
15498             if (top_index - fence >= 0) {
15499                 /* If the top entry on the stack is an operator, it had better
15500                  * be a '!', otherwise the entry below the top operand should
15501                  * be an operator */
15502                 top_ptr = av_fetch(stack, top_index, FALSE);
15503                 assert(top_ptr);
15504                 if (IS_OPERATOR(*top_ptr)) {
15505
15506                     /* The only permissible operator at the top of the stack is
15507                      * '!', which is applied immediately to this operand. */
15508                     curchar = (char) SvUV(*top_ptr);
15509                     if (curchar != '!') {
15510                         SvREFCNT_dec(current);
15511                         vFAIL2("Unexpected binary operator '%c' with no "
15512                                 "preceding operand", curchar);
15513                     }
15514
15515                     _invlist_invert(current);
15516
15517                     only_to_avoid_leaks = av_pop(stack);
15518                     SvREFCNT_dec(only_to_avoid_leaks);
15519
15520                     /* And we redo with the inverted operand.  This allows
15521                      * handling multiple ! in a row */
15522                     goto handle_operand;
15523                 }
15524                           /* Single operand is ok only for the non-binary ')'
15525                            * operator */
15526                 else if ((top_index - fence == 0 && curchar != ')')
15527                          || (top_index - fence > 0
15528                              && (! (stacked_ptr = av_fetch(stack,
15529                                                            top_index - 1,
15530                                                            FALSE))
15531                                  || IS_OPERAND(*stacked_ptr))))
15532                 {
15533                     SvREFCNT_dec(current);
15534                     vFAIL("Operand with no preceding operator");
15535                 }
15536             }
15537
15538             /* Here there was nothing on the stack or the top element was
15539              * another operand.  Just add this new one */
15540             av_push(stack, current);
15541
15542         } /* End of switch on next parse token */
15543
15544         RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
15545     } /* End of loop parsing through the construct */
15546
15547   done:
15548     if (av_tindex_skip_len_mg(fence_stack) >= 0) {
15549         vFAIL("Unmatched (");
15550     }
15551
15552     if (av_tindex_skip_len_mg(stack) < 0   /* Was empty */
15553         || ((final = av_pop(stack)) == NULL)
15554         || ! IS_OPERAND(final)
15555         || SvTYPE(final) != SVt_INVLIST
15556         || av_tindex_skip_len_mg(stack) >= 0)  /* More left on stack */
15557     {
15558       bad_syntax:
15559         SvREFCNT_dec(final);
15560         vFAIL("Incomplete expression within '(?[ ])'");
15561     }
15562
15563     /* Here, 'final' is the resultant inversion list from evaluating the
15564      * expression.  Return it if so requested */
15565     if (return_invlist) {
15566         *return_invlist = final;
15567         return END;
15568     }
15569
15570     /* Otherwise generate a resultant node, based on 'final'.  regclass() is
15571      * expecting a string of ranges and individual code points */
15572     invlist_iterinit(final);
15573     result_string = newSVpvs("");
15574     while (invlist_iternext(final, &start, &end)) {
15575         if (start == end) {
15576             Perl_sv_catpvf(aTHX_ result_string, "\\x{%" UVXf "}", start);
15577         }
15578         else {
15579             Perl_sv_catpvf(aTHX_ result_string, "\\x{%" UVXf "}-\\x{%" UVXf "}",
15580                                                      start,          end);
15581         }
15582     }
15583
15584     /* About to generate an ANYOF (or similar) node from the inversion list we
15585      * have calculated */
15586     save_parse = RExC_parse;
15587     RExC_parse = SvPV(result_string, len);
15588     save_end = RExC_end;
15589     RExC_end = RExC_parse + len;
15590
15591     /* We turn off folding around the call, as the class we have constructed
15592      * already has all folding taken into consideration, and we don't want
15593      * regclass() to add to that */
15594     RExC_flags &= ~RXf_PMf_FOLD;
15595     /* regclass() can only return RESTART_PASS1 and NEED_UTF8 if multi-char
15596      * folds are allowed.  */
15597     node = regclass(pRExC_state, flagp,depth+1,
15598                     FALSE, /* means parse the whole char class */
15599                     FALSE, /* don't allow multi-char folds */
15600                     TRUE, /* silence non-portable warnings.  The above may very
15601                              well have generated non-portable code points, but
15602                              they're valid on this machine */
15603                     FALSE, /* similarly, no need for strict */
15604                     FALSE, /* Require return to be an ANYOF */
15605                     NULL,
15606                     NULL
15607                 );
15608     if (!node)
15609         FAIL2("panic: regclass returned NULL to handle_sets, flags=%#" UVxf,
15610                     PTR2UV(flagp));
15611
15612     /* Fix up the node type if we are in locale.  (We have pretended we are
15613      * under /u for the purposes of regclass(), as this construct will only
15614      * work under UTF-8 locales.  But now we change the opcode to be ANYOFL (so
15615      * as to cause any warnings about bad locales to be output in regexec.c),
15616      * and add the flag that indicates to check if not in a UTF-8 locale.  The
15617      * reason we above forbid optimization into something other than an ANYOF
15618      * node is simply to minimize the number of code changes in regexec.c.
15619      * Otherwise we would have to create new EXACTish node types and deal with
15620      * them.  This decision could be revisited should this construct become
15621      * popular.
15622      *
15623      * (One might think we could look at the resulting ANYOF node and suppress
15624      * the flag if everything is above 255, as those would be UTF-8 only,
15625      * but this isn't true, as the components that led to that result could
15626      * have been locale-affected, and just happen to cancel each other out
15627      * under UTF-8 locales.) */
15628     if (in_locale) {
15629         set_regex_charset(&RExC_flags, REGEX_LOCALE_CHARSET);
15630
15631         assert(OP(node) == ANYOF);
15632
15633         OP(node) = ANYOFL;
15634         ANYOF_FLAGS(node)
15635                 |= ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD;
15636     }
15637
15638     if (save_fold) {
15639         RExC_flags |= RXf_PMf_FOLD;
15640     }
15641
15642     RExC_parse = save_parse + 1;
15643     RExC_end = save_end;
15644     SvREFCNT_dec_NN(final);
15645     SvREFCNT_dec_NN(result_string);
15646
15647     nextchar(pRExC_state);
15648     Set_Node_Length(node, RExC_parse - oregcomp_parse + 1); /* MJD */
15649     return node;
15650 }
15651
15652 #ifdef ENABLE_REGEX_SETS_DEBUGGING
15653
15654 STATIC void
15655 S_dump_regex_sets_structures(pTHX_ RExC_state_t *pRExC_state,
15656                              AV * stack, const IV fence, AV * fence_stack)
15657 {   /* Dumps the stacks in handle_regex_sets() */
15658
15659     const SSize_t stack_top = av_tindex_skip_len_mg(stack);
15660     const SSize_t fence_stack_top = av_tindex_skip_len_mg(fence_stack);
15661     SSize_t i;
15662
15663     PERL_ARGS_ASSERT_DUMP_REGEX_SETS_STRUCTURES;
15664
15665     PerlIO_printf(Perl_debug_log, "\nParse position is:%s\n", RExC_parse);
15666
15667     if (stack_top < 0) {
15668         PerlIO_printf(Perl_debug_log, "Nothing on stack\n");
15669     }
15670     else {
15671         PerlIO_printf(Perl_debug_log, "Stack: (fence=%d)\n", (int) fence);
15672         for (i = stack_top; i >= 0; i--) {
15673             SV ** element_ptr = av_fetch(stack, i, FALSE);
15674             if (! element_ptr) {
15675             }
15676
15677             if (IS_OPERATOR(*element_ptr)) {
15678                 PerlIO_printf(Perl_debug_log, "[%d]: %c\n",
15679                                             (int) i, (int) SvIV(*element_ptr));
15680             }
15681             else {
15682                 PerlIO_printf(Perl_debug_log, "[%d] ", (int) i);
15683                 sv_dump(*element_ptr);
15684             }
15685         }
15686     }
15687
15688     if (fence_stack_top < 0) {
15689         PerlIO_printf(Perl_debug_log, "Nothing on fence_stack\n");
15690     }
15691     else {
15692         PerlIO_printf(Perl_debug_log, "Fence_stack: \n");
15693         for (i = fence_stack_top; i >= 0; i--) {
15694             SV ** element_ptr = av_fetch(fence_stack, i, FALSE);
15695             if (! element_ptr) {
15696             }
15697
15698             PerlIO_printf(Perl_debug_log, "[%d]: %d\n",
15699                                             (int) i, (int) SvIV(*element_ptr));
15700         }
15701     }
15702 }
15703
15704 #endif
15705
15706 #undef IS_OPERATOR
15707 #undef IS_OPERAND
15708
15709 STATIC void
15710 S_add_above_Latin1_folds(pTHX_ RExC_state_t *pRExC_state, const U8 cp, SV** invlist)
15711 {
15712     /* This hard-codes the Latin1/above-Latin1 folding rules, so that an
15713      * innocent-looking character class, like /[ks]/i won't have to go out to
15714      * disk to find the possible matches.
15715      *
15716      * This should be called only for a Latin1-range code points, cp, which is
15717      * known to be involved in a simple fold with other code points above
15718      * Latin1.  It would give false results if /aa has been specified.
15719      * Multi-char folds are outside the scope of this, and must be handled
15720      * specially.
15721      *
15722      * XXX It would be better to generate these via regen, in case a new
15723      * version of the Unicode standard adds new mappings, though that is not
15724      * really likely, and may be caught by the default: case of the switch
15725      * below. */
15726
15727     PERL_ARGS_ASSERT_ADD_ABOVE_LATIN1_FOLDS;
15728
15729     assert(HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(cp));
15730
15731     switch (cp) {
15732         case 'k':
15733         case 'K':
15734           *invlist =
15735              add_cp_to_invlist(*invlist, KELVIN_SIGN);
15736             break;
15737         case 's':
15738         case 'S':
15739           *invlist = add_cp_to_invlist(*invlist, LATIN_SMALL_LETTER_LONG_S);
15740             break;
15741         case MICRO_SIGN:
15742           *invlist = add_cp_to_invlist(*invlist, GREEK_CAPITAL_LETTER_MU);
15743           *invlist = add_cp_to_invlist(*invlist, GREEK_SMALL_LETTER_MU);
15744             break;
15745         case LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE:
15746         case LATIN_SMALL_LETTER_A_WITH_RING_ABOVE:
15747           *invlist = add_cp_to_invlist(*invlist, ANGSTROM_SIGN);
15748             break;
15749         case LATIN_SMALL_LETTER_Y_WITH_DIAERESIS:
15750           *invlist = add_cp_to_invlist(*invlist,
15751                                         LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS);
15752             break;
15753
15754 #ifdef LATIN_CAPITAL_LETTER_SHARP_S /* not defined in early Unicode releases */
15755
15756         case LATIN_SMALL_LETTER_SHARP_S:
15757           *invlist = add_cp_to_invlist(*invlist, LATIN_CAPITAL_LETTER_SHARP_S);
15758             break;
15759
15760 #endif
15761
15762 #if    UNICODE_MAJOR_VERSION < 3                                        \
15763    || (UNICODE_MAJOR_VERSION == 3 && UNICODE_DOT_VERSION == 0)
15764
15765         /* In 3.0 and earlier, U+0130 folded simply to 'i'; and in 3.0.1 so did
15766          * U+0131.  */
15767         case 'i':
15768         case 'I':
15769           *invlist =
15770              add_cp_to_invlist(*invlist, LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE);
15771 #   if UNICODE_DOT_DOT_VERSION == 1
15772           *invlist = add_cp_to_invlist(*invlist, LATIN_SMALL_LETTER_DOTLESS_I);
15773 #   endif
15774             break;
15775 #endif
15776
15777         default:
15778             /* Use deprecated warning to increase the chances of this being
15779              * output */
15780             if (PASS2) {
15781                 ckWARN2reg_d(RExC_parse, "Perl folding rules are not up-to-date for 0x%02X; please use the perlbug utility to report;", cp);
15782             }
15783             break;
15784     }
15785 }
15786
15787 STATIC void
15788 S_output_or_return_posix_warnings(pTHX_ RExC_state_t *pRExC_state, AV* posix_warnings, AV** return_posix_warnings)
15789 {
15790     /* If the final parameter is NULL, output the elements of the array given
15791      * by '*posix_warnings' as REGEXP warnings.  Otherwise, the elements are
15792      * pushed onto it, (creating if necessary) */
15793
15794     SV * msg;
15795     const bool first_is_fatal =  ! return_posix_warnings
15796                                 && ckDEAD(packWARN(WARN_REGEXP));
15797
15798     PERL_ARGS_ASSERT_OUTPUT_OR_RETURN_POSIX_WARNINGS;
15799
15800     while ((msg = av_shift(posix_warnings)) != &PL_sv_undef) {
15801         if (return_posix_warnings) {
15802             if (! *return_posix_warnings) { /* mortalize to not leak if
15803                                                warnings are fatal */
15804                 *return_posix_warnings = (AV *) sv_2mortal((SV *) newAV());
15805             }
15806             av_push(*return_posix_warnings, msg);
15807         }
15808         else {
15809             if (first_is_fatal) {           /* Avoid leaking this */
15810                 av_undef(posix_warnings);   /* This isn't necessary if the
15811                                                array is mortal, but is a
15812                                                fail-safe */
15813                 (void) sv_2mortal(msg);
15814                 if (PASS2) {
15815                     SAVEFREESV(RExC_rx_sv);
15816                 }
15817             }
15818             Perl_warner(aTHX_ packWARN(WARN_REGEXP), "%s", SvPVX(msg));
15819             SvREFCNT_dec_NN(msg);
15820         }
15821     }
15822 }
15823
15824 STATIC AV *
15825 S_add_multi_match(pTHX_ AV* multi_char_matches, SV* multi_string, const STRLEN cp_count)
15826 {
15827     /* This adds the string scalar <multi_string> to the array
15828      * <multi_char_matches>.  <multi_string> is known to have exactly
15829      * <cp_count> code points in it.  This is used when constructing a
15830      * bracketed character class and we find something that needs to match more
15831      * than a single character.
15832      *
15833      * <multi_char_matches> is actually an array of arrays.  Each top-level
15834      * element is an array that contains all the strings known so far that are
15835      * the same length.  And that length (in number of code points) is the same
15836      * as the index of the top-level array.  Hence, the [2] element is an
15837      * array, each element thereof is a string containing TWO code points;
15838      * while element [3] is for strings of THREE characters, and so on.  Since
15839      * this is for multi-char strings there can never be a [0] nor [1] element.
15840      *
15841      * When we rewrite the character class below, we will do so such that the
15842      * longest strings are written first, so that it prefers the longest
15843      * matching strings first.  This is done even if it turns out that any
15844      * quantifier is non-greedy, out of this programmer's (khw) laziness.  Tom
15845      * Christiansen has agreed that this is ok.  This makes the test for the
15846      * ligature 'ffi' come before the test for 'ff', for example */
15847
15848     AV* this_array;
15849     AV** this_array_ptr;
15850
15851     PERL_ARGS_ASSERT_ADD_MULTI_MATCH;
15852
15853     if (! multi_char_matches) {
15854         multi_char_matches = newAV();
15855     }
15856
15857     if (av_exists(multi_char_matches, cp_count)) {
15858         this_array_ptr = (AV**) av_fetch(multi_char_matches, cp_count, FALSE);
15859         this_array = *this_array_ptr;
15860     }
15861     else {
15862         this_array = newAV();
15863         av_store(multi_char_matches, cp_count,
15864                  (SV*) this_array);
15865     }
15866     av_push(this_array, multi_string);
15867
15868     return multi_char_matches;
15869 }
15870
15871 /* The names of properties whose definitions are not known at compile time are
15872  * stored in this SV, after a constant heading.  So if the length has been
15873  * changed since initialization, then there is a run-time definition. */
15874 #define HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION                            \
15875                                         (SvCUR(listsv) != initial_listsv_len)
15876
15877 /* There is a restricted set of white space characters that are legal when
15878  * ignoring white space in a bracketed character class.  This generates the
15879  * code to skip them.
15880  *
15881  * There is a line below that uses the same white space criteria but is outside
15882  * this macro.  Both here and there must use the same definition */
15883 #define SKIP_BRACKETED_WHITE_SPACE(do_skip, p)                          \
15884     STMT_START {                                                        \
15885         if (do_skip) {                                                  \
15886             while (isBLANK_A(UCHARAT(p)))                               \
15887             {                                                           \
15888                 p++;                                                    \
15889             }                                                           \
15890         }                                                               \
15891     } STMT_END
15892
15893 STATIC regnode *
15894 S_regclass(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth,
15895                  const bool stop_at_1,  /* Just parse the next thing, don't
15896                                            look for a full character class */
15897                  bool allow_multi_folds,
15898                  const bool silence_non_portable,   /* Don't output warnings
15899                                                        about too large
15900                                                        characters */
15901                  const bool strict,
15902                  bool optimizable,                  /* ? Allow a non-ANYOF return
15903                                                        node */
15904                  SV** ret_invlist, /* Return an inversion list, not a node */
15905                  AV** return_posix_warnings
15906           )
15907 {
15908     /* parse a bracketed class specification.  Most of these will produce an
15909      * ANYOF node; but something like [a] will produce an EXACT node; [aA], an
15910      * EXACTFish node; [[:ascii:]], a POSIXA node; etc.  It is more complex
15911      * under /i with multi-character folds: it will be rewritten following the
15912      * paradigm of this example, where the <multi-fold>s are characters which
15913      * fold to multiple character sequences:
15914      *      /[abc\x{multi-fold1}def\x{multi-fold2}ghi]/i
15915      * gets effectively rewritten as:
15916      *      /(?:\x{multi-fold1}|\x{multi-fold2}|[abcdefghi]/i
15917      * reg() gets called (recursively) on the rewritten version, and this
15918      * function will return what it constructs.  (Actually the <multi-fold>s
15919      * aren't physically removed from the [abcdefghi], it's just that they are
15920      * ignored in the recursion by means of a flag:
15921      * <RExC_in_multi_char_class>.)
15922      *
15923      * ANYOF nodes contain a bit map for the first NUM_ANYOF_CODE_POINTS
15924      * characters, with the corresponding bit set if that character is in the
15925      * list.  For characters above this, a range list or swash is used.  There
15926      * are extra bits for \w, etc. in locale ANYOFs, as what these match is not
15927      * determinable at compile time
15928      *
15929      * Returns NULL, setting *flagp to RESTART_PASS1 if the sizing scan needs
15930      * to be restarted, or'd with NEED_UTF8 if the pattern needs to be upgraded
15931      * to UTF-8.  This can only happen if ret_invlist is non-NULL.
15932      */
15933
15934     UV prevvalue = OOB_UNICODE, save_prevvalue = OOB_UNICODE;
15935     IV range = 0;
15936     UV value = OOB_UNICODE, save_value = OOB_UNICODE;
15937     regnode *ret;
15938     STRLEN numlen;
15939     int namedclass = OOB_NAMEDCLASS;
15940     char *rangebegin = NULL;
15941     bool need_class = 0;
15942     SV *listsv = NULL;
15943     STRLEN initial_listsv_len = 0; /* Kind of a kludge to see if it is more
15944                                       than just initialized.  */
15945     SV* properties = NULL;    /* Code points that match \p{} \P{} */
15946     SV* posixes = NULL;     /* Code points that match classes like [:word:],
15947                                extended beyond the Latin1 range.  These have to
15948                                be kept separate from other code points for much
15949                                of this function because their handling  is
15950                                different under /i, and for most classes under
15951                                /d as well */
15952     SV* nposixes = NULL;    /* Similarly for [:^word:].  These are kept
15953                                separate for a while from the non-complemented
15954                                versions because of complications with /d
15955                                matching */
15956     SV* simple_posixes = NULL; /* But under some conditions, the classes can be
15957                                   treated more simply than the general case,
15958                                   leading to less compilation and execution
15959                                   work */
15960     UV element_count = 0;   /* Number of distinct elements in the class.
15961                                Optimizations may be possible if this is tiny */
15962     AV * multi_char_matches = NULL; /* Code points that fold to more than one
15963                                        character; used under /i */
15964     UV n;
15965     char * stop_ptr = RExC_end;    /* where to stop parsing */
15966
15967     /* ignore unescaped whitespace? */
15968     const bool skip_white = cBOOL(   ret_invlist
15969                                   || (RExC_flags & RXf_PMf_EXTENDED_MORE));
15970
15971     /* Unicode properties are stored in a swash; this holds the current one
15972      * being parsed.  If this swash is the only above-latin1 component of the
15973      * character class, an optimization is to pass it directly on to the
15974      * execution engine.  Otherwise, it is set to NULL to indicate that there
15975      * are other things in the class that have to be dealt with at execution
15976      * time */
15977     SV* swash = NULL;           /* Code points that match \p{} \P{} */
15978
15979     /* Set if a component of this character class is user-defined; just passed
15980      * on to the engine */
15981     bool has_user_defined_property = FALSE;
15982
15983     /* inversion list of code points this node matches only when the target
15984      * string is in UTF-8.  These are all non-ASCII, < 256.  (Because is under
15985      * /d) */
15986     SV* has_upper_latin1_only_utf8_matches = NULL;
15987
15988     /* Inversion list of code points this node matches regardless of things
15989      * like locale, folding, utf8ness of the target string */
15990     SV* cp_list = NULL;
15991
15992     /* Like cp_list, but code points on this list need to be checked for things
15993      * that fold to/from them under /i */
15994     SV* cp_foldable_list = NULL;
15995
15996     /* Like cp_list, but code points on this list are valid only when the
15997      * runtime locale is UTF-8 */
15998     SV* only_utf8_locale_list = NULL;
15999
16000     /* In a range, if one of the endpoints is non-character-set portable,
16001      * meaning that it hard-codes a code point that may mean a different
16002      * charactger in ASCII vs. EBCDIC, as opposed to, say, a literal 'A' or a
16003      * mnemonic '\t' which each mean the same character no matter which
16004      * character set the platform is on. */
16005     unsigned int non_portable_endpoint = 0;
16006
16007     /* Is the range unicode? which means on a platform that isn't 1-1 native
16008      * to Unicode (i.e. non-ASCII), each code point in it should be considered
16009      * to be a Unicode value.  */
16010     bool unicode_range = FALSE;
16011     bool invert = FALSE;    /* Is this class to be complemented */
16012
16013     bool warn_super = ALWAYS_WARN_SUPER;
16014
16015     regnode * const orig_emit = RExC_emit; /* Save the original RExC_emit in
16016         case we need to change the emitted regop to an EXACT. */
16017     const char * orig_parse = RExC_parse;
16018     const SSize_t orig_size = RExC_size;
16019     bool posixl_matches_all = FALSE; /* Does /l class have both e.g. \W,\w ? */
16020
16021     /* This variable is used to mark where the end in the input is of something
16022      * that looks like a POSIX construct but isn't.  During the parse, when
16023      * something looks like it could be such a construct is encountered, it is
16024      * checked for being one, but not if we've already checked this area of the
16025      * input.  Only after this position is reached do we check again */
16026     char *not_posix_region_end = RExC_parse - 1;
16027
16028     AV* posix_warnings = NULL;
16029     const bool do_posix_warnings =     return_posix_warnings
16030                                    || (PASS2 && ckWARN(WARN_REGEXP));
16031
16032     GET_RE_DEBUG_FLAGS_DECL;
16033
16034     PERL_ARGS_ASSERT_REGCLASS;
16035 #ifndef DEBUGGING
16036     PERL_UNUSED_ARG(depth);
16037 #endif
16038
16039     DEBUG_PARSE("clas");
16040
16041 #if UNICODE_MAJOR_VERSION < 3 /* no multifolds in early Unicode */      \
16042     || (UNICODE_MAJOR_VERSION == 3 && UNICODE_DOT_VERSION == 0          \
16043                                    && UNICODE_DOT_DOT_VERSION == 0)
16044     allow_multi_folds = FALSE;
16045 #endif
16046
16047     /* Assume we are going to generate an ANYOF node. */
16048     ret = reganode(pRExC_state,
16049                    (LOC)
16050                     ? ANYOFL
16051                     : ANYOF,
16052                    0);
16053
16054     if (SIZE_ONLY) {
16055         RExC_size += ANYOF_SKIP;
16056         listsv = &PL_sv_undef; /* For code scanners: listsv always non-NULL. */
16057     }
16058     else {
16059         ANYOF_FLAGS(ret) = 0;
16060
16061         RExC_emit += ANYOF_SKIP;
16062         listsv = newSVpvs_flags("# comment\n", SVs_TEMP);
16063         initial_listsv_len = SvCUR(listsv);
16064         SvTEMP_off(listsv); /* Grr, TEMPs and mortals are conflated.  */
16065     }
16066
16067     SKIP_BRACKETED_WHITE_SPACE(skip_white, RExC_parse);
16068
16069     assert(RExC_parse <= RExC_end);
16070
16071     if (UCHARAT(RExC_parse) == '^') {   /* Complement the class */
16072         RExC_parse++;
16073         invert = TRUE;
16074         allow_multi_folds = FALSE;
16075         MARK_NAUGHTY(1);
16076         SKIP_BRACKETED_WHITE_SPACE(skip_white, RExC_parse);
16077     }
16078
16079     /* Check that they didn't say [:posix:] instead of [[:posix:]] */
16080     if (! ret_invlist && MAYBE_POSIXCC(UCHARAT(RExC_parse))) {
16081         int maybe_class = handle_possible_posix(pRExC_state,
16082                                                 RExC_parse,
16083                                                 &not_posix_region_end,
16084                                                 NULL,
16085                                                 TRUE /* checking only */);
16086         if (PASS2 && maybe_class >= OOB_NAMEDCLASS && do_posix_warnings) {
16087             SAVEFREESV(RExC_rx_sv);
16088             ckWARN4reg(not_posix_region_end,
16089                     "POSIX syntax [%c %c] belongs inside character classes%s",
16090                     *RExC_parse, *RExC_parse,
16091                     (maybe_class == OOB_NAMEDCLASS)
16092                     ? ((POSIXCC_NOTYET(*RExC_parse))
16093                         ? " (but this one isn't implemented)"
16094                         : " (but this one isn't fully valid)")
16095                     : ""
16096                     );
16097             (void)ReREFCNT_inc(RExC_rx_sv);
16098         }
16099     }
16100
16101     /* If the caller wants us to just parse a single element, accomplish this
16102      * by faking the loop ending condition */
16103     if (stop_at_1 && RExC_end > RExC_parse) {
16104         stop_ptr = RExC_parse + 1;
16105     }
16106
16107     /* allow 1st char to be ']' (allowing it to be '-' is dealt with later) */
16108     if (UCHARAT(RExC_parse) == ']')
16109         goto charclassloop;
16110
16111     while (1) {
16112
16113         if (   posix_warnings
16114             && av_tindex_skip_len_mg(posix_warnings) >= 0
16115             && RExC_parse > not_posix_region_end)
16116         {
16117             /* Warnings about posix class issues are considered tentative until
16118              * we are far enough along in the parse that we can no longer
16119              * change our mind, at which point we either output them or add
16120              * them, if it has so specified, to what gets returned to the
16121              * caller.  This is done each time through the loop so that a later
16122              * class won't zap them before they have been dealt with. */
16123             output_or_return_posix_warnings(pRExC_state, posix_warnings,
16124                                             return_posix_warnings);
16125         }
16126
16127         if  (RExC_parse >= stop_ptr) {
16128             break;
16129         }
16130
16131         SKIP_BRACKETED_WHITE_SPACE(skip_white, RExC_parse);
16132
16133         if  (UCHARAT(RExC_parse) == ']') {
16134             break;
16135         }
16136
16137       charclassloop:
16138
16139         namedclass = OOB_NAMEDCLASS; /* initialize as illegal */
16140         save_value = value;
16141         save_prevvalue = prevvalue;
16142
16143         if (!range) {
16144             rangebegin = RExC_parse;
16145             element_count++;
16146             non_portable_endpoint = 0;
16147         }
16148         if (UTF && ! UTF8_IS_INVARIANT(* RExC_parse)) {
16149             value = utf8n_to_uvchr((U8*)RExC_parse,
16150                                    RExC_end - RExC_parse,
16151                                    &numlen, UTF8_ALLOW_DEFAULT);
16152             RExC_parse += numlen;
16153         }
16154         else
16155             value = UCHARAT(RExC_parse++);
16156
16157         if (value == '[') {
16158             char * posix_class_end;
16159             namedclass = handle_possible_posix(pRExC_state,
16160                                                RExC_parse,
16161                                                &posix_class_end,
16162                                                do_posix_warnings ? &posix_warnings : NULL,
16163                                                FALSE    /* die if error */);
16164             if (namedclass > OOB_NAMEDCLASS) {
16165
16166                 /* If there was an earlier attempt to parse this particular
16167                  * posix class, and it failed, it was a false alarm, as this
16168                  * successful one proves */
16169                 if (   posix_warnings
16170                     && av_tindex_skip_len_mg(posix_warnings) >= 0
16171                     && not_posix_region_end >= RExC_parse
16172                     && not_posix_region_end <= posix_class_end)
16173                 {
16174                     av_undef(posix_warnings);
16175                 }
16176
16177                 RExC_parse = posix_class_end;
16178             }
16179             else if (namedclass == OOB_NAMEDCLASS) {
16180                 not_posix_region_end = posix_class_end;
16181             }
16182             else {
16183                 namedclass = OOB_NAMEDCLASS;
16184             }
16185         }
16186         else if (   RExC_parse - 1 > not_posix_region_end
16187                  && MAYBE_POSIXCC(value))
16188         {
16189             (void) handle_possible_posix(
16190                         pRExC_state,
16191                         RExC_parse - 1,  /* -1 because parse has already been
16192                                             advanced */
16193                         &not_posix_region_end,
16194                         do_posix_warnings ? &posix_warnings : NULL,
16195                         TRUE /* checking only */);
16196         }
16197         else if (value == '\\') {
16198             /* Is a backslash; get the code point of the char after it */
16199
16200             if (RExC_parse >= RExC_end) {
16201                 vFAIL("Unmatched [");
16202             }
16203
16204             if (UTF && ! UTF8_IS_INVARIANT(UCHARAT(RExC_parse))) {
16205                 value = utf8n_to_uvchr((U8*)RExC_parse,
16206                                    RExC_end - RExC_parse,
16207                                    &numlen, UTF8_ALLOW_DEFAULT);
16208                 RExC_parse += numlen;
16209             }
16210             else
16211                 value = UCHARAT(RExC_parse++);
16212
16213             /* Some compilers cannot handle switching on 64-bit integer
16214              * values, therefore value cannot be an UV.  Yes, this will
16215              * be a problem later if we want switch on Unicode.
16216              * A similar issue a little bit later when switching on
16217              * namedclass. --jhi */
16218
16219             /* If the \ is escaping white space when white space is being
16220              * skipped, it means that that white space is wanted literally, and
16221              * is already in 'value'.  Otherwise, need to translate the escape
16222              * into what it signifies. */
16223             if (! skip_white || ! isBLANK_A(value)) switch ((I32)value) {
16224
16225             case 'w':   namedclass = ANYOF_WORDCHAR;    break;
16226             case 'W':   namedclass = ANYOF_NWORDCHAR;   break;
16227             case 's':   namedclass = ANYOF_SPACE;       break;
16228             case 'S':   namedclass = ANYOF_NSPACE;      break;
16229             case 'd':   namedclass = ANYOF_DIGIT;       break;
16230             case 'D':   namedclass = ANYOF_NDIGIT;      break;
16231             case 'v':   namedclass = ANYOF_VERTWS;      break;
16232             case 'V':   namedclass = ANYOF_NVERTWS;     break;
16233             case 'h':   namedclass = ANYOF_HORIZWS;     break;
16234             case 'H':   namedclass = ANYOF_NHORIZWS;    break;
16235             case 'N':  /* Handle \N{NAME} in class */
16236                 {
16237                     const char * const backslash_N_beg = RExC_parse - 2;
16238                     int cp_count;
16239
16240                     if (! grok_bslash_N(pRExC_state,
16241                                         NULL,      /* No regnode */
16242                                         &value,    /* Yes single value */
16243                                         &cp_count, /* Multiple code pt count */
16244                                         flagp,
16245                                         strict,
16246                                         depth)
16247                     ) {
16248
16249                         if (*flagp & NEED_UTF8)
16250                             FAIL("panic: grok_bslash_N set NEED_UTF8");
16251                         if (*flagp & RESTART_PASS1)
16252                             return NULL;
16253
16254                         if (cp_count < 0) {
16255                             vFAIL("\\N in a character class must be a named character: \\N{...}");
16256                         }
16257                         else if (cp_count == 0) {
16258                             if (PASS2) {
16259                                 ckWARNreg(RExC_parse,
16260                                         "Ignoring zero length \\N{} in character class");
16261                             }
16262                         }
16263                         else { /* cp_count > 1 */
16264                             if (! RExC_in_multi_char_class) {
16265                                 if (invert || range || *RExC_parse == '-') {
16266                                     if (strict) {
16267                                         RExC_parse--;
16268                                         vFAIL("\\N{} in inverted character class or as a range end-point is restricted to one character");
16269                                     }
16270                                     else if (PASS2) {
16271                                         ckWARNreg(RExC_parse, "Using just the first character returned by \\N{} in character class");
16272                                     }
16273                                     break; /* <value> contains the first code
16274                                               point. Drop out of the switch to
16275                                               process it */
16276                                 }
16277                                 else {
16278                                     SV * multi_char_N = newSVpvn(backslash_N_beg,
16279                                                  RExC_parse - backslash_N_beg);
16280                                     multi_char_matches
16281                                         = add_multi_match(multi_char_matches,
16282                                                           multi_char_N,
16283                                                           cp_count);
16284                                 }
16285                             }
16286                         } /* End of cp_count != 1 */
16287
16288                         /* This element should not be processed further in this
16289                          * class */
16290                         element_count--;
16291                         value = save_value;
16292                         prevvalue = save_prevvalue;
16293                         continue;   /* Back to top of loop to get next char */
16294                     }
16295
16296                     /* Here, is a single code point, and <value> contains it */
16297                     unicode_range = TRUE;   /* \N{} are Unicode */
16298                 }
16299                 break;
16300             case 'p':
16301             case 'P':
16302                 {
16303                 char *e;
16304
16305                 /* We will handle any undefined properties ourselves */
16306                 U8 swash_init_flags = _CORE_SWASH_INIT_RETURN_IF_UNDEF
16307                                        /* And we actually would prefer to get
16308                                         * the straight inversion list of the
16309                                         * swash, since we will be accessing it
16310                                         * anyway, to save a little time */
16311                                       |_CORE_SWASH_INIT_ACCEPT_INVLIST;
16312
16313                 if (RExC_parse >= RExC_end)
16314                     vFAIL2("Empty \\%c", (U8)value);
16315                 if (*RExC_parse == '{') {
16316                     const U8 c = (U8)value;
16317                     e = (char *) memchr(RExC_parse, '}', RExC_end - RExC_parse);
16318                     if (!e) {
16319                         RExC_parse++;
16320                         vFAIL2("Missing right brace on \\%c{}", c);
16321                     }
16322
16323                     RExC_parse++;
16324                     while (isSPACE(*RExC_parse)) {
16325                          RExC_parse++;
16326                     }
16327
16328                     if (UCHARAT(RExC_parse) == '^') {
16329
16330                         /* toggle.  (The rhs xor gets the single bit that
16331                          * differs between P and p; the other xor inverts just
16332                          * that bit) */
16333                         value ^= 'P' ^ 'p';
16334
16335                         RExC_parse++;
16336                         while (isSPACE(*RExC_parse)) {
16337                             RExC_parse++;
16338                         }
16339                     }
16340
16341                     if (e == RExC_parse)
16342                         vFAIL2("Empty \\%c{}", c);
16343
16344                     n = e - RExC_parse;
16345                     while (isSPACE(*(RExC_parse + n - 1)))
16346                         n--;
16347                 }   /* The \p isn't immediately followed by a '{' */
16348                 else if (! isALPHA(*RExC_parse)) {
16349                     RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
16350                     vFAIL2("Character following \\%c must be '{' or a "
16351                            "single-character Unicode property name",
16352                            (U8) value);
16353                 }
16354                 else {
16355                     e = RExC_parse;
16356                     n = 1;
16357                 }
16358                 if (!SIZE_ONLY) {
16359                     SV* invlist;
16360                     char* name;
16361                     char* base_name;    /* name after any packages are stripped */
16362                     char* lookup_name = NULL;
16363                     const char * const colon_colon = "::";
16364
16365                     /* Try to get the definition of the property into
16366                      * <invlist>.  If /i is in effect, the effective property
16367                      * will have its name be <__NAME_i>.  The design is
16368                      * discussed in commit
16369                      * 2f833f5208e26b208886e51e09e2c072b5eabb46 */
16370                     name = savepv(Perl_form(aTHX_ "%.*s", (int)n, RExC_parse));
16371                     SAVEFREEPV(name);
16372                     if (FOLD) {
16373                         lookup_name = savepv(Perl_form(aTHX_ "__%s_i", name));
16374
16375                         /* The function call just below that uses this can fail
16376                          * to return, leaking memory if we don't do this */
16377                         SAVEFREEPV(lookup_name);
16378                     }
16379
16380                     /* Look up the property name, and get its swash and
16381                      * inversion list, if the property is found  */
16382                     SvREFCNT_dec(swash); /* Free any left-overs */
16383                     swash = _core_swash_init("utf8",
16384                                              (lookup_name)
16385                                               ? lookup_name
16386                                               : name,
16387                                              &PL_sv_undef,
16388                                              1, /* binary */
16389                                              0, /* not tr/// */
16390                                              NULL, /* No inversion list */
16391                                              &swash_init_flags
16392                                             );
16393                     if (! swash || ! (invlist = _get_swash_invlist(swash))) {
16394                         HV* curpkg = (IN_PERL_COMPILETIME)
16395                                       ? PL_curstash
16396                                       : CopSTASH(PL_curcop);
16397                         UV final_n = n;
16398                         bool has_pkg;
16399
16400                         if (swash) {    /* Got a swash but no inversion list.
16401                                            Something is likely wrong that will
16402                                            be sorted-out later */
16403                             SvREFCNT_dec_NN(swash);
16404                             swash = NULL;
16405                         }
16406
16407                         /* Here didn't find it.  It could be a an error (like a
16408                          * typo) in specifying a Unicode property, or it could
16409                          * be a user-defined property that will be available at
16410                          * run-time.  The names of these must begin with 'In'
16411                          * or 'Is' (after any packages are stripped off).  So
16412                          * if not one of those, or if we accept only
16413                          * compile-time properties, is an error; otherwise add
16414                          * it to the list for run-time look up. */
16415                         if ((base_name = rninstr(name, name + n,
16416                                                  colon_colon, colon_colon + 2)))
16417                         { /* Has ::.  We know this must be a user-defined
16418                              property */
16419                             base_name += 2;
16420                             final_n -= base_name - name;
16421                             has_pkg = TRUE;
16422                         }
16423                         else {
16424                             base_name = name;
16425                             has_pkg = FALSE;
16426                         }
16427
16428                         if (   final_n < 3
16429                             || base_name[0] != 'I'
16430                             || (base_name[1] != 's' && base_name[1] != 'n')
16431                             || ret_invlist)
16432                         {
16433                             const char * const msg
16434                                 = (has_pkg)
16435                                   ? "Illegal user-defined property name"
16436                                   : "Can't find Unicode property definition";
16437                             RExC_parse = e + 1;
16438
16439                             /* diag_listed_as: Can't find Unicode property definition "%s" */
16440                             vFAIL3utf8f("%s \"%" UTF8f "\"",
16441                                 msg, UTF8fARG(UTF, n, name));
16442                         }
16443
16444                         /* If the property name doesn't already have a package
16445                          * name, add the current one to it so that it can be
16446                          * referred to outside it. [perl #121777] */
16447                         if (! has_pkg && curpkg) {
16448                             char* pkgname = HvNAME(curpkg);
16449                             if (memNEs(pkgname, HvNAMELEN(curpkg), "main")) {
16450                                 char* full_name = Perl_form(aTHX_
16451                                                             "%s::%s",
16452                                                             pkgname,
16453                                                             name);
16454                                 n = strlen(full_name);
16455                                 name = savepvn(full_name, n);
16456                                 SAVEFREEPV(name);
16457                             }
16458                         }
16459                         Perl_sv_catpvf(aTHX_ listsv, "%cutf8::%s%" UTF8f "%s\n",
16460                                         (value == 'p' ? '+' : '!'),
16461                                         (FOLD) ? "__" : "",
16462                                         UTF8fARG(UTF, n, name),
16463                                         (FOLD) ? "_i" : "");
16464                         has_user_defined_property = TRUE;
16465                         optimizable = FALSE;    /* Will have to leave this an
16466                                                    ANYOF node */
16467
16468                         /* We don't know yet what this matches, so have to flag
16469                          * it */
16470                         ANYOF_FLAGS(ret) |= ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP;
16471                     }
16472                     else {
16473
16474                         /* Here, did get the swash and its inversion list.  If
16475                          * the swash is from a user-defined property, then this
16476                          * whole character class should be regarded as such */
16477                         if (swash_init_flags
16478                             & _CORE_SWASH_INIT_USER_DEFINED_PROPERTY)
16479                         {
16480                             has_user_defined_property = TRUE;
16481                         }
16482                         else if
16483                             /* We warn on matching an above-Unicode code point
16484                              * if the match would return true, except don't
16485                              * warn for \p{All}, which has exactly one element
16486                              * = 0 */
16487                             (_invlist_contains_cp(invlist, 0x110000)
16488                                 && (! (_invlist_len(invlist) == 1
16489                                        && *invlist_array(invlist) == 0)))
16490                         {
16491                             warn_super = TRUE;
16492                         }
16493
16494
16495                         /* Invert if asking for the complement */
16496                         if (value == 'P') {
16497                             _invlist_union_complement_2nd(properties,
16498                                                           invlist,
16499                                                           &properties);
16500
16501                             /* The swash can't be used as-is, because we've
16502                              * inverted things; delay removing it to here after
16503                              * have copied its invlist above */
16504                             SvREFCNT_dec_NN(swash);
16505                             swash = NULL;
16506                         }
16507                         else {
16508                             _invlist_union(properties, invlist, &properties);
16509                         }
16510                     }
16511                 }
16512                 RExC_parse = e + 1;
16513                 namedclass = ANYOF_UNIPROP;  /* no official name, but it's
16514                                                 named */
16515
16516                 /* \p means they want Unicode semantics */
16517                 REQUIRE_UNI_RULES(flagp, NULL);
16518                 }
16519                 break;
16520             case 'n':   value = '\n';                   break;
16521             case 'r':   value = '\r';                   break;
16522             case 't':   value = '\t';                   break;
16523             case 'f':   value = '\f';                   break;
16524             case 'b':   value = '\b';                   break;
16525             case 'e':   value = ESC_NATIVE;             break;
16526             case 'a':   value = '\a';                   break;
16527             case 'o':
16528                 RExC_parse--;   /* function expects to be pointed at the 'o' */
16529                 {
16530                     const char* error_msg;
16531                     bool valid = grok_bslash_o(&RExC_parse,
16532                                                RExC_end,
16533                                                &value,
16534                                                &error_msg,
16535                                                PASS2,   /* warnings only in
16536                                                            pass 2 */
16537                                                strict,
16538                                                silence_non_portable,
16539                                                UTF);
16540                     if (! valid) {
16541                         vFAIL(error_msg);
16542                     }
16543                 }
16544                 non_portable_endpoint++;
16545                 break;
16546             case 'x':
16547                 RExC_parse--;   /* function expects to be pointed at the 'x' */
16548                 {
16549                     const char* error_msg;
16550                     bool valid = grok_bslash_x(&RExC_parse,
16551                                                RExC_end,
16552                                                &value,
16553                                                &error_msg,
16554                                                PASS2, /* Output warnings */
16555                                                strict,
16556                                                silence_non_portable,
16557                                                UTF);
16558                     if (! valid) {
16559                         vFAIL(error_msg);
16560                     }
16561                 }
16562                 non_portable_endpoint++;
16563                 break;
16564             case 'c':
16565                 value = grok_bslash_c(*RExC_parse++, PASS2);
16566                 non_portable_endpoint++;
16567                 break;
16568             case '0': case '1': case '2': case '3': case '4':
16569             case '5': case '6': case '7':
16570                 {
16571                     /* Take 1-3 octal digits */
16572                     I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
16573                     numlen = (strict) ? 4 : 3;
16574                     value = grok_oct(--RExC_parse, &numlen, &flags, NULL);
16575                     RExC_parse += numlen;
16576                     if (numlen != 3) {
16577                         if (strict) {
16578                             RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
16579                             vFAIL("Need exactly 3 octal digits");
16580                         }
16581                         else if (! SIZE_ONLY /* like \08, \178 */
16582                                  && numlen < 3
16583                                  && RExC_parse < RExC_end
16584                                  && isDIGIT(*RExC_parse)
16585                                  && ckWARN(WARN_REGEXP))
16586                         {
16587                             SAVEFREESV(RExC_rx_sv);
16588                             reg_warn_non_literal_string(
16589                                  RExC_parse + 1,
16590                                  form_short_octal_warning(RExC_parse, numlen));
16591                             (void)ReREFCNT_inc(RExC_rx_sv);
16592                         }
16593                     }
16594                     non_portable_endpoint++;
16595                     break;
16596                 }
16597             default:
16598                 /* Allow \_ to not give an error */
16599                 if (!SIZE_ONLY && isWORDCHAR(value) && value != '_') {
16600                     if (strict) {
16601                         vFAIL2("Unrecognized escape \\%c in character class",
16602                                (int)value);
16603                     }
16604                     else {
16605                         SAVEFREESV(RExC_rx_sv);
16606                         ckWARN2reg(RExC_parse,
16607                             "Unrecognized escape \\%c in character class passed through",
16608                             (int)value);
16609                         (void)ReREFCNT_inc(RExC_rx_sv);
16610                     }
16611                 }
16612                 break;
16613             }   /* End of switch on char following backslash */
16614         } /* end of handling backslash escape sequences */
16615
16616         /* Here, we have the current token in 'value' */
16617
16618         if (namedclass > OOB_NAMEDCLASS) { /* this is a named class \blah */
16619             U8 classnum;
16620
16621             /* a bad range like a-\d, a-[:digit:].  The '-' is taken as a
16622              * literal, as is the character that began the false range, i.e.
16623              * the 'a' in the examples */
16624             if (range) {
16625                 if (!SIZE_ONLY) {
16626                     const int w = (RExC_parse >= rangebegin)
16627                                   ? RExC_parse - rangebegin
16628                                   : 0;
16629                     if (strict) {
16630                         vFAIL2utf8f(
16631                             "False [] range \"%" UTF8f "\"",
16632                             UTF8fARG(UTF, w, rangebegin));
16633                     }
16634                     else {
16635                         SAVEFREESV(RExC_rx_sv); /* in case of fatal warnings */
16636                         ckWARN2reg(RExC_parse,
16637                             "False [] range \"%" UTF8f "\"",
16638                             UTF8fARG(UTF, w, rangebegin));
16639                         (void)ReREFCNT_inc(RExC_rx_sv);
16640                         cp_list = add_cp_to_invlist(cp_list, '-');
16641                         cp_foldable_list = add_cp_to_invlist(cp_foldable_list,
16642                                                              prevvalue);
16643                     }
16644                 }
16645
16646                 range = 0; /* this was not a true range */
16647                 element_count += 2; /* So counts for three values */
16648             }
16649
16650             classnum = namedclass_to_classnum(namedclass);
16651
16652             if (LOC && namedclass < ANYOF_POSIXL_MAX
16653 #ifndef HAS_ISASCII
16654                 && classnum != _CC_ASCII
16655 #endif
16656             ) {
16657                 /* What the Posix classes (like \w, [:space:]) match in locale
16658                  * isn't knowable under locale until actual match time.  Room
16659                  * must be reserved (one time per outer bracketed class) to
16660                  * store such classes.  The space will contain a bit for each
16661                  * named class that is to be matched against.  This isn't
16662                  * needed for \p{} and pseudo-classes, as they are not affected
16663                  * by locale, and hence are dealt with separately */
16664                 if (! need_class) {
16665                     need_class = 1;
16666                     if (SIZE_ONLY) {
16667                         RExC_size += ANYOF_POSIXL_SKIP - ANYOF_SKIP;
16668                     }
16669                     else {
16670                         RExC_emit += ANYOF_POSIXL_SKIP - ANYOF_SKIP;
16671                     }
16672                     ANYOF_FLAGS(ret) |= ANYOF_MATCHES_POSIXL;
16673                     ANYOF_POSIXL_ZERO(ret);
16674
16675                     /* We can't change this into some other type of node
16676                      * (unless this is the only element, in which case there
16677                      * are nodes that mean exactly this) as has runtime
16678                      * dependencies */
16679                     optimizable = FALSE;
16680                 }
16681
16682                 /* Coverity thinks it is possible for this to be negative; both
16683                  * jhi and khw think it's not, but be safer */
16684                 assert(! (ANYOF_FLAGS(ret) & ANYOF_MATCHES_POSIXL)
16685                        || (namedclass + ((namedclass % 2) ? -1 : 1)) >= 0);
16686
16687                 /* See if it already matches the complement of this POSIX
16688                  * class */
16689                 if ((ANYOF_FLAGS(ret) & ANYOF_MATCHES_POSIXL)
16690                     && ANYOF_POSIXL_TEST(ret, namedclass + ((namedclass % 2)
16691                                                             ? -1
16692                                                             : 1)))
16693                 {
16694                     posixl_matches_all = TRUE;
16695                     break;  /* No need to continue.  Since it matches both
16696                                e.g., \w and \W, it matches everything, and the
16697                                bracketed class can be optimized into qr/./s */
16698                 }
16699
16700                 /* Add this class to those that should be checked at runtime */
16701                 ANYOF_POSIXL_SET(ret, namedclass);
16702
16703                 /* The above-Latin1 characters are not subject to locale rules.
16704                  * Just add them, in the second pass, to the
16705                  * unconditionally-matched list */
16706                 if (! SIZE_ONLY) {
16707                     SV* scratch_list = NULL;
16708
16709                     /* Get the list of the above-Latin1 code points this
16710                      * matches */
16711                     _invlist_intersection_maybe_complement_2nd(PL_AboveLatin1,
16712                                           PL_XPosix_ptrs[classnum],
16713
16714                                           /* Odd numbers are complements, like
16715                                            * NDIGIT, NASCII, ... */
16716                                           namedclass % 2 != 0,
16717                                           &scratch_list);
16718                     /* Checking if 'cp_list' is NULL first saves an extra
16719                      * clone.  Its reference count will be decremented at the
16720                      * next union, etc, or if this is the only instance, at the
16721                      * end of the routine */
16722                     if (! cp_list) {
16723                         cp_list = scratch_list;
16724                     }
16725                     else {
16726                         _invlist_union(cp_list, scratch_list, &cp_list);
16727                         SvREFCNT_dec_NN(scratch_list);
16728                     }
16729                     continue;   /* Go get next character */
16730                 }
16731             }
16732             else if (! SIZE_ONLY) {
16733
16734                 /* Here, not in pass1 (in that pass we skip calculating the
16735                  * contents of this class), and is not /l, or is a POSIX class
16736                  * for which /l doesn't matter (or is a Unicode property, which
16737                  * is skipped here). */
16738                 if (namedclass >= ANYOF_POSIXL_MAX) {  /* If a special class */
16739                     if (namedclass != ANYOF_UNIPROP) { /* UNIPROP = \p and \P */
16740
16741                         /* Here, should be \h, \H, \v, or \V.  None of /d, /i
16742                          * nor /l make a difference in what these match,
16743                          * therefore we just add what they match to cp_list. */
16744                         if (classnum != _CC_VERTSPACE) {
16745                             assert(   namedclass == ANYOF_HORIZWS
16746                                    || namedclass == ANYOF_NHORIZWS);
16747
16748                             /* It turns out that \h is just a synonym for
16749                              * XPosixBlank */
16750                             classnum = _CC_BLANK;
16751                         }
16752
16753                         _invlist_union_maybe_complement_2nd(
16754                                 cp_list,
16755                                 PL_XPosix_ptrs[classnum],
16756                                 namedclass % 2 != 0,    /* Complement if odd
16757                                                           (NHORIZWS, NVERTWS)
16758                                                         */
16759                                 &cp_list);
16760                     }
16761                 }
16762                 else if (  UNI_SEMANTICS
16763                         || classnum == _CC_ASCII
16764                         || (DEPENDS_SEMANTICS && (   classnum == _CC_DIGIT
16765                                                   || classnum == _CC_XDIGIT)))
16766                 {
16767                     /* We usually have to worry about /d and /a affecting what
16768                      * POSIX classes match, with special code needed for /d
16769                      * because we won't know until runtime what all matches.
16770                      * But there is no extra work needed under /u, and
16771                      * [:ascii:] is unaffected by /a and /d; and :digit: and
16772                      * :xdigit: don't have runtime differences under /d.  So we
16773                      * can special case these, and avoid some extra work below,
16774                      * and at runtime. */
16775                     _invlist_union_maybe_complement_2nd(
16776                                                      simple_posixes,
16777                                                      PL_XPosix_ptrs[classnum],
16778                                                      namedclass % 2 != 0,
16779                                                      &simple_posixes);
16780                 }
16781                 else {  /* Garden variety class.  If is NUPPER, NALPHA, ...
16782                            complement and use nposixes */
16783                     SV** posixes_ptr = namedclass % 2 == 0
16784                                        ? &posixes
16785                                        : &nposixes;
16786                     _invlist_union_maybe_complement_2nd(
16787                                                      *posixes_ptr,
16788                                                      PL_XPosix_ptrs[classnum],
16789                                                      namedclass % 2 != 0,
16790                                                      posixes_ptr);
16791                 }
16792             }
16793         } /* end of namedclass \blah */
16794
16795         SKIP_BRACKETED_WHITE_SPACE(skip_white, RExC_parse);
16796
16797         /* If 'range' is set, 'value' is the ending of a range--check its
16798          * validity.  (If value isn't a single code point in the case of a
16799          * range, we should have figured that out above in the code that
16800          * catches false ranges).  Later, we will handle each individual code
16801          * point in the range.  If 'range' isn't set, this could be the
16802          * beginning of a range, so check for that by looking ahead to see if
16803          * the next real character to be processed is the range indicator--the
16804          * minus sign */
16805
16806         if (range) {
16807 #ifdef EBCDIC
16808             /* For unicode ranges, we have to test that the Unicode as opposed
16809              * to the native values are not decreasing.  (Above 255, there is
16810              * no difference between native and Unicode) */
16811             if (unicode_range && prevvalue < 255 && value < 255) {
16812                 if (NATIVE_TO_LATIN1(prevvalue) > NATIVE_TO_LATIN1(value)) {
16813                     goto backwards_range;
16814                 }
16815             }
16816             else
16817 #endif
16818             if (prevvalue > value) /* b-a */ {
16819                 int w;
16820 #ifdef EBCDIC
16821               backwards_range:
16822 #endif
16823                 w = RExC_parse - rangebegin;
16824                 vFAIL2utf8f(
16825                     "Invalid [] range \"%" UTF8f "\"",
16826                     UTF8fARG(UTF, w, rangebegin));
16827                 NOT_REACHED; /* NOTREACHED */
16828             }
16829         }
16830         else {
16831             prevvalue = value; /* save the beginning of the potential range */
16832             if (! stop_at_1     /* Can't be a range if parsing just one thing */
16833                 && *RExC_parse == '-')
16834             {
16835                 char* next_char_ptr = RExC_parse + 1;
16836
16837                 /* Get the next real char after the '-' */
16838                 SKIP_BRACKETED_WHITE_SPACE(skip_white, next_char_ptr);
16839
16840                 /* If the '-' is at the end of the class (just before the ']',
16841                  * it is a literal minus; otherwise it is a range */
16842                 if (next_char_ptr < RExC_end && *next_char_ptr != ']') {
16843                     RExC_parse = next_char_ptr;
16844
16845                     /* a bad range like \w-, [:word:]- ? */
16846                     if (namedclass > OOB_NAMEDCLASS) {
16847                         if (strict || (PASS2 && ckWARN(WARN_REGEXP))) {
16848                             const int w = RExC_parse >= rangebegin
16849                                           ?  RExC_parse - rangebegin
16850                                           : 0;
16851                             if (strict) {
16852                                 vFAIL4("False [] range \"%*.*s\"",
16853                                     w, w, rangebegin);
16854                             }
16855                             else if (PASS2) {
16856                                 vWARN4(RExC_parse,
16857                                     "False [] range \"%*.*s\"",
16858                                     w, w, rangebegin);
16859                             }
16860                         }
16861                         if (!SIZE_ONLY) {
16862                             cp_list = add_cp_to_invlist(cp_list, '-');
16863                         }
16864                         element_count++;
16865                     } else
16866                         range = 1;      /* yeah, it's a range! */
16867                     continue;   /* but do it the next time */
16868                 }
16869             }
16870         }
16871
16872         if (namedclass > OOB_NAMEDCLASS) {
16873             continue;
16874         }
16875
16876         /* Here, we have a single value this time through the loop, and
16877          * <prevvalue> is the beginning of the range, if any; or <value> if
16878          * not. */
16879
16880         /* non-Latin1 code point implies unicode semantics.  Must be set in
16881          * pass1 so is there for the whole of pass 2 */
16882         if (value > 255) {
16883             REQUIRE_UNI_RULES(flagp, NULL);
16884         }
16885
16886         /* Ready to process either the single value, or the completed range.
16887          * For single-valued non-inverted ranges, we consider the possibility
16888          * of multi-char folds.  (We made a conscious decision to not do this
16889          * for the other cases because it can often lead to non-intuitive
16890          * results.  For example, you have the peculiar case that:
16891          *  "s s" =~ /^[^\xDF]+$/i => Y
16892          *  "ss"  =~ /^[^\xDF]+$/i => N
16893          *
16894          * See [perl #89750] */
16895         if (FOLD && allow_multi_folds && value == prevvalue) {
16896             if (value == LATIN_SMALL_LETTER_SHARP_S
16897                 || (value > 255 && _invlist_contains_cp(PL_HasMultiCharFold,
16898                                                         value)))
16899             {
16900                 /* Here <value> is indeed a multi-char fold.  Get what it is */
16901
16902                 U8 foldbuf[UTF8_MAXBYTES_CASE];
16903                 STRLEN foldlen;
16904
16905                 UV folded = _to_uni_fold_flags(
16906                                 value,
16907                                 foldbuf,
16908                                 &foldlen,
16909                                 FOLD_FLAGS_FULL | (ASCII_FOLD_RESTRICTED
16910                                                    ? FOLD_FLAGS_NOMIX_ASCII
16911                                                    : 0)
16912                                 );
16913
16914                 /* Here, <folded> should be the first character of the
16915                  * multi-char fold of <value>, with <foldbuf> containing the
16916                  * whole thing.  But, if this fold is not allowed (because of
16917                  * the flags), <fold> will be the same as <value>, and should
16918                  * be processed like any other character, so skip the special
16919                  * handling */
16920                 if (folded != value) {
16921
16922                     /* Skip if we are recursed, currently parsing the class
16923                      * again.  Otherwise add this character to the list of
16924                      * multi-char folds. */
16925                     if (! RExC_in_multi_char_class) {
16926                         STRLEN cp_count = utf8_length(foldbuf,
16927                                                       foldbuf + foldlen);
16928                         SV* multi_fold = sv_2mortal(newSVpvs(""));
16929
16930                         Perl_sv_catpvf(aTHX_ multi_fold, "\\x{%" UVXf "}", value);
16931
16932                         multi_char_matches
16933                                         = add_multi_match(multi_char_matches,
16934                                                           multi_fold,
16935                                                           cp_count);
16936
16937                     }
16938
16939                     /* This element should not be processed further in this
16940                      * class */
16941                     element_count--;
16942                     value = save_value;
16943                     prevvalue = save_prevvalue;
16944                     continue;
16945                 }
16946             }
16947         }
16948
16949         if (strict && PASS2 && ckWARN(WARN_REGEXP)) {
16950             if (range) {
16951
16952                 /* If the range starts above 255, everything is portable and
16953                  * likely to be so for any forseeable character set, so don't
16954                  * warn. */
16955                 if (unicode_range && non_portable_endpoint && prevvalue < 256) {
16956                     vWARN(RExC_parse, "Both or neither range ends should be Unicode");
16957                 }
16958                 else if (prevvalue != value) {
16959
16960                     /* Under strict, ranges that stop and/or end in an ASCII
16961                      * printable should have each end point be a portable value
16962                      * for it (preferably like 'A', but we don't warn if it is
16963                      * a (portable) Unicode name or code point), and the range
16964                      * must be be all digits or all letters of the same case.
16965                      * Otherwise, the range is non-portable and unclear as to
16966                      * what it contains */
16967                     if (             (isPRINT_A(prevvalue) || isPRINT_A(value))
16968                         && (          non_portable_endpoint
16969                             || ! (   (isDIGIT_A(prevvalue) && isDIGIT_A(value))
16970                                   || (isLOWER_A(prevvalue) && isLOWER_A(value))
16971                                   || (isUPPER_A(prevvalue) && isUPPER_A(value))
16972                     ))) {
16973                         vWARN(RExC_parse, "Ranges of ASCII printables should"
16974                                           " be some subset of \"0-9\","
16975                                           " \"A-Z\", or \"a-z\"");
16976                     }
16977                     else if (prevvalue >= 0x660) { /* ARABIC_INDIC_DIGIT_ZERO */
16978                         SSize_t index_start;
16979                         SSize_t index_final;
16980
16981                         /* But the nature of Unicode and languages mean we
16982                          * can't do the same checks for above-ASCII ranges,
16983                          * except in the case of digit ones.  These should
16984                          * contain only digits from the same group of 10.  The
16985                          * ASCII case is handled just above.  0x660 is the
16986                          * first digit character beyond ASCII.  Hence here, the
16987                          * range could be a range of digits.  First some
16988                          * unlikely special cases.  Grandfather in that a range
16989                          * ending in 19DA (NEW TAI LUE THAM DIGIT ONE) is bad
16990                          * if its starting value is one of the 10 digits prior
16991                          * to it.  This is because it is an alternate way of
16992                          * writing 19D1, and some people may expect it to be in
16993                          * that group.  But it is bad, because it won't give
16994                          * the expected results.  In Unicode 5.2 it was
16995                          * considered to be in that group (of 11, hence), but
16996                          * this was fixed in the next version */
16997
16998                         if (UNLIKELY(value == 0x19DA && prevvalue >= 0x19D0)) {
16999                             goto warn_bad_digit_range;
17000                         }
17001                         else if (UNLIKELY(   prevvalue >= 0x1D7CE
17002                                           &&     value <= 0x1D7FF))
17003                         {
17004                             /* This is the only other case currently in Unicode
17005                              * where the algorithm below fails.  The code
17006                              * points just above are the end points of a single
17007                              * range containing only decimal digits.  It is 5
17008                              * different series of 0-9.  All other ranges of
17009                              * digits currently in Unicode are just a single
17010                              * series.  (And mktables will notify us if a later
17011                              * Unicode version breaks this.)
17012                              *
17013                              * If the range being checked is at most 9 long,
17014                              * and the digit values represented are in
17015                              * numerical order, they are from the same series.
17016                              * */
17017                             if (         value - prevvalue > 9
17018                                 ||    (((    value - 0x1D7CE) % 10)
17019                                      <= (prevvalue - 0x1D7CE) % 10))
17020                             {
17021                                 goto warn_bad_digit_range;
17022                             }
17023                         }
17024                         else {
17025
17026                             /* For all other ranges of digits in Unicode, the
17027                              * algorithm is just to check if both end points
17028                              * are in the same series, which is the same range.
17029                              * */
17030                             index_start = _invlist_search(
17031                                                     PL_XPosix_ptrs[_CC_DIGIT],
17032                                                     prevvalue);
17033
17034                             /* Warn if the range starts and ends with a digit,
17035                              * and they are not in the same group of 10. */
17036                             if (   index_start >= 0
17037                                 && ELEMENT_RANGE_MATCHES_INVLIST(index_start)
17038                                 && (index_final =
17039                                     _invlist_search(PL_XPosix_ptrs[_CC_DIGIT],
17040                                                     value)) != index_start
17041                                 && index_final >= 0
17042                                 && ELEMENT_RANGE_MATCHES_INVLIST(index_final))
17043                             {
17044                               warn_bad_digit_range:
17045                                 vWARN(RExC_parse, "Ranges of digits should be"
17046                                                   " from the same group of"
17047                                                   " 10");
17048                             }
17049                         }
17050                     }
17051                 }
17052             }
17053             if ((! range || prevvalue == value) && non_portable_endpoint) {
17054                 if (isPRINT_A(value)) {
17055                     char literal[3];
17056                     unsigned d = 0;
17057                     if (isBACKSLASHED_PUNCT(value)) {
17058                         literal[d++] = '\\';
17059                     }
17060                     literal[d++] = (char) value;
17061                     literal[d++] = '\0';
17062
17063                     vWARN4(RExC_parse,
17064                            "\"%.*s\" is more clearly written simply as \"%s\"",
17065                            (int) (RExC_parse - rangebegin),
17066                            rangebegin,
17067                            literal
17068                         );
17069                 }
17070                 else if isMNEMONIC_CNTRL(value) {
17071                     vWARN4(RExC_parse,
17072                            "\"%.*s\" is more clearly written simply as \"%s\"",
17073                            (int) (RExC_parse - rangebegin),
17074                            rangebegin,
17075                            cntrl_to_mnemonic((U8) value)
17076                         );
17077                 }
17078             }
17079         }
17080
17081         /* Deal with this element of the class */
17082         if (! SIZE_ONLY) {
17083
17084 #ifndef EBCDIC
17085             cp_foldable_list = _add_range_to_invlist(cp_foldable_list,
17086                                                      prevvalue, value);
17087 #else
17088             /* On non-ASCII platforms, for ranges that span all of 0..255, and
17089              * ones that don't require special handling, we can just add the
17090              * range like we do for ASCII platforms */
17091             if ((UNLIKELY(prevvalue == 0) && value >= 255)
17092                 || ! (prevvalue < 256
17093                       && (unicode_range
17094                           || (! non_portable_endpoint
17095                               && ((isLOWER_A(prevvalue) && isLOWER_A(value))
17096                                   || (isUPPER_A(prevvalue)
17097                                       && isUPPER_A(value)))))))
17098             {
17099                 cp_foldable_list = _add_range_to_invlist(cp_foldable_list,
17100                                                          prevvalue, value);
17101             }
17102             else {
17103                 /* Here, requires special handling.  This can be because it is
17104                  * a range whose code points are considered to be Unicode, and
17105                  * so must be individually translated into native, or because
17106                  * its a subrange of 'A-Z' or 'a-z' which each aren't
17107                  * contiguous in EBCDIC, but we have defined them to include
17108                  * only the "expected" upper or lower case ASCII alphabetics.
17109                  * Subranges above 255 are the same in native and Unicode, so
17110                  * can be added as a range */
17111                 U8 start = NATIVE_TO_LATIN1(prevvalue);
17112                 unsigned j;
17113                 U8 end = (value < 256) ? NATIVE_TO_LATIN1(value) : 255;
17114                 for (j = start; j <= end; j++) {
17115                     cp_foldable_list = add_cp_to_invlist(cp_foldable_list, LATIN1_TO_NATIVE(j));
17116                 }
17117                 if (value > 255) {
17118                     cp_foldable_list = _add_range_to_invlist(cp_foldable_list,
17119                                                              256, value);
17120                 }
17121             }
17122 #endif
17123         }
17124
17125         range = 0; /* this range (if it was one) is done now */
17126     } /* End of loop through all the text within the brackets */
17127
17128
17129     if (   posix_warnings && av_tindex_skip_len_mg(posix_warnings) >= 0) {
17130         output_or_return_posix_warnings(pRExC_state, posix_warnings,
17131                                         return_posix_warnings);
17132     }
17133
17134     /* If anything in the class expands to more than one character, we have to
17135      * deal with them by building up a substitute parse string, and recursively
17136      * calling reg() on it, instead of proceeding */
17137     if (multi_char_matches) {
17138         SV * substitute_parse = newSVpvn_flags("?:", 2, SVs_TEMP);
17139         I32 cp_count;
17140         STRLEN len;
17141         char *save_end = RExC_end;
17142         char *save_parse = RExC_parse;
17143         char *save_start = RExC_start;
17144         STRLEN prefix_end = 0;      /* We copy the character class after a
17145                                        prefix supplied here.  This is the size
17146                                        + 1 of that prefix */
17147         bool first_time = TRUE;     /* First multi-char occurrence doesn't get
17148                                        a "|" */
17149         I32 reg_flags;
17150
17151         assert(! invert);
17152         assert(RExC_precomp_adj == 0); /* Only one level of recursion allowed */
17153
17154 #if 0   /* Have decided not to deal with multi-char folds in inverted classes,
17155            because too confusing */
17156         if (invert) {
17157             sv_catpv(substitute_parse, "(?:");
17158         }
17159 #endif
17160
17161         /* Look at the longest folds first */
17162         for (cp_count = av_tindex_skip_len_mg(multi_char_matches);
17163                         cp_count > 0;
17164                         cp_count--)
17165         {
17166
17167             if (av_exists(multi_char_matches, cp_count)) {
17168                 AV** this_array_ptr;
17169                 SV* this_sequence;
17170
17171                 this_array_ptr = (AV**) av_fetch(multi_char_matches,
17172                                                  cp_count, FALSE);
17173                 while ((this_sequence = av_pop(*this_array_ptr)) !=
17174                                                                 &PL_sv_undef)
17175                 {
17176                     if (! first_time) {
17177                         sv_catpv(substitute_parse, "|");
17178                     }
17179                     first_time = FALSE;
17180
17181                     sv_catpv(substitute_parse, SvPVX(this_sequence));
17182                 }
17183             }
17184         }
17185
17186         /* If the character class contains anything else besides these
17187          * multi-character folds, have to include it in recursive parsing */
17188         if (element_count) {
17189             sv_catpv(substitute_parse, "|[");
17190             prefix_end = SvCUR(substitute_parse);
17191             sv_catpvn(substitute_parse, orig_parse, RExC_parse - orig_parse);
17192
17193             /* Put in a closing ']' only if not going off the end, as otherwise
17194              * we are adding something that really isn't there */
17195             if (RExC_parse < RExC_end) {
17196                 sv_catpv(substitute_parse, "]");
17197             }
17198         }
17199
17200         sv_catpv(substitute_parse, ")");
17201 #if 0
17202         if (invert) {
17203             /* This is a way to get the parse to skip forward a whole named
17204              * sequence instead of matching the 2nd character when it fails the
17205              * first */
17206             sv_catpv(substitute_parse, "(*THEN)(*SKIP)(*FAIL)|.)");
17207         }
17208 #endif
17209
17210         /* Set up the data structure so that any errors will be properly
17211          * reported.  See the comments at the definition of
17212          * REPORT_LOCATION_ARGS for details */
17213         RExC_precomp_adj = orig_parse - RExC_precomp;
17214         RExC_start =  RExC_parse = SvPV(substitute_parse, len);
17215         RExC_adjusted_start = RExC_start + prefix_end;
17216         RExC_end = RExC_parse + len;
17217         RExC_in_multi_char_class = 1;
17218         RExC_emit = (regnode *)orig_emit;
17219
17220         ret = reg(pRExC_state, 1, &reg_flags, depth+1);
17221
17222         *flagp |= reg_flags&(HASWIDTH|SIMPLE|SPSTART|POSTPONED|RESTART_PASS1|NEED_UTF8);
17223
17224         /* And restore so can parse the rest of the pattern */
17225         RExC_parse = save_parse;
17226         RExC_start = RExC_adjusted_start = save_start;
17227         RExC_precomp_adj = 0;
17228         RExC_end = save_end;
17229         RExC_in_multi_char_class = 0;
17230         SvREFCNT_dec_NN(multi_char_matches);
17231         return ret;
17232     }
17233
17234     /* Here, we've gone through the entire class and dealt with multi-char
17235      * folds.  We are now in a position that we can do some checks to see if we
17236      * can optimize this ANYOF node into a simpler one, even in Pass 1.
17237      * Currently we only do two checks:
17238      * 1) is in the unlikely event that the user has specified both, eg. \w and
17239      *    \W under /l, then the class matches everything.  (This optimization
17240      *    is done only to make the optimizer code run later work.)
17241      * 2) if the character class contains only a single element (including a
17242      *    single range), we see if there is an equivalent node for it.
17243      * Other checks are possible */
17244     if (   optimizable
17245         && ! ret_invlist   /* Can't optimize if returning the constructed
17246                               inversion list */
17247         && (UNLIKELY(posixl_matches_all) || element_count == 1))
17248     {
17249         U8 op = END;
17250         U8 arg = 0;
17251
17252         if (UNLIKELY(posixl_matches_all)) {
17253             op = SANY;
17254         }
17255         else if (namedclass > OOB_NAMEDCLASS) { /* this is a single named
17256                                                    class, like \w or [:digit:]
17257                                                    or \p{foo} */
17258
17259             /* All named classes are mapped into POSIXish nodes, with its FLAG
17260              * argument giving which class it is */
17261             switch ((I32)namedclass) {
17262                 case ANYOF_UNIPROP:
17263                     break;
17264
17265                 /* These don't depend on the charset modifiers.  They always
17266                  * match under /u rules */
17267                 case ANYOF_NHORIZWS:
17268                 case ANYOF_HORIZWS:
17269                     namedclass = ANYOF_BLANK + namedclass - ANYOF_HORIZWS;
17270                     /* FALLTHROUGH */
17271
17272                 case ANYOF_NVERTWS:
17273                 case ANYOF_VERTWS:
17274                     op = POSIXU;
17275                     goto join_posix;
17276
17277                 /* The actual POSIXish node for all the rest depends on the
17278                  * charset modifier.  The ones in the first set depend only on
17279                  * ASCII or, if available on this platform, also locale */
17280                 case ANYOF_ASCII:
17281                 case ANYOF_NASCII:
17282 #ifdef HAS_ISASCII
17283                     op = (LOC) ? POSIXL : POSIXA;
17284 #else
17285                     op = POSIXA;
17286 #endif
17287                     goto join_posix;
17288
17289                 /* The following don't have any matches in the upper Latin1
17290                  * range, hence /d is equivalent to /u for them.  Making it /u
17291                  * saves some branches at runtime */
17292                 case ANYOF_DIGIT:
17293                 case ANYOF_NDIGIT:
17294                 case ANYOF_XDIGIT:
17295                 case ANYOF_NXDIGIT:
17296                     if (! DEPENDS_SEMANTICS) {
17297                         goto treat_as_default;
17298                     }
17299
17300                     op = POSIXU;
17301                     goto join_posix;
17302
17303                 /* The following change to CASED under /i */
17304                 case ANYOF_LOWER:
17305                 case ANYOF_NLOWER:
17306                 case ANYOF_UPPER:
17307                 case ANYOF_NUPPER:
17308                     if (FOLD) {
17309                         namedclass = ANYOF_CASED + (namedclass % 2);
17310                     }
17311                     /* FALLTHROUGH */
17312
17313                 /* The rest have more possibilities depending on the charset.
17314                  * We take advantage of the enum ordering of the charset
17315                  * modifiers to get the exact node type, */
17316                 default:
17317                   treat_as_default:
17318                     op = POSIXD + get_regex_charset(RExC_flags);
17319                     if (op > POSIXA) { /* /aa is same as /a */
17320                         op = POSIXA;
17321                     }
17322
17323                   join_posix:
17324                     /* The odd numbered ones are the complements of the
17325                      * next-lower even number one */
17326                     if (namedclass % 2 == 1) {
17327                         invert = ! invert;
17328                         namedclass--;
17329                     }
17330                     arg = namedclass_to_classnum(namedclass);
17331                     break;
17332             }
17333         }
17334         else if (value == prevvalue) {
17335
17336             /* Here, the class consists of just a single code point */
17337
17338             if (invert) {
17339                 if (! LOC && value == '\n') {
17340                     op = REG_ANY; /* Optimize [^\n] */
17341                     *flagp |= HASWIDTH|SIMPLE;
17342                     MARK_NAUGHTY(1);
17343                 }
17344             }
17345             else if (value < 256 || UTF) {
17346
17347                 /* Optimize a single value into an EXACTish node, but not if it
17348                  * would require converting the pattern to UTF-8. */
17349                 op = compute_EXACTish(pRExC_state);
17350             }
17351         } /* Otherwise is a range */
17352         else if (! LOC) {   /* locale could vary these */
17353             if (prevvalue == '0') {
17354                 if (value == '9') {
17355                     arg = _CC_DIGIT;
17356                     op = POSIXA;
17357                 }
17358             }
17359             else if (! FOLD || ASCII_FOLD_RESTRICTED) {
17360                 /* We can optimize A-Z or a-z, but not if they could match
17361                  * something like the KELVIN SIGN under /i. */
17362                 if (prevvalue == 'A') {
17363                     if (value == 'Z'
17364 #ifdef EBCDIC
17365                         && ! non_portable_endpoint
17366 #endif
17367                     ) {
17368                         arg = (FOLD) ? _CC_ALPHA : _CC_UPPER;
17369                         op = POSIXA;
17370                     }
17371                 }
17372                 else if (prevvalue == 'a') {
17373                     if (value == 'z'
17374 #ifdef EBCDIC
17375                         && ! non_portable_endpoint
17376 #endif
17377                     ) {
17378                         arg = (FOLD) ? _CC_ALPHA : _CC_LOWER;
17379                         op = POSIXA;
17380                     }
17381                 }
17382             }
17383         }
17384
17385         /* Here, we have changed <op> away from its initial value iff we found
17386          * an optimization */
17387         if (op != END) {
17388
17389             /* Throw away this ANYOF regnode, and emit the calculated one,
17390              * which should correspond to the beginning, not current, state of
17391              * the parse */
17392             const char * cur_parse = RExC_parse;
17393             RExC_parse = (char *)orig_parse;
17394             if ( SIZE_ONLY) {
17395                 if (! LOC) {
17396
17397                     /* To get locale nodes to not use the full ANYOF size would
17398                      * require moving the code above that writes the portions
17399                      * of it that aren't in other nodes to after this point.
17400                      * e.g.  ANYOF_POSIXL_SET */
17401                     RExC_size = orig_size;
17402                 }
17403             }
17404             else {
17405                 RExC_emit = (regnode *)orig_emit;
17406                 if (PL_regkind[op] == POSIXD) {
17407                     if (op == POSIXL) {
17408                         RExC_contains_locale = 1;
17409                     }
17410                     if (invert) {
17411                         op += NPOSIXD - POSIXD;
17412                     }
17413                 }
17414             }
17415
17416             ret = reg_node(pRExC_state, op);
17417
17418             if (PL_regkind[op] == POSIXD || PL_regkind[op] == NPOSIXD) {
17419                 if (! SIZE_ONLY) {
17420                     FLAGS(ret) = arg;
17421                 }
17422                 *flagp |= HASWIDTH|SIMPLE;
17423             }
17424             else if (PL_regkind[op] == EXACT) {
17425                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, 0, value,
17426                                            TRUE /* downgradable to EXACT */
17427                                            );
17428             }
17429
17430             RExC_parse = (char *) cur_parse;
17431
17432             SvREFCNT_dec(posixes);
17433             SvREFCNT_dec(nposixes);
17434             SvREFCNT_dec(simple_posixes);
17435             SvREFCNT_dec(cp_list);
17436             SvREFCNT_dec(cp_foldable_list);
17437             return ret;
17438         }
17439     }
17440
17441     if (SIZE_ONLY)
17442         return ret;
17443     /****** !SIZE_ONLY (Pass 2) AFTER HERE *********/
17444
17445     /* If folding, we calculate all characters that could fold to or from the
17446      * ones already on the list */
17447     if (cp_foldable_list) {
17448         if (FOLD) {
17449             UV start, end;      /* End points of code point ranges */
17450
17451             SV* fold_intersection = NULL;
17452             SV** use_list;
17453
17454             /* Our calculated list will be for Unicode rules.  For locale
17455              * matching, we have to keep a separate list that is consulted at
17456              * runtime only when the locale indicates Unicode rules.  For
17457              * non-locale, we just use the general list */
17458             if (LOC) {
17459                 use_list = &only_utf8_locale_list;
17460             }
17461             else {
17462                 use_list = &cp_list;
17463             }
17464
17465             /* Only the characters in this class that participate in folds need
17466              * be checked.  Get the intersection of this class and all the
17467              * possible characters that are foldable.  This can quickly narrow
17468              * down a large class */
17469             _invlist_intersection(PL_utf8_foldable, cp_foldable_list,
17470                                   &fold_intersection);
17471
17472             /* The folds for all the Latin1 characters are hard-coded into this
17473              * program, but we have to go out to disk to get the others. */
17474             if (invlist_highest(cp_foldable_list) >= 256) {
17475
17476                 /* This is a hash that for a particular fold gives all
17477                  * characters that are involved in it */
17478                 if (! PL_utf8_foldclosures) {
17479                     _load_PL_utf8_foldclosures();
17480                 }
17481             }
17482
17483             /* Now look at the foldable characters in this class individually */
17484             invlist_iterinit(fold_intersection);
17485             while (invlist_iternext(fold_intersection, &start, &end)) {
17486                 UV j;
17487
17488                 /* Look at every character in the range */
17489                 for (j = start; j <= end; j++) {
17490                     U8 foldbuf[UTF8_MAXBYTES_CASE+1];
17491                     STRLEN foldlen;
17492                     SV** listp;
17493
17494                     if (j < 256) {
17495
17496                         if (IS_IN_SOME_FOLD_L1(j)) {
17497
17498                             /* ASCII is always matched; non-ASCII is matched
17499                              * only under Unicode rules (which could happen
17500                              * under /l if the locale is a UTF-8 one */
17501                             if (isASCII(j) || ! DEPENDS_SEMANTICS) {
17502                                 *use_list = add_cp_to_invlist(*use_list,
17503                                                             PL_fold_latin1[j]);
17504                             }
17505                             else {
17506                                 has_upper_latin1_only_utf8_matches
17507                                     = add_cp_to_invlist(
17508                                             has_upper_latin1_only_utf8_matches,
17509                                             PL_fold_latin1[j]);
17510                             }
17511                         }
17512
17513                         if (HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(j)
17514                             && (! isASCII(j) || ! ASCII_FOLD_RESTRICTED))
17515                         {
17516                             add_above_Latin1_folds(pRExC_state,
17517                                                    (U8) j,
17518                                                    use_list);
17519                         }
17520                         continue;
17521                     }
17522
17523                     /* Here is an above Latin1 character.  We don't have the
17524                      * rules hard-coded for it.  First, get its fold.  This is
17525                      * the simple fold, as the multi-character folds have been
17526                      * handled earlier and separated out */
17527                     _to_uni_fold_flags(j, foldbuf, &foldlen,
17528                                                         (ASCII_FOLD_RESTRICTED)
17529                                                         ? FOLD_FLAGS_NOMIX_ASCII
17530                                                         : 0);
17531
17532                     /* Single character fold of above Latin1.  Add everything in
17533                     * its fold closure to the list that this node should match.
17534                     * The fold closures data structure is a hash with the keys
17535                     * being the UTF-8 of every character that is folded to, like
17536                     * 'k', and the values each an array of all code points that
17537                     * fold to its key.  e.g. [ 'k', 'K', KELVIN_SIGN ].
17538                     * Multi-character folds are not included */
17539                     if ((listp = hv_fetch(PL_utf8_foldclosures,
17540                                         (char *) foldbuf, foldlen, FALSE)))
17541                     {
17542                         AV* list = (AV*) *listp;
17543                         IV k;
17544                         for (k = 0; k <= av_tindex_skip_len_mg(list); k++) {
17545                             SV** c_p = av_fetch(list, k, FALSE);
17546                             UV c;
17547                             assert(c_p);
17548
17549                             c = SvUV(*c_p);
17550
17551                             /* /aa doesn't allow folds between ASCII and non- */
17552                             if ((ASCII_FOLD_RESTRICTED
17553                                 && (isASCII(c) != isASCII(j))))
17554                             {
17555                                 continue;
17556                             }
17557
17558                             /* Folds under /l which cross the 255/256 boundary
17559                              * are added to a separate list.  (These are valid
17560                              * only when the locale is UTF-8.) */
17561                             if (c < 256 && LOC) {
17562                                 *use_list = add_cp_to_invlist(*use_list, c);
17563                                 continue;
17564                             }
17565
17566                             if (isASCII(c) || c > 255 || AT_LEAST_UNI_SEMANTICS)
17567                             {
17568                                 cp_list = add_cp_to_invlist(cp_list, c);
17569                             }
17570                             else {
17571                                 /* Similarly folds involving non-ascii Latin1
17572                                 * characters under /d are added to their list */
17573                                 has_upper_latin1_only_utf8_matches
17574                                         = add_cp_to_invlist(
17575                                            has_upper_latin1_only_utf8_matches,
17576                                            c);
17577                             }
17578                         }
17579                     }
17580                 }
17581             }
17582             SvREFCNT_dec_NN(fold_intersection);
17583         }
17584
17585         /* Now that we have finished adding all the folds, there is no reason
17586          * to keep the foldable list separate */
17587         _invlist_union(cp_list, cp_foldable_list, &cp_list);
17588         SvREFCNT_dec_NN(cp_foldable_list);
17589     }
17590
17591     /* And combine the result (if any) with any inversion lists from posix
17592      * classes.  The lists are kept separate up to now because we don't want to
17593      * fold the classes (folding of those is automatically handled by the swash
17594      * fetching code) */
17595     if (simple_posixes) {   /* These are the classes known to be unaffected by
17596                                /a, /aa, and /d */
17597         if (cp_list) {
17598             _invlist_union(cp_list, simple_posixes, &cp_list);
17599             SvREFCNT_dec_NN(simple_posixes);
17600         }
17601         else {
17602             cp_list = simple_posixes;
17603         }
17604     }
17605     if (posixes || nposixes) {
17606
17607         /* We have to adjust /a and /aa */
17608         if (AT_LEAST_ASCII_RESTRICTED) {
17609
17610             /* Under /a and /aa, nothing above ASCII matches these */
17611             if (posixes) {
17612                 _invlist_intersection(posixes,
17613                                     PL_XPosix_ptrs[_CC_ASCII],
17614                                     &posixes);
17615             }
17616
17617             /* Under /a and /aa, everything above ASCII matches these
17618              * complements */
17619             if (nposixes) {
17620                 _invlist_union_complement_2nd(nposixes,
17621                                               PL_XPosix_ptrs[_CC_ASCII],
17622                                               &nposixes);
17623             }
17624         }
17625
17626         if (! DEPENDS_SEMANTICS) {
17627
17628             /* For everything but /d, we can just add the current 'posixes' and
17629              * 'nposixes' to the main list */
17630             if (posixes) {
17631                 if (cp_list) {
17632                     _invlist_union(cp_list, posixes, &cp_list);
17633                     SvREFCNT_dec_NN(posixes);
17634                 }
17635                 else {
17636                     cp_list = posixes;
17637                 }
17638             }
17639             if (nposixes) {
17640                 if (cp_list) {
17641                     _invlist_union(cp_list, nposixes, &cp_list);
17642                     SvREFCNT_dec_NN(nposixes);
17643                 }
17644                 else {
17645                     cp_list = nposixes;
17646                 }
17647             }
17648         }
17649         else {
17650             /* Under /d, things like \w match upper Latin1 characters only if
17651              * the target string is in UTF-8.  But things like \W match all the
17652              * upper Latin1 characters if the target string is not in UTF-8.
17653              *
17654              * Handle the case where there something like \W separately */
17655             if (nposixes) {
17656                 SV* only_non_utf8_list = invlist_clone(PL_UpperLatin1);
17657
17658                 /* A complemented posix class matches all upper Latin1
17659                  * characters if not in UTF-8.  And it matches just certain
17660                  * ones when in UTF-8.  That means those certain ones are
17661                  * matched regardless, so can just be added to the
17662                  * unconditional list */
17663                 if (cp_list) {
17664                     _invlist_union(cp_list, nposixes, &cp_list);
17665                     SvREFCNT_dec_NN(nposixes);
17666                     nposixes = NULL;
17667                 }
17668                 else {
17669                     cp_list = nposixes;
17670                 }
17671
17672                 /* Likewise for 'posixes' */
17673                 _invlist_union(posixes, cp_list, &cp_list);
17674
17675                 /* Likewise for anything else in the range that matched only
17676                  * under UTF-8 */
17677                 if (has_upper_latin1_only_utf8_matches) {
17678                     _invlist_union(cp_list,
17679                                    has_upper_latin1_only_utf8_matches,
17680                                    &cp_list);
17681                     SvREFCNT_dec_NN(has_upper_latin1_only_utf8_matches);
17682                     has_upper_latin1_only_utf8_matches = NULL;
17683                 }
17684
17685                 /* If we don't match all the upper Latin1 characters regardless
17686                  * of UTF-8ness, we have to set a flag to match the rest when
17687                  * not in UTF-8 */
17688                 _invlist_subtract(only_non_utf8_list, cp_list,
17689                                   &only_non_utf8_list);
17690                 if (_invlist_len(only_non_utf8_list) != 0) {
17691                     ANYOF_FLAGS(ret) |= ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER;
17692                 }
17693             }
17694             else {
17695                 /* Here there were no complemented posix classes.  That means
17696                  * the upper Latin1 characters in 'posixes' match only when the
17697                  * target string is in UTF-8.  So we have to add them to the
17698                  * list of those types of code points, while adding the
17699                  * remainder to the unconditional list.
17700                  *
17701                  * First calculate what they are */
17702                 SV* nonascii_but_latin1_properties = NULL;
17703                 _invlist_intersection(posixes, PL_UpperLatin1,
17704                                       &nonascii_but_latin1_properties);
17705
17706                 /* And add them to the final list of such characters. */
17707                 _invlist_union(has_upper_latin1_only_utf8_matches,
17708                                nonascii_but_latin1_properties,
17709                                &has_upper_latin1_only_utf8_matches);
17710
17711                 /* Remove them from what now becomes the unconditional list */
17712                 _invlist_subtract(posixes, nonascii_but_latin1_properties,
17713                                   &posixes);
17714
17715                 /* And add those unconditional ones to the final list */
17716                 if (cp_list) {
17717                     _invlist_union(cp_list, posixes, &cp_list);
17718                     SvREFCNT_dec_NN(posixes);
17719                     posixes = NULL;
17720                 }
17721                 else {
17722                     cp_list = posixes;
17723                 }
17724
17725                 SvREFCNT_dec(nonascii_but_latin1_properties);
17726
17727                 /* Get rid of any characters that we now know are matched
17728                  * unconditionally from the conditional list, which may make
17729                  * that list empty */
17730                 _invlist_subtract(has_upper_latin1_only_utf8_matches,
17731                                   cp_list,
17732                                   &has_upper_latin1_only_utf8_matches);
17733                 if (_invlist_len(has_upper_latin1_only_utf8_matches) == 0) {
17734                     SvREFCNT_dec_NN(has_upper_latin1_only_utf8_matches);
17735                     has_upper_latin1_only_utf8_matches = NULL;
17736                 }
17737             }
17738         }
17739     }
17740
17741     /* And combine the result (if any) with any inversion list from properties.
17742      * The lists are kept separate up to now so that we can distinguish the two
17743      * in regards to matching above-Unicode.  A run-time warning is generated
17744      * if a Unicode property is matched against a non-Unicode code point. But,
17745      * we allow user-defined properties to match anything, without any warning,
17746      * and we also suppress the warning if there is a portion of the character
17747      * class that isn't a Unicode property, and which matches above Unicode, \W
17748      * or [\x{110000}] for example.
17749      * (Note that in this case, unlike the Posix one above, there is no
17750      * <has_upper_latin1_only_utf8_matches>, because having a Unicode property
17751      * forces Unicode semantics */
17752     if (properties) {
17753         if (cp_list) {
17754
17755             /* If it matters to the final outcome, see if a non-property
17756              * component of the class matches above Unicode.  If so, the
17757              * warning gets suppressed.  This is true even if just a single
17758              * such code point is specified, as, though not strictly correct if
17759              * another such code point is matched against, the fact that they
17760              * are using above-Unicode code points indicates they should know
17761              * the issues involved */
17762             if (warn_super) {
17763                 warn_super = ! (invert
17764                                ^ (invlist_highest(cp_list) > PERL_UNICODE_MAX));
17765             }
17766
17767             _invlist_union(properties, cp_list, &cp_list);
17768             SvREFCNT_dec_NN(properties);
17769         }
17770         else {
17771             cp_list = properties;
17772         }
17773
17774         if (warn_super) {
17775             ANYOF_FLAGS(ret)
17776              |= ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER;
17777
17778             /* Because an ANYOF node is the only one that warns, this node
17779              * can't be optimized into something else */
17780             optimizable = FALSE;
17781         }
17782     }
17783
17784     /* Here, we have calculated what code points should be in the character
17785      * class.
17786      *
17787      * Now we can see about various optimizations.  Fold calculation (which we
17788      * did above) needs to take place before inversion.  Otherwise /[^k]/i
17789      * would invert to include K, which under /i would match k, which it
17790      * shouldn't.  Therefore we can't invert folded locale now, as it won't be
17791      * folded until runtime */
17792
17793     /* If we didn't do folding, it's because some information isn't available
17794      * until runtime; set the run-time fold flag for these.  (We don't have to
17795      * worry about properties folding, as that is taken care of by the swash
17796      * fetching).  We know to set the flag if we have a non-NULL list for UTF-8
17797      * locales, or the class matches at least one 0-255 range code point */
17798     if (LOC && FOLD) {
17799
17800         /* Some things on the list might be unconditionally included because of
17801          * other components.  Remove them, and clean up the list if it goes to
17802          * 0 elements */
17803         if (only_utf8_locale_list && cp_list) {
17804             _invlist_subtract(only_utf8_locale_list, cp_list,
17805                               &only_utf8_locale_list);
17806
17807             if (_invlist_len(only_utf8_locale_list) == 0) {
17808                 SvREFCNT_dec_NN(only_utf8_locale_list);
17809                 only_utf8_locale_list = NULL;
17810             }
17811         }
17812         if (only_utf8_locale_list) {
17813             ANYOF_FLAGS(ret)
17814                  |=  ANYOFL_FOLD
17815                     |ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD;
17816         }
17817         else if (cp_list) { /* Look to see if a 0-255 code point is in list */
17818             UV start, end;
17819             invlist_iterinit(cp_list);
17820             if (invlist_iternext(cp_list, &start, &end) && start < 256) {
17821                 ANYOF_FLAGS(ret) |= ANYOFL_FOLD;
17822             }
17823             invlist_iterfinish(cp_list);
17824         }
17825     }
17826     else if (   DEPENDS_SEMANTICS
17827              && (    has_upper_latin1_only_utf8_matches
17828                  || (ANYOF_FLAGS(ret) & ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER)))
17829     {
17830         OP(ret) = ANYOFD;
17831         optimizable = FALSE;
17832     }
17833
17834
17835     /* Optimize inverted simple patterns (e.g. [^a-z]) when everything is known
17836      * at compile time.  Besides not inverting folded locale now, we can't
17837      * invert if there are things such as \w, which aren't known until runtime
17838      * */
17839     if (cp_list
17840         && invert
17841         && OP(ret) != ANYOFD
17842         && ! (ANYOF_FLAGS(ret) & (ANYOF_LOCALE_FLAGS))
17843         && ! HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
17844     {
17845         _invlist_invert(cp_list);
17846
17847         /* Any swash can't be used as-is, because we've inverted things */
17848         if (swash) {
17849             SvREFCNT_dec_NN(swash);
17850             swash = NULL;
17851         }
17852
17853         /* Clear the invert flag since have just done it here */
17854         invert = FALSE;
17855     }
17856
17857     if (ret_invlist) {
17858         assert(cp_list);
17859
17860         *ret_invlist = cp_list;
17861         SvREFCNT_dec(swash);
17862
17863         /* Discard the generated node */
17864         if (SIZE_ONLY) {
17865             RExC_size = orig_size;
17866         }
17867         else {
17868             RExC_emit = orig_emit;
17869         }
17870         return orig_emit;
17871     }
17872
17873     /* Some character classes are equivalent to other nodes.  Such nodes take
17874      * up less room and generally fewer operations to execute than ANYOF nodes.
17875      * Above, we checked for and optimized into some such equivalents for
17876      * certain common classes that are easy to test.  Getting to this point in
17877      * the code means that the class didn't get optimized there.  Since this
17878      * code is only executed in Pass 2, it is too late to save space--it has
17879      * been allocated in Pass 1, and currently isn't given back.  But turning
17880      * things into an EXACTish node can allow the optimizer to join it to any
17881      * adjacent such nodes.  And if the class is equivalent to things like /./,
17882      * expensive run-time swashes can be avoided.  Now that we have more
17883      * complete information, we can find things necessarily missed by the
17884      * earlier code.  Another possible "optimization" that isn't done is that
17885      * something like [Ee] could be changed into an EXACTFU.  khw tried this
17886      * and found that the ANYOF is faster, including for code points not in the
17887      * bitmap.  This still might make sense to do, provided it got joined with
17888      * an adjacent node(s) to create a longer EXACTFU one.  This could be
17889      * accomplished by creating a pseudo ANYOF_EXACTFU node type that the join
17890      * routine would know is joinable.  If that didn't happen, the node type
17891      * could then be made a straight ANYOF */
17892
17893     if (optimizable && cp_list && ! invert) {
17894         UV start, end;
17895         U8 op = END;  /* The optimzation node-type */
17896         int posix_class = -1;   /* Illegal value */
17897         const char * cur_parse= RExC_parse;
17898
17899         invlist_iterinit(cp_list);
17900         if (! invlist_iternext(cp_list, &start, &end)) {
17901
17902             /* Here, the list is empty.  This happens, for example, when a
17903              * Unicode property that doesn't match anything is the only element
17904              * in the character class (perluniprops.pod notes such properties).
17905              * */
17906             op = OPFAIL;
17907             *flagp |= HASWIDTH|SIMPLE;
17908         }
17909         else if (start == end) {    /* The range is a single code point */
17910             if (! invlist_iternext(cp_list, &start, &end)
17911
17912                     /* Don't do this optimization if it would require changing
17913                      * the pattern to UTF-8 */
17914                 && (start < 256 || UTF))
17915             {
17916                 /* Here, the list contains a single code point.  Can optimize
17917                  * into an EXACTish node */
17918
17919                 value = start;
17920
17921                 if (! FOLD) {
17922                     op = (LOC)
17923                          ? EXACTL
17924                          : EXACT;
17925                 }
17926                 else if (LOC) {
17927
17928                     /* A locale node under folding with one code point can be
17929                      * an EXACTFL, as its fold won't be calculated until
17930                      * runtime */
17931                     op = EXACTFL;
17932                 }
17933                 else {
17934
17935                     /* Here, we are generally folding, but there is only one
17936                      * code point to match.  If we have to, we use an EXACT
17937                      * node, but it would be better for joining with adjacent
17938                      * nodes in the optimization pass if we used the same
17939                      * EXACTFish node that any such are likely to be.  We can
17940                      * do this iff the code point doesn't participate in any
17941                      * folds.  For example, an EXACTF of a colon is the same as
17942                      * an EXACT one, since nothing folds to or from a colon. */
17943                     if (value < 256) {
17944                         if (IS_IN_SOME_FOLD_L1(value)) {
17945                             op = EXACT;
17946                         }
17947                     }
17948                     else {
17949                         if (_invlist_contains_cp(PL_utf8_foldable, value)) {
17950                             op = EXACT;
17951                         }
17952                     }
17953
17954                     /* If we haven't found the node type, above, it means we
17955                      * can use the prevailing one */
17956                     if (op == END) {
17957                         op = compute_EXACTish(pRExC_state);
17958                     }
17959                 }
17960             }
17961         }   /* End of first range contains just a single code point */
17962         else if (start == 0) {
17963             if (end == UV_MAX) {
17964                 op = SANY;
17965                 *flagp |= HASWIDTH|SIMPLE;
17966                 MARK_NAUGHTY(1);
17967             }
17968             else if (end == '\n' - 1
17969                     && invlist_iternext(cp_list, &start, &end)
17970                     && start == '\n' + 1 && end == UV_MAX)
17971             {
17972                 op = REG_ANY;
17973                 *flagp |= HASWIDTH|SIMPLE;
17974                 MARK_NAUGHTY(1);
17975             }
17976         }
17977         invlist_iterfinish(cp_list);
17978
17979         if (op == END) {
17980             const UV cp_list_len = _invlist_len(cp_list);
17981             const UV* cp_list_array = invlist_array(cp_list);
17982
17983             /* Here, didn't find an optimization.  See if this matches any of
17984              * the POSIX classes.  These run slightly faster for above-Unicode
17985              * code points, so don't bother with POSIXA ones nor the 2 that
17986              * have no above-Unicode matches.  We can avoid these checks unless
17987              * the ANYOF matches at least as high as the lowest POSIX one
17988              * (which was manually found to be \v.  The actual code point may
17989              * increase in later Unicode releases, if a higher code point is
17990              * assigned to be \v, but this code will never break.  It would
17991              * just mean we could execute the checks for posix optimizations
17992              * unnecessarily) */
17993
17994             if (cp_list_array[cp_list_len-1] > 0x2029) {
17995                 for (posix_class = 0;
17996                      posix_class <= _HIGHEST_REGCOMP_DOT_H_SYNC;
17997                      posix_class++)
17998                 {
17999                     int try_inverted;
18000                     if (posix_class == _CC_ASCII || posix_class == _CC_CNTRL) {
18001                         continue;
18002                     }
18003                     for (try_inverted = 0; try_inverted < 2; try_inverted++) {
18004
18005                         /* Check if matches normal or inverted */
18006                         if (_invlistEQ(cp_list,
18007                                        PL_XPosix_ptrs[posix_class],
18008                                        try_inverted))
18009                         {
18010                             op = (try_inverted)
18011                                  ? NPOSIXU
18012                                  : POSIXU;
18013                             *flagp |= HASWIDTH|SIMPLE;
18014                             goto found_posix;
18015                         }
18016                     }
18017                 }
18018               found_posix: ;
18019             }
18020         }
18021
18022         if (op != END) {
18023             RExC_parse = (char *)orig_parse;
18024             RExC_emit = (regnode *)orig_emit;
18025
18026             if (regarglen[op]) {
18027                 ret = reganode(pRExC_state, op, 0);
18028             } else {
18029                 ret = reg_node(pRExC_state, op);
18030             }
18031
18032             RExC_parse = (char *)cur_parse;
18033
18034             if (PL_regkind[op] == EXACT) {
18035                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, 0, value,
18036                                            TRUE /* downgradable to EXACT */
18037                                           );
18038             }
18039             else if (PL_regkind[op] == POSIXD || PL_regkind[op] == NPOSIXD) {
18040                 FLAGS(ret) = posix_class;
18041             }
18042
18043             SvREFCNT_dec_NN(cp_list);
18044             return ret;
18045         }
18046     }
18047
18048     /* Here, <cp_list> contains all the code points we can determine at
18049      * compile time that match under all conditions.  Go through it, and
18050      * for things that belong in the bitmap, put them there, and delete from
18051      * <cp_list>.  While we are at it, see if everything above 255 is in the
18052      * list, and if so, set a flag to speed up execution */
18053
18054     populate_ANYOF_from_invlist(ret, &cp_list);
18055
18056     if (invert) {
18057         ANYOF_FLAGS(ret) |= ANYOF_INVERT;
18058     }
18059
18060     /* Here, the bitmap has been populated with all the Latin1 code points that
18061      * always match.  Can now add to the overall list those that match only
18062      * when the target string is UTF-8 (<has_upper_latin1_only_utf8_matches>).
18063      * */
18064     if (has_upper_latin1_only_utf8_matches) {
18065         if (cp_list) {
18066             _invlist_union(cp_list,
18067                            has_upper_latin1_only_utf8_matches,
18068                            &cp_list);
18069             SvREFCNT_dec_NN(has_upper_latin1_only_utf8_matches);
18070         }
18071         else {
18072             cp_list = has_upper_latin1_only_utf8_matches;
18073         }
18074         ANYOF_FLAGS(ret) |= ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP;
18075     }
18076
18077     /* If there is a swash and more than one element, we can't use the swash in
18078      * the optimization below. */
18079     if (swash && element_count > 1) {
18080         SvREFCNT_dec_NN(swash);
18081         swash = NULL;
18082     }
18083
18084     /* Note that the optimization of using 'swash' if it is the only thing in
18085      * the class doesn't have us change swash at all, so it can include things
18086      * that are also in the bitmap; otherwise we have purposely deleted that
18087      * duplicate information */
18088     set_ANYOF_arg(pRExC_state, ret, cp_list,
18089                   (HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
18090                    ? listsv : NULL,
18091                   only_utf8_locale_list,
18092                   swash, has_user_defined_property);
18093
18094     *flagp |= HASWIDTH|SIMPLE;
18095
18096     if (ANYOF_FLAGS(ret) & ANYOF_LOCALE_FLAGS) {
18097         RExC_contains_locale = 1;
18098     }
18099
18100     return ret;
18101 }
18102
18103 #undef HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION
18104
18105 STATIC void
18106 S_set_ANYOF_arg(pTHX_ RExC_state_t* const pRExC_state,
18107                 regnode* const node,
18108                 SV* const cp_list,
18109                 SV* const runtime_defns,
18110                 SV* const only_utf8_locale_list,
18111                 SV* const swash,
18112                 const bool has_user_defined_property)
18113 {
18114     /* Sets the arg field of an ANYOF-type node 'node', using information about
18115      * the node passed-in.  If there is nothing outside the node's bitmap, the
18116      * arg is set to ANYOF_ONLY_HAS_BITMAP.  Otherwise, it sets the argument to
18117      * the count returned by add_data(), having allocated and stored an array,
18118      * av, that that count references, as follows:
18119      *  av[0] stores the character class description in its textual form.
18120      *        This is used later (regexec.c:Perl_regclass_swash()) to
18121      *        initialize the appropriate swash, and is also useful for dumping
18122      *        the regnode.  This is set to &PL_sv_undef if the textual
18123      *        description is not needed at run-time (as happens if the other
18124      *        elements completely define the class)
18125      *  av[1] if &PL_sv_undef, is a placeholder to later contain the swash
18126      *        computed from av[0].  But if no further computation need be done,
18127      *        the swash is stored here now (and av[0] is &PL_sv_undef).
18128      *  av[2] stores the inversion list of code points that match only if the
18129      *        current locale is UTF-8
18130      *  av[3] stores the cp_list inversion list for use in addition or instead
18131      *        of av[0]; used only if cp_list exists and av[1] is &PL_sv_undef.
18132      *        (Otherwise everything needed is already in av[0] and av[1])
18133      *  av[4] is set if any component of the class is from a user-defined
18134      *        property; used only if av[3] exists */
18135
18136     UV n;
18137
18138     PERL_ARGS_ASSERT_SET_ANYOF_ARG;
18139
18140     if (! cp_list && ! runtime_defns && ! only_utf8_locale_list) {
18141         assert(! (ANYOF_FLAGS(node)
18142                 & ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP));
18143         ARG_SET(node, ANYOF_ONLY_HAS_BITMAP);
18144     }
18145     else {
18146         AV * const av = newAV();
18147         SV *rv;
18148
18149         av_store(av, 0, (runtime_defns)
18150                         ? SvREFCNT_inc(runtime_defns) : &PL_sv_undef);
18151         if (swash) {
18152             assert(cp_list);
18153             av_store(av, 1, swash);
18154             SvREFCNT_dec_NN(cp_list);
18155         }
18156         else {
18157             av_store(av, 1, &PL_sv_undef);
18158             if (cp_list) {
18159                 av_store(av, 3, cp_list);
18160                 av_store(av, 4, newSVuv(has_user_defined_property));
18161             }
18162         }
18163
18164         if (only_utf8_locale_list) {
18165             av_store(av, 2, only_utf8_locale_list);
18166         }
18167         else {
18168             av_store(av, 2, &PL_sv_undef);
18169         }
18170
18171         rv = newRV_noinc(MUTABLE_SV(av));
18172         n = add_data(pRExC_state, STR_WITH_LEN("s"));
18173         RExC_rxi->data->data[n] = (void*)rv;
18174         ARG_SET(node, n);
18175     }
18176 }
18177
18178 #if !defined(PERL_IN_XSUB_RE) || defined(PLUGGABLE_RE_EXTENSION)
18179 SV *
18180 Perl__get_regclass_nonbitmap_data(pTHX_ const regexp *prog,
18181                                         const regnode* node,
18182                                         bool doinit,
18183                                         SV** listsvp,
18184                                         SV** only_utf8_locale_ptr,
18185                                         SV** output_invlist)
18186
18187 {
18188     /* For internal core use only.
18189      * Returns the swash for the input 'node' in the regex 'prog'.
18190      * If <doinit> is 'true', will attempt to create the swash if not already
18191      *    done.
18192      * If <listsvp> is non-null, will return the printable contents of the
18193      *    swash.  This can be used to get debugging information even before the
18194      *    swash exists, by calling this function with 'doinit' set to false, in
18195      *    which case the components that will be used to eventually create the
18196      *    swash are returned  (in a printable form).
18197      * If <only_utf8_locale_ptr> is not NULL, it is where this routine is to
18198      *    store an inversion list of code points that should match only if the
18199      *    execution-time locale is a UTF-8 one.
18200      * If <output_invlist> is not NULL, it is where this routine is to store an
18201      *    inversion list of the code points that would be instead returned in
18202      *    <listsvp> if this were NULL.  Thus, what gets output in <listsvp>
18203      *    when this parameter is used, is just the non-code point data that
18204      *    will go into creating the swash.  This currently should be just
18205      *    user-defined properties whose definitions were not known at compile
18206      *    time.  Using this parameter allows for easier manipulation of the
18207      *    swash's data by the caller.  It is illegal to call this function with
18208      *    this parameter set, but not <listsvp>
18209      *
18210      * Tied intimately to how S_set_ANYOF_arg sets up the data structure.  Note
18211      * that, in spite of this function's name, the swash it returns may include
18212      * the bitmap data as well */
18213
18214     SV *sw  = NULL;
18215     SV *si  = NULL;         /* Input swash initialization string */
18216     SV* invlist = NULL;
18217
18218     RXi_GET_DECL(prog,progi);
18219     const struct reg_data * const data = prog ? progi->data : NULL;
18220
18221     PERL_ARGS_ASSERT__GET_REGCLASS_NONBITMAP_DATA;
18222     assert(! output_invlist || listsvp);
18223
18224     if (data && data->count) {
18225         const U32 n = ARG(node);
18226
18227         if (data->what[n] == 's') {
18228             SV * const rv = MUTABLE_SV(data->data[n]);
18229             AV * const av = MUTABLE_AV(SvRV(rv));
18230             SV **const ary = AvARRAY(av);
18231             U8 swash_init_flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;
18232
18233             si = *ary;  /* ary[0] = the string to initialize the swash with */
18234
18235             if (av_tindex_skip_len_mg(av) >= 2) {
18236                 if (only_utf8_locale_ptr
18237                     && ary[2]
18238                     && ary[2] != &PL_sv_undef)
18239                 {
18240                     *only_utf8_locale_ptr = ary[2];
18241                 }
18242                 else {
18243                     assert(only_utf8_locale_ptr);
18244                     *only_utf8_locale_ptr = NULL;
18245                 }
18246
18247                 /* Elements 3 and 4 are either both present or both absent. [3]
18248                  * is any inversion list generated at compile time; [4]
18249                  * indicates if that inversion list has any user-defined
18250                  * properties in it. */
18251                 if (av_tindex_skip_len_mg(av) >= 3) {
18252                     invlist = ary[3];
18253                     if (SvUV(ary[4])) {
18254                         swash_init_flags |= _CORE_SWASH_INIT_USER_DEFINED_PROPERTY;
18255                     }
18256                 }
18257                 else {
18258                     invlist = NULL;
18259                 }
18260             }
18261
18262             /* Element [1] is reserved for the set-up swash.  If already there,
18263              * return it; if not, create it and store it there */
18264             if (ary[1] && SvROK(ary[1])) {
18265                 sw = ary[1];
18266             }
18267             else if (doinit && ((si && si != &PL_sv_undef)
18268                                  || (invlist && invlist != &PL_sv_undef))) {
18269                 assert(si);
18270                 sw = _core_swash_init("utf8", /* the utf8 package */
18271                                       "", /* nameless */
18272                                       si,
18273                                       1, /* binary */
18274                                       0, /* not from tr/// */
18275                                       invlist,
18276                                       &swash_init_flags);
18277                 (void)av_store(av, 1, sw);
18278             }
18279         }
18280     }
18281
18282     /* If requested, return a printable version of what this swash matches */
18283     if (listsvp) {
18284         SV* matches_string = NULL;
18285
18286         /* The swash should be used, if possible, to get the data, as it
18287          * contains the resolved data.  But this function can be called at
18288          * compile-time, before everything gets resolved, in which case we
18289          * return the currently best available information, which is the string
18290          * that will eventually be used to do that resolving, 'si' */
18291         if ((! sw || (invlist = _get_swash_invlist(sw)) == NULL)
18292             && (si && si != &PL_sv_undef))
18293         {
18294             /* Here, we only have 'si' (and possibly some passed-in data in
18295              * 'invlist', which is handled below)  If the caller only wants
18296              * 'si', use that.  */
18297             if (! output_invlist) {
18298                 matches_string = newSVsv(si);
18299             }
18300             else {
18301                 /* But if the caller wants an inversion list of the node, we
18302                  * need to parse 'si' and place as much as possible in the
18303                  * desired output inversion list, making 'matches_string' only
18304                  * contain the currently unresolvable things */
18305                 const char *si_string = SvPVX(si);
18306                 STRLEN remaining = SvCUR(si);
18307                 UV prev_cp = 0;
18308                 U8 count = 0;
18309
18310                 /* Ignore everything before the first new-line */
18311                 while (*si_string != '\n' && remaining > 0) {
18312                     si_string++;
18313                     remaining--;
18314                 }
18315                 assert(remaining > 0);
18316
18317                 si_string++;
18318                 remaining--;
18319
18320                 while (remaining > 0) {
18321
18322                     /* The data consists of just strings defining user-defined
18323                      * property names, but in prior incarnations, and perhaps
18324                      * somehow from pluggable regex engines, it could still
18325                      * hold hex code point definitions.  Each component of a
18326                      * range would be separated by a tab, and each range by a
18327                      * new-line.  If these are found, instead add them to the
18328                      * inversion list */
18329                     I32 grok_flags =  PERL_SCAN_SILENT_ILLDIGIT
18330                                      |PERL_SCAN_SILENT_NON_PORTABLE;
18331                     STRLEN len = remaining;
18332                     UV cp = grok_hex(si_string, &len, &grok_flags, NULL);
18333
18334                     /* If the hex decode routine found something, it should go
18335                      * up to the next \n */
18336                     if (   *(si_string + len) == '\n') {
18337                         if (count) {    /* 2nd code point on line */
18338                             *output_invlist = _add_range_to_invlist(*output_invlist, prev_cp, cp);
18339                         }
18340                         else {
18341                             *output_invlist = add_cp_to_invlist(*output_invlist, cp);
18342                         }
18343                         count = 0;
18344                         goto prepare_for_next_iteration;
18345                     }
18346
18347                     /* If the hex decode was instead for the lower range limit,
18348                      * save it, and go parse the upper range limit */
18349                     if (*(si_string + len) == '\t') {
18350                         assert(count == 0);
18351
18352                         prev_cp = cp;
18353                         count = 1;
18354                       prepare_for_next_iteration:
18355                         si_string += len + 1;
18356                         remaining -= len + 1;
18357                         continue;
18358                     }
18359
18360                     /* Here, didn't find a legal hex number.  Just add it from
18361                      * here to the next \n */
18362
18363                     remaining -= len;
18364                     while (*(si_string + len) != '\n' && remaining > 0) {
18365                         remaining--;
18366                         len++;
18367                     }
18368                     if (*(si_string + len) == '\n') {
18369                         len++;
18370                         remaining--;
18371                     }
18372                     if (matches_string) {
18373                         sv_catpvn(matches_string, si_string, len - 1);
18374                     }
18375                     else {
18376                         matches_string = newSVpvn(si_string, len - 1);
18377                     }
18378                     si_string += len;
18379                     sv_catpvs(matches_string, " ");
18380                 } /* end of loop through the text */
18381
18382                 assert(matches_string);
18383                 if (SvCUR(matches_string)) {  /* Get rid of trailing blank */
18384                     SvCUR_set(matches_string, SvCUR(matches_string) - 1);
18385                 }
18386             } /* end of has an 'si' but no swash */
18387         }
18388
18389         /* If we have a swash in place, its equivalent inversion list was above
18390          * placed into 'invlist'.  If not, this variable may contain a stored
18391          * inversion list which is information beyond what is in 'si' */
18392         if (invlist) {
18393
18394             /* Again, if the caller doesn't want the output inversion list, put
18395              * everything in 'matches-string' */
18396             if (! output_invlist) {
18397                 if ( ! matches_string) {
18398                     matches_string = newSVpvs("\n");
18399                 }
18400                 sv_catsv(matches_string, invlist_contents(invlist,
18401                                                   TRUE /* traditional style */
18402                                                   ));
18403             }
18404             else if (! *output_invlist) {
18405                 *output_invlist = invlist_clone(invlist);
18406             }
18407             else {
18408                 _invlist_union(*output_invlist, invlist, output_invlist);
18409             }
18410         }
18411
18412         *listsvp = matches_string;
18413     }
18414
18415     return sw;
18416 }
18417 #endif /* !defined(PERL_IN_XSUB_RE) || defined(PLUGGABLE_RE_EXTENSION) */
18418
18419 /* reg_skipcomment()
18420
18421    Absorbs an /x style # comment from the input stream,
18422    returning a pointer to the first character beyond the comment, or if the
18423    comment terminates the pattern without anything following it, this returns
18424    one past the final character of the pattern (in other words, RExC_end) and
18425    sets the REG_RUN_ON_COMMENT_SEEN flag.
18426
18427    Note it's the callers responsibility to ensure that we are
18428    actually in /x mode
18429
18430 */
18431
18432 PERL_STATIC_INLINE char*
18433 S_reg_skipcomment(RExC_state_t *pRExC_state, char* p)
18434 {
18435     PERL_ARGS_ASSERT_REG_SKIPCOMMENT;
18436
18437     assert(*p == '#');
18438
18439     while (p < RExC_end) {
18440         if (*(++p) == '\n') {
18441             return p+1;
18442         }
18443     }
18444
18445     /* we ran off the end of the pattern without ending the comment, so we have
18446      * to add an \n when wrapping */
18447     RExC_seen |= REG_RUN_ON_COMMENT_SEEN;
18448     return p;
18449 }
18450
18451 STATIC void
18452 S_skip_to_be_ignored_text(pTHX_ RExC_state_t *pRExC_state,
18453                                 char ** p,
18454                                 const bool force_to_xmod
18455                          )
18456 {
18457     /* If the text at the current parse position '*p' is a '(?#...)' comment,
18458      * or if we are under /x or 'force_to_xmod' is TRUE, and the text at '*p'
18459      * is /x whitespace, advance '*p' so that on exit it points to the first
18460      * byte past all such white space and comments */
18461
18462     const bool use_xmod = force_to_xmod || (RExC_flags & RXf_PMf_EXTENDED);
18463
18464     PERL_ARGS_ASSERT_SKIP_TO_BE_IGNORED_TEXT;
18465
18466     assert( ! UTF || UTF8_IS_INVARIANT(**p) || UTF8_IS_START(**p));
18467
18468     for (;;) {
18469         if (RExC_end - (*p) >= 3
18470             && *(*p)     == '('
18471             && *(*p + 1) == '?'
18472             && *(*p + 2) == '#')
18473         {
18474             while (*(*p) != ')') {
18475                 if ((*p) == RExC_end)
18476                     FAIL("Sequence (?#... not terminated");
18477                 (*p)++;
18478             }
18479             (*p)++;
18480             continue;
18481         }
18482
18483         if (use_xmod) {
18484             const char * save_p = *p;
18485             while ((*p) < RExC_end) {
18486                 STRLEN len;
18487                 if ((len = is_PATWS_safe((*p), RExC_end, UTF))) {
18488                     (*p) += len;
18489                 }
18490                 else if (*(*p) == '#') {
18491                     (*p) = reg_skipcomment(pRExC_state, (*p));
18492                 }
18493                 else {
18494                     break;
18495                 }
18496             }
18497             if (*p != save_p) {
18498                 continue;
18499             }
18500         }
18501
18502         break;
18503     }
18504
18505     return;
18506 }
18507
18508 /* nextchar()
18509
18510    Advances the parse position by one byte, unless that byte is the beginning
18511    of a '(?#...)' style comment, or is /x whitespace and /x is in effect.  In
18512    those two cases, the parse position is advanced beyond all such comments and
18513    white space.
18514
18515    This is the UTF, (?#...), and /x friendly way of saying RExC_parse++.
18516 */
18517
18518 STATIC void
18519 S_nextchar(pTHX_ RExC_state_t *pRExC_state)
18520 {
18521     PERL_ARGS_ASSERT_NEXTCHAR;
18522
18523     if (RExC_parse < RExC_end) {
18524         assert(   ! UTF
18525                || UTF8_IS_INVARIANT(*RExC_parse)
18526                || UTF8_IS_START(*RExC_parse));
18527
18528         RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
18529
18530         skip_to_be_ignored_text(pRExC_state, &RExC_parse,
18531                                 FALSE /* Don't force /x */ );
18532     }
18533 }
18534
18535 STATIC regnode *
18536 S_regnode_guts(pTHX_ RExC_state_t *pRExC_state, const U8 op, const STRLEN extra_size, const char* const name)
18537 {
18538     /* Allocate a regnode for 'op' and returns it, with 'extra_size' extra
18539      * space.  In pass1, it aligns and increments RExC_size; in pass2,
18540      * RExC_emit */
18541
18542     regnode * const ret = RExC_emit;
18543     GET_RE_DEBUG_FLAGS_DECL;
18544
18545     PERL_ARGS_ASSERT_REGNODE_GUTS;
18546
18547     assert(extra_size >= regarglen[op]);
18548
18549     if (SIZE_ONLY) {
18550         SIZE_ALIGN(RExC_size);
18551         RExC_size += 1 + extra_size;
18552         return(ret);
18553     }
18554     if (RExC_emit >= RExC_emit_bound)
18555         Perl_croak(aTHX_ "panic: reg_node overrun trying to emit %d, %p>=%p",
18556                    op, (void*)RExC_emit, (void*)RExC_emit_bound);
18557
18558     NODE_ALIGN_FILL(ret);
18559 #ifndef RE_TRACK_PATTERN_OFFSETS
18560     PERL_UNUSED_ARG(name);
18561 #else
18562     if (RExC_offsets) {         /* MJD */
18563         MJD_OFFSET_DEBUG(
18564               ("%s:%d: (op %s) %s %" UVuf " (len %" UVuf ") (max %" UVuf ").\n",
18565               name, __LINE__,
18566               PL_reg_name[op],
18567               (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0]
18568                 ? "Overwriting end of array!\n" : "OK",
18569               (UV)(RExC_emit - RExC_emit_start),
18570               (UV)(RExC_parse - RExC_start),
18571               (UV)RExC_offsets[0]));
18572         Set_Node_Offset(RExC_emit, RExC_parse + (op == END));
18573     }
18574 #endif
18575     return(ret);
18576 }
18577
18578 /*
18579 - reg_node - emit a node
18580 */
18581 STATIC regnode *                        /* Location. */
18582 S_reg_node(pTHX_ RExC_state_t *pRExC_state, U8 op)
18583 {
18584     regnode * const ret = regnode_guts(pRExC_state, op, regarglen[op], "reg_node");
18585
18586     PERL_ARGS_ASSERT_REG_NODE;
18587
18588     assert(regarglen[op] == 0);
18589
18590     if (PASS2) {
18591         regnode *ptr = ret;
18592         FILL_ADVANCE_NODE(ptr, op);
18593         RExC_emit = ptr;
18594     }
18595     return(ret);
18596 }
18597
18598 /*
18599 - reganode - emit a node with an argument
18600 */
18601 STATIC regnode *                        /* Location. */
18602 S_reganode(pTHX_ RExC_state_t *pRExC_state, U8 op, U32 arg)
18603 {
18604     regnode * const ret = regnode_guts(pRExC_state, op, regarglen[op], "reganode");
18605
18606     PERL_ARGS_ASSERT_REGANODE;
18607
18608     assert(regarglen[op] == 1);
18609
18610     if (PASS2) {
18611         regnode *ptr = ret;
18612         FILL_ADVANCE_NODE_ARG(ptr, op, arg);
18613         RExC_emit = ptr;
18614     }
18615     return(ret);
18616 }
18617
18618 STATIC regnode *
18619 S_reg2Lanode(pTHX_ RExC_state_t *pRExC_state, const U8 op, const U32 arg1, const I32 arg2)
18620 {
18621     /* emit a node with U32 and I32 arguments */
18622
18623     regnode * const ret = regnode_guts(pRExC_state, op, regarglen[op], "reg2Lanode");
18624
18625     PERL_ARGS_ASSERT_REG2LANODE;
18626
18627     assert(regarglen[op] == 2);
18628
18629     if (PASS2) {
18630         regnode *ptr = ret;
18631         FILL_ADVANCE_NODE_2L_ARG(ptr, op, arg1, arg2);
18632         RExC_emit = ptr;
18633     }
18634     return(ret);
18635 }
18636
18637 /*
18638 - reginsert - insert an operator in front of already-emitted operand
18639 *
18640 * Means relocating the operand.
18641 *
18642 * IMPORTANT NOTE - it is the *callers* responsibility to correctly
18643 * set up NEXT_OFF() of the inserted node if needed. Something like this:
18644 *
18645 * reginsert(pRExC, OPFAIL, orig_emit, depth+1);
18646 * if (PASS2)
18647 *     NEXT_OFF(orig_emit) = regarglen[OPFAIL] + NODE_STEP_REGNODE;
18648 *
18649 * ALSO NOTE - operand->flags will be set to 0 as well.
18650 */
18651 STATIC void
18652 S_reginsert(pTHX_ RExC_state_t *pRExC_state, U8 op, regnode *operand, U32 depth)
18653 {
18654     regnode *src;
18655     regnode *dst;
18656     regnode *place;
18657     const int offset = regarglen[(U8)op];
18658     const int size = NODE_STEP_REGNODE + offset;
18659     GET_RE_DEBUG_FLAGS_DECL;
18660
18661     PERL_ARGS_ASSERT_REGINSERT;
18662     PERL_UNUSED_CONTEXT;
18663     PERL_UNUSED_ARG(depth);
18664 /* (PL_regkind[(U8)op] == CURLY ? EXTRA_STEP_2ARGS : 0); */
18665     DEBUG_PARSE_FMT("inst"," - %s",PL_reg_name[op]);
18666     if (SIZE_ONLY) {
18667         RExC_size += size;
18668         return;
18669     }
18670     assert(!RExC_study_started); /* I believe we should never use reginsert once we have started
18671                                     studying. If this is wrong then we need to adjust RExC_recurse
18672                                     below like we do with RExC_open_parens/RExC_close_parens. */
18673     src = RExC_emit;
18674     RExC_emit += size;
18675     dst = RExC_emit;
18676     if (RExC_open_parens) {
18677         int paren;
18678         /*DEBUG_PARSE_FMT("inst"," - %" IVdf, (IV)RExC_npar);*/
18679         /* remember that RExC_npar is rex->nparens + 1,
18680          * iow it is 1 more than the number of parens seen in
18681          * the pattern so far. */
18682         for ( paren=0 ; paren < RExC_npar ; paren++ ) {
18683             /* note, RExC_open_parens[0] is the start of the
18684              * regex, it can't move. RExC_close_parens[0] is the end
18685              * of the regex, it *can* move. */
18686             if ( paren && RExC_open_parens[paren] >= operand ) {
18687                 /*DEBUG_PARSE_FMT("open"," - %d",size);*/
18688                 RExC_open_parens[paren] += size;
18689             } else {
18690                 /*DEBUG_PARSE_FMT("open"," - %s","ok");*/
18691             }
18692             if ( RExC_close_parens[paren] >= operand ) {
18693                 /*DEBUG_PARSE_FMT("close"," - %d",size);*/
18694                 RExC_close_parens[paren] += size;
18695             } else {
18696                 /*DEBUG_PARSE_FMT("close"," - %s","ok");*/
18697             }
18698         }
18699     }
18700     if (RExC_end_op)
18701         RExC_end_op += size;
18702
18703     while (src > operand) {
18704         StructCopy(--src, --dst, regnode);
18705 #ifdef RE_TRACK_PATTERN_OFFSETS
18706         if (RExC_offsets) {     /* MJD 20010112 */
18707             MJD_OFFSET_DEBUG(
18708                  ("%s(%d): (op %s) %s copy %" UVuf " -> %" UVuf " (max %" UVuf ").\n",
18709                   "reg_insert",
18710                   __LINE__,
18711                   PL_reg_name[op],
18712                   (UV)(dst - RExC_emit_start) > RExC_offsets[0]
18713                     ? "Overwriting end of array!\n" : "OK",
18714                   (UV)(src - RExC_emit_start),
18715                   (UV)(dst - RExC_emit_start),
18716                   (UV)RExC_offsets[0]));
18717             Set_Node_Offset_To_R(dst-RExC_emit_start, Node_Offset(src));
18718             Set_Node_Length_To_R(dst-RExC_emit_start, Node_Length(src));
18719         }
18720 #endif
18721     }
18722
18723     place = operand;            /* Op node, where operand used to be. */
18724 #ifdef RE_TRACK_PATTERN_OFFSETS
18725     if (RExC_offsets) {         /* MJD */
18726         MJD_OFFSET_DEBUG(
18727               ("%s(%d): (op %s) %s %" UVuf " <- %" UVuf " (max %" UVuf ").\n",
18728               "reginsert",
18729               __LINE__,
18730               PL_reg_name[op],
18731               (UV)(place - RExC_emit_start) > RExC_offsets[0]
18732               ? "Overwriting end of array!\n" : "OK",
18733               (UV)(place - RExC_emit_start),
18734               (UV)(RExC_parse - RExC_start),
18735               (UV)RExC_offsets[0]));
18736         Set_Node_Offset(place, RExC_parse);
18737         Set_Node_Length(place, 1);
18738     }
18739 #endif
18740     src = NEXTOPER(place);
18741     place->flags = 0;
18742     FILL_ADVANCE_NODE(place, op);
18743     Zero(src, offset, regnode);
18744 }
18745
18746 /*
18747 - regtail - set the next-pointer at the end of a node chain of p to val.
18748 - SEE ALSO: regtail_study
18749 */
18750 STATIC void
18751 S_regtail(pTHX_ RExC_state_t * pRExC_state,
18752                 const regnode * const p,
18753                 const regnode * const val,
18754                 const U32 depth)
18755 {
18756     regnode *scan;
18757     GET_RE_DEBUG_FLAGS_DECL;
18758
18759     PERL_ARGS_ASSERT_REGTAIL;
18760 #ifndef DEBUGGING
18761     PERL_UNUSED_ARG(depth);
18762 #endif
18763
18764     if (SIZE_ONLY)
18765         return;
18766
18767     /* Find last node. */
18768     scan = (regnode *) p;
18769     for (;;) {
18770         regnode * const temp = regnext(scan);
18771         DEBUG_PARSE_r({
18772             DEBUG_PARSE_MSG((scan==p ? "tail" : ""));
18773             regprop(RExC_rx, RExC_mysv, scan, NULL, pRExC_state);
18774             Perl_re_printf( aTHX_  "~ %s (%d) %s %s\n",
18775                 SvPV_nolen_const(RExC_mysv), REG_NODE_NUM(scan),
18776                     (temp == NULL ? "->" : ""),
18777                     (temp == NULL ? PL_reg_name[OP(val)] : "")
18778             );
18779         });
18780         if (temp == NULL)
18781             break;
18782         scan = temp;
18783     }
18784
18785     if (reg_off_by_arg[OP(scan)]) {
18786         ARG_SET(scan, val - scan);
18787     }
18788     else {
18789         NEXT_OFF(scan) = val - scan;
18790     }
18791 }
18792
18793 #ifdef DEBUGGING
18794 /*
18795 - regtail_study - set the next-pointer at the end of a node chain of p to val.
18796 - Look for optimizable sequences at the same time.
18797 - currently only looks for EXACT chains.
18798
18799 This is experimental code. The idea is to use this routine to perform
18800 in place optimizations on branches and groups as they are constructed,
18801 with the long term intention of removing optimization from study_chunk so
18802 that it is purely analytical.
18803
18804 Currently only used when in DEBUG mode. The macro REGTAIL_STUDY() is used
18805 to control which is which.
18806
18807 */
18808 /* TODO: All four parms should be const */
18809
18810 STATIC U8
18811 S_regtail_study(pTHX_ RExC_state_t *pRExC_state, regnode *p,
18812                       const regnode *val,U32 depth)
18813 {
18814     regnode *scan;
18815     U8 exact = PSEUDO;
18816 #ifdef EXPERIMENTAL_INPLACESCAN
18817     I32 min = 0;
18818 #endif
18819     GET_RE_DEBUG_FLAGS_DECL;
18820
18821     PERL_ARGS_ASSERT_REGTAIL_STUDY;
18822
18823
18824     if (SIZE_ONLY)
18825         return exact;
18826
18827     /* Find last node. */
18828
18829     scan = p;
18830     for (;;) {
18831         regnode * const temp = regnext(scan);
18832 #ifdef EXPERIMENTAL_INPLACESCAN
18833         if (PL_regkind[OP(scan)] == EXACT) {
18834             bool unfolded_multi_char;   /* Unexamined in this routine */
18835             if (join_exact(pRExC_state, scan, &min,
18836                            &unfolded_multi_char, 1, val, depth+1))
18837                 return EXACT;
18838         }
18839 #endif
18840         if ( exact ) {
18841             switch (OP(scan)) {
18842                 case EXACT:
18843                 case EXACTL:
18844                 case EXACTF:
18845                 case EXACTFA_NO_TRIE:
18846                 case EXACTFA:
18847                 case EXACTFU:
18848                 case EXACTFLU8:
18849                 case EXACTFU_SS:
18850                 case EXACTFL:
18851                         if( exact == PSEUDO )
18852                             exact= OP(scan);
18853                         else if ( exact != OP(scan) )
18854                             exact= 0;
18855                 case NOTHING:
18856                     break;
18857                 default:
18858                     exact= 0;
18859             }
18860         }
18861         DEBUG_PARSE_r({
18862             DEBUG_PARSE_MSG((scan==p ? "tsdy" : ""));
18863             regprop(RExC_rx, RExC_mysv, scan, NULL, pRExC_state);
18864             Perl_re_printf( aTHX_  "~ %s (%d) -> %s\n",
18865                 SvPV_nolen_const(RExC_mysv),
18866                 REG_NODE_NUM(scan),
18867                 PL_reg_name[exact]);
18868         });
18869         if (temp == NULL)
18870             break;
18871         scan = temp;
18872     }
18873     DEBUG_PARSE_r({
18874         DEBUG_PARSE_MSG("");
18875         regprop(RExC_rx, RExC_mysv, val, NULL, pRExC_state);
18876         Perl_re_printf( aTHX_
18877                       "~ attach to %s (%" IVdf ") offset to %" IVdf "\n",
18878                       SvPV_nolen_const(RExC_mysv),
18879                       (IV)REG_NODE_NUM(val),
18880                       (IV)(val - scan)
18881         );
18882     });
18883     if (reg_off_by_arg[OP(scan)]) {
18884         ARG_SET(scan, val - scan);
18885     }
18886     else {
18887         NEXT_OFF(scan) = val - scan;
18888     }
18889
18890     return exact;
18891 }
18892 #endif
18893
18894 /*
18895  - regdump - dump a regexp onto Perl_debug_log in vaguely comprehensible form
18896  */
18897 #ifdef DEBUGGING
18898
18899 static void
18900 S_regdump_intflags(pTHX_ const char *lead, const U32 flags)
18901 {
18902     int bit;
18903     int set=0;
18904
18905     ASSUME(REG_INTFLAGS_NAME_SIZE <= sizeof(flags)*8);
18906
18907     for (bit=0; bit<REG_INTFLAGS_NAME_SIZE; bit++) {
18908         if (flags & (1<<bit)) {
18909             if (!set++ && lead)
18910                 Perl_re_printf( aTHX_  "%s",lead);
18911             Perl_re_printf( aTHX_  "%s ",PL_reg_intflags_name[bit]);
18912         }
18913     }
18914     if (lead)  {
18915         if (set)
18916             Perl_re_printf( aTHX_  "\n");
18917         else
18918             Perl_re_printf( aTHX_  "%s[none-set]\n",lead);
18919     }
18920 }
18921
18922 static void
18923 S_regdump_extflags(pTHX_ const char *lead, const U32 flags)
18924 {
18925     int bit;
18926     int set=0;
18927     regex_charset cs;
18928
18929     ASSUME(REG_EXTFLAGS_NAME_SIZE <= sizeof(flags)*8);
18930
18931     for (bit=0; bit<REG_EXTFLAGS_NAME_SIZE; bit++) {
18932         if (flags & (1<<bit)) {
18933             if ((1<<bit) & RXf_PMf_CHARSET) {   /* Output separately, below */
18934                 continue;
18935             }
18936             if (!set++ && lead)
18937                 Perl_re_printf( aTHX_  "%s",lead);
18938             Perl_re_printf( aTHX_  "%s ",PL_reg_extflags_name[bit]);
18939         }
18940     }
18941     if ((cs = get_regex_charset(flags)) != REGEX_DEPENDS_CHARSET) {
18942             if (!set++ && lead) {
18943                 Perl_re_printf( aTHX_  "%s",lead);
18944             }
18945             switch (cs) {
18946                 case REGEX_UNICODE_CHARSET:
18947                     Perl_re_printf( aTHX_  "UNICODE");
18948                     break;
18949                 case REGEX_LOCALE_CHARSET:
18950                     Perl_re_printf( aTHX_  "LOCALE");
18951                     break;
18952                 case REGEX_ASCII_RESTRICTED_CHARSET:
18953                     Perl_re_printf( aTHX_  "ASCII-RESTRICTED");
18954                     break;
18955                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
18956                     Perl_re_printf( aTHX_  "ASCII-MORE_RESTRICTED");
18957                     break;
18958                 default:
18959                     Perl_re_printf( aTHX_  "UNKNOWN CHARACTER SET");
18960                     break;
18961             }
18962     }
18963     if (lead)  {
18964         if (set)
18965             Perl_re_printf( aTHX_  "\n");
18966         else
18967             Perl_re_printf( aTHX_  "%s[none-set]\n",lead);
18968     }
18969 }
18970 #endif
18971
18972 void
18973 Perl_regdump(pTHX_ const regexp *r)
18974 {
18975 #ifdef DEBUGGING
18976     int i;
18977     SV * const sv = sv_newmortal();
18978     SV *dsv= sv_newmortal();
18979     RXi_GET_DECL(r,ri);
18980     GET_RE_DEBUG_FLAGS_DECL;
18981
18982     PERL_ARGS_ASSERT_REGDUMP;
18983
18984     (void)dumpuntil(r, ri->program, ri->program + 1, NULL, NULL, sv, 0, 0);
18985
18986     /* Header fields of interest. */
18987     for (i = 0; i < 2; i++) {
18988         if (r->substrs->data[i].substr) {
18989             RE_PV_QUOTED_DECL(s, 0, dsv,
18990                             SvPVX_const(r->substrs->data[i].substr),
18991                             RE_SV_DUMPLEN(r->substrs->data[i].substr),
18992                             PL_dump_re_max_len);
18993             Perl_re_printf( aTHX_
18994                           "%s %s%s at %" IVdf "..%" UVuf " ",
18995                           i ? "floating" : "anchored",
18996                           s,
18997                           RE_SV_TAIL(r->substrs->data[i].substr),
18998                           (IV)r->substrs->data[i].min_offset,
18999                           (UV)r->substrs->data[i].max_offset);
19000         }
19001         else if (r->substrs->data[i].utf8_substr) {
19002             RE_PV_QUOTED_DECL(s, 1, dsv,
19003                             SvPVX_const(r->substrs->data[i].utf8_substr),
19004                             RE_SV_DUMPLEN(r->substrs->data[i].utf8_substr),
19005                             30);
19006             Perl_re_printf( aTHX_
19007                           "%s utf8 %s%s at %" IVdf "..%" UVuf " ",
19008                           i ? "floating" : "anchored",
19009                           s,
19010                           RE_SV_TAIL(r->substrs->data[i].utf8_substr),
19011                           (IV)r->substrs->data[i].min_offset,
19012                           (UV)r->substrs->data[i].max_offset);
19013         }
19014     }
19015
19016     if (r->check_substr || r->check_utf8)
19017         Perl_re_printf( aTHX_
19018                       (const char *)
19019                       (   r->check_substr == r->substrs->data[1].substr
19020                        && r->check_utf8   == r->substrs->data[1].utf8_substr
19021                        ? "(checking floating" : "(checking anchored"));
19022     if (r->intflags & PREGf_NOSCAN)
19023         Perl_re_printf( aTHX_  " noscan");
19024     if (r->extflags & RXf_CHECK_ALL)
19025         Perl_re_printf( aTHX_  " isall");
19026     if (r->check_substr || r->check_utf8)
19027         Perl_re_printf( aTHX_  ") ");
19028
19029     if (ri->regstclass) {
19030         regprop(r, sv, ri->regstclass, NULL, NULL);
19031         Perl_re_printf( aTHX_  "stclass %s ", SvPVX_const(sv));
19032     }
19033     if (r->intflags & PREGf_ANCH) {
19034         Perl_re_printf( aTHX_  "anchored");
19035         if (r->intflags & PREGf_ANCH_MBOL)
19036             Perl_re_printf( aTHX_  "(MBOL)");
19037         if (r->intflags & PREGf_ANCH_SBOL)
19038             Perl_re_printf( aTHX_  "(SBOL)");
19039         if (r->intflags & PREGf_ANCH_GPOS)
19040             Perl_re_printf( aTHX_  "(GPOS)");
19041         Perl_re_printf( aTHX_ " ");
19042     }
19043     if (r->intflags & PREGf_GPOS_SEEN)
19044         Perl_re_printf( aTHX_  "GPOS:%" UVuf " ", (UV)r->gofs);
19045     if (r->intflags & PREGf_SKIP)
19046         Perl_re_printf( aTHX_  "plus ");
19047     if (r->intflags & PREGf_IMPLICIT)
19048         Perl_re_printf( aTHX_  "implicit ");
19049     Perl_re_printf( aTHX_  "minlen %" IVdf " ", (IV)r->minlen);
19050     if (r->extflags & RXf_EVAL_SEEN)
19051         Perl_re_printf( aTHX_  "with eval ");
19052     Perl_re_printf( aTHX_  "\n");
19053     DEBUG_FLAGS_r({
19054         regdump_extflags("r->extflags: ",r->extflags);
19055         regdump_intflags("r->intflags: ",r->intflags);
19056     });
19057 #else
19058     PERL_ARGS_ASSERT_REGDUMP;
19059     PERL_UNUSED_CONTEXT;
19060     PERL_UNUSED_ARG(r);
19061 #endif  /* DEBUGGING */
19062 }
19063
19064 /* Should be synchronized with ANYOF_ #defines in regcomp.h */
19065 #ifdef DEBUGGING
19066
19067 #  if   _CC_WORDCHAR != 0 || _CC_DIGIT != 1        || _CC_ALPHA != 2    \
19068      || _CC_LOWER != 3    || _CC_UPPER != 4        || _CC_PUNCT != 5    \
19069      || _CC_PRINT != 6    || _CC_ALPHANUMERIC != 7 || _CC_GRAPH != 8    \
19070      || _CC_CASED != 9    || _CC_SPACE != 10       || _CC_BLANK != 11   \
19071      || _CC_XDIGIT != 12  || _CC_CNTRL != 13       || _CC_ASCII != 14   \
19072      || _CC_VERTSPACE != 15
19073 #   error Need to adjust order of anyofs[]
19074 #  endif
19075 static const char * const anyofs[] = {
19076     "\\w",
19077     "\\W",
19078     "\\d",
19079     "\\D",
19080     "[:alpha:]",
19081     "[:^alpha:]",
19082     "[:lower:]",
19083     "[:^lower:]",
19084     "[:upper:]",
19085     "[:^upper:]",
19086     "[:punct:]",
19087     "[:^punct:]",
19088     "[:print:]",
19089     "[:^print:]",
19090     "[:alnum:]",
19091     "[:^alnum:]",
19092     "[:graph:]",
19093     "[:^graph:]",
19094     "[:cased:]",
19095     "[:^cased:]",
19096     "\\s",
19097     "\\S",
19098     "[:blank:]",
19099     "[:^blank:]",
19100     "[:xdigit:]",
19101     "[:^xdigit:]",
19102     "[:cntrl:]",
19103     "[:^cntrl:]",
19104     "[:ascii:]",
19105     "[:^ascii:]",
19106     "\\v",
19107     "\\V"
19108 };
19109 #endif
19110
19111 /*
19112 - regprop - printable representation of opcode, with run time support
19113 */
19114
19115 void
19116 Perl_regprop(pTHX_ const regexp *prog, SV *sv, const regnode *o, const regmatch_info *reginfo, const RExC_state_t *pRExC_state)
19117 {
19118 #ifdef DEBUGGING
19119     int k;
19120     RXi_GET_DECL(prog,progi);
19121     GET_RE_DEBUG_FLAGS_DECL;
19122
19123     PERL_ARGS_ASSERT_REGPROP;
19124
19125     SvPVCLEAR(sv);
19126
19127     if (OP(o) > REGNODE_MAX)            /* regnode.type is unsigned */
19128         /* It would be nice to FAIL() here, but this may be called from
19129            regexec.c, and it would be hard to supply pRExC_state. */
19130         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d",
19131                                               (int)OP(o), (int)REGNODE_MAX);
19132     sv_catpv(sv, PL_reg_name[OP(o)]); /* Take off const! */
19133
19134     k = PL_regkind[OP(o)];
19135
19136     if (k == EXACT) {
19137         sv_catpvs(sv, " ");
19138         /* Using is_utf8_string() (via PERL_PV_UNI_DETECT)
19139          * is a crude hack but it may be the best for now since
19140          * we have no flag "this EXACTish node was UTF-8"
19141          * --jhi */
19142         pv_pretty(sv, STRING(o), STR_LEN(o), PL_dump_re_max_len,
19143                   PL_colors[0], PL_colors[1],
19144                   PERL_PV_ESCAPE_UNI_DETECT |
19145                   PERL_PV_ESCAPE_NONASCII   |
19146                   PERL_PV_PRETTY_ELLIPSES   |
19147                   PERL_PV_PRETTY_LTGT       |
19148                   PERL_PV_PRETTY_NOCLEAR
19149                   );
19150     } else if (k == TRIE) {
19151         /* print the details of the trie in dumpuntil instead, as
19152          * progi->data isn't available here */
19153         const char op = OP(o);
19154         const U32 n = ARG(o);
19155         const reg_ac_data * const ac = IS_TRIE_AC(op) ?
19156                (reg_ac_data *)progi->data->data[n] :
19157                NULL;
19158         const reg_trie_data * const trie
19159             = (reg_trie_data*)progi->data->data[!IS_TRIE_AC(op) ? n : ac->trie];
19160
19161         Perl_sv_catpvf(aTHX_ sv, "-%s",PL_reg_name[o->flags]);
19162         DEBUG_TRIE_COMPILE_r({
19163           if (trie->jump)
19164             sv_catpvs(sv, "(JUMP)");
19165           Perl_sv_catpvf(aTHX_ sv,
19166             "<S:%" UVuf "/%" IVdf " W:%" UVuf " L:%" UVuf "/%" UVuf " C:%" UVuf "/%" UVuf ">",
19167             (UV)trie->startstate,
19168             (IV)trie->statecount-1, /* -1 because of the unused 0 element */
19169             (UV)trie->wordcount,
19170             (UV)trie->minlen,
19171             (UV)trie->maxlen,
19172             (UV)TRIE_CHARCOUNT(trie),
19173             (UV)trie->uniquecharcount
19174           );
19175         });
19176         if ( IS_ANYOF_TRIE(op) || trie->bitmap ) {
19177             sv_catpvs(sv, "[");
19178             (void) put_charclass_bitmap_innards(sv,
19179                                                 ((IS_ANYOF_TRIE(op))
19180                                                  ? ANYOF_BITMAP(o)
19181                                                  : TRIE_BITMAP(trie)),
19182                                                 NULL,
19183                                                 NULL,
19184                                                 NULL,
19185                                                 FALSE
19186                                                );
19187             sv_catpvs(sv, "]");
19188         }
19189     } else if (k == CURLY) {
19190         U32 lo = ARG1(o), hi = ARG2(o);
19191         if (OP(o) == CURLYM || OP(o) == CURLYN || OP(o) == CURLYX)
19192             Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags); /* Parenth number */
19193         Perl_sv_catpvf(aTHX_ sv, "{%u,", (unsigned) lo);
19194         if (hi == REG_INFTY)
19195             sv_catpvs(sv, "INFTY");
19196         else
19197             Perl_sv_catpvf(aTHX_ sv, "%u", (unsigned) hi);
19198         sv_catpvs(sv, "}");
19199     }
19200     else if (k == WHILEM && o->flags)                   /* Ordinal/of */
19201         Perl_sv_catpvf(aTHX_ sv, "[%d/%d]", o->flags & 0xf, o->flags>>4);
19202     else if (k == REF || k == OPEN || k == CLOSE
19203              || k == GROUPP || OP(o)==ACCEPT)
19204     {
19205         AV *name_list= NULL;
19206         U32 parno= OP(o) == ACCEPT ? (U32)ARG2L(o) : ARG(o);
19207         Perl_sv_catpvf(aTHX_ sv, "%" UVuf, (UV)parno);        /* Parenth number */
19208         if ( RXp_PAREN_NAMES(prog) ) {
19209             name_list= MUTABLE_AV(progi->data->data[progi->name_list_idx]);
19210         } else if ( pRExC_state ) {
19211             name_list= RExC_paren_name_list;
19212         }
19213         if (name_list) {
19214             if ( k != REF || (OP(o) < NREF)) {
19215                 SV **name= av_fetch(name_list, parno, 0 );
19216                 if (name)
19217                     Perl_sv_catpvf(aTHX_ sv, " '%" SVf "'", SVfARG(*name));
19218             }
19219             else {
19220                 SV *sv_dat= MUTABLE_SV(progi->data->data[ parno ]);
19221                 I32 *nums=(I32*)SvPVX(sv_dat);
19222                 SV **name= av_fetch(name_list, nums[0], 0 );
19223                 I32 n;
19224                 if (name) {
19225                     for ( n=0; n<SvIVX(sv_dat); n++ ) {
19226                         Perl_sv_catpvf(aTHX_ sv, "%s%" IVdf,
19227                                     (n ? "," : ""), (IV)nums[n]);
19228                     }
19229                     Perl_sv_catpvf(aTHX_ sv, " '%" SVf "'", SVfARG(*name));
19230                 }
19231             }
19232         }
19233         if ( k == REF && reginfo) {
19234             U32 n = ARG(o);  /* which paren pair */
19235             I32 ln = prog->offs[n].start;
19236             if (prog->lastparen < n || ln == -1)
19237                 Perl_sv_catpvf(aTHX_ sv, ": FAIL");
19238             else if (ln == prog->offs[n].end)
19239                 Perl_sv_catpvf(aTHX_ sv, ": ACCEPT - EMPTY STRING");
19240             else {
19241                 const char *s = reginfo->strbeg + ln;
19242                 Perl_sv_catpvf(aTHX_ sv, ": ");
19243                 Perl_pv_pretty( aTHX_ sv, s, prog->offs[n].end - prog->offs[n].start, 32, 0, 0,
19244                     PERL_PV_ESCAPE_UNI_DETECT|PERL_PV_PRETTY_NOCLEAR|PERL_PV_PRETTY_ELLIPSES|PERL_PV_PRETTY_QUOTE );
19245             }
19246         }
19247     } else if (k == GOSUB) {
19248         AV *name_list= NULL;
19249         if ( RXp_PAREN_NAMES(prog) ) {
19250             name_list= MUTABLE_AV(progi->data->data[progi->name_list_idx]);
19251         } else if ( pRExC_state ) {
19252             name_list= RExC_paren_name_list;
19253         }
19254
19255         /* Paren and offset */
19256         Perl_sv_catpvf(aTHX_ sv, "%d[%+d:%d]", (int)ARG(o),(int)ARG2L(o),
19257                 (int)((o + (int)ARG2L(o)) - progi->program) );
19258         if (name_list) {
19259             SV **name= av_fetch(name_list, ARG(o), 0 );
19260             if (name)
19261                 Perl_sv_catpvf(aTHX_ sv, " '%" SVf "'", SVfARG(*name));
19262         }
19263     }
19264     else if (k == LOGICAL)
19265         /* 2: embedded, otherwise 1 */
19266         Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags);
19267     else if (k == ANYOF) {
19268         const U8 flags = ANYOF_FLAGS(o);
19269         bool do_sep = FALSE;    /* Do we need to separate various components of
19270                                    the output? */
19271         /* Set if there is still an unresolved user-defined property */
19272         SV *unresolved                = NULL;
19273
19274         /* Things that are ignored except when the runtime locale is UTF-8 */
19275         SV *only_utf8_locale_invlist = NULL;
19276
19277         /* Code points that don't fit in the bitmap */
19278         SV *nonbitmap_invlist = NULL;
19279
19280         /* And things that aren't in the bitmap, but are small enough to be */
19281         SV* bitmap_range_not_in_bitmap = NULL;
19282
19283         const bool inverted = flags & ANYOF_INVERT;
19284
19285         if (OP(o) == ANYOFL) {
19286             if (ANYOFL_UTF8_LOCALE_REQD(flags)) {
19287                 sv_catpvs(sv, "{utf8-locale-reqd}");
19288             }
19289             if (flags & ANYOFL_FOLD) {
19290                 sv_catpvs(sv, "{i}");
19291             }
19292         }
19293
19294         /* If there is stuff outside the bitmap, get it */
19295         if (ARG(o) != ANYOF_ONLY_HAS_BITMAP) {
19296             (void) _get_regclass_nonbitmap_data(prog, o, FALSE,
19297                                                 &unresolved,
19298                                                 &only_utf8_locale_invlist,
19299                                                 &nonbitmap_invlist);
19300             /* The non-bitmap data may contain stuff that could fit in the
19301              * bitmap.  This could come from a user-defined property being
19302              * finally resolved when this call was done; or much more likely
19303              * because there are matches that require UTF-8 to be valid, and so
19304              * aren't in the bitmap.  This is teased apart later */
19305             _invlist_intersection(nonbitmap_invlist,
19306                                   PL_InBitmap,
19307                                   &bitmap_range_not_in_bitmap);
19308             /* Leave just the things that don't fit into the bitmap */
19309             _invlist_subtract(nonbitmap_invlist,
19310                               PL_InBitmap,
19311                               &nonbitmap_invlist);
19312         }
19313
19314         /* Obey this flag to add all above-the-bitmap code points */
19315         if (flags & ANYOF_MATCHES_ALL_ABOVE_BITMAP) {
19316             nonbitmap_invlist = _add_range_to_invlist(nonbitmap_invlist,
19317                                                       NUM_ANYOF_CODE_POINTS,
19318                                                       UV_MAX);
19319         }
19320
19321         /* Ready to start outputting.  First, the initial left bracket */
19322         Perl_sv_catpvf(aTHX_ sv, "[%s", PL_colors[0]);
19323
19324         /* Then all the things that could fit in the bitmap */
19325         do_sep = put_charclass_bitmap_innards(sv,
19326                                               ANYOF_BITMAP(o),
19327                                               bitmap_range_not_in_bitmap,
19328                                               only_utf8_locale_invlist,
19329                                               o,
19330
19331                                               /* Can't try inverting for a
19332                                                * better display if there are
19333                                                * things that haven't been
19334                                                * resolved */
19335                                               unresolved != NULL);
19336         SvREFCNT_dec(bitmap_range_not_in_bitmap);
19337
19338         /* If there are user-defined properties which haven't been defined yet,
19339          * output them.  If the result is not to be inverted, it is clearest to
19340          * output them in a separate [] from the bitmap range stuff.  If the
19341          * result is to be complemented, we have to show everything in one [],
19342          * as the inversion applies to the whole thing.  Use {braces} to
19343          * separate them from anything in the bitmap and anything above the
19344          * bitmap. */
19345         if (unresolved) {
19346             if (inverted) {
19347                 if (! do_sep) { /* If didn't output anything in the bitmap */
19348                     sv_catpvs(sv, "^");
19349                 }
19350                 sv_catpvs(sv, "{");
19351             }
19352             else if (do_sep) {
19353                 Perl_sv_catpvf(aTHX_ sv,"%s][%s",PL_colors[1],PL_colors[0]);
19354             }
19355             sv_catsv(sv, unresolved);
19356             if (inverted) {
19357                 sv_catpvs(sv, "}");
19358             }
19359             do_sep = ! inverted;
19360         }
19361
19362         /* And, finally, add the above-the-bitmap stuff */
19363         if (nonbitmap_invlist && _invlist_len(nonbitmap_invlist)) {
19364             SV* contents;
19365
19366             /* See if truncation size is overridden */
19367             const STRLEN dump_len = (PL_dump_re_max_len > 256)
19368                                     ? PL_dump_re_max_len
19369                                     : 256;
19370
19371             /* This is output in a separate [] */
19372             if (do_sep) {
19373                 Perl_sv_catpvf(aTHX_ sv,"%s][%s",PL_colors[1],PL_colors[0]);
19374             }
19375
19376             /* And, for easy of understanding, it is shown in the
19377              * uncomplemented form if possible.  The one exception being if
19378              * there are unresolved items, where the inversion has to be
19379              * delayed until runtime */
19380             if (inverted && ! unresolved) {
19381                 _invlist_invert(nonbitmap_invlist);
19382                 _invlist_subtract(nonbitmap_invlist, PL_InBitmap, &nonbitmap_invlist);
19383             }
19384
19385             contents = invlist_contents(nonbitmap_invlist,
19386                                         FALSE /* output suitable for catsv */
19387                                        );
19388
19389             /* If the output is shorter than the permissible maximum, just do it. */
19390             if (SvCUR(contents) <= dump_len) {
19391                 sv_catsv(sv, contents);
19392             }
19393             else {
19394                 const char * contents_string = SvPVX(contents);
19395                 STRLEN i = dump_len;
19396
19397                 /* Otherwise, start at the permissible max and work back to the
19398                  * first break possibility */
19399                 while (i > 0 && contents_string[i] != ' ') {
19400                     i--;
19401                 }
19402                 if (i == 0) {       /* Fail-safe.  Use the max if we couldn't
19403                                        find a legal break */
19404                     i = dump_len;
19405                 }
19406
19407                 sv_catpvn(sv, contents_string, i);
19408                 sv_catpvs(sv, "...");
19409             }
19410
19411             SvREFCNT_dec_NN(contents);
19412             SvREFCNT_dec_NN(nonbitmap_invlist);
19413         }
19414
19415         /* And finally the matching, closing ']' */
19416         Perl_sv_catpvf(aTHX_ sv, "%s]", PL_colors[1]);
19417
19418         SvREFCNT_dec(unresolved);
19419     }
19420     else if (k == POSIXD || k == NPOSIXD) {
19421         U8 index = FLAGS(o) * 2;
19422         if (index < C_ARRAY_LENGTH(anyofs)) {
19423             if (*anyofs[index] != '[')  {
19424                 sv_catpv(sv, "[");
19425             }
19426             sv_catpv(sv, anyofs[index]);
19427             if (*anyofs[index] != '[')  {
19428                 sv_catpv(sv, "]");
19429             }
19430         }
19431         else {
19432             Perl_sv_catpvf(aTHX_ sv, "[illegal type=%d])", index);
19433         }
19434     }
19435     else if (k == BOUND || k == NBOUND) {
19436         /* Must be synced with order of 'bound_type' in regcomp.h */
19437         const char * const bounds[] = {
19438             "",      /* Traditional */
19439             "{gcb}",
19440             "{lb}",
19441             "{sb}",
19442             "{wb}"
19443         };
19444         assert(FLAGS(o) < C_ARRAY_LENGTH(bounds));
19445         sv_catpv(sv, bounds[FLAGS(o)]);
19446     }
19447     else if (k == BRANCHJ && (OP(o) == UNLESSM || OP(o) == IFMATCH))
19448         Perl_sv_catpvf(aTHX_ sv, "[%d]", -(o->flags));
19449     else if (OP(o) == SBOL)
19450         Perl_sv_catpvf(aTHX_ sv, " /%s/", o->flags ? "\\A" : "^");
19451
19452     /* add on the verb argument if there is one */
19453     if ( ( k == VERB || OP(o) == ACCEPT || OP(o) == OPFAIL ) && o->flags) {
19454         if ( ARG(o) )
19455             Perl_sv_catpvf(aTHX_ sv, ":%" SVf,
19456                        SVfARG((MUTABLE_SV(progi->data->data[ ARG( o ) ]))));
19457         else
19458             sv_catpvs(sv, ":NULL");
19459     }
19460 #else
19461     PERL_UNUSED_CONTEXT;
19462     PERL_UNUSED_ARG(sv);
19463     PERL_UNUSED_ARG(o);
19464     PERL_UNUSED_ARG(prog);
19465     PERL_UNUSED_ARG(reginfo);
19466     PERL_UNUSED_ARG(pRExC_state);
19467 #endif  /* DEBUGGING */
19468 }
19469
19470
19471
19472 SV *
19473 Perl_re_intuit_string(pTHX_ REGEXP * const r)
19474 {                               /* Assume that RE_INTUIT is set */
19475     struct regexp *const prog = ReANY(r);
19476     GET_RE_DEBUG_FLAGS_DECL;
19477
19478     PERL_ARGS_ASSERT_RE_INTUIT_STRING;
19479     PERL_UNUSED_CONTEXT;
19480
19481     DEBUG_COMPILE_r(
19482         {
19483             const char * const s = SvPV_nolen_const(RX_UTF8(r)
19484                       ? prog->check_utf8 : prog->check_substr);
19485
19486             if (!PL_colorset) reginitcolors();
19487             Perl_re_printf( aTHX_
19488                       "%sUsing REx %ssubstr:%s \"%s%.60s%s%s\"\n",
19489                       PL_colors[4],
19490                       RX_UTF8(r) ? "utf8 " : "",
19491                       PL_colors[5],PL_colors[0],
19492                       s,
19493                       PL_colors[1],
19494                       (strlen(s) > PL_dump_re_max_len ? "..." : ""));
19495         } );
19496
19497     /* use UTF8 check substring if regexp pattern itself is in UTF8 */
19498     return RX_UTF8(r) ? prog->check_utf8 : prog->check_substr;
19499 }
19500
19501 /*
19502    pregfree()
19503
19504    handles refcounting and freeing the perl core regexp structure. When
19505    it is necessary to actually free the structure the first thing it
19506    does is call the 'free' method of the regexp_engine associated to
19507    the regexp, allowing the handling of the void *pprivate; member
19508    first. (This routine is not overridable by extensions, which is why
19509    the extensions free is called first.)
19510
19511    See regdupe and regdupe_internal if you change anything here.
19512 */
19513 #ifndef PERL_IN_XSUB_RE
19514 void
19515 Perl_pregfree(pTHX_ REGEXP *r)
19516 {
19517     SvREFCNT_dec(r);
19518 }
19519
19520 void
19521 Perl_pregfree2(pTHX_ REGEXP *rx)
19522 {
19523     struct regexp *const r = ReANY(rx);
19524     GET_RE_DEBUG_FLAGS_DECL;
19525
19526     PERL_ARGS_ASSERT_PREGFREE2;
19527
19528     if (r->mother_re) {
19529         ReREFCNT_dec(r->mother_re);
19530     } else {
19531         CALLREGFREE_PVT(rx); /* free the private data */
19532         SvREFCNT_dec(RXp_PAREN_NAMES(r));
19533     }
19534     if (r->substrs) {
19535         int i;
19536         for (i = 0; i < 2; i++) {
19537             SvREFCNT_dec(r->substrs->data[i].substr);
19538             SvREFCNT_dec(r->substrs->data[i].utf8_substr);
19539         }
19540         Safefree(r->substrs);
19541     }
19542     RX_MATCH_COPY_FREE(rx);
19543 #ifdef PERL_ANY_COW
19544     SvREFCNT_dec(r->saved_copy);
19545 #endif
19546     Safefree(r->offs);
19547     SvREFCNT_dec(r->qr_anoncv);
19548     if (r->recurse_locinput)
19549         Safefree(r->recurse_locinput);
19550 }
19551
19552
19553 /*  reg_temp_copy()
19554
19555     Copy ssv to dsv, both of which should of type SVt_REGEXP or SVt_PVLV,
19556     except that dsv will be created if NULL.
19557
19558     This function is used in two main ways. First to implement
19559         $r = qr/....; $s = $$r;
19560
19561     Secondly, it is used as a hacky workaround to the structural issue of
19562     match results
19563     being stored in the regexp structure which is in turn stored in
19564     PL_curpm/PL_reg_curpm. The problem is that due to qr// the pattern
19565     could be PL_curpm in multiple contexts, and could require multiple
19566     result sets being associated with the pattern simultaneously, such
19567     as when doing a recursive match with (??{$qr})
19568
19569     The solution is to make a lightweight copy of the regexp structure
19570     when a qr// is returned from the code executed by (??{$qr}) this
19571     lightweight copy doesn't actually own any of its data except for
19572     the starp/end and the actual regexp structure itself.
19573
19574 */
19575
19576
19577 REGEXP *
19578 Perl_reg_temp_copy(pTHX_ REGEXP *dsv, REGEXP *ssv)
19579 {
19580     struct regexp *drx;
19581     struct regexp *const srx = ReANY(ssv);
19582     const bool islv = dsv && SvTYPE(dsv) == SVt_PVLV;
19583
19584     PERL_ARGS_ASSERT_REG_TEMP_COPY;
19585
19586     if (!dsv)
19587         dsv = (REGEXP*) newSV_type(SVt_REGEXP);
19588     else {
19589         SvOK_off((SV *)dsv);
19590         if (islv) {
19591             /* For PVLVs, the head (sv_any) points to an XPVLV, while
19592              * the LV's xpvlenu_rx will point to a regexp body, which
19593              * we allocate here */
19594             REGEXP *temp = (REGEXP *)newSV_type(SVt_REGEXP);
19595             assert(!SvPVX(dsv));
19596             ((XPV*)SvANY(dsv))->xpv_len_u.xpvlenu_rx = temp->sv_any;
19597             temp->sv_any = NULL;
19598             SvFLAGS(temp) = (SvFLAGS(temp) & ~SVTYPEMASK) | SVt_NULL;
19599             SvREFCNT_dec_NN(temp);
19600             /* SvCUR still resides in the xpvlv struct, so the regexp copy-
19601                ing below will not set it. */
19602             SvCUR_set(dsv, SvCUR(ssv));
19603         }
19604     }
19605     /* This ensures that SvTHINKFIRST(sv) is true, and hence that
19606        sv_force_normal(sv) is called.  */
19607     SvFAKE_on(dsv);
19608     drx = ReANY(dsv);
19609
19610     SvFLAGS(dsv) |= SvFLAGS(ssv) & (SVf_POK|SVp_POK|SVf_UTF8);
19611     SvPV_set(dsv, RX_WRAPPED(ssv));
19612     /* We share the same string buffer as the original regexp, on which we
19613        hold a reference count, incremented when mother_re is set below.
19614        The string pointer is copied here, being part of the regexp struct.
19615      */
19616     memcpy(&(drx->xpv_cur), &(srx->xpv_cur),
19617            sizeof(regexp) - STRUCT_OFFSET(regexp, xpv_cur));
19618     if (!islv)
19619         SvLEN_set(dsv, 0);
19620     if (srx->offs) {
19621         const I32 npar = srx->nparens+1;
19622         Newx(drx->offs, npar, regexp_paren_pair);
19623         Copy(srx->offs, drx->offs, npar, regexp_paren_pair);
19624     }
19625     if (srx->substrs) {
19626         int i;
19627         Newx(drx->substrs, 1, struct reg_substr_data);
19628         StructCopy(srx->substrs, drx->substrs, struct reg_substr_data);
19629
19630         for (i = 0; i < 2; i++) {
19631             SvREFCNT_inc_void(drx->substrs->data[i].substr);
19632             SvREFCNT_inc_void(drx->substrs->data[i].utf8_substr);
19633         }
19634
19635         /* check_substr and check_utf8, if non-NULL, point to either their
19636            anchored or float namesakes, and don't hold a second reference.  */
19637     }
19638     RX_MATCH_COPIED_off(dsv);
19639 #ifdef PERL_ANY_COW
19640     drx->saved_copy = NULL;
19641 #endif
19642     drx->mother_re = ReREFCNT_inc(srx->mother_re ? srx->mother_re : ssv);
19643     SvREFCNT_inc_void(drx->qr_anoncv);
19644     if (srx->recurse_locinput)
19645         Newxz(drx->recurse_locinput,srx->nparens + 1,char *);
19646
19647     return dsv;
19648 }
19649 #endif
19650
19651
19652 /* regfree_internal()
19653
19654    Free the private data in a regexp. This is overloadable by
19655    extensions. Perl takes care of the regexp structure in pregfree(),
19656    this covers the *pprivate pointer which technically perl doesn't
19657    know about, however of course we have to handle the
19658    regexp_internal structure when no extension is in use.
19659
19660    Note this is called before freeing anything in the regexp
19661    structure.
19662  */
19663
19664 void
19665 Perl_regfree_internal(pTHX_ REGEXP * const rx)
19666 {
19667     struct regexp *const r = ReANY(rx);
19668     RXi_GET_DECL(r,ri);
19669     GET_RE_DEBUG_FLAGS_DECL;
19670
19671     PERL_ARGS_ASSERT_REGFREE_INTERNAL;
19672
19673     DEBUG_COMPILE_r({
19674         if (!PL_colorset)
19675             reginitcolors();
19676         {
19677             SV *dsv= sv_newmortal();
19678             RE_PV_QUOTED_DECL(s, RX_UTF8(rx),
19679                 dsv, RX_PRECOMP(rx), RX_PRELEN(rx), PL_dump_re_max_len);
19680             Perl_re_printf( aTHX_ "%sFreeing REx:%s %s\n",
19681                 PL_colors[4],PL_colors[5],s);
19682         }
19683     });
19684 #ifdef RE_TRACK_PATTERN_OFFSETS
19685     if (ri->u.offsets)
19686         Safefree(ri->u.offsets);             /* 20010421 MJD */
19687 #endif
19688     if (ri->code_blocks)
19689         S_free_codeblocks(aTHX_ ri->code_blocks);
19690
19691     if (ri->data) {
19692         int n = ri->data->count;
19693
19694         while (--n >= 0) {
19695           /* If you add a ->what type here, update the comment in regcomp.h */
19696             switch (ri->data->what[n]) {
19697             case 'a':
19698             case 'r':
19699             case 's':
19700             case 'S':
19701             case 'u':
19702                 SvREFCNT_dec(MUTABLE_SV(ri->data->data[n]));
19703                 break;
19704             case 'f':
19705                 Safefree(ri->data->data[n]);
19706                 break;
19707             case 'l':
19708             case 'L':
19709                 break;
19710             case 'T':
19711                 { /* Aho Corasick add-on structure for a trie node.
19712                      Used in stclass optimization only */
19713                     U32 refcount;
19714                     reg_ac_data *aho=(reg_ac_data*)ri->data->data[n];
19715 #ifdef USE_ITHREADS
19716                     dVAR;
19717 #endif
19718                     OP_REFCNT_LOCK;
19719                     refcount = --aho->refcount;
19720                     OP_REFCNT_UNLOCK;
19721                     if ( !refcount ) {
19722                         PerlMemShared_free(aho->states);
19723                         PerlMemShared_free(aho->fail);
19724                          /* do this last!!!! */
19725                         PerlMemShared_free(ri->data->data[n]);
19726                         /* we should only ever get called once, so
19727                          * assert as much, and also guard the free
19728                          * which /might/ happen twice. At the least
19729                          * it will make code anlyzers happy and it
19730                          * doesn't cost much. - Yves */
19731                         assert(ri->regstclass);
19732                         if (ri->regstclass) {
19733                             PerlMemShared_free(ri->regstclass);
19734                             ri->regstclass = 0;
19735                         }
19736                     }
19737                 }
19738                 break;
19739             case 't':
19740                 {
19741                     /* trie structure. */
19742                     U32 refcount;
19743                     reg_trie_data *trie=(reg_trie_data*)ri->data->data[n];
19744 #ifdef USE_ITHREADS
19745                     dVAR;
19746 #endif
19747                     OP_REFCNT_LOCK;
19748                     refcount = --trie->refcount;
19749                     OP_REFCNT_UNLOCK;
19750                     if ( !refcount ) {
19751                         PerlMemShared_free(trie->charmap);
19752                         PerlMemShared_free(trie->states);
19753                         PerlMemShared_free(trie->trans);
19754                         if (trie->bitmap)
19755                             PerlMemShared_free(trie->bitmap);
19756                         if (trie->jump)
19757                             PerlMemShared_free(trie->jump);
19758                         PerlMemShared_free(trie->wordinfo);
19759                         /* do this last!!!! */
19760                         PerlMemShared_free(ri->data->data[n]);
19761                     }
19762                 }
19763                 break;
19764             default:
19765                 Perl_croak(aTHX_ "panic: regfree data code '%c'",
19766                                                     ri->data->what[n]);
19767             }
19768         }
19769         Safefree(ri->data->what);
19770         Safefree(ri->data);
19771     }
19772
19773     Safefree(ri);
19774 }
19775
19776 #define av_dup_inc(s,t) MUTABLE_AV(sv_dup_inc((const SV *)s,t))
19777 #define hv_dup_inc(s,t) MUTABLE_HV(sv_dup_inc((const SV *)s,t))
19778 #define SAVEPVN(p,n)    ((p) ? savepvn(p,n) : NULL)
19779
19780 /*
19781    re_dup_guts - duplicate a regexp.
19782
19783    This routine is expected to clone a given regexp structure. It is only
19784    compiled under USE_ITHREADS.
19785
19786    After all of the core data stored in struct regexp is duplicated
19787    the regexp_engine.dupe method is used to copy any private data
19788    stored in the *pprivate pointer. This allows extensions to handle
19789    any duplication it needs to do.
19790
19791    See pregfree() and regfree_internal() if you change anything here.
19792 */
19793 #if defined(USE_ITHREADS)
19794 #ifndef PERL_IN_XSUB_RE
19795 void
19796 Perl_re_dup_guts(pTHX_ const REGEXP *sstr, REGEXP *dstr, CLONE_PARAMS *param)
19797 {
19798     dVAR;
19799     I32 npar;
19800     const struct regexp *r = ReANY(sstr);
19801     struct regexp *ret = ReANY(dstr);
19802
19803     PERL_ARGS_ASSERT_RE_DUP_GUTS;
19804
19805     npar = r->nparens+1;
19806     Newx(ret->offs, npar, regexp_paren_pair);
19807     Copy(r->offs, ret->offs, npar, regexp_paren_pair);
19808
19809     if (ret->substrs) {
19810         /* Do it this way to avoid reading from *r after the StructCopy().
19811            That way, if any of the sv_dup_inc()s dislodge *r from the L1
19812            cache, it doesn't matter.  */
19813         int i;
19814         const bool anchored = r->check_substr
19815             ? r->check_substr == r->substrs->data[0].substr
19816             : r->check_utf8   == r->substrs->data[0].utf8_substr;
19817         Newx(ret->substrs, 1, struct reg_substr_data);
19818         StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
19819
19820         for (i = 0; i < 2; i++) {
19821             ret->substrs->data[i].substr =
19822                         sv_dup_inc(ret->substrs->data[i].substr, param);
19823             ret->substrs->data[i].utf8_substr =
19824                         sv_dup_inc(ret->substrs->data[i].utf8_substr, param);
19825         }
19826
19827         /* check_substr and check_utf8, if non-NULL, point to either their
19828            anchored or float namesakes, and don't hold a second reference.  */
19829
19830         if (ret->check_substr) {
19831             if (anchored) {
19832                 assert(r->check_utf8 == r->substrs->data[0].utf8_substr);
19833
19834                 ret->check_substr = ret->substrs->data[0].substr;
19835                 ret->check_utf8   = ret->substrs->data[0].utf8_substr;
19836             } else {
19837                 assert(r->check_substr == r->substrs->data[1].substr);
19838                 assert(r->check_utf8   == r->substrs->data[1].utf8_substr);
19839
19840                 ret->check_substr = ret->substrs->data[1].substr;
19841                 ret->check_utf8   = ret->substrs->data[1].utf8_substr;
19842             }
19843         } else if (ret->check_utf8) {
19844             if (anchored) {
19845                 ret->check_utf8 = ret->substrs->data[0].utf8_substr;
19846             } else {
19847                 ret->check_utf8 = ret->substrs->data[1].utf8_substr;
19848             }
19849         }
19850     }
19851
19852     RXp_PAREN_NAMES(ret) = hv_dup_inc(RXp_PAREN_NAMES(ret), param);
19853     ret->qr_anoncv = MUTABLE_CV(sv_dup_inc((const SV *)ret->qr_anoncv, param));
19854     if (r->recurse_locinput)
19855         Newxz(ret->recurse_locinput,r->nparens + 1,char *);
19856
19857     if (ret->pprivate)
19858         RXi_SET(ret,CALLREGDUPE_PVT(dstr,param));
19859
19860     if (RX_MATCH_COPIED(dstr))
19861         ret->subbeg  = SAVEPVN(ret->subbeg, ret->sublen);
19862     else
19863         ret->subbeg = NULL;
19864 #ifdef PERL_ANY_COW
19865     ret->saved_copy = NULL;
19866 #endif
19867
19868     /* Whether mother_re be set or no, we need to copy the string.  We
19869        cannot refrain from copying it when the storage points directly to
19870        our mother regexp, because that's
19871                1: a buffer in a different thread
19872                2: something we no longer hold a reference on
19873                so we need to copy it locally.  */
19874     RX_WRAPPED(dstr) = SAVEPVN(RX_WRAPPED_const(sstr), SvCUR(sstr)+1);
19875     ret->mother_re   = NULL;
19876 }
19877 #endif /* PERL_IN_XSUB_RE */
19878
19879 /*
19880    regdupe_internal()
19881
19882    This is the internal complement to regdupe() which is used to copy
19883    the structure pointed to by the *pprivate pointer in the regexp.
19884    This is the core version of the extension overridable cloning hook.
19885    The regexp structure being duplicated will be copied by perl prior
19886    to this and will be provided as the regexp *r argument, however
19887    with the /old/ structures pprivate pointer value. Thus this routine
19888    may override any copying normally done by perl.
19889
19890    It returns a pointer to the new regexp_internal structure.
19891 */
19892
19893 void *
19894 Perl_regdupe_internal(pTHX_ REGEXP * const rx, CLONE_PARAMS *param)
19895 {
19896     dVAR;
19897     struct regexp *const r = ReANY(rx);
19898     regexp_internal *reti;
19899     int len;
19900     RXi_GET_DECL(r,ri);
19901
19902     PERL_ARGS_ASSERT_REGDUPE_INTERNAL;
19903
19904     len = ProgLen(ri);
19905
19906     Newxc(reti, sizeof(regexp_internal) + len*sizeof(regnode),
19907           char, regexp_internal);
19908     Copy(ri->program, reti->program, len+1, regnode);
19909
19910
19911     if (ri->code_blocks) {
19912         int n;
19913         Newx(reti->code_blocks, 1, struct reg_code_blocks);
19914         Newx(reti->code_blocks->cb, ri->code_blocks->count,
19915                     struct reg_code_block);
19916         Copy(ri->code_blocks->cb, reti->code_blocks->cb,
19917              ri->code_blocks->count, struct reg_code_block);
19918         for (n = 0; n < ri->code_blocks->count; n++)
19919              reti->code_blocks->cb[n].src_regex = (REGEXP*)
19920                     sv_dup_inc((SV*)(ri->code_blocks->cb[n].src_regex), param);
19921         reti->code_blocks->count = ri->code_blocks->count;
19922         reti->code_blocks->refcnt = 1;
19923     }
19924     else
19925         reti->code_blocks = NULL;
19926
19927     reti->regstclass = NULL;
19928
19929     if (ri->data) {
19930         struct reg_data *d;
19931         const int count = ri->data->count;
19932         int i;
19933
19934         Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
19935                 char, struct reg_data);
19936         Newx(d->what, count, U8);
19937
19938         d->count = count;
19939         for (i = 0; i < count; i++) {
19940             d->what[i] = ri->data->what[i];
19941             switch (d->what[i]) {
19942                 /* see also regcomp.h and regfree_internal() */
19943             case 'a': /* actually an AV, but the dup function is identical.
19944                          values seem to be "plain sv's" generally. */
19945             case 'r': /* a compiled regex (but still just another SV) */
19946             case 's': /* an RV (currently only used for an RV to an AV by the ANYOF code)
19947                          this use case should go away, the code could have used
19948                          'a' instead - see S_set_ANYOF_arg() for array contents. */
19949             case 'S': /* actually an SV, but the dup function is identical.  */
19950             case 'u': /* actually an HV, but the dup function is identical.
19951                          values are "plain sv's" */
19952                 d->data[i] = sv_dup_inc((const SV *)ri->data->data[i], param);
19953                 break;
19954             case 'f':
19955                 /* Synthetic Start Class - "Fake" charclass we generate to optimize
19956                  * patterns which could start with several different things. Pre-TRIE
19957                  * this was more important than it is now, however this still helps
19958                  * in some places, for instance /x?a+/ might produce a SSC equivalent
19959                  * to [xa]. This is used by Perl_re_intuit_start() and S_find_byclass()
19960                  * in regexec.c
19961                  */
19962                 /* This is cheating. */
19963                 Newx(d->data[i], 1, regnode_ssc);
19964                 StructCopy(ri->data->data[i], d->data[i], regnode_ssc);
19965                 reti->regstclass = (regnode*)d->data[i];
19966                 break;
19967             case 'T':
19968                 /* AHO-CORASICK fail table */
19969                 /* Trie stclasses are readonly and can thus be shared
19970                  * without duplication. We free the stclass in pregfree
19971                  * when the corresponding reg_ac_data struct is freed.
19972                  */
19973                 reti->regstclass= ri->regstclass;
19974                 /* FALLTHROUGH */
19975             case 't':
19976                 /* TRIE transition table */
19977                 OP_REFCNT_LOCK;
19978                 ((reg_trie_data*)ri->data->data[i])->refcount++;
19979                 OP_REFCNT_UNLOCK;
19980                 /* FALLTHROUGH */
19981             case 'l': /* (?{...}) or (??{ ... }) code (cb->block) */
19982             case 'L': /* same when RExC_pm_flags & PMf_HAS_CV and code
19983                          is not from another regexp */
19984                 d->data[i] = ri->data->data[i];
19985                 break;
19986             default:
19987                 Perl_croak(aTHX_ "panic: re_dup_guts unknown data code '%c'",
19988                                                            ri->data->what[i]);
19989             }
19990         }
19991
19992         reti->data = d;
19993     }
19994     else
19995         reti->data = NULL;
19996
19997     reti->name_list_idx = ri->name_list_idx;
19998
19999 #ifdef RE_TRACK_PATTERN_OFFSETS
20000     if (ri->u.offsets) {
20001         Newx(reti->u.offsets, 2*len+1, U32);
20002         Copy(ri->u.offsets, reti->u.offsets, 2*len+1, U32);
20003     }
20004 #else
20005     SetProgLen(reti,len);
20006 #endif
20007
20008     return (void*)reti;
20009 }
20010
20011 #endif    /* USE_ITHREADS */
20012
20013 #ifndef PERL_IN_XSUB_RE
20014
20015 /*
20016  - regnext - dig the "next" pointer out of a node
20017  */
20018 regnode *
20019 Perl_regnext(pTHX_ regnode *p)
20020 {
20021     I32 offset;
20022
20023     if (!p)
20024         return(NULL);
20025
20026     if (OP(p) > REGNODE_MAX) {          /* regnode.type is unsigned */
20027         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d",
20028                                                 (int)OP(p), (int)REGNODE_MAX);
20029     }
20030
20031     offset = (reg_off_by_arg[OP(p)] ? ARG(p) : NEXT_OFF(p));
20032     if (offset == 0)
20033         return(NULL);
20034
20035     return(p+offset);
20036 }
20037 #endif
20038
20039 STATIC void
20040 S_re_croak2(pTHX_ bool utf8, const char* pat1,const char* pat2,...)
20041 {
20042     va_list args;
20043     STRLEN l1 = strlen(pat1);
20044     STRLEN l2 = strlen(pat2);
20045     char buf[512];
20046     SV *msv;
20047     const char *message;
20048
20049     PERL_ARGS_ASSERT_RE_CROAK2;
20050
20051     if (l1 > 510)
20052         l1 = 510;
20053     if (l1 + l2 > 510)
20054         l2 = 510 - l1;
20055     Copy(pat1, buf, l1 , char);
20056     Copy(pat2, buf + l1, l2 , char);
20057     buf[l1 + l2] = '\n';
20058     buf[l1 + l2 + 1] = '\0';
20059     va_start(args, pat2);
20060     msv = vmess(buf, &args);
20061     va_end(args);
20062     message = SvPV_const(msv,l1);
20063     if (l1 > 512)
20064         l1 = 512;
20065     Copy(message, buf, l1 , char);
20066     /* l1-1 to avoid \n */
20067     Perl_croak(aTHX_ "%" UTF8f, UTF8fARG(utf8, l1-1, buf));
20068 }
20069
20070 /* XXX Here's a total kludge.  But we need to re-enter for swash routines. */
20071
20072 #ifndef PERL_IN_XSUB_RE
20073 void
20074 Perl_save_re_context(pTHX)
20075 {
20076     I32 nparens = -1;
20077     I32 i;
20078
20079     /* Save $1..$n (#18107: UTF-8 s/(\w+)/uc($1)/e); AMS 20021106. */
20080
20081     if (PL_curpm) {
20082         const REGEXP * const rx = PM_GETRE(PL_curpm);
20083         if (rx)
20084             nparens = RX_NPARENS(rx);
20085     }
20086
20087     /* RT #124109. This is a complete hack; in the SWASHNEW case we know
20088      * that PL_curpm will be null, but that utf8.pm and the modules it
20089      * loads will only use $1..$3.
20090      * The t/porting/re_context.t test file checks this assumption.
20091      */
20092     if (nparens == -1)
20093         nparens = 3;
20094
20095     for (i = 1; i <= nparens; i++) {
20096         char digits[TYPE_CHARS(long)];
20097         const STRLEN len = my_snprintf(digits, sizeof(digits),
20098                                        "%lu", (long)i);
20099         GV *const *const gvp
20100             = (GV**)hv_fetch(PL_defstash, digits, len, 0);
20101
20102         if (gvp) {
20103             GV * const gv = *gvp;
20104             if (SvTYPE(gv) == SVt_PVGV && GvSV(gv))
20105                 save_scalar(gv);
20106         }
20107     }
20108 }
20109 #endif
20110
20111 #ifdef DEBUGGING
20112
20113 STATIC void
20114 S_put_code_point(pTHX_ SV *sv, UV c)
20115 {
20116     PERL_ARGS_ASSERT_PUT_CODE_POINT;
20117
20118     if (c > 255) {
20119         Perl_sv_catpvf(aTHX_ sv, "\\x{%04" UVXf "}", c);
20120     }
20121     else if (isPRINT(c)) {
20122         const char string = (char) c;
20123
20124         /* We use {phrase} as metanotation in the class, so also escape literal
20125          * braces */
20126         if (isBACKSLASHED_PUNCT(c) || c == '{' || c == '}')
20127             sv_catpvs(sv, "\\");
20128         sv_catpvn(sv, &string, 1);
20129     }
20130     else if (isMNEMONIC_CNTRL(c)) {
20131         Perl_sv_catpvf(aTHX_ sv, "%s", cntrl_to_mnemonic((U8) c));
20132     }
20133     else {
20134         Perl_sv_catpvf(aTHX_ sv, "\\x%02X", (U8) c);
20135     }
20136 }
20137
20138 #define MAX_PRINT_A MAX_PRINT_A_FOR_USE_ONLY_BY_REGCOMP_DOT_C
20139
20140 STATIC void
20141 S_put_range(pTHX_ SV *sv, UV start, const UV end, const bool allow_literals)
20142 {
20143     /* Appends to 'sv' a displayable version of the range of code points from
20144      * 'start' to 'end'.  Mnemonics (like '\r') are used for the few controls
20145      * that have them, when they occur at the beginning or end of the range.
20146      * It uses hex to output the remaining code points, unless 'allow_literals'
20147      * is true, in which case the printable ASCII ones are output as-is (though
20148      * some of these will be escaped by put_code_point()).
20149      *
20150      * NOTE:  This is designed only for printing ranges of code points that fit
20151      *        inside an ANYOF bitmap.  Higher code points are simply suppressed
20152      */
20153
20154     const unsigned int min_range_count = 3;
20155
20156     assert(start <= end);
20157
20158     PERL_ARGS_ASSERT_PUT_RANGE;
20159
20160     while (start <= end) {
20161         UV this_end;
20162         const char * format;
20163
20164         if (end - start < min_range_count) {
20165
20166             /* Output chars individually when they occur in short ranges */
20167             for (; start <= end; start++) {
20168                 put_code_point(sv, start);
20169             }
20170             break;
20171         }
20172
20173         /* If permitted by the input options, and there is a possibility that
20174          * this range contains a printable literal, look to see if there is
20175          * one. */
20176         if (allow_literals && start <= MAX_PRINT_A) {
20177
20178             /* If the character at the beginning of the range isn't an ASCII
20179              * printable, effectively split the range into two parts:
20180              *  1) the portion before the first such printable,
20181              *  2) the rest
20182              * and output them separately. */
20183             if (! isPRINT_A(start)) {
20184                 UV temp_end = start + 1;
20185
20186                 /* There is no point looking beyond the final possible
20187                  * printable, in MAX_PRINT_A */
20188                 UV max = MIN(end, MAX_PRINT_A);
20189
20190                 while (temp_end <= max && ! isPRINT_A(temp_end)) {
20191                     temp_end++;
20192                 }
20193
20194                 /* Here, temp_end points to one beyond the first printable if
20195                  * found, or to one beyond 'max' if not.  If none found, make
20196                  * sure that we use the entire range */
20197                 if (temp_end > MAX_PRINT_A) {
20198                     temp_end = end + 1;
20199                 }
20200
20201                 /* Output the first part of the split range: the part that
20202                  * doesn't have printables, with the parameter set to not look
20203                  * for literals (otherwise we would infinitely recurse) */
20204                 put_range(sv, start, temp_end - 1, FALSE);
20205
20206                 /* The 2nd part of the range (if any) starts here. */
20207                 start = temp_end;
20208
20209                 /* We do a continue, instead of dropping down, because even if
20210                  * the 2nd part is non-empty, it could be so short that we want
20211                  * to output it as individual characters, as tested for at the
20212                  * top of this loop.  */
20213                 continue;
20214             }
20215
20216             /* Here, 'start' is a printable ASCII.  If it is an alphanumeric,
20217              * output a sub-range of just the digits or letters, then process
20218              * the remaining portion as usual. */
20219             if (isALPHANUMERIC_A(start)) {
20220                 UV mask = (isDIGIT_A(start))
20221                            ? _CC_DIGIT
20222                              : isUPPER_A(start)
20223                                ? _CC_UPPER
20224                                : _CC_LOWER;
20225                 UV temp_end = start + 1;
20226
20227                 /* Find the end of the sub-range that includes just the
20228                  * characters in the same class as the first character in it */
20229                 while (temp_end <= end && _generic_isCC_A(temp_end, mask)) {
20230                     temp_end++;
20231                 }
20232                 temp_end--;
20233
20234                 /* For short ranges, don't duplicate the code above to output
20235                  * them; just call recursively */
20236                 if (temp_end - start < min_range_count) {
20237                     put_range(sv, start, temp_end, FALSE);
20238                 }
20239                 else {  /* Output as a range */
20240                     put_code_point(sv, start);
20241                     sv_catpvs(sv, "-");
20242                     put_code_point(sv, temp_end);
20243                 }
20244                 start = temp_end + 1;
20245                 continue;
20246             }
20247
20248             /* We output any other printables as individual characters */
20249             if (isPUNCT_A(start) || isSPACE_A(start)) {
20250                 while (start <= end && (isPUNCT_A(start)
20251                                         || isSPACE_A(start)))
20252                 {
20253                     put_code_point(sv, start);
20254                     start++;
20255                 }
20256                 continue;
20257             }
20258         } /* End of looking for literals */
20259
20260         /* Here is not to output as a literal.  Some control characters have
20261          * mnemonic names.  Split off any of those at the beginning and end of
20262          * the range to print mnemonically.  It isn't possible for many of
20263          * these to be in a row, so this won't overwhelm with output */
20264         if (   start <= end
20265             && (isMNEMONIC_CNTRL(start) || isMNEMONIC_CNTRL(end)))
20266         {
20267             while (isMNEMONIC_CNTRL(start) && start <= end) {
20268                 put_code_point(sv, start);
20269                 start++;
20270             }
20271
20272             /* If this didn't take care of the whole range ... */
20273             if (start <= end) {
20274
20275                 /* Look backwards from the end to find the final non-mnemonic
20276                  * */
20277                 UV temp_end = end;
20278                 while (isMNEMONIC_CNTRL(temp_end)) {
20279                     temp_end--;
20280                 }
20281
20282                 /* And separately output the interior range that doesn't start
20283                  * or end with mnemonics */
20284                 put_range(sv, start, temp_end, FALSE);
20285
20286                 /* Then output the mnemonic trailing controls */
20287                 start = temp_end + 1;
20288                 while (start <= end) {
20289                     put_code_point(sv, start);
20290                     start++;
20291                 }
20292                 break;
20293             }
20294         }
20295
20296         /* As a final resort, output the range or subrange as hex. */
20297
20298         this_end = (end < NUM_ANYOF_CODE_POINTS)
20299                     ? end
20300                     : NUM_ANYOF_CODE_POINTS - 1;
20301 #if NUM_ANYOF_CODE_POINTS > 256
20302         format = (this_end < 256)
20303                  ? "\\x%02" UVXf "-\\x%02" UVXf
20304                  : "\\x{%04" UVXf "}-\\x{%04" UVXf "}";
20305 #else
20306         format = "\\x%02" UVXf "-\\x%02" UVXf;
20307 #endif
20308         GCC_DIAG_IGNORE(-Wformat-nonliteral);
20309         Perl_sv_catpvf(aTHX_ sv, format, start, this_end);
20310         GCC_DIAG_RESTORE;
20311         break;
20312     }
20313 }
20314
20315 STATIC void
20316 S_put_charclass_bitmap_innards_invlist(pTHX_ SV *sv, SV* invlist)
20317 {
20318     /* Concatenate onto the PV in 'sv' a displayable form of the inversion list
20319      * 'invlist' */
20320
20321     UV start, end;
20322     bool allow_literals = TRUE;
20323
20324     PERL_ARGS_ASSERT_PUT_CHARCLASS_BITMAP_INNARDS_INVLIST;
20325
20326     /* Generally, it is more readable if printable characters are output as
20327      * literals, but if a range (nearly) spans all of them, it's best to output
20328      * it as a single range.  This code will use a single range if all but 2
20329      * ASCII printables are in it */
20330     invlist_iterinit(invlist);
20331     while (invlist_iternext(invlist, &start, &end)) {
20332
20333         /* If the range starts beyond the final printable, it doesn't have any
20334          * in it */
20335         if (start > MAX_PRINT_A) {
20336             break;
20337         }
20338
20339         /* In both ASCII and EBCDIC, a SPACE is the lowest printable.  To span
20340          * all but two, the range must start and end no later than 2 from
20341          * either end */
20342         if (start < ' ' + 2 && end > MAX_PRINT_A - 2) {
20343             if (end > MAX_PRINT_A) {
20344                 end = MAX_PRINT_A;
20345             }
20346             if (start < ' ') {
20347                 start = ' ';
20348             }
20349             if (end - start >= MAX_PRINT_A - ' ' - 2) {
20350                 allow_literals = FALSE;
20351             }
20352             break;
20353         }
20354     }
20355     invlist_iterfinish(invlist);
20356
20357     /* Here we have figured things out.  Output each range */
20358     invlist_iterinit(invlist);
20359     while (invlist_iternext(invlist, &start, &end)) {
20360         if (start >= NUM_ANYOF_CODE_POINTS) {
20361             break;
20362         }
20363         put_range(sv, start, end, allow_literals);
20364     }
20365     invlist_iterfinish(invlist);
20366
20367     return;
20368 }
20369
20370 STATIC SV*
20371 S_put_charclass_bitmap_innards_common(pTHX_
20372         SV* invlist,            /* The bitmap */
20373         SV* posixes,            /* Under /l, things like [:word:], \S */
20374         SV* only_utf8,          /* Under /d, matches iff the target is UTF-8 */
20375         SV* not_utf8,           /* /d, matches iff the target isn't UTF-8 */
20376         SV* only_utf8_locale,   /* Under /l, matches if the locale is UTF-8 */
20377         const bool invert       /* Is the result to be inverted? */
20378 )
20379 {
20380     /* Create and return an SV containing a displayable version of the bitmap
20381      * and associated information determined by the input parameters.  If the
20382      * output would have been only the inversion indicator '^', NULL is instead
20383      * returned. */
20384
20385     SV * output;
20386
20387     PERL_ARGS_ASSERT_PUT_CHARCLASS_BITMAP_INNARDS_COMMON;
20388
20389     if (invert) {
20390         output = newSVpvs("^");
20391     }
20392     else {
20393         output = newSVpvs("");
20394     }
20395
20396     /* First, the code points in the bitmap that are unconditionally there */
20397     put_charclass_bitmap_innards_invlist(output, invlist);
20398
20399     /* Traditionally, these have been placed after the main code points */
20400     if (posixes) {
20401         sv_catsv(output, posixes);
20402     }
20403
20404     if (only_utf8 && _invlist_len(only_utf8)) {
20405         Perl_sv_catpvf(aTHX_ output, "%s{utf8}%s", PL_colors[1], PL_colors[0]);
20406         put_charclass_bitmap_innards_invlist(output, only_utf8);
20407     }
20408
20409     if (not_utf8 && _invlist_len(not_utf8)) {
20410         Perl_sv_catpvf(aTHX_ output, "%s{not utf8}%s", PL_colors[1], PL_colors[0]);
20411         put_charclass_bitmap_innards_invlist(output, not_utf8);
20412     }
20413
20414     if (only_utf8_locale && _invlist_len(only_utf8_locale)) {
20415         Perl_sv_catpvf(aTHX_ output, "%s{utf8 locale}%s", PL_colors[1], PL_colors[0]);
20416         put_charclass_bitmap_innards_invlist(output, only_utf8_locale);
20417
20418         /* This is the only list in this routine that can legally contain code
20419          * points outside the bitmap range.  The call just above to
20420          * 'put_charclass_bitmap_innards_invlist' will simply suppress them, so
20421          * output them here.  There's about a half-dozen possible, and none in
20422          * contiguous ranges longer than 2 */
20423         if (invlist_highest(only_utf8_locale) >= NUM_ANYOF_CODE_POINTS) {
20424             UV start, end;
20425             SV* above_bitmap = NULL;
20426
20427             _invlist_subtract(only_utf8_locale, PL_InBitmap, &above_bitmap);
20428
20429             invlist_iterinit(above_bitmap);
20430             while (invlist_iternext(above_bitmap, &start, &end)) {
20431                 UV i;
20432
20433                 for (i = start; i <= end; i++) {
20434                     put_code_point(output, i);
20435                 }
20436             }
20437             invlist_iterfinish(above_bitmap);
20438             SvREFCNT_dec_NN(above_bitmap);
20439         }
20440     }
20441
20442     if (invert && SvCUR(output) == 1) {
20443         return NULL;
20444     }
20445
20446     return output;
20447 }
20448
20449 STATIC bool
20450 S_put_charclass_bitmap_innards(pTHX_ SV *sv,
20451                                      char *bitmap,
20452                                      SV *nonbitmap_invlist,
20453                                      SV *only_utf8_locale_invlist,
20454                                      const regnode * const node,
20455                                      const bool force_as_is_display)
20456 {
20457     /* Appends to 'sv' a displayable version of the innards of the bracketed
20458      * character class defined by the other arguments:
20459      *  'bitmap' points to the bitmap.
20460      *  'nonbitmap_invlist' is an inversion list of the code points that are in
20461      *      the bitmap range, but for some reason aren't in the bitmap; NULL if
20462      *      none.  The reasons for this could be that they require some
20463      *      condition such as the target string being or not being in UTF-8
20464      *      (under /d), or because they came from a user-defined property that
20465      *      was not resolved at the time of the regex compilation (under /u)
20466      *  'only_utf8_locale_invlist' is an inversion list of the code points that
20467      *      are valid only if the runtime locale is a UTF-8 one; NULL if none
20468      *  'node' is the regex pattern node.  It is needed only when the above two
20469      *      parameters are not null, and is passed so that this routine can
20470      *      tease apart the various reasons for them.
20471      *  'force_as_is_display' is TRUE if this routine should definitely NOT try
20472      *      to invert things to see if that leads to a cleaner display.  If
20473      *      FALSE, this routine is free to use its judgment about doing this.
20474      *
20475      * It returns TRUE if there was actually something output.  (It may be that
20476      * the bitmap, etc is empty.)
20477      *
20478      * When called for outputting the bitmap of a non-ANYOF node, just pass the
20479      * bitmap, with the succeeding parameters set to NULL, and the final one to
20480      * FALSE.
20481      */
20482
20483     /* In general, it tries to display the 'cleanest' representation of the
20484      * innards, choosing whether to display them inverted or not, regardless of
20485      * whether the class itself is to be inverted.  However,  there are some
20486      * cases where it can't try inverting, as what actually matches isn't known
20487      * until runtime, and hence the inversion isn't either. */
20488     bool inverting_allowed = ! force_as_is_display;
20489
20490     int i;
20491     STRLEN orig_sv_cur = SvCUR(sv);
20492
20493     SV* invlist;            /* Inversion list we accumulate of code points that
20494                                are unconditionally matched */
20495     SV* only_utf8 = NULL;   /* Under /d, list of matches iff the target is
20496                                UTF-8 */
20497     SV* not_utf8 =  NULL;   /* /d, list of matches iff the target isn't UTF-8
20498                              */
20499     SV* posixes = NULL;     /* Under /l, string of things like [:word:], \D */
20500     SV* only_utf8_locale = NULL;    /* Under /l, list of matches if the locale
20501                                        is UTF-8 */
20502
20503     SV* as_is_display;      /* The output string when we take the inputs
20504                                literally */
20505     SV* inverted_display;   /* The output string when we invert the inputs */
20506
20507     U8 flags = (node) ? ANYOF_FLAGS(node) : 0;
20508
20509     bool invert = cBOOL(flags & ANYOF_INVERT);  /* Is the input to be inverted
20510                                                    to match? */
20511     /* We are biased in favor of displaying things without them being inverted,
20512      * as that is generally easier to understand */
20513     const int bias = 5;
20514
20515     PERL_ARGS_ASSERT_PUT_CHARCLASS_BITMAP_INNARDS;
20516
20517     /* Start off with whatever code points are passed in.  (We clone, so we
20518      * don't change the caller's list) */
20519     if (nonbitmap_invlist) {
20520         assert(invlist_highest(nonbitmap_invlist) < NUM_ANYOF_CODE_POINTS);
20521         invlist = invlist_clone(nonbitmap_invlist);
20522     }
20523     else {  /* Worst case size is every other code point is matched */
20524         invlist = _new_invlist(NUM_ANYOF_CODE_POINTS / 2);
20525     }
20526
20527     if (flags) {
20528         if (OP(node) == ANYOFD) {
20529
20530             /* This flag indicates that the code points below 0x100 in the
20531              * nonbitmap list are precisely the ones that match only when the
20532              * target is UTF-8 (they should all be non-ASCII). */
20533             if (flags & ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP)
20534             {
20535                 _invlist_intersection(invlist, PL_UpperLatin1, &only_utf8);
20536                 _invlist_subtract(invlist, only_utf8, &invlist);
20537             }
20538
20539             /* And this flag for matching all non-ASCII 0xFF and below */
20540             if (flags & ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER)
20541             {
20542                 not_utf8 = invlist_clone(PL_UpperLatin1);
20543             }
20544         }
20545         else if (OP(node) == ANYOFL) {
20546
20547             /* If either of these flags are set, what matches isn't
20548              * determinable except during execution, so don't know enough here
20549              * to invert */
20550             if (flags & (ANYOFL_FOLD|ANYOF_MATCHES_POSIXL)) {
20551                 inverting_allowed = FALSE;
20552             }
20553
20554             /* What the posix classes match also varies at runtime, so these
20555              * will be output symbolically. */
20556             if (ANYOF_POSIXL_TEST_ANY_SET(node)) {
20557                 int i;
20558
20559                 posixes = newSVpvs("");
20560                 for (i = 0; i < ANYOF_POSIXL_MAX; i++) {
20561                     if (ANYOF_POSIXL_TEST(node,i)) {
20562                         sv_catpv(posixes, anyofs[i]);
20563                     }
20564                 }
20565             }
20566         }
20567     }
20568
20569     /* Accumulate the bit map into the unconditional match list */
20570     for (i = 0; i < NUM_ANYOF_CODE_POINTS; i++) {
20571         if (BITMAP_TEST(bitmap, i)) {
20572             int start = i++;
20573             for (; i < NUM_ANYOF_CODE_POINTS && BITMAP_TEST(bitmap, i); i++) {
20574                 /* empty */
20575             }
20576             invlist = _add_range_to_invlist(invlist, start, i-1);
20577         }
20578     }
20579
20580     /* Make sure that the conditional match lists don't have anything in them
20581      * that match unconditionally; otherwise the output is quite confusing.
20582      * This could happen if the code that populates these misses some
20583      * duplication. */
20584     if (only_utf8) {
20585         _invlist_subtract(only_utf8, invlist, &only_utf8);
20586     }
20587     if (not_utf8) {
20588         _invlist_subtract(not_utf8, invlist, &not_utf8);
20589     }
20590
20591     if (only_utf8_locale_invlist) {
20592
20593         /* Since this list is passed in, we have to make a copy before
20594          * modifying it */
20595         only_utf8_locale = invlist_clone(only_utf8_locale_invlist);
20596
20597         _invlist_subtract(only_utf8_locale, invlist, &only_utf8_locale);
20598
20599         /* And, it can get really weird for us to try outputting an inverted
20600          * form of this list when it has things above the bitmap, so don't even
20601          * try */
20602         if (invlist_highest(only_utf8_locale) >= NUM_ANYOF_CODE_POINTS) {
20603             inverting_allowed = FALSE;
20604         }
20605     }
20606
20607     /* Calculate what the output would be if we take the input as-is */
20608     as_is_display = put_charclass_bitmap_innards_common(invlist,
20609                                                     posixes,
20610                                                     only_utf8,
20611                                                     not_utf8,
20612                                                     only_utf8_locale,
20613                                                     invert);
20614
20615     /* If have to take the output as-is, just do that */
20616     if (! inverting_allowed) {
20617         if (as_is_display) {
20618             sv_catsv(sv, as_is_display);
20619             SvREFCNT_dec_NN(as_is_display);
20620         }
20621     }
20622     else { /* But otherwise, create the output again on the inverted input, and
20623               use whichever version is shorter */
20624
20625         int inverted_bias, as_is_bias;
20626
20627         /* We will apply our bias to whichever of the the results doesn't have
20628          * the '^' */
20629         if (invert) {
20630             invert = FALSE;
20631             as_is_bias = bias;
20632             inverted_bias = 0;
20633         }
20634         else {
20635             invert = TRUE;
20636             as_is_bias = 0;
20637             inverted_bias = bias;
20638         }
20639
20640         /* Now invert each of the lists that contribute to the output,
20641          * excluding from the result things outside the possible range */
20642
20643         /* For the unconditional inversion list, we have to add in all the
20644          * conditional code points, so that when inverted, they will be gone
20645          * from it */
20646         _invlist_union(only_utf8, invlist, &invlist);
20647         _invlist_union(not_utf8, invlist, &invlist);
20648         _invlist_union(only_utf8_locale, invlist, &invlist);
20649         _invlist_invert(invlist);
20650         _invlist_intersection(invlist, PL_InBitmap, &invlist);
20651
20652         if (only_utf8) {
20653             _invlist_invert(only_utf8);
20654             _invlist_intersection(only_utf8, PL_UpperLatin1, &only_utf8);
20655         }
20656         else if (not_utf8) {
20657
20658             /* If a code point matches iff the target string is not in UTF-8,
20659              * then complementing the result has it not match iff not in UTF-8,
20660              * which is the same thing as matching iff it is UTF-8. */
20661             only_utf8 = not_utf8;
20662             not_utf8 = NULL;
20663         }
20664
20665         if (only_utf8_locale) {
20666             _invlist_invert(only_utf8_locale);
20667             _invlist_intersection(only_utf8_locale,
20668                                   PL_InBitmap,
20669                                   &only_utf8_locale);
20670         }
20671
20672         inverted_display = put_charclass_bitmap_innards_common(
20673                                             invlist,
20674                                             posixes,
20675                                             only_utf8,
20676                                             not_utf8,
20677                                             only_utf8_locale, invert);
20678
20679         /* Use the shortest representation, taking into account our bias
20680          * against showing it inverted */
20681         if (   inverted_display
20682             && (   ! as_is_display
20683                 || (  SvCUR(inverted_display) + inverted_bias
20684                     < SvCUR(as_is_display)    + as_is_bias)))
20685         {
20686             sv_catsv(sv, inverted_display);
20687         }
20688         else if (as_is_display) {
20689             sv_catsv(sv, as_is_display);
20690         }
20691
20692         SvREFCNT_dec(as_is_display);
20693         SvREFCNT_dec(inverted_display);
20694     }
20695
20696     SvREFCNT_dec_NN(invlist);
20697     SvREFCNT_dec(only_utf8);
20698     SvREFCNT_dec(not_utf8);
20699     SvREFCNT_dec(posixes);
20700     SvREFCNT_dec(only_utf8_locale);
20701
20702     return SvCUR(sv) > orig_sv_cur;
20703 }
20704
20705 #define CLEAR_OPTSTART                                                       \
20706     if (optstart) STMT_START {                                               \
20707         DEBUG_OPTIMISE_r(Perl_re_printf( aTHX_                                           \
20708                               " (%" IVdf " nodes)\n", (IV)(node - optstart))); \
20709         optstart=NULL;                                                       \
20710     } STMT_END
20711
20712 #define DUMPUNTIL(b,e)                                                       \
20713                     CLEAR_OPTSTART;                                          \
20714                     node=dumpuntil(r,start,(b),(e),last,sv,indent+1,depth+1);
20715
20716 STATIC const regnode *
20717 S_dumpuntil(pTHX_ const regexp *r, const regnode *start, const regnode *node,
20718             const regnode *last, const regnode *plast,
20719             SV* sv, I32 indent, U32 depth)
20720 {
20721     U8 op = PSEUDO;     /* Arbitrary non-END op. */
20722     const regnode *next;
20723     const regnode *optstart= NULL;
20724
20725     RXi_GET_DECL(r,ri);
20726     GET_RE_DEBUG_FLAGS_DECL;
20727
20728     PERL_ARGS_ASSERT_DUMPUNTIL;
20729
20730 #ifdef DEBUG_DUMPUNTIL
20731     Perl_re_printf( aTHX_  "--- %d : %d - %d - %d\n",indent,node-start,
20732         last ? last-start : 0,plast ? plast-start : 0);
20733 #endif
20734
20735     if (plast && plast < last)
20736         last= plast;
20737
20738     while (PL_regkind[op] != END && (!last || node < last)) {
20739         assert(node);
20740         /* While that wasn't END last time... */
20741         NODE_ALIGN(node);
20742         op = OP(node);
20743         if (op == CLOSE || op == WHILEM)
20744             indent--;
20745         next = regnext((regnode *)node);
20746
20747         /* Where, what. */
20748         if (OP(node) == OPTIMIZED) {
20749             if (!optstart && RE_DEBUG_FLAG(RE_DEBUG_COMPILE_OPTIMISE))
20750                 optstart = node;
20751             else
20752                 goto after_print;
20753         } else
20754             CLEAR_OPTSTART;
20755
20756         regprop(r, sv, node, NULL, NULL);
20757         Perl_re_printf( aTHX_  "%4" IVdf ":%*s%s", (IV)(node - start),
20758                       (int)(2*indent + 1), "", SvPVX_const(sv));
20759
20760         if (OP(node) != OPTIMIZED) {
20761             if (next == NULL)           /* Next ptr. */
20762                 Perl_re_printf( aTHX_  " (0)");
20763             else if (PL_regkind[(U8)op] == BRANCH
20764                      && PL_regkind[OP(next)] != BRANCH )
20765                 Perl_re_printf( aTHX_  " (FAIL)");
20766             else
20767                 Perl_re_printf( aTHX_  " (%" IVdf ")", (IV)(next - start));
20768             Perl_re_printf( aTHX_ "\n");
20769         }
20770
20771       after_print:
20772         if (PL_regkind[(U8)op] == BRANCHJ) {
20773             assert(next);
20774             {
20775                 const regnode *nnode = (OP(next) == LONGJMP
20776                                        ? regnext((regnode *)next)
20777                                        : next);
20778                 if (last && nnode > last)
20779                     nnode = last;
20780                 DUMPUNTIL(NEXTOPER(NEXTOPER(node)), nnode);
20781             }
20782         }
20783         else if (PL_regkind[(U8)op] == BRANCH) {
20784             assert(next);
20785             DUMPUNTIL(NEXTOPER(node), next);
20786         }
20787         else if ( PL_regkind[(U8)op]  == TRIE ) {
20788             const regnode *this_trie = node;
20789             const char op = OP(node);
20790             const U32 n = ARG(node);
20791             const reg_ac_data * const ac = op>=AHOCORASICK ?
20792                (reg_ac_data *)ri->data->data[n] :
20793                NULL;
20794             const reg_trie_data * const trie =
20795                 (reg_trie_data*)ri->data->data[op<AHOCORASICK ? n : ac->trie];
20796 #ifdef DEBUGGING
20797             AV *const trie_words
20798                            = MUTABLE_AV(ri->data->data[n + TRIE_WORDS_OFFSET]);
20799 #endif
20800             const regnode *nextbranch= NULL;
20801             I32 word_idx;
20802             SvPVCLEAR(sv);
20803             for (word_idx= 0; word_idx < (I32)trie->wordcount; word_idx++) {
20804                 SV ** const elem_ptr = av_fetch(trie_words,word_idx,0);
20805
20806                 Perl_re_indentf( aTHX_  "%s ",
20807                     indent+3,
20808                     elem_ptr
20809                     ? pv_pretty(sv, SvPV_nolen_const(*elem_ptr),
20810                                 SvCUR(*elem_ptr), PL_dump_re_max_len,
20811                                 PL_colors[0], PL_colors[1],
20812                                 (SvUTF8(*elem_ptr)
20813                                  ? PERL_PV_ESCAPE_UNI
20814                                  : 0)
20815                                 | PERL_PV_PRETTY_ELLIPSES
20816                                 | PERL_PV_PRETTY_LTGT
20817                             )
20818                     : "???"
20819                 );
20820                 if (trie->jump) {
20821                     U16 dist= trie->jump[word_idx+1];
20822                     Perl_re_printf( aTHX_  "(%" UVuf ")\n",
20823                                (UV)((dist ? this_trie + dist : next) - start));
20824                     if (dist) {
20825                         if (!nextbranch)
20826                             nextbranch= this_trie + trie->jump[0];
20827                         DUMPUNTIL(this_trie + dist, nextbranch);
20828                     }
20829                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
20830                         nextbranch= regnext((regnode *)nextbranch);
20831                 } else {
20832                     Perl_re_printf( aTHX_  "\n");
20833                 }
20834             }
20835             if (last && next > last)
20836                 node= last;
20837             else
20838                 node= next;
20839         }
20840         else if ( op == CURLY ) {   /* "next" might be very big: optimizer */
20841             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS,
20842                     NEXTOPER(node) + EXTRA_STEP_2ARGS + 1);
20843         }
20844         else if (PL_regkind[(U8)op] == CURLY && op != CURLYX) {
20845             assert(next);
20846             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS, next);
20847         }
20848         else if ( op == PLUS || op == STAR) {
20849             DUMPUNTIL(NEXTOPER(node), NEXTOPER(node) + 1);
20850         }
20851         else if (PL_regkind[(U8)op] == ANYOF) {
20852             /* arglen 1 + class block */
20853             node += 1 + ((ANYOF_FLAGS(node) & ANYOF_MATCHES_POSIXL)
20854                           ? ANYOF_POSIXL_SKIP
20855                           : ANYOF_SKIP);
20856             node = NEXTOPER(node);
20857         }
20858         else if (PL_regkind[(U8)op] == EXACT) {
20859             /* Literal string, where present. */
20860             node += NODE_SZ_STR(node) - 1;
20861             node = NEXTOPER(node);
20862         }
20863         else {
20864             node = NEXTOPER(node);
20865             node += regarglen[(U8)op];
20866         }
20867         if (op == CURLYX || op == OPEN)
20868             indent++;
20869     }
20870     CLEAR_OPTSTART;
20871 #ifdef DEBUG_DUMPUNTIL
20872     Perl_re_printf( aTHX_  "--- %d\n", (int)indent);
20873 #endif
20874     return node;
20875 }
20876
20877 #endif  /* DEBUGGING */
20878
20879 /*
20880  * ex: set ts=8 sts=4 sw=4 et:
20881  */